*****************************
OpenEye Toolkits |pkgversion|
*****************************

..  touch index to start TC

..  toctree::
    :maxdepth: 1

    releasenotes/index
    intro

..  oe:language:: java

    ..  toctree::
        :maxdepth: 2

        quickstart-java/index
        kitsummaryj

..  oe:language:: csharp

    ..  toctree::
        :maxdepth: 2

        quickstart-csharp/index
        kitsummarycsharp

..  oe:language:: python

    ..  toctree::
        :maxdepth: 2

        quickstart-python/index
        kitsummarypcpp

..  oe:language:: c++

    ..  toctree::
        :maxdepth: 2

        quickstart-cplusplus/index
        kitsummarypcpp

..  toctree::

    include_doctheme_glossary
    bibliography



.. Toolkit Release Notes Master File

.. _release_notes_index:

**********************
Toolkit Version 2026.1
**********************

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt



.. toctree::
   :maxdepth: 2

   2026.1 Highlights<highlights>

..  toctree::
    :maxdepth: 1

    detailed/detailed-index

Recent Release History
************************

..  toctree::
    :maxdepth: 2

    releasenotes2025_Fall
    releasenotes2025_Spr
    releasenotes2024_Fall
    releasenotes2024_Spr

Previous Release History
************************

..  toctree::
    :maxdepth: 1

    releasenotes2023_Fall
    releasenotes2023_Spr
    releasenotes2022_Fall
    releasenotes2022_Spr
    releasenotes2021_Fall
    releasenotes2021_Spr
    releasenotes2020_Fall
    releasenotes2020_Spr
    releasenotes2019_Oct
    releasenotes2019_Apr
    releasenotes2018_Oct
    releasenotes2018_Feb
    releasenotes2017_Oct
    releasenotes2017_Jun
    releasenotes2017_Feb
    releasenotes2016_Oct
    releasenotes2016_Jun
    releasenotes2016_Feb
    releasenotes2015_Oct
    releasenotes2015_Jun
    releasenotes2015_Feb
    releasenotes2014_Oct
    releasenotes2014_Jun
    releasenotes2014_Feb
    releasenotes2013_Oct
    releasenotes2013_Jun
    releasenotes2013_Feb
    releasenotes2012_Oct
    releasenotes2012_Jun
    releasenotes2012_Feb
    releasenotes2011_Oct
    releasenotes2011_1
    releasenotes1_7_4
    releasenotes1_7_2
    releasenotes1_7_1
    releasenotes1_7_0



.. _highlights_2026_Sum:

********************
OEToolkits 2026.1
********************

Release Highlights 2026.1
=============================

OEChem TK: Peptide Informatics Support 
-----------------------------------------------------------------------------

This release delivers a comprehensive set of peptide informatics capabilities in 
**OEChem TK**, including reliable conversion between molecular structures and HELM 
representations. Support for custom monomer dictionaries enables seamless incorporation 
of proprietary nonstandard amino acids into peptide discovery workflows.
The release also includes a built-in monomer dictionary containing more than 260 monomers 
commonly encountered in peptide chemistry projects.

In addition, enhanced visualization capabilities in **Grapheme TK** enable clear and
intuitive representation of complex peptides, facilitating the interpretation and communication 
of diverse peptide chemistries.

.. figure:: /_images/helm-conversion.png
   :width: 500pt
   :align: center
  
   **Figure 1.** Conversion between HELM strings generated with different monomer sets.


OMEGA: Torsion Driving with Thompson Sampling
-----------------------------------------------------------------------------

Conformer generation using **OMEGA** with torsion driving now automatically
uses Thompson sampling. The algorithm for Thompson sampling in **OMEGA** has been
optimized for performance and extended to the generation of larger ensembles, such
as those used in the ``classic`` and ``pose`` modes of **OMEGA**.

Thompson sampling is a Bayesian approach that drives conformer generation toward
low energy structures, enabling conformer generation at speed without sacrificing accuracy. 
In general, the speed increase with Thompson sampling is larger when working with larger
molecules and generating smaller ensembles. On a dataset of ~40K compounds, compiled 
from multiple vendor databases consisting of molecules of varied sizes, an overall
2x speedup over torsion driving without Thompson sampling is observed when generating
conformers in the ``classic`` mode. Conformer generation for the same dataset using
the ``fastrocs`` mode provides a 3x speedup over torsion driving without Thompson sampling.
A comparison of timings for the dataset of the ~40K compounds from multiple vendor
databases is shown in Figure 2.

.. figure:: /_images/OMEGA_TS_SpeedRotor.png
   :width: 550pt
   :align: center

   **Figure 2.** Comparison of **OMEGA** performance in the ``classic`` mode
   between exhaustive and Thompson sampling. The box plots show the distribution
   of processing time binned by rotor count.

**OMEGA** maintains high accuracy while achieving this performance gain.
As seen in Figure 3, both exhaustive and Thompson sampling methods in the
``classic`` mode reproduce conformations within 1 Å RMSD of the experimental
conformation for 80% of ligands across the 6,000 PDB structures with HT 
(Highly Trustworthy) Iridium scores. Structure-based virtual 
screening performance is equivalent to that obtained from exhaustive sampling.

.. figure:: /_images/OMEGA_TS_RMSD.png
   :width: 350pt
   :align: center

   **Figure 3.** Distribution of RMSD between the best pose from the generated ensemble
   and the crystal pose for the two sampling methods using ``classic`` mode in **OMEGA**.


Bioisostere TK: Multiquery Replacements
-----------------------------------------------------------------------------

**Bioisostere TK** now includes new API functionality for simultaneous replacement of
multiple query fragments in a molecule. With the addition of the new functionality,
**Bioisostere TK** is uniquely positioned with tools to build applications for
3D generative de novo molecule design.

In addition to the ability to simultaneously replace multiple query fragments,
tools have been added to obtain scores of multiple replacements from their single
replacement counterparts, building a single hit list of **Brood** overlay scores obtained
from multiple query replacements, building hit lists combining hits from different
queries and multiple queries, and building clusters from the combined hit lists.
All of the API designs are compatible for use with an arbitrary number of queries
on a molecule, without any limitations. With the addition of each query, the searchable
space can be expanded combinatorially, enabling exploration of increasingly larger chemical
design spaces.

As shown in Figure 4, users can select specific fragments in a molecule of
interest and generate targeted replacement suggestions.

.. figure:: /_images/Brood-multiquery.png
   :width: 600pt
   :align: center

   **Figure 4.** De novo molecule design of an EZH2 inhibitor. The compound on the
   left highlights the input molecule being divided into three fragments to build three
   separate **Brood** queries. The compound on the right is a new molecule designed
   using **Bioisostere TK** to replace all three queries from the left.


..  _supported-tk-platforms-2026-Sum:

Supported Platforms
--------------------

  ===========  ============  ===============================  ======================  ========================
  Package      Versions      Linux                            Windows                 macOS
  -----------  ------------  -------------------------------  ----------------------  ------------------------
  Python       3.11 - 3.14   RHEL8/9/10, Ubuntu22/22-ARM/24   Win11                   14, 15, 26
  C++                        RHEL8/9/10, Ubuntu22/22-ARM/24   Win11 (VS2022)          14, 15, 26
  Java         8, 11, 21     RHEL8/9/10, Ubuntu22/22-ARM/24   Win11                   14, 15, 26
  C#                                                          Win11 (VS2022)
  ===========  ============  ===============================  ======================  ========================

Related TK Versions
---------------------

  ==============  ===========
  Toolkit         Version
  --------------  -----------
  Bioisostere TK  5.0.0
  OEChem TK       5.0.0
  OEDepict TK     2.7.0
  OEDocking TK    4.3.5
  Eon TK          3.1.3
  FastROCS TK     2.3.2
  OEFF TK         2.9.2
  Grapheme TK     1.5.5
  GraphSim TK     2.7.1
  Lexichem TK     2.9.5
  OEMedChem TK    1.2.6
  MolProp TK      2.7.0
  Omega TK        7.0.0
  Quacpac TK      2.3.0
  Saiph TK        1.0.1
  Shape TK        3.10.0
  SiteHopper TK   2.1.4
  Spicoli TK      1.6.4
  Spruce TK       1.9.0
  Szmap TK        1.7.4
  Szybki TK       2.9.2
  Zap TK          2.5.3
  ==============  ===========

General Notices
==================

* This is the last release of the OpenEye Java and C# toolkits. Existing versions, including the
  current release versions, will continue to be available.

* Python Support: 

  * OpenEye Python Cookbook is now available as a pip-installable package.
  * Support for Python 3.14 has been added in this release for all supported platforms.
  * Support for Python 3.10 has been dropped in this release. 
  * Support for Python 3.11 will be dropped in the winter of 2027.

* Linux Support:
  
  * Support for Red Hat 10 has been added in this release.
  * Support for Ubuntu 26 will be added in the winter of 2027.
  * Support for Ubuntu 22 will be dropped in the winter of 2027.

* macOS Support:

  * Support for macOS 26 has been added in this release.
  * Support for macOS 13 has been dropped.
  * Support for all Intel-based Macs will be dropped in the winter of 2027.

* Support for Windows 10 has been dropped in this release.



.. Toolkit Release Notes Master File

.. _release_notes_index-detailed:

Detailed Release Notes 2026.1
*****************************

..  toctree::
    :maxdepth: 1


Bioisostere TK 5.0.0
================================================================================

New Features
--------------------------------------------------------------------------------

* The following new classes have been added as preliminary API:
  
  * :ref:`OEBroodBuildResult <OEBioisostere_OEBroodBuildResult>`
  * :ref:`OEBroodCluster <OEBioisostere_OEBroodCluster>`
  * :ref:`OEBroodClusterBuilder <OEBioisostere_OEBroodClusterBuilder>`
  * :ref:`OEBroodComboBuilder <OEBioisostere_OEBroodComboBuilder>`
  * :ref:`OEHitlistBuilderOptions <OEBioisostere_OEHitlistBuilderOptions>`
  * :ref:`OEHitlistBase <OEBioisostere_OEHitlistBase>`
  * :ref:`OEScoreHitlist <OEBioisostere_OEScoreHitlist>`
  * :ref:`OEBroodHitlist <OEBioisostere_OEBroodHitlist>`
  * :ref:`OEMolCTBuilder <OEBioisostere_OEMolCTBuilder>`
  * :ref:`OESimilarity <OEBioisostere_OESimilarity>`

* The following new methods have been added to :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>`:

  * :ref:`GetQueryID <OEBioisostere_OEBroodQuery_GetQueryID>`
  * :ref:`SetQueryID <OEBioisostere_OEBroodQuery_SetQueryID>`

* A new constructor overload has been added to :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>`
  that takes a :ref:`OEHitlistBuilderOptions <OEBioisostere_OEHitlistBuilderOptions>` as an argument.

* A new overload of :ref:`Setup <OEBioisostere_OEBroodDBFilter_Setup>` has been added to
  :ref:`OEBroodDBFilter <OEBioisostere_OEBroodDBFilter>` that takes a molecule as argument.

* The following new methods have been added to :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>`:

  * :ref:`GetBuildRes <OEBioisostere_OEBroodHit_GetBuildRes>`
  * :ref:`GetScores <OEBioisostere_OEBroodHit_GetScores>`

* The following new methods have been added to :ref:`OEBroodScore <OEBioisostere_OEBroodScore>`:

  * :ref:`Add <OEBioisostere_OEBroodScore_Add>`
  * :ref:`GetQueryIDs <OEBioisostere_OEBroodScore_GetQueryIDs>`

* The following new functions have been added:

  * :ref:`OECreateFlipperOptions <OEBioisostere_OECreateFlipperOptions>`
  * :ref:`OECreateFragFilter <OEBioisostere_OECreateFragFilter>`
  * :ref:`OEIsFragment <OEBioisostere_OEIsFragment>`

* The following methods have been removed from the :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>`,
  as they are no longer relevant:

  * GetTrimmedCount
  * TrimHitlist
  * An overload of GetHits that took a vector of :ref:`OEBroodHit <OEBioisostere_OEBroodHit>` as an argument.
  * GetRemovedHits


Minor Bug Fixes
--------------------------------------------------------------------------------

* The :ref:`OECreateBroodQuery <OEBioisostere_OECreateBroodQuery>` method now
  keeps any incoming color atoms associated with the query selection, when available, and
  does not add any additional color atoms to the query.  The behavior is unchanged
  when no color atoms are present with the incoming selection.

* A bug in fragment property filtering has been resolved. Now by setting the
  :ref:`SetUseProperty <OEBioisostere_OEBroodScoreOptions_SetUseProperty>` option in
  :ref:`OEBroodScoreOptions <OEBioisostere_OEBroodScoreOptions>` to true, you can activate
  the fragment filtering based on the properties defined by
  :ref:`OEExtrinsicPropOptions <OEBioisostere_OEExtrinsicPropOptions>` and
  :ref:`OEIntrinsicPropOptions <OEBioisostere_OEIntrinsicPropOptions>`.
  Previously, the filter was not being applied correctly, which could lead to unexpected
  fragments being included in the results.

* An issue has been fixed related to proper usage of 
  :ref:`SetRangeSize<OEBioisostere_OEBroodGeneralOptions_SetRangeSize>` and
  :ref:`SetRangeOffset<OEBioisostere_OEBroodGeneralOptions_SetRangeOffset>` so that
  fragment retrieval from the database during the overlay step now properly respects
  the specified range boundaries.

* A bug has been fixed where the color score reported by
  :ref:`GetColorScore <OEBioisostere_OEBroodScore_GetColorScore>` could exceed its valid
  range in ROCS mode, causing the combined score to exceed its range as well. The color
  Tanimoto is now computed consistently from the scored conformer.




OEChem TK 5.0.0
================================================================================

New Features
--------------------------------------------------------------------------------

* The following preliminary APIs have been added for monomer, HELM, and peptide
  support.

  **Classes:**

  * :oe:cls:`OEChem::OEMonomer` — represents a monomer in a monomer set.
  * :oe:cls:`OEChem::OEMonomerData` — stores the definition of a monomer.
  * :oe:cls:`OEChem::OEMonomerSet` — a collection of monomers.
  * :oe:cls:`OEChem::OEMonomerValidationResult` — stores the result of monomer data validation.
  * :oe:cls:`OEChem::OEHelmParsingResult` — stores the result of HELM parsing.
  * :oe:cls:`OEChem::OEHelmGenerationResult` — stores the result of HELM generation.
  * :oe:cls:`OEChem::OEHelmGenerationOptions` — gives options for HELM generation.

  **Predicates:**

  * :oe:cls:`OEChem::OEIsInMonomerCodeSet` — filters monomers by code set.
  * :oe:cls:`OEChem::OEHasPolymerType` — filters monomers by polymer type.
  * :oe:cls:`OEChem::OEHasMonomerType` — filters monomers by monomer type.
  * :oe:cls:`OEChem::OEHasAminoAcidType` — filters monomers by amino acid type.
  * :oe:cls:`OEChem::OEIsMonomerGroup` — identifies groups that store monomer information.
  * :oe:cls:`OEChem::OEHasMonomerGroup` — identifies groups that match a monomer group by code set and code.

  **Constants:**

  * :oe:constns:`OEChem::OEAminoAcidType` — amino acid type constants.
  * :oe:constns:`OEChem::OEPolymerType` — polymer type constants.
  * :oe:constns:`OEChem::OEMonomerType` — monomer type constants.
  * :oe:constns:`OEChem::OEMonomerValidationReturnCode` — monomer validation return codes.
  * :oe:constns:`OEChem::OEHelmParsingReturnCode` — HELM parsing return codes.
  * :oe:constns:`OEChem::OEHelmGenerationReturnCode` — HELM generation return codes.
  * :oe:const:`OEChem::OEGroupType::Monomer` — monomer group type constant.
  * :oe:const:`OEChem::OEProperty::Monomer` — monomer property type constant.


  **Monomer data and validation functions:**

  * :oe:func:`OEChem::OEIsValidMonomerData`
  * :oe:func:`OEChem::OEAminoAcidTypeToString`
  * :oe:func:`OEChem::OEPolymerTypeToString`
  * :oe:func:`OEChem::OEStringToPolymerType`
  * :oe:func:`OEChem::OEMonomerTypeToString`
  * :oe:func:`OEChem::OEStringToMonomerType`

  **Monomer set I/O functions:**

  * :oe:func:`OEChem::OEReadMonomerSet`
  * :oe:func:`OEChem::OEWriteMonomerSet`
  * :oe:func:`OEChem::OELoadStandardMonomerSet`
  * :oe:func:`OEChem::OELoadOpenEyeMonomerSet`

  **Monomer perception and detection functions:**

  * :oe:func:`OEChem::OEDetectMonomers`
  * :oe:func:`OEChem::OEGetPolymerType`
  * :oe:func:`OEChem::OEGetMonomerType`
  * :oe:func:`OEChem::OEGetAminoAcidType`
  * :oe:func:`OEChem::OEIsStandardMonomer`
  * :oe:func:`OEChem::OEGetStandardAnalog`
  * :oe:func:`OEChem::OECreatePeptideMonomerConnectionSmiles`
  * :oe:func:`OEChem::OEMonomerConnectionSmilesFromCXSmiles`
  * :oe:func:`OEChem::OEPerceivePeptideMonomerConnections`

  **HELM functions:**

  * :oe:func:`OEChem::OEHelmToMol`
  * :oe:func:`OEChem::OEMolToHelm`
  * :oe:func:`OEChem::OEGetHelmChainNames`
  * :oe:func:`OEChem::OEGetHelmMonomerCodes`

  **Peptide perception functions:**

  * :oe:func:`OEChem::OEIsPeptide`
  * :oe:func:`OEChem::OEPerceivePeptideBackbone`

* A new function, :oe:func:`OEChem::OEHasRadii`, has been added to check if
  a molecule has radii assigned to all atoms. The function takes an optional 
  boolean argument ``all`` (default: ``true``) to specify whether to check 
  for radii on every atom or whether to return early on the first atom without radii.

* More :oe:constns:`OEChem::OEIFlavor` constants have been added for better control of perception steps when reading mmCIF files.

Minor Bug Fixes
--------------------------------------------------------------------------------

* When generating a substructure search database with :oe:func:`OEChem::OECreateSubSearchDatabaseFile`,
  molecules with high graph complexity (such as https://www.rcsb.org/ligand/ZRW) are now
  skipped since they are unlikely to be useful for substructure searching and can cause 
  significant performance degradation during database generation.

* The stack size of threads used in the :oe:func:`OEChem::OECreateSubSearchDatabaseFile`
  function have been increased to avoid memory allocation issues when processing :file:`.oeb` files with large number of
  generic data.

* An issue has been fixed in :oe:func:`OEBio::OEGetTorsion` where residue perception was called
  on a const atom changing the underlying perception state of the molecule.
  The function now correctly returns an invalid value when the residue is not already perceived
  with a warning to perceive it.


Python-Specific Changes
--------------------------------------------------------------------------------

* The :oe:meth:`OEChem::OEMolBase::NewGroup` method raises :py:class:`TypeError` if
  invoked with an invalid argument type.

* The hashing function for OEResidue has been updated to work with 
  multicharacter chain IDs.


OEBio TK
================================================================================

New Features
--------------------------------------------------------------------------------

* The following preliminary APIs have been added to serializing and deserializing
  interaction hints into :file:`.oeb` files.

  * :oe:func:`OEBio::OEConstructInteractionHintContainer`
  * :oe:func:`OEBio::OEDeleteInteractionsHintSerializationData`
  * :oe:func:`OEBio::OEDeleteInteractionsHintSerializationIds`
  * :oe:func:`OEBio::OEHasInteractionHintSerializationIds`
  * :oe:func:`OEBio::OEHasInteractionsHintSerializationData`
  * :oe:func:`OEBio::OESerializeInteractionsHintContainer`
  * :oe:func:`OEBio::OESetInteractionsHintSerializationIds`

* The serialization API for interaction hints now supports
  :ref:`OEDesignUnit <OEBio_OEDesignUnit>` directly. The following functions
  have new overloads accepting an :oe:cls:`OEBio::OEDesignUnit`:

  * :oe:func:`OEBio::OEConstructInteractionHintContainer`
  * :oe:func:`OEBio::OEDeleteInteractionsHintSerializationData`
  * :oe:func:`OEBio::OEDeleteInteractionsHintSerializationIds`
  * :oe:func:`OEBio::OEHasInteractionsHintSerializationData`
  * :oe:func:`OEBio::OESetInteractionsHintSerializationIds`

* The :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class
  now supports a new :ref:`constructor overload <OEBio_OEInteractionHintContainer_Constructors>` that accepts an
  :oe:cls:`OEBio::OEDesignUnit`, assembling the receptor from the design unit
  components and the ligand (if present) automatically.

* Intramolecular interaction perception is now supported for a single component
  (either ligand or protein) by passing an empty molecule for the other
  component to the
  :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>`
  constructor. For example, passing an empty molecule as the ligand argument
  will perceive only intramolecular interactions within the protein, and
  vice versa. This also applies when using the
  :oe:cls:`OEBio::OEDesignUnit` constructor overload: if a design unit has
  site residues but no ligand, intramolecular receptor interactions are
  perceived automatically.

* The following new predicates have been added for finer-grained filtering of
  interaction hints:

  * :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>`
    identifies clashing hydrogen bond interactions (i.e.,
    :oe:const:`OEBio::OEHBondInteractionHintType::ClashAcceptorAcceptor` and
    :oe:const:`OEBio::OEHBondInteractionHintType::ClashDonorDonor` types).

  * :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>`
    identifies all unpaired interactions, including unpaired hydrogen bond
    donors/acceptors and unpaired salt-bridge charges.

  * :ref:`OEIsIntermolecularSaltBridgeInteractionHint <OEBio_OEIsIntermolecularSaltBridgeInteractionHint>`
    identifies intermolecular (ligand-protein) salt-bridge interactions.

  * :ref:`OEIsIntramolecularSaltBridgeInteractionHint <OEBio_OEIsIntramolecularSaltBridgeInteractionHint>`
    identifies intramolecular salt-bridge interactions within the ligand or protein.

  * :ref:`OEIsIntermolecularStackingInteractionHint <OEBio_OEIsIntermolecularStackingInteractionHint>`
    identifies intermolecular (ligand-protein) pi- and T-stacking interactions.

  * :ref:`OEIsIntramolecularStackingInteractionHint <OEBio_OEIsIntramolecularStackingInteractionHint>`
    identifies intramolecular pi- and T-stacking interactions within the ligand
    or protein.

  * :ref:`OEIsIntermolecularCationPiInteractionHint <OEBio_OEIsIntermolecularCationPiInteractionHint>`
    identifies intermolecular (ligand-protein) cation-pi interactions.

  * :ref:`OEIsIntramolecularCationPiInteractionHint <OEBio_OEIsIntramolecularCationPiInteractionHint>`
    identifies intramolecular cation-pi interactions within the ligand or protein.

  * :ref:`OEIsIntermolecularHalogenBondInteractionHint <OEBio_OEIsIntermolecularHalogenBondInteractionHint>`
    identifies intermolecular (ligand-protein) halogen bond interactions.

  * :ref:`OEIsIntramolecularHalogenBondInteractionHint <OEBio_OEIsIntramolecularHalogenBondInteractionHint>`
    identifies intramolecular halogen bond interactions within the ligand or protein.

* Intramolecular stacking and cation-pi interactions are now perceived and
  reported. The following new type constants have been added:

  * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularLigandPi`
  * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularLigandT`
  * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularProteinPi`
  * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularProteinT`
  * :oe:const:`OEBio::OECationPiInteractionHintType::IntramolecularLigand`
  * :oe:const:`OEBio::OECationPiInteractionHintType::IntramolecularProtein`

* A new option has been added to
  :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` to
  control the minimum stack offset required for a pi-stacking or T-stacking
  interaction to be reported:

  * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinStackOffset` /
    :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMinStackOffset`

  The stack offset is defined as
  :math:`\max(|\hat{c}\cdot\hat{n}_1|, |\hat{c}\cdot\hat{n}_2|)`, where
  :math:`\hat{c}` is the unit vector between the ring centers and
  :math:`\hat{n}_1` and :math:`\hat{n}_2` are the ring plane normals.
  This filter ensures that one ring sits above or below the other (i.e., a
  genuinely stacked arrangement) rather than side by side in the same plane.
  The default value is **0.5**.

* The following existing predicates have been updated to accept optional
  parameters that control whether intramolecular interactions and nonideal
  interactions are included in their results. All parameters default to ``True``
  to preserve backward-compatible behavior where interactions were previously
  returned without distinction:

  * :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` —
    new constructor ``OEIsHBondInteractionHint(bool includeIntra = true, bool includeNonIdeal = true)``

  * :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>` —
    new constructor ``OEIsIntermolecularHBondInteractionHint(bool includeNonIdeal = true)``

  * :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>` —
    new constructor ``OEIsIntramolecularHBondInteractionHint(bool includeNonIdeal = true)``

  * :ref:`OEIsChelatorInteractionHint <OEBio_OEIsChelatorInteractionHint>` —
    new constructor ``OEIsChelatorInteractionHint(bool includeIntra = true)``

  * :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>` —
    new constructor ``OEIsSaltBridgeInteractionHint(bool includeIntra = true)``

  * :ref:`OEIsStackingInteractionHint <OEBio_OEIsStackingInteractionHint>` —
    new constructor ``OEIsStackingInteractionHint(bool includeIntra = true)``

  * :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>` —
    new constructor ``OEIsCationPiInteractionHint(bool includeIntra = true)``

  * :ref:`OEIsHalogenBondInteractionHint <OEBio_OEIsHalogenBondInteractionHint>` —
    new constructor ``OEIsHalogenBondInteractionHint(bool includeIntra = true)``

* :ref:`OEDesignUnit <OEBio_OEDesignUnit>` now supports an additional
  ``SetSiteResidues`` overload that accepts
  ``std::vector<OEChem::OEResidue>``. The method validates that residues are
  present in the target, supports ligand coverage checks through ``threshold``
  and ``addBox``, supports optional component reassignment through
  ``rearrangeComponents``, and updates site-associated cofactors through
  ``siteSize``.

* A new overload to the function :oe:func:`OEChem::OEAssignRadii` that operates on
  :oe:cls:`OEBio::OEDesignUnit` has been added. The function
  takes a mask argument and radii types to assign specific radii to specified components.

* The :oe:cls:`OEBio::OEDesignUnit` now tracks the bond order of covalent bonds between components.

* The dictionaries used in :oe:cls:`OEBio::OEResidueCategoryData` have been updated.
  Specifically, `GCP` has been added as a cofactor. In addition, polymers were reclassified
  based on how often they appear as a standalone in the wwPDB, so they can be targeted as ligands, or,
  if they appear frequently as part of larger complexes, they can be treated as cofactors. 

Major Bug Fixes
--------------------------------------------------------------------------------

* An issue has been fixed where using :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>`
  with the :oe:const:`OEBio::OEAltLocFactOption::TrustInputBonds` option
  could lead to incorrect perception of formal charges for atoms that had an atom with 
  multiple alternative locations bonded to it instead of proper reassignment of the implicit
  hydrogen count first.

* The :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` predicate
  previously returned ``true`` for clashing hydrogen bond interactions
  (:oe:const:`OEBio::OEHBondInteractionHintType::ClashAcceptorAcceptor` and
  :oe:const:`OEBio::OEHBondInteractionHintType::ClashDonorDonor`) and for
  unpaired hydrogen bond interactions
  (:oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandDonor`,
  :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandAcceptor`,
  :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinDonor`, and
  :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinAcceptor`).
  These interaction types are now **excluded** from
  :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>`, as they
  represent geometrically unfavorable or unpaired contacts rather than genuine
  hydrogen bonds. Use the new
  :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>`
  predicate to retrieve clashing interactions, and the new
  :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>` predicate
  for unpaired interactions (note: ``OEIsUnpairedInteractionHint`` also returns
  unpaired salt-bridge interactions).

* Similarly, :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>`
  no longer includes clashing types, and
  :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>`
  no longer includes unpaired types.

* The directionality of intramolecular hydrogen bond, salt bridge, and chelator interactions
  has been corrected:

  * Intramolecular hydrogen bond interactions now consistently
    report the donor as the begin fragment and the acceptor as the end fragment.
  * Intramolecular salt bridge interactions now consistently report the positive
    charge as the begin fragment and the negative charge as the end fragment.
  * Intramolecular chelator interactions now consistently report the metal as the
    begin fragment and the chelating atom as the end fragment.

* The :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxAtomPairDistance` has been updated
  to also include the MaxUnpairedDistance in the calculation of the maximum atom pair distance.

Minor Bug Fixes
--------------------------------------------------------------------------------

* :oe:func:`OEBio::OEGetActiveSiteInteractionHintTypes` no longer returns duplicate
  interaction hint types.

* An issue has been fixed where incorrect perception of stacking interactions would occur.
  The new feature mentioned above fixes this issue with an option to control the minimum stack offset
  required for a pi-stacking or T-stacking.

* An issue has been fixed where chelators were incorrectly perceived because of a missing angular term.

* An issue has been fixed where halogen interactions were incorrectly perceived because of a missing angular term.

* An issue has been fixed where, in the :oe:cls:`OEBio::OEIsCTerminalAtom` and :oe:cls:`OEBio::OEIsNTerminalAtom`
  methods, incorrect terminal atom identification could occur for nonstandard amino acid residues.

Python-Specific Changes
--------------------------------------------------------------------------------

* Python wrapping of :oe:meth:`OEBio::OEInteractionHintContainer::GetMolecules` methods has been fixed.




OEDepict TK 2.7.0
================================================================================

New Features
--------------------------------------------------------------------------------

* Two new methods, :ref:`GetOptimizeMacrocycles<OEDepict_OEPrepareDepictionOptions_GetOptimizeMacrocycles>` and
  :ref:`SetOptimizeMacrocycles<OEDepict_OEPrepareDepictionOptions_SetOptimizeMacrocycles>`, have been
  added to :ref:`OEPrepareDepictionOptions<OEDepict_OEPrepareDepictionOptions>` to enable enhanced
  algorithmic depiction of macrocycle rings.



OEDocking TK 4.3.5
================================================================================

Minor Bug Fixes
-----------------

* An issue has been fixed that was causing :ref:`OEPosit <OEDocking_OEPosit>`
  to pick the wrong :ref:`method <OEDocking_OEPositMethod>` in posing some
  ligands.



EON TK 3.1.3
================================================================================

New Features
--------------------------------------------------------------------------------

* Two new methods, :ref:`GetJoinRef<OEEon_OEEonPBOptions_GetJoinRef>` and
  :ref:`SetJoinRef<OEEon_OEEonPBOptions_SetJoinRef>`, have been added to
  :ref:`OEEonPBOptions<OEEon_OEEonPBOptions>` to enable ``PB`` calculation
  on complexes in :ref:`OEEonPBFunc<OEEon_OEEonPBFunc>`.



FastROCS TK 2.3.2
================================================================================

Minor internal improvements have been made.



Grapheme\ :sup:`TM` TK 1.5.5
================================================================================

New Features
--------------------------------------------------------------------------------

* The following preliminary APIs have been added for monomer and peptide
  depiction support.

  **Classes:**

  * :oe:cls:`OEGrapheme::OEPeptideDisplayOptions` — options for peptide depiction.
  * :oe:cls:`OEGrapheme::OEHighlightMonomerDisplayOptions` — options for monomer highlight depiction.
  * :oe:cls:`OEGrapheme::OEMonomerColorDefault` — default monomer color functor.
  * :oe:cls:`OEGrapheme::OEMonomerColorMonochrome` — monochrome monomer color functor.
  * :oe:cls:`OEGrapheme::OEMonomerGlyphStyleBase` — base class for monomer glyph style functor.
  * :oe:cls:`OEGrapheme::OEMonomerGlyphStyleDefault` — default monomer glyph style functor.
  * :oe:cls:`OEGrapheme::OEMonomerGraphDisplayOptions` — options for monomer graph depiction.

  **Functions:**

  * :oe:func:`OEGrapheme::OEDrawMonomer` — draws a monomer image.
  * :oe:func:`OEGrapheme::OEDrawMonomerGraph` — draws a monomer graph of a peptide.
  * :oe:func:`OEGrapheme::OEHighlightMonomers` — highlights monomers in a peptide depiction.


* The :oe:func:`OEGrapheme::OERenderActiveSite` function now displays a counter on
  the top of the T- and pi-stacking interaction lines if multiple interactions
  exist between the aromatic ring of the ligand and the aromatic ring of a specific
  residue.

.. only:: oehtml

   .. figure:: /_images/stacking-count.svg
      :align: center
      :width: 400pt

      **Figure 1.** Example of visualizing multiple stacking interactions (PDB:4TX6).

* The following APIs have been added to allow customization of ligand alignment
  in protein–ligand interaction depictions:

  * :oe:cls:`OEGrapheme::OELigandAlignerBase`
  * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetLigandAlignerFunctor` method
  * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetOptimizeLigandOrientation` method

.. only:: oehtml

   .. list-table::

      * - default ligand orientation
        - ligand aligned to reference substructure

      * -  .. image:: ../../graphemetk/images/releasenotes-latest/complex2image-default.svg
              :width: 250pt
        -  .. image:: ../../graphemetk/images/releasenotes-latest/complex2image-aligned.svg
              :width: 250pt


Minor Bug Fixes
--------------------------------------------------------------------------------

* The :oe:func:`OEGrapheme::OEDrawResidues` function now depicts molecules
  with up to 300 heavy atoms.



GraphSim TK 2.7.1
================================================================================

Minor Bug Fixes
--------------------------------------------------------------------------------

* The hydrogen counts of neighbor atoms when R-groups are removed prior to fingerprint
  generation have been adjusted.



Lexichem TK 2.9.5
================================================================================

Minor internal improvements have been made.




OEMedChem TK 1.2.6
================================================================================

New Features
--------------------------------------------------------------------------------

* A new overload of the :ref:`OECreateIDStrings<OEMedChem_OECreateIDStrings>` function
  has been added to enable speeding up **BROOD** hit list clustering when working
  with multiquery replacements.



MolProp TK 2.7.0
================================================================================

Minor Bug Fixes
--------------------------------------------------------------------------------

* The SMARTS pattern of the :ref:`functional_group_rules_halo_amine` functional group has been fixed.



OEFF TK 2.9.2
================================================================================

Minor Bug Fixes
--------------------------------------------------------------------------------

* The :ref:`OEQuatAdaptor<OEMolPotential_OEQuatAdaptor>` now passes the coordinates
  to the internal :ref:`OEMolFunc<OEMolPotential_OEMolFunc>` when appropriate.



Omega TK 7.0.0
================================================================================

New Features
--------------------------------------------------------------------------------

* The following changes have been made to extend Thompson sampling usage for torsion driving
  in :ref:`OEOmega<OEConfGen_OEOmega>`:

  * The :ref:`Thompson sampling<OEConfGen_OETorDriveOptions_SetUseThompson>` algorithm
    for torsion driving has been improved for robustness and speed.
  * The default value for :ref:`SetUseThompson<OEConfGen_OETorDriveOptions_SetUseThompson>`
    in :ref:`OETorDriveOptions<OEConfGen_OETorDriveOptions>` has been changed to ``True``.
  * The :ref:`SetUseThompson<OEConfGen_OETorDriveOptions_SetUseThompson>` is honored even when
    :ref:`SetUseGPU<OEConfGen_OETorDriveOptions_SetUseGPU>` is set to ``True``.
  * The preliminary API class ``OEThompsonOptions`` has been removed, as it is no longer relevant.

* The default energy window for torsion driving in :ref:`Classic <OEConfGen_OEOmegaSampling_Classic>`
  mode has been changed to a range-based value to better suit **OMEGA** with Thompson sampling.
  Similarly, the energy range for the :ref:`Pose <OEConfGen_OEOmegaSampling_Pose>` mode has also been
  adjusted.


Minor Bug Fixes
--------------------------------------------------------------------------------

* :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` now respects the
  :ref:`MaxEnumConfs <OEConfGen_OEMolBuilderOptions_SetMaxEnumConfs>` provided in 
  the :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>`
  even when an input molecule has more conformers than specified.
  
* Certain edge cases where the torsion driving algorithm would fail with a
  FailedTorDrive error message have been addressed. 



Quacpac TK 2.3.0
================================================================================

Minor internal improvements have been made.




Saiph TK 1.0.1
================================================================================

Python-Specific Changes
--------------------------------------------------------------------------------

* The following APIs are now properly wrapped in Python:

  * :ref:`OESaiphGetArch<OESaiph_OESaiphGetArch>`
  * :ref:`OESaiphGetLicensee<OESaiph_OESaiphGetLicensee>`
  * :ref:`OESaiphGetPlatform<OESaiph_OESaiphGetPlatform>`
  * :ref:`OESaiphGetRelease<OESaiph_OESaiphGetRelease>`
  * :ref:`OESaiphGetSite<OESaiph_OESaiphGetSite>`
  * :ref:`OESaiphGetVersion<OESaiph_OESaiphGetVersion>`
  * :ref:`OESaiphIsLicensed<OESaiph_OESaiphIsLicensed>`




Shape TK 3.10.0
================================================================================

New Features
--------------------------------------------------------------------------------

* When using the :ref:`Overlay<OEShape_OEOverlay_Overlay>`
  method in :ref:`OEOverlay<OEShape_OEOverlay>` for overlay optimization, any of the inertial start
  methods now automatically trigger an additional :ref:`as-is<OEShape_OEAsIsStarts>` start
  if the optimization results in similarity measures less than the original similarity.
  This improves the default behavior of :ref:`Overlay<OEShape_OEOverlay_Overlay>` for
  some calculations.

* The following modifications have been made to :ref:`OEOverlapPrepOptions<OEShape_OEOverlapPrepOptions>`
  to provide more flexibility in assigning color atoms during the :ref:`Prep<OEShape_OEOverlapPrep_Prep>` process
  in :ref:`OEOverlapPrep<OEShape_OEOverlapPrep>`:

    * Two new methods, :ref:`SetRemoveColor<OEShape_OEOverlapPrepOptions_SetRemoveColor>`
      and :ref:`GetRemoveColor<OEShape_OEOverlapPrepOptions_GetRemoveColor>`, have been added
      to enable removal or reassignment of color atoms.
    * The new methods :ref:`AddDuplicateSmarts<OEShape_OEOverlapPrepOptions_AddDuplicateSmarts>`,
      :ref:`GetDuplicateSmarts<OEShape_OEOverlapPrepOptions_GetDuplicateSmarts>`, and
      :ref:`ClearDuplicateSmarts<OEShape_OEOverlapPrepOptions_ClearDuplicateSmarts>` have been added
      to enable duplicate color atom removal based on provided SMARTS patterns.
    * Duplicate color atom removal is now more robust in keeping the central atoms instead 
      of the first atom that it encounters and in placing the remaining atoms appropriately 
      (at the center of corresponding clusters).
    * Defaults for :ref:`SetRemoveDuplicate<OEShape_OEOverlapPrepOptions_SetRemoveDuplicate>`
      and :ref:`SetDuplicateDistance<OEShape_OEOverlapPrepOptions_SetDuplicateDistance>`
      have been changed from ``False`` and `0.001` to ``True`` and `0.0`, respectively. This improves
      robustness but keeps the default behavior unchanged.

* A new method, :ref:`SetupFrame<OEShape_OEStarts_SetupFrame>`, has been added to :ref:`OEStarts<OEShape_OEStarts>`
  that simplifies setting up a reference frame for calculating the starts.


Minor Bug Fixes
--------------------------------------------------------------------------------

* The overlay optimization in :ref:`OEHermiteOverlay<OEShape_OEHermiteOverlay>`
  with the :ref:`OEAsIsStarts<OEShape_OEAsIsStarts>` start option has been updated to use Hermite
  expansions around the center of mass to prevent inconsistent overlaps when objects are
  far from the origin.

* Overlay optimization with the :ref:`Overlay<OEShape_OEOverlay_Overlay>`
  method in :ref:`OEOverlay<OEShape_OEOverlay>` now captures the fit conformer
  self-overlap and color scores more accurately during the optimization.



SiteHopper TK 2.1.4
================================================================================

Minor internal improvements have been made.


   

Spicoli TK 1.6.4
================================================================================

Minor internal improvements have been made.



Spruce TK 1.9.0
================================================================================

New Features
--------------------------------------------------------------------------------
* The maximum cluster size for partial residues built using :ref:`OEBuildSidechains <OESpruce_OEBuildSidechains>` can 
  now be set in :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>`
  using :ref:`SetMaxClusterSize <OESpruce_OESidechainBuilderOptions_SetMaxClusterSize>`.

* The chemical component dictionary has been updated. However, if using mmCIF, the metadata will
  be used as primary information and the dictionary only engages if metadata is unavailable.

Minor Bug Fixes
--------------------------------------------------------------------------------

* An issue has been fixed in the routine to reassign ambiguous water and metals
  from packing residues to the protein chain of interest. The issue caused HEME analogs and connected amino acids
  to be soaked into a given chain ID.

* An issue has been fixed to allow :oe:cls:`OESpruce::OEHeterogenMetadata` to inform
  the component splitter during design unit generation and preparation. This also fixes an
  issue where the splitter would not allow reclassification of a metal ion to an excipient.

* An issue has been fixed that caused the option to collapse redundant alternate locations
  to improperly engage if there were multiple binding sites in a protein.

* An issue has been fixed that caused the option to collapse redundant alternate locations
  to improperly engage for different ligands in the same binding site.

* An issue has been fixed that caused :oe:func:`OESpruce::OEMutateResidues` to incorrectly
  leave the backbone nitrogen of a residue in a bad valence state when mutating from Proline.

* An issue has been fixed in :oe:func:`OESpruce::OEBuildSidechains` with the shell mutation option turned
  on that would leave side chains clashing with water molecules. The water molecules are now removed
  if the option to allow for removal of clashing waters is set to ``True``.



Szmap TK 1.7.4
================================================================================

Minor internal improvements have been made.




Szybki TK 2.9.2
================================================================================

Minor internal improvements have been made.




Zap TK 2.5.3
================================================================================

Major Bug Fixes
--------------------------------------------------------------------------------

* Salt concentration implementation in **Zap TK** has been corrected and made robust
  at higher salt concentrations.

* As a result of the salt concentration improvement, the rotational
  variation of Zap solvation energy at high salt concentrations has been
  substantially reduced.



.. _highlights_2025_fall:

********************
OEToolkits 2025.2
********************

Release Highlights 2025.2
=============================

Shape: Features Extension
-----------------------------------------------------------------------------

New functionalities have been added to improve **Shape TK** and **ROCS** handling 
of queries beyond those derived from molecules. Major new features include using 
queries consisting only of color atoms or Gaussians (Figure 1), and the ability 
to search a database of grids as well as molecules. The ability to work with non-molecular 
queries has also been enhanced by introducing a new algorithm to generate Gaussians 
from a grid that can better capture sparse grids (Figure 2).

.. figure:: /_images/color_only_overlay.png
   :width: 800pt
   :align: center

   **Figure 1.** A color-only query consisting only of color Gaussians (left). The overlay
   of a molecule on that color-only query (right).

.. figure:: /_images/grid_grid_overlay.png
   :width: 500pt
   :align: center

   **Figure 2.** The overlay of a grid on another grid as query.

Saiph TK: New Toolkit for ETL
-----------------------------------------------------------------------------

This release introduces **Saiph TK**, a toolkit for extracting, transforming, and 
loading (ETL) files, bringing the existing Orion ETL functionality for file conversion 
into the toolkits, providing greater accessibility and improved performance.

Major functionality in the **Saiph TK** includes conversion of various molecule 
file formats, including SMILES and CXSMILES, SD, Spruce TK design unit files, and Shape TK 
query files, into a set of records. **Saiph TK** also provides functionality to 
interconvert CSV files and records, and to create a Pandas dataframe directly from any 
supported format, enabling smooth integration of molecule objects into machine learning 
in Python.

OEChem TK and Spruce TK: Improvements to CIF File Format Support
-----------------------------------------------------------------------------

The Worldwide Protein Data Bank (wwPDB) has officially deprecated the legacy PDB file 
format in favor of mmCIF. The format has recently been expanded to include residue 
topology information, and the RCSB has worked to ensure that all deposited structures include
these new mmCIF-specific categories. In alignment with wwPDB and RCSB recommendations, 
we now advise using the mmCIF format for all macromolecular structures.
 
To support the transition, the CIF file reader in **OEChem** has been improved particularly 
in regard to reading the mmCIF file format variant. New APIs have been added that
allow parsing and modification of the mmCIF metadata. Improvements to CIF file writing 
has also been made to be more correct when header data is missing or has been manually 
altered.
 
The **Spruce** filter now leverages mmCIF header data to refine structure perception during 
standardization prior to preparation. Additionally, support has been added for reading 
structure factor CIF files into grids, replacing MTZ files for electron density maps.

..  _supported-tk-platforms-fall-2025:

Supported Platforms
---------------------

  ===========  ============  =============================  ======================  ========================
  Package      Versions      Linux                          Windows                 macOS
  -----------  ------------  -----------------------------  ----------------------  ------------------------
  Python       3.10 - 3.13   RHEL8/9, Ubuntu22/22-ARM/24    Win10/11                13, 14, 15
  C++                        RHEL8/9, Ubuntu22/22-ARM/24    Win10/11 (VS2022)       13, 14, 15
  Java         8, 11, 21     RHEL8/9, Ubuntu22/22-ARM/24    Win10/11                13, 14, 15
  C#                                                        Win10/11 (VS2022)
  ===========  ============  =============================  ======================  ========================

Related TK Versions
---------------------

  ==============  ===========
  Toolkit         Version
  --------------  -----------
  Bioisostere TK  4.2.1
  OEChem TK       4.3.0
  OEDepict TK     2.6.0
  OEDocking TK    4.3.4
  Eon TK          3.1.2
  FastROCS TK     2.3.1
  OEFF TK         2.9.1
  Grapheme TK     1.5.4
  Graphsim TK     2.7.0
  Lexichem TK     2.9.4
  OEMedChem TK    1.2.5
  MolProp TK      2.6.7
  Omega TK        6.1.1
  Quacpac TK      2.2.7
  Saiph TK        1.0.0
  Shape TK        3.9.0
  SiteHopper TK   2.1.3
  Spicoli TK      1.6.3
  Spruce TK       1.8.0
  Szmap TK        1.7.3
  Szybki TK       2.9.1
  Zap TK          2.5.2
  ==============  ===========

General Notices
==================

* Support for Python 3.13 has been added for all supported platforms.

* Support for Python 3.10 will be dropped in the Spring 2026 release, and Python 3.11 will be dropped in the fall of 2026.

* Support for Python 3.14 will be added in the Spring 2026 release.

* Support for macOS 26 will be added in the Spring 2026 release, and support for macOS 13 will be dropped.

* Support for Windows 10 will be dropped in the Spring 2026 release.


.. _highlights_2025_spring:

********************
OEToolkits 2025.1
********************

OEToolkits 2025.1
********************

Release Highlights 2025.1
=============================

FastROCS: Grid Query Support
-----------------------------------------------------------------------------

The 2025.1 release adds support for grid shape queries in **FastROCS TK**, as is already 
available in the **Shape TK** and **ROCS**. The ability to use shape grids substantially 
expands the application of **FastROCS TK** to queries beyond those derived from molecules.

To assess the efficacy of grid-derived versus molecule-derived queries **ROCS** was run with 
a series of thirteen molecule-derived queries, as well as the corresponding grid-derived queries, 
against a database of 1M molecules and the top-ranked 10K hitlist for each of the 13 was retained. 
**FastROCS** was then run with the same molecule-derived and grid-derived queries, and the 
fraction of the top-ranked 10K hits in common with the reference ROCS hitlist was calculated 
(see Figure 1). The fraction of molecules in common is almost completely constant (compare 
the black and pink bars in Figure 1), whether FastROCS was used with a molecule-derived query 
or the corresponding grid-derived query.

.. figure:: /_images/ROCS_vs_FastROCS_shapeonly.png
   :width: 750pt
   :align: center

   **Figure 1.** Thirteen query molecules and their shape grids (left). A graph of **ROCS** 
   versus **FastROCS** overlap in finding the same molecules in the hit list (right).

Bioisostere TK: Feature Extensions
-----------------------------------------------------------------------------

New functionality has been added to **Bioisostere TK**, bringing all features of the 
**BROOD** application into the toolkit. Some of the major new features in the toolkit 
include the ability to build queries in the presence of the target protein binding site 
and/or a selectivity protein, as well as creating bridging queries that connect two 
molecules. New APIs have also been added to enable checking whether compounds similar 
to the analogs generated by **BROOD** exist in commercial or internal databases, allowing 
a chemist to consider molecules available for purchase before undertaking the synthesis 
of a given analog.

With all of the **BROOD** functionality now available in Bioisostere TK, **BROOD** has been 
reengineered with **Bioisostere TK** to simplify and streamline coordination with the toolkit, 
ensuring that consistent results are provided between **BROOD** and **Bioisostere TK**. The 
graphical application **vBROOD** has been also been rewired to the newly engineered **BROOD**.

Representation of both active site and selectivity proteins in **Bioisostere TK**, **BROOD**, 
and **vBROOD** has been modified to work with the **OEDesignUnit**.

.. figure:: /_images/brood_query_in_active_site.png
   :width: 350pt
   :align: center

   **Figure 2.** Building a **BROOD** query in a protein active site.

SZYBKI: Robust Protein–Ligand Optimization
-----------------------------------------------------------------------------

The robustness of ligand optimization in a protein active site has been improved in both 
**Szybki TK** and **SZYBKI**.

Optimization failures due to non-planarity in aromatic rings of optimized structures are now 
separated from those due to excess atomic overlap in the starting structures, allowing better handling 
of failed optimizations. Failures due to a low level of aromatic ring bending, which is a common 
artifact of force-field-based optimization, can now be ignored, producing a substantial increase 
in successful ligand optimizations. The criterion for flagging an optimized structure as having 
bent aromatic rings has also been modified. Overall, the revised algorithm allows more structures 
to pass through the minimization process, while still giving the user the ability to flag results 
with deformed aromatic rings.

Besides these algorithmic modifications, there are improvements in integrating optimization of 
**POSIT** generated pose and in assigning **AM1BCCELF10** charges to ligands, with **SZYBKI**.

..  _supported-tk-platforms-spr-2025:

Supported Platforms
---------------------

  ===========  ============  =============================  ======================  ========================
  Package      Versions      Linux                          Windows                 macOS
  -----------  ------------  -----------------------------  ----------------------  ------------------------
  Python       3.10 - 3.12   RHEL8/9, Ubuntu22/22-ARM/24    Win10/11                13, 14, 15
  C++                        RHEL8/9, Ubuntu22/22-ARM/24    Win10/11 (VS2022)       13, 14, 15
  Java         8, 11, 20     RHEL8/9, Ubuntu22/22-ARM/24    Win10/11                13, 14, 15
  C#                                                        Win10/11 (VS2022)
  ===========  ============  =============================  ======================  ========================

Related TK Versions
---------------------

  ==============  ===========
  Toolkit         Version
  --------------  -----------
  Bioisostere TK  4.2.0
  OEChem TK       4.2.0
  OEDepict TK     2.5.6
  OEDocking TK    4.3.3
  FastROCS TK     2.3.0
  OEFF TK         2.9.0
  Grapheme TK     1.5.3
  Graphsim TK     2.6.2
  Lexichem TK     2.9.3
  OEMedChem TK    1.2.4
  MolProp TK      2.6.6
  Omega TK        6.1.0
  Quacpac TK      2.2.6
  Shape TK        3.8.0
  SiteHopper TK   2.1.2
  Spicoli TK      1.6.2
  Spruce TK       1.7.0
  Szmap TK        1.7.2
  Szybki TK       2.9.0
  Zap TK          2.5.1
  ==============  ===========

General Notices
==================

* Support for Ubuntu 24.04 has been extended for all applications except VIDA. Support for VIDA will be added in a later release. 
  Support for Ubuntu 24.04 for C++, Python, and Java toolkits was already added in the previous release. Support for Ubuntu 20.04 has been discontinued from this release.

* Support for macOS 15 has been added for C++, Python, and Java toolkits, as well as applications and **VIDA**.

* Support for Python 3.13 is not available in this release but will be added in a future release. Support for Python 3.9 has been discontinued from this release.



.. _highlights_2024_Fall:

********************
OEToolkits 2024.2
********************

OEToolkits 2024.2.1
********************

The **OEToolkits 2024.2.1** is a bug-fix of the **OEToolkits 2024.2.0** release.

  * :ref:`OEChem Notes <section_oechemtk_releasenotes_4111>`
  * :ref:`Spruce Notes <section_sprucetk_releasenotes_1611>`

OEToolkits 2024.2.0
********************

Release Highlights 2024.2.0
=============================

..  raw:: html

    <!-- The script tag should live in the head of your page if at all possible -->
    <script type="text/javascript" async src="https://play.vidyard.com/embed/v4.js"></script>

    <!-- Put this wherever you would like your player to appear -->
    <img
      style="width: 100%; margin: auto; display: block; max-width: 600px;"
      class="vidyard-player-embed"
      src="https://play.vidyard.com/aJobbXVTJT1aZFdsr1WUEr.jpg"
      data-uuid="aJobbXVTJT1aZFdsr1WUEr"
      data-v="4"
      data-type="inline"
      data-width="600"
    />
    <p>

OMEGA: Thompson Sampling for Torsion Driving
-----------------------------------------------------------------------------

A Bayesian approach to explore conformer space with torsion driving has been added as an alternative
to the exhaustive searching of the space in **OMEGA**. This uses the framework of Thompson sampling  
to quickly direct the conformer search towards the low energy structures, reducing the time required
to find the lowest energy conformer. As such, Thompson sampling is particularly suitable for generating
small to moderately sized ensembles, such as used in the ``FastROCS`` or ``ROCS`` mode.
Thompson sampling provides significant speedup for such ensemble generation, particularly for molecules 
with a large number of rotors.

Conformer ensembles for ``FastROCS`` usage are generated with **OMEGA** using both the standard
exhaustive sampling and the newly implemented Thompson sampling, for ~5500 Iridium HT protein bound
small molecule crystal structures. Performance between the two sampling methods is compared
in terms of RMSD between the generated ensemble and the crystal pose, and in the time required to
generate the ensembles.  The results of the comparison, as shown in Figure 1 below, show that
the accuracy of the generated ensembles, measured in RMSD, remains unaffected when using
exhaustive versus Thompson sampling, whereas there is significant reduction in time usage to
generate those ensembles when using Thompson sampling, especially as the size of the molecules grows.

.. figure:: /_images/omega_thompson_mmds.png
   :width: 550pt
   :align: center

   **Figure 1.** Comparison of **OMEGA** performance between exhaustive and Thompson sampling.

Ligand-based virtual screening performance, using both the exhaustive and Thompson sampling
generated ensembles, was also compared and displayed in Figure 2. The comparisons were performed
using directory of useful decoys (DUD-Z) datasets containing 38 targets. The results ensure that
there is no meaningful change in accuracy when using Thompson sampling for ensemble generation
for usage in ligand-based virtual screening.

.. figure:: /_images/omega_thompson_vs.png
   :width: 350pt
   :align: center

   **Figure 2.** Comparison of performance of ligand-based virtual screening success rate
   with conformer ensembles generated using exhaustive versus Thompson sampling.

BROOD: Bioisosteric Fragment Replacement in Macrocyclic Peptides
-----------------------------------------------------------------------------

A new pose generation algorithm has been introduced in **Bioisostere TK**, as well as in **BROOD**, 
based on flexible overlay of shape, color, and force fields, as used in pose generation with **ShapeFit**.
The new algorithm generates high quality poses of molecules that are obtained from fragment replacement
in **Bioisostere TK** and **BROOD**. The robust pose generation algorithm enables usage of **Bioisostere TK** 
and **BROOD** for molecules with complex geometry, including macrocyclic peptides. Figure 3 shows an
example of a residue fragment replacement in a macrocyclic peptide.

.. figure:: /_images/brood_macro_peptide.png
   :width: 350pt
   :align: center

   **Figure 3.** Bioisosteric replacement of a residue fragment in a macrocyclic peptide using **BROOD**.

Eon TK: New Toolkit for Overlay Optimization with Shape and Charge Density
-----------------------------------------------------------------------------

The 2024.2 release introduces **Eon TK**, a new toolkit for molecular similarity
based on shape and electrostatics. This provides toolkit-level access to the existing
**EON** application functionality. Following **EON**, the new toolkit has both
molecular charge density and electrostatic potential as options to use as
descriptors of electrostatic properties. Figure 4 shows an example of **EON** overlay
with charge density visualization.

.. figure:: /_images/eon_electrostatic_overlay.png
   :width: 550pt
   :align: center

   **Figure 4.** **EON** shape charge density overlay between two molecules.

**Eon TK** provides tools for molecular overlay optimization with shape and charge density,
similarity estimation based on shape and charge density or electrostatic potential, and
corresponding hit list building.

..  _supported-platforms-fall-2024:

Supported Platforms
---------------------

  ===========  ============  =================================  ======================  ========================
  Package      Versions      Linux                              Windows                 macOS (x64 and arm64)
  -----------  ------------  ---------------------------------  ----------------------  ------------------------
  Python       3.9 - 3.12    RHEL8/9, Ubuntu20/22/22-ARM/24     Win10/11                12, 13, 14
  C++                        RHEL8/9, Ubuntu20/22/22-ARM/24     Win10/11 (VS2022)       12, 13, 14
  Java         8, 11, 20     RHEL8/9, Ubuntu20/22/22-ARM/24     Win10/11                12, 13, 14
  C#                                                            Win10/11 (VS2022)
  ===========  ============  =================================  ======================  ========================

Related TK Versions
---------------------

  ==============  ===========
  Toolkit         Version
  --------------  -----------
  Bioisostere TK  4.1.0
  OEChem TK       4.1.1
  OEDepict TK     2.5.5
  OEDocking TK    4.3.2
  FastROCS TK     2.2.7
  OEFF TK         2.8.0
  Grapheme TK     1.5.2
  Graphsim TK     2.6.1
  Lexichem TK     2.9.2
  OEMedChem TK    1.2.3
  MolProp TK      2.6.5
  Omega TK        6.0.0
  Quacpac TK      2.2.5
  Shape TK        3.7.0
  SiteHopper TK   2.1.1
  Spicoli TK      1.6.1
  Spruce TK       1.6.1
  Szmap TK        1.7.1
  Szybki TK       2.8.0
  Zap TK          2.5.0
  ==============  ===========

General Notices
==================

* Support for Java 8 and 11 is now available on all platforms, including macOS arm64.

* Support for Ubuntu 24.04 has been added for C++, Python, and Java toolkits. Support for applications and VIDA will be added in the next release.

* Support for macOS 15 is not available in this release but will be added in the next release. This release will be the last to support macOS 12.

* Support for Python 3.13 is not available in this release but will be added in the next release.

* Support for Ubuntu 20.04 has been continued in this release, which will be the last to provide support for Ubuntu 20.04.


.. _highlights_2024_Spr:

********************
OEToolkits 2024.1
********************

OEToolkits 2024.1.3
********************

The **OEToolkits 2024.1.3** is a bug-fix of the **OEToolkits 2024.1.0** release.

  * :ref:`section_oefftk_releasenotes_2713`
  * :ref:`section_szybkitk_releasenotes_2713`
  * :ref:`section_oedockingtk_releasenotes_4313`
  * :ref:`section_graphemetk_releasenotes_1513`

OEToolkits 2024.1.0
********************

Release Highlights 2024.1.0
=============================

..  raw:: html

    <script type="text/javascript" async src="https://play.vidyard.com/embed/v4.js"></script>

    <!-- Put this wherever you would like your player to appear -->
    <img
      style="width: 100%; margin: auto; display: block; max-width: 600px;"
      class="vidyard-player-embed"
      src="https://play.vidyard.com/CMZ6j9fLPERatLydBgqfCb.jpg"
      data-uuid="CMZ6j9fLPERatLydBgqfCb"
      data-v="4"
      data-type="inline"
      data-width="600"
    />
    <p>

EON: Overlay Optimization with Shape and Charge Density
-----------------------------------------------------------------------------

**EON**, the tool for molecular similarity based on shape and electrostatics, has been
reimagined with the addition of charge density as a descriptor for electrostatic properties.
By replacing electrostatic potential with molecular charge density as the primary
descriptor of electrostatic properties, **EON** no longer requires the input molecules to
be pre-aligned with the query molecule. Instead, **EON** now aligns the input molecules
using shape- and electrostatics-based overlay optimization, where electrostatics are modeled via
molecular charge density. **EON** still has the option to use electrostatic potential as
a measure of similarity, if desired. Figure 1 shows an example of **EON** overlay with charge
density visualization.

.. figure:: /_images/eon_v3_shape_charge_overlay.png
   :width: 350pt
   :align: center

   **Figure 1.** **EON** shape charge density overlay between two molecules.

Even with the addition of overlay optimization within the workflow, the new **EON** is
now significantly faster compared to the previous version; and yet, as a
tool for virtual screening with shape and charge similarity, the behavior of **EON** remains the same. When compared to
**ROCS**, **EON** lags slightly when measured in terms of virtual screening success
rates but excels in finding hits that are more chemically diverse.

.. program:: EON

Performance of the previous and current versions of **EON**, as compared to **ROCS**,
are displayed in Figure 2. The comparisons were performed using multi-query directory of
useful decoys (MDUD) datasets containing 38 targets. The current version of **EON**
overlays and scores with shape and charge similarity. A command line flag ``-potential`` supports the rescoring
of shape- and charge-aligned conformers with shape and electrostatic potential similarity. The current default version
of **EON** is now almost as fast as **ROCS**, as can be seen in the right-hand plot below.

.. figure:: /_images/eon_v3_vs_mdud_comparison_of_methods.png
   :width: 550pt
   :align: center

   **Figure 2.** Comparison of performance of **EON** and **ROCS** for virtual screening
   success rate (left); for chemical diversity of actives found (middle); and for the speed of
   calculations (right).  “Current” refers to the default version using shape and charge density for similarity, and “current
   (potential)” refers to **EON** using shape and electrostatics.

FLYNN: Ligand fitting for Cryo-EM
-----------------------------------------------------------------------------

**FLYNN**, the tool for fitting small molecules to electron density, has been extended to
support density maps generated through **cryo-electron microscopy (cryo-EM)**.

**FLYNN** is a powerful tool for ligand fitting that uses adiabatic fitting to generate
the best-fitting, lowest strain conformers consistent with experimental electron densities
and structural models. This tool was one of the first to enable high-quality, physics-informed
pockets and poses from X-ray crystallographic models. **FLYNN** has now been updated
to enable researchers to access the same powerful insights from maps and models generated
through cryo-electron microscopy (cryo-EM).

.. figure:: /_images/FLYNN_for_CryoEM.png
   :width: 500 pt
   :align: center

   **Figure 3.** Ligand fitting with **FLYNN** to predict binding pockets and poses consistent
   with electron density from cryo-electron microscopy (cryo-EM).

Hydrogen Placement Updates in **SPRUCE**
-----------------------------------------------------------------------------

In the 2024.1 release of **SPRUCE**, several improvements have been made to :ref:`OEPlaceHydrogens <OEBio_OEPlaceHydrogens>` to handle metal cation chelation effects
on the nearby protonation states, specifically for ligands.
The changes shown in Figure 5 below highlight new state and optimized geometries for sulfonamide, hydroxamate, phosphate, and borate groups.
In addition, changes have been made around geometries for  sp\ :sup:`3`  secondary amines.
Lastly, improvements have been added in :ref:`OEProtonateDesignUnit <OESpruce_OEProtonateDesignUnit>` to allow for protonation state changes
related to the detection of unfavorable acceptor–acceptor clashes, resulting in a more favorable hydrogen bond network.

.. figure:: /_images/Hplacement.png
   :width: 500pt
   :align: center

   **Figure 4.** Examples of improved chelator interactions and deprotonation rules for different moieties: hydroxamate, sulfonamide, and phosphates/borates.
   Also, on the bottom right, an example of improved interaction networks with acceptor–acceptor heuristic fixes.

Bioisostere TK: New Toolkit for Bioisosteric Fragment Replacement
-----------------------------------------------------------------------------

The 2024.1 release introduces **Bioisostere TK**, a new toolkit for bioisosteric
analog generation. It involves replacing a portion of a lead compound with fragments
that have similar shape and electrostatics but with potentially novel connectivity
and chemistry. This provides toolkit level access to the existing
**BROOD**  application functionality.

**Bioisostere TK** also brings several additional functionalities. At its core are tools
for fragment-based modeling, such as fragment creation, fragment conformer generation, and
fragment alignment and similarity in 3-dimensional space. **Bioisostere TK** brings OpenEye's
shape-, color-, and electrostatics-based molecular similarity tools into fragment-based similarity.
It also exposes tools for the generation of 3D molecule conformers with fragment
replacement.

An example of fragment alignment with **Bioisostere TK** based on shape and color
is shown in Fopeigure 3. The attachment points in both the reference and fit fragments are
marked in purple. The fragment overlay highlights how special attention is paid to the
overlay of the attachment points.

.. figure:: /_images/fragment_overlay.png
   :width: 500pt
   :align: center

   **Figure 5.** Fragment overlay between a reference and a fit fragment.

..  _supported-platforms-spring-2024:

Supported Platforms
---------------------

===========  ===================  ===========================   ===============================  ============================================
Package      Versions             Linux                         Windows                          macOS (x64 and arm64)
-----------  -------------------  ---------------------------   -------------------------------  --------------------------------------------
Python       3.9 - 3.12           RHEL8/9, Ubuntu20/20-ARM/22   Win10/11                         12, 13, 14
C++                               RHEL8/9, Ubuntu20/20-ARM/22   Win10/11 (VS2022)                12, 13, 14
Java         8, 11, 20            RHEL8/9, Ubuntu20/20-ARM/22   Win10/11                         12, 13, 14 (only Java 20 support for arm64)
C#                                                              Win10/11 (VS2022)
===========  ===================  ===========================   ===============================  ============================================

Related TK Versions
---------------------

  ==============  ===========
  Toolkit         Version
  --------------  -----------
  Bioisostere TK  4.0.0
  OEChem TK       4.1.0
  OEDepict TK     2.5.4
  OEDocking TK    4.3.1
  FastROCS TK     2.2.6
  OEFF TK         2.7.1
  Grapheme TK     1.5.1
  Graphsim TK     2.6.0
  Lexichem TK     2.9.1
  OEMedChem TK    1.2.2
  MolProp TK      2.6.4
  Omega TK        5.1.0
  Quacpac TK      2.2.4
  Shape TK        3.6.2
  SiteHopper TK   2.1.0
  Spicoli TK      1.6.0
  Spruce TK       1.6.0
  Szmap TK        1.7.0
  Szybki TK       2.7.1
  Zap TK          2.4.7
  ==============  ===========

General Notices
==================

* Support for  Java 20 is now available on all platforms. 

* Support for macOS 14 has been added.

* Python 3.12 is now supported on all platforms.

* This release will be the last to support Ubuntu 20.04. Support for Ubuntu 24.04 will be added in the next release.


.. _highlights_2023_Fall:

********************
OEToolkits 2023.2
********************

OEToolkits 2023.2.0
===================

Release Highlights
******************

  * Sage force field (Sage 2.1.0), from the Open Force Field Consortium, is now
    available in **OMEGA** as a complement to MMFF94.
  * The defaults for Sage force field from the Open Force Field Consortium have been updated
    to the latest 2.1.0 version, everywhere Sage is supported.
  * The built-in fragment library in **OMEGA** has been updated; expanding on 80 K fragments
    in the previous library, the new fragment library contains approximately 540 K fragments.
  * Stereo-enumeration options in **Flipper** have been improved to allow fine-grained
    control over enumerating different types of atom and bond stereocenters in an uncoupled manner.
  * The torsion scanning algorithm in **SZYBKI** has been improved by adding the ability to optimize
    in internal coordinate space.
  * Protein–ligand optimization with FF14SB-OpenFF in **SZYBKI** has been improved for performance
    and robustness.
  * Support for PDBx/mmCIF in **OEChem TK** has been improved, following the format updates to
    PDB entries by wwPDB. The MMCIF reader now runs on Gemmi version 0.6.2.
  * A preliminary API has been added to provide reaction automapping ability, based on the
    maximum common substructure, enhancing reaction support in **OEChem TK**.
  * Python toolkit packaging has been improved to use pyproject.toml to declare metadata
    and dependencies.

..  raw:: html

    <!-- The script tag should live in the head of your page if at all possible -->
    <script type="text/javascript" async src="https://play.vidyard.com/embed/v4.js"></script>
    <!-- Put this wherever you would like your player to appear -->
    <img
      style="width: 100%; margin: auto; display: block; max-width: 600px;"
      class="vidyard-player-embed"
      src="https://play.vidyard.com/U4RJuy7C54uCfLsFDMsBhU.jpg"
      data-uuid="U4RJuy7C54uCfLsFDMsBhU"
      data-v="4"
      data-type="inline"
      data-width="600"
    />
    <p>

..  _supported-platforms-fall-2023:

Supported Platforms
*******************

  ===========  ===================  ===========================   ===============================  =====================
  Package      Versions             Linux                         Windows                          macOS (x64 and arm64)
  -----------  -------------------  ---------------------------   -------------------------------  ---------------------
  Python       3.9, 3.10, 3.11      RHEL8/9, Ubuntu20/20-ARM/22   Win10/11                         12, 13
  C++                               RHEL8/9, Ubuntu20/20-ARM/22   Win10/11 (VS2022)                12, 13
  Java         8, 11                RHEL8/9, Ubuntu20/20-ARM/22   Win10/11                         12, 13
  C#                                                              Win10/11 (VS2022)
  ===========  ===================  ===========================   ===============================  =====================

Related TK Versions
*******************

  ==============  ===========
  Toolkit         Version
  --------------  -----------
  OEChem TK       4.0.0
  OEDepict TK     2.5.3
  OEDocking TK    4.3.0
  FastROCS TK     2.2.5
  OEFF TK         2.7.0
  Grapheme TK     1.5.0
  Graphsim TK     2.5.7
  Lexichem TK     2.9.0
  OEMedChem TK    1.2.1
  MolProp TK      2.6.3
  Omega TK        5.0.0
  Quacpac TK      2.2.3
  Shape TK        3.6.1
  Sitehopper TK   2.0.4
  Spicoli TK      1.5.7
  Spruce TK       1.5.3
  Szmap TK        1.6.7
  Szybki TK       2.7.0
  Zap TK          2.4.6
  ==============  ===========

General Notices
==================

* Support for MacOS arm64 Java is now available.

* Python toolkits now use pyproject.toml to declare their metadata and dependencies, and no longer use the deprecated setup.py method.

* Python 3.11 is now fully supported on Windows.

* This is the last release to support MacOS 12.  Support for MacOS 14 will be added in the next release.

* Python 3.12 will not be fully supported until the next release.

* This is the last release to support Python 3.9




OEToolkits 1.7.0
================================================================================

This is a new release of the OpenEye Toolkits with versions of the
following libraries:

:OEChem TK: 1.7.0
:Grid TK: 1.3.2
:Lexichem TK: 1.9.0
:Ogham TK: 1.7.0
:Omega TK: 2.3.3
:Quacpac TK: 1.4.0
:Shape TK: 1.7.1
:Spicoli TK: 1.0.2
:Szybki TK: 1.3.4
:Zap TK: 2.1.1

* This release starts the transition from the old LaTeX based
  documentation system to the new reStructuredText based system.

* Starting with *OEChem* 1.7.0 the core OpenEye toolkits
  (``OEPlatform``, ``OESystem``, ``OEChem``, ``OEBio``) are now
  considered "thread-safe". The :ref:`Thread Safety
  <section_threadsafety>` section in the *OEChem* theory manual goes
  into more depth of what it means to be "thread-safe". Many minor
  changes were made to achieve this, only the major ones are listed
  in the release notes. No guarantee is made about any other library.

.. oe:language:: python

   .. note::
   
      The Python global interpreter lock is released around
      computationally expensive OEChem functions. Even so, the utility
      of threading in Python is still limited.

.. oe:language:: java

   *  *OEChem* objects no longer rely on finalizers to clean
      themselves up (*i.e.*, free memory). A separate thread is
      spawned to specifically handle *OEChem* object deletion. This
      reduces the risk of creating objects faster than the Java
      garbage collector can free them, usually leading to the process
      either running very slow, or crashing due to low memory.

   *  *OEChem* will allocate all memory from the Java heap. This makes
      *OEChem* adhere to any memory restrictions placed on the JVM. It
      also allows for more reliable ``OutOfMemory`` exceptions to be
      thrown back to Java code in the event the JVM heap runs out of
      memory.

   *  In previous versions, many functions had arguments of the type
      SWIGTYPE_p_float or SWIGTYPE_p_unsigned_int. These were 
      opaque C++ pointers that could be created from the OE*Array 
      family of classes. To simplify use, many functions that 
      formerly took a SWIGTYPE_p_* now just take the corresponding
      OE*Array class instance directly. In previous versions, the 
      user had to directly call the ``cast()`` method, but that is 
      done inside the wrapper now.

*  Many example programs have been renamed and cleaned up to provide
   better support across all three languages. 

*  Documentation example code is given a descriptive name instead of
   an out of date chapter and section number.



OEToolkits 1.7.1
================================================================================

This is a new release of the OpenEye Toolkits with versions of the
following libraries:

:OEChem TK: 1.7.1
:GraphSim TK: 1.0.0
:Grid TK: 1.3.3
:Lexichem TK: 2.1.0
:MolProp TK: 
:Ogham TK:
:Omega TK: 1.4.0
:Quacpac TK: 1.4.1
:Shape TK: 1.4.0
:Spicoli TK: 1.1.0
:Szybki TK:
:Zap TK: 2.1.1

* There are two major additions to the OpenEye toolkit suite with this
  release:

  :GraphSim TK: 

  A toolkit for doing 2D molecule similarity. The methods currently
  implemented are:
  
  * Path based fingerprints
  * MACCS key fingerprints
  * LINGOS

  :MolProp TK: 

  A toolkit derived from OpenEye's FILTER technology. This toolkit is
  useful for calculating an extensive list 2D molecular properties and
  building custom filters around these properties.

  .. note:: 

     The version number of *MolProp TK* will track with the FILTER
     application to indicate similarities. 
  

* This release of OEChem introduces many bug fixes and new features
  provided they didn't break source-level compatibility with 1.7.0. 

* This release completes the transition from the old LaTeX based
  documentation system to the new reStructuredText based system. This
  includes better support for Python and Java in the manuals as
  separate manuals for every library.

.. oe:language:: python
   
   * The ``OE_ARCH`` environment variable has been introduced to force
     the python libraries to load shared libraries for a specific
     architecture. This can be useful for getting OpenEye libraries to
     work on non-officially-supported platforms.

   * Quacpac: Added support for writing a custom OETautomerMolFunction
     or OETyperMolFunction in Python by deriving from the base class. 

.. oe:language:: java

   * JDK1.5 would sometimes crash while loading the 1.7.0
     libraries. This bug was introduced in 1.7.0 with the change to
     make all OpenEye library memory allocation use memory from the
     Java heap. However, JDK1.5 has a known bug
     `http://bugs.sun.com/view_bug.do?bug_id=6253386
     <http://bugs.sun.com/view_bug.do?bug_id=6253386>`_ which doesn't
     allow accessing the JVM during library initialization. Therefore,
     we now detect when the OpenEye libraries are being loaded by
     JDK1.5 and turn off Java heap allocation during library
     initialization. The amount of memory allocated during library
     initialization is usually negligible, so this shouldn't allow
     programs to exceed the Java heap restrictions very much.

     .. warning:: 
     
        This fix introduces a rare corner case that could cause the
        OpenEye libraries to leak memory. It will only occur if the
        following sequence of events occurs:

        .. list-table:: **Race Condition Causing Memory Leak**
           :header-rows: 1

           * - Thread 1
             - Thread 2
           * - Load *OEChem*
             -
           * - Allocate *OEChem* objects
             -
           * - 
             - Start loading another OpenEye library (e.g. OEDepict)
           * - Deallocate *OEChem* objects
             -
           * - This thread is terminated causing the *OEChem* objects to leak
             -
           * - 
             - Finish loading library
           

        If this occurs *OEChem* will throw the following warning:
        
        :: 

           Leaking memory (0x00000000) because OEUseJavaHeap is false
           Contact OpenEye support if this message is seen

        .. note::

           None of this is possible in JDK1.6.

   * `OEChem::OEIter::Target` and
     `OEChem::OEIter::next` will now raise
     ``NoSuchElementException`` to better adhere to the ``Iterable``
     interface.

   * Quacpac: Added support for writing a custom OETautomerMolFunction
     or OETyperMolFunction in Java by deriving from the base class. 




OEToolkits 1.7.2
================================================================================

This is a new release of the OpenEye Toolkits with versions of the
following libraries:

:OEChem TK: 1.7.2 
:GraphSim TK: 1.0.0
:Grid TK: 1.3.3
:Lexichem TK: 2.0.0
:MolProp TK: 2.1.0
:Ogham TK: 1.7.1
:Omega TK: 2.4.0
:Quacpac TK: 1.4.1
:Shape TK: 1.7.2
:Spicoli TK: 1.1.0
:Szybki TK: 1.4.0
:Zap TK: 2.1.1

* There are two major additions to the OpenEye toolkit suite with this
  release:

  :GraphSim TK: 

  A toolkit for doing 2D molecule similarity. The methods currently
  implemented are:
  
  * Path based fingerprints
  * MACCS key fingerprints
  * LINGOS

  :MolProp TK: 

  A toolkit derived from OpenEye's FILTER technology. This toolkit is
  useful for calculating an extensive list 2D molecular properties and
  building custom filters around these properties.

  .. note:: 

     The version number of *MolProp TK* will track with the FILTER
     application to indicate similarities. 
  

* This release of OEChem introduces many bug fixes and new features
  provided they didn't break source-level compatibility with 1.7.0. 

* This release completes the transition from the old LaTeX based
  documentation system to the new reStructuredText based system. This
  includes better support for Python and Java in the manuals as
  separate manuals for every library.

.. oe:language:: python

   The following release notes are only for the python toolkit:  
   
   * The ``OE_ARCH`` environment variable has been introduced to force
     the python libraries to load shared libraries for a specific
     architecture. This can be useful for getting OpenEye libraries to
     work on non-officially-supported platforms.

   * Quacpac: Added support for writing a custom OETautomerMolFunction
     or OETyperMolFunction in Python by deriving from the base class. 

.. oe:language:: java

   The following release notes are only for the java toolkit:  

   * JDK1.5 would sometimes crash while loading the 1.7.0
     libraries. This bug was introduced in 1.7.0 with the change to
     make all OpenEye library memory allocation use memory from the
     Java heap. However, JDK1.5 has a known bug
     `http://bugs.sun.com/view_bug.do?bug_id=6253386
     <http://bugs.sun.com/view_bug.do?bug_id=6253386>`_ which doesn't
     allow accessing the JVM during library initialization. Therefore,
     we now detect when the OpenEye libraries are being loaded by
     JDK1.5 and turn off Java heap allocation during library
     initialization. The amount of memory allocated during library
     initialization is usually negligible, so this shouldn't allow
     programs to exceed the Java heap restrictions very much.

     .. warning:: 
     
        This fix introduces a rare corner case that could cause the
        OpenEye libraries to leak memory. It will only occur if the
        following sequence of events occurs:

        .. list-table:: **Race Condition Causing Memory Leak**
           :header-rows: 1

           * - Thread 1
             - Thread 2
           * - Load *OEChem*
             -
           * - Allocate *OEChem* objects
             -
           * - 
             - Start loading another OpenEye library (e.g. OEDepict)
           * - Deallocate *OEChem* objects
             -
           * - This thread is terminated causing the *OEChem* objects to leak
             -
           * - 
             - Finish loading library
           

        If this occurs *OEChem* will throw the following warning:
        
        :: 

           Leaking memory (0x00000000) because OEUseJavaHeap is false
           Contact OpenEye support if this message is seen

        .. note::

           None of this is possible in JDK1.6.

   * `OEChem::OEIter::Target` and
     `OEChem::OEIter::next` will now raise
     ``NoSuchElementException`` to better adhere to the ``Iterable``
     interface.

   * Quacpac: Added support for writing a custom OETautomerMolFunction
     or OETyperMolFunction in Java by deriving from the base class. 




OEToolkits 1.7.4
================================================================================

This is a new release of the OpenEye Toolkits with versions of the
following libraries:

:OEChem TK: 1.7.4 
:GraphSim TK: 1.0.0
:Grid TK: 1.3.4
:Lexichem TK: 2.0.2 
:MolProp TK: 2.1.1 
:Ogham TK: 1.7.1
:Omega TK: 2.4.1
:Quacpac TK: 1.4.1
:Shape TK: 1.8.0 
:Spicoli TK: 1.1.0
:Szybki TK: 1.5.0
:Zap TK: 2.1.1
:Docking TK: 1.0.0

* This release of the OpenEye toolkit suite introduces a major new
  library, the :Docking TK:.

* The license error handling has been significantly improved to
  provide more descriptive error messages for why exactly a given
  license has failed. So instead of seeing "General failure to
  decrypt" as the license failure reason it will actually report
  "expired" or "version number" if that is the reason. 

* The ``OE*IsLicensed`` functions provided in each library will now
  report when the license expired if it is already expired instead of
  just erroring out. 

.. note:: 

   The above two changes do not affect licenses at all. Old and new
   licenses should continue to work exactly the same. 

.. oe:language:: python

   The following release notes are only for the python toolkit:  
   
   * :oe:meth:`OESystem::OEBase::AddData`, and thus any class that
     inherits from :ref:`OEBase <OESystem_OEBase>` like molecules, now works
     properly on complex data types, such as molecules, grids, and
     surfaces. Before this release,
     :oe:meth:`OESystem::OEBase::AddData` was implemented in python for
     complex data types using :oe:meth:`OESystem::OEBase::SetData`, so
     any previous data set was blown away. This release fixes
     :oe:meth:`OESystem::OEBase::AddData` for complex types to have
     proper ``AddData`` semantics. 

   * MiniMols and DBMols can now be attached as generic data. 

   * The Spicoli python module can now be queried for its license
     status without the need for a valid Spicoli license.

   * The error message has been greatly improved when the OpenEye
     python libraries load to detect a mismatch between the platform
     being run on and what is actually installed. The intention is to
     make trouble shooting this common problem easier. 

   * Added the ability to run a 32-bit python with a 32-bit OpenEye
     python installation on a 64-bit machine. Some third party
     libraries have not been ported to 64-bit yet so this should ease
     the use of OpenEye libraries with these tools. Note, the python
     interpreter is directly queried for the machine architecture, not
     the operating system itself, i.e., the ``uname`` command. 

     .. note:: 
        
        OSX 10.6 uses the ``VERSIONER_PYTHON_PREFER_32_BIT``
        environment variable to specify what version of python to use,
        so the OpenEye libraries obey this environment variable as
        well. 

   * The OpenEye libraries used to insert integer keys into python's
     main dictionary. This caused problems with downstream tools like
     PyDoc that would expect keys to only be strings. This has been
     fixed so that those entry are now strings. 



OEToolkits 2011.1
================================================================================

This is a new release of the OpenEye Toolkits with versions of the
following libraries:

:OEChem TK: 1.7.5 
:OEDepict TK: 2.0.0
:OEDocking TK: 1.1.0
:Grapheme TK: 1.0.0
:GraphSim TK: 2.0.0
:Grid TK: 1.3.5
:Lexichem TK: 2.1.0 
:MolProp TK: 2.1.2 
:Omega TK: 2.4.4
:Quacpac TK: 1.5.0
:Shape TK: 1.8.1
:Spicoli TK: 1.1.1
:Szybki TK: 1.6.0
:Zap TK: 2.1.2

* C# support added across all the toolkits. See the *C# Quick Start*
  guide to get started using this new language binding.  

* Renaming *Ogham TK* to *OEDepict TK*. *OEDepict TK 2.0* is a major
  redesign of this core rendering library to enable new technology
  advances in 2D molecular communication.

.. warning:: 

   The *Ogham TK 1.x* API is deprecated. The API is still available in
   *OEDepict TK 2.0*, but will be removed in a future release. 

* Introducing a major new library, *Grapheme TK*, based upon *OEDepict TK 2.0*.

* Changing *OEToolkits* package version to no longer track the version
  of *OEChem* inside the package. The version number will now be
  structured as the following:

    [year].[release].[build]

  :year: is the year the package was released
  :release: is a sequentially increasing number marking the release within the year
  :build: is an arbitrary number used for internally tracking the exact state of the package

* Changed the default visibility of symbols in *OpenEye* libraries to be
  hidden. This can drastically lower the number of symbols exported from
  a given library improving compile times and shared library load
  time. 

* When building with Microsoft Visual Studio, the OpenEye header files
  will enforce that you are building with the correct version of the
  compiler. 

.. oe:language:: python
   
   * The Python toolkits now allow for the ``OE_ARCH`` environment
     variable to contain multiple colon separated options.

.. oe:language:: java

   * The Java toolkits now ship as a single JAR file to ease
     use. Note, if a smaller JAR file is desired a custom JAR file can
     be created for only a subset of toolkits that can also work
     across platforms. See the new *Java Quick Start* guide for more
     information.   

   * Note that there are two sets of distributions for Linux. For the most part, if
     you are using a newer version of Linux (RHEL 5, RHEL 6, SLE 11 and Ubuntu
     10.04 LTS),  the regular distributions marked "Linux-x64" and "Linux-x86" are
     what you want.  These are built with a newer version of GCC and provided a
     noticeable increase in performance over previous releases.

     But, for RHEL 4 and SLED 10, these new releases are not compatible. For these
     two older Linux platforms, we've provided a pair of downloads labeled
     "Linux-x64-compat" and "Linux-x86-compat". Note that these "compat" releases
     will work on all the supported Linux platforms, albeit with a noticeable decrease 
     in performance.



OEToolkits 2011.Oct
================================================================================

This is a new release of the OpenEye Toolkits with versions of the
following libraries:

:OEChem TK: 1.7.6
:OEDepict TK: 2.0.1
:OEDocking TK: 1.1.0
:Grapheme TK: 1.0.1
:GraphSim TK: 2.0.0
:Grid TK: 1.3.5
:Lexichem TK: 2.1.0 
:MolProp TK: 2.1.2 
:Omega TK: 2.4.4
:Quacpac TK: 1.5.0
:Shape TK: 1.8.1
:Spicoli TK: 1.1.1
:Szybki TK: 1.6.0
:Zap TK: 2.1.2

This release is meant to be a minimal bug fix release to address a few
key issues in the *2011.1* release.

* The *2011.1* release left internal debugging code turned on during all
  builds. The result was spurious application failures for corner case
  conditions. In general, the *2011.Oct* version should run faster due
  to this being turned off. 

* The package wide version number has been tweaked due to customer
  feedback to include an explicit month as the 2nd field to avoid
  confusion with the version number looking like a date. The version number will now be
  structured as the following:

    [year].[month].[build]

  :year: is the year the package was released
  :month: is the month the package was released
  :build: is an arbitrary number used for internally tracking the exact state of the package

.. oe:language:: java

   * Added the username to the temporary directory used by the new Java
     JAR scheme. This fixes a bug where two users on Linux could get a
     permission conflict resulting in a failure to load the shared
     libraries.



OEToolkits 2012.Feb
================================================================================

This is a new release of the OpenEye Toolkits with versions of the
following libraries:

:OEChem TK: 1.7.7
:OEDepict TK: 2.0.2
:OEDocking TK: 1.1.1
:Grapheme TK: 1.0.2
:GraphSim TK: 2.0.1
:Grid TK: 1.3.5
:Lexichem TK: 2.1.1 
:MolProp TK: 2.1.2 
:Omega TK: 2.4.5
:Quacpac TK: 1.5.0
:Shape TK: 1.8.1
:Spicoli TK: 1.1.1
:Szybki TK: 1.7.0
:Zap TK: 2.1.2

All the toolkits now use an extension of the MMFF94 force field for
tricoordinate boron compounds. Please refer to the Omega TK and Szybki
TK release notes for a more complete description of what types of
boron are supported.


OEToolkits 2012.Jun
================================================================================

This is a new release of the OpenEye Toolkits with versions of the
following libraries:

:OEChem TK: 1.8.0
:OEDepict TK: 2.0.3
:OEDocking TK: 1.1.2
:Grapheme TK: 1.0.3
:GraphSim TK: 2.0.2
:Grid TK: 1.4.0
:Lexichem TK: 2.1.2 
:MolProp TK: 2.1.3
:Omega TK: 2.4.6
:Quacpac TK: 1.5.2
:Shape TK: 1.8.2
:Spicoli TK: 1.1.2
:Szybki TK: 1.7.1
:Zap TK: 2.1.3

* This release brings about the following changes in platform support: 

  * Added support for 64-bit Ubuntu 12.04 LTS. A reminder that 32-bit
    will not be supported on future linux distributions.
  * Last release to support Visual Studio 2003. Please upgrade to Visual
    Studio 2008 or 2010.
  * Last release to support Python 2.5 on Windows. Please upgrade to
    Python 2.6 or 2.7.
  * Last release to support OSX 10.5. Please upgrade to OSX 10.6 or 10.7. 

.. warning::

   OEChem has undergone a major revision change from 1.7.7 to 1.8.0 to
   indicate that bugs were fixed in isomeric canonical smiles
   generation that could potentially change the smiles generated. A
   benchmark over 24.0 million unique compounds only yielded changes
   in 42 of the compound's isomeric canonical smiles. These 42
   compounds fall into the following classes: 

   * broken porphyrins
   * cross linked organometallics
   * cross linked high molecular weight macrocycles
   * trivalent and tetravalent oxygens
   * polycyclic hydrazine dyes

   See the OEChem release notes for a more specific description of
   these minor algorithmic changes.




OEToolkits 2012.Oct
================================================================================

This is a new release of the OpenEye Toolkits with versions of the
following libraries:

:OEChem TK: 1.9.0
:OEDepict TK: 2.0.4
:OEDocking TK: 1.1.3
:Grapheme TK: 1.0.4
:GraphSim TK: 2.0.3
:Grid TK: 1.4.1
:Lexichem TK: 2.2.0 
:MolProp TK: 2.1.4
:Omega TK: 2.5.0
:Quacpac TK: 1.6.0
:Shape TK: 1.8.3
:Spicoli TK: 1.1.3
:Szybki TK: 1.7.2
:Zap TK: 2.1.4

.. oe:language:: python

   * Windows Python examples and documentation are installed into a
     subdirectory of ``C:\Python2*\`` named after the version, e.g.,
     ``C:\Python27\OpenEye-2012.Oct.1``. The installer will place
     links in the Windows start menu pointing to the new proper location.

.. oe:language:: c++

   * C++ examples build system changed to *CMake* for all supported platforms: Linux, Windows, and OSX.
     The old system was **Makefiles** for the Unix systems and Visual
     Studio Solution files for Windows. *CMake* allows for the
     generation of these platform specific build systems from a
     centralized text file (*CMakeLists.txt*). The *CMake* command to
     generate the platform specific build system is shipped as the
     *configure* or *configure.bat* script for Unix or Windows systems
     respectively. 

     The following is the new **Quick Start** guide for Unix
     systems:

     #. Un-tar the toolkits distribution
     #. > cd openeye/toolkits/examples
     #. > ./configure
     #. > make

     Built executables are placed in the
     **openeye/toolkits/examples/bin** directory.

     The following is the new **Quick Start** guide for Windows: 

     #. Un-zip the toolkits distribution
     #. > cd OpenEye-toolkits-2012.Oct.x-VSxxxx-xxx-xx/examples
     #. > configure.bat
     #. Open up the OpenEye-toolkits solution file that was generated 
     #. Hit the **F7** key to build the entire solution

     Built executables are placed in the
     **OpenEye-toolkits-2012.Oct.x-VSxxxx-xxx-xx/examples/bin/Release** directory.

* ``*GetSite`` and ``*GetLicensee`` free functions exposed by each
  toolkit now directly return a string to be more usable in all wrapped
  languages.




OEToolkits 2013.Feb
================================================================================

This is a new release of the OpenEye Toolkits with versions of the
following libraries:

:OEChem TK: 1.9.1
:OEDepict TK: 2.1.0
:OEDocking TK: 1.1.4
:Grapheme TK: 1.0.5
:GraphSim TK: 2.0.4
:Grid TK: 1.4.2
:Lexichem TK: 2.2.2 
:MolProp TK: 2.1.5
:Omega TK: 2.5.1
:Quacpac TK: 1.6.1
:Shape TK: 1.9.0
:Spicoli TK: 1.2.0
:Szybki TK: 1.7.3
:Zap TK: 2.1.5

* OSX 10.8 support added for C++, Python, and Java. Note, C++ and
  Python are built with the Clang 4 compiler.  

* Visual Studio 2012 support added for C++ and C#. 

* OSX 10.6 32-bit python is no longer supported. 

* The next release, 2013.Jun, will be the last release to support SuSe 10. 

.. oe:language:: python

   * The documentation examples were accidentally left out of the last
     release on Windows. They can now be found in
     ``C:\Python27\OpenEye-2013.Feb.1\docexamples``. 

   * Importing the python toolkits when there are spaces in the directory structure
     should now work properly. 

   * Added the toolkit package version to the ``openeye`` module,
     e.g., ``openeye.__version__ == "2013.Feb.x"`` for this release. 



OEToolkits 2013.Jun
===================

This is a new release of the OpenEye Toolkits with versions of the
following libraries:

:OEChem TK: 1.9.2
:OEDepict TK: 2.2.0
:OEDocking TK: 1.2.0
:Grapheme TK: 1.0.6
:GraphSim TK: 2.0.5
:Grid TK: 1.4.3
:Lexichem TK: 2.2.3 
:MolProp TK: 2.1.6
:Omega TK: 2.5.2
:Quacpac TK: 1.6.2
:Shape TK: 1.9.1
:Spicoli TK: 1.2.1
:Szybki TK: 1.7.4
:Zap TK: 2.1.6

* Most toolkit distributions do not ship with documentation anymore
  due to the sheer size of the documentation. Only the Python and C#
  Windows installers will continue to contain
  documentation. Documentation is still available as a separate
  download. Most users appear to rely on the `OpenEye online
  documentation <http://www.eyesopen.com/docs/>`_, that will continue
  to be maintained.

.. oe:language:: python

   * The next release, 2013.Oct, will be the last release to support
     Python 2.4 and 2.5. 

   * A setup.py has been included to allow developers to create pip 
     compatible packages. See the `Python Quick Start <http://www.eyesopen.com/docs/toolkits/current/html/OpenEye_Toolkit_Quickstart-python/index.html>`_ for more information.

.. oe:language:: java

   * A test script was added that will automatically run several of
     the included examples to ensure the Java toolkit distribution is
     running correctly. See the readme.txt file in the
     ``openeye/java/verify`` directory.

* This release will be the last release to support SuSe 10. 

.. oe:language:: java

   .. note:: 
   
      The last release of the Java toolkits to support SuSe 10 was the
      2012.Jun compatibility version.




OEToolkits 2013.Oct
================================================================================

This is a new release of the OpenEye Toolkits with versions of the
following libraries:

:OEChem TK: 1.9.3
:OEBrood TK: 0.9.0
:OEDepict TK: 2.2.1
:OEDocking TK: 1.2.1
:Grapheme TK: 1.1.0
:GraphSim TK: 2.0.6
:Grid TK: 1.4.4
:Lexichem TK: 2.3.0
:MolProp TK: 2.1.7
:Omega TK: 2.5.3
:Quacpac TK: 1.6.4
:Shape TK: 1.9.2
:Spicoli TK: 1.2.2
:Szybki TK: 1.7.5
:Zap TK: 2.1.6

.. oe:language:: python

   .. warning::

      The structure of the OpenEye Python Toolkit tarball is
      radically different for Linux and OSX. The OpenEye Python
      Toolkit tarball now conforms to Python standards for
      packaging. Please see the revised Python Quick Start manual for
      installation instructions.

   * This is the last release to support Python 2.4 and 2.5. Please
     upgrade to 2.6 or 2.7.

   * This is the last release to support Python 2.6 on Windows. 64-bit
     Windows Python 2.7 support is being added in this release.

   * The Python toolkits will now work on OSX 10.8 when the Python
     interpreter was compiled with GCC instead of Clang. 

   * Performance improved by about 30% for the initial import of the
     Python toolkits on Linux and OSX. The python toolkits no longer
     rely on a shell script on these platforms to determine their
     architecture.

   * The underlying version of SWIG has been upgraded to 2.0.10. This
     should only affect users who write custom extensions to the
     OpenEye Python toolkits in C++ and wrap them using SWIG. No other
     users should be affected by this change.

.. oe:language:: java

   * Two more important "idiomatic differences" have been added to the
     Introduction section of the Java Quick Start guide.

     - Calling close is required for any object that provides that method. 
     - Explicitly calling delete is recommended on objects from
       certain libraries.

   * The Java OpenEye toolkits will now allocate memory from the Java
     heap once again. The Java OpenEye toolkits should not exceed the
     memory usage specified by the Java -Xmx flag. The problem first
     appeared in the 2011.Oct release when the JNI_OnLoad symbol was
     made hidden.

   * Many Java functions and methods that returned iterators are now
     usable from Java. These methods used to return opaque
     SWIGTYPE_P_<class_name> objects.

   * A new Java example was added: Picto.  This example requires JavaFX 2.2 and Java version 
     1.7.0.21 or higher.  Please refer to the JavaFX 2.2 requirements `here <http://docs.oracle.com/javafx/2/system_requirements_2-2/jfxpub-system_requirements_2-2.htm>`_.
     To run this example execute `ant picto` in the directory that 
     contains the examples jar file.

* No OpenEye toolkit will call
  :oe:meth:`OESystem::OEErrorHandler::Fatal` anymore. All instances
  have been replaced with :oe:meth:`OESystem::OEErrorHandler::Error`
  allowing end-users the ability to control whether programs should
  exit on error with :oe:meth:`OESystem::OEErrorHandler::SetStrict`. It
  is recommended to use ``OEThrow.SetStrict(false)`` inside long
  running services like web servers.




OEToolkits 2014.Feb
================================================================================

This release marks a major milestone for **OEChem**: 10 years as an
OpenEye product! In recognition of that, we are releasing **OEChem**
2.0 to clean up some rough edges and bring in some important new
features. We are committed to maintaining a stable **OEChem** API and
thus the vast majority of programs written with previous versions of
**OEChem** should continue to be supported in the **OEChem** 2.x
series. The only "backwards breaking" functional change that everyone
will see is something that we feel all users will appreciate:

.. warning::

   **'.smi' will now output molecules with stereochemistry.**

A few of the new major features in **OEChem** are:

- :oe:func:`OEChem::OEGenerate2DCoordinates` added for 2D coordinate
  generation and is automatically called when writing :file:`.sdf`,
  :file:`.mdl`, and :file:`.cdx` files when the associated molecule
  had no coordinates.
- Support for :file:`.csv`, comma-separated values, added as a
  supported molecule file format.
- Fast random access to all **OEChem** file formats through the new
  :ref:`OEMolDatabase <OEChem_OEMolDatabase>` class.
- :oe:func:`OEPlatform::OEAddLicenseFromHttp` added to Python, Java, and
  .NET toolkits to enable fetching license information from a server
  instead of the standard text file. This is not currently supported
  in C++.

This release also features the addition of **two new toolkits** to the
distribution:

- **Szmap TK** – this provides access to the core functionality used
  by the **SZMAP** application and enables the calculation of solvent
  energies and probabilities at arbitrary points in space. It also
  provides access to probe geometry for output and display.

- **OEMedChem TK** – this is still in the experimental stages and is not
  yet officially supported; however, it provides many useful and
  interesting tools that we wanted to make available while we
  finalize the API and functionality set. As such, the existing API
  may (and most likely will) change in a future toolkit release.

.. oe:language:: java

   Several notable **improvements** have been made to the **Java** distributions:

   * The layout of the Java package has been simplified. In general
     the directory structure was flattened out.  Unzipping the
     distribution now creates a directory:
     OpenEye-Java-Version-Platform-Arch.  This directory includes the
     following subdirectories and files: lib, doc, examples, verify,
     and README.txt.  The OpenEye jar is under the lib directory.  The
     OEChem Quick Start Guide and Java Best Practices document are in
     the docs directory.  Run verify.py in the verify directory to
     ensure a working distribution.

   * All Java APIs that take primitive arrays as arguments have been
     optimized.

   * The Java toolkits no longer run a separate finalizer thread
     to automatically ``close()`` file-like objects as it was not
     guaranteed to run ``close()`` for all objects. Users are required
     to call ``close()`` for any object that provides that method.

   * The Java toolkits will no longer use ``OESwigBase`` and
     ``OENativePointer`` to circumvent the Java garbage collector.
     These constructs are no longer necessary with the newer versions
     of Java and were creating a small overhead in newer versions of Java. 

.. oe:language:: python

   An important **fix to Python on Windows** was added to this release:

   * The OpenEye Python toolkits will no longer break interactive
     Python interpreters on Windows. Previously, importing the
     OpenEye Python toolkits would cause any subsequent commands typed
     into the interpreter to return a very confusing ``SyntaxError``. 
    

**General notices:**

* Added support for **OSX 10.9** Mavericks. 

* The next toolkit release, 2014.Jun, will be the last release to
  support **OSX 10.7**.

* This release will be the last release to support **OSX 10.6**. 
  
* The next toolkit release, 2014.Jun, will be the last release to
  support 64-bit **Ubuntu 10.04**.

* **GCC 4.8.2** support added for **RHEL6**. GCC 4.8.1 had a bug that made
  it impossible to compile OpenEye header files. Please use 4.8.2+.
   
* Experimental support for **Python 3.3** added. 



OEToolkits 2014.Jun
================================================================================

This release of the OpenEye toolkits is focused on stability and new
platform support. The last release, 2014.Feb, was a major feature
release introducing numerous new features. This release focused on
fixing many bugs and improving the overall stability of the OpenEye
toolkits.

There is still a major new feature being added in this release:

- FreeForm API added to **Szybki TK**

.. oe:language:: java csharp

   The following changes were made across all the toolkits:

   - Java and C# should see greatly improved stability. All OpenEye
     toolkits will now be much more conservative with the use of stack
     based memory allocation. Stack memory allocation was causing
     non-deterministic crashes in environments with limited stack space,
     e.g., Java and C#.

.. oe:language:: java

   Several notable **improvements** have been made to the **Java** distributions:

   * Java 8 is fully supported by the OpenEye Java toolkits. 
    
   * Multiple OpenEye jars can be combined together to make platform
     independent runnable jars. The architecture of the JVM is now
     detected, and the appropriate shared library will be loaded. 

   * OpenEye jars are now cryptographically signed.  Use `jarsigner
     -verify <jarname>` to verify the jar.

.. oe:language:: python

   Several notable **improvements** have been made to the **Python** distributions:

   * Support for **Python 3.3** officially added. Python 3.3+ has been
     thoroughly tested since the previous release.  **Python 3.4**
     also works and is binary compatible with **Python 3.3**, as such,
     OpenEye Python 3.x distributions will just be labeled "python3",
     except for Windows.

   * All python examples should be compatible with both Python 2 and
     Python 3.

   * An ImportError exception with a more straight forward error
     message will be printed if there is a mismatch between the Python
     interpreter version and what Python interpreter version the OpenEye
     Toolkits are built against.

   * Fixed a bug in OpenEye's platform detection that would sometimes
     not recognize CentOS 6 as a RedHat 6 Linux distribution.

**General notices:**

* **Windows XP** is no longer a supported version of Microsoft Windows.

* Added support for **Ubuntu 14.04**, a long term support distribution
  that OpenEye will support for 4 years.

* This release will be the last release to support **Ubuntu 10.04**. 

* Added support for **RHEL 7**. This is the next major release from
  RedHat that will be supported by OpenEye for at least 5 years.
  OpenEye will be very rapidly phasing out support for **RHEL
  5**. **RHEL 5** users should be planning their upgrade now.

  To start the phase out, this will be the last release to support the
  following on **RHEL 5**:

  * Python 2.6
  * gcc 4.3
  * gcc 4.4

* This release will be the last release to support **OSX 10.7**. 

* The next release, 2014.Oct, will be the last release to support
  **Visual Studio 2008** for C++ and C# toolkits.
  
* Deprecated APIs will now throw a warning message once, and only
  once, for the lifetime of the process.

* Documentation examples for Java and Python distributions should now
  have documentation markup removed.


OEToolkits 2014.Oct
================================================================================

This release of the OpenEye toolkits contains many new features and
bug fixes. The most important have been highlighted here, the full
list can be accessed below. 

Pictorial application for automatically writing OEDepict code
--------------------------------------------------------------------------------

**OEDepict TK** is a powerful API for the “2D” depiction of small
molecules. While such depictions are universal in chemistry there are
many variants in drawing style, the majority of which are captured in
OEDepict’s extensive set of options. To aid navigation through the
many options available we now provide a small application,
**Pictorial**, written in Java, that will autogenerate code that can
then be used in your own programming. The figure below
is an illustration of the interface.

.. image:: /_images/Pictorial.png

Major improvements to Quacpac's protomer assignment algorithms
--------------------------------------------------------------------------------

**Quacpac TK** is a set of tools for the assignment of charges,
ionization states and proton positions. The latter has been
significantly improved to produce more reasonable tautomeric forms,
for instance by disfavoring exocyclic bonds adjacent to aromatic bonds
(e.g. favoring aromatic forms). An example is depicted below.

.. image:: /_images/canonical-tautomer-04.png

Major improvements to depiction of complex ring systems
--------------------------------------------------------------------------------

**Depiction** of complex molecules in 2D is both a science and an
art. Algorithms help with the majority of cases but sometimes they
have to be supplemented with the ‘art’ of hand-drawn templates. In our
continuing quest to provide the best 2D depiction of molecules, this
release includes an additional 550 such templates to **OEDepict** and 2D
coordinate generation in **OEChem**. Some examples are shown below.

.. image:: /_images/RingTemplateImprovements.png

Multi-precision conformer handling
--------------------------------------------------------------------------------

There are times where **precision** is important and times when, due to
memory consumption, it gets in the way of computation. As such, this
release of the toolkits includes **two new levels of precision**. In
OEChem the basic molecular object OEMol can now store conformer
coordinates as 16-bit ‘half-floats’, 64-bit double precision number or
long doubles (typically 80 bits although storage requirements may
vary). Half-floats have five bits reserved for the exponent, eleven for
the fraction. Examples of where it might be useful include shape
representation (robust to small coordinate changes) or compact
storage. Extra-precision is useful when interfacing with quantum
programs or for storage in rotor-offset form in OEB files.

.. warning::

   C++ users may notice that `OEChem::OEMCMolBaseT` and
   `OEChem::OEConfBaseT` have been renamed to
   :ref:`OEMCMolBase <OEChem_OEMCMolBase>` and :ref:`OEConfBase <OEChem_OEConfBase>`
   respectively. This change was to enable the above feature and to
   ease the use of the documentation by Python, Java, and C# users who
   should see no effect from this change.

New force field in Szybki
--------------------------------------------------------------------------------

**Szybki TK** encompasses our capabilities for molecular
optimization. This version of the toolkit includes our latest advances
in the calculation of intermolecular interactions, i.e. the
combination of dispersion (attractive), Fermi overlap (repulsion) and
Coulombic interactions (either). These are captured in the IEFF
formulation, which represents the first two interaction terms in more
detail than typical VdW forms. In addition, Coulombic interactions are
calculated using atom-centered point multipoles, as output by quantum
chemistry codes. OpenEye provides facilities to input these into OEB
files for proteins and ligands, allowing a new level of sophistication
in the evaluation of complex interactions. In addition, the Szybki
toolkit also includes a new function call to allow for specifically
constraining a single torsion and new methods to assign flexibility to
residues during protein-ligand optimization.

Matched Pairs analysis beta API added to OEMedChem TK
--------------------------------------------------------------------------------

This release includes an exciting beta of **OEMedChem** which includes
containing facilities for “Matched Pair” analysis. The matched pair
concept has resonated in the medicinal chemistry community because it
provides a simple method of comparing two molecules, i.e. ascertaining
whether they differ in chemically obvious ways, e.g. a swap of a
fluorine for a chlorine or a benzamide for a benzamidine, and then
using historical data on such transformations to make predictions on
property differences. The functions within the OEMedChem toolkit in
this release are capable of searching datasets for such pairings,
allowing for such prior expectations to be tabulated. We stress this
is a beta release feature and look forward to incorporating community
suggestions and requests.

.. CCOc1nc2cccc(C(=O)O[R1])c2n1Cc3ccc(cc3)c4ccccc4c5[nH]nnn5.CCOc1nc2cccc(C(=O)O[R2])c2n1Cc3ccc(cc3)c4ccccc4c5Noc(=O)n5
.. SSS = OESubSearch("[*]OC(=O)c3cccc2nc(OCC)n(c23)Cc6ccc(c5ccccc5)cc6")

.. image:: /_images/MatchedMolecularPairs.png

Major bug fixes
--------------------------------------------------------------------------------

.. warning:: 

   It is strongly recommended for users of the 2014.Feb and 2014.Jun
   releases to upgrade to the 2014.Oct release because of the
   following major bug fixes for the SDF, MDL, and CDX file formats.

   The addition of 2D coordinate generation for the SDF, MDL, and CDX
   file formats in the 2014.Feb release, **OEChem 2.0.0**, created the
   possibility of erroneously changing stereo chemistry in the
   following cases:

   #. Bond stereo chemistry in macrocycles
   #. Atom stereo from wedges or hashes between atoms with an angle less than 180 degrees

   The 2D coordinate generation can not always generate coordinates
   that represent the required stereo chemistry. For these cases,
   **OEChem** will now leave the coordinates in the resulting file all
   zero. This will make file readers choose to honor the stereo marks
   instead of the 2D coordinates. 

   .. _table_stereoProblems:

   .. list-table:: **Examples of stereo chemistry problems addressed in 2014.Oct**

      * - .. image:: ../oechemtk/images/releasenotes-2.0.2/BondStereoProblem-toolkits2014_Oct.png
        - .. image:: ../oechemtk/images/releasenotes-2.0.2/AtomStereoProblem-toolkits2014_Oct.png
      * - **[1]**
        - **[2]**

General notices
--------------------------------------------------------------------------------

* The following is no longer supported on RedHat Enterprise Linux 5:

  * Python 2.6
  * gcc 4.3
  * gcc 4.4

* **Ubuntu 10.04** is no longer supported. 

* This will be the last release to support **SuSe 11**. 

* **OSX 10.7** is no longer supported.

* This will be the last release to support **Visual Studio 2008** for
  C++ and C# toolkits.

.. oe:language:: java

   Several notable **improvements** have been made to the **Java** distributions:

   * The :ref:`OEJavaImageBase <OEDepict_OEJavaImageBase>` class was missing some of
     the newer drawing primitives added recently to the
     :ref:`OEImageBase <OEDepict_OEImageBase>` class. The
     :ref:`OEJavaImageBase <OEDepict_OEJavaImageBase>` class now fully implements the
     complete :ref:`OEImageBase <OEDepict_OEImageBase>` abstract base class to
     allow drawing into the native Java ``Graphics2D`` object:
     http://docs.oracle.com/javase/7/docs/api/java/awt/Graphics2D.html

   * New API's which support Java collections were added to the molecule objects: 

     ============================================ ========================================
     OEMolBase                                    OEMCMolBase                             
     ============================================ ========================================
     java.util.List<OEAtomBase>  GetAtomList()    java.util.List<OEConfBase> GetConfList()
     java.util.List<OEBondBase>  GetBondList()                                            
     java.util.List<OEGroupBase> GetGroupList()                                           
     ============================================ ========================================

   * The Picto example was removed from the distribution, and was replaced with a Java application,
     Pictorial.
    
.. oe:language:: python

   Several notable **improvements** have been made to the **Python** distributions:

   * OpenEye Toolkit APIs will be more strict about coercing
     parameters into boolean arguments. When objects are passed as a
     parameter to a Python function call where a Boolean is expected,
     the language ‘coerces’ the parameter to “True”. For instance,
     consider the following code:

     .. code-block:: python

        mol = OEGraphMol()
        opts = OEPrepareDepictionOptions()
        opts.SetSuppressHydrogens(False)
        clearCoords = True
        OEPrepareDepiction(mol, clearCoords, opts)

     .. warning: The preceding code does not work anymore and for good reason.

     Here the result is a depiction that does not have hydrogens, even
     though we set the "SuppressHydrogens" flag to false. This happens
     because the last flag in the function call is an object, not the
     expected Boolean and so Python sets it to "True”. This release has
     improvements in how this is handled and will throw an exception about
     the type mismatch.

   * OpenEye Python toolkits are now built with SWIG 3.0.2. Users who
     write and compile their own extensions will need to upgrade
     accordingly.

   * Incorrect ``OE_ARCH`` environment variables will no longer cause
     importing the OpenEye libraries to fail. Instead, the malformed
     architectures in the list will be ignored and normal architecture
     lookup will continue.



.. _toolkit_release_highlights_2015_Feb:

OEToolkits 2015.Feb
================================================================================

This release of the **OpenEye Toolkits** contains many new features and
bug fixes. The most important are highlighted here.

Protein-ligand Rendering
--------------------------------------------------------------------------------

**Grapheme TK** now includes a powerful new API for the display of 3D
information. The interactions between a protein 
and a ligand provide crucial information to the pursuit of new drugs.  To facilitate the 
deciphering of these complex interactions, **OpenEye** is releasing the ability 
to render this 3D information in a 2D diagram. Currently, only **OEDocking TK** 
interactions can be rendered by **Grapheme TK**. However, this feature will be fully
extensible through the **OEBio TK**. If you wish to display a particular type of 
interaction and would like to contribute to the development, please 
contact support@eyesopen.com.

.. image:: /_images/pdb1br6-PT1.ent.png

Documentation Refresh
--------------------------------------------------------------------------------

To improve usability and maintain a high level of quality, the **OpenEye Toolkit** 
documentation has been refreshed over the last year. In addition to a new
logo and style, significant functionality has been added. All **OpenEye Toolkits**
will now cross-reference, leading users to the correct
toolkit while searching for functionality. In addition, searching the
HTML documentation can now be performed with Google, offering
significantly better search results than the previous HTML
documentation. If you are an avid user of the PDF documentation, we
strongly encourage you to take another look at the HTML documentation.

.. image:: /_images/NewDocsTopLeftCorner.png

Matched Pairs Transformations
--------------------------------------------------------------------------------

This release continues the incorporation of community suggestions in
the **OEMedChem TK**. In this release, the matched molecular pairs
functionality has been augmented to include easy access to the
transformations themselves in native form, allowing for retrieval and
manipulation of transformations for many more matched pair use cases.

.. image:: /_images/HR_graphic.png

Optimized Depiction Orientation
--------------------------------------------------------------------------------

Molecular depictions are a common element in any chemistry
environment. However, they can waste a lot of screen
real estate, especially when displaying extended or oddly shaped
molecules. To maximize screen space, the **OEDepict TK** now provides
the ability to optimize for either horizontal or vertical rendering of
the molecule coordinates. For example: to display molecules in a
spreadsheet, horizontal depictions will conserve the most vertical
whitespace; to display molecules in the sidebar of a webpage,
vertical rendering will conserve the most horizontal whitespace.

.. _table_releasenotes_OEDepictOrientation_Horizonal:

.. list-table::
   :widths: 100 100
   :header-rows: 1

   * - :oe:const:`OEDepict::OEDepictOrientation::Default`
     - :oe:const:`OEDepict::OEDepictOrientation::Horizontal`
   * - .. image:: ./images/2015-Feb/OEDepictOrientation_Horizontal_Default.*
     - .. image:: ./images/2015-Feb/OEDepictOrientation_Horizontal.*

General Notices
--------------------------------------------------------------------------------

* **SuSe 11** is no longer supported. 

* **Visual Studio 2008** for C++ and C# toolkits is no longer
  supported.

* The 2015.Jun release will be the last to support
  **Visual Studio 2010** for C++.

* **OSX 10.10** Yosemite support has been added.

* Babel is a command line tool for molecular file format translation, 
  incorporating a wide range of OEChem options. The application code 
  is now open source and can be found here: https://github.com/oess/OEBabel

* **OpenEye** Python toolkits are now built with SWIG 3.0.2. Users who
  write and compile their own **OpenEye** C++ toolkit extensions will need
  to upgrade accordingly. An example of compiling a custom extension
  to the Python toolkits is given here:
  https://github.com/oess/oepython_extension.



.. _toolkit_release_highlights_2015_Jun:

OEToolkits 2015.Jun
================================================================================

PDB Splitting
--------------------------------------------------------------------------------

**OEBio TK** includes a powerful new API for automatically classifying
and separating the various components of a macromolecular complex by
their functional roles. This new API makes it easy to excise a
ligand or protein/cofactor complex automatically or identify
binding-site residues. The process is also fully customizable
to allow internal definitions of the ligand to augment the
splitting algorithm. For more information, please see the
:doc:`Splitting Macromolecular Complexes<../../oechemtk/proteinprep>`
documentation.

.. figure:: /_images/13GS.png

   The above Sulfasalazine ligand was automatically identified in the
   glutathione S-transferase binding site by using the
   :oe:func:`OEBio::OESplitMolComplex` function. The image was created
   by running the
   :ref:`complex2img<section_examples_summary_complex2img>` Grapheme
   TK example on the `13GS PDB entry
   <http://www.rcsb.org/pdb/files/13GS.pdb.gz>`_. Previous versions
   required an external definition of the ligand; this new version
   bypasses that requirement for ease of use.

PAINS Filter
--------------------------------------------------------------------------------
:ref:`Pan Assay Interference Compounds<PAINS_theory>` (PAINS) filter
was added to **OEMolProp TK** by adapting the supplementary
material from the original [Baell-2010]_ paper.  The PAINS filter can
be used as a prefilter set for screening or, more interestingly, as a
post-processing filter to identify possible protein-reactive or other
assay-confounding functionalities within hits.  Any hits so identified
will require more care to determine if the measured activity is
valid.  The PAINS filters can give valuable insights into lead
optimization priorities.

.. image:: /_images/june2015-pains.png

Matched Molecular Pair Improvements
--------------------------------------------------------------------------------

There is a wealth of information stored in a chemical series. 
Extracting this property change information from chemical analogs is
at the heart of a matched molecular pair analysis.  One 
challenge is capturing molecular differences
corresponding to substitution of a hydrogen with a larger group in an
unsupervised analysis approach.  This new indexing capability
generates significantly more matched molecular pairs during the
analysis and yields additional information about substituent effects
on molecular properties. More matched pairs means more information is
being extracted from the chemical series. 

This next beta release of **OEMedChem TK** improves the matched
molecular pair analysis engine to robustly and efficiently support the
identification of molecular pairs due to differences in hydrogen-atom
substitutions:

.. image:: /_images/june2015-mmp-hmember.png

Additionally, indexing improvements also identify new linker insertions and modifications:

.. image:: /_images/june2015-mmp-linker.png

Custom Ring Template Dictionaries
--------------------------------------------------------------------------------

Depiction of complex molecules in 2D is both a science and an
art. For this reason, **OEChem TK** can now utilize custom ring 
template dictionaries specified by the user. This allows **OpenEye Toolkits**
to adapt immediately to changing project demands. **OpenEye** will gladly
continue to incorporate ring templates submitted to us, but this new
feature will be more flexible. The :ref:`Custom Ring Template
Dictionary Guide<user-defined-ring-dictionary>` explains the tools and
process to start using custom internal dictionaries. 

.. image:: /_images/june2015-rtl.png

Anaconda Support
--------------------------------------------------------------------------------

We want to work where you do. At **OpenEye**, we support all major
platforms and `Continuum's
Anaconda <https://store.continuum.io/cshop/anaconda/>`_ is becoming a
major platform for scientific Python.  Anaconda is a Python
distribution that installs commonly used scientific packages by
default. **OpenEye Python Toolkits** have added binary support for
Anaconda. 

.. note::

  Using the PIP installation mechanism described below
  greatly simplifies this compatibility; the user should not
  even notice that Anaconda Python requires a different binary. 

One-Command Python Installation 
--------------------------------------------------------------------------------

**OpenEye Python Toolkits** can now be installed with one command::

   $ pip install -i https://pypi.binstar.org/OpenEye/simple OpenEye-toolkits
   ... 
   $ oecheminfo.py
   Installed OEChem version: |oechemversion| platform: ubuntu-14.04-g++4.8-x64 built: |builddate|
   ...

See the :ref:`Quick Start<section_python_getting_started>` guide to
learn how to make this command even shorter::

     pip install OpenEye-toolkits

The command above will automatically select the correct version and operating system in a way that is natural 
for any pure Python project.

* The Python toolkit package name has been changed from
  ``OpenEye`` to ``OpenEye-toolkits``. This will change how the previous toolkit 
  is uninstalled from a ``virtualenv``.

* :file:`examples`, :file:`docexamples`, and :file:`tests` are now found under the
  :file:`openeye` module in the ``OpenEye-toolkits`` package. This allows
  examples and integration testing to be performed easily after
  installing the ``OpenEye-toolkits`` package like a proper Python
  package.  Run the following command to execute the integration tests::

     (OpenEye)$ python -m openeye.examples.openeye_tests

  In addition to **OpenEye** examples being placed in the Python :file:`bin` or
  :file:`Scripts` directory, examples can also be run through the
  Python interpreter's ``-m`` option::

     (OpenEye)$ python -m openeye.examples.oechem.oecheminfo

* `py2exe <http://www.py2exe.org/>`_ should now work.
  **OpenEye Python Toolkits** will no longer use modules that are
  blacklisted by `py2exe <http://www.py2exe.org/>`_. 

General Notices
--------------------------------------------------------------------------------

* This is the last release to support **Visual Studio 2010** for C++.

* This is the last release to support **CMake 2.x** in the C++
  distributions; all future releases will use **CMake 3.1+**. The
  CMake files shipped with the C++ toolkits have been made compatible
  in both **CMake 2.x** and **CMake 3.1+**, but compatibility with
  **CMake 2.x** will not be tested after this release. 


.. _toolkit_release_highlights_2015_Oct:

OEToolkits 2015.Oct
================================================================================

FastROCS TK
--------------------------------------------------------------------------------

**OpenEye** is pleased to announce that **FastROCS** is joining the
pantheon of **OpenEye** toolkits as **FastROCS TK**. Shape technology
continues to be at the center of **OpenEye's** scientific mission, and
the unprecedented performance gains of **FastROCS TK** continues to enable
new science to be explored throughout the molecular modeling community.

.. note::

   **FastROCS TK** is only available in Python on 64-bit
   Linux platforms.

.. list-table::  **Example of depicting the results of FastROCS TK** (See code example in Grapheme TK)
   :widths: 200 200 200

   * -  .. image:: ./../graphemetk/images/shapeoverlap2pdf-page-1.* 
           :width: 250
     -  .. image:: ./../graphemetk/images/shapeoverlap2pdf-page-2.*
           :width: 250
     -  .. image:: ./../graphemetk/images/shapeoverlap2pdf-page-3.*
           :width: 250

.. warning::

   If your **FastROCS** license was created before May 19th, 2015,
   please visit https://www.eyesopen.com/contact for a new license.
   **FastROCS TK** requires that the relevant "python" feature be
   turned on for access to **FastROCS TK**.

OEChem: Molecule Reading Performance Improvement
--------------------------------------------------------------------------------

In addition to extending the capability of **OpenEye's** toolkits, improving the
performance of their existing functionalities is also important to us.
We continually work to increase the performance of the molecule readers 
in **OEChem TK** to accommodate our field's ever-growing molecule databases.
Significant effort has been made to accelerate reading molecules
into :ref:`OEMol <OEChem_OEMol>`.
The graph below illustrates the overall results of the code optimizations
performed since the previous release (:ref:`2015.Jun<toolkit_release_highlights_2015_Jun>`).

.. list-table:: **Performance improvement in C++**. See **OEChem TK**'s detailed release notes for the other languages. 

   * - .. image:: ./images/2015-Oct/ImportPerformance-Cpp.*
          :width: 400 pt

.. note::

   * OEB-OEMol - **OpenEye** OEBinary file format stores molecules as :ref:`OEMol <OEChem_OEMol>`
     (multi-conformer molecule representation)
   * OEB-OEGraphMol - **OpenEye** OEBinary file format stores molecules as :ref:`OEGraphMol <OEChem_OEGraphMol>`
     (single-conformer molecule representation)

OEBio: Fragment Network
--------------------------------------------------------------------------------

The :ref:`2015.Feb<toolkit_release_highlights_2015_Feb>` release introduced the
visualization of receptor-ligand interactions by **Grapheme TK**.
The following :ref:`2015.Jun<toolkit_release_highlights_2015_Jun>` release
provided automatic identification of ligands by **OEBio TK**.
This release extends these capabilities by providing read-only access to the
fragment network data structure that can store interactions perceived
by **OEDocking TK**.
Several classes and predicates that provide convenient ways to examine
various interactions types between a ligand and a protein have been
also introduced.

.. list-table::

   * - .. image:: ./images/2015-Oct/1avd.*
          :width: 400 pt

For more details about using these new APIs, see
the example in the :ref:`section_example_oebio_printinteractions` section.

General Notices
--------------------------------------------------------------------------------

* **OpenEye Python Toolkits'** installation command has been changed to::

     $ pip install -i https://pypi.anaconda.org/OpenEye/simple OpenEye-toolkits
     ...
     $ oecheminfo.py
     Installed OEChem version: |oechemversion| platform: ubuntu-14.04-g++4.8-x64 built: |builddate|
     ...

* This is the last release to support **FastROCS TK** on Ubuntu 12.

* The 2016.Feb release will be the last release to support Ubuntu 12 for all
  toolkits.

* The 2015.Oct release is the last to support OSX 10.8.


.. _toolkit_release_highlights_2016_Feb:

OEToolkits 2016.Feb
================================================================================

OpenEye Toolkit Security
--------------------------------------------------------------------------------

**OpenEye** toolkits are increasingly being used in web services that 
require protection from malicious users.  The most obvious attack vector against 
the **OpenEye** toolkits is file format parsing since scientific file formats 
are complex and often underdefined.

**OpenEye** has closed a significant number of vulnerabilities related to 
the parsing of supported file formats: molecules, grids, surfaces, receptors, 
etc. In addition, state-of-the-art testing and detection techniques are now 
continuously run on the **OpenEye** code base to ensure a high level of security going 
forward.

Security is a task requiring continuous vigilance and **OpenEye** will 
continue to make this effort a high priority.

FastROCS TK: Database Loading Performance Improvement
--------------------------------------------------------------------------------

The utility of **FastROCS** has always been hampered by the amount of physical memory
available in GPU machines.
The computational chemistry community is continuously pushing the boundaries of **FastROCS** 
by searching larger and larger virtual libraries of compounds.
In addition, **FastROCS** servers are becoming an increasingly important component of many
infrastructures and must be able to be rapidly brought up and down on demand.
Both these problems come down to the fact that loading a database into memory
is often between 10 and 20 times slower than performing an actual **FastROCS** 
search on that database.

This problem has been addressed in this release by dramatically increasing the
performance when loading a dataset into memory for eventual **FastROCS** processing.
:oe:func:`OEFastROCS::OEPrepareFastROCSMol` generates additional information to be written
to OEB that is used to rapidly read molecules into memory.

Using :oe:func:`OEFastROCS::OEPrepareFastROCSMol` on a molecule can result in
load times that are nearly 10 times faster than previous uncached OEB file loads.
Depending on the ratio of CPU and GPU compute power and conformers per molecule,
this can mean that loading a dataset can now be just as fast as the **FastROCS** 
search itself.

.. list-table::

   * - .. image:: ./images/2016-Feb/FastROCS-load.*
          :width: 400 pt

OEMedChem TK
--------------------------------------------------------------------------------

**OpenEye** is pleased to announce the first official release of **OEMedChem TK**.
This medicinal chemistry functionality was previously only available in beta form.

**OEMedChem TK** provides the ability to index a set of input
structures and identify matched molecular pairs. Matched molecular
pair analysis is becoming recognized as a powerful tool for
the extraction of the effects of chemical changes on a property or
properties of interest in large data sets.

.. list-table:: *Fragmentation and Indexing Approach to Matched Molecular Pair Analyses*

   * - .. image:: ./images/2016-Feb/HR_graphic.png
          :width: 400 pt

Additional **OEMedChem TK** capabilities include
fragmentation and perception, similarity measures, belief theory,
and molecular complexity measures.
For the full list of capabilities, see the 
:ref:`section_releasenotes_OEMedChem_100` section.

.. note::

   If you would like to utilize the functionalities of **OEMedChem TK**,
   please visit https://www.eyesopen.com/contact for a license.

General Notices
--------------------------------------------------------------------------------

* This 2016.Feb release is the last to support Ubuntu 12 for
  all toolkits.

* OSX 10.8 is no longer supported, but support has been added for OSX 10.11.

* This 2016.Feb release is the last to support Visual Studio 2012
  for C++ and C# toolkits and Visual Studio 2010 for Python 3.3 toolkit.

* This 2016.Feb release supports Python 3.5 for the following platforms:
  OSX 10.10, OSX 10.11, Ubuntu 12, Ubuntu 14, RedHat 6, and
  RedHat 7.

* The 2016.Jun release is expected to support Python 3.5 on Windows
  with Visual Studio 2015.

* The 2016.Jun release will add C++ support for Visual Studio 2015.

The Python 2 distributions of **OpenEye Python Toolkits** can now handle
both ascii and unicode Python strings for all APIs that accept string arguments.
For example, the :oe:func:`OEChem::OESmilesToMol` function can now parse
the following SMILES strings without throwing a 'TypeError' exception::

   smiles_str = "[N+](=O)([O-])([O-]) nitrát"
   smiles_unicode = u"[N+](=O)([O-])([O-]) nitrát"

Previously, the unicode strings would work in Python 3, but not in Python 2,
making it difficult to write code that was compatible with both major
versions of Python at the same time.
This major change should make porting to Python 3 much easier for
**OpenEye** toolkit users.



******************************
OEToolkits 2016.Jun
******************************

Single Build Distributions
================================================================================

**OpenEye** is pleased to announce the release of a Linux distribution built
for maximum compatibility across multiple Linux versions. This will simplify the
deployment of toolkits and toolkit programs across heterogeneous Linux environments.
A toolkit executable built using the ``single-build`` distribution will run
unmodified on most modern Linux systems, eliminating the need to
build executables for each Linux release or compiler version.
Currently, this ``single-build`` release is available for C++ and Python in
parallel with our normal version-specific releases.
In the future, we plan to make this build strategy available for all
**OpenEye**-supported platforms.

For more information, see the :ref:`section_cpp_single_build` section
for C++ and the :ref:`section_python_single_build` section for Python.

Protein-Ligand Visualization
================================================================================

**Grapheme TK** provides representation schemes that allow clear and
coherent visualization of complex chemical information.  Its most
important function is to project the intricate interactions of a
protein-ligand complex into a 2D diagram visualizing key interactions
and properties that chemists can use to make fast and effective
judgments.

The receptor-ligand visualization introduced in
:ref:`2015.Feb<toolkit_release_highlights_2015_Feb>` has been extended
to visualize two new interaction types: salt-bridges and stacking
interactions (Pi and T).  Accordingly, the color scheme used to depict
these interactions has been revamped.

**Grapheme TK** has also introduced the capability to select and highlight
various parts of the protein-ligand 2D depiction.

.. list-table:: **Examples of new protein-ligand visualization in Grapheme TK**

   * - .. image:: ./images/2016-Jun/pdb1aj7.*
          :width: 600
     - .. image:: ./images/2016-Jun/pdb1dd7.*
          :width: 600

.. note::

   As per customers' request, the OEFragmentNetwork class and its
   related API have been renamed and deprecated.
   The words "fragment," "network,"  and "connection" appearing in the names
   of classes and functions designed to store receptor-ligand interactions
   has been found to be confusing.
   The primary class is now called :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>`.
   For more details, see the :ref:`oebio_fragment_network_deprecation` section.
   The new API retains all previous functionalities and adds the capability to handle
   the new interaction types.

..  _tversky-fastrocs:

Tversky Similarity Scoring in FastROCS TK
================================================================================

**FastROCS TK** has supported only Tanimoto (symmetric) similarity
scoring since its inception. This release adds Tversky similarity
scoring to **FastROCS TK**. Using Tversky instead of Tanimoto scoring
can lead to a higher retrieval of actives in searches, as indicated by
our large-scale comparison experiment using the DUDE database (see the
chart below).

Other significant improvements in **FastROCS TK** include the reduced
memory consumption of :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` to support
color scoring and support for the new ``361.*`` driver. This new
driver has a noticeable performance improvement (approximately 10%), so 
upgrading is recommended.

.. list-table:: **Retrieval rates using Tanimoto and Tversky similarity measures**

   * - .. image:: ./images/2016-Jun/Tanimoto-Tversky.png
          :width: 400

General Notices
================================================================================

* This 2016.Jun release supports Python 3.5 on Windows with Visual Studio 2015.
  Python 3.3 on Windows is no longer supported.

* This 2016.Jun release supports Visual Studio 2015 for C++ and C# toolkits.
  Visual Studio 2010 and Visual Studio 2012 are no longer supported.

* This 2016.Jun release is the last to support Ubuntu 12 for
  all toolkits. The 2016.Oct release will add Ubuntu 16 support.

* This 2016.Jun release is the last to support 32-bit RedHat 5
  for all toolkits.

* This 2016.Jun release is the last to support Python 2.6 on RedHat 6.

.. note::

   **OpenEye** is planning to phase out Python 2 support by the October,
   2017 release. As this is a substantial change for us and our
   customers, we are willing to help with code migration, either with
   advice or hands-on work with your code-base. Please contact
   support@eyesopen.com for more details.


******************************
OEToolkits 2016.Oct
******************************

With this release, **OpenEye** continues to focus on protein handling and
visualization.  In addition, numerous improvements to the toolkits have
been made.

Protein Preparation
================================================================================

A new function, :oe:func:`OEBio::OEPlaceHydrogens`, has been introduced to the
**OpenEye** protein preparation workflow in **OEBio TK**.  This function positions
hydrogens in a molecule to build hydrogen bonding networks and avoid clashes.
It can also flip functional groups that are sometimes modeled incorrectly,
such as histidine, asparagine, and
glutamine sidechains.  Previously, **OpenEye** recommended that users run
the open source application Reduce to
perform these functions. :oe:func:`OEBio::OEPlaceHydrogens` is easier
to use and has broader applicability because it uses SMARTS patterns rather
than relying on naming conventions.

This release represents an initial implementation of this functionality; it
is under continuing development.  A new example program,
:ref:`section_example_oebio_proteinprep`, demonstrates this functionality.

For more information, see the :ref:`chapter_protein_prep` section.

.. list-table:: **Example of a hydrogen bonding network in 1R1H along with the corresponding protein-ligand visualization**

   * - .. image:: ./images/2016-Oct/1r1h.png
          :align:  center
          :width: 400

     - .. image:: ./images/2016-Oct/1r1h-grapheme.*
          :align:  center
          :width: 500

Protein-Ligand Interaction
================================================================================

This release of **OEBio TK** includes significant improvements to the
perception of potential protein-ligand interactions, intramolecular
interactions, and missing potential interactions.

A new type of interaction, :oe:cls:`Halogen Bonds<OEBio::OEHalogenBondInteractionHint>`, 
has been added to **OEBio TK**.
It joins :oe:cls:`Hydrogen Bonds<OEBio::OEHBondInteractionHint>`, 
:oe:cls:`Salt Bridges<OEBio::OESaltBridgeInteractionHint>`, 
:oe:cls:`Chelation<OEBio::OEChelatorInteractionHint>`, 
and :oe:cls:`Pi- and T-aromatic Stacking<OEBio::OEStackingInteractionHint>`
in the set of perceived interaction types.  These interactions
provide qualitative hints about biological interactions that may be important
for binding, and can be helpful for visualizing interactions and clashes.

An interface for modifying the geometric definitions for each interaction
has also been introduced.  While the default bond geometries have been
carefully constructed using literature data (see below), users can now
customize interaction parameters to fit their needs.

1. Kumar, S. and Nussinov, R., Biophysical Journal, 83:1595-1612, 2002.
2. Cavallo, G., Metrangolo, P., Milani, R., Pilati, T., Priimagi, A.,
   Resnati, G., Terraneo, G., Chem. Rev. 2478-2601, 2016.
3. Bissantz, C., Kuhn, B., Stahl, M., J. Med. Chem., 53:5061-5084, 2010.
4. Marcou, G., Rognan, D., J. Chem. Inf. Model., 47:195-207, 2007.

**FastROCS TK** CUDA Implementation
================================================================================

The internal GPU implementation of **FastROCS** has been ported from
OpenCL to CUDA.   Although this does not change the results returned by
**FastROCS** and should not impact the deployment of **FastROCS TK**
on customer machines,
it does allow **OpenEye** to better support NVIDIA hardware and facilitates
our ability to improve performance and add GPU functionality.

General Notices
================================================================================

* The 2016.Oct release adds support for Ubuntu16 for C++, Java, Python 2.7,
  and Python 3.x.

* The 2016.Oct release is the last release to support OSX 10.9.  The 2017.Feb
  release will add full support for macOS Sierra 10.12.

.. note::

   **OpenEye** continues to monitor and collect feedback from our customers
   on the need to support Python 2 wrappers.  Our current plan is to
   phase out support for Python 2 on Windows by the 2017.Oct release and
   phase out support on other platforms at a later date.
   As this is a substantial change for our customers, we are willing
   to help with migration.
   Please contact support@eyesopen.com for more details.


******************************
OEToolkits 2017.Feb
******************************

Alternative Starting Points for Shape Overlap Optimization in **FastROCS TK**
================================================================================

This release of **FastROCS TK** extends its capability to find the best
possible shape match between two conformers by introducing the ability to
use custom starting points for the shape search. For some systems, using
these alternative starting points can lead to more accurate shape scoring
as it enables broader sampling of the molecular volume overlap.

By default, the shape search in **FastROCS TK** starts from 4 poses of the
database molecule aligned around the inertial axes.  With the
:oe:constns:`UserInertialStarts<OEFastROCS::OEFastROCSOrientation::UserInertialStarts>`
option, **FastROCS TK** translates the database molecule to user-defined
starting coordinates. With the
:oe:constns:`InertialAtHeavyAtoms<OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms>` option,
the database molecule is translated to each heavy atom of the query molecule.
In both cases, the shape overlap is optimized for 4 unique inertial poses
at each location.

The images below illustrate a shape search between caffeine query and a
naphthalene derivative.

.. list-table:: **Caffeine query and naphthalene derivative**

   * - .. image:: images/2017-Feb/fr1a.png
          :align:  center
          :width: 400

     - .. image:: images/2017-Feb/fr1b.png
          :align:  center
          :width: 400

The default shape search results in a poor overlap between the two molecules
(left). When the new
:oe:constns:`InertialAtHeavyAtoms<OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms>`
option is used, the resulting overlap is much more favorable (right).

.. list-table:: **Best overlap: default vs. ``InertialAtHeavyAtoms`` starting points**

   * - .. image:: images/2017-Feb/fr2a.png
          :align:  center
          :width: 400

     - .. image:: images/2017-Feb/fr2b.png
          :align:  center
          :width: 400

In general, these options provide the ability to fine-tune **FastROCS TK**
searching based on specific criteria.

Charging Engine
================================================================================

A new charging function, :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`,
has been added.   This function introduces the concept of a
:oe:cls:`charge engine<OEProton::OEChargeEngineBase>`,
a flexible, open-ended
options class that defines a charging method.   Charge engines have been
written for every currently supported charging method as well as the new method
:oe:cls:`OEAM1BCCELF10Charges<OEProton::OEAM1BCCELF10Charges>`.

New Maximum Common Substructure (MCS) Similarity Capability
================================================================================

A new class, :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>`, has been
added that allows pairwise MCS similarity scores to be computed for a
query molecule against a set of indexed target structures.  The indexing
algorithm uses a fragmentation approach to reduce the computational
requirements of traditional ``NxN`` structure comparisons for MCS
scoring.  Tanimoto and Tversky similarity scoring functions are
provided, as well as the ability to implement custom scoring
functions.

Protein Preparation Update
================================================================================

In the 2016.Oct release, new functionality for hydrogen placement was
added as part of a protein preparation workflow.  This new functionality
has been significantly improved.

A new scoring system, ``MMFF-NIE`` (“MMFF Neighbor Interaction Energies”),
has been added to :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`
that significantly improves optimization of hydrogen bonding
networks and clash avoidance.

In addition, significant improvements have been made in the placement of
hydrogens around metal complexes.  In the following example, cysteine
sulfurs are now properly perceived as deprotonated in
the zinc finger domain of the nucleocapsid protein NCp8 (PDB: 2A51).

.. list-table:: **2016.Oct vs 2017.Feb cysteines in zinc finger domain**

   * - .. image:: images/2017-Feb/oct2a51SH.png
          :align:  center
          :width: 400

     - .. image:: images/2017-Feb/feb2a51Sminus.png
          :align:  center
          :width: 400

General Notices
================================================================================

* For Python, the new environment variable ``OE_PIP_ARCH`` can be set to
  override the Python package download.  ``OE_ARCH`` now only applies to
  application installation.  This should mitigate conflicts between Python
  and application package installation.

* On Linux, Python ``single-build`` distributions are now installed by default
  when using the meta-installer via ``pip install openeye-toolkits``.
  If a problem is encountered with the ``single-build``
  packages, users can set the environment variable ``OE_PIP_ARCH=old``
  before the ``pip install`` step.

* The Java wrappers are now built using Java 1.8 in 1.6 compatibility mode.
  Users should see no impact.

* The 2017.Feb release fully supports macOS Sierra 10.12.

* Python 3.4 on Windows is no longer supported.

* Python 3.6 will be supported in the 2017.Jun release.

.. note::

   The default Python version installed under Anaconda/Miniconda is
   Python 3.6.  Until the 2017.Jun release is available, users should
   override the default Python version with ``conda create python=3.5 ...``
   during the conda environment creation step.

.. note::

   **OpenEye** continues to monitor and collect feedback from our customers
   on the need to support Python 2 wrappers.  Our current plan is to
   phase out support for Python 2 on Windows by the 2017.Oct release and
   phase out support on other platforms at a later date.
   As this is a substantial change for our customers, we are willing
   to help with migration.  Please contact support@eyesopen.com for
   more details.


.. _toolkit_release_highlights_2017_Jun:

******************************
OEToolkits 2017.Jun
******************************

Shape TK: Hermite
================================================================================

The 2017.Jun release introduces the :ref:`OEHermite <OEShape_OEHermite>` class, which
allows a molecule to be expanded into a Hermite representation.  An initial
suggested area of application is the representation of protein shape. The
advantages of representing proteins by Hermites include:

* smooth representations that capture any level of detail, from the
  atomistic (many coefficients, see the picture on the right) to the very
  coarse (few coefficients, as in the middle picture),

* the ability to store these representations in a compact manner,

* the ability to transform these representations easily, and 

* very fast overlap calculations between proteins. 

Below are examples of low- and high-resolution Hermite representation
images of dihydrofolate reductase (DHFR):

.. figure:: releasenotes/images/2017-Jun/hermite-figure.*
   :width: 650pt
   :align: center
   :alt: Hard and soft shape gaussians
  
   **Exact shape versus Hermite Representation**

**OpenEye** will explore the potential of Hermite representations; we invite
users to do likewise with this exciting new addition to the OpenEye toolkits.
See the :ref:`shapetk_hermite_section` chapter of the **Shape TK**
documentation for more information.

OEDepict TK and Grapheme TK: Interactive SVG images
================================================================================

Scalable Vector Graphics (SVG) image format is dominant in web applications due
to its wide browser support and scalability.  An SVG image contains a list of
graphical objects that can be grouped, styled, and transformed together.
This enables the generation of interactive images defined in the SVG XML
elements or via scripting that accesses the SVG Document Object Model (DOM).

The new :term:`Preliminary API` available in **OEDepict TK** provides low-level
functionality that enables grouping of graphical elements in SVG images that
can be manipulated externally by web developers.
High-level API entrypoints are also available to generate self-contained SVG
images that show or hide different elements of the image based on mouse events.

.. only:: oehtml

   .. list-table:: **Example of interactive SVG images (PDB: 4HWR)**
      :widths: 400 400

      * - Hover the mouse over any ligand atom to display its b-factor
        - Click on any residue circle to display ligand atoms it interacts with

      * - .. raw:: html

             <p align="center">
             <object data="../_images/bfactor-4HWR.svg" type="image/svg+xml"  width = "400" ></object>
             <p>

        - .. raw:: html

             <p align="center">
             <object data="../_images/RenderContactMap-4HWR.svg" type="image/svg+xml"  width = "400" ></object>
             <p>

   .. these are necessary to copy images into build subdirectory

   .. image:: /_images/bfactor-4HWR.svg
      :width: 1pt

   .. image:: /_images/RenderContactMap-4HWR.svg
      :width: 1pt

For more information see the :ref:`chapter_svg` chapter of the **OEDepict TK**
documentation.

GraphSim TK: Fast Fingerprint Similarity Search
================================================================================

**OEGraphSim TK** now provides improved fingerprint search capability,
allowing users to perform molecule similarity searches on large databases
up to 10x faster than previous versions.

Fingerprint methods are used for the computation of similarity scores.
When searching large virtual databases, performance can be problematic.
To address this issue, **OEGraphSim TK** now uses :term:`popcount`, a
hardware instruction available on modern CPUs, to provide significant
performance improvements for computing similarity.

The new fingerprint search can be performed in two modes: *in-memory* and
*memory-mapped*.  The in-memory mode involves preloading all fingerprints
into memory and performing the search.  While this represents the
fastest way to perform similarity searches once the fingerprints are loaded,
searches are limited by memory availability.  The memory-mapped mode has no
load time penalty or memory limitation but the search itself takes more time.

.. list-table::
   :widths: 400 400

   * - fingerprint generation performance
     - fingerprint search performance

   * - .. image:: images/2017-Jun/PerformanceMakeFastFP.*
          :width: 300 pt

       * *generating 1M 4096-bit long tree fingerprints*
       * *benchmarked on m4.10xlarge AWS instance*
       * *multi-threaded fingerprint generation*

     - .. image:: images/2017-Jun/PerformanceFastFP.*
          :width: 300 pt

       * *128M 4096-bit long tree fingerprints = 64GB data*
       * *benchmarked on m4.10xlarge AWS instance*
       * *single-threaded search on CPU*

See the :ref:`oegraphsim_chapter_examples` chapter of the **OEGraphSim TK**
documentation for more information and examples using the new
:ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class.

General Notices
================================================================================

* On Linux, Python ``single-build`` distributions are now installed by default
  when using the meta-installer via ``pip install openeye-toolkits``.
  If a problem is encountered with the ``single-build``
  packages, users can set the environment variable ``OE_PIP_ARCH=old``
  before the ``pip install`` step.

* Python 3.6 is supported in the 2017.Jun release.

* This is the last release to support 32-bit Java.

* This is the last release to support Red Hat Enterprise Linux version 5.
  As of March 31, 2017, RHEL5 has reached end-of-production support.

.. note::

   **OpenEye** continues to monitor and collect feedback from our customers
   on the need to support Python 2 wrappers.  Our current plan is to
   phase out support for Python 2 on all platforms by the 2017.Oct release.
   As this is a substantial change for our customers, we are willing
   to help with migration.  Please contact support@eyesopen.com for
   more details.


.. _toolkit_release_highlights_2017_Oct:

******************************
OEToolkits 2017.Oct
******************************

Shape TK: Version 2.0.0
================================================================================

The 2017.Oct release introduces **Shape TK** version 2.0.0, which
is completely redesigned with a new API that is more flexible and
easily extended with new functionality.  **Shape TK** version
2.0.0 is now thread-safe and is able to:

* calculate color using grid- or proxy grid-based analytic methods

* calculate shape overlap and color score between two fixed-in-space objects
  with a single calculation using the :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>` class

* combine force fields from the **OEFF TK** with shape and/or
  color for overlay optimization

* obtain top hits from a database against a given query using
  the :ref:`OEROCS <OEShape_OEROCS>` class

* create a query combining any combination of a molecule, a
  grid, and multiple shape and/or color Gaussians using the
  :ref:`OEShapeQuery <OEShape_OEShapeQuery>` class (see example below)

Preliminary testing of functionality from **Shape TK** version 2.0.0
indicates that overlay optimization is up to 10% faster than the
:ref:`2017.Jun <toolkit_release_highlights_2017_Jun>` version.

.. list-table:: **Shape query with shape grid and color Gaussians**

   * - .. image:: images/2017-Oct/ShapeQuery.*
          :width: 500 pt
  
**Omega TK**: New Torsion Library
================================================================================

A new torsion library has been added to **Omega TK** based on a probabilistic
analysis of torsion angles in the Cambridge Structural Database (CSD) by
Guba et al. [Guba-2016]_ This torsion library, which contains more than 500
entries, complements the existing torsion library, which is based mainly on
analysis of structures found in the Protein Data Bank (PDB).  Replacement of
the existing library with the new library has four important effects on
OMEGA’s performance:

* nearly complete elimination of torsion values not well represented
  in the CSD

* significantly improved run time

* substantial reduction in the size of the conformer ensemble

* small trade-off increase in the median RMSD for solid state structures
  (both from the PDB and the CSD)

**OEDepict TK** and **Grapheme TK**: Interactive SVG Images
================================================================================

The 2017.Oct release expands these toolkits' ability to assemble sets of
graphical objects in SVG images.

Images can present great deal of information very quickly, but those that
try to convey too much information at once can look convoluted. The solution
lies in generating interactive images that on the surface are simple but
that can reveal extra information on request. This release allows users to
mouse over simple images to view additional embedded information.

In the example below, the sequence-level depiction of a peptide is easily
comprehensible due to its simplicity (see image below). The more detailed
atomic-level representation of the amino acid components of the peptide can
be revealed on mouse-over without cluttering the simplified view.

.. only:: oehtml

   .. list-table:: **Examples of interactive SVG images generated by Grapheme TK**
      :widths: 450 450

      * - Hover the mouse over any peptide circle
        - Hover the mouse over any residue circle or "Legend" label

      * - .. raw:: html

             <p align="center">
             <object data="../_images/peptide2img-1jbl.svg" type="image/svg+xml"  width = "350" ></object>
             <p>

        - .. raw:: html

             <p align="center">
             <object data="../_images/complex2img-pdb3eqb.svg" type="image/svg+xml"  width = "350" ></object>
             <p>

      * - cyclic trypsin inhibitor (PDB: 1JBL)
        - protein-ligand visualization (PDB: 3EQB)

   .. these are necessary to copy images into build subdirectory

   .. image:: /_images/peptide2img-1jbl.svg
      :width: 1pt

   .. image:: /_images/complex2img-pdb3eqb.svg
      :width: 1pt

For more information, see the :ref:`chapter_svg` chapter of the **OEDepict TK**
documentation.

General Notices
================================================================================

* On macOS Python, ``single-build`` distributions are now installed by
  default when using the meta-installer via ``pip install openeye-toolkits``.

* The Python verification tests now use ``pytest`` rather than ``nosetest``
  as the test discovery tool. ``pytest`` options can be passed to the
  ``openeye.examples.openeye_tests`` module to control the tests and
  level of debugging information provided.

* This is the last release to support Java 1.6.

* This is the last release to support Python 2.7.


******************************
OEToolkits 2018.Feb
******************************

GraphSim TK: GPU-Accelerated Fast Fingerprint Similarity Searches
================================================================================

**GraphSim TK** now supports CUDA for even faster fingerprint searching,
allowing users to perform molecular similarity calculations up to
*200x faster* than the in-memory fast fingerprint mode (see the NxN
similarity score calculations graph below).

CUDA mode involves preloading all fingerprints into GPU memory
prior to performing similarity calculations. Searches are limited by GPU
memory availability and will fall back to the memory-mapped CPU mode if the
entire set of fingerprints cannot be preloaded into the GPU memory.
Despite this limitation, this represents the fastest way to perform
similarity searches.

The most effective way to use CUDA fingerprint searches is to perform
multiple searches with a pre-loaded database on a dedicated GPU machine.
If CUDA mode is selected but a GPU is not present on the system,
the search will simply fall back to memory-mapped mode.

The new :oe:meth:`OEGraphSim::OEFastFPDatabase::GetHistogram` method
performs an NxN search of a database and returns a histogram of scores.
This is valuable information for understanding the diversity of a
database without consuming excess disk space.
Using :oe:meth:`OEGraphSim::OEFastFPDatabase::GetHistogram` in CUDA
mode will afford *2.5 billion* searches per second
(benchmarked on an AWS P3 instance - NVIDIA Tesla V100) compared with
*12.5 million* searches per second when using memory-mapped mode on the CPU.

.. list-table::
   :widths: 300 450

   * - Performance of an NxN similarity score calculation
     - Performance of a fingerprint search (load time not included)

   * - .. image:: images/2018-Feb/Performance-ScoreHistogram-CPU-GPU.*
          :width: 300 pt

       * *16M 4096-bit long tree fingerprints = 8GB data*
       * *CPU benchmarked on m4.10xlarge AWS instance (single threaded)*
       * *GPU benchmarked on p3.8xlarge AWS instance*
       * *In-memory timings are extrapolated from shorter runs*

     - .. image:: images/2018-Feb/Performance-SimilaritySearch-CPU-GPU.*
          :width: 450 pt

       * *128M 4096-bit long tree fingerprints = 64GB data*
       * *retrieving the 10 most similar molecules*
       * *CPU benchmarked on m4.10xlarge AWS instance (single threaded)*
       * *GPU benchmarked on p3.8xlarge AWS instance*

See the :ref:`oegraphsim_chapter_examples` chapter of the **OEGraphSim TK**
documentation for more information and examples using the new
:ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class.

Grapheme TK : Unpaired Interaction Map
================================================================================

**Grapheme TK** now includes the ability to generate unpaired interaction maps
(see the example below).  An unpaired interaction map provides a
complementary view to the more common active site interaction
depiction. While the interaction map (on the right) depicts interactions
between the ligand and protein, the unpaired map (on the left) illustrates
interactions that could contribute to binding but are not formed in the
complex. Together, these two maps of the protein-ligand binding site
provide insights into protein-ligand interactions and communicate complex 3D
structural results in a directly actionable way.

In the unpaired interaction map, different linker types are used to
mark unpaired acceptor and donor hydrogen bond interactions (see the
figure on the left). Note that since these interactions are unpaired, the
direction of the linkers has no real spatial meaning. Ligand linkers
are directed away from the ligand, while protein linkers are directed
towards the ligand.

The geometric parameters used to perceive unpaired interactions are
customizable to fit user needs.

.. only:: oehtml

   .. list-table:: **Unpaired interaction map (left) and active site depiction (right) generated after hydrogen placement (PDB: 1BR6)**
      :widths: 500 500

      * - .. image:: images/2018-Feb/RenderUnpairedMap-2018-Feb.svg
             :width: 500 pt

        - .. image:: images/2018-Feb/RenderActiveSite-2018-Feb.svg
             :width: 500 pt

.. only:: oepdf

   .. list-table:: **Unpaired interaction map (left) and active site depiction (right) generated after hydrogen placement (PDB: 1BR6)**
      :widths: 400 400

      * - .. image:: images/2018-Feb/RenderUnpairedMap-2018-Feb.pdf
             :width: 220 pt

        - .. image:: images/2018-Feb/RenderActiveSite-2018-Feb.pdf
             :width: 220 pt

Conda Packages for Python
================================================================================

The 2018.Feb release is the first release to fully support Conda packages
for Python toolkits on all supported platforms.  The toolkits are available
as a package named ``openeye-toolkits`` in the ``openeye`` Conda channel on
the default ``conda.anaconda.org`` server.  Versions are available for
Python 3.5 and higher on Windows and Python 3.4 and higher on Linux and macOS.
On Linux and macOS, users can install the toolkits into a Conda Python
environment with ``conda install -c openeye openeye-toolkits``.  On Windows,
Anaconda Navigator is a convenient way to manage Conda packages.

See :ref:`Python Installation <python_installation>` for more information.

General Notices
================================================================================

* All **OpenEye Toolkit** Python code examples now follow
  the `PEP8 <https://www.python.org/dev/peps/pep-0008/>`_  standard.

* The 2018.Feb release fully supports macOS High Sierra 10.13.

* mac OS 10.10 is no longer supported.


******************************
OEToolkits 2018.Oct
******************************

Omega TK: Macrocycle
================================================================================

A new distance geometry-based, conformational space-sampling method
has been added to **Omega TK** as a :term:`preliminary API <Preliminary API>`.
This approach opens up a new avenue for exploring conformer ensembles in **Omega
TK**. Although the distance geometry-based sampling is slower than the
traditional torsion driving-based approach, it works substantially
better for ensemble generation of macrocyclic molecules. This sampling
method can also be applied to linear and small ring-containing
molecules.

.. figure:: /_images/geldanamycin_macrocycle.png
   :width: 350pt
   :align: center

   **Conformer ensemble subset for geldanamycin (PDB: 1YET) generated using the macrocycle method**

FastROCS TK: C++ and Java Support
================================================================================

Previously, **FastROCS TK**  was available only in Python.
This release extends support to  `C++ <https://docs.eyesopen.com/toolkits/cpp/fastrocstk>`_
and `Java <https://docs.eyesopen.com/toolkits/java/fastrocstk>`_.
All classes, functions, and constants are wrapped and available for use.
Several example scripts now have C++ and Java versions
to showcase **FastROCS TK** functionalities.
Additionally, users running **FastROCS TK** on Tesla GPUs will see a 10-30%
speed-up over the previous version, depending on the system.

Quacpac TK: Tautomers
================================================================================

This release adds several improvements to the tautomer functionality in
**Quacpac TK**.
Tautomer handling in molecular modeling and cheminformatics usually includes
three important functions:

* Generating a canonical protomer representation for duplicate-free storage

* Generating a single tautomer suitable for visualization by chemists and
  modelers

* Generating an ensemble of aqueous-phase tautomers suitable for molecular
  modeling

.. figure:: releasenotes/images/2018-Oct/tautomer-enumeration.*
   :width: 600pt
   :align: center

   **Example of generating an ensemble of biologically relevant tautomers**

This release provides new API to cover each of these use-cases.
The algorithm has also been improved to handle memory usage when
a large number of possible tautomeric forms are present.

General Notices
================================================================================

* The release cycle of **OpenEye Toolkits** has been changed.
  See the :ref:`chapter_release_cycle` section for more information.

* This is the last release to support GCC 4.4 on RHEL6. For future
  toolkit releases, GCC 4.8 will be the oldest targeted compiler.

* This is the last release to support OS X 10.11. Full support for
  macOS 10.14 will be added in the next release.

* This release adds support for Ubuntu 18 and
  will be the last release to support Ubuntu 14.

* This release adds support for Python 3.7 on macOS and Linux. On Windows,
  Python 3.7 will be supported in the next release that will also drop
  support for Python 3.5.

* **FastROCS TK** no longer supports Nvidia Tesla, GeForce, and Quadro
  cards with a compute capability of less than 3.0. This includes all
  GPUs with Fermi architecture (e.g., Tesla C2050 and GeForce GTX 430).
  Users running one of these older GPUs who cannot upgrade their
  hardware should not update to this version of **FastROCS TK**.

* **Spruce TK** now requires a specific license. For information on
  **Spruce TK** licensing, please visit https://www.eyesopen.com/contact.

* Improvements have been made to the Python 3 toolkits with regard to
  wrapping optimization.  This results in Python 3 performance being
  comparable to Python 2.


.. _highlights_2019_Apr:

******************************
OEToolkits 2019.Apr
******************************

FastROCS TK: Color calculation on GPU
================================================================================

Changes to the **FastROCS** algorithm, including porting the static color
calculation to GPU, have resulted in a more than 2x performance improvement of **FastROCS** on some GPU systems.
Benchmarking was carried out on AWS GPU instances and compared to the 2018.Oct
version of **FastROCS TK**:

.. figure:: /_images/2018-2019_comparison_aws.png
   :width: 400pt
   :align: center

   **Performance comparison between the 2018.Oct release and the 2019.Apr release using
   OpenEye's standard benchmark dataset of 14M conformers on AWS.**

For some systems, the standard benchmark dataset of 14M conformers is not large
enough to fully saturate the GPUs. To demonstrate the potential
performance of larger databases, a 2 billion conformer subset of
Enamine was searched on suitable AWS instances. FastROCS searched the
2 billion conformer database on an AWS P3 instance with 8x Nvidia
Tesla V100 GPUs at a rate of over 44 million overlays per second:

.. figure:: /_images/AWS-Enamine-2bn.png
   :width: 300pt
   :align: center

   **Performance of a 2 billion conformer subset of Enamine on suitable AWS instances.**

OEChem TK: OEZ compressed file format
================================================================================

A new compressed file format with the extension ``oez`` has been added to
**OEChem TK**.
This format uses the `Zstandard <https://facebook.github.io/zstd/>`_ algorithm
to efficiently compress individual multi-conformer molecules, making it well-suited
to work with :ref:`OEMolDatabase <OEChem_OEMolDatabase>` for fast read-only random access to molecules.
See more details in the :ref:`section_molreadwrite_compressed` section of the
**OEChem TK documentation**.

OEGrapheme TK: Ramachandran plot
================================================================================

Following our tradition of providing easily comprehensible visualization of
complex data, **OEGrapheme TK** can now depict Ramachandran plots ([Ramachandran-1963]_).
These plots provide an easy way to examine the distribution of backbone dihedral angles in a particular protein.
For instance, structure quality can be assessed by identifying residues whose
backbone :math:`\psi` are outside energetically accessible regions.
**Grapheme TK** uses the data and classifications available in **OEBio TK**,
which were extracted from the open-source
Computational Crystallography Toolbox [Grosse-Kunstleve-2002]_.

.. only:: oehtml

   .. raw:: html

      <p align="center">
      <b > Hovering over the red circles (on the top right plot) reveals the name of the outlier residues</b>
      <p>

      <p align="center">
      <object data="../_images/ramagrid2img-2rox.svg" type="image/svg+xml"  width = "800" ></object>
      <p>

      <p align="center">
      <b>Examples of visualizing the Ramachandran plots of various residue types in Grapheme TK (PDB: 2ROX)</b>
      <p>

  .. this is necessary to copy images into build subdirectory

  .. image:: /_images/ramagrid2img-2rox.svg
     :width: 1pt

General Notices
================================================================================

* **OpenEye** currently uses `OpenJDK8 <https://openjdk.java.net/>`_ to
  build its Java packages. We are currently exploring support for OpenJDK 11.

* The 2019.Apr release skips Java support for macOS. For Java support on RHEL6,
  please contact support@eyesopen.com.

* This release adds support for macOS 10.14. OS X 10.11 is no longer supported.

* This release adds support for Ubuntu 18. Ubuntu 14 is no longer supported.

* Visual Studio 2017 support has been added for C++ and C#.
  This is the last release to support Visual Studio 2013,
  as well as 32-bit Windows for C++ and C#.

* Full support has been added for Python 3.7.
  Python 3.5 for Windows is no longer supported.

* The following prerequisites have been introduced
  so that **OpenEye** can implement algorithms in a more modern and
  efficient C++11 style:

  * GCC 4.8 is now the oldest targeted compiler for toolkits.
    RHEL6 with the default GCC 4.4 compiler is no longer supported.

  * The minimum recommended GNU `binutils <https://www.gnu.org/software/binutils/>`_
    version is 2.26 for the C++ single-build Linux packages.

  * The minimum CMake version required to build the C++ examples is now 3.1.3
    on all platforms.


.. _highlights_2019_Oct:

******************************
OEToolkits 2019.Oct
******************************

Spruce TK: A new toolkit for biomolecular structure preparation
================================================================================

The 2019.Oct release introduces **Spruce TK**. **Spruce TK** takes experimental
biomolecular structure data in either PDB or mmCIF formats, and prepares the
structures for use with downstream modeling applications, such as docking with
**FRED** or **HYBRID**, pose prediction with **POSIT**, identifying favorable
and unfavorable waters with **SZMAP** or free energy calculations using
molecular dynamics simulations.

With **Spruce TK**, users can easily prepare proteins using either C++ or
Python APIs (see :oe:func:`OESpruce::OEMakeDesignUnits`), where the output of the file is the recently
developed :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class and is serialized to a new OEDU file format.
The prepared system is componentized into molecular categories including `protein`, `ligand`,
`nucleic`, `solvent`, and many other molecular types common to biomolecular experiments.
By default, hydrogens are added to systems using a tautomer search for any ligand, cofactor,
or other nonstandard residue molecules. In addition, the system is split into distinct biological
units, and all final design unit structures are superposed into the common frame of reference of a
parent structure. For more details, see :ref:`Spruce theory<sprucetk_theory>`.

**Spruce TK** has been tested across a broad range of industry-relevant targets.
It has been used in virtual screening and molecular dynamics simulations in **Orion**,
as well as to prepare structures for loading into the MacroMolecular Data Service (MMDS).

OEChem TK: Fast Substructure Search
================================================================================

Substructure search is a fundamental task in cheminformatics.
**OEChem TK** now provides improved substructure search capability, allowing
users to search tens of millions of molecules in seconds.

**OEChem TK** uses the screen-based approach to accelerate the search process.
Screens are bit vectors encoding global and local features of molecules. They are
prebuilt and can be used to rapidly eliminate structures that could not be
matched to a query molecule. Only molecules that pass the screen are subjected
to the computationally more expensive atom-by-atom matching for validation.
**OEChem TK** provides three types of built-in screens based on the source of the
query molecule: :oe:const:`MDL<OEChem::OESubSearchScreenType::MDL>`,
:oe:const:`SMARTS<OEChem::OESubSearchScreenType::SMARTS>`, and
:oe:const:`Molecule<OEChem::OESubSearchScreenType::Molecule>`.
All screens are rigorously tested using diverse sets of queries and multiple
molecule databases to ensure that they do not eliminate true positive matches.

The new multi-threaded substructure search can be performed in two modes:
:oe:const:`in-memory<OEChem::OESubSearchDatabaseType::InMemoryMultiThreaded>`
and :oe:const:`molecule-database<OEChem::OESubSearchDatabaseType::MolDatabaseMultiThreaded>`.
The :oe:const:`in-memory<OEChem::OESubSearchDatabaseType::InMemoryMultiThreaded>`
mode provides the fastest way to search a dataset, but it is memory-intensive
as it holds both screens and molecules in memory.
The :oe:const:`molecule-database<OEChem::OESubSearchDatabaseType::MolDatabaseMultiThreaded>` mode
keeps only the screens in memory; only molecules with unmatching screens have to
be loaded into the memory. This method can be slower but uses significantly
less memory, allowing users to search larger datasets.

.. list-table::
   :widths: 400 400

   * - screen generation performance
     - substructure search performance

   * - .. image:: ./images/2019-Oct/GenerateFastSS.*
          :width: 300 pt

       * *generating 1M MDL 896-bit long screens*
       * *benchmarked on r5.16xlarge AWS instance*
       * *multi-threaded screen generation*

     - .. image:: ./images/2019-Oct/SubSearchMDL.*
          :width: 300 pt

       * `Enamine REAL Diverse  24.1M <https://enamine.net/library-synthesis/real-compounds/real-compound-libraries>`_
       * in-house diverse set of 650 MDL queries
       * *benchmarked on r5.16xlarge AWS instance*
       * *multi-threaded search using 64CPU*

See the :ref:`section_example_oechem_molecule_searching` chapter of **OEChem TK**
for examples using the new :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` class.
For the full list of new preliminary APIs, see :ref:`section_oechem_releasenotes_230`.

OEFF TK: SMIRNOFF
================================================================================

The 2019.Oct release incorporates the SMIRNOFF small molecule force field from
the `Open Force Field Initiative <https://openforcefield.org>`_  into **OEFF TK**.
The force field can handle almost all pharmaceutically
relevant chemical space.

The SMIRNOFF force field differs from traditional force fields principally in the data
representation of the chemistry. It uses extended SMARTS strings for parameters
instead of atom types, greatly reducing the number of interdependent parameters.
It currently adopts the functional form of the AMBER force field, but the
Open Force Field Initiative is actively examining improvements to this. **OEFF TK**
intends to include the most up-to-date version of the force field in its own releases
whenever possible.

General Notices
================================================================================

* This is the last release to support macOS 10.12. Full support for macOS 10.15
  will be added in the next release.

* This is the last release to support RHEL6. Full support for RHEL8 will be added
  in the next release.

* The 2019.Oct release skips Java support for macOS. For Java support on RHEL6,
  please contact support@eyesopen.com.

* A new search engine that provides better hits and shows results in a much cleaner
  format has been added to the documents.

* The 2019.Oct release now uses SWIG 3.0.12 for generating C#, Java, and Python wrappers.
  C# and Python use SWIG's built-in support for wrapping C++
  `std::vector <https://en.cppreference.com/w/cpp/container/vector>`_ and string types.


.. _tkhighlights_2020_2:

*************************
Release Highlights 2020.2
*************************

OEToolkits 2020.2.2
====================

The **OEToolkits 2020.2.2** is a bug-fix of the **OEToolkits 2020.2** release.
Click on the below links for more information about the bug fixes in this release:

  * :ref:`section_oechem_releasenotes_3102`
  * :ref:`section_oedocking_releasenotes_4002`
  * :ref:`section_quacpac_releasenotes_2112`

.. _omegaTK_highlight_Fall2020:

Omega TK: New fragment library
==============================

A new enhanced fragment library has been created for use in **Omega TK**.
The new fragment library consists of more than 500,000 fragments that have been
generated using the MMFF force field.

This new library is designed to reduce the run time of large-scale conformer
generation, and therefore is not built in to **Omega TK** but is available as a
separate `download <http://www.eyesopen.com/database-downloads>`_.
To run **Omega TK** with the enhanced library, simply use the :ref:`OEOmega <OEConfGen_OEOmega>`
method :oe:meth:`OEConfGen::OEOmega::AddFragLib`.

The fragments have been collated from commonly used electronic
databases, such as Enamine Building Blocks. Consequently, dramatic
runtime performance improvements can be seen for the Enamine Real dataset, among
others, since less time is spent building fragments on the fly. Runtime performance improvements
can be seen for all datasets; the Platinum and Enamine Real sets show particular improvement
and run ~50% faster (benchmarks run on Ubuntu 16 with Intel(R) Xeon(R) Gold 6128 CPU 3.40GHz and NVIDIA Tesla V100 GPU).

.. figure:: /_images/Omega_FragLib_Runtime_Perf.png
   :width: 500pt
   :align: center

   **GPU-OMEGA runtime performance using the built-in fragment library compared to
   the new enhanced fragment library. Benchmark datasets are a filtered set of 2359 molecules of
   the Platinum dataset and 10,000 randomly chosen molecules of the Enamine Real,
   Mcule and WuXi databases.**

The enhanced fragment library generates the same high-quality conformers as the built-in library,
as shown by the minimum RMSDs of the filtered Platinum dataset.

.. figure:: /_images/Omega_FragLib_Plat_Div_Perf.png
 :width: 400pt
 :align: center

 **Box plots showing minimum RMSDs of a filtered set of 2359 molecules of
 the Platinum dataset with the built-in fragment library and
 the new enhanced fragment library.**

Datasets can be downloaded from:
  * `Mcule <https://mcule.com/database/>`_
  * `Enamine Real <https://enamine.net/library-synthesis/real-compounds/real-database>`_
  * `Platinum Dataset <https://comp3d.univie.ac.at/servers-datasets/#c523270>`_
  * `WuXi <https://www.labnetwork.com/frontend-app/>`_

We are eager to get your feedback on the new enhanced fragment library. Please share
your experience with us at support@eyesopen.com.

.. _dockingTK_highlight_Fall2020:

OEDocking TK: Improved receptors
================================================================================

Receptors used in **OEDocking TK** classes, including **FRED**, **HYBRID**, and **POSIT**,
have been improved
to take advantage of properly prepared structures from **SPRUCE**.
A new
:ref:`OEReceptor <OEBio_OEReceptor>` object has been introduced and is created and contained within an
:ref:`OEDesignUnit <OEBio_OEDesignUnit>`.  Since an :ref:`OEReceptor <OEBio_OEReceptor>` is now an integral part of an
:ref:`OEDesignUnit <OEBio_OEDesignUnit>`, it is saved into an ``OEDU`` file along with a design unit.
There is no separate I/O for the receptors.

.. figure:: /_images/2IKO_receptor.png
   :width: 400pt
   :align: center

   **OEDocking receptor, along with the target structure and the bound ligand,
   for the 2IKO Human Renin Complexed with Inhibitor.**

Having the receptors as part of the design unit with properly prepped structures makes it easier for the docked
and posed structures to be used in further downstream modeling, which is especially necessary when working with
protein force fields like ``FF14SB``. The new receptors with properly prepped protein also enabled use of modern
force fields like ``FF14SB`` and ``Parsley`` for structure optimization
in flexible :ref:`OEPosit <OEDocking_OEPosit>`.

.. _szybkiTK_highlight_Fall2020:

Szybki TK: A new protein force field
================================================================================

The ``AMBER FF14SB`` protein force field has been implemented in **OEFF TK**. This
new force field has also been made available in **SZYBKI** for optimizing both
protein and protein-ligand complexes.

``FF14SB`` is the most widely used protein force field for molecular dynamics or
any other force field-based calculations. It is also used in Orion molecular dynamics
package, and is the community gold standard for such calculations.

Supported Platforms
=================================================================================

  ===========  ===============  =====================  ===============================  ====================
  Package      Versions         Linux                  Windows                          macOS
  -----------  ---------------  ---------------------  -------------------------------  --------------------
  Python       3.6, 3.7, 3.8    RHEL7/8, Ubuntu18/20   Win10                            10.13, 10.14, 10.15
  C++                           RHEL7/8, Ubuntu18/20   Win10 (VS2017, VS2019)           10.13, 10.14, 10.15
  Java          1.8, 11         RHEL7/8, Ubuntu18/20   Win10                            10.13, 10.14, 10.15
  C#                                                   Win10 (VS2015, VS2017, VS2019)
  ===========  ===============  =====================  ===============================  ====================

Related TK Versions
=================================================================================

  ==============  ===========
  Toolkit         Version
  --------------  -----------
  OEChem TK       3.1.0
  OEDepict TK     2.4.5
  OEDocking TK    4.0.0
  FastROCS TK     2.1.0
  OEFF TK         2.3.0
  Grapheme TK     1.4.2
  Graphsim TK     2.5.1
  Lexichem TK     2.7.2
  OEMedChem TK    1.1.3
  MolProp TK      2.5.5
  Omega TK        4.1.0
  Quacpac TK      2.1.1
  Shape TK        3.4.1
  Spicoli TK      1.5.1
  Spruce TK       1.2.0
  Szmap TK        1.6.1
  Szybki TK       2.3.0
  Zap TK          2.4.0
  ==============  ===========

General Notices
=================================================================================

* Support for Ubuntu20 has been added.
  Ubuntu16 is no longer supported.

* C++ CUDA-enabled toolkits and features are now supported on RHEL8 and Ubuntu18.

* This is the last release to support GCC 4.x and GCC 5.x.
  GCC 7.4 will be the minimum GCC supported in the next release.

* This is the last release to support Python 3.6.

* This is the last release to support VS2015.




.. _highlights_2020_Spr:

=========================
Release Highlights 2020.1
=========================

OEToolkits 2020.1.1
===================

The **OEToolkits 2020.1.1** is a bug-fix of the **OEToolkits 2020.1** release.

  * :ref:`section_oechem_releasenotes_3006`
  * :ref:`section_omega_releasenotes_4006`

OEToolkits 2020.1
=================

The **OEToolkits 2020.1** is a bug-fix of the **OEToolkits 2020.0** release.

  * :ref:`section_oechem_releasenotes_3005`
  * :ref:`section_oedocking_releasenotes_3505`

OEToolkits 2020.0
=================

**OpenEye Toolkits** and **Applications** are now
integrated into a single release cycle. This integration ensures that the tools delivered
are more consistent
across various product levels and, in keeping with  **OpenEye** standards,
are robust and efficient.
In addition, the integration reduces release process management time, allows more time
to deliver new features, and facilitates delivering bug-fix releases for critical issues when needed.

Omega TK: GPU-Omega - GPU-accelerated torsion driving
-----------------------------------------------------

The 2020.0 release introduces **GPU-Omega** to the **Omega TK**.
**GPU-Omega**
provides accelerated torsion driving by utilizing a GPU (Graphics Processing Unit).
**GPU-Omega** is integrated into the existing **Omega TK**; no additional
user actions are required to make use of this new feature. **GPU-Omega** detects any
supported Nvidia GPU on Linux platforms and accelerates torsion driving automatically
unless explicitly suppressed through the option
:oe:meth:`OEConfGen::OETorDriveOptions::SetUseGPU`. **GPU-Omega** is available with
all sampling modes except ``macrocycle``, which does not use the torsion driving
method for conformer generation. For more details on **GPU-Omega**, including prerequisites
and additional requirements for use with ``dense`` mode, please see
:ref:`GPU-Omega<chapter_omegagpuomega>`.

**GPU-Omega** performs at the same high level of accuracy as **Omega TK**, as shown
below using a filtered subset of the Platinum dataset [Friedrich-2017]_ [Hawkins-2020]_:

.. figure:: /_images/CPU_v_GPU_scatter_rmsd.png
   :width: 400pt
   :align: center

   **Comparison of the minimum RMSDs of CPU- and GPU-generated conformers against
   the experimental coordinates of a filtered subset of the Platinum dataset**

**GPU-Omega** was benchmarked against the CPU on AWS to demonstrate the achievable
performance on a `P3 instance <https://aws.amazon.com/ec2/instance-types/p3/>`_,
which houses an `Nvidia Tesla V100 <https://www.nvidia.com/en-gb/data-center/tesla-v100/>`_
GPU. **GPU-Omega** was benchmarked with all supported sampling modes (``sparse``, ``dense``
``pose``, ``rocs``, and ``fastrocs``) using a subset of ~6000 molecules from the GSK TCAMs dataset
[Gamo-2010]_. The most impressive speed-up is seen with the ``dense`` sampling mode, with
a reduction in time from 120 hours to less than 4 hours with **GPU-Omega**.

.. figure:: /_images/GPUOmega_Modes_V100_perf_tks.png
   :width: 600pt
   :align: center

   **Elapsed time comparison between Omega and GPU-Omega on an AWS P3 instance
   when sampling a subset of the GSK-TCAMS dataset with sparse, rocs, fastrocs, pose,
   and dense modes.**

FastROCS TK: Color optimization on GPU
--------------------------------------

Overlay optimization by color, in addition to shape, has been added to **FastROCS**.
The color adds chemistry in the superposition and similarity analysis process,
and thus facilitates identifying compounds that are similar both in shape
and chemistry.  **FastROCS** with color optimization was carried out on K80, M60,
and V100 instances on AWS GPU instances and compared against those without color
optimization:

.. figure:: /_images/Color_optimization_vs_no_color_optimization_performance_v2.png
   :width: 400pt
   :align: center

   **Performance comparison for FastROCS with and without color optimization
   in the 2020.0 release, using OpenEye’s standard benchmark dataset of 14M conformers on AWS.**

Previous versions of **FastROCS** optimized over the shape score and followed that with a
single point calculation for color. This can result in overlooking promising molecules. An
example of the effect of optimizing over color and shape overlap rather than just shape
overlap is shown below for XIAP BIR3 [Ndubaku-2009]_:

.. figure:: /_images/fastrocs_example_v4_5_22_cropped.png
   :width: 600pt
   :align: center

   **Example of the improvement using color optimization in FastROCS**

On the far left is the XIAP BIR3 binding site with its crystallographic ligand in green. In the center
is the crystallographic ligand, as well two copies of a known active ligand from the DUDE dataset
[Mysinger-2012]_, with the best overlay from **FastROCS** without and with color optimization, respectively.
Without color optimization, the ligand is not predicted to have high shape or chemical similarity.
When color optimization is used, a high degree of chemical and volumetric overlap is predicted,
as would be expected given that this compound is a known active. On the far right is the overlay
in the binding site of XIAP BIR3, occupying a similar pose to the crystallographic ligand.

Spruce TK: Protein Loop Modeling
--------------------------------

The 2020.0 release adds protein loop modeling to **Spruce TK**. This feature is
available with the lower level APIs :oe:func:`OESpruce::OEBuildSingleLoop` and
:oe:func:`OESpruce::OEBuildLoops`. It is also incorporated as an option
in the high level structure preparation API :oe:func:`OESpruce::OEMakeDesignUnit`.

The approach relies on a template database built from structures in the public
`RCSB Protein Data Bank <https://www.rcsb.org/>`_.
The database, which has been built for modeling loops that are 4-20 residues long by default,
is available for `download <http://www.eyesopen.com/db-downloads>`_
in a platform-independent format.  An application in the **SPRUCE**  bundle
allows appending additional structures to the existing database. For example,
proprietary in-house structures can be added, or the database can be completely rebuilt
from scratch with different options.

This approach has been validated on a public dataset from Rossi et al.  [Rossi-2007]_.
The results shown below were generated by building the excised loops back into the dataset, where the specific structures themselves were not part of the template database, and used the same success criterion as in the paper (<2.5A backbone RMSD). The results are generally good and the median RMSD is 0.6-0.7A (blue dots), irrespective of the length of the modeled loop. The unsuccessful cases (gray bar) have a large effect on the average RMSD (green dots), as loops are chosen that deviate significantly from the expected. Only in a single case of the ~200 loops modeled was a result not produced (red bar) that survived the search and filtering steps.

.. figure:: /_images/RossiLoops.png
   :width: 400pt
   :align: center

   **Performance assessment building loops ranging from 4-12 residues in length. Errors are when no
   loop was produced, failures when the backbone RMSD is larger than 2.5A from the original structure.**

For the full list of new preliminary APIs, see :ref:`Spruce TK 1.1.0 Release Notes<section_oespruce_releasenotes_110>`.

OEChemTK: Data record preliminary API
-------------------------------------

A preliminary API for **OERecord** and its associated classes has been added to
**OEChem TK**. **OERecord** is a data container for storing and transmitting
strongly typed data and its associated metadata. A pure Python implementation
of **OERecord** has been in use by **ORION** and **Floe**; the new C++
implementation improves performance and memory management, and makes data
records available to **OpenEye** toolkit code. The API is only available in C++
and Python at this time.

General Notices
===============

* Support for macOS Catalina 10.15 has been added.
  MacOS 10.12 is no longer supported.

* RHEL8 is supported across all toolkits except for the C++ CUDA-enabled toolkits and features.
  **FastROCS TK**, **GPU-Omega TK**, and **GraphSim TK's** CUDA fast fingerprints are not supported.

* C++ CUDA-enabled toolkits and features are not available on Ubuntu18.
  **FastROCS TK**, **GPU-Omega TK**, and **GraphSim TK's** CUDA fast fingerprints are not supported.

* C++ toolkits are now available for GCC 8.x.

* Support for Python 3.8 has been added for all supported platforms.
  Python 3.6 is no longer supported for Windows toolkits.

* Java toolkits are now available for macOS.

* Visual Studio 2019 toolkits are now available for C++ and C#.

* This is the last release to support Ubuntu16.04.  Support for Ubuntu20.04 will be
  added in the next release.

* Memory management in the Java toolkits no longer relies on the JVM to clean up objects.
  The new memory management significantly improves the Java toolkits performance,
  however requires users to manage memory. See :ref:`section_java_best_practices`
  for current best practices.



.. _highlights_2021_Fall:

******************************
Release Highlights 2021.2
******************************

SiteHopper: New Toolkit for Protein Binding Site Comparison
================================================================================

The 2021.2 release introduces **SiteHopper TK**, a new toolkit for searching a database
containing design units for proteins with similar binding sites to a query design unit.
The new **SiteHopper TK** provides toolkit level access to the
**SiteHopper**  application
functionality released in 2021.1.

Besides providing toolkit level access, the 2021.2 release also brings several other
improvements to **SiteHopper**. Efficiency of database building in **SiteHopper** is
enhanced with the use of a multi-threaded approach. Furthermore, search is now possible on the
CPU, enabling cross platform support of the toolkit and application. On Linux machines with
an NVIDIA graphics card, the GPU is used as a pre-screening method, speeding up the
search dramatically. A feature to exclude results based on a similarity threshold has been
added that allows for more diversity in the protein targets with similar binding sites.
The database storage format has also been revised.

An example of a **SiteHopper** produced hit is shown in the figure below. 1UYG is a structure
of human heat shock protein 90-alpha, bound to 8-(2,5-dimethoxy-benzyl)-2-fluoro-9H-purin-6-ylamine.
5IUN is a structure of the DesK-DesR complex, bound to AMP-PCP. The image on the left shows the overlay
of 1UYG (green) and 5UIN (light yellow), zoomed out to show the major structural differences between
the two proteins. The image on the right zooms in on the binding sites, with a surface showing
the type of residues present in each binding site. Blue represents acidic, red represents basic,
yellow represents polar, and white represents non polar. Despite a sequence similarity of only 46%,
1UYG and 5IUN may be targetable by similar ligands, as they have very similar steric and electrostatic
properties in their binding sites.

+------------------------------------------------------+----------------------------------------------------------+
| .. image:: images/2021-Fall/1UYG_5IUN_whole.png      | .. image:: images/2021-Fall/1UYG_5IUN_BSite_Focus.png    |
|   :width: 75%                                        |    :width: 95%                                           |
|   :align: Center                                     |    :align: Center                                        |
|   :alt: View of the entire structures                |    :alt: Zoomed in view on the binding sites             |
+------------------------------------------------------+----------------------------------------------------------+

.. rst-class:: center

**1UYG human hsp 90 (green) overlaid with 5UIN N-formyltransferase (yellow), full struture view (left), binding site view (right).**

SZYBKI: OpenFF-Sage force field support
================================================================================

The latest force field, **Sage**, from the `Open Force Field Initiative <https://openforcefield.org/>`_
has been added to **OEFF TK**, **Szybki TK**, and **SZYBKI**. The major features of the
**Sage** force field are outlined `here <https://openforcefield.org/community/news/general/sage2.0.0-release/.>`_.

New force field parameter classes :ref:`OESageParams <OEMolSmirnoff_OESageParams>` and
:ref:`OEFF14SBSageParams <OEFF_OEFF14SBSageParams>` have been added to the toolkit to support
the **Sage** parameters.  Three new force field classes,
:ref:`OESage <OEMolSmirnoff_OESage>`, :ref:`OEFF14SBSage <OEFF_OEFF14SBSage>`, and
:ref:`OEFF14SBSageComplex <OEFF_OEFF14SBSageComplex>`, have also been introduced.
The **Sage** force field is now the default for free energy analysis of conformation
ensembles with :ref:`OEFreeFormConf <OESz_OEFreeFormConf>`, and the corresponding application **Freeform**.
The protein-ligand forcefield, **FF14SBSage**, is now the default
for protein-ligand optimization in :ref:`OEFixedProteinLigandOptimizer <OESz_OEFixedProteinLigandOptimizer>`
and :ref:`OEFlexProteinLigandOptimizer <OESz_OEFlexProteinLigandOptimizer>`,
:ref:`OptimizeDU`, and :ref:`OptLigandInDU`.

The **Sage** force field can be used in **SZYBKI** for ligand calculations, with
the ``-ff sage_openff2.0.0`` command line option, and for calculations involving proteins using
``-ff ff14sb_sage``.

OEChem: MMCIF and CIF writers
================================================================================

Functionality to write Crystallographic Information Files (CIF and MMCIF) has been added
to the **OEChem TK** in the 2021.2 release. Similar to writing other molecule file
formats in **OEChem TK**, CIF and MMCIF files can be written using the high level
:oe:func:`OEChem::OEWriteMolecule` function. Low level functionality for advanced
users is also provided through a new :oe:func:`OEChem::OEWriteCIFFile` function.

If the molecule does not contain residue information, it is written as a small molecule CIF file
if the data is available to do so (i.e. space group information). If residue information
is available, the writer checks the number of residues and the
molecule is either written as a chemical component dictionary entry
(in the event there is a single residue) or as a macromolecular
CIF file (MMCIF).

The small molecule CIF reader has also been improved for performance and robustness, and
round-tripping these files has been tested and validated using the
`checkCIF <http://checkcif.iucr.org/>`_  facility from
the `International Union of Crystallography (IUCR) <https://www.iucr.org/>`_.
The MMCIF parser based on
`Gemmi <https://gemmi.readthedocs.io/en/latest/>`_ has also been updated, and items parsed from  PDB metadata have been expanded for proper processing of the biomolecules with
**Spruce**.

Supported Platforms
*******************

  ===========  ===============  =====================  ===============================  ====================
  Package      Versions         Linux                  Windows                          macOS
  -----------  ---------------  ---------------------  -------------------------------  --------------------
  Python       3.7, 3.8, 3.9    RHEL7/8, Ubuntu18/20   Win10                            10.14, 10.15, 11
  C++                           RHEL7/8, Ubuntu18/20   Win10 (VS2017, VS2019)           10.14, 10.15, 11
  Java          1.8, 11         RHEL7/8, Ubuntu18/20   Win10                            10.14, 10.15, 11
  C#                                                   Win10 (VS2017, VS2019)
  ===========  ===============  =====================  ===============================  ====================

Related TK Versions
*******************

  ==============  ===========
  Toolkit         Version
  --------------  -----------
  OEChem TK       3.2.0
  OEDepict TK     2.4.7
  OEDocking TK    4.1.1
  FastROCS TK     2.2.1
  OEFF TK         2.4.0
  Grapheme TK     1.4.4
  Graphsim TK     2.5.3
  Lexichem TK     2.7.4
  OEMedChem TK    1.1.5
  MolProp TK      2.5.7
  Omega TK        4.1.2
  Quacpac TK      2.1.3
  Shape TK        3.4.3
  Spicoli TK      1.5.3
  Spruce TK       1.4.0
  Szmap TK        1.6.3
  Szybki TK       2.4.0
  Zap TK          2.4.2
  ==============  ===========

General Notices
***************

* This is the last release to support  macOS 10.14.
  Support for macOS 12 will be added in the next release.

* A gcc 7.3 C++ toolkit package has been added for RHEL7.

* Support for Windows 11 will be added in the next release.



.. _highlights_2021_Spr:

*************************
Release Highlights 2021.1
*************************

OEDocking TK: Receptors in Design Unit
**************************************

:ref:`OEReceptor <OEBio_OEReceptor>` as an integral part of an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`,
with properly prepped structures and contained in an ``OEDU`` file, is fully integrated 
in all workflows. Receptors in an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` can now be created using the
**Make Receptor** GUI application, as well as the **SPRUCE** and **ReceptorInDU** command-line applications.

The **Make Receptor** GUI application has been extended
to be a fully functional DesignUnit builder in addition to building receptors. A new
DesignUnit can be created from a ``PDB/MMCIF`` file (with or without an associated
``MTZ`` file), or by combining molecules from various molecule files of any format.
**SPRUCE** options are exposed through a graphical interface giving
users control over the level of preparation the structure should go through.
Existing receptors, both in ``OEDU`` or ``OEB`` format, can also be opened and edited 
as desired in **Make Receptor**.

:oe:func:`OEDocking::OEMakeReceptor` now automatically detects protein constraints.
The detected protein constraints are kept disabled by default, and can be completely
turned off if desired,
functionality that was previously only available in the **Make Receptor** application.
Both the detected constraints and any custom constraints
can be enabled and edited via the :oe:func:`OEDocking::OEMakeReceptor`
interface, or using commands from :ref:`OEReceptorProteinConstraint <OEBio_OEReceptorProteinConstraint>` and
:ref:`OEReceptorCustomConstraints <OEBio_OEReceptorCustomConstraints>` classes in the toolkit.

.. figure:: /_images/Make_receptor_3TPP.png
   :width: 400pt
   :align: center

   **OEDocking receptor for the 3TPP BACE1 Complexed with Inhibitor with target structure, bound ligand, and a protein constraint. Displayed in the Make Receptor viewer.**

Having the receptors as part of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` with properly prepped structures makes
it easier for the docked and posed structures to be used in further downstream modeling, 
which is especially necessary when working with protein force fields like ``FF14SB``. 
The new receptors with properly prepped protein also enabled use of modern
force fields like ``FF14SB`` and ``Parsley`` for structure optimization
in flexible :ref:`OEPosit <OEDocking_OEPosit>`.

OESiteHopper: Application Suite for Rapid Protein Binding Site Comparison
*************************************************************************

The 2021.1 release introduces **SiteHopper**, which can search a database
containing hundreds of thousands of proteins in a few minutes for
proteins with similar binding sites to a query protein. **SiteHopper** will
output the most similar biomolecules, overlaid by binding site, for visualization
and analysis. A visual representation of the binding site is also output.
**SiteHopper** can also create databases for searching from a series of biomolecular
structures in ``OEDU`` format.

**SiteHopper** finds proteins with similar binding sites which searching by
sequence similarity would overlook. An example is shown in the figure below. 1UYG
is a structure of human heat shock protein 90-alpha, bound to
8-(2,5-dimethoxy-benzyl)-2-fluoro-9H-purin-6-ylamine. 5IUN is a structure of the
DesK-DesR complex, bound to AMP-PCP.

The image on the left shows the overlay of 1UYG (green) and 5UIN (light yellow),
zoomed out to show the major structural differences between the two proteins. The image on the right zooms
in on the binding sites, with a surface showing the type of residues present in each binding site. Blue represents
acidic, red represents basic, yellow represents polar, and white represents non polar.
Despite a sequence similarity of only 46%, 1UYG and 5IUN may be targetable by similar
ligands, as they have very similar steric and electrostatic properties in their
binding sites.

+------------------------------------------------------+---------------------------------------------------------+
| .. image:: images/2021-Spr/1UYG_5IUN_whole.png       | .. image:: images/2021-Spr/1UYG_5IUN_BSite_Focus.png    |
|   :width: 75%                                        |    :width: 95%                                          |
|   :align: Center                                     |    :align: Center                                       |
|   :alt: View of the entire structures                |    :alt: Zoomed in view on the binding sites            |
+------------------------------------------------------+---------------------------------------------------------+

  **1UYG human hsp 90 (green) overlaid with 5UIN N-formyltransferase (yellow), full struture view (left) and binding site view (right).**

VIDA 5: Major Update and OEDesignUnit Support
*********************************************

**VIDA** has undergone major changes including:

    * Upgrade to Python3.

    * Upgrade to Qt5 with PySide2 providing for user-interface improvements.

    * Updated to run on the same platforms as OpenEye Toolkits and Applications.

  This allows us to release **VIDA** along side the toolkits and applications in our twice-yearly releases.

  In addition, **VIDA** now has support for MMCIF files and improvements to I/O from other file format types.
  **VIDA** can also read prepared protein structures in :ref:`OEDesignUnit <OEBio_OEDesignUnit>` format produced
  with **SPRUCE** and **Make Receptor** along with the receptor objects that are now stored on these design units.

.. figure:: /_images/DUReceptorSupport.png
   :align: center

   **VIDA DesignUnit Support with receptors showing the prepared beta-secretase structure 3TPP.**

Supported Platforms
*******************

  ===========  ===============  =====================  ===============================  ====================
  Package      Versions         Linux                  Windows                          macOS
  -----------  ---------------  ---------------------  -------------------------------  --------------------
  Python       3.7, 3.8, 3.9    RHEL7/8, Ubuntu18/20   Win10                            10.14, 10.15, 11
  C++                           RHEL7/8, Ubuntu18/20   Win10 (VS2017, VS2019)           10.14, 10.15, 11
  Java          1.8, 11         RHEL7/8, Ubuntu18/20   Win10                            10.14, 10.15, 11
  C#                                                   Win10 (VS2017, VS2019)
  ===========  ===============  =====================  ===============================  ====================

Related TK Versions
*******************

  ==============  ===========
  Toolkit         Version
  --------------  -----------
  OEChem TK       3.1.1
  OEDepict TK     2.4.6
  OEDocking TK    4.1.0
  FastROCS TK     2.2.0
  OEFF TK         2.3.1
  Grapheme TK     1.4.3
  Graphsim TK     2.5.2
  Lexichem TK     2.7.3
  OEMedChem TK    1.1.4
  MolProp TK      2.5.6
  Omega TK        4.1.0
  Quacpac TK      2.1.2
  Shape TK        3.4.2
  Spicoli TK      1.5.2
  Spruce TK       1.3.0
  Szmap TK        1.6.2
  Szybki TK       2.3.1
  Zap TK          2.4.1
  ==============  ===========

General Notices
***************

* C++ CUDA-enabled toolkits and features are now supported on RHEL8 and Ubuntu20.

* Support for GCC 9.x has been added.
  Support for GCC 4.x and GCC 5.x has been dropped.

* Support for Python 3.6 has been dropped.

* Support for VS2015 has been dropped.

* Support for MacOS 11 has been added. Support for MacOS 10.13 has been dropped.

* OpenEye applications and toolkits have not been optimized for the M1 Mac but run under Rosetta 2.



.. _highlights_2022_Fall:

******************************
Release Highlights 2022.2
******************************

OEToolkits 2022.2.2
===================

The **OEToolkits 2022.2.2** is a bug-fix of the **OEToolkits 2022.2.1** release.

OEToolkits 2022.2.1
===================

MCS based fix during OMEGA Conformer Generation
================================================

The ability to constrain a fragment of the molecules during conformer generation with torsion
driving in :ref:`OMEGA <omega_introduction>` and  the :ref:`OMEGA <omega_part_theory>` toolkit
has been extended to include fixing based on maximum common 
subgraph (MCS) match. In this mode of fixing, the MCS between the template ``fixmol`` and the generated 
molecule is determined, and subsequently that common subgraph portion of the generated molecule is 
fixed to the proved conformer of the ``fixmol``.

The MCS based fixing during conformer generation can be turned on by setting
:oe:meth:`OEConfGen::OEConfFixOptions::SetFixMCS` to ``true`` for use in the 
:ref:`OMEGA <omega_part_theory>` toolkit.  Additional
API points have also been added to allow control during MCS search. A new flag ``-fixMCS`` is
available in the :ref:`OMEGA <omega_introduction>` application to facilitate this.

+------------------------------------------------------+---------------------------------------------------------+
| .. image:: images/2022-Fall/mcs_omega_3vv8.png       | .. image:: images/2022-Fall/mcs_omega_4bfd.png          |
|   :width: 90%                                        |    :width: 90%                                          |
|   :align: Center                                     |    :align: Center                                       |
|   :alt: Conformers for 3VV8_8838                     |    :alt: Conformers for 4BFD_4239                       |
+------------------------------------------------------+---------------------------------------------------------+

  **OMEGA generated conformers for two different molecules, with MCS based fix against a single bound 
  ligand pose. Figure shows that with MCS based fix, two different fragments 
  are fixed during conformer generation of the two different molecules.**

New ShapeFit Algorithm for Pose Prediction
============================================

The algorithm for pose prediction with the :oe:const:`OEDocking::OEPositMethod::SHAPEFIT`
method has been modified. The new algorithm simultaneously optimizes the shape and 
chemical similarity between the fit molecule and bound ligand, and intra-molecular 
force-field energies of the fit molecule. The new simultaneous optimization algorithm 
replaces the previous adiabatic optimization algorithm and is more robust. The new 
algorithm also offers flexibility to use different forcefields and uses the 
:oe:const:`OEFF::OELigandFFType::SAGE` force field by default. Another advantage of the new 
algorithm is that it is capable of producing multiple distinct poses when desired. 
The new algorithm is automatically reflected in both the :ref:`OEPosit <OEDocking_OEPosit>` toolkit
and the :ref:`POSIT <chapter_posit>` application. ``ShapeFit`` is also now available in the
:ref:`OEDocking TK <oedocking_chapter_intro>` as an independent API :ref:`OEShapeFit <OEDocking_OEShapeFit>`.

Cross-docking experiments based on the 22 diverse kinase types presented in
[Tuccinardi-2010]_ shows that ``ShapeFit`` accuracy is unaffected between the
previous and the new algorithm (when accuracy is measured as RMSD <=2.0). 
A balanced cross-docking set of 20,000 points, where points are equally distributed
over the various similarity regions and kinase types, was used. However, we see
clear indication that generating multiple poses helps increase the pose prediction accuracy.
A separate self-docking study based on the highly trustworthy iridium dataset ([Warren-2012]_) 
with 280 ligand-protein structures shows that the new algorithm predicts poses that are
closer to the x-ray crystallographic poses.

+------------------------------------------------------+---------------------------------------------------------+
| .. image:: images/2022-Fall/RMSD_Cross_Docking.png   | .. image:: images/2022-Fall/RMSD_Self_Docking_Inset.png |
|   :width: 90%                                        |    :width: 90%                                          |
|   :align: Center                                     |    :align: Center                                       |
|                                                      |                                                         |
+------------------------------------------------------+---------------------------------------------------------+

**Left: Comparison of ShapeFit accuracy in a cross-docking experiment between the existing and the new algorithm. 
The x-axis shows the tanimotocombo similarity between the ligand and the bound ligand present in protein complex. 
The Y-axis shows the fraction of accurately predicted poses based on being within 2 angstroms of the 
experimental pose. Right: Comparison of ShapeFit accuracy in a self-docking experiment, between the existing and 
the new algorithm. Axes show the RMSD of generated poses with respect to the experimental pose.**

Protein-ligand Optimization with ff14SB forcefield and PB solvent model 
=========================================================================
Protein-ligand Optimization with ``ff14SB-OpenFF`` force field and Poisson-Boltzmann (PB) solvent model 
is now available both in :ref:`SZYBKI <szybki_overview>` and the :ref:`SZYBKI <szybki_part_theory>` toolkit.

In the **SZYBKI TK**, the functionality is available through the :oe:cls:`OESz::OEFixedProteinLigandOptimizer` 
and the :oe:cls:`OESz::OEFlexProteinLigandOptimizer` APIs, and can be enabled by setting 
:oe:const:`OESz::OESolventModel::PB` as the value in :oe:meth:`OESz::OEProteinLigandOptOptions::SetSolventModel`.
In **SZYBKI** both the :ref:`OptLigandInDU` and :ref:`OptimizeDU` applications now accept ``pb`` as value
for ``-solventModel``.

Optimization of 244 highly trustworthy x-ray structures of protein-ligand complexes from the 
iridium dataset ([Warren-2012]_) with and without PB solvation
and with ``ff14SB-Sage`` forcefield shows better accuracy for the optimized ligand poses when PB solvation
is turned on. Accuracy is measured as the RMSD between the crystallographic ligand pose and the optimized
pose. On an average PB solvation optimized structures have an RMSD of 0.31 angstroms, compared to a value of
0.55 angstroms when explicit solvation is not turned on. A paired T-test suggests that the average improvement 
of 0.24 angstroms is statistically significant with a p value of 0.00001.  Turing on the solvation effects also
removes any significant deviations (RMSD > 2 angstroms) of pose, as was seen for a few cases when optimization was
performed in vacuum.

..  figure:: /_images/pb_opt_rmsd.png
    :width: 400pt
    :align: center

    **Comparison of RMSD for Flexible protein-ligand optimization of x-ray structures with
    and without PB solvation and with ff14SB-Sage forcefield.**

New **BROOD** Fragment Databases
==================================

Two new :ref:`BROOD <brood_introduction>` fragment databases, ``brood-database-ChEMBL31`` and ``brood-database-ChEMBL31_lite``, 
built from the latest version of ChEMBL, have been generated and are made available. The 
``brood-database-ChEMBL31`` contains all possible fragments up to 3 attachment points, whereas
the ``brood-database-ChEMBL31_lite`` is curated to prioritize fragments with medicinal relevance.

Limited validation, with 29 different queries across 14 molecules, shows that the number of hits of
druglike molecules obtained from the new databases are within 1% of those generated from the existing 
database ``brood-database-chembl-3.0.0``, when a maximum of 1000 hits are requested.  Comparison of 
belief score, a measure of potential activity of the generated hits, also shows that the hits generated 
from the new databases are at least as good as those generated from the existing database.

+------------------------------------------------------+---------------------------------------------------------+
| .. image:: images/2022-Fall/filtered_molecules.png   | .. image:: images/2022-Fall/Belief_score_lineplot.png   |
|   :width: 90%                                        |    :width: 90%                                          |
|   :align: Center                                     |    :align: Center                                       |
|                                                      |                                                         |
+------------------------------------------------------+---------------------------------------------------------+

**Left: Comparison of the number of hits of druglike molecules using the brood-database-chembl-3.0.0 (ChEMBL20),
brood-database-ChEMBL31 (ChEMBL31) and brood-database-ChEMBL31_lite (ChEMBL31_lite) fragment databases. Right: 
Comparison of the belief score distribution of all the hits generated using the ChEMBL20, ChEMBL31 and 
ChEMBL31_lite fragment databases.** 

Supported Platforms
*******************

  ===========  ===================  ===========================   ===============================  ====================
  Package      Versions             Linux                         Windows                          macOS
  -----------  -------------------  ---------------------------   -------------------------------  --------------------
  Python       3.7, 3.8, 3.9, 3.10  RHEL7/8, Ubuntu20/20-ARM/22   Win10/11                         11, 12
  C++                               RHEL7/8, Ubuntu20/20-ARM/22   Win10/11 (VS2017/19/22)          11, 12
  Java         1.8, 11              RHEL7/8, Ubuntu20/20-ARM/22   Win10/11                         11, 12
  C#                                                              Win10/11 (VS2017/19/22)
  ===========  ===================  ===========================   ===============================  ====================

Related TK Versions
*******************

  ==============  ===========
  Toolkit         Version
  --------------  -----------
  OEChem TK       3.3.1
  OEDepict TK     2.5.2
  OEDocking TK    4.2.0
  FastROCS TK     2.2.3
  OEFF TK         2.5.1
  Grapheme TK     1.4.6
  Graphsim TK     2.5.5
  Lexichem TK     2.8.0
  OEMedChem TK    1.1.7
  MolProp TK      2.6.1
  Omega TK        4.2.1
  Quacpac TK      2.2.1
  Shape TK        3.5.1
  Spicoli TK      1.5.5
  Spruce TK       1.5.1
  Szmap TK        1.6.5
  Szybki TK       2.5.1
  Zap TK          2.4.4
  ==============  ===========

General Notices
***************

* Support for macOS 12 has been added.  

* This is the last release to support macOS 11. Support for macOS 13 will be added in the next release.

* Support for Ubuntu22 has been added.  Support for Ubuntu18 has been dropped.

* This is the last release to support RHEL7.  Support for RHEL9 will be added in the next release.

* This is the last release to support Visual Studio 2017 and Visual Studio 2019.

:ref:`The detailed release notes consist of these highlights plus the individual release notes and the release history <release_notes_index>`.


.. _highlights_2022_Spring:

******************************
Release Highlights 2022.1
******************************

Enhanced Stereo Information Support
====================================

The 2022.1 release adds support for enhanced stereochemistry designations in molecules, 
defining relationships between stereocenters. Enhanced stereochemistry
information on any molecule is honored by :oe:meth:`OEFlipper<OEConfGen::OEFlipper>`
during stereo enumeration when asked to do so by setting appropriate options. Enhanced 
stereochemistry support has also been extended to both the :ref:`OMEGA <chapter_omega>` and
the :ref:`chapter_flipper` applications.

Support for :term:`CXSMILES` as a valid molecular input format via
:oe:const:`OEChem::OEFormat::CXSMILES` has been added.  :term:`CXSMILES` is specifically 
intended to support the import of `Enamine <https://enamine.net>`_ download structure files 
containing enhanced stereochemistry designations. While many other features are possibly 
provided in the :term:`CXSMILES` appendix information, only the enhanced stereochemistry group 
information is supported at this time.   Please contact support@eyesopen.com with specific needs 
for additional :term:`CXSMILES` features to allow prioritization in future releases.

**OMEGA** and **Flipper** applications can now accept molecule files in :term:`CXSMILES` format.

.. figure:: /_images/enhanced_stereo.png
   :width: 200pt
   :align: center

   **Molecule with enhanced stereo designation. The molecule has 16 stereoisomers when
   stereocenters are treated independently and only 4 stereoisomers when the
   enhanced stereo is enabled.**

Sheffield Solvation Model for Proteins
=======================================

The simple two parameter Sheffield Solvation Model, as introduced by Grant et al. (\ [Grant-2007]_ \)
for calculating the electrostatic component of molecular solvation energy, is a semi-empirical model
that performs well for small molecules and requires few computational resources. This model does
not work well for macromolecules like proteins and complexes, where many of the atoms are hidden or
only partially exposed to the solvent.

A modified three parameter Sheffield Solvation Model is parameterized and implemented in this release,
where solvent exposure is treated by correcting the effective atomic radii with the introduction of
a third additional parameter. The new model is available as part of the 
:oe:cls:`OESheff::OESheffield` API in the **OEFF toolkit**. The model is also available for use
through the :oe:cls:`OESz::OEFixedProteinLigandOptimizer` and the 
:oe:cls:`OESz::OEFlexProteinLigandOptimizer` APIs in the **SZYBKI toolkit**, and the :ref:`OptLigandInDU`
and :ref:`OptimizeDU` applications in **SZYBKI**.

Electrostatic solvation energies for protein conformers are calculated using both the new Sheffield
Solvation Model and the Poisson–Boltzmann (PB) model, and the difference in solvation energies between 
conformers of the same protein is compared between the two models. A set of 232 NMR proteins and peptide 
structures were used for this study that produced 41491 solvation energy differences between pairs of 
conformations. The results are compared in the image below.

.. figure:: /_images/protein_confs_sheffield_pb.png
   :width: 600pt
   :align: center

   **Comparison between Sheffield and PB of differential electrostatic solvation energies between protein conformers.**

Spruce Filter and Design Unit Validation
=========================================

New functionality for preprocessing inputs and validation of the
output ``Design Units`` has been added to **Spruce TK** in the form of two preliminary API classes :oe:cls:`OESpruce::OESpruceFilter` and 
:oe:cls:`OESpruce::OEValidateDesignUnit`.
These classes are also used by the **SPRUCE** application to check and fix, if possible, inputs and to validate the resulting outputs.

:oe:cls:`OESpruce::OESpruceFilter` performs a standardization and a filter check structures to use before prepping
this structure in **SPRUCE**. It automatically checks and fixes invalid component names, invalid residue 
states,and  invalid metal bonds. It also checks for invalid CRYST1 from the header file, low overlap between 
the electron density map and the structure, invalid sequence alignment, blank chain IDs, and invalid
alternate locations. If the structure does not pass these tests, Spruce Filter will fail the structure.

The :oe:cls:`OESpruce::OEValidateDesignUnit` function performs a check on the design units generated by 
**SPRUCE**. It will report if the provided DU contains partial side chains, missing loops, implicit 
hydrogens, incorrect partial charges, termini that are not capped properly, heavy atoms overlapping 
with each other, and broken chains.

Multistate Heuristic pKa Model
===============================

The multistate heuristic pKa model is an extension of the existing pKa model in **OpenEye** software. 
The existing model generates only one probable ionization state based on pKa estimated from 
about 80 rules. With the development of this multistate pKa model, we are enhancing the 
implementation with many more unique functional patterns in the form of pKa rules, identified 
from OpenEye's internal pKa database, allowing generation of all ionization states possible 
at physiological pH.

The model described herein uses SMARTS-based heuristics to assess the pKa of acidic or basic
functional groups of molecules. For all atoms of a query molecule, pKa is assessed as it belongs 
to one of three classes: Acidic (pKa < 6.4), Basic (pKa > 8.4), and Neutral (6.4 < pKa < 8.4). 
According to the assessed pKa class for each atom, it is either ionized and/or un-ionized at
pH 7.4. Any group with Acidic or Basic pKa range will result in one state, ionized or un-ionized 
and a group with Neutral pKa range will result in both states, ionized and un-ionized. Based 
on how many such functional groups there are in the molecule, and how many states are generated 
for them, multiple molecules can be generated for all possible combinations of all possible 
ionization states of acid/base groups.

The multistate heuristic pKa model is currently only available in **Quacpac TK** as preliminary
API classes :oe:cls:`OEProton::OEMultistatepKaModel` and :oe:cls:`OEProton::OEMultistatepKaModelOptions`.

Supported Platforms
*******************

  ===========  ===================  ===========================   ===============================  ====================
  Package      Versions             Linux                         Windows                          macOS
  -----------  -------------------  ---------------------------   -------------------------------  --------------------
  Python       3.7, 3.8, 3.9, 3.10  RHEL7/8, Ubuntu18/20/20-ARM   Win10/11                         10.15, 11, 12
  C++                               RHEL7/8, Ubuntu18/20/20-ARM   Win10/11 (VS2017/19/22)          10.15, 11, 12
  Java         1.8, 11              RHEL7/8, Ubuntu18/20/20-ARM   Win10/11                         10.15, 11, 12
  C#                                                              Win10/11 (VS2017/19/22)
  ===========  ===================  ===========================   ===============================  ====================

Related TK Versions
*******************

  ==============  ===========
  Toolkit         Version
  --------------  -----------
  OEChem TK       3.3.0
  OEDepict TK     2.5.0
  OEDocking TK    4.1.2
  FastROCS TK     2.2.2
  OEFF TK         2.5.0
  Grapheme TK     1.4.5
  Graphsim TK     2.5.4
  Lexichem TK     2.7.5
  OEMedChem TK    1.1.6
  MolProp TK      2.6.0
  Omega TK        4.2.0
  Quacpac TK      2.2.0
  Shape TK        3.5.0
  Spicoli TK      1.5.4
  Spruce TK       1.5.0
  Szmap TK        1.6.4
  Szybki TK       2.5.0
  Zap TK          2.4.3
  ==============  ===========

General Notices
***************

* Support for macOS 12 has been added. macOS 10.14 is no longer supported.

* This is the last release to support macOS 10.15.

* A GCC 7.3 C++ toolkit package has been added for RHEL7.

* Support for Windows 11 has been added.

* Support for Visual Studio 2022 has been added.

* Support for Apple M1 architecture has been added for C++ and Python toolkits.

* Support for Linux ARM architectures has been added.

* This is the last release to support Ubuntu 18.04. Support for Ubuntu 22.04 will be added in the next release.

For detailed release notes, see :ref:`Version 2022.1.0 Release Notes <release_notes_index>`.


.. _highlights_2023_Spring:

********************
OEToolkits 2023.1
********************

OEToolkits 2023.1.1
===================

The **OEToolkits 2023.1.1** is a bug-fix of the **OEToolkits 2023.1.0** release.

  * :ref:`section_oeff_releasenotes_2521`
  * :ref:`section_szybki_releasenotes_2601`

OEToolkits 2023.1.0
===================

Release Highlights
******************

..  raw:: html

    <!-- The script tag should live in the head of your page if at all possible -->
    <script type="text/javascript" async src="https://play.vidyard.com/embed/v4.js"></script>
    <!-- Put this wherever you would like your player to appear -->
    <img
      style="width: 100%; margin: auto; display: block; max-width: 600px;"
      class="vidyard-player-embed"
      src="https://play.vidyard.com/haNztpX3JmqF3A35LkYyVZ.jpg"
      data-uuid="haNztpX3JmqF3A35LkYyVZ"
      data-v="4"
      data-type="inline"
      data-width="600"
    />

..  _supported-platforms-spr-2023:

Supported Platforms
*******************

  ===========  ===================  ===========================   ===============================  =====================
  Package      Versions             Linux                         Windows                          macOS (x64 and arm64)
  -----------  -------------------  ---------------------------   -------------------------------  ---------------------
  Python       3.9, 3.10, 3.11      RHEL8/9, Ubuntu20/20-ARM/22   Win10/11 [no python 3.11]        12, 13
  C++                               RHEL8/9, Ubuntu20/20-ARM/22   Win10/11 (VS2017/19/22)          12, 13
  Java         8, 11                RHEL8/9, Ubuntu20/20-ARM/22   Win10/11                         12, 13
  C#                                                              Win10/11 (VS2017/19/22)
  ===========  ===================  ===========================   ===============================  =====================

Related TK Versions
*******************

  ==============  ===========
  Toolkit         Version
  --------------  -----------
  OEChem TK       3.4.0
  OEDepict TK     2.5.2
  OEDocking TK    4.2.1
  FastROCS TK     2.2.4
  OEFF TK         2.5.2
  Grapheme TK     1.4.7
  Graphsim TK     2.5.6
  Lexichem TK     2.8.1
  OEMedChem TK    1.2.0
  MolProp TK      2.6.2
  Omega TK        4.2.2
  Quacpac TK      2.2.2
  Shape TK        3.6.0
  Spicoli TK      1.5.6
  Spruce TK       1.5.2
  Szmap TK        1.6.6
  Szybki TK       2.6.0
  Zap TK          2.4.5
  ==============  ===========

General Notices
==================



************
Introduction
************

The OpenEye Toolkits are programming libraries that provide computational building
blocks for solving specific programming problems as well as general methods
that can be customized to create innovative new tools and workflows.
OpenEye Toolkits provide technologies to solve a wide range of
cheminformatics and molecular modeling problems.

.. figure:: common/images/toolkits.*
   :align:  center
   :width:  400pt

   **OpenEye Toolkits**

Toolkit API
***********

OpenEye Toolkits are delivered as :term:`APIs` (Application Programming Interfaces) for four supported languages: C++,
Python, Java, and C#.  The APIs are stable between versions and across
platforms. This allows users to write toolkit programs that will be viable
for many years.  New toolkit releases often include bug fixes and performance
improvements to core functionality.  Users can recompile against newer
versions of the toolkits to gain the benefits of the improvements to the core
functionality.

In order to accelerate the delivery of new technologies, new programming APIs
may be released as Preliminary APIs.  A :term:`Preliminary API` is a set of
new functionality that has been fully tested but may have limited
real-world use.  In that case, it is valuable to collect feedback about
the usability of the functionality before committing to a final, immutable
API design.  Preliminary APIs may change based on this user feedback; they
will become stable after 2 or 3 release cycles.  Preliminary APIs will
sometimes be made available on a subset of supported languages and platforms.

.. figure:: common/images/toolkits-API.*
   :align:  center
   :width:  400pt

   **Scheme of delivering OpenEye Toolkit API**

:term:`Stable API`
 Toolkits that have been fully developed, documented, and tested are
 considered stable.  The API definitions for these toolkits will be
 consistent across languages and platforms and will not change between
 toolkit releases.

 Code written with earlier versions of the toolkit will compile and
 run with newer versions. This allows users to easily upgrade
 to newer versions without worrying about breaking legacy code.

:term:`Preliminary API`
 APIs that are still under development might be delivered and marked as
 preliminary. Providing early access means that the APIs can be improved
 based on user feedback before committing to a final API design.
 Preliminary APIs will sometimes be made available for a limited set of
 platforms and languages.  They are marked as follows:

 .. attention::

    **PRELIMINARY API**. This is a Preliminary API and may be
    improved based on user feedback. It is currently available in C++
    and Python.

 The label will generally include the timeline for full release of the
 API and any platform or language limitations.

.. _chapter_release_cycle:

Release Cycle
*************

Beginning in 2026, feature release for OpenEye Toolkits are delivered
two times per year, in Summer and Winter. Intermediate bug fix releases are
done to fix critical issues if necessary. Both types of releases will be
available in all supported languages and on all supported platforms.

Packages are versioned as ``<year>.<release#>.<build#>``.
For example, ``2026.1.0`` represents the first  build of the first released
version in 2026.

:term:`Feature release`
 These releases provide support for new platforms and major and minor
 code fixes, as well as new features.

:term:`Bug-fix release`
 The *bug-fix*  releases happen between features releases, if necessary.
 These releases provide crucial bug fixes but no new features or platform
 updates.

.. figure:: /_images/ReleaseCycleImage.png
   :align:  center
   :width:  250pt

   **OpenEye Toolkits release cycle**



:orphan:

.. _section_java_getting_started:

***********************************
Getting Started with OpenEye Java
***********************************

.. toctree::
   :maxdepth: 2

   license
   install
   maven
   eclipse
   IDEA
   commandline
   customjar
   tkimport
   include-from-theme-in-tk



******************************
License for OpenEye Toolkits
******************************

.. |product_type| replace:: toolkit

A license file from OpenEye, Cadence Molecular Sciences is required to run any OpenEye
|product_type|. A license file can be requested/obtained by contacting OpenEye
(https://www.eyesopen.com/contact).

At startup, the |product_type| looks for a valid license in the following default
locations:

* In a file specified by the environment variable :envvar:`OE_LICENSE`.  Example commands to set
  the environment variable:

  * Linux/UNIX and MacOS:

    ``export OE_LICENSE=/home/USERNAME/oe_license.txt``

    This can be executed in a shell prompt, or added to the user's ``~/.bash_profile``.
    If running `zsh`,  add to the user's ``.bash_profile`` and then include ``.bash_profile``
    in the user's ``.zshrc``.

  * Microsoft Windows:

    ``setx OE_LICENSE C:\Users\USERNAME\oe_license.txt`` to set the environment variable permanently using Command Prompt, or
    ``SET OE_LICENSE=C:\Users\USERNAME\oe_license.txt`` to set for the duration of the session using Command Prompt.
    ``$env:OE_LICENSE="C:\Users\USERNAME\oe_license.txt"`` to set the environment variable using PowerShell.

* In a file named ``oe_license.txt`` in the directory specified by the
  environment variable :envvar:`OE_DIR`.

* In a file named ``oe_license.txt`` in the user's platform-specific local
  OpenEye application data directory. The location of this directory is
  detailed below:

  * Linux/UNIX:

    ``~USERNAME/.OpenEye``

  * MacOS:

    ``/Users/USERNAME/Library/OpenEye`` or ``~USERNAME``

  * Microsoft Windows:

    ``C:\Users\USERNAME\AppData\Local\OpenEye``

* In a file named ``oe_license.txt`` in the current working directory






Introduction
==============

The Java version of the OpenEye Toolkits is a JNI (Java Native Interface)
wrapper created using SWIG. It is important to note that this is not a new
version of the toolkits written in Java nor is it a Java interpretation of the
toolkit API, but a rather faithful reproduction of the toolkit API in Java. As
such there are some features that might not be as Java-like as a toolkit
written entirely in Java, but most of these are minor issues and consistency
with all the supported languages makes translation from one to another
relatively easy and greatly enhances our ability to support all the language
versions.

A few of these idiomatic differences include:

* There are relatively few classes in OEChem and they have a rather
  shallow inheritance hierarchy.

* Most OEChem algorithms are in C++ free functions. These are
  mapped to static methods in the class `oechem`.

* Method names in most **OEChem TK** classes start with uppercase
  letters.

* Java doesn't support operator overloading, so C++ operators are
  mapped to methods. For example, operator bool() is mapped to a
  member function called IsValid(), operator() is mapped to call()
  and operator() const is mapped to constCall().

* Java doesn't support direct access to class attributes, so for
  some simple C++ classes and structs, direct access is mapped to a
  get/set pair of functions.

* Calling close() is required for all objects that provide a close()
  method.

* delete() should be explicitly called on all objects that come from
  the following toolkits:

  - Grid TK
  - Shape TK
  - Szybki TK
  - Zap TK

  The user should interact with these particular libraries from only a
  single Java thread. Failing to do so can lead to subtle race
  conditions.

* There is a known bug concerning OpenEye constants that occurs when compiling
  against an older version of the OpenEye jar and running against a newer
  version of the OpenEye jar. Please make sure to run against java programs
  against the same version it was compiled with.

A Java version of the toolkits allows integration into Java desktop and
server-side applications. However, the Java toolkits are not necessarily
suited for applet programming since they require native code and platform-
specific shared libraries. This can be achieved by building  a multi-platform
JAR as described in the final section, but this is considered for experts
only.

.. note::

   In general, due to the wrapping of native code, using explicit
   ``obj.delete()`` calls on class instances obtained from any toolkit
   is highly recommended as it minimizes issues with early or delayed
   deletion activity by the Java garbage collector on OpenEye class instances.

.. _java_prerequisites:

Prerequisites
=============

In order to use the OpenEye Java toolkits, a compatible version of the Java
SDK must be installed. For the most part, this means installing a version
of OpenJDK8, OpenJDK11, or OpenJDK21.  See https://openjdk.org/
for your platform.

Linux installation also requires the zlib and libcairo libraries be available. These
are usually available on Desktop Linux installations by default, but
may not be available on Linux server installations.

Platform Support
----------------

OpenEye's support of operating systems changes from the time to time, with older systems
retired and newer ones validated.
For the current set of :ref:`supported platforms, see the current release notes <supported-tk-platforms-fall-2025>`.

Additional software requirements are spelled out in the following sections.

Java Versions
-------------

* `OpenJDK8 <https://openjdk.java.net/projects/jdk8/>`_ 

* `OpenJDK11  <https://openjdk.java.net/projects/jdk/11/>`_ 

* `OpenJDK21  <https://openjdk.java.net/projects/jdk/21/>`_ 

.. _java_gpu_prerequisites:

GPU Prerequisites
=================


GPU-Related Requirements
========================

The following features are required in order to use GPU-accelerated OpenEye toolkits and applications.


Supported Platforms
-------------------

CUDA-enabled OpenEye software is only available on supported Linux platforms.
For supported Linux platforms see the `Platform Support Page <https://www.eyesopen.com/supported-platforms>`_.


Supported GPUs
-------------------

An NVIDIA `Tesla <http://www.nvidia.com/object/tesla-supercomputing-solutions.html>`_,
`Quadro <http://www.nvidia.com/object/workstation-solutions.html>`_, or
`GeForce <http://www.nvidia.com/object/geforce_family.html>`_ GPU with a **compute capability of 3.5
or higher** is required on your system. For a comprehensive table of compute capability
categories for each GPU, please refer to the `CUDA <https://en.wikipedia.org/wiki/CUDA>`_ Wikipedia page.


NVIDIA Drivers
-------------------

* **Minimum NVIDIA Driver version: 450.x**.

* CUDA is **not** required to be installed.

We recommend driver `450.80.02 <https://www.nvidia.com/Download/driverResults.aspx/165294/en-us>`_, and
we strongly advise manually downloading and installing the appropriate NVIDIA driver
for your system as opposed to using a package manager.

To install, root privilege is required. Follow these steps:

  #. Download the driver to the machine you are installing it on.
  #. ``chmod +x`` the driver package to make it executable.
  #. Ensure you have disabled X-server by killing any running sessions.
     Reboot may be required if X-server is still running after this step.
     
     .. warning::

        Disabling X-server requires different processes to be killed depending on your Linux
        distribution.
        See the `NVIDIA installation guide
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_ for more details.

     .. warning::

        The NVIDIA kernel module can often conflict with the open source
        Nouveau display drivers, depending on your specific Linux
        distribution. The NVIDIA documentation is a much more complete
        and up-to-date source for information on how to work around this issue.
        See `Disabling Nouveau
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile-nouveau>`_ on the NVIDIA website.

  #. Install the driver by ``sudo ./NVIDIA-Linux-x86_64-450.80.02.run`` and follow the step-by-step installation instructions.

  For more details on driver installations, see the `CUDA Installation Guide
  <https://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_

.. note::

  The output of the ``nvidia-smi`` command is extremely useful when
  debugging GPU issues. Please include the output from
  ``nvidia-smi`` in any request to support@eyesopen.com.


Performance Tuning
-------------------

To get the most performance out of an NVIDIA graphics card, use the persistence daemon to switch persistence mode
across all cards on the system (root privilege required)::

  sudo nvidia-persistenced --user foo

This will automatically enable persistence mode after reboot.

For full instructions on the persistence daemon, see the `Persistence daemon section
<https://docs.nvidia.com/deploy/driver-persistence/index.html#persistence-daemon>`_ of the NVIDIA docs.

Download the OpenEye Java distribution
======================================

Picking a distribution is relatively easy. For each platform (Windows, Linux,
and macOS), we only have 1 download, a 64-bit version (x64).

Download from http://www.eyesopen.com/downloads.

Installation
=============

Untar or unzip the distribution into a directory of your choice. This will create the following structure::

   OpenEye-Java-|pkgversion|-OSName-xArch/
       docs/
       lib/
          oejava-|pkgversion|-OSName-xArch.jar
       verify/
          verify.py
       examples/
          build.xml
          openeye/
             examples/
             docexamples/

.. warning::

   For Windows, the distribution should be unzipped to a directory with a short
   pathname, so the longest directory pathname in the tree can be specified in
   less than 260 characters. Otherwise, one may see errors when running the
   verify.py mentioned below due to the 260 character maximum path limit in Windows.

.. warning::

   For Windows, please note that spaces in the path names to the distribution, `ant` or `java` may cause errors with building and running examples. 
   Please install these items in a location that does not contain spaces in the path name.

All the examples are found in the examples directory. Use ant to compile the examples jar then you can run an OEChem example using:

For Linux/macOS::

   cd OpenEye-Java-|pkgversion|-OSName-xArch/examples
   ant
   java -cp ../lib/oejava-|pkgversion|-Linux-x64.jar:openeye.examples.jar openeye.examples.oechem.OEChemInfo

For Windows, note the use of semi-colon instead of a colon in the class path argument::

   cd OpenEye-Java-|pkgversion|-OSName-xArch/examples
   ant
   java -cp ../lib/oejava-|pkgversion|-Windows-x64.jar;openeye.examples.jar openeye.examples.oechem.OEChemInfo

The verify.py script can also be run to ensure a properly working
distribution in the current environment.
If there are problems with the distribution or
environment the script will fail.  To run verify.py::

   cd OpenEye-Java-|pkgversion|-OSName-xArch/verify
   python verify.py

.. note::
   If an error similar to ``java.lang.OutOfMemoryError: Java heap space``
   occurs, one can increase the heap size of the JVM using the 'JAVAFLAGS'
   environment variable.  The '-Xmx' option controls the size of Java heap
   used.   For example, add ``export JAVAFLAGS=-Xmx4G`` in bash, and then
   rerun verify.py.


Using Apache Maven with OpenEye
===============================

.. _5 Minute Guide: http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html

.. _Getting Started Guide: http://maven.apache.org/guides/getting-started/

Maven is a tool that manages Java projects. In addition to other features, it enforces
requirements, manages dependencies, and defines artifact creation. This guide explains how to
use Maven With OpenEye jars.  To get familiar with Maven, please read the `5 Minute Guide`_
and the `Getting Started Guide`_.  The rest of this article assumes that Java
and Maven are installed and working.  It will be helpful to follow the sample
HelloMaven project, available at https://github.com/oess/HelloMaven, while
reading this guide.

Requirements
------------

.. _1.6: http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase6-419409.html

.. _1.7: http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html

.. _1.8: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

.. _3.3: http://maven.apache.org/download.cgi

.. _Git: http://git-scm.com/downloads

* Java x64: 1.6_, 1.7_, 1.8_
* Maven: 3.3_

Creating a Maven Project
------------------------

To create a new Maven project, the first step is to generate the layout.

.. code-block:: bash

   mvn archetype:generate -DarchetypeArtifactId="maven-archetype-quickstart" \
                           -DgroupId="com.user" \
                           -DartifactId=HelloMaven \
                           -Dversion="1.0-alpha" \
                           -DinteractiveMode=false

.. _package prefix: http://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html

The command above creates a new project called *HelloMaven* using a predefined
layout *maven-archetype-quickstart*. Maven has several predefined project layouts.
For example, an archetypeArtifactId of "maven-archetype-webapp" will
generate a layout for creating servlets. The layout in this example creates a
basic jar. *groupId* defines the `package prefix`_. Here, it is "com.user", but this
should be tailored to your company. For example: com.eyesopen.

Executing the ``mvn archetype:generate..`` command above creates a directory
with structure a like this::

   ./HelloMaven/src/main/java/com/user/App.java
   ./HelloMaven/src/test/java/com/user/AppTest.java
   ./HelloMaven/pom.xml

Using OpenEye Artifacts
-----------------------

Now that the project has been created, the next step is to tell Maven how to find the
OpenEye jars. Two pieces of information are required: the repository
server and the dependency definition; this information needs to be
added to the *pom.xml*.

.. rubric:: OpenEye Maven Repository

Add the following XML inside a ``<repositories>`` block.

.. code-block:: xml

   <repository>
      <id>openeye</id>
      <name>openeye-releases</name>
      <url>http://openeye.artifactoryonline.com/openeye/releases2</url>
   </repository>

.. rubric:: OpenEye Maven Dependency

Add the following XML inside a ``<dependencies>`` block.

.. code-block:: xml

   <dependency>
      <groupId>com.openeye</groupId>
      <artifactId>oejava</artifactId>
      <version>2015.Oct.1</version>
      <classifier>${oe.platform}-x64</classifier>
   </dependency>

Note that ``${oe.platform}`` is a property and may be defined as one of these
values:

   * Windows
   * Linux
   * macOS

The examples below define it as ``Linux``.

Finding Available OpenEye Versions
----------------------------------

The dependency above uses the 2015.Oct.1 version of OpenEye Jars.
Other versions are available and are listed in our Maven hosting site:

   https://openeye.jfrog.io/ui/repos/tree/General/releases2

Using OpenEye in HelloMaven
---------------------------

After defining the repository and dependency, the next step is to edit *App.java* and use
an OpenEye API.  In this example, *App.java* is modified to display the OEChem version.

.. code-block:: java

   package com.user;
   import openeye.oechem.*;

   public class App {
       public static void main(String[] args) {
           System.out.println("OEChem Version: " + oechem.OEChemGetRelease());
       }
   }

If everything is set up correctly, compiling should be easy..

Using Maven to Compile and Run
------------------------------

The following command will produce a jar in the ``target`` directory in HelloMaven:

.. code-block:: bash

   cd HelloMaven
   mvn package -Doe.platform=Linux

To run the application:

.. code-block:: bash

   mvn -q exec:java -Doe.platform=Linux -Dexec.mainClass="com.user.App"
   OEChem Version: 2.0.3

Thoughts
--------

A Maven project has several benefits.  Two stand out from this example.  First,
the dependencies are explicit and versioned.  This creates a standard
development environment for all developers working on the project.  It also
means that repeatable and reliable development environments can be tracked
with source code management.

The second benefit is that testing new versions of OpenEye jars is now simple:
change the version tag in the dependency definition and recompile.

Conclusion
----------

Maven makes managing dependencies very easy once established.
Maven has a mature and rich set of plug-ins for any project task.
Maven is also the industry best practice for Java projects.  The HelloMaven
example and more complex examples can be found on https://github.com/oess.

Having trouble getting started?  Contact support@eyesopen.com.


How to Develop with the OpenEye Java Toolkit in IntellJ IDEA
=============================================================

IntelliJ IDEA is a Java IDE available `from JetBrains <https://www.jetbrains.com/idea/>`_.
See the JetBrains site for downloads and installation instructions. IDEA is available on multiple
platforms.  The macOS version is used in this guide.

Creating a New Project
----------------------

IDEA creates *projects*, which consist of *modules*.
To create a new IDEA project, select ``File/New/Project..``, displaying the ``New Project``
dialog.

.. figure:: /_images/IDEA_IntelliJ_Project.png

   **New Project in IDEA**

Select ``IntelliJ`` as the build system, for this simple example. Then click ``Create``.

Next, you need to add the OpenEye JAR to the environment.  The
OpenEye Java toolkit is added as a "project" library.

Select ``File/Project Structure..``, and select ``Libraries``. The ``Project Structure`` dialog
should look like the picture.

.. figure:: /_images/IDEA_project_structure.png

   **Preparing to Add the OpenEye Toolkit to the Environment**

Select the ``+`` button to add a library, select ``Java``, and navigate to the location
containing the OpenEye JAR files. The picture here shows the selection of
the JAR files in the OpenEye ``lib`` subdirectory.

.. figure:: /_images/IDEA_library_selection.png

   **Selecting the OpenEye JARs**

Select ``Open`` to confirm the selection.  Click ``OK`` to add these files as  external libraries.  You should now be able
to import software from these libraries in Java classes, as in ``import openeye.oechem.*;``.

Create a Package and a Class
-----------------------------

Next we need to add a Java class to hold our sample code. Right-click on the ``src`` folder in the
``Project`` pane, and select ``New/Java Class``.  Be sure you have the ``src`` folder selected when you right-click.

.. figure:: /_images/IDEA_new_class.png

   **Adding a New Class**

For the name, enter ``com.example.oechem.Example1``. This will add the new package and new class in the editor, ready for your code.

Near the top of the file, add the import for oechem.

.. code-block:: java

   import openeye.oechem.*;

Then add our sample code inside the class.

.. code-block:: java

   public static void main(String[] args) {
       OEGraphMol mol = new OEGraphMol();
       oechem.OEParseSmiles(mol, "c1ccccc1CCCBr");
       System.out.format("mol has %d atoms\n", mol.NumAtoms());
   }

When you are finished, your sample should look like the figure.

.. figure:: /_images/IDEA_editing.png

   **Editing in IDEA**

Running Our Example inside IDEA
----------------------------------

We can now run our program in IDEA. In the toolbar,
click the "Run" button as shown in the figure.

.. figure:: /_images/IDEA_run.png

   **Running Our Example in IDEA**

This should produce some output in the ``Run`` window, as shown in the figure.

.. figure:: /_images/IDEA_Console_Output.png

   **Output from Our Example**

And now you've created your first OEChem Java sample. You can now
add code and continue to run inside IDEA to try out more of the
OEChem API.

Creating an Executable JAR
--------------------------

At some point, you may want to run your example outside of IDEA,
or you may want to deploy the application to another machine. An easy
tool for this purpose is an ``Artifacts`` option built into IDEA.

Create an Artifact Configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To create a standalone JAR executable, select ``File/Project Structure``. Click ``Artifacts``, click ``+``, choose
``JAR``, and select ``From modules with dependencies...``.

.. figure:: /_images/IDEA_artifacts.png

   **Preparing to Create a JAR**

Then in the next dialogs:

   * Select the main class (``Example1`` in our example). (You can click the folder icon to browse files in the project.)
   * Make your choice about how libraries should be packaged.
   * Click ``OK``.

.. figure:: /_images/IDEA_create_JAR_from_modules.png

   **Create a JAR from a Module**

Create a Run Configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Build the artifact you just created, with the ``Build/Build Artifacts...`` command.

..  figure:: /_images/IDEA_build_artifact.png

You can see the finished artifact in the ``out`` subdirectory in the project.

..  figure:: /_images/IDEA_finished_artifact.png

    A Finished JAR Artifact

Now build a configuration to run the JAR as an application.   IDEA uses configurations of this kind to run and
to debug programs.  Select the command ``Run/Edit Configurations...``.  Click the ``+`` button and select
``JAR Application``.   Name the application, and, in the ``Path to JAR`` field, enter the path to the JAR file on your
computer.   In the ``Before launch`` area, click ``+`` and select ``Build Artifacts`` and your JAR application.  This
means that the JAR is built every time you execute this run configuration.  Learn more about run configurations in the
IDEA documentation.

When you are finished entering the information, your screen should like like the figure.

..  figure::   /_images/IDEA_run_confi.png

    A Run Configuration for a JAR Application

Run the Application with the Run Configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now you can use the drop-down at the top of the screen to execute the JAR application via the run configuration
you just created.

..  figure:: /_images/IDEA_exec_config.png

Execute the program, and you should see the same output as before.



:orphan:

.. _section_java_best_practices:

***********************************
Best Practices for Java
***********************************

How to Reduce Memory Fragmentation
================================================================================

To reduce memory fragmentation, reuse molecules and call ``Clear()``.

.. code-block:: java

   // Creating a new molecule each iteration generates a significant amount of memory allocation/deallocation activity
   for(int i=0; i!=10; i++) {
       OEMol mol = new OEMol();
       oechem.OESmilesToMol(mol, smiles[i]);
       ...
   }

.. code-block:: java

   // Reusing molecule objects reduces memory fragmentation
   OEMol mol = new OEMol();
   for(int i=0; i!=10; i++) {
       oechem.OESmilesToMol(mol, smiles[i]);
       ...
       mol.Clear();
   }

When to Call close()
================================================================================

Call ``close()`` on any object that has the method (listed below), when it is done being used.

* :ref:`oeistream <OEPlatform_oeistream>`
* :ref:`oeifstream <OEPlatform_oeifstream>`
* :ref:`oeigzstream <OEPlatform_oeigzstream>`
* :ref:`oeisstream <OEPlatform_oeisstream>`
* :ref:`oeistdstream <OEPlatform_oeistdstream>`
* :ref:`oeiwrapperstream <OEPlatform_oeiwrapperstream>`
* :ref:`oeostream <OEPlatform_oeostream>`
* :ref:`oeofstream <OEPlatform_oeofstream>`
* :ref:`oeogzstream <OEPlatform_oeogzstream>`
* :ref:`oeosstream <OEPlatform_oeosstream>`
* :ref:`oeostdstream <OEPlatform_oeostdstream>`
* :ref:`oeowrapperstream <OEPlatform_oeowrapperstream>`
* :ref:`oemultiostream <OEPlatform_oemultiostream>`
* :ref:`oeprogressstream <OESystem_oeprogressstream>`
* :ref:`oemolistream <OEChem_oemolistream>`
* :ref:`oemolithread <OEChem_oemolithread>`
* :ref:`oemolostream <OEChem_oemolostream>`
* :ref:`oemolothread <OEChem_oemolothread>`

Despite the fact that Java is garbage collected, calling ``close()`` on any object
with an underlying file handle is necessary. The reason for this is that garbage collector
(GC) is non-deterministic. If the GC were to handle closing files, the stream might be waiting
to flush for several GC cycles, causing corruption if the same file were written to
again by another object.

The following example reads molecules from stdin in :ref:`SMILES <chapter_SMILES>`
format and write them to stdout in :oe:func:`absolute SMILES<OEChem::OECreateAbsSmiString>`
format. Notice that the :oe:meth:`OEChem::oemolstreambase::close` method must be
explicitly called on the molecule streams.

.. oe:source:: oemolstream.java
   :language: java
   :caption:  High-level Molecule I/O using molstreams
   :refnum:   1
   :frag:     SNIPPET

When to Call delete()
================================================================================

Call ``delete()`` as soon as possible on objects that have it defined from any of **OpenEye** toolkits.
For scripts that create many objects (including implicitly created object, such as by
:oe:meth:`OEChem::OEMolBase::GetAtoms` and :oe:meth:`OEChem::OEAtomBase::GetBonds`, etc.),
solely relying on GC can cause out of memory error. The ``delete()`` method invokes the
underlying C++ destructor to release the allocated memory, and is especially required to prevent such error.

.. code-block:: java

   // Calling .delete() is recommended
   OEMol mol = new OEMol();
   ...
   mol.delete();

.. code-block:: java

   // If many objects are created in a loop, it is
   // mandatory to call .delete() to prevent out of memory error
   while (oechem.OEReadMolecule(ifs, mol)) {
       OEAtomBaseIter aiter = mol.GetAtoms();
       for (OEAtomBase atm : aiter) {
           ...
       }
       aiter.delete();
   }

.. warning::

   Calling any method on an object after ``.delete()`` will cause a hard crash.

OEFloatArray vs float[]
================================================================================

It is at least 2 times faster to use a ``float[]``, instead of ``OEFloatArray``, when the contents of an array needs to be manipulated
between OpenEye API calls. This is best explained with the following examples:

.. oe:source:: FloatArraySlow.java
   :language: java
   :caption:  Using float[] is faster when contents need to be changed
   :refnum:   1
   :frag:     SNIPPET-SLOW

.. oe:source:: FloatArraySlowest.java
   :language: java
   :caption:  Using OEFloatArray is slower when contents need to be changed
   :refnum:   1
   :frag:     SNIPPET-SLOWEST

The performance difference is even more significant when this is called in
many loops.

OpenEye Defines
================================================================================

* ``-Doejava.libs.debug=[1|0]`` displays debugging output to the console while
  loading shared libraries.

* ``-Doejava.libs.path=path`` loads **OpenEye** shared libraries directly from path.
  It make no attempt to unpack them from the jar and fails if no libraries are found.

Keep in Mind
================================================================================

* "You can be sure only about which objects are marked for garbage collection. You can never be
  sure exactly when the object will be garbage collected. ([Gupta-2013]_)

* "Garbage collection happens in a low priority thread." ([Gupta-2013]_)

* "... the cost of automatic dynamic memory management is highly dependent on application behavior."
  ([Jones-2012]_)

References
================================================================================

.. [Gupta-2013]
   | M. Gupta,
   | **OCA Java SE 7 Programmer I Certification Guide**,
   | *Manning Publications Company*, pp. 120-124, ISBN: 9781617291043, **2013**.

.. [Jones-2012]
   | R. Jones, A. Hosking, and E. Moss,
   | **The Garbage Collection HandBook**,
   | *CRC Press*, pp. 9, **2012**.


Creating an Example on the command line
========================================

Let's start with a very simple OEChem program using command line tools. Open a new file in a text
editor called `OESample1.java` and enter the following code.

.. code-block:: java

   import openeye.oechem.*;

   class OESample1 {
       public static void main(String [] args) {
           OEGraphMol mol = new OEGraphMol();
           oechem.OEParseSmiles(mol, "c1ccccc1CCCBr");
           System.out.format("mol has %d atoms\n", mol.NumAtoms()); 
       } 
   }

Save the file and let's compile it from the command line with `javac`. Note that you can 
pass the CLASSPATH as an argument to javac or you could declare the CLASSPATH 
environment variable. In either case, the only thing needed to add is the
single jar file.

.. code-block:: bash
   
   $> javac -cp oejava-1.8.0-Windows-x86.jar OESample1.java

This should produce OESample1.class if you don't have any typos. You can then run this sample on the 
command line using something like:

.. code-block:: bash

   $> java -cp oejava-1.8.0-Windows-x86.jar:. OESample1
   mol has 10 atoms


Creating a custom oejava jar file
=================================

In the previous examples, we used the entire oejava-\*-.jar JAR file for
the projects. In most cases, this is the easiest path since it contains
all the toolkits for a particular platform.

But there are times where it may be desired to create a smaller, custom
JAR containing only the specific toolkits for that project. Additionally,
for a project that needs to run on several different platforms, we can 
also merge in two or more platforms, making a single JAR.

In the same directory that contains the oejava-\*-.jar file(s), you'll 
find another jar that contains a small program for generating these
custom JARs. The next section shows some example uses of this program.

Examples of creating a special jar
------------------------------------

If you run the program with no command line arguments, you'll see the basic
syntax of the command as well as a list of available toolkits to include.

.. code-block:: bash

   $ java -jar openeye-javautils.jar

   usage: Main -products <prod list> -jars <jar list> -out <new jar name>

    Available Products:
      OEBio
      OEChem
      OEDepict
      OEDocking
      OEGraphSim
      OEGrapheme
      OEIUPAC
      OEMedChem
      OEMolProp
      OEOmega
      OEQuacpac
      OEShape
      OESpicoli
      OESzmap
      OESzybki
      OEZap

The simplest example is to create a smaller JAR, containing a subset of the toolkits.
Assuming we are working on 32-bit Windows, and want to create a new JAR with only
OEChem and OEGraphSim, we would do something like:

.. code-block:: bash

   $ java -jar openeye-javautils.jar -products OEChem OEGraphSim \
     -jars oejava-v1.8.0-Windows-x86.jar -out oechem-special-win32.jar

You can then use this new JAR for your new project. You'll note that it is
significantly smaller, but still self-contained to support a project using
OEChem and OEGraphSim only.

A potentially more useful feature is the ability to merge multiple platforms
into one new JAR, allowing cross-platform project and cross-platform FAT JARs.

A standard scenario might be where you develop on Windows (using 32-bit Java) but
want to deploy on 64-bit Linux. First gather the original JARs for the two platforms
of interest.

.. code-block:: bash

   $ ls oejava*
   oejava-v1.8.0-Linux-x64.jar  oejava-v1.8.0-Windows-x86.jar

Then run the program to create a new JAR with OEChem, OEDepict and OEGrapheme.

.. code-block:: bash

   $ java -jar openeye-javautils.jar -products OEChem OEDepict OEGrapheme \
     -jars oejava-v1.8.0-Windows-x86.jar oejava-v1.8.0-Linux-x64.jar \
     -out oechem-oedepict-oegrapheme-Win32-Linux64.jar

Using this new JAR in your project in Eclipse will allow you to create a 
FAT JAR that will run on both Win32 and Linux64.


How to Develop with the OpenEye Java Toolkit in Eclipse
========================================================

Eclipse is a Java IDE available from eclipse.org. 

Creating a New Project
----------------------

To create a new project, we choose from the File menu, 
File->New->Java Project. This will bring up a dialog like 
:ref:`New Eclipse Project 1<figure_eclipse_new_project1_java>`.
Type in a name for this project, like "OESample1", and then 
press the "Next" button.

.. _figure_eclipse_new_project1_java:

.. figure:: /_images/Eclipse-new-project1.PNG
   :align:  center
   
   **New Eclipse Project 1**

Next, we need to add the OpenEye JAR to our project. Click the "Libraries"
tab at the top of the dialog, then choose "Add External JARs...". Browse 
to the location where you expanded the distribution you downloaded above
and pick the appropriate "oejava-\*-jar" for your platform. See 
:ref:`New Eclipse Project 2<figure_eclipse_new_project2_java>`.

.. _figure_eclipse_new_project2_java:

.. figure:: /_images/Eclipse-new-project2.PNG
   :align:  center
   
   **New Eclipse Project 2**

You should then see something like:
:ref:`New Eclipse Project 3<figure_eclipse_new_project3_java>`.
Click the "Finish" button.

.. _figure_eclipse_new_project3_java:

.. figure:: /_images/Eclipse-new-project3.PNG
   :align:  center
   
   **New Eclipse Project 3**

Adding a Class to Our Project
-----------------------------

Next we need to add a Java class to hold our sample code. Click
File->New->Class to bring up the "New Class" dialog as in 
:ref:`Eclipse New Class<figure_eclipse_new_class_java>`.

.. _figure_eclipse_new_class_java:

.. figure:: /_images/Eclipse-New-Class.PNG
   :align:  center
   
   **Eclipse New Class**

There are several things we want to do on this dialog.

   * Choose a package name for this class. For example, "myoechemexamples".
   * Choose a name for the class: "OESample1".
   * Remove the default "Superclass" entry, since it is not required.
   * Check the box to add a "main" to our class. And uncheck the box
     for "Inherits abstract methods".
   * Then click the "Finish" button.

This will take you back to Eclipse and open the new class in the editor,
ready to add code.

Near the top of the file, add the import for oechem.

.. code-block:: java
   
   import openeye.oechem.*;

Then add our sample code inside the main method.

.. code-block:: java

   public static void main(String[] args) {
       OEGraphMol mol = new OEGraphMol();
       oechem.OEParseSmiles(mol, "c1ccccc1CCCBr");
       System.out.format("mol has %d atoms\n", mol.NumAtoms()); 
   }

When you are finished, your sample should look something like
:ref:`Editing in Eclipse<figure_eclipse_editing_java>`.

.. _figure_eclipse_editing_java:

.. figure:: /_images/Eclipse-Editing.PNG
   :align:  center
   
   **Editing in Eclipse**

Running Our Example inside Eclipse
----------------------------------

We can now test run our program in Eclipse. In the toolbar,
click the "Run" button as shown in 
:ref:`Running in Eclipse<figure_eclipse_run_java>`.

.. _figure_eclipse_run_java:

.. figure:: /_images/Eclipse-Run.PNG
   :align:  center
   
   **Running Our Example in Eclipse**

This should produce some output in the "Console" window like
:ref:`Console output<figure_eclipse_console_output_java>`.

.. _figure_eclipse_console_output_java:

.. figure:: /_images/Eclipse-Console-Output.PNG
   :align:  center
   
   **Console Output from Our Example**

And now you've created your first OEChem Java sample. You can now
add code and continue to run inside Eclipse to try out more of the
OEChem API.

Creating an Executable JAR
--------------------------

At some point, you may want to run your example outside of Eclipse,
or you may want to deploy the application to another machine. An easy
tool for this purpose is an export option built into modern versions
of Eclipse.

To create a standalone JAR executable, right-click on the project
and select ``Export...``.

.. figure:: /_images/Eclipse-export-JAR.png
   :align:  center
   
   **Exporting a Runnable JAR**

Then in the next dialog:

   * Pick a name for your and destination for the new JAR
   * Make your choice about how libraries should be packaged.
   * Click "Finish".

.. _figure_eclipse_build_fatjar2_java:

.. figure:: /_images/Eclipse-export-JAR-options.png
   :align:  center
   
   **Set Options for the New JAR**

You should now be able to open a terminal in the location where you 
saved the JAR file and run it from the command-line.

.. code-block:: bash

   $> java -jar ./OESample1.jar
   mol has 10 atoms



########################
Legal Notices
########################

..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt




.. _section_java_tk_import:

****************************
How to import the toolkits
****************************

At the beginning of most Java programs, functionality that
resides in other files is imported with the ``import``
statement. Built-in packages are usually imported like the
following:

.. code-block:: java

   import java.io.*;

**OpenEye Toolkits** resides in the ``openeye`` module. For example
**OEChem TK** can imported as:

.. code-block:: java

   import openeye.oechem.*;


:orphan:

#################################
Informatics and Modeling Toolkits
#################################

..  toctree::
    :maxdepth: 2

    OEChem TK<oechemtk/index>
    OEDepict TK<depicttk/index>
    OEDocking TK<dockingtk/index>
    FastROCS™  TK<fastrocstk/index>
    Grapheme™ TK<graphemetk/index>
    GraphSim TK<graphsimtk/index>
    Lexichem TK<lexichemtk/index>
    OEMedChem TK<medchemtk/index>
    MolProp TK<molproptk/index>
    Omega TK<omegatk/index>
    Quacpac TK<quacpactk/index>
    Shape TK<shapetk/index>
    Spicoli TK<spicolitk/index>
    Szmap TK<szmaptk/index>
    Szybki TK<szybkitk/index>
    Zap Toolkit<zaptk/index>


.. oechemtk toolkit documentation master file

################################
OEChem Toolkit |oechem_version|
################################

.. toctree::
   :maxdepth: 3

   introduction
   theory
   examples
   api

..  oe:language:: python

    .. toctree::
       :maxdepth: 1

       selected_examples_python

.. toctree::
   :maxdepth: 2

   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _chapter_oechem_intro:

********************************************************************************
Introduction
********************************************************************************

.. oe:language:: c++

   This is **OEChem TK**'s C++ Programming manual.

.. oe:language:: python

   This is **OEChem TK**'s Python Programming manual.

.. oe:language:: java

   This is **OEChem TK**'s Java Programming manual.

.. oe:language:: csharp

   This is **OEChem TK**'s C#/.Net Programming manual.

.. _section_oechem_intro_howtoread:

How to read this manual
================================================================================

This is a collection of prose covering many of the important topics
which can be addressed by the **OEChem TK** library. This manual is meant
to be read from front to back at least once. Each topic in this manual
is introduced assuming the material presented earlier in the manual
has been read. Further, the complexity of topics as well as the
complexity of the example code grows as the text progresses.  While
the initial listings are effectively the "Hello World" of **OEChem TK**,
later examples may require some time to comprehend fully. This manual
is filled with example programs. We encourage you to compile, test,
and modify the examples we present.

.. oe:language:: c++

   .. seealso::

      Experienced **OEChem TK** programmers should use the Application
      Programming Interface (:ref:`oechem_part_api`) for the most thorough
      reference of **OEChem TK** functionality.

.. oe:language:: python

   .. seealso::

      Experienced **OEChem TK** programmers should use the Application
      Programming Interface (:ref:`oechem_part_api`) for the most thorough
      reference of **OEChem TK** functionality. ``N.B.`` The API section of
      the documentation is automatically generated from the C++ header
      files. Due to technical limitations, it is not possible to
      provide each API function with the correct Python syntax. If you
      have any questions about the correct syntax for a function
      please contact support (support@eyesopen.com)

.. oe:language:: java

   .. seealso::

      Experienced **OEChem TK** programmers should use the Application
      Programming Interface (:ref:`oechem_part_api`) for the most thorough
      reference of **OEChem TK** functionality. ``N.B.`` The API section of
      the documentation is automatically generated from the C++ header
      files. Due to technical limitations it is not possible to
      provide each API function with the correct Java syntax. If you
      have any questions about the correct syntax for a function
      please contact support (support@eyesopen.com)

.. oe:language:: csharp

   .. seealso::

      Experienced **OEChem TK** programmers should use the Application
      Programming Interface (:ref:`oechem_part_api`) for the most thorough
      reference of **OEChem TK** functionality. ``N.B.`` The API section of
      the documentation is automatically generated from the C++ header
      files. Due to technical limitations it is not possible to
      provide each API function with the correct C# syntax. If you
      have any questions about the correct syntax for a function
      please contact support (support@eyesopen.com)

.. _section_intro_informatics:

OEChem and Informatics
================================================================================

Chemical information processing is the science of representing
molecules in computers. Hence the fundamental "object" or data
structure within a chemical information system is that of the
molecule, its atoms, and its bonds.

A significant problem encountered in such systems is that different
applications place differing requirements or constraints on how a
molecule is represented. In protein biochemistry, molecules are
divided into amino acid residues, with specific atom naming and
conformational information such as alpha helix or beta
sheet. Inorganic chemistry requires isotopic and coordination
information for atoms and modeling of complex chiralities.

One
possible solution is to prescribe a single data structure that encodes
all of the potential information required of a molecule. However, such
an approach suffers from the fact that "you cannot please all of the
chemists, all of the time." A requirement in the field of chemical
databases and substructure searching is that a molecule representation
be as compact as possible, to allow as much information to be held in
memory as possible and maximize the performance of processing
databases from disk.

For this reason, the molecule, its atoms, and its bonds are
defined in as abstract a manner as possible in **OEChem TK**.
The following is a quick guide to the chapters covering these
fundamental classes:

:ref:`OEMolBase <OEChem_OEMolBase>`

  * :ref:`chapter_molctordtor`
  * :ref:`chapter_molreadwrite`
  * :ref:`chapter_molproperties`
  * :ref:`chapter_oemol`
  * :ref:`chapter_designdecisions`

:ref:`OEAtomBase <OEChem_OEAtomBase>`, :ref:`OEBondBase <OEChem_OEBondBase>`

  * :ref:`chapter_atombondtraversal`
  * :ref:`chapter_atomproperties`
  * :ref:`chapter_bondproperties`
  * :ref:`chapter_atombondindices`

.. oe:language:: c++

   .. seealso::

      * :ref:`C++ Quick Start Manual <section_cpp_getting_started>` for
        installation instructions.
      * :ref:`section_cpp_tk_import` section

.. oe:language:: python

   .. seealso::

      * :ref:`Python Quick Start Manual <section_python_getting_started>` for
        installation instructions.
      * :ref:`section_python_tk_import` section

.. oe:language:: java

   .. seealso::

      * :ref:`Java Quick Start Manual <section_cpp_getting_started>` for
        installation instructions.
      * :ref:`section_java_tk_import` section

.. oe:language:: csharp

   .. seealso::

      * :ref:`C# Quick Start Manual <section_csharp_getting_started>` for
        installation instructions.
      * :ref:`section_csharp_tk_import` section


.. _chapter_2D_coordinates:

********************************************************************************
2D Coordinate Generation
********************************************************************************

The :oe:func:`OEChem::OEGenerate2DCoordinates` function **OEChem
TK**'s depiction algorithm is capable of assigning 2D coordinates to
molecules and reactions.  See :ref:`Figure: Schematic representation
of the steps of the 2D coordinate generation
<figure_2D_coordinates_generation>`. The algorithm uses a
**built-in** ring template dictionary to provide aesthetically
pleasing 2D layouts for complex macro-cycles.  In case when no
built-in template exists, the 2D coordinates of the ring system are
generated on-the-fly.  After laying out the ring system(s), the
algorithm assigns coordinates for acyclic chains and functional
groups.  In the last step, the algorithm attempts to resolve atom
clashes using a variety of heuristics.

.. _figure_2D_coordinates_generation:

.. figure:: oechemtk/images/2DCoordinateGgenerationSteps.*
   :align:  center

   **Schematic representation of the steps of the 2D coordinate generation in OEChem TK**

This built-in dictionary currently contains about 3000 ring-systems
that frequently occur in drug-like databases. New ring templates are
continuously being added with each release.

.. note::

   To improve the depiction of the ring systems, please run the
   :ref:`section_example_oechem_extractringtemplates`
   script on a 2D molecule file and send the results to
   support@eyesopen.com. **OpenEye** will be happy to incorporate the
   new ring systems in the **built-in**  dictionary in the next
   release of the toolkits.

.. note::

   :oe:func:`OEChem::OEGenerate2DCoordinates` is a **low-level** function that only
   assigns 2D coordinates to the given molecule.
   It is highly recommended to use the :oe:func:`OEDepict::OEPrepareDepiction`
   function of **OEDepict TK** when generating 2D coordinates for molecular depiction.
   The :oe:func:`OEDepict::OEPrepareDepiction` function, apart from assigning 2D
   coordinates also does the following:

   - suppresses or adds explicit hydrogens
   - perceives atom and bond stereo information
   - optimizes the 2D coordinates for horizontal or vertical rendering

.. _user-defined-ring-dictionary:

User-Defined Ring Dictionary
================================================================================

**OEChem TK** also allows the customization of the 2D coordinate
generation process by providing functionality to extract ring
templates from 2D molecule files, build user-defined ring
dictionaries, and then plug them into the 2D coordinate generation
engine.

The following are the steps to define your own ring dictionaries:

#. Building a ring dictionary from scratch

   .. seealso::

      Example code : :ref:`section_example_oechem_createringdict`

#. Adding new ring templates to an existing ring dictionary

   .. seealso::

      Example code : :ref:`section_example_oechem_appendringdict`

#. Generating 2D coordinates with custom ring templates

   .. seealso::

      Example code : :ref:`section_example_oechem_generate2D`

.. seealso::

   * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
   * :ref:`OE2DRingDictionaryCreatorOptions <OEChem_OE2DRingDictionaryCreatorOptions>` class
   * :oe:func:`OEChem::OEInit2DRingDictionary` function
   * :oe:func:`OEChem::OEIsValid2DRingDictionary` function
   * :oe:func:`OEChem::OEWrite2DRingDictionary` function


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEAltGroup, AltGroup

.. _OEBio_OEAltGroup:

.. oe:class:: OEAltGroup

   .. oe:api::

      class OEAltGroup

   This class represents `OEAltGroup`, an abstraction of a particular alternate location group in a molecule
   managed by an :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>`. It can be thought of as a collection of
   :ref:`OEAltLocation <OEBio_OEAltLocation>` objects, each referring to a specific set of atomic positions.

   The following :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>` methods return an :ref:`OEAltGroup <OEBio_OEAltGroup>` or the corresponding iterator:

   ========================================================== ============================================================ ==========================================================
   :oe:meth:`GetGroup<OEBio::OEAltLocationFactory::GetGroup>` :oe:meth:`GetGroups<OEBio::OEAltLocationFactory::GetGroups>` :oe:meth:`GetGroup<OEBio::OEAltLocationFactory::GetGroup>`
   ========================================================== ============================================================ ==========================================================

   The following :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>` methods take an :ref:`OEAltGroup <OEBio_OEAltGroup>`:

   ========================================================================== ================================================================ ================================================================================
   :oe:meth:`GetLocationCodes<OEBio::OEAltLocationFactory::GetLocationCodes>` :oe:meth:`GetAltAtoms<OEBio::OEAltLocationFactory::GetAltAtoms>` :oe:meth:`GetCurrentLocations<OEBio::OEAltLocationFactory::GetCurrentLocations>`
   ========================================================================== ================================================================ ================================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEAltGroup()
            OEAltGroup(const OEAltGroup& grp)
            OEAltGroup(const unsigned int* counts, unsigned int numGrps)

      .. oe:language:: python

         .. oe:api:: python

            OEAltGroup() -> OEAltGroup
            OEAltGroup(counts: int) -> OEAltGroup
            OEAltGroup(grp: OEAltGroup) -> OEAltGroup

      Default, copy and initialization constructors.

      If no arguments are supplied, the :oe:cls:`OEAltGroup<OEBio::OEAltGroup>` is uninitialized
      and will return ``false`` when :oe:meth:`operator bool<OEBio::OEAltGroup::operator bool>` is called.

      If an :oe:cls:`OEAltGroup<OEBio::OEAltGroup>` is supplied, the constructed object is identical to the input.

      If an array of location counts is supplied along with the total number of groups (the size of the array),
      an object is constructed that represents the first of these groups (and can represent any of these groups).

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAltGroup &operator=(const OEAltGroup &grp)

      Assignment -- sets this group to be identical to the input.

      Assignment operator.

   .. oe:method:: operator bool

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

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns ``true`` if the object refers to an actual group.
      Returns ``false`` if the group identifier is out of range.

   .. oe:method:: GetGroupCount

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

         .. oe:api::

            unsigned int GetGroupCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetGroupCount() -> int

      Returns the total number of alternate location groups found by the corresponding :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>`.

   .. oe:method:: GetGroupID

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

         .. oe:api::

            int GetGroupID() const

      .. oe:language:: python

         .. oe:api:: python

            GetGroupID() -> int

      Returns an integer that identifies this alternate location group.
      A negative number indicates the object does not refer to an actual alternate location group.

   .. oe:method:: GetLocationCount

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

         .. oe:api::

            unsigned int GetLocationCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetLocationCount() -> int

      Returns the total number of :oe:cls:`OEAltLocations<OEBio::OEAltLocation>` in this group.

   .. oe:method:: GetLocations

      .. oe:api::

         OESystem::OEIterBase<const OEAltLocation> *GetLocations() const

      Returns an iterator over all :oe:cls:`OEAltLocations<OEBio::OEAltLocation>` in this group.

   .. oe:method:: SetGroupID

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

         .. oe:api::

            OEAltGroup& SetGroupID(int newGrp)

      .. oe:language:: python

         .. oe:api:: python

            SetGroupID(newGrp: int) -> OEAltGroup

      Changes the group identifier for this group. If the identifier is out of range,
      :oe:meth:`operator bool<OEBio::OEAltGroup::operator bool>` will return ``false``.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEAltLocation, AltLocation

.. _OEBio_OEAltLocation:

.. oe:class:: OEAltLocation

   .. oe:api::

      class OEAltLocation

   This class represents `OEAltLocation`, an abstraction of a particular alternate location of an
   :ref:`OEAltGroup <OEBio_OEAltGroup>` in the molecule used to construct an :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>`.

   The following :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>` methods return an :ref:`OEAltLocation <OEBio_OEAltLocation>` or the corresponding iterator:

   ================================================================ ================================================================================
   :oe:meth:`GetLocation<OEBio::OEAltLocationFactory::GetLocation>` :oe:meth:`GetCurrentLocations<OEBio::OEAltLocationFactory::GetCurrentLocations>`
   ================================================================ ================================================================================

   The following :ref:`OEAltGroup <OEBio_OEAltGroup>` method returns an :ref:`OEAltLocation <OEBio_OEAltLocation>` iterator:

   ======================================================== =
   :oe:meth:`GetLocations<OEBio::OEAltGroup::GetLocations>`  
   ======================================================== =

   The following :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>` methods take an :ref:`OEAltLocation <OEBio_OEAltLocation>`:

   ========================================================================== ====================================================== ============================================================== ==========================================================
   :oe:meth:`GetLocationCodes<OEBio::OEAltLocationFactory::GetLocationCodes>` :oe:meth:`SetAlt<OEBio::OEAltLocationFactory::SetAlt>` :oe:meth:`MakeAltMol<OEBio::OEAltLocationFactory::MakeAltMol>` :oe:meth:`GetGroup<OEBio::OEAltLocationFactory::GetGroup>`
   ========================================================================== ====================================================== ============================================================== ==========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEAltLocation()
            OEAltLocation(const OEAltLocation& loc)
            OEAltLocation(int grpID, int locID, unsigned int numLocs)

      .. oe:language:: python

         .. oe:api:: python

            OEAltLocation() -> OEAltLocation
            OEAltLocation(grpID: int, locID: int, numLocs: int) -> OEAltLocation
            OEAltLocation(loc: OEAltLocation) -> OEAltLocation

      Default, copy and initialization constructors.

      If no arguments are supplied, the :oe:cls:`OEAltLocation<OEBio::OEAltLocation>` is uninitialized
      and will return ``false`` when :oe:meth:`operator bool<OEBio::OEAltLocation::operator bool>` is called.

      If an :oe:cls:`OEAltLocation<OEBio::OEAltLocation>` is supplied, the constructed object is identical to the input.

      If a group ID, a location ID and the total number of locations in the group is supplied,
      an object is constructed that represents the specified location in the specified group.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAltLocation &operator=(const OEAltLocation &loc)

      Assignment -- sets this location to be identical to the input.

      Assignment operator.

   .. oe:method:: operator bool

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

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns ``true`` if the object refers to an actual location.
      Returns ``false`` if the location identifier is out of range.

   .. oe:method:: GetGroupID

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

         .. oe:api::

            int GetGroupID() const

      .. oe:language:: python

         .. oe:api:: python

            GetGroupID() -> int

      Returns an integer that identifies the :ref:`OEAltGroup <OEBio_OEAltGroup>` that contains this location.
      A negative number indicates the object does not refer to an actual alternate location group.

   .. oe:method:: GetLocationCount

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

         .. oe:api::

            unsigned int GetLocationCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetLocationCount() -> int

      Returns the total number of alternate locations in the :ref:`OEAltGroup <OEBio_OEAltGroup>` that contains this location.

   .. oe:method:: GetLocationID

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

         .. oe:api::

            int GetLocationID() const

      .. oe:language:: python

         .. oe:api:: python

            GetLocationID() -> int

      Returns an integer that identifies this location.
      A negative number indicates the object does not refer to an actual alternate location.

   .. oe:method:: SetLocationID

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

         .. oe:api::

            OEAltLocation& SetLocationID(int newLoc)

      .. oe:language:: python

         .. oe:api:: python

            SetLocationID(newLoc: int) -> OEAltLocation

      Changes the location identifier for this location. If the identifier is out of range,
      :oe:meth:`operator bool<OEBio::OEAltLocation::operator bool>` will return ``false``.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEAltLocationFactory, AltLocationFactory

.. _OEBio_OEAltLocationFactory:

.. oe:class:: OEAltLocationFactory

   .. oe:api::

      class OEAltLocationFactory

   This class represents `OEAltLocationFactory`, a class to perceive and manage alternate locations
   in a molecule and generate new subset molecules for specific sets of :ref:`OEAltLocation <OEBio_OEAltLocation>` selections.

   .. oe:method:: Constructors

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

         .. oe:api::

            OEAltLocationFactory(const OEAltLocationFactory& fact)
            OEAltLocationFactory(const OEChem::OEMolBase& src,
                                 unsigned int options = OEBio::OEAltLocFactOption::None)

      .. oe:language:: python

         .. oe:api:: python

            OEAltLocationFactory(impl: OEAltLocationFactoryImpl) -> OEAltLocationFactory
            OEAltLocationFactory(fact: OEAltLocationFactory) -> OEAltLocationFactory
            OEAltLocationFactory(src: Union[OEGraphMol,OEMol,OEQMol],
                                 options: int) -> OEAltLocationFactory

      Default and copy constructors.

      If an :ref:`OEMolBase <OEChem_OEMolBase>` is supplied, the constructed factory will describe alternate locations
      in the input molecule and generate new single-conformation molecules on demand for any set
      of alternate location selections. The initial selection state of this factory is as if
      :oe:meth:`SetPrimaryAlt<OEBio::OEAltLocationFactory::SetPrimaryAlt>` has been called.

      .. note::

         When reading a molecule from a PDB file that will be used to construct an
         :oe:cls:`OEAltLocationFactory<OEBio::OEAltLocation>` be sure to specify the input flavor:
         :oe:const:`OEChem::OEIFlavor::PDB::ALTLOC` so that all the alternate location atoms will be retained.

      The options argument provides control over how the factory is constructed. The set of unsigned values
      for this parameter is specified
      by the :oe:constns:`OEBio::OEAltLocFactOption` namespace.

      If an :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>` is supplied, an object is constructed that matches the input.

      .. oe:api:

         OEAltLocationFactory(OEChem::OEAltLocationFactoryImpl *impl)

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAltLocationFactory &operator=(const OEAltLocationFactory &fact)

      Assignment -- sets this alternate location factory to be identical to the input.

      Assignment operator.

   .. oe:method:: GetAltAtoms

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

         .. oe:api::

            OESystem::OEIterBase<const OEChem::OEAtomBase>* GetAltAtoms() const
            OESystem::OEIterBase< OEChem::OEAtomBase> * GetAltAtoms()
            OESystem::OEIterBase<const OEChem::OEAtomBase>* GetAltAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred) const
            OESystem::OEIterBase<OEChem::OEAtomBase>* GetAltAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred)
            OESystem::OEIterBase<const OEChem::OEAtomBase> * GetAltAtoms(const OEAltGroup& grp) const
            OESystem::OEIterBase< OEChem::OEAtomBase> * GetAltAtoms(const OEAltGroup& grp)
            OESystem::OEIterBase<const OEChem::OEAtomBase>* GetAltAtoms(const OEAltGroup& grp,
                                                                        const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred) const
            OESystem::OEIterBase< OEChem::OEAtomBase> * GetAltAtoms(const OEAltGroup& grp,
                                                                    const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred)
            OESystem::OEIterBase<const OEChem::OEAtomBase> * GetAltAtoms(const OEAltLocation& loc) const
            OESystem::OEIterBase< OEChem::OEAtomBase> * GetAltAtoms(const OEAltLocation& loc)
            OESystem::OEIterBase<const OEChem::OEAtomBase>* GetAltAtoms(const OEAltLocation& loc,
                                                                        const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred) const
            OESystem::OEIterBase< OEChem::OEAtomBase> * GetAltAtoms(const OEAltLocation& loc,
                                                                    const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred)

      .. oe:language:: python

         .. oe:api:: python

            GetAltAtoms() -> Iterable[OEAtomBase]
            GetAltAtoms() -> OEAtomIter
            GetAltAtoms(pred: OEUnaryAtomPred) -> Iterable[OEAtomBase]
            GetAltAtoms(pred: OEUnaryAtomPred) -> OEAtomIter
            GetAltAtoms(grp: OEAltGroup) -> Iterable[OEAtomBase]
            GetAltAtoms(grp: OEAltGroup) -> OEAtomIter
            GetAltAtoms(grp: OEAltGroup, pred: OEUnaryAtomPred) -> Iterable[OEAtomBase]
            GetAltAtoms(grp: OEAltGroup, pred: OEUnaryAtomPred) -> OEAtomIter
            GetAltAtoms(loc: OEAltLocation) -> Iterable[OEAtomBase]
            GetAltAtoms(loc: OEAltLocation) -> OEAtomIter
            GetAltAtoms(loc: OEAltLocation, pred: OEUnaryAtomPred) -> Iterable[OEAtomBase]
            GetAltAtoms(loc: OEAltLocation, pred: OEUnaryAtomPred) -> OEAtomIter

      Returns an :ref:`OEAtomBase <OEChem_OEAtomBase>` iterator over the atoms with alternate locations.
      Both ``const`` and non-``const`` versions are supplied for each iterator.

      If no arguments are supplied, the iterator is over all alternate location atoms.

      If an :ref:`OEAltGroup <OEBio_OEAltGroup>` or :ref:`OEAltLocation <OEBio_OEAltLocation>` is supplied, the iterator
      is only over the atoms in the specified group or location.

      If an :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>` is supplied, the iterator will return those
      alternate location atoms that also match the predicate.

   .. oe:method:: GetAtomMapSize

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

         .. oe:api::

            unsigned int GetAtomMapSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomMapSize() -> int

      Returns the minimum size of the array of :ref:`OEAtomBase <OEChem_OEAtomBase>` pointers
      the user must supply to one of the
      :oe:meth:`MakePrimaryAltMol<OEBio::OEAltLocationFactory::MakePrimaryAltMol>`,
      :oe:meth:`MakeCurrentAltMol<OEBio::OEAltLocationFactory::MakeCurrentAltMol>`, or
      :oe:meth:`MakeAltMol<OEBio::OEAltLocationFactory::MakeAltMol>` methods
      if an atom map is to be returned. Atom maps are pointers to atoms
      in the generated molecule at locations in the
      array equal to the internal index of atoms in the molecule returned by
      :oe:meth:`GetSourceMol<OEBio::OEAltLocationFactory::GetSourceMol>`, or 0 for atoms not included
      in the generated molecule.

   .. oe:method:: GetBondMapSize

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

         .. oe:api::

            unsigned int GetBondMapSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondMapSize() -> int

      Returns the minimum size of the array of :ref:`OEBondBase <OEChem_OEBondBase>` pointers
      the user must supply to one of the
      :oe:meth:`MakePrimaryAltMol<OEBio::OEAltLocationFactory::MakePrimaryAltMol>`,
      :oe:meth:`MakeCurrentAltMol<OEBio::OEAltLocationFactory::MakeCurrentAltMol>`, or
      :oe:meth:`MakeAltMol<OEBio::OEAltLocationFactory::MakeAltMol>` methods
      if a bond map is to be returned. Bond maps are arrays of pointers to bonds
      in the generated molecule at locations in the
      array equal to the internal index of bonds in the molecule returned by
      :oe:meth:`GetSourceMol<OEBio::OEAltLocationFactory::GetSourceMol>`, or 0 for bonds not included
      in the generated molecule.

   .. oe:method:: GetCurrentAtoms

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

         .. oe:api::

            OESystem::OEIterBase< OEChem::OEAtomBase> * GetCurrentAtoms()
            OESystem::OEIterBase<const OEChem::OEAtomBase>* GetCurrentAtoms() const
            OESystem::OEIterBase< OEChem::OEAtomBase> * GetCurrentAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred)
            OESystem::OEIterBase<const OEChem::OEAtomBase>* GetCurrentAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            GetCurrentAtoms() -> Iterable[OEAtomBase]
            GetCurrentAtoms() -> OEAtomIter
            GetCurrentAtoms(pred: OEUnaryAtomPred) -> Iterable[OEAtomBase]
            GetCurrentAtoms(pred: OEUnaryAtomPred) -> OEAtomIter

      Returns an :ref:`OEAtomBase <OEChem_OEAtomBase>` iterator over the atoms in the current selection -- atoms in
      selected locations in each group plus atoms that are not in any alternate location group.
      Both ``const`` and non-``const`` versions are supplied for each iterator.

      If an :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>` is supplied, the iterator will return
      those selected atoms that also match the predicate.

   .. oe:method:: GetCurrentLocations

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

         .. oe:api::

            OESystem::OEIterBase<const OEAltLocation>* GetCurrentLocations() const
            OESystem::OEIterBase<const OEAltLocation>* GetCurrentLocations(const OEAltGroup& grp) const
            OESystem::OEIterBase<const OEAltLocation>* GetCurrentLocations(int grpNum) const

      .. oe:language:: python

         .. oe:api:: python

            GetCurrentLocations() -> Iterable[OEAltLocation]
            GetCurrentLocations(grp: OEAltGroup) -> Iterable[OEAltLocation]
            GetCurrentLocations(grpNum: int) -> Iterable[OEAltLocation]

      Returns an iterator over currently selected :oe:cls:`OEAltLocations<OEBio::OEAltLocation>`.
      If no argument is supplied, every selected location is returned, otherwise only the
      selected location(s) for the specified :oe:cls:`OEAltGroup<OEBio::OEAltGroup>` is returned.
      Unless :oe:meth:`SetAlt<OEBio::OEAltLocationFactory::SetAlt>`
      has been called with ``multiLoc`` set to ``true``, only a single
      :oe:cls:`OEAltLocation<OEBio::OEAltLocation>` will be returned per
      :oe:cls:`OEAltGroup<OEBio::OEAltGroup>`.

   .. oe:method:: GetGroup

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

         .. oe:api::

            OEAltGroup GetGroup(const OEChem::OEAtomBase* selAtom) const
            OEAltGroup GetGroup(const OEAltLocation& loc) const

      .. oe:language:: python

         .. oe:api:: python

            GetGroup(selAtom: OEAtomBase) -> OEAltGroup
            GetGroup(loc: OEAltLocation) -> OEAltGroup

      If an :ref:`OEAtomBase <OEChem_OEAtomBase>` pointer is supplied, the method returns
      the :oe:cls:`OEAltGroup<OEBio::OEAltGroup>` that includes the residue of the atom provided as input.
      If the input atom residue is not in any of the alternate location groups, a warning will be thrown,
      the :oe:cls:`OEAltGroup<OEBio::OEAltGroup>` will be uninitialized and will return ``false``
      when :oe:meth:`operator bool<OEBio::OEAltGroup::operator bool>` is called.

      If an :oe:cls:`OEAltLocation<OEBio::OEAltLocation>` is supplied, the method returns the
      :oe:cls:`OEAltGroup<OEBio::OEAltGroup>` the location is associated with.

   .. oe:method:: GetGroupCount

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

         .. oe:api::

            unsigned int GetGroupCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetGroupCount() -> int

      Returns the total number of :oe:cls:`OEAltGroups<OEBio::OEAltGroup>` identified by this
      :oe:cls:`OEAltLocationFactory<OEBio::OEAltLocationFactory>`.

   .. oe:method:: GetGroups

      .. oe:api::

         OESystem::OEIterBase<const OEAltGroup> *GetGroups() const

      Returns an iterator over all :oe:cls:`OEAltGroups<OEBio::OEAltGroup>` managed by this
      :oe:cls:`OEAltLocationFactory<OEBio::OEAltLocationFactory>`.

   .. oe:method:: GetLocation

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

         .. oe:api::

            OEAltLocation GetLocation(const OEChem::OEAtomBase* selAtom,
                                      char confCode, bool caseSensitive = true) const

      .. oe:language:: python

         .. oe:api:: python

            GetLocation(selAtom: OEAtomBase, confCode: str,
                        caseSensitive: bool = True) -> OEAltLocation

      Returns the :oe:cls:`OEAltLocation<OEBio::OEAltLocation>` that includes the residue of
      the selected atom and the
      conformation code provided as input. The user can select whether or not
      the conformation code match is case sensitive.
      If the input atom residue is not in any of the alternate location groups,
      a warning will be thrown, the :oe:cls:`OEAltLocation<OEBio::OEAltLocation>`
      will be uninitialized and will return ``false``
      when :oe:meth:`operator bool<OEBio::OEAltLocation::operator bool>` is called.

   .. oe:method:: GetLocationCodes

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

         .. oe:api::

            std::string GetLocationCodes(const OEAltGroup& grp) const
            std::string GetLocationCodes(const OEAltLocation& loc) const

      .. oe:language:: python

         .. oe:api:: python

            GetLocationCodes(grp: OEAltGroup) -> str
            GetLocationCodes(loc: OEAltLocation) -> str

      Returns a string listing all the alternate location characters in the input :oe:cls:`OEAltGroup<OEBio::OEAltGroup>`
      or :oe:cls:`OEAltLocation<OEBio::OEAltLocation>`.
      Although most :oe:cls:`OEAltLocations<OEBio::OEAltLocation>` will return a string containing
      only a single character,
      some that are more complicated will return a string with more than one character.

   .. oe:method:: GetSourceMol

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

         .. oe:api::

            const OEChem::OEMolBase& GetSourceMol() const

      .. oe:language:: python

         .. oe:api:: python

            GetSourceMol() -> OEGraphMol

      Returns a constant reference to a copy of the :ref:`OEMolBase <OEChem_OEMolBase>` supplied to the
      :oe:meth:`Constructor<OEBio::OEAltLocationFactory::Constructors>`.

   .. oe:method:: GetState

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

         .. oe:api::

            OEAltLocationState GetState() const
            void GetState(OEAltLocationState& state) const

      .. oe:language:: python

         .. oe:api:: python

            GetState() -> OEAltLocationState
            GetState(state: OEAltLocationState) -> None

      Returns an :oe:cls:`OEAltLocationState<OEBio::OEAltLocationState>` that represents
      the current selection state of this
      :oe:cls:`OEAltLocationFactory<OEBio::OEAltLocationFactory>`.

      .. seealso::

         * :oe:meth:`SetState<OEBio::OEAltLocationFactory::SetState>`
         * :oe:meth:`MakeAltMol<OEBio::OEAltLocationFactory::MakeAltMol>`

   .. oe:method:: MakeAltMol

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

         .. oe:api::

            bool MakeAltMol(OEChem::OEMolBase& dst, const OEAltLocation& loc,
                            OEChem::OEAtomBase** atomMap = 0,
                            OEChem::OEBondBase** bondMap = 0,
                            unsigned int options = OEBio::OEMakeAltMolOption::None)
            bool MakeAltMol(OEChem::OEMolBase& dst,
                            const OEChem::OEAtomBase* selAtom, char confCode,
                            bool caseSensitive = true,
                            OEChem::OEAtomBase** atomMap = 0,
                            OEChem::OEBondBase** bondMap = 0,
                            unsigned int options = OEBio::OEMakeAltMolOption::None)
            bool MakeAltMol(OEChem::OEMolBase& dst,
                            const OEAltLocationState& state,
                            OEChem::OEAtomBase** atomMap = 0,
                            OEChem::OEBondBase** bondMap = 0,
                            unsigned int options = OEBio::OEMakeAltMolOption::None)

      .. oe:language:: python

         .. oe:api:: python

            MakeAltMol(dst: Union[OEGraphMol,OEMol,OEQMol], loc: OEAltLocation,
                       atomMap: OEAtomBase = None, bondMap: OEBondBase = None,
                       options: int) -> bool
            MakeAltMol(dst: Union[OEGraphMol,OEMol,OEQMol],
                       selAtom: OEAtomBase, confCode: str,
                       caseSensitive: bool = True, atomMap: OEAtomBase = None,
                       bondMap: OEBondBase = None, options: int) -> bool
            MakeAltMol(dst: Union[OEGraphMol,OEMol,OEQMol],
                       state: OEAltLocationState, atomMap: OEAtomBase = None,
                       bondMap: OEBondBase = None, options: int) -> bool

      Sets the selection state of this :oe:cls:`OEAltLocationFactory<OEBio::OEAltLocationFactory>`
      and generates a new subset molecule (``dst``) for this state, returning a value indicating
      whether the selection was valid.
      Unless :oe:meth:`SetAlt<OEBio::OEAltLocationFactory::SetAlt>`
      has been called with ``multiLoc`` set to ``true``,
      the subset mol will represent a single conformation.

      If either a location or an atom selection is supplied
      (see :oe:meth:`GetLocation<OEBio::OEAltLocationFactory::GetLocation>`),
      the selection state of only one group is set.
      If an :oe:cls:`OEAltLocationState<OEBio::OEAltLocationState>` is supplied,
      the selection state of all groups may be affected
      (see :oe:meth:`GetState<OEBio::OEAltLocationFactory::GetState>`).

      If either a location or an atom selection is supplied and cannot be found in any
      alternation group, the ``dst`` molecule is not updated and ``false`` is returned.

      If an array of :ref:`OEAtomBase <OEChem_OEAtomBase>` pointers is provided, this method will fill
      it with an atom map: pointers to atoms in the generated molecule at locations in the
      array equal to the internal index of atoms in the molecule returned by
      :oe:meth:`GetSourceMol<OEBio::OEAltLocationFactory::GetSourceMol>`, or 0 for atoms not included
      in the generated molecule.

      If an array of :ref:`OEBondBase <OEChem_OEBondBase>` pointers is provided, this method will fill
      it with a bond map: pointers to bonds in the generated molecule at locations in the
      array equal to the internal index of bonds in the molecule returned by
      :oe:meth:`GetSourceMol<OEBio::OEAltLocationFactory::GetSourceMol>`, or 0 for bonds not included
      in the generated molecule.

      The options argument provides control over how the molecule is constructed.
      The set of unsigned values for this parameter is specified
      by the :oe:constns:`OEBio::OEMakeAltMolOption` namespace.

   .. oe:method:: MakeCurrentAltMol

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

         .. oe:api::

            void MakeCurrentAltMol(OEChem::OEMolBase& dst,
                                   OEChem::OEAtomBase** atomMap = 0,
                                   OEChem::OEBondBase** bondMap = 0,
                                   unsigned int options = OEBio::OEMakeAltMolOption::None) const

      .. oe:language:: python

         .. oe:api:: python

            MakeCurrentAltMol(dst: Union[OEGraphMol,OEMol,OEQMol],
                              atomMap: OEAtomBase = None,
                              bondMap: OEBondBase = None, options: int) -> None

      Generates a new subset molecule (``dst``) for the current selection state.
      Unless :oe:meth:`SetAlt<OEBio::OEAltLocationFactory::SetAlt>`
      has been called with ``multiLoc`` set to ``true``,
      the subset mol will represent a single conformation.

      If an array of :ref:`OEAtomBase <OEChem_OEAtomBase>` pointers is provided, this method will fill
      it with an atom map: pointers to atoms in the generated molecule at locations in the
      array of the internal index of atoms in the molecule returned by
      :oe:meth:`GetSourceMol<OEBio::OEAltLocationFactory::GetSourceMol>`, or 0 for atoms not included
      in the generated molecule.

      If an array of :ref:`OEBondBase <OEChem_OEBondBase>` pointers is provided, this method will fill
      it with a bond map: pointers to bonds in the generated molecule at locations in the
      array of the internal index of bonds in the molecule returned by
      :oe:meth:`GetSourceMol<OEBio::OEAltLocationFactory::GetSourceMol>`, or 0 for bonds not included
      in the generated molecule.

      The options argument provides control over how the molecule is constructed.
      The set of unsigned values for this parameter is specified
      by the :oe:constns:`OEBio::OEMakeAltMolOption` namespace.

   .. oe:method:: MakePrimaryAltMol

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

         .. oe:api::

            void MakePrimaryAltMol(OEChem::OEMolBase& dst,
                                   OEChem::OEAtomBase** atomMap = 0,
                                   OEChem::OEBondBase** bondMap = 0,
                                   unsigned int options = OEBio::OEMakeAltMolOption::None)

      .. oe:language:: python

         .. oe:api:: python

            MakePrimaryAltMol(dst: Union[OEGraphMol,OEMol,OEQMol],
                              atomMap: OEAtomBase = None,
                              bondMap: OEBondBase = None, options: int) -> None

      Resets the selection state of this :oe:cls:`OEAltLocationFactory<OEBio::OEAltLocationFactory>`
      to the primary location (see :oe:meth:`SetPrimaryAlt<OEBio::OEAltLocationFactory::SetPrimaryAlt>`)
      and generates a new subset molecule (``dst``) for this state.
      Unless :oe:meth:`SetAlt<OEBio::OEAltLocationFactory::SetAlt>`
      has been called with ``multiLoc`` set to ``true``,
      the subset mol will represent a single conformation.

      If an array of :ref:`OEAtomBase <OEChem_OEAtomBase>` pointers is provided, this method will fill
      it with an atom map: pointers to atoms in the generated molecule at locations in the
      array of the internal index of atoms in the molecule returned by
      :oe:meth:`GetSourceMol<OEBio::OEAltLocationFactory::GetSourceMol>`, or 0 for atoms not included
      in the generated molecule.

      If an array of :ref:`OEBondBase <OEChem_OEBondBase>` pointers is provided, this method will fill
      it with a bond map: pointers to bonds in the generated molecule at locations in the
      array of the internal index of bonds in the molecule returned by
      :oe:meth:`GetSourceMol<OEBio::OEAltLocationFactory::GetSourceMol>`, or 0 for bonds not included
      in the generated molecule.

      The options argument provides control over how the molecule is constructed.
      The set of unsigned values for this parameter is specified
      by the :oe:constns:`OEBio::OEMakeAltMolOption` namespace.

   .. oe:method:: SetAlt

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

         .. oe:api::

            bool SetAlt(const OEAltLocation& loc, bool multiLoc = false)
            bool SetAlt(const OEChem::OEAtomBase* selAtom, char confCode,
                        bool caseSensitive = true)

      .. oe:language:: python

         .. oe:api:: python

            SetAlt(loc: OEAltLocation, multiLoc: bool = False) -> bool
            SetAlt(selAtom: OEAtomBase, confCode: str,
                   caseSensitive: bool = True) -> bool

      If an :oe:cls:`OEAltLocation<OEBio::OEAltLocation>` is supplied,
      the selection state of the :oe:cls:`OEAltGroup<OEBio::OEAltGroup>`
      containing the location is set to select that location, with a return value
      indicating whether the location was found. If the optional ``multiLoc``
      parameter has the (default) value of ``false``, the function acts like a
      toggle: the previous location for
      this group is unselected before the new location is selected.

      For a description of the atom selection form,
      see :oe:meth:`GetLocation<OEBio::OEAltLocationFactory::GetLocation>`.

      .. warning::

         If this method is called with the ``multiLoc`` parameter set to ``true``, the
         :oe:cls:`OEAltLocationFactory<OEBio::OEAltLocationFactory>` may be left in a state
         where :oe:meth:`MakeCurrentAltMol<OEBio::OEAltLocationFactory::MakeCurrentAltMol>`
         no longer generates a single-conformation molecule.

   .. oe:method:: SetPrimaryAlt

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

         .. oe:api::

            void SetPrimaryAlt()

      .. oe:language:: python

         .. oe:api:: python

            SetPrimaryAlt() -> None

      Resets the selection state of this :oe:cls:`OEAltLocationFactory<OEBio::OEAltLocationFactory>`
      to the first location for each group -- the location with the highest average occupancy.

   .. oe:method:: SetState

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

         .. oe:api::

            bool SetState(const OEAltLocationState& state)

      .. oe:language:: python

         .. oe:api:: python

            SetState(state: OEAltLocationState) -> bool

      Resets the selection state of this :oe:cls:`OEAltLocationFactory<OEBio::OEAltLocationFactory>`
      to that represented by the input :oe:cls:`OEAltLocationState<OEBio::OEAltLocationState>`,
      with a return value indicating whether the state was valid.

      .. seealso::

         * :oe:meth:`GetState<OEBio::OEAltLocationFactory::GetState>`
         * :oe:meth:`MakeAltMol<OEBio::OEAltLocationFactory::MakeAltMol>`


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEAltLocationState, AltLocationState

.. _OEBio_OEAltLocationState:

.. oe:class:: OEAltLocationState

   .. oe:api::

      class OEAltLocationState

   This class represents `OEAltLocationState`, an abstraction of the internal :ref:`OEAltLocation <OEBio_OEAltLocation>`
   selection state of an :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>`. It is designed for ease of use with collection classes
   and to support serialization.

   The following :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>` methods get or set an :ref:`OEAltLocationState <OEBio_OEAltLocationState>`:

   ============================================================================== ============================================================================== ==============================================================================
   :oe:meth:`GetState<OEBio::OEAltLocationFactory::GetState>`                     :oe:meth:`SetState<OEBio::OEAltLocationFactory::SetState>`                     :oe:meth:`MakeAltMol<OEBio::OEAltLocationFactory::MakeAltMol>`                
   ============================================================================== ============================================================================== ==============================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEAltLocationState()
            OEAltLocationState(const std::string& hex)
            OEAltLocationState(const OEAltLocationState& state)

      .. oe:language:: python

         .. oe:api:: python

            OEAltLocationState() -> OEAltLocationState
            OEAltLocationState(hex: str) -> OEAltLocationState
            OEAltLocationState(state: OEAltLocationState) -> OEAltLocationState

      Default and copy constructors.

      If no arguments are supplied, the constructed object is uninitialized and will return ``false``
      when :oe:meth:`operator bool<OEBio::OEAltLocationState::operator bool>` is called.

      If a ``string`` is supplied, then an object is constructed to represent the state described by the string.
      Strings appropriate for use with this method are generated by :oe:meth:`OEBio::OEAltLocationState::ToHexString`.
      This constructor is used when reconstituting the serialized state of an :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>` prior to
      providing the resulting :oe:cls:`OEAltLocationState<OEBio::OEAltLocationState>` to :oe:meth:`OEBio::OEAltLocationFactory::MakeAltMol`.

      If an :oe:cls:`OEAltLocationState<OEBio::OEAltLocationState>` is supplied, an object is constructed that is identical to the input.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAltLocationState &operator=(const OEAltLocationState &state)

      Assignment -- sets this state to match the supplied :ref:`OEAltLocationState <OEBio_OEAltLocationState>`.

      .. oe:api:

         OEAltLocationState &operator=(OEChem::OEAltLocationStateImpl *newImpl)

      Assignment operator.

   .. oe:method:: operator bool

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

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns ``true`` if the state has been initialized (constructed from a ``string`` argument or from another state that has been initialized).
      Otherwise, returns ``false``.

   .. oe:method:: ToHexString

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

         .. oe:api::

            bool ToHexString(std::string& hex) const

      .. oe:language:: python

         .. oe:api:: python

            ToHexString() -> str

      Generate a text string that describes the state. Used when serializing the state of an :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>`.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEAtomMatchResidue, AtomMatchResidue

.. _OEBio_OEAtomMatchResidue:

.. oe:class:: OEAtomMatchResidue

   .. oe:api::

      class OEAtomMatchResidue : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) in residues
   (:oe:cls:`OEResidue<OEChem::OEResidue>`) matching specific pieces, like residue name,
   residue number, insertion code, chain ID, and fragment number.

   .. seealso::

      * :ref:`section_predicates_reside_data_functors` section
      * :ref:`OEAtomMatchResidueID <OEBio_OEAtomMatchResidueID>` class

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEAtomMatchResidue(const std::string& resId)
            OEAtomMatchResidue(const std::vector<std::string>& resIds)
            OEAtomMatchResidue(const OEAtomMatchResidueID& resId)
            OEAtomMatchResidue(const std::vector<OEAtomMatchResidueID>& resIds)
            OEAtomMatchResidue(const OEChem::OEResidue& resId)
            OEAtomMatchResidue(const std::vector<OEChem::OEResidue>& resIds)

      .. oe:language:: python

         .. oe:api:: python

            OEAtomMatchResidue(resIds: OEAtomMatchResidueIDVector) -> OEAtomMatchResidue
            OEAtomMatchResidue(resId: OEAtomMatchResidueID) -> OEAtomMatchResidue
            OEAtomMatchResidue(resIds: OEResidueVector) -> OEAtomMatchResidue
            OEAtomMatchResidue(resId: OEResidue) -> OEAtomMatchResidue
            OEAtomMatchResidue(resIds: OEStringVector) -> OEAtomMatchResidue
            OEAtomMatchResidue(resId: str) -> OEAtomMatchResidue

      Constructs the functor with the residue properties specified by a regex string, 
      an :ref:`OEAtomMatchResidueID <OEBio_OEAtomMatchResidueID>` or a vector of those, an OEResidue, or a vector of those.

      .. oe:api: # IGNORE FOR DOCUMENTATION

         OEAtomMatchResidue(const std::vector<std::string>& resIds);

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

         .. oe:api::

            OEAtomMatchResidue(const OEChem::OEMolBase& molA,
                               const OEChem::OEMolBase& molB,
                               const double dist, bool excludeHydrogens = true)

      .. oe:language:: python

         .. oe:api:: python

            OEAtomMatchResidue(protein: Union[OEGraphMol,OEMol,OEQMol],
                               ligand: Union[OEGraphMol,OEMol,OEQMol],
                               dist: float, excludeHydrogens: bool = True) -> OEAtomMatchResidue

      Constructs the functor to match the complete residues in `molA` that are within the specific distance `dist` in `molB`.
      An option exists to exclude explicit hydrogens to be considered inside the distance threshold, which is on by default.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the residue of the atom (returned by the
      :oe:func:`OEChem::OEAtomGetResidue` function) has equivalent
      residue properties (i.e. residue name, residue number, insertion
      code, chain ID, and fragment number) with which the functor is
      constructed.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomMatchResidue

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   **Examples**

   The examples below demonstrate how to create various predicates that allow to access atoms
   based on their residue information.

   .. oe:source:: AtomMatchResidue.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEAtomMatchResidue

   .. oe:source:: AtomMatchResidue.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEAtomMatchResidue

   .. oe:source:: AtomMatchResidue.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEAtomMatchResidue

   .. oe:source:: AtomMatchResidue.cs
      :language: cs
      :noindent:
      :frag:     SNIPPET-OEAtomMatchResidue


.. oe:namespace:: OEBio

.. _OEBio_OEAtomMatchResidueID:

.. oe:class:: OEAtomMatchResidueID

   .. oe:api::

      class OEAtomMatchResidueID

   The :ref:`OEAtomMatchResidueID <OEBio_OEAtomMatchResidueID>` class stores residue properties,
   such as residue name, residue number, insertion code, chain ID, fragment number, and alternate location.
   It is used to construct an :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>` predicate that provides a
   convenient way to iterate over atoms with specific residue information.

   .. seealso::

      * :ref:`OEResidue <OEChem_OEResidue>` class
      * :ref:`section_predicates_reside_data_functors` section
      * :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>` predicate

   .. admonition:: Code Example

      * See code examples in the :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>` predicate

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OEAtomMatchResidueID()

      .. oe:language:: python

         .. oe:api:: python

            OEAtomMatchResidueID() -> OEAtomMatchResidueID

      Default constructor that initializes the object with fuzzy regex matches
      ``.*`` for each property.

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

         .. oe:api::

            OEAtomMatchResidueID(OEChem::OEResidue res)

      .. oe:language:: python

         .. oe:api:: python

            OEAtomMatchResidueID(res: OEResidue) -> OEAtomMatchResidueID

      Constructs an :ref:`OEAtomMatchResidueID <OEBio_OEAtomMatchResidueID>` object with the given residue.

      .. note::

         There is a difference between using an OEResidue object retrieved from an existing atom,
         and a default constructed OEResidue object where the user has set a few variables. This is
         because the default constucted OEResidue object sets the residue name to ``UNL``, residue number to
         ``1``, fragment number to ``0``, chainID, insert code, and alternate location to blank characters `` ``.
         Because of these defaults, when constructing from an OEResidue object, we convert fragment number ``0``,
         to a fuzzy regex match ``.*``, since it will be 1 or higher if it was read from a PDB file. In the same
         manner a blank `` `` character for the chainID is converted into a fuzzy regex match. However, since
         a blank character is allowed and the most common for an insertCode and alternate location, these are kept as is and not converted.

   .. oe:method:: GetName

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

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      By default, it returns ``.*`` to match atoms with any residue name.

   .. oe:method:: GetResidueNumber

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

         .. oe:api::

            std::string GetResidueNumber() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidueNumber() -> str

      By default, it returns ``.*`` to match atoms with any residue number.

   .. oe:method:: GetInsertCode

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

         .. oe:api::

            std::string GetInsertCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetInsertCode() -> str

      By default, it returns ``.*`` to match atoms with any residue insert code.

   .. oe:method:: GetChainID

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

         .. oe:api::

            std::string GetChainID() const

      .. oe:language:: python

         .. oe:api:: python

            GetChainID() -> str

      By default, it returns ``.*`` to match atoms with any residue chain ID.

   .. oe:method:: GetFragmentNumber

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

         .. oe:api::

            std::string GetFragmentNumber() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragmentNumber() -> str

      By default, it returns ``.*`` to match atoms with any residue fragment number.

   .. oe:method:: GetAlternateLocation()

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

         .. oe:api::

            std::string GetAlternateLocation() const

      .. oe:language:: python

         .. oe:api:: python

            GetAlternateLocation() -> str

      By default, it returns ``.*`` to match atoms with any alternate location code.

   .. oe:method:: SetName

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

         .. oe:api::

            void SetName(const std::string& n)

      .. oe:language:: python

         .. oe:api:: python

            SetName(n: str) -> None

      See also :oe:meth:`OEChem::OEResidue::SetName` method.

   .. oe:method:: SetResidueNumber

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

         .. oe:api::

            void SetResidueNumber(const std::string& n)

      .. oe:language:: python

         .. oe:api:: python

            SetResidueNumber(n: str) -> None

      See also :oe:meth:`OEChem::OEResidue::SetResidueNumber` method.

   .. oe:method:: SetInsertCode

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

         .. oe:api::

            void SetInsertCode(const std::string& i)

      .. oe:language:: python

         .. oe:api:: python

            SetInsertCode(i: str) -> None

      See also :oe:meth:`OEChem::OEResidue::SetInsertCode` method.

   .. oe:method:: SetChainID

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

         .. oe:api::

            void SetChainID(const std::string& c)

      .. oe:language:: python

         .. oe:api:: python

            SetChainID(c: str) -> None

      See also :oe:meth:`OEChem::OEResidue::SetChainID` method.

   .. oe:method:: SetFragmentNumber

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

         .. oe:api::

            void SetFragmentNumber(const std::string& f)

      .. oe:language:: python

         .. oe:api:: python

            SetFragmentNumber(f: str) -> None

      See also :oe:meth:`OEChem::OEResidue::SetFragmentNumber` method.

   .. oe:method:: SetAlternateLocation

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

         .. oe:api::

            void SetAlternateLocation(const std::string& f)

      .. oe:language:: python

         .. oe:api:: python

            SetAlternateLocation(a: str) -> None

      See also :oe:meth:`OEChem::OEResidue::SetAlternateLocation` method.


.. _OEBioClasses:

*******************
OEBio Classes
*******************

.. oe:namespace:: OEBio

.. toctree::
   :maxdepth: 1

   OEAltGroup
   OEAltLocation
   OEAltLocationFactory
   OEAltLocationState
   OEAtomMatchResidue
   OEAtomMatchResidueID
   OECationPiInteractionHint
   OEChelatorInteractionHint
   OEClashInteractionHint
   OEContactInteractionHint
   OECovalentInteractionHint
   OECrystalSymmetryParams
   OEDesignUnit
   OEHalogenBondInteractionHint
   OEHasAlternateLocation
   OEHasInteractionHint
   OEHasInteractionHintType
   OEHasPDBAtomIndex
   OEHasResidueInteractionHint
   OEHasSecondaryStructure
   OEHBondInteractionHint
   OEHierChain
   OEHierFragment
   OEHierResidue
   OEHierView
   OEInteractionHint
   OEInteractionHintComponentTypeBase
   OEInteractionHintContainer
   OEInteractionHintFragment
   OEInteractionHintTypeBase
   OEIridiumData
   OEIsAlphaCarbon
   OEIsBackboneAtom
   OEIsCationPiInteractionHint
   OEIsChelatorInteractionHint
   OEIsClashingHBondInteractionHint
   OEIsClashInteractionHint
   OEIsContactInteractionHint
   OEIsCovalentInteractionHint
   OEIsCTerminalAtom
   OEIsDisulfideBond
   OEIsHalogenBondInteractionHint
   OEIsHBondInteractionHint
   OEIsHetAtom
   OEIsInterInteractionHint
   OEIsIntermolecularCationPiInteractionHint
   OEIsIntermolecularChelatorInteractionHint
   OEIsIntermolecularHalogenBondInteractionHint
   OEIsIntermolecularHBondInteractionHint
   OEIsIntermolecularSaltBridgeInteractionHint
   OEIsIntermolecularStackingInteractionHint
   OEIsIntraInteractionHint
   OEIsIntramolecularCationPiInteractionHint
   OEIsIntramolecularChelatorInteractionHint
   OEIsIntramolecularHalogenBondInteractionHint
   OEIsIntramolecularHBondInteractionHint
   OEIsIntramolecularSaltBridgeInteractionHint
   OEIsIntramolecularStackingInteractionHint
   OEIsNonIdealHBondInteractionHint
   OEIsNTerminalAtom
   OEIsNucleicAcidBase
   OEIsNucleicAcidPhosphate
   OEIsNucleicAcidSugar
   OEIsSaltBridgeInteractionHint
   OEIsStackingInteractionHint
   OEIsStandardAminoAcid
   OEIsStandardNucleicAcid
   OEIsUnpairedInteractionHint
   OEIsUnpairedLigandInteractionHint
   OEIsUnpairedProteinInteractionHint
   OEIsWater
   OELigandInteractionHintComponent
   OEMolComplexCategorizer
   OEMolComplexCategorizerBase
   OEMolComplexFilter
   OEPerceiveInteractionOptions
   OEPlaceHydrogensDetails
   OEPlaceHydrogensMoverNote
   OEPlaceHydrogensOptions
   OEProteinInteractionHintComponent
   OERamachandranAnalysis
   OEReceptor
   OEReceptorConstraintFeature
   OEReceptorCustomConstraints
   OEReceptorProteinConstraint
   OEResidueCategoryData
   OERotamer
   OESaltBridgeInteractionHint
   OESequenceAlignment
   OESplitMolComplexOptions
   OEStackingInteractionHint
   OEStructureQuality


.. oe:namespace:: OEBio

.. _OEBio_OECationPiInteractionHint:

.. oe:class:: OECationPiInteractionHint

   .. oe:api::

      class OECationPiInteractionHint : public OEInteractionHintTypeBase

   The :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` class represents
   a built-in type that identifies interactions stored in an
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object as
   **cation-Pi** interactions (inter- and intramolecular).

   .. seealso::

      * :oe:constns:`OEBio::OECationPiInteractionHintType` namespace for specific **cation-Pi**  interaction types
      * :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>` predicate
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class

      To perceive **cation-Pi** interactions:

      * :oe:func:`OEBio::OEPerceiveInteractionHints` function
      * :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class and its methods:

        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCationPiAngle`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCationPiDistance`

   The following methods are publicly inherited from :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`:
   
   =================================================================== =================================================================== =================================================================== 
   :oe:meth:`operator=<OEBio::OEInteractionHintTypeBase::operator=>`   :oe:meth:`operator==<OEBio::OEInteractionHintTypeBase::operator==>` :oe:meth:`GetName<OEBio::OEInteractionHintTypeBase::GetName>`
   :oe:meth:`operator!=<OEBio::OEInteractionHintTypeBase::operator!=>` :oe:meth:`CreateCopy<OEBio::OEInteractionHintTypeBase::CreateCopy>` :oe:meth:`IsValid<OEBio::OEInteractionHintTypeBase::IsValid>`
   =================================================================== =================================================================== =================================================================== 

   .. oe:method:: Constructors

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

         .. oe:api::

            OECationPiInteractionHint(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            OECationPiInteractionHint(type: int) -> OECationPiInteractionHint

      Creates an :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` object with the given type.

      *type*
         This value has to be from the :oe:constns:`OEBio::OECationPiInteractionHintType`
         namespace.

      .. note::

         Two :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` objects with different
         types from the :oe:constns:`OEBio::OECationPiInteractionHintType`
         namespace are considered to be different.

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

         .. oe:api::

            OECationPiInteractionHint(const OECationPiInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OECationPiInteractionHint(rhs: OECationPiInteractionHint) -> OECationPiInteractionHint

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECationPiInteractionHint &operator=(const OECationPiInteractionHint &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintTypeBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintTypeBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEInteractionHintFragment *,
                         const OEInteractionHintFragment *) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHintFragment,
                    arg3: OEInteractionHintFragment) -> bool

      Evaluates whether the two given fragments would form a valid
      **cation-Pi** interaction when added to an
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

      It checks that each fragment contains at least one atom,
      and the fragments belong to different molecules *i.e.*
      it is an **intermolecular** interaction.

         


.. oe:namespace:: OEBio

.. _OEBio_OEChelatorInteractionHint:

.. oe:class:: OEChelatorInteractionHint

   .. oe:api::

      class OEChelatorInteractionHint : public OEInteractionHintTypeBase

   The :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>` class represents
   a built-in type that identifies interactions stored in an
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object as
   **chelator (metal)** interactions (inter- and intramolecular).

   .. seealso::

      * :oe:constns:`OEBio::OEChelatorInteractionHintType` namespace for specific **chelator** interaction types
      * :ref:`OEIsChelatorInteractionHint <OEBio_OEIsChelatorInteractionHint>` predicate
      * :ref:`OEIsIntramolecularChelatorInteractionHint <OEBio_OEIsIntramolecularChelatorInteractionHint>` predicate
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class

      To perceive **chelator** interactions:

      * :oe:func:`OEBio::OEPerceiveInteractionHints` function
      * :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class and its
        :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxMetalBondDistance` method

   The following methods are publicly inherited from :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`:

   =================================================================== =================================================================== ===================================================================
   :oe:meth:`operator=<OEBio::OEInteractionHintTypeBase::operator=>`   :oe:meth:`operator==<OEBio::OEInteractionHintTypeBase::operator==>` :oe:meth:`GetName<OEBio::OEInteractionHintTypeBase::GetName>`
   :oe:meth:`operator!=<OEBio::OEInteractionHintTypeBase::operator!=>` :oe:meth:`CreateCopy<OEBio::OEInteractionHintTypeBase::CreateCopy>` :oe:meth:`IsValid<OEBio::OEInteractionHintTypeBase::IsValid>`
   =================================================================== =================================================================== ===================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEChelatorInteractionHint(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            OEChelatorInteractionHint(type: int) -> OEChelatorInteractionHint

      Constructor to create a **chelator** interaction type with the
      given parameter.

      *type*
         This value has to be from the :oe:constns:`OEBio::OEChelatorInteractionHintType`
         namespace.

      .. note::

         Two :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>` objects with different
         types from the :oe:constns:`OEBio::OEChelatorInteractionHintType`
         namespace are considered to be different.

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

         .. oe:api::

            OEChelatorInteractionHint(const OEChelatorInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEChelatorInteractionHint(rhs: OEChelatorInteractionHint) -> OEChelatorInteractionHint

      Copy Constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEChelatorInteractionHint &operator=(const OEChelatorInteractionHint &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintTypeBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintTypeBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: GetChelatorType

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

         .. oe:api::

            unsigned int GetChelatorType() const

      .. oe:language:: python

         .. oe:api:: python

            GetChelatorType() -> int

      Returns the type of the :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
      object.
      The return value is taken from the :oe:constns:`OEBio::OEChelatorInteractionHintType`
      namespace.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEInteractionHintFragment *,
                         const OEInteractionHintFragment *) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHintFragment,
                    arg3: OEInteractionHintFragment) -> bool

      Evaluates whether the two given fragments would form a valid
      **chelator** interaction when added to an
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

      It checks that each fragment contains exactly one atom,
      and the fragments belong to different molecules *i.e.*
      it is an **intermolecular** interaction.


.. oe:namespace:: OEBio

.. _OEBio_OEClashInteractionHint:

.. oe:class:: OEClashInteractionHint

   .. oe:api::

      class OEClashInteractionHint : public OEInteractionHintTypeBase

   The :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>` class represents
   a built-in type that identifies interactions stored in an
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object as intermolecular
   **clash** interactions.

   .. seealso::

      * :ref:`OEIsClashInteractionHint <OEBio_OEIsClashInteractionHint>` predicate
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class

      To perceive **clash** interactions:

      * :oe:func:`OEBio::OEPerceiveInteractionHints` function
      * :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class and its
        :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` method

   The following methods are publicly inherited from :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`:

   =================================================================== =================================================================== ===================================================================
   :oe:meth:`operator=<OEBio::OEInteractionHintTypeBase::operator=>`   :oe:meth:`operator==<OEBio::OEInteractionHintTypeBase::operator==>` :oe:meth:`GetName<OEBio::OEInteractionHintTypeBase::GetName>`
   :oe:meth:`operator!=<OEBio::OEInteractionHintTypeBase::operator!=>` :oe:meth:`CreateCopy<OEBio::OEInteractionHintTypeBase::CreateCopy>` :oe:meth:`IsValid<OEBio::OEInteractionHintTypeBase::IsValid>`
   =================================================================== =================================================================== ===================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEClashInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEClashInteractionHint() -> OEClashInteractionHint

      Default constructor.

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

         .. oe:api::

            OEClashInteractionHint(const OEClashInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEClashInteractionHint(rhs: OEClashInteractionHint) -> OEClashInteractionHint

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEClashInteractionHint &operator=(const OEClashInteractionHint &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintTypeBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintTypeBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEInteractionHintFragment *,
                         const OEInteractionHintFragment *) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHintFragment,
                    arg3: OEInteractionHintFragment) -> bool

      Evaluates whether the two given fragments would form a valid
      **clash** interaction when added to an
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

      It checks that each fragment contains exactly one atom,
      and the fragments belong to different molecules *i.e.*
      it is an **intermolecular** interaction.


.. oe:namespace:: OEBio

.. _OEBio_OEContactInteractionHint:

.. oe:class:: OEContactInteractionHint

   .. oe:api::

      class OEContactInteractionHint : public OEInteractionHintTypeBase

   The :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>` class represents
   a built-in type that identifies interactions stored in an
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object as intermolecular
   **contact** interactions.

   .. seealso::

      * :ref:`OEIsContactInteractionHint <OEBio_OEIsContactInteractionHint>` predicate
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class

      To perceive **contact** interactions:

      * :oe:func:`OEBio::OEPerceiveInteractionHints` function
      * :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class and its methods:

        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction`

   The following methods are publicly inherited from :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`:

   =================================================================== =================================================================== ===================================================================
   :oe:meth:`operator=<OEBio::OEInteractionHintTypeBase::operator=>`   :oe:meth:`operator==<OEBio::OEInteractionHintTypeBase::operator==>` :oe:meth:`GetName<OEBio::OEInteractionHintTypeBase::GetName>`
   :oe:meth:`operator!=<OEBio::OEInteractionHintTypeBase::operator!=>` :oe:meth:`CreateCopy<OEBio::OEInteractionHintTypeBase::CreateCopy>` :oe:meth:`IsValid<OEBio::OEInteractionHintTypeBase::IsValid>`
   =================================================================== =================================================================== ===================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEContactInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEContactInteractionHint() -> OEContactInteractionHint

      Default constructor.

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

         .. oe:api::

            OEContactInteractionHint(const OEContactInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEContactInteractionHint(rhs: OEContactInteractionHint) -> OEContactInteractionHint

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEContactInteractionHint &operator=(const OEContactInteractionHint &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintTypeBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintTypeBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEInteractionHintFragment *,
                         const OEInteractionHintFragment *) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHintFragment,
                    arg3: OEInteractionHintFragment) -> bool

      Evaluates whether the two given fragments would form a valid
      **contact** interaction when added to an
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

      It checks that each fragment contains exactly one atom,
      and the fragments belong to different molecules *i.e.*
      it is an **intermolecular** interaction.


.. oe:namespace:: OEBio

.. _OEBio_OECovalentInteractionHint:

.. oe:class:: OECovalentInteractionHint

   .. oe:api::

      class  OECovalentInteractionHint : public OEInteractionHintTypeBase

   The :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>` class represents
   a built-in type that identifies interactions stored in an
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object as intermolecular
   **covalent** interactions.

   .. seealso::

      * :ref:`OEIsCovalentInteractionHint <OEBio_OEIsCovalentInteractionHint>` predicate
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class

      To perceive **covalent** interactions:

      * :oe:func:`OEBio::OEPerceiveInteractionHints` function
      * :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class and its methods:

        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCovalentFraction`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinCovalentFraction`

   The following methods are publicly inherited from :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`:
   
   =================================================================== =================================================================== =================================================================== 
   :oe:meth:`operator=<OEBio::OEInteractionHintTypeBase::operator=>`   :oe:meth:`operator==<OEBio::OEInteractionHintTypeBase::operator==>` :oe:meth:`GetName<OEBio::OEInteractionHintTypeBase::GetName>`
   :oe:meth:`operator!=<OEBio::OEInteractionHintTypeBase::operator!=>` :oe:meth:`CreateCopy<OEBio::OEInteractionHintTypeBase::CreateCopy>` :oe:meth:`IsValid<OEBio::OEInteractionHintTypeBase::IsValid>`
   =================================================================== =================================================================== =================================================================== 

   .. oe:method:: Constructors

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

         .. oe:api::

            OECovalentInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OECovalentInteractionHint() -> OECovalentInteractionHint

      Default constructor.

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

         .. oe:api::

            OECovalentInteractionHint(const OECovalentInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OECovalentInteractionHint(rhs: OECovalentInteractionHint) -> OECovalentInteractionHint

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECovalentInteractionHint &operator=(const OECovalentInteractionHint &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintTypeBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintTypeBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEInteractionHintFragment *,
                         const OEInteractionHintFragment *) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHintFragment,
                    arg3: OEInteractionHintFragment) -> bool

      Evaluates whether the two given fragments would form a valid
      **covalent** interaction when added to an
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

      It checks that each fragment contains exactly one atom,
      and the fragments belong to different molecules *i.e.*
      it is an **intermolecular** interaction.


.. oe:namespace:: OEBio

.. _OEBio_OECrystalSymmetryParams:

.. oe:class:: OECrystalSymmetryParams

   .. oe:api::

      class OECrystalSymmetryParams

   This class represents the :ref:`OECrystalSymmetryParams <OEBio_OECrystalSymmetryParams>` class
   that stores crystal symmetry parameters:

   * standard cell lengths
   * cell angles 'alpha', 'beta' and 'gamma' and
   * spacegroup number
   * z-value

   .. seealso::

      * :oe:func:`OEBio::OEGetCrystalSymmetry` function
      * :oe:func:`OEBio::OESetCrystalSymmetry` function

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OECrystalSymmetryParams()

      .. oe:language:: python

         .. oe:api:: python

            OECrystalSymmetryParams() -> OECrystalSymmetryParams

      Default constructor.

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

         .. oe:api::

            OECrystalSymmetryParams(float a, float b, float c, float alpha,
                                    float beta, float gamma,
                                    unsigned int sgnumber,
                                    unsigned int zvalue = 0u)

      .. oe:language:: python

         .. oe:api:: python

            OECrystalSymmetryParams(a: float, b: float, c: float, alpha: float,
                                    beta: float, gamma: float, sgnumber: int,
                                    zvalue: int = 0) -> OECrystalSymmetryParams

      Constructors an :ref:`OECrystalSymmetryParams <OEBio_OECrystalSymmetryParams>` object with the given values.

   .. oe:method:: GetA

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

         .. oe:api::

            float GetA() const

      .. oe:language:: python

         .. oe:api:: python

            GetA() -> float

   .. oe:method:: GetAlpha

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

         .. oe:api::

            float GetAlpha() const

      .. oe:language:: python

         .. oe:api:: python

            GetAlpha() -> float

   .. oe:method:: GetB

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

         .. oe:api::

            float GetB() const

      .. oe:language:: python

         .. oe:api:: python

            GetB() -> float

   .. oe:method:: GetBeta

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

         .. oe:api::

            float GetBeta() const

      .. oe:language:: python

         .. oe:api:: python

            GetBeta() -> float

   .. oe:method:: GetC

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

         .. oe:api::

            float GetC() const

      .. oe:language:: python

         .. oe:api:: python

            GetC() -> float

   .. oe:method:: GetGamma

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

         .. oe:api::

            float GetGamma() const

      .. oe:language:: python

         .. oe:api:: python

            GetGamma() -> float

   .. oe:method:: GetSpaceGroup

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

         .. oe:api::

            unsigned int GetSpaceGroup() const

      .. oe:language:: python

         .. oe:api:: python

            GetSpaceGroup() -> int

   .. oe:method:: GetZValue

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

         .. oe:api::

            unsigned int GetZValue() const

      .. oe:language:: python

         .. oe:api:: python

            GetZValue() -> int

   .. oe:method:: SetA

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

         .. oe:api::

            void SetA(float a)

      .. oe:language:: python

         .. oe:api:: python

            SetA(a: float) -> None

   .. oe:method:: SetAlpha

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

         .. oe:api::

            void SetAlpha(float alpha)

      .. oe:language:: python

         .. oe:api:: python

            SetAlpha(alpha: float) -> None

   .. oe:method:: SetB

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

         .. oe:api::

            void SetB(float b)

      .. oe:language:: python

         .. oe:api:: python

            SetB(b: float) -> None

   .. oe:method:: SetBeta

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

         .. oe:api::

            void SetBeta(float beta)

      .. oe:language:: python

         .. oe:api:: python

            SetBeta(beta: float) -> None

   .. oe:method:: SetC

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

         .. oe:api::

            void SetC(float c)

      .. oe:language:: python

         .. oe:api:: python

            SetC(c: float) -> None

   .. oe:method:: SetGamma

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

         .. oe:api::

            void SetGamma(float gamma)

      .. oe:language:: python

         .. oe:api:: python

            SetGamma(gamma: float) -> None

   .. oe:method:: SetSpaceGroup

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

         .. oe:api::

            void SetSpaceGroup(unsigned int sgnumber)

      .. oe:language:: python

         .. oe:api:: python

            SetSpaceGroup(sgnumber: int) -> None

   .. oe:method:: SetZValue

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

         .. oe:api::

            void SetZValue(unsigned int zvalue)

      .. oe:language:: python

         .. oe:api:: python

            SetZValue(zvalue: int) -> None


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. _OEDesignUnit_bio:

.. _OEBio_OEDesignUnit:

.. oe:class:: OEDesignUnit

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEDesignUnit : public OESystem::OEBase

   This is a container class derived from :ref:`OEBase <OESystem_OEBase>`
   that holds all molecules needed to construct a model-ready biomolecular system.

   .. oe:method:: Constructors

      .. oe:language:: c++

         .. oe:api:: c++

            OEDesignUnit()

         Default constructor.

         .. oe:api:: c++

            OEDesignUnit(const OEDesignUnit& rhs)

         Copy constructor.

      .. oe:language:: python

         .. oe:api:: python

            OEDesignUnit() -> OEDesignUnit
            OEDesignUnit(rhs: OEDesignUnit) -> OEDesignUnit
            OEDesignUnit(target: Union[OEGraphMol,OEMol,OEQMol],
                         siteResidues: OEStringVector,
                         solvent: Union[OEGraphMol,OEMol,OEQMol]=OEGraphMol(),
                         cofactors: Union[OEGraphMol,OEMol,OEQMol]=OEGraphMol(),
                         targetID: int) -> OEDesignUnit
            OEDesignUnit(target: Union[OEGraphMol,OEMol,OEQMol],
                         ligand: Union[OEGraphMol,OEMol,OEQMol],
                         solvent: Union[OEGraphMol,OEMol,OEQMol]=OEGraphMol(),
                         cofactors: Union[OEGraphMol,OEMol,OEQMol]=OEGraphMol(),
                         targetID: int) -> OEDesignUnit

         Default constructor.

   .. oe:method:: Molecule constructors

      .. note::

         Molecule constructors are intended for already prepared molecules. They requires a target structure, as well as either a ligand or a list of binding site residues. Solvent and co-factors are optional, and are only set if the molecules passed are valid.
         The target molecule is not split into components and no structure preparation take place. A title will be generated based on the names of the provided molecules, but can be set manually afterwards.
         
      .. oe:api::

         OEDesignUnit(const OEChem::OEMolBase& target,
                      const OEChem::OEMolBase& ligand,
                      const OEChem::OEMolBase& solvent = OEChem::OEGraphMol(),
                      const OEChem::OEMolBase& cofactors = OEChem::OEGraphMol(),
                      const unsigned targetID = OEDesignUnitComponents::Protein)

      Target-ligand constructor

      .. oe:api::

         OEDesignUnit(const OEChem::OEMolBase& target,
                      const std::vector<std::string>& siteResidues,
                      const OEChem::OEMolBase& solvent = OEChem::OEGraphMol(),
                      const OEChem::OEMolBase& cofactors = OEChem::OEGraphMol(),
                      const unsigned targetID = OEDesignUnitComponents::Protein)

      Apo target constructor

   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api:: c++

            OEDesignUnit& operator=(const OEDesignUnit& rhs)

         Assignment operator

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++

         .. oe:api:: c++
         
            operator bool() const

         Returns whether the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object is valid.

   .. _OEBio_OEDesignUnit_Clear:

   .. oe:method:: Clear

      .. oe:language:: c++
      
         .. oe:api:: c++

            void Clear()

         Resets the  :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object to its initial state. This method
         deletes all internally stored molecules, and clears any
         :ref:`OEBase <OESystem_OEBase>` data from the object.

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

         Resets the  :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object to its initial state. This method
         deletes all internally stored molecules, and clears any
         :ref:`OEBase <OESystem_OEBase>` data from the object.

   .. _OEBio_OEDesignUnit_CreateCopy:

   .. oe:method:: CreateCopy

      .. oe:language:: c++
      
         .. oe:api:: c++

            OEBio::OEDesignUnit* CreateCopy() const

         Deep copy constructor that returns a copy of the object. The
         memory for the returned  :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object is dynamically
         allocated and owned by the caller.

      .. oe:language:: python
      
         .. oe:api:: python

            CreateCopy() -> OEDesignUnit

         Deep copy constructor that returns a copy of the object. The
         memory for the returned  :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object is dynamically
         allocated and owned by the caller.

   .. _OEBio_OEDesignUnit_GetComponent:

   .. oe:method:: GetComponent

      .. oe:language:: c++
      
         .. oe:api:: c++

            const OEChem::OEMolBase& GetComponent(unsigned componentID) const

         Returns a const reference to the molecule on the
         :ref:`OEDesignUnit <OEBio_OEDesignUnit>` that is associated with the input
         componentID. Note that this function only works for single molecule components (e.g. protein, ligand, etc).
         This function requires an empty :ref:`OEMolBase <OEChem_OEMolBase>` or it will clear the incoming molecule.

         .. oe:api:: c++

            bool GetComponent(OEMolBase& mol, unsigned componentID) const

         Returns success based on a valid copy of the molecule in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object that is associated with the input
         componentID.

      .. oe:language:: python

         .. oe:api:: python

            GetComponent(molecule: Union[OEGraphMol,OEMol,OEQMol],
                         componentID: int) -> bool

         Returns a const reference to the molecule on the
         :ref:`OEDesignUnit <OEBio_OEDesignUnit>` that is associated with the input
         componentID. Note that this function only works for single molecule components (e.g. protein, ligand, etc).
         This function requires an empty :ref:`OEMolBase <OEChem_OEMolBase>` or it will clear the incoming molecule.

   .. _OEBio_OEDesignUnit_GetComponentID:

   .. oe:method:: GetComponentID

      .. oe:language:: c++

         .. oe:api:: c++

            unsigned GetComponentID(const std::string& componentTag) const

         Returns the internal unsigned integer representation of the
         componentTag string from the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python

         .. oe:api:: python

            GetComponentID(componentTag: str) -> int

         Returns the internal unsigned integer representation of the
         componentTag string from the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_GetComponentTag:

   .. oe:method:: GetComponentTag

      .. oe:language:: c++
      
         .. oe:api:: c++

            std::string GetComponentTag(unsigned componentID) const

         Returns the string tag representation of the componentID
         unsigned integer from the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python
      
         .. oe:api:: python

            GetComponentTag(componentID: int) -> str

         Returns the string tag representation of the componentID
         unsigned integer from the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_GetComponents:

   .. oe:method:: GetComponents

      .. oe:language:: c++

         .. oe:api:: c++

            bool GetComponents(OEChem::OEMolBase& mol, unsigned componentMask,
                               bool bondCovalent = true,
                               const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred = OEChem::OEIsTrueAtom())) const

         The function creates a single output mol from the components
         given in the componentMask bit mask. The bit mask can be
         constructed using unsigned integers stored in the
         :oe:constns:`OEBio::OEDesignUnitComponents` namespace. The
         function returns a boolean value to alert if the operation was
         successful. Note that this function only works for a list of components (e.g. other_ligands, excipients, etc).
         The optional predicate can be used to subset some of the components
         in the specified bit mask. The predicate does not have to be complete,
         e.g. two water molecules can be specified to subset the solvent category,
         but that will not subset the protein component also included in that mask.
         In essence the predicate is checked to see if it matches part of a design unit
         component and only in this case does it take effect. 

      .. oe:language:: python

         .. oe:api:: python

            GetComponents(mol: Union[OEGraphMol,OEMol,OEQMol],
                          componentMask: int, bondCovalent: bool = True,
                          pred: OEUnaryAtomPred = OEIsTrueAtom()) -> bool

         The function creates a single output mol from the components
         given in the componentMask bit mask. The bit mask can be
         constructed using unsigned integers stored in the
         :oe:constns:`OEBio::OEDesignUnitComponents` namespace. The
         function returns a boolean value to alert if the operation was
         successful. Note that this function only works for a list of components (e.g. other_ligands, excipients, etc).
         The optional predicate can be used to subset some of the components
         in the specified bit mask. The predicate does not have to be complete,
         e.g. two water molecules can be specified to subset the solvent category,
         but that will not subset the protein component also included in that mask.
         In essence the predicate is checked to see if it matches part of a design unit
         component and only in this case does it take effect. 

   .. _OEBio_OEDesignUnit_GetComponentsWithin:

   .. oe:method:: GetComponentsWithin

      .. oe:language:: c++
         
         .. oe:api:: c++

            bool GetComponentsWithin(OEChem::OEMolBase& mol,
                                     unsigned componentMask = OEDesignUnitComponents::Solvent,
                                     unsigned withinMask = OEDesignUnitComponents::Protein,
                                     double dist = 5.0, bool includeself,
                                     bool bondCovalent = true) const

         The function creates a single output mol from the components
         given in the componentMask bit mask that fall within a dist
         distance of components given in the withinMask bit mask. All bit
         masks can be constructed using unsigned integers stored in the
         :oe:constns:`OEBio::OEDesignUnitComponents` namespace. If the
         boolean bondCovalent flag is set, all components that should be
         covalently bonded will have bonded added in the output mol. The
         function returns a boolean value to alert if the operation was
         successful.

      .. oe:language:: python
         
         .. oe:api:: python

            GetComponentsWithin(mol: Union[OEGraphMol,OEMol,OEQMol],
                                componentMask: int, withinMask: int,
                                dist: float = 5.0, includeSelf: bool = False,
                                bondCovalent: bool = True) -> bool

         The function creates a single output mol from the components
         given in the componentMask bit mask that fall within a dist
         distance of components given in the withinMask bit mask. All bit
         masks can be constructed using unsigned integers stored in the
         :oe:constns:`OEBio::OEDesignUnitComponents` namespace. If the
         boolean bondCovalent flag is set, all components that should be
         covalently bonded will have bonded added in the output mol. The
         function returns a boolean value to alert if the operation was
         successful.

   .. _OEBio_OEDesignUnit_GetDataType:

   .. oe:method:: GetDataType

      .. oe:language:: c++

         .. oe:api:: c++

            const void* GetDataType() const

         This pure virtual function is used to perform run-time type
         identification. The value returned by the method should be
         equivalent to the value returned by :oe:func:`OESystem::OEGetDataType`
         using the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` derived class type as the template argument.

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

         This pure virtual function is used to perform run-time type
         identification. The value returned by the method should be
         equivalent to the value returned by :oe:func:`OESystem::OEGetDataType`
         using the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` derived class type as the template argument.

   .. _OEBio_OEDesignUnit_GetIDs:

   .. oe:method:: GetIDs

      .. oe:language:: c++

         .. oe:api:: c++

            const std::vector<unsigned> GetIDs() const

         Returns a vector of the component IDs stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python

         .. oe:api:: python

            GetIDs() -> OEUIntVector
         
         Returns a vector of the component IDs stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_GetLigand:

   .. oe:method:: GetLigand

      .. oe:language:: c++

         .. oe:api::

            const OEChem::OEMolBase& GetLigand() const

         Returns a const reference to the ligand molecule on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python
      
         .. oe:api:: python

            GetLigand(molecule: Union[OEGraphMol,OEMol,OEQMol]) -> bool
      
         Returns success based on a valid copy of the ligand molecule in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:source:: extract_ligand_oedu.py
         :language: python
         :noindent:
         :frag: SNIPPET-ExtractLigandFromDesignUnit
      
      .. oe:language:: python

         Whole example script can be downloaded from :ref:`here<section_example_oebio_extract_ligand>`.

   .. _OEBio_OEDesignUnit_GetMetal:

   .. oe:method:: GetMetal

      .. oe:language:: c++

         .. oe:api:: c++

            const OEChem::OEMolBase& GetMetal() const

         Returns a const reference to the metal on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python
   
         .. oe:api:: python

            GetMetal(molecule: Union[OEGraphMol,OEMol,OEQMol]) -> bool

         Returns success based on a valid copy of the metal in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_GetNucleicAcid:

   .. oe:method:: GetNucleicAcid

      .. oe:language:: c++

         .. oe:api:: c++

            const OEChem::OEMolBase& GetNucleicAcid() const

         Returns a const reference to the nucleic acid molecule on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

         .. oe:api:: c++

            bool GetNucleicAcid(OEMolBase& mol) const
      
         Returns success based on a valid copy of the nucleic acid molecule in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.
      
      .. oe:language:: python
   
         .. oe:api:: python

            GetNucleicAcid(molecule: Union[OEGraphMol,OEMol,OEQMol]) -> bool
         
         Returns success based on a valid copy of the nucleic acid molecule in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_GetPDBMetaData:

   .. oe:method:: GetPDBMetaData

      .. oe:language:: c++

         .. oe:api:: c++

            bool OEDesignUnit::GetPDBMetaData(OEChem::OEMolBase& mol) const
      
         Returns success based on a valid copy of the PDB metadata in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.
      
      .. oe:language:: python
   
         .. oe:api:: python

            GetPDBMetaData(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
         
         Returns success based on a valid copy of the PDB metadata in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object. 

         .. seealso::

            * :ref:`OEResidueToString <OEChem_OEResidueToString>` function.

   .. _OEBio_OEDesignUnit_GetPackingResidues:

   .. oe:method:: GetPackingResidues

      .. oe:language:: c++

         .. oe:api:: c++

            const OEChem::OEMolBase& GetPackingResidues() const

         Returns a const reference to the packing residue molecule on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

         .. oe:api:: c++

            bool GetPackingResidues(OEMolBase& mol) const

         Returns success based on a valid copy of the packing residue molecule in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python

         .. oe:api:: python

            GetPackingResidues(molecule: Union[OEGraphMol,OEMol,OEQMol]) -> bool

         Returns success based on a valid copy of the packing residue molecule in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_GetProtein:

   .. oe:method:: GetProtein

      .. oe:language:: c++
         
         .. oe:api:: c++

            const OEChem::OEMolBase& GetProtein() const

         Returns a const reference to the protein molecule on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.
         Note that this function requires an empty :ref:`OEMolBase <OEChem_OEMolBase>` or it will clear the incoming molecule.

         .. oe:api:: c++

            bool GetProtein(OEMolBase& mol) const
      
         Returns success based on a valid copy of the protein molecule in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python
         
         .. oe:api:: python

            GetProtein(molecule: Union[OEGraphMol,OEMol,OEQMol]) -> bool
      
         Returns success based on a valid copy of the protein molecule in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.
         Note that this function requires an empty :ref:`OEMolBase <OEChem_OEMolBase>` or it will clear the incoming molecule.

   .. _OEBio_OEDesignUnit_GetReceptor:

   .. oe:method:: GetReceptor

      .. oe:language:: c++

         .. oe:api:: c++

            const OEBio::OEReceptor& GetReceptor() const
            OEBio::OEReceptor& GetReceptor()

         Returns a reference to the receptor on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

         .. oe:api:: c++

            bool OEDesignUnit::GetReceptor(OEBio::OEReceptor& receptor) const

         Returns success based on a valid copy of the receptor in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python

         .. oe:api:: python

            GetReceptor() -> OEReceptor

         Returns a reference to the receptor on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_GetSiteResidues:

   .. oe:method:: GetSiteResidues

      .. oe:language:: c++
         
         .. oe:api:: c++

            const std::vector<std::string> GetSiteResidues() const

         Returns a vector of the site residue strings stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object. This function calls the :ref:`OEResidueToString <OEChem_OEResidueToString>` function with ":" delimiter.

      .. oe:language:: python
         
         .. oe:api:: python

            GetSiteResidues() -> OEStringVector

         Returns a vector of the site residue strings stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.  This function calls the :ref:`OEResidueToString <OEChem_OEResidueToString>` function with ":" delimiter.

   .. _OEBio_OEDesignUnit_GetSolvent:

   .. oe:method:: GetSolvent

      .. oe:language:: c++
   
         .. oe:api:: c++

            const OEChem::OEMolBase& GetSolvent() const

         Returns a const reference to the solvent molecule on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

         .. oe:api:: c++

            bool GetSolvent(OEMolBase& mol) const
      
         Returns success based on a valid copy of the solvent molecule in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python
   
         .. oe:api:: python

            GetSolvent(molecule: Union[OEGraphMol,OEMol,OEQMol]) -> bool
      
         Returns success based on a valid copy of the solvent molecule in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_GetStructureQuality:

   .. oe:method:: GetStructureQuality

      .. oe:language:: c++
   
         .. oe:api:: c++

            const OEBio::OEStructureQuality& GetStructureQuality() const

         Returns the :ref:`OEStructureQuality <OEBio_OEStructureQuality>` class stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python
   
         .. oe:api:: python

            GetStructureQuality() -> OEStructureQuality

         Returns the :ref:`OEStructureQuality <OEBio_OEStructureQuality>` class stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. seealso::

         * :ref:`OEStructureQuality <OEBio_OEStructureQuality>` class

   .. _OEBio_OEDesignUnit_GetTransform:

   .. oe:method:: GetTransform

      .. oe:language:: c++
      
         .. oe:api:: c++

            const OEChem::OETrans& GetTransform() const

         Returns the :ref:`OETrans <OEChem_OETrans>` class stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

         .. oe:api:: c++

            bool GetTransform(OEChem::OETrans& trans) const

         Returns success based on a valid copy of the input :ref:`OETrans <OEChem_OETrans>` object in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python
      
         .. oe:api:: python

            GetTransform(trans: OETrans) -> bool

         Returns success based on a valid copy of the input :ref:`OETrans <OEChem_OETrans>` object in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. seealso::

         * :ref:`OETrans <OEChem_OETrans>` class

   .. _OEBio_OEDesignUnit_GetTaggedComponents:

   .. oe:method:: GetTaggedComponents

      .. oe:language:: c++
      
         .. oe:api:: c++

            OESystem::OEIterBase<std::pair<std::string, const OEChem::OEMolBase &> > *
            GetTaggedComponents(unsigned componentMask) const

         Returns an :ref:`OEIter <OESystem_OEIter>` of all molecules and
         corresponding molecular tags stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
         object. A bit mask of desired components can be constructed from
         constants in the :oe:constns:`OEBio::OEDesignUnitComponents`
         namespace and be passed in via the componentMask argument.

      .. oe:language:: python
      
         .. oe:api:: python

            GetTaggedComponents(componentMask: int) -> Iterable[Tuple[int, OEMolBase]]

         Returns an :ref:`OEIter <OESystem_OEIter>` of all molecules and
         corresponding molecular tags stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
         object. A bit mask of desired components can be constructed from
         constants in the :oe:constns:`OEBio::OEDesignUnitComponents`
         namespace and be passed in via the componentMask argument.

   .. _OEBio_OEDesignUnit_GetTags:

   .. oe:method:: GetTags

      .. oe:language:: c++

         .. oe:api:: c++

            const std::vector<std::string> GetTags() const

         Returns a vector of the tags of the molecules stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python

         .. oe:api:: python

            GetTags() -> OEStringVector

         Returns a vector of the tags of the molecules stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_GetTarget:

   .. oe:method:: GetTarget

      .. oe:language:: c++

         .. oe:api:: c++

            const OEChem::OEMolBase& GetTarget() const

         Returns a const reference to target molecule on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

         .. oe:api:: c++

            bool GetTarget(OEMolBase& mol) const
         
         Returns success based on a valid copy of the target molecule in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python

         .. oe:api:: python

            GetTarget(molecule: Union[OEGraphMol,OEMol,OEQMol]) -> bool
         
         Returns success based on a valid copy of the target molecule in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_GetTargetComponentID:

   .. oe:method:: GetTargetComponentID

      .. oe:language:: c++
   
         .. oe:api:: c++

            unsigned GetTargetComponentID() const

         Returns the component ID from the
         :oe:constns:`OEBio::OEDesignUnitComponents` namespace of the
         target molecule on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python
   
         .. oe:api:: python

            GetTargetComponentID() -> int

         Returns the component ID from the
         :oe:constns:`OEBio::OEDesignUnitComponents` namespace of the
         target molecule on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_GetTargetComponentTag:

   .. oe:method:: GetTargetComponentTag

      .. oe:language:: c++
      
         .. oe:api:: c++

            std::string GetTargetComponentTag() const

         Returns the string tag of the title of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python
      
         .. oe:api:: python

            GetTargetComponentTag() -> str

         Returns the string tag of the title of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_GetTitle:

   .. oe:method:: GetTitle

      .. oe:language:: c++
      
         .. oe:api:: c++

            std::string GetTitle() const

         Returns the title of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python
      
         .. oe:api:: python

            GetTitle() -> str

         Returns the title of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_GetAltLoc:

   .. oe:method:: GetAltLoc

      .. oe:language:: c++
      
         .. oe:api:: c++

            std::string GetAltLoc() const

         Returns the alternate location code used to generate the :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.

      .. oe:language:: python
      
         .. oe:api:: python

            GetAltLoc() -> str

         Returns the alternate location code used to generate the :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.

   .. _OEBio_OEDesignUnit_HasAltLoc:

   .. oe:method:: HasAltLoc

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasAltLoc() const

         Checks that the alternate locations flag on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

      .. oe:language:: python

         .. oe:api:: python

            HasAltLoc(OEDesignUnit self) -> bool

         Checks that the alternate locations flag on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

   .. _OEBio_OEDesignUnit_HasComponent:

   .. oe:method:: HasComponent

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasComponent(unsigned componentID) const

         Checks that a molecule given by the componentID from the
         :oe:constns:`OEBio::OEDesignUnitComponents` namespace has been
         set on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python

         .. oe:api:: python

            HasComponent(componentID: int) -> bool

         Checks that a molecule given by the componentID from the
         :oe:constns:`OEBio::OEDesignUnitComponents` namespace has been
         set on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_HasLigand:

   .. oe:method:: HasLigand

      .. oe:language:: c++

         .. oe:api:: c++
         
            bool HasLigand() const

         Checks that the ligand molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

      .. oe:language:: python

         .. oe:api:: python

            HasLigand() -> bool

         Checks that the ligand molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

   .. _OEBio_OEDesignUnit_HasMetal:

   .. oe:method:: HasMetal

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasMetal() const

         Checks that the metal molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

      .. oe:language:: python

         .. oe:api:: python

            HasMetal() -> bool

         Checks that the metal molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

   .. _OEBio_OEDesignUnit_HasNucleicAcid:

   .. oe:method:: HasNucleicAcid

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasNucleicAcid() const

         Checks that the nucleic acid molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

      .. oe:language:: python

         .. oe:api:: python

            HasNucleicAcid() -> bool

         Checks that the nucleic acid molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

   .. _OEBio_OEDesignUnit_HasPDBMetaData:

   .. oe:method:: HasPDBMetaData

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasPDBMetaData() const

         Checks that the PDB metadata of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

      .. oe:language:: python

         .. oe:api:: python

            HasPDBMetaData() -> bool

         Checks that the PDB metadata of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

   .. _OEBio_OEDesignUnit_HasPackingResidues:

   .. oe:method:: HasPackingResidues

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasPackingResidues() const

         Checks that the packing residue molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

      .. oe:language:: python

         .. oe:api:: python

            HasPackingResidues() -> bool

         Checks that the packing residue molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

   .. _OEBio_OEDesignUnit_HasProtein:

   .. oe:method:: HasProtein

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasProtein() const

         Checks that the protein molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

      .. oe:language:: python

         .. oe:api:: python

            HasProtein() -> bool

         Checks that the protein molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

   .. _OEBio_OEDesignUnit_HasReceptor:

   .. oe:method:: HasReceptor

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasReceptor() const

         Checks that the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object contains a valid receptor.

      .. oe:language:: python

         .. oe:api:: python

            HasReceptor() -> bool

         Checks that the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object contains a valid receptor.

   .. _OEBio_OEDesignUnit_HasSiteResidues:

   .. oe:method:: HasSiteResidues

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasSiteResidues() const

         Checks that the site residues of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

      .. oe:language:: python

         .. oe:api:: python

            HasSiteResidues() -> bool

         Checks that the site residues of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

   .. _OEBio_OEDesignUnit_HasSolvent:

   .. oe:method:: HasSolvent

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasSolvent() const

         Checks that the solvent molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

      .. oe:language:: python

         .. oe:api:: python

            HasSolvent() -> bool

         Checks that the solvent molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

   .. _OEBio_OEDesignUnit_HasStructureQuality:

   .. oe:method:: HasStructureQuality

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasStructureQuality() const

         Checks that the internal :ref:`OEStructureQuality <OEBio_OEStructureQuality>` object stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` has been set.

      .. oe:language:: python

         .. oe:api:: python

            HasStructureQuality() -> bool

         Checks that the internal :ref:`OEStructureQuality <OEBio_OEStructureQuality>` object stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` has been set.

   .. _OEBio_OEDesignUnit_HasTransform:

   .. oe:method:: HasTransform

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasTransform() const

         Checks that the internal :ref:`OETrans <OEChem_OETrans>` object stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` has been set.

      .. oe:language:: python

         .. oe:api:: python

            HasTransform() -> bool

         Checks that the internal :ref:`OETrans <OEChem_OETrans>` object stored on the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` has been set.

   .. _OEBio_OEDesignUnit_HasTarget:

   .. oe:method:: HasTarget

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasTarget() const

         Checks that the target molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

      .. oe:language::python

         .. oe:api:: python

            HasTarget(OEDesignUnit self) -> bool

         Checks that the target molecule of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

   .. _OEBio_OEDesignUnit_HasTitle:

   .. oe:method:: HasTitle

      .. oe:language:: c++

         .. oe:api:: c++

            bool HasTitle() const

         Checks that a title of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

      .. oe:language::python

         .. oe:api:: python

            HasTitle(OEDesignUnit self) -> bool

         Checks that a title of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object has been set.

   .. _OEBio_OEDesignUnit_IsDataType:

   .. oe:method:: IsDataType

      .. oe:language:: c++

         .. oe:api:: c++

            bool IsDataType(const void *) const

         Returns whether the type is the same as the instance this method is called on.

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

         Returns whether the type is the same as the instance this method is called on.

   .. _OEBio_OEDesignUnit_SetTitle:

   .. oe:method:: SetTitle

      .. oe:language:: c++

         .. oe:api:: c++

            bool SetTitle(const std::string& title)

         Sets the title of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(title: str) -> bool

         Sets the title of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. _OEBio_OEDesignUnit_SetSiteResidues:

   .. oe:method:: SetSiteResidues

      .. oe:language:: c++

         .. oe:api:: c++

            bool SetSiteResidues(const std::vector<OEChem::OEResidue>& siteResidues,
                                 const float threshold = 0.80f,
                                 const float addBox = 2.0f,
                                 const bool rearrangeComponents = false,
                                 const float siteSize = 5.0f)

         SetSiteResidues sets site residues from :oe:cls:`OEChem::OEResidue` objects, updates site-based components, and regenerates site-dependent interaction and style data.

      .. oe:language:: python

         .. oe:api:: python

            SetSiteResidues(siteResidues: OEResidueVector,
                            threshold: float = 0.80, addBox: float = 2.0,
                            rearrangeComponents: bool = False,
                            siteSize: float = 5.0) -> bool

         SetSiteResidues sets site residues from :oe:cls:`OEChem::OEResidue` objects, updates site-based components, and regenerates site-dependent interaction and style data.

      SetSiteResidues requires residues that are present in the current target component. SetSiteResidues returns ``False`` if ``siteResidues`` is empty, or if any residue in ``siteResidues`` is not found in the target.

      SetSiteResidues uses the optional parameters as follows:

      - The ``threshold`` option defines the minimum heavy-atom fraction of the current ligand that must fall inside the site box. Setting the value to 0.0 skips the ligand coverage validation.
      - The ``addBox`` option expands the site box before ligand coverage is evaluated.
      - The ``rearrangeComponents`` option controls whether components are re-arranged in the design unit based on whether the ligand coverage validation is true or false. 
        Setting ``rearrangeComponents`` to ``False`` causes SetSiteResidues to return ``False`` when ligand coverage is below ``threshold``. Setting the value to ``True``,
        allows component reassignment when ligand coverage is below ``threshold``. The current ligand is moved to ``OtherLigands`` and cofactors are moved to ``OtherCofactors``.
        The list of ``OtherLigands`` is then evaluated, and the best ligand that meets ``threshold`` can be promoted into the ligand component, with corresponding ``OtherCofactors`` moved to the ``Cofactors`` component.
      - ``siteSize`` controls how site-associated cofactors are determined.

      .. note::

         SetSiteResidues preserves an existing receptor only when at least one new site residue overlaps the previous site-residue set. SetSiteResidues clears the receptor when no overlap is found.

   .. _OEBio_OEDesignUnit_ClearReceptor:

   .. oe:method:: ClearReceptor

      .. oe:language:: c++

         .. oe:api:: c++

            bool ClearReceptor()

         Clears the stored :ref:`OEReceptor <OEBio_OEReceptor>` object.

      .. oe:language:: python

         .. oe:api:: python

            ClearReceptor() -> bool

         Clears the stored :ref:`OEReceptor <OEBio_OEReceptor>` object.

   .. _OEBio_OEDesignUnit_ClearComponent:

      .. oe:method:: ClearComponent

      .. oe:language:: c++

         .. oe:api:: c++

            bool ClearComponent(const std::string& componentTag,
                                int listIndex = -1)
            bool ClearComponent(unsigned componentID, int listIndex = -1)

         Clears a specified component.
         The listIndex is intended for listComponents, e.g. co-factors.
         If the listIndex is -1 the entire list is removed, otherwise only the 
         co-factor with the given index is removed.

      .. oe:language:: python

         .. oe:api:: python

            ClearComponent(componentTag: str, listIndex: int = -1) -> bool
            ClearComponent(componentID: int, listIndex: int = -1) -> bool

         Clears a specified component.
         The listIndex is intended for listComponents, e.g. co-factors.
         If the listIndex is -1 the entire list is removed, otherwise only the 
         co-factor with the given index is removed.


.. oe:namespace:: OEBio

.. _OEBio_OEHBondInteractionHint:

.. oe:class:: OEHBondInteractionHint

   .. oe:api::

      class OEHBondInteractionHint : public OEInteractionHintTypeBase

   The :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` class represents
   a built-in type that identifies interactions stored in an
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object as
   **hydrogen bond** interactions (inter- and intramolecular).

   .. seealso::

      * :oe:constns:`OEBio::OEHBondInteractionHintType` namespace for specific **hydrogen bond** interaction types
      * :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` predicate
      * :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>` predicate
      * :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>` predicate
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class

      To perceive **hydrogen bond** interactions:

      * :oe:func:`OEBio::OEPerceiveInteractionHints` function
      * :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class and its methods:

        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedAngle`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedDistance`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction`

   The following methods are publicly inherited from :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`:

   =================================================================== =================================================================== ===================================================================
   :oe:meth:`operator=<OEBio::OEInteractionHintTypeBase::operator=>`   :oe:meth:`operator==<OEBio::OEInteractionHintTypeBase::operator==>` :oe:meth:`GetName<OEBio::OEInteractionHintTypeBase::GetName>`
   :oe:meth:`operator!=<OEBio::OEInteractionHintTypeBase::operator!=>` :oe:meth:`CreateCopy<OEBio::OEInteractionHintTypeBase::CreateCopy>` :oe:meth:`IsValid<OEBio::OEInteractionHintTypeBase::IsValid>`
   =================================================================== =================================================================== ===================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHBondInteractionHint(unsigned int type, bool charged = false)

      .. oe:language:: python

         .. oe:api:: python

            OEHBondInteractionHint(type: int, charged: bool = False) -> OEHBondInteractionHint

      *type*
         This value has to be from the :oe:constns:`OEBio::OEHBondInteractionHintType`
         namespace.

      .. note::

         Two :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` objects with different
         types from the :oe:constns:`OEBio::OEHBondInteractionHintType`
         namespace and/or with different charge options are considered to be different.

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

         .. oe:api::

            OEHBondInteractionHint(const OEHBondInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHBondInteractionHint(rhs: OEHBondInteractionHint) -> OEHBondInteractionHint

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHBondInteractionHint &operator=(const OEHBondInteractionHint &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintTypeBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintTypeBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: GetHBondType

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

         .. oe:api::

            unsigned int GetHBondType() const

      .. oe:language:: python

         .. oe:api:: python

            GetHBondType() -> int

      Returns the type of the :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
      object.
      The return value is taken from the :oe:constns:`OEBio::OEHBondInteractionHintType`
      namespace.

   .. oe:method:: IsCharged

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

         .. oe:api::

            bool IsCharged() const

      .. oe:language:: python

         .. oe:api:: python

            IsCharged() -> bool

      Returns whether or not the :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
      object represents a charged interaction.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEInteractionHintFragment *,
                         const OEInteractionHintFragment *) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHintFragment,
                    arg3: OEInteractionHintFragment) -> bool

      Evaluates whether the two given fragments would form a valid
      **hydrogen bond** interaction when added to an
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

      Interactions with the :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` type
      can be either **intermolecular** or **intramolecular**.


.. oe:namespace:: OEBio

.. _OEBio_OEHalogenBondInteractionHint:

.. oe:class:: OEHalogenBondInteractionHint

   .. oe:api::

      class OEHalogenBondInteractionHint : public OEInteractionHintTypeBase

   The :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` class represents
   a built-in type that identifies interactions stored in an
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object as
   **halogen bond** interactions (inter- and intramolecular).

   .. seealso::

      * :oe:constns:`OEBio::OEHalogenBondInteractionHintType` namespace for specific **halogen-bond** interaction types
      * :ref:`OEIsHalogenBondInteractionHint <OEBio_OEIsHalogenBondInteractionHint>` predicate
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class

      To perceive **halogen bond** interactions:

      * :oe:func:`OEBio::OEPerceiveInteractionHints` function
      * :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class and its methods:

        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHalogenAngle`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHalogenBondDistance`

   The following methods are publicly inherited from :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`:

   =================================================================== =================================================================== ===================================================================
   :oe:meth:`operator=<OEBio::OEInteractionHintTypeBase::operator=>`   :oe:meth:`operator==<OEBio::OEInteractionHintTypeBase::operator==>` :oe:meth:`GetName<OEBio::OEInteractionHintTypeBase::GetName>`
   :oe:meth:`operator!=<OEBio::OEInteractionHintTypeBase::operator!=>` :oe:meth:`CreateCopy<OEBio::OEInteractionHintTypeBase::CreateCopy>` :oe:meth:`IsValid<OEBio::OEInteractionHintTypeBase::IsValid>`
   =================================================================== =================================================================== ===================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHalogenBondInteractionHint(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            OEHalogenBondInteractionHint(type: int) -> OEHalogenBondInteractionHint

      *type*
         This value has to be from the :oe:constns:`OEBio::OEHalogenBondInteractionHintType`
         namespace.

      .. note::

         Two :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` objects with different
         types from the :oe:constns:`OEBio::OEHalogenBondInteractionHintType`
         namespace and/or with different charge options are considered to be different.

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

         .. oe:api::

            OEHalogenBondInteractionHint(const OEHalogenBondInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHalogenBondInteractionHint(rhs: OEHalogenBondInteractionHint) -> OEHalogenBondInteractionHint

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHalogenBondInteractionHint &operator=(const OEHalogenBondInteractionHint &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintTypeBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintTypeBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEInteractionHintFragment *,
                         const OEInteractionHintFragment *) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHintFragment,
                    arg3: OEInteractionHintFragment) -> bool

      Evaluates whether the two given fragments would form a valid
      **halogen bond** interaction when added to an
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

      It checks that each fragment contains exactly one atom,
      and the fragments belong to different molecules *i.e.*
      it is an **intermolecular** interaction.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEHasAlternateLocation, HasAlternateLocation

.. _OEBio_OEHasAlternateLocation:

.. oe:class:: OEHasAlternateLocation

   .. oe:api::

      class OEHasAlternateLocation : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   .. seealso::

      :ref:`section_predicates_reside_data_functors` section

   This class represents `OEHasAlternateLocation`, a functor that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with an alternate location code.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHasAlternateLocation(const OEHasAlternateLocation& rhs)
            OEHasAlternateLocation(char confCode = '\0',
                                   bool acceptBlanks = false,
                                   bool caseSensitive = true)

      .. oe:language:: python

         .. oe:api:: python

            OEHasAlternateLocation(confCode: str = '\0',
                                   acceptBlanks: bool = False,
                                   caseSensitive: bool = True) -> OEHasAlternateLocation
            OEHasAlternateLocation(rhs: OEHasAlternateLocation) -> OEHasAlternateLocation

      Default and copy constructors.

      If a non-blank ``char`` is supplied, atoms with that alternate location code will be selected when the object is used in a predicate expression.
      If a non-blank ``char`` is not supplied, atoms with any non-blank alternate location code will be selected.

      If ``acceptBlanks`` is ``true``, then atoms with blank alternate location codes will also be selected.
      If ``caseSensitive`` is ``false``, then both upper- and lower-case versions of the ``confCode`` parameter will
      be tried in the match.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the :ref:`OEAtomBase <OEChem_OEAtomBase>` has a :ref:`OEResidue <OEChem_OEResidue>`
      and :oe:meth:`OEChem::OEResidue::GetAlternateLocation` returns a ``char`` that matches
      the values used in the :oe:meth:`OEBio::OEHasAlternateLocation::Constructors`.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryPredicate<OEChem::OEAtomBase>::base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasAlternateLocation

      Deep copy constructor that returns a copy of the object.
      The memory for the returned `OEHasAlternateLocation`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEBio

.. _OEBio_OEHasInteractionHint:

.. oe:class:: OEHasInteractionHint

   .. oe:api::

      class OEHasInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEHasInteractionHint <OEBio_OEHasInteractionHint>` functor that
   identifies interactions (:ref:`OEInteractionHint <OEBio_OEInteractionHint>`)
   with a specific atom (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   .. admonition:: Code Examples

      * :ref:`section_example_oebio_printinteractions` **OEChem TK** example
      * `Accessing Interaction Hint Information`_  **OpenEye Python Cookbook** recipe

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHasInteractionHint(const OEChem::OEAtomBase* atom)

      .. oe:language:: python

         .. oe:api:: python

            OEHasInteractionHint(arg2: OEAtomBase) -> OEHasInteractionHint

      Constructs the functor with the given atom.

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

         .. oe:api::

            OEHasInteractionHint(const OEHasInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHasInteractionHint(arg2: OEHasInteractionHint) -> OEHasInteractionHint

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHasInteractionHint &operator=(const OEHasInteractionHint &rhs)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(c: OEInteractionHint) -> bool

      Returns ``true``, if the atom with which the functor is constructed
      is stored in the given interaction.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasInteractionHint <OEBio_OEHasInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEHasInteractionHintType:

.. oe:class:: OEHasInteractionHintType

   .. oe:api::

      class OEHasInteractionHintType : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEHasInteractionHintType <OEBio_OEHasInteractionHintType>` functor that
   identifies connections (:ref:`OEInteractionHint <OEBio_OEInteractionHint>`)
   with a specific type (:ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`).

   .. seealso::

      * :oe:meth:`OEBio::OEInteractionHintContainer::GetInteractions` method

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHasInteractionHintType(const OEInteractionHintTypeBase& itype)

      .. oe:language:: python

         .. oe:api:: python

            OEHasInteractionHintType(itype: OEInteractionHintTypeBase) -> OEHasInteractionHintType

      Constructs the functor with the given interaction type.

      .. seealso::

         The following built-in interaction hint types are available:

         * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`
         * :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
         * :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>`
         * :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`
         * :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>`
         * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>`
         * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
         * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`
         * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>`

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

         .. oe:api::

            OEHasInteractionHintType(const OEHasInteractionHintType& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHasInteractionHintType(arg2: OEHasInteractionHintType) -> OEHasInteractionHintType

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHasInteractionHintType &operator=(const OEHasInteractionHintType &rhs)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the interaction has the same type with which the functor
      is constructed.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasInteractionHintType <OEBio_OEHasInteractionHintType>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEHasPDBAtomIndex, HasPDBAtomIndex

.. _OEBio_OEHasPDBAtomIndex:

.. oe:class:: OEHasPDBAtomIndex

   .. oe:api::

      class OEHasPDBAtomIndex : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEHasPDBAtomIndex <OEBio_OEHasPDBAtomIndex>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with a specific
   PDB index from the :oe:constns:`OEChem::OEPDBAtomName` namespace.

   .. seealso::

      * :ref:`section_predicates_reside_data_functors` section
      * :oe:func:`OEChem::OEGetPDBAtomIndex` function

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHasPDBAtomIndex(unsigned pdbatomidx)

      .. oe:language:: python

         .. oe:api:: python

            OEHasPDBAtomIndex(pdbatomidx: int) -> OEHasPDBAtomIndex

      Default and copy constructors.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasPDBAtomIndex

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasPDBAtomIndex <OEBio_OEHasPDBAtomIndex>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEBio

.. _OEBio_OEHasResidueInteractionHint:

.. oe:class:: OEHasResidueInteractionHint

   .. oe:api::

      class OEHasResidueInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEHasResidueInteractionHint <OEBio_OEHasResidueInteractionHint>` functor that
   identifies connections (:ref:`OEInteractionHint <OEBio_OEInteractionHint>`)
   with a specific residue (:ref:`OEResidue <OEChem_OEResidue>`).

   .. admonition:: Code Examples

      * :ref:`section_example_oebio_printinteractions` **OEChem TK** example
      * `Accessing Interaction Hint Information`_  **OpenEye Python Cookbook** recipe

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHasResidueInteractionHint(const OEChem::OEResidue& res)

      .. oe:language:: python

         .. oe:api:: python

            OEHasResidueInteractionHint(arg2: OEResidue) -> OEHasResidueInteractionHint

      Constructs the functor with the given residue.

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

         .. oe:api::

            OEHasResidueInteractionHint(const OEChem::OEResidue& res,
                                        const OEInteractionHintComponentTypeBase& ctype)

      .. oe:language:: python

         .. oe:api:: python

            OEHasResidueInteractionHint(arg2: OEResidue,
                                        ctype: OEInteractionHintComponentTypeBase) -> OEHasResidueInteractionHint

      Constructs the functor with the given residue and component type.

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

         .. oe:api::

            OEHasResidueInteractionHint(const OEHasResidueInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHasResidueInteractionHint(rhs: OEHasResidueInteractionHint) -> OEHasResidueInteractionHint

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHasResidueInteractionHint &operator=(const OEHasResidueInteractionHint &rhs)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the residue with which the functor is constructed
      identifies any atom stored in the given interaction.
      If a component type is defined at construction than that
      is also checked.

      .. seealso::

         The following built-in component types are available:

         * :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>`
         * :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasResidueInteractionHint <OEBio_OEHasResidueInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEHasSecondaryStructure, HasSecondaryStructure

.. _OEBio_OEHasSecondaryStructure:

.. oe:class:: OEHasSecondaryStructure

   .. oe:api::

      class OEHasSecondaryStructure : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   A predicate that returns ``true`` when the atom belongs to a residue
   that has a secondary structure assignment.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHasSecondaryStructure(int ssType = OESecondaryStructure::Unassigned)
            OEHasSecondaryStructure(const OEHasSecondaryStructure& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHasSecondaryStructure(ssType: int) -> OEHasSecondaryStructure
            OEHasSecondaryStructure(rhs: OEHasSecondaryStructure) -> OEHasSecondaryStructure

      Default and copy constructors.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasSecondaryStructure



.. oe:namespace:: OEBio

.. meta::
   :keywords: OEHierChain, HierChain

.. _OEBio_OEHierChain:

.. oe:class:: OEHierChain

   .. oe:api::

      class OEHierChain

   This class represents a snapshot of one of the chains inside the
   molecule used to construct the :ref:`OEHierView <OEBio_OEHierView>` object which owns the
   :ref:`OEHierChain <OEBio_OEHierChain>` object. It can be used to give a temporary hierarchical
   view to the underlying molecular data structure.

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHierChain()
            OEHierChain(OEHierChainImpl* i)
            OEHierChain(const OEHierChain &)

      .. oe:language:: python

         .. oe:api:: python

            OEHierChain(i: OEHierChainImpl) -> OEHierChain
            OEHierChain() -> OEHierChain
            OEHierChain(arg2: OEHierChain) -> OEHierChain

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHierChain &operator=(const OEHierChain &)

      Default assignment operator

      Assignment operator.

   .. oe:method:: GetAtom

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

         .. oe:api::

            OEChem::OEAtomBase* GetAtom(const char* resName, int resIdx,
                                        unsigned pdbAtomIdx)
            const OEChem::OEAtomBase* GetAtom(const char* resName, int resIdx,
                                              unsigned pdbAtomIdx) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtom(resName: str, resIdx: int, pdbAtomIdx: int) -> OEAtomBase

      Returns an atom specified by the residue name, residue number
      and atom name.

   .. oe:method:: GetChainID

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

         .. oe:api::

            char GetChainID() const

      .. oe:language:: python

         .. oe:api:: python

            GetChainID() -> str

      Returns the single character representation of the chain ID for
      this chain of the molecule. This corresponds to the chain ID
      found in the PDB file.

   .. oe:method:: GetFragments

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

         .. oe:api::

            OESystem::OEIterBase<OEHierFragment>* GetFragments()
            OESystem::OEIterBase<const OEHierFragment>* GetFragments() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragments() -> OEHierFragmentIter
            GetFragments() -> Iterable[OEHierFragment]

      Returns an iterator over all of the fragments in the chain.

   .. oe:method:: GetOEResidue

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

         .. oe:api::

            const OEChem::OEResidue& GetOEResidue() const

      .. oe:language:: python

         .. oe:api:: python

            GetOEResidue() -> OEResidue

      This returns an arbitrary :ref:`OEResidue <OEChem_OEResidue>` object associated with this
      chain.

   .. oe:method:: GetResidue

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

         .. oe:api::

            OEHierResidue& GetResidue(const char* resName, int resIdx)
            const OEHierResidue& GetResidue(const char* resName, int resIdx) const

      .. oe:language:: python

         .. oe:api:: python

            GetResidue(resName: str, resIdx: int) -> OEHierResidue

      Gives direct access to a residue using the typical information
      that a user might know about a residue of interest (*e.g.* -
      ``THR242``). The chain specifier is not included because the chain
      is implied by the current object.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEHierFragment, HierFragment

.. _OEBio_OEHierFragment:

.. oe:class:: OEHierFragment

   .. oe:api::

      class OEHierFragment

   The hierarchical view has an :ref:`OEHierFragment <OEBio_OEHierFragment>` object
   in the hierarchy between :ref:`OEHierChain <OEBio_OEHierChain>` and
   :ref:`OEHierResidue <OEBio_OEHierResidue>`. This gives a
   hierarchical view of a temporary snapshot of the data structure in
   the molecule used to construct the :ref:`OEHierView <OEBio_OEHierView>` which owns the
   fragment objects.

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHierFragment()
            OEHierFragment(OEHierFragImpl* i)
            OEHierFragment(const OEHierFragment &)

      .. oe:language:: python

         .. oe:api:: python

            OEHierFragment(i: OEHierFragImpl) -> OEHierFragment
            OEHierFragment() -> OEHierFragment
            OEHierFragment(arg2: OEHierFragment) -> OEHierFragment

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHierFragment &operator=(const OEHierFragment &)

      Default assignment operator

      Assignment operator.

   .. oe:method:: GetAtom

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

         .. oe:api::

            OEChem::OEAtomBase* GetAtom(const char* resName, int resIdx,
                                        unsigned pdbAtomIdx)
            const OEChem::OEAtomBase* GetAtom(const char* resName, int resIdx,
                                              unsigned pdbAtomIdx) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtom(resName: str, resIdx: int, pdbAtomIdx: int) -> OEAtomBase

   .. oe:method:: GetFragmentNumber

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

         .. oe:api::

            int GetFragmentNumber() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragmentNumber() -> int

      Returns the integer representation of the fragment number for this
      fragment of the chain. While reading a PDB file, fragment numbers
      are incremented every time a `TER`_ record is encountered or a new
      ChainID is encountered.

   .. oe:method:: GetOEResidue

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

         .. oe:api::

            const OEChem::OEResidue& GetOEResidue() const

      .. oe:language:: python

         .. oe:api:: python

            GetOEResidue() -> OEResidue

      Returns an arbitrary :ref:`OEResidue <OEChem_OEResidue>` object associated
      with this fragment.

   .. oe:method:: GetResidue

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

         .. oe:api::

            OEHierResidue& GetResidue(const char* resName, int resIdx)
            const OEHierResidue& GetResidue(const char* resName, int resIdx) const

      .. oe:language:: python

         .. oe:api:: python

            GetResidue(resName: str, resIdx: int) -> OEHierResidue

      Gives direct access to a residue using the typical information
      that a user might know about a residue of interest (*e.g.* -
      ``THR242``). The chain specifier is not included because the chain
      is implied by the current object.

   .. oe:method:: GetResidues

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

         .. oe:api::

            OESystem::OEIterBase<OEHierResidue>* GetResidues()
            OESystem::OEIterBase<const OEHierResidue>* GetResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidues() -> OEHierResidueIter
            GetResidues() -> Iterable[OEHierResidue]

      Returns an iterator over all of the residues in the fragment.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEHierResidue, HierResidue

.. _OEBio_OEHierResidue:

.. oe:class:: OEHierResidue

   .. oe:api::

      class OEHierResidue

   This is the lowest temporary object in the hierarchical
   view. :ref:`OEHierResidue <OEBio_OEHierResidue>` objects are available from within the
   :ref:`OEHierFragment <OEBio_OEHierFragment>` object and give access to the
   :ref:`OEAtomBase <OEChem_OEAtomBase>` objects
   within the molecule at the time the parent :ref:`OEHierView <OEBio_OEHierView>` was
   created. Any atom deletions or additions after the creation of the
   :ref:`OEHierView <OEBio_OEHierView>` will not be available in the object. However, changes to
   atoms or bonds will be available via the :ref:`OEAtomBase <OEChem_OEAtomBase>` API. The bonds
   of a molecule are not directly available through the :ref:`OEHierView <OEBio_OEHierView>`
   object, but instead must be accessed via the :oe:meth:`OEChem::OEAtomBase::GetBonds`
   API point.

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHierResidue()
            OEHierResidue(OEHierResImpl* i)
            OEHierResidue(const OEHierResidue &)

      .. oe:language:: python

         .. oe:api:: python

            OEHierResidue(i: OEHierResImpl) -> OEHierResidue
            OEHierResidue() -> OEHierResidue
            OEHierResidue(arg2: OEHierResidue) -> OEHierResidue

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHierResidue &operator=(const OEHierResidue &)

      Default assignment operator

      Assignment operator.

   .. oe:method:: GetAtom

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

         .. oe:api::

            OEChem::OEAtomBase* GetAtom(unsigned pdbAtomIdx)
            const OEChem::OEAtomBase* GetAtom(unsigned pdbAtomIdx) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtom(pdbAtomIdx: int) -> OEAtomBase

      Returns an atom specified by the PDB atom index.

   .. oe:method:: GetAtoms

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

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEAtomBase>* GetAtoms()
            OESystem::OEIterBase<const OEChem::OEAtomBase>* GetAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> OEAtomIter
            GetAtoms() -> Iterable[OEAtomBase]

      Returns an iterator over all of the atoms in the residue.

   .. oe:method:: GetOEResidue

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

         .. oe:api::

            const OEChem::OEResidue& GetOEResidue() const

      .. oe:language:: python

         .. oe:api:: python

            GetOEResidue() -> OEResidue

      This returns an arbitrary :ref:`OEResidue <OEChem_OEResidue>` object associated with this
      :ref:`OEHierResidue <OEBio_OEHierResidue>`.

      .. seealso::

         .. oe:language:: c++

             * Example program :ref:`reshist.cpp<section_example_oebio_reshist>`

         .. oe:language:: python

            * Example program :ref:`reshist.py<section_example_oebio_reshist>`

         .. oe:language:: java

            * Example program :ref:`ResHist.java<section_example_oebio_reshist>`

         .. oe:language:: csharp

            * Example program :ref:`ResHist.cs<section_example_oebio_reshist>`

   .. oe:method:: GetResidueName

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

         .. oe:api::

            const char* GetResidueName() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidueName() -> str

      Returns the residue name.

   .. oe:method:: GetResidueNumber

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

         .. oe:api::

            int GetResidueNumber() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidueNumber() -> int

      Returns the integer representation of the residue number for this
      residue of the fragment.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEHierView, HierView

.. _OEBio_OEHierView:

.. oe:class:: OEHierView

   .. oe:api::

      class OEHierView

   The :ref:`OEHierView <OEBio_OEHierView>` class provides a convenient method for
   examining biological molecules as if they were hierarchical data.
   Hierarchical views can be fraught with inefficiencies. Despite this, they
   are such a common means of thinking about macromolecules that **OEChem**
   provides access to molecules in this manner.
   The :ref:`OEHierView <OEBio_OEHierView>` class takes a snapshot of an
   :ref:`OEMolBase <OEChem_OEMolBase>` and provides convenient access to a hierarchical
   view of the data.

   .. note::

      Unlike typical *OEChem* iterators that
      closely track changes to a molecule, the hierarchy view is based on
      a snapshot of the molecule. One should use the assignment operator
      to update the hierarchical view after any change to the molecule.

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHierView()
            OEHierView(OEHierViewImpl* i)
            OEHierView(const OEHierView &)

      .. oe:language:: python

         .. oe:api:: python

            OEHierView(i: OEHierViewImpl) -> OEHierView
            OEHierView() -> OEHierView
            OEHierView(arg2: OEHierView) -> OEHierView

      Default and copy constructors.

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

         .. oe:api::

            OEHierView(OEChem::OEMolBase &,
                       unsigned assume = OEAssumption::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEHierView(arg2: Union[OEGraphMol,OEMol,OEQMol], assume: int) -> OEHierView

      This constructor takes  an :ref:`OEMolBase <OEChem_OEMolBase>` as an argument
      and takes a snapshot of the molecule and sets up a hierarchical data
      view of the molecule. This allows hierarchical access to the
      molecule via the :ref:`OEIter <OESystem_OEIter>` class.

   .. note::

      Unlike typical *OEChem* iterators that track changes to a molecule,
      the hierarchy view is based on a snapshot of the molecule. One should
      use the assignment operator to update the hierarchical view after any
      change to the molecule.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHierView &operator=(const OEHierView &)
         OEHierView &operator=(OEChem::OEMolBase &)

      Assignment operator.

   .. oe:method:: GetAtom

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

         .. oe:api::

            const OEChem::OEAtomBase * GetAtom(char chainID,
                                               const char* resName, int resIdx,
                                               unsigned pdbAtomIdx)
            const OEChem::OEAtomBase* GetAtom(char chainID,
                                              const char* resName, int resIdx,
                                              unsigned pdbAtomIdx) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtom(chainID: str, resName: str, resIdx: int, pdbAtomIdx: int) -> OEAtomBase

      Returns an atom specified by the chainID, residue name, residue
      number, and the PDB atom index.

      .. seealso::

         :ref:`OEGetPDBAtomIndex <OEChem_OEGetPDBAtomIndex>` function

   .. oe:method:: GetAtoms

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

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEAtomBase>* GetAtoms()
            OESystem::OEIterBase<const OEChem::OEAtomBase>* GetAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> OEAtomIter
            GetAtoms() -> Iterable[OEAtomBase]

      Returns an iterator over all of the atoms in the hierarchical
      view.

   .. oe:method:: GetChains

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

         .. oe:api::

            OESystem::OEIterBase<OEHierChain>* GetChains()
            OESystem::OEIterBase<const OEHierChain>* GetChains() const

      .. oe:language:: python

         .. oe:api:: python

            GetChains() -> OEHierChainIter
            GetChains() -> Iterable[OEHierChain]

   .. oe:method:: GetFragments

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

         .. oe:api::

            OESystem::OEIterBase<OEHierFragment>* GetFragments()
            OESystem::OEIterBase<const OEHierFragment>* GetFragments() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragments() -> OEHierFragmentIter
            GetFragments() -> Iterable[OEHierFragment]

      Returns an iterator over all of the fragments in the hierarchical
      view.

   .. oe:method:: GetResidue

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

         .. oe:api::

            OEHierResidue& GetResidue(char chainID, const char* resName,
                                      int resIdx)
            const OEHierResidue& GetResidue(char chainID, const char* resName,
                                            int resIdx) const

      .. oe:language:: python

         .. oe:api:: python

            GetResidue(chainID: str, resName: str, resIdx: int) -> OEHierResidue

      Gives direct access to a residue using the typical information that
      a user might know about a residue of interest (*e.g.* - ``THR242`` of
      chain ``'A'``).

   .. oe:method:: GetResidues

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

         .. oe:api::

            OESystem::OEIterBase<OEHierResidue>* GetResidues()
            OESystem::OEIterBase<const OEHierResidue>* GetResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidues() -> OEHierResidueIter
            GetResidues() -> Iterable[OEHierResidue]

      Returns an iterator over all of the residues in the hierarchical
      view.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEInteractionHint

.. _OEBio_OEInteractionHint:

.. oe:class:: OEInteractionHint

   .. oe:api::

      class OEInteractionHint : public OESystem::OEBase

   The :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class is a
   container that stores a typed interaction between two fragments
   (:ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>`) of an
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

   .. only:: oehtml

      .. figure:: /_images/interactionhint.svg
         :width: 600
         :align: center

         **Schematic representation of interaction hint container**

   .. seealso::

      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class
      * :ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>` class
      * :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class

   .. seealso::

      The following built-in interaction hint types are available:

      * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`
      * :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
      * :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>`
      * :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`
      * :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>`
      * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
      * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`
      * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>`
      * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>`

   .. admonition:: Code Examples

      * :ref:`section_example_oebio_printinteractions` **OEChem TK** example
      * :ref:`section_examples_summary_complex2img` **Grapheme TK** example

      **OpenEye Python Cookbook** recipes:

      * `Accessing Interaction Hint Information`_
      * `Print Protein-Ligand Interactions to Console`_
      * `Print the Summary of Protein-Ligand Interactions for a Set of Molecules`_

   .. oe:method:: Constructors

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

         .. oe:api::

            OEInteractionHint(const OEInteractionHintContainerImpl* container,
                              const OEInteractionHintFragment* fragBgn,
                              const OEInteractionHintFragment* fragEnd,
                              const OEInteractionHintTypeBase& itype)

      .. oe:language:: python

         .. oe:api:: python

            OEInteractionHint(rhs: OEInteractionHint) -> OEInteractionHint

      Constructs an :ref:`OEInteractionHint <OEBio_OEInteractionHint>` object with
      the given parameters.

      *container*
        The :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object the
        two fragments belong to.

      **fragBgn, fragEnd**
        The two fragments of the interaction.
        The first fragment is going to be considered as the 'begin'
        fragment, while the second one will be the considered as the
        'end' fragment.

      **type**
        The type of the interaction that is derived from the
        :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>` abstract base class.

      .. seealso::

         * :oe:meth:`OEBio::OEInteractionHint::GetBgnFragment` method
         * :oe:meth:`OEBio::OEInteractionHint::GetEndFragment` method

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

         .. oe:api::

            OEInteractionHint(const OEInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEInteractionHint(rhs: OEInteractionHint) -> OEInteractionHint

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEInteractionHint &operator=(const OEInteractionHint &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

      Deep copy constructor that returns a copy of the object.
      The memory of the returned :ref:`OEInteractionHint <OEBio_OEInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using the C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: HasCalculatedGeometry

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

         .. oe:api::

            bool HasCalculatedGeometry(const std::string& name) const

      .. oe:language:: python

         .. oe:api:: python

            HasCalculatedGeometry(name: str) -> bool

      Returns ``true`` if the interaction hint has the geometry calculated with the
      given name.

      **name**
        The name of the calculated geometry.
        All interaction hint geometry names start with the ``bio:interaction:`` prefix.
        The :oe:meth:`OEBio::OEInteractionHint::HasCalculatedGeometry` method can
        be invoked with or without the ``bio:interaction:`` prefix in the given name.

      .. seealso::

         * :ref:`chapter_interactions_geometry` section
         * :oe:meth:`OEBio::OEInteractionHint::GetCalculatedGeometry` method
         * :oe:meth:`OEBio::OEInteractionHint::GetCalculatedGeometries` method

   .. oe:method:: GetBgnFragment

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

         .. oe:api::

            const OEInteractionHintFragment* GetBgnFragment() const

      .. oe:language:: python

         .. oe:api:: python

            GetBgnFragment() -> OEInteractionHintFragment

      Returns the ‘begin’ fragment of the interaction.
      The 'begin' fragment is defined when the interaction is constructed.

      .. seealso::

         * :oe:meth:`OEBio::OEInteractionHint::Constructors` method

      .. note::

         In case of an "unpaired" interaction both the :oe:meth:`OEBio::OEInteractionHint::GetBgnFragment` and
         :oe:meth:`OEBio::OEInteractionHint::GetEndFragment` methods will point to the same fragment.

         **See Also:** :oe:cls:`OEBio::OEIsUnpairedInteractionHint` predicate

   .. oe:method:: GetCalculatedGeometry

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

         .. oe:api::

            double GetCalculatedGeometry(const std::string& name) const

      .. oe:language:: python

         .. oe:api:: python

            GetCalculatedGeometry(name: str) -> float

      Returns the calculated geometry of the interaction (such as distance or angle).
      The "distance" values are given in Angstroms, and all "angle" values are given in radians.

      **name**
        The name of the calculated geometry.
        All interaction hint geometry names start with the ``bio:interaction:`` prefix.
        The :oe:meth:`OEBio::OEInteractionHint::GetCalculatedGeometry` method can be
        invoked with or without the ``bio:interaction:`` prefix in the given name.

      .. hint::

         It is a good practice to call :oe:meth:`OEBio::OEInteractionHint::HasCalculatedGeometry`
         beforehand to check whether the interaction hint has a geometry with a given name.

      **Example:**

      .. oe:source:: InteractionGeometry.py
         :language: python
         :noindent:
         :frag:     SNIPPET-HAS-GEOMETRY

      .. oe:source:: InteractionGeometry.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-HAS-GEOMETRY

      .. oe:source:: InteractionGeometry.java
         :language: java
         :noindent:
         :frag:     SNIPPET-HAS-GEOMETRY

      .. oe:source:: InteractionGeometry.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-HAS-GEOMETRY

      .. seealso::

         * :ref:`chapter_interactions_geometry` section
         * :oe:meth:`OEBio::OEInteractionHint::HasCalculatedGeometry` method
         * :oe:meth:`OEBio::OEInteractionHint::GetCalculatedGeometries` method

   .. oe:method:: GetCalculatedGeometries

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

         .. oe:api::

            OESystem::OEIterBase<const std::string>* GetCalculatedGeometries() const

      .. oe:language:: python

         .. oe:api:: python

            GetCalculatedGeometries() -> Iterable[str]

      Returns an iterator over the geometry names of the interaction hint.

      .. seealso::

         * :ref:`chapter_interactions_geometry` section
         * :oe:meth:`OEBio::OEInteractionHint::HasCalculatedGeometry` method
         * :oe:meth:`OEBio::OEInteractionHint::GetCalculatedGeometry` method
         * :oe:func:`OEBio::OEGetCalculatedInteractionGeometries` function

   .. oe:method:: GetDataType

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

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

      This function is used to perform run-time type identification.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::GetDataType` method in the **OEChem TK** manual

   .. oe:method:: GetDetails

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

         .. oe:api::

            std::string GetDetails() const

      .. oe:language:: python

         .. oe:api:: python

            GetDetails() -> str

      Returns the string data associated with the
      :ref:`OEInteractionHint <OEBio_OEInteractionHint>` object.

   .. oe:method:: GetEndFragment

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

         .. oe:api::

            const OEInteractionHintFragment* GetEndFragment() const

      .. oe:language:: python

         .. oe:api:: python

            GetEndFragment() -> OEInteractionHintFragment

      Returns the ‘end’ fragment of the interaction.
      The 'end' fragment is defined when the interaction is constructed.

      .. seealso::

         * :oe:meth:`OEBio::OEInteractionHint::Constructors` method

      .. note::

         In case of an "unpaired" interaction both the :oe:meth:`OEBio::OEInteractionHint::GetBgnFragment` and
         :oe:meth:`OEBio::OEInteractionHint::GetEndFragment` methods will point to the same fragment.

         **See Also:** :oe:cls:`OEBio::OEIsUnpairedInteractionHint` predicate

   .. oe:method:: GetFragment

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

         .. oe:api::

            const OEInteractionHintFragment* GetFragment(const OEInteractionHintComponentTypeBase &) const

      .. oe:language:: python

         .. oe:api:: python

            GetFragment(arg2: OEInteractionHintComponentTypeBase) -> OEInteractionHintFragment

      Returns the pointer to one fragment with the given component type.
      If neither the 'begin' nor the 'end' fragment has the given type,
      a NULL pointer will be returned.

      .. warning::

         In case of an intramolecular interaction, the
         :oe:meth:`OEBio::OEInteractionHint::GetFragment` can return a NULL
         pointer, so the return value should always be checked.

      .. seealso::

         The following built-in component types are available:

         * :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>`
         * :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>`

   .. oe:method:: GetInteractionType

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

         .. oe:api::

            const OEInteractionHintTypeBase& GetInteractionType() const

      .. oe:language:: python

         .. oe:api:: python

            GetInteractionType() -> OEInteractionHintTypeBase

      Returns the interaction type of the
      :ref:`OEInteractionHint <OEBio_OEInteractionHint>` object.

      .. seealso::

         The following built-in fragment connection types are available:

         * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`
         * :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
         * :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>`
         * :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`
         * :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>`
         * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
         * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`
         * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>`
         * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>`

   .. oe:method:: GetWeight

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

         .. oe:api::

            double GetWeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetWeight() -> float

      Returns the 'weight' (or score) associated with the
      :ref:`OEInteractionHint <OEBio_OEInteractionHint>` object.

   .. oe:method:: IsDataType

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

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

      Returns whether type is the same as the instance this method is
      called on.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::IsDataType` method in the **OEChem TK** manual

   .. oe:method:: IsInter

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

         .. oe:api::

            bool IsInter() const

      .. oe:language:: python

         .. oe:api:: python

            IsInter() -> bool

      Returns whether the two fragments of the :ref:`OEInteractionHint <OEBio_OEInteractionHint>`
      object belongs to the different molecules.

   .. oe:method:: IsIntra

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

         .. oe:api::

            bool IsIntra() const

      .. oe:language:: python

         .. oe:api:: python

            IsIntra() -> bool

      Returns whether the two fragments of the :ref:`OEInteractionHint <OEBio_OEInteractionHint>`
      object belongs to the same molecule.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OEInteractionHint <OEBio_OEInteractionHint>` object
      represents a valid interaction defined by the type
      associated with it.

   .. oe:method:: SetDetails

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

         .. oe:api::

            void SetDetails(const std::string& details)

      .. oe:language:: python

         .. oe:api:: python

            SetDetails(details: str) -> None

      Sets string data associated with the
      :ref:`OEInteractionHint <OEBio_OEInteractionHint>` object.

   .. oe:method:: SetWeight

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

         .. oe:api::

            void SetWeight(double)

      .. oe:language:: python

         .. oe:api:: python

            SetWeight(arg2: float) -> None

      Sets the 'weight' associated with the
      :ref:`OEInteractionHint <OEBio_OEInteractionHint>` object.

      **weight**
         This number has to be in the range of ``[0.0, 1.0]``.


.. oe:namespace:: OEBio

.. _OEBio_OEInteractionHintComponentTypeBase:

.. oe:class:: OEInteractionHintComponentTypeBase

   .. oe:api::

      class OEInteractionHintComponentTypeBase

   The :ref:`OEInteractionHintComponentTypeBase <OEBio_OEInteractionHintComponentTypeBase>` is an abstract class that
   enables to type molecule and fragments stored in a
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

   The following classes derive from this class:
    * :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>`
    * :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>`

   .. oe:method:: Constructors

      .. oe:api::

         OEInteractionHintComponentTypeBase(const std::string& name)

      Creates an component type with the given name (identifier).

      *name*
        A unique string representing a specific component type.

      .. oe:api::

         OEInteractionHintComponentTypeBase(const OEInteractionHintComponentTypeBase& rhs)

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEInteractionHintComponentTypeBase& operator=(const OEInteractionHintComponentTypeBase& rhs)

      Assignment operator.

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEInteractionHintComponentTypeBase &) const

      Determines whether two component types, derived from the
      :ref:`OEInteractionHintComponentTypeBase <OEBio_OEInteractionHintComponentTypeBase>` class, are identical.

   .. oe:method:: operator!=
      :language: c++

      .. oe:api::

         bool operator!=(const OEInteractionHintComponentTypeBase &) const

      Determines whether two component types, derived from the
      :ref:`OEInteractionHintComponentTypeBase <OEBio_OEInteractionHintComponentTypeBase>` class, are different.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintComponentTypeBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintComponentTypeBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.

   .. oe:method:: GetName

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

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the name (identifier) of the connection type.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEChem::OEMolBase &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This is a virtual method that has to be implemented in the concrete
      derived classes to evaluate whether the given molecule is valid for
      for the given concrete component type.




.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEBio

.. _OEBio_OEInteractionHintContainer:

.. oe:class:: OEInteractionHintContainer

   .. oe:api::

      class OEInteractionHintContainer

   This class represents :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>`, a read only class
   that stores molecules, the fragments of those molecules (:ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>`), and the typed interactions (:ref:`OEInteractionHint <OEBio_OEInteractionHint>`) between the fragments.

   .. only:: oehtml

      .. figure:: /_images/interactionhint.svg
         :width: 600
         :align: center

         **Schematic representation of interaction hint container**

   .. seealso::

      * :ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>` class
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class

   .. seealso::

      This class is used by **OEChem TK** and **Grapheme TK**
      to visualize protein-ligand interactions.

      * :oe:func:`OEBio::OEPerceiveInteractionHints` function in the **OEChem TK** manual
      * :oe:func:`OEGrapheme::OERenderActiveSite` function in the **Grapheme TK** manual
      * :oe:func:`OEGrapheme::OERenderUnpairedInteractionMap` function in the **Grapheme TK** manual

   .. admonition:: Code Examples

      * :ref:`section_example_oebio_printinteractions` **OEChem TK** example
      * :ref:`section_examples_summary_complex2img` **Grapheme TK** example
      * `Accessing Interaction Hint Information`_ **OpenEye Python Cookbook** recipe

   .. ################################################################
      #
      ################################################################

   .. _OEBio_OEInteractionHintContainer_Constructors:

   .. oe:method:: Constructors

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

         .. oe:api::

            OEInteractionHintContainer()

      .. oe:language:: python

         .. oe:api:: python

            OEInteractionHintContainer() -> OEInteractionHintContainer

      Constructs an empty :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

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

         .. oe:api::

            OEInteractionHintContainer(const OEChem::OEMolBase& protein,
                                       const OEChem::OEMolBase& ligand)

      .. oe:language:: python

         .. oe:api:: python

            OEInteractionHintContainer(protein: Union[OEGraphMol,OEMol,OEQMol],
                                       ligand: Union[OEGraphMol,OEMol,OEQMol]) -> OEInteractionHintContainer

      Initializes an :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object with the two
      given molecules. The first molecule will be added to the
      container with the :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>` type
      while the second molecule will be added with the
      :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>` type.

      To perceive only intramolecular interactions within one component, pass an
      empty molecule for the other component. For example, to perceive only
      intramolecular interactions within the protein, pass an empty molecule as
      the ``ligand`` argument. Similarly, to perceive only intramolecular
      interactions within the ligand, pass an empty molecule as the ``protein``
      argument.

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

         .. oe:api::

            OEInteractionHintContainer(const OEBio::OEDesignUnit& du,
                                       const unsigned receptorMask = OEBio::OEDesignUnitComponents::TargetComplex)

      .. oe:language:: python

         .. oe:api:: python

            OEInteractionHintContainer(du: OEDesignUnit, receptorMask: int) -> OEInteractionHintContainer

      Initializes an :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>`
      from an :oe:cls:`OEBio::OEDesignUnit`. The receptor component is assembled
      from all design unit components matching ``receptorMask`` (default:
      :oe:const:`OEBio::OEDesignUnitComponents::TargetComplex`). If the design
      unit has a ligand, it is added with the
      :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>` type.
      If the design unit has site residues but no ligand, an empty ligand
      molecule is used so that only intramolecular interactions within the
      receptor are perceived.

      .. seealso::

         * :oe:const:`OEBio::OEDesignUnitComponents::TargetComplex` constant
         * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class
         * :oe:func:`OEBio::OEConstructInteractionHintContainer` function

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator bool

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

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Same as the :oe:meth:`OEBio::OEInteractionHintContainer::IsValid` method.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: AddMolecule

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

         .. oe:api::

            const OEChem::OEMolBase* AddMolecule(const OEChem::OEMolBase& mol,
                                                 const OEInteractionHintComponentTypeBase& itype)

      .. oe:language:: python

         .. oe:api:: python

            AddMolecule(mol: Union[OEGraphMol,OEMol,OEQMol],
                        itype: OEInteractionHintComponentTypeBase) -> OEGraphMol

      Adds a molecule the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` with a given
      type. It returns the pointer of the molecule that is the copied molecule
      stored inside the interaction container or returns a NULL pointer if
      adding the molecule with the given type was unsuccessful.

      .. seealso::

         The following built-in component types are available:

         * :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>`
         * :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>`

   .. ################################################################
      #
      ################################################################

   .. oe:method:: DeleteInteraction

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

         .. oe:api::

            bool DeleteInteraction(const OEInteractionHint* inter)

      .. oe:language:: python

         .. oe:api:: python

            DeleteInteraction(arg2: OEInteractionHint) -> bool

      Deletes the given interaction with the corresponding interaction
      fragments from the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>`
      object.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: DeleteInteractions

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

         .. oe:api::

            bool DeleteInteractions()

      .. oe:language:: python

         .. oe:api:: python

            DeleteInteractions() -> bool

      Deletes all interactions.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetInteractions

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

         .. oe:api::

            OESystem::OEIterBase<const OEInteractionHint>* GetInteractions() const

      .. oe:language:: python

         .. oe:api:: python

            GetInteractions() -> Iterable[OEInteractionHint]

      Returns an iterator over all of the interactions stored in the
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

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

         .. oe:api::

            OESystem::OEIterBase<const OEInteractionHint>* GetInteractions(const OESystem::OEUnaryPredicate<OEInteractionHint>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            GetInteractions(pred: OEUnaryInteractionHintPred) -> Iterable[OEInteractionHint]

      Returns an iterator over all of the interactions of the
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object that
      match the specified interaction predicate.

      .. seealso::

         The following built-in interaction predicates are available:

         * :ref:`OEHasInteractionHint <OEBio_OEHasInteractionHint>`
         * :ref:`OEHasInteractionHintType <OEBio_OEHasInteractionHintType>`
         * :ref:`OEHasResidueInteractionHint <OEBio_OEHasResidueInteractionHint>`

         * :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>`
         * :ref:`OEIsChelatorInteractionHint <OEBio_OEIsChelatorInteractionHint>`
         * :ref:`OEIsClashInteractionHint <OEBio_OEIsClashInteractionHint>`
         * :ref:`OEIsContactInteractionHint <OEBio_OEIsContactInteractionHint>`
         * :ref:`OEIsCovalentInteractionHint <OEBio_OEIsCovalentInteractionHint>`
         * :ref:`OEIsHalogenBondInteractionHint <OEBio_OEIsHalogenBondInteractionHint>`
         * :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>`
         * :ref:`OEIsInterInteractionHint <OEBio_OEIsInterInteractionHint>`
         * :ref:`OEIsIntermolecularCationPiInteractionHint <OEBio_OEIsIntermolecularCationPiInteractionHint>`
         * :ref:`OEIsIntermolecularHalogenBondInteractionHint <OEBio_OEIsIntermolecularHalogenBondInteractionHint>`
         * :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>`
         * :ref:`OEIsIntermolecularSaltBridgeInteractionHint <OEBio_OEIsIntermolecularSaltBridgeInteractionHint>`
         * :ref:`OEIsIntermolecularStackingInteractionHint <OEBio_OEIsIntermolecularStackingInteractionHint>`

         * :ref:`OEIsIntraInteractionHint <OEBio_OEIsIntraInteractionHint>`
         * :ref:`OEIsIntramolecularCationPiInteractionHint <OEBio_OEIsIntramolecularCationPiInteractionHint>`
         * :ref:`OEIsIntramolecularChelatorInteractionHint <OEBio_OEIsIntramolecularChelatorInteractionHint>`
         * :ref:`OEIsIntramolecularHalogenBondInteractionHint <OEBio_OEIsIntramolecularHalogenBondInteractionHint>`
         * :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>`
         * :ref:`OEIsIntramolecularSaltBridgeInteractionHint <OEBio_OEIsIntramolecularSaltBridgeInteractionHint>`
         * :ref:`OEIsIntramolecularStackingInteractionHint <OEBio_OEIsIntramolecularStackingInteractionHint>`
         * :ref:`OEIsNonIdealHBondInteractionHint <OEBio_OEIsNonIdealHBondInteractionHint>`
         * :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>`
         * :ref:`OEIsStackingInteractionHint <OEBio_OEIsStackingInteractionHint>`

         * :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>`
         * :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>`
         * :ref:`OEIsUnpairedLigandInteractionHint <OEBio_OEIsUnpairedLigandInteractionHint>`
         * :ref:`OEIsUnpairedProteinInteractionHint <OEBio_OEIsUnpairedProteinInteractionHint>`

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetMolecule

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

         .. oe:api::

            const OEChem::OEMolBase* GetMolecule(const OEInteractionHintComponentTypeBase& itype) const

      .. oe:language:: python

         .. oe:api:: python

            GetMolecule(itype: OEInteractionHintComponentTypeBase) -> OEGraphMol

      Returns the first molecule stored in the
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object
      with the given type.

      .. seealso::

         The following built-in component types are available:

         * :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>`
         * :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>`

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetMolecules

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

         .. oe:api::

            OESystem::OEIterBase<const OEChem::OEMolBase>* GetMolecules() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolecules() -> Iterable[OEMolBase]

      Returns an iterator over all the molecule of the
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

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

         .. oe:api::

            OESystem::OEIterBase<const OEChem::OEMolBase>* GetMolecules(const OEInteractionHintComponentTypeBase& itype) const

      .. oe:language:: python

         .. oe:api:: python

            GetMolecules(itype: OEInteractionHintComponentTypeBase) -> Iterable[OEMolBase]

      Returns an iterator over all the molecule with the given type
      of the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

      .. seealso::

         The following built-in component types are available:

         * :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>`
         * :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>`

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetTitle

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

         .. oe:api::

            const std::string& GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Returns the 'title' of the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: HasInteraction

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

         .. oe:api::

            bool HasInteraction(const OESystem::OEUnaryPredicate<OEInteractionHint>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            HasInteraction(pred: OEUnaryInteractionHintPred) -> bool

      Returns `true` if there is at least one interaction stored
      in the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object that
      matches the given predicate.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether there is at least one molecule that is stored in the
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

      .. seealso::

         * :oe:func:`OEBio::OEIsValidActiveSite` function

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumFragments

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

         .. oe:api::

            unsigned int NumFragments() const

      .. oe:language:: python

         .. oe:api:: python

            NumFragments() -> int

      Returns the number of fragments stored in the
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumInteractions

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

         .. oe:api::

            unsigned int NumInteractions() const

      .. oe:language:: python

         .. oe:api:: python

            NumInteractions() -> int

      Returns the number of interactions stored in the
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

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

         .. oe:api::

            unsigned NumInteractions(const OESystem::OEUnaryPredicate<OEInteractionHint>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            NumInteractions(pred: OEUnaryInteractionHintPred) -> int

      Returns the number of interactions stored in the
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object that satisfies
      the given predicate.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumMolecules

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

         .. oe:api::

            unsigned int NumMolecules() const

      .. oe:language:: python

         .. oe:api:: python

            NumMolecules() -> int

      Returns the number of molecules stored in the
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object

   .. ################################################################
      #
      ################################################################

   .. oe:method:: SetTitle

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

         .. oe:api::

            void SetTitle(const std::string& title)

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(title: str) -> None

      Sets the 'title' of the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEBio

.. _OEBio_OEInteractionHintFragment:

.. oe:class:: OEInteractionHintFragment

   .. oe:api::

      class OEInteractionHintFragment : public OESystem::OEBase

   The :ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>` class is a container
   that holds atom pointers of a molecule of a
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

   .. only:: oehtml

      .. figure:: /_images/interactionhint.svg
         :width: 600
         :align: center

         **Schematic representation of interaction hint container**

   .. seealso::

      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

   .. admonition:: Code Examples

      * :ref:`section_example_oebio_printinteractions` **OEChem TK** example
      * :ref:`section_examples_summary_complex2img` **Grapheme TK** example
      * `Accessing Interaction Hint Information`_ **OpenEye Python Cookbook** recipe

   .. oe:method:: Constructors

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

         .. oe:api::

            OEInteractionHintFragment(const OEInteractionHintContainerImpl* container,
                                      const OEChem::OEMolBase* parent)

      .. oe:language:: python

         .. oe:api:: python

            OEInteractionHintFragment(rhs: OEInteractionHintFragment) -> OEInteractionHintFragment

      Creates an :ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>` object
      that belongs to the given container and stores the atoms of the
      given molecule.

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

         .. oe:api::

            OEInteractionHintFragment(const OEInteractionHintFragment& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEInteractionHintFragment(rhs: OEInteractionHintFragment) -> OEInteractionHintFragment

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEInteractionHintFragment &operator=(const OEInteractionHintFragment &rhs)

      Assignment operator.

   .. oe:method:: AddAtom

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

         .. oe:api::

            bool AddAtom(const OEChem::OEAtomBase *)

      .. oe:language:: python

         .. oe:api:: python

            AddAtom(arg2: OEAtomBase) -> bool

      Adds an atom to the :ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>` object.
      Returns ``true`` if the atom was successfully added to the
      :ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>` object.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: GetAtom

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

         .. oe:api::

            const OEChem::OEAtomBase* GetAtom(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>&) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtom(arg2: OEUnaryAtomPred) -> OEAtomBase

      Retrieves the first atom of a fragment that matches the
      specified atom predicate (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`).
      If the fragment does not contain an atom that matches, a null 
      pointer is returned.

   .. oe:method:: GetAtoms

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

         .. oe:api::

            OESystem::OEIterBase<const OEChem::OEAtomBase>* GetAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> Iterable[OEAtomBase]

      Returns an iterator over all the atoms of the fragment.

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

         .. oe:api::

            OESystem::OEIterBase<const OEChem::OEAtomBase>* GetAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms(arg2: OEUnaryAtomPred) -> Iterable[OEAtomBase]

      Returns an iterator over all of the atoms of the fragment that
      match the specified atom predicate (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`).

   .. oe:method:: GetComponentType

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

         .. oe:api::

            const OEInteractionHintComponentTypeBase& GetComponentType() const

      .. oe:language:: python

         .. oe:api:: python

            GetComponentType() -> OEInteractionHintComponentTypeBase

      Returns the type of the fragment i.e. the type of the molecule the
      fragment belongs to.

      .. seealso::

         The following built-in component types are available:

         * :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>`
         * :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>`

   .. oe:method:: GetDataType

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

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

      This function is used to perform run-time type
      identification.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::GetDataType` method in the **OEChem TK** manual

   .. oe:method:: HasAtom

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

         .. oe:api::

            bool HasAtom(const OEChem::OEAtomBase *) const

      .. oe:language:: python

         .. oe:api:: python

            HasAtom(arg2: OEAtomBase) -> bool

      Returns whether the given atom is already stored in the
      :ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>` object.

   .. oe:method:: IsDataType

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

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

      Returns whether a type is the same as the instance this method is
      called on.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::IsDataType` method in the **OEChem TK** manual

   .. oe:method:: NumAtoms

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

         .. oe:api::

            unsigned int NumAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            NumAtoms() -> int

      Returns the number of atoms of the fragment.


.. oe:namespace:: OEBio

.. _OEBio_OEInteractionHintTypeBase:

.. oe:class:: OEInteractionHintTypeBase

   .. oe:api::

      class OEInteractionHintTypeBase

   The :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>` is an abstract class that
   enables to type interactions
   (:ref:`OEInteractionHint <OEBio_OEInteractionHint>`) stored in a
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

   The following classes derive from this class:
    * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`
    * :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
    * :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>`
    * :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`
    * :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>`
    * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>`
    * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
    * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`
    * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>`

   .. oe:method:: Constructors

      .. oe:api::

         OEInteractionHintTypeBase(const std::string& name)

      Creates an interaction type with the given name (identifier).

      *name*
        A unique string representing a specific interaction type.

      .. oe:api::

         OEInteractionHintTypeBase(const OEInteractionHintTypeBase& rhs)

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEInteractionHintTypeBase& operator=(const OEInteractionHintTypeBase& rhs)

      Assignment operator.

   .. oe:method:: operator!=
      :language: c++

      .. oe:api::

         bool operator!=(const OEInteractionHintTypeBase &) const

      Determines whether two interaction types, derived from the
      :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>` class, are different.

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEInteractionHintTypeBase &) const

      Determines whether two interaction types, derived from the
      :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>` class, are identical.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintTypeBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintTypeBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.

   .. oe:method:: GetName

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

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the name (identifier) of the interaction type.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEInteractionHint &) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHint) -> bool

      Returns whether the given interaction is considered valid for
      the given interaction type.

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

         .. oe:api::

            bool IsValid(const OEInteractionHintFragment *,
                         const OEInteractionHintFragment *) const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHintFragment,
                    arg3: OEInteractionHintFragment) -> bool

      This is a virtual method that has to be implemented in the concrete
      derived classes to evaluate whether the two given fragments form a valid
      interaction for the given concrete interaction type.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. _OEBio_OEIridiumData:

.. oe:class:: OEIridiumData

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEIridiumData

   This class contains the Iridium category [Warren-2012]_, metrics required for
   categorization, and a methods to determine the Iridium category
   itself.

   .. seealso::

      * :ref:`section_sprucetk_iridium_categorization` section in **OESpruce TK**
      * :oe:func:`OEBio::OECalculateDPI` function
      * :ref:`OEStructureQuality <OEBio_OEStructureQuality>` class
      * :oe:func:`OEGrapheme::OEDrawIridiumData` function in **Grapheme TK** to visualize information stored
        in an :ref:`OEIridiumData <OEBio_OEIridiumData>` object

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover cursor over graph</b>
         </p>

         <p align="center">
         <object data="../../_images/DrawIridiumData.svg" type="image/svg+xml"  width = "250" ></object>
         <p>

         <p align="center">
         <b>Example of visualizing OEIridiumData</b>
         <p>

   .. only:: oepdf

      .. figure:: graphemetk/images/DrawIridiumData.*
         :align:  center

         **Example of visualizing OEIridiumData**

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIridiumData()
            OEIridiumData(const OEIridiumData& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEIridiumData() -> OEIridiumData
            OEIridiumData(rhs: OEIridiumData) -> OEIridiumData

      Default and copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIridiumData &operator=(const OEIridiumData &rhs)

      Assignment operator.

   .. oe:method:: operator bool

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

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OEIridiumData <OEBio_OEIridiumData>` object is valid.

   .. oe:method:: Clear

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

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Resets the OEIridiumData object to its initial state.

   .. oe:method:: DetermineCategory

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

         .. oe:api::

            void DetermineCategory()

      .. oe:language:: python

         .. oe:api:: python

            DetermineCategory() -> None

      This function uses the internally stored metrics to determine
      the Iridium category.

      .. seealso::

         * :oe:constns:`OEBio::OEIridiumCategory` namespace
         * :ref:`section_sprucetk_iridium_categorization` section in **OESpruce TK**

   .. oe:method:: GetAltConfs

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

         .. oe:api::

            bool GetAltConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetAltConfs() -> bool

      Returns whether or not alternative conformations exist for this structure.

   .. oe:method:: GetAsDensity

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

         .. oe:api::

            double GetAsDensity() const

      .. oe:language:: python

         .. oe:api:: python

            GetAsDensity() -> float

      Returns the active site density coverage (0 to 1).

   .. oe:method:: GetCategory

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

         .. oe:api::

            unsigned GetCategory() const

      .. oe:language:: python

         .. oe:api:: python

            GetCategory() -> int

      Returns the Iridium category from the
      :oe:constns:`OEBio::OEIridiumCategory` namespace.

   .. oe:method:: GetDPI

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

         .. oe:api::

            double GetDPI() const

      .. oe:language:: python

         .. oe:api:: python

            GetDPI() -> float

      Returns the diffraction-component precision index (DPI) value.

   .. oe:method:: GetExcipients

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

         .. oe:api::

            bool GetExcipients() const

      .. oe:language:: python

         .. oe:api:: python

            GetExcipients() -> bool

      Returns whether or not excipients have interactions with the ligand.

   .. oe:method:: GetHasMTZ

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

         .. oe:api::

            bool GetHasMTZ() const

      .. oe:language:: python

         .. oe:api:: python

            GetHasMTZ() -> bool

      Returns whether or not an MTZ file exists for this structure.

   .. oe:method:: GetIrrationalRfree

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

         .. oe:api::

            bool GetIrrationalRfree() const

      .. oe:language:: python

         .. oe:api:: python

            GetIrrationalRfree() -> bool

      Returns the irrational Rfree value.

   .. oe:method:: GetLigandDensity

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

         .. oe:api::

            double GetLigandDensity() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandDensity() -> float

      Returns the ligand density coverage (0 to 1).

   .. oe:method:: GetPackingResidues

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

         .. oe:api::

            bool GetPackingResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetPackingResidues() -> bool

      Returns whether or not packing residues make interactions with the ligand.

   .. oe:method:: GetPartOccupancyLigand

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

         .. oe:api::

            bool GetPartOccupancyLigand() const

      .. oe:language:: python

         .. oe:api:: python

            GetPartOccupancyLigand() -> bool

      Returns whether or not the ligand has partial occupancy.

   .. oe:method:: GetPartOccupancyProtein

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

         .. oe:api::

            bool GetPartOccupancyProtein() const

      .. oe:language:: python

         .. oe:api:: python

            GetPartOccupancyProtein() -> bool

      Returns whether or not the protein has partial occupancy.

   .. oe:method:: GetPossibleCovalent

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

         .. oe:api::

            bool GetPossibleCovalent() const

      .. oe:language:: python

         .. oe:api:: python

            GetPossibleCovalent() -> bool

      Returns whether or not potential but unperceived covalent 
      interaction can be found in the active site.

   .. oe:method:: GetRFree

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

         .. oe:api::

            double GetRFree() const

      .. oe:language:: python

         .. oe:api:: python

            GetRFree() -> float

      Returns the Rfree value.

   .. oe:method:: GetResolution

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

         .. oe:api::

            double GetResolution() const

      .. oe:language:: python

         .. oe:api:: python

            GetResolution() -> float

      Returns the resolution of the crystal structure.

   .. oe:method:: SetAltConfs

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

         .. oe:api::

            bool SetAltConfs(bool altConfs)

      .. oe:language:: python

         .. oe:api:: python

            SetAltConfs(altConfs: bool) -> bool

      Sets whether or not alternative conformations exist for this structure.

   .. oe:method:: SetAsDensity

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

         .. oe:api::

            bool SetAsDensity(double asDensity)

      .. oe:language:: python

         .. oe:api:: python

            SetAsDensity(asDensity: float) -> bool

      Sets the active site density coverage.

   .. oe:method:: SetCategory

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

         .. oe:api::

            bool SetCategory(unsigned category)

      .. oe:language:: python

         .. oe:api:: python

            SetCategory(category: int) -> bool

      Sets the Iridium category from a value in the
      :oe:constns:`OEBio::OEIridiumCategory` namespace.

   .. oe:method:: SetDPI

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

         .. oe:api::

            bool SetDPI(double dpi)

      .. oe:language:: python

         .. oe:api:: python

            SetDPI(dpi: float) -> bool

      Sets the diffraction-component precision index (DPI) value.

   .. oe:method:: SetExcipients

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

         .. oe:api::

            bool SetExcipients(bool excipients)

      .. oe:language:: python

         .. oe:api:: python

            SetExcipients(excipients: bool) -> bool

      Sets whether or not excipients have interactions with the ligand.

   .. oe:method:: SetHasMTZ

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

         .. oe:api::

            bool SetHasMTZ(bool hasMTZ)

      .. oe:language:: python

         .. oe:api:: python

            SetHasMTZ(hasMTZ: bool) -> bool

      Sets whether or not an MTZ file exists for this structure.

   .. oe:method:: SetIrrationalRfree

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

         .. oe:api::

            bool SetIrrationalRfree(bool irrationalRfree)

      .. oe:language:: python

         .. oe:api:: python

            SetIrrationalRfree(irrationalRfree: bool) -> bool

      Sets the irrational Rfree value.

   .. oe:method:: SetLigandDensity

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

         .. oe:api::

            bool SetLigandDensity(double ligandDensity)

      .. oe:language:: python

         .. oe:api:: python

            SetLigandDensity(ligandDensity: float) -> bool

      Sets the ligand density coverage (0 to 1).

   .. oe:method:: SetPackingResidues

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

         .. oe:api::

            bool SetPackingResidues(bool packingResidues)

      .. oe:language:: python

         .. oe:api:: python

            SetPackingResidues(packingResidues: bool) -> bool

      Sets whether or not packing residues make interactions with the ligand.

   .. oe:method:: SetPartOccupancyLigand

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

         .. oe:api::

            bool SetPartOccupancyLigand(bool partOccupancyLigand)

      .. oe:language:: python

         .. oe:api:: python

            SetPartOccupancyLigand(partOccupancyLigand: bool) -> bool

      Sets whether or not the ligand has partial occupancy.

   .. oe:method:: SetPartOccupancyProtein

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

         .. oe:api::

            bool SetPartOccupancyProtein(bool partOccupancyProtein)

      .. oe:language:: python

         .. oe:api:: python

            SetPartOccupancyProtein(partOccupancyProtein: bool) -> bool

      Sets whether or not the protein has partial occupancy.

   .. oe:method:: SetPossibleCovalent

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

         .. oe:api::

            bool SetPossibleCovalent(bool possibleCovalent)

      .. oe:language:: python

         .. oe:api:: python

            SetPossibleCovalent(possibleCovalent: bool) -> bool

      Sets whether or not potential but unperceived covalent 
      interaction can be found in the active site.

   .. oe:method:: SetRFree

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

         .. oe:api::

            bool SetRFree(double rFree)

      .. oe:language:: python

         .. oe:api:: python

            SetRFree(rFree: float) -> bool

      Sets the Rfree value.

   .. oe:method:: SetResolution

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

         .. oe:api::

            bool SetResolution(double resolution)

      .. oe:language:: python

         .. oe:api:: python

            SetResolution(resolution: float) -> bool

      Sets the resolution of the crystal structure.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsAlphaCarbon, IsAlphaCarbon

.. _OEBio_OEIsAlphaCarbon:

.. oe:class:: OEIsAlphaCarbon

   .. oe:api::

      class OEIsAlphaCarbon : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   .. warning::

      This is a deprecated functor. Use :ref:`OEIsCAlpha <OEChem_OEIsCAlpha>` predicate
      instead.



.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsBackboneAtom, IsBackboneAtom

.. _OEBio_OEIsBackboneAtom:

.. oe:class:: OEIsBackboneAtom

   .. oe:api::

      class OEIsBackboneAtom : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsBackboneAtom <OEBio_OEIsBackboneAtom>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) that are part of a
   macro-molecule backbone.

   .. seealso::

      * :ref:`section_predicates_reside_data_functors` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsBackboneAtom(bool considercarbonyl = true,
                             bool considerterminaloxygen = false)

      .. oe:language:: python

         .. oe:api:: python

            OEIsBackboneAtom(o: bool = True,
                             includeTerminalOxygen: bool = False) -> OEIsBackboneAtom

      Default constructor.

      *considercarbonyl*
         Determines whether to consider the carbonyl oxygen as a backbone atom.
      *considerterminaloxygen*
         Determines whether to consider the terminal oxygen (OXT) as a backbone atom.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsBackboneAtom

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsBackboneAtom <OEBio_OEIsBackboneAtom>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsCTerminalAtom, IsCTerminal

.. _OEBio_OEIsCTerminalAtom:

.. oe:class:: OEIsCTerminalAtom

   .. oe:api::

      class OEIsCTerminalAtom : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsCTerminalAtom <OEBio_OEIsCTerminalAtom>` functor
   that identifies the C-terminal backbone atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) for standard amino
   acid residues in a macro-molecule, or for a nonstandard amino acid residues with a complete backbone.

   .. seealso::

      * :ref:`section_predicates_reside_data_functors` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsCTerminalAtom()

      .. oe:language:: python

         .. oe:api:: python

            OEIsCTerminalAtom() -> OEIsCTerminalAtom

      Default constructor.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsCTerminalAtom

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsCTerminalAtom <OEBio_OEIsCTerminalAtom>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsCationPiInteractionHint:

.. oe:class:: OEIsCationPiInteractionHint

   .. oe:api::

      class OEIsCationPiInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>` functor that
   identifies **cation-Pi** interactions.

   .. seealso::

      * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` class
      * :oe:constns:`OEBio::OECationPiInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsIntermolecularCationPiInteractionHint <OEBio_OEIsIntermolecularCationPiInteractionHint>` predicate
      * :ref:`OEIsIntramolecularCationPiInteractionHint <OEBio_OEIsIntramolecularCationPiInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsCationPiInteractionHint(bool includeIntra = true)

      .. oe:language:: python

         .. oe:api:: python

            OEIsCationPiInteractionHint(includeIntra: bool = True) -> OEIsCationPiInteractionHint
            OEIsCationPiInteractionHint(arg2: OEIsCationPiInteractionHint) -> OEIsCationPiInteractionHint

      Constructor.

      :param includeIntra: If ``true`` (default), intramolecular cation-pi
         interactions are included in the results.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsCationPiInteractionHint & operator=(const OEIsCationPiInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a cation-pi
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`
      type.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.



.. oe:namespace:: OEBio

.. _OEBio_OEIsChelatorInteractionHint:

.. oe:class:: OEIsChelatorInteractionHint

   .. oe:api::

      class OEIsChelatorInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsChelatorInteractionHint <OEBio_OEIsChelatorInteractionHint>` functor that
   identifies **chelator** interactions.

   .. seealso::

      * :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>` class
      * :oe:constns:`OEBio::OEChelatorInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsIntramolecularChelatorInteractionHint <OEBio_OEIsIntramolecularChelatorInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsChelatorInteractionHint(bool includeIntra = true)

      .. oe:language:: python

         .. oe:api:: python

            OEIsChelatorInteractionHint(includeIntra: bool = True) -> OEIsChelatorInteractionHint
            OEIsChelatorInteractionHint(arg2: OEIsChelatorInteractionHint) -> OEIsChelatorInteractionHint

      Constructor.

      :param includeIntra: If ``true`` (default), intramolecular chelator
         interactions are included in the results.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsChelatorInteractionHint & operator=(const OEIsChelatorInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(c: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a chelator
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
      type.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsChelatorInteractionHint <OEBio_OEIsChelatorInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsClashInteractionHint:

.. oe:class:: OEIsClashInteractionHint

   .. oe:api::

      class OEIsClashInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsClashInteractionHint <OEBio_OEIsClashInteractionHint>` functor that
   identifies **clash** interactions.

   .. seealso::

      * :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>` class
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsClashInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsClashInteractionHint() -> OEIsClashInteractionHint
            OEIsClashInteractionHint(arg2: OEIsClashInteractionHint) -> OEIsClashInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsClashInteractionHint & operator=(const OEIsClashInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(c: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a clash
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>`
      type.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsClashInteractionHint <OEBio_OEIsClashInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsClashingHBondInteractionHint:

.. oe:class:: OEIsClashingHBondInteractionHint

   .. oe:api::

      class OEIsClashingHBondInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>` functor that
   identifies **clashing** hydrogen bond interactions, i.e. geometrically
   unfavorable interactions between two acceptors or two donors that cannot
   form a proper hydrogen bond.

   .. seealso::

      * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` class
      * :oe:constns:`OEBio::OEHBondInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` predicate
      * :ref:`OEIsNonIdealHBondInteractionHint <OEBio_OEIsNonIdealHBondInteractionHint>` predicate
      * :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsClashingHBondInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsClashingHBondInteractionHint() -> OEIsClashingHBondInteractionHint
            OEIsClashingHBondInteractionHint(arg2: OEIsClashingHBondInteractionHint) -> OEIsClashingHBondInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsClashingHBondInteractionHint & operator=(const OEIsClashingHBondInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& c) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(c: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a clashing hydrogen bond
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
      with one of the following types:

      * :oe:const:`OEBio::OEHBondInteractionHintType::ClashAcceptorAcceptor`
      * :oe:const:`OEBio::OEHBondInteractionHintType::ClashDonorDonor`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsContactInteractionHint:

.. oe:class:: OEIsContactInteractionHint

   .. oe:api::

      class OEIsContactInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsContactInteractionHint <OEBio_OEIsContactInteractionHint>` functor that
   identifies **contact** interactions.

   .. seealso::

      * :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>` class
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsContactInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsContactInteractionHint() -> OEIsContactInteractionHint
            OEIsContactInteractionHint(arg2: OEIsContactInteractionHint) -> OEIsContactInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsContactInteractionHint & operator=(const OEIsContactInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(c: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a contact
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`
      type.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsContactInteractionHint <OEBio_OEIsContactInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsCovalentInteractionHint:

.. oe:class:: OEIsCovalentInteractionHint

   .. oe:api::

      class OEIsCovalentInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsCovalentInteractionHint <OEBio_OEIsCovalentInteractionHint>` functor that
   identifies **covalent** interactions.

   .. seealso::

      * :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>` class
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsCovalentInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsCovalentInteractionHint() -> OEIsCovalentInteractionHint
            OEIsCovalentInteractionHint(arg2: OEIsCovalentInteractionHint) -> OEIsCovalentInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsCovalentInteractionHint & operator=(const OEIsCovalentInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& c) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(c: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a clash
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>`
      type.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsCovalentInteractionHint <OEBio_OEIsCovalentInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsDisulfideBond, IsDisulfide

.. _OEBio_OEIsDisulfideBond:

.. oe:class:: OEIsDisulfideBond

   .. oe:api::

      class OEIsDisulfideBond : public OESystem::OEUnaryPredicate<OEChem::OEBondBase>

   This class represents :ref:`OEIsDisulfideBond <OEBio_OEIsDisulfideBond>` functor
   that identifies the disulfide bonds.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsDisulfideBond()

      .. oe:language:: python

         .. oe:api:: python

            OEIsDisulfideBond() -> OEIsDisulfideBond

      Default constructor.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> bool

      Returns ``true`` if the ``bond`` is disulfide; otherwise, it returns ``false``.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEBondBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsDisulfideBond

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsDisulfideBond <OEBio_OEIsDisulfideBond>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsHBondInteractionHint:

.. oe:class:: OEIsHBondInteractionHint

   .. oe:api::

      class OEIsHBondInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` functor that
   identifies **hydrogen bonding** interactions.

   .. seealso::

      * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` class
      * :oe:constns:`OEBio::OEHBondInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>` predicate
      * :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>` predicate
      * :ref:`OEIsNonIdealHBondInteractionHint <OEBio_OEIsNonIdealHBondInteractionHint>` predicate
      * :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>` predicate
      * :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsHBondInteractionHint(bool includeIntra = true,
                                     bool includeNonIdeal = true)

      .. oe:language:: python

         .. oe:api:: python

            OEIsHBondInteractionHint(includeIntra: bool = True,
                                     includeNonIdeal: bool = True) -> OEIsHBondInteractionHint
            OEIsHBondInteractionHint(arg2: OEIsHBondInteractionHint) -> OEIsHBondInteractionHint

      Constructor.

      :param includeIntra: If ``true`` (default), intramolecular hydrogen bond
         interactions are included in the results.
      :param includeNonIdeal: If ``true`` (default), non-ideal hydrogen bond
         interactions (long donor-acceptor distances or poor geometries) are
         included in the results.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsHBondInteractionHint & operator=(const OEIsHBondInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& c) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(c: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a hydrogen bonding
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
      type. Clashing hydrogen bond interactions
      (:oe:const:`OEBio::OEHBondInteractionHintType::ClashAcceptorAcceptor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::ClashDonorDonor`) and
      unpaired interactions
      (:oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandDonor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandAcceptor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinDonor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinAcceptor`)
      are **not** included. Use
      :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>`
      and :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>`
      to retrieve those interaction types.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsHalogenBondInteractionHint:

.. oe:class:: OEIsHalogenBondInteractionHint

   .. oe:api::

      class OEIsHalogenBondInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsHalogenBondInteractionHint <OEBio_OEIsHalogenBondInteractionHint>` functor that
   identifies **halogen bonding** interactions.

   .. seealso::

      * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` class
      * :oe:constns:`OEBio::OEHalogenBondInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsIntermolecularHalogenBondInteractionHint <OEBio_OEIsIntermolecularHalogenBondInteractionHint>` predicate
      * :ref:`OEIsIntramolecularHalogenBondInteractionHint <OEBio_OEIsIntramolecularHalogenBondInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsHalogenBondInteractionHint(bool includeIntra = true)

      .. oe:language:: python

         .. oe:api:: python

            OEIsHalogenBondInteractionHint(includeIntra: bool = True) -> OEIsHalogenBondInteractionHint
            OEIsHalogenBondInteractionHint(arg2: OEIsHalogenBondInteractionHint) -> OEIsHalogenBondInteractionHint

      Constructor.

      :param includeIntra: If ``true`` (default), intramolecular halogen bond
         interactions are included in the results.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsHalogenBondInteractionHint & operator=(const OEIsHalogenBondInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a halogen bonding
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>`
      type.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsHalogenBondInteractionHint <OEBio_OEIsHalogenBondInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsHetAtom, IsHet

.. _OEBio_OEIsHetAtom:

.. oe:class:: OEIsHetAtom

   .. oe:api::

      class OEIsHetAtom : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsHetAtom <OEBio_OEIsHetAtom>` functor
   that identifies the atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) that have the
   ‘hetero atom’ property in a residue.

   .. seealso::

      * :oe:meth:`OEChem::OEResidue::IsHetAtom` method

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsHetAtom()

      .. oe:language:: python

         .. oe:api:: python

            OEIsHetAtom() -> OEIsHetAtom

      Default constructor.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true`` if the ``atom`` has the ‘hetero atom’ property in a
      residue; otherwise, it returns ``false``.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsHetAtom

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsHetAtom <OEBio_OEIsHetAtom>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsInterInteractionHint:

.. oe:class:: OEIsInterInteractionHint

   .. oe:api::

      class OEIsInterInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsInterInteractionHint <OEBio_OEIsInterInteractionHint>` functor that
   identifies connections (:ref:`OEInteractionHint <OEBio_OEInteractionHint>`)
   within two different molecules stored in the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>`
   object.

   .. seealso::

      * :oe:meth:`OEBio::OEInteractionHintContainer::GetInteractions` method
      * :ref:`OEIsIntraInteractionHint <OEBio_OEIsIntraInteractionHint>` functor
      * :oe:meth:`OEBio::OEInteractionHint::IsInter` method

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsInterInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsInterInteractionHint() -> OEIsInterInteractionHint
            OEIsInterInteractionHint(arg2: OEIsInterInteractionHint) -> OEIsInterInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsInterInteractionHint & operator=(const OEIsInterInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the interaction is between two
      different molecules.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsInterInteractionHint <OEBio_OEIsInterInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsIntermolecularCationPiInteractionHint:

.. oe:class:: OEIsIntermolecularCationPiInteractionHint

   .. oe:api::

      class OEIsIntermolecularCationPiInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntermolecularCationPiInteractionHint <OEBio_OEIsIntermolecularCationPiInteractionHint>` functor that
   identifies **cation-pi** interactions between atoms in different molecules
   (i.e. between the ligand and the protein).

   .. seealso::

      * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` class
      * :oe:constns:`OEBio::OECationPiInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>` predicate
      * :ref:`OEIsIntramolecularCationPiInteractionHint <OEBio_OEIsIntramolecularCationPiInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntermolecularCationPiInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntermolecularCationPiInteractionHint() -> OEIsIntermolecularCationPiInteractionHint
            OEIsIntermolecularCationPiInteractionHint(arg2: OEIsIntermolecularCationPiInteractionHint) -> OEIsIntermolecularCationPiInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsIntermolecularCationPiInteractionHint & operator=(const OEIsIntermolecularCationPiInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has an intermolecular
      cation-pi type *i.e.* the
      :oe:meth:`OEBio::OEInteractionHint::GetInteractionType` method returns an
      :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` with
      one of the following types:

      * :oe:const:`OEBio::OECationPiInteractionHintType::LigandPi`
      * :oe:const:`OEBio::OECationPiInteractionHintType::ProteinPi`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntermolecularCationPiInteractionHint <OEBio_OEIsIntermolecularCationPiInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsIntermolecularChelatorInteractionHint:

.. oe:class:: OEIsIntermolecularChelatorInteractionHint

   .. oe:api::

      class OEIsIntermolecularChelatorInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntermolecularChelatorInteractionHint <OEBio_OEIsIntermolecularChelatorInteractionHint>` functor that
   identifies **chelator** interactions between two atoms in the different molecule.

   .. seealso::

      * :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>` class
      * :oe:constns:`OEBio::OEChelatorInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsChelatorInteractionHint <OEBio_OEIsChelatorInteractionHint>` predicate
      * :ref:`OEIsIntramolecularChelatorInteractionHint <OEBio_OEIsIntramolecularChelatorInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntermolecularChelatorInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntermolecularChelatorInteractionHint() -> OEIsIntermolecularChelatorInteractionHint
            OEIsIntermolecularChelatorInteractionHint(arg2: OEIsIntermolecularChelatorInteractionHint) -> OEIsIntermolecularChelatorInteractionHint

      Default constructor.

   
   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsIntermolecularChelatorInteractionHint & operator=(const OEIsIntermolecularChelatorInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& c) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(c: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a hydrogen bonding
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>` with the
      following types:

      * :oe:const:`OEBio::OEChelatorInteractionHintType::LigandChelates`
      * :oe:const:`OEBio::OEChelatorInteractionHintType::ProteinChelates`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntermolecularChelatorInteractionHint <OEBio_OEIsIntermolecularChelatorInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsIntermolecularHBondInteractionHint:

.. oe:class:: OEIsIntermolecularHBondInteractionHint

   .. oe:api::

      class OEIsIntermolecularHBondInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>` functor that
   identifies **hydrogen bonding** interactions between two atom in different molecules.

   .. seealso::

      * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` class
      * :oe:constns:`OEBio::OEHBondInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` predicate
      * :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>` predicate
      * :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntermolecularHBondInteractionHint(bool includeNonIdeal = true)

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntermolecularHBondInteractionHint(includeNonIdeal: bool = True) -> OEIsIntermolecularHBondInteractionHint
            OEIsIntermolecularHBondInteractionHint(arg2: OEIsIntermolecularHBondInteractionHint) -> OEIsIntermolecularHBondInteractionHint

      Constructor.

      :param includeNonIdeal: If ``true`` (default), non-ideal hydrogen bond
         interactions (long donor-acceptor distances or poor geometries) are
         included in the results.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsIntermolecularHBondInteractionHint & operator=(const OEIsIntermolecularHBondInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& c) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(c: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a hydrogen bonding
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` with the following types:

      * :oe:const:`OEBio::OEHBondInteractionHintType::LigandAccepts`
      * :oe:const:`OEBio::OEHBondInteractionHintType::LigandDonates`

      When ``includeNonIdeal`` is ``true`` (default), the following types are
      also included:

      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandAccepts`
      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandDonates`

      Clashing interactions (:oe:const:`OEBio::OEHBondInteractionHintType::ClashAcceptorAcceptor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::ClashDonorDonor`) are not
      included. Use :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>`
      for those.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.



.. oe:namespace:: OEBio

.. _OEBio_OEIsIntermolecularHalogenBondInteractionHint:

.. oe:class:: OEIsIntermolecularHalogenBondInteractionHint

   .. oe:api::

      class OEIsIntermolecularHalogenBondInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntermolecularHalogenBondInteractionHint <OEBio_OEIsIntermolecularHalogenBondInteractionHint>` functor that
   identifies **halogen bond** interactions between atoms in different molecules
   (i.e. between the ligand and the protein).

   .. seealso::

      * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` class
      * :oe:constns:`OEBio::OEHalogenBondInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsHalogenBondInteractionHint <OEBio_OEIsHalogenBondInteractionHint>` predicate
      * :ref:`OEIsIntramolecularHalogenBondInteractionHint <OEBio_OEIsIntramolecularHalogenBondInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntermolecularHalogenBondInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntermolecularHalogenBondInteractionHint() -> OEIsIntermolecularHalogenBondInteractionHint
            OEIsIntermolecularHalogenBondInteractionHint(arg2: OEIsIntermolecularHalogenBondInteractionHint) -> OEIsIntermolecularHalogenBondInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsIntermolecularHalogenBondInteractionHint & operator=(const OEIsIntermolecularHalogenBondInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has an intermolecular
      halogen bond type *i.e.* the
      :oe:meth:`OEBio::OEInteractionHint::GetInteractionType` method returns an
      :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` with
      one of the following types:

      * :oe:const:`OEBio::OEHalogenBondInteractionHintType::LigandElectrophile`
      * :oe:const:`OEBio::OEHalogenBondInteractionHintType::LigandNucleophile`
      * :oe:const:`OEBio::OEHalogenBondInteractionHintType::ProteinElectrophile`
      * :oe:const:`OEBio::OEHalogenBondInteractionHintType::ProteinNucleophile`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntermolecularHalogenBondInteractionHint <OEBio_OEIsIntermolecularHalogenBondInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsIntermolecularSaltBridgeInteractionHint:

.. oe:class:: OEIsIntermolecularSaltBridgeInteractionHint

   .. oe:api::

      class OEIsIntermolecularSaltBridgeInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntermolecularSaltBridgeInteractionHint <OEBio_OEIsIntermolecularSaltBridgeInteractionHint>` functor that
   identifies **salt-bridge** interactions between atoms in different molecules
   (i.e. between the ligand and the protein).

   .. seealso::

      * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>` class
      * :oe:constns:`OEBio::OESaltBridgeInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>` predicate
      * :ref:`OEIsIntramolecularSaltBridgeInteractionHint <OEBio_OEIsIntramolecularSaltBridgeInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntermolecularSaltBridgeInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntermolecularSaltBridgeInteractionHint() -> OEIsIntermolecularSaltBridgeInteractionHint
            OEIsIntermolecularSaltBridgeInteractionHint(arg2: OEIsIntermolecularSaltBridgeInteractionHint) -> OEIsIntermolecularSaltBridgeInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsIntermolecularSaltBridgeInteractionHint & operator=(const OEIsIntermolecularSaltBridgeInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has an intermolecular
      salt-bridge type *i.e.* the
      :oe:meth:`OEBio::OEInteractionHint::GetInteractionType` method returns an
      :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>` with
      one of the following types:

      * :oe:const:`OEBio::OESaltBridgeInteractionHintType::LigandNegative`
      * :oe:const:`OEBio::OESaltBridgeInteractionHintType::LigandPositive`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntermolecularSaltBridgeInteractionHint <OEBio_OEIsIntermolecularSaltBridgeInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsIntermolecularStackingInteractionHint:

.. oe:class:: OEIsIntermolecularStackingInteractionHint

   .. oe:api::

      class OEIsIntermolecularStackingInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntermolecularStackingInteractionHint <OEBio_OEIsIntermolecularStackingInteractionHint>` functor that
   identifies **stacking** interactions between aromatic rings in different
   molecules (i.e. between the ligand and the protein).

   .. seealso::

      * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` class
      * :oe:constns:`OEBio::OEStackingInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsStackingInteractionHint <OEBio_OEIsStackingInteractionHint>` predicate
      * :ref:`OEIsIntramolecularStackingInteractionHint <OEBio_OEIsIntramolecularStackingInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntermolecularStackingInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntermolecularStackingInteractionHint() -> OEIsIntermolecularStackingInteractionHint
            OEIsIntermolecularStackingInteractionHint(arg2: OEIsIntermolecularStackingInteractionHint) -> OEIsIntermolecularStackingInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsIntermolecularStackingInteractionHint & operator=(const OEIsIntermolecularStackingInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has an intermolecular
      stacking type *i.e.* the
      :oe:meth:`OEBio::OEInteractionHint::GetInteractionType` method returns an
      :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` with
      one of the following types:

      * :oe:const:`OEBio::OEStackingInteractionHintType::Pi`
      * :oe:const:`OEBio::OEStackingInteractionHintType::T`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntermolecularStackingInteractionHint <OEBio_OEIsIntermolecularStackingInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsIntraInteractionHint:

.. oe:class:: OEIsIntraInteractionHint

   .. oe:api::

      class OEIsIntraInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntraInteractionHint <OEBio_OEIsIntraInteractionHint>` functor that
   identifies connections (:ref:`OEInteractionHint <OEBio_OEInteractionHint>`)
   within the same molecule stored in the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>`
   object.

   .. seealso::

      * :oe:meth:`OEBio::OEInteractionHintContainer::GetInteractions` method
      * :ref:`OEIsInterInteractionHint <OEBio_OEIsInterInteractionHint>` functor
      * :oe:meth:`OEBio::OEInteractionHint::IsIntra` method

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntraInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntraInteractionHint() -> OEIsIntraInteractionHint
            OEIsIntraInteractionHint(arg2: OEIsIntraInteractionHint) -> OEIsIntraInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsIntraInteractionHint & operator=(const OEIsIntraInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the interaction is within the same molecule.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntraInteractionHint <OEBio_OEIsIntraInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsIntramolecularCationPiInteractionHint:

.. oe:class:: OEIsIntramolecularCationPiInteractionHint

   .. oe:api::

      class OEIsIntramolecularCationPiInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntramolecularCationPiInteractionHint <OEBio_OEIsIntramolecularCationPiInteractionHint>` functor that
   identifies **intramolecular cation-pi** interactions between a cation and an
   aromatic ring within the same molecule (ligand or protein).

   .. seealso::

      * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` class
      * :oe:constns:`OEBio::OECationPiInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>` predicate
      * :ref:`OEIsIntermolecularCationPiInteractionHint <OEBio_OEIsIntermolecularCationPiInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntramolecularCationPiInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntramolecularCationPiInteractionHint() -> OEIsIntramolecularCationPiInteractionHint
            OEIsIntramolecularCationPiInteractionHint(arg2: OEIsIntramolecularCationPiInteractionHint) -> OEIsIntramolecularCationPiInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsIntramolecularCationPiInteractionHint & operator=(const OEIsIntramolecularCationPiInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has an intramolecular
      cation-pi type *i.e.* the
      :oe:meth:`OEBio::OEInteractionHint::GetInteractionType` method returns an
      :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` with
      one of the following types:

      * :oe:const:`OEBio::OECationPiInteractionHintType::IntramolecularLigand`
      * :oe:const:`OEBio::OECationPiInteractionHintType::IntramolecularProtein`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntramolecularCationPiInteractionHint <OEBio_OEIsIntramolecularCationPiInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsIntramolecularChelatorInteractionHint:

.. oe:class:: OEIsIntramolecularChelatorInteractionHint

   .. oe:api::

      class OEIsIntramolecularChelatorInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntramolecularChelatorInteractionHint <OEBio_OEIsIntramolecularChelatorInteractionHint>` functor that
   identifies **chelator** interactions between two atoms in the same molecule.

   .. seealso::

      * :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>` class
      * :oe:constns:`OEBio::OEChelatorInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsChelatorInteractionHint <OEBio_OEIsChelatorInteractionHint>` predicate
      * :ref:`OEIsIntermolecularChelatorInteractionHint <OEBio_OEIsIntermolecularChelatorInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntramolecularChelatorInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntramolecularChelatorInteractionHint() -> OEIsIntramolecularChelatorInteractionHint
            OEIsIntramolecularChelatorInteractionHint(arg2: OEIsIntramolecularChelatorInteractionHint) -> OEIsIntramolecularChelatorInteractionHint

      Default constructor.

   
   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsIntramolecularChelatorInteractionHint & operator=(const OEIsIntramolecularChelatorInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& c) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(c: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a chelator bonding
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>` with
      :oe:const:`OEBio::OEChelatorInteractionHintType::IntramolecularProtein` 
      type.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntramolecularChelatorInteractionHint <OEBio_OEIsIntramolecularChelatorInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsIntramolecularHBondInteractionHint:

.. oe:class:: OEIsIntramolecularHBondInteractionHint

   .. oe:api::

      class OEIsIntramolecularHBondInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>` functor that
   identifies **hydrogen bonding** interactions between two atoms in the same molecule.

   .. seealso::

      * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` class
      * :oe:constns:`OEBio::OEHBondInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` predicate
      * :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>` predicate
      * :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntramolecularHBondInteractionHint(bool includeNonIdeal = true)

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntramolecularHBondInteractionHint(includeNonIdeal: bool = True) -> OEIsIntramolecularHBondInteractionHint
            OEIsIntramolecularHBondInteractionHint(arg2: OEIsIntramolecularHBondInteractionHint) -> OEIsIntramolecularHBondInteractionHint

      Constructor.

      :param includeNonIdeal: If ``true`` (default), non-ideal intramolecular
         hydrogen bond interactions are included in the results.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsIntramolecularHBondInteractionHint & operator=(const OEIsIntramolecularHBondInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& c) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(c: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has an intramolecular hydrogen
      bonding type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` with the following types:

      * :oe:const:`OEBio::OEHBondInteractionHintType::IntramolecularLigand`
      * :oe:const:`OEBio::OEHBondInteractionHintType::IntramolecularProtein`

      When ``includeNonIdeal`` is ``true`` (default), the following types are
      also included:

      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealProteinAccepts`
      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealProteinDonates`
      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandDonates`
      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandAccepts`

      Unpaired interactions are not included. Use
      :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>`
      to retrieve unpaired hydrogen bond donors and acceptors.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.



.. oe:namespace:: OEBio

.. _OEBio_OEIsIntramolecularHalogenBondInteractionHint:

.. oe:class:: OEIsIntramolecularHalogenBondInteractionHint

   .. oe:api::

      class OEIsIntramolecularHalogenBondInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntramolecularHalogenBondInteractionHint <OEBio_OEIsIntramolecularHalogenBondInteractionHint>` functor that
   identifies **intramolecular halogen bond** interactions between a halogen
   and an acceptor within the same molecule (ligand or protein).

   .. seealso::

      * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` class
      * :oe:constns:`OEBio::OEHalogenBondInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsHalogenBondInteractionHint <OEBio_OEIsHalogenBondInteractionHint>` predicate
      * :ref:`OEIsIntermolecularHalogenBondInteractionHint <OEBio_OEIsIntermolecularHalogenBondInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntramolecularHalogenBondInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntramolecularHalogenBondInteractionHint() -> OEIsIntramolecularHalogenBondInteractionHint
            OEIsIntramolecularHalogenBondInteractionHint(arg2: OEIsIntramolecularHalogenBondInteractionHint) -> OEIsIntramolecularHalogenBondInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsIntramolecularHalogenBondInteractionHint & operator=(const OEIsIntramolecularHalogenBondInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has an intramolecular
      halogen bond type *i.e.* the
      :oe:meth:`OEBio::OEInteractionHint::GetInteractionType` method returns an
      :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` with
      one of the following types:

      * :oe:const:`OEBio::OEHalogenBondInteractionHintType::IntramolecularLigand`
      * :oe:const:`OEBio::OEHalogenBondInteractionHintType::IntramolecularProtein`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntramolecularHalogenBondInteractionHint <OEBio_OEIsIntramolecularHalogenBondInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsIntramolecularSaltBridgeInteractionHint:

.. oe:class:: OEIsIntramolecularSaltBridgeInteractionHint

   .. oe:api::

      class OEIsIntramolecularSaltBridgeInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntramolecularSaltBridgeInteractionHint <OEBio_OEIsIntramolecularSaltBridgeInteractionHint>` functor that
   identifies **intramolecular salt-bridge** interactions between oppositely
   charged groups within the same molecule (ligand or protein).

   .. seealso::

      * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>` class
      * :oe:constns:`OEBio::OESaltBridgeInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>` predicate
      * :ref:`OEIsIntermolecularSaltBridgeInteractionHint <OEBio_OEIsIntermolecularSaltBridgeInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntramolecularSaltBridgeInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntramolecularSaltBridgeInteractionHint() -> OEIsIntramolecularSaltBridgeInteractionHint
            OEIsIntramolecularSaltBridgeInteractionHint(arg2: OEIsIntramolecularSaltBridgeInteractionHint) -> OEIsIntramolecularSaltBridgeInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsIntramolecularSaltBridgeInteractionHint & operator=(const OEIsIntramolecularSaltBridgeInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has an intramolecular
      salt-bridge type *i.e.* the
      :oe:meth:`OEBio::OEInteractionHint::GetInteractionType` method returns an
      :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>` with
      one of the following types:

      * :oe:const:`OEBio::OESaltBridgeInteractionHintType::IntramolecularLigand`
      * :oe:const:`OEBio::OESaltBridgeInteractionHintType::IntramolecularProtein`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntramolecularSaltBridgeInteractionHint <OEBio_OEIsIntramolecularSaltBridgeInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsIntramolecularStackingInteractionHint:

.. oe:class:: OEIsIntramolecularStackingInteractionHint

   .. oe:api::

      class OEIsIntramolecularStackingInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntramolecularStackingInteractionHint <OEBio_OEIsIntramolecularStackingInteractionHint>` functor that
   identifies **intramolecular stacking** interactions between aromatic rings
   within the same molecule (ligand or protein).

   .. seealso::

      * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` class
      * :oe:constns:`OEBio::OEStackingInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsStackingInteractionHint <OEBio_OEIsStackingInteractionHint>` predicate
      * :ref:`OEIsIntermolecularStackingInteractionHint <OEBio_OEIsIntermolecularStackingInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntramolecularStackingInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntramolecularStackingInteractionHint() -> OEIsIntramolecularStackingInteractionHint
            OEIsIntramolecularStackingInteractionHint(arg2: OEIsIntramolecularStackingInteractionHint) -> OEIsIntramolecularStackingInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsIntramolecularStackingInteractionHint & operator=(const OEIsIntramolecularStackingInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has an intramolecular
      stacking type *i.e.* the
      :oe:meth:`OEBio::OEInteractionHint::GetInteractionType` method returns an
      :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` with
      one of the following types:

      * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularLigandPi`
      * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularLigandT`
      * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularProteinPi`
      * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularProteinT`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntramolecularStackingInteractionHint <OEBio_OEIsIntramolecularStackingInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsNTerminalAtom, IsNTerminal

.. _OEBio_OEIsNTerminalAtom:

.. oe:class:: OEIsNTerminalAtom

   .. oe:api::

      class OEIsNTerminalAtom : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsNTerminalAtom <OEBio_OEIsNTerminalAtom>` functor
   that identifies the N-terminal backbone atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) for standard amino
   acid residues in a macro-molecule, or for a nonstandard amino acid residues with a complete backbone.

   .. seealso::

      * :ref:`section_predicates_reside_data_functors` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsNTerminalAtom()

      .. oe:language:: python

         .. oe:api:: python

            OEIsNTerminalAtom() -> OEIsNTerminalAtom

      Default constructor.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsNTerminalAtom

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsNTerminalAtom <OEBio_OEIsNTerminalAtom>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsNonIdealHBondInteractionHint:

.. oe:class:: OEIsNonIdealHBondInteractionHint

   .. oe:api::

      class OEIsNonIdealHBondInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsNonIdealHBondInteractionHint <OEBio_OEIsNonIdealHBondInteractionHint>` functor that
   identifies **non-ideal hydrogen bond** (i.e. hydrogen bonds with long donor-acceptor distances
   or poor geometries) interactions.

   .. seealso::

      * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` class
      * :oe:constns:`OEBio::OEHBondInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class
      * :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` predicate

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsNonIdealHBondInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsNonIdealHBondInteractionHint() -> OEIsNonIdealHBondInteractionHint

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& c) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(c: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has non-ideal hydrogen bonding
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` with the following types:

      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandAccepts`
      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandDonates`
      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealProteinAccepts`
      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealProteinDonates`

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsNonIdealHBondInteractionHint <OEBio_OEIsNonIdealHBondInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsNucleicAcidBase:

.. oe:class:: OEIsNucleicAcidBase

   .. oe:api::

      class OEIsNucleicAcidBase : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsNucleicAcidBase <OEBio_OEIsNucleicAcidBase>` functor that
   identifies nucleic acid base atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   .. seealso::

      * :oe:func:`OEChem::OEGetPDBAtomIndex` function
      * :ref:`section_predicates_reside_data_functors` section
      * :ref:`OEIsNucleicAcidSugar <OEBio_OEIsNucleicAcidSugar>` predicate
      * :ref:`OEIsNucleicAcidPhosphate <OEBio_OEIsNucleicAcidPhosphate>` predicate

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the atom read from a :file:`pdb` file with the following pdb atom
      names:

      * :oe:const:`OEChem::OEPDBAtomName::C2`, :oe:const:`OEChem::OEPDBAtomName::C5`,
        :oe:const:`OEChem::OEPDBAtomName::C6`, :oe:const:`OEChem::OEPDBAtomName::C8`

      * :oe:const:`OEChem::OEPDBAtomName::N1`, :oe:const:`OEChem::OEPDBAtomName::N2`,
        :oe:const:`OEChem::OEPDBAtomName::N3`, :oe:const:`OEChem::OEPDBAtomName::N4`,
        :oe:const:`OEChem::OEPDBAtomName::N6`, :oe:const:`OEChem::OEPDBAtomName::N7`,
        :oe:const:`OEChem::OEPDBAtomName::N9`

      * :oe:const:`OEChem::OEPDBAtomName::O2`, :oe:const:`OEChem::OEPDBAtomName::O4`,
        :oe:const:`OEChem::OEPDBAtomName::O6`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsNucleicAcidBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsNucleicAcidBase <OEBio_OEIsNucleicAcidBase>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsNucleicAcidPhosphate:

.. oe:class:: OEIsNucleicAcidPhosphate

   .. oe:api::

      class OEIsNucleicAcidPhosphate : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsNucleicAcidPhosphate <OEBio_OEIsNucleicAcidPhosphate>` functor that
   identifies nucleic acid phosphate atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   .. seealso::

      * :oe:func:`OEChem::OEGetPDBAtomIndex` function
      * :ref:`section_predicates_reside_data_functors` section
      * :ref:`OEIsNucleicAcidBase <OEBio_OEIsNucleicAcidBase>` predicate
      * :ref:`OEIsNucleicAcidSugar <OEBio_OEIsNucleicAcidSugar>` predicate

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the atom read from a :file:`pdb` file with the following pdb atom
      names:

      * :oe:const:`OEChem::OEPDBAtomName::P`
      * :oe:const:`OEChem::OEPDBAtomName::O1P`, :oe:const:`OEChem::OEPDBAtomName::O2P`,
        :oe:const:`OEChem::OEPDBAtomName::O3P`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsNucleicAcidPhosphate

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsNucleicAcidPhosphate <OEBio_OEIsNucleicAcidPhosphate>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsNucleicAcidSugar:

.. oe:class:: OEIsNucleicAcidSugar

   .. oe:api::

      class OEIsNucleicAcidSugar : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsNucleicAcidSugar <OEBio_OEIsNucleicAcidSugar>` functor that
   identifies nucleic acid sugar atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   .. seealso::

      * :oe:func:`OEChem::OEGetPDBAtomIndex` function
      * :ref:`section_predicates_reside_data_functors` section
      * :ref:`OEIsNucleicAcidBase <OEBio_OEIsNucleicAcidBase>` predicate
      * :ref:`OEIsNucleicAcidPhosphate <OEBio_OEIsNucleicAcidPhosphate>` predicate

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the atom read from a :file:`pdb` file with the following
      pdb atom names:

      * :oe:const:`OEChem::OEPDBAtomName::O2_`, :oe:const:`OEChem::OEPDBAtomName::O3_`,
        :oe:const:`OEChem::OEPDBAtomName::O4_`, :oe:const:`OEChem::OEPDBAtomName::O5_`,
      * :oe:const:`OEChem::OEPDBAtomName::C1_`, :oe:const:`OEChem::OEPDBAtomName::C2_`,
        :oe:const:`OEChem::OEPDBAtomName::C3_`, :oe:const:`OEChem::OEPDBAtomName::C4_`,
        :oe:const:`OEChem::OEPDBAtomName::C5_`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsNucleicAcidSugar

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsNucleicAcidSugar <OEBio_OEIsNucleicAcidSugar>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsSaltBridgeInteractionHint:

.. oe:class:: OEIsSaltBridgeInteractionHint

   .. oe:api::

      class OEIsSaltBridgeInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>` functor that
   identifies **salt-bridge** interactions.

   .. seealso::

      * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>` class
      * :oe:constns:`OEBio::OESaltBridgeInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsIntermolecularSaltBridgeInteractionHint <OEBio_OEIsIntermolecularSaltBridgeInteractionHint>` predicate
      * :ref:`OEIsIntramolecularSaltBridgeInteractionHint <OEBio_OEIsIntramolecularSaltBridgeInteractionHint>` predicate
      * :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsSaltBridgeInteractionHint(bool includeIntra = true)

      .. oe:language:: python

         .. oe:api:: python

            OEIsSaltBridgeInteractionHint(includeIntra: bool = True) -> OEIsSaltBridgeInteractionHint
            OEIsSaltBridgeInteractionHint(arg2: OEIsSaltBridgeInteractionHint) -> OEIsSaltBridgeInteractionHint

      Constructor.

      :param includeIntra: If ``true`` (default), intramolecular salt-bridge
         interactions are included in the results.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsSaltBridgeInteractionHint & operator=(const OEIsSaltBridgeInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a salt-bridge
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`
      type.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsStackingInteractionHint:

.. oe:class:: OEIsStackingInteractionHint

   .. oe:api::

      class OEIsStackingInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsStackingInteractionHint <OEBio_OEIsStackingInteractionHint>` functor that
   identifies **stacking** interactions.

   .. seealso::

      * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` class
      * :oe:constns:`OEBio::OEStackingInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsIntermolecularStackingInteractionHint <OEBio_OEIsIntermolecularStackingInteractionHint>` predicate
      * :ref:`OEIsIntramolecularStackingInteractionHint <OEBio_OEIsIntramolecularStackingInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsStackingInteractionHint(bool includeIntra = true)

      .. oe:language:: python

         .. oe:api:: python

            OEIsStackingInteractionHint(includeIntra: bool = True) -> OEIsStackingInteractionHint
            OEIsStackingInteractionHint(arg2: OEIsStackingInteractionHint) -> OEIsStackingInteractionHint

      Constructor.

      :param includeIntra: If ``true`` (default), intramolecular stacking
         interactions are included in the results.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsStackingInteractionHint & operator=(const OEIsStackingInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a stacking
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>`
      type.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsStackingInteractionHint <OEBio_OEIsStackingInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsStandardAminoAcid

.. _OEBio_OEIsStandardAminoAcid:

.. oe:class:: OEIsStandardAminoAcid

   .. oe:api::

      class OEIsStandardAminoAcid : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsStandardAminoAcid <OEBio_OEIsStandardAminoAcid>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) that are in standard amino acid residues

   .. seealso::

      * :ref:`section_predicates_reside_data_functors` section
      * :func:`OEIsStandardProteinResidue` function

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsStandardAminoAcid()

      .. oe:language:: python

         .. oe:api:: python

            OEIsStandardAminoAcid() -> OEIsStandardAminoAcid

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsStandardAminoAcid

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsStandardAminoAcid <OEBio_OEIsStandardAminoAcid>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsStandardNucleicAcid

.. _OEBio_OEIsStandardNucleicAcid:

.. oe:class:: OEIsStandardNucleicAcid

   .. oe:api::

      class OEIsStandardNucleicAcid : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsStandardNucleicAcid <OEBio_OEIsStandardNucleicAcid>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) that are in standard nucleic acid residues

   .. seealso::

      * :ref:`section_predicates_reside_data_functors` section
      * :func:`OEIsStandardNucleicAcidResidue` function

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsStandardNucleicAcid()

      .. oe:language:: python

         .. oe:api:: python

            OEIsStandardNucleicAcid() -> OEIsStandardNucleicAcid

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsStandardNucleicAcid

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsStandardNucleicAcid <OEBio_OEIsStandardNucleicAcid>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsUnpairedInteractionHint:

.. oe:class:: OEIsUnpairedInteractionHint

   .. oe:api::

      class OEIsUnpairedInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>` functor that
   identifies **unpaired** interactions — hydrogen bond donors or acceptors, and
   charged groups in salt-bridge positions, that have no complementary partner
   in the active site.

   .. note::

      This predicate covers both unpaired hydrogen bond interactions
      (:oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandDonor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandAcceptor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinDonor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinAcceptor`) and
      unpaired salt-bridge interactions
      (:oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedLigandPositive`,
      :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedLigandNegative`,
      :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedProteinPositive`,
      :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedProteinNegative`).

   .. seealso::

      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEIsUnpairedLigandInteractionHint <OEBio_OEIsUnpairedLigandInteractionHint>` predicate
      * :ref:`OEIsUnpairedProteinInteractionHint <OEBio_OEIsUnpairedProteinInteractionHint>` predicate
      * :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` predicate
      * :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsUnpairedInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsUnpairedInteractionHint() -> OEIsUnpairedInteractionHint
            OEIsUnpairedInteractionHint(arg2: OEIsUnpairedInteractionHint) -> OEIsUnpairedInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsUnpairedInteractionHint & operator=(const OEIsUnpairedInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction is an unpaired hydrogen bond
      or unpaired salt-bridge interaction. This is equivalent to
      :ref:`OEIsUnpairedLigandInteractionHint <OEBio_OEIsUnpairedLigandInteractionHint>` ``||``
      :ref:`OEIsUnpairedProteinInteractionHint <OEBio_OEIsUnpairedProteinInteractionHint>`.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OEIsUnpairedLigandInteractionHint:

.. oe:class:: OEIsUnpairedLigandInteractionHint

   .. oe:api::

      class  OEIsUnpairedLigandInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsUnpairedLigandInteractionHint <OEBio_OEIsUnpairedLigandInteractionHint>` functor that
   identifies interactions with only ligand component.

   .. seealso::

      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsUnpairedLigandInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsUnpairedLigandInteractionHint() -> OEIsUnpairedLigandInteractionHint
            OEIsUnpairedLigandInteractionHint(arg2: OEIsUnpairedLigandInteractionHint) -> OEIsUnpairedLigandInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsUnpairedLigandInteractionHint & operator=(const OEIsUnpairedLigandInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has only a ligand
      component. 

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsUnpairedLigandInteractionHint <OEBio_OEIsUnpairedLigandInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.



.. oe:namespace:: OEBio

.. _OEBio_OEIsUnpairedProteinInteractionHint:

.. oe:class:: OEIsUnpairedProteinInteractionHint

   .. oe:api::

      class OEIsUnpairedProteinInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsUnpairedProteinInteractionHint <OEBio_OEIsUnpairedProteinInteractionHint>` functor that
   identifies interactions with only protein component..

   .. seealso::

      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsUnpairedProteinInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsUnpairedProteinInteractionHint() -> OEIsUnpairedProteinInteractionHint
            OEIsUnpairedProteinInteractionHint(arg2: OEIsUnpairedProteinInteractionHint) -> OEIsUnpairedProteinInteractionHint

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsUnpairedProteinInteractionHint & operator=(const OEIsUnpairedProteinInteractionHint &)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has only a protein
      component. 

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsUnpairedProteinInteractionHint <OEBio_OEIsUnpairedProteinInteractionHint>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.



.. oe:namespace:: OEBio

.. _OEBio_OEIsWater:

.. oe:class:: OEIsWater

   .. oe:api::

      class OEIsWater : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsWater <OEBio_OEIsWater>` functor that
   determines if an atom (:ref:`OEAtomBase <OEChem_OEAtomBase>`) is in a water molecule.

   .. seealso::

      * :ref:`section_predicates_reside_data_functors` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsWater(bool checkHydrogens = false, bool allowIons = false)

      .. oe:language:: python

         .. oe:api:: python

            OEIsWater(checkHydrogens: bool = False, allowIons: bool = False) -> OEIsWater

      Constructs the functor to determine if an atom is part of a water molecule.
      If the optional argument ``checkHydrogens`` is set to ``true``, the function checks whether
      hydrogen atoms are part of a water molecule and returns ``true``. The default behavior
      only returns ``true`` for water oxygen atoms, which is useful for counting water molecules in a system.
      If optional argument ``allowIons`` is set to ``true``, the function allows checking for
      the water ions :math:`OH^{-}` and :math:`H_{3}O^{+}`.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the atom

      * read from a :file:`pdb` file with the following pdb residue names:
        `HOH`, `H2O`, `DOD`, `D2O`, `WAT`, `TIP`, `SOL`, `OH2`, `OD2`.
      * is an oxygen and has no heavy atom neighbor

      otherwise it returns ``false``.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsWater

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsWater <OEBio_OEIsWater>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEBio

.. _OEBio_OELigandInteractionHintComponent:

.. oe:class:: OELigandInteractionHintComponent

   .. oe:api::

      class OELigandInteractionHintComponent : public OEInteractionHintComponentTypeBase

   Built-in component type that classifies molecules as being 'ligand' when
   stored in a :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

   The following methods are publicly inherited from :ref:`OEInteractionHintComponentTypeBase <OEBio_OEInteractionHintComponentTypeBase>`:

   ============================================================================ ============================================================================ ============================================================================
   :oe:meth:`operator=<OEBio::OEInteractionHintComponentTypeBase::operator=>`   :oe:meth:`operator==<OEBio::OEInteractionHintComponentTypeBase::operator==>` :oe:meth:`GetName<OEBio::OEInteractionHintComponentTypeBase::GetName>`
   :oe:meth:`operator!=<OEBio::OEInteractionHintComponentTypeBase::operator!=>` :oe:meth:`CreateCopy<OEBio::OEInteractionHintComponentTypeBase::CreateCopy>` :oe:meth:`IsValid<OEBio::OEInteractionHintComponentTypeBase::IsValid>`
   ============================================================================ ============================================================================ ============================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OELigandInteractionHintComponent()

      .. oe:language:: python

         .. oe:api:: python

            OELigandInteractionHintComponent() -> OELigandInteractionHintComponent

      Default constructor.

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

         .. oe:api::

            OELigandInteractionHintComponent(const OELigandInteractionHintComponent& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OELigandInteractionHintComponent(arg2: OELigandInteractionHintComponent) -> OELigandInteractionHintComponent

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELigandInteractionHintComponent &operator=(const OELigandInteractionHintComponent &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintComponentTypeBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintComponentTypeBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: GetMaxHeavyAtom

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

         .. oe:api::

            unsigned int GetMaxHeavyAtom() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHeavyAtom() -> int

      Returns the maximum number of heavy atoms that a molecule
      allowed to have in order to be able to be considered as a 'ligand' in
      a :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEChem::OEMolBase &) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Returns whether a molecule can be inserted to a
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object with a
      :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>` type *i.e.*
      it returns true if the molecule has 3D coordinates and its number
      of heavy atoms in the range of [1, 200].

      .. seealso::

         * :oe:meth:`OEBio::OELigandInteractionHintComponent::SetMaxHeavyAtom` method
         * :oe:meth:`OEBio::OELigandInteractionHintComponent::GetMaxHeavyAtom` method

   .. oe:method:: SetMaxHeavyAtom

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

         .. oe:api::

            void SetMaxHeavyAtom(unsigned int maxhvy)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHeavyAtom(maxhvy: int) -> None

      Sets the maximum number of heavy atoms that a molecule
      allowed to have in order to be able to be considered as a 'ligand' in
      a :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEMolComplexCategorizer, MolComplexCategorizer

.. _OEBio_OEMolComplexCategorizer:

.. oe:class:: OEMolComplexCategorizer

   .. oe:api::

      class OEMolComplexCategorizer : public OEMolComplexCategorizerBase

   Concrete class functor used by :oe:func:`OEBio::OESplitMolComplex` and
   :oe:func:`OEBio::OEGetMolComplexComponents` to assign
   functional roles to molecular fragments.
   The :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` class holds a
   `OEMolComplexCategorizer` object by default.

   The following methods are publicly inherited from :ref:`OEMolComplexCategorizerBase <OEBio_OEMolComplexCategorizerBase>`:

   =============================================================================================== ===============================================================================================
   :oe:meth:`operator()<OEBio::OEMolComplexCategorizerBase::operator()>`                           :oe:meth:`GetBundleCofactors<OEBio::OEMolComplexCategorizerBase::GetBundleCofactors>`
   :oe:meth:`CreateCopy<OEBio::OEMolComplexCategorizerBase::CreateCopy>`                           :oe:meth:`UsingExplicitLigandName<OEBio::OEMolComplexCategorizerBase::UsingExplicitLigandName>`
   :oe:meth:`GetResidueCategoryData<OEBio::OEMolComplexCategorizerBase::GetResidueCategoryData>`
   =============================================================================================== ===============================================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMolComplexCategorizer(const OEMolComplexCategorizer& rhs)
            OEMolComplexCategorizer(const std::string& ligName = std::string())

      .. oe:language:: python

         .. oe:api:: python

            OEMolComplexCategorizer(ligName: str = str()) -> OEMolComplexCategorizer
            OEMolComplexCategorizer(rhs: OEMolComplexCategorizer) -> OEMolComplexCategorizer

      Constructor and copy constructor. If ``ligName`` is specified
      in the call to the constructor, the method
      :oe:meth:`UsingExplicitLigandName<OEBio::OEMolComplexCategorizer::UsingExplicitLigandName>`
      will return ``true`` and components will be recognized as ligands if and only if
      they have a matching residue name string.

      .. seealso::

         * :oe:meth:`OEBio::OEMolComplexCategorizer::AddLigandName`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolComplexCategorizer &operator=(const OEMolComplexCategorizer &rhs)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            std::string operator() (OESystem::OERoleSet& roles, OEMolComplexResCounts& counts, const OEChem::OEAtomBondSet& frag, bool isCovalent = false) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(roles: OERoleSet, counts: OEMolComplexResCounts,
                     frag: OEAtomBondSet, isCovalent: bool = False) -> str

      Method to examine the :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` ``frag``
      and return three things
      required by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents` to process the component:

      * a new title string
      * a :ref:`OERoleSet <OESystem_OERoleSet>` containing the functional roles
        associated with this fragment (see :oe:constns:`OEBio::OEMolComplexFilterCategory`)
      * an updated map of how many times a residue has been seen to date

      If ``isCovalent`` is true, additional tests may be performed to determine
      whether the fragment might be considered a (covalent) ligand which is indicated
      with the :oe:const:`OEBio::OEMolComplexFilterCategory::Ligand` :ref:`OERole <OESystem_OERole>`
      in ``roles``.

   .. oe:method:: AddLigandName

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

         .. oe:api::

            void AddLigandName(const std::string& ligName)

      .. oe:language:: python

         .. oe:api:: python

            AddLigandName(ligName: str) -> None

      Store an additional ligand name in the :ref:`OEResidueCategoryData <OEBio_OEResidueCategoryData>`
      associated with this object. Method
      :oe:meth:`UsingExplicitLigandName<OEBio::OEMolComplexCategorizer::UsingExplicitLigandName>`
      will return ``true`` and components will be recognized as ligands if and only if
      they have a residue name string matching one of the
      :oe:const:`OEBio::OEResidueDatabaseCategory::Ligand` entries.

      .. seealso::

         * :oe:meth:`OEBio::OEMolComplexCategorizer::Constructors`
         * :oe:meth:`OEBio::OEMolComplexCategorizer::SetResidueCategoryData`

   .. oe:method:: ClearLigandSubSearch

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

         .. oe:api::

            void ClearLigandSubSearch()

      .. oe:language:: python

         .. oe:api:: python

            ClearLigandSubSearch() -> None

      Clear any ligand subsearch pattern.

      .. seealso::

         * :oe:meth:`OEBio::OEMolComplexCategorizer::GetLigandSubSearch`
         * :oe:meth:`OEBio::OEMolComplexCategorizer::SetLigandSubSearch`

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEMolComplexCategorizerBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMolComplexCategorizerBase

      CreateCopy method.

   .. oe:method:: GetBundleCofactors

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

         .. oe:api::

            bool GetBundleCofactors() const

      .. oe:language:: python

         .. oe:api:: python

            GetBundleCofactors() -> bool

      Returns ``true`` if cofactors (other than metals) are associated with
      the category :oe:const:`OEBio::OEMolComplexFilterCategory::ProtComplex`.

   .. oe:method:: GetLigandSubSearch

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

         .. oe:api::

            OEChem::OESubSearch GetLigandSubSearch() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandSubSearch() -> OESubSearch

      Return the subsearch pattern used to identify the ligand by graph.

      .. seealso::

         * :ref:`section_patternmatch_sss` section
         * :oe:meth:`OEBio::OEMolComplexCategorizer::SetLigandSubSearch`
         * :oe:meth:`OEBio::OEMolComplexCategorizer::ClearLigandSubSearch`

   .. oe:method:: GetMaxLigAtoms

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

         .. oe:api::

            unsigned GetMaxLigAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxLigAtoms() -> int

      Return the maximum number of non-hydrogen atoms in a ligand.

      .. seealso::

         * :oe:meth:`OEBio::OEMolComplexCategorizer::SetMaxLigAtoms`

   .. oe:method:: GetMaxLigResidues

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

         .. oe:api::

            unsigned GetMaxLigResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxLigResidues() -> int

      .. seealso::

         * :oe:meth:`OEBio::OEMolComplexCategorizer::SetMaxLigResidues`

      Return the maximum number of residues in a ligand.

   .. oe:method:: GetMaxPeptideResidues

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

         .. oe:api::

            unsigned GetMaxPeptideResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxPeptideResidues() -> int

      Return the maximum number of residues in a peptide.

   .. oe:method:: GetMaxProteinAtoms

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

         .. oe:api::

            unsigned GetMaxProteinAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxProteinAtoms() -> int

      Return the maximum number of non-hydrogen atoms in a protein.

   .. oe:method:: GetMinLigAtoms

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

         .. oe:api::

            unsigned GetMinLigAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinLigAtoms() -> int

      Return the minimum number of non-hydrogen atoms in a ligand.

      .. seealso::

         * :oe:meth:`OEBio::OEMolComplexCategorizer::SetMinLigAtoms`

   .. oe:method:: GetResidueCategoryData

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

         .. oe:api::

            OEResidueCategoryData* GetResidueCategoryData() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidueCategoryData() -> OEResidueCategoryData

      Return a new copy of the :ref:`OEResidueCategoryData <OEBio_OEResidueCategoryData>`
      object used to define all the molecular components that
      are *not* ligands.

      .. oe:language:: c++

         To avoid a memory leak in C++, the returned pointer should be
         stored in a variable of the
         :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` template class
         or deallocated with the ``delete`` operator.

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

         .. oe:api::

            OEResidueCategoryData& GetResidueCategoryData()

      .. oe:language:: python

         .. oe:api:: python

            GetResidueCategoryData() -> OEResidueCategoryData

      Returns a reference to the :ref:`OEResidueCategoryData <OEBio_OEResidueCategoryData>`
      object used to define all the molecular components that
      are *not* ligands.

   .. oe:method:: SetBundleCofactors

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

         .. oe:api::

            void SetBundleCofactors(bool bundle = true)

      .. oe:language:: python

         .. oe:api:: python

            SetBundleCofactors(bundle: bool = True) -> None

      Controls whether cofactors (other than metals) should be associated with
      the category :oe:const:`OEBio::OEMolComplexFilterCategory::ProtComplex`.

   .. oe:method:: SetLigandSubSearch

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

         .. oe:api::

            void SetLigandSubSearch(const char* smarts)
            void SetLigandSubSearch(const OEChem::OESubSearch& ss)

      .. oe:language:: python

         .. oe:api:: python

            SetLigandSubSearch(smarts: str) -> None
            SetLigandSubSearch(ss: OESubSearch) -> None

      Define a subsearch pattern used to identify the ligand by graph.

      .. seealso::

         * :ref:`section_patternmatch_sss` section
         * :oe:meth:`OEBio::OEMolComplexCategorizer::GetLigandSubSearch`
         * :oe:meth:`OEBio::OEMolComplexCategorizer::ClearLigandSubSearch`

   .. oe:method:: SetMaxLigAtoms

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

         .. oe:api::

            void SetMaxLigAtoms(unsigned n)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxLigAtoms(n: int) -> None

      Set the maximum number of non-hydrogen atoms in a ligand.
      Default = 70.

      .. note::

         When no ligand is found, other molecules such as peptides,
         nucleic acids, or sugars may be treated as ligands. If this
         occurs, this restriction will not apply.

   .. oe:method:: SetMaxLigResidues

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

         .. oe:api::

            void SetMaxLigResidues(unsigned n)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxLigResidues(n: int) -> None

      Set the maximum number of residues in a ligand.
      Default = 3.

      .. note::

         When no ligand is found, other molecules such as peptides,
         nucleic acids, or sugars may be treated as ligands. If this
         occurs, this restriction will not apply.

   .. oe:method:: SetMaxPeptideResidues

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

         .. oe:api::

            void SetMaxPeptideResidues(unsigned n)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxPeptideResidues(n: int) -> None

      Set the maximum number of residues to be considered a peptide.
      Default = 49.

   .. oe:method:: SetMaxProteinAtoms

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

         .. oe:api::

            void SetMaxProteinAtoms(unsigned n)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxProteinAtoms(n: int) -> None

      Set the maximum number of non-hydrogen atoms in a protein.
      Default = 0, meaning unlimited.

   .. oe:method:: SetMinLigAtoms

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

         .. oe:api::

            void SetMinLigAtoms(unsigned n)

      .. oe:language:: python

         .. oe:api:: python

            SetMinLigAtoms(n: int) -> None

      Set the minimum number of non-hydrogen atoms in a ligand.
      Default = 4.

      .. note::

         When no ligand is found, other molecules such as peptides,
         nucleic acids, or sugars may be treated as ligands. If this
         occurs, this restriction will not apply.

   .. oe:method:: SetResidueCategoryData

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

         .. oe:api::

            void SetResidueCategoryData(const OEResidueCategoryData& db)

      .. oe:language:: python

         .. oe:api:: python

            SetResidueCategoryData(db: OEResidueCategoryData) -> None

      Set the :ref:`OEResidueCategoryData <OEBio_OEResidueCategoryData>` object used to
      define all the molecular components that are *not* ligands.

   .. oe:method:: UsingExplicitLigandName

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

         .. oe:api::

            bool UsingExplicitLigandName() const

      .. oe:language:: python

         .. oe:api:: python

            UsingExplicitLigandName() -> bool

      Returns ``true`` if an explicit ligand residue name is being used
      to identify the ligand.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEMolComplexCategorizerBase, MolComplexCategorizerBase

.. _OEBio_OEMolComplexCategorizerBase:

.. oe:class:: OEMolComplexCategorizerBase

   .. oe:api::

      class OEMolComplexCategorizerBase

   Abstract base class functor for objects
   stored in :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` objects
   which are used by :oe:func:`OEBio::OESplitMolComplex` and
   :oe:func:`OEBio::OEGetMolComplexComponents` to assign
   functional roles to molecular fragments.

   The following :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` methods get
   or set an `OEMolComplexCategorizerBase`:

   ========================================================================================= =========================================================================================
   :oe:meth:`GetCategorizer<OEBio::OESplitMolComplexOptions::GetCategorizer>`                     :oe:meth:`SetCategorizer<OEBio::OESplitMolComplexOptions::SetCategorizer>`
   ========================================================================================= =========================================================================================

   The following classes derive from this class:
    * :ref:`OEMolComplexCategorizer <OEBio_OEMolComplexCategorizer>`

   .. oe:method:: operator()

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

         .. oe:api::

            std::string operator()(OESystem::OERoleSet& roles, OEMolComplexResCounts& counts, const OEChem::OEAtomBondSet& frag, bool isCovalent = false) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(roles: OERoleSet, counts: OEMolComplexResCounts,
                     frag: OEAtomBondSet, isCovalent: bool = False) -> str

      Method to examine the :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` ``frag``
      and return three things
      required by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents` to process the component:

      * a new title string
      * a :ref:`OERoleSet <OESystem_OERoleSet>` containing the functional roles
        associated with this fragment (see :oe:constns:`OEBio::OEMolComplexFilterCategory`)
      * an updated map of how many times a residue has been seen to date

      If ``isCovalent`` is true, additional tests may be performed to determine
      whether the fragment might be considered a (covalent) ligand which is indicated
      with the :oe:const:`OEBio::OEMolComplexFilterCategory::Ligand` :ref:`OERole <OESystem_OERole>`
      in ``roles``.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEMolComplexCategorizerBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMolComplexCategorizerBase

      CreateCopy method.

   .. oe:method:: GetBundleCofactors

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

         .. oe:api::

            bool GetBundleCofactors() const

      .. oe:language:: python

         .. oe:api:: python

            GetBundleCofactors() -> bool

      Returns ``true`` if cofactors (other than metals) are associated with
      the category :oe:const:`OEBio::OEMolComplexFilterCategory::Cofactor`.

   .. oe:method:: GetResidueCategoryData

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

         .. oe:api::

            OEResidueCategoryData* GetResidueCategoryData() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetResidueCategoryData() -> OEResidueCategoryData

      Pure virtual method.

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

         .. oe:api::

            OEResidueCategoryData& GetResidueCategoryData() = 0

      .. oe:language:: python

         .. oe:api:: python

            GetResidueCategoryData() -> OEResidueCategoryData

      Pure virtual method.

   .. oe:method:: UsingExplicitLigandName

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

         .. oe:api::

            bool UsingExplicitLigandName() const

      .. oe:language:: python

         .. oe:api:: python

            UsingExplicitLigandName() -> bool

      Returns ``true`` if  an explicit ligand residue name is
      being used to identify the ligand.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEMolComplexFilter, MolComplexFilter

.. _OEBio_OEMolComplexFilter:

.. oe:class:: OEMolComplexFilter

   .. oe:api::

      class OEMolComplexFilter : public OESystem::OEUnaryPredicate<OESystem::OERoleSet>

   The class `OEMolComplexFilter` represents a predicate over
   :ref:`OERoleSet <OESystem_OERoleSet>` objects used
   by :oe:func:`OEBio::OESplitMolComplex` and
   :oe:func:`OEBio::OEGetMolComplexComponents`
   to filter components by their functional roles.

   The following factories are used to generate `OEMolComplexFilter` objects:

   ============================================ ================================================
   :oe:func:`OEBio::OEMolComplexFilterFactory`  :oe:func:`OEBio::OERoleMolComplexFilterFactory`
   ============================================ ================================================

   `OEMolComplexFilter`  objects can be combined
   into arbitrarily complex expressions using
   composition functors (see the :ref:`section_predicates_composition_functors` section).

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMolComplexFilter()
            OEMolComplexFilter(const OEMolComplexFilter& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEMolComplexFilter() -> OEMolComplexFilter
            OEMolComplexFilter(rhs: OEMolComplexFilter) -> OEMolComplexFilter
            OEMolComplexFilter(impl: OEMolComplexFilterImpl) -> OEMolComplexFilter

      Constructor and copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolComplexFilter &operator=(const OEMolComplexFilter &rhs)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OESystem::OERoleSet& roles) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(roles: OERoleSet) -> bool

      Returns ``true`` if the :ref:`OERoleSet <OESystem_OERoleSet>` matches the filter.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OESystem::OERoleSet, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMolComplexFilter

      CreateCopy method.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. _OEBio_OEPerceiveInteractionOptions:

.. oe:class:: OEPerceiveInteractionOptions

   .. oe:api::

      class OEPerceiveInteractionOptions

   This class is a container for all the parameters that control interaction
   perception when
   invoking the :oe:func:`OEBio::OEPerceiveInteractionHints` function.

   The current list of interactions include:

   * **cation-pi**          (see also :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`    class and :oe:constns:`OEBio::OECationPiInteractionHintType`    namespace)
   * **clashes**            (see also :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>`       class)
   * **contacts**           (see also :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`     class)
   * **metal interactions** (see also :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`    class and :oe:constns:`OEBio::OEChelatorInteractionHintType`    namespace)
   * **covalents**          (see also :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>`    class)
   * **halogen bonds**      (see also :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` class and :oe:constns:`OEBio::OEHalogenBondInteractionHintType` namespace)
   * **hydrogen bonds**     (see also :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`       class and :oe:constns:`OEBio::OEHBondInteractionHintType`       namespace)
   * **salt-bridges**       (see also :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`  class and :oe:constns:`OEBio::OESaltBridgeInteractionHintType`  namespace)
   * **Pi and T stacking**  (see also :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>`    class and :oe:constns:`OEBio::OEStackingInteractionHintType`    namespace)

   Each interaction type has one or more parameters that control its perception.
   In  addition, hydrogen-bonding clashes, intramolecular hydrogen-bonds,
   unpaired hydrogen-bonds and  unpaired salt-bridges are also perceived.
   Unpaired interactions are those that are near the protein-ligand interface,
   but do not form an apparent bond.

   .. seealso::

      * [Kumar-2002]_
      * [Cavallo-2016]_
      * [Bissantz-2010]_
      * [Marcou-2007]_

   .. list-table::
      :widths: 100 100 100 100

      * - Get method
        - Set method
        - Interaction type(s)
        - Default value

      * - :oe:meth:`GetExtendedSaltBridgeDistance<OEBio::OEPerceiveInteractionOptions::GetExtendedSaltBridgeDistance>`
        -
        - salt bridge
        -

      * - :oe:meth:`GetMaxAcceptorAngle<OEBio::OEPerceiveInteractionOptions::GetMaxAcceptorAngle>`
        - :oe:meth:`SetMaxAcceptorAngle<OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle>`
        - hbond
        - 30 degrees

      * - :oe:meth:`GetMaxAtomPairDistance<OEBio::OEPerceiveInteractionOptions::GetMaxAtomPairDistance>`
        -
        -
        -

      * - :oe:meth:`GetMaxCationPiAngle<OEBio::OEPerceiveInteractionOptions::GetMaxCationPiAngle>`
        - :oe:meth:`SetMaxCationPiAngle<OEBio::OEPerceiveInteractionOptions::SetMaxCationPiAngle>`
        - cation-Pi
        - 50 degrees

      * - :oe:meth:`GetMaxCationPiDistance<OEBio::OEPerceiveInteractionOptions::GetMaxCationPiDistance>`
        - :oe:meth:`SetMaxCationPiDistance<OEBio::OEPerceiveInteractionOptions::SetMaxCationPiDistance>`
        - cation-Pi
        - 5.5 |Angstroms|

      * - :oe:meth:`GetMaxChargeAidedHBondDistance<OEBio::OEPerceiveInteractionOptions::GetMaxChargeAidedHBondDistance>`
        - :oe:meth:`SetMaxChargeAidedHBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance>`
        - hbond
        - 3.5 |Angstroms|

      * - :oe:meth:`GetMaxContactFraction<OEBio::OEPerceiveInteractionOptions::GetMaxContactFraction>`
        - :oe:meth:`SetMaxContactFraction<OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction>`
        - contact
        - 1.2

      * - :oe:meth:`GetMaxCovalentFraction<OEBio::OEPerceiveInteractionOptions::GetMaxCovalentFraction>`
        - :oe:meth:`SetMaxCovalentFraction<OEBio::OEPerceiveInteractionOptions::SetMaxCovalentFraction>`
        - covalent
        - 1.1

      * - :oe:meth:`GetMaxDonorAngle<OEBio::OEPerceiveInteractionOptions::GetMaxDonorAngle>`
        - :oe:meth:`SetMaxDonorAngle<OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle>`
        - hbond
        - 35 degrees

      * - :oe:meth:`GetMaxHBondDistance<OEBio::OEPerceiveInteractionOptions::GetMaxHBondDistance>`
        - :oe:meth:`SetMaxHBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance>`
        - hbond
        - 3.2 |Angstroms|

      * - :oe:meth:`GetMaxHalogenAngle<OEBio::OEPerceiveInteractionOptions::GetMaxHalogenAngle>`
        - :oe:meth:`SetMaxHalogenAngle<OEBio::OEPerceiveInteractionOptions::SetMaxHalogenAngle>`
        - halogen bond
        - 35 degrees

      * - :oe:meth:`GetMaxHalogenBondDistance<OEBio::OEPerceiveInteractionOptions::GetMaxHalogenBondDistance>`
        - :oe:meth:`SetMaxHalogenBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxHalogenBondDistance>`
        - halogen bond
        - 3.2 |Angstroms|

      * - :oe:meth:`GetMaxMetalBondDistance<OEBio::OEPerceiveInteractionOptions::GetMaxMetalBondDistance>`
        - :oe:meth:`SetMaxMetalBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxMetalBondDistance>`
        - chelator
        - 3.5 |Angstroms|

      * - :oe:meth:`GetMaxNonIdealAcceptorAngle<OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealAcceptorAngle>`
        - :oe:meth:`SetMaxNonIdealAcceptorAngle<OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealAcceptorAngle>`
        - hbond
        - 30 degrees

      * - :oe:meth:`GetMaxNonIdealDonorAngle<OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealDonorAngle>`
        - :oe:meth:`SetMaxNonIdealDonorAngle<OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealDonorAngle>`
        - hbond
        - 45 degrees

      * - :oe:meth:`GetMaxNonIdealHBondDistance<OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealHBondDistance>`
        - :oe:meth:`SetMaxNonIdealHBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealHBondDistance>`
        - hbond
        - 3.8 |Angstroms|

      * - :oe:meth:`GetMaxPiStackAngle<OEBio::OEPerceiveInteractionOptions::GetMaxPiStackAngle>`
        - :oe:meth:`SetMaxPiStackAngle<OEBio::OEPerceiveInteractionOptions::SetMaxPiStackAngle>`
        - Pi-stacking
        - :math:`\frac{\pi}{9.0}`

      * - :oe:meth:`GetMaxPiStackDistance<OEBio::OEPerceiveInteractionOptions::GetMaxPiStackDistance>`
        - :oe:meth:`SetMaxPiStackDistance<OEBio::OEPerceiveInteractionOptions::SetMaxPiStackDistance>`
        - Pi-stacking
        - 5.0 |Angstroms|

      * - :oe:meth:`GetMaxProteinIntraDistance<OEBio::OEPerceiveInteractionOptions::GetMaxProteinIntraDistance>`
        - :oe:meth:`SetMaxProteinIntraDistance<OEBio::OEPerceiveInteractionOptions::SetMaxProteinIntraDistance>`
        - intramolecular (protein)
        - 6.0 |Angstroms|

      * - :oe:meth:`GetMaxSaltBridgeDistance<OEBio::OEPerceiveInteractionOptions::GetMaxSaltBridgeDistance>`
        - :oe:meth:`SetMaxSaltBridgeDistance<OEBio::OEPerceiveInteractionOptions::SetMaxSaltBridgeDistance>`
        - salt bridge
        - 5.0 |Angstroms|

      * - :oe:meth:`GetMaxTStackAngle<OEBio::OEPerceiveInteractionOptions::GetMaxTStackAngle>`
        - :oe:meth:`SetMaxTStackAngle<OEBio::OEPerceiveInteractionOptions::SetMaxTStackAngle>`
        - T-stacking
        - :math:`\frac{\pi}{9.0}`

      * - :oe:meth:`GetMaxTStackDistance<OEBio::OEPerceiveInteractionOptions::GetMaxTStackDistance>`
        - :oe:meth:`SetMaxTStackDistance<OEBio::OEPerceiveInteractionOptions::SetMaxTStackDistance>`
        - T-stacking
        - 5.35 |Angstroms|

      * - :oe:meth:`GetMaxUnpairedAngle<OEBio::OEPerceiveInteractionOptions::GetMaxUnpairedAngle>`
        - :oe:meth:`SetMaxUnpairedAngle<OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedAngle>`
        - hbond
        - :math:`\frac{\pi}{2}`

      * - :oe:meth:`GetMaxUnpairedDistance<OEBio::OEPerceiveInteractionOptions::GetMaxUnpairedDistance>`
        - :oe:meth:`SetMaxUnpairedDistance<OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedDistance>`
        - hbond
        - 5.0 |Angstroms|

      * - :oe:meth:`GetMinContactFraction<OEBio::OEPerceiveInteractionOptions::GetMinContactFraction>`
        - :oe:meth:`SetMinContactFraction<OEBio::OEPerceiveInteractionOptions::SetMinContactFraction>`
        - contact, clash
        - 0.8

      * - :oe:meth:`GetMinCovalentFraction<OEBio::OEPerceiveInteractionOptions::GetMinCovalentFraction>`
        - :oe:meth:`SetMinCovalentFraction<OEBio::OEPerceiveInteractionOptions::SetMinCovalentFraction>`
        - covalent
        - 0.9

      * - :oe:meth:`GetMinHBondContactFraction<OEBio::OEPerceiveInteractionOptions::GetMinHBondContactFraction>`
        - :oe:meth:`SetMinHBondContactFraction<OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction>`
        - hbond
        - 0.5

      * - :oe:meth:`GetMinStackOffset<OEBio::OEPerceiveInteractionOptions::GetMinStackOffset>`
        - :oe:meth:`SetMinStackOffset<OEBio::OEPerceiveInteractionOptions::SetMinStackOffset>`
        - Pi-stacking, T-stacking
        - 0.5 |Angstroms|

   .. oe:method:: Constructors

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

         .. oe:api::

            OEPerceiveInteractionOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEPerceiveInteractionOptions() -> OEPerceiveInteractionOptions
            OEPerceiveInteractionOptions(arg2: OEPerceiveInteractionOptions) -> OEPerceiveInteractionOptions

      The default constructor for perception of interaction options.  It sets all of the interaction parameters
      to their default value.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPerceiveInteractionOptions & operator=(const OEPerceiveInteractionOptions &)

      Assignment operator.

   .. oe:method:: GetExtendedSaltBridgeDistance

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

         .. oe:api::

            double GetExtendedSaltBridgeDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetExtendedSaltBridgeDistance() -> float

      Actual salt bridge interaction distance is calculated from the geometric centers of the two interacting
      charge groups, which may or may not be comprised of a single atom.  The distance returned by this function
      is the maximum distance between two formally charged atoms for subsequent identification of charge groups.
      This is a simple increment larger than the value associated with
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxSaltBridgeDistance` and
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxSaltBridgeDistance`.

   .. oe:method:: GetMaxAcceptorAngle

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

         .. oe:api::

            double GetMaxAcceptorAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxAcceptorAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle`.

   .. oe:method:: GetMaxAtomPairDistance

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

         .. oe:api::

            double GetMaxAtomPairDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxAtomPairDistance() -> float

      Returns the maximum value of

      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxHBondDistance`,
      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxChargeAidedHBondDistance`,
      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxMetalBondDistance`,
      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetExtendedSaltBridgeDistance`, and
      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxHalogenBondDistance`.

   .. oe:method:: GetMaxCationPiAngle

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

         .. oe:api::

            double GetMaxCationPiAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxCationPiAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCationPiAngle`.

   .. oe:method:: GetMaxCationPiDistance

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

         .. oe:api::

            double GetMaxCationPiDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxCationPiDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCationPiDistance`.

   .. oe:method:: GetMaxChargeAidedHBondDistance

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

         .. oe:api::

            double GetMaxChargeAidedHBondDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxChargeAidedHBondDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance`.

   .. oe:method:: GetMaxContactFraction

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

         .. oe:api::

            double GetMaxContactFraction() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxContactFraction() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction`.

   .. oe:method:: GetMaxCovalentFraction

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

         .. oe:api::

            double GetMaxCovalentFraction() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxCovalentFraction() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCovalentFraction`.

   .. oe:method:: GetMaxDonorAngle

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

         .. oe:api::

            double GetMaxDonorAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxDonorAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle`.

   .. oe:method:: GetMaxHBondDistance

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

         .. oe:api::

            double GetMaxHBondDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHBondDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance`.

   .. oe:method:: GetMaxHalogenAngle

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

         .. oe:api::

            double GetMaxHalogenAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHalogenAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHalogenAngle`.

   .. oe:method:: GetMaxHalogenBondDistance

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

         .. oe:api::

            double GetMaxHalogenBondDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHalogenBondDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHalogenBondDistance`.

   .. oe:method:: GetMaxMetalBondDistance

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

         .. oe:api::

            double GetMaxMetalBondDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMetalBondDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxMetalBondDistance`.

   .. oe:method:: GetMaxNonIdealAcceptorAngle

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

         .. oe:api::

            double GetMaxNonIdealAcceptorAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxNonIdealAcceptorAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealAcceptorAngle`.

   .. oe:method:: GetMaxNonIdealDonorAngle

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

         .. oe:api::

            double GetMaxNonIdealDonorAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxNonIdealDonorAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealDonorAngle`.

   .. oe:method:: GetMaxNonIdealHBondDistance

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

         .. oe:api::

            double GetMaxNonIdealHBondDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxNonIdealHBondDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealHBondDistance`.

   .. oe:method:: GetMaxPiStackAngle

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

         .. oe:api::

            double GetMaxPiStackAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxPiStackAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxPiStackAngle`.

   .. oe:method:: GetMaxPiStackDistance

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

         .. oe:api::

            double GetMaxPiStackDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxPiStackDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxPiStackDistance`.

   .. oe:method:: GetMaxProteinIntraDistance

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

         .. oe:api::

            double GetMaxProteinIntraDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxProteinIntraDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxProteinIntraDistance`.

   .. oe:method:: GetMaxSaltBridgeDistance

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

         .. oe:api::

            double GetMaxSaltBridgeDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSaltBridgeDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxSaltBridgeDistance`.

   .. oe:method:: GetMaxTStackAngle

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

         .. oe:api::

            double GetMaxTStackAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxTStackAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxTStackAngle`.

   .. oe:method:: GetMaxTStackDistance

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

         .. oe:api::

            double GetMaxTStackDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxTStackDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxTStackDistance`.

   .. oe:method:: GetMaxUnpairedAngle

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

         .. oe:api::

            double GetMaxUnpairedAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxUnpairedAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedAngle`.

   .. oe:method:: GetMaxUnpairedDistance

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

         .. oe:api::

            double GetMaxUnpairedDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxUnpairedDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedDistance`.

   .. oe:method:: GetMinContactFraction

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

         .. oe:api::

            double GetMinContactFraction() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinContactFraction() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction`.

   .. oe:method:: GetMinCovalentFraction

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

         .. oe:api::

            double GetMinCovalentFraction() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinCovalentFraction() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinCovalentFraction`.

   .. oe:method:: GetMinHBondContactFraction

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

         .. oe:api::

            double GetMinHBondContactFraction() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinHBondContactFraction() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction`.

   .. oe:method:: GetMinStackOffset

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

         .. oe:api::

            double GetMinStackOffset() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinStackOffset() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinStackOffset`.

   .. oe:method:: SetMaxAcceptorAngle

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

         .. oe:api::

            void SetMaxAcceptorAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxAcceptorAngle(radians: float) -> None

      In perception of a hydrogen bond, we define the angle :math:`X-A...D`, where **A** and **D** are the acceptor
      and donor respectively, and **X** is one or more points in space that are located so that an idealized
      hydrogen-bond would give an angle of :math:`\pi`.  The maximum acceptor angle is the maximum allowed deviation (in
      radians) from the idealized angle (or the minimum deviation from multiple angles when more than one
      **X** position is possible).

      **Default=** :math:`(\pi * \frac{6.0}{36.0})` **= 30 degrees**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance` method

   .. oe:method:: SetMaxCationPiAngle

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

         .. oe:api::

            void SetMaxCationPiAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxCationPiAngle(radians: float) -> None

      This option sets the maximum allowed angle defined by a point on the vector normal from the pi ring system, the
      geometric center of the ring system and the geometric center of the charged system.  For the purposes of
      Cation Pi interaction hints, only Lysine, N-methyl Lysine and Arginine are recognized cations. For Lysine and N-methyl
      Lysine, the charge center is the charged Nitrogen atom, while for the Arginine residue, the charge center will be the
      geometric center of the Carbon and three Nitrogen atoms that share the resonant charge.  Each smallest
      aromatic ring (independent of ring fusions) is considered separately and a cation can interact with more
      than one pi system simultaneously.

      **Default=** :math:`(\pi * \frac{10.0}{36.0})` **= 50 degrees**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCationPiDistance` method

   .. oe:method:: SetMaxCationPiDistance

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

         .. oe:api::

            void SetMaxCationPiDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxCationPiDistance(dist: float) -> None

      This is the maximum allowed distance between the center of a cation system and the center of an
      aromatic pi system.  For the purposes of Cation Pi interaction hints, only Lysine, N-methyl Lysine
      and Arginine are recognized cations. Each smallest aromatic ring (independent of ring fusions) is
      considered separately and a cation can interact with more than one pi system simultaneously.

      **Default= 5.5** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCationPiAngle` method

   .. oe:method:: SetMaxChargeAidedHBondDistance

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

         .. oe:api::

            void SetMaxChargeAidedHBondDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxChargeAidedHBondDistance(dist: float) -> None

      For the purpose of hydrogen bond perception, charge assisted hydrogen bonds, are identified when one
      of the two bonding partners is part of a functional group with a net formal charge.  These interactions
      include dipole - charge interactions and are perceived at slightly longer range than simple hydrogen-
      bonds by default.

      **Default= 3.5** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle` method

   .. oe:method:: SetMaxContactFraction

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

         .. oe:api::

            void SetMaxContactFraction(double frac)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxContactFraction(frac: float) -> None

      Van der Waals interactions are perceived as non-interacting, in attractive contact, or clashing.  The three
      classes are determined by comparing the atom - atom distance **Daa** to the sum of the
      van der Waals radii of the two atoms **VDWtot**.  The distance **Daa** is represented as a
      fraction of **VDWtot** which we will call **Faa**.  If the value of **Faa** is greater than
      the value stored in
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction`, then the two atoms are
      non-interacting.  If the value of **Faa** is between the values set by
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction` and
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` then the atoms are in attractive
      contact.  If the value of **Faa** is less than
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` then the atoms are clashing.

      Any two atoms that are forming a hydrogen bond can be in attractive contact at shorter distances than
      generic atom pairs because of the balance of forces.  To handle this, when two atoms are forming a
      hydrogen bond, the value of **Faa** is compared to
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` to determine clashing
      rather than :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction`.

      **Default = 1.2**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method

   .. oe:method:: SetMaxCovalentFraction

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

         .. oe:api::

            void SetMaxCovalentFraction(double frac)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxCovalentFraction(frac: float) -> None

      This function sets the maximum ratio of the distance between to atoms to the sum of their covalent
      radii allowed for perception of a covalent bond.

      Covalent interactions are perceived based on comparing the distance between two atoms **D** to the
      sum of the covalent radii **SumRc**.  If **D** is > **SumRc** times the value set by
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinCovalentFraction` and **D** is < **SumRc** times the
      value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCovalentFraction`, then a covalent
      interaction will be perceived. Currently no angle constraint is used in perceiving covalent interactions.

      Hydrogen and Halide atoms as well as water molecules are excluded from covalent interaction hint
      perception.  Metal atom interactions are perceived as :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
      rather than as covalent interactions.

      When a covalent interaction exists between atom **P** of the protein and atom **L** of the ligand, then
      no other interactions will be perceived for atoms **P** and **L**.  Further, atoms bonded to atoms
      **L** and **P** will be excluded from perception of clash or contact interactions.  Bonded atoms will
      be able to participate in other interactions such as hydrogen bonding.

      **Default = 1.1**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinCovalentFraction` method

   .. oe:method:: SetMaxDonorAngle

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

         .. oe:api::

            void SetMaxDonorAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxDonorAngle(radians: float) -> None

      In the perception of a hydrogen bond with the interaction :math:`A...H-D`, the angle :math:`A-D-H`
      is ideally zero in most cases.
      This function determines the maximum allowed value of this angle in a perceived hydrogen-bond.

      **Default** = :math:`(\pi * \frac{7.0}{36.0})` **= 35 degrees**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance` method

   .. oe:method:: SetMaxHBondDistance

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

         .. oe:api::

            void SetMaxHBondDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHBondDistance(dist: float) -> None

      This function sets the maximum distance between the donor and acceptor heavy atoms for a hydrogen-bond
      to be perceived.

      **Default = 3.2** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance` method

   .. oe:method:: SetMaxHalogenAngle

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

         .. oe:api::

            void SetMaxHalogenAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHalogenAngle(radians: float) -> None

      In the perception of halogen bonds, there is an angle formed between :math:`R-X...E/N` where **X** is a univalent
      halogen, **E/N** are the electrophile or nucleophile, and **R** is the attachment of the halogen.  For
      nucleophiles, the ideal interaction angle is :math:`\pi`, for electrophiles, the ideal interaction angle
      :math:`\frac{\pi}{2}`.
      This function determines the maximum allowed deviation (in radian) from these ideal angles, respectively, for
      perception of a halogen bond.

      **Default** = :math:`(\pi * \frac{7.0}{36.0})` **= 35 degrees**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHalogenBondDistance` method

   .. oe:method:: SetMaxHalogenBondDistance

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

         .. oe:api::

            void SetMaxHalogenBondDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHalogenBondDistance(dist: float) -> None

      This is the maximum distance between the halogen atom and the electrophile or nucleophile atom for
      perception of a halogen bond.

      **Default = 3.2** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHalogenAngle` method

   .. oe:method:: SetMaxMetalBondDistance

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

         .. oe:api::

            void SetMaxMetalBondDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxMetalBondDistance(dist: float) -> None

      This is the maximum distance allowed for an interaction to be perceived between a metal atom and a
      chelating non-metal atom.

      **Default = 3.5** |Angstroms|

   .. oe:method:: SetMaxNonIdealAcceptorAngle

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

         .. oe:api::

            void SetMaxNonIdealAcceptorAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxNonIdealAcceptorAngle(radians: float) -> None

      Sets the maximum angle deviation (in radian) from the non-ideal angle.

      **Default=** :math:`(\pi * \frac{6.0}{36.0})` **= 30 degrees**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealHBondDistance` method

   .. oe:method:: SetMaxNonIdealDonorAngle

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

         .. oe:api::

            void SetMaxNonIdealDonorAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxNonIdealDonorAngle(radians: float) -> None

      Sets the maximum allowed value of this angle in a perceived non-ideal
      hydrogen bond.

      **Default=** :math:`(\pi * \frac{9.0}{36.0})` **= 45 degrees**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealHBondDistance` method

   .. oe:method:: SetMaxNonIdealHBondDistance

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

         .. oe:api::

            void SetMaxNonIdealHBondDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxNonIdealHBondDistance(dist: float) -> None

      This function sets the maximum distance between the donor and acceptor
      heavy atoms for a non-ideal hydrogen bond to be perceived.

      **Default = 3.8** |Angstroms|

   .. oe:method:: SetMaxPiStackAngle

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

         .. oe:api::

            void SetMaxPiStackAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxPiStackAngle(radians: float) -> None

      Sets the maximum angle deviation (in radian) from the ideal angle calculated
      between the two aromatic ring normals to be considered for Pi-stacking interaction.

      **Default =** :math:`\frac{\pi}{9.0}`

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxPiStackDistance` method

   .. oe:method:: SetMaxPiStackDistance

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

         .. oe:api::

            void SetMaxPiStackDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxPiStackDistance(dist: float) -> None

      Sets the maximum distance (in |Angstrom|) allowed between the geometric center of two aromatic
      rings in order to being considered for Pi-stacking interaction.

      **Default = 5.0** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxPiStackAngle` method

   .. oe:method:: SetMaxProteinIntraDistance

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

         .. oe:api::

            void SetMaxProteinIntraDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxProteinIntraDistance(dist: float) -> None

      Sets the maximum distance (in |Angstroms|) used to identify protein atoms that are
      neighbours of the ligand when perceiving intramolecular protein hydrogen bonds and
      chelator interactions.

      **Default = 6.0** |Angstroms|

   .. oe:method:: SetMaxSaltBridgeDistance

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

         .. oe:api::

            void SetMaxSaltBridgeDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxSaltBridgeDistance(dist: float) -> None

      Sets the maximum distance (in |Angstroms|) allowed between the geometric centers of the
      two formally charged groups in a perceived salt bridge interaction.

      **Default = 5.0** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetExtendedSaltBridgeDistance` method

   .. oe:method:: SetMaxTStackAngle

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

         .. oe:api::

            void SetMaxTStackAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxTStackAngle(radians: float) -> None

      Sets the maximum angle deviation (in radian) from the ideal angle (:math:`\frac{\pi}{2}`) calculated
      between the two aromatic ring normals to be considered for T-stacking interaction.

      **Default =** :math:`\frac{\pi}{9.0}`

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxTStackDistance` method

   .. oe:method:: SetMaxTStackDistance

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

         .. oe:api::

            void SetMaxTStackDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxTStackDistance(dist: float) -> None

      Sets the maximum distance (in |Angstrom|) allowed between the geometric center of two aromatic
      rings in order to being considered for T-stacking interaction.

      **Default = 5.35** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxTStackAngle` method

   .. oe:method:: SetMaxUnpairedAngle

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

         .. oe:api::

            void SetMaxUnpairedAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxUnpairedAngle(radians: float) -> None

      In perception of unpaired interactions, the unpaired potential interaction group should be oriented
      toward the ligand or protein where it could make an interaction.  This is the maximum deviation (in radian)
      allowed between the potential interaction group and the nearest potential partner atom.

      **Default =** :math:`\frac{\pi}{2}`

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedDistance` method

   .. oe:method:: SetMaxUnpairedDistance

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

         .. oe:api::

            void SetMaxUnpairedDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxUnpairedDistance(dist: float) -> None

      In perception of unpaired interactions, the unpaired potential interaction group should be within
      a minimum distance of the nearest potential paired atom.  This function sets the maximum distance
      (in |Angstroms|) for perception of an unpaired potential.

      **Default = 5.0** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedAngle` method

   .. oe:method:: SetMinContactFraction

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

         .. oe:api::

            void SetMinContactFraction(double frac)

      .. oe:language:: python

         .. oe:api:: python

            SetMinContactFraction(frac: float) -> None

      der Waals interactions are perceived as non-interacting, in attractive contact, or clashing.  The three
      classes are determined by comparing the atom - atom distance **Daa** to the sum of the
      van der Waals radii of the two atoms **VDWtot**.  The distance **Daa** is represented as a
      fraction of **VDWtot** which we will call **Faa**.  If the value of **Faa** is greater than
      the value stored in
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction`, then the two atoms are
      non-interacting.  If the value of **Faa** is between the values set by
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction` and
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` then the atoms are in attractive
      contact.  If the value of **Faa** is less than
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` then the atoms are clashing.

      Any two atoms that are forming a hydrogen bond can be in attractive contact at shorter distances than
      generic atom pairs because of the balance of forces.  To handle this, when two atoms are forming a
      hydrogen bond, the value of **Faa** is compared to
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` to determine clashing
      rather than :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction`.

      **Default = 0.8**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method

   .. oe:method:: SetMinCovalentFraction

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

         .. oe:api::

            void SetMinCovalentFraction(double frac)

      .. oe:language:: python

         .. oe:api:: python

            SetMinCovalentFraction(frac: float) -> None

      This function sets the minimum ratio of the distance between to atoms to the sum of their covalent
      radii allowed for perception of a covalent bond.

      Covalent interactions are perceived based on comparing the distance between two atoms **D** to the
      sum of the covalent radii **SumRc**.  If **D** is > **SumRc** times the value set by
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinCovalentFraction` and **D** is < **SumRc** times the
      value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCovalentFraction`, then a covalent
      interaction will be perceived. Currently no angle constraint is used in perceiving covalent interactions.

      Hydrogen and Halide atoms as well as water molecules are excluded from covalent interaction hint
      perception.  Metal atom interactions are perceived as :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
      rather than as covalent interactions.

      When a covalent interaction exists between atom **P** of the protein and atom **L** of the ligand, then
      no other interactions will be perceived for atoms **P** and **L**.  Further, atoms bonded to atoms
      **L** and **P** will be excluded from perception of clash or contact interactions.  Bonded atoms will
      be able to participate in other interactions such as hydrogen bonding.

      **Default = 0.9**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCovalentFraction` method

   .. oe:method:: SetMinHBondContactFraction

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

         .. oe:api::

            void SetMinHBondContactFraction(double frac)

      .. oe:language:: python

         .. oe:api:: python

            SetMinHBondContactFraction(frac: float) -> None

      der Waals interactions are perceived as non-interacting, in attractive contact, or clashing.  The three
      classes are determined by comparing the atom - atom distance **Daa** to the sum of the
      van der Waals radii of the two atoms **VDWtot**.  The distance **Daa** is represented as a
      fraction of **VDWtot** which we will call **Faa**.  If the value of **Faa** is greater than
      the value stored in
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction`, then the two atoms are
      non-interacting.  If the value of **Faa** is between the values set by
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction` and
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` then the atoms are in attractive
      contact.  If the value of **Faa** is less than
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` then the atoms are clashing.

      Any two atoms that are forming a hydrogen bond can be in attractive contact at shorter distances than
      generic atom pairs because of the balance of forces.  To handle this, when two atoms are forming a
      hydrogen bond, the value of **Faa** is compared to
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` to determine clashing
      rather than :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction`.

      **Default = 0.5**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance` method

   .. oe:method:: SetMinStackOffset

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

         .. oe:api::

            void SetMinStackOffset(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMinStackOffset(minOffset: float) -> None

      Sets the minimum allowed lateral offset (in |Angstroms|) used to filter
      Pi-stacking and T-stacking interaction candidates.

      **Default = 0.5** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxPiStackDistance` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxTStackDistance` method



.. oe:namespace:: OEBio

.. _OEBio_OEPlaceHydrogensDetails:

.. oe:class:: OEPlaceHydrogensDetails

   .. oe:api::

      class OEPlaceHydrogensDetails

   The *read-only* container `OEPlaceHydrogensDetails` holds information about
   the results of applying the function :oe:func:`OEBio::OEPlaceHydrogens`
   to a particular molecule. Details objects can provide insight into
   the conformational states and how they were chosen.

   Information is broken down into clusters (including singletons)
   of "movers" or moving functional groups and their associated
   "background" of non-moving groups. Information about each mover is
   collected in a corresponding
   :oe:cls:`OEPlaceHydrogensMoverNote<OEBio::OEPlaceHydrogensMoverNote>`.

   .. seealso::

      * :ref:`section_place_hydrogens` section
      * :oe:func:`OEBio::OEPlaceHydrogens` function
      * :ref:`OEPlaceHydrogensMoverNote <OEBio_OEPlaceHydrogensMoverNote>` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OEPlaceHydrogensDetails()
            OEPlaceHydrogensDetails(const OEPlaceHydrogensDetails& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEPlaceHydrogensDetails() -> OEPlaceHydrogensDetails
            OEPlaceHydrogensDetails(rhs: OEPlaceHydrogensDetails) -> OEPlaceHydrogensDetails

      Default and copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPlaceHydrogensDetails &operator=(const OEPlaceHydrogensDetails &rhs)

      Assignment operator.

   .. oe:method:: ClusterHasBadClash

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

         .. oe:api::

            bool ClusterHasBadClash(unsigned clusterIdx) const

      .. oe:language:: python

         .. oe:api:: python

            ClusterHasBadClash(clusterIdx: int) -> bool

      Returns ``true`` if the cluster referred to by `clusterIdx`
      is in a conformation that generates a "bad" atom-atom clash.

      .. seealso::

         * :oe:meth:`GetNumClusters<OEBio::OEPlaceHydrogensDetails::GetNumClusters>` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetBadClashOverlapDistance` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::GetBadClashOverlapDistance` method

   .. oe:method:: Describe

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

         .. oe:api::

            std::string Describe(bool showBackground = false) const

      .. oe:language:: python

         .. oe:api:: python

            Describe(showBackground: bool = False) -> str

      Returns a multi-line description of the conformation and score
      of movers in each cluster processed by the
      :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>` function.

      .. code-block:: bash

         OEBio 2.1.1: score system MMFF-NIE: flip bias 2.000
         87 clusters : 5 flips
         cluster 0  : score -53.935!
                      CG  ASN44(A)   :      amide:   -6.084  (o=-53.93!,f=-8.42!)
                      NZ  LYS47(A)   : NH3 150deg:  -14.865
                      CG  HIS80(A)   :    +bothHN:   -5.628  (o=-53.93!,f=-15.89!)
                      OG1 THR81(A)   : OH   65deg:    1.255
                      CD  GLN87(A)   :FLIP  amide:   -4.976  (o=-26.48!,f=-53.93!)
                      CG  ASN126(A)  :      amide:   -5.193  (o=-53.93!,f=-35.33!)
                      CG  ASN169(A)  :      amide:   -2.230  (o=-53.93!,f=-33.02!)
                      CD  GLN203(A)  :      amide:   -1.400  (o=-53.93!,f=-15.53!)
                      CG  HIS205(A)  :    +bothHN:   -8.693! (o=-53.93!,f=-6.89!)
                      OG1 THR232(A)  : OH  179deg:    9.120
                      O3B XYP601(A)  : OH  280deg:   -5.020
                      O2B XYP601(A)  : OH  173deg:    3.917
                      O4B XYP601(A)  : OH   50deg:    1.236
                      O3  XIF602(A)  : OH   29deg:   -3.688
         cluster 1  : score -85.724!
                      CG  HIS85(A)   :    +bothHN:   -7.737! (o=-85.72!,f=-84.85!)
                      OG  SER86(A)   : OH  241deg:    2.116
                      OG  SER139(A)  : OH  185deg:    3.367!
                      OH  TYR171(A)  : OH   25deg:   -3.384
                      CG  ASN172(A)  :      amide:    1.153  (o=-85.72!,f=-68.75!)
                      NZ  LYS179(A)  : NH3 188deg:  -39.497
         ...
         single  13 : OG1 THR2(A)    : OH  151deg:    1.545
         single  14 : OG  SER25(A)   : OH  292deg:    2.046
         single  15 : OH  TYR29(A)   : OH  199deg:   -1.262
         single  16 : OG  SER35(A)   : OH  254deg:    1.935
         ...

      Key elements in the description output:

      * The score system is ``MMFF-NIE`` which stands for
        "MMFF Neighbor Interaction Energies". This is is a physics based
        score where the Coulombic and Van der Waals terms are from MMFF94
        (including MMFF partial charges), with a weighting factor of 1:3 Coulomb
        to VDW. There are biases against ionization and "flipping" a group.
        Interactions are scored between movers and between movers and non-moving
        background atoms. Background atoms are neighboring atoms that form a
        "dipole cluster", the sum of the partial charges of these clusters are
        the same as the sum of the formal charges.

      * The count ``87 clusters`` includes both groups of interacting movers
        and singletons, movers that interact only with non-moving atoms or waters.

      * ``5 flips`` indicates that five movers were "flipped" by 180 degrees to
        improve hydrogen bonding or avoid clashes. Groups such as the asparagine
        sidechain ``CD  GLN87(A)   :FLIP  amide:`` are occasionally modeled
        with certain heavy atoms in the wrong orientation. Any free amide or
        imidazole group will be considered for flipping.

      * The score in ``OG  SER139(A)  : OH  185deg:    3.367!`` is from
        ``score system MMFF-NIE`` for this mover in the specified
        conformation. Lower numbers represent better scores. The exclamation
        point (!) indicates a clash between this group and another group or
        non-moving background atom.

      * The score in ``cluster 0  : score -53.935!`` is the sum of both the mover
        scores, and the background scores (not shown here, but displayable if
        the ``showBackground`` parameter is set to ``true``).
        The exclamation point (!) indicates that at least one mover had a clash.

      * The pair of scores for flippable groups ``(o=-53.93!,f=-8.42!)``
        are the best cluster scores for both the original (o) and the
        flipped (f) state. After the basic
        optimization, each flippable mover in a cluster is fixed in the opposite
        flip state and the optimization is re-run. A group is flipped
        only if the flipped cluster score is lower than the original score
        by more than ``flip bias 2.000``.

      * Imidazoles have both flipped states and three protonation states for
        each flip state. The description indicates whether the group is flipped
        and where protons are with respect to the two ring nitrogens:
        ``:     no HE2:`` *neutral with HD1 but no HE2* or
        ``:FLIP no HD1:`` *flipped neutral with HE2 but no HD1* or
        ``:    +bothHN:`` *+ charged with two NH protons.*

      * Other groups have descriptions of their state.
        ``O3B XYP601(A)  : OH  280deg:`` shows the orientation of one
        of the hydroxyl rotors in the residue XYP.

      * Waters (not shown above) are processed after other movers,
        progressively in shells away from the protein.

      .. seealso::

         * :oe:meth:`OEBio::OEPlaceHydrogensMoverNote::Describe` method
         * :oe:constns:`OEBio::OEPlaceHydrogensMoverClass` constants

   .. oe:method:: GetClusterScore

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

         .. oe:api::

            double GetClusterScore(unsigned clusterIdx) const

      .. oe:language:: python

         .. oe:api:: python

            GetClusterScore(clusterIdx: int) -> float

      Returns the combined score of all the movers (plus non-moving background)
      of the cluster referred to by `clusterIdx`.

      .. seealso::

         * :oe:meth:`GetNumClusters<OEBio::OEPlaceHydrogensDetails::GetNumClusters>` method

   .. oe:method:: GetFlipBias

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

         .. oe:api::

            double GetFlipBias() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlipBias() -> float

      Returns the score bias against flipping functional groups (e.g. imidazole, amide)
      used by :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>` when this
      details object was produced.

      .. seealso::

         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::GetFlipBias` method

   .. oe:method:: GetMoverNotes

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

         .. oe:api::

            OESystem::OEIterBase<OEPlaceHydrogensMoverNote>* GetMoverNotes(unsigned clusterIdx) const

      .. oe:language:: python

         .. oe:api:: python

            GetMoverNotes(clusterIdx: int) -> Iterable[OEPlaceHydrogensMoverNote]

      Returns an iterator of all the
      :oe:cls:`mover notes<OEBio::OEPlaceHydrogensMoverNote>`
      describing the state of movers in the cluster referred to by `clusterIdx`.

      .. seealso::

         * :ref:`OEPlaceHydrogensMoverNote <OEBio_OEPlaceHydrogensMoverNote>`
         * :ref:`OEIter <OESystem_OEIter>` class

   .. oe:method:: GetNumClusters

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

         .. oe:api::

            unsigned GetNumClusters() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumClusters() -> int

      Returns the number of mover clusters processed
      by :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>` when this
      details object was produced.

   .. oe:method:: GetNumFlips

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

         .. oe:api::

            unsigned GetNumFlips() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumFlips() -> int

      Returns the number movers
      :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`
      decided to flip when this details object was produced.

      .. seealso::

         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::GetFlipBias` method

   .. oe:method:: GetNumHydrogensStandardized

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

         .. oe:api::

            unsigned GetNumHydrogensStandardized() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumHydrogensStandardized() -> int

      Returns the number of bonds between a hydrogen and a heavy atom
      whose length was adjusted by
      :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`
      when this details object was produced.

      .. seealso::

         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetStandardizeBondLen` method

   .. oe:method:: GetNumMovers

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

         .. oe:api::

            unsigned GetNumMovers(unsigned clusterIdx) const

      .. oe:language:: python

         .. oe:api:: python

            GetNumMovers(clusterIdx: int) -> int

      Returns the number of movers in the cluster referred to by `clusterIdx`
      (including all non-moving background "movers").

      .. seealso::

         * :oe:meth:`GetNumClusters<OEBio::OEPlaceHydrogensDetails::GetNumClusters>` method
         * :oe:meth:`IsSingleton<OEBio::OEPlaceHydrogensDetails::IsSingleton>` method
         * :oe:meth:`GetMoverNotes<OEBio::OEPlaceHydrogensDetails::GetMoverNotes>` method

   .. oe:method:: IsSingleton

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

         .. oe:api::

            bool IsSingleton(unsigned clusterIdx) const

      .. oe:language:: python

         .. oe:api:: python

            IsSingleton(clusterIdx: int) -> bool

      Returns ``true`` if the cluster referred to by `clusterIdx`
      only contains a single mover
      (not counting the corresponding non-moving background).

      .. seealso::

         * :oe:meth:`GetNumMovers<OEBio::OEPlaceHydrogensDetails::GetNumMovers>` method

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns ``true`` if this details object contains valid information.
      Returns ``false`` if
      :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>` failed.


.. oe:namespace:: OEBio

.. _OEBio_OEPlaceHydrogensMoverNote:

.. oe:class:: OEPlaceHydrogensMoverNote

   .. oe:api::

      class OEPlaceHydrogensMoverNote

   The *read-only* container `OEPlaceHydrogensMoverNote` holds information about
   a single functional group processed by :oe:func:`OEBio::OEPlaceHydrogens`.

   These mover notes are organized into clusters in
   :oe:cls:`OEPlaceHydrogensDetails<OEBio::OEPlaceHydrogensDetails>` objects.

   .. seealso::

      * :ref:`section_place_hydrogens` section
      * :oe:func:`OEBio::OEPlaceHydrogens` function
      * :ref:`OEPlaceHydrogensDetails <OEBio_OEPlaceHydrogensDetails>` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OEPlaceHydrogensMoverNote()
            OEPlaceHydrogensMoverNote(const OEPlaceHydrogensMoverNote& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEPlaceHydrogensMoverNote() -> OEPlaceHydrogensMoverNote
            OEPlaceHydrogensMoverNote(rhs: OEPlaceHydrogensMoverNote) -> OEPlaceHydrogensMoverNote

      Default and copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPlaceHydrogensMoverNote &operator=(const OEPlaceHydrogensMoverNote &rhs)

      Assignment operator.

   .. oe:method:: Describe

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

         .. oe:api::

            std::string Describe() const

      .. oe:language:: python

         .. oe:api:: python

            Describe() -> str

      Returns a description of the identity, state, and score of this mover.

      .. seealso::

         * :oe:meth:`OEBio::OEPlaceHydrogensDetails::Describe` method

   .. oe:method:: GetAngle

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

         .. oe:api::

            double GetAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetAngle() -> float

      Returns the angle this mover was oriented in (if rotatable).

   .. oe:method:: GetFlippedBestClusterScore

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

         .. oe:api::

            double GetFlippedBestClusterScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlippedBestClusterScore() -> float

      Returns the best score for this cluster when this mover was flipped
      (if flippable).

      .. seealso::

         * :oe:meth:`IsFlippable<OEBio::OEPlaceHydrogensMoverNote::IsFlippable>` method
         * :oe:meth:`IsFlipped<OEBio::OEPlaceHydrogensMoverNote::IsFlipped>` method

   .. oe:method:: GetLabel

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

         .. oe:api::

            std::string GetLabel() const

      .. oe:language:: python

         .. oe:api:: python

            GetLabel() -> str

      Returns a string describing this mover.

   .. oe:method:: GetMoverClass

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

         .. oe:api::

            unsigned GetMoverClass() const

      .. oe:language:: python

         .. oe:api:: python

            GetMoverClass() -> int

      Returns the :oe:constns:`class<OEBio::OEPlaceHydrogensMoverClass>`
      of this mover.

      .. seealso::

         * :oe:constns:`OEBio::OEPlaceHydrogensMoverClass` namespace
         * :oe:func:`OEBio::OEGetPlaceHydrogensMoverClassName`

   .. oe:method:: GetOriginalBestClusterScore

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

         .. oe:api::

            double GetOriginalBestClusterScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetOriginalBestClusterScore() -> float

      Returns the best score for this cluster when this mover was *not* flipped
      (if flippable).

      .. seealso::

         * :oe:meth:`IsFlippable<OEBio::OEPlaceHydrogensMoverNote::IsFlippable>` method
         * :oe:meth:`IsFlipped<OEBio::OEPlaceHydrogensMoverNote::IsFlipped>` method

   .. oe:method:: GetReferenceCoords

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

         .. oe:api::

            bool GetReferenceCoords(double* xyz) const

      .. oe:language:: python

         .. oe:api:: python

            GetReferenceCoords(xyz: OEDoubleArray) -> bool

      Returns 3-D coordinates of an atom representing the location of this mover.

   .. oe:method:: GetScore

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

         .. oe:api::

            double GetScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetScore() -> float

      Returns the score for this mover.

   .. oe:method:: GetStateIdx

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

         .. oe:api::

            unsigned GetStateIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetStateIdx() -> int

      Returns the index of the conformational state of this mover.

   .. oe:method:: GetStateName

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

         .. oe:api::

            std::string GetStateName() const

      .. oe:language:: python

         .. oe:api:: python

            GetStateName() -> str

      Returns the name of the state of this mover.

   .. oe:method:: HasBadClash

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

         .. oe:api::

            bool HasBadClash() const

      .. oe:language:: python

         .. oe:api:: python

            HasBadClash() -> bool

      Returns ``true`` if this mover in a state that makes a bad clash.

      .. seealso::

         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetBadClashOverlapDistance` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::GetBadClashOverlapDistance` method

   .. oe:method:: HasFlippedBadClusterClash

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

         .. oe:api::

            bool HasFlippedBadClusterClash() const

      .. oe:language:: python

         .. oe:api:: python

            HasFlippedBadClusterClash() -> bool

      Returns ``true`` if this cluster has a bad clash when this mover is flipped
      (if flippable).

      .. seealso::

         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetBadClashOverlapDistance` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::GetBadClashOverlapDistance` method
         * :oe:meth:`IsFlippable<OEBio::OEPlaceHydrogensMoverNote::IsFlippable>` method
         * :oe:meth:`IsFlipped<OEBio::OEPlaceHydrogensMoverNote::IsFlipped>` method

   .. oe:method:: HasOriginalBadClusterClash

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

         .. oe:api::

            bool HasOriginalBadClusterClash() const

      .. oe:language:: python

         .. oe:api:: python

            HasOriginalBadClusterClash() -> bool

      Returns ``true`` if this cluster has a bad clash when this mover is *not* flipped
      (if flippable).

      .. seealso::

         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetBadClashOverlapDistance` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::GetBadClashOverlapDistance` method
         * :oe:meth:`IsFlippable<OEBio::OEPlaceHydrogensMoverNote::IsFlippable>` method
         * :oe:meth:`IsFlipped<OEBio::OEPlaceHydrogensMoverNote::IsFlipped>` method

   .. oe:method:: IsFlippable

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

         .. oe:api::

            bool IsFlippable() const

      .. oe:language:: python

         .. oe:api:: python

            IsFlippable() -> bool

      Returns ``true`` if this this mover is flippable.

      .. seealso::

         * :oe:meth:`IsFlipped<OEBio::OEPlaceHydrogensMoverNote::IsFlipped>` method

   .. oe:method:: IsFlipped

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

         .. oe:api::

            bool IsFlipped() const

      .. oe:language:: python

         .. oe:api:: python

            IsFlipped() -> bool

      Returns ``true`` if this mover has been flipped. If restrained, it may
      be flipped even though it is not flippable.

      .. seealso::

         * :oe:meth:`IsFlippable<OEBio::OEPlaceHydrogensMoverNote::IsFlippable>` method
         * :oe:meth:`IsRestrained<OEBio::OEPlaceHydrogensMoverNote::IsRestrained>` method
         * :oe:meth:`GetFlippedBestClusterScore<OEBio::OEPlaceHydrogensMoverNote::GetFlippedBestClusterScore>` method
         * :oe:meth:`GetOriginalBestClusterScore<OEBio::OEPlaceHydrogensMoverNote::GetOriginalBestClusterScore>` method
         * :oe:meth:`HasFlippedBadClusterClash<OEBio::OEPlaceHydrogensMoverNote::HasFlippedBadClusterClash>` method
         * :oe:meth:`HasOriginalBadClusterClash<OEBio::OEPlaceHydrogensMoverNote::HasOriginalBadClusterClash>` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetFlipPredicate` method

   .. oe:method:: IsIonized

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

         .. oe:api::

            bool IsIonized() const

      .. oe:language:: python

         .. oe:api:: python

            IsIonized() -> bool

      Returns ``true`` if this mover is in an ionized state.

   .. oe:method:: IsIonizable

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

         .. oe:api::

            bool IsIonizable() const

      .. oe:language:: python

         .. oe:api:: python

            IsIonizable() -> bool

      Returns ``true`` if this mover is ionized in one of its allowed states.

   .. oe:method:: IsRestrained

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

         .. oe:api::

            bool IsRestrained() const

      .. oe:language:: python

         .. oe:api:: python

            IsRestrained() -> bool

      Returns ``true`` if this mover is restrained as to the allowed states.
      For example, if it is restrained to be flipped.

      .. seealso::

         * :oe:meth:`IsFlipped<OEBio::OEPlaceHydrogensMoverNote::IsFlipped>` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetFlipPredicate` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetNoFlipPredicate` method


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. _OEBio_OEPlaceHydrogensOptions:

.. oe:class:: OEPlaceHydrogensOptions

   .. oe:api::

      class OEPlaceHydrogensOptions : public OESystem::OEOptions

   The `OEPlaceHydrogensOptions` class encapsulates
   properties and resources that determine how
   :oe:func:`OEBio::OEPlaceHydrogens` functions.

   .. seealso::

      * :ref:`section_place_hydrogens` section
      * :oe:func:`OEBio::OEPlaceHydrogens` function

   .. oe:method:: Constructors

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

         .. oe:api::

            OEPlaceHydrogensOptions(bool compatibleAlts = false)
            OEPlaceHydrogensOptions(const OEPlaceHydrogensOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEPlaceHydrogensOptions(compatibleAlts: bool = False) -> OEPlaceHydrogensOptions
            OEPlaceHydrogensOptions(rhs: OEPlaceHydrogensOptions) -> OEPlaceHydrogensOptions

      Constructor and copy constructor. The optional parameter
      ``compatibleAlts`` controls how alternate location codes are interpreted by
      :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`.

      .. seealso::

         * :oe:meth:`SetAltsMustBeCompatible<OEBio::OEPlaceHydrogensOptions::SetAltsMustBeCompatible>` method
         * :oe:meth:`GetAltsMustBeCompatible<OEBio::OEPlaceHydrogensOptions::GetAltsMustBeCompatible>` method

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPlaceHydrogensOptions &operator=(const OEPlaceHydrogensOptions &rhs)

      Assignment operator.

   .. oe:method:: GetAddMetadata

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

         .. oe:api::

            bool GetAddMetadata() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddMetadata() -> bool

      Returns ``true`` if metadata describing the results
      will be added to the molecule. The metadata is the string generated by the
      :oe:meth:`OEBio::OEPlaceHydrogensDetails::Describe` method
      and can be accessed by the :oe:func:`OEBio::OEGetPlaceHydrogensMetadata`
      function.

      .. seealso::

         * :oe:func:`OEBio::OEHasPlaceHydrogensMetadata` function
         * :oe:func:`OEBio::OEGetPlaceHydrogensMetadata` function
         * :oe:func:`OEBio::OEClearPlaceHydrogensMetadata` function
         * :ref:`OEPlaceHydrogensDetails <OEBio_OEPlaceHydrogensDetails>` class

   .. oe:method:: GetAltsMustBeCompatible

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

         .. oe:api::

            bool GetAltsMustBeCompatible() const

      .. oe:language:: python

         .. oe:api:: python

            GetAltsMustBeCompatible() -> bool

      Returns ``true`` if alternate location codes are required to be compatible
      (either identical or blank) when atoms interact. If ``true``,
      incompatible atoms do not interact.

      .. seealso::

         * :oe:meth:`Constructors<OEBio::OEPlaceHydrogensOptions::Constructors>`

   .. oe:method:: GetBadClashOverlapDistance

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

         .. oe:api::

            double GetBadClashOverlapDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetBadClashOverlapDistance() -> float

      Returns the amount of excess van der Waals overlap considered to be
      a "bad" clash.

   .. oe:method:: GetBypassPredicate

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

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* GetBypassPredicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetBypassPredicate() -> OEUnaryAtomPred

      Returns a new copy of the predicate that
      :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`
      will use to exclude from analysis all movers having a matching atom.

      .. oe:language:: c++

         To avoid a memory leak in C++, the returned pointer should be
         stored in a variable of the
         :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` template class
         or deallocated with the ``delete`` operator.

      (Default: :oe:cls:`OEIsFalseAtom<OESystem::OEIsFalse>`)

      .. seealso::

         * :oe:meth:`SetBypassPredicate<OEBio::OEPlaceHydrogensOptions::SetBypassPredicate>` method
         * :oe:meth:`GetFlipPredicate<OEBio::OEPlaceHydrogensOptions::GetFlipPredicate>` method
         * :oe:meth:`GetNoFlipPredicate<OEBio::OEPlaceHydrogensOptions::GetNoFlipPredicate>` method

   .. oe:method:: GetFlipBias

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

         .. oe:api::

            double GetFlipBias() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlipBias() -> float

      Returns the score bias against flipping a
      mover. The score bias is determined by the scoring system but can
      be controlled indirectly with the
      :oe:meth:`SetFlipBiasScale<OEBio::OEPlaceHydrogensOptions::SetFlipBiasScale>`
      method.

      .. seealso::

         * :oe:meth:`GetFlipBiasScale<OEBio::OEPlaceHydrogensOptions::GetFlipBiasScale>` method

   .. oe:method:: GetFlipBiasScale

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

         .. oe:api::

            double GetFlipBiasScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlipBiasScale() -> float

      Returns the scaling factor for the score bias against flipping a
      mover. The actual score bias is determined by the scoring system.

      .. seealso::

         * :oe:meth:`GetFlipBias<OEBio::OEPlaceHydrogensOptions::GetFlipBias>` method

   .. oe:method:: GetFlipPredicate

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

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* GetFlipPredicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlipPredicate() -> OEUnaryAtomPred

      Returns a new copy of the predicate that
      :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`
      will use to restrain to the flipped state all flippable movers
      having a matching atom.

      .. oe:language:: c++

         To avoid a memory leak in C++, the returned pointer should be
         stored in a variable of the
         :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` template class
         or deallocated with the ``delete`` operator.

      (Default: :oe:cls:`OEIsFalseAtom<OESystem::OEIsFalse>`)

      .. seealso::

         * :oe:meth:`SetFlipPredicate<OEBio::OEPlaceHydrogensOptions::SetFlipPredicate>` method
         * :oe:meth:`GetBypassPredicate<OEBio::OEPlaceHydrogensOptions::GetBypassPredicate>` method
         * :oe:meth:`GetNoFlipPredicate<OEBio::OEPlaceHydrogensOptions::GetNoFlipPredicate>` method

   .. oe:method:: GetMaxSubstateCutoff

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

         .. oe:api::

            double GetMaxSubstateCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSubstateCutoff() -> float

      Max number of substates processed in a single step of the state optimizer.

      .. seealso::

         * :oe:meth:`SetMaxSubstateCutoff<OEBio::OEPlaceHydrogensOptions::SetMaxSubstateCutoff>` method

   .. oe:method:: GetNoFlipPredicate

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

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* GetNoFlipPredicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetNoFlipPredicate() -> OEUnaryAtomPred

      Returns a new copy of the predicate that
      :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`
      will use to restrain to the original (unflipped) state all flippable movers
      having a matching atom.

      .. oe:language:: c++

         To avoid a memory leak in C++, the returned pointer should be
         stored in a variable of the
         :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` template class
         or deallocated with the ``delete`` operator.

      (Default: :oe:cls:`OEIsFalseAtom<OESystem::OEIsFalse>`)

      .. seealso::

         * :oe:meth:`SetNoFlipPredicate<OEBio::OEPlaceHydrogensOptions::SetNoFlipPredicate>` method
         * :oe:meth:`GetBypassPredicate<OEBio::OEPlaceHydrogensOptions::GetBypassPredicate>` method
         * :oe:meth:`GetFlipPredicate<OEBio::OEPlaceHydrogensOptions::GetFlipPredicate>` method

   .. oe:method:: GetStandardizeBondLen

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

         .. oe:api::

            bool GetStandardizeBondLen() const

      .. oe:language:: python

         .. oe:api:: python

            GetStandardizeBondLen() -> bool

      Returns whether the length of bonds to hydrogen atoms are adjusted to
      standard size.

   .. oe:method:: GetWaterProcessing

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

         .. oe:api::

            unsigned GetWaterProcessing() const

      .. oe:language:: python

         .. oe:api:: python

            GetWaterProcessing() -> int

      Returns a constant indicating how waters (and analogs) are processed.

      .. seealso::

         * :oe:constns:`OEBio::OEPlaceHydrogensWaterProcessing` namespace

   .. oe:method:: SetAddMetadata

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

         .. oe:api::

            void SetAddMetadata()

      .. oe:language:: python

         .. oe:api:: python

            SetAddMetadata() -> None

      Controls whether metadata describing the results
      should be added to the molecule. The metadata is the string generated by
      the :oe:meth:`OEBio::OEPlaceHydrogensDetails::Describe` method
      and can be accessed by the :oe:func:`OEBio::OEGetPlaceHydrogensMetadata`
      function.

      (Default: ``true``)

      .. seealso::

         * :oe:func:`OEBio::OEHasPlaceHydrogensMetadata` function
         * :oe:func:`OEBio::OEGetPlaceHydrogensMetadata` function
         * :oe:func:`OEBio::OEClearPlaceHydrogensMetadata` function
         * :ref:`OEPlaceHydrogensDetails <OEBio_OEPlaceHydrogensDetails>` class

   .. oe:method:: SetAltsMustBeCompatible

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

         .. oe:api::

            void SetAltsMustBeCompatible()

      .. oe:language:: python

         .. oe:api:: python

            SetAltsMustBeCompatible() -> None

      Set if alternate location codes are required to be compatible (either
      identical or blank) for atoms to interact. If set to ``true``,
      incompatible atoms will not interact.

      The appropriate setting will depend on how alternate locations are prepared
      in the input molecule. If an :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>` was
      used to select the highest occupancy alternate locations, only one location
      remains for each atom so ``compatible`` should be ``false``, it could
      prevent legitimate interactions. The same is true
      if alt information was stripped and only codes ``A`` and *blank* remain
      (the default behavior when a ``.pdb`` file is read with the default flavor).

      If all location codes are retained on input with the
      :oe:const:`ALTLOC<OEChem::OEIFlavor::PDB::ALTLOC>` flavor and not modified,
      then ``compatible`` should be ``true``. This is not perfect, but generally
      works OK. But it is generally recommended that you read ``.pdb`` files using
      the :oe:const:`ALTLOC<OEChem::OEIFlavor::PDB::ALTLOC>` flavor, process it
      with the :oe:cls:`OEAltLocationFactory<OEBio::OEAltLocationFactory>`, and
      leave ``compatible`` set to ``false`` when calling
      :oe:func:`OEBio::OEPlaceHydrogens`.

      (Default: ``false``)

      .. seealso::

         * :oe:meth:`Constructors<OEBio::OEPlaceHydrogensOptions::Constructors>`
         * :oe:const:`OEChem::OEIFlavor::PDB::ALTLOC` flavor
         * :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>` class

   .. oe:method:: SetBadClashOverlapDistance

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

         .. oe:api::

            bool SetBadClashOverlapDistance(double overlap)

      .. oe:language:: python

         .. oe:api:: python

            SetBadClashOverlapDistance(value: float) -> bool

      Sets the amount of excess van der Waals overlap considered to be
      a "bad" clash. (Default: 0.4 |A|)

   .. oe:method:: SetBypassPredicate

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

         .. oe:api::

            bool SetBypassPredicate(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred)

      .. oe:language:: python

         .. oe:api:: python

            SetBypassPredicate(value: OEUnaryAtomPred) -> bool

      Stores a predicate that :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`
      will use to exclude from analysis all movers having a matching atom.
      Useful for groups where a specific orientation has already been established.

      .. note::

         For any given mover, this predicate takes precedence over both the
         :oe:meth:`flip<OEBio::OEPlaceHydrogensOptions::SetFlipPredicate>` and the
         :oe:meth:`noFlip<OEBio::OEPlaceHydrogensOptions::SetNoFlipPredicate>`
         predicates.

      .. seealso::

         * :oe:meth:`GetBypassPredicate<OEBio::OEPlaceHydrogensOptions::GetBypassPredicate>` method
         * :oe:meth:`SetFlipPredicate<OEBio::OEPlaceHydrogensOptions::SetFlipPredicate>` method
         * :oe:meth:`SetNoFlipPredicate<OEBio::OEPlaceHydrogensOptions::SetNoFlipPredicate>` method

   .. oe:method:: SetFlipBiasScale

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

         .. oe:api::

            bool SetFlipBiasScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetFlipBiasScale(value: float) -> bool

      Sets a scaling factor for the score bias against flipping a
      mover. The actual score bias is determined by the scoring system.
      Setting the bias to ``0.0`` will turn off any bias towards
      the input structure. (Default: ``1.0``)

      .. seealso::

         * :oe:meth:`GetFlipBias<OEBio::OEPlaceHydrogensOptions::GetFlipBias>` method

   .. oe:method:: SetFlipPredicate

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

         .. oe:api::

            bool SetFlipPredicate(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred)

      .. oe:language:: python

         .. oe:api:: python

            SetFlipPredicate(value: OEUnaryAtomPred) -> bool

      Stores a predicate that :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`
      will use to restrain to the flipped state all flippable movers having a matching atom.

      .. note::

         For any given mover, if either the
         :oe:meth:`bypass<OEBio::OEPlaceHydrogensOptions::SetBypassPredicate>`
         predicate or the
         :oe:meth:`noFlip<OEBio::OEPlaceHydrogensOptions::SetNoFlipPredicate>`
         predicate matches, this predicate will be ignored.

      .. seealso::

         * :oe:meth:`GetFlipPredicate<OEBio::OEPlaceHydrogensOptions::GetFlipPredicate>` method
         * :oe:meth:`SetBypassPredicate<OEBio::OEPlaceHydrogensOptions::SetBypassPredicate>` method
         * :oe:meth:`SetNoFlipPredicate<OEBio::OEPlaceHydrogensOptions::SetNoFlipPredicate>` method

   .. oe:method:: SetMaxSubstateCutoff

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

         .. oe:api::

            bool SetMaxSubstateCutoff(double maxStates)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxSubstateCutoff(value: float) -> bool

      Set the maximum number of substates processed in a single step
      of the state optimizer. (Default: 1.0e8)

      .. seealso::

         * :oe:meth:`GetMaxSubstateCutoff<OEBio::OEPlaceHydrogensOptions::GetMaxSubstateCutoff>` method

   .. oe:method:: SetNoFlipPredicate

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

         .. oe:api::

            bool SetNoFlipPredicate(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred)

      .. oe:language:: python

         .. oe:api:: python

            SetNoFlipPredicate(value: OEUnaryAtomPred) -> bool

      Stores a predicate that :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`
      will use to restrain to the original (unflipped) state all flippable movers
      having a matching atom. Useful in preventing a group from being automatically
      flipped.

      .. note::

         For any given mover, if the
         :oe:meth:`bypass<OEBio::OEPlaceHydrogensOptions::SetBypassPredicate>`
         predicate matches, this predicate will be ignored.
         In addition, this predicate takes precedence over the
         :oe:meth:`flip<OEBio::OEPlaceHydrogensOptions::SetFlipPredicate>`
         predicate.

      .. seealso::

         * :oe:meth:`GetNoFlipPredicate<OEBio::OEPlaceHydrogensOptions::GetNoFlipPredicate>` method
         * :oe:meth:`SetBypassPredicate<OEBio::OEPlaceHydrogensOptions::SetBypassPredicate>` method
         * :oe:meth:`SetFlipPredicate<OEBio::OEPlaceHydrogensOptions::SetFlipPredicate>` method

   .. oe:method:: SetStandardizeBondLen

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

         .. oe:api::

            void SetStandardizeBondLen()

      .. oe:language:: python

         .. oe:api:: python

            SetStandardizeBondLen() -> None

      Sets whether the length of bonds to hydrogen atoms are adjusted to
      standard size. (Default: ``true``)

   .. oe:method:: SetWaterProcessing

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

         .. oe:api::

            bool SetWaterProcessing(unsigned process)

      .. oe:language:: python

         .. oe:api:: python

            SetWaterProcessing(value: int) -> bool

      Sets how waters (and analogs) are processed. (Default:
      :oe:const:`OEBio::OEPlaceHydrogensWaterProcessing::Default`)

      .. seealso::

         * :oe:constns:`OEBio::OEPlaceHydrogensWaterProcessing` namespace


.. oe:namespace:: OEBio

.. _OEBio_OEProteinInteractionHintComponent:

.. oe:class:: OEProteinInteractionHintComponent

   .. oe:api::

      class OEProteinInteractionHintComponent : public OEInteractionHintComponentTypeBase

   Built-in component type that classifies molecules as being 'protein' when
   stored in a :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

   The following methods are publicly inherited from :ref:`OEInteractionHintComponentTypeBase <OEBio_OEInteractionHintComponentTypeBase>`:

   ============================================================================ ============================================================================ ============================================================================
   :oe:meth:`operator=<OEBio::OEInteractionHintComponentTypeBase::operator=>`   :oe:meth:`operator==<OEBio::OEInteractionHintComponentTypeBase::operator==>` :oe:meth:`GetName<OEBio::OEInteractionHintComponentTypeBase::GetName>`
   :oe:meth:`operator!=<OEBio::OEInteractionHintComponentTypeBase::operator!=>` :oe:meth:`CreateCopy<OEBio::OEInteractionHintComponentTypeBase::CreateCopy>` :oe:meth:`IsValid<OEBio::OEInteractionHintComponentTypeBase::IsValid>`
   ============================================================================ ============================================================================ ============================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEProteinInteractionHintComponent()

      .. oe:language:: python

         .. oe:api:: python

            OEProteinInteractionHintComponent() -> OEProteinInteractionHintComponent

      Default constructor.

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

         .. oe:api::

            OEProteinInteractionHintComponent(const OEProteinInteractionHintComponent& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEProteinInteractionHintComponent(arg2: OEProteinInteractionHintComponent) -> OEProteinInteractionHintComponent

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEProteinInteractionHintComponent &operator=(const OEProteinInteractionHintComponent &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintComponentTypeBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintComponentTypeBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEChem::OEMolBase &) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Returns whether a molecule can be inserted to a
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object with a
      :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>` type *i.e.*
      it returns true if the molecule has 3D coordinates.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. meta::
   :keywords: OERamachandranAnalysis, Ramachandran

.. _OEBio_OERamachandranAnalysis:

.. oe:class:: OERamachandranAnalysis

   .. oe:api::

      class OERamachandranAnalysis

   This class represents an :ref:`OERamachandranAnalysis <OEBio_OERamachandranAnalysis>`, which holds
   information about the backbone conformation, of a protein residue,
   which can be used for plotting a Ramachandran plot.  A
   Ramachandran plot, is a plot of the protein backbone :math:`\phi`
   and :math:`\psi` angles of an amino acid residue, on the x- and
   y-axis, respectively.  The diagram was originally developed in
   1963 by G. N. Ramachandran [Ramachandran-1963]_ to visualizes
   energetically accessible regions of protein conformational space.
   Initially, there was a single plot used for all standard amino
   acid residues, but recent work has been done on certain residue
   types that do not follow the general pattern [Lovell-2003]_
   [Chen-2010]_ [Hintze-2016]_, specifically new diagrams have been
   derived for: glycine, isoleucine and valine, cis-proline,
   trans-proline, and for residues preceding proline residues, since
   their backbone conformational space is affected by the following
   proline residue. The data was extracted from the open-source 
   Computational Crystallography Toolbox (CCTBX) [Grosse-Kunstleve-2002]_.

   .. note::

      The function expects alternate conformations of the protein to be collapsed,
      meaning only a single alternate conformation should
      exist in the molecule object

   The following is an example of determining the Ramachandran classification for each standard residue in a protein:

   #. Read in a PDB and collapse the alternate conformations (if present). See chapter :ref:`spruce_read_pdb_section` in **Spruce TK**.

   #. Loop over the CA atoms in the protein molecule. Alternatively, (not shown) loop over the residues in the protein.

   #. For each CA atom or residue construct the :ref:`OERamachandranAnalysis <OEBio_OERamachandranAnalysis>`

   #. Print out information about outliers for further analysis

   .. oe:source:: RamaOutlierCheck.py
      :language: python
      :refnum:   1
      :caption:  Example of Ramachandran outlier analysis
      :frag:     SNIPPET-RAMA-OUTLIER-CHECK

   .. oe:source:: RamaOutlierCheck.cpp
      :language: c++
      :refnum:   1
      :caption:  Example of Ramachandran outlier analysis
      :frag:     SNIPPET-RAMA-OUTLIER-CHECK

   .. oe:source:: RamaOutlierCheck.java
      :language: java
      :refnum:   1
      :caption:  Example of Ramachandran outlier analysis
      :frag:     SNIPPET-RAMA-OUTLIER-CHECK

   .. oe:source:: RamaOutlierCheck.cs
      :language: csharp
      :refnum:   1
      :caption:  Example of Ramachandran outlier analysis
      :frag:     SNIPPET-RAMA-OUTLIER-CHECK

   .. seealso:: 

      * :oe:constns:`OEBio::OERamaCategory` namespace
      * :oe:constns:`OEBio::OERamaType` namespace
      * :oe:func:`OEGrapheme::OERenderRamachandranPlot` function in **Grapheme TK** to visualize Ramachandran plots

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <object data="../../_images/RenderRamachandranPlot-General.svg" type="image/svg+xml"  width = "350" ></object>
         <p>

         <p align="center">
         <b>Example of Grapeheme TK visualization of Ramachandran plot</b>
         <p>

   .. only:: oepdf

      |NOPDFIMAGE|

   .. oe:method:: Constructors

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

         .. oe:api::

            OERamachandranAnalysis(const OEChem::OEAtomBase* atom)

      .. oe:language:: python

         .. oe:api:: python

            OERamachandranAnalysis(atom: OEAtomBase) -> OERamachandranAnalysis

      The atom based constructor accepts any atom of a given amino
      acid residue and returns an
      :ref:`OERamachandranAnalysis <OEBio_OERamachandranAnalysis>`.  While any atom from
      a residue is acceptable, it is advised to loop over the
      protein atoms with a predicate selecting e.g. only CA atoms,
      as this ensures the analysis is only done once per residue.
      The molecule must have 3D coordinates assigned.
      See code example above.

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

         .. oe:api::

            OERamachandranAnalysis(const OEHierResidue& res)
            OERamachandranAnalysis(const OEChem::OEMolBase& mol,
                                   const OEChem::OEResidue& res)

      .. oe:language:: python

         .. oe:api:: python

            OERamachandranAnalysis(res: OEHierResidue) -> OERamachandranAnalysis
            OERamachandranAnalysis(mol: Union[OEGraphMol,OEMol,OEQMol],
                                   res: OEResidue) -> OERamachandranAnalysis

      Residue based constructors. These constructors, like the atom
      based one, use :oe:func:`OEGetTorsion<OEBio::OEGetTorsion>`,
      to determine the :math:`\phi`, :math:`\psi`, and
      :math:`\omega` dihedrals angles. The dihedral is used to
      differentiate Cis/Trans proline.
      The molecule must have 3D coordinates assigned.

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

         .. oe:api::

            OERamachandranAnalysis(double phi, double psi,
                                   const unsigned int ramaType)

      .. oe:language:: python

         .. oe:api:: python

            OERamachandranAnalysis(phi: float, psi: float, ramaType: int) -> OERamachandranAnalysis

      Constructor that determines the Ramachandran category based on
      raw data, where the user specifies which underlying
      Ramachandran plot to use, by specifying the type using the
      :oe:constns:`OEBio::OERamaType` namespace.

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

         .. oe:api::

            OERamachandranAnalysis(const OERamachandranAnalysis& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OERamachandranAnalysis(arg2: OERamachandranAnalysis) -> OERamachandranAnalysis

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERamachandranAnalysis & operator=(const OERamachandranAnalysis &)

      Assignment operator.

   .. oe:method:: GetPhi

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

         .. oe:api::

            double GetPhi() const

      .. oe:language:: python

         .. oe:api:: python

            GetPhi() -> float

      Returns the value of the backbone :math:`\phi` dihedral angle used to evaluate the score, in radians.

   .. oe:method:: GetPsi

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

         .. oe:api::

            double GetPsi() const

      .. oe:language:: python

         .. oe:api:: python

            GetPsi() -> float

      Returns the value of the backbone :math:`\psi` dihedral angle used to evaluate the score, in radians.

   .. oe:method:: GetRamaCategory

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

         .. oe:api::

            unsigned int GetRamaCategory() const

      .. oe:language:: python

         .. oe:api:: python

            GetRamaCategory() -> int

      Returns a value corresponding to the classification for the
      residue from the :oe:constns:`OEBio::OERamaCategory`
      namespace.

   .. oe:method:: GetRamaScore

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

         .. oe:api::

            double GetRamaScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetRamaScore() -> float

      Returns the value of the residue's Ramachandran score, which
      is a score relative to contours of expected Ramachandran
      behavior.

   .. oe:method:: GetRamaType

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

         .. oe:api::

            unsigned int GetRamaType() const

      .. oe:language:: python

         .. oe:api:: python

            GetRamaType() -> int

      Returns a value corresponding to the
      :oe:constns:`OEBio::OERamaCategory` namespace of the type
      of Ramachandran plot data used to determine the classification.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. meta::
   :keywords: OEReceptor, Receptor

.. _OEBio_OEReceptor:

.. oe:class:: OEReceptor

   .. oe:api::

      class OEReceptor

   The :ref:`OEReceptor <OEBio_OEReceptor>` represents a receptor as used in a
   **OEDocking** or **POSIT** calculation.

   The :ref:`OEReceptor <OEBio_OEReceptor>` class defines the following public methods:
    * :oe:meth:`AddProteinConstraint<OEBio::OEReceptor::AddProteinConstraint>`
    * :oe:meth:`Clear<OEBio::OEReceptor::Clear>`
    * :oe:meth:`ClearCustomConstraints<OEBio::OEReceptor::ClearCustomConstraints>`
    * :oe:meth:`ClearProteinConstraint<OEBio::OEReceptor::ClearProteinConstraint>`
    * :oe:meth:`ClearProteinConstraints<OEBio::OEReceptor::ClearProteinConstraints>`
    * :ref:`GetCustomConstraints <OEBio_OEReceptor_GetCustomConstraints>`
    * :oe:meth:`GetInnerContourLevel<OEBio::OEReceptor::GetInnerContourLevel>`
    * :oe:meth:`GetNegativeImageGrid<OEBio::OEReceptor::GetNegativeImageGrid>`
    * :oe:meth:`GetOuterContourLevel<OEBio::OEReceptor::GetOuterContourLevel>`
    * :oe:meth:`GetOuterContourVolume<OEBio::OEReceptor::GetOuterContourVolume>`
    * :oe:meth:`GetInnerContourVolume<OEBio::OEReceptor::GetInnerContourVolume>`
    * :oe:meth:`NumProteinConstraints(<OEBio::OEReceptor::NumProteinConstraints>`
    * :oe:meth:`GetProteinConstraints<OEBio::OEReceptor::GetProteinConstraints>`
    * :oe:meth:`GetTargetMask<OEBio::OEReceptor::GetTargetMask>`
    * :oe:meth:`GetTargetPred<OEBio::OEReceptor::GetTargetPred>`
    * :oe:meth:`IsValid<OEBio::OEReceptor::IsValid>`
    * :oe:meth:`HasCustomConstraints<OEBio::OEReceptor::HasCustomConstraints>`
    * :oe:meth:`HasInnerContourLevel<OEBio::OEReceptor::HasInnerContourLevel>`
    * :oe:meth:`HasNegativeImageGrid<OEBio::OEReceptor::HasNegativeImageGrid>`
    * :oe:meth:`HasOuterContourLevel<OEBio::OEReceptor::HasOuterContourLevel>`
    * :oe:meth:`HasProteinConstraints<OEBio::OEReceptor::HasProteinConstraints>`
    * :oe:meth:`SetCustomConstraints<OEBio::OEReceptor::SetCustomConstraints>`
    * :oe:meth:`SetInnerContourLevel<OEBio::OEReceptor::SetInnerContourLevel>`
    * :oe:meth:`SetOuterContourLevel<OEBio::OEReceptor::SetOuterContourLevel>`

   .. oe:method:: Constructor

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

         .. oe:api::

            OEReceptor()
            OEReceptor(const OEReceptor &)

      .. oe:language:: python

         .. oe:api:: python

            OEReceptor() -> OEReceptor
            OEReceptor(arg2: OEReceptor) -> OEReceptor

   Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEReceptor &operator=(const OEReceptor &)

   .. _OEBio_OEReceptor_AddProteinConstraint:

      Assignment operator.

   .. oe:method:: AddProteinConstraint

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

         .. oe:api::

            bool AddProteinConstraint(const OEReceptorProteinConstraint&)

      .. oe:language:: python

         .. oe:api:: python

            AddProteinConstraint(arg2: OEReceptorProteinConstraint) -> bool

      Adds a protein constraint. If the receptor already has a constraint on the specified atom the constraint 
      will be replaced, otherwise a new one will be created.

   .. _OEBio_OEReceptor_Clear:

   .. oe:method:: Clear

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

         .. oe:api::

            bool Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> bool

      Clear all receptor information from receptor, and makes it an invalid receptor.

   .. _OEBio_OEReceptor_ClearCustomConstraints:

   .. oe:method:: ClearCustomConstraints

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

         .. oe:api::

            bool ClearCustomConstraints()

      .. oe:language:: python

         .. oe:api:: python

            ClearCustomConstraints() -> bool

      Clear all custom constraints from the receptor.
 
    .. _OEBio_OEReceptor_ClearProteinConstraint:

   .. oe:method:: ClearProteinConstraint

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

         .. oe:api::

            bool ClearProteinConstraint(const OEReceptorProteinConstraint*)

      .. oe:language:: python

         .. oe:api:: python

            ClearProteinConstraint(arg2: OEReceptorProteinConstraint) -> bool

      Remove the specified protein constraint from the receptor.

    .. _OEBio_OEReceptor_ClearProteinConstraints:

   .. oe:method:: ClearProteinConstraints

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

         .. oe:api::

            bool ClearProteinConstraints()

      .. oe:language:: python

         .. oe:api:: python

            ClearProteinConstraints() -> bool

      Clear all protein constraint from the receptor.

    .. _OEBio_OEReceptor_GetCustomConstraints:

   .. oe:method:: GetCustomConstraints

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

         .. oe:api::

            const OEReceptorCustomConstraints& GetCustomConstraints() const
            OEReceptorCustomConstraints& GetCustomConstraints()

      .. oe:language:: python

         .. oe:api:: python

            GetCustomConstraints() -> OEReceptorCustomConstraints

      Return a copy of the receptor’s custom constraints.

    .. _OEBio_OEReceptor_GetInnerContourLevel:

   .. oe:method:: GetInnerContourLevel

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

         .. oe:api::

            float GetInnerContourLevel() const

      .. oe:language:: python

         .. oe:api:: python

            GetInnerContourLevel() -> float

      Return the inner contour level of the receptor

    .. _OEBio_OEReceptor_GetNegativeImageGrid:

   .. oe:method:: GetNegativeImageGrid

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

         .. oe:api::

            OESystem::OEGrid<float> GetNegativeImageGrid() const

      .. oe:language:: python

         .. oe:api:: python

            GetNegativeImageGrid() -> OEFloatGrid

      Return a copy of the receptor's negative image potential grid.

    .. _OEBio_OEReceptor_GetOuterContourLevel:

   .. oe:method:: GetOuterContourLevel

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

         .. oe:api::

            float GetOuterContourLevel() const

      .. oe:language:: python

         .. oe:api:: python

            GetOuterContourLevel() -> float

      Return the outer contour level of the receptor

   .. _OEBio_OEReceptor_GetOuterContourVolume:

   .. oe:method:: GetOuterContourVolume

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

         .. oe:api::

            float GetOuterContourVolume() const

      .. oe:language:: python

         .. oe:api:: python

            GetOuterContourVolume() -> float

      Return the volume of the outer contour of the receptor at the set contour level. 
      Will return zero if the contour is not set or has a negative value.

   .. _OEBio_OEReceptor_GetInnerContourVolume:

   .. oe:method:: GetInnerContourVolume

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

         .. oe:api::

            float GetInnerContourVolume() const

      .. oe:language:: python

         .. oe:api:: python

            GetInnerContourVolume() -> float

      Return the volume of the inner contour of the receptor at the set contour level
      Will return zero if the contour is not set or has a negative value.

   .. _OEBio_OEReceptor_NumProteinConstraints:

   .. oe:method:: NumProteinConstraints

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

         .. oe:api::

            unsigned int NumProteinConstraints(bool enabledOnly = true) const

      .. oe:language:: python

         .. oe:api:: python

            NumProteinConstraints(enabledOnly: bool = True) -> int

      Returns the number of :ref:`OEReceptorProteinConstraint <OEBio_OEReceptorProteinConstraint>` objects contained by this
      class.  

      If *enabledOnly* is true then only :ref:`OEReceptorProteinConstraint <OEBio_OEReceptorProteinConstraint>` objects
      for which the method :oe:meth:`OEBio::OEReceptorProteinConstraint::GetEnabled` returns true will
      be counted.

    .. _OEBio_OEReceptor_GetProteinConstraints:

   .. oe:method:: GetProteinConstraints

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

         .. oe:api::

            OESystem::OEIterBase<const OEReceptorProteinConstraint>* GetProteinConstraints(bool enabledOnly = true) const
            OESystem::OEIterBase<OEReceptorProteinConstraint>* GetProteinConstraints(bool enabledOnly = true)

      .. oe:language:: python

         .. oe:api:: python

            GetProteinConstraints(enabledOnly: bool = True) -> Iterable[OEReceptorProteinConstraint]

      Returns an iterator over the receptor’s protein constraints. If ``enabledOnly`` is ``true`` then only 
      enabled constraints will be returned.

    .. _OEBio_OEReceptor_GetTargetMask:

   .. oe:method:: GetTargetMask

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

         .. oe:api::

            unsigned GetTargetMask() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetMask() -> int

      Return the target mask corresponding to the receptor. The mask and predicate, can be used with
      the :oe:meth:`OEBio::OEDesignUnit::GetComponents` method to generate the molecule used in receptor generation. 

    .. _OEBio_OEReceptor_GetTargetPred:

   .. oe:method:: GetTargetPred

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

         .. oe:api::

            OEBio::OEAtomMatchResidue GetTargetPred() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetPred() -> OEAtomMatchResidue

      Returns the residue based :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>` predicate used with the corresponding
      target mask to generate the receptor. The mask and predicate, can be used with the 
      :oe:meth:`OEBio::OEDesignUnit::GetComponents` method to generate the molecule used in receptor generation. 

      .. seealso::

         * :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>` class
         * :oe:meth:`OEBio::OEDesignUnit::GetComponents` method

    .. _OEBio_OEReceptor_IsValid:

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns if the this is a valid receptor, and ready to be used for **OEDocking** or **POSIT** calculation.

    .. _OEBio_OEReceptor_HasCustomConstraints:

   .. oe:method:: HasCustomConstraints

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

         .. oe:api::

            bool HasCustomConstraints(const bool enabledOnly = true) const

      .. oe:language:: python

         .. oe:api:: python

            HasCustomConstraints(enabledOnly: bool = True) -> bool

      Returns true if receptor has custom constraints. If ``enabledOnly`` is ``true`` then at least one of the 
      constraints must be enabled.

    .. _OEBio_OEReceptor_HasInnerContourLevel:

   .. oe:method:: HasInnerContourLevel

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

         .. oe:api::

            bool HasInnerContourLevel() const

      .. oe:language:: python

         .. oe:api:: python

            HasInnerContourLevel() -> bool

      Returns true if the receptor has an inner contour level set.

    .. _OEBio_OEReceptor_HasNegativeImageGrid:

   .. oe:method:: HasNegativeImageGrid

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

         .. oe:api::

            bool HasNegativeImageGrid() const

      .. oe:language:: python

         .. oe:api:: python

            HasNegativeImageGrid() -> bool

      Returns true if the receptor has negative image potential grid.  A receptor is invalid without
      the negative image potential grid.

    .. _OEBio_OEReceptor_HasOuterContourLevel:

   .. oe:method:: HasOuterContourLevel

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

         .. oe:api::

            bool HasOuterContourLevel() const

      .. oe:language:: python

         .. oe:api:: python

            HasOuterContourLevel() -> bool

      Returns true if the receptor has an outer contour level set.

    .. _OEBio_OEReceptor_HasProteinConstraints:

   .. oe:method:: HasProteinConstraints

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

         .. oe:api::

            bool HasProteinConstraints(const bool enabledOnly = true) const

      .. oe:language:: python

         .. oe:api:: python

            HasProteinConstraints(enabledOnly: bool = True) -> bool

      Returns true if receptor has protein constraints. If ``enabledOnly`` is ``true`` then at least one of the 
      constraints must be enabled.

    .. _OEBio_OEReceptor_SetCustomConstraints:

   .. oe:method:: SetCustomConstraints

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

         .. oe:api::

            bool SetCustomConstraints(const OEReceptorCustomConstraints&)

      .. oe:language:: python

         .. oe:api:: python

            SetCustomConstraints(arg2: OEReceptorCustomConstraints) -> bool

      Set **custom constraints** to the receptor. Returns ``true`` is set. 

    .. _OEBio_OEReceptor_SetInnerContourLevel:

   .. oe:method:: SetInnerContourLevel

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

         .. oe:api::

            bool SetInnerContourLevel(const float level)

      .. oe:language:: python

         .. oe:api:: python

            SetInnerContourLevel(level: float) -> bool

      Set **inner contour level** to the receptor. Returns ``true`` is set. 

    .. _OEBio_OEReceptor_SetOuterContourLevel:

   .. oe:method:: SetOuterContourLevel

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

         .. oe:api::

            bool SetOuterContourLevel(const float level)

      .. oe:language:: python

         .. oe:api:: python

            SetOuterContourLevel(level: float) -> bool

      Set **outer contour level** to the receptor. Returns ``true`` is set.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEReceptorConstraintFeature

.. _OEBio_OEReceptorConstraintFeature:

.. oe:class:: OEReceptorConstraintFeature

   .. oe:api::

      class OEReceptorConstraintFeature

   OEBio_OEReceptorConstraintFeature represents a single custom
   docking constraint in an :ref:`OEReceptor <OEBio_OEReceptor>`.

   To satisfy a docking constraint a pose must either have: 

   #. At least one atom that
      matches one of the SMARTS patterns returned by 
      :ref:`GetSmarts <OEBio_GetSmarts>`
      **and** falls within one of the spheres returned by 
      :ref:`GetFeatureSpheres <OEBio_OEReceptorConstraintFeature_GetFeatureSpheres>`.

   #. At least one heavy atom that falls within one of the spheres
      returned by :ref:`GetFeatureSpheres <OEBio_OEReceptorConstraintFeature_GetFeatureSpheres>`, 
      **if** the :ref:`OEReceptorConstraintFeature<OEBio_OEReceptorConstraintFeature>` has
      no SMARTS patterns.

   .. oe:method:: Constructor

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

         .. oe:api::

            OEReceptorConstraintFeature()
            OEReceptorConstraintFeature(const OEReceptorConstraintFeature&)

      .. oe:language:: python

         .. oe:api:: python

            OEReceptorConstraintFeature() -> OEReceptorConstraintFeature
            OEReceptorConstraintFeature(arg2: OEReceptorConstraintFeature) -> OEReceptorConstraintFeature

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEReceptorConstraintFeature& operator=(const OEReceptorConstraintFeature&)

      Assignment operator.

   ..   _OEBio_OEReceptorConstraintFeature_GetFeatureSpheres:

   .. oe:method:: GetFeatureSpheres

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

         .. oe:api::

            OESystem::OEIterBase<OEMath::OESphere>* GetFeatureSpheres()
            OESystem::OEIterBase<OEMath::OESphere>* GetFeatureSpheres()

      .. oe:language:: python

         .. oe:api:: python

            GetFeatureSpheres() -> Iterable[OESphere]

      Returns all spheres associated with this custom constraint feature.

   .. oe:method:: AddNewSphere

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

         .. oe:api::

            OEMath::OESphere* AddNewSphere()
            OEMath::OESphere* AddNewSphere(const OEMath::OESphere& sph)

      .. oe:language:: python

         .. oe:api:: python

            AddNewSphere() -> OESphere
            AddNewSphere(arg2: OESphere) -> OESphere

      Adds an :ref:`OESphere <OEMath_OESphere>` object to this class.  If
      *sph* is passed the created sphere will be a copy of *sph* otherwise
      a default constructed sphere will be created.

      Note that the returned memory is owned by this class and will be
      destroyed by the destructor of this class.

   .. oe:method:: DeleteSphere

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

         .. oe:api::

            bool DeleteSphere(const OEMath::OESphere* sph)

      .. oe:language:: python

         .. oe:api:: python

            DeleteSphere(arg2: OESphere) -> bool

      Deletes a :ref:`OESphere <OEMath_OESphere>` held by this class.  Note
      that after this call *sph* will no longer point to a valid 
      :ref:`OESphere <OEMath_OESphere>` object.

   .. oe:method:: NumSpheres

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

         .. oe:api::

            unsigned int NumSpheres() const

      .. oe:language:: python

         .. oe:api:: python

            NumSpheres() -> int

      Returns the number of spheres held by this object.

   .. oe:method:: ClearSpheres

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

         .. oe:api::

            bool ClearSpheres()

      .. oe:language:: python

         .. oe:api:: python

            ClearSpheres() -> bool

      Returns this object to its default constructed state.  Deleting all
      spheres and SMARTS patterns it currently holds.

   ..   _OEBio_GetSmarts:

   .. oe:method:: GetSmarts

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

         .. oe:api::

            OESystem::OEIterBase<const std::string>* GetSmarts() const
            OESystem::OEIterBase<std::string>* GetSmarts()

      .. oe:language:: python

         .. oe:api:: python

            GetSmarts() -> Iterable[str]

      Returns an iterator over all SMARTS patterns associated with this
      :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>`.

   .. oe:method:: AddSmarts

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

         .. oe:api::

            bool AddSmarts(const std::string& smarts)

      .. oe:language:: python

         .. oe:api:: python

            AddSmarts(Smarts: str) -> bool

      Adds a SMARTS pattern to this :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>`.

   .. oe:method:: DeleteSmarts

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

         .. oe:api::

            bool DeleteSmarts(const std::string& smarts)

      .. oe:language:: python

         .. oe:api:: python

            DeleteSmarts(smarts: str) -> bool

      Deletes the specified SMARTS pattern from this :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>`.

   .. oe:method:: NumSmarts

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

         .. oe:api::

            unsigned int NumSmarts() const

      .. oe:language:: python

         .. oe:api:: python

            NumSmarts() -> int

      Returns the number of SMARTS patterns held by this 
      :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>`.

   .. oe:method:: ClearSmarts

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

         .. oe:api::

            bool ClearSmarts()

      .. oe:language:: python

         .. oe:api:: python

            ClearSmarts() -> bool

      Deletes all SMARTS patterns associated with this 
      :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>`.

   .. oe:method:: SetFeatureName

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

         .. oe:api::

            void SetFeatureName(const std::string&)

      .. oe:language:: python

         .. oe:api:: python

            SetFeatureName(arg2: str) -> None

      Sets the name of this feature.

   .. oe:method:: GetFeatureName

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

         .. oe:api::

            std::string GetFeatureName() const

      .. oe:language:: python

         .. oe:api:: python

            GetFeatureName() -> str

      Returns the name of the feature.

   .. oe:method:: SetEnabled

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

         .. oe:api::

            void SetEnabled(const bool enabled)

      .. oe:language:: python

         .. oe:api:: python

            SetEnabled(enabled: bool) -> None

      Sets whether this feature is enabled or not.  If the feature
      is disabled the constraint will be ignored 
      during the docking process.

   .. oe:method:: GetEnabled

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

         .. oe:api::

            bool GetEnabled() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnabled() -> bool

      Returns whether this feature is enabled.  If this function
      returns false this constraint will be ignored during the
      docking process.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEReceptorConstraintFeature* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEReceptorConstraintFeature

      Creates a copy of this :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>`.  Note
      that the memory returned by this function is **not** owned by
      this class, and is the responsibility of the calling function.



.. oe:namespace:: OEBio

.. meta::
   :keywords: OEReceptorCustomConstraints, ReceptorCustomConstraints

.. _OEBio_OEReceptorCustomConstraints:

.. oe:class:: OEReceptorCustomConstraints

   .. oe:api::

      class OEReceptorCustomConstraints

   :ref:`OEReceptorCustomConstraints <OEBio_OEReceptorCustomConstraints>` holds a set of custom docking
   constraint features.  Each custom constraint is defined by an
   :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` contained by this class.

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

         .. oe:api::

            OEReceptorCustomConstraints()
            OEReceptorCustomConstraints(const OEReceptorCustomConstraints& )

      .. oe:language:: python

         .. oe:api:: python

            OEReceptorCustomConstraints() -> OEReceptorCustomConstraints
            OEReceptorCustomConstraints(arg2: OEReceptorCustomConstraints) -> OEReceptorCustomConstraints

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++
      
      .. oe:api::

         OEReceptorCustomConstraints& operator=(const OEReceptorCustomConstraints&)

      Assignment operator.

   ..   _OEBio_GetConstraintFeatures:

   .. oe:method:: GetConstraintFeatures

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

         .. oe:api::

            OESystem::OEIterBase<OEReceptorConstraintFeature>* GetConstraintFeatures(bool enabledOnly = true)
            OESystem::OEIterBase<const OEReceptorConstraintFeature>* GetConstraintFeatures(bool enabledOnly = true) const

      .. oe:language:: python

         .. oe:api:: python

            GetConstraintFeatures(const: bool) -> Iterable[OEReceptorConstraintFeature]

      Returns an iterator over all features contained by this class, 
      or all enabled features if *enabledOnly* is true 
      (see :oe:meth:`OEBio::OEReceptorConstraintFeature::GetEnabled` method).

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

         .. oe:api::

            OEReceptorConstraintFeature* AddNewFeature()

      .. oe:language:: python

         .. oe:api:: python

            AddNewFeature() -> OEReceptorConstraintFeature

      Adds a new :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` object to this class and returns a pointer
      to the newly created :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>`.  The returned
      :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` object is owned by this class, and will be destroyed
      by the destructor of this class.

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

         .. oe:api::

            bool DeleteFeature(const OEReceptorConstraintFeature* feature)

      .. oe:language:: python

         .. oe:api:: python

            DeleteFeature(arg2: OEReceptorConstraintFeature) -> bool

      Deletes an :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` owned by this class.  Note that after
      this method is called *feature* will no longer point to a valid 
      :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` object.

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

         .. oe:api::

            unsigned int NumFeatures(bool enabledOnly = true) const

      .. oe:language:: python

         .. oe:api:: python

            NumFeatures(enabledOnly: bool = True) -> int

      Returns the number of :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` objects contained by this
      class.  

      If *enabledOnly* is true then only :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` objects
      for which the method :oe:meth:`OEBio::OEReceptorConstraintFeature::GetEnabled` returns true will
      be counted.
    
   .. oe:method:: Clear
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> bool

      Returns this object to its default constructed state, deleting any 
      :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` objects it may currently be holding.

         



.. oe:namespace:: OEBio

.. meta::
   :keywords: OEReceptorProteinConstraint, ReceptorProteinConstraint

.. _OEBio_OEReceptorProteinConstraint:

.. oe:class:: OEReceptorProteinConstraint

   .. oe:api::

      class OEReceptorProteinConstraint

   This class holds information about a single receptor protein constraint.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEReceptorProteinConstraint & operator=(const OEReceptorProteinConstraint &)

      Assignment operator.

   .. oe:method:: GetAtom

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

         .. oe:api::

            OEChem::OEAtomBase* GetAtom(const OEChem::OEMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtom(mol: Union[OEGraphMol,OEMol,OEQMol]) -> OEAtomBase

      Return the protein atom of the receptor the constraint is associated with.
      The input molecule refers to the corresponding target protein.

   .. oe:method:: GetType

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

         .. oe:api::

            unsigned int GetType() const

      .. oe:language:: python

         .. oe:api:: python

            GetType() -> int

      Type for the constraint (see :oe:constns:`OEBio::OEProteinConstraintType`).

   .. oe:method:: GetEnabled

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

         .. oe:api::

            bool GetEnabled() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnabled() -> bool

      Returns true if the constraint is enabled and false otherwise.

   .. oe:method:: GetName

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

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the name of the constraint.

   .. oe:method:: SetAtom

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

         .. oe:api::

            void SetAtom(OEChem::OEAtomBase* atom)

      .. oe:language:: python

         .. oe:api:: python

            SetAtom(atom: OEAtomBase) -> None

      Sets the atom of the receptor the constraint will be associated with.

   .. oe:method:: SetType

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

         .. oe:api::

            void SetType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetType(type: int) -> bool

      Sets the constraint type (see :oe:constns:`OEBio::OEProteinConstraintType`).

   .. oe:method:: SetName

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

         .. oe:api::

            void SetEnabled(bool enabled)

      .. oe:language:: python

         .. oe:api:: python

            SetName(name: str) -> bool

      Sets the name of the constraint.

   .. oe:method:: SetEnabled

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

         .. oe:api::

            void SetName(std::string name)

      .. oe:language:: python

         .. oe:api:: python

            SetEnabled(enabled: bool) -> bool

      Sets the enabled flag of the constraint.



.. oe:namespace:: OEBio

.. meta::
   :keywords: OEResidueCategoryData, ResidueCategoryData

.. _OEBio_OEResidueCategoryData:

.. oe:class:: OEResidueCategoryData

   .. oe:api::

      class OEResidueCategoryData

   This class represents a container for a collection of residue name lists,
   each list associated with a category in the
   :oe:constns:`OEBio::OEResidueDatabaseCategory` namespace.
   These lists define various types of components found in a
   macromolecular complex. The main use of these lists is to identify
   molecules that are *not* ligands, so that ligands may be recognized more easily.

   The :ref:`OEMolComplexCategorizer <OEBio_OEMolComplexCategorizer>` class makes use of a
   `OEResidueCategoryData` object.
   The following :ref:`OEMolComplexCategorizer <OEBio_OEMolComplexCategorizer>` methods get
   or set an `OEResidueCategoryData`:

   ========================================================================================= =========================================================================================
   :oe:meth:`GetResidueCategoryData<OEBio::OEMolComplexCategorizer::GetResidueCategoryData>`                     :oe:meth:`SetResidueCategoryData<OEBio::OEMolComplexCategorizer::SetResidueCategoryData>`
   ========================================================================================= =========================================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEResidueCategoryData()
            OEResidueCategoryData(const OEResidueCategoryData& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEResidueCategoryData() -> OEResidueCategoryData
            OEResidueCategoryData(rhs: OEResidueCategoryData) -> OEResidueCategoryData

      Constructor and copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEResidueCategoryData &operator=(const OEResidueCategoryData &rhs)

      Assignment operator.

   .. oe:method:: AddToDB

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

         .. oe:api::

            bool AddToDB(const unsigned category, const std::string& resName)
            bool AddToDB(const unsigned category,
                         const std::vector<std::string>& list)

      .. oe:language:: python

         .. oe:api:: python

            AddToDB(category: int, list: OEStringVector) -> bool

      Add an entry to the list associated with the specified category.

      .. note:: The overload that takes a std::vector parameter is only available in C++.

   .. oe:method:: ClearDBCategory

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

         .. oe:api::

            bool ClearDBCategory(const unsigned category)

      .. oe:language:: python

         .. oe:api:: python

            ClearDBCategory(category: int) -> bool

      Remove all entries in the list associated with the specified category.

   .. oe:method:: RemoveFromDB

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

         .. oe:api::

            bool RemoveFromDB(const unsigned category,
                              const std::string& resName)
            bool RemoveFromDB(const unsigned category,
                              const std::vector<std::string>& list)

      .. oe:language:: python

         .. oe:api:: python

            RemoveFromDB(category: int, list: OEStringVector) -> bool

      Remove an entry from the list associated with the specified category.

      .. note:: The overload that takes a std::vector parameter is only available in C++.

   .. oe:method:: FoundInDB

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

         .. oe:api::

            bool FoundInDB(const unsigned category, const std::string& resName) const

      .. oe:language:: python

         .. oe:api:: python

            FoundInDB(category: int, resName: str) -> bool

      Is the specified residue name found in the list associated
      with the specified category.

   .. oe:method:: AllInDB

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

         .. oe:api::

            bool AllInDB(const unsigned category,
                         const std::vector<std::string>& resNames) const

      .. oe:language:: python

         .. oe:api:: python

            AllInDB(category: int, resNames: OEStringVector) -> bool

      Are all the specified residue names found in the list associated
      with the specified category.

   .. oe:method:: GetEntries

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

         .. oe:api::

            OESystem::OEIterBase<const std::string>* GetEntries(const unsigned category) const

      .. oe:language:: python

         .. oe:api:: python

            GetEntries(category: int) -> Iterable[str]

      Return an iterator of all the entries in the list associated
      with the specified category.

   .. oe:method:: Size

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

         .. oe:api::

            unsigned Size(const unsigned category) const

      .. oe:language:: python

         .. oe:api:: python

            Size(category: int) -> int

      Return the size of the list associated with the specified category.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OERotamer, Rotamer

.. _OEBio_OERotamer:

.. oe:class:: OERotamer

   .. oe:api::

      struct OERotamer

   This class represents an :ref:`OERotamer <OEBio_OERotamer>`, an abstraction of
   a frequently observed conformation of an amino-acid side-chain.
   Statistical surveys of side-chain conformations
   for well-curated sets of protein structures reveal that almost all
   can be assigned to a limited number of clusters.
   The mean, or more usefully the *mode*, of each cluster's dihedral
   angles can be used to represent the cluster as a whole.
   Collections of these dihedral angles, along with the observed
   probability of the associated cluster is known as a rotamer library.

   .. seealso::

      * :oe:func:`OEBio::OESetRotamer` function that takes an :ref:`OERotamer <OEBio_OERotamer>` as an argument
        and modifies the 3-dimensional structure of a particular amino-acid
        side-chain so that the dihedral angles are that of the rotamer.
      * :oe:func:`OEBio::OEGetRotamers` function that returns an :ref:`OERotamer <OEBio_OERotamer>` iterator
        over each rotamer for a given amino-acid in a specific rotamer library.
      * :oe:constns:`OEBio::OERotamerLibrary` namespace
      * :oe:func:`OEChem::OEGetTorsion` function

   .. note::

      If a specific side-chain dihedral angle does not exist in the given residue,
      the above GetChiN e.g. :oe:meth:`OEBio::OERotamer::GetChi1` methods return ``-100.0``.

   .. oe:method:: GetChi1

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

         .. oe:api::

            float GetChi1() const

      .. oe:language:: python

         .. oe:api:: python

            GetChi1() -> float

      Return the value of the side-chain :math:`\chi_1` dihedral angle,
      ``N-CA-CB-xG(1)``.

   .. oe:method:: GetChi2

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

         .. oe:api::

            float GetChi2() const

      .. oe:language:: python

         .. oe:api:: python

            GetChi2() -> float

      Return the value of the side-chain :math:`\chi_2` dihedral angle,
      ``CA-CB-xG(1)-xD(1)``.

   .. oe:method:: GetChi3

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

         .. oe:api::

            float GetChi3() const

      .. oe:language:: python

         .. oe:api:: python

            GetChi3() -> float

      Return the value of the side-chain :math:`\chi_3` dihedral angle,
      ``CB-xG-xD-xE(1)``.

   .. oe:method:: GetChi4

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

         .. oe:api::

            float GetChi4() const

      .. oe:language:: python

         .. oe:api:: python

            GetChi4() -> float

      Return the value of the side-chain :math:`\chi_4` dihedral angle,
      ``xG-xD-xE-xZ``.

   .. oe:method:: GetProbability

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

         .. oe:api::

            float GetProbability() const

      .. oe:language:: python

         .. oe:api:: python

            GetProbability() -> float

      Return the probability assigned to this rotamer by
      the rotamer library used to set the rotamer parameters
      (see :oe:constns:`OEBio::OERotamerLibrary`).

   .. oe:method:: GetResidueIndex

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

         .. oe:api::

            unsigned int GetResidueIndex() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidueIndex() -> int

      Return the :oe:constns:`OEChem::OEResidueIndex` value indicating
      the type of amino-acid residue used to set the rotamer parameters.


.. oe:namespace:: OEBio

.. _OEBio_OESaltBridgeInteractionHint:

.. oe:class:: OESaltBridgeInteractionHint

   .. oe:api::

      class OESaltBridgeInteractionHint : public OEInteractionHintTypeBase

   The :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>` class represents
   a built-in type that identifies interactions stored in an
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object as
   **salt-bridge** interactions (inter- and intramolecular).

   .. seealso::

      * :oe:constns:`OEBio::OESaltBridgeInteractionHintType` namespace for specific **salt-bridge** interaction types
      * :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>` predicate
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class

      To perceive **salt-bridge** interactions:

      * :oe:func:`OEBio::OEPerceiveInteractionHints` function
      * :oe:meth:`OEBio::OEPerceiveInteractionOptions` class and its methods:

        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxSaltBridgeDistance`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetExtendedSaltBridgeDistance`

   The following methods are publicly inherited from :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`:

   =================================================================== =================================================================== ===================================================================
   :oe:meth:`operator=<OEBio::OEInteractionHintTypeBase::operator=>`   :oe:meth:`operator==<OEBio::OEInteractionHintTypeBase::operator==>` :oe:meth:`GetName<OEBio::OEInteractionHintTypeBase::GetName>`
   :oe:meth:`operator!=<OEBio::OEInteractionHintTypeBase::operator!=>` :oe:meth:`CreateCopy<OEBio::OEInteractionHintTypeBase::CreateCopy>` :oe:meth:`IsValid<OEBio::OEInteractionHintTypeBase::IsValid>`
   =================================================================== =================================================================== ===================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OESaltBridgeInteractionHint(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            OESaltBridgeInteractionHint(type: int) -> OESaltBridgeInteractionHint

      *type*
         This value has to be from the :oe:constns:`OEBio::OESaltBridgeInteractionHintType`
         namespace.

      .. note::

         Two :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>` objects with different
         types from the :oe:constns:`OEBio::OESaltBridgeInteractionHintType`
         namespace are considered to be different.

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

         .. oe:api::

            OESaltBridgeInteractionHint(const OESaltBridgeInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESaltBridgeInteractionHint(rhs: OESaltBridgeInteractionHint) -> OESaltBridgeInteractionHint

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESaltBridgeInteractionHint &operator=(const OESaltBridgeInteractionHint &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintTypeBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintTypeBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEInteractionHintFragment *,
                         const OEInteractionHintFragment *) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHintFragment,
                    arg3: OEInteractionHintFragment) -> bool

      Evaluates whether the two given fragments would form a valid
      **salt-bridge** interaction when added to an
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.


.. oe:namespace:: OEBio

.. meta::
   :keywords: OESequenceAlignment, SequenceAlignment

.. _OEBio_OESequenceAlignment:

.. oe:class:: OESequenceAlignment

   .. oe:api::

      class OESequenceAlignment

   This class contains information regarding a sequence alignment
   between two molecules that have residue information. The class
   includes information concerning the methods used to generate the
   alignment as well as :ref:`OEMatchBase <OEChem_OEMatchBase>` information for either the alpha
   carbons or all the backbone atoms that are paired by the
   alignment. The :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` class can be passed to an
   an :oe:func:`OEBio::OERMSD` function to generate
   3D alignment based on the
   sequence alignment, and can also be passed to the
   :oe:func:`OEBio::OEWriteAlignment`
   function to generate a standard sequence alignment text output.

   .. oe:method:: Constructors

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

         .. oe:api::

            OESequenceAlignment()
            OESequenceAlignment(const OESequenceAlignment& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESequenceAlignment() -> OESequenceAlignment
            OESequenceAlignment(rhs: OESequenceAlignment) -> OESequenceAlignment

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESequenceAlignment &operator=(const OESequenceAlignment &rhs)

      Default assignment operator

      Assignment operator.

   .. oe:method:: operator bool

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

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      An :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` object is considered invalid
      until its implementation is set.

   .. oe:method:: Clear

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

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Resets the object to the state in which it is default constructed.

   .. oe:method:: GetBackboneMatch

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

         .. oe:api::

            const OEChem::OEMatchBase& GetBackboneMatch(unsigned idx1 = 0,
                                                        unsigned idx2 = 1)

      .. oe:language:: python

         .. oe:api:: python

            GetBackboneMatch(idx1: int = 0, idx2: int = 1) -> OEMatchBase

      Returns an :ref:`OEMatchBase <OEChem_OEMatchBase>` that is the alignment of backbone atoms
      between the sequences indicated by 'idx1' and 'idx2'. By default, the
      indices are `0` and `1` respectively, corresponding to a simple
      pairwise alignment.

   .. oe:method:: GetCAlphaMatch

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

         .. oe:api::

            const OEChem::OEMatchBase& GetCAlphaMatch(unsigned idx1 = 0,
                                                      unsigned idx2 = 1)

      .. oe:language:: python

         .. oe:api:: python

            GetCAlphaMatch(idx1: int = 0, idx2: int = 1) -> OEMatchBase

      Returns an :ref:`OEMatchBase <OEChem_OEMatchBase>` that is the alignment of alpha
      carbon atoms between the sequences indicated by 'idx1' and
      'idx2'. By default, the indices are `0` and `1` respectively,
      corresponding to a simple pairwise alignment.

   .. oe:method:: GetChainID

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

         .. oe:api::

            char GetChainID(unsigned int idx) const

      .. oe:language:: python

         .. oe:api:: python

            GetChainID(idx: int) -> str

     Returns the chain id of the given sequence.

     *idx*
        The index of the sequence. In a simple pairwise alignment this should be
        either `0` or `1`.

   .. oe:method:: GetExtend

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

         .. oe:api::

            int GetExtend() const

      .. oe:language:: python

         .. oe:api:: python

            GetExtend() -> int

      Returns an integer that is the extension penalty used in creating
      the sequence alignment.

   .. oe:method:: GetGap

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

         .. oe:api::

            int GetGap() const

      .. oe:language:: python

         .. oe:api:: python

            GetGap() -> int

      Returns an integer that is the gap penalty used in creating the
      sequence alignment.

   .. oe:method:: GetMaxSeqIdx

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

         .. oe:api::

            unsigned GetMaxSeqIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSeqIdx() -> int

      Returns a pointer that is the maximum index of any of the sequences
      used in the alignment.

   .. oe:method:: GetMethod

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

         .. oe:api::

            unsigned GetMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetMethod() -> int

      Returns the unsigned integer that corresponds to one of the
      constants in the namespace :oe:constns:`OEBio::OESeqAlignmentMethod`.
      This is the method that was used to create the alignment.

   .. oe:method:: GetScore

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

         .. oe:api::

            int GetScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetScore() -> int

      Returns an integer that is the score of the sequence alignment.

   .. oe:method:: GetSequenceIdentity

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

         .. oe:api::

            double GetSequenceIdentity() const

      .. oe:language:: python

         .. oe:api:: python

            GetSequenceIdentity() -> float

      Returns the percentage identity between the two sequences.

   .. oe:method:: GetSequenceSimilarity

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

         .. oe:api::

            double GetSequenceSimilarity() const

      .. oe:language:: python

         .. oe:api:: python

            GetSequenceSimilarity() -> float

      Returns the percentage similarity between the two sequences based
      on the given method.

      .. seealso::

         * :oe:constns:`OEBio::OESeqAlignmentMethod` namespace



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. meta::
   :keywords: OESplitMolComplexOptions, SplitMolComplexOptions

.. _OEBio_OESplitMolComplexOptions:

.. oe:class:: OESplitMolComplexOptions

   .. oe:api::

      class OESplitMolComplexOptions

   The `OESplitMolComplexOptions` class encapsulates
   properties and resources that determine how
   :oe:func:`OEBio::OESplitMolComplex` and
   :oe:func:`OEBio::OEGetMolComplexComponents` operate.
   For examples detailing how to modify and/or operate different filters
   see :ref:`section_split_mol_complex`.

   .. oe:method:: Constructors

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

         .. oe:api::

            OESplitMolComplexOptions(const OESplitMolComplexOptions& rhs)
            OESplitMolComplexOptions(const std::string& ligName = std::string())

      .. oe:language:: python

         .. oe:api:: python

            OESplitMolComplexOptions(ligName: str = str()) -> OESplitMolComplexOptions
            OESplitMolComplexOptions(rhs: OESplitMolComplexOptions) -> OESplitMolComplexOptions

      Constructor and copy constructor. If ``ligName`` is specified
      in the call to the constructor, components will be recognized
      as ligands if and only if
      they have a matching residue name string.

      .. seealso::

         * :oe:meth:`OEBio::OEMolComplexCategorizer::Constructors`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESplitMolComplexOptions &operator=(const OESplitMolComplexOptions &rhs)

      Assignment operator.

   .. oe:method:: operator!=
      :language: c++

      .. oe:api::

         bool operator!=(const OESplitMolComplexOptions &rhs) const

      Not equals operator. Returns ``true`` if options are not equivalent.

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OESplitMolComplexOptions &rhs) const

      Equals operator. Returns ``true`` if options are equivalent.

   .. oe:method:: GetAddRGroup

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

         .. oe:api::

            bool GetAddRGroup() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddRGroup() -> bool

      Returns ``true`` if "R groups" are to be added
      when covalent bonds are broken.

   .. oe:method:: GetAdjustHCount

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

         .. oe:api::

            bool GetAdjustHCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetAdjustHCount() -> bool

      Returns ``true`` if the implicit hydrogen count is to be adjusted
      when covalent bonds are broken.

   .. oe:method:: GetAssumptions

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

         .. oe:api::

            unsigned GetAssumptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetAssumptions() -> int

      Return assumptions about molecular perception.

      .. seealso::

         * :oe:constns:`OEBio::OEAssumption`

   .. oe:method:: GetCategorizer

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

         .. oe:api::

            OEMolComplexCategorizerBase* GetCategorizer() const

      .. oe:language:: python

         .. oe:api:: python

            GetCategorizer() -> OEMolComplexCategorizerBase

      Return a new copy of the :ref:`OEMolComplexCategorizerBase <OEBio_OEMolComplexCategorizerBase>`
      object used to categorize molecular components.

      .. oe:language:: c++

         To avoid a memory leak in C++, the returned pointer should be
         stored in a variable of the
         :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` template class
         or deallocated with the ``delete`` operator.

   .. oe:method:: GetCollectProteinByChain

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

         .. oe:api::

            bool GetCollectProteinByChain() const

      .. oe:language:: python

         .. oe:api:: python

            GetCollectProteinByChain() -> bool

      Returns ``true`` if fragmented protein chains be
      associated with the same the same site.

   .. oe:method:: GetCombinedFilter

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

         .. oe:api::

            OESystem::OEUnaryPredicate<OESystem::OERoleSet>* GetCombinedFilter() const

      .. oe:language:: python

         .. oe:api:: python

            GetCombinedFilter() -> OEUnaryRoleSetPred

      Returns a new copy of the filter that matches
      the *ligand* or *protein* or *water* filters.

      .. oe:language:: c++

         To avoid a memory leak in C++, the returned pointer should be
         stored in a variable of the
         :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` template class
         or deallocated with the ``delete`` operator.

      .. seealso::

         * :oe:meth:`OEBio::OESplitMolComplexOptions::GetLigandFilter`
         * :oe:meth:`OEBio::OESplitMolComplexOptions::GetProteinFilter`
         * :oe:meth:`OEBio::OESplitMolComplexOptions::GetWaterFilter`
         * :oe:meth:`OEBio::OESplitMolComplexOptions::GetOtherFilter`

   .. oe:method:: GetLigandFilter

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

         .. oe:api::

            OESystem::OEUnaryPredicate<OESystem::OERoleSet>* GetLigandFilter() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandFilter() -> OEUnaryRoleSetPred

      Returns a new copy of the *ligand* filter.

      .. oe:language:: c++

         To avoid a memory leak in C++, the returned pointer should be
         stored in a variable of the
         :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` template class
         or deallocated with the ``delete`` operator.

   .. oe:method:: GetMaxBindingSiteDist

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

         .. oe:api::

            double GetMaxBindingSiteDist() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxBindingSiteDist() -> float

      Return the maximum distance from the ligand to be associated with a binding site.
      Can not be less than 1.0 |A|.

   .. oe:method:: GetMaxSurfaceWaterDist

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

         .. oe:api::

            double GetMaxSurfaceWaterDist() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSurfaceWaterDist() -> float

      Return the maximum distance from the protein to be considered a surface water.
      Can not be less than 1.0 |A|.

   .. oe:method:: GetOtherFilter

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

         .. oe:api::

            OESystem::OEUnaryPredicate<OESystem::OERoleSet>* GetOtherFilter() const

      .. oe:language:: python

         .. oe:api:: python

            GetOtherFilter() -> OEUnaryRoleSetPred

      Returns a new copy of the filter that matches everything
      that does *not* match the combined filter.

      .. oe:language:: c++

         To avoid a memory leak in C++, the returned pointer should be
         stored in a variable of the
         :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` template class
         or deallocated with the ``delete`` operator.

      .. seealso::

         * :oe:meth:`OEBio::OESplitMolComplexOptions::GetCombinedFilter`

   .. oe:method:: GetPromoteUnknowns

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

         .. oe:api::

            bool GetPromoteUnknowns() const

      .. oe:language:: python

         .. oe:api:: python

            GetPromoteUnknowns() -> bool

      Returns ``true`` if components classified as
      :oe:const:`OEBio::OEMolComplexFilterCategory::Unknown`
      should be considered the ligand if no others
      ligand is found.

   .. oe:method:: GetProteinFilter

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

         .. oe:api::

            OESystem::OEUnaryPredicate<OESystem::OERoleSet>* GetProteinFilter() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinFilter() -> OEUnaryRoleSetPred

      Returns a new copy of the *protein* filter.

      .. oe:language:: c++

         To avoid a memory leak in C++, the returned pointer should be
         stored in a variable of the
         :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` template class
         or deallocated with the ``delete`` operator.

   .. oe:method:: GetSeparateResidues

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

         .. oe:api::

            bool GetSeparateResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetSeparateResidues() -> bool

      Returns ``true`` if proteins are to be separated into individual residues
      before selection.
      Separating into residues can be used to extract binding site residues.

   .. oe:method:: GetSplitCovalent

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

         .. oe:api::

            bool GetSplitCovalent() const

      .. oe:language:: python

         .. oe:api:: python

            GetSplitCovalent() -> bool

      Returns ``true`` if covalent ligands are to be searched for
      and split out as separate components.

   .. oe:method:: GetSplitCovalentCofactors

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

         .. oe:api::

            bool GetSplitCovalentCofactors() const

      .. oe:language:: python

         .. oe:api:: python

            GetSplitCovalentCofactors() -> bool

      Returns ``true`` if covalent cofactors are to be searched for
      and split out as separate components.

   .. oe:method:: GetWarnNoLigand

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

         .. oe:api::

            bool GetWarnNoLigand() const

      .. oe:language:: python

         .. oe:api:: python

            GetWarnNoLigand() -> bool

      Returns ``true`` if a verbose level warning will be generated
      when a ligand is not found.

   .. oe:method:: GetWaterFilter

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

         .. oe:api::

            OESystem::OEUnaryPredicate<OESystem::OERoleSet>* GetWaterFilter() const

      .. oe:language:: python

         .. oe:api:: python

            GetWaterFilter() -> OEUnaryRoleSetPred

      Returns a new copy of the *water* filter.

      .. oe:language:: c++

         To avoid a memory leak in C++, the returned pointer should be
         stored in a variable of the
         :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` template class
         or deallocated with the ``delete`` operator.

   .. oe:method:: ResetFilters

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

         .. oe:api::

            void ResetFilters(unsigned site = 1u, bool surfaceWaters = false,
                              unsigned ligCategory = OEMolComplexFilterCategory::Ligand,
                              unsigned protCategory = OEMolComplexFilterCategory::ProtComplex,
                              unsigned waterCategory = OEMolComplexFilterCategory::Water,
                              unsigned modelNo = 1u)

      .. oe:language:: python

         .. oe:api:: python

            ResetFilters(site: int = 1, surfaceWaters: bool = False,
                         ligCategory: int, protCategory: int,
                         waterCategory: int, modelNo: int = 1) -> None

      Regenerate filters based on parameters. Can be overridden by methods to
      set individual filters. Site 0 means all sites. ModelNo 0 means all models.

      .. note::

         It may be necessary to remove the input flavor
         :oe:const:`OEChem::OEIFlavor::PDB::ENDM` to read all models
         (see the :ref:`splitmolcomplex<section_example_oebio_splitmolcomplex>`
         example for how to do this).
         In most situations, the ``modelNo`` parameter should be
         set to either 0 or 1 (the default). The reason
         for this is that the site counter, which the ``site`` parameter
         selects based on, does not reset for each model and
         therefore site and model are not independent. A good example of
         where this can be used is with a PDB biological assembly file:
         setting the ``modelNo`` parameter to 0 (use all models),
         allows a binding site spanning symmetry related
         proteins marked as different models to be recognized.

      .. seealso::

         * :oe:constns:`OEBio::OEMolComplexFilterCategory` namespace
         * :oe:func:`OEBio::OEMolComplexFilterFactory` function
         * :oe:meth:`OEBio::OESplitMolComplexOptions::SetLigandFilter`
         * :oe:meth:`OEBio::OESplitMolComplexOptions::SetProteinFilter`
         * :oe:meth:`OEBio::OESplitMolComplexOptions::SetWaterFilter`
         * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
         * :ref:`section_split_mol_complex` section

   .. oe:method:: SetAddRGroup

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

         .. oe:api::

            void SetAddRGroup(bool addR = true)

      .. oe:language:: python

         .. oe:api:: python

            SetAddRGroup(addR: bool = True) -> None

      Set whether "R groups" are to be added when covalent bonds are broken.

   .. oe:method:: SetAdjustHCount

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

         .. oe:api::

            void SetAdjustHCount(bool adjust = true)

      .. oe:language:: python

         .. oe:api:: python

            SetAdjustHCount(adjust: bool = True) -> None

      Set whether the implicit hydrogen count is to be adjusted
      when covalent bonds are broken.

   .. oe:method:: SetAssumptions

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

         .. oe:api::

            void SetAssumptions(unsigned assume)

      .. oe:language:: python

         .. oe:api:: python

            SetAssumptions(assume: int) -> None

      Set assumptions about molecular perception.
      Default = :oe:const:`OEBio::OEAssumption::ResPerceived`

   .. oe:method:: SetCategorizer

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

         .. oe:api::

            void SetCategorizer(const OEMolComplexCategorizerBase& cat)

      .. oe:language:: python

         .. oe:api:: python

            SetCategorizer(cat: OEMolComplexCategorizerBase) -> None

      Set the :ref:`OEMolComplexCategorizerBase <OEBio_OEMolComplexCategorizerBase>` object
      used to categorize molecular components.

   .. oe:method:: SetCollectProteinByChain

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

         .. oe:api::

            void SetCollectProteinByChain(bool collect = true)

      .. oe:language:: python

         .. oe:api:: python

            SetCollectProteinByChain(collect: bool = True) -> None

      Set whether fragmented protein chains should be collected into the same site.
      Default = ``true``

   .. oe:method:: SetLigandFilter

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

         .. oe:api::

            void SetLigandFilter(const OESystem::OEUnaryPredicate<OESystem::OERoleSet>& f)

      .. oe:language:: python

         .. oe:api:: python

            SetLigandFilter(f: OEUnaryRoleSetPred) -> None

      Set the *ligand* filter.
      Default is an :oe:func:`OEBio::OEMolComplexFilterFactory` created with :oe:const:`OEBio::OEMolComplexFilterCategory::Ligand`

      .. seealso::

         * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
         * :oe:func:`OEBio::OEMolComplexFilterFactory` function
         * :oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters`

   .. oe:method:: SetMaxBindingSiteDist

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

         .. oe:api::

            void SetMaxBindingSiteDist(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxBindingSiteDist(dist: float) -> None

      Set the maximum distance from the ligand to be associated with a binding site.
      Default = 8.0 |A|

   .. oe:method:: SetMaxSurfaceWaterDist

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

         .. oe:api::

            void SetMaxSurfaceWaterDist(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxSurfaceWaterDist(dist: float) -> None

      Set the maximum distance from the protein to be considered a surface water.
      Default = 5.0 |A|

   .. oe:method:: SetPromoteUnknowns

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

         .. oe:api::

            void SetPromoteUnknowns(bool promote = true)

      .. oe:language:: python

         .. oe:api:: python

            SetPromoteUnknowns(promote: bool = True) -> None

      Set whether components classified as
      :oe:const:`OEBio::OEMolComplexFilterCategory::Unknown`
      should be considered the ligand if no others
      ligand is found.
      Default = ``true``

   .. oe:method:: SetProteinFilter

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

         .. oe:api::

            void SetProteinFilter(const OESystem::OEUnaryPredicate<OESystem::OERoleSet>& f)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinFilter(f: OEUnaryRoleSetPred) -> None

      Set the *protein* filter.
      Default is an :oe:func:`OEBio::OEMolComplexFilterFactory` created with :oe:const:`OEBio::OEMolComplexFilterCategory::ProtComplex`

      .. seealso::

         * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
         * :oe:func:`OEBio::OEMolComplexFilterFactory` function
         * :oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters`

   .. oe:method:: SetSeparateResidues

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

         .. oe:api::

            void SetSeparateResidues(bool separate = true)

      .. oe:language:: python

         .. oe:api:: python

            SetSeparateResidues(separate: bool = True) -> None

      Set whether to separate proteins into individual residues before selection.
      Can be used to identify binding site residues.
      Default = ``false``

   .. oe:method:: SetSplitCovalent

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

         .. oe:api::

            void SetSplitCovalent(bool split = true)

      .. oe:language:: python

         .. oe:api:: python

            SetSplitCovalent(split: bool = True) -> None

      Set whether covalent ligands are to be searched for
      and split out as separate components.
      Default = ``false``

   .. oe:method:: SetSplitCovalentCofactors

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

         .. oe:api::

            void SetSplitCovalentCofactors(bool split = true)

      .. oe:language:: python

         .. oe:api:: python

            SetSplitCovalentCofactors(split: bool = True) -> None

      Set whether covalent cofactors are to be searched for
      and split out as separate components.
      Default = ``false``

   .. oe:method:: SetWarnNoLigand

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

         .. oe:api::

            void SetWarnNoLigand(bool warn = true)

      .. oe:language:: python

         .. oe:api:: python

            SetWarnNoLigand(warn: bool = True) -> None

      Set whether to send out a verbose level warning
      if a ligand is not found.
      Default = ``true``

   .. oe:method:: SetWaterFilter

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

         .. oe:api::

            void SetWaterFilter(const OESystem::OEUnaryPredicate<OESystem::OERoleSet>& f)

      .. oe:language:: python

         .. oe:api:: python

            SetWaterFilter(f: OEUnaryRoleSetPred) -> None

      Set the *water* filter.
      Default is an :oe:func:`OEBio::OEMolComplexFilterFactory` created with :oe:const:`OEBio::OEMolComplexFilterCategory::Water`

      .. seealso::

         * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
         * :oe:func:`OEBio::OEMolComplexFilterFactory` function
         * :oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters`


.. oe:namespace:: OEBio

.. _OEBio_OEStackingInteractionHint:

.. oe:class:: OEStackingInteractionHint

   .. oe:api::

      class OEStackingInteractionHint : public OEInteractionHintTypeBase

   The :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` class represents
   a built-in type that identifies interactions stored in an
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object as
   Pi or T **stacking** interactions (inter- and intramolecular).

   .. seealso::

      * :oe:constns:`OEBio::OEStackingInteractionHintType` namespace for specific **stacking**  interaction types
      * :ref:`OEIsStackingInteractionHint <OEBio_OEIsStackingInteractionHint>` predicate
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class

      To perceive **stacking** interactions:

      * :oe:func:`OEBio::OEPerceiveInteractionHints` function
      * :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class and its methods:

        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxPiStackAngle`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxPiStackDistance`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxTStackAngle`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxTStackDistance`

   The following methods are publicly inherited from :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`:

   =================================================================== =================================================================== ===================================================================
   :oe:meth:`operator=<OEBio::OEInteractionHintTypeBase::operator=>`   :oe:meth:`operator==<OEBio::OEInteractionHintTypeBase::operator==>` :oe:meth:`GetName<OEBio::OEInteractionHintTypeBase::GetName>`
   :oe:meth:`operator!=<OEBio::OEInteractionHintTypeBase::operator!=>` :oe:meth:`CreateCopy<OEBio::OEInteractionHintTypeBase::CreateCopy>` :oe:meth:`IsValid<OEBio::OEInteractionHintTypeBase::IsValid>`
   =================================================================== =================================================================== ===================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEStackingInteractionHint(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            OEStackingInteractionHint(type: int) -> OEStackingInteractionHint

      Creates an :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` object with the given type.

      *type*
         This value has to be from the :oe:constns:`OEBio::OEStackingInteractionHintType`
         namespace.

      .. note::

         Two :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` objects with different
         types from the :oe:constns:`OEBio::OEStackingInteractionHintType`
         namespace are considered to be different.

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

         .. oe:api::

            OEStackingInteractionHint(const OEStackingInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEStackingInteractionHint(rhs: OEStackingInteractionHint) -> OEStackingInteractionHint

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEStackingInteractionHint &operator=(const OEStackingInteractionHint &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintTypeBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintTypeBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEInteractionHintFragment *,
                         const OEInteractionHintFragment *) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHintFragment,
                    arg3: OEInteractionHintFragment) -> bool

      Evaluates whether the two given fragments would form a valid
      **stacking** interaction when added to an
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

      It checks that each fragment contains at least five atoms,
      and the fragments belong to different molecules *i.e.*
      it is an **intermolecular** interaction.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. _OEBio_OEStructureQuality:

.. oe:class:: OEStructureQuality

   .. attention::

      |TWOLANGUAGE|
   
   .. oe:api::

      class OEStructureQuality

   This is a container class that holds all data relating to the
   structural quality of biomolecular system.

   .. seealso::

      * :ref:`OEIridiumData <OEBio_OEIridiumData>` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OEStructureQuality()
            OEStructureQuality(const OEIridiumData& id)
            OEStructureQuality(const OEStructureQuality& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEStructureQuality() -> OEStructureQuality
            OEStructureQuality(id: OEIridiumData) -> OEStructureQuality
            OEStructureQuality(rhs: OEStructureQuality) -> OEStructureQuality

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEStructureQuality &operator=(const OEStructureQuality &rhs)

      Assignment operator.

   .. oe:method:: operator bool

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

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OEStructureQuality <OEBio_OEStructureQuality>` object is valid.

   .. oe:method:: Clear

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

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Resets the OEStructureQuality object to its initial state.

   .. oe:method:: GetIridiumData

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

         .. oe:api::

            OEIridiumData GetIridiumData()
            const OEIridiumData GetIridiumData() const

      .. oe:language:: python

         .. oe:api:: python

            GetIridiumData() -> OEIridiumData

      Returns a copy of the :ref:`OEIridiumData <OEBio_OEIridiumData>` object
      stored within the :ref:`OEStructureQuality <OEBio_OEStructureQuality>` object.

   .. oe:method:: HasIridiumData

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

         .. oe:api::

            bool HasIridiumData() const

      .. oe:language:: python

         .. oe:api:: python

            HasIridiumData() -> bool

      Checks that the :ref:`OEIridiumData <OEBio_OEIridiumData>` object has been set.

   .. oe:method:: SetIridiumData

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

         .. oe:api::

            bool SetIridiumData(const OEIridiumData& id)

      .. oe:language:: python

         .. oe:api:: python

            SetIridiumData(id: OEIridiumData) -> bool

      Sets the :ref:`OEIridiumData <OEBio_OEIridiumData>` object on the
      :ref:`OEStructureQuality <OEBio_OEStructureQuality>` object. Returns ``true`` if
      successful, and ``false`` otherwise.


.. oe:namespace:: OEBio

.. oe:constnamespace:: OEAltLocFactOption

   This namespace contains the following constants used as options to :oe:meth:`OEBio::OEAltLocationFactory::Constructors`:

   .. oe:constant:: None
   
      This constant indicates no options.

   .. oe:constant:: TrustInputBonds
   
      This constant indicates that any existing bonds in the input molecule can be used. 
      Missing bonds will still be perceived. Without this option, if any alternate location codes 
      are found in the input mol, any bonds found will be ignored.

      Since the basic bond perception mechanism will usually fail on a molecule that contains 
      alternative conformation atoms, this option should only be used when special care
      has been taken with the input molecule (for example, if the molecule comes from 
      :oe:meth:`OEBio::OEAltLocationFactory::GetSourceMol`).


.. oe:namespace:: OEBio

.. oe:constnamespace:: OEAssumption

   This namespace contains constants defining properties of molecules that can be assumed.

   .. oe:constant:: None
   
      No assumptions should be made.

   .. oe:constant:: PDBOrder
   
      Assume the molecules atoms are in standard PDB order.

   .. oe:constant:: BondedResidue
   
      Assume that residues in the molecule have all the residues atoms bonded to one another.

   .. oe:constant:: ResPerceived
   
      Assume that :oe:cls:`OEResidues<OEChem::OEResidue>` have been perceived.

   .. oe:constant:: Default
   
      Assume :oe:const:`PDBOrder<OEBio::OEAssumption::PDBOrder>` and
      :oe:const:`BondedResidue<OEBio::OEAssumption::BondedResidue>` and
      :oe:const:`ResPerceived<OEBio::OEAssumption::ResPerceived>`.


.. _OEBioConstants:

*******************
OEBio Constants
*******************

.. oe:namespace:: OEBio

.. toctree::

   OEAltLocFactOption
   OEAssumption
   OECationPiInteractionHintType
   OEChelatorInteractionHintType
   OEDesignUnitComponents
   OEDesignUnitFileType
   OEHalogenBondInteractionHintType
   OEHBondInteractionHintType
   OEIridiumCategory
   OEMakeAltMolOption
   OEMolComplexData
   OEMolComplexFilterCategory
   OEPlaceHydrogensMoverClass
   OEPlaceHydrogensWaterProcessing
   OEProteinConstraintType
   OEProtTorType
   OERamaCategory
   OERamaType
   OEResidueDatabaseCategory
   OERotamerLibrary
   OESaltBridgeInteractionHintType
   OESecondaryStructure
   OESeqAlignmentMethod
   OESplitMolComplexParam
   OESplitMolComplexSetup
   OEStackingInteractionHintType


.. oe:namespace:: OEBio

..  _oebio_oecationpiinteractionhinttype:

.. oe:constnamespace:: OECationPiInteractionHintType

   This namespace contains constants for the
   :ref:`OECationPiInteractionHintType <OEBio_OECationPiInteractionHintType>` interaction type.

   .. seealso::

      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` class
      * :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>` functor
      * :ref:`OEIsIntermolecularCationPiInteractionHint <OEBio_OEIsIntermolecularCationPiInteractionHint>` functor
      * :ref:`OEIsIntramolecularCationPiInteractionHint <OEBio_OEIsIntramolecularCationPiInteractionHint>` functor

   .. oe:constant:: LigandCation

      Same as the :oe:const:`OEBio::OECationPiInteractionHintType::ProteinPi`
      constant.

   .. oe:constant:: LigandPi

      This type of Cation Pi interaction has a ligand pi ring system interacting
      with a Lysine, N-methyl Lysine or Arginine of the protein.

   .. oe:constant:: ProteinCation

      Same as the :oe:const:`OEBio::OECationPiInteractionHintType::LigandPi`
      constant.

   .. oe:constant:: ProteinPi

      This type of Cation Pi interaction includes a protein pi ring system
      interacting with a Lysine-like or Arginine-like ligand cation.

   .. oe:constant:: IntramolecularLigand

      A cation-pi interaction with the :oe:const:`OEBio::OECationPiInteractionHintType::IntramolecularLigand`
      type represents an intramolecular cation-pi interaction between a cation
      and an aromatic ring within the **ligand**.

   .. oe:constant:: IntramolecularProtein

      A cation-pi interaction with the :oe:const:`OEBio::OECationPiInteractionHintType::IntramolecularProtein`
      type represents an intramolecular cation-pi interaction between a cation
      and an aromatic ring within the **protein**.



.. oe:namespace:: OEBio

..  _oebio_oechelatorinteractionhinttype:

.. oe:constnamespace:: OEChelatorInteractionHintType

   This namespace contains constants for the
   :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>` interaction type.

   .. seealso::

      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>` class
      * :ref:`OEIsChelatorInteractionHint <OEBio_OEIsChelatorInteractionHint>` functor

   .. oe:constant:: LigandChelates

      Chelation bonds with this type represent an interaction in which
      a ligand chelates a metal that is part of the protein.

   .. oe:constant:: ProteinChelates

      Chelation bonds with this type represent an interaction in which
      a protein chelates a metal that is part of the ligand.

   .. oe_constant  IntramolecularLigand DO NOT DOCUMENT NOT IS USE

   .. oe:constant:: IntramolecularProtein

      Chelation bonds with this type represent an interaction in which a
      protein chelates a metal (near the active site) that is part of
      the protein.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

..  _OEBio_OEDesignUnitComponents:

.. oe:constnamespace:: OEDesignUnitComponents

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants representing the various
   molecular types that can be stored within an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`, see :ref:`Storage Components<bio_du_components_storage>`.

   The namespace also lists some combined constants for convenient use in various general applications, 
   for example `TargetComplex`, see :ref:`Combined Components<bio_du_components_combined>`

   .. note:: When using these in command-line applications, the two word names in storage components below 
      need to have an underscore (`_`) between the words, e.g. `OtherNucleics` should
      be `other_nucleics`. When relevant these are noted below.

   .. _bio_du_components_combined:

Combined constants
==================

   .. oe:constant:: All

      All components.

   .. _OEBio_TargetComplex:

   .. oe:constant:: TargetComplex

      This is bit mask that combines the following, and is often used in modeling application
      :oe:const:`OEBio::OEDesignUnitComponents::Protein`,
      :oe:const:`OEBio::OEDesignUnitComponents::Nucleic`,
      :oe:const:`OEBio::OEDesignUnitComponents::Cofactors`,
      :oe:const:`OEBio::OEDesignUnitComponents::Solvent`,
      :oe:const:`OEBio::OEDesignUnitComponents::Metals`,
      :oe:const:`OEBio::OEDesignUnitComponents::CounterIons`,
      :oe:const:`OEBio::OEDesignUnitComponents::Lipids`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherProteins`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherNucleics`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherLigands`, and
      :oe:const:`OEBio::OEDesignUnitComponents::OtherCofactors`

   .. _OEBio_TargetComplexNoSolvent:

   .. oe:constant:: TargetComplexNoSolvent

      This is bit mask that combines the following, and is often used in modeling application
      :oe:const:`OEBio::OEDesignUnitComponents::Protein`,
      :oe:const:`OEBio::OEDesignUnitComponents::Nucleic`,
      :oe:const:`OEBio::OEDesignUnitComponents::Cofactors`,
      :oe:const:`OEBio::OEDesignUnitComponents::Metals`,
      :oe:const:`OEBio::OEDesignUnitComponents::Lipids`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherProteins`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherNucleics`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherLigands`, and
      :oe:const:`OEBio::OEDesignUnitComponents::OtherCofactors`

   .. oe:constant:: Default

      This is bit mask that combines
      :oe:const:`OEBio::OEDesignUnitComponents::Protein`,
      :oe:const:`OEBio::OEDesignUnitComponents::Nucleic`,
      :oe:const:`OEBio::OEDesignUnitComponents::Ligand`,
      :oe:const:`OEBio::OEDesignUnitComponents::Cofactors`,
      :oe:const:`OEBio::OEDesignUnitComponents::Solvent`,
      :oe:const:`OEBio::OEDesignUnitComponents::Metals`,
      :oe:const:`OEBio::OEDesignUnitComponents::CounterIons`, and
      :oe:const:`OEBio::OEDesignUnitComponents::Lipids`.

   .. oe:constant:: ListComponents

      This is a bit mask that combines
      :oe:const:`OEBio::OEDesignUnitComponents::Cofactors`,
      :oe:const:`OEBio::OEDesignUnitComponents::Excipients`,
      :oe:const:`OEBio::OEDesignUnitComponents::Sugars`,
      :oe:const:`OEBio::OEDesignUnitComponents::Polymers`,
      :oe:const:`OEBio::OEDesignUnitComponents::PostTranslational`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherProteins`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherNucleics`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherLigands`, and
      :oe:const:`OEBio::OEDesignUnitComponents::OtherCofactors`.

   .. oe:constant:: MacroMolComponents

      This is bit mask that combines
      :oe:const:`OEBio::OEDesignUnitComponents::Protein`,
      :oe:const:`OEBio::OEDesignUnitComponents::Nucleic`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherProteins`, and
      :oe:const:`OEBio::OEDesignUnitComponents::OtherNucleics`

   .. oe:constant:: MolComponents

      This is bit mask that combines
      :oe:const:`OEBio::OEDesignUnitComponents::Protein`,
      :oe:const:`OEBio::OEDesignUnitComponents::Nucleic`,
      :oe:const:`OEBio::OEDesignUnitComponents::Ligand`,
      :oe:const:`OEBio::OEDesignUnitComponents::Solvent`,
      :oe:const:`OEBio::OEDesignUnitComponents::Metals`,
      :oe:const:`OEBio::OEDesignUnitComponents::CounterIons`,
      :oe:const:`OEBio::OEDesignUnitComponents::Lipids`,
      :oe:const:`OEBio::OEDesignUnitComponents::PackingResidues`, and
      :oe:const:`OEBio::OEDesignUnitComponents::Undefined`

   .. _bio_du_components_storage:

Storage constants
==================

   .. oe:constant:: Cofactors

      Cofactors (*i.e.* any heterogen molecule) within a short distance to the active site.

   .. oe:constant:: CounterIons

      All counter ions.

      In command line use, please use `counter_ions`

   .. oe:constant:: Excipients

      All excipient molecules.

   .. oe:constant:: Ligand

      The ligand.

   .. oe:constant:: Lipids

      All lipid molecules.

   .. oe:constant:: Metals

      All system metals that are not cofactors.

   .. oe:constant:: Nucleic

      All nucleic acid molecules.

   .. oe:constant:: OtherCofactors

      Any non-primary cofactors.

      In command line use, please use `other_cofactors`

   .. oe:constant:: OtherLigands

      Any non-primary ligands (*i.e.* ligands not in the active site).

      In command line use, please use `other_ligands`

   .. oe:constant:: OtherNucleics

      Any non-primary nucleic acids.

      In command line use, please use `other_nucleics`

   .. oe:constant:: OtherProteins

      Any non-primary proteins.

      In command line use, please use `other_proteins`

   .. oe:constant:: PackingResidues

      All packing residue molecules.

      In command line use, please use `packing_residues`

   .. oe:constant:: Polymers

      All polymers, excluding typical biological polymers like DNA and proteins.

   .. oe:constant:: PostTranslational

      All components resulting from post-translation modifications (PTMs) that
      are not sugars or lipids.

      In command line use, please use `post_translational`

   .. oe:constant:: Protein

      The primary protein molecule.

   .. oe:constant:: Solvent

      All solvent molecules.

   .. oe:constant:: Sugars

      All sugar molecules.

   .. oe:constant:: Undefined

      Molecules that cannot be categorized by :oe:func:`OEBio::OEGetDesignUnitComponentID` are Undefined,
      an example would be residues specifically marked with residue name **UNK**.

   .. oe:constant:: Unknown

      Molecules cannot be stored using this constant. The constant exists to indicate invalid use of IDs
      or string versions of the namespace.

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:constnamespace:: OEDesignUnitFileType

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants representing the various file
   types that can be read with :oe:meth:`OEBio::OEReadDesignUnit`.

   .. oe:constant:: OEDesignUnit

      An OEDesignUnit file (.oedu) will be read as an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.

   .. oe:constant:: Undefined

      The file type is undefined.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

..  _oebio_oehbondinteractionhinttype:

.. oe:constnamespace:: OEHBondInteractionHintType

   This namespace contains constants for the
   :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` interaction type.

   .. seealso::

      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` class
      * :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` functor

   .. oe:constant:: ClashAcceptorAcceptor

      A hydrogen bond with the
      :oe:const:`OEBio::OEHBondInteractionHintType::ClashAcceptorAcceptor` type
      represents a clashing interaction between a ligand acceptor atom and a
      protein acceptor atom.

   .. oe:constant:: ClashDonorDonor

      A hydrogen bond with the
      :oe:const:`OEBio::OEHBondInteractionHintType::ClashDonorDonor` type
      represents a clashing interaction between a ligand donor atom and a
      protein donor atom.

   .. oe:constant:: Clash

      .. warning::

         |DEPRECATED-API|
         Please use
         :oe:const:`OEBio::OEHBondInteractionHintType::ClashAcceptorAcceptor`
         or
         :oe:const:`OEBio::OEHBondInteractionHintType::ClashDonorDonor`
         instead.

   .. oe:constant:: IntramolecularLigand

      A hydrogen bond with the
      :oe:const:`OEBio::OEHBondInteractionHintType::LigandAccepts` type
      represents an interaction between a donor and acceptor on the ligand
      component.

   .. oe:constant:: IntramolecularProtein

      A hydrogen bond with the
      :oe:const:`OEBio::OEHBondInteractionHintType::ProteinAccepts` type
      represents an interaction between a donor and acceptor on the protein
      component.

   .. oe:constant:: LigandAccepts

      A hydrogen bond interaction with the
      :oe:const:`OEBio::OEHBondInteractionHintType::LigandAccepts`
      type represents an interaction where the ligand component of an
      active site accepts a proton donated by the protein component of
      the active site.

   .. oe:constant:: LigandDonates

      A hydrogen bond interaction with the
      :oe:const:`OEBio::OEHBondInteractionHintType::LigandDonates`
      type represents an interaction where the ligand component of an
      active site donates a proton accepted by the protein component of
      the active site.

   ..  _oebio_oehbondinteractionhinttype_NonIdealLigandAccepts:

   .. oe:constant:: NonIdealLigandAccepts

      A hydrogen bond interaction with the
      :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandAccepts`
      type represents an interaction where the bond between the ligand
      component and a proton donated by the protein component is not ideal.

   ..  _oebio_oehbondinteractionhinttype_NonIdealLigandDonates:

   .. oe:constant:: NonIdealLigandDonates

      A hydrogen bond interaction with the
      :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandDonates`
      type represents an interaction where the bond between the ligand component
      and a proton accepted by the protein component is not ideal.

   .. oe:constant:: NonIdealProteinAccepts

      Same as the :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandDonates`
      constant.

   .. oe:constant:: NonIdealProteinDonates

      Same as the :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandAccepts`
      constant.

   .. oe:constant:: ProteinAccepts

      Same as the :oe:const:`OEBio::OEHBondInteractionHintType::LigandDonates`
      constant.

   .. oe:constant:: ProteinDonates

      Same as the :oe:const:`OEBio::OEHBondInteractionHintType::LigandAccepts`
      constant.

   .. oe:constant:: UnpairedLigandDonor

      A interaction with the
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandDonor` type
      represents a donor on the ligand component that has no paired acceptor.

   .. oe:constant:: UnpairedLigandAcceptor

      A interaction with the
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandAcceptor` type
      represents an acceptor on the ligand component that has no paired donor.

   .. oe:constant:: UnpairedProteinDonor

      A interaction with the
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinDonor` type
      represents a donor on the protein component that has no paired acceptor.

   .. oe:constant:: UnpairedProteinAcceptor

      A interaction with the
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinAcceptor`
      type represents an acceptor on the protein component that has no
      paired donor.


.. oe:namespace:: OEBio

..  _oebio_oehalogenbondinteractionhinttype:

.. oe:constnamespace:: OEHalogenBondInteractionHintType

   This namespace contains constants for the
   :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` interaction type.

   .. seealso::

      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` class
      * :ref:`OEIsHalogenBondInteractionHint <OEBio_OEIsHalogenBondInteractionHint>` functor
      * :ref:`OEIsIntermolecularHalogenBondInteractionHint <OEBio_OEIsIntermolecularHalogenBondInteractionHint>` functor
      * :ref:`OEIsIntramolecularHalogenBondInteractionHint <OEBio_OEIsIntramolecularHalogenBondInteractionHint>` functor

   .. oe:constant:: LigandElectrophile

      A halogen bond with the :oe:const:`OEBio::OEHalogenBondInteractionHintType::LigandElectrophile` type
      represents an interaction between a Chlorine, Bromine or Iodine on the protein and an electrophile on
      the ligand.

   .. oe:constant:: LigandNucleophile

      A halogen bond with the :oe:const:`OEBio::OEHalogenBondInteractionHintType::LigandNucleophile` type
      represents an interaction between a Chlorine, Bromine or Iodine on the protein and a nucleophile on
      the ligand.

   .. oe:constant:: ProteinElectrophile

      A halogen bond with the :oe:const:`OEBio::OEHalogenBondInteractionHintType::ProteinElectrophile` type
      represents an interaction between a Chlorine, Bromine or Iodine on the ligand and an electrophile on
      the protein.

   .. oe:constant:: ProteinNucleophile

      A halogen bond with the :oe:const:`OEBio::OEHalogenBondInteractionHintType::ProteinNucleophile` type
      represents an interaction between a Chlorine, Bromine or Iodine on the ligand and a nucleophile on
      the protein.

   .. oe:constant:: IntramolecularLigand

      A halogen bond with the :oe:const:`OEBio::OEHalogenBondInteractionHintType::IntramolecularLigand`
      type represents an intramolecular halogen bond between a halogen and an
      acceptor within the **ligand**.

   .. oe:constant:: IntramolecularProtein

      A halogen bond with the :oe:const:`OEBio::OEHalogenBondInteractionHintType::IntramolecularProtein`
      type represents an intramolecular halogen bond between a halogen and an
      acceptor within the **protein**.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:constnamespace:: OEIridiumCategory

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants that represent the Iridium
   classification. These classifications were taken from the 2012
   paper by Warren *et al.*, which describes the Iridium scoring
   methodology, and includes a database of structures to be used in
   validation of structure-based drug discovery tools [Warren-2012]_.

   .. oe:constant:: HT

   The structure is highly trustworthy.

   .. oe:constant:: MT

   The structure is mildly trustworthy.

   .. oe:constant:: NA

   Not applicable -- no Iridium category has been assigned.

   .. oe:constant:: NT

   The structure is not trustworthy.

   .. seealso::

      * :oe:func:`OEBio::OEGetIridiumCategoryName` function
      * :oe:func:`OEBio::OEGetIridiumCategoryFromName` function
      * :ref:`section_sprucetk_iridium_categorization` section in **OESpruce TK**


.. oe:namespace:: OEBio

.. oe:constnamespace:: OEMakeAltMolOption

   This namespace contains the following constants used as options to one of the
   :oe:meth:`OEBio::OEAltLocationFactory::MakePrimaryAltMol`,
   :oe:meth:`OEBio::OEAltLocationFactory::MakeCurrentAltMol`, or
   :oe:meth:`OEBio::OEAltLocationFactory::MakeAltMol` methods:

   .. oe:constant:: None
   
      This constant indicates no options.

   .. oe:constant:: RemoveAltCodes
   
      This constant indicates that all alternate location codes should be set to blank
      in the new subset molecule.



.. oe:namespace:: OEBio

.. oe:constnamespace:: OEMolComplexData

   This namespace contains the following SD tags attached to
   components returned by
   :oe:func:`OEBio::OEGetMolComplexComponents` specifying
   various properties. Any other roles a component is associated with
   are also be assigned SD tags (with a value of ``true``).
   These SD tags can be removed with the function
   :oe:func:`OEBio::OEClearMolComplexSDData`.

   .. oe:constant:: CovalentSDTag

      Identifies a covalent ligand or cofactor.

   .. oe:constant:: CovalentLigandSDTag

      Alias for :oe:const:`CovalentSDTag<OEBio::OEMolComplexData::CovalentSDTag>`
      for backward compatibility.

   .. oe:constant:: PartOrderSDTag
   
      The sequence number of the molecular component in the order it was identified in the source molecule.

   .. oe:constant:: SDTagPrefix

      Prefix for all SD tags used when splitting molecular complexes.

   .. oe:constant:: SiteNumberSDTag

      The component is associated with at least one binding site. The value is the sequence number of the binding site(s).

   .. oe:constant:: SurfaceWatersNumberSDTag

      The component is a surface water. The value is the sequence number of the associated binding site(s).

   .. seealso::

      * :oe:func:`OEBio::OEGetMolComplexComponents` function
      * :oe:func:`OEBio::OEClearMolComplexSDData` function


.. oe:namespace:: OEBio

.. oe:constnamespace:: OEMolComplexFilterCategory

   This namespace contains constants used as parameters to
   :oe:func:`OEBio::OEMolComplexRoleFactory`,
   :oe:func:`OEBio::OEGetMolComplexFilterCategoryName`,
   :oe:func:`OEBio::OEMolComplexFilterFactory`, and
   :oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters`.
   These constants refer to functional roles that may be associated
   with a component by :oe:func:`OEBio::OESplitMolComplex` or
   :oe:func:`OEBio::OEGetMolComplexComponents` and are
   used to construct filters (see :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>`)
   that select a desired subset of components. The class
   :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` manages several of
   these filters; others can be generated as required.

   .. oe:constant:: Anything

      Match anything.

   .. oe:constant:: ChainA

      Match any component in chain 'A'.

      Filters for other chains may be build by combining
      :oe:func:`OEBio::OEMolComplexChainRoleFactory`
      with :oe:func:`OEBio::OERoleMolComplexFilterFactory`.

   .. oe:constant:: Cofactor

      Match any component identified as a cofactor.

   .. oe:constant:: CofactorAndLigand

      Match any component in a special category for items
      that are either a cofactor or a ligand if no ligand is otherwise found.

   .. oe:constant:: CounterIon

      Match any counter-ion (either a first-row metal or an halogen).

   .. oe:constant:: Covalent

      Match any component identified as a covalent ligand.

   .. oe:constant:: DNA_RNA

      Match any DNA or RNA molecule.

   .. oe:constant:: Ligand

      Match any ligand.

   .. oe:constant:: Lipid

      Match any lipids.

   .. oe:constant:: Metal

      Match any metal.

   .. oe:constant:: Misc

      Component has been identified as miscellaneous.
      These are otherwise unclassified compounds that
      are not to be considered ligands
      (for example buffers and excipients).

   .. oe:constant:: Model1

      Match any component in model number 1
      (the default if model information is not explicitly specified).

      Filters for other chains may be build by combining
      :oe:func:`OEBio::OEMolComplexModelRoleFactory`
      with :oe:func:`OEBio::OERoleMolComplexFilterFactory`.

   .. oe:constant:: Nothing

      Match nothing.

   .. oe:constant:: Nucleotide

      Match any nucleotide.

   .. oe:constant:: Peptide

      Match any poly-peptide.

   .. oe:constant:: ProtComplex

      Match any component identified as being part of the protein complex (protein + cofactor).

   .. oe:constant:: Protein

      Match any protein chain.

   .. oe:constant:: Saccharide

      Match any component identified as a sugar.

   .. oe:constant:: Site1

      Match any component identified as being part of binding site 1.

      Filters for other chains may be build by combining
      :oe:func:`OEBio::OEMolComplexSiteRoleFactory`
      with :oe:func:`OEBio::OERoleMolComplexFilterFactory`.

   .. oe:constant:: Solution

      Match any component identified as being part of the solution (water + counter-ion).

   .. oe:constant:: SurfaceWaters1

      Match any surface waters identified as being part of binding site 1.

      Filters for other chains may be build by combining
      :oe:func:`OEBio::OEMolComplexSurfaceWatersRoleFactory`
      with :oe:func:`OEBio::OERoleMolComplexFilterFactory`.

   .. oe:constant:: Underdefined

      Match any component containing a dummy atom (:oe:const:`OEChem::OEElemNo::Du`).

   .. oe:constant:: Unknown

      Match any component that would have been identified as a ligand but has a
      residue name that differs from that explicitly specified.

   .. oe:constant:: Water

      Match any water molecule.



.. oe:namespace:: OEBio

..  _oebio_oeplacehydrogensmoverclass:

.. oe:constnamespace:: OEPlaceHydrogensMoverClass

   This namespace contains constants used by the
   :ref:`OEPlaceHydrogensMoverNote <OEBio_OEPlaceHydrogensMoverNote>`
   class to describe each "mover" (movable functional group processed by
   :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`).

   .. oe:constant:: AmideNO

      Terminal amide group, as in asparagine or glutamine (flippable).

   .. oe:constant:: AroN

      Aromatic nitrogen other than an imidazole,
      deprotonated when coordinating a metal.

   .. oe:constant:: AroCH3

      Aromatic methyl group. Has two rotational states,
      always placing one methyl hydrogen in the ring plane.

   .. oe:constant:: Background

      Collection of non-moving atoms surrounding another mover. For waters,
      other movers are treated as background.

   .. oe:constant:: COOH

      Protonated carboxylic acid (or analog). Hydrogen is rotated and group flipped.

   .. oe:constant:: DH

      Donor with rotatable hydrogen, as in serene, theonine, tyrosine,
      cysteine, or ribose. Rotational states based on interactions with nearby
      hydrogen bond donors and acceptors.

   .. oe:constant:: Imidazole

      Imidazole group, as in histidine (maximum of six states:
      two flip states times three protonation states HD1, HE2,
      and plus (+) charged with both HD1 & HE2). If between two metals,
      can instead be doubly deprotonated with a negative (-) charge.

   .. oe:constant:: Max

      The total number of different mover classes.

   .. oe:constant:: N

      Non-aromatic nitrogen deprotonated when coordinating a metal.

   .. oe:constant:: NHsp2Only

      Secondary amine with a sp2 geometry.

   .. oe:constant:: NHsp3Only

      Secondary amine with a sp3 geometry.

   .. oe:constant:: NHsp2sp3

      Secondary amine with a hybrid sp2/2p3 geometry.

   .. oe:constant:: NH2

      Neutral amine in aniline analog (pyramidal, six H2 orientations).

   .. oe:constant:: NH3

      Ionized primary amine, as in lysine (rotates).

   .. oe:constant:: SCH3

      Methyl attached to a sulfur, as in methionine (low rotational barrier,
      high number of orientations sampled).

   .. oe:constant:: Water

      Water or hydrogen sulfide, a water analog
      (each can have many orientation states). Waters are not included in
      mover clusters to avoid combinatorial explosion, instead they
      are optimized after other movers.

   .. seealso::

      * :ref:`section_place_hydrogens` section
      * :oe:func:`OEBio::OEPlaceHydrogens` function
      * :ref:`OEPlaceHydrogensDetails <OEBio_OEPlaceHydrogensDetails>` class
      * :ref:`OEPlaceHydrogensMoverNote <OEBio_OEPlaceHydrogensMoverNote>` class


.. oe:namespace:: OEBio

.. oe:constnamespace:: OEPlaceHydrogensWaterProcessing

   This namespace contains constants used by the
   :oe:meth:`SetWaterProcessing<OEBio::OEPlaceHydrogensOptions::SetWaterProcessing>`
   and
   :oe:meth:`GetWaterProcessing<OEBio::OEPlaceHydrogensOptions::GetWaterProcessing>`
   methods of :ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>` to control how waters
   (and H2S molecules) are processed by :oe:func:`OEBio::OEPlaceHydrogens`.

   .. oe:constant:: Default

      Same as :oe:const:`FullSearch<OEBio::OEPlaceHydrogensWaterProcessing::FullSearch>`.

   .. oe:constant:: Focused

      Sample water orientations with respect to nearby donors and acceptors
      (in all combinations: A, D, A/A, D/D, A/D).

   .. oe:constant:: FullSearch

      Same as :oe:const:`Focused<OEBio::OEPlaceHydrogensWaterProcessing::Focused>`
      but with two additional equilibration passes over the waters.

   .. oe:constant:: Ignore

      Do not sample more than one orientation for each water molecule.

   .. seealso::

      * :ref:`section_place_hydrogens` section
      * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetWaterProcessing` method
      * :oe:func:`OEBio::OEPlaceHydrogens` function


.. oe:namespace:: OEBio

.. oe:constnamespace:: OEProtTorType

   This namespace contains constants for specifying torsion angles.

   .. oe:constant:: Unknown
   
      Unknown torsion.

   .. oe:constant:: Phi
   
      The protein backbone :math:`\phi` dihedral angle between C(n-1)--N--CA--C(O) atoms.

   .. oe:constant:: Psi
   
      The protein backbone :math:`\psi` dihedral angle between N--CA--C(O)--N(n+1) atoms.

   .. oe:constant:: Omega
   
      The :math:`\omega` dihedral angle across the peptide bond, between CA--C(O)--N(n+1)--CA(n+1) atoms.

   .. oe:constant:: Chi1
   
      The protein sidechain :math:`\chi_1` dihedral angle between N--CA--CB--XG(1) atoms.

   .. oe:constant:: Chi2
   
      The protein sidechain :math:`\chi_2` dihedral angle between CA--CB--XG(1)--XD(1) atoms.

   .. oe:constant:: Chi3
   
      The protein sidechain :math:`\chi_3` dihedral angle between CB--XG--XD--XE(1) atoms.

   .. oe:constant:: Chi4
   
      The protein sidechain :math:`\chi_4` dihedral angle between CG--XD--XE--XZ atoms.

   .. oe:constant:: Chi5
   
      The protein sidechain :math:`\chi_5` dihedral angle between CD--XE--XZ--XH(1) atoms.

   .. oe:constant:: Max
   
      Total number of measurable protein dihedral angles (with indices: 0 .. Max-1)


.. oe:namespace:: OEBio

.. _OEBio_OEProteinConstraintType:

.. oe:constnamespace:: OEProteinConstraintType

   Constants in this namespace are used by the
   :ref:`OEReceptorProteinConstraint <OEBio_OEReceptorProteinConstraint>` class
   to specify the type
   of ligand atom that is allowed to satisfy a protein docking
   constraint.

   .. oe:constant:: Chelator

      A chelating heavy atom on the ligand must interact
      with the protein metal constraint atom to satisfy
      the constraint.

   .. oe:constant:: Acceptor

      A hydrogen bond acceptor on the ligand must interact with
      the protein donor to satisfy the constraint.

   .. oe:constant:: Donor

      A hydrogen bond donor on the ligand must interact with
      the protein acceptor to satisfy the constraint.

   .. oe:constant:: Contact

      A heavy atom on the ligand must contact the protein
      constraint atom to satisfy the constraint.

   .. oe:constant:: Lipophilic

      A non-polar heavy atom on the ligand must contact the protein

   .. oe:constant:: Unknown

      Unknown constraint type.  Most likely this receptor
      was written by a future version of this toolkit or FRED.



.. oe:namespace:: OEBio

.. oe:constnamespace:: OERamaCategory

   This namespace contains constants used to indicate which region of the
   Ramachandran plot a residue is in.

   .. seealso:: 

      * :oe:func:`OEBio::OEGetRamachandranCategoryName` function
      * :ref:`OERamachandranAnalysis <OEBio_OERamachandranAnalysis>` class
      * :oe:constns:`OEBio::OERamaType` namespace

   .. oe:constant:: Favored

      Residue is in the favored region.

   .. oe:constant:: Allowed

      Residue is in the allowed region.

   .. oe:constant:: Outlier

      Residue is an outlier.

   .. oe:constant:: Unknown

      Data for the residue cannot be calculated.


.. oe:namespace:: OEBio

.. oe:constnamespace:: OERamaType

    This namespace contains constants for specifying Ramachandran data for different amino acid residue types.

    .. note::

       The hierarchy used to determine the residue type is:
       :oe:const:`Glycine<OEBio::OERamaType::Glycine>` >
       :oe:const:`Isoleucine/Valine<OEBio::OERamaType::IleVal>` >
       :oe:const:`pre-Proline<OEBio::OERamaType::PrePro>` >  :oe:const:`Cis/Trans Proline<OEBio::OERamaType::TransPro>` >
       :oe:const:`General<OEBio::OERamaType::General>`,
       as defined by [Chen-2010]_.

    .. seealso:: 

       * :oe:func:`OEBio::OEGetRamachandranTypeName` function
       * :ref:`OERamachandranAnalysis <OEBio_OERamachandranAnalysis>` class
       * :oe:constns:`OEBio::OERamaCategory` namespace

    .. oe:constant:: General

       The general residue type, meaning standard residues not captured by the below types.

    .. oe:constant:: Glycine

       The data used for the Glycine residues

    .. oe:constant:: CisPro

       The data used for the cis-Proline residues

    .. oe:constant:: TransPro

       The data used for the trans-Proline residues

    .. oe:constant:: PrePro

       The data used for a residue just prior to Proline in the protein chain, except Glycine, Isoleucine and Valine

    .. oe:constant:: IleVal

       The data used for Isoleucine and Valine residues

    .. oe:constant:: Unknown

       Unknown residue type, or the dihedral angles used to determine the type cannot be measured, e.g. for terminal residues.


.. oe:namespace:: OEBio

.. oe:constnamespace:: OEResidueDatabaseCategory

   This namespace contains the following constants used as parameters to
   :ref:`OEResidueCategoryData <OEBio_OEResidueCategoryData>` methods and
   :oe:func:`OEBio::OEGetResidueDatabaseCategoryName`.  These constants refer to
   lists of residue names for various components found in a
   macromolecular complex. One of the key uses of these lists is to identify
   molecules that are *not* ligands, so that ligands may be recognized more easily.

   .. oe:constant:: AminoAcid

      Standard amino acid and common variants such as *hydroxy-proline*.

   .. oe:constant:: Cofactor

      Cofactors, such as *heme* or *flavin adenine dinucleotide*.

   .. oe:constant:: CofactorAndLigand

      Compounds such as *ATP* that frequently act as a cofactor
      in some contexts and a ligand in another.

   .. oe:constant:: Ligand

      Ligand. If the list associated with this category is populated,
      only ligands with one of the listed residue names will be recognized as such.

   .. oe:constant:: Lipid

      Lipids.

   .. oe:constant:: Max

      Total number of categories.

   .. oe:constant:: Metal

      Metals.

   .. oe:constant:: Misc

      Otherwise unclassified compounds that are not to be considered ligands
      (such as buffers or excipients).

   .. oe:constant:: NucleicAcid

      Nucleic acids.

   .. oe:constant:: Polymer

      Polymer residues.

   .. oe:constant:: Saccharide

      Sugars.



.. oe:namespace:: OEBio

.. oe:constnamespace:: OERotamerLibrary

   This namespace contains constants for selecting sidechain rotamer libraries.

   .. seealso::

      * :ref:`OERotamer <OEBio_OERotamer>` class
      * :oe:func:`OEBio::OEGetRotamers` function

   .. oe:constant:: Default

      The default rotamer library type is
      :oe:const:`OEBio::OERotamerLibrary::Richardson_2016`.

   .. oe:constant:: Dunbrack
   
      Uses rotamers from a backbone-dependent rotamer library [Dunbrack-1997]_ obtained from
      a Bayesian statistical analysis of high-resolution crystal structures.

   .. oe:constant:: Richardson
   
      Use rotamers from the "penultimate rotamer library" [Lovell-2000]_ obtained from
      high-resolution crystal structures, filtered to remove clashes and residues with high-temperature factors.

   .. oe:constant:: Richardson_2016

      Use rotamers from the “ultimate rotamer library” [Hintze-2016]_ obtained using a diverse high quality crystal 
      structure dataset with associated structure factors. The structures were filtered more stringently than the 
      original Richardson [Lovell-2000]_ and quality measures were performed on a per residue basis.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

..  _oebio_oesaltbridgeinteractionhinttype:

.. oe:constnamespace:: OESaltBridgeInteractionHintType

   This namespace contains constants for the
   :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>` interaction type.

   .. seealso::

      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>` functor

   .. oe:constant: Clash CURRENTLY NOT USED

   .. oe:constant:: LigandNegative

      A salt-bridge interaction with the :oe:const:`OEBio::OESaltBridgeInteractionHintType::LigandNegative`
      type represents an interaction where the 'ligand' component of an active site has **negative**
      charge and the 'protein' component of an active site has **positive** charge.

   .. oe:constant:: LigandPositive

      A salt-bridge interaction with the :oe:const:`OEBio::OESaltBridgeInteractionHintType::LigandPositive`
      type represents an interaction where the 'ligand' component of an active site has **positive**
      charge and the 'protein' component of an active site has **negative** charge.

   .. oe:constant:: ProteinNegative

      Same as the :oe:const:`OEBio::OESaltBridgeInteractionHintType::LigandPositive` constant.

   .. oe:constant:: ProteinPositive

      Same as the :oe:const:`OEBio::OESaltBridgeInteractionHintType::LigandNegative` constant.

   .. oe:constant:: UnpairedLigand

      .. warning::

         |DEPRECATED-API|
         Please use :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedLigandPositive` or
         :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedLigandNegative` instead.

   .. oe:constant:: UnpairedLigandPositive

      A **positively** charged ligand atom or group near the protein without a significant 
      interaction with the protein.

   .. oe:constant:: UnpairedLigandNegative

      A **negatively** charged ligand atom or group near the protein without a significant 
      interaction with the protein.

   .. oe:constant:: UnpairedProtein

      .. warning::

         |DEPRECATED-API|
         Please use :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedProteinPositive` or
         :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedProteinNegative` instead.

   .. oe:constant:: UnpairedProteinPositive

      A **positively** charged protein atom or group near the ligand without a significant 
      interaction with the ligand.

   .. oe:constant:: UnpairedProteinNegative

      A **negatively** charged protein atom or group near the ligand without a significant 
      interaction with the ligand.

   .. oe:constant:: IntramolecularLigand

      An intramolecular ligand saltbridge.

   .. oe:constant:: IntramolecularProtein

      An intramolecular protein saltbridge.



.. oe:namespace:: OEBio

.. oe:constnamespace:: OESecondaryStructure

   This namespace contains the following constants used as options to 
   :ref:`OEHasSecondaryStructure <OEBio_OEHasSecondaryStructure>` and as return values from
   :oe:func:`OEBio::OEGetSecondaryStructureType`.  These constants represent
   sets of bits, and in some cases can be OR'ed together, for example, to 
   designate left-handed alpha helix.

   .. oe:constant:: Unassigned
   
      This indicates secondary structure which is unassigned or unknown.

   .. oe:constant:: Helix
   
      This indicates any type of helix.

   .. oe:constant:: Helix310
   
      This indicates a 3-10 helix.

   .. oe:constant:: HelixAlpha
   
      This indicates an alpha helix.

   .. oe:constant:: HelixPi
   
      This indicates a pi helix.

   .. oe:constant:: Turn
   
      This indicates any type of turn.

   .. oe:constant:: Turn3
   
      This indicates a 3-residue turn.

   .. oe:constant:: Turn4
   
      This indicates a 4-residue turn.

   .. oe:constant:: Turn5
   
      This indicates a 5-residue turn.

   .. oe:constant:: Sheet
   
      This indicates a beta sheet.

   .. oe:constant:: StrandSense
   
      This bit indicates a strand that is antiparallel to an adjacent strand in
      a beta sheet.  Since strands can be simultaneously parallel and 
      antiparallel to other strands in a sheet, this isn't an absolute
      indicator of a strand's direction.  It is useful in some visualization
      programs to visually illustrate antiparallel character of beta sheets.
      
   .. oe:constant:: HelixLeft

      This bit indicates left-handedness of a helix.  For example, a 
      left-handed alpha helix would have a value of HelixAlpha | HelixLeft.

   .. oe:constant:: Any

      This will match any assigned values for secondary structure when used
      as an option to :ref:`OEHasSecondaryStructure <OEBio_OEHasSecondaryStructure>`.



.. oe:namespace:: OEBio

.. oe:constnamespace:: OESeqAlignmentMethod

   This namespace contains constants for selecting protein sequence alignment distance matrices.

   .. oe:constant:: None
   
      Do not use a protein alignment distance matrix.

   .. oe:constant:: Identity
   
      Use an identity matrix for protein alignment distance calculation (+1 if residue type is identical, otherwise 0).

   .. oe:constant:: PAM250
   
      Use the PAM250 protein alignment distance matrix [Dayhoff-1978]_. This matrix uses weights derived from
      an estimate of evolutionary substitution rates from a database of 71 groups of closely related, mostly
      globular proteins, with an evolutionary distance of 250 substitutions per hundred residues.
      This matrix is is best used when aligning similar proteins.

   .. oe:constant:: BLOSUM62
   
      Use the Blosum62 protein alignment distance matrix [Henikoff-1992]_. This matrix uses weights derived from
      alignable regions from the BLOCS database for distantly related proteins.

   .. oe:constant:: GONNET
   
      Use the Gonnet protein alignment distance matrix [Gonnet-1992]_. This matrix uses weights derived from
      exhaustive pairwise alignments of the protein sequence databases. This matrix is useful for alignments
      proteins of varying similarity.



.. oe:namespace:: OEBio

.. oe:constnamespace:: OESplitMolComplexParam

   This namespace defines constants used with
   :oe:func:`OEBio::OESetupSplitMolComplexOptions`.

   .. oe:constant:: DoNotOverride

      Indicates that this parameter should *not* override the value defined
      by the input :ref:`OEInterface <OESystem_OEInterface>` object.


.. oe:namespace:: OEBio

.. oe:constnamespace:: OESplitMolComplexSetup

   This namespace encodes symbolic constants used as bit-masks to
   indicate which parameters are created when the
   :oe:func:`OEBio::OEConfigureSplitMolComplexOptions`
   function is called to configure command-line options.

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEBio::OESplitMolComplexSetup::CovBondTreatment`
      * :oe:const:`OEBio::OESplitMolComplexSetup::CovCofactor`
      * :oe:const:`OEBio::OESplitMolComplexSetup::CovLig`
      * :oe:const:`OEBio::OESplitMolComplexSetup::LigFilter`
      * :oe:const:`OEBio::OESplitMolComplexSetup::LigName`
      * :oe:const:`OEBio::OESplitMolComplexSetup::MaxSiteDist`
      * :oe:const:`OEBio::OESplitMolComplexSetup::MaxSurfDist`
      * :oe:const:`OEBio::OESplitMolComplexSetup::ModelNum`
      * :oe:const:`OEBio::OESplitMolComplexSetup::ProtFilter`
      * :oe:const:`OEBio::OESplitMolComplexSetup::SeparateRes`
      * :oe:const:`OEBio::OESplitMolComplexSetup::SiteNum`
      * :oe:const:`OEBio::OESplitMolComplexSetup::SurfWat`
      * :oe:const:`OEBio::OESplitMolComplexSetup::WatFilter`

   .. oe:constant:: CovBondTreatment

      Passing this constant to the
      :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function results
      in generating the following default interface to configure
      the splitting of covalent ligand bonds
      by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents`.

      ::

         Contents of parameter -covalentbondtreatment
             Type : string
             Allow list : false
             Default : hydrogen
             Simple : false
             Required : false
             Legal values : hydrogen rgroup none
             Brief : Covalent bond treatment
             Detail
                 Add hydrogens, add Rgroups or do nothing when a covalent bond is broken

      .. seealso::

         * :oe:meth:`OEBio::OESplitMolComplexOptions::SetAdjustHCount` method
         * :oe:meth:`OEBio::OESplitMolComplexOptions::SetAddRGroup` method

   .. oe:constant:: CovCofactor

      Passing this constant to the
      :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function results
      in generating the following default interface to configure
      the treatment of covalent cofactors
      by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents`.

      ::

         Contents of parameter -covalentcofactor
             Aliases : -covcofact
             Type : bool
             Allow list : false
             Default : false
             Simple : false
             Required : false
             Brief : Split covalent cofactors
             Detail
                 Identify and separate covalently bound cofactors

      .. seealso::

         * :oe:meth:`OEBio::OESplitMolComplexOptions::SetSplitCovalentCofactors` method

   .. oe:constant:: CovLig

      Passing this constant to the
      :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function results
      in generating the following default interface to configure
      the treatment of covalent ligands
      by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents`.

      ::

         Contents of parameter -covalentligand
             Aliases : -covlig
             Type : bool
             Allow list : false
             Default : false
             Simple : true
             Required : false
             Brief : Split covalent ligands
             Detail
                 Identify and separate covalently bound ligands

      .. seealso::

         * :oe:meth:`OEBio::OESplitMolComplexOptions::SetSplitCovalent` method

   .. oe:constant:: LigFilter

      Passing this constant to the
      :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function results
      in generating the following default interface to configure
      the ligand filter used
      by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents`.

      ::

         Contents of parameter -ligandfilter
             Type : string
             Allow list : false
             Default : ligand
             Simple : false
             Required : false
             Legal values : protein ligand water saccharide cofactor cofactor_and_ligand
                            metal counter_ion prot_complex peptide dna_rna nucleotide
                            covalent solution misc unknown
                            underdefined site1 surface_waters1 model1 chainA anything nothing
             Brief : Ligand filter category
             Detail
                 Return molecules from this category as the ligand

      .. seealso::

         * :oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters` method
         * :oe:meth:`OEBio::OESplitMolComplexOptions::SetLigandFilter` method

   .. oe:constant:: LigName

      Passing this constant to the
      :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function results
      in generating the following default interface to configure
      the identification of ligands
      by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents`.

      ::

         Contents of parameter -ligandname
             Aliases : -ligname
             Type : string
             Allow list : false
             Default : (parameter does not have a default)
             Simple : true
             Required : false
             Brief : Ligand name
             Detail
                 Select ligand having this residue name

      .. seealso::

         * :oe:meth:`OEBio::OESplitMolComplexOptions::Constructors`

   .. oe:constant:: MaxSiteDist

      Passing this constant to the
      :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function results
      in generating the following default interface to configure
      the identification of binding sites
      by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents`.

      ::

         Contents of parameter -maxsitedistance
             Type : double
             Allow list : false
             Default : 8.0
             Simple : false
             Required : false
             Legal ranges :
                 9999.9 to 1.0
             Brief : Maximum distance to be associated with the binding site

      .. seealso::

         * :oe:meth:`OEBio::OESplitMolComplexOptions::SetMaxBindingSiteDist` method

   .. oe:constant:: MaxSurfDist

      Passing this constant to the
      :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function results
      in generating the following default interface to configure
      the identification of surface waters
      by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents`.

      ::

         Contents of parameter -maxsurfacedistance
             Type : double
             Allow list : false
             Default : 5.0
             Simple : false
             Required : false
             Legal ranges :
                 9999.9 to 1.0
             Brief : Maximum distance to be associated with the protein surface
             Detail
                 Used when surface waters are selected

      .. seealso::

         * :oe:meth:`OEBio::OESplitMolComplexOptions::SetMaxSurfaceWaterDist` method

   .. oe:constant:: ModelNum

      Passing this constant to the
      :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function results
      in generating the following default interface to configure
      the selection filters used
      by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents`.

      ::

         Contents of parameter -modelnum
             Type : unsigned
             Allow list : false
             Default : 1
             Simple : false
             Required : false
             Legal ranges :
                 999 to 0
             Brief : Select this NMR model number
             Detail
                 Molecules that are not marked as models are treated as model 1.
                 Model 0 selects all models.

      .. note::

         It may be necessary to remove the input flavor
         :oe:const:`OEChem::OEIFlavor::PDB::ENDM` to read all models
         (see the :ref:`splitmolcomplex<section_example_oebio_splitmolcomplex>`
         example for how to do this).
         In most situations, this parameter should be set to either
         0 (allow all models to be selected) or 1 (the default). The reason
         for this is that the site counter, which the parameter
         :oe:const:`-bindingsitenum<OEBio::OESplitMolComplexSetup::SiteNum>`
         selects based on, does not reset for each model and
         therefore site and model are not independent. A good example of
         where this can be used is with a PDB biological assembly file:
         setting the
         :oe:const:`-modelnum<OEBio::OESplitMolComplexSetup::ModelNum>`
         parameter to 0 (use all models),
         allows a binding site spanning symmetry related
         proteins marked as different models to be recognized.

      .. seealso::

        * :oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters` method

   .. oe:constant:: ProtFilter

      Passing this constant to the
      :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function results
      in generating the following default interface to configure
      the protein filter used
      by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents`.

      ::

         Contents of parameter -proteinfilter
             Type : string
             Allow list : false
             Default : prot_complex
             Simple : false
             Required : false
             Legal values : protein ligand water saccharide cofactor cofactor_and_ligand
                            metal counter_ion prot_complex peptide dna_rna nucleotide
                            covalent solution misc unknown
                            underdefined site1 surface_waters1 model1 chainA anything nothing
             Brief : Protein filter category
             Detail
                 Return molecules from this category as the protein

      .. seealso::

         * :oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters` method
         * :oe:meth:`OEBio::OESplitMolComplexOptions::SetProteinFilter` method

   .. oe:constant:: SeparateRes

      Passing this constant to the
      :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function results
      in generating the following default interface to configure
      the whether individual protein residues are separated before selection
      by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents`.
      This is commonly used to return just binding-site residues.

      ::

         Contents of parameter -separateresidues
             Type : bool
             Allow list : false
             Default : false
             Simple : true
             Required : false
             Brief : Separate individual residues before selection
             Detail
                 Used to return just those residues near the binding site

      .. seealso::

         * :oe:meth:`OEBio::OESplitMolComplexOptions::SetSeparateResidues` method

   .. oe:constant:: SiteNum

      Passing this constant to the
      :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function results
      in generating the following default interface to configure
      the selection filters used
      by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents`.

      ::

         Contents of parameter -bindingsitenum
             Aliases : -sitenum
             Type : unsigned
             Allow list : false
             Default : 1
             Simple : false
             Required : false
             Legal ranges :
                 999 to 0
             Brief : Select this binding site
             Detail
                 Specifying site 0 means select ALL sites

      .. seealso::

        * :oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters` method

   .. oe:constant:: SurfWat

      Passing this constant to the
      :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function results
      in generating the following default interface to configure
      the treatment of surface waters
      by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents`.

      ::

         Contents of parameter -surfacewaters
             Aliases : -surfwat
             Type : bool
             Allow list : false
             Default : false
             Simple : true
             Required : false
             Brief : Select surface waters
             Detail
                 Waters near the surface of the protein rather than just near the binding site

      .. seealso::

        * :oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters` method

   .. oe:constant:: WatFilter

      Passing this constant to the
      :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function results
      in generating the following default interface to configure
      the water filter used
      by :oe:func:`OEBio::OESplitMolComplex` and
      :oe:func:`OEBio::OEGetMolComplexComponents`.

      ::

         Contents of parameter -waterfilter
             Type : string
             Allow list : false
             Default : water
             Simple : false
             Required : false
             Legal values : protein ligand water saccharide cofactor cofactor_and_ligand
                            metal counter_ion prot_complex peptide dna_rna nucleotide
                            covalent solution misc unknown
                            underdefined site1 surface_waters1 model1 chainA anything nothing
             Brief : Water filter category
             Detail
                 Return molecules from this category as water

      .. seealso::

         * :oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters` method
         * :oe:meth:`OEBio::OESplitMolComplexOptions::SetWaterFilter` method



.. oe:namespace:: OEBio

..  _oebio_oestackinginteractionhinttype:

.. oe:constnamespace:: OEStackingInteractionHintType

   This namespace contains constants for the
   :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` interaction type.

   .. seealso::

      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` class
      * :ref:`OEIsStackingInteractionHint <OEBio_OEIsStackingInteractionHint>` functor
      * :ref:`OEIsIntermolecularStackingInteractionHint <OEBio_OEIsIntermolecularStackingInteractionHint>` functor
      * :ref:`OEIsIntramolecularStackingInteractionHint <OEBio_OEIsIntramolecularStackingInteractionHint>` functor

   .. oe:constant:: Pi

      A stacking interaction with the :oe:const:`OEBio::OEStackingInteractionHintType::Pi`
      type represents a Pi-stacking interaction between an aromatic ring of the
      'ligand' and an aromatic ring of the 'protein'.

   .. oe:constant:: T

      A stacking interaction with the :oe:const:`OEBio::OEStackingInteractionHintType::T`
      type represents a T-stacking interaction between an aromatic ring of the
      'ligand' and an aromatic ring of the 'protein'.

   .. oe:constant:: IntramolecularLigandPi

      A stacking interaction with the :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularLigandPi`
      type represents an intramolecular Pi-stacking interaction between two
      aromatic rings within the **ligand**.

   .. oe:constant:: IntramolecularLigandT

      A stacking interaction with the :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularLigandT`
      type represents an intramolecular T-stacking interaction between two
      aromatic rings within the **ligand**.

   .. oe:constant:: IntramolecularProteinPi

      A stacking interaction with the :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularProteinPi`
      type represents an intramolecular Pi-stacking interaction between two
      aromatic rings within the **protein**.

   .. oe:constant:: IntramolecularProteinT

      A stacking interaction with the :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularProteinT`
      type represents an intramolecular T-stacking interaction between two
      aromatic rings within the **protein**.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEAtomMatchResidueIDToString

.. oe:function:: OEAtomMatchResidueIDToString

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

      .. oe:api::

         std::string OEAtomMatchResidueIDToString(const OEBio::OEAtomMatchResidueID& res)

   .. oe:language:: python

      .. oe:api:: python

         OEAtomMatchResidueIDToString(res: OEAtomMatchResidueID) -> str

   Returns a human-readable string representation of the given
   :ref:`OEAtomMatchResidueID <OEBio_OEAtomMatchResidueID>` object,
   encoding its residue name, residue number, insertion code, chain ID,
   fragment number, and alternate location fields.

   .. seealso::

      * :ref:`OEAtomMatchResidueID <OEBio_OEAtomMatchResidueID>` class
      * :oe:func:`OEBio::OEGetAtomMatchResidueIDs` function


.. # split from OEBioFunctions.rst:6

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEBuildUnitCell

.. oe:function:: OEBuildUnitCell

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

      .. oe:api::

         bool OEBuildUnitCell(OEChem::OEMCMolBase& cell,
                              const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEBuildUnitCell(cell: OEMol, mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Apply all symmetry operators specified in mol and generate the unit cell
   by removing all redundant operators.
   ``mol`` must have 3D coordinates assigned and crystal symmetry set
   (see :oe:func:`OEBio::OESetCrystalSymmetry`).



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OECalculateDPI

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         bool OECalculateDPI(OEIridiumData& irid, const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OECalculateDPI(irid: OEIridiumData,
                        mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns ``true`` if the diffraction-component precision index (DPI) value can
   be calculated; otherwise, it returns ``false``. The calculated DPI value, the
   Rfree value, and the resolution of the crystal structure are stored in the
   ``irid`` (an :ref:`OEIridiumData <OEBio_OEIridiumData>` object).

   If the DPI is not readily readable from the PDB header data, it is calculated
   using the Blow equation (eq.1 in [Warren-2012]_), derived from work by Blow [Blow-2002]_ and Cruickshank [Cruickshank-1999]_.

   .. seealso::

      * :ref:`OEIridiumData <OEBio_OEIridiumData>` class
      * :ref:`chapter_sprucetk_iridium` section in **OESpruce TK**


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEClearDesignUnitStyle

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         void OEClearDesignUnitStyle(OEBio::OEDesignUnit& du)

   .. oe:language:: python

      .. oe:api:: python

         OEClearDesignUnitStyle(du: OEDesignUnit) -> None

   Removes all visual style information from every component of the
   design unit. After this call, no display style is set on any atom
   or bond in any tagged component.

   .. seealso::

      * :oe:func:`OEBio::OESetDefaultStyle` function
      * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class


.. # split by hand

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEClearMolComplexSDData

.. oe:function:: OEClearMolComplexSDData

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

      .. oe:api::

         void OEClearMolComplexSDData(OEChem::OEMolBase& mol,
                                      const std::string& prefix = std::string(OEMolComplexData::SDTagPrefix))

   .. oe:language:: python

      .. oe:api:: python

         OEClearMolComplexSDData(mol: Union[OEGraphMol,OEMol,OEQMol],
                                 prefix: str = str(OEMolComplexData_SDTagPrefix)) -> None

   Deletes any SD tags that have the specified prefix.
   Normally deletes all the tags generated by
   :oe:func:`OEBio::OEGetMolComplexComponents`,
   but a subset can be deleted by providing a more specific prefix.

   .. seealso::

      * :oe:func:`OEBio::OEGetMolComplexComponents` function
      * :oe:const:`OEBio::OEMolComplexData::SDTagPrefix` constant



.. # split by hand

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEClearPlaceHydrogensMetadata

.. oe:function:: OEClearPlaceHydrogensMetadata

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

      .. oe:api::

         void OEClearPlaceHydrogensMetadata(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEClearPlaceHydrogensMetadata(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Clears any metadata added to the molecule by
   :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`.

   .. seealso::

      * :oe:func:`OEBio::OEPlaceHydrogens` function
      * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetAddMetadata` method


.. # split by hand

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OECombineMolComplexFragments

.. oe:function:: OECombineMolComplexFragments

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

      .. oe:api::

         bool OECombineMolComplexFragments(OEChem::OEMolBase& dst,
                                           const std::vector<OEChem::OEAtomBondSet>& frags,
                                           const OESplitMolComplexOptions& opt = OESplitMolComplexOptions())
         bool OECombineMolComplexFragments(OEChem::OEMolBase& dst,
                                           const std::vector<OEChem::OEAtomBondSet>& frags,
                                           const OESplitMolComplexOptions& opt,
                                           const OESystem::OEUnaryPredicate<OESystem::OERoleSet>& filter,
                                           OEChem::OEAtomBase** atomMap = NULL,
                                           OEChem::OEBondBase** bondMap = NULL)

   .. oe:language:: python

      .. oe:api:: python

         OECombineMolComplexFragments(dst: Union[OEGraphMol,OEMol,OEQMol],
                                      frags: OEAtomBondSetVector,
                                      opt: OESplitMolComplexOptions = OESplitMolComplexOptions()) -> bool
         OECombineMolComplexFragments(dst: Union[OEGraphMol,OEMol,OEQMol],
                                      frags: OEAtomBondSetVector,
                                      opt: OESplitMolComplexOptions,
                                      filter: OEUnaryRoleSetPred,
                                      atomMap: OEAtomBase = None,
                                      bondMap: OEBondBase = None) -> bool

   Constructs a (subset) molecule ``dst`` from
   the input :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` vector ``frags``.
   The optional :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` object
   controls this process. If an explicit ``filter`` is not provided,
   the filter returned by the :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` method
   :oe:meth:`GetCombinedFilter<OEBio::OESplitMolComplexOptions::GetCombinedFilter>`
   method will be used. You can generate your own filters,
   see :ref:`section_split_mol_complex`.

   Using an :oe:cls:`OEAtomBondSet<OEChem::OEAtomBondSet>` vector and then
   filtering several times to produce molecules can be much more efficient
   compared to using the :oe:func:`OEBio::OESplitMolComplex` or
   :oe:func:`OEBio::OEGetMolComplexComponents` functions.

   Any molecules returned have been given titles.
   Protein chains are given a shortened version of the input title
   combined with the chain ID. Small molecule titles are
   residue names. Molecules with more than one residue are combined
   with a ``-`` if they are covalently attached, and a ``.`` if not.
   Residue names are not repeated. So, a single two residue
   molecule combined with any number of waters might have
   the title ``XYZ-ABC.HOH``.
   Output molecules may have *SD Tags* to indicate they include
   a covalent ligand.

   Atom and bond maps may be provided as a way to map from the original
   ``mol`` used to generate the :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` vector
   to the ``dst`` molecule. They are arrays of pointers of size
   :oe:meth:`GetMaxAtomIdx<OEChem::OEMolBase::GetMaxAtomIdx>` and
   :oe:meth:`GetMaxBondIdx<OEChem::OEMolBase::GetMaxBondIdx>`,
   respectively, indexed by atom and bond
   indices (using :oe:meth:`OEChem::OEAtomBase::GetIdx` and
   :oe:meth:`OEChem::OEBondBase::GetIdx`).

   Returns ``false`` if the task could not performed.
   To check if the filter identified any atoms,
   check the number of atoms in ``dst``.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :oe:func:`OEBio::OEGetMolComplexFragments` function
      * :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` class
      * :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` class
      * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
      * :oe:meth:`OEBio::OESplitMolComplexOptions::GetLigandFilter` method
      * :oe:meth:`OEBio::OESplitMolComplexOptions::GetProteinFilter` method
      * :oe:meth:`OEBio::OESplitMolComplexOptions::GetWaterFilter` method
      * :oe:meth:`OEBio::OESplitMolComplexOptions::GetOtherFilter` method
      * :oe:func:`OEBio::OESplitMolComplex` function
      * :oe:func:`OEBio::OEGetMolComplexComponents` function


.. # split from OEBioFunctions.rst:16

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEConfigureSplitMolComplexOptions

.. oe:function:: OEConfigureSplitMolComplexOptions

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

      .. oe:api::

         bool OEConfigureSplitMolComplexOptions(OESystem::OEInterface& itf,
                                                unsigned config = OESplitMolComplexSetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureSplitMolComplexOptions(itf: OEInterface, config: int) -> bool

   Configures the given interface to add command-line interface parameters that
   control :oe:func:`OEBio::OESetupSplitMolComplexOptions`.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface
      This value has to be from the
      :oe:constns:`OEBio::OESplitMolComplexSetup` namespace.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEBio::OESplitMolComplexSetup` namespace



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEConstructInteractionHintContainer

   .. attention::

      |PRELIMINARY-API|
      
   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConstructInteractionHintContainer(OEInteractionHintContainer& asite,
                                                  const OEChem::OEMolBase& protein,
                                                  const OEChem::OEMolBase& ligand)

   .. oe:language:: python

      .. oe:api:: python

         OEConstructInteractionHintContainer(asite: OEInteractionHintContainer,
                                             protein: Union[OEGraphMol,OEMol,OEQMol],
                                             ligand: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Constructs an :oe:cls:`OEBio::OEInteractionHintContainer` object that contains the 
   interaction hints between a protein and a ligand from the serialized interaction
   present in the molecules. 
   The function will return true if the interaction hints can be constructed successfully, 
   otherwise the function will return false and a given container will be cleared.

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

      .. oe:api::

         bool OEConstructInteractionHintContainer(OEInteractionHintContainer& asite,
                                                  const OEBio::OEDesignUnit& du)

   .. oe:language:: python

      .. oe:api:: python

         OEConstructInteractionHintContainer(asite: OEInteractionHintContainer,
                                             du: OEDesignUnit) -> bool

   Constructs an :oe:cls:`OEBio::OEInteractionHintContainer` from the serialized
   interaction hints stored in an :oe:cls:`OEBio::OEDesignUnit`.
   The function will return true if the interaction hints can be constructed
   successfully, otherwise the function will return false and the container will
   be cleared.

   .. seealso::

      * :oe:func:`OEBio::OESerializeInteractionsHintContainer` function
      * :oe:func:`OEBio::OEHasInteractionsHintSerializationData` function


.. # split from OEBioFunctions.rst:41

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OECopyCrystalSymmetry

.. oe:function:: OECopyCrystalSymmetry

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

      .. oe:api::

         bool OECopyCrystalSymmetry(OEChem::OEMolBase& dst,
                                    const OEChem::OEMolBase& src)

   .. oe:language:: python

      .. oe:api:: python

         OECopyCrystalSymmetry(dst: Union[OEGraphMol,OEMol,OEQMol],
                               src: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Copies any existing crystal symmetry from the source
   molecule to the destination molecule. This function returns ``false``
   if there was no symmetry to copy and ``true`` otherwise.



.. # split from OEBioFunctions.rst:51

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OECountMolComplexSites

.. oe:function:: OECountMolComplexSites

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

      .. oe:api::

         unsigned OECountMolComplexSites(const OEChem::OEMolBase& mol,
                                         const OESplitMolComplexOptions& opt = OESplitMolComplexOptions())

   .. oe:language:: python

      .. oe:api:: python

         OECountMolComplexSites(mol: Union[OEGraphMol,OEMol,OEQMol],
                                opt: OESplitMolComplexOptions = OESplitMolComplexOptions()) -> int

   Returns the number of binding sites identified in the specified :ref:`OEMolBase <OEChem_OEMolBase>`
   by identifying any ligands and then counting the number of binding sites
   they define. The optional :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` class
   can be used to control this process.

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

      .. oe:api::

         unsigned OECountMolComplexSites(const std::vector<OEChem::OEAtomBondSet>& frags)

   .. oe:language:: python

      .. oe:api:: python

         OECountMolComplexSites(frags: OEAtomBondSetVector) -> int

   Returns the number of binding sites as above, but in this case based on the
   :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` vector produced by the
   :oe:func:`OEBio::OEGetMolComplexFragments` function.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :oe:func:`OEBio::OEGetMolComplexFragments` function
      * :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` class
      * :oe:func:`OEBio::OESplitMolComplex` function
      * :oe:func:`OEBio::OEGetMolComplexComponents` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEDeleteInteractionsHintSerializationData

   .. attention::

      |PRELIMINARY-API|
      
   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDeleteInteractionsHintSerializationData(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEDeleteInteractionsHintSerializationData(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Deletes the serialized interaction hint data from a molecule.

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

      .. oe:api::

         void OEDeleteInteractionsHintSerializationData(OEBio::OEDesignUnit& du)

   .. oe:language:: python

      .. oe:api:: python

         OEDeleteInteractionsHintSerializationData(du: OEDesignUnit) -> None

   Deletes the serialized interaction hint data from all molecules in the given
   :oe:cls:`OEBio::OEDesignUnit`.

   .. seealso::

      * :oe:func:`OEBio::OESerializeInteractionsHintContainer` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEDeleteInteractionsHintSerializationIds

   .. attention::

      |PRELIMINARY-API|

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

      .. oe:api::

         void OEDeleteInteractionsHintSerializationIds(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEDeleteInteractionsHintSerializationIds(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Deletes the serialized interaction hint ids from a molecule.

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

      .. oe:api::

         void OEDeleteInteractionsHintSerializationIds(OEBio::OEDesignUnit& du)

   .. oe:language:: python

      .. oe:api:: python

         OEDeleteInteractionsHintSerializationIds(du: OEDesignUnit) -> None

   Deletes the serialized interaction hint ids from all molecules in the given
   :oe:cls:`OEBio::OEDesignUnit`.

    .. seealso::
    
       * :oe:func:`OEBio::OESetInteractionsHintSerializationIds` function
       * :oe:func:`OEBio::OESerializeInteractionsHintContainer` function


.. # split from OEBioFunctions.rst:71

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEExpandCrystalSymmetry

.. oe:function:: OEExpandCrystalSymmetry

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

      .. oe:api::

         bool OEExpandCrystalSymmetry(OEChem::OEMolBase& mol, float radius,
                                      float* center = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEExpandCrystalSymmetry(mol: Union[OEGraphMol,OEMol,OEQMol],
                                 radius: float, center: OEFloatArray = None) -> bool

   Expands atoms to fill the desired radius and optional
   center using the existing crystal symmetry on the molecule. If no
   center is specified, the center of the molecule is used. This
   function adds symmetry atoms and bonds to the molecule.
   ``mol`` must have 3D coordinates assigned and crystal symmetry set
   (see :oe:func:`OEBio::OESetCrystalSymmetry`).

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

      .. oe:api::

         bool OEExpandCrystalSymmetry(OEChem::OEMCMolBase& expanded,
                                      const OEChem::OEMolBase& src)

   .. oe:language:: python

      .. oe:api:: python

         OEExpandCrystalSymmetry(operators: OEMol,
                                 src: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Apply each symmetry operator to the input molecule ``src`` and
   generate a new conformer for each operator in ``expanded``.
   ``src`` must have 3D coordinates assigned and crystal symmetry set
   (see :oe:func:`OEBio::OESetCrystalSymmetry`).

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

      .. oe:api::

         bool OEExpandCrystalSymmetry(OEChem::OEMCMolBase& expanded,
                                      const OEChem::OEMolBase& src,
                                      float radius, float* center = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEExpandCrystalSymmetry(expanded: OEMol,
                                 mol: Union[OEGraphMol,OEMol,OEQMol],
                                 radius: float, center: OEFloatArray = None) -> bool

   This expands each symmetry operator within the symmetry of ``src``
   within the given radius and center.  Each symmetry operator forms a
   new conformer in ``expanded``. ``expanded`` is cleared before new conformers
   are added.

   If the center is not supplied, the center of the original molecule
   is used.
   ``src`` must have 3D coordinates assigned and crystal symmetry set
   (see :oe:func:`OEBio::OESetCrystalSymmetry`).


.. # split by hand

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEFilterMolComplexFragments

.. oe:function:: OEFilterMolComplexFragments

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

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEMolBase>* OEFilterMolComplexFragments(const std::vector<OEChem::OEAtomBondSet>& frags,
                                                                              const OESplitMolComplexOptions& opt = OESplitMolComplexOptions())
         OESystem::OEIterBase<OEChem::OEMolBase>* OEFilterMolComplexFragments(const std::vector<OEChem::OEAtomBondSet>& frags,
                                                                              const OESplitMolComplexOptions& opt,
                                                                              const OESystem::OEUnaryPredicate<OESystem::OERoleSet>& filter)

   .. oe:language:: python

      .. oe:api:: python

         OEFilterMolComplexFragments(frags: OEAtomBondSetVector,
                                     opt: OESplitMolComplexOptions = OESplitMolComplexOptions()) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]
         OEFilterMolComplexFragments(frags: OEAtomBondSetVector,
                                     opt: OESplitMolComplexOptions,
                                     filter: OEUnaryRoleSetPred) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

   Returns an iterator of connected components within
   the input :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` vector ``frags``.
   The optional :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` object
   controls this process. If an explicit ``filter`` is not provided,
   the filter returned by the :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` method
   :oe:meth:`GetCombinedFilter<OEBio::OESplitMolComplexOptions::GetCombinedFilter>`
   method will be used.

   Any molecules returned in the iterator have been given titles.
   Protein chains are given a shortened version of the input title
   combined with the chain ID. Small molecule titles are
   residue names. Molecules with more than one residue are combined
   with a ``-``. A two residue molecule might have the title ``XYZ-ABC``.
   Output molecules also have one or more *SD Tags* to describe the functional roles.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :oe:func:`OEBio::OEGetMolComplexFragments` function
      * :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` class
      * :ref:`OEIter <OESystem_OEIter>` class
      * :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` class
      * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
      * :oe:meth:`OEBio::OESplitMolComplexOptions::GetCombinedFilter` method
      * :oe:meth:`OEBio::OESplitMolComplexOptions::GetLigandFilter` method
      * :oe:meth:`OEBio::OESplitMolComplexOptions::GetProteinFilter` method
      * :oe:meth:`OEBio::OESplitMolComplexOptions::GetWaterFilter` method
      * :oe:meth:`OEBio::OESplitMolComplexOptions::GetOtherFilter` method
      * :oe:func:`OEBio::OESplitMolComplex` function
      * :oe:func:`OEBio::OEGetMolComplexComponents` function
      * :oe:func:`OEBio::OECombineMolComplexFragments` function



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetActiveSiteInteractionHintTypes

..  _oebio_oegetactivesiteinteractionhinttypes:

.. oe:function:: OEGetActiveSiteInteractionHintTypes

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

      .. oe:api::

         OESystem::OEIterBase<const OEInteractionHintTypeBase>* OEGetActiveSiteInteractionHintTypes()

   .. oe:language:: python

      .. oe:api:: python

         OEGetActiveSiteInteractionHintTypes() -> Iterable[OEInteractionHintTypeBase]

   Returns an iterator over all built-in interaction types
   that are used to indicate protein-ligand interactions
   perceived by either by the :oe:func:`OEBio::OEPerceiveInteractionHints`
   function or by the :oe:func:`OEDocking::OEAddDockingInteractions` function.

   .. admonition:: Code Examples

      * :ref:`section_example_oebio_printinteractions` **OEChem TK** example
      * `Accessing Interaction Hint Information`_  **OpenEye Python Cookbook** recipe

   .. seealso::

      * :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>` base class
      * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` class
      * :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>` class
      * :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>` class
      * :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>` class
      * :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>` class
      * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` class
      * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` class
      * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>` class
      * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` class


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetAlignment

.. oe:function:: OEGetAlignment

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

      .. oe:api::

         OESequenceAlignment OEGetAlignment(OEChem::OEMolBase& mol1,
                                            OEChem::OEMolBase& mol2,
                                            unsigned int assume = OEAssumption::Default,
                                            unsigned int method = OESeqAlignmentMethod::PAM250,
                                            int gap = -10, int extend = -2,
                                            bool nonStdToX = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAlignment(m1: Union[OEGraphMol,OEMol,OEQMol],
                        m2: Union[OEGraphMol,OEMol,OEQMol], assume: int,
                        method: int, gap: int = -10, extend: int = -2,
                        nonStdToX: bool = False) -> OESequenceAlignment

   Returns the highest scored alignment of all pairwise chain alignments calculated by
   :oe:func:`OEBio::OEGetAlignments`.

   **mol1, mol2**
     The two proteins of which alignment is being calculated.
     No 3D coordinates are required for sequence alignment; however, if the
     returned :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` is passed
     to :oe:func:`OEBio::OERMSD`, both molecules must have 3D coordinates assigned.

   **assume**
      A bitmask that indicates whether the algorithm can assume that the given proteins 
      have perceived residues, have PDB ordered atoms, or have bonded residues.
      See the :oe:constns:`OEBio::OEAssumption` namespace for more information.

   **method**
      This value has to be from the :oe:constns:`OEBio::OESeqAlignmentMethod`
      namespace and it defines the algorithm that is used to generate the 
      molecule alignment.

   **gap**, **extend**
      The gap and extension penalty to be used in the alignment.
      See also `Gap penalty <https://en.wikipedia.org/wiki/Gap_penalty>`_ in Wikipedia.

   **nonStdToX**
      Option to convert non-standard residues to an X, default is false.

   .. seealso::

      * :oe:func:`OEBio::OEGetAlignments` function
      * :oe:func:`OEBio::OEGetSimpleAlignment` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetAlignmentMethodName

.. oe:function:: OEGetAlignmentMethodName

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

      .. oe:api::

         const char* OEGetAlignmentMethodName(unsigned int method)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAlignmentMethodName(methodIdx: int) -> str

   Returns the string representation of a built-in sequence alignment method.

   **method**
     This value has to be from the  :oe:constns:`OEBio::OESeqAlignmentMethod`
     namespace.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetAlignments

.. oe:function:: OEGetAlignments

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

      .. oe:api::

         OESystem::OEIterBase<OEBio::OESequenceAlignment>* OEGetAlignments(OEChem::OEMolBase& mol1,
                                                                           OEChem::OEMolBase& mol2,
                                                                           unsigned int assume = OEAssumption::Default,
                                                                           unsigned int method = OESeqAlignmentMethod::PAM250,
                                                                           int gap = -10,
                                                                           int extend = -2,
                                                                           bool nonStdToX = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAlignments(m1: Union[OEGraphMol,OEMol,OEQMol],
                         m2: Union[OEGraphMol,OEMol,OEQMol], assume: int,
                         method: int, gap: int = -10, extend: int = -2,
                         nonStdToX: bool = False) -> OESequenceAlignmentIter

   Returns an iterator over all pairwise chain alignments of two proteins. 
   The returned alignments are not sorted.

   **mol1, mol2**
     The two proteins of which alignment is being calculated.
     No 3D coordinates are required for sequence alignment; however, if the
     returned :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` is passed
     to :oe:func:`OEBio::OERMSD`, both molecules must have 3D coordinates assigned.

   **assume**
      A bitmask that indicates whether the algorithm can assume that the given proteins 
      have perceived residues, have PDB ordered atoms, or have bonded residues.
      See the :oe:constns:`OEBio::OEAssumption` namespace for more information.

   **method**
      This value has to be from the :oe:constns:`OEBio::OESeqAlignmentMethod`
      namespace and it defines the algorithm that is used to generate the 
      molecule alignment.

   **gap**, **extend**
      The gap and extension penalty to be used in the alignment.
      See also `Gap penalty <https://en.wikipedia.org/wiki/Gap_penalty>`_ in Wikipedia.

   **nonStdToX**
      Option to convert non-standard residues to an X, default is false.

   .. seealso::

      * :oe:func:`OEBio::OEGetAlignment` function
      * :oe:func:`OEBio::OEGetSimpleAlignment` function
      * :oe:func:`OEBio::OERMSD` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetAtomMatchResidueIDs

.. oe:function:: OEGetAtomMatchResidueIDs

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

      .. oe:api::

         std::vector<OEAtomMatchResidueID> OEGetAtomMatchResidueIDs(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAtomMatchResidueIDs(mol: Union[OEGraphMol,OEMol,OEQMol]) -> OEAtomMatchResidueIDVector

   Retrieves the following properties for each residue in the molecule:

   * residue name
   * residue number
   * insertion code
   * chain ID
   * fragment number
   * alternate location.

   .. seealso::

      * :oe:cls:`OEResidue<OEChem::OEResidue>` class
      * :ref:`section_predicates_reside_data_functors` section
      * :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>` class
      * :ref:`OEAtomMatchResidueID <OEBio_OEAtomMatchResidueID>` class


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. oe:function:: OEGetCalculatedInteractionGeometries

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

      .. oe:api::

         OESystem::OEIterBase<const std::string>*
         OESystem::OEIterBase<const std::string>* OEGetCalculatedInteractionGeometries(const OEInteractionHintTypeBase& itype)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCalculatedInteractionGeometries(itype: OEInteractionHintTypeBase) -> Iterable[str]

   Returns an iterator over the names of the geometries generated for the
   given interaction hint type.

   **Example:**

   .. oe:source:: InteractionGeometry.py
      :language: python
      :noindent:
      :frag:     SNIPPET-INTER-TYPE

   .. oe:source:: InteractionGeometry.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-INTER-TYPE

   .. oe:source:: InteractionGeometry.java
      :language: java
      :noindent:
      :frag:     SNIPPET-INTER-TYPE

   .. oe:source:: InteractionGeometry.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-INTER-TYPE

   .. seealso::

      * :ref:`chapter_interactions_geometry` section
      * :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>` class
      * :oe:meth:`OEBio::OEInteractionHint::GetCalculatedGeometries` method


.. # split from OEBioFunctions.rst:140

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetChis Chi

.. oe:function:: OEGetChis

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

      .. oe:api::

         OESystem::OEIterBase<unsigned>* OEGetChis(const OEHierResidue& res)
         OESystem::OEIterBase<unsigned>* OEGetChis(const OEChem::OEAtomBase* atom,
                                                   unsigned assume = OEAssumption::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGetChis(res: OEHierResidue) -> List[float]
         OEGetChis(atom: OEAtomBase, assume: int = OEAssumption_Default) -> List[float]

   Returns an iterator over the torsion-type constants from :oe:constns:`OEBio::OEProtTorType`
   (e.g. ``Chi1``, ``Chi2``) for all the side-chain :math:`\chi` (chi) angles of a
   particular residue. Pass these constants to :oe:func:`OEBio::OEGetTorsion` to retrieve
   the actual angle values in radians.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetCrystalSymmetry

.. oe:function:: OEGetCrystalSymmetry

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

      .. oe:api::

         bool OEGetCrystalSymmetry(OECrystalSymmetryParams& params,
                                   const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCrystalSymmetry(params: OECrystalSymmetryParams,
                              mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Retrieves the crystal symmetry information from the
   molecule.
   The retrieved information is stored in the given
   :ref:`OECrystalSymmetryParams <OEBio_OECrystalSymmetryParams>` object.

   .. note::

      Use this overloaded function in the supported wrapped
      languages: Python, Java and C#.

   **Example:**

   .. oe:source:: OEGetCrystalSymmetry.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEGETCRYSTALSYMMETRY

   .. oe:source:: OEGetCrystalSymmetry.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEGETCRYSTALSYMMETRY

   .. oe:source:: OEGetCrystalSymmetry.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEGETCRYSTALSYMMETRY

   .. oe:source:: OEGetCrystalSymmetryDoc.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEGETCRYSTALSYMMETRY

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

      .. oe:api::

         bool OEGetCrystalSymmetry(const OEChem::OEMolBase& mol, float& a,
                                   float& b, float& c, float& alpha,
                                   float& beta, float& gamma,
                                   unsigned int& sgnumber)
         bool OEGetCrystalSymmetry(const OEChem::OEMolBase& mol, float& a,
                                   float& b, float& c, float& alpha,
                                   float& beta, float& gamma,
                                   unsigned int& sgnumber, unsigned int& zvalue)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCrystalSymmetry(mol: Union[OEGraphMol,OEMol,OEQMol]) -> (a: float, b: float, c: float, alpha: float, beta: float, gamma: float, sgnumber: int, zvalue: int)

   Retrieves the following the crystal symmetry information from the
   molecule:

   * standard cell lengths
   * cell angles 'alpha', 'beta' and 'gamma' and
   * spacegroup number
   * z-value

   .. seealso::

      * :oe:func:`OEBio::OESetCrystalSymmetry` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEGetDesignUnitComponentID

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         unsigned OEGetDesignUnitComponentID(const std::string& componentName)

   .. oe:language:: python

      .. oe:api:: python

         OEGetDesignUnitComponentID(componentName: str) -> int

   This function returns numeric value from the
   :oe:constns:`OEBio::OEDesignUnitComponents` namespace given the
   input ``componentName`` string. It will return the :oe:constns:`OEBio::OEDesignUnitComponents::Unknown`
   constant if the input name does not match any known component ID.

   .. seealso::

      * :oe:func:`OEBio::OEGetDesignUnitComponentName` function
      * :oe:func:`OEBio::OEGetDesignUnitComponentNamesFromMask` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEGetDesignUnitComponentName

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         std::string OEGetDesignUnitComponentName(const unsigned componentID)

   .. oe:language:: python

      .. oe:api:: python

         OEGetDesignUnitComponentName(componentID: int) -> str

   This function returns the name of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` component from
   the input ``componentID``, whose value is assumed to be from
   the :oe:constns:`OEBio::OEDesignUnitComponents` namespace. If the input ID does not match
   any of the known IDs in the namespace, the function returns "unknown".

   .. seealso::

      * :oe:func:`OEBio::OEGetDesignUnitComponentID` function
      * :oe:func:`OEBio::OEGetDesignUnitComponentNamesFromMask` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEGetDesignUnitComponentNamesFromMask

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         std::string OEGetDesignUnitComponentNamesFromMask(const unsigned mask,
                                                           const std::string& delimiter = "|")

   .. oe:language:: python

      .. oe:api:: python

         OEGetDesignUnitComponentNamesFromMask(componentMask: int,
                                               delimiter: str = "|") -> str

   This function returns the names of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` components from
   the input ``mask`` in a concatenated form with a delimiter. The input mask is
   assumed to be from the :oe:constns:`OEBio::OEDesignUnitComponents` namespace, otherwise "unknown" will be returned.

   .. seealso::

      * :oe:func:`OEBio::OEGetDesignUnitComponentName` function
      * :oe:func:`OEBio::OEGetDesignUnitComponentID` function



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetInteractions

.. oe:function:: OEGetInteractions

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

      .. oe:api::

         OESystem::OEIterBase<const OEInteractionHint>* OEGetInteractions(const OEChem::OEMolBase& mol,
                                                                          const OEInteractionHintContainer& container)

   .. oe:language:: python

      .. oe:api:: python

         OEGetInteractions(mol: Union[OEGraphMol,OEMol,OEQMol],
                           arg2: OEInteractionHintContainer) -> Iterable[OEInteractionHint]

   Returns an iterator over the interactions stored in the given container
   that are connecting any atoms of the given molecules.

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

      .. oe:api::

         OESystem::OEIterBase<const OEInteractionHint>* OEGetInteractions(const OEChem::OEAtomBase* atom,
                                                                          const OEInteractionHintContainer& container)

   .. oe:language:: python

      .. oe:api:: python

         OEGetInteractions(atom: OEAtomBase, arg2: OEInteractionHintContainer) -> Iterable[OEInteractionHint]

   Returns an iterator over the interactions stored in the given container
   that are connecting the given atom.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEGetIridiumCategoryFromName

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         unsigned OEGetIridiumCategoryFromName(std::string categoryName)

   .. oe:language:: python

      .. oe:api:: python

         OEGetIridiumCategoryFromName(categoryName: str) -> int

   This function returns the corresponding Iridium category value from
   the :oe:constns:`OEBio::OEIridiumCategory` namespace given the
   input ``categoryName`` string.

   .. seealso::

      * :oe:constns:`OEBio::OEIridiumCategory` namespace
      * :oe:func:`OEBio::OEGetIridiumCategoryName` inverse function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEGetIridiumCategoryName

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         std::string OEGetIridiumCategoryName(unsigned iridiumCategory)

   .. oe:language:: python

      .. oe:api:: python

         OEGetIridiumCategoryName(iridiumCategory: int) -> str

   This function returns the name of the Iridium category from the
   input ``iridiumCategory``, whose value is assumed to be from the
   :oe:constns:`OEBio::OEIridiumCategory` namespace.

   .. seealso::

      * :oe:constns:`OEBio::OEIridiumCategory` namespace
      * :oe:func:`OEBio::OEGetIridiumCategoryFromName` inverse function


.. # split from OEBioFunctions.rst:164

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetMolComplexComponents

.. oe:function:: OEGetMolComplexComponents

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

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEMolBase>* OEGetMolComplexComponents(const OEChem::OEMolBase& mol,
                                                                            const OESplitMolComplexOptions& opt = OESplitMolComplexOptions())
         OESystem::OEIterBase<OEChem::OEMolBase>* OEGetMolComplexComponents(const OEChem::OEMolBase& mol,
                                                                            const OESplitMolComplexOptions& opt,
                                                                            const OESystem::OEUnaryPredicate<OESystem::OERoleSet>& filter)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMolComplexComponents(mol: Union[OEGraphMol,OEMol,OEQMol],
                                   opt: OESplitMolComplexOptions = OESplitMolComplexOptions()) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]
         OEGetMolComplexComponents(mol: Union[OEGraphMol,OEMol,OEQMol],
                                   opt: OESplitMolComplexOptions,
                                   filter: OEUnaryRoleSetPred) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

   Returns an iterator of connected components within
   the specified :ref:`OEMolBase <OEChem_OEMolBase>`.
   The optional :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` object
   controls this process. If an explicit ``filter`` is not provided,
   the filter returned by the :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` method
   :oe:meth:`GetCombinedFilter<OEBio::OESplitMolComplexOptions::GetCombinedFilter>`
   will be used.

   Any molecules returned in the iterator have been given titles.
   Protein chains are given a shortened version of the input title
   combined with the chain ID. Small molecule titles are
   residue names. Molecules with more than one residue are combined
   with a ``-``. A two residue molecule might have the title ``XYZ-ABC``.
   Output molecules also have one or more *SD Tags* to describe the functional roles.

   .. warning::

      The input molecule should contain *PDB*
      :ref:`residue information<section_biopolymer_residues>`
      such as residue name, which is used during the
      classification process, either from a PDB format file or
      through :oe:func:`residue perception<OEChem::OEPerceiveResidues>`.
      Molecular complexes read from files in formats that lack this
      information (for example *SDF*) may be split inappropriately unless
      residues are perceived after input.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :ref:`OEIter <OESystem_OEIter>` class
      * :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` class
      * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
      * :oe:func:`OEBio::OESplitMolComplex` function


.. # split from OEBioFunctions.rst:198

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetMolComplexFilterCategoryName

.. oe:function:: OEGetMolComplexFilterCategoryName

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

      .. oe:api::

         const char* OEGetMolComplexFilterCategoryName(unsigned category)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMolComplexFilterCategoryName(category: int) -> str

   Returns the name of the specified functional role filter category from the
   :oe:constns:`OEBio::OEMolComplexFilterCategory` namespace.



.. # split by hand

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetMolComplexFragments

.. oe:function:: OEGetMolComplexFragments

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

      .. oe:api::

         bool OEGetMolComplexFragments(std::vector<OEChem::OEAtomBondSet>& frags,
                                       const OEChem::OEMolBase& mol,
                                       const OESplitMolComplexOptions& opt = OESplitMolComplexOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEGetMolComplexFragments(frags: OEAtomBondSetVector,
                                  mol: Union[OEGraphMol,OEMol,OEQMol],
                                  opt: OESplitMolComplexOptions = OESplitMolComplexOptions()) -> bool

   Analyze the input ``mol`` and generate
   a vector of :oe:cls:`OEAtomBondSets<OEChem::OEAtomBondSet>` that describe
   each connected fragment according to its functional role.
   The ``frags`` vector can be used to
   :oe:func:`count<OEBio::OECountMolComplexSites>` binding sites,
   :oe:func:`combine<OEBio::OECombineMolComplexFragments>` fragments
   into a molecule, or :oe:func:`filter<OEBio::OEFilterMolComplexFragments>`
   fragments by role.

   Using an :oe:cls:`OEAtomBondSet<OEChem::OEAtomBondSet>` vector and then
   filtering several times to produce molecules can be much more efficient
   compared to using the :oe:func:`OEBio::OESplitMolComplex` or
   :oe:func:`OEBio::OEGetMolComplexComponents` functions.

   .. oe:language:: python

      To create an :oe:cls:`OEAtomBondSet<OEChem::OEAtomBondSet>` vector:

      .. code-block:: python

         frags = OEAtomBondSetVector()

   .. oe:language:: java

      To create an :oe:cls:`OEAtomBondSet<OEChem::OEAtomBondSet>` vector:

      .. code-block:: java

         OEAtomBondSetVector frags = new OEAtomBondSetVector();

   .. oe:language:: csharp

      To create an :oe:cls:`OEAtomBondSet<OEChem::OEAtomBondSet>` vector:

      .. code-block:: csharp

         OEAtomBondSetVector frags = new OEAtomBondSetVector();

   The process is controlled by
   an optional :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` object.

   Returns ``false`` if the task could not be performed
   (for example, if ``mol`` is empty).

   .. warning::

      The input molecule should contain *PDB*
      :ref:`residue information<section_biopolymer_residues>`
      such as residue name, which is used during the
      classification process, either from a PDB format file or
      through :oe:func:`residue perception<OEChem::OEPerceiveResidues>`.
      Molecular complexes read from files in formats that lack this
      information (for example *SDF*) may be split inappropriately unless
      residues are perceived after input.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` class
      * :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` class
      * :oe:func:`OEBio::OECombineMolComplexFragments` function
      * :oe:func:`OEBio::OEFilterMolComplexFragments` function
      * :oe:func:`OEBio::OECountMolComplexSites` function
      * :oe:func:`OEBio::OESplitMolComplex` function


.. # split from OEBioFunctions.rst:208

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetPhi Phi

.. oe:function:: OEGetPhi

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

      .. oe:api::

         double OEGetPhi(const OEHierResidue& res)
         double OEGetPhi(const OEChem::OEAtomBase* atom,
                         unsigned assume = OEAssumption::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPhi(res: OEHierResidue) -> float
         OEGetPhi(atom: OEAtomBase, assume: int) -> float

   Returns the :math:`\phi` (phi) angle in radians for a residue
   specified by its :ref:`OEHierResidue <OEBio_OEHierResidue>` class or by an
   :ref:`OEAtomBase <OEChem_OEAtomBase>` from the residue.
   The molecule must have 3D coordinates assigned.



.. # split by hand

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetPlaceHydrogensMetadata

.. oe:function:: OEGetPlaceHydrogensMetadata

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

      .. oe:api::

         std::string OEGetPlaceHydrogensMetadata(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPlaceHydrogensMetadata(mol: Union[OEGraphMol,OEMol,OEQMol]) -> str

   Returns any metadata added to the molecule by
   :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`.
   The metadata is the string generated by a call to the
   :oe:meth:`OEBio::OEPlaceHydrogensDetails::Describe` method
   (does not require an explicit :ref:`OEPlaceHydrogensDetails <OEBio_OEPlaceHydrogensDetails>`
   to be passed in).

   .. seealso::

      * :oe:func:`OEBio::OEPlaceHydrogens` function
      * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetAddMetadata` method


.. # split by hand

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetPlaceHydrogensMoverClassName

.. oe:function:: OEGetPlaceHydrogensMoverClassName

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

      .. oe:api::

         std::string OEGetPlaceHydrogensMoverClassName(unsigned moverClass)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPlaceHydrogensMoverClassName(moverClass: int) -> str

   Returns the standard name of the
   :oe:constns:`class<OEBio::OEPlaceHydrogensMoverClass>`
   assigned to a "mover" as described by a
   :ref:`OEPlaceHydrogensMoverNote <OEBio_OEPlaceHydrogensMoverNote>` object generated by calling
   :oe:func:`OEBio::OEPlaceHydrogens` and examining the resulting
   :ref:`OEPlaceHydrogensDetails <OEBio_OEPlaceHydrogensDetails>` object.

   .. seealso::

      * :oe:constns:`OEBio::OEPlaceHydrogensMoverClass` namespace
      * :oe:meth:`OEBio::OEPlaceHydrogensMoverNote::GetMoverClass` method


.. # split from OEBioFunctions.rst:220

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetProteinTorsionName

.. oe:function:: OEGetProteinTorsionName

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

      .. oe:api::

         const char* OEGetProteinTorsionName(unsigned torType)

   .. oe:language:: python

      .. oe:api:: python

         OEGetProteinTorsionName(torType: int) -> str

   Takes an integer from the :oe:constns:`OEBio::OEProtTorType` namespace and
   returns a ``const char*`` version for use in output.



.. # split from OEBioFunctions.rst:229

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetPsi Psi

.. oe:function:: OEGetPsi

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

      .. oe:api::

         double OEGetPsi(const OEHierResidue& res)
         double OEGetPsi(const OEChem::OEAtomBase* atom,
                         unsigned assume = OEAssumption::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPsi(res: OEHierResidue) -> float
         OEGetPsi(atom: OEAtomBase, assume: int) -> float

   Returns the :math:`\psi` (psi) angle in radians for a residue
   specified by its :ref:`OEHierResidue <OEBio_OEHierResidue>` class or by any
   :ref:`OEAtomBase <OEChem_OEAtomBase>` from the residue.
   The molecule must have 3D coordinates assigned.



.. oe:namespace:: OEBio

.. oe:function:: OEGetRamachandranCategoryName

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

      .. oe:api::

         std::string OEGetRamachandranCategoryName(const unsigned int category)

   .. oe:language:: python

      .. oe:api:: python

         OEGetRamachandranCategoryName(ramaCategory: int) -> str

   Returns the string representation of a built-in Ramachandran category.

   **category**
     This value has to be from the  :oe:constns:`OEBio::OERamaCategory`
     namespace.


.. oe:namespace:: OEBio

.. oe:function:: OEGetRamachandranTypeName

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

      .. oe:api::

         std::string OEGetRamachandranTypeName(const unsigned ramatype)

   .. oe:language:: python

      .. oe:api:: python

         OEGetRamachandranTypeName(ramaType: int) -> str

   Returns the string representation of a built-in Ramachandran type.

   **ramatype**
     This value has to be from the  :oe:constns:`OEBio::OERamaType`
     namespace.



.. oe:namespace:: OEBio

.. oe:function:: OEGetResidueAtom

   These two functions return an atom pointer to a specific atom in a residue.
   The specific atom is specified by the :oe:constns:`OEChem::OEPDBAtomName` namespace.
   The residue in question can either be supplied by passing an :ref:`OEResidue <OEChem_OEResidue>` object
   indicating the residue and the molecule of interest, or by passing any atom in the residue.
   In both functions, the assume argument is a bitmask that indicates whether the algorithm
   can assume that the molecule has perceived residues, has PDB ordered atoms, or as
   bonded residues.

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

      .. oe:api::

         const OEChem::OEAtomBase * OEGetResidueAtom(const OEChem::OEAtomBase* atom,
                                                     const unsigned pdbAtomIdx,
                                                     unsigned assume = OEAssumption::Default)
         OEChem::OEAtomBase * OEGetResidueAtom(OEChem::OEAtomBase* atom,
                                               const unsigned pdbAtomIdx,
                                               unsigned assume = OEAssumption::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGetResidueAtom(atom: OEAtomBase, pdbAtomIdx: int, assume: int) -> OEAtomBase

   In this function, the residue of interest is identified by passing
   any atom from that residue into the function, e.g. passing in the
   :oe:const:`NZ<OEChem::OEPDBAtomName::NZ>` atom and requesting the
   :oe:const:`CA<OEChem::OEPDBAtomName::CA>` atom in the same residue.

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

      .. oe:api::

         const OEChem::OEAtomBase * OEGetResidueAtom(const OEChem::OEMolBase& mol,
                                                     const OEChem::OEResidue& residue,
                                                     const unsigned pdbAtomIdx,
                                                     unsigned assume = OEAssumption::Default)
         OEChem::OEAtomBase * OEGetResidueAtom(OEChem::OEMolBase& mol,
                                               const OEChem::OEResidue& residue,
                                               const unsigned pdbAtomIdx,
                                               unsigned assume = OEAssumption::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGetResidueAtom(mol: Union[OEGraphMol,OEMol,OEQMol],
                          residue: OEResidue, pdbAtomIdx: int, assume: int) -> OEAtomBase

   In this function, the residue is indicated by a combination of the
   molecule of interest as well as any one of the :ref:`OEResidue <OEChem_OEResidue>`
   objects from the residue.

   .. seealso::

      * :oe:func:`OEBio::OEGetResidueAtoms` function
      * :oe:constns:`OEBio::OEAssumption` namespace
      * :ref:`OEHierView <OEBio_OEHierView>` for an additional method for accessing the
        atom of a residue in a protein



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetResidueAtoms

.. oe:function:: OEGetResidueAtoms

   These two functions generate an iterator of all of the atoms in a
   residue. They differ dramatically in the manner in which the
   residue is specified. In both functions, the assume argument is a
   bitmask that indicates whether the algorithm can assume that the
   molecule has perceived residues, has PDB ordered atoms, or as
   bonded residues (see the :oe:constns:`OEBio::OEAssumption` namespace for more
   information). Please see :ref:`OEHierView <OEBio_OEHierView>` for an additional method for
   accessing the atoms of a residue in a protein.

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

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEAtomBase>* OEGetResidueAtoms(OEChem::OEAtomBase* atom,
                                                                     unsigned assume = OEAssumption::Default)
         OESystem::OEIterBase<const OEChem::OEAtomBase>* OEGetResidueAtoms(const OEChem::OEAtomBase* atom,
                                                                           unsigned assume = OEAssumption::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGetResidueAtoms(atom: OEAtomBase, assume: int) -> OEAtomIter

   In this function, the residue of interest is identified by passing
   any atom from that residue into the function.

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

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEAtomBase>* OEGetResidueAtoms(OEChem::OEMolBase& mol,
                                                                     const OEChem::OEResidue& residue,
                                                                     unsigned assume = OEAssumption::Default)
         OESystem::OEIterBase<const OEChem::OEAtomBase>* OEGetResidueAtoms(const OEChem::OEMolBase& mol,
                                                                           const OEChem::OEResidue& residue,
                                                                           unsigned assume = OEAssumption::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGetResidueAtoms(mol: Union[OEGraphMol,OEMol,OEQMol],
                           residue: OEResidue, assume: int) -> OEAtomIter

   In this function, the residue is indicated by a combination of the
   molecule of interest as well as any one of the :ref:`OEResidue <OEChem_OEResidue>`
   objects from the residue.

   .. seealso::

      * :oe:func:`OEBio::OEGetResidueAtom` function


.. # split from OEBioFunctions.rst:279

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetResidueDatabaseCategoryName

.. oe:function:: OEGetResidueDatabaseCategoryName

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

      .. oe:api::

         const char* OEGetResidueDatabaseCategoryName(const unsigned category)

   .. oe:language:: python

      .. oe:api:: python

         OEGetResidueDatabaseCategoryName(category: int) -> str

   Returns the name of the specified residue name list category from the
   :oe:constns:`OEBio::OEResidueDatabaseCategory` namespace.


.. # split from OEBioFunctions.rst:288

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetResidues

.. oe:function:: OEGetResidues

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

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEResidue>* OEGetResidues(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetResidues(mol: Union[OEGraphMol,OEMol,OEQMol]) -> OEResidueIter

   Returns an iterator containing all the unique :ref:`OEResidue <OEChem_OEResidue>`
   objects in the :ref:`OEMolBase <OEChem_OEMolBase>` provided. Regardless of the
   number of atoms in a peptide amino-acid, nucleic acid base, or ligand,
   only one :ref:`OEResidue <OEChem_OEResidue>` will be returned for each.

   .. seealso::

      * :ref:`section_biopolymer_residues` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetRotamers

.. oe:function:: OEGetRotamers

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

      .. oe:api::

         OESystem::OEIterBase<OERotamer>* OEGetRotamers(const OEHierResidue& residue,
                                                        unsigned int library = OERotamerLibrary::Default)
         OESystem::OEIterBase<OERotamer>* OEGetRotamers(const OEChem::OEResidue& residue,
                                                        unsigned int library = OERotamerLibrary::Default)
         OESystem::OEIterBase<OERotamer>* OEGetRotamers(unsigned int residueIndex,
                                                        unsigned int library = OERotamerLibrary::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGetRotamers(residue: OEHierResidue, library: int) -> OERotamerIter
         OEGetRotamers(residue: OEResidue, library: int) -> OERotamerIter
         OEGetRotamers(residueIndex: int, library: int) -> OERotamerIter

   Return an iterator of :ref:`OERotamer <OEBio_OERotamer>` objects specifying angles :math:`\chi_1 \cdots \chi_4`
   and the associated probability for each rotamer for the given residue type
   based on the selected rotamer library.
   The type of the rotamer library has to be taken from the :oe:constns:`OEBio::OERotamerLibrary` namespace.

   .. seealso::

      * :ref:`OERotamer <OEBio_OERotamer>` class
      * :oe:func:`OEBio::OESetRotamer` function
      * :oe:constns:`OEBio::OERotamerLibrary` namespace


.. # split from OEBioFunctions.rst:320

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetSecondaryStructureID

.. oe:function:: OEGetSecondaryStructureID

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

      .. oe:api::

         int OEGetSecondaryStructureID(int ssValue)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSecondaryStructureID(ssValue: int) -> int

   Returns an integer containing the serial number of a helix, sheet, or turn 
   in a protein.  The ssValue argument is typically a value returned from
   :oe:meth:`OEChem::OEResidue::GetSecondaryStructure`.



.. # split from OEBioFunctions.rst:330

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetSecondaryStructureName

.. oe:function:: OEGetSecondaryStructureName

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

      .. oe:api::

         std::string OEGetSecondaryStructureName(int ssValue)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSecondaryStructureName(ssValue: int) -> str

   Returns a string describing the type of secondary structure, (e.g., 
   'Alpha Helix', 'Beta Sheet', etc.) decoded from a secondary structure 
   value.  This value typically comes from the return value of
   :oe:meth:`OEChem::OEResidue::GetSecondaryStructure`.



.. # split from OEBioFunctions.rst:341

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetSecondaryStructureStrandID

.. oe:function:: OEGetSecondaryStructureStrandID

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

      .. oe:api::

         int OEGetSecondaryStructureStrandID(int ssValue)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSecondaryStructureStrandID(ssValue: int) -> int

   Returns an integer containing the strand serial number for a strand in
   a beta sheet.  The ssValue argument is typically a value returned from 
   :oe:meth:`OEChem::OEResidue::GetSecondaryStructure`.  For secondary structure
   elements other than sheets, the strand ID is always zero.



.. # split from OEBioFunctions.rst:352

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetSecondaryStructureType

.. oe:function:: OEGetSecondaryStructureType

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

      .. oe:api::

         int OEGetSecondaryStructureType(int ssValue)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSecondaryStructureType(ssValue: int) -> int

   Returns an integer containing a secondary structure type decoded from the
   ssValue argument, which typically is returned from
   :oe:meth:`OEChem::OEResidue::GetSecondaryStructure`.  The return values are
   defined in the :oe:constns:`OEBio::OESecondaryStructure` namespace.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetSimpleAlignment

.. oe:function:: OEGetSimpleAlignment

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

      .. oe:api::

         OESequenceAlignment OEGetSimpleAlignment(OEChem::OEMolBase& mol1,
                                                  OEChem::OEMolBase& mol2,
                                                  unsigned int assume = OEAssumption::Default,
                                                  unsigned int method = OESeqAlignmentMethod::PAM250,
                                                  int gap = -10,
                                                  int extend = -2,
                                                  bool nonStdToX = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSimpleAlignment(m1: Union[OEGraphMol,OEMol,OEQMol],
                              m2: Union[OEGraphMol,OEMol,OEQMol], assume: int,
                              method: int, gap: int = -10, extend: int = -2,
                              nonStdToX: bool = False) -> OESequenceAlignment

   Returns the alignment of two proteins in an :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>`
   object. Only the first chain of each protein is considered.

   **mol1, mol2**
     The two proteins of which alignment is being calculated.
     No 3D coordinates are required for sequence alignment; however, if the
     returned :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` is passed
     to :oe:func:`OEBio::OERMSD`, both molecules must have 3D coordinates assigned.

   **assume**
      A bitmask that indicates whether the algorithm can assume that the given proteins 
      have perceived residues, have PDB ordered atoms, or have bonded residues.
      See the :oe:constns:`OEBio::OEAssumption` namespace for more information.

   **method**
      This value has to be from the :oe:constns:`OEBio::OESeqAlignmentMethod`
      namespace and it defines the algorithm that is used to generate the 
      molecule alignment.

   **gap**, **extend**
      The gap and extension penalty to be used in the alignment.
      See also `Gap penalty <https://en.wikipedia.org/wiki/Gap_penalty>`_ in Wikipedia.

   **nonStdToX**
      Option to convert non-standard residues to an X, default is false.

   .. seealso::

      * :oe:func:`OEBio::OEGetAlignment` function
      * :oe:func:`OEBio::OEGetAlignments` function


.. # split from OEBioFunctions.rst:363

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetSpaceGroup

.. oe:function:: OEGetSpaceGroup

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

      .. oe:api::

         bool OEGetSpaceGroup(std::string& ccp4Name, unsigned int sgnumber,
                              bool shortname = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSpaceGroup(sgnumber: int, shortname: bool = False) -> str

   Assigns the standard CCP4 spacegroup name referenced by
   sgnumber to spacegroup. If 'shortname' is ``true`` then the standard
   shortened name for the spacegroup is assigned. This function
   returns ``false`` if 'sgnumber' does not reference a valid space group.



.. # split from OEBioFunctions.rst:374

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetSpaceGroupNumber

.. oe:function:: OEGetSpaceGroupNumber

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

      .. oe:api::

         int OEGetSpaceGroupNumber(const std::string& ccp4Name)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSpaceGroupNumber(ccp4Name: str) -> int

   Returns the CCP4 integer spacegroup number for the CCP4
   spacegroup referenced by spacegroup. If the spacegroup cannot be
   found, this function returns ``0``.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEGetTorsion

.. oe:function:: OEGetTorsion

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

      .. oe:api::

         double OEGetTorsion(const OEHierResidue& res, unsigned torType)
         double OEGetTorsion(const OEChem::OEAtomBase* atom, unsigned torType,
                             unsigned assume = OEAssumption::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGetTorsion(res: OEHierResidue, torType: int) -> float
         OEGetTorsion(atom: OEAtomBase, torType: int,
                      assume: int = OEAssumption_Default) -> float

   Returns the angle in radians for one of the standard
   torsion angles in a residue. The specific torsion is indicated by passing
   one of the constants from the :oe:constns:`OEBio::OEProtTorType` namespace into the
   'torType' parameter. The residue is specified by its :ref:`OEHierResidue <OEBio_OEHierResidue>`
   class or by any :ref:`OEAtomBase <OEChem_OEAtomBase>` from the residue. If the
   specified torsion type does not exist in the given residue, the
   function returns ``-100.0``.
   The function works by calling :oe:func:`OEGetTorsion<OEChem::OEGetTorsion>` with the
   appropriate atoms provided by the :oe:constns:`OEBio::OEProtTorType` namespace.
   The molecule must have 3D coordinates assigned.

  .. seealso::

     * :oe:func:`OEChem::OEGetTorsion` **OEChem TK** function


.. # split from OEBioFunctions.rst:400

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEHasBondedResidues

.. oe:function:: OEHasBondedResidues

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

      .. oe:api::

         bool OEHasBondedResidues(OEChem::OEMolBase& mol,
                                  unsigned assume = OEAssumption::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEHasBondedResidues(mol: Union[OEGraphMol,OEMol,OEQMol], assume: int) -> bool

   Returns a boolean value indicating whether all of the
   atoms of each residue in the molecule are bonded to one
   another. The assume argument is a bitmask that indicates whether
   the algorithm can assume that the molecule has perceived residues,
   has PDB ordered atoms, or as bonded residues 
   (see the :oe:constns:`OEBio::OEAssumption` namespace for more information).



.. # split from OEBioFunctions.rst:414

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEHasCrystalSymmetry

.. oe:function:: OEHasCrystalSymmetry

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

      .. oe:api::

         bool OEHasCrystalSymmetry(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasCrystalSymmetry(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns a boolean value indicating whether the
   molecule has crystal symmetry or not.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEHasInteractionHintSerializationIds

   .. attention::

      |PRELIMINARY-API|

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

      .. oe:api::

         bool OEHasInteractionHintSerializationIds(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasInteractionHintSerializationIds(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns true if the molecule has the interaction hint serialization ids set.

   .. seealso::
    
      * :oe:func:`OEBio::OESetInteractionsHintSerializationIds` function
      * :oe:func:`OEBio::OEDeleteInteractionsHintSerializationIds` function
      * :oe:func:`OEBio::OESerializeInteractionsHintContainer` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEHasInteractionsHintSerializationData

   .. attention::

      |PRELIMINARY-API|

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

      .. oe:api::

         bool  OEHasInteractionsHintSerializationData(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasInteractionsHintSerializationData(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns true if the molecule has the interaction hint serialization data set.

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

      .. oe:api::

         bool  OEHasInteractionsHintSerializationData(const OEBio::OEDesignUnit& du)

   .. oe:language:: python

      .. oe:api:: python

         OEHasInteractionsHintSerializationData(du: OEDesignUnit) -> bool

   Returns true if any molecule in the given :oe:cls:`OEBio::OEDesignUnit` has
   the interaction hint serialization data set.

   .. seealso::
    
      * :oe:func:`OEBio::OEDeleteInteractionsHintSerializationData` function
      * :oe:func:`OEBio::OESerializeInteractionsHintContainer` function


.. # split by hand

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEHasPlaceHydrogensMetadata

.. oe:function:: OEHasPlaceHydrogensMetadata

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

      .. oe:api::

         bool OEHasPlaceHydrogensMetadata(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasPlaceHydrogensMetadata(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns ``true`` if metadata has been added to the molecule by
   :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`.

   .. seealso::

      * :oe:func:`OEBio::OEPlaceHydrogens` function
      * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetAddMetadata` method


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEIsReadableDesignUnit

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         bool OEIsReadableDesignUnit(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEIsReadableDesignUnit(filename: str) -> bool

   Returns ``true`` if the supplied file name is readable by
   :oe:func:`OEBio::OEReadDesignUnit`.

   .. seealso::

      * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class
      * :oe:func:`OEBio::OEReadDesignUnit` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsStandardNucleicAcidResidue

.. oe:function:: OEIsStandardNucleicAcidResidue

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

      .. oe:api::

         bool OEIsStandardNucleicAcidResidue(const OEHierResidue& res)
         bool OEIsStandardNucleicAcidResidue(const OEChem::OEResidue& res)
         bool OEIsStandardNucleicAcidResidue(unsigned int resIdx)
         bool OEIsStandardNucleicAcidResidue(const OEChem::OEAtomBase& atom)
         bool OEIsStandardNucleicAcidResidue(const OESystem::OEIter<OEHierResidue>& hit)

   .. oe:language:: python

      .. oe:api:: python

         OEIsStandardNucleicAcidResidue(res: OEResidue) -> bool
         OEIsStandardNucleicAcidResidue(resIdx: int) -> bool
         OEIsStandardNucleicAcidResidue(atom: OEAtomBase) -> bool
         OEIsStandardNucleicAcidResidue(hit: OEHierResidueIter) -> bool

   Returns whether the residue referred to is one of:
   A, C, G, I, T, U, DA, DC, DG, DI, DT, DU Residue indices are provided by
   :oe:func:`OEChem::OEGetResidueIndex`.

   .. seealso::

      * :ref:`OEIsStandardNucleicAcid <OEBio_OEIsStandardNucleicAcid>` class for use as a predicate



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsStandardProteinResidue

.. oe:function:: OEIsStandardProteinResidue

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

      .. oe:api::

         bool OEIsStandardProteinResidue(const OEHierResidue& res)
         bool OEIsStandardProteinResidue(const OEChem::OEResidue& res)
         bool OEIsStandardProteinResidue(unsigned int resIdx)
         bool OEIsStandardProteinResidue(const OEChem::OEAtomBase& atom)
         bool OEIsStandardProteinResidue(const OESystem::OEIter<OEHierResidue>& hit)

   .. oe:language:: python

      .. oe:api:: python

         OEIsStandardProteinResidue(res: OEResidue) -> bool
         OEIsStandardProteinResidue(resIdx: int) -> bool
         OEIsStandardProteinResidue(atom: OEAtomBase) -> bool
         OEIsStandardProteinResidue(hit: OEHierResidueIter) -> bool

   Returns whether the residue referred to is one of:
   ALA, ARG, ASN, ASP, CYS, GLN, GLU, GLY,
   HIS, ILE, LEU, LYS, MET, PHE, PRO, SER, THR, TRP, TYR, VAL, ASX,
   GLX, CYX, CYH, HID, HIE or HIP. Residue indices are provided by
   :oe:func:`OEChem::OEGetResidueIndex`.

   .. seealso::

      * :ref:`OEIsStandardAminoAcid <OEBio_OEIsStandardAminoAcid>` class for use as a predicate


.. # split from OEBioFunctions.rst:439

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsTypicalPrimaryLocationCode

.. oe:function:: OEIsTypicalPrimaryLocationCode

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

      .. oe:api::

         bool OEIsTypicalPrimaryLocationCode(char confCode)

   .. oe:language:: python

      .. oe:api:: python

         OEIsTypicalPrimaryLocationCode(confCode: str) -> bool

   Returns a boolean value indicating whether the alternate location code is one
   of the values typically used to indicate the highest occupancy conformation
   ('A', 'a', or '1') or is blank.




.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsValidActiveSite

..  _oebio_oeisvalidactivesite:

.. oe:function:: OEIsValidActiveSite

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

      .. oe:api::

         bool OEIsValidActiveSite(const OEInteractionHintContainer& asite)

   .. oe:language:: python

      .. oe:api:: python

         OEIsValidActiveSite(asite: OEInteractionHintContainer) -> bool

   Returns true if the interaction container contains exactly two molecules.
   One typed as "ligand" (:ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>`), the other
   as "protein" (:ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>`).

   .. seealso::

       * :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>` class
       * :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>` class

   .. note::

      Valid active sites can be depicted with the **Grapheme TK**

      .. seealso::

         * :oe:func:`OEDocking::OEAddDockingInteractions` function in the **OEDocking TK** manual
         * :oe:func:`OEGrapheme::OEPrepareActiveSiteDepiction` and
           :oe:func:`OEGrapheme::OERenderActiveSite` functions in the **Grapheme TK** manual


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEIsWriteableDesignUnit

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         bool OEIsWriteableDesignUnit(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEIsWriteableDesignUnit(filename: str) -> bool

   Returns ``true`` if the supplied file name is writable by
   :oe:func:`OEBio::OEWriteDesignUnit`.

   .. seealso::

      * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class
      * :oe:func:`OEBio::OEWriteDesignUnit` function


.. # split from OEBioFunctions.rst:461

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEMolComplexChainRoleFactory

.. oe:function:: OEMolComplexChainRoleFactory

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

      .. oe:api::

         OESystem::OERole OEMolComplexChainRoleFactory(char chain)

   .. oe:language:: python

      .. oe:api:: python

         OEMolComplexChainRoleFactory(chain: str) -> OERole

   Returns an :ref:`OERole <OESystem_OERole>` object
   corresponding to the specified chain ID
   for use in constructing a functional role filter.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :ref:`OERole <OESystem_OERole>` class
      * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
      * :oe:func:`OEBio::OERoleMolComplexFilterFactory` function



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEMolComplexFilterFactory

.. oe:function:: OEMolComplexFilterFactory

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

      .. oe:api::

         OEMolComplexFilter OEMolComplexFilterFactory(unsigned category)

   .. oe:language:: python

      .. oe:api:: python

         OEMolComplexFilterFactory(category: int) -> OEMolComplexFilter

   Returns a :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` object corresponding to
   the specified functional role filter category from the
   :oe:constns:`OEBio::OEMolComplexFilterCategory` namespace.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` class
      * :oe:constns:`OEBio::OEMolComplexFilterCategory` namespace
      * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
      * :oe:func:`OEBio::OERoleMolComplexFilterFactory` function


.. # split from OEBioFunctions.rst:496

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEMolComplexModelRoleFactory

.. oe:function:: OEMolComplexModelRoleFactory

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

      .. oe:api::

         OESystem::OERole OEMolComplexModelRoleFactory(unsigned model)

   .. oe:language:: python

      .. oe:api:: python

         OEMolComplexModelRoleFactory(model: int) -> OERole

   Returns an :ref:`OERole <OESystem_OERole>` object
   corresponding to the specified model number
   for use in constructing a functional role filter.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :ref:`OERole <OESystem_OERole>` class
      * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
      * :oe:func:`OEBio::OERoleMolComplexFilterFactory` function



.. # split from OEBioFunctions.rst:513

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEMolComplexOrderRoleFactory

.. oe:function:: OEMolComplexOrderRoleFactory

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

      .. oe:api::

         OESystem::OERole OEMolComplexOrderRoleFactory(unsigned order)

   .. oe:language:: python

      .. oe:api:: python

         OEMolComplexOrderRoleFactory(order: int) -> OERole

   Returns an :ref:`OERole <OESystem_OERole>` object
   corresponding to the specified component order sequence number
   for use in constructing a functional role filter.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :ref:`OERole <OESystem_OERole>` class
      * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
      * :oe:func:`OEBio::OERoleMolComplexFilterFactory` function



.. # split from OEBioFunctions.rst:531

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEMolComplexRoleFactory

.. oe:function:: OEMolComplexRoleFactory

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

      .. oe:api::

         OESystem::OERole OEMolComplexRoleFactory(unsigned category)

   .. oe:language:: python

      .. oe:api:: python

         OEMolComplexRoleFactory(category: int) -> OERole

   Returns a :ref:`OERole <OESystem_OERole>` object corresponding to
   the specified functional role filter category from the
   :oe:constns:`OEBio::OEMolComplexFilterCategory` namespace.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :oe:constns:`OEBio::OEMolComplexFilterCategory` namespace
      * :ref:`OERole <OESystem_OERole>` class
      * :oe:func:`OEBio::OERoleMolComplexFilterFactory` function



.. # split from OEBioFunctions.rst:549

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEMolComplexSiteRoleFactory

.. oe:function:: OEMolComplexSiteRoleFactory

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

      .. oe:api::

         OESystem::OERole OEMolComplexSiteRoleFactory(unsigned site)

   .. oe:language:: python

      .. oe:api:: python

         OEMolComplexSiteRoleFactory(site: int) -> OERole

   Returns an :ref:`OERole <OESystem_OERole>` object
   corresponding to the specified binding site number
   for use in constructing a functional role filter.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :ref:`OERole <OESystem_OERole>` class
      * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
      * :oe:func:`OEBio::OERoleMolComplexFilterFactory` function



.. # split from OEBioFunctions.rst:566

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEMolComplexSurfaceWatersRoleFactory

.. oe:function:: OEMolComplexSurfaceWatersRoleFactory

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

      .. oe:api::

         OESystem::OERole OEMolComplexSurfaceWatersRoleFactory(unsigned site)

   .. oe:language:: python

      .. oe:api:: python

         OEMolComplexSurfaceWatersRoleFactory(site: int) -> OERole

   Returns an :ref:`OERole <OESystem_OERole>` object
   corresponding to the specified binding site number
   for use in constructing a functional role filter for surface waters.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :ref:`OERole <OESystem_OERole>` class
      * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
      * :oe:func:`OEBio::OERoleMolComplexFilterFactory` function



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEPerceiveInteractionHints

..  _oebio_oeperceiveinteractionhints:

.. oe:function:: OEPerceiveInteractionHints

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

      .. oe:api::

         bool OEPerceiveInteractionHints(OEBio::OEInteractionHintContainer& asite)

   .. oe:language:: python

      .. oe:api:: python

         OEPerceiveInteractionHints(asite: OEInteractionHintContainer) -> bool

   Perceives potential interaction types between a protein and a ligand
   stored in the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object using default
   parameters.

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

      .. oe:api::

         bool OEPerceiveInteractionHints(OEBio::OEInteractionHintContainer& asite,
                                         const OEPerceiveInteractionOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEPerceiveInteractionHints(asite: OEInteractionHintContainer,
                                    opts: OEPerceiveInteractionOptions) -> bool

   Perceives potential interaction types between a protein and a ligand
   stored in the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object using the
   given parameters (:ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>`).
   The molecules stored in ``asite`` must have 3D coordinates assigned and should also have radii assigned to the atoms.

   .. seealso::

      * [Kumar-2002]_
      * [Cavallo-2016]_
      * [Bissantz-2010]_
      * [Marcou-2007]_

   The following interaction types are currently perceived:

   * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`    (see also :oe:constns:`OEBio::OECationPiInteractionHintType` namespace)
   * :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`    (see also :oe:constns:`OEBio::OEChelatorInteractionHintType` namespace)
   * :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>`
   * :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`
   * :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>`
   * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` (see also :oe:constns:`OEBio::OEHalogenBondInteractionHintType` namespace)
   * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`       (see also :oe:constns:`OEBio::OEHBondInteractionHintType` namespace)
   * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`  (see also :oe:constns:`OEBio::OESaltBridgeInteractionHintType` namespace)
   * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>`    (see also :oe:constns:`OEBio::OEStackingInteractionHintType` namespace)

   .. admonition:: Code Examples

      * :ref:`section_example_oebio_printinteractions` **OEChem TK** example
      * :ref:`section_examples_summary_complex2img` **Grapheme TK** example
      * `Accessing Interaction Hint Information`_ **OpenEye Python Cookbook** recipe


.. # split from OEBioFunctions.rst:449

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEPerceiveSecondaryStructure

.. oe:function:: OEPerceiveSecondaryStructure

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

      .. oe:api::

         bool OEPerceiveSecondaryStructure(OEChem::OEMolBase& mol,
                                           bool force = false)

   .. oe:language:: python

      .. oe:api:: python

         OEPerceiveSecondaryStructure(mol: Union[OEGraphMol,OEMol,OEQMol],
                                      force: bool = False) -> bool

   Calculates secondary structure for a protein molecule and stores the
   values into the :ref:`OEResidue <OEChem_OEResidue>` objects associated with each
   atom in the protein.  Returns false if no secondary structure assignments
   were made (e.g., when passed a non-protein molecule).
   ``mol`` must have 3D coordinates assigned.



.. # split by hand

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEPlaceHydrogens

..  _OEBio_OEPlaceHydrogens:

.. oe:function:: OEPlaceHydrogens

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

      .. oe:api::

         bool OEPlaceHydrogens(OEChem::OEMolBase& mol,
                               const OEPlaceHydrogensOptions& opts = OEPlaceHydrogensOptions())
         bool OEPlaceHydrogens(OEChem::OEMolBase& mol,
                               OEPlaceHydrogensDetails& details,
                               const OEPlaceHydrogensOptions& opts = OEPlaceHydrogensOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEPlaceHydrogens(mol: Union[OEGraphMol,OEMol,OEQMol],
                          opts: OEPlaceHydrogensOptions = OEPlaceHydrogensOptions()) -> bool
         OEPlaceHydrogens(mol: Union[OEGraphMol,OEMol,OEQMol],
                          details: OEPlaceHydrogensDetails,
                          opts: OEPlaceHydrogensOptions = OEPlaceHydrogensOptions()) -> bool

   Function to modify the input molecule, adding explicit hydrogens
   oriented so as to make hydrogen bonds and, if required,
   "flipping" certain functional groups (e.g. imidazoles and terminal amides)
   that are occasionally misoriented in crystal structures.

   If a :oe:cls:`details<OEBio::OEPlaceHydrogensDetails>` object is passed in,
   it will be updated with information that describes the results.

   **mol**
      The molecule to add hydrogens to. Must have 3D coordinates assigned.

   .. warning::

      Just like :oe:func:`OEChem::OEAddExplicitHydrogens`, this function
      can add hydrogens at the end of the input ``mol``.
      If you require your molecule to be in *PDB order*, you may need to call
      :oe:func:`OEChem::OEPDBOrderAtoms` afterwards.

   .. seealso::

      * :ref:`section_place_hydrogens` section
      * :ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>` class
      * :ref:`OEPlaceHydrogensDetails <OEBio_OEPlaceHydrogensDetails>` class


.. # split from OEBioFunctions.rst:606

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OERMSD

.. oe:function:: OERMSD

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

      .. oe:api::

         double OERMSD(const OEChem::OEMolBase& ref,
                       const OEChem::OEMolBase& fit,
                       OESequenceAlignment& align, bool onlyCAlpha = true,
                       bool overlay = false, double* rot = 0, double* trans = 0)

   .. oe:language:: python

      .. oe:api:: python

         OERMSD(ref: Union[OEGraphMol,OEMol,OEQMol],
                fit: Union[OEGraphMol,OEMol,OEQMol],
                align: OESequenceAlignment, onlyCAlpha: bool = True,
                overlay: bool = False, rot: OEDoubleArray = None,
                trans: OEDoubleArray = None) -> float

   This OEBio :oe:func:`OEBio::OERMSD` function is quite
   analogous to the heavily
   overloaded OEChem :oe:func:`OEChem::OERMSD` functions.
   This function takes two molecules as const
   parameters (one the reference and the other to be fit) and adds
   an additional :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>`
   class parameter that indicates the correspondence between the two molecules.
   Whether the corresponding
   alignment considers all backbone atoms or only alpha carbons is
   controlled by the 'onlyCAlpha' parameter. The 'overlay' parameter
   indicates whether the RMSD should be measured using the current
   coordinates of the two molecules (default) or whether an optimum
   possible RMSD between the two molecules should be calculated. If
   the optimum overlay is calculated, the transformations applied to
   the 'fit' molecule to generate this optimum overlay can be retrieved
   by passing an array of ``double[9]`` to the 'rot' parameter and an array
   of ``double[3]`` to the 'trans' parameter. These two arrays can
   subsequently be applied to the 'fit' molecule using the
   :oe:func:`OEChem::OERotate` and :oe:func:`OEChem::OETranslate` 
   functions if desired. It is important that
   :oe:func:`OEChem::OERotate` and :oe:func:`OEChem::OETranslate` are
   applied in that order.

   The return value is a root-mean square distance between the
   specified atoms in the two molecules.

   **ref**
      The reference molecule. Must have 3D coordinates assigned.

   **fit**
      The molecule to be fitted. Must have 3D coordinates assigned.




.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEReadDesignUnit

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         bool OEReadDesignUnit(const std::string& fname, OEDesignUnit& du)
         bool OEReadDesignUnit(OEPlatform::oeistream& ifs, OEDesignUnit& du,
                               unsigned type = OEDesignUnitFileType::OEDesignUnit)

   .. oe:language:: python

      .. oe:api:: python

         OEReadDesignUnit(fname: str, du: OEDesignUnit) -> bool
         OEReadDesignUnit(ifs: oeistream, du: OEDesignUnit, type: int) -> bool

   Read the contents of the file named ``fname`` into an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` named
   ``du``. Returns ``true`` if an OEDesignUnit was read successfully, and ``false`` otherwise.

   An overload is provided to take any arbitrary
   :ref:`oeistream <OEPlatform_oeistream>`.

   .. seealso::

      * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class
      * :oe:func:`OEBio::OEIsReadableDesignUnit` function
      * :oe:func:`OEBio::OEWriteDesignUnit` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:language:: c++

   .. meta::
      :keywords: OEReadDesignUnitFromString

   .. oe:function:: OEReadDesignUnitFromString
   
      .. attention::
   
         |TWOLANGUAGE|
   
      .. oe:api:: c++
   
         bool OEReadDesignUnitFromString(OEDesignUnit& du,
                                         const std::string& input)
   
      Reads the contents of the string ``input`` into an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
      named ``du``.
      Returns ``true`` if an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` was read successfully,
      and ``false`` otherwise.
   
      .. seealso::
   
         * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class
         * :oe:func:`OEBio::OEReadDesignUnit` function

.. oe:language:: python

   .. meta::
      :keywords: OEReadDesignUnitFromBytes

   .. oe:function:: OEReadDesignUnitFromBytes
   
      .. attention::
   
         |TWOLANGUAGE|
   
      .. oe:api:: python
   
         OEReadDesignUnitFromBytes(du, input) -> bytes
   
      Reads the contents of the bytes ``input`` into an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
      named ``du``.
      Returns ``True`` if an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` was read successfully,
      and ``False`` otherwise.
   
      .. seealso::
   
         * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class
         * :oe:func:`OEBio::OEReadDesignUnit` function


.. # split from OEBioFunctions.rst:584

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OERoleMolComplexFilterFactory

.. oe:function:: OERoleMolComplexFilterFactory

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

      .. oe:api::

         OEMolComplexFilter OERoleMolComplexFilterFactory(const OESystem::OERole& r)

   .. oe:language:: python

      .. oe:api:: python

         OERoleMolComplexFilterFactory(r: OERole) -> OEMolComplexFilter

   Returns a :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` object corresponding to
   the specified :ref:`OERole <OESystem_OERole>`.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :ref:`OERole <OESystem_OERole>` class
      * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
      * :oe:func:`OEBio::OEMolComplexChainRoleFactory` function
      * :oe:func:`OEBio::OEMolComplexModelRoleFactory` function
      * :oe:func:`OEBio::OEMolComplexOrderRoleFactory` function
      * :oe:func:`OEBio::OEMolComplexRoleFactory` function
      * :oe:func:`OEBio::OEMolComplexSiteRoleFactory` function
      * :oe:func:`OEBio::OEMolComplexSurfaceWatersRoleFactory` function



.. # split from OEBioFunctions.rst:639

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OESecondaryStructurePacked

.. oe:function:: OESecondaryStructurePacked

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

      .. oe:api::

         int OESecondaryStructurePacked(int ssType, int ssIDNumber,
                                        int strandID = 0)

   .. oe:language:: python

      .. oe:api:: python

         OESecondaryStructurePacked(ssType: int, ssIDNumber: int,
                                    strandID: int = 0) -> int

   This function packs secondary structure information into an integer suitable
   for use with the :oe:meth:`OEChem::OEResidue::SetSecondaryStructure` method.
   The 'ssType' argument specifies a secondary structure type from the 
   :oe:constns:`OEBio::OESecondaryStructure` namespace.  'ssIDNumber' is an
   ID number for a particular secondary structure element (e.g., helix #2, 
   sheet #7, etc.), and 'strandID' is an ID number for individual strands
   within a beta sheet.  The packed integer return value can also be used
   as an argument to the :ref:`OEHasSecondaryStructure <OEBio_OEHasSecondaryStructure>` predicate,
   to allow identification of all atoms in a specific helix, beta sheet, 
   turn, or strand within a sheet.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OESerializeInteractionsHintContainer

   .. attention::

      |PRELIMINARY-API|

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

      .. oe:api::

         bool OESerializeInteractionsHintContainer(OEChem::OEMolBase& protein,
                                                   OEChem::OEMolBase& ligand,
                                                   const OEInteractionHintContainer& asite)

   .. oe:language:: python

      .. oe:api:: python

         OESerializeInteractionsHintContainer(protein: Union[OEGraphMol,OEMol,OEQMol],
                                              ligand: Union[OEGraphMol,OEMol,OEQMol],
                                              asite: OEInteractionHintContainer) -> bool

   Serializes the interaction hints between a protein and a ligand from a given 
   container and stores the serialized data in the protein and ligand molecules.
   The molecules can then be written to an :file:`.oeb` file and the interaction hints can
   be reconstructed using the :oe:func:`OEBio::OEConstructInteractionHintContainer` function.

   .. seealso::

      * :oe:func:`OEBio::OEConstructInteractionHintContainer` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OESetCrystalSymmetry

.. oe:function:: OESetCrystalSymmetry

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

      .. oe:api::

         bool OESetCrystalSymmetry(OEChem::OEMolBase& mol,
                                   const OECrystalSymmetryParams& params,
                                   bool force = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetCrystalSymmetry(mol: Union[OEGraphMol,OEMol,OEQMol],
                              params: OECrystalSymmetryParams,
                              force: bool = False) -> bool

   Sets the crystal symmetry stored in a :ref:`OECrystalSymmetryParams <OEBio_OECrystalSymmetryParams>`
   object for a given molecule.

   The above functions return ``false`` if the space group number 
   (returned by  :oe:meth:`OEBio::OECrystalSymmetryParams::GetSpaceGroup`) 
   is not found or the symmetry cannot be set on the molecule because the
   constraints on the spacegroup are violated.

   If ``force`` is set to true, then parameters that violate the constraints of
   the given spacegroup will be applied.  (This is sometimes necessary based on 
   slight rounding errors for deposited CRYST1 cards).

   .. note::

      Use this overloaded function in the supported wrapped
      languages: Python, Java and C#.

   **Example:**

   .. oe:source:: OESetCrystalSymmetry.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OESETCRYSTALSYMMETRY

   .. oe:source:: OESetCrystalSymmetry.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OESETCRYSTALSYMMETRY

   .. oe:source:: OESetCrystalSymmetry.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OESETCRYSTALSYMMETRY

   .. oe:source:: OESetCrystalSymmetryDoc.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OESETCRYSTALSYMMETRY

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

      .. oe:api::

         bool OESetCrystalSymmetry(OEChem::OEMolBase& mol, float a, float b,
                                   float c, float alpha, float beta,
                                   float gamma, unsigned int sgnumber,
                                   bool force = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetCrystalSymmetry(mol: Union[OEGraphMol,OEMol,OEQMol], a: float,
                              b: float, c: float, alpha: float, beta: float,
                              gamma: float, sgnumber: int, force: bool = False) -> bool

   Sets the crystal symmetry for a given molecule. 

   The above functions return ``false`` if the indicated space group number is
   not found or the symmetry cannot be set on the molecule because the
   constraints on the spacegroup are violated, such as a=b for tetragonal
   spacegroups.

   If ``force`` is set to true, then parameters that violate the constraints of
   the given spacegroup will be applied.  (This is sometimes necessary based on 
   slight rounding errors for deposited CRYST1 cards).

   .. seealso::

      * :oe:func:`OEBio::OEGetCrystalSymmetry` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OESetDefaultStyle

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         void OESetDefaultStyle(OEDesignUnit& du)

   .. oe:language:: python

      .. oe:api:: python

         OESetDefaultStyle(du: OEDesignUnitImpl) -> None
         OESetDefaultStyle(du: OEDesignUnit) -> None

   Applies a default visual style to all components of the design unit.
   Any previously applied style is first removed (equivalent to calling
   :oe:func:`OEBio::OEClearDesignUnitStyle`), then element-based coloring
   and component-appropriate display styles are set for each tagged
   component (protein, ligand, site residues, near residues, etc.).

   .. seealso::

      * :oe:func:`OEBio::OEClearDesignUnitStyle` function
      * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OESetInteractionsHintSerializationIds

   .. attention::

      |PRELIMINARY-API|

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

      .. oe:api::

         void OESetInteractionsHintSerializationIds(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OESetInteractionsHintSerializationIds(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Sets the interaction hint serialization ids on a molecule. This function
   is useful when serializing interactions for multiple active sites in the same protein.

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

      .. oe:api::

         void OESetInteractionsHintSerializationIds(OEBio::OEDesignUnit& du)

   .. oe:language:: python

      .. oe:api:: python

         OESetInteractionsHintSerializationIds(du: OEDesignUnit) -> None

   Sets the interaction hint serialization ids on all molecules in the given
   :oe:cls:`OEBio::OEDesignUnit`. This is equivalent to calling the molecule
   overload on each component of the design unit.

   .. seealso::
    
      * :oe:func:`OEBio::OEHasInteractionHintSerializationIds` function
      * :oe:func:`OEBio::OEDeleteInteractionsHintSerializationIds` function
      * :oe:func:`OEBio::OESerializeInteractionsHintContainer` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OESetRotamer

.. oe:function:: OESetRotamer

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

      .. oe:api::

         bool OESetRotamer(OEHierResidue& residue, const OERotamer& rotamer)
         bool OESetRotamer(OEAtomBase& atom, const OERotamer& rotamer)

   .. oe:language:: python

      .. oe:api:: python

         OESetRotamer(residue: OEHierResidue, rotamer: OERotamer) -> bool
         OESetRotamer(atom: OEAtomBase, rotamer: OERotamer) -> bool

   Sets the :math:`\chi` angles for the atoms in the specified residue.
   The angles are defined in the :ref:`OERotamer <OEBio_OERotamer>` object
   while the residue is specified either by an :ref:`OEHierResidue <OEBio_OEHierResidue>` object
   or by one of the atoms of the residue (:ref:`OEAtomBase <OEChem_OEAtomBase>`).
   The molecule must have 3D coordinates assigned; side-chain atoms are
   moved in 3D space to match the requested rotamer conformation.

   .. seealso::

      * :ref:`OERotamer <OEBio_OERotamer>` class
      * :oe:func:`OEBio::OEGetRotamers` function



.. # split from OEBioFunctions.rst:687

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OESetTorsion

.. oe:function:: OESetTorsion

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

      .. oe:api::

         bool OESetTorsion(OEHierResidue& res, unsigned torType, double radians)
         bool OESetTorsion(OEChem::OEAtomBase* atom, unsigned torType,
                           double radians,
                           unsigned assume = OEAssumption::Default)

   .. oe:language:: python

      .. oe:api:: python

         OESetTorsion(res: OEHierResidue, torType: int, radians: float) -> bool
         OESetTorsion(atom: OEAtomBase, torType: int, radians: float,
                      assume: int = OEAssumption_Default) -> bool

   Sets one of the standard torsions in a residue to a
   particular value in radians. The specific torsion is indicated by
   passing one of the constants from the :oe:constns:`OEBio::OEProtTorType` namespace into
   the torType parameter. The residue is specified by its
   :ref:`OEHierResidue <OEBio_OEHierResidue>` class or by any
   :ref:`OEAtomBase <OEChem_OEAtomBase>` from the residue.
   The molecule must have 3D coordinates assigned; atoms in the residue are
   moved in 3D space to achieve the requested torsion value.



.. # split from OEBioFunctions.rst:703

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OESetupSplitMolComplexOptions

.. oe:function:: OESetupSplitMolComplexOptions

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

      .. oe:api::

         bool OESetupSplitMolComplexOptions(OESplitMolComplexOptions& opts,
                                            const OESystem::OEInterface& itf,
                                            unsigned siteOverride = OESplitMolComplexParam::DoNotOverride,
                                            unsigned modelOverride = OESplitMolComplexParam::DoNotOverride)

   .. oe:language:: python

      .. oe:api:: python

         OESetupSplitMolComplexOptions(opts: OESplitMolComplexOptions,
                                       itf: OEInterface, siteOverride: int,
                                       modelOverride: int) -> bool

   Initializes an :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>`
   object from the parameters of a given
   :oe:cls:`interface<OESystem::OEInterface>`.

   The parameters ``siteOverride`` and ``modelOverride`` can be used to
   :oe:meth:`ResetFilters<OEBio::OESplitMolComplexOptions::ResetFilters>`
   with values other than that from the interface object. For example, by setting
   ``siteOverride`` to ``0``, filters will be set up to select for *all* sites
   regardless what was specified on the command line and then stored in the interface.
   These parameters are convenient when iterating over sites and/or models
   in a system. By default, these parameters will *not* override the interface object.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :ref:`OEInterface <OESystem_OEInterface>` class
      * :oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters` method
      * :oe:constns:`OEBio::OESplitMolComplexParam` namespace


.. # split from OEBioFunctions.rst:713

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OESplitMolComplex

.. oe:function:: OESplitMolComplex

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

      .. oe:api::

         bool OESplitMolComplex(OEChem::OEMolBase& lig,
                                OEChem::OEMolBase& prot,
                                OEChem::OEMolBase& waters,
                                OEChem::OEMolBase& other,
                                const OEChem::OEMolBase& mol,
                                const OESplitMolComplexOptions& opt = OESplitMolComplexOptions())

   .. oe:language:: python

      .. oe:api:: python

         OESplitMolComplex(lig: Union[OEGraphMol,OEMol,OEQMol],
                           prot: Union[OEGraphMol,OEMol,OEQMol],
                           waters: Union[OEGraphMol,OEMol,OEQMol],
                           other: Union[OEGraphMol,OEMol,OEQMol],
                           mol: Union[OEGraphMol,OEMol,OEQMol],
                           opt: OESplitMolComplexOptions = OESplitMolComplexOptions()) -> bool

   Separates components of the input ``mol`` into the four
   output :ref:`OEMolBase <OEChem_OEMolBase>` categories
   ``lig``, ``prot``, ``waters``, and ``other``
   representing basic elements of a macro-molecular complex.
   The process is controlled by
   an optional :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` object.
   ``Other`` contains everything that is not in ``lig``, ``prot``, or ``waters``,
   all of which are defined by :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` objects
   from :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>`.
   By default, ``lig``, ``prot``, and ``waters`` return components associated
   with the first binding site.
   The filters can be changed so that ``lig``, ``prot``, and ``waters``
   return other types of components; for example, the filters could be set so that
   both the protein and any waters are placed in ``prot``, and any cofactors are
   placed in ``waters``.

   Any molecules returned have been given titles.
   Protein chains are given a shortened version of the input title
   combined with the chain ID. Small molecule titles are
   residue names. Molecules with more than one residue are combined
   with a ``-`` if they are covalently attached, and a ``.`` if not.
   Residue names are not repeated. So, a single two residue
   molecule combined with any number of waters might have
   the title ``XYZ-ABC.HOH``.
   Output molecules may have *SD Tags* to indicate they include
   a covalent ligand.

   Returns ``false`` if the task could not be performed
   (for example, if ``mol`` is empty). To check if a ligand was found,
   check the number of atoms in ``lig``.

   .. warning::

      The input molecule should contain *PDB*
      :ref:`residue information<section_biopolymer_residues>`
      such as residue name, which is used during the
      classification process, either from a PDB format file or
      through :oe:func:`residue perception<OEChem::OEPerceiveResidues>`.
      Molecular complexes read from files in formats that lack this
      information (for example *SDF*) may be split inappropriately unless
      residues are perceived after input.

   .. seealso::

      * :ref:`section_split_mol_complex` section
      * :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` class
      * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class
      * :oe:meth:`OEBio::OESplitMolComplexOptions::GetLigandFilter` method
      * :oe:meth:`OEBio::OESplitMolComplexOptions::GetProteinFilter` method
      * :oe:meth:`OEBio::OESplitMolComplexOptions::GetWaterFilter` method
      * :oe:meth:`OEBio::OESplitMolComplexOptions::GetOtherFilter` method
      * :oe:func:`OEBio::OEGetMolComplexComponents` function
      * :oe:func:`OEBio::OECombineMolComplexFragments` function
      * :oe:func:`OEBio::OEFilterMolComplexFragments` function
      * :oe:func:`OEBio::OECountMolComplexSites` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OESubsetDesignUnit

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         bool OESubsetDesignUnit(OEDesignUnit& du, const OEDesignUnit& refDu,
                                 const unsigned componentMask,
                                 const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred = OEChem::OEIsTrueAtom())

   .. oe:language:: python

      .. oe:api:: python

         OESubsetDesignUnit(du: OEDesignUnit, refDu: OEDesignUnit,
                            componentMask: int,
                            pred: OEUnaryAtomPred = OEIsTrueAtom()) -> bool

   This function generates a fully-functional
   :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object (``du``) as subset of another
   OEDesignUnit (``refDu``) object. An additional bit mask
   (``componentMask``) is required to specify which components should
   be extracted as the subset. The bit mask should be specified from
   constants in the :oe:constns:`OEBio::OEDesignUnitComponents`
   namespace.
   The optional predicate can be used to subset some of the components 
   in the specified bit mask. The predicate does not have to be complete,
   e.g. two water molecules can be specified to subset the solvent category,
   but that will not subset the protein component also included in that mask.
   In essence the predicate is checked to see if it matches part of a design unit
   component and only in this case does it take effect. 

    .. warning::

       If the design unit contains a receptor it will persist in the subset, 
       except if the subset action removes a component that was part of 
       receptor generation mask, see :oe:meth:`OEBio::OEReceptor::GetTargetMask`

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

      .. oe:api::

         bool OESubsetDesignUnit(OEDesignUnit& du,
                                 const unsigned componentMask,
                                 const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred = OEChem::OEIsTrueAtom())
         This function behaves similarly as the above one, but does the subsetting
         on the passed design-unit removing the need for a copy.

   .. oe:language:: python

      .. oe:api:: python

         OESubsetDesignUnit(du: OEDesignUnit, componentMask: int,
                            pred: OEUnaryAtomPred = OEIsTrueAtom()) -> bool

   .. seealso::
      
      * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class
      * :ref:`OEReceptor <OEBio_OEReceptor>` class
      * :oe:constns:`OEBio::OEDesignUnitComponents` namespace
      * :oe:func:`OEBio::OEUpdateDesignUnit` function

   **Examples**

   The example below demonstrate how to use :oe:func:`OEBio::OESubsetDesignUnit`
   to subset an existing :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. oe:source:: DesignUnit.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OESubsetDesignUnit

   .. oe:source:: DesignUnit.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OESubsetDesignUnit


.. # split from OEBioFunctions.rst:766

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OESwapAIEResidueAtoms

.. oe:function:: OESwapAIEResidueAtoms

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

      .. oe:api::

         bool OESwapAIEResidueAtoms(OEChem::OEMolBase& mol, OEHierResidue& res)
         bool OESwapAIEResidueAtoms(OEChem::OEMCMolBase& mol,
                                    OEHierResidue& res)
         bool OESwapAIEResidueAtoms(OEChem::OEMolBase& mol,
                                    OEChem::OEAtomBase* atom,
                                    unsigned assume = OEAssumption::Default)
         bool OESwapAIEResidueAtoms(OEChem::OEMCMolBase& mol,
                                    OEChem::OEAtomBase* atom,
                                    unsigned assume = OEAssumption::Default)

   .. oe:language:: python

      .. oe:api:: python

         OESwapAIEResidueAtoms(mol: Union[OEGraphMol,OEQMol],
                               res: OEHierResidue) -> bool
         OESwapAIEResidueAtoms(mol: OEMol, res: OEHierResidue) -> bool
         OESwapAIEResidueAtoms(mol: Union[OEGraphMol,OEQMol], atom: OEAtomBase,
                               assume: int) -> bool
         OESwapAIEResidueAtoms(mol: OEMol, atom: OEAtomBase, assume: int) -> bool

   The function name :oe:func:`OEBio::OESwapAIEResidueAtoms` stands 
   for ``Swap Ambiguous Isoelectronic Residue Atoms``. 
   This high-level function allows a
   user to easily swap the residues in an atom which may not be fully
   specified by the crystallographic densities. The residues which are
   effected by this function include ASP, ASN, ASX, GLU, GLN, GLX,
   HIS, HIP, HID and HIE.

   The 'assume' argument is a bitmask that indicates whether the
   algorithm can assume that the molecule has perceived residues, has
   PDB ordered atoms, or as bonded residues 
   (see the :oe:constns:`OEBio::OEAssumption` namespace for more information).



.. # split from OEBioFunctions.rst:790

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OESymmetryCartesianToFractional

.. oe:function:: OESymmetryCartesianToFractional

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

      .. oe:api::

         bool OESymmetryCartesianToFractional(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OESymmetryCartesianToFractional(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Converts the Cartesian coordinates of the molecule to
   unit cell fractional coordinates.  Returns false if the molecule does not
   have crystal symmetry.
   ``mol`` must have 3D Cartesian coordinates assigned and crystal symmetry
   set (see :oe:func:`OEBio::OESetCrystalSymmetry`).



.. # split from OEBioFunctions.rst:800

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OESymmetryFractionalToCartesian

.. oe:function:: OESymmetryFractionalToCartesian

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

      .. oe:api::

         bool OESymmetryFractionalToCartesian(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OESymmetryFractionalToCartesian(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Converts the unit cell fractional coordinates of the molecule to
   Cartesian coordinates.  Returns false if the molecule does not
   have crystal symmetry.
   ``mol`` must have 3D fractional coordinates assigned and crystal symmetry
   set (see :oe:func:`OEBio::OESetCrystalSymmetry`).



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OETransformDesignUnit

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         void OETransformDesignUnit(OEDesignUnit& du, const double* rmat,
                                    const double* trns)
         void OETransformDesignUnit(OEDesignUnit& du,
                                    const OEChem::OETrans& trans)

   .. oe:language:: python

      .. oe:api:: python

         OETransformDesignUnit(du: OEDesignUnit, rmat: OEDoubleArray,
                               trns: OEDoubleArray) -> None
         OETransformDesignUnit(du: OEDesignUnit, trans: OETrans) -> None

   Transforms the OEDesignUnit with the provided transforms. The OEDesignUnit object stores the transforms
   applied to it, which can be helpul if the original coordiante frame is required later in a workflow.

    .. warning::

       Applying a transform to a design unit invalidates the :ref:`OEReceptor <OEBio_OEReceptor>` object stored on the design unit
       and it will be removed as part of the transformation.

   .. seealso::

      * :ref:`OETrans <OEChem_OETrans>` class
      * :ref:`OEReceptor <OEBio_OEReceptor>` class
      * :oe:meth:`OEBio::OEDesignUnit::GetTransform` method


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

..  _OEBio_OEUpdateDesignUnit:

.. oe:function:: OEUpdateDesignUnit

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         bool OEUpdateDesignUnit(OEDesignUnit& du,
                                 const OEChem::OEMolBase& mol,
                                 const unsigned componentId,
                                 const bool retainStyle = false,
                                 const int listIndex = -1)

   .. oe:language:: python

      .. oe:api:: python

         OEUpdateDesignUnit(du: OEDesignUnit,
                            mol: Union[OEGraphMol,OEMol,OEQMol],
                            componentId: int, retainStyle: bool = False,
                            listIndex: int = -1) -> bool

   This function updates an existing :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
   object ``du`` by setting the component given by ``componentId``
   with the input molecule ``mol``, the input molecule must be valid (not empty). 
   The component ID should be specified from constants in the 
   :oe:constns:`OEBio::OEDesignUnitComponents` namespace.
   The optional parameter ``retainStyle`` retains the style on the input molecule, 
   otherwise undergoes standard OEDesignUnit object styling (default).
   If the update function is called with an empty molecule the function returns false.
   In the event the update operation fails due to the inability to update a specific component,
   the function returns false, and the input ``du`` is cleared.
   
    .. note::

       List components, co-factors, excipients etc. are updated by appending to the list. 
       To modify one of them, we recommend getting all the molecule components from a 
       list (e.g. co-facors), clearing that component in the designunit and adding
       the co-factors back where one or more have been modified.

    .. warning::

       Updating the content of a design unit invalidates the :ref:`OEReceptor <OEBio_OEReceptor>` object stored on the design unit
       and it will be removed as part of the update.

   .. seealso::
      
      * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class
      * :oe:constns:`OEBio::OEDesignUnitComponents` namespace
      * :oe:func:`OEBio::OESubsetDesignUnit` function

   **Examples**

   The example below demonstrate how to use
   :oe:func:`OEBio::OEUpdateDesignUnit` to
   update an existing :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

   .. oe:source:: DesignUnit.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEUpdateDesignUnit

   .. oe:source:: DesignUnit.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEUpdateDesignUnit


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEBio

.. meta::
   :keywords: OEWriteAlignment

.. oe:function:: OEWriteAlignment

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

      .. oe:api::

         bool OEWriteAlignment(OEPlatform::oeostream& os,
                               const OESequenceAlignment& align,
                               unsigned int width = 50)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteAlignment(ofs: oeostream, align: OESequenceAlignment,
                          width: int = 50) -> bool

   Generates a version of the standard formatted text
   representation of sequence alignments.

   *os*
      The stream into which the sequence alignment is being written.

   *align*
      The :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` object

   *width*
      The width of the output.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:function:: OEWriteDesignUnit

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         bool OEWriteDesignUnit(const std::string& fname,
                                const OEDesignUnit& du)
         bool OEWriteDesignUnit(OEPlatform::oeostream& ofs,
                                const OEDesignUnit& du)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteDesignUnit(fname: str, du: OEDesignUnit) -> bool
         OEWriteDesignUnit(ofs: oeostream, du: OEDesignUnit) -> bool

   Write an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` named
   ``du`` to an OEDesignUnit (.oedu) file ``fname``. This will overwrite the
   previous file if it existed.

   The overload that takes an :oe:func:`OEPlatform::oeostream` can be
   used to write multiple :oe:cls:`OEDesignUnits<OEBio::OEDesignUnit>`
   to the same destination.
   Note that the format must be specified by a constant from the
   :oe:const:`OEBio::OEDesignUnitFileType` namespace as the type
   argument.

   The function returns ``true`` if the file was written
   successfully, and ``false`` otherwise.

   .. seealso::

      * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class
      * :oe:func:`OEBio::OEIsWriteableDesignUnit` function
      * :oe:func:`OEBio::OEReadDesignUnit` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBio

.. oe:language:: c++

   .. meta::
      :keywords: OEWriteDesignUnitToString

   .. oe:function:: OEWriteDesignUnitToString

      .. attention::

         |TWOLANGUAGE|

      .. oe:api:: c++

         std::string OEWriteDesignUnitToString(const OEDesignUnit& du)

      Write an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` named ``du`` to a string.

      .. seealso::

         * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class
         * :oe:func:`OEBio::OEWriteDesignUnit` function

.. oe:language:: python

   .. meta::
      :keywords: OEWriteDesignUnitToBytes

   .. oe:function:: OEWriteDesignUnitToBytes

      .. attention::

         |TWOLANGUAGE|

      .. oe:api:: python

         OEWriteDesignUnitToBytes(du) -> bytes

      Write an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` named ``du`` to bytes.

      .. seealso::

         * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class
         * :oe:func:`OEBio::OEWriteDesignUnit` function

.. oe:language:: python

   .. meta::
      :keywords: OEWriteMolToBytes



*******************************************************************************
OEBio Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEAtomMatchResidueIDToString.rst
   OEBuildUnitCell.rst
   OECalculateDPI.rst
   OEClearDesignUnitStyle.rst
   OEClearMolComplexSDData.rst
   OEClearPlaceHydrogensMetadata.rst
   OECombineMolComplexFragments.rst
   OEConfigureSplitMolComplexOptions.rst
   OECopyCrystalSymmetry.rst
   OECountMolComplexSites.rst
   OEExpandCrystalSymmetry.rst
   OEFilterMolComplexFragments.rst
   OEGetActiveSiteInteractionHintTypes.rst
   OEGetAlignmentMethodName.rst
   OEGetAlignment.rst
   OEGetAlignments.rst
   OEGetAtomMatchResidueIDs.rst
   OEGetCalculatedInteractionGeometries.rst
   OEGetChis.rst
   OEGetCrystalSymmetry.rst
   OEGetDesignUnitComponentID.rst
   OEGetDesignUnitComponentName.rst
   OEGetDesignUnitComponentNamesFromMask.rst
   OEGetInteractions.rst
   OEGetIridiumCategoryFromName.rst
   OEGetIridiumCategoryName.rst
   OEGetMolComplexComponents.rst
   OEGetMolComplexFilterCategoryName.rst
   OEGetMolComplexFragments.rst
   OEGetPhi.rst
   OEGetPlaceHydrogensMetadata.rst
   OEGetPlaceHydrogensMoverClassName.rst
   OEGetProteinTorsionName.rst
   OEGetPsi.rst
   OEGetRamachandranCategoryName.rst
   OEGetRamachandranTypeName.rst
   OEGetResidueAtom.rst
   OEGetResidueAtoms.rst
   OEGetResidueDatabaseCategoryName.rst
   OEGetResidues.rst
   OEGetRotamers.rst
   OEGetSecondaryStructureID.rst
   OEGetSecondaryStructureName.rst
   OEGetSecondaryStructureStrandID.rst
   OEGetSecondaryStructureType.rst
   OEGetSimpleAlignment.rst
   OEGetSpaceGroupNumber.rst
   OEGetSpaceGroup.rst
   OEGetTorsion.rst
   OEHasBondedResidues.rst
   OEHasCrystalSymmetry.rst
   OEHasPlaceHydrogensMetadata.rst
   OEIsReadableDesignUnit.rst
   OEIsStandardNucleicAcidResidue.rst
   OEIsStandardProteinResidue.rst
   OEIsTypicalPrimaryLocationCode.rst
   OEIsValidActiveSite.rst
   OEIsWriteableDesignUnit.rst
   OEMolComplexChainRoleFactory.rst
   OEMolComplexFilterFactory.rst
   OEMolComplexModelRoleFactory.rst
   OEMolComplexOrderRoleFactory.rst
   OEMolComplexRoleFactory.rst
   OEMolComplexSiteRoleFactory.rst
   OEMolComplexSurfaceWatersRoleFactory.rst
   OEPerceiveInteractionHints.rst
   OEPerceiveSecondaryStructure.rst
   OEPlaceHydrogens.rst
   OEReadDesignUnit.rst
   OERMSD.rst
   OERoleMolComplexFilterFactory.rst
   OESecondaryStructurePacked.rst
   OESetCrystalSymmetry.rst
   OESetDefaultStyle.rst
   OESetRotamer.rst
   OESetTorsion.rst
   OESetupSplitMolComplexOptions.rst
   OESplitMolComplex.rst
   OESubsetDesignUnit.rst
   OESwapAIEResidueAtoms.rst
   OESymmetryCartesianToFractional.rst
   OESymmetryFractionalToCartesian.rst
   OEWriteAlignment.rst
   OETransformDesignUnit.rst
   OEUpdateDesignUnit.rst
   OEWriteDesignUnit.rst

.. oe:language:: c++ python

   .. toctree::
      :maxdepth: 1

      OEReadDesignUnitFromString.rst
      OEWriteDesignUnitToString.rst

*******************************************************************************
Preliminary OEBio Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEConstructInteractionHintContainer
   OEDeleteInteractionsHintSerializationData
   OEDeleteInteractionsHintSerializationIds
   OEHasInteractionHintSerializationIds
   OEHasInteractionsHintSerializationData
   OESerializeInteractionsHintContainer
   OESetInteractionsHintSerializationIds


.. oe:namespace:: OEChem

.. meta::
   :keywords: OE2DRingDictionary, 2DRingDictionary

.. _OEChem_OE2DRingDictionary:

.. oe:class:: OE2DRingDictionary

   .. oe:api::

      class OE2DRingDictionary

   This class represents :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` that
   stores ring system layouts *i.e.* templates that can be plugged
   into the 2D coordinate generation system.

   .. seealso::

      * :ref:`chapter_2D_coordinates` chapter
      * :ref:`OE2DRingDictionaryCreatorOptions <OEChem_OE2DRingDictionaryCreatorOptions>` class
      * :oe:func:`OEChem::OEGenerate2DCoordinates` function
      * :oe:func:`OEChem::OEWrite2DRingDictionary` function

      The following **OEChem TK** examples illustrate how to create and utilize
      user-defined ring layouts:

      .. oe:language:: c++

         * Example program :ref:`createringdict.cpp<section_example_oechem_createringdict>`
         * Example program :ref:`appendringdict.cpp<section_example_oechem_appendringdict>`
         * Example program :ref:`generate2D.cpp<section_example_oechem_generate2D>`

      .. oe:language:: python

         * Example program :ref:`createringdict.py<section_example_oechem_createringdict>`
         * Example program :ref:`appendringdict.py<section_example_oechem_appendringdict>`
         * Example program :ref:`generate2D.py<section_example_oechem_generate2D>`

      .. oe:language:: java

         * Example program :ref:`CreateRingDict.java<section_example_oechem_createringdict>`
         * Example program :ref:`AppendRingDict.java<section_example_oechem_appendringdict>`
         * Example program :ref:`Generate2D.java<section_example_oechem_generate2D>`

      .. oe:language:: csharp

         * Example program :ref:`CreateRingDict.cs<section_example_oechem_createringdict>`
         * Example program :ref:`AppendRingDict.cs<section_example_oechem_appendringdict>`
         * Example program :ref:`Generate2D.cs<section_example_oechem_generate2D>`

      The following **OEDepict TK** example shows how to generate a multi-page PDF
      report of user-defined ring layouts:

      .. oe:language:: c++

         * Example program :ref:`ringdict2pdf.cpp<section_examples_summary_ringdict2pdf>`

      .. oe:language:: python

         * Example program :ref:`ringdict2pdf.py<section_examples_summary_ringdict2pdf>`

       .. oe:language:: java

         * Example program :ref:`RingDict2PDF.java<section_examples_summary_ringdict2pdf>`

       .. oe:language:: java

         * Example program :ref:`RingDict2PDF.cs<section_examples_summary_ringdict2pdf>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OE2DRingDictionary()

      .. oe:language:: python

         .. oe:api:: python

            OE2DRingDictionary() -> OE2DRingDictionary

      Default constructor that creates an empty ring template dictionary
      with default parameters.

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

         .. oe:api::

            OE2DRingDictionary(const OE2DRingDictionaryCreatorOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            OE2DRingDictionary(opts: OE2DRingDictionaryCreatorOptions) -> OE2DRingDictionary

      Constructs an empty ring dictionary with the given parameters.

      .. seealso::

         * :ref:`OE2DRingDictionaryCreatorOptions <OEChem_OE2DRingDictionaryCreatorOptions>` class

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

         .. oe:api::

            OE2DRingDictionary(oemolistream& ims)
            OE2DRingDictionary(const std::string& filename)

      .. oe:language:: python

         .. oe:api:: python

            OE2DRingDictionary(filename: str) -> OE2DRingDictionary
            OE2DRingDictionary(ims: oemolistream) -> OE2DRingDictionary

      Initializes a ring dictionary from a binary file written by the
      :oe:func:`OEChem::OEWrite2DRingDictionary` function.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE2DRingDictionary & operator=(const OE2DRingDictionary & rhs)

      Assignment operator.

   .. ################################################################
      # AddRings
      ################################################################

   .. oe:method:: AddRings

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

         .. oe:api::

            unsigned int AddRings(const OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            AddRings(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Returns the number of ring systems extracted from the given
      molecule and adds them to the dictionary.

      **mol**
         The molecule **with 2D** coordinates.

      By default, the rings are extracted and added to the dictionary by the
      following rules:

      * A ring system will be added to the dictionary even if a corresponding
        layout already exists in the built-in ring dictionary *i.e.* user-defined
        layout will have higher priority.
      * If a ring system already exists in the given dictionary then the new
        ring template will be ignored *i.e* first-come first-register.
      * If a ring system has specified cis/trans bond stereo configuration then
        two layouts could be added to the ring dictionary: one with the cis/trans
        bond stereo configuration and one pure carbon skeleton framework without
        any bond stereo configuration.

      The rules above can be altered when the ring dictionary is constructed
      via the :ref:`OE2DRingDictionaryCreatorOptions <OEChem_OE2DRingDictionaryCreatorOptions>` class.

   .. ################################################################
      # NumRings
      ################################################################

   .. oe:method:: NumRings

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

         .. oe:api::

            unsigned int NumRings() const

      .. oe:language:: python

         .. oe:api:: python

            NumRings() -> int

      Returns the number of rings stored in the dictionary.


.. oe:namespace:: OEChem

.. _OEChem_OE2DRingDictionaryCreatorOptions:

.. oe:class:: OE2DRingDictionaryCreatorOptions

   .. oe:api::

      class OE2DRingDictionaryCreatorOptions

   This class represents the :ref:`OE2DRingDictionaryCreatorOptions <OEChem_OE2DRingDictionaryCreatorOptions>` class
   that encapsulates properties that determine how a ring template is added to
   a ring template dictionary (:ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>`).

   .. seealso::

      * :ref:`chapter_2D_coordinates` chapter
      * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
      * :oe:func:`OEChem::OEWrite2DRingDictionary` function

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OE2DRingDictionaryCreatorOptions()

      .. oe:language:: python

         .. oe:api:: python

            OE2DRingDictionaryCreatorOptions() -> OE2DRingDictionaryCreatorOptions

      Default constructor.

      An :ref:`OE2DRingDictionaryCreatorOptions <OEChem_OE2DRingDictionaryCreatorOptions>` object is initialized
      with the following default parameters:

      * A ring system will be added to the dictionary even if a corresponding
        layout already exists in the built-in ring dictionary *i.e.* user-defined
        layout will have higher priority.

        See also :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetRetainExistingBuiltInTemplates`
        method.

      * If a ring system already exists in the given dictionary then the new
        ring template will be ignored *i.e* first-come first-register.

        See also :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetRetainExistingTemplates`
        method.

      * If a ring system has specified cis/trans bond stereo configuration then
        two layouts could be added to the ring dictionary: one with the cis/trans
        bond stereo configuration and one pure carbon skeleton without
        any bond stereo configuration.

        See also :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetAddCarbonSkeleton`
        and :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetAddCarbonSkeletonWithBondStereo`
        methods.

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

         .. oe:api::

            OE2DRingDictionaryCreatorOptions(const OE2DRingDictionaryCreatorOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DRingDictionaryCreatorOptions(rhs: OE2DRingDictionaryCreatorOptions) -> OE2DRingDictionaryCreatorOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE2DRingDictionaryCreatorOptions &operator=(const OE2DRingDictionaryCreatorOptions &rhs)

      Assignment operator.

   .. oe:method:: GetAddCarbonSkeleton

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

         .. oe:api::

            bool GetAddCarbonSkeleton() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddCarbonSkeleton() -> bool

      Returns whether the carbon skeleton of a ring system is added to 
      the dictionary.
      The default value is ``true``.

      .. seealso::

         * :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetAddCarbonSkeleton` method

   .. oe:method:: GetAddCarbonSkeletonWithBondStereo

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

         .. oe:api::

            bool GetAddCarbonSkeletonWithBondStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddCarbonSkeletonWithBondStereo() -> bool

      Returns whether the carbon skeleton of a ring system retaining 
      cis/trans bond stereo configuration is added to the dictionary.
      The default value is ``true``.

      .. seealso::

         * :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetAddCarbonSkeletonWithBondStereo` method

   .. oe:method:: GetRetainExistingBuiltInTemplates

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

         .. oe:api::

            bool GetRetainExistingBuiltInTemplates() const

      .. oe:language:: python

         .. oe:api:: python

            GetRetainExistingBuiltInTemplates() -> bool

      Sets whether a ring system will be added to the dictionary
      even if a corresponding layout already exists in the built-in ring
      dictionary.

      .. seealso::

         * :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetRetainExistingBuiltInTemplates` method

   .. oe:method:: GetRetainExistingTemplates

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

         .. oe:api::

            bool GetRetainExistingTemplates() const

      .. oe:language:: python

         .. oe:api:: python

            GetRetainExistingTemplates() -> bool

      Returns whether to override the ring template that already
      exists in the dictionary.

      .. seealso::

         * :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetRetainExistingTemplates` method

   .. oe:method:: SetAddCarbonSkeleton

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

         .. oe:api::

            void SetAddCarbonSkeleton(bool add)

      .. oe:language:: python

         .. oe:api:: python

            SetAddCarbonSkeleton(arg2: bool) -> None

      Sets whether the carbon skeleton of a ring system is added
      to the dictionary.

      .. figure:: oechemtk/images/OE2DRingDictionaryCreatorOptions_AddCarbonSkeleton.*
         :align: center

         **Example of extracting the carbon skeleton of a ring system**

   .. oe:method:: SetAddCarbonSkeletonWithBondStereo

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

         .. oe:api::

            void SetAddCarbonSkeletonWithBondStereo(bool add)

      .. oe:language:: python

         .. oe:api:: python

            SetAddCarbonSkeletonWithBondStereo(arg2: bool) -> None

      Sets whether the carbon skeleton of a ring system retaining 
      cis/trans bond stereo configuration is added to the dictionary.
      The default value is ``true``.

      .. figure:: oechemtk/images/OE2DRingDictionaryCreatorOptions_AddCarbonSkeletonWithBondStereo.*
         :align: center

         **Example of extracting the carbon skeleton of a ring system with
         cis/trans bond stereo configuration**

   .. oe:method:: SetRetainExistingBuiltInTemplates

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

         .. oe:api::

            void SetRetainExistingBuiltInTemplates(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRetainExistingBuiltInTemplates(arg2: bool) -> None

      Sets whether a ring system will be added to the dictionary
      even if a corresponding layout already exists in the built-in ring
      dictionary.
      The default value is ``false`` i.e. user-defined ring layouts will
      have higher priority than the built-in ring templates.

   .. oe:method:: SetRetainExistingTemplates

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

         .. oe:api::

            void SetRetainExistingTemplates(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRetainExistingTemplates(arg2: bool) -> None

      Sets whether to override the ring template that already
      exists in the dictionary.
      The default value is ``false`` i.e. the new user-defined
      ring template will be ignored.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OE3DMolStyle, 3DMolStyle, MolStyle

.. _OEChem_OE3DMolStyle:

.. oe:class:: OE3DMolStyle

   .. oe:api::

      class OE3DMolStyle

   This class represents `OE3DMolStyle`.

   The :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` class is the abstract interface for
   representing a 3D molecule style within *OEChem*.

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OE3DMolStyle()
            OE3DMolStyle(const OE3DMolStyle& other)

      .. oe:language:: python

         .. oe:api:: python

            OE3DMolStyle() -> OE3DMolStyle
            OE3DMolStyle(other: OE3DMolStyle) -> OE3DMolStyle

      Default and copy constructors.

   .. oe:method:: operator<
      :language: c++

      .. oe:api::

         bool operator<(const OE3DMolStyle &rhs) const

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE3DMolStyle &operator=(const OE3DMolStyle &rhs)

      Assignment operator.

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OE3DMolStyle &rhs) const

.. _OEChem_OE3DMolStyle_ClearAtomColorer:

   .. oe:method:: ClearAtomColorer

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

         .. oe:api::

            void ClearAtomColorer()

      .. oe:language:: python

         .. oe:api:: python

            ClearAtomColorer() -> None

      Clears the value of the atom color scheme set to the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearAtomLabelColorer:

   .. oe:method:: ClearAtomLabelColorer

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

         .. oe:api::

            void ClearAtomLabelColorer()

      .. oe:language:: python

         .. oe:api:: python

            ClearAtomLabelColorer() -> None

      Clears the value of the color set for the atom label of the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearAtomLabelDataTag:

   .. oe:method:: ClearAtomLabelDataTag

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

         .. oe:api::

            void ClearAtomLabelDataTag()

      .. oe:language:: python

         .. oe:api:: python

            ClearAtomLabelDataTag() -> None

      Clears the value of the data tag set for the atom label of the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearAtomLabelText:

   .. oe:method:: ClearAtomLabelText

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

         .. oe:api::

            void ClearAtomLabelText()

      .. oe:language:: python

         .. oe:api:: python

            ClearAtomLabelText() -> None

      Clears the value of the text set for the atom label of the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearAtomLabelType:

   .. oe:method:: ClearAtomLabelType

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

         .. oe:api::

            void ClearAtomLabelType()

      .. oe:language:: python

         .. oe:api:: python

            ClearAtomLabelType() -> None

      Clears the value of the lable type set for the atoms of the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearAtomStyle:

   .. oe:method:: ClearAtomStyle

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

         .. oe:api::

            void ClearAtomStyle()

      .. oe:language:: python

         .. oe:api:: python

            ClearAtomStyle() -> None

      Clears the value of the atom type set for the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearContourStyle:

   .. oe:method:: ClearContourStyle

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

         .. oe:api::

            void ClearContourStyle()

      .. oe:language:: python

         .. oe:api:: python

            ClearContourStyle() -> None

      Clears the value of the contour type set for the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearGridContourColorer:

   .. oe:method:: ClearGridContourColorer

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

         .. oe:api::

            void ClearGridContourColorer()

      .. oe:language:: python

         .. oe:api:: python

            ClearGridContourColorer() -> None

      Clears the value of the contour type set for the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearGridType:

   .. oe:method:: ClearGridType

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

         .. oe:api::

            void ClearGridType()

      .. oe:language:: python

         .. oe:api:: python

            ClearGridType() -> None

      Clears the value of the grid type set for the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearHydrogenVisibility:

   .. oe:method:: ClearHydrogenVisibility

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

         .. oe:api::

            void ClearHydrogenVisibility()

      .. oe:language:: python

         .. oe:api:: python

            ClearHydrogenVisibility() -> None

      Clears the value of the hydrogen visibility set for the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearInteractionStyle:

   .. oe:method:: ClearInteractionStyle

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

         .. oe:api::

            void ClearInteractionStyle()

      .. oe:language:: python

         .. oe:api:: python

            ClearInteractionStyle() -> None

      Clears the value of the interaction style set for the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearProteinColorer:

   .. oe:method:: ClearProteinColorer

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

         .. oe:api::

            void ClearProteinColorer()

      .. oe:language:: python

         .. oe:api:: python

            ClearProteinColorer() -> None

      Clears the value of the color set for the proteins of the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearProteinStyle:

   .. oe:method:: ClearProteinStyle

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

         .. oe:api::

            void ClearProteinStyle()

      .. oe:language:: python

         .. oe:api:: python

            ClearProteinStyle() -> None

      Clears the value of the style set for the proteins of the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearSurfaceAlpha:

   .. oe:method:: ClearSurfaceAlpha

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

         .. oe:api::

            void ClearSurfaceAlpha()

      .. oe:language:: python

         .. oe:api:: python

            ClearSurfaceAlpha() -> None

      Clears the value of the surface alpha set for the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearSurfaceColorer:

   .. oe:method:: ClearSurfaceColorer

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

         .. oe:api::

            void ClearSurfaceColorer()

      .. oe:language:: python

         .. oe:api:: python

            ClearSurfaceColorer() -> None

      Clears the value of the color set for the surface of the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearSurfaceStyle:

   .. oe:method:: ClearSurfaceStyle

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

         .. oe:api::

            void ClearSurfaceStyle()

      .. oe:language:: python

         .. oe:api:: python

            ClearSurfaceStyle() -> None

      Clears the value of the cstyle set for the surface of the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_ClearSurfaceType:

   .. oe:method:: ClearSurfaceType

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

         .. oe:api::

            void ClearSurfaceType()

      .. oe:language:: python

         .. oe:api:: python

            ClearSurfaceType() -> None

      Clears the value of the surface type for the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_FromString:

   .. oe:method:: FromString

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

         .. oe:api::

            bool FromString(const std::string& str)

      .. oe:language:: python

         .. oe:api:: python

            FromString(str: str) -> bool

.. _OEChem_OE3DMolStyle_GetAtomColorer:

   .. oe:method:: GetAtomColorer

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

         .. oe:api::

            const OEMolStyleColorer& GetAtomColorer() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomColorer() -> OEMolStyleColorer

      Returns an OEMolStyleColorer that specifies the color of the atoms set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetAtomLabelColorer:

   .. oe:method:: GetAtomLabelColorer

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

         .. oe:api::

            const OEMolStyleColorer& GetAtomLabelColorer() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelColorer() -> OEMolStyleColorer

      Returns an OEMolStyleColorer that specifies the color of the atom label set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetAtomLabelDataTag:

   .. oe:method:: GetAtomLabelDataTag

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

         .. oe:api::

            std::string GetAtomLabelDataTag() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelDataTag() -> str

      Returns a string that specifies the data tag of the atom label set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetAtomLabelPrecision:

   .. oe:method:: GetAtomLabelPrecision

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

         .. oe:api::

            unsigned int GetAtomLabelPrecision() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelPrecision() -> int

      Returns an integer that correlates to the precision of the atom label set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetAtomLabelText:

   .. oe:method:: GetAtomLabelText

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

         .. oe:api::

            std::string GetAtomLabelText() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelText() -> str

      Returns a string of the atom label specified in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetAtomLabelTyow:

   .. oe:method:: GetAtomLabelType

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

         .. oe:api::

            unsigned int GetAtomLabelType() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelType() -> int

      Returns an integer that specifies the atom label type set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetAtomStyle:

   .. oe:method:: GetAtomStyle

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

         .. oe:api::

            unsigned int GetAtomStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomStyle() -> int

      Returns an integer that specifies the atom style set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetContourStyle:

   .. oe:method:: GetContourStyle

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

         .. oe:api::

            unsigned int GetContourStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetContourStyle() -> int

      Returns an integer that specifies the contour style set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetGridContourColorer:

   .. oe:method:: GetGridContourColorer

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

         .. oe:api::

            const OEMolStyleColorer& GetGridContourColorer() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridContourColorer() -> OEMolStyleColorer

      Returns an OEMolStyleColorer that specifies the color scheme of the grid contour set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetGridType:

   .. oe:method:: GetGridType

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

         .. oe:api::

            unsigned int GetGridType() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridType() -> int

      Returns an integer that specifies the grid type set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetHydrogenVisibility:

   .. oe:method:: GetHydrogenVisibility

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

         .. oe:api::

            unsigned int GetHydrogenVisibility() const

      .. oe:language:: python

         .. oe:api:: python

            GetHydrogenVisibility() -> int

      Returns an integer that specifies the hydrogen visibility set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetInteractionStyle:

   .. oe:method:: GetInteractionStyle

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

         .. oe:api::

            unsigned int GetInteractionStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetInteractionStyle() -> int

      Returns an integer that specifies the interaction style set in the OE3DMolStyle.

   .. oe:method:: GetProteinColorer

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

         .. oe:api::

            const OEMolStyleColorer& GetProteinColorer() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinColorer() -> OEMolStyleColorer

      Returns an OEMolStyleColorer that specifies the color scheme of the proteins set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetProteinStyle:

   .. oe:method:: GetProteinStyle

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

         .. oe:api::

            unsigned int GetProteinStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinStyle() -> int

      Returns an integer that specifies the protein style set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetString:

   .. oe:method:: GetString

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

         .. oe:api::

            std::string GetString() const

      .. oe:language:: python

         .. oe:api:: python

            GetString() -> str

.. _OEChem_OE3DMolStyle_GetSurfaceAlpha:

   .. oe:method:: GetSurfaceAlpha

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

         .. oe:api::

            unsigned int GetSurfaceAlpha() const

      .. oe:language:: python

         .. oe:api:: python

            GetSurfaceAlpha() -> int

      Returns an integer that specifies the surface alpha set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetSurfaceColorer:

   .. oe:method:: GetSurfaceColorer

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

         .. oe:api::

            const OEMolStyleColorer& GetSurfaceColorer() const

      .. oe:language:: python

         .. oe:api:: python

            GetSurfaceColorer() -> OEMolStyleColorer

      Returns an OEMolStyleColorer that specifies the color scheme of the surface set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetSurfaceStyle:

   .. oe:method:: GetSurfaceStyle

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

         .. oe:api::

            unsigned int GetSurfaceStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetSurfaceStyle() -> int

      Returns an integer that specifies the surface style set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_GetSurfaceType:

   .. oe:method:: GetSurfaceType

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

         .. oe:api::

            unsigned int GetSurfaceType() const

      .. oe:language:: python

         .. oe:api:: python

            GetSurfaceType() -> int

      Returns an integer that specifies the surface type set in the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_HasAtomColorer:

   .. oe:method:: HasAtomColorer

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

         .. oe:api::

            bool HasAtomColorer() const

      .. oe:language:: python

         .. oe:api:: python

            HasAtomColorer() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set atom colorer.

.. _OEChem_OE3DMolStyle_HasAtomLabelColorer:

   .. oe:method:: HasAtomLabelColorer

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasAtomLabelColorer() const

      .. oe:language:: python

         .. oe:api:: python

            HasAtomLabelColorer() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set atom label colorer.

.. _OEChem_OE3DMolStyle_HasAtomLabelDataTag:

   .. oe:method:: HasAtomLabelDataTag

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasAtomLabelDataTag() const

      .. oe:language:: python

         .. oe:api:: python

            HasAtomLabelDataTag() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set atom label data tag.

.. _OEChem_OE3DMolStyle_HasAtomLabelText:

   .. oe:method:: HasAtomLabelText

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasAtomLabelText() const

      .. oe:language:: python

         .. oe:api:: python

            HasAtomLabelText() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set atom label text.

.. _OEChem_OE3DMolStyle_HasAtomLabelType:

   .. oe:method:: HasAtomLabelType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasAtomLabelType() const

      .. oe:language:: python

         .. oe:api:: python

            HasAtomLabelType() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set atom label type.

.. _OEChem_OE3DMolStyle_HasAtomStyle:

   .. oe:method:: HasAtomStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasAtomStyle() const

      .. oe:language:: python

         .. oe:api:: python

            HasAtomStyle() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set atom style.

.. _OEChem_OE3DMolStyle_HasContourStyle:

   .. oe:method:: HasContourStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasContourStyle() const

      .. oe:language:: python

         .. oe:api:: python

            HasContourStyle() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set contour style.

.. _OEChem_OE3DMolStyle_HasGridContourColorer:

   .. oe:method:: HasGridContourColorer

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasGridContourColorer() const

      .. oe:language:: python

         .. oe:api:: python

            HasGridContourColorer() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set grid contour colorer.

.. _OEChem_OE3DMolStyle_HasGridType:

   .. oe:method:: HasGridType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasGridType() const

      .. oe:language:: python

         .. oe:api:: python

            HasGridType() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set grid type.

.. _OEChem_OE3DMolStyle_HasHydrogenVisibility:

   .. oe:method:: HasHydrogenVisibility

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasHydrogenVisibility() const

      .. oe:language:: python

         .. oe:api:: python

            HasHydrogenVisibility() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set hydrogen visibility.

.. _OEChem_OE3DMolStyle_HasInteractionStyle:

   .. oe:method:: HasInteractionStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasInteractionStyle() const

      .. oe:language:: python

         .. oe:api:: python

            HasInteractionStyle() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set interaction style.

.. _OEChem_OE3DMolStyle_HasProteinColorer:

   .. oe:method:: HasProteinColorer

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasProteinColorer() const

      .. oe:language:: python

         .. oe:api:: python

            HasProteinColorer() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set protein colorer.

.. _OEChem_OE3DMolStyle_HasProteinStyle:

   .. oe:method:: HasProteinStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasProteinStyle() const

      .. oe:language:: python

         .. oe:api:: python

            HasProteinStyle() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set protein style.

.. _OEChem_OE3DMolStyle_HasSurfaceAlpha:

   .. oe:method:: HasSurfaceAlpha

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasSurfaceAlpha() const

      .. oe:language:: python

         .. oe:api:: python

            HasSurfaceAlpha() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set surface alpha.

.. _OEChem_OE3DMolStyle_HasSurfaceColorer:

   .. oe:method:: HasSurfaceColorer

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasSurfaceColorer() const

      .. oe:language:: python

         .. oe:api:: python

            HasSurfaceColorer() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set surface colorer.

.. _OEChem_OE3DMolStyle_HasSurfaceStyle:

   .. oe:method:: HasSurfaceStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasSurfaceStyle() const

      .. oe:language:: python

         .. oe:api:: python

            HasSurfaceStyle() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set surfacestyle.

.. _OEChem_OE3DMolStyle_HasSurfaceType:

   .. oe:method:: HasSurfaceType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasSurfaceType() const

      .. oe:language:: python

         .. oe:api:: python

            HasSurfaceType() -> bool

      Return a boolean indicated whether the OE3DMolStyle has a set surface type.

.. _OEChem_OE3DMolStyle_IsValid:

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Return a boolean indicated whether the OE3DMolStyle is valid or not.

.. _OEChem_OE3DMolStyle_SetAtomColorer:

   .. oe:method:: SetAtomColorer

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetAtomColorer(const OEMolStyleColorer& colorer)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomColorer(colorer: OEMolStyleColorer) -> OE3DMolStyle

      Sets the atom colorer for the OE3DMolStyle.

      .. seealso::

         * :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>`
         * :oe:constns:`OEChem::OEAtomColorScheme`

.. _OEChem_OE3DMolStyle_SetAtomLabelColorer:

   .. oe:method:: SetAtomLabelColorer

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetAtomLabelColorer(const OEMolStyleColorer& colorer)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelColorer(colorer: OEMolStyleColorer) -> OE3DMolStyle

      Sets the atom label colorer for the OE3DMolStyle.

      .. seealso::

         * :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>`

.. _OEChem_OE3DMolStyle_SetAtomLabelDataTag:

   .. oe:method:: SetAtomLabelDataTag

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetAtomLabelDataTag(const std::string& tag,
                                              unsigned int precision = 0)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelDataTag(tag: str, precision: int = 0) -> OE3DMolStyle

      Sets the atom label data tage and percision for the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_SetAtomLabelText:

   .. oe:method:: SetAtomLabelText

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetAtomLabelText(const std::string& label)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelText(label: str) -> OE3DMolStyle

      Sets the atom label text for the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_SetAtomLabelType:

   .. oe:method:: SetAtomLabelType

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetAtomLabelType(unsigned int labelData,
                                           unsigned int precision = 0)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelType(labelData: int, precision: int = 0) -> OE3DMolStyle

      Sets the atom label type and precision for the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_SetAtomStyle:

   .. oe:method:: SetAtomStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetAtomStyle(unsigned int displayStyle)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomStyle(displayStyle: int) -> OE3DMolStyle

      Sets the atom style for the OE3DMolStyle.

      .. seealso::

         * :oe:constns:`OEChem::OEAtomStyle`

.. _OEChem_OE3DMolStyle_SetContourStyle:

   .. oe:method:: SetContourStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetContourStyle(unsigned int displayStyle)

      .. oe:language:: python

         .. oe:api:: python

            SetContourStyle(displayStyle: int) -> OE3DMolStyle

      Sets the contour style for the OE3DMolStyle.

      .. seealso::

         * :oe:constns:`OEChem::OEContourStyle`

.. _OEChem_OE3DMolStyle_SetGridContourColorer:

   .. oe:method:: SetGridContourColorer

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetGridContourColorer(const OEMolStyleColorer& colorer)

      .. oe:language:: python

         .. oe:api:: python

            SetGridContourColorer(colorer: OEMolStyleColorer) -> OE3DMolStyle

      Sets the grid contour colorer for the OE3DMolStyle.

      .. seealso::

         * :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>`

.. _OEChem_OE3DMolStyle_SetGridType:

   .. oe:method:: SetGridType

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetGridType(unsigned int gridType)

      .. oe:language:: python

         .. oe:api:: python

            SetGridType(gridType: int) -> OE3DMolStyle

      Sets the grid type for the OE3DMolStyle.

      .. seealso::

         * :oe:constns:`OEChem::OEStyleGridType`

.. _OEChem_OE3DMolStyle_SetHydrogenVisibility:

   .. oe:method:: SetHydrogenVisibility

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetHydrogenVisibility(unsigned int mode)

      .. oe:language:: python

         .. oe:api:: python

            SetHydrogenVisibility(mode: int) -> OE3DMolStyle

      Sets the hydrogen visibility for the OE3DMolStyle.

      .. seealso::

         * :oe:constns:`OEChem::OEHydrogenVisibility`

.. _OEChem_OE3DMolStyle_SetInteractionStyle:

   .. oe:method:: SetInteractionStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetInteractionStyle(unsigned int mode)

      .. oe:language:: python

         .. oe:api:: python

            SetInteractionStyle(mode: int) -> OE3DMolStyle

      Sets the interaction style for the OE3DMolStyle.

      .. seealso::

         * :oe:constns:`OEChem::OEInteractionStyle`

.. _OEChem_OE3DMolStyle_SetProteinColorer:

   .. oe:method:: SetProteinColorer

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetProteinColorer(const OEMolStyleColorer& colorer)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinColorer(colorer: OEMolStyleColorer) -> OE3DMolStyle

      Sets the protein colorer for the OE3DMolStyle.

      .. seealso::

         * :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>`
         * :oe:constns:`OEChem::OEAtomColorScheme`
         * :oe:constns:`OEChem::OEProteinColorScheme`

.. _OEChem_OE3DMolStyle_SetProteinStyle:

   .. oe:method:: SetProteinStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetProteinStyle(unsigned int displayStyle)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinStyle(displayStyle: int) -> OE3DMolStyle

      Sets the protein style for the OE3DMolStyle.

      .. seealso::

         * :oe:constns:`OEChem::OEProteinStyle`

.. _OEChem_OE3DMolStyle_SetSurfaceAlpha:

   .. oe:method:: SetSurfaceAlpha

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetSurfaceAlpha(unsigned int alpha)

      .. oe:language:: python

         .. oe:api:: python

            SetSurfaceAlpha(alpha: int) -> OE3DMolStyle

      Sets the surface alpha for the OE3DMolStyle.

.. _OEChem_OE3DMolStyle_SetSurfaceColorer:

   .. oe:method:: SetSurfaceColorer

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetSurfaceColorer(const OEMolStyleColorer& colorer)

      .. oe:language:: python

         .. oe:api:: python

            SetSurfaceColorer(colorer: OEMolStyleColorer) -> OE3DMolStyle

      Sets the surface colorer for the OE3DMolStyle.

      .. seealso::

         * :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>`
         * :oe:constns:`OEChem::OESurfaceColorScheme`

.. _OEChem_OE3DMolStyle_SetSurfaceStyle:

   .. oe:method:: SetSurfaceStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetSurfaceStyle(unsigned int displayStyle)

      .. oe:language:: python

         .. oe:api:: python

            SetSurfaceStyle(displayStyle: int) -> OE3DMolStyle

      Sets the surface style for the OE3DMolStyle.

      .. seealso::

         * :oe:constns:`OEChem::OESurfaceStyle`

.. _OEChem_OE3DMolStyle_SetSurfaceType:

   .. oe:method:: SetSurfaceType

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE3DMolStyle& SetSurfaceType(unsigned int surfaceType)

      .. oe:language:: python

         .. oe:api:: python

            SetSurfaceType(surfaceType: int) -> OE3DMolStyle

      Sets the surface type for the OE3DMolStyle.

      .. seealso::

         * :oe:constns:`OEChem::OESurfaceType`

   .. seealso::

      * :oe:func:`OEChem::OEAddMolStyles` function
      * :oe:func:`OEChem::OEApplyStyleChange` function
      * :oe:func:`OEChem::OEClearStyle` function
      * :oe:func:`OEChem::OEGetAtomColor` function
      * :oe:func:`OEChem::OEGetAtomLabelColor` function
      * :oe:func:`OEChem::OEGetAtomLabelText` function
      * :oe:func:`OEChem::OEGetColorSchemeName` function
      * :oe:func:`OEChem::OEGetStyle` function
      * :oe:func:`OEChem::OEGetStyleChange` function
      * :oe:func:`OEChem::OEGetStyleIndex` function
      * :oe:func:`OEChem::OEHasStyle` function
      * :oe:func:`OEChem::OESetStyle` function
      * :oe:func:`OEChem::OESetStyleIndex` function
      * :oe:func:`OEChem::OESweepStyles` function
      * :ref:`basicStyle<section_example_oechem_basicmolstyle>` example
      * :ref:`bFactorStyle<section_example_oechem_bFactorStyle>` example
      * :ref:`styleHierarchy<section_oechem_example_stylehierarchy>` example



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAbsCanonicalConfTest, AbsCanonicalConfTest

.. _OEChem_OEAbsCanonicalConfTest:

.. oe:class:: OEAbsCanonicalConfTest

   .. oe:api::

      class OEAbsCanonicalConfTest : public OEConfTestBase

   This class represents `OEAbsCanonicalConfTest`.

   This implementation of :ref:`OEConfTestBase <OEChem_OEConfTestBase>` combines
   subsequent connection tables into a multi-conformer molecule if
   they have the same :term:`canonical SMILES`, that is, absolute (nonisomeric) graph.

   The following methods are publicly inherited from :ref:`OEConfTestBase <OEChem_OEConfTestBase>`:

   =========================================================== =========================================================== ==========================================================
   :oe:meth:`CombineMols<OEChem::OEConfTestBase::CombineMols>` :oe:meth:`CompareMols<OEChem::OEConfTestBase::CompareMols>` :oe:meth:`CreateCopy<OEChem::OEConfTestBase::CreateCopy>` 
   =========================================================== =========================================================== ==========================================================

   .. oe:method:: CombineMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CombineMols(OEMCMolBase& m1, OEMolBase& m2)

      .. oe:language:: python

         .. oe:api:: python

            CombineMols(m1: OEMol, m2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   .. oe:method:: CompareMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CompareMols(OEMolBase& m1, OEMolBase& m2) const

      .. oe:language:: python

         .. oe:api:: python

            CompareMols(m1: Union[OEGraphMol,OEMol,OEQMol],
                        m2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Returns whether the two :ref:`OEMolBase <OEChem_OEMolBase>` object have
      the same :term:`canonical SMILES`. Before the
      comparison all atom and bond stereo values of 'm2' are set to
      :oe:const:`OEChem::OEAtomStereo::Undefined` and
      :oe:const:`OEChem::OEBondStereo::Undefined`, respectively,
      followed by canonical ordering of its atoms by
      :oe:func:`OEChem::OECanonicalOrderAtoms`
  
   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfTestBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEConfTestBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAbsCanonicalConfTest <OEChem_OEAbsCanonicalConfTest>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAbsoluteConfTest, AbsoluteConfTest

.. _OEChem_OEAbsoluteConfTest:

.. oe:class:: OEAbsoluteConfTest

   .. oe:api::

      class OEAbsoluteConfTest : public OEConfTestBase

   This class represents `OEAbsoluteConfTest`.

   This implementation of :ref:`OEConfTestBase <OEChem_OEConfTestBase>` combines
   subsequent connection tables into a multi-conformer molecule if
   they:

   1. Have the same number of atoms and bonds in the same order.
   2. Each atom and bond must have identical properties with its order 
      correspondent in the subsequent connection table.
   3. Have the same title (optional).

   .. note::

      :ref:`OEAbsoluteConfTest <OEChem_OEAbsoluteConfTest>` shouldn't be used for
      reading multi-conformer molecules in PDB or XYZ file format. These
      file formats typically require the use of
      :oe:func:`OEChem::OEDetermineConnectivity` (and
      :oe:func:`OEChem::OEPerceiveBondOrders`) which may potentially
      perceive and create bonds in different orders (or arbitrarily
      assign bond orders and Kekulé forms differently) for different
      conformers of the same molecule. This disrupts the ordering (and
      property) constraints described above. Generally, file formats
      other than PDB and XYZ should be used for storing multi-conformer
      molecules (as consecutive connection tables), but if unavoidable,
      the :ref:`OEAbsCanonicalConfTest <OEChem_OEAbsCanonicalConfTest>` class should be used
      instead.

   The following methods are publicly inherited from :ref:`OEConfTestBase <OEChem_OEConfTestBase>`:

   =========================================================== =========================================================== ==========================================================
   :oe:meth:`CombineMols<OEChem::OEConfTestBase::CombineMols>` :oe:meth:`CompareMols<OEChem::OEConfTestBase::CompareMols>` :oe:meth:`CreateCopy<OEChem::OEConfTestBase::CreateCopy>` 
   =========================================================== =========================================================== ==========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAbsoluteConfTest(bool compTitles = true)

      .. oe:language:: python

         .. oe:api:: python

            OEAbsoluteConfTest(compTitles: bool = True) -> OEAbsoluteConfTest

      Constructs an :ref:`OEAbsoluteConfTest <OEChem_OEAbsoluteConfTest>`
      object. The argument 'compTitle' specifies whether to compare
      molecule titles (accessed by
      :oe:meth:`OEChem::OEMolBase::GetTitle`).  If the constructor is
      called with no arguments or with the argument true, molecule
      titles will be required to be the same. Otherwise, the titles
      will not be compared. In the latter instance, each conformer
      will have the individual title of its original connection table
      and the multi-conformer molecule will reflect the title of the
      active conformer.

   .. oe:method:: CombineMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CombineMols(OEMCMolBase& m1, OEMolBase& m2)

      .. oe:language:: python

         .. oe:api:: python

            CombineMols(m1: OEMol, m2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   .. oe:method:: CompareMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CompareMols(OEMolBase& m1, OEMolBase& m2) const

      .. oe:language:: python

         .. oe:api:: python

            CompareMols(m1: Union[OEGraphMol,OEMol,OEQMol],
                        m2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Returns whether the two :ref:`OEMolBase <OEChem_OEMolBase>` objects
      are the same by checking the three conditions listed at the top.

      Before  the comparison all atom and bond stereo values of 
      'm2' are set to :oe:const:`OEChem::OEAtomStereo::Undefined` and
      :oe:const:`OEChem::OEBondStereo::Undefined`, respectively,
      followed by canonical ordering of its atoms by
      :oe:func:`OEChem::OECanonicalOrderAtoms`

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfTestBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEConfTestBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAbsoluteConfTest <OEChem_OEAbsoluteConfTest>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 



.. oe:namespace:: OEChem

.. _OEChem_OEAnisoUij:

.. oe:class:: OEAnisoUij

   .. oe:api::

      class OEAnisoUij

   The :ref:`OEAnisoUij <OEChem_OEAnisoUij>` class is a simple container
   used to package anisotropic B-factor parameters that can be associated with
   an :ref:`OEAtomBase <OEChem_OEAtomBase>` object. Using one can make accessing
   Uij values easier in wrapped languages.

   .. seealso::

      * :ref:`OEHasAnisou <OEChem_OEHasAnisou>`
      * :oe:func:`OEChem::OEGetAnisou`
      * :oe:func:`OEChem::OESetAnisou`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAnisoUij()
            OEAnisoUij(int u11, int u22, int u33, int u12, int u13, int u23)

      .. oe:language:: python

         .. oe:api:: python

            OEAnisoUij() -> OEAnisoUij
            OEAnisoUij(u11: int, u22: int, u33: int, u12: int, u13: int,
                       u23: int) -> OEAnisoUij

      Default constructor (which sets all parameters to 0)
      and constructor that takes specific values for each parameter.

   .. oe:method:: GetU11

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetU11() const

      .. oe:language:: python

         .. oe:api:: python

            GetU11() -> int

   .. oe:method:: GetU12

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetU12() const

      .. oe:language:: python

         .. oe:api:: python

            GetU12() -> int

   .. oe:method:: GetU13

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetU13() const

      .. oe:language:: python

         .. oe:api:: python

            GetU13() -> int

   .. oe:method:: GetU22

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetU22() const

      .. oe:language:: python

         .. oe:api:: python

            GetU22() -> int

   .. oe:method:: GetU23

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetU23() const

      .. oe:language:: python

         .. oe:api:: python

            GetU23() -> int

   .. oe:method:: GetU33

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetU33() const

      .. oe:language:: python

         .. oe:api:: python

            GetU33() -> int

   .. oe:method:: SetU11

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetU11(int val)

      .. oe:language:: python

         .. oe:api:: python

            SetU11(val: int) -> None

   .. oe:method:: SetU12

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetU12(int val)

      .. oe:language:: python

         .. oe:api:: python

            SetU12(val: int) -> None

   .. oe:method:: SetU13

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetU13(int val)

      .. oe:language:: python

         .. oe:api:: python

            SetU13(val: int) -> None

   .. oe:method:: SetU22

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetU22(int val)

      .. oe:language:: python

         .. oe:api:: python

            SetU22(val: int) -> None

   .. oe:method:: SetU23

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetU23(int val)

      .. oe:language:: python

         .. oe:api:: python

            SetU23(val: int) -> None

   .. oe:method:: SetU33

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetU33(int val)

      .. oe:language:: python

         .. oe:api:: python

            SetU33(val: int) -> None


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomBase
   :keywords: AtomBase

.. _OEChem_OEAtomBase:

.. oe:class:: OEAtomBase

   .. oe:api::

      class OEAtomBase : public OESystem::OEBase

   The :ref:`OEAtomBase <OEChem_OEAtomBase>` class is the abstract interface for
   representing atoms within **OpenEye's Toolkits**. An :ref:`OEAtomBase <OEChem_OEAtomBase>`
   object is created by calling the :oe:cls:`OEChem::OEMolBase::NewAtom` method
   on the parent molecule.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   The following classes derive from this class:
    * :ref:`OEQAtomBase <OEChem_OEQAtomBase>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAtomBase& operator=(const OEAtomBase& a)

   .. _OEChem_OEAtomBase_AddBond:

      Assignment operator.

   .. oe:method:: AddBond
      :language: c++ java csharp

      .. oe:api::

         bool AddBond(const OEBondBase *)=0

   .. _OEChem_OEAtomBase_Clear:

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()=0

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

   .. _OEChem_OEAtomBase_GetAtomicNum:

   .. oe:method:: GetAtomicNum

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetAtomicNum() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetAtomicNum() -> int

      Returns the 'atomic number' property of the atom.  
      A value of zero is returned for wildcard atoms, such as MDL super atoms.  
      An atomic number is specified as the argument to :oe:meth:`OEChem::OEMolBase::NewAtom` 
      and may be changed using :oe:meth:`OEChem::OEAtomBase::SetAtomicNum`.  
      The set of valid values for this property are defined by the 
      :oe:constns:`OEChem::OEElemNo` namespace.

   .. _OEChem_OEAtomBase_GetAtoms:

   .. oe:method:: GetAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEAtomBase>* GetAtoms() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> OEAtomIter

      Returns an iterator over the neighboring atoms of this atom.
      The returned iterator traverses
      only the explicit atoms that are bonded to the
      :ref:`OEAtomBase <OEChem_OEAtomBase>`. The number of neighbors in the
      iterator is identical to
      :oe:meth:`OEChem::OEAtomBase::GetExplicitDegree`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEAtomBase>* GetAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms(arg2: OEUnaryAtomPred) -> OEAtomIter

      Returns an iterator over the neighboring atoms of the :ref:`OEAtomBase <OEChem_OEAtomBase>` that match
      the predicate (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`)

   .. _OEChem_OEAtomBase_GetAxial:

   .. oe:method:: GetAxial

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAxial(const OEBondBase *) const

      .. oe:language:: python

         .. oe:api:: python

            GetAxial(arg2: OEBondBase) -> bool

      .. warning::

         |DEPRECATED-API|

   .. _OEChem_OEAtomBase_GetBond:

   .. oe:method:: GetBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondBase* GetBond(const OEAtomBase *) const

      .. oe:language:: python

         .. oe:api:: python

            GetBond(arg2: OEAtomBase) -> OEBondBase

      Returns a :ref:`OEBondBase <OEChem_OEBondBase>` pointer that connecting
      the :ref:`OEAtomBase <OEChem_OEAtomBase>` to the atom specified in the
      method argument. If the :ref:`OEAtomBase <OEChem_OEAtomBase>` is not
      connected to the specified atom, a NULL pointer
      (:oe:cls:`OEChem::OEBondBase*<OEChem::OEBondBase>`)0 is returned.

   .. _OEChem_OEAtomBase_GetBonds:

   .. oe:method:: GetBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBondBase>* GetBonds() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBonds() -> OEBondIter

      Returns an iterator over the bonds connected to the atom.
      The returned iterator traverses only the explicit bonds that are
      attached to the :ref:`OEAtomBase <OEChem_OEAtomBase>`. The number of bonds
      in the iterator is identical to
      :oe:meth:`OEChem::OEAtomBase::GetExplicitDegree`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBondBase>* GetBonds(const OESystem::OEUnaryPredicate<OEChem::OEBondBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBonds(arg2: OEUnaryBondPred) -> OEBondIter

      Returns an iterator over the bonds of the :ref:`OEAtomBase <OEChem_OEAtomBase>` that match
      the predicate (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`)

   .. _OEChem_OEAtomBase_GetDegree:

   .. oe:method:: GetDegree

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetDegree() const

      .. oe:language:: python

         .. oe:api:: python

            GetDegree() -> int

      Returns the total number of neighbor atoms bonded to an atom, or
      equivalently the total number of bonds connected to an
      atom. This value includes bonds to implicit hydrogen atoms. This
      value is identical to
      :oe:meth:`OEChem::OEAtomBase::GetExplicitDegree()<OEChem::OEAtomBase::GetExplicitDegree>` +
      :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount()<OEChem::OEAtomBase::GetImplicitHCount>`, 
      and is also identical to 
      :oe:meth:`OEChem::OEAtomBase::GetHvyDegree()<OEChem::OEAtomBase::GetHvyDegree>` +
      :oe:meth:`OEChem::OEAtomBase::GetTotalHCount()<OEChem::OEAtomBase::GetTotalHCount>`.

   .. _OEChem_OEAtomBase_GetExplicitDegree:

   .. oe:method:: GetExplicitDegree

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetExplicitDegree() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetExplicitDegree() -> int

      Returns the number of explicit neighbor atoms bonded to an
      atom. This value does not include bonds to implicit hydrogen
      atoms.

   .. _OEChem_OEAtomBase_GetExplicitHCount:

   .. oe:method:: GetExplicitHCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetExplicitHCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetExplicitHCount() -> int

      Returns the number of explicit hydrogen neighbors bonded to an
      atom.

   .. _OEChem_OEAtomBase_GetExplicitValence:

   .. oe:method:: GetExplicitValence

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetExplicitValence() const

      .. oe:language:: python

         .. oe:api:: python

            GetExplicitValence() -> int

      Returns the sum of the bond orders of explicit bonds connected
      to an atom.

   .. _OEChem_OEAtomBase_GetFormalCharge:

   .. oe:method:: GetFormalCharge

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetFormalCharge() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetFormalCharge() -> int

      Returns the 'formal charge' property of  an atom. The default value is
      zero. The 'formal charge' property may be set using the
      :ref:`SetFormalCharge <OEChem_OEAtomBase_SetFormalCharge>` method. Formal
      charges may also be set on a molecule using the
      :ref:`OEAssignFormalCharges <OEChem_OEAssignFormalCharges>` function that infers
      reasonable formal charges using the atomic number, and implicit
      hydrogen count for each atom.

   .. _OEChem_OEAtomBase_GetHvyDegree:

   .. oe:method:: GetHvyDegree

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetHvyDegree() const

      .. oe:language:: python

         .. oe:api:: python

            GetHvyDegree() -> int

      Returns the number of non-hydrogen neighbors of an atom.

   .. _OEChem_OEAtomBase_GetHvyValence:

   .. oe:method:: GetHvyValence

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetHvyValence() const

      .. oe:language:: python

         .. oe:api:: python

            GetHvyValence() -> int

      Returns the sum of bond orders of bonds to non-hydrogen atoms.

   .. _OEChem_OEAtomBase_GetHyb:

   .. oe:method:: GetHyb

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetHyb() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetHyb() -> int

      Returns the 'hybridization' property of an atom.  
      The set of valid  values for this property are defined in the
      :oe:constns:`OEChem::OEHybridization` namespace.  
      The default value is zero, (:oe:const:`OEChem::OEHybridization::Unknown`).  
      The 'hybridization' property can be set with the
      :oe:meth:`OEChem::OEAtomBase::SetHyb` method.

   .. _OEChem_OEAtomBase_GetIdx:

   .. oe:method:: GetIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetIdx() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetIdx() -> int

      Returns the atom index of an atom. This value is assigned
      when an atom is created. The atom index is unique for
      the atoms of a given molecule, and is stable (not reused) for
      the lifetime of that :ref:`OEMolBase <OEChem_OEMolBase>`. These values
      may not be assigned sequentially, and may contain gaps. Atom
      indices are guaranteed to be less than
      :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx`. Atom indices are
      typically only used for efficiently storing data in arrays (or
      vectors) externally to the :ref:`OEMolBase <OEChem_OEMolBase>`. They
      arrays can be conveniently indexed via
      :oe:meth:`OEChem::OEAtomBase::GetIdx`. For iterating across the
      atoms of a molecule, use :oe:meth:`OEChem::OEMolBase::GetAtoms`
      and for keeping track of a particular atom use an 
      :oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`.

      .. seealso::
 
         * :ref:`chapter_atombondindices` chapter

   .. _OEChem_OEAtomBase_GetImplicitHCount:

   .. oe:method:: GetImplicitHCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetImplicitHCount() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetImplicitHCount() -> int

      Returns the 'implicit hydrogen count' property of an atom. The
      default value is zero. The 'implicit hydrogen count' property
      may be set using the
      :oe:meth:`OEChem::OEAtomBase::SetImplicitHCount` method. Implicit
      hydrogen counts may also be set on a molecule using the
      :oe:func:`OEChem::OEAssignImplicitHydrogens` function. The 'implicit
      hydrogen count' property of an atom is a stored, not a computed,
      property. To calculate a reasonable implicit hydrogen count for
      an atom from connectivity, use the 
      :oe:func:`OEChem::OEDefaultImplicitHCount` function.

      To convert explicit hydrogens to implicit hydrogens, use the
      :oe:func:`OEChem::OESuppressHydrogens` function, and to
      convert implicit hydrogens to explicit hydrogens, use the
      :oe:func:`OEChem::OEAddExplicitHydrogens` function.

   .. _OEChem_OEAtomBase_GetIntType:

   .. oe:method:: GetIntType

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetIntType() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetIntType() -> int

      Returns the 'integer atom type' of an atom. The default value is
      zero. The 'integer atom type' property may be set using the
      :oe:meth:`OEChem::OEAtomBase::SetIntType` method.

   .. _OEChem_OEAtomBase_GetIsotope:

   .. oe:method:: GetIsotope

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetIsotope() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetIsotope() -> int

      Returns the 'isotopic mass' property of an atom.  
      The default value is zero, meaning that the atom isn't a specific single isotope, but a
      composition of isotopes in their naturally occurring abundances.   
      A non-zero value indicates that the atom is a specific isotope.  
      The 'isotopic mass' property may be set using the :oe:meth:`OEChem::OEAtomBase::SetIsotope`
      method.

   .. _OEChem_OEAtomBase_GetMapIdx:

   .. oe:method:: GetMapIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMapIdx() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetMapIdx() -> int

      Returns the 'reaction map index' of property of an atom. This integer value
      is used for tracking equivalent atom positions in a reaction
      molecule/transform. The default value is zero, meaning that the
      atom isn't mapped in the reaction.
      This property is also used to store 'R-group' indices, for example when
      parsing the :term:`SMILES` string ``CCC[R1]``.

      .. seealso::

         * :oe:meth:`OEChem::OEAtomBase::SetMapIdx` method
         * :ref:`OEIsRGroup <OEChem_OEIsRGroup>`  predicate

   .. _OEChem_OEAtomBase_GetName:

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetName() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the 'atom name' property of an atom. This property is
      typically used when reading or writing molecular file
      formats. For example in PDB files, the atom name `` CA `` is
      used to denote that the atom is a peptide alpha carbon. The
      default value is the empty string. The 'atom name' property may
      be set using the :oe:meth:`OEChem::OEAtomBase::SetName` method.

   .. _OEChem_OEAtomBase_GetParent:

   .. oe:method:: GetParent

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolBase* GetParent() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetParent() -> OEGraphMol

      Returns the parent molecule (:ref:`OEMolBase <OEChem_OEMolBase>`) of an
      atom. All :oe:cls:`OEChem::OEAtomBases<OEChem::OEAtomBase>` are
      created as a component of an :ref:`OEMolBase <OEChem_OEMolBase>`, this
      method can be used to determine the molecule of which an atom is
      part. The 'parent molecule' property of an atom cannot be
      assigned, as its determined at the point the atom is created.

   .. _OEChem_OEAtomBase_GetPartialCharge:

   .. oe:method:: GetPartialCharge

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPartialCharge() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetPartialCharge() -> float

      Returns the 'partial charge' property of an atom. The default value is
      ``0.0``. The 'partial charge' property on an atom may be set
      using the :oe:meth:`OEChem::OEAtomBase::SetPartialCharge`
      method. The 'partial charge' property is a stored, not a
      calculated, property. The 
      :oe:func:`OEChem::OEClearPartialCharges` function resets the partial
      charges on a molecule to zero, and the
      :oe:func:`OEChem::OEFormalPartialCharges` function sets the partial charge
      on each atom equal to its formal charge.

   .. _OEChem_OEAtomBase_GetRadius:

   .. oe:method:: GetRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetRadius() -> float

      Returns the 'radius' property of an atom.  
      The default value is 0.0.  
      The 'radius' property on an atom may be set using the 
      :oe:meth:`OEChem::OEAtomBase::SetRadius` method.  
      The 'radius' property is typically used to hold a Van der Waal's or ionic 
      radius for a given atom when passing an :ref:`OEMolBase <OEChem_OEMolBase>` to an algorithm
      requiring some form of radii, such as a surface area calculation.

   .. _OEChem_OEAtomBase_GetRxnRole:

   .. oe:method:: GetRxnRole

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRxnRole() const

      .. oe:language:: python

         .. oe:api:: python

            GetRxnRole() -> int

      Returns the 'reaction role' property of an atom in a reaction
      molecule/transform. The set of valid  values for this
      property are defined in the namespace
      :oe:constns:`OEChem::OERxnRole`. The default value is zero,
      :oe:const:`OEChem::OERxnRole::None`, which means that the atom
      does have a role, *i.e.* is part of a normal molecule. Other
      values include :oe:const:`OEChem::OERxnRole::Reactant`,
      :oe:const:`OEChem::OERxnRole::Agent` and
      :oe:const:`OEChem::OERxnRole::Product` which correspond to
      reactant, agent and product atoms, respectively, in a reaction or
      transform. The 'reaction role' property may be set using the
      :oe:meth:`OEChem::OEAtomBase::SetRxnRole` method.

   .. _OEChem_OEAtomBase_GetStereo:

   .. oe:method:: GetStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetStereo(const std::vector<OEAtomBase *>& neighs,
                                   unsigned int stereoclass) const

      .. oe:language:: python

         .. oe:api:: python

            GetStereo(arg2: OEAtomVector, arg3: int) -> int

      Returns the stereochemistry annotation of the atom.

      *neighs*
         A vector of neighboring atoms and a specific stereochemistry
         class and returns whether that stereochemistry is specified at
         this atom, and if so, what that specified value is.

      *stereoclass*
         **OEChem TK** currently only supports the tetrahedral atom stereochemistry class.
         The only valid *stereoclass* value is :oe:const:`OEChem::OEAtomStereo::Tetra`.

      This method returns the value :oe:const:`OEChem::OEAtomStereo::Undefined`
      if the stereo chemistry for the given stereochemistry class is unspecified, if
      the stereo chemistry class is invalid or if the vector of
      neighboring atoms is invalid.

      For a specified tetrahedral stereo center, it returns either
      :oe:const:`OEChem::OEAtomStereo::Left` or
      :oe:const:`OEChem::OEAtomStereo::Right`.

      The stereochemistry annotation of an atom may be set
      using the :oe:meth:`OEChem::OEAtomBase::SetStereo` method.

      .. seealso::

         * :term:`stereo atom`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEAtomBase::IsChiral` 
         * :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` 

   .. _OEChem_OEAtomBase_GetSymmetryClass:

   .. oe:method:: GetSymmetryClass

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSymmetryClass() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetSymmetryClass() -> int

      Returns the 'symmetry class' property of an atom. The default value is
      zero, indicating that symmetry classes haven't been
      assigned. The 'symmetry class' property may be set using the
      :oe:meth:`OEChem::OEAtomBase::SetSymmetryClass` method. Symmetry
      classes of a molecule are usually set by calling the
      :oe:func:`OEChem::OEPerceiveSymmetry` function.

   .. _OEChem_OEAtomBase_GetTotalHCount:

   .. oe:method:: GetTotalHCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetTotalHCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalHCount() -> int

      Returns the total number of hydrogen atoms attached to an
      atom. This value includes the implicit hydrogen atoms. This
      value is identical to
      :oe:meth:`OEChem::OEAtomBase::GetExplicitHCount()<OEChem::OEAtomBase::GetExplicitHCount>` +
      :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount()<OEChem::OEAtomBase::GetImplicitHCount>`.

   .. _OEChem_OEAtomBase_GetType:

   .. oe:method:: GetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetType() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetType() -> str

      Returns the 'atom type name' property  of an atom. This value is
      typically used when reading and writing molecular formats. For
      example, in Sybyl :file:`mol2` file, the atom type name ``N.pl3`` means
      that the atom should be treated as a three-valent planar
      nitrogen. The default value is the empty string. The 'atom type
      name' property may be set using the
      :oe:meth:`OEChem::OEAtomBase::SetType` method.

   .. _OEChem_OEAtomBase_GetValence:

   .. oe:method:: GetValence

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetValence() const

      .. oe:language:: python

         .. oe:api:: python

            GetValence() -> int

      Returns the sum of all bond orders to an atom. This value
      includes bonds to implicit hydrogen atoms. This value is equal to
      :oe:meth:`OEChem::OEAtomBase::GetExplicitValence()<OEChem::OEAtomBase::GetExplicitValence>`  +
      :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount()<OEChem::OEAtomBase::GetImplicitHCount>`.

   .. _OEChem_OEAtomBase_HasAlphaBetaUnsat:

   .. oe:method:: HasAlphaBetaUnsat

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasAlphaBetaUnsat(bool includePandS = true) const

      .. oe:language:: python

         .. oe:api:: python

            HasAlphaBetaUnsat(includePandS: bool = True) -> bool

      .. warning::

         This is a deprecated method. Use :ref:`OEHasAlphaBetaUnsat <OEChem_OEHasAlphaBetaUnsat>` predicate
         instead.

   .. _OEChem_OEAtomBase_HasStereoSpecified:

   .. oe:method:: HasStereoSpecified

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasStereoSpecified(unsigned int v = OEAtomStereo::All) const

      .. oe:language:: python

         .. oe:api:: python

            HasStereoSpecified(v: int) -> bool

      Determines whether the given atom has specified
      stereochemistry. The optional argument specifies the class of
      stereochemistry to check for. The default value,
      :oe:const:`OEChem::OEAtomStereo::All`, checks whether any class
      of stereochemistry is specified for the current atom.

      If an atom has
      unspecified stereochemistry, and this method returns
      ``false``, the molecule is assumed to represent either a racemic
      mixture or an undetermined isomer of this compound. If this
      method returns ``true``, this atom has an explicit stereochemistry
      which may be retrieved using the
      :oe:meth:`OEChem::OEAtomBase::GetStereo` method.

      This method initially returns ``false`` for a newly created
      atom. The stereochemistry of an atom may be set by calling the
      :oe:meth:`OEChem::OEAtomBase::SetStereo` method with the
      appropriate stereochemistry class and any value other than
      :oe:const:`OEChem::OEAtomStereo::Undefined`. The atom
      stereochemistry may subsequently be cleared by calling the same
      method, with the appropriate stereochemistry class, but
      specifying the value :oe:const:`OEChem::OEAtomStereo::Undefined`.

      .. seealso::

         * :term:`stereo atom`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEAtomBase::IsChiral` 
         * :oe:meth:`OEChem::OEAtomBase::GetStereo` 

   .. _OEChem_OEAtomBase_IsAromatic:

   .. oe:method:: IsAromatic

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsAromatic() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsAromatic() -> bool

      Returns the 'aromatic' property of an atom. The default value is
      ``false``. The 'aromatic' property of an atom can be set using
      the :oe:meth:`OEChem::OEAtomBase::SetAromatic` method. The
      'aromatic' property of atoms and bonds in a molecule are
      typically set by calling either the 
      :oe:func:`OEChem::OEAssignAromaticFlags` function and cleared by the
      :oe:func:`OEChem::OEClearAromaticFlags` function.

      .. seealso::

         * :ref:`chapter_aromaticity` chapter

   .. _OEChem_OEAtomBase_IsCarbon:

   .. oe:method:: IsCarbon

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsCarbon() const

      .. oe:language:: python

         .. oe:api:: python

            IsCarbon() -> bool

      Determines whether an atom is a carbon atom. This method tests
      whether the atom's atomic number is `6`, and is equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>`
      == :oe:const:`OEChem::OEElemNo::C`.

   .. _OEChem_OEAtomBase_IsChiral:

   .. oe:method:: IsChiral

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsChiral() const

      .. oe:language:: python

         .. oe:api:: python

            IsChiral() -> bool

      Determines whether the current atom is a stereogenic center. If
      this method returns ``true``, the atom is a :term:`chiral atom`
      and the different left-handed and right-handed configurations
      about this atom represent two distinct isomers. If this method
      returns ``false``, this atom is not a chiral stereocenter.

      .. note::

         This :term:`chiral atom` property is independent of the
         :term:`stereo atom` property that records whether a particular
         left-handed or right-handed configuration is specified at a
         particular atom.

      .. seealso::

         * :term:`chiral atom`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` 
         * :oe:meth:`OEChem::OEAtomBase::GetStereo` 

   .. _OEChem_OEAtomBase_IsConnected:

   .. oe:method:: IsConnected

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsConnected(const OEAtomBase *) const

      .. oe:language:: python

         .. oe:api:: python

            IsConnected(arg2: OEAtomBase) -> bool

      Determines whether the atom is bonded to the given atom. To
      obtain the actual bond linking the atom to its neighbor use the
      :oe:meth:`OEChem::OEAtomBase::GetBond` method. This method is
      equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetBond()<OEChem::OEAtomBase::GetBond>`
      != (:oe:cls:`OEChem::OEBondBase*<OEChem::OEBondBase>`)0.

   .. _OEChem_OEAtomBase_IsDataType:

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

   .. _OEChem_OEAtomBase_IsDeleted:

   .. oe:method:: IsDeleted

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDeleted() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsDeleted() -> bool

   .. _OEChem_OEAtomBase_IsHalogen:

   .. oe:method:: IsHalogen

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsHalogen() const

      .. oe:language:: python

         .. oe:api:: python

            IsHalogen() -> bool

      Determines whether an atom is a halogen atom. This method tests
      whether the atom is Fluorine, Chlorine, Bromine, Iodine or
      Astatine (atomic number :oe:const:`OEChem::OEElemNo::F`, :oe:const:`OEChem::OEElemNo::Cl`, 
      :oe:const:`OEChem::OEElemNo::Br`, :oe:const:`OEChem::OEElemNo::I` or 
      :oe:const:`OEChem::OEElemNo::As`).

   .. _OEChem_OEAtomBase_IsHydrogen:

   .. oe:method:: IsHydrogen

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsHydrogen() const

      .. oe:language:: python

         .. oe:api:: python

            IsHydrogen() -> bool

      Determines whether an atom is a hydrogen atom. This method
      tests whether the atom's atomic number is ``1``, and is equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>`
      == :oe:const:`OEChem::OEElemNo::H`.

   .. _OEChem_OEAtomBase_IsInRing:

   .. oe:method:: IsInRing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsInRing() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsInRing() -> bool

      Returns the 'in ring' property of an atom. The default value is
      ``false``. The 'in ring' property of an atom may be set using
      the :oe:meth:`OEChem::OEAtomBase::SetInRing` method. The 'in
      ring' properties of atoms and bonds are typically set by calling
      :oe:func:`OEChem::OEFindRingAtomsAndBonds` function.

      To determine whether an atom is a member of a specific
      ring/cycle size, use the :oe:func:`OEChem::OEAtomIsInRingSize` function.

      .. seealso:: 

         * :ref:`chapter_ring` chapter

   .. _OEChem_OEAtomBase_IsMetal:

   .. oe:method:: IsMetal

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsMetal() const

      .. oe:language:: python

         .. oe:api:: python

            IsMetal() -> bool

      Determines whether an atom is a metal atom. 
      This tests whether the atom number is not :oe:const:`OEChem::OEElemNo::H`, 
      :oe:const:`OEChem::OEElemNo::He`, :oe:const:`OEChem::OEElemNo::B`, 
      :oe:const:`OEChem::OEElemNo::C`, :oe:const:`OEChem::OEElemNo::N`, 
      :oe:const:`OEChem::OEElemNo::O`, :oe:const:`OEChem::OEElemNo::F`, 
      :oe:const:`OEChem::OEElemNo::Ne`, :oe:const:`OEChem::OEElemNo::Si`,
      :oe:const:`OEChem::OEElemNo::P`, :oe:const:`OEChem::OEElemNo::S`, 
      :oe:const:`OEChem::OEElemNo::Cl`, :oe:const:`OEChem::OEElemNo::Ar`, 
      :oe:const:`OEChem::OEElemNo::As`, :oe:const:`OEChem::OEElemNo::Se`, 
      :oe:const:`OEChem::OEElemNo::Br`, :oe:const:`OEChem::OEElemNo::Kr`, 
      :oe:const:`OEChem::OEElemNo::Te`, :oe:const:`OEChem::OEElemNo::I`, 
      :oe:const:`OEChem::OEElemNo::Xe`, :oe:const:`OEChem::OEElemNo::At` or 
      :oe:const:`OEChem::OEElemNo::Rn`.

   .. _OEChem_OEAtomBase_IsNitrogen:

   .. oe:method:: IsNitrogen

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsNitrogen() const

      .. oe:language:: python

         .. oe:api:: python

            IsNitrogen() -> bool

      Determines whether an atom is a nitrogen atom. This method
      tests whether the atom's atomic number is ``7``, and is equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>`
      == :oe:const:`OEChem::OEElemNo::N`.

   .. _OEChem_OEAtomBase_IsOxygen:

   .. oe:method:: IsOxygen

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsOxygen() const

      .. oe:language:: python

         .. oe:api:: python

            IsOxygen() -> bool

      Determines whether an atom is an oxygen atom. This method
      tests whether the atom's atomic number is ``8``, and is equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>`
      == :oe:const:`OEChem::OEElemNo::O`.

   .. _OEChem_OEAtomBase_IsPhosphorus:

   .. oe:method:: IsPhosphorus

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsPhosphorus() const

      .. oe:language:: python

         .. oe:api:: python

            IsPhosphorus() -> bool

      Determines whether an atom is a phosphorus atom. This method
      tests whether the atom's atomic number is ``15``, and is equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>`
      == :oe:const:`OEChem::OEElemNo::P`.

   .. _OEChem_OEAtomBase_IsPolar:

   .. oe:method:: IsPolar

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsPolar() const

      .. oe:language:: python

         .. oe:api:: python

            IsPolar() -> bool

      Determines whether an atom is neither a carbon
      (:oe:const:`OEChem::OEElemNo::C`) nor hydrogen
      (:oe:const:`OEChem::OEElemNo::H`).

   .. _OEChem_OEAtomBase_IsPolarHydrogen:

   .. oe:method:: IsPolarHydrogen

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsPolarHydrogen() const

      .. oe:language:: python

         .. oe:api:: python

            IsPolarHydrogen() -> bool

      Determines whether an atom is a hydrogen attached to a polar
      atom. If the atom's atomic number is not one, *i.e.*
      :oe:meth:`OEChem::OEAtomBase::IsHydrogen()<OEChem::OEAtomBase::IsHydrogen>`
      == ``false``, then this method returns ``false`` too. Otherwise,
      this method returns ``true`` if any of its neighbors return
      ``true`` for :oe:meth:`OEChem::OEAtomBase::IsPolar`.

   .. _OEChem_OEAtomBase_IsSulfur:

   .. oe:method:: IsSulfur

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsSulfur() const

      .. oe:language:: python

         .. oe:api:: python

            IsSulfur() -> bool

      Determines whether an atom is a  sulfur (sulphur) atom. This method
      tests whether the atom's atomic number is ``16``, and is equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>`
      == :oe:const:`OEChem::OEElemNo::S`.

   .. _OEChem_OEAtomBase_OrderBonds:

   .. oe:method:: OrderBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool OrderBonds(const std::vector<OEBondBase *> &)=0

      .. oe:language:: python

         .. oe:api:: python

            OrderBonds(arg2: OEBondVector) -> bool

   .. _OEChem_OEAtomBase_RemoveBond:

   .. oe:method:: RemoveBond
      :language: c++ java csharp

      .. oe:api::

         bool RemoveBond(OEBondBase *)=0

   .. _OEChem_OEAtomBase_SetAromatic:

   .. oe:method:: SetAromatic

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAromatic(bool)=0

      .. oe:language:: python

         .. oe:api:: python

            SetAromatic(arg2: bool) -> bool

      Sets the 'aromatic' property of an atom. This value is ``false``
      by default. The 'aromatic' property of an atom may be retrieved
      using the :oe:meth:`OEChem::OEAtomBase::IsAromatic` method. This
      method is normally only used by the
      :oe:func:`OEChem::OEClearAromaticFlags` function and the
      :oe:func:`OEChem::OEAssignAromaticFlags` function.

      .. seealso::

         * :ref:`chapter_aromaticity` chapter

   .. _OEChem_OEAtomBase_SetAtomicNum:

   .. oe:method:: SetAtomicNum

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAtomicNum(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetAtomicNum(arg2: int) -> bool

      Sets the 'atomic number' property of an atom.  
      The set of valid values for this property is specified by the 
      :oe:constns:`OEChem::OEElemNo`.  
      The default value is specified when an atom is created with 
      :oe:meth:`OEChem::OEMolBase::NewAtom` method.  
      The 'atomic number' property of an atom can be retrieved using the 
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum` method.

   .. _OEChem_OEAtomBase_SetAxial:

   .. oe:method:: SetAxial

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAxial(const OEBondBase *, bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAxial(arg2: OEBondBase, arg3: bool) -> bool

      .. warning::

         This is a deprecated method.

   .. _OEChem_OEAtomBase_SetChiral:

   .. oe:method:: SetChiral

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetChiral(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetChiral(arg2: bool) -> bool

      .. seealso::

         * :term:`chiral atom`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEAtomBase::SetStereo` 

   .. _OEChem_OEAtomBase_SetFormalCharge:

   .. oe:method:: SetFormalCharge

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFormalCharge(int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetFormalCharge(arg2: int) -> bool

      Sets the 'formal charge' property of an atom. The default value is
      zero. The 'formal charge' property may be retrieved using the
      :oe:meth:`OEChem::OEAtomBase::GetFormalCharge` method.

   .. _OEChem_OEAtomBase_SetHyb:

   .. oe:method:: SetHyb

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetHyb(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetHyb(arg2: int) -> bool

      Sets the 'hybridization' property of an atom.  
      The set of valid values for this property is specified by the 
      :oe:constns:`OEChem::OEHybridization` namespace.
      The default value is zero (:oe:const:`OEChem::OEHybridization::Unknown`).  
      The 'hybridization' property may be retrieved using the
      :oe:meth:`OEChem::OEAtomBase::GetHyb` method. 

      .. seealso::
   
         * :oe:func:`OEChem::OEGetHybridization`
         * :oe:func:`OEChem::OEAssignHybridization`

   .. _OEChem_OEAtomBase_SetImplicitHCount:

   .. oe:method:: SetImplicitHCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetImplicitHCount(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetImplicitHCount(arg2: int) -> bool

      Sets the 'implicit hydrogen count' property of an atom. The default value
      is zero. The 'implicit hydrogen count' property may be retrieved
      using the :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount`
      method.

   .. _OEChem_OEAtomBase_SetInRing:

   .. oe:method:: SetInRing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetInRing(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetInRing(arg2: bool) -> bool

      Sets the 'in ring' property of an atom. This property is usually
      set by the
      :oe:func:`OEChem::OEFindRingAtomsAndBonds` function. The default value is
      ``false``. The 'in ring' property of an atom may be retrieved
      using the :oe:meth:`OEChem::OEAtomBase::IsInRing` method.

      .. seealso:: 

         * :ref:`chapter_ring` chapter

   .. _OEChem_OEAtomBase_SetIntType:
  
   .. oe:method:: SetIntType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIntType(int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetIntType(arg2: int) -> bool

      Sets the 'integer atom type' property of an atom. The default
      value is zero. The 'integer atom type' property may be retrieved
      using the :oe:meth:`OEChem::OEAtomBase::GetIntType` method. Note that
      IntType is considered volatile and can be overwritten by different algorithms 
      and also is not retained during I/O.

   .. _OEChem_OEAtomBase_SetIsotope:

   .. oe:method:: SetIsotope

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIsotope(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetIsotope(arg2: int) -> bool

      Sets the 'isotopic mass' property of an atom (*i.e.* number of protons and neutrons). 
      The default value is zero, meaning that the atom isn't a specific single 
      isotope, but a composition of isotopes in their naturally occurring abundances.  
      A non-zero value indicates that the atom is a specific isotope.  
      The 'isotopic mass' property can be  retrieved using the 
      :oe:meth:`OEChem::OEAtomBase::GetIsotope` method.

   .. _OEChem_OEAtomBase_SetMapIdx:

   .. oe:method:: SetMapIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMapIdx(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetMapIdx(arg2: int) -> bool

      Sets the 'reaction map index' property of an atom. This integer value is
      used for tracking equivalent atom positions in a reaction
      molecule/transform. The default value is zero, meaning that the
      atom isn't mapped in the reaction.

      .. seealso::

         * :oe:meth:`OEChem::OEAtomBase::GetMapIdx` method

   .. _OEChem_OEAtomBase_SetName:

   .. oe:method:: SetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetName(const char *)=0
            bool SetName(const std::string &)=0

      .. oe:language:: python

         .. oe:api:: python

            SetName(arg2: str) -> bool

      Sets the 'atom name' property of an atom. This property is
      typically used when reading or writing molecular file
      formats. For example in PDB files, the atom name `` CA `` is
      used to denote that the atom is a peptide alpha carbon. The
      default value is the empty string. The 'atom name' property may
      be retrieved using the :oe:meth:`OEChem::OEAtomBase::GetName`
      method.

   .. _OEChem_OEAtomBase_SetPartialCharge:

   .. oe:method:: SetPartialCharge

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPartialCharge(float)=0
            bool SetPartialCharge(double)=0

      .. oe:language:: python

         .. oe:api:: python

            SetPartialCharge(arg2: float) -> bool

      Sets the 'partial charge' property of an atom. The default value
      is ``0.0``. The 'partial charge' property may be retrieved using
      the :oe:meth:`OEChem::OEAtomBase::GetPartialCharge` method.

   .. _OEChem_OEAtomBase_SetRadius:

   .. oe:method:: SetRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRadius(double)

      .. oe:language:: python

         .. oe:api:: python

            SetRadius(arg2: float) -> bool

      Sets the 'radius' property of an atom.  
      The assigned radius may be retrieved using the  
      :oe:meth:`OEChem::OEAtomBase::GetRadius` method.  
      The 'radius' property is typically used to hold a Van der Waal's 
      or ionic radius for a given atom when passing an :ref:`OEMolBase <OEChem_OEMolBase>`
      to an algorithm requiring some form of radii, such as a surface area 
      calculation.

      .. seealso::

         * :oe:func:`OEChem::OEAssignCovalentRadii`
         * :oe:func:`OEChem::OEAssignDelphiRadii`
         * :oe:func:`OEChem::OEAssignBondiVdWRadii`
         * :oe:func:`OEChem::OEAssignPaulingVdWRadii`
         * :oe:func:`OEChem::OEAssignHonigIonicCavityRadii`
         * :oe:func:`OEChem::OEAssignZap9Radii`

   .. _OEChem_OEAtomBase_SetRxnRole:

   .. oe:method:: SetRxnRole

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRxnRole(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetRxnRole(arg2: int) -> bool

      Sets the 'reaction role' property of an atom in a reaction
      molecule/transform. The set of valid values for this
      property is defined by the :oe:constns:`OEChem::OERxnRole`
      namespace. The default value is zero,
      :oe:const:`OEChem::OERxnRole::None`, which means that the atom
      does have a role, *i.e.* is part of a normal molecule. Other
      values include :oe:const:`OEChem::OERxnRole::Reactant`,
      :oe:const:`OEChem::OERxnRole::Agent` and
      :oe:const:`OEChem::OERxnRole::Product` which correspond to
      reactant, agent and product atoms, respectively, in a reaction
      or transform. The 'reaction role' property may be retrieved using
      the :oe:meth:`OEChem::OEAtomBase::SetRxnRole` method.

   .. _OEChem_OEAtomBase_SetStereo:

   .. oe:method:: SetStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStereo(const std::vector<OEAtomBase *> & neighs,
                           unsigned int stereoclass, unsigned int stereovalue)

      .. oe:language:: python

         .. oe:api:: python

            SetStereo(arg2: OEAtomVector, arg3: int, arg4: int) -> bool

      Sets the stereochemistry annotation of the atom.

      *neighs*
         A vector of neighboring atoms that defines the stereochemistry.

      *stereoclass*
         **OEChem TK** currently only supports the tetrahedral atom stereochemistry class.
         The only valid *stereoclass* value is :oe:const:`OEChem::OEAtomStereo::Tetra`.

      *stereovalue*
         This value can be either :oe:const:`OEChem::OEAtomStereo::Left` or
         :oe:const:`OEChem::OEAtomStereo::Right` when specifying a tetrahedral
         atom stereo center, or :oe:const:`OEChem::OEAtomStereo::Undefined` when
         unspecifying *i.e.* deleting an atom stereo center.

      This method returns ``true`` if the atom
      stereo was correctly set, and ``false`` if the stereochemistry
      class is invalid, the stereochemistry value is invalid for the
      stereochemistry class, or the vector of neighboring atoms is
      invalid. The stereo information of an atom may be retrieved using
      the :oe:meth:`OEChem::OEAtomBase::GetStereo`.

      If set successfully, to a value other than
      :oe:const:`OEChem::OEAtomStereo::Undefined`, future calls to
      :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` with the given
      stereochemistry class (or :oe:const:`OEChem::OEAtomStereo::All`)
      will return ``true``. If successfully set to the value
      :oe:const:`OEChem::OEAtomStereo::Undefined`, future calls to
      :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` will return
      ``false``.

      .. seealso::
 
         * :term:`stereo atom`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEAtomBase::SetChiral`

   .. _OEChem_OEAtomBase_SetSymmetryClass:

   .. oe:method:: SetSymmetryClass

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSymmetryClass(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetSymmetryClass(arg2: int) -> bool

      Sets the symmetry class of an atom. This routine is normally
      only called by the 
      :oe:func:`OEChem::OEPerceiveSymmetry` function. The default value is zero,
      indicating that the symmetry class hasn't be perceived. The
      symmetry class of an atom may be retrieved by using the
      :oe:meth:`OEChem::OEAtomBase::GetSymmetryClass` function.

   .. _OEChem_OEAtomBase_SetType:

   .. oe:method:: SetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetType(const char *)=0
            bool SetType(const std::string &)=0

      .. oe:language:: python

         .. oe:api:: python

            SetType(arg2: str) -> bool

      Sets the 'atom type name'  property of an atom. This value
      is typically used when reading and writing molecular
      formats. For example, in Sybyl :file:`mol2` file, the atom type name
      ``N.pl3`` means that the atom should be treated as a
      three-valent planar nitrogen. The default value is the empty
      string. The 'atom type name' property may be retrieved using the
      :oe:meth:`OEChem::OEAtomBase::GetType` method.

   .. _OEChem_OEAtomBase_Sweep:

   .. oe:method:: Sweep
      :language: c++ java csharp

      .. oe:api::

         bool Sweep()=0



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomBondSet, AtomBondSet

.. _OEChem_OEAtomBondSet:

.. oe:class:: OEAtomBondSet

   .. oe:api::

      class OEAtomBondSet : public OESystem::OERoleSet

   This class represents `OEAtomBondSet` that is a container that holds
   atom and bond pointers.

   The following methods are publicly inherited from :ref:`OERoleSet <OESystem_OERoleSet>`:

   ======================================================= ======================================================= =======================================================
   :oe:meth:`AddRole<OESystem::OERoleSet::AddRole>`        :oe:meth:`GetRoles<OESystem::OERoleSet::GetRoles>`
   :oe:meth:`ClearRoles<OESystem::OERoleSet::ClearRoles>`  :oe:meth:`HasRole<OESystem::OERoleSet::HasRole>`
   :oe:meth:`DeleteRole<OESystem::OERoleSet::DeleteRole>`  :oe:meth:`NumRoles<OESystem::OERoleSet::NumRoles>`
   ======================================================= ======================================================= =======================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomBondSet()

      .. oe:language:: python

         .. oe:api:: python

            OEAtomBondSet() -> OEAtomBondSet

      Default constructor that generates an empty container.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomBondSet(rhs: OEAtomBondSet, amap: OEAtomBase = (OEAtomBase, bmap: OEBondBase = (OEBondBase) -> OEAtomBondSet

      .. oe:language:: python

         .. oe:api:: python

            OEAtomBondSet(rhs: OEAtomBondSet, amap: OEAtomBase = (OEAtomBase, bmap: OEBondBase = (OEBondBase) -> OEAtomBondSet

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomBondSet(OESystem::OEIter<OEChem::OEAtomBase>& atoms)
            OEAtomBondSet(OESystem::OEIter<OEChem::OEBondBase>& bonds)
            OEAtomBondSet(OESystem::OEIterBase<OEChem::OEAtomBase>* atoms)
            OEAtomBondSet(OESystem::OEIterBase<OEChem::OEBondBase>* bonds)
            OEAtomBondSet(OESystem::OEIter<OEChem::OEAtomBase>& atoms,
                          OESystem::OEIter<OEChem::OEBondBase>& bonds)
            OEAtomBondSet(OESystem::OEIterBase<OEChem::OEAtomBase>* atoms,
                          OESystem::OEIterBase<OEChem::OEBondBase>* bonds)

      .. oe:language:: python

         .. oe:api:: python

            OEAtomBondSet(atoms: OEAtomIter) -> OEAtomBondSet
            OEAtomBondSet(bonds: OEBondIter) -> OEAtomBondSet
            OEAtomBondSet(atoms: OEAtomIter, bonds: OEBondIter) -> OEAtomBondSet

      Constructors that generate an :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`
      container with the given atoms and bonds.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAtomBondSet &operator=(const OEAtomBondSet &rhs)

      Assignment operator.

   .. oe:method:: Add

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Add(const OEMolBase& mol,
                     const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& atompred)
            bool Add(const OEMolBase& mol,
                     const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& bondpred)
            bool Add(const OEMolBase& mol,
                     const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& atompred,
                     const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& bondpred)
            bool Add(const OEAtomBondSet& abset)

      .. oe:language:: python

         .. oe:api:: python

            Add(mol: Union[OEGraphMol,OEMol,OEQMol], atompred: OEUnaryAtomPred) -> bool
            Add(mol: Union[OEGraphMol,OEMol,OEQMol], bondpred: OEUnaryBondPred) -> bool
            Add(mol: Union[OEGraphMol,OEMol,OEQMol], atompred: OEUnaryAtomPred,
                bondpred: OEUnaryBondPred) -> bool
            Add(abset: OEAtomBondSet) -> bool

      Adds the atom and bond objects to the container. Returns ``false`` if given a null
      pointer or if the atoms or bonds being added do not belong to the same
      molecule previous objects in the set belong to.

      .. seealso::

         * :oe:meth:`OEChem::OEAtomBondSet::GetParent` method

   .. oe:method:: AddAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddAtom(OEChem::OEAtomBase* atom)

      .. oe:language:: python

         .. oe:api:: python

            AddAtom(atom: OEAtomBase) -> bool

      Adds an atom to the container. Returns ``false`` if given a null
      pointer or if the atom being added does not belong to the same
      molecule previous atoms and bonds in the set belong to.

      .. seealso::

         * :oe:meth:`OEChem::OEAtomBondSet::GetParent` method

   .. oe:method:: AddAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddAtoms(const std::vector<OEChem::OEAtomBase *>& atoms)

      .. oe:language:: python

         .. oe:api:: python

            AddAtoms(atoms: OEAtomVector) -> bool

      Adds all the atoms to the container. Returns ``false`` if given a null
      pointer or if any atom being added does not belong to the same
      molecule previous atoms and bonds in the set belong to.

      .. seealso::

         * :oe:meth:`OEChem::OEAtomBondSet::GetParent` method

   .. oe:method:: AddBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddBond(OEChem::OEBondBase* bond)

      .. oe:language:: python

         .. oe:api:: python

            AddBond(bond: OEBondBase) -> bool

      Adds a bond to the container. Returns ``false`` if given a null
      pointer or if the bond being added does not belong to the same
      molecule previous atoms and bonds in the set belong to.

      .. seealso::

         * :oe:meth:`OEChem::OEAtomBondSet::GetParent` method

   .. oe:method:: AddBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddBonds(const std::vector<OEChem::OEBondBase *>& bonds)

      .. oe:language:: python

         .. oe:api:: python

            AddBonds(bonds: OEBondVector) -> bool

      Adds all the bonds to the container. Returns ``false`` if given a null
      pointer or if any bond being added does not belong to the same
      molecule previous atoms and bonds in the set belong to.

      .. seealso::

         * :oe:meth:`OEChem::OEAtomBondSet::GetParent` method

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Removes all atoms and bonds from the
      :oe:cls:`OEAtomBondSet<OEChem::OEAtomBondSet>`
      and clears the :ref:`OERoleSet <OESystem_OERoleSet>`.

   .. oe:method:: ClearAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearAtoms()

      .. oe:language:: python

         .. oe:api:: python

            ClearAtoms() -> None

      Removes all atoms from the
      :oe:cls:`OEAtomBondSet<OEChem::OEAtomBondSet>`.

   .. oe:method:: ClearAtomsAndBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearAtomsAndBonds()

      .. oe:language:: python

         .. oe:api:: python

            ClearAtomsAndBonds() -> None

      Removes all atoms and bonds from the
      :oe:cls:`OEAtomBondSet<OEChem::OEAtomBondSet>` but retains
      the existing  :ref:`OERoleSet <OESystem_OERoleSet>`.

   .. oe:method:: ClearBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearBonds()

      .. oe:language:: python

         .. oe:api:: python

            ClearBonds() -> None

      Removes all bonds from the
      :oe:cls:`OEAtomBondSet<OEChem::OEAtomBondSet>`.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEAtomBondSet* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomBondSet

      Deep copy constructor that returns a copy of the object.
      The memory for the returned object derived from
      :oe:cls:`OEAtomBondSet<OEChem::OEAtomBondSet>`
      is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: HasAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasAtom(const OEChem::OEAtomBase* atom) const

      .. oe:language:: python

         .. oe:api:: python

            HasAtom(atom: OEAtomBase) -> bool

      Returns whether ``atom`` already belongs to the set.

   .. oe:method:: HasBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasBond(const OEChem::OEBondBase* bond) const

      .. oe:language:: python

         .. oe:api:: python

            HasBond(bond: OEBondBase) -> bool

      Returns whether ``bond`` already belongs to the set.

   .. oe:method:: IsEmpty

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsEmpty() const

      .. oe:language:: python

         .. oe:api:: python

            IsEmpty() -> bool

      Returns whether the set contains any atoms or bonds.

   .. oe:method:: GetAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEAtomBase>* GetAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> OEAtomIter

      Returns an iterator over the atoms that are stored in the
      :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEAtomBase>* GetAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms(atompred: OEUnaryAtomPred) -> OEAtomIter

      Returns an iterator over all of the atoms in the container that
      match the specified atom predicate
      (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`).

   .. oe:method:: GetBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEBondBase>* GetBonds() const

      .. oe:language:: python

         .. oe:api:: python

            GetBonds() -> OEBondIter

      Returns an iterator over the bonds that are stored in the
      :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBondBase>* GetBonds(const OESystem::OEUnaryPredicate<OEChem::OEBondBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBonds(bondpred: OEUnaryBondPred) -> OEBondIter

      Returns an iterator over all of the bonds in the container that
      match the specified bond predicate
      (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`).

   .. oe:method:: GetParent

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMolBase* GetParent() const

      .. oe:language:: python

         .. oe:api:: python

            GetParent() -> OEGraphMol

      Returns the parent molecule of a :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`
      object.
      This method can be used to determine the molecule of which atoms
      and bonds the container stores.
      The 'parent molecule' property of a :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`
      object cannot be altered, as it is determined at the point the
      container is created.
      The :oe:meth:`OEChem::OEAtomBondSet::GetParent` method returns a
      null pointer if the container is empty.

   .. oe:method:: NumAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            NumAtoms() -> int

      Returns the number of atoms stored in the
      :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& atompred) const

      .. oe:language:: python

         .. oe:api:: python

            NumAtoms(atompred: OEUnaryAtomPred) -> int

      Returns the number of atoms stored in the
      :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object matching the provided predicate.

   .. oe:method:: NumBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumBonds() const

      .. oe:language:: python

         .. oe:api:: python

            NumBonds() -> int

      Returns the number of bonds stored in the
      :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumBonds(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& bondpred) const

      .. oe:language:: python

         .. oe:api:: python

            NumBonds(bondpred: OEUnaryBondPred) -> int

      Returns the number of bonds stored in the
      :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object matching the provided predicate.

   .. oe:method:: Remove

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Remove(const OEMolBase& mol,
                        const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& atompred)
            bool Remove(const OEMolBase& mol,
                        const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& bondpred)
            bool Remove(const OEMolBase& mol,
                        const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& atompred,
                        const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& bondpred)
            bool Remove(const OEAtomBondSet& abset)

      .. oe:language:: python

         .. oe:api:: python

            Remove(mol: Union[OEGraphMol,OEMol,OEQMol],
                   atompred: OEUnaryAtomPred) -> bool
            Remove(mol: Union[OEGraphMol,OEMol,OEQMol],
                   bondpred: OEUnaryBondPred) -> bool
            Remove(mol: Union[OEGraphMol,OEMol,OEQMol],
                   atompred: OEUnaryAtomPred, bondpred: OEUnaryBondPred) -> bool
            Remove(abset: OEAtomBondSet) -> bool

      Removes the objects from the container. Returns ``false`` if given a null
      pointer or if any of the objects being removed do not belong to the same
      molecule previous objects in the set belong to.

   .. oe:method:: RemoveAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RemoveAtom(OEChem::OEAtomBase* atom)

      .. oe:language:: python

         .. oe:api:: python

            RemoveAtom(atom: OEAtomBase) -> bool

      Removes an atom from the container. Returns ``false`` if given a null
      pointer or if the atom being removed does not belong to the same
      molecule previous atoms in the set belong to.

   .. oe:method:: RemoveAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RemoveAtoms(const std::vector<OEChem::OEAtomBase *>& atoms)

      .. oe:language:: python

         .. oe:api:: python

            RemoveAtoms(atoms: OEAtomVector) -> bool

      Removes atoms from the container. Returns ``false`` if given a null
      pointer or if any atoms being removed do not belong to the same
      molecule previous atoms in the set belong to.

   .. oe:method:: RemoveBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RemoveBond(OEChem::OEBondBase* bond)

      .. oe:language:: python

         .. oe:api:: python

            RemoveBond(bond: OEBondBase) -> bool

      Removes a bond from the container. Returns ``false`` if given a null
      pointer or if the bond being removed does not belong to the same
      molecule previous bonds in the set belong to.

   .. oe:method:: RemoveBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RemoveBonds(const std::vector<OEChem::OEBondBase *>& bonds)

      .. oe:language:: python

         .. oe:api:: python

            RemoveBonds(bonds: OEBondVector) -> bool

      Removes bonds from the container. Returns ``false`` if given a null
      pointer or if any bonds being removed do not belong to the same
      molecule previous bonds in the set belong to.

   .. oe:method:: Sweep

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Sweep()

      .. oe:language:: python

         .. oe:api:: python

            Sweep() -> bool

      Removes deleted atoms and bonds from the container.

   .. oe:method:: Translate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Translate(OEAtomBase** amap, OEBondBase** bmap)

      .. oe:language:: python

         .. oe:api:: python

            Translate(amap: OEAtomBase, bmap: OEBondBase) -> bool

      Translates the pointers in the container based on the provided
      mapping between the atoms or bonds in the array arguments.
      This can be used to convert an existing :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`
      container to refer to a copy of the molecule made from
      a subset operations.

      .. seealso::

         :oe:func:`OEChem::OESubsetMol`



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomIsInAgent, AtomIsInAgent

.. _OEChem_OEAtomIsInAgent:

.. oe:class:: OEAtomIsInAgent

   .. oe:api::

      class OEAtomIsInAgent : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEAtomIsInAgent <OEChem_OEAtomIsInAgent>` functor that
   identifies atoms of the catalysts or solvents of a reaction.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::GetRxnRole`
      method returns :oe:const:`OEChem::OERxnRole::Agent` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomIsInAgent

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAtomIsInAgent <OEChem_OEAtomIsInAgent>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomIsInChain, AtomIsInChain

.. _OEChem_OEAtomIsInChain:

.. oe:class:: OEAtomIsInChain

   .. oe:api::

      struct OEAtomIsInChain : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEAtomIsInChain <OEChem_OEAtomIsInChain>` functor that
   identifies chain atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. seealso::

      * :ref:`OEAtomIsInRing <OEChem_OEAtomIsInRing>` predicate

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsInRing`
      method returns ``false`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomIsInChain

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAtomIsInChain <OEChem_OEAtomIsInChain>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomIsInProduct, AtomIsInProduct

.. _OEChem_OEAtomIsInProduct:

.. oe:class:: OEAtomIsInProduct

   .. oe:api::

      class OEAtomIsInProduct : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEAtomIsInProduct <OEChem_OEAtomIsInProduct>` functor that
   identifies atoms of the product molecule(s) of a reaction.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::GetRxnRole`
      method returns :oe:const:`OEChem::OERxnRole::Product` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomIsInProduct

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAtomIsInProduct <OEChem_OEAtomIsInProduct>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomIsInReactant, AtomIsInReactant

.. _OEChem_OEAtomIsInReactant:

.. oe:class:: OEAtomIsInReactant

   .. oe:api::

      class OEAtomIsInReactant : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEAtomIsInReactant <OEChem_OEAtomIsInReactant>` functor that
   identifies atoms of the reactant molecule(s) of a reaction.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::GetRxnRole`
      method returns :oe:const:`OEChem::OERxnRole::Reactant` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomIsInReactant

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAtomIsInReactant <OEChem_OEAtomIsInReactant>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomIsInResidue, AtomIsInResidue

.. _OEChem_OEAtomIsInResidue:

.. oe:class:: OEAtomIsInResidue

   .. oe:api::

      class OEAtomIsInResidue : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEAtomIsInResidue <OEChem_OEAtomIsInResidue>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with a given
   residue (:ref:`OEResidue <OEChem_OEResidue>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomIsInResidue(const OEResidue& r)

      .. oe:language:: python

         .. oe:api:: python

            OEAtomIsInResidue(r: OEResidue) -> OEAtomIsInResidue

      Constructs the functor with :ref:`OEResidue <OEChem_OEResidue>` as the
      internally specified residue.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomIsInResidue(const OEAtomIsInResidue& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEAtomIsInResidue(rhs: OEAtomIsInResidue) -> OEAtomIsInResidue

      Copy constructor.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the atom is in the residue specified as the
      construction argument. This is the same as the value returned by
      :oe:func:`OEChem::OESameResidue` (r, :oe:func:`OEChem::OEAtomGetResidue` (atom) ), 
      where 'r' is the
      functor's construction :ref:`OEResidue <OEChem_OEResidue>` argument.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomIsInResidue

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAtomIsInResidue <OEChem_OEAtomIsInResidue>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 
 

     


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomIsInRing, AtomIsInRing

.. _OEChem_OEAtomIsInRing:

.. oe:class:: OEAtomIsInRing

   .. oe:api::

      struct OEAtomIsInRing : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEAtomIsInRing <OEChem_OEAtomIsInRing>` functor that
   identifies ring atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. seealso::

      * :ref:`OEAtomIsInChain <OEChem_OEAtomIsInChain>` predicate

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsInRing`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomIsInRing

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAtomIsInRing <OEChem_OEAtomIsInRing>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`ringsubset.cpp<section_example_oechem_ringsubset>`
      * Example program :ref:`extractscaffold.cpp<section_example_oechem_extractscaffold>`

  .. oe:language:: python

      * Example program :ref:`ringsubset.py<section_example_oechem_ringsubset>`
      * Example program :ref:`extractscaffold.py<section_example_oechem_extractscaffold>`

  .. oe:language:: java

      * Example program :ref:`RingSubset.java<section_example_oechem_ringsubset>`
      * Example program :ref:`ExtractScaffold.java<section_example_oechem_extractscaffold>`

  .. oe:language:: csharp

      * Example program :ref:`RingSubset.cs<section_example_oechem_ringsubset>`
      * Example program :ref:`ExtractScaffold.cs<section_example_oechem_extractscaffold>`


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEBondBase, BondBase

..  _OEBondBase:

.. _OEChem_OEBondBase:

.. oe:class:: OEBondBase

   .. oe:api::

      class OEBondBase : public OESystem::OEBase

   The :ref:`OEBondBase <OEChem_OEBondBase>` class is the abstract interface for
   representing bonds within **OpenEye's Toolkits**. An :ref:`OEBondBase <OEChem_OEBondBase>`
   object is created by calling the
   :oe:meth:`OEChem::OEMolBase::NewBond` method on the parent molecule.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   The following classes derive from this class:
    * :ref:`OEQBondBase <OEChem_OEQBondBase>`
   

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBondBase& operator=(const OEBondBase& b)

      Assignment operator.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()=0

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

   .. oe:method:: GetBgn

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomBase* GetBgn() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBgn() -> OEAtomBase

      Returns the 'begin' (or 'source') atom of a bond. The begin atom
      of a bond is defined either when the bond is created with
      :oe:meth:`OEChem::OEMolBase::NewBond`, or possibly by a call to
      the :oe:meth:`OEChem::OEBondBase::SetBgn` method. If the begin
      atom was specified as the NULL pointer,
      (:oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`)0, when the
      bond was created, this method may return a NULL pointer.

      .. seealso::

         * :oe:meth:`OEChem::OEBondBase::GetEnd` method

   .. oe:method:: GetBgnIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetBgnIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetBgnIdx() -> int

      Returns the atom index of the 'begin' (or 'source') atom of a
      bond. This method is equivalent to
      :oe:meth:`OEChem::OEBondBase::GetBgn()<OEChem::OEBondBase::GetBgn>`->
      :oe:meth:`GetIdx<OEChem::OEAtomBase::GetIdx>`.

      .. seealso::
 
         * :ref:`chapter_atombondindices` chapter

   .. oe:method:: GetEnd

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomBase* GetEnd() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetEnd() -> OEAtomBase

      Returns the 'end' (or 'destination') atom of a bond. The end atom
      of a bond is defined either when the bond is created with
      :oe:meth:`OEChem::OEMolBase::NewBond`, or possibly by a call to
      the :oe:meth:`OEChem::OEBondBase::SetEnd` method. If the begin
      atom was specified as the NULL pointer,
      (:oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`)0, when the
      bond was created, this method may return a NULL pointer.

   .. oe:method:: GetEndIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetEndIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetEndIdx() -> int

      Returns the atom index of the 'end' (or 'destination') atom of a
      bond. This method is equivalent to
      :oe:meth:`OEChem::OEBondBase::GetEnd()<OEChem::OEBondBase::GetEnd>`->
      :oe:meth:`GetIdx<OEChem::OEAtomBase::GetIdx>`.

      .. seealso::
 
         * :ref:`chapter_atombondindices` chapter

   .. oe:method:: GetIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetIdx() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetIdx() -> int

      Returns the bond index of a bond. This value is assigned
      when a bond is created. The bond index is unique for
      the bonds of a given molecule, and is stable (not reused) for
      the lifetime of that :ref:`OEMolBase <OEChem_OEMolBase>`. These values
      may not be assigned sequentially, and may contain gaps. Bond
      indices are guaranteed to be less than
      :oe:meth:`OEChem::OEMolBase::GetMaxBondIdx`. Bond indices are
      typically only used for efficiently storing data in arrays (or
      vectors) externally to the :ref:`OEMolBase <OEChem_OEMolBase>`. The
      arrays can be conveniently indexed via
      :oe:meth:`OEChem::OEBondBase::GetIdx`. For iterating across the
      bonds of a molecule, use :oe:meth:`OEChem::OEMolBase::GetBonds`
      and for keeping track of a particular bond use its
      :oe:cls:`OEChem::OEBondBase*<OEChem::OEBondBase>`.

      .. seealso::
 
         * :ref:`chapter_atombondindices` chapter

   .. oe:method:: GetIntType

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetIntType() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetIntType() -> int

      Returns the 'integer bond type' property of a bond. The default value is
      zero. The 'integer bond type' property may be set using the
      :oe:meth:`OEChem::OEBondBase::SetIntType` method.

   .. oe:method:: GetNbr

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomBase* GetNbr(const OEAtomBase * nbr) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetNbr(arg2: OEAtomBase) -> OEAtomBase

      Returns the atom across the bond from the specified atom. If the
      'nbr' argument represents the begin atom of the bond, *i.e.*
      :oe:meth:`OEChem::OEBondBase::GetBgn`, this method returns the
      end atom, *i.e.* :oe:meth:`OEChem::OEBondBase::GetEnd`, and if
      the 'nbr' argument is the end atom, this method returns the
      begin atom (:oe:meth:`OEChem::OEBondBase::GetBgn`). If passed an
      atom other than the begin or end atoms, this method returns a
      NULL pointer,
      (:oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`)0. This
      method is often used for traversing the atoms of a molecule.

   .. oe:method:: GetOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetOrder() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetOrder() -> int

      Returns the 'bond order' property of a bond. The 'bond order' property is
      one, for single bonds, two for double bonds, three for triple
      bonds and four for quadruple bonds. The default value is
      specified when a bond is created using
      :oe:meth:`OEChem::OEMolBase::NewBond`. The 'bond order' property of
      a bond may be set using the
      :oe:meth:`OEChem::OEBondBase::SetOrder` method.

   .. oe:method:: GetParent

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolBase* GetParent() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetParent() -> OEGraphMol

      Returns the parent molecule of a bond. All
      :oe:cls:`OEChem::OEBondBases<OEChem::OEBondBase>` are created as
      a component of an :ref:`OEMolBase <OEChem_OEMolBase>`, this method can be
      used to determine the molecule of which a bond is part. The
      'parent molecule' property of a bond cannot be assigned, as its
      determined at the point the bond is created.

   .. oe:method:: GetStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetStereo(const std::vector<OEAtomBase *>& neighs,
                                   unsigned int stereoclass) const

      .. oe:language:: python

         .. oe:api:: python

            GetStereo(arg2: OEAtomVector, arg3: int) -> int

      Returns the stereochemistry annotation of the bond.

      *neighs*
        A vector of adjacent atoms of the bond.

      *stereoclass*
         **OEChem TK** currently only supports the cis/trans bond stereochemistry class.
         The only valid *stereoclass* value is :oe:const:`OEChem::OEBondStereo::CisTrans`.

      This method returns the value :oe:const:`OEChem::OEBondStereo::Undefined` if
      the stereo chemistry for the given stereochemistry class is
      unspecified, if the stereo chemistry class is invalid or if the
      vector of adjacent atoms is invalid.

      For a specified cis/trans stereo center, it returns either
      :oe:const:`OEChem::OEBondStereo::Cis` or
      :oe:const:`OEChem::OEBondStereo::Trans`.

      The stereochemistry annotation of a bond may be set
      using the :oe:meth:`OEChem::OEBondBase::SetStereo` method.

      .. seealso::

         * :term:`stereo bond`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEBondBase::IsChiral` method
         * :oe:meth:`OEChem::OEBondBase::HasStereoSpecified` method

   .. oe:method:: GetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetType() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetType() -> str

      Returns the 'bond type name' property of a bond. This value is
      typically used when reading and writing molecular formats. For
      example, in Sybyl :file:`mol2` file, the bond type name ``am``
      means that the bond should be treated as an amide bond. The
      default value is the empty string. The 'bond type name' property
      may be set using the :oe:meth:`OEChem::OEBondBase::SetType` method.

   .. oe:method:: HasStereoSpecified

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasStereoSpecified(unsigned int v = OEBondStereo::All) const

      .. oe:language:: python

         .. oe:api:: python

            HasStereoSpecified(v: int) -> bool

      Determines whether the given bond has specified
      stereochemistry. The optional argument specifies the class of
      stereochemistry to check for. The default value,
      :oe:const:`OEChem::OEBondStereo::All`, checks whether any class
      of stereochemistry is specified for the current bond.

      If a bond has unspecified
      stereochemistry, and this method returns ``false``, the
      molecule is assumed to represent either a racemic mixture or an
      undetermined isomer of this compound. If this method returns
      ``true``, this bond has an explicit stereochemistry which may be
      retrieved using the :oe:meth:`OEChem::OEBondBase::GetStereo`
      method.

      This method initially returns ``false`` for a newly created
      bond. The stereochemistry of a bond may be set by calling the
      :oe:meth:`OEChem::OEBondBase::SetStereo` method with the
      appropriate stereochemistry class, c, and any value other than
      :oe:const:`OEChem::OEBondStereo::Undefined`. The bond
      stereochemistry may subsequently be cleared by calling the same
      method, with the appropriate stereochemistry class, but
      specifying the value :oe:const:`OEChem::OEBondStereo::Undefined`.

      .. seealso::
 
         * :term:`stereo bond`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEBondBase::IsChiral` method
         * :oe:meth:`OEChem::OEBondBase::GetStereo` method

   .. oe:method:: IsAromatic

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsAromatic() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsAromatic() -> bool

      Returns the 'aromatic' property of a bond. The default value is
      ``false``. The 'aromatic' property of a bond can be set using the
      :oe:meth:`OEChem::OEBondBase::SetAromatic` method. The 'aromatic'
      property of bonds and atoms in a molecule are typically set by
      calling either the :oe:func:`OEChem::OEAssignAromaticFlags`
      function, or the :oe:func:`OEChem::OEClearAromaticFlags`
      function.

      .. seealso::

         * :ref:`chapter_aromaticity` chapter 

   .. oe:method:: IsChiral

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsChiral() const

      .. oe:language:: python

         .. oe:api:: python

            IsChiral() -> bool

      Determines whether the current bond is a stereogenic center. If
      this method returns ``true``, the bond is a :term:`chiral bond` and
      the cis and trans forms of this bond represent two distinct
      isomers. If this method returns ``false``, this bond is not a
      chiral stereocenter.

      .. note::

         This :term:`chiral bond` property is independent of the
         :term:`stereo bond` property that records whether a particular
         cis or trans configuration is specified at a
         particular bond.

      .. seealso::
 
         * :term:`chiral bond`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEBondBase::GetStereo` method
         * :oe:meth:`OEChem::OEBondBase::HasStereoSpecified` method

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

   .. oe:method:: IsDeleted

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDeleted() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsDeleted() -> bool

   .. oe:method:: IsInRing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsInRing() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsInRing() -> bool

      Returns the 'in ring' property of a bond. The default value is
      ``false``. The 'in ring' property of a bond may be set using
      the :oe:meth:`OEChem::OEBondBase::SetInRing` method. The 'in
      ring' properties of bonds and atoms are typically set by calling
      the :oe:func:`OEChem::OEFindRingAtomsAndBonds` function.

      To determine whether a bond is a member of a specific
      ring/cycle size, use the :oe:func:`OEChem::OEBondIsInRingSize` function.

      .. seealso:: 

         * :ref:`chapter_ring` chapter

   .. oe:method:: IsRotor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsRotor() const

      .. oe:language:: python

         .. oe:api:: python

            IsRotor() -> bool

      Determines whether a bond is freely :term:`rotatable<rotatable bond>` 

      .. note::

         Since the  'rotatable' property is depends on the 'in ring' property.
         The  :oe:func:`OEChem::OEFindRingAtomsAndBonds` function must be called
         before accessing the :term:`rotatable bond` property via 
         :oe:meth:`OEChem::OEBondBase::IsRotor`. 

      .. seealso:: 

         * :term:`rotatable bond`
         * :oe:func:`OEMolProp::OEGetRotatableBondCount` function

   .. oe:method:: SetAromatic

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAromatic(bool)=0

      .. oe:language:: python

         .. oe:api:: python

            SetAromatic(arg2: bool) -> bool

      Sets the 'aromatic' property of a bond. This value is ``false``
      by default. The 'aromatic' property of a bond may be retrieved
      using the :oe:meth:`OEChem::OEBondBase::IsAromatic` method. This
      method is normally only used by the
      :oe:func:`OEChem::OEClearAromaticFlags` function and
      :oe:func:`OEChem::OEAssignAromaticFlags` function.

      .. seealso::

         * :ref:`chapter_aromaticity` chapter

   .. oe:method:: SetBgn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBgn(OEAtomBase *)=0

      .. oe:language:: python

         .. oe:api:: python

            SetBgn(arg2: OEAtomBase) -> bool

      Defines the 'begin' (or 'source') atom of a bond. Normally, the
      begin atom of a bond is defined when the bond is created with
      :oe:meth:`OEChem::OEMolBase::NewBond`. However, it is
      occasionally useful to defer this decision, by passing the NULL
      pointer,
      (:oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`)0, as
      the begin atom to :oe:meth:`OEChem::OEMolBase::NewBond`. The
      begin atom should then later be specified by calling this
      method, :oe:meth:`OEChem::OEBondBase::SetBgn`, to resolve the
      begin atom before the molecule is used. Note that it is not
      possible to set/change the begin atom of a bond, once it has
      been defined. To achieve the same behavior call the
      :oe:meth:`OEChem::OEMolBase::DeleteBond` method, followed by
      :oe:meth:`OEChem::OEMolBase::NewBond`, to first destroy the
      original and replace it with a new bond.

   .. oe:method:: SetChiral

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetChiral(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetChiral(arg2: bool) -> bool

      .. seealso::
 
         * :term:`chiral bond`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEBondBase::SetStereo`

   .. oe:method:: SetEnd

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnd(OEAtomBase *)=0

      .. oe:language:: python

         .. oe:api:: python

            SetEnd(arg2: OEAtomBase) -> bool

      Defines the 'end' (or 'destination') atom of a bond. Normally,
      the end atom of a bond is defined when the bond is created with
      :oe:meth:`OEChem::OEMolBase::NewBond`. However, it is
      occasionally useful to defer this decision, by passing the NULL
      pointer, (:oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`)0, as
      the end atom to
      :oe:meth:`OEChem::OEMolBase::NewBond`. The end atom should then
      later be specified by calling this method,
      :oe:meth:`OEChem::OEBondBase::SetEnd`, to resolve the end atom
      before the molecule is used. Note that it is not possible to
      set/change the end atom of a bond, once it has been defined. To
      achieve the same behavior call the
      :oe:meth:`OEChem::OEMolBase::DeleteBond` method, followed by
      :oe:meth:`OEChem::OEMolBase::NewBond`, to first destroy the
      original and replace it with a new bond.

   .. oe:method: SetIdx IGNORED-METHOD

      .. oe:api::

         bool SetIdx(unsigned int)=0

   .. oe:method:: SetInRing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetInRing(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetInRing(arg2: bool) -> bool

      Sets the 'in ring' property of a bond. This property is usually
      set by the :oe:func:`OEChem::OEFindRingAtomsAndBonds`
      function. The default value is ``false``. The 'in ring' property
      of a bond can be retrieved using the
      :oe:meth:`OEChem::OEBondBase::IsInRing` method.

      .. seealso:: 

         * :ref:`chapter_ring` chapter

   .. oe:method:: SetIntType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIntType(int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetIntType(arg2: int) -> bool

      Sets the 'integer bond type' property of a bond. The default value is
      zero. The 'integer bond type' property may be retrieved using the
      :oe:meth:`OEChem::OEBondBase::GetIntType` method.

   .. oe:method:: SetOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOrder(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetOrder(arg2: int) -> bool

      Sets the 'bond order' property of a bond. The 'bond order' property is
      one, for single bonds, two for double bonds, three for triple
      bonds and four for quadruple bonds. The default value is
      specified when a bond is created using
      :oe:meth:`OEChem::OEMolBase::NewBond`. The 'bond order' property of
      a bond may be retrieved using the
      :oe:meth:`OEChem::OEBondBase::GetOrder` method.

   .. oe:method:: SetStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStereo(const std::vector<OEAtomBase *> & neighs,
                           unsigned int stereoclass, unsigned int stereovalue)

      .. oe:language:: python

         .. oe:api:: python

            SetStereo(arg2: OEAtomVector, arg3: int, arg4: int) -> bool

      Sets the stereochemistry annotation of the bond.

      *neighs*
         A vector of neighboring atoms that defines the stereochemistry.

      *stereoclass*
         **OEChem TK** currently only supports the cis/trans bond stereochemistry class.
         The only valid *stereoclass* value is :oe:const:`OEChem::OEBondStereo::CisTrans`.

      *stereovalue*
         This value can be either :oe:const:`OEChem::OEBondStereo::Cis` or
         :oe:const:`OEChem::OEBondStereo::Trans` when specifying a cis/trans
         bond stereo center, or :oe:const:`OEChem::OEBondStereo::Undefined` when
         un-specifying *i.e.* deleting a bond stereo center.

      This method returns ``true`` if the bond chirality
      was correctly set, and ``false`` if the stereochemistry class is
      invalid, the stereochemistry value is invalid for the
      stereochemistry class, or the vector of adjacent atoms is
      invalid. The stereo information of a bond may be retrieved using
      the :oe:meth:`OEChem::OEBondBase::GetStereo`.

      If set successfully, to a value other than
      :oe:const:`OEChem::OEBondStereo::Undefined`, future calls to
      :oe:meth:`OEChem::OEBondBase::HasStereoSpecified` with the given
      stereochemistry class (or :oe:const:`OEChem::OEBondStereo::All`)
      will return ``true``. If successfully set to the value
      :oe:const:`OEChem::OEBondStereo::Undefined`, future calls to
      :oe:meth:`OEChem::OEBondBase::HasStereoSpecified` will return
      ``false``.

      .. seealso::
 
         * :term:`stereo bond`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEBondBase::SetChiral`

   .. oe:method:: SetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetType(const char *)=0
            bool SetType(const std::string &)=0

      .. oe:language:: python

         .. oe:api:: python

            SetType(arg2: str) -> bool

      Sets the 'bond type name' property of a bond. This value is
      typically used when reading and writing molecular formats. For
      example, in Sybyl :file:`mol2` file, the bond type name ``am``
      means that the bond should be treated as an amide bond. The
      default value is the empty string. The 'bond type name' property
      may be retrieved using the :oe:meth:`OEChem::OEBondBase::GetType`
      method.

   .. oe:method:: SwapEnds

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SwapEnds()=0

      .. oe:language:: python

         .. oe:api:: python

            SwapEnds() -> bool

      Swaps the begin and end atoms of a bond. The lists of bonds
      contained in each of the two atoms are not altered. After
      calling the :oe:meth:`OEChem::OEBondBase::SwapEnds` method, the atoms
      returned by the :oe:meth:`OEChem::OEBondBase::GetBgn` and
      :oe:meth:`OEChem::OEBondBase::GetEnd` methods will be
      interchanged.

   .. oe:method:: Sweep

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Sweep()=0

      .. oe:language:: python

         .. oe:api:: python

            Sweep() -> bool



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEBondIsInChain, BondIsInChain

.. _OEChem_OEBondIsInChain:

.. oe:class:: OEBondIsInChain

   .. oe:api::

      struct OEBondIsInChain : public OESystem::OEUnaryPredicate<OEChem::OEBondBase>

   This class represents :ref:`OEBondIsInChain <OEChem_OEBondIsInChain>` functor that
   identifies chain bonds (:ref:`OEBondBase <OEChem_OEBondBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. seealso::

      * :ref:`OEBondIsInRing <OEChem_OEBondIsInRing>` predicate

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEBondBase::IsInRing`
      method returns ``false`` for the given 
      :ref:`OEBondBase <OEChem_OEBondBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEBondBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondIsInChain

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBondIsInChain <OEChem_OEBondIsInChain>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEBondIsInRing, BondIsInRing

.. _OEChem_OEBondIsInRing:

.. oe:class:: OEBondIsInRing

   .. oe:api::

      struct OEBondIsInRing : public OESystem::OEUnaryPredicate<OEChem::OEBondBase>

   This class represents :ref:`OEBondIsInRing <OEChem_OEBondIsInRing>` functor that
   identifies ring bonds (:ref:`OEBondBase <OEChem_OEBondBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. seealso::

      * :ref:`OEBondIsInChain <OEChem_OEBondIsInChain>` predicate

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEBondBase::IsInRing`
      method returns ``true`` for the given 
      :ref:`OEBondBase <OEChem_OEBondBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEBondBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondIsInRing

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBondIsInRing <OEChem_OEBondIsInRing>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECIFCategory, CIFCategory

.. _OEChem_OECIFCategory:

.. oe:class:: OECIFCategory

   .. oe:api::

      struct OECIFCategory

   This class represents the :ref:`OECIFCategory <OEChem_OECIFCategory>` that holds CIF header data and acts as an
   interface to interact with this header data. This object reflects what is contained in a CIF category.

   The :ref:`section_moldata_CIF` section explains in more detail the CIF data structure.

   .. seealso::

      * :oe:cls:`OEChem::OECIFData` class
      * :oe:cls:`OEChem::OECIFOptions` class
      * :ref:`section_moldata_cif`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECIFCategory()
            OECIFCategory(const std::string& categoryName,
                          const std::vector<std::string>& attributes,
                          const std::vector<std::string>& values)
            OECIFCategory(const std::string& categoryName,
                          const std::string& attribute,
                          const std::string& value)
            OECIFCategory(const std::string& categoryName,
                          const std::vector<std::string>& attributes)
            OECIFCategory(const std::string& categoryName)

      .. oe:language:: python

         .. oe:api:: python

            OECIFCategory() -> OECIFCategory
            OECIFCategory(categoryName: str) -> OECIFCategory
            OECIFCategory(categoryName: str, attributes: OEStringVector) -> OECIFCategory
            OECIFCategory(categoryName: str, attributes: OEStringVector,
                          values: OEStringVector) -> OECIFCategory
            OECIFCategory(categoryName: str, attribute: str, value: str) -> OECIFCategory
            OECIFCategory(category: OECIFCategory) -> OECIFCategory

      Create a :ref:`OECIFCategory <OEChem_OECIFCategory>` object.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECIFCategory & operator=(const OECIFCategory & category)

      Assignment operator.

   .. oe:method:: AddAttribute

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddAttribute(const std::string& newAttribute,
                              const std::string& newValue = "?")
            bool AddAttribute(const std::string& newAttribute,
                              const std::vector<std::string>& newValues)

      .. oe:language:: python

         .. oe:api:: python

            AddAttribute(newAttribute: str, newValues: OEStringVector) -> bool

      Adds a column of values to the indicated CIF attribute.
      If no values are input, a question mark "?" value will be used to populate attribute values.

   .. oe:method:: AddRow

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddRow(const std::vector<std::string>& nvals)
            bool AddRow(const std::string init = "?")

      .. oe:language:: python

         .. oe:api:: python

            AddRow(newValues: OEStringVector) -> bool

      Adds a row of value(s) to the CIF category.

      If no values are input, by default, it will add a question mark "?" to every attribute in the category.

   .. oe:method:: DeleteRow

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteRow(unsigned int row)

      .. oe:language:: python

         .. oe:api:: python

            DeleteRow(row: int) -> bool

      Deletes a category's indicated row.

   .. oe:method:: DeleteAttribute

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteAttribute(const std::string& attribute)

      .. oe:language:: python

         .. oe:api:: python

            DeleteAttribute(attribute: str) -> bool

      Deletes a category attribute.

   .. oe:method:: GetAttributes

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetAttributes() const

      .. oe:language:: python

         .. oe:api:: python

            GetAttributes() -> OEStringVector

      Returns the category's attributes.

   .. oe:method:: GetAttributeValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetAttributeValue(const std::string& attribute,
                                          bool raw = false) const
            std::string GetAttributeValue(const std::string& attribute,
                                          unsigned int row, bool raw = false) const

      .. oe:language:: python

         .. oe:api:: python

            GetAttributeValue(attribute: str, raw: bool = False) -> str
            GetAttributeValue(attribute: str, row: int, raw: bool = False) -> str

      Gets the saved value on the indicated attribute.
      If multiple values exist for a given attribute, then a row number must be identified.

   .. oe:method:: GetAttributeValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetAttributeValues(const std::string& attribute,
                                                        bool raw = false) const

      .. oe:language:: python

         .. oe:api:: python

            GetAttributeValues(attribute: str, raw: bool = False) -> OEStringVector

      Gets all the saved values on the indicated attribute.

   .. oe:method:: GetAttributeIndex

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetAttributeIndex(const std::string& attribute) const

      .. oe:language:: python

         .. oe:api:: python

            GetAttributeIndex(attribute: str) -> int

      Returns the attribute's base-0 index. For any given row of data associated with the category, this index
      correlates with the attribute's value in that row.
      For example, if GetAttributeIndex("type")=1, for every row generated by
      GetRows(), the _category.type data would be the [1] value in that row.

   .. oe:method:: GetCategoryName

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetCategoryName() const

      .. oe:language:: python

         .. oe:api:: python

            GetCategoryName() -> str

      Returns the category's name.

   .. oe:method:: GetDataItem

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetDataItem(const std::string& attribute) const

      .. oe:language:: python

         .. oe:api:: python

            GetDataItem(attribute: str) -> str

      Returns the CIF data item name in the format: '_category.attribute'

   .. oe:method:: GetDataItems

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetDataItems() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataItems() -> OEStringVector

      Returns all the CIF data item names in the category in the format: '_category.attribute'

   .. oe:method:: GetNumRows

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumRows() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumRows() -> int

      Number of CIF rows in the category.

   .. oe:method:: GetNumAttributes

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumAttributes() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumAttributes() -> int

      Number of CIF attributes in the category.

   .. oe:method:: GetNumericAttributeValue

      .. oe:language:: c++

         .. oe:api::

            bool GetNumericAttributeValue(const std::string& attribute,
                                          float& val) const
            bool GetNumericAttributeValue(const std::string& attribute,
                                          int& val) const
            bool GetNumericAttributeValue(const std::string& attribute,
                                          unsigned int row, float& val) const
            bool GetNumericAttributeValue(const std::string& attribute,
                                          unsigned int row, int& val) const

      .. oe:language:: java

         .. oe:api::

            GetFloatAttributeValue(String attribute, Float val)
            GetIntAttributeValue(String attribute, Integer val)
            GetFloatAttributeValue(String attribute, Integer row, Float val)
            GetIntAttributeValue(String attribute, Integer row, Integer val)

      Gets the saved value for the indicated attribute and converts it to a numeric value.
      If multiple values exist for a given attribute, then a row number must be identified.
      If a value cannot be easily converted to a numeric value, it will default to 0.

   .. oe:method:: GetNumericAttributeValues

      .. oe:language:: c++

         .. oe:api::

            bool GetNumericAttributeValues(const std::string& attribute,
                                           std::vector<float>& vals) const
            bool GetNumericAttributeValues(const std::string& attribute,
                                           std::vector<int>& vals) const

      .. oe:language:: java

         .. oe:api::

            bool GetFloatAttributeValues(String attribute, Vector<Float> vals)
            bool GetIntAttributeValues(String attribute, Vector<Integer> vals)

      .. oe:language:: python

         .. oe:api:: python

            GetNumericAttributeValues(attribute: str, vals: OEFloatVector) -> bool
            GetNumericAttributeValues(attribute: str, vals: OEIntVector) -> bool

      Gets all the saved values for the indicated attribute and converts to a numeric value.
      If a value cannot be easily converted to a numeric value, it will default to 0.

   .. oe:method:: GetRow

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetRow(unsigned int row, bool raw = false) const

      .. oe:language:: python

         .. oe:api:: python

            GetRow(row: int, raw: bool = False) -> OEStringVector

      Returns as a specific row from the category. Row indicators are base-0.
      Raw values are formatted as they will appear in the header. This is most noticeable with values that contain
      space characters, as CIF formatting requires single or double quotes around such a string value.

   .. oe:method:: GetRows

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::vector<std::string>> GetRows(int beginRow,
                                                          int endRow,
                                                          bool raw = false) const
            std::vector<std::vector<std::string>> GetRows(bool raw = false) const

      .. oe:language:: python

         .. oe:api:: python

            GetRows(beginRow: int, endRow: int, raw: bool = False) -> OEStringVectorVector
            GetRows(raw: bool = False) -> OEStringVectorVector

      Returns rows from the category. Row indicators are base-0.
      Raw values are formatted as they will appear in the header. This is most noticeable with values that contain
      space characters, as CIF formatting requires single or double quotes around such a string value.

   .. oe:method:: GetRowIndices

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<unsigned int> GetRowIndices(const std::string& attribute,
                                                    const std::string& matchValue) const

      .. oe:language:: python

         .. oe:api:: python

            GetRowIndices(attribute: str, matchValue: str) -> OEUIntVector

      Returns the base-0 row indices whose values string-match with input match values.

   .. oe:method:: HasAttribute

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasAttribute(const std::string& attribute) const

      .. oe:language:: python

         .. oe:api:: python

            HasAttribute(attribute: str) -> bool

      Returns if an attribute is present in this object.

   .. oe:method:: SetData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetData(const std::string& attribute,
                         const std::string& newValue)
            bool SetData(const std::string& attribute, unsigned int row,
                         const std::string& newValue,
                         const std::string init = "?")
            bool SetData(const std::string& attribute,
                         const std::vector<std::string>& newValues)
            bool SetData(unsigned int row,
                         const std::vector<std::string>& newValues,
                         const std::string init = "?")

      .. oe:language:: python

         .. oe:api:: python

            SetData(attribute: str, newValues: OEStringVector) -> bool
            SetData(attribute: str, row: int, newValue: str, init: str = "?") -> bool
            SetData(row: int, newValues: OEStringVector, init: str = "?") -> bool

      Sets attribute and row data. When setting data related to row values, if the
      indicated row value exceeds the maximum number of rows, then empty values will populate any undefined attributes
      values.
      Rows indicators are base-0.

   .. oe:method:: SortByAttribute

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SortByAttribute(const std::string& attribute)

      .. oe:language:: python

         .. oe:api:: python

            SortByAttribute(attribute: str) -> None

      All rows will be rearranged according to the alphanumeric order of the indicated attribute's values.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECIFData, CIFData

.. _OEChem_OECIFData:

.. oe:class:: OECIFData

   .. oe:api::

      struct OECIFData

   This class represents :ref:`OECIFData <OEChem_OECIFData>` that holds CIF header data and acts as an interface to
   interact with this header data. This object reflects what is contained in the CIF ``data_`` section.

   The goal for the OECIFData class is to allow a user to freely interact with CIF data and be confident the
   data will be written in proper format that can be easily be read again.
   This object allows structural data stored on the molecule to be synchronized and updated with its CIF header data
   to reflect changes in the molecule. No change in OECIFData will affect the molecule that stores it.

   The overall structure of OECIFData reflects CIF formatting. The OECIFData object stores all the data in a
   ``data_`` block. Values from each CIF category are stored on the OECIFCategory object. Thus, OECIFData is a
   collection of OECIFCategory objects mapped to the category name.

   Access to the data using OECIFData utilizes the CIF category and attribute names. These functions allow a user
   to get, set or add any value in the CIF header.

   .. note::

      Category names must begin with an underscore and end with a period. Example: ``"_entity."``

   The :ref:`section_moldata_CIF` section explains the CIF data structure in more detail.

   .. seealso::

      * :oe:func:`OEChem::OEUpdateMMCIFData` function
      * :oe:cls:`OEChem::OECIFCategory` class
      * :oe:cls:`OEChem::OECIFOptions` class
      * :ref:`section_moldata_cif`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECIFData()
            OECIFData(const std::string& cifHeaderString)
            OECIFData(const OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            OECIFData() -> OECIFData
            OECIFData(cifDataBlockAsString: str) -> OECIFData
            OECIFData(cifData: OECIFData) -> OECIFData
            OECIFData(mol: Union[OEGraphMol,OEMol,OEQMol]) -> OECIFData

      Create an :ref:`OECIFData <OEChem_OECIFData>` object from a header data string, or header data stored on a mol
      accessed using :ref:`OEGetMMCIFData <OEChem_OEGetMMCIFData>`.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECIFData & operator=(const OECIFData & category)

      Assignment operator.

   .. oe:method:: AddCategory

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddCategory(const OECIFCategory& category)
            bool AddCategory(const std::string& categoryName,
                             const std::vector<std::string>& attributes,
                             const std::vector<std::string>& newValues)
            bool AddCategory(const std::string& categoryName,
                             const std::vector<std::string>& attributes)
            bool AddCategory(const std::string& categoryName,
                             const std::string& attribute,
                             const std::vector<std::string>& newValues)
            bool AddCategory(const std::string& categoryName,
                             const std::string& attribute,
                             const std::string& newValue)
            bool AddCategory(const std::string& categoryName)

      .. oe:language:: python

         .. oe:api:: python

            AddCategory(category: OECIFCategory) -> bool
            AddCategory(categoryName: str, attributes: OEStringVector,
                        newValues: OEStringVector) -> bool
            AddCategory(categoryName: str, attributes: OEStringVector) -> bool
            AddCategory(categoryName: str) -> bool

      Adds a new category to the OECIFData object.

   .. oe:method:: AddRow

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddRow(const std::string& categoryName,
                        const std::vector<std::string>& newValues)
            bool AddRow(const std::string& categoryName,
                        const std::string init = "?")

      .. oe:language:: python

         .. oe:api:: python

            AddRow(categoryName: str, newValues: OEStringVector) -> bool

      Adds a row of values to the indicated CIF item prefix.
      If no values are input, by default, it will add a question mark "?" to every attribute in the category.

   .. oe:method:: AddData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddData(const std::string& categoryName,
                         const std::string& attribute,
                         const std::vector<std::string>& newValues)
            bool AddData(const std::string& categoryName,
                         const std::string& attribute,
                         const std::string& newValue = "?")

      .. oe:language:: python

         .. oe:api:: python

            AddData(categoryName: str, attribute: str,
                    newValuess: OEStringVector) -> bool

      Adds a new attribute and a column of its values to the indicated CIF item tag. The number of new data input
      must match the number of rows currently in the OECIFCategory it is being added to.

   .. oe:method:: ChemCompToMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ChemCompToMol(OEMolBase& cifMol, const std::string resName) const

      .. oe:language:: python

         .. oe:api:: python

            ChemCompToMol(cifMol: Union[OEGraphMol,OEMol,OEQMol], resName: str) -> bool

      Creates a molecule from CIF _chem_comp data in the OECIFData object. The following CIF categories must be present
      for proper function:

      * _chem_comp_atom. defines the atom name and element
      * _chem_comp_bond. defines the bonding network

      The input cifMol molecule is cleared before parsing, so the resulting molecule object only contains atoms and bonds
      from the _chem_comp header data.

   .. oe:method:: DeleteCategory

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteCategory(const std::string& categoryName)

      .. oe:language:: python

         .. oe:api:: python

            DeleteCategory(categoryName: str) -> bool

      Deletes a category based on the category name.

   .. oe:method:: DeleteRow

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteRow(const std::string& categoryName, unsigned int row)

      .. oe:language:: python

         .. oe:api:: python

            DeleteRow(categoryName: str, row: int) -> bool

      Deletes a category's indicated row values based on the category name.

   .. oe:method:: DeleteAttribute

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteAttribute(const std::string& categoryName,
                                 const std::string& attribute)

      .. oe:language:: python

         .. oe:api:: python

            DeleteAttribute(categoryName: str, attribute: str) -> bool

      Deletes a category's attribute and associated values.

   .. oe:method:: GenerateHeader

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GenerateHeader() const

      .. oe:language:: python

         .. oe:api:: python

            GenerateHeader() -> str

      Using all the categories saved on this object, this will output the CIF header.

   .. oe:method:: GeneratePolySeqScheme

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GeneratePolySeqScheme(OEMolBase& mol,
                                       const unsigned int maxMismatch = 10)

      .. oe:language:: python

         .. oe:api:: python

            GeneratePolySeqScheme(mol: Union[OEGraphMol,OEMol,OEQMol],
                                  maxMismatch: int = 10) -> bool

      Will generate the _pdbx_poly_seq_scheme header section using header and molecule data.
      The following categories need to be present and properly populated for this function:

      * _struct_asym.
      * _entity.
      * _entity_poly_seq.

      The molecule object must contain at least one residue. Any existing _pdbx_poly_seq_scheme data will be
      cleared before generation.

   .. oe:method:: GetAttributes

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string>  GetAttributes(const std::string& categoryName) const

      .. oe:language:: python

         .. oe:api:: python

            GetAttributes(categoryName: str) -> OEStringVector

      Gets a list of all the attributes in this object.

   .. oe:method:: GetAttributeValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetAttributeValue(const std::string& categoryName,
                                          const std::string& attribute,
                                          bool raw = false) const
            std::string GetAttributeValue(const std::string& categoryName,
                                          const std::string& attribute,
                                          unsigned int row, bool raw = false) const

      .. oe:language:: python

         .. oe:api:: python

            GetAttributeValue(categoryName: str, attribute: str,
                              raw: bool = False) -> str
            GetAttributeValue(categoryName: str, attribute: str, row: int,
                              raw: bool = False) -> str

      Gets the saved value on the indicated category's attribute.
      If multiple values exist for a given attribute, then a row number must be identified.

   .. oe:method:: GetAttributeValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetAttributeValues(const std::string& categoryName,
                                                        const std::string& attribute,
                                                        bool raw = false) const

      .. oe:language:: python

         .. oe:api:: python

            GetAttributeValues(categoryName: str, attribute: str,
                               raw: bool = False) -> OEStringVector

      Gets all the saved values on the indicated category's attribute.

   .. oe:method:: GetAttributeIndex

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetAttributeIndex(const std::string& categoryName,
                                  const std::string& attribute) const

      .. oe:language:: python

         .. oe:api:: python

            GetAttributeIndex(categoryName: str, attribute: str) -> int

      Returns the attribute's base-0 index. For any given row of data associated with the category, this index
      correlates with the attribute's value in that row.
      For example, if GetAttributeIndex("entity.", "type")=1, for every row generated by
      GetRows("_entity."), the _category.type data would be the [1] value in that row.

   .. oe:method:: GetCategory

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECIFCategory& GetCategory(const std::string& categoryName)

      .. oe:language:: python

         .. oe:api:: python

            GetCategory(categoryName: str) -> OECIFCategory

      Gets the :ref:`OECIFCategory <OEChem_OECIFCategory>` object by its category name.

   .. oe:method:: GetCategoryNames

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetCategoryNames() const

      .. oe:language:: python

         .. oe:api:: python

            GetCategoryNames() -> OEStringVector

      Returns all the CIF category names present in this object.

   .. oe:method:: GetDataItems

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string>  GetDataItems(const std::string& categoryName) const

      .. oe:language:: python

         .. oe:api:: python

            GetDataItems(categoryName: str) -> OEStringVector

      Returns a list of all the CIF data items in this object.

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the name of the header data. Value is defined using the molecule's title.

   .. oe:method:: GetNumCategories

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumCategories() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumCategories() -> int

      Number of CIF categories saved in this object.

   .. oe:method:: GetNumCategoryRows

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumCategoryRows(const std::string& categoryName) const

      .. oe:language:: python

         .. oe:api:: python

            GetNumCategoryRows(categoryName: str) -> int

      Number of CIF rows in a category.

   .. oe:method:: GetNumCategoryAttributes

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumCategoryAttributes(const std::string& categoryName) const

      .. oe:language:: python

         .. oe:api:: python

            GetNumCategoryAttributes(categoryName: str) -> int

      Number of CIF attributes in a category.

   .. oe:method:: GetNumericAttributeValue

      .. oe:language:: c++

         .. oe:api::

            bool GetNumericAttributeValue(const std::string& categoryName,
                                          const std::string& attribute,
                                          float& val) const
            bool GetNumericAttributeValue(const std::string& categoryName,
                                          const std::string& attribute,
                                          int& val) const
            bool GetNumericAttributeValue(const std::string& categoryName,
                                          const std::string& attribute,
                                          unsigned int row, float& val) const
            bool GetNumericAttributeValue(const std::string& categoryName,
                                          const std::string& attribute,
                                          unsigned int row, int& val) const

      .. oe:language:: java

         .. oe:api::

            GetFloatAttributeValue(String categoryName, String attribute,
                                   Float val)
            GetIntAttributeValue(String categoryName, String attribute,
                                 Integer val)
            GetFloatAttributeValue(String categoryName, String attribute,
                                   Integer row, Float val)
            GetIntAttributeValue(String categoryName, String attribute,
                                 Integer row, Integer val)

      Gets the saved value on the indicated category's attribute and converts to a numeric value.
      If multiple values exist for a given item attribute, then a row number must be identified.
      If a value cannot be easily converted to a numeric value, it will default to 0.

   .. oe:method:: GetNumericAttributeValues

      .. oe:language:: c++

         .. oe:api::

            bool GetNumericAttributeValues(const std::string& categoryName,
                                           const std::string& attribute,
                                           std::vector<float>& vals) const
            bool GetNumericAttributeValues(const std::string& categoryName,
                                           const std::string& attribute,
                                           std::vector<int>& vals) const

      .. oe:language:: java

         .. oe:api::

            GetFloatAttributeValues(String categoryName, String attribute,
                                    Vector<Float> vals)
            GetIntAttributeValues(String categoryName, String attribute,
                                  Vector<Integer> vals)

      .. oe:language:: python

         .. oe:api:: python

            GetNumericAttributeValues(categoryName: str, attribute: str,
                                      vals: OEFloatVector) -> bool
            GetNumericAttributeValues(categoryName: str, attribute: str,
                                      vals: OEIntVector) -> bool

      Gets all the saved values on the indicated category's attribute and converts to a numeric value.
      If a value cannot be easily converted to a numeric value, it will default to 0.

   .. oe:method:: GetRow

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetRow(const std::string& categoryName,
                                            unsigned int row, bool raw = false) const

      .. oe:language:: python

         .. oe:api:: python

            GetRow(categoryName: str, row: int, raw: bool = False) -> OEStringVector

      Returns a specific row from the indicated category. Rows values are base-0.
      Raw values are formatted as they will appear in the header. This is most noticeable with values that contain
      space characters as CIF formatting requires single or double quotes around such a string value.

   .. oe:method:: GetRows

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::vector<std::string>> GetRows(const std::string& categoryName,
                                                          int beginRow,
                                                          int endRow,
                                                          bool raw = false) const
            std::vector<std::vector<std::string>> GetRows(const std::string& categoryName,
                                                          bool raw = false) const

      .. oe:language:: python

         .. oe:api:: python

            GetRows(categoryName: str, beginRow: int, endRow: int,
                    raw: bool = False) -> OEStringVectorVector
            GetRows(categoryName: str, raw: bool = False) -> OEStringVectorVector

      Returns rows from the indicated category. Rows values are base-0.
      Raw values are formatted as they will appear in the header. This is most noticeable with values that contain
      space characters as CIF formatting requires single or double quotes around such a string value.

   .. oe:method:: GetRowIndices

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<unsigned int> GetRowIndices(const std::string& categoryName,
                                                    const std::string& attribute,
                                                    const std::string& matchValue) const

      .. oe:language:: python

         .. oe:api:: python

            GetRowIndices(categoryName: str, attribute: str, matchValue: str) -> OEUIntVector

      Returns the base-0 row indices whose values string-match with input match value.

   .. oe:method:: HasAttribute

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasAttribute(const std::string& categoryName,
                              const std::string& attribute) const

      .. oe:language:: python

         .. oe:api:: python

            HasAttribute(categoryName: str, attribute: str) -> bool

      Returns if an attribute is present in this object.

   .. oe:method:: HasCategoryName

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCategoryName(const std::string& categoryName) const

      .. oe:language:: python

         .. oe:api:: python

            HasCategoryName(categoryName: str) -> bool

      Returns if a category name is present in this object.

   .. oe:method:: SetCategory

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCategory(const OECIFCategory& category)
            bool SetCategory(const std::string& categoryName,
                             const std::string& attribute,
                             const std::string& val)
            bool SetCategory(const std::string& categoryName,
                             const std::vector<std::string>& attributes,
                             const std::vector<std::string>& vals)

      .. oe:language:: python

         .. oe:api:: python

            SetCategory(category: OECIFCategory) -> bool
            SetCategory(categoryName: str, attributes: OEStringVector,
                        vals: OEStringVector) -> bool

      Sets OECIFCategory information in this object.

   .. oe:method:: SetData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetData(const std::string& categoryName,
                         const std::string& attribute, const std::string& nval)
            bool SetData(const std::string& categoryName,
                         const std::string& attribute, unsigned int row,
                         const std::string& nval, const std::string init = "?")
            bool SetData(const std::string& categoryName,
                         const std::string& attribute,
                         const std::vector<std::string>& nvals)
            bool SetData(const std::string& categoryName, unsigned int row,
                         const std::vector<std::string>& nvals,
                         const std::string init = "?")

      .. oe:language:: python

         .. oe:api:: python

            SetData(categoryName: str, attribute: str,
                    newValues: OEStringVector) -> bool
            SetData(categoryName: str, attribute: str, row: int, newValue: str,
                    init: str = "?") -> bool
            SetData(categoryName: str, row: int, newValues: OEStringVector,
                    init: str = "?") -> bool

      Sets attribute and row data on the indicated category.

   .. oe:method:: SetMMCIFChemCompData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMMCIFChemCompData(const OEMolBase& mol,
                                      const OEMolBase& chemCompMol,
                                      const bool strict = false)

      .. oe:language:: python

         .. oe:api:: python

            SetMMCIFChemCompData(mol: Union[OEGraphMol,OEMol,OEQMol],
                                 chemCompMol: Union[OEGraphMol,OEMol,OEQMol],
                                 strict: bool = False) -> bool

      Updates _chem_comp sections in the mmCIF header metadata with information from the input chemCompMol molecule.
      First, a single-residue chemCompMol is checked to name match with a residue in the molecule.
      The chemCompMol atom and bond data is then used to replace the _chem_comp header data for a similarly named residue
      in the mol. If strict is used, an additional check for atom name matching is made between the matched residue in
      the molecule and the chemCompMol.

      The following categories need to be present and properly populated in the input molecules header for this
      function. If any attributes are missing, running OEUpdateMMCIFData with ChemComp perception should populate any
      missing attributes:

        * _chem_comp.
        * _chem_comp_atom.
        * _chem_comp_bond.

      If the molecule already exists, it will replace all chemical component reference of that molecule with the
      new molecule.
      By default, residue atom name matching is enforced. If strict is turned off, an :ref:`OESubSearch <OEChem_OESubSearch>`
      is used to identify structural similarity with the new molecule. If a match is found, the matching structure
      atom names will be used in the _chem_comp atom naming scheme.

   .. oe:method:: Update

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Update(OEMolBase& mol, const OECIFOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            Update(mol: Union[OEGraphMol,OEMol,OEQMol], opts: OECIFOptions) -> bool

      Coordinates the molecule's structural and residue data with related information found in the header. Where
      there are disagreements, the molecule's data overrides the header data.
      Because updating can affect many parts of the header,
      to control what parts are and are not updated, the :ref:`OECIFOptions <OEChem_OECIFOptions>` class indicates which
      parts of the header will be perceived during the update.

      This function can be used to convert PDB header data into CIF header data. Create an OECIFData object using the
      PDB molecule and run Update(). Only perceivable fields in the molecule's structure data will be populated.

   .. oe:method:: ValidateMMCIFHeader

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ValidateMMCIFHeader(bool allowErrors = false,
                                     bool strict = false)

      .. oe:language:: python

         .. oe:api:: python

            ValidateMMCIFHeader(allowErrors: bool = False, strict: bool = False) -> bool

      Validates self-consistency within a mmCIF header. Many items will reference each other and this function runs
      checks to see if some of these are consistent with each other. Item entries that are checked include:

        * _entity.
        * _entity_poly.
        * _entity_poly_seq.
        * _chem_comp.
        * _struct_asym.

      The strict flag will explore more parts of the header and enforce a wider range of requirements:

        * Any 'entry_id' value reference must match an already defined '_entry.id'
        * Any 'entity_id' value reference must match an already defined '_entity.id'
        * An expression system has been identified (_entity_src_gen., _entity_src_nat., _entity_src_syn.)
        * _chem_comp_atom.
        * _chem_comp_bond.
        * _struct_ref.
        * _struct_ref_seq.

   .. oe:method:: ValidateMMCIFMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ValidateMMCIFMol(const OEMolBase& mol,
                                  bool allowErrors = false, bool strict = false)

      .. oe:language:: python

         .. oe:api:: python

            ValidateMMCIFMol(mol: Union[OEGraphMol,OEMol,OEQMol],
                             allowErrors: bool = False, strict: bool = False) -> bool

      Validates self-consistency between the header and mol reference. Item entries that are checked against the
      input molecule include:

        * _entity.
        * _chem_comp.
        * _struct_asym.

      The strict flag will explore more parts of the header and enforce a wider range of requirements against the
      input molecule:

        * strict _entity. header validation
        * _pdbx_poly_seq_scheme.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECIFOptions, CIFOptions

.. _OEChem_OECIFOptions:

.. oe:class:: OECIFOptions

   .. oe:api::

      class OECIFOptions

An option handling class for the :oe:func:`OEChem::OEUpdateMMCIFData` function
   and :oe:meth:`OEChem::OECIFData::Update` method in the :oe:cls:`OEChem::OECIFData` class.
   The :ref:`section_moldata_CIF` section explains in more detail the perception process and what CIF attributes
   are affected when an OECIFOption is set to ``true`` for a given perception method.

   .. seealso::

      * :oe:cls:`OEChem::OECIFData` class
      * :ref:`section_moldata_CIF` section

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECIFOptions()
            OECIFOptions(const OECIFOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OECIFOptions() -> OECIFOptions
            OECIFOptions(arg2: OECIFOptions) -> OECIFOptions

      Default and copy a constructor that constructs an OECIFOptions object.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECIFOptions & operator=(const OECIFOptions &)

      Assignment operator.

   .. oe:method:: GetPerceiveEntity

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveEntity() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveEntity() -> bool

      A value of ``true`` will perceive all entity-related CIF attributes.

   .. oe:method:: GetPerceiveChemComp

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveChemComp() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveChemComp() -> bool

      A value of ``true`` will perceive all chemical component-related CIF attributes.

   .. oe:method:: GetPerceiveCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveCell() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveCell() -> bool

      A value of ``true`` will perceive CIF attributes related to the structure cell.

   .. oe:method:: GetPerceiveSymmetry

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveSymmetry() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveSymmetry() -> bool

      A value of ``true`` will perceive CIF attributes related to structural symmetry.

   .. oe:method:: GetPerceiveStruct

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveStruct() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveStruct() -> bool

      A value of ``true`` will perceive all struct or structure-related CIF attributes.

   .. oe:method:: GetPerceiveExperimental

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveExperimental() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveExperimental() -> bool

      A value of ``true`` will coordinate the experimental CIF attributes with the perceived header values.

   .. oe:method:: GetPerceiveOther

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveOther() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveOther() -> bool

      All remaining CIF categories not covered in the other perception options are coordinated with the perceived header values.

   .. oe:method:: SetPerceiveEntity

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveEntity(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveEntity(value: bool) -> bool

      Sets whether to perceive entity-related CIF attributes during header updates when molecule data informs
      header values. Default is ``false``.

   .. oe:method:: SetPerceiveChemComp

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveChemComp(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveChemComp(value: bool) -> bool

      Sets whether to perceive chemical component-related CIF attributes during header updates when molecule data
      informs header values. Default is ``false``.

   .. oe:method:: SetPerceiveCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveCell(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveCell(value: bool) -> bool

      Sets whether to perceive CIF attributes related to the structure cell during header updates when molecule data
      informs header values. Default is ``false``.

   .. oe:method:: SetPerceiveSymmetry

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveSymmetry(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveSymmetry(value: bool) -> bool

      Sets whether to perceive CIF attributes related to the structural symmetry during header updates when
      molecule data informs header values. Default is ``false``.

   .. oe:method:: SetPerceiveStruct

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveEntity(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveStruct(value: bool) -> bool

      Sets whether to perceive struct or structure related CIF attributes during header updates when molecule data
      informs header values. Default is ``false``.

   .. oe:method:: SetPerceiveExperimental

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveExperimental(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveExperimental(value: bool) -> bool

      Sets whether to coordinate experimental CIF attributes with the perceived header values. Default is ``false``.

   .. oe:method:: SetPerceiveOther

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveOther(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveOther(value: bool) -> bool

      Sets whether to coordinate all remaining CIF categories not covered in the other perception options.
      Default is ``false``.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECSVHeader, CSVHeader

.. _OEChem_OECSVHeader:

.. oe:class:: OECSVHeader

   .. oe:api::

      class OECSVHeader

   This class stores the column names to be read or written to a
   :oe:const:`OEChem::OEFormat::CSV` file. It is typically retrieved
   from an :ref:`oemolstreambase <OEChem_oemolstreambase>` through the
   :oe:meth:`OEChem::oemolstreambase::GetCSVHeader` method. The object
   available from that method is initialized during the first read or
   write operation on that stream. 

   .. seealso::

      :oe:func:`OEChem::OECreateCSVHeader` for creating a
      :ref:`OECSVHeader <OEChem_OECSVHeader>` from the SD data tag in a molecule.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECSVHeader()
            OECSVHeader(const OECSVHeader& rhs)
            OECSVHeader(const std::vector<std::string>& columnNames)

      .. oe:language:: python

         .. oe:api:: python

            OECSVHeader() -> OECSVHeader
            OECSVHeader(rhs: OECSVHeader) -> OECSVHeader
            OECSVHeader(columnNames: OEStringVector) -> OECSVHeader

      The default constructors initializes the object to an empty
      state. The copy constructor can be used to make a copy from
      about :ref:`OECSVHeader <OEChem_OECSVHeader>` object. The class can also be
      constructed directly from a ``std::vector`` of ``std::string``. 

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECSVHeader &operator=(const OECSVHeader &rhs)

      Assignment operator to copy the contents of ``rhs`` into this class. 

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns ``false`` if this class has not been initialized with
      any column names yet. Returns ``true`` if this class does
      contain column names.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Resets the class to an empty uninitialized state. 

   .. oe:method:: GetColumnName

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetColumnName(unsigned int fieldIdx) const

      .. oe:language:: python

         .. oe:api:: python

            GetColumnName(fieldIdx: int) -> str

      Return the column name for the particular index, starting at
      zero. If ``fieldIdx`` is not less than
      :oe:meth:`OEChem::OECSVHeader::GetNumColumns`, a reference to an
      empty string is returned.

   .. oe:method:: GetColumnNames

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<const std::string>* GetColumnNames() const

      .. oe:language:: python

         .. oe:api:: python

            GetColumnNames() -> Iterable[str]

      Returns an iterator over all the column names stored in this class. 

   .. oe:method:: GetNumColumns

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumColumns() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumColumns() -> int

      Returns the number of column names stored in this class. 

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns ``false`` if this class has not been initialized with
      any column names yet. Returns ``true`` if this class does
      contain column names.


.. _OEChemClasses:

*******************************************************************************
OEChem Classes
*******************************************************************************

.. oe:namespace:: OEChem

.. toctree::

   OE2DRingDictionary
   OE2DRingDictionaryCreatorOptions
   OE3DMolStyle
   OEAbsCanonicalConfTest
   OEAbsoluteConfTest
   OEAnisoUij
   OEAtomBase
   OEAtomBondSet
   OEAtomIsInAgent
   OEAtomIsInChain
   OEAtomIsInProduct
   OEAtomIsInReactant
   OEAtomIsInResidue
   OEAtomIsInRing
   OEBondBase
   OEBondIsInChain
   OEBondIsInRing
   OECIFCategory
   OECIFData
   OECIFOptions
   OECliqueSearch
   OEConfBase
   OEConfRMSD
   OEConfRMSDOptions
   OEConfTestBase
   OEConstCoords
   OECoordArray
   OECreateSubSearchDatabaseOptions
   OECSVHeader
   OEDefaultConfTest
   OEEuler
   OEExprBase
   OEExtractRingTemplateOptions
   OEFileStringParameter
   OEFuzzy
   OEGetNbrAtom
   OEGraphMol
   OEGroupBase
   OEHasAlphaBetaUnsat
   OEHasAnisou
   OEHasAtomicNum
   OEHasAtomInGroup
   OEHasAtomName
   OEHasAtomStereoSpecified
   OEHasBondInGroup
   OEHasBondStereoSpecified
   OEHasChainID
   OEHasFormalCharge
   OEHasFragmentNumber
   OEHasGroupType
   OEHasHvyDegree
   OEHasIdx
   OEHasMapIdx
   OEHasOrder
   OEHasResidueNumber
   OEHydrogenCounter
   OEIdxSelected
   OEInChIOptions
   OEInSamePart
   OEIsAmideBond
   OEIsAromaticAtom
   OEIsAromaticBond
   OEIsAtomHybridization
   OEIsBridgeHead
   OEIsCAlpha
   OEIsCarbon
   OEIsChiralAtom
   OEIsChiralBond
   OEIsDisulfideBridgeBond
   OEIsHalide
   OEIsHalogen
   OEIsHeavy
   OEIsHetero
   OEIsHydrogen
   OEIsIntraResidueBond
   OEIsInvertibleNitrogen
   OEIsMDLStereoGroup
   OEIsMember
   OEIsMemberPtr
   OEIsMetal
   OEIsNitrogen
   OEIsNonRingAtomDoubleBondedToRing
   OEIsomericConfTest
   OEIsOxygen
   OEIsPhosphorus
   OEIsPolar
   OEIsPolarHydrogen
   OEIsProductGroup
   OEIsReactantGroup
   OEIsRGroup
   OEIsRotor
   OEIsRxnComponentGroup
   OEIsSulfur
   OEIsTermHeavyAtom
   OEIsValidAtomValence
   OEIsValidMDLAtomValence
   OELibraryGen
   OELingoSim
   OEMatch
   OEMatchBase
   OEMatchFunc
   OEMatchPair
   OEMCMolBase
   OEMCSFunc
   OEMCSFuncParameter
   OEMCSMaxAtoms
   OEMCSMaxAtomsCompleteCycles
   OEMCSMaxBonds
   OEMCSMaxBondsCompleteCycles
   OEMCSSearch
   OEMMFFTypeResult
   OEMol
   OEMolBase
   OEMolDatabase
   OEMolDatabaseSaveOptions
   OEMolDBException
   OEMolGDPropertyFxn
   oemolistream
   oemolithread
   oemolostream
   oemolothread
   OEMolParameter
   OEMolReaderParameter
   OEMolWriterParameter
   OEMolPropertyFxn
   OEMolPropertyList
   OEMolRecord
   OEMolSDPropertyFxn
   oemolstreambase
   OEMolStyleColorer
   OEMolTaggedPropertyFxn
   oemolthreadbase
   OEMutableCoords
   OENbrs
   OENearestNbrs
   OENthAtom
   OEOmegaConfTest
   OEOutFileStringParameter
   OEParseSmilesOptions
   OEPartPredT
   OEPredicateParameter
   OEQAtomBase
   OEQBase
   OEQBondBase
   OEQMol
   OEQMolBase
   OEQuaternion
   OERefInputAppOptions
   OEResidue
   OERotMatrix
   OESDDataPair
   OESimilarByRMSD
   OESimpleAppOptions
   OESubSearch
   OESubSearchDatabase
   OESubSearchQuery
   OESubSearchResult
   OESubSearchScreen
   OESubSearchScreenTypeBase
   OETokenizerBase
   OETorsion
   OETrans
   OETransBase
   OETranslation
   OEUnaryToBinaryAnd
   OEUnaryToBinaryOr
   OEUnAtomPredParameter
   OEUnBondPredParameter
   OEUniMolecularRxn
   OEUniMolecularRxnOptions
   OEVectorBindings


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECliqueSearch, CliqueSearch

.. _OEChem_OECliqueSearch:

.. oe:class:: OECliqueSearch

   .. oe:api::

      class OECliqueSearch

   This class represents `OECliqueSearch`.

   The :ref:`OECliqueSearch <OEChem_OECliqueSearch>` class performs bounded common
   substructure searches.
   It is a useful search method in cases where common substructures other than
   the maximum common substructure (:ref:`OEMCSSearch <OEChem_OEMCSSearch>`)
   need to be identified.

   .. seealso::

      .. oe:language:: c++

         * :ref:`section_patternmatch_clique` section
         * Example program :ref:`cliquealign.cpp<section_example_oechem_cliquealign>`

      .. oe:language:: python

         * :ref:`section_patternmatch_clique` section
         * Example program :ref:`cliquealign.py<section_example_oechem_cliquealign>`

      .. oe:language:: java

         * :ref:`section_patternmatch_clique` section
         * Example program :ref:`CliqueAlign.java<section_example_oechem_cliquealign>`

      .. oe:language:: csharp

         * :ref:`section_patternmatch_clique` section
         * Example program :ref:`CliqueAlign.cs<section_example_oechem_cliquealign>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECliqueSearch(unsigned int type = OEMCSType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OECliqueSearch(type: int) -> OECliqueSearch

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECliqueSearch(const OECliqueSearch &)

      .. oe:language:: python

         .. oe:api:: python

            OECliqueSearch(arg2: OECliqueSearch) -> OECliqueSearch

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECliqueSearch(const char* smarts,
                           unsigned int type = OEMCSType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OECliqueSearch(arg2: str, type: int) -> OECliqueSearch

      Constructs an :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object using a 'smarts' pattern.
      The :term:`SMARTS` pattern is parsed into a query molecule
      (:ref:`OEQMolBase <OEChem_OEQMolBase>`).
      The valid types of the :ref:`OECliqueSearch <OEChem_OECliqueSearch>` are defined
      in the :oe:constns:`OEChem::OEMCSType` namespace.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECliqueSearch(const OEQMolBase &, bool perception = true,
                           unsigned int type = OEMCSType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OECliqueSearch(arg2: OEQMol, makeCopy: bool = True, type: int) -> OECliqueSearch

      Constructs an :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object using a query molecule
      (:ref:`OEQMolBase <OEChem_OEQMolBase>`).

      *qmol*
        The query molecule of the MCS search.

      *type*
        The type of the :ref:`OECliqueSearch <OEChem_OECliqueSearch>` from the
        :oe:constns:`OEChem::OEMCSType` namespace.

      *perception*
         If ``true``, then ring perception is performed on the query molecule.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECliqueSearch(const OEMolBase &, unsigned int atomexpr,
                           unsigned int bondexpr,
                           unsigned int type = OEMCSType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OECliqueSearch(arg2: Union[OEGraphMol,OEMol,OEQMol], arg3: int,
                           arg4: int, type: int) -> OECliqueSearch

      Constructs an :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object using a molecule and expression options.
      The atom and bond expression options passed as the second and
      third arguments to the method are defined in the
      :oe:constns:`OEChem::OEExprOpts` namespace.
      The expression options are used to convert the atom and bond
      data into expression trees which are used during the common
      subgraph search.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECliqueSearch &operator=(const OECliqueSearch &rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object
      into the right-hand side :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object.

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Test for successful initialization of an
      :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object.
      If initialization was attempted with an invalid :term:`SMARTS`
      pattern or query molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`) then
      this method will return ``false``.
      If initialization was completed successfully this method will
      return ``true``.
      An :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object is considered to be
      uninitialized when constructed with the default constructor.

   .. oe:method:: AddConstraint

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddConstraint(const OEMatchPair<OEAtomBase> &)
            bool AddConstraint(const OEMatchPair<OEBondBase> &)

      .. oe:language:: python

         .. oe:api:: python

            AddConstraint(arg2: OEMatchPairAtom) -> bool
            AddConstraint(arg2: OEMatchPairBond) -> bool

      The search space of a common subgraph determination can
      be restricted by constraining pairs of nodes or edges (atoms or
      bonds) to be mapped onto one another in all subgraph solutions.
      Failure to satisfy atom or bond pairwise constraints will prevent
      any subgraph solutions from being identified.
      Constraints are considered satisfied in subgraphs which do not
      contain any constrained atoms or bonds in either the pattern or
      target molecules.

      Both :oe:meth:`OEChem::OECliqueSearch::AddConstraint` methods return
      ``true`` if a constraint is added successfully.
      If the pattern atom or bond in the :ref:`OEMatchPair <OEChem_OEMatchPair>`
      does not exist as part of the query molecule created in the
      initialization of the :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object then
      :oe:meth:`OEChem::OECliqueSearch::AddConstraint` will return
      ``false``.
      Multiple calls to :oe:meth:`OEChem::OECliqueSearch::AddConstraint`
      using the same pattern atom or bond will cause previously stored
      constraints to be overwritten as constraints are mutually
      exclusive.
      It is impossible to satisfy multiple simultaneous constraints
      for a single pattern atom or bond, hence the exclusivity.

   .. oe:method:: ClearConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearConstraints()

      .. oe:language:: python

         .. oe:api:: python

            ClearConstraints() -> None

      Clears all prior match constraints set with the
      :oe:meth:`OEChem::OECliqueSearch::AddConstraint` methods.

   .. oe:method:: GetMaxMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxMatches() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMatches() -> int

      Returns the maximum number of subgraphs
      that the :ref:`OECliqueSearch <OEChem_OECliqueSearch>` will identify
      before terminating the search.
      A value of zero indicates that no arbitrary limit has been set
      on the total number of subgraphs to be identified.
      By default, the maximum number of matches is set to ``1024``
      This value can be set using the
      :oe:meth:`OEChem::OECliqueSearch::SetMaxMatches` method.

   .. oe:method:: GetMinAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMinAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinAtoms() -> int

      Returns the minimum number of atoms of a subgraph that
      can be returned as a common subgraph.
      This value can be set using the
      :oe:meth:`OEChem::OECliqueSearch::SetMinAtoms` method.

   .. oe:method:: GetPattern

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEQMolBase& GetPattern() const

      .. oe:language:: python

         .. oe:api:: python

            GetPattern() -> OEQMol

      Returns a read-only reference to the query molecule
      (:ref:`OEQMolBase <OEChem_OEQMolBase>`) of :ref:`OECliqueSearch <OEChem_OECliqueSearch>`.
      Const :ref:`OEQMolBase <OEChem_OEQMolBase>` methods can be used on the
      returned :ref:`OEQMolBase <OEChem_OEQMolBase>` reference.
      If the :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object has not been
      initialized, a reference to an empty molecule will be returned.

   .. oe:method:: GetSaveRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSaveRange() const

      .. oe:language:: python

         .. oe:api:: python

            GetSaveRange() -> int

      This value can be set using the :oe:meth:`OEChem::OECliqueSearch::SetSaveRange` method.
      Any subgraphs found by the MCS function used by the search are discarded that have a smaller scoring value than
      the maximum score minus this ‘range’. See :ref:`OEMCSSearch <OEChem_OEMCSSearch>` for more details.

   .. oe:method:: Init

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const char* smarts)

      .. oe:language:: python

         .. oe:api:: python

            Init(arg2: str) -> bool

      (Re)initializes an :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object using a
      'smarts' pattern.
      The :term:`SMARTS` pattern is parsed to create a query molecule
      available for subgraph matching.
      The method will return ``true`` if initialization completes
      successfully, and ``false`` upon failure.

      .. note::

         Prior state information is cleared before initialization, and
         is lost even if the method fails to initialize properly.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const OEQMolBase& qmol, bool perception = true)

      .. oe:language:: python

         .. oe:api:: python

            Init(arg2: OEQMol, makeCopy: bool = True) -> bool

      (Re)initializes an :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object using a
      query molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`) reference.
      The method will return ``true`` if initialization completes
      successfully, and ``false`` upon failure.

      *qmol*
        The query molecule of the MCS search.

      *perception*
         If ``true``, then ring perception is performed on the query molecule.

      .. note::

         Prior state information is cleared before initialization, and
         is lost even if the method fails to initialize properly.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const OEMolBase& mol, unsigned int atomexpr,
                      unsigned int bondexpr)

      .. oe:language:: python

         .. oe:api:: python

            Init(arg2: Union[OEGraphMol,OEMol,OEQMol], arg3: int, arg4: int) -> bool

      (Re)initializes an :ref:`OECliqueSearch <OEChem_OECliqueSearch>`
      object using a molecule (:ref:`OEMolBase <OEChem_OEMolBase>`) and
      expression options used to convert the molecule into a query
      molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`).
      The atom and bond expression options passed as the second and
      third arguments to the method are defined in the
      :oe:constns:`OEChem::OEExprOpts` namespace.
      Expression options are used to convert the atom and bond data
      into expression trees which are used during the common subgraph
      search.
      The method will return ``true`` if initialization completes
      successfully, and ``false`` upon failure.

      .. note::

         Prior state information is cleared before initialization, and
         is lost even if the method fails to initialize properly.

   .. oe:method:: Match

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMatchBase>* Match(const OEMolBase &)

      .. oe:language:: python

         .. oe:api:: python

            Match(arg2: Union[OEGraphMol,OEMol]) -> Iterable[OEMatchBase]

      Performs search in order to identify common subgraphs (cliques)
      shared between the passed :ref:`OEMolBase <OEChem_OEMolBase>` and the
      query molecule which the :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object was
      initialized.
      It returns an iterator pointer (:ref:`OEIterBase <OESystem_OEIterBase>`)
      over graph matches (:ref:`OEMatchBase <OEChem_OEMatchBase>`), and should be
      assigned to an :ref:`OEIter <OESystem_OEIter>` < :ref:`OEMatchBase <OEChem_OEMatchBase>` >
      in order to prevent memory leaks.

      If the 'uniquematch'  argument passed to the methods is ``true`` then
      only the unique matches will be returned  in the iterator over the matches.
      By definition, a match or subgraph is considered unique if it differs
      from all other subgraphs found previously by at least one atom or
      bond.
      Additionally, it is also considered unique if the query subgraph
      is mapped to a different part of the target
      (See example in the :ref:`section_patternmatch_mcss` section)

      .. oe:api:  IGNORED - NOT IMPLEMENTED YET

         OESystem::OEIterBase<OEMatchBase> *Match(const OEQMolBase &)

   .. oe:method:: SetMCSFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMCSFunc(const OEMCSFunc &)

      .. oe:language:: python

         .. oe:api:: python

            SetMCSFunc(arg2: OEMCSFunc) -> bool

      Stores a copy of the passed :ref:`OEMCSFunc <OEChem_OEMCSFunc>` functor
      in the :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object.
      The functor is then used to evaluate and order subgraphs found
      during a common subgraph search.

      .. seealso::

         * :ref:`OEMCSFunc <OEChem_OEMCSFunc>`
         * :ref:`OEMCSMaxAtoms <OEChem_OEMCSMaxAtoms>`
         * :ref:`OEMCSMaxBonds <OEChem_OEMCSMaxBonds>`
         * :ref:`OEMCSMaxAtomsCompleteCycles <OEChem_OEMCSMaxAtomsCompleteCycles>`
         * :ref:`OEMCSMaxBondsCompleteCycles <OEChem_OEMCSMaxBondsCompleteCycles>`

   .. oe:method:: SetMaxMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxMatches(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxMatches(arg2: int) -> bool

      Sets the maximum number of common subgraph (clique) matches that
      will be returned by the :oe:meth:`OEChem::OECliqueSearch::Match`
      method.
      The default limit set upon construction of an
      :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object is ``1024`` matches.
      This value can be retrieved
      using the :oe:meth:`OEChem::OECliqueSearch::GetMaxMatches` method.

   .. oe:method:: SetMinAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMinAtoms(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMinAtoms(arg2: int) -> bool

      Sets the minimum number of atoms required of a subgraph match to
      be returned a solution by a clique search.
      A single atom can be a perfectly valid common subgraph,
      however, for many applications such a small subgraph may not be
      considered useful.
      Setting the minimum number of atoms to an appropriate size
      prevents unproductive subgraph matches from being returned by
      the :oe:meth:`OEChem::OECliqueSearch::Match` method.
      The default value for the minimum number of atoms in a subgraph
      match is set to ``1`` upon construction of an
      :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object.
      This value can be retrieved using the
      :oe:meth:`OEChem::OECliqueSearch::GetMinAtoms` method.

   .. oe:method:: SetSaveRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSaveRange(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetSaveRange(arg2: int) -> bool

      Sets the range of the clique search.
      This value can be retrieved using the
      :oe:meth:`OEChem::OECliqueSearch::GetSaveRange` method.

   .. oe:method: SingleMatch  IGNORED - NOT IMPLEMENTED YET

      .. oe:api::

         bool SingleMatch(const OEMolBase &)

      .. oe:api::

         bool SingleMatch(const OEQMolBase &)



*******************************************************************************
Preliminary OEChem Classes
*******************************************************************************

.. oe:namespace:: OEChem

.. toctree::

   OEHasAminoAcidType 
   OEHasMonomerGroup
   OEHasMonomerType
   OEHasPolymerType
   OEHelmGenerationOptions
   OEHelmGenerationResult
   OEHelmParsingResult
   OEIsInMonomerCodeSet
   OEIsMonomerGroup
   OEMonomer
   OEMonomerData
   OEMonomerSet
   OEMonomerValidationResult
   OERxnAutomapper
   OERxnAutomapperOptions


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:class:: OEHasAminoAcidType

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHasAminoAcidType
      
   This functor can be used to identify monomers with the given amino acid type
   (:oe:constns:`OEChem::OEAminoAcidType`).

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasAminoAcidType(unsigned aminoAcidType)

      .. oe:language:: python

         .. oe:api:: python

            OEHasAminoAcidType(aminoAcidType: int) -> OEHasAminoAcidType

      Initializes the functor with the given polymer type from the 
      :oe:constns:`OEChem::OEAminoAcidType` namespace.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasAminoAcidType(const OEHasAminoAcidType &)

      .. oe:language:: python

         .. oe:api:: python

            OEHasAminoAcidType(arg2: OEHasAminoAcidType) -> OEHasAminoAcidType

      Copy Constructors.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEMonomer &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: OEMonomer) -> bool

      Returns true, if the given monomer has the same amino acid type
      the :oe:cls:`OEChem::OEHasAminoAcidType` functor is initialized with.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHasAminoAcidType &operator=(const OEHasAminoAcidType &)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEMonomer, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryMonomerBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :oe:cls:`OEChem::OEHasAminoAcidType`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasMonomerGroup, IsMDLStereoGroup

.. _OEChem_OEHasMonomerGroup:

.. oe:class:: OEHasMonomerGroup

   .. oe:api::

      class  OEHasMonomerGroup : public OESystem::OEUnaryPredicate<OEGroupBase>

   This class represents :ref:`OEHasMonomerGroup <OEChem_OEHasMonomerGroup>` functor that
   identifies groups (:ref:`OEGroupBase <OEChem_OEGroupBase>`) that are representing
   a monomer specified by a code.

   .. seealso::

      * :oe:cls:`OEChem::OEIsMonomerGroup` for a functor that identifies groups that store monomer information.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasMonomerGroup::OEHasMonomerGroup(const std::string codeSet,
                                                 const std::string code)

      .. oe:language:: python

         .. oe:api:: python

            __init__(code_set: str, code: str) -> OEHasMonomerGroup

      Constructor that takes a code set and a code to identify the monomer group.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()
      :language: c++

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEGroupBase& group) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(group: OEGroupBase) -> bool

      Returns ``true``, if the group identifies a monomer with the code set and code
      specified in the constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEGroupBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryGroupBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasMonomerGroup <OEChem_OEHasMonomerGroup>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEConfBase, ConfBase

.. _OEChem_OEConfBase:

.. oe:class:: OEConfBase

   .. oe:api::

      class OEConfBase : public OEMolBase

   :ref:`OEConfBase <OEChem_OEConfBase>` is the generic conformer base class.
   It is an abstract base class which defines the interface for
   conformer implementations. Coordinates can be stored in
   :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` (16-bit), ``float`` (32-bit),
   ``double`` (64-bit), or ``long double`` (>= 64-bit). The precision
   is determined by the constructor argument given to
   :ref:`OEMol <OEChem_OEMol>`, taken from the
   :oe:constns:`OEChem::OEMCMolType` namespace. The default is 32-bit
   ``float``.

   The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>`:

   =========================================================== =========================================================== ============================================================
   :oe:meth:`operator=<OEChem::OEMolBase::operator=>`          :oe:meth:`GetDimension<OEChem::OEMolBase::GetDimension>`    :oe:meth:`NumBonds<OEChem::OEMolBase::NumBonds>`            
   :oe:meth:`operator bool<OEChem::OEMolBase::operator bool>`  :oe:meth:`GetEnergy<OEChem::OEMolBase::GetEnergy>`          :oe:meth:`NumGroups<OEChem::OEMolBase::NumGroups>`          
   :oe:meth:`Clear<OEChem::OEMolBase::Clear>`                  :oe:meth:`GetGroup<OEChem::OEMolBase::GetGroup>`            :oe:meth:`OrderAtoms<OEChem::OEMolBase::OrderAtoms>`        
   :oe:meth:`ClearCoords<OEChem::OEMolBase::ClearCoords>`      :oe:meth:`GetGroups<OEChem::OEMolBase::GetGroups>`          :oe:meth:`OrderBonds<OEChem::OEMolBase::OrderBonds>`        
   :oe:meth:`Compress<OEChem::OEMolBase::Compress>`            :oe:meth:`GetMaxAtomIdx<OEChem::OEMolBase::GetMaxAtomIdx>`  :oe:meth:`ResetPerceived<OEChem::OEMolBase::ResetPerceived>`
   :oe:meth:`Count<OEChem::OEMolBase::Count>`                  :oe:meth:`GetMaxBondIdx<OEChem::OEMolBase::GetMaxBondIdx>`  :oe:meth:`SetCoords<OEChem::OEMolBase::SetCoords>`          
   :oe:meth:`CreateCopy<OEChem::OEMolBase::CreateCopy>`        :oe:meth:`GetTitle<OEChem::OEMolBase::GetTitle>`            :oe:meth:`SetDimension<OEChem::OEMolBase::SetDimension>`    
   :oe:meth:`DeleteAtom<OEChem::OEMolBase::DeleteAtom>`        :oe:meth:`HasPerceived<OEChem::OEMolBase::HasPerceived>`    :oe:meth:`SetEnergy<OEChem::OEMolBase::SetEnergy>`          
   :oe:meth:`DeleteBond<OEChem::OEMolBase::DeleteBond>`        :oe:meth:`IsDataType<OEChem::OEMolBase::IsDataType>`        :oe:meth:`SetPerceived<OEChem::OEMolBase::SetPerceived>`    
   :oe:meth:`DeleteGroup<OEChem::OEMolBase::DeleteGroup>`      :oe:meth:`IsDeleted<OEChem::OEMolBase::IsDeleted>`          :oe:meth:`SetRxn<OEChem::OEMolBase::SetRxn>`                
   :oe:meth:`GetAtom<OEChem::OEMolBase::GetAtom>`              :oe:meth:`IsRxn<OEChem::OEMolBase::IsRxn>`                  :oe:meth:`SetTitle<OEChem::OEMolBase::SetTitle>`            
   :oe:meth:`GetAtoms<OEChem::OEMolBase::GetAtoms>`            :oe:meth:`NewAtom<OEChem::OEMolBase::NewAtom>`              :oe:meth:`Sweep<OEChem::OEMolBase::Sweep>`                  
   :oe:meth:`GetBond<OEChem::OEMolBase::GetBond>`              :oe:meth:`NewBond<OEChem::OEMolBase::NewBond>`              :oe:meth:`UnCompress<OEChem::OEMolBase::UnCompress>`        
   :oe:meth:`GetBonds<OEChem::OEMolBase::GetBonds>`            :oe:meth:`NewGroup<OEChem::OEMolBase::NewGroup>`            
   :oe:meth:`GetCoords<OEChem::OEMolBase::GetCoords>`          :oe:meth:`NumAtoms<OEChem::OEMolBase::NumAtoms>`            
   =========================================================== =========================================================== ============================================================

   .. oe:language:: java

      The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>` only in Java:

      ====================================================== ====================================================== =========================================================
      :oe:meth:`GetAtomList<OEChem::OEMolBase::GetAtomList>` :oe:meth:`GetBondList<OEChem::OEMolBase::GetBondList>` :oe:meth:`GetGroupList<OEChem::OEMolBase::GetGroupList>` 
      ====================================================== ====================================================== =========================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEConfBase& operator=(const OEMolBase& rhs)
         OEConfBase& operator=(const OEConfBase& rhs)

      Conformer assignment either from another conformer or
      :ref:`OEMolBase <OEChem_OEMolBase>`.

      Assignment operator.

   .. oe:method:: AddAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddAtom(OEAtomBase* atom)=0
            void AddAtom(const OEAtomBase* rhs, OEAtomBase* atom)=0

      .. oe:language:: python

         .. oe:api:: python

            AddAtom(atom: OEAtomBase) -> None
            AddAtom(rhs: OEAtomBase, atom: OEAtomBase) -> None

      :oe:meth:`OEChem::OEConfBase::AddAtom` is a helper method
      that the :ref:`OEMCMolBase <OEChem_OEMCMolBase>` can call as an
      adjunct to :oe:meth:`OEChem::OEMolBase::NewAtom` on the
      molecule which contains the conformers.

      .. warning::

         This should not be called by a primary user.

   .. oe:method:: AddBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddBond(OEBondBase* bond)=0

      .. oe:language:: python

         .. oe:api:: python

            AddBond(bond: OEBondBase) -> None

      :oe:meth:`OEChem::OEConfBase::AddBond` is a helper method
      that the :ref:`OEMCMolBase <OEChem_OEMCMolBase>` can call as an
      adjunct to :oe:meth:`OEChem::OEMolBase::NewBond` on the
      molecule which contains the conformers.

      .. warning::

         This should not be called by a primary user.

   .. oe:method:: Delete

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Delete()=0

      .. oe:language:: python

         .. oe:api:: python

            Delete() -> None

      The :oe:meth:`OEChem::OEConfBase::Delete` method is equivalent to call
      :oe:meth:`OEChem::OEMCMolBase::DeleteConf` from the parent molecule.
      It removes the current conformer from the  :ref:`OEMCMolBase <OEChem_OEMCMolBase>`
      object containing it.
      These functions do not invalidate current :ref:`OEIter <OESystem_OEIter>` objects,
      and all calls to :oe:meth:`OEChem::OEMCMolBase::GetConfs` called after
      the call to :oe:meth:`OEChem::OEConfBase::Delete` will not contain the
      deleted conformer.

   .. oe:method:: GetCoordsPtr
      :language: c++

      .. oe:api::

         unsigned int GetCoordsPtr(const void *&ptr) const = 0
         unsigned int GetCoordsPtr(void *&ptr) = 0

      Use with care, this provides direct access to the coordinates
      pointer of this conformer. Returns a constant from the
      :oe:constns:`OEChem::OECoordsType` namespace specifying the type
      of data ``ptr`` will point
      to. :oe:const:`OEChem::OECoordsType::Undefined` is returned if
      the underlying implementation does not allow direct memory
      access. If access is allowed, a pointer to the memory storing
      the coordinates is returned as ``ptr``. That pointer is
      considered owned by this class, and may be invalidated by other
      non-const methods on the :ref:`OEConfBase <OEChem_OEConfBase>` or
      :ref:`OEMCMolBase <OEChem_OEMCMolBase>`.

      .. warning::

         Users should avoid using this method directly. Use
         :ref:`OEConstCoords <OEChem_OEConstCoords>` or
         :ref:`OEMutableCoords <OEChem_OEMutableCoords>` instead.

   .. oe:method:: ClearCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearCoords() = 0

      .. oe:language:: python

         .. oe:api:: python

            ClearCoords() -> None

      Clears the coordinates, clears perception flags and sets the coordinate
      dimension to ``0``

      .. seealso::

         * :oe:meth:`OEChem::OEConfBase::GetCoords`
         * :oe:meth:`OEChem::OEConfBase::SetCoords`

   .. oe:method:: GetCoords

      .. oe:language:: python

         .. oe:api:: python

            GetCoords() -> {idx : (x_0, y_0, z_0), ... }

         Returns a Python dictionary of the coordinates of this
         molecule. The dictionary is keyed off the index of the
         :ref:`OEAtomBase <OEChem_OEAtomBase>` as returned by
         :oe:meth:`OEChem::OEAtomBase::GetIdx`. The values will always
         be a 3-element tuple of floating point values. Note, the
         dictionary will not contain entries for deleted atoms, making
         it significantly easier to use than the following
         ``OEFloatArray`` overloads. This also means the keys of the
         dictionary are not always guaranteed to be contiguous
         integers.

         .. note::

            The overload that returns a dictionary is for convenience
            over performance as it is significantly more
            pythonic. However, if the floating point values are not
            needed in Python and just being passed to another OpenEye
            toolkit function, using the following overloads with
            ``OEFloatArray`` objects will be significantly faster.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCoords(OEPlatform::OEHalfFloat *) const = 0
            bool GetCoords(float *) const = 0
            bool GetCoords(double *) const = 0
            bool GetCoords(long double *) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetCoords(arg2: OEHalfFloat) -> bool
            GetCoords(arg2: OEFloatArray) -> bool
            GetCoords(arg2: OEDoubleArray) -> bool
            GetCoords(OEDoubleArray: int) -> bool
            GetCoords(atom: OEAtomBase) -> (x: float, y: float, z: float)

      Fills the array passed into the function with a copy of the coordinates of
      the conformer.
      The array passed in should be at least of length
      :oe:meth:`OEChem::OEConfBase::GetMaxAtomIdx<OEChem::OEMolBase::GetMaxAtomIdx>` * ``3``.
      The coordinates of each atom in the conformer will begin at
      ``coords[atom->GetIdx()*3]`` in the array.
      Changes made to the array after this function call will have no effect on
      the conformer.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCoords(const OEAtomBase *, OEPlatform::OEHalfFloat* coords) const = 0
            bool GetCoords(const OEAtomBase *, float* coords) const = 0
            bool GetCoords(const OEAtomBase *, double* coords) const = 0
            bool GetCoords(const OEAtomBase *, long double* coords) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetCoords(arg2: OEAtomBase, arg3: OEHalfFloat) -> bool
            GetCoords(arg2: OEAtomBase, arg3: OEFloatArray) -> bool
            GetCoords(arg2: OEAtomBase, arg3: OEDoubleArray) -> bool
            GetCoords(arg2: OEAtomBase, OEDoubleArray: int) -> bool

      Fills the ``coords`` array with the coordinates of the
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.
      The ``coords`` array should be at least of length ``3``.
      Changes made to the ``coord`` array after this function call will
      have no effect on the conformer.

      .. seealso::

         * :oe:meth:`OEChem::OEConfBase::SetCoords`
         * :oe:meth:`OEChem::OEConfBase::ClearCoords`

   .. oe:method:: GetIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetIdx() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetIdx() -> int

      Returns the index of the conformer.
      This value is assigned by OEChem when a conformer is created.
      The conformer index is unique for the conformation of a given molecule,
      and is stable (not reused) for the lifetime of that :ref:`OEMCMolBase <OEChem_OEMCMolBase>`.
      These values may not be assigned sequentially, and may contain gaps.
      Conformer indices are guaranteed to be less than
      :oe:meth:`OEChem::OEMCMolBase::GetMaxConfIdx`.
      Conformer indices are typically only used for efficiently storing
      data in arrays externally to the :ref:`OEMCMolBase <OEChem_OEMCMolBase>`.
      The arrays can be conveniently indexed via :oe:meth:`OEChem::OEConfBase::GetIdx`.
      For iterating across the conformers of a molecule, use :oe:meth:`OEChem::OEMCMolBase::GetConfs`
      and for keeping track of a particular conformer use the conformer pointer :oe:cls:`OEChem::OEConfBase*<OEChem::OEConfBase>`.

   .. oe:method:: GetMCMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCMolBase& GetMCMol() = 0
            const OEMCMolBase& GetMCMol() const = 0
      .. oe:language:: python

         .. oe:api:: python

            GetMCMol() -> OEMol

      Returns the associated multi-conformer molecule that is serving as
      the container for the :ref:`OEConfBase <OEChem_OEConfBase>`.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetTitle() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      :ref:`OEConfBase <OEChem_OEConfBase>` objects can have their own title.
      However, if they do not, they will report the title of their parent
      :ref:`OEMCMolBase <OEChem_OEMCMolBase>` when the :oe:meth:`OEChem::OEConfBase::GetTitle`
      method is called.

      .. seealso::

         * :oe:meth:`OEChem::OEConfBase::HasTitle`

   .. oe:method:: GetTorsion

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTorsion(OETorsion &) const = 0
            double GetTorsion(const OEAtomBase* a, const OEAtomBase* b,
                              const OEAtomBase* c, const OEAtomBase* d) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetTorsion(arg2: OETorsion) -> float
            GetTorsion(a: OEAtomBase, b: OEAtomBase, c: OEAtomBase,
                       d: OEAtomBase) -> float

      Returns the torsion value in the conformer.
      The torsion can be defined by either an :ref:`OETorsion <OEChem_OETorsion>` object,
      or by four :ref:`OEAtomBase <OEChem_OEAtomBase>` objects.

      .. seealso::

         * :oe:meth:`OEChem::OEConfBase::SetTorsion`

   .. oe:method:: GetTransform

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OETrans& GetTransform() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetTransform() -> OETrans

      Returns an :ref:`OETrans <OEChem_OETrans>`, which is a container of all the
      transformations which have been applied to the :ref:`OEConfBase <OEChem_OEConfBase>`.
      This function is particularly useful when the internal representation
      of coordinates may not be Cartesian.

   .. oe:method:: HasTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasTitle() const = 0

      .. oe:language:: python

         .. oe:api:: python

            HasTitle() -> bool

      Returns whether this conformer has a title set. 

      .. seealso::

         * :oe:meth:`OEChem::OEConfBase::GetTitle`

   .. oe:method:: IsDeleted

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDeleted() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsDeleted() -> bool

      :oe:meth:`OEChem::OEConfBase::IsDeleted` is a helper function which
      assists other classes in maintaining functionality after
      an :ref:`OEConfBase <OEChem_OEConfBase>` has been deleted.

      .. seealso::

         * :oe:meth:`OEChem::OEMolBase::IsDeleted` methods inherited
           from the :ref:`OEMolBase <OEChem_OEMolBase>` class. That method has
           the purpose of identifying deleted atoms and bonds. 

   .. oe:method:: RemoveAtom
      :language: c++ java csharp

      .. oe:api::

         bool RemoveAtom(OEAtomBase *atom)=0

      :oe:meth:`OEChem::OEConfBase::RemoveAtom` is a helper function which
      the :ref:`OEMCMolBase <OEChem_OEMCMolBase>` can call as an adjunct to
      :oe:meth:`OEChem::OEMolBase::DeleteAtom` on the molecule
      which contains the conformers.

      .. warning::

         This should not be called by a primary user.

   .. oe:method:: RemoveBond
      :language: c++ java csharp

      .. oe:api::

         bool RemoveBond(OEBondBase *bond)=0

      :oe:meth:`OEChem::OEConfBase::RemoveBond` is a helper function which
      the :ref:`OEMCMolBase <OEChem_OEMCMolBase>` can call as an adjunct to
      :oe:meth:`OEChem::OEMolBase::DeleteBond` on the molecule
      which contains the conformers.

      .. warning::

         This should not be called by a primary user.

   .. oe:method:: SetCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCoords(const OEPlatform::OEHalfFloat* coords)=0
            bool SetCoords(const float* coords)=0
            bool SetCoords(const double* coords)=0
            bool SetCoords(const long double* coords)=0

      .. oe:language:: python

         .. oe:api:: python

            SetCoords(arg2: OEHalfFloat) -> bool
            SetCoords(arg2: OEFloatArray) -> bool
            SetCoords(arg2: OEDoubleArray) -> bool
            SetCoords(OEDoubleArray: int) -> bool

      Sets the coordinates of a conformer.  The ``coords`` parameter
      is expected to be an array of size
      :oe:meth:`OEChem::OEConfBase::GetMaxAtomIdx<OEChem::OEMolBase::GetMaxAtomIdx>` *
      ``3``.  This array should contain ``3`` coordinates for each
      atom, and they should be located in the array passed in at
      ``coords[atom->GetIdx() * 3 + i]``, where i ranges from 0 to
      ``3``.  An internal copy of the coordinates is stored in the
      :ref:`OEConfBase <OEChem_OEConfBase>` that is independent of the
      ``coords`` array.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCoords(const OEAtomBase *,
                           const OEPlatform::OEHalfFloat* coords)=0
            bool SetCoords(const OEAtomBase *, const float* coords)=0
            bool SetCoords(const OEAtomBase *, const double* coords)=0
            bool SetCoords(const OEAtomBase *, const long double* coords)=0

      .. oe:language:: python

         .. oe:api:: python

            SetCoords(arg2: OEAtomBase, arg3: OEHalfFloat) -> bool
            SetCoords(arg2: OEAtomBase, arg3: OEFloatArray) -> bool
            SetCoords(arg2: OEAtomBase, arg3: OEDoubleArray) -> bool
            SetCoords(arg2: OEAtomBase, OEDoubleArray: int) -> bool

      Sets to coordinates of a single atom in the :ref:`OEConfBase <OEChem_OEConfBase>`.
      The array passed in should be of length ``3`` and should contain the
      new coordinates of the atom.
      An internal copy of the coordinates is stored in the :ref:`OEConfBase <OEChem_OEConfBase>`
      which is independent of the ``coords`` array.

      .. seealso::

         * :oe:meth:`OEChem::OEConfBase::GetCoords`
         * :oe:meth:`OEChem::OEConfBase::ClearCoords`

   .. oe:method: SetIdx  IGNORED-METHOD

      .. oe:api::

         void SetIdx(unsigned int)=0

      It is not recommended that a user call the OEConfBase::SetIdx() function.
      This value is assigned by OEChem when a conformer is created.
      The conformer index is unique for the conformers of a
      given molecule, and is stable (not reused) for the lifetime of that
      OEMCMolBase.
      These values may not be assigned sequentially, and may contain gaps.
      Conformer indices are guaranteed to be less than OEMCMolBase::GetMaxConfIdx.
      Conformer indices are typically only used for efficiently storing
      data in arrays (or vectors) externally to the OEMCMolBase.
      They arrays can be conveniently indexed via OEConfBase::GetIdx().
      For iterating across the conformers of a molecule, use OEMCMolBase::GetConfs()
      and for keeping track of a particular conformer use an OEConfBase*.

   .. oe:method: SetMCMol IGNORED-METHOD

      .. oe:api::

         void SetMCMol(OEMCMolBase &)=0

      Sets the associated multi-conformer molecule which is serving as
      the container for the :ref:`OEConfBase <OEChem_OEConfBase>`.

      .. seealso::

         * :oe:meth:`OEChem::OEConfBase::GetMCMol`

   .. oe:method:: SetTorsion

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTorsion(OETorsion &)=0
            void SetTorsion(OEAtomBase* a, OEAtomBase* b, OEAtomBase* c,
                            OEAtomBase* d, double radians)=0

      .. oe:language:: python

         .. oe:api:: python

            SetTorsion(arg2: OETorsion) -> None
            SetTorsion(a: OEAtomBase, b: OEAtomBase, c: OEAtomBase,
                       d: OEAtomBase, radians: float) -> None

      Sets torsion value in the conformer.
      The torsion can be defined by either an :ref:`OETorsion <OEChem_OETorsion>` object,
      or by four :ref:`OEAtomBase <OEChem_OEAtomBase>` objects

      .. seealso::

         * :oe:meth:`OEChem::OEConfBase::GetTorsion`

   .. oe:method:: Transform

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Transform(const OETrans &)=0
            void Transform(const OETransBase *)=0

      .. oe:language:: python

         .. oe:api:: python

            Transform(arg2: OETrans) -> None
            Transform(arg2: OETransBase) -> None

      Applies the geometric transformation specified in the
      :ref:`OETransBase <OEChem_OETransBase>` object or the series of geometric
      transformations specified in the :ref:`OETrans <OEChem_OETrans>`
      container to the :ref:`OEConfBase <OEChem_OEConfBase>`.  These functions
      permanently change the coordinates of the
      :ref:`OEConfBase <OEChem_OEConfBase>`.


.. oe:namespace:: OEChem

.. _OEChem_OEConfRMSD:

.. oe:class:: OEConfRMSD

   .. oe:api::

      class OEConfRMSD

   The :ref:`OEConfRMSD <OEChem_OEConfRMSD>` class provides fast RMSD calculation
   of conformers of the same molecule.
   During the RMSD calculation the automorphisms of the molecule graph is taken into
   consideration.
   Automorphisms are the symmetry related
   transformations of a molecule which can result in anomalously high
   RMSDs if not properly treated. For instance, t-butyl-benzene has a
   three-fold automorphism around the t-butyl group and a two-fold
   automorphism around the benzene ring.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfRMSD(const OEMolBase& mol,
                       const OEConfRMSDOptions& opts = OEConfRMSDOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEConfRMSD(mol: Union[OEGraphMol,OEMol,OEQMol],
                       opts: OEConfRMSDOptions = OEConfRMSDOptions()) -> OEConfRMSD

      Constructs an :ref:`OEConfRMSD <OEChem_OEConfRMSD>` object using a
      :ref:`OEMolBase <OEChem_OEMolBase>` and an optional
      :ref:`OEConfRMSDOptions <OEChem_OEConfRMSDOptions>`.

      .. seealso::

         * :ref:`OEConfRMSDOptions <OEChem_OEConfRMSDOptions>` class

   .. oe:method:: CalculateRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            double CalculateRMSD(const OEConfBase* refconf,
                                 const OEConfBase* fitconf) const
            double CalculateRMSD(const double* refcoords,
                                 const double* fitcoords) const

      .. oe:language:: python

         .. oe:api:: python

            CalculateRMSD(refconf: OEConfBase, fitconf: OEConfBase) -> float
            CalculateRMSD(refcoords: OEDoubleArray, fitcoords: OEDoubleArray) -> float

      Calculates the RMSD between the two conformations. The inputs can be
      either the :ref:`OEConfRMSD <OEChem_OEConfRMSD>` objects or their coordinates.

      For the second overload, the length of the arrays should be ``3*MaxAtomIdx`` and
      should contain the Cartesian coordinates of the two conformers being assessed. 

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfRMSDOptions GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEConfRMSDOptions

      Returns the options used to set up the :ref:`OEConfRMSD <OEChem_OEConfRMSD>` object.

      .. seealso::

         * :ref:`OEConfRMSDOptions <OEChem_OEConfRMSDOptions>` class

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OEConfRMSD <OEChem_OEConfRMSD>` object is valid.

   .. oe:method:: MinimizeRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            double MinimizeRMSD(const OEConfBase* refconf,
                                const OEConfBase* fitconf, OETrans& trans) const
            double MinimizeRMSD(const double* refcoords,
                                const double* fitcoords, OETrans& trans) const

      .. oe:language:: python

         .. oe:api:: python

            MinimizeRMSD(refconf: OEConfBase, fitconf: OEConfBase,
                         trans: OETrans) -> float
            MinimizeRMSD(refcoords: OEDoubleArray, fitcoords: OEDoubleArray,
                         trans: OETrans) -> float

      The function returns the minimum RMSD between the two conformations and reports
      the translation and rotation, *trans*, required to give this minimum RMSD.

      For the second overload, the length of the arrays should be ``3*MaxAtomIdx`` and
      should contain the Cartesian coordinates of the two conformers being assessed. 

   .. oe:method:: NumAutomorphs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumAutomorphs() const

      .. oe:language:: python

         .. oe:api:: python

            NumAutomorphs() -> int

      The function returns the number of automorphisms taken into account
      during the RMSD calculation.

   **Example:**

   The following example finds the two conformers of a molecule that have
   the smallest RMSD.

   .. oe:source:: ClosestConfs.py
      :language: python
      :noindent:
      :frag: SNIPPET

   .. oe:source:: ClosestConfs.cpp
      :language: c++
      :noindent:
      :frag: SNIPPET

   .. oe:source:: ClosestConfs.java
      :language: java
      :noindent:
      :frag: SNIPPET

   .. oe:source:: ClosestConfs.cs
      :language: csharp
      :noindent:
      :frag: SNIPPET

   .. seealso::

      * :oe:func:`OEChem::OERMSD` function
      * :oe:func:`OEChem::OEWeightedRMSD` function


.. oe:namespace:: OEChem

.. _OEChem_OEConfRMSDOptions:

.. oe:class:: OEConfRMSDOptions

   .. oe:api::

      class OEConfRMSDOptions : public OESystem::OEOptions

   This class represents options for setting up :oe:func:`OEChem::OEConfRMSD`
   calculations.

   .. seealso::

      * :ref:`OEConfRMSD <OEChem_OEConfRMSD>` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfRMSDOptions()
            OEConfRMSDOptions(const OEConfRMSDOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEConfRMSDOptions() -> OEConfRMSDOptions
            OEConfRMSDOptions(arg2: OEConfRMSDOptions) -> OEConfRMSDOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEConfRMSDOptions &operator=(const OEConfRMSDOptions &)

      Assignment operator.

   .. oe:method:: GetIgnoreHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetIgnoreHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetIgnoreHydrogens() -> bool

      If ``true``, hydrogen atoms are ignored when assessing automorphisms.

   .. oe:method:: GetIgnoreTerminalHeavy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetIgnoreTerminalHeavy() const

      .. oe:language:: python

         .. oe:api:: python

            GetIgnoreTerminalHeavy() -> bool

      If ``true``, terminal heavy atoms are ignored when assessing automorphisms.

   .. oe:method:: GetMaxMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxMatches() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMatches() -> int

      Returns the maximum number of automorphism solutions that the
      :ref:`OESubSearch <OEChem_OESubSearch>` object will identify before
      terminating the search.

   .. oe:method:: SetIgnoreHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIgnoreHydrogens(bool ignore)

      .. oe:language:: python

         .. oe:api:: python

            SetIgnoreHydrogens(value: bool) -> bool

      Sets whether to ignore or consider hydrogen atoms when assessing
      automorphisms in the molecule graph. The default is ``true``.
      Hydrogen atom can not be considered while ignoring terminal heavy atoms.

   .. oe:method:: SetIgnoreTerminalHeavy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIgnoreTerminalHeavy(bool ignore)

      .. oe:language:: python

         .. oe:api:: python

            SetIgnoreTerminalHeavy(value: bool) -> bool

      Sets whether to ignore or consider terminal heavy atoms assessing automorphisms
      in the molecule graphs. The default is ``false``.
      Terminal heavy atoms can not be ignored while considering hydrogens.

   .. oe:method:: SetMaxMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxMatches(unsigned int maxmatches)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxMatches(value: int) -> bool

      Sets the maximum number of subgraphs to be determined by the
      :oe:meth:`OEChem::OESubSearch::Match` method.  Once the maximum number of
      subgraphs have been found, the search for additional subgraphs is
      terminated.  By default, the maximum number of matches is set to ``16384``. The
      method returns ``false`` if the maximum number of matches is zero.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEConfTestBase, ConfTestBase

.. _OEChem_OEConfTestBase:

.. oe:class:: OEConfTestBase

   .. oe:api::

      class OEConfTestBase

   :ref:`OEConfTestBase <OEChem_OEConfTestBase>` is the abstract base class which
   defines the interface for classes used to determine whether
   consecutive molecules read from single-conformer file-formats are
   combined into multi-conformer molecules.

   The following classes derive from this class:
    * :ref:`OEAbsCanonicalConfTest <OEChem_OEAbsCanonicalConfTest>`
    * :ref:`OEAbsoluteConfTest <OEChem_OEAbsoluteConfTest>`
    * :ref:`OEDefaultConfTest <OEChem_OEDefaultConfTest>`
    * :ref:`OEIsomericConfTest <OEChem_OEIsomericConfTest>`
    * :ref:`OEOmegaConfTest <OEChem_OEOmegaConfTest>`

   .. oe:method:: CombineMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CombineMols(OEMCMolBase& m1, OEMolBase& m2)=0

      .. oe:language:: python

         .. oe:api:: python

            CombineMols(m1: OEMol, m2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Adds ``m2`` as a new conformer in the multi-conformer ``m1``
      molecule. Returns a boolean indicating whether this combination
      was successful. This method should only be called if a previous
      call to :oe:meth:`OEChem::OEConfTestBase::CompareMols`
      previously returned ``true``.

   .. oe:method:: CompareMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CompareMols(OEMolBase& m1, OEMolBase& m2) const = 0

      .. oe:language:: python

         .. oe:api:: python

            CompareMols(m1: Union[OEGraphMol,OEMol,OEQMol],
                        m2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This is the pure virtual function used to determine if two
      molecules are conformers of the same multi-conformer
      molecule. Users inheriting from this class must define this
      function. Note the molecule which is the second argument is not
      const. This allows the second molecule to be modified as may be
      necessary for it to be part of a multi-conformer molecule. It
      can be assumed that every molecule from an input stream will be
      used as argument 'm2' in this function call at least once.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfTestBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEConfTestBase

      Return a pointer to a copy of the derived object. This must be
      implemented by all derived classes.

   .. oe:method:: HasCompareMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCompareMols() const

      .. oe:language:: python

         .. oe:api:: python

            HasCompareMols() -> bool

      Return whether the
      :oe:meth:`OEChem::OEConfTestBase::CompareMols` method has a
      "real" implementation and does not always return ``false``. This
      allows :oe:func:`OEChem::OEReadMolecule` to significantly
      optimize the performance of reading single conformer file
      formats into :ref:`OEMCMolBase <OEChem_OEMCMolBase>` objects by avoiding
      copy operations. By default, this base-class method always
      returns ``true`` to be backwards compatible with sub-classes
      already written before this method was
      added. :oe:meth:`OEChem::OEDefaultConfTest::HasCompareMols` is
      the only **OEChem TK** implementation of this method that
      returns ``false``, allowing significant performance optimization
      for the reading into :ref:`OEMol <OEChem_OEMol>` by default.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEConstCoords, ConstCoords

.. _OEChem_OEConstCoords:

.. oe:class:: OEConstCoords

   .. oe:language:: python java csharp

      .. warning:: 

         This class is only usable from the OpenEye C++ toolkits. 

   .. oe:api::

      template<class T>
      class OEConstCoords : public detail::OECoordsBase<const T, const OEConfBase>

   This class is used to provide convenient direct access to the
   memory storing coordinates for a :ref:`OEConfBase <OEChem_OEConfBase>`
   through the :oe:meth:`OEChem::OEConfBase::GetCoordsPtr` methods. If
   the data type of ``T`` does not match the implementation of
   :ref:`OEConfBase <OEChem_OEConfBase>`, this class makes a copy of the
   coordinates with :oe:meth:`OEChem::OEConfBase::GetCoords` instead.

   .. oe:language:: c++

      :oe:src:`Listing 1<SNIPPET-OEConstCoords-ConstCoords>` demonstrates how
      :ref:`OEConstCoords <OEChem_OEConstCoords>` can be used to get direct access
      to the coordinates in an :ref:`OEConfBase <OEChem_OEConfBase>` for a
      center-of-mass calculation. This can provide large efficiency
      gains due to the reduced need for temporary memory and copies
      like the :oe:meth:`OEChem::OEConfBase::GetCoords` method. 

      .. oe:source:: ConstCoords.cpp
         :language: c++
         :refnum:   1
         :frag:     SNIPPET-OEConstCoords

   .. seealso::

      This class only provides ``const`` read-only access, use
      :ref:`OEMutableCoords <OEChem_OEMutableCoords>` for write-access as well.

   .. oe:method:: Constructors

      .. oe:api::

         OEConstCoords(const OEConfBase* conf)

      Construct a read-only view of the coordinates in the conformer ``conf``. 

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEConstCoords & operator=(const OEConstCoords & rhs)

      Assignment operator.

   

   .. oe:method:: operator const T *
      :language: c++

      .. oe:api::

         operator const T *() const

      Allows implicitly casting this object into a const pointer of type
      ``T`` to the coordinates of the conformer used in the
      constructor.

   .. oe:method:: GetPtr

      .. oe:api::

         const T* GetPtr() const

      Returns a const pointer of type ``T`` to the coordinates of the
      conformer used in the constructor.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OECoordArray, CoordArray

.. _OEChem_OECoordArray:

.. oe:class:: OECoordArray

   .. oe:api::

      class OECoordArray

   This class represents `OECoordArray`.

   
   .. oe:method:: Constructors

      .. oe:api::

         OECoordArray()
         OECoordArray(const OECoordArray& rhs)
         OECoordArray(const OEChem::OEMolBase& mol)

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECoordArray& operator=(const OECoordArray& rhs)

      Assignment operator.

   .. oe:method:: operator double *
      :language: c++

      .. oe:api::

         operator double *() const



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. _OEChem_OECreateSubSearchDatabaseOptions:

.. oe:class:: OECreateSubSearchDatabaseOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OECreateSubSearchDatabaseOptions

   This class represents the :ref:`OECreateSubSearchDatabaseOptions <OEChem_OECreateSubSearchDatabaseOptions>`
   class that encapsulates properties that determine how a substructure search  database
   is generated when calling the  :oe:func:`OEChem::OECreateSubSearchDatabaseFile`
   function.

   The :ref:`OECreateSubSearchDatabaseOptions <OEChem_OECreateSubSearchDatabaseOptions>` class stores the following properties:

   .. list-table::
      :widths: 100 120 100 100 120
      :header-rows: 1

      * - Property
        - Default
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - screen type
        -
        - :oe:meth:`GetScreenType<OEChem::OECreateSubSearchDatabaseOptions::GetScreenType>`
        - :oe:meth:`Constructor<OEChem::OECreateSubSearchDatabaseOptions::Constructors>`
        - :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>` class

      * - database sorting
        - ``true``
        - :oe:meth:`GetSortByBitCounts<OEChem::OECreateSubSearchDatabaseOptions::GetSortByBitCounts>`
        - :oe:meth:`SetSortByBitCounts<OEChem::OECreateSubSearchDatabaseOptions::SetSortByBitCounts>`
        - boolean

      * - handling molecule titles
        - ``false``
        - :oe:meth:`GetKeepTitle<OEChem::OECreateSubSearchDatabaseOptions::GetKeepTitle>`
        - :oe:meth:`SetKeepTitle<OEChem::OECreateSubSearchDatabaseOptions::SetKeepTitle>`
        - boolean

      * - number of processors
        - ``0`` (0 means :oe:func:`OEGetNumProcessors<OEPlatform::OEGetNumProcessors>`)
        - :oe:meth:`GetNumProcessors<OEChem::OECreateSubSearchDatabaseOptions::GetNumProcessors>`
        - :oe:meth:`SetNumProcessors<OEChem::OECreateSubSearchDatabaseOptions::SetNumProcessors>`
        - unsigned integer

   .. seealso::

      * :oe:func:`OEChem::OECreateSubSearchDatabaseFile` function
      * :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` class

   .. admonition:: Code Example

       * :ref:`section_example_oechem_makefastss` example

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECreateSubSearchDatabaseOptions(const OESubSearchScreenTypeBase *)

      .. oe:language:: python

         .. oe:api:: python

            OECreateSubSearchDatabaseOptions(arg2: OESubSearchScreenTypeBase) -> OECreateSubSearchDatabaseOptions

      Constructs an :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>`
      object with the given screen type.

   .. oe:method:: GetKeepTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetKeepTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetKeepTitle() -> bool

      Returns whether the molecule titles are kept in the output substructure
      search database. The default is ``false``.

      .. seealso::

         * :oe:meth:`OEChem::OECreateSubSearchDatabaseOptions::SetKeepTitle` method

   .. oe:method:: GetNumProcessors

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetNumProcessors() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumProcessors() -> int

      Returned the number of processors used during the database generation.

      .. seealso::

         * :oe:meth:`OEChem::OECreateSubSearchDatabaseOptions::SetNumProcessors` method

   .. oe:method:: GetScreenType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESubSearchScreenTypeBase* GetScreenType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScreenType() -> OESubSearchScreenTypeBase

      Returns the type of the screen that will be generated for each molecule in
      substructure search database.

      .. seealso::

         * :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>` class

   .. oe:method:: GetSortByBitCounts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSortByBitCounts() const

      .. oe:language:: python

         .. oe:api:: python

            GetSortByBitCounts() -> bool

      Returns whether to sort the molecules based on their screen bit counts.
      The default is ``true``.

      .. seealso::

         * :oe:meth:`OEChem::OECreateSubSearchDatabaseOptions::SetSortByBitCounts` method

   .. oe:method:: SetKeepTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetKeepTitle(const bool keep)

      .. oe:language:: python

         .. oe:api:: python

            SetKeepTitle(keep: bool) -> None

      Sets whether to keep molecule titles taken from the input file as
      unique identifiers. If ``false``, a 16 character long
      `UUID <https://en.wikipedia.org/wiki/Universally_unique_identifier>`_ will
      be assigned for each molecule as a new title.

      .. hint::

         If the original molecule titles are kept, these titles should
         be unique.
         :oe:func:`OEChem::OECreateSubSearchDatabaseFile` will not check or
         throw any warnings for non-unique title when generating the substructure
         database files.

      By keeping the titles when the database is generated, an external
      id (such as corporate or vendor id) can be associate with each molecule
      in the substructure search database. When searching the database, the titles of
      the matched molecules can be retrieved by the
      :oe:meth:`OEChem::OESubSearchDatabase::GetMatchTitles` method.

   .. oe:method:: SetNumProcessors

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNumProcessors(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetNumProcessors(arg2: int) -> None

      Sets the number of threads that are used to generate the
      substructure search database when calling the
      :oe:func:`OEChem::OECreateSubSearchDatabaseFile` function.
      When set to ``0``, the number of processors used will be the number
      returned by the :oe:func:`OEPlatform::OEGetNumProcessors` function.

   .. oe:method:: SetSortByBitCounts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSortByBitCounts(const bool sort)

      .. oe:language:: python

         .. oe:api:: python

            SetSortByBitCounts(sort: bool) -> None

      Sets whether to sort the molecules based on their screen bit counts.

      .. hint::

         The :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` works with both
         sorted and unsorted input database files. While sorting the
         database at generation can take slightly more time, this pays
         off at search time. Based on the query molecule,
         significant portion of the screen matches can be skipped
         without losing any matches when using a sorted input database.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDefaultConfTest, DefaultConfTest

.. _OEChem_OEDefaultConfTest:

.. oe:class:: OEDefaultConfTest

   .. oe:api::

      class OEDefaultConfTest : public OEConfTestBase

   This class represents `OEDefaultConfTest`.

   This is the default implementation of
   :ref:`OEConfTestBase <OEChem_OEConfTestBase>`. It never combines connection tables
   into multi-conformer molecules. This function is set as the
   conformer test to use by all of the :ref:`oemolistream <OEChem_oemolistream>`
   constructors.

   The following methods are publicly inherited from :ref:`OEConfTestBase <OEChem_OEConfTestBase>`:

   =========================================================== =========================================================== ==========================================================
   :oe:meth:`CombineMols<OEChem::OEConfTestBase::CombineMols>` :oe:meth:`CompareMols<OEChem::OEConfTestBase::CompareMols>` :oe:meth:`CreateCopy<OEChem::OEConfTestBase::CreateCopy>` 
   =========================================================== =========================================================== ==========================================================

   .. oe:method:: CombineMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CombineMols(OEMCMolBase& m1, OEMolBase& m2)

      .. oe:language:: python

         .. oe:api:: python

            CombineMols(m1: OEMol, m2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Adds ``m2`` as a new conformer in ``m1`` and returns whether the
      combination was successful.

   .. oe:method:: CompareMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CompareMols(OEMolBase& m1, OEMolBase& m2) const

      .. oe:language:: python

         .. oe:api:: python

            CompareMols(m1: Union[OEGraphMol,OEMol,OEQMol],
                        m2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This method always returns ``false``.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfTestBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEConfTestBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEDefaultConfTest <OEChem_OEDefaultConfTest>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 
 
   .. oe:method:: HasCompareMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCompareMols() const

      .. oe:language:: python

         .. oe:api:: python

            HasCompareMols() -> bool

      Always returns ``false`` for this object to indicate that the
      implementation of the
      :oe:meth:`OEChem::OEConfTestBase::CompareMols` method is
      "trivial" and always returns ``false``, indicating molecule
      copying can be elided in :oe:func:`OEChem::OEReadMolecule`. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEEuler, Euler

.. _OEChem_OEEuler:

.. oe:class:: OEEuler

   .. oe:api::

      class OEEuler : public OETransBase

   This class represents `OEEuler`.

   The following methods are publicly inherited from :ref:`OETransBase <OEChem_OETransBase>`:

   ====================================================== ====================================================== =====================================================
   :oe:meth:`CreateCopy<OEChem::OETransBase::CreateCopy>` :oe:meth:`GetInverse<OEChem::OETransBase::GetInverse>`                                                      
   :oe:meth:`Extract<OEChem::OETransBase::Extract>`       :oe:meth:`Transform<OEChem::OETransBase::Transform>`                                                        
   ====================================================== ====================================================== =====================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEuler()
            OEEuler(const float* angles)
            OEEuler(const double* angles)
            OEEuler(float phi, float theta, float psi)
            OEEuler(double phi, double theta, double psi)

      .. oe:language:: python

         .. oe:api:: python

            OEEuler() -> OEEuler
            OEEuler(angles: OEDoubleArray) -> OEEuler
            OEEuler(angles: OEFloatArray) -> OEEuler
            OEEuler(phi: float, theta: float, psi: float) -> OEEuler

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEEuler &operator=(const float *rhs)
         OEEuler &operator=(const double *rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETransBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OETransBase

   .. oe:method:: Extract

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Extract(float* r, float* t) const
            void Extract(float* r, double* t) const
            void Extract(double* r, float* t) const
            void Extract(double* r, double* t) const

      .. oe:language:: python

         .. oe:api:: python

            Extract(r: OEFloatArray, t: OEFloatArray) -> None
            Extract(r: OEFloatArray, t: OEDoubleArray) -> None
            Extract(r: OEDoubleArray, t: OEFloatArray) -> None
            Extract(r: OEDoubleArray, t: OEDoubleArray) -> None

   .. oe:method:: GetAngles

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetAngles(float* angles) const
            void GetAngles(double* angles) const

      .. oe:language:: python

         .. oe:api:: python

            GetAngles(angles: OEFloatArray) -> None
            GetAngles(angles: OEDoubleArray) -> None

   .. oe:method:: GetInverse

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETransBase* GetInverse() const

      .. oe:language:: python

         .. oe:api:: python

            GetInverse() -> OETransBase

   .. oe:method:: GetPhi

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPhi() const

      .. oe:language:: python

         .. oe:api:: python

            GetPhi() -> float

   .. oe:method:: GetPsi

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPsi() const

      .. oe:language:: python

         .. oe:api:: python

            GetPsi() -> float

   .. oe:method:: GetTheta

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTheta() const

      .. oe:language:: python

         .. oe:api:: python

            GetTheta() -> float

   .. oe:method:: SetPhi

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPhi(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetPhi(radians: float) -> None

   .. oe:method:: SetPsi

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPsi(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetPsi(radians: float) -> None

   .. oe:method:: SetTheta

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTheta(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetTheta(radians: float) -> None

   .. oe:method: _Extract DO NOT DOCUMENT

      .. oe:api::

         template<class T, class U>
         void _Extract(T *rmat, U *trans) const



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEExprBase, ExprBase

.. _OEChem_OEExprBase:

.. oe:class:: OEExprBase

   .. oe:api::

      class OEExprBase

   This class represents `OEExprBase`.

   The :ref:`OEExprBase <OEChem_OEExprBase>` is an abstract class which defines
   an interface through which boolean expressions can test equivalence
   of nodes (atoms) and edges (bonds) during graph match processes.
   The expression class interface simplifies what is normally a binary
   tree representation of attributes which atoms and bonds must (not)
   have in order to be called equivalent to a corresponding node or
   edge.
   Derived classes may be used to extend the graph matching algorithms
   in *OEChem* to compare attributes beyond the pre-defined
   expressions in *OEChem*.
   In addition, user-defined expression classes may take full
   advantage of the arbitrary data storage mechanism which is part of
   the :ref:`OEBase <OESystem_OEBase>` class.
   Expression equivalence could then be performed on dynamic
   user-defined data extensions to atoms and bonds.

   .. oe:method:: Constructors

      .. oe:api::

         OEExprBase()

      Default and copy constructors.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExprBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEExprBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEExprBase <OEChem_OEExprBase>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 

   .. oe:method:: GetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetType() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetType() -> int

      This pure virtual method is designed to return a unique
      identifier for each :ref:`OEExprBase <OEChem_OEExprBase>` implementation.
      A listing of type identifiers returned by classes in *OEChem*
      which are derived from the :ref:`OEExprBase <OEChem_OEExprBase>` class can
      be found in the :oe:constns:`OEChem::OEExprType` namespace.
      User-defined implementations of the :ref:`OEExprBase <OEChem_OEExprBase>`
      class should return value for this method which does not collide
      with types returned by implementations provided by *OEChem*.
 
   .. oe:method:: IsEquivalent

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFuzzy& IsEquivalent(const OEBondBase *) const = 0
            const OEFuzzy& IsEquivalent(const OEAtomBase *) const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsEquivalent(arg2: OEBondBase) -> OEFuzzy
            IsEquivalent(arg2: OEAtomBase) -> OEFuzzy

      These pure virtual methods provide a common interface for
      testing attributes of atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) and
      bonds (:ref:`OEBondBase <OEChem_OEBondBase>`).
      Any method which does not modify an atom or bond may be called
      in an implementation of an
      :oe:meth:`OEChem::OEExprBase::IsEquivalent` method.
      The return value must be one of the :ref:`OEFuzzy <OEChem_OEFuzzy>`
      predefined instances of 
      true (:oe:const:`OEChem::OEFuzzVal::True`), 
      false (:oe:const:`OEChem::OEFuzzVal::False`), or 
      maybe (:oe:const:`OEChem::OEFuzzVal::Maybe`).


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEExtractRingTemplateOptions, ExtractRingTemplateOptions

.. _OEChem_OEExtractRingTemplateOptions:

.. oe:class:: OEExtractRingTemplateOptions

   .. oe:api::

      class OEExtractRingTemplateOptions

   This class represents :ref:`OEExtractRingTemplateOptions <OEChem_OEExtractRingTemplateOptions>` that
   stores the parameters that are used when extracting ring templates
   using :oe:func:`OEChem::OEExtractRingTemplates` function

   .. note::

      We recommend using the :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class for
      generating a ring template dictionary.

    .. figure:: oechemtk/images/OEExtractRingTemplates_Default.*
       :align: center

       **Example of extracting ring templates with default parameters**

   .. seealso::

      * :oe:func:`OEChem::OEExtractRingTemplates` function

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExtractRingTemplateOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEExtractRingTemplateOptions() -> OEExtractRingTemplateOptions

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExtractRingTemplateOptions(const OEExtractRingTemplateOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEExtractRingTemplateOptions(rhs: OEExtractRingTemplateOptions) -> OEExtractRingTemplateOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEExtractRingTemplateOptions &operator=(const OEExtractRingTemplateOptions &rhs)
         Assignment operator.

   .. oe:method:: GetRetainBondStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRetainBondStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetRetainBondStereo() -> bool

      Returns whether the cis/trans bond stereo configurations are kept in macro-cycles
      when extracting ring systems.

      .. seealso::

        * :oe:meth:`OEChem::OEExtractRingTemplateOptions::SetRetainBondStereo` method

   .. oe:method:: GetRetainExistingTemplates

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRetainExistingTemplates() const

      .. oe:language:: python

         .. oe:api:: python

            GetRetainExistingTemplates() -> bool

      Returns whether to return or ignore ring templates that have been already
      exist in the 2D coordinate generation system of OEChem.

      .. seealso::

        * :oe:meth:`OEChem::OEExtractRingTemplateOptions::SetRetainExistingTemplates` method

   .. oe:method:: SetRetainBondStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRetainBondStereo(bool retain)

      .. oe:language:: python

         .. oe:api:: python

            SetRetainBondStereo(arg2: bool) -> None

      Sets whether the cis/trans bond stereo configurations are kept in macro-cycles
      when extracting ring systems.
      By default, the bond stereo configurations in macro-cycles are retained.

      .. figure:: oechemtk/images/OEExtractRingTemplates_RemoveBondStereo.*
         :align: center

         **Example of extracting ring templates with removing bond stereo configurations**

      .. seealso::

        * :oe:meth:`OEChem::OEExtractRingTemplateOptions::GetRetainBondStereo` method

   .. oe:method:: SetRetainExistingTemplates

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRetainExistingTemplates(bool retain)

      .. oe:language:: python

         .. oe:api:: python

            SetRetainExistingTemplates(arg2: bool) -> None

      Sets whether to return or ignore ring templates that have been already
      exist in the 2D coordinate generation system of OEChem.
      By default, the existing ring templates are ignored.

      .. figure:: oechemtk/images/OEExtractRingTemplates_RetainExistingTemplates.*
         :align: center

         **Example of extracting ring templates with keeping existing ring templates**

      .. seealso::

        * :oe:meth:`OEChem::OEExtractRingTemplateOptions::GetRetainExistingTemplates` method


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEFileStringParameter, FileStringParameter

.. _OEChem_OEFileStringParameter:

.. oe:class:: OEFileStringParameter

   .. oe:api::

      class OEFileStringParameter : public OESystem::OEStringParameter

   The :ref:`OEFileStringParameter <OEChem_OEFileStringParameter>` represents parameter that has ``string`` value
   representing a readable file format for modeling objects, such as a molecule or a design unit.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OETypedParameter <OESystem_OETypedParameter>`:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   Following methods are publicly inherited from :ref:`OEPODParameter <OESystem_OEPODParameter>`:
    * :ref:`GetDefaultsVector <OESystem_GetDefaultsVector>`
    * :ref:`GetSettingsVector <OESystem_GetSettingsVector>`
    * :ref:`GetValuesVector <OESystem_GetValuesVector>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

          OEFileStringParameter()
          OEFileStringParameter(const std::string& name,
                                const unsigned fileType,
                                const unsigned fileTypeFlavor = 0u)
          OEFileStringParameter(const std::string& name,
                                const std::string& fileExt)
          OEFileStringParameter(const OEFileStringParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEFileStringParameter(name: str, fileType: int,
                                  fileTypeFlavor: int = 0) -> OEFileStringParameter
            OEFileStringParameter(name: str, fileExt: str) -> OEFileStringParameter
            OEFileStringParameter() -> OEFileStringParameter
            OEFileStringParameter(arg2: OEFileStringParameter) -> OEFileStringParameter

      Default and copy constructors.

      Constructs an :ref:`OEFileStringParameter <OEChem_OEFileStringParameter>` instance using the specified set of parameters.
      The ``fileType`` argument refers to constants defined in the :oe:constns:`OEChem::OEFileStringType` namespace.
      The ``fileTypeFlavor`` argument refers to constants defined in the :oe:constns:`OEChem::OEFileStringTypeFlavor` namespace.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFileStringParameter &operator=(const OEFileStringParameter &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEFuzzy, Fuzzy

.. _OEChem_OEFuzzy:

.. oe:class:: OEFuzzy

   .. oe:api::

      class OEFuzzy

   This class represents `OEFuzzy`.

   The :ref:`OEFuzzy <OEChem_OEFuzzy>` class represents fuzzy logic used in
   expression tests.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFuzzy()

      .. oe:language:: python

         .. oe:api:: python

            OEFuzzy() -> OEFuzzy

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFuzzy(const unsigned int v)

      .. oe:language:: python

         .. oe:api:: python

            OEFuzzy(v: int) -> OEFuzzy

      Construct an :ref:`OEFuzzy <OEChem_OEFuzzy>` object given with an
      integer value.
      The integer values should be one of the values give in the
      :oe:constns:`OEChem::OEFuzzVal` namespace.
      Three pre-defined global constant fuzzy values
      (:oe:const:`OEChem::OEFuzzVal::True`,
      :oe:const:`OEChem::OEFuzzVal::False`, and 
      :oe:const:`OEChem::OEFuzzVal::Maybe`) are define in
      *OEChem* which represent the fuzzy values of true, false, and
      maybe, respectively.

      Default and copy constructors.

   .. oe:method:: operator!
      :language: c++

      .. oe:api::

         const OEFuzzy &operator!() const

      Negation operator. 
      Negation of true(:oe:const:`OEChem::OEFuzzVal::True`) will return
      false(:oe:const:`OEChem::OEFuzzVal::False`).
      Negation of false(:oe:const:`OEChem::OEFuzzVal::False`) will
      return true(:oe:const:`OEChem::OEFuzzVal::True`).
      Negation of maybe(:oe:const:`OEChem::OEFuzzVal::Maybe`) will
      return maybe (:oe:const:`OEChem::OEFuzzVal::Maybe`).

   .. oe:method:: operator!=
      :language: c++

      .. oe:api::

         bool operator!=(const OEFuzzy &) const

      Not equal operator. Two :ref:`OEFuzzy <OEChem_OEFuzzy>` objects are not
      equivalent if their fuzzy logic values differ.
 
   .. oe:method:: operator&&
      :language: c++

      .. oe:api::

         const OEFuzzy &operator&&(const OEFuzzy &) const

      And operator. Logic values for ''fuzzy and'' is the following:

      * ``False && False`` -> :oe:const:`OEChem::OEFuzzVal::False`
      * ``False && Maybe`` -> :oe:const:`OEChem::OEFuzzVal::False`
      * ``False && True`` -> :oe:const:`OEChem::OEFuzzVal::False`
      * ``Maybe && False`` -> :oe:const:`OEChem::OEFuzzVal::False`
      * ``Maybe && Maybe`` -> :oe:const:`OEChem::OEFuzzVal::Maybe`
      * ``Maybe && True`` -> :oe:const:`OEChem::OEFuzzVal::Maybe`
      * ``True && False`` -> :oe:const:`OEChem::OEFuzzVal::False`
      * ``True && Maybe`` -> :oe:const:`OEChem::OEFuzzVal::Maybe`
      * ``True && True`` -> :oe:const:`OEChem::OEFuzzVal::True`

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEFuzzy &) const

      Equivalence operator. Two :ref:`OEFuzzy <OEChem_OEFuzzy>` objects are
      equivalent if their fuzzy logic values are identical.

   .. oe:method:: operator||
      :language: c++

      .. oe:api::

         const OEFuzzy &operator||(const OEFuzzy &) const

      Or operator. Logic values for ''fuzzy or'' is the following:

      * ``False || False`` -> :oe:const:`OEChem::OEFuzzVal::False`
      * ``False || Maybe`` -> :oe:const:`OEChem::OEFuzzVal::Maybe`
      * ``False || True`` -> :oe:const:`OEChem::OEFuzzVal::True`
      * ``Maybe || False`` -> :oe:const:`OEChem::OEFuzzVal::Maybe`
      * ``Maybe || Maybe`` -> :oe:const:`OEChem::OEFuzzVal::Maybe`
      * ``Maybe || True`` -> :oe:const:`OEChem::OEFuzzVal::True`
      * ``True || False`` -> :oe:const:`OEChem::OEFuzzVal::True`
      * ``True || Maybe`` -> :oe:const:`OEChem::OEFuzzVal::True`
      * ``True || True`` -> :oe:const:`OEChem::OEFuzzVal::True`

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Boolean test operator. Both fuzzy true
      (:oe:const:`OEChem::OEFuzzVal::True`) and maybe
      (:oe:const:`OEChem::OEFuzzVal::Maybe`) values will return
      ``true``. A fuzzy false(:oe:const:`OEChem::OEFuzzVal::False`)
      value will return ``false``.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetNbrAtom, GetNbrAtom

.. _OEChem_OEGetNbrAtom:

.. oe:class:: OEGetNbrAtom

   .. oe:api::

      class OEGetNbrAtom : public OESystem::OEUnaryFunction<OEChem::OEBondBase*, OEChem::OEAtomBase*>

   This class represents :ref:`OEGetNbrAtom <OEChem_OEGetNbrAtom>` functor that, when constructed
   with one atom and passed a bond,
   will return the neighbor atom which is across the bond from the
   construction atom.

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEGetNbrAtom(const OEChem::OEAtomBase* atom)

      .. oe:language:: python

         .. oe:api:: python

            OEGetNbrAtom(atom: OEAtomBase) -> OEGetNbrAtom

      Constructs the functor with atom (:ref:`OEAtomBase <OEChem_OEAtomBase>`) as
      the reference atom used to find neighbors.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            result_type operator()(const argument_type &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: OEBondBase) -> OEAtomBase

      Returns the :ref:`OEAtomBase <OEChem_OEAtomBase>` pointer that returned
      by the :oe:meth:`OEChem::OEBondBase::GetNbr` (atom), 
      where 'atom' is the construction :ref:`OEAtomBase <OEChem_OEAtomBase>`
      argument.

   .. oe:method: operator new IGNORED - INTERNAL USE ONLY

      .. oe:api::

         void *operator new(size_t)

   .. oe:method: operator delete IGNORED - INTERNAL USE ONLY

      .. oe:api::

         void operator delete(void *, size_t)

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEBondBase *, OEChem::OEAtomBase *>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryFuncBondAtom

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEGetNbrAtom <OEChem_OEGetNbrAtom>`
      object is dynamically  allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGraphMol, GraphMol

.. _OEChem_OEGraphMol:

.. oe:class:: OEGraphMol

   .. oe:api::

      class OEGraphMol

   This class represents :ref:`OEGraphMol <OEChem_OEGraphMol>` that is a single-conformer concrete implementation
   of the :ref:`OEMolBase <OEChem_OEMolBase>` base class.
   It is recommended to use in cheminformatics applications.

   .. seealso::

      :ref:`chapter_molctordtor` chapter

   The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>`:

   =========================================================== =========================================================== ============================================================
   :oe:meth:`operator=<OEChem::OEMolBase::operator=>`          :oe:meth:`GetDimension<OEChem::OEMolBase::GetDimension>`    :oe:meth:`NumBonds<OEChem::OEMolBase::NumBonds>`
   :oe:meth:`operator bool<OEChem::OEMolBase::operator bool>`  :oe:meth:`GetEnergy<OEChem::OEMolBase::GetEnergy>`          :oe:meth:`NumGroups<OEChem::OEMolBase::NumGroups>`
   :oe:meth:`Clear<OEChem::OEMolBase::Clear>`                  :oe:meth:`GetGroup<OEChem::OEMolBase::GetGroup>`            :oe:meth:`OrderAtoms<OEChem::OEMolBase::OrderAtoms>`
   :oe:meth:`ClearCoords<OEChem::OEMolBase::ClearCoords>`      :oe:meth:`GetGroups<OEChem::OEMolBase::GetGroups>`          :oe:meth:`OrderBonds<OEChem::OEMolBase::OrderBonds>`
   :oe:meth:`Compress<OEChem::OEMolBase::Compress>`            :oe:meth:`GetMaxAtomIdx<OEChem::OEMolBase::GetMaxAtomIdx>`  :oe:meth:`ResetPerceived<OEChem::OEMolBase::ResetPerceived>`
   :oe:meth:`Count<OEChem::OEMolBase::Count>`                  :oe:meth:`GetMaxBondIdx<OEChem::OEMolBase::GetMaxBondIdx>`  :oe:meth:`SetCoords<OEChem::OEMolBase::SetCoords>`
   :oe:meth:`CreateCopy<OEChem::OEMolBase::CreateCopy>`        :oe:meth:`GetTitle<OEChem::OEMolBase::GetTitle>`            :oe:meth:`SetDimension<OEChem::OEMolBase::SetDimension>`
   :oe:meth:`DeleteAtom<OEChem::OEMolBase::DeleteAtom>`        :oe:meth:`HasPerceived<OEChem::OEMolBase::HasPerceived>`    :oe:meth:`SetEnergy<OEChem::OEMolBase::SetEnergy>`
   :oe:meth:`DeleteBond<OEChem::OEMolBase::DeleteBond>`        :oe:meth:`IsDataType<OEChem::OEMolBase::IsDataType>`        :oe:meth:`SetPerceived<OEChem::OEMolBase::SetPerceived>`
   :oe:meth:`DeleteGroup<OEChem::OEMolBase::DeleteGroup>`      :oe:meth:`IsDeleted<OEChem::OEMolBase::IsDeleted>`          :oe:meth:`SetRxn<OEChem::OEMolBase::SetRxn>`
   :oe:meth:`GetAtom<OEChem::OEMolBase::GetAtom>`              :oe:meth:`IsRxn<OEChem::OEMolBase::IsRxn>`                  :oe:meth:`SetTitle<OEChem::OEMolBase::SetTitle>`
   :oe:meth:`GetAtoms<OEChem::OEMolBase::GetAtoms>`            :oe:meth:`NewAtom<OEChem::OEMolBase::NewAtom>`              :oe:meth:`Sweep<OEChem::OEMolBase::Sweep>`
   :oe:meth:`GetBond<OEChem::OEMolBase::GetBond>`              :oe:meth:`NewBond<OEChem::OEMolBase::NewBond>`              :oe:meth:`UnCompress<OEChem::OEMolBase::UnCompress>`
   :oe:meth:`GetBonds<OEChem::OEMolBase::GetBonds>`            :oe:meth:`NewGroup<OEChem::OEMolBase::NewGroup>`
   :oe:meth:`GetCoords<OEChem::OEMolBase::GetCoords>`          :oe:meth:`NumAtoms<OEChem::OEMolBase::NumAtoms>`
   =========================================================== =========================================================== ============================================================

   .. oe:language:: java

      The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>` only in Java:

      ====================================================== ====================================================== =========================================================
      :oe:meth:`GetAtomList<OEChem::OEMolBase::GetAtomList>` :oe:meth:`GetBondList<OEChem::OEMolBase::GetBondList>` :oe:meth:`GetGroupList<OEChem::OEMolBase::GetGroupList>`
      ====================================================== ====================================================== =========================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEGraphMol(const OEMolBase &)
            OEGraphMol(const OEGraphMol &)
            OEGraphMol(const OEMolBase &, unsigned int type)
            OEGraphMol(const OEGraphMol &, unsigned int type)
            OEGraphMol(unsigned int type = OEMolBaseType::OEDefault)
            OEGraphMol(const OEMol &,
                       unsigned int type = OEMolBaseType::OEDefault)
            OEGraphMol(const OEQMol &,
                       unsigned int type = OEMolBaseType::OEDefault)
            OEGraphMol(const OEQMolBase &,
                       unsigned int type = OEMolBaseType::OEDefault)
            OEGraphMol(const OEMCMolBase &,
                       unsigned int type = OEMolBaseType::OEDefault)

      .. oe:language:: python

         .. oe:api:: python

            OEGraphMol(t: int = OEGraphMolType.OEDefault) -> OEGraphMol
            OEGraphMol(mol: OEGraphMol, t: int) -> OEGraphMol
            OEGraphMol(mol: OEGraphMol) -> OEGraphMol
            OEGraphMol(mol: OEQMol, t: int = OEGraphMolType.OEDefault) -> OEGraphMol
            OEGraphMol(mol: OEMol, t: int = OEGraphMolType.OEDefault) -> OEGraphMol
            OEGraphMol(mol: Union[OEMol,OEQMol]) -> OEGraphMol

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEGraphMol &operator=(const OEMol &)
         OEGraphMol &operator=(const OEQMol &)
         OEGraphMol &operator=(const OEMolBase &)
         OEGraphMol &operator=(const OEQMolBase &)
         OEGraphMol &operator=(const OEGraphMol &)
         OEGraphMol &operator=(const OEMCMolBase &)

      Assignment operator.

   .. oe:method:: operator OEMolBase &
      :language: c++

      .. oe:api::

         operator const OEMolBase &() const
         operator OEMolBase &()

   .. oe:method:: SCMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMolBase& SCMol() const
            OEMolBase& SCMol()
      .. oe:language:: python

         .. oe:api:: python

            SCMol() -> OEGraphMol



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGroupBase, GroupBase

.. _OEChem_OEGroupBase:

.. oe:class:: OEGroupBase

   .. oe:api::

      class OEGroupBase  : public OESystem::OEBase

   The :ref:`OEGroupBase <OEChem_OEGroupBase>` class is the abstract interface for
   representing a 'group' container that can store atom and bond pointers
   of a molecule.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEGroupBase & operator=(const OEGroupBase & rhs)

      Assignment operator.

   .. ################################################################
      # AddAtom
      ################################################################

   .. oe:method:: AddAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddAtom(OEAtomBase* atom)=0

      .. oe:language:: python

         .. oe:api:: python

            AddAtom(atom: OEAtomBase) -> bool

      Adds an atom to the group.
      A group can hold only atoms that belong to the same
      molecule on which the group is created.

      .. seealso::

         * :oe:meth:`OEChem::OEGroupBase::GetParent` method

   .. oe:method:: AddBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddBond(OEBondBase* bond)=0

      .. oe:language:: python

         .. oe:api:: python

            AddBond(bond: OEBondBase) -> bool

      Adds a bond to the group.
      A group can hold only bonds that belong to the same
      molecule on which the group is created.

      .. seealso::

         * :oe:meth:`OEChem::OEGroupBase::GetParent` method

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()=0

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      This method removes all atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) and
      bonds (:ref:`OEBondBase <OEChem_OEBondBase>`) that are stored in the group.

   .. oe:method:: DeleteAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteAtom(OEAtomBase* atom)=0

      .. oe:language:: python

         .. oe:api:: python

            DeleteAtom(atom: OEAtomBase) -> bool

      Deletes an atom from a group.
      Returns ``true`` if the atom was successfully removed.

   .. oe:method:: DeleteBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteBond(OEBondBase* bond)=0

      .. oe:language:: python

         .. oe:api:: python

            DeleteBond(bond: OEBondBase) -> bool

      Deletes a bond from a group.
      Returns ``true`` if the bond was successfully removed.

   .. oe:method:: GetAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEAtomBase>* GetAtoms() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> OEAtomIter

      Returns an iterator over all the atoms in the group.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEAtomBase>* GetAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms(atompred: OEUnaryAtomPred) -> OEAtomIter

      Returns an iterator over all of the atoms in the group that
      match the specified atom predicate
      (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`).

   .. oe:method:: GetBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBondBase>* GetBonds() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBonds() -> OEBondIter

      Returns an iterator over all the bonds in the group.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBondBase>* GetBonds(const OESystem::OEUnaryPredicate<OEChem::OEBondBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBonds(bondpred: OEUnaryBondPred) -> OEBondIter

      Returns an iterator over all bonds in the group that
      match the specified bond predicate
      (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`).

   .. oe:method:: GetGroupDefinition

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetGroupDefinition(OEChem::OEAtomBondSet &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetGroupDefinition(abset: OEAtomBondSet) -> bool

      Returns the entire group definition as an :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`.

   .. oe:method:: GetParent

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMolBase* GetParent() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetParent() -> OEGraphMol

      Returns the parent molecule of a group.
      All :oe:cls:`OEChem::OEGroupBases<OEChem::OEGroupBase>` are created
      as a container of an :ref:`OEMolBase <OEChem_OEMolBase>`.
      This method can be used to determine the molecule of which atoms
      and bonds the group stores.
      The 'parent molecule' property of a group cannot be altered, as its
      determined at the point the group is created.

   .. oe:method:: GetGroupType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetGroupType() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetGroupType() -> int

      Returns the type of the group.

      .. seealso::

         * :oe:meth:`OEChem::OEGroupBase::SetGroupType` methods
         * :oe:constns:`OEChem::OEGroupType` namespace for the built-in group types

   .. oe:method:: HasAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasAtom(const OEAtomBase* atom) const = 0

      .. oe:language:: python

         .. oe:api:: python

            HasAtom(atom: OEAtomBase) -> bool

      Returns ``true`` if the given atom belongs to the group.

   .. oe:method:: HasBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasBond(const OEBondBase* bond) const = 0

      .. oe:language:: python

         .. oe:api:: python

            HasBond(bond: OEBondBase) -> bool

      Returns ``true`` if the given bond belongs to the group.

   .. oe:method:: IsDeleted

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDeleted() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsDeleted() -> bool

      Returns ``true`` if the group has been deleted or if all atom and bonds
      have been removed from the group i.e. if the group is empty.

   .. oe:method:: IsEmpty

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsEmpty() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsEmpty() -> bool

      Returns ``true`` if all atom and bonds
      have been removed from the group, i.e. if the group is empty.

   .. oe:method:: NumAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumAtoms() const = 0

      .. oe:language:: python

         .. oe:api:: python

            NumAtoms() -> int

      Returns the number of atoms in the group.

   .. oe:method:: NumBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumBonds() const = 0

      .. oe:language:: python

         .. oe:api:: python

            NumBonds() -> int

      Returns the number of bonds in the group.

   .. oe:method:: SetGroupType

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetGroupType(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetGroupType(arg2: int) -> None

      Sets the type of the group.

      .. seealso::

         * :oe:meth:`OEChem::OEGroupBase::GetGroupType` method
         * :oe:constns:`OEChem::OEGroupType` namespace for the built-in group types

   .. oe:method:: Sweep

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Sweep()=0

      .. oe:language:: python

         .. oe:api:: python

            Sweep() -> bool

      Removes  atoms and bonds from the group for which the
      :oe:meth:`OEChem::OEAtomBase::IsDeleted` method and the
      :oe:meth:`OEChem::OEBondBase::IsDeleted` method returns ``true``,
      respectively.


.. oe:namespace:: OEChem

.. _OEChem_OEHasAlphaBetaUnsat:

.. oe:class:: OEHasAlphaBetaUnsat

   .. oe:api::

      class OEHasAlphaBetaUnsat : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents `OEHasAlphaBetaUnsat`.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasAlphaBetaUnsat(bool includePandS = true)

      .. oe:language:: python

         .. oe:api:: python

            OEHasAlphaBetaUnsat(includePandS: bool = True) -> OEHasAlphaBetaUnsat

      Default and copy constructors.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasAlphaBetaUnsat



.. oe:namespace:: OEChem

.. _OEChem_OEHasAnisou:

.. oe:class:: OEHasAnisou

   .. oe:api::

      class OEHasAnisou : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents the :ref:`OEHasAnisou <OEChem_OEHasAnisou>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) that have associated
   anisotropic B-factor parameters.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Method returning ``true`` if anisotropic B-factor parameters are associated
      with the input atom.

      .. seealso::

         * :ref:`OEAnisoUij <OEChem_OEAnisoUij>`
         * :oe:func:`OEChem::OEGetAnisou`
         * :oe:func:`OEChem::OESetAnisou`

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasAnisou

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasAnisou <OEChem_OEHasAnisou>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasAtomInGroup, HasAtomInGroup

.. _OEChem_OEHasAtomInGroup:

.. oe:class:: OEHasAtomInGroup

   .. oe:api::

      class OEHasAtomInGroup : public OESystem::OEUnaryPredicate<OEGroupBase>

   This class represents :ref:`OEHasAtomInGroup <OEChem_OEHasAtomInGroup>` functor that
   identifies groups (:ref:`OEGroupBase <OEChem_OEGroupBase>`) that store a specific
   atom (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasAtomInGroup(const OEAtomBase* atom)

      .. oe:language:: python

         .. oe:api:: python

            OEHasAtomInGroup(atom: OEAtomBase) -> OEHasAtomInGroup

      Constructs the functor with the given atom.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEGroupBase& group) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(group: OEGroupBase) -> bool

      Returns ``true``, if the atom with which the functor is constructed
      is stored in the group.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEGroupBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryGroupBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasAtomInGroup <OEChem_OEHasAtomInGroup>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasAtomName, HasAtomName

.. _OEChem_OEHasAtomName:

.. oe:class:: OEHasAtomName

   .. oe:api::

      class OEHasAtomName : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEHasAtomName <OEChem_OEHasAtomName>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with a specific name.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasAtomName(const char* name, const bool trimspaces = false)

      .. oe:language:: python

         .. oe:api:: python

            OEHasAtomName(name: str, trimspaces: bool = False) -> OEHasAtomName

      Constructs the functor with the provided name. The trimspaces allows matching atoms with names by first trimming off white spaces.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the atom name returned by the 
      :oe:meth:`OEChem::OEAtomBase::GetName` method for the given :ref:`OEAtomBase <OEChem_OEAtomBase>`
      object is equivalent to the name with which the functor is constructed.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasAtomName

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasAtomName <OEChem_OEHasAtomName>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasAtomStereoSpecified, HasAtomStereoSpecified

.. _OEChem_OEHasAtomStereoSpecified:

.. oe:class:: OEHasAtomStereoSpecified

   .. oe:api::

      class OEHasAtomStereoSpecified : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEHasAtomStereoSpecified <OEChem_OEHasAtomStereoSpecified>`
   functor that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`)
   which have stereo specified.

   .. seealso::

      * :term:`stereo atom`

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:
   

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasAtomStereoSpecified()

      .. oe:language:: python

         .. oe:api:: python

            OEHasAtomStereoSpecified() -> OEHasAtomStereoSpecified

      Default constructor.
      Constructs the functor so that atoms
      (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with any stereo type will be
      identified (:oe:const:`OEChem::OEAtomStereo::All`).

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasAtomStereoSpecified(unsigned int v)

      .. oe:language:: python

         .. oe:api:: python

            OEHasAtomStereoSpecified(v: int) -> OEHasAtomStereoSpecified

      Constructs the functor so that atoms
      (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with the given stereo type will be
      identified.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the
      :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` method returns
      ``true`` for the given :ref:`OEAtomBase <OEChem_OEAtomBase>` object for
      the stereo type with which the functor is constructed.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasAtomStereoSpecified

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasAtomStereoSpecified <OEChem_OEHasAtomStereoSpecified>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasAtomicNum, HasAtomicNum

.. _OEChem_OEHasAtomicNum:

.. oe:class:: OEHasAtomicNum

   .. oe:api::

      class OEHasAtomicNum : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEHasAtomicNum <OEChem_OEHasAtomicNum>` functor that
   identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with a specific atomic number.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:
   

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasAtomicNum(unsigned int an)

      .. oe:language:: python

         .. oe:api:: python

            OEHasAtomicNum(an: int) -> OEHasAtomicNum

      Constructs the functor with the internal atomic number.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the atomic number returned by the 
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum` method for the given
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object is equivalent to the atomic
      number with which the functor is constructed.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasAtomicNum

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasAtomicNum <OEChem_OEHasAtomicNum>` object is dynamically
      allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasBondInGroup, HasBondInGroup

.. _OEChem_OEHasBondInGroup:

.. oe:class:: OEHasBondInGroup

   .. oe:api::

      class OEHasBondInGroup : public OESystem::OEUnaryPredicate<OEGroupBase>

   This class represents :ref:`OEHasBondInGroup <OEChem_OEHasBondInGroup>` functor that
   identifies groups (:ref:`OEGroupBase <OEChem_OEGroupBase>`) that store a specific
   bond (:ref:`OEBondBase <OEChem_OEBondBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasBondInGroup(const OEBondBase* bond)

      .. oe:language:: python

         .. oe:api:: python

            OEHasBondInGroup(bond: OEBondBase) -> OEHasBondInGroup

      Constructs the functor with the given bond.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEGroupBase& group) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(group: OEGroupBase) -> bool

      Returns ``true``, if the bond with which the functor is constructed
      is stored in the group.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEGroupBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryGroupBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasBondInGroup <OEChem_OEHasBondInGroup>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasBondStereoSpecified, HasBondStereoSpecified

.. _OEChem_OEHasBondStereoSpecified:

.. oe:class:: OEHasBondStereoSpecified

   .. oe:api::

      class OEHasBondStereoSpecified : public OESystem::OEUnaryPredicate<OEChem::OEBondBase>

   This class represents :ref:`OEHasBondStereoSpecified <OEChem_OEHasBondStereoSpecified>`
   functor that identifies bonds (:ref:`OEBondBase <OEChem_OEBondBase>`)
   which have stereo specified.

   .. seealso::

      * :term:`stereo bond`

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasBondStereoSpecified(unsigned int v = OEBondStereo::All)

      .. oe:language:: python

         .. oe:api:: python

            OEHasBondStereoSpecified(v: int) -> OEHasBondStereoSpecified

      Constructs the functor so that bonds
      (:ref:`OEBondBase <OEChem_OEBondBase>`) with the given stereo type will be
      identified.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> bool

      Returns ``true``, if the
      :oe:meth:`OEChem::OEBondBase::HasStereoSpecified` method returns
      ``true`` for the given :ref:`OEBondBase <OEChem_OEBondBase>` object for
      the stereo type with which the functor is constructed.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEBondBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasBondStereoSpecified

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasBondStereoSpecified <OEChem_OEHasBondStereoSpecified>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasChainID, HasChainID

.. _OEChem_OEHasChainID:

.. oe:class:: OEHasChainID

   .. oe:api::

      class OEHasChainID : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEHasChainID <OEChem_OEHasChainID>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with a specific chain ID.

   .. seealso::

      :ref:`section_predicates_reside_data_functors` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasChainID(const char id)

      .. oe:language:: python

         .. oe:api:: python

            OEHasChainID(id: str) -> OEHasChainID

      Constructs the functor with the internal chain id.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if :oe:func:`OEChem::OEAtomGetResidue`
      (atom). :oe:meth:`GetChainID()<OEChem::OEResidue::GetChainID>` is
      equivalent to the chain id with which the functor is
      constructed.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasChainID

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasChainID <OEChem_OEHasChainID>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasFormalCharge, HasFormalCharge

.. _OEChem_OEHasFormalCharge:

.. oe:class:: OEHasFormalCharge

   .. oe:api::

      class OEHasFormalCharge : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEHasFormalCharge <OEChem_OEHasFormalCharge>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with a specific formal charge.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasFormalCharge(int c)

      .. oe:language:: python

         .. oe:api:: python

            OEHasFormalCharge(c: int) -> OEHasFormalCharge

      Constructs the functor with the given formal charge.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the charge returned by the
      :oe:meth:`OEChem::OEAtomBase::GetFormalCharge` method for the given :ref:`OEAtomBase <OEChem_OEAtomBase>`
      object is equivalent to the charge with which the functor is constructed.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasFormalCharge

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasFormalCharge <OEChem_OEHasFormalCharge>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasFragmentNumber, HasFragmentNumber

.. _OEChem_OEHasFragmentNumber:

.. oe:class:: OEHasFragmentNumber

   .. oe:api::

      class OEHasFragmentNumber : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEHasFragmentNumber <OEChem_OEHasFragmentNumber>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with a specific
   fragment number.

   .. seealso::

      :ref:`section_predicates_reside_data_functors` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasFragmentNumber(unsigned int num)

      .. oe:language:: python

         .. oe:api:: python

            OEHasFragmentNumber(num: int) -> OEHasFragmentNumber

      Constructs the functor with the internal fragment number.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if :oe:func:`OEChem::OEAtomGetResidue`
      (atom). :oe:meth:`GetFragmentNumber()<OEChem::OEResidue::GetFragmentNumber>` is
      equivalent to the number with which the functor is
      constructed.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasFragmentNumber

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasFragmentNumber <OEChem_OEHasFragmentNumber>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasGroupType, HasGroupType

.. _OEChem_OEHasGroupType:

.. oe:class:: OEHasGroupType

   .. oe:api::

      class OEHasGroupType : public OESystem::OEUnaryPredicate<OEGroupBase>

   This class represents :ref:`OEHasGroupType <OEChem_OEHasGroupType>` functor that
   identifies groups (:ref:`OEGroupBase <OEChem_OEGroupBase>`) with a specific
   type.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasGroupType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            OEHasGroupType(type: int) -> OEHasGroupType

      Constructs the functor with the given type.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEGroupBase& group) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(group: OEGroupBase) -> bool

      Returns ``true``, if the number returned by the
      :oe:meth:`OEChem::OEGroupBase::GetGroupType` method  is equivalent 
      to the number with which the functor is constructed.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEGroupBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryGroupBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasGroupType <OEChem_OEHasGroupType>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasHvyDegree, HasHvyDegree

.. _OEChem_OEHasHvyDegree:

.. oe:class:: OEHasHvyDegree

   .. oe:api::

      class OEHasHvyDegree : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEHasHvyDegree <OEChem_OEHasHvyDegree>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with a specific
   number of heavy atom neighbors.

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasHvyDegree(unsigned int h)

      .. oe:language:: python

         .. oe:api:: python

            OEHasHvyDegree(h: int) -> OEHasHvyDegree

      Constructs the functor with the given number of heavy atom neighbor.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the value returned by the
      :oe:meth:`OEChem::OEAtomBase::GetHvyDegree` method for the given :ref:`OEAtomBase <OEChem_OEAtomBase>`
      object is equivalent to the value with which the functor is constructed.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasHvyDegree

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasHvyDegree <OEChem_OEHasHvyDegree>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasIdx, HasIdx

.. _OEChem_OEHasIdx:

.. oe:class:: OEHasIdx

   .. oe:api::

      template<class Arg>
      class OEHasIdx : public OESystem::OEUnaryPredicate<Arg>

   This class represents :ref:`OEHasIdx <OEChem_OEHasIdx>` template functor that
   identifies object that provides a ``GetIdx`` method with a specific index.

   .. seealso::

      * :ref:`section_atombondindices_dontdothis` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   The following specializations exist for this template:

   ==================== ====================================================================
   Specialized Functor  Definition                                                          
   ==================== ====================================================================
   OEHasAtomIdx         :ref:`OEHasIdx <OEChem_OEHasIdx>` <:ref:`OEAtomBase <OEChem_OEAtomBase>`>
   OEHasBondIdx         :ref:`OEHasIdx <OEChem_OEHasIdx>` <:ref:`OEBondBase <OEChem_OEBondBase>`>
   OEHasConfIdx         :ref:`OEHasIdx <OEChem_OEHasIdx>` <:ref:`OEConfBase <OEChem_OEConfBase>`>
   ==================== ====================================================================

   .. index::
      single: OEHasAtomIdx
      single: OEHasBondIdx
      single: OEHasConfIdx

   .. oe:method:: Constructors

      .. oe:api::

         OEHasIdx(unsigned int idx)

      Constructs the functor with the internal index number.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const Arg& arg) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg: Arg) -> bool

      Returns ``true``, if the index returned by the 
      ``Arg.GetIdx()`` method  is equivalent to the number  
      with which the functor is constructed.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETYPENAME OESystem::OEUnaryFunction<Arg, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasIdx

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasIdx <OEChem_OEHasIdx>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasMapIdx, HasMapIdx

.. _OEChem_OEHasMapIdx:

.. oe:class:: OEHasMapIdx

   .. oe:api::

      class OEHasMapIdx : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEHasMapIdx <OEChem_OEHasMapIdx>` functor that identifies
   atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with any or a specific map index.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasMapIdx(unsigned int idx = 0)

      .. oe:language:: python

         .. oe:api:: python

            OEHasMapIdx(idx: int = 0) -> OEHasMapIdx

      Constructs the functor with the internal map index.
      With no arguments, this constructs a functor which returns ``true``
      for any atom with a non-zero map index. When constructed with a
      non-zero integer, it constructs a functor which return ``true`` for
      atoms which have the same map index as the constructor argument.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the index returned by the 
      :oe:meth:`OEChem::OEAtomBase::GetMapIdx` method for the given
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object is equivalent to the non-zero index
      number with which the functor is constructed.

      Returns ``true``, if the index returned by the 
      :oe:meth:`OEChem::OEAtomBase::GetMapIdx` method for the given
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object is non-zero when the index
      number with which the functor is constructed is ``0``.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasMapIdx

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasMapIdx <OEChem_OEHasMapIdx>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:class:: OEHasMonomerType

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHasMonomerType
      
   This functor can be used to identify monomers with the given monomer type
   (:oe:constns:`OEChem::OEMonomerType`).
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasMonomerType(unsigned polymerType)

      .. oe:language:: python

         .. oe:api:: python

            OEHasMonomerType(monomerType: int) -> OEHasMonomerType

      Initializes the functor with the given polymer type from the 
      :oe:constns:`OEChem::OEMonomerType` namespace.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasMonomerType(const OEHasMonomerType &)

      .. oe:language:: python

         .. oe:api:: python

            OEHasMonomerType(arg2: OEHasMonomerType) -> OEHasMonomerType

      Copy constructor.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEMonomer &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: OEMonomer) -> bool

      Returns true, if the given monomer has the same monomer type
      the :oe:cls:`OEChem::OEHasMonomerType` functor is initialized with.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHasMonomerType &operator=(const OEHasMonomerType &)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEMonomer, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryMonomerBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :oe:cls:`OEChem::OEHasMonomerType`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasOrder, HasOrder

.. _OEChem_OEHasOrder:

.. oe:class:: OEHasOrder

   .. oe:api::

      class OEHasOrder : public OESystem::OEUnaryPredicate<OEChem::OEBondBase>

   This class represents :ref:`OEHasOrder <OEChem_OEHasOrder>` functor that identifies
   bonds (:ref:`OEBondBase <OEChem_OEBondBase>`) with a specific bond order.
 
   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasOrder(unsigned int o)

      .. oe:language:: python

         .. oe:api:: python

            OEHasOrder(o: int) -> OEHasOrder

      Constructs the functor with the internal bond order.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> bool

      Returns ``true``, if the bond order returned by the 
      :oe:meth:`OEChem::OEBondBase::GetOrder` method for the given
      :ref:`OEBondBase <OEChem_OEBondBase>` object is equivalent to the bond
      order with which the functor is constructed.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEBondBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasOrder

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasOrder <OEChem_OEHasOrder>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:class:: OEHasPolymerType

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHasPolymerType
      
   This functor can be used to identify monomers with the given polymer type
   (:oe:constns:`OEChem::OEPolymerType`).
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasPolymerType(unsigned polymerType)

      .. oe:language:: python

         .. oe:api:: python

            OEHasPolymerType(polymerType: int) -> OEHasPolymerType

      Initializes the functor with the given polymer type from the 
      :oe:constns:`OEChem::OEPolymerType` namespace.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasPolymerType(const OEHasPolymerType &)

      .. oe:language:: python

         .. oe:api:: python

            OEHasPolymerType(arg2: OEHasPolymerType) -> OEHasPolymerType

      Copy constructor.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEMonomer &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: OEMonomer) -> bool

      Returns true, if the given monomer has the same polymer type
      the :oe:cls:`OEChem::OEHasPolymerType` functor is initialized with.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHasPolymerType &operator=(const OEHasPolymerType &)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEMonomer, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryMonomerBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :oe:cls:`OEChem::OEHasPolymerType`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasResidueNumber, HasResidueNumber

.. _OEChem_OEHasResidueNumber:

.. oe:class:: OEHasResidueNumber

   .. oe:api::

      class OEHasResidueNumber : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEHasResidueNumber <OEChem_OEHasResidueNumber>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with a specific
   residue number.

   .. seealso::

      :ref:`section_predicates_reside_data_functors` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasResidueNumber(int num)

      .. oe:language:: python

         .. oe:api:: python

            OEHasResidueNumber(num: int) -> OEHasResidueNumber

      Constructs the functor with the internal residue number.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if :oe:func:`OEChem::OEAtomGetResidue`
      (atom). :oe:meth:`GetResidueNumber()<OEChem::OEResidue::GetResidueNumber>` is
      equivalent to the residue number with which the functor is
      constructed.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasResidueNumber

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHasResidueNumber <OEChem_OEHasResidueNumber>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:class:: OEHelmGenerationOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHelmGenerationOptions

   Encapsulates the properties that control HELM generation from a molecule.

   .. seealso::

      * :oe:cls:`OEChem::OEHelmGenerationResult` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHelmGenerationOptions()
            OEHelmGenerationOptions(const std::string& codeSet,
                                    bool allowUnspecifiedStereo = false,
                                    bool allowPartialMonomerMatch = false)

      .. oe:language:: python

         .. oe:api:: python

            OEHelmGenerationOptions() -> OEHelmGenerationOptions
            OEHelmGenerationOptions(codeSet: str,
                                    allowUnspecifiedStereo: bool = False,
                                    allowPartialMonomerMatch: bool = False) -> OEHelmGenerationOptions

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHelmGenerationOptions(const OEHelmGenerationOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEHelmGenerationOptions(arg2: OEHelmGenerationOptions) -> OEHelmGenerationOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHelmGenerationOptions &operator=(const OEHelmGenerationOptions &)

      Assignment operator.

   .. oe:method:: GetAllowUnmatchedFragments

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAllowUnmatchedFragments() const

      .. oe:language:: python

         .. oe:api:: python

            GetAllowUnmatchedFragments() -> bool

      Returns whether unmatched fragments are allowed when generating the :term:`HELM`
      when using :oe:func:`OEChem::OEMolToHelm` function.
      Unmatched fragments  will be encoded as embedded SMILES in the generated  :term:`HELM`
      string.

   .. oe:method:: GetAllowUnspecifiedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAllowUnspecifiedStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetAllowUnspecifiedStereo() -> bool

      Returns whether unspecified atom or bond stereochemistry are allowed when 
      generating the :term:`HELM` when using :oe:func:`OEChem::OEMolToHelm` function.

   .. oe:method:: GetCodeSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetCodeSet() const

      .. oe:language:: python

         .. oe:api:: python

            GetCodeSet() -> str

      Returns the code-set to be used for generating the :term:`HELM` string.

      .. seealso::

         * :oe:meth:`OEChem::OEHelmGenerationOptions::SetCodeSet` method

   .. oe:method:: GetMinUnmatchedAtomsRatio

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMinUnmatchedAtomsRatio() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinUnmatchedAtomsRatio() -> float

      Returns the minimum atom to fragment ratio that are allowed when generating the :term:`HELM`
      when using :oe:func:`OEChem::OEMolToHelm` function.

   .. oe:method:: SetAllowUnmatchedFragments

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAllowUnmatchedFragments(bool allow)

      .. oe:language:: python

         .. oe:api:: python

            SetAllowUnmatchedFragments(value: bool) -> bool

      Sets whether unmatched fragments are allowed when generating the :term:`HELM`
      when using :oe:func:`OEChem::OEMolToHelm` function.

   .. oe:method:: SetAllowUnspecifiedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAllowUnspecifiedStereo(bool allow)

      .. oe:language:: python

         .. oe:api:: python

            SetAllowUnspecifiedStereo(value: bool) -> bool

      Sets whether unspecified atom or bond stereochemistry are allowed when 
      generating the :term:`HELM` when using :oe:func:`OEChem::OEMolToHelm` function.

   .. oe:method:: SetCodeSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCodeSet(const std::string& codeSet)

      .. oe:language:: python

         .. oe:api:: python

            SetCodeSet(value: str) -> bool

      Sets the code-set to be used for generating the :term:`HELM` string.
      If not set the primary code-set will be used. 

      .. seealso::

         * :oe:meth:`OEChem::OEMonomerSet::GetPrimaryCodeSet` method

   .. oe:method:: SetMinUnmatchedAtomsRatio

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMinUnmatchedAtomsRatio(double minRatio)

      .. oe:language:: python

         .. oe:api:: python

            SetMinUnmatchedAtomsRatio(value: float) -> bool

      Sets the minimum atom to fragment ratio that are allowed when generating the :term:`HELM`
      when using :oe:func:`OEChem::OEMolToHelm` function.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:class:: OEHelmGenerationResult

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHelmGenerationResult

   This class is used to return additional information when using the  
   :oe:cls:`OEChem::OEMolToHelm` function.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHelmGenerationResult()
            OEHelmGenerationResult(const OEHelmGenerationResult &)

      .. oe:language:: python

         .. oe:api:: python

            OEHelmGenerationResult() -> OEHelmGenerationResult
            OEHelmGenerationResult(arg2: OEHelmGenerationResult) -> OEHelmGenerationResult

      Default and copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHelmGenerationResult &operator=(const OEHelmGenerationResult &)

      Assignment operator. 

   .. oe:method:: GetCodeSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetCodeSet() const

      .. oe:language:: python

         .. oe:api:: python

            GetCodeSet() -> str

      Returns the name of the code-set that is used to successfully generate the :term:`HELM` string.

   .. oe:method:: GetReturnCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetReturnCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetReturnCode() -> int

      Returns a code from the  
      :oe:constns:`OEChem::OEHelmGenerationReturnCode` namespace.

   .. oe:method:: GetUnmappedFragments

      Returns the SMILES representation of unmapped fragments in the molecule.

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetUnmappedFragments() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnmappedFragments() -> OEStringVector

   .. oe:method:: GetWarning

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetWarning() const

      .. oe:language:: python

         .. oe:api:: python

            GetWarning() -> str

      If the :term:`HELM` generation fails, i.e. the return code is not 
      :oe:const:`OEChem::OEHelmGenerationReturnCode::Success`,
      this message provides details about the reason for the failure.
   


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. _OEHelmParsingResult:

.. oe:class:: OEHelmParsingResult

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHelmParsingResult

   This class is used to return additional information when using the  
   :oe:cls:`OEChem::OEHelmToMol` function.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHelmParsingResult()
            OEHelmParsingResult(const OEHelmParsingResult &)

      .. oe:language:: python

         .. oe:api:: python

            OEHelmParsingResult() -> OEHelmParsingResult
            OEHelmParsingResult(arg2: OEHelmParsingResult) -> OEHelmParsingResult

      Default and copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHelmParsingResult &operator=(const OEHelmParsingResult &)

      Assignment operator. 

   .. oe:method:: GetCodeSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetCodeSet() const

      .. oe:language:: python

         .. oe:api:: python

            GetCodeSet() -> str

      Returns the name of the code-set that is used to successfully parse the :term:`HELM` string.

   .. oe:method:: GetErrorPosition

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetErrorPosition() const

      .. oe:language:: python

         .. oe:api:: python

            GetErrorPosition() -> int

      If the HELm parsing fails, i.e. the return code is not 
      :oe:const:`OEChem::OEHelmParsingReturnCode::Success`,
      this shows the position in the HELM string where the failure occurs.

   .. oe:method:: GetReturnCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetReturnCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetReturnCode() -> int

      Returns a code from the  
      :oe:constns:`OEChem::OEHelmParsingReturnCode` namespace.

   .. oe:method:: GetWarning

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetWarning() const

      .. oe:language:: python

         .. oe:api:: python

            GetWarning() -> str

      If the :term:`HELM` parsing fails, i.e. the return code is not 
      :oe:const:`OEChem::OEHelmParsingReturnCode::Success`,
      this message provides details about the reason for the failure.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHydrogenCounter, HydrogenCounter

.. _OEChem_OEHydrogenCounter:

.. oe:class:: OEHydrogenCounter

   .. oe:api::

      class OEHydrogenCounter

   The :ref:`OEHydrogenCounter <OEChem_OEHydrogenCounter>` class is a utility class used for counting the implicit
   and explicit hydrogens within a molecule. 
   
   .. oe:method:: Constructors
      
      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHydrogenCounter(unsigned int explicitHCount = 0,
                              unsigned int implicitHCount = 0)

      .. oe:language:: python

         .. oe:api:: python

            OEHydrogenCounter(explicitHCount: int = 0, implicitHCount: int = 0) -> OEHydrogenCounter

      Constructs a counter with the specified explicit and implicit counts. 

   .. oe:method:: GetImplicitHCount 

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetImplicitHCount()

      .. oe:language:: python

         .. oe:api:: python

            GetImplicitHCount() -> int

      Returns the implicit hydrogen count stored in the counter.
      
   .. oe:method:: GetExplicitHCount
   
      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetExplicitHCount()

      .. oe:language:: python

         .. oe:api:: python

            GetExplicitHCount() -> int

      Returns the explicit hydrogen count stored in the counter.
       
   .. seealso::

      * :oe:func:`OEChem::OEGetHydrogenCounts`



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIdxSelected, IdxSelected

.. _OEChem_OEIdxSelected:

.. oe:class:: OEIdxSelected

   .. oe:api::

      template<class Arg>
      class OEIdxSelected : public OESystem::OEUnaryPredicate<Arg>

   This class represents `OEIdxSelected`, a template functor that identifies objects
   which provide a ``GetIdx`` method and have been selected by index in the
   boolean `array` or `vector` or :ref:`OEBitVector <OESystem_OEBitVector>` used
   to initialize the class.
   
   .. seealso::

      * :ref:`section_atombondindices_dontdothis` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   The following specializations exist for this template:

   .. index::
      single: OEAtomIdxSelected
      single: OEBondIdxSelected
      single: OEConfIdxSelected

   ==================== ====================================================================
   Specialized Functor  Definition                                                          
   ==================== ====================================================================
   OEAtomIdxSelected    :ref:`OEIdxSelected <OEChem_OEIdxSelected>` <:ref:`OEAtomBase <OEChem_OEAtomBase>`>
   OEBondIdxSelected    :ref:`OEIdxSelected <OEChem_OEIdxSelected>` <:ref:`OEBondBase <OEChem_OEBondBase>`>
   OEConfIdxSelected    :ref:`OEIdxSelected <OEChem_OEIdxSelected>` <:ref:`OEConfBase <OEChem_OEConfBase>`>
   ==================== ====================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++

         .. oe:api::

            OEIdxSelected(const OESystem::OEBitVector& bv)
            OEIdxSelected(const std::vector<bool>& vb)
            OEIdxSelected(const bool* ap, unsigned int sz)
            OEIdxSelected(const bool* ap)

         Construct the functor from an :ref:`OEBitVector <OESystem_OEBitVector>`, ``vector<bool>`` or boolean *array* (call it *s*)
         where the selection state of the object with internal index *i* is stored at *s[i]*
         (*e.g.* ``bv.SetBitOn(atom.GetIdx())``). The caller is responsible for making sure that the input
         :ref:`OEBitVector <OESystem_OEBitVector>`, ``vector<bool>`` or *array* is sufficient size to refer to the maximum index value of
         the objects it will be applied to.

         If only ``const bool *ap`` is supplied to the constructor, the functor continues to accesses the boolean array
         by its pointer. In that case, the caller is responsible for making certain that it is not be deleted before
         this functor is called. Because of this, it is recommended that you pass in the array size as well.

         If other arguments are supplied to the constructor, the selection states will be copied into an internal representation
         and the :ref:`OEBitVector <OESystem_OEBitVector>`, ``vector<bool>`` or *array* can be deleted before the functor is called.

      .. oe:language:: python java csharp

         .. oe:api::

            OEIdxSelected(const OESystem::OEBitVector& bv)

         Construct the functor from an :ref:`OEBitVector <OESystem_OEBitVector>` (call it *bv*)
         where the selection state of the object with internal index *i* is stored at *bv[i]*
         (*e.g.* ``bv.SetBitOn(atom.GetIdx())``). The caller is responsible for making sure that
         the input :ref:`OEBitVector <OESystem_OEBitVector>` is sufficient size to refer to the maximum
         index value of the objects it will be applied to.

         The selection states are copied into an internal representation
         and the :ref:`OEBitVector <OESystem_OEBitVector>` can be deleted before the functor is called.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const Arg& a) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(a: Arg) -> bool

      .. oe:language:: c++

         Returns ``true``, if the state of the
         *array*, ``vector`` or :ref:`OEBitVector <OESystem_OEBitVector>` used to construct
         the functor at the index returned by the 
         ``Arg.GetIdx()`` method is ``true``.

      .. oe:language:: python java csharp

         Returns ``true``, if the state of the
         :ref:`OEBitVector <OESystem_OEBitVector>` used to construct
         the functor at the index returned by the 
         ``Arg.GetIdx()`` method is ``true``.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETYPENAME OESystem::OEUnaryFunction<Arg, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIdxSelected

      Deep copy constructor that returns a copy of the object.
      The memory for the returned `OEIdxSelected` 
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. meta::
   :keywords: OEInChIOptions, InChIOptions

.. _OEChem_OEInChIOptions:

.. oe:class:: OEInChIOptions

   .. oe:api::

      class OEInChIOptions

   This class is used to control the output for the
   :oe:const:`OEChem::OEFormat::INCHI` and
   :oe:const:`OEChem::OEFormat::INCHIKEY` formats. The options have a
   direct mapping between the flavors in the
   :oe:constns:`OEChem::OEOFlavor::INCHI` and
   :oe:constns:`OEChem::OEOFlavor::INCHIKEY`. The options also have a
   direct mapping into the options provided by the InChI library.

   .. seealso::

      * `InChI API Reference`_ documentation
      * `InChI Technical Manual`_ documentation

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInChIOptions(unsigned int flavor = OEOFlavor::INCHI::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEInChIOptions(flavor: int) -> OEInChIOptions

      The default constructor initializes the options class to the
      flavors indicated by the :oe:const:`OEChem::OEOFlavor::INCHI::Default`
      constant.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInChIOptions(const OEInChIOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEInChIOptions(arg2: OEInChIOptions) -> OEInChIOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEInChIOptions &operator=(const OEInChIOptions &rhs)

      Assignment operator. 

   .. oe:method:: GetChiral

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetChiral() const

      .. oe:language:: python

         .. oe:api:: python

            GetChiral() -> bool

      Returns a bool stating whether to use absolute stereochemistry.

   .. oe:method:: GetFixedHLayer

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFixedHLayer() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixedHLayer() -> bool

      Returns whether to include the fixed H-layer.

   .. oe:method:: GetHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetHydrogens() -> bool

      Returns whether to add H according to usual valences.

   .. oe:method:: GetNonPolymerPseudoAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetNonPolymerPseudoAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetNonPolymerPseudoAtoms() -> bool

      Returns the state of the flag that allows non-polymer `*atoms` (:oe:const:`OEChem::OEElemNo::Du`) to
      be present in the structure used for :term:`InChI` generation.
      Setting this flag results in a nonstandard :term:`InChI` version.
      By default, no `*atoms` are allowed.  Currently there is no support for polymer InChIs in ``OEChem``.

   .. oe:method:: GetRacemicStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRacemicStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetRacemicStereo() -> bool

      Returns whether to export all stereo as racemic stereo in the :term:`InChI` string.
      By default, all stereo is exported as absolute stereo.

   .. oe:method:: GetReconnectedMetals

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetReconnectedMetals() const

      .. oe:language:: python

         .. oe:api:: python

            GetReconnectedMetals() -> bool

      Returns whether to include reconnected metals.

   .. oe:method:: GetRelativeStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRelativeStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelativeStereo() -> bool

      Returns whether to export all stereo as relative stereo in the :term:`InChI` string.
      By default, all stereo is exported as absolute stereo.

   .. oe:method:: GetStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetStereo() -> bool

      Returns whether the stereo information in the input structure is ignored.

   .. oe:method:: GetTimeout

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetTimeout() const

      .. oe:language:: python

         .. oe:api:: python

            GetTimeout() -> int

      Returns the setting for the maximum number of seconds the :term:`InChI` generation is allowed to take.
      By default, a ``60`` second execution limit is used.

   .. oe:method:: GetUndefinedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUndefinedStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetUndefinedStereo() -> bool

      Returns the setting that controls explicit undefined stereo annotations in the generated :term:`InChI` identifier.
      Default, ``false``.

   .. oe:method:: SetChiral

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetChiral(bool val)

      .. oe:language:: python

         .. oe:api:: python

            SetChiral(val: bool) -> None

      If set to true, use absolute stereochemistry, else relative
      stereochemistry (corresponds to :term:`InChI` option "ChiralFlagOn").

   .. oe:method:: SetFixedHLayer

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFixedHLayer(bool val)

      .. oe:language:: python

         .. oe:api:: python

            SetFixedHLayer(val: bool) -> None

      If set to true, do not allow for mobile hydrogens e.g. in
      tautomers (corresponds to :term:`InChI` option "FixedH").

   .. oe:method:: SetHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHydrogens(bool val)

      .. oe:language:: python

         .. oe:api:: python

            SetHydrogens(val: bool) -> None

      If set to true, hydrogens are added according to usual valences
      (corresponds to the inverse of the :term:`InChI` option "DoNotAddH").

   .. oe:method:: SetNonPolymerPseudoAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNonPolymerPseudoAtoms(bool val)

      .. oe:language:: python

         .. oe:api:: python

            SetNonPolymerPseudoAtoms(val: bool) -> None

      If set to true, non-polymer `*atoms` (:oe:const:`OEChem::OEElemNo::Du`) are allowed to be present
      in the structure used for :term:`InChI` generation.
      Setting this flag results in a nonstandard :term:`InChI` version.
      By default, no `*atoms` are allowed.  Currently there is no support for polymer InChIs in ``OEChem``.

   .. oe:method:: SetRacemicStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRacemicStereo(bool val)

      .. oe:language:: python

         .. oe:api:: python

            SetRacemicStereo(val: bool) -> None

      If set to true, export all stereo as racemic stereo (corresponds to
      :term:`InChI` option "SRac").  Enabling the racemic stereo option
      takes precedence over the option setting to disable
      :oe:meth:`OEChem::OEInChIOptions::SetStereo`.

   .. oe:method:: SetReconnectedMetals

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetReconnectedMetals(bool val)

      .. oe:language:: python

         .. oe:api:: python

            SetReconnectedMetals(val: bool) -> None

      If set to true, include reconnected metals (corresponds to
      :term:`InChI` option "RecMet").

   .. oe:method:: SetRelativeStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRelativeStereo(bool val)

      .. oe:language:: python

         .. oe:api:: python

            SetRelativeStereo(val: bool) -> None

      If set to true, export all stereo as relative stereo (corresponds to
      :term:`InChI` option "SRel").  Enabling the relative stereo option
      takes precedence over other option settings of
      :oe:meth:`OEChem::OEInChIOptions::SetRacemicStereo` or
      (disabled) :oe:meth:`OEChem::OEInChIOptions::SetStereo`.

   .. oe:method:: SetStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStereo(bool val)

      .. oe:language:: python

         .. oe:api:: python

            SetStereo(val: bool) -> None

      If set to true, stereo information is used from input structure
      (corresponds to the inverse of the :term:`InChI` option "SNon").

   .. oe:method:: SetTimeout

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTimeout(unsigned int val)

      .. oe:language:: python

         .. oe:api:: python

            SetTimeout(val: int) -> None

      Sets the :term:`InChI` execution time cutoff to ``val`` seconds.
      Setting a value of ``0`` means unlimited, and by default a ``60`` second limit is used.

   .. oe:method:: SetUndefinedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetUndefinedStereo(bool val)

      .. oe:language:: python

         .. oe:api:: python

            SetUndefinedStereo(val: bool) -> None

      If set to true, requests explicit undefined stereo annotations in the generated :term:`InChI` and :term:`InChIKey` identifiers.
      Enabling this flag always results in a nonstandard :term:`InChI`.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEInSamePart, InSamePart

.. _OEChem_OEInSamePart:

.. oe:class:: OEInSamePart

   .. oe:api::

      class OEInSamePart : public OESystem::OEBinaryPredicate<OEChem::OEAtomBase, OEChem::OEAtomBase>

   This class represents `OEInSamePart`.

   The following methods are publicly inherited from :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>`:

   =============================================================================== =============================================================================== ================================================================================
   :oe:meth:`operator()<OESystem::OEBinaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEBinaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEBinaryPredicate::CreatePredicateCopy>`
   =============================================================================== =============================================================================== ================================================================================

   The following methods are publicly inherited from :ref:`OEBinaryFunction <OESystem_OEBinaryFunction>`:

   ============================================================= ============================================================= ============================================================
   :oe:meth:`operator()<OESystem::OEBinaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEBinaryFunction::CreateCopy>`                                                             
   ============================================================= ============================================================= ============================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInSamePart(const OEInSamePart& rhs)
            OEInSamePart(unsigned int* parts, unsigned int size,
                         bool boolval = true)

      .. oe:language:: python

         .. oe:api:: python

            OEInSamePart(parts: int, boolval: bool = True) -> OEInSamePart
            OEInSamePart(rhs: OEInSamePart) -> OEInSamePart

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEInSamePart &operator=(const OEInSamePart &rhs)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& a1, const OEAtomBase& a2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(a1: OEAtomBase, a2: OEAtomBase) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEChem::OEAtomBase , OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInSamePart



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsAmideBond, IsAmide

.. _OEChem_OEIsAmideBond:

.. oe:class:: OEIsAmideBond

   .. oe:api::

      class OEIsAmideBond : public OESystem::OEUnaryPredicate<OEChem::OEBondBase>

   This class represents the :ref:`OEIsAmideBond <OEChem_OEIsAmideBond>` functor
   that identifies amide bonds.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsAmideBond(bool includeCappingGroups = true)

      .. oe:language:: python

         .. oe:api:: python

            OEIsAmideBond(includeCappingGroups: bool = True) -> OEIsAmideBond

      Default constructor.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEChem::OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> bool

      Returns ``true`` if the ``bond`` is an interresidue amide bond; otherwise, it returns ``false``.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEBondBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsAmideBond

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsAmideBond <OEChem_OEIsAmideBond>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using a C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsAromaticAtom, IsAromaticAtom

.. _OEChem_OEIsAromaticAtom:

.. oe:class:: OEIsAromaticAtom

   .. oe:api::

      struct OEIsAromaticAtom : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsAromaticAtom <OEChem_OEIsAromaticAtom>` functor that
   identifies aromatic atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsAromatic`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsAromaticAtom

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsAromaticAtom <OEChem_OEIsAromaticAtom>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsAromaticBond, IsAromaticBond

.. _OEChem_OEIsAromaticBond:

.. oe:class:: OEIsAromaticBond

   .. oe:api::

      struct OEIsAromaticBond : public OESystem::OEUnaryPredicate<OEChem::OEBondBase>

   This class represents :ref:`OEIsAromaticBond <OEChem_OEIsAromaticBond>` functor that
   identifies aromatic bonds (:ref:`OEBondBase <OEChem_OEBondBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEBondBase::IsAromatic`
      method returns ``true`` for the given 
      :ref:`OEBondBase <OEChem_OEBondBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEBondBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsAromaticBond

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsAromaticBond <OEChem_OEIsAromaticBond>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsAtomHybridization, IsAtomHybridization

.. _OEChem_OEIsAtomHybridization:

.. oe:class:: OEIsAtomHybridization

   .. oe:api::

      class OEIsAtomHybridization : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsAtomHybridization <OEChem_OEIsAtomHybridization>` functor
   that identifies atoms with the given hybridization.

   .. seealso::

      * :oe:func:`OEChem::OEAssignHybridization` function
      * :oe:constns:`OEChem::OEHybridization` namespace

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsAtomHybridization(unsigned int hyb)

      .. oe:language:: python

         .. oe:api:: python

            OEIsAtomHybridization(h: int) -> OEIsAtomHybridization

      Default constructors that creates an 
      :ref:`OEIsAtomHybridization <OEChem_OEIsAtomHybridization>` functor with the given
      hybridization.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::GetHyb`
      method returns the same hybridization with which the 
      :ref:`OEIsAtomHybridization <OEChem_OEIsAtomHybridization>` object was initialized.
  
      .. warning::
 
         Prior to using the :ref:`OEIsAtomHybridization <OEChem_OEIsAtomHybridization>` functor,
         the hybridization of a molecule should be perceived by calling
         the :oe:func:`OEChem::OEAssignHybridization` function.
         Otherwise the :oe:func:`OEChem::OEGetHybridization` function is 
         called every time to perceive the hybridization of the atom 
         on the fly.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsAtomHybridization

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsAtomHybridization <OEChem_OEIsAtomHybridization>`
      object is dynamically allocated  and owned by the caller.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsBridgeHead, IsBridgeHead

.. _OEChem_OEIsBridgeHead:

.. oe:class:: OEIsBridgeHead

   .. oe:api::

      class OEIsBridgeHead : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsBridgeHead <OEChem_OEIsBridgeHead>` functor that
   identifies bridge head atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsBridgeHead & operator=(const OEIsBridgeHead & rhs)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true`` if the atom is a bridge head of a ring, otherwise it returns ``false``.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsBridgeHead

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsBridgeHead <OEChem_OEIsBridgeHead>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsCAlpha, IsCAlpha

.. _OEChem_OEIsCAlpha:

.. oe:class:: OEIsCAlpha

   .. oe:api::

      class OEIsCAlpha : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsCAlpha <OEChem_OEIsCAlpha>` functor that
   identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with
   :oe:const:`OEChem::OEPDBAtomName::CA` PDB index.

   .. seealso::

      * :ref:`section_predicates_reside_data_functors` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if

      * the :oe:meth:`OEChem::OEAtomBase::IsCarbon`  method returns ``true`` and
      * the :oe:func:`OEHasResidue<OEChem::OEHasResidue>` returns ``true`` and
      * the :oe:func:`OEGetPDBAtomIndex<OEChem::OEGetPDBAtomIndex>` returns
        :oe:const:`OEChem::OEPDBAtomName::CA`

      for the given :ref:`OEAtomBase <OEChem_OEAtomBase>`, ``atom``, object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsCAlpha

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsCAlpha <OEChem_OEIsCAlpha>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsCarbon, IsCarbon

.. _OEChem_OEIsCarbon:

.. oe:class:: OEIsCarbon

   .. oe:api::

      struct OEIsCarbon : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsCarbon <OEChem_OEIsCarbon>` functor that
   identifies carbon atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsCarbon`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsCarbon

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsCarbon <OEChem_OEIsCarbon>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsChiralAtom, IsChiralAtom

.. _OEChem_OEIsChiralAtom:

.. oe:class:: OEIsChiralAtom

   .. oe:api::

      struct OEIsChiralAtom : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsChiralAtom <OEChem_OEIsChiralAtom>` functor that
   identifies chiral atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   .. seealso:: 

      * :term:`chiral atom`

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsChiral`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsChiralAtom

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsChiralAtom <OEChem_OEIsChiralAtom>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsChiralBond, IsChiralBond

.. _OEChem_OEIsChiralBond:

.. oe:class:: OEIsChiralBond

   .. oe:api::

      struct OEIsChiralBond : public OESystem::OEUnaryPredicate<OEChem::OEBondBase>

   This class represents :ref:`OEIsChiralBond <OEChem_OEIsChiralBond>` functor that
   identifies chiral bonds (:ref:`OEBondBase <OEChem_OEBondBase>`).

   .. seealso:: 

      * :term:`chiral bond`

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEBondBase::IsChiral`
      method returns ``true`` for the given 
      :ref:`OEBondBase <OEChem_OEBondBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEBondBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsChiralBond

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsChiralBond <OEChem_OEIsChiralBond>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsDisulfideBridgeBond, IsDisulfide

.. _OEChem_OEIsDisulfideBridgeBond:

.. oe:class:: OEIsDisulfideBridgeBond

   .. oe:api::

      class OEIsDisulfideBridgeBond : public OESystem::OEUnaryPredicate<OEChem::OEBondBase>

   This class represents the :ref:`OEIsDisulfideBridgeBond <OEChem_OEIsDisulfideBridgeBond>` functor
   that identifies the disulfide bonds.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsDisulfideBridgeBond()

      .. oe:language:: python

         .. oe:api:: python

            OEIsDisulfideBridgeBond() -> OEIsDisulfideBridgeBond

      Default constructor.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEChem::OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> bool

      Returns ``true`` if the ``bond`` is disulfide; otherwise, it returns ``false``.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEBondBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsDisulfideBridgeBond

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsDisulfideBridgeBond <OEChem_OEIsDisulfideBridgeBond>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using a C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsHalide, IsHalide

.. _OEChem_OEIsHalide:

.. oe:class:: OEIsHalide

   .. oe:api::

      struct OEIsHalide : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsHalide <OEChem_OEIsHalide>` functor that
   identifies halide (halogen) atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsHalogen`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsHalide

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsHalide <OEChem_OEIsHalide>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsHalogen, IsHalogen

.. _OEChem_OEIsHalogen:

.. oe:class:: OEIsHalogen

   .. oe:api::

      struct OEIsHalogen : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsHalogen <OEChem_OEIsHalogen>` functor that
   identifies halogen atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsHalogen`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsHalogen

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsHalogen <OEChem_OEIsHalogen>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsHeavy, IsHeavy

.. _OEChem_OEIsHeavy:

.. oe:class:: OEIsHeavy

   .. oe:api::

      struct OEIsHeavy : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsHeavy <OEChem_OEIsHeavy>` functor that
   identifies heavy atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`GetAtomicNum<OEChem::OEAtomBase::GetAtomicNum>`
      method is greater than 1 for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsHeavy

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsHeavy <OEChem_OEIsHeavy>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`sizefilter.cpp<section_example_oechem_sizefilter>`
      * Example program :ref:`molstats.cpp<section_example_oechem_molstats>`

  .. oe:language:: python

      * Example program :ref:`sizefilter.py<section_example_oechem_sizefilter>`
      * Example program :ref:`molstats.py<section_example_oechem_molstats>`

  .. oe:language:: java

      * Example program :ref:`SizeFilter.java<section_example_oechem_sizefilter>`
      * Example program :ref:`MolStats.java<section_example_oechem_molstats>`

  .. oe:language:: csharp

      * Example program :ref:`SizeFilter.cs<section_example_oechem_sizefilter>`
      * Example program :ref:`MolStats.cs<section_example_oechem_molstats>`


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsHetero, IsHetero

.. _OEChem_OEIsHetero:

.. oe:class:: OEIsHetero

   .. oe:api::

      struct OEIsHetero : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsHetero <OEChem_OEIsHetero>` functor that
   identifies hetero atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if both the :oe:meth:`OEChem::OEAtomBase::IsCarbon`
      and the :oe:meth:`OEChem::OEAtomBase::IsHydrogen`  methods return ``false`` 
      for the given :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsHetero

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsHetero <OEChem_OEIsHetero>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsHydrogen, IsHydrogen

.. _OEChem_OEIsHydrogen:

.. oe:class:: OEIsHydrogen

   .. oe:api::

      struct OEIsHydrogen : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsHydrogen <OEChem_OEIsHydrogen>` functor that
   identifies hydrogen atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsHydrogen`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsHydrogen

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsHydrogen <OEChem_OEIsHydrogen>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:class:: OEIsInMonomerCodeSet

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEIsInMonomerCodeSet
      
   Functor that identifies monomers whose code is defined in the specified code set.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsInMonomerCodeSet(const std::string& codeSet)

      .. oe:language:: python

         .. oe:api:: python

            OEIsInMonomerCodeSet(codeSet: str) -> OEIsInMonomerCodeSet

      Constructs the functor with the name of the code set to match against.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsInMonomerCodeSet(const OEIsInMonomerCodeSet &)

      .. oe:language:: python

         .. oe:api:: python

            OEIsInMonomerCodeSet(arg2: OEIsInMonomerCodeSet) -> OEIsInMonomerCodeSet

      Copy constructor.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEMonomer &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: OEMonomer) -> bool

      Returns ``true`` if the monomer has a code defined in the code set
      specified at construction.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsInMonomerCodeSet &operator=(const OEIsInMonomerCodeSet &)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEMonomer, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryMonomerBoolFunc



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsIntraResidueBond, IntraResidue

.. _OEChem_OEIsIntraResidueBond:

.. oe:class:: OEIsIntraResidueBond

   .. oe:api::

      class OEIsIntraResidueBond : public OESystem::OEUnaryPredicate<OEChem::OEBondBase>

   This class represents the :ref:`OEIsIntraResidueBond <OEChem_OEIsIntraResidueBond>`
   functor that identifies intra-residue bonds.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsIntraResidueBond()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntraResidueBond() -> OEIsIntraResidueBond

      Default constructor.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEChem::OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> bool

      Returns ``true`` if the ``bond`` is intra-residue; otherwise, it returns ``false``.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEBondBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsIntraResidueBond

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsIntraResidueBond <OEChem_OEIsIntraResidueBond>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using a C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsInvertibleNitrogen, IsInvertibleNitrogen

.. _OEChem_OEIsInvertibleNitrogen:

.. oe:class:: OEIsInvertibleNitrogen

   .. oe:api::

      struct OEIsInvertibleNitrogen : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsInvertibleNitrogen <OEChem_OEIsInvertibleNitrogen>` functor that
   identifies invertible nitrogen atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsNitrogen`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object and the atom has a degree of 3, a valence of 3, is not aromatic, and has less than 3 ring bonds.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsInvertibleNitrogen

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsInvertibleNitrogen <OEChem_OEIsInvertibleNitrogen>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsMDLStereoGroup, IsMDLStereoGroup

.. _OEChem_OEIsMDLStereoGroup:

.. oe:class:: OEIsMDLStereoGroup

   .. oe:api::

      class  OEIsMDLStereoGroup : public OESystem::OEUnaryPredicate<OEGroupBase>

   This class represents :ref:`OEIsMDLStereoGroup <OEChem_OEIsMDLStereoGroup>` functor that
   identifies groups (:ref:`OEGroupBase <OEChem_OEGroupBase>`) that store MDL
   enhanced stereo information.

   .. seealso::   

      * :oe:constns:`OEChem::OEGroupType` for built-in group types.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. ################################################################
      #
      ################################################################
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsMDLStereoGroup()

      .. oe:language:: python

         .. oe:api:: python

            OEIsMDLStereoGroup() -> OEIsMDLStereoGroup

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEGroupBase& group) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(group: OEGroupBase) -> bool

      Returns ``true``, if the number returned by the
      :oe:meth:`OEChem::OEGroupBase::GetGroupType` method is equivalent 
      to any of the following constants:

      * :oe:const:`OEChem::OEGroupType::MDLAbsStereo`
      * :oe:const:`OEChem::OEGroupType::MDLAndStereo`
      * :oe:const:`OEChem::OEGroupType::MDLOrStereo`

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEGroupBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryGroupBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsMDLStereoGroup <OEChem_OEIsMDLStereoGroup>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsMember, IsMember

.. _OEChem_OEIsMember:

.. oe:class:: OEIsMember

   .. oe:api::

      template<class C>
      class OEIsMember : public OESystem::OEUnaryPredicate<C>

   This class represents :ref:`OEIsMember <OEChem_OEIsMember>` template functor that
   identifies all of the objects which are in an STL
   container. 

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEIsMember()

      Default constructors.

      .. oe:api::

         OEIsMember(std::set<C>& v)
         OEIsMember(std::list<C>& v)
         OEIsMember(std::deque<C>& v)
         OEIsMember(std::vector<C>& v)

      Constructs the functor using an STL container of type 'C', which
      contains objects or pointers to objects. Any of the elements of
      the STL container will be considered to be 'a member' of the
      functor.

      .. oe:api::

         OEIsMember(OESystem::OEIter<C>& i)

      Constructs the functor using an iterator (:ref:`OEIter <OESystem_OEIter>`)
      over values of the same type as the functor template argument. 

      .. oe:api::

         OEIsMember(OESystem::OEIterBase<C>* i)

      Constructs the functor using an iterator (:ref:`OEIterBase <OESystem_OEIterBase>`)
      over values of the same type as the functor template argument. 

      .. oe:api::

         template<class T>
         OEIsMember(T bgn, T end)

      Constructs the functor using a sequence of values. The values
      from 'bgn' up to, but not including, 'end' are used to construct the
      functor. Using this constructor, the functor may be constructed
      from arrays and STL containers.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsMember<C>& operator=(const OEIsMember<C>& rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OEIsMember <OEChem_OEIsMember>` object
      into the right-hand side :ref:`OEIsMember <OEChem_OEIsMember>` object.

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const C& arg) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg: C) -> bool

      Returns ``true`` if the object arg (or a pointer to arg) is
      contained in the STL container passed to the functor on
      construction.

   .. oe:method:: Add

      .. oe:api::

         bool Add(C& item)

      Add a new element to be considered as ‘a member’ of the functor.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryPredicate<C>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsMember

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsMember <OEChem_OEIsMember>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 

   .. oe:method:: Set

      .. oe:api::

         template<class T>
         bool Set(T bgn, T end)

      All elements specified by the given iterators will be considered to be ‘a member’ of the functor.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsMemberPtr, IsMemberPtr

.. _OEChem_OEIsMemberPtr:

.. oe:class:: OEIsMemberPtr

   .. oe:api::

      template<class C>
      class OEIsMemberPtr : public OESystem::OEUnaryPredicate<C>

   This class represents :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>` template functor that
   performs set membership tests. This functor differs
   from the :ref:`OEIsMember <OEChem_OEIsMember>` functor in that the internal
   storage type differs from the test type. 
   While instances of abstract classes cannot be easily
   stored, however, pointers to abstract class instances do not pose
   the same storage problems. 
   :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>` stores pointers to
   data types, while the template type of the class is a single
   dereferenced version of the storage type.

   .. seealso::

      .. oe:language:: c++

         * Example program :ref:`minpath.cpp<section_example_oechem_minpath>`

      .. oe:language:: python

         * Example program :ref:`minpath.py<section_example_oechem_minpath>`

      .. oe:language:: java

         * Example program :ref:`MinPath.java<section_example_oechem_minpath>`

      .. oe:language:: csharp

         * Example program :ref:`MinPath.cs<section_example_oechem_minpath>`

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:language:: c++  python

      .. _OEChem_OEIsMemberPtr_OEIsAtomMember:
      .. _OEChem_OEIsMemberPtr_OEIsBondMember:

      The following specializations exist for this template:

      ==================== =======================================================================
      Specialized Functor  Definition                                                             
      ==================== =======================================================================
      OEIsAtomMember       :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>` < :ref:`OEAtomBase <OEChem_OEAtomBase>` >
      OEIsBondMember       :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>` < :ref:`OEBondBase <OEChem_OEBondBase>` >
      ==================== =======================================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEIsMemberPtr()

      Default constructor.

      .. oe:api::

         OEIsMemberPtr(OESystem::OEIter<C>& i)

      Constructs the functor using an iterator (:ref:`OEIter <OESystem_OEIter>`)
      over values of the same type as the functor template argument. 
      Addresses instead of instances or references to the data are
      stored internally.

      .. oe:api::

         OEIsMemberPtr(OESystem::OEIterBase<C>* i)

      Constructs the functor using an iterator (:ref:`OEIterBase <OESystem_OEIterBase>`)
      over values of the same type as the functor template argument. 
      Addresses instead of instances or references to the data are
      stored internally.

      .. oe:api::

         template<class T>  OEIsMemberPtr(T bgn, T end)

      Constructs the functor using a sequence of values. The values
      from 'bgn' up to, but not including 'end' are used to construct the
      functor. Using this constructor, the functor may be constructed
      from arrays and STL containers.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsMemberPtr<C>& operator=(const OEIsMemberPtr<C>& rhs)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const C& arg) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg: C) -> bool

      Returns ``true`` if a pointer to the object 'arg' is contained in the
      functor.

   .. oe:method:: Add

      .. oe:api::

         bool Add(const C* item)

      Add a new pointer to be considered as ‘a member’ of the functor.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryPredicate<C>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsMemberPtr

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 

   .. oe:method:: Set

      .. oe:api::

         template<class T>
         bool Set(T bgn, T end)



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsMetal, IsMetal

.. _OEChem_OEIsMetal:

.. oe:class:: OEIsMetal

   .. oe:api::

      struct OEIsMetal : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsMetal <OEChem_OEIsMetal>` functor that
   identifies metal atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsMetal`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsMetal

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsMetal <OEChem_OEIsMetal>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsMonomerGroup

.. _OEChem_OEIsMonomerGroup:

.. oe:class:: OEIsMonomerGroup

   .. oe:api::

      class  OEIsMonomerGroup : public OESystem::OEUnaryPredicate<OEGroupBase>

   This class represents :ref:`OEIsMonomerGroup <OEChem_OEIsMonomerGroup>` functor that
   identifies groups (:ref:`OEGroupBase <OEChem_OEGroupBase>`) that store monomer information.

   .. seealso::

      * :oe:constns:`OEChem::OEGroupType` for built-in group types.
      * :oe:cls:`OEChem::OEHasMonomerGroup` for a functor that identifies groups that match a monomer group by code set and code.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsMonomerGroup()

      .. oe:language:: python

         .. oe:api:: python

            __init__() -> OEIsMonomerGroup

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()
      :language: c++

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEGroupBase& group) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(group: OEGroupBase) -> bool

      Returns ``true``, if the number returned by the
      :oe:meth:`OEChem::OEGroupBase::GetGroupType` method is  :oe:const:`OEChem::OEGroupType::Monomer`.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEGroupBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryGroupBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsMonomerGroup <OEChem_OEIsMonomerGroup>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsNitrogen, IsNitrogen

.. _OEChem_OEIsNitrogen:

.. oe:class:: OEIsNitrogen

   .. oe:api::

      struct OEIsNitrogen : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsNitrogen <OEChem_OEIsNitrogen>` functor that
   identifies nitrogen atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsNitrogen`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsNitrogen

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsNitrogen <OEChem_OEIsNitrogen>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsNonRingAtomDoubleBondedToRing, IsNonRingAtomDoubleBondedToRing

.. _OEChem_OEIsNonRingAtomDoubleBondedToRing:

.. oe:class:: OEIsNonRingAtomDoubleBondedToRing

   .. oe:api::

      struct OEIsNonRingAtomDoubleBondedToRing : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents the :ref:`OEIsNonRingAtomDoubleBondedToRing <OEChem_OEIsNonRingAtomDoubleBondedToRing>` functor that
   identifies non-ring atoms double bonded to a ring.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsInRing`
      method returns ``false`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object, and the atom is bonded to an atom
      where the  :oe:meth:`OEChem::OEAtomBase::IsInRing`
      method returns ``true`` and the order of the bond as determined by the
      :oe:meth:`OEChem::OEBondBase::GetOrder` method is 2.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsNonRingAtomDoubleBondedToRing

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsNonRingAtomDoubleBondedToRing <OEChem_OEIsNonRingAtomDoubleBondedToRing>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`ringsubset.cpp<section_example_oechem_ringsubset>`
      * Example program :ref:`extractscaffold.cpp<section_example_oechem_extractscaffold>`

  .. oe:language:: python

      * Example program :ref:`ringsubset.py<section_example_oechem_ringsubset>`
      * Example program :ref:`extractscaffold.py<section_example_oechem_extractscaffold>`

  .. oe:language:: java

      * Example program :ref:`RingSubset.java<section_example_oechem_ringsubset>`
      * Example program :ref:`ExtractScaffold.java<section_example_oechem_extractscaffold>`

  .. oe:language:: csharp

      * Example program :ref:`RingSubset.cs<section_example_oechem_ringsubset>`
      * Example program :ref:`ExtractScaffold.cs<section_example_oechem_extractscaffold>`


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsOxygen, IsOxygen

.. _OEChem_OEIsOxygen:

.. oe:class:: OEIsOxygen

   .. oe:api::

      struct OEIsOxygen : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsOxygen <OEChem_OEIsOxygen>` functor that
   identifies oxygen atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsOxygen`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsOxygen

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsOxygen <OEChem_OEIsOxygen>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsPhosphorus, IsPhosphorus

.. _OEChem_OEIsPhosphorus:

.. oe:class:: OEIsPhosphorus

   .. oe:api::

      struct OEIsPhosphorus : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsPhosphorus <OEChem_OEIsPhosphorus>` functor that
   identifies phosphorus atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsPhosphorus`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsPhosphorus

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsPhosphorus <OEChem_OEIsPhosphorus>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsPolar, IsPolar

.. _OEChem_OEIsPolar:

.. oe:class:: OEIsPolar

   .. oe:api::

      struct OEIsPolar : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsPolar <OEChem_OEIsPolar>` functor that
   identifies polar atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsPolar`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsPolar

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsPolar <OEChem_OEIsPolar>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsPolarHydrogen, IsPolarHydrogen

.. _OEChem_OEIsPolarHydrogen:

.. oe:class:: OEIsPolarHydrogen

   .. oe:api::

      struct OEIsPolarHydrogen : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents `OEIsPolarHydrogen`.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsPolarHydrogen



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsProductGroup, IsProductGroup

.. _OEChem_OEIsProductGroup:

.. oe:class:: OEIsProductGroup

   .. oe:api::

      class  OEIsProductGroup : public OESystem::OEUnaryPredicate<OEGroupBase>

   This class represents the :ref:`OEIsProductGroup <OEChem_OEIsProductGroup>` functor that
   identifies groups (:ref:`OEGroupBase <OEChem_OEGroupBase>`) that represent
   reaction component information which contain at least one atom
   identified by :oe:meth:`OEChem::OEAtomBase::GetRxnRole` as being
   a :oe:const:`OEChem::OERxnRole::Product` atom.

   .. seealso::

      * :oe:constns:`OEChem::OEGroupType` for built-in group types.
      * :oe:constns:`OEChem::OERxnRole` for reaction role types.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. ################################################################
      #
      ################################################################
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsProductGroup()

      .. oe:language:: python

         .. oe:api:: python

            OEIsProductGroup() -> OEIsProductGroup

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEGroupBase& group) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(group: OEGroupBase) -> bool

      Returns ``true``, if the value returned by the
      :oe:meth:`OEChem::OEGroupBase::GetGroupType` method is equal
      to the following constant:

      * :oe:const:`OEChem::OEGroupType::Component`

      and which contain one or more atoms identified as products.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEGroupBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryGroupBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsProductGroup <OEChem_OEIsProductGroup>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsRGroup, IsRGroup

.. _OEChem_OEIsRGroup:

.. oe:class:: OEIsRGroup

   .. oe:api::

      class OEIsRGroup : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsRGroup <OEChem_OEIsRGroup>` functor that
   identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with any or
   a specific R-group.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsRGroup(unsigned int idx = 0)

      .. oe:language:: python

         .. oe:api:: python

            OEIsRGroup(idx: int = 0) -> OEIsRGroup

      Constructs the functor with the internal R-group index.
      With no arguments, this constructs a functor which returns ``true``
      for any atom with a non-zero R-group index. When constructed with a
      non-zero integer, it constructs a functor which return ``true`` for
      atoms which have the same R-group index as the constructor argument.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>` == 0 
      and the index returned by the 
      :oe:meth:`OEChem::OEAtomBase::GetMapIdx` method for the given
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object is equivalent to the non-zero index
      number with which the functor is constructed.

      Returns ``true``, if the :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>` == 0 
      and the index returned by the 
      :oe:meth:`OEChem::OEAtomBase::GetMapIdx` method for the given
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object is non-zero when the index
      number with which the functor is constructed is ``0``.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsRGroup

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsRGroup <OEChem_OEIsRGroup>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsReactantGroup, IsReactantGroup

.. _OEChem_OEIsReactantGroup:

.. oe:class:: OEIsReactantGroup

   .. oe:api::

      class  OEIsReactantGroup : public OESystem::OEUnaryPredicate<OEGroupBase>

   This class represents the :ref:`OEIsReactantGroup <OEChem_OEIsReactantGroup>` functor that
   identifies groups (:ref:`OEGroupBase <OEChem_OEGroupBase>`) that represent
   reaction component information which contain at least one atom
   identified by :oe:meth:`OEChem::OEAtomBase::GetRxnRole` as being
   a :oe:const:`OEChem::OERxnRole::Reactant` atom.

   .. seealso::

      * :oe:constns:`OEChem::OEGroupType` for built-in group types.
      * :oe:constns:`OEChem::OERxnRole` for reaction role types.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. ################################################################
      #
      ################################################################
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsReactantGroup()

      .. oe:language:: python

         .. oe:api:: python

            OEIsReactantGroup() -> OEIsReactantGroup

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEGroupBase& group) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(group: OEGroupBase) -> bool

      Returns ``true``, if the value returned by the
      :oe:meth:`OEChem::OEGroupBase::GetGroupType` method is equal
      to the following constant:

      * :oe:const:`OEChem::OEGroupType::Component`

      and which contain one or more atoms identified as reactants.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEGroupBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryGroupBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsReactantGroup <OEChem_OEIsReactantGroup>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsRotor, IsRotor

.. _OEChem_OEIsRotor:

.. oe:class:: OEIsRotor

   .. oe:api::

      class OEIsRotor : public OESystem::OEUnaryPredicate<OEChem::OEBondBase>

   This class represents :ref:`OEIsRotor <OEChem_OEIsRotor>` functor that
   identifies rotatable bonds (:ref:`OEBondBase <OEChem_OEBondBase>`).

   .. seealso::

      * :term:`rotatable bond`
      * :oe:func:`OEMolProp::OEGetRotatableBondCount` function in **OEMolProp TK**

      .. oe:language:: c++

         * Example programs :ref:`molstats.cpp<section_example_oechem_molstats>` and :ref:`rotorcount.cpp<section_example_oechem_rotorcount>`

      .. oe:language:: python

         * Example programs :ref:`molstats.py<section_example_oechem_molstats>` and :ref:`rotorcount.py<section_example_oechem_rotorcount>`

      .. oe:language:: java

         * Example programs :ref:`MolStats.java<section_example_oechem_molstats>` and :ref:`RotorCount.java<section_example_oechem_rotorcount>`

      .. oe:language:: csharp

         * Example programs :ref:`MolStats.cs<section_example_oechem_molstats>` and :ref:`RotorCount.cs<section_example_oechem_rotorcount>`

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsRotor(bool includeHydrogen = false)

      .. oe:language:: python

         .. oe:api:: python

            OEIsRotor(includeHydrogen: bool = False) -> OEIsRotor

      Default and copy constructors.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEBondBase::IsRotor`
      method returns ``true`` for the given
      :ref:`OEBondBase <OEChem_OEBondBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEBondBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsRotor

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsRotor <OEChem_OEIsRotor>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsRxnComponentGroup, IsRxnComponentGroup

.. _OEChem_OEIsRxnComponentGroup:

.. oe:class:: OEIsRxnComponentGroup

   .. oe:api::

      class  OEIsRxnComponentGroup : public OESystem::OEUnaryPredicate<OEGroupBase>

   This class represents the :ref:`OEIsRxnComponentGroup <OEChem_OEIsRxnComponentGroup>` functor that
   identifies groups (:ref:`OEGroupBase <OEChem_OEGroupBase>`) that represent
   reaction component information which contain at least one atom
   identified by :oe:meth:`OEChem::OEAtomBase::GetRxnRole` as being any of:

      * :oe:const:`OEChem::OERxnRole::Reactant`
      * :oe:const:`OEChem::OERxnRole::Agent`
      * :oe:const:`OEChem::OERxnRole::Catalyst`
      * :oe:const:`OEChem::OERxnRole::Product`

   .. seealso::

      * :oe:constns:`OEChem::OEGroupType` for built-in group types.
      * :oe:constns:`OEChem::OERxnRole` for reaction role types.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. ################################################################
      #
      ################################################################
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsRxnComponentGroup()

      .. oe:language:: python

         .. oe:api:: python

            OEIsRxnComponentGroup() -> OEIsRxnComponentGroup

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEGroupBase& group) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(group: OEGroupBase) -> bool

      Returns ``true``, if the value returned by the
      :oe:meth:`OEChem::OEGroupBase::GetGroupType` method is equal
      to the following constant:

      * :oe:const:`OEChem::OEGroupType::Component`

      and which contain one or more atoms identified as either a reactant or product.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEGroupBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryGroupBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsRxnComponentGroup <OEChem_OEIsRxnComponentGroup>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsSulfur, IsSulfur

.. _OEChem_OEIsSulfur:

.. oe:class:: OEIsSulfur

   .. oe:api::

      struct OEIsSulfur : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsSulfur <OEChem_OEIsSulfur>` functor that
   identifies sulfur atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsSulfur`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsSulfur

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsSulfur <OEChem_OEIsSulfur>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsTermHeavyAtom, IsTermHeavyAtom

.. _OEChem_OEIsTermHeavyAtom:

.. oe:class:: OEIsTermHeavyAtom

   .. oe:api::

      struct OEIsTermHeavyAtom : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsTermHeavyAtom <OEChem_OEIsTermHeavyAtom>` functor that
   identifies terminal heavy atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEIsHeavy`
      method returns ``true`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object and the atom is a terminal atom in the molecule.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsTermHeavyAtom

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsTermHeavyAtom <OEChem_OEIsTermHeavyAtom>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsValidAtomValence

.. _OEChem_OEIsValidAtomValence:

.. oe:class:: OEIsValidAtomValence

   .. oe:api::

      class OEIsValidAtomValence : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsValidAtomValence <OEChem_OEIsValidAtomValence>` functor that
   identifies valid atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) by the **OpenEye valence model**.

   .. seealso::

      * section :ref:`section_valence_openeye`
      * :oe:func:`OEChem::OECheckAtomValence` function
      * :oe:func:`OEChem::OECheckAtomValences` function
      * :ref:`OEIsValidMDLAtomValence <OEChem_OEIsValidMDLAtomValence>` functor for **MDL valence model**

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:func:`OEChem::OECheckAtomValences`
      function returns ``true`` for the given
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsValidAtomValence

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsValidAtomValence <OEChem_OEIsValidAtomValence>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsValidMDLAtomValence

.. _OEChem_OEIsValidMDLAtomValence:

.. oe:class:: OEIsValidMDLAtomValence

   .. oe:api::

      class OEIsValidMDLAtomValence : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OEIsValidMDLAtomValence <OEChem_OEIsValidMDLAtomValence>` functor that
   identifies valid atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) by the **MDL valence model**.

   .. seealso:: 

      * section :ref:`section_valence_mdl`
      * :oe:func:`OEChem::OEDefaultMDLHCount` function
      * :oe:func:`OEChem::OEAssignMDLHydrogens` function
      * :oe:func:`OEChem::OEMDLGetValence` function
      * :oe:cls:`OEChem::OEIsValidAtomValence` functor for **OpenEye valence model**

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true`` if the given :ref:`OEAtomBase <OEChem_OEAtomBase>` object is
      determined to be valid by MDL valence conventions.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsValidMDLAtomValence

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsValidMDLAtomValence <OEChem_OEIsValidMDLAtomValence>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsomericConfTest, IsomericConfTest

.. _OEChem_OEIsomericConfTest:

.. oe:class:: OEIsomericConfTest

   .. oe:api::

      class OEIsomericConfTest : public OEConfTestBase

   This class represents `OEIsomericConfTest`.

   This implementation of :ref:`OEConfTestBase <OEChem_OEConfTestBase>` combines
   subsequent connection tables into a multi-conformer molecule if
   they:

   1. Have the same numbers of atoms and bonds in the same order
   2. Each atom and bond must have identical properties with its order 
      correspondent in the subsequent connection table
   3. Have the same atom and bond stereochemistry
   4. Have the same title (optional)

   :ref:`OEIsomericConfTest <OEChem_OEIsomericConfTest>` shouldn't be used for reading
   multi-conformer molecules in PDB or XYZ file format. These file
   formats typically require the use of
   :oe:func:`OEChem::OEDetermineConnectivity` (and
   :oe:func:`OEChem::OEPerceiveBondOrders`) which may potentially
   perceive and create bonds in different orders (or arbitrarily
   assign bond orders and Kekulé forms differently) for different
   conformers of the same molecule. This disrupts the ordering (and
   property) constraints described above. Generally, file formats
   other than PDB and XYZ should be used for storing multi-conformer
   molecules (as consecutive connection tables), but if unavoidable,
   the :ref:`OEAbsCanonicalConfTest <OEChem_OEAbsCanonicalConfTest>` class should be used
   instead.

   The following methods are publicly inherited from :ref:`OEConfTestBase <OEChem_OEConfTestBase>`:

   =========================================================== =========================================================== ==========================================================
   :oe:meth:`CombineMols<OEChem::OEConfTestBase::CombineMols>` :oe:meth:`CompareMols<OEChem::OEConfTestBase::CompareMols>` :oe:meth:`CreateCopy<OEChem::OEConfTestBase::CreateCopy>` 
   =========================================================== =========================================================== ==========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsomericConfTest(bool compTitles = true)

      .. oe:language:: python

         .. oe:api:: python

            OEIsomericConfTest(compTitles: bool = True) -> OEIsomericConfTest

      Constructs an  :ref:`OEIsomericConfTest <OEChem_OEIsomericConfTest>`
      object. The argument 'compTitle' specifies whether to compare
      molecule titles (accessed by
      :oe:meth:`OEChem::OEMolBase::GetTitle`).  If the constructor is
      called with no arguments or with the argument ``true``, molecule
      titles will be required to be the same. Otherwise, the titles
      will not be compared. In the latter instance, each conformer
      will have the individual title of its original connection table
      and the multi-conformer molecule will reflect the title of the
      active conformer.

   .. oe:method:: CombineMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CombineMols(OEMCMolBase& m1, OEMolBase& m2)

      .. oe:language:: python

         .. oe:api:: python

            CombineMols(m1: OEMol, m2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   .. oe:method:: CompareMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CompareMols(OEMolBase& m1, OEMolBase& m2) const

      .. oe:language:: python

         .. oe:api:: python

            CompareMols(m1: Union[OEGraphMol,OEMol,OEQMol],
                        m2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Returns whether the two :ref:`OEMolBase <OEChem_OEMolBase>` objects
      are the same by checking the four conditions listed at the top.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfTestBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEConfTestBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsomericConfTest <OEChem_OEIsomericConfTest>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OELibraryGen, LibraryGen

.. _OEChem_OELibraryGen:

.. oe:class:: OELibraryGen

   .. oe:api::

      class OELibraryGen

   This class represents :ref:`OELibraryGen <OEChem_OELibraryGen>` that is designed to perform
   library generation.

   .. seealso::

      * :ref:`chapter_reactions` chapter
      * :term:`SMIRKS`
      * :ref:`section_example_oechem_libgen` example
      * :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELibraryGen()

      .. oe:language:: python

         .. oe:api:: python

            OELibraryGen() -> OELibraryGen

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELibraryGen(const OELibraryGen& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OELibraryGen(rhs: OELibraryGen) -> OELibraryGen

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELibraryGen(const char * smirks, bool strictSmirks = true)

      .. oe:language:: python

         .. oe:api:: python

            OELibraryGen(arg2: str, strictSmirks: bool = True) -> OELibraryGen

      Creates a :ref:`OELibraryGen <OEChem_OELibraryGen>` object with the given :term:`SMIRKS`
      reaction.
      Success of initialization can be tested using the operator
      :oe:meth:`OEChem::OELibraryGen::operator bool` method.

      Passing a value of ``false`` to the second method argument will relax
      the strict SMIRKS restrictions.
      A mapped reactant atom that does not have a corresponding mapped
      product atom is valid, and will be destroyed as part of the
      reaction.
      Unmapped reactant atoms will be used to match the reactant
      pattern, but are not destroyed when the reaction is applied.
      The resulting SMIRKS like reactions may therefore be more easily
      readable by humans as fewer atoms may be required to be mapped.

      Atoms in the provided reaction must have unique mapping numbers, otherwise
      there is ambiguity as to the correspondence of reactant to product atoms.
      A duplicate mapping number warning message indicates that the SMIRKS must be
      corrected prior to use.

      *smirks*
         The string representing the reaction for library generation.

      *strictSmirks*
         The parameter that specifies the interpretation of the :term:`SMIRKS`
         semantics.

      .. seealso::

         * :oe:meth:`OEChem::OELibraryGen::Init` method
         * :term:`SMIRKS`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELibraryGen &operator=(const OELibraryGen &rhs)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEMolBase &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns ``true``, if the :ref:`OELibraryGen <OEChem_OELibraryGen>`
      object was initialized with no failures using either the
      constructors or one of the
      :oe:meth:`OEChem::OELibraryGen::Init` methods.

      The method will return ``false`` when the
      :ref:`OELibraryGen <OEChem_OELibraryGen>` object has not been properly
      initialized as it will be unable to apply transform operations
      to molecules.

   .. oe:method:: AddStartingMaterial

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int AddStartingMaterial(const OEMolBase& mol,
                                             unsigned int reacnum,
                                             bool umatch = true)
            unsigned int AddStartingMaterial(OESystem::OEIter<OEMolBase> &,
                                             unsigned int reacnum,
                                             bool umatch = true)
            unsigned int AddStartingMaterial(OESystem::OEIterBase<OEMolBase> *,
                                             unsigned int reacnum,
                                             bool umatch = true)

      .. oe:language:: python

         .. oe:api:: python

            AddStartingMaterial(mol: Union[OEGraphMol,OEMol,OEQMol],
                                reacnum: int, umatch: bool = True) -> int

      Initializes the starting materials corresponding to a reaction
      component.
      An iterator over molecules or a single molecule may be passed as
      the first argument to the overloaded methods.
      Subsequent calls to the
      :oe:meth:`OEChem::OELibraryGen::AddStartingMaterial` methods
      append to the list of starting materials set in prior calls.
      The second argument (``reacnum``) specifies the reactant to which
      the starting materials correspond.  The return value is the number of
      starting materials that were successfully added for the specified reaction component.

      A copy of the starting material molecules are stored internally
      with the atom maps from the reactant pattern.
      This is done for efficiency, as each product molecule requires
      very little computational work to be done because of the
      starting material preprocessing.

      The final argument (``umatch``) is used to control the pattern
      matching of the reactant pattern to the starting material.
      If the value passed is ``true``, only matches that contain a
      unique set of atoms relative to previously identified matches
      are used.
      If the value is ``false``, every possible match including those
      related by symmetry will be used. Reactant patterns are unique
      matched by default.

      .. seealso::

         * :oe:meth:`OEChem::OELibraryGen::ClearStartingMaterial` method
         * :oe:meth:`OEChem::OELibraryGen::SetStartingMaterial` method
         * :ref:`subsection_reactions_libgen_sm` section of the
           :ref:

   .. oe:method:: ClearStartingMaterial

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearStartingMaterial(unsigned reacnum)

      .. oe:language:: python

         .. oe:api:: python

            ClearStartingMaterial(reacnum: int) -> None

      Removes any starting materials previously set by either the
      :oe:meth:`OEChem::OELibraryGen::AddStartingMaterial` or the
      :oe:meth:`OEChem::OELibraryGen::SetStartingMaterial` methods
      corresponding to the reactant pattern number ('reacnum' ) passed
      as the argument to the method.

   .. oe:method:: GetAssignMapIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAssignMapIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetAssignMapIdx() -> bool

      .. seealso::

         * Corresponding :oe:meth:`OEChem::OELibraryGen::SetAssignMapIdx` setter method

   .. oe:method:: GetClearCoordinates

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetClearCoordinates() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearCoordinates() -> bool

      .. seealso::

         * Corresponding :oe:meth:`OEChem::OELibraryGen::SetClearCoordinates` setter method

   .. oe:method:: GetExplicitHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetExplicitHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetExplicitHydrogens() -> bool

      .. seealso::

         * Corresponding :oe:meth:`OEChem::OELibraryGen::SetExplicitHydrogens` setter method

   .. oe:method:: GetProducts

      .. oe:api::

         OESystem::OEIterBase<OEMolBase> *GetProducts() const

      Returns an iterator over all the products generated by the library
      generation.

   .. oe:method:: GetRemoveUnmappedFragments

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRemoveUnmappedFragments() const

      .. oe:language:: python

         .. oe:api:: python

            GetRemoveUnmappedFragments() -> bool

      .. seealso::

         * Corresponding :oe:meth:`OEChem::OELibraryGen::SetRemoveUnmappedFragments` setter method

   .. oe:method:: GetStartingMaterial

      .. oe:api::

         OESystem::OEIterBase<OEMolBase> *GetStartingMaterial(unsigned int rnum) const

      Returns an iterator over all the starting materials that have been successfully added to
      the :ref:`OELibraryGen <OEChem_OELibraryGen>` object.

      .. seealso::

         * :oe:meth:`OEChem::OELibraryGen::AddStartingMaterial` method
         * :oe:meth:`OEChem::OELibraryGen::SetStartingMaterial` method

   .. oe:method:: GetTitleSeparator

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetTitleSeparator() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitleSeparator() -> str

      .. seealso::

         * Corresponding :oe:meth:`OEChem::OELibraryGen::SetTitleSeparator` setter method

   .. oe:method:: GetValenceCorrection

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetValenceCorrection() const

      .. oe:language:: python

         .. oe:api:: python

            GetValenceCorrection() -> bool

      .. seealso::

         * Corresponding :oe:meth:`OEChem::OELibraryGen::SetValenceCorrection` setter method

   .. oe:method:: GetValidateKekule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetValidateKekule() const

      .. oe:language:: python

         .. oe:api:: python

            GetValidateKekule() -> bool

      .. seealso::

         * Corresponding :oe:meth:`OEChem::OELibraryGen::SetValidateKekule` setter method

   .. oe:method:: Init

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const OEQMolBase& mol, bool strictSmirks = true)
            bool Init(const char* smirks, bool strictSmirks = true)

      .. oe:language:: python

         .. oe:api:: python

            Init(arg2: OEQMol, strictSmirks: bool = True) -> bool
            Init(c: str, strictSmirks: bool = True) -> bool

      The first method initializes an :ref:`OELibraryGen <OEChem_OELibraryGen>`
      object with the :oe:cls:`OEQMolBase<OEChem::OEQMolBase>` object.
      The second method initializes an :ref:`OELibraryGen <OEChem_OELibraryGen>`
      object with the 'smirks' pattern.
      By default, the SMIRKS string is interpreted using strict semantics.

      Passing a value of ``false`` to the second method argument will relax
      the strict SMIRKS restrictions.
      A mapped reactant atom that does not have a corresponding mapped
      product atom is valid, and will be destroyed as part of the
      reaction.
      Unmapped reactant atoms will be used to match the reactant
      pattern, but are not destroyed when the reaction is applied.
      The resulting SMIRKS like reactions may therefore be more easily
      readable by humans as fewer atoms may be required to be mapped.

   .. oe:method:: NumReactants

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumReactants() const

      .. oe:language:: python

         .. oe:api:: python

            NumReactants() -> int

      Returns the number of separate reactants that the
      :ref:`OELibraryGen <OEChem_OELibraryGen>` object perceived during
      initialization.
      The value returned will be equal to the number of graphically
      disconnected reactants that are not grouped together using the
      :term:`SMIRKS` parts primitive.

   .. oe:method:: NumPossibleProducts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumPossibleProducts() const

      .. oe:language:: python

         .. oe:api:: python

            NumPossibleProducts() -> int

      Returns the number of all possible products generated by the
      library generation. A warning message will be thrown if the
      number possible combinations exceeds the :math:`2^{32}` limit.

   .. oe:method:: SetAssignMapIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAssignMapIdx(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAssignMapIdx(arg2: bool) -> bool

      Sets whether the atom mapping of the reaction is transferred to the
      product.
      The default setting is ``false`` i.e. no mapping will be transferred to
      the product.

      .. list-table:: **Example of assigning map indices**
         :header-rows: 1

         * - reaction
           - product

         * - .. image:: ../images/amide-map.*
                :width:  500pt
           - .. image:: ../images/amide-product-map.*
                :width:  230pt

   .. oe:method:: SetClearCoordinates

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetClearCoordinates(bool clearcoords)

      .. oe:language:: python

         .. oe:api:: python

            SetClearCoordinates(arg2: bool) -> bool

      Sets whether the coordinates of a molecule are cleared when the
      molecule is added to the library generation by calling the
      :oe:meth:`OEChem::OELibraryGen::AddStartingMaterial` or
      :oe:meth:`OEChem::OELibraryGen::SetStartingMaterial` methods.
      The default setting is ``false`` i.e. the coordinates will be kept.

      .. note::

         The :ref:`OELibraryGen <OEChem_OELibraryGen>` modifies the molecular
         graph of the reactant(s) to generate products.
         Generating valid 2D or 3D coordinates for the products is
         beyond the scope of the :ref:`OELibraryGen <OEChem_OELibraryGen>`
         class.

         It is recommended to either clear the coordinates by
         invoking the :oe:meth:`OEChem::OELibraryGen::SetClearCoordinates`
         method or regenerate the coordinates of the products afterwards.

   .. oe:method:: SetExplicitHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetExplicitHydrogens(bool explcitH)

      .. oe:language:: python

         .. oe:api:: python

            SetExplicitHydrogens(arg2: bool) -> bool

      Sets whether to add explicit hydrogens or suppress them when a
      starting material is added to the library.
      The default setting is ``true`` i.e. explicit hydrogens will be added.

      .. seealso::

         * :ref:`subsection_reactions_libgen_sm` section of the
           :ref:`chapter_reactions` chapter

   .. oe:method:: SetRemoveUnmappedFragments

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRemoveUnmappedFragments(bool remove)

      .. oe:language:: python

         .. oe:api:: python

            SetRemoveUnmappedFragments(arg2: bool) -> bool

      Sets whether unmapped components of the products are removed or kept
      prior to returning them by the :oe:meth:`OEChem::OELibraryGen::GetProducts`
      method.
      The default setting is ``false`` i.e. unmapped components will be kept.

      .. seealso::

         * :ref:`subsection_reactions_libgen_atommapping` section of the
           :ref:`chapter_reactions` chapter

   .. oe:method:: SetStartingMaterial

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int SetStartingMaterial(const OEMolBase& mol,
                                             unsigned int reacnum,
                                             bool umatch = true)
            unsigned int SetStartingMaterial(OESystem::OEIter<OEMolBase> &,
                                             unsigned int reacnum,
                                             bool umatch = true)
            unsigned int SetStartingMaterial(OESystem::OEIterBase<OEMolBase> *,
                                             unsigned int reacnum,
                                             bool umatch = true)

      .. oe:language:: python

         .. oe:api:: python

            SetStartingMaterial(mol: Union[OEGraphMol,OEMol,OEQMol],
                                reacnum: int, umatch: bool = True) -> int

      Initializes the starting materials corresponding to a reaction
      component.
      An iterator over molecules or a single molecule may be passed as
      the first argument to the overloaded methods.
      Subsequent calls to the
      :oe:meth:`OEChem::OELibraryGen::SetStartingMaterial` methods
      discard the list of starting materials set in prior calls.
      The second argument ('reacnum') specifies the reactant to which
      the starting materials correspond.

      A copy of the starting material molecules are stored internally
      with the atom maps from the reactant pattern.
      This is done for efficiency, as each product molecule requires
      very little computational work to be done because of the
      starting material preprocessing.

      The final argument ('umatch') is used to control the pattern
      matching of the reactant pattern to the starting material.
      If the value passed is ``true``, only matches that contain a
      unique set of atoms relative to previously identified matches
      are used.
      If the value is ``false``, every possible match including those
      related by symmetry will be used. Reactant patterns are unique
      matched by default.

      .. seealso::

         * :oe:meth:`OEChem::OELibraryGen::ClearStartingMaterial`
         * :oe:meth:`OEChem::OELibraryGen::AddStartingMaterial`
         * :ref:`subsection_reactions_libgen_sm` section of the
           :ref:`chapter_reactions` chapter

   .. oe:method:: SetTitleSeparator

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTitleSeparator(const char* c)

      .. oe:language:: python

         .. oe:api:: python

            SetTitleSeparator(c: str) -> bool

      Sets the separator or delimiter used by the
      :ref:`OELibraryGen <OEChem_OELibraryGen>` object to compose product molecule
      titles.
      Product molecule titles are created by concatenating reactant
      molecule titles separated by a title separator or delimiter.
      The default separator is the underscore character ``_``.

      .. note::

         The title separator must be set prior to calling
         :oe:meth:`OEChem::OELibraryGen::GetProducts`.
         Calling :oe:meth:`OEChem::OELibraryGen::SetTitleSeparator`
         after calling :oe:meth:`OEChem::OELibraryGen::GetProducts`
         will have no affect on the resultant product molecule titles.

      .. seealso::

         * :ref:`subsection_reactions_libgen_tracking` section of the
           :ref:`chapter_reactions` chapter

   .. oe:method:: SetValenceCorrection

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetValenceCorrection(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetValenceCorrection(arg2: bool) -> bool

      Sets whether valence correction is applied to the products prior to
      returning them by the :oe:meth:`OEChem::OELibraryGen::GetProducts`
      method.
      The default setting is ``false`` i.e. no valence correction will be performed.

      .. seealso::

         * :ref:`subsection_reactions_libgen_modes` section of the
           :ref:`chapter_reactions` chapter

   .. oe:method:: SetValidateKekule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetValidateKekule(bool validate)

      .. oe:language:: python

         .. oe:api:: python

            SetValidateKekule(arg2: bool) -> bool

      Sets whether the generated products are simply returned after a
      Kekulization attempt, or if the |Kekule| form is validated more
      rigorously. If the extra validation is enabled and an invalid
      |Kekule| form is identified, alternatives are tried by adding
      and removing implicit hydrogens from aromatic nitrogens to
      produce a valid |Kekule| form.  No further attempt is made to
      return the most reasonable or chemically sensible result.  By
      default, the extra |Kekule| validation is enabled.
      The default setting is ``true`` i.e.  |Kekule| form
      validation will be performed.

      .. seealso::

         * :ref:`subsection_reactions_libgen_kekule` section of the
           :ref:`chapter_reactions` chapter


.. oe:namespace:: OEChem

.. meta::
   :keywords: OELingoSim, LingoSim

.. _OEChem_OELingoSim:

.. oe:class:: OELingoSim

   .. oe:api::

      class OELingoSim

   This class represents `OELingoSim`.

   The :ref:`OELingoSim <OEChem_OELingoSim>` class provides a fast 2D molecular
   similarity method.
   The construction of an :ref:`OELingoSim <OEChem_OELingoSim>` object based on a
   single molecule or canonical string describing the molecule.
   Similarity between this original molecule and any
   subsequent molecule can then be rapidly calculated using another
   molecule or its canonical string.

   .. seealso::

      * :term:`LINGO`

      * [Grant-2006]_ 

      * [Vidal-2005]_   

      * [Vidal-2006]_

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELingoSim(const char* str = 0,
                       unsigned type = OELingoType::Default)
            OELingoSim(const std::string& str,
                       unsigned type = OELingoType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OELingoSim(str: str = None, type: int) -> OELingoSim

      Constructs a :ref:`OELingoSim <OEChem_OELingoSim>` object with a canonical string.
      The string API of :ref:`OELingoSim <OEChem_OELingoSim>` class allows use
      of any string in both construction and similarity testing
      (:oe:meth:`OEChem::OELingoSim::Similarity`).
      While :term:`canonical SMILES` or :term:`canonical isomeric
      SMILES` are the most common string to be used, there is
      absolutely no requirement to use these strings in generating
      lingos comparisons.
      Care must be taken, however, to make sure consistent string
      types are passed to the constructors and similarity functions!
      The set of valid types are defined in the
      :oe:constns:`OEChem::OELingoType` namespace.
 
      .. oe:language:: c++ java csharp

         .. oe:api::

            OELingoSim(const OEMolBase& mol,
                       unsigned type = OELingoType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OELingoSim(mol: Union[OEGraphMol,OEMol,OEQMol], type: int) -> OELingoSim

      Constructs a :ref:`OELingoSim <OEChem_OELingoSim>` object with a query
      molecule (:ref:`OEMolBase <OEChem_OEMolBase>`).
      Constructing an :ref:`OELingoSim <OEChem_OELingoSim>` object with a
      molecule provides less flexibility because the strings are
      generated inside the object and thus limited to a specific
      string type.
      The set of valid types are defined in the
      :oe:constns:`OEChem::OELingoType` namespace.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELingoSim(const OELingoSim& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OELingoSim(rhs: OELingoSim) -> OELingoSim

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELingoSim &operator=(const OELingoSim &rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OELingoSim <OEChem_OELingoSim>` object
      into the right-hand side :ref:`OELingoSim <OEChem_OELingoSim>` object.

      Assignment operator.

   .. oe:method:: GetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetType() const

      .. oe:language:: python

         .. oe:api:: python

            GetType() -> int

   .. oe:method:: Init

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Init(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      (Re)initialize the :ref:`OELingoSim <OEChem_OELingoSim>` object with a
      molecule.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const char* str)
            bool Init(const std::string& str)

      .. oe:language:: python

         .. oe:api:: python

            Init(str: str) -> bool

      (Re)initialize the :ref:`OELingoSim <OEChem_OELingoSim>` object with a
      string.

      .. note:: 
      
        The implementation type (:oe:constns:`OEChem::OELingoType`),
        set in the constructor, is unchanged by the
        :oe:meth:`OEChem::OELingoSim::Init` methods.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Tests for successful initialization of the
      :ref:`OELingoSim <OEChem_OELingoSim>` object.
      If initialization was attempted with an invalid molecule, a
      string shorter than four characters, or was default
      constructed it will not be valid. 
      Similarity of any object to an invalid
      :ref:`OELingoSim <OEChem_OELingoSim>` will always be ``0.0``.

   .. oe:method:: SetImpl
      :language: c++

      .. oe:api::

         void SetImpl(const OELingoSimImpl &impl)

   .. oe:method:: Similarity

      .. oe:language:: c++ java csharp

         .. oe:api::

            float Similarity(const char* str) const
            float Similarity(const OEMolBase& mol) const
            float Similarity(const std::string& cansmi) const

      .. oe:language:: python

         .. oe:api:: python

            Similarity(str: str) -> float
            Similarity(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

      Calculates the lingos similarity between the molecule or string
      used to create the :ref:`OELingoSim <OEChem_OELingoSim>` object and the
      molecule or string passed into the
      :oe:meth:`OEChem::OELingoSim::Similarity` function.

      The :ref:`OEMolBase <OEChem_OEMolBase>` version is provided for
      convenience, and is suitable for most uses, but is somewhat less
      efficient than comparing strings directly.

      .. note::

         In the string API of the :oe:meth:`OEChem::OELingoSim::Similarity`
         method, any string can be used (:term:`canonical SMILES`,
         :term:`canonical isomeric SMILES`, IUPAC name), but care
         must be taken to make sure consistent string types are passed to


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMCMolBase, MCMolBase

.. _OEChem_OEMCMolBase:

.. oe:class:: OEMCMolBase

   .. oe:api::

      class OEMCMolBase : public OEMolBase

   The :ref:`OEMCMolBase <OEChem_OEMCMolBase>` class provides the basic
   multi-conformer molecule in *OEChem*.  It is an abstract base class
   which defines the interface for multi-conformer molecule
   implementations. Coordinates can be stored in
   :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` (16-bit), ``float`` (32-bit),
   ``double`` (64-bit), or ``long double`` (>= 64-bit). The precision
   is determined by the constructor argument given to
   :ref:`OEMol <OEChem_OEMol>`, taken from the
   :oe:constns:`OEChem::OEMCMolType`
   namespace. :ref:`OEMCMolBase <OEChem_OEMCMolBase>` have an interface which
   allow access to conformers in a modal
   (:oe:meth:`OEChem::OEMCMolBase::GetActive`) or a non-modal manner
   (:oe:meth:`OEChem::OEMCMolBase::GetConfs`).

   The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>`:

   =========================================================== =========================================================== ============================================================
   :oe:meth:`operator=<OEChem::OEMolBase::operator=>`          :oe:meth:`GetDimension<OEChem::OEMolBase::GetDimension>`    :oe:meth:`NumBonds<OEChem::OEMolBase::NumBonds>`            
   :oe:meth:`operator bool<OEChem::OEMolBase::operator bool>`  :oe:meth:`GetEnergy<OEChem::OEMolBase::GetEnergy>`          :oe:meth:`NumGroups<OEChem::OEMolBase::NumGroups>`          
   :oe:meth:`Clear<OEChem::OEMolBase::Clear>`                  :oe:meth:`GetGroup<OEChem::OEMolBase::GetGroup>`            :oe:meth:`OrderAtoms<OEChem::OEMolBase::OrderAtoms>`        
   :oe:meth:`ClearCoords<OEChem::OEMolBase::ClearCoords>`      :oe:meth:`GetGroups<OEChem::OEMolBase::GetGroups>`          :oe:meth:`OrderBonds<OEChem::OEMolBase::OrderBonds>`        
   :oe:meth:`Compress<OEChem::OEMolBase::Compress>`            :oe:meth:`GetMaxAtomIdx<OEChem::OEMolBase::GetMaxAtomIdx>`  :oe:meth:`ResetPerceived<OEChem::OEMolBase::ResetPerceived>`
   :oe:meth:`Count<OEChem::OEMolBase::Count>`                  :oe:meth:`GetMaxBondIdx<OEChem::OEMolBase::GetMaxBondIdx>`  :oe:meth:`SetCoords<OEChem::OEMolBase::SetCoords>`          
   :oe:meth:`CreateCopy<OEChem::OEMolBase::CreateCopy>`        :oe:meth:`GetTitle<OEChem::OEMolBase::GetTitle>`            :oe:meth:`SetDimension<OEChem::OEMolBase::SetDimension>`    
   :oe:meth:`DeleteAtom<OEChem::OEMolBase::DeleteAtom>`        :oe:meth:`HasPerceived<OEChem::OEMolBase::HasPerceived>`    :oe:meth:`SetEnergy<OEChem::OEMolBase::SetEnergy>`          
   :oe:meth:`DeleteBond<OEChem::OEMolBase::DeleteBond>`        :oe:meth:`IsDataType<OEChem::OEMolBase::IsDataType>`        :oe:meth:`SetPerceived<OEChem::OEMolBase::SetPerceived>`    
   :oe:meth:`DeleteGroup<OEChem::OEMolBase::DeleteGroup>`      :oe:meth:`IsDeleted<OEChem::OEMolBase::IsDeleted>`          :oe:meth:`SetRxn<OEChem::OEMolBase::SetRxn>`                
   :oe:meth:`GetAtom<OEChem::OEMolBase::GetAtom>`              :oe:meth:`IsRxn<OEChem::OEMolBase::IsRxn>`                  :oe:meth:`SetTitle<OEChem::OEMolBase::SetTitle>`            
   :oe:meth:`GetAtoms<OEChem::OEMolBase::GetAtoms>`            :oe:meth:`NewAtom<OEChem::OEMolBase::NewAtom>`              :oe:meth:`Sweep<OEChem::OEMolBase::Sweep>`                  
   :oe:meth:`GetBond<OEChem::OEMolBase::GetBond>`              :oe:meth:`NewBond<OEChem::OEMolBase::NewBond>`              :oe:meth:`UnCompress<OEChem::OEMolBase::UnCompress>`        
   :oe:meth:`GetBonds<OEChem::OEMolBase::GetBonds>`            :oe:meth:`NewGroup<OEChem::OEMolBase::NewGroup>`            
   :oe:meth:`GetCoords<OEChem::OEMolBase::GetCoords>`          :oe:meth:`NumAtoms<OEChem::OEMolBase::NumAtoms>`            
   =========================================================== =========================================================== ============================================================

   .. oe:language:: java

      The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>` only in Java:

      ====================================================== ====================================================== =========================================================
      :oe:meth:`GetAtomList<OEChem::OEMolBase::GetAtomList>` :oe:meth:`GetBondList<OEChem::OEMolBase::GetBondList>` :oe:meth:`GetGroupList<OEChem::OEMolBase::GetGroupList>` 
      ====================================================== ====================================================== =========================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMCMolBase& operator=(const OEMolBase& rhs)
         OEMCMolBase& operator=(const OEConfBase& rhs)
         OEMCMolBase& operator=(const OEMCMolBase& rhs)

      Assignment operator of multi-conformer molecules via this abstract base
      class.

      Assignment operator.

   .. oe:method:: ClearBase

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearBase()=0

      .. oe:language:: python

         .. oe:api:: python

            ClearBase() -> None

      Clear the generic data from the :ref:`OEBase <OESystem_OEBase>` base
      class of this object. Equivalent to just calling
      :oe:meth:`OESystem::OEBase::Clear` without actually clearing away
      molecule data like atoms, bonds, and conformers.

   .. oe:method:: ClearMCMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearMCMol()=0

      .. oe:language:: python

         .. oe:api:: python

            ClearMCMol() -> None

      Clears molecule data like atoms, bonds, and conformers without
      clearing away the :ref:`OEBase <OESystem_OEBase>` generic data.

   .. oe:method:: ClearMolBase

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearMolBase()=0

      .. oe:language:: python

         .. oe:api:: python

            ClearMolBase() -> None

      Equivalent to calling :oe:meth:`OEChem::OEMolBase::Clear`. 

   .. oe:method:: DeleteConf

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteConf(OEConfBase *)=0

      .. oe:language:: python

         .. oe:api:: python

            DeleteConf(arg2: OEConfBase) -> bool

      Deletes the conformer which is passed in from the
      :ref:`OEMCMolBase <OEChem_OEMCMolBase>` object.

   .. oe:method:: DeleteConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DeleteConfs()=0

      .. oe:language:: python

         .. oe:api:: python

            DeleteConfs() -> None

      .. warning:: 

         :oe:meth:`OEChem::OEMCMolBase::DeleteConfs` leaves the
         :ref:`OEMCMolBase <OEChem_OEMCMolBase>` object in an unstable state.
         It should be used with care and followed shortly with a call
         to :oe:meth:`OEChem::OEMCMolBase::NewConf`.

      Deletes all of the conformers from the :ref:`OEMCMolBase <OEChem_OEMCMolBase>`
      object.
      This is a very useful function for creating a new transformed
      :ref:`OEMCMolBase <OEChem_OEMCMolBase>` from an untransformed molecule.

      .. seealso::

         :oe:src:`Listing 3<SNIPPET-FilterConfs>` code example in the
         :ref:`section_oemol_conformercreation` section

   .. oe:method:: GetActive

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfBase* GetActive() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetActive() -> OEConfBase

      Returns the currently active conformer of the
      :ref:`OEMCMolBase <OEChem_OEMCMolBase>` object.

      .. note::

         The :oe:meth:`OEChem::OEMCMolBase::GetActive` and
         :oe:meth:`OEChem::OEMCMolBase::SetActive` methods are often
         sufficient for accessing conformations in multi-conformer molecules.

      .. seealso::

         * :oe:meth:`OEChem::OEMCMolBase::PopActive` method
         * :oe:meth:`OEChem::OEMCMolBase::PushActive` methods
         * :oe:meth:`OEChem::OEMCMolBase::SetActive` method

   .. oe:method:: GetConf

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfBase* GetConf(const OESystem::OEUnaryPredicate<OEChem::OEConfBase>& pred) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetConf(arg2: OEUnaryConfPred) -> OEConfBase

      Returns the first conformer in the molecule for which the predicate passed
      in returns ``true``.

   .. oe:method:: GetConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEConfBase>* GetConfs() const = 0
            OESystem::OEIterBase<OEConfBase>* GetConfs(const OESystem::OEUnaryPredicate<OEChem::OEConfBase>& pred) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetConfs() -> OEConfIter
            GetConfs(arg2: OEUnaryConfPred) -> OEConfIter

      Returns an iterator over the conformers in the multi-conformer molecule.
      The return value of this function should always be assigned to an
      :ref:`OEIter <OESystem_OEIter>` object.
      The function which takes no arguments returns an iterator over all of the
      conformers. The function which takes a predicate returns an iterator which
      only contains conformers for which the predicate returns ``true``.

   .. oe:language:: java

      .. oe:method:: GetConfList

         .. oe:api:: java

            java.util.List<OEConfBase> GetConfList()

         Returns a List of conformers in order of creation.  Note that removing a conformer
         from the list will not remove it from the molecule.

   .. oe:method:: GetMaxConfIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxConfIdx() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetMaxConfIdx() -> int

      For performance reasons, conformer indices are not guaranteed to be contiguous.
      :oe:meth:`OEChem::OEMCMolBase::GetMaxConfIdx` returns a lower bound for the maximum conformer index
      i.e. all indices returned by :oe:meth:`OEChem::OEConfBase::GetIdx` of the
      multi-conformer molecule will be less than this value.
      The value returned by :oe:meth:`OEChem::OEMCMolBase::GetMaxConfIdx`
      is always at least as large as :oe:meth:`OEChem::OEMCMolBase::NumConfs`.

      This method is useful for allocating temporary external data structures
      that need to be indexed by conformer index, as returned by
      :oe:meth:`OEChem::OEConfBase::GetIdx`.

   .. oe:method:: GetMCMolTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetMCMolTitle() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetMCMolTitle() -> str

      Return the title for the parent molecule, don't fall back to a
      conformer title like :oe:meth:`OEChem::OEConfBase::GetTitle`.

   .. oe:method:: IsDeleted

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDeleted(OEConfBase *) const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsDeleted(arg2: OEConfBase) -> bool

      Returns whether the passed in conformer has already been deleted. 

      .. seealso::

         * :oe:meth:`OEChem::OEMolBase::IsDeleted` methods inherited
           from the :ref:`OEMolBase <OEChem_OEMolBase>` class

   .. oe:method:: NewConf

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfBase* NewConf()=0
            OEConfBase* NewConf(const OEPlatform::OEHalfFloat *)=0
            OEConfBase* NewConf(const float *)=0
            OEConfBase* NewConf(const double *)=0
            OEConfBase* NewConf(const long double *)=0
            OEConfBase* NewConf(const OEMolBase *)=0
            OEConfBase* NewConf(const OEConfBase *)=0
            OEConfBase* NewConf(const OEConfBase *, const OETrans &)=0
            OEConfBase* NewConf(const OEConfBase *, std::vector<OETorsion>& t)=0

      .. oe:language:: python

         .. oe:api:: python

            NewConf() -> OEConfBase
            NewConf(arg2: OEHalfFloat) -> OEConfBase
            NewConf(arg2: OEFloatArray) -> OEConfBase
            NewConf(arg2: OEDoubleArray) -> OEConfBase
            NewConf(arg2: Union[OEGraphMol,OEMol,OEQMol]) -> OEConfBase
            NewConf(arg2: OEConfBase) -> OEConfBase
            NewConf(arg2: OEConfBase, arg3: OETrans) -> OEConfBase
            NewConf(arg2: OEConfBase, t: List[OETorsion]) -> OEConfBase

      These methods generate a new conformer that is owned by the
      current :ref:`OEMCMolBase <OEChem_OEMCMolBase>`. Each of the methods will
      return a pointer to the newly created conformer. The
      :oe:meth:`OEChem::OEMCMolBase::NewConf` methods act as virtual
      constructors of the :ref:`OEConfBase <OEChem_OEConfBase>`
      objects. :oe:meth:`OEChem::OEMCMolBase::NewConf` constructs a
      conformer with its default constructor. ``NewConf(const
      OEMolBase *)`` and ``NewConf(const OEConfBase *)`` copy
      construct a new conformer with the coordinates from the object
      passed into the function. The objects passed in must have the
      same graph as the current :ref:`OEMCMolBase <OEChem_OEMCMolBase>`.
      ``NewConf`` that takes a :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>`,
      ``float``, ``double``, or ``long double`` pointer constructs a
      new conformer with the coordinates passed in as coords. The
      array must be of length
      :oe:meth:`GetMaxAtomIdx()<OEChem::OEMolBase::GetMaxAtomIdx>` ``*
      3``, and the coordinates for each atom in the new conformer
      should be the dimension values in the array starting at
      ``coords[atom->GetIdx() * 3]``.

      Passing a ``NULL`` to any of these methods will effectively do
      nothing and just return a ``NULL`` :ref:`OEConfBase <OEChem_OEConfBase>`
      pointer.

      .. warning::

         The dimension of the conformer will be set to ``0`` for the
         NewConf default constructor. The NewConf methods that create
         conformers from coordinates will set the dimension of the
         conformer to ``3``. The NewConf methods that copy construct
         will copy the dimension from the source.

   .. oe:method:: NumConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumConfs() const = 0

      .. oe:language:: python

         .. oe:api:: python

            NumConfs() -> int

      Returns the number of conformers contained in the
      :ref:`OEMCMolBase <OEChem_OEMCMolBase>` object.

   .. oe:method:: OrderConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool OrderConfs(const std::vector<OEConfBase*>& vc)=0

      .. oe:language:: python

         .. oe:api:: python

            OrderConfs(arg2: OEConfVector) -> bool

      Reorders the conformers in the molecule to the order specified
      in the vector argument. If the vector contains an incomplete
      list, the remaining conformers will come at the end. This
      function call changes the order in which the conformers are
      returned by :oe:meth:`OEChem::OEMCMolBase::GetConfs`, but does
      not change the conformer indices.

   .. oe:method:: PopActive

      .. oe:language:: c++ java csharp

         .. oe:api::

            void PopActive()=0

      .. oe:language:: python

         .. oe:api:: python

            PopActive() -> None

      The :oe:meth:`OEChem::OEMCMolBase::PopActive` method along with the
      :oe:meth:`OEChem::OEMCMolBase::PushActive` method allow to maintain
      a stack of active conformers.

      The :oe:meth:`OEChem::OEMCMolBase::PopActive` method removes the top active
      conformer from the active stack and makes the next highest conformer
      in the stack active.

      .. seealso::

         * :oe:meth:`OEChem::OEMCMolBase::GetActive` method
         * :oe:meth:`OEChem::OEMCMolBase::SetActive` method
         * :oe:meth:`OEChem::OEMCMolBase::PushActive` method

   .. oe:method:: PushActive

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool PushActive(OEConfBase *)=0

      .. oe:language:: python

         .. oe:api:: python

            PushActive(arg2: OEConfBase) -> bool

      The :oe:meth:`OEChem::OEMCMolBase::PushActive` method along with the
      :oe:meth:`OEChem::OEMCMolBase::PopActive` method allow to maintain
      a stack of active conformers.

      The :oe:meth:`OEChem::OEMCMolBase::PushActive` method makes the new conformer
      the active one and pushes the previous active conformer down the stack.

      .. seealso::

         * :oe:meth:`OEChem::OEMCMolBase::GetActive` method
         * :oe:meth:`OEChem::OEMCMolBase::SetActive` method
         * :oe:meth:`OEChem::OEMCMolBase::PopActive` method

   .. oe:method: ResetConf # ignoring because it's weird

      .. oe:api::

         bool ResetConf(OEConfBase *, const OEConfBase *)=0

   .. oe:method:: SetActive

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetActive(OEConfBase *)=0

      .. oe:language:: python

         .. oe:api:: python

            SetActive(arg2: OEConfBase) -> bool

      Makes the conformer passed in become the active conformer.
      The conformer passed in must already be a member of the
      :ref:`OEMCMolBase <OEChem_OEMCMolBase>` object.

      .. note::

         The :oe:meth:`OEChem::OEMCMolBase::GetActive` and
         :oe:meth:`OEChem::OEMCMolBase::SetActive` methods are often
         sufficient for accessing conformations in multi-conformer molecules.

      .. seealso::

         * :oe:meth:`OEChem::OEMCMolBase::GetActive` method
         * :oe:meth:`OEChem::OEMCMolBase::PopActive` method
         * :oe:meth:`OEChem::OEMCMolBase::PushActive` method

   .. oe:method:: SweepConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SweepConfs()=0

      .. oe:language:: python

         .. oe:api:: python

            SweepConfs() -> bool

      Cleans up unused memory and objects which may be associated with
      the conformers of the :ref:`OEMCMolBase <OEChem_OEMCMolBase>`. Renumber
      the conformer indices sequentially. This function invalidates
      the conformer indices of all conformers in a molecule. Note that
      this function doesn't guarantee that all conformer indices are
      sequential upon completion (some molecule implementations may
      treat :oe:meth:`OEChem::OEMolBase::Sweep` as a no-op).



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMCSFunc, MCSFunc

.. _OEChem_OEMCSFunc:

.. oe:class:: OEMCSFunc

   .. oe:api::

      class OEMCSFunc

   The :ref:`OEMCSFunc <OEChem_OEMCSFunc>` is an abstract base class that
   defines the API used for scoring subgraph matches.

   The scores generated by implementations of
   :ref:`OEMCSFunc <OEChem_OEMCSFunc>` influence the sorting and retention of
   maximum common subgraph matches generated by the
   :ref:`OEMCSSearch <OEChem_OEMCSSearch>` and the :ref:`OECliqueSearch <OEChem_OECliqueSearch>`
   classes.

   The following classes derive from this class:
    * :ref:`OEMCSMaxAtoms <OEChem_OEMCSMaxAtoms>`
    * :ref:`OEMCSMaxAtomsCompleteCycles <OEChem_OEMCSMaxAtomsCompleteCycles>`
    * :ref:`OEMCSMaxBonds <OEChem_OEMCSMaxBonds>`
    * :ref:`OEMCSMaxBondsCompleteCycles <OEChem_OEMCSMaxBondsCompleteCycles>`

   .. seealso::

      * :oe:meth:`OEChem::OEMCSSearch::SetMCSFunc` method
      * :oe:meth:`OEChem::OECliqueSearch::SetMCSFunc` method

   .. note::

      Custom implementation of :ref:`OEMCSFunc <OEChem_OEMCSFunc>` can be done by deriving
      from the :ref:`OEMCSFunc <OEChem_OEMCSFunc>` class and implementing all of the methods
      listed below.

   .. oe:source:: CustomMCSFunc.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-CUSTOM-MCSFUNC
      :caption:  Example of using custom scoring function

   .. oe:source:: CustomMCSFunc.py
      :language: python
      :noindent:
      :frag:     SNIPPET-CUSTOM-MCSFUNC
      :caption:  Example of using custom scoring function

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator()(const OEMolBase& pattern, const OEMolBase& target, OEAtomBase** amap, OEBondBase** bmap)=0

      .. oe:language:: python

         .. oe:api:: python

            __call__(pattern: Union[OEGraphMol,OEMol,OEQMol],
                     target: Union[OEGraphMol,OEMol,OEQMol], amap: OEAtomBase,
                     bmap: OEBondBase) -> float

      This method is called automatically by the
      :ref:`OEMCSSearch <OEChem_OEMCSSearch>` and :ref:`OECliqueSearch <OEChem_OECliqueSearch>`
      classes when a common subgraph of two molecules is identified.

      The 'pattern' (query) molecule and 'target' molecule currently
      being matched are passed as the first and second arguments to
      the function.
      The arrays of pointers to atoms ('amap') and bonds ('bmap') hold
      the atom and bond correspondences between the pattern and
      target.
      The arrays are the length of the maximum atom and bond indices
      of the pattern molecule.
      The indices of the atoms and bonds in the pattern molecule can
      be used to look up the corresponding atoms and bonds in the
      target molecule.
      Subgraphs may not include all pattern atoms. Array positions for
      unmatched atoms and bonds are assigned to the NULL pointer.

      The integer part of the floating point value returned by the
      method is used to determine maximal common subgraphs.

      All integer part scores which are smaller than the maximum
      computed value for any subgraph are discarded by
      :ref:`OEMCSSearch <OEChem_OEMCSSearch>`.
      In case of :ref:`OECliqueSearch <OEChem_OECliqueSearch>` the any subgraph are
      discarded that has a smaller scoring value than the maximum
      score minus the 'range' set by
      :oe:meth:`OEChem::OECliqueSearch::SetSaveRange`.

      The decimal part of the floating point value returned by the
      method is used to sort the matches found by
      :ref:`OEMCSSearch <OEChem_OEMCSSearch>` or :ref:`OECliqueSearch <OEChem_OECliqueSearch>`
      For example, by scoring matches using the function

      :math:`num.\ of\ mapped\ atoms + \frac{num.\ of\ mapped\ bonds}{100}`

      all matches which have the same number of subgraph atoms would
      be retained but the matches would be returned in order of
      decreasing number of bonds matched.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSFunc* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMCSFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEMCSFunc <OEChem_OEMCSFunc>` object
      is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMCSFuncParameter, MCSFuncParameter

..  _OEChem_OEMCSFuncParameter:

.. oe:class:: OEMCSFuncParameter

   .. oe:api::

      class OEMCSFuncParameter : public OESystem::OEMultiParameter<OEChem::OEMCSFunc>

   OEMCSFuncParameter represents a parameter that has a value of type
   :oe:cls:`OEChem::OEMCSFunc`.

   Following methods are publicly inherited from :oe:cls:`OESystem::OEParameter`:   
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :oe:cls:`OESystem::OEMultiParameter`:
    * :oe:meth:`AddLegalEntry<OESystem::OEMultiParameter::AddLegalEntry>` 
    * :oe:meth:`GetDefault<OESystem::OEMultiParameter::GetDefault>` and
      :oe:meth:`SetDefault<OESystem::OEMultiParameter::SetDefault>` 
    * :oe:meth:`GetSetting<OESystem::OEMultiParameter::GetSetting>`
    * :oe:meth:`GetValue<OESystem::OEMultiParameter::GetValue>` and
      :oe:meth:`SetValue<OESystem::OEMultiParameter::SetValue>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSFuncParameter()
            OEMCSFuncParameter(const std::string& name)
            OEMCSFuncParameter(const OEMCSFuncParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSFuncParameter(name: str) -> OEMCSFuncParameter
            OEMCSFuncParameter(arg2: OEMCSFuncParameter) -> OEMCSFuncParameter

      Default and copy constructors.

      Constructs an OEMCSFuncParameter instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMCSFuncParameter &operator=(const OEMCSFuncParameter &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMCSMaxAtoms, MCSMaxAtoms

.. _OEChem_OEMCSMaxAtoms:

.. oe:class:: OEMCSMaxAtoms

   .. oe:api::

      class OEMCSMaxAtoms : public OEMCSFunc

   This class represents `OEMCSMaxAtoms`.

   The :ref:`OEMCSMaxAtoms <OEChem_OEMCSMaxAtoms>` class is an implementation of
   :ref:`OEMCSFunc <OEChem_OEMCSFunc>` designed to order maximum common
   substructure matches by the maximum number of atoms included in the
   graph match. If two common structure matches having the same number
   of atoms, ties are split based on the number of bonds contained in
   the match.

   .. seealso::

      * :ref:`section_patternmatch_mcss_score` section
      * :oe:meth:`OEChem::OEMCSSearch::SetMCSFunc` method
      * :oe:meth:`OEChem::OECliqueSearch::SetMCSFunc` method

   The following methods are publicly inherited from :ref:`OEMCSFunc <OEChem_OEMCSFunc>`:

   ==================================================== ==================================================== ===================================================
   :oe:meth:`operator()<OEChem::OEMCSFunc::operator()>` :oe:meth:`CreateCopy<OEChem::OEMCSFunc::CreateCopy>`                                                    
   ==================================================== ==================================================== ===================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator()(const OEMolBase &, const OEMolBase &, OEAtomBase **, OEBondBase **)

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: Union[OEGraphMol,OEMol,OEQMol],
                     arg3: Union[OEGraphMol,OEMol,OEQMol], arg4: OEAtomBase,
                     arg5: OEBondBase) -> float

      This method is called by its parent :ref:`OEMCSSearch <OEChem_OEMCSSearch>`
      or :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object.
      The method is called with the pattern molecule, target molecule,
      and arrays and atoms and bonds containing the correspondences
      found for the a common structure match.
      The method computes a value based on the number of atoms and bonds
      in the common structure match which is used to determine the
      maximum common structure match.

      **Scoring function:** 

      :math:`num.\ of\ mapped\ atoms + \frac{num.\ of\ mapped\ bonds}{100}`

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSFunc * CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMCSFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEMCSMaxAtoms <OEChem_OEMCSMaxAtoms>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMCSMaxAtomsCompleteCycles, MCSMaxAtomsCompleteCycles

.. _OEChem_OEMCSMaxAtomsCompleteCycles:

.. oe:class:: OEMCSMaxAtomsCompleteCycles

   .. oe:api::

      class OEMCSMaxAtomsCompleteCycles : public OEMCSFunc

   This class represents `OEMCSMaxAtomsCompleteCycles`.

   The :ref:`OEMCSMaxAtomsCompleteCycles <OEChem_OEMCSMaxAtomsCompleteCycles>` class is an
   implementation of :ref:`OEMCSFunc <OEChem_OEMCSFunc>` designed to order
   maximum substructure matches by the maximum number of atoms
   included in the graph match, with a variable priority given to
   matches which contain complete cycles common to both pattern and
   target.

   .. seealso::

      * :ref:`section_patternmatch_mcss_score` section
      * :oe:meth:`OEChem::OEMCSSearch::SetMCSFunc` method
      * :oe:meth:`OEChem::OECliqueSearch::SetMCSFunc` method

   The following methods are publicly inherited from :ref:`OEMCSFunc <OEChem_OEMCSFunc>`:

   ==================================================== ==================================================== ===================================================
   :oe:meth:`operator()<OEChem::OEMCSFunc::operator()>` :oe:meth:`CreateCopy<OEChem::OEMCSFunc::CreateCopy>`                                                    
   ==================================================== ==================================================== ===================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSMaxAtomsCompleteCycles(double a = 1.0)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSMaxAtomsCompleteCycles(a: float = 1.0) -> OEMCSMaxAtomsCompleteCycles

      The constructor takes a 'penalty' argument, with a default value
      of ``1.0``.
      The penalty (or scaling) factor is used to subtract from the
      total score composed of matching atoms and bonds the number of
      pattern ring bonds that are not matches by a target bond 
      (see scoring function below).
      This has the affect of scoring matches more highly when pattern
      ring atoms are matched.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator()(const OEMolBase &, const OEMolBase &, OEAtomBase **, OEBondBase **)

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: Union[OEGraphMol,OEMol,OEQMol],
                     arg3: Union[OEGraphMol,OEMol,OEQMol], arg4: OEAtomBase,
                     arg5: OEBondBase) -> float

      This method is called by its parent :ref:`OEMCSSearch <OEChem_OEMCSSearch>`
      or :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object.
      The method is called with the pattern molecule, target molecule,
      and arrays and atoms and bonds containing the correspondences
      found for the a common structure match.
      The method computes a value based on the number of atoms and bonds
      in the common structure match which is used to determine the
      maximum common structure match.

      **Scoring function:** 

      :math:`num.\ of\ mapped\ atoms + \frac{num.\ of\ mapped\ bonds}{100} - penalty \times num.\ of\ unmapped\ cyclic\ query\ bonds`

      The default penalty for each unmapped cyclic query bond is ``1.0``.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSFunc * CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMCSFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEMCSMaxAtomsCompleteCycles <OEChem_OEMCSMaxAtomsCompleteCycles>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMCSMaxBonds, MCSMaxBonds

.. _OEChem_OEMCSMaxBonds:

.. oe:class:: OEMCSMaxBonds

   .. oe:api::

      class OEMCSMaxBonds : public OEMCSFunc

   This class represents `OEMCSMaxBonds`.

   The :ref:`OEMCSMaxBonds <OEChem_OEMCSMaxBonds>` class is an implementation of
   :ref:`OEMCSFunc <OEChem_OEMCSFunc>` designed to order maximum common
   substructure matches by the maximum number of bonds included in the
   graph match. If two common structure matches have the same number
   of bonds, ties are split based on the number of atoms contained in
   the match.

   .. seealso::

      * :ref:`section_patternmatch_mcss_score` section
      * :oe:meth:`OEChem::OEMCSSearch::SetMCSFunc` method
      * :oe:meth:`OEChem::OECliqueSearch::SetMCSFunc` method

   The following methods are publicly inherited from :ref:`OEMCSFunc <OEChem_OEMCSFunc>`:

   ==================================================== ==================================================== ===================================================
   :oe:meth:`operator()<OEChem::OEMCSFunc::operator()>` :oe:meth:`CreateCopy<OEChem::OEMCSFunc::CreateCopy>`                                                    
   ==================================================== ==================================================== ===================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator()(const OEMolBase &, const OEMolBase &, OEAtomBase **, OEBondBase **)

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: Union[OEGraphMol,OEMol,OEQMol],
                     arg3: Union[OEGraphMol,OEMol,OEQMol], arg4: OEAtomBase,
                     arg5: OEBondBase) -> float

      This method is called by its parent :ref:`OEMCSSearch <OEChem_OEMCSSearch>`
      or :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object.
      The method is called with the pattern molecule, target molecule,
      and arrays and atoms and bonds containing the correspondences
      found for the a common structure match.
      The method computes a value based on the number of atoms and
      bonds in the common structure match which is used to determine
      the maximum common structure match.

      **Scoring function:**

      :math:`num.\ of\ mapped\ bonds + \frac{num.\ of\ mapped\ atoms}{100}`

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSFunc * CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMCSFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEMCSMaxBonds <OEChem_OEMCSMaxBonds>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMCSMaxBondsCompleteCycles, MCSMaxBondsCompleteCycles

.. _OEChem_OEMCSMaxBondsCompleteCycles:

.. oe:class:: OEMCSMaxBondsCompleteCycles

   .. oe:api::

      class OEMCSMaxBondsCompleteCycles : public OEMCSFunc

   This class represents `OEMCSMaxBondsCompleteCycles`.

   The :ref:`OEMCSMaxBondsCompleteCycles <OEChem_OEMCSMaxBondsCompleteCycles>` class is an
   implementation of :ref:`OEMCSFunc <OEChem_OEMCSFunc>` designed to order
   maximum substructure matches by the maximum number of bonds
   included in the graph match, with a variable priority given to
   matches which contain complete cycles common to both pattern and
   target.

   .. seealso::

      * :ref:`section_patternmatch_mcss_score` section
      * :oe:meth:`OEChem::OEMCSSearch::SetMCSFunc` method
      * :oe:meth:`OEChem::OECliqueSearch::SetMCSFunc` method

   The following methods are publicly inherited from :ref:`OEMCSFunc <OEChem_OEMCSFunc>`:

   ==================================================== ==================================================== ===================================================
   :oe:meth:`operator()<OEChem::OEMCSFunc::operator()>` :oe:meth:`CreateCopy<OEChem::OEMCSFunc::CreateCopy>`                                                    
   ==================================================== ==================================================== ===================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSMaxBondsCompleteCycles(double a = 1.0)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSMaxBondsCompleteCycles(a: float = 1.0) -> OEMCSMaxBondsCompleteCycles

      The constructor takes a 'penalty' argument, with a default value
      of ``1.0``.
      The penalty (or scaling) factor is used to subtract from the
      total score composed of matching atoms and bonds the number of
      pattern ring bonds that are not matches by a target bond 
      (see scoring function below).
      This has the affect of scoring matches more highly when pattern
      ring bonds are matched.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator()(const OEMolBase &, const OEMolBase &, OEAtomBase **, OEBondBase **)

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: Union[OEGraphMol,OEMol,OEQMol],
                     arg3: Union[OEGraphMol,OEMol,OEQMol], arg4: OEAtomBase,
                     arg5: OEBondBase) -> float

      This method is called by its parent :ref:`OEMCSSearch <OEChem_OEMCSSearch>`
      or :ref:`OECliqueSearch <OEChem_OECliqueSearch>` object.
      The method is called with the pattern molecule, target molecule,
      and arrays and atoms and bonds containing the correspondences
      found for the a common structure match.
      The method computes a value based on the number of atoms and
      bonds in the common structure match which is used to determine
      the maximum common structure match.

      **Scoring function:**

      :math:`num.\ of\ mapped\ bonds + \frac{num.\ of\ mapped\ atoms}{100} - penalty \times  num.\ of\ unmapped\ cyclic\ query\ bonds`

      The default penalty for each unmapped cyclic query bond is ``1.0``.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSFunc * CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMCSFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEMCSMaxBondsCompleteCycles <OEChem_OEMCSMaxBondsCompleteCycles>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMCSSearch, MCSSearch

.. _OEChem_OEMCSSearch:

.. oe:class:: OEMCSSearch

   .. oe:api::

      class OEMCSSearch

   This class represents `OEMCSSearch`.

   This :ref:`OEMCSSearch <OEChem_OEMCSSearch>` class identifies a set of
   maximum substructures common to two molecules.

   .. seealso::

      .. oe:language:: c++

         * :ref:`section_patternmatch_mcss` section
         * Example program :ref:`mcs3dalign.cpp<section_example_oechem_mcs3dalign>`

      .. oe:language:: python

         * :ref:`section_patternmatch_mcss` section
         * Example program :ref:`mcs3dalign.py<section_example_oechem_mcs3dalign>`

      .. oe:language:: java

         * :ref:`section_patternmatch_mcss` section
         * Example program :ref:`MCS3DAlign.java<section_example_oechem_mcs3dalign>`

      .. oe:language:: csharp

         * :ref:`section_patternmatch_mcss` section
         * Example program :ref:`MCS3DAlign.cs<section_example_oechem_mcs3dalign>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSSearch(unsigned int type = OEMCSType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSSearch(type: int) -> OEMCSSearch

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSSearch(const OEMCSSearch& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSSearch(arg2: OEMCSSearch) -> OEMCSSearch

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSSearch(const char* smarts,
                        unsigned int type = OEMCSType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSSearch(arg2: str, type: int) -> OEMCSSearch

      Constructs an :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object using a 'smarts' pattern.
      The :term:`SMARTS` pattern is parsed into a query molecule
      (:ref:`OEQMolBase <OEChem_OEQMolBase>`).
      The valid types of the :ref:`OEMCSSearch <OEChem_OEMCSSearch>` are defined
      in the :oe:constns:`OEChem::OEMCSType` namespace.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSSearch(const OEQMolBase& qmol, bool perception = true,
                        unsigned int type = OEMCSType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSSearch(arg2: OEQMol, makeCopy: bool = True, type: int) -> OEMCSSearch

      Constructs an :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object using a query molecule
      (:ref:`OEQMolBase <OEChem_OEQMolBase>`).

      *qmol*
        The query molecule of the MCS search.

      *type*
        The type of the :ref:`OEMCSSearch <OEChem_OEMCSSearch>` from the
        :oe:constns:`OEChem::OEMCSType` namespace.

      *perception*
         If ``true``, then ring perception is performed on the query molecule.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSSearch(const OEMolBase &, unsigned int atomexpr,
                        unsigned int bondexpr,
                        unsigned int type = OEMCSType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSSearch(arg2: Union[OEGraphMol,OEMol,OEQMol], arg3: int,
                        arg4: int, type: int) -> OEMCSSearch

      Constructs an :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object using a molecule and expression options.
      The atom and bond expression options passed as the second and
      third arguments to the method are defined in the
      :oe:constns:`OEChem::OEExprOpts` namespace.
      The expression options are used to convert the atom and bond
      data into expression trees which are used during the common
      subgraph search.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMCSSearch &operator=(const OEMCSSearch &rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object
      into the right-hand side :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object.

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Test for successful initialization of an
      :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object.
      If initialization was attempted with an invalid :term:`SMARTS`
      pattern or query molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`) then
      this method will return ``false``.
      If initialization was completed successfully this method will
      return ``true``.
      An :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object is considered to be
      uninitialized when constructed with the default constructor.

   .. oe:method:: AddConstraint

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddConstraint(const OEMatchPair<OEBondBase> &)
            bool AddConstraint(const OEMatchPair<OEAtomBase> &)

      .. oe:language:: python

         .. oe:api:: python

            AddConstraint(arg2: OEMatchPairBond) -> bool
            AddConstraint(arg2: OEMatchPairAtom) -> bool

      The search space of a maximum common subgraph determination can
      be restricted by constraining pairs of nodes or edges (atoms or
      bonds) to be mapped onto one another in all subgraph solutions.
      All subgraph solutions will contain all constraints specified by
      this method.

      Both :oe:meth:`OEChem::OEMCSSearch::AddConstraint` methods return
      ``true`` if a constraint is added successfully.
      If the pattern atom or bond in the :ref:`OEMatchPair <OEChem_OEMatchPair>`
      does not exist as part of the query molecule created in the
      initialization of the :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object then
      :oe:meth:`OEChem::OEMCSSearch::AddConstraint` will return
      ``false``.

      Multiple calls to :oe:meth:`OEChem::OEMCSSearch::AddConstraint`
      using the same pattern atom or bond will return ``false`` as
      it is impossible to satisfy multiple simultaneous constraints
      for a single pattern atom or bond, hence the exclusivity.

   .. oe:method:: ClearConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearConstraints()

      .. oe:language:: python

         .. oe:api:: python

            ClearConstraints() -> None

      Clears all prior match constraints set with the
      :oe:meth:`OEChem::OEMCSSearch::AddConstraint` methods.

   .. oe:method:: GetMaxMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxMatches() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMatches() -> int

      Returns the maximum number of common subgraphs
      that the :ref:`OEMCSSearch <OEChem_OEMCSSearch>` will identify
      before terminating the search.
      A value of zero indicates that no arbitrary limit has been set
      on the total number of subgraphs to be identified.
      By default, the maximum number of matches is set to ``1024``
      This value can be set using the
      :oe:meth:`OEChem::OEMCSSearch::SetMaxMatches` method.

   .. oe:method:: GetMinAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMinAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinAtoms() -> int

      Returns the minimum number of atoms of a subgraph that
      can be returned as a maximum common subgraph.
      This value can be set using the
      :oe:meth:`OEChem::OEMCSSearch::SetMinAtoms` method.

   .. oe:method:: GetPattern

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEQMolBase& GetPattern() const

      .. oe:language:: python

         .. oe:api:: python

            GetPattern() -> OEQMol

      Returns a read-only reference to the query molecule
      (:ref:`OEQMolBase <OEChem_OEQMolBase>`) of :ref:`OEMCSSearch <OEChem_OEMCSSearch>`.
      Const :ref:`OEQMolBase <OEChem_OEQMolBase>` methods can be used on the
      returned :ref:`OEQMolBase <OEChem_OEQMolBase>` reference.
      If the :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object has not been
      initialized, a reference to an empty molecule will be returned.

   .. oe:method: GetSaveRange  IGNORE - OBSOLETE

      .. oe:api:

         unsigned int GetSaveRange() const

   .. oe:method:: Init

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const char* smarts)

      .. oe:language:: python

         .. oe:api:: python

            Init(arg2: str) -> bool

      (Re)initializes an :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object using a
      'smarts' pattern.
      The :term:`SMARTS` pattern is parsed to create a query molecule
      available for maximum common subgraph matching.
      The method will return ``true`` if initialization completes
      successfully, and ``false`` upon failure.

      .. note::

         Prior state information is cleared before initialization, and
         is lost even if the method fails to initialize properly.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const OEQMolBase& qmol, bool perception = true)

      .. oe:language:: python

         .. oe:api:: python

            Init(arg2: OEQMol, makeCopy: bool = True) -> bool

      (Re)initializes an :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object using a
      query molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`) reference.
      The method will return ``true`` if initialization completes
      successfully, and ``false`` upon failure.

      *qmol*
        The query molecule of the MCS search.

      *perception*
         If ``true``, then ring perception is performed on the query molecule.

      .. note::

         Prior state information is cleared before initialization, and
         is lost even if the method fails to initialize properly.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const OEMolBase& mol, unsigned int atomexpr,
                      unsigned int bondexpr)

      .. oe:language:: python

         .. oe:api:: python

            Init(arg2: Union[OEGraphMol,OEMol,OEQMol], arg3: int, arg4: int) -> bool

      (Re)initializes an :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object using a
      molecule and expression options that are used to convert the given
      molecule into a :ref:`OEQMolBase <OEChem_OEQMolBase>` query object.

      *mol*
        The *query* molecule of the maximum common substructure search.

      *atomexpr*
        This value has to be any combination of atom expressions of the
        :oe:constns:`OEChem::OEExprOpts` namespace.

      *bondexpr*
        This value has to be any combination of bond expressions of the
        :oe:constns:`OEChem::OEExprOpts` namespace.

      Expression options are used to convert the atom and bond data
      into expression trees which are used during the common subgraph
      search.
      The method will return ``true`` if initialization completes
      successfully, and ``false`` upon failure.

      .. note::

         Prior state information is cleared before initialization, and
         is lost even if the method fails to initialize properly.

      .. seealso::

         * :oe:constns:`OEChem::OEExprOpts` namespace

   .. oe:method:: Match

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMatchBase>* Match(const OEMolBase &,
                                                     bool uniquematch = false) const

      .. oe:language:: python

         .. oe:api:: python

            Match(arg2: Union[OEGraphMol,OEMol], umatch: bool = False) -> Iterable[OEMatchBase]

      Performs search in order to identify maximum common subgraphs
      shared between the passed :ref:`OEMolBase <OEChem_OEMolBase>` and the
      query molecule which the :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object was
      initialized.
      It returns an iterator pointer (:ref:`OEIterBase <OESystem_OEIterBase>`)
      over graph matches (:ref:`OEMatchBase <OEChem_OEMatchBase>`), and should be
      assigned to an :ref:`OEIter <OESystem_OEIter>` < :ref:`OEMatchBase <OEChem_OEMatchBase>` >
      in order to prevent memory leaks.

      If the 'uniquematch'  argument passed to the methods is ``true`` then
      only the unique matches will be returned  in the iterator over the matches.
      By definition, a match or subgraph is considered unique if it differs
      from all other subgraphs found previously by at least one atom or
      bond.
      Additionally, it is also considered unique if the query subgraph
      is mapped to a different part of the target
      (See example in the :ref:`section_patternmatch_mcss` section)

      .. oe:api: IGNORED - NOT IMPLEMENTED YET

         OESystem::OEIterBase<OEMatchBase> *Match(const OEQMolBase &,
                                                  bool umatch=false) const

   .. oe:method:: SetMCSFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMCSFunc(const OEChem::OEMCSFunc &)

      .. oe:language:: python

         .. oe:api:: python

            SetMCSFunc(arg2: OEMCSFunc) -> bool

      Stores a copy of the passed :ref:`OEMCSFunc <OEChem_OEMCSFunc>` functor
      in the :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object.
      The functor is then used to evaluate and order subgraphs found
      during a maximum common subgraph search.

      .. seealso::

         * :ref:`OEMCSFunc <OEChem_OEMCSFunc>`
         * :ref:`OEMCSMaxAtoms <OEChem_OEMCSMaxAtoms>`
         * :ref:`OEMCSMaxBonds <OEChem_OEMCSMaxBonds>`
         * :ref:`OEMCSMaxAtomsCompleteCycles <OEChem_OEMCSMaxAtomsCompleteCycles>`
         * :ref:`OEMCSMaxBondsCompleteCycles <OEChem_OEMCSMaxBondsCompleteCycles>`

   .. oe:method:: SetMaxMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxMatches(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxMatches(arg2: int) -> bool

      Sets the maximum number of maximum common subgraph matches that
      will be returned by the :oe:meth:`OEChem::OEMCSSearch::Match`
      method.

      .. note::

         The search for maximum common substructures will not terminate
         immediately upon reaching this limit.
         The maximum common subgraph cannot be known unless the MCS is
         composed of all atoms and bonds of at least one of the graphs
         being compared.
         The limit of subgraphs to be returned may be reached with a
         smaller subgraph than the maximum.
         In such a case the search continues for larger subgraphs until
         the search is exhausted.
         :oe:meth:`OEChem::OEMCSSearch::Match` will return the first
         :math:`N` maximum common subgraphs where :math:`N` is less than
         or equal to the maximum match limit.

      The default limit set upon construction of an
      :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object is ``1024`` matches.
      This value can be retrieved
      using the :oe:meth:`OEChem::OEMCSSearch::GetMaxMatches` method.

   .. oe:method:: SetMinAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMinAtoms(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMinAtoms(arg2: int) -> bool

      Sets the minimum number of atoms required of a subgraph match to
      be returned a solution by a MCS search.
      A single atom can be a perfectly valid maximum common subgraph,
      however, for many applications such a small subgraph may not be
      considered useful.
      Setting the minimum number of atoms to an appropriate size
      prevents unproductive subgraph matches from being returned by
      the :oe:meth:`OEChem::OEMCSSearch::Match` method.
      The default value for the minimum number of atoms in a subgraph
      match is set to ``1`` upon construction of an
      :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object.
      This value can be retrieved using the
      :oe:meth:`OEChem::OEMCSSearch::GetMinAtoms` method.

   .. oe:method: SetSaveRange IGNORE - OBSOLETE

      .. oe:api::

         bool SetSaveRange(unsigned int)

   .. oe:method: SingleMatch IGNORED - NOT IMPLEMENTED YET

      .. oe:api::

         bool SingleMatch(const OEMolBase &) const
         bool SingleMatch(const OEQMolBase &) const



.. oe:namespace:: OEChem

.. _OEChem_OEMMFFTypeResult:

.. oe:class:: OEMMFFTypeResult

   .. oe:api::

      class OEMMFFTypeResult

   Used by the :oe:func:`OEChem::OEMMFFAtomType` function to retrieve
   the MMFF94 type of an atom.

   The following table describes how the result should be interpreted:

   .. list-table::
      :widths: 100 50 150
      :header-rows: 1

      * - GetMMFFType()
        - GetFailed()
        - interpretation

      * - :oe:const:`OEChem::OEMMFFType::UNK`
        - true
        - MMFF atom type **can not** be identified

      * - *not* :oe:const:`OEChem::OEMMFFType::UNK`
        - true
        - an **alternative** MMFF atom type is identified

      * - *not* :oe:const:`OEChem::OEMMFFType::UNK`
        - false
        - MMFF atom type is identified **successfully**

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFTypeResult(unsigned int type, bool failed)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFTypeResult(type: int, failed: bool) -> OEMMFFTypeResult
            OEMMFFTypeResult(rhs: OEMMFFTypeResult) -> OEMMFFTypeResult

      Constructor

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMMFFTypeResult & operator=(const OEMMFFTypeResult & rhs)

      Assignment operator.

   .. oe:method:: GetFailed

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFailed() const

      .. oe:language:: python

         .. oe:api:: python

            GetFailed() -> bool

      Returns whether MMFF94 type can be assigned to an atom.

   .. oe:method:: GetMMFFType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMMFFType() const

      .. oe:language:: python

         .. oe:api:: python

            GetMMFFType() -> int

      Returns MMFF94 type from the :oe:constns:`OEChem::OEMMFFType`
      namespace.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMatch, Match

.. _OEChem_OEMatch:

.. oe:class:: OEMatch

   .. oe:api::

      class OEMatch : public OEMatchBase

   This class represents `OEMatch`.

   The :ref:`OEMatch <OEChem_OEMatch>` class is a concrete instance of the
   :ref:`OEMatchBase <OEChem_OEMatchBase>` abstract base class.
   The purpose of an :ref:`OEMatch <OEChem_OEMatch>` object is to represent a
   pairwise correspondence between atoms and/or bonds in two different
   molecules. The correspondences are normally generated as the result
   of graph matching operations such as subgraph isomorphism
   determination, maximal common subgraph search, or supergraph
   search.

   The following methods are publicly inherited from :ref:`OEMatchBase <OEChem_OEMatchBase>`:

   =============================================================== ================================================================ ===============================================================
   :oe:meth:`operator bool<OEChem::OEMatchBase::operator bool>`    :oe:meth:`GetBonds<OEChem::OEMatchBase::GetBonds>`               :oe:meth:`GetTargetBonds<OEChem::OEMatchBase::GetTargetBonds>` 
   :oe:meth:`Clear<OEChem::OEMatchBase::Clear>`                    :oe:meth:`GetPatternAtoms<OEChem::OEMatchBase::GetPatternAtoms>` :oe:meth:`IsValid<OEChem::OEMatchBase::IsValid>`               
   :oe:meth:`CreateCopy<OEChem::OEMatchBase::CreateCopy>`          :oe:meth:`GetPatternBonds<OEChem::OEMatchBase::GetPatternBonds>` :oe:meth:`NumAtoms<OEChem::OEMatchBase::NumAtoms>`             
   :oe:meth:`GetAtoms<OEChem::OEMatchBase::GetAtoms>`              :oe:meth:`GetTargetAtoms<OEChem::OEMatchBase::GetTargetAtoms>`   :oe:meth:`NumBonds<OEChem::OEMatchBase::NumBonds>`             
   =============================================================== ================================================================ ===============================================================

   The following methods are publicly inherited from :ref:`OERoleSet <OESystem_OERoleSet>`:

   ======================================================= ======================================================= =======================================================
   :oe:meth:`AddRole<OESystem::OERoleSet::AddRole>`        :oe:meth:`GetRoles<OESystem::OERoleSet::GetRoles>`                                                             
   :oe:meth:`ClearRoles<OESystem::OERoleSet::ClearRoles>`  :oe:meth:`HasRole<OESystem::OERoleSet::HasRole>`                                                               
   :oe:meth:`DeleteRole<OESystem::OERoleSet::DeleteRole>`  :oe:meth:`NumRoles<OESystem::OERoleSet::NumRoles>`                                                             
   ======================================================= ======================================================= =======================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatch()

      .. oe:language:: python

         .. oe:api:: python

            OEMatch() -> OEMatch

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatch(const OEMatch &)
            OEMatch(const OEMatchBase &)

      .. oe:language:: python

         .. oe:api:: python

            OEMatch(arg2: OEMatch) -> OEMatch
            OEMatch(arg2: OEMatchBase) -> OEMatch

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatch(const std::vector<OEMatchPair<OEAtomBase> > &)

      .. oe:language:: python

         .. oe:api:: python

            OEMatch(arg2: List[OEMatchPair[OEAtomBase]]) -> OEMatch

      Constructors an :ref:`OEMatch <OEChem_OEMatch>` object and initializes
      it by making a copy of the passed vector of
      :ref:`OEMatchPair <OEChem_OEMatchPair>` objects which contain atom to atom
      mappings.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatch(const std::vector<OEMatchPair<OEBondBase> > &)

      .. oe:language:: python

         .. oe:api:: python

            OEMatch(arg2: List[OEMatchPair[OEBondBase]]) -> OEMatch

      Constructors an :ref:`OEMatch <OEChem_OEMatch>` object and initializes
      it by making a copy of the passed vector of
      :ref:`OEMatchPair <OEChem_OEMatchPair>` objects which contain bond to bond
      mappings.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatch(const std::vector<OEMatchPair<OEAtomBase> > &,
                    const std::vector<OEMatchPair<OEBondBase> > &)

      .. oe:language:: python

         .. oe:api:: python

            OEMatch(arg2: List[OEMatchPair[OEAtomBase]],
                    arg3: List[OEMatchPair[OEBondBase]]) -> OEMatch

      Constructors an :ref:`OEMatch <OEChem_OEMatch>` object and initializes
      it by making a copy of the passed vectors of
      :ref:`OEMatchPair <OEChem_OEMatchPair>` objects which contain and atom to atom and
      bond to bond mappings.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatch(std::vector<OEMatchPair<OEAtomBase> > *,
                    std::vector<OEMatchPair<OEBondBase> > *)

      .. oe:language:: python

         .. oe:api:: python

            OEMatch(arg2: List[OEMatchPair[OEAtomBase]],
                    arg3: List[OEMatchPair[OEBondBase]]) -> OEMatch

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         const OEMatch &operator=(const OEMatch &rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OEMatch <OEChem_OEMatch>` object
      into the right-hand side :ref:`OEMatch <OEChem_OEMatch>` object.

      .. oe:api::

         const OEMatch &operator=(const OEMatchBase &rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OEMatchBase <OEChem_OEMatchBase>` object
      into the right-hand side :ref:`OEMatch <OEChem_OEMatch>` object.

   .. oe:method: operator new

      .. oe:api::

         void *operator new(size_t)
         void *operator new(size_t, void *here)

   .. oe:method: operator delete

      .. oe:api::

         void operator delete(void *ptr)
         void operator delete(void *ptr, size_t)

      Assignment operator.

   .. oe:method:: AddPair

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddPair(const OEBondBase *, const OEBondBase *)

      .. oe:language:: python

         .. oe:api:: python

            AddPair(arg2: OEBondBase, arg3: OEBondBase) -> bool

      Adds a pair of bonds (:ref:`OEBondBase <OEChem_OEBondBase>`) to the
      :ref:`OEMatch <OEChem_OEMatch>` object. Returns ``true`` if the bonds
      are successfully added. Returns ``false`` and throws a warning
      if the bonds being added do not belong to the same parent
      molecule as previously added bonds.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddPair(const OEAtomBase *, const OEAtomBase *)

      .. oe:language:: python

         .. oe:api:: python

            AddPair(arg2: OEAtomBase, arg3: OEAtomBase) -> bool

      Adds a pair of atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) to the
      :ref:`OEMatch <OEChem_OEMatch>` object. Returns ``true`` if the atoms
      are successfully added. Returns ``false`` and throws a warning
      if the atoms being added do not belong to the same parent
      molecule as previously added atoms.

   .. seealso::

      .. oe:language:: c++

         * Example program :ref:`smartsalign.cpp<section_example_oechem_smartsalign>`

      .. oe:language:: python

         * Example program :ref:`smartsalign.py<section_example_oechem_smartsalign>`

      .. oe:language:: java

         * Example program :ref:`SMARTSAlign.java<section_example_oechem_smartsalign>`

      .. oe:language:: csharp

         * Example program :ref:`SMARTSAlign.cs<section_example_oechem_smartsalign>`

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Removes all atom and bond of pairs from the
      :oe:cls:`OEMatch<OEChem::OEMatch>` and clears the :ref:`OERoleSet <OESystem_OERoleSet>`.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEMatchBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMatchBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned object derived from :ref:`OEMatchBase <OEChem_OEMatchBase>`
      is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: GetAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMatchPair<OEAtomBase> >* GetAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> Iterable[OEMatchPair[OEAtomBase]]

      Returns an iterator over
      :oe:cls:`OEChem::OEMatchPairs<OEChem::OEMatchPair>` which contain
      the atom to atom correspondences in the
      :ref:`OEMatchBase <OEChem_OEMatchBase>` object.
      The returned :ref:`OEIterBase <OESystem_OEIterBase>` pointer should be
      assigned to an :ref:`OEIter <OESystem_OEIter>` object to prevent
      memory leaks.

   .. oe:method:: GetBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMatchPair<OEBondBase> >* GetBonds() const

      .. oe:language:: python

         .. oe:api:: python

            GetBonds() -> Iterable[OEMatchPair[OEBondBase]]

      Returns an iterator over
      :oe:cls:`OEChem::OEMatchPairs<OEChem::OEMatchPair>` which contain
      the bond to bond correspondences in the
      :ref:`OEMatchBase <OEChem_OEMatchBase>` object.
      The returned :ref:`OEIterBase <OESystem_OEIterBase>` pointer should be
      assigned to an :ref:`OEIter <OESystem_OEIter>` object to prevent
      memory leaks.

   .. oe:method:: NumAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            NumAtoms() -> int

      Returns the number of atom equivalences in the
      :ref:`OEMatch <OEChem_OEMatch>` object.

   .. oe:method:: NumBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumBonds() const

      .. oe:language:: python

         .. oe:api:: python

            NumBonds() -> int

      Returns the number of bond equivalences in the
      :ref:`OEMatch <OEChem_OEMatch>` object.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMatchBase, MatchBase

.. _OEChem_OEMatchBase:

.. oe:class:: OEMatchBase

   .. oe:api::

      class OEMatchBase : public OESystem::OERoleSet

   The :ref:`OEMatchBase <OEChem_OEMatchBase>` class is the abstract interface
   for representing the equivalences or correspondences found in a
   substructure (or similar) match.
   The :ref:`OEMatchBase <OEChem_OEMatchBase>` class can represent substructure
   hits, maximal common subgraph fragments, tautomer equivalences,
   automorphisms and sequence alignments.

   The following methods are publicly inherited from :ref:`OERoleSet <OESystem_OERoleSet>`:

   ======================================================= ======================================================= =======================================================
   :oe:meth:`AddRole<OESystem::OERoleSet::AddRole>`        :oe:meth:`GetRoles<OESystem::OERoleSet::GetRoles>`                                                             
   :oe:meth:`ClearRoles<OESystem::OERoleSet::ClearRoles>`  :oe:meth:`HasRole<OESystem::OERoleSet::HasRole>`                                                               
   :oe:meth:`DeleteRole<OESystem::OERoleSet::DeleteRole>`  :oe:meth:`NumRoles<OESystem::OERoleSet::NumRoles>`                                                             
   ======================================================= ======================================================= =======================================================

   The following classes derive from this class:
    * :ref:`OEMatch <OEChem_OEMatch>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMatchBase & operator=(const OEMatchBase & rhs)

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Same as the :oe:meth:`OEChem::OEMatchBase::IsValid` method.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()=0

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Removes all atom and bond of pairs from any object derived from
      :ref:`OEMatchBase <OEChem_OEMatchBase>` and clears the :ref:`OERoleSet <OESystem_OERoleSet>`.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatchBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMatchBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned object derived from
      :oe:cls:`OEMatchBase<OEChem::OEMatchBase>`
      is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: GetAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMatchPair<OEAtomBase> >* GetAtoms() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> Iterable[OEMatchPair[OEAtomBase]]

      Returns an iterator over
      :oe:cls:`OEChem::OEMatchPairs<OEChem::OEMatchPair>` which contain
      the atom to atom correspondences in the
      :ref:`OEMatchBase <OEChem_OEMatchBase>` object.
      The returned :ref:`OEIterBase <OESystem_OEIterBase>` pointer should be
      assigned to an :ref:`OEIter <OESystem_OEIter>` object to prevent
      memory leaks.

   .. oe:method:: GetBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMatchPair<OEBondBase> >* GetBonds() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBonds() -> Iterable[OEMatchPair[OEBondBase]]

      Returns an iterator over
      :oe:cls:`OEChem::OEMatchPairs<OEChem::OEMatchPair>` which contain
      the bond to bond correspondences in the
      :ref:`OEMatchBase <OEChem_OEMatchBase>` object.
      The returned :ref:`OEIterBase <OESystem_OEIterBase>` pointer should be
      assigned to an :ref:`OEIter <OESystem_OEIter>` object to prevent
      memory leaks.

   .. oe:method:: GetPatternAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEAtomBase>* GetPatternAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetPatternAtoms() -> OEAtomIter

      Returns an iterator over the match-ordered atoms of the pattern
      molecule.
      The returned :ref:`OEIterBase <OESystem_OEIterBase>` pointer should be
      assigned to an :ref:`OEIter <OESystem_OEIter>` object to prevent
      memory leaks.

   .. oe:method:: GetPatternBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBondBase>* GetPatternBonds() const

      .. oe:language:: python

         .. oe:api:: python

            GetPatternBonds() -> OEBondIter

      Returns an iterator over the match-ordered bonds of the pattern
      molecule.
      The returned :ref:`OEIterBase <OESystem_OEIterBase>` pointer should be
      assigned to an :ref:`OEIter <OESystem_OEIter>` object to prevent
      memory leaks.

   .. oe:method:: GetTargetAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEAtomBase>* GetTargetAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetAtoms() -> OEAtomIter

      Returns an iterator over the match-ordered atoms of the target
      molecule.
      The returned :ref:`OEIterBase <OESystem_OEIterBase>` pointer should be
      assigned to an :ref:`OEIter <OESystem_OEIter>` object to prevent
      memory leaks.

   .. oe:method:: GetTargetBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBondBase>* GetTargetBonds() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetBonds() -> OEBondIter

      Returns an iterator over the match-ordered bonds of the target
      molecule.
      The returned :ref:`OEIterBase <OESystem_OEIterBase>` pointer should be
      assigned to an :ref:`OEIter <OESystem_OEIter>` object to prevent
      memory leaks.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns if at least one atom or one bond equivalence is stored
      in the :ref:`OEMatchBase <OEChem_OEMatchBase>` object.

   .. oe:method:: NumAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumAtoms() const = 0

      .. oe:language:: python

         .. oe:api:: python

            NumAtoms() -> int

      Returns the number of atom equivalences in a match.

   .. oe:method:: NumBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumBonds() const = 0

      .. oe:language:: python

         .. oe:api:: python

            NumBonds() -> int

      Returns the number of bond equivalences in a match.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMatchFunc, MatchFunc

.. _OEChem_OEMatchFunc:

.. oe:class:: OEMatchFunc

   .. oe:api::

      template<class Arg>
      class OEMatchFunc : public OESystem::OEUnaryPredicate<Arg>

   This class represents :ref:`OEMatchFunc <OEChem_OEMatchFunc>` template functor that
   identifies objects (:ref:`OEAtomBase <OEChem_OEAtomBase>`, :ref:`OEBondBase <OEChem_OEBondBase>`)
   that match a query substructure specified in construction.

   .. seealso::

      * :ref:`section_predicates_match` section 

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   The following specializations exist for this template:
   
   .. oe:language:: c++

      ==================== ====================================================================
      Specialized Functor  Definition                                                          
      ==================== ====================================================================
      OEMatchAtomBase      :ref:`OEMatchFunc <OEChem_OEMatchFunc>` <:ref:`OEAtomBase <OEChem_OEAtomBase>`>
      OEMatchGraphMol      :ref:`OEMatchFunc <OEChem_OEMatchFunc>` <:ref:`OEGraphMol <OEChem_OEGraphMol>`>
      OEMatchMolBase       :ref:`OEMatchFunc <OEChem_OEMatchFunc>` <:ref:`OEMolBase <OEChem_OEMolBase>`>
      ==================== ====================================================================

      .. index::    
         single: OEMatchAtomBase
         single: OEMatchGraphMol
         single: OEMatchMolBase

   .. oe:language:: python java csharp

      ==================== ====================================================================
      Specialized Functor  Definition                                                          
      ==================== ====================================================================
      OEMatchAtom          :ref:`OEMatchFunc <OEChem_OEMatchFunc>` <:ref:`OEAtomBase <OEChem_OEAtomBase>`>
      OEMatchGraphMol      :ref:`OEMatchFunc <OEChem_OEMatchFunc>` <:ref:`OEGraphMol <OEChem_OEGraphMol>`>
      OEMatchMolBase       :ref:`OEMatchFunc <OEChem_OEMatchFunc>` <:ref:`OEMolBase <OEChem_OEMolBase>`>
      ==================== ====================================================================

       .. index::    
          single: OEMatchAtom
          single: OEMatchGraphMol
          single: OEMatchMolBase

   .. oe:method:: Constructors

      .. oe:api::

         OEMatchFunc(const char* smarts)

      Constructs the functor with the internal substructure search
      specified by the 'smarts' (:term:`SMARTS`) pattern.

      .. oe:api::

         OEMatchFunc(const OEQMolBase& qmol)

      Constructs the functor with the internal substructure search
      specified by the 'qmol' query molecule.

      .. oe:api::

         OEMatchFunc(const OEMolBase& mol, unsigned int aexpr,
                     unsigned int bexpr)

      Constructs the functor with the internal substructure search
      that is created from 'mol' using the specified expression options.
      The atom and bond expression options passed as the second and
      third arguments to the method are defined
      in the :oe:constns:`OEChem::OEExprOpts` namespace. The expression
      options are used to convert the atom and bond data into
      expression trees which are used during the subgraph search.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const Arg& arg) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg: Arg) -> bool

      Returns ``true`` if the 'arg' object matched by the query molecule
      defined in construction.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool()

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns ``true``, if the substructure search object was initialized
      correctly.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<Arg, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMatchFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEMatchFunc <OEChem_OEMatchFunc>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMatchPair, MatchPair

.. _OEChem_OEMatchPair:

.. oe:class:: OEMatchPair

   .. oe:api::

      template<class T>
      class OEMatchPair

   This class represents `OEMatchPair`.

   The :ref:`OEMatchPair <OEChem_OEMatchPair>` template class represents both
   atom-atom and bond-bond equivalences in pattern matching.
   Each :ref:`OEMatchPair <OEChem_OEMatchPair>` represents a correspondence (or
   matching) between a pattern atom or bond in the query molecule, and
   a target atom or bond in the target molecule, respectively.

   .. oe:method:: Constructors

      .. oe:api::

         OEMatchPair()

      Default constructor.

      .. oe:api::

         OEMatchPair(const T* p, const T* t)

      Initializes the :ref:`OEMatchPair <OEChem_OEMatchPair>` object with either
      an atom (:ref:`OEAtomBase <OEChem_OEAtomBase>`) or a bond
      (:ref:`OEBondBase <OEChem_OEBondBase>`) pair.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMatchPair<T>& operator=(const OEMatchPair<T>& rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OEMatchPair <OEChem_OEMatchPair>` object
      into the right-hand side :ref:`OEMatchPair <OEChem_OEMatchPair>` object.

      Assignment operator.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMol

.. _OEChem_OEMol:

.. oe:class:: OEMol

   .. oe:api::

      class OEMol

   The :ref:`OEMol <OEChem_OEMol>` class is a specific implementation of
   multi-conformer molecules.

   The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>`:

   =========================================================== =========================================================== ============================================================
   :oe:meth:`operator=<OEChem::OEMolBase::operator=>`          :oe:meth:`GetDimension<OEChem::OEMolBase::GetDimension>`    :oe:meth:`NumBonds<OEChem::OEMolBase::NumBonds>`            
   :oe:meth:`operator bool<OEChem::OEMolBase::operator bool>`  :oe:meth:`GetEnergy<OEChem::OEMolBase::GetEnergy>`          :oe:meth:`NumGroups<OEChem::OEMolBase::NumGroups>`          
   :oe:meth:`Clear<OEChem::OEMolBase::Clear>`                  :oe:meth:`GetGroup<OEChem::OEMolBase::GetGroup>`            :oe:meth:`OrderAtoms<OEChem::OEMolBase::OrderAtoms>`        
   :oe:meth:`ClearCoords<OEChem::OEMolBase::ClearCoords>`      :oe:meth:`GetGroups<OEChem::OEMolBase::GetGroups>`          :oe:meth:`OrderBonds<OEChem::OEMolBase::OrderBonds>`        
   :oe:meth:`Compress<OEChem::OEMolBase::Compress>`            :oe:meth:`GetMaxAtomIdx<OEChem::OEMolBase::GetMaxAtomIdx>`  :oe:meth:`ResetPerceived<OEChem::OEMolBase::ResetPerceived>`
   :oe:meth:`Count<OEChem::OEMolBase::Count>`                  :oe:meth:`GetMaxBondIdx<OEChem::OEMolBase::GetMaxBondIdx>`  :oe:meth:`SetCoords<OEChem::OEMolBase::SetCoords>`          
   :oe:meth:`CreateCopy<OEChem::OEMolBase::CreateCopy>`        :oe:meth:`GetTitle<OEChem::OEMolBase::GetTitle>`            :oe:meth:`SetDimension<OEChem::OEMolBase::SetDimension>`    
   :oe:meth:`DeleteAtom<OEChem::OEMolBase::DeleteAtom>`        :oe:meth:`HasPerceived<OEChem::OEMolBase::HasPerceived>`    :oe:meth:`SetEnergy<OEChem::OEMolBase::SetEnergy>`          
   :oe:meth:`DeleteBond<OEChem::OEMolBase::DeleteBond>`        :oe:meth:`IsDataType<OEChem::OEMolBase::IsDataType>`        :oe:meth:`SetPerceived<OEChem::OEMolBase::SetPerceived>`    
   :oe:meth:`DeleteGroup<OEChem::OEMolBase::DeleteGroup>`      :oe:meth:`IsDeleted<OEChem::OEMolBase::IsDeleted>`          :oe:meth:`SetRxn<OEChem::OEMolBase::SetRxn>`                
   :oe:meth:`GetAtom<OEChem::OEMolBase::GetAtom>`              :oe:meth:`IsRxn<OEChem::OEMolBase::IsRxn>`                  :oe:meth:`SetTitle<OEChem::OEMolBase::SetTitle>`            
   :oe:meth:`GetAtoms<OEChem::OEMolBase::GetAtoms>`            :oe:meth:`NewAtom<OEChem::OEMolBase::NewAtom>`              :oe:meth:`Sweep<OEChem::OEMolBase::Sweep>`                  
   :oe:meth:`GetBond<OEChem::OEMolBase::GetBond>`              :oe:meth:`NewBond<OEChem::OEMolBase::NewBond>`              :oe:meth:`UnCompress<OEChem::OEMolBase::UnCompress>`        
   :oe:meth:`GetBonds<OEChem::OEMolBase::GetBonds>`            :oe:meth:`NewGroup<OEChem::OEMolBase::NewGroup>`            
   :oe:meth:`GetCoords<OEChem::OEMolBase::GetCoords>`          :oe:meth:`NumAtoms<OEChem::OEMolBase::NumAtoms>`            
   =========================================================== =========================================================== ============================================================

   .. oe:language:: java

      The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>` only in Java:

      ====================================================== ====================================================== =========================================================
      :oe:meth:`GetAtomList<OEChem::OEMolBase::GetAtomList>` :oe:meth:`GetBondList<OEChem::OEMolBase::GetBondList>` :oe:meth:`GetGroupList<OEChem::OEMolBase::GetGroupList>` 
      ====================================================== ====================================================== =========================================================

   The following methods are publicly inherited from :ref:`OEMCMolBase <OEChem_OEMCMolBase>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`DeleteConf<OEChem::OEMCMolBase::DeleteConf>`        :oe:meth:`GetMCMolTitle<OEChem::OEMCMolBase::GetMCMolTitle>` :oe:meth:`PushActive<OEChem::OEMCMolBase::PushActive>`      
   :oe:meth:`DeleteConfs<OEChem::OEMCMolBase::DeleteConfs>`      :oe:meth:`IsDeleted<OEChem::OEMCMolBase::IsDeleted>`         :oe:meth:`SetActive<OEChem::OEMCMolBase::SetActive>`        
   :oe:meth:`GetActive<OEChem::OEMCMolBase::GetActive>`          :oe:meth:`NewConf<OEChem::OEMCMolBase::NewConf>`             :oe:meth:`SweepConfs<OEChem::OEMCMolBase::SweepConfs>`      
   :oe:meth:`GetConf<OEChem::OEMCMolBase::GetConf>`              :oe:meth:`NumConfs<OEChem::OEMCMolBase::NumConfs>`                                                                       
   :oe:meth:`GetConfs<OEChem::OEMCMolBase::GetConfs>`            :oe:meth:`OrderConfs<OEChem::OEMCMolBase::OrderConfs>`                                                                   
   :oe:meth:`GetMaxConfIdx<OEChem::OEMCMolBase::GetMaxConfIdx>`  :oe:meth:`PopActive<OEChem::OEMCMolBase::PopActive>`                                                                     
   ============================================================= ============================================================ ============================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMol(const OEMol &)
            OEMol(const OEMCMolBase &)
            OEMol(const OEMol &, unsigned int type)
            OEMol(unsigned int type = OEMolType::OEDefault)
            OEMol(const OEMCMolBase &, unsigned int type)
            OEMol(const OEQMol &, unsigned int type = OEMCMolType::OEDefault)
            OEMol(const OEMolBase &, unsigned int type = OEMCMolType::OEDefault)
            OEMol(const OEQMolBase &,
                  unsigned int type = OEMCMolType::OEDefault)
            OEMol(const OEGraphMol &,
                  unsigned int type = OEMCMolType::OEDefault)
            OEMol(const OESystem::OEBase &,
                  unsigned int type = OEMCMolType::OEDefault)

      .. oe:language:: python

         .. oe:api:: python

            OEMol(t: int = OEMolType.OEDefault) -> OEMol
            OEMol(mol: OEMol) -> OEMol
            OEMol(mol: OEMol, t: int) -> OEMol
            OEMol(b: OEBase, t: int = OEMolType.OEDefault) -> OEMol
            OEMol(m: OEQMol, t: int = OEMolType.OEDefault) -> OEMol
            OEMol(m: OEMol) -> OEMol
            OEMol(m: OEMol, t: int) -> OEMol
            OEMol(mol: OEGraphMol, t: int) -> OEMol

      Default and copy constructors.

      *type*
         The type of the molecule from the
         :oe:constns:`OEChem::OEMCMolType` namespace.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMol &operator=(const OEMol &)
         OEMol &operator=(const OEQMol &)
         OEMol &operator=(const OEMolBase &)
         OEMol &operator=(const OEGraphMol &)
         OEMol &operator=(const OEQMolBase &)
         OEMol &operator=(const OEMCMolBase &)

      Assignment operators.

      Assignment operator.

   .. oe:method:: operator OEMCMolBase &
      :language: c++

      .. oe:api::

         operator const OEMCMolBase &() const
         operator OEMCMolBase &()

   .. oe:method:: ClearBase

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearBase()

      .. oe:language:: python

         .. oe:api:: python

            ClearBase() -> None

   .. oe:method:: ClearMCMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearMCMol()

      .. oe:language:: python

         .. oe:api:: python

            ClearMCMol() -> None

   .. oe:method:: ClearMolBase

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearMolBase()

      .. oe:language:: python

         .. oe:api:: python

            ClearMolBase() -> None

   .. oe:method:: MCMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMCMolBase& MCMol() const
            OEMCMolBase& MCMol()

      .. oe:language:: python

         .. oe:api:: python

            MCMol() -> OEMol

   .. oe:method:: SCMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMolBase& SCMol() const
            OEMolBase& SCMol()

      .. oe:language:: python

         .. oe:api:: python

            SCMol() -> OEGraphMol

   .. oe:language:: java

      .. oe:method:: GetConfList

         .. oe:api:: java

            java.util.List<OEConfBase> GetConfList()

         Returns a List object containing all of the conformers in the order they were
         created.  Note that removing atoms from the list does not remove them from
         the molecule.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMolBase, MolBase

.. _OEChem_OEMolBase:

.. oe:class:: OEMolBase

   .. oe:api::

      class OEMolBase : public OESystem::OEBase

   This class represents `OEMolBase`.

   The :ref:`OEMolBase <OEChem_OEMolBase>` class is the abstract interface for
   representing molecules within *OEChem*.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   The following classes derive from this class:
    * :ref:`OEConfBase <OEChem_OEConfBase>`
    * :ref:`OEMCMolBase <OEChem_OEMCMolBase>`
    * :ref:`OEQMolBase <OEChem_OEQMolBase>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolBase& operator=(const OEMolBase& m)

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Determines whether the :ref:`OEMolBase <OEChem_OEMolBase>` object
      contains any atoms. This method is equivalent to
      :oe:meth:`OEChem::OEMolBase::NumAtoms()<OEChem::OEMolBase::NumAtoms>`
      != 0.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()=0

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Resets a molecule to its initial state. This method deletes all
      atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) and bonds
      (:ref:`OEBondBase <OEChem_OEBondBase>`) that are part of the
      molecule. Following an :oe:meth:`OEChem::OEMolBase::Clear`, the
      atom and bond indices assigned to new atoms and bonds may not be
      unique with those assigned prior to the
      :oe:meth:`OEChem::OEMolBase::Clear`.

   .. oe:method:: ClearBase

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearBase()

      .. oe:language:: python

         .. oe:api:: python

            ClearBase() -> None

      Clear the generic data from the :ref:`OEBase <OESystem_OEBase>` base
      class of this object. Equivalent to just calling
      :oe:meth:`OESystem::OEBase::Clear` without actually clearing away
      molecule data like atoms and bonds.

   .. oe:method:: ClearCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearCoords() =0

      .. oe:language:: python

         .. oe:api:: python

            ClearCoords() -> None

      Clears the coordinates, resets stereo perception flags and sets the coordinate
      dimension to ``0``

      .. seealso::

         * :oe:meth:`OEChem::OEMolBase::GetCoords`
         * :oe:meth:`OEChem::OEMolBase::SetCoords`

   .. oe:method:: Compress

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Compress()

      .. oe:language:: python

         .. oe:api:: python

            Compress() -> bool

   .. seealso::

      .. oe:language:: c++

         * Example program :ref:`randomsample.cpp<section_example_oechem_randomsample>`

      .. oe:language:: python

         * Example program :ref:`randomsample.py<section_example_oechem_randomsample>`

      .. oe:language:: java

         * Example program :ref:`RandomSample.java<section_example_oechem_randomsample>`

      .. oe:language:: csharp

         * Example program :ref:`RandomSample.cs<section_example_oechem_randomsample>`

   .. oe:method:: Count

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int Count(unsigned int) const = 0

      .. oe:language:: python

         .. oe:api:: python

            Count(arg2: int) -> int

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

   .. oe:method:: DeleteAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteAtom(OEAtomBase* atom)=0

      .. oe:language:: python

         .. oe:api:: python

            DeleteAtom(arg2: OEAtomBase) -> bool

      Deletes an atom from a molecule. All bonds connected to the
      specified atom are also automatically deleted. Following an atom
      deletion, the specified :ref:`OEAtomBase <OEChem_OEAtomBase>` pointer, and
      the :ref:`OEBondBase <OEChem_OEBondBase>` pointers of any incident bonds,
      are no longer valid and should not be used. The atom index
      associated with the atom, and the bond indices of any incident
      bonds, are no longer recognized by the
      :ref:`OEMolBase <OEChem_OEMolBase>`, but the indices of all other atoms
      and bonds remain stable, and are unaffected by this call.

      .. note::

         After deleting atoms or bonds, it may be necessary to call the
         :oe:func:`OEChem::OEFindRingAtomsAndBonds` and
         :oe:func:`OEChem::OEAssignAromaticFlags` functions to update the
         'in ring' and 'aromatic' properties of the atoms and bonds in
         the modified molecule.

   .. oe:method:: DeleteBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteBond(OEBondBase* bond)=0

      .. oe:language:: python

         .. oe:api:: python

            DeleteBond(arg2: OEBondBase) -> bool

      Deletes a bond from a molecule. Following a bond deletion, the
      specified :ref:`OEBondBase <OEChem_OEBondBase>` pointer is no longer valid
      and should not be used. The bond index associated with the bond
      is no longer recognized by the :ref:`OEMolBase <OEChem_OEMolBase>`, but
      the indices of all other bonds remain stable, and are unaffected
      by this call.

      .. note::

         After deleting atoms or bonds, it may be necessary to call the
         :oe:func:`OEChem::OEFindRingAtomsAndBonds` and
         :oe:func:`OEChem::OEAssignAromaticFlags` functions to update the
         'in ring' and 'aromatic' properties of the atoms and bonds in
         the modified molecule.

   .. oe:method:: DeleteGroup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteGroup(OEGroupBase* group)

      .. oe:language:: python

         .. oe:api:: python

            DeleteGroup(group: OEGroupBase) -> bool

      Deletes a group from a molecule. Following a group deletion, the
      specified :ref:`OEGroupBase <OEChem_OEGroupBase>` pointer is no longer valid
      and should not be used.

   .. oe:method:: GetAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomBase* GetAtom(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetAtom(arg2: OEUnaryAtomPred) -> OEAtomBase

      Retrieves the first atom of a molecule that matches the
      specified atom predicate
      (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`). If the molecule does not
      contain an atom that matches, a NULL pointer,
      (:oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`)0, is returned.

   .. oe:method:: GetAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEAtomBase>* GetAtoms() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> OEAtomIter

      Returns an iterator over all the atoms of a molecule. By
      default, this returns all the atoms of the molecule in the order
      they were created. The ordering of the atoms returned by
      :oe:meth:`OEChem::OEMolBase::GetAtoms` may be modified by
      :oe:meth:`OEChem::OEMolBase::OrderAtoms`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEAtomBase>* GetAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms(arg2: OEUnaryAtomPred) -> OEAtomIter

      Returns an iterator over all of the atoms of a molecule that
      match the specified atom predicate
      (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`).

   .. oe:language:: java

      .. oe:method:: GetAtomList

         .. oe:api:: java

            java.util.List<OEAtomBase> GetAtomList()

         Returns a List object containing all of the atoms in the order they were
         created.  Note that removing atoms from the list does not remove them from
         the molecule.

   .. oe:method:: GetBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondBase* GetBond(const OEAtomBase* src, const OEAtomBase* dst) const

      .. oe:language:: python

         .. oe:api:: python

            GetBond(arg2: OEAtomBase, arg3: OEAtomBase) -> OEBondBase

      Retrieves the bond of a molecule between two specified atoms. If
      the two atoms, 'src' and 'dst' are not bonded together, then a
      NULL pointer,
      (:oe:cls:`OEChem::OEBondBase*<OEChem::OEBondBase>`)0, is returned

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondBase* GetBond(const OESystem::OEUnaryPredicate<OEChem::OEBondBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBond(arg2: OEUnaryBondPred) -> OEBondBase

      Retrieves the first bond of a molecule that matches the
      specified bond predicate. If the molecule does not contain a
      bond that matches the predicate, a NULL pointer,
      (:oe:cls:`OEChem::OEBondBase*<OEChem::OEBondBase>`)0, is
      returned.

   .. oe:method:: GetBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBondBase>* GetBonds() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBonds() -> OEBondIter

      Returns an iterator over all the bonds of a molecule. By
      default, this returns all the bonds of the molecule in the order
      they were created. The ordering of the bonds returned by
      :oe:meth:`OEChem::OEMolBase::GetBonds` may be modified by
      :oe:meth:`OEChem::OEMolBase::OrderBonds`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBondBase>* GetBonds(const OESystem::OEUnaryPredicate<OEChem::OEBondBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBonds(arg2: OEUnaryBondPred) -> OEBondIter

      Returns an iterator over all of the bonds of a molecule that
      match the specified bond predicate
      (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`).

   .. oe:language:: java

       .. oe:method:: GetBondList

          .. oe:api:: java

             java.util.List<OEBondBase> GetBondList()

          Returns a List object containing all of the bonds in the order they were
          created.  Note that removing bonds from the list does not remove them from
          the molecule.

   .. oe:method:: GetCoords

      .. oe:language:: python

         .. oe:api:: python

            GetCoords() -> {idx : (x_0, y_0, z_0), ... }

         Returns a Python dictionary of the coordinates of this
         molecule. The dictionary is keyed off the index of the
         :ref:`OEAtomBase <OEChem_OEAtomBase>` as returned by
         :oe:meth:`OEChem::OEAtomBase::GetIdx`. The values will always
         be a 3-element tuple of floating point values. Note, the
         dictionary will not contain entries for deleted atoms, making
         it significantly easier to use than the following
         ``OEFloatArray`` overloads. This also means the keys of the
         dictionary are not always guaranteed to be contiguous
         integers.

         .. note::

            The overload that returns a dictionary is for convenience
            over performance as it is significantly more
            pythonic. However, if the floating point values are not
            needed in Python and just being passed to another OpenEye
            toolkit function, using the following overloads with
            ``OEFloatArray`` objects will be significantly faster.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCoords(OEPlatform::OEHalfFloat *) const = 0
            bool GetCoords(float *) const = 0
            bool GetCoords(double *) const = 0
            bool GetCoords(long double *) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetCoords(arg2: OEAtomBase) -> bool
            GetCoords(crds: OEHalfFloat) -> bool
            GetCoords(arg2: OEFloatArray) -> bool
            GetCoords(arg2: OEDoubleArray) -> bool

      Fills the specified array of floating point values with the
      Cartesian coordinates of all of the atoms in the molecule. The
      array argument must point to an array of at least
      3* :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx()<OEChem::OEMolBase::GetMaxAtomIdx>`
      elements. The X, Y and Z coordinates for the atom with index 'i'
      will be placed at offsets ``3*i``, ``3*i+1`` and ``3*i+2``
      respectively.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCoords(const OEAtomBase *, OEPlatform::OEHalfFloat *) const = 0
            bool GetCoords(const OEAtomBase *, float *) const = 0
            bool GetCoords(const OEAtomBase *, double *) const = 0
            bool GetCoords(const OEAtomBase *, long double *) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetCoords(atom: OEAtomBase, crds: OEHalfFloat) -> bool
            GetCoords(arg2: OEAtomBase, arg3: OEFloatArray) -> bool
            GetCoords(arg2: OEAtomBase, arg3: OEDoubleArray) -> bool

      Fills the specified array of floating point values with the
      Cartesian coordinates of the specified atom. This array must be
      large enough to hold at least three values, corresponding to the
      X, Y and Z values for the given atom.

   .. oe:method:: GetDimension

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetDimension() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetDimension() -> int

      Returns the 'dimensionality' property of a molecule. The default value is
      zero, for unknown or no coordinates, 2 for 2-dimensional
      coordinates (such as depictions) and 3 for 3-dimensional
      coordinates.
      The 'dimensionality' property of a molecule may be
      set using the :oe:meth:`OEChem::OEMolBase::SetDimension`
      method.

      This property is typically set by the appropriate
      molecular file format reader (``0`` for SMILES, ``3`` for MOL2 and ``2`` or
      ``3`` for MDL SD files *etc...*) or by calling the
      :oe:func:`OEChem::OESetDimensionFromCoords` function.

   .. oe:method:: GetEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEnergy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetEnergy() -> float

      Returns the 'energy' property of a molecule. The default value is
      0.0. The 'energy' property of a molecule may be set using the
      :oe:meth:`OEChem::OEMolBase::SetEnergy` method. Higher values
      indicate higher energies and therefore less-favorable or
      more-strained structures.

   .. oe:method:: GetGroup

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEGroupBase* GetGroup(const OESystem::OEUnaryPredicate<OEChem::OEGroupBase>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            GetGroup(pred: OEUnaryGroupPred) -> OEGroupBase

      Retrieves the first group of a molecule that matches the
      specified group predicate (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`).
      If the molecule does not contain a group that matches, a NULL pointer,
      (:oe:cls:`OEChem::OEGroupBase*<OEChem::OEGroupBase>`)0, is returned.

      .. seealso::

         * :ref:`OEHasAtomInGroup <OEChem_OEHasAtomInGroup>` predicate
         * :ref:`OEHasBondInGroup <OEChem_OEHasBondInGroup>` predicate
         * :ref:`OEHasGroupType <OEChem_OEHasGroupType>` predicate
         * :ref:`OEIsMDLStereoGroup <OEChem_OEIsMDLStereoGroup>` predicate

   .. oe:method:: GetGroups

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEGroupBase>* GetGroups() const

      .. oe:language:: python

         .. oe:api:: python

            GetGroups() -> Iterable[OEGroupBase]

      Returns an iterator over all the groups of a molecule.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEGroupBase>* GetGroups(const OESystem::OEUnaryPredicate<OEChem::OEGroupBase>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            GetGroups(pred: OEUnaryGroupPred) -> Iterable[OEGroupBase]

      Returns an iterator over all of the groups of a molecule that
      match the specified group predicate
      (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`).

      .. seealso::

         * :ref:`OEHasAtomInGroup <OEChem_OEHasAtomInGroup>` predicate
         * :ref:`OEHasBondInGroup <OEChem_OEHasBondInGroup>` predicate
         * :ref:`OEHasGroupType <OEChem_OEHasGroupType>` predicate
         * :ref:`OEIsMDLStereoGroup <OEChem_OEIsMDLStereoGroup>` predicate

   .. oe:language:: java

      .. oe:method:: GetGroupList

         .. oe:api:: java

            java.util.List<OEGroupBase> GetGroupList()

         Returns a List object containing all of the groups in the order they were
         created.  Note that removing groups from the list does not remove them from
         the molecule.

   .. oe:method:: GetMaxAtomIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxAtomIdx() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetMaxAtomIdx() -> int

      For performance reasons, atom indices are not guaranteed to be contiguous.
      :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx` returns a lower bound for the maximum atom index
      i.e. all indices returned by :oe:meth:`OEChem::OEAtomBase::GetIdx` of the
      molecule will be less than this value.
      The value returned by :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx`
      is always at least as large as :oe:meth:`OEChem::OEMolBase::NumAtoms`.

      This method is useful for allocating temporary external data structures
      that need to be indexed by atom index, as returned by
      :oe:meth:`OEChem::OEAtomBase::GetIdx`.

   .. oe:method:: GetMaxBondIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxBondIdx() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetMaxBondIdx() -> int

      For performance reasons, bond indices are not guaranteed to be contiguous.
      :oe:meth:`OEChem::OEMolBase::GetMaxBondIdx` returns a lower bound for the maximum bond index
      i.e. all indices returned by :oe:meth:`OEChem::OEBondBase::GetIdx` of the
      molecule will be less than this value.
      The value returned by :oe:meth:`OEChem::OEMolBase::GetMaxBondIdx`
      is always at least as large as :oe:meth:`OEChem::OEMolBase::NumBonds`.

      This method is useful for allocating temporary external data structures
      that need to be indexed by bond index, as returned by
      :oe:meth:`OEChem::OEBondBase::GetIdx`.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Returns the 'title' property of a molecule. The default value is
      the empty string. The title of a molecule may be set
      using the :oe:meth:`OEChem::OEMolBase::SetTitle` method.

      .. oe:language:: c++

         .. warning::

            Titles should be compared using **strcmp**:

            .. code-block:: c

               if (strcmp(mol1.GetTitle(), mol2.GetTitle()) == 0)
                 // do something if titles are the same

            The following code snippet compares the pointer of the titles **not** the titles themselves.

            .. code-block:: c

               if (mol1.GetTitle() == mol2.GetTitle())
                  // do something if titles are the same

      .. seealso::

         .. oe:language:: c++

            * Example programs :ref:`gettitles.cpp<section_example_oechem_gettitles>` and :ref:`molextract.cpp<section_example_oechem_molextract>`

         .. oe:language:: python

            * Example programs :ref:`gettitles.py<section_example_oechem_gettitles>` and :ref:`molextract.py<section_example_oechem_molextract>`

         .. oe:language:: java

            * Example programs :ref:`GetTitles.java<section_example_oechem_gettitles>` and :ref:`MolExtract.java<section_example_oechem_molextract>`

         .. oe:language:: csharp

            * Example programs :ref:`GetTitles.cs<section_example_oechem_gettitles>` and :ref:`MolExtract.cs<section_example_oechem_molextract>`

   .. oe:method:: HasPerceived

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasPerceived(unsigned int prop) const = 0

      .. oe:language:: python

         .. oe:api:: python

            HasPerceived(arg2: int) -> bool

      Returns whether a property is perceived for the given molecule.

      *property*
         This value has to be from the :oe:constns:`OEChem::OEPerceived`
         namespace.

      .. seealso::

         * :oe:meth:`OEChem::OEMolBase::ResetPerceived` method
         * :oe:meth:`OEChem::OEMolBase::SetPerceived` method

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

   .. oe:method:: IsDeleted

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDeleted(OEBondBase *) const = 0
            bool IsDeleted(OEAtomBase *) const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsDeleted(arg2: OEBondBase) -> bool
            IsDeleted(arg2: OEAtomBase) -> bool

   .. oe:method:: IsRxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsRxn() const

      .. oe:language:: python

         .. oe:api:: python

            IsRxn() -> bool

      Determines whether the molecule represents a
      reaction/transform. A ``true`` returned value indicates that the
      molecule represents a reaction, while ``false`` indicates the
      molecule is a simple connection table. The default value is
      ``false``. The reaction property of a molecule may be set using
      the :oe:meth:`OEChem::OEMolBase::SetRxn` method.

   .. oe:method:: NewAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomBase* NewAtom(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            NewAtom(arg2: int) -> OEAtomBase

      Creates a new atom in the molecule by specifying the element
      number from the :oe:constns:`OEChem::OEElemNo` namespace.
      This method does not create any bonds, and the returned created
      atom is always disconnected.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomBase* NewAtom(const OEAtomBase &)=0

      .. oe:language:: python

         .. oe:api:: python

            NewAtom(arg2: OEAtomBase) -> OEAtomBase

      Creates a new atom in the molecule and copies the atomic
      properties of the specified atom (atomic number, formal charge,
      implicit hydrogen count, *etc...*)
      This method does not create any bonds, and the returned created
      atom is always disconnected.

   .. oe:method:: NewBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondBase* NewBond(OEAtomBase* src, OEAtomBase* dst,
                                unsigned int order = 0)=0

      .. oe:language:: python

         .. oe:api:: python

            NewBond(arg2: OEAtomBase, arg3: OEAtomBase, order: int = 0) -> OEBondBase

      Creates a new bond in the molecule. The 'src', 'dst' and 'order'
      arguments are used to specify the begin atom, the end atom and
      the bond order of the new bond.
      This method returns a pointer to the newly created
      :ref:`OEBondBase <OEChem_OEBondBase>` object.
      The atoms specified as 'src' and 'dst' atoms must belong to the
      current molecule.
      Additionally, a NULL pointer,
      (:oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`)0, may be
      passed as either the begin or end atom (but not both), allowing
      that atom to be specified later using
      :oe:meth:`OEChem::OEBondBase::SetBgn` or
      :oe:meth:`OEChem::OEBondBase::SetEnd` respectively.
      This helps when creating molecules for applications in which the
      ordering of atoms and/or bonds is significant.

      .. note::

         After creating new bonds, it may be necessary to call the
         :oe:func:`OEChem::OEFindRingAtomsAndBonds` and
         :oe:func:`OEChem::OEAssignAromaticFlags` functions to update the
         'in ring' and 'aromatic' properties of the atoms and bonds in
         the modified molecule.

   .. oe:method:: NewGroup

      .. oe:api::

         OEGroupBase *NewGroup(unsigned int type,
                               const std::vector<OEAtomBase *> &atoms)
         OEGroupBase *NewGroup(unsigned int type,
                               const std::vector<OEBondBase *> &bonds)
         OEGroupBase *NewGroup(unsigned int type,
                               const std::vector<OEAtomBase *> &atoms,
                               const std::vector<OEBondBase *> &bonds)
         OEGroupBase* NewGroup(unsigned int type, const OEAtomBondSet &abset)

      Creates a new group in the molecule with the given atoms or/and bonds.

      *type*
          The type associated with the created :ref:`OEGroupBase <OEChem_OEGroupBase>`
          object.

      *atoms*
          The pointer of the :ref:`OEAtomBase <OEChem_OEAtomBase>` objects that the group
          will hold.

      *bonds*
          The pointer of the :ref:`OEBondBase <OEChem_OEBondBase>` objects that the group
          will hold.

      *abset*
          The :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` container that holds atom and bond
          pointers.

      .. note::

         An empty group can not be created. If there is no valid atom or/and
         bond pointers given, then the :oe:meth:`OEChem::OEMolBase::NewGroup`
         will return a NULL pointer.

      .. seealso::

         * :oe:constns:`OEChem::OEGroupType` namespace

   .. oe:method:: NumAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumAtoms() const = 0

      .. oe:language:: python

         .. oe:api:: python

            NumAtoms() -> int

      Returns the number of atoms in the molecule.

   .. oe:method:: NumBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumBonds() const = 0

      .. oe:language:: python

         .. oe:api:: python

            NumBonds() -> int

      Returns the number of bonds in the molecule.

   .. oe:method:: NumGroups

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumGroups() const

      .. oe:language:: python

         .. oe:api:: python

            NumGroups() -> int

      Returns the number of groups in the molecule.

   .. oe:method:: OrderAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool OrderAtoms(const std::vector<OEAtomBase *> &)=0

      .. oe:language:: python

         .. oe:api:: python

            OrderAtoms(arg2: OEAtomVector) -> bool

      Reorders the atoms of the molecule.
      This method modifies the order in which the atoms are visited by
      the iterator returned by :oe:meth:`OEChem::OEMolBase::GetAtoms`.
      This method does not affect the atom indices of any of the atoms
      of the molecule.
      This method does not affect the ordering of any other iterator,
      including bonds over a molecule (:oe:meth:`OEChem::OEMolBase::GetBonds`) ,
      bonds over an atom (:oe:meth:`OEChem::OEAtomBase::GetBonds`) or
      neighboring atoms over an atom (:oe:meth:`OEChem::OEAtomBase::GetAtoms`).

   .. oe:method:: OrderBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool OrderBonds(const std::vector<OEBondBase *> &)=0

      .. oe:language:: python

         .. oe:api:: python

            OrderBonds(arg2: OEBondVector) -> bool

      Reorders the bonds of a molecule.
      This method modifies the order in which the bonds are visited by
      the iterator returned by :oe:meth:`OEChem::OEMolBase::GetBonds`.
      This method does not affect the bond indices of any of the bonds
      of the molecule.
      This method does not affect the ordering of any other iterator,
      including atoms over a molecule (:oe:meth:`OEChem::OEMolBase::GetAtoms`),
      bonds over an atom (:oe:meth:`OEChem::OEAtomBase::GetBond`) or
      neighboring atoms over atom (:oe:meth:`OEChem::OEAtomBase::GetAtoms`).

   .. oe:method:: ResetPerceived

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ResetPerceived() = 0

      .. oe:language:: python

         .. oe:api:: python

            ResetPerceived() -> None

      Invalidates all previously perceived properties specified in the
      :oe:constns:`OEChem::OEPerceived` namespace.

      .. seealso::

         * :oe:meth:`OEChem::OEMolBase::HasPerceived` method
         * :oe:meth:`OEChem::OEMolBase::SetPerceived` method

   .. oe:method:: SetCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCoords(const OEPlatform::OEHalfFloat* coords)=0
            bool SetCoords(const float* coords)=0
            bool SetCoords(const double* coords)=0
            bool SetCoords(const long double* coords)=0

      .. oe:language:: python

         .. oe:api:: python

            SetCoords(arg2: OEAtomBase) -> bool
            SetCoords(crds: OEHalfFloat) -> bool
            SetCoords(arg2: OEFloatArray) -> bool
            SetCoords(arg2: OEDoubleArray) -> bool

      Sets the Cartesian coordinates for all of the atoms in a molecule.
      The array argument must point to an array of at least
      3* :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx()<OEChem::OEMolBase::GetMaxAtomIdx>`
      elements.
      The X, Y and Z coordinates for the atom with index 'i', should be
      placed at offsets ``3*i``, ``3*i+1`` and ``3*i+2`` respectively.

      .. seealso::

         * :oe:meth:`OEChem::OEMolBase::ClearCoords`

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCoords(const OEAtomBase *, const OEPlatform::OEHalfFloat *)=0
            bool SetCoords(const OEAtomBase *, const float *)=0
            bool SetCoords(const OEAtomBase *, const double *)=0
            bool SetCoords(const OEAtomBase *, const long double *)=0

      .. oe:language:: python

         .. oe:api:: python

            SetCoords(atom: OEAtomBase, crds: OEHalfFloat) -> bool
            SetCoords(arg2: OEAtomBase, arg3: OEFloatArray) -> bool
            SetCoords(arg2: OEAtomBase, arg3: OEDoubleArray) -> bool

      Sets the Cartesian coordinates of the specified atom to the
      values specified by the floating point array.
      The array argument must point to array of at least three values,
      representing the X, Y and Z Cartesian coordinates of the atom,
      respectively.

   .. oe:method:: SetDimension

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDimension(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetDimension(arg2: int) -> bool

      Sets the 'dimensionality' property of a molecule.
      The default value is zero.
      The 'dimensionality' property of a molecule may be retrieved using
      the :oe:meth:`OEChem::OEMolBase::GetDimension` method.
      This property is typically set by the appropriate molecular file
      format reader, or by calling the
      :oe:func:`OEChem::OESetDimensionFromCoords` function.

      The 'dimensionality' property represents the dimensionality of
      the coordinates.
      This has the default value zero, for unknown or no coordinates,
      2 for 2-dimensional coordinates (such as depictions) and 3 for
      3-dimensional coordinates.
      This property is typically set by the file format reader
      indicating the dimensionality of the input file (``0`` for
      SMILES, ``3`` for MOL2 and ``2`` or ``3`` for MDL SD files
      *etc...*)

   .. oe:method:: SetEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnergy(float)=0
            bool SetEnergy(double)=0

      .. oe:language:: python

         .. oe:api:: python

            SetEnergy(arg2: float) -> bool

      Sets the 'energy' property of a molecule. The default value is ``0.0``.
      The energy of a molecule may be retrieved using the
      :oe:meth:`OEChem::OEMolBase::GetEnergy` method.

   .. oe:method:: SetPerceived

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceived(unsigned int property, bool perceived) = 0

      .. oe:language:: python

         .. oe:api:: python

            SetPerceived(arg2: int, arg3: bool) -> bool

      Sets whether a property is considered to be perceived for the
      given molecule.

      *property*
         This value has to be from the :oe:constns:`OEChem::OEPerceived`
         namespace.

      *perceived*
         A boolean value that determines whether the given property is
         perceived.

      .. warning::

         The perception flags are used for performance in order to avoid
         perceiving properties that have already been calculated.
         It should be set to be 'true' only by the function that
         calculates the given property.

      .. seealso::

         * :oe:meth:`OEChem::OEMolBase::HasPerceived` method
         * :oe:meth:`OEChem::OEMolBase::ResetPerceived` method

   .. oe:method:: SetRxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRxn(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRxn(arg2: bool) -> bool

      Sets the 'reaction' property of a molecule.
      The 'reaction' property of a molecule may be retrieved using the
      :oe:meth:`OEChem::OEMolBase::IsRxn` method.

   .. oe:method:: SetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTitle(const char *)=0
            bool SetTitle(const std::string &)=0

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(arg2: str) -> bool

      Sets the 'title' property of a molecule.
      The default value is the empty string.
      The 'title' property of a molecule may be retrieved using the
      :oe:meth:`OEChem::OEMolBase::GetTitle` method.

   .. seealso::

      .. oe:language:: c++

         * Example program :ref:`sdfrename.cpp<section_example_oechem_sdfrename>`

      .. oe:language:: python

         * Example program :ref:`sdfrename.py<section_example_oechem_sdfrename>`

      .. oe:language:: java

         * Example program :ref:`SDFRename.java<section_example_oechem_sdfrename>`

      .. oe:language:: csharp

         * Example program :ref:`SDFRename.cs<section_example_oechem_sdfrename>`

   .. oe:method:: Sweep

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Sweep()=0

      .. oe:language:: python

         .. oe:api:: python

            Sweep() -> bool

      Renumbers the atom and bond indices sequentially.
      This method invalidates the atom and bond indices of all atoms
      in a molecule.

      .. note::

         This method doesn't guarantee that all atom and bond indices
         are sequential upon completion (some molecule implementations
         may treat :oe:meth:`OEChem::OEMolBase::Sweep` as a no-op).

   .. oe:method:: UnCompress

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool UnCompress()

      .. oe:language:: python

         .. oe:api:: python

            UnCompress() -> bool

   .. seealso::

      .. oe:language:: c++

         * Example program :ref:`randomsample.cpp<section_example_oechem_randomsample>`

      .. oe:language:: python

         * Example program :ref:`randomsample.py<section_example_oechem_randomsample>`

      .. oe:language:: java

         * Example program :ref:`RandomSample.java<section_example_oechem_randomsample>`

      .. oe:language:: csharp

         * Example program :ref:`RandomSample.cs<section_example_oechem_randomsample>`


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMolDBException, MolDBException

.. _OEChem_OEMolDBException:

.. oe:class:: OEMolDBException

   .. oe:api::

      class OEMolDBException : public std::exception

   The exception that is raised when the :oe:meth:`OEMolDatabase
   constructors<OEChem::OEMolDatabase::Constructors>` fail.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolDBException(const std::string& msg)

      .. oe:language:: python

         .. oe:api:: python

            OEMolDBException(msg: str) -> OEMolDBException

      Construct the exception with the ``msg``. 

   .. oe:method:: what

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* what() const

      .. oe:language:: python

         .. oe:api:: python

            what() -> str

      Returns the message used to construct this exception.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMolDatabase, MolDatabase

.. _OEChem_OEMolDatabase:

.. oe:class:: OEMolDatabase

   .. oe:api::

      class OEMolDatabase : public OESystem::OEBase

   This class provides an abstraction for fast read-only random access
   to any molecular file format **OEChem** supports reading. The
   :ref:`chapter_moldatabase` chapter provides a description of the
   fundamentals of using this class.

   When :oe:meth:`opened<OEChem::OEMolDatabase::Open>` or
   :oe:meth:`saved<OEChem::OEMolDatabase::Save>` to an :file:`.oeb`
   file, the generic data on the object itself will be preserved
   through the :ref:`OEHeader <OESystem_OEHeader>` record in the file. The
   following methods can be used to access the generic since they are
   inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolDatabase()
            OEMolDatabase(OEChem::oemolistream& ifs)
            OEMolDatabase(const std::string& filename)
            OEMolDatabase(OEPlatform::oeistream& istr, unsigned int format)
            OEMolDatabase(const std::string& filename, unsigned int format)
            OEMolDatabase(const std::string& filename, unsigned int format,
                          unsigned int flavor)
            OEMolDatabase(OEPlatform::oeistream& istr, unsigned int format,
                          unsigned int flavor)

      .. oe:language:: python

         .. oe:api:: python

            OEMolDatabase() -> OEMolDatabase
            OEMolDatabase(filename: str) -> OEMolDatabase
            OEMolDatabase(filename: str, format: int) -> OEMolDatabase
            OEMolDatabase(filename: str, format: int, flavor: int) -> OEMolDatabase
            OEMolDatabase(ifs: oemolistream) -> OEMolDatabase
            OEMolDatabase(istr: oeistream, format: int) -> OEMolDatabase
            OEMolDatabase(istr: oeistream, format: int, flavor: int) -> OEMolDatabase

      The default constructor will initialize the object to an empty
      state where most of the accessors methods will fail. It is
      expected that the user will later call
      :oe:meth:`OEChem::OEMolDatabase::Open` on the object.

      The other constructors are convenience methods for opening the
      database on the given ``filename`` or stream with the specified
      ``format`` and ``flavor``.

      The database requires file storage to store the actual molecule
      data. Therefore, if given a :ref:`oeistream <OEPlatform_oeistream>`, the
      stream's data will be copied to a temporary file. The temporary
      file will be automatically deleted by the destructor of this
      class.

      :ref:`oemolistream <OEChem_oemolistream>` may not need a temporary file if
      they were opened on an actual file.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolDatabase & operator=(const OEMolDatabase &)

      Assignment operator.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Removes all generic by calling through to
      :oe:meth:`OESystem::OEBase::Clear` as well as resetting the
      database back to an un-initialized state, the same state as the
      default constructor.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

      Creates a copy of the database pointing to the same backing file
      store as the original. The copy is invalid if the original is
      destroyed.

      .. warning::

         It is not recommended to use this method. It is only
         implemented to adhere to the :ref:`OEBase <OESystem_OEBase>` API.

   .. oe:method:: Delete

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Delete(unsigned int idx)
            bool Delete(const std::vector<unsigned int>& indices)
            bool Delete(const OESystem::OEUnaryPredicate<OEMolBase>& pred)
            bool Delete(const OESystem::OEUnaryPredicate<OEMCMolBase>& pred)

      .. oe:language:: python

         .. oe:api:: python

            Delete(idx: int) -> bool
            Delete(indices: OEUIntVector) -> bool
            Delete(pred: OEUnaryMolBasePred) -> bool
            Delete(pred: OEUnaryPredicate[OEMol]) -> bool

      Mark the given molecules as "deleted" in the database in
      constant time, ``O(1)``. Deleted molecules will not be written
      during a :oe:meth:`Save<OEChem::OEMolDatabase::Save>`
      operation. Deleted molecules will return ``false`` when accessed
      from the :oe:meth:`OEChem::OEMolDatabase::GetMolecule` method.

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

      Return an opaque value representing the data type of this class.

   .. oe:method:: GetFlavor

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFlavor() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlavor() -> int

      Returns ``0`` if uninitialized. Returns the flavor used to
      interpret the molecules in this database, pulled from the
      :oe:constns:`OEChem::OEIFlavor` namespace associated with the
      format returned from the
      :oe:meth:`OEChem::OEMolDatabase::GetFormat` method.

   .. oe:method:: GetFormat

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFormat() const

      .. oe:language:: python

         .. oe:api:: python

            GetFormat() -> int

      Returns the format used to interpret the molecules in the file
      this database was opened on. The value returned is a member of
      the :ref:`the OEFormat namespace <OEChem_OEFormat>`.

   .. oe:method:: GetIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetIdx(unsigned int row)

      .. oe:language:: python

         .. oe:api:: python

            GetIdx(row: int) -> int

      Returns the index for the nth ``row`` in the
      database. ``row`` should be less than
      :oe:meth:`OEChem::OEMolDatabase::NumMols` and the value returned
      will be less than
      :oe:meth:`OEChem::OEMolDatabase::GetMaxMolIdx`. By default, row
      numbers are the same as their index. Row numbers can be changed
      by deleting or re-ordering the database. If row numbers were
      altered before this call, this call is
      ``O(GetMaxMolIdx())``. After the first call to ``GetIdx``,
      subsequent calls are ``O(1)``, until another alteration is made
      to the database.

      This is the reverse operation from
      :oe:meth:`OEChem::OEMolDatabase::GetRow`.

   .. oe:method:: GetIdxs

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<unsigned int>* GetIdxs() const
            bool GetIdxs(std::vector<unsigned int>& indices) const

      .. oe:language:: python

         .. oe:api:: python

            GetIdxs() -> Iterable[int]
            GetIdxs(indices: OEUIntVector) -> bool

      Returns all the valid indices in the order that is currently
      considered the database order by this object.

   .. oe:method:: GetMaxMolIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxMolIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMolIdx() -> int

      Returns one more than the maximum molecule index this database
      currently contains.

   .. oe:method:: GetMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMolecule(OEMolBase& mol, unsigned int idx) const
            bool GetMolecule(OEMCMolBase& mol, unsigned int idx) const
            bool GetMolecule(oemolostream& ostr, unsigned int idx) const

      .. oe:language:: python

         .. oe:api:: python

            GetMolecule(mol: Union[OEGraphMol,OEQMol], idx: int) -> bool
            GetMolecule(mol: OEMol, idx: int) -> bool
            GetMolecule(ofs: oemolostream, idx: int) -> bool

      Read the molecule located at index ``idx`` into the molecule
      ``mol``. If the file format is a multi-conformer :file:`.oeb`
      file, only the first will be read if ``mol`` is an
      :ref:`OEMolBase <OEChem_OEMolBase>`. If there is a need for handling
      multi-conformer molecules, the :ref:`OEMCMolBase <OEChem_OEMCMolBase>`
      overload should be used instead.

      .. warning::

         The overload that takes an :ref:`oemolostream <OEChem_oemolostream>` is
         deprecated as of 2015.Jun and will be removed in a future
         version of **OEChem TK**, please use
         :oe:meth:`OEChem::OEMolDatabase::WriteMolecule` instead.

         The overload that takes an :ref:`oemolostream <OEChem_oemolostream>` will
         write bytes for the molecule record at index ``idx`` to the
         stream ``ostr``. No attempt will be made to interpret the data
         as a molecule and verify whether it is truly a parsable
         molecule. The molecule will be in whatever format the database
         was opened on.

   .. oe:method:: GetMoleculeString

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetMoleculeString(unsigned int idx) const

      .. oe:language:: python

         .. oe:api:: python

            GetMoleculeString(idx: int) -> bytes

      Return the chunk of data from the molecule file that corresponds
      to the molecule record at index ``idx``.

      .. oe:language:: python

         In **Python** the :oe:meth:`OEChem::OEMolDatabase::GetMoleculeString`
         method returns ``bytes``.

   .. oe:language:: python

      .. oe:method:: GetOEGraphMols

         .. oe:api::

            GetOEGraphMols() -> <generator of OEGraphMol objects>

         Returns a generator over all the non-deleted molecules in the
         :ref:`OEMolDatabase <OEChem_OEMolDatabase>` in the current order. By
         default, the molecule database order is defined by the file,
         but can be altered by
         :oe:meth:`OEChem::OEMolDatabase::Order`. Each molecule will be
         an :ref:`OEGraphMol <OEChem_OEGraphMol>` object. If opened on a
         multi-conformer :file:`.oeb` file, only the first conformer
         will be returned for each molecule record.

         .. note::

            Unlike ``OEChem::oemolistream::GetOEGraphMols``, a new
            molecule object will be returned upon each iteration, reducing
            the need to create molecule copies when keeping the molecules
            around.

      .. oe:method:: GetOEMols

         .. oe:api::

            GetOEMols() -> <generator of OEMol objects>

         Returns a generator over all the non-deleted molecules in the
         :ref:`OEMolDatabase <OEChem_OEMolDatabase>` in the current order. By
         default, the molecule database order is defined by the file,
         but can be altered by
         :oe:meth:`OEChem::OEMolDatabase::Order`. Each molecule will be
         an :ref:`OEMol <OEChem_OEMol>` object.

         .. note::

            Unlike :oe:meth:`OEChem::oemolistream::GetOEMols`, a new
            molecule object will be returned upon each iteration, reducing
            the need to create molecule copies when keeping the molecules
            around.

   .. oe:method:: GetRow

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRow(unsigned int idx)

      .. oe:language:: python

         .. oe:api:: python

            GetRow(idx: int) -> int

      Return where the database considers the molecule record ``idx``
      to reside in the global order of the database. ``idx`` should be
      less than :oe:meth:`OEChem::OEMolDatabase::GetMaxMolIdx` and the
      value returned will be less than
      :oe:meth:`OEChem::OEMolDatabase::NumMols`. By default, row
      numbers are the same as their index. Row numbers can be changed
      by deleting or re-ordering the database. If row numbers were
      altered before this call, this call is
      ``O(GetMaxMolIdx())``. After the first call to ``GetIdx``,
      subsequent calls are ``O(1)``, until another alteration is made
      to the database.

      This is the reverse operation from
      :oe:meth:`OEChem::OEMolDatabase::GetIdx`.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetTitle(unsigned int idx) const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle(idx: int) -> str

      Returns the title for the molecule at index ``idx`` in the
      database. This is the same value that is returned by
      :oe:meth:`OEChem::OEMolBase::GetTitle`, but without the need to
      parse the whole molecule record into an :ref:`OEMolBase <OEChem_OEMolBase>`.

   .. oe:method:: GetTitles

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<const std::string>* GetTitles() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitles() -> Iterable[str]

      Returns all the titles for the database as would be returned by
      :oe:meth:`OEChem::OEMolDatabase::GetTitle` in database index
      order.

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

      Returns whether the opaque data passed represents the same data
      type as this class.

   .. oe:method:: IsDeleted

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDeleted(unsigned int idx) const

      .. oe:language:: python

         .. oe:api:: python

            IsDeleted(idx: int) -> bool

      Returns whether the database index ``idx`` has already been
      deleted by a previous call to
      :oe:meth:`OEChem::OEMolDatabase::Delete`.

   .. oe:method:: NumMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumMols() const

      .. oe:language:: python

         .. oe:api:: python

            NumMols() -> int

      Returns the number of molecule **records** in the database.

      .. note::

         The number of valid molecules in the database might be less than
         the number returned by :oe:meth:`OEChem::OEMolDatabase::NumMols`.
         The reason is that the molecule file is not fully parsed when invoking the
         :oe:meth:`OEChem::OEMolDatabase::NumMols` function.

   .. oe:method:: Open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Open(OEChem::oemolistream& ifs)
            bool Open(const std::string& filename)
            bool Open(const std::string& filename, unsigned int format)
            bool Open(OEPlatform::oeistream& istr, unsigned int format)
            bool Open(const std::string& filename, unsigned int format,
                      unsigned int flavor)
            bool Open(OEPlatform::oeistream& istr, unsigned int format,
                      unsigned int flavor)

      .. oe:language:: python

         .. oe:api:: python

            Open(ifs: oemolistream) -> bool
            Open(filename: str) -> bool
            Open(filename: str, format: int) -> bool
            Open(istr: oeistream, format: int) -> bool
            Open(filename: str, format: int, flavor: int) -> bool
            Open(istr: oeistream, format: int, flavor: int) -> bool

      Initializes the database to the file name given.  The database
      requires file storage to store the actual molecule
      data. Therefore, if given a :ref:`oeistream <OEPlatform_oeistream>`, the
      stream's data will be copied to a temporary file. The temporary
      file will be automatically deleted by the destructor of this
      class.

      :ref:`oemolistream <OEChem_oemolistream>` may not need a temporary file if
      they were opened on an actual file.

      This method is expensive, it may require scanning the whole file
      to determine the proper file offsets to the individual molecule
      records. To speed up the ``Open`` operation, :file:`.idx` files
      can be generated by :oe:func:`OEChem::OECreateMolDatabaseIdx` or
      :oe:meth:`OEChem::OEMolDatabase::Save`. If ``Open`` detects the
      presence of an :file:`.idx` file parallel to the database file,
      the file offsets will be read directly from this file instead,
      possibly saving the need to stream the entire database from disk.

      .. seealso::

         :ref:`section_index_files` section

   .. oe:method:: Order

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Order(const std::vector<unsigned int>& indices)

      .. oe:language:: python

         .. oe:api:: python

            Order(indices: OEUIntVector) -> bool

      Re-orders the molecules in the database according to the order
      of the indices specified by ``indices``. Subsequent calls to
      :oe:meth:`OEChem::OEMolDatabase::GetIdx` or
      :oe:meth:`OEChem::OEMolDatabase::GetRow` will return this
      order. Subsequent calls to :oe:meth:`OEChem::OEMolDatabase::Save`
      will output the database in this order.

   .. oe:method:: Save

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Save(const std::string& filename, unsigned int format) const
            bool Save(OEPlatform::oeostream& ostr, unsigned int format) const
            bool Save(const std::string& filename, unsigned int format,
                      unsigned int flavor) const
            bool Save(OEPlatform::oeostream& ostr, unsigned int format,
                      unsigned int flavor) const
            bool Save(OEChem::oemolostream& ofs,
                      const OEMolDatabaseSaveOptions& opts = OEMolDatabaseSaveOptions()) const
            bool Save(const std::string& filename,
                      const OEMolDatabaseSaveOptions& opts = OEMolDatabaseSaveOptions()) const

      .. oe:language:: python

         .. oe:api:: python

            Save(filename: str, format: int) -> bool
            Save(ostr: oeostream, format: int) -> bool
            Save(filename: str, format: int, flavor: int) -> bool
            Save(ostr: oeostream, format: int, flavor: int) -> bool
            Save(ofs: oemolostream,
                 opts: OEMolDatabaseSaveOptions = OEMolDatabaseSaveOptions()) -> bool
            Save(filename: str,
                 opts: OEMolDatabaseSaveOptions = OEMolDatabaseSaveOptions()) -> bool

      Save the database to the file specified by ``filename`` in the
      ``format`` and ``flavor`` specified. The data may be written
      directly to the stream ``ostr`` as well.

      This method is heavily optimized for the case whenever the
      output file format is the same as the input file format used to
      initialize the database. If the same file format is used, the
      molecule record's bytes will be streamed directly, without an
      intermediate :ref:`OEMolBase <OEChem_OEMolBase>` to do the conversion.

      .. seealso::

         * :ref:`OEMolDatabaseSaveOptions <OEChem_OEMolDatabaseSaveOptions>` class for more
           options when saving a database to a file.
         * :oe:meth:`OEChem::OEGetMolDatabaseIdxFileName` to retrieve
           the default filename used for the index file generated.

      .. warning::

         Since :ref:`OEMolDatabase <OEChem_OEMolDatabase>` depends on backing file
         storage. Therefore, if the contents of the file change after
         :oe:meth:`OEChem::OEMolDatabase::Open` completes, the
         behavior is undefined. It is very likely the file data itself
         will be corrupted. For this reason,
         :oe:meth:`OEChem::OEMolDatabase::Save` will fail to write to
         the same file name used to open the database object. This
         protects against the common case, but does not protect
         against the general case of file changing during access.

   .. oe:method:: WriteMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool WriteMolecule(oemolostream& ostr, unsigned int idx) const

      .. oe:language:: python

         .. oe:api:: python

            WriteMolecule(ofs: oemolostream, idx: int) -> bool

      Write bytes for the molecule record at index ``idx`` to the
      stream ``ostr``. No attempt will be made to interpret the data
      as a molecule and verify whether it is truly a parsable
      molecule. The molecule will be in whatever format the database
      was opened on. Returns ``false`` if the
      :ref:`oemolostream <OEChem_oemolostream>` is not the exact same file format
      as the :ref:`OEMolDatabase <OEChem_OEMolDatabase>` or any input/output
      operation fails.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMolDatabaseSaveOptions, MolDatabaseSaveOptions

.. _OEChem_OEMolDatabaseSaveOptions:

.. oe:class:: OEMolDatabaseSaveOptions

   .. oe:api::

      class OEMolDatabaseSaveOptions

   The class used to contain additional options for the
   :oe:meth:`OEChem::OEMolDatabase::Save` method.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolDatabaseSaveOptions()
            OEMolDatabaseSaveOptions(unsigned int format, unsigned int flavor,
                                     bool writeIdx,
                                     const std::string& idxFileName)

      .. oe:language:: python

         .. oe:api:: python

            OEMolDatabaseSaveOptions() -> OEMolDatabaseSaveOptions
            OEMolDatabaseSaveOptions(format: int, flavor: int, writeIdx: bool,
                                     idxFileName: str) -> OEMolDatabaseSaveOptions

      The default constructor initializes the object to the following: 

      *format* :oe:const:`OEChem::OEFormat::UNDEFINED`
      
      *flavor* ``0``
      
      *writeIdx* ``true``

      *idxFileName* Empty string

   .. oe:method:: GetFlavor

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFlavor() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlavor() -> int

      Returns a constant from the :oe:constns:`OEChem::OEOFlavor`
      namespace for the format being saved to. 

   .. oe:method:: GetFormat

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFormat() const

      .. oe:language:: python

         .. oe:api:: python

            GetFormat() -> int

      Returns a constant from the :ref:`the OEFormat namespace <OEChem_OEFormat>`
      namespace.

   .. oe:method:: GetIdxFileName

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetIdxFileName() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdxFileName() -> str

      Returns the name of the index file being written to. If this
      file name is empty and
      :oe:meth:`OEChem::OEMolDatabaseSaveOptions::GetWriteIdx` returns
      ``true``, the file name will be automatically determined with
      the same rules as :oe:func:`OEChem::OEGetMolDatabaseIdxFileName`. 

      .. seealso::

         * :oe:func:`OEChem::OEGetMolDatabaseIdxFileName`
         * :oe:func:`OEChem::OECreateMolDatabaseIdx`

   .. oe:method:: GetWriteIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetWriteIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetWriteIdx() -> bool

      Returns whether an index file should be created as well. 

   .. oe:method:: SetFlavor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFlavor(unsigned int flvr)

      .. oe:language:: python

         .. oe:api:: python

            SetFlavor(flvr: int) -> None

      Specifies what the file format flavor the database should be
      saved to. ``flvr`` should be a value from the
      :oe:constns:`OEChem::OEOFlavor` namespace.

   .. oe:method:: SetFormat

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFormat(unsigned int fmt)

      .. oe:language:: python

         .. oe:api:: python

            SetFormat(fmt: int) -> None

      Specifies what file format the database should be saved
      to. ``fmt`` should be a value from the
      :ref:`the OEFormat namespace <OEChem_OEFormat>`.

   .. oe:method:: SetIdxFileName

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetIdxFileName(const std::string& f)

      .. oe:language:: python

         .. oe:api:: python

            SetIdxFileName(f: str) -> None

      Specifies what the index file name should be. 

      .. seealso:: 

         :ref:`section_index_files`

   .. oe:method:: SetWriteIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetWriteIdx(bool w)

      .. oe:language:: python

         .. oe:api:: python

            SetWriteIdx(w: bool) -> None

      Specifies whether an index file should be created during the
      database save operation.



.. oe:namespace:: OEChem

.. _OEChem_OEMolGDPropertyFxn:

.. oe:class:: OEMolGDPropertyFxn

   .. oe:api::

      class OEMolGDPropertyFxn : public OEMolPropertyFxn

   This class can be used to access molecule properties defined
   as generic data in a molecule.

   The following methods are publicly inherited from :ref:`OEMolPropertyFxn <OEChem_OEMolPropertyFxn>`:
   
   =========================================================== =========================================================== =========================================================== 
   :oe:meth:`CreateCopy<OEChem::OEMolPropertyFxn::CreateCopy>` :oe:meth:`Get<OEChem::OEMolPropertyFxn::Get>`               :oe:meth:`Has<OEChem::OEMolPropertyFxn::Has>`
   =========================================================== =========================================================== =========================================================== 
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolGDPropertyFxn(const std::string& tag)
            OEMolGDPropertyFxn(const OEMolGDPropertyFxn &)

      .. oe:language:: python

         .. oe:api:: python

            OEMolGDPropertyFxn(tag: str) -> OEMolGDPropertyFxn
            OEMolGDPropertyFxn(arg2: OEMolGDPropertyFxn) -> OEMolGDPropertyFxn

      Default and copy constructors. The tag parameter referes to the generic data tag 
      corresponding to the property of interest.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolGDPropertyFxn &operator=(const OEMolGDPropertyFxn &)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMolParameter, MolParameter

.. _OEChem_OEMolParameter:

.. oe:class:: OEMolParameter

   .. oe:api::

      class OEMolParameter : public OESystem::OEPointerParameter<OEMolBase>

   The :ref:`OEMolParameter <OEChem_OEMolParameter>` represents parameter that has value
   of :ref:`OEMolBase <OEChem_OEMolBase>` type.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   The :ref:`OEMolParameter <OEChem_OEMolParameter>` class defines the following public methods:
    * :oe:meth:`GetSetting<OEChem::OEMolParameter::GetSetting>`
    * :oe:meth:`GetValue<OEChem::OEMolParameter::GetValue>`
    * :oe:meth:`SetValue<OEChem::OEMolParameter::SetValue>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolParameter()
            OEMolParameter(const std::string& name)
            OEMolParameter(const OEMolParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEMolParameter(name: str) -> OEMolParameter
            OEMolParameter() -> OEMolParameter
            OEMolParameter(arg2: OEMolParameter) -> OEMolParameter

      Default and copy constructors.

      Constructs an :ref:`OEMolParameter <OEChem_OEMolParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolParameter &operator=(const OEMolParameter &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetSetting

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase& GetSetting() const

      .. oe:language:: python

         .. oe:api:: python

            GetSetting() -> OEGraphMol

      Returns the current setting of the parameter.

   .. oe:method:: GetValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase& GetValue() const

      .. oe:language:: python

         .. oe:api:: python

            GetValue() -> OEGraphMol

      Returns the current user-defined value of the parameter.

   .. oe:method:: SetValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetValue(OEChem::oemolistream& fstream)
            bool SetValue(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            SetValue(fstream: oemolistream) -> bool
            SetValue(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets the user-defined value of the parameter.  For the overload with the ``OEChem::oemolistream``,
      the first molecule is used as the value.



.. oe:namespace:: OEChem

.. _OEChem_OEMolPropertyFxn:

.. oe:class:: OEMolPropertyFxn

   .. oe:api::

      class OEMolPropertyFxn

   The :ref:`OEMolPropertyFxn <OEChem_OEMolPropertyFxn>` is an abstract base class. This class defines
   the interface for functions which can be used to access molecule properties defined
   as SDF file data fields or generic data in a molecule.
   

   The following classes derive from this class:
    * :ref:`OEMolGDPropertyFxn <OEChem_OEMolGDPropertyFxn>`
    * :ref:`OEMolSDPropertyFxn <OEChem_OEMolSDPropertyFxn>`
    * :ref:`OEMolTaggedPropertyFxn <OEChem_OEMolTaggedPropertyFxn>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolPropertyFxn & operator=(const OEMolPropertyFxn &)

      Assignment operator.

   

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolPropertyFxn* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMolPropertyFxn

      A virtual constructor which allows copying of concrete derived objects using a reference 
      to this base class.

   .. oe:method:: Get

      .. oe:language:: c++ java csharp

         .. oe:api::

            double Get(const OEChem::OEMolBase& mol) const = 0
            double Get(const OEChem::OEMCMolBase& mol) const = 0

      .. oe:language:: python

         .. oe:api:: python

            Get(mol: Union[OEGraphMol,OEQMol]) -> float
            Get(mol: OEMol) -> float

      Returns the property value for the specified molecule. Method returns a large number
      (limiting large double in C++) when a value is not found.

   .. oe:method:: Has

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Has(const OEChem::OEMolBase& mol) const = 0
            bool Has(const OEChem::OEMCMolBase& mol) const = 0

      .. oe:language:: python

         .. oe:api:: python

            Has(mol: Union[OEGraphMol,OEQMol]) -> bool
            Has(mol: OEMol) -> bool

      Checks if the property value exists for the specified molecule. Returns ``True`` if 
      a value exists.



.. oe:namespace:: OEChem

.. _OEChem_OEMolPropertyList:

.. oe:class:: OEMolPropertyList

   .. oe:api::

      class OEMolPropertyList

   This class is a container for multiple :ref:`OEMolPropertyFxn <OEChem_OEMolPropertyFxn>` objects.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolPropertyList()
            OEMolPropertyList(const OEMolPropertyList &)

      .. oe:language:: python

         .. oe:api:: python

            OEMolPropertyList() -> OEMolPropertyList
            OEMolPropertyList(arg2: OEMolPropertyList) -> OEMolPropertyList

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolPropertyList &operator=(const OEMolPropertyList &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: Add

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Add(const OEMolPropertyFxn &)

      .. oe:language:: python

         .. oe:api:: python

            Add(arg2: OEMolPropertyFxn) -> None

      Adds a copy of the specified property function to the list.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Clears the list of property functions.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolPropertyList* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMolPropertyList

      Returns a copy of this :ref:`OEMolPropertyList <OEChem_OEMolPropertyList>` object.

   .. oe:method:: GetProperty

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetProperty(const OEChem::OEMolBase &, size_t index) const
            double GetProperty(const OEChem::OEMCMolBase &, size_t index) const

      .. oe:language:: python

         .. oe:api:: python

            GetProperty(arg2: Union[OEGraphMol,OEQMol], index: int) -> float
            GetProperty(arg2: OEMol, index: int) -> float

      Returns the property value for the specified molecule, for the function 
      located at the specified index in the list. Method returns a large number
      (limiting large double in C++) when a value is not found.

   .. oe:method:: GetSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t GetSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetSize() -> int

      Returns the current number of :ref:`OEMolPropertyFxn <OEChem_OEMolPropertyFxn>` objects
      in the list.

   .. oe:method:: HasProperties

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasProperties(const OEChem::OEMolBase &) const
            bool HasProperties(const OEChem::OEMCMolBase &) const

      .. oe:language:: python

         .. oe:api:: python

            HasProperties(arg2: Union[OEGraphMol,OEQMol]) -> bool
            HasProperties(arg2: OEMol) -> bool

      Checks if the all of the property values exist for the specified molecule. 
      Returns ``False`` if at least of the property value does not exist.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMolReaderParameter, MolReaderParameter

.. _OEChem_OEMolReaderParameter:

.. oe:class:: OEMolReaderParameter

   .. oe:api::

      class OEMolReaderParameter : public OESystem::OEStringParameter

   The :ref:`OEMolReaderParameter <OEChem_OEMolReaderParameter>` represents parameter that has ``string`` value
   representing a readable molecule file format.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OETypedParameter <OESystem_OETypedParameter>`:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   Following methods are publicly inherited from :ref:`OEPODParameter <OESystem_OEPODParameter>`:
    * :ref:`GetDefaultsVector <OESystem_GetDefaultsVector>`
    * :ref:`GetSettingsVector <OESystem_GetSettingsVector>`
    * :ref:`GetValuesVector <OESystem_GetValuesVector>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolReaderParameter()
            OEMolReaderParameter(const std::string& name,
                                 const bool is3D = false)
            OEMolReaderParameter(const OEMolReaderParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEMolReaderParameter(name: str, is3D: bool = False) -> OEMolReaderParameter
            OEMolReaderParameter() -> OEMolReaderParameter
            OEMolReaderParameter(arg2: OEMolReaderParameter) -> OEMolReaderParameter

      Default and copy constructors.

      Constructs an :ref:`OEMolReaderParameter <OEChem_OEMolReaderParameter>` instance using the specified set of parameters.
      The optional boolean argument referes to if the readable file format must contain 3D molecule.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolReaderParameter &operator=(const OEMolReaderParameter &)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDataFlow

.. attention::

   |TWOLANGUAGE|

.. meta::
   :keywords: OEMolRecord OERecord datarecord

.. _OEDataFlow_OEMolRecord:

.. oe:class:: OEMolRecord

   .. seealso::

      * :ref:`chapter_oemolrecord` chapter

   .. oe:language:: c++

      .. attention::

        |TWOLANGUAGE|

      .. oe:api::

         class OEMolRecord

      The :ref:`OEMolRecord <OEDataFlow_OEMolRecord>` class is a subclass of
      :ref:`OERecord <OEDataFlow_OERecord>`, with additional convenience
      methods for handling molecules. All public methods from
      :ref:`OERecord <OEDataFlow_OERecord>` are inherited. This class has
      a "primary" molecule field, to which several convenience methods apply.

      .. ################################################################
         # Constructors
         ################################################################

      .. oe:method:: Constructors

         .. oe:api::

            OEMolRecord()

         The default constructor initializes the record object to an empty
         record with no fields or values.

         .. oe:api::

            OEMolRecord(const OERecord& rhs)

         Copy constructor. OEMolRecords can be constructed from OERecords,
         and vice versa, without any loss of data.

      .. ################################################################
         #
         ################################################################

      .. oe:method:: GetPrimaryMolField

         .. oe:api::

            OEField<OEChem::OEMol> GetPrimaryMolField(const std::string defName = "Molecule",
                                                      OEFieldMeta meta = OEFieldMeta()) const

         Retrieves the primary molecule field from the record. If no primary
         molecule field exists, this will return a field of type
         Types::Chem::Molecule with the name "Molecule".

         defName
           The name to be used for the molecule field if a primary molecule
           field doesn't already exist ont he record.

         meta
           An optional OEFieldMeta object specifying metadata for the field.

      .. seealso::

         * :ref:`OEField <OEDataFlow_OEField>`

      .. ################################################################
         #
         ################################################################

      .. oe:method:: GetMol

         .. oe:api::

            OEChem::OEMol GetMol(OEFieldBase field = OEFieldBase()) const

         Retrieves a molecule from the record. If no field is specified, the
         record's primary molecule is returned. If no primary molecule exists,
         an default-constructed (empty) OEMol is returned.

         field
           The field to retrieve the molecule from. If this is omitted, the
           record's primary molecule will be returned.

      .. seealso::

         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>`

      .. ################################################################
         #
         ################################################################

      .. oe:method:: HasMol

         .. oe:api::

            bool HasMol(OEFieldBase field = OEFieldBase()) const

         Returns true if the record has a molecule in the specified field,
         or a primary molecule if no field is supplied.

         field
           The field to check for the presence of a molecule. If this is
           omitted, the record's primary molecule will be used.

      .. seealso::

         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>`

      .. ################################################################
         #
         ################################################################

      .. _OEDataFlow_SetMol_CPP:

      .. oe:method:: SetMol

         .. oe:api::

            bool SetMol(const OEChem::OEMol& mol,
                        OEFieldBase field = OEFieldBase(),
                        OEFieldMeta meta = OEFieldMeta())

         Sets a molecule on the record using the specified field. If no field
         is supplied, the primary molecule is set.

         mol
           The molecule to be copied to the record.

         field
           The field to store the molecule on. If this is omitted, the molecule
           will be stored as the record's primary molecule.

         meta
           Optional metadata to store on the field.

      .. seealso::

         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` class
         * :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` class

      .. ################################################################
         #
         ################################################################

      .. oe:method:: GetMolPointer

         .. oe:api::

            OEChem::OEMol* GetMolPointer(OEFieldBase field = OEFieldBase())

         Returns a pointer to the molecule from the specified field on the
         record, or to the primary molecule if no field is supplied. If no
         such molecule exists on the record, a null pointer is returned.

         field
           The field from which the molecule pointer is obtained. If this
           argument is omitted, a pointer to the primary molecule is returned.

      .. seealso::

         * :oe:meth:`OEDataFlow::OEMolRecord::HasMol` method
         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` class

      .. note::

         This method will return a pointer to the actual molecule on the record,
         so any modifications to this molecule will affect the record contents.
         Accessing this pointer after the record has been destroyed will have
         undefined results.

      .. ################################################################
         #
         ################################################################

      .. oe:method:: SetMolReference

         .. oe:api::

            bool SetMolReference(OEChem::OEMol& mol,
                                 OEFieldBase field = OEFieldBase(),
                                 OEFieldMeta meta = OEFieldMeta())

         This method puts a pointer to the passed OEMol onto the record, in
         the specified field. If no field is provided, the record's primary
         molecule is set. While the
         :ref:`SetMol <OEDataFlow_SetMol_CPP>` method places
         a *copy* of the passed molecule onto the record, this method avoids
         creating a copy, and may in some cases improve performance.

         mol
           The molecule to be placed on the record.

         field
           The field to store the molecule in. If this is omitted the molecule
           will be stored in the record's primary molecule field.

         meta
           Optional metadata to be stored on the field.

      .. seealso::

         * :oe:meth:`OEDataFlow::OEMolRecord::SetMol` method
         * :oe:meth:`OEDataFlow::OEMolRecord::GetMolPointer` method
         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` class
         * :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` class

      .. ################################################################
         #
         ################################################################

      .. oe:method:: GetConfRecord

         .. oe:api::

            OERecord GetConfRecord(const OEChem::OEConfBase* conf) const

         Returns a record for the provided conformer. OEMolRecord provides a
         mechanism for storing a record of data for each conformer. If the
         passed conformer doesn't already have a record associated with it,
         this will return an empty OERecord.

         conf
           The conformer the record will be associated with.

      .. ################################################################
         #
         ################################################################

      .. oe:method:: SetConfRecord

         .. oe:api::

            void SetConfRecord(const OEChem::OEConfBase* conf,
                               OERecord& childRecord)

         This method associates data on a record with a conformer. The
         conformer's parent molecule must be stored in a field on the parent
         record *after* this method is called, or stored using the
         :oe:meth:`OEDataFlow::OEMolRecord::SetMolReference` method.
         Otherwise, the conformer data will be lost during serialization.

         childRecord
           A record containing data for the conformer.

      .. seealso::

         * :oe:meth:`OEDataFlow::OEMolRecord::GetConfRecord`
         * :oe:meth:`OEDataFlow::OEMolRecord::SetMolReference`

   .. oe:language:: python

      .. oe:api::

         class OEMolRecord

      The :ref:`OEMolRecord <OEDataFlow_OEMolRecord>` class is a subclass of
      :ref:`OERecord <OEDataFlow_OERecord>`, with additional convenience
      methods for handling molecules. All public methods from
      :ref:`OERecord <OEDataFlow_OERecord>` are inherited. This class has
      a "primary" molecule field, to which several convenience methods apply.

      .. ################################################################
         # Constructors
         ################################################################

      .. oe:method:: Constructors

         .. oe:api::

            OEMolRecord()

         The default constructor initializes the record object to an empty
         record with no fields or values.

         .. oe:api::

            OEMolRecord(const OERecord &rhs)

         Copy constructor. OEMolRecords can be constructed from OERecords,
         and vice versa, without any loss of data.

      .. ################################################################
         #
         ################################################################

      .. oe:method:: get_primary_mol_field

         .. oe:api::

            get_primary_mol_field(def_name: str = "Molecule",
                                  meta: OEFieldMeta = None) -> object

         Retrieves the primary molecule field from the record. If no primary
         molecule field exists, this will return a field of type
         Types.Chem.Molecule with the name "Molecule".

         def_name
           The name to be used for the molecule field if a primary molecule
           field doesn't already exist ont he record.

         meta
           An optional OEFieldMeta object specifying metadata for the field.

      .. seealso::

         * :ref:`OEField <OEDataFlow_OEField>`

      .. ################################################################
         #
         ################################################################

      .. oe:method::  get_mol

         .. oe:api::

            get_mol(field: OEFieldBase) -> OEMol

         Retrieves a molecule from the record. If no field is specified, the
         record's primary molecule is returned. If no primary molecule exists,
         None is returned.

         field
           The field to retrieve the molecule from. If this is omitted, the
           record's primary molecule will be returned.

      .. seealso::

         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>`

      .. ################################################################
         #
         ################################################################

      .. oe:method:: has_mol

         .. oe:api::

            has_mol(field: OEFieldBase = None) -> bool

         Returns True if the record has a molecule in the specified field,
         or a primary molecule if no field is supplied.

         field
           The field to check for the presence of a molecule. If this is
           omitted, the record's primary molecule will be used.

      .. seealso::

         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>`

      .. ################################################################
         #
         ################################################################

      .. _OEDataFlow_SetMol_Python:

      .. oe:method:: set_mol

         .. oe:api::

            set_mol(mol: OEMol, field: OEFieldBase = None,
                    meta: OEFieldMeta = None) -> bool

         Sets a molecule on the record using the specified field. If no field
         is supplied, the primary molecule is set.

         mol
           The molecule to be copied to the record.

         field
           The field to store the molecule on. If this is omitted, the molecule
           will be stored as the record's primary molecule.

         meta
           Optional metadata to store on the field.

      .. seealso::

         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` class
         * :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` class

      .. ################################################################
         #
         ################################################################

      .. _get_mol_reference:

      .. oe:method:: get_mol_reference

         .. oe:api::

            get_mol_reference(field: OEFieldBase = None) -> OEMol

         Returns a reference to the molecule from the specified field on the
         record, or to the primary molecule if no field is supplied. If no
         such molecule exists on the record, None is returned.

         field
           The field from which the molecule pointer is obtained. If this
           argument is omitted, a pointer to the primary molecule is returned.

      .. seealso::

         * :oe:meth:`OEDataFlow::OEMolRecord::has_mol` method
         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` class

      .. note::

         This method will return a reference to the actual molecule on the
         record, so any modifications to this molecule will affect the record
         contents.

      .. ################################################################
         #
         ################################################################

      .. oe:method:: set_mol_reference

         .. oe:api::

            set_mol_reference(mol: OEMol, field: OEFieldBase = None,
                              meta: OEFieldMeta = None) -> bool

         This method puts a reference to the passed OEMol onto the record, in
         the specified field. If no field is provided, the record's primary
         molecule is set. While the :ref:`SetMol <OEDataFlow_SetMol_Python>` method places
         a *copy* of the passed molecule onto the record, this method avoids
         creating a copy, and may in some cases improve performance.

         mol
           The molecule to be placed on the record.

         field
           The field to store the molecule in. If this is omitted the molecule
           will be stored in the record's primary molecule field.

         meta
           Optional metadata to be stored on the field.

      .. seealso::

         * :oe:meth:`OEDataFlow::OEMolRecord::set_mol` method
         * :oe:meth:`OEDataFlow::OEMolRecord::get_mol_reference` method
         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` class
         * :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` class

      .. ################################################################
         #
         ################################################################

      .. oe:method:: get_conf_record

         .. oe:api::

            get_conf_record(conf: OEConfBase) -> OERecord

         Returns a record for the provided conformer. OEMolRecord provides a
         mechanism for storing a record of data for each conformer. If the
         passed conformer doesn't already have a record associated with it,
         this will return an empty OERecord.

         conf
           The conformer the record will be associated with.

      .. ################################################################
         #
         ################################################################

      .. oe:method:: set_conf_record

         .. oe:api::

            set_conf_record(conf: OEConfBase, child_record: OERecord) -> null

         This method associates data on a record with a conformer. The
         conformer's parent molecule must be stored in a field on the parent
         record *after* this method is called, or stored using the
         :oe:meth:`OEDataFlow::OEMolRecord::set_mol_reference` method.
         Otherwise, the conformer data will be lost during serialization.

         child_record
           A record containing data for the conformer.

      .. seealso::

         * :oe:meth:`OEDataFlow::OEMolRecord::get_conf_record`
         * :oe:meth:`OEDataFlow::OEMolRecord::set_mol_reference`



.. oe:namespace:: OEChem

.. _OEChem_OEMolSDPropertyFxn:

.. oe:class:: OEMolSDPropertyFxn

   .. oe:api::

      class OEMolSDPropertyFxn : public OEMolPropertyFxn

   This class can be used to access molecule properties defined
   as SD data in a molecule.

   The following methods are publicly inherited from :ref:`OEMolPropertyFxn <OEChem_OEMolPropertyFxn>`:
   
   =========================================================== =========================================================== =========================================================== 
   :oe:meth:`CreateCopy<OEChem::OEMolPropertyFxn::CreateCopy>` :oe:meth:`Get<OEChem::OEMolPropertyFxn::Get>`               :oe:meth:`Has<OEChem::OEMolPropertyFxn::Has>`
   =========================================================== =========================================================== =========================================================== 
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolSDPropertyFxn(const std::string& tag)
            OEMolSDPropertyFxn(const OEMolSDPropertyFxn &)

      .. oe:language:: python

         .. oe:api:: python

            OEMolSDPropertyFxn(tag: str) -> OEMolSDPropertyFxn
            OEMolSDPropertyFxn(arg2: OEMolSDPropertyFxn) -> OEMolSDPropertyFxn

      Default and copy constructors. The tag parameter referes to the SD data tag 
      corresponding to the property of interest.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolSDPropertyFxn &operator=(const OEMolSDPropertyFxn &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMolStyleColorer, OE3DMolStyleColorer, MolStyleColorer, StyleColorer

.. _OEChem_OEMolStyleColorer:

.. oe:class:: OEMolStyleColorer

   .. oe:api::

      class OEMolStyleColorer
      
   This class represents `OEMolStyleColorer`. 

   The :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>` class is the abstract interface for 
   coloring a 3D molecule within *OEChem*. The :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>` 
   is set within a :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` utilizing 
   :oe:meth:`OEChem::OE3DMolStyle::SetAtomColorer`, :oe:meth:`OEChem::OE3DMolStyle::SetAtomLabelColorer`, 
   :oe:meth:`OEChem::OE3DMolStyle::SetGridContourColorer`, :oe:meth:`OEChem::OE3DMolStyle::SetProteinColorer`, 
   :oe:meth:`OEChem::OE3DMolStyle::SetProteinColorer`, and :oe:meth:`OEChem::OE3DMolStyle::SetSurfaceColorer`. 
   The :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>` can be applied to the initial molecule, but can also 
   applied to its conformers and atoms. The hierarchy between the different :ref:`OEMolStyleColorers <OEChem_OEMolStyleColorer>` 
   dictates that the settings specified on the atom supersede those set on the conformer, and likewise, the settings 
   specified on the conformer will override those on the molecule. 
      
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolStyleColorer()
            OEMolStyleColorer(unsigned int colorScheme)
            OEMolStyleColorer(const char* propertyName)
            OEMolStyleColorer(const OESystem::OEColor& col)
            OEMolStyleColorer(const OEMolStyleColorer& other)
            OEMolStyleColorer(const std::string& propertyName)
            OEMolStyleColorer(unsigned int colorScheme,
                              const OESystem::OEColor& defaultColor)
            OEMolStyleColorer(const char* propertyName,
                              const OESystem::OEColor& defaultColor)
            OEMolStyleColorer(const std::string& propertyName,
                              const OESystem::OEColor& defaultColor)

      .. oe:language:: python

         .. oe:api:: python

            OEMolStyleColorer() -> OEMolStyleColorer
            OEMolStyleColorer(col: OEColor) -> OEMolStyleColorer
            OEMolStyleColorer(other: OEMolStyleColorer) -> OEMolStyleColorer
            OEMolStyleColorer(colorScheme: int) -> OEMolStyleColorer
            OEMolStyleColorer(colorScheme: int, defaultColor: OEColor) -> OEMolStyleColorer
            OEMolStyleColorer(propertyName: str) -> OEMolStyleColorer
            OEMolStyleColorer(propertyName: str, defaultColor: OEColor) -> OEMolStyleColorer

      Default and copy constructors.

   .. oe:method:: operator<
      :language: c++

      .. oe:api::

         bool operator<(const OEMolStyleColorer &rhs) const

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolStyleColorer &operator=(const OEMolStyleColorer &rhs)

      Assignment operator.

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEMolStyleColorer &rhs) const

   .. oe:method:: AddColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddColor(int value, const OESystem::OEColor& col)
            bool AddColor(double value, const OESystem::OEColor& col)
            bool AddColor(unsigned int value, const OESystem::OEColor& col)
            bool AddColor(const std::string& value,
                          const OESystem::OEColor& col)

      .. oe:language:: python

         .. oe:api:: python

            AddColor(value: int, col: OEColor) -> bool
            AddColor(value: float, col: OEColor) -> bool
            AddColor(value: str, col: OEColor) -> bool

      Adds OEColor to OEMolStyleColorer.

   .. oe:method:: ClearColors

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearColors()

      .. oe:language:: python

         .. oe:api:: python

            ClearColors() -> None

      Clears all of the color maps in the OEMolStyleColorer.

   .. oe:method:: GetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEColor GetColor() const
            OESystem::OEColor GetColor(int val) const
            OESystem::OEColor GetColor(double val) const
            OESystem::OEColor GetColor(unsigned int val) const
            OESystem::OEColor GetColor(const std::string& val) const
            OESystem::OEColor GetColor(double val, double scaleMin,
                                       double scaleMax) const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> OEColor
            GetColor(val: int) -> OEColor
            GetColor(val: float) -> OEColor
            GetColor(val: str) -> OEColor
            GetColor(val: float, scaleMin: float, scaleMax: float) -> OEColor

      Returns a OEColor set in the OEMolStyleColorer. The function with no arguments will 
      return the default color set in the OEMolStyleColorer. The functions with arguments 
      will search for the color in the repected map based of the inputted value.

   .. oe:method:: GetColorScheme

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetColorScheme() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorScheme() -> int

      Returns a integer that specifies the color scheme set in the OEMolStyleColorer.

   .. oe:method:: GetDataTypes

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetDataTypes() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataTypes() -> int

      Returns a integer that specifies the data type set in the OEMolStyleColorer.

   .. oe:method:: GetDefaultColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEColor GetDefaultColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetDefaultColor() -> OEColor

      Returns the OEColor set as the default color in the OEMolStyleColorer.

   .. oe:method:: GetNumColors

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumColors() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumColors() -> int

      Returns the number of colors set in all of the maps of the OEMolStyleColorer.

   .. oe:method:: GetPropertyName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetPropertyName() const

      .. oe:language:: python

         .. oe:api:: python

            GetPropertyName() -> str

      Returns a string that specifies the color scheme name set in the OEMolStyleColorer.

   .. oe:method:: GetValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetValues(std::vector<int>& vals) const
            bool GetValues(std::vector<double>& vals) const
            bool GetValues(std::vector<std::string>& vals) const

      .. oe:language:: python

         .. oe:api:: python

            GetValues(vals: OEIntVector) -> bool
            GetValues(vals: OEDoubleVector) -> bool
            GetValues(vals: OEStringVector) -> bool

      Returns a boolean indicating if the specified map has any data. The map that is 
      searched is indicated by the data being stored in the vector. This data is pushed 
      into the reference vector.

   .. oe:method:: SetDefaultColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDefaultColor(const OESystem::OEColor& col)

      .. oe:language:: python

         .. oe:api:: python

            SetDefaultColor(col: OEColor) -> None

      Sets an OEColor as the default color in the OEMolStyleColorer.

   .. seealso::

         * :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`



.. oe:namespace:: OEChem

.. _OEChem_OEMolTaggedPropertyFxn:

.. oe:class:: OEMolTaggedPropertyFxn

   .. oe:api::

      class OEMolTaggedPropertyFxn : public OEMolPropertyFxn

   This class can be used to access molecule properties defined
   as either SD data or generic data in a molecule.  Methods of this
   class checks for SD data field first, and only looks for the generic data
   if a corresponding SD data field is not found.

   The following methods are publicly inherited from :ref:`OEMolPropertyFxn <OEChem_OEMolPropertyFxn>`:
   
   =========================================================== =========================================================== =========================================================== 
   :oe:meth:`CreateCopy<OEChem::OEMolPropertyFxn::CreateCopy>` :oe:meth:`Get<OEChem::OEMolPropertyFxn::Get>`               :oe:meth:`Has<OEChem::OEMolPropertyFxn::Has>`
   =========================================================== =========================================================== =========================================================== 
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolTaggedPropertyFxn(const std::string& tag)
            OEMolTaggedPropertyFxn(const OEMolTaggedPropertyFxn &)

      .. oe:language:: python

         .. oe:api:: python

            OEMolTaggedPropertyFxn(tag: str) -> OEMolTaggedPropertyFxn
            OEMolTaggedPropertyFxn(arg2: OEMolTaggedPropertyFxn) -> OEMolTaggedPropertyFxn

      Default and copy constructors. The tag parameter referes to the data tag 
      corresponding to the property of interest.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolTaggedPropertyFxn &operator=(const OEMolTaggedPropertyFxn &)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMolWriterParameter, MolWriterParameter

.. _OEChem_OEMolWriterParameter:

.. oe:class:: OEMolWriterParameter

   .. oe:api::

      class OEMolWriterParameter : public OESystem::OEStringParameter

   The :ref:`OEMolWriterParameter <OEChem_OEMolWriterParameter>` represents parameter that has ``string`` value
   representing a writable molecule file format.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OETypedParameter <OESystem_OETypedParameter>`:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   Following methods are publicly inherited from :ref:`OEPODParameter <OESystem_OEPODParameter>`:
    * :ref:`GetDefaultsVector <OESystem_GetDefaultsVector>`
    * :ref:`GetSettingsVector <OESystem_GetSettingsVector>`
    * :ref:`GetValuesVector <OESystem_GetValuesVector>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolWriterParameter()
            OEMolWriterParameter(const std::string& name,
                                 const bool is3D = false)
            OEMolWriterParameter(const OEMolWriterParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEMolWriterParameter(name: str, is3D: bool = False) -> OEMolWriterParameter
            OEMolWriterParameter() -> OEMolWriterParameter
            OEMolWriterParameter(arg2: OEMolWriterParameter) -> OEMolWriterParameter

      Default and copy constructors.

      Constructs an :ref:`OEMolWriterParameter <OEChem_OEMolWriterParameter>` instance using the specified set of parameters.
      The optional boolean argument referes to if the writeable file format must be able to write 3D molecule.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolWriterParameter &operator=(const OEMolWriterParameter &)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. _OEChem_OEMonomer:

.. oe:class:: OEMonomer

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMonomer : public OESystem::OEBase

   Stores validated and pre-computed information for a monomer to be used
   as a building block for representing biological macromolecules.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomer(const OEMonomerData &)

      .. oe:language:: python

         .. oe:api:: python

            OEMonomer(arg2: OEMonomerData) -> OEMonomer
            OEMonomer(arg2: OEMonomerImpl) -> OEMonomer

      Initializes a monomer from :oe:cls:`OEChem::OEMonomerData` object.
      If the :oe:cls:`OEChem::OEMonomerData` is not valid an error will be
      thrown and the the generated  :oe:cls:`OEChem::OEMonomer` object will be invalid too.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomer(const OEMonomer &)

      .. oe:language:: python

         .. oe:api:: python

            OEMonomer(arg2: OEMonomerImpl) -> OEMonomer
            OEMonomer(arg2: OEMonomer) -> OEMonomer

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMonomer &operator=(const OEMonomer &)

      Assignment operator.

   .. oe:method:: GetAminoAcidType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAminoAcidType() const

      .. oe:language:: python

         .. oe:api:: python

            GetAminoAcidType() -> int

      Returns the amino acid of the monomer.

      .. seealso::

         * :oe:constns:`OEChem::OEAminoAcidType` namespace

   .. oe:method:: GetCanonicalSmiles

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetCanonicalSmiles() const

      .. oe:language:: python

         .. oe:api:: python

            GetCanonicalSmiles() -> str

      Returns the canonical smiles of the monomer without the R-group definitions.
      In case of alanine, that is defined with ``[H:1]N[C@@H](C)C(=O)[OH:2]``, its canonical
      smiles will be ``C[C@@H](C(=O)O)N``.

      .. seealso::

         * :oe:meth:`OEChem::OEMonomer::GetSmiles` method

   .. oe:method:: GetCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetCode(const std::string& codeSet) const

      .. oe:language:: python

         .. oe:api:: python

            GetCode(codeSet: str) -> str

      Returns the code of the monomer in the given code set. Empty string is returned 
      if the monomer has no code specified. 

   .. oe:method:: GetCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::map<std::string, std::string>& GetCodes() const

      .. oe:language:: python

         .. oe:api:: python

            GetCodes() -> OEStringStringMap

      Returns all the code/code-set pairs defined for the monomer.

   .. oe:method:: GetMonomerType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMonomerType() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerType() -> int

      Returns the monomer type of the monomer.

      .. seealso::

         * :oe:constns:`OEChem::OEMonomerType` namespace

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the full name of the monomer, or an empty string if the name was not
      specified at initialization.

   .. oe:method:: GetPolymerType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetPolymerType() const

      .. oe:language:: python

         .. oe:api:: python

            GetPolymerType() -> int

      Returns the polymer type of the monomer.

      .. seealso::

         * :oe:constns:`OEChem::OEPolymerType` namespace

   .. oe:method:: GetSmiles

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetSmiles() const

      .. oe:language:: python

         .. oe:api:: python

            GetSmiles() -> str

      Returns the smiles representation of the monomer that contains the atom 
      map indices representing connection points.
      Such as ``[H:1]N[C@@H](C)C(=O)[OH:2]`` defining alanine.
      
      .. seealso::

         * :oe:meth:`OEChem::OEMonomer::GetCanonicalSmiles` method

   .. oe:method:: HasCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCode(const std::string& codeSet) const

      .. oe:language:: python

         .. oe:api:: python

            HasCode(codeSet: str) -> bool

      Return whether the monomer has a code defined in the given code-set.

   .. oe:method:: HasRGroup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasRGroup(unsigned idx) const

      .. oe:language:: python

         .. oe:api:: python

            HasRGroup(idx: int) -> bool

      Returns whether the monomer has a specific (R-groups) connections.

   .. oe:method:: IsCTerminal

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsCTerminal() const

      .. oe:language:: python

         .. oe:api:: python

            IsCTerminal() -> bool

      Returns whether a monomer can be used at the C-terminal of a peptide chain.

   .. oe:method:: IsNTerminal

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsNTerminal() const

      .. oe:language:: python

         .. oe:api:: python

            IsNTerminal() -> bool

      Returns whether a monomer can be used at the N-terminal of a peptide chain.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the monomer was initialized successfully.

   .. oe:method:: NumCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned NumCodes() const

      .. oe:language:: python

         .. oe:api:: python

            NumCodes() -> int

      Returns the number of codes the monomer is defined in various code-sets.

   .. oe:method:: NumRGroups

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned NumRGroups() const

      .. oe:language:: python

         .. oe:api:: python

            NumRGroups() -> int

      Returns the number of connections (R-groups) of the monomer.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. _OEChem_OEMonomerData:

.. oe:class:: OEMonomerData

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMonomerData

   Stores the basic definition required for a monomer (:ref:`OEMonomer <OEChem_OEMonomer>`)
   to be used as a building block for representing biological macromolecules.

   .. list-table:: **Example of monomer definition of L-Alanine**
      :widths: 250 250 250
      :header-rows: 1

      * - Property
        - Value
        - Required/Optional/Generated

      * - Smiles
        - ``[H:1]N[C@@H](C)C(=O)[OH:2]``
        - required

      * - Canonical Smiles
        - ``C[C@@H](C(=O)O)N``
        - generated

      * - Name
        - ``L-Alanine`` (optional)
        - optional

      * - Polymer type
        - :oe:const:`OEChem::OEPolymerType::Peptide`
        - required

      * - Monomer type
        - :oe:const:`OEChem::OEMonomerType::Backbone`
        - required

      * - Monomer code-set/code pair
        - ``A`` in code-set ``Standard``
        - required for at least one code-set

   .. oe:source:: MakeAlanine.py
      :language: python
      :noindent:
      :frag:     SNIPPET

   .. oe:source:: MakeAlanine.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET

   .. seealso::
      
      * :oe:func:`OEChem::OEIsValidMonomerData` function
      * :oe:cls:`OEChem::OEMonomerValidationResult` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomerData()

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerData() -> OEMonomerData

      Default constructor that creates an :ref:`OEMonomerData <OEChem_OEMonomerData>`
      object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomerData(const std::string& smiles,
                          unsigned polymerType = OEPolymerType::Peptide,
                          unsigned monomerType = OEMonomerType::Backbone)

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerData(smiles: str, polymerType: int, monomerType: int) -> OEMonomerData

      Constructor that initializes an :ref:`OEMonomerData <OEChem_OEMonomerData>`
      object.

      .. seealso::

         * :oe:constns:`OEChem::OEPolymerType` namespace
         * :oe:constns:`OEChem::OEMonomerType` namespace

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomerData(const OEMonomerData &)

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerData(arg2: OEMonomerData) -> OEMonomerData

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMonomerData &operator=(const OEMonomerData &)

      Assignment operator.

   .. oe:method:: AddCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddCode(const std::string& codeSet, const std::string& code)

      .. oe:language:: python

         .. oe:api:: python

            AddCode(codeSet: str, code: str) -> None

      Adds a code to a monomer for a given code-set.    

   .. oe:method:: GetCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetCode(const std::string& codeSet) const

      .. oe:language:: python

         .. oe:api:: python

            GetCode(codeSet: str) -> str

      Returns the code of the monomer for the given code-set. Returns an empty string
      if there is no code defined for the code-set.   

   .. oe:method:: GetCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::map<std::string, std::string>& GetCodes() const

      .. oe:language:: python

         .. oe:api:: python

            GetCodes() -> OEStringStringMap

      Returns the map that contains all the code-set and code pairs 
      defined for the monomer. 

   .. oe:method:: GetMonomerType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMonomerType() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerType() -> int

      Returns the monomer type of the monomer.

      .. seealso::

         * :oe:constns:`OEChem::OEMonomerType` namespace

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the full name of the monomer. It is optional to define and only used to reference name.

   .. oe:method:: GetPolymerType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetPolymerType() const

      .. oe:language:: python

         .. oe:api:: python

            GetPolymerType() -> int

      Returns the polymer type of the monomer.

      .. seealso::

         * :oe:constns:`OEChem::OEPolymerType` namespace

   .. oe:method:: GetSmiles

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetSmiles() const

      .. oe:language:: python

         .. oe:api:: python

            GetSmiles() -> str

      Returns the smiles representation of the monomer that contains the atom 
      map indices representing connection points.
      Such as ``[H:1]N[C@@H](C)C(=O)[OH:2]`` defining alanine.

   .. oe:method:: GetCanonicalSmiles

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetCanonicalSmiles() const

      .. oe:language:: python

         .. oe:api:: python

            GetCanonicalSmiles() -> str

      Returns the canonical smiles representation of the monomer (without atom mapping)
      Such as ``C[C@@H](C(=O)O)N]`` for  alanine.

   .. oe:method:: HasCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCode(const std::string& codeSet) const

      .. oe:language:: python

         .. oe:api:: python

            HasCode(codeSet: str) -> bool

      Returns whether the monomer has a code defined for the given code set.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the  :oe:cls:`OEChem::OEMonomerData` object is fully defined 
      and correct.

      .. seealso::

         * :oe:func:`OEChem::OEIsValidMonomerData` function      

   .. oe:method:: NumCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumCodes() const

      .. oe:language:: python

         .. oe:api:: python

            NumCodes() -> int

   Returns the number of codes defined for the monomer in various code-sets.

   .. oe:method:: SetCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCodes(const std::map<std::string, std::string>& codes)

      .. oe:language:: python

         .. oe:api:: python

            SetCodes(codes: OEStringStringMap) -> None

   Sets a code of the monomer for a specific code-set.

   .. oe:method:: SetMonomerType

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMonomerType(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMonomerType(arg2: int) -> None

      Sets the monomer type of the monomer.

      .. seealso::

         * :oe:constns:`OEChem::OEMonomerType` namespace

   .. oe:method:: SetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetName(const std::string &)

      .. oe:language:: python

         .. oe:api:: python

            SetName(arg2: str) -> None

      Sets the name of the monomer. The name can be arbitrary, but it is recommended use the IUPAC name
      or any other name that well the monomer.
      For example, the name of the ``C[C@@H](C(=O)O)N]`` monomer of can be ``Alanine`` , ``L-alanine`` or
      ``L-alpha-Alanine`` or ``(2S)-2-aminopropanoic acid``.
      Setting the name is optional.

   .. oe:method:: SetPolymerType

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPolymerType(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetPolymerType(arg2: int) -> None

      Sets the polymer type of the monomer.

      .. seealso::

         * :oe:constns:`OEChem::OEPolymerType` namespace

   .. oe:method:: SetSmiles

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSmiles(const std::string &)

      .. oe:language:: python

         .. oe:api:: python

            SetSmiles(arg2: str) -> None

      Sets the smiles of the monomer.  The given smiles has to define possible attachment points
      of the monomer using map indices.
      For example, ``[H:1]N[C@@H](C)C(=O)[OH:2]`` defining alanine with two connection points to
      from a peptide bonds with adjacent amino acid monomers.

      .. seealso::

         * :oe:func:`OEChem::OEPerceivePeptideMonomerConnections` function

   .. oe:method:: Validate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Validate() const

      .. oe:language:: python

         .. oe:api:: python

            Validate() -> bool

      Calls the :oe:func:`OEChem::OEIsValidMonomerData` function
      to validate the monomer data object.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEChem

.. _OEChem_OEMonomerSet:

.. oe:class:: OEMonomerSet

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMonomerSet

   A container class that stores monomer definitions.

   There are two built in monomer set supported by OEChem
   
   - "Standard" - contains 20 standard amino acid in the code-set named `Standard` 
   - "OpenEye" - contains more than 200 diverse monomers in defined in four code-sets named: ``OpenEye``, ``Standard``, ``PDB`` and ``ChEMBL``

   A monomer has to be defined in at least one code-set. In a code-set each monomer has to have a unique name, 
   built different code set can a monomer cna be named differently.

   .. list-table:: **Example of monomer codes in the built-in OpenEye monomer-set**
      :header-rows: 1

      * - Monomer Name
        - Code in `OpenEye` [#f1]_
        - Code in `Standard`
        - Code in `PDB`
        - Code in `ChEMBL`

      * - Alanine
        - `A`
        - `A`
        - `ALA`
        - `A`

      * - Cysteine
        - `C`
        - `C`
        - `CYS`
        - `c`

      * - D-Alanine
        - `dAla`
        - 
        - `DAL`
        - `dA`

      * - (2S)-2-amino-3-(3-pyridyl)propanoic acid
        - `3Pal`
        - 
        - `1MH`
        - `3-Pal`

   .. [#f1] OpenEye code-set following naming-convention of [Ghiandoni-2026]_

   .. only:: oehtml

      .. admonition:: Download JSON file of built-in Standard and OpenEye monomer-set

         * :download:`monomers-standard.json <../../../../../sublibs/tklibs/oechem/peptide/data/monomers-standard.json>`
           and see :oe:func:`OEChem::OELoadStandardMonomerSet` function
          
         * :download:`monomers-openeye.json <../../../../../sublibs/tklibs/oechem/peptide/data/monomers-openeye.json>`
           and see :oe:func:`OEChem::OELoadOpenEyeMonomerSet` function

   The following example shows how to generate a custom monomer set:

   .. oe:source:: CreateCustomMonomerSet.py
      :language: python
      :noindent:
      :frag:     SNIPPET

   .. oe:source:: CreateCustomMonomerSet.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET

   The generated :oe:cls:`OEChem::OEMonomerSet`  object can be saved into a JSON file using 
   :oe:func:`OEChem::OEWriteMonomerSet` and later loaded with thee :oe:func:`OEChem::OEReadMonomerSet` function.

   .. seealso::

      * :oe:func:`OEChem::OEPerceivePeptideMonomerConnections` function
      * :oe:func:`OEChem::OEGetPolymerType` and :oe:func:`OEChem::OEGetMonomerType` functions
      * :oe:cls:`OEChem::OEMonomerData` class and :oe:func:`OEChem::OEIsValidMonomerData` function

   .. admonition:: OpenEye Python Cookbook Code Example

      * `Generating Custom Monomer Set`_ **OpenEye Python Cookbook** recipe

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomerSet()

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerSet() -> OEMonomerSet

      Constructors an empty monomer set.

   .. oe:method: operator bool # IGNORE

      .. oe:api::

         operator bool() const

   .. oe:method:: AddCodeSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddCodeSet(const std::string& codeSet)

      .. oe:language:: python

         .. oe:api:: python

            AddCodeSet(codeSet: str) -> bool

      Adds a code-set name. 

   .. oe:method:: AddMonomer

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddMonomer(const OEMonomerData &)

      .. oe:language:: python

         .. oe:api:: python

            AddMonomer(arg2: OEMonomerData) -> bool

      Adds a monomer (defined by in a :oe:cls:`OEChem::OEMonomerData` object) to the monomer set.
      The monomer is validated with the :oe:func:`OEChem::OEIsValidMonomerData` function. 
      The method will returns if the monomer was valid and it was successfully added to the set, 
      otherwise it will return false.
      
      Adding a valid monomer (:oe:cls:`OEChem::OEMonomerData`) can fail if:
      
      - the monomer is already present in the set (using canonical isomeric smiles for equivalency check)
      - the monomer has a code that is already used in the specific code-set stored in the set

   .. oe:method:: GetCodeSets

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetCodeSets() const

      .. oe:language:: python

         .. oe:api:: python

            GetCodeSets() -> OEStringVector

      Returns all the code-sets supported by the monomer set.

      .. seealso::

         * :oe:meth:`OEChem::OEMonomerSet::GetPrimaryCodeSet` method

   .. oe:method:: GetCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetCodes(const std::string& codeSet) const

      .. oe:language:: python

         .. oe:api:: python

            GetCodes(codeSet: str) -> OEStringVector

      Returns all the monomer codes stored in the monomer set for the given code-set.

   .. oe:method:: GetMonomer

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMonomer* GetMonomer(const std::string& codeSet,
                                        const std::string& code) const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomer(codeSet: str, code: str) -> OEMonomer

      Returns a monomer pointer with the given code in the specified code-set. 
      NULL pointer will be return if no such monomer exists in the set.

   .. oe:method:: GetMonomers

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<const OEMonomer>* GetMonomers() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomers() -> Iterable[OEMonomer]

      Returns an iterator over all :oe:cls:`OEChem::OEMonomer` objects
      stored in monomer set.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<const OEMonomer>* GetMonomers(const OESystem::OEUnaryPredicate<OEMonomer>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomers(pred: OEUnaryMonomerPred) -> Iterable[OEMonomer]

      Returns an iterator over all :oe:cls:`OEChem::OEMonomer` objects
      stored in monomer set that satisfies the given predicate.

   .. oe:method:: GetPrimaryCodeSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetPrimaryCodeSet() const

      .. oe:language:: python

         .. oe:api:: python

            GetPrimaryCodeSet() -> str

      Returns the name of the primary code-set of the monomer set.
      The primary code-set is the set that has the largest number of monomers defined with a unique code.

      .. seealso::

         * :oe:meth:`OEChem::OEMonomerSet::GetCodeSets` method
         * :oe:meth:`OEChem::OEMonomerSet::NumMonomers` method

   .. oe:method:: GetVersion

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetVersion() const

      .. oe:language:: python

         .. oe:api:: python

            GetVersion() -> str

      Returns the version of the monomer set.

      .. seealso::

         * :oe:meth:`OEChem::OEMonomerSet::SetVersion` method

   .. oe:method:: HasCodeInCodeSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCodeInCodeSet(const std::string& codeSet,
                                  const std::string& code) const

      .. oe:language:: python

         .. oe:api:: python

            HasCodeInCodeSet(codeSet: str, code: str) -> bool

   Returns whether the monomer set contains a specific monomer with the given code and code-set.

   .. oe:method:: HasCodeSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCodeSet(const std::string& codeSet) const

      .. oe:language:: python

         .. oe:api:: python

            HasCodeSet(codeSet: str) -> bool

   Returns whether the monomer set contains any monomer for the given code-set.

   .. oe:method:: HasMonomer

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasMonomer(const OEMonomerData &) const

      .. oe:language:: python

         .. oe:api:: python

            HasMonomer(arg2: OEMonomerData) -> bool

   Returns whether the monomer (:oe:cls:`OEChem::OEMonomerData`) already exists in the monomer set.
   Each monomer in the :oe:cls:`OEChem::OEMonomerSet` has to have a unique canonical smiles.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the monomer set stores at least one valid monomer object.

   .. oe:method:: NumCodeSets

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned NumCodeSets() const

      .. oe:language:: python

         .. oe:api:: python

            NumCodeSets() -> int

      Returns the number of unique code set the monomers are defined.

   .. oe:method:: NumMonomers

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned NumMonomers() const

      .. oe:language:: python

         .. oe:api:: python

            NumMonomers() -> int

      Returns the number of monomers in the container.

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned NumMonomers(const std::string& codeSet) const

      .. oe:language:: python

         .. oe:api:: python

            NumMonomers(codeSet: str) -> int

      Returns the number of monomers in the container that associated wit a code
      in the given code-set. 

      .. seealso::

         * :oe:meth:`OEChem::OEMonomerSet::GetPrimaryCodeSet` method

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned NumMonomers(const OESystem::OEUnaryPredicate<OEMonomer>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            NumMonomers(pred: OEUnaryMonomerPred) -> int

      Returns the number of monomers that satisfy the given predicate.

      .. seealso::

         * :oe:cls:`OEChem::OEHasAminoAcidType` predicate
         * :oe:cls:`OEChem::OEHasMonomerType` predicate
         * :oe:cls:`OEChem::OEHasPolymerType` predicate
         * :oe:cls:`OEChem::OEIsInMonomerCodeSet` predicate

   .. oe:method:: SetVersion

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetVersion(const std::string& version)

      .. oe:language:: python

         .. oe:api:: python

            SetVersion(version: str) -> None

      Sets the version of the monomer set. The function does not validate the format of the given string.
      However OpenEye's built-in monomer sets are using the following conventions:

      The version format is ``A.B.C`` (The first is version is "1.0.0")

      - A: incremented for **major** changes in monomer set that has effect of parsing already generated HELMS with the given code set.

        - monomer is removed
        - monomer smiles has been corrected (for example correcting stereo configuration)
        - monomer code is modified

      - B: incremented for **minor** changes in monomer set that has effect on generating new HELMs but will not effect paring of HELMs
        generated with previous versions (backwards-compatibility)

        - new monomer is added
        - new R-group is added to already existing monomer

      - C: incremented for **micro** changes hat does not effect either HELM parsing or generation
        (backwards-compatibility)

        - monomer name change
        - adding additional monomer properties (such as associating colors with monomers for depiction)


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. _OEChem_OEMonomerValidationResult:

.. oe:class:: OEMonomerValidationResult

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMonomerValidationResult

   This class is used to return additional information when using the  
   :oe:cls:`OEChem::OEIsValidMonomerData` function.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomerValidationResult()
            OEMonomerValidationResult(const OEMonomerValidationResult &)

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerValidationResult() -> OEMonomerValidationResult
            OEMonomerValidationResult(arg2: OEMonomerValidationResult) -> OEMonomerValidationResult

      Default and copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMonomerValidationResult &operator=(const OEMonomerValidationResult &)

      Assignment operator.

   .. oe:method:: GetReturnCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetReturnCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetReturnCode() -> int

      Returns a code from the  
      :oe:constns:`OEChem::OEMonomerValidationReturnCode` namespace.

   .. oe:method:: GetWarning

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetWarning() const

      .. oe:language:: python

         .. oe:api:: python

            GetWarning() -> str

      If the monomer validation fails, i.e. the return code is not 
      :oe:const:`OEChem::OEMonomerValidationReturnCode::Success`,
      this message provides details about the reason for the failure.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMutableCoords, MutableCoords

.. _OEChem_OEMutableCoords:

.. oe:class:: OEMutableCoords

   .. oe:language:: python java csharp

      .. warning:: 

         This class is only usable from the OpenEye C++ toolkits. 

   .. oe:api::

      template<class T>
      class OEMutableCoords : public detail::OECoordsBase<T, OEConfBase>

   This class is used to provide convenient direct access to the
   memory storing coordinates for a :ref:`OEConfBase <OEChem_OEConfBase>`
   through the :oe:meth:`OEChem::OEConfBase::GetCoordsPtr` methods. If
   the data type of ``T`` does not match the implementation of
   :ref:`OEConfBase <OEChem_OEConfBase>`, this class makes a copy of the
   coordinates with :oe:meth:`OEChem::OEConfBase::GetCoords` instead.
   If a copy of the coordinates are made with
   :oe:meth:`OEChem::OEConfBase::GetCoords`, the destructor of this
   class will copy the changes made back into the conformer with
   :oe:meth:`OEChem::OEConfBase::SetCoords`. 

   .. note::

      This class can incur unnecessary copies if ``T`` does not match
      the implementation of the :ref:`OEConfBase <OEChem_OEConfBase>` and no
      modifications were actually made. Use :ref:`OEConstCoords <OEChem_OEConstCoords>`
      whenever read-only access to coordinates is acceptable. 

   .. oe:language:: c++

      :oe:src:`Listing 1<SNIPPET-OEMutableCoords-MutableCoords>` demonstrates the quickest way
      to zero all the coordinates in a conformer using the ``memset``
      function.  :ref:`OEMutableCoords <OEChem_OEMutableCoords>` it used to get
      direct access to the coordinates in an
      :ref:`OEConfBase <OEChem_OEConfBase>`. This can provide large efficiency
      gains due to the reduced need for temporary memory and copies
      like the :oe:meth:`OEChem::OEConfBase::SetCoords` method.

      .. oe:source:: MutableCoords.cpp
         :language: c++
         :refnum:   1
         :frag:     SNIPPET-OEMutableCoords

   .. oe:method:: Constructors

      .. oe:api::

         OEMutableCoords(OEConfBase* conf)

      Construct a mutable view of the coordinates in the conformer ``conf``. 

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMutableCoords & operator=(const OEMutableCoords & rhs)

      Assignment operator.

   

   .. oe:method:: operator T *
      :language: c++

      .. oe:api::

         operator T *()

      Allows implicitly casting this object into a pointer of type
      ``T`` to the coordinates of the conformer used in the
      constructor.

   .. oe:method:: GetPtr

      .. oe:api::

         T* GetPtr()

      Returns a pointer of type ``T`` to the coordinates of the
      conformer used in the constructor.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OENbrs, Nbrs

.. _OEChem_OENbrs:

.. oe:class:: OENbrs

   .. oe:api::

      struct OENbrs

   This class represents :ref:`OENbrs <OEChem_OENbrs>` that stores an atom pair
   and the distance between them.

   .. seealso::

      * :oe:func:`OEChem::OEGetNearestNbrs` function
      * :oe:func:`OEChem::OENearestNbrs` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENbrs(const OEAtomBase* bgn, const OEAtomBase* end, double dist2)

      .. oe:language:: python

         .. oe:api:: python

            OENbrs(b: OEAtomBase, e: OEAtomBase, d: float) -> OENbrs

      Creates an :ref:`OENbrs <OEChem_OENbrs>` object.

   .. oe:method:: GetBgn

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEAtomBase* GetBgn() const

      .. oe:language:: python

         .. oe:api:: python

            GetBgn() -> OEAtomBase

      Returns the 'bgn' atom.

   .. oe:method:: GetDist2

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDist2() const

      .. oe:language:: python

         .. oe:api:: python

            GetDist2() -> float

      Returns the square of the distance between the 'bgn' and 'end' atoms.

   .. oe:method:: GetDist

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDist() const

      .. oe:language:: python

         .. oe:api:: python

            GetDist() -> float

      Returns the distance between the 'bgn' and 'end' atoms.

   .. oe:method:: GetEnd

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEAtomBase* GetEnd() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnd() -> OEAtomBase

      Returns the 'end' atom.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OENearestNbrs, NearestNbrs

.. _OEChem_OENearestNbrs:

.. oe:class:: OENearestNbrs

   .. oe:api::

      class OENearestNbrs

   This class represents `OENearestNbrs`.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENearestNbrs(const OEMolBase& mol, double maxdist,
                          unsigned int method = OENearestNbrsMethod::Default)

      .. oe:language:: python

         .. oe:api:: python

            OENearestNbrs(mol: Union[OEGraphMol,OEMol,OEQMol], maxdist: float,
                          method: int) -> OENearestNbrs

      Creates an :ref:`OENearestNbrs <OEChem_OENearestNbrs>` object for nearest neighbor
      search.

      method
        Determines the algorithm that is used to find the nearest neighbors.
        This value has to be from the :oe:const:`OEChem::OENearestNbrsMethod` namespace.

   .. oe:method:: GetNbrs

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OENbrs>* GetNbrs(const float* coords) const

      .. oe:language:: python

         .. oe:api:: python

            GetNbrs(coords: float) -> OENbrsIter

      Returns an iterator over all atom pairs of the molecule that are closer
      to each other than the **maxdist** limit.
      When calculating the distances the coordinates passed as a parameter are
      utilized rather then the coordinates stored in the molecule of which
      the :ref:`OENearestNbrs <OEChem_OENearestNbrs>` was initialized.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OENbrs>* GetNbrs(const OEMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            GetNbrs(mol: Union[OEGraphMol,OEMol,OEQMol]) -> OENbrsIter

      Returns an iterator over all atoms that are closer to the given atom than
      the **maxdist** limit.

      Returns an iterator over all atom pairs of the two molecules that are closer
      to each other than the **maxdist** limit.
      This function calculates **intra-molecular** distances.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OENbrs>* GetNbrs(const OEAtomBase* atom) const

      .. oe:language:: python

         .. oe:api:: python

            GetNbrs(atom: OEAtomBase) -> OENbrsIter

      Returns an iterator over all atoms that are closer to the given atom than
      the **maxdist** limit.

   .. seealso::

      * :oe:func:`OEChem::OEGetNearestNbrs` function
      * :oe:func:`OEChem::OENbrs` class


.. oe:namespace:: OEChem

.. meta::
   :keywords: OENthAtom, NthAtom

.. _OEChem_OENthAtom:

.. oe:class:: OENthAtom

   .. oe:api::

      class OENthAtom : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents :ref:`OENthAtom <OEChem_OENthAtom>` functor that
   identifies the Nth atom (:ref:`OEAtomBase <OEChem_OEAtomBase>`) is the molecule.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENthAtom(unsigned int n, unsigned int start = 0)

      .. oe:language:: python

         .. oe:api:: python

            OENthAtom(n: int, start: int = 0) -> OENthAtom

      Constructs the functor with the Nth atom specified by 'n' and the
      starting atom specified by 'start'.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if iteration over the atoms in the molecule makes
      the 'atom' the Nth atom in the molecule starting with the first
      atom being the 'start' atom.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OENthAtom

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OENthAtom <OEChem_OENthAtom>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEOmegaConfTest, OmegaConfTest

.. _OEChem_OEOmegaConfTest:

.. oe:class:: OEOmegaConfTest

   .. oe:api::

      class OEOmegaConfTest : public OEConfTestBase

   This implementation of :ref:`OEConfTestBase <OEChem_OEConfTestBase>` combines
   subsequent connection tables into a multi-conformer molecule if
   they:

   * have the same number of atoms and bonds in the same order
   * have atoms and bonds with identical properties in the same order 
   * have the same atom and bond stereochemistry, except for invertible nitrogen stereochemistry 
   * have the same title (optional)

   :ref:`OEOmegaConfTest <OEChem_OEOmegaConfTest>` shouldn't be used for reading
   multi-conformer molecules in PDB or XYZ file format. These file
   formats typically require the use of
   :oe:func:`OEChem::OEDetermineConnectivity` (and
   :oe:func:`OEChem::OEPerceiveBondOrders`) which may potentially
   perceive and create bonds in different orders (or arbitrarily
   assign bond orders and Kekulé forms differently) for different
   conformers of the same molecule. This disrupts the ordering (and
   property) constraints described above. Generally, file formats
   other than PDB and XYZ should be used for storing multi-conformer
   molecules (as consecutive connection tables).

   The following methods are publicly inherited from :ref:`OEConfTestBase <OEChem_OEConfTestBase>`:

   =========================================================== =========================================================== ==========================================================
   :oe:meth:`CombineMols<OEChem::OEConfTestBase::CombineMols>` :oe:meth:`CompareMols<OEChem::OEConfTestBase::CompareMols>` :oe:meth:`CreateCopy<OEChem::OEConfTestBase::CreateCopy>` 
   =========================================================== =========================================================== ==========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOmegaConfTest(bool compTitles = true)

      .. oe:language:: python

         .. oe:api:: python

            OEOmegaConfTest(compTitles: bool = True) -> OEOmegaConfTest

      Constructs an  :ref:`OEOmegaConfTest <OEChem_OEOmegaConfTest>`
      object. The argument 'compTitle' specifies whether to compare
      molecule titles (accessed by
      :oe:meth:`OEChem::OEMolBase::GetTitle`).  If the constructor is
      called with no arguments or with the argument ``true``, molecule
      titles will be required to be the same. Otherwise, the titles
      will not be compared. In the latter instance, each conformer
      will have the individual title of its original connection table
      and the multi-conformer molecule will reflect the title of the
      active conformer.

   .. oe:method:: CombineMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CombineMols(OEMCMolBase& m1, OEMolBase& m2)

      .. oe:language:: python

         .. oe:api:: python

            CombineMols(m1: OEMol, m2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   .. oe:method:: CompareMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CompareMols(OEMolBase& m1, OEMolBase& m2) const

      .. oe:language:: python

         .. oe:api:: python

            CompareMols(m1: Union[OEGraphMol,OEMol,OEQMol],
                        m2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Returns whether the two :ref:`OEMolBase <OEChem_OEMolBase>` objects
      are the same by checking the four conditions listed above.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfTestBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEConfTestBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEOmegaConfTest <OEChem_OEOmegaConfTest>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         ``delete`` in order to prevent a memory leak. 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEOutFileStringParameter, OutFileStringParameter

.. _OEChem_OEOutFileStringParameter:

.. oe:class:: OEOutFileStringParameter

   .. oe:api::

      class OEOutFileStringParameter : public OEFileStringParameter

   The :ref:`OEOutFileStringParameter <OEChem_OEOutFileStringParameter>` represents parameter that has ``string`` value
   representing a writable file format for modeling objects, such as a molecule or a design unit.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OETypedParameter <OESystem_OETypedParameter>`:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   Following methods are publicly inherited from :ref:`OEPODParameter <OESystem_OEPODParameter>`:
    * :ref:`GetDefaultsVector <OESystem_GetDefaultsVector>`
    * :ref:`GetSettingsVector <OESystem_GetSettingsVector>`
    * :ref:`GetValuesVector <OESystem_GetValuesVector>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOutFileStringParameter()
            OEOutFileStringParameter(const std::string& name,
                                     const unsigned fileType,
                                     const unsigned fileTypeFlavor = 0u)
            OEOutFileStringParameter(const std::string& name,
                                     const std::string& fileExt)
            OEOutFileStringParameter(const OEOutFileStringParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEOutFileStringParameter(name: str, fileType: int,
                                     fileTypeFlavor: int = 0) -> OEOutFileStringParameter
            OEOutFileStringParameter(name: str, fileExt: str) -> OEOutFileStringParameter
            OEOutFileStringParameter() -> OEOutFileStringParameter
            OEOutFileStringParameter(arg2: OEOutFileStringParameter) -> OEOutFileStringParameter

      Default and copy constructors.

      Constructs an :ref:`OEOutFileStringParameter <OEChem_OEOutFileStringParameter>` instance using the specified set of parameters.
      The ``fileType`` argument refers to constants defined in the :oe:constns:`OEChem::OEFileStringType` namespace.
      The ``fileTypeFlavor`` argument refers to constants defined in the :oe:constns:`OEChem::OEFileStringTypeFlavor` namespace.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOutFileStringParameter &operator=(const OEOutFileStringParameter &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEParseSmilesOptions, ParseSmilesOptions

.. _OEChem_OEParseSmilesOptions:

.. oe:class:: OEParseSmilesOptions

   .. oe:api::

      class OEParseSmilesOptions

   An class for handling options for the
   :oe:func:`OEChem::OEParseSmiles` function.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEParseSmilesOptions(bool canon = false, bool strict = false,
                                 bool quiet = false, bool cxsmiles = false)

      .. oe:language:: python

         .. oe:api:: python

            OEParseSmilesOptions(canon: bool = False, strict: bool = False,
                                 quiet: bool = False, cxsmiles: bool = False) -> OEParseSmilesOptions

      Initializes the object with the specified options.

   .. oe:method:: GetCanon

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCanon() const

      .. oe:language:: python

         .. oe:api:: python

            GetCanon() -> bool

      A value of ``true`` specifies that the
      :oe:func:`OEChem::OEKekulize` step can be skipped. Defaults to
      ``false``.

   .. oe:method:: GetCXSMILES

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCXSMILES() const

      .. oe:language:: python

         .. oe:api:: python

            GetCXSMILES() -> bool

      A value of ``true`` specifies that a :term:`CXSMILES` formatted
      appendix is allowed to be present in the parse string, and extra checking
      will be employed to capture any enhanced stereogroup information therein.
      A value of ``false`` results in a :term:`CXSMILES` appendix being
      ignored and retained as part of the molecule title. Defaults to ``false``.

      .. warning::

         Unparsed :term:`CXSMILES` appendix information captured in the molecule title
         will generally be corrupt after regeneration of :term:`SMILES` information.

   .. oe:method:: GetStrict

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStrict() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrict() -> bool

      A value of ``true`` specifies that the
      :oe:func:`OEChem::OEParseSmiles` will apply more rigorous sanity
      checks on the parsed :term:`SMILES` string. Defaults to
      ``false``.

   .. oe:method:: GetQuiet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetQuiet() const

      .. oe:language:: python

         .. oe:api:: python

            GetQuiet() -> bool

      A value of ``true`` specifies that there will be no output
      written to :oe:constns:`OESystem::OEThrow` if
      :oe:func:`OEChem::OEParseSmiles` fails to parse the
      string. Defaults to ``false``.

   .. oe:method:: SetCanon

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCanon(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetCanon(c: bool) -> None

      This setting can be used to circumvent the post-processing
      kekulization test of :oe:func:`OEChem::OEParseSmiles`.  Passing a
      boolean ``true`` value to this argument indicates to the parser
      that the :term:`SMILES` string should be assumed to be
      well-formed and the usual kekulization (by calling
      :oe:func:`OEChem::OEKekulize`) step may be omitted.  This can be
      used to speed-up parsing of a large database, but has the
      side-effect that bond orders are not correctly assigned for
      aromatic molecules.

   .. oe:method:: SetCXSMILES

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCXSMILES(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetCXSMILES(ste: bool) -> None

      Setting a value of ``true`` specifies that a :term:`CXSMILES` formatted
      appendix is allowed to be present in the parse string, and extra checking
      should be employed to capture any enhanced stereogroup information therein.
      Setting a value of ``false`` results in a :term:`CXSMILES` appendix being
      ignored and captured as part of the molecule title.

   .. oe:method:: SetStrict

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStrict(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetStrict(s: bool) -> None

      This setting controls whether :oe:func:`OEChem::OEParseSmiles`
      should operate in strict mode.  By default, the :term:`SMILES`
      parser attempts to process any reasonably formed :term:`SMILES`
      string.  If this setting is ``true``, the parser applies more
      rigorous sanity checking.  For example, the :term:`SMILES`
      ``C==C`` is accepted by the default non-strict parser, but
      rejected by the strict parser.

   .. oe:method:: SetQuiet

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetQuiet(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetQuiet(q: bool) -> None

      This setting can be used to force
      :oe:func:`OEChem::OEParseSmiles` to not write anything to
      :oe:constns:`OESystem::OEThrow` in the case of a failure. This can
      be useful for programs that want to determine if a string is a
      valid :term:`SMILES` string without spewing unnecessary logging
      information to the terminal.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEPartPredT, PartPredT

.. _OEChem_OEPartPredT:

.. oe:class:: OEPartPredT

   .. oe:api::

      template<class T>
      class OEPartPredT : public OESystem::OEUnaryPredicate<T>

   This class represents :ref:`OEPartPredT <OEChem_OEPartPredT>` template functor that
   holds multiple parts of a molecule and
   identifies objects (that provide ``GetIdx`` method such as
   :ref:`OEAtomBase <OEChem_OEAtomBase>`, :ref:`OEBondBase <OEChem_OEBondBase>`)
   that belong to different part of a molecule
   based on the state of the functor.

   .. seealso::

      * :ref:`section_predicates_partitioning` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   The following specialization exists for this template:
   
   .. oe:language:: c++

      ==================== ====================================================================
      Specialized Functor  Definition                                                          
      ==================== ====================================================================
      OEPartPred           :ref:`OEPartPredT <OEChem_OEPartPredT>` <:ref:`OEAtomBase <OEChem_OEAtomBase>`>
      ==================== ====================================================================

      .. index::
         single: OEPartPred

   .. oe:language:: python java csharp

      ==================== ====================================================================
      Specialized Functor  Definition                                                          
      ==================== ====================================================================
      OEPartPredAtom       :ref:`OEPartPredT <OEChem_OEPartPredT>` <:ref:`OEAtomBase <OEChem_OEAtomBase>`>
      ==================== ====================================================================

      .. index::
         single: OEPartPredAtom
   

   .. oe:method:: Constructors

      .. oe:api::

         OEPartPredT(unsigned int* parts, unsigned int size)

      Constructs the functor where the parts are specified in the 
      passed integer array ('parts'), the size of the 'parts'
      array is is specified by the 'size' argument.

      If the :ref:`OEPartPredT <OEChem_OEPartPredT>` is used to identify atoms
      (:ref:`OEAtomBase <OEChem_OEAtomBase>`), then 'parts' array is assumed to
      be of length equal to the number return by the
      :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx` method, where
      parts[atom. :oe:meth:`GetIdx()<OEChem::OEAtomBase::GetIdx>` ] is
      the integer associated with the part to which atom belongs.

      .. oe:api::

         OEPartPredT(const OEPartPredT& rhs)

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPartPredT& operator=(const OEPartPredT& rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OEPartPredT <OEChem_OEPartPredT>` object
      into the right-hand side :ref:`OEPartPredT <OEChem_OEPartPredT>` object.

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const T& t) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(t: T) -> bool

      If the :ref:`OEPartPredT <OEChem_OEPartPredT>` is used to identify atoms,
      then this method returns ``true``, if
      parts[ atom. :oe:meth:`GetIdx()<OEChem::OEAtomBase::GetIdx>` ] ==
      part, where 'parts' is the array passed on construction, and
      'part' is the argument set by the
      :oe:meth:`OEChem::OEPartPredT::SelectPart` method.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<T, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEPartPredT

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEPartPredT <OEChem_OEPartPredT>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 

   .. oe:method:: SelectPart

      .. oe:api::

         void SelectPart(unsigned int part)

      Sets the 'part' argument that is used to select a specific part
      of a molecule.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEPredicateParameter, PredicateParameter

.. _OEChem_OEPredicateParameter:

.. oe:class:: OEPredicateParameter
      
   .. oe:api::

      template<class TT>
      template <class TT>class OEPredicateParameter : public OESystem::OEPointerParameter<TT>

   The :ref:`OEPredicateParameter <OEChem_OEPredicateParameter>` represents parameter that has value
   of predicate type.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   The :ref:`OEPredicateParameter <OEChem_OEPredicateParameter>` class defines the following public methods:
    * :oe:meth:`GetDefault<OEChem::OEPredicateParameter::GetDefault>` and
      :oe:meth:`SetDefault<OEChem::OEPredicateParameter::SetDefault>` 
    * :oe:meth:`GetSetting<OEChem::OEPredicateParameter::GetSetting>`
    * :oe:meth:`GetValue<OEChem::OEPredicateParameter::GetValue>` and
      :oe:meth:`SetValue<OEChem::OEPredicateParameter::SetValue>`

   The following classes derive from this class:
    * :ref:`OEUnAtomPredParameter <OEChem_OEUnAtomPredParameter>`
    * :ref:`OEUnBondPredParameter <OEChem_OEUnBondPredParameter>`

   .. oe:method:: Constructors

      .. oe:api::

         OEPredicateParameter()
         OEPredicateParameter(const std::string& name)
         OEPredicateParameter(const OEPredicateParameter&)

      Default and copy constructors.

      Constructs an :ref:`OEPredicateParameter <OEChem_OEPredicateParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPredicateParameter& operator=(const OEPredicateParameter &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetDefault

      .. oe:api::

         TT* GetDefault() const

      Returns the current default value of the parameter.

   .. oe:method:: GetSetting

      .. oe:api::

         TT* GetSetting() const

      Returns the current setting of the parameter.

   .. oe:method:: GetValue

      .. oe:api::

         TT* GetValue() const

      Returns the current user-defined value of the parameter.

   .. oe:method:: SetDefault

      .. oe:api::

         bool SetDefault(const TT& value)

      Sets the default value of the parameter.

   .. oe:method:: SetValue

      .. oe:api::

         bool SetValue(const TT& value)

      Sets the user-defined value of the parameter.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEQAtomBase, QAtomBase

.. _OEChem_OEQAtomBase:

.. oe:class:: OEQAtomBase

   .. oe:api::

      class OEQAtomBase : public OEAtomBase , public OEQBase

   The :ref:`OEQAtomBase <OEChem_OEQAtomBase>` class is the abstract interface
   for representing atoms and atom expressions within **OpenEye's Toolkits**.
   For a  description of query expressions and their utility in graph
   matching refer to the :ref:`section_patternmatch_OEExprOpts` section. 
   An :ref:`OEQAtomBase <OEChem_OEQAtomBase>` object is created by calling the
   :oe:meth:`OEChem::OEMolBase::NewAtom` method on the parent molecule.

   The following methods are publicly inherited from :ref:`OEAtomBase <OEChem_OEAtomBase>`:

   ===================================================================== ===================================================================== ====================================================================
   :oe:meth:`operator=<OEChem::OEAtomBase::operator=>`                   :oe:meth:`GetRadius<OEChem::OEAtomBase::GetRadius>`                   :oe:meth:`IsSulfur<OEChem::OEAtomBase::IsSulfur>`                   
   :oe:meth:`AddBond<OEChem::OEAtomBase::AddBond>`                       :oe:meth:`GetRxnRole<OEChem::OEAtomBase::GetRxnRole>`                 :oe:meth:`OrderBonds<OEChem::OEAtomBase::OrderBonds>`               
   :oe:meth:`Clear<OEChem::OEAtomBase::Clear>`                           :oe:meth:`GetStereo<OEChem::OEAtomBase::GetStereo>`                   :oe:meth:`RemoveBond<OEChem::OEAtomBase::RemoveBond>`               
   :oe:meth:`GetAtomicNum<OEChem::OEAtomBase::GetAtomicNum>`             :oe:meth:`GetSymmetryClass<OEChem::OEAtomBase::GetSymmetryClass>`     :oe:meth:`SetAromatic<OEChem::OEAtomBase::SetAromatic>`             
   :oe:meth:`GetAtoms<OEChem::OEAtomBase::GetAtoms>`                     :oe:meth:`GetTotalHCount<OEChem::OEAtomBase::GetTotalHCount>`         :oe:meth:`SetAtomicNum<OEChem::OEAtomBase::SetAtomicNum>`           
   :oe:meth:`GetType<OEChem::OEAtomBase::GetType>`                       
   :oe:meth:`GetBond<OEChem::OEAtomBase::GetBond>`                       :oe:meth:`GetValence<OEChem::OEAtomBase::GetValence>`                 :oe:meth:`SetChiral<OEChem::OEAtomBase::SetChiral>`                 
   :oe:meth:`GetBonds<OEChem::OEAtomBase::GetBonds>`                     :oe:meth:`SetFormalCharge<OEChem::OEAtomBase::SetFormalCharge>`     
   :oe:meth:`GetDegree<OEChem::OEAtomBase::GetDegree>`                   :oe:meth:`HasStereoSpecified<OEChem::OEAtomBase::HasStereoSpecified>` :oe:meth:`SetHyb<OEChem::OEAtomBase::SetHyb>`                       
   :oe:meth:`GetExplicitDegree<OEChem::OEAtomBase::GetExplicitDegree>`   :oe:meth:`IsAromatic<OEChem::OEAtomBase::IsAromatic>`
   :oe:meth:`GetExplicitHCount<OEChem::OEAtomBase::GetExplicitHCount>`   :oe:meth:`IsCarbon<OEChem::OEAtomBase::IsCarbon>`                     :oe:meth:`SetImplicitHCount<OEChem::OEAtomBase::SetImplicitHCount>` 
   :oe:meth:`GetExplicitValence<OEChem::OEAtomBase::GetExplicitValence>` :oe:meth:`IsChiral<OEChem::OEAtomBase::IsChiral>`                     :oe:meth:`SetInRing<OEChem::OEAtomBase::SetInRing>`                 
   :oe:meth:`GetFormalCharge<OEChem::OEAtomBase::GetFormalCharge>`       :oe:meth:`IsConnected<OEChem::OEAtomBase::IsConnected>`               :oe:meth:`SetIntType<OEChem::OEAtomBase::SetIntType>`               
   :oe:meth:`GetHvyDegree<OEChem::OEAtomBase::GetHvyDegree>`             :oe:meth:`IsDataType<OEChem::OEAtomBase::IsDataType>`                 :oe:meth:`SetIsotope<OEChem::OEAtomBase::SetIsotope>`               
   :oe:meth:`GetHvyValence<OEChem::OEAtomBase::GetHvyValence>`           :oe:meth:`IsDeleted<OEChem::OEAtomBase::IsDeleted>`                   :oe:meth:`SetMapIdx<OEChem::OEAtomBase::SetMapIdx>`                 
   :oe:meth:`GetHyb<OEChem::OEAtomBase::GetHyb>`                         :oe:meth:`IsHalogen<OEChem::OEAtomBase::IsHalogen>`                   :oe:meth:`SetName<OEChem::OEAtomBase::SetName>`                     
   :oe:meth:`GetIdx<OEChem::OEAtomBase::GetIdx>`                         :oe:meth:`IsHydrogen<OEChem::OEAtomBase::IsHydrogen>`                 :oe:meth:`SetPartialCharge<OEChem::OEAtomBase::SetPartialCharge>`   
   :oe:meth:`GetImplicitHCount<OEChem::OEAtomBase::GetImplicitHCount>`   :oe:meth:`IsInRing<OEChem::OEAtomBase::IsInRing>`                     :oe:meth:`SetRadius<OEChem::OEAtomBase::SetRadius>`                 
   :oe:meth:`GetIntType<OEChem::OEAtomBase::GetIntType>`                 :oe:meth:`IsMetal<OEChem::OEAtomBase::IsMetal>`                       :oe:meth:`SetRxnRole<OEChem::OEAtomBase::SetRxnRole>`               
   :oe:meth:`GetIsotope<OEChem::OEAtomBase::GetIsotope>`                 :oe:meth:`IsNitrogen<OEChem::OEAtomBase::IsNitrogen>`                 :oe:meth:`SetStereo<OEChem::OEAtomBase::SetStereo>`                 
   :oe:meth:`GetMapIdx<OEChem::OEAtomBase::GetMapIdx>`                   :oe:meth:`IsOxygen<OEChem::OEAtomBase::IsOxygen>`                     :oe:meth:`SetSymmetryClass<OEChem::OEAtomBase::SetSymmetryClass>`   
   :oe:meth:`GetName<OEChem::OEAtomBase::GetName>`                       :oe:meth:`IsPhosphorus<OEChem::OEAtomBase::IsPhosphorus>`             :oe:meth:`SetType<OEChem::OEAtomBase::SetType>`                     
   :oe:meth:`GetParent<OEChem::OEAtomBase::GetParent>`                   :oe:meth:`IsPolar<OEChem::OEAtomBase::IsPolar>`                       :oe:meth:`Sweep<OEChem::OEAtomBase::Sweep>`                         
   :oe:meth:`GetPartialCharge<OEChem::OEAtomBase::GetPartialCharge>`     :oe:meth:`IsPolarHydrogen<OEChem::OEAtomBase::IsPolarHydrogen>`                                                                           
   ===================================================================== ===================================================================== ====================================================================

   The following methods are publicly inherited from :ref:`OEQBase <OEChem_OEQBase>`:

   ============================================ ============================================ ===========================================
   :oe:meth:`GetExpr<OEChem::OEQBase::GetExpr>` :oe:meth:`SetExpr<OEChem::OEQBase::SetExpr>`                                            
   ============================================ ============================================ ===========================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: GetParentAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomBase* GetParentAtom() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetParentAtom() -> OEAtomBase

   .. oe:method:: GetQAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEQAtomBase>* GetQAtoms() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetQAtoms() -> OEQAtomIter

      Returns an iterator over the neighboring query atoms of this atom.
      The returned iterator traverses
      only the explicit atoms that are bonded to the
      :ref:`OEQAtomBase <OEChem_OEQAtomBase>`. The number of neighbors in the
      iterator is identical to
      :oe:meth:`OEChem::OEAtomBase::GetExplicitDegree`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEQAtomBase>* GetQAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetQAtoms(arg2: OEUnaryAtomPred) -> OEQAtomIter

      Returns an iterator over the neighboring query atoms of the :ref:`OEQAtomBase <OEChem_OEQAtomBase>` that match
      the predicate (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`)

   .. oe:method:: GetQBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEQBondBase>* GetQBonds() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetQBonds() -> OEQBondIter

      Returns an iterator over the query bonds connected to the atom.
      The returned iterator traverses only the explicit bonds that are
      attached to the :ref:`OEQAtomBase <OEChem_OEQAtomBase>`. The number of bonds
      in the iterator is identical to
      :oe:meth:`OEChem::OEAtomBase::GetExplicitDegree`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEQBondBase>* GetQBonds(const OESystem::OEUnaryPredicate<OEChem::OEBondBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetQBonds(arg2: OEUnaryBondPred) -> OEQBondIter

      Returns an iterator over the query bonds of the :ref:`OEQAtomBase <OEChem_OEQAtomBase>` that match
      the predicate (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`)

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEQBase, QBase

.. _OEChem_OEQBase:

.. oe:class:: OEQBase

   .. oe:api::

      class OEQBase

   This class represents `OEQBase`.

   The :ref:`OEQBase <OEChem_OEQBase>` is the abstract class which defines
   the API for storage and retrieval of expressions used in graph
   matching operations.

   The following classes derive from this class:
    * :ref:`OEQAtomBase <OEChem_OEQAtomBase>`
    * :ref:`OEQBondBase <OEChem_OEQBondBase>`
   

   .. oe:method:: GetExpr

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEExprBase* GetExpr() const = 0
            OEExprBase* GetExpr() =0

      .. oe:language:: python

         .. oe:api:: python

            GetExpr() -> OEExprBase

      This pure virtual method defines the interface for retrieving a
      stored expressions from a :ref:`OEQBase <OEChem_OEQBase>` parent class
      instance.
      If no expression was stored previously a NULL pointer may be
      returned.
      The pointer returned from this method should therefore be
      checked before use.

   .. oe:method:: SetExpr

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetExpr(const OEExprBase *)=0
            bool SetExpr(const OEExprBase &)=0

      .. oe:language:: python

         .. oe:api:: python

            SetExpr(arg2: OEExprBase) -> bool

     This pure virtual method defines the interface for storage of an
     expression. The parent class instance takes ownership of the
     memory associated with the expression pointer.
     Any existing expressions stored in the parent instance will be
     destroyed.
     Stored expressions are destroyed along with their parent
     :ref:`OEQBase <OEChem_OEQBase>` object.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEQBondBase, QBondBase

..  _OEQBondBase:

.. _OEChem_OEQBondBase:

.. oe:class:: OEQBondBase

   .. oe:api::

      class OEQBondBase : public OEBondBase , public OEQBase

   The :ref:`OEQBondBase <OEChem_OEQBondBase>` class is the abstract interface
   for representing bonds and bond matching expressions within
   **OpenEye's Toolkits**.
   For a  description of query expressions and their utility in graph
   matching refer to the :ref:`section_patternmatch_OEExprOpts` section.  
   An :ref:`OEQBondBase <OEChem_OEQBondBase>` object is created by calling the
   :oe:meth:`OEChem::OEMolBase::NewBond` method on the parent molecule.

   The following methods are publicly inherited from :ref:`OEBondBase <OEChem_OEBondBase>`:

   ==================================================================== ===================================================================== ====================================================================
   :oe:meth:`operator=<OEChem::OEBondBase::operator=>`                  :oe:meth:`GetStereo<OEChem::OEBondBase::GetStereo>`                   :oe:meth:`SetChiral<OEChem::OEBondBase::SetChiral>`                 
   :oe:meth:`Clear<OEChem::OEBondBase::Clear>`                          :oe:meth:`GetType<OEChem::OEBondBase::GetType>`                       :oe:meth:`SetEnd<OEChem::OEBondBase::SetEnd>`                       
   :oe:meth:`GetBgn<OEChem::OEBondBase::GetBgn>`                        :oe:meth:`HasStereoSpecified<OEChem::OEBondBase::HasStereoSpecified>`
   :oe:meth:`GetBgnIdx<OEChem::OEBondBase::GetBgnIdx>`                  :oe:meth:`IsAromatic<OEChem::OEBondBase::IsAromatic>`                 :oe:meth:`SetInRing<OEChem::OEBondBase::SetInRing>`                 
   :oe:meth:`GetEnd<OEChem::OEBondBase::GetEnd>`                        :oe:meth:`IsChiral<OEChem::OEBondBase::IsChiral>`                     :oe:meth:`SetIntType<OEChem::OEBondBase::SetIntType>`               
   :oe:meth:`GetEndIdx<OEChem::OEBondBase::GetEndIdx>`                  :oe:meth:`IsDataType<OEChem::OEBondBase::IsDataType>`                 :oe:meth:`SetOrder<OEChem::OEBondBase::SetOrder>`                   
   :oe:meth:`GetIdx<OEChem::OEBondBase::GetIdx>`                        :oe:meth:`IsDeleted<OEChem::OEBondBase::IsDeleted>`                   :oe:meth:`SetStereo<OEChem::OEBondBase::SetStereo>`                 
   :oe:meth:`GetIntType<OEChem::OEBondBase::GetIntType>`                :oe:meth:`IsInRing<OEChem::OEBondBase::IsInRing>`                     :oe:meth:`SetType<OEChem::OEBondBase::SetType>`                     
   :oe:meth:`GetNbr<OEChem::OEBondBase::GetNbr>`                        :oe:meth:`IsRotor<OEChem::OEBondBase::IsRotor>`                       :oe:meth:`SwapEnds<OEChem::OEBondBase::SwapEnds>`                   
   :oe:meth:`GetOrder<OEChem::OEBondBase::GetOrder>`                    :oe:meth:`SetAromatic<OEChem::OEBondBase::SetAromatic>`               :oe:meth:`Sweep<OEChem::OEBondBase::Sweep>`                         
   :oe:meth:`GetParent<OEChem::OEBondBase::GetParent>`                  :oe:meth:`SetBgn<OEChem::OEBondBase::SetBgn>`                                                                                             
   ==================================================================== ===================================================================== ====================================================================

   The following methods are publicly inherited from :ref:`OEQBase <OEChem_OEQBase>`:

   ============================================ ============================================ ===========================================
   :oe:meth:`GetExpr<OEChem::OEQBase::GetExpr>` :oe:meth:`SetExpr<OEChem::OEQBase::SetExpr>`                                            
   ============================================ ============================================ ===========================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: GetParentBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondBase* GetParentBond() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetParentBond() -> OEBondBase

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEQMol, QMol

.. _OEChem_OEQMol:

.. oe:class:: OEQMol

   .. oe:api::

      class OEQMol

   The :ref:`OEQMol <OEChem_OEQMol>` is a specific implementation of query
   molecules.

   The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>`:

   =========================================================== =========================================================== ============================================================
   :oe:meth:`operator=<OEChem::OEMolBase::operator=>`          :oe:meth:`GetDimension<OEChem::OEMolBase::GetDimension>`    :oe:meth:`NumBonds<OEChem::OEMolBase::NumBonds>`            
   :oe:meth:`operator bool<OEChem::OEMolBase::operator bool>`  :oe:meth:`GetEnergy<OEChem::OEMolBase::GetEnergy>`          :oe:meth:`NumGroups<OEChem::OEMolBase::NumGroups>`          
   :oe:meth:`Clear<OEChem::OEMolBase::Clear>`                  :oe:meth:`GetGroup<OEChem::OEMolBase::GetGroup>`            :oe:meth:`OrderAtoms<OEChem::OEMolBase::OrderAtoms>`        
   :oe:meth:`ClearCoords<OEChem::OEMolBase::ClearCoords>`      :oe:meth:`GetGroups<OEChem::OEMolBase::GetGroups>`          :oe:meth:`OrderBonds<OEChem::OEMolBase::OrderBonds>`        
   :oe:meth:`Compress<OEChem::OEMolBase::Compress>`            :oe:meth:`GetMaxAtomIdx<OEChem::OEMolBase::GetMaxAtomIdx>`  :oe:meth:`ResetPerceived<OEChem::OEMolBase::ResetPerceived>`
   :oe:meth:`Count<OEChem::OEMolBase::Count>`                  :oe:meth:`GetMaxBondIdx<OEChem::OEMolBase::GetMaxBondIdx>`  :oe:meth:`SetCoords<OEChem::OEMolBase::SetCoords>`          
   :oe:meth:`CreateCopy<OEChem::OEMolBase::CreateCopy>`        :oe:meth:`GetTitle<OEChem::OEMolBase::GetTitle>`            :oe:meth:`SetDimension<OEChem::OEMolBase::SetDimension>`    
   :oe:meth:`DeleteAtom<OEChem::OEMolBase::DeleteAtom>`        :oe:meth:`HasPerceived<OEChem::OEMolBase::HasPerceived>`    :oe:meth:`SetEnergy<OEChem::OEMolBase::SetEnergy>`          
   :oe:meth:`DeleteBond<OEChem::OEMolBase::DeleteBond>`        :oe:meth:`IsDataType<OEChem::OEMolBase::IsDataType>`        :oe:meth:`SetPerceived<OEChem::OEMolBase::SetPerceived>`    
   :oe:meth:`DeleteGroup<OEChem::OEMolBase::DeleteGroup>`      :oe:meth:`IsDeleted<OEChem::OEMolBase::IsDeleted>`          :oe:meth:`SetRxn<OEChem::OEMolBase::SetRxn>`                
   :oe:meth:`GetAtom<OEChem::OEMolBase::GetAtom>`              :oe:meth:`IsRxn<OEChem::OEMolBase::IsRxn>`                  :oe:meth:`SetTitle<OEChem::OEMolBase::SetTitle>`            
   :oe:meth:`GetAtoms<OEChem::OEMolBase::GetAtoms>`            :oe:meth:`NewAtom<OEChem::OEMolBase::NewAtom>`              :oe:meth:`Sweep<OEChem::OEMolBase::Sweep>`                  
   :oe:meth:`GetBond<OEChem::OEMolBase::GetBond>`              :oe:meth:`NewBond<OEChem::OEMolBase::NewBond>`              :oe:meth:`UnCompress<OEChem::OEMolBase::UnCompress>`        
   :oe:meth:`GetBonds<OEChem::OEMolBase::GetBonds>`            :oe:meth:`NewGroup<OEChem::OEMolBase::NewGroup>`            
   :oe:meth:`GetCoords<OEChem::OEMolBase::GetCoords>`          :oe:meth:`NumAtoms<OEChem::OEMolBase::NumAtoms>`            
   =========================================================== =========================================================== ============================================================

   .. oe:language:: java

      The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>` only in Java:

      ====================================================== ====================================================== =========================================================
      :oe:meth:`GetAtomList<OEChem::OEMolBase::GetAtomList>` :oe:meth:`GetBondList<OEChem::OEMolBase::GetBondList>` :oe:meth:`GetGroupList<OEChem::OEMolBase::GetGroupList>` 
      ====================================================== ====================================================== =========================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      All query molecule constructors provide the ability to specify
      the implementation type through the 'type' argument.
      The default implementation type
      (:oe:const:`OEChem::OEQMolType::OEDefault`) is provided as a
      default argument when not explicitly specified.
      If additional query molecule implementations exist they will be
      listed in the :oe:constns:`OEChem::OEQMolType` namespace.

      .. note::

         Copy constructors which take a non-query molecule type as an
         argument do not, by default, build atom and bond expressions
         used in graph matching.
         The :oe:meth:`OEChem::OEQMolBase::BuildExpressions` method
         should be called to build query expressions after copy
         constructing a molecule using something other than a query
         molecule.

      .. oe:language:: c++ java csharp

         .. oe:api::

            explicit OEQMol(unsigned int type = OEQMolType::OEDefault)

      .. oe:language:: python

         .. oe:api:: python

            OEQMol(type: int = OEQMolType.OEDefault) -> OEQMol

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEQMol(const OEQMol &)

      .. oe:language:: python

         .. oe:api:: python

            OEQMol(m: OEQMol) -> OEQMol

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEQMol(const OEQMolBase &)
            explicit OEQMol(const OEQMolBase *)
            OEQMol(const OEQMol &, unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            OEQMol(qmol: OEQMol, type: int = OEQMolType.OEDefault) -> OEQMol

      Construct a query molecule from a query molecule
      (:ref:`OEQMol <OEChem_OEQMol>`).
      Atom and bond expressions will be copied from the source molecule.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEQMol(const OEQMolBase &, unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            OEQMol(qmol: OEQMol, type: int = OEQMolType.OEDefault) -> OEQMol

      Construct a query molecule from a query base molecule
      (:ref:`OEQMolBase <OEChem_OEQMolBase>`).
      Atom and bond expressions will be copied from the source molecule.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEQMol(const OEMol &, unsigned int type = OEQMolType::OEDefault)

      .. oe:language:: python

         .. oe:api:: python

            OEQMol(m: OEMol, t: int = OEQMolType.OEDefault) -> OEQMol

      Construct a query molecule from a multi-conformer molecule
      (:ref:`OEMol <OEChem_OEMol>`).

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEQMol(const OEMolBase &, unsigned int type = OEQMolType::OEDefault)

      Construct a query molecule from a base molecule
      (:ref:`OEMolBase <OEChem_OEMolBase>`).

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEQMol(const OEGraphMol &,
                   unsigned int type = OEQMolType::OEDefault)

      .. oe:language:: python

         .. oe:api:: python

            OEQMol(qmol: OEGraphMol, type: int = OEQMolType.OEDefault) -> OEQMol

      Construct a query molecule from a graph molecule
      (:ref:`OEGraphMol <OEChem_OEGraphMol>`).

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEQMol(const OEMCMolBase &,
                   unsigned int type = OEQMolType::OEDefault)

      .. oe:language:: python

         .. oe:api:: python

            OEQMol(m: OEMol, t: int = OEQMolType.OEDefault) -> OEQMol

      Construct a query molecule from a multi-conformer base molecule
      (:oe:cls:`OEChem::OEMCMolBase<OEChem::OEMCMolBase>`).

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEQMol &operator=(const OEMol &)
         OEQMol &operator=(const OEQMol &)
         OEQMol &operator=(const OEMolBase &)
         OEQMol &operator=(const OEQMolBase &)
         OEQMol &operator=(const OEGraphMol &)
         OEQMol &operator=(const OEMCMolBase &)

      Assignment operator.

   .. oe:method:: operator OEMolBase &
      :language: c++

      .. oe:api::

         operator const OEMolBase &() const
         operator OEMolBase &()

      Returns the query molecule as an :ref:`OEMolBase <OEChem_OEMolBase>` reference.

   .. oe:method:: operator OEQMolBase &
      :language: c++

      .. oe:api::

         operator const OEQMolBase &() const
         operator OEQMolBase &()

      Returns the query molecule as an :ref:`OEQMolBase <OEChem_OEQMolBase>` reference.

   .. oe:method:: BuildExpressions

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool BuildExpressions(const OEMatchPair<OEExprBase>& mp)
            bool BuildExpressions(unsigned int atomopts, unsigned int bondopts)

      .. oe:language:: python

         .. oe:api:: python

            BuildExpressions(mp: OEMatchPair[OEExprBase]) -> bool
            BuildExpressions(atomopts: int, bondopts: int) -> bool

   .. oe:method:: GetQAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEQAtomBase>* GetQAtoms() const
            OESystem::OEIterBase<OEQAtomBase>* GetQAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            GetQAtoms() -> OEQAtomIter
            GetQAtoms(pred: OEUnaryAtomPred) -> OEQAtomIter

   .. oe:method:: GetQBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEQBondBase>* GetQBonds() const
            OESystem::OEIterBase<OEQBondBase>* GetQBonds(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            GetQBonds() -> OEQBondIter
            GetQBonds(pred: OEUnaryBondPred) -> OEQBondIter

   .. oe:method:: QMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEQMolBase& QMol() const
            OEQMolBase& QMol()

      .. oe:language:: python

         .. oe:api:: python

            QMol() -> OEQMol

      Returns a query molecule (:ref:`OEQMol <OEChem_OEQMol>`) as an
      :ref:`OEQMolBase <OEChem_OEQMolBase>` reference.
      When passing an :ref:`OEQMol <OEChem_OEQMol>` object to a function
      which is overloaded to take either an :ref:`OEMolBase <OEChem_OEMolBase>`
      or :ref:`OEQMolBase <OEChem_OEQMolBase>` object it is necessary to
      explicitly specify which overloaded method is desired.
      This method is equivalent to the cast operator
      :oe:meth:`OEChem::OEQMol::operator OEQMolBase &`.

   .. oe:method:: SCMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMolBase& SCMol() const
            OEMolBase& SCMol()

      .. oe:language:: python

         .. oe:api:: python

            SCMol() -> OEGraphMol

      Returns a query molecule (:ref:`OEQMol <OEChem_OEQMol>`) as an
      :ref:`OEMolBase <OEChem_OEMolBase>` reference.
      When passing an :ref:`OEQMol <OEChem_OEQMol>` to a function which is
      overloaded to take either an :ref:`OEMolBase <OEChem_OEMolBase>` or
      :ref:`OEQMolBase <OEChem_OEQMolBase>` object it is necessary to explicitly
      specify which overloaded method is desired.
      This method is equivalent to the cast operator
      :oe:meth:`OEChem::OEQMol::operator OEMolBase &`.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEQMolBase, QMolBase

.. _OEChem_OEQMolBase:

.. oe:class:: OEQMolBase

   .. oe:api::

      class OEQMolBase : public OEMolBase

   This class represents `OEQMolBase`.

   The :ref:`OEQMolBase <OEChem_OEQMolBase>` is an abstract class that extends
   :ref:`OEMolBase <OEChem_OEMolBase>` and provides facilities useful in graph
   matching.
   Query molecules are used in matching operations such as
   substructure search (:ref:`OESubSearch <OEChem_OESubSearch>`), clique
   detection (:ref:`OECliqueSearch <OEChem_OECliqueSearch>`), and maximum common
   substructure search (:ref:`OEMCSSearch <OEChem_OEMCSSearch>`).
   Query expressions (:ref:`OEExprBase <OEChem_OEExprBase>`) stored in query
   atoms (:ref:`OEQAtomBase <OEChem_OEQAtomBase>`) and query bonds
   (:ref:`OEQBondBase <OEChem_OEQBondBase>`) are used to represent the boolean
   logic used in graph matching operations.
   Query molecules (:ref:`OEQMolBase <OEChem_OEQMolBase>`) conveniently collect
   query atoms and query bonds into a molecule suitable for use as a
   query graph in matching operations.
   As a derived type of :ref:`OEMolBase <OEChem_OEMolBase>`, query molecules
   are valid arguments for functions which take a base molecule class
   as an argument.

   The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>`:

   =========================================================== =========================================================== ============================================================
   :oe:meth:`operator=<OEChem::OEMolBase::operator=>`          :oe:meth:`GetDimension<OEChem::OEMolBase::GetDimension>`    :oe:meth:`NumBonds<OEChem::OEMolBase::NumBonds>`            
   :oe:meth:`operator bool<OEChem::OEMolBase::operator bool>`  :oe:meth:`GetEnergy<OEChem::OEMolBase::GetEnergy>`          :oe:meth:`NumGroups<OEChem::OEMolBase::NumGroups>`          
   :oe:meth:`Clear<OEChem::OEMolBase::Clear>`                  :oe:meth:`GetGroup<OEChem::OEMolBase::GetGroup>`            :oe:meth:`OrderAtoms<OEChem::OEMolBase::OrderAtoms>`        
   :oe:meth:`ClearCoords<OEChem::OEMolBase::ClearCoords>`      :oe:meth:`GetGroups<OEChem::OEMolBase::GetGroups>`          :oe:meth:`OrderBonds<OEChem::OEMolBase::OrderBonds>`        
   :oe:meth:`Compress<OEChem::OEMolBase::Compress>`            :oe:meth:`GetMaxAtomIdx<OEChem::OEMolBase::GetMaxAtomIdx>`  :oe:meth:`ResetPerceived<OEChem::OEMolBase::ResetPerceived>`
   :oe:meth:`Count<OEChem::OEMolBase::Count>`                  :oe:meth:`GetMaxBondIdx<OEChem::OEMolBase::GetMaxBondIdx>`  :oe:meth:`SetCoords<OEChem::OEMolBase::SetCoords>`          
   :oe:meth:`CreateCopy<OEChem::OEMolBase::CreateCopy>`        :oe:meth:`GetTitle<OEChem::OEMolBase::GetTitle>`            :oe:meth:`SetDimension<OEChem::OEMolBase::SetDimension>`    
   :oe:meth:`DeleteAtom<OEChem::OEMolBase::DeleteAtom>`        :oe:meth:`HasPerceived<OEChem::OEMolBase::HasPerceived>`    :oe:meth:`SetEnergy<OEChem::OEMolBase::SetEnergy>`          
   :oe:meth:`DeleteBond<OEChem::OEMolBase::DeleteBond>`        :oe:meth:`IsDataType<OEChem::OEMolBase::IsDataType>`        :oe:meth:`SetPerceived<OEChem::OEMolBase::SetPerceived>`    
   :oe:meth:`DeleteGroup<OEChem::OEMolBase::DeleteGroup>`      :oe:meth:`IsDeleted<OEChem::OEMolBase::IsDeleted>`          :oe:meth:`SetRxn<OEChem::OEMolBase::SetRxn>`                
   :oe:meth:`GetAtom<OEChem::OEMolBase::GetAtom>`              :oe:meth:`IsRxn<OEChem::OEMolBase::IsRxn>`                  :oe:meth:`SetTitle<OEChem::OEMolBase::SetTitle>`            
   :oe:meth:`GetAtoms<OEChem::OEMolBase::GetAtoms>`            :oe:meth:`NewAtom<OEChem::OEMolBase::NewAtom>`              :oe:meth:`Sweep<OEChem::OEMolBase::Sweep>`                  
   :oe:meth:`GetBond<OEChem::OEMolBase::GetBond>`              :oe:meth:`NewBond<OEChem::OEMolBase::NewBond>`              :oe:meth:`UnCompress<OEChem::OEMolBase::UnCompress>`        
   :oe:meth:`GetBonds<OEChem::OEMolBase::GetBonds>`            :oe:meth:`NewGroup<OEChem::OEMolBase::NewGroup>`            
   :oe:meth:`GetCoords<OEChem::OEMolBase::GetCoords>`          :oe:meth:`NumAtoms<OEChem::OEMolBase::NumAtoms>`            
   =========================================================== =========================================================== ============================================================

   .. oe:language:: java

      The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>` only in Java:

      ====================================================== ====================================================== =========================================================
      :oe:meth:`GetAtomList<OEChem::OEMolBase::GetAtomList>` :oe:meth:`GetBondList<OEChem::OEMolBase::GetBondList>` :oe:meth:`GetGroupList<OEChem::OEMolBase::GetGroupList>` 
      ====================================================== ====================================================== =========================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEQMolBase()
         OEQMolBase(const OEMolBase& m)
         OEQMolBase(const OEQMolBase& m)

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEQMolBase& operator=(const OEMolBase& rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OEMolBase <OEChem_OEMolBase>` object
      into the right-hand side :ref:`OEQMolBase <OEChem_OEQMolBase>` object.

      .. oe:api::

         OEQMolBase& operator=(const OEQMolBase& rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OEQMolBase <OEChem_OEQMolBase>` object
      into the right-hand side :ref:`OEQMolBase <OEChem_OEQMolBase>` object.

      Assignment operator.

   .. oe:method:: BuildExpressions

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool BuildExpressions(const OEMatchPair<OEExprBase> &)

      .. oe:language:: python

         .. oe:api:: python

            BuildExpressions(arg2: OEMatchPair[OEExprBase]) -> bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool BuildExpressions(unsigned int atomopts, unsigned int bondopts)

      .. oe:language:: python

         .. oe:api:: python

            BuildExpressions(atomopts: int, bondopts: int) -> bool

      Builds query expressions (:ref:`OEExprBase <OEChem_OEExprBase>`) for the
      atoms (:ref:`OEQAtomBase <OEChem_OEQAtomBase>`) and bonds
      (:ref:`OEQBondBase <OEChem_OEQBondBase>`) contained in a query molecule
      object.
      Any pre-existing query expressions are destroyed by this method.
      The bits in the unsigned integers passed to the method define
      how query expressions will be built based on the attributes of
      each atom and bond instance.
      The bitwise options are stored in the
      :oe:constns:`OEChem::OEExprOpts` namespace.
      This method provides the ability to convert attributes of base
      atoms and bonds to query expressions that are consistent with
      the semantics desired for a graph match procedure.
      Each requested expression is constructed, using data from the
      parent atom or bond if necessary.
      During a graph match procedure, the resulting expression
      composition will be used to evaluate atom and bond graph
      component equivalences.

      .. note::

         :oe:meth:`OEChem::OEQMolBase::BuildExpressions` uses the data
         present in a query molecule only when it is called.
         Subsequent modifications to atom and bond data to not cause
         the expressions to be updated to reflect changes.
         An additional call to
         :oe:meth:`OEChem::OEQMolBase::BuildExpressions` must be made
         to synchronize expressions with atom and bond data.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEQMolBase <OEChem_OEQMolBase>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 

   .. oe:method:: GetQAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEQAtomBase>* GetQAtoms() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetQAtoms() -> OEQAtomIter

      Returns an iterator over all the query atoms (:ref:`OEQAtomBase <OEChem_OEQAtomBase>`)
      of a query molecule. 
      By default, this returns all the query atoms of the molecule in the order
      they were created. The ordering of the atoms returned by
      :oe:meth:`OEChem::OEQMolBase::GetQAtoms` may be modified by
      :oe:meth:`OEChem::OEMolBase::OrderAtoms`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEQAtomBase>* GetQAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetQAtoms(arg2: OEUnaryAtomPred) -> OEQAtomIter

      Returns an iterator over all of the query atoms of a query molecule that
      match the specified atom predicate
      (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`).

   .. oe:method:: GetQBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEQBondBase>* GetQBonds() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetQBonds() -> OEQBondIter

      Returns an iterator over all the query bonds (:ref:`OEQBondBase <OEChem_OEQBondBase>`)
      of a query molecule. 
      By default, this returns all the query bonds of the molecule in the order
      they were created. The ordering of the bonds returned by
      :oe:meth:`OEChem::OEQMolBase::GetQBonds` may be modified by
      :oe:meth:`OEChem::OEMolBase::OrderBonds`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEQBondBase>* GetQBonds(const OESystem::OEUnaryPredicate<OEChem::OEBondBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetQBonds(arg2: OEUnaryBondPred) -> OEQBondIter

      Returns an iterator over all of the query bonds of a query molecule that
      match the specified bond predicate
      (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`).

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEQuaternion, Quaternion

.. _OEChem_OEQuaternion:

.. oe:class:: OEQuaternion

   .. oe:api::

      class OEQuaternion : public OETransBase

   This class represents `OEQuaternion`.

   The :ref:`OEQuaternion <OEChem_OEQuaternion>` class performs quaternion
   rotation transformation.

   .. This quaternion object does not include a translation, thus the
      vec arrays are assumed to be of length three and the quat arrays of
      length four.

   The following methods are publicly inherited from :ref:`OETransBase <OEChem_OETransBase>`:

   ====================================================== ====================================================== =====================================================
   :oe:meth:`CreateCopy<OEChem::OETransBase::CreateCopy>` :oe:meth:`GetInverse<OEChem::OETransBase::GetInverse>`                                                      
   :oe:meth:`Extract<OEChem::OETransBase::Extract>`       :oe:meth:`Transform<OEChem::OETransBase::Transform>`                                                        
   ====================================================== ====================================================== =====================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEQuaternion()
            OEQuaternion(const float* quat)
            OEQuaternion(const double* quat)
            OEQuaternion(const float* vec, float angle)
            OEQuaternion(const double* vec, double angle)
            OEQuaternion(const double w, const double x, const double y,
                         const double z)
            OEQuaternion(const float w, const float x, const float y,
                         const float z)

      .. oe:language:: python

         .. oe:api:: python

            OEQuaternion() -> OEQuaternion
            OEQuaternion(w: float, x: float, y: float, z: float) -> OEQuaternion
            OEQuaternion(vec: OEDoubleArray, angle: float) -> OEQuaternion
            OEQuaternion(vec: OEFloatArray, angle: float) -> OEQuaternion
            OEQuaternion(quat: OEDoubleArray) -> OEQuaternion
            OEQuaternion(quat: OEFloatArray) -> OEQuaternion

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEQuaternion &operator=(const float *quat)
         OEQuaternion &operator=(const double *quat)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETransBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OETransBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEQuaternion <OEChem_OEQuaternion>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 

   .. oe:method:: Extract

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Extract(float* r, float* t) const
            void Extract(float* r, double* t) const
            void Extract(double* r, float* t) const
            void Extract(double* r, double* t) const

      .. oe:language:: python

         .. oe:api:: python

            Extract(r: OEFloatArray, t: OEFloatArray) -> None
            Extract(r: OEFloatArray, t: OEDoubleArray) -> None
            Extract(r: OEDoubleArray, t: OEFloatArray) -> None
            Extract(r: OEDoubleArray, t: OEDoubleArray) -> None

   .. oe:method:: GetInverse

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETransBase* GetInverse() const

      .. oe:language:: python

         .. oe:api:: python

            GetInverse() -> OETransBase

   .. oe:method:: GetQuaternion

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetQuaternion(float* quat) const
            void GetQuaternion(double* quat) const

      .. oe:language:: python

         .. oe:api:: python

            GetQuaternion(quat: OEFloatArray) -> None
            GetQuaternion(quat: OEDoubleArray) -> None

   .. oe:method: _Extract NO NOT DOCUMENT

      .. oe:api::

         template<class T, class U>
         void _Extract(T *rmat, U *trans) const


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OERefInputAppOptions, RefInputAppOptions

.. _OEChem_OERefInputAppOptions:

.. oe:class:: OERefInputAppOptions

   .. oe:api::

      class OERefInputAppOptions : public OESystem::OEOptions

   The :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>` represents an options class,
   representing an applications interface that requires an additional reference or target input, 
   along with an input reader and an output writer file.

   .. seealso::

      * :ref:`OEOptions <OESystem_OEOptions>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_docking` example
      * :ref:`section_examples_posing` example

   The :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>` class defines the following public methods:
    * :oe:meth:`GetInFile<OEChem::OERefInputAppOptions::GetInFile>` and
      :oe:meth:`SetInFile<OEChem::OERefInputAppOptions::SetInFile>`
    * :oe:meth:`GetOutFile<OEChem::OERefInputAppOptions::GetOutFile>` and
      :oe:meth:`SetOutFile<OEChem::OERefInputAppOptions::SetOutFile>`
    * :oe:meth:`GetRefFile<OEChem::OERefInputAppOptions::GetRefFile>` and
      :oe:meth:`SetRefFile<OEChem::OERefInputAppOptions::SetRefFile>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERefInputAppOptions(const OESystem::OEOptions& opts,
                                 const std::string& name,
                                 const unsigned inFileType,
                                 const unsigned outFileType,
                                 const unsigned refFileType,
                                 const std::string& refCmdName)
            OERefInputAppOptions(const OESystem::OEOptions& opts,
                                 const std::string& name,
                                 const unsigned inFileType,
                                 const unsigned outFileType,
                                 const std::string& refFileExt,
                                 const std::string& refCmdName)
            OERefInputAppOptions(const OESystem::OEOptions& opts,
                                 const std::string& name,
                                 const unsigned inFileType,
                                 const unsigned refFileType,
                                 const std::string& refCmdName)
            OERefInputAppOptions(const OESystem::OEOptions& opts,
                                 const std::string& name,
                                 const unsigned inFileType,
                                 const std::string& refFileExt,
                                 const std::string& refCmdName)
            OERefInputAppOptions(const OERefInputAppOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OERefInputAppOptions(opts: OEOptions, name: str, inFileType: int,
                                 outFileType: int, refFileType: int,
                                 refCmdName: str) -> OERefInputAppOptions
            OERefInputAppOptions(opts: OEOptions, name: str, inFileType: int,
                                 outFileType: int, refFileExt: str,
                                 refCmdName: str) -> OERefInputAppOptions
            OERefInputAppOptions(opts: OEOptions, name: str, inFileType: int,
                                 refFileType: int, refCmdName: str) -> OERefInputAppOptions
            OERefInputAppOptions(opts: OEOptions, name: str, inFileType: int,
                                 refFileExt: str, refCmdName: str) -> OERefInputAppOptions
            OERefInputAppOptions(arg2: OERefInputAppOptions) -> OERefInputAppOptions

      Default and copy constructors.

      The ``opts`` represents the sub-options that should be wrapped to extend this options to generate
      the API for the intended application, the ``name`` represents the name of the application, and the
      ``refCmdName`` represents the command line flag for reference input. The ``inFileType``, ``outFileType``, 
      and ``refFileType`` refers to if the input, output and the reference input file types as defined in the
      :oe:constns:`OEChem::OEFileStringType` namespace. The second overload accepts the reference input file 
      type as a string. Variation of constructors that does not require an output file can
      be used when an output is not desired in an application.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERefInputAppOptions &operator=(const OERefInputAppOptions &)

      Assignment operator.
   
   .. oe:method:: GetInFile

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetInFile() const

      .. oe:language:: python

         .. oe:api:: python

            GetInFile() -> str

      See :oe:meth:`SetInFile<OEChem::OERefInputAppOptions::SetInFile>` method.

   .. oe:method:: GetOutFile

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetOutFile() const

      .. oe:language:: python

         .. oe:api:: python

            GetOutFile() -> str

      See :oe:meth:`SetOutFile<OEChem::OERefInputAppOptions::SetOutFile>` method.

   .. oe:method:: GetRefFile

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetRefFile() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefFile() -> str

      See :oe:meth:`SetRefFile<OEChem::OERefInputAppOptions::SetRefFile>` method.

   .. oe:method:: SetInFile

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetInFile(string)

      .. oe:language:: python

         .. oe:api:: python

            SetInFile(value: str) -> bool

      Sets name of the input file for the application. **Default: None**

   .. oe:method:: SetOutFile

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOutFile(string)

      .. oe:language:: python

         .. oe:api:: python

            SetOutFile(value: str) -> bool

      Sets name of the output file for the application. **Default: None**

   .. oe:method:: SetRefFile

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRefFile(string)

      .. oe:language:: python

         .. oe:api:: python

            SetRefFile(value: str) -> bool

      Sets name of the reference/target input file for the application. **Default: None**


.. oe:namespace:: OEChem

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. meta::
   :keywords: OEResidue, Residue

.. _OEChem_OEResidue:

.. oe:class:: OEResidue

   .. oe:api::

      class OEResidue

   The :ref:`OEResidue <OEChem_OEResidue>` class is used to attach biopolymer
   information to each :ref:`OEAtomBase <OEChem_OEAtomBase>` object.
   This class contains a number of fields specific to processing
   macromolecules, such as proteins and nucleic acids.
   Each atom may be annotated with a unique
   :ref:`OEResidue <OEChem_OEResidue>`, hence :ref:`OEResidue <OEChem_OEResidue>`
   objects are not shared between different atoms.
   If the fields of an :ref:`OEResidue <OEChem_OEResidue>` associated with a
   single atom are updated, only that atom is affected.
   To adapt to the change for mmCIF where a chainID can now contain
   multiple characters, the chainID is now stored as an string. The
   existing GetChainID() function will return just the first character
   of the chain ID. We encourage users to switch to use GetExtChainID()
   which will return the string.

   .. seealso::

      * :oe:func:`OEChem::OEHasResidue` function
      * :oe:func:`OEChem::OEAtomGetResidue` function
      * :oe:func:`OEChem::OEAtomSetResidue` function

   .. note::

      See section :ref:`section_biopolymer_residues` for a detailed description
      of the data stored in an :ref:`OEResidue <OEChem_OEResidue>`.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEResidue()

      .. oe:language:: python

         .. oe:api:: python

            OEResidue() -> OEResidue

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEResidue(const OEResidue& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEResidue(rhs: OEResidue) -> OEResidue

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEResidue &operator=(const OEResidue &rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OEResidue <OEChem_OEResidue>` object
      into the right-hand side :ref:`OEResidue <OEChem_OEResidue>` object.

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Determines whether any field of an :ref:`OEResidue <OEChem_OEResidue>`
      has a non-default value.

   .. oe:language:: c++

      .. oe:method:: Comparison Operators

         .. oe:api::

            bool operator==(const OEResidue& rhs) const
            bool operator!=(const OEResidue& rhs) const
            bool operator<(const OEResidue& rhs) const
            bool operator<=(const OEResidue& rhs) const
            bool operator>(const OEResidue& rhs) const
            bool operator>=(const OEResidue& rhs) const

         The comparison operators compare properties of two
         :oe:cls:`OEResidue<OEChem::OEResidue>` objects.
         Two residues are considered equal if all their properties are equal.
         The <, <=, >, and >= operators consider the residue properties in
         the following order: model number, chain ID, fragment number,
         residue number, insertion code, and residue name.

         Because of the existence of the < operator, it is possible to sort
         containers by residue, and also to create std::map containers using
         :oe:cls:`OEResidue<OEChem::OEResidue>` as a key.  The residue sorting
         order produced by the < operator is the same as that produced by
         :oe:func:`OEPDBOrderAtoms<OEChem::OEPDBOrderAtoms>`.

   .. oe:method:: GetAlternateLocation

      .. oe:language:: c++ java csharp

         .. oe:api::

            char GetAlternateLocation() const

      .. oe:language:: python

         .. oe:api:: python

            GetAlternateLocation() -> str

      Returns the 'alternate location' property of an atom in a
      residue. The 'alternate location' property may be set using the
      :oe:meth:`OEChem::OEResidue::SetAlternateLocation` method.

   .. oe:method:: GetBFactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBFactor() const

      .. oe:language:: python

         .. oe:api:: python

            GetBFactor() -> float

      Returns the crystallographic 'b-factor' property of an atom in a
      residue. The 'b-factor' property may be set using the
      :oe:meth:`OEChem::OEResidue::SetBFactor` method.

      .. seealso::

         * :ref:`OEHasAnisou <OEChem_OEHasAnisou>`
         * :oe:func:`OEChem::OEGetAnisou`
         * :oe:func:`OEChem::OESetAnisou`

   .. oe:method:: GetChainID

      .. oe:language:: c++ java csharp

         .. oe:api::

            char GetChainID() const

      .. oe:language:: python

         .. oe:api:: python

            GetChainID() -> str

      This method is deprecated and should no longer be used.
      Instead, use :oe:meth:`OEChem::OEResidue::GetExtChainID`.
      Returns the first character of the 'chain identifier' property
      of the residue. The 'chain identifier' property may be set using
      the :oe:meth:`OEChem::OEResidue::SetExtChainID` method.

   .. oe:method:: GetExtChainID

      .. oe:language:: c++ java csharp

         .. oe:api::

            string GetExtChainID() const

      .. oe:language:: python

         .. oe:api:: python

            GetExtChainID() -> str

      Returns the 'chain identifier' property of the residue.
      The 'chain identifier' property may be set using
      the :oe:meth:`OEChem::OEResidue::SetExtChainID` method.
      If reading from mmCIF, this property is ``auth_asym_id`` field from the mmCIF spec.

   .. oe:method:: GetSubChainID

      .. oe:language:: c++ java csharp

         .. oe:api::

            string GetSubChainID() const

      .. oe:language:: python

         .. oe:api:: python

            GetSubChainID() -> str

      Returns the 'subchain identifier' property
      of the residue. The 'subchain identifier' property may be set using
      the :oe:meth:`OEChem::OEResidue::SetSubChainID` method.
      When reading from PDB, this is default to a space character. When reading from
      mmCIF, these are now a further subdivision of the chain identifier based on connected
      components. If reading from mmCIF, this property is ``label_asym_id`` field from the mmCIF spec.

   .. oe:method:: GetFragmentNumber

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetFragmentNumber() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragmentNumber() -> int

      Returns the 'fragment number' property of a residue. Fragment
      numbers are integer indices that define connected components of
      a macromolecule.
      When reading from a PDB file, the first atom is placed in
      fragment number ``1``.
      Each time a `TER`_, `END`_ or `ENDM`_ record is encountered
      within a single connection table, the fragment number is
      incremented.
      Similarly, when writing a PDB file, a `TER`_ record is written
      between any consecutive pair of atoms with different fragment
      numbers.
      The fragment number property may be set using the
      :oe:meth:`OEChem::OEResidue::SetFragmentNumber` number property.

   .. oe:method:: GetInsertCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            char GetInsertCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetInsertCode() -> str

      Returns the 'insertion code' of a residue.
      Insertion codes are single character suffixes used to
      distinguish insertions when using a standardized residue
      numbering system.
      By default, this property contains a single space character, ``' '``.
      The insertion code property of a residue may be set using the
      :oe:meth:`OEChem::OEResidue::SetInsertCode` method.

   .. oe:method:: GetModelNumber

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetModelNumber() const

      .. oe:language:: python

         .. oe:api:: python

            GetModelNumber() -> int

      Returns the 'model number' property of a residue. For NMR or
      molecular dynamics files, the model number contains the index of
      the NMR model or dynamics time-step within a file.
      When reading from mmCIF, the model numbers start from 1.
      The 'model number' property may be set using the
      :oe:meth:`OEChem::OEResidue::SetModelNumber` method.

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the 'residue name' property of a residue. The 'residue
      name' property may be set using the
      :oe:meth:`OEChem::OEResidue::SetName` method.

   .. oe:method:: GetOccupancy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetOccupancy() const

      .. oe:language:: python

         .. oe:api:: python

            GetOccupancy() -> float

      Returns the crystallographic 'occupancy' property of an atom in
      a residue. The default value is ``1.0``. The 'occupancy'
      property may be set using the
      :oe:meth:`OEChem::OEResidue::SetOccupancy` method.

   .. oe:method:: GetResidueNumber

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetResidueNumber() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidueNumber() -> int

      Returns the 'residue number' property of a residue. The 'residue
      number' property may be set using the
      :oe:meth:`OEChem::OEResidue::SetResidueNumber` method.

   .. oe:method:: GetEntityID

      .. oe:language:: c++ java csharp

         .. oe:api::

            string GetEntityID() const

      .. oe:language:: python

         .. oe:api:: python

            GetEntityID() -> str

      Returns the 'entity ID' property of a residue. The 'entity ID' 
      property may be set using the
      :oe:meth:`OEChem::OEResidue::SetEntityID` method.

   .. oe:method:: GetSequenceID

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetSequenceID() const

      .. oe:language:: python

         .. oe:api:: python

            GetSequenceID() -> int

      Returns the 'sequence id' property of a residue, if set by reading an mmCIF file. The 'sequence
      id' property may be set using the :oe:meth:`OEChem::OEResidue::SetSequenceID` method.
      The number of typically sequential starting from 1, contrary to the
      'residue number' which typically follows the biological sequence numbering.
      If reading from mmCIF, this property is ``label_seq_id`` field from the mmCIF spec.

   .. oe:method:: GetSecondaryStructure

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetSecondaryStructure() const

      .. oe:language:: python

         .. oe:api:: python

            GetSecondaryStructure() -> int

      Returns the protein 'secondary structure'  property of a
      residue.
      The default value is zero.
      The 'secondary structure' property of a residue may be set using
      the :oe:meth:`OEChem::OEResidue::SetSecondaryStructure` method.

   .. oe:method:: GetSerialNumber

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetSerialNumber() const

      .. oe:language:: python

         .. oe:api:: python

            GetSerialNumber() -> int

      Returns the 'atom serial number' property of an atom in a
      residue. The 'atom serial number' property may be set using the
      :oe:meth:`OEChem::OEResidue::SetSerialNumber` method.

   .. oe:method:: IsHetAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsHetAtom() const

      .. oe:language:: python

         .. oe:api:: python

            IsHetAtom() -> bool

      Returns the 'hetero atom' property of an atom in a residue.
      The 'hetero atom' property may be set using the
      :oe:meth:`OEChem::OEResidue::SetHetAtom` method.

      .. note::

         A 'hetero atom' is distinguished from a 'standard atom' in a PDB file
         by using the record type ``HETATM`` rather than ``ATOM``.

   .. oe:method:: SetAlternateLocation

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAlternateLocation(char v)

      .. oe:language:: python

         .. oe:api:: python

            SetAlternateLocation(v: str) -> bool

      Sets the 'alternate location' property of an atom in a residue.
      The default value is a space character.
      The 'alternate location' property of an atom in a residue may be
      retrieved using the
      :oe:meth:`OEChem::OEResidue::GetAlternateLocation` method.

   .. oe:method:: SetBFactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBFactor(float v)

      .. oe:language:: python

         .. oe:api:: python

            SetBFactor(v: float) -> bool

      Sets the crystallographic 'b-factor' property of an atom in a residue.
      The default value is ``0.0``.
      The 'b-factor' property of an atom in a residue may be retrieved
      using the :oe:meth:`OEChem::OEResidue::GetBFactor` method.

      .. seealso::

         * :ref:`OEHasAnisou <OEChem_OEHasAnisou>`
         * :oe:func:`OEChem::OESetAnisou`
         * :oe:func:`OEChem::OEGetAnisou`

   .. oe:method:: SetChainID

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetChainID(char v)

      .. oe:language:: python

         .. oe:api:: python

            SetChainID(v: str) -> bool

      This method is deprecated and should no longer be used. Instead, use :oe:meth:`OEChem::OEResidue::SetExtChainID`.
      Sets the 'chain identifier' property of a residue.
      This sets the same property as :oe:meth:`OEChem::OEResidue::SetExtChainID`
      The default value is a space character. The 'chain identifier' property of a residue may be retrieved
      using the :oe:meth:`OEChem::OEResidue::GetExtChainID` method.

   .. oe:method:: SetExtChainID

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetExtChainID(const string &)

      .. oe:language:: python

         .. oe:api:: python

            SetExtChainID(v: str) -> bool

      Sets the 'chain identifier' property of a residue.
      The default value is a space character. The 'chain identifier' property of a residue may be retrieved
      using the :oe:meth:`OEChem::OEResidue::GetExtChainID` method.

   .. oe:method:: SetSubChainID

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSubChainID(const string &)

      .. oe:language:: python

         .. oe:api:: python

            SetSubChainID(v: str) -> bool

      Sets the 'subchain identifier' property of a residue.
      The default value is a space character. The 'subchain identifier' property of a residue may be retrieved
      using the :oe:meth:`OEChem::OEResidue::GetSubChainID` method.

   .. oe:method:: SetFragmentNumber

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFragmentNumber(int v)

      .. oe:language:: python

         .. oe:api:: python

            SetFragmentNumber(v: int) -> bool

      Sets the fragment number property of a residue.
      Fragment numbers are integer indices that define the connected
      components of a macromolecule.
      When reading from a PDB file, the first atom is placed in
      fragment number ``1``.
      Each time a `TER`_, `END`_ or `ENDM`_ record is encountered
      within a single connection table, the fragment number is
      incremented.
      Similarly, when writing a PDB file, a `TER`_ record is written
      between any consecutive pair of atoms with different fragment
      numbers.
      When reading from an mmCIF file, this number is read directly
      from the input as it is defined in that file spec.
      The default value is zero.
      The 'fragment number' property of a residue may be retrieved
      using the :oe:meth:`OEChem::OEResidue::GetFragmentNumber` method.

   .. oe:method:: SetHetAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetHetAtom(bool v)

      .. oe:language:: python

         .. oe:api:: python

            SetHetAtom(v: bool) -> bool

      Set the 'hetero atom' property of an atom in a residue.
      The default value is ``false``.
      The 'hetero atom' property of an atom in a residue may be
      retrieved using the :oe:meth:`OEChem::OEResidue::IsHetAtom`
      method.

   .. oe:method:: SetInsertCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetInsertCode(char v)

      .. oe:language:: python

         .. oe:api:: python

            SetInsertCode(v: str) -> bool

      Sets the 'insertion code' of a residue.
      Insertion codes are single character suffices used to
      distinguish insertions when using a standardized residue
      numbering system.
      By default, this property contains a single space character ``' '``.
      The 'insertion code' property of a residue may be retrieved using
      the :oe:meth:`OEChem::OEResidue::GetInsertCode` method.

   .. oe:method:: SetModelNumber

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetModelNumber(int v)

      .. oe:language:: python

         .. oe:api:: python

            SetModelNumber(v: int) -> bool

      Sets the `model number` property of a residue.
      For NMR or molecular dynamics files, the model number contains
      the index of the NMR model or dynamics time-step within a file.
      The default value is 0.
      The 'model number' property of a residue may be retrieved using
      the :oe:meth:`OEChem::OEResidue::GetModelNumber` method.

   .. oe:method:: SetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetName(const char* v)
            bool SetName(const std::string& v)

      .. oe:language:: python

         .. oe:api:: python

            SetName(v: str) -> bool

      Sets the 'residue name' property of a residue.
      The default value is ``MOL``.
      The 'residue name' property of a residue may be retrieved using
      the :oe:meth:`OEChem::OEResidue::GetName` method.

   .. oe:method:: SetOccupancy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOccupancy(float v)

      .. oe:language:: python

         .. oe:api:: python

            SetOccupancy(v: float) -> bool

      Sets the crystallographic 'occupancy' property of an atom in a residue.
      The default value is ``1.0``.
      The 'occupancy' property of an atom in a molecule may be
      retrieved using the :oe:meth:`OEChem::OEResidue::GetOccupancy`
      method.

   .. oe:method:: SetResidueNumber

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetResidueNumber(int v)

      .. oe:language:: python

         .. oe:api:: python

            SetResidueNumber(v: int) -> bool

      Sets the 'residue number' property of a residue.
      The default value is ``1``.
      The 'residue number' property of a residue may be retrieved
      using the :oe:meth:`OEChem::OEResidue::GetResidueNumber` method.

   .. oe:method:: SetEntityID

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEntityID(const string &)

      .. oe:language:: python

         .. oe:api:: python

            SetEntityID(v: str) -> bool

      Sets the 'Entity ID' property of a residue.
      The default value is a single space character, ``' '``.
      The 'Entity ID' property of a residue may be retrieved
      using the :oe:meth:`OEChem::OEResidue::GetEntityID` method.

   .. oe:method:: SetSequenceID

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSequenceID(int v)

      .. oe:language:: python

         .. oe:api:: python

            SetSequenceID(v: int) -> bool

      Sets the 'sequence id' property of a residue.
      The default value is ``-1``.
      The 'sequence id' property of a residue may be retrieved
      using the :oe:meth:`OEChem::OEResidue::GetSequenceID` method.

   .. oe:method:: SetSecondaryStructure

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSecondaryStructure(int v)

      .. oe:language:: python

         .. oe:api:: python

            SetSecondaryStructure(v: int) -> bool

      Sets the protein 'secondary structure' property of a residue.
      The default value is 0.
      The 'secondary structure' property of a residue may be retrieved
      using the :oe:meth:`OEChem::OEResidue::GetSecondaryStructure`
      method.

   .. oe:method:: SetSerialNumber

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSerialNumber(int v)

      .. oe:language:: python

         .. oe:api:: python

            SetSerialNumber(v: int) -> bool

      Sets the 'atom serial number' property of an atom in a residue.
      The default value is 0.
      The 'atom serial number' property may be retrieved using the
      :oe:meth:`OEChem::OEResidue::GetSerialNumber` method.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OERotMatrix, RotMatrix

.. _OEChem_OERotMatrix:

.. oe:class:: OERotMatrix

   .. oe:api::

      class OERotMatrix : public OETransBase

   This class represents `OERotMatrix`.

   The :ref:`OERotMatrix <OEChem_OERotMatrix>` class performs rotation specified
   by a rotation matrix.

   .. The mat array in the constructors is assumed to be of length nine.

   The following methods are publicly inherited from :ref:`OETransBase <OEChem_OETransBase>`:

   ====================================================== ====================================================== =====================================================
   :oe:meth:`CreateCopy<OEChem::OETransBase::CreateCopy>` :oe:meth:`GetInverse<OEChem::OETransBase::GetInverse>`                                                      
   :oe:meth:`Extract<OEChem::OETransBase::Extract>`       :oe:meth:`Transform<OEChem::OETransBase::Transform>`                                                        
   ====================================================== ====================================================== =====================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERotMatrix()
            OERotMatrix(const float* mat)
            OERotMatrix(const double* mat)
            OERotMatrix(const OERotMatrix& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OERotMatrix() -> OERotMatrix
            OERotMatrix(mat: OEDoubleArray) -> OERotMatrix
            OERotMatrix(mat: OEFloatArray) -> OERotMatrix
            OERotMatrix(rhs: OERotMatrix) -> OERotMatrix

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERotMatrix &operator=(const float *mat)
         OERotMatrix &operator=(const double *mat)
         OERotMatrix &operator=(const OERotMatrix& rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETransBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OETransBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OERotMatrix <OEChem_OERotMatrix>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 

   .. oe:method:: Extract

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Extract(float* r, float* t) const
            void Extract(double* r, float* t) const
            void Extract(float* r, double* t) const
            void Extract(double* r, double* t) const

      .. oe:language:: python

         .. oe:api:: python

            Extract(r: OEFloatArray, t: OEFloatArray) -> None
            Extract(r: OEDoubleArray, t: OEFloatArray) -> None
            Extract(r: OEFloatArray, t: OEDoubleArray) -> None
            Extract(r: OEDoubleArray, t: OEDoubleArray) -> None

   .. oe:method:: GetInverse

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETransBase* GetInverse() const

      .. oe:language:: python

         .. oe:api:: python

            GetInverse() -> OETransBase

   .. oe:method:: GetRotMatrix

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetRotMatrix(float* mat) const
            void GetRotMatrix(double* mat) const

      .. oe:language:: python

         .. oe:api:: python

            GetRotMatrix(mat: OEFloatArray) -> None
            GetRotMatrix(mat: OEDoubleArray) -> None

   .. oe:method: _Extract NO NOT DOCUMENT

      .. oe:api::

         template<class T, class U>
         void _Extract(T *rmat, U *trans) const



.. role:: raw-html(raw)
   :format: html

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OERxnAutomapper, RxnAutomapper

.. _OEChem_OERxnAutomapper:

.. oe:class:: OERxnAutomapper

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OERxnAutomapper

   Applies reactant and product reaction mapping correspondence information to a reaction molecule.

   .. seealso::

      * :ref:`OERxnAutomapperOption <OEChem_OERxnAutomapperOptions>` class

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERxnAutomapper()

      .. oe:language:: python

         .. oe:api:: python

            OERxnAutomapper() -> OERxnAutomapper

      Default constructor that initializes an :ref:`OERxnAutomapper <OEChem_OERxnAutomapper>`
      object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERxnAutomapper(const OERxnAutomapperOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            OERxnAutomapper(opts: OERxnAutomapperOptions) -> OERxnAutomapper

      Constructor that initializes an :ref:`OERxnAutomapper <OEChem_OERxnAutomapper>`
      object with the provided option class settings.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERxnAutomapper(const OERxnAutomapper& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OERxnAutomapper(arg2: OERxnAutomapper) -> OERxnAutomapper

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERxnAutomapper &operator=(const OERxnAutomapper &rhs)

      Assignment operator.

   .. ################################################################
      # AutoMapRxn
      ################################################################

   .. oe:method:: AutoMapRxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned AutoMapRxn(OEMolBase& rxn)

      .. oe:language:: python

         .. oe:api:: python

            AutoMapRxn(rxn: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Requests the provided reaction be processed to apply atom-atom mapping correspondence.

   .. seealso::

      * :ref:`OERxnAutomapStatus <OEChem_OERxnAutomapStatus>` namespace

   .. ################################################################
      # GetOptions
      ################################################################

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OERxnAutomapperOptions& GetOptions() const
            OERxnAutomapperOptions& GetOptions()

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OERxnAutomapperOptions

      Returns the internal option class that controls the automap activities.



.. role:: raw-html(raw)
   :format: html

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OERxnAutomapperOptions, RxnAutomapperOptions

.. _OEChem_OERxnAutomapperOptions:

.. oe:class:: OERxnAutomapperOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OERxnAutomapperOptions

   Encapsulates the properties that control reaction mapping using :ref:`OERxnAutomapper <OEChem_OERxnAutomapper>`.

   .. seealso::

      * :ref:`OERxnAutomapper <OEChem_OERxnAutomapper>` class

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERxnAutomapperOptions()

      .. oe:language:: python

         .. oe:api:: python

            OERxnAutomapperOptions() -> OERxnAutomapperOptions

      Default constructor that initializes an :ref:`OERxnAutomapperOptions <OEChem_OERxnAutomapperOptions>`
      object with the following properties:

      .. list-table::  **Default parameters of OERxnAutomapperOptions**
         :widths: 50 50 50
         :header-rows: 1

         * - Description
           - Option
           - Default value

         * - Mapping Method
           - :oe:meth:`GetMappingMethod()<OEChem::OERxnAutomapperOptions::GetMappingMethod>`
           - :oe:const:`OEChem::OERxnAutomapMethod::MCSMapping`

         * - MCS Mapping Mode
           - :oe:meth:`GetMCSExhaustiveMode()<OEChem::OERxnAutomapperOptions::GetMCSExhaustiveMode>`
           - ``false``

         * - Clear Mapping
           - :oe:meth:`GetClearMapping()<OEChem::OERxnAutomapperOptions::GetClearMapping>`
           - ``true``

         * - Extend Mapping
           - :oe:meth:`GetExtendMappedRegions()<OEChem::OERxnAutomapperOptions::GetExtendMappedRegions>`
           - ``true``

         * - Strict Mapping
           - :oe:meth:`GetStrictMapping()<OEChem::OERxnAutomapperOptions::GetStrictMapping>`
           - ``false``

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERxnAutomapperOptions(const OERxnAutomapperOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OERxnAutomapperOptions(arg2: OERxnAutomapperOptions) -> OERxnAutomapperOptions

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERxnAutomapperOptions &operator=(const OERxnAutomapperOptions &rhs)

      Assignment operator.

   .. ################################################################
      # GetClearMapping
      ################################################################

   .. oe:method:: GetClearMapping

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetClearMapping() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearMapping() -> bool

      Returns whether existing atom-atom mappings should be cleared prior
      to attempting the reaction mapping activity.  Existing atom-atom mappings
      *may* be used to guide the reaction mapping activity if not cleared.

      .. seealso::

         * :oe:meth:`OEChem::OEAtomBase::GetMapIdx` method
         * :oe:meth:`OEChem::OEAtomBase::SetMapIdx` method

   .. ################################################################
      # GetExtendMappedRegions
      ################################################################

   .. oe:method:: GetExtendMappedRegions

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetExtendMappedRegions() const

      .. oe:language:: python

         .. oe:api:: python

            GetExtendMappedRegions() -> bool

      Returns whether unassigned mapped regions can be augmented with unambiguous
      reactant and product atom correspondences to maximize the size of the reaction mapping.

   .. ################################################################
      # GetMappingMethod
      ################################################################

   .. oe:method:: GetMappingMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMappingMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetMappingMethod() -> int

      Returns the requested mapping method to use for the reaction mapping correspondence.

   .. ################################################################
      # GetMCSExhaustiveMode
      ################################################################

   .. oe:method:: GetMCSExhaustiveMode

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMCSExhaustiveMode() const

      .. oe:language:: python

         .. oe:api:: python

            GetMCSExhaustiveMode() -> bool

      Returns whether the exhaustive MCS mapping mode should being used
      when the automapping is using the MCS method.

   .. ################################################################
      # GetStrictMapping
      ################################################################

   .. oe:method:: GetStrictMapping

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStrictMapping() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrictMapping() -> bool

      Returns the requested activation state for strict reaction mapping validation activities.

   .. ################################################################
      # SetClearMapping
      ################################################################

   .. oe:method:: SetClearMapping

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetClearMapping(bool flag)

      .. oe:language:: python

         .. oe:api:: python

            SetClearMapping(value: bool) -> bool

      Sets whether existing atom-atom mappings should be cleared prior
      to attempting the reaction mapping activity.  Existing atom-atom mappings
      may be used to guide the reaction mapping activity if not cleared.

      .. seealso::

         * :oe:meth:`OEChem::OERxnAutomapperOptions::GetClearMapping` method

   .. ################################################################
      # SetExtendMappedRegions
      ################################################################

   .. oe:method:: SetExtendMappedRegions

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetExtendMappedRegions(bool flag)

      .. oe:language:: python

         .. oe:api:: python

            SetExtendMappedRegions(value: bool) -> bool

      Sets whether unassigned mapped regions can be augmented with unambiguous
      reactant and product atom correspondences to maximize the size of the reaction mapping.

   .. ################################################################
      # SetMappingMethod
      ################################################################

   .. oe:method:: SetMappingMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMappingMethod(unsigned method)

      .. oe:language:: python

         .. oe:api:: python

            SetMappingMethod(value: int) -> bool

      Sets the requested mapping method to use for the reaction mapping correspondence.
      This is simply a placeholder for future methods, currently only an MCS mapping approach
      is available.

   .. ################################################################
      # SetMCSExhaustiveMode
      ################################################################

   .. oe:method:: SetMCSExhaustiveMode

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMCSExhaustiveMode(bool flag)

      .. oe:language:: python

         .. oe:api:: python

            SetMCSExhaustiveMode(value: bool) -> bool

      Sets whether the slower exhaustive MCS mapping mode should be used
      when the automapping is using the MCS method.

   .. ################################################################
      # SetStrictMapping
      ################################################################

   .. oe:method:: SetStrictMapping

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStrictMapping(bool flag)

      .. oe:language:: python

         .. oe:api:: python

            SetStrictMapping(value: bool) -> bool

      Enables or disables strict reaction mapping validation activities.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OESDDataPair, SDDataPair

.. _OEChem_OESDDataPair:

.. oe:class:: OESDDataPair

   .. oe:api::

      class OESDDataPair

   This class represents `OESDDataPair`.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESDDataPair()
            OESDDataPair(std::string t, std::string v)

      .. oe:language:: python

         .. oe:api:: python

            OESDDataPair() -> OESDDataPair
            OESDDataPair(t: str, v: str) -> OESDDataPair

      Default and copy constructors.

   .. oe:method:: GetTag

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetTag() const

      .. oe:language:: python

         .. oe:api:: python

            GetTag() -> str

   .. oe:method:: GetValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetValue() const

      .. oe:language:: python

         .. oe:api:: python

            GetValue() -> str

   .. oe:method:: SetTag

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTag(const char* t)

      .. oe:language:: python

         .. oe:api:: python

            SetTag(t: str) -> None

   .. oe:method:: SetValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetValue(const char* v)

      .. oe:language:: python

         .. oe:api:: python

            SetValue(v: str) -> None



.. oe:namespace:: OEChem

.. meta::
   :keywords: OESimilarByRMSD, SimilarByRMSD

.. _OEChem_OESimilarByRMSD:

.. oe:class:: OESimilarByRMSD

   .. oe:api::

      class OESimilarByRMSD : public OESystem::OEBinaryPredicate<OEChem::OEConfBase, OEChem::OEConfBase>

   This class represents `SimilarByRMSD`, a functor that identifies if two conformers (:ref:`OEConfBase <OEChem_OEConfBase>`)
   are similar.

   The following methods are publicly inherited from :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEBinaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEBinaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEBinaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEBinaryFunction <OESystem_OEBinaryFunction>`:

   ============================================================== ==============================================================
   :oe:meth:`operator()<OESystem::OEBinaryFunction::operator()>`  :oe:meth:`CreateCopy<OESystem::OEBinaryFunction::CreateCopy>`
   ============================================================== ==============================================================
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESimilarByRMSD(const OESimilarByRMSD&)
            OESimilarByRMSD(const double rmsd)

      .. oe:language:: python

         .. oe:api:: python

            OESimilarByRMSD(argRmsd: float) -> OESimilarByRMSD
            OESimilarByRMSD(argPredicate: OESimilarByRMSD) -> OESimilarByRMSD

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESimilarByRMSD &operator=(const OESimilarByRMSD&)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEChem::OEConfBase& conf1, const OEChem::OEConfBase& conf2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(argConf1: OEConfBase, argConf2: OEConfBase) -> bool

      Returns ``true``, if the two specified conformers are similar within the specified RMSD, i.e.,
      if the RMSD between the two conformers is smaller or equal to the specified value.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEChem::OEConfBase, OEChem::OEConfBase, bool> * CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESimilarByRMSD

      Deep copy constructor that returns a copy of the object.
      The memory for the returned `OESimilarByRMSD` 
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OESimpleAppOptions, SimpleAppOptions

.. _OEChem_OESimpleAppOptions:

.. oe:class:: OESimpleAppOptions

   .. oe:api::

      class OESimpleAppOptions : public OESystem::OEOptions

   The :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` represents a simple options class,
   representing a simple applications interface with an input reader file and
   an output writer file.

   .. seealso::

      * :ref:`OEOptions <OESystem_OEOptions>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_simple_omega` example
      * :ref:`section_examples_dens_omega` example
      * :ref:`section_examples_stereo_and_torsion` example
      * :ref:`section_examples_torsion` example
      * :ref:`section_examples_fraglib` example
      * :ref:`section_examples_macrocycles` example

   The :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class defines the following public methods:
    * :oe:meth:`GetInFile<OEChem::OESimpleAppOptions::GetInFile>` and
      :oe:meth:`SetInFile<OEChem::OESimpleAppOptions::SetInFile>`
    * :oe:meth:`GetOutFile<OEChem::OESimpleAppOptions::GetOutFile>` and
      :oe:meth:`SetOutFile<OEChem::OESimpleAppOptions::SetOutFile>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESimpleAppOptions(const std::string& name,
                               const unsigned inFileType,
                               const unsigned outFileType)
            OESimpleAppOptions(const std::string& name,
                               const std::string& inFileExt,
                               const unsigned outFileType)
            OESimpleAppOptions(const std::string& name,
                               const unsigned inFileType,
                               const std::string& outFileExt)
            OESimpleAppOptions(const std::string& name,
                               const std::string& inFileExt,
                               const std::string& outFileExt)
            OESimpleAppOptions(const OESystem::OEOptions& opts,
                               const std::string& name,
                               const unsigned inFileType,
                               const unsigned outFileType)
            OESimpleAppOptions(const OESystem::OEOptions& opts,
                               const std::string& name,
                               const std::string& inFileExt,
                               const unsigned outFileType)
            OESimpleAppOptions(const OESystem::OEOptions& opts,
                               const std::string& name,
                               const unsigned inFileType,
                               const std::string& outFileExt)
            OESimpleAppOptions(const OESystem::OEOptions& opts,
                               const std::string& name,
                               const std::string& inFileExt,
                               const std::string& outFileExt)
            OESimpleAppOptions(const OESystem::OEOptions& opts,
                               const std::string& name,
                               const unsigned inFileType)
            OESimpleAppOptions(const OESystem::OEOptions& opts,
                               const std::string& name,
                               const std::string& inFileExt)
            OESimpleAppOptions(const OESimpleAppOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESimpleAppOptions(opts: OEOptions, name: str, inFileType: int,
                               outFileType: int) -> OESimpleAppOptions
            OESimpleAppOptions(opts: OEOptions, name: str, inFileExt: str,
                               outFileType: int) -> OESimpleAppOptions
            OESimpleAppOptions(opts: OEOptions, name: str, inFileType: int,
                               outFileExt: str) -> OESimpleAppOptions
            OESimpleAppOptions(opts: OEOptions, name: str, inFileExt: str,
                               outFileExt: str) -> OESimpleAppOptions
            OESimpleAppOptions(name: str, inFileType: int, outFileType: int) -> OESimpleAppOptions
            OESimpleAppOptions(name: str, inFileExt: str, outFileType: int) -> OESimpleAppOptions
            OESimpleAppOptions(name: str, inFileType: int, outFileExt: str) -> OESimpleAppOptions
            OESimpleAppOptions(name: str, inFileExt: str, outFileExt: str) -> OESimpleAppOptions
            OESimpleAppOptions(opts: OEOptions, name: str, inFileType: int) -> OESimpleAppOptions
            OESimpleAppOptions(opts: OEOptions, name: str, inFileExt: str) -> OESimpleAppOptions
            OESimpleAppOptions(arg2: OESimpleAppOptions) -> OESimpleAppOptions

      Default and copy constructors.

      The ``opts`` represents the sub-options that should be wrapped to extend this options to generate
      the API for the intended application, where applicable, and the ``name`` represents the name of the application.
      The ``inFileType`` and ``outFileType`` refers to the input and output file types. The file types
      can be specified using constants as defined in the :oe:constns:`OEChem::OEFileStringType` namespace,
      or using a string value. Variation of constructors that does not require an output file can
      be used when an output is not desired in an application.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESimpleAppOptions &operator=(const OESimpleAppOptions &)

      Assignment operator.
   
   .. oe:method:: GetInFile

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetInFile() const

      .. oe:language:: python

         .. oe:api:: python

            GetInFile() -> str

      See :oe:meth:`SetInFile<OEChem::OESimpleAppOptions::SetInFile>` method.

   .. oe:method:: GetOutFile

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetOutFile() const

      .. oe:language:: python

         .. oe:api:: python

            GetOutFile() -> str

      See :oe:meth:`SetOutFile<OEChem::OESimpleAppOptions::SetOutFile>` method.

   .. oe:method:: SetInFile

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetInFile(const std::string value)

      .. oe:language:: python

         .. oe:api:: python

            SetInFile(value: str) -> bool

      Sets name of the input file for the application. **Default: None**

   .. oe:method:: SetOutFile

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOutFile(const std::string value)

      .. oe:language:: python

         .. oe:api:: python

            SetOutFile(value: str) -> bool

      Sets name of the output file for the application. **Default: None**


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESubSearch, SubSearch

.. _OEChem_OESubSearch:

.. oe:class:: OESubSearch

   .. oe:api::

      class OESubSearch

   This class represents `OESubSearch`.

   The :ref:`OESubSearch <OEChem_OESubSearch>` class performs substructure searches,
   also known as subgraph isomorphism determination, on molecular graphs.
   In a molecular graph, atoms are considered nodes and bonds are edges.
   The :ref:`OESubSearch <OEChem_OESubSearch>` class is capable of performing both
   colored and uncolored graph comparison.  The 'color' properties of a
   query graph are stored as expression trees associated with atoms and
   bonds of a query molecule.

   .. seealso::

      * :ref:`section_patternmatch_sss` section
      * :ref:`chapter_mdlqueries` chapter

   .. admonition:: Code Example

      * :ref:`section_example_oechem_molgrep` example

   .. hint::

      It is a good practice to call the :oe:func:`OEChem::OEPrepareSearch`
      function before calling any of the following methods:

      * :oe:meth:`OEChem::OESubSearch::AtomMatch`
      * :oe:meth:`OEChem::OESubSearch::Match`
      * :oe:meth:`OEChem::OESubSearch::SingleMatch`

      If there is any atom or bond property that is not perceived but it
      is necessary to successfully execute the substructure search,
      then the above methods throw a warning.
      These warnings can be suppressed by calling the
      :oe:func:`OEChem::OEPrepareSearch` function.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESubSearch()

      .. oe:language:: python

         .. oe:api:: python

            OESubSearch() -> OESubSearch

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESubSearch(const OESubSearch& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESubSearch(arg2: OESubSearch) -> OESubSearch

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESubSearch(const OEQMolBase& qmol)

      .. oe:language:: python

         .. oe:api:: python

            OESubSearch(arg2: OEQMol) -> OESubSearch

      Constructs an :ref:`OESubSearch <OEChem_OESubSearch>` object using
      a query molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`). Query molecules must
      have atom and bond expressions (see
      :oe:meth:`OEChem::OEQMolBase::BuildExpressions`) built for the entire
      molecule before being passed to this constructor.  Failure to do so
      will result in the :ref:`OESubSearch <OEChem_OESubSearch>` object being
      constructed as uninitialized.

      .. note::

        The :ref:`OESubSearch <OEChem_OESubSearch>` object will store its own copy of the
        given query molecule, and the :oe:meth:`OEChem::OESubSearch::Match`
        method will return matches between copied query and the target.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESubSearch(const OEMolBase& mol, unsigned int aexpr,
                        unsigned int bexpr)

      .. oe:language:: python

         .. oe:api:: python

            OESubSearch(mol: Union[OEGraphMol,OEMol,OEQMol], aexpr: int,
                        bexpr: int) -> OESubSearch

      Constructs an :ref:`OESubSearch <OEChem_OESubSearch>` object using
      a molecule and expression options.  The atom and bond expression
      options passed as the second and third arguments to the method are
      defined in the :oe:constns:`OEChem::OEExprOpts` namespace.  The
      expression options are used to convert the atom and bond data into
      expression trees which are used during the subgraph search.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESubSearch(const char* smarts, bool allowReorderAtoms = true)

      .. oe:language:: python

         .. oe:api:: python

            OESubSearch(smarts: str, allowReorderAtoms: bool = False) -> OESubSearch

      Constructs an :ref:`OESubSearch <OEChem_OESubSearch>` object using
      a :term:`SMARTS` pattern that is passed as the first argument to the
      constructor.
      The second argument of the method determines the traversal order used
      in subgraph isomorphism detection. This argument is currently not
      used, therefore the traversal order always reflects the atom and bond
      ordering of the passed :term:`SMARTS` pattern.

      ..  The Boolean reorder flag determines the match order of the query atoms
          and bonds.  If reorder is set to ``true`` then the atoms and bonds will be
          matched in an arbitrary order.  If ``false``, atoms and bonds will be
          matched in the order that they appear in the query molecule.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESubSearch &operator=(const OESubSearch &rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OESubSearch <OEChem_OESubSearch>` object
      into the right-hand side :ref:`OESubSearch <OEChem_OESubSearch>` object.

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Tests whether initialization of an :ref:`OESubSearch <OEChem_OESubSearch>` object
      is successful .  If initialization was attempted with an invalid
      :term:`SMARTS` pattern or query molecule then this method will return ``false``.
      If initialization was completed successfully this method will return
      ``true``.  An :ref:`OESubSearch <OEChem_OESubSearch>` object is considered to be
      uninitialized when constructed with the default constructor.

   .. oe:method:: AddConstraint

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddConstraint(const OEMatchPair<OEAtomBase> &)
            bool AddConstraint(const OEMatchPair<OEBondBase> &)

      .. oe:language:: python

         .. oe:api:: python

            AddConstraint(arg2: OEMatchPairAtom) -> bool
            AddConstraint(arg2: OEMatchPairBond) -> bool

      The search space of a subgraph isomorphism determination can be
      restricted by constraining pairs of nodes or edges (atoms or bonds) to
      be mapped onto one another in all valid subgraph solutions.  Failure
      to satisfy atom or bond pairwise constraints will prevent any subgraph
      solutions from being identified by any of the match methods in
      :ref:`OESubSearch <OEChem_OESubSearch>`.  Both
      :oe:meth:`OEChem::OESubSearch::AddConstraint` methods return ``true`` if a
      constraint is added successfully.  If the pattern atom or bond in the
      :ref:`OEMatchPair <OEChem_OEMatchPair>` does not exist as part of the query
      molecule created in the initialization of the
      :ref:`OESubSearch <OEChem_OESubSearch>` object then
      :oe:meth:`OEChem::OESubSearch::AddConstraint` will return ``false``.
      Multiple calls :oe:meth:`OEChem::OESubSearch::AddConstraint` using the same
      pattern atom or bond will cause previously stored constraints to be
      overwritten as constraints are mutually exclusive.  It is impossible to
      satisfy multiple simultaneous constraints for a single pattern atom or bond,
      hence the exclusivity.

   .. oe:method:: AtomMatch

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AtomMatch(const OEAtomBase *) const

      .. oe:language:: python

         .. oe:api:: python

            AtomMatch(arg2: OEAtomBase) -> bool

      Searches for a single valid subgraph isomorphism starting with the
      passed target atom mapped to the first pattern atom with which the
      :ref:`OESubSearch <OEChem_OESubSearch>` was initialized. If a valid subgraph is
      identified the method will return ``true``. This method is the effective
      combination of sequential calls to
      :oe:meth:`OEChem::OESubSearch::AddConstraint` followed by
      :oe:meth:`OEChem::OESubSearch::SingleMatch`.

      .. oe:api: IGNORED - NOT IMPLEMENTED YET

         bool AtomMatch(const OEQAtomBase *) const

   .. oe:method:: ClearConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearConstraints()

      .. oe:language:: python

         .. oe:api:: python

            ClearConstraints() -> None

      Eliminates all prior match constraints set with the
      :oe:meth:`OEChem::OESubSearch::AddConstraint` method.

   .. oe:method:: GetMaxMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxMatches() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMatches() -> int

      Returns the maximum number of subgraph isomorphism solutions that the
      :ref:`OESubSearch <OEChem_OESubSearch>` object will identify before
      terminating the search.  A value of zero indicates that no arbitrary
      limit has been set on the total number of subgraph isomorphism
      solutions to be identified.
      By default, the maximum number of matches is set to ``1024``.

      .. seealso::

         * :oe:meth:`OEChem::OESubSearch::SetMaxMatches`

   .. oe:method:: GetPattern

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEQMolBase& GetPattern() const

      .. oe:language:: python

         .. oe:api:: python

            GetPattern() -> OEQMol

      Returns the read-only reference to the query molecule contained in an
      :ref:`OESubSearch <OEChem_OESubSearch>` object.
      Const :ref:`OEQMolBase <OEChem_OEQMolBase>` methods can be used to interrogate
      the returned :ref:`OEQMolBase <OEChem_OEQMolBase>` reference.  If the
      :ref:`OESubSearch <OEChem_OESubSearch>` object has not been initialized, a reference
      to an empty molecule will be returned.

   .. oe:method:: Init

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const OEQMolBase &)

      .. oe:language:: python

         .. oe:api:: python

            Init(arg2: OEQMol) -> bool

      (Re)initializes an :ref:`OESubSearch <OEChem_OESubSearch>` object with a query
      molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`) reference. The method will
      return ``true`` if initialization completes successfully, and ``false`` upon
      failure.  Prior state information is cleared before initialization,
      and is lost even if the method fails to initialize properly.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const char* smarts, bool allowReorderAtoms = false)

      .. oe:language:: python

         .. oe:api:: python

            Init(smarts: str, allowReorderAtoms: bool = False) -> bool

      (Re)initializes an :ref:`OESubSearch <OEChem_OESubSearch>` object
      with a :term:`SMARTS` pattern, which is parsed to create a query molecule
      available for substructure search.  The method will return ``true`` if
      initialization completes successfully, and ``false`` upon failure.  Prior
      state information is cleared before initialization, and is lost even
      if the method fails to initialize properly.  The second argument of
      the method determines the traversal order used in subgraph isomorphism
      detection. This argument is currently not used, therefore the
      traversal order always reflects the atom and bond ordering of the
      passed :term:`SMARTS` pattern.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const OEMolBase& mol, unsigned int atomexpr,
                      unsigned int bondexpr)

      .. oe:language:: python

         .. oe:api:: python

            Init(mol: Union[OEGraphMol,OEMol,OEQMol], aexpr: int, bexpr: int) -> bool

      (Re)initializes an :ref:`OESubSearch <OEChem_OESubSearch>` object using a
      molecule and expression options that are used to convert the given
      molecule into a :ref:`OEQMolBase <OEChem_OEQMolBase>` query object.

      *mol*
        The *query* molecule of the maximum common substructure search.

      *atomexpr*
        This value has to be any combination of atom expressions of the
        :oe:constns:`OEChem::OEExprOpts` namespace.

      *bondexpr*
        This value has to be any combination of bond expressions of the
        :oe:constns:`OEChem::OEExprOpts` namespace.

      Expression options are used to convert the atom and bond data into
      expression trees which are  used during the substructure search
      to map atoms and bonds.
      The method will return ``true`` if initialization completes successfully,
      and ``false`` upon failure.

      .. note::

         Prior state information is cleared before initialization, and
         is lost even if the method fails to initialize properly.

      .. seealso::

         * :oe:constns:`OEChem::OEExprOpts` namespace

   .. oe:method:: Match

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMatchBase>* Match(const OEMolBase& mol,
                                                     bool uniquematch = false) const

      .. oe:language:: python

         .. oe:api:: python

            Match(arg2: Union[OEGraphMol,OEMol], uniquematch: bool = False) -> Iterable[OEMatchBase]

      Performs search in order to identify subgraphs of :ref:`OEMolBase <OEChem_OEMolBase>`
      which are isomorphic to the graph with which an
      :ref:`OESubSearch <OEChem_OESubSearch>` object was initialized.
      It returns an iterator pointer (:ref:`OEIterBase <OESystem_OEIterBase>`)
      over graph matches (:ref:`OEMatchBase <OEChem_OEMatchBase>`), and should be
      assigned to an :ref:`OEIter <OESystem_OEIter>` < :ref:`OEMatchBase <OEChem_OEMatchBase>` >
      in order to prevent memory leaks.

      *mol*
         The target molecule in which the substructure is identified.

      *uniquematch*
         By default all possible subgraphs up to and including
         the maximum number of matches are returned by these methods.
         If this parameters is ``true`` then only the unique
         matches will be included in the iterator over the matches.  A match or
         subgraph is considered unique if it differs from all other subgraphs
         found previously by at least one atom.  Two subgraph matches
         which cover the same atoms, albeit in different orders, will
         be called duplicates and the subgraph found later in the search will
         be discarded.

      .. oe:api: IGNORED - NOT IMPLEMENTED YET

         OESystem::OEIterBase<OEMatchBase> *Match(const OEQMolBase &,
                                                  bool uniquematch=false) const

   .. oe:method:: SetMaxMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxMatches(unsigned int m)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxMatches(m: int) -> bool

      Sets the maximum number of subgraphs to be determined by the
      :oe:meth:`OEChem::OESubSearch::Match` method.  Once the maximum number of
      subgraphs have been found the search for additional subgraphs is
      terminated.  By default, maximum number of matches is set to ``1024``. The
      constraint on the maximum number of matches can be removed by calling
      this method with a value of zero.

      .. seealso::

         * :oe:meth:`OEChem::OESubSearch::GetMaxMatches`

   .. oe:method:: SingleMatch

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SingleMatch(const OEMolBase &) const

      .. oe:language:: python

         .. oe:api:: python

            SingleMatch(arg2: Union[OEGraphMol,OEMol]) -> bool

      Returns ``true``, if a single subgraph isomorphism is detected in the
      molecule passed as the function argument. If no subgraph isomorphism
      is detected the method will return ``false``.

      .. oe:api: IGNORED - NOT IMPLEMENTED YET

         bool SingleMatch(const OEQMolBase &) const

   .. seealso::

      .. oe:language:: c++

         * Example program :ref:`molgrep.cpp<section_example_oechem_molgrep>`

      .. oe:language:: python

         * Example program :ref:`molgrep.py<section_example_oechem_molgrep>`

      .. oe:language:: java

         * Example program :ref:`MolGrep.java<section_example_oechem_molgrep>`

      .. oe:language:: csharp

         * Example program :ref:`MolGrep.cs<section_example_oechem_molgrep>`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. _OEChem_OESubSearchDatabase:

.. oe:class:: OESubSearchDatabase

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESubSearchDatabase

   The :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` class is designed to perform
   fast multi-threaded substructure search.
   Each :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` is associated with one
   screen type (:ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>`) that is
   set when the database is initialized from a pre-generated binary
   substructure search file.

   .. figure:: oechemtk/images/FastSSSearch.*
      :width: 350 pt
      :align: center

      **Schematic representation of using substructure search database**

   The :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` class provides the following search methods:

   .. list-table::
      :widths: 100 100 200
      :header-rows: 1

      * - Method
        - Returns
        - Type

      * - :oe:meth:`NumMatches<OEChem::OESubSearchDatabase::NumMatches>`
        - number of matched molecules
        - full search

      * - :oe:meth:`GetMatchIndices<OEChem::OESubSearchDatabase::GetMatchIndices>`
        - indices of matched molecules
        - limited search

      * - :oe:meth:`GetMatchTitles<OEChem::OESubSearchDatabase::GetMatchTitles>`
        - titles of matched molecules
        - limited search

      * - :oe:meth:`Search<OEChem::OESubSearchDatabase::Search>`
        - :oe:cls:`OESubSearchResult<OEChem::OESubSearchResult>` (indices of molecules, progress of search)
        - full/limited search (cancelable)

   .. seealso::

      * :oe:func:`OEChem::OECreateSubSearchDatabaseFile` function to generate
        database files for :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>`.

   .. admonition:: Code Example

      * :ref:`section_example_oechem_makefastss` example
      * :ref:`section_example_oechem_searchfastss` example

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESubSearchDatabase(const std::string& dbfile,
                                const unsigned memtype = OESubSearchDatabaseType::Default,
                                const unsigned numprocesssors = 0u)
            OESubSearchDatabase(const unsigned memtype = OESubSearchDatabaseType::Default,
                                const unsigned numprocesssors = 0u)

      .. oe:language:: python

         .. oe:api:: python

            OESubSearchDatabase(memtype: int, numprocesssors: int = 0) -> OESubSearchDatabase
            OESubSearchDatabase(dbfile: str, memtype: int,
                                numprocesssors: int = 0) -> OESubSearchDatabase

      Constructs an :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` object.

      dbfile
        The name of the file that contains the substructure search data
        (molecules with pre-generated screens).
        The file has to be generated with the
        :oe:func:`OEChem::OECreateSubSearchDatabaseFile` function.
        If no file name is defined, the database has to be initialized
        by calling the :oe:meth:`OEChem::OESubSearchDatabase::Open` method.

      memtype
        Defines the type of the substructure database.
        This value has to be from the
        :oe:constns:`OEChem::OESubSearchDatabaseType` namespace.

      numprocesssors
        The maximum number of threads that can be used to search the database.
        When set to ``0``, the number of processors used will be the number
        returned by the :oe:func:`OEPlatform::OEGetNumProcessors` function.
        If ``numprocesssors == 1``, all searches are executed using
        the main thread only.

   .. oe:method:: GetDatabaseType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetDatabaseType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDatabaseType() -> int

      Returns the type of the substructure search database.
      The return value is taken from the :oe:constns:`OEChem::OESubSearchDatabaseType`
      namespace.

   .. oe:method:: GetMatchIndices

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<size_t>* GetMatchIndices(const OESubSearchQuery &) const

      .. oe:language:: python

         .. oe:api:: python

            GetMatchIndices(arg2: OESubSearchQuery) -> Iterable[int]

      Returns the indices of molecules matched to the given query
      (:ref:`OESubSearchQuery <OEChem_OESubSearchQuery>`).
      The search terminates if the limit set for the query is reached
      (:oe:cls:`GetMaxMatches<OEChem::OESubSearchQuery::GetMaxMatches>`).
      The matched molecules  can be retried from the database by using the
      :oe:meth:`OEChem::OESubSearchDatabase::GetMolecule` method.

   .. oe:method:: GetMatchTitles

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<std::string>* GetMatchTitles(const OESubSearchQuery &) const

      .. oe:language:: python

         .. oe:api:: python

            GetMatchTitles(arg2: OESubSearchQuery) -> OEStringIter

      Returns the titles of the molecules matched to the given query
      (:ref:`OESubSearchQuery <OEChem_OESubSearchQuery>`).
      The search terminates if the limit set for the query is reached
      (:oe:cls:`GetMaxMatches<OEChem::OESubSearchQuery::GetMaxMatches>`).

   .. oe:method:: GetMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMolecule(OEMolBase& mol, const size_t index) const

      .. oe:language:: python

         .. oe:api:: python

            GetMolecule(mol: Union[OEGraphMol,OEMol,OEQMol], arg3: int) -> bool

      Retrieves the molecule stored in the database with the specified index.

      .. seealso::

         * :oe:meth:`OEChem::OESubSearchDatabase::GetTitle` method

   .. oe:method:: GetScreenType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESubSearchScreenTypeBase* GetScreenType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScreenType() -> OESubSearchScreenTypeBase

      Returns the screen type of the
      :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` object.
      An :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` object can only store
      screens with identical types.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetTitle(const size_t index) const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle(arg2: int) -> str

      Retrieves the title of the molecule stored in the database with the specified index.

      .. seealso::

         * :oe:meth:`OEChem::OESubSearchDatabase::GetMolecule` method

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` object is valid.

   .. oe:method:: NumMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t NumMatches(const OEQMolBase& query) const

      .. oe:language:: python

         .. oe:api:: python

            NumMatches(query: OEQMol) -> int

      Returns the number of molecules matched to the given query
      (:ref:`OESubSearchQuery <OEChem_OESubSearchQuery>`) in the entire database.

   .. oe:method:: NumMolecules

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t NumMolecules() const

      .. oe:language:: python

         .. oe:api:: python

            NumMolecules() -> int

      Returns the number of molecules stored in the :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>`
      object.

   .. oe:method:: NumProcessors

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned NumProcessors() const

      .. oe:language:: python

         .. oe:api:: python

            NumProcessors() -> int

      Returns the maximum number of threads that can be used to search the database.
      This is determined when the database is initialized.

   .. oe:method:: Open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Open(oemolistream& ifs,
                      OESystem::OETracerBase& tracer = OESystem::OENoTracer)
            bool Open(const std::string & filename,
                      OESystem::OETracerBase& tracer = OESystem::OENoTracer)

      .. oe:language:: python

         .. oe:api:: python

            Open(ifs: oemolistream, tracer: OETracerBase = OENoTracer) -> bool
            Open(arg2: str, tracer: OETracerBase = OENoTracer) -> bool

      Initializes the substructure search database. These methods return
      ``true`` if the database was successfully initialized.

      ifs
        The molecule stream from which the substructure search database is
        initialized.

      filename
        The name of the file from which the substructure search database is
        initialized.

      tracer
        The tracer that can be used to report the progress of the database load.

      .. seealso::

         * :ref:`OEConsoleProgressTracer <OESystem_OEConsoleProgressTracer>` class

   .. oe:method:: Search

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Search(OESubSearchResult& result,
                            const OESubSearchQuery& query) const

      .. oe:language:: python

         .. oe:api:: python

            Search(arg2: OESubSearchResult, arg3: OESubSearchQuery) -> int

      This search method is designed for interactive searches.

      result
        The :ref:`OESubSearchResult <OEChem_OESubSearchResult>` object that stores the result of the
        search along with the progress of the search.
        The :ref:`OESubSearchResult <OEChem_OESubSearchResult>` is updated regularly during the search
        as more and more matches identified. It also provides a mechanism to cancel
        a long running search via :oe:meth:`OEChem::OESubSearchResult::Cancel`.

      query
        The :ref:`OESubSearchQuery <OEChem_OESubSearchQuery>` object that stores the query molecule
        with search parameters.

      The :oe:meth:`OEChem::OESubSearchDatabase::Search` method returns:

      * :oe:const:`OEChem::OESubSearchStatus::Uninitialized` if the search can not be executed
      * :oe:const:`OEChem::OESubSearchStatus::Finished`, if the search successfully finished
      * :oe:const:`OEChem::OESubSearchStatus::Canceled`, if the search was interrupted

      .. seealso::

         * :oe:constns:`OEChem::OESubSearchStatus` namespace


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. _OEChem_OESubSearchQuery:

.. oe:class:: OESubSearchQuery

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESubSearchQuery

   The :ref:`OESubSearchQuery <OEChem_OESubSearchQuery>` class is used to submit queries
   to be searched in a database (:oe:meth:`OEChem::OESubSearchDatabase`).

   .. seealso::

      * :oe:meth:`OEChem::OESubSearchDatabase::Search` method
      * :oe:meth:`OEChem::OESubSearchDatabase::GetMatchIndices` method
      * :oe:meth:`OEChem::OESubSearchDatabase::GetMatchTitles` method

   .. admonition:: Code Example

      * :ref:`section_example_oechem_searchfastss` example

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESubSearchQuery(const OEQMolBase& query,
                             const size_t maxmatches = 1000u)

      .. oe:language:: python

         .. oe:api:: python

            OESubSearchQuery(arg2: OEQMol, maxmatches: int = 1000) -> OESubSearchQuery
            OESubSearchQuery(arg2: OESubSearchQueryImpl) -> OESubSearchQuery

      Creates an :ref:`OESubSearchQuery <OEChem_OESubSearchQuery>` object.

      query
        The query molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`).

      maxmatches
        The maximum number of matches that will be kept.

   .. oe:method:: SetFilter

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFilter(const OESystem::OEUnaryPredicate<OEMolBase>&)

      .. oe:language:: python

         .. oe:api:: python

            SetFilter(arg2: OEUnaryMolBasePred) -> None

      Sets a molecule predicate that can be used to filter out molecules
      based on molecular properties other than the existence of a certain
      substructure.

      .. oe:language:: c++ python

         The following code snippet shows how to use the
         :oe:meth:`OEChem::OESubSearchQuery::SetFilter` method to identify
         molecules that are matching the given :term:`SMARTS` pattern and
         also have molecule weight in the given range:

         .. oe:source:: FilteredSubSearch.cpp
            :language: c++
            :noindent:
            :frag:     SNIPPET

         .. oe:source:: FilteredSubSearch.py
            :language: python
            :noindent:
            :frag:     SNIPPET

         The output of the code snippet above might look like this:

         .. code-block:: console

            Number of total matches = 20
            Number of total matches (filtered) = 7
            weight= 204.225 c1ccc2c(c1)c(c[nH]2)C[C@H](C(=O)O)N
            weight= 218.252 CN[C@@H](Cc1c[nH]c2c1cccc2)C(=O)O
            weight= 245.277 CC(=O)N[C@@H](Cc1c[nH]c2c1cccc2)C(=O)N
            weight= 275.303 c1ccc2c(c1)c(c[nH]2)C[C@@H](C(=O)O)NC(=O)CCN
            weight= 260.288 CC(=O)N[C@@H](Cc1c[nH]c2c1cccc2)C(=O)OC
            weight= 274.315 CCOC(=O)[C@H](Cc1c[nH]c2c1cccc2)NC(=O)C
            weight= 254.327 CN1CC(C=C2[C@H]1Cc3c[nH]c4c3c2ccc4)CO

         where ``MoleculeWeightPredicate`` is a molecule predicate that is defined as:

         .. oe:source:: FilteredSubSearch.cpp
            :language: c++
            :noindent:
            :frag:     SNIPPET-PREDICATE

         .. oe:source:: FilteredSubSearch.py
            :language: python
            :noindent:
            :frag:     SNIPPET-PREDICATE

      .. note::

         During the search, the predicate set by the
         :oe:meth:`OEChem::OESubSearchQuery::SetFilter` method is utilized after
         the screening phase and before the atom-by-atom validation of the
         substructure search match. Note that to minimize the memory footprints, the
         :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` only stores the molecular graphs
         (no coordinates) and the titles of the molecules.

      .. seealso::

         * :ref:`chapter_predicates` chapter

   .. oe:method:: GetMaxMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t GetMaxMatches() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMatches() -> int

      Returns the maximum match limit when searching :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>`.
      The :oe:meth:`OEChem::OESubSearchDatabase::GetMatchIndices` and
      :oe:meth:`OEChem::OESubSearchDatabase::GetMatchTitles` methods will terminate
      when this limit is reached.
      The default is ``1000``.

   .. oe:method:: SetMaxMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxMatches(const size_t limit)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxMatches(arg2: int) -> None

      Sets the maximum match limit.

      .. note::

         While there is no upper limit on how many matches can be retrieve by the search,
         it is not recommended to set this limit very high (>10K).
         Searching a very large database with a very generic query can result in
         internally storing millions of indices or titles.
         The total number of matches can be determined (without storing all matches) either
         using the :oe:meth:`OEChem::OESubSearchDatabase::NumMatches` method or
         via the :oe:meth:`OEChem::OESubSearchResult::NumTotalMatches` counter when using
         the :oe:meth:`OEChem::OESubSearchDatabase::Search` method.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. _OEChem_OESubSearchResult:

.. oe:class:: OESubSearchResult

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESubSearchResult

   The :ref:`OESubSearchResult <OEChem_OESubSearchResult>` class is used to store the results
   of a substructure search along with reporting the progress of the search
   (:oe:meth:`OEChem::OESubSearchDatabase::Search`).
   The :ref:`OESubSearchResult <OEChem_OESubSearchResult>` class provides progress with updating the
   following counters:

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Counter
        - Description

      * - :oe:meth:`NumTargets<OEChem::OESubSearchResult::NumTargets>`
        - number of molecules in the database

      * - :oe:meth:`NumScreened<OEChem::OESubSearchResult::NumScreened>`
        - number of molecules eliminated by their screen

      * - :oe:meth:`NumSearched<OEChem::OESubSearchResult::NumSearched>`
        - number of molecules searched

      * - :oe:meth:`NumTotalMatches<OEChem::OESubSearchResult::NumTotalMatches>`
        - total number of matches identified

      * - :oe:meth:`NumMatches<OEChem::OESubSearchResult::NumMatches>`
        - total number of matches kept

   If the search is not canceled at the end of the search:

   .. math::

       number\ of\ targets = number\ of\ screened + number\ of\ searched

   The success of the screen (in percentages) is defined as:

   .. math::

      \frac{number\ of\ screened + number\ of\ total\ matches}{number\ of\ targets} * 100.0

   Where ``100.0%`` means that no false positive was detected i.e. each molecule that passed
   the screening phase was a real match.

   .. seealso::

      * :oe:meth:`OEChem::OESubSearchDatabase::Search` method

   .. admonition:: Code Example

      * :ref:`section_example_oechem_searchfastss` example

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESubSearchResult()

      .. oe:language:: python

         .. oe:api:: python

            OESubSearchResult() -> OESubSearchResult

      Default constructor that creates an empty result object.

   .. oe:method:: Cancel

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Cancel()

      .. oe:language:: python

         .. oe:api:: python

            Cancel() -> None

      Cancels the ongoing substructure search. The search might not be immediately
      terminated, but no new molecules will be submitted for substructure search.
      The status of the search will be
      :oe:const:`OEChem::OESubSearchStatus::Canceled`.

   .. oe:method:: GetMatchIndices

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<size_t>* GetMatchIndices() const

      .. oe:language:: python

         .. oe:api:: python

            GetMatchIndices() -> Iterable[int]

      Returns the indices of the matched molecules. The matched molecules
      can be retried from the database by using the
      :oe:meth:`OEChem::OESubSearchDatabase::GetMolecule` method.

   .. oe:method:: GetSearchStatus

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetSearchStatus() const

      .. oe:language:: python

         .. oe:api:: python

            GetSearchStatus() -> int

      Returns the status of the substructure search defined in
      the :oe:constns:`OEChem::OESubSearchStatus` namespace.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OESubSearchResult <OEChem_OESubSearchResult>` object is valid.

   .. oe:method:: NumMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t NumMatches() const

      .. oe:language:: python

         .. oe:api:: python

            NumMatches() -> int

      Returns the number of kept matches which can be retrieved via
      the :oe:meth:`OEChem::OESubSearchResult::GetMatchIndices` method.
      After the search limit is reached
      (defined by :oe:cls:`GetMaxMatches<OEChem::OESubSearchQuery::GetMaxMatches>`), only
      the :oe:meth:`NumTotalMatches<OEChem::OESubSearchResult::NumTotalMatches>`
      counter will be updated.

      .. seealso::

         * :oe:meth:`OEChem::OESubSearchResult::NumTotalMatches` method

   .. oe:method:: NumScreened

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t NumScreened() const

      .. oe:language:: python

         .. oe:api:: python

            NumScreened() -> int

      Returns the number of molecules that could be eliminated by their
      screens.

      .. seealso::

         * :oe:func:`OEChem::OEScreen` function

   .. oe:method:: NumSearched

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t NumSearched() const

      .. oe:language:: python

         .. oe:api:: python

            NumSearched() -> int

      Returns the number of molecules that have to be searched i.e.
      the number of times :ref:`OESubSearch <OEChem_OESubSearch>` has to be used.

   .. oe:method:: NumTargets

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t NumTargets() const

      .. oe:language:: python

         .. oe:api:: python

            NumTargets() -> int

      Returns the number of target molecules i.e the number of molecules
      in the database.

   .. oe:method:: NumTotalMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t NumTotalMatches() const

      .. oe:language:: python

         .. oe:api:: python

            NumTotalMatches() -> int

      Returns the total number of matches in the database.

      .. seealso::

         * :oe:meth:`OEChem::OESubSearchResult::NumMatches` method


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. _OEChem_OESubSearchScreen:

.. oe:class:: OESubSearchScreen

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESubSearchScreen : public OESystem::OEBitVector

   :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>` class represents substructure search screens that encode local
   and global features of query and target molecules.
   These screens can be used to accelerate the substructure search since target molecules that clearly
   can not be matched to the query can be rapidly eliminated.
   Only molecules that pass the screening phase are subjected to the more expensive atom-by-atom validation
   when using the search methods of the :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` class.
   An :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>` objects are typed bit-vectors (:ref:`OEBitVector <OESystem_OEBitVector>`).
   The type determines what kind of queries in mind the screen was designed for
   (SMARTS, MDL query, or molecule query).

   .. figure:: oechemtk/images/Screen.*
      :scale: 50
      :align: center

      **Example of using substructure search screens to eliminate target molecules**

   .. seealso::

      * :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>` class
      * :oe:constns:`OEChem::OESubSearchScreenType` namespace
      * :oe:func:`OEChem::OEMakeSubSearchQueryScreen` and :oe:func:`OEChem::OEMakeSubSearchTargetScreen` functions

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESubSearchScreen()

      .. oe:language:: python

         .. oe:api:: python

            OESubSearchScreen() -> OESubSearchScreen

      The default constructor creates an uninitialized
      :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>` object. The object can be initialized by
      calling either the  :oe:func:`OEChem::OEMakeSubSearchQueryScreen` function
      for query molecules or the :oe:func:`OEChem::OEMakeSubSearchTargetScreen` function
      for target molecules.

      .. oe:language:: c++ python

         **Examples:**

         The following code snippet shows how to generate substructure screens:

         .. oe:source:: MakeScreen.cpp
            :language: c++
            :noindent:
            :frag:     SNIPPET

         .. oe:source:: MakeScreen.py
            :language: python
            :noindent:
            :frag:     SNIPPET

         The following code snippet shows how to store and retrieve screens
         as generic data:

         .. oe:source:: ScreenData.cpp
            :language: c++
            :noindent:
            :frag:     SNIPPET

         .. oe:source:: ScreenData.py
            :language: python
            :noindent:
            :frag:     SNIPPET

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESubSearchScreen(const OESubSearchScreen &)

      .. oe:language:: python

         .. oe:api:: python

            OESubSearchScreen(arg2: OESubSearchScreen) -> OESubSearchScreen

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESubSearchScreen &operator=(const OESubSearchScreen &)

      Assignment operator.

   .. oe:method:: GetScreenType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESubSearchScreenTypeBase* GetScreenType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScreenType() -> OESubSearchScreenTypeBase

      Returns the type of the screen (:ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>`).

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>` object has a valid
      screen type.

   .. oe:method: SetScreenType DO NOT DOCUMENT (SHOULD NOT BE SET MANUALLY)

      .. oe:api::

         void SetScreenType(const OESubSearchScreenTypeBase *stype)


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. _OEChem_OESubSearchScreenTypeBase:

.. oe:class:: OESubSearchScreenTypeBase

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESubSearchScreenTypeBase

   The :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>` class provides an interface
   to type :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>` objects.
   The type determines what kind of queries in mind the screen was designed for

   * :term:`SMARTS` patterns
   * :ref:`MDL<chapter_mdlqueries>` queries
   * simple molecule queries with no complex query features

   Screen types can not be constructed by themselves.
   The type of an :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>` object is determined
   when it is initialized by calling either the
   :oe:func:`OEChem::OEMakeSubSearchQueryScreen` or the
   :oe:func:`OEChem::OEMakeSubSearchTargetScreen` function.

   Each screen type has a version number. Version numbers are introduced in
   order to keep track of changes in the screen generation algorithm itself.

   .. seealso::

      * :oe:constns:`OEChem::OESubSearchScreenType` namespace

   .. oe:language:: c++ python

      The following code snippet shows how to interrogate the screen type.

      .. oe:source:: ScreenTypeString.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET

      .. oe:source:: ScreenTypeString.py
         :language: python
         :noindent:
         :frag:     SNIPPET

      The output of the code is:

      .. code-block:: console

         MDL SubSearch Screen,ver=0.9.0
         0.9.0
         MDL SubSearch Screen

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the name of the screen type.

   .. oe:method:: GetScreenType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetScreenType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScreenType() -> int

      Returns the screen type defined in the
      :oe:constns:`OEChem::OESubSearchScreenType` namespace.

   .. oe:method:: GetScreenTypeString

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetScreenTypeString() const

      .. oe:language:: python

         .. oe:api:: python

            GetScreenTypeString() -> str

      Returns the name and the version of the screen type in
      the string format.

   .. oe:method:: GetSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetSize() -> int

      Returns the number of bits in of the screen type.

   .. oe:method:: GetVersion

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned short GetVersion() const

      .. oe:language:: python

         .. oe:api:: python

            GetVersion() -> short

      Returns the current version of the screen type.

   .. oe:method:: GetVersionString

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetVersionString() const

      .. oe:language:: python

         .. oe:api:: python

            GetVersionString() -> str

      Returns the current version of the screen type in the string format,
      such as ``0.9.0`` .

   .. note::

      The version number of various screen types will not be changed with each release.
      It will be incremented only if modifications or bug fixes to the corresponding
      algorithm would result in generating a different screen for the same molecule.

      Screens with an old version number will **not** be supported. But rather it will
      be required to regenerate the screen databases.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETokenizerBase, TokenizerBase

.. _OEChem_OETokenizerBase:

.. oe:class:: OETokenizerBase

   .. oe:api::

      class OETokenizerBase

   This is an abstract base class used to represent an object that can
   efficiently split up a molecular file into a stream of tokens, each
   token representing one molecule in the stream. Implementations of
   this class are returned by the :oe:func:`OEChem::OEGetTokenizer`
   function. This class is expected to do the minimal amount of string
   parsing possible to determine the next chunk of bytes representing
   a molecule.

   .. oe:method:: GetNextToken

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string* GetNextToken(OEPlatform::oeistream& ifs)=0

      .. oe:language:: python

         .. oe:api:: python

            GetNextToken(ifs: oeistream) -> str

      Returns a chunk of bytes representing the next molecule in the
      stream ``ifs``. The stream of bytes is expected to be in the
      same file format as was passed to the
      :oe:func:`OEChem::OEGetTokenizer` factory function used to
      construct this object.

      .. oe:language:: c++

         This method returns a ``new std::string``, ownership is
         passed to the caller, that is expected to call ``delete``.

   .. oe:method:: ParseTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string ParseTitle(const std::string& data) const = 0

      .. oe:language:: python

         .. oe:api:: python

            ParseTitle(data: str) -> str

      Return the string that :oe:meth:`OEChem::OEMolBase::GetTitle`
      would return for the molecule record data passed in. The
      implementations of this method are designed to do the minimal
      amount of parsing required to retrieve the title. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETorsion, Torsion

.. _OEChem_OETorsion:

.. oe:class:: OETorsion

   .. oe:api::

      struct OETorsion

   An object to contain the information necessary to represent a
   torsion: a 3D rotation around the vector defined by the
   coordinates of ``a2`` and ``a3`` and an angle defined by ``a1`` and
   ``a4``. The angle is stored in radians instead of degrees

   .. seealso::

      * :oe:func:`OEChem::OEGetTorsions`
      * :oe:meth:`OEChem::OEConfBase::SetTorsion`
      * :oe:meth:`OEChem::OEMCMolBase::NewConf`
      * :oe:meth:`OESz::OESzybki::SetTorsionConstraint`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorsion()
            OETorsion(OEAtomBase* a1, OEAtomBase* a2, OEAtomBase* a3,
                      OEAtomBase* a4, double rads)

      .. oe:language:: python

         .. oe:api:: python

            OETorsion() -> OETorsion
            OETorsion(a1: OEAtomBase, a2: OEAtomBase, a3: OEAtomBase,
                      a4: OEAtomBase, rads: float) -> OETorsion

      Construct a torsion object containing 4 atoms and an angle in radians. 



.. oe:namespace:: OEChem

.. meta::
   :keywords: OETrans, Trans

.. _OEChem_OETrans:

.. oe:class:: OETrans

   .. oe:api::

      class OETrans

   This class represents `OETrans`.

   The :ref:`OETrans <OEChem_OETrans>` class is a container of high-level
   molecular transformations.
   It can be used to hold and wrap a series of molecular
   transformations, which can be applied to
   :oe:cls:`OEConfBase<OEChem::OEConfBase>` objects with a single function call.
   The :ref:`OETrans <OEChem_OETrans>` container keeps its own copies of the
   :oe:cls:`OETransBases<OEChem::OETransBase>`.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETrans()

      .. oe:language:: python

         .. oe:api:: python

            OETrans() -> OETrans

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETrans(const OETrans& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OETrans(rhs: OETrans) -> OETrans

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETrans(const OETransBase* t)
            OETrans(const OETransBase& tr)

      .. oe:language:: python

         .. oe:api:: python

            OETrans(tr: OETransBase) -> OETrans

      Creates a :ref:`OETrans <OEChem_OETrans>` transformation container and
      adds a copy of the :ref:`OETransBase <OEChem_OETransBase>` object to the
      container.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETrans &operator=(const OETrans &rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OETrans <OEChem_OETrans>` object
      into the right-hand side :ref:`OETrans <OEChem_OETrans>` object.

      Assignment operator.

   .. oe:method:: operator+=
      :language: c++

      .. oe:api::

         OETrans &operator+=(const OETrans &rhs)

      Makes copies of all :ref:`OETransBase <OEChem_OETransBase>` transformations
      of the 'rhs' :ref:`OETrans <OEChem_OETrans>` object and adds them to
      the end of the right-hand side :ref:`OETrans <OEChem_OETrans>` container.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns ``true``, if at least one transformation
      (:ref:`OETransBase <OEChem_OETransBase>`) is stored in the
      :ref:`OETrans <OEChem_OETrans>` object.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Removes all transformations (:ref:`OETransBase <OEChem_OETransBase>`) from
      the :ref:`OETrans <OEChem_OETrans>` object.

   .. oe:method:: Compress

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Compress()

      .. oe:language:: python

         .. oe:api:: python

            Compress() -> None

   .. oe:method:: Extract

      .. oe:language:: c++ java csharp

         .. oe:api::

            template<class T, class U>
            void Extract(T* rmat, U* trans, bool clobber = true) const

      .. oe:language:: python

         .. oe:api:: python

            Extract(rmat: OEFloatArray, trans: OEFloatArray,
                    clobber: bool = True) -> None
            Extract(rmat: OEDoubleArray, trans: OEDoubleArray,
                    clobber: bool = True) -> None

      Extract the :ref:`OETransBase <OEChem_OETransBase>` transformation as a rotation matrix, ``rmat``,
      and a translation vector, ``trans``.
 
   .. oe:method:: GetInverse

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetInverse(OETrans& inverse)

      .. oe:language:: python

         .. oe:api:: python

            GetInverse(inverse: OETrans) -> bool

   .. oe:method:: GetTransforms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OETransBase>* GetTransforms() const

      .. oe:language:: python

         .. oe:api:: python

            GetTransforms() -> OETransBaseIter

      Returns an iterator over the transformations
      (:ref:`OETransBase <OEChem_OETransBase>`) stored in the
      :ref:`OETrans <OEChem_OETrans>` object.

   .. oe:method:: PushBack

      .. oe:language:: c++ java csharp

         .. oe:api::

            void PushBack(const OETransBase& t)

      .. oe:language:: python

         .. oe:api:: python

            PushBack(t: OETransBase) -> None

      Makes a copy of the :ref:`OETransBase <OEChem_OETransBase>` transformation and adds it to
      the end of the :ref:`OETrans <OEChem_OETrans>` container.

   .. oe:method:: PushFront

      .. oe:language:: c++ java csharp

         .. oe:api::

            void PushFront(const OETransBase& t)

      .. oe:language:: python

         .. oe:api:: python

            PushFront(t: OETransBase) -> None

      Makes a copy of the :ref:`OETransBase <OEChem_OETransBase>` transformation and adds it to
      the front of the :ref:`OETrans <OEChem_OETrans>` container.

   .. oe:method:: Transform

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Transform(OEMolBase* mol) const
            void Transform(OEConfBase* conf) const

      .. oe:language:: python

         .. oe:api:: python

            Transform(conf: OEConfBase) -> None
            Transform(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

      Applies the transformation specified by the
      :ref:`OETransBase <OEChem_OETransBase>` object to the molecule or conformer
      passed.

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Transform(float* coords, unsigned int ncoords,
                           unsigned int dim) const
            void Transform(double* coords, unsigned int ncoords,
                           unsigned int dim) const

      .. oe:language:: python

         .. oe:api:: python

            Transform(coords: OEFloatArray, ncoords: int, dim: int) -> None
            Transform(coords: OEDoubleArray, ncoords: int, dim: int) -> None

      Applies all transformations stored in the  :ref:`OETrans <OEChem_OETrans>` object
      to the a set of coordinates ('coords').
      The 'row' argument specifies the number of coordinates in
      'coords' array, while the 'dim' argument specifies the dimension
      of the coordinates.
      These methods presumes that the size of 'coords' at least :math:`rows*dim`. 


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETransBase, TransBase

.. _OEChem_OETransBase:

.. oe:class:: OETransBase

   .. oe:api::

      class OETransBase

   The :ref:`OETransBase <OEChem_OETransBase>` is the abstract base class which
   describes the interface for all of the high-level molecular
   transformation objects.
   It allows generic application of many manipulations 
   (such as :oe:cls:`translation<OEChem::OETranslation>`,
   :oe:cls:`Euler rotation<OEChem::OEEuler>`, 
   :oe:cls:`rotation by matrix<OEChem::OERotMatrix>`, 
   :oe:cls:`quaternion rotation<OEChem::OEQuaternion>`) to conformers.
   All of the default transformation currently provided carry out
   rigid transformations of molecule positions rather than
   conformational modifications. These are provided in the *OEMath*
   namespace described below.

   The following classes derive from this class:
    * :ref:`OEEuler <OEChem_OEEuler>`
    * :ref:`OEQuaternion <OEChem_OEQuaternion>`
    * :ref:`OERotMatrix <OEChem_OERotMatrix>`
    * :ref:`OETranslation <OEChem_OETranslation>`
   

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETransBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OETransBase

      It is a virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.

   .. oe:method:: Extract

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Extract(float *, float *) const = 0
            void Extract(double *, float *) const = 0
            void Extract(float *, double *) const = 0
            void Extract(double *, double *) const = 0

      .. oe:language:: python

         .. oe:api:: python

            Extract(arg2: OEFloatArray, arg3: OEFloatArray) -> None
            Extract(arg2: OEDoubleArray, arg3: OEFloatArray) -> None
            Extract(arg2: OEFloatArray, arg3: OEDoubleArray) -> None
            Extract(arg2: OEDoubleArray, arg3: OEDoubleArray) -> None

   .. oe:method:: GetInverse

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETransBase* GetInverse() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetInverse() -> OETransBase

   .. oe:method:: Transform

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Transform(OEMolBase* mol) const
            void Transform(OEConfBase* conf) const

      .. oe:language:: python

         .. oe:api:: python

            Transform(conf: OEConfBase) -> None
            Transform(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

      Applies the transformation specified by the
      :ref:`OETransBase <OEChem_OETransBase>` object to the molecule or conformer
      passed.

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Transform(float* coords, unsigned int rows, unsigned int dim) const
            void Transform(double* coords, unsigned int rows, unsigned int dim) const

      .. oe:language:: python

         .. oe:api:: python

            Transform(coords: OEFloatArray, rows: int, dim: int) -> None
            Transform(coords: OEDoubleArray, rows: int, dim: int) -> None

      Applies the transformation specified by the
      :ref:`OETransBase <OEChem_OETransBase>` object to the a set of coordinates
      ('coords').
      The 'row' argument specifies the number of coordinates in
      'coords' array, while the 'dim' argument specifies the dimension
      of the coordinates.
      These methods presumes that the size of 'coords' at least :math:`rows*dim`. 
      Both methods modify the coordinates in place.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETranslation, Translation

.. _OEChem_OETranslation:

.. oe:class:: OETranslation

   .. oe:api::

      class OETranslation : public OETransBase

   This class represents `OETranslation`.

   The :ref:`OETranslation <OEChem_OETranslation>` class performs Cartesian translation.

   The following methods are publicly inherited from :ref:`OETransBase <OEChem_OETransBase>`:

   ====================================================== ====================================================== =====================================================
   :oe:meth:`CreateCopy<OEChem::OETransBase::CreateCopy>` :oe:meth:`GetInverse<OEChem::OETransBase::GetInverse>`                                                      
   :oe:meth:`Extract<OEChem::OETransBase::Extract>`       :oe:meth:`Transform<OEChem::OETransBase::Transform>`                                                        
   ====================================================== ====================================================== =====================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETranslation()
            OETranslation(const float* vec)
            OETranslation(const double* vec)
            OETranslation(float dx, float dy, float dz)
            OETranslation(double dx, double dy, double dz)

      .. oe:language:: python

         .. oe:api:: python

            OETranslation() -> OETranslation
            OETranslation(vec: OEDoubleArray) -> OETranslation
            OETranslation(vec: OEFloatArray) -> OETranslation
            OETranslation(dx: float, dy: float, dz: float) -> OETranslation

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETranslation &operator=(const float *vec)
         OETranslation &operator=(const double *vec)

      Assignment operator.

   .. oe:method:: operator+=
      :language: c++

      .. oe:api::

         OETranslation &operator+=(const OETranslation &rhs)

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETransBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OETransBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OETranslation <OEChem_OETranslation>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 

   .. oe:method:: Extract

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Extract(float* r, float* t) const
            void Extract(double* r, float* t) const
            void Extract(float* r, double* t) const
            void Extract(double* r, double* t) const

      .. oe:language:: python

         .. oe:api:: python

            Extract(r: OEFloatArray, t: OEFloatArray) -> None
            Extract(r: OEDoubleArray, t: OEFloatArray) -> None
            Extract(r: OEFloatArray, t: OEDoubleArray) -> None
            Extract(r: OEDoubleArray, t: OEDoubleArray) -> None

   .. oe:method:: GetInverse

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETransBase* GetInverse() const

      .. oe:language:: python

         .. oe:api:: python

            GetInverse() -> OETransBase

   .. oe:method:: GetTranslation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetTranslation(float* vec) const
            void GetTranslation(double* vec) const

      .. oe:language:: python

         .. oe:api:: python

            GetTranslation(vec: OEFloatArray) -> None
            GetTranslation(vec: OEDoubleArray) -> None

   .. oe:method: _Extract DO NOT DOCUMENT

      .. oe:api::

         template<class T, class U>
         void _Extract(T *rmat, U *trans) const



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEUnAtomPredParameter, UnAtomPredParameter

.. _OEChem_OEUnAtomPredParameter:

.. oe:class:: OEUnAtomPredParameter
      
   .. oe:api::

      class OEUnAtomPredParameter : public OEPredicateParameter<OESystem::OEUnaryPredicate<OEChem::OEAtomBase>>

   The :ref:`OEUnAtomPredParameter <OEChem_OEUnAtomPredParameter>` represents parameter that has value
   of :oe:cls:`OESystem::OEUnaryPredicate<OEChem::OEAtomBase>` type.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OEPredicateParameter <OEChem_OEPredicateParameter>`:
    * :oe:meth:`GetDefault<OEChem::OEPredicateParameter::GetDefault>` and
      :oe:meth:`SetDefault<OEChem::OEPredicateParameter::SetDefault>` 
    * :oe:meth:`GetSetting<OEChem::OEPredicateParameter::GetSetting>`
    * :oe:meth:`GetValue<OEChem::OEPredicateParameter::GetValue>` and
      :oe:meth:`SetValue<OEChem::OEPredicateParameter::SetValue>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUnAtomPredParameter()
            OEUnAtomPredParameter(const std::string& name)
            OEUnAtomPredParameter(const OEUnAtomPredParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEUnAtomPredParameter(name: str) -> OEUnAtomPredParameter
            OEUnAtomPredParameter() -> OEUnAtomPredParameter
            OEUnAtomPredParameter(arg2: OEUnAtomPredParameter) -> OEUnAtomPredParameter

      Default and copy constructors.

      Constructs an :ref:`OEUnAtomPredParameter <OEChem_OEUnAtomPredParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEUnAtomPredParameter &operator=(const OEUnAtomPredParameter &)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEUnBondPredParameter, UnBondPredParameter

.. _OEChem_OEUnBondPredParameter:

.. oe:class:: OEUnBondPredParameter
      
   .. oe:api::

      class OEUnBondPredParameter : public OEPredicateParameter<OESystem::OEUnaryPredicate<OEChem::OEBondBase>>

   The :ref:`OEUnBondPredParameter <OEChem_OEUnBondPredParameter>` represents parameter that has value
   of :oe:cls:`OESystem::OEUnaryPredicate<OEChem::OEBondBase>` type.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OEPredicateParameter <OEChem_OEPredicateParameter>`:
    * :oe:meth:`GetDefault<OEChem::OEPredicateParameter::GetDefault>` and
      :oe:meth:`SetDefault<OEChem::OEPredicateParameter::SetDefault>` 
    * :oe:meth:`GetSetting<OEChem::OEPredicateParameter::GetSetting>`
    * :oe:meth:`GetValue<OEChem::OEPredicateParameter::GetValue>` and
      :oe:meth:`SetValue<OEChem::OEPredicateParameter::SetValue>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUnBondPredParameter()
            OEUnBondPredParameter(const std::string& name)
            OEUnBondPredParameter(const OEUnBondPredParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEUnBondPredParameter(name: str) -> OEUnBondPredParameter
            OEUnBondPredParameter() -> OEUnBondPredParameter
            OEUnBondPredParameter(arg2: OEUnBondPredParameter) -> OEUnBondPredParameter

      Default and copy constructors.

      Constructs an :ref:`OEUnBondPredParameter <OEChem_OEUnBondPredParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEUnBondPredParameter &operator=(const OEUnBondPredParameter &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEUnaryToBinaryAnd, UnaryToBinaryAnd

.. _OEChem_OEUnaryToBinaryAnd:

.. oe:class:: OEUnaryToBinaryAnd

   .. oe:api::

      template<typename T>
      class OEUnaryToBinaryAnd : public OESystem::OEBinaryPredicate<T, T>

   This class represents `OEUnaryToBinaryAnd`.

   The following methods are publicly inherited from :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>`:

   =============================================================================== =============================================================================== ================================================================================
   :oe:meth:`operator()<OESystem::OEBinaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEBinaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEBinaryPredicate::CreatePredicateCopy>`
   =============================================================================== =============================================================================== ================================================================================

   The following methods are publicly inherited from :ref:`OEBinaryFunction <OESystem_OEBinaryFunction>`:

   ============================================================= ============================================================= ============================================================
   :oe:meth:`operator()<OESystem::OEBinaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEBinaryFunction::CreateCopy>`                                                             
   ============================================================= ============================================================= ============================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEUnaryToBinaryAnd(const OEUnaryToBinaryAnd& rhs)
         OEUnaryToBinaryAnd(const OESystem::OEUnaryPredicate<T>& p)

      Default and copy constructors.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const T& arg1, const T& arg2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg1: T, arg2: T) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<T, T, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryToBinaryAnd



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEUnaryToBinaryOr, UnaryToBinaryOr

.. _OEChem_OEUnaryToBinaryOr:

.. oe:class:: OEUnaryToBinaryOr

   .. oe:api::

      template<typename T>
      class OEUnaryToBinaryOr : public OESystem::OEBinaryPredicate<T, T>

   This class represents `OEUnaryToBinaryOr`.

   The following methods are publicly inherited from :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>`:

   =============================================================================== =============================================================================== ================================================================================
   :oe:meth:`operator()<OESystem::OEBinaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEBinaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEBinaryPredicate::CreatePredicateCopy>`
   =============================================================================== =============================================================================== ================================================================================

   The following methods are publicly inherited from :ref:`OEBinaryFunction <OESystem_OEBinaryFunction>`:

   ============================================================= ============================================================= ============================================================
   :oe:meth:`operator()<OESystem::OEBinaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEBinaryFunction::CreateCopy>`                                                             
   ============================================================= ============================================================= ============================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEUnaryToBinaryOr(const OEUnaryToBinaryOr& rhs)
         OEUnaryToBinaryOr(const OESystem::OEUnaryPredicate<T>& p)

      Default and copy constructors.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const T& arg1, const T& arg2)
            bool operator()(const T& arg1, const T& arg2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg1: T, arg2: T) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<T, T, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryToBinaryOr



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEUniMolecularRxn, UniMolecularRxn

.. _OEChem_OEUniMolecularRxn:

.. oe:class:: OEUniMolecularRxn

   .. oe:api::

      class OEUniMolecularRxn

   The :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` class is designed to apply a
   chemical transformation to a molecule. The primary purpose of the
   class is to provide an efficient means of applying normalization
   reactions, although there are few restrictions on the types of
   chemical transformations that can be applied.  The reaction used to
   initialize the class must contain only a single reactant.  The
   provided transformation is applied iteratively until no further
   reactant patterns are matched. Caution must be used in defining the
   transformation as it is possible to provide a reaction that will
   cause a :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` object to iterate until memory
   is exhausted. For example, a reaction for which the reactant
   pattern matches the transformed product molecule will reapply the
   transformation indefinitely and must be avoided.  Note, however,
   that atoms and bonds created by a transformation are excluded from
   involvement in iterative applications of the transformation.

   .. figure:: oechemtk/images/OEUniMolecularRxn.*
      :scale:  100
      :align:  center

      **OEUniMolecularRxn**

      *Example of amine nitrogen protonation using 'OEUniMolecularRxn'. Transformations are applied to the starting material recursively*

   .. seealso::

      .. oe:language:: c++

         * :ref:`chapter_reactions` chapter
         * :term:`SMIRKS`
         * :ref:`OELibraryGen <OEChem_OELibraryGen>` class
         * Example program :ref:`unimolrxn.cpp<section_example_oechem_unimolrxn>`

      .. oe:language:: python

         * :ref:`chapter_reactions` chapter
         * :term:`SMIRKS`
         * :ref:`OELibraryGen <OEChem_OELibraryGen>` class
         * Example program :ref:`unimolrxn.py<section_example_oechem_unimolrxn>`

      .. oe:language:: java

         * :ref:`chapter_reactions` chapter
         * :term:`SMIRKS`
         * :ref:`OELibraryGen <OEChem_OELibraryGen>` class
         * Example program :ref:`UniMolRxn.java<section_example_oechem_unimolrxn>`

      .. oe:language:: csharp

         * :ref:`chapter_reactions` chapter
         * :term:`SMIRKS`
         * :ref:`OELibraryGen <OEChem_OELibraryGen>` class
         * Example program :ref:`UniMolRxn.cs<section_example_oechem_unimolrxn>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUniMolecularRxn()

      .. oe:language:: python

         .. oe:api:: python

            OEUniMolecularRxn() -> OEUniMolecularRxn

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUniMolecularRxn(const OEUniMolecularRxn& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEUniMolecularRxn(arg2: OEUniMolecularRxn) -> OEUniMolecularRxn

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUniMolecularRxn(const char * smirks, bool strictSmirks)

      .. oe:language:: python

         .. oe:api:: python

            OEUniMolecularRxn(c: str, strictSmirks: bool) -> OEUniMolecularRxn

      Creates a :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` object with a (:term:`SMIRKS`) pattern.
      Attempts to initialize an :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>`
      object with a reaction that has more than one reactant will
      result in an initialization failure.
      Initialization success can be tested using the operator
      :oe:meth:`OEChem::OEUniMolecularRxn::operator bool` method.
      The second argument to the constructor is used to specify the
      interpretation of the :term:`SMIRKS` semantics.
      By default, the ``smirks`` string is interpreted using strict
      semantics via a value ``true``.

      Passing a ``smirks`` value of ``false`` to the second method argument will relax
      the strict SMIRKS restrictions.
      A mapped reactant atom that does not have a corresponding mapped
      product atom is valid, and will be destroyed as part of the
      reaction.
      Unmapped reactant atoms will be used to match the reactant
      pattern, but are not destroyed when the reaction is applied.
      The resulting :term:`SMIRKS` like reactions may therefore be
      more easily readable by humans as fewer atoms may be required to
      be mapped.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxn::Init` method
         * :term:`SMIRKS` definition describing the strict SMIRKS semantics

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUniMolecularRxn(const char * smirks,
                              const OEChem::OEUniMolecularRxnOptions& options = OEUniMolecularRxnOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEUniMolecularRxn(c: str,
                              opts: OEUniMolecularRxnOptions = OEUniMolecularRxnOptions()) -> OEUniMolecularRxn

      Creates a :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` object with a
      (:term:`SMIRKS`) pattern.  The options class argument will be interrogated to determine the desired
      strict ``smirks`` interpretation requested for the (:term:`SMIRKS`) processing.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::GetStrictSmirks` method
         * :oe:meth:`OEChem::OEUniMolecularRxn::Init` method
         * :term:`SMIRKS` definition describing the strict SMIRKS semantics

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEUniMolecularRxn &operator=(const OEUniMolecularRxn &rhs)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Applies the transformation that the
      :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` object contains on
      the passed :ref:`OEMolBase <OEChem_OEMolBase>` object.
      Returns ``true`` if the reactant pattern matches at least one
      time in the passed molecule.

      If the :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` fails to apply any
      transformations because the reactant pattern failed to match the
      molecule, the method will return ``false``.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns ``true``, if the :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>`
      object was initialized with no failures using either the
      constructors or one of the
      :oe:meth:`OEChem::OEUniMolecularRxn::Init` methods.

      The method will return ``false`` when the
      :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` object has not been properly
      initialized as it will be unable to apply transform operations
      to molecules.

   .. oe:method:: GetClearCoordinates

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetClearCoordinates() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearCoordinates() -> bool

      Returns whether the coordinates of a molecule are cleared
      before performing the chemical transformation.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxn::SetClearCoordinates` method

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUniMolecularRxnOptions& GetOptions()
            const OEUniMolecularRxnOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEUniMolecularRxnOptions

      Returns the internal options class in the :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>`
      instance.  A non-const instance supports changing the option control values for
      options that are active during transformation application.  Note that the
      ``strict`` flag processing setting occurs when the :term:`SMIRKS` or :oe:cls:`OEQMolBase<OEChem::OEQMolBase>`
      transformation is processed and not during application of the transformation.

      .. seealso::

         * :ref:`OEUniMolecularRxnOptions <OEChem_OEUniMolecularRxnOptions>` class

   .. oe:method:: GetValidateKekule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetValidateKekule() const

      .. oe:language:: python

         .. oe:api:: python

            GetValidateKekule() -> bool

      Returns whether the transformation validates the |Kekule|
      form of the returned products.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxn::SetValidateKekule` method
         * :ref:`subsection_reactions_libgen_kekule` section

   .. oe:method:: Init

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const char* smirks,
                      const OEUniMolecularRxnOptions& options = OEUniMolecularRxnOptions())
            bool Init(const OEQMolBase& qmol,
                      const OEUniMolecularRxnOptions& options = OEUniMolecularRxnOptions())

      .. oe:language:: python

         .. oe:api:: python

            Init(c: str,
                 opts: OEUniMolecularRxnOptions = OEUniMolecularRxnOptions()) -> bool
            Init(arg2: OEQMol,
                 opts: OEUniMolecularRxnOptions = OEUniMolecularRxnOptions()) -> bool

      The first two method overloads initialize an :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>`
      object with a ``smirks`` pattern and either the explicitly provided ``strict`` flag
      setting or via the ``strict`` setting from the provided options class.

      The next two method overloads initialize an :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>`
      object with a :oe:cls:`OEQMolBase<OEChem::OEQMolBase>` object and either the explicitly provided ``strict`` flag
      setting or via the ``strict`` setting from the provided options class.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::GetStrictSmirks` method

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const char* smirks, bool strict)
            bool Init(const OEQMolBase &, bool strictSmirks = true)

      .. oe:language:: python

         .. oe:api:: python

            Init(c: str, strictSmirks: bool) -> bool
            Init(arg2: OEQMol, strictSmirks: bool) -> bool

      Initializes an :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` object with a
      query molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`).
      If query molecule is created using the
      :oe:func:`OEChem::OEParseSmirks` function, and if the reaction is
      desired to be interpreted using strict :term:`SMIRKS` semantics,
      then the default ``true`` value for the second argument to the method
      should be used.

      Passing a value of ``false`` to the second argument will relax the
      restrictions imposed by strict SMIRKS semantics.

      .. seealso::

         * :term:`SMIRKS` definition describing the strict SMIRKS semantics

   .. oe:method:: SetClearCoordinates

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetClearCoordinates(bool clearcoords)

      .. oe:language:: python

         .. oe:api:: python

            SetClearCoordinates(arg2: bool) -> bool

      Sets whether the coordinates of a molecule are cleared
      before performing the chemical transformation.

     .. note::

         The :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` modifies the molecular
         graph when applying the transformations.
         Generating valid 2D or 3D coordinates for the products is
         beyond the scope of the :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>`
         class.

         It is recommended to either clear the coordinates by
         invoking the :oe:meth:`OEChem::OEUniMolecularRxn::SetClearCoordinates`
         method or regenerate the coordinates of the molecule afterwards.

         If no transformation is applied the molecule will not be changed.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxn::GetClearCoordinates` method

   .. oe:method:: SetValidateKekule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetValidateKekule(bool validate)

      .. oe:language:: python

         .. oe:api:: python

            SetValidateKekule(arg2: bool) -> bool

      Sets whether the generated products are simply returned after a
      Kekulization attempt, or if the |Kekule| form is validated more
      rigorously. If the extra validation is enabled and an invalid
      |Kekule| form is identified, alternatives are tried by adding
      and removing implicit hydrogens from aromatic nitrogens to
      produce a valid |Kekule| form.  No further attempt is made to
      return the most reasonable or chemically sensible result.  By
      default, the extra |Kekule| validation is enabled.

      .. seealso::

         * :ref:`subsection_reactions_libgen_kekule` section


.. role:: raw-html(raw)
   :format: html

.. oe:namespace:: OEChem

.. meta::
   :keywords: OEUniMolecularRxnOptions, UniMolecularRxnOptions

.. _OEChem_OEUniMolecularRxnOptions:

.. oe:class:: OEUniMolecularRxnOptions

   .. oe:api::

      class OEUniMolecularRxnOptions

   This class represents the :ref:`OEUniMolecularRxnOptions <OEChem_OEUniMolecularRxnOptions>` options class
   that encapsulates properties to control transforms using :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>`
   and :oe:func:`OEChem::OEGetUniMolecularRxnIter`.

   .. seealso::

      * :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` class
      * :oe:func:`OEChem::OEGetUniMolecularRxnIter`

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUniMolecularRxnOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEUniMolecularRxnOptions() -> OEUniMolecularRxnOptions

      Default constructor that initializes an :ref:`OEUniMolecularRxnOptions <OEChem_OEUniMolecularRxnOptions>`
      object with the following properties:

      .. list-table::  **Default parameters of OEUniMolecularRxnOptions**
         :widths: 50 50
         :header-rows: 1

         * - Option
           - Default value

         * - Strict SMIRKS
           - ``true``

         * - Validate Kekule
           - ``true``

         * - Clear Coordinates
           - ``false``

         * - Hydrogen Conversions
           - ``true``

         * - Fix Valences
           - :oe:const:`OEChem::OEUniMolecularRxnFixValence::Explicit`

         * - Altered Tag
           - empty

         * - Max Matches
           - 10000

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUniMolecularRxnOptions(const OEUniMolecularRxnOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEUniMolecularRxnOptions(arg2: OEUniMolecularRxnOptions) -> OEUniMolecularRxnOptions

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEUniMolecularRxnOptions &operator=(const OEUniMolecularRxnOptions &rhs)

      Assignment operator.

   .. ################################################################
      # GetAlteredTag
      ################################################################

   .. oe:method:: GetAlteredTag

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetAlteredTag() const

      .. oe:language:: python

         .. oe:api:: python

            GetAlteredTag() -> str

      Return the desired generic data tag that captures the boolean state
      indicating specific atoms that are modified by the transformation.
      If empty or blank, no generic data is returned on the transformation
      product atoms.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::SetAlteredTag` method

   .. ################################################################
      # GetClearCoordinates
      ################################################################

   .. oe:method:: GetClearCoordinates

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetClearCoordinates() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearCoordinates() -> bool

      Returns whether the coordinates of a molecule are cleared
      before performing the chemical transformation.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::SetClearCoordinates` method

   .. ################################################################
      # GetFixValence
      ################################################################

   .. oe:method:: GetFixValence

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetFixValence() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixValence() -> int

      Returns what type of valence corrections should be applied
      to the transformation products.   The legal values are
      taken from :oe:constns:`OEChem::OEUniMolecularRxnFixValence`.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::SetFixValence` method

   .. ################################################################
      # GetHydrogenConversions
      ################################################################

   .. oe:method:: GetHydrogenConversions

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetHydrogenConversions() const

      .. oe:language:: python

         .. oe:api:: python

            GetHydrogenConversions() -> bool

      Returns whether hydrogen count conversions are allowed to be performed
      on transformation targets based on the transformation SMIRKS requirements.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::SetHydrogenConversions` method
         * :oe:func:`OEChem::OEPrepareSearch` function

   .. ################################################################
      # GetMaxMatches
      ################################################################

   .. oe:method:: GetMaxMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxMatches() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMatches() -> int

      The maximum number of transformations returned or applied.
      A value of ``0`` indicates there is no constraint.
      Note that if this value is low, the transformations returned will
      be arbitrarily truncated to this limit.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::SetMaxMatches` method

   ..   _OEChem_GetStrictSmirks:

   .. oe:method:: GetStrictSmirks

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStrictSmirks() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrictSmirks() -> bool

      Returns the current setting of the ``strict`` flag that
      controls how to interpret the :term:`SMIRKS` for the transformation.
      This setting value controls the interpretation of the :term:`SMIRKS` semantics.
      By default, the :term:`SMIRKS` string is interpreted using strict
      semantics (i.e., with the setting value of ``true``).

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::SetStrictSmirks` method

   .. ################################################################
      # GetValidateKekule
      ################################################################

   .. oe:method:: GetValidateKekule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetValidateKekule() const

      .. oe:language:: python

         .. oe:api:: python

            GetValidateKekule() -> bool

      Returns whether the transformation validates the Kekulé
      form of the returned products.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::SetValidateKekule` method

   .. ################################################################
      # SetAlteredTag
      ################################################################

   .. oe:method:: SetAlteredTag

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAlteredTag(const std::string& alteredtag)

      .. oe:language:: python

         .. oe:api:: python

            SetAlteredTag(tag: str) -> bool

      Sets the desired generic data tag value used to capture boolean data
      indicating specific atoms that are modified by the transformation.
      If empty or blank, no generic data is returned on the transformation
      product atoms.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::GetAlteredTag` method

   .. ################################################################
      # SetClearCoordinates
      ################################################################

   .. oe:method:: SetClearCoordinates

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetClearCoordinates(bool clearcoords)

      .. oe:language:: python

         .. oe:api:: python

            SetClearCoordinates(arg2: bool) -> bool

      Sets whether the coordinates of a molecule should be cleared
      before performing the chemical transformation.

     .. note::

         The :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` modifies the molecular
         graph when applying the transformations.
         Generating valid 2D or 3D coordinates for the products is
         beyond the scope of the :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>`
         class.

         It is recommended to either clear the coordinates by
         invoking the :oe:meth:`OEChem::OEUniMolecularRxn::SetClearCoordinates`
         method or regenerate the coordinates of the molecule afterwards.

         If no transformation is applied the molecule will not be changed.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::GetClearCoordinates` method

   .. ################################################################
      # SetFixValence
      ################################################################

   .. oe:method:: SetFixValence

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixValence(unsigned fixvalence)

      .. oe:language:: python

         .. oe:api:: python

            SetFixValence(arg2: int) -> bool

      Sets the type of valence corrections that should be applied
      to the transformation products.   The legal values are
      taken from :oe:constns:`OEChem::OEUniMolecularRxnFixValence`.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::GetFixValence` method

   .. ################################################################
      # SetHydrogenConversions
      ################################################################

   .. oe:method:: SetHydrogenConversions

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetHydrogenConversions(bool allowed)

      .. oe:language:: python

         .. oe:api:: python

            SetHydrogenConversions(arg2: bool) -> bool

      Sets whether hydrogen count conversions are allowed to be performed
      on transformation targets based on the transformation SMIRKS requirements.
      If ``true``, :oe:func:`OEChem::OEPrepareSearch` is called to reconcile the
      hydrogen state between the target and query as well as any other perception
      information needed for the query (aromaticity, etc.).

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::GetHydrogenConversions` method
         * :oe:func:`OEChem::OEPrepareSearch` function

   .. ################################################################
      # SetMaxMatches
      ################################################################

   .. oe:method:: SetMaxMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxMatches(unsigned maxmatches)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxMatches(maxMatches: int) -> bool

      Sets the maximum number of transformations that should
      be returned or applied. Setting the value to ``0`` removes
      the constraint. Note that if this value is low, the transformations returned will
      be arbitrarily truncated to this limit.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::GetMaxMatches` method

   .. ################################################################
      # SetStrictSmirks
      ################################################################

   .. oe:method:: SetStrictSmirks

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStrictSmirks(bool strict)

      .. oe:language:: python

         .. oe:api:: python

            SetStrictSmirks(arg2: bool) -> bool

      Sets the desired value of the ``strict`` flag that
      controls how to interpret the :term:`SMIRKS` for the transformation.
      This setting value controls the interpretation of the :term:`SMIRKS` semantics.
      By default, the :term:`SMIRKS` string is interpreted using strict
      semantics (i.e., with the setting value of ``true``).

      .. seealso::

         * :ref:`GetStrictSmirks <OEChem_GetStrictSmirks>` method
         * :term:`SMIRKS` definition describing the strict SMIRKS semantics

   .. ################################################################
      # SetValidateKekule
      ################################################################

   .. oe:method:: SetValidateKekule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetValidateKekule(bool validatekekule)

      .. oe:language:: python

         .. oe:api:: python

            SetValidateKekule(arg2: bool) -> bool

      Sets whether the generated products are simply returned after a
      Kekulization attempt, or if the Kekulé form is validated more
      rigorously. If the extra validation is enabled and an invalid
      Kekulé form is identified, alternatives are tried by adding
      and removing implicit hydrogens from aromatic nitrogens to
      produce a valid Kekulé form.  No further attempt is made to
      return the most reasonable or chemically sensible result.  By
      default, the extra Kekulé validation is enabled.

      .. seealso::

         * :oe:meth:`OEChem::OEUniMolecularRxnOptions::GetValidateKekule` method


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEVectorBindings, VectorBindings

.. _OEChem_OEVectorBindings:

.. oe:class:: OEVectorBindings

   .. oe:api::

      class OEVectorBindings

   This class represents `OEVectorBindings`.

   The :ref:`OEVectorBindings <OEChem_OEVectorBindings>` class is used to store a set of
   vector bindings or lexigraphic replacements that may appear in a
   :term:`SMARTS` pattern.
 
   A vector binding is a :term:`SMARTS` pattern bound to a name. 
   For example, the name ``[$HALO]`` can be used to represent the
   pattern ``[$(F,Cl,Br,I)]`` in order to make a pattern more human
   readable.
   The :ref:`OEVectorBindings <OEChem_OEVectorBindings>` class converts :term:`SMARTS`
   patterns written using vector bindings (human readable form) to the
   corresponding machine readable form by performing a name to pattern
   replacement.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEVectorBindings()
            OEVectorBindings(const OEVectorBindings &)

      .. oe:language:: python

         .. oe:api:: python

            OEVectorBindings() -> OEVectorBindings
            OEVectorBindings(arg2: OEVectorBindings) -> OEVectorBindings

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEVectorBindings &operator=(const OEVectorBindings &)

      Assignment operator.

   .. oe:method:: Add

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Add(const char* label, const char* pattern)

      .. oe:language:: python

         .. oe:api:: python

            Add(label: str, pattern: str) -> bool

      Adds one vector binding to an :ref:`OEVectorBindings <OEChem_OEVectorBindings>`
      object.
      The 'label' given as the first method argument is the name that
      appears in the human readable version of a :term:`SMARTS`, while
      the 'pattern' given as the second method argument is the
      :term:`SMARTS` that should be used to replace the ''label''.
      If the 'pattern' is parsed correctly and the association is made
      in the :ref:`OEVectorBindings <OEChem_OEVectorBindings>` object, the method will return
      ``true``.
      If the 'pattern' is invalid or the association cannot be made
      the method will return ``false``.
      All attempts to associate a :term:`SMARTS` pattern with a
      particular 'label' after the first association succeeds will
      result subsequent failures to create new associations.

   .. oe:method:: Get

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Get(const OEExprBase *&expr, const char *&label,
                     const char* smarts) const

      .. oe:language:: python

         .. oe:api:: python

            Get(expr: OEExprBase, label: str, smarts: str) -> bool

      Retrieves the 'label' and corresponding
      :ref:`OEExprBase <OEChem_OEExprBase>` pointer reference as the first and
      second method arguments, respectively, given a pointer to a
      position within a `smarts` string given as the final
      argument.
      If the 'smarts' string position points to the beginning of a
      vector bound 'label' contained in the
      :ref:`OEVectorBindings <OEChem_OEVectorBindings>` object then the method will
      return ``true``.
      If the vector binding cannot be identified then the method will
      return ``false``.


.. oe:namespace:: OEChem

.. meta::
   :keywords: oemolistream, molistream

.. _OEChem_oemolistream:

.. oe:class:: oemolistream

   .. oe:api::

      class oemolistream : public oemolstreambase

   The :ref:`oemolistream <OEChem_oemolistream>` class provides a stream-like
   abstraction for reading molecules from files, strings or standard
   input.
   The :ref:`oemolistream <OEChem_oemolistream>` maintains the format and flavor
   of molecular reading for the stream.
   It also manages the conversion between multi-conformer molecules
   and single conformer molecules in cases where the molecule read
   into is not compatible with the file format (in the sense of a
   multi-conformer file format being read into a single-conformer
   molecule, or a single-conformer file format being read into a
   multi-conformer molecule).
   The :ref:`oemolistream <OEChem_oemolistream>` is capable of
   uncompressing gzip files while reading.

   The following methods are publicly inherited from :ref:`oemolstreambase <OEChem_oemolstreambase>`:

   ========================================================================== ========================================================================= =========================================================================
   :oe:meth:`ClearCSVHeader<OEChem::oemolstreambase::ClearCSVHeader>`         :oe:meth:`GetFlavor<OEChem::oemolstreambase::GetFlavor>`                  :oe:meth:`SetFormat<OEChem::oemolstreambase::SetFormat>`
   :oe:meth:`GetBinaryIOHandler<OEChem::oemolstreambase::GetBinaryIOHandler>` :oe:meth:`GetFormat<OEChem::oemolstreambase::GetFormat>`                  :oe:meth:`close<OEChem::oemolstreambase::close>`
   :oe:meth:`GetCSVHeader<OEChem::oemolstreambase::GetCSVHeader>`             :oe:meth:`Getgz<OEChem::oemolstreambase::Getgz>`                          :oe:meth:`open<OEChem::oemolstreambase::open>`
   :oe:meth:`GetFileName<OEChem::oemolstreambase::GetFileName>`               :oe:meth:`SetFlavor<OEChem::oemolstreambase::SetFlavor>`
   ========================================================================== ========================================================================= =========================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oemolistream()

      .. oe:language:: python

         .. oe:api:: python

            oemolistream() -> oemolistream

      Default constructor.
      Creates a new :ref:`oemolistream <OEChem_oemolistream>` object
      that is connected to the standard input.

      .. oe:language:: c++ java csharp

         .. oe:api::

            explicit oemolistream(const char* fname)
            explicit oemolistream(const std::string& fname)

      .. oe:language:: python

         .. oe:api:: python

            oemolistream(arg2: str) -> oemolistream
            oemolistream(fn: str) -> oemolistream

      Creates a new :ref:`oemolistream <OEChem_oemolistream>` object and opens
      the file specified by the given name ('fname').

      .. oe:language:: c++ java csharp

         .. oe:api::

            explicit oemolistream(OEPlatform::oeistream *, bool owned = true)

      .. oe:language:: python

         .. oe:api:: python

            oemolistream(arg2: oeistream, owned: bool = True) -> oemolistream

      Creates a new :ref:`oemolistream <OEChem_oemolistream>` object from an
      existing :ref:`oeistream <OEPlatform_oeistream>` object.
      The second optional argument is used to indicate whether the new
      :ref:`oemolistream <OEChem_oemolistream>` now owns the given
      :ref:`oeistream <OEPlatform_oeistream>` and is therefore responsible for
      closing and destroying it when it itself is closed and/or
      destroyed.

      .. warning::

         Only in C++ can an :ref:`oemolistream <OEChem_oemolistream>` object own an existing
         :ref:`oeistream <OEPlatform_oeistream>` object.

      .. oe:language:: python

         .. admonition:: Usage in Python

            .. code-block:: console

               i = oechem.oeistream()
               owned = True
               ifs = oechem.oemolistream(i, not owned)

      .. seealso::

         To associate a file or a stream with an
         :ref:`oemolistream <OEChem_oemolistream>` after it has been created, see the
         :oe:meth:`OEChem::oemolstreambase::open` method.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

   .. oe:method:: operator OEPlatform::oeistream &
      :language: c++

      .. oe:api::

         operator OEPlatform::oeistream &() const

   .. oe:method:: GetConfTest

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEConfTestBase & GetConfTest() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfTest() -> OEConfTestBase

   .. oe:language:: python

      .. oe:method:: GetOEMols

         .. oe:api::

            GetOEMols() -> <generator of OEMol objects>

         Returns a generator over all the molecules in the
         file or stream. Each molecule will be an
         :ref:`OEMol <OEChem_OEMol>` object. These are references to the
         molecules in the file or stream and so calling this method
         does not create copies of the molecules.

   .. oe:language:: python

   .. oe:method:: GetOEGraphMols

       .. oe:api::

          GetOEGraphMols() -> <generator of OEGraphMol objects>

       Returns a generator over all the  molecules in the
       input stream in the current order. Each molecule will be
       an :ref:`OEGraphMol <OEChem_OEGraphMol>` object. If opened on a
       multi-conformer :file:`.oeb` file, only the first conformer
       will be returned for each molecule record.

       .. note::

          Unlike ``OEChem::OEMolDatabase::GetOEGraphMols``, a reference to
          each molecule will be used for each iteration to avoid unnecessary
          copying of molecules.

   .. oe:method:: GetMCMolBases

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEMCMolBase>* GetMCMolBases(bool single = false)

      .. oe:language:: python

         .. oe:api:: python

            GetMCMolBases(single: bool = False) -> Iterable[OEMol]

   .. oe:method:: GetMolBases

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEMolBase>* GetMolBases()

      .. oe:language:: python

         .. oe:api:: python

            GetMolBases() -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

   .. oe:method: GetNextMol -- INTERNAL API TO HANDLE MULTI-CONFORMER MOLECULES

      .. oe:api::

         OEMolBase *GetNextMol()

   .. oe:method:: GetReadFailureCt

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetReadFailureCt() const

      .. oe:language:: python

         .. oe:api:: python

            GetReadFailureCt() -> int

   .. oe:method: HasNextMol -- INTERNAL API TO HANDKE MULTI-CONFORMER MOLECULES

      .. oe:api::

         bool HasNextMol() const

   .. oe:method:: IncrementReadFailureCt

      .. oe:language:: c++ java csharp

         .. oe:api::

            void IncrementReadFailureCt()

      .. oe:language:: python

         .. oe:api:: python

            IncrementReadFailureCt() -> None

   .. oe:method: PeekNextMol -- INTERNAL API TO HANDKE MULTI-CONFORMER MOLECULES

      .. oe:api::

         OEMolBase *PeekNextMol()

   .. oe:method: PushNextMol -- INTERNAL API TO HANDKE MULTI-CONFORMER MOLECULES

      .. oe:api::

         void PushNextMol(OEMolBase *mol, oefpos_t pos = 0)

   .. oe:method:: ResetReadFailureCt

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ResetReadFailureCt()

      .. oe:language:: python

         .. oe:api:: python

            ResetReadFailureCt() -> None

   .. oe:method:: SetConfTest

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetConfTest(const OEConfTestBase &)

      .. oe:language:: python

         .. oe:api:: python

            SetConfTest(arg2: OEConfTestBase) -> bool

      Sets the functor class which is used to compare incoming graphs
      to determine whether they should be placed as conformers of a
      multi-conformer molecule or be returned individually as single
      molecules.
      The default conformer test never places separate graphs into a
      multi-conformer molecule (:ref:`OEDefaultConfTest <OEChem_OEDefaultConfTest>`).

      .. seealso::

         * :ref:`OEAbsCanonicalConfTest <OEChem_OEAbsCanonicalConfTest>`
         * :ref:`OEAbsoluteConfTest <OEChem_OEAbsoluteConfTest>`
         * :ref:`OEConfTestBase <OEChem_OEConfTestBase>`
         * :ref:`OEDefaultConfTest <OEChem_OEDefaultConfTest>`
         * :ref:`OEIsomericConfTest <OEChem_OEIsomericConfTest>`

   .. oe:method:: SetFlavor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFlavor(unsigned int format, unsigned int flavor)

      .. oe:language:: python

         .. oe:api:: python

            SetFlavor(format: int, flavor: int) -> bool

      Sets the file flavor for a given format associated with the
      :ref:`oemolistream <OEChem_oemolistream>` object.
      The set of valid formats are defined in the
      :ref:`the OEFormat namespace <OEChem_OEFormat>`.
      The set of valid bitmasks flavors are defined in the
      :oe:constns:`OEChem::OEIFlavor` namespace.
      The current flavor can be queried using the
      :oe:meth:`OEChem::oemolstreambase::GetFlavor` method.
      Each format has its own specific flavor which must be set
      separately.
      The :ref:`oemolistream <OEChem_oemolistream>` constructors
      call the :oe:func:`OEChem::OESetDefaultFlavors` function
      to set the flavors for all of the formats to their default state.

   .. oe:method:: SetFormat

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFormat(unsigned int format)

      .. oe:language:: python

         .. oe:api:: python

            SetFormat(format: int) -> bool

      Sets the file format associated with the
      :ref:`oemolistream <OEChem_oemolistream>` object.
      The set of valid formats are defined in the
      :ref:`the OEFormat namespace <OEChem_OEFormat>`.
      By default, when reading from standard input, the associated
      file format is :oe:const:`OEChem::OEFormat::SMI`.
      The file format property of an :ref:`oemolistream <OEChem_oemolistream>`
      may be retrieved using the
      :oe:meth:`OEChem::oemolstreambase::GetFormat` method.

      .. note::

         The file format property is also set automatically by
         :oe:meth:`OEChem::oemolstreambase::open` based upon the file
         extension of the specified filename.

   .. oe:method:: SetTracer

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTracer(OESystem::OETracerBase* tracer, bool owntracer)

      .. oe:language:: python

         .. oe:api:: python

            SetTracer(tracer: OETracerBase, owntracer: bool) -> bool

      Registers the tracer, ``tracer``, to report the current progress
      of the :ref:`oemolistream <OEChem_oemolistream>` object on reading molecules.
      The second optional argument is used to indicate whether the
      :ref:`oemolistream <OEChem_oemolistream>` now owns the given
      :ref:`OETracerBase <OESystem_OETracerBase>` object and is therefore responsible for
      closing and destroying it when it itself is closed and/or
      destroyed.

      .. warning::

         Only in C++ can an :ref:`oemolistream <OEChem_oemolistream>` object own an existing
         :ref:`OETracerBase <OESystem_OETracerBase>` object.

      .. seealso::

         * :ref:`OETracerBase <OESystem_OETracerBase>`

   .. oe:method:: Setgz

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Setgz(bool gz, OEPlatform::oeistream* sptr = 0,
                       bool owned = false)

      .. oe:language:: python

         .. oe:api:: python

            Setgz(gz: bool, sptr: oeistream = None, owned: bool = False) -> bool

      Specifies that the contents of the
      :ref:`oemolistream <OEChem_oemolistream>` object are to be treated as compressed
      by GNU gzip compressed.  The decompression takes place on-the-fly.
      Usually the 'gz' property of a :ref:`oemolistream <OEChem_oemolistream>`
      object is determined implicitly from the file extension used to
      open the stream for reading.
      The current 'gz' property of the :ref:`oemolistream <OEChem_oemolistream>`
      object can be retrieved using the
      :oe:meth:`OEChem::oemolstreambase::Getgz` method.

   .. oe:method:: close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void close()

      .. oe:language:: python

         .. oe:api:: python

            close() -> None

      Closes the :ref:`oemolistream <OEChem_oemolistream>` object.
      This method may be safely called multiple times.
      However :oe:meth:`OEChem::oemolistream::close` method is called
      from within the :ref:`oemolistream <OEChem_oemolistream>` destructor and
      therefore it is not necessary to call this explicitly under most
      circumstances.

   .. oe:method:: eof

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool eof() const

      .. oe:language:: python

         .. oe:api:: python

            eof() -> bool

   .. oe:method:: getbyte

      .. oe:language:: c++ java csharp

         .. oe:api::

            int getbyte()

      .. oe:language:: python

         .. oe:api:: python

            getbyte() -> int

   .. oe:method:: getline

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool getline(char* buffer, oesize_t max)

      .. oe:language:: python

         .. oe:api:: python

            getline(buffer: str, max: oesize_t) -> bool

   .. oe:language:: c++ python

      .. oe:method:: openstring

         .. oe:api:: c++ python

            bool openstring(const std::string& str)
            bool openstring(const unsigned char* buffer, oesize_t len)

         Allows the :ref:`oemolistream <OEChem_oemolistream>` to read from a buffer in
         memory, instead of from a file or standard input.

         Internally, the :oe:meth:`OEChem::oemolistream::openstring`
         method make a copy of the specified file contents, allowing the
         :ref:`oemolistream <OEChem_oemolistream>` to continue to function
         independently of whether the original buffer is later modified
         or deallocated.

         .. note::
            Prior to calling :oe:meth:`OEChem::oemolistream::openstring` it
            is necessary to specify the format and whether or not the format is
            compressed with gzip.  These can be set with the
            :oe:meth:`OEChem::oemolistream::SetFormat` and
            :oe:meth:`OEChem::oemolistream::Setgz` methods respectively.

   .. oe:language:: java

      .. oe:method:: openByteArray

         .. oe:api:: java

            boolean openByteArray(byte[] byteArray)
            boolean openByteArray(char* byteArray, unsigned int len)

         Allows the :ref:`oemolistream <OEChem_oemolistream>` to read from a buffer in
         memory, instead of from a file or standard input.

         Internally, the :oe:meth:`OEChem::oemolistream::openByteArray`
         method make a copy of the specified file contents, allowing the
         :ref:`oemolistream <OEChem_oemolistream>` to continue to function
         independently of whether the original buffer is later modified
         or deallocated.

         .. note::
            Prior to calling :oe:meth:`OEChem::oemolistream::openByteArray` it
            is necessary to specify the format and whether or not the format is
            compressed with gzip.  These can be set with the
            :oe:meth:`OEChem::oemolistream::SetFormat` and
            :oe:meth:`OEChem::oemolistream::Setgz` methods respectively.

   .. oe:language:: csharp

      .. oe:method:: OpenByteArray

         .. oe:api:: csharp

            boolean OpenByteArray(byte[] buffer)
            boolean OpenByteArray(byte[] buffer, uint len)

         Allows the :ref:`oemolistream <OEChem_oemolistream>` to read from a buffer in
         memory, instead of from a file or standard input.

         Internally, the :oe:meth:`OEChem::oemolistream::OpenByteArray`
         method make a copy of the specified file contents, allowing the
         :ref:`oemolistream <OEChem_oemolistream>` to continue to function
         independently of whether the original buffer is later modified
         or deallocated.

         .. note::
            Prior to calling :oe:meth:`OEChem::oemolistream::OpenByteArray` it
            is necessary to specify the format and whether or not the format is
            compressed with gzip.  These can be set with the
            :oe:meth:`OEChem::oemolistream::SetFormat` and
            :oe:meth:`OEChem::oemolistream::Setgz` methods respectively.

   .. oe:method:: peekbyte

      .. oe:language:: c++ java csharp

         .. oe:api::

            int peekbyte()

      .. oe:language:: python

         .. oe:api:: python

            peekbyte() -> int

   .. oe:method:: read

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool read(unsigned char* buffer, oesize_t len)

      .. oe:language:: python

         .. oe:api:: python

            read(buffer: str, len: oesize_t) -> bool

   .. oe:method:: rewind

      .. oe:language:: c++ java csharp

         .. oe:api::

            void rewind()

      .. oe:language:: python

         .. oe:api:: python

            rewind() -> None

   .. oe:method:: seek

      .. oe:language:: c++ java csharp

         .. oe:api::

            void seek(oefpos_t pos)

      .. oe:language:: python

         .. oe:api:: python

            seek(pos: oefpos_t) -> None

      Moves the position of the next valid read to the position indicated.
      This function takes account of gzip streams and molecule caching.

   .. oe:method:: size

      .. oe:language:: c++ java csharp

         .. oe:api::

            oefpos_t size()

      .. oe:language:: python

         .. oe:api:: python

            size() -> oefpos_t

      Returns the size of the input stream if applicable to the current stream.
      The return type is a portable file-system pointer type.

   .. oe:method:: skip

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool skip(oefpos_t len)

      .. oe:language:: python

         .. oe:api:: python

            skip(len: oefpos_t) -> bool

   .. oe:method:: skipbyte

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool skipbyte()

      .. oe:language:: python

         .. oe:api:: python

            skipbyte() -> bool

   .. oe:method:: skipline

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool skipline()

      .. oe:language:: python

         .. oe:api:: python

            skipline() -> bool

   .. oe:method:: tell

      .. oe:language:: c++ java csharp

         .. oe:api::

            oefpos_t tell()

      .. oe:language:: python

         .. oe:api:: python

            tell() -> oefpos_t

      Returns the current position of the next read.
      This function accounts for molecular caching.

      .. note::

         If you are reading an :file:`.oeb` file that was written as
         multi-conformer molecules and is being read with single conformer
         molecules, all of the conformers are read into cache at once,
         and the pointer will point to the beginning of a multi-conformer
         molecule rather than to a conformer inside a molecule.


.. oe:namespace:: OEChem

.. meta::
   :keywords: oemolithread, molithread

.. _OEChem_oemolithread:

.. oe:class:: oemolithread

   .. oe:api::

      class oemolithread : public oemolthreadbase

   The following methods are publicly inherited from :ref:`oemolthreadbase <OEChem_oemolthreadbase>`:

   ================================================================ =============================================================== ===============================================================
   :oe:meth:`operator bool<OEChem::oemolthreadbase::operator bool>` :oe:meth:`GetMol<OEChem::oemolthreadbase::GetMol>`              :oe:meth:`PutMol<OEChem::oemolthreadbase::PutMol>`             
   ================================================================ =============================================================== ===============================================================

   The following methods are publicly inherited from :ref:`oemolstreambase <OEChem_oemolstreambase>`:

   ========================================================================== ========================================================================= =========================================================================
   :oe:meth:`ClearCSVHeader<OEChem::oemolstreambase::ClearCSVHeader>`         :oe:meth:`GetFlavor<OEChem::oemolstreambase::GetFlavor>`                  :oe:meth:`SetFormat<OEChem::oemolstreambase::SetFormat>`                 
   :oe:meth:`GetBinaryIOHandler<OEChem::oemolstreambase::GetBinaryIOHandler>` :oe:meth:`GetFormat<OEChem::oemolstreambase::GetFormat>`                  :oe:meth:`close<OEChem::oemolstreambase::close>`                         
   :oe:meth:`GetCSVHeader<OEChem::oemolstreambase::GetCSVHeader>`             :oe:meth:`Getgz<OEChem::oemolstreambase::Getgz>`                          :oe:meth:`open<OEChem::oemolstreambase::open>`                           
   :oe:meth:`GetFileName<OEChem::oemolstreambase::GetFileName>`               :oe:meth:`SetFlavor<OEChem::oemolstreambase::SetFlavor>`                                                                                           
   ========================================================================== ========================================================================= =========================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oemolithread()
            explicit oemolithread(const char* fn)
            explicit oemolithread(const std::string& fn)

      .. oe:language:: python

         .. oe:api:: python

            oemolithread() -> oemolithread
            oemolithread(fn: str) -> oemolithread

      Default and copy constructors.

   .. oe:method:: GetIStream

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPlatform::oeistream* GetIStream()

      .. oe:language:: python

         .. oe:api:: python

            GetIStream() -> oeistream

   .. oe:method:: GetMolStream

      .. oe:language:: c++ java csharp

         .. oe:api::

            oemolistream* GetMolStream()

      .. oe:language:: python

         .. oe:api:: python

            GetMolStream() -> oemolistream

   .. oe:method:: SetFlavor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFlavor(unsigned int format, unsigned int flavor)

      .. oe:language:: python

         .. oe:api:: python

            SetFlavor(format: int, flavor: int) -> bool

   .. oe:method:: SetFormat

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFormat(unsigned int format)

      .. oe:language:: python

         .. oe:api:: python

            SetFormat(format: int) -> bool

   .. oe:method:: close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void close()

      .. oe:language:: python

         .. oe:api:: python

            close() -> None

   .. oe:method:: openstring

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool openstring(const std::string& str, bool gz = false)
            bool openstring(const unsigned char* buffer, oesize_t len,
                            bool gz = false)

      .. oe:language:: python

         .. oe:api:: python

            openstring(data: bytes, gz: bool = False) -> bool
            openstring(buffer: str, len: oesize_t, gz: bool = False) -> bool



.. oe:namespace:: OEChem

.. meta::
   :keywords: oemolostream, molostream

.. _OEChem_oemolostream:

.. oe:class:: oemolostream

   .. oe:api::

      class oemolostream : public oemolstreambase

   The :ref:`oemolostream <OEChem_oemolostream>` class provides a stream-like
   abstraction for writing molecules to files, streams or standard
   output.
   The :ref:`oemolostream <OEChem_oemolostream>` maintains the format and flavor
   of the writer used when writing molecules.
   The :ref:`oemolostream <OEChem_oemolostream>` is capable of
   compressing gzip files while writing.

   The following methods are publicly inherited from :ref:`oemolstreambase <OEChem_oemolstreambase>`:

   ========================================================================== ========================================================================= =========================================================================
   :oe:meth:`ClearCSVHeader<OEChem::oemolstreambase::ClearCSVHeader>`         :oe:meth:`GetFlavor<OEChem::oemolstreambase::GetFlavor>`                  :oe:meth:`SetFormat<OEChem::oemolstreambase::SetFormat>`
   :oe:meth:`GetBinaryIOHandler<OEChem::oemolstreambase::GetBinaryIOHandler>` :oe:meth:`GetFormat<OEChem::oemolstreambase::GetFormat>`                  :oe:meth:`close<OEChem::oemolstreambase::close>`
   :oe:meth:`GetCSVHeader<OEChem::oemolstreambase::GetCSVHeader>`             :oe:meth:`Getgz<OEChem::oemolstreambase::Getgz>`                          :oe:meth:`open<OEChem::oemolstreambase::open>`
   :oe:meth:`GetFileName<OEChem::oemolstreambase::GetFileName>`               :oe:meth:`SetFlavor<OEChem::oemolstreambase::SetFlavor>`
   ========================================================================== ========================================================================= =========================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oemolostream()

      .. oe:language:: python

         .. oe:api:: python

            oemolostream() -> oemolostream

      Creates a new :ref:`oemolostream <OEChem_oemolostream>` object
      that is connected to standard output.

      .. oe:language:: c++ java csharp

         .. oe:api::

            explicit oemolostream(const char* fname)
            explicit oemolostream(const std::string& fname)

      .. oe:language:: python

         .. oe:api:: python

            oemolostream(name: str) -> oemolostream
            oemolostream(fn: str) -> oemolostream

      Creates a new :ref:`oemolostream <OEChem_oemolostream>` object and opens
      the file specified by the given name ('fname').

      .. oe:language:: c++ java csharp

         .. oe:api::

            explicit oemolostream(OEPlatform::oeostream *, bool owned = true)

      .. oe:language:: python

         .. oe:api:: python

            oemolostream(arg2: oeostream, owned: bool = True) -> oemolostream

      Creates a new :ref:`oemolostream <OEChem_oemolostream>` object from the
      existing :ref:`oeostream <OEPlatform_oeostream>` object.
      The second optional argument is used to indicate whether the new
      :ref:`oemolostream <OEChem_oemolostream>` now owns the given
      :ref:`oeostream <OEPlatform_oeostream>` and is therefore responsible for
      closing and destroying it when it itself is closed and/or
      destroyed.

      .. warning::

         Only in C++ can an :ref:`oemolostream <OEChem_oemolostream>` object own an existing
         :ref:`oeostream <OEPlatform_oeostream>` object.

      .. oe:language:: python

         .. admonition:: Usage in Python

            .. code-block:: console

               i = oechem.oeostream()
               owned = True
               ofs = oechem.oemolostream(i, not owned)

      .. seealso::

         To associate a file or a stream with an
         :ref:`oemolostream <OEChem_oemolostream>` after it has been created, see the
         :oe:meth:`OEChem::oemolstreambase::open` method.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

   .. oe:method:: operator OEPlatform::oeostream &
      :language: c++

      .. oe:api::

         operator OEPlatform::oeostream &() const

   .. oe:language:: c++ python

      .. oe:method:: GetString

         .. oe:api:: c++ python

            std::string GetString(void)

         Returns the contents of the in-memory buffer associated with the
         :ref:`oemolostream <OEChem_oemolostream>` object.
         The :ref:`oemolostream <OEChem_oemolostream>` object must previously have
         been opened for writing to an in-memory buffer using the
         :oe:meth:`OEChem::oemolostream::openstring` method.

   .. oe:language:: java

      .. oe:method:: getByteArray

         .. oe:api:: java

            byte[] getByteArray()

         Returns the contents of the in-memory buffer associated with the
         :ref:`oemolostream <OEChem_oemolostream>` object.
         The :ref:`oemolostream <OEChem_oemolostream>` object must previously have
         been opened for writing to an in-memory buffer using the
         :oe:meth:`OEChem::oemolostream::openstring` method.

   .. oe:language:: csharp

      .. oe:method:: GetByteArray

         .. oe:api:: csharp

            byte[] GetByteArray()

         Returns the contents of the in-memory buffer associated with the
         :ref:`oemolostream <OEChem_oemolostream>` object.
         The :ref:`oemolostream <OEChem_oemolostream>` object must previously have
         been opened for writing to an in-memory buffer using the
         :oe:meth:`OEChem::oemolostream::openstring` method.

   .. oe:method:: SetFlavor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFlavor(unsigned int format, unsigned int flavor)

      .. oe:language:: python

         .. oe:api:: python

            SetFlavor(format: int, flavor: int) -> bool

      Sets the file flavor for a given format associated with the
      :ref:`oemolostream <OEChem_oemolostream>` object.
      The set of valid formats are defined int the
      :ref:`the OEFormat namespace <OEChem_OEFormat>`.
      The set of valid bitmasks flavors are defined in the
      :oe:constns:`OEChem::OEOFlavor` namespace.
      The current flavor can be queried using the
      :oe:meth:`OEChem::oemolstreambase::GetFlavor` method.
      Each format has its own specific flavor which must be set
      separately.
      The :ref:`oemolostream <OEChem_oemolostream>` constructors
      calls the :oe:func:`OEChem::OESetDefaultFlavors` function
      to set the flavors for all of the formats to their default state.

   .. oe:method:: SetFormat

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFormat(unsigned int format)

      .. oe:language:: python

         .. oe:api:: python

            SetFormat(format: int) -> bool

      Sets the file format associated with the
      :ref:`oemolostream <OEChem_oemolostream>` object.
      The set of valid formats are defined in the
      :ref:`the OEFormat namespace <OEChem_OEFormat>`.
      By default, when writing to standard output, the associated
      file format is :oe:const:`OEChem::OEFormat::SMI`.
      The file format property of an :ref:`oemolistream <OEChem_oemolistream>`
      may be retrieved using the
      :oe:meth:`OEChem::oemolstreambase::GetFormat` method.

      .. note::

         The file format property is also set automatically by
         :oe:meth:`OEChem::oemolstreambase::open` based upon the file
         extension of the specified filename.

   .. oe:method:: SetString

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetString(const char* c)
            void SetString(const unsigned char* c, oesize_t size)

      .. oe:language:: python

         .. oe:api:: python

            SetString(c: str) -> None
            SetString(c: str, size: oesize_t) -> None

      Allows the :ref:`oemolostream <OEChem_oemolostream>` to be opened for
      writing to a buffer and specify the initial contents of the
      buffer.

      .. oe:language:: c++ python

         The contents of in-memory buffer when writing to a string may be
         obtained using the :oe:meth:`OEChem::oemolostream::GetString`
         method.

      .. oe:language:: java

         The contents of in-memory buffer when writing to a string may be
         obtained using the :oe:meth:`OEChem::oemolostream::getByteArray`
         method.

      .. oe:language:: csharp

         The contents of in-memory buffer when writing to a string may be
         obtained using the :oe:meth:`OEChem::oemolostream::GetByteArray`
         method.

   .. oe:method:: Setgz

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Setgz(bool gz, OEPlatform::oeostream* sptr = 0, bool = false)

      .. oe:language:: python

         .. oe:api:: python

            Setgz(gz: bool, sptr: oeostream = None, arg4: bool = False) -> bool

      Specifies that the contents of the
      :ref:`oemolostream <OEChem_oemolostream>` object should be GNU gzip
      compressed
      The compression takes place on-the-fly.
      Usually the 'gz' property of a :ref:`oemolostream <OEChem_oemolostream>`
      object is determined implicitly from the file extension used to
      open the stream for writing.
      The current 'gz' property of the :ref:`oemolostream <OEChem_oemolostream>`
      object can be retrieved using the
      :oe:meth:`OEChem::oemolstreambase::Getgz` method.

   .. oe:method:: close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void close()

      .. oe:language:: python

         .. oe:api:: python

            close() -> None

      Closes the :ref:`oemolostream <OEChem_oemolostream>` object.
      This method may be safely called multiple times.

   .. oe:method:: flush

      .. oe:language:: c++ java csharp

         .. oe:api::

            oemolostream& flush()

      .. oe:language:: python

         .. oe:api:: python

            flush() -> oemolostream

   .. oe:method:: openstring

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool openstring()
            bool openstring(bool gzip)

      .. oe:language:: python

         .. oe:api:: python

            openstring() -> bool
            openstring(gzip: bool) -> bool

      Allows the :ref:`oemolostream <OEChem_oemolostream>` to write to a buffer in
      memory, instead of to a file or standard output.

      .. oe:language:: c++ python

         Calling :oe:meth:`OEChem::oemolostream::openstring` instructs the
         :ref:`oemolostream <OEChem_oemolostream>` object to start accumulating
         output in a buffer, which can later be retrieved by calling the
         :oe:meth:`OEChem::oemolostream::GetString` method.

      .. oe:language:: java

         Calling :oe:meth:`OEChem::oemolostream::openstring` instructs the
         :ref:`oemolostream <OEChem_oemolostream>` object to start accumulating
         output in a buffer, which can later be retrieved by calling the
         :oe:meth:`OEChem::oemolostream::getByteArray` method.

      .. oe:language:: csharp

         Calling :oe:meth:`OEChem::oemolostream::openstring` instructs the
         :ref:`oemolostream <OEChem_oemolostream>` object to start accumulating
         output in a buffer, which can later be retrieved by calling the
         :oe:meth:`OEChem::oemolostream::GetByteArray` method.

      The form that accepts a 'gzip' argument can be used to instruct
      the :ref:`oemolostream <OEChem_oemolostream>` object to compress the contents
      of the in-memory buffer.

   .. oe:method:: put

      .. oe:language:: c++ java csharp

         .. oe:api::

            oemolostream& put(char c)

      .. oe:language:: python

         .. oe:api:: python

            put(c: str) -> oemolostream

   .. oe:method:: tell

      .. oe:language:: c++ java csharp

         .. oe:api::

            oefpos_t tell()

      .. oe:language:: python

         .. oe:api:: python

            tell() -> oefpos_t

   .. oe:method:: write

      .. oe:language:: c++ java csharp

         .. oe:api::

            oemolostream& write(const char* str, oesize_t size)

      .. oe:language:: python

         .. oe:api:: python

            write(str: str, size: oesize_t) -> oemolostream



.. oe:namespace:: OEChem

.. meta::
   :keywords: oemolothread, molothread

.. _OEChem_oemolothread:

.. oe:class:: oemolothread

   .. oe:api::

      class oemolothread : public oemolthreadbase

   The following methods are publicly inherited from :ref:`oemolthreadbase <OEChem_oemolthreadbase>`:

   ================================================================ =============================================================== ===============================================================
   :oe:meth:`operator bool<OEChem::oemolthreadbase::operator bool>` :oe:meth:`GetMol<OEChem::oemolthreadbase::GetMol>`              :oe:meth:`PutMol<OEChem::oemolthreadbase::PutMol>`             
   ================================================================ =============================================================== ===============================================================

   The following methods are publicly inherited from :ref:`oemolstreambase <OEChem_oemolstreambase>`:

   ========================================================================== ========================================================================= =========================================================================
   :oe:meth:`ClearCSVHeader<OEChem::oemolstreambase::ClearCSVHeader>`         :oe:meth:`GetFlavor<OEChem::oemolstreambase::GetFlavor>`                  :oe:meth:`SetFormat<OEChem::oemolstreambase::SetFormat>`                 
   :oe:meth:`GetBinaryIOHandler<OEChem::oemolstreambase::GetBinaryIOHandler>` :oe:meth:`GetFormat<OEChem::oemolstreambase::GetFormat>`                  :oe:meth:`close<OEChem::oemolstreambase::close>`                         
   :oe:meth:`GetCSVHeader<OEChem::oemolstreambase::GetCSVHeader>`             :oe:meth:`Getgz<OEChem::oemolstreambase::Getgz>`                          :oe:meth:`open<OEChem::oemolstreambase::open>`                           
   :oe:meth:`GetFileName<OEChem::oemolstreambase::GetFileName>`               :oe:meth:`SetFlavor<OEChem::oemolstreambase::SetFlavor>`                                                                                           
   ========================================================================== ========================================================================= =========================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oemolothread()
            explicit oemolothread(const char* fn)
            explicit oemolothread(const std::string& fn)

      .. oe:language:: python

         .. oe:api:: python

            oemolothread() -> oemolothread
            oemolothread(fn: str) -> oemolothread

      Default and copy constructors.

   .. oe:method:: GetMolStream

      .. oe:language:: c++ java csharp

         .. oe:api::

            oemolostream* GetMolStream()

      .. oe:language:: python

         .. oe:api:: python

            GetMolStream() -> oemolostream

   .. oe:method:: GetOStream

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPlatform::oeostream* GetOStream()

      .. oe:language:: python

         .. oe:api:: python

            GetOStream() -> oeostream

   .. oe:method:: GetString

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetString()

      .. oe:language:: python

         .. oe:api:: python

            GetString() -> bytes

   .. oe:method:: SetFlavor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFlavor(unsigned int format, unsigned int flavor)

      .. oe:language:: python

         .. oe:api:: python

            SetFlavor(format: int, flavor: int) -> bool

   .. oe:method:: SetFormat

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFormat(unsigned int format)

      .. oe:language:: python

         .. oe:api:: python

            SetFormat(format: int) -> bool

   .. oe:method:: close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void close()

      .. oe:language:: python

         .. oe:api:: python

            close() -> None

   .. oe:method:: openstring

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool openstring(bool gz = false)

      .. oe:language:: python

         .. oe:api:: python

            openstring(gz: bool = False) -> bool



.. oe:namespace:: OEChem

.. meta::
   :keywords: oemolstreambase, molstreambase

.. _OEChem_oemolstreambase:

.. oe:class:: oemolstreambase

   .. oe:api::

      class oemolstreambase

   The :ref:`oemolstreambase <OEChem_oemolstreambase>` is the abstract base class for
   reading and writing molecules.

   The following classes derive from this class:
    * :ref:`oemolistream <OEChem_oemolistream>`
    * :ref:`oemolithread <OEChem_oemolithread>`
    * :ref:`oemolostream <OEChem_oemolostream>`
    * :ref:`oemolothread <OEChem_oemolothread>`
    * :ref:`oemolthreadbase <OEChem_oemolthreadbase>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         oemolstreambase & operator=(const oemolstreambase & rhs)

      Assignment operator.

   .. oe:method:: ClearCSVHeader

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearCSVHeader()

      .. oe:language:: python

         .. oe:api:: python

            ClearCSVHeader() -> None

      Clears out the :ref:`OECSVHeader <OEChem_OECSVHeader>` object owned by this
      stream allowing an alternative set of column names to be
      initialized.

   .. oe:method:: GetBinaryIOHandler

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryIOHandlerBase& GetBinaryIOHandler() const

      .. oe:language:: python

         .. oe:api:: python

            GetBinaryIOHandler() -> OEBinaryIOHandlerBase

   .. oe:method:: GetCSVHeader

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECSVHeader& GetCSVHeader()

      .. oe:language:: python

         .. oe:api:: python

            GetCSVHeader() -> OECSVHeader

      Returns a reference to the :ref:`OECSVHeader <OEChem_OECSVHeader>` object
      owned by this stream. The first molecule read or written to this
      stream will initialize the :ref:`OECSVHeader <OEChem_OECSVHeader>` object
      to the set of SD data tags and the order in which to read or
      write them.

   .. oe:method:: GetFileName

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetFileName() const

      .. oe:language:: python

         .. oe:api:: python

            GetFileName() -> str

      Returns the file name used in the previous call to
      :oe:meth:`OEChem::oemolstreambase::open`. An empty string is
      returned if :oe:meth:`OEChem::oemolstreambase::open` has not been
      called yet or :oe:meth:`OEChem::oemolstreambase::close` has been
      called.

   .. oe:method:: GetFlavor

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFlavor(unsigned int format)

      .. oe:language:: python

         .. oe:api:: python

            GetFlavor(format: int) -> int

      Returns the file flavor associated with the format for the
      :ref:`oemolstreambase <OEChem_oemolstreambase>` object.
      The set of valid formats are defined in the
      :ref:`the OEFormat namespace <OEChem_OEFormat>`.
      The set of valid bitmasks flavors of input streams are defined in the
      :oe:constns:`OEChem::OEIFlavor` namespace.
      The set of valid bitmasks flavors of output streams are defined in the
      :oe:constns:`OEChem::OEOFlavor` namespace.

      The flavor for any format can be set using the
      :oe:meth:`OEChem::oemolstreambase::SetFlavor` method.
      The default flavors are automatically set by the
      :ref:`oemolstreambase <OEChem_oemolstreambase>` constructors.

   .. oe:method:: GetFormat

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFormat() const

      .. oe:language:: python

         .. oe:api:: python

            GetFormat() -> int

      Returns the file format associated with the output
      :ref:`oemolstreambase <OEChem_oemolstreambase>` object.
      The set of valid formats are defined in the
      :ref:`the OEFormat namespace <OEChem_OEFormat>`.

      By default, when writing to standard output or when reading from
      standard input the associated file format is
      :oe:const:`OEChem::OEFormat::SMI`.

      The file format property can be set using the
      :oe:meth:`OEChem::oemolstreambase::SetFormat` method.

      .. note::

         The file format property is also set automatically by
         :oe:meth:`OEChem::oemolstreambase::open` based upon the file
         extension of the specified filename.

   .. oe:method:: Getgz

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Getgz()

      .. oe:language:: python

         .. oe:api:: python

            Getgz() -> bool

      Returns whether the stream is writing to or reading from a gzip
      compressed :ref:`oemolstreambase <OEChem_oemolstreambase>`.

   .. oe:method:: SetFlavor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFlavor(unsigned int format, unsigned int flavor)=0

      .. oe:language:: python

         .. oe:api:: python

            SetFlavor(format: int, flavor: int) -> bool

      This pure virtual method is designed to set the flavor for a given format
      associated with an input/output molstream.

      .. seealso::

         * :oe:meth:`OEChem::oemolistream::SetFlavor`
         * :oe:meth:`OEChem::oemolithread::SetFlavor`
         * :oe:meth:`OEChem::oemolostream::SetFlavor`
         * :oe:meth:`OEChem::oemolothread::SetFlavor`

   .. oe:method:: SetFormat

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFormat(unsigned int format)=0

      .. oe:language:: python

         .. oe:api:: python

            SetFormat(format: int) -> bool

      This pure virtual method is designed to set the format
      associated with an input/output molstream.

      .. seealso::

         * :oe:meth:`OEChem::oemolistream::SetFormat`
         * :oe:meth:`OEChem::oemolithread::SetFormat`
         * :oe:meth:`OEChem::oemolostream::SetFormat`
         * :oe:meth:`OEChem::oemolothread::SetFormat`

      .. note::

         Setting the molstream format to .gz or .oez when it was previously a different (or default) 
         format re-initializes the OEB handlers in the molstream. This means, any explicit changes 
         to the OEB handlers for the stream should be made after setting the format.

   .. oe:method:: close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void close()

      .. oe:language:: python

         .. oe:api:: python

            close() -> None

      This method clears the :ref:`OECSVHeader <OEChem_OECSVHeader>` object owned
      by this stream, and resets the file name returned by
      :oe:meth:`OEChem::oemolstreambase::GetFileName` back to an empty
      string. It is expected that the user will not need to call this
      method directly, but rely on the following subclass methods to
      call this function:

      * :oe:meth:`OEChem::oemolistream::close`
      * :oe:meth:`OEChem::oemolithread::close`
      * :oe:meth:`OEChem::oemolostream::close`
      * :oe:meth:`OEChem::oemolothread::close`

   .. oe:method:: open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool open()

      .. oe:language:: python

         .. oe:api:: python

            open() -> bool

      The input molstreams (:ref:`oemolistream <OEChem_oemolistream>`,
      :ref:`oemolithread <OEChem_oemolithread>`) read from to standard input.
      The output molstreams (:ref:`oemolostream <OEChem_oemolostream>`,
      :ref:`oemolothread <OEChem_oemolothread>`) write to standard input.
      The default file format for both input and output molstreams are
      :oe:const:`OEChem::OEFormat::SMI`.
      Calling :oe:meth:`OEChem::oemolstreambase::open` (no arguments)
      on input or output molstreams will force the stream format to
      the default :oe:const:`OEChem::OEFormat::SMI` and the
      gzip compression property to false.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool open(const char* fname)
            bool open(const std::string& fname)

      .. oe:language:: python

         .. oe:api:: python

            open(name: str) -> bool

      In case of an **input molstream** (:ref:`oemolistream <OEChem_oemolistream>`,
      :ref:`oemolithread <OEChem_oemolithread>`), this method opens a file ,
      specified by its filename ('fname') for reading.
      The file format property of the input molstream is set based
      upon the extension of the given filename.
      If the file extension isn't recognized, a warning is issued and
      the existing file format is unchanged.
      If the filename is appended with :file:`.gz`, the input
      molstream will decompress the file on-the-fly when reading.
      If only a file extension is used as the filename
      (:file:`.oeb.gz`), then the standard input is opened with the
      format specified by the given extensions.

      In case of an **output molstream**
      (:ref:`oemolostream <OEChem_oemolostream>`, :ref:`oemolothread <OEChem_oemolothread>`),
      this method creates (or overwrite) a file , specified by its
      filename ('fname') for writing.
      The file format property of the output molstream is set based
      upon the extension of the given filename.
      If the filename is appended with :file:`.gz`, the output
      molstream will compress the file on-the-fly when writing.
      If the file extension isn't recognized, a warning is issued and
      the existing file format is unchanged.
      If only a file extension is used as the filename
      (:file:`.oeb.gz`), then the standard output is opened with the
      format specified by the given extensions.

      In case of both **input** and **output molstream**, the filename based
      file format may be overridden by calling
      :oe:meth:`OEChem::oemolstreambase::SetFormat` explicitly with
      the desired file format.



.. oe:namespace:: OEChem

.. meta::
   :keywords: oemolthreadbase, molthreadbase

.. _OEChem_oemolthreadbase:

.. oe:class:: oemolthreadbase

   .. seealso::

      The :ref:`section_inputandoutputthreads` section. 

   .. warning::

      The interface provided here is for advanced users. Most users
      should be able to accomplish their goals through the high-level
      :oe:func:`OEChem::OEReadMolecule` and
      :oe:func:`OEChem::OEWriteMolecule` functions.

   .. oe:api::

      class oemolthreadbase : public oemolstreambase

   The following methods are publicly inherited from :ref:`oemolstreambase <OEChem_oemolstreambase>`:

   ========================================================================== ========================================================================= =========================================================================
   :oe:meth:`ClearCSVHeader<OEChem::oemolstreambase::ClearCSVHeader>`         :oe:meth:`GetFlavor<OEChem::oemolstreambase::GetFlavor>`                  :oe:meth:`SetFormat<OEChem::oemolstreambase::SetFormat>`                 
   :oe:meth:`GetBinaryIOHandler<OEChem::oemolstreambase::GetBinaryIOHandler>` :oe:meth:`GetFormat<OEChem::oemolstreambase::GetFormat>`                  :oe:meth:`close<OEChem::oemolstreambase::close>`                         
   :oe:meth:`GetCSVHeader<OEChem::oemolstreambase::GetCSVHeader>`             :oe:meth:`Getgz<OEChem::oemolstreambase::Getgz>`                          :oe:meth:`open<OEChem::oemolstreambase::open>`                           
   :oe:meth:`GetFileName<OEChem::oemolstreambase::GetFileName>`               :oe:meth:`SetFlavor<OEChem::oemolstreambase::SetFlavor>`                                                                                           
   ========================================================================== ========================================================================= =========================================================================

   The following classes derive from this class:
    * :ref:`oemolithread <OEChem_oemolithread>`
    * :ref:`oemolothread <OEChem_oemolothread>`
   

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

   .. oe:method:: GetMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string* GetMol()

      .. oe:language:: python

         .. oe:api:: python

            GetMol() -> bytes

      Retrieve the next molecule in the stream as a ``std::string``
      blocking if there are no molecules currently available. The
      method will return a zero-pointer (``NULL``) if there are no
      more molecules left to retrieve.

      The user is expected to call ``delete`` on the ``std::string``
      pointer returned from this method.

      .. note:: 

         This method was specifically designed to be thread safe so
         multiple threads can call this method on the same
         :ref:`oemolthreadbase <OEChem_oemolthreadbase>` object simultaneously.

   .. oe:method:: PeekMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string* PeekMol()

      .. oe:language:: python

         .. oe:api:: python

            PeekMol() -> bytes

      Return the next molecule ``std::string`` pointer that will be
      returned by :oe:meth:`OEChem::oemolthreadbase::GetMol` method. 

      .. note::
         
         If multiple threads are calling
         :oe:meth:`OEChem::oemolthreadbase::GetMol` and
         :oe:meth:`OEChem::oemolthreadbase::PeekMol` then it can not be
         guaranteed that the thread that called
         :oe:meth:`OEChem::oemolthreadbase::PeekMol` will get the same
         pointer when it later calls
         :oe:meth:`OEChem::oemolthreadbase::GetMol`.
      
   .. oe:method:: PutMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool PutMol(const std::string* data)

      .. oe:language:: python

         .. oe:api:: python

            PutMol(data: bytes) -> bool

      Place a molecule as a ``std::string`` into the stream blocking
      if the in-memory buffer is full.

      In the case of the :ref:`oemolothread <OEChem_oemolothread>` object the
      output thread will call ``delete`` on the pointer to free the
      memory. Passing a zero-pointer (``NULL``) will instruct the
      :ref:`oemolothread <OEChem_oemolothread>` output thread to shut down.

      .. note:: 

         This method was specifically designed to be thread safe so
         multiple threads can call this method on the same
         :ref:`oemolthreadbase <OEChem_oemolthreadbase>` object simultaneously.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEAminoAcidType

   .. attention::

      |PRELIMINARY-API|
   
   The :oe:constns:`OEChem::OEAminoAcidType` namespace encodes symbolic constants used as bit-masks to
   categorize amino-acids.

   A monomer such as `N-alpha-methyl-L-Alanine` (defined with ``[H:1]N(C)[C@@H](C)C(=O)[OH:2]``)
   belongs to both :oe:const:`OEChem::OEAminoAcidType::Alpha` and 
   :oe:const:`OEChem::OEAminoAcidType::AlphaMethylated` categories.

   The namespace contains the following constants:
   
   .. oe:constant:: Alpha

      Standard amino acid where the amino group attached to the alpha-carbon.

   .. oe:constant:: AlphaMethylated

      Amino acid where a methyl group is attached to alpha-carbon of its backbone.

   .. oe:constant: BackboneMask # ignore used inly internally

   .. oe:constant:: Beta

      Amino amino with amino group attached to the beta-carbon.

   .. oe:constant:: BetaMethylated

      Amino acid where a methyl group is attached to beta-carbon of its backbone.

   .. oe:constant:: Delta

      Standard amino acid where the amino group attached to the delta-carbon.

   .. oe:constant:: Gamma

      Standard amino acid where the amino group attached to the gamma-carbon.

   .. oe:constant: MethylatedMask  # ignore used inly internally

   .. oe:constant:: NMethylated

      Amino acid where a methyl group is attached to amino group of its backbone.

   .. oe:constant:: NotAminoAcid

      Indicates monomers that are not amino-acids.

   .. oe:constant:: Undefined

   .. seealso::

      * :oe:func:`OEChem::OEGetAminoAcidType` function
      * :oe:cls:`OEChem::OEHasAminoAcidType` functor
      * :oe:func:`OEChem::OEAminoAcidTypeToString` function



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEAroModel

   This namespace contains constants representing various supported
   aromaticity when calling the :oe:func:`OEChem::OEAssignAromaticFlags`
   function.

   .. seealso::

      * :ref:`section_aromaticity_models` section

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Daylight

      This constant represents the Daylight aromaticity model.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OpenEye

      This constant represents the default *OpenEye* aromaticity model.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Tripos

      This constant represents the Tripos aromaticity model.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MMFF

      This constant represents the MMFF aromaticity model.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MDL

      This constant represents the MDL aromaticity model.


.. oe:namespace:: OEChem

.. _OEChem_OEAtomColorScheme:

.. oe:constnamespace:: OEAtomColorScheme

   The OEAtomColorScheme namespace encodes symbolic constants utilized to 
   specify the color scheme of the atoms in an :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. 
   The constants can be used as an argument when constructing a 
   :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>`, which 
   can be used as an argument for the :oe:meth:`OEChem::OE3DMolStyle::SetAtomColorer` 
   function in :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`.

   This namespace contains constants.

   .. oe:constant:: AltLocation

   .. oe:constant:: Amino

      .. figure:: oechemtk/images/atomColor/amino.*
         :align:  center

   .. oe:constant:: BEGIN

   .. oe:constant:: BFactor

      .. figure:: oechemtk/images/atomColor/bfactor.*
         :align:  center

   .. oe:constant:: Chain

   .. oe:constant:: END

   .. oe:constant:: Element

      .. figure:: oechemtk/images/atomColor/element.*
         :align:  center

   .. oe:constant:: FormalCharge

      .. figure:: oechemtk/images/atomColor/formalcharge.*
         :align:  center

   .. oe:constant:: GenericData

   .. oe:constant:: Occupancy

   .. oe:constant:: PartialCharge

      .. figure:: oechemtk/images/atomColor/partialCharge.*
         :align:  center

   .. oe:constant:: ProteinSequence

      .. figure:: oechemtk/images/atomColor/proteinSeq.*
         :align:  center

   .. oe:constant:: Residue

      .. figure:: oechemtk/images/atomColor/residue.*
         :align:  center

   .. oe:constant:: ResidueHydrophobicity

      .. figure:: oechemtk/images/atomColor/residueHydrophobicity.*
         :align:  center

   .. oe:constant:: SecondaryStructure

      .. figure:: oechemtk/images/atomColor/secondaryStruct.*
         :align:  center

   .. oe:constant:: Shapely

   .. oe:constant:: Solid

      .. figure:: oechemtk/images/atomColor/solid.*
         :align:  center


.. oe:namespace:: OEChem

.. _OEChem_OEAtomLabelScheme:

.. oe:constnamespace:: OEAtomLabelScheme

   The OEAtomLabelScheme namespace encodes symbolic constants utilized to 
   specify the labeling scheme of the atoms in a :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. The constants 
   can be used as an argument for the :oe:meth:`OEChem::OE3DMolStyle::SetAtomLabelType` function in 
   :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. 

   This namespace contains constants.

   .. oe:constant:: AltLocation

   .. oe:constant:: BEGIN

   .. oe:constant:: BFactor

      .. figure:: oechemtk/images/atomLabel/bfactor.*
         :align:  center

   .. oe:constant:: Chirality

   .. oe:constant:: Degree

      .. figure:: oechemtk/images/atomLabel/degree.*
         :align:  center

   .. oe:constant:: END

   .. oe:constant:: Element

      .. figure:: oechemtk/images/atomLabel/element.*
         :align:  center

   .. oe:constant:: FormalCharge

      .. figure:: oechemtk/images/atomLabel/formalCharge.*
         :align:  center

   .. oe:constant:: GenericData

   .. oe:constant:: HasStereoSpecified

   .. oe:constant:: Hybridization

   .. oe:constant:: ImplicitHCount

      .. figure:: oechemtk/images/atomLabel/formalCharge.*
         :align:  center

   .. oe:constant:: Index

      .. figure:: oechemtk/images/atomLabel/index.*
         :align:  center

   .. oe:constant:: IntegerType

   .. oe:constant:: IsChiral

      .. figure:: oechemtk/images/atomLabel/isChiral.*
         :align:  center

   .. oe:constant:: IsInRing

      .. figure:: oechemtk/images/atomLabel/isInRing.*
         :align:  center

   .. oe:constant:: Isotope

   .. oe:constant:: MMFFType

   .. oe:constant:: MapIdx

   .. oe:constant:: OEChemIdx

   .. oe:constant:: Occupancy

      .. figure:: oechemtk/images/atomLabel/occupancy.*
         :align:  center

   .. oe:constant:: Off

      .. figure:: oechemtk/images/atomLabel/off.*
         :align:  center

   .. oe:constant:: PartialCharge

      .. figure:: oechemtk/images/atomLabel/partialCharge.*
         :align:  center

   .. oe:constant:: Radius

      .. figure:: oechemtk/images/atomLabel/radius.*
         :align:  center

   .. oe:constant:: ResidueInfo

      .. figure:: oechemtk/images/atomLabel/residue.*
         :align:  center

   .. oe:constant:: ResidueInfoCA

      .. figure:: oechemtk/images/atomLabel/residueCA.*
         :align:  center

   .. oe:constant:: Symmetry

   .. oe:constant:: Type

   .. oe:constant:: User



.. oe:namespace:: OEChem

.. _OEChem_OEAtomStereo:

.. oe:constnamespace:: OEAtomStereo

   .. seealso:: 

      * :term:`stereo atom`
      * :oe:meth:`OEChem::OEAtomBase::GetStereo` method
      * :oe:meth:`OEChem::OEAtomBase::SetStereo` method
      * :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` method

   This namespace contains the following constants:

   .. oe:constant:: All

      Represents all atom stereochemistry classes.

   .. oe:constant:: Left

      Atom stereochemistry value of the :oe:const:`OEChem::OEAtomStereo::Tetra` class.

   .. oe:constant:: LeftHanded

      Same as the :oe:const:`OEChem::OEAtomStereo::Left` constant.

   .. oe:constant:: Right

      Atom stereochemistry value of the :oe:const:`OEChem::OEAtomStereo::Tetra` class.

   .. oe:constant:: RightHanded

      Same as the :oe:const:`OEChem::OEAtomStereo::Right` constant.

   .. oe:constant:: Tetra

      Atom stereochemistry class.

      .. seealso::

         :oe:meth:`OEChem::OEAtomBase::SetStereo` function

   .. oe:constant:: Tetrahedral

      Same as the :oe:const:`OEChem::OEAtomStereo::Tetra` constant.

   .. oe:constant:: Undefined

      Represents undefined atom stereochemistry.


.. oe:namespace:: OEChem

.. _OEChem_OEAtomStyle:

.. oe:constnamespace:: OEAtomStyle

   The OEAtomStyle namespace encodes symbolic constants representing the 
   style of the atoms in an :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. The constants can be used as an 
   argument for the :oe:meth:`OEChem::OE3DMolStyle::SetAtomStyle` function in :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. 

   This namespace contains constants.

   .. oe:constant:: BEGIN

   .. oe:constant:: BallAndStick

      .. figure:: oechemtk/images/atomStyle/ballandstick.*
         :align:  center

   .. oe:constant:: CPK

      .. figure:: oechemtk/images/atomStyle/cpk.*
         :align:  center

   .. oe:constant:: END

   .. oe:constant:: Hidden

      .. figure:: oechemtk/images/atomStyle/hidden.*
         :align:  center

   .. oe:constant:: Stars

   .. oe:constant:: Stick

      .. figure:: oechemtk/images/atomStyle/stick.*
         :align:  center

   .. oe:constant:: Wireframe

      .. figure:: oechemtk/images/atomStyle/wire.*
         :align:  center


.. oe:namespace:: OEChem

.. _OEBaseColorScheme:

.. oe:constnamespace:: OEBaseColorScheme

   The OEBaseColorScheme namespace encodes symbolic constants representing the 
   base color scheme of the molecule associated with the :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`.

   This namespace contains constants.

   .. oe:constant:: BEGIN

   .. oe:constant:: END

   .. oe:constant:: GenericData

   .. oe:constant:: Solid



.. oe:namespace:: OEChem

..  _OEBondStereo:

.. oe:constnamespace:: OEBondStereo

   .. seealso:: 

      * :term:`stereo bond`
      * :oe:meth:`OEChem::OEBondBase::GetStereo` method
      * :oe:meth:`OEChem::OEBondBase::SetStereo` method
      * :oe:meth:`OEChem::OEBondBase::HasStereoSpecified` method

   This namespace contains the following constants:

   .. oe:constant:: All

      Represents all bond stereochemistry classes.

   .. oe:constant:: Cis

      Bond stereochemistry value of the :oe:const:`OEChem::OEBondStereo::CisTrans` class.

   .. oe:constant:: CisTrans

      Bond stereochemistry class.

      .. seealso::

         :oe:meth:`OEChem::OEBondBase::SetStereo` function

   .. oe:constant:: DoubleEither

      Bond stereochemistry value of the :oe:const:`OEChem::OEBondStereo::CisTrans` class.
      Represents double bonds with unspecified cis or trans configuration (bow tie).

   .. oe:constant:: Hash
   
      Bond type that can represent atom stereo information.

      .. seealso::

         :oe:func:`OEChem::OEMDLPerceiveBondStereo` function

   .. oe:constant:: Trans

      Bond stereochemistry value of the :oe:const:`OEChem::OEBondStereo::CisTrans` class.

   .. oe:constant:: Wavy 

      Bond type that can represent atom stereo information.

      .. seealso::

         :oe:func:`OEChem::OEMDLPerceiveBondStereo` function

   .. oe:constant:: Wedge

      Bond type that can represent atom stereo information.

      .. seealso::

         :oe:func:`OEChem::OEMDLPerceiveBondStereo` function

   .. oe:constant:: Undefined

      Represents undefined bond stereochemistry.


.. oe:namespace:: OEChem

.. oe:constnamespace:: OECIPAtomStereo

   The :oe:constns:`OEChem::OECIPAtomStereo` namespace encodes symbolic constants
   representing Cahn–Ingold–Prelog atom stereo descriptors.

   .. seealso:: 

      * :oe:func:`OEChem::OEPerceiveCIPStereo` function
      * :oe:func:`OEChem::OESetCIPStereo` function

   This namespace contains the following constants:

   .. oe:constant:: NotStereo

      Indicates atom that are not CIP stereo centers.

   .. oe:constant:: S

      Indicates **S** CIP atom stereo centers.

   .. oe:constant:: R

      Indicates **R** CIP atom stereo centers.

   .. oe:constant:: UnspecStereo

      Indicates atoms that are CIP stereo centers but without specific stereo information
      (*i.e.* :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` method returns ``false``)


.. oe:namespace:: OEChem

.. oe:constnamespace:: OECIPBondStereo

   The :oe:constns:`OEChem::OECIPAtomStereo` namespace encodes symbolic constants
   representing Cahn–Ingold–Prelog bond stereo descriptors.

   .. seealso:: 

      * :oe:func:`OEChem::OEPerceiveCIPStereo` function
      * :oe:func:`OEChem::OESetCIPStereo` function

   This namespace contains the following constants:

   .. oe:constant:: NotStereo

      Indicates bonds that are not CIP stereo centers.

   .. oe:constant:: E

      Indicates **E** CIP bond stereo centers.

   .. oe:constant:: Z

      Indicates **Z** CIP bond stereo centers.

   .. oe:constant:: UnspecStereo

      Indicates bonds that are CIP stereo centers but without specific stereo information
      (*i.e.* :oe:meth:`OEChem::OEBondBase::HasStereoSpecified` method returns ``false``)



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEChem

   This namespace contains the following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEAroModelDaylight

      **Deprecated**
      See :oe:const:`Daylight<OEChem::OEAroModel::Daylight>` aromaticity model.

      .. seealso::

         * :ref:`section_aromaticity_models` section
         * :oe:func:`OEChem::OEAssignAromaticFlags` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEAroModelOpenEye

      **Deprecated**
      See :oe:const:`OpenEye<OEChem::OEAroModel::OpenEye>` aromaticity model.

      .. seealso::

         * :ref:`section_aromaticity_models` section
         * :oe:func:`OEChem::OEAssignAromaticFlags` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEAroModelTripos

      **Deprecated**
      See :oe:const:`Tripos<OEChem::OEAroModel::Tripos>` aromaticity model.

      .. seealso::

         * :ref:`section_aromaticity_models` section
         * :oe:func:`OEChem::OEAssignAromaticFlags` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEAroModelMMFF

      **Deprecated**
      See :oe:const:`MMFF<OEChem::OEAroModel::MMFF>` aromaticity model. 

      .. seealso::

         * :ref:`section_aromaticity_models` section
         * :oe:func:`OEChem::OEAssignAromaticFlags` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEAroModelMDL

      **Deprecated**
      See :oe:const:`MDL<OEChem::OEAroModel::MDL>` aromaticity model.

      .. seealso::

         * :ref:`section_aromaticity_models` section
         * :oe:func:`OEChem::OEAssignAromaticFlags` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FzFalse

      This is a globally available :ref:`OEFuzzy <OEChem_OEFuzzy>` object that represents fuzzy false value.

   .. oe:constant:: FzTrue

      This is a globally available :ref:`OEFuzzy <OEChem_OEFuzzy>` object that represents fuzzy true value.

   .. oe:constant:: FzMaybe

      This is a globally available :ref:`OEFuzzy <OEChem_OEFuzzy>` object that represents fuzzy maybe value.



.. _OEChemConstants:

*******************************************************************************
OEChem Constants
*******************************************************************************

.. oe:namespace:: OEChem

.. toctree::

   OEChem
   OEChemConstants-preliminary
   OEAroModel
   OEAtomColorScheme
   OEAtomLabelScheme
   OEAtomStereo
   OEAtomStyle
   OEBaseColorScheme
   OEBondStereo
   OECIPAtomStereo
   OECIPBondStereo
   OEContourStyle
   OECoordsType
   OEElemNo
   OEExprOpts
   OEExprType
   OEFileStringType
   OEFileStringTypeFlavor
   OEFormat
   OEFuzzVal
   OEGroupType
   OEHybridization
   OEHydrogenVisibility
   OEIFlavor
   OEInteractionStyle
   OELingoType
   OEMCMolType
   OEMCSType
   OEMDLQueryOpts
   OEMMFFType
   OEMModType
   OEMolBaseType
   OENearestNbrsMethod
   OEOFlavor
   OEPDBAtomName
   OEPerceived
   OEPreserveResInfo
   OEProperty
   OEProteinColorScheme
   OEProteinStyle
   OEQMolType
   OERadiiType
   OEResidueIndex
   OERxnRole
   OESLNFlag
   OESmartsParseOpts
   OESMILESFlag
   OEStyleGridType
   OESubSearchDatabaseType
   OESubSearchScreenType
   OESubSearchStatus
   OESurfaceColorScheme
   OESurfaceStyle
   OESurfaceType
   OETriposType
   OEUncolorStrategy
   OEUniMolecularRxnFixValence
   OEWriteMolReturnCode
   OEZap7Version
   OEZap9Version


*******************************************************************************
Preliminary OEChem Constants
*******************************************************************************

.. oe:namespace:: OEChem

.. toctree::

   OEAminoAcidType
   OEHelmGenerationReturnCode
   OEHelmParsingReturnCode
   OERxnAutomapMethod
   OERxnAutomapStatus
   OEMonomerType
   OEMonomerValidationReturnCode
   OEPolymerType
   OESMARTSAtomFlag
   OESMARTSBondFlag


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEHelmGenerationReturnCode

   .. attention::

      |PRELIMINARY-API|

   The :oe:constns:`OEChem::OEHelmGenerationReturnCode` namespace
   contains codes representing the success or various issues of :term:`HELM` string
   generation when using the :oe:func:`OEChem::OEMolToHelm` function.

   .. seealso::

      * :oe:cls:`OEChem::OEHelmGenerationResult` class

   .. oe:constant:: Success

      Represents that the HELM is **successfully** generated.

   .. oe:constant:: InvalidCodeSet

      Returned if the the monomers set used for :term:`HELM` generation does not have the specified
      code-set.

   .. oe:constant:: InvalidMonomerGraph

      Returns if after the monomers mapped to the molecule, the monomer graph can not be fully traversed
      to encode all the monomer components in the :term:`HELM` string.

   .. oe:constant:: InvalidUnmappedFragment

      Returned if there is any unmapped monomer in the molecule that can not be represented
      in the :term:`HELM` as an embedded SMILES string.

   .. oe:constant:: NoSequence

      Returned if the molecule has large portion of its sequence unmapped to known monomers.

   .. oe:constant:: TooLarge

      Returned if the molecule has more than 2048 heavy atoms and it is considered
      too large for :term:`HELM` generation.

   .. oe:constant:: UnmappedFragments

      Returns if there are any unmapped fragments in the molecule that would obstruct
      the generation of a valid :term:`HELM` string without embedded SMILES.

      .. seealso::

         * :oe:meth:`OEChem::OEHelmGenerationOptions::GetAllowUnmatchedFragments` method

   .. oe:constant:: UnspecifiedAtomStereo

      Returns if there is any unspecified stereo of a chiral atom in the molecule that would obstruct
      the generation of a valid :term:`HELM` string without embedded SMILES.

      .. seealso::

         * :oe:meth:`OEChem::OEHelmGenerationOptions::SetAllowUnspecifiedStereo` method

   .. oe:constant:: UnspecifiedBondStereo

      Returns if there is any unspecified stereo of a chiral bond in the molecule that would obstruct
      the generation of a valid :term:`HELM` string without embedded SMILES.

      .. seealso::

         * :oe:meth:`OEChem::OEHelmGenerationOptions::SetAllowUnspecifiedStereo` method


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEHelmParsingReturnCode

   .. attention::

      |PRELIMINARY-API|

   The :oe:constns:`OEChem::OEHelmParsingReturnCode` namespace
   contains codes representing the success or various issues of :term:`HELM` string
   parsing when using the :oe:func:`OEChem::OEHelmToMol` function. 

   .. seealso::

      * :oe:cls:`OEChem::OEHelmParsingResult` class

   .. oe:constant:: Success

      Represents that the HELM is **successfully** parsed.

   .. oe:constant:: HelmInvalidComponent

   .. oe:constant:: HelmInvalidVersion

   .. oe:constant:: HelmSyntaxError

   .. oe:constant:: InvalidConnectionChainId

      The HELM connection component references a chain that does not exist.

   .. oe:constant:: InvalidConnectionMonomerIdx

      The HELM connection component references a monomer that does not exist.

   .. oe:constant:: InvalidConnectionRGroupIdx

      The HELM connection component references a chain that does not exist.

   .. oe:constant:: InvalidEmbeddedSmiles

      The HELM contains embedded :term:`SMILES` string that can not be parsed and converted into a 
      monomer.

   .. oe:constant:: InvalidMonomerConnection

      The HELM contains monomer connections that are invalid.

   .. oe:constant:: NotSupported

      The HELM contains features that is not supported yet in the current implementation.

   .. oe:constant:: UnrecognizedMonomerCode

      The HELM string includes a monomer code that is not present in the selected code sets.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. _OEChem_OERxnAutomapMethod:

.. oe:constnamespace:: OERxnAutomapMethod

   .. attention::

      |PRELIMINARY-API|

   The :oe:constns:`OEChem::OERxnAutomapMethod` namespace encodes symbolic constants
   representing the mapping method to use for the reaction automapping activity.  This
   is just a placeholder for future mapping methods.

   .. seealso::

      * :ref:`OERxnAutomapper <OEChem_OERxnAutomapper>` class

   This namespace contains the following constants:

   .. oe:constant:: DEFAULT

      This value requests the default mapping based algorithm, currently MCSMapping.

   .. oe:constant:: MCSMapping

      This value requests an MCS mapping based algorithm.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. _OEChem_OERxnAutomapStatus:

.. oe:constnamespace:: OERxnAutomapStatus

   .. attention::

      |PRELIMINARY-API|

   The :oe:constns:`OEChem::OERxnAutomapStatus` namespace encodes symbolic constants
   representing the status returned from reaction automapping.

   .. seealso::

      * :ref:`OERxnAutomapper <OEChem_OERxnAutomapper>` class

   This namespace contains the following constants:

   .. oe:constant:: Failure

      This status indicates a general failure attempting to automap a reaction.

   .. oe:constant:: InvalidComponents

      This status indicates that the input reaction is missing either reactants
      or products and thus cannot have mapping correspondence assigned.

   .. oe:constant:: InvalidMethod

      This status indicates that an invalid mapping method was requested.

   .. oe:constant:: NonReactionInput

      This status indicates that the input structure is not identified as a reaction.

      .. seealso::

         * :oe:meth:`IsRxn<OEChem::OEMolBase::IsRxn>`

   .. oe:constant:: Success

      This status indicates success.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEMonomerType

   .. attention::

      |PRELIMINARY-API|

   The :oe:constns:`OEChem::OEMonomerType` namespace contains the 
   following constants:

   .. oe:constant:: Default

      The default polymer type is
      :oe:const:`OEChem::OEMonomerType::Backbone`.

   .. oe:constant:: Backbone

      String representation: ``Backbone``

      Monomer with multiple connection point. In case of a peptides, these monomers
      are used to build the backbone.

   .. oe:constant:: Terminal

      Monomer with one attachment point. In case of a peptides, these monomers
      are used at the C and N-terminal.

      String representation: ``Terminal``

   .. oe:constant:: Undefined

   .. seealso::

      * :oe:func:`OEChem::OEGetMonomerType` function
      * :oe:cls:`OEChem::OEHasMonomerType` functor
      * :oe:cls:`OEChem::OEMonomerData` class
      * :oe:func:`OEChem::OEStringToMonomerType` and :oe:func:`OEChem::OEMonomerTypeToString` functions


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEMonomerValidationReturnCode

   .. attention::

      |PRELIMINARY-API|

   The :oe:constns:`OEChem::OEMonomerValidationReturnCode` namespace
   contains codes representing the success or various issues of monomer validation
   when using the :oe:func:`OEChem::OEIsValidMonomerData` function. 

   .. seealso::

      * :oe:cls:`OEChem::OEMonomerData` class
      * :oe:cls:`OEChem::OEMonomerValidationResult` class

   It contains the following constants:

   .. oe:constant:: Success

      Represents that the monomer is **valid**.

   .. oe:constant:: InvalidMonomerCode

      The monomer code is invalid:

      * empty string or more the 20 character long
      * contains character other than: alphanumerical, ``-`` (dash), ``_`` (underscore), ``(`` or ``)`` or ``,`` (comma)
      * ``UNK`` is a reserved name and should nt be used as a monomer code

   .. oe:constant:: InvalidMonomerRGroups

      If the monomer has any invalid connection point defined my R-group map index.

   .. oe:constant:: InvalidMonomerSmiles

      The monomer smiles is invalid, if the :oe:func:`OEChem::OEParseSmiles` function return false.

   .. oe:constant:: InvalidMonomerType

      The monomer type is invalid or does not match to the type 
      returned by the :oe:func:`OEChem::OEGetMonomerType` function.

   .. oe:constant:: InvalidPolymerType

      The polymer type is invalid or does not match to the type 
      returned by the :oe:func:`OEChem::OEGetPolymerType` function.

   .. oe:constant:: MissingMonomerCode

      If the monomer has not code specified for any code-set.

   .. oe:constant:: MissingMonomerRGroups

      If the monomer has no connection point defined my R-group map index.

   .. oe:constant:: MissingMonomerSmiles

      If no smiles specified for the monomer structure.

   .. oe:constant:: UnspecifiedAtomStereo

      A monomer unspecified stereo at a chiral atom is considered invalid.

   .. oe:constant:: UnspecifiedBondStereo

      A monomer unspecified bond at a chiral bond is considered invalid.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


   
.. oe:namespace:: OEChem

.. oe:constnamespace:: OEPolymerType

   .. attention::

      |PRELIMINARY-API|

   The :oe:constns:`OEChem::OEPolymerType` namespace contains the 
   following constants:

   .. oe:constant:: Default

      The default polymer type is
      :oe:const:`OEChem::OEPolymerType::Peptide`.

   .. oe:constant:: Chem

      Represents monomers with generic polymer type.

      String representation: ``Chem``

   .. oe:constant:: Peptide

      Represents peptidic monomers that can be used to define large 
      peptide molecules.

      String representation: ``Peptide``

   .. oe:constant:: Undefined

   .. seealso::

      * :oe:func:`OEChem::OEGetPolymerType` function
      * :oe:cls:`OEChem::OEHasPolymerType` functor
      * :oe:cls:`OEChem::OEMonomerData` class
      * :oe:func:`OEChem::OEStringToPolymerType` and :oe:func:`OEChem::OEPolymerTypeToString` functions


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:constnamespace:: OESMARTSAtomFlag

   .. attention::

      |PRELIMINARY-API|

   This namespace contains constants representing various supported
   SMARTS pattern constraints for atoms.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AAmap

      This constant requests the explicit inclusion of non-zero mapping number information.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AtomType
   .. oe:constant:: AnyAtomType
   .. oe:constant:: IgnoreArom

      These constants control the output of atom type information.
      The returned atom SMARTS string will only be ``[]`` delimited if one of ``AnyAtomType`` or ``AtomType`` are specified
      which allows using non-atype flags to build up SMARTS qualifiers for alternate custom SMARTS generation activities.

      ``AtomType`` will encode the atom symbol of the atom type which is downcased for aromatic atoms.
      ``AnyAtomType`` will encode ``a,A`` for any atom type, depending on aromatic atom state.
      ``IgnoreArom`` will encode just the atomic number value of the atom.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Charge
   .. oe:constant:: Charge0

      These constants control the output of atom formal charge information.
      For ``Charge``, only non-zero charge information is output, and for
      ``Charge0``, information is output explicitly regardless of value.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Chirality

      This constant requests the encoding of atom parity information via
      the ``@``, ``@@`` designation on the atom.  Note that this information requires the
      presence of the neighbor atoms in the SMARTS query to be a meaningful
      mapping constraint.  Additionally, the encoded parity state is explicitly
      dependent on the ordering of neighbor atoms, requiring suppression of any
      reordering of atoms when generating the full molecule SMARTS.

      .. seealso::
         * :oe:constns:`OEChem::OESMILESFlag`
         * :oe:func:`OEChem::OECreateSmartsString`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Connectivity

      This constant controls the output of the connectivity for the atom, see :ref:`GetDegree <OEChem_OEAtomBase_GetDegree>`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DegreeCount

      This constant controls the output of the explicit degree for the atom, see :ref:`GetExplicitDegree <OEChem_OEAtomBase_GetExplicitDegree>`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: HCount
   .. oe:constant:: HCount0

      These constants control the output of atom total hydrogen count information.
      For ``HCount``, only non-zero information is output, and for
      ``HCount0``, information is output explicitly regardless of value.
      See :ref:`GetTotalHCount <OEChem_OEAtomBase_GetTotalHCount>`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Hybridization

      This constant controls the output of nonzero hybridization for the atom, see :ref:`GetHyb <OEChem_OEAtomBase_GetHyb>`.
      The hybridization of atoms should be set up via :ref:`OEAssignHybridization <OEChem_OEAssignHybridization>` for this flag to be active.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ImplicitHCount
   .. oe:constant:: ImplicitHCount0

      These constants control the output of implicit hydrogen counts for the atom which can be assigned via :oe:func:`OEChem::OEAssignImplicitHydrogens`,
      but may already be assigned depending on how the molecule was instantiated and from what source.
      For ``ImplicitHCount``, only non-zero information is output, and for ``ImplicitHCount0``, information is output explicitly regardless of value.
      See :ref:`GetImplicitHCount <OEChem_OEAtomBase_GetImplicitHCount>`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Isotope

      This constant controls whether isoptopic information on the atom should be encoded.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: LeavingGroup

      This constant is experimental.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: RingBondCount

      This constant controls the output of the ring bond count for the atom.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Valence

      This constant controls the output of the valence value for the atom, see :ref:`GetValence <OEChem_OEAtomBase_GetValence>`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AtomAll

      This constant is a collection of all available flags.
      Equivalent to

      ``(AtomType | IgnoreArom | AnyAtomType |
      DegreeCount |
      HCount | HCount0 |
      Charge | Charge0 |
      RingBondCount |
      Valence |
      Connectivity |
      AAmap |
      LeavingGroup |
      Isotope |
      Chirality |
      Hybridization |
      ImplicitHCount | ImplicitHCount0)``

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DEFAULT
   .. oe:constant:: AtomDefault

      These two constant values equivalently request that no atom pattern constraints are generated.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AtomExact

      This constant provides a collection of atom pattern constraints suitable for exact-match searching.
      Equivalent to ``(AtomType | Isotope | RingBondCount | Valence | HCount0 | Connectivity | Charge0)``
      These flags are not included, as they require consideration of neighbor atoms, or need setup perception activity to be meaningful,
      but should be carefully considered for augmenting an exact-match context: ``Chirality``, ``Hybridization``, ``ImplicitHCount``, ``ImplicitHCount0``.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:constnamespace:: OESMARTSBondFlag

.. oe:class:: OELigandEnergy

   .. attention::

      |PRELIMINARY-API|

   This namespace contains constants representing various supported
   SMARTS pattern constraints for bonds.

   .. oe:constant:: BondType
   .. oe:constant:: AromBondType
   .. oe:constant:: AnyBondType

      For non-aromatic bond types, ``BondType`` exports the explicit bond order/type, ``-,=,#``.
      For aromatic bonds types and ``AromBondType`` specified, an aromatic bond type is exported, ``:``.
      If ``AnyBondType`` is specified, a generic any bond type is exported, ``~``.

   .. oe:constant:: BondTopo

      For non-aromatic bonds, ring/chain constraints are exported.

   .. oe:constant:: Chirality

      This constant requests the encoding of bond cis/tran parity information via
      forward and backward ``/`` designations on the bond neighbors.  Note that this information requires the
      presence of the neighbor atoms of the geometric double bond in the SMARTS query to be a meaningful
      mapping constraint.  Additionally, the encoded cis/trans parity state is explicitly
      dependent on the ordering of neighbor atoms, requiring suppression of any
      atom reordering when generating the full molecule SMARTS, as well as requesting
      :oe:const:`OEChem::OESMILESFlag::BondStereo` during the molecule SMARTS generation.

      .. seealso::
         * :oe:constns:`OEChem::OESMILESFlag`
         * :oe:const:`OEChem::OESMILESFlag::BondStereo` 
         * :oe:func:`OEChem::OECreateSmartsString`

   .. oe:constant:: BondAll

      This constant is a collection of all available flags.
      Equivalent to ``(BondType | AromBondType | AnyBondType | BondTopo | Chirality)``

   .. oe:constant:: DEFAULT
   .. oe:constant:: BondDefault

      These two constant values equivalently request that no bond pattern constraints are generated.

   .. oe:constant:: BondExact
      
      This constant provides a collection of bond pattern constraints suitable for exact-match searching.
      Equivalent to ``(BondType | AromBondType | BondTopo)``
      This flag is not included, as it requires consideration of neighbor atoms to the cis/trans bond
      but should be carefully considered for augmenting an exact-match context: ``Chirality``.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELigandEnergy & operator=(const OELigandEnergy &)

      Assignment operator.



.. oe:namespace:: OEChem

.. _OEChem_OEContourStyle:

.. oe:constnamespace:: OEContourStyle

   The OEContourStyle namespace encodes symbolic constants representing the 
   contour style of the :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. The constants can be used as an 
   argument for the :oe:meth:`OEChem::OE3DMolStyle::SetContourStyle` function in :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. 

   This namespace contains constants.

   .. oe:constant:: BEGIN

   .. oe:constant:: Cloud

   .. oe:constant:: END

   .. oe:constant:: Hidden

   .. oe:constant:: Mesh

      .. figure:: oechemtk/images/contourStyle/mesh.*
         :align:  center

   .. oe:constant:: Solid

      .. figure:: oechemtk/images/contourStyle/solid.*
         :align:  center


.. oe:namespace:: OEChem

.. oe:constnamespace:: OECoordsType

   This namespace contains constants used to interrogate the floating
   point precision of a given
   :oe:meth:`OEChem::OEConfBase::GetCoordsPtr` implementation.

   .. oe:constant:: DoubleType

   .. oe:constant:: FloatType

   .. oe:constant:: HalfFloatType

   .. oe:constant:: LongDoubleType

   .. oe:constant:: MaxType

   .. oe:constant:: Undefined
   
   


.. oe:namespace:: OEChem

.. oe:constnamespace:: OEElemNo

   The :oe:constns:`OEChem::OEElemNo` namespace encodes symbolic constants
   representing atomic numbers of the elements.
   Elements are represented by their atomic symbols encoding the
   integer value of their atomic number, *i.e.*
   :oe:const:`OEChem::OEElemNo::C` has the value ``6``,
   :oe:const:`OEChem::OEElemNo::O` the value ``8`` and
   :oe:const:`OEChem::OEElemNo::H` the value ``1``.

   This namespace contains the following constants:

   .. oe:constant:: H

      Hydrogen

   .. oe:constant:: He

      Helium

   .. oe:constant:: Li

      Lithium

   .. oe:constant:: Be

      Beryllium

   .. oe:constant:: B

      Boron

   .. oe:constant:: C

      Carbon

   .. oe:constant:: N

      Nitrogen

   .. oe:constant:: O

      Oxygen

   .. oe:constant:: F

      Fluorine

   .. oe:constant:: Ne

      Neon

   .. oe:constant:: Na

      Sodium

   .. oe:constant:: Mg

      Magnesium

   .. oe:constant:: Al

      Aluminium

   .. oe:constant:: Si

      Silicon

   .. oe:constant:: P

      Phosphorus

   .. oe:constant:: S

      Sulfur or sulphur

   .. oe:constant:: Cl

      Chlorine

   .. oe:constant:: Ar

      Argon

   .. oe:constant:: K

      Potassium

   .. oe:constant:: Ca

      Calcium

   .. oe:constant:: Sc

      Scandium

   .. oe:constant:: Ti

      Titanium

   .. oe:constant:: V

      Vanadium

   .. oe:constant:: Cr

      Chromium

   .. oe:constant:: Mn

      Manganese

   .. oe:constant:: Fe

      Iron

   .. oe:constant:: Co

     Cobalt

   .. oe:constant:: Ni

      Nickel

   .. oe:constant:: Cu

      Copper

   .. oe:constant:: Zn

      Zinc

   .. oe:constant:: Ga

      Gallium

   .. oe:constant:: Ge

      Germanium

   .. oe:constant:: As

      Arsenic

   .. oe:constant:: Se

      Selenium

   .. oe:constant:: Br

      Bromine

   .. oe:constant:: Kr

      Krypton

   .. oe:constant:: Rb

      Rubidium

   .. oe:constant:: Sr

      Strontium

   .. oe:constant:: Y

      Yttrium

   .. oe:constant:: Zr

      Zirconium

   .. oe:constant:: Nb

      Niobium

   .. oe:constant:: Mo

      Molybdenum

   .. oe:constant:: Tc

      Technetium

   .. oe:constant:: Ru

      Ruthenium

   .. oe:constant:: Rh

      Rhodium

   .. oe:constant:: Pd

      Palladium

   .. oe:constant:: Ag

      Silver

   .. oe:constant:: Cd

      Cadmium

   .. oe:constant:: In

      Indium

   .. oe:constant:: Sn

      Tin

   .. oe:constant:: Sb

      Antimony

   .. oe:constant:: Te

      Tellurium

   .. oe:constant:: I

      Iodine

   .. oe:constant:: Xe

      Xenon

   .. oe:constant:: Cs

      Caesium or cesium

   .. oe:constant:: Ba

      Barium

   .. oe:constant:: La

      Lanthanum

   .. oe:constant:: Ce

      Cerium

   .. oe:constant:: Pr

      Praseodymium

   .. oe:constant:: Nd

      Neodymium

   .. oe:constant:: Pm

      Promethium

   .. oe:constant:: Sm

      Samarium

   .. oe:constant:: Eu

      Europium

   .. oe:constant:: Gd

      Gadolinium

   .. oe:constant:: Tb

      Terbium

   .. oe:constant:: Dy

      Dysprosium

   .. oe:constant:: Ho

      Holmium

   .. oe:constant:: Er

      Erbium

   .. oe:constant:: Tm

      Thulium

   .. oe:constant:: Yb

      Ytterbium

   .. oe:constant:: Lu

      Lutetium

   .. oe:constant:: Hf

      Hafnium

   .. oe:constant:: Ta

      Tantalum

   .. oe:constant:: W

      Tungsten

   .. oe:constant:: Re

      Rhenium

   .. oe:constant:: Os

      Osmium

   .. oe:constant:: Ir

      Iridium

   .. oe:constant:: Pt

      Platinum

   .. oe:constant:: Au

      Gold

   .. oe:constant:: Hg

      Mercury

   .. oe:constant:: Tl

      Thallium

   .. oe:constant:: Pb

      Lead

   .. oe:constant:: Bi

      Bismuth

   .. oe:constant:: Po

      Polonium

   .. oe:constant:: At

      Astatine

   .. oe:constant:: Rn

      Radon

   .. oe:constant:: Fr

      Francium

   .. oe:constant:: Ra

      Radium

   .. oe:constant:: Ac

      Actinium

   .. oe:constant:: Th

      Thorium

   .. oe:constant:: Pa

      Protactinium

   .. oe:constant:: U

      Uranium

   .. oe:constant:: Np

      Neptunium

   .. oe:constant:: Pu

      Plutonium

   .. oe:constant:: Am

      Americium

   .. oe:constant:: Cm

      Curium

   .. oe:constant:: Bk

      Berkelium

   .. oe:constant:: Cf

      Californium

   .. oe:constant:: Es

      Einsteinium

   .. oe:constant:: Fm

      Fermium

   .. oe:constant:: Md

      Mendelevium

   .. oe:constant:: No

      Nobelium

   .. oe:constant:: Lr

      Lawrencium

   .. oe:constant:: Rf

      Rutherfordium

   .. oe:constant:: Db

      Dubnium

   .. oe:constant:: Sg

      Seaborgium

   .. oe:constant:: Bh

      Bohrium

   .. oe:constant:: Hs

      Hassium

   .. oe:constant:: Mt

      Meitnerium

   .. oe:constant:: Ds

      Darmstadtium

   .. oe:constant:: Rg

      Roentgenium

   .. oe:constant:: Cn

      Copernicium

   .. oe:constant:: Nh

      Nihonium

   .. oe:constant:: Fl

      Flerovium

   .. oe:constant:: Mc

      Moscovium

   .. oe:constant:: Lv

      Livermorium

   .. oe:constant:: Ts

      Tennessine

   .. oe:constant:: Og

      Oganesson

   .. oe:constant:: MAXELEM

   .. oe:constant:: Du

      Dummy atom

   .. oe:constant:: Lp

      Lone pair

   .. oe:constant:: Xx

   .. oe:constant:: D

      Deuterium (:math:`^{2}H`), hydrogen isotope that contains one proton and one neutron in its nucleus.

   .. oe:constant:: T

      Tritium (:math:`^{3}H`), hydrogen isotope that contains one proton and two neutrons in its nucleus.

.. oe:namespace:: OEChem

.. oe:constnamespace:: OEExprOpts

   Pattern matching in **OEChem TK** is always done using query molecules or
   query graphs (:ref:`OEQMolBase <OEChem_OEQMolBase>`).
   Non-query molecules, *i.e.* those that are defined by :ref:`OEMolBase <OEChem_OEMolBase>`
   abstract base-class must be converted into a query molecule before using
   them in pattern matching algorithms (:ref:`OESubSearch <OEChem_OESubSearch>`,
   :ref:`OEMCSSearch <OEChem_OEMCSSearch>` or :ref:`OECliqueSearch <OEChem_OECliqueSearch>`).

   The :oe:constns:`OEChem::OEExprOpts` namespace contains expression options
   that control the conversion into query molecules.

   .. seealso::

      * :oe:meth:`OEChem::OESubSearch::Init` method
      * :oe:meth:`OEChem::OEMCSSearch::Init` method
      * :oe:meth:`OEChem::OEQMolBase::BuildExpressions` method

   The :oe:constns:`OEChem::OEExprOpts` namespace contains both atom and bond
   expressions options.
   Some options such as :oe:const:`OEChem::OEExprOpts::Aromaticity` can be used
   both as an atom or a bond expression.

   .. list-table:: **Atom and bond expression options**
      :widths: 80 50 50 100
      :header-rows: 1

      * - Constant name
        - Atom expression
        - Bond expression
        - Should be used with

      * - :oe:const:`Aromaticity<OEChem::OEExprOpts::Aromaticity>`
        - **X**
        - **X**
        -

      * - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>`
        - **X**
        -
        -

      * - :oe:const:`BondOrder<OEChem::OEExprOpts::BondOrder>`
        -
        - **X**
        -

      * - :oe:const:`Chiral<OEChem::OEExprOpts::Chiral>`
        - **X**
        - **X**
        -

      * - :oe:const:`Degree<OEChem::OEExprOpts::Degree>`
        - **X**
        -
        -

      * - :oe:const:`EqAromatic<OEChem::OEExprOpts::EqAromatic>`
        - **X**
        -
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>`

      * - :oe:const:`EqCAliphaticONS<OEChem::OEExprOpts::EqCAliphaticONS>`
        - **X**
        -
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>`

      * - :oe:const:`EqCHalogen<OEChem::OEExprOpts::EqCHalogen>`
        - **X**
        -
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>`

      * - :oe:const:`EqCPSAcidRoot<OEChem::OEExprOpts::EqCPSAcidRoot>`
        - **X**
        -
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>`

      * - :oe:const:`EqDoubleTriple<OEChem::OEExprOpts::EqDoubleTriple>`
        -
        - **X**
        - :oe:const:`BondOrder<OEChem::OEExprOpts::BondOrder>`

      * - :oe:const:`EqHalogen<OEChem::OEExprOpts::EqHalogen>`
        - **X**
        -
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>`

      * - :oe:const:`EqKetoneSulfoneRoot<OEChem::OEExprOpts::EqKetoneSulfoneRoot>`
        - **X**
        -
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>`

      * - :oe:const:`EqMetal<OEChem::OEExprOpts::EqMetal>`
        - **X**
        -
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>`

      * - :oe:const:`EqNotAromatic<OEChem::OEExprOpts::EqNotAromatic>`
        - **X**
        - **X**
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>` or :oe:const:`BondOrder<OEChem::OEExprOpts::BondOrder>`

      * - :oe:const:`EqON<OEChem::OEExprOpts::EqON>`
        - **X**
        -
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>`

      * - :oe:const:`EqONS<OEChem::OEExprOpts::EqONS>`
        - **X**
        -
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>`

      * - :oe:const:`EqPS<OEChem::OEExprOpts::EqPS>`
        - **X**
        -
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>`

      * - :oe:const:`EqSingleDouble<OEChem::OEExprOpts::EqSingleDouble>`
        -
        - **X**
        - :oe:const:`BondOrder<OEChem::OEExprOpts::BondOrder>`

      * - :oe:const:`ExplicitDegree<OEChem::OEExprOpts::ExplicitDegree>`
        - **X**
        -
        -

      * - :oe:const:`FormalCharge<OEChem::OEExprOpts::FormalCharge>`
        - **X**
        -
        -

      * - :oe:const:`HCount<OEChem::OEExprOpts::HCount>`
        - **X**
        -
        -

      * - :oe:const:`HvyDegree<OEChem::OEExprOpts::HvyDegree>`
        - **X**
        -
        -

      * - :oe:const:`Hybridization<OEChem::OEExprOpts::Hybridization>`
        - **X**
        -
        -

      * - :oe:const:`ImplicitHCount<OEChem::OEExprOpts::ImplicitHCount>`
        - **X**
        -
        -

      * - :oe:const:`IntType<OEChem::OEExprOpts::IntType>`
        - **X**
        - **X**
        -

      * - :oe:const:`Mass<OEChem::OEExprOpts::Mass>`
        - **X**
        -
        -

      * - :oe:const:`RingMember<OEChem::OEExprOpts::RingMember>`
        - **X**
        - **X**
        -

      * - :oe:const:`StrictFormalCharge<OEChem::OEExprOpts::StrictFormalCharge>`
        - **X**
        -
        -

      * - :oe:const:`StringType<OEChem::OEExprOpts::StringType>`
        - **X**
        - **X**
        -

      * - :oe:const:`SymmetryClass<OEChem::OEExprOpts::SymmetryClass>`
        - **X**
        - **X**
        -

      * - :oe:const:`Valence<OEChem::OEExprOpts::Valence>`
        - **X**
        -
        -

   The :oe:constns:`OEChem::OEExprOpts` namespace also contains some predefined atom and bonds
   expression combinations listed in the table below.

   .. list-table:: **Predefined atom and bond expression combinations**
      :widths: 60 340
      :header-rows: 1

      * - Constant name
        - Combination of expression flags

      * - :oe:const:`AutomorphAtoms<OEChem::OEExprOpts::AutomorphAtoms>`
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>` | :oe:const:`Aromaticity<OEChem::OEExprOpts::Aromaticity>` | :oe:const:`RingMember<OEChem::OEExprOpts::RingMember>` | :oe:const:`HvyDegree<OEChem::OEExprOpts::HvyDegree>`
      * - :oe:const:`AutomorphBonds<OEChem::OEExprOpts::AutomorphBonds>`
        - :oe:const:`Aromaticity<OEChem::OEExprOpts::Aromaticity>`

      * - :oe:const:`DefaultAtoms<OEChem::OEExprOpts::DefaultAtoms>`
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>` | :oe:const:`Aromaticity<OEChem::OEExprOpts::Aromaticity>` | :oe:const:`FormalCharge<OEChem::OEExprOpts::FormalCharge>`
      * - :oe:const:`DefaultBonds<OEChem::OEExprOpts::DefaultBonds>`
        - :oe:const:`BondOrder<OEChem::OEExprOpts::BondOrder>` | :oe:const:`Aromaticity<OEChem::OEExprOpts::Aromaticity>`

      * - :oe:const:`ExactAtoms<OEChem::OEExprOpts::ExactAtoms>`
        - :oe:const:`AtomicNumber<OEChem::OEExprOpts::AtomicNumber>` | :oe:const:`Aromaticity<OEChem::OEExprOpts::Aromaticity>` | :oe:const:`StrictFormalCharge<OEChem::OEExprOpts::StrictFormalCharge>` | :oe:const:`Degree<OEChem::OEExprOpts::Degree>` | :oe:const:`HCount<OEChem::OEExprOpts::HCount>` | :oe:const:`Chiral<OEChem::OEExprOpts::Chiral>` | :oe:const:`Mass<OEChem::OEExprOpts::Mass>` | :oe:const:`RingMember<OEChem::OEExprOpts::RingMember>`
      * - :oe:const:`ExactBonds<OEChem::OEExprOpts::ExactBonds>`
        - :oe:const:`BondOrder<OEChem::OEExprOpts::BondOrder>` | :oe:const:`Aromaticity<OEChem::OEExprOpts::Aromaticity>` | :oe:const:`Chiral<OEChem::OEExprOpts::Chiral>` | :oe:const:`RingMember<OEChem::OEExprOpts::RingMember>`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Aromaticity

      The :oe:const:`OEChem::OEExprOpts::Aromaticity` flag can be used both
      as atom and bond expression option.

      * When using this option as an atom expression option, atoms are
        considered equivalent if the :oe:meth:`OEChem::OEAtomBase::IsAromatic`
        method returns the same value for them.

      * When using this option as a bond expression option, bonds are
        considered equivalent if the :oe:meth:`OEChem::OEBondBase::IsAromatic`
        method returns the same value for them.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::Aromaticity` **option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotAromaticity.*
           - .. image:: ../images/OEExprOpts_OESubSearch_Aromaticity.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::Aromaticity` **option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotAromaticity.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_Aromaticity.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AtomicNumber

      The :oe:const:`OEChem::OEExprOpts::AtomicNumber` flag can be used
      as an atom expression option.
      When using this option, atoms are considered equivalent if the
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum` method returns the
      same value for them.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::AtomicNumber` **option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotAtomicNumber.*
           - .. image:: ../images/OEExprOpts_OESubSearch_AtomicNumber.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::AtomicNumber` **option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotAtomicNumber.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_AtomicNumber.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AutomorphAtoms

      This constant along with :oe:const:`OEChem::OEExprOpts::AutomorphBonds`
      is used when determining automorphism related graphs
      :oe:const:`OEChem::OEExprOpts::AutomorphAtoms` is the combination of the
      following atom expression constants:

      * :oe:const:`OEChem::OEExprOpts::AtomicNumber`
      * :oe:const:`OEChem::OEExprOpts::Aromaticity`
      * :oe:const:`OEChem::OEExprOpts::RingMember`
      * :oe:const:`OEChem::OEExprOpts::HvyDegree`

   .. oe:constant:: AutomorphBonds

      This constant along with :oe:const:`OEChem::OEExprOpts::AutomorphAtoms`
      is used when determining automorphism related graphs.
      :oe:const:`OEChem::OEExprOpts::AutomorphBonds` is equivalent to the
      :oe:const:`OEChem::OEExprOpts::Aromaticity` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BondOrder

      The :oe:const:`OEChem::OEExprOpts::BondOrder` flag can be used
      as a bond expression option.
      When using this option, bonds are considered equivalent if the
      :oe:meth:`OEChem::OEBondBase::GetOrder` method returns the
      same value for them.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::BondOrder` **option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotBondOrder.*
           - .. image:: ../images/OEExprOpts_OESubSearch_BondOrder.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::BondOrder` **option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotBondOrder.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_BondOrder.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DefaultAtoms

      This constant along with :oe:const:`OEChem::OEExprOpts::DefaultBonds`
      is used when a moderate degree of discrimination is required
      of the graph equivalence.
      :oe:const:`OEChem::OEExprOpts::DefaultAtoms` is the combination of
      the following atom expression constants:

      * :oe:const:`OEChem::OEExprOpts::AtomicNumber`
      * :oe:const:`OEChem::OEExprOpts::Aromaticity`
      * :oe:const:`OEChem::OEExprOpts::FormalCharge`

      This combination of flags is intended to give a moderate
      degree of discrimination of the graph equivalence of atoms.
      Accordingly, two atoms are considered equivalent if they
      have the same element, aromaticity value and formal charge.

   .. oe:constant:: DefaultBonds

      :oe:const:`OEChem::OEExprOpts::DefaultBonds` is the combination of the
      following bond expression constants:

      * :oe:const:`OEChem::OEExprOpts::BondOrder`
      * :oe:const:`OEChem::OEExprOpts::Aromaticity`

      This combination of flags is intended to give a moderate
      degree of discrimination of the graph equivalence of bonds.
      Accordingly, two bonds are considered equivalent if they
      have the same bond order and aromaticity value.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Chiral

      The :oe:const:`OEChem::OEExprOpts::Chiral` flag can be used both
      as atom and bond expression option.

      * When using this option as an atom expression option, if the query atom
        has specified tetrahedral configuration, than it can only be
        mapped to an atom with the same stereo configuration.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::Chiral` **atom option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotChiralAtom.*
           - .. image:: ../images/OEExprOpts_OESubSearch_ChiralAtom.*

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::Chiral` is not available
         as an atom expression option in maximum common substructure
         search (:ref:`OEMCSSearch <OEChem_OEMCSSearch>`) and clique search
         (:ref:`OECliqueSearch <OEChem_OECliqueSearch>`).

      * When using this option as a bond expression option, if the query bond
        has specified cis/trans configuration, than it can only be
        mapped to a bond with the same stereo configuration.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::Chiral` **atom option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotChiralBond.*
           - .. image:: ../images/OEExprOpts_OESubSearch_ChiralBond.*

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::Chiral` is not available
         as a bond expression option in maximum common substructure
         search (:ref:`OEMCSSearch <OEChem_OEMCSSearch>`) and clique search
         (:ref:`OECliqueSearch <OEChem_OECliqueSearch>`).

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Degree

      The :oe:const:`OEChem::OEExprOpts::Degree` flag can be used
      as an atom expression option.
      When using this option, atoms are considered equivalent if the
      :oe:meth:`OEChem::OEAtomBase::GetDegree` method returns the
      same value for them.

      .. hint::

         The :oe:meth:`OEChem::OEAtomBase::GetDegree` method returns the total
         degree including the contribution from implicit hydrogens.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EqAromatic

      The :oe:const:`OEChem::OEExprOpts::EqAromatic` flag can be used
      as an atom expression option.
      When using this option, aromatic atoms are considered equivalent
      regardless of their atomic number.

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::EqAromatic` should always be used
         with the :oe:const:`OEChem::OEExprOpts::AtomicNumber` flag.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqAromatic` **option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotEqAromatic.*
           - .. image:: ../images/OEExprOpts_OESubSearch_EqAromatic.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqAromatic` **option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotEqAromatic.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_EqAromatic.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EqCAliphaticONS

      The :oe:const:`OEChem::OEExprOpts::EqCAliphaticONS` flag can be used
      as an atom expression option.
      When using this option, aliphatic query carbon atoms are considered equivalent
      with aliphatic oxygen, nitrogen, or sulfur atoms.

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::EqCAliphaticONS` should always be used
         with the :oe:const:`OEChem::OEExprOpts::AtomicNumber` flag.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqCAliphaticONS` **option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotEqCAliphaticONS.*
           - .. image:: ../images/OEExprOpts_OESubSearch_EqCAliphaticONS.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqCAliphaticONS` **option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotEqCAliphaticONS.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_EqCAliphaticONS.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EqCHalogen

      The :oe:const:`OEChem::OEExprOpts::EqCHalogen` flag can be used
      as an atom expression option.
      When using this option, carbons are considered equivalent
      with halogen atoms.

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::EqCHalogen` should always be used
         with the :oe:const:`OEChem::OEExprOpts::AtomicNumber` flag.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EqCPSAcidRoot

      The :oe:const:`OEChem::OEExprOpts::EqCPSAcidRoot` flag can be used
      as an atom expression option.
      When using this option, query atoms which are the central atom of a carboxylic,
      phosphonic, or sulfonic acid moiety are equivalent to a
      potential match atom which is also the central atom of a
      carboxylic, phosphonic, or sulfonic moiety.

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::EqCPSAcidRoot` should always be used
         with the :oe:const:`OEChem::OEExprOpts::AtomicNumber` flag.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EqDoubleTriple

      The :oe:const:`OEChem::OEExprOpts::EqDoubleTriple` flag can be used
      as a bond expression option.
      When using this option, double and triple bonds are considered equivalent.

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::EqDoubleTriple` should always be used
         with the :oe:const:`OEChem::OEExprOpts::BondOrder` flag.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqDoubleTriple` **option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotEqDoubleTriple.*
           - .. image:: ../images/OEExprOpts_OESubSearch_EqDoubleTriple.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqDoubleTriple` **option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotEqDoubleTriple.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_EqDoubleTriple.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EqHalogen

      The :oe:const:`OEChem::OEExprOpts::EqHalogen` flag can be used
      as an atom expression option.
      When using this option, halide atoms (:oe:const:`OEChem::OEElemNo::F`,
      :oe:const:`OEChem::OEElemNo::Cl`, :oe:const:`OEChem::OEElemNo::Br`,
      and :oe:const:`OEChem::OEElemNo::I`) are considered equivalent.

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::EqHalogen` should always be used
         with the :oe:const:`OEChem::OEExprOpts::AtomicNumber` flag.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqHalogen` **option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotEqHalogen.*
           - .. image:: ../images/OEExprOpts_OESubSearch_EqHalogen.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqHalogen` **option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotEqHalogen.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_EqHalogen.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EqKetoneSulfoneRoot

      The :oe:const:`OEChem::OEExprOpts::EqKetoneSulfoneRoot` flag can be used
      as an atom expression option.
      When using this option, query atoms
      which are the central atom of a ketone or sulfone moiety are
      equivalent to a potential match atom which is also the central
      atom of a ketone or sulfone moiety.

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::EqKetoneSulfoneRoot` should always be used
         with the :oe:const:`OEChem::OEExprOpts::AtomicNumber` flag.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EqMetal

      The :oe:const:`OEChem::OEExprOpts::EqMetal` flag can be used
      as an atom expression option.
      When using this option, metal atoms are considered equivalent.

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::EqMetal` should always be used
         with the :oe:const:`OEChem::OEExprOpts::AtomicNumber` flag.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EqNotAromatic

      The :oe:const:`OEChem::OEExprOpts::EqNotAromatic` flag can be used both
      as atom and bond expression option.

      * When using this option as an atom expression option, aliphatic
        atoms are considered equivalent regardless of their atomic number.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqNotAromatic` **atom option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotEqNotAromaticAtom.*
           - .. image:: ../images/OEExprOpts_OESubSearch_EqNotAromaticAtom.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqNotAromatic` **atom option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotEqNotAromaticAtom.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_EqNotAromaticAtom.*

      * When using this option as a bond expression option, aliphatic
        bonds are considered equivalent regardless of their bond order.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqNotAromatic` **bond option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotEqNotAromaticBond.*
           - .. image:: ../images/OEExprOpts_OESubSearch_EqNotAromaticBond.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqNotAromatic` **bond option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotEqNotAromaticBond.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_EqNotAromaticBond.*

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::EqNotAromatic` should always be used
         with either the :oe:const:`OEChem::OEExprOpts::AtomicNumber` or
         the :oe:const:`OEChem::OEExprOpts::BondOrder` flag.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EqON

      The :oe:const:`OEChem::OEExprOpts::EqON` flag can be used
      as an atom expression option.
      When using this option, nitrogen and oxygen atoms are considered equivalent.

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::EqON` should always be used
         with the :oe:const:`OEChem::OEExprOpts::AtomicNumber` flag.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EqONS

      The :oe:const:`OEChem::OEExprOpts::EqONS` flag can be used
      as an atom expression option.
      When using this option, nitrogen, oxygen and sulfur atoms
      are considered equivalent.

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::EqONS` should always be used
         with the :oe:const:`OEChem::OEExprOpts::AtomicNumber` flag.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EqPS

      The :oe:const:`OEChem::OEExprOpts::EqPS` flag can be used
      as an atom expression option.
      When using this option, phosphorus and sulfur atoms
      are considered equivalent.

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::EqPS` should always be used
         with the :oe:const:`OEChem::OEExprOpts::AtomicNumber` flag.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EqSingleDouble

      The :oe:const:`OEChem::OEExprOpts::EqSingleDouble` flag can be used
      as a bond expression option.
      When using this option, single and double bonds and are considered equivalent.

      .. warning::

         The :oe:const:`OEChem::OEExprOpts::EqSingleDouble` should always be used
         with the :oe:const:`OEChem::OEExprOpts::BondOrder` flag.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqSingleDouble` **option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotEqSingleDouble.*
           - .. image:: ../images/OEExprOpts_OESubSearch_EqSingleDouble.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::EqSingleDouble` **option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotEqSingleDouble.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_EqSingleDouble.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ExactAtoms

      :oe:const:`OEChem::OEExprOpts::ExactAtoms` is the combination of the
      following bond expression constants:

      * :oe:const:`OEChem::OEExprOpts::AtomicNumber`
      * :oe:const:`OEChem::OEExprOpts::Aromaticity`
      * :oe:const:`OEChem::OEExprOpts::StrictFormalCharge`
      * :oe:const:`OEChem::OEExprOpts::Degree`
      * :oe:const:`OEChem::OEExprOpts::HCount`
      * :oe:const:`OEChem::OEExprOpts::Chiral`
      * :oe:const:`OEChem::OEExprOpts::Mass`
      * :oe:const:`OEChem::OEExprOpts::RingMember`

      This combination of flags is intended to give a high
      degree of discrimination of the graph equivalence of atoms.

   .. oe:constant:: ExactBonds

      :oe:const:`OEChem::OEExprOpts::ExactBonds` is the combination of the
      following bond expression constants:

      * :oe:const:`OEChem::OEExprOpts::BondOrder`
      * :oe:const:`OEChem::OEExprOpts::Aromaticity`
      * :oe:const:`OEChem::OEExprOpts::Chiral`
      * :oe:const:`OEChem::OEExprOpts::RingMember`

      This combination of flags is intended to give a high
      degree of discrimination of the graph equivalence of bonds.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ExplicitDegree

      The :oe:const:`OEChem::OEExprOpts::ExplicitDegree` flag can be used
      as an atom expression option.
      When using this option, atoms are considered equivalent if the
      :oe:meth:`OEChem::OEAtomBase::GetHvyDegree` method returns the
      same value for them.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FormalCharge

      The :oe:const:`OEChem::OEExprOpts::FormalCharge` flag can be used
      as an atom expression option.
      When using this option, atoms are considered equivalent if the
      :oe:meth:`OEChem::OEAtomBase::GetFormalCharge` method returns the
      same value for them **and** the query atom has a non-zero charge.
      If you want to consider zero charges see option
      :oe:const:`OEChem::OEExprOpts::StrictFormalCharge`.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::FormalCharge` **option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotFormalCharge.*
           - .. image:: ../images/OEExprOpts_OESubSearch_FormalCharge.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::FormalCharge` **option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotFormalCharge.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_FormalCharge.*

      .. seealso::

         * :oe:const:`OEChem::OEExprOpts::StrictFormalCharge` constants

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: HCount

      The :oe:const:`OEChem::OEExprOpts::HCount` flag can be used
      as an atom expression option.
      When using this option, atoms are considered equivalent if the
      :oe:meth:`OEChem::OEAtomBase::GetTotalHCount` method returns the
      same value for them.

      .. hint::

         The :oe:meth:`OEChem::OEAtomBase::GetTotalHCount` method returns
         the number of explicit and implicit hydrogens i.e.
         the expression built when the :oe:const:`OEChem::OEExprOpts::HCount`
         flag is set will therefore not discriminate between implicit and
         explicit hydrogen counts.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: HvyDegree

      The :oe:const:`OEChem::OEExprOpts::HvyDegree` flag can be used
      as an atom expression option.
      When using this option, atoms are considered equivalent if the
      :oe:meth:`OEChem::OEAtomBase::GetHvyDegree` method returns the
      same value for them.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Hybridization

      The :oe:const:`OEChem::OEExprOpts::Hybridization` flag can be used
      as an atom expression option.
      When using this option, atoms are considered equivalent if the
      :oe:meth:`OEChem::OEAtomBase::GetHyb` method returns the
      same value for them.

      .. warning::

         Hybridization of the molecules must be perceived by calling
         the :oe:func:`OEChem::OEAssignHybridization` function.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ImplicitHCount

      The :oe:const:`OEChem::OEExprOpts::ImplicitHCount` flag can be used
      as an atom expression option.
      When using this option, atoms are considered equivalent if the
      :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount` method returns the
      same value for them.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: IntType

      The :oe:const:`OEChem::OEExprOpts::IntType` flag can be used both
      as atom and bond expression option.

      * When using this option as an atom expression option,
        atoms are considered equivalent if the
        :oe:meth:`OEChem::OEAtomBase::GetIntType` method returns the
        same value for them.

      * When using this option as a bond expression option,
        bonds are considered equivalent if the
        :oe:meth:`OEChem::OEBondBase::GetIntType` method returns the
        same value for them.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Mass

      The :oe:const:`OEChem::OEExprOpts::Mass` flag can be used
      as an atom expression option.
      When using this option, atoms are considered equivalent if the
      :oe:meth:`OEChem::OEAtomBase::GetIsotope` method returns the
      same value for them.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: RingMember

      The :oe:const:`OEChem::OEExprOpts::RingMember` flag can be used both
      as atom and bond expression option.

      * When using this option as an atom expression option,
        atoms are considered equivalent if the
        :oe:meth:`OEChem::OEAtomBase::IsInRing` method returns the
        same value for them.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::RingMember` **atom option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotRingMemberAtom.*
           - .. image:: ../images/OEExprOpts_OESubSearch_RingMemberAtom.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::RingMember` **atom option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotRingMemberAtom.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_RingMemberAtom.*

      * When using this option as a bond expression option,
        bonds are considered equivalent if the
        :oe:meth:`OEChem::OEBondBase::IsInRing` method returns the
        same value for them.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::RingMember` **bond option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotRingMemberBond.*
           - .. image:: ../images/OEExprOpts_OESubSearch_RingMemberBond.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::RingMember` **bond option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotRingMemberBond.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_RingMemberBond.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: StrictFormalCharge

      The :oe:const:`OEChem::OEExprOpts::StrictFormalCharge` flag can be used
      as an atom expression option.
      When using this option, atoms are considered equivalent if the
      :oe:meth:`OEChem::OEAtomBase::GetFormalCharge` method returns the
      same value for them.
      The formal charges must be equivalent even if the formal charge
      of the query atom is zero.

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::StrictFormalCharge` **option in substructure search**

         * - .. image:: ../images/OEExprOpts_OESubSearch_NotStrictFormalCharge.*
           - .. image:: ../images/OEExprOpts_OESubSearch_StrictFormalCharge.*

      .. list-table:: **Example of using the** :oe:const:`OEChem::OEExprOpts::StrictFormalCharge` **option in maximum common substructure search**

         * - .. image:: ../images/OEExprOpts_OEMCSSearch_NotStrictFormalCharge.*
           - .. image:: ../images/OEExprOpts_OEMCSSearch_StrictFormalCharge.*

      .. seealso::

         * :oe:const:`OEChem::OEExprOpts::FormalCharge` constant

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: StringType

      The :oe:const:`OEChem::OEExprOpts::StringType` flag can be used both
      as atom and bond expression option.

      * When using this option as an atom expression option,
        atoms are considered equivalent if the
        :oe:meth:`OEChem::OEAtomBase::GetType` method returns the
        same value for them.

      * When using this option as a bond expression option,
        bonds are considered equivalent if the
        :oe:meth:`OEChem::OEBondBase::GetType` method returns the
        same value for them.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SymmetryClass

      The :oe:const:`OEChem::OEExprOpts::SymmetryClass` flag can be used
      as an atom expression option.
      When using this option, atoms are considered equivalent if the
      :oe:meth:`OEChem::OEAtomBase::GetSymmetryClass` method returns the
      same value for them.

      .. warning::

         Symmetry of the molecules must be perceived by calling
         the :oe:func:`OEChem::OEPerceiveSymmetry` function.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Valence

      The :oe:const:`OEChem::OEExprOpts::Valence` flag can be used
      as an atom expression option.
      When using this option, atoms are considered equivalent if the
      :oe:meth:`OEChem::OEAtomBase::GetValence` method returns the
      same value for them.

      .. hint::

         The :oe:meth:`OEChem::OEAtomBase::GetValence` method
         includes the valence contribution from implicit hydrogens,
         therefore, the expression test may return successfully even when
         the explicit valence of two corresponding atoms differ.


.. oe:namespace:: OEChem

.. oe:constnamespace:: OEExprType

   This namespace contains constants.

   .. oe:constant:: AllowedElements

   .. oe:constant:: And

   .. oe:constant:: Aromatic

   .. oe:constant:: AromBondOrder

      Utilized when optimizing bond expression trees.

   .. oe:constant:: AromElem

   .. oe:constant:: AromElemMinDegree

      Utilized when optimizing atom expression trees.

   .. oe:constant:: AromOrBondOrder

      Utilized when optimizing bond expression trees.

   .. oe:constant:: AromRingElem

      Utilized when optimizing atom expression trees.

   .. oe:constant:: AtomParityChange

   .. oe:constant:: BondOrder

   .. oe:constant:: BondParityChange

   .. oe:constant:: Charge

   .. oe:constant:: Chiral

   .. oe:constant:: Connect

   .. oe:constant:: Const

   .. oe:constant:: DefaultEdge

   .. oe:constant:: Degree

   .. oe:constant:: DoubleAromBond

   .. oe:constant:: ElemCharge

      Utilized when optimizing atom expression trees.

   .. oe:constant:: Element

   .. oe:constant:: ElemMinDegree

      Utilized when optimizing atom expression trees.

   .. oe:constant:: ElemMinHCount

      Utilized when optimizing bond expression trees.

   .. oe:constant:: FormalChargeChange

   .. oe:constant:: Halogen

   .. oe:constant:: HCount

   .. oe:constant:: HCountChange

   .. oe:constant:: Hyb

   .. oe:constant:: Implicit

   .. oe:constant:: IntType

   .. oe:constant:: Mass

   .. oe:constant:: Metal

   .. oe:constant:: MinDegree

   .. oe:constant:: MinHCount

   .. oe:constant:: Not

   .. oe:constant:: Or

   .. oe:constant:: Recurs

   .. oe:constant:: Ring

   .. oe:constant:: RingBondCount

   .. oe:constant:: RingBondOrder

      Utilized when optimizing bond expression trees.

   .. oe:constant:: RingDefaultEdge

      Utilized when optimizing bond expression trees.

   .. oe:constant:: RingElem

      Utilized when optimizing atom expression trees.

   .. oe:constant:: Saturation

   .. oe:constant:: SingleAromBond

   .. oe:constant:: Size

   .. oe:constant:: Stereo

   .. oe:constant:: StringType

   .. oe:constant:: SymmetryClass

   .. oe:constant:: TerminalAtom

   .. oe:constant:: Undefined

   .. oe:constant:: Valence


.. oe:namespace:: OEChem

.. oe:constnamespace:: OEFileStringType

   This namespace contains constants that are used with
   :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` and :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>`
   to control the input and output file parameters.

   .. oe:constant:: Mol

      Any molecule file type.

   .. oe:constant:: Mol3D

      Molecule fle types that contain 3D-coordinates.

   .. oe:constant:: MolReceptor

      Molecule file types for receptor molecules.

   .. oe:constant:: BroodQMol

      Molecule file type for Brood query.

   .. oe:constant:: DU

      Design unit file type.


.. oe:namespace:: OEChem

.. oe:constnamespace:: OEFileStringTypeFlavor

   This namespace contains constants that are used with
   :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` and :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>`
   to control the flavor of :oe:constns:`OEChem::OEFileStringType`.

   .. oe:constant:: Default
   .. oe:constant:: DEFAULT

      The combination of
      :oe:const:`OEChem::OEFileStringTypeFlavor::Pretty`,
      :oe:const:`OEChem::OEFileStringTypeFlavor::FileList`,
      :oe:const:`OEChem::OEFileStringTypeFlavor::Input`,
      :oe:const:`OEChem::OEFileStringTypeFlavor::Output`,
      :oe:const:`OEChem::OEFileStringTypeFlavor::MolOnly`.
      Generally useful for setting defaults, then disabling either
      :oe:const:`OEChem::OEFileStringTypeFlavor::Input`,
      or :oe:const:`OEChem::OEFileStringTypeFlavor::Output`,

   .. oe:constant:: Dim2D

      Explicitly indicates 2D file types. See :oe:func:`OEChem::OEIs2DFormat`.

   .. oe:constant:: Dim2D3D

      Explicitly indicates 2D or 3D file types, and excludes 0D file types, valid for input types only.
      The combination of
      :oe:const:`OEChem::OEFileStringTypeFlavor::Dim2D`,
      :oe:const:`OEChem::OEFileStringTypeFlavor::Dim3D`,

   .. oe:constant:: Dim3D

      Explicitly indicates 3D file types. See :oe:func:`OEChem::OEIs3DFormat`.

   .. oe:constant:: FileList

      Enables input file lists as valid filetypes, namely ``.lst`` and ``.list``.

   .. oe:constant:: Pretty

      Removes file types that are supported but not suggested for use.

   .. oe:constant:: Input

      Explicitly specifies input file types. See :oe:func:`OEChem::OEIsReadable`.

   .. oe:constant:: InputDefault

      The combination of
      :oe:const:`OEChem::OEFileStringTypeFlavor::FileList`,
      :oe:const:`OEChem::OEFileStringTypeFlavor::Input`,
      :oe:const:`OEChem::OEFileStringTypeFlavor::MolOnly`.

   .. oe:constant:: MolOnly

      Explicitly indicates only molecule input file types, excludes reactions.

   .. oe:constant:: NoListDefault

      The combination of
      :oe:const:`OEChem::OEFileStringTypeFlavor::Input`,
      :oe:const:`OEChem::OEFileStringTypeFlavor::Output`,
      :oe:const:`OEChem::OEFileStringTypeFlavor::MolOnly`.
      Generally useful for setting defaults, then disabling either
      :oe:const:`OEChem::OEFileStringTypeFlavor::Input`,
      or :oe:const:`OEChem::OEFileStringTypeFlavor::Output`,

   .. oe:constant:: Output

      Explicitly specifies output file types. See :oe:func:`OEChem::OEIsWriteable`.

   .. oe:constant:: OutputDefault

      The combination of
      :oe:const:`OEChem::OEFileStringTypeFlavor::Output`,
      :oe:const:`OEChem::OEFileStringTypeFlavor::MolOnly`.

   .. oe:constant:: RxnOnly

      Explicitly indicates only reaction input file types.



.. oe:namespace:: OEChem

..  _oechem_OEFormat:

.. oe:constnamespace:: OEFormat

   The OEFormat namespace encodes symbolic constants
   representing the molecular file formats that may be read or written
   by **OEChem TK**.

   .. seealso::

      * :ref:`section_molreadwrite_fileformats` section

   This namespace contains the following constants:

   .. oe:constant:: Default

      The default file format type is :oe:const:`OEChem::OEFormat::SMI`.

   .. oe:constant:: CAN

      This constant indicates :term:`Canonical SMILES`  file format.

   .. oe:constant:: CDX

      This constant indicates ChemDraw CDX file format.

   .. oe:constant:: CIF

      This constant indicates the small molecule Crystallographic Information File (CIF) format.

   .. oe:constant:: CSV

      This constant indicates the comma separated values file format
      as specified by `RFC 4180
      <http://tools.ietf.org/html/rfc4180>`_. The first column is
      :term:`canonical isomeric SMILES`, the second column is the
      :oe:meth:`molecule title<OEChem::OEMolBase::GetTitle>`, the
      remaining columns are SD data as determined by the first
      molecule read or written to the :ref:`oemolstreambase <OEChem_oemolstreambase>`.

      .. seealso::

         :ref:`section_moltaggeddata_CSV`

   .. oe:constant:: CXSMILES

      This constant indicates the Chemaxon Extended SMILES format.

      Enhanced stereogroup information is the only information in cxsmiles appendices currently supported.
      Please contact support@eyesopen.com if there are additional cxsmiles features that you would like to see supported.

      The specific features supported for this format are limited to,
      `MDL Chiral OFF 
      <https://docs.chemaxon.com/display/docs/formats_chemaxon-extended-smiles-and-smarts-cxsmiles-and-cxsmarts.md#molecule-absolute-stereoconfiguration>`_ and
      `Enhanced stereochemical representation 
      <https://docs.chemaxon.com/display/docs/formats_chemaxon-extended-smiles-and-smarts-cxsmiles-and-cxsmarts.md#enhanced-stereochemical-representation>`_ .
      The supported features cannot be in the presence of other unsupported features since a partial parse of the appendix information is disallowed.

      See `Chemaxon Extended SMILES and SMARTS <https://docs.chemaxon.com/display/docs/chemaxon-extended-smiles-and-smarts-cxsmiles-and-cxsmarts.md>`_ for a complete
      specification of all possible features.

   .. oe:constant:: FASTA

      This constant indicates FASTA protein sequence file format.

   .. oe:constant:: INCHI

      This constant indicates IUPAC InChI file format.

   .. oe:constant:: INCHIKEY

      This constant indicates IUPAC InChI Key file format.

   .. oe:constant:: ISM

      This constant indicates :term:`Canonical isomeric SMILES` file format.
      This is the same as the :oe:const:`OEChem::OEFormat::SMI` file format.

   .. oe:constant:: MAXFORMAT

      The maximum integral value any constant in the
      :oe:constns:`OEChem::OEFormat` can have.

      .. note::

         Values in this namespace are guaranteed to be contiguous.

   .. oe:constant:: MDL

      This constant indicates MDL Mol file format.

   .. oe:constant:: MF

      This constant indicates Molecular Formula  (Hill order) format.

   .. oe:constant:: MMCIF

      This constant indicates macromolecular Crystallographic Information File
      (mmCIF) file format.

   .. oe:constant:: MMOD

      This constant indicates Macromodel file format.

   .. oe:constant:: MOL2

      This constant indicates Tripos Sybyl mol2 file format.

   .. oe:constant:: MOL2H

      This constant indicates Tripos Sybyl mol2 file format with explicit hydrogens.

   .. oe:constant:: MOPAC

      This constant indicates MOPAC file format.

   .. oe:constant:: OEB

      This constant indicates **OpenEye** OEBinary file format.

   .. oe:constant:: OEZ

      This constant indicates Zstd compressed **OpenEye** OEBinary file format.
      Currently this file format **only** supports multi-conformer molecules derived
      from the :ref:`OEMCMolBase <OEChem_OEMCMolBase>` class.

      .. note::

         This file format was introduced in the ``2019.Apr`` toolkits.
         OpenEye applications or toolkits released before Apr/2019 will **not**
         be able to read this new file format.

      .. seealso::

         * :ref:`section_molreadwrite_compressed` section

   .. oe:constant:: PDB

      This constant indicates  Protein Databank PDB file format.

   .. oe:constant:: RDF

      This constant indicates MDL RDF reaction file format.

   .. oe:constant:: SDF

      This constant indicates MDL SD file format.

   .. oe:constant:: SKC

      This constant indicates MDL ISIS Sketch file format.

   .. oe:constant:: SLN

      This constant indicates Tripos Sybyl Line Notation file format.

   .. oe:constant:: SMI

      This constant indicates :term:`canonical isomeric SMILES` file format.
      This is the same as the :oe:const:`OEChem::OEFormat::ISM` file format.

   .. oe:constant:: UNDEFINED

      This constant indicates an unrecognized or undefined file format.

   .. oe:constant:: USM

      This constant indicates :term:`SMILES` file format.

   .. oe:constant:: XYZ

      This constant indicates XMol XYZ file format.


.. oe:namespace:: OEChem

.. oe:constnamespace:: OEFuzzVal

   The :oe:constns:`OEChem::OEFuzzVal` namespace encodes symbolic constants
   representing fuzzy values used to construct
   :ref:`OEFuzzy <OEChem_OEFuzzy>` objects.

   This namespace contains the following constants:

   .. oe:constant:: False
   
      This constant represents fuzzy value of false.

   .. oe:constant:: True
   
      This constant represents fuzzy value of true.

   .. oe:constant:: Maybe
   
      This constant represents fuzzy value of maybe.



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEGroupType

   The :oe:constns:`OEChem::OEGroupType` namespace encodes symbolic constants
   representing various group ids.

   .. oe:constant:: Component

   This tag identifies a set atoms that were identified as originating from the same reactant or product
   component.  This information allows multi-fragment reaction components to be identified.

   .. oe:constant:: MDLAbsStereo

   This tag identifies the set of stereo centers with absolute stereochemistry.

   .. oe:constant:: MDLOrStereo

   This tag identifies the set of stereo centers with relative (to other centers in the set) stereochemistry.
   The actual stereochemistry could be exactly as marked, or with all centers of the opposite parity.
   Only one of the two configurations is assumed to be present.

   .. oe:constant:: MDLAndStereo

   This tag identifies the set of stereo centers with racemic stereochemistry. A mixture of the two enantiomeric
   configurations is present, one with the stereo centers of the marked parity, and the other with all the
   stereo centers of the opposite parity. No information about the relative amount of one or the other enantiomer
   is assumed or implied.

   .. oe:constant:: Monomer

   This tag identifies the set of atoms that are belong to a specific monomer as parsed when a molecule
   is initialized with :oe:func:`OEChem::OEHelmToMol`.

   .. oe:constant:: Undefined

   .. oe:constant:: UserDefined

   This tag identifies a set atoms and/or bonds that were applied by an explicit user operation.  Groups defined
   with this tag are supported for serialization in the ``.oeb`` format.



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEHybridization

   The :oe:constns:`OEChem::OEHybridization` namespace encodes symbolic constants
   representing atom hybridizations.

   .. seealso:: 

      * :oe:func:`OEChem::OEAssignHybridization` function
      * :oe:meth:`OEChem::OEAtomBase::GetHyb` method
      * :oe:meth:`OEChem::OEAtomBase::SetHyb` method

   This namespace contains the following constants:

   .. oe:constant:: Unknown
   

   .. oe:constant:: sp
   

   .. oe:constant:: sp2
   

   .. oe:constant:: sp3
   

   .. oe:constant:: sp3d
   

   .. oe:constant:: sp3d2
   



.. oe:namespace:: OEChem

.. _OEChem_OEHydrogenVisibility:

.. oe:constnamespace:: OEHydrogenVisibility   
   
   The OEHydrogenVisibility namespace encodes symbolic constants representing the 
   different depiction of hydrogens for the :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. The constants can be 
   used as an argument for the :oe:meth:`OEChem::OE3DMolStyle::SetHydrogenVisibility` function in :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`.

   This namespace contains constants.

   .. oe:constant:: All

      .. figure:: oechemtk/images/hydrogenVis/all.*
         :align:  center

   .. oe:constant:: BEGIN

   .. oe:constant:: END

   .. oe:constant:: Off

      .. figure:: oechemtk/images/hydrogenVis/off.*
         :align:  center

   .. oe:constant:: Polar

      .. figure:: oechemtk/images/hydrogenVis/polar.*
         :align:  center


.. oe:namespace:: OEChem

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


..  _OEChem_OEIFlavor:

.. oe:constnamespace:: OEIFlavor

   The :oe:constns:`OEChem::OEIFlavor` namespace encodes symbolic
   constants used as bit-masks to indicate how to write various
   file formats by **OEChem TK**.

      .. note::

         A very important introduction (with examples) as to how to manipulate these
         bit-masks is given :ref:`section_molreadwrite_flavoredinputandoutput`

   The :oe:constns:`OEChem::OEIFlavor::Generic` namespace within
   :oe:constns:`OEChem::OEIFlavor` defines control bit-masks that are
   common to all of the input formats.
   Although these generic bits are common to all file formats, they
   may be specified independently for each file format.

   .. seealso::

      * :oe:meth:`OEChem::oemolistream::SetFormat` method to set the flavor of an input molecule stream
      * :oe:meth:`OEChem::oemolstreambase::GetFormat` method to retrieve the flavor of a molecule stream

   The interpretation of many of these flavor values, is identical to
   those passed to the corresponding **OEChem TK** low-level file format
   readers.

   This namespace contains the following namespaces:

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_CAN:

   .. oe:constnamespace:: OEIFlavor::CAN

      The :oe:constns:`OEChem::OEIFlavor::CAN` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::CAN` format file by
      the :oe:func:`OEChem::OEParseSmiles` function.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_CAN_Default:

      .. oe:constant:: Default

         No special options are set.

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_CDX:

   .. oe:constnamespace:: OEIFlavor::CDX

      The :oe:constns:`OEChem::OEIFlavor::CDX` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::CDX` format file by
      the :oe:func:`OEChem::OEReadCDXFile` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_CDX_SuperAtom:

      .. oe:constant:: SuperAtom

         Controls whether nested CDX fragment objects, which represent
         superatom abbreviation groups, are expanded and read with their
         atoms parented to the enclosing atom. When this flag is set (the
         default), abbreviations such as ``Ph`` or ``OMe`` embedded in a
         CDX structure are interpreted as substructures.

      ..  _OEChem_OEIFlavor_CDX_Default:

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::CDX::SuperAtom` constant.

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_CIF:

   .. oe:constnamespace:: OEIFlavor::CIF

      The :oe:constns:`OEChem::OEIFlavor::CIF` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::CIF` format file by the
      :oe:func:`OEChem::OEReadCIFFile` low-level file reader.

      This namespace contains the following constants, that mimic the XYZ reader.

      ..  _OEChem_OEIFlavor_CIF_FormalCrg:

      .. oe:constant:: FormalCrg

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignFormalCharges` function to
         assign formal charges.

      ..  _OEChem_OEIFlavor_CIF_ImplicitH:

      .. oe:constant:: ImplicitH

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignImplicitHydrogens` function to
         assign implicit hydrogens.

      ..  _OEChem_OEIFlavor_CIF_BondOrder:

      .. oe:constant:: BondOrder

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEPerceiveBondOrders` function to
         perceive bond orders.

      ..  _OEChem_OEIFlavor_CIF_Rings:

      .. oe:constant:: Rings

      The reader stores excluded sites and sites left after filtering. The filtering of these sites is based on the flavors listed below.

      ..  _OEChem_OEIFlavor_CIF_OccFilterOneHalf:

      .. oe:constant:: OccFilterOneHalf

         If occupancy is noted in the CIF file, only the sites with occupancy larger than one half is kept.
         If occupancy is not defined in the CIF file, the occupancies are set to 1 to prevent filtering.

      ..  _OEChem_OEIFlavor_CIF_RemovePBCImages:

      .. oe:constant:: RemovePBCImages

         Each site read is checked to see if it is equal to a previously read site up to periodic wrapping in fractional coordinates.

      ..  _OEChem_OEIFlavor_CIF_NormalizeHydPos:

      .. oe:constant:: NormalizeHydPos

         Hydrogen positions and bond lengths are normalized if necessary.

      ..  _OEChem_OEIFlavor_CIF_BondHydToClosest:

      .. oe:constant:: BondHydToClosest

         Enforces that hydrogen atoms are bonded to their closest heavy atom in space.

      ..  _OEChem_OEIFlavor_CIF_RemoveQuestionMarkInLabel:

      .. oe:constant:: RemoveQuestionMarkInLabel

         Sites with a question mark after atom labels are assigned are filtered out. These extra sites are sometimes alternative positions of existing sites.

      ..  _OEChem_OEIFlavor_CIF_Default:

      .. oe:constant:: Default

         Combination of:
         :oe:const:`OEChem::OEIFlavor::CIF::FormalCrg`,
         :oe:const:`OEChem::OEIFlavor::CIF::ImplicitH`,
         :oe:const:`OEChem::OEIFlavor::CIF::BondOrder`,
         :oe:const:`OEChem::OEIFlavor::CIF::Rings`,
         :oe:const:`OEChem::OEIFlavor::CIF::OccFilterOneHalf`,
         :oe:const:`OEChem::OEIFlavor::CIF::RemovePBCImages`,
         :oe:const:`OEChem::OEIFlavor::CIF::NormalizeHydPos`,
         :oe:const:`OEChem::OEIFlavor::CIF::BondHydToClosest`,
         :oe:const:`OEChem::OEIFlavor::CIF::RemoveQuestionMarkInLabel` flags.

   .. ################################################################
      #
      ################################################################

      ..  _OEChem_OEIFlavor_CSV:

   .. oe:constnamespace:: OEIFlavor::CSV

      This namespace contains constants for modifying the behavior of
      how the :oe:const:`OEChem::OEFormat::CSV` file format is read.

      .. seealso::

         :ref:`section_moltaggeddata_CSV`

      ..  _OEChem_OEIFlavor_CSV_Header:

      .. oe:constant:: Header

         Attempt to interpret the first line of the :file:`.csv` file
         as a header line containing column names. The header line
         will be parsed into an :ref:`OECSVHeader <OEChem_OECSVHeader>` object and
         stored on the :ref:`oemolistream <OEChem_oemolistream>` object,
         retrievable by :oe:meth:`OEChem::oemolstreambase::GetCSVHeader`.

         If this flag is not set, or the first column of the first
         line does not contain a valid :term:`SMILES` string, the
         :ref:`OECSVHeader <OEChem_OECSVHeader>` will be initialized with the
         number of columns present in the first line of the file. The
         columns will then be named and parsed in the following order:
         SMILES, TITLE, OE_CSV_COLUMN_1, OE_CSV_COLUMN_2, ...,
         OE_CSV_COLUMN_N.

      ..  _OEChem_OEIFlavor_CSV_Default:

      .. oe:constant:: Default

         Set to include :oe:const:`OEChem::OEIFlavor::CSV::Header` to
         automatically parse column names into molecule SD data.

      .. oe:constant:: DEFAULT

         Synonym for :oe:const:`OEChem::OEIFlavor::CSV::Default`.

   .. ################################################################
      #
      ################################################################

      ..  _OEChem_OEIFlavor_CXSMILES:

   .. oe:constnamespace:: OEIFlavor::CXSMILES

      The :oe:constns:`OEChem::OEIFlavor::CXSMILES` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OEParseSmiles` function.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_CXSMILES_Strict:

      .. oe:constant:: Strict

         Enables strict parsing mode for CXSMILES strings. The parser
         applies more rigorous sanity checking, rejecting malformed
         :term:`SMILES` strings that would be accepted by the non-strict
         parser. For example, ``C==C`` is accepted by default but rejected
         in strict mode.

      ..  _OEChem_OEIFlavor_CXSMILES_Canon:

      .. oe:constant:: Canon

         When set, the parser assumes the :term:`SMILES` string is
         well-formed and omits the usual kekulization step performed by
         :oe:func:`OEChem::OEKekulize`. This can speed up parsing of large
         databases, but bond orders may not be correctly assigned for
         aromatic molecules.

      ..  _OEChem_OEIFlavor_CXSMILES_Default:

      .. oe:constant:: DEFAULT

         No special parsing options are set. Both
         :oe:const:`OEChem::OEIFlavor::CXSMILES::Strict` and
         :oe:const:`OEChem::OEIFlavor::CXSMILES::Canon` flags are disabled.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::CXSMILES::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_FASTA:

   .. oe:constnamespace:: OEIFlavor::FASTA

      The :oe:constns:`OEChem::OEIFlavor::FASTA` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::FASTA` format file by
      the :oe:func:`OEChem::OEReadFASTAFile` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_FASTA_Default:

      .. oe:constant:: Default

         No special options are selected.

      ..  _OEChem_OEIFlavor_FASTA_CustomResidues:

      .. oe:constant:: CustomResidues

         Instructs the FASTA reader to interpret values surrounded in
         square brackets, ``[foo]``, as custom residues. The structure
         of these custom residues must first be registered with the
         :oe:func:`OEChem::OEAddCustomFASTAResidue` function.

         .. warning::

            This is an experimental API that may change in the future.

      ..  _OEChem_OEIFlavor_FASTA_EmbeddedSMILES:

      .. oe:constant:: EmbeddedSMILES

         Instructs the FASTA reader to interpret values surrounded in
         square brackets, ``[CCC]``, as :term:`SMILES` strings if a
         custom residue with the same name can not be found. The
         :term:`SMILES` can optionally contain attachment points back
         to the peptide backbone. For example, ``[[R1]CSC[R15]]``
         specifies to attach to the first and fifteenth residue in the
         peptide, effectively cyclizing the peptide.

         .. warning::

            This is an experimental API that may change in the future.

      ..  _OEChem_OEIFlavor_FASTA_AllMask:

      .. oe:constant:: AllMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::FASTA::CustomResidues` and
         :oe:const:`OEChem::OEIFlavor::FASTA::EmbeddedSMILES` flags.

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_Generic:

   .. oe:constnamespace:: OEIFlavor::Generic

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_Generic_OEAroModelDaylight:

      .. oe:constant:: OEAroModelDaylight

         This flag indicates that the Daylight aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEReadMolecule` high-level reader.

      ..  _OEChem_OEIFlavor_Generic_OEAroModelOpenEye:

      .. oe:constant:: OEAroModelOpenEye

         This flag indicates that the OpenEye aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEReadMolecule` high-level reader.

      ..  _OEChem_OEIFlavor_Generic_OEAroModelTripos:

      .. oe:constant:: OEAroModelTripos

         This flag indicates that the Tripos aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEReadMolecule` high-level reader.

      ..  _OEChem_OEIFlavor_Generic_OEAroModelMMFF:

      .. oe:constant:: OEAroModelMMFF

         This flag indicates that the MMFF aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEReadMolecule` high-level reader.

      ..  _OEChem_OEIFlavor_Generic_OEAroModelMDL:

      .. oe:constant:: OEAroModelMDL

         This flag indicates that the MDL aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEReadMolecule` high-level reader.

      ..  _OEChem_OEIFlavor_Generic_AroMask:

      .. oe:constant:: AroMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::Generic::OEAroModelDaylight`,
         :oe:const:`OEChem::OEIFlavor::Generic::OEAroModelOpenEye`,
         :oe:const:`OEChem::OEIFlavor::Generic::OEAroModelTripos`,
         :oe:const:`OEChem::OEIFlavor::Generic::OEAroModelMMFF` and
         :oe:const:`OEChem::OEIFlavor::Generic::OEAroModelMDL` flags.

         .. seealso::

            * :ref:`section_aromaticity_models` section
            * :oe:func:`OEChem::OEAssignAromaticFlags` function

      ..  _OEChem_OEIFlavor_Generic_Rings:

      .. oe:constant:: Rings

         This flag indicates the rings are perceived by the
         :oe:func:`OEChem::OEReadMolecule` high-level reader by calling
         the :oe:func:`OEChem::OEFindRingAtomsAndBonds` function.

      ..  _OEChem_OEIFlavor_GenericMask:

      .. oe:constant:: GenericMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::Generic::AroMask` and
         :oe:const:`OEChem::OEIFlavor::Generic::Rings` flags.

      ..  _OEChem_OEIFlavor_Generic_SpecificMask:

      .. oe:constant:: SpecificMask

         Bit mask covering all format-specific flavor bits (bits 0-13).
         This is the complement of
         :oe:const:`OEChem::OEIFlavor::Generic::GenericMask`.

      ..  _OEChem_OEIFlavor_Generic_Default:

      .. oe:constant:: DEFAULT

         Same as the :oe:const:`OEChem::OEIFlavor::Generic::Rings`
         constant. Ring perception is performed after every molecule
         read by the high-level :oe:func:`OEChem::OEReadMolecule` reader.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::Generic::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace: OEIFlavor::INCHI # THIS IS COMMENTED OUT
      The :oe:constns:`OEChem::OEIFlavor::INCHI` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::INCHI` format file by
      the :oe:func:`OEChem::OEParseInChI` function.
      This namespace contains the following constants:
      .. oe:constant:: Default

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_ISM:

   .. oe:constnamespace:: OEIFlavor::ISM

      The :oe:constns:`OEChem::OEIFlavor::ISM` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::ISM` format file by
      the :oe:func:`OEChem::OEParseSmiles` function.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_ISM_Default:

      .. oe:constant:: Default

         No special options are set.

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_MDL:

   .. oe:constnamespace:: OEIFlavor::MDL

      The :oe:constns:`OEChem::OEIFlavor::MDL` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::MDL` format file by
      the :oe:func:`OEChem::OEReadMDLFile` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_MDL_Default:

      .. oe:constant:: Default

         No special options are set. The
         :oe:const:`OEChem::OEIFlavor::MDL::FixBondMarks`,
         :oe:const:`OEChem::OEIFlavor::MDL::SuppressEmptyMolSkip`,
         :oe:const:`OEChem::OEIFlavor::MDL::SuppressImp2ExpENHSTE`, and
         :oe:const:`OEChem::OEIFlavor::MDL::ForceImp2ExpENHSTE` flags
         are all disabled.

      ..  _OEChem_OEIFlavor_MDL_FixBondMarks:

      .. oe:constant:: FixBondMarks

      This input flavor requests that the reader make an attempt
      to repair stereocenters that throw warnings due to issues identified
      by :oe:func:`OEChem::OEMDLStereoFromBondStereo`.  With this input flavor
      enabled, the warnings will continue to be issued to allow user inspection and verification
      of the modified bond marks.  However, once the corrected structure(s) have been rewritten
      with any format that captures bond stereomark information, a re-read of the structure(s)
      should emit fewer stereocenter correction warnings. This input flavor is not
      enabled for the default :oe:const:`OEChem::OEFormat::MDL` setting.

      ..  _OEChem_OEIFlavor_MDL_SuppressEmptyMolSkip:

      .. oe:constant:: SuppressEmptyMolSkip

      This input flavor suppresses the default action of skipping empty molecules
      in the input stream. This may be important in order to recover SDData stored on empty molecule records.

      ..  _OEChem_OEIFlavor_MDL_SuppressImp2ExpENHSTE:

      .. oe:constant:: SuppressImp2ExpENHSTE

      This input flavor suppresses any enhanced stereogroup implicit to explicit
      conversions for an input V3000 format molfile.

      ..  _OEChem_OEIFlavor_MDL_ForceImp2ExpENHSTE:

      .. oe:constant:: ForceImp2ExpENHSTE

      This input flavor performs implicit to explicit enhanced stereogroup
      conversions for an input V2000 or V3000 format molfile.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace: OEIFlavor::MF IGNORED
      This namespace contains the following constants:
      .. oe:constant:: Default

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_MMCIF:

   .. oe:constnamespace:: OEIFlavor::MMCIF

      The :oe:constns:`OEChem::OEIFlavor::MMCIF` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::MMCIF` format file by
      the :oe:func:`OEChem::OEReadCIFFile` low-level file reader.

      This namespace contains the following constants.

      ..  _OEChem_OEIFlavor_MMCIF_FormalCrg:

      .. oe:constant:: FormalCrg

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignFormalCharges` function to
         assign formal charges.

      ..  _OEChem_OEIFlavor_MMCIF_ImplicitH:

      .. oe:constant:: ImplicitH

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignImplicitHydrogens` function to
         assign implicit hydrogens.

      ..  _OEChem_OEIFlavor_MMCIF_BondOrder:

      .. oe:constant:: BondOrder

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEPerceiveBondOrders` function to
         perceive bond orders.

      ..  _OEChem_OEIFlavor_MMCIF_Rings:

      .. oe:constant:: Rings

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEFindRingAtomsAndBonds` function to
         determine ring structure.

      ..  _OEChem_OEIFlavor_MMCIF_Connect:

      .. oe:constant:: Connect

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEDetermineConnectivity` function to
         perceive bond connectivity from atomic coordinates.

      ..  _OEChem_OEIFlavor_MMCIF_SecStruct:

      .. oe:constant:: SecStruct

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEBio::OEPerceiveSecondaryStructure` function to
         assign secondary structure.

      ..  _OEChem_OEIFlavor_MMCIF_ALTLOC:

      .. oe:constant:: ALTLOC

         This flavor is required when :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>`
         is to be used so that all the atoms with alternate location codes
         are retained.

      ..  _OEChem_OEIFlavor_MMCIF_DEFAULT:

      .. oe:constant:: DEFAULT

         Combination of
         :oe:const:`OEChem::OEIFlavor::MMCIF::Connect`,
         :oe:const:`OEChem::OEIFlavor::MMCIF::Rings`,
         :oe:const:`OEChem::OEIFlavor::MMCIF::BondOrder`,
         :oe:const:`OEChem::OEIFlavor::MMCIF::ImplicitH`,
         :oe:const:`OEChem::OEIFlavor::MMCIF::SecStruct`,
         :oe:const:`OEChem::OEIFlavor::MMCIF::FormalCrg`, flags.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::MMCIF::DEFAULT` constant.

      ..  _OEChem_OEIFlavor_MMCIF_SpruceDefault:

      .. oe:constant:: SpruceDefault

         Combination of
         :oe:const:`OEChem::OEIFlavor::MMCIF::DEFAULT`,
         :oe:const:`OEChem::OEIFlavor::MMCIF::ALTLOC`, flags.

      ..  _OEChem_OEIFlavor_MMCIF_AllMask:

      .. oe:constant:: AllMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::MMCIF::DEFAULT` and
         :oe:const:`OEChem::OEIFlavor::MMCIF::ALTLOC` flags.

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_MMOD:

   .. oe:constnamespace:: OEIFlavor::MMOD

      The :oe:constns:`OEChem::OEIFlavor::MMOD` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::MMOD` format file by
      the :oe:func:`OEChem::OEReadMacroModelFile` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_MMOD_FormalCrg:

      .. oe:constant:: FormalCrg

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignFormalCharges` function to
         assign formal charges.

      ..  _OEChem_OEIFlavor_MMOD_Default:

      .. oe:constant:: Default

         No special options are set. Formal charge assignment via
         :oe:func:`OEChem::OEAssignFormalCharges` is disabled.

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_MOL2:

   .. oe:constnamespace:: OEIFlavor::MOL2

      The :oe:constns:`OEChem::OEIFlavor::MOL2` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecular file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::MOL2` format file by
      the :oe:func:`OEChem::OEReadMol2File` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_MOL2_M2H:

      .. oe:constant:: M2H

         Instructs the MOL2 file reader to treat the file as containing
         explicit hydrogen atoms. When set, the reader applies additional
         formal charge and resonance form corrections appropriate for
         structures with explicit hydrogens. This corresponds to the
         behavior of the :oe:const:`OEChem::OEFormat::MOL2H` format.

      ..  _OEChem_OEIFlavor_MOL2_Forcefield:

      .. oe:constant:: Forcefield

         This specifies a commonly used variant of MOL2, wherein the chemical element
         for an atom is inferred from the atom name, but not using the second
         character if it is capitalized. For example:

         - CA specifies carbon (not calcium)
         - Ca specifies calcium
         - NA specifies nitrogen (not sodium)
         - Na specifies sodium
         - HA specifies hydrogen (not hahnium)

         Exceptions were made for atom names beginning with FE, ZN, MG, MN,
         CL, and BR: these specify chemical elements Fe, Zn, Mg, Mn, Cl, and Br,
         respectively.

      ..  _OEChem_OEIFlavor_MOL2_AllMask:

      .. oe:constant:: AllMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::MOL2::M2H` and
         :oe:const:`OEChem::OEIFlavor::MOL2::Forcefield` flags.

      ..  _OEChem_OEIFlavor_MOL2_Default:

      .. oe:constant:: DEFAULT

         No special options are set. Neither
         :oe:const:`OEChem::OEIFlavor::MOL2::M2H` nor
         :oe:const:`OEChem::OEIFlavor::MOL2::Forcefield` is enabled.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::MOL2::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_MOL2H:

   .. oe:constnamespace:: OEIFlavor::MOL2H

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_MOL2H_M2H:

      .. oe:constant:: M2H

         Indicates that explicit hydrogen atoms are present in the file.
         When active, the reader applies formal charge and resonance form
         corrections appropriate for structures with explicit hydrogens.

      ..  _OEChem_OEIFlavor_MOL2H_AllMask:

      .. oe:constant:: AllMask

         Same as the :oe:const:`OEChem::OEIFlavor::MOL2H::M2H` constant;
         the only flag in this namespace.

      ..  _OEChem_OEIFlavor_MOL2H_Default:

      .. oe:constant:: DEFAULT

         Same as the :oe:const:`OEChem::OEIFlavor::MOL2H::M2H` constant.
         Explicit hydrogen treatment is always the default for
         :oe:const:`OEChem::OEFormat::MOL2H` format.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::MOL2H::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace: OEIFlavor::MOPAC IGNORED
      This namespace contains the following constants:
      .. oe:constant:: Default

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_OEB:

   .. oe:constnamespace:: OEIFlavor::OEB

      This namespace contains the following constants:

      .. oe:constant:: Default

         No special options are set.

   ..  _OEChem_OEIFlavor_OEZ:

   .. oe:constnamespace:: OEIFlavor::OEZ

      This namespace contains the following constants:

      .. oe:constant:: Default

         No special options are set.

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_PDB:

   .. oe:constnamespace:: OEIFlavor::PDB

      This namespace contains the following constants:

   ..  _OEChem_OEIFlavor_PDB_TER:

      .. oe:constant:: TER

         Controls whether the PDB file reader should separate consecutive molecules
         at `TER`_ records.
         :oe:const:`OEChem::OEIFlavor::PDB::TER` is off by default.

   ..  _OEChem_OEIFlavor_PDB_END:

      .. oe:constant:: END

         Controls whether the PDB file reader should separate consecutive molecules
         at `END`_  records.
         :oe:const:`OEChem::OEIFlavor::PDB::END` is on by default.

   ..  _OEChem_OEIFlavor_PDB_ENDM:

      .. oe:constant:: ENDM

         Controls whether the PDB file reader should separate consecutive molecules
         at `ENDM`_  records.

         :oe:const:`OEChem::OEIFlavor::PDB::ENDM` is on by default.

     ..  _OEChem_OEIFlavor_PDB_TerMask:

     .. oe:constant:: TerMask

         Combination of :oe:const:`OEChem::OEIFlavor::PDB::TER` and
         :oe:const:`OEChem::OEIFlavor::PDB::END` and
         :oe:const:`OEChem::OEIFlavor::PDB::ENDM` flags.

         .. note::

            By default, only :oe:const:`OEChem::OEIFlavor::PDB::END` and
            :oe:const:`OEChem::OEIFlavor::PDB::ENDM` are on (and
            :oe:const:`OEChem::OEIFlavor::PDB::TER` is off), meaning that
            different chains are read into the a single molecule, but
            different NMR models and concatenated PDB files are treated as
            sequential molecules.

            If :oe:const:`OEChem::OEIFlavor::PDB::END`, :oe:const:`OEChem::OEIFlavor::PDB::ENDM`
            and :oe:const:`OEChem::OEIFlavor::PDB::TER` are all turned off, all of
            the  `ATOM`_ and `HETATM`_ records in a single PDB file will be read into a
            single :ref:`OEMolBase <OEChem_OEMolBase>`.

     ..  _OEChem_OEIFlavor_PDB_ALL:

      .. oe:constant:: ALL

         It used to indicate that all of the atom records in the input
         file should be read into the :ref:`OEMolBase <OEChem_OEMolBase>`. By
         default, the :oe:func:`OEChem::OEReadPDBFile` function
         ignores/omits `ATOM`_ and `HETATM`_ records that represent
         pseudo or dummy atoms and/or alternate conformations.  Without
         :oe:const:`OEChem::OEIFlavor::PDB::ALL`, the PDB file reader ignores
         all atoms whose alternate location indicator is other than ``'
         '``, ``A`` or ``1``, all atoms with atom names beginning ``"
         Q"``, all atoms with residue name ``"DUM"``, and all atoms with
         coordinates 9999.000, 9999.000, 9999.000 (as used by XPLOR/CNS
         to represent dummy atoms).

     ..  _OEChem_OEIFlavor_PDB_ALTLOC:

      .. oe:constant:: ALTLOC

         Combination of :oe:const:`OEChem::OEIFlavor::Generic::Default`,
         :oe:const:`OEChem::OEIFlavor::PDB::Default`, and
         :oe:const:`OEChem::OEIFlavor::PDB::ALL` flags.
         This flavor is required when :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>`
         is to be used so that all the atoms with alternate location codes
         are retained.

     ..  _OEChem_OEIFlavor_PDB_DATA:

      .. oe:constant:: DATA

         Controls whether the PDB file reader preserves the PDB file's header data
         as OEMolBase's generic data.
         This option currently preserves the following records:

         * Title section: `AUTHOR`_,  `CAVEAT`_, `COMPND`_, `EXPDTA`_, `HEADER`_, `JRNL`_,  `KEYWDS`_,
           `OBSLTE`_,  `SOURCE`_, `SPRSDE`_,   `REMARK`_, `REVDAT`_,  `TITLE`_
         * Primary structure section: `DBREF`_, `MODRES`_, `SEQRES`_, `SEQADV`_
         * Heterogen section:   `FORMUL`_, `HET`_, `HETNAM`_, `HETSYM`_
         * Secondary structure section:  `HELIX`_, `SHEET`_, `TURN`_
         * Connectivity annotation section:  `SSBOND`_
         * Miscellaneous features section:  `SITE`_
         * Crystallographic and coordinate transformation section: `CRYST1`_, `MTRIX1`_, `MTRIX2`_,
           `MTRIX3`_, `ORIGX1`_, `ORIGX2`_, `ORIGX3`_, `SCALE1`_, `SCALE2`_, `SCALE3`_

         .. note::

            Modifying or reordering the molecule may invalidate the atom
            serial numbers used in some of the PDB records.

     ..  _OEChem_OEIFlavor_PDB_CHARGE:

      .. oe:constant:: CHARGE

         It is used to indicate that the contents of the b-factor column
         in the input PDB file contains a partial charge, and should be
         stored in the 'partial charge' property of an atom, instead of
         the 'b-factor' property.  This value can then be retrieved using
         the :oe:meth:`OEChem::OEAtomBase::GetPartialCharge` method.

     ..  _OEChem_OEIFlavor_PDB_RADIUS:

      .. oe:constant:: RADIUS

         It is used to indicate that the contents of the occupancy column in
         the input PDB file contains a radius, and should be stored in
         the 'radius' property of an atom instead of the 'occupancy'
         property.  This value can then be retrieved using the
         :oe:meth:`OEChem::OEAtomBase::GetRadius` method.

     ..  _OEChem_OEIFlavor_PDB_DELPHI:

      .. oe:constant:: DELPHI

         Combinations of :oe:const:`OEChem::OEIFlavor::PDB::CHARGE` and
         :oe:const:`OEChem::OEIFlavor::PDB::RADIUS` flags.

     ..  _OEChem_OEIFlavor_PDB_FORMALCHARGE:

      .. oe:constant:: FORMALCHARGE

         Controls whether the PDB reader should read the formal charge
         of the atom from column 79 and 80. Note, this flavor is not
         turned on default because the subsequent perception steps
         would not take this formal charge into account when filling
         valences with bonds and hydrogens.

     ..  _OEChem_OEIFlavor_PDB_SecStruct:

      .. oe:constant:: SecStruct

         This controls whether protein secondary structure is perceived after
         a file is read in.  It is on by default.  If this flavor is off, secondary
         structure information specified in the input PDB file (through SHEET and
         HELIX records) is retained.

     ..  _OEChem_OEIFlavor_PDB_BasicMask:

      .. oe:constant:: BasicMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::PDB::TER`,
         :oe:const:`OEChem::OEIFlavor::PDB::END`,
         :oe:const:`OEChem::OEIFlavor::PDB::ENDM`,
         :oe:const:`OEChem::OEIFlavor::PDB::ALL`,
         :oe:const:`OEChem::OEIFlavor::PDB::DATA`,
         :oe:const:`OEChem::OEIFlavor::PDB::CHARGE`,
         :oe:const:`OEChem::OEIFlavor::PDB::RADIUS` and
         :oe:const:`OEChem::OEIFlavor::PDB::FORMALCHARGE` flags.
         These are the flags honored by the low-level
         :oe:func:`OEChem::OEReadPDBFile` reader.

     ..  _OEChem_OEIFlavor_PDB_FormalCrg:

      .. oe:constant:: FormalCrg

         .. note::

            This flag is only relevant in the high-level file reader
            (:oe:func:`OEChem::OEReadMolecule`) and not in :oe:func:`OEChem::OEReadPDBFile`.

     ..  _OEChem_OEIFlavor_PDB_ImplicitH:

      .. oe:constant:: ImplicitH

         .. note::

            This flag is only relevant in the high-level file reader
            (:oe:func:`OEChem::OEReadMolecule`) and not in :oe:func:`OEChem::OEReadPDBFile`.

     ..  _OEChem_OEIFlavor_PDB_BondOrder:

      .. oe:constant:: BondOrder

         .. note::

            This flag is only relevant in the high-level file reader
            (:oe:func:`OEChem::OEReadMolecule`) and not in :oe:func:`OEChem::OEReadPDBFile`.

     ..  _OEChem_OEIFlavor_PDB_Rings:

      .. oe:constant:: Rings

         .. note::

            This flag is only relevant in the high-level file reader
            (:oe:func:`OEChem::OEReadMolecule`) and not in :oe:func:`OEChem::OEReadPDBFile`.

     ..  _OEChem_OEIFlavor_PDB_Connect:

      .. oe:constant:: Connect

         .. note::

            This flag is only relevant in the high-level file reader
            (:oe:func:`OEChem::OEReadMolecule`) and not in :oe:func:`OEChem::OEReadPDBFile`.

     ..  _OEChem_OEIFlavor_PDB_ExtraMask:

      .. oe:constant:: ExtraMask

         .. note::

            This flag is only relevant in the high-level file reader
            (:oe:func:`OEChem::OEReadMolecule`) and not in :oe:func:`OEChem::OEReadPDBFile`.

     ..  _OEChem_OEIFlavor_PDB_AllMask:

      .. oe:constant:: AllMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::PDB::BasicMask` and
         :oe:const:`OEChem::OEIFlavor::PDB::ExtraMask` flags.

     ..  _OEChem_OEIFlavor_PDB_Default:

      .. oe:constant:: DEFAULT

         Combination of
         :oe:const:`OEChem::OEIFlavor::PDB::Connect`,
         :oe:const:`OEChem::OEIFlavor::PDB::Rings`,
         :oe:const:`OEChem::OEIFlavor::PDB::BondOrder`,
         :oe:const:`OEChem::OEIFlavor::PDB::ImplicitH`,
         :oe:const:`OEChem::OEIFlavor::PDB::FormalCrg`,
         :oe:const:`OEChem::OEIFlavor::PDB::ENDM` and
         :oe:const:`OEChem::OEIFlavor::PDB::END` 
         :oe:const:`OEChem::OEIFlavor::PDB::DATA`, flags.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::PDB::DEFAULT` constant.

     ..  _OEChem_OEIFlavor_PDB_SpruceDefault:

      .. oe:constant:: SpruceDefault

         Combination of
         :oe:const:`OEChem::OEIFlavor::PDB::DEFAULT`,
         :oe:const:`OEChem::OEIFlavor::PDB::ALTLOC`, flags.
 
   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_RDF:

   .. oe:constnamespace:: OEIFlavor::RDF

      The :oe:constns:`OEChem::OEIFlavor::RDF` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::RDF` format file by
      the :oe:func:`OEChem::OEReadMDLFile` low-level file reader.

      ..  _OEChem_OEIFlavor_RDF_Default:

      .. oe:constant:: Default

         No special options are set. The
         :oe:const:`OEChem::OEIFlavor::RDF::FixBondMarks`,
         :oe:const:`OEChem::OEIFlavor::RDF::SuppressEmptyMolSkip`,
         :oe:const:`OEChem::OEIFlavor::RDF::SuppressImp2ExpENHSTE`, and
         :oe:const:`OEChem::OEIFlavor::RDF::ForceImp2ExpENHSTE` flags
         are all disabled.

      ..  _OEChem_OEIFlavor_RDF_FixBondMarks:

      .. oe:constant:: FixBondMarks

      This input flavor requests that the reader make an attempt
      to repair stereocenters that throw warnings due to issues identified
      by :oe:func:`OEChem::OEMDLStereoFromBondStereo`.  With this input flavor
      enabled, the warnings will continue to be issued to allow user inspection and verification
      of the modified bond marks.  However, once the corrected structure(s) have been rewritten
      with any format that captures bond stereomark information, a re-read of the structure(s)
      should emit fewer stereocenter correction warnings. This input flavor is not
      enabled for the default :oe:const:`OEChem::OEFormat::RDF` setting.

      ..  _OEChem_OEIFlavor_RDF_SuppressEmptyMolSkip:

      .. oe:constant:: SuppressEmptyMolSkip

      This input flavor suppresses the default action of skipping empty molecules
      in the input stream. This may be important in order to recover SDData stored on empty molecule records.

      ..  _OEChem_OEIFlavor_RDF_SuppressImp2ExpENHSTE:

      .. oe:constant:: SuppressImp2ExpENHSTE

      This input flavor suppresses any enhanced stereogroup implicit to explicit
      conversions for an input V3000 format RDFile.

      ..  _OEChem_OEIFlavor_RDF_ForceImp2ExpENHSTE:

      .. oe:constant:: ForceImp2ExpENHSTE

      This input flavor performs implicit to explicit enhanced stereogroup
      conversions for an input RDFile.

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_SDF:

   .. oe:constnamespace:: OEIFlavor::SDF

      The :oe:constns:`OEChem::OEIFlavor::SDF` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::SDF` format file by
      the :oe:func:`OEChem::OEReadMDLFile` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_SDF_Default:

      .. oe:constant:: Default

         No special options are set. The
         :oe:const:`OEChem::OEIFlavor::SDF::FixBondMarks`,
         :oe:const:`OEChem::OEIFlavor::SDF::SuppressEmptyMolSkip`,
         :oe:const:`OEChem::OEIFlavor::SDF::SuppressImp2ExpENHSTE`, and
         :oe:const:`OEChem::OEIFlavor::SDF::ForceImp2ExpENHSTE` flags
         are all disabled.

      ..  _OEChem_OEIFlavor_SDF_FixBondMarks:

      .. oe:constant:: FixBondMarks

      This input flavor requests that the reader make an attempt
      to repair stereocenters that throw warnings due to issues identified
      by :oe:func:`OEChem::OEMDLStereoFromBondStereo`.  With this input flavor
      enabled, the warnings will continue to be issued to allow user inspection and verification
      of the modified bond marks.  However, once the corrected structure(s) have been rewritten
      with any format that captures bond stereomark information, a re-read of the structure(s)
      should emit fewer stereocenter correction warnings. This input flavor is not
      enabled for the default :oe:const:`OEChem::OEFormat::SDF` setting.

      ..  _OEChem_OEIFlavor_SDF_SuppressEmptyMolSkip:

      .. oe:constant:: SuppressEmptyMolSkip

      This input flavor suppresses the default action of skipping empty molecules
      in the input stream. This may be important in order to recover SDData stored on empty molecule records.

      ..  _OEChem_OEIFlavor_SDF_SuppressImp2ExpENHSTE:

      .. oe:constant:: SuppressImp2ExpENHSTE

      This input flavor suppresses any enhanced stereogroup implicit to explicit
      conversions for an input V3000 format SDFile.

      ..  _OEChem_OEIFlavor_SDF_ForceImp2ExpENHSTE:

      .. oe:constant:: ForceImp2ExpENHSTE

      This input flavor performs implicit to explicit enhanced stereogroup
      conversions for an input V2000 or V3000 format SDFile.

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_SKC:

   .. oe:constnamespace:: OEIFlavor::SKC

      The :oe:constns:`OEChem::OEIFlavor::SKC` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::SKC` format file by
      the :oe:func:`OEChem::OEReadSketchFile` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_SKC_Default:

      .. oe:constant:: Default

         No special options are set.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace: OEIFlavor::SLN  IGNORED
      This namespace contains the following constants:
      .. oe:constant:: Default

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_SMI:

   .. oe:constnamespace:: OEIFlavor::SMI

      The :oe:constns:`OEChem::OEIFlavor::SMI` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OEParseSmiles` function.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_SMI_Strict:

      .. oe:constant:: Strict

         Enables strict parsing mode when processing :term:`SMILES`
         strings. The parser applies more rigorous sanity checking,
         rejecting malformed strings that the non-strict parser would
         accept. For example, ``C==C`` is accepted by default but
         rejected in strict mode.

      ..  _OEChem_OEIFlavor_SMI_Canon:

      .. oe:constant:: Canon

         When set, the parser assumes the :term:`SMILES` string is
         well-formed and omits the usual kekulization step performed by
         :oe:func:`OEChem::OEKekulize`. This can speed up parsing of
         large databases, but bond orders may not be correctly assigned
         for aromatic molecules.

      ..  _OEChem_OEIFlavor_SMI_Default:

      .. oe:constant:: DEFAULT

         No special options are set. Both
         :oe:const:`OEChem::OEIFlavor::SMI::Strict` and
         :oe:const:`OEChem::OEIFlavor::SMI::Canon` flags are disabled.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::SMI::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_USM:

   .. oe:constnamespace:: OEIFlavor::USM

      The :oe:constns:`OEChem::OEIFlavor::USM` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OEParseSmiles` function.

      This namespace contains constants.

      ..  _OEChem_OEIFlavor_USM_Default:

      .. oe:constant:: Default

         No special options are set.

   .. ################################################################
      #
      ################################################################

   ..  _OEChem_OEIFlavor_XYZ:

   .. oe:constnamespace:: OEIFlavor::XYZ

      The :oe:constns:`OEChem::OEIFlavor::XYZ` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::XYZ` format file by
      the :oe:func:`OEChem::OEReadXYZFile` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_XYZ_FormalCrg:

      .. oe:constant:: FormalCrg

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignFormalCharges` function to
         assign formal charges.

      ..  _OEChem_OEIFlavor_XYZ_ImplicitH:

      .. oe:constant:: ImplicitH

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignImplicitHydrogens` function to
         assign implicit hydrogens.

      ..  _OEChem_OEIFlavor_XYZ_BondOrder:

      .. oe:constant:: BondOrder

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEPerceiveBondOrders` function to
         perceive bond orders.

      ..  _OEChem_OEIFlavor_XYZ_Rings:

      .. oe:constant:: Rings

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEFindRingAtomsAndBonds` function to
         determine ring structure.

      ..  _OEChem_OEIFlavor_XYZ_Connect:

      .. oe:constant:: Connect

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEDetermineConnectivity` function to
         perceive bond connectivity from atomic coordinates. Since
         :oe:const:`OEChem::OEFormat::XYZ` files contain only atomic
         positions without explicit bond information, this flag is
         required to establish bonding.

      ..  _OEChem_OEIFlavor_XYZ_ExtraMask:

      .. oe:constant:: ExtraMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::XYZ::Connect`,
         :oe:const:`OEChem::OEIFlavor::XYZ::Rings`,
         :oe:const:`OEChem::OEIFlavor::XYZ::BondOrder`,
         :oe:const:`OEChem::OEIFlavor::XYZ::ImplicitH` and
         :oe:const:`OEChem::OEIFlavor::XYZ::FormalCrg` flags.

      ..  _OEChem_OEIFlavor_XYZ_Default:

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::XYZ::ExtraMask` constant.


.. oe:namespace:: OEChem

.. _OEChem_OEInteractionStyle:

.. oe:constnamespace:: OEInteractionStyle

   The OEInteractionStyle namespace encodes symbolic constants representing the 
   different hydrogen interaction styles for the :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`.

   This namespace contains constants.

   .. oe:constant:: BEGIN

   .. oe:constant:: Bumps

   .. oe:constant:: END

   .. oe:constant:: IntermolecularHBonds

      .. figure:: oechemtk/images/interactionStyle/inter.*
         :align:  center

   .. oe:constant:: IntramolecularHBonds

      .. figure:: oechemtk/images/interactionStyle/intra.*
         :align:  center

   .. oe:constant:: Off

      .. figure:: oechemtk/images/interactionStyle/off.*
         :align:  center

   .. oe:constant:: UnsatisfiedHBonds



.. oe:namespace:: OEChem

.. oe:constnamespace:: OELingoType

   This namespace contains constants.

   .. oe:constant:: Undefined
   

   .. oe:constant:: IsoSmiMap
   

   .. oe:constant:: Default
   



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEMCMolType

   The :oe:constns:`OEChem::OEMCMolType` namespace encodes symbolic constants
   representing  specific :ref:`OEMCMolBase <OEChem_OEMCMolBase>` class implementation types.

   .. seealso::

      * :oe:meth:`OEChem::OEMol::Constructors` function
      * :oe:func:`OEChem::OENewMCMolBase` function

   This namespace contains the following constants:

   .. oe:constant:: Cartesian
   
      The same as :oe:const:`OEChem::OEMCMolType::FloatCartesian` and
      :oe:const:`OEChem::OEMCMolType::OEDefault`. The default
      :ref:`OEMol <OEChem_OEMol>` implementation. Conformer coordinates are
      stored in 32-bit ``float`` precision representation.

   .. oe:constant:: DoubleCartesian

      Conformer coordinates will be stored in 64-bit ``double``
      precision. Useful by applications requiring a higher degree of
      precision, like numerical optimization or quantum
      mechanics. Writing out molecules of this type to
      :oe:const:`OEChem::OEFormat::XYZ` or
      :oe:const:`OEChem::OEFormat::OEB` file formats will maintain this
      level of precision. Even rotor-offset-compressed OEB files can
      maintain precision to the 15th decimal place when using a
      ``DoubleCartesian`` :ref:`OEMol <OEChem_OEMol>`.

   .. oe:constant:: FloatCartesian

      The same as :oe:const:`OEChem::OEMCMolType::Cartesian` and
      :oe:const:`OEChem::OEMCMolType::OEDefault`. The default
      :ref:`OEMol <OEChem_OEMol>` implementation. Conformer coordinates are
      stored in 32-bit ``float`` precision representation.

   .. oe:constant:: HalfFloatCartesian

      Conformer coordinates will be stored in 16-bit
      :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` precision defined by the IEEE
      754-2008 standard. Useful for applications that need to conserve
      memory or file size. Writing out molecules of this type to
      :oe:const:`OEChem::OEFormat::OEB` will only preserve 4 decimal
      places of precision in conformer
      coordinates. Rotor-offset-compressed OEB files will only
      preserve up to the 2nd decimal place for conformer coordinates. 

   .. oe:constant:: LongDoubleCartesian

      Conformer coordinates will be stored in ``long double``
      precision. ``long double`` precision is implementation defined,
      only defined to be greater than or equal to 64-bits. Writing out
      molecules of this type to :oe:const:`OEChem::OEFormat::OEB` first
      convert to ``double`` precision and only 64-bits of precision
      will be preserved.

   .. oe:constant:: OEDBMCMol
   
      An implementation of :ref:`OEMCMolBase <OEChem_OEMCMolBase>` designed to
      have a very small memory footprint when compressed using the
      :oe:meth:`OEChem::OEMolBase::Compress` method. Compressed
      molecules are very fragile, the only operations that are valid
      is destruction, :oe:meth:`OEChem::OEMolBase::Clear`, and
      :oe:meth:`OEChem::OEMolBase::UnCompress`. Using any other method
      is undefined. Users should uncompress the molecule before
      working with it.

   .. oe:constant:: OEDefault

      The same as :oe:const:`OEChem::OEMCMolType::Cartesian` and
      :oe:const:`OEChem::OEMCMolType::FloatCartesian`. The default
      :ref:`OEMol <OEChem_OEMol>` implementation. Conformer coordinates are
      stored in 32-bit ``float`` precision representation.

   .. oe:constant:: Undefined

      Used to signal errors and undefined behavior. 

   .. oe:constant:: MaxType
   
      How many unique numerical constants are in this namespace. 


.. oe:namespace:: OEChem

.. oe:constnamespace:: OEMCSType

   The :oe:constns:`OEChem::OEMCSType` namespace encodes symbolic constants
   representing MCS search types.

   .. seealso::

      * :ref:`OEMCSSearch <OEChem_OEMCSSearch>` class
      * :ref:`section_patternmatch_mcss_rearchmode` section

   This namespace contains the following constants:

   .. oe:constant:: Exhaustive
   
      This constraint indicates that the MCS search is based on a
      back-tracking algorithm in which the atom mapping of two
      structures is systematically extended.

   .. oe:constant:: Approximate

      This constraint indicates that the MCS search is based on
      traversing through pre-defined paths of the query structure and
      trying to map the visited atom into the target.

   .. oe:constant:: Default
   
      Same as the :oe:const:`OEChem::OEMCSType::Exhaustive` constant.


.. oe:namespace:: OEChem

.. _OEMDLQueryOpts_constraints:

.. oe:constnamespace:: OEMDLQueryOpts

   The :oe:constns:`OEChem::OEMDLQueryOpts` namespace encodes symbolic
   constants used as bit-masks to indicate how to interpret MDL query
   files or MDL reaction imported by
   :oe:func:`OEChem::OEReadMDLQueryFile` and
   :oe:func:`OEChem::OEReadMDLReactionQueryFile` functions,
   respectively.

   This namespace contains the following constants:

   .. oe:constant:: Default
   
      Only constraints explicitly specified in the MDL file are added
      to the :ref:`OEQMolBase <OEChem_OEQMolBase>` query structure with the
      the :oe:const:`OEChem::OEMDLQueryOpts::Optimize` option.
 
   .. oe:constant:: SuppressExplicitH
   
      Controls how the explicit hydrogens of the query are
      matched to the explicit/implicit hydrogens of the target structures.

      .. seealso::

         * :ref:`section_mdlqueries_features` section for the supported MDL query features
         * :ref:`section_mdlqueries_interpret` section
         * :ref:`section_mdlqueries_hydrogens` section

   .. oe:constant:: AddBondAliphaticConstraint
   
      Controls whether or not map an aliphatic query bond only to 
      aliphatic bonds in the target structure during the substructure search.

      .. seealso::

         * :ref:`section_mdlqueries_interpret` section

   .. oe:constant:: AddBondTopologyConstraint

      By default, ring bonds in the query structure can only be mapped to ring bonds in the target,
      and chain bonds in the query can be mapped to both ring and chain bonds.

      The :oe:const:`OEChem::OEMDLQueryOpts::AddBondTopologyConstraint` option enables enforcement
      of bond topology constraint during substructure search i.e. ring bonds in the query can
      only be mapped to ring bonds, and chain bonds in the query can
      only be mapped to chain bonds.

      .. seealso::

         * :ref:`section_mdlqueries_interpret` section

   .. oe:constant:: ExactMatchStarAtoms
   
      By default, R-group atoms and `*` atoms (:oe:const:`OEChem::OEElemNo::Du`)
      match like an "any"-atom - matching atoms of any type for both :term:`SMARTS` and MDL queries.
      Adding this non-default option flag will force `*atoms` that are neither
      pseudo-atoms nor R-group atoms to match only explicit `*` atoms in the target.

      .. seealso::

         * :ref:`section_mdlqueries_interpret` section

   .. oe:constant:: MatchAtomStereo

      By default, atom stereo information is not considered when building
      query molecules, allowing unconditional match between any atom 
      configuration.

      When  the :oe:const:`OEChem::OEMDLQueryOpts::MatchAtomStereo`
      option is turned on, an S/R atom stereo configuration in the
      query will match only to any S/R configuration in the target
      molecule, but not to a R/S (opposite) or an  unspecified one.
      If an atom stereo configuration is undefined in the query, 
      it can match to any atom regardless to its stereo configuration.

      .. seealso::

         * :ref:`section_mdlqueries_interpret` section

   .. oe:constant:: MatchIsotope

      By default, the isotopic information (*i.e.* lines starting with
      ``M ISO`` in the MDL query file) is ignored.  

      When the :oe:const:`OEChem::OEMDLQueryOpts::MatchIsotope` option is
      turned on, a query isotope atoms can be match to a target atom only if
      it has the same atomic mass.
      If the query atom has no specified isotope number, it will still match 
      to any target atom regardless of its atomic mass.

      .. seealso::

         * :ref:`section_mdlqueries_interpret` section

   .. oe:constant:: Optimize

      When the :oe:const:`OEChem::OEMDLQueryOpts::Optimize` option is
      turned on, the atom and bond expressions are optimized for
      substructure search.

   .. oe:constant:: ReactionQuery
   
      MDL reaction files are interpreted differently from MDL query files. 
      The usage of :oe:const:`OEChem::OEMDLQueryOpts::ReactionQuery` option is 
      necessary when a MDL reaction is imported with the
      :oe:func:`OEChem::OEReadMDLReactionQueryFile` function.     
   
      .. seealso::

         * :ref:`subsection_reactions_libgen_MDL` section


.. oe:namespace:: OEChem

.. oe:constnamespace:: OEMMFFType

   This namespace contains constants.

   .. oe:constant:: UNK
   

   .. oe:constant:: CR
   

   .. oe:constant:: CC
   

   .. oe:constant:: CSP2
   

   .. oe:constant:: CO
   

   .. oe:constant:: CN
   

   .. oe:constant:: CGD
   

   .. oe:constant:: COR
   

   .. oe:constant:: CON
   

   .. oe:constant:: COO
   

   .. oe:constant:: COON
   

   .. oe:constant:: COOO
   

   .. oe:constant:: COS
   

   .. oe:constant:: CS
   

   .. oe:constant:: CSN
   

   .. oe:constant:: CSO2
   

   .. oe:constant:: CSO
   

   .. oe:constant:: CSS
   

   .. oe:constant:: CP
   

   .. oe:constant:: CSP
   

   .. oe:constant:: C
   

   .. oe:constant:: DUMMY

   .. oe:constant:: HC
   

   .. oe:constant:: HSI
   

   .. oe:constant:: O
   

   .. oe:constant:: OR
   

   .. oe:constant:: OCO
   

   .. oe:constant:: OCC
   

   .. oe:constant:: OCN
   

   .. oe:constant:: OCS
   

   .. oe:constant:: ONO2
   

   .. oe:constant:: ONO
   

   .. oe:constant:: OSO3
   

   .. oe:constant:: OSO2
   

   .. oe:constant:: OSO
   

   .. oe:constant:: OSO_
   

   .. oe:constant:: OS
   

   .. oe:constant:: OPO3
   

   .. oe:constant:: OPO2
   

   .. oe:constant:: OPO
   

   .. oe:constant:: OP
   

   .. oe:constant:: OC
   

   .. oe:constant:: OCN_
   

   .. oe:constant:: OCR
   

   .. oe:constant:: OCO_
   

   .. oe:constant:: ON
   

   .. oe:constant:: OS_
   

   .. oe:constant:: OS__
   

   .. oe:constant:: NR
   

   .. oe:constant:: NC
   

   .. oe:constant:: NN
   

   .. oe:constant:: NCO
   

   .. oe:constant:: NCS
   

   .. oe:constant:: NNC
   

   .. oe:constant:: NNN
   

   .. oe:constant:: F
   

   .. oe:constant:: CL
   

   .. oe:constant:: Cl
   

   .. oe:constant:: BR
   

   .. oe:constant:: Br
   

   .. oe:constant:: I
   

   .. oe:constant:: S
   

   .. oe:constant:: SC
   

   .. oe:constant:: SO
   

   .. oe:constant:: SN
   

   .. oe:constant:: SO2
   

   .. oe:constant:: SO2N
   

   .. oe:constant:: SO3
   

   .. oe:constant:: SO4
   

   .. oe:constant:: SO2_
   

   .. oe:constant:: SNO
   

   .. oe:constant:: SI
   

   .. oe:constant:: CR4R
   

   .. oe:constant:: HOR
   

   .. oe:constant:: HO
   

   .. oe:constant:: CR3R
   

   .. oe:constant:: HNR
   

   .. oe:constant:: HPYL
   

   .. oe:constant:: H3N
   

   .. oe:constant:: HNOX
   

   .. oe:constant:: HOCO
   

   .. oe:constant:: HOP
   

   .. oe:constant:: PO4
   

   .. oe:constant:: PO3
   

   .. oe:constant:: PO2
   

   .. oe:constant:: PO
   

   .. oe:constant:: PTET
   

   .. oe:constant:: P
   

   .. oe:constant:: HNC
   

   .. oe:constant:: HNN
   

   .. oe:constant:: HNCO
   

   .. oe:constant:: HNCS
   

   .. oe:constant:: HNCC
   

   .. oe:constant:: HNCN
   

   .. oe:constant:: HNNC
   

   .. oe:constant:: HNNN
   

   .. oe:constant:: HNSO
   

   .. oe:constant:: HNC_
   

   .. oe:constant:: HSP2
   

   .. oe:constant:: HOCC
   

   .. oe:constant:: HOCN
   

   .. oe:constant:: CR4E
   

   .. oe:constant:: HOH
   

   .. oe:constant:: O2CM
   

   .. oe:constant:: OXN
   

   .. oe:constant:: ON_
   

   .. oe:constant:: O2N
   

   .. oe:constant:: O2NO
   

   .. oe:constant:: O3N
   

   .. oe:constant:: OS___
   

   .. oe:constant:: O2S
   

   .. oe:constant:: O3S
   

   .. oe:constant:: O4S
   

   .. oe:constant:: OSMS
   

   .. oe:constant:: OP_
   

   .. oe:constant:: O2P
   

   .. oe:constant:: O3P
   

   .. oe:constant:: O4P
   

   .. oe:constant:: O4CL
   

   .. oe:constant:: O4Cl
   

   .. oe:constant:: HOS
   

   .. oe:constant:: NR_
   

   .. oe:constant:: OM
   

   .. oe:constant:: OM2
   

   .. oe:constant:: HNR_
   

   .. oe:constant:: HIM
   

   .. oe:constant:: HPD_
   

   .. oe:constant:: HNN_
   

   .. oe:constant:: HNC__
   

   .. oe:constant:: HGD_
   

   .. oe:constant:: CB
   

   .. oe:constant:: NPYD
   

   .. oe:constant:: NPYL
   

   .. oe:constant:: NCC
   

   .. oe:constant:: NCN
   

   .. oe:constant:: NCP
   

   .. oe:constant:: NCC_
   

   .. oe:constant:: CO2M
   

   .. oe:constant:: CS2M
   

   .. oe:constant:: NSP
   

   .. oe:constant:: NSO2
   

   .. oe:constant:: NSO3
   

   .. oe:constant:: NCN_
   

   .. oe:constant:: STHI
   

   .. oe:constant:: NO2
   

   .. oe:constant:: NO3
   

   .. oe:constant:: NO
   

   .. oe:constant:: NAZT
   

   .. oe:constant:: NSO
   

   .. oe:constant:: O_
   

   .. oe:constant:: HO_
   

   .. oe:constant:: O__
   

   .. oe:constant:: HO__
   

   .. oe:constant:: N_
   

   .. oe:constant:: NC_
   

   .. oe:constant:: NN_
   

   .. oe:constant:: NCN__
   

   .. oe:constant:: NGD_
   

   .. oe:constant:: CGD_
   

   .. oe:constant:: CNN_
   

   .. oe:constant:: NPD_
   

   .. oe:constant:: OFUR
   

   .. oe:constant:: C__
   

   .. oe:constant:: NR__
   

   .. oe:constant:: NM
   

   .. oe:constant:: C5A
   

   .. oe:constant:: C5B
   

   .. oe:constant:: N5A
   

   .. oe:constant:: N5B
   

   .. oe:constant:: N2OX
   

   .. oe:constant:: N3OX
   

   .. oe:constant:: NPOX
   

   .. oe:constant:: OH2
   

   .. oe:constant:: HS
   

   .. oe:constant:: HSN
   

   .. oe:constant:: HP
   

   .. oe:constant:: SP
   

   .. oe:constant:: SM
   

   .. oe:constant:: SSMO
   

   .. oe:constant:: SO2M
   

   .. oe:constant:: SSOM
   

   .. oe:constant:: SO_
   

   .. oe:constant:: PC
   

   .. oe:constant:: N5M
   

   .. oe:constant:: CLO4
   

   .. oe:constant:: C5
   

   .. oe:constant:: N5
   

   .. oe:constant:: CIM
   

   .. oe:constant:: NIM
   

   .. oe:constant:: N5A_
   

   .. oe:constant:: N5B_
   

   .. oe:constant:: N5_
   

   .. oe:constant:: N5AX
   

   .. oe:constant:: N5BX
   

   .. oe:constant:: N5OX
   

   .. oe:constant:: FE2
   

   .. oe:constant:: FE3
   

   .. oe:constant:: F_
   

   .. oe:constant:: CL_
   

   .. oe:constant:: BR_
   

   .. oe:constant:: LI
   

   .. oe:constant:: NA
   

   .. oe:constant:: K
   

   .. oe:constant:: ZN2
   

   .. oe:constant:: CA2
   

   .. oe:constant:: CU1
   

   .. oe:constant:: CU2
   

   .. oe:constant:: MG2
   

   .. oe:constant:: HOM
   

   .. oe:constant:: HOCS
   

   .. oe:constant:: HON
   

   .. oe:constant:: HX
   

   .. oe:constant:: HNO
   

   .. oe:constant:: HN5_
   

   .. oe:constant:: NPO2
   

   .. oe:constant:: NPO3
   

   .. oe:constant:: HNPO
   

   .. oe:constant:: HNO2
   

   .. oe:constant:: HNM
   

   .. oe:constant:: CONN
   

   .. oe:constant:: S2CM
   

   .. oe:constant:: SE
   

   .. oe:constant:: Se
   

   .. oe:constant:: B
   

   .. oe:constant:: HSE
   

   .. oe:constant:: HSe
   

    .. oe:constant:: CION

   .. oe:constant:: MAXTYPE
   



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEMModType

   This namespace contains constants.

   .. oe:constant:: C1
   

   .. oe:constant:: C2
   

   .. oe:constant:: C3
   

   .. oe:constant:: CA
   

   .. oe:constant:: CB
   

   .. oe:constant:: CC
   

   .. oe:constant:: CD
   

   .. oe:constant:: CE
   

   .. oe:constant:: CF
   

   .. oe:constant:: CM
   

   .. oe:constant:: CP
   

   .. oe:constant:: CR
   

   .. oe:constant:: C0
   

   .. oe:constant:: O2
   

   .. oe:constant:: O3
   

   .. oe:constant:: OA
   

   .. oe:constant:: OM
   

   .. oe:constant:: OW
   

   .. oe:constant:: OP
   

   .. oe:constant:: OQ
   

   .. oe:constant:: O0
   

   .. oe:constant:: N1
   

   .. oe:constant:: N2
   

   .. oe:constant:: N3
   

   .. oe:constant:: NA
   

   .. oe:constant:: NB
   

   .. oe:constant:: NC
   

   .. oe:constant:: ND
   

   .. oe:constant:: N4
   

   .. oe:constant:: N5
   

   .. oe:constant:: NE
   

   .. oe:constant:: NF
   

   .. oe:constant:: NG
   

   .. oe:constant:: NH
   

   .. oe:constant:: NI
   

   .. oe:constant:: NM
   

   .. oe:constant:: NP
   

   .. oe:constant:: N0
   

   .. oe:constant:: H1
   

   .. oe:constant:: H2
   

   .. oe:constant:: H3
   

   .. oe:constant:: H4
   

   .. oe:constant:: H5
   

   .. oe:constant:: H0
   

   .. oe:constant:: S1
   

   .. oe:constant:: SA
   

   .. oe:constant:: SM
   

   .. oe:constant:: S0
   

   .. oe:constant:: P0
   

   .. oe:constant:: B2
   

   .. oe:constant:: B3
   

   .. oe:constant:: F0
   

   .. oe:constant:: Cl
   

   .. oe:constant:: Br
   

   .. oe:constant:: I0
   

   .. oe:constant:: Si
   

   .. oe:constant:: Du
   

   .. oe:constant:: Z0
   

   .. oe:constant:: Lp
   

   .. oe:constant:: Li
   

   .. oe:constant:: Na
   

   .. oe:constant:: K0
   

   .. oe:constant:: Rb
   

   .. oe:constant:: Cs
   

   .. oe:constant:: Ca
   

   .. oe:constant:: Ba
   

   .. oe:constant:: Mg
   

   .. oe:constant:: M2
   

   .. oe:constant:: M3
   

   .. oe:constant:: M4
   

   .. oe:constant:: M5
   

   .. oe:constant:: M6
   

   .. oe:constant:: M7
   

   .. oe:constant:: f2
   

   .. oe:constant:: f3
   

   .. oe:constant:: o2
   

   .. oe:constant:: o3
   

   .. oe:constant:: n2
   

   .. oe:constant:: n3
   

   .. oe:constant:: c1
   

   .. oe:constant:: c2
   

   .. oe:constant:: Zn
   

   .. oe:constant:: m3
   

   .. oe:constant:: m4
   

   .. oe:constant:: m5
   

   .. oe:constant:: m6
   

   .. oe:constant:: SP
   

   .. oe:constant:: S2
   

   .. oe:constant:: Cm
   

   .. oe:constant:: MAXTYPE
   



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEMolBaseType

   The :oe:constns:`OEChem::OEMolBaseType` namespace encodes symbolic
   constants representing specific :ref:`OEMolBase <OEChem_OEMolBase>` class
   implementation types.

   .. seealso::

      * :ref:`OEGraphMol <OEChem_OEGraphMol>` constructor
      * :oe:func:`OEChem::OENewMolBase` function

   This namespace contains the following constants:

   .. oe:constant:: Undefined

      Used to signal errors.

   .. oe:constant:: OEDefault

      The default molecule implementation used by OEChem.

   .. oe:constant:: OEDBMol

      A molecule implementation designed to have a very small memory
      footprint. :oe:meth:`OEChem::OEMolBase::Compress` can be called
      to dramatically reduce memory consumption. However,
      :oe:meth:`OEChem::OEMolBase::UnCompress` must be called to make
      the molecule usable again.

   .. oe:constant:: OEMiniMol

      A molecule implementation designed to have a small memory
      footprint, however, the molecule is still usable for molecular
      algorithms, i.e., substructure searching. This molecule
      implementation has been tuned for high performance in-memory
      substructure searching, while maintaining a small memory
      footprint. :oe:meth:`OEChem::OEMolBase::Compress` will reduce
      memory consumption, however, it will put the molecule in a
      "read-only" state. :oe:meth:`OEChem::OEMolBase::UnCompress` will
      make the molecule writeable again.

      .. warning::

         :ref:`OEGroupBase <OEChem_OEGroupBase>` information will be lost
         when compressing molecules that are constructed with the
         :oe:const:`OEChem::OEMolBaseType::OEMiniMol` type.

   .. oe:constant:: MaxType

      The maximum numerical value possible from this namespace.


.. oe:namespace:: OEChem

.. oe:constnamespace:: OENearestNbrsMethod

   This namespace contains constants.

   This namespace contains constants representing various heuristics
   used to search for nearest neighbors.

   .. seealso::

      * :oe:func:`OEChem::OEGetNearestNbrs` function
      * :oe:func:`OEChem::OENearestNbrs` class

   .. oe:constant:: Default

      The default method is :oe:const:`OEChem::OENearestNbrsMethod::Auto`.
   
   .. oe:constant:: Auto

      When using the :oe:const:`OEChem::OENearestNbrsMethod::Auto` constant,
      the algorithm that is utilized to search the nearest neighbors will be
      determined by the size of the molecule.

   .. oe:constant:: AllByAll

      This represent a method that is suitable for searching nearest neighbors
      in small molecules.

   .. oe:constant:: LocalHash

      This represent a method that is suitable for searching nearest neighbors
      in large molecules such as proteins.

   .. oe:constant:: ZCoordSort

      This represent a method that is suitable for searching nearest neighbors
      in mid-sized molecules.


.. oe:namespace:: OEChem

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


..  _OEChem_OEOFlavor:

.. oe:constnamespace:: OEOFlavor

   The :oe:constns:`OEChem::OEOFlavor` namespace encodes symbolic
   constants used as bit-masks to indicate how to read various
   file formats by **OEChem TK**.

   The :oe:constns:`OEChem::OEOFlavor::Generic` namespace within
   :oe:constns:`OEChem::OEOFlavor` defines control bit-masks that are
   common to all of the output formats.
   Although these generic bits are common to all file formats, they
   may be specified independently for each file format.

   .. seealso::

      * :oe:meth:`OEChem::oemolostream::SetFormat` method to set the flavor of an output molecule stream
      * :oe:meth:`OEChem::oemolstreambase::GetFormat` method to retrieve the flavor of a molecule stream

   The interpretation of many of these flavor values, is identical to
   those passed to the corresponding **OEChem TK** low-level file format
   writers.

   This namespace contains the following namespaces:

   .. ################################################################
      #
      ################################################################

..  _OEChem_OEOFlavor_CAN:

   .. oe:constnamespace:: OEOFlavor::CAN

      The :oe:constns:`OEChem::OEOFlavor::CAN` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OECreateSmiString` function
      when writing a molecule into a :oe:const:`OEChem::OEFormat::CAN`
      format file.

      .. note::

         If no aromaticity model is specified for the
         :oe:constns:`OEChem::OEOFlavor::Generic` namespace for this file format,
         then the OpenEye  model is used by default to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      This namespace contains the following constants:

      .. oe:constant:: AllBonds

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AllBonds` constant.

      .. oe:constant:: AtomMaps

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AtomMaps` constant.

      .. oe:constant:: AtomStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AtomStereo` constant.

      .. oe:constant:: BondStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::BondStereo` constant.

      .. oe:constant:: Canonical

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Canonical` constant.

      .. oe:constant:: DEFAULT

         Same as the :oe:const:`OEChem::OEOFlavor::CAN::Default` constant.

      .. oe:constant:: Default

         Combination of
         :oe:const:`OEChem::OEOFlavor::CAN::AtomMaps`,
         :oe:const:`OEChem::OEOFlavor::CAN::Canonical` and
         :oe:const:`OEChem::OEOFlavor::CAN::RGroups` flags.

      .. oe:constant:: EnhStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::EnhStereo` constant.

      .. oe:constant:: ExtBonds

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::ExtBonds` constant.

      .. oe:constant:: Hydrogens

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Hydrogens` constant.

      .. oe:constant:: ImpHCount

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::ImpHCount` constant.

      .. oe:constant:: Isotopes

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Isotopes` constant.

      .. oe:constant:: Kekule

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Kekule` constant.

      .. oe:constant:: RGroups

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::RGroups` constant.

      .. oe:constant:: SmiMask

      .. oe:constant:: SuperAtoms

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::SuperAtoms` constant.

   .. ################################################################
      #
      ################################################################

..  _OEChem_OEOFlavor_CDX:

   .. oe:constnamespace:: OEOFlavor::CDX

      .. note::

         If no aromaticity model is specified for the
         :oe:constns:`OEChem::OEOFlavor::Generic` namespace for this file format,
         then the OpenEye model is used by default to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      This namespace contains the following constants:

      .. oe:constant:: Add2D

         This flag indicates that 2D coordinates are generated prior to
         writing a molecule by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.
         If the molecule already has 2D coordinates then
         these coordinates are left intact.
         In certain cases the 2D layout may result in incorrect stereochemistry
         in the resulting connection table.  In these cases no coordinates
         are generated.

      .. oe:constant:: UnsetBad2DStereo

         This flag is used with the Add2D constant.  In certain cases
         the 2D layout may result in incorrect stereochemistry in the output
         connection table format.  When this flag is set the writer will
         output the generated coordinates and set the stereochemistry of the
         offending stereocenters to 'Undefined'.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEOFlavor::CDX::Add2D` constant.

   .. ################################################################
      #
      ################################################################

..  _OEChem_OEOFlavor_CIF:

   .. oe:constnamespace:: OEOFlavor::CIF

      .. note::

         If no aromaticity model is specified for the
         :oe:constns:`OEChem::OEOFlavor::Generic` namespace for this file format,
         then the OpenEye model is used by default to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      This namespace contains the following constants:

      .. oe:constant:: Default

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::CSV

      This namespace contains constants for modifying the behavior of
      how the :oe:const:`OEChem::OEFormat::CSV` file format is written.

      .. seealso::

         :ref:`section_moltaggeddata_CSV`

      .. oe:constant:: Header

         This flag indicates whether the first line in the
         :file:`.csv` should contain the column names for the
         file. Column names are determined by the SD data present on
         the first molecule written to the
         :ref:`oemolostream <OEChem_oemolostream>`, regardless of whether this
         flag is set. The column names are retrievable through the
         :oe:meth:`OEChem::oemolstreambase::GetCSVHeader` method on the
         :ref:`OECSVHeader <OEChem_OECSVHeader>` object.

         If this flag is not set, the first line of the
         output :file:`.csv` file will be the first molecule record.

      .. oe:constant:: Default

         Set to include :oe:const:`OEChem::OEOFlavor::CSV::Header` to
         automatically write the column names as the first line in the
         file.

      .. oe:constant:: DEFAULT

         Synonym for :oe:const:`OEChem::OEOFlavor::CSV::Default`.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::CXSMILES

      The :oe:constns:`OEChem::OEOFlavor::CXSMILES` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OECreateSmiString` function
      when writing a molecule into a :oe:const:`OEChem::OEFormat::CXSMILES`
      format file.

      .. note::

         If no aromaticity model is specified for the
         :oe:constns:`OEChem::OEOFlavor::Generic` namespace for this file format,
         then the OpenEye  model is used by default to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      This namespace contains the following constants:

      .. oe:constant:: AllBonds

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AllBonds` constant.

      .. oe:constant:: AtomMaps

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AtomMaps` constant.

      .. oe:constant:: AtomStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AtomStereo` constant.

      .. oe:constant:: BondStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::BondStereo` constant.

      .. oe:constant:: Canonical

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Canonical` constant.

      .. oe:constant:: DEFAULT

         Same as the :oe:const:`OEChem::OEOFlavor::CXSMILES::Default` constant.

      .. oe:constant:: Default

         Combination of
         :oe:const:`OEChem::OEOFlavor::CXSMILES::AtomMaps`,
         :oe:const:`OEChem::OEOFlavor::CXSMILES::AtomStereo`,
         :oe:const:`OEChem::OEOFlavor::CXSMILES::BondStereo`,
         :oe:const:`OEChem::OEOFlavor::CXSMILES::Canonical`,
         :oe:const:`OEChem::OEOFlavor::CXSMILES::Isotopes`,
         :oe:const:`OEChem::OEOFlavor::CXSMILES::RGroups` and
         :oe:const:`OEChem::OEOFlavor::CXSMILES::EnhStereo` flags.

      .. oe:constant:: EnhStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::EnhStereo` constant.

      .. oe:constant:: ExtBonds

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::ExtBonds` constant.

      .. oe:constant:: Hydrogens

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Hydrogens` constant.

      .. oe:constant:: ImpHCount

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::ImpHCount` constant.

      .. oe:constant:: Isotopes

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Isotopes` constant.

      .. oe:constant:: Kekule

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Kekule` constant.

      .. oe:constant:: RGroups

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::RGroups` constant.

      .. oe:constant:: SmiMask

      .. oe:constant:: SuperAtoms

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::SuperAtoms` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::FASTA

      This namespace contains the following constants:

      .. oe:constant:: Default

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::Generic

      This namespace contains the following constants:

      .. oe:constant:: OEAroModelDaylight

         This flag indicates that the Daylight aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      .. oe:constant:: OEAroModelOpenEye

         This flag indicates that the OpenEye aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      .. oe:constant:: OEAroModelTripos

         This flag indicates that the Tripos aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      .. oe:constant:: OEAroModelMMFF

         This flag indicates that the MMFF aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      .. oe:constant:: OEAroModelMDL

         This flag indicates that the MDL aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      .. oe:constant:: AroMask

         Combination of
         :oe:const:`OEChem::OEOFlavor::Generic::OEAroModelDaylight`,
         :oe:const:`OEChem::OEOFlavor::Generic::OEAroModelOpenEye`,
         :oe:const:`OEChem::OEOFlavor::Generic::OEAroModelTripos`,
         :oe:const:`OEChem::OEOFlavor::Generic::OEAroModelMMFF` and
         :oe:const:`OEChem::OEOFlavor::Generic::OEAroModelMDL` flags.

         .. seealso::

            * :ref:`section_aromaticity_models` section
            * :oe:func:`OEChem::OEAssignAromaticFlags` function

      .. oe:constant:: Rings

         This flag indicates the rings are (re)perceived by the
         :oe:func:`OEChem::OEWriteMolecule` high-level reader by calling
         the :oe:func:`OEChem::OEFindRingAtomsAndBonds` function.

      .. oe:constant:: GenericMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::Generic::AroMask` and
         :oe:const:`OEChem::OEIFlavor::Generic::Rings` flags.

      .. oe:constant:: SpecificMask

      .. oe:constant:: DEFAULT

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEOFlavor::Generic::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::INCHI

      The :oe:constns:`OEChem::OEOFlavor::INCHI` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OECreateInChI` function
      when writing a molecule into the :oe:const:`OEChem::OEFormat::INCHI`
      format file.
      These constants translate into InChI library options documented
      in the `InChI API Reference`_ documentation.

      .. seealso::

         :ref:`OEInChIOptions <OEChem_OEInChIOptions>`

      This namespace contains the following constants:

      .. oe:constant:: Chiral

         Corresponds to the ``ChiralFlagOn`` InChI option.

      .. oe:constant:: Default

         Equal to :oe:const:`OEChem::OEOFlavor::INCHI::Stereo` and :oe:const:`OEChem::OEOFlavor::INCHI::Title`.

      .. oe:constant:: FixedHLayer

         Corresponds to the ``FixedH`` InChI option.

      .. oe:constant:: Hydrogens

         Corresponds to the inverse of the ``DoNotAddH`` InChI option.

      .. oe:constant:: RacemicStereo

         Corresponds to the ``SRac`` InChI option.

      .. oe:constant:: ReconnectedMetals

         Corresponds to the ``RecMet`` InChI option.

      .. oe:constant:: RelativeStereo

         Corresponds to the ``SRel`` InChI option.

      .. oe:constant:: Stereo

         Corresponds to the inverse of the ``SNon`` InChI option.

      .. oe:constant:: Title

         If this flag is set, then the molecule's title (returned by
         :oe:meth:`OEChem::OEMolBase::GetTitle` method) is written to
         the output file.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::INCHIKEY

      The :oe:constns:`OEChem::OEOFlavor::INCHIKEY` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OECreateInChIKey` function
      when writing a molecule into a :oe:const:`OEChem::OEFormat::INCHIKEY`
      format file.
      These constants translate into InChI library options documented
      in the `InChI API Reference`_ documentation.

      This namespace contains the following constants:

      .. oe:constant:: Chiral

         Corresponds to the ``ChiralFlagOn`` InChI option.

      .. oe:constant:: Default

         Equal to :oe:const:`OEChem::OEOFlavor::INCHIKEY::Stereo` and :oe:const:`OEChem::OEOFlavor::INCHIKEY::Title`.

      .. oe:constant:: FixedHLayer

         Corresponds to the ``FixedH`` InChI option.

      .. oe:constant:: Hydrogens

         Corresponds to the inverse of the ``DoNotAddH`` InChI option.

      .. oe:constant:: RacemicStereo

         Corresponds to the ``SRac`` InChI option.

      .. oe:constant:: ReconnectedMetals

         Corresponds to the ``RecMet`` InChI option.

      .. oe:constant:: RelativeStereo

         Corresponds to the ``SRel`` InChI option.

      .. oe:constant:: Stereo

         Corresponds to the inverse of the ``SNon`` InChI option.

      .. oe:constant:: Title

         If this flag is set, then the molecule's title (returned by
         :oe:meth:`OEChem::OEMolBase::GetTitle` method) is written to
         the output file.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::ISM

      The :oe:constns:`OEChem::OEOFlavor::ISM` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OECreateSmiString` function
      when writing a molecule into a :oe:const:`OEChem::OEFormat::ISM`
      format file.

      .. note::

         If no aromaticity model is specified for the
         :oe:constns:`OEChem::OEOFlavor::Generic` namespace for this file format,
         then the OpenEye  model is used by default to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      This namespace contains the following constants:

      .. oe:constant:: AllBonds

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AllBonds` constant.

      .. oe:constant:: AtomMaps

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AtomMaps` constant.

      .. oe:constant:: AtomStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AtomStereo` constant.

      .. oe:constant:: BondStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::BondStereo` constant.

      .. oe:constant:: Canonical

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Canonical` constant.

      .. oe:constant:: DEFAULT

         Same as the :oe:const:`OEChem::OEOFlavor::ISM::Default` constant.

      .. oe:constant:: Default

         Combination of
         :oe:const:`OEChem::OEOFlavor::ISM::AtomMaps`,
         :oe:const:`OEChem::OEOFlavor::ISM::AtomStereo`,
         :oe:const:`OEChem::OEOFlavor::ISM::BondStereo`,
         :oe:const:`OEChem::OEOFlavor::ISM::Canonical`,
         :oe:const:`OEChem::OEOFlavor::ISM::Isotopes` and
         :oe:const:`OEChem::OEOFlavor::ISM::RGroups` flags.

      .. oe:constant:: EnhStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::EnhStereo` constant.

      .. oe:constant:: ExtBonds

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::ExtBonds` constant.

      .. oe:constant:: Hydrogens

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Hydrogens` constant.

      .. oe:constant:: ImpHCount

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::ImpHCount` constant.

      .. oe:constant:: Isotopes

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Isotopes` constant.

      .. oe:constant:: Kekule

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Kekule` constant.

      .. oe:constant:: RGroups

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::RGroups` constant.

      .. oe:constant:: SmiMask

      .. oe:constant:: SuperAtoms

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::SuperAtoms` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::MDL

      The :oe:constns:`OEChem::OEOFlavor::MDL` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OEWriteMDLFile` and the
      :oe:func:`OEChem::OEWriteMolecule` functions
      when writing a molecule into a :oe:const:`OEChem::OEFormat::MDL`
      format file.

      This namespace contains the following constants:

      .. oe:constant:: Add2D

         This flag indicates that if a molecule has no coordinates, then
         2D coordinates are generated prior to  writing a molecule by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.
         If the molecule already has 2D or 3D coordinates
         then these coordinates are left intact.
         In certain cases the 2D layout may result in incorrect stereochemistry
         in the resulting connection table.  In these cases no coordinates
         are generated.

      .. oe:constant:: UnsetBad2DStereo

         This flag is used with the Add2D constant.  In certain cases
         the 2D layout may result in incorrect stereochemistry in the output
         connection table format.  When this flag is set the writer will
         output the generated coordinates and set the stereochemistry of the
         offending stereocenters to 'Undefined'.

      .. oe:constant:: MCHG

         The :oe:const:`OEChem::OEOFlavor::MDL::MCHG` flag is used to instruct
         the MDL mol file writer to write ``M CHG`` and ``M RAD`` lines for
         charged/radical atoms in the output connection table, even if the
         charge and radical values of every atom are within the ranges
         representable by the MDL atom block.  By default, ``M CHG`` and ``M
         RAD`` lines are only used for connection tables that 'overflow' the
         allowed atom block limits.

      .. oe:constant:: MISO

         The :oe:const:`OEChem::OEOFlavor::MDL::MISO` flag is used to instruct
         the **OEChem TK** MDL mol file writer to write ``M ISO`` lines for isotopes
         in the output connection table, even if the isotopic masses of every
         atom are within the range representable by the MDL atom block.  By
         default, ``M ISO`` lines are only used for connection tables that
         'overflow' the allowed atom block limits.

      .. oe:constant:: MRGP

         The :oe:const:`OEChem::OEOFlavor::MDL::MRGP` flag is used to instruct
         the **OEChem TK** MDL mol file writer to write out ``M RGP`` entries for
         each R-group atom, *i.e.* atom with element zero and a non-zero atom
         map index.  These atoms are always written with atomic symbol ``R#``.

      .. oe:constant:: MV30

         Force every molecule to be written in V3000 format. By
         default, only molecules with more than 999 atoms or enhanced
         stereo groups will be written in V3000 format.

      .. oe:constant:: MDLParity

         If this flag is set and :oe:func:`OEChem::OEMDLHasParity`
         returns ``false`` ,then :oe:func:`OEChem::OEMDLPerceiveParity`
         function is called to perceive the MDL atom stereo parity
         fields.

         .. note::

            This flag is only interpreted by the high-level file writers
            (:oe:func:`OEChem::OEWriteMolecule`) and not in
            :oe:func:`OEChem::OEWriteMDLFile`.

      .. oe:constant:: NoParity

         If this flag is set, then :oe:func:`OEChem::OEMDLClearParity`
         function is called to set all MDL atom stereo parity fields
         to zero.

         .. note::

            This flag is only interpreted by the high-level file writers
            (:oe:func:`OEChem::OEWriteMolecule`) and not in
            :oe:func:`OEChem::OEWriteMDLFile`.

      .. oe:constant:: CurrentParity

         If this flag is set, then the MDL atom stereo parity fields
         are left intact.

         .. note::

            This flag is only interpreted by the high-level file writers
            (:oe:func:`OEChem::OEWriteMolecule`) and not in
            :oe:func:`OEChem::OEWriteMDLFile`.

      .. oe:constant:: MMask

      .. oe:constant:: PMask

         Combination of
         :oe:const:`OEChem::OEOFlavor::MDL::MDLParity`,
         :oe:const:`OEChem::OEOFlavor::MDL::NoParity` and
         :oe:const:`OEChem::OEOFlavor::MDL::CurrentParity` flags.
         The flag controls the processing of the MDL stereo parity bit
         field of each atom.

      .. oe:constant:: SuppressImp2ExpENHSTE

         This flavor suppresses any implicit to explicit enhanced stereogroup
         conversions if the output is V3000 format.

      .. oe:constant:: SuppressTimestamps

         This flavor suppresses the output of timestamps in MDL format header line(s).
         This can be useful for generation of simple diffable standards for use in tests.

      .. oe:constant:: DEFAULT

         Combination of
         :oe:const:`OEChem::OEOFlavor::MDL::Add2D`,
         :oe:const:`OEChem::OEOFlavor::MDL::MDLParity`,
         :oe:const:`OEChem::OEOFlavor::MDL::MRGP`,
         :oe:const:`OEChem::OEOFlavor::MDL::MISO` and
         :oe:const:`OEChem::OEOFlavor::MDL::MCHG` flags.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEOFlavor::MDL::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::MF

      The :oe:constns:`OEChem::OEOFlavor::MF` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OEWriteMolecule` functions
      when writing a molecule into a :oe:const:`OEChem::OEFormat::MF`
      format file.

      This namespace contains the following constants:

      .. oe:constant:: Title

         If this flag is set, then the molecule's title (returned by
         :oe:meth:`OEChem::OEMolBase::GetTitle` method) is written to
         the output file.

      .. oe:constant:: DEFAULT

         Same as the :oe:const:`OEChem::OEOFlavor::MF::Title` constant.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEOFlavor::MF::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

..  _OEChem_OEOFlavor_MMCIF:

   .. oe:constnamespace:: OEOFlavor::MMCIF

      .. note::

         If no aromaticity model is specified for the
         :oe:constns:`OEChem::OEOFlavor::Generic` namespace for this file format,
         then the OpenEye model is used by default to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      This namespace contains the following constants:

..  _OEChem_OEOFlavor_MMCIF_PerceiveMetadata:

      .. oe:constant:: PerceiveMetadata

..  _OEChem_OEOFlavor_MMCIF_PerceiveMetadata_Default:

      .. oe:constant:: Default

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::MMOD

      This namespace contains following constants:

      .. oe:constant:: AtomTypes

      .. oe:constant:: DEFAULT

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEOFlavor::MMOD::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::MOL2

      .. note::

         Except for MOL2 Flavor Forcefield, if no aromaticity model is specified for the
         :oe:constns:`OEChem::OEOFlavor::Generic` namespace for this file format,
         then the Tripos model is used by default to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      This namespace contains the following constant:

      .. oe:constant:: AtomNames

      .. oe:constant:: AtomTypeNames

      .. oe:constant:: BondTypeNames

      .. oe:constant:: ChargePrecision

         This flavor allows for increased precision of partial charges by writing
         them out to 5 decimal places.

      .. oe:constant:: Forcefield

         Combination of
         :oe:const:`OEChem::OEOFlavor::MOL2::GeneralFFFormat`,
         :oe:const:`OEChem::OEOFlavor::MOL2::ChargePrecision`, and
         :oe:const:`OEChem::OEOFlavor::MOL2::BondTypeNames` flags

         This variant of MOL2 reflects a common use of MOL2 format to embody
         information for a general forcefield. It combines the :oe:const:`OEChem::OEOFlavor::MOL2::GeneralFFFormat`
         so that atom names, atom types, and atom ordering are written out "as is"
         based on the input molecule, and :oe:const:`OEChem::OEOFlavor::MOL2::ChargePrecision`, which writes out
         atomic partial charges to 5 decimal places. Mol2 :oe:const:`OEChem::OEOFlavor::MOL2::BondTypeNames` are
         retained from the Tripos standard at this point because they are
         generally reasonable and historically they don't conflict with the
         other needs of general forcefield format.

      .. oe:constant:: GeneralFFFormat

         This variant of MOL2 is commonly used for carrying information for
         force fields more general than the Tripos forcefield (the MOL2 standard).
         Here the atom names, atom types, and atom ordering are retained from the
         input molecule, rather than being changed to comply with
         the Tripos MOL2 standard. If an atom does not have a user-defined atom name
         and atom type for all atoms, warnings will be given and no molecule will
         be written.

      .. oe:constant:: Hydrogens

      .. oe:constant:: OrderAtoms

      .. oe:constant:: Substructure

      .. oe:constant:: NameMask

      .. oe:constant:: AllMask

      .. oe:constant:: DEFAULT

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEOFlavor::MOL2::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::MOL2H

      .. note::

         If no aromaticity model is specified for the
         :oe:constns:`OEChem::OEOFlavor::Generic` namespace for this file format,
         then the Tripos model is used by default to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      This namespace contains the following constants:

      .. oe:constant:: AtomTypeNames

      .. oe:constant:: BondTypeNames

      .. oe:constant:: AtomNames

      .. oe:constant:: OrderAtoms

      .. oe:constant:: Hydrogens

      .. oe:constant:: Substructure

      .. oe:constant:: NameMask

      .. oe:constant:: AllMask

      .. oe:constant:: DEFAULT

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEOFlavor::MOL2H::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::MOPAC

      This namespace contains the following constants:

      .. oe:constant:: XYZ

      .. oe:constant:: CHARGES

      .. oe:constant:: AllMask

      .. oe:constant:: DEFAULT

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEOFlavor::MOPAC::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::OEB

      This namespace contains the following constants:

      .. oe:constant:: Default

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::OEZ

      This namespace contains the following constants:

      .. oe:constant:: Default

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::PDB

      The :oe:constns:`OEChem::OEOFlavor::PDB` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OEWritePDBFile` and the
      :oe:func:`OEChem::OEWriteMolecule` functions
      when writing a molecule into a :oe:const:`OEChem::OEFormat::PDB`
      format file.

      This namespace contains the following constants:

      .. oe:constant:: BONDS

         Controls whether the OEChem PDB file writer includes `CONECT`_
         records to describe the connectivity of the molecule.  If this flag is
         given without :oe:const:`OEChem::OEOFlavor::PDB::ORDERS` all bonds are
         written as 'single' bonds.  :oe:const:`OEChem::OEOFlavor::PDB::BONDS` is
         off by default.

      .. oe:constant:: ORDERS

         Controls whether the PDB file writer should use repeated `CONECT`_
         records to represent multiple bond orders (*i.e.* double and triple
         bonds).  If this flag is given without
         :oe:const:`OEChem::OEOFlavor::PDB::BONDS` only double and triple bonds are
         written to the file. :oe:const:`OEChem::OEOFlavor::PDB::ORDERS` is off by
         default.

      .. oe:constant:: BOTH

         Including this bit-mask writes bi-directional `CONECT`_ records.
         Conventionally, PDB files list connect records both from source atom
         to destination atom, and again from destination to source.  This
         duplication doubles the number/size of `CONECT`_ records with
         redundant information, as most readers (if they honor `CONECT`_
         records at all) can work with uni-directional `CONECT`_ records.
         By default, this flavor is enabled and bi-directional `CONECT`_ records
         are written.

      .. oe:constant:: CHARGE

         Controls whether the PDB file writer takes the value for the PDB
         file's B-factor field from the atom's partial charge property.  A
         number of applications, including Delphi, (ab)use the PDB file format
         specification to store atomic partial charges in the b-factor field
         rather instead of crystallographically determined anisotropic
         temperature factors.  :oe:const:`OEChem::OEOFlavor::PDB::CHARGE` is off by
         default.

      .. oe:constant:: RADIUS

         Controls whether the PDB file writer takes the value for the PDB
         file's occupancy field from the atom's radius property.  A number of
         applications, including Delphi, (ab)use the PDB file format
         specification to store radii in the occupancy field rather instead of
         crystallographically determined anisotropic
         occupancies. :oe:const:`OEChem::OEOFlavor::PDB::RADIUS` is off by default.

      .. oe:constant:: TER

         Controls whether the PDB file writer terminates each connection table
         with a `TER`_ record rather than an `END`_ record.  Some dubious
         molecular graphics software, such as Grasp, requires that multiple
         compounds be separated by the chain/fragment separator `TER`_, rather
         than the molecule separator `END`_.
         :oe:const:`OEChem::OEOFlavor::PDB::TER` is off by default.

      .. oe:constant:: DELPHI

         Combination of :oe:const:`OEChem::OEOFlavor::PDB::CHARGE` and
         :oe:const:`OEChem::OEOFlavor::PDB::RADIUS` flags.

      .. oe:constant:: ELEMENT

         Controls whether the PDB writer writes the chemical symbol
         right-justified in columns 77-78, as specified by version 2.2 of the
         PDB format specification.  :oe:const:`OEChem::OEOFlavor::PDB::ELEMENT` is on by default.

      .. oe:constant:: FORMALCHARGE

         Controls whether the PDB file writer writes the formal charge
         right-justified (*e.g.* ``2+``, ``2-``) in columns 79-80, as specified
         by version 2.2 of the PDB format specification.  This flag is off by default.  Enabling
         :oe:const:`OEChem::OEOFlavor::PDB::FORMALCHARGE` also enables
         :oe:const:`OEChem::OEOFlavor::PDB::ELEMENT`.

      .. oe:constant:: HETBONDS

         Controls whether the PDB writer writes any bond to or from a
         'hetero atom' (i.e. atom that has the record type ``HETATM`` in a
         PDB file). :oe:const:`OEChem::OEOFlavor::PDB::HETBONDS` is on by default.

         .. seealso::

            * :oe:constns:`OEChem::OEPreserveResInfo` namespace
            * :oe:meth:`OEChem::OEResidue::IsHetAtom` method to retrieve the 'hetero atom' property of an atom in a residue
            * :oe:meth:`SetHetAtom<OEChem::OEResidue::SetHetAtom>` method

      .. oe:constant:: BasicMask

      .. oe:constant:: OEResidues

         .. note::

            This flag is only interpreted by the high-level file
            writers (:oe:func:`OEChem::OEWriteMolecule`) and not in
            :oe:func:`OEChem::OEWritePDBFile`.

      .. oe:constant:: NoResidues

         .. note::

            This flag is only interpreted by the high-level file
            writers (:oe:func:`OEChem::OEWriteMolecule`) and not in
            :oe:func:`OEChem::OEWritePDBFile`.

      .. oe:constant:: CurrentResidues

         .. note::

            This flag is only interpreted by the high-level file
            writers (:oe:func:`OEChem::OEWriteMolecule`) and not in
            :oe:func:`OEChem::OEWritePDBFile`.

      .. oe:constant:: OrderAtoms

         .. note::

            This flag is only interpreted by the high-level file
            writers (:oe:func:`OEChem::OEWriteMolecule`) and not in
            :oe:func:`OEChem::OEWritePDBFile`.

      .. oe:constant:: AllMask

      .. oe:constant:: DEFAULT

         Combination of
         :oe:const:`OEChem::OEOFlavor::PDB::OrderAtoms`,
         :oe:const:`OEChem::OEOFlavor::PDB::OEResidues`,
         :oe:const:`OEChem::OEOFlavor::PDB::HETBONDS`,
         :oe:const:`OEChem::OEOFlavor::PDB::ELEMENT` and
         :oe:const:`OEChem::OEOFlavor::PDB::BOTH` flags.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEOFlavor::PDB::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace: OEOFlavor::RDF IGNORED

      This namespace contains the following constants:

      .. oe:constant:: MCHG

      .. oe:constant:: MISO

      .. oe:constant:: MRGP

      .. oe:constant:: MV30

      .. oe:constant:: MDLParity

      .. oe:constant:: NoParity

      .. oe:constant:: CurrentParity

      .. oe:constant:: MMask

      .. oe:constant:: PMask

      .. oe:constant:: SuppressImp2ExpENHSTE

      .. oe:constant:: DEFAULT

      .. oe:constant:: Default

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::SDF

      The :oe:constns:`OEChem::OEOFlavor::SDF` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OEWriteMDLFile` and the
      :oe:func:`OEChem::OEWriteMolecule` functions
      when writing a molecule into a :oe:const:`OEChem::OEFormat::SDF`
      format file.

      This namespace contains the following constants:

      .. oe:constant:: Add2D

         This flag indicates that if a molecule has no coordinates, then
         2D coordinates are generated prior to  writing a molecule by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.
         If the molecule already has 2D or 3D coordinates
         then these coordinates are left intact.
         In certain cases the 2D layout may result in incorrect stereochemistry
         in the resulting connection table.  In these cases no coordinates
         are generated.

      .. oe:constant:: UnsetBad2DStereo

         This flag is used with the Add2D constant.  In certain cases
         the 2D layout may result in incorrect stereochemistry in the output
         connection table format.  When this flag is set the writer will
         output the generated coordinates and set the stereochemistry of the
         offending stereocenters to 'Undefined'.

      .. oe:constant:: MCHG

      .. oe:constant:: MISO

      .. oe:constant:: MRGP

      .. oe:constant:: MV30

      .. oe:constant:: MDLParity

         If this flag is set and :oe:func:`OEChem::OEMDLHasParity`
         returns ``false`` ,then :oe:func:`OEChem::OEMDLPerceiveParity`
         function is called to perceive the MDL atom stereo parity
         fields.

         .. note::

            This flag is only interpreted by the high-level file writers
            (:oe:func:`OEChem::OEWriteMolecule`) and not in
            :oe:func:`OEChem::OEWriteMDLFile`.

      .. oe:constant:: NoParity

         If this flag is set, then :oe:func:`OEChem::OEMDLClearParity`
         function is called to set all MDL atom stereo parity fields
         to zero.

         .. note::

            This flag is only interpreted by the high-level file writers
            (:oe:func:`OEChem::OEWriteMolecule`) and not in
            :oe:func:`OEChem::OEWriteMDLFile`.

      .. oe:constant:: CurrentParity

         If this flag is set, then the MDL atom stereo parity fields
         are left intact.

         .. note::

            This flag is only interpreted by the high-level file writers
            (:oe:func:`OEChem::OEWriteMolecule`) and not in
            :oe:func:`OEChem::OEWriteMDLFile`.

      .. oe:constant:: MMask

      .. oe:constant:: PMask

         Combination of
         :oe:const:`OEChem::OEOFlavor::SDF::MDLParity`,
         :oe:const:`OEChem::OEOFlavor::SDF::NoParity` and
         :oe:const:`OEChem::OEOFlavor::SDF::CurrentParity` flags.
         The flag controls the processing of the MDL stereo parity bit
         field of each atom.

      .. oe:constant:: SuppressImp2ExpENHSTE

         This flavor suppresses any implicit to explicit enhanced stereogroup
         conversions if the output is V3000 format.

      .. oe:constant:: SuppressTimestamps

         This flavor suppresses the output of timestamps in MDL format header line(s).
         This can be useful for generation of simple diffable standards for use in tests.

      .. oe:constant:: DEFAULT

         Combination of
         :oe:const:`OEChem::OEOFlavor::SDF::Add2D`,
         :oe:const:`OEChem::OEOFlavor::SDF::MDLParity`,
         :oe:const:`OEChem::OEOFlavor::SDF::MRGP`,
         :oe:const:`OEChem::OEOFlavor::SDF::MISO` and
         :oe:const:`OEChem::OEOFlavor::SDF::MCHG` flags.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEOFlavor::SDF::DEFAULT` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace: OEOFlavor::SKC IGNORED

      This namespace contains the following constants:

      .. oe:constant:: Default

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::SLN

      .. note::

         If no aromaticity model is specified for the
         :oe:constns:`OEChem::OEOFlavor::Generic` namespace for this file format,
         then the Tripos model is used by default to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      This namespace contains the following constants:

      .. oe:constant:: Default

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::SMI

      The :oe:constns:`OEChem::OEOFlavor::SMI` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OECreateSmiString` function
      when writing a molecule into a :oe:const:`OEChem::OEFormat::SMI`
      format file.

      .. note::

         If no aromaticity model is specified for the
         :oe:constns:`OEChem::OEOFlavor::Generic` namespace for this file format,
         then the OpenEye  model is used by default to perceive aromaticity by the
         :oe:func:`OEChem::OEWriteMolecule` high-level writer.

      This namespace contains the following constants:

      .. oe:constant:: AllBonds

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AllBonds` constant.

      .. oe:constant:: AtomMaps

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AtomMaps` constant.

      .. oe:constant:: AtomStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AtomStereo` constant.

      .. oe:constant:: BondStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::BondStereo` constant.

      .. oe:constant:: Canonical

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Canonical` constant.

      .. oe:constant:: DEFAULT

         Same as the :oe:const:`OEChem::OEOFlavor::SMI::Default` constant.

      .. oe:constant:: Default

         Combination of
         :oe:const:`OEChem::OEOFlavor::SMI::AtomMaps`,
         :oe:const:`OEChem::OEOFlavor::SMI::AtomStereo`,
         :oe:const:`OEChem::OEOFlavor::SMI::BondStereo`,
         :oe:const:`OEChem::OEOFlavor::SMI::Canonical`,
         :oe:const:`OEChem::OEOFlavor::SMI::Isotopes` and
         :oe:const:`OEChem::OEOFlavor::SMI::RGroups` flags.

      .. oe:constant:: EnhStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::EnhStereo` constant.

      .. oe:constant:: ExtBonds

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::ExtBonds` constant.

      .. oe:constant:: Hydrogens

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Hydrogens` constant.

      .. oe:constant:: ImpHCount

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::ImpHCount` constant.

      .. oe:constant:: Isotopes

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Isotopes` constant.

      .. oe:constant:: Kekule

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Kekule` constant.

      .. oe:constant:: RGroups

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::RGroups` constant.

      .. oe:constant:: SmiMask

      .. oe:constant:: SuperAtoms

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::SuperAtoms` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::USM

      This namespace contains constants.

      .. oe:constant:: AllBonds

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AllBonds` constant.

      .. oe:constant:: AtomMaps

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AtomMaps` constant.

      .. oe:constant:: AtomStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::AtomStereo` constant.

      .. oe:constant:: BondStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::BondStereo` constant.

      .. oe:constant:: Canonical

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Canonical` constant.

      .. oe:constant:: DEFAULT

         Same as the :oe:const:`OEChem::OEOFlavor::USM::Default` constant.

      .. oe:constant:: Default

         Combination of
         :oe:const:`OEChem::OEOFlavor::USM::AtomMaps`,
         :oe:const:`OEChem::OEOFlavor::USM::RGroups` flags.

      .. oe:constant:: EnhStereo

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::EnhStereo` constant.

      .. oe:constant:: ExtBonds

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::ExtBonds` constant.

      .. oe:constant:: Hydrogens

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Hydrogens` constant.

      .. oe:constant:: ImpHCount

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::ImpHCount` constant.

      .. oe:constant:: Isotopes

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Isotopes` constant.

      .. oe:constant:: Kekule

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::Kekule` constant.

      .. oe:constant:: RGroups

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::RGroups` constant.

      .. oe:constant:: SmiMask

      .. oe:constant:: SuperAtoms

         Corresponds to the :oe:const:`OEChem::OESMILESFlag::SuperAtoms` constant.

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEOFlavor::XYZ

      The :oe:constns:`OEChem::OEOFlavor::XYZ` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OEWriteXYZFile` function
      when writing a molecule into a :oe:const:`OEChem::OEFormat::XYZ`
      format file.

      This namespace contains the following constants:

      .. oe:constant:: Charges

         Specifies that the partial charge for each atom should be
         appended as an additional column.

      .. oe:constant:: Symbols

         Write the atomic symbol instead of the atomic number.

      .. oe:constant:: SinglePrecision

         Forces coordinates to be written in single precision with only 5
         significant digits.

      .. oe:constant:: DoublePrecision

         Forces coordinates to be written in double precision with only 18
         significant digits.

      .. oe:constant:: Default

         Equivalent to ``Charges | Symbols``. By default, what
         precision, single or double precision will be introspected
         from the molecule type.


.. oe:namespace:: OEChem

.. oe:constnamespace:: OEPDBAtomName

   The :oe:constns:`OEChem::OEPDBAtomName` namespace encodes symbolic
   constants representing PDB atom types.

   .. seealso::

      * `PDB file format documentation <http://www.wwpdb.org/documentation/file-format>`_
      * [Markley-1998]_
      * :oe:func:`OEChem::OEGetPDBAtomIndex` function
      * :oe:func:`OEChem::OEGetPDBAtomName` function

   This namespace contains the following constants:

   .. oe:constant:: UNK

      Unknown atom name.

   .. oe:constant:: N

      Peptide backbone amide nitrogen.

   .. oe:constant:: CA

      Peptide backbone alpha carbon.

   .. oe:constant:: C

      Peptide backbone carbonyl carbon.

   .. oe:constant:: O

      Peptide backbone carbonyl oxygen.

   .. oe:constant:: CB

      Peptide sidechain beta carbon
      (for example :oe:const:`ALA<OEChem::OEResidueIndex::ALA>`).

   .. oe:constant:: CG

      Peptide sidechain gamma carbon
      (for example :oe:const:`LYS<OEChem::OEResidueIndex::LYS>`).

   .. oe:constant:: OG

      Peptide sidechain gamma oxygen
      (for example :oe:const:`SER<OEChem::OEResidueIndex::SER>`).

   .. oe:constant:: SG

      Peptide sidechain gamma sulfur
      (for example :oe:const:`CYS<OEChem::OEResidueIndex::CYS>`).

   .. oe:constant:: CG1

      Peptide sidechain beta carbon 1
      (for example the long arm of :oe:const:`ILE<OEChem::OEResidueIndex::ILE>`).

   .. oe:constant:: OG1

      Peptide sidechain beta oxygen 1
      (for example :oe:const:`THR<OEChem::OEResidueIndex::THR>`).

   .. oe:constant:: CG2

      Peptide sidechain beta carbon 2
      (for example the short arm of :oe:const:`ILE<OEChem::OEResidueIndex::ILE>`).

   .. oe:constant:: CD

      Peptide sidechain delta carbon
      (for example :oe:const:`LYS<OEChem::OEResidueIndex::LYS>`).

   .. oe:constant:: OD

      Peptide sidechain delta oxygen.

   .. oe:constant:: SD

      Peptide sidechain delta sulfur
      (for example :oe:const:`MET<OEChem::OEResidueIndex::MET>`).

   .. oe:constant:: CD1

      Peptide sidechain delta carbon 1
      (for example :oe:const:`ILE<OEChem::OEResidueIndex::ILE>`).

   .. oe:constant:: ND1

      Peptide sidechain delta nitrogen 1
      (for example :oe:const:`HIS<OEChem::OEResidueIndex::HIS>`).

   .. oe:constant:: OD1

      Peptide sidechain delta oxygen 1
      (for example :oe:const:`ASN<OEChem::OEResidueIndex::ASN>`).

   .. oe:constant:: CD2

      Peptide sidechain delta carbon 2
      (for example :oe:const:`HIS<OEChem::OEResidueIndex::HIS>`).

   .. oe:constant:: ND2

      Peptide sidechain delta nitrogen 2
      (for example :oe:const:`ASN<OEChem::OEResidueIndex::ASN>`).

   .. oe:constant:: OD2

      Peptide sidechain delta oxygen 2
      (for example :oe:const:`ASP<OEChem::OEResidueIndex::ASP>`).

   .. oe:constant:: SE_

      Peptide sidechain selenium
      (for example :oe:const:`MSE<OEChem::OEResidueIndex::MSE>`).

   .. oe:constant:: CE

      Peptide sidechain epsilon carbon
      (for example :oe:const:`MET<OEChem::OEResidueIndex::MET>`).

   .. oe:constant:: NE

      Peptide sidechain epsilon nitrogen
      (for example :oe:const:`ARG<OEChem::OEResidueIndex::ARG>`).

   .. oe:constant:: OE

      Peptide sidechain epsilon oxygen.

   .. oe:constant:: CE1

      Peptide sidechain epsilon carbon 1
      (for example :oe:const:`HIS<OEChem::OEResidueIndex::HIS>`).

   .. oe:constant:: NE1

      Peptide sidechain epsilon nitrogen 1
      (for example :oe:const:`TRP<OEChem::OEResidueIndex::TRP>`).

   .. oe:constant:: OE1

      Peptide sidechain epsilon oxygen 1
      (for example :oe:const:`GLN<OEChem::OEResidueIndex::GLN>`).

   .. oe:constant:: CE2

      Peptide sidechain epsilon carbon 2
      (for example :oe:const:`TRP<OEChem::OEResidueIndex::TRP>`).

   .. oe:constant:: NE2

      Peptide sidechain epsilon nitrogen 2
      (for example :oe:const:`GLN<OEChem::OEResidueIndex::GLN>`).

   .. oe:constant:: OE2

      Peptide sidechain epsilon oxygen 2
      (for example :oe:const:`GLN<OEChem::OEResidueIndex::GLN>`).

   .. oe:constant:: CE3

      Peptide sidechain epsilon carbon 3
      (for example :oe:const:`TRP<OEChem::OEResidueIndex::TRP>`).

   .. oe:constant:: OE3

      Peptide sidechain epsilon oxygen 3.

   .. oe:constant:: OE4

      Peptide sidechain epsilon oxygen 4.

   .. oe:constant:: CZ

      Peptide sidechain zeta carbon
      (for example :oe:const:`TYR<OEChem::OEResidueIndex::TYR>`).

   .. oe:constant:: NZ

      Peptide sidechain zeta nitrogen
      (for example :oe:const:`LYS<OEChem::OEResidueIndex::LYS>`).

   .. oe:constant:: CZ2

      Peptide sidechain zeta carbon 2
      (for example :oe:const:`TRP<OEChem::OEResidueIndex::TRP>`).

   .. oe:constant:: CZ3

      Peptide sidechain zeta carbon 3
      (for example :oe:const:`TRP<OEChem::OEResidueIndex::TRP>`).

   .. oe:constant:: OH

      Peptide sidechain eta oxygen
      (for example :oe:const:`TYR<OEChem::OEResidueIndex::TYR>`).

   .. oe:constant:: CH1

      Peptide sidechain eta carbon 1.

   .. oe:constant:: NH1

      Peptide sidechain eta nitrogen 1
      (for example :oe:const:`ARG<OEChem::OEResidueIndex::ARG>`).

   .. oe:constant:: CH2

      Peptide sidechain eta carbon 2
      (for example :oe:const:`TRP<OEChem::OEResidueIndex::TRP>`).

   .. oe:constant:: NH2

      Peptide sidechain eta nitrogen 2
      (for example :oe:const:`ARG<OEChem::OEResidueIndex::ARG>`).

   .. oe:constant:: CH3

      Methyl carbon
      (for example :oe:const:`ACE<OEChem::OEResidueIndex::ACE>`).

   .. oe:constant:: OXT

      Peptide backbone C-terminal oxygen.

   .. oe:constant:: P

      Nucleic acid backbone phosphate phosphorus.

   .. oe:constant:: O1P

      Nucleic acid backbone phosphate oxygen 1.

   .. oe:constant:: O2P

      Nucleic acid backbone phosphate oxygen 2.

   .. oe:constant:: O5_

      Nucleic acid backbone ribose oxygen 5-prime.

   .. oe:constant:: C5_

      Nucleic acid backbone ribose carbon 5-prime.

   .. oe:constant:: C4_

      Nucleic acid backbone ribose carbon 4-prime.

   .. oe:constant:: O4_

      Nucleic acid backbone ribose oxygen 4-prime.

   .. oe:constant:: C3_

      Nucleic acid backbone ribose carbon 3-prime.

   .. oe:constant:: O3_

      Nucleic acid backbone ribose oxygen 3-prime.

   .. oe:constant:: C2_

      Nucleic acid backbone ribose carbon 2-prime.

   .. oe:constant:: O2_

      Nucleic acid backbone ribose oxygen 2-prime.

   .. oe:constant:: C2A

      Methylated nucleic acid base carbon 2A
      (for example :oe:const:`2MG<OEChem::OEResidueIndex::_2MG>`).

   .. oe:constant:: C1_

      Nucleic acid backbone ribose carbon 1-prime.

   .. oe:constant:: N9

      Nucleic acid base nitrogen 9.

   .. oe:constant:: C8

      Nucleic acid base carbon 2.

   .. oe:constant:: N7

      Nucleic acid base nitrogen 7.

   .. oe:constant:: C5

      Nucleic acid base carbon 5.

   .. oe:constant:: C6

      Nucleic acid base carbon 6.

   .. oe:constant:: O6

      Nucleic acid base oxygen 6.

   .. oe:constant:: N6

      Nucleic acid base nitrogen 6.

   .. oe:constant:: N1

      Nucleic acid base nitrogen 1.

   .. oe:constant:: C2

      Nucleic acid base carbon 2.

   .. oe:constant:: O2

      Nucleic acid base oxygen 2.

   .. oe:constant:: N2

      Nucleic acid base nitrogen 2.

   .. oe:constant:: CM5

      Methylated nucleic acid base carbon M5
      (for example :oe:const:`5MC<OEChem::OEResidueIndex::_5MC>`).

   .. oe:constant:: N3

      Nucleic acid base nitrogen 3.

   .. oe:constant:: C3

      Nucleic acid base carbon 3.

   .. oe:constant:: C4

      Nucleic acid base carbon 4.

   .. oe:constant:: O4

      Nucleic acid base oxygen 4.

   .. oe:constant:: N4

      Nucleic acid base nitrogen 4.

   .. oe:constant:: CM7

      Methylated nucleic acid base carbon M7
      (for example :oe:const:`7MG<OEChem::OEResidueIndex::_7MG>`).

   .. oe:constant:: C5M

      Methylated nucleic acid base carbon 5M
      (for example methylated :oe:const:`T<OEChem::OEResidueIndex::T>`).

   .. oe:constant:: O3P

      Nucleic acid terminal phosphate oxygen 3P
      (for example :oe:const:`1MA<OEChem::OEResidueIndex::_1MA>`).

   .. oe:constant:: CM1

      Methylated nucleic acid base carbon M1
      (for example :oe:const:`1MA<OEChem::OEResidueIndex::_1MA>`).

   .. oe:constant:: CM2

      Methylated nucleic acid base carbon M2
      (for example :oe:const:`2MG<OEChem::OEResidueIndex::_2MG>`).

   .. oe:constant:: C10

      Modified nucleic acid base carbon 10
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: C11

      Modified nucleic acid base carbon 11
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: C12

      Modified nucleic acid base carbon 12
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: C13

      Modified nucleic acid base carbon 13
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: C14

      Modified nucleic acid base carbon 14
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: C15

      Modified nucleic acid base carbon 15
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: C16

      Modified nucleic acid base carbon 16
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: O17

      Modified nucleic acid base oxygen 17
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: O18

      Modified nucleic acid base oxygen 18
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: C19

      Modified nucleic acid base carbon 19
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: N20

      Modified nucleic acid base nitrogen 20
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: C21

      Modified nucleic acid base carbon 21
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: O22

      Modified nucleic acid base oxygen 22
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: O23

      Modified nucleic acid base oxygen 23
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: C24

      Modified nucleic acid base carbon 24
      (for example :oe:const:`YG<OEChem::OEResidueIndex::YG>`).

   .. oe:constant:: Cprev

      Refers to previous peptide backbone carbonyl carbon.

   .. oe:constant:: Nnext

      Refers to next peptide backbone amide nitrogen.

   .. oe:constant:: CAnext

      Refers to next peptide backbone alpha carbon.


.. oe:namespace:: OEChem

.. oe:constnamespace:: OEPerceived

   The :oe:constns:`OEChem::OEPerceived` namespace encodes symbolic constants
   representing whether or not various atom, bond or molecular properties have
   been perceived of a molecule.

   .. seealso::

      * :oe:meth:`OEChem::OEMolBase::HasPerceived` method
      * :oe:meth:`OEChem::OEMolBase::SetPerceived` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Aromaticity

      The :oe:const:`OEChem::OEPerceived::Aromaticity` flag is set by the
      :oe:func:`OEChem::OEAssignAromaticFlags` function.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AtomStereo

      The :oe:const:`OEChem::OEPerceived::AtomStereo` flag is set
      by the following functions:

      * :oe:func:`OEChem::OE3DToAtomStereo`
      * :oe:func:`OEChem::OEMDLStereoFromBondStereo` 
      * :oe:func:`OEChem::OEMDLStereoFromParity`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BondStereo

      The :oe:const:`OEChem::OEPerceived::BondStereo` flag is set
      by the :oe:func:`OEChem::OE3DToBondStereo` function.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Chains

      Currently not used by *OEChem*.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Chiral

      The :oe:const:`OEChem::OEPerceived::Chiral` flag is set by the
      :oe:func:`OEChem::OEPerceiveChiral` function.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Energy

      The :oe:const:`OEChem::OEPerceived::Energy` flag is set by the
      :oe:meth:`OEChem::OEMolBase::SetEnergy` method.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Hybridization

      The :oe:const:`OEChem::OEPerceived::Hybridization` flag is set by the
      :oe:func:`OEChem::OEAssignHybridization` function.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PartialCharges

      Currently not used by *OEChem*.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: RingAtomsAndBonds

      The :oe:const:`OEChem::OEPerceived::RingAtomsAndBonds` flag is set
      by the :oe:func:`OEChem::OEFindRingAtomsAndBonds` function.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SecondaryStructure

      The :oe:const:`OEChem::OEPerceived::SecondaryStructure` flag is set
      by the :oe:func:`OEChem::OEReadPDBFile` function.



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEPreserveResInfo

   The :oe:constns:`OEChem::OEPreserveResInfo` namespace encodes symbolic
   constants used as bit-masks to indicate which fields in the
   :ref:`OEResidue <OEChem_OEResidue>` class are preserved during an
   :oe:func:`OEChem::OEPerceiveResidues` function call.

   This namespace contains the following constants:

   .. oe:constant:: All

   .. oe:constant:: AlternateLocation

   .. oe:constant:: AtomName
   
   .. oe:constant:: ChainID

   .. oe:constant:: BFactor

   .. oe:constant:: Default

   .. oe:constant:: FragmentNumber

   .. oe:constant:: HetAtom

   .. oe:constant:: InsertCode

   .. oe:constant:: None

   .. oe:constant:: Occupancy
   
   .. oe:constant:: ResidueName

   .. oe:constant:: ResidueNumber
   
   .. oe:constant:: SerialNumber


.. oe:namespace:: OEChem

.. oe:constnamespace:: OEProperty

   This namespace contains constants.

   .. oe:constant:: Undefined
   
      Undefined

   .. oe:constant:: Aromatic
   
      Aromatic

   .. oe:constant:: Ring
   
      Ring

   .. oe:constant:: Donor
   
      Donor

   .. oe:constant:: Acceptor
   
      Acceptor

   .. oe:constant:: Both
   
      Both

   .. oe:constant:: Chiral
   
      Chiral

   .. oe:constant:: Exo
   
      Exo

   .. oe:constant:: Endo
   
      Endo

   .. oe:constant:: StereoDefined
   
      StereoDefined

   .. oe:constant:: Visit
   
      Visit

   .. oe:constant:: Deleted
   
      Deleted

   .. oe:constant:: Single
   
      Single

   .. oe:constant:: Double
   
      Double

   .. oe:constant:: Triple
   
      Triple

   .. oe:constant:: Closure
   
      Closure

   .. oe:constant:: Rotor
   
      Rotor

   .. oe:constant:: RingAtomsAndBonds
   
      RingAtomsAndBonds

   .. oe:constant:: ClosureBonds
   
      ClosureBonds

   .. oe:constant:: Chirality
   
      Chirality

   .. oe:constant:: Hybridization
   
      Hybridization

   .. oe:constant:: Kekule
   
      Kekule

   .. oe:constant:: Degree
   
      Degree

   .. oe:constant:: Valence
   
      Valence

   .. oe:constant:: PhCorrected
   
      PhCorrected

   .. oe:constant:: AtomTypes
   
      AtomTypes

   .. oe:constant:: Residue
   
      Residue

   .. oe:constant:: BondOrders
   
      BondOrders

   .. oe:constant:: HydrogenMode
   
      HydrogenMode

   .. oe:constant:: DeletedAtoms
   
      DeletedAtoms

   .. oe:constant:: DeletedBonds
   
      DeletedBonds

   .. oe:constant:: AtomTypeString
   
      AtomTypeString

   .. oe:constant:: BondTypeString
   
      BondTypeString

   .. oe:constant:: Isotope
   
      Isotope

   .. oe:constant:: PartialCharge
   
      PartialCharge

   .. oe:constant:: AtomTypeInt
   
      AtomTypeInt

   .. oe:constant:: AtomName
   
      AtomName

   .. oe:constant:: X
   
      X

   .. oe:constant:: Y
   
      Y

   .. oe:constant:: Z
   
      Z

   .. oe:constant:: MatchOrder
   
      MatchOrder

   .. oe:constant:: OEBase
   
      OEBase

   .. oe:constant:: Rxn
   
      Rxn

   .. oe:constant:: RxnRole
   
      RxnRole

   .. oe:constant:: AtomMemberPred
   
      AtomMemberPred

   .. oe:constant:: BondMemberPred
   
      BondMemberPred

   .. oe:constant:: BondStereo
   
      BondStereo

   .. oe:constant:: Component
   
      Component

   .. oe:constant:: AroModel
   
      AroModel

   .. oe:constant:: PartialChargeModel
   
      PartialChargeModel

   .. oe:constant:: Dimension
   
      Dimension

   .. oe:constant:: Perceived
   
      Perceived

   .. oe:constant:: MapIdx
   
      MapIdx

   .. oe:constant:: SymClass
   
      SymClass

   .. oe:constant:: All
   
      All

   .. oe:constant:: Radius
   
      Radius

   .. oe:constant:: Anisou
   
      Anisou

   .. oe:constant:: Monomer

      Used by :oe:func:`OEChem::OEHelmToMol` function to attach monomer (:oe:func:`OEChem::OEMonomerData`) into
      a molecule.

.. oe:namespace:: OEChem

.. _OEChem_OEProteinColorScheme:

.. oe:constnamespace:: OEProteinColorScheme

   This namespace contains constants.

   .. oe:constant:: AtomColor

      .. figure:: oechemtk/images/proteinColor/atomColor.*
         :align:  center

   .. oe:constant:: BEGIN

   .. oe:constant:: END



.. oe:namespace:: OEChem

.. _OEChem_OEProteinStyle:

.. oe:constnamespace:: OEProteinStyle

   The OEProteinStyle namespace encodes symbolic constants representing the 
   different protein styles that can be stored in an :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. The constants 
   can be used as an argument for the :oe:meth:`OEChem::OE3DMolStyle::SetProteinStyle` function in :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`.
   
   This namespace contains constants.

   .. oe:constant:: BEGIN

   .. oe:constant:: Backbone

      .. figure:: oechemtk/images/proteinStyle/backbone.*
         :align:  center

   .. oe:constant:: CAlpha

      .. figure:: oechemtk/images/proteinStyle/calpha.*
         :align:  center

   .. oe:constant:: END

   .. oe:constant:: Off

      .. figure:: oechemtk/images/proteinStyle/off.*
         :align:  center

   .. oe:constant:: Ribbons

      .. figure:: oechemtk/images/proteinStyle/ribbon.*
         :align:  center


.. oe:namespace:: OEChem

.. oe:constnamespace:: OEQMolType

   The :oe:constns:`OEChem::OEQMolType` namespace encodes symbolic constants
   representing  specific :ref:`OEQMolBase <OEChem_OEQMolBase>` class implementation types.

   .. seealso::

      * :oe:func:`OEChem::OENewQMolBase` function

   This namespace contains the following constants:

   .. oe:constant:: Undefined
   

   .. oe:constant:: OEDefault
   

   .. oe:constant:: MaxType
   



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:constnamespace:: OERadiiType

   This namespace contains the following constants used as
   options to :oe:func:`OEChem::OEAssignRadii`.

   .. seealso::

      * :ref:`section_periodictable_atomradius` section
      * :oe:constns:`OEChem::OEZap7Version`
      * :oe:constns:`OEChem::OEZap9Version`

   .. oe:constant:: BondiHVdw
   
      Bondi van der Waals radii,
      with polar hydrogen radii set to 0.95 |A|.

   .. oe:constant:: BondiVdw
   
      Assign Bondi van der Waals radii using :oe:func:`OEChem::OEAssignBondiVdWRadii`.

   .. oe:constant:: Covalent
   
      Assign covalent bonding radii using :oe:func:`OEChem::OEAssignCovalentRadii`.

   .. oe:constant:: Default
   
      When used as ``molRadiiType``,
      equates to :oe:constns:`OEChem::OERadiiType::BondiVdw`
      When used as ``ionRadiiType``, equates to
      whatever is specified for ``molRadiiType``.

   .. oe:constant:: Delphi
   
      Assign DelPhi radii using :oe:func:`OEChem::OEAssignDelphiRadii`.

   .. oe:constant:: Delphi_Robust
   
      DelPhi radii where the radii of unsupported atoms
      are assigned radii from :oe:constns:`OEChem::OERadiiType::BondiVdw`.

   .. oe:constant:: HonigIonicCavity
   
      Assign Honig effective ionic cavity radii using
      :oe:func:`OEChem::OEAssignHonigIonicCavityRadii`.

   .. oe:constant:: HonigIonicCavity_Robust
   
      Honig ionic cavity radii where the radii of unsupported atoms
      are assigned radii from :oe:constns:`OEChem::OERadiiType::Delphi`
      or :oe:constns:`OEChem::OERadiiType::BondiVdw`, in that order.

   .. oe:constant:: Max
   
      Total number of atomic radii constants.

   .. oe:constant:: None
   
      Atomic radii are all set to 0.0.

   .. oe:constant:: PaulingVdw
   
      Assign Pauling van der Waals radii using :oe:func:`OEChem::OEAssignPaulingVdWRadii`.

   .. oe:constant:: PaulingVdw_Robust
   
      Pauling van der Waals radii where the radii of unsupported atoms
      are assigned radii from :oe:constns:`OEChem::OERadiiType::Delphi`
      or :oe:constns:`OEChem::OERadiiType::BondiVdw`, in that order.

   .. oe:constant:: Zap7
   
      Equivalent to :oe:constns:`OEChem::OERadiiType::Zap7_CarbonylOxygen`.

   .. oe:constant:: Zap7_CarbonylOxygen
   
      Assign *Zap7* radii using :oe:func:`OEChem::OEAssignZap7Radii` with the parameter
      :oe:constns:`OEChem::OEZap7Version::CarbonylOxygen`.

   .. oe:constant:: Zap7_DoublyBondedOxygen
   
      Assign *Zap7* radii using :oe:func:`OEChem::OEAssignZap7Radii` with the parameter
      :oe:constns:`OEChem::OEZap7Version::DoublyBondedOxygen`.

   .. oe:constant:: Zap9
   
      Equivalent to :oe:constns:`OEChem::OERadiiType::Zap9_JCAMD2010`.

   .. oe:constant:: Zap9_JCAMD2010
   
      Assign *Zap9* radii using :oe:func:`OEChem::OEAssignZap9Radii` with the parameter
      :oe:constns:`OEChem::OEZap9Version::JCAMD2010`.

   .. oe:constant:: Zap9_JMC2008
   
      Assign *Zap9* radii using :oe:func:`OEChem::OEAssignZap9Radii` with the parameter
      :oe:constns:`OEChem::OEZap9Version::JMC2008`.



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEResidueIndex

   The :oe:constns:`OEChem::OEResidueIndex` namespace encodes symbolic
   constants representing residue indices returned by the
   :oe:func:`OEChem::OEGetResidueIndex` function(s).

   If the biopolymer residue name is not recognized, the
   :oe:func:`OEChem::OEGetResidueIndex` function returns either a zero
   or a unsigned integer value other than the values listed below.

   .. note::

      As future releases of **OEChem** may add to this namespace, code
      should not test for zero, but instead check against the relevant
      values and treat all other values as 'unrecognized'.

   This namespace contains the following constants:

   .. oe:constant:: ALA

   .. oe:constant:: ARG

   .. oe:constant:: ASN

   .. oe:constant:: ASP

   .. oe:constant:: CYS

   .. oe:constant:: GLN

   .. oe:constant:: GLU

   .. oe:constant:: GLY

   .. oe:constant:: HIS

   .. oe:constant:: ILE

   .. oe:constant:: LEU

   .. oe:constant:: LYS

   .. oe:constant:: MET

   .. oe:constant:: PHE

   .. oe:constant:: PRO

   .. oe:constant:: SER

   .. oe:constant:: THR

   .. oe:constant:: TRP

   .. oe:constant:: TYR

   .. oe:constant:: VAL

   .. oe:constant:: UNK

   .. oe:constant:: ASX

   .. oe:constant:: GLX

   .. oe:constant:: ASH

   .. oe:constant:: CYX

   .. oe:constant:: CYH

   .. oe:constant:: CYM

   .. oe:constant:: GLH

   .. oe:constant:: HID

   .. oe:constant:: HIE

   .. oe:constant:: HIP

   .. oe:constant:: LYN

   .. oe:constant:: TYM

   .. oe:constant:: A

   .. oe:constant:: C

   .. oe:constant:: G

   .. oe:constant:: I

   .. oe:constant:: T

   .. oe:constant:: U

   .. oe:constant:: DA

   .. oe:constant:: DC

   .. oe:constant:: DG

   .. oe:constant:: DI

   .. oe:constant:: DU

   .. oe:constant:: _1MA

   .. oe:constant:: _2MG

   .. oe:constant:: _5MC

   .. oe:constant:: _5MU

   .. oe:constant:: _7MG

   .. oe:constant:: H2U

   .. oe:constant:: M2G

   .. oe:constant:: OMC

   .. oe:constant:: OMG

   .. oe:constant:: PSU

   .. oe:constant:: YG

   .. oe:constant:: ABA

   .. oe:constant:: ACE

   .. oe:constant:: CGU

   .. oe:constant:: CME

   .. oe:constant:: CSD

   .. oe:constant:: FOR

   .. oe:constant:: HSE

   .. oe:constant:: HYP

   .. oe:constant:: HYL

   .. oe:constant:: LYZ

   .. oe:constant:: MEN

   .. oe:constant:: MLE

   .. oe:constant:: MLY

   .. oe:constant:: MSE

   .. oe:constant:: ORN

   .. oe:constant:: PCA

   .. oe:constant:: PTR

   .. oe:constant:: SAR

   .. oe:constant:: SEP

   .. oe:constant:: TAU

   .. oe:constant:: TPO

   .. oe:constant:: LIG

   .. oe:constant:: MOL

   .. oe:constant:: UNL

   .. oe:constant:: BR

   .. oe:constant:: CL

   .. oe:constant:: ADP

   .. oe:constant:: AF3

   .. oe:constant:: ALF

   .. oe:constant:: ATP

   .. oe:constant:: BME

   .. oe:constant:: DMS

   .. oe:constant:: EDO

   .. oe:constant:: EOH

   .. oe:constant:: FAD

   .. oe:constant:: GOL

   .. oe:constant:: HEM

   .. oe:constant:: HOH

   .. oe:constant:: IOD

   .. oe:constant:: MOH

   .. oe:constant:: NAD

   .. oe:constant:: NAG

   .. oe:constant:: PEO

   .. oe:constant:: PER

   .. oe:constant:: PO2

   .. oe:constant:: PO4

   .. oe:constant:: SO2

   .. oe:constant:: SO4

   .. oe:constant:: SX

   .. oe:constant:: NHE

   .. oe:constant:: NME

   .. oe:constant:: CIP

   .. oe:constant:: CIM

   .. oe:constant:: RU

   .. oe:constant:: SB

   .. oe:constant::   V

   .. oe:constant::  MN

   .. oe:constant:: MN3

   .. oe:constant::  FE

   .. oe:constant:: FE2

   .. oe:constant::  CO

   .. oe:constant:: CO3

   .. oe:constant::  NI

   .. oe:constant:: _3NI

   .. oe:constant:: CU1

   .. oe:constant::  CU

   .. oe:constant::  Y1

   .. oe:constant:: YT3

   .. oe:constant:: _4MO

   .. oe:constant:: _6MO

   .. oe:constant::  EU

   .. oe:constant:: EU3

   .. oe:constant::  AU

   .. oe:constant:: AU3

   .. oe:constant:: PT4

   .. oe:constant::  PT

   .. oe:constant:: IR3

   .. oe:constant::  IR

   .. oe:constant::  OS

   .. oe:constant:: OS4

   .. oe:constant::  YB

   .. oe:constant:: YB2

   .. oe:constant:: _4TI

.. oe:namespace:: OEChem

.. oe:constnamespace:: OERxnRole

   The :oe:constns:`OEChem::OERxnRole` namespace encodes symbolic
   constants representing for the 'role' property of
   :ref:`OEAtomBase <OEChem_OEAtomBase>` objects
   This stored property is used to record that 'role' played by the
   atom in a reaction molecule.

   .. seealso::
 
      * :oe:meth:`OEChem::OEAtomBase::GetRxnRole` method
      * :oe:meth:`OEChem::OEAtomBase::SetRxnRole` method

   This namespace contains the following constants:

   .. oe:constant:: None
   

   .. oe:constant:: Reactant
   

   .. oe:constant:: Agent
   

   .. oe:constant:: Catalyst
   

   .. oe:constant:: Product
   



.. oe:namespace:: OEChem

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:constnamespace:: OESLNFlag

   This namespace contains constants.

   .. oe:constant:: Isotopes
   
      Controls whether isotopic mass is written to the generated SLN strings.

   .. oe:constant:: Hydrogens
   
      Controls whether explicit hydrogens are automatically suppressed and
      written to the SLN string as part of an atom's implicit hydrogen
      count.

   .. oe:constant:: Canonical
   
      Controls whether we attempt to generate canonical SLN strings.

   .. oe:constant:: Kekule
   
      Controls whether we generate |Kekule| or aromatic SLN strings.  The
      :oe:func:`OEChem::OECreateSlnString` function uses the currently
      assigned aromaticity model.  Ideally, from compatibility with Tripos
      generated SLN, the user should assign Tripos aromaticity to the
      molecule when writing aromatic SLN, calling the function
      :oe:func:`OEChem::OEAssignAromaticFlags` with
      :oe:const:`OEChem::OEAroModel::Tripos` aromaticity model.

   .. oe:constant:: Name
   
      Controls whether we append the SLN name attribute to the end of each 
      SLN string.

   .. oe:constant:: FCharge
   
      Controls whether we output the partial charge on each atom.

   .. oe:constant:: Coords2D
   

   .. oe:constant:: Coords3D
   

   .. oe:constant:: DEFAULT
   
      The default value, :oe:const:`OEChem::OESLNFlag::DEFAULT` currently contains the
      flavor :oe:const:`OEChem::OESLNFlag::Name`.



.. oe:namespace:: OEChem

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _oechem_OESMILESFlag:

.. oe:constnamespace:: OESMILESFlag

   This namespace contains constants that controls the generation of
   SMILES when calling the low-level :oe:func:`OEChem::OECreateSmiString`
   function.

   .. list-table:: **The following function calls generate identical SMILES**
      :widths: 50 200
      :header-rows: 1

      * - OEChem function
        - calling :oe:func:`OEChem::OECreateSmiString` with flags from the :oe:constns:`OEChem::OESMILESFlag` namespace

      * - :oe:func:`OEChem::OECreateAbsSmiString`
        - :oe:const:`AtomMaps<OEChem::OESMILESFlag::AtomMaps>` | :oe:const:`RGroups<OEChem::OESMILESFlag::RGroups>`

      * - :oe:func:`OEChem::OECreateCanSmiString`
        - :oe:const:`DEFAULT<OEChem::OESMILESFlag::DEFAULT>` identical to :oe:const:`Canonical<OEChem::OESMILESFlag::Canonical>` | :oe:const:`AtomMaps<OEChem::OESMILESFlag::AtomMaps>` | :oe:const:`RGroups<OEChem::OESMILESFlag::RGroups>`

      * - :oe:func:`OEChem::OECreateIsoSmiString`
        - :oe:const:`ISOMERIC<OEChem::OESMILESFlag::ISOMERIC>` identical to :oe:const:`Isotopes<OEChem::OESMILESFlag::Isotopes>` | :oe:const:`AtomStereo<OEChem::OESMILESFlag::AtomStereo>` | :oe:const:`BondStereo<OEChem::OESMILESFlag::BondStereo>` | :oe:const:`Canonical<OEChem::OESMILESFlag::Canonical>` | :oe:const:`AtomMaps<OEChem::OESMILESFlag::AtomMaps>` | :oe:const:`RGroups<OEChem::OESMILESFlag::RGroups>`

      * - :oe:func:`OEChem::OEMolToSmiles`
        - :oe:const:`ISOMERIC<OEChem::OESMILESFlag::ISOMERIC>` identical to :oe:const:`Isotopes<OEChem::OESMILESFlag::Isotopes>` | :oe:const:`AtomStereo<OEChem::OESMILESFlag::AtomStereo>` | :oe:const:`BondStereo<OEChem::OESMILESFlag::BondStereo>` | :oe:const:`Canonical<OEChem::OESMILESFlag::Canonical>` | :oe:const:`AtomMaps<OEChem::OESMILESFlag::AtomMaps>` | :oe:const:`RGroups<OEChem::OESMILESFlag::RGroups>`

   [1] :oe:func:`OEChem::OEMolToSmiles` is a high-level function that perceives necessary properties before generating :term:`canonical isomeric SMILES`

   .. oe:constant:: AllBonds

      Controls whether all bonds are written explicitly to the generated
      SMILES string.  By default, aromatic bonds and most single bonds will
      be omitted since the semantics are unambiguous.

      This option is convenient for using SMILES as a generic graph
      representation language and for simple SMILES processors which do not
      perceive aromaticity.

      For example, will generate ``c:1:c:c:c:c:c1`` for benzene rather than
      ``c1ccccc1``.

   .. oe:constant:: AtomMaps

      Controls whether atom map indices are written to the generated SMILES string.
      *OEChem* allows the use of atom map indices on molecules other than reactions,
      *e.g.* ``[CH4:1]`` SMILES.

   .. _oechem_OESMILESFlag_AtomStereo:

   .. oe:constant:: AtomStereo

      Controls whether the specified chirality at tetrahedral atomic stereocenters
      should be written to the generated SMILES string.

   .. oe:constant:: BondStereo

      Controls whether the specified cis/trans chirality at bond stereocenters
      should be written to the generated SMILES string.

   .. oe:constant:: Canonical

      Controls whether to generate canonical SMILES strings.
      The canonical SMILES strings generated by *OEChem* are not canonicalized by the same
      algorithm used by Daylight Chemical Information Systems, and hence some molecules
      will be assigned a different unique representation by each toolkit.
      Indeed, the algorithms used both by OpenEye and Daylight evolve and improve over time,
      so SMILES should always be recanonicalized by the same version of a toolkit,
      before comparing them for equivalence.

   .. oe:constant:: EnhStereo

      Controls whether explicit enhanced stereogroup information is exported as a :term:`CXSMILES`
      formatted appendix following the generated SMILES string.  The :term:`CXSMILES` appendix is
      whitespace delimited and begins and ends with ``|``.

   .. oe:constant:: ExtBonds

      Controls whether atoms with atomic number zero (as determined by the
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum` method),
      and a non-zero map index (as determined by the :oe:meth:`OEChem::OEAtomBase::GetMapIdx`
      method) should be generated the external bond ``&1`` notation.
      In this notation, the integer value following the ``&`` corresponds to
      the atom's map index.
      When this flag isn't set, such atoms are written in the Daylight convention ``[*:1]``.

   .. oe:constant:: Hydrogens

      Controls whether explicit hydrogens are included in the SMILES string.  If not set,
      explicit hydrogens are included in each atom's implicit hydrogen count.

   .. oe:constant:: ImpHCount

      Controls whether implicit hydrogen count is written to the generated
      SMILES strings.  For example, to generate ``[cH]1[cH][cH][cH][cH][cH]1``
      for benzene rather than ``c1ccccc1``.

   .. oe:constant:: Isotopes

      Controls whether isotopic mass is written to the generated SMILES strings.

   .. oe:constant:: Kekule

      Controls whether to generate |Kekule| or aromatic SMILES strings.
      The :oe:func:`OEChem::OECreateSmiString` function uses the currently assigned
      aromaticity model.
      There are known portability problems with different SMILES parsers having
      varying degrees of ability in parsing aromatic systems, hence writing |Kekule|
      SMILES or using a simple model of aromaticity
      (see the function :oe:func:`OEChem::OEAssignAromaticFlags`)
      can be used to improve interoperability with non-OpenEye software.

   .. oe:constant:: RGroups

      Controls whether atoms with atomic number zero (as determined by the
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum` method),
      and a non-zero map index (as determined by the :oe:meth:`OEChem::OEAtomBase::GetMapIdx`
      method) should be displayed using the ``[R1]`` notation.
      In this notation, the integer value following the ``R`` corresponds to the atom's map
      index.
      When this flag isn't set, such atoms are written in the Daylight convention ``[*:1]``.

   .. oe:constant:: SuperAtoms

      Controls whether atoms with atomic number zero (as determined by the
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum` method),
      and a non-empty name string property (as determined by the
      :oe:meth:`OEChem::OEAtomBase::GetName`) should be displayed in SMILES *superatom*
      notation, rather than just ``[*]``.
      For example, this can be used to generate the SMILES ``[Asp][Gly][Lys]``.

   .. oe:constant:: DEFAULT

      The combination of
      :oe:const:`OEChem::OESMILESFlag::RGroups`,
      :oe:const:`OEChem::OESMILESFlag::AtomMaps` and
      :oe:const:`OEChem::OESMILESFlag::Canonical` flavors,
      that is used to generate :term:`canonical SMILES`

   .. oe:constant:: ISOMERIC

      The combination of
      :oe:const:`OEChem::OESMILESFlag::RGroups`,
      :oe:const:`OEChem::OESMILESFlag::AtomMaps`,
      :oe:const:`OEChem::OESMILESFlag::Canonical`,
      :oe:const:`OEChem::OESMILESFlag::Isotopes`,
      :oe:const:`OEChem::OESMILESFlag::AtomStereo` and
      :oe:const:`OEChem::OESMILESFlag::BondStereo` flavors,
      that is used to generate :term:`canonical isomeric SMILES`.


.. oe:namespace:: OEChem

.. oe:constnamespace:: OESmartsParseOpts

   The :oe:constns:`OEChem::OESmartsParseOpts` namespace encodes symbolic
   constants used as bit-masks to indicate how to interpret :term:`SMARTS`
   and :term:`SMIRKS` strings.

   .. seealso:: 

      * :oe:func:`OEChem::OEParseSmarts` function
      * :oe:func:`OEChem::OEParseSmirks` function

   This namespace contains constants.

   .. oe:constant:: Default

      The combination of the following flags.

      * :oe:const:`OEChem::OESmartsParseOpts::RingConstraint`
      * :oe:const:`OEChem::OESmartsParseOpts::Optimize`

   .. oe:constant:: None

      Only constraints explicitly specified in the :term:`SMARTS` and :term:`SMIRKS` 
      strings are added to the :ref:`OEQMolBase <OEChem_OEQMolBase>` query structure.

   .. oe:constant:: Optimize

      When the :oe:const:`OEChem::OESmartsParseOpts::Optimize` option is
      turned on, the atom and bond expressions are optimized for
      substructure search.

   .. oe:constant:: RingConstraint

      Additional ring constraint is added to each ring atom of the 
      generated :ref:`OEQMolBase <OEChem_OEQMolBase>` query molecule.

      This can significantly increase the performance of the substructure 
      search. 
      For example, matching the ``C1CCCCC1`` ring against the ``CCCCCCCC`` chain
      will fail much faster, since none of the query ring atoms can be mapped to 
      any of the target chain atom.


.. oe:namespace:: OEChem

.. _OEChem_OEStyleGridType:

.. oe:constnamespace:: OEStyleGridType

   This namespace contains constants.

   .. oe:constant:: BEGIN

   .. oe:constant:: END

   .. oe:constant:: Electrostatic



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:constnamespace:: OESubSearchDatabaseType

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants representing how search data
   (molecules and pre-generated screens) are stored and searched in an
   :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` object.

   This namespace contains the following constants.

   .. oe:constant:: Default

      The default type is :oe:const:`OEChem::OESubSearchDatabaseType::InMemoryMultiThreaded`.

   .. oe:constant:: InMemoryMultiThreaded

      When an :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` is initialized with the
      :oe:const:`OEChem::OESubSearchDatabaseType::InMemoryMultiThreaded` type,
      the search data, both molecules and pre-generated screens, are
      pre-loaded into memory.

      This mode is memory intensive, but it provides the **fastest** way to search a
      dataset when utilizing all available processors on the machine.

   .. oe:constant:: MolDatabaseMultiThreaded

      When an :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` is initialized with the
      :oe:const:`OEChem::OESubSearchDatabaseType::MolDatabaseMultiThreaded` type,
      **only** the pre-generated screens are pre-loaded into memory.
      During the search, if a molecule can not be rejected based on its screen, then
      it has to be loaded from disk on-the-fly to perform atom-by-atom validation.

      This mode is not as fast as
      :oe:const:`OEChem::OESubSearchDatabaseType::InMemoryMultiThreaded` mode, however,
      it requires significantly less memory, allowing to searches on larger datasets.
      The performance loss is highly dependent on the query and its screening performance.
      If a significantly large number of hits can be pre-screened, searching only a couple
      thousands molecules can be done very fast even with the added I/O cost of loading
      molecules on the fly.

   .. note::

      In both modes, searches can be executed in single or multi-treaded way
      based on the parameter (maximum number of processors) that was determined
      when the database was constructed.

   .. seealso::

      * :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` class

   .. admonition:: Code Example

      * :ref:`section_example_oechem_searchfastss` example


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:constnamespace:: OESubSearchScreenType

   .. attention::

      |TWOLANGUAGE|

   The :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>` objects are typed bit-vectors.
   The type of a screen determines what kind of queries in mind the screen was
   designed.

   In **OEChem TK**, a query molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`) can be
   constructed in three different ways.

   .. list-table::
      :widths: 50 100 100 150
      :header-rows: 1

      * - Screen Type
        - Description
        - Initialize
        - See Also

      * - :oe:const:`OEChem::OESubSearchScreenType::MDL`
        - query read from MDL query file
        - :oe:func:`OEChem::OEReadMDLQueryFile`
        - :ref:`chapter_mdlqueries`

      * - :oe:const:`OEChem::OESubSearchScreenType::Molecule`
        - query built from molecule
        - :oe:meth:`BuildExpressions<OEChem::OEQMolBase::BuildExpressions>`
        -

      * - :oe:const:`OEChem::OESubSearchScreenType::SMARTS`
        - query built from SMARTS pattern
        - :oe:func:`OEChem::OEParseSmarts`
        - :ref:`chapter_SMARTS`

   The expression trees of the queries that are initialized from different sources
   can be significantly different.
   For example, the "language" of :term:`SMARTS` is the most expressive one allowing
   complex logical operations and recursive patterns.
   A :term:`SMARTS` such as ``[NX3;H2,H1;!$(NC=O)]`` (primary or secondary amine that is not in amide)
   defines a substructure that can not be expressed using MDL query features.
   This also makes queries built from :term:`SMARTS` the most complex ones.
   The other major difference between :term:`SMARTS` and MDL queries is the way how they
   are expected to match aromaticity. For these reasons, **OEChem TK** provides three
   different screen types especially designed for the three different ways that are
   available to built query molecules using **OEChem TK**.

   .. note::

      For performance reason, **OEChem TK** does not support screening-based fast substructure
      search with explicit hydrogens.
      The :oe:func:`OEChem::OEMakeSubSearchTargetScreen` function automatically suppresses explicit
      hydrogens of the molecule prior to the screen generation.
      The :oe:func:`OEChem::OEMakeSubSearchQueryScreen` function will return ``false`` if the query
      molecule has any explicit hydrogen expression.

   .. oe:constant:: Default

      The default screen type is :oe:const:`OEChem::OESubSearchScreenType::MDL`.

   .. oe:constant:: MDL

      .. oe:language:: c++ python

         The following code snippet shows how to create
         :oe:const:`OEChem::OESubSearchScreenType::MDL` screens.

         .. oe:source:: MakeMDLScreen.cpp
            :language: c++
            :noindent:
            :frag:     SNIPPET

         .. oe:source:: MakeMDLScreen.py
            :language: python
            :noindent:
            :frag:     SNIPPET

   .. oe:constant:: Molecule

      .. oe:language:: c++ python

         The following code snippet shows how to create
         :oe:const:`OEChem::OESubSearchScreenType::Molecule` screens.
         The query molecule is created from a "real" molecule using
         the :oe:meth:`BuildExpressions<OEChem::OEQMolBase::BuildExpressions>`
         method.

         .. oe:source:: MakeMoleculeScreen.cpp
            :language: c++
            :noindent:
            :frag:     SNIPPET

         .. oe:source:: MakeMoleculeScreen.py
            :language: python
            :noindent:
            :frag:     SNIPPET

      .. note::

         * It is highly recommended to use the :oe:const:`OEChem::OEExprOpts::DefaultAtoms` and
           :oe:const:`OEChem::OEExprOpts::DefaultBonds` options when building the query molecule
           with the :oe:meth:`BuildExpressions<OEChem::OEQMolBase::BuildExpressions>`.
           When using other option combinations, the built query molecule  might not be suitable
           for the :oe:const:`OEChem::OESubSearchScreenType::Molecule` screen type.

         * If the input molecule has any explicit hydrogens, the
           :oe:func:`OEChem::OESuppressHydrogens` function should be called prior to calling
           :oe:meth:`BuildExpressions<OEChem::OEQMolBase::BuildExpressions>`.

   .. oe:constant:: SMARTS

      .. oe:language:: c++ python

         The following code snippet shows how to create
         :oe:const:`OEChem::OESubSearchScreenType::SMARTS` screens.

         .. oe:source:: MakeSMARTSScreen.cpp
            :language: c++
            :noindent:
            :frag:     SNIPPET

         .. oe:source:: MakeSMARTSScreen.py
            :language: python
            :noindent:
            :frag:     SNIPPET

   .. hint::

      In case of a query molecule of unknown source, the
      :oe:func:`OEChem::OEIsComplementaryScreenType` function can be used to check
      whether the query molecule is suited for a specific screen type.

   .. oe:constant: Unknown # IGNORING DOCUMENTATON

   .. seealso::

      * :oe:func:`OEChem::OEMakeSubSearchQueryScreen` and
        :oe:func:`OEChem::OEMakeSubSearchTargetScreen` functions

   .. admonition:: Code Example

      * :ref:`section_example_oechem_makefastss` example
      * :ref:`section_example_oechem_searchfastss` example


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:constnamespace:: OESubSearchStatus

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants representing the various status of the
   substructure search (:oe:meth:`OEChem::OESubSearchResult::GetSearchStatus`).

   .. oe:constant:: Canceled

      This constant indicates that the substructure search was canceled by invoking
      :oe:meth:`OEChem::OESubSearchResult::Cancel`.

   .. oe:constant:: Finished

      This constant indicates that the substructure search was finished successfully.

   .. oe:constant:: InProgress

      This constant indicates that the substructure search is in progress.

   .. oe:constant:: Uninitialized

      This constant indicates that the substructure search can not be initialized.
      For example, attempting a search on an invalid :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>`
      object.

   .. seealso::

      * :oe:meth:`OEChem::OESubSearchDatabase::Search` method
      * :oe:func:`OEChem::OESubSearchStatusToName` function

   .. admonition:: Code Example

      * :ref:`section_example_oechem_searchfastss` example


.. oe:namespace:: OEChem

.. _OEChem_OESurfaceColorScheme:

.. oe:constnamespace:: OESurfaceColorScheme

   The OESurfaceColorScheme namespace encodes symbolic constants representing the 
   different surface color schemes. The constants can be used as an argument when 
   constructing a :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>` which can be used as an argument for the 
   :ref:`SetSurfaceColorer <OEChem_OE3DMolStyle_SetSurfaceColorer>` method in :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`.

   This namespace contains constants.

   .. oe:constant:: AtomColor

   .. oe:constant:: BEGIN

   .. oe:constant:: Concavity

   .. oe:constant:: Curvature

   .. oe:constant:: Distance

   .. oe:constant:: END

   .. oe:constant:: Electrostatic

   .. oe:constant:: GenericData

   .. oe:constant:: Grid

   .. oe:constant:: HBondPotential

   .. oe:constant:: Hydrophobicity

   .. oe:constant:: Solid

   .. oe:constant:: SurfacePotential



.. oe:namespace:: OEChem

.. _OEChem_OESurfaceStyle:

.. oe:constnamespace:: OESurfaceStyle

   The OESurfaceStyle namespace encodes symbolic constants representing the 
   different surface styles for the :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. The constants can be used 
   as an argument for the :oe:meth:`OEChem::OE3DMolStyle::SetSurfaceStyle` function in :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. 

   This namespace contains constants.

   .. oe:constant:: BEGIN

   .. oe:constant:: END

   .. oe:constant:: Mesh

      .. figure:: oechemtk/images/surfaceStyle/mesh.*
         :align:  center

   .. oe:constant:: Points

      .. figure:: oechemtk/images/surfaceStyle/points.*
         :align:  center

   .. oe:constant:: Solid

      .. figure:: oechemtk/images/surfaceStyle/solid.*
         :align:  center


.. oe:namespace:: OEChem

.. _OEChem_OESurfaceType:

.. oe:constnamespace:: OESurfaceType

   The OESurfaceType namespace encodes symbolic constants representing the 
   different surface types for the :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. The constants can be used 
   as an argument for the :oe:meth:`OEChem::OE3DMolStyle::SetSurfaceType` function in :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`.

   This namespace contains constants.

   .. oe:constant:: Accessible

   .. oe:constant:: BEGIN

   .. oe:constant:: END

   .. oe:constant:: Molecular

   .. oe:constant:: Off

   .. oe:constant:: VDW



.. oe:namespace:: OEChem

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:constnamespace:: OETriposType

   The :oe:constns:`OEChem::OETriposType` namespace encodes symbolic
   constants representing Tripos atom types.
   These values are typically calculated by atom typing, read
   from a Sybyl mol2 format file and used in writing Sybyl mol2 format
   files.

   This namespace contains the following constants:

   .. oe:constant:: Du
   
      Dummy      

   .. oe:constant:: Al
   
      Aluminium

   .. oe:constant:: Br
   
      Bromine

   .. oe:constant:: C1
   
      Carbon :math:`sp` 

   .. oe:constant:: C2
   
      Carbon :math:`sp^2` 

   .. oe:constant:: C3
   
      Carbon :math:`sp^3`

   .. oe:constant:: Car
   
      Carbon aromatic 

   .. oe:constant:: Ccat
   
      :math:`C^+`  carbocation

   .. oe:constant:: Ca
   
      Calcium

   .. oe:constant:: Cl
   
      Chlorine

   .. oe:constant:: Cooh

      Cobalt (octahedral)
   .. oe:constant:: Crth

      Chromium (octahedral)

   .. oe:constant:: Croh

      Chromium (tetrahedral)

   .. oe:constant:: Cu

      Copper

   .. oe:constant:: F
   
      Fluorine

   .. oe:constant:: Fe

      Iron

   .. oe:constant:: H
   
      Hydrogen

   .. oe:constant:: I
   
      Iodine

   .. oe:constant:: K
   
      Potassium

   .. oe:constant:: Li
   
      Lithium

   .. oe:constant:: Lp
   
      Lone pair

   .. oe:constant:: Mg

      Magnesium

   .. oe:constant:: Mn

      Manganese

   .. oe:constant:: Mo

      Molybdenum

   .. oe:constant:: N1
   
      Nitrogen :math:`sp`

   .. oe:constant:: N2
   
      Nitrogen :math:`sp^2`

   .. oe:constant:: N3
   
      Nitrogen :math:`sp^3`

   .. oe:constant:: N4
   
      Nitrogen :math:`sp^3` with positive charge

   .. oe:constant:: Nam
     
      Nitrogen in amide

   .. oe:constant:: Nar
   
      Nitrogen aromatic

   .. oe:constant:: Npl3
   
      Nitrogen trigonal planar

   .. oe:constant:: Na
     
      Sodium

   .. oe:constant:: O2
   
      Oxygen :math:`sp^2`

   .. oe:constant:: O3
   
      Oxygen :math:`sp^3`

   .. oe:constant:: Oco2
   
      Oxygen in carboxylate 

   .. oe:constant:: P3
   
      Phosphorous :math:`sp^3`

   .. oe:constant:: S2
   
      Sulfur :math:`sp^2`

   .. oe:constant:: S3
   
      Sulfur :math:`sp^3`

   .. oe:constant:: Se

      Selenium

   .. oe:constant:: So
   
      Sulfur in sulfoxide

   .. oe:constant:: So2
   
      Sulfur in sulfone

   .. oe:constant:: Si
   
      Silicon

   .. oe:constant:: Sn

      Tin
   .. oe:constant:: Zn

      Zinc

   .. oe:constant:: MAXTYPE



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEUncolorStrategy

   The :oe:constns:`OEChem::OEUncolorStrategy` namespace encodes symbolic constants
   representing types of actions for molecule uncoloring activities.

   .. seealso::

      * :oe:func:`OEChem::OEUncolorMol` function

   This namespace contains the following constants:

   .. oe:constant:: Default

      The default uncolor action is :oe:const:`OEChem::OEUncolorStrategy::RemoveDimension` and
      :oe:const:`OEChem::OEUncolorStrategy::BemisMurcko`.

   .. oe:constant:: UncolorNone

      This mode requests no changes be made to the structure.

   .. oe:constant:: ConvertAtomTypeToC

      Convert all non-hydrogen atom types to carbon.

   .. oe:constant:: ConvertBondTypeToSingle

      Convert all bond types to single bonds.

   .. oe:constant:: RemoveAtomStereo

      Remove any atom stereo parity values as well as any stereo bond marks, also implies RemoveGroupStereo.

   .. oe:constant:: RemoveBondStereo

      Remove any cis/tran bond parity values as well as any double either marks.

   .. oe:constant:: RemoveGroupStereo

      Removes all MDL stereogroups (''abs'', ''or'', and ''and'' groups).

   .. oe:constant:: RemoveAtomProperties

      Remove the following properties from the atoms: charge, aromaticity, isotope and map index values.

   .. oe:constant:: RemoveDimension

      Clears the coordinates, resets stereo perception flags and sets the coordinate dimension to ``0``.

   .. oe:constant:: BemisMurcko

      This mode embodies the following actions: :oe:const:`OEChem::OEUncolorStrategy::ConvertAtomTypeToC`,
      :oe:const:`OEChem::OEUncolorStrategy::ConvertBondTypeToSingle`,
      :oe:const:`OEChem::OEUncolorStrategy::RemoveAtomStereo`,
      :oe:const:`OEChem::OEUncolorStrategy::RemoveBondStereo`,
      :oe:const:`OEChem::OEUncolorStrategy::RemoveAtomProperties`


.. oe:namespace:: OEChem

.. oe:constnamespace:: OEUniMolecularRxnFixValence

   This namespace contains constants representing various supported
   valence fixup actions after a successfully applied reaction transformation.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      This constant requests that all atoms
      in the transformed products be checked for valence issues.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Altered

      This constant requests that only atoms modified by the transformation
      in the transformed products be checked for valence issues.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DEFAULT
   .. oe:constant:: Default

      This constant requests the default action valence correction
      setting of :oe:const:`OEChem::OEUniMolecularRxnFixValence::Explicit`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Explicit

      This constant requests that no atoms
      in the transformed products be checked for valence issues.
      It is assumed that the reaction transformation itself
      provides expicit valence corrections as part of the transform.



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEWriteMolReturnCode

   The :oe:constns:`OEChem::OEWriteMolReturnCode` namespace encodes symbolic
   constants representing error codes returned by the high-level write
   functions :oe:func:`OEChem::OEWriteMolecule` and
   :oe:func:`OEChem::OEWriteConstMolecule`.

   This namespace contains the following constants:
   
   .. oe:constant:: Success

      This constant indicates that the molecule has been written out successfully.

   .. oe:constant:: FormatNotWritable

      This constant indicates that an unsupported output format for write was attempted.
      See :oe:func:`OEChem::OEIsWriteable`.

   .. oe:constant:: OEBWriteFailure

      This constant indicates a general error occurred when serializing the structure to :oe:const:`OEChem::OEFormat::OEB`.

   .. oe:constant:: TooManyAtoms

      This constant indicate that the molecule exceeds the limits for the specified format,
      for example: >99999 atoms for :oe:const:`OEChem::OEFormat::PDB`.

   .. oe:constant:: NoConformer

      This constant indicates that writing a multi-conformer molecule has
      failed due to a missing conformation.

   .. oe:constant:: InvalidSDData

      This constant indicates that invalid SD data is present on the structure which would
      result in a noncompliant output :oe:const:`OEChem::OEFormat::SDF` format.
      An attempt was made to alter the output data to ensure compliance with strict readers.

   .. oe:constant:: MolInvalidForFileFormatSpec 

      This constant indicates that a molecule cannot be written to the requested format, 
      because it would violate the format spec. As an example, not all molecules read from MMCIF can be
      written to the PDB file format. Examples issues are, multi-character chain IDs and residue names 
      exceeding the 3-character limit in PDB format.


.. oe:namespace:: OEChem

.. oe:constnamespace:: OEZap7Version

   .. seealso:: 

      * :oe:meth:`OEChem::OEAssignZap7Radii` function

   This namespace contains the following constants:

   .. oe:constant:: Undefined
   
   .. oe:constant:: CarbonylOxygen
   
      Zap7 radii version in which carbonyl oxygens radii parameter is increased with respect to 
      the Bondi radius, while all other oxygens have radii set at Bondi values. 

   .. oe:constant:: DoublyBondedOxygen
   
      Modified version of Zap7 radii in which in addition to carbonyl oxygens, all other doubly
      bonded oxygens have increased radii parameter with respect to the Bondi radii (see Table 2 
      in [Nicholls-2010]_).

   .. oe:constant:: Default
   
      Same as the :oe:const:`OEChem::OEZap7Version::CarbonylOxygen` constant.
   
   



.. oe:namespace:: OEChem

.. oe:constnamespace:: OEZap9Version

   .. seealso:: 

      * :oe:meth:`OEChem::OEAssignZap9Radii` function

   This namespace contains the following constants:

   .. oe:constant:: Undefined
   
   .. oe:constant:: JMC2008
   
      Initial Zap9 radii version described in [Nicholls-2008]_.

   .. oe:constant:: JCAMD2010
   
      Modified version of Zap9 radii from [Nicholls-2010]_.

   .. oe:constant:: Default
   
      Same as the :oe:const:`OEChem::OEZap9Version::JCAMD2010` constant.
   
   



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OE3DToAtomStereo

.. _OEChem_OE3DToAtomStereo:

.. oe:function:: OE3DToAtomStereo

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OE3DToAtomStereo(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OE3DToAtomStereo(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Set the stereochemistry at the chiral atoms of a molecule, as
   specified by the molecule's 3D coordinates.  The affected atoms are
   those with a 'chiral' atom property of ``true``, as perceived by a call
   to :oe:func:`OEChem::OEPerceiveChiral`, or set manually by the user
   calling the :oe:meth:`OEChem::OEAtomBase::SetChiral` method.  If no
   chirality has been perceived on the molecule,
   :oe:func:`OEChem::OEPerceiveChiral` will be called inside this
   function.

   This function will return ``false`` immediately, if the dimension of
   the molecule is not found to be 3.

   The :oe:func:`OEChem::OE3DToAtomStereo` function throws a warning
   and returns ``false`` at the end, if the geometry of any of the chiral atoms
   of the given molecule is not tetrahedral *i.e.* if the atom stereo
   can not be determined from the coordinates.

   After stereochemistry is set
   :oe:meth:`SetPerceived<OEChem::OEMolBase::SetPerceived>` is called with
   the :oe:const:`OEChem::OEPerceived::AtomStereo` flag set to
   ``true``. Subsequent calls to :oe:func:`OEChem::OE3DToAtomStereo` will
   return ``true`` immediately as the value of
   :oe:meth:`HasPerceived<OEChem::OEMolBase::HasPerceived>` is checked on
   entry. Stereochemistry can be forced to be reperceived by setting the
   :oe:const:`OEChem::OEPerceived::AtomStereo` flag to ``false``.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OE3DToBondStereo

.. oe:function:: OE3DToBondStereo

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OE3DToBondStereo(OEMolBase& mol, unsigned char* bmask = 0)

   .. oe:language:: python

      .. oe:api:: python

         OE3DToBondStereo(mol: Union[OEGraphMol,OEMol,OEQMol],
                          bmask: str = None) -> bool

   Set the stereochemistry at the chiral bonds of a molecule, as
   specified by the molecule's 3D (or possibly 2D) coordinates.  The
   affected bonds are those with a 'chiral' bond property of ``true``, as
   discovered by a call to :oe:func:`OEChem::OEPerceiveChiral`, or set
   manually by the user calling
   :oe:meth:`OEChem::OEBondBase::SetChiral` method.  If no chirality
   has been perceived or set on the molecule,
   :oe:func:`OEChem::OEPerceiveChiral` will be called inside this
   function.

   After stereochemistry is set
   :oe:meth:`SetPerceived<OEChem::OEMolBase::SetPerceived>` is called with
   the :oe:const:`OEChem::OEPerceived::BondStereo` flag set to
   ``true``. Subsequent calls to :oe:func:`OEChem::OE3DToBondStereo` will
   return ``true`` immediately as the value of
   :oe:meth:`HasPerceived<OEChem::OEMolBase::HasPerceived>` is checked on
   entry. Stereochemistry can be forced to be reperceived by setting the
   :oe:const:`OEChem::OEPerceived::BondStereo` flag to ``false``.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OE3DToInternalStereo

.. oe:function:: OE3DToInternalStereo

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OE3DToInternalStereo(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OE3DToInternalStereo(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Assigns the stereochemistry of molecule from its 3D coordinates.
   It perceives both the tetrahedral chirality around atomic centers,
   and the E/Z chirality around double bonds.  This function is
   equivalent to the sequence of calling
   :oe:func:`OEChem::OE3DToAtomStereo` and
   :oe:func:`OEChem::OE3DToBondStereo`. However
   :oe:func:`OEChem::OE3DToBondStereo` will not be called if
   :oe:func:`OEChem::OE3DToAtomStereo` returns ``false``.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAcyclicPath

.. oe:function:: OEAcyclicPath

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEAtomBase>* OEAcyclicPath(const OEAtomBase* bgn,
                                                         const OEAtomBase* end)

   .. oe:language:: python

      .. oe:api:: python

         OEAcyclicPath(arg1: OEAtomBase, arg2: OEAtomBase) -> OEAtomIter

   Returns an iterator over the atoms in order connecting ``bgn`` to
   ``end`` through the molecular graph without traversing rings. Both
   ``bgn`` and ``end`` will be returned in the iterator. Therefore,
   ``bgn`` will always be the first atom in the iterator and ``end``
   will always be the last atom in the iterator if an acyclic path
   through the molecule exists. If no path exists, only ``bgn`` will
   be returned in the iterator.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAddCustomFASTAResidue

.. oe:function:: OEAddCustomFASTAResidue

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddCustomFASTAResidue(const char* code, const char* smiles)

   .. oe:language:: python

      .. oe:api:: python

         OEAddCustomFASTAResidue(code: str, smiles: str) -> bool

   Add a custom residue to the **OEChem TK** FASTA parser. The ``code`` is
   the string surrounded in square brackets. The ``smiles`` is the
   structure of the un-natural nucleic acid to add to the internal
   dictionary. Note, the hydroxyl from the background will be
   automatically stripped and removed by this function.

   In order for these residues to be used, the
   :oe:const:`OEChem::OEIFlavor::FASTA::CustomResidues` flavor must be
   specified. The following code snippet demonstrates how to register
   a custom D-isoleucine with the FASTA reader named with ``[dI]``. It
   also demonstrates using the
   :oe:const:`OEChem::OEIFlavor::FASTA::EmbeddedSMILES` flavor to
   define a tether that can cyclize the peptide.

   .. oe:source:: CustomFASTA.cpp
      :language: c++
      :frag:     SNIPPET

   .. oe:source:: CustomFASTA.py
      :language: python
      :frag:     SNIPPET

   .. oe:source:: CustomFASTA.java
      :language: java
      :frag:     SNIPPET

   .. warning::

      This is an experimental API that may change in the future.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAddExplicitHydrogens

.. oe:function:: OEAddExplicitHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddExplicitHydrogens(OEMolBase& mol, bool polarOnly = false,
                                     bool set3D = true)
         bool OEAddExplicitHydrogens(OEMCMolBase& mol, bool polarOnly = false,
                                     bool set3D = true)

   .. oe:language:: python

      .. oe:api:: python

         OEAddExplicitHydrogens(mol: OEMol, polarOnly: bool = False,
                                set3D: bool = True) -> bool
         OEAddExplicitHydrogens(mol: Union[OEGraphMol,OEQMol],
                                polarOnly: bool = False, set3D: bool = True) -> bool

   Converts the implicit hydrogens on the atoms of a molecule to
   explicit hydrogen atoms.  Zero or more new atoms are created with
   atomic number :oe:const:`OEChem::OEElemNo::H`, and new bonds are
   created to connect these to the parent atom with a single bond.
   This function also resets the implicit hydrogen count to zero.  

   polarOnly
     If ``true``, this function only add explicit hydrogens to polar atoms,
     *i.e.* when :oe:meth:`OEChem::OEAtomBase::IsPolar` returns
     ``true``.

   set3D
     If ``true``, the default, and the molecule
     is 3D, then the :oe:func:`OEChem::OESet3DHydrogenGeom` function is 
     automatically called on any hydrogen atom in the molecule that has the
     same coordinates as its parent heavy atom.

     If ``false``, then the sprouted hydrogens are initially given the same
     coordinates as their parent heavy atom.

   .. hint::

      In case of a 2D molecule, the coordinates of the explicit hydrogens
      can be assigned by calling the
      :oe:func:`OEChem::OESet2DHydrogenGeom` function.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddExplicitHydrogens(OEMolBase& mol, OEAtomBase* hvyatom)

   .. oe:language:: python

      .. oe:api:: python

         OEAddExplicitHydrogens(mol: Union[OEGraphMol,OEMol,OEQMol],
                                atm: OEAtomBase) -> bool

   This function creates a new :ref:`OEAtomBase <OEChem_OEAtomBase>` for every
   implicit hydrogen on 'hvyatom', as given by
   :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount`.  The new hydrogen
   atoms are given the same coordinates as their parent, 'hvyatom'.
   This function currently always returns ``true``.  To set the 2D or 3D
   geometry of these atoms, call the :oe:func:`OEChem::OESet2DHydrogenGeom`
   or :oe:func:`OEChem::OESet3DHydrogenGeom` functions, respectively.

   .. seealso::

      * :oe:func:`OEChem::OESuppressHydrogens` function
      * :oe:func:`OEChem::OESet2DHydrogenGeom` function
      * :oe:func:`OEChem::OESet3DHydrogenGeom` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAddMMCIFData

.. oe:function:: OEAddMMCIFData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddMMCIFData(OEMolBase& mol, const std::string& value)

   .. oe:language:: python

      .. oe:api:: python

         OEAddMMCIFData(mol: Union[OEGraphMol,OEMol,OEQMol], value: str) -> bool

   Adds mmCIF data to a molecule. The input is not validated,
   but is added to the mmCIF metadata block.

   .. seealso::

      * :oe:func:`OEChem::OESetMMCIFData` function to set (replace) MMCIF data
      * :ref:`section_moldata_MMCIF` section

   .. note::

      Unicode characters are not supported neither in the data tag nor in the data value.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAddMolStyles

.. oe:function:: OEAddMolStyles

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddMolStyles(OEChem::OEMolBase& lhs,
                             const OEChem::OEMolBase& rhs,
                             OEChem::OEAtomBase** aa, OEChem::OEBondBase **)

   .. oe:language:: python

      .. oe:api:: python

         OEAddMolStyles(lhs: Union[OEGraphMol,OEMol,OEQMol],
                        rhs: Union[OEGraphMol,OEMol,OEQMol], aa: OEAtomBase,
                        arg4: OEBondBase) -> None

   Merges styles from two molecules, usually utilized when concatenating molecules. 
   :ref:`OEMolBase <OEChem_OEMolBase>` &rhs must have a style because :ref:`OEMolBase <OEChem_OEMolBase>` &lhs will 
   inherit the style from :ref:`OEMolBase <OEChem_OEMolBase>` &rhs.

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAddMols

.. oe:function:: OEAddMols

   .. oe:language:: python

      .. oe:api::

         OEAddMols(dst: OEMolBase, src: OEMolBase) -> amap: List[OEAtomBase], bmap: List[OEBondBase]
         OEAddMols(dst: OEMolBase, src: OEMolBase, delim: str) -> amap: List[OEAtomBase], bmap: List[OEBondBase]

      Adds the one molecule to another molecule.

      dst
        The destination molecule.

      src
        The molecule that will be added to the destination molecule.

      delim
        The delimiter used to concatenate the title of the two molecules.
        The empty string (*e.g.* ``""``) is a valid argument, and
        causes a direct concatenation of the two titles.
        If ``None`` is passed as the argument, no concatenation of
        titles occurs.
        If not specified ``_`` character will be used as to concatenate
        the titles together.

      amap
         Stores mappings between the atoms in the original ``src`` molecule and the
         newly created atoms in the ``dst`` molecule.
         The newly created atom that is corresponding to a source atom can be obtained
         by atom index lookup into the list.

         .. oe:source:: OEAddMols.py
            :language: python
            :noindent:
            :frag:     SNIPPET-OEADDMOL-ATOMMAP

      bmap
         Stores mappings between the bonds in the original ``src`` molecule and the
         newly created bonds in the ``dst`` molecule.
         The newly created bond that is corresponding to a source bond can be obtained
         by bond index lookup into the list.

         .. oe:source:: OEAddMols.py
            :language: python
            :noindent:
            :frag:     SNIPPET-OEADDMOL-BONDMAP

      **Example:**

      .. oe:source:: OEAddMols.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEADDMOLS

      The above code snippet will generate the following output:

      .. code-block:: console

         ('c1ccccc1.c1ccncc1', 'benzene+pyridine')
          6 C  7 C  8 N  9 C 10 C 11 C
          6 (6C-11C)  7 (6C-7C)  8 (7C-8N)  9 (8N-9C) 10 (9C-10C) 11 (10C-11C)

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddMols(OEMolBase& dst, const OEMolBase& src,
                        OEAtomBase** amap = (OEAtomBase **) 0,
                        OEBondBase** bmap = (OEBondBase **) 0)
         bool OEAddMols(OEMolBase& dst, const OEMolBase& src,
                        const char* delim,
                        OEAtomBase** amap = (OEAtomBase **) 0,
                        OEBondBase** bmap = (OEBondBase **) 0)

      Adds the one molecule to another molecule.

      dst
        The destination molecule.

      src
        The molecule that will be added to the destination molecule.

      delim
        The delimiter used to concatenate the title of the two molecules.
        The empty string (*e.g.* ``""``) is a valid argument, and
        causes a direct concatenation of the two titles.
        If ``(char *)0`` is passed as the argument, no concatenation of
        titles occurs.
        If not specified ``_`` character will be used as to concatenate
        the titles together.

      amap
         This parameter can be used to obtain mappings between the atoms
         in the original ``src`` molecule and the newly created atoms
         in the ``dst`` molecule.
         It is assumed that argument passed to ``amap`` is array of atom pointers
         of at least :oe:meth:`src.GetMaxAtomIdx()<OEChem::OEMolBase::GetMaxAtomIdx>` in
         size.

         The newly created atom corresponding to a source atom can be obtained
         by atom index lookup into the ``amap`` array.

      bmap
         This parameter can be used to obtain mappings between the bonds
         in the original ``src`` molecule and the newly created bonds
         in the ``dst`` molecule.
         It is assumed that argument passed to ``bmap`` is array of bond pointers
         of at least :oe:meth:`src.GetMaxBondIdx()<OEChem::OEMolBase::GetMaxAtomIdx>` in size.

         The newly created atom corresponding to a source atom can be obtained
         by atom index lookup into the ``bmap`` array.

   .. note::

      :oe:func:`OEChem::OEAddMols` will not generate bonds between the
      molecules added.

   .. seealso::

      .. oe:language:: c++

          * Example program :ref:`catmols.cpp<section_example_oechem_catmols>`

      .. oe:language:: python

          * Example program :ref:`catmols.py<section_example_oechem_catmols>`

      .. oe:language:: java

          * Example program :ref:`CatMols.java<section_example_oechem_catmols>`

      .. oe:language:: csharp

          * Example program :ref:`CatMols.cs<section_example_oechem_catmols>`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAddPDBData

.. oe:function:: OEAddPDBData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddPDBData(OEMolBase& mol, const OESDDataPair& dp)
         bool OEAddPDBData(OEMolBase& mol, const std::string& tag,
                           const std::string& value)

   .. oe:language:: python

      .. oe:api:: python

         OEAddPDBData(mol: Union[OEGraphMol,OEMol,OEQMol], dp: OESDDataPair) -> bool
         OEAddPDBData(mol: Union[OEGraphMol,OEMol,OEQMol], tag: str, value: str) -> bool

   Adds a PDB tag and value data pair to a molecule. Both the tag and
   the value must be a string.
   If an item with the same tag already exists, another item is added
   to the molecule.

   .. seealso::

      * :oe:func:`OEChem::OESetPDBData` function to set (replace) PDB data
      * :ref:`section_moltaggeddata_PDB` section

   .. note::

      Unicode characters are not supported neither in the data tag nor in the data value.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAddSDData

.. oe:function:: OEAddSDData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddSDData(OEMolBase& mol, const OESDDataPair& dp)
         bool OEAddSDData(OEMolBase& mol, const std::string& tag,
                          const std::string& value)

   .. oe:language:: python

      .. oe:api:: python

         OEAddSDData(mol: Union[OEGraphMol,OEMol,OEQMol], dp: OESDDataPair) -> bool
         OEAddSDData(mol: Union[OEGraphMol,OEMol,OEQMol], tag: str, value: str) -> bool

   Adds an SD tag and value data pair to a molecule. Both the tag and
   the value must be a string.
   If an item with the same tag already exists, another item is added
   to the molecule.

   .. seealso::

      * :oe:func:`OEChem::OESetSDData` function to set (replace) SD data
      * :ref:`section_moltaggeddata_SD` section

   .. note::

      Unicode characters are not supported neither in the data tag nor in the data value.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


    
.. oe:namespace:: OEChem

.. oe:function:: OEAminoAcidTypeToString

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEAminoAcidTypeToString(unsigned)

   .. oe:language:: python

      .. oe:api:: python

         OEAminoAcidTypeToString(arg1: int) -> str

   Converts the values of the :oe:constns:`OEChem::OEAminoAcidType` namespace into string
   representation.

   .. seealso::

      * :oe:constns:`OEChem::OEAminoAcidType` namespace


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEApplyStateFromRef

.. oe:function:: OEApplyStateFromRef

   .. attention::

      |PRELIMINARY-API|

   This function can be used to change the tautomer state or a fix a broken valence state in a 3D
   molecule, based on a reference state (not required to be 3D). The function matches the substructures
   and transfers the state of the reference, like bond-orders, formal charge assignments, and hydrogen assignments
   to the input molecule.
   The input molecule can be smaller than the reference
   molecule, as this is intended to work for small molecule crystal structures where part of the molecule can have
   been degraded in the experiment. It also works for molecules that have been covalently bound to a protein,
   such that there is an R-group in place of the broken covalent bond.
   Due to symmetries in the substructure graph match, that are not unique in 3D, the function returns an iterator of output
   molecules where the state of the reference has been applied. An simple example would be a 3D molecule with two carboxylic
   acid groups on either side of a beneze ring. If the state being applied has one neutral carboxylic acid, and one negatively
   charged, two output molecules would have to be generated. While they are symmetric, if the 3D molecule is bound
   in a protein pocket, the two groups are not identical and one very likely fits the local environment better than
   the other, which will need to be checked.

   .. note::

      The state of hydrogens being implicit or explicit in the output will match that of the
      state of the reference molecle. 
      
   .. note::
      
      The function currently ignores chirality of the two molecules, since this cannot be changed
      in a 3D molecule without conformational changes. However, the function will attempt to transfer chiral information on atoms 
      and bonds from the reference state by setting  the :oe:meth:`OEChem::OEAtomBase::SetChiral` flag to match 
      the :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` flag from the reference state. The user is expected to call
      :ref:`OE3DToAtomStereo <OEChem_OE3DToAtomStereo>` to convert the chiral flag to atoms with specified stereo on 3D molecules.

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEMolBase>* OEApplyStateFromRef(const OEMolBase& input,
                                                              const OEMolBase& refMol)
         OESystem::OEIterBase<OEMolBase>* OEApplyStateFromRef(const OEMolBase& input,
                                                              const std::string& refSmiles)

   .. oe:language:: python

      .. oe:api:: python

         OEApplyStateFromRef(inputState: Union[OEGraphMol,OEMol,OEQMol],
                             refState: Union[OEGraphMol,OEMol,OEQMol]) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

  The SMILES version uses :oe:func:`OEChem::OEMolToSmiles` to convert the incoming smiles to a molecule usable for
  the substructure search.

   .. seealso::

      * :oe:func:`OEChem::OEMolToSmiles` function
      * :ref:`OESubSearch <OEChem_OESubSearch>` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEApplyStyleChange

.. oe:function:: OEApplyStyleChange

   .. oe:language:: c++ java csharp

      .. oe:api::

         OE3DMolStyle OEApplyStyleChange(const OE3DMolStyle& initialStyle,
                                         const OE3DMolStyle& deltaStyle)

   .. oe:language:: python

      .. oe:api:: python

         OEApplyStyleChange(initialStyle: OE3DMolStyle,
                            deltaStyle: OE3DMolStyle) -> OE3DMolStyle

   Returns a new :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`, which includes all of the specified options 
   in the initial style that do not overlap with the delta style and any new additions from the delta 
   style. 

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignAromaticFlags

.. oe:function:: OEAssignAromaticFlags

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAssignAromaticFlags(OEMolBase& mol,
                                    unsigned int aromodel = OEAroModelOpenEye,
                                    bool clearflags = true,
                                    unsigned int maxpath = 0,
                                    bool prune = false)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignAromaticFlags(mol: Union[OEGraphMol,OEMol,OEQMol],
                               aromodel: int = OEAroModelOpenEye,
                               clearflags: bool = True, maxpath: int = 0,
                               prune: bool = False) -> None

   Perceives the aromatic atoms and bonds of a molecule.
   The assigned atom and bond aromaticity can be accessed by
   :oe:meth:`OEChem::OEAtomBase::IsAromatic` and
   :oe:meth:`OEChem::OEBondBase::IsAromatic` methods, respectively.

   *model*
     The parameter that  specifies that aromaticity model that are perceived by the
     :oe:func:`OEChem::OEAssignAromaticFlags` function.
     The default aromaticity 'model' is :oe:const:`OEChem::OEAroModel::OpenEye`.
     Other predefined aromaticity models provided by **OEChem TK**
     include :oe:const:`OEChem::OEAroModel::Daylight`,
     :oe:const:`OEChem::OEAroModel::Tripos`,
     :oe:const:`OEChem::OEAroModel::MMFF` and
     :oe:const:`OEChem::OEAroModel::MDL` that represent the Daylight,
     Tripos, MMFF and MDL definitions, respectively.

   *clearflags*
     The parameter that specifies whether to clear the
     aromaticity flags by calling :oe:func:`OEChem::OEClearAromaticFlags` prior
     to re-perceiving the aromaticity.
     Newly created molecules that have not had their aromaticity assigned
     yet can specify ``false``, for a very small performance advantage.

   *maxpath*
      The parameter that specifies the maximum path
      length to consider an aromatic cycle, or zero (the default) to specify
      no upper bound on aromatic cycle length.  Some formal models of
      aromaticity use the value six, limiting aromaticity to six membered
      rings like benzene or pyridine.

   *prune*
      The parameter that specifies whether or not to run a
      post-processing step to consider rings with exo-double bonds as not
      aromatic. This is also required by some formal models of aromaticity.

.. seealso::

  .. oe:language:: c++

      * :oe:constns:`OEChem::OEAroModel` constant namespace
      * :oe:func:`OEChem::OEClearAromaticFlags` to remove atom and bond aromaticity properties
      * :ref:`chapter_aromaticity` chapter
      * Example program :ref:`cansmi.cpp<section_example_oechem_cansmi>`

  .. oe:language:: python

      * :oe:constns:`OEChem::OEAroModel` constant namespace
      * :oe:func:`OEChem::OEClearAromaticFlags` to remove atom and bond aromaticity properties
      * :ref:`chapter_aromaticity` chapter
      * Example program :ref:`cansmi.py<section_example_oechem_cansmi>`

  .. oe:language:: java

      * :oe:constns:`OEChem::OEAroModel` constant namespace
      * :oe:func:`OEChem::OEClearAromaticFlags` to remove atom and bond aromaticity properties
      * :ref:`chapter_aromaticity` chapter
      * Example program :ref:`CanSmi.java<section_example_oechem_cansmi>`

  .. oe:language:: csharp

      * :oe:constns:`OEChem::OEAroModel` constant namespace
      * :oe:func:`OEChem::OEClearAromaticFlags` to remove atom and bond aromaticity properties
      * :ref:`chapter_aromaticity` chapter
      * Example program :ref:`CanSmi.cs<section_example_oechem_cansmi>`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignBondiVdWRadii

.. oe:function:: OEAssignBondiVdWRadii

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAssignBondiVdWRadii(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignBondiVdWRadii(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Assigns radii to all atoms in the given :ref:`OEMolBase <OEChem_OEMolBase>` using calls
   to :oe:func:`OEChem::OEGetBondiVdWRadius`.
   The assigned radii of an :ref:`OEAtomBase <OEChem_OEAtomBase>` can be accessed by
   :oe:meth:`OEChem::OEAtomBase::GetRadius` method.

   .. seealso::

      * :ref:`section_periodictable_atomradius` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignCovalentRadii

.. oe:function:: OEAssignCovalentRadii

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAssignCovalentRadii(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignCovalentRadii(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Assigns radii to all atoms in the given :ref:`OEMolBase <OEChem_OEMolBase>`
   using calls to :oe:func:`OEChem::OEGetCovalentRadius`.  The assigned
   radii of an :ref:`OEAtomBase <OEChem_OEAtomBase>` can be accessed by
   :oe:meth:`OEChem::OEAtomBase::GetRadius` method.

   .. seealso::

      * :ref:`section_periodictable_atomradius` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignDelphiRadii

.. oe:function:: OEAssignDelphiRadii

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAssignDelphiRadii(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignDelphiRadii(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Assigns radii to all atoms in the given :ref:`OEMolBase <OEChem_OEMolBase>`
   using calls to :oe:func:`OEChem::OEGetDelphiRadius`.  The assigned
   radii of an :ref:`OEAtomBase <OEChem_OEAtomBase>` can be accessed by
   :oe:meth:`OEChem::OEAtomBase::GetRadius` method.

   .. seealso::

      * :ref:`section_periodictable_atomradius` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignFormalCharges

..  _OEChem_OEAssignFormalCharges:

.. oe:function:: OEAssignFormalCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAssignFormalCharges(OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignFormalCharges(atm: OEAtomBase) -> None

   Sets the formal charge property of an atom, based upon a **OpenEye
   valence model**.  This function assumes that the bond orders and
   implicit hydrogen counts have been set on a molecule.  For example,
   this function will place a single positive charge on a neutral
   four-valent nitrogen.  Note that this function only modifies neutral
   atoms, with zero formal charge.  This preserves any formal charges
   previously assigned, but requires the charge to be reset to zero in
   order to force a reassignment.

   The assigned formal charge can be accessed by the
   :oe:meth:`OEChem::OEAtomBase::GetFormalCharge` method

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAssignFormalCharges(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignFormalCharges(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Sets the formal charge property of each atom in the molecule by
   by calling :oe:func:`OEAssignFormalCharges(OEAtomBase *)<OEChem::OEAssignFormalCharges>`
   function.

   The assigned formal charge can be accessed by the
   :oe:meth:`OEChem::OEAtomBase::GetFormalCharge` method.

   .. seealso::

      * :ref:`section_valence_openeye` section
      * :oe:func:`OEChem::OEAssignImplicitHydrogens` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignHonigIonicCavityRadii

.. oe:function:: OEAssignHonigIonicCavityRadii

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAssignHonigIonicCavityRadii(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignHonigIonicCavityRadii(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Assigns radii to all atoms in the given :ref:`OEMolBase <OEChem_OEMolBase>`
   using calls to :oe:func:`OEChem::OEGetHonigIonicCavityRadius`.  The
   assigned radii of an :ref:`OEAtomBase <OEChem_OEAtomBase>` can be accessed by
   :oe:meth:`OEChem::OEAtomBase::GetRadius` method.

   .. seealso::

      * :ref:`section_periodictable_atomradius` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignHybridization

..  _OEChem_OEAssignHybridization:

.. oe:function:: OEAssignHybridization

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAssignHybridization(OEMolBase &)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignHybridization(arg1: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Assigns hybridization to all atoms in the given
   :ref:`OEMolBase <OEChem_OEMolBase>` using calls to
   :oe:func:`OEChem::OEGetHybridization` function that predicts the
   electronic hybridization/geometry of each atom from simple
   connectivity

   This function updates the hybridization property of each atom in the
   molecule (see namespace :oe:constns:`OEChem::OEHybridization`).
   The assigned hybridization value can be accessed by the
   :oe:meth:`GetHyb<OEChem::OEAtomBase::GetHyb>` method of
   :ref:`OEAtomBase <OEChem_OEAtomBase>`.

   .. warning::

      The predicted atom hybridization depends on the perceived aromaticity.

      #. If the aromaticity is not perceived prior to calling the
         :oe:func:`OEChem::OEAssignHybridization` function,
         then :oe:func:`OEChem::OEAssignAromaticFlags` is automatically called
         to perceive the OpenEye aromaticity  model.
         For more details about aromaticity models, see :ref:`chapter_aromaticity`)

      #. Otherwise, the already perceived aromaticity information is used.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignImplicitHydrogens

.. oe:function:: OEAssignImplicitHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAssignImplicitHydrogens(OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignImplicitHydrogens(atm: OEAtomBase) -> bool

   Sets the implicit hydrogen count property of an atom
   based upon a **OpenEye valence model**.  This function assumes that the
   formal charges may be incorrect or haven't been assigned yet.  This
   function should be followed with a call to the function
   :oe:func:`OEChem::OEAssignFormalCharges`.  This function calls the
   :oe:meth:`OEChem::OEAtomBase::SetImplicitHCount` method on the atom
   with the value returned by :oe:func:`OEChem::OEDefaultImplicitHCount`.

   This function returns ``true`` if the implicit hydrogen count of the atom
   is changed.

   The assigned implicit hydrogen count can be accessed by
   :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount` method.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAssignImplicitHydrogens(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignImplicitHydrogens(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Sets the implicit hydrogen count property of each atom in the molecule
   by calling :oe:func:`OEAssignImplicitHydrogens(OEAtomBase *)<OEChem::OEAssignImplicitHydrogens>`.

   This function returns ``true`` if the implicit hydrogen count of any atom in the
   molecule is changed. It returns ``false`` if none of the atoms in the molecule has the
   implicit hydrogen count changed.

   The assigned implicit hydrogen count can be accessed by
   :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount` method.

   .. note::

      If the charge state is correctly set on each atom, you should call the
      :oe:func:`OEChem::OEAssignMDLHydrogens` function instead.

   .. seealso::

      * :ref:`section_valence_openeye` section
      * :oe:func:`OEChem::OEDefaultImplicitHCount` function
      * :oe:func:`OEChem::OEAssignFormalCharges` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignMDLHydrogens

.. oe:function:: OEAssignMDLHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAssignMDLHydrogens(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignMDLHydrogens(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Sets the implicit hydrogen count property of each atom in the molecule
   based upon the **MDL valence model** by
   calling :oe:func:`OEAssignMDLHydrogens(OEAtomBase*)<OEChem::OEAssignMDLHydrogens>`
   with the value returned by :oe:func:`OEChem::OEDefaultImplicitHCount`.
   This function returns ``true`` if the implicit hydrogen count of any atom in the
   molecule is changed. It returns ``false`` if none of the atoms in the molecule has the
   implicit hydrogen count changed.
   The assigned implicit hydrogen count can be accessed by
   :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount` method.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAssignMDLHydrogens(OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignMDLHydrogens(atm: OEAtomBase) -> bool

   Sets the implicit hydrogen count property of an atom based upon the
   **MDL valence model**. This function assumes that the formal charges
   are correctly set. This function calls the
   :oe:meth:`OEChem::OEAtomBase::SetImplicitHCount` method on each atom with the value
   returned by :oe:func:`OEChem::OEDefaultMDLHCount`. This function returns ``false``
   if the implicit hydrogen count of the atom is not changed.
   If the charge state of each atom has not been assigned, you should call the
   :oe:func:`OEChem::OEAssignImplicitHydrogens` and
   :oe:func:`OEChem::OEAssignFormalCharges` functions instead.

   .. seealso::

      * :ref:`section_valence_mdl` section
      * :oe:func:`OEChem::OEDefaultMDLHCount` function
      * :oe:func:`OEChem::OEMDLGetValence` function
      * :oe:cls:`OEChem::OEIsValidMDLAtomValence` predicate 


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignPaulingVdWRadii

.. oe:function:: OEAssignPaulingVdWRadii

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAssignPaulingVdWRadii(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignPaulingVdWRadii(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Assigns radii to all atoms in the given :ref:`OEMolBase <OEChem_OEMolBase>`
   using calls  to :oe:func:`OEChem::OEGetPaulingVdWRadius`.
   The assigned radii of an :ref:`OEAtomBase <OEChem_OEAtomBase>` can be
   accessed by :oe:meth:`OEChem::OEAtomBase::GetRadius` method.

   .. seealso::

      * :ref:`section_periodictable_atomradius` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignRadii

.. oe:function:: OEAssignRadii

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAssignRadii(OEChem::OEMolBase& mol,
                            unsigned molRadiiType = OERadiiType::Default,
                            unsigned ionRadiiType = OERadiiType::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignRadii(mol: Union[OEGraphMol,OEMol,OEQMol], molRadiiType: int,
                       ionRadiiType: int) -> bool

   Assigns radii to all atoms in the given :ref:`OEMolBase <OEChem_OEMolBase>`
   using calls to specific radii functions based on the values of
   ``molRadiiType`` and ``ionRadiiType``, drawn from
   the :oe:constns:`OEChem::OERadiiType` namespace.
   Ions in a molecular complex can be assigned radii distinct from
   other species by specifying a value for ``ionRadiiType`` (for example
   :oe:constns:`OEChem::OERadiiType::HonigIonicCavity_Robust`).

   The assigned radii of an :ref:`OEAtomBase <OEChem_OEAtomBase>` can be
   accessed by :oe:meth:`OEChem::OEAtomBase::GetRadius` method.

   .. seealso::

      * :ref:`section_periodictable_atomradius` section
      * :oe:func:`OEChem::OEGetRadiiTypeName`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignResidueNumbers

.. oe:function:: OEAssignResidueNumbers

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAssignResidueNumbers(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignResidueNumbers(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Assigns sequential residue numbers to the residues of a
   molecule, as currently ordered in the :ref:`OEMolBase <OEChem_OEMolBase>`.
   The residue number is stored in :ref:`OEResidue <OEChem_OEResidue>` that is
   associated with each :ref:`OEAtomBase <OEChem_OEAtomBase>` via the
   :oe:const:`OEChem::OEProperty::Residue` property.

   .. seealso::

      * :oe:func:`OEChem::OEAtomGetResidue`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignSerialNumbers

.. oe:function:: OEAssignSerialNumbers

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAssignSerialNumbers(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignSerialNumbers(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   The function assigns sequential atom serial numbers to the atoms of a
   molecule, as currently ordered in the :ref:`OEMolBase <OEChem_OEMolBase>`.
   The atom serial number is stored in :ref:`OEResidue <OEChem_OEResidue>` that is
   associated with each :ref:`OEAtomBase <OEChem_OEAtomBase>` via the
   :oe:const:`OEChem::OEProperty::Residue` property.

   .. seealso::

      * :oe:func:`OEChem::OEAtomGetResidue`



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignZap7Radii

.. oe:function:: OEAssignZap7Radii

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAssignZap7Radii(OEMolBase& mol,
                                unsigned int version = OEZap7Version::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignZap7Radii(mol: Union[OEGraphMol,OEMol,OEQMol], version: int) -> None

   Assigns atomic radii from the ZAP7 set ([Nicholls-2010]_) to all
   atoms of the passed molecule ``mol``. ZAP7 set has been optimized
   to be used together with high quality atomic partial charges
   obtained with DFT calculations using large basis set, for example
   aug-cc-pVTZ, and a surface-area coefficient of 5.7 cal per square
   |A|.  The assigned radii of an :ref:`OEAtomBase <OEChem_OEAtomBase>` can be
   accessed by the :oe:meth:`OEChem::OEAtomBase::GetRadius` method.

   .. seealso::

      * :oe:constns:`OEChem::OEZap7Version`
      * :ref:`section_periodictable_atomradius` section



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAssignZap9Radii

.. oe:function:: OEAssignZap9Radii

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAssignZap9Radii(OEMolBase& mol,
                                unsigned int version = OEZap9Version::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignZap9Radii(mol: Union[OEGraphMol,OEMol,OEQMol], version: int) -> None

   Assigns radii to all atoms in the given :ref:`OEMolBase <OEChem_OEMolBase>`
   using atomic radii defined initially in [Nicholls-2008]_.  These
   radii include minor atom-typing for oxygen and nitrogen and are not
   a simple atomic number mapping. In the later paper [Nicholls-2010]_
   the same modification of radii for some types of doubly bonded
   oxygen to P,S, and N has been introduced, and is now made a default
   set of Zap9 radii. These radii are suitable for use in calculating
   transfer energies when used with a surface-area coefficient of
   6.3cal per square |A|.  The assigned radii of an
   :ref:`OEAtomBase <OEChem_OEAtomBase>` can be accessed by the
   :oe:meth:`OEChem::OEAtomBase::GetRadius` method.

   .. seealso::

      * :oe:constns:`OEChem::OEZap9Version`
      * :ref:`section_periodictable_atomradius` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomGetMDLParity

.. oe:function:: OEAtomGetMDLParity

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEAtomGetMDLParity(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEAtomGetMDLParity(atm: OEAtomBase) -> int

   This function is used to retrieve the 'MDL Parity' value associated
   with an atom.  The interpretation of this unsigned integer is
   described in the MDL file format documentation, and will appear in the
   appropriate atom parity column of the atom connection tables in MDL
   file formats.  This value may be set using the
   :oe:func:`OEChem::OEAtomSetMDLParity` function.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomGetResidue

.. oe:function:: OEAtomGetResidue

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OEResidue& OEAtomGetResidue(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEAtomGetResidue(atm: OEAtomBase) -> OEResidue

   This function is used to retrieve the :ref:`OEResidue <OEChem_OEResidue>`
   associated with an :ref:`OEAtomBase <OEChem_OEAtomBase>`.  The
   :ref:`OEResidue <OEChem_OEResidue>` class is used to store information used in
   biopolymer processing, *e.g.* proteins and nucleic acids, on a per-atom
   basis.

   .. seealso::

      * :ref:`OEResidue <OEChem_OEResidue>` class
      * :oe:func:`OEChem::OEHasResidue` function
      * :oe:func:`OEChem::OEAtomSetResidue` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomGetSmallestRingSize

.. oe:function:: OEAtomGetSmallestRingSize

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEAtomGetSmallestRingSize(const OEAtomBase* atm)
         unsigned int OEAtomGetSmallestRingSize(const OEAtomBase& atm)

   .. oe:language:: python

      .. oe:api:: python

         OEAtomGetSmallestRingSize(atm: OEAtomBase) -> int

   Determines the size of the smallest ring that an atom is in.
   If the atom is not in a ring,
   *i.e.* :oe:meth:`OEChem::OEAtomBase::IsInRing` returns ``false``, the
   value zero is returned.

   .. warning::

      It is not necessary to perform the ring perception by calling
      :oe:func:`OEChem::OEFindRingAtomsAndBonds` function
      prior to calling :oe:func:`OEChem::OEAtomGetSmallestRingSize` function.

   .. seealso::

      * :ref:`chapter_ring` chapter



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomIsInAromaticRingSize

.. oe:function:: OEAtomIsInAromaticRingSize

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAtomIsInAromaticRingSize(const OEAtomBase& atm,
                                         unsigned int size)
         bool OEAtomIsInAromaticRingSize(const OEAtomBase* atm,
                                         unsigned int size)

   .. oe:language:: python

      .. oe:api:: python

         OEAtomIsInAromaticRingSize(atm: OEAtomBase, size: int) -> bool

   Determines whether the given atom is in an aromatic cycle of the
   specified size.
   If the atom is not aromatic, *i.e.*
   :oe:meth:`OEChem::OEAtomBase::IsAromatic` returns ``false``, then this
   function also returns ``false``.

   .. warning::

      It is necessary to call :oe:func:`OEChem::OEFindRingAtomsAndBonds` and
      :oe:func:`OEChem::OEAssignAromaticFlags` functions prior to calling
      calling :oe:func:`OEChem::OEAtomIsInAromaticRingSize` function.

   .. seealso::

      * :ref:`chapter_ring` chapter



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomIsInRingSize

.. oe:function:: OEAtomIsInRingSize

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAtomIsInRingSize(const OEAtomBase* atm, unsigned int size)
         bool OEAtomIsInRingSize(const OEAtomBase& atm, unsigned int size)

   .. oe:language:: python

      .. oe:api:: python

         OEAtomIsInRingSize(atm: OEAtomBase, size: int) -> bool

   Determines whether the given atom is in a cycle of the specified size.
   If the atom is not in a
   ring, *i.e.* :oe:meth:`OEChem::OEAtomBase::IsInRing` returns ``false``,
   then this function also returns ``false``.  This function also returns
   ``false`` for all values of size less than three.

   .. warning::

      It is necessary to perform ring perception by calling
      :oe:func:`OEChem::OEFindRingAtomsAndBonds` function prior to calling
      :oe:func:`OEChem::OEAtomIsInRingSize` function.

   .. seealso::

      * :ref:`chapter_ring` chapter



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomSetMDLParity

.. oe:function:: OEAtomSetMDLParity

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAtomSetMDLParity(OEAtomBase* atm, unsigned int)

   .. oe:language:: python

      .. oe:api:: python

         OEAtomSetMDLParity(atm: OEAtomBase, arg2: int) -> bool

   This function may be used to set the 'MDL parity' value associated
   with an atom.  The interpretation of this unsigned integer is
   described in the MDL file format documentation, and will appear in the
   appropriate atom parity column of the atom connection tables in MDL
   file formats.  This value may be retrieved using the
   :oe:func:`OEChem::OEAtomGetMDLParity` function.

   Typically, these values is either read from MDL connection tables or
   set by *OEChem* via the :oe:func:`OEChem::OEMDLPerceiveParity` and
   :oe:func:`OEChem::OEMDLClearParity` functions.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomSetResidue

.. oe:function:: OEAtomSetResidue

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAtomSetResidue(OEAtomBase* atm, const OEResidue& res)

   .. oe:language:: python

      .. oe:api:: python

         OEAtomSetResidue(atm: OEAtomBase, res: OEResidue) -> bool

   This function is used to set the :ref:`OEResidue <OEChem_OEResidue>` associated
   with an :ref:`OEAtomBase <OEChem_OEAtomBase>`.  The :ref:`OEResidue <OEChem_OEResidue>`
   class is used to store information used in biopolymer processing,
   *e.g.* proteins and nucleic acids, on a per-atom basis.

   .. seealso::

      * :ref:`OEResidue <OEChem_OEResidue>` class
      * :oe:func:`OEChem::OEHasResidue` function
      * :oe:func:`OEChem::OEAtomGetResidue` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEBAtomIntTypeOpts

.. oe:function:: OEBAtomIntTypeOpts

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEBAtomIntTypeOpts()

   .. oe:language:: python

      .. oe:api:: python

         OEBAtomIntTypeOpts() -> str

   Specifies that atom and bond int types should be read and written
   from the OEB file format.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEBDefaultOpts

.. oe:function:: OEBDefaultOpts

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEBDefaultOpts()

   .. oe:language:: python

      .. oe:api:: python

         OEBDefaultOpts() -> str

   The default set of options used by :ref:`oemolistream <OEChem_oemolistream>`
   and :ref:`oemolostream <OEChem_oemolostream>`. The default is that
   rotor-offset-compression is not preserved; as well as that atom and
   bond int types are not preserved.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEBGZipCompressOpts

.. oe:function:: OEBGZipCompressOpts

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEBGZipCompressOpts()

   .. oe:language:: python

      .. oe:api:: python

         OEBGZipCompressOpts() -> str

   Specifies that the OEB format should gzip compress individual
   payloads of data.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEBRotCompressOpts

.. oe:function:: OEBRotCompressOpts

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEBRotCompressOpts()

   .. oe:language:: python

      .. oe:api:: python

         OEBRotCompressOpts() -> str

   Specifies that while reading a molecule the data needed to maintain
   a smaller file size should be preserved on the molecule for later
   use during writing.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEBondGetSmallestRingSize

.. oe:function:: OEBondGetSmallestRingSize

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEBondGetSmallestRingSize(const OEBondBase& bnd)
         unsigned int OEBondGetSmallestRingSize(const OEBondBase* bnd)

   .. oe:language:: python

      .. oe:api:: python

         OEBondGetSmallestRingSize(bnd: OEBondBase) -> int

   Determines the size of the smallest ring that a bond is in.
   If the bond is not in a ring, *i.e.* :oe:meth:`OEChem::OEBondBase::IsInRing`
   returns ``false``, the value zero is returned.

   .. warning::

      It is necessary to perform ring perception by calling
      :oe:func:`OEChem::OEFindRingAtomsAndBonds` function prior to calling
      :oe:func:`OEChem::OEBondGetSmallestRingSize` function.

   .. seealso::

      * :ref:`chapter_ring` chapter



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEBondIsInAromaticRingSize

.. oe:function:: OEBondIsInAromaticRingSize

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBondIsInAromaticRingSize(const OEBondBase* bnd,
                                         unsigned int size)
         bool OEBondIsInAromaticRingSize(const OEBondBase& bnd,
                                         unsigned int size)

   .. oe:language:: python

      .. oe:api:: python

         OEBondIsInAromaticRingSize(bnd: OEBondBase, size: int) -> bool

   Determines whether the given bond is in an aromatic cycle of the
   specified size. If the bond is not aromatic, *i.e.*
   :oe:meth:`OEChem::OEBondBase::IsAromatic` returns ``false``, then this
   function also returns ``false``.

   .. warning::

      It is necessary to call :oe:func:`OEChem::OEFindRingAtomsAndBonds` and
      :oe:func:`OEChem::OEAssignAromaticFlags` functions prior to calling
      :oe:func:`OEChem::OEBondIsInAromaticRingSize` function.

   .. seealso::

      * :ref:`chapter_ring` chapter



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEBondIsInRingSize

.. oe:function:: OEBondIsInRingSize

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBondIsInRingSize(const OEBondBase* bnd, unsigned int size)
         bool OEBondIsInRingSize(const OEBondBase& bnd, unsigned int size)

   .. oe:language:: python

      .. oe:api:: python

         OEBondIsInRingSize(bnd: OEBondBase, size: int) -> bool

   Determines whether the given bond is in a cycle of the specified size.
   If the bond is not in a ring, *i.e.* :oe:meth:`OEChem::OEBondBase::IsInRing`
   returns ``false``, then this function also returns ``false``.
   This function also returns ``false`` for all values for size less than three.

   .. warning::

      It is necessary to perform ring perception by calling
      :oe:func:`OEChem::OEFindRingAtomsAndBonds` function prior to calling
      :oe:func:`OEChem::OEBondIsInRingSize` function.

   .. seealso::

      * :ref:`chapter_ring` chapter



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEBuildMDLQueryExpressions

.. oe:function:: OEBuildMDLQueryExpressions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBuildMDLQueryExpressions(OEQMolBase& qmol,
                                         const OEMolBase& mol,
                                         unsigned int opts = OEMDLQueryOpts::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEBuildMDLQueryExpressions(qmol: OEQMol,
                                    mol: Union[OEGraphMol,OEMol,OEQMol],
                                    opts: int) -> bool

   .. seealso::

      * :ref:`chapter_mdlqueries` chapter



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECXSMILESToMol

.. oe:function:: OECXSMILESToMol

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECXSMILESToMol(OEMolBase& mol, const std::string& str)

   .. oe:language:: python

      .. oe:api:: python

         OECXSMILESToMol(mol: Union[OEGraphMol,OEMol,OEQMol], str: str) -> bool

   Converts a :term:`CXSMILES` string into a molecule.
   After constructing the molecule the following properties are perceived:

   * Rings are perceived by calling the
     :oe:func:`OEChem::OEFindRingAtomsAndBonds` function.

   * The aromaticity is assigned by calling the
     :oe:func:`OEChem::OEAssignAromaticFlags` function using the
     :oe:const:`OEChem::OEAroModel::OpenEye` aromaticity model.

   * The chirality is perceived by calling the
     :oe:func:`OEChem::OEPerceiveChiral` function.

   Note that since :term:`CXSMILES` is a superset of the :term:`SMILES` syntax,
   it is safe to use this function for either format. Using :term:`SMILES` readers
   for known :term:`CXSMILES` is discouraged since any appendix information will become
   a static addition to the molecule title and cannot be recovered.

   The molecule object is cleared before parsing so the resulting molecule
   object only contains atoms and bonds from the :term:`CXSMILES`.  If one
   wishes to *add* atoms and bonds to an existing molecule, one can use
   the lower-level :oe:func:`OEChem::OEParseSmiles` function (with an option argument
   that enables :term:`CXSMILES` parsing), which preserves
   any existing atoms and bonds in the molecule.

   .. seealso::

      * :oe:func:`OEChem::OEMolToCXSMILES` function
      * :oe:func:`OEChem::OEMolToSmiles` function
      * :ref:`section_molctordtor_smilesfrommol` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECalcCartesianCoord

.. oe:function:: OECalcCartesianCoord

   .. oe:api::

      void OECalcCartesianCoord(float* a, float* b, float* c, float* z,
                                float* x)

   Given the Cartesian coordinates of the three reference atoms, in the
   arrays 'a', 'b' and 'c', convert the internal coordinate specified by 'z', to
   a Cartesian coordinate in the buffer pointed to by 'x'.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECalcInternalCoord

.. oe:function:: OECalcInternalCoord

   .. oe:api::

      void OECalcInternalCoord(float* a, float* b, float* c, float* x, float* z)

   Given the Cartesian coordinates of the three reference atoms, in the
   arrays 'a', 'b' and 'c', convert the Cartesian coordinate specified by 'x', to
   an internal coordinate in the buffer pointed to by 'z'.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OECalcPMI

.. oe:function:: OECalcPMI

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECalcPMI(double* pmi, OEMolBase& mol)
         bool OECalcPMI(double* pmi, const OEMolBase& mol)
         bool OECalcPMI(double* pmi, const OEConfBase& mol)
         bool OECalcPMI(double* pmi, const OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OECalcPMI(pmi: OEDoubleArray, mol: Union[OEGraphMol,OEQMol]) -> bool
         OECalcPMI(pmi: OEDoubleArray, mol: OEConfBase) -> bool
         OECalcPMI(pmi: OEDoubleArray, mol: OEMol) -> bool

   Calculates the PMI (principal moment of inertia) of the given molecule. Units of the PMI calculated are
   :math:`\text{amu} \times A^2`, where amu stands for Atomic Mass Unit and :math:`A` for Angstrom. If calling the OEMCMolBase overload,
   the PMI calculated corresponds to the active conformer.
   
   Returns true if calculation is successful, false otherwise. The function returns false if the values for the PMI
   are all 0, or if the molecule is not centered before calling the overloads with a const molecule argument.

   If using any of the constant molecule overloads of this function, you must center the molecule before calling the
   overload, otherwise the function will return an incorrect or invalid value.
   See the function :oe:func:`OEChem::OECenter` for how to center a molecule.

   *pmi*
      This pointer is populated by the PMI of the given molecule in each dimension, X, Y, and Z. 
  
   *mol*
      This is the molecule for which the PMI is calculated. It must have a set radius and set mass for the calculation
      to be valid. 

   .. warning::

      These functions only work correctly with a molecule that has been centered using the function
      :oe:func:`OEChem::OECenter`. If the molecule has not been centered, the function will return false.

   .. seealso::

      * :oe:func:`OEChem::OEGetRadiusOfGyration` function to calculate radius of gyration.

   The following code snippet demonstrates how to calculate the PMI and radius of gyration for a molecule.

.. oe:source:: CalcPMI.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-CALC-PMI

.. oe:source:: CalcPMI.py
   :language: python
   :noindent:
   :frag:     SNIPPET-CALC-PMI

.. oe:source:: CalcPMI.java
   :language: java
   :noindent:
   :frag:     SNIPPET-CALC-PMI

.. oe:source:: CalcPMI.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-CALC-PMI


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECalculateMolecularWeight

.. oe:function:: OECalculateMolecularWeight

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OECalculateMolecularWeight(const OEMolBase& mol,
                                           bool isotopic = false)

   .. oe:language:: python

      .. oe:api:: python

         OECalculateMolecularWeight(mol: Union[OEGraphMol,OEMol,OEQMol],
                                    isotopic: bool = False) -> float

   Calculates the molecular weight of the given molecule.
   By default, all atoms are assumed their average atomic weight, as returned
   by the :oe:func:`OEChem::OEGetAverageWeight` function.

   *isotopic*
      This parameter determines whether to use the :oe:func:`OEChem::OEGetIsotopicWeight` function
      instead of :oe:func:`OEChem::OEGetAverageWeight`. Atoms must have a specified (non-zero) isotopic 
      mass, as returned by :oe:meth:`OEChem::OEAtomBase::GetIsotope`

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`sizefilter.cpp<section_example_oechem_sizefilter>`
      * Example program :ref:`molstats.cpp<section_example_oechem_molstats>`

  .. oe:language:: python

      * Example program :ref:`sizefilter.py<section_example_oechem_sizefilter>`
      * Example program :ref:`molstats.py<section_example_oechem_molstats>`

  .. oe:language:: java

      * Example program :ref:`SizeFilter.java<section_example_oechem_sizefilter>`
      * Example program :ref:`MolStats.java<section_example_oechem_molstats>`

  .. oe:language:: csharp

      * Example program :ref:`SizeFilter.cs<section_example_oechem_sizefilter>`
      * Example program :ref:`MolStats.cs<section_example_oechem_molstats>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECanonicalOrderAtoms

.. oe:function:: OECanonicalOrderAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECanonicalOrderAtoms(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OECanonicalOrderAtoms(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Reorders the atoms of the molecule into canonical order. This function
   uses the :oe:meth:`OEChem::OEMolBase::OrderAtoms` method to change the
   order in which the iterator returned by
   :oe:meth:`OEChem::OEMolBase::GetAtoms` traverses the atoms of a
   molecule.  This function does not affect the atom indices.

   .. note::

      :oe:func:`OEChem::OECanonicalOrderAtoms` does not provide the
      exactly the same canonicalization that is used to generate
      :term:`canonical isomeric SMILES`.
      The canonical atom order of SMILES generation (with various flavors)
      can be accessed by calling the :oe:func:`OEChem::OEGetSmiStringOrder` function.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`cansmi.cpp<section_example_oechem_cansmi>`

  .. oe:language:: python

      * Example program :ref:`cansmi.py<section_example_oechem_cansmi>`

  .. oe:language:: java

      * Example program :ref:`CanSmi.java<section_example_oechem_cansmi>`

  .. oe:language:: csharp

      * Example program :ref:`CanSmi.cs<section_example_oechem_cansmi>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECanonicalOrderBonds

.. oe:function:: OECanonicalOrderBonds

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECanonicalOrderBonds(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OECanonicalOrderBonds(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Reorders the bonds of a molecule canonically with respect to the
   current atom order.  This function uses the
   :oe:meth:`OEChem::OEMolBase::OrderBonds` method to change the order in
   which the iterator returned by :oe:meth:`OEChem::OEMolBase::GetBonds`
   and :oe:meth:`OEChem::OEAtomBase::GetBonds` traverses the
   bonds of a molecule.  This function does not affect the bond indices.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`cansmi.cpp<section_example_oechem_cansmi>`

  .. oe:language:: python

      * Example program :ref:`cansmi.py<section_example_oechem_cansmi>`

  .. oe:language:: java

      * Example program :ref:`CanSmi.java<section_example_oechem_cansmi>`

  .. oe:language:: csharp

      * Example program :ref:`CanSmi.cs<section_example_oechem_cansmi>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECenter

.. oe:function:: OECenter

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECenter(OEMolBase& mol, double* t = 0)
         void OECenter(OEMCMolBase& mcmol, double* t = 0)
         void OECenter(OEConfBase& conf, double* t = 0)

   .. oe:language:: python

      .. oe:api:: python

         OECenter(arg1: Union[OEGraphMol,OEQMol], t: OEDoubleArray = None) -> None
         OECenter(mcmol: OEMol, t: OEDoubleArray = None) -> None
         OECenter(conf: OEConfBase, t: OEDoubleArray = None) -> None

   The :oe:func:`OEChem::OECenter` function moves the molecule so that its
   center of mass is located at the Cartesian position origin.  An
   optional array 't' can be passed in, which will be filled with the
   vector which describes the translation to move the molecule back to
   its original position.  For the :ref:`OEMolBase <OEChem_OEMolBase>` and
   :ref:`OEConfBase <OEChem_OEConfBase>` overloads, the 't' array, if present, is
   assumed to be at least of length three.  For the
   :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` overload, the 't' array is assumed to be
   at least of length :oe:meth:`OEChem::OEMCMolBase::GetMaxConfIdx` ``*3``.
   In this case, the vector to move and conformer back to its original
   position would be located at ``t[OEConfBase::GetIdx()*3]``.

   *mol*
      The molecule to center.

   *conf*
      The conformer to center.

   *mcmol*
      The multi-conformer molecule to center.

   *t*
      The translation required to move molecule back to original position.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECheckAtomValence

.. oe:function:: OECheckAtomValence

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECheckAtomValence(const OEAtomBase* atom)

   .. oe:language:: python

      .. oe:api:: python

         OECheckAtomValence(atom: OEAtomBase) -> bool

   Checks the atom's environment (specifically its atomic number, formal charge
   and the bond orders of the bonds it participates in) to determine if it is a
   valid atom valence whe consider the **OpenEye valence model**.
   Returns ``true`` if the atom is valid.

   .. seealso::

      * section :ref:`section_valence_openeye`
      * :oe:func:`OEChem::OECheckAtomValences` function
      * :oe:cls:`OEChem::OEIsValidAtomValence` predicate 


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECheckAtomValences

.. oe:function:: OECheckAtomValences

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECheckAtomValences(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OECheckAtomValences(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Loops through the atoms of the molecule and calls
   :oe:func:`OEChem::OECheckAtomValence` to check if every atom is
   valid considering the **OpenEye valence model**.
   Returns ``true`` if all atoms are valid.

   .. seealso::

      * section :ref:`section_valence_openeye`
      * :oe:func:`OEChem::OECheckAtomValence` function
      * :oe:cls:`OEChem::OEIsValidAtomValence` predicate


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEChemGetArch

.. oe:function:: OEChemGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEChemGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEChemGetArch() -> str



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEChemGetLicensee

.. oe:function:: OEChemGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEChemGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEChemGetLicensee(licensee: str) -> bool



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEChemGetPlatform

.. oe:function:: OEChemGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEChemGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEChemGetPlatform() -> str

   Returns the internal build string used by OpenEye, Cadence Molecular Sciences
   to identify a platform.  The format of these strings may change over
   time, and future distributions may contain different values even when
   using the same operating system, compiler and processor.  For example,
   on a ``x86_64`` Red Hat Enterprise Linux box this would return
   ``redhat-RHEL5-g++4.1-x64``.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`oecheminfo.cpp<section_example_oechem_oecheminfo>`

  .. oe:language:: python

      * Example program :ref:`oecheminfo.py<section_example_oechem_oecheminfo>`

  .. oe:language:: java

      * Example program :ref:`OEChemInfo.java<section_example_oechem_oecheminfo>`

  .. oe:language:: csharp

      * Example program :ref:`OEChemInfo.cs<section_example_oechem_oecheminfo>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEChemGetRelease

.. oe:function:: OEChemGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEChemGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEChemGetRelease() -> str

   Returns the release name of the *OEChem* library being used.  This
   returns a value similar to ``1.0`` for production versions of the
   library, and ``1.0 debug`` for the checking version of the library.

.. seealso::

  .. oe:language:: c++

      * :oe:func:`OEChem::OEChemGetVersion`
      * Example program :ref:`oecheminfo.cpp<section_example_oechem_oecheminfo>`

  .. oe:language:: python

      * :oe:func:`OEChem::OEChemGetVersion`
      * Example program :ref:`oecheminfo.py<section_example_oechem_oecheminfo>`

  .. oe:language:: java

      * :oe:func:`OEChem::OEChemGetVersion`
      * Example program :ref:`OEChemInfo.java<section_example_oechem_oecheminfo>`

  .. oe:language:: csharp

      * :oe:func:`OEChem::OEChemGetVersion`
      * Example program :ref:`OEChemInfo.cs<section_example_oechem_oecheminfo>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEChemGetSite

.. oe:function:: OEChemGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEChemGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEChemGetSite(site: str) -> bool



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEChemGetVersion

.. oe:function:: OEChemGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEChemGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEChemGetVersion() -> int

   Returns the version number of the library being used.  This is an
   unsigned integer value indicating the date on which the library was
   built, for example ``20020903``, for the 3rd of September 2002.  This
   value should be used when reporting problems, and unlike the release
   string, may be used in comparisons if needed.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`oecheminfo.cpp<section_example_oechem_oecheminfo>`

  .. oe:language:: python

      * Example program :ref:`oecheminfo.py<section_example_oechem_oecheminfo>`

  .. oe:language:: java

      * Example program :ref:`OEChemInfo.java<section_example_oechem_oecheminfo>`

  .. oe:language:: csharp

      * Example program :ref:`OEChemInfo.cs<section_example_oechem_oecheminfo>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEChemIsLicensed

..  _OEChem_OEChemIsLicensed:

.. oe:function:: OEChemIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEChemIsLicensed(const char* feature = 0,
                               unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEChemIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **OEChem TK**, **OESystem TK** or **OEPlatform TK**
   functionality.

   .. oe:language:: c++

      For example, to verify that **OEChem TK** can be used:

      .. oe:source:: OEChemIsLicensed.cpp
         :language: c++
         :frag:     SNIPPET-OECHEMISLICENSED-VERIFY

   .. oe:language:: python java csharp

      The 'features' argument can be used to check for a valid license to
      **OEChem TK** along with that feature, such as 'python', 'java' or 'clr'
      (for Csharp).
      For example, to verify that **OEChem TK** can be used:

      .. oe:source:: OEChemIsLicensed.py
         :language: python
         :frag:     SNIPPET-OECHEMISLICENSED-VERIFY

      .. oe:source:: OEChemIsLicensed.java
         :language: java
         :frag:     SNIPPET-OECHEMISLICENSED-VERIFY

      .. oe:source:: OEChemIsLicensed.cs
         :language: csharp
         :frag:     SNIPPET-OECHEMISLICENSED-VERIFY

   The second argument can be used to get the expiration date of the
   license. This is an array of size three with the date returned as
   {day, month, year}. Even if the function returns ``false`` due to an
   expired license, the 'expdate' will show that expiration date. A value
   of a zeroes implies that no license or date was found.

   .. oe:source:: OEChemIsLicensed.cpp
      :language: c++
      :frag:     SNIPPET-OECHEMISLICENSED-EXPIRE

   .. oe:source:: OEChemIsLicensed.py
      :language: python
      :frag:     SNIPPET-OECHEMISLICENSED-EXPIRE

   .. oe:source:: OEChemIsLicensed.java
      :language: java
      :frag:     SNIPPET-OECHEMISLICENSED-EXPIRE

   .. oe:source:: OEChemIsLicensed.cs
      :language: csharp
      :frag:     SNIPPET-OECHEMISLICENSED-EXPIRE


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEClear2DRingDictionary

.. oe:function:: OEClear2DRingDictionary

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEClear2DRingDictionary()

   .. oe:language:: python

      .. oe:api:: python

         OEClear2DRingDictionary() -> None

   Clears the **global** user-defined ring dictionary that is used to 
   generate 2D coordinates when calling the :oe:func:`OEChem::OEGenerate2DCoordinates` 
   function.

   .. seealso::

      * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
      * :oe:func:`OEChem::OEIsValid2DRingDictionary` function
      * :oe:func:`OEChem::OEInit2DRingDictionary` function



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEClearAromaticFlags

.. oe:function:: OEClearAromaticFlags

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEClearAromaticFlags(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEClearAromaticFlags(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Clears the aromatic property of all atoms and bonds in
   the molecule.  This function effectively Kekulizes the molecule, if a
   |Kekule| form has already been perceived by the
   :oe:func:`OEChem::OEKekulize` function.  Note this function does not
   affect the integer types or the type names of the atom or bond of the
   molecule.

   .. seealso::

      * :oe:func:`OEChem::OEAssignAromaticFlags` to determine atom and bond aromaticity properties
      * :ref:`chapter_aromaticity` chapter



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEClearChiralPerception

.. oe:function:: OEClearChiralPerception

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEClearChiralPerception(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEClearChiralPerception(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Function to clear the chiral perception from a molecule and its atoms and bonds.

   .. seealso::

      * :oe:func:`OEChem::OEPerceiveChiral` to perceive chiral atoms and bonds


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEClearFormalCharges

.. oe:function:: OEClearFormalCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEClearFormalCharges(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEClearFormalCharges(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Clears the formal charge property of all atoms in a
   molecule, setting the formal charge on each atom of a molecule to
   ``0``.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEClearMMCIFData

.. oe:function:: OEClearMMCIFData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEClearMMCIFData(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEClearMMCIFData(mol: Union[OEGraphMol,OEQMol]) -> bool

   Removes all mmCIF data from the molecule.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEClearMMCIFData(OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEClearMMCIFData(mol: OEMol) -> bool

   Removes all mmCIF data from the molecule and from all of its conformers.

   .. seealso::

      * :ref:`section_moldata_MMCIF` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEClearPDBData

.. oe:function:: OEClearPDBData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEClearPDBData(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEClearPDBData(mol: Union[OEGraphMol,OEQMol]) -> bool

   Removes all PDB data from the molecule.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEClearPDBData(OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEClearPDBData(mol: OEMol) -> bool

   Removes all PDB data from the molecule and from all of its conformers.

   .. seealso::

      * :oe:func:`OEChem::OEDeletePDBData` function to remove PDB data with a specific tag
      * :ref:`section_moltaggeddata_PDB` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEClearPartialCharges

.. oe:function:: OEClearPartialCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEClearPartialCharges(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEClearPartialCharges(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Clears the partial charge property of all atoms in a
   molecule, setting the partial charge on each atom of a molecule to
   ``0.0``.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEClearResidue

.. oe:function:: OEClearResidue

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEClearResidue(OEAtomBase* atom)

   .. oe:language:: python

      .. oe:api:: python

         OEClearResidue(atom: OEAtomBase) -> None



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEClearResidues

.. oe:function:: OEClearResidues

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEClearResidues(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEClearResidues(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEClearRotorCompressData

.. oe:function:: OEClearRotorCompressData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEClearRotorCompressData(OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEClearRotorCompressData(mol: OEMol) -> bool



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEClearSDData

.. oe:function:: OEClearSDData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEClearSDData(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEClearSDData(mol: Union[OEGraphMol,OEQMol]) -> bool

   Removes all SD data from the molecule.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEClearSDData(OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEClearSDData(mol: OEMol) -> bool

   Removes all SD data from the molecule and from all of its conformers.

   .. seealso::

      .. oe:language:: c++

         * :oe:func:`OEChem::OEDeleteSDData` to remove SD data with a specific tag
         * :ref:`section_moltaggeddata_SD` section
         * Example program :ref:`sdfmodprops.cpp<section_example_oechem_sdfmodprops>`

      .. oe:language:: python

         * :oe:func:`OEChem::OEDeleteSDData` to remove SD data with a specific tag
         * :ref:`section_moltaggeddata_SD` section
         * Example program :ref:`sdfmodprops.py<section_example_oechem_sdfmodprops>`

      .. oe:language:: java

         * :oe:func:`OEChem::OEDeleteSDData` to remove SD data with a specific tag
         * :ref:`section_moltaggeddata_SD` section
         * Example program :ref:`SDFModProps.java<section_example_oechem_sdfmodprops>`

      .. oe:language:: csharp

         * :oe:func:`OEChem::OEDeleteSDData` to remove SD data with a specific tag
         * :ref:`section_moltaggeddata_SD` section
         * Example program :ref:`SDFModProps.cs<section_example_oechem_sdfmodprops>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEClearStyle

.. oe:function:: OEClearStyle

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEClearStyle(OEChem::OEMolBase& mol)
         void OEClearStyle(OEChem::OEAtomBase& atom)
         void OEClearStyle(OESystem::OEContainer& cont)
         void OEClearStyle(OESystem::OEIter<OEChem::OEAtomBase>& atoms)

   .. oe:language:: python

      .. oe:api:: python

         OEClearStyle(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None
         OEClearStyle(atom: OEAtomBase) -> None
         OEClearStyle(cont: OEContainer) -> None
         OEClearStyle(atoms: OEAtomIter) -> None

   Clears the style declared for a molecule and all of its atoms, 
   a certain atom in a molecule, iterator of specified atoms, and an 
   :ref:`OEContainer <OESystem_OEContainer>`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECopyMMCIFData

.. oe:function:: OECopyMMCIFData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECopyMMCIFData(OEMolBase& dst, const OEMolBase& src)

   .. oe:language:: python

      .. oe:api:: python

         OECopyMMCIFData(dst: Union[OEGraphMol,OEMol,OEQMol],
                         src: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Copies the entire set of mmCIF metadata from a source molecule to a destination molecule.

   .. seealso::

      * :ref:`section_moldata_MMCIF` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECopyMol

.. oe:function:: OECopyMol

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECopyMol(OEMolBase& dst, const OEMolBase& src,
                        OEAtomBase** atommap = 0, OEBondBase** bondmap = 0)
         void OECopyMol(OEMCMolBase& dst, const OEMCMolBase& src,
                        OEAtomBase** atommap = 0, OEBondBase** bondmap = 0)

   .. oe:language:: python

      .. oe:api:: python

         OECopyMol(dst: Union[OEGraphMol,OEMol,OEQMol],
                   src: Union[OEGraphMol,OEMol,OEQMol],
                   atommap: OEAtomBase = None, bondmap: OEBondBase = None) -> None
         OECopyMol(dst: OEMol, src: OEMol, atommap: OEAtomBase = None,
                   bondmap: OEBondBase = None) -> None

   Create a copy of the molecule ``src`` into the molecule
   ``dst``. The mapping of the atoms and bonds between the two copies
   of the molecule can be retrieved by passing in arrays to the
   ``atommap`` and ``bondmap`` arguments. The size of the ``atommap``
   array should be large enough to store ``src.GetMaxAtomIdx()``
   atoms. The size of the ``bondmap`` array should be large enough to
   store ``src.GetMaxBondIdx()`` atoms. The new atom or bond in
   ``dst`` will be stored at the ``src`` atom or bond's
   :oe:meth:`OEChem::OEAtomBase::GetIdx<OEChem::OEAtomBase::GetIdx>`
   location in the array.

   The following code demonstrates how to access the atom associations
   output by the ``OECopyMol`` function.

   .. oe:source:: CopyMol.cpp
      :language: c++
      :frag:     SNIPPET

   .. oe:source:: CopyMol.py
      :language: python
      :frag:     SNIPPET

   .. oe:source:: CopyMol.java
      :language: java
      :frag:     SNIPPET

   .. oe:source:: CopyMol.cs
      :language: csharp
      :frag:     SNIPPET



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECopyPDBData

.. oe:function:: OECopyPDBData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECopyPDBData(OEMolBase& dst, const OEMolBase& src)

   .. oe:language:: python

      .. oe:api:: python

         OECopyPDBData(dst: Union[OEGraphMol,OEMol,OEQMol],
                       src: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Copies the entire set of PDB data from a source molecule to a destination molecule.

   .. seealso::

      * :ref:`section_moltaggeddata_PDB` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECopySDData

.. oe:function:: OECopySDData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECopySDData(OEMolBase& dst, const OEMolBase& src)
         bool OECopySDData(OEMolBase& dst, const OESystem::OEContainer& src)

   .. oe:language:: python

      .. oe:api:: python

         OECopySDData(dst: Union[OEGraphMol,OEMol,OEQMol],
                      src: Union[OEGraphMol,OEMol,OEQMol]) -> bool
         OECopySDData(dst: Union[OEGraphMol,OEMol,OEQMol], src: OEContainer) -> bool

   Copies the entire set of SD data from a source to a destination molecule.

   .. seealso::

      * :ref:`section_moltaggeddata_SD` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECorrectAcidProtonGeometry

.. oe:function:: OECorrectAcidProtonGeometry

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECorrectAcidProtonGeometry(OEMolBase& mol)
         bool OECorrectAcidProtonGeometry(OEMolBase& mol,
                                          const OEAtomBase* atom)

   .. oe:language:: python

      .. oe:api:: python

         OECorrectAcidProtonGeometry(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
         OECorrectAcidProtonGeometry(mol: Union[OEGraphMol,OEMol,OEQMol],
                                     atom: OEAtomBase) -> bool



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OECount

.. oe:function:: OECount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OECount(const OEMolBase& mol, const OESubSearch& ss,
                              bool uniquematch = false)

   .. oe:language:: python

      .. oe:api:: python

         OECount(arg1: Union[OEGraphMol,OEMol,OEQMol], arg2: OESubSearch,
                 uniquematch: bool = False) -> int

   Returns the number of substructure search matches for the given molecule.

   *uniquematch*
      If ``true`` then only the unique matches will be counted.
      See more details in :oe:meth:`OEChem::OESubSearch::Match` method.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OECount(const OEMolBase& mol,
                              const OESystem::OEUnaryPredicate<OEAtomBase> &)

   .. oe:language:: python

      .. oe:api:: python

         OECount(arg1: Union[OEGraphMol,OEMol,OEQMol], arg2: OEUnaryAtomPred) -> int

   Returns the number of atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) matching
   the given predicate.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OECount(const OEAtomBondSet& abset,
                              const OESystem::OEUnaryPredicate<OEAtomBase> &)

   .. oe:language:: python

      .. oe:api:: python

         OECount(abset: OEAtomBondSet, atompred: OEUnaryAtomPred) -> int

   Returns the number of atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) matching
   the given predicate from the provided container.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OECount(const OEMolBase& mol,
                              const OESystem::OEUnaryPredicate<OEBondBase> &)

   .. oe:language:: python

      .. oe:api:: python

         OECount(arg1: Union[OEGraphMol,OEMol,OEQMol], arg2: OEUnaryBondPred) -> int

   Returns the number of bonds (:ref:`OEBondBase <OEChem_OEBondBase>`) matching
   the given predicate.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OECount(const OEAtomBondSet& abset,
                              const OESystem::OEUnaryPredicate<OEBondBase> &)

   .. oe:language:: python

      .. oe:api:: python

         OECount(abset: OEAtomBondSet, bondpred: OEUnaryBondPred) -> int

   Returns the number of bonds (:ref:`OEBondBase <OEChem_OEBondBase>`) matching
   the given predicate from the provided container.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OECount(const OEMolBase& mol,
                              const OESystem::OEUnaryPredicate<OEGroupBase> &)

   .. oe:language:: python

      .. oe:api:: python

         OECount(arg1: Union[OEGraphMol,OEMol,OEQMol], arg2: OEUnaryGroupPred) -> int

   Returns the number of groups (:ref:`OEGroupBase <OEChem_OEGroupBase>`) matching
   the given predicate.

   .. seealso::

      * :oe:func:`OESystem::OECount` functions in **OESystem TK**

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OECount(const OEMonomerSet& monomers,
                          const OESystem::OEUnaryPredicate<OEMonomer>& pred)

   .. oe:language:: python

      .. oe:api:: python

         OECount(monomers: OEMonomerSet, pred: OEUnaryMonomerPred) -> int

   .. attention::

      |PRELIMINARY-API|

   Returns the number of groups (:ref:`OEMonomer <OEChem_OEMonomer>`) matching
   the given predicate.

   .. seealso::

      * :oe:cls:`OEChem::OEMonomerSet` class

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECreateAbsSmiString

..  _OECreateAbsSmiString:

.. oe:function:: OECreateAbsSmiString

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECreateAbsSmiString(std::string& str, const OEMolBase& mol,
                                   std::pair<const OEAtomBase *, const OEAtomBase *>* atmord = (std::pair<const OEAtomBase *, const OEAtomBase *> *) 0)

   .. oe:language:: python

      .. oe:api:: python

         OECreateAbsSmiString(str: str, mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Creates a :term:`SMILES` string representing a given molecule, without
   isotopic labeling or stereochemistry, and in arbitrary output
   order (*i.e.* not necessarily canonical).
   This function is just a special case of the :oe:func:`OEChem::OECreateSmiString`
   function.

   .. note::

      This function does not correspond to any of the forms (flavors) of :term:`SMILES`
      string produced by *Daylight*.

   .. seealso::

      * :oe:func:`OEChem::OECreateCanSmiString` to create an :term:`canonical SMILES`
      * :oe:func:`OEChem::OECreateIsoSmiString` to create an :term:`canonical isomeric SMILES`

.. ################################################################
   #
   ################################################################



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OECreateAtomSmartsString

.. oe:function:: OECreateAtomSmartsString

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECreateAtomSmartsString(std::string& str,
                                       const OEChem::OEAtomBase* atm,
                                       unsigned int atomSMARTSFlags = OESMARTSAtomFlag::AtomDefault,
                                       bool bExplicitDelim = true)

   .. oe:language:: python

      .. oe:api::

         OECreateSmartsAtomString(OEAtomBase atm, int atomflags,
                                  bool delim = True) -> str

   .. oe:language:: c++ python java csharp

      For a specified atom, generate a SMARTS string of query qualifiers based on the specified atom's environment
      and using the constraints defined by the :oe:constns:`OEChem::OESMARTSAtomFlag` namespace. The ``bExplicitDelim``
      argument indicates if the generated property list should be explicitly ``;`` delimited in the output to simplify
      post-processing for custom constraint generations.

   .. oe:language:: java csharp

      This function is only provided in C++ and python.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OECreateBondSmartsString

.. oe:function:: OECreateBondSmartsString

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECreateBondSmartsString(std::string& str,
                                       const OEChem::OEBondBase* bnd,
                                       unsigned int bondSMARTSFlags = OESMARTSBondFlag::BondDefault,
                                       bool bExplicitDelim = false)

   .. oe:language:: python

      .. oe:api::

         OECreateSmartsBondString(OEBondBase bnd, int bondflags,
                                  bool delim = False) -> str

   .. oe:language:: c++ python java csharp

      For a specified bond, generate a SMARTS string of query qualifiers based on the specified bond's environment
      and using the constraints defined by the :oe:constns:`OEChem::OESMARTSBondFlag` namespace.

   .. oe:language:: java csharp

      This function is only provided in C++ and python.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECreateCSVHeader

.. oe:function:: OECreateCSVHeader

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECreateCSVHeader(OECSVHeader& header, const OEMolBase& mol)
         void OECreateCSVHeader(OECSVHeader& header, const OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OECreateCSVHeader(header: OECSVHeader, mol: Union[OEGraphMol,OEQMol]) -> None
         OECreateCSVHeader(header: OECSVHeader, mol: OEMol) -> None

   Initializes a :ref:`OECSVHeader <OEChem_OECSVHeader>` object to the SD data
   tags present in ``mol``. If a :ref:`OEMCMolBase <OEChem_OEMCMolBase>` is
   given, all the SD data tags across all the conformers are considered.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


..  _OECreateCanSmiString:

.. oe:namespace:: OEChem

.. meta::
   :keywords: OECreateCanSmiString

.. oe:function:: OECreateCanSmiString

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECreateCanSmiString(std::string& str, const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OECreateCanSmiString(str: str, mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Creates a :term:`canonical SMILES` string representing a given molecule,
   but without isotopic labeling or stereochemistry.
   This function is just a special case of the :oe:func:`OEChem::OECreateSmiString`
   function, called with the flavor :oe:const:`OEChem::OESMILESFlag::DEFAULT`.

   .. note::

      This function produces what Daylight Chemical Information Systems
      term a *unique* SMILES.

   Note that the canonical SMILES generated by this function remains
   dependent on the state of the molecule, especially its aromaticity
   state (see examples in :ref:`section_aromaticity_models` section).
   Thus, to generate a canonical smiles suitable for purposes
   such as a database key, the user must assure that the state of
   the molecule has been standardized.
   In particular, aromaticity should be perceived according to the preferred model.

   In contrast, the high-level output function :oe:func:`OEChem::OEWriteMolecule`,
   when writing the canonical SMILES format (:oe:const:`OEChem::OEFormat::CAN`)
   does invoke :oe:func:`OEChem::OEFindRingAtomsAndBonds` and
   :oe:func:`OEChem::OEAssignAromaticFlags`.

   .. seealso::

      * :oe:func:`OEChem::OEMolToSmiles` for a high-level and **preferred** way to create
        :term:`SMILES` equivalent to what is written by
        :oe:func:`OEChem::OEWriteMolecule`.
      * :oe:func:`OEChem::OECreateAbsSmiString` to create an arbitrary :term:`SMILES`
      * :oe:func:`OEChem::OECreateIsoSmiString` to create an :term:`canonical isomeric SMILES`

   **Validation:**

   The :oe:func:`OEChem::OECreateCanSmiString` is rigorously tested to ensure
   that it generates unique string representations of molecules.
   This test involves randomly reordering the atoms and bonds of molecules
   and confirming that this has no effect on the SMILES generated by the
   :oe:func:`OEChem::OECreateCanSmiString` function.

   .. table:: Performance of **OECreateCanSmiString** to generate :term:`canonical SMILES`

      =================== ========= ============
      Database            Size      Success Rate
      =================== ========= ============
      Wombat              53K       100.0 %
      Maybridge           64K       100.0 %
      MDDR                111K      100.0 %
      NCI                 250K      100.0 %
      =================== ========= ============

   Running the validation test on 19M unique molecules produces only
   in 57 failures.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECreateInChI

.. oe:function:: OECreateInChI

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECreateInChI(std::string& str, const OEMolBase& mol,
                            const OEInChIOptions& = OEInChIOptions())

   .. oe:language:: python

      .. oe:api:: python

         OECreateInChI(str: str, mol: Union[OEGraphMol,OEMol,OEQMol],
                       arg3: OEInChIOptions = OEInChIOptions()) -> None

   Creates an *standard InChI* or a *nonstandard InChI* string representing a given molecule.
   See the :ref:`chapter_inchivalidation` chapter for information on validations of generated InChI strings.

   .. note::

      Setting any options will by default return a *nonstandard InChI*.

   .. note::

      |InChIVersionID|

   .. seealso::

      * :oe:func:`OEChem::OEMolToSTDInChI` function
      * :oe:func:`OEChem::OEMolToInChI` function
      * :oe:func:`OEChem::OEInChIToMol` function
      * :oe:func:`OEChem::OEParseInChI` function
      * :ref:`chapter_atomstereo` chapter for valid bond stereo configurations
      * `InChi Software Download`_



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECreateInChIKey

.. oe:function:: OECreateInChIKey

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECreateInChIKey(std::string& str, const OEMolBase& mol,
                               const OEInChIOptions& = OEInChIOptions())

   .. oe:language:: python

      .. oe:api:: python

         OECreateInChIKey(str: str, mol: Union[OEGraphMol,OEMol,OEQMol],
                          arg3: OEInChIOptions = OEInChIOptions()) -> None

   Creates an :term:`InChIKey` string representing a given molecule.

   .. note::

      |InChIVersionID|



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

..  _OECreateIsoSmiString:

.. meta::
   :keywords: OECreateIsoSmiString

.. oe:function:: OECreateIsoSmiString

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECreateIsoSmiString(std::string& str, const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OECreateIsoSmiString(str: str, mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Creates an :term:`canonical isomeric SMILES` string representing a given molecule.

   This function is just a special case of the :oe:func:`OEChem::OECreateSmiString`
   function, called with the flavor :oe:const:`OEChem::OESMILESFlag::ISOMERIC`.

   .. note::

      This function produces SMILES that correspond  what *Daylight*  Chemical Information
      Systems term an '*absolute*' SMILES

   Note that the canonical SMILES generated by this function remains
   dependent on the state of the molecule, especially its aromaticity
   state (see examples in :ref:`section_aromaticity_models` section).
   Thus, to generate a canonical smiles suitable for purposes
   such as a database key, the user must assure that the state of
   the molecule has been standardized.
   In particular, aromaticity should be perceived according to the preferred model.

   In contrast, the high-level output function :oe:func:`OEChem::OEWriteMolecule`
   (and :oe:func:`OEChem::OEMolToSmiles`) , when
   writing the canonical SMILES format (:oe:const:`OEChem::OEFormat::ISM`) does invoke
   :oe:func:`OEChem::OEFindRingAtomsAndBonds` and :oe:func:`OEChem::OEAssignAromaticFlags`.

   Furthermore, whether :oe:func:`OEChem::OEWriteMolecule` or
   :oe:func:`OEChem::OECreateIsoSmiString` is used, the canonical SMILES generated depends on
   the current stereo specifications for the molecule.
   If the goal is a :term:`canonical isomeric SMILES` which is unique for all representations
   of an equivalent stereoisomer, *i.e.*, for use as a database key, it is the user's
   responsibility to assure that the stereochemical state of the molecule has been
   rationalized and standardized, using methods such as:

   * :oe:func:`OEChem::OEPerceiveChiral`, :oe:func:`OEChem::OE3DToAtomStereo`, :oe:func:`OEChem::OE3DToBondStereo`
   * :oe:meth:`OEChem::OEAtomBase::IsChiral`, :oe:meth:`OEChem::OEAtomBase::SetStereo`
   * :oe:meth:`OEChem::OEBondBase::IsChiral`, :oe:meth:`OEChem::OEBondBase::SetStereo`

   .. seealso::

      .. oe:language:: c++

         * :oe:func:`OEChem::OEMolToSmiles` for a high-level way to create
           :term:`SMILES` equivalent to what is written by
           :oe:func:`OEChem::OEWriteMolecule`.
         * :oe:func:`OEChem::OECreateAbsSmiString` to create an arbitrary :term:`SMILES`
         * :oe:func:`OEChem::OECreateCanSmiString` to create a :term:`canonical SMILES`
         * Example program :ref:`uniqmol.cpp<section_example_oechem_uniqmol>`

      .. oe:language:: python

         * :oe:func:`OEChem::OEMolToSmiles` for a high-level way to create
           :term:`SMILES` equivalent to what is written by
           :oe:func:`OEChem::OEWriteMolecule`.
         * :oe:func:`OEChem::OECreateAbsSmiString` to create an arbitrary :term:`SMILES`
         * :oe:func:`OEChem::OECreateCanSmiString` to create a :term:`canonical SMILES`
         * Example program :ref:`uniqmol.py<section_example_oechem_uniqmol>`

      .. oe:language:: java

         * :oe:func:`OEChem::OEMolToSmiles` for a high-level way to create
           :term:`SMILES` equivalent to what is written by
           :oe:func:`OEChem::OEWriteMolecule`.
         * :oe:func:`OEChem::OECreateAbsSmiString` to create an arbitrary :term:`SMILES`
         * :oe:func:`OEChem::OECreateCanSmiString` to create a :term:`canonical SMILES`
         * Example program :ref:`UniqMol.java<section_example_oechem_uniqmol>`

      .. oe:language:: csharp

         * :oe:func:`OEChem::OEMolToSmiles` for a high-level way to create
           :term:`SMILES` equivalent to what is written by
           :oe:func:`OEChem::OEWriteMolecule`.
         * :oe:func:`OEChem::OECreateAbsSmiString` to create an arbitrary :term:`SMILES`
         * :oe:func:`OEChem::OECreateCanSmiString` to create a :term:`canonical SMILES`
         * Example program :ref:`UniqMol.cs<section_example_oechem_uniqmol>`

   **Validation:**

   The :oe:func:`OEChem::OECreateIsoSmiString` is rigorously tested to ensure
   that it generates unique string representations of molecules.
   This test involves randomly reordering the atoms and bonds of molecules
   and confirming that this has no effect on the SMILES generated by the
   :oe:func:`OEChem::OECreateIsoSmiString` function.

   .. table:: Performance of **OECreateIsoSmiString** to generate :term:`canonical isomeric SMILES`

      =================== ========= ============
      Database            Size      Success Rate
      =================== ========= ============
      Wombat              53K       100.0 %
      Maybridge           64K       100.0 %
      MDDR                111K      100.0 %
      NCI                 250K      100.0 %
      =================== ========= ============

   Running the validation test on 24M unique molecules produces only
   129 failure cases.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECreateMolDatabaseIdx

.. oe:function:: OECreateMolDatabaseIdx

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECreateMolDatabaseIdx(const std::string& databaseFileName)
         bool OECreateMolDatabaseIdx(const std::string& databaseFileName,
                                     const std::string& indexFileName)

   .. oe:language:: python

      .. oe:api:: python

         OECreateMolDatabaseIdx(databaseFileName: str) -> bool
         OECreateMolDatabaseIdx(databaseFileName: str, indexFileName: str) -> bool

   Creates an index file parallel to the file named by
   ``databaseFileName`` to improve the performance of
   :oe:meth:`OEChem::OEMolDatabase::Open` as described by the
   :ref:`section_index_files` section. If
   :oe:meth:`OEChem::OEMolDatabase::Open` detects the presence of a
   parallel :file:`.idx` file, the file position offsets will be read
   from the :file:`.idx` file instead of having to stream the entire
   file off of disk to find the offsets during the call to
   :oe:meth:`OEChem::OEMolDatabase::Open`.

   The index file name created is based upon the
   ``databaseFileName`` passed, optionally accounting for
   :file:`.gz`. The following table demonstrates the pattern used to
   create index file names:

   =================== =====================
   Database File Name  Index File Name
   =================== =====================
   database.oeb        database.oeb.idx
   database.oeb.gz     database.oeb.idx.gz
   =================== =====================

   The overload of the function that takes an ``indexFileName`` will
   write the index to that file name instead.

   Returns ``false`` if the function fails to create the index file
   for any reason, e.g., unable to open the file specified by
   ``databaseFileName``.

   **Example**

   .. oe:source:: CreateMolDBIdx.cpp
      :language: c++
      :caption:  Creates an index file
      :refnum:   1
      :frag:     SNIPPET-CreateMolDBIdx

   .. oe:source:: CreateMolDBIdx.py
      :language: python
      :caption:  Creates an index file
      :refnum:   1
      :frag:     SNIPPET-CreateMolDBIdx

   .. oe:source:: CreateMolDBIdx.java
      :language: java
      :caption:  Creates an index file
      :refnum:   1
      :frag:     SNIPPET-CreateMolDBIdx

   .. oe:source:: CreateMolDBIdx.cs
      :language: csharp
      :caption:  Creates an index file
      :refnum:   1
      :frag:     SNIPPET-CreateMolDBIdx

   .. note::

      :file:`.idx` files can be concatenated together. Care must be
      taken to concatenate the corresponding database files together
      in the exact same order.

.. ################################################################
   #
   ################################################################



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


    
.. oe:namespace:: OEChem

.. oe:function:: OECreatePeptideMonomerConnectionSmiles

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OECreatePeptideMonomerConnectionSmiles(const std::string& monomerSmiles)

   .. oe:language:: python

      .. oe:api:: python

         OECreatePeptideMonomerConnectionSmiles(monomerSmiles: str) -> str

   The function identifies the backbone of the amino acid represented in the input string and
   marks the backbone connections in the output smiles:

   - the hydrogen of the amino group of the backbone will be have atom mapping ``1``
   - the oxygen of the amino acid of the backbone with be have atom mapping ``2``

   For example, in case of the input smiles ``C[C@@H](C(=O)O)N``, 
   the function will return ``[H:1]N[C@@H](C)C(=O)[OH:2]``.

   If the input smiles does not represent an amino-acid or its backbone can not be 
   identified, and empty string will be returned.

   The current implementation supports the identification of backbone connection for 
   alpha-, beta-, gamma-, and delta- amino acids. 
   However, it does not identify connection point(s) on the side chain of the amino acid.

   For example, in case of the input smiles  ``C([C@@H](C(=O)[OH:2])N)S`` representing `cystine`, 
   the function will return ``[H:1]N[C@@H](CS)C(=O)[OH:2]",`` rather than ``[H:1]N[C@@H](CS[H:3])C(=O)[OH:2]``
   where `R3` could be used to form disulfide cross-links.

   When identifying the backbone of an amino acid, backbone is always selected as the shortest path
   between identified amino and carboxylic acid groups.

   For example, in case of the input smiles ``C(CC(=O)O)[C@@H](C(=O)O)N`` representing `glutamic acid`, 
   the function will return ``[H:1]N[C@@H](CCC(=O)O)C(=O)[OH:2]``, rather than ``[H:1]N[C@@H](CCC(=O)[OH:3])C(=O)[OH:2]``
   where `R3` could be used to form isopeptide bond.

   When creating a custom monomer set, side-chain interactions of amino acids, along with the 
   identification of connection points for C- and N-terminal monomers and generic non-peptidic monomers, 
   must be specified manually.

   .. seealso::

      * :oe:func:`OEChem::OEPerceivePeptideMonomerConnections` function
      * :oe:func:`OEChem::OEMonomerConnectionSmilesFromCXSmiles` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECreateSlnString

.. oe:function:: OECreateSlnString

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECreateSlnString(std::string& str, const OEMolBase& mol,
                                unsigned int flavor = OESLNFlag::DEFAULT)

   .. oe:language:: python

      .. oe:api:: python

         OECreateSlnString(str: str, mol: Union[OEGraphMol,OEMol,OEQMol],
                           flavor: int) -> None

   Creates a *Tripos* SLN string representing a given molecule.
   Several variants of SLN format are supported by using different flavors from
   the :oe:constns:`OEChem::OESLNFlag` namespace.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OECreateSmartsString

.. oe:function:: OECreateSmartsString

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECreateSmartsString(std::string& str, const OEMolBase& mol,
                                   const char* smartsTag = nullptr,
                                   unsigned int flavor = (OESMILESFlag::DEFAULT & ~OESMILESFlag::Canonical),
                                   std::pair<const OEAtomBase*, const OEAtomBase*>* atmord = nullptr)

   .. oe:language:: python

      .. oe:api::

         OECreateSmartsString(OEMolBase mol, str smartsTag = None,
                              int flavor = (OESMILESFlag_DEFAULT & ~OESMILESFlag_Canonical)) -> str

   .. oe:language:: c++ python java csharp

      Generate the :term:`SMARTS` string from the provided molecule using the flavors from the :oe:constns:`OEChem::OESMILESFlag` namespace.
      If the ``smartsTag`` argument is null, the data tag applied by :oe:func:`OEChem::OEParseSmarts` 
      is assumed to contain the atom and bond annotations from the SMARTS parse, otherwise an explicit generic data tag
      can be provided for custom SMARTS constraint annotations.  Note that custom constraint annotations are not validated, so
      extra checking for a valid SMARTS query will be required (e.g., by calling :oe:func:`OEChem::OEParseSmarts`).

      The provided default flavor for the SMARTS generation suppresses reordering which can invalidate the statically captured
      pattern constraints.  Any explicitly provided non-default flavor should also suppress reordering activity for the same reason.
      While the flavor is provided for user control and experimentation, be aware that only actual atom/bond properties on the molecule
      are considered for the flavor provided, so any SMARTS qualifiers from the ``smartsTag`` generic data are considered to be completely irrelevant
      during canonicalization. Extra care is also required if any atom (:oe:const:`OEChem::OESMARTSAtomFlag::Chirality`)
      or bond (:oe:const:`OEChem::OESMARTSBondFlag::Chirality`) stereo parity is encoded as into the SMARTS string, requiring one or both of
      :oe:const:`OEChem::OESMILESFlag::AtomStereo` for tetrahedral stereo parity SMARTS encodings, or
      :oe:const:`OEChem::OESMILESFlag::BondStereo` for cis/trans SMARTS encodings.

      .. seealso::
         * :ref:`SMARTS <chapter_SMARTS>`
         * :oe:func:`OEChem::OECreateAtomSmartsString`
         * :oe:func:`OEChem::OECreateBondSmartsString`

   .. oe:language:: java csharp

      This function is only provided in C++ and python.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OECreateSmiString

.. oe:function:: OECreateSmiString

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECreateSmiString(std::string& str, const OEMolBase& mol,
                                unsigned int flavor = OESMILESFlag::DEFAULT,
                                std::pair<const OEAtomBase*, const OEAtomBase*>* atmord = (std::pair<const OEAtomBase*, const OEAtomBase*>*)0)

   .. oe:language:: python

      .. oe:api:: python

         OECreateSmiString(str: str, mol: Union[OEGraphMol,OEMol,OEQMol],
                           flavor: int) -> None

   Creates a SMILES string representing a given molecule.
   Several variants of SMILES format are supported by using different
   flavors from the :oe:constns:`OEChem::OESMILESFlag` namespace.

   .. note::

      :oe:func:`OEChem::OEGetSmiStringOrder` function can be used
      to return an iterator over atoms, in the order in which they appear in the SMILES string.

   .. list-table:: **The following function calls generate identical SMILES**
      :widths: 50 200
      :header-rows: 1

      * - **OEChem TK** function
        - calling :oe:func:`OEChem::OECreateSmiString` with flags from the :oe:constns:`OEChem::OESMILESFlag` namespace

      * - :oe:func:`OEChem::OECreateAbsSmiString`
        - :oe:const:`AtomMaps<OEChem::OESMILESFlag::AtomMaps>` | :oe:const:`RGroups<OEChem::OESMILESFlag::RGroups>`

      * - :oe:func:`OEChem::OECreateCanSmiString`
        - :oe:const:`DEFAULT<OEChem::OESMILESFlag::DEFAULT>` identical to :oe:const:`Canonical<OEChem::OESMILESFlag::Canonical>` | :oe:const:`AtomMaps<OEChem::OESMILESFlag::AtomMaps>` | :oe:const:`RGroups<OEChem::OESMILESFlag::RGroups>`

      * - :oe:func:`OEChem::OECreateIsoSmiString`
        - :oe:const:`ISOMERIC<OEChem::OESMILESFlag::ISOMERIC>` identical to :oe:const:`Isotopes<OEChem::OESMILESFlag::Isotopes>` | :oe:const:`AtomStereo<OEChem::OESMILESFlag::AtomStereo>` | :oe:const:`BondStereo<OEChem::OESMILESFlag::BondStereo>` | :oe:const:`Canonical<OEChem::OESMILESFlag::Canonical>` | :oe:const:`AtomMaps<OEChem::OESMILESFlag::AtomMaps>` | :oe:const:`RGroups<OEChem::OESMILESFlag::RGroups>`

      * - :oe:func:`OEChem::OEMolToSmiles`
        - :oe:const:`ISOMERIC<OEChem::OESMILESFlag::ISOMERIC>` identical to :oe:const:`Isotopes<OEChem::OESMILESFlag::Isotopes>` | :oe:const:`AtomStereo<OEChem::OESMILESFlag::AtomStereo>` | :oe:const:`BondStereo<OEChem::OESMILESFlag::BondStereo>` | :oe:const:`Canonical<OEChem::OESMILESFlag::Canonical>` | :oe:const:`AtomMaps<OEChem::OESMILESFlag::AtomMaps>` | :oe:const:`RGroups<OEChem::OESMILESFlag::RGroups>`

   [1] :oe:func:`OEChem::OEMolToSmiles` is a high-level function that perceives necessary properties before generating :term:`canonical isomeric SMILES`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

..  _OEChem_OECreateSubSearchDatabaseFile:

.. oe:function:: OECreateSubSearchDatabaseFile

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECreateSubSearchDatabaseFile(const std::string& ofname,
                                            const std::string& ifname,
                                            const OESubSearchScreenTypeBase* stype,
                                            OESystem::OETracerBase& tracer = OESystem::OENoTracer)
         bool OECreateSubSearchDatabaseFile(const std::string& ofname,
                                            const std::string& ifname,
                                            const OECreateSubSearchDatabaseOptions& opts,
                                            OESystem::OETracerBase& tracer = OESystem::OENoTracer)

   .. oe:language:: python

      .. oe:api:: python

         OECreateSubSearchDatabaseFile(ofname: str, ifname: str,
                                       stype: OESubSearchScreenTypeBase,
                                       tracer: OETracerBase = OENoTracer) -> bool
         OECreateSubSearchDatabaseFile(ofname: str, ifname: str,
                                       opts: OECreateSubSearchDatabaseOptions,
                                       tracer: OETracerBase = OENoTracer) -> bool

   Generates substructure search database files for :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>`.
   :oe:func:`OEChem::OECreateSubSearchDatabaseFile` and returns ``true`` if the database
   is successfully created.

   ofname
     The name of the generated substructure search database file. The generated file
     will be an OpenEye binary file (:oe:const:`OEChem::OEFormat::OEB`); therefore, ``.oeb`` file
     extension is required in the given filename.

   ifname
     The name of the input molecule file.

   stype
     The type of the screen that will be pre-generated to each molecule.

   opts
     The :ref:`OECreateSubSearchDatabaseOptions <OEChem_OECreateSubSearchDatabaseOptions>` object that encapsulates
     properties that determine how the database is generated.

   tracer
     A tracer that can be used to report the progress of the database generation.

   .. figure:: oechemtk/images/FastSSGeneration.*
      :width: 350 pt
      :align: center

      **Schematic representation of substructure search database file generation process**

   The generated database file is an OpenEye binary file with a header that stores
   extra information about the database such as, screen type.
   Each substructure database file is associated with one and only one screen type.
   The molecules will be pre-processed for that specific type of substructure search.
   In order to minimize the memory footprints of the dataset at search time, all
   unessential data will be stripped from the molecules and explicit hydrogens will be
   suppressed.
   The search database will store only the following information for each molecule:

   * the molecular graph (no coordinates)
   * the molecule title (either user-defined or a unique identifier assigned during database generation)
   * the screen generated for the molecule

   The titles are kept in order to provide an external id for each molecule.
   See also :oe:meth:`OEChem::OECreateSubSearchDatabaseOptions::SetKeepTitle`.
   When searching the database, the titles of the matched molecules can be
   retrieved by the :oe:meth:`OEChem::OESubSearchDatabase::GetMatchTitles` method.

   .. note::

      If a sorted database is generated (see the
      :oe:meth:`OEChem::OECreateSubSearchDatabaseOptions::SetSortByBitCounts` method),
      a temporary file will be written into the disk prior to generating the final
      sorted database. This two-step process allows to generate database files that
      can not be fit into the memory with the size that is limited by the disk
      space.

   .. seealso::

      * :ref:`OECreateSubSearchDatabaseOptions <OEChem_OECreateSubSearchDatabaseOptions>` class
      * :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>` class
      * :ref:`OEConsoleProgressTracer <OESystem_OEConsoleProgressTracer>` class

   .. admonition:: Code Example

      * :ref:`section_example_oechem_makefastss` example


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDefaultImplicitHCount

.. oe:function:: OEDefaultImplicitHCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEDefaultImplicitHCount(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEDefaultImplicitHCount(atm: OEAtomBase) -> int

   Determines the default number of implicit hydrogens on an atom using
   **OpenEye's valence model**.  This count assumes that it is free to
   change the formal charge of an atom.

   .. note::

      If the charge state is correctly set on each atom, you should call the
      :oe:func:`OEChem::OEDefaultMDLHCount` function instead.

   .. seealso::

      * :ref:`section_valence_openeye` section
      * :oe:func:`OEChem::OEAssignImplicitHydrogens` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDefaultMDLHCount

.. oe:function:: OEDefaultMDLHCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEDefaultMDLHCount(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEDefaultMDLHCount(atm: OEAtomBase) -> int

   Determines the default number of implicit hydrogens on an atom using
   **MDL's valence model**.  This count assumes that the formal charge on an
   atom has been correctly set.  If the formal charge on each atom is not
   know *a priori*, the :oe:func:`OEChem::OEDefaultImplicitHCount`
   function may be more suitable.

   .. seealso::

      * :ref:`section_valence_mdl` section about MDL valence model
      * :oe:func:`OEChem::OEAssignMDLHydrogens` function
      * :oe:func:`OEChem::OEMDLGetValence` function
      * :oe:cls:`OEChem::OEIsValidMDLAtomValence` predicate 



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDeleteEverythingExceptTheFirstLargestComponent, DeleteEverythingExceptTheFirstLargestComponent

.. oe:function:: OEDeleteEverythingExceptTheFirstLargestComponent

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDeleteEverythingExceptTheFirstLargestComponent(OEMolBase & mol)

   .. oe:language:: python

      .. oe:api:: python

         OEDeleteEverythingExceptTheFirstLargestComponent(arg1: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Deletes all atoms that are not part of the largest connected component
   of a molecule. If two or more components of a molecule are the size
   of the largest component, this function keeps the first one
   encountered.
   Only heavy atoms are taken into consideration when determining the size
   of the components.
   The :oe:func:`OEChem::OEDeleteEverythingExceptTheFirstLargestComponent` function returns
   ``false`` if the given molecule has only one connected component,
   otherwise it returns ``true``.

.. note::

   The :oe:func:`OEChem::OEDeleteEverythingExceptTheFirstLargestComponent` function is
   identical to :oe:func:`OEChem::OETheFunctionFormerlyKnownAsStripSalts`.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`stripsalts.cpp<section_example_oechem_stripsalts>`

  .. oe:language:: python

      * Example program :ref:`stripsalts.py<section_example_oechem_stripsalts>`

  .. oe:language:: java

      * Example program :ref:`StripSalts.java<section_example_oechem_stripsalts>`

  .. oe:language:: csharp

      * Example program :ref:`StripSalts.cs<section_example_oechem_stripsalts>`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDeletePDBData

.. oe:function:: OEDeletePDBData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDeletePDBData(OEMolBase& mol, const std::string& tag)

   .. oe:language:: python

      .. oe:api:: python

         OEDeletePDBData(mol: Union[OEGraphMol,OEMol,OEQMol], tag: str) -> bool

   Delete all PDB data items with the specified tag.

   .. seealso::

      * :oe:func:`OEChem::OEClearPDBData` function to remove all PDB data
      * :ref:`section_moltaggeddata_PDB` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDeleteSDData

.. oe:function:: OEDeleteSDData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDeleteSDData(OEMolBase& mol, const std::string& tag)

   .. oe:language:: python

      .. oe:api:: python

         OEDeleteSDData(mol: Union[OEGraphMol,OEMol,OEQMol], tag: str) -> bool

   Delete all SD data items with the specified tag.

   .. seealso::

      * :oe:func:`OEChem::OEClearSDData` to remove all SD data.
      * :ref:`section_moltaggeddata_SD` section

   .. admonition:: Code Example

      * :ref:`section_example_oechem_sdfmodprops`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEDetectMonomers

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDetectMonomers(OEMolBase& mol, const OEMonomerSet& monomers)
         bool OEDetectMonomers(OEMolBase& mol, const OEMonomerSet& monomers,
                               const std::string& codeSet)

   .. oe:language:: python

      .. oe:api:: python

         OEDetectMonomers(mol: Union[OEGraphMol,OEMol,OEQMol],
                          monomers: OEMonomerSet) -> bool
         OEDetectMonomers(mol: Union[OEGraphMol,OEMol,OEQMol],
                          monomers: OEMonomerSet, codeSet: str) -> bool

   Detects the monomers defined in the specified monomer set in the given molecule.
   The function returns true if all atoms in the molecule are part of the defined monomers
   and false otherwise.

   mol
    The molecule (:oe:cls:`OEChem::OEMolBase`) to be searched for monomers.

   monomers
    The monomer set (:oe:cls:`OEChem::OEMonomerSet`) that stores the monomers that
    are being detected.

   code-set
    The code set to use for detecting monomers, if not specified the primary code-set of the
    monomer set will be used.

   The detected monomers are stored on the molecule as groups (:oe:cls:`OEChem::OEGroupBase`).

   **Example**

   .. oe:source:: DetectMonomers.py
      :language: python
      :noindent:
      :frag:     SNIPPET

   .. oe:source:: DetectMonomers.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET

   .. seealso::

      * :oe:cls:`OEChem::OEMonomerSet` class
      * :oe:func:`OEChem::OEMolToHelm` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDetermineAromaticRingSystems

.. oe:function:: OEDetermineAromaticRingSystems

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEDetermineAromaticRingSystems(const OEMolBase& mol,
                                                     unsigned int* rings)

   .. oe:language:: python

      .. oe:api:: python

         OEDetermineAromaticRingSystems(mol: Union[OEGraphMol,OEMol,OEQMol]) -> Tuple[int, List[int]]

   Determines the aromatic ring systems of a molecule.  The return
   value is the number of aromatic ring systems found in the molecule.
   If the molecule is acyclic or there is no aromatic ring system in
   the molecule, the return value is zero.  The 'rings' array must
   contain at least :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx`
   elements, and upon return it contains a mapping indexed by
   :oe:meth:`OEChem::OEAtomBase::GetIdx` of which aromatic ring system
   each atom is in.  The aromatic ring systems are numbered from one,
   up to an including the return value of the function.  Atoms that
   aren't contained in an aromatic ring, *i.e.* for which
   :oe:meth:`OEChem::OEAtomBase::IsInRing` or
   :oe:meth:`OEChem::OEAtomBase::IsAromatic` returns ``false``, are
   mapped to the value zero.

   .. warning::

      It is necessary to call :oe:func:`OEChem::OEFindRingAtomsAndBonds` and
      :oe:func:`OEChem::OEAssignAromaticFlags` functions prior to calling
      :oe:func:`OEChem::OEDetermineAromaticRingSystems` function.

   .. seealso::

      * :ref:`section_ring_system_identification` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDetermineComponents

..  _oechem_oedeterminecomponents:

.. oe:function:: OEDetermineComponents

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEDetermineComponents(const OEMolBase& mol,
                                            unsigned int* parts)

   .. oe:language:: python

      .. oe:api:: python

         OEDetermineComponents(mol: Union[OEGraphMol,OEMol,OEQMol]) -> Tuple[int, List[int]]

   Determines the connected components of a molecule.  The
   return value is the number of connected components found in the
   molecule.  If the molecule contains a single discrete molecule, the
   return value is one.  The 'parts' array must contain at least
   :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx` elements, and upon return
   it contains a mapping indexed by :oe:meth:`OEChem::OEAtomBase::GetIdx`
   of which part or connected component each atom is in.  The parts are
   numbered from one, up to and including the return value of the
   function.

   .. seealso::

      .. oe:language:: c++

         * :ref:`section_ring_system_components` section
         * Example program :ref:`parts2mols.cpp<section_example_oechem_parts2mols>`

      .. oe:language:: python

         * :ref:`section_ring_system_components` section
         * Example program :ref:`parts2mols.py<section_example_oechem_parts2mols>`

      .. oe:language:: java

         * :ref:`section_ring_system_components` section
         * Example program :ref:`Parts2Mols.java<section_example_oechem_parts2mols>`

      .. oe:language:: csharp

         * :ref:`section_ring_system_components` section
         * Example program :ref:`Parts2Mols.cs<section_example_oechem_parts2mols>`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDetermineConnectivity

.. oe:function:: OEDetermineConnectivity

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDetermineConnectivity(OEMolBase& mol, bool same_altloc = true)

   .. oe:language:: python

      .. oe:api:: python

         OEDetermineConnectivity(mol: Union[OEGraphMol,OEMol,OEQMol],
                                 same_altloc: bool = True) -> None

   Perceives the covalent bonds of a molecule from 3D coordinates.  This
   routine creates a bond between any pair of atoms that are closer than
   the sum of their covalent radii plus a slop factor of ``0.45``
   Angstroms.  The covalent radii of each atom are as defined by the
   Cambridge Crystallographic Database (http://www.ccdc.cam.ac.uk), and are those returned by the
   **OEChem TK** function :oe:func:`OEChem::OEGetCovalentRadius`.  Bonds are not
   created by atoms separated by less than ``0.4`` |A|.  All bonds are
   created with bond order ``1``.  The **OEChem TK** function
   :oe:func:`OEChem::OEPerceiveBondOrders` may be used to assign bond
   orders from the 3D geometry and connectivity.

   .. seealso::

      * :ref:`chapter_connectivity` chapter and :ref:`section_connectivity_bond_order_perception` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDetermineReactants

.. oe:function:: OEDetermineReactants

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEDetermineReactants(const OEMolBase& mol,
                                           unsigned int* parts)

   .. oe:language:: python

      .. oe:api:: python

         OEDetermineReactants(mol: Union[OEGraphMol,OEMol,OEQMol], parts: int) -> int



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDetermineRingSystems

.. oe:function:: OEDetermineRingSystems

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEDetermineRingSystems(const OEMolBase& mol,
                                             unsigned int* rings)

   .. oe:language:: python

      .. oe:api:: python

         OEDetermineRingSystems(mol: Union[OEGraphMol,OEMol,OEQMol]) -> Tuple[int, List[int]]

   .. oe:language:: python

      .. oe:api::

         OEDetermineRingSystems(const OEMolBase mol) -> number_of_rings, ring_idx_per_atom

   Determines the ring systems of a molecule.  The return
   value is the number of ring systems found in the molecule.  If
   the molecule is acyclic, the return value is zero.  The 'rings' array
   must contain at least :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx`
   elements, and upon return it contains a mapping indexed by
   :oe:meth:`OEChem::OEAtomBase::GetIdx` of which ring system each atom is
   in.  The ring systems are numbered from one, up to an including the
   return value of the function.  Atoms that aren't contained in a ring,
   *i.e.* for which :oe:meth:`OEChem::OEAtomBase::IsInRing` returns
   ``false``, are mapped to the value zero.

   .. oe:language:: python

      In Python, OEDetermineRingSystems returns a two item tuple. The
      first item in the tuple is the number of independent ring
      systems found. The second item in the tuple is a list of the
      atom ring membership as described as the 'rings' parameter
      above.

   .. warning::

      It is necessary to perform ring perception by calling
      :oe:func:`OEChem::OEFindRingAtomsAndBonds` function prior to calling
      :oe:func:`OEChem::OEDetermineRingSystems` function.

   .. seealso::

      * :ref:`section_ring_system_identification` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDisassembleExpressions

.. oe:function:: OEDisassembleExpressions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDisassembleExpressions(OEQMolBase &)

   .. oe:language:: python

      .. oe:api:: python

         OEDisassembleExpressions(arg1: OEQMol) -> bool

   .. warning::

      This function is deprecated.  The activities
      performed by this function will be internalized in a future release.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDoubleBondCount

.. oe:function:: OEDoubleBondCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEDoubleBondCount(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEDoubleBondCount(atm: OEAtomBase) -> int

   Returns the number of double bonds connected to an atom.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEDoubleBondOCount

.. oe:function:: OEDoubleBondOCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEDoubleBondOCount(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEDoubleBondOCount(atm: OEAtomBase) -> int



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEElementHistogram

.. oe:function:: OEElementHistogram

   .. oe:language:: c++

      .. oe:api::

         int OEElementHistogram(unsigned int* hist, const OEMolBase& mol)



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEEulerRotate

.. oe:function:: OEEulerRotate

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEEulerRotate(OEMolBase& mol, const double* angles)
         void OEEulerRotate(OEConfBase& conf, const double* angles)
         void OEEulerRotate(OEMCMolBase& mcmol, const double* angles)

   .. oe:language:: python

      .. oe:api:: python

         OEEulerRotate(mol: Union[OEGraphMol,OEQMol], angles: OEDoubleArray) -> None
         OEEulerRotate(conf: OEConfBase, angles: OEDoubleArray) -> None
         OEEulerRotate(mcmol: OEMol, angles: OEDoubleArray) -> None

   Rotates the molecules about the z, x', and z' axes in order.  It
   is assumed that the angles array is at least of length 3.  The angles
   array should contain the z rotation in radians in ``angles[0]``, the
   x' rotation in radians in ``angles[1]``, and the z' rotation in
   radians in ``angles[2]``.  The overloads for
   :ref:`OEConfBase <OEChem_OEConfBase>` and :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` are
   for efficiency.

   *mol*
      The molecule to rotate.

   *conf*
      The conformer to rotate.

   *mcmol*
      The multi-conformer molecule to rotate.

   *angle*
      The rotation angle.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEExactGraphMatch

.. oe:function:: OEExactGraphMatch

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEExactGraphMatch(const OEMolBase& mol1, const OEMolBase& mol2)

   .. oe:language:: python

      .. oe:api:: python

         OEExactGraphMatch(mol1: Union[OEGraphMol,OEMol,OEQMol],
                           mol2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Determines whether two molecules, 'mol1' and 'mol2', have exactly the
   same graph.  This function effectively compares the :term:`canonical
   SMILES` of both molecules (created by
   :oe:func:`OEChem::OECreateCanSmiString`) using string equality.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEExpandSuperAtoms

.. oe:function:: OEExpandSuperAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEExpandSuperAtoms(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEExpandSuperAtoms(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Expands (or instantiates) the recognized super-atoms in a connection
   table.  Superatoms are commonly found in MDL mol files and some SMILES
   variants as a way of specifying a common functional group by a single
   superatom.  This function replaces each pseudo atom with the set of
   atoms and bonds it represents.

   Currently this function expands the 20 naturally occurring amino acids
   and 'Abu' (2-amino butyric acid).  Additional superatoms, such as
   common protecting groups, may be supported in the future.
   Unrecognized superatoms are unmodified by this function.

   This function determines connectivity for multi-valent superatoms from
   2D coordinates when available, and failing that from atom indices,
   *i.e.* the order in which atoms are created.  These heuristics allow
   correct interpretation of most common uses of superatoms, such as the
   SMILES variant ``[Ala][Asn][Thr]``.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEExtractRingTemplates

.. oe:function:: OEExtractRingTemplates

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEMolBase> * OEExtractRingTemplates(const OEMolBase& mol)
         OESystem::OEIterBase<OEMolBase> * OEExtractRingTemplates(const OEMolBase& mol,
                                                                  const OEExtractRingTemplateOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEExtractRingTemplates(mol: Union[OEGraphMol,OEMol,OEQMol]) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]
         OEExtractRingTemplates(mol: Union[OEGraphMol,OEMol,OEQMol],
                                opts: OEExtractRingTemplateOptions) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

   Returns an iterator over the anonymized ring systems of the given molecule.

   .. note::

      The :oe:func:`OEChem::OEExtractRingTemplates` function is used to extract
      potential new ring templates for the 2D coordinate generation system
      and it requires an input molecule with 2D coordinates.

      We recommend using the :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class for generating a
      ring template dictionary.

   .. seealso::

      .. oe:language:: c++

         * :ref:`OEExtractRingTemplateOptions <OEChem_OEExtractRingTemplateOptions>` class
         * Example program :ref:`extractringtemplates.cpp<section_example_oechem_extractringtemplates>`

      .. oe:language:: python

         * :ref:`OEExtractRingTemplateOptions <OEChem_OEExtractRingTemplateOptions>` class
         * Example program :ref:`extractringtemplates.py<section_example_oechem_extractringtemplates>`

      .. oe:language:: java

         * :ref:`OEExtractRingTemplateOptions <OEChem_OEExtractRingTemplateOptions>` class
         * Example program :ref:`ExtractRingTemplates.java<section_example_oechem_extractringtemplates>`

      .. oe:language:: csharp

         * :ref:`OEExtractRingTemplateOptions <OEChem_OEExtractRingTemplateOptions>` class
         * Example program :ref:`ExtractRingTemplates.cs<section_example_oechem_extractringtemplates>`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEFastaToMol

.. oe:function:: OEFastaToMol

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEFastaToMol(OEMolBase& mol, const std::string& str)

   .. oe:language:: python

      .. oe:api:: python

         OEFastaToMol(mol: Union[OEGraphMol,OEMol,OEQMol], str: str) -> bool

   Converts a FASTA sequence into a molecule.

   The following code demonstrates how to create a molecule from a
   FASTA sequence using the :oe:func:`OEChem::OEFastaToMol` function
   and prints out the number of alpha carbon atoms in the molecule.

   .. oe:source:: FastaToMol.cpp
      :language: c++
      :frag:     SNIPPET

   .. oe:source:: FastaToMol.py
      :language: python
      :frag:     SNIPPET

   .. oe:source:: FastaToMol.java
      :language: java
      :frag:     SNIPPET

   .. oe:source:: FastaToMol.cs
      :language: csharp
      :frag:     SNIPPET

   .. seealso::

      * :oe:func:`OEChem::OEReadFASTAFile` function



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEFindRingAtomsAndBonds

..  _OEFindRingAtomsAndBonds:

.. oe:function:: OEFindRingAtomsAndBonds

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEFindRingAtomsAndBonds(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEFindRingAtomsAndBonds(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Determines which atoms and bonds of a molecule are contained in rings,
   and set their 'in ring' property appropriately via
   :oe:meth:`OEChem::OEAtomBase::SetInRing` and
   :oe:meth:`OEChem::OEBondBase::SetInRing` methods, respectively.

   .. seealso::

      * :ref:`chapter_ring` chapter
      * :ref:`chapter_connectivity` chapter and :ref:`section_connectivity_bond_order_perception` section

      .. oe:language:: c++

         * Example program :ref:`cansmi.cpp<section_example_oechem_cansmi>`

      .. oe:language:: python

         * Example program :ref:`cansmi.py<section_example_oechem_cansmi>`

      .. oe:language:: java

         * Example program :ref:`CanSmi.java<section_example_oechem_cansmi>`

      .. oe:language:: csharp

         * Example program :ref:`CanSmi.cs<section_example_oechem_cansmi>`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEFormalPartialCharges

.. oe:function:: OEFormalPartialCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEFormalPartialCharges(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEFormalPartialCharges(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Set the partial charge property of each atom in a molecule to its
   formal charge.  This is equivalent of calling the
   :oe:meth:`OEChem::OEAtomBase::SetPartialCharge` method on every atom
   with the value returned from
   :oe:meth:`OEChem::OEAtomBase::GetFormalCharge`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGasteigerInitialCharges

.. oe:function:: OEGasteigerInitialCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGasteigerInitialCharges(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGasteigerInitialCharges(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Calculates the seed charge partial charges used by the
   Marsilli-Gasteiger partial charge algorithm.

   Gasteiger initial charges assign the partial charge of ``-0.5`` to
   atoms of type :oe:const:`OEChem::OETriposType::Oco2`, *i.e.*
   carboxylate oxygens, and use the formal charge as the partial charge
   on all other atoms except those in conjugated rings.  For conjugated
   ring systems, consisting of Tripos atom types
   :oe:const:`OEChem::OETriposType::C2`,
   :oe:const:`OEChem::OETriposType::Car`,
   :oe:const:`OEChem::OETriposType::N2`,
   :oe:const:`OEChem::OETriposType::Nar`,
   :oe:const:`OEChem::OETriposType::Npl3` and
   :oe:const:`OEChem::OETriposType::Nam`, the sum of the formal charges of
   the atoms in the ring system are divided equally amongst all atoms in
   the ring system.  For example, the five heavy atoms in imidazolium
   (``[nH+]1c[nH]cc1``), each get a partial charge of ``0.2``. O

   .. warning::

      It is not necessary to call :oe:func:`OEChem::OEGasteigerInitialCharges`
      function prior to calling :oe:func:`OEChem::OEGasteigerPartialCharges`
      function.

   .. seealso::

      * :ref:`section_charges_Gasteiger` section
      * :oe:func:`OEChem::OETriposAtomTypes` to determine Tripos atom types



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGasteigerPartialCharges

.. oe:function:: OEGasteigerPartialCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGasteigerPartialCharges(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGasteigerPartialCharges(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Calculate Marsilli-Gasteiger partial charges for a molecule.  The
   results of the calculation are placed in the partial charge property
   of each atom using :oe:meth:`OEChem::OEAtomBase::SetPartialCharge`.

   .. seealso::

      * :oe:func:`OEChem::OEGasteigerInitialCharges`
      * :ref:`section_charges_Gasteiger` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGenerate2DCoordinates

.. oe:function:: OEGenerate2DCoordinates

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGenerate2DCoordinates(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGenerate2DCoordinates(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Assigns 2D coordinates to the given :ref:`OEMolBase <OEChem_OEMolBase>`
   object.
   The coordinates of each explicit atom are assigned using the
   :oe:meth:`OEChem::OEMolBase::SetCoords` method.
   This function automatically set the dimensionality of the molecule
   to two, using the :oe:meth:`OEChem::OEMolBase::SetDimension` method.

   .. note::

      :oe:func:`OEChem::OEGenerate2DCoordinates` is a low-level function
      that only generates 2D coordinates but does not perform any other
      perceptions.

      :oe:func:`OEChem::OEGenerate2DCoordinates` will clear MDL bond stereo
      information that can be re-perceived by calling the
      :oe:func:`OEChem::OEMDLPerceiveBondStereo` function.

   If :oe:func:`OEChem::OEGenerate2DCoordinates` fails to generate
   2D coordinates that correspond to the atom and bond stereo information
   of the molecule it returns ``false``.
   This problem occurs when no **built-in** ring template exists for a
   specific stereo configuration. To avoid this issue specifying user-defined
   ring template might be necessary.
   For more information see the :ref:`chapter_2D_coordinates` chapter.

   .. seealso::

      :oe:func:`OEChem::OEInit2DRingDictionary` function

.. ################################################################
   #
   ################################################################



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetAbsTorsion

.. oe:function:: OEGetAbsTorsion

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetAbsTorsion(const OEMolBase& mol, const OEAtomBase* a,
                                const OEAtomBase* b, const OEAtomBase* c,
                                const OEAtomBase* d)
         double OEGetAbsTorsion(const OEConfBase& conf, const OEAtomBase* a,
                                const OEAtomBase* b, const OEAtomBase* c,
                                const OEAtomBase* d)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAbsTorsion(arg1: Union[OEGraphMol,OEMol,OEQMol], a: OEAtomBase,
                         b: OEAtomBase, c: OEAtomBase, d: OEAtomBase) -> float
         OEGetAbsTorsion(arg1: OEConfBase, a: OEAtomBase, b: OEAtomBase,
                         c: OEAtomBase, d: OEAtomBase) -> float

   Returns the absolute value of the torsion defined by atoms `a`, `b`,
   `c`, and `d`.  The return value is in radians and varies from ``0`` to
   ``+PI``.  This function returns the same value as
   fabs( :oe:func:`OEChem::OEGetTorsion` ), yet it is more efficient.  These
   functions assume that the four atoms are members of the molecule or
   conformer which is passed to the function.  The
   :ref:`OEConfBase <OEChem_OEConfBase>` overload is strictly for efficiency.

   *mol*
      The molecule that the pair of atom belongs to.

   *conf*
      The conformer that the pair of atom belongs to.

    *a*
      One of the end atoms in the torsion.

    *b*
      Atom that is connected to `a` in the torsion.

    *c*
      Atom that is connected to `d` in the torsion.

    *d*
      The other end atom in the torsion.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetAminoAcidCode

.. oe:function:: OEGetAminoAcidCode

   .. oe:language:: c++ java csharp

      .. oe:api::

         char OEGetAminoAcidCode(unsigned int idx)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAminoAcidCode(idx: int) -> str

   Returns the single character amino acid code corresponding to the
   specified residue (using the :oe:constns:`OEChem::OEResidueIndex`
   namespace format). The character ``X`` is returned for the residue
   :oe:const:`OEChem::OEResidueIndex::UNK` and the NULL character (0) is
   returned for all other non-amino acid residues.

   .. seealso::

      * :oe:func:`OEChem::OEGetResidueIndexFromCode` inverse function
      * :oe:constns:`OEChem::OEResidueIndex` namespace


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEGetAminoAcidType

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetAminoAcidType(const OEMolBase& monomer_mol)
         unsigned int OEGetAminoAcidType(const std::string& monomerSmiles)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAminoAcidType(monomer_mol: Union[OEGraphMol,OEMol,OEQMol]) -> int
         OEGetAminoAcidType(monomerSmiles: str) -> int

   Determines the amino acid type of the monomer defined by its molecule or smiles 
   representation.

   .. seealso::

      * :oe:constns:`OEChem::OEAminoAcidType` namespace


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetAngle

.. oe:function:: OEGetAngle

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetAngle(const OEMolBase& mol, const OEAtomBase* a,
                           const OEAtomBase* b, const OEAtomBase* c)
         double OEGetAngle(const OEConfBase& conf, const OEAtomBase* a,
                           const OEAtomBase* b, const OEAtomBase* c)
         double OEGetAngle(const OEMolBase& ma, const OEAtomBase* a,
                           const OEMolBase& mb, const OEAtomBase* b,
                           const OEMolBase& mc, const OEAtomBase* c)
         double OEGetAngle(const OEConfBase& ca, const OEAtomBase* a,
                           const OEConfBase& cb, const OEAtomBase* b,
                           const OEConfBase& cc, const OEAtomBase* c)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAngle(arg1: Union[OEGraphMol,OEMol,OEQMol], a: OEAtomBase,
                    b: OEAtomBase, c: OEAtomBase) -> float
         OEGetAngle(conf: OEConfBase, a: OEAtomBase, b: OEAtomBase,
                    c: OEAtomBase) -> float
         OEGetAngle(ma: Union[OEGraphMol,OEMol,OEQMol], a: OEAtomBase,
                    mb: Union[OEGraphMol,OEMol,OEQMol], b: OEAtomBase,
                    mc: Union[OEGraphMol,OEMol,OEQMol], c: OEAtomBase) -> float
         OEGetAngle(ca: OEConfBase, a: OEAtomBase, cb: OEConfBase,
                    b: OEAtomBase, cc: OEConfBase, c: OEAtomBase) -> float

   Returns the angle formed by three atoms where the atom passed in as
   the `b` argument is the vertex.  The function which takes a single
   :ref:`OEMolBase <OEChem_OEMolBase>` argument assumes that all three atoms are
   contained in the single molecule.  The :ref:`OEConfBase <OEChem_OEConfBase>`
   overload functions are not strictly necessary, but are useful for
   efficiency.

   *mol*
      The molecule that the atoms belong to (when all atoms belong to the same molecule).

   *conf*
      The conformer that the atoms belong to (when all atoms belong to the same conformer).

   *a*
      One of the end atoms.

   *b*
      The vertex atom.

   *c*
      One of the end atoms.

   *ma*
      The molecule that atom `a` belongs to (when the atoms are in three different molecule).

   *mb*
      The molecule that atom `b` belongs to (when the atoms are in three different molecule).

   *mc*
      The molecule that atom `c` belongs to (when the atoms are in three different molecule).

   *ca*
      The conformer that atom `a` belongs to (when the atoms are in three different conformer).

   *cb*
      The conformer that atom `b` belongs to (when the atoms are in three different conformer).

   *cc*
      The conformer that atom `c` belongs to (when the atoms are in three different conformer).



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetAnisou

.. oe:function:: OEGetAnisou

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGetAnisou(OEAnisoUij& uij, const OEAtomBase* atom)
         bool OEGetAnisou(const OEAtomBase* atom, int& u11, int& u22, int& u33,
                          int& u12, int& u13, int& u23)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAnisou(uij: OEAnisoUij, atom: OEAtomBase) -> bool
         OEGetAnisou(atom: OEAtomBase, u11: int, u22: int, u33: int, u12: int,
                     u13: int, u23: int) -> bool

   This function is used to return anisotropic B-factor parameters associated
   with an :ref:`OEAtomBase <OEChem_OEAtomBase>` from a PDB file read with the flavor
   :oe:const:`OEChem::OEIFlavor::PDB::DATA`.

   If the atom does not have associated anisotropic B-factor parameters,
   returns ``false`` and sets all the parameter values to 0. The predicate
   :ref:`OEHasAnisou <OEChem_OEHasAnisou>` can be used to check for parameters.

   The form that uses a :ref:`OEAnisoUij <OEChem_OEAnisoUij>` returns the data in
   packaged form for convenience in wrapped languages.

   .. seealso::

      * :ref:`OEAnisoUij <OEChem_OEAnisoUij>`
      * :ref:`OEHasAnisou <OEChem_OEHasAnisou>`
      * :oe:func:`OEChem::OESetAnisou`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetAtomColor

.. oe:function:: OEGetAtomColor

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEColor OEGetAtomColor(const OEChem::OEAtomBase& atom)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAtomColor(atom: OEAtomBase) -> OEColor

   Returns the OEColor stored in the :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` of the molecule 
   asscoiated with the atom specified.

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetAtomComment

.. oe:function:: OEGetAtomComment

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetAtomComment(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAtomComment(atm: OEAtomBase) -> str

   Used to retrieve the text comment associated with an individual atom.
   This field is used to manipulate the atom alias information in MDL
   file formats.  This property may be set using the
   :oe:func:`OEChem::OESetAtomComment` function.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetAtomLabelColor

.. oe:function:: OEGetAtomLabelColor

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEColor OEGetAtomLabelColor(const OEChem::OEAtomBase& atom)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAtomLabelColor(atom: OEAtomBase) -> OEColor

   Returns the OEColor stored in the :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` for the atom label of the 
   atom specified.
    

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetAtomLabelText

.. oe:function:: OEGetAtomLabelText

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetAtomLabelText(const OEChem::OEAtomBase& atom)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAtomLabelText(atom: OEAtomBase) -> str

   Returns a string of the label associated with specified atom. 
    

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetAtomicNum

.. oe:function:: OEGetAtomicNum

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetAtomicNum(const char* sym)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAtomicNum(sym: str) -> int

   Returns the atomic number associated with the specified atomic symbol.
   The specified buffer ``sym`` must contain a string terminated by either
   a space or a NULL, ``\0``, character.  Zero-length strings, strings
   longer than two characters or unrecognized symbols all make the function
   return ``0``.  The comparison is case insensitive, such that the first
   character need not be uppercase, and the second character (if one
   exists) need not be lowercase.

   This function returns the value ``1`` for symbols 'H', 'D' and 'T'.

   .. oe:api: # IGNORE  (privatized)

      OEFuzzy OEGetAtomicNum(const OEExprBase *, unsigned int &anum)


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetAtomicSymbol

.. oe:function:: OEGetAtomicSymbol

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetAtomicSymbol(unsigned int elemno)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAtomicSymbol(elemno: int) -> str

   Returns the atomic symbol associated with the specified atomic number.
   This function returns a valid pointer to a NUL-character, ``\0``, if
   ``elemno`` is neither greater than zero nor less than the symbolic constant
   :oe:const:`OEChem::OEElemNo::MAXELEM`.  Otherwise, all returned values
   are NUL-terminated, with the first character uppercase, and the second
   character either a NUL or lowercase (in which case the third character is
   always the NUL-terminator).


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetAutomorphs

.. oe:function:: OEGetAutomorphs

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEMatchBase>* OEGetAutomorphs(const OEMolBase& mol,
                                                            bool includeH = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAutomorphs(arg1: Union[OEGraphMol,OEMol,OEQMol],
                         includeH: bool = False) -> Iterable[OEMatchBase]

   Returns an iterator over all the automorphisms, i.e. self matches of the 
   molecule.

   *includeH*
      This flag indicates whether explicit hydrogen atoms should be considered 
      when assessing automorphisms. Default is ``false``.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetAverageWeight

.. oe:function:: OEGetAverageWeight

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetAverageWeight(unsigned int elemno)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAverageWeight(elemno: int) -> float

   Returns the average atomic weight of an element, based upon the
   naturally occurring abundances of its isotopes.  To return the
   'monoisotopic' weight for a particular element use the
   :oe:func:`OEChem::OEGetIsotopicWeight` function like the following.

   .. oe:source:: UsingPeriodicTableFunctions.cpp
      :language: c++
      :frag:     SNIPPET-PERIODIC-MONOISO-WEIGHT

   .. oe:source:: UsingPeriodicTableFunctions.py
      :language: python
      :frag:     SNIPPET-PERIODIC-MONOISO-WEIGHT

   .. oe:source:: UsingPeriodicTableFunctions.java
      :language: java
      :frag:     SNIPPET-PERIODIC-MONOISO-WEIGHT

   .. oe:source:: UsingPeriodicTableFunctions.cs
      :language: csharp
      :frag:     SNIPPET-PERIODIC-MONOISO-WEIGHT


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetBondiVdWRadius

.. oe:function:: OEGetBondiVdWRadius

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetBondiVdWRadius(unsigned int elemno)

   .. oe:language:: python

      .. oe:api:: python

         OEGetBondiVdWRadius(elemno: int) -> float

   Returns the Van der Waals radius for a particular atomic number as
   tabulated by Bondi [Bondi-1964]_.
   There are several experimental values for Van der Waals radii (see also
   :oe:func:`OEChem::OEGetPaulingVdWRadius`) and many additional:
   values used in molecular mechanics forcefields (including united-atom VdW radii),
   so there is often no definitive notion of Van der Waals radius.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetCenterAndExtents

.. oe:function:: OEGetCenterAndExtents

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEGetCenterAndExtents(const OEMolBase& mol, float* ctr,
                                    float* ext)
         Determines the bounding box that can encompass the molecule. The length of
         each side of the box is output in the 3-element array extents. The geometric
         center of the box is output to the center parameter.
         *mol*The molecule to calculate center and extents.
         *ctr*The output box center vector.  The vector must have a defined size of at least three.
         *ext*The output box lengths vector.  The vector must have a defined size of at least three.

   .. oe:language:: python

      .. oe:api:: python

         OEGetCenterAndExtents(mol: Union[OEGraphMol,OEMol,OEQMol],
                               center: OEFloatArray, extents: OEFloatArray) -> None

.. note::

   The center of the box is different from the center-of-mass of the molecule.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetCenterOfMass

.. oe:function:: OEGetCenterOfMass

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEGetCenterOfMass(const OEMolBase& mol, float* com,
                                bool weightAtoms = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCenterOfMass(mol: Union[OEGraphMol,OEMol,OEQMol],
                           com: OEFloatArray, weightAtoms: bool = False) -> None

   Calculates the center-of-mass of the molecule. The ``weightAtoms`` can be
   specified to weight each of the atom coordinates with the corresponding atom weights.

   *mol*
       The molecule to calculate center-of-mass.

    *com*
       The output center-of-mass array.  The array must have a defined size of at least three.

    *weightAtoms*
       Flag indicating if the atom weights should be used to weight the coordinates during calculation.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetColorSchemeName

.. oe:function:: OEGetColorSchemeName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetColorSchemeName(unsigned int colorScheme)

   .. oe:language:: python

      .. oe:api:: python

         OEGetColorSchemeName(colorScheme: int) -> str

   Returns the color scheme name as a const char. The function is called 
   in the :oe:meth:`OEChem::OEMolStyleColorer::GetPropertyName` function of :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>`. It can be used 
   in tandem with the :oe:meth:`OEChem::OE3DMolStyle::GetAtomColorer` function of :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`.

   example: std::string str = style.GetAtomColorer().GetPropertyName();


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetComment

.. oe:function:: OEGetComment

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetComment(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetComment(mol: Union[OEGraphMol,OEMol,OEQMol]) -> str

   Returns a pointer to the text comment attached to a molecule.  These
   comments are written to the comment field of .sdf and .mol2 formats
   and are also stored in OEBinary format.  This property may be set
   using the :oe:func:`OEChem::OESetComment` function.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetCovalentRadius

.. oe:function:: OEGetCovalentRadius

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetCovalentRadius(unsigned int elemno)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCovalentRadius(elemno: int) -> float

   Returns the covalent radius of the element specified by the given atomic number.
   The covalent radius of an atom is typically used in bonding calculations, such as the
   function :oe:func:`OEDetermineConnectivity<OEChem::OEDetermineConnectivity>`.
   A value of zero is returned for elements other than those commonly found
   in organic molecules.  The actual values are those prescribed by the
   Cambridge Crystallographic Database (http://www.ccdc.cam.ac.uk).



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetDefaultIFlavor

.. oe:function:: OEGetDefaultIFlavor

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetDefaultIFlavor(unsigned int format)

   .. oe:language:: python

      .. oe:api:: python

         OEGetDefaultIFlavor(format: int) -> int

   Returns the default input file flavor associated with the given file format.
   The set of valid file formats are defined in the :oe:constns:`OEChem::OEFormat`
   namespace.
   The default flavors are automatically set by the
   :ref:`oemolistream <OEChem_oemolistream>` constructors. The flavor for any
   format can be set using the :oe:meth:`OEChem::oemolstreambase::SetFlavor`
   method.

   .. seealso::

      * :oe:func:`OEChem::OESetDefaultFlavors` function.
      * :oe:func:`OEChem::OESetDefaultIFlavors` function.
      * :oe:constns:`OEChem::OEIFlavor` and :ref:`the OEFormat namespace <OEChem_OEFormat>`.
      * :oe:meth:`OEChem::oemolstreambase::SetFlavor` and :oe:meth:`OEChem::oemolstreambase::GetFlavor` methods.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetDefaultMass

.. oe:function:: OEGetDefaultMass

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetDefaultMass(unsigned int elemno)

   .. oe:language:: python

      .. oe:api:: python

         OEGetDefaultMass(elemno: int) -> int

   Returns the most abundant isotope for the given atomic number *i.e.* the same
   values as required by the MDL file format.
   In MDL SD files, non-natural isotopes are represented as a delta from
   the most commonly occurring isotope for a particular element/atomic number.

   For example, for :oe:const:`OEChem::OEElemNo::C` this function returns the
   value 12.
   For input value of zero and for values greater than or equal to
   :oe:const:`OEChem::OEElemNo::MAXELEM`, it returns zero.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetDefaultOFlavor

.. oe:function:: OEGetDefaultOFlavor

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetDefaultOFlavor(unsigned int format)

   .. oe:language:: python

      .. oe:api:: python

         OEGetDefaultOFlavor(format: int) -> int

   Returns the default output file flavor associated with the given file format.
   The set of valid file formats are defined in the :oe:constns:`OEChem::OEFormat`
   namespace.
   The default flavors are automatically set by the
   :ref:`oemolostream <OEChem_oemolostream>` constructors. The flavor for any
   format can be set using the :oe:meth:`OEChem::oemolstreambase::SetFlavor`
   method.

   .. seealso::

      * :oe:func:`OEChem::OESetDefaultFlavors` function
      * :oe:func:`OEChem::OESetDefaultOFlavors` function
      * :oe:constns:`OEChem::OEOFlavor` and :ref:`the OEFormat namespace <OEChem_OEFormat>`
      * :oe:meth:`OEChem::oemolstreambase::SetFlavor` and :oe:meth:`OEChem::oemolstreambase::GetFlavor` methods


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetDelphiRadius

.. oe:function:: OEGetDelphiRadius

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetDelphiRadius(unsigned int elemno)

   .. oe:language:: python

      .. oe:api:: python

         OEGetDelphiRadius(elemno: int) -> float

   Returns the default radius for a given element used by the Accelrys'
   Delphi program for electrostatics calculations.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetDimensionFromCoords

.. oe:function:: OEGetDimensionFromCoords

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetDimensionFromCoords(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetDimensionFromCoords(arg1: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Returns the molecule's dimension from the coordinates.
   The returned value is  ``0``, ``1``, ``2`` or ``3``
   depending upon the number of coordinates for which any atom has a
   non-zero value.

   The table below illustrates the difference between the
   :oe:func:`OEChem::OEGetDimensionFromCoords` and
   :oe:func:`OEChem::OEGetMDLDimensionFromCoords` functions.

   +--------------------------+--------------------------+------------------------------+
   | Coordinates              | OEGetDimensionFromCoords | OEGetMDLDimensionFromCoords  |
   +--------+--------+--------+                          +                              +
   |  X     |  Y     |  Z     |                          |                              |
   +========+========+========+==========================+==============================+
   |  0.00  |  0.00  |  0.00  |  0D                      |  0D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  0.00  |  0.00  |  1D                      |  2D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  0.00  |  1.00  |  0.00  |  1D                      |  2D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  0.00  |  0.00  |  1.00  |  1D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  1.00  |  0.00  |  2D                      |  2D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  0.00  |  1.00  |  1.00  |  2D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  0.00  |  1.00  |  2D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  1.00  |  1.00  |  3D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+

   .. seealso::

      * :oe:func:`OEChem::OESetDimensionFromCoords` function
      * :oe:func:`OEChem::OEGetMDLDimensionFromCoords` and :oe:func:`OEChem::OESetMDLDimensionFromCoords` functions


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetDistance

.. oe:function:: OEGetDistance

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetDistance(const OEMolBase& mol, const OEAtomBase* a,
                              const OEAtomBase* b)
         double OEGetDistance(const OEConfBase& conf, const OEAtomBase* a,
                              const OEAtomBase* b)
         double OEGetDistance(const OEMolBase& ma, const OEAtomBase* a,
                              const OEMolBase& mb, const OEAtomBase* b)
         double OEGetDistance(const OEConfBase& ca, const OEAtomBase* a,
                              const OEConfBase& cb, const OEAtomBase* b)

   .. oe:language:: python

      .. oe:api:: python

         OEGetDistance(arg1: Union[OEGraphMol,OEMol,OEQMol], a: OEAtomBase,
                       b: OEAtomBase) -> float
         OEGetDistance(conf: OEConfBase, a: OEAtomBase, b: OEAtomBase) -> float
         OEGetDistance(ma: Union[OEGraphMol,OEMol,OEQMol], a: OEAtomBase,
                       mb: Union[OEGraphMol,OEMol,OEQMol], b: OEAtomBase) -> float
         OEGetDistance(ca: OEConfBase, a: OEAtomBase, cb: OEConfBase,
                       b: OEAtomBase) -> float

   Calculates the distance between two atoms.  The first two functions which
   take a single molecule (either :ref:`OEMolBase <OEChem_OEMolBase>` or
   :ref:`OEConfBase <OEChem_OEConfBase>`) assume that the two atoms are both in
   the single molecule.  If the atoms are in different molecules, the
   function which takes two molecule arguments should be used.
   :ref:`OEConfBase <OEChem_OEConfBase>` inherits from :ref:`OEMolBase <OEChem_OEMolBase>`
   and strictly speaking the overload is not necessary.  However, the
   specific :ref:`OEConfBase <OEChem_OEConfBase>` implementation can be more
   efficient.

   *mol*
      The molecule that the pair of atom belongs to (when all atoms belong to the same molecule).

   *conf*
      The conformer that the pair of atom belongs to (when all atoms belong to the same conformer).

   *a*
      The first atom.

   *b*
      The second atom.

   *ma*
      The molecule that the first atom (atom `a`) belongs to (when the atoms are in two different molecules).

   *mb*
      The molecule that the second atom (atom `b`) belongs to (when the atoms are in two different molecules).

   *ca*
      The conformer that the first atom (atom `a`) belongs to (when the atoms are in two different conformers).

   *cb*
      The conformer that the second atom (atom `b`) belongs to (when the atoms are in two different conformers).



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetDistance2

.. oe:function:: OEGetDistance2

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetDistance2(const OEMolBase& mol, const OEAtomBase* a,
                               const OEAtomBase* b)
         double OEGetDistance2(const OEConfBase& conf, const OEAtomBase* a,
                               const OEAtomBase* b)
         double OEGetDistance2(const OEMolBase& ma, const OEAtomBase* a,
                               const OEMolBase& mb, const OEAtomBase* b)
         double OEGetDistance2(const OEConfBase& ca, const OEAtomBase* a,
                               const OEConfBase& cb, const OEAtomBase* b)

   .. oe:language:: python

      .. oe:api:: python

         OEGetDistance2(arg1: Union[OEGraphMol,OEMol,OEQMol], a: OEAtomBase,
                        b: OEAtomBase) -> float
         OEGetDistance2(conf: OEConfBase, a: OEAtomBase, b: OEAtomBase) -> float
         OEGetDistance2(ma: Union[OEGraphMol,OEMol,OEQMol], a: OEAtomBase,
                        mb: Union[OEGraphMol,OEMol,OEQMol], b: OEAtomBase) -> float
         OEGetDistance2(ca: OEConfBase, a: OEAtomBase, cb: OEConfBase,
                        b: OEAtomBase) -> float

   These four functions are almost identical to the
   :oe:func:`OEChem::OEGetDistance` function.  However, they return the
   square of the distance between two atoms rather than distance.  When
   it is possible to use the square of the distance, this is more
   efficient.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetDoubleBondNeighbor

.. oe:function:: OEGetDoubleBondNeighbor

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAtomBase* OEGetDoubleBondNeighbor(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEGetDoubleBondNeighbor(atm: OEAtomBase) -> OEAtomBase



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetFileExtension

.. oe:function:: OEGetFileExtension

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetFileExtension(const char* fname)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFileExtension(fname: str) -> str

   Returns the file extension for the file name 'fname'.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetFileType

.. oe:function:: OEGetFileType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetFileType(const char* ext)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFileType(ext: str) -> int

   Returns a constant from the :ref:`the OEFormat namespace <OEChem_OEFormat>` for
   the file extension 'ext'.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetFormatExtension

.. oe:function:: OEGetFormatExtension

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetFormatExtension(unsigned int tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFormatExtension(tag: int) -> str

   Returns a comma-separated list of possible file extensions
   corresponding to the specified parameter. The parameter, 'tag', should
   be drawn from the :ref:`the OEFormat namespace <OEChem_OEFormat>`.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`oecheminfo.cpp<section_example_oechem_oecheminfo>`

  .. oe:language:: python

      * Example program :ref:`oecheminfo.py<section_example_oechem_oecheminfo>`

  .. oe:language:: java

      * Example program :ref:`OEChemInfo.java<section_example_oechem_oecheminfo>`

  .. oe:language:: csharp

      * Example program :ref:`OEChemInfo.cs<section_example_oechem_oecheminfo>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetFormatString

.. oe:function:: OEGetFormatString

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetFormatString(unsigned int tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFormatString(tag: int) -> str

   Returns the name of the file format associated with the symbolic
   constant 'tag' from the :ref:`the OEFormat namespace <OEChem_OEFormat>`.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`oecheminfo.cpp<section_example_oechem_oecheminfo>`

  .. oe:language:: python

      * Example program :ref:`oecheminfo.py<section_example_oechem_oecheminfo>`

  .. oe:language:: java

      * Example program :ref:`OEChemInfo.java<section_example_oechem_oecheminfo>`

  .. oe:language:: csharp

      * Example program :ref:`OEChemInfo.cs<section_example_oechem_oecheminfo>`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEGetHelmChainNames

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::vector<std::string> OEGetHelmChainNames(const std::string& helm)

   .. oe:language:: python

      .. oe:api:: python

         OEGetHelmChainNames(helm: str) -> OEStringVector

   Returns the chain names present in the given :term:`HELM` string.
   
   For example, in case of input  ``"PEPTIDE1{F.A}|CHEM1{[Fmoc]}$PEPTIDE1,CHEM1,1:R1-1:R1$$$"``
   it will return ``PEPTIDE1`` and ``CHEM1``.

   .. warning::

      The :oe:func:`OEChem::OEGetHelmChainNames` function does not perform full validation or parsing of the :term:`HELM` string. 
      It is intended for quickly extracting information from an already validated :term:`HELM`.

   .. seealso::

      * :oe:func:`OEChem::OEGetHelmMonomerCodes` function 
      * :oe:func:`OEChem::OEHelmToMol` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


    
.. oe:namespace:: OEChem

.. oe:function:: OEGetHelmMonomerCodes

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::vector<std::string> OEGetHelmMonomerCodes(const std::string& helm)
         std::vector<std::string> OEGetHelmMonomerCodes(const std::string& helm,
                                                        const std::string& chainName)

   .. oe:language:: python

      .. oe:api:: python

         OEGetHelmMonomerCodes(helm: str) -> OEStringVector
         OEGetHelmMonomerCodes(helm: str, chainName: str) -> OEStringVector

   Returns the monomer codes present in the given :term:`HELM` string.
   
   For example, in case of input  ``"PEPTIDE1{F.A}|CHEM1{[Fmoc]}$PEPTIDE1,CHEM1,1:R1-1:R1$$$"``
   it will return ``F``, ``A`` and ``Fmoc``. If a chain name is specified only monomer codes present
   in that chain are returned.  For example, in case of ``PEPTIDE1`` it will only return ``F`` abd ``A``.

   .. warning::

      The :oe:func:`OEChem::OEGetHelmMonomerCodes` function does not perform full validation or parsing of the :term:`HELM` string. 
      It is intended for quickly extracting information from an already validated :term:`HELM`.

   .. seealso::

      * :oe:func:`OEChem::OEGetHelmChainNames` function 
      * :oe:func:`OEChem::OEHelmToMol` function

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetHonigIonicCavityRadius

.. oe:function:: OEGetHonigIonicCavityRadius

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetHonigIonicCavityRadius(unsigned int elemno)

   .. oe:language:: python

      .. oe:api:: python

         OEGetHonigIonicCavityRadius(elemno: int) -> float

   Returns the effective ionic radius (defined in  [Rashin-1985]_) of each element to
   be used in solvation calculations.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetHybridization

.. oe:function:: OEGetHybridization

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetHybridization(const OEAtomBase *)

   .. oe:language:: python

      .. oe:api:: python

         OEGetHybridization(arg1: OEAtomBase) -> int

   This function predicts the atomic hybridization/geometry of an atom given
   its immediate connectivity.  The return value is taken from the
   namespace :oe:constns:`OEChem::OEHybridization`.

   .. warning::

      The aromaticity has to be perceived by
      calling :oe:func:`OEChem::OEAssignAromaticFlags` function prior to
      calling :oe:func:`OEChem::OEGetHybridization` function.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetHydrogenCounts

.. oe:function:: OEGetHydrogenCounts

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGetHydrogenCounts(OEHydrogenCounter& counter,
                                  const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetHydrogenCounts(counter: OEHydrogenCounter,
                             mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Populates an :ref:`OEHydrogenCounter <OEChem_OEHydrogenCounter>` object containing the explicit and implicit count of hydrogens in the molecule.
   Returns true if molecule is valid and counter is populated, false otherwise.  

.. seealso::

   * :ref:`OEHydrogenCounter <OEChem_OEHydrogenCounter>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetIsotopicWeight

.. oe:function:: OEGetIsotopicWeight

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetIsotopicWeight(unsigned int elemno, unsigned int mass)

   .. oe:language:: python

      .. oe:api:: python

         OEGetIsotopicWeight(elemno: int, mass: int) -> float

   Returns the atomic weight for a specific isotope.
   The isotope is specified by the atomic number ('elemno') and the
   atomic mass ('mass').

   To get the average atomic weight of an element, based upon
   typically occurring abundances of its natural isotopes, use the
   :oe:func:`OEChem::OEGetAverageWeight` function.

   .. seealso::

      * :oe:func:`OEChem::OEGetAverageWeight` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetMCSExhaustiveSearchTruncationLimit

.. oe:function:: OEGetMCSExhaustiveSearchTruncationLimit

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetMCSExhaustiveSearchTruncationLimit()

   .. oe:language:: python

      .. oe:api:: python

         OEGetMCSExhaustiveSearchTruncationLimit() -> int

   Returns the number of unique partial substructures that can be traversed
   during the :oe:const:`exhaustive<OEChem::OEMCSType::Exhaustive>`
   MCS search.

   .. seealso::

      * :oe:func:`OEChem::OESetMCSExhaustiveSearchTruncationLimit` function



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetMDLDimensionFromCoords

.. oe:function:: OEGetMDLDimensionFromCoords

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetMDLDimensionFromCoords(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMDLDimensionFromCoords(arg1: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Returns the molecule's dimension from the coordinates,
   The returned value is:

   * ``0`` if all x, y, z coordinates are zero
   * ``2`` if there is at least one atom with non-zero x or z coordinates
   * ``3`` it there is at least one atom with non-zero z coordinate

   The table below illustrates the difference between the :oe:func:`OEChem::OEGetDimensionFromCoords` and
   :oe:func:`OEChem::OEGetMDLDimensionFromCoords` functions.

   +--------------------------+--------------------------+------------------------------+
   | Coordinates              | OEGetDimensionFromCoords | OEGetMDLDimensionFromCoords  |
   +--------+--------+--------+                          +                              +
   |  X     |  Y     |  Z     |                          |                              |
   +========+========+========+==========================+==============================+
   |  0.00  |  0.00  |  0.00  |  0D                      |  0D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  0.00  |  0.00  |  1D                      |  2D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  0.00  |  1.00  |  0.00  |  1D                      |  2D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  0.00  |  0.00  |  1.00  |  1D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  1.00  |  0.00  |  2D                      |  2D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  0.00  |  1.00  |  1.00  |  2D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  0.00  |  1.00  |  2D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  1.00  |  1.00  |  3D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+

   .. seealso::

      * :oe:func:`OEChem::OESetMDLDimensionFromCoords` function
      * :oe:func:`OEChem::OEGetDimensionFromCoords` and :oe:func:`OEChem::OESetDimensionFromCoords` functions



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetMMCIFData

..  _OEChem_OEGetMMCIFData:

.. oe:function:: OEGetMMCIFData

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetMMCIFData(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMMCIFData(mol: Union[OEGraphMol,OEMol,OEQMol]) -> str

   Returns the mmCIF metadata for a molecule. If the molecule does not have
   the data, an empty string is returned.

   .. seealso::

      * :ref:`section_moldata_MMCIF` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetMolDBIdx

.. oe:function:: OEGetMolDBIdx

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetMolDBIdx(const OESystem::OEBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMolDBIdx(mol: OEBase) -> int

   Returns the index used to retrieve the molecule from a
   :ref:`OEMolDatabase <OEChem_OEMolDatabase>`. Returns ``(unsigned int)-1`` if
   ``mol`` did not actually originate from a
   :ref:`OEMolDatabase <OEChem_OEMolDatabase>`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetMolDatabaseIdxFileName

.. oe:function:: OEGetMolDatabaseIdxFileName

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetMolDatabaseIdxFileName(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMolDatabaseIdxFileName(databaseFileName: str) -> str

   Returns the default index file name generated by
   :oe:func:`OEChem::OECreateMolDatabaseIdx` and
   :oe:meth:`OEChem::OEMolDatabase::Save`. Returns an empty string if
   an empty string is given.

   The index file name created is based upon the ``filename`` passed,
   optionally accounting for :file:`.gz`. The following table
   demonstrates the pattern used to create index file names:

   =================== =====================
   Database File Name  Index File Name
   =================== =====================
   database.oeb        database.oeb.idx
   database.oeb.gz     database.oeb.idx.gz
   =================== =====================

   .. seealso::

      * :oe:func:`OEChem::OECreateMolDatabaseIdx`
      * :oe:meth:`OEChem::OEMolDatabase::Save`



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEGetMonomerType

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetMonomerType(const OEMolBase& monomer_mol)
         unsigned int OEGetMonomerType(const std::string& monomerSmiles)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMonomerType(monomer_mol: Union[OEGraphMol,OEMol,OEQMol]) -> int
         OEGetMonomerType(monomerSmiles: str) -> int

   Determines the monomer type of the monomer defined by its molecule or smiles 
   representation.
   Returns :oe:const:`OEChem::OEMonomerType::Undefined` if given monomer
   does not satisfy the requirement of any of the specific monomer type. 

   .. seealso::

      * :oe:constns:`OEChem::OEMonomerType` namespace

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetNearestNbrs

.. oe:function:: OEGetNearestNbrs

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OENbrs>* OEGetNearestNbrs(const OEMolBase& mol,
                                                        double maxdist,
                                                        unsigned int method = OENearestNbrsMethod::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearestNbrs(mol: Union[OEGraphMol,OEMol,OEQMol], maxdist: float,
                          method: int) -> OENbrsIter

   Returns an iterator over all atom pairs of the given molecule that are closer
   to each other than the given limit.

   maxdist
     The maximum distance between two atoms.

   method
     Determines the algorithm that is used to find the nearest neighbors.
     This value has to be from the :oe:const:`OEChem::OENearestNbrsMethod` namespace.

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OENbrs>* OEGetNearestNbrs(const OEMolBase& mol,
                                                        const OEAtomBase* atom,
                                                        double maxdist,
                                                        unsigned int method = OENearestNbrsMethod::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearestNbrs(mol: Union[OEGraphMol,OEMol,OEQMol],
                          atom: OEAtomBase, maxdist: float, method: int) -> OENbrsIter

   Returns an iterator over all neighbors of the given atom that is closer than the
   given limit.

   atom
     This atom does not have to belong to the given molecule.

   maxdist
     The maximum distance between two atoms.

   method
     Determines the algorithm that is used to find the nearest neighbors.
     This value has to be from the :oe:const:`OEChem::OENearestNbrsMethod` namespace.

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OENbrs>* OEGetNearestNbrs(const OEMolBase& mol,
                                                        const float* coords,
                                                        double maxdist,
                                                        unsigned int method = OENearestNbrsMethod::Default)
         OESystem::OEIterBase<OENbrs>* OEGetNearestNbrs(const OEMolBase& mol,
                                                        const double* coords,
                                                        double maxdist,
                                                        unsigned int method = OENearestNbrsMethod::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearestNbrs(mol: Union[OEGraphMol,OEMol,OEQMol], coords: float,
                          maxdist: float, method: int) -> OENbrsIter

   Returns an iterator over all atom pairs of the given molecule that are closer
   to each other than the given limit. When calculating the distances the coordinates
   passed as a parameter are utilized rather then the coordinates stored in
   the molecule.

   maxdist
     The maximum distance between two atoms.

   method
     Determines the algorithm that is used to find the nearest neighbors.
     This value has to be from the :oe:const:`OEChem::OENearestNbrsMethod` namespace.

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OENbrs>* OEGetNearestNbrs(const OEMolBase& mol1,
                                                        const OEMolBase& mol2,
                                                        double maxdist,
                                                        unsigned int method = OENearestNbrsMethod::Default,
                                                        const bool sorting = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearestNbrs(mol1: Union[OEGraphMol,OEMol,OEQMol],
                          mol2: Union[OEGraphMol,OEMol,OEQMol], maxdist: float,
                          method: int) -> OENbrsIter

   Returns an iterator over all atom pairs of the two molecules that are closer
   to each other than the given limit.
   This function calculates **intra-molecular** distances.

   maxdist
     The maximum distance between two atoms.

   method
     Determines the algorithm that is used to find the nearest neighbors.
     This value has to be from the :oe:const:`OEChem::OENearestNbrsMethod` namespace.

   sorting
     If the value is set to ``true``, the returned atom pairs are sorted based on
     the distance from the shortest to the longest. The default value is ``false``.

   .. seealso::

      * :oe:func:`OEChem::OENearestNbrs` function
      * :oe:func:`OEChem::OENbrs` class


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetNucleicAcidCode

.. oe:function:: OEGetNucleicAcidCode

   .. oe:language:: c++ java csharp

      .. oe:api::

         char OEGetNucleicAcidCode(unsigned int idx)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNucleicAcidCode(idx: int) -> str

   Returns the single character nucleic acid code corresponding to the
   specified residue (using the :oe:constns:`OEChem::OEResidueIndex`
   namespace format). The character ``N`` is returned for the residue
   :oe:const:`OEChem::OEResidueIndex::UNK` and the NULL character (0) is
   returned for all other non-nucleic acid residues.

   .. seealso::

      * :oe:func:`OEChem::OEGetResidueIndexFromCode` inverse function
      * :oe:constns:`OEChem::OEResidueIndex` namespace


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetOEGraphMol

.. oe:function:: OEGetOEGraphMol

   .. oe:language:: java

      .. oe:api:: java

         OEGraphMol OEGetOEGraphMol(OEBase obj, String tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetOEGraphMol(obj, tag) -> OEGraphMol

   .. oe:language:: csharp

      .. oe:api:: csharp

         OEGraphMol OEGetOEGraphMol(OEBase obj, String tag)

   .. oe:language:: python java csharp

      Returns a copy of the :ref:`OEGraphMol <OEChem_OEGraphMol>` attached with
      the ``tag`` as :ref:`generic data<chapter_genericdata>`.

      .. seealso::

         * The :ref:`section_attaching_other_objects` section for example code
         * :oe:func:`OEChem::OESetOEGraphMol`

   .. oe:language:: c++

      This function is provided in CSharp, Java and Python wrappers and
      is not needed in C++.  Use the templated
      :oe:meth:`OESystem::OEBaseDataT::GetData` method instead.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetOEMol

.. oe:function:: OEGetOEMol

   .. oe:language:: java

      .. oe:api:: java

         OEMol OEGetOEMol(OEBase obj, String tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetOEMol(obj, tag) -> OEMol

   .. oe:language:: csharp

      .. oe:api:: csharp

         OEMol OEGetOEMol(OEBase obj, String tag)

   .. oe:language:: csharp java python

      Returns a copy of the :ref:`OEMol <OEChem_OEMol>` attached with
      the ``tag`` as :ref:`generic data<chapter_genericdata>`.

      .. seealso::

         * :oe:func:`OEChem::OESetOEMol`
         * The :ref:`section_attaching_other_objects` section for example code

   .. oe:language:: c++

      This function is provided in CSharp, Java and Python wrappers and
      is not needed in C++.  Use the templated
      :oe:meth:`OESystem::OEBaseDataT::GetData` method instead.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetOEQMol

.. oe:function:: OEGetOEQMol

   .. oe:language:: java

      .. oe:api:: java

         OEQMol OEGetOEQMol(OEBase obj, String tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetOEQMol(obj, tag) -> OEQMol

   .. oe:language:: csharp

      .. oe:api:: csharp

         OEQMol OEGetOEQMol(OEBase obj, String tag)

   .. oe:language:: python java csharp

      Returns a copy of the :ref:`OEQMol <OEChem_OEQMol>` attached with
      the ``tag`` as :ref:`generic data<chapter_genericdata>`.

      .. seealso::

         * The :ref:`section_attaching_other_objects` section for example code
         * :oe:func:`OEChem::OESetOEQMol`

   .. oe:language:: c++

      This function is provided in CSharp, Java and Python wrappers and
      is not needed in C++.  Use the templated
      :oe:meth:`OESystem::OEBaseDataT::GetData` method instead.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetOtherNeighbor

.. oe:function:: OEGetOtherNeighbor

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEBondBase* OEGetOtherNeighbor(const OEAtomBase* atm,
                                        const OEBondBase* nbr)
         OEAtomBase* OEGetOtherNeighbor(const OEAtomBase* atm,
                                        const OEAtomBase* nbr)

   .. oe:language:: python

      .. oe:api:: python

         OEGetOtherNeighbor(atm: OEAtomBase, nbr: OEBondBase) -> OEBondBase
         OEGetOtherNeighbor(atm: OEAtomBase, nbr: OEAtomBase) -> OEAtomBase



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetPDBAtomIndex

..  _OEChem_OEGetPDBAtomIndex:

.. oe:function:: OEGetPDBAtomIndex

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetPDBAtomIndex(const char* name)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPDBAtomIndex(name: str) -> int

   Returns an unsigned integer index encoding the atom name.
   The returned index is from the :oe:constns:`OEChem::OEPDBAtomName`
   namespace.
   If the PDB atom name is **not** recognized then the
   :oe:func:`OEChem::OEGetPDBAtomIndex` function returns :oe:const:`OEChem::OEPDBAtomName::UNK`.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetPDBAtomIndex(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPDBAtomIndex(atm: OEAtomBase) -> int

   Returns an unsigned integer index encoding the atom name
   that is returned by the :oe:meth:`OEChem::OEAtomBase::GetName` method.
   The returned index is from the :oe:constns:`OEChem::OEPDBAtomName`
   namespace.

   .. note::

      The PDB atom name index returned by the :oe:func:`OEChem::OEGetPDBAtomIndex`
      function may be converted back into a string using
      the :oe:func:`OEChem::OEGetPDBAtomName` function.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetPDBAtomName

.. oe:function:: OEGetPDBAtomName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetPDBAtomName(unsigned int idx)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPDBAtomName(idx: int) -> str

   Converts an **OEChem TK** PDB atom name index, as returned by the
   :oe:func:`OEChem::OEGetPDBAtomIndex` function, back into a string
   representation.  Valid indices are specified in **OEChem TK**'s
   :oe:constns:`OEChem::OEPDBAtomName` namespace.

   A NULL pointer, ``(char*)0``, is returned for invalid or unrecognized
   argument values.  All other returned string constants are guaranteed
   to be four characters long.  For example, the input value
   :oe:const:`OEChem::OEPDBAtomName::CA` returns the string value ``" CA "``.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetPDBBaseData

.. oe:function:: OEGetPDBBaseData

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OESystem::OEBaseDataT<std::string> >* OEGetPDBBaseData(const OESystem::OEBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPDBBaseData(mol: OEBase) -> Iterable[OEBaseDataT[str]]



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetPDBData

.. oe:function:: OEGetPDBData

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetPDBData(const OEMolBase& mol, const std::string& tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPDBData(mol: Union[OEGraphMol,OEMol,OEQMol], tag: str) -> str

   Returns the PDB data for the given tag. If the molecule does not have
   that tag, an empty string is returned.
   If there are multiple items with the same tag, only the first data
   is returned.

   .. seealso::

      * :oe:func:`OEChem::OEGetPDBDataPairs` function to access multiple items with the same tag
      * :oe:func:`OEChem::OEAddSDData` and :oe:func:`OEChem::OESetSDData` functions
      * :ref:`section_moltaggeddata_PDB` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetPDBDataPairs

.. oe:function:: OEGetPDBDataPairs

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEPDBDataPair>* OEGetPDBDataPairs(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPDBDataPairs(mol: Union[OEGraphMol,OEMol,OEQMol]) -> Iterable[OEPDBDataPair]

   Returns an iterator over all the PDB data pairs of the molecule.

   .. seealso::

      * :oe:func:`OEChem::OEGetSDData` function
      * :oe:func:`OEChem::OEAddSDData` and :oe:func:`OEChem::OESetSDData` functions
      * :ref:`section_moltaggeddata_PDB` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetPackedCoords

.. oe:function:: OEGetPackedCoords

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEGetPackedCoords(const OEMolBase& mol, float* coords)
         void OEGetPackedCoords(const OEMolBase& mol, double* coords)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPackedCoords(mol: Union[OEGraphMol,OEMol,OEQMol],
                           coords: OEFloatArray) -> None
         OEGetPackedCoords(mol: Union[OEGraphMol,OEMol,OEQMol],
                           coords: OEDoubleArray) -> None

   Fills an array with the coordinates of a molecule.  The coordinates
   will be packed into an array of size
   :oe:meth:`OEChem::OEMolBase::NumAtoms` * 3 which is passed in as the
   coords array.  The coordinates of the atoms will be in the array in
   the same order as the atoms come out of the iterator generated by
   :oe:meth:`OEChem::OEMolBase::GetAtoms`.

   *mol*
      The molecule to get coordinates from.

   *coords*
      The array to fill coordinates with.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetPathLength

.. oe:function:: OEGetPathLength

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetPathLength(const OEAtomBase* a, const OEAtomBase* b,
                                      unsigned int maxpath = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPathLength(arg1: OEAtomBase, arg2: OEAtomBase, maxPath: int = 0) -> int

   Returns the shortest path length between two atoms i.e. the number of
   bonds between the two given atoms.
   For example, in thiazole ``(c1nccs1)`` the path length between the nitrogen
   and sulfur atom is 2.

   **src, dst**
      The two atoms for which the length of the shortest path returns.
      If the two atoms are the same :ref:`OEAtomBase <OEChem_OEAtomBase>`,
      have different parent molecule or are part of different
      disconnected molecular graphs, the :oe:func:`OEChem::OEGetPathLength`
      function returns zero.

   *maxpath**
      This parameter may be used to specify a maximum path length to
      consider before terminating the search.  If this value is zero, the
      default, there is no upper bound on the returned path length.  Otherwise,
      if the shortest path between the two atoms is greater than **maxpath**
      bonds, this function returns the value zero.

.. seealso::

   * :oe:func:`OEChem::OEShortestPath` function

   .. oe:language:: c++

      * Example program :ref:`minpath.cpp<section_example_oechem_minpath>`

   .. oe:language:: python

      * Example program :ref:`minpath.py<section_example_oechem_minpath>`

   .. oe:language:: java

      * Example program :ref:`MinPath.java<section_example_oechem_minpath>`

   .. oe:language:: csharp

      * Example program :ref:`MinPath.cs<section_example_oechem_minpath>`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetPaulingVdWRadius

.. oe:function:: OEGetPaulingVdWRadius

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetPaulingVdWRadius(unsigned int elemno)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPaulingVdWRadius(elemno: int) -> float

   Returns the Van der Waals radius for a particular atomic number as
   tabulated by Linus Pauling [Pauling-1960]_.
   There are several experimental values for Van der Waals radii (see also
   :oe:func:`OEChem::OEGetBondiVdWRadius`) and many additional
   values used in molecular mechanics forcefields (including united-atom VdW radii),
   so there is often no definitive notion of Van der Waals radius.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEGetPolymerType

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetPolymerType(const OEMolBase& monomer_mol)
         unsigned int OEGetPolymerType(const std::string& monomerSmiles)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPolymerType(monomer_mol: Union[OEGraphMol,OEMol,OEQMol]) -> int
         OEGetPolymerType(monomerSmiles: str) -> int

   Determines the polymer type of the monomer defined by its molecule or smiles 
   representation.
   Returns :oe:const:`OEChem::OEPolymerType::Undefined` if given monomer
   does not satisfy the requirement of any of the specific polymer type. 

   .. seealso::

      * :oe:constns:`OEChem::OEPolymerType` namespace


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetRadiiTypeName

.. oe:function:: OEGetRadiiTypeName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetRadiiTypeName(unsigned int radiiType)

   .. oe:language:: python

      .. oe:api:: python

         OEGetRadiiTypeName(radiiType: int) -> str

   Returns the name of the specified ``radiiType``, from
   the :oe:constns:`OEChem::OERadiiType` namespace.

   .. seealso::

      * :oe:func:`OEChem::OEAssignRadii`



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetRadiusOfGyration

.. oe:function:: OEGetRadiusOfGyration

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGetRadiusOfGyration(double* radiusOfGyration,
                                    const double* pmi, const OEMolBase& mol)
         bool OEGetRadiusOfGyration(double* radiusOfGyration,
                                    const double* pmi, const OEConfBase& mol)
         bool OEGetRadiusOfGyration(double* radiusOfGyration,
                                    const double* pmi, const OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetRadiusOfGyration(rGyration: OEDoubleArray, pmi: OEDoubleArray,
                               mol: Union[OEGraphMol,OEQMol]) -> bool
         OEGetRadiusOfGyration(rGyration: OEDoubleArray, pmi: OEDoubleArray,
                               mol: OEConfBase) -> bool
         OEGetRadiusOfGyration(rGyration: OEDoubleArray, pmi: OEDoubleArray,
                               mol: OEMol) -> bool

   Calculates the radius of gyration of the given molecule, using the given PMI that has already been calculated
   with the function :oe:func:`OEChem::OECalcPMI`. Units of the calculated radius are the same as those used to
   set the radius of the molecule, which need to be the same radius units used to calculate the PMI.

   The function returns true if calculation is successful, false otherwise. If the molecule is not centered, or
   radius of gyration values are all 0, the function will return false,

   Note that for an :ref:`OEMCMolBase <OEChem_OEMCMolBase>`, the :oe:func:`OEChem::OECalcPMI` only calculates the PMI for the
   active conformer, and therefore this function similarly uses only the mass of the active conformer to calculate the
   radius of gyration.

   *radiusOfGyration*
      This double array will be populated by the radius of gyration in each dimension, X, Y, and Z.  
   
   *pmi*
      This is a pointer to the PMI of the given molecule in each dimension, in X, Y, and Z.

   *mol*
      This is the molecule for which the PMI is calculated. It must have a set radius and set mass for the calculation
      to be valid. 

   .. warning::

      These functions only work correctly with a molecule that has been centered using the function
      :oe:func:`OEChem::OECenter`. If the molecule has not been centered, the function will return false.

   .. seealso::

      * :oe:func:`OEChem::OECalcPMI` function to calculate principle moment of inertia.

   The following code snippet demonstrates how to calculate the PMI and radius of gyration for a molecule.

.. oe:source:: CalcPMI.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-CALC-PMI

.. oe:source:: CalcPMI.py
   :language: python
   :noindent:
   :frag:     SNIPPET-CALC-PMI

.. oe:source:: CalcPMI.java
   :language: java
   :noindent:
   :frag:     SNIPPET-CALC-PMI

.. oe:source:: CalcPMI.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-CALC-PMI

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetResidueIndex

.. oe:function:: OEGetResidueIndex

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetResidueIndex(const char* name)
         unsigned int OEGetResidueIndex(const OEResidue& res)
         unsigned int OEGetResidueIndex(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEGetResidueIndex(name: str) -> int
         OEGetResidueIndex(res: OEResidue) -> int
         OEGetResidueIndex(atm: OEAtomBase) -> int

   Returns the **OEChem TK** PDB residue name index.  The resulting value is
   specified by the :oe:constns:`OEChem::OEResidueIndex` namespace.  If
   the residue name is not recognized internally by **OEChem TK** this
   function returns the value zero.

   .. seealso::

      * :oe:constns:`OEChem::OEResidueIndex` namespace
      * :ref:`OEResidue <OEChem_OEResidue>` class
      * :oe:func:`OEChem::OEAtomGetResidue` function


.. oe:namespace:: OEChem

.. oe:function:: OEGetResidueIndexFromCode

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetResidueIndexFromCode(const char name)

   .. oe:language:: python

      .. oe:api:: python

         OEGetResidueIndexFromCode(name: str) -> int

   Converts the single character amino acid code into a value from
   the :oe:constns:`OEChem::OEResidueIndex` namespace.
   For invalid amino acid codes the function returns ``0``.

   .. seealso::

      * :oe:func:`OEChem::OEGetAminoAcidCode` inverse function
      * :oe:constns:`OEChem::OEResidueIndex` namespace


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetResidueName

.. oe:function:: OEGetResidueName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetResidueName(unsigned int idx)

   .. oe:language:: python

      .. oe:api:: python

         OEGetResidueName(idx: int) -> str

   Converts an **OEChem TK** residue index, as returned by the
   :oe:func:`OEChem::OEGetResidueIndex` function, back into a
   three-character string representation.  Valid indices are specified in
   **OEChemTK**'s :oe:constns:`OEChem::OEResidueIndex` namespace.

   A NULL pointer, ``(char*)0``, is returned for invalid or unrecognized
   argument values.  All other returned string constants are guaranteed
   to be three characters long.  For example, the input value
   :oe:const:`OEChem::OEResidueIndex::ALA` returns the string value
   ``"ALA"``.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetSDBaseData

.. oe:function:: OEGetSDBaseData

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OESystem::OEBaseDataT<std::string> >* OEGetSDBaseData(const OESystem::OEBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSDBaseData(mol: OEBase) -> Iterable[OEBaseDataT[str]]



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetSDData

.. oe:function:: OEGetSDData

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetSDData(const OEMolBase& mol, const std::string& tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSDData(mol: Union[OEGraphMol,OEMol,OEQMol], tag: str) -> str

   Returns the SD data for the given tag. If the molecule does not have
   that tag, an empty string is returned.
   If there are multiple items with the same tag, only the first data
   is returned.

   .. seealso::

      * :oe:func:`OEChem::OEGetSDDataPairs` function to access multiple items with the same tag
      * :oe:func:`OEChem::OEAddSDData` and :oe:func:`OEChem::OESetSDData` functions
      * :ref:`section_moltaggeddata_SD` section

   .. admonition:: Code Example

      * :ref:`section_example_oechem_sdf2csv` example
      * :ref:`section_example_oechem_sdfilter` example


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetSDDataPairs

.. oe:function:: OEGetSDDataPairs

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OESDDataPair>* OEGetSDDataPairs(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSDDataPairs(mol: Union[OEGraphMol,OEMol,OEQMol]) -> OESDDataIter

   Returns an iterator over all the SD data pairs of the molecule.

   .. seealso::

      * :oe:func:`OEChem::OEGetSDData` function
      * :oe:func:`OEChem::OEAddSDData` and :oe:func:`OEChem::OESetSDData` functions
      * :ref:`section_moltaggeddata_SD` section

   .. admonition:: Code Example

      * :ref:`section_example_oechem_csv2sdf` example


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetSingleBondNeighbor

.. oe:function:: OEGetSingleBondNeighbor

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAtomBase* OEGetSingleBondNeighbor(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSingleBondNeighbor(atm: OEAtomBase) -> OEAtomBase



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetSmallestSubtree

.. oe:function:: OEGetSmallestSubtree

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEAtomBase>* OEGetSmallestSubtree(const OEBondBase * bond,
                                                                unsigned int maxdepth = 0)
         OESystem::OEIterBase<OEAtomBase>* OEGetSmallestSubtree(const OEBondBase* bond,
                                                                const OESystem::OEUnaryPredicate<OEAtomBase>& excludeAtoms,
                                                                unsigned int maxdepth = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSmallestSubtree(arg1: OEBondBase, maxDepth: int = 0) -> OEAtomIter
         OEGetSmallestSubtree(bond: OEBondBase, excludeAtoms: OEUnaryAtomPred,
                              maxDepth: int = 0) -> OEAtomIter

   This function traverses the subgraph of all connected atoms on one end
   of a bond passed as the argument without crossing the bond itself.  If
   the number of contiguous atoms connected to the beginning atom of the
   bond exceeds half of the atoms in the molecule, that subtree is
   discarded and a new traversal begins starting with the end atom of the
   bond.  The bond itself may not be crossed in the second traversal.  An
   iterator over the atoms that are members of the smallest subgraph is
   returned.  The root atom of the bond from which the smallest subtree
   originates is included in the atom iterator returned.

   *maxdepth*
     This parameter enables partial tree traversal in ring structures, default
     is zero which means full depth search.

   .. seealso::

      * :oe:func:`OEChem::OEGetSubtree` function


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetSmiStringOrder

.. oe:function:: OEGetSmiStringOrder

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEAtomBase>*OEGetSmiStringOrder(OEMolBase& mol,
                                                              unsigned int flavor = OESMILESFlag::DEFAULT)
         OESystem::OEIterBase<const OEAtomBase>*OEGetSmiStringOrder(const OEMolBase& mol,
                                                                    unsigned int flavor = OESMILESFlag::DEFAULT)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSmiStringOrder(mol: Union[OEGraphMol,OEMol,OEQMol], flavor: int) -> OEAtomIter

   Returns an iterator over the heavy atoms of a molecule, in the order in
   which they appear in the canonical SMILES string. Several variants of
   SMILES format are supported by using different flavors from
   the :oe:constns:`OEChem::OESMILESFlag` namespace.

   .. oe:source:: OEGetSmiStringOrder.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEGETSMISTRINGORDER

   .. oe:source:: OEGetSmiStringOrder.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEGETSMISTRINGORDER

   .. oe:source:: OEGetSmiStringOrder.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEGETSMISTRINGORDER

   .. oe:source:: OEGetSmiStringOrder.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEGETSMISTRINGORDER

   .. seealso::

      * :oe:func:`OEChem::OECreateSmiString` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetSoleBond

.. oe:function:: OEGetSoleBond

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEBondBase* OEGetSoleBond(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSoleBond(atm: OEAtomBase) -> OEBondBase

   Gets the first bond of the given atom. If there is more than one bond, the bond chosen is arbitrary. If there is no
   bond, null is returned.

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetSoleDoubleBond

.. oe:function:: OEGetSoleDoubleBond

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEBondBase* OEGetSoleDoubleBond(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSoleDoubleBond(atm: OEAtomBase) -> OEBondBase

   Gets the first double bond of the given atom. If there is more than one double bond, the bond chosen is arbitrary.
   If there is no double bond, null is returned.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetSoleNeighbor

.. oe:function:: OEGetSoleNeighbor

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAtomBase* OEGetSoleNeighbor(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSoleNeighbor(atm: OEAtomBase) -> OEAtomBase

   Gets the first neighbor of the given atom. If there is more than one neighbor, the atom chosen
   is arbitrary. If there is no atom, the function returns a null pointer. 



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetSoleSingleBond

.. oe:function:: OEGetSoleSingleBond

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEBondBase* OEGetSoleSingleBond(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSoleSingleBond(atm: OEAtomBase) -> OEBondBase

   Gets the first single bond of the given atom. If there is more than one single bond, the bond chosen is arbitrary.
   If there is no single bond, null is returned.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetSoleTripleBond

.. oe:function:: OEGetSoleTripleBond

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEBondBase* OEGetSoleTripleBond(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSoleTripleBond(atm: OEAtomBase) -> OEBondBase

   Returns the first triple bond attached to the given atom. If there is more than one triple bond, the bond returned
   is arbitrary. if there is no triple bond, null is returned.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEGetStandardAnalog

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetStandardAnalog(const std::string& monomerSmiles)

   .. oe:language:: python

      .. oe:api:: python

         OEGetStandardAnalog(monomerSmiles: str) -> int

   Returns the residue index of the standard amino acid (from the :oe:constns:`OEChem::OEResidueIndex` namespace)
   that are most similar to monomer represented by the given SMILES, or :oe:const:`OEChem::OEResidueIndex::UNK` 
   if the monomer is not considered an analog.

   .. seealso::

      * :oe:constns:`OEChem::OEResidueIndex` namespace
      * :oe:func:`OEChem::OEGetAminoAcidCode` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetStyle

.. oe:function:: OEGetStyle

   .. oe:language:: c++ java csharp

      .. oe:api::

         OE3DMolStyle OEGetStyle(const OEChem::OEMolBase& mol)
         OE3DMolStyle OEGetStyle(const OEChem::OEAtomBase& atom)
         OE3DMolStyle OEGetStyle(const OEChem::OEAtomBase& atom,
                                 const OE3DMolStyle& dflt)
         OE3DMolStyle OEGetStyle(const OEChem::OEAtomBase& atom,
                                 const OEChem::OEConfBase& c)

   .. oe:language:: python

      .. oe:api:: python

         OEGetStyle(mol: Union[OEGraphMol,OEMol,OEQMol]) -> OE3DMolStyle
         OEGetStyle(atom: OEAtomBase) -> OE3DMolStyle
         OEGetStyle(atom: OEAtomBase, dflt: OE3DMolStyle) -> OE3DMolStyle
         OEGetStyle(atom: OEAtomBase, c: OEConfBase) -> OE3DMolStyle

   Returns the :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` accociated with the molecule or atom 
   specified. There are two various of this function that utilize 
   :ref:`OEAtomBase <OEChem_OEAtomBase>` and either a :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` or 
   :ref:`OEConfBase <OEChem_OEConfBase>`. Both of these function are used to incorporate a conformer to 
   influence the :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` returned.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetStyleChange

.. oe:function:: OEGetStyleChange

   .. oe:language:: c++ java csharp

      .. oe:api::

         OE3DMolStyle OEGetStyleChange(const OE3DMolStyle& initialStyle,
                                       const OE3DMolStyle& finalStyle)

   .. oe:language:: python

      .. oe:api:: python

         OEGetStyleChange(initialStyle: OE3DMolStyle, finalStyle: OE3DMolStyle) -> OE3DMolStyle

   Returns a :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` with only the difference between the two inputted 
   :ref:`OE3DMolStyles <OEChem_OE3DMolStyle>`. :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` &finalStyle is utilized as the reference 
   :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`.

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetStyleIndex

.. oe:function:: OEGetStyleIndex

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetStyleIndex(const OEAtomBase& atom)
         unsigned int OEGetStyleIndex(const OEConfBase& conf)

   .. oe:language:: python

      .. oe:api:: python

         OEGetStyleIndex(atom: OEAtomBase) -> int
         OEGetStyleIndex(conf: OEConfBase) -> int

   Returns the style index of a specified :ref:`OEAtomBase <OEChem_OEAtomBase>` or 
   :ref:`OEConfBase <OEChem_OEConfBase>` as an integer.

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

..  _OEChem_OEGetSubSearchScreenType:

.. oe:function:: OEGetSubSearchScreenType

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OESubSearchScreenTypeBase* OEGetSubSearchScreenType(const unsigned stype)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSubSearchScreenType(stype: int) -> OESubSearchScreenTypeBase

   Converts a constant from the :oe:constns:`OEChem::OESubSearchScreenType`
   namespace into an internal screen type (:ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>`).

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OESubSearchScreenTypeBase* OEGetSubSearchScreenType(const std::string& stypestr)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSubSearchScreenType(stypestr: str) -> OESubSearchScreenTypeBase

   Convert a string (such as ``"Molecule SubSearch Screen,ver=0.9.0"``) into
   an internal screen type (:ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>`).
   The function returns a null pointer for invalid strings.

   .. seealso::

      * :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>` class
      * :oe:meth:`OEChem::OESubSearchScreenTypeBase::GetScreenTypeString` method
      * :oe:constns:`OEChem::OESubSearchScreenType` namespace

   .. admonition:: Code Example

      * :ref:`section_example_oechem_makefastss` example
      * :ref:`section_example_oechem_searchfastss` example


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetSubtree

.. oe:function:: OEGetSubtree

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEAtomBase>* OEGetSubtree(const OEAtomBase* bgn,
                                                        const OEAtomBase* end,
                                                        unsigned int maxDepth = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSubtree(bgn: OEAtomBase, end: OEAtomBase, maxDepth: int = 0) -> OEAtomIter

   Traverses the subgraph from the **end** atom and avoids crossing over the bond to the
   **bgn** atom.

   *maxdepth*
     This parameter enables partial tree traversal in ring structures, default
     is zero which means full depth search.

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEAtomBase>* OEGetSubtree(const OEBondBase*,
                                                        const OESystem::OEUnaryPredicate<OEAtomBase>& excludeAtoms,
                                                        unsigned int maxDepth = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSubtree(arg1: OEBondBase, excludeAtoms: OEUnaryAtomPred,
                      maxDepth: int = 0) -> OEAtomIter

   Traverses the subgraph from the beginning atom of the **bond** passed
   as the first argument without crossing the bond itself.

   If the subgraph traversal does not cross any atoms which return ``true`` when
   tested with the **excludeAtoms** predicate, then an iterator over the
   atoms contained in the subgraph is returned.  If 'excludeAtoms` are
   encountered in the subgraph traversal, the subgraph is discarded
   and a new traversal begins from the end atom of the bond.  If the
   new traversal fails to encounter excluded atoms then an iterator
   over the atoms contained in the subgraph is returned.  If both traversals
   fail then an iterator over an empty set of atoms is returned.

   *maxdepth*
     This parameter enables partial tree traversal in ring structures, default
     is zero which means full depth search.

   .. seealso::

      * :oe:func:`OEChem::OEGetSmallestSubtree` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetTokenizer

.. oe:function:: OEGetTokenizer

   .. oe:language:: c++ java csharp

      .. oe:api::

         OETokenizerBase* OEGetTokenizer(unsigned int fmt, unsigned int flavor)

   .. oe:language:: python

      .. oe:api:: python

         OEGetTokenizer(fmt: int, flavor: int) -> OETokenizerBase

   Returns an :ref:`OETokenizerBase <OEChem_OETokenizerBase>` implementation for the
   specified ``fmt`` and ``flavor`` specified by constants in the
   :oe:constns:`OEChem::OEFormat` and :oe:constns:`OEChem::OEIFlavor`
   namespaces respectively. Tokenizers are the underlying
   implementation of how the :ref:`oemolithread <OEChem_oemolithread>` can chunk
   up a molecule file into a string token for each molecule. Most
   users will find it more convenient to use
   :oe:meth:`OEChem::oemolthreadbase::GetMol` method to retrieve
   molecule tokens as strings from a file.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetTorsion

.. oe:function:: OEGetTorsion

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetTorsion(const OEMolBase& mol, const OEAtomBase* a,
                             const OEAtomBase* b, const OEAtomBase* c,
                             const OEAtomBase* d)
         double OEGetTorsion(const OEConfBase& conf, const OEAtomBase* a,
                             const OEAtomBase* b, const OEAtomBase* c,
                             const OEAtomBase* d)

   .. oe:language:: python

      .. oe:api:: python

         OEGetTorsion(arg1: Union[OEGraphMol,OEMol,OEQMol], a: OEAtomBase,
                      b: OEAtomBase, c: OEAtomBase, d: OEAtomBase) -> float
         OEGetTorsion(arg1: OEConfBase, a: OEAtomBase, b: OEAtomBase,
                      c: OEAtomBase, d: OEAtomBase) -> float

   Returns the torsion formed by the four atoms `a`, `b`, `c`, and `d`.
   The return value is in radians and varies from ``+PI`` to ``-PI``.
   If any of the arguments are null pointers, the function returns ``FLT_MAX`` to indicate an error.
   All of the atoms must be contained in the molecule (or conformer)
   which is passed to the function.  The :ref:`OEConfBase <OEChem_OEConfBase>` is
   strictly for efficiency.  If the absolute value of the torsion can be
   used instead, the function :oe:func:`OEChem::OEGetAbsTorsion` is much
   more efficient than calculating the absolute value of the return of
   this function.

   *mol*
      The molecule that the atoms belong to.

   *conf*
      The conformer that the atoms belong to.

    *a*
      One of the end atoms in the torsion.

    *b*
      Atom that is connected to `a` in the torsion.

    *c*
      Atom that is connected to `d` in the torsion.

    *d*
      The other end atom in the torsion.

  .. seealso::

     * :oe:func:`OEBio::OEGetTorsion` **OEBio TK** function for regular dihedral angles in standard protein residues. 


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetTorsions

.. oe:function:: OEGetTorsions

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OETorsion>* OEGetTorsions(const OEMolBase &,
                                                        const OESystem::OEUnaryPredicate<OEBondBase>& isRotor = static_cast<const OESystem::OEUnaryPredicate<OEBondBase>&> \ (IsRotor()))

   .. oe:language:: python

      .. oe:api:: python

         OEGetTorsions(arg1: Union[OEGraphMol,OEMol,OEQMol],
                       isRotor: OEUnaryBondPred = (IsRotor())) -> OETorsionIter

   Return an iterator over all torsions in the molecule as
   :ref:`OETorsion <OEChem_OETorsion>` objects. What bonds are considered
   torsions can be changed by passing a different predicate to the
   ``isRotor`` argument.

   *mol*
      The molecule to get torsions of.

   *isRotor*
      Predicate to define which bonds should be considered torsions.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetTripleBondNeighbor

.. oe:function:: OEGetTripleBondNeighbor

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAtomBase* OEGetTripleBondNeighbor(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEGetTripleBondNeighbor(atm: OEAtomBase) -> OEAtomBase



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEGetUniMolecularRxnIter

.. oe:function:: OEGetUniMolecularRxnIter

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEMolBase>* OEGetUniMolecularRxnIter(const OEMolBase& mol,
                                                                   OEQMolBase& rxn,
                                                                   bool strictSmirks = true,
                                                                   unsigned maxMatches = 10000,
                                                                   bool validateKekule = true)
         OESystem::OEIterBase<OEMolBase>* OEGetUniMolecularRxnIter(const OEMolBase& mol,
                                                                   OEQMolBase& rxn,
                                                                   bool strictSmirks = true,
                                                                   unsigned maxMatches = 10000,
                                                                   bool validateKekule = true)

   .. oe:language:: python

      .. oe:api:: python

         OEGetUniMolecularRxnIter(mol: Union[OEGraphMol,OEMol,OEQMol],
                                  rxn: OEQMol, strictSmirks: bool = True,
                                  maxMatches: int = 10000,
                                  validateKekule: bool = True) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]
         OEGetUniMolecularRxnIter(mol: Union[OEGraphMol,OEMol,OEQMol],
                                  rxn: OEQMol, opts: OEUniMolecularRxnOptions) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

   The first function overload returns an iterator over unique products from each individual application
   of the transformation provided by a :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` instance initialized
   with the function arguments.

   The second function overload returns an iterator over unique products from each individual application
   of the transformation provided by a :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` instance initialized with the provided
   :ref:`OEUniMolecularRxnOptions <OEChem_OEUniMolecularRxnOptions>` class.

   .. seealso::

      * :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` class
      * :ref:`OEUniMolecularRxnOptions <OEChem_OEUniMolecularRxnOptions>` class



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasAtomStereoHydrogens

.. oe:function:: OEHasAtomStereoHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasAtomStereoHydrogens(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEHasAtomStereoHydrogens(atm: OEAtomBase) -> bool

   Returns true if the given atom has specified stereochemistry and no more than one hydrogen, deuterium or tritium
   isotope attached.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasBondStereoHydrogens

.. oe:function:: OEHasBondStereoHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasBondStereoHydrogens(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEHasBondStereoHydrogens(atm: OEAtomBase) -> bool

   Returns true if there is a double bond adjacent to the atom that has stereochemistry specified, and either endpoint
   of this bond has no more than one hydrogen, deuterium or tritium isotope attached.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasDoubleBond

.. oe:function:: OEHasDoubleBond

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasDoubleBond(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEHasDoubleBond(atm: OEAtomBase) -> bool

   Determines whether an atom is connected by one or more double bonds.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasDoubleBondO

.. oe:function:: OEHasDoubleBondO

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasDoubleBondO(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEHasDoubleBondO(atm: OEAtomBase) -> bool



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. oe:function:: OEHasExplicitHydrogenExpression

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasExplicitHydrogenExpression(const OEQMolBase& qmol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasExplicitHydrogenExpression(arg1: OEQMol) -> bool

   Returns `true` if the query molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`) has
   any explicit hydrogen(s).
   For example, if the query molecule has been initialized from the ``CO[H]``
   or ``[CO[#1,#6]]`` SMARTS patterns.

   .. seealso::

      * :oe:func:`OEChem::OEHasImplicitHydrogenExpression` function
      * :ref:`chapter_SMARTS` chapter


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasExplicitHydrogens

.. oe:function:: OEHasExplicitHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasExplicitHydrogens(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasExplicitHydrogens(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Determines whether a molecule has any explicit hydrogens.  A return
   value of ``true`` indicates that one or more of the
   :ref:`OEAtomBase <OEChem_OEAtomBase>` 's of the given molecule has an atomic
   number of one (:oe:const:`OEChem::OEElemNo::H`).



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. oe:function:: OEHasImplicitHydrogenExpression

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasImplicitHydrogenExpression(const OEQMolBase& qmol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasImplicitHydrogenExpression(arg1: OEQMol) -> bool

   Returns `true` if the query molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`) has
   any implicit hydrogen(s).
   For example, if the query molecule has been initialized from the ``[Ch1]``
   SMARTS pattern.

   .. seealso::

      * :oe:func:`OEChem::OEHasExplicitHydrogenExpression` function
      * :ref:`chapter_SMARTS` chapter


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasImplicitHydrogens

.. oe:function:: OEHasImplicitHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasImplicitHydrogens(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasImplicitHydrogens(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Determines whether a molecule as any implicit hydrogens.  A return
   value of ``true`` indicates that one or more of the
   :ref:`OEAtomBase <OEChem_OEAtomBase>` 's of the given molecule has an 'implicit
   hydrogen count' property greater than or equal to one.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasMMCIFData

.. oe:function:: OEHasMMCIFData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasMMCIFData(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasMMCIFData(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Determines whether a molecule has mmCIF metadata stored on it.

   .. seealso::

      * :ref:`section_moldata_MMCIF` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasMolDBIdx

.. oe:function:: OEHasMolDBIdx

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasMolDBIdx(const OESystem::OEBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasMolDBIdx(mol: OEBase) -> bool

   Returns whether ``mol`` came from a :ref:`OEMolDatabase <OEChem_OEMolDatabase>`
   and would a positive value from :oe:func:`OEChem::OEGetMolDBIdx`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasMultipleBond

.. oe:function:: OEHasMultipleBond

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasMultipleBond(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEHasMultipleBond(atm: OEAtomBase) -> bool

   Determines whether an atom is connected by any bonds with whose bond
   order, as returned by :oe:meth:`OEChem::OEBondBase::GetOrder`, is
   greater than one.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasPDBData

.. oe:function:: OEHasPDBData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasPDBData(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasPDBData(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Determines whether a molecule has any PDB data.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasPDBData(const OEMolBase& mol, const std::string& tag)

   .. oe:language:: python

      .. oe:api:: python

         OEHasPDBData(mol: Union[OEGraphMol,OEMol,OEQMol], tag: str) -> bool

   Determines whether a molecule has PDB data with a given tag.

   .. seealso::

      * :ref:`section_moltaggeddata_PDB` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasPartialCharges

.. oe:function:: OEHasPartialCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasPartialCharges(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasPartialCharges(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns ``true`` if any of the atoms of a molecule have a non-zero partial
   charge.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasRadii

.. oe:function:: OEHasRadii

   .. oe:api::

      bool OEHasRadii(const OEMolBase &mol, bool all=true)

   OEHasRadii returns whether atoms in the molecule have radii assigned.

   When ``all`` is ``true`` (the default), the function returns ``true`` only
   if every non-dummy atom has a non-zero radius. When ``all`` is ``false``,
   the function returns ``true`` if any non-dummy atom has a non-zero radius.

   .. note::

      Dummy atoms (atomic number :oe:const:`OEChem::OEElemNo::Du`) are
      excluded from the check.

   .. seealso::

      * :oe:func:`OEChem::OEAssignRadii`
      * :oe:meth:`OEChem::OEAtomBase::GetRadius`
      * :ref:`section_periodictable_atomradius` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasResidue

.. oe:function:: OEHasResidue

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasResidue(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEHasResidue(atm: OEAtomBase) -> bool

   Checks whether an atom has any biopolymer residue information
   associated with it.

   .. seealso::

      * :ref:`OEResidue <OEChem_OEResidue>` class
      * :oe:func:`OEChem::OEAtomGetResidue` function
      * :oe:func:`OEChem::OEAtomSetResidue` function



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasResidues

.. _OEChem_OEHasResidues:

.. oe:function:: OEHasResidues

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasResidues(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasResidues(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Checks whether any of the atoms of a molecule have any biopolymer
   residue information associated with them.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasSDData

.. oe:function:: OEHasSDData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasSDData(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasSDData(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Determines whether a molecule has any SD data.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasSDData(const OEMolBase& mol, const std::string& tag)

   .. oe:language:: python

      .. oe:api:: python

         OEHasSDData(mol: Union[OEGraphMol,OEMol,OEQMol], tag: str) -> bool

   Determines whether a molecule has SD data with a given tag.

   .. seealso::

      * :ref:`section_moltaggeddata_SD` section

   .. admonition:: Code Example

      * :ref:`section_example_oechem_sdfrename` example
      * :ref:`section_example_oechem_sdfilter` example


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasSingleBond

.. oe:function:: OEHasSingleBond

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasSingleBond(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEHasSingleBond(atm: OEAtomBase) -> bool

   Determines whether an atom is connected by one or more single bonds.
   This function returns ``true`` if the atoms implicit hydrogen count is
   non-zero.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasStereoHydrogens

.. oe:function:: OEHasStereoHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasStereoHydrogens(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEHasStereoHydrogens(atm: OEAtomBase) -> bool

   Returns whether the heavy atom passed in the argument has a hydrogen
   attached that is required to properly specify a stereo-center.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasStyle

.. oe:function:: OEHasStyle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasStyle(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasStyle(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns a boolean that indicates whether the :ref:`OEMolBase <OEChem_OEMolBase>` 
   has a :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasTokenizer

.. oe:function:: OEHasTokenizer

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasTokenizer(unsigned int fmt)

   .. oe:language:: python

      .. oe:api:: python

         OEHasTokenizer(fmt: int) -> bool



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHasTripleBond

.. oe:function:: OEHasTripleBond

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasTripleBond(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEHasTripleBond(atm: OEAtomBase) -> bool

   Determines whether an atom is connected by one or more triple
   bonds.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEChem

.. oe:function:: OEHelmToMol

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHelmToMol(OEMolBase& mol, const std::string& helm,
                          const OEMonomerSet& monomers)
         bool OEHelmToMol(OEMolBase& mol, const std::string& helm,
                          const OEMonomerSet& monomers,
                          OEHelmParsingResult& result)

   .. oe:language:: python

      .. oe:api:: python

         OEHelmToMol(mol: Union[OEGraphMol,OEMol,OEQMol], helm: str,
                     monomers: OEMonomerSet) -> bool
         OEHelmToMol(mol: Union[OEGraphMol,OEMol,OEQMol], helm: str,
                     monomers: OEMonomerSet, result: OEHelmParsingResult) -> bool

   Converts a :term:`HELM` string into a molecule. The function will return true
   if the :term:`HELM` string can be parsed and interpreted successfully, otherwise
   the function will return false and a given molecule will be cleared.

   mol
    The constructed molecule (:oe:cls:`OEChem::OEMolBase`).

   helm
    The :term:`HELM` string that is parsed into the molecule. 

   monomers
    The monomer set (:oe:cls:`OEChem::OEMonomerSet`) that stores the monomers that
    are used to interpret the :term:`HELM` string.

    If the given monomer set supports multiple code sets, :oe:func:`OEChem::OEHelmToMol` automatically
    selects the code set that contains all monomer codes needed to parse the :term:`HELM` string.

   result
    Is specified, the :oe:cls:`OEChem::OEHelmParsingResult` object will store additional
    parsing information.

   After constructing the molecule the following properties are perceived:

   * Rings are perceived by calling the
     :oe:func:`OEChem::OEFindRingAtomsAndBonds` function.

   * The aromaticity is assigned by calling the
     :oe:func:`OEChem::OEAssignAromaticFlags` function using the
     :oe:const:`OEChem::OEAroModel::OpenEye` aromaticity model.

   * The chirality is perceived by calling the
     :oe:func:`OEChem::OEPerceiveChiral` function.

   .. warning::

      The current implementation of HELM parsing algorithm does not support ``RNA`` polymers.

   **Example**

   .. oe:source:: HelmToMol.py
      :language: python
      :noindent:
      :frag:     SNIPPET

   .. oe:source:: HelmToMol.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET

   :oe:func:`OEChem::OEHelmToMol` can parse :term:`HELM` strings with embedded SMILES in various styles.
   The examples below illustrate valid representations of eledoisin:

   .. code-block:: text
      :linenos:

      PEPTIDE1{[N1[C@@H](CCC1=O)C([R2])=O].P.S.K.D.A.F.I.G.L.M.[am]}$$$$
      PEPTIDE1{[N1[C@@H](CCC1=O)C([*:2])=O].P.S.K.D.A.F.I.G.L.M.[am]}$$$$
      PEPTIDE1{[N1[C@@H](CCC1=O)C(*)=O |$;;;;;;;_R2;$|].P.S.K.D.A.F.I.G.L.M.[am]}$$$$

   In case when the :oe:func:`OEChem::OEHelmToMol` function successfully parses a :term:`HELM` string
   the atoms that are generated for a specific monomer are added to a molecule
   as a group (:oe:cls:`OEChem::OEGroupBase`)

   .. seealso::

      * [Zhang-2012]_ publications
      * :oe:func:`OEChem::OEGetHelmMonomerCodes` function
      * :oe:func:`OEChem::OEGetHelmChainNames` function
      * :oe:func:`OEChem::OEMolToHelm` function

   .. admonition:: OpenEye Python Cookbook Code Example

      * `Convert HELM to SMILES`_
      * `Convert HELM File to Molecule File`_



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEHistogramFormula

.. oe:function:: OEHistogramFormula

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEHistogramFormula(std::string& str, const unsigned int* hist,
                                 int charge)

   .. oe:language:: python

      .. oe:api:: python

         OEHistogramFormula(str: str, hist: int, charge: int) -> None


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEInChIToMol

.. oe:function:: OEInChIToMol

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEInChIToMol(OEMolBase& mol, const std::string& str)

   .. oe:language:: python

      .. oe:api:: python

         OEInChIToMol(mol: Union[OEGraphMol,OEMol,OEQMol], str: str) -> bool

   Converts an :term:`InChI` string into a molecule.
   After constructing the molecule the following properties are perceived:

   * Rings are perceived by calling the
     :oe:func:`OEChem::OEFindRingAtomsAndBonds` function.

   * The aromaticity is assigned by calling the
     :oe:func:`OEChem::OEAssignAromaticFlags` function using the
     :oe:const:`OEChem::OEAroModel::OpenEye` aromaticity model.

   * The chirality is perceived by calling the
     :oe:func:`OEChem::OEPerceiveChiral` function.

   The molecule object is cleared before parsing so the resulting molecule
   object only contains atoms and bonds from the :term:`InChI`.  If one
   wishes to *add* atoms and bonds to an existing molecule, one can use
   the lower-level :oe:func:`OEChem::OEParseInChI` function, which preserves
   any existing atoms and bonds in the molecule.

   .. seealso::

      * :oe:func:`OEChem::OEMolToInChI` function
      * :oe:func:`OEChem::OEMolToSTDInChI` function
      * :ref:`section_molctordtor_inchifrommol` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEInit2DRingDictionary

..  _oechem_oeinit2dringdictionary:

.. oe:function:: OEInit2DRingDictionary

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEInit2DRingDictionary(oemolistream& ims)
         bool OEInit2DRingDictionary(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEInit2DRingDictionary(ims: oemolistream) -> bool
         OEInit2DRingDictionary(filename: str) -> bool

   Initializes the **global** ring dictionary with the ring layouts stored
   in the given file.
   After initialization, the user-defined ring layouts will have priority over
   the built-in ring templates of **OEChem TK** when calling the
   :oe:func:`OEChem::OEGenerate2DCoordinates` function to generate 2D coordinates.

   .. seealso::

      * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
      * :oe:func:`OEChem::OEIsValid2DRingDictionary` function
      * :oe:func:`OEChem::OEClear2DRingDictionary` function

      2D ring dictionary files can be generated with the following programs:

      .. oe:language:: c++

         * Example program :ref:`createringdict.cpp<section_example_oechem_createringdict>`
         * Example program :ref:`appendringdict.cpp<section_example_oechem_appendringdict>`

      .. oe:language:: python

         * Example program :ref:`createringdict.py<section_example_oechem_createringdict>`
         * Example program :ref:`appendringdict.py<section_example_oechem_appendringdict>`

      .. oe:language:: java

         * Example program :ref:`CreateRingDict.java<section_example_oechem_createringdict>`
         * Example program :ref:`AppendRingDict.java<section_example_oechem_appendringdict>`

      .. oe:language:: csharp

         * Example program :ref:`CreateRingDict.cs<section_example_oechem_createringdict>`
         * Example program :ref:`AppendRingDict.cs<section_example_oechem_appendringdict>`

      The program below shows how to generate 2D coordinates with user-defined
      ring layouts:

      .. oe:language:: c++

         * Example program :ref:`generate2D.cpp<section_example_oechem_generate2D>`

      .. oe:language:: python

         * Example program :ref:`generate2D.py<section_example_oechem_generate2D>`

      .. oe:language:: java

         * Example program :ref:`Generate2D.java<section_example_oechem_generate2D>`

      .. oe:language:: csharp

         * Example program :ref:`Generate2D.cs<section_example_oechem_generate2D>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEInitDefaultHandler

.. oe:function:: OEInitDefaultHandler

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEInitDefaultHandler(OESystem::OEBinaryIOHandlerBase& hand,
                                   bool compressMCMol = false,
                                   bool useZstd = false)

   .. oe:language:: python

      .. oe:api:: python

         OEInitDefaultHandler(hand: OEBinaryIOHandlerBase,
                              compressMCMol: bool = False,
                              useZstd: bool = False) -> bool

   This function is equivalent to calling
   :oe:func:`OEChem::OEInitHandler` with the return value of
   :oe:func:`OEChem::OEBDefaultOpts` as both arguments.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEInitHandler

.. oe:function:: OEInitHandler

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEInitHandler(OESystem::OEBinaryIOHandlerBase& hand,
                            const char* readOptHex, const char* writeOptHex)

   .. oe:language:: python

      .. oe:api:: python

         OEInitHandler(hand: OEBinaryIOHandlerBase, readOptHex: str,
                       writeOptHex: str) -> bool

   Initialize the :ref:`OEBinaryIOHandlerBase <OESystem_OEBinaryIOHandlerBase>` with all
   the handlers specified by the options ``readOptHex`` and
   ``writeOptHex`` for reading and writing OEB files. The hex strings
   passed in as arguments specify which handlers should be used. The
   hex strings should be the return value of one of the following
   functions:

   - :oe:func:`OEChem::OEBDefaultOpts`
   - :oe:func:`OEChem::OEBGZipCompressOpts`
   - :oe:func:`OEChem::OEBRotCompressOpts`
   - :oe:func:`OEChem::OEBAtomIntTypeOpts`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEInvertCenter

.. oe:function:: OEInvertCenter

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEInvertCenter(OEMolBase& mol, const OEAtomBase* atom)
         bool OEInvertCenter(OEMolBase& mol, const OEAtomBase* atom,
                             const OEAtomBase* ref1, const OEAtomBase* ref2)

   .. oe:language:: python

      .. oe:api:: python

         OEInvertCenter(mol: Union[OEGraphMol,OEMol,OEQMol], atom: OEAtomBase) -> bool
         OEInvertCenter(mol: Union[OEGraphMol,OEMol,OEQMol], atom: OEAtomBase,
                        ref1: OEAtomBase, ref2: OEAtomBase) -> bool

   These functions perform a geometric inversion around the atom passed
   as the second argument.  The second overloaded function allows the
   reference atoms that are held fixed during the inversion to be
   specified as the third and fourth arguments.  The functions return ``true``
   if inversion completes successfully.  The functions return ``false`` if
   the center is not either degree three or degree four, if the reference atoms
   are invalid, if the center to invert has more than two rings bonds, or
   if a geometric inversion is ill defined.

   *mol*
      The molecule on which to perform inversion.

   *atom*
      The atom around which to perform the geometric inversion.

   *ref1*
      The first reference atom to be held fixed.

   *ref1*
      The second reference atom to be held fixed.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIs2DFormat

.. oe:function:: OEIs2DFormat

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIs2DFormat(unsigned int format)

   .. oe:language:: python

      .. oe:api:: python

         OEIs2DFormat(format: int) -> bool

   Returns ``true`` if the specified file format can contain 2D coordinates.
   The parameter value should be drawn from the
   :ref:`the OEFormat namespace <OEChem_OEFormat>`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIs3DFormat

.. oe:function:: OEIs3DFormat

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIs3DFormat(unsigned int format)

   .. oe:language:: python

      .. oe:api:: python

         OEIs3DFormat(format: int) -> bool

   Returns ``true`` if the specified file format can contain 3D coordinates.
   The parameter value should be drawn from the
   :ref:`the OEFormat namespace <OEChem_OEFormat>`.

   .. seealso::

      .. oe:language:: c++

         * Example program :ref:`smartsalign.cpp<section_example_oechem_smartsalign>`

      .. oe:language:: python

         * Example program :ref:`smartsalign.py<section_example_oechem_smartsalign>`

      .. oe:language:: java

         * Example program :ref:`SMARTSAlign.java<section_example_oechem_smartsalign>`

      .. oe:language:: csharp

         * Example program :ref:`SMARTSAlign.cs<section_example_oechem_smartsalign>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsBinary

.. oe:function:: OEIsBinary

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsBinary(unsigned int format)

   .. oe:language:: python

      .. oe:api:: python

         OEIsBinary(format: int) -> bool

   Returns ``true`` if the specified file format is a binary format.  The
   parameter value should be drawn from the :oe:constns:`OEChem::OEFormat`
   namespace.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsCIFHeaderCompliant

.. oe:function:: OEIsCIFHeaderCompliant

   .. oe:language:: c++

       .. oe:api:: c++

          bool OEIsCIFHeaderCompliant(OEMolBase& mol,
                                      const string& cifDictionaryFilename,
                                      vector<string>& failCategories)

   .. oe:language:: python

       .. oe:api:: python

          OEIsCIFHeaderCompliant(mol: Union[OEGraphMol,OEMol,OEQMol],
                                 filename: str) -> list

   Checks if mmCIF header metadata stored on the molecule is compliant with the input dictionary of supported
   CIF categories. The latest version of this dictionary can be found on the
   `RCSB user guide <https://mmcif.wwpdb.org/dictionaries/downloads.html>`_

   .. seealso::

      * :oe:func:`OEChem::OEGetMMCIFData` function to get mmCIF data
      * :oe:func:`OEChem::OESetMMCIFData` function to add mmCIF data
      * :ref:`section_moldata_MMCIF` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsCommonIsotope

.. oe:function:: OEIsCommonIsotope

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsCommonIsotope(unsigned int elemno, unsigned int mass)

   .. oe:language:: python

      .. oe:api:: python

         OEIsCommonIsotope(elemno: int, mass: int) -> bool

   Determine whether the isotope specified by the atomic number ('elemno'),
   and atomic mass ('mass') is a valid combination.
   This list is derived from high-energy physics experiments, and is useful
   for checking whether the masses provided on radioisotopes are within
   the expected range.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

..  _OEChem_OEIsComplementaryScreenType:

.. oe:function:: OEIsComplementaryScreenType

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsComplementaryScreenType(const OEQMolBase& qmol,
                                          const unsigned stype)
         bool OEIsComplementaryScreenType(const OEQMolBase& qmol,
                                          const OESubSearchScreenTypeBase* stype)

   .. oe:language:: python

      .. oe:api:: python

         OEIsComplementaryScreenType(arg1: OEQMol, stype: int) -> bool
         OEIsComplementaryScreenType(arg1: OEQMol,
                                     stype: OESubSearchScreenTypeBase) -> bool

   Returns whether the given query molecule can be used with a certain screen type.
   The function determines this by examining all the atom and bond expressions of the
   query molecule.
   For more explanation, see the :oe:constns:`OEChem::OESubSearchScreenType` namespace.

   qmol
     The query molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`)

   stype
     The type of the screen (either from the :oe:constns:`OEChem::OESubSearchScreenType` namespace
     or as an internal :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>` type).

   .. oe:language:: c++ python

      **Example**

      .. oe:source:: ComplementaryScreen.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET

      .. oe:source:: ComplementaryScreen.py
         :language: python
         :noindent:
         :frag:     SNIPPET

      The above code snippet will generate the following output.

      .. code-block:: console

         SMARTS SubSearch Screen screen type is complementary

   .. seealso::

      * :oe:constns:`OEChem::OESubSearchScreenType` namespace
      * :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>` class


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsExtension

.. oe:function:: OEIsExtension

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsExtension(const char* fname)

   .. oe:language:: python

      .. oe:api:: python

         OEIsExtension(fname: str) -> bool



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsGZip

.. oe:function:: OEIsGZip

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsGZip(const char *)

   .. oe:language:: python

      .. oe:api:: python

         OEIsGZip(arg1: str) -> bool



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEIsPeptide

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsPeptide(const OEMolBase &, const OEMonomerSet& monomers,
                          double ratio = 0.8)

   .. oe:language:: python

      .. oe:api:: python

         OEIsPeptide(arg1: Union[OEGraphMol,OEMol,OEQMol],
                     monomers: OEMonomerSet, ratio: float = 0.8) -> bool

   Determines whether the given molecule can be classified as a peptide with respect to the specified monomers. 
   The function identifies backbone peptide monomers within the molecule to determine which atoms may belong 
   to the peptide. 
   If the ratio of matched atoms to total heavy atoms exceeds the specified threshold, 
   the function returns true.

   mol
    The input molecule (:oe:cls:`OEChem::OEMolBase`).

   monomers
    The monomer set (:oe:cls:`OEChem::OEMonomerSet`) that stores the monomers that
    are used to interpret the :term:`HELM` string.
 
   ratio
    Specifies the minimum `heavy atoms` to `matched monomer atoms` ratio 
    required for a molecule to be considered a peptide. 
    The ratio must fall within the range [0.25,0.90].


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsReadable

.. oe:function:: OEIsReadable

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsReadable(unsigned int format)
         bool OEIsReadable(const std::string& filename)
         bool OEIsReadable(unsigned int format, unsigned int flavor)
         bool OEIsReadable(const std::string& filename, unsigned int flavor)

   .. oe:language:: python

      .. oe:api:: python

         OEIsReadable(format: int) -> bool
         OEIsReadable(filename: str) -> bool
         OEIsReadable(format: int, flavor: int) -> bool
         OEIsReadable(filename: str, flavor: int) -> bool

   Returns ``true`` if the supplied file format is readable by **OEChem TK** via :oe:func:`OEChem::OEReadMolecule`. The
   'filename' can be a file name or a file extension.  The 'format'
   parameter value should be drawn from the :oe:constns:`OEChem::OEFormat`
   namespace.

   .. seealso::

      * :oe:func:`OEChem::OEReadMolecule` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsSDDataFormat, SD data

.. oe:function:: OEIsSDDataFormat

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsSDDataFormat(unsigned int format)

   .. oe:language:: python

      .. oe:api:: python

         OEIsSDDataFormat(format: int) -> bool

   Returns ``true`` if the specified file format can contain SD data.
   The parameter value should be drawn from the :ref:`OEFormat namespace <OEChem_OEFormat>`.

   .. seealso::

      * :ref:`section_moltaggeddata_SD` section



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEIsStandardMonomer

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsStandardMonomer(const std::string& monomerCanSmiles)

   .. oe:language:: python

      .. oe:api:: python

         OEIsStandardMonomer(monomerCanSmiles: str) -> bool

   Returns true for the canonical smiles of the 20 standard amino acids.

   .. seealso::

      * :oe:func:`OEChem::OEGetStandardAnalog` function



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsTerminalOxygen

.. oe:function:: OEIsTerminalOxygen

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsTerminalOxygen(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEIsTerminalOxygen(atm: OEAtomBase) -> bool



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsTerminalSulfur

.. oe:function:: OEIsTerminalSulfur

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsTerminalSulfur(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEIsTerminalSulfur(atm: OEAtomBase) -> bool



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsValid2DRingDictionary

.. oe:function:: OEIsValid2DRingDictionary

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsValid2DRingDictionary(oemolistream& ifs)
         bool OEIsValid2DRingDictionary(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEIsValid2DRingDictionary(ifs: oemolistream) -> bool
         OEIsValid2DRingDictionary(filename: str) -> bool

   Returns true is the given file is a valid 2D ring dictionary.

   .. seealso::

      * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
      * :ref:`OEInit2DRingDictionary <OEChem_OEInit2DRingDictionary>` class

      2D ring dictionary files can be generated with the following programs:

      .. oe:language:: c++

         * Example program :ref:`createringdict.cpp<section_example_oechem_createringdict>`
         * Example program :ref:`appendringdict.cpp<section_example_oechem_appendringdict>`

      .. oe:language:: python

         * Example program :ref:`createringdict.py<section_example_oechem_createringdict>`
         * Example program :ref:`appendringdict.py<section_example_oechem_appendringdict>`

      .. oe:language:: java

         * Example program :ref:`CreateRingDict.java<section_example_oechem_createringdict>`
         * Example program :ref:`AppendRingDict.java<section_example_oechem_appendringdict>`

      .. oe:language:: csharp

         * Example program :ref:`CreateRingDict.cs<section_example_oechem_createringdict>`
         * Example program :ref:`AppendRingDict.cs<section_example_oechem_appendringdict>`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. _OEChem_OEIsValidMonomerData:

.. meta::
   :keywords: OEIsValidMonomerData

.. oe:function:: OEIsValidMonomerData
   
   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsValidMonomerData(const OEMonomerData& monomer)
         bool OEIsValidMonomerData(const OEMonomerData& monomer,
                                   OEMonomerValidationResult& result)

   .. oe:language:: python

      .. oe:api:: python

         OEIsValidMonomerData(monomer: OEMonomerData) -> bool
         OEIsValidMonomerData(monomer: OEMonomerData,
                              result: OEMonomerValidationResult) -> bool

   Returns whether the :oe:cls:`OEChem::OEMonomerData` object is fully defined 
   and correct.

   .. oe:source:: MakeAlanine.py
      :language: python
      :noindent:
      :frag:     SNIPPET

   .. oe:source:: MakeAlanine.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET
   
   .. seealso::

      * :oe:cls:`OEChem::OEMonomerData` class
      * :oe:cls:`OEChem::OEMonomerValidationResult` class 
        and :oe:constns:`OEChem::OEMonomerValidationReturnCode` namespace 

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

..  _OEChem_OEIsValidSubSearchDatabase:

.. oe:function:: OEIsValidSubSearchDatabase

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsValidSubSearchDatabase(oemolistream& ifs)
         bool OEIsValidSubSearchDatabase(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEIsValidSubSearchDatabase(filename: str) -> bool
         OEIsValidSubSearchDatabase(ifs: oemolistream) -> bool

   Returns ``true`` if the given molecule stream or the file is a valid
   substructure search database that was created by the
   :oe:func:`OEChem::OECreateSubSearchDatabaseFile` function.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsValidSubSearchDatabase(oemolistream& ifs,
                                         const OESubSearchScreenTypeBase *)
         bool OEIsValidSubSearchDatabase(const std::string& filename,
                                         const OESubSearchScreenTypeBase *)

   .. oe:language:: python

      .. oe:api:: python

         OEIsValidSubSearchDatabase(filename: str,
                                    arg2: OESubSearchScreenTypeBase) -> bool
         OEIsValidSubSearchDatabase(ifs: oemolistream,
                                    arg2: OESubSearchScreenTypeBase) -> bool

   Returns ``true`` if the given molecule stream or the file is a valid
   substructure search database that was created by the
   :oe:func:`OEChem::OECreateSubSearchDatabaseFile` function.
   These functions also check if the database stores substructure search
   screens with the given type.

   .. seealso::

      * :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>` class

   .. admonition:: Code Example

      * :ref:`section_example_oechem_searchfastss` example


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

..  _OEChem_OEIsValidSubSearchScreenString:

.. oe:function:: OEIsValidSubSearchScreenString

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsValidSubSearchScreenString(const std::string& stypestr)

   .. oe:language:: python

      .. oe:api:: python

         OEIsValidSubSearchScreenString(stypestr: str) -> bool

   Returns ``true`` if the given string is a valid representation of any
   available screen type.

.. seealso::

   * :oe:func:`OEChem::OEGetSubSearchScreenType` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsWriteable

.. oe:function:: OEIsWriteable

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsWriteable(unsigned int format)
         bool OEIsWriteable(const std::string& filename)
         bool OEIsWriteable(unsigned int format, unsigned int flavor)
         bool OEIsWriteable(const std::string& filename, unsigned int flavor)

   .. oe:language:: python

      .. oe:api:: python

         OEIsWriteable(format: int) -> bool
         OEIsWriteable(filename: str) -> bool
         OEIsWriteable(format: int, flavor: int) -> bool
         OEIsWriteable(filename: str, flavor: int) -> bool

   Returns ``true`` if the supplied file format is writable by **OEChem TK** via :oe:func:`OEChem::OEWriteMolecule`. The
   'filename' can be a file name or a file extension.  The 'format'
   parameter value should be drawn from the :oe:constns:`OEChem::OEFormat`
   namespace.

   .. seealso::

      * :oe:func:`OEChem::OEWriteMolecule` function



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEKekulize

.. oe:function:: OEKekulize

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEKekulize(OEMolBase &)

   .. oe:language:: python

      .. oe:api:: python

         OEKekulize(arg1: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Determine a valid |Kekule| form for a molecule.  On input, the integer
   bond types of each bond should be set to ``1`` for single, ``2`` for double, ``3``
   for triple, ``4`` for quadruple and ``5`` for an aromatic (or resonant bond).
   On output, the bond order property of each bond is set to the integer
   bond types, except for bonds marked type ``5``, which are assigned as
   either single or double as required.  The formal charges and implicit
   hydrogen counts of each atom must be correctly specified prior to
   calling this function. The
   :oe:func:`OEChem::OEKekulize` function returns false and throws a warning
   if the integer bond types are not set correctly. Newly created bonds will
   have their integer types set to ``0``    by default. These will need to be
   set to the appropriate values before calling :oe:func:`OEChem::OEKekulize`;
   see the :ref:`section_kekule_assignment_of_new_bonds` section for examples.

   Note that this function will not clear the aromatic flags associated
   with atoms and bonds.  These flags may affect resulting output
   (*e.g.* :term:`SMILES`) or downstream processing.  So, if these effects are not
   desired, the function :oe:func:`OEChem::OEClearAromaticFlags` should be
   used.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`cansmi.cpp<section_example_oechem_cansmi>`

  .. oe:language:: python

      * Example program :ref:`cansmi.py<section_example_oechem_cansmi>`

  .. oe:language:: java

      * Example program :ref:`CanSmi.java<section_example_oechem_cansmi>`

  .. oe:language:: csharp

      * Example program :ref:`CanSmi.cs<section_example_oechem_cansmi>`

.. ################################################################
   #
   ################################################################



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OELoadOpenEyeMonomerSet

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OELoadOpenEyeMonomerSet(OEMonomerSet& monomers)

   .. oe:language:: python

      .. oe:api:: python

         OELoadOpenEyeMonomerSet(monomers: OEMonomerSet) -> bool

   Loads the built-in ``OpenEye`` monomer set containing more than 260 diverse monomers
   that are common in macro-cyclic peptide projects. This monomer set defines four code-sets:

   * ``OpenEye`` - the primary code-set, the codes assigned to monomers follow naming conventions defined in [Ghiandoni-2026]_
   * ``Standard`` - 20 standard amino-acids with universally accepted one-letter codes, such as ``C`` for cystine
   * ``PDB`` - monomer that also exists in PDB database with a three-letter code, such as ``CYS`` for cystine
   * ``ChEMBL`` - monomer that also exists in the monomer dictionary of  
     `CHEMBL36 <https://chembl.gitbook.io/chembl-interface-documentation/downloads>`_.

   .. figure:: oechemtk/images/dNMePhe.*
      :width: 500
      :align:  center

      **Example of monomer that occurs in different code-sets in the OpenEye monomer set**

   .. warning::

      The built-in ``OpenEye`` monomer set is intended primarily for testing, illustrating how OEChem handles
      diverse peptide structures during :term:`HELM` parsing and generation, and providing a template for constructing
      private monomer sets.

      Because this monomer set is **subject to change**, we strongly discourage our customers from relying on it in 
      their production workflows.
      Monomers in this set may be added, removed, or modified  between releases.
      Instead, users should define, validate, and maintain their own custom monomer set so they
      can control which monomers are included and adopt naming conventions that match their organizational 
      standards.

   .. seealso::

      * :oe:cls:`OEChem::OEMonomerSet` class
      * :oe:func:`OEChem::OEReadMonomerSet` function
      * :oe:func:`OEChem::OELoadStandardMonomerSet` function
   
   .. only:: oehtml

      .. admonition:: Download JSON file of built-in OpenEye monomer set

         :download:`monomers-openeye.json <../../../../../sublibs/tklibs/oechem/peptide/data/monomers-openeye.json>`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OELoadStandardMonomerSet

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OELoadStandardMonomerSet(OEMonomerSet& monomers)

   .. oe:language:: python

      .. oe:api:: python

         OELoadStandardMonomerSet(monomers: OEMonomerSet) -> bool

   Loads the built-in ``Standard`` monomer set containing 20 standard amino acids.

   .. seealso::

      * :oe:cls:`OEChem::OEMonomerSet` class
      * :oe:func:`OEChem::OEReadMonomerSet` function
      * :oe:func:`OEChem::OELoadOpenEyeMonomerSet` function

   .. only:: oehtml

      .. admonition:: Download JSON file of built-in ``Standard`` monomer set

         :download:`monomers-standard.json <../../../../../sublibs/tklibs/oechem/peptide/data/monomers-standard.json>`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMDLClearBondStereo

.. oe:function:: OEMDLClearBondStereo

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMDLClearBondStereo(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMDLClearBondStereo(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Clears the bond stereo fields from all bonds of a molecule.

   .. seealso::

      * :oe:func:`OEChem::OEMDLPerceiveBondStereo` function
      * :oe:constns:`OEChem::OEBondStereo`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMDLClearParity

.. oe:function:: OEMDLClearParity

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEMDLClearParity(OEMolBase& mol)
         void OEMDLClearParity(OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMDLClearParity(mol: Union[OEGraphMol,OEQMol]) -> None

   Clears the MDL chiral flag, and atom stereo parity fields from all atoms
   of a molecule.

   The :ref:`OEMCMolBase <OEChem_OEMCMolBase>` overload of this function clears the MDL chiral flag
   on **all** conformers in the multi-conformer molecule.

   .. seealso::

      * :oe:func:`OEChem::OEMDLPerceiveParity` function
      * :oe:func:`OEChem::OEMDLHasParity` function
      * :oe:func:`OEChem::OEMDLSetParity` and :oe:func:`OEChem::OEMDLGetParity` functions


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMDLCorrectBondStereo

.. oe:function:: OEMDLCorrectBondStereo

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMDLCorrectBondStereo(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMDLCorrectBondStereo(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   This function tries to correct the wedge/hash bond assignment of the
   molecule, inverting or removing wedges and hashes from the connection
   table to avoid inconsistent or ambiguous stereochemistry assignment.
   This function requires that the molecule have 2D coordinates.
   See example in :ref:`Figure: Example of using OEMDLCorrectBondStereo<figure_OEMDLCorrectBondStereo>`

   .. _figure_OEMDLCorrectBondStereo:

   .. figure:: oechemtk/images/OEMDLCorrectBondStereo.*
      :scale:  100
      :align:  center

      **Example of using OEMDLCorrectBondStereo: before (A) and after (B) calling the OEMDLCorrectBondStereo function**



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMDLGetParity

.. oe:function:: OEMDLGetParity

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMDLGetParity(const OEMolBase& mol)
         bool OEMDLGetParity(const OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMDLGetParity(mol: Union[OEGraphMol,OEQMol]) -> bool

   Returns the MDL 'chiral' flag status for a molecule.  After reading from an
   MDL connection table this value is ``true`` if the chiral flag was 'on' in
   the header, indicating absolute stereochemistry for marked stereocenters.
   This value is ``false`` if the chiral flag setting was 'off' in the header,
   indicating relative stereochemistry for marked stereocenters. After calling the
   :oe:func:`OEChem::OEMDLPerceiveParity` function this value is forced to ``true``
   if any non-zero atom stereo parity values have been assigned.  The function
   :oe:func:`OEChem::OEMDLHasParity` returns whether the 'chiral' flag status is
   available, which may indicate the structure originated from an MDL structure file.
   If :oe:func:`OEChem::OEMDLHasParity` is ``false``, this function will also
   return ``false`` by default.

   The :ref:`OEMCMolBase <OEChem_OEMCMolBase>` overload of this function returns the 'chiral' flag status
   of the **active** conformer in the multi-conformer molecule.

   .. seealso::

      * :oe:func:`OEChem::OEMDLPerceiveParity` function
      * :oe:func:`OEChem::OEMDLHasParity` and :oe:func:`OEChem::OEMDLSetParity` functions
      * :oe:func:`OEChem::OEMDLClearParity` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMDLGetValence

.. oe:function:: OEMDLGetValence

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEMDLGetValence(unsigned int atomicnum, int charge,
                                      unsigned int minvalence)

   .. oe:language:: python

      .. oe:api:: python

         OEMDLGetValence(elemno: int, charge: int, minval: int) -> int

   Returns the **MDL valence** for the given parameters.

   **elemno**
      The atomic number returned by the :oe:meth:`OEChem::OEAtomBase::GetAtomicNum` method.

   **charge**
      The formal charge returned by the :oe:meth:`OEChem::OEAtomBase::GetFormalCharge` method.

   **minvalence**
     The minimum valence.

   For example, :oe:func:`OEChem::OEMDLGetValence` will return ``4``
   in the case of the following input parameters:

   * atomic number: :oe:const:`OEChem::OEElemNo::N`
   * formal charge: "+1"
   * minimum valence: three single bonds to heavy atoms (value returned by the
     :oe:meth:`OEChem::OEAtomBase::GetExplicitDegree` method)

   This means that the atom has correct valence only if it has either one implicit
   or one explicit hydrogen.

   .. seealso::

      * :ref:`section_valence_mdl` section
      * :oe:func:`OEChem::OEDefaultMDLHCount` function
      * :oe:func:`OEChem::OEAssignMDLHydrogens` function
      * :oe:cls:`OEChem::OEIsValidMDLAtomValence` predicate 



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMDLHasIncorrectBondStereo

.. oe:function:: OEMDLHasIncorrectBondStereo

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMDLHasIncorrectBondStereo(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMDLHasIncorrectBondStereo(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Checks whether the wedge/hash bond assignment of the molecule is
   inconsistent or ambiguous.  This function requires that the molecule
   have 2D coordinates.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMDLHasParity

.. oe:function:: OEMDLHasParity

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMDLHasParity(const OEMolBase& mol)
         bool OEMDLHasParity(const OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMDLHasParity(mol: Union[OEGraphMol,OEQMol]) -> bool

   Checks for the availability of the MDL 'chiral' flag for a molecule.
   After reading from an MDL connection table this value is ``true``, and
   ``false`` if the molecule did not originate from an MDL file or if the 'chiral'
   flag has been cleared. Calling the :oe:func:`OEChem::OEMDLGetParity`
   function will return the actual on/off value of the 'chiral' flag from the MDL
   file header. After calling the :oe:func:`OEChem::OEMDLClearParity`
   this function will return ``false``.

   The :ref:`OEMCMolBase <OEChem_OEMCMolBase>` overload of this function checks the 'chiral' flag availability
   for the **active** conformer in the multi-conformer molecule.

   .. seealso::

      * :oe:func:`OEChem::OEMDLPerceiveParity` function
      * :oe:func:`OEChem::OEMDLSetParity` and :oe:func:`OEChem::OEMDLGetParity` functions
      * :oe:func:`OEChem::OEMDLClearParity` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMDLPerceiveBondStereo

.. oe:function:: OEMDLPerceiveBondStereo

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMDLPerceiveBondStereo(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMDLPerceiveBondStereo(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Assigns wedge and hash bonds to a connection table from
   the **OEChem TK** stereochemistry of each atom.
   This function requires that the molecule have 2D coordinates.
   See example in :ref:`Figure: Example of using OEMDLPerceiveBondStereo<figure_OEMDLPerceiveBondStereo>`

   .. _figure_OEMDLPerceiveBondStereo:

   .. figure:: oechemtk/images/OEMDLPerceiveBondStereo.*
      :scale:  100
      :align:  center

      **Example of using OEMDLPerceiveBondStereo: before (A) and after (B) calling the OEMDLPerceiveBondStereo function**

   .. note::

      This function is the opposite of the
      :oe:func:`OEChem::OEMDLStereoFromBondStereo` function.

   .. seealso::

      * :oe:constns:`OEChem::OEBondStereo` namespace

   .. note::

      The :oe:func:`OEChem::OEMDLPerceiveBondStereo` function preserves wavy bonds
      (:oe:const:`OEChem::OEBondStereo::Wavy`).
      These can only be removed by calling the
      :oe:func:`OEChem::OEMDLClearBondStereo` function.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMDLPerceiveParity

.. oe:function:: OEMDLPerceiveParity

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEMDLPerceiveParity(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMDLPerceiveParity(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   This function sets the MDL stereo parity information for each atom
   from the **OEChem TK** stereochemistry.  Any atom that has tetrahedral stereo
   specified has the corresponding MDL stereo parity value, one or two, placed in its
   'MDLParity' generic data, with type ``unsigned int``.  This MDL stereo
   parity is relative to the current order of atoms returned by an
   iterator of atoms across a molecule.  All other atoms, non-chiral or
   without stereo specified, have their MDL stereo parity set to zero or three.

   :oe:func:`OEChem::OEMDLPerceiveParity` internally calls the
   :oe:func:`OEChem::OEPerceiveChiral` function, so there's no need to
   explicitly call :oe:func:`OEChem::OEPerceiveChiral` on a molecule prior
   to calling :oe:func:`OEChem::OEMDLPerceiveParity`.

   .. note::

      This function is the opposite of the
      :oe:func:`OEChem::OEMDLStereoFromParity` function.

   .. note::

      This function assumes that atoms have stereo parity values assigned explicitly.  This is generally automatic
      when reading structure file formats, or via generation of conformers.  For 3D structures
      from other sources, an explicit call to the :oe:func:`OEChem::OE3DToInternalStereo` function prior to
      calling this function may be required to ensure atom stereo parities are assigned based on the 3D coordinates.

   .. seealso::

      * :oe:func:`OEChem::OEMDLHasParity` function
      * :oe:func:`OEChem::OEMDLSetParity` and :oe:func:`OEChem::OEMDLGetParity` functions
      * :oe:func:`OEChem::OEMDLClearParity` function
      * :oe:func:`OEChem::OE3DToInternalStereo` function
      * :oe:func:`OEChem::OE3DToAtomStereo` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMDLSetParity

.. oe:function:: OEMDLSetParity

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMDLSetParity(OEMolBase& mol, bool value)
         bool OEMDLSetParity(OEMCMolBase& mol, bool value)

   .. oe:language:: python

      .. oe:api:: python

         OEMDLSetParity(mol: Union[OEGraphMol,OEQMol], value: bool) -> bool

   Sets the MDL 'chiral' flag status for a molecule to the passed value.
   Setting the value to ``true`` implies setting the chiral flag 'on' and indicates
   absolute stereochemistry for any marked stereocenters. :oe:func:`OEChem::OEMDLHasParity`
   will return true after setting a value via this function, and
   :oe:func:`OEChem::OEMDLGetParity` will return the value.
   :oe:func:`OEChem::OEMDLClearParity` will clear the property from the molecule.

   The :ref:`OEMCMolBase <OEChem_OEMCMolBase>` overload of this function sets the 'chiral' flag status
   of the **active** conformer in the multi-conformer molecule.

  .. seealso::

      * :oe:func:`OEChem::OEMDLPerceiveParity` function
      * :oe:func:`OEChem::OEMDLHasParity` and :oe:func:`OEChem::OEMDLGetParity` functions
      * :oe:func:`OEChem::OEMDLClearParity` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMDLStereoFromBondStereo

.. oe:function:: OEMDLStereoFromBondStereo

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMDLStereoFromBondStereo(OEMolBase& mol,
                                        bool alterBondMarks = false)

   .. oe:language:: python

      .. oe:api:: python

         OEMDLStereoFromBondStereo(mol: Union[OEGraphMol,OEMol,OEQMol],
                                   bAllowMarkCorrections: bool = False) -> bool

   Sets the **OEChem TK** stereochemistry of each atom from the
   wedge and hash bonds in the connection table. 
   See example in :ref:`Figure: Example of using default OEMDLStereoFromBondStereo<figure_OEMDLStereoFromBondStereo>`

   *mol*
     The molecule of which stereochemistry is being set.
     The given molecule has to have 2D coordinates.

   *alterBondMarks*
     The boolean argument controls whether an attempt should be made to repair stereocenters that throw warnings
     due to ambiguous bond marking patterns (disabled by default with alterBondMarks=``false``).
     If this action is enabled, warnings will continue to be issued to allow user inspection and verification
     of the modified bond marks.  However, once the corrected structure(s) have been rewritten
     with any format that captures bond stereomark information, a re-read of the structure(s)
     should emit fewer stereocenter correction warnings.  Enabling the bond mark alteration activity will
     aggressively attempt to repair ambiguous bond marking patterns by possibly applying more than one stereo mark, or marking ring bond(s).
     See example in :ref:`Figure: Example of enabling alterBondMarks OEMDLStereoFromBondStereo<figure_OEMDLStereoFromBondStereoFixMarks>`

   .. _figure_OEMDLStereoFromBondStereo:

   .. figure:: oechemtk/images/OEMDLStereoFromBondStereo.*
      :scale:  100
      :align:  center

      **Example of using default OEMDLStereoFromBondStereo behavior: before (A) and after (B) calling the OEMDLStereoFromBondStereo function**

   .. _figure_OEMDLStereoFromBondStereoFixMarks:

   .. figure:: oechemtk/images/OEMDLStereoFromBondStereoFixMarks.*
      :scale:  100
      :align:  center

      **Example of enabling alterBondMarks OEMDLStereoFromBondStereo behavior: before (A) and after (B) calling the OEMDLStereoFromBondStereo function**

   .. note::

      This function is the opposite of the
      :oe:func:`OEChem::OEMDLPerceiveBondStereo` function.

   .. seealso::

      * :ref:`chapter_atomstereo` chapter
      * :oe:constns:`OEChem::OEAtomStereo` namespace
      * :oe:const:`OEChem::OEIFlavor::SDF::FixBondMarks` input flavor



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMDLStereoFromParity

.. oe:function:: OEMDLStereoFromParity

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEMDLStereoFromParity(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMDLStereoFromParity(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   This function sets the **OEChem TK** stereochemistry for each atom from the
   MDL stereo parity information.

   .. note::

      This function is the opposite of the
      :oe:func:`OEChem::OEMDLPerceiveParity` function.

   .. seealso::

      * :oe:func:`OEChem::OEMDLHasParity` function
      * :oe:func:`OEChem::OEMDLSetParity` and :oe:func:`OEChem::OEMDLGetParity` functions
      * :oe:func:`OEChem::OEMDLClearParity` function



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMMFF94InitialCharges

.. oe:function:: OEMMFF94InitialCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMMFF94InitialCharges(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMMFF94InitialCharges(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Assigns integral or fractional formal atomic charges (for example +1/3 on guanidinium
   nitrogens), which are used in MMFF94 force field for obtaining final partial atomic charges
   applying bond charge increments. Requires a prior call of :oe:func:`OEChem::OEMMFFAtomTypes`.
   Charge 0.0 is assigned to any atom missing proper MMFF94 atom type.
   Returns ``true`` when charges are successfully assigned.

   .. note::

      This function assigns silently zero charges to all atoms if MMFF94 atom types are
      not assigned to the passed molecule.

   .. hint::

      :oe:func:`OEChem::OEMMFF94InitialCharges` is a low-level function, we highly recommend
      to assigning MMFF initial charges to a molecule by calling the
      :oe:func:`OEProton::OEAssignCharges` function with the
      :ref:`OEInitialCharges <OEProton_OEInitialCharges>` class of the **Quacpac TK**.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMMFF94PartialCharges

.. oe:function:: OEMMFF94PartialCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMMFF94PartialCharges(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMMFF94PartialCharges(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Assigns MMFF94 partial charges. Requires a prior call of :oe:func:`OEChem::OEMMFFAtomTypes`.
   Charge 0.0 is assigned to any atom missing proper MMFF94 atom type. Returns ``true`` when
   charges are successfully assigned.

   .. note::

      This function assigns silently zero charges to all atoms if MMFF94 atom types are
      not assigned to the passed molecule.

   .. hint::

      :oe:func:`OEChem::OEMMFF94PartialCharges` is a low-level function, we highly recommend
      to assigning MMFF partial charges to a molecule by calling the
      :oe:func:`OEProton::OEAssignCharges` function with the
      :ref:`OEMMFF94Charges <OEProton_OEMMFF94Charges>` class of the **Quacpac TK**.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMMFFAtomType

.. oe:function:: OEMMFFAtomType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEMMFFAtomType(const OEAtomBase* atom, bool& fail)

   .. oe:language:: python

      .. oe:api:: python

         OEMMFFAtomType(atm: OEAtomBase) -> OEMMFFTypeResult

   Returns the MMFF94 atom type from the :oe:constns:`OEChem::OEMMFFType` namespace.

   The following table describes how the returned MMFF type and the 'fail'
   flag should be interpreted:

   .. list-table::
      :widths: 100 50 150
      :header-rows: 1

      * - MMFF type
        - 'fail' flag
        - interpretation

      * - :oe:const:`OEChem::OEMMFFType::UNK`
        - true
        - MMFF atom type **can not** be identified

      * - *not* :oe:const:`OEChem::OEMMFFType::UNK`
        - true
        - an **alternative** MMFF atom type is identified

      * - *not* :oe:const:`OEChem::OEMMFFType::UNK`
        - false
        - MMFF atom type is identified **successfully**

   .. oe:source:: MMFFAtomType.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-MMFF-ATOMTYPE-ORIG

   .. seealso::

      :oe:constns:`OEChem::OEMMFFType` namespace

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEMMFFTypeResult OEMMFFAtomType(const OEAtomBase* atom)

   .. oe:language:: python

      .. oe:api:: python

         OEMMFFAtomType(atm: OEAtomBase) -> OEMMFFTypeResult

   Returns whether an MMFF94 integer atom type can be assigned to an atom
   and the type itself stored in an :ref:`OEMMFFTypeResult <OEChem_OEMMFFTypeResult>` object.

   .. warning::

      Only the function that returns :ref:`OEMMFFTypeResult <OEChem_OEMMFFTypeResult>` is supported
      in the wrapped languages: Python, Java and C#.

   .. oe:source:: MMFFAtomType.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-MMFF-ATOMTYPE

   .. oe:source:: MMFFAtomType.py
      :language: python
      :noindent:
      :frag:     SNIPPET-MMFF-ATOMTYPE

   .. oe:source:: MMFFAtomType.java
      :language: java
      :noindent:
      :frag:     SNIPPET-MMFF-ATOMTYPE

   .. oe:source:: MMFFAtomType.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-MMFF-ATOMTYPE

   The correct atom typing requires the following conditions:

   * The molecule has to have explicit hydrogens.
   * The molecule has to have (:oe:const:`MMFF<OEChem::OEAroModel::MMFF>`) aromaticity model.

   .. hint::

      We highly recommend assigning MMFF partial charges to a molecule by calling the
      :oe:func:`OEProton::OEAssignCharges` function with the
      :ref:`OEMMFF94Charges <OEProton_OEMMFF94Charges>` class of the **Quacpac TK**.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMMFFAtomTypeNames

.. oe:function:: OEMMFFAtomTypeNames

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMMFFAtomTypeNames(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMMFFAtomTypeNames(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Assigns symbolic MMFF94 atom names to atoms in passed molecule. Returns ``true`` when
   symbolic atom types are successfully assigned.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMMFFAtomTypes

.. oe:function:: OEMMFFAtomTypes

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMMFFAtomTypes(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMMFFAtomTypes(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Assigns MMFF94 integer atom type to atoms in passed molecule. Returns ``true`` when
   all atom types are successfully assigned.

   The correct atom typing requires the following conditions:

   * The molecule has to have explicit hydrogens.
   * The molecule has to have (:oe:const:`MMFF<OEChem::OEAroModel::MMFF>`) aromaticity model.

   .. hint::

      We highly recommend assigning MMFF partial charges to a molecule by calling the
      :oe:func:`OEProton::OEAssignCharges` function with the
      :ref:`OEMMFF94Charges <OEProton_OEMMFF94Charges>` class of the **Quacpac TK**.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMMFFClearRemappedElements

.. oe:function:: OEMMFFClearRemappedElements

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEMMFFClearRemappedElements()

   .. oe:language:: python

      .. oe:api:: python

         OEMMFFClearRemappedElements() -> None

   Removes any mappings created by calling :oe:func:`OEChem::OEMMFFRemapElement`.

   .. warning::

      This function is **not** thread-safe. It should only be called when it is
      assured not to race with any other OEMMFF functions.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMMFFRemapElement

.. oe:function:: OEMMFFRemapElement

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEMMFFRemapElement(unsigned int from_element,
                                 unsigned int to_element)

   .. oe:language:: python

      .. oe:api:: python

         OEMMFFRemapElement(from_element: int, to_element: int) -> None

   Map a particular element to another element for purposes of the OEMMFF
   functions.

   .. warning::

      This function is **not** thread-safe. It should only be called when
      it is assured not to race with any other OEMMFF functions.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMMFFTypeIndex

.. oe:function:: OEMMFFTypeIndex

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEMMFFTypeIndex(unsigned int type)

   .. oe:language:: python

      .. oe:api:: python

         OEMMFFTypeIndex(type: int) -> int


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMMFFTypeName

.. oe:function:: OEMMFFTypeName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEMMFFTypeName(unsigned int type)

   .. oe:language:: python

      .. oe:api:: python

         OEMMFFTypeName(type: int) -> str



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMMFFTypeNames

.. oe:function:: OEMMFFTypeNames

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMMFFTypeNames(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMMFFTypeNames(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMacroModelAtomTypeNames

.. oe:function:: OEMacroModelAtomTypeNames

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMacroModelAtomTypeNames(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMacroModelAtomTypeNames(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   This function sets the string atom type property of every atom in a
   molecule to its MacroModel atom type.  The string atom type property
   is set using the :oe:meth:`OEChem::OEAtomBase::SetType` method.  This
   function returns ``false`` if any atom was assigned ``00``, *i.e.*
   unknown, and returns the value ``true`` otherwise.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMacroModelAtomTypes

.. oe:function:: OEMacroModelAtomTypes

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMacroModelAtomTypes(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMacroModelAtomTypes(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   This function sets the integer atom type property of every atom in a
   molecule to its MacroModel atom type.  The integer atom type indices
   are defined in the :oe:constns:`OEChem::OEMModType` namespace, and each
   atom is assigned a value using the
   :oe:meth:`OEChem::OEAtomBase::SetIntType` method.  The
   :oe:func:`OEChem::OEMacroModelAtomTypes` function returns ``false`` if any
   atom was assigned type zero, *i.e.* unknown, and returns the value
   ``true`` otherwise.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMacroModelTypeElement

.. oe:function:: OEMacroModelTypeElement

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEMacroModelTypeElement(unsigned int type)

   .. oe:language:: python

      .. oe:api:: python

         OEMacroModelTypeElement(type: int) -> int

   Returns the atomic number/element represented by the given MacroModel
   atom type index, as encoded by the :oe:constns:`OEChem::OEMModType`
   namespace.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMacroModelTypeName

.. oe:function:: OEMacroModelTypeName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEMacroModelTypeName(unsigned int type)

   .. oe:language:: python

      .. oe:api:: python

         OEMacroModelTypeName(type: int) -> str

   This function returns the symbolic atom type name that corresponds to
   the given MacroModel atom type index, as encoded by the
   :oe:constns:`OEChem::OEMModType` namespace.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMacroModelTypeNames

.. oe:function:: OEMacroModelTypeNames

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMacroModelTypeNames(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMacroModelTypeNames(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   This function loops through the atoms of the molecule, setting the
   string atom type property of each atom, to atom type name of the
   MacroModel atom type encoded in the atoms integer atom type property.
   This is approximately equivalent to following operation:

   .. code-block:: c++

      atm->SetType(OEMacroModelTypeName(atm->GetIntType()))

   If both the string and integer atom types are required, it is faster
   to call :oe:func:`OEChem::OEMacroModelAtomTypes` and then
   :oe:func:`OEChem::OEMacroModelTypeNames` (which reuses the results of
   the first call) than it is to call
   :oe:func:`OEChem::OEMacroModelAtomTypes` and
   :oe:func:`OEChem::OEMacroModelAtomTypeNames`.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

..  _oechem_oemakesubsearchqueryscreen:

.. oe:function:: OEMakeSubSearchQueryScreen

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeSubSearchQueryScreen(OESubSearchScreen& screen,
                                         OEQMolBase& qmol,
                                         const OESubSearchScreenTypeBase* stype)
         bool OEMakeSubSearchQueryScreen(OESubSearchScreen& screen,
                                         OEQMolBase& qmol,
                                         const unsigned stype = OESubSearchScreenType::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeSubSearchQueryScreen(arg1: OESubSearchScreen, arg2: OEQMol,
                                    arg3: OESubSearchScreenTypeBase) -> bool
         OEMakeSubSearchQueryScreen(arg1: OESubSearchScreen, arg2: OEQMol,
                                    stype: int) -> bool

   Generates a substructure search screen of a query molecule with the given type.

   screen
     The :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>` object that is generated.

   qmol
     The query molecule of which properties are encoded into the generated screen.

   stype
     The type of the screen (either from the :oe:constns:`OEChem::OESubSearchScreenType` namespace
     or an internal screen type, :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>`).

   The :ref:`OEMakeSubSearchQueryScreen <OEChem_OEMakeSubSearchQueryScreen>` function also prepares the
   query molecule for the substructure search. For some screen types,
   the expression trees of the query are optimized for substructure search.
   The :ref:`OEMakeSubSearchQueryScreen <OEChem_OEMakeSubSearchQueryScreen>` function returns ``true``
   if the screen was successfully generated and ``false`` otherwise.

   .. note::

      For performance reason, **OEChem TK** does not support screening-based fast substructure
      search with explicit hydrogens.
      The :oe:func:`OEChem::OEMakeSubSearchQueryScreen` function will return ``false`` if the query
      molecule has any explicit hydrogen expression.

      :oe:func:`OEChem::OEIsComplementaryScreenType` function can be used to check
      whether the query molecule is suited for a specific screen type.

   .. seealso::

      * :oe:func:`OEChem::OEMakeSubSearchTargetScreen` function
      * :oe:func:`OEChem::OEScreen` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

..  _oechem_oemakesubsearchtargetscreen:

.. oe:function:: OEMakeSubSearchTargetScreen

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeSubSearchTargetScreen(OESubSearchScreen& screen,
                                          OEMolBase& mol,
                                          const OESubSearchScreenTypeBase* stype)
         bool OEMakeSubSearchTargetScreen(OESubSearchScreen& screen,
                                          OEMolBase& mol,
                                          const unsigned stype = OESubSearchScreenType::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeSubSearchTargetScreen(arg1: OESubSearchScreen,
                                     arg2: Union[OEGraphMol,OEMol,OEQMol],
                                     arg3: OESubSearchScreenTypeBase) -> bool
         OEMakeSubSearchTargetScreen(arg1: OESubSearchScreen,
                                     arg2: Union[OEGraphMol,OEMol,OEQMol],
                                     stype: int) -> bool

   Generates a substructure search screen of a molecule with the given type.

   screen
     The :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>` object that is generated.

   mol
     The molecule of which properties are encoded into the generated screen.

   stype
     The type of the screen (either from the :oe:constns:`OEChem::OESubSearchScreenType` namespace
     or an internal screen type, :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>`).

   The :ref:`OEMakeSubSearchTargetScreen <OEChem_OEMakeSubSearchTargetScreen>` function also prepares the
   molecule for the substructure search by doing the following.

   * suppresses explicit hydrogens
   * perceives the atom and bond properties of the molecule that are necessary to
     successfully execute the substructure search
     (see also the :ref:`OEPrepareSearch <OEChem_OEPrepareSearch>` function)

   The :ref:`OEMakeSubSearchTargetScreen <OEChem_OEMakeSubSearchTargetScreen>` function returns ``true``
   if the screen was successfully generated and ``false`` otherwise.

   .. seealso::

      * :oe:func:`OEChem::OEMakeSubSearchTargetScreen` function
      * :oe:func:`OEChem::OEScreen` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

..  _OEMolToCXSMILES:

.. meta::
   :keywords: OEMolToCXSMILES

.. oe:function:: OEMolToCXSMILES

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEMolToCXSMILES(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMolToCXSMILES(mol: Union[OEGraphMol,OEMol,OEQMol]) -> str

   Creates a :term:`CXSMILES` from a molecule
   by evoking the low-level :oe:func:`OEChem::OECreateSmiString`
   function with the :oe:const:`OEChem::OESMILESFlag::ISOMERIC` and :oe:const:`OEChem::OESMILESFlag::EnhStereo` options.

   Prior to generating the :term:`CXSMILES` the
   following properties are perceived **if necessary**:

   * The rings of the molecule are perceived by calling the
     :oe:func:`OEChem::OEFindRingAtomsAndBonds` function

   * The aromaticity is assigned by calling the
     :oe:func:`OEChem::OEAssignAromaticFlags` function using the
     :oe:const:`OEChem::OEAroModel::OpenEye` aromaticity model.

   * In case of a 3D molecule, the stereochemistry of the atoms
     and the bonds are set by calling the :oe:func:`OEChem::OE3DToAtomStereo`
     and the :oe:func:`OEChem::OE3DToBondStereo` functions, respectively.

   .. seealso::

      * :oe:func:`OEChem::OECXSMILESToMol` function
      * :oe:func:`OEChem::OESmilesToMol` function
      * :ref:`section_molctordtor_smilesfrommol` section


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEChem

.. oe:function:: OEMolToHelm

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEMolToHelm(const OEMolBase& mol,
                                 const OEMonomerSet& monomers)
         std::string OEMolToHelm(const OEMolBase& mol,
                                 const OEMonomerSet& monomers,
                                 OEHelmGenerationResult& result)
         std::string OEMolToHelm(const OEMolBase& mol,
                                 const OEMonomerSet& monomers,
                                 const OEHelmGenerationOptions& options)
         std::string OEMolToHelm(const OEMolBase& mol,
                                 const OEMonomerSet& monomers,
                                 const OEHelmGenerationOptions& options,
                                 OEHelmGenerationResult& result)

   .. oe:language:: python

      .. oe:api:: python

         OEMolToHelm(mol: Union[OEGraphMol,OEMol,OEQMol],
                     monomers: OEMonomerSet) -> str
         OEMolToHelm(mol: Union[OEGraphMol,OEMol,OEQMol],
                     monomers: OEMonomerSet, result: OEHelmGenerationResult) -> str
         OEMolToHelm(mol: Union[OEGraphMol,OEMol,OEQMol],
                     monomers: OEMonomerSet, options: OEHelmGenerationOptions) -> str
         OEMolToHelm(mol: Union[OEGraphMol,OEMol,OEQMol],
                     monomers: OEMonomerSet, options: OEHelmGenerationOptions,
                     result: OEHelmGenerationResult) -> str

   Converts a molecule into :term:`HELM` string. The function will return :term:`HELM`
   string if it can be generated successfully, otherwise
   the function will return an empty string.

   mol
    The molecule (:oe:cls:`OEChem::OEMolBase`) the HELM string is generated from.

   monomers
    The monomer set (:oe:cls:`OEChem::OEMonomerSet`) that stores the monomers that
    are used to generate the :term:`HELM` string.

    If the given monomer set supports multiple code sets, :oe:func:`OEChem::OEHelmToMol` automatically
    selects the primary code set.

   options
    The options for :term:`HELM` generation (:oe:cls:`OEChem::OEHelmGenerationOptions`).

   result
    Is specified, the :oe:cls:`OEChem::OEHelmGenerationResult` object will store additional
    information about the success or failure of the :term:`HELM` generation. 

   **Example**

   .. oe:source:: MolToHelm.py
      :language: python
      :noindent:
      :frag:     SNIPPET

   .. oe:source:: MolToHelm.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET

   .. seealso::

      * [Zhang-2012]_ publications
      * :oe:func:`OEChem::OEHelmToMol` function

   .. admonition:: OpenEye Python Cookbook Code Example

      * `Convert SMILES to HELM`_
      * `Convert Molecule File to HELM File`_


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMolToInChI

.. oe:function:: OEMolToInChI

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEMolToInChI(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMolToInChI(mol: Union[OEGraphMol,OEMol,OEQMol]) -> str

   Creates a nonstandard round-trip form of InChI from a molecule.  This function suppresses most of the
   normalizations done for the standard InChI to allow its use for round-trip activities.

   .. note::

      |InChIVersionID|

   .. table:: Success rate for **OEMolTo[STD]InChI/OEInChIToMol** to regenerate input structure ``SMILES``

      ============================ ========= =================== ============
      Database                     Size      Number of failures  Success Rate
      ============================ ========= =================== ============
      ChEMBL_23 (OEMolToSTDInChI)  1.7M      ~798K                53 %
      ChEMBL_23 (OEMolToInChI)     1.7M      ~92K                 95 %
      ============================ ========= =================== ============

   The round-trip failures relate to *InChI* structure normalization
   activities (charge, and/or bond rearrangements) that preclude the ability to recover
   an arbitrary molecule in its input form.

   .. seealso::

      * :oe:func:`OEChem::OEMolToSTDInChI` function
      * :oe:func:`OEChem::OEInChIToMol` function
      * :oe:func:`OEChem::OECreateInChI` function
      * :oe:func:`OEChem::OEParseInChI` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMolToInChIKey

.. oe:function:: OEMolToInChIKey

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEMolToInChIKey(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMolToInChIKey(mol: Union[OEGraphMol,OEMol,OEQMol]) -> str

   Creates an :term:`InChIKey` from the nonstandard round-trip InChI from a molecule.

   .. note::

      |InChIVersionID|


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMolToSTDInChI

.. oe:function:: OEMolToSTDInChI

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEMolToSTDInChI(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMolToSTDInChI(mol: Union[OEGraphMol,OEMol,OEQMol]) -> str

   Creates a standard InChI from a molecule.

   .. note::

      |InChIVersionID|

   .. table:: Success rate for **OEMolTo[STD]InChI/OEInChIToMol** to regenerate input structure ``SMILES``

      ============================ ========= =================== ============
      Database                     Size      Number of failures  Success Rate
      ============================ ========= =================== ============
      ChEMBL_23 (OEMolToSTDInChI)  1.7M      ~798K                53 %
      ChEMBL_23 (OEMolToInChI)     1.7M      ~92K                 95 %
      ============================ ========= =================== ============

   The round-trip failures relate to *InChI* structure normalization
   activities (charge, and/or bond rearrangements) that preclude the ability to recover
   an arbitrary molecule in its input form.

   .. seealso::

      * :oe:func:`OEChem::OEMolToInChI` function
      * :oe:func:`OEChem::OEInChIToMol` function
      * :oe:func:`OEChem::OECreateInChI` function
      * :oe:func:`OEChem::OEParseInChI` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMolToSTDInChIKey

.. oe:function:: OEMolToSTDInChIKey

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEMolToSTDInChIKey(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMolToSTDInChIKey(mol: Union[OEGraphMol,OEMol,OEQMol]) -> str

   Creates an :term:`InChIKey` from the a standard InChI for a molecule.

   .. note::

      |InChIVersionID|


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

..  _OEMolToSmiles:

.. meta::
   :keywords: OEMolToSmiles

.. oe:function:: OEMolToSmiles

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEMolToSmiles(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMolToSmiles(mol: Union[OEGraphMol,OEMol,OEQMol]) -> str

   Creates a :term:`canonical isomeric SMILES` from a molecule
   by evoking the low-level :oe:func:`OEChem::OECreateSmiString`
   function with the :oe:const:`OEChem::OESMILESFlag::ISOMERIC` option.

   Prior to generating the :term:`canonical isomeric SMILES` the
   following properties are perceived **if necessary**:

   * The rings of the molecule are perceived by calling the
     :oe:func:`OEChem::OEFindRingAtomsAndBonds` function

   * The aromaticity is assigned by calling the
     :oe:func:`OEChem::OEAssignAromaticFlags` function using the
     :oe:const:`OEChem::OEAroModel::OpenEye` aromaticity model.

   * In case of a 3D molecule, the stereochemistry of the atoms
     and the bonds are set by calling the :oe:func:`OEChem::OE3DToAtomStereo`
     and the :oe:func:`OEChem::OE3DToBondStereo` functions, respectively.

   .. seealso::

      * :oe:func:`OEChem::OESmilesToMol` function
      * :oe:func:`OEChem::OECXSMILESToMol` function
      * :ref:`section_molctordtor_smilesfrommol` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMolecularFormula

.. oe:function:: OEMolecularFormula

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEMolecularFormula(std::string& str, const OEMolBase& mol,
                                 bool hydrogenisotopic = false)

   .. oe:language:: python

      .. oe:api:: python

         OEMolecularFormula(mol: Union[OEGraphMol,OEMol,OEQMol],
                            hydrogenisotopic: bool = False) -> str

   This function calculates the molecular formula for the given
   molecule, return the result in the str argument.  The component
   elements of the molecular formula are listed in Hill order.  This
   function determines the cumulative molecular formula, so elements
   from different connected components are summed.  To generate a "dot
   disconnected" molecular formula, this function should be used to
   generate the formula for each component or part, and the results
   concatenated together as appropriate.  If the 'hydrogenisotopic'
   parameter is ``true``, and the molecule contains any atoms of
   deuterium or tritium, then the output molecular formula will
   represent them as D or T as appropriate. By default hydrogens
   isotopes are summed together as H.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEMonomerConnectionSmilesFromCXSmiles

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEMonomerConnectionSmilesFromCXSmiles(const std::string& monomerCXSmiles,
                                                           const std::vector<std::string>& cappingCXSmiles)

   .. oe:language:: python

      .. oe:api:: python

         OEMonomerConnectionSmilesFromCXSmiles(monomerCXSmiles: str,
                                               cappingCXSmiles: OEStringVector) -> str

   Converts :term:`CXSMILES` style monomer definition for the OpenEye preferred style.. 
   For example in case of alanine: ``"[H:1]N[C@@H](C)C(=O)[OH:2]"`` will be returned for the 
   the ``"C[C@H](N[*])C([*])=O |$;;;_R1;;_R2;$|"`` cx-smiles and corresponding 
   ``"[*][H] |$_R1;$|"`` and  ``"O[*] |$;_R2$|"`` capping smiles.
   If the function fails an empty string will be returned.

   .. warning::

      The :term:`CXSMILES` used in this function shouldn't contains any features other than the R-group number information.
   
   .. seealso::

      * :oe:func:`OEChem::OECreatePeptideMonomerConnectionSmiles` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEMonomerTypeToString

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEMonomerTypeToString(unsigned)

   .. oe:language:: python

      .. oe:api:: python

         OEMonomerTypeToString(arg1: int) -> str

   Converts a constant of the :oe:constns:`OEChem::OEMonomerType` namespace into string
   representation.

   .. seealso::

      * :oe:constns:`OEChem::OEMonomerType` namespace
      * :oe:func:`OEChem::OEStringToMonomerType` function

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEMultipleBondCount

.. oe:function:: OEMultipleBondCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEMultipleBondCount(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OEMultipleBondCount(atm: OEAtomBase) -> int

   Returns the number of bonds connected to an atom, with bond order
   greater than one.  The bond order is as determined by
   :oe:meth:`OEChem::OEBondBase::GetOrder`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OENetCharge

.. oe:function:: OENetCharge

   .. oe:language:: c++ java csharp

      .. oe:api::

         int OENetCharge(const OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OENetCharge(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Determines the net charge on a molecule.  If the molecule has
   specified partial charges, see **OEChem TK**'s
   :oe:func:`OEChem::OEHasPartialCharges` function, this function returns
   the sum of the partial charges rounded to an integer.  Otherwise this
   function returns the sum of the formal charges on each atom of the
   molecule.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OENewMCMolBase

.. oe:function:: OENewMCMolBase

   .. oe:api::

      OEMCMolBase* OENewMCMolBase(unsigned int type = OEMCMolType::OEDefault)
      OEMCMolBase* OENewMCMolBase(const OEMolBase& mol,
                                  unsigned int type = OEMCMolType::OEDefault)
      OEMCMolBase* OENewMCMolBase(const OEMCMolBase& mol,
                                  unsigned int type = OEMCMolType::OEDefault)
      OEMCMolBase* OENewMCMolBase(const OESystem::OEBase& b,
                                  unsigned int type = OEMCMolType::OEDefault)

   The :oe:func:`OEChem::OENewMCMolBase` factory functions allocate an
   implementation of an :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` based on the integer
   'type' argument.  The 'type' argument specifies the implementation
   type to be allocated, and should be one of the values listed in
   :oe:constns:`OEChem::OEMCMolType` namespace.  An
   :ref:`OEMolBase <OEChem_OEMolBase>` or :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` may be
   passed in order to copy construct the :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`
   instance.  The pointer to the :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` memory
   returned by the function is allocated dynamically.  The ``delete``
   operator must be called for all returned instances to prevent memory leaks.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OENewMolBase

.. oe:function:: OENewMolBase

   .. oe:api::

      OEMolBase* OENewMolBase(unsigned int type = OEMolBaseType::OEDefault)
      OEMolBase* OENewMolBase(const OEMolBase& mol,
                              unsigned int type = OEMolBaseType::OEDefault)

   Allocates an implementation of an :ref:`OEMolBase <OEChem_OEMolBase>` based on
   the integer 'type' argument.  The 'type' argument specifies the
   implementation type to be allocated, and should be one of the values
   listed in :oe:constns:`OEChem::OEMolBaseType`.  The returned molecule
   may be copy constructed from an existing :ref:`OEMolBase <OEChem_OEMolBase>`
   instance.  The pointer to the :ref:`OEMolBase <OEChem_OEMolBase>` memory
   returned by the function is allocated dynamically.  The ``delete``
   operator must be called for all returned instances to prevent memory leaks.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OENewQMolBase

.. oe:function:: OENewQMolBase

   .. oe:api::

      OEQMolBase* OENewQMolBase(unsigned int type = OEQMolType::OEDefault)
      OEQMolBase* OENewQMolBase(const OEMolBase& mol,
                                unsigned int type = OEQMolType::OEDefault)
      OEQMolBase* OENewQMolBase(const OEQMolBase& mol,
                                unsigned int type = OEQMolType::OEDefault)

   Allocates an implementation of an :ref:`OEQMolBase <OEChem_OEQMolBase>` based on
   the integer 'type' argument.  The 'type' argument specifies the
   implementation type to be allocated, and should be one of the values
   listed in :oe:constns:`OEChem::OEQMolType`.  An
   :ref:`OEMolBase <OEChem_OEMolBase>` or :ref:`OEQMolBase <OEChem_OEQMolBase>` may be
   passed in order to copy construct the :ref:`OEQMolBase <OEChem_OEQMolBase>`
   instance.  The pointer to the :ref:`OEQMolBase <OEChem_OEQMolBase>` memory
   returned by the function is allocated dynamically.  The ``delete``
   operator must be called for all returned instances to prevent memory leaks.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OENormalize

.. oe:function:: OENormalize

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OENormalize(OEMolBase& mol,
                          const OENormModel model = OENormModelDefault)

   .. oe:language:: python

      .. oe:api:: python

         OENormalize(mol: Union[OEGraphMol,OEMol,OEQMol],
                     model: OENormModel = OENormModelDefault) -> None


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEOverlayConfsByRMSD

.. oe:function:: OEOverlayConfsByRMSD
      
   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEOverlayConfsByRMSD(OEMCMolBase& mol,
                                   const unsigned maxTermHeavyAtoms = 25u)

   .. oe:language:: python

      .. oe:api:: python

         OEOverlayConfsByRMSD(mol: OEMol, maxTermHeavyAtoms: int = 25) -> bool

   This method overlays the all conformers of the molecule, onto the first conformer, such that the
   RSMD between the conformers are minimized. The automorphisms of the molecule graph is taken into
   consideration during the RMSD calculations.

   *mol*
      Molecule whose conformers are to be overlaid.

   *maxTermHeavyAtoms*
      Maximum number of terminal heavy atoms that should be considered in assessing automorphisms
      in the molecule graphs. If the number of terminal heavy atoms exceeds this limit, they are ignored
      for assessing automorphisms.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEPDBOrderAtoms

.. oe:function:: OEPDBOrderAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPDBOrderAtoms(OEMolBase& mol, bool preserveResOrder = false)

   .. oe:language:: python

      .. oe:api:: python

         OEPDBOrderAtoms(mol: Union[OEGraphMol,OEMol,OEQMol],
                         preserveResOrder: bool = False) -> bool

   Reorders the atoms of a molecule into PDB order, using the residue
   information associated with each atom. The optional argument preserveResOrder,
   forces the function to preserve the residue order from the input.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEPRECompress

.. oe:function:: OEPRECompress

   .. warning::

      OEB files generated through these functions will only be
      readable by **OEChem TK** 2.0.2 (2014.Oct) and higher.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPRECompress(oemolstreambase& str)

   .. oe:language:: python

      .. oe:api:: python

         OEPRECompress(str: oemolstreambase) -> bool

   Enables the :ref:`oemolostream <OEChem_oemolostream>` to write
   rotor-offset-compressed molecules in the perfect-rotor-encoding
   format, even for ``float`` precision molecules. This alleviates the
   need to GZip the ``OEB``, improving the performance of
   :oe:meth:`OEChem::OEMolDatabase::Open`.

   .. note::

      To compress data for **ROCS/FastROCS** at the :ref:`OEMCMolBase <OEChem_OEMCMolBase>` level
      instead of :ref:`oemolostream <OEChem_oemolostream>` see :oe:func:`OEFastROCS::OEPrepareFastROCSMol`.

.. ################################################################
   #
   ################################################################



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEParseInChI

.. oe:function:: OEParseInChI

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEParseInChI(OEMolBase& mol, const std::string& str)

   .. oe:language:: python

      .. oe:api:: python

         OEParseInChI(mol: Union[OEGraphMol,OEMol,OEQMol], str: str) -> bool

   Parses a :term:`InChI` string into a molecule.
   The returned value indicates whether the given :term:`InChI` string was parsed
   successfully.

   mol
    The constructed molecule.

   str
    The :term:`InChI` string that is parsed into the molecule.

   The input molecule instance is not cleared so these functions can be used
   to add components to an existing molecule.

   .. hint::

      The use of the high-level :oe:func:`OEChem::OEInChIToMol` function is
      highly recommended over the low-level :oe:func:`OEChem::OEParseInChI` function.
      The :oe:func:`OEChem::OEInChIToMol` function not only converts
      an :term:`InChI` string into a molecule but also perceives basic molecular
      properties.

   .. seealso::

      * :oe:func:`OEChem::OEMolToSTDInChI` function
      * :oe:func:`OEChem::OEMolToInChI` function
      * :oe:func:`OEChem::OEInChIToMol` function
      * :oe:func:`OEChem::OECreateInChI` function
      * :ref:`section_molctordtor_inchifrommol` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEParseSmarts

.. oe:function:: OEParseSmarts

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEParseSmarts(OEQMolBase& mol, const char* smarts,
                            unsigned int opt = OESmartsParseOpts::Default)
         bool OEParseSmarts(OEQMolBase& mol, const char* smarts,
                            const OEVectorBindings& vbinding,
                            unsigned int opt = OESmartsParseOpts::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEParseSmarts(arg1: OEQMol, arg2: str, opt: int) -> bool
         OEParseSmarts(arg1: OEQMol, arg2: str, vb: OEVectorBindings, opt: int) -> bool

   These functions generate a query molecule by parsing the given
   :term:`SMARTS` pattern.
   If the :term:`SMARTS` string passed to the function is valid and
   is parsed correctly the function will return ``true``,
   otherwise it will return ``false``.

   *mol*
    The :ref:`OEQMolBase <OEChem_OEQMolBase>` object that is generated for the
    given :term:`SMARTS` pattern.

   *smarts*
    The :term:`SMARTS` string that represents a molecular substructure query.

   *opts*
     The parameter determines how the :term:`SMARTS` pattern is interpreted.
     This value has to be from the :oe:constns:`OEChem::OESmartsParseOpts`
     namespace.

   *vbinding*
     The parameter provides a mechanism for parsing a :term:`SMARTS` pattern that
     contains vector bindings.  An :ref:`OEVectorBindings <OEChem_OEVectorBindings>` object
     containing the complete set of possible vector bindings that may be
     contained in a :term:`SMARTS` pattern, including recursive vector
     bindings, and passed to the :oe:func:`OEChem::OEParseSmarts` function.
     Vector bindings will be resolved while the :term:`SMARTS` pattern is being
     parsed.

   .. seealso::

      * :ref:`chapter_SMARTS` chapter
      * :oe:constns:`OEChem::OESmartsParseOpts` namespace


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEParseSmiles

.. oe:function:: OEParseSmiles

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEParseSmiles(OEMolBase& mol, const char* str,
                            bool canon = false, bool strict = false)
         bool OEParseSmiles(OEMolBase& mol, const std::string& str,
                            bool canon = false, bool strict = false)
         bool OEParseSmiles(OEMolBase& mol, const char* str,
                            const OEParseSmilesOptions& options)
         bool OEParseSmiles(OEMolBase& mol, const std::string& str,
                            const OEParseSmilesOptions& options)

   .. oe:language:: python

      .. oe:api:: python

         OEParseSmiles(mol: Union[OEGraphMol,OEMol,OEQMol], str: str,
                       canon: bool = False, strict: bool = False) -> bool
         OEParseSmiles(mol: Union[OEGraphMol,OEMol,OEQMol], str: str,
                       options: OEParseSmilesOptions) -> bool

   Parses a :term:`SMILES` string into a molecule.
   The returned value indicates whether the given :term:`SMILES` string was parsed
   successfully.

   mol
    The constructed molecule.

   str
    The :term:`SMILES` string that is parsed into the molecule.

   canon
     Flag that determines whether the post-processing kekulization is performed.
     Passing a boolean ``true`` value to this argument indicates to the parser
     that the :term:`SMILES` string
     should be assumed to be well-formed and the usual kekulization (by
     calling :oe:func:`OEChem::OEKekulize`) step may be omitted.

     This can be used to speed-up parsing of a large database, but has the
     side-effect that bond orders are not correctly assigned for aromatic molecules.

   strict
     Flag that controls whether the parser should operate in strict mode.
     By default, the :term:`SMILES`
     parser attempts to process any reasonably formed :term:`SMILES`
     string.  If the 'strict' argument is ``true``, the parser applies more
     rigorous sanity checking.  For example, the :term:`SMILES` ``C==C`` is
     accepted by the default non-strict parser, but rejected by the strict
     parser.

   options
      The :ref:`OEParseSmilesOptions <OEChem_OEParseSmilesOptions>` object that stores
      properties that influence how a :term:`SMILES` string is parsed into a
      molecule.

   The input molecule instance is not cleared so these functions can be used
   to add components to an existing molecule.  If the :term:`SMILES` string
   represents a reaction, any previously-existing atoms and bonds not already
   in a reaction component become reactants in the resulting molecule object.

   .. hint::

      The use of the high-level :oe:func:`OEChem::OESmilesToMol` function is
      highly recommended over the low-level :oe:func:`OEChem::OEParseSmiles` function.
      The :oe:func:`OEChem::OESmilesToMol` function not only converts
      a :term:`SMILES` string into a molecule but also perceives basic molecular
      properties.

   .. seealso::

      * :oe:func:`OEChem::OESmilesToMol` function
      * :ref:`section_molctordtor_smilesfrommol` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEParseSmirks

.. oe:function:: OEParseSmirks

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEParseSmirks(OEQMolBase& mol, const char* smirks,
                            unsigned int opt = OESmartsParseOpts::Default)
         bool OEParseSmirks(OEQMolBase& mo, const char* smirks,
                            const OEVectorBindings& vb,
                            unsigned int opt = OESmartsParseOpts::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEParseSmirks(arg1: OEQMol, arg2: str, opt: int) -> bool
         OEParseSmirks(arg1: OEQMol, arg2: str, vb: OEVectorBindings, opt: int) -> bool

   These functions generate a reaction molecule by parsing the given
   :term:`SMIRKS` pattern.
   If the :term:`SMIRKS` string passed to the function is valid and
   is parsed correctly the function will return a ``true``,
   otherwise the it will return ``false``.

   *mol*
    The :ref:`OEQMolBase <OEChem_OEQMolBase>` object that is generated for the
    given :term:`SMIRKS` pattern.

   *smirks*
    The :term:`SMARTS` string that represents a molecular substructure query.

   *opts*
     The parameter determines how the :term:`SMARTS` pattern is interpreted.
     This value has to be from the :oe:constns:`OEChem::OESmartsParseOpts`
     namespace.

   *vbinding*
     The parameter provides a mechanism for parsing a :term:`SMARTS` pattern that
     contains vector bindings.  An :ref:`OEVectorBindings <OEChem_OEVectorBindings>` object
     containing the complete set of possible vector bindings that may be
     contained in a :term:`SMIRKS` pattern, including recursive vector
     bindings, and passed to the :oe:func:`OEChem::OEParseSmarts` function.
     Vector bindings will be resolved while the :term:`SMIRKS` pattern is being
     parsed.
 
   .. seealso::

      * :ref:`chapter_SMARTS` chapter
      * :oe:constns:`OEChem::OESmartsParseOpts` namespace

   .. note::

      :oe:func:`OEChem::OEParseSmirks` is functionally nearly identical to
      :oe:func:`OEChem::OEParseSmarts`.  The only significant difference in
      how :term:`SMARTS` and :term:`SMIRKS` are parsed is the handling of the ``[H]``
      expression.  :term:`SMARTS` interprets ``[H]`` as an atom that has a total
      hydrogen count of exactly one.  :term:`SMIRKS` interprets ``[H]`` as an
      explicit hydrogen.  The :oe:func:`OEChem::OEParseSmirks` function
      therefore parses ``[H]`` differently than would
      :oe:func:`OEChem::OEParseSmarts`, and performs additional validity
      checks of the :term:`SMIRKS` string.

   .. seealso::

      .. oe:language:: c++

         * Example program :ref:`libgen.cpp<section_example_oechem_libgen>`

      .. oe:language:: python

         * Example program :ref:`libgen.py<section_example_oechem_libgen>`

      .. oe:language:: java

         * Example program :ref:`LibGen.java<section_example_oechem_libgen>`

      .. oe:language:: csharp

         * Example program :ref:`LibGen.cs<section_example_oechem_libgen>`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEPerceiveBondOrders

.. oe:function:: OEPerceiveBondOrders

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEPerceiveBondOrders(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEPerceiveBondOrders(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Attempts to determine bond orders from the 3D geometry and
   connectivity of a molecule.  If the connectivity is unspecified, the
   *OEChem* function :oe:func:`OEChem::OEDetermineConnectivity` must be
   called prior to this function.

   This function invalidates the aromaticity flags of the molecule's
   atoms and bonds.  If necessary, these aromaticity flags may either be
   cleared using :oe:func:`OEChem::OEClearAromaticFlags` or set
   appropriately by calling :oe:func:`OEChem::OEAssignAromaticFlags`, after
   calling this function.

   .. seealso::

      * :ref:`chapter_connectivity` chapter and :ref:`section_connectivity_bond_order_perception` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEPerceiveCIPStereo

.. note::

   The aromaticity (see :ref:`chapter_aromaticity` chapter) has to be perceived by calling
   the :oe:func:`OEChem::OEAssignAromaticFlags` function prior to calling
   :oe:func:`OEChem::OEPerceiveCIPStereo`.

.. oe:function:: OEPerceiveCIPStereo

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEPerceiveCIPStereo(const OEMolBase& mol,
                                          const OEAtomBase* atom)

   .. oe:language:: python

      .. oe:api:: python

         OEPerceiveCIPStereo(mol: Union[OEGraphMol,OEMol,OEQMol],
                             atom: OEAtomBase) -> int

   Perceives the Cahn-Ingold-Prelog descriptor for the given atom.
   The return value is taken from the :oe:constns:`OEChem::OECIPAtomStereo` namespace.

   For a chiral atom center the function returns

   * either :oe:const:`OEChem::OECIPAtomStereo::R` or :oe:const:`OEChem::OECIPAtomStereo::S`, if the atom has specified stereochemistry
   * :oe:const:`OEChem::OECIPAtomStereo::UnspecStereo` if the CIP atom stereo center has no specified stereo (*i.e.* when :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` returns false),

   The function always returns :oe:const:`OEChem::OECIPAtomStereo::NotStereo` for the following atoms:

   * non-chiral atoms
   * atoms that have invalid valence (checked by :oe:func:`OEChem::OECheckAtomValence`)

   .. seealso::

      * :oe:func:`OEChem::OESetCIPStereo` to set atom stereo from CIP stereo descriptor
      * :ref:`section_stereochemistry_CIP` section

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEPerceiveCIPStereo(const OEMolBase& mol,
                                          const OEBondBase* bond)

   .. oe:language:: python

      .. oe:api:: python

         OEPerceiveCIPStereo(mol: Union[OEGraphMol,OEMol,OEQMol],
                             bond: OEBondBase) -> int

   Perceives the Cahn-Ingold-Prelog descriptor for the given bond stereo center.
   The return value is taken from the :oe:constns:`OEChem::OECIPBondStereo` namespace.

   For a double bond, the function returns

   * either :oe:const:`OEChem::OECIPBondStereo::E` or :oe:const:`OEChem::OECIPBondStereo::Z`, if the bond has specified stereochemistry
   * :oe:const:`OEChem::OECIPBondStereo::UnspecStereo` if the CIP bond stereo center has no specified stereo (*i.e.* when :oe:meth:`OEChem::OEBondBase::HasStereoSpecified` returns false)

   For a non-chiral bond, the function always returns :oe:const:`OEChem::OECIPBondStereo::NotStereo`.

   .. seealso::

      * :oe:func:`OEChem::OESetCIPStereo` to set bond stereo from CIP stereo descriptor
      * :ref:`section_stereochemistry_CIP` section
      *


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEPerceiveChiral

.. oe:function:: OEPerceiveChiral

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPerceiveChiral(OEMolBase& mol, bool carbonOnly = false)

   .. oe:language:: python

      .. oe:api:: python

         OEPerceiveChiral(mol: Union[OEGraphMol,OEMol,OEQMol],
                          carbonOnly: bool = False) -> bool

   Perceives whether an atom or a bond in a molecule is chiral and
   updates the 'chiral' property accordingly.
   Because this function is based on the symmetry classes of a molecule,
   as a side-effect, it also sets the 'symmetry' property of all the atoms the molecule
   to be their 'explicit hydrogen suppressed' symmetry class, by calling the **OEChem TK**
   function :oe:func:`OEChem::OEPerceiveSymmetry`.
   The default behavior is to perceive nitrogens that can undergo nitrogen inversion as
   chiral centers. This behavior can be turned off with the optional carbonOnly flag.
   Before calling OEPerceiveChiral with a different flag it is important to first clear
   the existing chiral perception using :oe:func:`OEChem::OEClearChiralPerception`.

   .. seealso::

      * :oe:func:`OEChem::OEClearChiralPerception` to clear existing chiral perception


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEPerceivePeptideBackbone

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPerceivePeptideBackbone(OEMolBase &)

   .. oe:language:: python

      .. oe:api:: python

         OEPerceivePeptideBackbone(arg1: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   The :oe:func:`OEChem::OEPerceivePeptideBackbone` function identifies the peptide backbone of a
   molecule based on monomers that have already been perceived.
   It returns `true` if the backbone is successfully perceived and `false` if no monomer information
   is available.
   The function sets the following atom name constants
   :oe:const:`OEChem::OEPDBAtomName::C`, :oe:const:`OEChem::OEPDBAtomName::O`,
   :oe:const:`OEChem::OEPDBAtomName::OXT`, :oe:const:`OEChem::OEPDBAtomName::CA`, and
   :oe:const:`OEChem::OEPDBAtomName::N` for atoms belonging to alpha amino acids.
   Furthermore, :oe:const:`OEChem::OEPDBAtomName::CB`, :oe:const:`OEChem::OEPDBAtomName::CG`, and
   :oe:const:`OEChem::OEPDBAtomName::CD` are used to mark additional carbon atoms that are part of
   the backbone in beta, gamma, or delta peptide monomers.

   mol
    The input molecule (:oe:cls:`OEChem::OEMolBase`).

   .. warning::

      The :oe:func:`OEChem::OEPerceivePeptideBackbone` function does not perform a full residue perception 
      like :oe:func:`OEChem::OEPerceiveResidues` does. Instead, it removes any residue information 
      (:oe:cls:`OEChem::OEResidue`) already present and marks only the backbone atoms based on monomer perception. 

   .. seealso::

      * :oe:func:`OEChem::OEGetPDBAtomIndex` function to access PDB ideas assigned to the atoms

      Monomer information is required for the perception of the peptide backbone. The following functions will
      help in obtaining this information:

      * :oe:func:`OEChem::OEHelmToMol`  function to convert a HELM string to a molecule
      * :oe:func:`OEChem::OEDetectMonomers` function to detect monomers in a molecule


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEPerceivePeptideMonomerConnections

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPerceivePeptideMonomerConnections(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEPerceivePeptideMonomerConnections(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   The function identifies the backbone of the amino acid represented by the molecule
   and marks the backbone connections in the molecule.
   The function returns whether both connection points could be identified.

   .. seealso::

      * :oe:func:`OEChem::OECreatePeptideMonomerConnectionSmiles` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEPerceiveResidues

.. oe:function:: OEPerceiveResidues

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEPerceiveResidues(OEMolBase& mol,
                                 unsigned int stable = OEPreserveResInfo::None)

   .. oe:language:: python

      .. oe:api:: python

         OEPerceiveResidues(mol: Union[OEGraphMol,OEMol,OEQMol], stable: int) -> None

   Recognizes the protein and nucleic acid chains of a molecule and set
   the residue information for each atom appropriately.  The stable
   parameter is a bit-mask defined in the
   :oe:constns:`OEChem::OEPreserveResInfo` namespace that indicates if the
   residue numbers, residue names, or chain ID's should be preserved
   during the perception routine.  By default, no prior information is
   preserved.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEPerceiveSymmetry

.. oe:function:: OEPerceiveSymmetry

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPerceiveSymmetry(OEMolBase &, bool includeH = true,
                                 bool automorph = false)

   .. oe:language:: python

      .. oe:api:: python

         OEPerceiveSymmetry(mol: Union[OEGraphMol,OEMol,OEQMol],
                            includeH: bool = True, automorph: bool = False) -> bool

   Set the structural symmetry class of each atom of the given molecule.
   Symmetry classes are numbered sequentially from one up to the maximum
   number of atoms in the molecule for totally asymmetric molecules.
   The assigned symmetry class for each atom may be retrieved using the
   :oe:meth:`OEChem::OEAtomBase::GetSymmetryClass` method.

   The 'includeH' parameter is used to specify whether implicit hydrogens
   should be considered distinct from explicit hydrogens.
   Normally, a molecule will have all hydrogens either implicitly represented or
   explicitly represented so this option shouldn't affect symmetries.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEPolymerTypeToString

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEPolymerTypeToString(unsigned)

   .. oe:language:: python

      .. oe:api:: python

         OEPolymerTypeToString(arg1: int) -> str

   Converts a constant of the :oe:constns:`OEChem::OEPolymerType` namespace into string
   representation.

   .. seealso::

      * :oe:constns:`OEChem::OEPolymerType` namespace
      * :oe:func:`OEChem::OEStringToPolymerType` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEPrepareSearch

..  _oechem_oepreparesearch:

.. oe:function:: OEPrepareSearch

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEPrepareSearch(OEMolBase& mol, const OESubSearch& subs,
                              bool adjustH = false)

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareSearch(mol: Union[OEGraphMol,OEMol,OEQMol],
                         subs: OESubSearch, adjustH: bool = False) -> None

   Perceives the atom and bond properties of the given **target** molecule
   that are necessary to successfully execute the given substructure search.

   * The :oe:func:`OEChem::OEAssignAromaticFlags` function is called if
     the aromaticity of the molecule is not perceived yet.
     The aromaticity is also re-perceived if it does not match the
     aromaticity model of the query molecule stored in the given
     :ref:`OESubSearch <OEChem_OESubSearch>` object.  If the query does not
     have an aromatic model specified after processing (e.g., SMARTS, SMIRKS input),
     the target is re-perceived with the default :oe:const:`OEChem::OEAroModel::OpenEye`
     aromaticity model.

   * The :oe:func:`OEChem::OEPerceiveChiral` function is called if the
     chirality of the given molecule is not perceived yet.

   * The :oe:func:`OEChem::OEAssignHybridization` function is called if the
     hybridization perception is required by the query molecule stored
     in the :ref:`OESubSearch <OEChem_OESubSearch>` object.

   * Attempts to perceive atom stereo from other information (such as 3D,
     bond stereo or atom parity) if the atom stereo is required by the
     query molecule stored in the :ref:`OESubSearch <OEChem_OESubSearch>` object.

   * Attempts to perceive bond stereo from 2D or 3D  coordinates if
     the bond stereo is required by the query molecule stored in the
     :ref:`OESubSearch <OEChem_OESubSearch>` object.

   * If the **adjustH** parameter is ``true``, and

     * the query molecule of the substructure search has any explicit hydrogen
       expressions but no implicit ones, then
       :oe:func:`OEChem::OEAddExplicitHydrogens` is called on the
       given **target** molecule.

     * the query molecule of the substructure search has any implicit hydrogen
       expressions but no explicit ones, then
       :oe:func:`OEChem::OESuppressHydrogens` is called on the
       given **target** molecule.

   .. warning::

      If the query molecule has both explicit and implicit hydrogens then the
      hydrogens on the **target** molecule can not be adjusted accordingly,
      and the substructure search could fail. Therefore it is highly recommended
      to **not mix** explicit and implicit hydrogens in the query molecule.

   .. hint::

      It is a good practice to call the :oe:func:`OEChem::OEPrepareSearch`
      function before calling any of the following methods:

      * :oe:meth:`OEChem::OESubSearch::AtomMatch`
      * :oe:meth:`OEChem::OESubSearch::Match`
      * :oe:meth:`OEChem::OESubSearch::SingleMatch`

      If there is any atom or bond property that is not perceived but it
      is necessary to successfully execute the substructure search,
      then the above methods throw a warning.
      These warnings can be suppressed by calling the
      :oe:func:`OEChem::OEPrepareSearch` function.

   .. seealso::

      * :ref:`OESubSearch <OEChem_OESubSearch>` class
      * :oe:func:`OEChem::OEHasExplicitHydrogenExpression` function
      * :oe:func:`OEChem::OEHasImplicitHydrogenExpression` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEPreserveRotCompress

.. oe:function:: OEPreserveRotCompress

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPreserveRotCompress(oemolstreambase& str)

   .. oe:language:: python

      .. oe:api:: python

         OEPreserveRotCompress(str: oemolstreambase) -> bool

   Instructs the :ref:`oemolstreambase <OEChem_oemolstreambase>` to preserve
   rotor-offset-compression data on :ref:`OEMCMolBase <OEChem_OEMCMolBase>`
   objects when being read from the ``OEB`` file format. This should
   be called on the :ref:`oemolistream <OEChem_oemolistream>` object if the
   molecule needs to be output and preserve compression.

   .. warning::

      Altering the coordinates or connection table of an
      :ref:`OEMCMolBase <OEChem_OEMCMolBase>` molecule that has been read through
      this mechanism is undefined. Modifications to conformer
      coordinates will likely be lost. Modifications to the connection
      table will likely result in an error during
      :oe:func:`OEChem::OEWriteMolecule`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OERGroupsToHydrogens

.. oe:function:: OERGroupsToHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERGroupsToHydrogens(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OERGroupsToHydrogens(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Converts terminal R-groups (atoms with atomic number 0) in a molecule to hydrogen atoms.
   The terminal requirement means it can only and must be be connected to one heavy atom.
   Additionally, it R-group atoms implicit hydrogen count must be zero.
   The function attempts to be consistent with the input molecule,
   such that molecules with only implicit hydrogens will stay that way after the conversion.
   If a molecule has explicit hydrogens, the function will convert the R-group to an explicit
   hydrogen atom. For a molecule in 3D, the new hydrogen will have 3D coordinates, either retaining
   the coordinates of the R-group atom, of that was places at (0,0,0) the hydrogen will be assigned
   proper 3D coordinates.

   .. seealso::

      * :oe:func:`OEChem::OESet3DHydrogenGeom` that assigned proper 3D geometry to the hydrogen atom if needed.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OERMSD

.. oe:function:: OERMSD

   **Array-Based OERMSD**

   .. _api_Array_Based_RMSD:

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OERMSD(const float* refcrds, const float* fitcrds,
                       unsigned int size, bool overlay = false,
                       double* rot = 0, double* trans = 0)
         double OERMSD(const double* refcrds, const double* fitcrds,
                       unsigned int size, bool overlay = false,
                       double* rot = 0, double* trans = 0)

   .. oe:language:: python

      .. oe:api:: python

         OERMSD(refcrds: OEFloatArray, fitcrds: OEFloatArray, size: int,
                overlay: bool = False, rot: OEDoubleArray = None,
                trans: OEDoubleArray = None) -> float
         OERMSD(refcrds: OEDoubleArray, fitcrds: OEDoubleArray, size: int,
                overlay: bool = False, rot: OEDoubleArray = None,
                trans: OEDoubleArray = None) -> float

   Returns the root mean squared deviation (i.e. RMSD) between two sets of
   Cartesian coordinates.  

   *refcrds, fitcrds*
      These arrays should be of length `size` ``*3``, and should contain
      the Cartesian coordinates of the two objects being assessed.

   *overlay*
     This flag indicates whether the RMSD of the two arrays in their
     current position is desired (``false``), or whether the lowest possible
     RMSD for the two arrays should be returned (``true``).  

   *rot, trans*
      If an overlay calculation is carried out, the functions can report the
      rotation and translation required to achieve the minimum RMSD.  An
      array of length ``double[9]`` should be passed to the **rot** argument
      and an array of length ``double[3]``
      should be passed as the **trans** argument.

   **Example:**

   .. oe:source:: OERMSD.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OERMSD-ARRAY

   .. oe:source:: OERMSD.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OERMSD-ARRAY

   .. oe:source:: OERMSD.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OERMSD-ARRAY

   .. oe:source:: OERMSD.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OERMSD-ARRAY

   **Full Molecule-Based OERMSD**

   .. _api_Full_Molecule_Based_RMSD:

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OERMSD(const OEMolBase& ref, const OEMolBase& fit,
                       bool automorph = true, bool heavyOnly = true,
                       bool overlay = false, double* rot = 0, double* trans = 0)
         bool OERMSD(const OEMolBase& ref, const OEMCMolBase& fit,
                     double* rmsdArray, bool automorph = true,
                     bool heavyOnly = true, bool overlay = false,
                     double* rot = 0, double* trans = 0)

   .. oe:language:: python

      .. oe:api:: python

         OERMSD(ref: Union[OEGraphMol,OEMol,OEQMol], fit: OEMol,
                rmsdArray: OEDoubleArray, automorph: bool = True,
                heavyOnly: bool = True, overlay: bool = False,
                rot: OEDoubleArray = None, trans: OEDoubleArray = None) -> bool
         OERMSD(ref: Union[OEGraphMol,OEMol,OEQMol],
                fit: Union[OEGraphMol,OEMol,OEQMol], automorph: bool = True,
                heavyOnly: bool = True, overlay: bool = False,
                rot: OEDoubleArray = None, trans: OEDoubleArray = None) -> float
         OERMSD(ref: Union[OEGraphMol,OEMol,OEQMol],
                fit: Union[OEGraphMol,OEMol,OEQMol],
                align: OESequenceAlignment, onlyCAlpha: bool = True,
                overlay: bool = False, rot: OEDoubleArray = None,
                trans: OEDoubleArray = None) -> float

   Calculates the root mean squared deviation (i.e. RMSD ) between two
   molecules.  

   *ref, fit*
      This function is overloaded for comparisons of a
      single-conformer (:oe:cls:`OEMolBase<OEChem::OEMolBase>`) reference
      molecule with either a single-conformer
      (:oe:cls:`OEMolBase<OEChem::OEMolBase>`) or a multi-conformer
      (:oe:cls:`OEMCMolBases<OEChem::OEMCMolBase>`) **fit** molecule.

   *rmsdArray*
      For the :ref:`OEMolBase <OEChem_OEMolBase>` vs :ref:`OEMolBase <OEChem_OEMolBase>`
      comparison, the RMSD is the return value.  For the
      :ref:`OEMolBase <OEChem_OEMolBase>` vs
      :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` case, the RMSDs are
      returned in the **rmsdArray** array.  The **rmsdArray** passed to this
      function should be of length ``fit.GetMaxConfIdx()``.

   *automorph*
      This flag indicates whether automorphisms should be taken into account
      during the RMSD calculation.  Automorphisms are the symmetry related
      transformations of a molecule which can result in anomalously high
      RMSDs if not properly treated.  For instance, t-butyl-benzene has a
      three-fold automorphism around the t-butyl group and a two-fold
      automorphism around the benzene ring.  

   *heavyOnly*
      This flag indicates whether only heavy atoms should be considered  
      or hydrogen atoms should be also taken into account as well when
      assessing automorphisms.

   .. hint::
 
      It is strongly recommended that one should
      consider carefully before setting the 'automorph' flag to ``true``
      and the 'heavyOnly' flag to ``false`` due to the increased
      computational cost.

   *overlay*
     This flag indicates whether the RMSD of the molecules in their
     current position is desired (``false``), or whether the lowest possible
     RMSD for the two molecules should be returned (``true``).  

   *rot, trans* 
      If an overlay calculation is carried out, the functions can
      report the rotation and translation required to give this
      minimum RMSD.

      In case when the **fit** molecule is single-conformer 
      (:oe:cls:`OEMolBase<OEChem::OEMolBase>`),  array of length
      ``double[9]`` should be passed to the **rot** argument and an array
      of length ``double[3]`` should be passed as the **trans** argument.

      In case when the **fit** molecule is multi-conformer
      (:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`), the array size of
      both **rot** and **trans** has to be multiplied by the length of
      ``fit.GetMaxConfIdx()``.

   .. hint::

      The arrays **rot** and **trans** described above can subsequently be
      applied to the **fit** molecule using the
      :oe:func:`OEChem::OERotate` and :oe:func:`OEChem::OETranslate`
      functions if desired. It is important that
      :oe:func:`OEChem::OERotate` and :oe:func:`OEChem::OETranslate`
      are applied in that order.

   .. note::

      A multi-conformer **fit** molecule (:oe:cls:`OEMCMolBases<OEChem::OEMCMolBase>`) 
      that is passed to the :oe:func:`OEChem::OERMSD` function can have 
      nonsequential conformation indices. This can occur, for example, if some 
      conformations of the molecule have been deleted.
      In this case, the returned **rmsdArray** array will
      contain ``-1.0`` RMSD values for invalid conformation indices. 
 
   **Example:**

   .. oe:source:: OERMSD.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OERMSD-FULLMOL

   .. oe:source:: OERMSD.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OERMSD-FULLMOL

   .. oe:source:: OERMSD.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OERMSD-FULLMOL

   .. oe:source:: OERMSD.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OERMSD-FULLMOL

   **Partial Molecule-Based OERMSD**

   .. _api_Partial_Molecule_Based_RMSD:

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OERMSD(const OEMolBase& ref, const OEMolBase& fit,
                       const OEMatchBase& match, bool overlay = false,
                       double* rot = 0, double* trans = 0)
         bool OERMSD(const OEMolBase& ref, const OEMCMolBase& fit,
                     double* rmsdArray, const OEMatchBase& match,
                     bool overlay = false, double* rot = 0, double* trans = 0)

   .. oe:language:: python

      .. oe:api:: python

         OERMSD(ref: Union[OEGraphMol,OEMol,OEQMol], fit: OEMol,
                rmsdArray: OEDoubleArray, match: OEMatchBase,
                overlay: bool = False, rot: OEDoubleArray = None,
                trans: OEDoubleArray = None) -> bool
         OERMSD(ref: Union[OEGraphMol,OEMol,OEQMol],
                fit: Union[OEGraphMol,OEMol,OEQMol], match: OEMatchBase,
                overlay: bool = False, rot: OEDoubleArray = None,
                trans: OEDoubleArray = None) -> float
         OERMSD(ref: Union[OEGraphMol,OEMol,OEQMol],
                fit: Union[OEGraphMol,OEQMol], rmsdArray: OEDoubleArray,
                match: OEMatchBase, overlay: bool = False,
                rot: OEDoubleArray = None, trans: OEDoubleArray = None) -> bool

   These functions are quite similar to the previous three.  However,
   rather than considering automorphisms and heavy atoms, these functions
   allow a user to explicitly determine which substructure of the
   two molecules should be used to determine the RMSD. 

   *ref, fit*
      This function is overloaded for comparisons of a
      single-conformer (:oe:cls:`OEMolBase<OEChem::OEMolBase>`) reference
      molecule with either a single-conformer
      (:oe:cls:`OEMolBase<OEChem::OEMolBase>`) or a multi-conformer
      (:oe:cls:`OEMCMolBases<OEChem::OEMCMolBase>`) **fit** molecule.

   *rmsdArray*
      For the :ref:`OEMolBase <OEChem_OEMolBase>` vs :ref:`OEMolBase <OEChem_OEMolBase>`
      comparison, the RMSD is the return value.  For the
      :ref:`OEMolBase <OEChem_OEMolBase>` vs
      :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` case, the RMSDs are
      returned in the **rmsdArray** array.  The **rmsdArray** passed to this
      function should be of length ``fit.GetMaxConfIdx()``.

   *match*
      The match determines the atoms of the **fit** molecule that will be
      aligned to the atoms of the `ref` molecule.
      The match can be generated by hand, or with any of the **OEChem TK**
      matching algorithms such as :ref:`OESubSearch <OEChem_OESubSearch>` or
      :ref:`OEMCSSearch <OEChem_OEMCSSearch>`.

   *overlay*
     This flag indicates whether the RMSD of the molecules in their
     current position is desired (``false``), or whether the lowest possible
     RMSD for the two molecules should be returned (``true``).  

   *rot, trans* 
      If an overlay calculation is carried out, the functions can
      report the rotation and translation required to give this
      minimum RMSD.

      In case when the **fit** molecule is single-conformer 
      (:oe:cls:`OEMolBase<OEChem::OEMolBase>`),  array of length
      ``double[9]`` should be passed to the 'rot' argument and an array of
      length ``double[3]`` should be passed as the 'trans' argument.

      In case when the **fit** molecule is multi-conformer
      (:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`), the array size of
      both `rot` and `trans` has to be multiplied by the length of
      ``fit.GetMaxConfIdx()``.

   .. hint::

      The arrays **rot** and **trans** described above can subsequently be
      applied to the **fit** molecule using the
      :oe:func:`OEChem::OERotate` and :oe:func:`OEChem::OETranslate`
      functions if desired. It is important that
      :oe:func:`OEChem::OERotate` and :oe:func:`OEChem::OETranslate`
      are applied in that order.

   **Example:**

   .. oe:source:: OERMSD.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OERMSD-PARTMOL

   .. oe:source:: OERMSD.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OERMSD-PARTMOL

   .. oe:source:: OERMSD.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OERMSD-PARTMOL

   .. oe:source:: OERMSD.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OERMSD-PARTMOL
         
   .. seealso::

      * :oe:func:`OEChem::OEWeightedRMSD` function
      * :ref:`OEConfRMSD <OEChem_OEConfRMSD>` class

   .. admonition:: Code Example

      * :ref:`section_example_oechem_smartsalign` example
      * :ref:`section_example_oechem_cliquealign` example


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OERandomizeTorsions

.. oe:function:: OERandomizeTorsions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERandomizeTorsions(OEMolBase& mol, double maxRadians)
         bool OERandomizeTorsions(OEMolBase& mol, double maxRadians,
                                  const OESystem::OEUnaryPredicate<OEBondBase>& isRotor)

   .. oe:language:: python

      .. oe:api:: python

         OERandomizeTorsions(arg1: Union[OEGraphMol,OEMol,OEQMol],
                             maxRadians: float) -> bool
         OERandomizeTorsions(arg1: Union[OEGraphMol,OEMol,OEQMol],
                             maxRadians: float, isRotor: OEUnaryBondPred) -> bool

   Modifies each of the torsions in a molecule by a random value between
   ``+maxRadians`` and ``-maxRadians``.  While most people think about
   this sort of function in degrees, all angles in **OEChem TK** are measures
   in radians.  The following simple constants may be used
   :oe:const:`OEMath::OEMath::Pi`, :oe:const:`OEMath::OEMath::Rad2Deg` and
   :oe:const:`OEMath::OEMath::Deg2Rad` to generate the appropriate value.

   There are two API points, the one with two arguments applies the
   random torsion adjustment to every bond for which the **OEChem TK** bond
   predicate 'IsRotor` returns ``true``.  The second API point has an
   additional argument in which the user can specify a functor which
   defines which bonds are rotatable.  If the user's functor causes the
   function to attempt to apply a random rotation on a ring bond, no
   change in the internal coordinates will occur, however, the frame of
   reference of the molecule may change.

   The functions return ``true`` if completes successfully.  The functions 
   return ``false`` if there are no torsions to randomize.

   *mol*
      The molecule to randomize torsions of.

   *maxRadians*
      Maximum value of torsions angle to be modified, in radians. 

   *isRotor*
      Predicate to define which torsions should be randomized.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadCDXFile

.. oe:function:: OEReadCDXFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadCDXFile(oemolistream& ifs, OEMolBase& mol,
                            unsigned int flavor = OEIFlavor::CDX::DEFAULT)

   .. oe:language:: python

      .. oe:api:: python

         OEReadCDXFile(ifs: oemolistream, mol: Union[OEGraphMol,OEMol,OEQMol],
                       flavor: int) -> bool

   Reads the contents of a ChemDraw CDX file into the specified
   :ref:`OEMolBase <OEChem_OEMolBase>`.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadCIFFile

..  _OEChem_OEReadCIFFile:

.. oe:function:: OEReadCIFFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadCIFFile(oemolistream& ifs, OEMolBase& mol,
                            unsigned int flavor)

   .. oe:language:: python

      .. oe:api:: python

         OEReadCIFFile(ifs: oemolistream, mol: Union[OEGraphMol,OEMol,OEQMol],
                       flavor: int) -> bool

   Reads a molecule from the specified input stream, 'ifs', in CIF file format. THis supports the 
   small molecule smCIF, macromolecule mmCIF, and chemical component ccCIF format variants.
   The reader peeks into the file to check for specific tags to determine whether it is a smCIF, ccCIF or
   mmCIF formatted file, given that the extension used is the same. The mmCIF reader can be enforced by
   setting the :oe:const:`OEChem::OEFormat::MMCIF` on the input stream.
   A number of different format variants are supported by the use of 'flavor' parameter from the
   :oe:const:`OEChem::OEIFlavor::CIF` or the :oe:const:`OEChem::OEIFlavor::MMCIF` namespace.
   This function returns ``true`` if the operation was successful, and ``false`` if an end-of-file was encountered.

   The atoms (_atom_site) table has four “author defined alternatives” (.auth_*) that have similar meaning 
   to the “primary” identifiers (.label_*). Two of them, atom name (atom_id) and residue name (comp_id) almost 
   never differ. The other two, chain name (asym_id) and sequence number (seq_id) may differ in a confusing 
   way (A,B,C <-> C,A,B). Thus we read and store only one, auth if it is present, otherwise label. 

   In all PDB entries each auth_asym_id “chain” is split into one or more label_asym_id subchains. 
   The polymer (residues before the TER record in the PDB format) goes into one subchain; all the
   other (non-polymer) residues are put into single-residue subchains; except the waters, which are all put 
   into one subchain. Currently, wwPDB treats non-linear polymers (such as sugars) as non-polymers.

   .. note::

      It is recommended to always use the author-defined names, for consistency with the PDB 
      format and with the literature.

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadCSVFile

.. oe:function:: OEReadCSVFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadCSVFile(oemolistream& ifs, OEMolBase& mol,
                            unsigned int flavor = OEIFlavor::CSV::DEFAULT)

   .. oe:language:: python

      .. oe:api:: python

         OEReadCSVFile(ifs: oemolistream, mol: Union[OEGraphMol,OEMol,OEQMol],
                       flavor: int) -> bool

   Read the next molecule from a comma-separated-value, CSV, file
   opened by ``ifs`` into ``mol``. The specific layout of the file is
   described in the :ref:`section_moltaggeddata_CSV` section. The
   ``flavor`` argument is a value OR'd together from the values in the
   :oe:constns:`OEChem::OEIFlavor::CSV` namespace. Returns ``true`` if a
   molecule was successfully read, ``false`` otherwise.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadCSVHeader

.. oe:function:: OEReadCSVHeader

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadCSVHeader(oemolistream& ifs, OECSVHeader& header,
                              unsigned int flavor = OEIFlavor::CSV::DEFAULT)

   .. oe:language:: python

      .. oe:api:: python

         OEReadCSVHeader(ifs: oemolistream, header: OECSVHeader, flavor: int) -> bool

   Attempt to read the first line of the file opened by ``ifs`` into a
   :ref:`OECSVHeader <OEChem_OECSVHeader>` object. This initializes the
   :ref:`OECSVHeader <OEChem_OECSVHeader>` object with column names described by
   that line. If :oe:const:`OEChem::OEIFlavor::CSV::Header` is not specified in
   the ``flavor`` argument or the first column of the first line is
   interpretable as :term:`SMILES`, then the column names will be
   initialized to the following pattern based upon the number of
   columns found in the first line: SMILES, TITLE, OE_CSV_COLUMN_1,
   OE_CSV_COLUMN_2, ..., OE_CSV_COLUMN_N.

   .. seealso::

      :ref:`section_moltaggeddata_CSV`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadFASTAFile

.. oe:function:: OEReadFASTAFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadFASTAFile(oemolistream& ifs, OEMolBase& mol,
                              bool customResidues = false,
                              bool embeddedSmiles = false)

   .. oe:language:: python

      .. oe:api:: python

         OEReadFASTAFile(ifs: oemolistream,
                         mol: Union[OEGraphMol,OEMol,OEQMol],
                         customResidues: bool = False,
                         embeddedSmiles: bool = False) -> bool

   Reads the contents of a FASTA sequence file into the specified
   :ref:`OEMolBase <OEChem_OEMolBase>`.  The amino acid residues of the sequence
   file are automatically expanded to an all atom representation.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadMDLFile

.. oe:function:: OEReadMDLFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMDLFile(oemolistream& ifs, OEMolBase& mol,
                            const char* id = "")

   .. oe:language:: python

      .. oe:api:: python

         OEReadMDLFile(ifs: oemolistream, mol: Union[OEGraphMol,OEMol,OEQMol],
                       id: str = "") -> bool

   Reads the contents of the MDL mol or SDF file into the specified
   :ref:`OEMolBase <OEChem_OEMolBase>`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadMDLQueryFile

.. oe:function:: OEReadMDLQueryFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMDLQueryFile(oemolistream& ifs, OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMDLQueryFile(ifs: oemolistream,
                            mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Reads the contents of the MDL query file into the specified
   :ref:`OEMolBase <OEChem_OEMolBase>` object. The atom and bond query features
   present in the MDL file are attached as generic data to the related
   atoms and bonds of the :ref:`OEMolBase <OEChem_OEMolBase>` object.  An
   :ref:`OEQMolBase <OEChem_OEQMolBase>` object can be subsequently created from
   this :ref:`OEMolBase <OEChem_OEMolBase>` object by calling the
   :oe:func:`OEChem::OEBuildMDLQueryExpressions`
   function. :oe:func:`OEChem::OEReadMDLQueryFile` is a low-level reader and as such
   will not call :oe:meth:`Clear<OEChem::OEMolBase::Clear>` on each
   read.

   .. seealso::

      * :ref:`chapter_mdlqueries` chapter

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMDLQueryFile(oemolistream& ifs, OEQMolBase& qmol,
                                 unsigned int opts = OEMDLQueryOpts::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMDLQueryFile(ifs: oemolistream, qmol: OEQMol, opts: int) -> bool

   Reads the contents of the MDL query file into the specified
   :ref:`OEQMolBase <OEChem_OEQMolBase>` object.
   The option from the :oe:constns:`OEChem::OEMDLQueryOpts` namespace
   determine how the MDL query is interpreted.

   .. seealso::

      * :ref:`chapter_mdlqueries` chapter



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadMDLReactionQueryFile

.. oe:function:: OEReadMDLReactionQueryFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMDLReactionQueryFile(oemolistream& ifs, OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMDLReactionQueryFile(ifs: oemolistream,
                                    mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Reads the contents of the MDL reaction file into the specified
   :ref:`OEMolBase <OEChem_OEMolBase>` object. :oe:func:`OEChem::OEReadMDLReactionQueryFile`
   is a low-level reader and as such will not call :oe:meth:`Clear<OEChem::OEMolBase::Clear>`
   on each read.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMDLReactionQueryFile(oemolistream& ifs, OEQMolBase& qmol,
                                         unsigned int opts = OEMDLQueryOpts::ReactionQuery)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMDLReactionQueryFile(ifs: oemolistream, qmol: OEQMol, opts: int) -> bool

   Reads the contents of the MDL reaction file into the specified
   :ref:`OEQMolBase <OEChem_OEQMolBase>` object.
   The option from the :oe:constns:`OEChem::OEMDLQueryOpts` namespace
   determine how the MDL reaction is interpreted.

   .. seealso::

      .. oe:language:: c++

         * :ref:`subsection_reactions_libgen_MDL` section
         * Example program :ref:`libgen.cpp<section_example_oechem_libgen>`

      .. oe:language:: python

         * :ref:`subsection_reactions_libgen_MDL` section
         * Example program :ref:`libgen.py<section_example_oechem_libgen>`

      .. oe:language:: java

         * :ref:`subsection_reactions_libgen_MDL` section
         * Example program :ref:`LibGen.java<section_example_oechem_libgen>`

      .. oe:language:: csharp

         * :ref:`subsection_reactions_libgen_MDL` section
         * Example program :ref:`LibGen.cs<section_example_oechem_libgen>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadMOPACFile

.. oe:function:: OEReadMOPACFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMOPACFile(oemolistream& ifs, OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMOPACFile(ifs: oemolistream, mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Reads the contents of the MOPAC output file into the specified
   :ref:`OEMolBase <OEChem_OEMolBase>`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadMacroModelFile

.. oe:function:: OEReadMacroModelFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMacroModelFile(oemolistream& ifs, OEMolBase& mol)
         bool OEReadMacroModelFile(oemolistream& ifs, OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMacroModelFile(ifs: oemolistream, mol: Union[OEGraphMol,OEQMol]) -> bool
         OEReadMacroModelFile(ifs: oemolistream, mol: OEMol) -> bool

   Reads the contents of the Schrodinger MacroModel format file into
   the specified :ref:`OEMolBase <OEChem_OEMolBase>`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadMol2File

.. oe:function:: OEReadMol2File

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMol2File(oemolistream& ifs, OEMolBase& mol,
                             bool m2h = false)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMol2File(ifs: oemolistream, mol: Union[OEGraphMol,OEMol,OEQMol],
                        m2h: bool = False) -> bool

   Reads the contents of the Tripos Sybyl mol2 file into the specified
   :ref:`OEMolBase <OEChem_OEMolBase>`.  The 'm2h' parameter indicates whether the
   connection table already has all hydrogen atoms explicit, informing
   the **OEChem TK** mol2 file reader not to adjust implicit hydrogen counts
   to satisfy valence and formal charge rules.



.. oe:language:: c++

   .. oe:namespace:: OEChem

   .. meta::
      :keywords: OEReadMolFromString

   ..   _OEChem_OEReadMolFromString:

   .. oe:function:: OEReadMolFromString

      .. oe:api:: c++

         bool OEReadMolFromString(OEMolBase& mol, const std::string& format,
                                  const std::string& data)
         bool OEReadMolFromString(OEMolBase& mol, unsigned format, bool gzip,
                                  const std::string& data)
         bool OEReadMolFromString(OEMolBase& mol, unsigned format,
                                  unsigned flavor, bool gzip,
                                  const std::string& data)

         bool OEReadMolFromString(OEMCMolBase& mol, const std::string& format,
                                  const std::string& data)
         bool OEReadMolFromString(OEMCMolBase& mol, unsigned format, bool gzip,
                                  const std::string& data)
         bool OEReadMolFromString(OEMCMolBase& mol, unsigned format,
                                  unsigned flavor, bool gzip,
                                  const std::string& data)

.. oe:language:: java

   .. oe:namespace:: OEChem

   .. meta::
      :keywords: OEReadMolFromByteArray

   ..   _OEChem_OEReadMolFromByteArray:

   .. oe:function:: OEReadMolFromByteArray

      .. oe:api:: java

         boolean OEReadMolFromByteArray(OEMolBase mol, String format,
                                        byte[] data)
         boolean OEReadMolFromByteArray(OEMolBase mol, int format,
                                        boolean gzip, byte[] data)
         boolean OEReadMolFromByteArray(OEMolBase mol, int format, int flavor,
                                        boolean gzip, byte[] data)

         boolean OEReadMolFromByteArray(OEMCMolBase mol, String format,
                                        byte[] data)
         boolean OEReadMolFromByteArray(OEMCMolBase mol, int format,
                                        boolean gzip, byte[] data)
         boolean OEReadMolFromByteArray(OEMCMolBase mol, int format,
                                        int flavor, boolean gzip, byte[] data)

.. oe:language:: python

   .. oe:namespace:: OEChem

   .. meta::
      :keywords: OEReadMolFromBytes

   ..   _OEChem_OEReadMolFromBytes:

   .. oe:function:: OEReadMolFromBytes

      .. oe:api:: python

         OEReadMolFromBytes(OEMolBase, format, data) -> bool
         OEReadMolFromBytes(OEMolBase, format, gzip, data) -> bool
         OEReadMolFromBytes(OEMolBase, format, flavor, gzip, data) -> bool

         OEReadMolFromBytes(OEMCMolBase, format, data) -> bool
         OEReadMolFromBytes(OEMCMolBase, format, gzip, data) -> bool
         OEReadMolFromBytes(OEMCMolBase, format, flavor, gzip, data) -> bool

.. oe:language:: csharp

   .. oe:namespace:: OEChem

   .. meta::
      :keywords: OEReadMolFromBytes, OEReadMolFromByteArray, OEReadMolFromString

   ..   _OEChem_OEReadMolFromBytes:

   .. oe:function:: OEReadMolFromBytes

      .. oe:api:: csharp

         boolean OEReadMolFromByteArray(OEMolBase mol, String format,
                                        OEIntArray data)
         boolean OEReadMolFromByteArray(OEMCMolBase mol, String format,
                                        OEIntArray data)

         boolean OEReadMolFromBytes(OEMCMolBase mol, String format, byte[] data)
         boolean OEReadMolFromBytes(OEMCMolBase mol, int format, int flavor,
                                    boolean gzip, byte[] data)

         boolean OEReadMolFromBytes(OEMolBase mol,  String format, byte[] data)
         boolean OEReadMolFromBytes(OEMolBase mol, int format, int flavor,
                                    boolean gzip, byte[] data)

         boolean OEReadMolFromBytes(OEMCMolBase mol, String format, byte[] data)
         boolean OEReadMolFromBytes(OEMCMolBase mol, int format, int flavor,
                                    boolean gzip, byte[] data)

.. oe:language:: python c++ java

   Instantiates a molecule from the contents of 'data' in terms of 'format'. 'format' must be a file extension
   that is readable by OpenEye, for example: ".oeb.gz". Overloads which take
   a Boolean 'gzip' parameter or an unsigned 'flavor' and Boolean 'gzip' parameters expect
   the format or the format and flavor to be specified by one of the constants 
   in :oe:constns:`OEChem::OEFormat` and :oe:constns:`OEChem::OEIFlavor`.

   Returns 'true' if decoding was successful.

.. oe:language:: csharp

   Instantiates a molecule from the contents of 'data' in terms of 'format'. 'format' must be a file extension
   that is readable by OpenEye, for example: ".oeb.gz". Overloads which take
   an unsigned 'format', unsigned 'flavor' and Boolean 'gzip' parameters expect
   the format or the format and flavor to be specified by one of the constants
   in :oe:constns:`OEChem::OEFormat` and :oe:constns:`OEChem::OEIFlavor`.

   Returns 'true' if decoding was successful.

   .. warning::

      The overload that takes an :ref:`OEIntArray <OEChem_OEIntArray>` is deprecated as of 2018.Feb and will be removed in a future
      version of **OEChem TK**, please use :oe:func:`OEChem::OEReadMolFromBytes` instead.

.. oe:language:: c++

   .. oe:source:: EncodeMols.cpp
      :language: c++
      :frag:     SNIPPET-READMOL
      :noindent:

   .. oe:source:: EncodeMols.cpp
      :language: c++
      :frag:     SNIPPET-READMOL2
      :noindent:

   .. oe:source:: EncodeMols.cpp
      :language: c++
      :frag:     SNIPPET-READMOL3
      :noindent:

.. oe:language:: python

   .. oe:source:: EncodeMols.py
      :language: python
      :frag:     SNIPPET-READMOL
      :noindent:

   .. oe:source:: EncodeMols.py
      :language: python
      :frag:     SNIPPET-READMOL2
      :noindent:

   .. oe:source:: EncodeMols.py
      :language: python
      :frag:     SNIPPET-READMOL3
      :noindent:

.. oe:language:: java

   .. oe:source:: EncodeMols.java
      :language: java
      :frag:     SNIPPET-READMOL
      :noindent:

   .. oe:source:: EncodeMols.java
      :language: java
      :frag:     SNIPPET-READMOL2
      :noindent:

   .. oe:source:: EncodeMols.java
      :language: java
      :frag:     SNIPPET-READMOL3
      :noindent:

.. oe:language:: csharp

   .. oe:source:: EncodeMols.cs
      :language: csharp
      :frag:     SNIPPET-READMOL
      :noindent:

   .. oe:source:: EncodeMols.cs
      :language: csharp
      :frag:     SNIPPET-READMOL3
      :noindent:



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadMolecule

.. oe:function:: OEReadMolecule

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMolecule(oemolistream& ifs, OEMol& mol)
         bool OEReadMolecule(oemolistream& ifs, OEQMol& mol)
         bool OEReadMolecule(oemolistream& ifs, OEMolBase& mol)
         bool OEReadMolecule(oemolithread& ifs, OEMolBase& mol)
         bool OEReadMolecule(oemolistream& ifs, OEGraphMol& mol)
         bool OEReadMolecule(oemolithread& ifs, OEQMolBase& mol)
         bool OEReadMolecule(oemolistream& ifs, OEQMolBase& mol)
         bool OEReadMolecule(oemolistream& ifs, OEMCMolBase& mol)
         bool OEReadMolecule(oemolithread& ifs, OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMolecule(ifs: oemolistream, mol: OEMol) -> bool
         OEReadMolecule(ifs: oemolistream, mol: OEQMol) -> bool
         OEReadMolecule(ifs: oemolistream, mol: OEGraphMol) -> bool
         OEReadMolecule(ifs: oemolithread, mol: OEGraphMol) -> bool
         OEReadMolecule(ifs: oemolithread, mol: OEQMol) -> bool
         OEReadMolecule(ifs: oemolithread, mol: OEMol) -> bool

   Reads the contents of the input molstream into the specified molecule
   using the file format currently associated with the
   :ref:`oemolistream <OEChem_oemolistream>`.  The assumed file format may be
   specified using the :oe:meth:`OEChem::oemolistream::SetFormat` method.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`convert.cpp<section_example_oechem_convert>`

  .. oe:language:: python

      * Example program :ref:`convert.py<section_example_oechem_convert>`

  .. oe:language:: java

      * Example program :ref:`Convert.java<section_example_oechem_convert>`

  .. oe:language:: csharp

      * Example program :ref:`Convert.cs<section_example_oechem_convert>`



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEReadMonomerSet

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMonomerSet(OEMonomerSet& monomers,
                               const std::string& jsonFileName)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMonomerSet(monomers: OEMonomerSet, jsonFileName: str) -> bool

   Reads all monomer definitions from the given json file and adds them to the 
   the :oe:cls:`OEChem::OEMonomerSet` objects.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMonomerSet(OEMonomerSet& monomers,
                               const std::string& jsonFileName,
                               const std::string& codeSet)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMonomerSet(monomers: OEMonomerSet, jsonFileName: str,
                          codeSet: str) -> bool

   Reads all monomer definitions from the given json file and but only adds those to 
   the :oe:cls:`OEChem::OEMonomerSet` objects which are defined in the given code-set.

   .. seealso::

      * :oe:cls:`OEChem::OEMonomerSet` class
      * :oe:func:`OEChem::OELoadStandardMonomerSet` and :oe:func:`OEChem::OELoadOpenEyeMonomerSet` functions
      * :oe:func:`OEChem::OEWriteMonomerSet` function

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadOEBFile

.. oe:function:: OEReadOEBFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEReadOEBFile(OEPlatform::oeistream& is, OEMolBase& mol,
                                    const OESystem::OEBinaryIOHandlerBase& handler)
         unsigned int OEReadOEBFile(OEPlatform::oeistream& is,
                                    OEMCMolBase& mol,
                                    const OESystem::OEBinaryIOHandlerBase& handler)

   .. oe:language:: python

      .. oe:api:: python

         OEReadOEBFile(ifs: oeistream, mol: Union[OEGraphMol,OEQMol],
                       handler: OEBinaryIOHandlerBase) -> int
         OEReadOEBFile(ifs: oeistream, mol: OEMol,
                       handler: OEBinaryIOHandlerBase) -> int

   Reads a molecule from the specified input stream in the
   OpenEye Binary Version 2 format. This is considered a low-level
   API for advanced users that will only parse the part of the OEB
   specified by the handlers registered with
   `handler`. :oe:func:`OEChem::OEReadMolecule` is the preferred way to
   read molecules from OEB files, as it will handle many corner cases
   more cleanly. This function only performs the parsing of the
   actual OEB data based upon the given 'handler'.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadPDBFile

.. oe:function:: OEReadPDBFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadPDBFile(oemolistream& ifs, OEMolBase& mol,
                            unsigned int flavor = OEIFlavor::PDB::DEFAULT)

   .. oe:language:: python

      .. oe:api:: python

         OEReadPDBFile(ifs: oemolistream, mol: Union[OEGraphMol,OEMol,OEQMol],
                       flavor: int) -> bool

   Reads a molecule from the specified input stream, 'ifs', in Brookhaven
   PDB file format.  A number of different PDB format variants are
   supported by the use of 'flavor' parameter from the
   :oe:constns:`OEChem::OEIFlavor::PDB` namespace.  This function returns
   ``true`` if the operation was successful, and ``false`` if an end-of-file was
   encountered.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadRxnFile

.. oe:function:: OEReadRxnFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadRxnFile(oemolistream& ifs, OEMolBase& mol,
                            const char* id = "", bool query = false)

   .. oe:language:: python

      .. oe:api:: python

         OEReadRxnFile(ifs: oemolistream, mol: Union[OEGraphMol,OEMol,OEQMol],
                       id: str = "", query: bool = False) -> bool



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadSketchFile

.. oe:function:: OEReadSketchFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadSketchFile(oemolistream& ifs, OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEReadSketchFile(ifs: oemolistream,
                          mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Reads the contents of the MDL ISIS sketch file into the specified
   :ref:`OEMolBase <OEChem_OEMolBase>`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEReadXYZFile

.. oe:function:: OEReadXYZFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadXYZFile(oemolistream& ifs, OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEReadXYZFile(ifs: oemolistream, mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Reads the contents of the XMol XYZ format file into the specified
   :ref:`OEMolBase <OEChem_OEMolBase>`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEResidueHydrogens

.. oe:function:: OEResidueHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEResidueHydrogens(OEAtomBase* atm,
                                 unsigned style = OEPDBHydrogenStyle::Modern)
         void OEResidueHydrogens(OEMolBase& mol,
                                 unsigned style = OEPDBHydrogenStyle::Modern)

   .. oe:language:: python

      .. oe:api:: python

         OEResidueHydrogens(atm: OEAtomBase, style: int) -> None
         OEResidueHydrogens(mol: Union[OEGraphMol,OEMol,OEQMol], style: int) -> None

   This function sets the residue information associated with each
   explicit hydrogen in a molecule, from the residue information of its
   parent.



.. oe:namespace:: OEChem

..  _OEChem_OEResidueToString:

.. oe:function:: OEResidueToString

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEResidueToString(const OEChem::OEResidue& res,
                                       const std::string delimiter = " ")

   .. oe:language:: python

      .. oe:api:: python

         OEResidueToString(res: OEResidue, delimiter: str = ") -> str

   Returns the string representation of the given residue in the following format::

      <RES NAME> <RES NUMBER> <INSERT CODE> <CHAIN ID> <FRAG NUMBER> <ALT>

   Examples::

       ASP 381   A 1
       72L 301   A 5
       THR 60 A B 2
       THR 9   A 1 A

.. seealso::

   * :ref:`OEResidue <OEChem_OEResidue>` class


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OERingBondCount

.. oe:function:: OERingBondCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OERingBondCount(const OEChem::OEAtomBase&)

   .. oe:language:: python

      .. oe:api:: python

         OERingBondCount(atom: OEAtomBase) -> int

   Returns the number of bonds connected to this atom that are part of a ring.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OERotate

.. oe:function:: OERotate

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OERotate(OEMolBase& mol, const float* m)
         void OERotate(OEMolBase& mol, const double* m)
         void OERotate(OEConfBase& conf, const float* m)
         void OERotate(OEConfBase& conf, const double* m)
         void OERotate(OEMCMolBase& mcmol, const float* m)
         void OERotate(OEMCMolBase& mcmol, const double* m)

   .. oe:language:: python

      .. oe:api:: python

         OERotate(mol: Union[OEGraphMol,OEQMol], m: OEFloatArray) -> None
         OERotate(mol: Union[OEGraphMol,OEQMol], m: OEDoubleArray) -> None
         OERotate(conf: OEConfBase, m: OEFloatArray) -> None
         OERotate(conf: OEConfBase, m: OEDoubleArray) -> None
         OERotate(mcmol: OEMol, m: OEFloatArray) -> None
         OERotate(mcmol: OEMol, m: OEDoubleArray) -> None

   These functions rotate a molecule by the :math:`3 \times 3`
   rotation matrix passed as the ``m`` argument that is 9-element
   array in row-major order. 
   The rotation is defined as :math:`xyz' = m \times xyz`, where
   :math:`m` is the rotation matrix, :math:`xyz` is the original
   vector, and :math:`xyz'` is the new  vector.
   The overloads for :ref:`OEConfBase <OEChem_OEConfBase>` and
   :ref:`OEMCMolBase <OEChem_OEMCMolBase>` are for efficiency.

   *mol*
      The molecule to rotate.

   *conf*
      The conformer to rotate.

   *mcmol*
      The multi-conformer molecule to rotate.

   *m*
      The rotation matrix.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`mcs3dalign.cpp<section_example_oechem_mcs3dalign>`

  .. oe:language:: python

      * Example program :ref:`mcs3dalign.py<section_example_oechem_mcs3dalign>`

  .. oe:language:: java

      * Example program :ref:`MCS3DAlign.java<section_example_oechem_mcs3dalign>`

  .. oe:language:: csharp

      * Example program :ref:`MCS3DAlign.cs<section_example_oechem_mcs3dalign>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESameAlternateLocation

..  _OEChem_OESameAlternateLocation:

.. oe:function:: OESameAlternateLocation

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESameAlternateLocation(const OEAtomBase& res1,
                                      const OEAtomBase& res2,
                                      const bool allowBlank = false)
         bool OESameAlternateLocation(const OEResidue& res1,
                                      const OEResidue& res2,
                                      const bool allowBlank = false)

   .. oe:language:: python

      .. oe:api:: python

         OESameAlternateLocation(atom1: OEAtomBase, atom2: OEAtomBase,
                                 allowBlank: bool = False) -> bool
         OESameAlternateLocation(res1: OEResidue, res2: OEResidue,
                                 allowBlank: bool = False) -> bool

   Determines whether two atoms or their respective
   :ref:`OEResidue <OEChem_OEResidue>` s represent the same
   alternate location.  This returns ``true`` when both residue have the same 
   alternate location, or when one has a designated alternate location and 
   the other has a blank (unspecified) alternate location. This does not enforce
   that the atoms to be in the same residue.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESameChain

..  _OEChem_OESameChain:

.. oe:function:: OESameChain

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESameChain(const OEAtomBase& atom1, const OEAtomBase& atom2)
         bool OESameChain(const OEResidue& res1, const OEResidue& res2)

   .. oe:language:: python

      .. oe:api:: python

         OESameChain(atom1: OEAtomBase, atom2: OEAtomBase) -> bool
         OESameChain(res1: OEResidue, res2: OEResidue) -> bool

   Determines whether two atoms or their 
   respective :ref:`OEResidue <OEChem_OEResidue>` s are
   in the same chain.  This returns ``true`` if both residues have the same
   NMR model number, :oe:meth:`OEChem::OEResidue::GetModelNumber`, and the
   same chain identifier, :oe:meth:`OEChem::OEResidue::GetChainID`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESameResidue

..  _OEChem_SameResidue:

.. oe:function:: OESameResidue

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESameResidue(const OEAtomBase& atom1, const OEAtomBase& atom2)
         bool OESameResidue(const OEResidue& res1, const OEResidue& res2)

   .. oe:language:: python

      .. oe:api:: python

         OESameResidue(atom1: OEAtomBase, atom2: OEAtomBase) -> bool
         OESameResidue(res1: OEResidue, res2: OEResidue) -> bool

   Determines whether atoms or their respective
   :ref:`OEResidue <OEChem_OEResidue>` s represent the same
   residue.  This returns ``true`` when both residues are in the same chain
   (see :oe:func:`OEChem::OESameChain`, have the same residue number,
   :oe:meth:`OEChem::OEResidue::GetResidueNumber`, the same sequence
   insertion code, :oe:meth:`OEChem::OEResidue::GetInsertCode`, and the
   same name, :oe:meth:`OEChem::OEResidue::GetName`.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

..  _OEChem_OESameSubSearchScreenTypes:

.. oe:function:: OESameSubSearchScreenTypes

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESameSubSearchScreenTypes(const OESubSearchScreen &,
                                         const OESubSearchScreen &)

   .. oe:language:: python

      .. oe:api:: python

         OESameSubSearchScreenTypes(arg1: OESubSearchScreen,
                                    arg2: OESubSearchScreen) -> bool

   Returns whether or not the types (:ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>`) of
   the two :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>` objects are the same.

   .. oe:language:: c++ python

      **Example:**

      .. oe:source:: ScreenType.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET

      .. oe:source:: ScreenType.py
         :language: python
         :noindent:
         :frag:     SNIPPET

   .. warning::

      Screens with different types should never be compared with each other since
      they have been generated with different algorithms, they might have different
      lengths and their bits can represent different molecular features.

   .. seealso::

      * :oe:func:`OEChem::OEGetSubSearchScreenType` function
      * :oe:constns:`OEChem::OESubSearchScreenType` namespace


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEScrambleMolecule

.. oe:function:: OEScrambleMolecule

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEScrambleMolecule(OEMolBase &)

   .. oe:language:: python

      .. oe:api:: python

         OEScrambleMolecule(arg1: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Randomly reorders the atoms and bonds of a molecule.  Like
   :oe:meth:`OEChem::OEMolBase::OrderAtoms` and
   :oe:meth:`OEChem::OEMolBase::OrderBonds`, this function modifies the
   order in which atoms and bonds are visited by the iterator returned by
   :oe:meth:`OEChem::OEMolBase::GetAtoms` and
   :oe:meth:`OEChem::OEMolBase::GetBonds` respectively.  This function
   does not affect the atom or bond indices of any of the atoms or bonds
   of the molecule.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`randomizeatoms.cpp<section_example_oechem_randomizeatoms>`

  .. oe:language:: python

      * Example program :ref:`randomizeatoms.py<section_example_oechem_randomizeatoms>`

  .. oe:language:: java

      * Example program :ref:`RandomizeAtoms.java<section_example_oechem_randomizeatoms>`

  .. oe:language:: csharp

      * Example program :ref:`RandomizeAtoms.cs<section_example_oechem_randomizeatoms>`



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

..  _OEChem_OEScreen:

.. oe:function:: OEScreen

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEScreen(const OESubSearchScreen& query,
                       const OESubSearchScreen& target)

   .. oe:language:: python

      .. oe:api:: python

         OEScreen(query: OESubSearchScreen, target: OESubSearchScreen) -> bool

   Returns whether an :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>` object generated
   for a target molecule can be matched to the :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>`
   object generated for a query molecule.

   .. oe:language:: c++ python

     The code snippet below shows how to generate a screens for a query and a target molecule
     and how to compare them using :oe:func:`OEChem::OEScreen`.

     * :oe:func:`OEChem::OEScreen` will throw a warning and returns ``false`` if the type of the
       screens are different.
     * If the query screen has any bit 'on' that is 'off' in the target molecule (i.e. query
       has some feature that is not present in the target molecule), the :oe:func:`OEChem::OEScreen`
       function returns ``false`` and the target molecule can be eliminated
       from further consideration since it can not be successfully matched to the query.
     * If all the bits that are 'on' in the query screen are also 'on' in the target screen,
       :oe:func:`OEChem::OEScreen` returns ``true`` and match has to
       be validated by performing atom-by-atom substructure match
       (see also :ref:`OESubSearch <OEChem_OESubSearch>`).

   **Example**

   .. oe:source:: SubSearchScreen.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET

   .. oe:source:: SubSearchScreen.py
      :language: python
      :noindent:
      :frag:     SNIPPET

   .. note::

      All screens provided by **OEChem TK** are rigorously tested to make sure that
      they do not eliminate any matches that would succeed when utilizing the
      more elaborate atom-by-atom substructure search algorithm.

   .. seealso::

      * :oe:func:`OEChem::OEGetSubSearchScreenType` function
      * :oe:constns:`OEChem::OESubSearchScreenType` namespace


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetDHydrogenGeom

..  _oechem_oeset2dhydrogengeom:

.. oe:function:: OESet2DHydrogenGeom

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESet2DHydrogenGeom(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OESet2DHydrogenGeom(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Assigns approximate 2D coordinates to explicit hydrogen atoms of the 
   given molecule.

   .. seealso::

      * :oe:func:`OEChem::OESet2DHydrogenGeom` function
      * :oe:func:`OEChem::OEAddExplicitHydrogens` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESet3DHydrogenGeom

.. oe:function:: OESet3DHydrogenGeom

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESet3DHydrogenGeom(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OESet3DHydrogenGeom(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Assigns approximate 3D coordinates to explicit hydrogen atoms of 
   the molecule. Only explicit hydrogen atoms with identical coordinates 
   to their parent heavy atoms are updated. 

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESet3DHydrogenGeom(OEMolBase& mol, const OEAtomBase* hatom)

   .. oe:language:: python

      .. oe:api:: python

         OESet3DHydrogenGeom(mol: Union[OEGraphMol,OEMol,OEQMol],
                             hatom: OEAtomBase) -> bool

   Assigns approximate 3D coordinates to the given hydrogen.

   .. seealso::

      * :oe:func:`OEChem::OESet2DHydrogenGeom` function
      * :oe:func:`OEChem::OEAddExplicitHydrogens` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetAngle

.. oe:function:: OESetAngle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetAngle(OEMolBase& mol, OEAtomBase* a, OEAtomBase* b,
                         OEAtomBase* c, double ang, double* axis = 0)

   .. oe:language:: python

      .. oe:api:: python

         OESetAngle(mol: Union[OEGraphMol,OEMol,OEQMol], a: OEAtomBase,
                    b: OEAtomBase, c: OEAtomBase, ang: float,
                    axis: OEDoubleArray = None) -> bool

   Sets the angle between atoms `a`, `b` and `c` to the value specified by the 
   argument `ang` in radians. The three atoms must be bonded together in a molecule,
   with atom `b` being the vertex.  All atoms which are attached to ‘c’ (excluding ‘b’) 
   are rotated. If the bond defined by atoms ‘b’ and ‘c’ are in a ring, no change to
   the angle will occur.  If an axis of rotation is not provided, the rotation is
   performed such that the three atoms stay in the same plane. The function returns 
   ``true`` if it completes successfully.  The function returns ``false`` if the 
   atoms are not bonded together, if the bond between `b` and `c` is part of a ring, or if 
   the atoms are on top of each other.
   
   *mol*
      The molecule that the three atoms belong to.

   *a*
      One of the end atoms.

   *b*
      The vertex atom.

   *c*
      One of the end atoms.

    *ang*
      The angle in radians.

    *axis*
      The axis of rotation.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetAnisou

.. oe:function:: OESetAnisou

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESetAnisou(OEAtomBase* atom, const OEAnisoUij& uij)
         void OESetAnisou(OEAtomBase* atom, int u11, int u22, int u33, int u12,
                          int u13, int u23)

   .. oe:language:: python

      .. oe:api:: python

         OESetAnisou(atom: OEAtomBase, uij: OEAnisoUij) -> None
         OESetAnisou(atom: OEAtomBase, u11: int, u22: int, u33: int, u12: int,
                     u13: int, u23: int) -> None

   This function is used to set the anisotropic B-factor parameters associated
   with an :ref:`OEAtomBase <OEChem_OEAtomBase>`.

   The form that uses a :ref:`OEAnisoUij <OEChem_OEAnisoUij>` accesses the data
   packaged within the object.

   .. seealso::

      * :ref:`OEAnisoUij <OEChem_OEAnisoUij>`
      * :ref:`OEHasAnisou <OEChem_OEHasAnisou>`
      * :oe:func:`OEChem::OEGetAnisou`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetAtomComment

.. oe:function:: OESetAtomComment

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESetAtomComment(OEAtomBase* atm, const char* c)
         void OESetAtomComment(OEAtomBase* atm, const std::string& c)

   .. oe:language:: python

      .. oe:api:: python

         OESetAtomComment(atm: OEAtomBase, c: str) -> None

   Attaches a text comment to an individual atom.  This function is used
   to manipulate atom alias information in MDL file formats.  This
   property may be retrieved using the :oe:func:`OEChem::OEGetAtomComment`
   function.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetCIPStereo

.. oe:function:: OESetCIPStereo

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetCIPStereo(OEMolBase& mol, OEAtomBase* atom,
                             unsigned int cipstereo)

   .. oe:language:: python

      .. oe:api:: python

         OESetCIPStereo(mol: Union[OEGraphMol,OEMol,OEQMol], atom: OEAtomBase,
                        cipstereo: int) -> bool

   Sets the internal **OEChem TK** stereochemistry from the given CIP atom stereo descriptor.
   The descriptor must be either :oe:const:`OEChem::OECIPAtomStereo::R` or
   :oe:const:`OEChem::OECIPAtomStereo::S`.
   This function returns true if the stereochemistry was successfully set,
   and false otherwise: *i.e.* the descriptor was invalid or the specified atom
   was not a CIP atom stereo center.

   .. seealso::

      * :oe:func:`OEChem::OEPerceiveCIPStereo` to perceive CIP atom stereo descriptor.
      * :ref:`section_stereochemistry_CIP` section

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetCIPStereo(OEMolBase& mol, OEBondBase* bond,
                             unsigned int cipstereo)

   .. oe:language:: python

      .. oe:api:: python

         OESetCIPStereo(mol: Union[OEGraphMol,OEMol,OEQMol], bond: OEBondBase,
                        cipstereo: int) -> bool

   Sets the internal **OEChem TK** stereochemistry from the given CIP atom stereo descriptor.
   The descriptor must be either :oe:const:`OEChem::OECIPBondStereo::E` or
   :oe:const:`OEChem::OECIPBondStereo::Z`.
   This function returns true if the stereochemistry was successfully set,
   and false otherwise: *i.e.* the descriptor was invalid or the specified bond
   was not a CIP bond stereo center.

   .. seealso::

      * :oe:func:`OEChem::OEPerceiveCIPStereo` to perceive CIP bond stereo descriptor.
      * :ref:`section_stereochemistry_CIP` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetComment

.. oe:function:: OESetComment

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESetComment(OEMolBase& mol, const char* c)
         void OESetComment(OEMolBase& mol, const std::string& c)

   .. oe:language:: python

      .. oe:api:: python

         OESetComment(mol: Union[OEGraphMol,OEMol,OEQMol], c: str) -> None

   Attaches a text comment to a molecule.  This comment will be written
   to the comment field of the .mol2 and .sdf molecular formats.  It will
   also be conserved in OEBinary format.  This property may be retrieved
   using the :oe:func:`OEChem::OEGetComment` function.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetDefaultFlavors

.. oe:function:: OESetDefaultFlavors

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetDefaultFlavors(oemolistream &)

   .. oe:language:: python

      .. oe:api:: python

         OESetDefaultFlavors(arg1: oemolistream) -> bool

   Sets the flavors for all of the file formats associated with
   the :ref:`oemolistream <OEChem_oemolistream>` object to their default state.
   The :ref:`oemolistream <OEChem_oemolistream>` constructor invokes this function to initialize its input file format flavors.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetDefaultFlavors(oemolostream &)

   .. oe:language:: python

      .. oe:api:: python

         OESetDefaultFlavors(arg1: oemolostream) -> bool

   Sets the flavors for all of the file formats associated with
   the :ref:`oemolostream <OEChem_oemolostream>` object to their default state.
   The :ref:`oemolostream <OEChem_oemolostream>` constructor invokes this function to initialize its output file format flavors.

   .. seealso::
 
      * :oe:func:`OEChem::OESetDefaultIFlavors` and :oe:func:`OEChem::OESetDefaultOFlavors` functions
      * :oe:func:`OEChem::OEGetDefaultIFlavor` and :oe:func:`OEChem::OEGetDefaultOFlavor` functions
      * :ref:`the OEFormat namespace <OEChem_OEFormat>`
      * :oe:constns:`OEChem::OEIFlavor` and :oe:constns:`OEChem::OEOFlavor` namespaces
      * :oe:meth:`OEChem::oemolstreambase::SetFlavor` and :oe:meth:`OEChem::oemolstreambase::GetFlavor` methods


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetDefaultIFlavors

.. oe:function:: OESetDefaultIFlavors

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetDefaultIFlavors(oemolstreambase &)

   .. oe:language:: python

      .. oe:api:: python

         OESetDefaultIFlavors(arg1: oemolstreambase) -> bool

   Sets the flavors for all of the formats associated with
   the :ref:`oemolstreambase <OEChem_oemolstreambase>` object to their default state.
   The default flavors are automatically set by the
   :ref:`oemolistream <OEChem_oemolistream>` constructors.

   .. seealso::

      * :oe:func:`OEChem::OEGetDefaultIFlavor` function
      * :oe:constns:`OEChem::OEIFlavor` and :ref:`the OEFormat namespace <OEChem_OEFormat>`
      * :oe:meth:`OEChem::oemolstreambase::SetFlavor` and :oe:meth:`OEChem::oemolstreambase::GetFlavor` methods


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetDefaultOFlavors

.. oe:function:: OESetDefaultOFlavors

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetDefaultOFlavors(oemolstreambase &)

   .. oe:language:: python

      .. oe:api:: python

         OESetDefaultOFlavors(arg1: oemolstreambase) -> bool

   Sets the flavors for all of the formats associated with
   the :ref:`oemolstreambase <OEChem_oemolstreambase>` object to their default state.
   The default flavors are automatically set by the
   :ref:`oemolostream <OEChem_oemolostream>` constructors.

   .. seealso::

      * :oe:func:`OEChem::OEGetDefaultOFlavor` function
      * :oe:constns:`OEChem::OEOFlavor` and :ref:`the OEFormat namespace <OEChem_OEFormat>`
      * :oe:meth:`OEChem::oemolstreambase::SetFlavor` and :oe:meth:`OEChem::oemolstreambase::GetFlavor` methods


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetDimensionFromCoords

.. oe:function:: OESetDimensionFromCoords

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESetDimensionFromCoords(OEMolBase &)

   .. oe:language:: python

      .. oe:api:: python

         OESetDimensionFromCoords(arg1: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Assigns the molecule's dimension property from the coordinates
   using the :oe:meth:`OEChem::OEMolBase::SetDimension`
   method.  The dimension property is set to the value ``0``, ``1``,
   ``2`` or ``3`` depending upon the number of ordinates for which any
   atom has a non-zero value.

   The table below illustrates the difference between the
   :oe:func:`OEChem::OESetDimensionFromCoords` and
   :oe:func:`OEChem::OESetMDLDimensionFromCoords` functions.

   +--------------------------+--------------------------+------------------------------+
   | Coordinates              | OESetDimensionFromCoords | OESetMDLDimensionFromCoords  |
   +--------+--------+--------+                          +                              +
   |  X     |  Y     |  Z     |                          |                              |
   +========+========+========+==========================+==============================+
   |  0.00  |  0.00  |  0.00  |  0D                      |  0D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  0.00  |  0.00  |  1D                      |  2D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  0.00  |  1.00  |  0.00  |  1D                      |  2D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  0.00  |  0.00  |  1.00  |  1D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  1.00  |  0.00  |  2D                      |  2D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  0.00  |  1.00  |  1.00  |  2D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  0.00  |  1.00  |  2D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  1.00  |  1.00  |  3D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+

   .. seealso::

      * :oe:func:`OEChem::OEGetDimensionFromCoords` function
      * :oe:func:`OEChem::OEGetMDLDimensionFromCoords` and :oe:func:`OEChem::OESetMDLDimensionFromCoords` functions


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetDistance

.. oe:function:: OESetDistance

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetDistance(OEMolBase& mol, OEAtomBase* a, OEAtomBase* b,
                            double dist)

   .. oe:language:: python

      .. oe:api:: python

         OESetDistance(mol: Union[OEGraphMol,OEMol,OEQMol], a: OEAtomBase,
                       b: OEAtomBase, dist: float) -> bool

   Sets the distance between two atoms to the value specified by the argument `dist`.
   The two atoms must be bonded together.  The atom passed in as `b` is displaced.
   If the bond defined by atoms is in a ring, no change to the distance will occur.
   The function returns ``true`` if it completes successfully.  The function returns 
   ``false`` if the atoms do not form a bond, if the bond is part of a ring, or if 
   the atoms are on top of each other.
   
   *mol*
      The molecule that the pair of atom belongs to.

   *a*
      The first atom.

   *b*
      The second atom.

    *dist*
      The distance.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetMCSExhaustiveSearchTruncationLimit

.. oe:function:: OESetMCSExhaustiveSearchTruncationLimit

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESetMCSExhaustiveSearchTruncationLimit(unsigned int limit)

   .. oe:language:: python

      .. oe:api:: python

         OESetMCSExhaustiveSearchTruncationLimit(limit: int) -> None

   Sets the number of unique partial substructures that can be traversed
   during the :oe:const:`exhaustive<OEChem::OEMCSType::Exhaustive>`
   MCS search.
   If this limit is reached than the :oe:const:`exhaustive<OEChem::OEMCSType::Exhaustive>`
   MCS search throws a "MCS search truncated" waning and terminates returning the
   maximum common substructures identified prior to reaching this limit.

   .. warning::

      Use this function with caution.
      Reducing the default limit will result in terminating the exhaustive MCS searches
      prematurely thereby preventing them from locating the maximum common substructure(s).
      Increasing this limit can result in significantly increasing the execution time
      in case of complex or large molecule pairs.

   .. seealso::

      * :oe:func:`OEChem::OEGetMCSExhaustiveSearchTruncationLimit` function
      * :ref:`OEMCSSearch <OEChem_OEMCSSearch>` class.
      * :ref:`section_patternmatch_mcss` section



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetMDLDimensionFromCoords

..  _oechem_oesetmdldimensionfromcoords:

.. oe:function:: OESetMDLDimensionFromCoords

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESetMDLDimensionFromCoords(OEMolBase &)

   .. oe:language:: python

      .. oe:api:: python

         OESetMDLDimensionFromCoords(arg1: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Assigns the molecule's dimension property from the coordinates using the :oe:meth:`OEChem::OEMolBase::SetDimension` method.
   The dimension property is set to the value:
   
   * ``0`` if all x, y, z coordinates are zero
   * ``2`` if there is at least one atom with non-zero x or z coordinates
   * ``3`` it there is at least one atom with non-zero z coordinate

   The table below illustrates the difference between the :oe:func:`OEChem::OESetDimensionFromCoords` and
   :oe:func:`OEChem::OESetMDLDimensionFromCoords` functions.

   +--------------------------+--------------------------+------------------------------+
   | Coordinates              | OESetDimensionFromCoords | OESetMDLDimensionFromCoords  |
   +--------+--------+--------+                          +                              +
   |  X     |  Y     |  Z     |                          |                              |
   +========+========+========+==========================+==============================+
   |  0.00  |  0.00  |  0.00  |  0D                      |  0D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  0.00  |  0.00  |  1D                      |  2D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  0.00  |  1.00  |  0.00  |  1D                      |  2D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  0.00  |  0.00  |  1.00  |  1D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  1.00  |  0.00  |  2D                      |  2D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  0.00  |  1.00  |  1.00  |  2D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  0.00  |  1.00  |  2D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+
   |  1.00  |  1.00  |  1.00  |  3D                      |  3D                          |
   +--------+--------+--------+--------------------------+------------------------------+

   .. seealso::

      * :oe:func:`OEChem::OEGetMDLDimensionFromCoords` function
      * :oe:func:`OEChem::OEGetDimensionFromCoords` and :oe:func:`OEChem::OESetDimensionFromCoords` functions



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetMMCIFChemCompData

.. oe:function:: OESetMMCIFChemCompData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetMMCIFChemCompData(OEMolBase& mol,
                                     const OEMolBase& chemCompMol,
                                     const bool strict = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetMMCIFChemCompData(mol: Union[OEGraphMol,OEMol,OEQMol],
                                chemCompMol: Union[OEGraphMol,OEMol,OEQMol],
                                strict: bool = False) -> bool

   Updates _chem_comp sections in the MMCIF header metadata with information from the input chemCompMol molecule.
   First, a single-residue chemCompMol is checked to name match with a residue in mol molecule.
   The chemCompMol atom and bond data is then used to replace the _chem_comp header data for a similarly named residue
   in the mol. If strict is used, an additional check for atom name matching is made between the matched residue in
   the molecule and the chemCompMol.

   The following categories need to be present and properly populated in the input molecules header for this
   function. If any attributes are missing, running OEUpdateMMCIFData with ChemComp perception should populate any
   missing attributes:

     * _chem_comp.
     * _chem_comp_atom.
     * _chem_comp_bond.

   If the molecule already exists, it will replace all chemical component references of that molecule with the
   new molecule.
   By default, residue atom name matching is enforced. If strict is turned off, an :ref:`OESubSearch <OEChem_OESubSearch>`
   is used to identify structural similarity with the new molecule. If a match is found, the matching structure
   atom names will be used in the _chem_comp atom naming scheme.

   .. seealso::

      * :oe:cls:`OEChem::OECIFData` class for cif data manipulation
      * :ref:`section_moldata_MMCIF` section

   .. admonition:: Code Example

      * :ref:`section_example_oechem_setchemcomp` example


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetMMCIFData

.. oe:function:: OESetMMCIFData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetMMCIFData(OEMolBase& mol, const std::string& value)
         bool OESetMMCIFData(OEMolBase& mol, const OECIFData& cifData)

   .. oe:language:: python

      .. oe:api:: python

         OESetMMCIFData(mol: Union[OEGraphMol,OEMol,OEQMol], value: str) -> bool
         OESetMMCIFData(mol: Union[OEGraphMol,OEMol,OEQMol], cifData: OECIFData) -> bool

   Sets mmCIF metadata on a molecule. If metadata already exists,
   it is replaced with the new value.

   .. seealso::

      * :oe:func:`OEChem::OEAddMMCIFData` function to add MMCIF data
      * :ref:`section_moldata_MMCIF` section

   .. note::

      Unicode characters are not supported in either the data tag or the data value.


.. oe:language:: python java csharp

.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetOEGraphMol

.. oe:function:: OESetOEGraphMol

   .. oe:language:: java

      .. oe:api:: java

         boolean OESetOEGraphMol(OEBase obj, String tag, OEGraphMol mol)

   .. oe:language:: python

      .. oe:api:: python

         OESetOEGraphMol(obj, tag, mol)

   .. oe:language:: csharp

      .. oe:api:: csharp

         boolean OESetOEGraphMol(OEBase obj, String tag, OEGraphMol mol)

   .. oe:language:: csharp java python

      Attaches a copy of the :ref:`OEGraphMol <OEChem_OEGraphMol>` ``mol`` to
      the :ref:`OEBase <OESystem_OEBase>` ``obj`` using the ``tag`` as
      :ref:`generic data<chapter_genericdata>`.

      .. oe:language:: python

         .. note::

            Python toolkit users can use ``obj.SetData(tag, mol)``
            directly.

      .. seealso::

         * The :ref:`section_attaching_other_objects` section for example code
         * :oe:func:`OEChem::OEGetOEGraphMol`

   .. oe:language:: c++

      This function is provided in CSharp, Java and Python wrappers and
      is not needed in C++.  Use the templated
      :oe:meth:`OESystem::OEBaseDataT::SetData` method instead.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetOEMol

.. oe:function:: OESetOEMol

   .. oe:language:: java

      .. oe:api:: java

         boolean OESetOEMol(OEBase obj, String tag, OEMol mol)

   .. oe:language:: python

      .. oe:api:: python

         OESetOEMol(obj, tag, mol)

   .. oe:language:: csharp

      .. oe:api:: csharp

         boolean OESetOEMol(OEBase obj, String tag, OEMol mol)

   .. oe:language:: python java csharp

      Attaches a copy of the :ref:`OEMol <OEChem_OEMol>` ``mol`` to
      the :ref:`OEBase <OESystem_OEBase>` ``obj`` using the ``tag`` as
      :ref:`generic data<chapter_genericdata>`.

      .. seealso::

         * The :ref:`section_attaching_other_objects` section for example code
         * :oe:func:`OEChem::OEGetOEMol`

   .. oe:language:: c++

      This function is provided in CSharp, Java and Python wrappers and
      is not needed in C++.  Use the templated
      :oe:meth:`OESystem::OEBaseDataT::SetData` method instead.


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetOEQMol

.. oe:function:: OESetOEQMol

   .. oe:language:: java

      .. oe:api:: java

         boolean OESetOEQMol(OEBase obj, String tag, OEQMol mol)

   .. oe:language:: python

      .. oe:api:: python

         OESetOEQMol(obj, tag, mol)

   .. oe:language:: csharp

      .. oe:api:: csharp

         boolean OESetOEQMol(OEBase obj, String tag, OEQMol mol)

   .. oe:language:: python java csharp

      Attaches a copy of the :ref:`OEQMol <OEChem_OEQMol>` ``mol`` to
      the :ref:`OEBase <OESystem_OEBase>` ``obj`` using the ``tag`` as
      :ref:`generic data<chapter_genericdata>`.

      .. seealso::

         * The :ref:`section_attaching_other_objects` section for example code
         * :oe:func:`OEChem::OEGetOEQMol`

   .. oe:language:: c++

      This function is provided in CSharp, Java and Python wrappers and
      is not needed in C++.  Use the templated
      :oe:meth:`OESystem::OEBaseDataT::SetData` method instead.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetPDBData

.. oe:function:: OESetPDBData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetPDBData(OEMolBase& mol, const OESDDataPair& dp)
         bool OESetPDBData(OEMolBase& mol, const std::string& tag,
                           const std::string& value)

   .. oe:language:: python

      .. oe:api:: python

         OESetPDBData(mol: Union[OEGraphMol,OEMol,OEQMol], dp: OESDDataPair) -> bool
         OESetPDBData(mol: Union[OEGraphMol,OEMol,OEQMol], tag: str, value: str) -> bool

   Sets a PDB tag and value data pair to a molecule. Both the tag and the value must be a string.
   If an item with the same tag already exists, it is replaced with the new value.

   .. seealso::

      * :oe:func:`OEChem::OEAddPDBData` function to add multiple PDB data
      * :ref:`section_moltaggeddata_PDB` section

   .. note::

      Unicode characters are not supported neither in the data tag nor in the data value.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetPackedCoords

.. oe:function:: OESetPackedCoords

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESetPackedCoords(OEMolBase& mol, const float* coords)
         void OESetPackedCoords(OEMolBase& mol, const double* coords)

   .. oe:language:: python

      .. oe:api:: python

         OESetPackedCoords(mol: Union[OEGraphMol,OEMol,OEQMol],
                           coords: OEFloatArray) -> None
         OESetPackedCoords(mol: Union[OEGraphMol,OEMol,OEQMol],
                           coords: OEDoubleArray) -> None

   Sets the coordinates of the molecule to the coordinates passed in the
   coords argument.  The coords array must be at least of size
   :oe:meth:`OEChem::OEMolBase::NumAtoms` ``*3``.  The atom coordinates in the coords array
   should be packed and they should be in the same order as the atoms in
   the iterator returned by :oe:meth:`OEChem::OEMolBase::GetAtoms`.

   *mol*
      The molecule to set coordinates.

   *coords*
      The array with coordinates.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetSDData

.. oe:function:: OESetSDData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetSDData(OEMolBase& mol, const OESDDataPair& dp)
         bool OESetSDData(OEMolBase& mol, const std::string& tag,
                          const std::string& value)

   .. oe:language:: python

      .. oe:api:: python

         OESetSDData(mol: Union[OEGraphMol,OEMol,OEQMol], dp: OESDDataPair) -> bool
         OESetSDData(mol: Union[OEGraphMol,OEMol,OEQMol], tag: str, value: str) -> bool

   Sets an SD tag and value data pair to a molecule. Both the tag and the value must be a string.
   If an item with the same tag already exists, it is replaced with the new value.

   .. seealso::

      * :oe:func:`OEChem::OEAddSDData` function to add multiple SD data with the same tag
      * :oe:func:`OEChem::OEGetSDData` function
      * :oe:func:`OEChem::OEGetSDDataPairs` function to access multiple items with the same tag
      * :ref:`section_moltaggeddata_SD` section

   .. admonition:: Code Example

      * :ref:`section_example_oechem_csv2sdf` example

   .. note::

      Unicode characters are not supported neither in the data tag nor in the data value.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetStyle

.. oe:function:: OESetStyle

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESetStyle(OEChem::OEMolBase& mol, const OE3DMolStyle& style)
         void OESetStyle(OEChem::OEAtomBase& atom, const OE3DMolStyle& style)
         void OESetStyle(OESystem::OEIter<OEChem::OEAtomBase>& atoms,
                         const OE3DMolStyle& style)

   .. oe:language:: python

      .. oe:api:: python

         OESetStyle(mol: Union[OEGraphMol,OEMol,OEQMol], style: OE3DMolStyle) -> None
         OESetStyle(atom: OEAtomBase, style: OE3DMolStyle) -> None
         OESetStyle(atoms: OEAtomIter, style: OE3DMolStyle) -> None

   Sets the :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` of a 
   :ref:`OEMolBase <OEChem_OEMolBase>`, :ref:`OEAtomBase <OEChem_OEAtomBase>`, or 
   an iterator of :ref:`OEAtomBase <OEChem_OEAtomBase>`.

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetStyleIndex

.. oe:function:: OESetStyleIndex

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESetStyleIndex(OEAtomBase& atom, unsigned int idx)
         void OESetStyleIndex(OEConfBase& conf, unsigned int idx)

   .. oe:language:: python

      .. oe:api:: python

         OESetStyleIndex(atom: OEAtomBase, idx: int) -> None
         OESetStyleIndex(conf: OEConfBase, idx: int) -> None

   Sets the style index of a specified :ref:`OEAtomBase <OEChem_OEAtomBase>` 
   or :ref:`OEConfBase <OEChem_OEConfBase>`.

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESetTorsion

.. oe:function:: OESetTorsion

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetTorsion(OEMolBase& mol, OEAtomBase* a, OEAtomBase* b,
                           OEAtomBase* c, OEAtomBase* d, double ang)
         bool OESetTorsion(OEConfBase& conf, OEAtomBase* a, OEAtomBase* b,
                           OEAtomBase* c, OEAtomBase* d, double ang)

   .. oe:language:: python

      .. oe:api:: python

         OESetTorsion(arg1: Union[OEGraphMol,OEMol,OEQMol], a: OEAtomBase,
                      b: OEAtomBase, c: OEAtomBase, d: OEAtomBase, ang: float) -> bool
         OESetTorsion(arg1: OEConfBase, a: OEAtomBase, b: OEAtomBase,
                      c: OEAtomBase, d: OEAtomBase, ang: float) -> bool

   Sets torsion angle defined by atoms `a`, `b`, `c` and `d` to the angle
   in the argument radians.  It is presumed that each of these atoms are
   members of the molecules passed to the function.  All atoms which are
   attached to 'c' (excluding 'b') are rotated.  If the bond defined by
   atoms 'b' and 'c' are in a ring, no change to the torsion will occur.
   However, an overall rotation of the molecule may be a side effect.
   The functions return ``true`` if completes successfully.  The functions 
   return ``false`` if the central bond is part of a ring, or if 
   the atoms are on top of each other.

   *mol*
      The molecule that the atoms belong to.

   *conf*
      The conformer that the atoms belong to.

    *a*
      One of the end atoms in the torsion.

    *b*
      Atom that is connected to `a` in the torsion.

    *c*
      Atom that is connected to `d` in the torsion.

    *d*
      The other end atom in the torsion.

    *ang*
      The angle in radians.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEShortestPath

.. oe:function:: OEShortestPath

   .. list-table:: **The overloaded versions of the OEShortestPath function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OEShortestPath(atomA, atomB)<api_OEShortestPath_OEAtomBase_OEAtomBase>`
        - find shortest path between two atoms
      * - :ref:`OEShortestPath(atomA, atomB, atompred)<api_OEShortestPath_OEAtomBase_OEAtomBase_AtomPred>`
        - find shortest path between two atoms (excluding certain atoms)
      * - :ref:`OEShortestPath(atomA, atomB, bondpred)<api_OEShortestPath_OEAtomBase_OEAtomBase_BondPred>`
        - find shortest path between two atoms (excluding certain bonds)

   .. _api_OEShortestPath_OEAtomBase_OEAtomBase:

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEAtomBase>* OEShortestPath(const OEAtomBase* a,
                                                          const OEAtomBase* b)

   .. oe:language:: python

      .. oe:api:: python

         OEShortestPath(a: OEAtomBase, b: OEAtomBase) -> OEAtomIter

   Returns a shortest path between the two given atoms. If no path exists
   the :oe:func:`OEChem::OEShortestPath` function returns an empty iterator.

   **Example**

   .. oe:source:: ShortestPath.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OESHORTESTPATH

   .. oe:source:: ShortestPath.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OESHORTESTPATH

   .. oe:source:: ShortestPath.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OESHORTESTPATH

   .. oe:source:: ShortestPath.cs
      :language: cs
      :noindent:
      :frag:     SNIPPET-OESHORTESTPATH

   .. _figure_OEShortestPath:

   .. figure:: oechemtk/images/OEShortestPath.*
      :align:  center

      **Example of shortest path between atom 2 and 8**

   .. note::

      The shortest path returned by the :oe:func:`OEChem::OEShortestPath` function is
      non-unique. There are more than one valid shortest path can exist between two
      atoms. The :oe:func:`OEChem::OEShortestPath` only returns one of them.
      For example, there are three valid six atoms long shortest path exist between atom
      1 and 7 in the example above:  ``1, 2, 3, 9, 8, 7``,  ``1, 0, 5, 4, 6, 7``, and
      ``1, 2, 3, 4, 6, 7``.

   .. _api_OEShortestPath_OEAtomBase_OEAtomBase_AtomPred:

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEAtomBase>* OEShortestPath(const OEAtomBase* a,
                                                          const OEAtomBase* b,
                                                          const OESystem::OEUnaryPredicate<OEAtomBase>& excludeatoms)

   .. oe:language:: python

      .. oe:api:: python

         OEShortestPath(a: OEAtomBase, b: OEAtomBase,
                        excludeAtoms: OEUnaryAtomPred) -> OEAtomIter

   Returns a shortest path between the two given atoms. The returned path will exclude
   any atom that satisfies the given atom predicate.
   If no path exists the :oe:func:`OEChem::OEShortestPath` function returns
   an empty iterator.

   **Example**

   .. oe:source:: ShortestPath.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OESHORTESTPATH-EXCLUDE

   .. oe:source:: ShortestPath.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OESHORTESTPATH-EXCLUDE

   .. oe:source:: ShortestPath.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OESHORTESTPATH-EXCLUDE

   .. oe:source:: ShortestPath.cs
      :language: cs
      :noindent:
      :frag:     SNIPPET-OESHORTESTPATH-EXCLUDE

   .. _figure_OEShortestPathAtomPredicate:

   .. figure:: oechemtk/images/OEShortestPath_AtomPredicate.*
      :align:  center

      **Example of shortest path between atom 2 and 8 without traversing any nitrogen atom**

   .. _api_OEShortestPath_OEAtomBase_OEAtomBase_BondPred:

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEAtomBase>* OEShortestPath(const OEAtomBase* a,
                                                          const OEAtomBase* b,
                                                          const OESystem::OEUnaryPredicate<OEBondBase>& excludebonds)

   .. oe:language:: python

      .. oe:api:: python

         OEShortestPath(a: OEAtomBase, b: OEAtomBase,
                        excludeBonds: OEUnaryBondPred) -> OEAtomIter

   Returns a shortest path between the two given atoms. The returned path will exclude
   any bond that satisfies the given bond predicate.
   If no path exists, the :oe:func:`OEChem::OEShortestPath` function returns
   an empty iterator.

.. seealso::

   * :oe:func:`OEChem::OEGetPathLength` function

   .. oe:language:: c++

      * Example program :ref:`minpath.cpp<section_example_oechem_minpath>`

   .. oe:language:: python

      * Example program :ref:`minpath.py<section_example_oechem_minpath>`

   .. oe:language:: java

      * Example program :ref:`MinPath.java<section_example_oechem_minpath>`

   .. oe:language:: csharp

      * Example program :ref:`MinPath.cs<section_example_oechem_minpath>`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESingleBondCount

.. oe:function:: OESingleBondCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OESingleBondCount(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OESingleBondCount(atm: OEAtomBase) -> int

   Returns the number of single bonds connected to an atom.  The return
   value includes the number of implicit hydrogens attached to an atom,
   as returned by the :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount`
   method.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESmartsLexReplace

.. oe:function:: OESmartsLexReplace

   .. oe:language:: c++

      .. oe:api::

         bool OESmartsLexReplace(std::string& smarts,
                                 const std::vector<std::pair<std::string, std::string> >& bindings)

   .. oe:language:: python

      .. oe:api::

         OESmartsLexReplace(smarts: str, bindings: List[(name, definition)]) -> modsmarts: str

   Replaces all the instances of ``$varname`` in the :term:`SMARTS`
   pattern ``smarts`` with the variables as defined by the mapping in
   ``bindings``.

   .. oe:language:: c++ python

      The following code demonstrates how to use
      :oe:src:`SmartsLexReplace<SmartsLexReplace>`.

   .. oe:source:: SmartsLexReplace.cpp
      :language: c++
      :frag:     SNIPPET

   .. oe:source:: SmartsLexReplace.py
      :language: python
      :frag:     SNIPPET

   .. oe:language:: c++ python

      The output of the above code snippet is the following:

      .. code-block:: console

         SMARTS = c[$([$([F,Cl]),$([Br,I])])]
         Match to chlorobenzene



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESmilesAtomCount

.. oe:function:: OESmilesAtomCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OESmilesAtomCount(const char* str)
         unsigned int OESmilesAtomCount(const std::string& str)

   .. oe:language:: python

      .. oe:api:: python

         OESmilesAtomCount(str: str) -> int

   This function efficiently determines the number of **heavy** atoms in a SMILES string,
   without converting it into an :ref:`OEMolBase <OEChem_OEMolBase>`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESmilesToMol

.. oe:function:: OESmilesToMol

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESmilesToMol(OEMolBase& mol, const std::string& str)

   .. oe:language:: python

      .. oe:api:: python

         OESmilesToMol(mol: Union[OEGraphMol,OEMol,OEQMol], str: str) -> bool

   Converts a :term:`SMILES` string into a molecule.
   After constructing the molecule the following properties are perceived:

   * Rings are perceived by calling the
     :oe:func:`OEChem::OEFindRingAtomsAndBonds` function.

   * The aromaticity is assigned by calling the
     :oe:func:`OEChem::OEAssignAromaticFlags` function using the
     :oe:const:`OEChem::OEAroModel::OpenEye` aromaticity model.

   * The chirality is perceived by calling the
     :oe:func:`OEChem::OEPerceiveChiral` function.

   The molecule object is cleared before parsing so the resulting molecule
   object only contains atoms and bonds from the :term:`SMILES`.  If one
   wishes to *add* atoms and bonds to an existing molecule, one can use
   the lower-level :oe:func:`OEChem::OEParseSmiles` function, which preserves
   any existing atoms and bonds in the molecule.

   .. seealso::

      * :oe:func:`OEChem::OEMolToSmiles` function
      * :oe:func:`OEChem::OEMolToCXSMILES` function
      * :ref:`section_molctordtor_smilesfrommol` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESortConfsBySDTag

.. oe:function:: OESortConfsBySDTag

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESortConfsBySDTag(OEChem::OEMCMolBase& mol,
                                 const std::string& sdtag, bool biggerIsBetter)

   .. oe:language:: python

      .. oe:api:: python

         OESortConfsBySDTag(mol: OEMol, sdtag: str, biggerIsBetter: bool) -> bool

   Reorders the conformers of *mol* based on SD values associated
   with the given *sdtag*.  The SD values must be numeric.
   *biggerIsBetter* controls if the highest (true) values appear
   first in the list or the lowest values (false).

   Conformers missing *sdtag* SD data will be sorted to the end of
   the list.




.. oe:namespace:: OEChem

.. meta::
   :keywords: OESortConfsByTag

.. oe:function:: OESortConfsByTag

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESortConfsByTag(OEChem::OEMCMolBase& mol,
                               const std::string& tag, bool biggerIsBetter)

   .. oe:language:: python

      .. oe:api:: python

         OESortConfsByTag(mol: OEMol, tag: str, biggerIsBetter: bool) -> bool

   Reorders the conformers of *mol* based on the value of generic
   data on the conformers with the specified *tag*.  The generic
   data must be stored as either a float or double.  
   *biggerIsBetter* controls if the highest (true) values appear
   first in the list or the lowest values (false).

   Conformers missing *tag* float/double generic data will best
   sorted to the end of the conformer list.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEString2OEAtomExpr

.. oe:function:: OEString2OEAtomExpr

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEString2OEAtomExpr(const char* expression)

   .. oe:language:: python

      .. oe:api:: python

         OEString2OEAtomExpr(expression: str) -> int



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEString2OEBondExpr

.. oe:function:: OEString2OEBondExpr

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEString2OEBondExpr(const char* expression)

   .. oe:language:: python

      .. oe:api:: python

         OEString2OEBondExpr(expression: str) -> int



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. attention::

   |PRELIMINARY-API|

.. oe:function:: OEStringToMonomerType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEStringToMonomerType(const std::string &)

   .. oe:language:: python

      .. oe:api:: python

         OEStringToMonomerType(arg1: str) -> int

   Converts a string into a constant in the :oe:constns:`OEChem::OEMonomerType` namespace.
   Returns :oe:const:`OEChem::OEMonomerType::Undefined`, if the string
   does not represent any of the specific monomer type. 

   .. seealso::

      * :oe:constns:`OEChem::OEMonomerType` namespace
      * :oe:func:`OEChem::OEMonomerTypeToString` function

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEStringToPolymerType

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEStringToPolymerType(const std::string &)

   .. oe:language:: python

      .. oe:api:: python

         OEStringToPolymerType(arg1: str) -> int

   Converts a string into a constant in the :oe:constns:`OEChem::OEPolymerType` namespace.
   Returns :oe:const:`OEChem::OEPolymerType::Undefined`, if the string
   does not represent any of the specific polymer types.

   .. seealso::

      * :oe:constns:`OEChem::OEPolymerType` namespace
      * :oe:func:`OEChem::OEPolymerTypeToString` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

..  _OEChem_OESubSearchStatusToName:

.. oe:function:: OESubSearchStatusToName

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OESubSearchStatusToName(const unsigned status)

   .. oe:language:: python

      .. oe:api:: python

         OESubSearchStatusToName(s: int) -> str

   Returns the string representation of the constants in the
   :oe:constns:`OEChem::OESubSearchStatus` namespace.

   .. seealso::

      * :oe:meth:`OEChem::OESubSearchDatabase::Search` method

   .. admonition:: Code Example

      * :ref:`section_example_oechem_searchfastss` example


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESubsetMol

.. |DST|    replace:: The destination subset molecule generated
                      from the source molecule.
                      The source molecule may be multi-conformer, in which case a
                      multi-conformational subset molecule is produced.

.. |SRC|    replace:: The source molecule.

.. |RGROUP| replace:: Flag that indicates whether "R groups" are to be added when covalent
                      bonds are broken by the selection.

.. |ADJUSTH| replace:: Flag that indicates whether the implicit hydrogen count is to be adjusted
                       when covalent bonds are broken by the selection in order to preserve
                       the original hybridization.

.. |MAP| replace::  A mapping between the atoms or / and bonds of the source  and destination
                    molecule can be obtained by passing in the ``atomMap`` and
                    ``bondMap`` arrays respectively.
                    These arrays should be large
                    enough to hold all the atoms / bonds for the source molecule, *i.e.*,
                    the size of :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx` and
                    :oe:meth:`OEChem::OEMolBase::GetMaxBondIdx`, respectively.
                    The atoms or bonds in the array are those from the destination molecule
                    placed at the source molecule's atom / bond index location in the array.

The following functions generate fully-functional molecule
from a subset of another molecule.
The following subset methods are available:

  * :ref:`Match-based selection <api_Match_based_SubSet>` methods

  * :ref:`Atom predicate-based selection <api_AtomPred_based_SubSet>` methods

  * :ref:`Atom and bond predicate-based selection <api_AtomBondPred_based_SubSet>` methods

  * :ref:`Atom and bond set-based selection <api_AtomBondSet_based_SubSet>` methods

.. oe:function:: OESubsetMol

   **Match-based selection**

   .. _api_Match_based_SubSet:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESubsetMol(OEMolBase& dst, const OEMatchBase* match,
                          bool adjustHCount = false, bool RGroup = false,
                          OEAtomBase** atomMap = 0, OEBondBase** bondMap = 0)
         bool OESubsetMol(OEMCMolBase& dst, const OEMCMolBase& src,
                          const OEMatchBase* match, bool adjustHCount = false,
                          bool RGroup = false, OEAtomBase** atomMap = 0,
                          OEBondBase** bondMap = 0)

   .. oe:language:: python

      .. oe:api:: python

         OESubsetMol(dst: OEMol, src: OEMol, match: OEMatchBase,
                     adjustHCount: bool = False, RGroup: bool = False,
                     atomMap: OEAtomBase = None, bondMap: OEBondBase = None) -> bool
         OESubsetMol(dst: Union[OEGraphMol,OEMol,OEQMol], match: OEMatchBase,
                     adjustHCount: bool = False, RGroup: bool = False,
                     atomMap: OEAtomBase = None, bondMap: OEBondBase = None) -> bool

   *dst*
     |DST|

   *src*
     |SRC|

   *match*
      The container that stores the selected atoms that will be in
      the generated subset molecule.
      By default, bonds between the selected atoms are carried along.
      If no source molecule is specified then the target molecule
      of the :oe:meth:`OEChem::OEMatchBase` defines the source
      molecule.

   *RGroup*
     |RGROUP|

   *adjustHCount*
     |ADJUSTH|

   *atomMap, bondMap*
      |MAP|

   **Atom predicate-based selection**

   .. _api_AtomPred_based_SubSet:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESubsetMol(OEMolBase& dst, const OEMolBase& src,
                          const OESystem::OEUnaryPredicate<OEAtomBase>& atomfcn,
                          bool adjustHCount = false, bool RGroup = false,
                          OEAtomBase** atomMap = 0, OEBondBase** bondMap = 0)
         bool OESubsetMol(OEMCMolBase& dst, const OEMCMolBase& src,
                          const OESystem::OEUnaryPredicate<OEAtomBase>& atomfcn,
                          bool adjustHCount = false, bool RGroup = false,
                          OEAtomBase** atomMap = 0, OEBondBase** bondMap = 0)
         bool OESubsetMol(OEQMolBase& dst, const OEQMolBase& src,
                          const OESystem::OEUnaryPredicate<OEAtomBase>& atomfcn,
                          bool adjustHCount = false, bool RGroup = false,
                          OEAtomBase** atomMap = 0, OEBondBase** bondMap = 0)

   .. oe:language:: python

      .. oe:api:: python

         OESubsetMol(dst: OEMol, src: OEMol, atomfcn: OEUnaryAtomPred,
                     adjustHCount: bool = False, RGroup: bool = False,
                     atomMap: OEAtomBase = None, bondMap: OEBondBase = None) -> bool
         OESubsetMol(dst: OEQMol, src: OEQMol, atomfcn: OEUnaryAtomPred,
                     adjustHCount: bool = False, RGroup: bool = False,
                     atomMap: OEAtomBase = None, bondMap: OEBondBase = None) -> bool
         OESubsetMol(dst: Union[OEGraphMol,OEMol,OEQMol],
                     src: Union[OEGraphMol,OEMol,OEQMol],
                     atomfcn: OEUnaryAtomPred, adjustHCount: bool = False,
                     RGroup: bool = False, atomMap: OEAtomBase = None,
                     bondMap: OEBondBase = None) -> bool

   *dst*
     |DST|

   *src*
     |SRC|

   *atomfcn*
      The atom predicate that defines the subset of atoms that are
      carried over to the destination molecule.
      By default, bonds between the selected atoms are carried along.

   *RGroup*
     |RGROUP|

   *adjustHCount*
     |ADJUSTH|

   *atomMap, bondMap*
      |MAP|

   **Atom and bond predicate-based selection**

   .. _api_AtomBondPred_based_SubSet:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESubsetMol(OEMolBase& dst, const OEMolBase& src,
                          const OESystem::OEUnaryPredicate<OEAtomBase>& atomfcn,
                          const OESystem::OEUnaryPredicate<OEBondBase>& bondfcn,
                          bool adjustHCount = false, bool RGroup = false,
                          OEAtomBase** atomMap = 0, OEBondBase** bondMap = 0)
         bool OESubsetMol(OEMCMolBase& dst, const OEMCMolBase& src,
                          const OESystem::OEUnaryPredicate<OEAtomBase>& atomfcn,
                          const OESystem::OEUnaryPredicate<OEBondBase>& bondfcn,
                          bool adjustHCount = false, bool RGroup = false,
                          OEAtomBase** atomMap = 0, OEBondBase** bondMap = 0)
         bool OESubsetMol(OEQMolBase& dst, const OEQMolBase& src,
                          const OESystem::OEUnaryPredicate<OEAtomBase>& atomfcn,
                          const OESystem::OEUnaryPredicate<OEBondBase>& bondfcn,
                          bool adjustHCount = false, bool RGroup = false,
                          OEAtomBase** atomMap = 0, OEBondBase** bondMap = 0)

   .. oe:language:: python

      .. oe:api:: python

         OESubsetMol(dst: OEMol, src: OEMol, atomfcn: OEUnaryAtomPred,
                     bondfcn: OEUnaryBondPred, adjustHCount: bool = False,
                     RGroup: bool = False, atomMap: OEAtomBase = None,
                     bondMap: OEBondBase = None) -> bool
         OESubsetMol(dst: OEQMol, src: OEQMol, atomfcn: OEUnaryAtomPred,
                     bondfcn: OEUnaryBondPred, adjustHCount: bool = False,
                     RGroup: bool = False, atomMap: OEAtomBase = None,
                     bondMap: OEBondBase = None) -> bool
         OESubsetMol(dst: Union[OEGraphMol,OEMol,OEQMol],
                     src: Union[OEGraphMol,OEMol,OEQMol],
                     atomfcn: OEUnaryAtomPred, bondfcn: OEUnaryBondPred,
                     adjustHCount: bool = False, RGroup: bool = False,
                     atomMap: OEAtomBase = None, bondMap: OEBondBase = None) -> bool

   *dst*
     |DST|

   *src*
     |SRC|

   *atomfcn*
      The atom predicate that defines the subset of atoms that are
      carried over to the destination molecule.

   *bondfcn*
      The atom predicate that defines the subset of bonds that are
      carried over to the destination molecule.

   *RGroup*
     |RGROUP|

   *adjustHCount*
     |ADJUSTH|

   *atomMap, bondMap*
      |MAP|

   **Atom and bond set-based selection**

   .. _api_AtomBondSet_based_SubSet:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESubsetMol(OEMolBase& dst, const OEAtomBondSet& abset,
                          bool adjustHCount = false, bool RGroup = false,
                          OEAtomBase** atomMap = 0, OEBondBase** bondMap = 0)
         bool OESubsetMol(OEMolBase& dst, const OEMolBase& src,
                          const OEAtomBondSet& abset,
                          bool adjustHCount = false, bool RGroup = false,
                          OEAtomBase** atomMap = 0, OEBondBase** bondMap = 0)
         bool OESubsetMol(OEMCMolBase& dst, const OEMCMolBase& src,
                          const OEAtomBondSet& abset,
                          bool adjustHCount = false, bool RGroup = false,
                          OEAtomBase** atomMap = 0, OEBondBase** bondMap = 0)
         bool OESubsetMol(OEQMolBase& dst, const OEQMolBase& src,
                          const OEAtomBondSet& abset,
                          bool adjustHCount = false, bool RGroup = false,
                          OEAtomBase** atomMap = 0, OEBondBase** bondMap = 0)

   .. oe:language:: python

      .. oe:api:: python

         OESubsetMol(dst: OEMol, src: OEMol, submol: OEAtomBondSet,
                     adjustHCount: bool = False, RGroup: bool = False,
                     atomMap: OEAtomBase = None, bondMap: OEBondBase = None) -> bool
         OESubsetMol(dst: OEQMol, src: OEQMol, submol: OEAtomBondSet,
                     adjustHCount: bool = False, RGroup: bool = False,
                     atomMap: OEAtomBase = None, bondMap: OEBondBase = None) -> bool
         OESubsetMol(dst: Union[OEGraphMol,OEMol,OEQMol],
                     submol: OEAtomBondSet, adjustHCount: bool = False,
                     RGroup: bool = False, atomMap: OEAtomBase = None,
                     bondMap: OEBondBase = None) -> bool
         OESubsetMol(dst: Union[OEGraphMol,OEMol,OEQMol],
                     src: Union[OEGraphMol,OEMol,OEQMol],
                     submol: OEAtomBondSet, adjustHCount: bool = False,
                     RGroup: bool = False, atomMap: OEAtomBase = None,
                     bondMap: OEBondBase = None) -> bool

   *dst*
     |DST|

   *src*
     |SRC|

   *abset*
      The container that stores the selected atoms and bonds that will be in
      the generated subset molecule.
      If no source molecule is specified then :oe:meth:`OEChem::OEAtomBondSet`
      defines the source molecule.

   *RGroup*
     |RGROUP|

   *adjustHCount*
     |ADJUSTH|

   *atomMap, bondMap*
      |MAP|

   .. seealso::

      .. oe:language:: c++

         * :ref:`section_atombondindices_paralleldatastructures` section
         * :ref:`section_predicates_partitioning` section
         * Example program :ref:`parts2mols.cpp<section_example_oechem_parts2mols>`
         * Example program :ref:`extractscaffold.cpp<section_example_oechem_extractscaffold>`

      .. oe:language:: python

         * :ref:`section_atombondindices_paralleldatastructures` section
         * :ref:`section_predicates_partitioning` section
         * Example program :ref:`parts2mols.py<section_example_oechem_parts2mols>`
         * Example program :ref:`extractscaffold.py<section_example_oechem_extractscaffold>`

      .. oe:language:: java

         * :ref:`section_atombondindices_paralleldatastructures` section
         * :ref:`section_predicates_partitioning` section
         * Example program :ref:`Parts2Mols.java<section_example_oechem_parts2mols>`
         * Example program :ref:`ExtractScaffold.java<section_example_oechem_extractscaffold>`

      .. oe:language:: csharp

         * :ref:`section_atombondindices_paralleldatastructures` section
         * :ref:`section_predicates_partitioning` section
         * Example program :ref:`Parts2Mols.cs<section_example_oechem_parts2mols>`
         * Example program :ref:`ExtractScaffold.cs<section_example_oechem_extractscaffold>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESuppressHydrogens

.. oe:function:: OESuppressHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESuppressHydrogens(OEMolBase& mol, bool retainPolar = false,
                                  bool retainStereo = false,
                                  bool retainIsotope = true)
         bool OESuppressHydrogens(OEAtomBase* atom, bool retainPolar = false,
                                  bool retainStereo = false,
                                  bool retainIsotope = true)

   .. oe:language:: python

      .. oe:api:: python

         OESuppressHydrogens(mol: Union[OEGraphMol,OEMol,OEQMol],
                             retainPolar: bool = False,
                             retainStereo: bool = False,
                             retainIsotope: bool = True) -> bool
         OESuppressHydrogens(atm: OEAtomBase, retainPolar: bool = False,
                             retainStereo: bool = False,
                             retainIsotope: bool = True) -> bool

   Transforms the explicit hydrogens in a molecule into implicit
   hydrogens on their parent heavy atom.  The overloaded function provides
   the same capability at a specific heavy atom.

   Any explicit hydrogen atoms,
   those with atomic number :oe:const:`OEChem::OEElemNo::H`, are deleted
   and any information associated with them, coordinates, isotopes,
   generic data etc... are lost.  In their place, the implicit hydrogen
   count field of the heavy atom to which they are bonded is
   appropriately incremented.

   retainPolar
     If ``true``, then hydrogens on polar atoms,
     *i.e.* those for which :oe:meth:`OEChem::OEAtomBase::IsPolarHydrogen`
     returns ``true``, are left unaffected.

   retainStereo
     If ``true``, then hydrogens required to specify stereo centers, *i.e.* those
     for which :oe:func:`OEChem::OEHasStereoHydrogens` return ``true``, are left
     unaffected.

   retainIsotope
     If ``true``, then specified isotopes of hydrogen (including deuterium
     ``[2H]``, tritium ``[3H]`` and protium ``[1H]``) will be treated
     as heavy atoms and retained.

   The functions return the value ``true`` if any hydrogens were deleted,
   and return ``false`` if the molecule was left unchanged.

   .. seealso::

      * :oe:func:`OEChem::OEAddExplicitHydrogens` function
      * :ref:`section_example_oechem_cliquealign` **OEChem TK** example program



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OESweepMDLStereoGroups

.. oe:function:: OESweepMDLStereoGroups

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESweepMDLStereoGroups(OEMolBase& mol,
                                     bool clearmdlstereomarks = true)

   .. oe:language:: python

      .. oe:api:: python

         OESweepMDLStereoGroups(mol: Union[OEGraphMol,OEMol,OEQMol],
                                clearstereomarks: bool = True) -> bool

   Removes all atoms that lack atom stereo parity information from enhanced stereogroups.
   If the resulting stereogroup basis is empty, the group itself is also deleted.
   The ``clearmdlstereomarks`` argument controls whether stereomarks to the
   identified nonstereo atom(s) should also be removed.  Stereomarks to atoms that are
   not a member of any enhanced stereogroup are unaffected.

   A return status of ``true`` indicates that the provided molecule has been altered.

   .. seealso::

      * :oe:cls:`OEIsMDLStereoGroup<OEChem::OEIsMDLStereoGroup>`
      * :oe:meth:`GetGroups<OEChem::OEMolBase::GetGroups>`
      * :oe:constns:`OEChem::OEBondStereo`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESweepRotorCompressHydrogens

.. oe:function:: OESweepRotorCompressHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESweepRotorCompressHydrogens(OEMCMolBase& mol,
                                            bool retainPolar = false,
                                            bool retainStereo = false,
                                            bool retainIsotope = true)

   .. oe:language:: python

      .. oe:api:: python

         OESweepRotorCompressHydrogens(mol: OEMol, retainPolar: bool = False,
                                       retainStereo: bool = False,
                                       retainIsotope: bool = True) -> bool

   Suppress hydrogens from a rotor-offset-compressed
   :ref:`OEMCMolBase <OEChem_OEMCMolBase>` in a way that does not corrupt the
   rotor compression data tables. Removing explicit hydrogens can have
   a dramatic improvement on the storage requirements of a molecule as
   hydrogen coordinates do not need to be stored anymore.

   The ``retainPolar``, ``retainStereo``, ``retainIsotope`` arguments
   are identical to the arguments passed to the
   :oe:func:`OEChem::OESuppressHydrogens` function and are forwarded
   to that function.

   Return ``false`` if an error like the following is detected: the
   molecule contains deleted atoms; or the rotor compression data is
   corrupted in some way. Return ``true`` if sweeping was successful
   and :oe:meth:`OEChem::OEMolBase::Sweep` was called on the
   molecule. Also return ``true`` if there were no hydrogens to sweep
   away at all and nothing was done.

   .. warning::

      The returned boolean value has a different meaning than
      :oe:func:`OEChem::OESuppressHydrogens` boolean return
      value. :oe:func:`OEChem::OESuppressHydrogens` will return
      ``false`` whenever a molecule does not contain hydrogens.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESweepStyles

.. oe:function:: OESweepStyles

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESweepStyles(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OESweepStyles(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Utilized when merging two :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` to make sure 
   the styles are appropriatly set to the atoms and the molecule. 

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OESymmetryNumber

.. oe:function:: OESymmetryNumber

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OESymmetryNumber(const OEMolBase& mol, bool useH = true,
                                   double threshold = 0.05)
         bool OESymmetryNumber(const OEMCMolBase& mol, unsigned* symCtArray,
                               bool useH = true, double threshold = 0.05)

   .. oe:language:: python

      .. oe:api:: python

         OESymmetryNumber(mol: Union[OEGraphMol,OEMol,OEQMol],
                          useH: bool = True, threshold: float = 0.05) -> int
         OESymmetryNumber(mol: OEMol, symCtArray: int, useH: bool = True,
                          threshold: float = 0.05) -> bool

   Calculates the symmetry number of the molecule.
   For the overload with :ref:`OEMolBase <OEChem_OEMolBase>` as input molecule,
   the symmetry number is the return value.  For the 
   :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` overload, the symmetry 
   numbers are returned in the `symCtdArray` array.  The `symCtArray` passed to this
   function should be of length ``fit.GetMaxConfIdx()``.  The `useH`
   flag indicates whether symmetry calculation should use the hydrogen atoms
   of the molecule or ignore them.  Root mean squared deviation between 
   conformations are performed internally and accepted as identical based on the
   specified `threshold`. For the :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` 
   overload the return value is ``True`` if calculation completes successfully,
   and ``False`` otherwise.

   *mol*
      The molecule to calculate symmetry number.

   *useH*
      Flag indicating if hydrogen atoms should be considered explicitly.

   *threshold*
      Threshold for root mean squared deviation (RMSD) comparison.

   *symCtArray*
      Array containing calculated symmetry numbers in a multi-conformer input molecule.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETerminalOCount

.. oe:function:: OETerminalOCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OETerminalOCount(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OETerminalOCount(atm: OEAtomBase) -> int



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETerminalSCount

.. oe:function:: OETerminalSCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OETerminalSCount(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OETerminalSCount(atm: OEAtomBase) -> int



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETheFunctionFormerlyKnownAsStripSalts

.. oe:function:: OETheFunctionFormerlyKnownAsStripSalts

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OETheFunctionFormerlyKnownAsStripSalts(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OETheFunctionFormerlyKnownAsStripSalts(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Deletes all atoms that are not part of the largest connected component
   of a molecule.  If two or more components of a molecule are the size
   of the largest component, this function keeps the first one
   encountered.

.. note::

   The :oe:func:`OEChem::OETheFunctionFormerlyKnownAsStripSalts` function is
   identical to :oe:func:`OEChem::OEDeleteEverythingExceptTheFirstLargestComponent`.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`stripsalts.cpp<section_example_oechem_stripsalts>`

  .. oe:language:: python

      * Example program :ref:`stripsalts.py<section_example_oechem_stripsalts>`

  .. oe:language:: java

      * Example program :ref:`StripSalts.java<section_example_oechem_stripsalts>`

  .. oe:language:: csharp

      * Example program :ref:`StripSalts.cs<section_example_oechem_stripsalts>`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETranslate

.. oe:function:: OETranslate

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OETranslate(OEMolBase& mol, const float* v)
         void OETranslate(OEMolBase& mol, const double* v)
         void OETranslate(OEConfBase& conf, const float* v)
         void OETranslate(OEConfBase& conf, const double* v)
         void OETranslate(OEMCMolBase& mcmol, const float* v)
         void OETranslate(OEMCMolBase& mcmol, const double* v)

   .. oe:language:: python

      .. oe:api:: python

         OETranslate(mol: Union[OEGraphMol,OEQMol], v: OEFloatArray) -> None
         OETranslate(mol: Union[OEGraphMol,OEQMol], v: OEDoubleArray) -> None
         OETranslate(conf: OEConfBase, v: OEFloatArray) -> None
         OETranslate(conf: OEConfBase, v: OEDoubleArray) -> None
         OETranslate(mcmol: OEMol, v: OEFloatArray) -> None
         OETranslate(mcmol: OEMol, v: OEDoubleArray) -> None

   Translates the molecule by the vector passed as the argument 'v'.  The
   vector 'v' must be of size three and contain the Cartesian
   translation vectors.  The overloads for :ref:`OEConfBase <OEChem_OEConfBase>`
   and :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` are for efficiency.

   *mol*
      The molecule to translate.

   *conf*
      The conformer to translate.

   *mcmol*
      The multi-conformer molecule to translate.

   *v*
      The translation vector.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`mcs3dalign.cpp<section_example_oechem_mcs3dalign>`

  .. oe:language:: python

      * Example program :ref:`mcs3dalign.py<section_example_oechem_mcs3dalign>`

  .. oe:language:: java

      * Example program :ref:`MCS3DAlign.java<section_example_oechem_mcs3dalign>`

  .. oe:language:: csharp

      * Example program :ref:`MCS3DAlign.cs<section_example_oechem_mcs3dalign>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETrimConformers

.. oe:function:: OETrimConformers

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OETrimConformers(OEChem::OEMCMolBase& mol, unsigned int N)

   .. oe:language:: python

      .. oe:api:: python

         OETrimConformers(mol: OEMol, N: int) -> bool

   Deletes conformers of *mol*, starting with those with the 
   highest conformer index, such *mol* has *N* conformers
   remaining.  

   If *mol* has less than *N* conformers, or *N* is passed 0 then
   this function is a no-op.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETripleBondCount

.. oe:function:: OETripleBondCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OETripleBondCount(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OETripleBondCount(atm: OEAtomBase) -> int

   Returns the number of triple bonds connected to an atom.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETriposAtomNames

.. oe:function:: OETriposAtomNames

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OETriposAtomNames(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OETriposAtomNames(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Sets the atom name property of each atom, using the
   :oe:meth:`OEChem::OEAtomBase::SetName` method, to follow the convention
   typically followed in Sybyl .mol2 files.  Each atom is named by its
   atomic symbol (or ``Du`` for element zero) followed by a sequential
   index per atomic number.  For example, the first carbon in the
   molecule is named ``C1``, the second is named ``C2``, and so on.  Similarly,
   the first oxygen is named ``O1`` and so on.  The 'atom name' property may be
   retrieved using the :oe:meth:`OEChem::OEAtomBase::GetName` method.

   The ordering of atoms is taken from the iterator returned by the
   :oe:meth:`OEChem::OEMolBase::GetAtoms` method (and may therefore be
   changed by using :oe:meth:`OEChem::OEMolBase::OrderAtoms`) and is
   unchanged by this function.

   .. seealso::

      .. oe:language:: c++

         * Example program :ref:`printatomnames.cpp<section_example_oechem_printatomnames>`

      .. oe:language:: python

         * Example program :ref:`printatomnames.py<section_example_oechem_printatomnames>`

      .. oe:language:: java

         * Example program :ref:`PrintAtomNames.java<section_example_oechem_printatomnames>`

      .. oe:language:: csharp

         * Example program :ref:`PrintAtomNames.cs<section_example_oechem_printatomnames>`

      * :oe:func:`OEChem::OETriposAtomTypes`
      * :oe:func:`OEChem::OETriposAtomTypeNames`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETriposAtomType

.. oe:function:: OETriposAtomType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OETriposAtomType(const OEAtomBase* atm)

   .. oe:language:: python

      .. oe:api:: python

         OETriposAtomType(atm: OEAtomBase) -> int

   This function determines the Tripos Sybyl atom type for the given
   atom.  The result is an unsigned integer index taken from the
   :oe:constns:`OEChem::OETriposType` namespace.  The index zero
   corresponds to :oe:const:`OEChem::OETriposType::Du`, *i.e.* a dummy or
   unrecognized atom.  The atom, including any previously assigned
   integer atom type, is not modified by this function.

   This function prefers that aromaticity has previously been assigned
   using the Tripos model of aromaticity, see the :oe:func:`OEChem::OEAssignAromaticFlags`
   function.  However, reasonable atom types are returned when using
   other models of aromaticity.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETriposAtomTypeNames

.. oe:function:: OETriposAtomTypeNames

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OETriposAtomTypeNames(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OETriposAtomTypeNames(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Sets the string atom type property of every atom in a molecule to its
   Tripos Sybyl atom type.  The symbolic atom type of each atom is determined by
   :oe:func:`OEChem::OETriposAtomType` and then is converted from integer
   index to type name using :oe:func:`OEChem::OETriposTypeName`.  The
   string 'atom type property' is set using the :oe:meth:`OEChem::OEAtomBase::SetType`
   method. The 'atom type name' property may be retrieved using the
   :oe:meth:`OEChem::OEAtomBase::GetType` method. This function returns ``false`` if any
   atom was assigned with ``"Du"``, and returns ``true`` otherwise.

   This function prefers that aromaticity has previously been assigned
   using the Tripos model of aromaticity, see the
   :oe:func:`OEChem::OEAssignAromaticFlags` function.  However, reasonable
   atom types are returned when using other models of aromaticity.

   .. seealso::

      * :oe:func:`OEChem::OETriposAtomTypes`
      * :oe:func:`OEChem::OETriposTypeNames`
      * :oe:func:`OEChem::OETriposAtomNames`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETriposAtomTypes

.. oe:function:: OETriposAtomTypes

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OETriposAtomTypes(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OETriposAtomTypes(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   This function sets the integer atom type property of every atom in a
   molecule to its Tripos Sybyl atom type.  The integer atom types are
   taken from the :oe:constns:`OEChem::OETriposType` namespace, as
   determined by the :oe:func:`OEChem::OETriposAtomType` function, and
   each atom is assigned a value using the
   :oe:meth:`OEChem::OEAtomBase::SetIntType` method.  The
   :oe:func:`OEChem::OETriposAtomTypes` function returns ``false`` if any atom
   was assigned :oe:const:`OEChem::OETriposType::Du`, and returns the
   value ``true`` otherwise.

   This function prefers that aromaticity has previously been assigned
   using the Tripos model of aromaticity, see the
   :oe:func:`OEChem::OEAssignAromaticFlags` function.  However, reasonable
   atom types are returned when using other models of aromaticity.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETriposBondTypeNames

.. oe:function:: OETriposBondTypeNames

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OETriposBondTypeNames(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OETriposBondTypeNames(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Sets the string bond type property of every bond in a molecule to its
   Tripos Sybyl bond type.  Single, double and triple bonds are assigned
   the types ``1``, ``2`` and ``3`` respectively with the exception of
   aromatic and amide bonds with are assigned the values ``ar`` and
   ``am`` respectively.

   This function prefers that aromaticity has previously been assigned
   using the Tripos model of aromaticity, see the
   :oe:func:`OEChem::OEAssignAromaticFlags` function.  However, reasonable
   atom types are returned when using other models of aromaticity.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETriposOrderAtoms

.. oe:function:: OETriposOrderAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OETriposOrderAtoms(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OETriposOrderAtoms(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETriposResonantTypeNames

.. oe:function:: OETriposResonantTypeNames

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OETriposResonantTypeNames(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OETriposResonantTypeNames(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETriposTypeElement

.. oe:function:: OETriposTypeElement

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OETriposTypeElement(unsigned int type)

   .. oe:language:: python

      .. oe:api:: python

         OETriposTypeElement(type: int) -> int

   Returns the atomic number/element represented by the given Tripos atom
   type index, as encoded by the :oe:constns:`OEChem::OETriposType`
   namespace.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETriposTypeIndex

.. oe:function:: OETriposTypeIndex

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OETriposTypeIndex(const char* name)

   .. oe:language:: python

      .. oe:api:: python

         OETriposTypeIndex(name: str) -> int

   Returns the integer atom type, as encoded by the
   :oe:constns:`OEChem::OETriposType` namespace, that corresponds to the
   given Tripos Sybyl atom type string.  For example,
   :oe:func:`OEChem::OETriposTypeIndex` returns the integer value
   :oe:const:`OEChem::OETriposType::Npl3` for ``"N.pl3"``.

   This function is the inverse of :oe:func:`OEChem::OETriposTypeName`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETriposTypeName

.. oe:function:: OETriposTypeName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OETriposTypeName(unsigned int type)

   .. oe:language:: python

      .. oe:api:: python

         OETriposTypeName(type: int) -> str

   Returns the symbolic atom type name that corresponds to
   the given Tripos Sybyl atom type index, as encoded by the
   :oe:constns:`OEChem::OETriposType` namespace.  For example,
   :oe:func:`OEChem::OETriposTypeName` returns the value ``"N.pl3"`` for
   :oe:const:`OEChem::OETriposType::Npl3`.

   This function is the inverse of :oe:func:`OEChem::OETriposTypeIndex`.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OETriposTypeNames

.. oe:function:: OETriposTypeNames

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OETriposTypeNames(OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OETriposTypeNames(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Loops through the atoms of the molecule, setting the string atom type
   property of each atom, to atom type name of the Tripos Sybyl atom type
   encoded in the atoms integer atom type property.  This is
   approximately equivalent to the following operation:

   .. code-block:: c++

      atm->SetType(OETriposTypeName(atm->GetIntType()))

   The 'atom type name' property may be retrieved using the
   :oe:meth:`OEChem::OEAtomBase::GetType` method. If both the string and
   integer atom types are required, it is faster to call
   :oe:func:`OEChem::OETriposAtomTypes` and then
   :oe:func:`OEChem::OETriposTypeNames` (which reuses the results of the
   first call) than it is to call :oe:func:`OEChem::OETriposAtomTypes` and
   :oe:func:`OEChem::OETriposAtomTypeNames`.

   .. seealso::

      * :oe:func:`OEChem::OETriposAtomNames`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEUncolorMol

.. oe:function:: OEUncolorMol

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEUncolorMol(OEChem::OEMolBase& uncoloredcmol,
                           const OEChem::OEMolBase& inputmol,
                           unsigned uncolortype = OEUncolorStrategy::Default)
         bool OEUncolorMol(OEChem::OEMCMolBase& uncoloredcmol,
                           const OEChem::OEMCMolBase& inputmol,
                           unsigned uncolortype = OEUncolorStrategy::Default)
         bool OEUncolorMol(OEChem::OEMolBase& moltouncolor,
                           unsigned uncolortype = OEUncolorStrategy::Default)
         bool OEUncolorMol(OEChem::OEMCMolBase& moltouncolor,
                           unsigned uncolortype = OEUncolorStrategy::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEUncolorMol(uncoloredcmol: Union[OEGraphMol,OEMol,OEQMol],
                      mol: Union[OEGraphMol,OEMol,OEQMol], uncolortype: int) -> bool
         OEUncolorMol(uncoloredcmol: OEMol, mol: OEMol, uncolortype: int) -> bool
         OEUncolorMol(moltouncolor: Union[OEGraphMol,OEQMol], uncolortype: int) -> bool
         OEUncolorMol(moltouncolor: OEMol, uncolortype: int) -> bool

   The :oe:func:`OEChem::OEUncolorMol` function will remove chemical
   features from the output structure according to the
   :oe:constns:`OEChem::OEUncolorStrategy`.  The default strategy
   is :oe:const:`OEChem::OEUncolorStrategy::RemoveDimension` and
   :oe:const:`OEChem::OEUncolorStrategy::BemisMurcko`.

   For the function overloads that operate directly on the input molecule, the function returns ``true`` if
   uncoloring modifications were applied to the structure and ``false`` otherwise.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEUpdateMMCIFData

.. oe:function:: OEUpdateMMCIFData

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEUpdateMMCIFData(OEMolBase& mol, const OECIFOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEUpdateMMCIFData(mol: Union[OEGraphMol,OEMol,OEQMol],
                           opts: OECIFOptions) -> bool

   Updates MMCIF header metadata based on the structural data of the input molecule.
   If metadata already exists, it is replaced with the updated header.

   .. seealso::

      * :oe:func:`OEChem::OEAddMMCIFData` function to add MMCIF data
      * :oe:func:`OEChem::OESetMMCIFData` function to set MMCIF data
      * :ref:`section_moldata_MMCIF` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OERMSD, OEWeightedRMSD

.. oe:function:: OEWeightedRMSD

   **Array-Based OEWeightedRMSD**

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEWeightedRMSD(const float* refcrds, const float* fitcrds,
                               const float* weightArray, unsigned int size,
                               bool overlay = false, double* rot = 0,
                               double* trans = 0)
         double OEWeightedRMSD(const double* refcrds, const double* fitcrds,
                               const double* weightArray, unsigned int size,
                               bool overlay = false, double* rot = 0,
                               double* trans = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEWeightedRMSD(refcrds: OEFloatArray, fitcrds: OEFloatArray,
                        weight: OEFloatArray, size: int, overlay: bool = False,
                        rot: OEDoubleArray = None, trans: OEDoubleArray = None) -> float
         OEWeightedRMSD(refcrds: OEDoubleArray, fitcrds: OEDoubleArray,
                        weight: OEDoubleArray, size: int,
                        overlay: bool = False, rot: OEDoubleArray = None,
                        trans: OEDoubleArray = None) -> float

   Returns the weighted root mean squared deviation between two sets of
   Cartesian coordinates.

   *weightArray*
       The array should be of length `size` and should contain the relative
       weight of each coordinate.  The resulting RMSD is only affected by
       the relative weighting, so if all the weights are 1.0 or if all the
       weights are 2.0, the result will be the same.

   .. note::

      This function only differs from the function :oe:func:`OEChem::OERMSD`
      by the additional parameter 'weightArray'. For details of the
      other parameters see :oe:func:`OEChem::OERMSD` function.

   **Full Molecule-Based OEWeightedRMSD**

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEWeightedRMSD(const OEMolBase& ref, const OEMolBase& fit,
                               const double* weightArray,
                               bool automorph = true, bool heavyOnly = true,
                               bool overlay = false, double* rot = 0,
                               double* trans = 0)
         bool OEWeightedRMSD(const OEMolBase& ref, const OEMCMolBase& fit,
                             const double* weightArray, double* rmsdArray,
                             bool automorph = true, bool heavyOnly = true,
                             bool overlay = false, double* rot = 0,
                             double* trans = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEWeightedRMSD(ref: Union[OEGraphMol,OEMol,OEQMol], fit: OEMol,
                        weight: OEDoubleArray, rmsdArray: OEDoubleArray,
                        automorph: bool = True, heavyOnly: bool = True,
                        overlay: bool = False, rot: OEDoubleArray = None,
                        trans: OEDoubleArray = None) -> bool
         OEWeightedRMSD(ref: Union[OEGraphMol,OEMol,OEQMol],
                        fit: Union[OEGraphMol,OEMol,OEQMol],
                        weight: OEDoubleArray, automorph: bool = True,
                        heavyOnly: bool = True, overlay: bool = False,
                        rot: OEDoubleArray = None, trans: OEDoubleArray = None) -> float

   Calculates the weighted root mean squared deviation between two molecules.

   *weightArray*
       This array should be of length `fit.GetMaxAtomIdx()` and should contain
       the relative weight of each coordinate.  The resulting RMSD is only
       affected by the relative weighting, so if all the weights are 1.0 or
       if all the weights are 2.0, the result will be the same.

   .. note::

      This function only differs from the function :oe:func:`OEChem::OERMSD`
      by the additional parameter 'weightArray'. For details of the other
      parameters see :oe:func:`OEChem::OERMSD` function.

   **Partial Molecule-Based OEWeightedRMSD**

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEWeightedRMSD(const OEMolBase& ref, const OEMolBase& fit,
                               const double* weightArray,
                               const OEMatchBase& match, bool overlay = false,
                               double* rot = 0, double* trans = 0)
         bool OEWeightedRMSD(const OEMolBase& ref, const OEMCMolBase& fit,
                             const double* weightArray, double* rmsdArray,
                             const OEMatchBase& match, bool overlay = false,
                             double* rot = 0, double* trans = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEWeightedRMSD(ref: Union[OEGraphMol,OEMol,OEQMol], fit: OEMol,
                        weight: OEDoubleArray, rmsdArray: OEDoubleArray,
                        match: OEMatchBase, overlay: bool = False,
                        rot: OEDoubleArray = None, trans: OEDoubleArray = None) -> bool
         OEWeightedRMSD(ref: Union[OEGraphMol,OEMol,OEQMol],
                        fit: Union[OEGraphMol,OEMol,OEQMol],
                        weight: OEDoubleArray, match: OEMatchBase,
                        overlay: bool = False, rot: OEDoubleArray = None,
                        trans: OEDoubleArray = None) -> float
         OEWeightedRMSD(ref: Union[OEGraphMol,OEMol,OEQMol],
                        fit: Union[OEGraphMol,OEQMol], weight: OEDoubleArray,
                        rmsdArray: OEDoubleArray, match: OEMatchBase,
                        overlay: bool = False, rot: OEDoubleArray = None,
                        trans: OEDoubleArray = None) -> bool

   These functions are quite similar to the previous three.  However,
   rather than considering automorphisms and heavy atoms, these
   functions allow a user to explicitly specify which substructure
   of the two molecules should be used to determine the RMSD.
   The match can be generated by hand, or with any of **OEChem TK**'s matching
   algorithms such as :ref:`OESubSearch <OEChem_OESubSearch>` or
   :ref:`OEMCSSearch <OEChem_OEMCSSearch>`.

   *weightArray*
       This array should be of length `fit.GetMaxAtomIdx()` and should
       contain the relative weight of each coordinate.  The resulting
       RMSD is only affected by the relative weighting, so if all the
       weights are 1.0 or if all the weights are 2.0, the result will
       be the same. The 'match' parameter takes precedence over the
       weights, so only weights that are part of the match will be
       relevant to the calculation.

   .. note::

      This function only differs from the function :oe:func:`OEChem::OERMSD`
      by the additional parameter 'weightArray'. For details of the other
      parameters see :oe:func:`OEChem::OERMSD` function.

   .. seealso::

      * :oe:func:`OEChem::OERMSD` function
      * :ref:`OEConfRMSD <OEChem_OEConfRMSD>` class
      * :ref:`section_patternmatch_sss` section
      * :ref:`section_patternmatch_mcss` section


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWrite2DRingDictionary

.. oe:function:: OEWrite2DRingDictionary

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWrite2DRingDictionary(oemolostream& oms,
                                      const OE2DRingDictionary& ringdict)
         bool OEWrite2DRingDictionary(OEPlatform::oeostream& os,
                                      const OE2DRingDictionary& ringdict)
         bool OEWrite2DRingDictionary(const std::string& filename,
                                      const OE2DRingDictionary& ringdict)

   .. oe:language:: python

      .. oe:api:: python

         OEWrite2DRingDictionary(oms: oemolostream, rtd: OE2DRingDictionary) -> bool
         OEWrite2DRingDictionary(os: oeostream, rtd: OE2DRingDictionary) -> bool
         OEWrite2DRingDictionary(filename: str, rtd: OE2DRingDictionary) -> bool

   Writes a ring template dictionary binary file.

   .. seealso::

      * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
      * :ref:`chapter_2D_coordinates` chapter


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWriteCDXFile

.. oe:function:: OEWriteCDXFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteCDXFile(oemolostream& ofs, OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteCDXFile(ofs: oemolostream, mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Writes the given molecule to the output molstream in ChemDraw CDX file
   format.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWriteCIFFile

..  _OEChem_OEWriteCIFFile:

.. oe:function:: OEWriteCIFFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEWriteCIFFile(oemolostream& ofs, OEMolBase& mol,
                             const unsigned int flavor)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteCIFFile(ofs: oemolostream, mol: Union[OEGraphMol,OEMol,OEQMol],
                        flavor: int) -> None

   Writes the molecule as an CIF or mmCIF-file format file to the output
   stream 'ofs', depending on the content of the molecule. If :ref:`OEResidue <OEChem_OEResidue>`
   information is available on any atom in the molecule, it will be written by the mmCIF writer.
   The mmCIF writer will, additionally, switch between two modes, the mmCIF format for
   macromolecules or the Chemical Component Dictionary format. The Chemical Components Dictionary format
   is used when the molecule being written has only a single residue in it.
   A limited number of different CIF and mmCIF format variants are supported
   by the use of 'flavor' parameter from the
   :oe:constns:`OEChem::OEOFlavor::CIF` or :oe:constns:`OEChem::OEOFlavor::MMCIF` namespace.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWriteCSVFile

.. oe:function:: OEWriteCSVFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEWriteCSVFile(oemolostream& ofs, OEMolBase& mol,
                             unsigned int flavor = OEOFlavor::CSV::DEFAULT)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteCSVFile(ofs: oemolostream, mol: Union[OEGraphMol,OEMol,OEQMol],
                        flavor: int) -> None

   Write the molecule ``mol`` to the stream ``ofs`` in the
   :oe:const:`OEChem::OEFormat::CSV` format as described in the
   :ref:`section_moltaggeddata_CSV` section.

   .. seealso::

      :oe:constns:`OEChem::OEOFlavor::CSV`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWriteCSVHeader

.. oe:function:: OEWriteCSVHeader

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEWriteCSVHeader(oemolostream& ifs, const OECSVHeader& header,
                               unsigned int flavor = OEOFlavor::CSV::DEFAULT)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteCSVHeader(ifs: oemolostream, header: OECSVHeader, flavor: int) -> None

   Write out the column names specified by the
   :ref:`OECSVHeader <OEChem_OECSVHeader>` object into the stream passed as the
   ``ifs`` argument. Nothing will be written if
   :oe:const:`OEChem::OEOFlavor::CSV::Header` is not set.

   .. seealso::

      :ref:`section_moltaggeddata_CSV`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWriteConstMolecule

.. oe:function:: OEWriteConstMolecule

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEWriteConstMolecule(oemolostream& ofs, const OEGraphMol& mol)
         unsigned OEWriteConstMolecule(oemolostream& ofs, const OEMol& mol)
         unsigned OEWriteConstMolecule(oemolostream& ofs, const OEQMol& mol)
         unsigned OEWriteConstMolecule(oemolostream& ofs, const OEMolBase& mol)
         unsigned OEWriteConstMolecule(oemolostream& ofs, const OEMCMolBase& mol
         unsigned OEWriteConstMolecule(oemolostream& ofs, const OEQMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteConstMolecule(ofs: oemolostream, mol: OEGraphMol) -> int
         OEWriteConstMolecule(ofs: oemolostream, mol: OEMol) -> int
         OEWriteConstMolecule(ofs: oemolostream, mol: OEQMol) -> int

   These functions provide high-level file format writers for multiple file
   formats.  These functions are built on top of **OEChem TK**'s low-level file
   format writers.  If needed, these functions will make a copy of the
   molecule in order to automatically invoke the appropriate perception
   routines (aromaticity, atom typing, chirality perception, residue
   perception, etc...) as required by the selected file format.
   This greatly simplifies the task of writing molecules to a stream,
   but may provide less control than calling the lower-level functions
   directly.

   Since these functions may make a copy of the molecule they'll generally
   be slower than the analogous :oe:func:`OEChem::OEWriteMolecule` functions,
   which modify the molecule directly.

   All of the overloads of :oe:func:`OEChem::OEWriteConstMolecule` functions
   return an error code from the :oe:constns:`OEChem::OEWriteMolReturnCode`
   namespace.
   A return code of ``0`` or :oe:const:`OEChem::OEWriteMolReturnCode::Success`
   indicates the write had no problems.

   ofs
     The output stream into which the molecule will be written.

     The file format controlled by the format field of the
     :ref:`oemolostream <OEChem_oemolostream>` which may be set and retrieved using
     the methods :oe:meth:`OEChem::oemolstreambase::SetFormat`, and
     :oe:meth:`OEChem::oemolstreambase::GetFormat` respectively.

     Additionally, the :oe:func:`OEChem::OEWriteConstMolecule` functions provide
     some level of control over the processing applied to a molecule prior
     to writing using **OEChem TK**'s file format flavor mechanism.
     Each output molecule stream maintains an independent 'flavor' value for
     each output file format that can be specified by
     :oe:meth:`OEChem::oemolstreambase::SetFlavor`.
     These 'flavors' are unsigned integer values that are the combination
     of bit patterns specified by the :oe:constns:`OEChem::OEOFlavor` namespace.
     The interpretation of each bit in a flavor depends upon the output file
     format to which it refers, and enables or disables processing
     associated with writing that output file format.

   mol
     The molecule that is written into the stream.

.. seealso::

   * :oe:constns:`OEChem::OEWriteMolReturnCode` namespace
   * :ref:`the OEFormat namespace <OEChem_OEFormat>`
   * :oe:constns:`OEChem::OEOFlavor` namespace
   * :oe:func:`OEChem::OEWriteMolecule` function

   .. oe:language:: c++

      * Example program :ref:`cliquealign.cpp<section_example_oechem_cliquealign>`

   .. oe:language:: python

      * Example program :ref:`cliquealign.py<section_example_oechem_cliquealign>`

   .. oe:language:: java

      * Example program :ref:`CliqueAlign.java<section_example_oechem_cliquealign>`

   .. oe:language:: csharp

      * Example program :ref:`CliqueAlign.cs<section_example_oechem_cliquealign>`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWriteFASTAFile

.. oe:function:: OEWriteFASTAFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEWriteFASTAFile(oemolostream& ofs, OEMolBase& mol,
                               const char* ident)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteFASTAFile(ofs: oemolostream,
                          mol: Union[OEGraphMol,OEMol,OEQMol], ident: str) -> None

   Writes the molecule as a FASTA format protein sequence to the output
   stream 'ofs'.  The 'ident' parameter is used to specify the sequence
   identifier to be written before the molecule's title on for each amino
   acid sequence.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWriteMDLFile

.. oe:function:: OEWriteMDLFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEWriteMDLFile(oemolostream& ofs, OEMolBase& mol,
                             unsigned int flavor = OEOFlavor::MDL::DEFAULT)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteMDLFile(ofs: oemolostream, mol: Union[OEGraphMol,OEMol,OEQMol],
                        flavor: int) -> None

   Writes the molecule as a MDL mol format file to the output stream
   'ofs'.  A number of different MDL format variants are
   supported by the use of the 'flavor' parameter from the
   :oe:constns:`OEChem::OEOFlavor::MDL` namespace.

   By default, only molecules with more than 999 atoms or enhanced
   stereo groups will be written in V3000 format. The
   :oe:const:`OEChem::OEOFlavor::MDL::MV30` flavor can be used to force
   all molecules to be written in the V3000 format.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWriteMOPACInputFile

.. oe:function:: OEWriteMOPACInputFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEWriteMOPACInputFile(oemolostream& ofs, OEMolBase& mol,
                                    unsigned int flavor = OEOFlavor::MOPAC::DEFAULT)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteMOPACInputFile(ofs: oemolostream,
                               mol: Union[OEGraphMol,OEMol,OEQMol], flavor: int) -> None

   Writes the molecule in MOPAC input file format to the output stream 'ofs' with
   'flavor' parameter from the :oe:constns:`OEChem::OEOFlavor::MOPAC` namespace.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWriteMacroModelFile

.. oe:function:: OEWriteMacroModelFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEWriteMacroModelFile(oemolostream& ofs, OEMolBase& mol)
         void OEWriteMacroModelFile(oemolostream& ofs, OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteMacroModelFile(ofs: oemolostream, mol: Union[OEGraphMol,OEQMol]) -> None
         OEWriteMacroModelFile(ofs: oemolostream, mol: OEMol) -> None

   Writes the molecule as a MacroModel format file to the output stream
   'ofs'.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWriteMol2File

.. oe:function:: OEWriteMol2File

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEWriteMol2File(oemolostream& ofs, OEMolBase& mol,
                              bool m2h = true, bool substruct = false)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteMol2File(ofs: oemolostream,
                         mol: Union[OEGraphMol,OEMol,OEQMol], m2h: bool = True,
                         substruct: bool = False) -> None

   Writes the molecule as a Tripos mol2 format file to the output stream
   'ofs'.  The 'm2h' parameter specifies whether implicit hydrogens
   should be written out as explicit hydrogens in the mol2 file.  If the
   value of 'm2h' is ``false``, the mol2 file writer attempts to suppress
   writing hydrogens, if the resulting connection table can be read
   unambiguously.



.. oe:namespace:: OEChem

.. oe:language:: c++

   .. meta::
      :keywords: OEWriteMolToString

   ..   _oechem_oewritemoltostring:

   .. oe:function:: OEWriteMolToString

      .. oe:api:: c++

         std::string OEWriteMolToString(const std::string& format,
                                        const OEMolBase& mol)
         std::string OEWriteMolToString(unsigned format, bool gzip,
                                        const OEMolBase& mol)
         std::string OEWriteMolToString(unsigned format, unsigned flavor,
                                        bool gzip, const OEMolBase& mol)

         std::string OEWriteMolToString(const std::string& format,
                                        const OEMCMolBase& mol)
         std::string OEWriteMolToString(unsigned format, bool gzip,
                                        const OEMCMolBase& mol)
         std::string OEWriteMolToString(unsigned format, unsigned flavor,
                                        bool gzip, const OEMCMolBase& mol)

         bool OEWriteMolToString(std::string& molstring, unsigned format,
                                 bool gzip, const OEMolBase& mol)
         bool OEWriteMolToString(std::string& molstring, unsigned format,
                                 unsigned flavor, bool gzip,
                                 const OEMolBase& mol)
         bool OEWriteMolToString(std::string& molstring, unsigned format,
                                 bool gzip, const OEMCMolBase& mol)
         bool OEWriteMolToString(std::string& molstring, unsigned format,
                                 unsigned flavor, bool gzip,
                                 const OEMCMolBase& mol)

.. oe:language:: java

   .. meta::
      :keywords: OEWriteMolToByteArray

   ..   _oechem_oewritemoltobytearray:

   .. oe:function:: OEWriteMolToByteArray

      .. oe:api:: java

         byte[] OEWriteMolToByteArray(String format, OEMolBase mol)
         byte[] OEWriteMolToByteArray(int format, boolean gzip, OEMolBase mol)
         byte[] OEWriteMolToByteArray(int format, int flavor, boolean gzip,
                                      OEMolBase mol)

         byte[] OEWriteMolToByteArray(String format, OEMCMolBase mol)
         byte[] OEWriteMolToByteArray(int format, boolean gzip, OEMCMolBase mol)
         byte[] OEWriteMolToByteArray(int format, int flavor, boolean gzip,
                                      OEMCMolBase mol)

.. oe:language:: python

   .. meta::
      :keywords: OEWriteMolToBytes

   ..   _oechem_oewritemoltobytes:

   .. oe:function:: OEWriteMolToBytes

      .. oe:api:: python

         OEWriteMolToBytes(format, oemol) -> bytes
         OEWriteMolToBytes(format, gzip, oemol) -> bytes
         OEWriteMolToBytes(format, flavor, gzip, oemol) -> bytes

         OEWriteMolToBytes(format, oemcmol) -> bytes
         OEWriteMolToBytes(format, gzip, oemcmol) -> bytes
         OEWriteMolToBytes(format, flavor, gzip, oemcmol) -> bytes

.. oe:language:: csharp

   .. meta::
      :keywords: OEWriteMolToBytes, OEWriteMolToByteArray, OEWriteMolToString

   ..   _oechem_oewritemoltobytes:

   .. oe:function:: OEWriteMolToBytes

      .. oe:api:: csharp

         OEIntArray OEWriteMolToByteArray(String format, OEMolBase mol)
         OEIntArray OEWriteMolToByteArray(String format, OEMCMolBase mol)

         byte[] OEWriteMolToBytes(String format, OEMolBase mol)
         byte[] OEWriteMolToBytes(int format, int flavor, boolean gzip,
                                  OEMolBase mol)

         byte[] OEWriteMolToBytes(String format, OEMCMolBase mol)
         byte[] OEWriteMolToBytes(int format, int flavor, boolean gzip,
                                  OEMCMolBase mol)

.. oe:language:: python c++ java

   Encodes a molecule in terms of 'format'. 'format' must be a file extension
   that is writeable by OpenEye, for example: ".oeb.gz". The overloads which take
   a Boolean 'gzip' parameter or an unsigned 'flavor' and Boolean 'gzip' parameters expect
   the format or the format and flavor to be specified by one of the constants 
   in :oe:constns:`OEChem::OEFormat` and :oe:constns:`OEChem::OEOFlavor`.

.. oe:language:: csharp

   Encodes a molecule in terms of 'format'. 'format' must be a file extension
   that is writeable by OpenEye, for example: ".oeb.gz". Overloads which take
   an unsigned 'format', unsigned 'flavor' and Boolean 'gzip' parameters expect
   the format or the format and flavor to be specified by one of the constants
   in :oe:constns:`OEChem::OEFormat` and :oe:constns:`OEChem::OEOFlavor`.

   .. warning::

      The overload that takes an :ref:`OEIntArray <OEChem_OEIntArray>` is deprecated as of 2018.Feb and will be removed in a future
      version of **OEChem TK**, please use :oe:func:`OEChem::OEWriteMolToBytes` instead.

.. oe:language:: c++

   Overloads which take an extra string reference and return a boolean status write
   the result in the provided string and return `true` if encoding into
   the given string was successful.

   Otherwise, a non-empty std::string is returned if the encoding was successful.

.. oe:language:: java

   Returns a non-empty byte[] if encoding was successful.

.. oe:language:: python

   Returns bytes if encoding was successful, otherwise ''None''.

.. oe:language:: c++

   .. oe:source:: EncodeMols.cpp
      :language: c++
      :frag:     SNIPPET-WRITEMOL
      :noindent:

   .. oe:source:: EncodeMols.cpp
      :language: c++
      :frag:     SNIPPET-WRITEMOL2
      :noindent:

   .. oe:source:: EncodeMols.cpp
      :language: c++
      :frag:     SNIPPET-WRITEMOL3
      :noindent:

   .. oe:source:: EncodeMols.cpp
      :language: c++
      :frag:     SNIPPET-WRITEMOL4
      :noindent:

.. oe:language:: python

   .. oe:source:: EncodeMols.py
      :language: python
      :frag:     SNIPPET-WRITEMOL
      :noindent:

   .. oe:source:: EncodeMols.py
      :language: python
      :frag:     SNIPPET-WRITEMOL2
      :noindent:

   .. oe:source:: EncodeMols.py
      :language: python
      :frag:     SNIPPET-WRITEMOL3
      :noindent:

.. oe:language:: java

   .. oe:source:: EncodeMols.java
      :language: java
      :frag:     SNIPPET-WRITEMOL
      :noindent:

   .. oe:source:: EncodeMols.java
      :language: java
      :frag:     SNIPPET-WRITEMOL2
      :noindent:

   .. oe:source:: EncodeMols.java
      :language: java
      :frag:     SNIPPET-WRITEMOL3
      :noindent:

.. oe:language:: csharp

   .. oe:source:: EncodeMols.cs
      :language: csharp
      :frag:     SNIPPET-WRITEMOL
      :noindent:

   .. oe:source:: EncodeMols.cs
      :language: csharp
      :frag:     SNIPPET-WRITEMOL3
      :noindent:


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWriteMolecule

..  _oechem_oewritemolecule:

.. oe:function:: OEWriteMolecule

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEWriteMolecule(oemolostream& ofs, OEGraphMol& mol)
         unsigned int OEWriteMolecule(oemolostream& ofs, OEMol& mol)
         unsigned int OEWriteMolecule(oemolostream& ofs, OEQMol& mol)
         unsigned int OEWriteMolecule(oemolothread& ofs, OEMolBase& mol)
         unsigned int OEWriteMolecule(oemolothread& ofs, OEMCMolBase& mol)
         unsigned int OEWriteMolecule(oemolothread& ofs, OEQMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteMolecule(ofs: oemolostream, mol: OEGraphMol) -> int
         OEWriteMolecule(ofs: oemolostream, mol: OEMol) -> int
         OEWriteMolecule(ofs: oemolostream, mol: OEQMol) -> int
         OEWriteMolecule(ofs: oemolothread, mol: OEGraphMol) -> int

   These functions provide high-level file format writers for multiple file
   formats.  These functions are built on top of **OEChem TK**'s low-level file
   format writers and may modify the molecule by automatically invoking
   the appropriate perception routines (aromaticity, atom typing, chirality
   perception, residue perception, etc...) as required by the selected
   output format.  This greatly simplifies the task of writing molecules
   to a stream, but may provide less control than calling the lower-level
   functions directly.

   There are a parallel set of :oe:func:`OEChem::OEWriteConstMolecule`
   functions which write identical output without modifying the given
   molecule.  These const functions will operate on a copy of the molecule
   if additional perception is required.

   All of the overloads of :oe:func:`OEChem::OEWriteMolecule` functions
   return an error code from the :oe:constns:`OEChem::OEWriteMolReturnCode`
   namespace.
   A return code of ``0`` or :oe:const:`OEChem::OEWriteMolReturnCode::Success`
   indicates the write had no problems.

   ofs
     The output stream into which the molecule will be written.

     The file format controlled by the format field of the
     :ref:`oemolostream <OEChem_oemolostream>` which may be set and retrieved using
     the methods :oe:meth:`OEChem::oemolstreambase::SetFormat`, and
     :oe:meth:`OEChem::oemolstreambase::GetFormat` respectively.

     Additionally, the :oe:func:`OEChem::OEWriteMolecule` functions provide
     some level of control over the processing applied to a molecule prior
     to writing using **OEChem TK**'s file format flavor mechanism.
     Each output molecule stream maintains an independent 'flavor' value
     for each output file format that can be specified by
     :oe:meth:`OEChem::oemolstreambase::SetFlavor`.
     These 'flavors' are unsigned integer values that are the combination
     of bit patterns specified by the :oe:constns:`OEChem::OEOFlavor` namespace.
     The interpretation of each bit in a flavor depends upon the output file
     format to which it refers, and enables or disables processing
     associated with writing that output file format.

   mol
     The molecule that is written into the stream.

.. seealso::

   * :oe:constns:`OEChem::OEWriteMolReturnCode` namespace
   * :ref:`the OEFormat namespace <OEChem_OEFormat>`
   * :oe:constns:`OEChem::OEOFlavor` namespace
   * :oe:func:`OEChem::OEWriteConstMolecule` function

   .. oe:language:: c++

      * Example program :ref:`convert.cpp<section_example_oechem_convert>`

   .. oe:language:: python

      * Example program :ref:`convert.py<section_example_oechem_convert>`

   .. oe:language:: java

      * Example program :ref:`Convert.java<section_example_oechem_convert>`

   .. oe:language:: csharp

      * Example program :ref:`Convert.cs<section_example_oechem_convert>`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEChem

.. oe:function:: OEWriteMonomerSet

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteMonomerSet(const OEMonomerSet& monomers,
                                const std::string& jsonFileName)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteMonomerSet(monomers: OEMonomerSet, jsonFileName: str) -> bool

   Writes the monomer definitions stored in the monomer set (:oe:cls:`OEChem::OEMonomerSet`) into a JSON format.

   The following example shows how a monomer is represented in the output file:

   .. code-block:: bash

      {
        "smiles": "[H:1]N(C)[C@@H](Cc1ccccc1)C(=O)[OH:2]",
        "name": "N-alpha-methyl-L-Phenylalanine",
        "codes": {
           "OpenEye": "MeF",
           "PDB": "MEA"
        }
      },
   
   The :oe:const:`OEChem::OEPolymerType::Peptide` and :oe:const:`OEChem::OEMonomerType::Backbone`
   are considered defaults for a monomer and are only written to the json file if their 
   values differ from these defaults.

   .. only:: oehtml

      .. admonition::  See more example in the the following file:

         :download:`monomers-openeye.json <../../../../../sublibs/tklibs/oechem/peptide/data/monomers-openeye.json>`
   

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWritePDBFile

.. oe:function:: OEWritePDBFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWritePDBFile(oemolostream& ofs, OEMolBase& mol,
                             unsigned int flavor = OEOFlavor::PDB::DEFAULT)

   .. oe:language:: python

      .. oe:api:: python

         OEWritePDBFile(ofs: oemolostream, mol: Union[OEGraphMol,OEMol,OEQMol],
                        flavor: int) -> bool

   Writes the molecule as a Brookhaven PDB format file to the output
   stream 'ofs'.  A number of different PDB format variants are supported
   by the use of 'flavor' parameter from the
   :oe:constns:`OEChem::OEOFlavor::PDB` namespace.



.. oe:namespace:: OEChem

.. meta::
   :keywords: OEWriteXYZFile, WriteXYZFile

.. oe:function:: OEWriteXYZFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEWriteXYZFile(oemolostream& ofs, const OEMolBase& mol,
                             bool charges = true, bool symbols = true,
                             bool doubleprecision = false)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteXYZFile(ofs: oemolostream, mol: Union[OEGraphMol,OEMol,OEQMol],
                        charges: bool = True, symbols: bool = True,
                        doubleprecision: bool = False) -> None

   Writes the molecule as an XMol XYZ format file to the output stream 'ofs'.



*******************************************************************************
OEChem Functions
*******************************************************************************

.. _chapter_oechemfunctions:

.. toctree::
   :maxdepth: 1

   OE3DToAtomStereo.rst
   OE3DToBondStereo.rst
   OE3DToInternalStereo.rst
   OEAcyclicPath.rst
   OEAddCustomFASTAResidue.rst
   OEAddExplicitHydrogens.rst
   OEAddMMCIFData.rst
   OEAddMols.rst
   OEAddMolStyles.rst
   OEAddPDBData.rst
   OEAddSDData.rst
   OEApplyStyleChange.rst
   OEAssignAromaticFlags.rst
   OEAssignBondiVdWRadii.rst
   OEAssignCovalentRadii.rst
   OEAssignDelphiRadii.rst
   OEAssignFormalCharges.rst
   OEAssignHonigIonicCavityRadii.rst
   OEAssignHybridization.rst
   OEAssignImplicitHydrogens.rst
   OEAssignMDLHydrogens.rst
   OEAssignPaulingVdWRadii.rst
   OEAssignRadii.rst
   OEAssignResidueNumbers.rst
   OEAssignSerialNumbers.rst
   OEAssignZap7Radii.rst
   OEAssignZap9Radii.rst
   OEAtomGetMDLParity.rst
   OEAtomGetResidue.rst
   OEAtomGetSmallestRingSize.rst
   OEAtomIsInAromaticRingSize.rst
   OEAtomIsInRingSize.rst
   OEAtomSetMDLParity.rst
   OEAtomSetResidue.rst
   OEBAtomIntTypeOpts.rst
   OEBDefaultOpts.rst
   OEBGZipCompressOpts.rst
   OEBondGetSmallestRingSize.rst
   OEBondIsInAromaticRingSize.rst
   OEBondIsInRingSize.rst
   OEBRotCompressOpts.rst
   OEBuildMDLQueryExpressions.rst
   OECalcCartesianCoord.rst
   OECalcInternalCoord.rst
   OECalcPMI.rst
   OECalculateMolecularWeight.rst
   OECanonicalOrderAtoms.rst
   OECanonicalOrderBonds.rst
   OECenter.rst
   OECheckAtomValence.rst
   OECheckAtomValences.rst
   OEChemGetArch.rst
   OEChemGetLicensee.rst
   OEChemGetPlatform.rst
   OEChemGetRelease.rst
   OEChemGetSite.rst
   OEChemGetVersion.rst
   OEChemIsLicensed.rst
   OEClear2DRingDictionary.rst
   OEClearAromaticFlags.rst
   OEClearChiralPerception.rst
   OEClearFormalCharges.rst
   OEClearMMCIFData.rst
   OEClearPartialCharges.rst
   OEClearPDBData.rst
   OEClearResidue.rst
   OEClearResidues.rst
   OEClearRotorCompressData.rst
   OEClearSDData.rst
   OEClearStyle.rst
   OECopyMMCIFData.rst
   OECopyMol.rst
   OECopyPDBData.rst
   OECopySDData.rst
   OECorrectAcidProtonGeometry.rst
   OECount.rst
   OECreateAbsSmiString.rst
   OECreateCanSmiString.rst
   OECreateCSVHeader.rst
   OECreateInChIKey.rst
   OECreateInChI.rst
   OECreateIsoSmiString.rst
   OECreateMolDatabaseIdx.rst
   OECreateSlnString.rst
   OECreateSmiString.rst
   OECreateSubSearchDatabaseFile.rst
   OEDefaultImplicitHCount.rst
   OEDefaultMDLHCount.rst
   OEDeleteEverythingExceptTheFirstLargestComponent.rst
   OEDeletePDBData.rst
   OEDeleteSDData.rst
   OEDetermineAromaticRingSystems.rst
   OEDetermineComponents.rst
   OEDetermineConnectivity.rst
   OEDetermineReactants.rst
   OEDetermineRingSystems.rst
   OEDisassembleExpressions.rst
   OEDoubleBondCount.rst
   OEDoubleBondOCount.rst
   OEElementHistogram.rst
   OEEulerRotate.rst
   OEExactGraphMatch.rst
   OEExpandSuperAtoms.rst
   OEExtractRingTemplates.rst
   OEFastaToMol.rst
   OEFindRingAtomsAndBonds.rst
   OEFormalPartialCharges.rst
   OEGasteigerInitialCharges.rst
   OEGasteigerPartialCharges.rst
   OEGenerate2DCoordinates.rst
   OEGetAbsTorsion.rst
   OEGetAminoAcidCode.rst
   OEGetAngle.rst
   OEGetAnisou.rst
   OEGetAtomColor.rst
   OEGetAtomComment.rst
   OEGetAtomLabelColor.rst
   OEGetAtomLabelText.rst
   OEGetAtomicNum.rst
   OEGetAtomicSymbol.rst
   OEGetAutomorphs.rst
   OEGetAverageWeight.rst
   OEGetBondiVdWRadius.rst
   OEGetCenterAndExtents.rst
   OEGetCenterOfMass.rst
   OEGetColorSchemeName.rst
   OEGetComment.rst
   OEGetCovalentRadius.rst
   OEGetDefaultIFlavor.rst
   OEGetDefaultOFlavor.rst
   OEGetDefaultMass.rst
   OEGetDelphiRadius.rst
   OEGetDimensionFromCoords.rst
   OEGetDistance2.rst
   OEGetDistance.rst
   OEGetDoubleBondNeighbor.rst
   OEGetFileExtension.rst
   OEGetFileType.rst
   OEGetFormatExtension.rst
   OEGetFormatString.rst
   OEGetHonigIonicCavityRadius.rst
   OEGetHybridization.rst
   OEGetHydrogenCounts.rst
   OEGetIsotopicWeight.rst
   OEGetMCSExhaustiveSearchTruncationLimit.rst
   OEGetMDLDimensionFromCoords.rst
   OEGetMolDatabaseIdxFileName.rst
   OEGetMolDBIdx.rst
   OEGetNearestNbrs.rst
   OEGetNucleicAcidCode.rst
   OEGetMMCIFData.rst
   OEGetOEGraphMol.rst
   OEGetOEMol.rst
   OEGetOEQMol.rst
   OEGetOtherNeighbor.rst
   OEGetPackedCoords.rst
   OEGetPathLength.rst
   OEGetPaulingVdWRadius.rst
   OEGetPDBAtomIndex.rst
   OEGetPDBAtomName.rst
   OEGetPDBBaseData.rst
   OEGetPDBDataPairs.rst
   OEGetPDBData.rst
   OEGetRadiiTypeName.rst
   OEGetRadiusOfGyration.rst
   OEGetResidueIndex.rst
   OEGetResidueIndexFromCode.rst
   OEGetResidueName.rst
   OEGetSDBaseData.rst
   OEGetSDDataPairs.rst
   OEGetSDData.rst
   OEGetSingleBondNeighbor.rst
   OEGetSmallestSubtree.rst
   OEGetSmiStringOrder.rst
   OEGetSoleBond.rst
   OEGetSoleDoubleBond.rst
   OEGetSoleNeighbor.rst
   OEGetSoleSingleBond.rst
   OEGetSoleTripleBond.rst
   OEGetStyle.rst
   OEGetStyleChange.rst
   OEGetStyleIndex.rst
   OEGetSubSearchScreenType.rst
   OEGetSubtree.rst
   OEGetTokenizer.rst
   OEGetTorsion.rst
   OEGetTorsions.rst
   OEGetTripleBondNeighbor.rst
   OEGetUniMolecularRxnIter.rst
   OEHasAtomStereoHydrogens.rst
   OEHasBondStereoHydrogens.rst
   OEHasDoubleBondO.rst
   OEHasDoubleBond.rst
   OEHasExplicitHydrogens.rst
   OEHasExplicitHydrogenExpression.rst
   OEHasImplicitHydrogens.rst
   OEHasImplicitHydrogenExpression.rst
   OEHasMMCIFData.rst
   OEHasMolDBIdx.rst
   OEHasMultipleBond.rst
   OEHasPartialCharges.rst
   OEHasPDBData.rst
   OEHasRadii.rst
   OEHasResidue.rst
   OEHasResidues.rst
   OEHasSDData.rst
   OEHasSingleBond.rst
   OEHasStereoHydrogens.rst
   OEHasStyle.rst
   OEHasTokenizer.rst
   OEHasTripleBond.rst
   OEHistogramFormula.rst
   OEInChIToMol.rst
   OEInit2DRingDictionary.rst
   OEInitDefaultHandler.rst
   OEInitHandler.rst
   OEInvertCenter.rst
   OEIs2DFormat.rst
   OEIs3DFormat.rst
   OEIsBinary.rst
   OEIsCIFHeaderCompliant.rst
   OEIsCommonIsotope.rst
   OEIsComplementaryScreenType.rst
   OEIsExtension.rst
   OEIsGZip.rst
   OEIsReadable.rst
   OEIsSDDataFormat.rst
   OEIsTerminalOxygen.rst
   OEIsTerminalSulfur.rst
   OEIsValid2DRingDictionary.rst
   OEIsValidSubSearchDatabase.rst
   OEIsValidSubSearchScreenString.rst
   OEIsWriteable.rst
   OEKekulize.rst
   OEMacroModelAtomTypeNames.rst
   OEMacroModelAtomTypes.rst
   OEMacroModelTypeElement.rst
   OEMacroModelTypeName.rst
   OEMacroModelTypeNames.rst
   OEMakeSubSearchQueryScreen.rst
   OEMakeSubSearchTargetScreen.rst
   OEMDLClearBondStereo.rst
   OEMDLClearParity.rst
   OEMDLCorrectBondStereo.rst
   OEMDLGetParity.rst
   OEMDLGetValence.rst
   OEMDLHasIncorrectBondStereo.rst
   OEMDLHasParity.rst
   OEMDLPerceiveBondStereo.rst
   OEMDLPerceiveParity.rst
   OEMDLSetParity.rst
   OEMDLStereoFromBondStereo.rst
   OEMDLStereoFromParity.rst
   OEMMFF94InitialCharges.rst
   OEMMFF94PartialCharges.rst
   OEMMFFAtomTypeNames.rst
   OEMMFFAtomType.rst
   OEMMFFAtomTypes.rst
   OEMMFFClearRemappedElements.rst
   OEMMFFRemapElement.rst
   OEMMFFTypeIndex.rst
   OEMMFFTypeName.rst
   OEMMFFTypeNames.rst
   OEMolecularFormula.rst
   OEMolToInChIKey.rst
   OEMolToInChI.rst
   OEMolToCXSMILES.rst
   OEMolToSmiles.rst
   OEMolToSTDInChIKey.rst
   OEMolToSTDInChI.rst
   OEMultipleBondCount.rst
   OENetCharge.rst
   OENewMCMolBase.rst
   OENewMolBase.rst
   OENewQMolBase.rst
   OENormalize.rst
   OEOverlayConfsByRMSD
   OEParseInChI.rst
   OEParseSmarts.rst
   OEParseSmiles.rst
   OEParseSmirks.rst
   OEPDBOrderAtoms.rst
   OEPerceiveBondOrders.rst
   OEPerceiveChiral.rst
   OEPerceiveCIPStereo.rst
   OEPerceiveResidues.rst
   OEPerceiveSymmetry.rst
   OEPRECompress.rst
   OEPrepareSearch.rst
   OEPreserveRotCompress.rst
   OERandomizeTorsions.rst
   OEReadCDXFile.rst
   OEReadCIFFile.rst
   OEReadCSVFile.rst
   OEReadCSVHeader.rst
   OEReadFASTAFile.rst
   OEReadMacroModelFile.rst
   OEReadMDLFile.rst
   OEReadMDLQueryFile.rst
   OEReadMDLReactionQueryFile.rst
   OEReadMol2File.rst
   OEReadMolecule.rst
   OEReadMolFromString.rst
   OEReadMOPACFile.rst
   OEReadOEBFile.rst
   OEReadPDBFile.rst
   OEReadRxnFile.rst
   OEReadSketchFile.rst
   OEReadXYZFile.rst
   OEResidueHydrogens.rst
   OEResidueToString.rst
   OERGroupsToHydrogens.rst
   OERingBondCount.rst
   OERMSD.rst
   OERotate.rst
   OESameAlternateLocation.rst
   OESameChain.rst
   OESameResidue.rst
   OESameSubSearchScreenTypes.rst
   OEScrambleMolecule.rst
   OEScreen.rst
   OESet2DHydrogenGeom.rst
   OESet3DHydrogenGeom.rst
   OESetAngle.rst
   OESetAnisou.rst
   OESetAtomComment.rst
   OESetCIPStereo.rst
   OESetComment.rst
   OESetDefaultFlavors.rst
   OESetDefaultIFlavors.rst
   OESetDefaultOFlavors.rst
   OESetDimensionFromCoords.rst
   OESetDistance.rst
   OESetMCSExhaustiveSearchTruncationLimit.rst
   OESetMDLDimensionFromCoords.rst
   OESetMMCIFChemCompData.rst
   OESetMMCIFData.rst
   OESetOEGraphMol.rst
   OESetOEMol.rst
   OESetOEQMol.rst
   OESetPackedCoords.rst
   OESetPDBData.rst
   OESetSDData.rst
   OESetStyle.rst
   OESetStyleIndex.rst
   OESetTorsion.rst
   OEShortestPath.rst
   OESingleBondCount.rst
   OESmartsLexReplace.rst
   OESmilesAtomCount.rst
   OECXSMILESToMol.rst
   OESmilesToMol.rst
   OESortConfsBySDTag.rst
   OESortConfsByTag.rst
   OEString2OEAtomExpr.rst
   OEString2OEBondExpr.rst
   OESubSearchStatusToName.rst
   OESubsetMol.rst
   OESuppressHydrogens.rst
   OESweepMDLStereoGroups.rst
   OESweepRotorCompressHydrogens.rst
   OESweepStyles.rst
   OESymmetryNumber.rst
   OETerminalOCount.rst
   OETerminalSCount.rst
   OETheFunctionFormerlyKnownAsStripSalts.rst
   OETranslate.rst
   OETrimConformers.rst
   OETripleBondCount.rst
   OETriposAtomNames.rst
   OETriposAtomTypeNames.rst
   OETriposAtomType.rst
   OETriposAtomTypes.rst
   OETriposBondTypeNames.rst
   OETriposOrderAtoms.rst
   OETriposResonantTypeNames.rst
   OETriposTypeElement.rst
   OETriposTypeIndex.rst
   OETriposTypeName.rst
   OETriposTypeNames.rst
   OEUncolorMol.rst
   OEUpdateMMCIFData.rst
   OEWeightedRMSD.rst
   OEWrite2DRingDictionary.rst
   OEWriteCDXFile.rst
   OEWriteConstMolecule.rst
   OEWriteCSVFile.rst
   OEWriteCIFFile.rst
   OEWriteCSVHeader.rst
   OEWriteFASTAFile.rst
   OEWriteMacroModelFile.rst
   OEWriteMDLFile.rst
   OEWriteMol2File.rst
   OEWriteMolecule.rst
   OEWriteMolToString.rst
   OEWriteMOPACInputFile.rst
   OEWritePDBFile.rst
   OEWriteXYZFile.rst


*******************************************************************************
Preliminary OEChem Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEAminoAcidTypeToString
   OEApplyStateFromRef.rst
   OECreateAtomSmartsString
   OECreateBondSmartsString
   OECreatePeptideMonomerConnectionSmiles
   OECreateSmartsString
   OEDetectMonomers
   OEGetAminoAcidType
   OEGetHelmChainNames
   OEGetHelmMonomerCodes
   OEGetMonomerType
   OEGetPolymerType
   OEGetStandardAnalog
   OEIsStandardMonomer
   OEHelmToMol
   OEIsPeptide
   OEIsValidMonomerData
   OELoadOpenEyeMonomerSet
   OELoadStandardMonomerSet
   OEMonomerConnectionSmilesFromCXSmiles
   OEMolToHelm
   OEMonomerTypeToString
   OEPerceivePeptideBackbone
   OEPerceivePeptideMonomerConnections
   OEPolymerTypeToString
   OEReadMonomerSet
   OEStringToMonomerType
   OEStringToPolymerType
   OEWriteMonomerSet


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEBox

.. _OEMath_OEBox:

.. oe:class:: OEBox

   .. oe:api::

      class OEBox

   :ref:`OEBox <OEMath_OEBox>` class represents a box aligned to the x, y and z coordinate axis.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBox()
            OEBox(const OEBox&)

      .. oe:language:: python

         .. oe:api:: python

            OEBox() -> OEBox
            OEBox(arg2: OEBox) -> OEBox

      Default and copy constructors

   .. oe:method:: operator=
      :language: c++
  
      .. oe:api::

         OEBox& operator=(const OEBox& rhs)

      Assignment operator

      Assignment operator.

   .. oe:method:: Extend
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Extend(const float x, const float y, const float z)
            bool Extend(const float value)

      .. oe:language:: python

         .. oe:api:: python

            Extend(x: float, y: float, z: float) -> bool
            Extend(value: float) -> bool

      Extend the box in all dimensions with the specified values.  The box is extended simultaneously
      in both maximum and minimum coordinate directions

   .. oe:method:: GetArea
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetArea() -> float

      Returns the surface area of the box

   .. oe:method:: GetVolume
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetVolume() const

      .. oe:language:: python

         .. oe:api:: python

            GetVolume() -> float

      Returns the volume of the box

   .. oe:method:: GetXDim
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetXDim() const

      .. oe:language:: python

         .. oe:api:: python

            GetXDim() -> float

      Returns the X dimension value of the box

   .. oe:method:: GetYDim
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetYDim() const

      .. oe:language:: python

         .. oe:api:: python

            GetYDim() -> float

      Returns the Y dimension value of the box

   .. oe:method:: GetZDim
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZDim() const

      .. oe:language:: python

         .. oe:api:: python

            GetZDim() -> float

      Returns the Z dimension value of the box

   .. oe:method:: GetXMax
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetXMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetXMax() -> float

      Returns the maximum X value of the box

   .. oe:method:: GetYMax
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetYMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetYMax() -> float

      Returns the maximum Y value of the box

   .. oe:method:: GetZMax
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetZMax() -> float

      Returns the maximum Z value of the box

   .. oe:method:: GetXMid
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetXMid() const

      .. oe:language:: python

         .. oe:api:: python

            GetXMid() -> float

      Returns the midpoint of X dimension of the box

   .. oe:method:: GetYMid
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetYMid() const

      .. oe:language:: python

         .. oe:api:: python

            GetYMid() -> float

      Returns the midpoint of Y dimension of the box

   .. oe:method:: GetZMid
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZMid() const

      .. oe:language:: python

         .. oe:api:: python

            GetZMid() -> float

      Returns the midpoint of Z dimension of the box

   .. oe:method:: GetXMin
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetXMin() const

      .. oe:language:: python

         .. oe:api:: python

            GetXMin() -> float

      Returns the minimum X value of the box

   .. oe:method:: GetYMin
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetYMin() const

      .. oe:language:: python

         .. oe:api:: python

            GetYMin() -> float

      Returns the minimum Y value of the box

   .. oe:method:: GetZMin
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZMin() const

      .. oe:language:: python

         .. oe:api:: python

            GetZMin() -> float

      Returns the minimum Z value of the box

   .. oe:method:: IsInside
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsInside(const float x, const float y, const float z) const

      .. oe:language:: python

         .. oe:api:: python

            IsInside(x: float, y: float, z: float) -> bool

      Returns if the specified point is inside the box

   .. oe:method:: Setup
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Setup(const float x1, const float y1, const float z1,
                       const float x2, const float y2, const float z2)
            bool Setup(const float* xyz, const unsigned numPoints,
                       const bool addbox = 0.0f)
            bool Setup(const float* center, const float* extents)

      .. oe:language:: python

         .. oe:api:: python

            Setup(x1: float, y1: float, z1: float, x2: float, y2: float,
                  z2: float) -> bool
            Setup(xyz: OEFloatArray, numPoints: int, addbox: float = 0.0) -> bool
            Setup(center: OEFloatArray, extents: OEFloatArray) -> bool

      Sets up the box.  

      The first overload expects the maximum and minimum values in all directions.
      The max and min X values are the max and min of *x1*, *x2* respectively.  Minimum 
      and maximum values of Y and Z are selected in an analogous fashion.

      The second overload creates a box that encapsulates all the specified data points.
      The number of values in ``xyz`` must be three times that specified in ``numPoints``.
      The value in ``addbox`` extends the box in all three dimensions with the specified value.
      The box is extended simultaneously in both maximum and minimum coordinate directions,
      when specified.

      The third overload creates a box with the specified center and extent.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMath

.. meta::
   :keywords: OEKernelPLS, KernelPLS

.. _OEMath_OEKernelPLS:

.. oe:class:: OEKernelPLS

   .. oe:api::

      class OEKernelPLS
      
   The :ref:`OEKernelPLS <OEMath_OEKernelPLS>` can be used to build models using
   kernel partial least squares technique (kPLS).

   To train a model using kPLS, the descriptors are expected to be in the 
   dot-kernel space.  Kernel partial least squares (PLS) has been particularly 
   popular in chemometrics, due to its sub-cubic runtime for learning, and 
   an iterative construction of directions which are relevant for predicting 
   the outputs.

   The :ref:`OEKernelPLS <OEMath_OEKernelPLS>` class defines the following public methods:
    * :oe:meth:`Fit<OEMath::OEKernelPLS::Fit>`
    * :oe:meth:`GetB0<OEMath::OEKernelPLS::GetB0>`
    * :oe:meth:`GetBValues<OEMath::OEKernelPLS::GetBValues>`
    * :oe:meth:`GetNumFeaturesUsed<OEMath::OEKernelPLS::GetNumFeaturesUsed>`
    * :oe:meth:`Predict<OEMath::OEKernelPLS::Predict>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEKernelPLS()
            OEKernelPLS(const OEKernelPLS&)

      .. oe:language:: python

         .. oe:api:: python

            OEKernelPLS() -> OEKernelPLS
            OEKernelPLS(arg2: OEKernelPLS) -> OEKernelPLS

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEKernelPLS &operator=(const OEKernelPLS &)

      Assignment operator.

   .. oe:method:: Fit

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Fit(const OESquareMatrix& kernel,
                     const std::vector<double>& vecResponse,
                     const unsigned maxFeatures)

      .. oe:language:: python

         .. oe:api:: python

            Fit(kernel: OESquareMatrix, vecResponse: OEDoubleVector,
                maxFeatures: int) -> bool

      Fit model using the provided kernel descriptor matrix.

         *kernel*   
            kernel descriptor matrix.

         *vecResponse*    
            vector of response corresponding to descriptors.

         *maxFeatures*    
            Maximum number of PLS features to use for model fitting.  A value of *0 (zero)*
            corresponds to choosing number of features to fit the best model that minimizes 
            error on the training set.

   .. oe:method:: GetB0

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetB0() const

      .. oe:language:: python

         .. oe:api:: python

            GetB0() -> float

      Get the fitted model intercept.

   .. oe:method:: GetBValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<double>& GetBValues() const

      .. oe:language:: python

         .. oe:api:: python

            GetBValues() -> OEDoubleVector

      Get the fitted model regression coefficients. 

   .. oe:method:: GetNumFeaturesUsed

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetNumFeaturesUsed() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumFeaturesUsed() -> int

      Returns the actual number of PLS features used for model fitting.

   .. oe:method:: Predict

      .. oe:language:: c++ java csharp

         .. oe:api::

            double Predict(const std::vector<double>& kernel) const

      .. oe:language:: python

         .. oe:api:: python

            Predict(kernel: OEDoubleVector) -> float

      Returns predicted estimation for the input descriptor vector.


.. _OEMathClasses:

*******************************************************************************
OEMath Classes
*******************************************************************************

.. oe:namespace:: OEMath

.. toctree::

   OEBox
   OEKernelPLS
   OEMatrix
   OESphere
   OESquareMatrix


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMath

.. meta::
   :keywords: OEMatrix

.. _OEMath_OEMatrix:

.. oe:class:: OEMatrix

   .. oe:api::

      class OEMatrix

   :ref:`OEMatrix <OEMath_OEMatrix>` class represents a Matrix.

   The :ref:`OEMatrix <OEMath_OEMatrix>` class defines the following public methods:
    * :oe:meth:`AddRow<OEMath::OEMatrix::AddRow>`
    * :oe:meth:`Clear<OEMath::OEMatrix::Clear>`
    * :oe:meth:`GetData<OEMath::OEMatrix::GetData>`
    * :oe:meth:`GetNumColumns<OEMath::OEMatrix::GetNumColumns>`
    * :oe:meth:`GetNumRows<OEMath::OEMatrix::GetNumRows>`
    * :oe:meth:`Resize<OEMath::OEMatrix::Resize>`
    * :oe:meth:`SetRowData<OEMath::OEMatrix::SetRowData>`
    * :oe:meth:`Transpose<OEMath::OEMatrix::Transpose>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatrix()
            OEMatrix(const unsigned numRow, const unsigned numCol,
                     const double initialValue = 0.0)
            OEMatrix(const OEMatrix&)

      .. oe:language:: python

         .. oe:api:: python

            OEMatrix() -> OEMatrix
            OEMatrix(arg2: OEMatrix) -> OEMatrix
            OEMatrix(numRow: int, numCol: int, initialValue: float = 0.0) -> OEMatrix

      Default and copy constructors.

      The default constructor creates an empty matrix. The second overload creates a matrix
      with *numRows* rows and *numCols* columns, with all the values set to zero.  The
      third overload creates a matrix with *numRows* rows and *numCols* columns, with all the 
      values set to *initialValue*.

   .. oe:method:: operator=
      :language: c++
  
      .. oe:api::

         OEMatrix& operator=(const OEMatrix& rhs)

      Assignment operator for :ref:`OEMatrix <OEMath_OEMatrix>`.

      Assignment operator.

   .. oe:method:: AddRow
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddRow(const double initialValue = 0.0)

      .. oe:language:: python

         .. oe:api:: python

            AddRow(initialValue: float = 0.0) -> None

      Add a new row to the matrix.  The new row is initialized with *zero*, unless
      *initialValue* is provided.

   .. oe:method:: Clear
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Clear the matrix.

   .. oe:method:: GetData
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<double>& GetData() const

      .. oe:language:: python

         .. oe:api:: python

            GetData() -> OEDoubleVector

      Get the contents of the matrix. The data is organized sequentially from the first row
      to the last.

   .. oe:method:: GetNumColumns
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetNumColumns() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumColumns() -> int

      Returns the number of columns in the matrix.

   .. oe:method:: GetNumRows
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetNumRows() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumRows() -> int

      Returns the number of rows in the matrix.

   .. oe:method:: Resize
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            void Resize(const unsigned numRow, const unsigned numCol,
                        const double initialValue = 0.0)

      .. oe:language:: python

         .. oe:api:: python

            Resize(numRow: int, numCol: int, initialValue: float = 0.0) -> None

      Resize the matrix to *numRows* rows and *numCols* columns.  The matrix is initialized 
      with *zero*, unless *initialValue* is provided.

   .. oe:method:: SetRowData
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRowData(const unsigned iRow,
                            const std::vector<double>& vecValues)

      .. oe:language:: python

         .. oe:api:: python

            SetRowData(iRow: int, vecValues: OEDoubleVector) -> None

      Set *vecValues* as content of the *iRow*-th row.

   .. oe:method:: Transpose
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatrix Transpose() const

      .. oe:language:: python

         .. oe:api:: python

            Transpose() -> OEMatrix

      Returns the transpose of the matrix.


.. oe:namespace:: OEMath

.. meta::
   :keywords: OESphere, SphereBase

.. _OEMath_OESphere:

.. oe:class:: OESphere

   .. oe:api::OESphere

      class OESphere

   :ref:`OESphere <OEMath_OESphere>` class represents a sphere.

   .. oe:method:: Constructor
      
      .. oe:language:: c++ java csharp

         .. oe:api::

            OESphere()
            OESphere& operator=(const OESphere&)
            OESphere(const float x, const float y, const float z,
                     const float rad)

      .. oe:language:: python

         .. oe:api:: python

            OESphere() -> OESphere
            OESphere(x: float, y: float, z: float, rad: float) -> OESphere
            OESphere(arg2: OESphere) -> OESphere

   Default and copy constructors.  The third overload requires the center of the
   sphere, specified by `x, y, and z`, and the radius.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESphere& operator=(const OESphere& rhs)

   Assignment operator.

   .. oe:method:: GetArea
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetArea() -> float

      Returns the surface area of the sphere

   .. oe:method:: GetVolume
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetVolume() const

      .. oe:language:: python

         .. oe:api:: python

            GetVolume() -> float

      Returns the volume of the sphere

   .. oe:method:: GetX

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetX() const

      .. oe:language:: python

         .. oe:api:: python

            GetX() -> float

      Returns the X coordinate of the center of the sphere

   .. oe:method:: GetY

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetY() const

      .. oe:language:: python

         .. oe:api:: python

            GetY() -> float

      Returns the Y coordinate of the center of the sphere

   .. oe:method:: GetZ

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZ() const

      .. oe:language:: python

         .. oe:api:: python

            GetZ() -> float

      Return the Z coordinate of the center of the sphere

   .. oe:method:: GetRad

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetRad() const

      .. oe:language:: python

         .. oe:api:: python

            GetRad() -> float

      Returns the radius of the sphere

   .. oe:method:: IsInside
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsInside(const float x, const float y, const float z) const

      .. oe:language:: python

         .. oe:api:: python

            IsInside(x: float, y: float, z: float) -> bool

      Returns if the specified point is inside the sphere

   .. oe:method:: SetRad

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRad(const float rad)

      .. oe:language:: python

         .. oe:api:: python

            SetRad(rad: float) -> bool

      Sets the radius of the sphere to *rad*.  Will
      fail and return false if *rad* < 0.

   .. oe:method:: SetCenter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCenter(const float x, const float y, const float z)

      .. oe:language:: python

         .. oe:api:: python

            SetCenter(x: float, y: float, z: float) -> bool

      Sets the center of the sphere.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMath

.. meta::
   :keywords: OESquareMatrix

.. _OEMath_OESquareMatrix:

.. oe:class:: OESquareMatrix

   .. oe:api::

      class OESquareMatrix : public OEMatrix

   :ref:`OESquareMatrix <OEMath_OESquareMatrix>` class represents a square matrix.

   Following methods are publicly inherited from :ref:`OEMatrix <OEMath_OEMatrix>`:
    * :oe:meth:`Clear<OEMath::OEMatrix::Clear>`
    * :oe:meth:`GetData<OEMath::OEMatrix::GetData>`
    * :oe:meth:`GetNumColumns<OEMath::OEMatrix::GetNumColumns>`
    * :oe:meth:`GetNumRows<OEMath::OEMatrix::GetNumRows>`
    * :oe:meth:`SetRowData<OEMath::OEMatrix::SetRowData>`
    * :oe:meth:`Transpose<OEMath::OEMatrix::Transpose>`

   The :ref:`OESquareMatrix <OEMath_OESquareMatrix>` class defines the following public methods:
    * :oe:meth:`Resize<OEMath::OEMatrix::Resize>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESquareMatrix()
            OESquareMatrix(const unsigned numRows,
                           const double initialValue = 0.0)
            OESquareMatrix(const OESquareMatrix&)

      .. oe:language:: python

         .. oe:api:: python

            OESquareMatrix() -> OESquareMatrix
            OESquareMatrix(numRows: int, initialValue: float = 0.0) -> OESquareMatrix
            OESquareMatrix(arg2: OESquareMatrix) -> OESquareMatrix

      Default and copy constructors.

      The default constructor creates an empty matrix. The second overload creates a matrix
      with *numRows* rows and columns, with all the values set to zero.  The
      third overload creates a matrix with *numRows* rows and columns, with all the 
      values set to *initialValue*.

   .. oe:method:: operator=
      :language: c++
  
      .. oe:api::

         OESquareMatrix& operator=(const OESquareMatrix& rhs)

      Assignment operator for :ref:`OESquareMatrix <OEMath_OESquareMatrix>`.

      Assignment operator.

   .. oe:method:: Resize
        
      .. oe:language:: c++ java csharp

         .. oe:api::

            void Resize(const unsigned numRow, const double initialValue = 0.0)

      .. oe:language:: python

         .. oe:api:: python

            Resize(numRow: int, initialValue: float = 0.0) -> None

      Resize the matrix to *numRows* rows and columns.  The matrix is initialized 
      with *zero*, unless *initialValue* is provided.


.. oe:namespace:: OEMath

.. oe:constnamespace:: OEConst

   This namespace contains constants.

   .. oe:constant:: c
   
      The speed of light in :math:`meters/second`.

   .. oe:constant:: h
   
      The Planck's constant in :math:`J*s` (joule-seconds).

   .. oe:constant:: hbar
   
      The reduced Planck constant which is equal to the
      :oe:const:`Planck constant<OEMath::OEConst::h>` divided by (or
      reduced by) :math:`2\pi`.
 
   .. oe:constant:: NA
   
      The Avogadro constant in :math:`mol^{-1}`.

   .. oe:constant:: k
   
      Boltzmann constant in :math:`JK^{-1}mol^{-1}`.

   .. oe:constant:: e
   
      The elementary charge in :math:`coulombs`.

   .. oe:constant:: R
   
      The gas constant in :math:`JK^{-1}`.

   .. oe:constant:: me
   
      The electron mass constant in :math:`kg`.

   .. oe:constant:: mp
   
      The proton mass constant in :math:`kg`.

   .. oe:constant:: mu
   
      The atomic mass constant in :math:`kg`.

   .. oe:constant:: eps0
   
      The electric constant (vacuum permittivity) in :math:`C^2*N^{-1}*m^{-2}`

   .. oe:constant:: cal2J
   
      The thermodynamic calorie to Joule factor.


.. oe:namespace:: OEMath

.. oe:constnamespace:: OEMath

   This namespace contains constants.

   .. oe:constant:: Rad2Deg
   
      Conversion coefficient for angles from radians to degrees.

   .. oe:constant:: Deg2Rad
   
      Conversion coefficient for angles from degrees to radians.

   .. oe:constant:: Pi
   
      Numerical constant pi, :math:`\pi`, the circumference of a
      circle divided by its diameter.

   .. oe:constant:: Pi2

      Twice the numerical value of pi, :math:`\pi`. This is the number
      of radians in a complete revolution.


.. _OEMathConstants:

*******************
OEMath Constants
*******************

.. oe:namespace:: OEMath

.. toctree::

   OEMath
   OEConst



.. oe:namespace:: OEMath

.. meta::
   :keywords: OEBoxArea

.. oe:function:: OEBoxArea

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxArea(const OEBox& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxArea(box: OEBox) -> float

   Return the area of the box.




.. oe:namespace:: OEMath

.. meta::
   :keywords: OEBoxExtend

.. oe:function:: OEBoxExtend

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBoxExtend(OEBox& box, const float x_ext, const float y_ext,
                          const float z_ext)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxExtend(box: OEBox, x: float, y: float, z: float) -> bool

   Extends each side of the *box* by the specified amount.  *x_ext* extends
   the two faces of the box normal to the x-axis.  Thus the x dimension of
   the box will increase by 2 times *x_ext*.  The *y_ext* and *z_ext* perform
   the same function for the y and z faces respectively.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBoxExtend(OEBox& box, const float ext)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxExtend(box: OEBox, value: float) -> bool

   Extends every face of *box* by *ext*.  Thus every dimension of the box
   will increase by 2 times *ext*.
   



.. oe:namespace:: OEMath

.. meta::
   :keywords: OEBoxTranslate

.. oe:function:: OEBoxTranslate

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBoxTranslate(OEBox& box, const float x_trans,
                             const float y_trans, const float z_trans)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxTranslate(box: OEBox, x: float, y: float, z: float) -> bool

   Translates *box* a distance specified by (*x_trans*, *y_trans*, *z_trans*)




.. oe:namespace:: OEMath

.. meta::
   :keywords: OEBoxVolume

.. oe:function:: OEBoxVolume

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxVolume(const OEBox& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxVolume(box: OEBox) -> float

   Return the volume of the box




.. oe:namespace:: OEMath

.. meta::
   :keywords: OEBoxXDim

.. oe:function:: OEBoxXDim

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxXDim(const OEBox& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxXDim(box: OEBox) -> float

   Returns the X dimension of the box.




.. oe:namespace:: OEMath

.. meta::
   :keywords: OEBoxXMid

.. oe:function:: OEBoxXMid

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxXMid(const OEBox& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxXMid(box: OEBox) -> float

   Returns the X midpoint of the  box.




.. oe:namespace:: OEMath

.. meta::
   :keywords: OEBoxYDim

.. oe:function:: OEBoxYDim

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxYDim(const OEBox& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxYDim(box: OEBox) -> float

   Returns the Y dimension of the box.




.. oe:namespace:: OEMath

.. meta::
   :keywords: OEBoxYMid

.. oe:function:: OEBoxYMid

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxYMid(const OEBox& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxYMid(box: OEBox) -> float

   Returns the Y midpoint of the  box.




.. oe:namespace:: OEMath

.. meta::
   :keywords: OEBoxZDim

.. oe:function:: OEBoxZDim

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxZDim(const OEBox& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxZDim(box: OEBox) -> float

   Returns the Z dimension of the box.




.. oe:namespace:: OEMath

.. meta::
   :keywords: OEBoxZMid

.. oe:function:: OEBoxZMid

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxZMid(const OEBox& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxZMid(box: OEBox) -> float

   Returns the Z midpoint of the  box.



.. # split from OEMathFunctions.rst:9

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OECenter

.. oe:function:: OECenter

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OECenter(T* c, unsigned int size, U* trans)

   .. oe:language:: python

      .. oe:api:: python

         OECenter(conf: OEConfBase, t: OEDoubleArray = None) -> None
         OECenter(mcmol: OEMol, t: OEDoubleArray = None) -> None
         OECenter(arg1: Union[OEGraphMol,OEQMol], t: OEDoubleArray = None) -> None

   Moves the cartesian points specified by ``c`` so that the collective
   center-of-mass is located at the origin, ``(0.0, 0.0, 0.0)``. The
   translation applied to every point is returned as the ``trans``
   parameter.



.. # split from OEMathFunctions.rst:22

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DAdd

.. oe:function:: OEGeom2DAdd

   .. oe:language:: c++

      .. oe:api::

         template<class T>
         void OEGeom2DAdd(T* x, const T* p)
         template<class T>
         void OEGeom2DAdd(T* x, const T* p, const T* q)

   .. oe:language:: python

      .. oe:api::

         OEGeom2DAdd(x: OEFloatArray, p: OEFloatArray) -> None
         OEGeom2DAdd(x: OEFloatArray, p: OEFloatArray, q: OEFloatArray) -> None
         OEGeom2DAdd(x: OEDoubleArray,  p: OEDoubleArray) -> None
         OEGeom2DAdd(x: OEDoubleArray, p: OEDoubleArray, q: OEDoubleArray) -> None

   .. oe:language:: java

      .. oe:api::

         void OEGeom2DAdd(OEFloatArray x, OEFloatArray p)
         void OEGeom2DAdd(OEDoubleArray x, OEDoubleArray p)
         void OEGeom2DAdd(OEFloatArray x, OEFloatArray p, OEFloatArray q)
         void OEGeom2DAdd(OEDoubleArray x, OEDoubleArray p, OEDoubleArray q)

   .. oe:language:: csharp

      .. oe:api::

         void OEGeom2DAdd(float[] x, float[] p)
         void OEGeom2DAdd(double[] x, double[] p)
         void OEGeom2DAdd(float[] x, float[] p, float[] q)
         void OEGeom2DAdd(double[] x, double[] p, double[] q)
            
   Two dimensional vector addition. The first form computes :math:`x + =p` and
   the second form computes :math:`x = p + q`.



.. # split from OEMathFunctions.rst:63

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DAngle

.. oe:function:: OEGeom2DAngle

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         double OEGeom2DAngle(const T* p, const T* q, const T* r)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom2DAngle(p: OEFloatArray, q: OEFloatArray, r: OEFloatArray) -> float
         OEGeom2DAngle(p: OEDoubleArray, q: OEDoubleArray, r: OEDoubleArray) -> float

   Determines the angle in two dimensions between ``p``, ``q`` and ``r``. 
   The result is in radians.  The two dimensional array ``q`` represents the 
   vertex for angle calculation.



.. # split from OEMathFunctions.rst:73

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DCopy

.. oe:function:: OEGeom2DCopy

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom2DCopy(T* x, const T* p)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom2DCopy(x: OEFloatArray, p: OEFloatArray) -> None
         OEGeom2DCopy(x: OEDoubleArray, p: OEDoubleArray) -> None

   Two dimensional vector assignment. The vector ``x`` is assigned the
   value of ``p``.

   *x*
      Output two dimensional array.

   *p*
      Input two dimensional array.



.. # split from OEMathFunctions.rst:83

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DDistance

.. oe:function:: OEGeom2DDistance

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         double OEGeom2DDistance(const T* p, const T* q)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom2DDistance(p: OEFloatArray, q: OEFloatArray) -> float
         OEGeom2DDistance(p: OEDoubleArray, q: OEDoubleArray) -> float

   Determines the distance in two dimensions between ``p`` and ``q``.

   *p*
      First two dimensional input array.

   *q*
      Second two dimensional input array.



.. # split from OEMathFunctions.rst:92

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DDistance2

.. oe:function:: OEGeom2DDistance2

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         double OEGeom2DDistance2(const T* p, const T* q)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom2DDistance2(p: OEFloatArray, q: OEFloatArray) -> float
         OEGeom2DDistance2(p: OEDoubleArray, q: OEDoubleArray) -> float

   Determines the squared distance in two dimensions between ``p`` and ``q``.
   When it is possible to use the square of the distance, this is more
   efficient than using :oe:func:`OEMath::OEGeom2DDistance`.

   *p*
      First two dimensional input array.

   *q*
      Second two dimensional input array.



.. # split from OEMathFunctions.rst:101

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DDotProd

.. oe:function:: OEGeom2DDotProd

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         double OEGeom2DDotProd(const T* p, const T* q)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom2DDotProd(p: OEFloatArray, q: OEFloatArray) -> float
         OEGeom2DDotProd(p: OEDoubleArray, q: OEDoubleArray) -> float

   Determines the dot-product in two dimensions between ``p`` and ``q``.



.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DMagnitude

.. oe:function:: OEGeom2DMagnitude

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         double OEGeom2DMagnitude(T* x)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom2DMagnitude(x: OEFloatArray) -> float
         OEGeom2DMagnitude(x: OEDoubleArray) -> float

   Returns the length of the two element vector ``x``. 

   *x*
      Input two element vector.


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DMidpoint

.. oe:function:: OEGeom2DMidpoint

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom2DMidpoint(T* x, const T* p, const T* q)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom2DMidpoint(x: OEFloatArray, p: OEFloatArray, q: OEFloatArray) -> None
         OEGeom2DMidpoint(x: OEDoubleArray, p: OEDoubleArray, q: OEDoubleArray) -> None

   Determines the midpoint ``x`` between ``p`` and ``q`` in two dimensions.  
   
   *x*
      Output two dimensional array.

   *p*
      Input two dimensional array.

   *q*
      Input two dimensional array.


.. # split from OEMathFunctions.rst:111

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DNormalize

.. oe:function:: OEGeom2DNormalize

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom2DNormalize(T* x)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom2DNormalize(x: OEFloatArray) -> None
         OEGeom2DNormalize(x: OEDoubleArray) -> None

   Normalizes the two dimensional vector ``x`` to a unit vector.

   *x*
      Two dimensional array to normalize.


.. # split from OEMathFunctions.rst:120

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DRotate

.. oe:function:: OEGeom2DRotate

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom2DRotate(T* xyz, const U* m, unsigned int ncoord)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom2DRotate(xyz: OEFloatArray, m: OEFloatArray, ncoord: int) -> None
         OEGeom2DRotate(xyz: OEDoubleArray, m: OEDoubleArray, ncoord: int) -> None

   Rotates the two dimensional coordinates by the :math:`2 \times 2`
   rotation matrix passed as the argument ``m``.  For ``ncoord`` sets 
   of coordinates the input array ``xyz`` is expected to have a length 
   of :math:`2*ncoord`.

   *xyz*
      Array of coordinates to rotate

   *m*
      Rotation matrix

   *ncoord*
      Number of coordinate sets


.. # split from OEMathFunctions.rst:128

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DScale

.. oe:function:: OEGeom2DScale

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom2DScale(T* x, const T p)
         template<class T>
         void OEGeom2DScale(T* x, const T p, const T* q)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom2DScale(x: OEFloatArray, p: float) -> None
         OEGeom2DScale(x: OEDoubleArray, p: float) -> None
         OEGeom2DScale(x: OEFloatArray, p: float, q: OEFloatArray) -> None
         OEGeom2DScale(x: OEDoubleArray, p: float, q: OEDoubleArray) -> None

   Two dimensional vector scaling. The first form computes :math:`x *= p` and
   the second form computes :math:`x = p * q`.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DSetLength

.. oe:function:: OEGeom2DSetLength

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom2DSetLength(T* x, T len)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom2DSetLength(x: OEFloatArray, len: float) -> None
         OEGeom2DSetLength(x: OEDoubleArray, len: float) -> None

   Sets the two dimensional vector ``x`` to have a magnitude of ``len``.


.. # split from OEMathFunctions.rst:148

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DSubtract

.. oe:function:: OEGeom2DSubtract

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom2DSubtract(T* x, const T* p)
         template<class T>
         void OEGeom2DSubtract(T* x, const T* p, const T* q)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom2DSubtract(x: OEFloatArray, p: OEFloatArray) -> None
         OEGeom2DSubtract(x: OEDoubleArray, p: OEDoubleArray) -> None
         OEGeom2DSubtract(x: OEFloatArray, p: OEFloatArray, q: OEFloatArray) -> None
         OEGeom2DSubtract(x: OEDoubleArray, p: OEDoubleArray, q: OEDoubleArray) -> None

   Two dimensional vector subtraction. The first form computes :math:`x -= p` and
   the second form computes :math:`x = p - q`.



.. # split from OEMathFunctions.rst:160

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom2DTranslate

.. oe:function:: OEGeom2DTranslate

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom2DTranslate(T* xyz, const U* t, unsigned int ncoord)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom2DTranslate(xyz: OEFloatArray, t: OEFloatArray, ncoord: int) -> None
         OEGeom2DTranslate(xyz: OEDoubleArray, t: OEDoubleArray, ncoord: int) -> None

   Translates the two dimensional coordinates by the vector passed as the 
   argument ``t``.  The vector ``t`` must be of size two and contain the Cartesian
   translation vectors.  For ``ncoord`` sets of coordinates the input array ``xyz``
   is expected to have a length of :math:`2*ncoord`.

   *xyz*
      Array of coordinates to translate

   *t*
      Translation vector array

   *ncoord*
      Number of coordinate sets


.. # split from OEMathFunctions.rst:168

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DAbsTorsion

.. oe:function:: OEGeom3DAbsTorsion

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         double OEGeom3DAbsTorsion(const T* p, const T* q, const T* r,
                                   const T* s)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DAbsTorsion(p: OEFloatArray, q: OEFloatArray, r: OEFloatArray,
                            s: OEFloatArray) -> float
         OEGeom3DAbsTorsion(p: OEDoubleArray, q: OEDoubleArray,
                            r: OEDoubleArray, s: OEDoubleArray) -> float

   Determines the absolute value of the torsion between three
   dimensional coordinates ``p``, ``q``, ``r`` and ``s``. 
   The result is in radians.



.. # split from OEMathFunctions.rst:179

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DAdd

.. oe:function:: OEGeom3DAdd

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom3DAdd(T* x, const U* p)
         template<class T>
         void OEGeom3DAdd(T* x, const T* p, const T* q)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DAdd(x: OEFloatArray, p: OEFloatArray) -> None
         OEGeom3DAdd(x: OEDoubleArray, p: OEDoubleArray) -> None
         OEGeom3DAdd(x: OEFloatArray, p: OEFloatArray, q: OEFloatArray) -> None
         OEGeom3DAdd(x: OEDoubleArray, p: OEDoubleArray, q: OEDoubleArray) -> None

   Three dimensional vector addition. The first form computes :math:`x+=p` and
   the second form computes :math:`x = p + q`.



.. # split from OEMathFunctions.rst:213

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DAllZero

.. oe:function:: OEGeom3DAllZero

   .. oe:api::

      template<class T>
      bool OEGeom3DAllZero(const T* x, unsigned int ncoord)

   Returns ``true`` if all the coordinates pointed to by ``x`` are zero.

   *x*
      Three dimensional coordinates array to check.

   *ncoord*
      Number of coordinates in the input array.



.. # split from OEMathFunctions.rst:191

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DAngle

.. oe:function:: OEGeom3DAngle

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         double OEGeom3DAngle(const T* p, const T* q)
         template<class T, class U, class V>
         double OEGeom3DAngle(const T* p, const U* q, const V* r)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DAngle(p: OEFloatArray, q: OEFloatArray) -> float
         OEGeom3DAngle(p: OEDoubleArray, q: OEDoubleArray) -> float
         OEGeom3DAngle(p: OEFloatArray, q: OEFloatArray, r: OEFloatArray) -> float
         OEGeom3DAngle(p: OEDoubleArray, q: OEDoubleArray, r: OEDoubleArray) -> float

   Determines the angle in three dimensions. The first form is between 
   two vectors ``p`` and ``q``, and the second form is between three 
   cartesian coordinate points ``p``, ``q`` and ``r`` with ``q`` 
   being the vertex.  The result is in radians.



.. # split from OEMathFunctions.rst:203

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DAngleCoord

.. oe:function:: OEGeom3DAngleCoord

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom3DAngleCoord(T* dst, const T* center, const T* r1, T ang,
                                 T len)
         template<class T>
         void OEGeom3DAngleCoord(T* dst, const T* center, const T* r1,
                                 const T* n, T ang, T len)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DAngleCoord(dst: OEFloatArray, center: OEFloatArray,
                            r1: OEFloatArray, ang: float, len: float) -> None
         OEGeom3DAngleCoord(dst: OEDoubleArray, center: OEDoubleArray,
                            r1: OEDoubleArray, ang: float, len: float) -> None
         OEGeom3DAngleCoord(dst: OEFloatArray, center: OEFloatArray,
                            r1: OEFloatArray, n: OEFloatArray, ang: float,
                            len: float) -> None
         OEGeom3DAngleCoord(dst: OEDoubleArray, center: OEDoubleArray,
                            r1: OEDoubleArray, n: OEDoubleArray, ang: float,
                            len: float) -> None

   Calculates cartesian coordinate point ``dst`` that has a distance of ``len`` from the
   point ``center``, and the vector :math:`(dst-center)` forms an angle of ``ang`` radians
   with the vector :math:`(r1-center)`.  The  second form places it on (or to the closest
   possible to) the plane defined by the normal ``n``.  The first form chooses 
   the normal to be either the ``x`` or the ``y`` coordinate based on the proximity of
   :math:`(r1-center)` to these axes.


.. # split from OEMathFunctions.rst:222

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DCopy

.. oe:function:: OEGeom3DCopy

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom3DCopy(T* x, const T* p)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DCopy(x: OEFloatArray, p: OEFloatArray) -> None
         OEGeom3DCopy(x: OEDoubleArray, p: OEDoubleArray) -> None

   Three dimensional vector assignment. The vector 'x' is assigned the
   value of 'p'.

   *x*
      Output two dimensional array.

   *p*
      Input two dimensional array.



.. # split from OEMathFunctions.rst:232

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DCrossProd

.. oe:function:: OEGeom3DCrossProd

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom3DCrossProd(T* x, const T* p, const T* q, const T* r)
         template<class T, class U, class V>
         void OEGeom3DCrossProd(T* x, const U* p, const V* q)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DCrossProd(x: OEFloatArray, p: OEFloatArray, q: OEFloatArray,
                           r: OEFloatArray) -> None
         OEGeom3DCrossProd(x: OEDoubleArray, p: OEDoubleArray,
                           q: OEDoubleArray, r: OEDoubleArray) -> None
         OEGeom3DCrossProd(x: OEFloatArray, p: OEFloatArray, q: OEFloatArray) -> None
         OEGeom3DCrossProd(x: OEDoubleArray, p: OEDoubleArray, q: OEDoubleArray) -> None

   Calculates the cross product of the two three element vectors ``p`` and
   ``q``. The first form computes :math:`x = (p-q)*(r-q)` and
   the second form computes :math:`x = p * q`.


.. # split from OEMathFunctions.rst:242

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DDistance

.. oe:function:: OEGeom3DDistance

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         double OEGeom3DDistance(const T* p, const U* q)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DDistance(p: OEFloatArray, q: OEFloatArray) -> float
         OEGeom3DDistance(p: OEFloatArray, q: OEDoubleArray) -> float
         OEGeom3DDistance(p: OEDoubleArray, q: OEFloatArray) -> float
         OEGeom3DDistance(p: OEDoubleArray, q: OEDoubleArray) -> float

   Returns the Euclidean distance between the two cartesian points,
   ``p`` and ``q``. 



.. # split from OEMathFunctions.rst:252

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DDistance2

.. oe:function:: OEGeom3DDistance2

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         double OEGeom3DDistance2(const T* p, const U* q)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DDistance2(p: OEFloatArray, q: OEFloatArray) -> float
         OEGeom3DDistance2(p: OEFloatArray, q: OEDoubleArray) -> float
         OEGeom3DDistance2(p: OEDoubleArray, q: OEFloatArray) -> float
         OEGeom3DDistance2(p: OEDoubleArray, q: OEDoubleArray) -> float

   Returns the square of the Euclidean distance between the two
   cartesian points, ``p`` and ``q``. When it is possible to use 
   the square of the distance, this is more efficient than 
   using :oe:func:`OEMath::OEGeom3DDistance`.



.. # split from OEMathFunctions.rst:263

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DDotProd

.. oe:function:: OEGeom3DDotProd

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         double OEGeom3DDotProd(const T* p, const U* q)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DDotProd(p: OEFloatArray, q: OEFloatArray) -> float
         OEGeom3DDotProd(p: OEDoubleArray, q: OEDoubleArray) -> float

   Returns the dot product of the two given three element vectors ``p`` and
   ``q``.



.. # split from OEMathFunctions.rst:273

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DEulerRotate

.. oe:function:: OEGeom3DEulerRotate

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom3DEulerRotate(T* xyz, const U* angles, unsigned int ncoord)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DEulerRotate(xyz: OEFloatArray, angles: OEDoubleArray,
                             ncoord: int) -> None
         OEGeom3DEulerRotate(xyz: OEDoubleArray, angles: OEDoubleArray,
                             ncoord: int) -> None

   Rotates the coordinates ``xyz`` by using the three Eulerian angles
   given by ``angles``. The number of coordinates in ``xyz`` is given by ``ncoord``. 



.. # split from OEMathFunctions.rst:283

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DEulerToQuaternion

.. oe:function:: OEGeom3DEulerToQuaternion

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom3DEulerToQuaternion(T* quat, const U* angles)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DEulerToQuaternion(quat: OEDoubleArray, angles: OEDoubleArray) -> None

   Constructs the four element quaternion ``quat`` for the rotation given by
   the three Euler angles ``angles``. 



.. # split from OEMathFunctions.rst:293

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DEulerToRotMatrix

.. oe:function:: OEGeom3DEulerToRotMatrix

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom3DEulerToRotMatrix(T* RMat, const double* angles)
         template<class T>
         void OEGeom3DEulerToRotMatrix(T* RMat, const double phi,
                                       const double theta, const double psi)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DEulerToRotMatrix(RMat: OEDoubleArray, angles: OEDoubleArray) -> None

   Constructs a :math:`3x3` rotation matrix ``RMat`` from the given Euler angles. 



.. # split from OEMathFunctions.rst:306

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DGetCenterAndExtents

.. oe:function:: OEGeom3DGetCenterAndExtents

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom3DGetCenterAndExtents(const T* xyz, unsigned int ncoord,
                                          U* center, U* extents)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DGetCenterAndExtents(xyz: OEFloatArray, ncoord: int,
                                     center: OEFloatArray,
                                     extents: OEFloatArray) -> None
         OEGeom3DGetCenterAndExtents(xyz: OEDoubleArray, ncoord: int,
                                     center: OEDoubleArray,
                                     extents: OEDoubleArray) -> None

   Determines the bounding box that can encompass all the points
   defined by ``xyz`` and ``ncoord``. The length of each side of the
   box output in the 3-element array ``extents``. The geometric center
   of the box is output to the ``center`` parameter.

   .. note::

      The center of the box is different from the center-of-mass.



.. # split from OEMathFunctions.rst:323

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DGetCenterOfMass

.. oe:function:: OEGeom3DGetCenterOfMass

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom3DGetCenterOfMass(const T* xyz, unsigned int ncoord, U* com)
         template<class T, class U, class Z>
         void OEGeom3DGetCenterOfMass(const T* xyz, unsigned int ncoord,
                                      U* com, Z* weights)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DGetCenterOfMass(xyz: OEFloatArray, ncoord: int,
                                 com: OEFloatArray) -> None
         OEGeom3DGetCenterOfMass(xyz: OEDoubleArray, ncoord: int,
                                 com: OEDoubleArray) -> None
         OEGeom3DGetCenterOfMass(xyz: OEFloatArray, ncoord: int,
                                 com: OEFloatArray, weights: OEFloatArray) -> None
         OEGeom3DGetCenterOfMass(xyz: OEDoubleArray, ncoord: int,
                                 com: OEDoubleArray, weights: OEDoubleArray) -> None

   Calculates the center-of-mass for the coordinates given by ``xyz``
   and places the cartesian center-of-mass in the output ``com``
   argument. The number of 3-element cartesian coordinates is
   specified by the ``ncoord`` parameter. Note, ``weights`` can be
   specified to weight each of the cartesian points differently.



.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DMagnitude

.. oe:function:: OEGeom3DMagnitude

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         double OEGeom3DMagnitude(T* x)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DMagnitude(x: OEFloatArray) -> float
         OEGeom3DMagnitude(x: OEDoubleArray) -> float

   Returns the length of the 3-element vector ``x``. 


.. # split from OEMathFunctions.rst:350

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DMakeQuaternion

.. oe:function:: OEGeom3DMakeQuaternion

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U, class V>
         void OEGeom3DMakeQuaternion(T* quat, const U* vec, const V angle)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DMakeQuaternion(quat: OEDoubleArray, vec: OEDoubleArray,
                                angle: float) -> None

   Construct a 4-element quaternion pointed to by ``quat`` from the
   3-element vector ``vec`` and the angle ``angle``. This quaternion
   represents a 3D rotation around the axis of ``vec`` by the angle
   ``angle``.

   .. warning:: 

      Translation is not taken into account by this function. 



.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DMatrixIdentity

.. oe:function:: OEGeom3DMatrixIdentity

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom3DMatrixIdentity(T* rmat)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DMatrixIdentity(rmat: OEDoubleArray) -> None

   Initializes the :math:`3x3` matrix ``rmat`` to be an identity
   matrix: diagonal terms are ``1.0``; off-diagonal terms are ``0.0``. 


.. # split from OEMathFunctions.rst:377

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DMatrixInvert

.. oe:function:: OEGeom3DMatrixInvert

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         bool OEGeom3DMatrixInvert(T* mi, const U* m)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DMatrixInvert(mi: OEDoubleArray, m: OEDoubleArray) -> bool

   Calculates the inverse of the matrix ``m`` and stores the result in
   ``mi``. By definition, multiplying ``m`` times ``mi`` will return
   the identity matrix.

   .. note:: 

      Rotation matrices are `orthogonal
      matrices <http://en.wikipedia.org/wiki/Orthogonal_matrix>`_ that
      can be inverted much more cheaply by using
      :oe:func:`OEMath::OEGeom3DMatrixTranspose` instead.



.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DMatrixMultiply

.. oe:function:: OEGeom3DMatrixMultiply

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom3DMatrixMultiply(T* accumulator, const U* add)
         template<class T, class U, class V>
         void OEGeom3DMatrixMultiply(T* Product, const U* init, const V* add)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DMatrixMultiply(accumulator: OEDoubleArray, add: OEDoubleArray) -> None
         OEGeom3DMatrixMultiply(Product: OEDoubleArray, init: OEDoubleArray,
                                add: OEDoubleArray) -> None

   Performs :math:`3x3` matrix multiplication. The first form computes
   :math:`accumulator *= add`, and the second form computes 
   :math:`Product = init * add`. All of the inputs are nine element 
   :math:`3x3` matrices.


.. # split from OEMathFunctions.rst:411

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DMatrixTranspose

.. oe:function:: OEGeom3DMatrixTranspose

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom3DMatrixTranspose(T* mat)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DMatrixTranspose(mat: OEDoubleArray) -> None

   Transposes the elements of the :math:`3x3` matrix ``mat``, that is, the
   elements are swapped along the diagonal.



.. # split from OEMathFunctions.rst:423

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DNormalize

.. oe:function:: OEGeom3DNormalize

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom3DNormalize(T* x)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DNormalize(x: OEFloatArray) -> None
         OEGeom3DNormalize(x: OEDoubleArray) -> None

   Normalizes the 3-element vector ``x`` so that the length
   (magnitude) of the vector ``x`` will be equal to ``1.0``. 



.. # split from OEMathFunctions.rst:423

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DNormalizeQuaternion

.. oe:function:: OEGeom3DNormalizeQuaternion

   .. oe:api::

      template<class T>
      void OEGeom3DNormalizeQuaternion(T* quaternion)

   Normalizes the four dimensional vector ``quaternion`` so that it
   has a magnitude of ``1.0``. 



.. # split from OEMathFunctions.rst:434

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DPlanarCoord

.. oe:function:: OEGeom3DPlanarCoord

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom3DPlanarCoord(T* dst, const T* center, const T* r1,
                                  const T* r2, T len)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DPlanarCoord(dst: OEFloatArray, center: OEFloatArray,
                             r1: OEFloatArray, r2: OEFloatArray, len: float) -> None
         OEGeom3DPlanarCoord(dst: OEDoubleArray, center: OEDoubleArray,
                             r1: OEDoubleArray, r2: OEDoubleArray, len: float) -> None

   Calculates cartesian coordinate point ``dst`` that has a distance of ``len`` from the
   point ``center``, placed on the plane defined by the vectors :math:`(center-r1)`
   and :math:`(center-r2)` and on the line bisecting these two vectors.


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DQuaternionIdentity

.. oe:function:: OEGeom3DQuaternionIdentity

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom3DQuaternionIdentity(T* quat)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DQuaternionIdentity(quat: OEDoubleArray) -> None

   Initializes the four element quaternion ``quat`` to be an identity
   quaternion: real component is ``1.0`` and imaginary components are ``0.0``. 


.. # split from OEMathFunctions.rst:442

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DQuaternionInvert

.. oe:function:: OEGeom3DQuaternionInvert

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom3DQuaternionInvert(T* iquat, const U* quat)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DQuaternionInvert(iquat: OEDoubleArray, quat: OEDoubleArray) -> None

   Calculates the inverse ``iquat`` of the given four element quaternion ``quat``.
   The inverse is also a four element quaternion. 



.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeomQuaternionMultiply

.. oe:function:: OEGeomQuaternionMultiply

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U, class V>
         void OEGeomQuaternionMultiply(T* Product, const U* qLhs, const V* qRhs)

   .. oe:language:: python

      .. oe:api:: python

         OEGeomQuaternionMultiply(Product: OEDoubleArray, qLhs: OEDoubleArray,
                                  qRhs: OEDoubleArray) -> None

   Calculates the product of multiplication of two quaternions,
   :math:`Product = qLhs * qRhs`.


.. # split from OEMathFunctions.rst:450

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DQuaternionRotate

.. oe:function:: OEGeom3DQuaternionRotate

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom3DQuaternionRotate(T* xyz, const U* quat,
                                       unsigned int ncoord)
         template<class T, class U>
         void OEGeom3DQuaternionRotate(T* xyz, const U* quat,
                                       unsigned int* idx, unsigned int ncoord)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DQuaternionRotate(xyz: OEFloatArray, quat: OEDoubleArray,
                                  ncoord: int) -> None
         OEGeom3DQuaternionRotate(xyz: OEDoubleArray, quat: OEDoubleArray,
                                  ncoord: int) -> None
         OEGeom3DQuaternionRotate(xyz: OEFloatArray, quat: OEDoubleArray,
                                  idx: int, ncoord: int) -> None
         OEGeom3DQuaternionRotate(xyz: OEDoubleArray, quat: OEDoubleArray,
                                  idx: int, ncoord: int) -> None

   Rotates the coordinates of ``xyz`` using the quaternion
   given by ``quat``. The second form only rotates the coordinates
   according to the indices given by ``idx``. 
 
   *xyz*
      Array of coordinates to rotate

   *quat*
      quaternion for rotation

   *ncoord*
      Number of coordinate sets to rotate

   *idx*
      Indices of the coordinates to rotate



.. # split from OEMathFunctions.rst:461

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DQuaternionToRotMatrix

.. oe:function:: OEGeom3DQuaternionToRotMatrix

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom3DQuaternionToRotMatrix(T* RMat, const U* quat)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DQuaternionToRotMatrix(RMat: OEDoubleArray, quat: OEDoubleArray) -> None

   Constructs a :math:`3x3` rotation matrix ``RMat`` from the given four element quaternion ``quat``.



.. # split from OEMathFunctions.rst:482

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DReflect

.. oe:function:: OEGeom3DReflect

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom3DReflect(T* xyz, unsigned int axis_to_reflect_around,
                              unsigned int ncoord)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DReflect(xyz: OEFloatArray, axis_to_reflect_around: int,
                         ncoord: int) -> None
         OEGeom3DReflect(xyz: OEDoubleArray, axis_to_reflect_around: int,
                         ncoord: int) -> None

   Reflects the coordinates of ``xyz`` around the axis given by
   ``axis_to_reflect_around``. ``axis_to_reflect_around`` should be
   either 0, 1, or 2 for the X, Y, and Z axis respectively. 

   *xyz*
      Array of coordinates to reflect

   *axis_to_reflect_around*
      The axis to reflect around

   *ncoord*
      Number of coordinate sets to reflect



.. # split from OEMathFunctions.rst:482

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DReflectCoord

.. oe:function:: OEGeom3DReflectCoord

   .. oe:api::

      template<class T>
      void OEGeom3DReflectCoord(T* dst, const T* center, const T* r1,
                                const T* r2, const T* rHyd)

   This is a template function that takes T* coordinates of a
   central atom (``center``) and two r-group atoms (``r1`` and
   ``r2``), and performs a reflection around the center-r1-r2 plane
   for the hydrogen atom (``rHyd``). The output coordinates are
   returned within the ``dst`` variable.


.. # split from OEMathFunctions.rst:469

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DRotVectorToTransform

.. oe:function:: OEGeom3DRotVectorToTransform

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U, class V>
         bool OEGeom3DRotVectorToTransform(T* m, T* tran, const U* p1,
                                           const U* p2, const V theta)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DRotVectorToTransform(m: OEDoubleArray, tran: OEDoubleArray,
                                      p1: OEFloatArray, p2: OEFloatArray,
                                      theta: float) -> bool
         OEGeom3DRotVectorToTransform(m: OEDoubleArray, tran: OEDoubleArray,
                                      p1: OEDoubleArray, p2: OEDoubleArray,
                                      theta: float) -> bool

   Return the 3x3 rotation matrix ``m`` and 3 element translation
   ``tran`` for the transformation needed to rotate cartesian
   coordinates by ``theta`` around the vector formed by the points
   ``p1`` and ``p2``.



.. # split from OEMathFunctions.rst:495

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DRotate

.. oe:function:: OEGeom3DRotate

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom3DRotate(T* xyz, const U* m, unsigned int ncoord)
         template<class T, class U>
         void OEGeom3DRotate(T* xyz, const U* m, unsigned int* idx,
                             unsigned int ncoord)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DRotate(xyz: OEFloatArray, m: OEDoubleArray, ncoord: int) -> None
         OEGeom3DRotate(xyz: OEDoubleArray, m: OEDoubleArray, ncoord: int) -> None
         OEGeom3DRotate(xyz: OEFloatArray, m: OEDoubleArray, idx: int,
                        ncoord: int) -> None
         OEGeom3DRotate(xyz: OEDoubleArray, m: OEDoubleArray, idx: int,
                        ncoord: int) -> None

   Rotates the coordinates of ``xyz`` using the :math:`3x3` rotation matrix
   given by ``m``. The second form only rotates the coordinates
   according to the indices given by ``idx``. 
 
   *xyz*
      Array of coordinates to rotate

   *r*
      rotation matrix

   *ncoord*
      Number of coordinate sets to rotate

   *idx*
      Indices of the coordinates to rotate


.. # split from OEMathFunctions.rst:508

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DScale

.. oe:function:: OEGeom3DScale

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom3DScale(T* x, const T p)
         template<class T>
         void OEGeom3DScale(T* x, const T p, const T* q)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DScale(x: OEFloatArray, p: float) -> None
         OEGeom3DScale(x: OEDoubleArray, p: float) -> None
         OEGeom3DScale(x: OEFloatArray, p: float, q: OEFloatArray) -> None
         OEGeom3DScale(x: OEDoubleArray, p: float, q: OEDoubleArray) -> None

   Three dimensional vector scaling. The first form computes :math:`x *= p` and
   the second form computes :math:`x = p * q`.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DSetLength

.. oe:function:: OEGeom3DSetLength

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom3DSetLength(T* x, T len)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DSetLength(x: OEFloatArray, len: float) -> None
         OEGeom3DSetLength(x: OEDoubleArray, len: float) -> None

   Sets the length (magnitude) of the three-element vector ``x`` to
   the specified value ``len``.


.. # split from OEMathFunctions.rst:526

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DSubtract

.. oe:function:: OEGeom3DSubtract

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom3DSubtract(T* x, const U* p)
         template<class T>
         void OEGeom3DSubtract(T* x, const T* p, const T* q)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DSubtract(x: OEFloatArray, p: OEFloatArray) -> None
         OEGeom3DSubtract(x: OEDoubleArray, p: OEDoubleArray) -> None
         OEGeom3DSubtract(x: OEFloatArray, p: OEFloatArray, q: OEFloatArray) -> None
         OEGeom3DSubtract(x: OEDoubleArray, p: OEDoubleArray, q: OEDoubleArray) -> None

   Three dimensional vector subtraction. The first form computes :math:`x-=p` and
   the second form computes :math:`x = p - q`.


.. # split from OEMathFunctions.rst:536

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DTetraCoord

.. oe:function:: OEGeom3DTetraCoord

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeom3DTetraCoord(T* dst, const T* center, const T* r1,
                                 const T* r2, T len)
         template<class T>
         void OEGeom3DTetraCoord(T* dst, const T* center, const T* r1,
                                 const T* r2, const T* r3, T len)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DTetraCoord(dst: OEFloatArray, center: OEFloatArray,
                            r1: OEFloatArray, r2: OEFloatArray, len: float) -> None
         OEGeom3DTetraCoord(dst: OEDoubleArray, center: OEDoubleArray,
                            r1: OEDoubleArray, r2: OEDoubleArray, len: float) -> None
         OEGeom3DTetraCoord(dst: OEFloatArray, center: OEFloatArray,
                            r1: OEFloatArray, r2: OEFloatArray,
                            r3: OEFloatArray, len: float) -> None
         OEGeom3DTetraCoord(dst: OEDoubleArray, center: OEDoubleArray,
                            r1: OEDoubleArray, r2: OEDoubleArray,
                            r3: OEDoubleArray, len: float) -> None

   Calculates cartesian coordinate point ``dst`` that has a distance of ``len`` from the
   point ``center``, and corresponds to a tetrahedral atom location with respect to the
   given coordinates.  The first form places the new coordinates at the known tetrahedral
   angle based on the bisecting vector between :math:`(r1-center)` and :math:`(r2-center)`.  
   The second form places it on the direction perpendicular to the plane of the three given
   coordinates ``r1``, ``r2``, and ``r3``.


.. # split from OEMathFunctions.rst:547

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DTorsion

.. oe:function:: OEGeom3DTorsion

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         double OEGeom3DTorsion(const T* p, const T* q, const T* r, const T* s)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DTorsion(p: OEFloatArray, q: OEFloatArray, r: OEFloatArray,
                         s: OEFloatArray) -> float
         OEGeom3DTorsion(p: OEDoubleArray, q: OEDoubleArray, r: OEDoubleArray,
                         s: OEDoubleArray) -> float

   Determines the torsional angle in three dimensions between 
   cartesian coordinate points ``p``, ``q``, ``r``, and ``s``. 
   The result is in radians.


.. # split from OEMathFunctions.rst:555

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DTranslate

.. oe:function:: OEGeom3DTranslate

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom3DTranslate(T* xyz, const U* t, unsigned int ncoord)
         template<class T, class U>
         void OEGeom3DTranslate(T* xyz, const U* t, unsigned int* idx,
                                unsigned int ncoord)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DTranslate(xyz: OEFloatArray, t: OEDoubleArray, ncoord: int) -> None
         OEGeom3DTranslate(xyz: OEDoubleArray, t: OEDoubleArray, ncoord: int) -> None
         OEGeom3DTranslate(xyz: OEFloatArray, t: OEDoubleArray, idx: int,
                           ncoord: int) -> None
         OEGeom3DTranslate(xyz: OEDoubleArray, t: OEDoubleArray, idx: int,
                           ncoord: int) -> None

   Translates the three dimensional coordinates by the vector passed as the 
   argument ``t``.  The vector ``t`` must be of size three and contain the Cartesian
   translation vector.  For ``ncoord`` sets of coordinates the input array ``xyz``
   is expected to have at least a length of :math:`3*ncoord`.  The second form only 
   translates the coordinates according to the indices given by ``idx``.

   *xyz*
      Array of coordinates to translate

   *t*
      Translation vector array

   *ncoord*
      Number of coordinate sets to translate

   *idx*
      Index of the coordinates to translate


.. # split from OEMathFunctions.rst:566

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DUnitQuaternionRotate

.. oe:function:: OEGeom3DUnitQuaternionRotate

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U>
         void OEGeom3DUnitQuaternionRotate(T* xyz, const U* quat,
                                           unsigned int ncoord)
         template<class T, class U>
         void OEGeom3DUnitQuaternionRotate(T* xyz, const U* quat,
                                           unsigned int* idx,
                                           unsigned int ncoord)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DUnitQuaternionRotate(xyz: OEFloatArray, quat: OEDoubleArray,
                                      ncoord: int) -> None
         OEGeom3DUnitQuaternionRotate(xyz: OEDoubleArray, quat: OEDoubleArray,
                                      ncoord: int) -> None
         OEGeom3DUnitQuaternionRotate(xyz: OEFloatArray, quat: OEDoubleArray,
                                      idx: int, ncoord: int) -> None
         OEGeom3DUnitQuaternionRotate(xyz: OEDoubleArray, quat: OEDoubleArray,
                                      idx: int, ncoord: int) -> None

   Rotates the coordinates of ``xyz`` using the unit-quaternion
   given by ``quat``. The second form only rotates the coordinates
   according to the indices given by ``idx``. When it is known that
   the input quaternion is a unit quaternion, this is more
   efficient than using :oe:func:`OEMath::OEGeom3DQuaternionRotate`.
 
   *xyz*
      Array of coordinates to rotate

   *quat*
      unit-quaternion for rotation

   *ncoord*
      Number of coordinate sets to rotate

   *idx*
      Indices of the coordinates to rotate

   .. warning:: 

      Calling this functions when the input quaternion is not
      a unit quaternion could led to unexpected results.


.. # split from OEMathFunctions.rst:577

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeom3DVolume

.. oe:function:: OEGeom3DVolume

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         double OEGeom3DVolume(const T* p, const T* q, const T* r, const T* s)

   .. oe:language:: python

      .. oe:api:: python

         OEGeom3DVolume(p: OEFloatArray, q: OEFloatArray, r: OEFloatArray,
                        s: OEFloatArray) -> float
         OEGeom3DVolume(p: OEDoubleArray, q: OEDoubleArray, r: OEDoubleArray,
                        s: OEDoubleArray) -> float



.. # split from OEMathFunctions.rst:585

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeomDotProd

.. oe:function:: OEGeomDotProd

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         double OEGeomDotProd(const T* p, const T* q, unsigned int n)

   .. oe:language:: python

      .. oe:api:: python

         OEGeomDotProd(p: OEFloatArray, q: OEFloatArray, arg3: int) -> float
         OEGeomDotProd(p: OEDoubleArray, q: OEDoubleArray, arg3: int) -> float

   Returns the dot-product between the two ``n`` dimensional
   vectors ``p`` and ``q``.



.. # split from OEMathFunctions.rst:593

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEGeomNormalizeQuaternion

.. oe:function:: OEGeomNormalizeQuaternion

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         void OEGeomNormalizeQuaternion(T* quaternion)

   .. oe:language:: python

      .. oe:api:: python

         OEGeomNormalizeQuaternion(quaternion: OEDoubleArray) -> None



.. meta::
   :keywords: OEGeomQuaternionMultiply

.. oe:namespace:: OEMath

.. oe:function:: OEGeomQuaternionMultiply

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T, class U, class V>
         void OEGeomQuaternionMultiply(T* Product, const U* qLhs, const V* qRhs)

   .. oe:language:: python

      .. oe:api:: python

         OEGeomQuaternionMultiply(Product: OEDoubleArray, qLhs: OEDoubleArray,
                                  qRhs: OEDoubleArray) -> None


.. oe:namespace:: OEMath

.. meta::
   :keywords: OEInBox

.. oe:function:: OEInBox

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEInBox(const OEBox& box, const float x, const float y,
                      const float z)

   .. oe:language:: python

      .. oe:api:: python

         OEInBox(box: OEBox, x: float, y: float, z: float) -> bool

   Returns true if (*x* , *y*, *z*) is within *box*.

   Coordinates that lie on an edge of *box* are considered to be in *box*.



.. oe:namespace:: OEMath

.. meta::
   :keywords: OEInSphere

.. oe:function:: OEInSphere

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEInSphere(const OESphere& sph, const float x, const float y,
                         const float z)

   .. oe:language:: python

      .. oe:api:: python

         OEInSphere(sphere: OESphere, x: float, y: float, z: float) -> bool

   Returns true if (*x* , *y*, *z*) is within the sphere *sph*.

   Coordinates that lie on an edge of *sph* are considered to be in *sph*.


.. oe:namespace:: OEMath

.. meta::
   :keywords: OESetupBox

.. oe:function:: OESetupBox

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupBox(OEBox& box, const float* xyz, const unsigned N,
                         const bool addbox = 0.0f)

   .. oe:language:: python

      .. oe:api:: python

         OESetupBox(arg1: OEBox, xyz: OEFloatArray, numPoints: int,
                    addbox: float = 0.0) -> bool

   Sets up *box* to contain the minimum size box that encloses all coordinates in
   the *xyz* array and then extends each box face by *addbox*.

      *box*
         Box to setup

      *xyz*
         Array of coordinates

      *N*
         Number of coordinates in *xyz* array

      *addbox*
         Optional parameter to extend each box face by a specified amount relative
         to the minimum box enclosing the *xyz* coordinates.

   Returns true if setup was successful.




.. oe:namespace:: OEMath

.. meta::
   :keywords: OESetupBoxCenterAndExtents

.. oe:function:: OESetupBoxCenterAndExtents

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupBoxCenterAndExtents(OEBox& box, const float* center,
                                         const float* extents)

   .. oe:language:: python

      .. oe:api:: python

         OESetupBoxCenterAndExtents(arg1: OEBox, center: OEFloatArray,
                                    extents: OEFloatArray) -> bool

   Sets up *box* using a center coordinate and the dimension of the box.

      *box*
         Box to setup

      *center*
         A length 3 array holds the coordinate of the box center 

      *extends*
         A length 3 array holding the x, y and z dimensions of the box.

   Returns true if setup was successful.



.. oe:namespace:: OEMath

.. meta::
   :keywords: OESphereArea

.. oe:function:: OESphereArea

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OESphereArea(const OESphere& sph)

   .. oe:language:: python

      .. oe:api:: python

         OESphereArea(sphere: OESphere) -> float

   Calculates the area of the sphere

.. oe:namespace:: OEMath

.. meta::
   :keywords: OESphereVolume

.. oe:function:: OESphereVolume

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OESphereVolume(const OESphere& sph)

   .. oe:language:: python

      .. oe:api:: python

         OESphereVolume(sphere: OESphere) -> float

   Calculate the volume of the sphere.


.. _chapter_math_functions:

*******************************************************************************
OEMath Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEBoxArea.rst
   OEBoxExtend.rst
   OEBoxTranslate.rst
   OEBoxVolume.rst
   OEBoxXDim.rst
   OEBoxXMid.rst
   OEBoxYDim.rst
   OEBoxYMid.rst
   OEBoxZDim.rst
   OEBoxZMid.rst
   OECenter.rst
   OEGeom2DAdd.rst
   OEGeom2DAngle.rst
   OEGeom2DCopy.rst
   OEGeom2DDistance.rst
   OEGeom2DDistance2.rst
   OEGeom2DDotProd.rst
   OEGeom2DMagnitude.rst
   OEGeom2DMidpoint.rst
   OEGeom2DNormalize.rst
   OEGeom2DRotate.rst
   OEGeom2DScale.rst
   OEGeom2DSetLength.rst
   OEGeom2DSubtract.rst
   OEGeom2DTranslate.rst
   OEGeom3DAbsTorsion.rst
   OEGeom3DAdd.rst
   OEGeom3DAllZero.rst
   OEGeom3DAngle.rst
   OEGeom3DAngleCoord.rst
   OEGeom3DCopy.rst
   OEGeom3DCrossProd.rst
   OEGeom3DDistance.rst
   OEGeom3DDistance2.rst
   OEGeom3DDotProd.rst
   OEGeom3DEulerRotate.rst
   OEGeom3DEulerToQuaternion.rst
   OEGeom3DEulerToRotMatrix.rst
   OEGeom3DGetCenterAndExtents.rst
   OEGeom3DGetCenterOfMass.rst
   OEGeom3DMagnitude.rst
   OEGeom3DMakeQuaternion.rst
   OEGeom3DMatrixIdentity.rst
   OEGeom3DMatrixInvert.rst
   OEGeom3DMatrixMultiply.rst
   OEGeom3DMatrixTranspose.rst
   OEGeom3DNormalize.rst
   OEGeom3DNormalizeQuaternion.rst
   OEGeom3DPlanarCoord.rst
   OEGeom3DQuaternionIdentity.rst
   OEGeom3DQuaternionInvert.rst
   OEGeom3DQuaternionMultiply.rst
   OEGeom3DQuaternionRotate.rst
   OEGeom3DQuaternionToRotMatrix.rst
   OEGeom3DReflect.rst
   OEGeom3DReflectCoord.rst
   OEGeom3DRotVectorToTransform.rst
   OEGeom3DRotate.rst
   OEGeom3DScale.rst
   OEGeom3DSetLength.rst
   OEGeom3DSubtract.rst
   OEGeom3DTetraCoord.rst
   OEGeom3DTorsion.rst
   OEGeom3DTranslate.rst
   OEGeom3DUnitQuaternionRotate.rst
   OEGeom3DVolume.rst
   OEGeomDotProd.rst
   OEGeomNormalizeQuaternion.rst
   OEGeomQuaternionMultiply.rst
   OEInBox.rst
   OEInSphere.rst
   OESetupBox.rst
   OESetupBoxCenterAandExtents.rst
   OESphereArea.rst
   OESphereVolume.rst



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OECondition, Condition

.. _OEPlatform_OECondition:

.. oe:class:: OECondition

   .. oe:api::

      class OECondition

   This class represents `OECondition`.

   
   .. oe:method:: Constructors

      .. oe:api::

         OECondition()

      Default and copy constructors.

   .. oe:method:: Acquire

      .. oe:api::

         void Acquire()

   .. oe:method:: Broadcast

      .. oe:api::

         void Broadcast()

   .. oe:method:: Release

      .. oe:api::

         void Release()

   .. oe:method:: Signal

      .. oe:api::

         void Signal()

   .. oe:method:: Wait

      .. oe:api::

         void Wait()



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEDirectoryScan, DirectoryScan

.. _OEPlatform_OEDirectoryScan:

.. oe:class:: OEDirectoryScan

   .. oe:api::

      class OEDirectoryScan

   This class represents `OEDirectoryScan`.

   The :ref:`OEDirectoryScan <OEPlatform_OEDirectoryScan>` class provides a portable
   way of retrieving the
   names of all the files and subdirectories in a given directory.

   .. oe:method:: Constructors

      .. oe:api::

         OEDirectoryScan(const char* dname)

      The constructor for :ref:`OEDirectoryScan <OEPlatform_OEDirectoryScan>` specifies the
      name of the directory to scan. A NULL pointer, ``(char*)0``, is taken 
      to mean the
      current directory and is equivalent to ``"."``.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Checks whether the :ref:`OEDirectoryScan <OEPlatform_OEDirectoryScan>` has been
      successfully opened and is still valid. A
      return value of ``true`` does not guarantee that the next call to the
      Next method will not return ``(const char*)0``.

   .. oe:method:: Close

      .. oe:api::

         void Close()

      Closes the :ref:`OEDirectoryScan <OEPlatform_OEDirectoryScan>` and frees any system
      resources. This method is invoked automatically by the classes'
      destructor. Following a call to Close, operator bool will always
      return ``false``.

   .. oe:method:: Next

      .. oe:api::

         const char *Next()

      Returns the next file name sequentially in the directory scan. This
      function automatically advances the directory pointer. The returned
      value is a pointer to the local filename, *i.e.* without its
      directory prefix. Upon reaching the end of the directory, this
      function returns ``(const char*)0``, and the 
      :ref:`OEDirectoryScan <OEPlatform_OEDirectoryScan>` is closed.


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFile, File

.. _OEPlatform_OEFile:

.. oe:class:: OEFile

   .. oe:api::

      class OEFile

   This class represents `OEFile`.

   
   .. oe:method:: Constructors

      .. oe:api::

         OEFile(const OEFile &)
         OEFile(const std::string &="")
         OEFile(const std::string &, const std::string &)

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFile& operator=(const OEFile &)

      Assignment operator.

   .. oe:method:: AbsPath

      .. oe:api::

         std::string AbsPath() const

   .. oe:method:: DirContents

      .. oe:api::

         std::vector<std::string> DirContents() const

   .. oe:method:: DirPath

      .. oe:api::

         std::string DirPath() const

   .. oe:method:: Exists

      .. oe:api::

         bool Exists() const

   .. oe:method:: FileName

      .. oe:api::

         std::string FileName() const

   .. oe:method:: IsDirectory

      .. oe:api::

         bool IsDirectory() const

   .. oe:method:: IsExecutable

      .. oe:api::

         bool IsExecutable() const

   .. oe:method:: IsFile

      .. oe:api::

         bool IsFile() const

   .. oe:method:: IsLink

      .. oe:api::

         bool IsLink() const

   .. oe:method:: IsReadable

      .. oe:api::

         bool IsReadable() const

   .. oe:method:: IsWritable

      .. oe:api::

         bool IsWritable() const

   .. oe:method:: Refresh

      .. oe:api::

         bool Refresh()

   .. oe:method:: Set

      .. oe:api::

         bool Set(const std::string &)
         bool Set(const std::string &, const std::string &)

   .. oe:method:: Size

      .. oe:api::

         oesize_t Size() const



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEHalfFloat, HalfFloat

.. _OEPlatform_OEHalfFloat:

.. oe:class:: OEHalfFloat

   .. oe:api::

      struct OEHalfFloat

   This class can be used to store a 32-bit float as a 16-bit float as
   defined by the ``IEEE 754-2008`` standard. Useful for reducing
   memory consumption when most of the data is 32-bit floating point
   values as the expense of precision.

   .. note:: 

      This is a "storage only" class, all math should still be done as
      float or double and then converted to 16 bits for storage.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHalfFloat()
            OEHalfFloat(double)
            OEHalfFloat(float)
            OEHalfFloat(long double)
            OEHalfFloat(oe_half data)

      .. oe:language:: python

         .. oe:api:: python

            OEHalfFloat() -> OEHalfFloat
            OEHalfFloat(data: oe_half) -> OEHalfFloat
            OEHalfFloat(data: int) -> OEHalfFloat
            OEHalfFloat(arg2: float) -> OEHalfFloat
            OEHalfFloat(float: int) -> OEHalfFloat

      Default constructors initializes to the value of
      ``0.0``. Otherwise convert the value from ``float``, ``double``,
      or ``long double`` and construct with that.

   .. oe:method:: operator double
      :language: c++

      .. oe:api::

         operator double() const

      Retrieve the value as a 64-bit ``double``. 

   .. oe:method:: operator float
      :language: c++ java

      .. oe:api::

         operator float() const

      Retrieve the value as a 32-bit ``float``. 

   .. oe:method:: operator long double
      :language: c++ java

      .. oe:api::

         operator long double() const

      Retrieve the value as the platform dependent ``long double``. 

   .. oe:method:: GetValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetValue() const

      .. oe:language:: python

         .. oe:api:: python

            GetValue() -> float

      Retrieve the value as a 32-bit float. 



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OELock, Lock

.. _OEPlatform_OELock:

.. oe:class:: OELock

   .. oe:api::

      class OELock

   This class can be used to ensure an
   :ref:`OEMutex <OEPlatform_OEMutex>` object is properly released when
   this object falls out of scope.

   .. code-block:: c++

      OELock  = std::lock_guard<OEMutex>;

   .. seealso::

      * :ref:`OEMutex <OEPlatform_OEMutex>` class
      * `std::lock_guard <https://en.cppreference.com/w/cpp/thread/lock_guard>`_


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OELockCondition, LockCondition

.. _OEPlatform_OELockCondition:

.. oe:class:: OELockCondition

   .. oe:api::

      class OELockCondition

   This class can be used to ensure an
   :ref:`OECondition <OEPlatform_OECondition>` object is properly released when
   this object falls out of scope.

   .. warning::

      This may not prevent deadlocks as
      :oe:meth:`OEPlatform::OECondition::Signal` or
      :oe:meth:`OEPlatform::OECondition::Broadcast` still need to be
      explicitly called by the user.

   .. oe:method:: Constructors

      .. oe:api::

         OELockCondition(OECondition& cond)

      This constructor calls :oe:meth:`OEPlatform::OECondition::Acquire`. The
      destructor of this class will be responsible for calling
      :oe:meth:`OEPlatform::OECondition::Release`.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELockCondition & operator=(const OELockCondition &)

      Assignment operator.

   



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OELockSpinlock, LockSpinlock

.. _OEPlatform_OELockSpinlock:

.. oe:class:: OELockSpinlock

   .. oe:api::

      class OELockSpinlock

   This class can be used to ensure an
   :ref:`OESpinlock <OEPlatform_OESpinlock>` object is properly released when
   this object falls out of scope.

   .. code-block:: c++

      OELockSpinlock = std::lock_guard<OESpinlock>;

   .. seealso::

      * :ref:`OESpinlock <OEPlatform_OESpinlock>` class
      * `std::lock_guard <https://en.cppreference.com/w/cpp/thread/lock_guard>`_


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEMutex, Mutex

.. _OEPlatform_OEMutex:

.. oe:class:: OEMutex

   .. oe:api::

      struct OEMutex

   The :ref:`OEMutex <OEPlatform_OEMutex>` class provides a portable MUTual
   EXclusion device, that is useful for protecting shared data structures 
   from concurrent modification.

   .. seealso::

      * :ref:`OELock <OEPlatform_OELock>` class
      * :ref:`OETryMutex <OEPlatform_OETryMutex>` class

   .. oe:method:: Constructors

      .. oe:api::

         OEMutex()

      Default constructor.

   .. oe:method:: Acquire

      .. oe:api::

         void Acquire()

      Acquires (locks) the :ref:`OEMutex <OEPlatform_OEMutex>`. If the
      :ref:`OEMutex <OEPlatform_OEMutex>` is unlocked, it is locked by this calls
      and becomes owned
      by the calling thread. If the :ref:`OEMutex <OEPlatform_OEMutex>` is already
      locked, by this or another thread, :oe:meth:`OEPlatform::OEMutex::Acquire`
      suspends the calling thread until the :ref:`OEMutex <OEPlatform_OEMutex>`
      is released.

   .. oe:method:: Release

      .. oe:api::

         void Release()

      Releases (unlocks) the :ref:`OEMutex <OEPlatform_OEMutex>`. The
      :ref:`OEMutex <OEPlatform_OEMutex>` object must have previously been locked
      by the calling thread.


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEOnce, Once

.. _OEPlatform_OEOnce:

.. oe:class:: OEOnce

   .. oe:api::

      template<class T>
      struct OEOnce

   **OEOnce is deprecated. OpenEye strongly recommends using one of the alternatives
   below instead of `OEOnce`** 
   
   `OEOnce` was created to facilitate thread-safe initialization of
   function-local-statics before C++11’s magic-statics were universally available.
   Its implementation has become redundant since moving to VS2015 with full C++11
   compliance. All of the existing uses will continue to work as intended without 
   change, with minimal overhead in compile and run time for optimized release 
   builds, in most cases.

   **Alternatives**

   * Function local static instances:

      * Only use when required - there is a performance cost!

      * Make const unless you can’t. 

      * Fully construct static local in a single line:

         * Via constructor:
           ``static const SomeClass someInstance{"abc", 1.23f, 456};``
         
         * Via function result:
           ``static const int tag = OEGetTag(”my_tag”);``

         * Use ``std::unique_ptr`` when you must have a pointer, or 
           for very large objects:
           ``static const std::unique_ptr<Class2> up{factoryFunc()};``
         
   * When call-once is truly desired:

      * ``std::atomic_flag``

         * Define at file scope if you can

         * init with  ``= ATOMIC_FLAG_INIT;``

         * Use ``std::atomic_flag::test_and_set`` in conditional

      * ``std::once_flag/call_once``

         * Define ``std::once_flag`` at file scope if you can

         * Provides exception handling

         * Can handle more complex situations

   **Original Documentation**

   This class is used to do thread-safe one time initialization of an
   object as a function local static. It is intended to imitate the
   behavior of the C++11 "magic statics" feature. The default
   constructor of the class ``T`` is guaranteed to be called once, and
   only once, and all other threads will block until initialization is
   complete.

   The following code snippet demonstrates how to use ``OEOnce`` to
   cache an initialized :ref:`OESubSearch <OEChem_OESubSearch>` object to be used
   by subsequent function invocations:

   .. code-block:: c++

      class PhenylSubSearch
      {
        OESubSearch _subsrch;
      public:
        PhenylSubSearch() : _subsrch("c1ccccc1") { }
        const OESubSearch &GetSubSearch() const { return _subsrch; }
      };

      bool HasPhenyl(const OEMolBase &mol)
      {
        static OEOnce<PhenylSubSearch> phenylSubSrch = OE_ONCE_INIT;
        return phenylSubSrch->GetSubSearch().SingleMatch(mol);
      }
      
   .. warning::

      The thread safety of the object ``T`` is the responsibility of the
      user. ``OEOnce`` will only ensure that there is only one of them
      initialized for the whole lifetime of the process and that its
      destructor is called during process exit.

   .. oe:method:: operator*
      :language: c++

      .. oe:api::

         T& operator*()

      Dereference that ``OEOnce`` object, returning a reference to the
      singleton ``T`` object. The reference will only be returned once
      at least one thread has fully initialized the object.

   .. oe:method:: operator->
      :language: c++

      .. oe:api::

         T* operator->()

      Allows the ``OEOnce`` object to behave like a pointer to
      ``T``. The pointer will only be returned once at least one
      thread has fully initialized the object.

   .. oe:method:: operator T *
      :language: c++

      .. oe:api::

         operator T *()

      Allows the ``OEOnce`` object to be cast to a pointer of
      ``T``. The pointer will only be returned once at least one
      thread has fully initialized the object.

   .. oe:method:: GetValue

      .. oe:api::

         T* GetValue()

      Returns the pointer to a singleton object initialized in a thread
      safe way. The pointer will only be returned once at least one
      thread has fully initialized the object.


.. _OEPlatformClasses:

*******************
OEPlatform Classes
*******************

.. oe:namespace:: OEPlatform

.. toctree::

   OECondition
   OEDirectoryScan
   OEFile
   OEHalfFloat
   OELock
   OELockCondition
   OELockSpinlock
   OEMutex
   OEOnce
   OESpinlock
   OEThread
   OEThreadLocal
   OETryMutex
   oeifstream
   oeigzstream
   oeiofstream
   oeisstream
   oeistdstream
   oeistream 
   oeiwrapperstream
   oemultiostream
   oeofstream
   oeogzstream
   oeosstream
   oeostdstream
   oeostream
   oeowrapperstream
   oestream


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OESpinlock, Spinlock

.. _OEPlatform_OESpinlock:

.. oe:class:: OESpinlock

   .. oe:api::

      struct OESpinlock

   The :ref:`OESpinlock <OEPlatform_OESpinlock>` class provides a portable
   mutual exclusion device, that is useful for protecting shared data
   structures from concurrent modification. It provides the exact same
   semantics as a :ref:`OEMutex <OEPlatform_OEMutex>` object, however, it has
   very different performance semantics. Spin locks will
   optimistically continually try to acquire the lock in a tight
   loop. :ref:`OEMutex <OEPlatform_OEMutex>` will typically yield the
   processor back to the operating system. Spin locks are useful to
   protect very cheap operations. 

   .. seealso::

      * :ref:`OELockSpinlock <OEPlatform_OELockSpinlock>` class

   .. oe:method:: Constructors

      .. oe:api::

         OESpinlock()

      Default constructor.

   .. oe:method:: Acquire

      .. oe:api::

         void Acquire()

      Acquires (locks) the :ref:`OESpinlock <OEPlatform_OESpinlock>`. If the
      :ref:`OESpinlock <OEPlatform_OESpinlock>` is unlocked, it is locked by
      this thread and becomes owned by the calling thread. If the
      :ref:`OESpinlock <OEPlatform_OESpinlock>` is already locked, by this or
      another thread, :oe:meth:`OEPlatform::OESpinlock::Acquire` spins
      in a tight loop until the :ref:`OESpinlock <OEPlatform_OESpinlock>` is
      released. No attempt is made at fairness between threads. 

   .. oe:method:: Release

      .. oe:api::

         void Release()

      Releases (unlocks) the :ref:`OESpinlock <OEPlatform_OESpinlock>`.



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEThread, Thread

.. _OEPlatform_OEThread:

.. oe:class:: OEThread

   .. oe:api::

      class OEThread

   Abstracts away the notion of an operating system thread in a
   cross-platform way. Users can subclass this class and implement the
   :oe:meth:`OEPlatform::OEThread::Run` method in order to create new
   operating system threads running any arbitrary code. 

   .. oe:method:: Constructors

      .. oe:api::

         OEThread()

      Default constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEThread & operator=(const OEThread &)

      Assignment operator.

   

   .. oe:method:: GetArg

      .. oe:api::

         void* GetArg()

      Used by the implementation to pass the ``void *`` argument from
      :oe:meth:`OEPlatform::OEThread::Start` to the
      :oe:meth:`OEPlatform::OEThread::Run` method in a new thread. Not
      guaranteed to return anything useful on all platforms, and may
      go away in a future version.

   .. oe:method:: GetReturn

      .. oe:api::

         void* GetReturn()

      Used by the implementation to pass the ``void *`` returned from
      :oe:meth:`OEPlatform::OEThread::Run` to the
      :oe:meth:`OEPlatform::OEThread::Join` method in a new thread. Not
      guaranteed to return anything useful on all platforms, and may
      go away in a future version. If the thread is still running,
      this method can data race with the running thread, this should
      only be called after this thread is joined.

   .. oe:method:: GetStackSize

      .. oe:api::

         unsigned int GetStackSize() const

      Return the stack size chosen for this thread by a previous call
      to :oe:meth:`OEPlatform::OEThread::SetStackSize`. By default,
      this method will return ``0``, specifying that the operating
      system's default stack size will be used. 

   .. oe:method:: Join

      .. oe:api::

         void* Join()

      Blocks and wait for the thread to finish, returning the ``void *`` 
      returned by the overloaded :oe:meth:`OEPlatform::OEThread::Run` method. 

   .. oe:method:: Run

      .. oe:api::

         void* Run(void* targ)=0

      Pure virtual method expected to be overloaded by the inheriting
      class. This method will be started in a separate operating
      system thread after a successful call to
      :oe:meth:`OEPlatform::OEThread::Start`.

   .. oe:method:: SetArg

      .. oe:api::

         void SetArg(void* targ)

      Used by the implementation to pass the ``void *`` argument from
      :oe:meth:`OEPlatform::OEThread::Start` to the
      :oe:meth:`OEPlatform::OEThread::Run` method in a new thread. Not
      guaranteed to return anything useful on all platforms, and may
      go away in a future version.

   .. oe:method:: SetReturn

      .. oe:api::

         void SetReturn(void* targ)

      Used by the implementation to pass the ``void *`` returned from
      :oe:meth:`OEPlatform::OEThread::Run` to the
      :oe:meth:`OEPlatform::OEThread::Join` method in a new thread. Not
      guaranteed to return anything useful on all platforms, and may
      go away in a future version.

   .. oe:method:: SetStackSize

      .. oe:api::

         void SetStackSize(unsigned int stackSize)

      Specify the maximum size a stack can grow for this newly created
      operating system thread. This method must be called before
      calling :oe:meth:`OEPlatform::OEThread::Start`. Depending on the
      platform and the operating system settings,
      :oe:meth:`OEPlatform::OEThread::Start` may fail and return
      ``false`` if the value is considered inappropriate by the
      operating system. The value of ``0`` specifies to just use the
      operating system default. 

   .. oe:method:: Start

      .. oe:api::

         bool Start(void* targ = 0)

      Returns ``true`` if the operating system thread is successfully
      created, ``false`` otherwise.


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEThreadLocal, ThreadLocal

.. _OEPlatform_OEThreadLocal:

.. oe:class:: OEThreadLocal

   .. oe:api::

      template<class T>
      class OEThreadLocal

   This class represents `OEThreadLocal`.

   
   .. oe:method:: Constructors

      .. oe:api::

         OEThreadLocal()

      Default constructor.

   .. oe:method:: operator*
      :language: c++

      .. oe:api::

         T& operator*() const

   .. oe:method:: operator->
      :language: c++

      .. oe:api::

         T* operator->() const

   .. oe:method:: operator T &
      :language: c++

      .. oe:api::

         operator T &() const

   .. oe:method:: operator T *
      :language: c++

      .. oe:api::

         operator T *() const



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OETryMutex, TryMutex

.. _OEPlatform_OETryMutex:

.. oe:class:: OETryMutex

   .. oe:api::

      class OETryMutex

   This class represents `OETryMutex`.

   The :ref:`OETryMutex <OEPlatform_OETryMutex>` class provides a portable
   MUTual EXclusion device, that is useful for protecting shared data
   structures from concurrent modification. This version also contains
   :oe:meth:`OEPlatform::OETryMutex::Try` method that allows for a
   failed acquire. :ref:`OETryMutex <OEPlatform_OETryMutex>` is slightly more
   costly than :ref:`OEMutex <OEPlatform_OEMutex>`.

   .. oe:method:: Constructors

      .. oe:api::

         OETryMutex()

      Default constructor.

   .. oe:method:: Acquire

      .. oe:api::

         void Acquire()

      Acquires (locks) the :ref:`OETryMutex <OEPlatform_OETryMutex>`. If the
      :ref:`OETryMutex <OEPlatform_OETryMutex>` is unlocked, it is locked by
      this calls and becomes owned by the calling thread. If the
      :ref:`OETryMutex <OEPlatform_OETryMutex>` is already locked, by this or
      another thread, :oe:meth:`OEPlatform::OETryMutex::Acquire`
      suspends the calling thread until the
      :ref:`OETryMutex <OEPlatform_OETryMutex>` is released.

   .. oe:method:: Release

      .. oe:api::

         void Release()

      Releases (unlocks) the :ref:`OETryMutex <OEPlatform_OETryMutex>`. The
      :ref:`OETryMutex <OEPlatform_OETryMutex>` object must have previously been
      locked by the calling thread.

   .. oe:method:: Try

      .. oe:api::

         bool Try()

      Attempts to acquire (lock) the
      :ref:`OETryMutex <OEPlatform_OETryMutex>`. If the
      :ref:`OETryMutex <OEPlatform_OETryMutex>` is unlocked, it is locked by
      this call, becomes owned by the calling thread, and returns
      ``true``. If the :ref:`OETryMutex <OEPlatform_OETryMutex>` is already locked,
      by this or another thread, :oe:meth:`OEPlatform::OETryMutex::Try`
      returns ``false``.


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeifstream, ifstream

.. _OEPlatform_oeifstream:

.. oe:class:: oeifstream

   .. oe:api::

      class oeifstream : public oeistream

   This class represents `oeifstream`.

   Implements an input stream capable of reading from a specified file
   or from any generic data source with an associated file descriptor.

   The following methods are publicly inherited from :ref:`oeistream <OEPlatform_oeistream>`:

   ======================================================== ======================================================= =======================================================
   :oe:meth:`operator>><OEPlatform::oeistream::operator>>>` :oe:meth:`gettoken<OEPlatform::oeistream::gettoken>`    :oe:meth:`skipbyte<OEPlatform::oeistream::skipbyte>`   
   :oe:meth:`close<OEPlatform::oeistream::close>`           :oe:meth:`open<OEPlatform::oeistream::open>`            :oe:meth:`skipline<OEPlatform::oeistream::skipline>`   
   :oe:meth:`get<OEPlatform::oeistream::get>`               :oe:meth:`peekbyte<OEPlatform::oeistream::peekbyte>`                                                           
   :oe:meth:`getbyte<OEPlatform::oeistream::getbyte>`       :oe:meth:`read<OEPlatform::oeistream::read>`                                                                   
   :oe:meth:`getline<OEPlatform::oeistream::getline>`       :oe:meth:`skip<OEPlatform::oeistream::skip>`                                                                   
   ======================================================== ======================================================= =======================================================

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oeifstream()
            oeifstream(int ifd)
            oeifstream(const char* filename)
            oeifstream(const std::string& filename)

      .. oe:language:: python

         .. oe:api:: python

            oeifstream() -> oeifstream
            oeifstream(ifd: int) -> oeifstream
            oeifstream(filename: str) -> oeifstream

      Creates a new :ref:`oeifstream <OEPlatform_oeifstream>`. If a valid file descriptor ('ifd')
      is passed to the constructor, the stream will use the associated data source
      for input. Otherwise, the constructors expect the name of an
      existing file from which to read. If no parameter is passed to the
      constructor, the stream can later be opened using the open command
      defined in :ref:`oeistream <OEPlatform_oeistream>` or the
      :oe:meth:`OEPlatform::oeifstream::openfd` 
      command defined in this class.

   .. oe:method:: fd

      .. oe:language:: c++ java csharp

         .. oe:api::

            int fd() const

      .. oe:language:: python

         .. oe:api:: python

            fd() -> int

      Returns the system dependent file descriptor associated with the
      stream's data source.

   .. oe:method:: openfd

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool openfd(int ifd, bool closefd)

      .. oe:language:: python

         .. oe:api:: python

            openfd(ifd: int, closefd: bool) -> bool

      Sets the data source of the stream to the specified file descriptor
      'ifd'. If 'closefd' is ``false``, the underlying data source 
      is not closed before changing to the new data source.

   .. oe:method:: pread

      .. oe:language:: c++ java csharp

         .. oe:api::

            oesize_t pread(char* buffer, oesize_t len, oefpos_t offset) const

      .. oe:language:: python

         .. oe:api:: python

            pread(buffer: str, len: oesize_t, offset: oefpos_t) -> oesize_t

      Reads 'len' bytes into 'buffer' at the specified 'offset' in the
      file. Returns the number of bytes actually read. This method
      allows multiple threads to safely read from a single file
      descriptor. 

      .. warning:: 
         
         It is undefined behavior to mix calls to 'pread' other
         :ref:`oeistream <OEPlatform_oeistream>` read method calls on the same object.


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeigzstream, igzstream

.. _OEPlatform_oeigzstream:

.. oe:class:: oeigzstream

   .. oe:api::

      class oeigzstream : public oeiwrapperstream

   This class represents `oeigzstream`.

   Implements a wrapper stream capable of dynamically uncompressing
   gzipped data read off of the wrapped stream.

   The following methods are publicly inherited from :ref:`oeiwrapperstream <OEPlatform_oeiwrapperstream>`:

   ====================================================== ====================================================== =======================================================
   :oe:meth:`clear<OEPlatform::oeiwrapperstream::clear>`  :oe:meth:`set<OEPlatform::oeiwrapperstream::set>`      :oe:meth:`stream<OEPlatform::oeiwrapperstream::stream>`
   ====================================================== ====================================================== =======================================================

   The following methods are publicly inherited from :ref:`oeistream <OEPlatform_oeistream>`:

   ======================================================== ======================================================= =======================================================
   :oe:meth:`operator>><OEPlatform::oeistream::operator>>>` :oe:meth:`gettoken<OEPlatform::oeistream::gettoken>`    :oe:meth:`skipbyte<OEPlatform::oeistream::skipbyte>`   
   :oe:meth:`close<OEPlatform::oeistream::close>`           :oe:meth:`open<OEPlatform::oeistream::open>`            :oe:meth:`skipline<OEPlatform::oeistream::skipline>`   
   :oe:meth:`get<OEPlatform::oeistream::get>`               :oe:meth:`peekbyte<OEPlatform::oeistream::peekbyte>`                                                           
   :oe:meth:`getbyte<OEPlatform::oeistream::getbyte>`       :oe:meth:`read<OEPlatform::oeistream::read>`                                                                   
   :oe:meth:`getline<OEPlatform::oeistream::getline>`       :oe:meth:`skip<OEPlatform::oeistream::skip>`                                                                   
   ======================================================== ======================================================= =======================================================

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   .. oe:method:: Constructors

      .. oe:api::

         oeigzstream()
         oeigzstream(oeistream* is, bool del)

      Creates a new :ref:`oeigzstream <OEPlatform_oeigzstream>`.

   .. seealso::

      :ref:`oeiwrapperstream <OEPlatform_oeiwrapperstream>` for more details on the functionality of this class.


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeiofstream, iofstream

.. _OEPlatform_oeiofstream:

.. oe:class:: oeiofstream

   .. oe:api::

      class oeiofstream : public oeofstream

   This class represents a file that can be both written to and read
   from at the same time. Note, it inherits from
   :ref:`oeofstream <OEPlatform_oeofstream>` and can generally be used as an
   output file stream. The major distinction being that the
   :oe:meth:`OEPlatform::oeiofstream::pread` method can be used to read
   data back from the file provided
   :oe:meth:`OEPlatform::oeostream::flush` has been called. 

   The following methods are publicly inherited from :ref:`oeofstream <OEPlatform_oeofstream>`:

   ================================================= ================================================ =================================================
   :oe:meth:`append<OEPlatform::oeofstream::append>` :oe:meth:`fd<OEPlatform::oeofstream::fd>`        :oe:meth:`openfd<OEPlatform::oeofstream::openfd>`
   ================================================= ================================================ =================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oeiofstream()
            oeiofstream(const char* filename)
            oeiofstream(const std::string& filename)

      .. oe:language:: python

         .. oe:api:: python

            oeiofstream() -> oeiofstream
            oeiofstream(filename: str) -> oeiofstream

      Default and copy constructors.

   .. oe:method:: pread

      .. oe:language:: c++ java csharp

         .. oe:api::

            oesize_t pread(char* buffer, oesize_t len, oefpos_t offset) const

      .. oe:language:: python

         .. oe:api:: python

            pread(buffer: str, len: oesize_t, offset: oefpos_t) -> oesize_t

      Reads 'len' bytes into 'buffer' at the specified 'offset' in the
      file. Returns the number of bytes actually read. This method
      allows multiple threads to safely read from a single file
      descriptor. 

      .. warning:: 
         
         The ``flush`` method must be called before data written to
         this stream can be seen by the ``pread`` method. 



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeisstream, isstream

.. _OEPlatform_oeisstream:

.. oe:class:: oeisstream

   .. oe:api::

      class oeisstream : public oeistream

   This class represents `oeisstream`.

   Implements an input stream that uses a string of data already in
   memory as the input source.

   The following methods are publicly inherited from :ref:`oeistream <OEPlatform_oeistream>`:

   ======================================================== ======================================================= =======================================================
   :oe:meth:`operator>><OEPlatform::oeistream::operator>>>` :oe:meth:`gettoken<OEPlatform::oeistream::gettoken>`    :oe:meth:`skipbyte<OEPlatform::oeistream::skipbyte>`   
   :oe:meth:`close<OEPlatform::oeistream::close>`           :oe:meth:`open<OEPlatform::oeistream::open>`            :oe:meth:`skipline<OEPlatform::oeistream::skipline>`   
   :oe:meth:`get<OEPlatform::oeistream::get>`               :oe:meth:`peekbyte<OEPlatform::oeistream::peekbyte>`                                                           
   :oe:meth:`getbyte<OEPlatform::oeistream::getbyte>`       :oe:meth:`read<OEPlatform::oeistream::read>`                                                                   
   :oe:meth:`getline<OEPlatform::oeistream::getline>`       :oe:meth:`skip<OEPlatform::oeistream::skip>`                                                                   
   ======================================================== ======================================================= =======================================================

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oeisstream()
            oeisstream(const oeisstream& rhs)
            oeisstream(const std::string& buffer)
            oeisstream(char* buffer, oesize_t len, bool copy = true)
            oeisstream(const char* buffer, oesize_t len, bool copy = true)

      .. oe:language:: python

         .. oe:api:: python

            oeisstream(buffer: str, len: oesize_t, copy: bool = True) -> oeisstream
            oeisstream(buffer: str) -> oeisstream
            oeisstream() -> oeisstream
            oeisstream(rhs: oeisstream) -> oeisstream

      Creates a new :ref:`oeisstream <OEPlatform_oeisstream>`.
      Passing any of the specified parameters
      to the one of the non-default constructors is equivalent to
      creating a new :ref:`oeisstream <OEPlatform_oeisstream>` with the default
      constructor and then
      calling the appropriate :oe:meth:`OEPlatform::oeisstream::set` method 
      on that stream.

      If the copy constructor is used, the newly created oeisstream will
      read from the same data string as the stream being copied from. If
      the 'copy' parameter was set to ``true`` on the stream being copied from,
      the new stream will create its own local copy to read from,
      otherwise it will just point to the same place in memory as the
      original stream. In addition, the newly constructed stream's
      reading pointer will be set to the same location as the one in the
      stream being copied from.

      Regardless of whether or not a local copy is made, the stream takes
      no responsibility for the management of the original input source's
      memory.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         oeisstream &operator=(const oeisstream &rhs)

      Clears the current stream and sets the input source of this stream
      to be the same as the one in the assigned stream. If the copy
      parameter was set to ``true`` on the assigned stream, the stream will
      create its own local copy to read from, otherwise it will just
      point to the same place in memory as the assigned stream. In
      addition, the stream's reading pointer will be set to the same
      location as the one in the assigned stream.

      Assignment operator.

   .. oe:method:: clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void clear()

      .. oe:language:: python

         .. oe:api:: python

            clear() -> None

      Clears the association with input source associated with this
      stream. If the copy parameter was set to ``false`` when this stream was
      assigned or constructed, no changes will be made to the original
      data source.

   .. oe:method:: getbuffer

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool getbuffer(std::string& buffer) const

      .. oe:language:: python

         .. oe:api:: python

            getbuffer(buffer: str) -> bool

      Copies the entire contents of the input source into the specified
      string regardless of the current location of the reading pointer
      and returns whether or not this was successful.

   .. oe:method:: reset

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool reset()

      .. oe:language:: python

         .. oe:api:: python

            reset() -> bool

      Resets the reading pointer to the beginning of the input stream and
      returns whether or not this was successful. This is equivalent to
      calling the :oe:meth:`OEPlatform::oestream::rewind` method of  
      :ref:`oestream <OEPlatform_oestream>`.

   .. oe:method:: set

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool set(const std::string &)
            bool set(char *, oesize_t, bool)
            bool set(const char *, oesize_t, bool)

      .. oe:language:: python

         .. oe:api:: python

            set(arg2: str) -> bool
            set(arg2: str, arg3: oesize_t, arg4: bool) -> bool

      Sets the input source of this stream based on the specified
      parameters. The buffer parameter specifies the data string to be
      used as the input source. If the ``char *`` constructors are used, the
      length of the input buffer must be specified as well as whether or
      not a local copy of the buffer should be made and used as the input
      source. If the ``std::string`` method is used, a local copy of the
      input string will be made and used as the input source.

      Regardless of whether or not a local copy is made, the stream takes
      no responsibility for the management of the original input source's
      memory.


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeistdstream, istdstream

.. _OEPlatform_oeistdstream:

.. oe:class:: oeistdstream

   .. oe:api::

      class oeistdstream : public oeistream

   This class represents `oeistdstream`.

   
   Implements a wrapper stream around a standard C++ input stream
   (``std::istream``).

   The following methods are publicly inherited from :ref:`oeistream <OEPlatform_oeistream>`:

   ======================================================== ======================================================= =======================================================
   :oe:meth:`operator>><OEPlatform::oeistream::operator>>>` :oe:meth:`gettoken<OEPlatform::oeistream::gettoken>`    :oe:meth:`skipbyte<OEPlatform::oeistream::skipbyte>`   
   :oe:meth:`close<OEPlatform::oeistream::close>`           :oe:meth:`open<OEPlatform::oeistream::open>`            :oe:meth:`skipline<OEPlatform::oeistream::skipline>`   
   :oe:meth:`get<OEPlatform::oeistream::get>`               :oe:meth:`peekbyte<OEPlatform::oeistream::peekbyte>`                                                           
   :oe:meth:`getbyte<OEPlatform::oeistream::getbyte>`       :oe:meth:`read<OEPlatform::oeistream::read>`                                                                   
   :oe:meth:`getline<OEPlatform::oeistream::getline>`       :oe:meth:`skip<OEPlatform::oeistream::skip>`                                                                   
   ======================================================== ======================================================= =======================================================

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   .. oe:method:: Constructors

      .. oe:api::

         oeistdstream()
         oeistdstream(std::istream* isptr, bool del)

      Creates a new :ref:`oeistdstream <OEPlatform_oeistdstream>`. Passing the 'isptr'
      and 'del' parameters is
      equivalent to using the default constructor and then calling
      :oe:meth:`set(isptr, del)<OEPlatform::oeistdstream::set>` on the 
      newly created stream.

   .. oe:method:: clear

      .. oe:api::

         void clear()

      Clears the pointer to the wrapped stream. If the 'del' parameter was
      set to ``true`` when the wrapped stream was set 
      (:oe:meth:`OEPlatform::oeistdstream::set`), the wrapped stream
      will be deleted before it is cleared.

   .. oe:method:: set

      .. oe:api::

         bool set(std::istream* isptr, bool del)

      Sets 'isptr' to be the stream wrapped by this class. If 'del' is ``true``,
      the wrapped stream will be deleted when the clear method is called
      or when this class is deleted. It is important to understand that
      by setting 'del' to ``true``, ownership of the stream's memory is
      transferred to this class, and if it is ``false``, you retain the
      responsibility for managing the stream's memory.

   .. oe:method:: stream

      .. oe:api::

         std::istream* stream()

      Returns a pointer to the wrapped stream if present, otherwise ``0``.


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeistream, istream

.. _OEPlatform_oeistream:

.. oe:class:: oeistream

   .. oe:api::

      class oeistream : public oestream

   This class represents `oeistream`.

   Defines the platform independent interface and implementation for a
   generic input data stream class.

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:
   

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   The following classes derive from this class:
    * :ref:`oeifstream <OEPlatform_oeifstream>`
    * :ref:`oeigzstream <OEPlatform_oeigzstream>`
    * :ref:`oeisstream <OEPlatform_oeisstream>`
    * :ref:`oeistdstream <OEPlatform_oeistdstream>`
    * :ref:`oeiwrapperstream <OEPlatform_oeiwrapperstream>`
    * :ref:`oeprogressstream <OESystem_oeprogressstream>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oeistream()

      .. oe:language:: python

         .. oe:api:: python

            oeistream() -> oeistream

      Creates an instance of an
      :ref:`oeistream <OEPlatform_oeistream>`. This class is designed to
      provide an interface and some functionality; however, this
      class does not define a data source and therefore instances
      of this class have no independent functionality.

   .. oe:method:: operator>>
      :language: c++

      .. oe:api::

         oeistream &operator>>(oestream &(_f)(oestream &))
         oeistream &operator>>(oeistream &(_f)(oeistream &))

      Use of these operators executes the specified function ('f') on
      the stream in question. In order for proper compilation and
      execution, the specified function must be prototyped according
      to the API shown above.

      .. oe:api::

         oeistream &operator>>(oeostream &)

      Sends all of the remaining input on the stream to the specified 
      :ref:`oeostream <OEPlatform_oeostream>`.

      .. oe:api::

         oeistream &operator>>(int &)
         oeistream &operator>>(bool &)
         oeistream &operator>>(long &)
         oeistream &operator>>(char &)
         oeistream &operator>>(float &)
         oeistream &operator>>(short &)
         oeistream &operator>>(double &)
         oeistream &operator>>(std::string &)
         oeistream &operator>>(signed char &)
         oeistream &operator>>(unsigned int &)
         oeistream &operator>>(unsigned long &)
         oeistream &operator>>(unsigned char &)
         oeistream &operator>>(unsigned short &)

      These operators read the next whitespace-delimited token on the
      input stream, converts it into the appropriate data type, and
      stores that value in the specified parameter. The use of these
      operators on non-text streams is undefined.

   .. oe:method:: close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void close()

      .. oe:language:: python

         .. oe:api:: python

            close() -> None

      Closes the input stream. All future attempts to read from this
      stream will fail until it is opened again with new input.

   .. oe:method:: get

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool get(char& c)
            bool get(signed char& c)
            bool get(unsigned char& c)

      .. oe:language:: python

         .. oe:api:: python

            get(c: str) -> bool
            get(str: signed) -> bool

      Gets the next byte off of the stream and assigns its value to the
      parameter 'c'. Returns whether or not the byte read equals EOF.

   .. oe:method:: getbyte

      .. oe:language:: c++ java csharp

         .. oe:api::

            int getbyte()

      .. oe:language:: python

         .. oe:api:: python

            getbyte() -> int

      Returns the next byte off of the stream.

   .. oe:method:: getline

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool getline(std::string& sbuffer)
            bool getline(char* buffer, oesize_t max)
            bool getline(signed char* buffer, oesize_t max)
            bool getline(std::string& sbuffer, oesize_t max)
            bool getline(unsigned char* buffer, oesize_t max)

      .. oe:language:: python

         .. oe:api:: python

            getline(sbuffer: str) -> bool
            getline(sbuffer: str, max: oesize_t) -> bool

      Retrieves the next text line from the stream and directly copies
      its contents into the 'buffer' parameter. The newline character is
      not copied with the rest of the contents, though a null
      terminator, '\0', is placed at the end of the contents. The 'max' parameter
      specifies the maximum size of the memory passed in as the
      'buffer' argument. If a newline character is not found within
      'max - 1' characters, only the specified number of characters will be copied
      into the buffer and all the remaining characters in the stream
      before the next newline character will be discarded.

   .. oe:method:: gettoken

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool gettoken(char* buffer, oesize_t max)
            bool gettoken(signed char* buffer, oesize_t max)
            bool gettoken(std::string& sbuffer, oesize_t max)
            bool gettoken(unsigned char* buffer, oesize_t max)

      .. oe:language:: python

         .. oe:api:: python

            gettoken(sbuffer: str, max: oesize_t) -> bool

      Retrieves the next whitespace delimited token from the stream and
      directly copies its contents into the 'buffer' parameter. This
      function discards the whitespace characters read when searching for
      the next token. The 'max' parameter specifies the maximum number of
      characters allowed per token. If a whitespace character is not
      found within the specified number of characters, only the specified
      number of characters will be copied into the buffer and all the
      remaining characters in the stream before the next whitespace
      character will be discarded.

   .. oe:method:: open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool open(const char* name)
            bool open(const std::string& name)
            bool open(unsigned char* buffer, oesize_t len)

      .. oe:language:: python

         .. oe:api:: python

            open(name: str) -> bool
            open(buffer: str, len: oesize_t) -> bool

      Opens the input stream with data from the specified
      sources. Passing a 'name' parameter will result in invocation of a
      protected virtual method to appropriate handle the specified input
      source. Passing a pointer to a character buffer along with the
      buffer's size will result in the stream wrapping the 'buffer' and
      using that as the stream data source. Returns whether or not data
      can now be read from the stream.

   .. oe:method:: peekbyte

      .. oe:language:: c++ java csharp

         .. oe:api::

            int peekbyte()

      .. oe:language:: python

         .. oe:api:: python

            peekbyte() -> int

      Returns the value of the next byte without removing that byte from
      the input stream. Returns ``-1`` if the stream is not valid.

   .. oe:method:: read

      .. oe:language:: c++ java csharp

         .. oe:api::

            oesize_t read(std::string& sbuffer)
            oesize_t read(char* buffer, oesize_t len)
            oesize_t read(signed char* buffer, oesize_t len)
            oesize_t read(std::string& sbuffer, oesize_t len)
            oesize_t read(unsigned char* buffer, oesize_t len)

      .. oe:language:: python

         .. oe:api:: python

            read(sbuffer: str) -> oesize_t

      Reads the next len number of bytes off of the stream, stores them
      in the specified 'buffer' and returns the number of bytes actually
      read. It is the user's responsibility when using any of the three
      ``char *`` versions to make sure that the specified 'buffer' has been
      properly allocated and has enough room to store len bytes. This
      function does not add a NULL terminator to the end of the
      buffer.

      The version that takes a ``std::string`` without a size will
      read the entire contents of the stream into the string, or until
      ``std::bad_alloc`` is thrown when the system runs out of
      memory. 

   .. oe:method:: skip

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool skip(oefpos_t len)

      .. oe:language:: python

         .. oe:api:: python

            skip(len: oefpos_t) -> bool

      Discards the next number of bytes specified by 'len' in the
      stream. Returns whether or not there are any bytes left in the
      stream.

   .. oe:method:: skipbyte

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool skipbyte()

      .. oe:language:: python

         .. oe:api:: python

            skipbyte() -> bool

      Discards the next byte in the stream. Returns whether or not there
      are any bytes left in the stream.

   .. oe:method:: skipline

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool skipline()

      .. oe:language:: python

         .. oe:api:: python

            skipline() -> bool

      Discards the next text line in the stream. Returns whether or not
      there are any bytes left in the stream.



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeiwrapperstream, iwrapperstream

.. _OEPlatform_oeiwrapperstream:

.. oe:class:: oeiwrapperstream

   .. oe:api::

      class oeiwrapperstream : public oeistream

   This class represents `oeiwrapperstream`.

   Implements a wrapper class to seamless contain and abstract the
   functionality of another :ref:`oeistream <OEPlatform_oeistream>`.

   The following methods are publicly inherited from :ref:`oeistream <OEPlatform_oeistream>`:
   

   ======================================================== ======================================================= =======================================================
   :oe:meth:`operator>><OEPlatform::oeistream::operator>>>` :oe:meth:`gettoken<OEPlatform::oeistream::gettoken>`    :oe:meth:`skipbyte<OEPlatform::oeistream::skipbyte>`   
   :oe:meth:`close<OEPlatform::oeistream::close>`           :oe:meth:`open<OEPlatform::oeistream::open>`            :oe:meth:`skipline<OEPlatform::oeistream::skipline>`   
   :oe:meth:`get<OEPlatform::oeistream::get>`               :oe:meth:`peekbyte<OEPlatform::oeistream::peekbyte>`                                                           
   :oe:meth:`getbyte<OEPlatform::oeistream::getbyte>`       :oe:meth:`read<OEPlatform::oeistream::read>`                                                                   
   :oe:meth:`getline<OEPlatform::oeistream::getline>`       :oe:meth:`skip<OEPlatform::oeistream::skip>`                                                                   
   ======================================================== ======================================================= =======================================================

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   The following classes derive from this class:
    * :ref:`oeigzstream <OEPlatform_oeigzstream>`
    * :ref:`oeprogressstream <OESystem_oeprogressstream>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oeiwrapperstream()
            oeiwrapperstream(oeistream* isptr, bool del)

      .. oe:language:: python

         .. oe:api:: python

            oeiwrapperstream() -> oeiwrapperstream
            oeiwrapperstream(isptr: oeistream, deleteptr: bool) -> oeiwrapperstream

      Creates a new :ref:`oeiwrapperstream <OEPlatform_oeiwrapperstream>`.
      Passing the 'isptr' and 'del'
      parameters is equivalent to using the default constructor and then
      calling :oe:meth:`set(isptr, del)<OEPlatform::oeiwrapperstream::set>` 
      on the newly created stream.

   .. oe:method:: clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void clear()

      .. oe:language:: python

         .. oe:api:: python

            clear() -> None

      Clears the pointer to the wrapped stream. If the 'del' parameter was
      set to ``true`` when the wrapped stream was set 
      (:oe:meth:`OEPlatform::oeiwrapperstream::set`), the wrapped stream
      will be deleted before it is cleared.

   .. oe:method:: set

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool set(oeistream* isptr, bool del)

      .. oe:language:: python

         .. oe:api:: python

            set(isptr: oeistream, deleteptr: bool) -> bool

      Sets 'isptr' to be the stream wrapped by this class. If 'del' is ``true``,
      the wrapped stream will be deleted when the clear method is called
      or when this class is deleted. It is important to understand that
      by setting 'del' to ``true``, ownership of the stream's memory is
      transferred to this class, and if it is ``false``, you retain the
      responsibility for managing the stream's memory.

   .. oe:method:: stream

      .. oe:language:: c++ java csharp

         .. oe:api::

            oeistream* stream()

      .. oe:language:: python

         .. oe:api:: python

            stream() -> oeistream

      Returns a pointer to the wrapped stream if present, otherwise ``0``.



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oemultiostream, multiostream

.. _OEPlatform_oemultiostream:

.. oe:class:: oemultiostream

   .. oe:api::

      class oemultiostream : public OEPlatform::oeostream

   This class represents `oemultiostream`.  This class can be used to write to more than one :ref:`oeostream <OEPlatform_oeostream>`.

   
   The following methods are publicly inherited from :ref:`oeostream <OEPlatform_oeostream>`:

   ========================================================= ======================================================= =======================================================
   :oe:meth:`operator\< <OEPlatform::oeostream::operator<<>` :oe:meth:`flush<OEPlatform::oeostream::flush>`          :oe:meth:`putbyte<OEPlatform::oeostream::putbyte>`     
   :oe:meth:`close<OEPlatform::oeostream::close>`            :oe:meth:`open<OEPlatform::oeostream::open>`            :oe:meth:`write<OEPlatform::oeostream::write>`         
   ========================================================= ======================================================= =======================================================

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oemultiostream()

      .. oe:language:: python

         .. oe:api:: python

            oemultiostream() -> oemultiostream

      Default constructor.

   .. oe:method:: addstream

      .. oe:language:: c++ java csharp

         .. oe:api::

            void addstream(oeostream* ostr, bool owned = false)

      .. oe:language:: python

         .. oe:api:: python

            addstream(ostr: oeostream, owned: bool = False) -> None

      This method adds the stream `ostr` for output.  The second parameter can be used to give ownership to the `oemultiostream` instance, which will
      make the instance responsible for deletion of the `oeostream`.

   .. oe:method:: clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void clear()

      .. oe:language:: python

         .. oe:api:: python

            clear() -> None

      Clears all streams and deletes them if owned.



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeofstream, ofstream

.. _OEPlatform_oeofstream:

.. oe:class:: oeofstream

   .. oe:api::

      class oeofstream : public oeostream

   This class represents `oeofstream`.

   
   Implements an output stream capable of writing to a specified file
   or to any generic data source with an associated file descriptor.

   The following methods are publicly inherited from :ref:`oeostream <OEPlatform_oeostream>`:

   ========================================================= ======================================================= =======================================================
   :oe:meth:`operator\< <OEPlatform::oeostream::operator<<>` :oe:meth:`flush<OEPlatform::oeostream::flush>`          :oe:meth:`putbyte<OEPlatform::oeostream::putbyte>`     
   :oe:meth:`close<OEPlatform::oeostream::close>`            :oe:meth:`open<OEPlatform::oeostream::open>`            :oe:meth:`write<OEPlatform::oeostream::write>`         
   ========================================================= ======================================================= =======================================================

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oeofstream()
            oeofstream(int ofd)
            oeofstream(const char* filename)
            oeofstream(const std::string& filename)

      .. oe:language:: python

         .. oe:api:: python

            oeofstream() -> oeofstream
            oeofstream(ofd: int) -> oeofstream
            oeofstream(filename: str) -> oeofstream

      Creates a new :ref:`oeofstream <OEPlatform_oeofstream>`.
      If a valid file descriptor ('fd') is passed
      to the constructor, the stream will use the associated data target
      for output. Otherwise, the constructors expect the name of file to
      be written to. If the named file does not exist, it will be
      created. If no parameter is passed to the constructor, the stream
      can later be opened using the open command defined in
      :ref:`oeostream <OEPlatform_oeostream>` or the
      :oe:meth:`OEPlatform::oeofstream::openfd` command defined in this class.

   .. oe:method:: append

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool append(const char* filename)
            bool append(const std::string& filename)

      .. oe:language:: python

         .. oe:api:: python

            append(filename: str) -> bool

      Opens the specified file to which data will be appended. Returns
      whether or not the file was successfully opened (or created as
      necessary).

   .. oe:method:: fd

      .. oe:language:: c++ java csharp

         .. oe:api::

            int fd() const

      .. oe:language:: python

         .. oe:api:: python

            fd() -> int

      Returns the system dependent file descriptor associated with the
      stream's data target.

   .. oe:method:: openfd

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool openfd(int ofd, bool closefd)

      .. oe:language:: python

         .. oe:api:: python

            openfd(ofd: int, closefd: bool) -> bool

      Sets the data target of the stream to the specified file descriptor
      'fd'. If 'closefd' is ``false``, the underlying data target is not closed
      before changing to the new data source.



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeogzstream, ogzstream

.. _OEPlatform_oeogzstream:

.. oe:class:: oeogzstream

   .. oe:api::

      class oeogzstream : public oeowrapperstream

   This class represents `oeogzstream`.

   Implements a wrapper stream capable of dynamically compressing data
   in gzip format and then passing that along to the wrapped stream.

   The following methods are publicly inherited from :ref:`oeowrapperstream <OEPlatform_oeowrapperstream>`:

   ====================================================== ====================================================== =======================================================
   :oe:meth:`clear<OEPlatform::oeowrapperstream::clear>`  :oe:meth:`set<OEPlatform::oeowrapperstream::set>`      :oe:meth:`stream<OEPlatform::oeowrapperstream::stream>`
   ====================================================== ====================================================== =======================================================

   The following methods are publicly inherited from :ref:`oeostream <OEPlatform_oeostream>`:

   ========================================================= ======================================================= =======================================================
   :oe:meth:`operator\< <OEPlatform::oeostream::operator<<>` :oe:meth:`flush<OEPlatform::oeostream::flush>`          :oe:meth:`putbyte<OEPlatform::oeostream::putbyte>`     
   :oe:meth:`close<OEPlatform::oeostream::close>`            :oe:meth:`open<OEPlatform::oeostream::open>`            :oe:meth:`write<OEPlatform::oeostream::write>`         
   ========================================================= ======================================================= =======================================================

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   .. oe:method:: Constructors

      .. oe:api::

         oeogzstream()
         oeogzstream(oeostream* os, bool del)

      Creates a new :ref:`oeogzstream <OEPlatform_oeogzstream>`.

   .. seealso::

      See :ref:`oeowrapperstream <OEPlatform_oeowrapperstream>` for more details on the
      functionality of this class.



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeosstream, osstream

.. _OEPlatform_oeosstream:

.. oe:class:: oeosstream

   .. oe:api::

      class oeosstream : public oeostream

   This class represents `oeosstream`.

   Implements an output stream that writes into an internally
   contained string.

   The following methods are publicly inherited from :ref:`oeostream <OEPlatform_oeostream>`:

   ========================================================= ======================================================= =======================================================
   :oe:meth:`operator\< <OEPlatform::oeostream::operator<<>` :oe:meth:`flush<OEPlatform::oeostream::flush>`          :oe:meth:`putbyte<OEPlatform::oeostream::putbyte>`     
   :oe:meth:`close<OEPlatform::oeostream::close>`            :oe:meth:`open<OEPlatform::oeostream::open>`            :oe:meth:`write<OEPlatform::oeostream::write>`         
   ========================================================= ======================================================= =======================================================

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oeosstream()
            oeosstream(const char *)
            oeosstream(const unsigned char *, oesize_t)

      .. oe:language:: python

         .. oe:api:: python

            oeosstream() -> oeosstream
            oeosstream(arg2: str, arg3: oesize_t) -> oeosstream
            oeosstream(arg2: str) -> oeosstream

      Creates a new :ref:`oeosstream <OEPlatform_oeosstream>` which is immediately ready to be written
      to. Passing any of the specified parameters to one of the
      non-default constructors is equivalent to creating a new 
      :ref:`oeosstream <OEPlatform_oeosstream>`
      with the default constructor and then calling the appropriate 
      :oe:meth:`OEPlatform::oeosstream::set` method.

      If the copy constructor is used, the entire contents of the other
      stream's internal string are copied into the newly constructed
      stream's internal string.

   .. oe:method:: clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void clear()

      .. oe:language:: python

         .. oe:api:: python

            clear() -> None

      Clears the contents of the internal string.

   .. oe:method:: set

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool set(const char * buffer)
            bool set(const unsigned char *, oesize_t len)

      .. oe:language:: python

         .. oe:api:: python

            set(arg2: str) -> bool
            set(arg2: str, arg3: oesize_t) -> bool

      Sets the contents of the internal string to the contents of the
      specified 'buffer'. If the 'len' parameter is not specified, this
      method will copy the contents of the specified 'buffer' until a null
      character is reached. The null character is not copied. Returns
      whether or not the contents were successfully copied.

   .. oe:method:: str

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string str()

      .. oe:language:: python

         .. oe:api:: python

            str() -> bytes

      Returns a copy of the current internal string.



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeostdstream, ostdstream

.. _OEPlatform_oeostdstream:

.. oe:class:: oeostdstream

   .. oe:api::

      class oeostdstream : public oeostream

   This class represents `oeostdstream`.

   The following methods are publicly inherited from :ref:`oeostream <OEPlatform_oeostream>`:

   =========================================================== ======================================================= =======================================================
   :oe:meth:`operator\<\< <OEPlatform::oeostream::operator<<>` :oe:meth:`flush<OEPlatform::oeostream::flush>`          :oe:meth:`putbyte<OEPlatform::oeostream::putbyte>`     
   :oe:meth:`close<OEPlatform::oeostream::close>`              :oe:meth:`open<OEPlatform::oeostream::open>`            :oe:meth:`write<OEPlatform::oeostream::write>`         
   =========================================================== ======================================================= =======================================================

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   .. oe:method:: Constructors

      .. oe:api::

         oeostdstream()
         oeostdstream(std::ostream* osptr, bool del)

      Default and copy constructors.

   .. oe:method:: clear

      .. oe:api::

         void clear()

   .. oe:method:: set

      .. oe:api::

         bool set(std::ostream* osptr, bool del)

   .. oe:method:: stream

      .. oe:api::

         std::ostream* stream()



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeostream, ostream

.. _OEPlatform_oeostream:

.. oe:class:: oeostream

   .. oe:api::

      class oeostream : public oestream

   This class represents `oeostream`.

   Defines the platform independent interface and implementation for a
   generic output data stream class.

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   The following classes derive from this class:
    * :ref:`oeofstream <OEPlatform_oeofstream>`
    * :ref:`oeogzstream <OEPlatform_oeogzstream>`
    * :ref:`oeosstream <OEPlatform_oeosstream>`
    * :ref:`oeostdstream <OEPlatform_oeostdstream>`
    * :ref:`oeowrapperstream <OEPlatform_oeowrapperstream>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oeostream()

      .. oe:language:: python

         .. oe:api:: python

            oeostream() -> oeostream
            oeostream(arg2: oeostream) -> oeostream

      Creates an instance of an :ref:`oeostream <OEPlatform_oeostream>`.
      This class is designed to
      provide an interface and some functionality; however, this class
      does not define a data target and therefore writing data to an
      instance of this is equivalent to writing to null.

   .. oe:method:: operator<<
      :language: c++

      .. oe:api::

         oeostream &operator<<(oestream &(_f)(oestream &))
         oeostream &operator<<(oeostream &(_f)(oeostream &))

      Use of these operators executes the specified function ('f') on
      the stream in question. In order for proper compilation and
      execution, the specified function must be prototyped according
      to the API shown above.

      .. oe:api::

         oeostream &operator<<(oeistream &)

      Fills the current stream by reading and storing all of the data 
      from the specified :ref:`oeistream <OEPlatform_oeistream>` stream.

      .. oe:api::

         oeostream &operator<<(int)
         oeostream &operator<<(bool)
         oeostream &operator<<(long)
         oeostream &operator<<(char)
         oeostream &operator<<(short)
         oeostream &operator<<(float)
         oeostream &operator<<(double)
         oeostream &operator<<(signed char)
         oeostream &operator<<(const char *)
         oeostream &operator<<(unsigned int)
         oeostream &operator<<(unsigned long)
         oeostream &operator<<(unsigned char)
         oeostream &operator<<(unsigned short)
         oeostream &operator<<(const signed char *)
         oeostream &operator<<(const std::string &)
         oeostream &operator<<(const unsigned char *)

      These operators take the specified parameter, convert it to a text
      representation, and then push it onto the current stream as a
      whitespace-delimited text token.

   .. oe:method:: close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void close()

      .. oe:language:: python

         .. oe:api:: python

            close() -> None

      Flushes the remaining data in the output buffer and then closes the
      stream. After the stream has been closed, it is then initialized
      and ready to be opened. Before this stream can be reused, it must
      first be opened with :oe:meth:`OEPlatform::oeostream::open`. 
      Any attempts to write to this stream
      before it has been opened will fail.

   .. oe:method:: flush

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool flush()

      .. oe:language:: python

         .. oe:api:: python

            flush() -> bool

      Flushes the remaining data in the output buffer onto the stream and
      returns whether or not it was successful. Explicit calls to this
      function are only necessary when one needs to make sure that all of
      the data that has been stored in the output buffer is actually on
      the output stream at that time. The output buffer is automatically
      flushed when it becomes full.

   .. oe:method:: open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool open(const char* name)
            bool open(const std::string& name)
            bool open(unsigned char* buffer, oesize_t len)

      .. oe:language:: python

         .. oe:api:: python

            open(name: str) -> bool
            open(buffer: str, len: oesize_t) -> bool

      Opens the output stream to the specified sources. Passing a 'name'
      parameter will result in invocation of a protected virtual method
      to appropriate handle the specified output source. Passing a
      pointer to a character buffer along with the buffer's size will
      result in the stream wrapping the 'buffer' and using that as the
      stream data destination. Returns whether or not data can now be
      written to the stream.

   .. oe:method:: putbyte

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool putbyte(char c)

      .. oe:language:: python

         .. oe:api:: python

            putbyte(c: str) -> bool

      Pushes the specified byte 'c' onto the output stream and returns
      whether or not this was successful.

   .. oe:method:: write

      .. oe:language:: c++ java csharp

         .. oe:api::

            oesize_t write(const char* buffer, oesize_t len)
            oesize_t write(const std::string& buffer, oesize_t len)
            oesize_t write(const signed char* buffer, oesize_t len)
            oesize_t write(const unsigned char* buffer, oesize_t len)

      .. oe:language:: python

         .. oe:api:: python

            write(buffer: str, len: oesize_t) -> oesize_t
            write(str: signed, len: oesize_t) -> oesize_t

      Writes 'len' number of bytes from the specified data source ('buffer')
      onto the output stream and returns the number of bytes that were
      able to be written.


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeowrapperstream, owrapperstream

.. _OEPlatform_oeowrapperstream:

.. oe:class:: oeowrapperstream

   .. oe:api::

      class oeowrapperstream : public oeostream

   This class represents `oeowrapperstream`.

   Implements a wrapper class to seamless contain and abstract the
   functionality of another :ref:`oeostream <OEPlatform_oeostream>`

   The following methods are publicly inherited from :ref:`oeostream <OEPlatform_oeostream>`:

   ========================================================= ======================================================= =======================================================
   :oe:meth:`operator\< <OEPlatform::oeostream::operator<<>` :oe:meth:`flush<OEPlatform::oeostream::flush>`          :oe:meth:`putbyte<OEPlatform::oeostream::putbyte>`     
   :oe:meth:`close<OEPlatform::oeostream::close>`            :oe:meth:`open<OEPlatform::oeostream::open>`            :oe:meth:`write<OEPlatform::oeostream::write>`         
   ========================================================= ======================================================= =======================================================

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   The following classes derive from this class:
    * :ref:`oeogzstream <OEPlatform_oeogzstream>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oeowrapperstream()
            oeowrapperstream(oeostream* osptr, bool del)

      .. oe:language:: python

         .. oe:api:: python

            oeowrapperstream() -> oeowrapperstream
            oeowrapperstream(osptr: oeostream, deleteptr: bool) -> oeowrapperstream

      Creates a new :ref:`oeowrapperstream <OEPlatform_oeowrapperstream>`.
      Passing the 'osptr' and 'del'
      parameters is equivalent to using the default constructor and then
      calling :oe:meth:`set(osptr, del)<OEPlatform::oeowrapperstream::set>`
      on the newly created stream.

   .. oe:method:: clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void clear()

      .. oe:language:: python

         .. oe:api:: python

            clear() -> None

      Clears the pointer to the wrapped stream. If the 'del' parameter was
      set to ``true`` when the wrapped stream was set
      (:oe:meth:`OEPlatform::oeowrapperstream::set`), the wrapped stream
      will be deleted before it is cleared.

   .. oe:method:: set

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool set(oeostream* osptr, bool del)

      .. oe:language:: python

         .. oe:api:: python

            set(osptr: oeostream, deleteptr: bool) -> bool

      Sets 'osptr' to be the stream wrapped by this class. If 'del' is ``true``,
      the wrapped stream will be deleted when the clear method is called
      or when this class is deleted. It is important to understand that
      by setting 'del' to ``true``, ownership of the stream's memory is
      transferred to this class, and if it is ``false``, you retain the
      responsibility for managing the stream's memory.

   .. oe:method:: stream

      .. oe:language:: c++ java csharp

         .. oe:api::

            oeostream* stream()

      .. oe:language:: python

         .. oe:api:: python

            stream() -> oeostream

      Returns a pointer to the wrapped stream if present, otherwise ``0``.




.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oestream, stream

.. _OEPlatform_oestream:

.. oe:class:: oestream

   .. oe:api::

      class oestream

   This class represents `oestream`.

   The :ref:`oestream <OEPlatform_oestream>` class is the base class which sets up the
   platform independent interface for streaming any type of data.
   

   The following classes derive from this class:
    * :ref:`oeifstream <OEPlatform_oeifstream>`
    * :ref:`oeigzstream <OEPlatform_oeigzstream>`
    * :ref:`oeisstream <OEPlatform_oeisstream>`
    * :ref:`oeistdstream <OEPlatform_oeistdstream>`
    * :ref:`oeistream <OEPlatform_oeistream>`
    * :ref:`oeiwrapperstream <OEPlatform_oeiwrapperstream>`
    * :ref:`oeofstream <OEPlatform_oeofstream>`
    * :ref:`oeogzstream <OEPlatform_oeogzstream>`
    * :ref:`oeosstream <OEPlatform_oeosstream>`
    * :ref:`oeostdstream <OEPlatform_oeostdstream>`
    * :ref:`oeostream <OEPlatform_oeostream>`
    * :ref:`oeowrapperstream <OEPlatform_oeowrapperstream>`
    * :ref:`oeprogressstream <OESystem_oeprogressstream>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            oestream()

      .. oe:language:: python

         .. oe:api:: python

            oestream() -> oestream

      Creates an instance of an :ref:`oestream <OEPlatform_oestream>`.
      This class exists solely to
      provide an interface, therefore, instances of this class have no
      independently meaningful functionality.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Evaluates the stream to a Boolean value based on whether the end of
      the stream has been reached. This is equivalent to ``!eof()``.

   .. oe:method:: eof

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool eof() const

      .. oe:language:: python

         .. oe:api:: python

            eof() -> bool

      Returns whether the end of the stream has been reached.

   .. oe:method:: length

      .. oe:language:: c++ java csharp

         .. oe:api::

            oefpos_t length()

      .. oe:language:: python

         .. oe:api:: python

            length() -> oefpos_t

      Returns the number of bytes that have been read from or written
      to the stream in the last
      :oe:meth:`read<OEPlatform::oeistream::read>` or
      :oe:meth:`write<OEPlatform::oeostream::write>` call.

   .. oe:method:: rewind

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool rewind()

      .. oe:language:: python

         .. oe:api:: python

            rewind() -> bool

      Sets the data pointer position in the stream to the beginning of
      the stream.

   .. oe:method:: seek

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool seek(oefpos_t pos)
            bool seek(oefpos_t offset, seek_dir dir)

      .. oe:language:: python

         .. oe:api:: python

            seek(pos: oefpos_t) -> bool

      Sets the current position of the data pointer. This is accomplished
      by specifying the desired position or by specifying an offset
      distance and a directionality from the current
      position. Directionality is specified using the following
      enumeration:

      .. code-block:: c++

         enum seek_dir { beg = 0, cur = 1, end = 2 };

   .. oe:method:: size

      .. oe:language:: c++ java csharp

         .. oe:api::

            oefpos_t size()

      .. oe:language:: python

         .. oe:api:: python

            size() -> oefpos_t

      If possible, returns the size of the stream in bytes. For
      :oe:cls:`oeostreams<OEPlatform::oeostream>` this is always
      ``zero``. 
      
      .. note:: 

         For :oe:cls:`oeistreams<OEPlatform::oeistream>` this may not
         be possible to calculate without reading, *e.g.*, when the
         stream is a socket or pipe. In this case the implementation
         may return ``0``. 

   .. oe:method:: tell

      .. oe:language:: c++ java csharp

         .. oe:api::

            oefpos_t tell() const

      .. oe:language:: python

         .. oe:api:: python

            tell() -> oefpos_t

      Returns the current position of the data pointer in the
      stream. 

         


.. oe:namespace:: OEPlatform

.. oe:constnamespace:: OEPlatform

   This namespace contains constants.

   .. oe:constant:: oein

      This is a globally available input stream that reads directly from stdin.

   .. oe:constant:: oeout

      This is a globally available output stream that writes directly to stdout.

   .. oe:constant:: oeerr

      This is a globally available output stream that writes directly to stderr.

   .. oe:constant:: oenul

      This is a globally available output stream that writes directly to null.


.. _OEPlatfromConstants:

*********************
OEPlatform Constants
*********************

.. oe:namespace:: OEPlatfrom

.. toctree::

   OEPlatform


.. # split from OEPlatformFunctions.rst:17

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEAddLicenseData

.. oe:function:: OEAddLicenseData

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddLicenseData(const std::string & data)

   .. oe:language:: python

      .. oe:api:: python

         OEAddLicenseData(data: str) -> None

   Parses the string passed as ``data`` as an OpenEye license file and
   adds all the license keys found to the current running process.



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEAddLicenseFromHttp

.. oe:function:: OEAddLicenseFromHttp

   .. oe:language:: java

      .. oe:api:: java

         void OEAddLicenseFromHttp(java.net.URL url)

   .. oe:language:: python

      .. oe:api:: python

         OEAddLicenseFromHttp(url)

   .. oe:language:: csharp

      .. oe:api:: csharp

         void OEAddLicenseFromHttp(System.Uri uri)

   .. oe:language:: python java csharp

      License the current process with a license file retrieved from an
      HTTP or HTTPS request. The following caveats apply:

      - There is no proxy support.
      - The request has a 10 second time out.
      - Content-type must be any of the followings:
        ``text/plain``, ``text/html; charset=utf-8`` or ``text/plain; charset=utf-8``
      - An exception will be thrown if the server does not return status 200
        (success) with the contents of a valid ``oe_license.txt`` file.

      An example of setting the license:

      .. oe:source:: AddLicenseFromHttp.py
         :language: python
         :frag:     SNIPPET-addlicensefromhttp

      .. oe:source:: AddLicenseFromHttp.java
         :language: java
         :frag:     SNIPPET-addlicensefromhttp

      .. oe:source:: AddLicenseFromHttp.cs
         :language: csharp
         :frag:     SNIPPET-addlicensefromhttp

      .. seealso::

         An example of a python http license server is available
         here: https://github.com/oess/HttpLicenseServer

   .. oe:language:: c++

      This method is not available in C++.


.. # split from OEPlatformFunctions.rst:9

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEAddLicenseKey

.. oe:function:: OEAddLicenseKey

   .. oe:language:: c++ java csharp

      .. oe:api::

         int OEAddLicenseKey(const char* key, const char* licensee,
                             const char* site)

   .. oe:language:: python

      .. oe:api:: python

         OEAddLicenseKey(key: str, licensee: str, site: str) -> int

   Add a license to the current process to allow more OpenEye software to be used.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEBigEndian

.. oe:function:: OEBigEndian

   .. oe:api::

      constexpr bool OEBigEndian()


.. # split from OEPlatformFunctions.rst:90

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OECloseIStream

.. oe:function:: OECloseIStream

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECloseIStream(oeistream *)

   .. oe:language:: python

      .. oe:api:: python

         OECloseIStream(arg1: oeistream) -> None

   Closes the specified input :ref:`oeistream <OEPlatform_oeistream>` stream.
   This function only works on :oe:cls:`oeistreams<OEPlatform::oeistream>`
   created with the :oe:func:`OEPlatform::OEOpenIStream`
   function and is also the only way in which they should be closed.



.. # split from OEPlatformFunctions.rst:101

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OECloseOStream

.. oe:function:: OECloseOStream

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECloseOStream(oeostream *)

   .. oe:language:: python

      .. oe:api:: python

         OECloseOStream(arg1: oeostream) -> None

   Closes the specified output :ref:`oeostream <OEPlatform_oeostream>` stream.
   This function only works on :oe:cls:`oeostreams<OEPlatform::oeostream>`
   created with the :oe:func:`OEPlatform::OEOpenOStream` function and
   is also the only way in which they should be closed.



.. # split from OEPlatformFunctions.rst:112

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OECompress

.. oe:function:: OECompress

   .. oe:api::

      bool OECompress(std::string& dst, const std::string& src,
                      const char* fmt = "gz")
      bool OECompress(std::string& dst, const char* src, size_t size,
                      const char* fmt = "gz")

   Compresses the data in the original data buffer, ``src``, using
   the specified compression format, ``fmt``, and stores the compressed data in
   the compressed string ``dst``. Returns whether or not the specified
   compression format was available and if the data was successfully
   compressed using that format.



.. # split from OEPlatformFunctions.rst:125

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OECompressionAvailable

.. oe:function:: OECompressionAvailable

   .. oe:api::

      bool OECompressionAvailable(const char *="gz")

   Returns whether or not compress/uncompress
   functionality is available for the specified compression format.



.. # split from OEPlatformFunctions.rst:134

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OECreateDirectory

.. oe:function:: OECreateDirectory

   .. oe:api::

      bool OECreateDirectory(const char* dname)

   Provides a portable way of creating a new
   subdirectory. Upon success, this function returns the value ``true``.



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OECurrentTime

.. oe:function:: OECurrentTime

   .. oe:language:: c++

      .. oe:api::

         std::string OECurrentTime()
         bool OECurrentTime(struct tm* timeinfo)

      The first overload of this function that takes no arguments
      returns the current local time in the following format:

      ::

         Thu Nov 24 18:22:48 1986\n

      An empty string will be returned if the function fails.

      The second overload will place the current local time into the
      ``timeinfo`` struct. If that fails, ``false`` will be returned.

   .. oe:language:: csharp java python

      This function is only available in C++.


.. # split from OEPlatformFunctions.rst:183

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileCorrectSeparators

.. oe:function:: OEFileCorrectSeparators

   .. oe:api::

      void OEFileCorrectSeparators(std::string& path)



.. # split from OEPlatformFunctions.rst:190

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileCreate

.. oe:function:: OEFileCreate

   .. oe:api::

      OEFile OEFileCreate(const std::string& fname, int permissions = 00666)



.. # split from OEPlatformFunctions.rst:197

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileDelete

.. oe:function:: OEFileDelete

   .. oe:api::

      bool OEFileDelete(OEFile& file)
      bool OEFileDelete(const std::string& fname)



.. # split from OEPlatformFunctions.rst:205

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileDetermineName

.. oe:function:: OEFileDetermineName

   .. oe:api::

      std::string OEFileDetermineName(const std::string& fname)



.. # split from OEPlatformFunctions.rst:212

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileDeterminePath

.. oe:function:: OEFileDeterminePath

   .. oe:api::

      std::string OEFileDeterminePath(const std::string& fname)



.. # split from OEPlatformFunctions.rst:219

.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileDeterminePathAndName

.. oe:function:: OEFileDeterminePathAndName

   .. oe:api::

      void OEFileDeterminePathAndName(const std::string& fname,
                                      std::string& path, std::string& name)



.. # split from OEPlatformFunctions.rst:227

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileExists

.. oe:function:: OEFileExists

   .. oe:api::

      bool OEFileExists(const std::string& fname)



.. # split from OEPlatformFunctions.rst:234

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileIsDirectory

.. oe:function:: OEFileIsDirectory

   .. oe:api::

      bool OEFileIsDirectory(const std::string& fname)



.. # split from OEPlatformFunctions.rst:241

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileIsFile

.. oe:function:: OEFileIsFile

   .. oe:api::

      bool OEFileIsFile(const std::string& fname)



.. # split from OEPlatformFunctions.rst:248

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileIsLink

.. oe:function:: OEFileIsLink

   .. oe:api::

      bool OEFileIsLink(const std::string& fname)



.. # split from OEPlatformFunctions.rst:255

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileIsReadable

.. oe:function:: OEFileIsReadable

   .. oe:api::

      bool OEFileIsReadable(const std::string& fname)



.. # split from OEPlatformFunctions.rst:262

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileIsWritable

.. oe:function:: OEFileIsWritable

   .. oe:api::

      bool OEFileIsWritable(const std::string& fname)



.. # split from OEPlatformFunctions.rst:269

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileRandomName

.. oe:function:: OEFileRandomName

   .. oe:api::

      std::string OEFileRandomName()

   .. warning::

      This function is deprecated. Two threads or processes can end up
      with the same file name.

   .. seealso::

      Use the :oe:func:`OEPlatform::OEFileTempDescriptor` function instead.



.. # split from OEPlatformFunctions.rst:285

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileSize

.. oe:function:: OEFileSize

   .. oe:api::

      oesize_t OEFileSize(const std::string& fname)



.. # split from OEPlatformFunctions.rst:291

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileTempDescriptor

.. oe:function:: OEFileTempDescriptor

   .. oe:api::

      int OEFileTempDescriptor(std::string& fname)

   Returns a file descriptor to a temporary file opened exclusive
   access for both reading and writing. The name of the file is
   returned in the ``fname`` argument string. The file name is
   guaranteed not to race and collide with any other thread or process
   on the system. It is the caller's responsibility to close the file
   descriptor and delete the file.



.. # split from OEPlatformFunctions.rst:304

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileTempDirectory

.. oe:function:: OEFileTempDirectory

   .. oe:api::

      std::string OEFileTempDirectory(const std::string& base_dir = "")

   Create and return the name of a new temporary directory. This
   directory is guaranteed to be unique and free of race
   conditions. If no argument is given or ``base_dir`` is an empty
   string, create the directory inside the
   :oe:func:`OEPlatform::OEFileTempPath` directory. Otherwise, create
   the directory inside ``base_dir`` given. If this function fails, an
   empty string it returned.



.. # split from OEPlatformFunctions.rst:318

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEFileTempPath

.. oe:function:: OEFileTempPath

   .. oe:api::

      std::string OEFileTempPath()

   Returns a system dependent directory for storing temporary files.

   On Linux or macOS this defaults to ``/tmp``, unless the ``TMPDIR``
   environment variable is specified, in which case that directory is
   used if it exists.

   On Windows, this defaults to ``C:\\Temp`` and then ``C:\\Tmp`` if
   that doesn't exist. If the ``TEMP`` or ``TMP`` environment
   variables are set and point to a valid directory, that directory is
   used instead.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetAbsolutePath

.. oe:function:: OEGetAbsolutePath

   .. oe:api::

      std::string OEGetAbsolutePath(const std::string& filename)

   Returns the full absolute pathname to the input file or the empty string if there was an error.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetAllocaThreshold

.. oe:function:: OEGetAllocaThreshold

   .. oe:api::

      oesize_t OEGetAllocaThreshold()

   Returns the maximum number of bytes that can be allocated on the stack at once.

   .. seealso::

      :oe:func:`OEPlatform::OESetAllocaThreshold` function


.. # split from OEPlatformFunctions.rst:336

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetCurrentWorkingDirectory

.. oe:function:: OEGetCurrentWorkingDirectory

   .. oe:api::

        std::string OEGetCurrentWorkingDirectory()

   Return the current working directory for the process.



.. # split from OEPlatformFunctions.rst:344

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetDomainName

.. oe:function:: OEGetDomainName

   .. oe:language:: c++ java csharp

      .. oe:api::

         char* OEGetDomainName()

   .. oe:language:: python

      .. oe:api:: python

         OEGetDomainName() -> str

   Returns the domain name of the machine currently being run on. This
   function is thread safe and expensive on the first call. The
   returned pointer does not need to be freed.



.. # split from OEPlatformFunctions.rst:355

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetHostIdent

.. oe:function:: OEGetHostIdent

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetHostIdent()

   .. oe:language:: python

      .. oe:api:: python

         OEGetHostIdent() -> int

   Returns a unique number derived from the MAC address to represent
   this machine uniquely.



.. # split from OEPlatformFunctions.rst:364

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetHostName

.. oe:function:: OEGetHostName

   .. oe:language:: c++ java csharp

      .. oe:api::

         char* OEGetHostName()

   .. oe:language:: python

      .. oe:api:: python

         OEGetHostName() -> str

   Returns the hostname of the current machine. This
   function is thread safe and expensive on the first call. The
   returned pointer does not need to be freed.



.. # split from OEPlatformFunctions.rst:374

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetIPAddress

.. oe:function:: OEGetIPAddress

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned char* OEGetIPAddress()

   .. oe:language:: python

      .. oe:api:: python

         OEGetIPAddress() -> str

   Returns the IPv4 address of the machine currently being run on.



.. # split from OEPlatformFunctions.rst:383

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetMachineName

.. oe:function:: OEGetMachineName

   .. oe:api::

      std::string OEGetMachineName()

   Returns the NetBIOS name of the local computer on Windows. Returns
   an empty string on other platforms.



.. # split from OEPlatformFunctions.rst:392

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetNumProcessors

.. oe:function:: OEGetNumProcessors

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetNumProcessors()

   .. oe:language:: python

      .. oe:api:: python

         OEGetNumProcessors() -> int

   Returns the number of processor cores available in the current
   machine.



.. # split from OEPlatformFunctions.rst:402

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetPlatformInfo

.. oe:function:: OEGetPlatformInfo

   .. oe:api::

      std::string OEGetPlatformInfo()

   Returns a description of the platform being run on, .e.g, version
   of Windows, or flavor of Linux distribution.



.. # split from OEPlatformFunctions.rst:411

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetProcessMemUsage

.. oe:function:: OEGetProcessMemUsage

   .. oe:api::

      void OEGetProcessMemUsage(size_t& vm_usage, size_t& resident_set)

   Returns the total amount of virtual memory used as the ``vm_usage``
   parameter, and the total amount of memory resident in physical memory
   as the ``resident_set`` parameter.



.. # split from OEPlatformFunctions.rst:422

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetProcessorInfo

.. oe:function:: OEGetProcessorInfo

   .. oe:api::

      std::string OEGetProcessorInfo()



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: GetTimeOfDay

.. oe:function:: OEGetTimeOfDay

   .. oe:language:: c++

      .. oe:api::

         bool OEGetTimeOfDay(struct timeval* tp)

      Fills the ``timeval`` struct ``tp`` with the current time of day
      for the local timezone. Equivalent to the ``gettimeofday`` system
      call on Linux. Returns ``true`` when successful, ``false``
      otherwise.

   .. oe:language:: csharp java python

      This function is only available in C++.


.. # split from OEPlatformFunctions.rst:442

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetUserAppDataDir

.. oe:function:: OEGetUserAppDataDir

   .. oe:api::

      std::string OEGetUserAppDataDir()



.. # split from OEPlatformFunctions.rst:449

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetUserDocumentsDir

.. oe:function:: OEGetUserDocumentsDir

   .. oe:api::

      std::string OEGetUserDocumentsDir()



.. # split from OEPlatformFunctions.rst:456

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetUserHomeDir

.. oe:function:: OEGetUserHomeDir

   .. oe:api::

      std::string OEGetUserHomeDir()



.. # split from OEPlatformFunctions.rst:463

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEGetUserName

.. oe:function:: OEGetUserName

   .. oe:api::

      std::string OEGetUserName()

   Returns the user name of the current user. The current implementation returns
   the value ``User`` or ``Windows User`` if the user name could not
   be determined. Future implementations of this function may return
   an empty string upon failure.



.. # split from OEPlatformFunctions.rst:474

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEIsNaN

.. oe:function:: OEIsNaN

   .. oe:api::

      bool OEIsNaN(float f)
      bool OEIsNaN(double d)

   Returns ``true`` if the number passed is one of the following
   non-real numbers: signaling NaN, quiet NaN, negative infinity, or
   positive infinity.

   .. seealso::

      The reverse of ``OEIsNaN`` is :oe:func:`OEPlatform::OEIsNormalNum`.



.. # split from OEPlatformFunctions.rst:490

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEIsNormalNum

.. oe:function:: OEIsNormalNum

   .. oe:api::

      bool OEIsNormalNum(float f)
      bool OEIsNormalNum(double d)

   Returns ``true`` if the number passed is one of the following real
   numbers: negative or positive denormalized; negative or positive
   zero; negative or positive normalized.

   .. seealso::

      The reverse of ``OEIsNormalNum`` is :oe:func:`OEPlatform::OEIsNaN`.



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OELocalTime

.. oe:function:: OELocalTime

   .. oe:language:: c++

      .. oe:api::

         bool OELocalTime(struct tm* timeinfo, time_t rawtime)

      Convert the seconds since January 1st, 1970, ``rawtime``, into
      the date and time ``timeinfo``. Returns ``false`` if the
      conversion fails.

   .. oe:language:: csharp java python

      This function is only available in C++.


.. # split from OEPlatformFunctions.rst:525

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEOpenIStream

.. oe:function:: OEOpenIStream

   .. oe:language:: c++ java csharp

      .. oe:api::

         oeistream* OEOpenIStream(const char *)

   .. oe:language:: python

      .. oe:api:: python

         OEOpenIStream(arg1: str) -> oeistream

   Creates and returns an :ref:`oeistream <OEPlatform_oeistream>` input stream
   capable of reading the input
   specified by the source parameter. The source parameter is
   initially parsed to determine whether a colon delimited protocol
   was specified. If no protocol was specified, it is assumed that the
   source parameter refers to a filename. If a protocol was specified,
   the function checks to see whether an input stream allocator and
   deallocator have been registered to handle the appropriate
   protocol. If the specified protocol has been registered, the
   appropriate input stream will be created and returned, otherwise
   the function will return ``0``. Allocators and deallocators for
   specific protocols can be registered using the
   :oe:func:`OEPlatform::OERegisterIStream` function.

   .. code-block:: c++

      oeistream *is = OEOpenIStream("pipe: echo \"hello world\"");

   In addition, this function will attempt to assess whether or not
   the input data is compressed. If the data is compressed in a
   supported format, the appropriate decompression wrapper stream will
   be used to dynamically decompress the data.

   .. warning::

      All streams created with this function MUST be closed with the
      :oe:func:`OEPlatform::OECloseIStream` function.



.. # split from OEPlatformFunctions.rst:560

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEOpenOStream

.. oe:function:: OEOpenOStream

   .. oe:language:: c++ java csharp

      .. oe:api::

         oeostream* OEOpenOStream(const char *)

   .. oe:language:: python

      .. oe:api:: python

         OEOpenOStream(arg1: str) -> oeostream

   Creates and returns an :ref:`oeostream <OEPlatform_oeostream>` output stream
   capable of writing to the
   specified target parameter. The target parameter is initially
   parsed to determine whether a colon delimited protocol was
   specified. If no protocol was specified, it is assumed that the
   target parameter refers to a filename. If a protocol was specified,
   the function checks to see whether an output stream allocator and
   deallocator have been registered to handle to the appropriate
   protocol. If the specified protocol has been registered, the
   appropriate output stream will be created and returned, otherwise
   the function will return ``0``. Allocators and deallocators for
   specific protocols can be registered using the
   :oe:func:`OEPlatform::OERegisterOStream` function.

   .. code-block:: c++

       oeostream *os = OEOpenOStream("pipe: uniq > output.txt");

   In addition, this function will attempt to assess whether or not
   the output data target expects compressed data. If the expected
   format is supported, the appropriate compression wrapper stream
   will be used to dynamically compress the data.

   .. warning::

      All streams created with this function MUST be closed with the
      :oe:func:`OEPlatform::OECloseOStream` function.



.. # split from OEPlatformFunctions.rst:594

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEProcessFileName

.. oe:function:: OEProcessFileName

   .. oe:api::

      std::string OEProcessFileName(const char *)



.. # split from OEPlatformFunctions.rst:601

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEProcessSystemCommand

.. oe:function:: OEProcessSystemCommand

   .. oe:api::

      std::string OEProcessSystemCommand(const char *)



.. # split from OEPlatformFunctions.rst:608

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OERegisterIStream

.. oe:function:: OERegisterIStream

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERegisterIStream(const char *, oeistream_alloc_t,
                                oeistream_dealloc_t)

   .. oe:language:: python

      .. oe:api:: python

         OERegisterIStream(arg1: str, arg2: oeistream_alloc_t,
                           arg3: oeistream_dealloc_t) -> bool



.. # split from OEPlatformFunctions.rst:615

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OERegisterOStream

.. oe:function:: OERegisterOStream

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERegisterOStream(const char *, oeostream_alloc_t,
                                oeostream_dealloc_t)

   .. oe:language:: python

      .. oe:api:: python

         OERegisterOStream(arg1: str, arg2: oeostream_alloc_t,
                           arg3: oeostream_dealloc_t) -> bool



.. # split from OEPlatformFunctions.rst:622

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OERenameFile

.. oe:function:: OERenameFile

   .. oe:api::

      bool OERenameFile(const char* oldfname, const char* newfname)

   Renames a file portably.  The 'oldfname' argument denotes the
   original file name, which is renamed to the filename specified by
   'newfname'. This function returns ``true`` upon success.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OESetAllocaThreshold

.. oe:function:: OESetAllocaThreshold

   .. oe:api::

      void OESetAllocaThreshold(oesize_t size)

   Sets the maximum number of bytes that can be allocated on the stack at once
   by alloca. If larger memory is requested than the set limit, then the 
   memory will be allocated on the heap.

   .. note::

      The default limit is 4096. Please only reduce the limit if necessary.
      Reducing the default limit can have significant 
      performance impact.

   .. seealso::

      :oe:func:`OEPlatform::OEGetAllocaThreshold` function


.. # split from OEPlatformFunctions.rst:632

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OESetLicenseFile

.. oe:function:: OESetLicenseFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESetLicenseFile(const char* fname)

   .. oe:language:: python

      .. oe:api:: python

         OESetLicenseFile(fname: str) -> None

   Set the OpenEye license file to use to perform license checks. This
   can be used instead setting the ``OE_LICENSE`` environment variable.

   .. oe:language:: python

      .. note::

         Although *OEChem* can be imported without a license check
         other OpenEye libraries may perform their license check at
         load time. Therefore, this function should be used before
         importing those libraries, for example:

         .. code-block:: python

            from openeye.oechem import *
            OESetLicenseFile("/usr/local/openeye/oe_license.txt")
            from openeye.oespicoli import *



.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OESleep

.. oe:function:: OESleep

   .. oe:language:: c++

      .. oe:api::

         void OESleep(unsigned long milliseconds)

      Suspends execution of the current process (or thread) for at least
      the specified number of milliseconds.

   .. oe:language:: csharp java python

      This function is only available in C++.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEToolkitsGetRelease

.. oe:function:: OEToolkitsGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToolkitsGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEToolkitsGetRelease() -> str

   Returns the release name of the overall toolkits being used.  This
   returns a string of the form ``YYYY.Mon.V``, where

      * ``YYYY`` is the four-digit year

      * ``Mon`` is a month (e.g. Jan, Feb, etc.)

      * ``V`` is a single digit version number (1-9)

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`oecheminfo.cpp<section_example_oechem_oecheminfo>`

  .. oe:language:: python

      * Example program :ref:`oecheminfo.py<section_example_oechem_oecheminfo>`

  .. oe:language:: java

      * Example program :ref:`OEChemInfo.java<section_example_oechem_oecheminfo>`

  .. oe:language:: csharp

      * Example program :ref:`OEChemInfo.cs<section_example_oechem_oecheminfo>`



.. # split from OEPlatformFunctions.rst:667

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEUncompress

.. oe:function:: OEUncompress

   .. oe:api::

      bool OEUncompress(std::string& dst, const std::string& src,
                        const char* fmt = "gz")
      bool OEUncompress(std::string& dst, const char* src, size_t size,
                        const char* fmt = "gz")

   Uncompresses the data in the compressed data buffer, ``src``, 
   using the specified compression format, ``fmt``, and stores the uncompressed
   data in the uncompressed string ``dst``. Returns whether or not the
   specified compression format was available and if the data was
   successfully uncompressed using that format.



.. # split from OEPlatformFunctions.rst:680

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEUnlink

.. oe:function:: OEUnlink

   .. oe:api::

      bool OEUnlink(const char* fname)

   Deletes or renames a file portably.
   Deleting a file that is still open by a process
   results in implementation defined behavior. This function returns
   ``true`` upon success.



.. # split from OEPlatformFunctions.rst:691

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: OEUnlinkDirectory

.. oe:function:: OEUnlinkDirectory

   .. oe:api::

      bool OEUnlinkDirectory(const char* dname)

   Deletes or renames a directory portably.
   All files and subdirectories of the given directory
   should be deleted before calling this function. This function
   returns ``true`` upon success.



.. _chapter_oeplatform_functions:

*******************************************************************************
OEPlatform Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEAddLicenseData.rst
   OEAddLicenseFromHttp.rst
   OEAddLicenseKey.rst
   OEBigEndian.rst
   OECloseIStream.rst
   OECloseOStream.rst
   OECompressionAvailable.rst
   OECompress.rst
   OECreateDirectory.rst
   OECurrentTime.rst
   oeendl.rst
   oeends.rst
   oeflush.rst
   OEFileCorrectSeparators.rst
   OEFileCreate.rst
   OEFileDelete.rst
   OEFileDetermineName.rst
   OEFileDeterminePathAndName.rst
   OEFileDeterminePath.rst
   OEFileExists.rst
   OEFileIsDirectory.rst
   OEFileIsFile.rst
   OEFileIsLink.rst
   OEFileIsReadable.rst
   OEFileIsWritable.rst
   OEFileRandomName.rst
   OEFileSize.rst
   OEFileTempDescriptor.rst
   OEFileTempDirectory.rst
   OEFileTempPath.rst
   OEGetAbsolutePath.rst
   OEGetAllocaThreshold.rst
   OEGetCurrentWorkingDirectory.rst
   OEGetDomainName.rst
   OEGetHostIdent.rst
   OEGetHostName.rst
   OEGetIPAddress.rst
   OEGetMachineName.rst
   OEGetNumProcessors.rst
   OEGetPlatformInfo.rst
   OEGetProcessMemUsage.rst
   OEGetProcessorInfo.rst
   OEGetTimeOfDay.rst
   OEGetUserAppDataDir.rst
   OEGetUserDocumentsDir.rst
   OEGetUserHomeDir.rst
   OEGetUserName.rst
   OEIsNaN.rst
   OEIsNormalNum.rst
   OELocalTime.rst
   OEOpenIStream.rst
   OEOpenOStream.rst
   OEProcessFileName.rst
   OEProcessSystemCommand.rst
   OERegisterIStream.rst
   OERegisterOStream.rst
   OERenameFile.rst
   OESetAllocaThreshold.rst
   OESetLicenseFile.rst
   OESleep.rst
   OEToolkitsGetRelease.rst
   OEUncompress.rst
   OEUnlinkDirectory.rst
   OEUnlink.rst


.. # split from OEPlatformFunctions.rst:702

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeendl

.. oe:function:: oeendl

   .. oe:api::

      oeostream& oeendl(oeostream &)

   Pushes a newline character onto the specified output stream and
   then flushes that stream.

   .. oe:language:: c++

      This is equivalent to the ``std::endl`` function.



.. # split from OEPlatformFunctions.rst:715

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OEPlatform

.. meta::
   :keywords: oeends

.. oe:function:: oeends

   .. oe:api::

      oeostream& oeends(oeostream &)

   Pushes a null character onto the specified output stream.

   .. oe:language:: c++

      This is equivalent to the ``std::ends`` function.



.. meta::
   :keywords: oeflush

.. oe:namespace:: OEPlatform

.. oe:function:: oeflush

   .. oe:api::

      oeostream& oeflush(oeostream &)

   Flushes the specified output stream.

   .. oe:language:: c++

      This is equivalent to the ``std::flush`` function.



.. oe:namespace:: OESystem

.. meta::
   :keywords: IsFalse, IsFalse

.. _OESystem_IsFalse:

.. oe:class:: IsFalse

   .. warning::

      ``IsFalse`` is deprecated. Please use :ref:`OEIsFalse <OESystem_OEIsFalse>` instead.

   .. oe:api::

      template<class T> class IsFalse : public OEIsFalse<T>

   The following methods are publicly inherited from :ref:`OEIsFalse <OESystem_OEIsFalse>`:

   ====================================================== ====================================================== =====================================================
   :oe:meth:`operator()<OESystem::OEIsFalse::operator()>` :oe:meth:`CreateCopy<OESystem::OEIsFalse::CreateCopy>`                                                      
   ====================================================== ====================================================== =====================================================

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================


.. oe:namespace:: OESystem

.. meta::
   :keywords: IsTrue, IsTrue

.. _OESystem_IsTrue:

.. oe:class:: IsTrue

   .. warning::

      ``IsTrue`` is deprecated. Please use :ref:`OEIsTrue <OESystem_OEIsTrue>` instead.

   .. oe:api::

      template<class T> class IsTrue : public OEIsTrue<T>

   The following methods are publicly inherited from :ref:`OEIsTrue <OESystem_OEIsTrue>`:

   ===================================================== ===================================================== ====================================================
   :oe:meth:`operator()<OESystem::OEIsTrue::operator()>` :oe:meth:`CreateCopy<OESystem::OEIsTrue::CreateCopy>`                                                     
   ===================================================== ===================================================== ====================================================

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAnd

.. _OESystem_OEAnd:

.. oe:class:: OEAnd

   .. oe:api::

      template<class Arg>
      class OEAnd : public OEUnaryPredicate<Arg>

   This class represents `OEAnd`.

   This class template is a composition predicate which generates a predicate
   which is the logical *and* operation of the two predicates passed as
   arguments.

   .. seealso::

    * :ref:`section_predicates_composition_functors` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:language:: python java csharp

      The following specializations exist for this template:

      ==================== =====================================================
      OEAndAtom            OESystem::OEAnd<OEChem::OEAtomBase>
      OEAndBond            OESystem::OEAnd<OEChem::OEBondBase>
      OEAndConf            OESystem::OEAnd<OEChem::OEConfBase>
      OEAndGroup           OESystem::OEAnd<OEChem::OEGroupBase>
      OEAndRoleSet         OESystem::OEAnd<OEChem::OERoleSet>
      OEAndInteractionHint OESystem::OEAnd<OEChem::OEInteractionHint>
      ==================== =====================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEAnd()
         OEAnd(const OEAnd& rhs)
         OEAnd(const OEUnaryPredicate<Arg>& func1,
               const OEUnaryPredicate<Arg>& func2)

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAnd& operator=(const OEAnd& rhs)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const Arg& arg) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg: Arg) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUnaryFunction<Arg, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAnd



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAnnotation, Annotation

.. _OESystem_OEAnnotation:

.. oe:class:: OEAnnotation

   .. oe:api::

      class OEAnnotation : public OESystem::OEBase

   This class represents `OEAnnotation`.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAnnotation()
            OEAnnotation(const OEAnnotation& rhs)
            OEAnnotation(unsigned int type, const char* title = 0)

      .. oe:language:: python

         .. oe:api:: python

            OEAnnotation() -> OEAnnotation
            OEAnnotation(type: int, title: str = None) -> OEAnnotation
            OEAnnotation(rhs: OEAnnotation) -> OEAnnotation

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAnnotation &operator=(const OEAnnotation &rhs)

      Assignment operator.

   .. oe:method:: AddChild

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddChild(const OEAnnotation& child)

      .. oe:language:: python

         .. oe:api:: python

            AddChild(child: OEAnnotation) -> None

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

   .. oe:method:: GetChildren

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEAnnotation>* GetChildren() const

      .. oe:language:: python

         .. oe:api:: python

            GetChildren() -> Iterable[OEAnnotation]

   .. oe:method:: GetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEColor GetColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> OEColor

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

   .. oe:method:: GetRenderHint

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRenderHint() const

      .. oe:language:: python

         .. oe:api:: python

            GetRenderHint() -> int

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

   .. oe:method:: GetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetType() const

      .. oe:language:: python

         .. oe:api:: python

            GetType() -> int

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void* type) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(type: void) -> bool

   .. oe:method:: SetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAnnotation& SetColor(const OESystem::OEColor &)

      .. oe:language:: python

         .. oe:api:: python

            SetColor(arg2: OEColor) -> OEAnnotation

   .. oe:method:: SetRenderHint

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAnnotation& SetRenderHint(unsigned int hint)

      .. oe:language:: python

         .. oe:api:: python

            SetRenderHint(hint: int) -> OEAnnotation

   .. oe:method:: SetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTitle(const char *)

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(arg2: str) -> None

   .. oe:method:: SetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetType(type: int) -> None



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBInitializer, BInitializer

.. attention::

   |CPPONLY|

.. _OESystem_OEBInitializer:

.. oe:class:: OEBInitializer

   .. oe:api::

      template<OEBHandInitializer INIT>
      class OEBInitializer

   .. oe:method:: Constructors

      .. oe:api::

         OEBInitializer()

      Default constructor



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBase

.. _OESystem_OEBase:

.. oe:class:: OEBase

   .. oe:api::

      class OEBase

   This class represents `OEBase`.

   The abstract class :ref:`OEBase <OESystem_OEBase>` defines the interface for run-time class
   extensibility and run-time type identification. Classes which
   derive from :ref:`OEBase <OESystem_OEBase>` can store and retrieve data by association with
   integer or character string 'tag' identifiers.

   .. oe:language:: c++

      All primitive data types and user-defined classes which have valid copy constructors
      and assignment operators can be stored through the mechanism
      provided by :ref:`OEBase <OESystem_OEBase>`.

   .. oe:language:: python java csharp

      All primitive data types can be stored through the mechanism provided by
      :ref:`OEBase <OESystem_OEBase>`.

   The following classes derive from this class:

    * :ref:`OEAtomBase <OEChem_OEAtomBase>`
    * :ref:`OEBondBase <OEChem_OEBondBase>`
    * :ref:`OEConfBase <OEChem_OEConfBase>`
    * :ref:`OEGraphMol <OEChem_OEGraphMol>`
    * :ref:`OEMCMolBase <OEChem_OEMCMolBase>`
    * :ref:`OEMolBase <OEChem_OEMolBase>`
    * :ref:`OEQAtomBase <OEChem_OEQAtomBase>`
    * :ref:`OEQBondBase <OEChem_OEQBondBase>`
    * :ref:`OEQMolBase <OEChem_OEQMolBase>`
    * :ref:`OEAnnotation <OESystem_OEAnnotation>`
    * :ref:`OEBinaryIOHandler <OESystem_OEBinaryIOHandler>`
    * :ref:`OEBinaryIOHandlerBase <OESystem_OEBinaryIOHandlerBase>`
    * :ref:`OEContainer <OESystem_OEContainer>`
    * :ref:`OEFixedGrid <OESystem_OEFixedGrid>`
    * :ref:`OEFixedMultiGrid <OESystem_OEFixedMultiGrid>`
    * :ref:`OEGaussian <OESystem_OEGaussian>`
    * :ref:`OEGaussianBase <OESystem_OEGaussianBase>`
    * :ref:`OEGaussianContainer <OESystem_OEGaussianContainer>`
    * :ref:`OEGaussianContainerBase <OESystem_OEGaussianContainerBase>`
    * :ref:`OEGrid <OESystem_OEGrid>`
    * :ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>`
    * :ref:`OEGridBase <OESystem_OEGridBase>`
    * :ref:`OEHeader <OESystem_OEHeader>`
    * :ref:`OEMultiGrid <OESystem_OEMultiGrid>`
    * :ref:`OEScalarGrid <OESystem_OEScalarGrid>`
    * :ref:`OESkewGrid <OESystem_OESkewGrid>`

   .. oe:method:: Constructors

      .. oe:api::

         OEBase()
         OEBase(const OEBase& rhs)

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBase& operator=(const OEBase &)

      Assignment operator.

   .. oe:method:: operator+=
      :language: c++ java csharp

      .. oe:api::

         OEBase& operator+=(const OEBase &)

   .. oe:method:: AddBaseData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddBaseData(const OEBaseData *)

      .. oe:language:: python

         .. oe:api:: python

            AddBaseData(arg2: OEBaseData) -> bool

   .. oe:method:: AddData

      .. oe:language:: c++ java csharp

         .. oe:api::

            template<typename T>
            bool AddData(const char* tag, const T t)
            template<typename T>
            bool AddData(unsigned int tag, const T t)

      .. oe:language:: python

         .. oe:api:: python

            AddData(tag: str, data: object) -> bool

      Stores and associates a copy of the data
      passed as the second argument with the 'tag' identifier given as
      the first argument. Integer tags should be allocated using the
      :oe:func:`OESystem::OEGetTag` function. Multiple calls to
      :oe:meth:`OESystem::OEBase::AddData` of a
      :ref:`OEBase <OESystem_OEBase>` derived class instance will result in multiple copies of
      data being stored. The :oe:meth:`OESystem::OEBase::AddData` method
      does not overwrite data
      stored by previous calls.

      .. oe:language:: c++ java csharp

         .. oe:api::

            template<typename T>
            bool AddData(const char* tag, const T t, unsigned int len)
            template<typename T>
            bool AddData(unsigned int tag, const T t, unsigned int len)

      .. oe:language:: python

         .. oe:api:: python

            AddData(tag: str, data: object) -> bool

      Stores and associates a copy of the data
      pointed to by the second argument with the 'tag' identifier given
      as the first argument. The third argument passed to the method
      is used to denote the length of the array pointed to by the
      second argument. The array length must be specified so that
      data can be copied directly. Integer tags should be allocated
      using the :oe:func:`OESystem::OEGetTag` function. Multiple calls to
      :oe:meth:`OESystem::OEBase::AddData` of a :ref:`OEBase <OESystem_OEBase>`
      derived class instance will result in
      multiple copies of data being stored. The
      :oe:meth:`OESystem::OEBase::AddData` method does
      not overwrite data stored by previous calls.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Clears all data stored using the :oe:meth:`OESystem::OEBase::AddData` and
      :oe:meth:`OESystem::OEBase::SetData` methods.
      When writing classes derived from :ref:`OEBase <OESystem_OEBase>` the
      :oe:meth:`OESystem::OEBase::Clear` method should be chained to call
      the parent class :oe:meth:`OESystem::OEBase::Clear` method.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

      This pure virtual copy constructor should return a deep copy of
      the :ref:`OEBase <OESystem_OEBase>` derived object. The copy of the object returned is
      dynamically allocated and should be deallocated using the C++
      delete operator.

   .. oe:method:: DeleteData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteData(const char* tag)
            bool DeleteData(unsigned int tag)

      .. oe:language:: python

         .. oe:api:: python

            DeleteData(tag: str) -> bool
            DeleteData(tag: int) -> bool

      Deletes all instances of data stored with the
      :oe:meth:`OESystem::OEBase::AddData` and :oe:meth:`OESystem::OEBase::SetData`
      methods which are associated with the data
      'tag' passed to the method. The method will return ``true`` if any
      data was deleted, and ``false`` if not data associated with the
      data tag was found.

   .. oe:method:: GetBoolData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetBoolData(const char* tag) const
            bool GetBoolData(unsigned int tag) const

      .. oe:language:: python

         .. oe:api:: python

            GetBoolData(tag: str) -> bool
            GetBoolData(tag: int) -> bool

      Returns the first instance of boolean data stored
      previously with the associated data tag. This method is
      equivalent to calling the :oe:meth:`OESystem::OEBase::GetData`
      method with template argument bool.

   .. oe:method:: GetData

      .. oe:language:: c++ java csharp

         .. oe:api::

            template<typename T>
            const T& GetData(const char* tag) const
            template<typename T>
            const T& GetData(unsigned int tag) const

      .. oe:language:: python

         .. oe:api:: python

            GetData() -> dict
            GetData(tag: str) -> PyObject
            GetData(t: int) -> PyObject

      Returns the first instance of data stored
      previously with the associated data tag. Integer tags should be
      allocated using the :oe:func:`OESystem::OEGetTag` function. Run-time
      type checking is performed when data is requested. A data type
      mismatch between the storage and request types will result in a
      default data instance being returned instead of the original
      data. Request for datum not present will also result in a
      default data instance being returned.

   .. oe:method:: GetDataIter

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESystem::OEBaseData>* GetDataIter() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataIter() -> OEBaseDataIter

      Returns an iterator over data stored in an
      :ref:`OEBase <OESystem_OEBase>` derived class instance. Data tag identification,
      run-time type checking, and data retrieval can be performed
      using the :ref:`OEBaseData <OESystem_OEBaseData>` API.

      .. seealso::

         * :ref:`OEBaseDataT <OESystem_OEBaseDataT>` template class

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESystem::OEBaseData>* GetDataIter(unsigned int tag) const

      .. oe:language:: python

         .. oe:api:: python

            GetDataIter(tag: int) -> OEBaseDataIter

      Returns an iterator over all generic data attached to the
      :ref:`OEBase <OESystem_OEBase>` object with the given data *tag*.

      .. seealso::

         * :ref:`OEBaseDataT <OESystem_OEBaseDataT>` template class

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

      This pure virtual function is used to perform run-time type
      identification. The value returned by the method should be
      equivalent to the value returned by :oe:func:`OESystem::OEGetDataType`
      using the derived class type as the template argument.

   .. oe:method:: GetDoubleData

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDoubleData(const char* tag) const
            double GetDoubleData(unsigned int tag) const

      .. oe:language:: python

         .. oe:api:: python

            GetDoubleData(tag: str) -> float
            GetDoubleData(tag: int) -> float

      Returns the first instance of double precision
      floating point data stored previously with the associated data
      tag. This method is equivalent to calling the
      :oe:meth:`OESystem::OEBase::GetData` method
      with template argument ``double``.

   .. oe:method:: GetFloatData

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetFloatData(const char* tag) const
            float GetFloatData(unsigned int tag) const

      .. oe:language:: python

         .. oe:api:: python

            GetFloatData(tag: str) -> float
            GetFloatData(tag: int) -> float

      Returns the first instance of single precision
      floating point data stored previously with the associated data
      tag. This method is equivalent to calling the
      :oe:meth:`OESystem::OEBase::GetData` method
      with template argument ``float``.

   .. oe:method:: GetIntData

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetIntData(const char* tag) const
            int GetIntData(unsigned int tag) const

      .. oe:language:: python

         .. oe:api:: python

            GetIntData(tag: str) -> int
            GetIntData(tag: int) -> int

      Returns the first instance of integer data stored
      previously with the associated data tag. This method is
      equivalent to calling the :oe:meth:`OESystem::OEBase::GetData`
      method with template argument ``int``.

   .. oe:method:: GetStringData

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetStringData(const char* tag) const
            const std::string& GetStringData(unsigned int tag) const

      .. oe:language:: python

         .. oe:api:: python

            GetStringData(tag: str) -> str
            GetStringData(tag: int) -> str

      Returns the first instance of an STL string stored
      previously with the associated data tag. This method is
      equivalent to calling the :oe:meth:`OESystem::OEBase::GetData`
      method with template argument ``std::string``.

   .. oe:method:: HasData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasData(const char* tag) const
            bool HasData(unsigned int tag) const

      .. oe:language:: python

         .. oe:api:: python

            HasData(tag: str) -> bool
            HasData(tag: int) -> bool

      Returns ``true`` if any data stored in an :ref:`OEBase <OESystem_OEBase>`
      derived object is associated with a particular data tag
      identifier. If no stored data is associated with the passed data
      'tag' the methods return ``false``.

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

      This method is used for run-time type identification of :ref:`OEBase <OESystem_OEBase>`
      derived classes. The const void pointer argument passed to the
      function should be a value returned by the template function
      :oe:func:`OESystem::OEGetDataType`. The :oe:meth:`OESystem::OEBase::IsDataType`
      method will return
      ``true`` if the data type identifier passed to the function matches
      at least one of the data types in the inheritance tree of the
      requested :ref:`OEBase <OESystem_OEBase>` derived object. The method will return ``false``
      if the data type identifier passed to the method fails to match
      any class type in the inheritance tree of the requested :ref:`OEBase <OESystem_OEBase>`
      derived object. Implementations of this pure virtual method
      should chain to their parent class' :oe:meth:`OESystem::OEBase::IsDataType`
      method.

   .. oe:method:: SetBaseData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBaseData(const OEBaseData *)

      .. oe:language:: python

         .. oe:api:: python

            SetBaseData(arg2: OEBaseData) -> bool

   .. oe:method:: SetBoolData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBoolData(const char* tag, bool t)
            bool SetBoolData(unsigned int tag, bool t)

      .. oe:language:: python

         .. oe:api:: python

            SetBoolData(tag: str, t: bool) -> bool
            SetBoolData(tag: int, t: bool) -> bool

      Stores boolean values associated with the passed data
      'tag' identifiers. The methods are equivalent to the
      :oe:meth:`OESystem::OEBase::SetData` method
      called with a boolean value.

   .. oe:method:: SetData

      .. oe:language:: c++ java csharp

         .. oe:api::

            template<typename T>
            bool SetData(const char* tag, const T t)
            template<typename T>
            bool SetData(unsigned int tag, const T t)

      .. oe:language:: python

         .. oe:api:: python

            SetData(tag: str, data: object) -> bool

      Stores a copy of primitive or user-defined
      data passed as the second argument with a data 'tag' identifier
      passed as the first argument. If data of the same type has been
      stored using the identical tag in a previous
      :oe:meth:`OESystem::OEBase::AddData` or :oe:meth:`OESystem::OEBase::SetData`
      call, subsequent calls to :oe:meth:`OESystem::OEBase::SetData` will
      overwrite the first instance
      of data stored with the data tag. If a call to SetData succeeds in
      storing or overwriting previously stored data the method will
      return ``true``. :oe:meth:`OESystem::OEBase::SetData` will return
      ``false`` if a copy of the data cannot
      be made. If data has been stored previously associated with a data
      tag, subsequent calls to :oe:meth:`OESystem::OEBase::SetData` with
      the identical data 'tag' but
      with different data type will result in a run-time warning being
      written and a return value of ``false``. Note that these methods will
      not make copies of data passed by pointer. Values to be passed by
      pointer, or arrays, should be stored using the following
      :oe:meth:`OESystem::OEBase::SetData`
      methods.

      .. oe:language:: c++ java csharp

         .. oe:api::

            template<typename T>
            bool SetData(const char* tag, const T t, unsigned int len)
            template<typename T>
            bool SetData(unsigned int tag, const T t, unsigned int len)

      .. oe:language:: python

         .. oe:api:: python

            SetData(tag: str, data: object) -> bool

      Stores copies of arrays of primitive or
      user-defined data passed as the second argument with a data tag
      identifier passed as the first argument. The length of the array
      (number of elements) is passed as the third argument to the
      method. If data of the same type has been stored using the
      identical 'tag' in a previous :oe:meth:`OESystem::OEBase::AddData` or
      :oe:meth:`OESystem::OEBase::SetData` call, subsequent
      calls to :oe:meth:`OESystem::OEBase::SetData` will overwrite the
      first instance of data
      stored with the data tag. The array copy stored previously will
      be deallocated and a copy of the new array will be stored. If a
      call to :oe:meth:`OESystem::OEBase::SetData` succeeds in storing
      or overwriting an array
      stored previously the method will return ``true``.
      :oe:meth:`OESystem::OEBase::SetData` will
      return ``false`` if a copy of the data cannot be made. If data has
      been stored previously associated with a data tag, subsequent
      calls to :oe:meth:`OESystem::OEBase::SetData` with the identical data
      'tag' but with different
      data type will result in a run-time warning being written and a
      return value of ``false``.

   .. oe:method:: SetDoubleData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDoubleData(const char* tag, double t)
            bool SetDoubleData(unsigned int tag, double t)

      .. oe:language:: python

         .. oe:api:: python

            SetDoubleData(tag: str, t: float) -> bool
            SetDoubleData(tag: int, t: float) -> bool

      Stores and associates double precision floating
      point values passed as the second argument with the data tag
      provided as the first argument. The methods are provided for
      convenience and are functionally equivalent to calls to
      :oe:meth:`OESystem::OEBase::SetData`
      where the template argument is a double precision floating point
      number.

   .. oe:method:: SetFloatData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFloatData(const char* tag, float t)
            bool SetFloatData(unsigned int tag, float t)

      .. oe:language:: python

         .. oe:api:: python

            SetFloatData(tag: str, t: float) -> bool
            SetFloatData(tag: int, t: float) -> bool

      Stores and associates single precision floating
      point values passed as the second argument with the data tag
      provided as the first argument. The methods are provided for
      convenience and are functionally equivalent to calls to
      :oe:meth:`OESystem::OEBase::SetData`
      where the template argument is a single precision floating point
      number.

   .. oe:method:: SetIntData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIntData(const char* tag, int t)
            bool SetIntData(unsigned int tag, int t)

      .. oe:language:: python

         .. oe:api:: python

            SetIntData(tag: str, t: int) -> bool
            SetIntData(tag: int, t: int) -> bool

      Stores and associates integer values passed as the
      second argument with the data 'tag' provided as the first
      argument. The methods are provided for convenience and are
      functionally equivalent to calls to
      :oe:meth:`OESystem::OEBase::SetData` where the template
      argument is an integer value.

   .. oe:method:: SetStringData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStringData(const char* tag, const std::string t)
            bool SetStringData(unsigned int tag, const std::string t)

      .. oe:language:: python

         .. oe:api:: python

            SetStringData(tag: str, t: str) -> bool
            SetStringData(tag: int, t: str) -> bool

      Stores and associates ``std::string`` passed as the
      second argument with the data 'tag' provided as the first
      argument. The methods are provided for convenience and are
      functionally equivalent to calls to :oe:meth:`OESystem::OEBase::SetData`
      where the template argument is a ``std::string``.



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBaseData, BaseData

.. _OESystem_OEBaseData:

.. oe:class:: OEBaseData

   .. oe:api::

      class OEBaseData

   :ref:`OEBaseData <OESystem_OEBaseData>` is an abstract class which defines the interface
   necessary for storage, retrieval, and duplication of data stored
   through the generic data interface in the :ref:`OEBase <OESystem_OEBase>`
   class. Data stored in classes derived from :ref:`OEBaseData <OESystem_OEBaseData>` is identified
   through data tags. The ability to perform run-time type checking is
   also built into the class.

   The following classes derive from this class:

    * :ref:`OEBaseDataT <OESystem_OEBaseDataT>`
    * :ref:`OEBaseDataTPtr <OESystem_OEBaseDataTPtr>`

   .. note::

      :ref:`OEBaseData <OESystem_OEBaseData>` is an abstract class. Methods for accessing
      and setting generic data are implemented in its derived class
      :ref:`OEBaseDataT <OESystem_OEBaseDataT>`.

   .. seealso::

      * :oe:meth:`OESystem::OEBaseDataT::GetData` method instead.
      * :oe:meth:`OESystem::OEBaseDataT::SetData` method instead.

   .. oe:method:: Constructors

      .. oe:api::

         OEBaseData(unsigned int tag)

      Constructs and instance of :ref:`OEBaseData <OESystem_OEBaseData>` and set the data identifier
      tag upon construction.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBaseData* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBaseData

      This pure virtual copy constructor should return a deep copy of
      the :ref:`OEBaseData <OESystem_OEBaseData>` object. The copy of the object returned is not
      memory-managed by the parent instance. It is the responsibility
      of the programmer to manage the memory created and returned by
      this method.

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

      This pure virtual method returns a unique type identifier for
      the data type being stored. The return value of the method is
      equivalent to the return value of :oe:func:`OESystem::OEGetDataType`
      for the stored type.

   .. oe:method:: GetSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSize() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetSize() -> int

      This pure virtual method is used to return the number of
      elements if the data stored in an :ref:`OEBaseData <OESystem_OEBaseData>` derived
      class is an array.

      .. note::

         The value returned is the number of elements in
         the array, not the number of bytes occupied by the data.

   .. oe:method:: GetTag

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetTag() const

      .. oe:language:: python

         .. oe:api:: python

            GetTag() -> int

      Returns the integer data tag with which the data was
      stored.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBaseDataT, BaseDataT

.. _OESystem_OEBaseDataT:

.. oe:class:: OEBaseDataT

   .. oe:api::

      template<class T>
      class OEBaseDataT : public OEBaseData

   This class represents `OEBaseDataT`.

   The following methods are publicly inherited from :ref:`OEBaseData <OESystem_OEBaseData>`:

   ========================================================= ======================================================== ========================================================
   :oe:meth:`CreateCopy<OESystem::OEBaseData::CreateCopy>`   :oe:meth:`GetSize<OESystem::OEBaseData::GetSize>`
   :oe:meth:`GetDataType<OESystem::OEBaseData::GetDataType>` :oe:meth:`GetTag<OESystem::OEBaseData::GetTag>`
   ========================================================= ======================================================== ========================================================

   The following specializations exist for this template:

    * OESystem::OEBaseDataT< int >

   The following classes derive from this class:
    * :ref:`OEBaseDataTPtr <OESystem_OEBaseDataTPtr>`

   .. oe:method:: Constructors

      .. oe:api::

         OEBaseDataT(unsigned int tag, const T& t)

      Constructs an :ref:`OEBaseDataT <OESystem_OEBaseDataT>` object that
      stores data with ``T`` type associated with
      the given ``tag`` identifier.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBaseDataT<T>& operator=(const OEBaseDataT<T>& t)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBaseData* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBaseDataT

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBaseDataT <OESystem_OEBaseDataT>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: GetData

      .. oe:api::

         T& GetData()
         const T& GetData() const

      Returns the data stored int the :ref:`OEBaseDataT <OESystem_OEBaseDataT>` object.

   .. oe:method:: GetDataType

      .. oe:api::

         const void* GetDataType() const

      Returns a unique type identifier for the data type being stored.
      The return value of the method is
      equivalent to the return value of :oe:func:`OESystem::OEGetDataType`
      for the stored type.

   .. oe:method:: GetSize

      .. oe:api::

         unsigned int GetSize() const

      Returns the number of elements stored in the an
      :ref:`OEBaseDataT <OESystem_OEBaseDataT>` object that is always ``1``.

      .. note::

         The value returned is not the number of bytes occupied by the data.

   .. oe:method:: SetData

      .. oe:api::

         bool SetData(const T& t)

      Sets the data stored int the :ref:`OEBaseDataT <OESystem_OEBaseDataT>` object.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBaseDataTPtr, BaseDataTPtr

.. _OESystem_OEBaseDataTPtr:

.. oe:class:: OEBaseDataTPtr

   .. oe:api::

      template<class T>
      class OEBaseDataTPtr : public OEBaseDataT<T>

   This class represents `OEBaseDataTPtr`.

   The following methods are publicly inherited from :ref:`OEBaseDataT <OESystem_OEBaseDataT>`:

   ========================================================= ========================================================== =========================================================
   :oe:meth:`operator=<OESystem::OEBaseDataT::operator=>`    :oe:meth:`GetData<OESystem::OEBaseDataT::GetData>`         :oe:meth:`GetSize<OESystem::OEBaseDataT::GetSize>`       
   :oe:meth:`CreateCopy<OESystem::OEBaseDataT::CreateCopy>`  :oe:meth:`GetDataType<OESystem::OEBaseDataT::GetDataType>` :oe:meth:`SetData<OESystem::OEBaseDataT::SetData>`       
   ========================================================= ========================================================== =========================================================

   The following methods are publicly inherited from :ref:`OEBaseData <OESystem_OEBaseData>`:

   ========================================================= ======================================================== ========================================================
   :oe:meth:`CreateCopy<OESystem::OEBaseData::CreateCopy>`   :oe:meth:`GetSize<OESystem::OEBaseData::GetSize>`                                                                
   :oe:meth:`GetDataType<OESystem::OEBaseData::GetDataType>` :oe:meth:`GetTag<OESystem::OEBaseData::GetTag>`                                                                  
   ========================================================= ======================================================== ========================================================

   The following specializations exist for this template:
   
    * OESystem::OEBaseDataTPtr< OEBase * >
    * OESystem::OEBaseDataTPtr< T * >
   



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBinaryAnd, BinaryAnd

.. _OESystem_OEBinaryAnd:

.. oe:class:: OEBinaryAnd

   .. oe:api::

      template<class Arg1, class Arg2>
      class OEBinaryAnd : public OEBinaryPredicate<Arg1, Arg2>

   This class represents `OEBinaryAnd`.

   The following methods are publicly inherited from :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>`:

   =============================================================================== =============================================================================== ================================================================================
   :oe:meth:`operator()<OESystem::OEBinaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEBinaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEBinaryPredicate::CreatePredicateCopy>`
   =============================================================================== =============================================================================== ================================================================================

   The following methods are publicly inherited from :ref:`OEBinaryFunction <OESystem_OEBinaryFunction>`:

   ============================================================= ============================================================= ============================================================
   :oe:meth:`operator()<OESystem::OEBinaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEBinaryFunction::CreateCopy>`                                                             
   ============================================================= ============================================================= ============================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEBinaryAnd()
         OEBinaryAnd(const OEBinaryAnd& rhs)
         OEBinaryAnd(const OEBinaryPredicate<Arg1, Arg2>& func1,
                     const OEBinaryPredicate<Arg1, Arg2>& func2)

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBinaryAnd& operator=(const OEBinaryAnd& rhs)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const Arg1& arg1, const Arg2& arg2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg1: Arg1, arg2: Arg2) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBinaryFunction<Arg1, Arg2, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBinaryAnd



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBinaryFalse, BinaryFalse

.. _OESystem_OEBinaryFalse:

.. oe:class:: OEBinaryFalse

   .. oe:api::

      template<class T, class U>
      class OEBinaryFalse : public OEBinaryPredicate<T, U>

   A functor to always return ``false``. 

   The following methods are publicly inherited from :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>`:

   =============================================================================== =============================================================================== ================================================================================
   :oe:meth:`operator()<OESystem::OEBinaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEBinaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEBinaryPredicate::CreatePredicateCopy>`
   =============================================================================== =============================================================================== ================================================================================

   The following methods are publicly inherited from :ref:`OEBinaryFunction <OESystem_OEBinaryFunction>`:

   ============================================================= ============================================================= ============================================================
   :oe:meth:`operator()<OESystem::OEBinaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEBinaryFunction::CreateCopy>`                                                             
   ============================================================= ============================================================= ============================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const T &, const U &)
            bool operator()(const T &, const U &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(T, U) -> bool

   Always returns ``false``.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<T, U, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBinaryFalse



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBinaryFunction, BinaryFunction

.. _OESystem_OEBinaryFunction:

.. oe:class:: OEBinaryFunction

   .. oe:api::

      template<class Arg1, class Arg2, class Result, bool ConstArg, bool ConstFcn>
      class OEBinaryFunction

   This class represents `OEBinaryFunction`.

   

   The following specializations exist for this template:
   
    * OESystem::OEBinaryFunction< Arg1, Arg2, Result, false, false >
    * OESystem::OEBinaryFunction< Arg1, Arg2, Result, false, true >
    * OESystem::OEBinaryFunction< Arg1, Arg2, Result, true, false >
   

   The following classes derive from this class:
    * :ref:`OEInSamePart <OEChem_OEInSamePart>`
    * :ref:`OEUnaryToBinaryAnd <OEChem_OEUnaryToBinaryAnd>`
    * :ref:`OEUnaryToBinaryOr <OEChem_OEUnaryToBinaryOr>`
    * :ref:`OEBinaryAnd <OESystem_OEBinaryAnd>`
    * :ref:`OEBinaryFalse <OESystem_OEBinaryFalse>`
    * :ref:`OEBinaryNot <OESystem_OEBinaryNot>`
    * :ref:`OEBinaryOr <OESystem_OEBinaryOr>`
    * :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>`
   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            Result operator()(const Arg1& a1, const Arg2& a2) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(a1: Arg1, a2: Arg2) -> Result

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBinaryFunction



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBinaryIOHandler, BinaryIOHandler

.. _OESystem_OEBinaryIOHandler:

.. oe:class:: OEBinaryIOHandler

   .. oe:api::

      class OEBinaryIOHandler : public OEBinaryIOHandlerBase

   The following methods are publicly inherited form :ref:`OEBinaryIOHandlerBase <OESystem_OEBinaryIOHandlerBase>`

   ==================================================================================  ============================================================================== ================================================================================
   :oe:meth:`Clear<OESystem::OEBinaryIOHandlerBase::Clear>`                            :oe:meth:`GetBaseWriteFxns<OESystem::OEBinaryIOHandlerBase::GetBaseWriteFxns>` :oe:meth:`GetDefaultReadFxn<OESystem::OEBinaryIOHandlerBase::GetDefaultReadFxn>`
   :oe:meth:`GetDefaultWriteFxn<OESystem::OEBinaryIOHandlerBase::GetDefaultWriteFxn>`  :oe:meth:`GetReadFxns<OESystem::OEBinaryIOHandlerBase::GetReadFxns>`           :oe:meth:`GetWriteFxns<OESystem::OEBinaryIOHandlerBase::GetWriteFxns>`
   :oe:meth:`ReplaceReadFxn<OESystem::OEBinaryIOHandlerBase::ReplaceReadFxn>`          :oe:meth:`ReplaceWriteFxn<OESystem::OEBinaryIOHandlerBase::ReplaceWriteFxn>`   :oe:meth:`SetBaseWriteFxn<OESystem::OEBinaryIOHandlerBase::SetBaseWriteFxn>`
   :oe:meth:`SetReadFxn<OESystem::OEBinaryIOHandlerBase::SetReadFxn>`                  :oe:meth:`SetWriteFxn<OESystem::OEBinaryIOHandlerBase::SetWriteFxn>`
   ==================================================================================  ============================================================================== ================================================================================

   This class is for extremely advanced usage.  Typical usage of this class is for 
   preserving rotor offset compression.  Please see the 
   :oe:func:`OEChem::OEPreserveRotCompress` function instead.
      
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBinaryIOHandler()
            OEBinaryIOHandler(const OEBinaryIOHandler &)
            OEBinaryIOHandler(const OEBinaryIOHandlerBase &)

      .. oe:language:: python

         .. oe:api:: python

            OEBinaryIOHandler() -> OEBinaryIOHandler
            OEBinaryIOHandler(arg2: OEBinaryIOHandler) -> OEBinaryIOHandler
            OEBinaryIOHandler(arg2: OEBinaryIOHandlerBase) -> OEBinaryIOHandler

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBinaryIOHandler &operator=(const OEBinaryIOHandler &)

      Assignment operator.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

   .. oe:method:: GetBaseWriteFxns

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<OEWriteFxn<OEBaseData> >* GetBaseWriteFxns() const

      .. oe:language:: python

         .. oe:api:: python

            GetBaseWriteFxns() -> Iterable[OEWriteFxn[OEBaseData]]

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

   .. oe:method:: GetDefaultReadFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEReadFxnBase& GetDefaultReadFxn() const

      .. oe:language:: python

         .. oe:api:: python

            GetDefaultReadFxn() -> OEReadFxnBase

   .. oe:method:: GetDefaultWriteFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEWriteFxnBase& GetDefaultWriteFxn() const

      .. oe:language:: python

         .. oe:api:: python

            GetDefaultWriteFxn() -> OEWriteFxnBase

   .. oe:method:: GetReadFxns

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<OEReadFxnBase>* GetReadFxns() const

      .. oe:language:: python

         .. oe:api:: python

            GetReadFxns() -> Iterable[OEReadFxnBase]

   .. oe:method:: GetWriteFxns

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<OEWriteFxnBase>* GetWriteFxns() const

      .. oe:language:: python

         .. oe:api:: python

            GetWriteFxns() -> Iterable[OEWriteFxnBase]

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

   .. oe:method:: ReplaceReadFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ReplaceReadFxn (const OEReadFxnBase& ,
                                 const std::string replacetag = std::string(""))

      .. oe:language:: python

         .. oe:api:: python

            ReplaceReadFxn(arg2: OEReadFxnBase, replacetag: str = str("")) -> bool

   .. oe:method:: ReplaceWriteFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ReplaceWriteFxn(const OEWriteFxnBase&,
                                 const std::string replacetag = std::string(""))

      .. oe:language:: python

         .. oe:api:: python

            ReplaceWriteFxn(arg2: OEWriteFxnBase, replacetag: str = str("")) -> bool

   .. oe:method:: SetBaseWriteFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBaseWriteFxn(const OEWriteFxn<OEBaseData> &)

      .. oe:language:: python

         .. oe:api:: python

            SetBaseWriteFxn(arg2: OEWriteFxn[OEBaseData]) -> bool

   .. oe:method:: SetReadFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetReadFxn(const OEReadFxnBase &, bool makedefault = false)

      .. oe:language:: python

         .. oe:api:: python

            SetReadFxn(arg2: OEReadFxnBase, makedefault: bool = False) -> bool

   .. oe:method:: SetWriteFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetWriteFxn(const OEWriteFxnBase &, bool makedefault = false)

      .. oe:language:: python

         .. oe:api:: python

            SetWriteFxn(arg2: OEWriteFxnBase, makedefault: bool = False) -> bool



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBinaryIOHandlerBase, BinaryIOHandlerBase

.. _OESystem_OEBinaryIOHandlerBase:

.. oe:class:: OEBinaryIOHandlerBase

   .. oe:api::

      class OEBinaryIOHandlerBase : public OEBase

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   The following classes derive from this class:

   :ref:`OEBinaryIOHandler <OESystem_OEBinaryIOHandler>`

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()=0

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

   .. oe:method:: GetBaseWriteFxns

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<OEWriteFxn<OEBaseData> >* GetBaseWriteFxns() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBaseWriteFxns() -> Iterable[OEWriteFxn[OEBaseData]]

   .. oe:method:: GetDefaultReadFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEReadFxnBase& GetDefaultReadFxn() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetDefaultReadFxn() -> OEReadFxnBase

   .. oe:method:: GetDefaultWriteFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEWriteFxnBase& GetDefaultWriteFxn() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetDefaultWriteFxn() -> OEWriteFxnBase

   .. oe:method:: GetReadFxns

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<OEReadFxnBase>* GetReadFxns() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetReadFxns() -> Iterable[OEReadFxnBase]

   .. oe:method:: GetWriteFxns

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<OEWriteFxnBase>* GetWriteFxns() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetWriteFxns() -> Iterable[OEWriteFxnBase]

   .. oe:method:: ReplaceReadFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ReplaceReadFxn (const OEReadFxnBase& ,
                                 const std::string replacetag = std::string("")) = 0

      .. oe:language:: python

         .. oe:api:: python

            ReplaceReadFxn(arg2: OEReadFxnBase, replacetag: str = str("")) -> bool

   .. oe:method:: ReplaceWriteFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ReplaceWriteFxn(const OEWriteFxnBase&,
                                 const std::string replacetag = std::string("")) = 0

      .. oe:language:: python

         .. oe:api:: python

            ReplaceWriteFxn(arg2: OEWriteFxnBase, replacetag: str = str("")) -> bool

   .. oe:method:: SetBaseWriteFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBaseWriteFxn(const OEWriteFxn<OEBaseData> &)=0

      .. oe:language:: python

         .. oe:api:: python

            SetBaseWriteFxn(arg2: OEWriteFxn[OEBaseData]) -> bool

   .. oe:method:: SetReadFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetReadFxn(const OEReadFxnBase &, bool makedefault = false)=0

      .. oe:language:: python

         .. oe:api:: python

            SetReadFxn(arg2: OEReadFxnBase, makedefault: bool = False) -> bool

   .. oe:method:: SetWriteFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetWriteFxn(const OEWriteFxnBase &, bool makedefault = false)=0

      .. oe:language:: python

         .. oe:api:: python

            SetWriteFxn(arg2: OEWriteFxnBase, makedefault: bool = False) -> bool



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBinaryNot, BinaryNot

.. _OESystem_OEBinaryNot:

.. oe:class:: OEBinaryNot

   .. oe:api::

      template<class Arg1, class Arg2>
      class OEBinaryNot : public OEBinaryPredicate<Arg1, Arg2>

   This class represents `OEBinaryNot`.

   The following methods are publicly inherited from :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>`:

   =============================================================================== =============================================================================== ================================================================================
   :oe:meth:`operator()<OESystem::OEBinaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEBinaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEBinaryPredicate::CreatePredicateCopy>`
   =============================================================================== =============================================================================== ================================================================================

   The following methods are publicly inherited from :ref:`OEBinaryFunction <OESystem_OEBinaryFunction>`:

   ============================================================= ============================================================= ============================================================
   :oe:meth:`operator()<OESystem::OEBinaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEBinaryFunction::CreateCopy>`                                                             
   ============================================================= ============================================================= ============================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEBinaryNot()
         OEBinaryNot(const OEBinaryNot<Arg1, Arg2>& rhs)
         OEBinaryNot(const OEBinaryPredicate<Arg1, Arg2>& func)

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBinaryNot& operator=(const OEBinaryNot<Arg1, Arg2>& rhs)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const Arg1& a1, const Arg2& a2)
            bool operator()(const Arg1& a1, const Arg2& a2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(a1: Arg1, a2: Arg2) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBinaryFunction<Arg1, Arg2, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBinaryNot



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBinaryOr, BinaryOr

.. _OESystem_OEBinaryOr:

.. oe:class:: OEBinaryOr

   .. oe:api::

      template<class Arg1, class Arg2>
      class OEBinaryOr : public OEBinaryPredicate<Arg1, Arg2>

   This class represents `OEBinaryOr`.

   The following methods are publicly inherited from :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>`:

   =============================================================================== =============================================================================== ================================================================================
   :oe:meth:`operator()<OESystem::OEBinaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEBinaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEBinaryPredicate::CreatePredicateCopy>`
   =============================================================================== =============================================================================== ================================================================================

   The following methods are publicly inherited from :ref:`OEBinaryFunction <OESystem_OEBinaryFunction>`:

   ============================================================= ============================================================= ============================================================
   :oe:meth:`operator()<OESystem::OEBinaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEBinaryFunction::CreateCopy>`                                                             
   ============================================================= ============================================================= ============================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEBinaryOr()
         OEBinaryOr(const OEBinaryOr& rhs)
         OEBinaryOr(const OEBinaryPredicate<Arg1, Arg2>& func1,
                    const OEBinaryPredicate<Arg1, Arg2>& func2)

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBinaryOr & operator=(const OEBinaryOr& rhs)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const Arg1& arg1, const Arg2& arg2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg1: Arg1, arg2: Arg2) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBinaryFunction<Arg1, Arg2, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBinaryOr



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBinaryPredicate, BinaryPredicate

.. _OESystem_OEBinaryPredicate:

.. oe:class:: OEBinaryPredicate

   .. oe:api::

      template<class Arg1, class Arg2>
      class OEBinaryPredicate : public OEBinaryFunction<Arg1, Arg2, bool>

   This class represents `OEBinaryPredicate`.

   The following methods are publicly inherited from :ref:`OEBinaryFunction <OESystem_OEBinaryFunction>`:

   ============================================================= ============================================================= ============================================================
   :oe:meth:`operator()<OESystem::OEBinaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEBinaryFunction::CreateCopy>`                                                             
   ============================================================= ============================================================= ============================================================

   The following classes derive from this class:
    * :ref:`OEInSamePart <OEChem_OEInSamePart>`
    * :ref:`OEUnaryToBinaryAnd <OEChem_OEUnaryToBinaryAnd>`
    * :ref:`OEUnaryToBinaryOr <OEChem_OEUnaryToBinaryOr>`
    * :ref:`OEBinaryAnd <OESystem_OEBinaryAnd>`
    * :ref:`OEBinaryFalse <OESystem_OEBinaryFalse>`
    * :ref:`OEBinaryNot <OESystem_OEBinaryNot>`
    * :ref:`OEBinaryOr <OESystem_OEBinaryOr>`

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const Arg1& a1, const Arg2& a2) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(a1: Arg1, a2: Arg2) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBinaryPredicate

   .. oe:method:: CreatePredicateCopy

      .. oe:api::

         OEBinaryPredicate<Arg1, Arg2> *CreatePredicateCopy() const



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBinaryTrue, BinaryTrue

.. _OESystem_OEBinaryTrue:

.. oe:class:: OEBinaryTrue

   .. oe:api::

      template<class T, class U> class OEBinaryTrue : public OEBinaryPredicate<T, U>

   A functor to always return ``true``. 

   The following methods are publicly inherited from :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>`:

   =============================================================================== =============================================================================== ================================================================================
   :oe:meth:`operator()<OESystem::OEBinaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEBinaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEBinaryPredicate::CreatePredicateCopy>`
   =============================================================================== =============================================================================== ================================================================================

   The following methods are publicly inherited from :ref:`OEBinaryFunction <OESystem_OEBinaryFunction>`:

   ============================================================= ============================================================= ============================================================
   :oe:meth:`operator()<OESystem::OEBinaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEBinaryFunction::CreateCopy>`                                                             
   ============================================================= ============================================================= ============================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const T &, const U &)
            bool operator()(const T &, const U &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(T, U) -> bool

   Always returns ``true``. 

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<T, U, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBinaryTrue



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBitVector, BitVector

.. _OESystem_OEBitVector:

.. oe:class:: OEBitVector

   .. oe:api::

      class OEBitVector

   The :ref:`OEBitVector <OESystem_OEBitVector>` class is used to represent a resizable
   bitmap. These are commonly used to store *fingerprints* in
   cheminformatics.

   .. seealso::

      * :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>` class
      * :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` class in **GraphSim TK** manual

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBitVector()
            OEBitVector(unsigned int size)
            OEBitVector(const OEBitVector& src)

      .. oe:language:: python

         .. oe:api:: python

            OEBitVector() -> OEBitVector
            OEBitVector(size: int) -> OEBitVector
            OEBitVector(src: OEBitVector) -> OEBitVector

      When constructed with a ``size`` argument, this specifies the
      initial number of bits in the :ref:`OEBitVector <OESystem_OEBitVector>`.
      When constructed without an argument, the default number of bits
      is architecture dependent, ``32`` bits on 32-bit hosts and
      ``64`` bits on 64-bit hosts. Initially, all the bits are set to
      zero.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBitVector(OERandom& rand, unsigned int size)

      .. oe:language:: python

         .. oe:api:: python

            OEBitVector(rand: OERandom, size: int) -> OEBitVector

      Creates a :ref:`OEBitVector <OESystem_OEBitVector>` with ``size`` bits
      randomly initialized from the ``rand`` object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBitVector(const unsigned char* data, unsigned int size)

      .. oe:language:: python

         .. oe:api:: python

            OEBitVector(data: str, size: int) -> OEBitVector

      Using this constructor is equivalent to creating a default
      constructed :ref:`OEBitVector <OESystem_OEBitVector>` and then immediately
      calling :oe:meth:`OESystem::OEBitVector::SetData` with the
      ``data`` and ``size`` arguments.

   .. oe:method:: operator<
      :language: c++

      .. oe:api::

         bool operator<(const OEBitVector &other) const

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBitVector &operator=(const OEBitVector &src)

      Assignment operator.

   .. oe:method:: operator&=
      :language: c++

      .. oe:api::

         OEBitVector &operator&=(const OEBitVector &)

   .. oe:method:: operator-=
      :language: c++

      .. oe:api::

         OEBitVector &operator-=(const OEBitVector &)

   .. oe:method:: operator[]
      :language: c++

      .. oe:api::

         bool operator[](unsigned int bit) const

   .. oe:method:: operator^=
      :language: c++

      .. oe:api::

         OEBitVector &operator^=(unsigned int bit)
         OEBitVector &operator^=(const OEBitVector &)

   .. oe:method:: operator|=
      :language: c++

      .. oe:api::

         OEBitVector &operator|=(unsigned int bit)
         OEBitVector &operator|=(const OEBitVector &)

   .. oe:method:: ClearBits

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearBits()

      .. oe:language:: python

         .. oe:api:: python

            ClearBits() -> None

      Clears all of the bits of the :ref:`OEBitVector <OESystem_OEBitVector>` to zero.

   .. oe:method:: CountBits

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int CountBits() const

      .. oe:language:: python

         .. oe:api:: python

            CountBits() -> int

      Counts the number of bits that are set to one, in the
      :ref:`OEBitVector <OESystem_OEBitVector>` object.

   .. oe:method:: CountRangeBits

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int CountRangeBits(const unsigned start,
                                        const unsigned end) const

      .. oe:language:: python

         .. oe:api:: python

            CountRangeBits(start: int, end: int) -> int

      Counts the number of bits that are set to one in the
      given bit range.

   .. oe:method:: FirstBit

      .. oe:language:: c++ java csharp

         .. oe:api::

            int FirstBit() const

      .. oe:language:: python

         .. oe:api:: python

            FirstBit() -> int

      Returns the index of the first bit, *i.e.* the
      set bit with the lowest index, in the
      :ref:`OEBitVector <OESystem_OEBitVector>`.
      Bit position
      indices are numbered from zero, and have a maximum of
      :oe:meth:`OESystem::OEBitVector::GetSize` ``-1``.
      If the :ref:`OEBitVector <OESystem_OEBitVector>` has no bits set,
      *i.e.* :oe:meth:`OESystem::OEBitVector::IsEmpty` returns
      ``true``, this method return will
      return the value ``-1``.

   .. oe:method:: FromHexString

      .. oe:language:: c++ java csharp

         .. oe:api::

            void FromHexString(const char* bvs)
            void FromHexString(const std::string& bvs)

      .. oe:language:: python

         .. oe:api:: python

            FromHexString(bvs: str) -> None

      Converts a hexadecimal string, in either upper, lower or mixed case,
      into an :ref:`OEBitVector <OESystem_OEBitVector>`.  Each valid hexadecimal digit
      (0-9, a-f, A-F) translates to four bits in the
      :ref:`OEBitVector <OESystem_OEBitVector>`.
      Note: Because :oe:cls:`OEBitVectors<OESystem::OEBitVector>` may have a
      length not divisible by four,
      the last character of an OEChem-generated hexadecimal string may
      be a non-hex digit encoding the correct length of the
      :ref:`OEBitVector <OESystem_OEBitVector>`. Don't worry if you see a non-hex
      digit at the end of a hexadecimal string.

      .. seealso::

         * :oe:meth:`OESystem::OEBitVector::ToHexString` method

   .. oe:method:: GetData

      .. oe:language:: c++ java csharp

         .. oe:api::

            const unsigned char* GetData() const

      .. oe:language:: python

         .. oe:api:: python

            GetData() -> str

      Returns a pointer to the internal storage of
      the :ref:`OEBitVector <OESystem_OEBitVector>`'s bitmap.
      This pointer to a sequence of at least
      (:oe:meth:`OESystem::OEBitVector::GetSize` ``+7)/8`` consecutive bytes. Bit index zero
      corresponds to the least significant bit of the first byte. All
      bits beyond :oe:meth:`OESystem::OEBitVector::GetSize` in the last byte are guaranteed
      to be zero. The :oe:meth:`OESystem::OEBitVector::GetData` method always returns a valid non-NULL
      pointer even if the number of bits is zero.

   .. oe:method:: GetSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetSize() -> int

      Returns the size, in bits, of the
      :ref:`OEBitVector <OESystem_OEBitVector>`.
      An :ref:`OEBitVector <OESystem_OEBitVector>` may potentially contain zero bits.

   .. oe:method:: IsBitOn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsBitOn(unsigned int bit) const

      .. oe:language:: python

         .. oe:api:: python

            IsBitOn(bit: int) -> bool

      Tests whether the bit as the
      specified position/index of an :ref:`OEBitVector <OESystem_OEBitVector>` is set.
      Bit position
      indices are numbered from zero, and have a maximum of
      :oe:meth:`OESystem::OEBitVector::GetSize` ``-1``. This method returns ``false`` for all
      indices greater than or equal to :oe:meth:`OESystem::OEBitVector::GetSize`.

   .. oe:method:: IsEmpty

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsEmpty() const

      .. oe:language:: python

         .. oe:api:: python

            IsEmpty() -> bool

      Returns ``true`` if all the bits of an :ref:`OEBitVector <OESystem_OEBitVector>` are zero.
      This is
      equivalent to, but much more efficient than, testing that
      :oe:meth:`OESystem::OEBitVector::CountBits` == 0. An :ref:`OEBitVector <OESystem_OEBitVector>` of
      zero size is considered empty.

   .. oe:method:: LastBit

      .. oe:language:: c++ java csharp

         .. oe:api::

            int LastBit() const

      .. oe:language:: python

         .. oe:api:: python

            LastBit() -> int

      Returns the index of the last bit, *i.e.* the
      set bit with the highest index, in the
      :ref:`OEBitVector <OESystem_OEBitVector>`.
      Bit position indices are numbered from zero, and have a maximum of
      :oe:meth:`OESystem::OEBitVector::GetSize` ``-1``. If the
      :ref:`OEBitVector <OESystem_OEBitVector>` has no bits set,
      *i.e.* :oe:meth:`OESystem::OEBitVector::IsEmpty` returns
      ``true``, this method return will
      return the value ``-1``.

   .. oe:method:: NegateBits

      .. oe:language:: c++ java csharp

         .. oe:api::

            void NegateBits()

      .. oe:language:: python

         .. oe:api:: python

            NegateBits() -> None

      Inverts all of the bits of an :ref:`OEBitVector <OESystem_OEBitVector>`.

   .. oe:method:: NextBit

      .. oe:language:: c++ java csharp

         .. oe:api::

            int NextBit(unsigned int) const

      .. oe:language:: python

         .. oe:api:: python

            NextBit(arg2: int) -> int

      Returns the next set bit after the specified
      bit position, *i.e.* the set bit with the lowest index greater
      than the argument. If there are no such set bits, or the value
      of bit is greater than or equal to :oe:meth:`OESystem::OEBitVector::GetSize`, this
      method returns the value ``-1``.

   .. oe:method:: PrevBit

      .. oe:language:: c++ java csharp

         .. oe:api::

            int PrevBit(unsigned int) const

      .. oe:language:: python

         .. oe:api:: python

            PrevBit(arg2: int) -> int

      Returns the previous set bit before the
      specified bit position, *i.e.* the set bit with the highest index
      less than the argument. If there are no such set bits, this
      method returns the value ``-1``. If the specified value of bit is
      greater than or equal to :oe:meth:`OESystem::OEBitVector::GetSize`, this method
      returns the same values as :oe:meth:`OESystem::OEBitVector::LastBit`.

   .. oe:method:: SetBitOff

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBitOff(unsigned int bit)

      .. oe:language:: python

         .. oe:api:: python

            SetBitOff(bit: int) -> None

      Clears the bit at the specified bit
      position/index of an :ref:`OEBitVector <OESystem_OEBitVector>`. Bit position indices are
      numbered from zero, and have a maximum of
      :oe:meth:`OESystem::OEBitVector::GetSize` ``-1``. If the value of 'bit' is greater than
      or equal to :oe:meth:`OESystem::OEBitVector::GetSize`, the bitmap is resized to
      'bit'+1 bits. All of the new bits are initialized to zero.

   .. oe:method:: SetBitOn

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBitOn(unsigned int bit)

      .. oe:language:: python

         .. oe:api:: python

            SetBitOn(bit: int) -> None

      Tests whether the bit as the
      specified position/index of an :ref:`OEBitVector <OESystem_OEBitVector>` is set. Bit position
      indices are numbered from zero, and have a maximum of
      :oe:meth:`OESystem::OEBitVector::GetSize` ``-1``. This method returns ``false`` for all
      indices greater than or equal to :oe:meth:`OESystem::OEBitVector::GetSize`.

   .. oe:method:: SetData

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetData(const unsigned char* data, unsigned int nbits)

      .. oe:language:: python

         .. oe:api:: python

            SetData(data: str, nbits: int) -> None

      Initialize the :ref:`OEBitVector <OESystem_OEBitVector>` by the binary data
      pointed to by ``data``, possibly resizing the
      :ref:`OEBitVector <OESystem_OEBitVector>` to accommodate the ``nbits`` of
      data. ``data`` should point to at least ``nbits/8`` bytes of
      data. If a non-multiple of 8 bits is to be copied it is the
      users responsibility to make sure the remainder of bits in the
      last byte are zeroed out.

   .. oe:method:: SetRangeOff

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRangeOff(unsigned int start, unsigned int end)

      .. oe:language:: python

         .. oe:api:: python

            SetRangeOff(start: int, end: int) -> None

   .. oe:method:: SetRangeOn

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRangeOn(unsigned int start, unsigned int end)

      .. oe:language:: python

         .. oe:api:: python

            SetRangeOn(start: int, end: int) -> None

   .. oe:method:: SetSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSize(unsigned int bits)

      .. oe:language:: python

         .. oe:api:: python

            SetSize(bits: int) -> None

      Resizes an :ref:`OEBitVector <OESystem_OEBitVector>` to the specified
      number of bits. A size argument of zero is allowed. If this
      method increases the size of an :ref:`OEBitVector <OESystem_OEBitVector>` all of the new bit
      positions are initialized to zero.

   .. oe:method:: ToHexString

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ToHexString(std::string& bvs) const

      .. oe:language:: python

         .. oe:api:: python

            ToHexString() -> str

      Generates a hexadecimal string representation of an
      :ref:`OEBitVector <OESystem_OEBitVector>`.
      Each "nibble" of four bits is converted into an uppercase hexadecimal
      character.

      .. figure:: oechemtk/images/OEBitVector_ToHexString.*
         :align:  center

         **The interpretation of the four-bit long "nibble"-s (big-endian system)**

      The four-bit long "nibble" shown above is encoded as hexadecimal 'A':

      :math:`0 * 2^0 + 1 * 2^1 + 0 * 2^2 + 1 * 2^3 = 0 + 2 + 0 + 8 = 10 (dec) = A (hex)`

      Because :oe:cls:`OEBitVectors<OESystem::OEBitVector>` may have a length
      that is not a multiple of four, an extra non-hexadecimal digit is added
      to the end of the string to encode the correct
      :ref:`OEBitVector <OESystem_OEBitVector>` length.

      .. table:: **Interpretation of last character**

         ========================= ===========================================
         last character            number of extra bits
         ========================= ===========================================
         'J'                       0
         'G'                       1
         'H'                       2
         'I'                       3
         ========================= ===========================================

      For example, if the size of the bit-vector is 8 (multiple of four), then
      the last character of the returned string will be 'J'.
      If the size of the bit-vector is 9, then the last character will be 'I',
      since there will be three extra bits to add up to a number that can be
      multiplied by four.

      .. seealso::

         * :oe:meth:`OESystem::OEBitVector::FromHexString` method

   .. oe:method:: ToggleBit

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ToggleBit(unsigned int bit)

      .. oe:language:: python

         .. oe:api:: python

            ToggleBit(bit: int) -> None

      Inverts the bit at the specified bit
      position/index of an :ref:`OEBitVector <OESystem_OEBitVector>`. Bit position indices are
      numbered from zero, and have a maximum of
      :oe:meth:`OESystem::OEBitVector::GetSize` ``-1``. If the value of 'bit' is greater than
      or equal to :oe:meth:`OESystem::OEBitVector::GetSize`, the bitmap is resized to
      'bit'+1 bits. All of the new bits other than the one specified in
      the argument, *i.e.* the last, are initialized to zero.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBoolParameter, BoolParameter

.. _OESystem_OEBoolParameter:

.. oe:class:: OEBoolParameter

   .. oe:api::

      class OEBoolParameter : public OEPODParameter<bool>

   The :ref:`OEBoolParameter <OESystem_OEBoolParameter>` represents parameter that has ``boolean`` value.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OETypedParameter <OESystem_OETypedParameter>`:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   Following methods are publicly inherited from :ref:`OEPODParameter <OESystem_OEPODParameter>`:
    * :oe:meth:`GetDefaultsVector<OESystem::OEPODParameter::GetDefaultsVector>`
    * :oe:meth:`GetSettingsVector<OESystem::OEPODParameter::GetSettingsVector>`
    * :oe:meth:`GetValuesVector<OESystem::OEPODParameter::GetValuesVector>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBoolParameter()
            OEBoolParameter(const std::string& name)
            OEBoolParameter(const std::string& name, const bool default)
            OEBoolParameter(const OEBoolParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEBoolParameter(name: str) -> OEBoolParameter
            OEBoolParameter(name: str, defValue: bool) -> OEBoolParameter
            OEBoolParameter() -> OEBoolParameter
            OEBoolParameter(arg2: OEBoolParameter) -> OEBoolParameter

      Default and copy constructors.

      Constructs an :ref:`OEBoolParameter <OESystem_OEBoolParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBoolParameter &operator=(const OEBoolParameter &)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBoundedBuffer, BoundedBuffer

.. attention::

   |CPPONLY|

.. _OESystem_OEBoundedBuffer:

.. oe:class:: OEBoundedBuffer

   .. oe:api::

      template<class T>
      class OEBoundedBuffer

   First-in-first-out (FIFO) queue that only allows for ``maxsize``
   items to be stored in the buffer, hence, "bounded".  It is not
   inherently thread safe by itself. Use this in conjunction with a
   :ref:`OEProtectedBuffer <OESystem_OEProtectedBuffer>` to make a thread-safe queue.

   .. oe:method:: Constructors

      .. oe:api::

         OEBoundedBuffer(oesize_t maxsize)

      Determines the maximum number of elements this queue can
      hold. The ``maxsize`` parameter should be a power-of-2 to allow
      for a more efficient implementation.

   .. oe:method:: Empty

      .. oe:api::

         bool Empty() const

      Returns whether the queue contains any items.

   .. oe:method:: Full

      .. oe:api::

         bool Full() const

      Returns ``true`` if the queue contains ``maxsize`` items.

   .. oe:method:: Get

      .. oe:api::

         T Get()

      Pops the next item off of the queue.

   .. oe:method:: Peek

      .. oe:api::

         T Peek()

      Returns the item that will be returned by the next call to
      :oe:meth:`OESystem::OEBoundedBuffer::Get`, but does not remove
      it from the queue.

   .. oe:method:: Put

      .. oe:api::

         void Put(T obj)

      Pushes an item into the queue.

   .. oe:method:: Size

      .. oe:api::

         oesize_t Size() const

      Returns the current number of items in the queue.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDataFlow

OEBytes
=======

.. attention::

   |TWOLANGUAGE|

.. meta::
   :keywords: OEBytes

.. oe:language:: c++

   .. oe:class:: OEBytes

      .. oe:api::

         OEBytes

      OEBytes is a type used to store bytes. It is a typedef for std::vector<unsigned char>.

.. oe:language:: python

   OEBytes exists only in the C++ API and corresponds to a Python *bytes*
   object.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEColor

.. _OESystem_OEColor:

.. oe:class:: OEColor

   .. oe:api::

      class OEColor

   The :ref:`OEColor <OESystem_OEColor>` class represents colors in terms of
   RGBA (red, green, blue, alpha) components, where alpha is used as an
   opacity channel. Each color component is represented by one byte in the
   range of ``0`` to ``255``. Meaning that
   :math:`2^8*2^8*2^8 = 16,777,216` different colors can be 
   represented.

   The value of alpha is also in the range of ``0`` to ``255``.  If a
   color has an alpha value of ``0``, then the color is fully
   transparent, *i.e.*, invisible. If a color has an alpha value
   ``255``, then the color is fully opaque.

   *OESystem* provides many predefined colors. For example, the color
   black is represented by
   :oe:const:`OEBlack<OESystem::OESystem::OEBlack>` (R=0, G=0, B=0),
   and the color white is represented by
   :oe:const:`OEWhite<OESystem::OESystem::OEWhite>` (R=255, G=255,
   B=255).  The full list of pre-defined colors is shown in 
   :ref:`Figure: List of pre-defined colors<figure_oecolors>`

   .. _figure_oecolors:
   .. figure:: oechemtk/images/OEColor.*
      :align: center

      **List of pre-defined colors**

   .. note::

      The alpha for all pre-defined colors is ``255``, entirely
      opaque.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor()

      .. oe:language:: python

         .. oe:api:: python

            OEColor() -> OEColor

      The default constructor initializes the color object to *white*
      (R=255, B=255, G=255, A=255).

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor(const OEColor& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEColor(rhs: OEColor) -> OEColor

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor(unsigned int packed)

      .. oe:language:: python

         .. oe:api:: python

            OEColor(packed: int) -> OEColor

      Create a color object from a packed 32-bit integer. Each 8-bit
      byte of the integer is assumed to contain a different component
      of the color.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor(const std::string& text)

      .. oe:language:: python

         .. oe:api:: python

            OEColor(text: str) -> OEColor

      Create a color object that is initialized with an RGB or an RGBA
      hexadecimal string.  The format of an RGB string is ``#RRGGBB``
      and format of an RGBA string is ``#RRGGBBAA``, where R,G,B and A
      are hexadecimal numbers. For example, the string ``#FF0000``
      represents the color red.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor(const unsigned char* rgba)

      .. oe:language:: python

         .. oe:api:: python

            OEColor(rgba: str) -> OEColor

      Create a color object from an array of ``unsigned char``. The
      array is assumed to contain at least 4 bytes, where each byte
      corresponds to RGBA components respectively. 

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor(unsigned int red, unsigned int green, unsigned int blue)

      .. oe:language:: python

         .. oe:api:: python

            OEColor(r: int, g: int, b: int) -> OEColor

      Create a color object with a specified `red`, `green`, and
      `blue` color components, the alpha component is set to
      ``255``. Each argument should be in the range of ``0`` to
      ``255``.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor(unsigned int red, unsigned int green, unsigned int blue,
                    unsigned int alpha)

      .. oe:language:: python

         .. oe:api:: python

            OEColor(r: int, g: int, b: int, a: int) -> OEColor

      Create a color object with a specified `red`, `green`, `blue`, and
      `alpha` components.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColor & operator=(const OEColor & rhs)

      Assignment operator.

   .. oe:method:: operator!=
      :language: c++

      .. oe:api::

         bool operator!=(const OEColor &rhs) const

      Determines whether two :ref:`OEColor <OESystem_OEColor>` objects are
      different. Two :ref:`OEColor <OESystem_OEColor>` objects are
      considered different, if any of their color components (red,
      green, blue, or alpha) are different.

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEColor &rhs) const

      Determines whether two :ref:`OEColor <OESystem_OEColor>` objects are
      equal. Two :ref:`OEColor <OESystem_OEColor>` objects are considered
      equivalent if all of their color components (red, green, blue,
      and alpha) are identical.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEColor

      Deep copy constructor that returns a pointer to a copy of the
      object.  The memory for the returned :ref:`OEColor <OESystem_OEColor>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetR

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetR() const

      .. oe:language:: python

         .. oe:api:: python

            GetR() -> int

      Returns the red component of the :ref:`OEColor <OESystem_OEColor>`
      object in the range of ``[0, 255]``.

      .. seealso::

         * :oe:meth:`OESystem::OEColor::SetR` method

   .. oe:method:: GetG

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetG() const

      .. oe:language:: python

         .. oe:api:: python

            GetG() -> int

      Returns the green component of the :ref:`OEColor <OESystem_OEColor>`
      object in the range of ``[0, 255]``.
 
      .. seealso::

         * :oe:meth:`OESystem::OEColor::SetG` method

         
   .. oe:method:: GetB

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetB() const

      .. oe:language:: python

         .. oe:api:: python

            GetB() -> int

      Returns the blue component of the :ref:`OEColor <OESystem_OEColor>`
      object in the range of ``[0, 255]``.

      .. seealso::

         * :oe:meth:`OESystem::OEColor::SetB` method

   .. oe:method:: GetA

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetA() const

      .. oe:language:: python

         .. oe:api:: python

            GetA() -> int

      Returns the alpha component of the :ref:`OEColor <OESystem_OEColor>`
      object in the range of ``[0, 255]``.

      .. seealso::

         * :oe:meth:`OESystem::OEColor::SetA` method

   .. oe:method:: GetPackedColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetPackedColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetPackedColor() -> int

      Returns all the components of the :ref:`OEColor <OESystem_OEColor>`
      object packed into a single 32-bit integer. Each 8-bit byte of
      the integer contains a different component of the color.

   .. oe:method:: GetRGBA

      .. oe:language:: c++ java csharp

         .. oe:api::

            const unsigned char* GetRGBA() const

      .. oe:language:: python

         .. oe:api:: python

            GetRGBA() -> str

      Returns all the components of the :ref:`OEColor <OESystem_OEColor>`
      object as an array of 4 bytes.  The array contains 4 bytes,
      where each byte corresponds to RGBA components respectively. The
      pointer returned is owned by the :ref:`OEColor <OESystem_OEColor>`
      object and should not be deallocated by the user. 

   .. oe:method:: GetText

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetText(bool alpha = false) const

      .. oe:language:: python

         .. oe:api:: python

            GetText(a: bool = False) -> str

      Returns the hexadecimal string representation of the
      :ref:`OEColor <OESystem_OEColor>` object. By default the format is
      ``#RRGGBB``. If the ``alpha`` argument is set to ``true`` the
      returned string will include the alpha component in the format
      ``#RRGGBBAA``.

   .. oe:method:: Set

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor& Set(unsigned int r, unsigned int g, unsigned int b)
            OEColor& Set(unsigned int r, unsigned int g, unsigned int b,
                         unsigned int a)

      .. oe:language:: python

         .. oe:api:: python

            Set(r: int, g: int, b: int) -> OEColor
            Set(r: int, g: int, b: int, a: int) -> OEColor

      Sets all the components of the :ref:`OEColor <OESystem_OEColor>`
      object. Each argument is assumed to be in the range of ``0`` to
      ``255``. Returns a reference to the :ref:`OEColor <OESystem_OEColor>`
      object.

   .. oe:method:: SetR

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor& SetR(unsigned int r)

      .. oe:language:: python

         .. oe:api:: python

            SetR(r: int) -> OEColor

      Sets the red component of the :ref:`OEColor <OESystem_OEColor>`
      object. 
      The given value is clamped into the range of ``[0, 255]``. 
      Returns a reference to the :ref:`OEColor <OESystem_OEColor>`
      object.

      .. figure:: oechemtk/images/OEColorComponentRed.*
         :align: center

         **Examples of changing the red color component**

      .. seealso::

         * :oe:meth:`OESystem::OEColor::GetR` method

   .. oe:method:: SetG

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor& SetG(unsigned int g)

      .. oe:language:: python

         .. oe:api:: python

            SetG(g: int) -> OEColor

      Sets the green component of the :ref:`OEColor <OESystem_OEColor>`
      object. 
      The given value is clamped into the range of ``[0, 255]``. 
      Returns a reference to the :ref:`OEColor <OESystem_OEColor>`
      object.

      .. figure:: oechemtk/images/OEColorComponentGreen.*
         :align: center

         **Examples of changing the green color component**

      .. seealso::

         * :oe:meth:`OESystem::OEColor::SetG` method

   .. oe:method:: SetB

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor& SetB(unsigned int b)

      .. oe:language:: python

         .. oe:api:: python

            SetB(b: int) -> OEColor

      Sets the blue component of the :ref:`OEColor <OESystem_OEColor>`
      object. 
      The given value is clamped into the range of ``[0, 255]``. 
      Returns a reference to the :ref:`OEColor <OESystem_OEColor>`
      object.

      .. figure:: oechemtk/images/OEColorComponentBlue.*
         :align: center

         **Examples of changing the blue color component**

      .. seealso::

         * :oe:meth:`OESystem::OEColor::SetB` method

   .. oe:method:: SetA

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor& SetA(unsigned int a)

      .. oe:language:: python

         .. oe:api:: python

            SetA(a: int) -> OEColor

      Sets the alpha component of the :ref:`OEColor <OESystem_OEColor>`
      object. 
      The given value is clamped into the range of ``[0, 255]``. 
      Returns a reference to the :ref:`OEColor <OESystem_OEColor>`
      object.

      .. figure:: oechemtk/images/OEColorComponentAlpha.*
         :align: center

         **Examples of changing the alpha (transparency) color component**

      .. seealso::

         * :oe:meth:`OESystem::OEColor::SetA` method

   .. oe:method:: SetPackedColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor& SetPackedColor(unsigned int color)

      .. oe:language:: python

         .. oe:api:: python

            SetPackedColor(color: int) -> OEColor

      Sets all the components of the :ref:`OEColor <OESystem_OEColor>`
      object from a packed 32-bit integer. Each 8-bit
      byte of the integer is assumed to contain a different component
      of the color. Returns a reference to the :ref:`OEColor <OESystem_OEColor>`
      object.

   .. oe:method:: SetRGBA

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor& SetRGBA(const unsigned char* rgba)

      .. oe:language:: python

         .. oe:api:: python

            SetRGBA(rgba: str) -> OEColor

      Sets all the components of the :ref:`OEColor <OESystem_OEColor>` object
      from an array of ``unsigned char``. The array is assumed to
      contain at least 4 bytes, where each byte corresponds to RGBA
      components respectively. Returns a reference to the
      :ref:`OEColor <OESystem_OEColor>` object.

   .. oe:method:: SetText

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor& SetText(const std::string& text)

      .. oe:language:: python

         .. oe:api:: python

            SetText(text: str) -> OEColor

      Sets all the components of the :ref:`OEColor <OESystem_OEColor>` object
      from a RGB or RGBA hexadecimal string. The format of an RGB
      string is ``#RRGGBB`` and format of an RGBA string is
      ``#RRGGBBAA``, where R,G,B and A are hexadecimal numbers. For
      example, the string ``#FF0000`` represents the color
      red. Returns a reference to the :ref:`OEColor <OESystem_OEColor>`
      object.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEColorGradientBase, ColorGradientBase

.. _OESystem_OEColorGradientBase:

.. oe:class:: OEColorGradientBase

   .. oe:api::

      class OEColorGradientBase

   :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>`  is an abstract class
   used for interpolating between colors that are defined by using the
   :ref:`OEColorStop <OESystem_OEColorStop>` class.

   The following classes derive from this class:
    * :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>`
    * :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>`
    * :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>`
    * :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>`

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:api::

         OEColorGradientBase()

      Default constructor that creates an "empty" color gradient.

      .. note::

         An "empty" color gradient always returns the :oe:const:`OEBlack<OESystem::OESystem::OEBlack>`
         color, when calling the :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`,
         the :oe:meth:`OESystem::OEColorGradientBase::GetMinColor` or
         the :oe:meth:`OESystem::OEColorGradientBase::GetMaxColor` methods.

      .. oe:api::

         OEColorGradientBase(const OEColorStop& oneStop)

      Creates an :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>` object with
      one color stop. An :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>`
      object that has only one color stop will always return that
      color when calling the
      :oe:meth:`OESystem::OEColorGradientBase::GetColorAt` method.

      .. oe:api::

         OEColorGradientBase(const OEColorStop& bgnStop,
                             const OEColorStop& endStop)

      Creates an :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>` object with
      interpolation range between the two specified color stops.

      .. oe:api::

         OEColorGradientBase(const OEColorGradientBase& rhs)

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColorGradientBase& operator=(const OEColorGradientBase& rhs)

      Assignment operator.

   .. oe:method:: AddStop

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddStop(const OEColorStop& stop)

      .. oe:language:: python

         .. oe:api:: python

            AddStop(stop: OEColorStop) -> bool

      Add a new color stop to the color gradient.

   .. oe:method:: DeleteStop

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteStop(unsigned int stopidx)

      .. oe:language:: python

         .. oe:api:: python

            DeleteStop(stopidx: int) -> bool

      Deletes the color stop at ``idx`` and returns ``true``. If the
      color gradient only has one color stop or the ``idx`` is
      not between ``0`` and
      :oe:meth:`NumStops()<OESystem::OEColorGradientBase::NumStops>`,
      then :oe:meth:`OESystem::OEColorGradientBase::DeleteStop`
      throws a warning and returns ``false``.

   .. oe:method:: GetColorAt

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColor GetColorAt(double value) const

      .. oe:language:: python

         .. oe:api:: python

            GetColorAt(value: float) -> OEColor

      Returns the interpolated color at ``value`` defined by
      the color stops in the color gradient.
      Returns :oe:meth:`OESystem::OEColorGradientBase::GetMinColor`
      if the ``value`` is less than
      :oe:meth:`OESystem::OEColorGradientBase::GetMinValue`.
      Returns :oe:meth:`OESystem::OEColorGradientBase::GetMaxColor`
      if the ``value`` is greater than
      :oe:meth:`OESystem::OEColorGradientBase::GetMinValue`.

   .. oe:method:: GetMaxColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEColor& GetMaxColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxColor() -> OEColor

      Returns the color associated with the value returned by the
      :oe:meth:`OESystem::OEColorGradientBase::GetMaxValue`
      method.

   .. oe:method:: GetMaxValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMaxValue() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxValue() -> float

      Returns the highest value stored in any of the color stops of the
      color gradient.

   .. oe:method:: GetMinColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEColor& GetMinColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinColor() -> OEColor

      Returns the color associated with the value returned by the
      :oe:meth:`OESystem::OEColorGradientBase::GetMinValue` method.

   .. oe:method:: GetMinValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMinValue() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinValue() -> float

      Returns the lowest value stored in any of the color stops of the
      color gradient.

   .. oe:method:: GetStops

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase< OEColorStop >* GetStops() const

      .. oe:language:: python

         .. oe:api:: python

            GetStops() -> Iterable[OEColorStop]

      Returns an iterator over all color stops of the color gradient.
      The iterator is invariant to further modifications of
      the :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>` object.

   .. oe:method:: IsEmpty

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsEmpty() const

      .. oe:language:: python

         .. oe:api:: python

            IsEmpty() -> bool

      Returns ``true`` if no color stop has been added to the
      :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>` object that has been
      created by the default constructor, otherwise it returns ``false``.

   .. oe:method:: NumStops

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumStops() const

      .. oe:language:: python

         .. oe:api:: python

            NumStops() -> int

      Returns the number of color stops of the color gradient.

   .. oe:method:: TransformValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            double TransformValue(double value) const = 0

      .. oe:language:: python

         .. oe:api:: python

            TransformValue(value: float) -> float

      This is a virtual const method that is implemented in the concrete
      color gradient derived classes.
      This method is called by :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`
      method to transform a value before performing color interpolation.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEColorStop, ColorStop

.. _OESystem_OEColorStop:

.. oe:class:: OEColorStop

   .. oe:api::

      class OEColorStop

   The :ref:`OEColorStop <OESystem_OEColorStop>` class stores a color
   (:ref:`OEColor <OESystem_OEColor>`) and value (double) pair that is used
   by the color gradient classes.

   .. seealso::

      * :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>` base class
      * :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` class
      * :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>` class
      * :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class
      * :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>` class

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorStop(double value, const OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            OEColorStop(value: float, color: OEColor) -> OEColorStop

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorStop(const OEColorStop& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEColorStop(rhs: OEColorStop) -> OEColorStop

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColorStop &operator=(const OEColorStop &rhs)

      Assignment operator.

   .. ################################################################
      # GetColor
      ################################################################

   .. oe:method:: GetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEColor& GetColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> OEColor

      Returns the :ref:`OEColor <OESystem_OEColor>` stored in the
      :ref:`OEColorStop <OESystem_OEColorStop>` object.

   .. ################################################################
      # GetValue
      ################################################################

   .. oe:method:: GetValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetValue() const

      .. oe:language:: python

         .. oe:api:: python

            GetValue() -> float

      Returns the value stored in the :ref:`OEColorStop <OESystem_OEColorStop>`
      object.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEConcatIter, ConcatIter

.. warning::

   This functionality is only available in the C++ toolkits.

.. _OESystem_OEConcatIter:

.. oe:class:: OEConcatIter

   .. oe:api::

      template<class A>
      class OEConcatIter : public OEIterBase<A>

   This class represents `OEConcatIter`.

   The following methods are publicly inherited from :ref:`OEIterBase <OESystem_OEIterBase>`:

   ============================================================ ============================================================= ============================================================
   :oe:meth:`operator*<OESystem::OEIterBase::operator*>`        :oe:meth:`operator-=<OESystem::OEIterBase::operator-=>`       :oe:meth:`Copy<OESystem::OEIterBase::Copy>`
   :oe:meth:`operator++<OESystem::OEIterBase::operator++>`      :oe:meth:`operator-><OESystem::OEIterBase::operator->>`       :oe:meth:`Push<OESystem::OEIterBase::Push>`
   :oe:meth:`operator+=<OESystem::OEIterBase::operator+=>`      :oe:meth:`operator A *<OESystem::OEIterBase::operator A *>`   :oe:meth:`ToFirst<OESystem::OEIterBase::ToFirst>`
   :oe:meth:`operator--<OESystem::OEIterBase::operator-->`      :oe:meth:`operator bool<OESystem::OEIterBase::operator bool>` :oe:meth:`ToLast<OESystem::OEIterBase::ToLast>`
   ============================================================ ============================================================= ============================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEConcatIter()
         OEConcatIter(OEIterBase<A>* rhs)
         OEConcatIter(const OEConcatIter<A>& rhs)
         OEConcatIter(OEIterBase<A>* ib1, OEIterBase<A>* ib2)

      Default and copy constructors.

   .. oe:method:: operator*
      :language: c++

      .. oe:api::

         A& operator*() const

   .. oe:method:: operator++
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator++()

   .. oe:method:: operator+=
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator+=(int x)
         OEIterBase<A>& operator+=(unsigned int x)

   .. oe:method:: operator--
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator--()

   .. oe:method:: operator-=
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator-=(int x)
         OEIterBase<A>& operator-=(unsigned int x)

   .. oe:method:: operator->
      :language: c++

      .. oe:api::

         A* operator->() const

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

   .. oe:method:: Copy

      .. oe:api::

         OEIterBase<A> *Copy() const

   .. oe:method:: Push

      .. oe:api::

         OEIterBase<A> *Push(OEIterBase<A> *ib)

   .. oe:method:: ToFirst

      .. oe:api::

         OEIterBase<A> &ToFirst()

   .. oe:method:: ToLast

      .. oe:api::

         OEIterBase<A> &ToLast()



.. oe:namespace:: OESystem

.. _OESystem_OEConsoleProgressTracer:

.. oe:class:: OEConsoleProgressTracer

   .. oe:api::

      class OEConsoleProgressTracer : public OETracerBase

   The following methods are publicly inherited from :ref:`OETracerBase <OESystem_OETracerBase>`:

   ========================================================== ========================================================== ===========================================================
   :oe:meth:`Aborted<OESystem::OETracerBase::Aborted>`        :oe:meth:`Push<OESystem::OETracerBase::Push>`              :oe:meth:`SetProgress<OESystem::OETracerBase::SetProgress>`
   :oe:meth:`Pop<OESystem::OETracerBase::Pop>`                :oe:meth:`Refresh<OESystem::OETracerBase::Refresh>`        :oe:meth:`SetTask<OESystem::OETracerBase::SetTask>`
   ========================================================== ========================================================== ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConsoleProgressTracer()

      .. oe:language:: python

         .. oe:api:: python

            OEConsoleProgressTracer() -> OEConsoleProgressTracer

      Default constructor.

   .. oe:method:: Aborted

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Aborted()

      .. oe:language:: python

         .. oe:api:: python

            Aborted() -> bool

      This is a no-op method for this class.

   .. oe:method:: Pop

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Pop()

      .. oe:language:: python

         .. oe:api:: python

            Pop() -> None

      Prints out the task name and the progress bar along with the elapsed time.
      An example output is shown below.

      ::

        Screen generation        [========----------------------------------------------------]  13.53%  00:00:53

   .. oe:method:: Push

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Push(std::string task)

      .. oe:language:: python

         .. oe:api:: python

            Push(task: str) -> None

      This is equivalent to calling :oe:meth:`OESystem::OEConsoleProgressTracer::SetTask`.

   .. oe:method:: Refresh

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Refresh()

      .. oe:language:: python

         .. oe:api:: python

            Refresh() -> None

      This is a no-op method for this class.

   .. oe:method:: SetProgress

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetProgress(double percent)
            void SetProgress(unsigned int current, unsigned int total)

      .. oe:language:: python

         .. oe:api:: python

            SetProgress(percent: float) -> None
            SetProgress(current: int, total: int) -> None

      Prints out the task name and its progress bar when the current progress
      of the task has reached the percentage of completion specified by ``percent``
      or by ``current`` / ``total``.

   .. oe:method:: SetTask

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTask(std::string task)

      .. oe:language:: python

         .. oe:api:: python

            SetTask(task: str) -> None

      Registers the tracer with a task name specified by, ``task``.
      It also starts the timer to trace the progress of the task and prints out
      the initial progress bar, i.e. ``0.0``.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEConstParameter, ConstParameter

.. _OESystem_OEConstParameter:

.. oe:class:: OEConstParameter

   .. oe:api::

      class OEConstParameter : public OEUIntParameter

   The :ref:`OEConstParameter <OESystem_OEConstParameter>` represents parameter that has ``unsigned`` value.
   Unlike :ref:`OEUIntParameter <OESystem_OEUIntParameter>`, however, this parameter requires a set
   of constants defined in terms of <unsigned, std::string> pairs as legal entries.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OETypedParameter <OESystem_OETypedParameter>`:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   Following methods are publicly inherited from :ref:`OEPODParameter <OESystem_OEPODParameter>`:
    * :oe:meth:`GetDefaultsVector<OESystem::OEPODParameter::GetDefaultsVector>`
    * :oe:meth:`GetSettingsVector<OESystem::OEPODParameter::GetSettingsVector>`
    * :oe:meth:`GetValuesVector<OESystem::OEPODParameter::GetValuesVector>`

   The :ref:`OEConstParameter <OESystem_OEConstParameter>` class defines the following public methods:
    * :ref:`AddLegalEntry <OESystem_OEConstParameter_AddLegalEntry>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConstParameter()
            OEConstParameter(const std::string& name)
            OEConstParameter(const std::string& name, const unsigned defValue,
                             const std::string& defKey)
            OEConstParameter(const OEConstParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEConstParameter(name: str) -> OEConstParameter
            OEConstParameter(name: str, defValue: int, defKey: str) -> OEConstParameter
            OEConstParameter() -> OEConstParameter
            OEConstParameter(arg2: OEConstParameter) -> OEConstParameter

      Default and copy constructors.

      Constructs an :ref:`OEConstParameter <OESystem_OEConstParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEConstParameter &operator=(const OEConstParameter &)

      The assignment operator.

   .. _OESystem_OEConstParameter_AddLegalEntry:

      Assignment operator.

   .. oe:method:: AddLegalEntry

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddLegalEntry(const unsigned value, const std::string& key)

      .. oe:language:: python

         .. oe:api:: python

            AddLegalEntry(value: int, key: str) -> bool

      Adds a legal pair, defining valid constants for the parameter.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEContainer, Container

.. _OESystem_OEContainer:

.. oe:class:: OEContainer

   .. oe:api::

      class OEContainer : public OEBase

   This class represents `OEContainer`.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   The following classes derive from this class:
    * :ref:`OEHeader <OESystem_OEHeader>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEContainer()
            OEContainer(const OEBase& rhs)
            OEContainer(const OEContainer& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEContainer() -> OEContainer
            OEContainer(rhs: OEBase) -> OEContainer
            OEContainer(arg2: OEContainer) -> OEContainer

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEContainer &operator=(const OEContainer &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void* type) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(type: void) -> bool



.. oe:namespace:: OESystem

.. meta::
   :keywords: OECycleTimer, CycleTimer

.. _OESystem_OECycleTimer:

.. oe:class:: OECycleTimer

   .. oe:api::

      class OECycleTimer

   This class represents `OECycleTimer`.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECycleTimer()

      .. oe:language:: python

         .. oe:api:: python

            OECycleTimer() -> OECycleTimer

      Default and copy constructors.

   .. oe:method:: Elapsed

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEULongLong Elapsed()

      .. oe:language:: python

         .. oe:api:: python

            Elapsed() -> OEULongLong

   .. oe:method:: Lap

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEULongLong Lap()

      .. oe:language:: python

         .. oe:api:: python

            Lap() -> OEULongLong

   .. oe:method:: Start

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Start()

      .. oe:language:: python

         .. oe:api:: python

            Start() -> None



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEDots, Dots

.. _OESystem_OEDots:

.. oe:class:: OEDots

   .. oe:api::

      class OEDots

   Provides a simple progress bar interface for command line
   applications. Dots, ``.``, characters are printed to
   :oe:const:`OEPlatform::OEPlatform::oeerr` to indicate to the user
   of the command line application that progress is indeed being made
   and the program is not hung indefinitely.

   .. seealso::

      A version of this class that is safe to used from multiple
      threads of computation: :ref:`OEThreadedDots <OESystem_OEThreadedDots>`.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDots(unsigned int bigstep, unsigned int smallstep,
                   const char * objectname = "",
                   const char * action = "processed")

      .. oe:language:: python

         .. oe:api:: python

            OEDots(bigstep: int, smallstep: int, objectname: str = "",
                   action: str = "processed") -> OEDots

      Controls how the following output gets updated::

         .......... 10000 things processed.
         .......... 20000 things processed.
         .......... 30000 things processed.
         .......... 40000 things processed.
         .......... 50000 things processed.
         .......... 60000 things processed.
         .......... 70000 things processed.
         .......... 80000 things processed.

      *bigstep*
        The number of elements before a new line is generated. The
        above example is a ``bigstep`` of ``10000``.

      *smallstep*
        The number of elements before a single new dot, ``.``, is
        printed.  The above example is a ``smallstep`` of ``1000``. Or
        10 dots per line.

      *objectname*
        A description of what is being processed. In the above
        example, this is "things".

      *action*
        A description of what is done to the 'objects'. In the above
        example, this is "processed".

   .. oe:method:: GetBigStep

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetBigStep()

      .. oe:language:: python

         .. oe:api:: python

            GetBigStep() -> int

      Returns the ``bigstep`` size used to construct this instance.

   .. oe:method:: GetCounts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetCounts()

      .. oe:language:: python

         .. oe:api:: python

            GetCounts() -> int

      Returns the current number of elements counted by this instance.

   .. oe:method:: GetSmallStep

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSmallStep()

      .. oe:language:: python

         .. oe:api:: python

            GetSmallStep() -> int

      Returns the ``smallstep`` size used to construct this instance.

   .. oe:method:: SetBigStep

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBigStep(unsigned int s)

      .. oe:language:: python

         .. oe:api:: python

            SetBigStep(s: int) -> None

      Sets a new ``bigstep`` size for this instance.

   .. oe:method:: SetSmallStep

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSmallStep(unsigned int s)

      .. oe:language:: python

         .. oe:api:: python

            SetSmallStep(s: int) -> None

      Sets a new ``smallstep`` size for this instance.

   .. oe:method:: Total

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Total()

      .. oe:language:: python

         .. oe:api:: python

            Total() -> None

      Prints a final summary line like the following::

         Total: 80000 things processed.

      Typically only run once at the end of all processing.

   .. oe:method:: Update

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Update(unsigned int step = 1)
            void Update(const char symbol, unsigned int step = 1)

      .. oe:language:: python

         .. oe:api:: python

            Update(step: int = 1) -> None
            Update(symbol: str, step: int = 1) -> None

      Update the progress with the number of elements specified by
      ``step``. The default is ``1`` element, but any number can be
      specified. However, ``0`` is not a valid step size and will
      throw an error.  The second overload allows to specify a `symbol`
      to be displayed as progress, instead of a dot.

      .. note::

         Not thread-safe, see :ref:`OEThreadedDots <OESystem_OEThreadedDots>` if
         this method needs to be called from multiple threads.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`dots.cpp<section_example_oechem_dots>`

  .. oe:language:: python

      * Example program :ref:`dots.py<section_example_oechem_dots>`

  .. oe:language:: java

      * Example program :ref:`Dots.java<section_example_oechem_dots>`

  .. oe:language:: csharp

      * Example program :ref:`Dots.cs<section_example_oechem_dots>`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEDoubleParameter, DoubleParameter

.. _OESystem_OEDoubleParameter:

.. oe:class:: OEDoubleParameter

   .. oe:api::

      class OEDoubleParameter : public OEPODParameter<double>

   The :ref:`OEDoubleParameter <OESystem_OEDoubleParameter>` represents parameter that has ``double`` value.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OETypedParameter <OESystem_OETypedParameter>`:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   Following methods are publicly inherited from :ref:`OEPODParameter <OESystem_OEPODParameter>`:
    * :oe:meth:`GetDefaultsVector<OESystem::OEPODParameter::GetDefaultsVector>`
    * :oe:meth:`GetSettingsVector<OESystem::OEPODParameter::GetSettingsVector>`
    * :oe:meth:`GetValuesVector<OESystem::OEPODParameter::GetValuesVector>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDoubleParameter()
            OEDoubleParameter(const std::string& name)
            OEDoubleParameter(const std::string& name, const double default)
            OEDoubleParameter(const OEDoubleParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEDoubleParameter(name: str) -> OEDoubleParameter
            OEDoubleParameter(name: str, defValue: float) -> OEDoubleParameter
            OEDoubleParameter() -> OEDoubleParameter
            OEDoubleParameter(arg2: OEDoubleParameter) -> OEDoubleParameter

      Default and copy constructors.

      Constructs an :ref:`OEDoubleParameter <OESystem_OEDoubleParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDoubleParameter &operator=(const OEDoubleParameter &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEErrorHandler, ErrorHandler

.. _OESystem_OEErrorHandler:

.. oe:class:: OEErrorHandler

   .. oe:api::

      class OEErrorHandler

   This class represents `OEErrorHandler`.

   The :ref:`OEErrorHandler <OESystem_OEErrorHandler>` class is used to define the behavior of the
   :oe:constns:`OESystem::OEThrow` error handler. All diagnostic output, including
   error, warning and informational messages, generated by the *OpenEye*
   libraries are emitted via :oe:constns:`OESystem::OEThrow`.
   The :ref:`OEErrorHandler <OESystem_OEErrorHandler>` class defines
   how these messages are emitted, but also how the user can redirect
   and/or intercept these messages.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEErrorHandler()

      .. oe:language:: python

         .. oe:api:: python

            OEErrorHandler() -> OEErrorHandler

      Default constructor that creates an
      :ref:`OEErrorHandlerImplBase <OESystem_OEErrorHandlerImplBase>` that it owns and writes output to stderr.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEErrorHandler(OEErrorHandler& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEErrorHandler(rhs: OEErrorHandler) -> OEErrorHandler

      Copy constructor.

      .. note::

         :oe:meth:`OESystem::OEErrorHandlerImplBase::CreateCopy` will
         only be called by the copy constructor if the right-hand-side
         owns the :ref:`OEErrorHandlerImplBase <OESystem_OEErrorHandlerImplBase>`. This is
         why the right-hand-side argument is non-const.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEErrorHandler &operator=(OEErrorHandler &rhs)

      Assignment operator.

      .. note::

         :oe:meth:`OESystem::OEErrorHandlerImplBase::CreateCopy` will
         only be called by ``operator=`` if the right-hand-side
         owns the :ref:`OEErrorHandlerImplBase <OESystem_OEErrorHandlerImplBase>`. This is
         why the right-hand-side argument is non-const.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Reset all the counts returned by
      :oe:meth:`OESystem::OEErrorHandler::Count` to zero.

   .. oe:method:: Count

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int Count(unsigned int level = 0) const

      .. oe:language:: python

         .. oe:api:: python

            Count(level: int = 0) -> int

      Returns the number of messages already written at the given
      ``level``. The constant ``level`` should be drawn from the
      :oe:constns:`OESystem::OEErrorLevel` namespace. If ``level`` is
      zero, the default, the sum of all error level counts is returned.

   .. oe:method:: Debug

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Debug(const std::string &)
            void Debug(const char* format, ...)

      .. oe:language:: python

         .. oe:api:: python

            Debug(arg2: str) -> None

      Writes debugging messages to the
      :ref:`OEErrorHandler <OESystem_OEErrorHandler>`. By default, these message
      will not appear, :oe:meth:`OESystem::OEErrorHandler::SetLevel`
      should be set to :oe:const:`OESystem::OEErrorLevel::Debug` or
      below to make them appear.

   .. oe:method:: Error

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Error(const std::string &)
            void Error(const char* format, ...)

      .. oe:language:: python

         .. oe:api:: python

            Error(arg2: str) -> None

      Writes error messages to the :ref:`OEErrorHandler <OESystem_OEErrorHandler>`.
      Depending upon the value of the :ref:`OEErrorHandler <OESystem_OEErrorHandler>`'s
      'strict' property (see :oe:meth:`OESystem::OEErrorHandler::GetStrict` and
      :oe:meth:`OESystem::OEErrorHandler::SetStrict`), these diagnostics
      are forwarded to either the :oe:meth:`OESystem::OEErrorHandler::Fatal` or
      :oe:meth:`OESystem::OEErrorHandler::Warning` methods.

   .. oe:method:: Fatal

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Fatal(const std::string &)
            void Fatal(const char* format, ...)

      .. oe:language:: python

         .. oe:api:: python

            Fatal(arg2: str) -> None

      Writes fatal error messages to the :ref:`OEErrorHandler <OESystem_OEErrorHandler>`.

   .. oe:method:: GetHandlerImpl

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEErrorHandlerImplBase* GetHandlerImpl()

      .. oe:language:: python

         .. oe:api:: python

            GetHandlerImpl() -> OEErrorHandlerImplBase

      Returns the :ref:`OEErrorHandlerImplBase <OESystem_OEErrorHandlerImplBase>` error handler that
      is used to handle messages. The default error handler writes output to stderr.
      The error handler can be changed by calling the :oe:meth:`OESystem::OEErrorHandler::SetHandlerImpl` method.

   .. oe:method:: GetLevel

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetLevel() const

      .. oe:language:: python

         .. oe:api:: python

            GetLevel() -> int

      Returns a constant from the :oe:constns:`OESystem::OEErrorLevel`
      namespace indicating the current level of messages that should
      make it to the output stream. The default is
      :oe:const:`OESystem::OEErrorLevel::Default`, that will output messages of
      :oe:meth:`OESystem::OEErrorHandler::Info` or higher.

      .. warning::

         All threads, including the main thread, will start out at the
         :oe:const:`OESystem::OEErrorLevel::Default`
         level. :oe:meth:`OESystem::OEErrorHandler::SetLevel` will
         only change the level for the current thread.

   .. oe:method:: GetStrict

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStrict() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrict() -> bool

      Returns the 'strict' property of the
      :ref:`OEErrorHandler <OESystem_OEErrorHandler>`. When the :ref:`OEErrorHandler <OESystem_OEErrorHandler>` is
      strict, all error messages written via the
      :oe:meth:`OESystem::OEErrorHandler::Error` methods are treated as fatal,
      and handled like those passed to :oe:meth:`OESystem::OEErrorHandler::Fatal`.
      When the :ref:`OEErrorHandler <OESystem_OEErrorHandler>` is  not strict, error messages
      written via :oe:meth:`OESystem::OEErrorHandler::Error` are treated like
      those to :oe:meth:`OESystem::OEErrorHandler::Warning`.
      The strict property of an :ref:`OEErrorHandler <OESystem_OEErrorHandler>` can
      be set using the :oe:meth:`OESystem::OEErrorHandler::SetStrict` method.

   .. oe:method:: Info

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Info(const std::string &)
            void Info(const char* format, ...)

      .. oe:language:: python

         .. oe:api:: python

            Info(arg2: str) -> None

      Writes an informational messages to the :ref:`OEErrorHandler <OESystem_OEErrorHandler>`.

   .. oe:method:: Msg

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Msg(unsigned int level, const std::string &)
            void Msg(unsigned int level, const char* format, ...)

      .. oe:language:: python

         .. oe:api:: python

            Msg(level: int, arg3: str) -> None

      Write a message at any ``level``. The ``level`` constant should
      be drawn from the :oe:constns:`OESystem::OEErrorLevel` namespace.

   .. oe:method:: SetHandlerImpl

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHandlerImpl(OEErrorHandlerImplBase* ptr, bool owned)

      .. oe:language:: python

         .. oe:api:: python

            SetHandlerImpl(ptr: OEErrorHandlerImplBase, owned: bool) -> None

      Use a different implementation of
      :ref:`OEErrorHandlerImplBase <OESystem_OEErrorHandlerImplBase>` to handle error
      messages. The ownership is determined by the ``owned`` flag,
      which is always ``false`` in any other language but C++.

      This method allows a user to completely redefine how the **OpenEye
      toolkits** handle error messages by declaring a new subclass of
      :ref:`OEErrorHandlerImplBase <OESystem_OEErrorHandlerImplBase>` and defining the
      :oe:meth:`OESystem::OEErrorHandlerImplBase::Msg` to have the
      desired behavior.

   .. oe:method:: SetLevel

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLevel(unsigned int errLevel)

      .. oe:language:: python

         .. oe:api:: python

            SetLevel(errLevel: int) -> None

      Controls whether a message passed to the error handler will make
      it to the output stream. Values greater than ``errLevel`` from
      the :oe:constns:`OESystem::OEErrorLevel` namespace will be sent
      to the output stream.

      .. warning::

         This method will only change the error level for the current
         thread. Child threads will not inherit the parent thread
         error level.

   .. oe:method:: SetOutputStream

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOutputStream(OEPlatform::oeostream& ofs)

      .. oe:language:: python

         .. oe:api:: python

            SetOutputStream(ofs: oeostream) -> None

      Sets the output stream (:ref:`oeostream <OEPlatform_oeostream>`)
      that diagnostic messages are written to when no custom
      error handler has been specified. By default, all messages are
      written to :oe:const:`OEPlatform::OEPlatform::oeerr`. This function can be used to
      redirect this output to either a file stream (:ref:`oeofstream <OEPlatform_oeofstream>`)
      or a string stream (:ref:`oeosstream <OEPlatform_oeosstream>`).

   .. oe:method:: SetStrict

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStrict(bool strict)

      .. oe:language:: python

         .. oe:api:: python

            SetStrict(strict: bool) -> None

      Sets the 'strict' property of the
      :ref:`OEErrorHandler <OESystem_OEErrorHandler>`.
      When the :ref:`OEErrorHandler <OESystem_OEErrorHandler>` is strict, all error
      messages written via the :oe:meth:`OESystem::OEErrorHandler::Error`
      methods are treated as fatal, and
      handled like those passed to :oe:meth:`OESystem::OEErrorHandler::Fatal`.
      When the :ref:`OEErrorHandler <OESystem_OEErrorHandler>` is
      not strict, error messages written via :oe:meth:`OESystem::OEErrorHandler::Error`
      are treated like those to :oe:meth:`OESystem::OEErrorHandler::Warning`.
      The strict property of an :ref:`OEErrorHandler <OESystem_OEErrorHandler>` can
      be retrieved by using the :oe:meth:`OESystem::OEErrorHandler::GetStrict`
      method.

   .. oe:method:: Usage

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Usage(const std::string &)
            void Usage(const char* format, ...)

      .. oe:language:: python

         .. oe:api:: python

            Usage(arg2: str) -> None

      Writes usage (warning) messages to the :ref:`OEErrorHandler <OESystem_OEErrorHandler>`.

   .. oe:method:: Verbose

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Verbose(const std::string &)
            void Verbose(const char* format, ...)

      .. oe:language:: python

         .. oe:api:: python

            Verbose(arg2: str) -> None

      Writes messages with the
      :oe:const:`OESystem::OEErrorLevel::Verbose` error message level
      to the :ref:`OEErrorHandler <OESystem_OEErrorHandler>`. By default, these
      messages will not appear.

   .. oe:method:: Warning

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Warning(const std::string &)
            void Warning(const char* format, ...)

      .. oe:language:: python

         .. oe:api:: python

            Warning(arg2: str) -> None

      Writes warning messages to the :ref:`OEErrorHandler <OESystem_OEErrorHandler>`.



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEErrorHandlerImplBase, ErrorHandlerImplBase

.. _OESystem_OEErrorHandlerImplBase:

.. oe:class:: OEErrorHandlerImplBase

   .. oe:api::

      class OEErrorHandlerImplBase

   This class represents `OEErrorHandlerImplBase`.

   The :ref:`OEErrorHandlerImplBase <OESystem_OEErrorHandlerImplBase>` abstract base class
   is used to define the API that can be used to customize an
   :ref:`OEErrorHandler <OESystem_OEErrorHandler>`, typically the system error
   handler, :oe:constns:`OESystem::OEThrow`. For example, this
   class may be implemented to customize how OpenEye toolkit messages
   are handled as all OpenEye toolkits will write their messages to
   :oe:constns:`OESystem::OEThrow`. The handler used by
   :oe:constns:`OESystem::OEThrow` can be changed with the
   :oe:meth:`OESystem::OEErrorHandler::SetHandlerImpl` method.

   Implementations of this class only need to implement
   :oe:meth:`OESystem::OEErrorHandlerImplBase::Msg` and
   :oe:meth:`OESystem::OEErrorHandlerImplBase::CreateCopy`.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEErrorHandlerImplBase()

      .. oe:language:: python

         .. oe:api:: python

            OEErrorHandlerImplBase() -> OEErrorHandlerImplBase
            OEErrorHandlerImplBase(arg2: OEErrorHandlerImplBase) -> OEErrorHandlerImplBase

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEErrorHandlerImplBase & operator=(const OEErrorHandlerImplBase &)

      Assignment operator.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

   .. oe:method:: Count

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int Count(unsigned int level = 0) const

      .. oe:language:: python

         .. oe:api:: python

            Count(level: int = 0) -> int

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEErrorHandlerImplBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEErrorHandlerImplBase

   .. oe:method:: GetLevel

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetLevel() const

      .. oe:language:: python

         .. oe:api:: python

            GetLevel() -> int

   .. oe:method:: GetStrict

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStrict() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrict() -> bool

   .. oe:method:: IncrementCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            void IncrementCount(unsigned int level)

      .. oe:language:: python

         .. oe:api:: python

            IncrementCount(level: int) -> None

   .. oe:method:: Msg

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Msg(unsigned int level, const std::string &)=0

      .. oe:language:: python

         .. oe:api:: python

            Msg(level: int, arg0: str) -> None

   .. oe:method:: SetLevel

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLevel(unsigned int level)

      .. oe:language:: python

         .. oe:api:: python

            SetLevel(level: int) -> None

   .. oe:method:: SetStrict

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStrict(bool strict)

      .. oe:language:: python

         .. oe:api:: python

            SetStrict(strict: bool) -> None



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEExponentColorGradient, ExponentColorGradient

.. _OESystem_OEExponentColorGradient:

.. oe:class:: OEExponentColorGradient

   .. oe:api::

      class OEExponentColorGradient : public OEColorGradientBase

   The :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` class interpolates between colors that
   are defined by using the OEColorStop class.
   The :oe:meth:`OESystem::OEExponentColorGradient::TransformValue` method
   defines the transformation that is performed before returning an
   interpolated color associated with a floating point value.
   The :ref:`Figure: Example of various exponent color gradients
   <figure_OEExponentColorGradient>`
   illustrates the difference between :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>`
   objects constructed with the same color stops but with different *exponent* values.
   An :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` object constructed with `1.0`
   *exponent* value is equivalent to an :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>`
   object constructed with the same color stops.

   .. _figure_OEExponentColorGradient:

   .. figure:: oechemtk/images/OEExponentAndLinearColorGradient.*
      :align:  center

      **Example of various exponent color gradients** generated with (-2.0, OERed), (0.0,
      OEWhite) and (+2.0, OEBlue) color stops

   .. seealso::

      * :ref:`OEColorStop <OESystem_OEColorStop>` class
      * :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>` class
      * :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class
      * :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>` class

   The following methods are publicly inherited from :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>`:

   ======================================================================= ======================================================================= ========================================================================
   :oe:meth:`operator=<OESystem::OEColorGradientBase::operator=>`          :oe:meth:`GetMaxColor<OESystem::OEColorGradientBase::GetMaxColor>`      :oe:meth:`GetStops<OESystem::OEColorGradientBase::GetStops>`            
   :oe:meth:`AddStop<OESystem::OEColorGradientBase::AddStop>`              :oe:meth:`GetMaxValue<OESystem::OEColorGradientBase::GetMaxValue>`      :oe:meth:`IsEmpty<OESystem::OEColorGradientBase::IsEmpty>`              
   :oe:meth:`DeleteStop<OESystem::OEColorGradientBase::DeleteStop>`        :oe:meth:`GetMinColor<OESystem::OEColorGradientBase::GetMinColor>`      :oe:meth:`NumStops<OESystem::OEColorGradientBase::NumStops>`            
   :oe:meth:`GetColorAt<OESystem::OEColorGradientBase::GetColorAt>`        :oe:meth:`GetMinValue<OESystem::OEColorGradientBase::GetMinValue>`      :oe:meth:`TransformValue<OESystem::OEColorGradientBase::TransformValue>`
   ======================================================================= ======================================================================= ========================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExponentColorGradient(double exponent)

      .. oe:language:: python

         .. oe:api:: python

            OEExponentColorGradient(exponent: float) -> OEExponentColorGradient

      Constructor that creates an "empty" color gradient with the given
      *exponent* value.

      *exponent*
        The given value is clamped into the range of ``[0.1, 10.0]``.

      .. note::

         An "empty" color gradient always returns the :oe:const:`OEBlack<OESystem::OESystem::OEBlack>`
         color, when calling the :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`,
         the :oe:meth:`OESystem::OEColorGradientBase::GetMinColor` or
         the :oe:meth:`OESystem::OEColorGradientBase::GetMaxColor` methods.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExponentColorGradient(double exponent, const OEColorStop& oneStop)

      .. oe:language:: python

         .. oe:api:: python

            OEExponentColorGradient(exponent: float, oneStop: OEColorStop) -> OEExponentColorGradient

      Creates an :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` object with
      one color stop and an *exponent* value.
      An :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>`  object that
      has only one color stop will always return that color when calling the
      :oe:meth:`OESystem::OEColorGradientBase::GetColorAt` method.

      *exponent*
        The given value is clamped into the range of ``[0.1, 10.0]``.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExponentColorGradient(double exponent,
                                    const OEColorStop& bgnStop,
                                    const OEColorStop& endStop)

      .. oe:language:: python

         .. oe:api:: python

            OEExponentColorGradient(exponent: float, bgnStop: OEColorStop,
                                    endStop: OEColorStop) -> OEExponentColorGradient

      Creates an :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` object with
      interpolation range between the two specified color stops using the
      given *exponent* value.

      *exponent*
        The given value is clamped into the range of ``[0.1, 10.0]``.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExponentColorGradient(const OEExponentColorGradient& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEExponentColorGradient(rhs: OEExponentColorGradient) -> OEExponentColorGradient

      Copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEExponentColorGradient &operator=(const OEExponentColorGradient &rhs)

      Assignment operator.

   .. oe:method:: GetExponent

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetExponent() const

      .. oe:language:: python

         .. oe:api:: python

            GetExponent() -> float

      Returns the *exponent* value used in the
      :oe:meth:`OESystem::OEExponentColorGradient::TransformValue` method.

   .. oe:method:: SetExponent

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetExponent(double exponent)

      .. oe:language:: python

         .. oe:api:: python

            SetExponent(exponent: float) -> None

      Sets the *exponent* value used in the
      :oe:meth:`OESystem::OEExponentColorGradient::TransformValue` method.

      *exponent*
        The given value is clamped into the range of ``[0.1, 10.0]``.

   .. oe:method:: TransformValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            double TransformValue(double value) const

      .. oe:language:: python

         .. oe:api:: python

            TransformValue(value: float) -> float

      Performs a
      :math:`f(x) = -x^y` transformation when x is less than 0.0 and
      :math:`f(x) = x^y` transformation when x is greater than 0.0, where
      the :math:`y` is the exponent returned by
      :oe:meth:`OESystem::OEExponentColorGradient::GetExponent` method.
      This method is called by :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`
      method to transform a value before performing color interpolation.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEExponentialColorGradient, ExponentialColorGradient

.. _OESystem_OEExponentialColorGradient:

.. oe:class:: OEExponentialColorGradient

   .. oe:api::

      class OEExponentialColorGradient : public OEColorGradientBase

   The :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>` class interpolates between colors that
   are defined by using the OEColorStop class.
   The :oe:meth:`OESystem::OEExponentialColorGradient::TransformValue` method
   defines the transformation that is performed before returning an
   interpolated color associated with a floating point value.
   The :ref:`Figure: Example of linear and exponential color gradients
   <figure_OEExponentialColorGradient>`
   illustrates the difference between a linear and a logarithmic colors
   gradients constructed with the same color stops.

   .. _figure_OEExponentialColorGradient:

   .. figure:: oechemtk/images/OEExponentialAndLinearColorGradient.*
      :align:  center

      **Example of linear and exponential color gradients** generated with (-2.5, OERed), (0.0,
      OEWhite) and (+2.5, OEBlue) color stops

   .. seealso::

      * :ref:`OEColorStop <OESystem_OEColorStop>` class
      * :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` class
      * :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class
      * :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>` class

   The following methods are publicly inherited from :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>`:

   ======================================================================= ======================================================================= ========================================================================
   :oe:meth:`operator=<OESystem::OEColorGradientBase::operator=>`          :oe:meth:`GetMaxColor<OESystem::OEColorGradientBase::GetMaxColor>`      :oe:meth:`GetStops<OESystem::OEColorGradientBase::GetStops>`            
   :oe:meth:`AddStop<OESystem::OEColorGradientBase::AddStop>`              :oe:meth:`GetMaxValue<OESystem::OEColorGradientBase::GetMaxValue>`      :oe:meth:`IsEmpty<OESystem::OEColorGradientBase::IsEmpty>`              
   :oe:meth:`DeleteStop<OESystem::OEColorGradientBase::DeleteStop>`        :oe:meth:`GetMinColor<OESystem::OEColorGradientBase::GetMinColor>`      :oe:meth:`NumStops<OESystem::OEColorGradientBase::NumStops>`            
   :oe:meth:`GetColorAt<OESystem::OEColorGradientBase::GetColorAt>`        :oe:meth:`GetMinValue<OESystem::OEColorGradientBase::GetMinValue>`      :oe:meth:`TransformValue<OESystem::OEColorGradientBase::TransformValue>`
   ======================================================================= ======================================================================= ========================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExponentialColorGradient()

      .. oe:language:: python

         .. oe:api:: python

            OEExponentialColorGradient() -> OEExponentialColorGradient

      Default constructor that creates an "empty" color gradient.

      .. note::

         An "empty" color gradient always returns the :oe:const:`OEBlack<OESystem::OESystem::OEBlack>`
         color, when calling the :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`,
         the :oe:meth:`OESystem::OEColorGradientBase::GetMinColor` or
         the :oe:meth:`OESystem::OEColorGradientBase::GetMaxColor` methods.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExponentialColorGradient(const OEColorStop& oneStop)

      .. oe:language:: python

         .. oe:api:: python

            OEExponentialColorGradient(oneStop: OEColorStop) -> OEExponentialColorGradient

      Creates an :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>` object with
      one color stop. An :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>`
      object that has only one color stop will always return that
      color when calling the
      :oe:meth:`OESystem::OEColorGradientBase::GetColorAt` method.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExponentialColorGradient(const OEColorStop& bgnStop,
                                       const OEColorStop& endStop)

      .. oe:language:: python

         .. oe:api:: python

            OEExponentialColorGradient(bgnStop: OEColorStop,
                                       endStop: OEColorStop) -> OEExponentialColorGradient

      Creates an :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>` object with
      interpolation range between the two specified color stops.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExponentialColorGradient(const OEExponentialColorGradient& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEExponentialColorGradient(rhs: OEExponentialColorGradient) -> OEExponentialColorGradient

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEExponentialColorGradient &operator=(const OEExponentialColorGradient &rhs)

      Assignment operator.

   .. oe:method:: TransformValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            double TransformValue(double value) const

      .. oe:language:: python

         .. oe:api:: python

            TransformValue(value: float) -> float

      Performs a
      :math:`f(x) = -exp(-x)+1.0` transformation when x is less than 0.0 and
      :math:`f(x) =  exp(x)-1.0)` transformation when x is greater than 0.0.
      This method is called by :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDataFlow

.. attention::

   |TWOLANGUAGE|

..  _OEDataFlow_OEFieldBase:

..  _OEDataFlow_OEField:

.. meta::
   :keywords: OEFieldBase, OEField, datarecord, OERecord
  
.. oe:language:: c++

   .. oe:class:: OEFieldBase
   
      .. oe:api::
   
         class OEFieldBase
   
      The :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` class is a base class for
      the templated :ref:`OEField <OEDataFlow_OEField>` classes used to
      set and get data from :ref:`OERecord <OEDataFlow_OERecord>` objects.
      In most cases, the templated, concrete 
      :ref:`OEField <OEDataFlow_OEField>` objects should be used.

      .. oe:method:: Constructors
   
         .. oe:api::

            OEFieldBase()

         The default constructor initializes the field object to an invalid
         field with no name or type.
   
         .. oe:api::

            OEFieldBase(const OEFieldBase& rhs)

         Copy constructor.
   
   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFieldBase & operator=(const OEFieldBase &)

      Assignment operator.

   
      .. oe:method:: GetName
   
         .. oe:api::

            std::string GetName() const

         Returns the field's name.
   
      .. oe:method:: SetName
   
         .. oe:api::

            void SetName(const std::string& name)

         Sets the name of the field.
   
      .. oe:method:: GetTypeName
   
         .. oe:api::

            std::string GetTypeName() const

         Returns the name of the field's type.
   
   
      .. oe:method:: IsNullable
   
         .. oe:api::

            bool IsNullable() const

         Returns true if the field allows setting of null values.
   
   
      .. oe:method:: IsReadonly
   
         .. oe:api::

            bool IsReadonly() const

         Returns true if the field only allows reading, but not writing, of
         data onto a record.
   
   
      .. oe:method:: IsValid
   
         .. oe:api::

            bool IsValid() const

         Returns true if the field has been initialized.
   
   
      .. oe:method:: GetMeta
   
         .. oe:api::

            OEFieldMeta GetMeta() const

         Returns the metadata associated with this field. If the field has no
         metadata, an empty :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` object
         is returned.
   
   
      .. oe:method:: SetMeta
   
         .. oe:api::

            void SetMeta(const OEFieldMeta& meta)

         Sets metadata for this field.
   
      .. seealso::
   
         * :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>`
   
   .. oe:class:: OEField
   
      .. oe:api::
   
         class OEField
   
      The OEField class is a templated subclass of
      :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` and is templated on types
      that can be stored on :ref:`OERecord <OEDataFlow_OERecord>`.
   
      The following methods are publicly inherited from 
      :ref:`OEFieldBase <OEDataFlow_OEFieldBase>`:
   
      =========================================================== =========================================================
      :oe:meth:`OEDataFlow::OEFieldBase::GetName`       	  :oe:meth:`OEDataFlow::OEFieldBase::SetName`
      :oe:meth:`OEDataFlow::OEFieldBase::GetTypeName`   	  :oe:meth:`OEDataFlow::OEFieldBase::IsNullable`
      :oe:meth:`OEDataFlow::OEFieldBase::IsReadonly`    	  :oe:meth:`OEDataFlow::OEFieldBase::IsValid`
      :oe:meth:`OEDataFlow::OEFieldBase::GetMeta`       	  :oe:meth:`OEDataFlow::OEFieldBase::SetMeta`
      =========================================================== =========================================================
   
      .. ################################################################
         # Constructors
         ################################################################
   
      .. oe:method:: Constructors
   
         .. oe:api::

            template<typename T> OEField<T>::OEField(const string &,
                                                     OEFieldMeta, bool, bool)

         This constructor initializes the field object with the specified type,
         name, and metadata, and sets the readonly and nullable states of the
         field.
   
         The :oe:constns:`OEDataFlow::Types` namespace contains the types of
         T that are supported.
   
         .. note::
   
            OEField objects are best created using the 
            :oe:func:`OEDataFlow::OEMakeField` function instead of this 
            constructor method.
   
         .. seealso::
         
            * :oe:func:`OEDataFlow::OEMakeField`
            * :ref:`OERecord <OEDataFlow_OERecord>`
   
         .. oe:api::

            template<typename T> OEField<T>::OEField(const OEFieldBase& f)

         Copy constructor.
   
      .. oe:method:: GetType
   
         .. oe:api::

            OEFieldType<T> GetType() const

         Returns an :ref:`OEFieldType <OEDataFlow_OEFieldType>` object
         representing the type of objects stored and retrieved by this field.
   
   ..  _OEDataFlow_OEVectorField:

   .. oe:class:: OEVectorField
   
      .. oe:api::
   
         class OEVectorField
   
      The OEVectorField class is a templated subclass of
      :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` and is templated on types
      that can be stored in vectors on :ref:`OERecord <OEDataFlow_OERecord>`.
   
      .. ################################################################
         # Constructors
         ################################################################
   
      .. oe:method:: Constructors
   
         .. oe:api::

            template<typename T> OEVectorField<T>::OEVectorField(const string &,
                                                                 OEFieldMeta = OEFieldMeta(),
                                                                 bool = false,
                                                                 bool = false)

         This constructor initializes the field object with the specified type,
         name, and metadata, and sets the readonly and nullable states of the
         field. An OEVectorField<T> can store and retrieve std::vector<T> objects
         to and from records.
   
         See the :oe:constns:`OEDataFlow::Types` namespace for types of
         T that are supported.
   
         .. note::
   
            OEVectorField objects are best created using the 
            :oe:func:`OEDataFlow::OEMakeField` function instead of this 
            constructor method.
   
   
         .. oe:api::

            template<typename T> OEVectorField<T>::OEVectorField(const OEFieldBase &)

         Copy constructor.
   
      .. oe:method:: GetType
   
         .. oe:api::

            OEVectorFieldType<T> GetType() const

         Returns an OEVectorFieldType object
         representing the type of objects stored and retrieved by this field.
   
   
   .. oe:class:: OEMatchField

      .. oe:api::

         class OEMatchField

      The OEMatchField class is a templated subclass of
      :ref:`OEField <OEDataFlow_OEField>`. It is used to retrieve values
      from an :ref:`OERecord <OEDataFlow_OERecord>` object when the
      name of the field is unknown. An OEMatchField object acts as a surrogate
      for the first field of a record that matches the type and metadata.
   
      .. ################################################################
         # Constructors
         ################################################################
   
      .. oe:method:: Constructors
   
         .. oe:api::

            OEMatchField(const std::string& name,
                         const OEFieldMeta meta = OEFieldMeta(),
                         bool readonly = false, bool nullable = false)

         This constructor initializes the match field object with the specified type,
         name, and metadata, and sets the readonly and nullable states of the
         field. The provided `name` parameter is only used if the match field creates
         a new field on a record.
   
         .. note::
   
            OEMatchField objects are best created using the 
            :oe:func:`OEDataFlow::OEMakeMatchField` function instead of this 
            constructor method.
   
   
      .. seealso::
   
         * :oe:func:`OEDataFlow::OEMakeMatchField`
         * :ref:`OEField <OEDataFlow_OEField>`
   
   
   .. oe:class:: OEMatchVectorField
   
      .. oe:api::
   
         class OEMatchVectorField
   
      The OEMatchVectorField class is a templated subclass of
      :ref:`OEVectorField <OEDataFlow_OEVectorField>`. It is used to retrieve values
      from an :ref:`OERecord <OEDataFlow_OERecord>` object when the
      name of the field is unknown. An OEMatchVectorField object acts as a surrogate
      for the first vector field of a record that matches the type and metadata.
   
   
      .. ################################################################
         # Constructors
         ################################################################
   
      .. oe:method:: Constructors
   
         .. oe:api::

            OEMatchVectorField(const std::string& name,
                               const OEFieldMeta meta = OEFieldMeta(),
                               bool readonly = false, bool nullable = false)

         This constructor initializes the match field object with the specified type,
         name, and metadata, and sets the readonly and nullable states of the
         field. The provided `name` parameter is only used if the match field creates
         a new field on a record. 
   
         .. note::
   
            OEMatchVectorField objects are best created using the 
            :oe:func:`OEDataFlow::OEMakeMatchField` function instead of this 
            constructor method.
   
      .. seealso::
   
         * :oe:func:`OEDataFlow::OEMakeMatchField`
         * :ref:`OEMatchField <OEDataFlow_OEMatchField>`
         * :ref:`OEVectorField <OEDataFlow_OEVectorField>`
   
.. oe:language:: python

   .. oe:class:: OEFieldBase
   
      .. oe:api::
   
         class OEFieldBase
   
      The :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` class is a base class for
      a number of specialized classes used to set and get data from 
      :ref:`OERecord <OEDataFlow_OERecord>` objects. These objects are
      returned from the OEField function and are not constructed directly.
   
      .. ################################################################
         # Constructors
         ################################################################
   
      .. oe:method:: Constructors
   
         .. oe:api::

            OEFieldBase()

         The default constructor initializes the field object to an invalid
         field with no name or type.
   
         .. oe:api::

            OEFieldBase(rhs: OEFieldBase)

         Copy constructor.
   
      .. _get_name:

      .. oe:method:: get_name
   
         .. oe:api::

            get_name() -> string

         Returns the field's name.
   
      .. _set_name:

      .. oe:method:: set_name
   
         .. oe:api::

            set_name(name: str) -> None

         Sets the name of the field.
   
      .. _get_type_name:

      .. oe:method:: get_type_name
   
         .. oe:api::

            get_type_name() -> string

         Returns the name of the field's type.
   
   
      .. _is_nullable:

      .. oe:method:: is_nullable
   
         .. oe:api::

            is_nullable() -> bool

         Returns True if the field allows setting of null values.
   
   
      .. _get_read_only:

      .. oe:method:: get_read_only
   
         .. oe:api::

            get_read_only() -> bool

         Returns True if the field only allows reading, but not writing, of
         data onto a record.
   
   
      .. _is_valid:

      .. oe:method:: is_valid
   
         .. oe:api::

            is_valid() -> bool

         Returns True if the field has been initialized.
   
   
      .. _get_meta:

      .. oe:method:: get_meta
   
         .. oe:api::

            get_meta() -> OEFieldMeta

         Returns the metadata associated with this field. If the field has no
         metadata, an empty :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` object
         is returned.
   
   
      .. _set_meta:

      .. oe:method:: set_meta
   
         .. oe:api::

            set_meta(meta: OEFieldMeta) -> None

         Sets metadata for this field.
   
      .. seealso::
   
         * :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>`
   
   .. oe:class:: OEField
   
      .. oe:api::
   
         OEField(name: str, dataType: OEFieldType, meta: OEFieldMeta,
                 read_only: bool = False, nullable: bool = False) -> field object of specific type
         
   
      In Python, OEField is a factory function returning a field object derived from
      :ref:`OEFieldBase <OEDataFlow_OEFieldBase>`. The returned field object can
      be used to set/get values on an :ref:`OERecord <OEDataFlow_OERecord>`.
  
      name
        The name to be given to the created field.

      dataType
        The type of field to create. Supported types come from the 
        :oe:constns:`OEDataFlow::Types` namespace.

      meta
        An :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` object containing
        metadata for the returned field.

      read_only
        If *True*, the returned field can only be used for reading from, and
        not writing to, :ref:`OERecord <OEDataFlow_OERecord>` objects.

      nullable
        If *True*, the returned field can be used to set null values onto
        an :ref:`OERecord <OEDataFlow_OERecord>`.

      The returned field object will have the following methods inherited from 
      :ref:`OEFieldBase <OEDataFlow_OEFieldBase>`:
   
      ================== ==========================
      get_name_          set_name_
      get_type_name_     is_nullable_
      get_read_only_     is_valid_
      get_meta_          set_meta_
      ================== ==========================

      .. seealso::
 
         * :ref:`OERecord <OEDataFlow_OERecord>`
   
      .. oe:method:: get_type
   
         .. oe:api::

            get_type() -> OEFieldType

         Returns an :ref:`OEFieldType <OEDataFlow_OEFieldType>` object
         representing the type of objects stored and retrieved by this field.
   
   
   .. _OEDataFlow_OEMatchField:

   .. oe:class:: OEMatchField
   
      .. oe:api::
   
         class OEMatchField
   
      OEMatchField is a factory function returning a specialized match field
      object. The returned match field is used to retrieve values
      from an :ref:`OERecord <OEDataFlow_OERecord>` object when the
      name of the field is unknown. An OEMatchField object acts as a surrogate
      for the first field of a record that matches the type and metadata.
   
      .. oe:api::
   
         OEMatchField(name: str, meta: OEFieldMeta, read_only: bool = False,
                      nullable: bool = False)
  
      name
        The name to be given to the created match field. It is only used if the
        match field is used to create a new field on a record.

      meta
        An :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` object containing
        metadata for the returned match field.

      read_only
        If *True*, the returned match field can only be used for reading from, and
        not writing to, :ref:`OERecord <OEDataFlow_OERecord>` objects.

      nullable
        If *True*, the returned match field can be used to set null values onto
        an :ref:`OERecord <OEDataFlow_OERecord>`.

        
      .. seealso::
   
         * :ref:`OEField <OEDataFlow_OEField>`
   
   


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDataFlow

.. attention::

   |TWOLANGUAGE|

.. meta::
   :keywords: OEFieldMeta datarecord

.. _OEDataFlow_OEFieldMeta:

.. oe:class:: OEFieldMeta

   .. oe:language:: c++ 

      .. oe:api::
   
         class OEFieldMeta
   
      The :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` class is used to
      associate metadata with data to be stored on :ref:`OERecord <OEDataFlow_OERecord>`
      objects. Two types of metadata can be assigned to an OEFieldMeta object:
      *options* are simple flags, while *attributes* are key-value pairs.
      Constants defining both options and attributes are defined in the
      :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         # Constructors
         ################################################################
   
      .. oe:method:: Constructors
   
         .. oe:api::
   
            OEFieldMeta()
   
         The default constructor initializes an empty metadata object.
   
         .. oe:api::
   
            OEFieldMeta(const OEFieldMeta& rhs)
   
         Copy constructor.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: SetOption
   
         .. oe:api::
   
            OEFieldMeta& SetOption(unsigned int option)
   
         Adds the specified option to the OEFieldMeta object. Options are specified
         in the :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: SetOptions
   
         .. oe:api::
   
            OEFieldMeta& SetOptions(const std::vector<unsigned int>& options)
   
         Sets all the option values for the OEFieldMeta object at once. Options 
         are specified in the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: GetOptions
   
         .. oe:api::
   
            const std::vector<unsigned int>& GetOptions() const
   
         Returns all the option values for the OEFieldMeta object at once.
         Options are specified in the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: HasOption
   
         .. oe:api::
   
            bool HasOption(unsigned int option) const
   
         Returns true if this OEFieldMeta object contains the specified
         option.
   

      .. ################################################################
         #
         ################################################################

      .. oe:method:: RemoveOption

         .. oe:api::

            OEMeta& RemoveOption(unsigned int option)

         Removes the specified option from the OEFieldMeta object.

      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: AddRelation
   
         .. oe:api::
   
            OEFieldMeta& AddRelation(unsigned int relationship,
                                     const OEFieldBase& otherField)
   
         Specifies a relationship to another field on the same record. For
         example, this could be used to specify that one field contains
         error bars for another field. The relationships are specified in the Relations
         section of the :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: GetRelatedFields
   
         .. oe:api::
   
            std::vector<std::string> GetRelatedFields() const
   
         Returns the names of fields that this OEFieldMeta object refers to.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: GetFieldRelations
   
         .. oe:api::
   
            std::vector<unsigned int> GetFieldRelations(const std::string& fieldName) const
   
         Returns the relationships that this OEFieldMeta object has to the
         named field. The relationships are specified in the
         Relations section of the :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: Clear
   
         .. oe:api::
   
            void Clear()
   
         Clears all attributes and options from the OEFieldMeta object.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: SetAttribute
   
         .. oe:api::
   
            OEFieldMeta& SetAttribute(unsigned int key,
                                      const std::string& value)
            OEFieldMeta& SetAttribute(unsigned int key, const double& value)
            OEFieldMeta& SetAttribute(unsigned int key, const int& value)
   
         Sets a metadata key-value pair on the OEFieldMeta object. Any attribute(s)
         with the same key are replaced. The key values are from the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: AddAttribute
   
         .. oe:api::
   
            OEFieldMeta& AddAttribute(unsigned int key,
                                      const std::string& value)
            OEFieldMeta& AddAttribute(unsigned int key, const double& value)
            OEFieldMeta& AddAttribute(unsigned int key, const int& value)
   
         Sets a metadata key-value pair on the OEFieldMeta object. Multiple
         attributes for the same key are allowed, and this method adds additional
         values for the specified key. The key values are from the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: GetAttribute
   
         .. oe:api::
   
            template<typename T> T GetAttribute(unsigned int key,
                                                unsigned int idx = 0) const
   
         Returns the attribute value for the provided key and index. If the OEFieldMeta
         object doesn't have a corresponding value, a default-constructed T object
         is returned. Because an attribute key can have multiple values, the *idx*
         argument specifies which value to return.  The key values are from the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: HasAttribute
   
         .. oe:api::
   
            bool HasAttribute(unsigned int key) const
            bool HasAttribute(unsigned int key, const std::string& value) const
            bool HasAttribute(unsigned int key, const double& value) const
            bool HasAttribute(unsigned int key, const int& value) const
   
         Returns true if this OEFieldMeta object contains the specified attribute.
         If the *value* argument is specified, the method will return true if
         that specific key-value pair is present. Otherwise, it will return true
         if any value is present for the provided key.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: RemoveAttribute
   
         .. oe:api::
   
            OEFieldMeta& RemoveAttribute(unsigned int key)
            OEFieldMeta& RemoveAttribute(unsigned int key,
                                         const std::string& value)
            OEFieldMeta& RemoveAttribute(unsigned int key, const double& value)
            OEFieldMeta& RemoveAttribute(unsigned int key, const int& value)
   
         Removes a metadata key-value pair from the OEFieldMeta object. If
         the *value* is specified, that specific key-value pair is removed
         from the OEFieldMeta object. Otherwise, all values with the provided
         key are removed.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: GetName
   
         .. oe:api::
   
            static std::string GetName(unsigned int optionOrAttributeKey)
   
         Returns a name for the specified option or attribute key.
   
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: GetValue
   
         .. oe:api::
   
            static unsigned int GetValue(const std::string& name)
   
         Returns an integer value for the specified option name.
         The returned values are from the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: IsOption
   
         .. oe:api::
   
            bool IsOption(unsigned int key)
   
         Returns true if the provided metadata key is an option, rather than
         an attribute. The key value is from the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
   .. oe:language:: python

      .. oe:api::
   
         class OEFieldMeta
   
      The :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` class is used to
      associate metadata with data to be stored on :ref:`OERecord <OEDataFlow_OERecord>`
      objects. Two types of metadata can be assigned to an OEFieldMeta object:
      *options* are simple flags, while *attributes* are key-value pairs.
      Constants defining both options and attributes are defined in the
      :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         # Constructors
         ################################################################
   
      .. oe:method:: Constructors
   
         .. oe:api::
   
            OEFieldMeta()
   
         The default constructor initializes an empty metadata object.
   
         .. oe:api::
   
            OEFieldMeta(rhs: OEFieldMeta)
   
         Copy constructor.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: set_option
   
         .. oe:api::
   
            set_option(option: int) -> OEFieldMeta
   
         Adds the specified option to the OEFieldMeta object. Options are specified
         in the :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: set_options
   
         .. oe:api::
   
            set_options(options: List[int]) -> OEFieldMeta
   
         Sets all the option values for the OEFieldMeta object at once. Options 
         are specified in the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.

      .. ################################################################
         #
         ################################################################

      .. oe:method:: remove_option
   
         .. oe:api::

            remove_option(option: int) -> OEFieldMeta

         Removes the specified option from the OEFieldMeta object.
         Options are specified
         in the :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.

      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: get_options
   
         .. oe:api::
   
            get_options() -> List[int]
   
         Returns all the option values for the OEFieldMeta object at once.
         Options are specified in the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: has_option
   
         .. oe:api::
   
            has_option(option: int) -> bool
   
         Returns *True* if this OEFieldMeta object contains the specified
         option.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: add_relation
   
         .. oe:api::
   
            add_relation(relationship: int, otherField: OEFieldBase) -> OEFieldMeta
   
         Specifies a relationship to another field on the same record. For
         example, this could be used to specify that one field contains
         error bars for another field. The relationships are specified in the
         ``Relations`` section of the :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: get_related_fields
   
         .. oe:api::
   
            get_related_fields() -> List[str]
   
         Returns the names of fields that this OEFieldMeta object refers to.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: get_field_relations
   
         .. oe:api::
   
            get_field_relations(fieldName: str) -> List[int]
   
         Returns the relationships that this OEFieldMeta object has to the
         named field. The relationships are specified in the ``Relations``
         section of the :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: clear
   
         .. oe:api::
   
            clear() -> None
    
         Clears all attributes and options from the OEFieldMeta object.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: set_attribute
   
         .. oe:api::
   
            set_attribute(key: int, value: str) -> OEFieldMeta
            set_attribute(key: int, value: int) -> OEFieldMeta
            set_attribute(key: int, value: float) -> OEFieldMeta
   
         Sets a metadata key-value pair on the OEFieldMeta object. Any attribute(s)
         with the same key are replaced. The key values are from the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: add_attribute
   
         .. oe:api::
   
            add_attribute(key: int, value: str) -> OEFieldMeta
            add_attribute(key: int, value: int) -> OEFieldMeta
            add_attribute(key: int, value: float) -> OEFieldMeta
   
         Sets a metadata key-value pair on the OEFieldMeta object. Multiple
         attributes for the same key are allowed, and this method adds additional
         values for the specified key. The key values are from the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: get_attribute
   
         .. oe:api::
   
            get_attribute(key: int, idx: int = 0) -> Union[str, int, float, None]
   
         Returns the attribute value for the provided key and index. If the OEFieldMeta
         object doesn't have a corresponding value, a *None* 
         is returned. Because an attribute key can have multiple values, the *idx*
         argument specifies which value to return.  The key values are from the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: has_attribute
   
         .. oe:api::
   
            has_attribute(key: int) -> bool
            has_attribute(key: int, value: str) -> bool
            has_attribute(key: int, value: int) -> bool
            has_attribute(key: int, value: float) -> bool
   
         Returns *True* if this OEFieldMeta object contains the specified attribute.
         If the *value* argument is specified, the method will return true if
         that specific key-value pair is present. Otherwise, it will return true
         if any value is present for the provided key.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: remove_attribute
   
         .. oe:api::
   
            remove_attribute(unsigned int key) -> OEFieldMeta
            remove_attribute(unsigned int key, value: str) -> OEFieldMeta
            remove_attribute(unsigned int key, value: int) -> OEFieldMeta
            remove_attribute(unsigned int key, value: float) -> OEFieldMeta
   
         Removes a metadata key-value pair from the OEFieldMeta object. If
         the *value* is specified, that specific key-value pair is removed
         from the OEFieldMeta object. Otherwise, all values with the provided
         key are removed.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: get_name
   
         .. oe:api::
   
            get_name(optionOrAttributeKey: int) -> str
   
         Returns a name for the specified option or attribute key.
   
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: get_value
   
         .. oe:api::
   
            get_value(name: str) -> int
   
         Returns an integer value for the specified option name.
         The returned values are from the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: is_option
   
         .. oe:api::
   
            IsOption(key: int) -> bool
   
         Returns *True* if the provided metadata key is an option, rather than
         an attribute. The key value is from the 
         :ref:`OEMetadata <OEDataFlow_OEMetadata>` namespace.
   


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDataFlow

.. attention::

   |TWOLANGUAGE|

..  _OEDataFlow_OEFieldType:

.. meta::
   :keywords: OEFieldType, OEField, OERecord, datarecord

.. oe:language:: c++

   .. oe:class:: OEFieldType
   
      .. oe:api::
   
         template<class T> class OEFieldType
   
      The :ref:`OEFieldType <OEDataFlow_OEFieldType>` class is a templated
      class used to construct :ref:`OEField <OEDataFlow_OEField>`
      objects for interacting with :ref:`OERecord <OEDataFlow_OERecord>` s.
   
      .. ################################################################
         # Constructor
         ################################################################
   
      .. oe:method:: Constructor
   
         .. oe:api::

            template <class T> OEFieldType<T> ()

      Generally, OEFieldType objects are not constructed directly, but
      are used from the :oe:constns:`OEDataFlow::Types` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: GetName
   
         .. oe:api::

            std::string GetName() const

         Returns the name of this field type.
   
         .. seealso::
   
            * :ref:`OEField <OEDataFlow_OEField>`
            * :ref:`OERecord <OEDataFlow_OERecord>`
            * :oe:constns:`OEDataFlow::Types`
   
      .. oe:method:: ToBytes
   
         .. oe:api::

            static OEBytes ToBytes(const T& val)

         Returns the binary representation of the value *val*.
   
   
      .. oe:method:: FromBytes
   
         .. oe:api::

            static bool FromBytes(T& val, const OEBytes& data)

         Returns true if a T value can be read from the provided bytes.
   
.. oe:language:: python

    .. _OEDataFlow_OEFieldTypeHandler:

.. oe:class:: OEFieldTypeHandler
   
      .. oe:api::
   
         class OEFieldTypeHandler
   
      The :ref:`OEFieldTypeHandler <OEDataFlow_OEFieldTypeHandler>` class is a
      base class for field types. OEFieldTypeHandler objects are not constructed
      by users, but specific handlers are found in the 
      :oe:constns:`OEDataFlow::Types` namespace.
   
      .. ################################################################
         #
         ################################################################
   
      .. oe:method:: get_name
   
         .. oe:api::

            get_name() -> str

         Returns the name of this field type.
   
         .. seealso::
   
            * :ref:`OEField <OEDataFlow_OEField>`
            * :ref:`OERecord <OEDataFlow_OERecord>`
            * :oe:constns:`OEDataFlow::Types`
  

      .. oe:method:: isPOD
   
         .. oe:api::

            isPOD() -> bool

         Returns true if the data type represents a simple "plain
         old data" type.
  
      .. oe:method:: is_cacheable

         .. oe:api::

            is_cacheable() -> bool

         Returns true if the data type can be cached on an
         :ref:`OERecord <OEDataFlow_OERecord>` object.
  


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEFixedGrid, FixedGrid

.. _OESystem_OEFixedGrid:

.. oe:class:: OEFixedGrid

   .. oe:api::

      template<class GridType>
      class OEFixedGrid : public OEGridBase

   This class represents `OEFixedGrid`.

   The following methods are publicly inherited from :ref:`OEGridBase <OESystem_OEGridBase>`:

   ============================================================================= ============================================================================ =============================================================================
   :oe:meth:`Clear<OESystem::OEGridBase::Clear>`                                 :oe:meth:`GetXMid<OESystem::OEGridBase::GetXMid>`                            :oe:meth:`GetZMin<OESystem::OEGridBase::GetZMin>`                            
   :oe:meth:`CreateCopy<OESystem::OEGridBase::CreateCopy>`                       :oe:meth:`GetXMin<OESystem::OEGridBase::GetXMin>`                            :oe:meth:`GridIdxToElement<OESystem::OEGridBase::GridIdxToElement>`          
   :oe:meth:`ElementToGridIdx<OESystem::OEGridBase::ElementToGridIdx>`           :oe:meth:`GetY<OESystem::OEGridBase::GetY>`                                  :oe:meth:`GridIdxToSpatialCoord<OESystem::OEGridBase::GridIdxToSpatialCoord>`
   :oe:meth:`ElementToSpatialCoord<OESystem::OEGridBase::ElementToSpatialCoord>` :oe:meth:`GetYDim<OESystem::OEGridBase::GetYDim>`                            :oe:meth:`IsDataType<OESystem::OEGridBase::IsDataType>`                      
   :oe:meth:`GetDataType<OESystem::OEGridBase::GetDataType>`                     :oe:meth:`GetYIdx<OESystem::OEGridBase::GetYIdx>`                            :oe:meth:`IsInGrid<OESystem::OEGridBase::IsInGrid>`                          
   :oe:meth:`GetDim<OESystem::OEGridBase::GetDim>`                               :oe:meth:`GetYInc<OESystem::OEGridBase::GetYInc>`                            :oe:meth:`IsSpacingSet<OESystem::OEGridBase::IsSpacingSet>`                  
   :oe:meth:`GetMid<OESystem::OEGridBase::GetMid>`                               :oe:meth:`GetYMax<OESystem::OEGridBase::GetYMax>`                            :oe:meth:`IsTitleSet<OESystem::OEGridBase::IsTitleSet>`                      
   :oe:meth:`GetSize<OESystem::OEGridBase::GetSize>`                             :oe:meth:`GetYMid<OESystem::OEGridBase::GetYMid>`                            :oe:meth:`IsXMidSet<OESystem::OEGridBase::IsXMidSet>`                        
   :oe:meth:`GetSpacing<OESystem::OEGridBase::GetSpacing>`                       :oe:meth:`GetYMin<OESystem::OEGridBase::GetYMin>`                            :oe:meth:`IsYMidSet<OESystem::OEGridBase::IsYMidSet>`                        
   :oe:meth:`GetTitle<OESystem::OEGridBase::GetTitle>`                           :oe:meth:`GetZ<OESystem::OEGridBase::GetZ>`                                  :oe:meth:`IsZMidSet<OESystem::OEGridBase::IsZMidSet>`                        
   :oe:meth:`GetX<OESystem::OEGridBase::GetX>`                                   :oe:meth:`GetZDim<OESystem::OEGridBase::GetZDim>`                            :oe:meth:`SetTitle<OESystem::OEGridBase::SetTitle>`                          
   :oe:meth:`GetXDim<OESystem::OEGridBase::GetXDim>`                             :oe:meth:`GetZIdx<OESystem::OEGridBase::GetZIdx>`                            :oe:meth:`SpatialCoordToElement<OESystem::OEGridBase::SpatialCoordToElement>`
   :oe:meth:`GetXIdx<OESystem::OEGridBase::GetXIdx>`                             :oe:meth:`GetZInc<OESystem::OEGridBase::GetZInc>`                            :oe:meth:`SpatialCoordToGridIdx<OESystem::OEGridBase::SpatialCoordToGridIdx>`
   :oe:meth:`GetXInc<OESystem::OEGridBase::GetXInc>`                             :oe:meth:`GetZMax<OESystem::OEGridBase::GetZMax>`                                                                                                         
   :oe:meth:`GetXMax<OESystem::OEGridBase::GetXMax>`                             :oe:meth:`GetZMid<OESystem::OEGridBase::GetZMid>`                                                                                                         
   ============================================================================= ============================================================================ =============================================================================

   The following methods are publicly inherited from :ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>`:

   ================================================================== ================================================================== ===================================================================
   :oe:meth:`Clear<OESystem::OEGridAbstractBase::Clear>`              :oe:meth:`GetTitle<OESystem::OEGridAbstractBase::GetTitle>`        :oe:meth:`GetZMid<OESystem::OEGridAbstractBase::GetZMid>`          
   :oe:meth:`GetDataType<OESystem::OEGridAbstractBase::GetDataType>`  :oe:meth:`GetXDim<OESystem::OEGridAbstractBase::GetXDim>`          :oe:meth:`IsDataType<OESystem::OEGridAbstractBase::IsDataType>`    
   :oe:meth:`GetDim<OESystem::OEGridAbstractBase::GetDim>`            :oe:meth:`GetXMid<OESystem::OEGridAbstractBase::GetXMid>`          :oe:meth:`IsSpacingSet<OESystem::OEGridAbstractBase::IsSpacingSet>`
   :oe:meth:`GetMid<OESystem::OEGridAbstractBase::GetMid>`            :oe:meth:`GetYDim<OESystem::OEGridAbstractBase::GetYDim>`          :oe:meth:`SetTitle<OESystem::OEGridAbstractBase::SetTitle>`        
   :oe:meth:`GetSize<OESystem::OEGridAbstractBase::GetSize>`          :oe:meth:`GetYMid<OESystem::OEGridAbstractBase::GetYMid>`                                                                             
   :oe:meth:`GetSpacing<OESystem::OEGridAbstractBase::GetSpacing>`    :oe:meth:`GetZDim<OESystem::OEGridAbstractBase::GetZDim>`                                                                             
   ================================================================== ================================================================== ===================================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   The following classes derive from this class:
    * :ref:`OEGrid <OESystem_OEGrid>`
    * :ref:`OEScalarGrid <OESystem_OEScalarGrid>`
   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            GridType& operator()(float x, float y, float z)
            const GridType& operator()(float x, float y, float z) const
            GridType& operator()(unsigned int ix, unsigned int iy, unsigned int iz)
            const GridType& operator()(unsigned int ix, unsigned int iy, unsigned int iz) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(x: float, y: float, z: float) -> GridType
            __call__(ix: int, iy: int, iz: int) -> GridType

   .. oe:method:: operator[]
      :language: c++

      .. oe:api::

         GridType &operator[](unsigned int el)
         const GridType &operator[](unsigned int el) const

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEFixedGrid

   .. oe:method:: GetDataType

      .. oe:api::

         const void *GetDataType() const

   .. oe:method:: GetValues

      .. oe:api::

         GridType *GetValues()
         const GridType *GetValues() const

   .. oe:method:: IsDataType

      .. oe:api::

         bool IsDataType(const void *type) const

   .. oe:method:: SetValues

      .. oe:api::

         bool SetValues(const GridType *dataptr, unsigned int length)



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEFixedMultiGrid, FixedMultiGrid

.. _OESystem_OEFixedMultiGrid:

.. oe:class:: OEFixedMultiGrid

   .. oe:api::

      template<class GridType>
      class OEFixedMultiGrid : public OEGridBase

   This class represents `OEFixedMultiGrid`.

   The following methods are publicly inherited from :ref:`OEGridBase <OESystem_OEGridBase>`:

   ============================================================================= ============================================================================ =============================================================================
   :oe:meth:`Clear<OESystem::OEGridBase::Clear>`                                 :oe:meth:`GetXMid<OESystem::OEGridBase::GetXMid>`                            :oe:meth:`GetZMin<OESystem::OEGridBase::GetZMin>`                            
   :oe:meth:`CreateCopy<OESystem::OEGridBase::CreateCopy>`                       :oe:meth:`GetXMin<OESystem::OEGridBase::GetXMin>`                            :oe:meth:`GridIdxToElement<OESystem::OEGridBase::GridIdxToElement>`          
   :oe:meth:`ElementToGridIdx<OESystem::OEGridBase::ElementToGridIdx>`           :oe:meth:`GetY<OESystem::OEGridBase::GetY>`                                  :oe:meth:`GridIdxToSpatialCoord<OESystem::OEGridBase::GridIdxToSpatialCoord>`
   :oe:meth:`ElementToSpatialCoord<OESystem::OEGridBase::ElementToSpatialCoord>` :oe:meth:`GetYDim<OESystem::OEGridBase::GetYDim>`                            :oe:meth:`IsDataType<OESystem::OEGridBase::IsDataType>`                      
   :oe:meth:`GetDataType<OESystem::OEGridBase::GetDataType>`                     :oe:meth:`GetYIdx<OESystem::OEGridBase::GetYIdx>`                            :oe:meth:`IsInGrid<OESystem::OEGridBase::IsInGrid>`                          
   :oe:meth:`GetDim<OESystem::OEGridBase::GetDim>`                               :oe:meth:`GetYInc<OESystem::OEGridBase::GetYInc>`                            :oe:meth:`IsSpacingSet<OESystem::OEGridBase::IsSpacingSet>`                  
   :oe:meth:`GetMid<OESystem::OEGridBase::GetMid>`                               :oe:meth:`GetYMax<OESystem::OEGridBase::GetYMax>`                            :oe:meth:`IsTitleSet<OESystem::OEGridBase::IsTitleSet>`                      
   :oe:meth:`GetSize<OESystem::OEGridBase::GetSize>`                             :oe:meth:`GetYMid<OESystem::OEGridBase::GetYMid>`                            :oe:meth:`IsXMidSet<OESystem::OEGridBase::IsXMidSet>`                        
   :oe:meth:`GetSpacing<OESystem::OEGridBase::GetSpacing>`                       :oe:meth:`GetYMin<OESystem::OEGridBase::GetYMin>`                            :oe:meth:`IsYMidSet<OESystem::OEGridBase::IsYMidSet>`                        
   :oe:meth:`GetTitle<OESystem::OEGridBase::GetTitle>`                           :oe:meth:`GetZ<OESystem::OEGridBase::GetZ>`                                  :oe:meth:`IsZMidSet<OESystem::OEGridBase::IsZMidSet>`                        
   :oe:meth:`GetX<OESystem::OEGridBase::GetX>`                                   :oe:meth:`GetZDim<OESystem::OEGridBase::GetZDim>`                            :oe:meth:`SetTitle<OESystem::OEGridBase::SetTitle>`                          
   :oe:meth:`GetXDim<OESystem::OEGridBase::GetXDim>`                             :oe:meth:`GetZIdx<OESystem::OEGridBase::GetZIdx>`                            :oe:meth:`SpatialCoordToElement<OESystem::OEGridBase::SpatialCoordToElement>`
   :oe:meth:`GetXIdx<OESystem::OEGridBase::GetXIdx>`                             :oe:meth:`GetZInc<OESystem::OEGridBase::GetZInc>`                            :oe:meth:`SpatialCoordToGridIdx<OESystem::OEGridBase::SpatialCoordToGridIdx>`
   :oe:meth:`GetXInc<OESystem::OEGridBase::GetXInc>`                             :oe:meth:`GetZMax<OESystem::OEGridBase::GetZMax>`                                                                                                         
   :oe:meth:`GetXMax<OESystem::OEGridBase::GetXMax>`                             :oe:meth:`GetZMid<OESystem::OEGridBase::GetZMid>`                                                                                                         
   ============================================================================= ============================================================================ =============================================================================

   The following methods are publicly inherited from :ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>`:

   ================================================================== ================================================================== ===================================================================
   :oe:meth:`Clear<OESystem::OEGridAbstractBase::Clear>`              :oe:meth:`GetTitle<OESystem::OEGridAbstractBase::GetTitle>`        :oe:meth:`GetZMid<OESystem::OEGridAbstractBase::GetZMid>`          
   :oe:meth:`GetDataType<OESystem::OEGridAbstractBase::GetDataType>`  :oe:meth:`GetXDim<OESystem::OEGridAbstractBase::GetXDim>`          :oe:meth:`IsDataType<OESystem::OEGridAbstractBase::IsDataType>`    
   :oe:meth:`GetDim<OESystem::OEGridAbstractBase::GetDim>`            :oe:meth:`GetXMid<OESystem::OEGridAbstractBase::GetXMid>`          :oe:meth:`IsSpacingSet<OESystem::OEGridAbstractBase::IsSpacingSet>`
   :oe:meth:`GetMid<OESystem::OEGridAbstractBase::GetMid>`            :oe:meth:`GetYDim<OESystem::OEGridAbstractBase::GetYDim>`          :oe:meth:`SetTitle<OESystem::OEGridAbstractBase::SetTitle>`        
   :oe:meth:`GetSize<OESystem::OEGridAbstractBase::GetSize>`          :oe:meth:`GetYMid<OESystem::OEGridAbstractBase::GetYMid>`                                                                             
   :oe:meth:`GetSpacing<OESystem::OEGridAbstractBase::GetSpacing>`    :oe:meth:`GetZDim<OESystem::OEGridAbstractBase::GetZDim>`                                                                             
   ================================================================== ================================================================== ===================================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   The following classes derive from this class:
    * :ref:`OEMultiGrid <OESystem_OEMultiGrid>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFixedMultiGrid & operator=(const OEFixedMultiGrid<GridType> & rhs)

      Assignment operator.

   

   .. oe:method:: operator[]
      :language: c++

      .. oe:api::

         OEFixedGrid<GridType>& operator[](unsigned int igrid)
         const OEFixedGrid<GridType>& operator[](unsigned int igrid) const

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEFixedMultiGrid

   .. oe:method:: GetDataType

      .. oe:api::

         const void *GetDataType() const

   .. oe:method:: GetNumGrids

      .. oe:api::

         unsigned int GetNumGrids() const

   .. oe:method:: GetValues

      .. oe:api::

         GridType *GetValues(unsigned int igrid = 0)
         const GridType *GetValues(unsigned int igrid = 0) const

   .. oe:method:: IsDataType

      .. oe:api::

         bool IsDataType(const void *type) const

   .. oe:method:: SetNumGrids

      .. oe:api::

         bool SetNumGrids(unsigned int n)



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEFloatParameter, FloatParameter

.. _OESystem_OEFloatParameter:

.. oe:class:: OEFloatParameter

   .. oe:api::

      class OEFloatParameter : public OEPODParameter<float>

   The :ref:`OEFloatParameter <OESystem_OEFloatParameter>` represents parameter that has ``float`` value.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OETypedParameter <OESystem_OETypedParameter>`:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   Following methods are publicly inherited from :ref:`OEPODParameter <OESystem_OEPODParameter>`:
    * :oe:meth:`GetDefaultsVector<OESystem::OEPODParameter::GetDefaultsVector>`
    * :oe:meth:`GetSettingsVector<OESystem::OEPODParameter::GetSettingsVector>`
    * :oe:meth:`GetValuesVector<OESystem::OEPODParameter::GetValuesVector>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFloatParameter()
            OEFloatParameter(const std::string& name)
            OEFloatParameter(const std::string& name, const float default)
            OEFloatParameter(const OEFloatParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEFloatParameter(name: str) -> OEFloatParameter
            OEFloatParameter(name: str, defValue: float) -> OEFloatParameter
            OEFloatParameter() -> OEFloatParameter
            OEFloatParameter(arg2: OEFloatParameter) -> OEFloatParameter

      Default and copy constructors.

      Constructs an :ref:`OEFloatParameter <OESystem_OEFloatParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFloatParameter &operator=(const OEFloatParameter &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGaussian, Gaussian

.. _OESystem_OEGaussian:

.. oe:class:: OEGaussian

   .. oe:api::

      class OEGaussian : public OEGaussianBase

   This class represents `OEGaussian`.

   The following methods are publicly inherited from :ref:`OEGaussianBase <OESystem_OEGaussianBase>`:

   =============================================================== =============================================================== ==============================================================
   :oe:meth:`GetCenter<OESystem::OEGaussianBase::GetCenter>`       :oe:meth:`GetY<OESystem::OEGaussianBase::GetY>`                 :oe:meth:`SetWidth<OESystem::OEGaussianBase::SetWidth>`       
   :oe:meth:`GetColor<OESystem::OEGaussianBase::GetColor>`         :oe:meth:`GetZ<OESystem::OEGaussianBase::GetZ>`                 :oe:meth:`SetX<OESystem::OEGaussianBase::SetX>`               
   :oe:meth:`GetDataType<OESystem::OEGaussianBase::GetDataType>`   :oe:meth:`IsDataType<OESystem::OEGaussianBase::IsDataType>`     :oe:meth:`SetY<OESystem::OEGaussianBase::SetY>`               
   :oe:meth:`GetPrefactor<OESystem::OEGaussianBase::GetPrefactor>` :oe:meth:`SetCenter<OESystem::OEGaussianBase::SetCenter>`       :oe:meth:`SetZ<OESystem::OEGaussianBase::SetZ>`               
   :oe:meth:`GetWidth<OESystem::OEGaussianBase::GetWidth>`         :oe:meth:`SetColor<OESystem::OEGaussianBase::SetColor>`                                                                       
   :oe:meth:`GetX<OESystem::OEGaussianBase::GetX>`                 :oe:meth:`SetPrefactor<OESystem::OEGaussianBase::SetPrefactor>`                                                               
   =============================================================== =============================================================== ==============================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEGaussian()
            OEGaussian(const OEGaussian& rhs)
            OEGaussian(const OEGaussianBase& rhs)
            OEGaussian(float prefactor, float width, float* xyz = 0,
                       unsigned int color = 0)
            OEGaussian(float prefactor, float width, float x, float y, float z,
                       unsigned int color = 0)

      .. oe:language:: python

         .. oe:api:: python

            OEGaussian() -> OEGaussian
            OEGaussian(prefactor: float, width: float,
                       xyz: OEFloatArray = None, color: int = 0) -> OEGaussian
            OEGaussian(prefactor: float, width: float, x: float, y: float,
                       z: float, color: int = 0) -> OEGaussian
            OEGaussian(rhs: OEGaussian) -> OEGaussian
            OEGaussian(rhs: OEGaussianBase) -> OEGaussian

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEGaussian& operator=(const OEGaussian& rhs)
         OEGaussian& operator=(const OEGaussianBase& rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEGaussian

   .. oe:method:: GetCenter

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetCenter(float* xyz) const

      .. oe:language:: python

         .. oe:api:: python

            GetCenter(xyz: OEFloatArray) -> None

   .. oe:method:: GetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> int

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

   .. oe:method:: GetPrefactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetPrefactor() const

      .. oe:language:: python

         .. oe:api:: python

            GetPrefactor() -> float

   .. oe:method:: GetWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetWidth() -> float

   .. oe:method:: GetX

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetX() const

      .. oe:language:: python

         .. oe:api:: python

            GetX() -> float

   .. oe:method:: GetY

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetY() const

      .. oe:language:: python

         .. oe:api:: python

            GetY() -> float

   .. oe:method:: GetZ

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZ() const

      .. oe:language:: python

         .. oe:api:: python

            GetZ() -> float

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

   .. oe:method:: SetCenter

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCenter(float* xyz)

      .. oe:language:: python

         .. oe:api:: python

            SetCenter(xyz: OEFloatArray) -> None

   .. oe:method:: SetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColor(unsigned int color)

      .. oe:language:: python

         .. oe:api:: python

            SetColor(color: int) -> None

   .. oe:method:: SetPrefactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPrefactor(float prefactor)

      .. oe:language:: python

         .. oe:api:: python

            SetPrefactor(prefactor: float) -> None

   .. oe:method:: SetWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetWidth(float width)

      .. oe:language:: python

         .. oe:api:: python

            SetWidth(width: float) -> None

   .. oe:method:: SetX

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetX(float x)

      .. oe:language:: python

         .. oe:api:: python

            SetX(x: float) -> None

   .. oe:method:: SetY

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetY(float y)

      .. oe:language:: python

         .. oe:api:: python

            SetY(y: float) -> None

   .. oe:method:: SetZ

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetZ(float z)

      .. oe:language:: python

         .. oe:api:: python

            SetZ(z: float) -> None



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGaussianBase, GaussianBase

.. _OESystem_OEGaussianBase:

.. oe:class:: OEGaussianBase

   .. oe:api::

      class OEGaussianBase : public OEBase

   This class represents `OEGaussianBase`.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   The following classes derive from this class:
    * :ref:`OEGaussian <OESystem_OEGaussian>`
   

   .. oe:method:: GetCenter

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetCenter(float* xyz) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetCenter(xyz: OEFloatArray) -> None

   .. oe:method:: GetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetColor() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> int

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

   .. oe:method:: GetPrefactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetPrefactor() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetPrefactor() -> float

   .. oe:method:: GetWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetWidth() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetWidth() -> float

   .. oe:method:: GetX

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetX() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetX() -> float

   .. oe:method:: GetY

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetY() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetY() -> float

   .. oe:method:: GetZ

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZ() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetZ() -> float

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

   .. oe:method:: SetCenter

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCenter(float* xyz)=0

      .. oe:language:: python

         .. oe:api:: python

            SetCenter(xyz: OEFloatArray) -> None

   .. oe:method:: SetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColor(unsigned int color)=0

      .. oe:language:: python

         .. oe:api:: python

            SetColor(color: int) -> None

   .. oe:method:: SetPrefactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPrefactor(float prefactor)=0

      .. oe:language:: python

         .. oe:api:: python

            SetPrefactor(prefactor: float) -> None

   .. oe:method:: SetWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetWidth(float width)=0

      .. oe:language:: python

         .. oe:api:: python

            SetWidth(width: float) -> None

   .. oe:method:: SetX

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetX(float x)=0

      .. oe:language:: python

         .. oe:api:: python

            SetX(x: float) -> None

   .. oe:method:: SetY

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetY(float y)=0

      .. oe:language:: python

         .. oe:api:: python

            SetY(y: float) -> None

   .. oe:method:: SetZ

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetZ(float z)=0

      .. oe:language:: python

         .. oe:api:: python

            SetZ(z: float) -> None



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGaussianContainer, GaussianContainer

.. _OESystem_OEGaussianContainer:

.. oe:class:: OEGaussianContainer

   .. oe:api::

      class OEGaussianContainer : public OEGaussianContainerBase

   This class represents `OEGaussianContainer`.

   The following methods are publicly inherited from :ref:`OEGaussianContainerBase <OESystem_OEGaussianContainerBase>`:

   ============================================================================== ============================================================================= =============================================================================
   :oe:meth:`AddGaussian<OESystem::OEGaussianContainerBase::AddGaussian>`         :oe:meth:`GetColors<OESystem::OEGaussianContainerBase::GetColors>`            :oe:meth:`GetPrefactors<OESystem::OEGaussianContainerBase::GetPrefactors>`   
   :oe:meth:`Clear<OESystem::OEGaussianContainerBase::Clear>`                     :oe:meth:`GetCoords<OESystem::OEGaussianContainerBase::GetCoords>`            :oe:meth:`GetWidths<OESystem::OEGaussianContainerBase::GetWidths>`           
   :oe:meth:`DeleteGaussian<OESystem::OEGaussianContainerBase::DeleteGaussian>`   :oe:meth:`GetDataType<OESystem::OEGaussianContainerBase::GetDataType>`        :oe:meth:`IsDataType<OESystem::OEGaussianContainerBase::IsDataType>`         
   :oe:meth:`DeleteGaussians<OESystem::OEGaussianContainerBase::DeleteGaussians>` :oe:meth:`GetGaussians<OESystem::OEGaussianContainerBase::GetGaussians>`      :oe:meth:`NumGaussians<OESystem::OEGaussianContainerBase::NumGaussians>`     
   ============================================================================== ============================================================================= =============================================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEGaussianContainer()
         OEGaussianContainer(const OEGaussianContainer &)
         OEGaussianContainer(const OEGaussianContainerBase &)

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEGaussianContainer& operator=(const OEGaussianContainer &)
         OEGaussianContainer& operator=(const OEGaussianContainerBase &)

      Assignment operator.

   .. oe:method:: AddGaussian

      .. oe:api::

         bool AddGaussian(const OEGaussianBase &)

   .. oe:method:: Clear

      .. oe:api::

         void Clear()

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEGaussianContainer

   .. oe:method:: DeleteGaussian

      .. oe:api::

         bool DeleteGaussian(OEGaussianBase *)

   .. oe:method:: DeleteGaussians

      .. oe:api::

         void DeleteGaussians()

   .. oe:method:: GetColors

      .. oe:api::

         bool GetColors(unsigned int *) const

   .. oe:method:: GetCoords

      .. oe:api::

         bool GetCoords(float *) const
         bool GetCoords(double *) const

   .. oe:method:: GetDataType

      .. oe:api::

         const void *GetDataType() const

   .. oe:method:: GetGaussians

      .. oe:api::

         OESystem::OEIterBase<OEGaussianBase> *GetGaussians()
         OESystem::OEIterBase<const OEGaussianBase> *GetGaussians() const

   .. oe:method:: GetPrefactors

      .. oe:api::

         bool GetPrefactors(float *) const
         bool GetPrefactors(double *) const

   .. oe:method:: GetWidths

      .. oe:api::

         bool GetWidths(float *) const
         bool GetWidths(double *) const

   .. oe:method:: IsDataType

      .. oe:api::

         bool IsDataType(const void *) const

   .. oe:method:: NumGaussians

      .. oe:api::

         unsigned int NumGaussians() const



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGaussianContainerBase, GaussianContainerBase

.. _OESystem_OEGaussianContainerBase:

.. oe:class:: OEGaussianContainerBase

   .. oe:api::

      class OEGaussianContainerBase  : public OEBase

   This class represents `OEGaussianContainerBase`.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   The following classes derive from this class:
    * :ref:`OEGaussianContainer <OESystem_OEGaussianContainer>`
   

   .. oe:method:: AddGaussian

      .. oe:api::

         bool AddGaussian(const OEGaussianBase &)=0

   .. oe:method:: Clear

      .. oe:api::

         void Clear()

   .. oe:method:: DeleteGaussian

      .. oe:api::

         bool DeleteGaussian(OEGaussianBase *)=0

   .. oe:method:: DeleteGaussians

      .. oe:api::

         void DeleteGaussians()=0

   .. oe:method:: GetColors

      .. oe:api::

         bool GetColors(unsigned int *) const = 0

   .. oe:method:: GetCoords

      .. oe:api::

         bool GetCoords(float *) const = 0
         bool GetCoords(double *) const = 0

   .. oe:method:: GetDataType

      .. oe:api::

         const void* GetDataType() const

   .. oe:method:: GetGaussians

      .. oe:api::

         OESystem::OEIterBase<OEGaussianBase>* GetGaussians()=0
         OESystem::OEIterBase<const OEGaussianBase>* GetGaussians() const = 0

   .. oe:method:: GetPrefactors

      .. oe:api::

         bool GetPrefactors(float *) const = 0
         bool GetPrefactors(double *) const = 0

   .. oe:method:: GetWidths

      .. oe:api::

         bool GetWidths(float *) const = 0
         bool GetWidths(double *) const = 0

   .. oe:method:: IsDataType

      .. oe:api::

         bool IsDataType(const void *) const

   .. oe:method:: NumGaussians

      .. oe:api::

         unsigned int NumGaussians() const = 0



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGrid, Grid

.. _OESystem_OEGrid:

.. oe:class:: OEGrid

   .. oe:api::

      template<class GridType>
      class OEGrid : public OEFixedGrid<GridType>

   This class represents `OEGrid`.

   The following methods are publicly inherited from :ref:`OEFixedGrid <OESystem_OEFixedGrid>`:

   ========================================================= ========================================================== =========================================================
   :oe:meth:`operator()<OESystem::OEFixedGrid::operator()>`  :oe:meth:`GetDataType<OESystem::OEFixedGrid::GetDataType>` :oe:meth:`SetValues<OESystem::OEFixedGrid::SetValues>`   
   :oe:meth:`operator[]<OESystem::OEFixedGrid::operator[]>`  :oe:meth:`GetValues<OESystem::OEFixedGrid::GetValues>`                                                              
   :oe:meth:`CreateCopy<OESystem::OEFixedGrid::CreateCopy>`  :oe:meth:`IsDataType<OESystem::OEFixedGrid::IsDataType>`                                                            
   ========================================================= ========================================================== =========================================================

   The following methods are publicly inherited from :ref:`OEGridBase <OESystem_OEGridBase>`:

   ============================================================================= ============================================================================ =============================================================================
   :oe:meth:`Clear<OESystem::OEGridBase::Clear>`                                 :oe:meth:`GetXMid<OESystem::OEGridBase::GetXMid>`                            :oe:meth:`GetZMin<OESystem::OEGridBase::GetZMin>`                            
   :oe:meth:`CreateCopy<OESystem::OEGridBase::CreateCopy>`                       :oe:meth:`GetXMin<OESystem::OEGridBase::GetXMin>`                            :oe:meth:`GridIdxToElement<OESystem::OEGridBase::GridIdxToElement>`          
   :oe:meth:`ElementToGridIdx<OESystem::OEGridBase::ElementToGridIdx>`           :oe:meth:`GetY<OESystem::OEGridBase::GetY>`                                  :oe:meth:`GridIdxToSpatialCoord<OESystem::OEGridBase::GridIdxToSpatialCoord>`
   :oe:meth:`ElementToSpatialCoord<OESystem::OEGridBase::ElementToSpatialCoord>` :oe:meth:`GetYDim<OESystem::OEGridBase::GetYDim>`                            :oe:meth:`IsDataType<OESystem::OEGridBase::IsDataType>`                      
   :oe:meth:`GetDataType<OESystem::OEGridBase::GetDataType>`                     :oe:meth:`GetYIdx<OESystem::OEGridBase::GetYIdx>`                            :oe:meth:`IsInGrid<OESystem::OEGridBase::IsInGrid>`                          
   :oe:meth:`GetDim<OESystem::OEGridBase::GetDim>`                               :oe:meth:`GetYInc<OESystem::OEGridBase::GetYInc>`                            :oe:meth:`IsSpacingSet<OESystem::OEGridBase::IsSpacingSet>`                  
   :oe:meth:`GetMid<OESystem::OEGridBase::GetMid>`                               :oe:meth:`GetYMax<OESystem::OEGridBase::GetYMax>`                            :oe:meth:`IsTitleSet<OESystem::OEGridBase::IsTitleSet>`                      
   :oe:meth:`GetSize<OESystem::OEGridBase::GetSize>`                             :oe:meth:`GetYMid<OESystem::OEGridBase::GetYMid>`                            :oe:meth:`IsXMidSet<OESystem::OEGridBase::IsXMidSet>`                        
   :oe:meth:`GetSpacing<OESystem::OEGridBase::GetSpacing>`                       :oe:meth:`GetYMin<OESystem::OEGridBase::GetYMin>`                            :oe:meth:`IsYMidSet<OESystem::OEGridBase::IsYMidSet>`                        
   :oe:meth:`GetTitle<OESystem::OEGridBase::GetTitle>`                           :oe:meth:`GetZ<OESystem::OEGridBase::GetZ>`                                  :oe:meth:`IsZMidSet<OESystem::OEGridBase::IsZMidSet>`                        
   :oe:meth:`GetX<OESystem::OEGridBase::GetX>`                                   :oe:meth:`GetZDim<OESystem::OEGridBase::GetZDim>`                            :oe:meth:`SetTitle<OESystem::OEGridBase::SetTitle>`                          
   :oe:meth:`GetXDim<OESystem::OEGridBase::GetXDim>`                             :oe:meth:`GetZIdx<OESystem::OEGridBase::GetZIdx>`                            :oe:meth:`SpatialCoordToElement<OESystem::OEGridBase::SpatialCoordToElement>`
   :oe:meth:`GetXIdx<OESystem::OEGridBase::GetXIdx>`                             :oe:meth:`GetZInc<OESystem::OEGridBase::GetZInc>`                            :oe:meth:`SpatialCoordToGridIdx<OESystem::OEGridBase::SpatialCoordToGridIdx>`
   :oe:meth:`GetXInc<OESystem::OEGridBase::GetXInc>`                             :oe:meth:`GetZMax<OESystem::OEGridBase::GetZMax>`                                                                                                         
   :oe:meth:`GetXMax<OESystem::OEGridBase::GetXMax>`                             :oe:meth:`GetZMid<OESystem::OEGridBase::GetZMid>`                                                                                                         
   ============================================================================= ============================================================================ =============================================================================

   The following methods are publicly inherited from :ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>`:

   ================================================================== ================================================================== ===================================================================
   :oe:meth:`Clear<OESystem::OEGridAbstractBase::Clear>`              :oe:meth:`GetTitle<OESystem::OEGridAbstractBase::GetTitle>`        :oe:meth:`GetZMid<OESystem::OEGridAbstractBase::GetZMid>`          
   :oe:meth:`GetDataType<OESystem::OEGridAbstractBase::GetDataType>`  :oe:meth:`GetXDim<OESystem::OEGridAbstractBase::GetXDim>`          :oe:meth:`IsDataType<OESystem::OEGridAbstractBase::IsDataType>`    
   :oe:meth:`GetDim<OESystem::OEGridAbstractBase::GetDim>`            :oe:meth:`GetXMid<OESystem::OEGridAbstractBase::GetXMid>`          :oe:meth:`IsSpacingSet<OESystem::OEGridAbstractBase::IsSpacingSet>`
   :oe:meth:`GetMid<OESystem::OEGridAbstractBase::GetMid>`            :oe:meth:`GetYDim<OESystem::OEGridAbstractBase::GetYDim>`          :oe:meth:`SetTitle<OESystem::OEGridAbstractBase::SetTitle>`        
   :oe:meth:`GetSize<OESystem::OEGridAbstractBase::GetSize>`          :oe:meth:`GetYMid<OESystem::OEGridAbstractBase::GetYMid>`                                                                             
   :oe:meth:`GetSpacing<OESystem::OEGridAbstractBase::GetSpacing>`    :oe:meth:`GetZDim<OESystem::OEGridAbstractBase::GetZDim>`                                                                             
   ================================================================== ================================================================== ===================================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   The following classes derive from this class:
    * :ref:`OEScalarGrid <OESystem_OEScalarGrid>`
   
   .. oe:method:: Constructors

      .. oe:api::

         OEGrid()

      Creates a one point :ref:`OEScalarGrid <OESystem_OEScalarGrid>` grid object.

      .. oe:api::

         OEGrid(const OEGrid<GridType>& rhs)
         OEGrid(const OEFixedGrid<GridType>& rhs)

      Creates a :ref:`OEGrid <OESystem_OEGrid>` object and copies the entire contents of the 'rhs' grid.

      .. oe:api::

         OEGrid(const float minmax[6], float spacing, const char* title = "")
         OEGrid(const double minmax[6], double spacing, const char* title = "")

      Creates a :ref:`OEGrid <OESystem_OEGrid>` object from a minimum bounding box ('minmax').
      The size of each length between grid points is determined by the 'spacing' parameter. 
      The 'title' parameter is provided as a convenience for setting the title upon construction. 
      It can later be retrieved with the :oe:meth:`OESystem::OEGridBase::GetTitle` method.

      .. oe:api::

         OEGrid(int xdim, int ydim, int zdim, float midx, float midy,
                float midz, float spacing, std::string title = "",
                GridType* dataptr = 0)

      Creates and initializes a :ref:`OEGrid <OESystem_OEGrid>` object. The
      grid data can be copied from the optional parameter
      'dataptr'. The pointer should be an array of size
      ``xdim*ydim*zdim*sizeof(float)``.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEGrid<GridType>& operator=(const OEGrid<GridType>& rhs)
         OEGrid<GridType>& operator=(const OEFixedGrid<GridType>& rhs)

      Copies the contents of 'rhs' grid.

      Assignment operator.

   .. oe:method:: Clear

      .. oe:api::

         void Clear()

      Reallocates memory for the grid, effectively clearing all the grid values. 
      Calls through to :oe:meth:`OESystem::OEBase::Clear`.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEGrid

   .. oe:method:: GetDataType

      .. oe:api::

         const void *GetDataType() const

   .. oe:method:: IsDataType

      .. oe:api::

         bool IsDataType(const void *type) const

   .. oe:method:: SetAll

      .. oe:api::

         bool SetAll(unsigned int xdim, unsigned int ydim, unsigned int zdim,
                     float midx, float midy, float midz, float spacing,
                     std::string title, GridType *dataptr)

      Convenience method for setting all the properties of this grid at once.

   .. oe:method:: SetDim

      .. oe:api::

         bool SetDim(unsigned int ixdim, unsigned int iydim, unsigned int izdim)

      Sets the number of grid points for each dimension.

   .. oe:method:: SetMid

      .. oe:api::

         bool SetMid(float x, float y, float z)

      Sets the mid-point (center) of the grid.

   .. oe:method:: SetSpacing

      .. oe:api::

         bool SetSpacing(float spacing)

      Sets the length between grid points.

   .. oe:method:: SetXDim

      .. oe:api::

         bool SetXDim(unsigned int ixdim)

      Sets the number of grid points in the x-dimension.

   .. oe:method:: SetXMid

      .. oe:api::

         bool SetXMid(float x)

      Sets the mid-point (center) in the x-dimension.

   .. oe:method:: SetYDim

      .. oe:api::

         bool SetYDim(unsigned int iydim)

      Sets the number of grid points in the y-dimension.

   .. oe:method:: SetYMid

      .. oe:api::

         bool SetYMid(float y)

      Sets the mid-point (center) in the y-dimension.

   .. oe:method:: SetZDim

      .. oe:api::

         bool SetZDim(unsigned int izdim)

      Sets the number of grid points in the z-dimension.

   .. oe:method:: SetZMid

      .. oe:api::

         bool SetZMid(float z)

      Sets the mid-point (center) in the z-dimension.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridAbstractBase, GridAbstractBase

.. _OESystem_OEGridAbstractBase:

.. oe:class:: OEGridAbstractBase

   .. oe:api::

      class OEGridAbstractBase : public OEBase

   This class represents `OEGridAbstractBase`.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   The following classes derive from this class:
    * :ref:`OEFixedGrid <OESystem_OEFixedGrid>`
    * :ref:`OEFixedMultiGrid <OESystem_OEFixedMultiGrid>`
    * :ref:`OEGrid <OESystem_OEGrid>`
    * :ref:`OEGridBase <OESystem_OEGridBase>`
    * :ref:`OEMultiGrid <OESystem_OEMultiGrid>`
    * :ref:`OEScalarGrid <OESystem_OEScalarGrid>`
    * :ref:`OESkewGrid <OESystem_OESkewGrid>`
   

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

   .. oe:method:: GetDim

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetDim(unsigned int& xdim, unsigned int& ydim,
                        unsigned int& zdim) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetDim() -> (nx: int, ny: int, nz: int)

   .. oe:method:: GetMid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMid(float& x, float& y, float& z) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetMid() -> (x: float, y: float, z: float)

   .. oe:method:: GetSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSize() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetSize() -> int

   .. oe:method:: GetSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSpacing() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetSpacing() -> float

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetTitle() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

   .. oe:method:: GetXDim

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetXDim() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetXDim() -> int

   .. oe:method:: GetXMid

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetXMid() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetXMid() -> float

   .. oe:method:: GetYDim

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetYDim() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetYDim() -> int

   .. oe:method:: GetYMid

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetYMid() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetYMid() -> float

   .. oe:method:: GetZDim

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetZDim() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetZDim() -> int

   .. oe:method:: GetZMid

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZMid() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetZMid() -> float

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void* type) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(type: void) -> bool

   .. oe:method:: IsSpacingSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsSpacingSet() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsSpacingSet() -> bool

   .. oe:method:: SetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTitle(const std::string& title)=0

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(title: str) -> bool



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridBase, GridBase

.. _OESystem_OEGridBase:

.. oe:class:: OEGridBase

   .. oe:api::

      class OEGridBase : public OEGridAbstractBase

   This class represents `OEGridBase`.

   The following methods are publicly inherited from :ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>`:

   ================================================================== ================================================================== ===================================================================
   :oe:meth:`Clear<OESystem::OEGridAbstractBase::Clear>`              :oe:meth:`GetTitle<OESystem::OEGridAbstractBase::GetTitle>`        :oe:meth:`GetZMid<OESystem::OEGridAbstractBase::GetZMid>`          
   :oe:meth:`GetDataType<OESystem::OEGridAbstractBase::GetDataType>`  :oe:meth:`GetXDim<OESystem::OEGridAbstractBase::GetXDim>`          :oe:meth:`IsDataType<OESystem::OEGridAbstractBase::IsDataType>`    
   :oe:meth:`GetDim<OESystem::OEGridAbstractBase::GetDim>`            :oe:meth:`GetXMid<OESystem::OEGridAbstractBase::GetXMid>`          :oe:meth:`IsSpacingSet<OESystem::OEGridAbstractBase::IsSpacingSet>`
   :oe:meth:`GetMid<OESystem::OEGridAbstractBase::GetMid>`            :oe:meth:`GetYDim<OESystem::OEGridAbstractBase::GetYDim>`          :oe:meth:`SetTitle<OESystem::OEGridAbstractBase::SetTitle>`        
   :oe:meth:`GetSize<OESystem::OEGridAbstractBase::GetSize>`          :oe:meth:`GetYMid<OESystem::OEGridAbstractBase::GetYMid>`                                                                             
   :oe:meth:`GetSpacing<OESystem::OEGridAbstractBase::GetSpacing>`    :oe:meth:`GetZDim<OESystem::OEGridAbstractBase::GetZDim>`                                                                             
   ================================================================== ================================================================== ===================================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   The following classes derive from this class:
    * :ref:`OEFixedGrid <OESystem_OEFixedGrid>`
    * :ref:`OEFixedMultiGrid <OESystem_OEFixedMultiGrid>`
    * :ref:`OEGrid <OESystem_OEGrid>`
    * :ref:`OEMultiGrid <OESystem_OEMultiGrid>`
    * :ref:`OEScalarGrid <OESystem_OEScalarGrid>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEGridBase & operator=(const OEGridBase & rhs)

      Assignment operator.

   

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Reallocates memory for the grid, effectively clearing all the grid values. 
      Calls through to :oe:meth:`OESystem::OEBase::Clear`.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

      Makes a copy of the grid instance.

   .. oe:method:: ElementToGridIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ElementToGridIdx(unsigned int el, unsigned int& ix,
                                  unsigned int& iy, unsigned int& iz) const

      .. oe:language:: python

         .. oe:api:: python

            ElementToGridIdx(el: int) -> (ix: int, iy: int, iz: int)

      The element 'el' is the one dimensional index into the grid points. 
      This function converts this one dimensional index into the three dimensional 
      indices (ix, iy, iz) for the associated grid point. 
      Returns ``false`` if 'el' is outside the array bounds.

   .. oe:method:: ElementToSpatialCoord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ElementToSpatialCoord(unsigned int el, float& x, float& y,
                                       float& z) const

      .. oe:language:: python

         .. oe:api:: python

            ElementToSpatialCoord(el: int) -> (x: float, y: float, z: float)

      The element 'el' is the one dimensional index into the grid points. 
      This function converts this one dimensional index into the Cartesian coordinates 
      (x,y,z) of the associated grid point. Returns false if 'el' is outside the array bounds.

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

   .. oe:method:: GetDim

      .. oe:api::

         bool GetDim(unsigned int &xdim, unsigned int &ydim, unsigned int &zdim) const

      Retrieves the grid dimensions (*i.e.* the wideness of the grid for a specific axis) 
      into 'xdim', 'ydim', 'zdim' arguments. 

   .. oe:method:: GetMid

      .. oe:api::

         bool GetMid(float &x, float &y, float &z) const

      Retrieves the grid midpoint (*i.e.* the center of the grid) into 'midx', 'midy' and 
      'midz' arguments. The midpoint defines where the grid is located in Cartesian space. 
      Returns ``false`` if the midpoint is not completely defined 
      (! :oe:meth:`IsXMidSet()<OESystem::OEGridBase::IsXMidSet>` || 
      ! :oe:meth:`IsYMidSet()<OESystem::OEGridBase::IsYMidSet>` || 
      ! :oe:meth:`IsZMidSet()<OESystem::OEGridBase::IsZMidSet>`)

   .. oe:method:: GetSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetSize() -> int

      Returns the number of grid points inside this grid.

   .. oe:method:: GetSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSpacing() const

      .. oe:language:: python

         .. oe:api:: python

            GetSpacing() -> float

      Returns the length between grid points.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Returns the title of this grid. The title defaults to an empty string.

   .. oe:method:: GetX

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetX(unsigned int ix) const

      .. oe:language:: python

         .. oe:api:: python

            GetX(ix: int) -> float

      Returns the x-component of the Cartesian coordinate for the grid points with the x-index of 'ix'.

   .. oe:method:: GetXDim

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetXDim() const

      .. oe:language:: python

         .. oe:api:: python

            GetXDim() -> int

      Returns how many grid points there are for the x-dimension of this grid.

   .. oe:method:: GetXIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetXIdx(float x) const

      .. oe:language:: python

         .. oe:api:: python

            GetXIdx(x: float) -> int

      Returns the grid index in the x-dimension for the grid point identified 
      by 'x', that corresponds to the x-component of the Cartesian coordinates. 

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetXIdx(unsigned int el) const

      .. oe:language:: python

         .. oe:api:: python

            GetXIdx(el: int) -> int

      Returns the grid index in the x-dimension for the grid point identified 
      by 'el', that corresponds to a specific point in the grid.

   .. oe:method:: GetXInc

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetXInc() const

      .. oe:language:: python

         .. oe:api:: python

            GetXInc() -> int

      Returns the increment to be added or subtracted to the grid point index to 
      access the neighbor grid points along the x-axis.

   .. oe:method:: GetXMax

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetXMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetXMax() -> float

      Returns the maximum extent of this grid along the x-axis.

   .. oe:method:: GetXMid

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetXMid() const

      .. oe:language:: python

         .. oe:api:: python

            GetXMid() -> float

      Returns the center of this grid along the x-axis.

   .. oe:method:: GetXMin

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetXMin() const

      .. oe:language:: python

         .. oe:api:: python

            GetXMin() -> float

      Returns the minimum extent of this grid along the x-axis.

   .. oe:method:: GetY

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetY(unsigned int iy) const

      .. oe:language:: python

         .. oe:api:: python

            GetY(iy: int) -> float

      Returns the y-component of the Cartesian coordinate for the grid points with the y-index of 'iy'.

   .. oe:method:: GetYDim

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetYDim() const

      .. oe:language:: python

         .. oe:api:: python

            GetYDim() -> int

      Returns how many grid points there are for the y-dimension of this grid.

   .. oe:method:: GetYIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetYIdx(float y) const

      .. oe:language:: python

         .. oe:api:: python

            GetYIdx(y: float) -> int

      Returns the grid index in the y-dimension for the grid point identified 
      by 'y', that corresponds to the y-component of the Cartesian coordinates. 

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetYIdx(unsigned int el) const

      .. oe:language:: python

         .. oe:api:: python

            GetYIdx(el: int) -> int

      Returns the grid index in the y-dimension for the grid point identified 
      by 'el', that corresponds to a specific point in the grid.
     
   .. oe:method:: GetYInc

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetYInc() const

      .. oe:language:: python

         .. oe:api:: python

            GetYInc() -> int

      Returns the increment to be added or subtracted to the grid point index to 
      access the neighbor grid points along the y-axis.

   .. oe:method:: GetYMax

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetYMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetYMax() -> float

      Returns the maximum extent of this grid along the y-axis.

   .. oe:method:: GetYMid

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetYMid() const

      .. oe:language:: python

         .. oe:api:: python

            GetYMid() -> float

      Returns the center of this grid along the y-axis.

   .. oe:method:: GetYMin

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetYMin() const

      .. oe:language:: python

         .. oe:api:: python

            GetYMin() -> float

      Returns the minimum extent of this grid along the y-axis.

   .. oe:method:: GetZ

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZ(unsigned int iz) const

      .. oe:language:: python

         .. oe:api:: python

            GetZ(iz: int) -> float

      Returns the z-component of the Cartesian coordinate for the grid points with the z-index of 'iz'.

   .. oe:method:: GetZDim

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetZDim() const

      .. oe:language:: python

         .. oe:api:: python

            GetZDim() -> int

      Returns how many grid points there are for the z-dimension of this grid.

   .. oe:method:: GetZIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetZIdx(float z) const

      .. oe:language:: python

         .. oe:api:: python

            GetZIdx(z: float) -> int

      Returns the grid index in the z-dimension for the grid point identified 
      by 'z', that corresponds to the z-component of the Cartesian coordinates. 

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetZIdx(unsigned int el) const

      .. oe:language:: python

         .. oe:api:: python

            GetZIdx(el: int) -> int

      Returns the grid index in the z-dimension for the grid point identified 
      by 'el', that corresponds to a specific point in the grid.

   .. oe:method:: GetZInc

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetZInc() const

      .. oe:language:: python

         .. oe:api:: python

            GetZInc() -> int

      Returns the increment to be added or subtracted to the grid point index to 
      access the neighbor grid points along the z-axis.

   .. oe:method:: GetZMax

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetZMax() -> float

      Returns the maximum extent of this grid along the z-axis.

   .. oe:method:: GetZMid

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZMid() const

      .. oe:language:: python

         .. oe:api:: python

            GetZMid() -> float

      Returns the center of this grid along the z-axis.

   .. oe:method:: GetZMin

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZMin() const

      .. oe:language:: python

         .. oe:api:: python

            GetZMin() -> float

      Returns the minimum extent of this grid along the z-axis.

   .. oe:method:: GridIdxToElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GridIdxToElement(unsigned int ix, unsigned int iy,
                                  unsigned int iz, unsigned int& el) const

      .. oe:language:: python

         .. oe:api:: python

            GridIdxToElement(ix: int, iy: int, iz: int) -> int

      Converts the three dimensional grid indices (ix,iy,iz) into the one dimensional 
      grid point index 'el'. Returns ``false`` if (ix,iy,iz) are outside the grid bounds.

      .. seealso::
    
         * :oe:meth:`OESystem::OEGridBase::ElementToGridIdx`
  
   .. oe:method:: GridIdxToSpatialCoord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GridIdxToSpatialCoord(unsigned int ix, unsigned int iy,
                                       unsigned int iz, float& x, float& y,
                                       float& z) const

      .. oe:language:: python

         .. oe:api:: python

            GridIdxToSpatialCoord(ix: int, iy: int, iz: int) -> (x: float, y: float, z: float)

      Converts the three dimensional grid indices (ix,iy,iz) into the Cartesian 
      coordinates (x,y,z) of the associated grid point. 
      Returns false if (ix,iy,iz) are outside the grid bounds.

      .. seealso::
    
         * :oe:meth:`OESystem::OEGridBase::SpatialCoordToGridIdx`

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void* type) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(type: void) -> bool

      Returns whether type is the same as the instance this method is called on.

   .. oe:method:: IsInGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsInGrid(float x, float y, float z) const
            bool IsInGrid(unsigned int ix, unsigned int iy, unsigned int iz) const

      .. oe:language:: python

         .. oe:api:: python

            IsInGrid(x: float, y: float, z: float) -> bool
            IsInGrid(ix: int, iy: int, iz: int) -> bool

      Returns whether the given coordinates are located within the grid bounds.

   .. oe:method:: IsSpacingSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsSpacingSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsSpacingSet() -> bool

      Returns whether the spacing for this grid has been specified.

   .. oe:method:: IsTitleSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsTitleSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsTitleSet() -> bool

      Returns whether there is a title associated with this grid.

   .. oe:method:: IsXMidSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsXMidSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsXMidSet() -> bool

      Returns whether the midpoint for this grid has been specified for the x-dimension.

   .. oe:method:: IsYMidSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsYMidSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsYMidSet() -> bool

      Returns whether the midpoint for this grid has been specified for the y-dimension.

   .. oe:method:: IsZMidSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsZMidSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsZMidSet() -> bool

      Returns whether the midpoint for this grid has been specified for the z-dimension.

   .. oe:method:: SetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTitle(const std::string& title)

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(title: str) -> bool

      Sets the title associated with this grid.

   .. oe:method:: SpatialCoordToElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SpatialCoordToElement(float x, float y, float z,
                                       unsigned int& el) const

      .. oe:language:: python

         .. oe:api:: python

            SpatialCoordToElement(x: float, y: float, z: float) -> int

      Converts the Cartesian coordinates (x,y,z) into the grid point index 'el'. 
      Returns ``false`` if (x,y,z) are outside the grid bounds.

      .. seealso::
 
         * :oe:meth:`OESystem::OEGridBase::ElementToSpatialCoord`
         

   .. oe:method:: SpatialCoordToGridIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SpatialCoordToGridIdx(float x, float y, float z,
                                       unsigned int& ix, unsigned int& iy,
                                       unsigned int& iz) const

      .. oe:language:: python

         .. oe:api:: python

            SpatialCoordToGridIdx(x: float, y: float, z: float) -> (ix: int, iy: int, iz: int)

      Converts the Cartesian coordinates (x,y,z) into the three dimensional 
      indices (ix,iy,iz). Returns ``false`` if (x,y,z) are outside the grid bounds.

      .. seealso::
 
         * :oe:meth:`OESystem::OEGridBase::GridIdxToSpatialCoord`


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEHasRole, HasRole

.. _OESystem_OEHasRole:

.. oe:class:: OEHasRole

   .. oe:api::

      class OEHasRole : public OESystem::OEUnaryPredicate<OERoleSet>

   This class represents `OEHasRole`, a functor for objects
   inherited from :ref:`OERoleSet <OESystem_OERoleSet>`
   that identifies those containing a specified role (:ref:`OERole <OESystem_OERole>`).

   .. oe:source:: RoleSet.py
      :language: python
      :noindent:
      :frag:     SNIPPET-HAS-ROLE-PRED

   .. oe:source:: RoleSet.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-HAS-ROLE-PRED

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasRole(const OERole& role)

      .. oe:language:: python

         .. oe:api:: python

            OEHasRole(role: OERole) -> OEHasRole

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHasRole(const std::string& name)

      .. oe:language:: python

         .. oe:api:: python

            OEHasRole(name: str) -> OEHasRole

      Convenience constructor allowing the predicate to be
      constructed from a `role name` string.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OERoleSet& myObject) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(someObject: OERoleSet) -> bool

      Returns ``true`` if the :oe:cls:`OERoleSet<OESystem::OERoleSet>` contains
      an :oe:cls:`OERole<OESystem::OERole>` that
      matches the value used in the :oe:meth:`OESystem::OEHasRole::Constructors`.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OERoleSet , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasRole

      Deep copy constructor that returns a copy of the object.
      The memory for the returned `OEHasRole` 
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be managed to ensure
         it is deallocated using C++
         ``delete`` operator in order to prevent a memory leak. 


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEHeader, Header

.. _OESystem_OEHeader:

.. oe:class:: OEHeader

   .. oe:api::

      class OEHeader : public OEContainer

   This class represents `OEHeader`.

   The following methods are publicly inherited from :ref:`OEContainer <OESystem_OEContainer>`:

   ========================================================= ========================================================== =========================================================
   :oe:meth:`operator=<OESystem::OEContainer::operator=>`    :oe:meth:`GetDataType<OESystem::OEContainer::GetDataType>`                                                          
   :oe:meth:`CreateCopy<OESystem::OEContainer::CreateCopy>`  :oe:meth:`IsDataType<OESystem::OEContainer::IsDataType>`                                                            
   ========================================================= ========================================================== =========================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHeader()
            OEHeader(int argc, const char* argv[], const char* appname,
                     const char* version, const char* comment = "",
                     const OEInterface& itf = OEInterface(),
                     const OEHeader* history = 0x0)
            OEHeader(const OEHeader& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHeader() -> OEHeader
            OEHeader(argc: int, argv: List[str], appname: str, version: str,
                     comment: str = "", itf: OEInterface = OEInterface(),
                     history: OEHeader = None) -> OEHeader
            OEHeader(rhs: OEHeader) -> OEHeader

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHeader & operator=(const OEHeader &)

      Assignment operator.

   .. oe:method:: AddHistory

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddHistory(const OEHeader& header)

      .. oe:language:: python

         .. oe:api:: python

            AddHistory(header: OEHeader) -> None

   .. oe:method:: GetCommandLine

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetCommandLine() const

      .. oe:language:: python

         .. oe:api:: python

            GetCommandLine() -> str

   .. oe:method:: GetComment

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetComment() const

      .. oe:language:: python

         .. oe:api:: python

            GetComment() -> str

   .. oe:method:: GetDate

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetDate(int& day, int& month, int& year) const
            void GetDate(int& day, int& month, int& year, int& hour,
                         int& minute, int& seconds) const

      .. oe:language:: python

         .. oe:api:: python

            GetDate(day: int, month: int, year: int) -> None
            GetDate(day: int, month: int, year: int, hour: int, minute: int,
                    seconds: int) -> None

   .. oe:method:: GetHistory

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<OEHeader>* GetHistory() const

      .. oe:language:: python

         .. oe:api:: python

            GetHistory() -> Iterable[OEHeader]

   .. oe:method:: GetInterface

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetInterface() const

      .. oe:language:: python

         .. oe:api:: python

            GetInterface() -> str

   .. oe:method:: GetOERelease

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetOERelease() const

      .. oe:language:: python

         .. oe:api:: python

            GetOERelease() -> str

   .. oe:method:: GetOEVersion

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetOEVersion() const

      .. oe:language:: python

         .. oe:api:: python

            GetOEVersion() -> int

   .. oe:method:: GetPlatform

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetPlatform() const

      .. oe:language:: python

         .. oe:api:: python

            GetPlatform() -> str

   .. oe:method:: GetProgram

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetProgram() const

      .. oe:language:: python

         .. oe:api:: python

            GetProgram() -> str

   .. oe:method:: GetVersion

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetVersion() const

      .. oe:language:: python

         .. oe:api:: python

            GetVersion() -> str

   .. oe:method:: SetCommandLine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCommandLine(const std::string& comment)

      .. oe:language:: python

         .. oe:api:: python

            SetCommandLine(comment: str) -> None

   .. oe:method:: SetComment

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetComment(const std::string& comment)

      .. oe:language:: python

         .. oe:api:: python

            SetComment(comment: str) -> None

   .. oe:method:: SetDate

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDate()
            void SetDate(int day, int month, int year)
            void SetDate(int day, int month, int year, int hour, int minute,
                         int seconds)

      .. oe:language:: python

         .. oe:api:: python

            SetDate() -> None
            SetDate(day: int, month: int, year: int) -> None
            SetDate(day: int, month: int, year: int, hour: int, minute: int,
                    seconds: int) -> None

   .. oe:method:: SetInterface

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetInterface(const OEInterface& itf)

      .. oe:language:: python

         .. oe:api:: python

            SetInterface(itf: OEInterface) -> None

   .. oe:method:: SetOERelease

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOERelease(const std::string& release)

      .. oe:language:: python

         .. oe:api:: python

            SetOERelease(release: str) -> None

   .. oe:method:: SetOEVersion

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOEVersion(int version)

      .. oe:language:: python

         .. oe:api:: python

            SetOEVersion(version: int) -> None

   .. oe:method:: SetPlatform

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPlatform(const std::string& platform)

      .. oe:language:: python

         .. oe:api:: python

            SetPlatform(platform: str) -> None

   .. oe:method:: SetProgram

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetProgram(const std::string& program)

      .. oe:language:: python

         .. oe:api:: python

            SetProgram(program: str) -> None

   .. oe:method:: SetVersion

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetVersion(const std::string &)

      .. oe:language:: python

         .. oe:api:: python

            SetVersion(arg2: str) -> None



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEIntParameter, IntParameter

.. _OESystem_OEIntParameter:

.. oe:class:: OEIntParameter

   .. oe:api::

      class OEIntParameter : public OEPODParameter<int>

   The :ref:`OEIntParameter <OESystem_OEIntParameter>` represents parameter that has ``int`` value.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OETypedParameter <OESystem_OETypedParameter>`:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   Following methods are publicly inherited from :ref:`OEPODParameter <OESystem_OEPODParameter>`:
    * :oe:meth:`GetDefaultsVector<OESystem::OEPODParameter::GetDefaultsVector>`
    * :oe:meth:`GetSettingsVector<OESystem::OEPODParameter::GetSettingsVector>`
    * :oe:meth:`GetValuesVector<OESystem::OEPODParameter::GetValuesVector>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIntParameter()
            OEIntParameter(const std::string& name)
            OEIntParameter(const std::string& name, const int default)
            OEIntParameter(const OEIntParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEIntParameter(name: str) -> OEIntParameter
            OEIntParameter(name: str, defValue: int) -> OEIntParameter
            OEIntParameter() -> OEIntParameter
            OEIntParameter(arg2: OEIntParameter) -> OEIntParameter

      Default and copy constructors.

      Constructs an :ref:`OEIntParameter <OESystem_OEIntParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIntParameter &operator=(const OEIntParameter &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEInterface, Interface

.. _OESystem_OEInterface:

.. oe:class:: OEInterface

   .. oe:api::

      class OEInterface

   This class represents `OEInterface`.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInterface()
            OEInterface(const OEInterface &)

      .. oe:language:: python

         .. oe:api:: python

            OEInterface() -> OEInterface
            OEInterface(arg2: OEInterface) -> OEInterface

      Default and copy constructors.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInterface(const unsigned char* dataptr)
            OEInterface(const char* dataptr)

      .. oe:language:: python

         .. oe:api:: python

            OEInterface(dataptr: str) -> OEInterface

      Constructs an :ref:`OEInterface <OESystem_OEInterface>` and configures it
      with the interface definition passed by ``dataptr``. This is
      equivalent to the following code: 

      .. oe:source:: OEInterfaceConfigureCtor.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECONFIGURE-OEINTERFACE

      .. oe:source:: OEInterfaceConfigureCtor.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECONFIGURE-OEINTERFACE

      .. oe:source:: OEInterfaceConfigureCtor.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECONFIGURE-OEINTERFACE

      .. oe:source: OEInterfaceConfigureCtor.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECONFIGURE-OEINTERFACE

      .. note:: 
         
         It is possible to configure an :ref:`OEInterface <OESystem_OEInterface>`
         from multiple interface definitions. Just call
         :oe:func:`OESystem::OEConfigure` once per interface definition
         on the same :ref:`OEInterface <OESystem_OEInterface>` object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInterface(const unsigned char* dataptr, int argc, char** argv)
            OEInterface(const char* dataptr, int argc, char** argv)

      .. oe:language:: python

         .. oe:api:: python

            OEInterface(dataptr: str, argc: int, argv: str) -> OEInterface

      Constructs an :ref:`OEInterface <OESystem_OEInterface>` and configures it
      with the interface definition passed by ``dataptr``. Then parses
      the command line given by ``argv``. This is
      equivalent to the following code: 

      .. oe:source:: OEInterfaceConvenienceCtor.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEINTERFACE-CONVENIENCE

      .. oe:source:: OEInterfaceConvenienceCtor.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEINTERFACE-CONVENIENCE 

      .. oe:source:: OEInterfaceConvenienceCtor.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEINTERFACE-CONVENIENCE 

      .. oe:source: OEInterfaceConvenienceCtor.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEINTERFACE-CONVENIENCE 

      .. warning:: 

         These convenience constructors may force the program to exit
         and thus may not be appropriate when writing a library that
         should instead return errors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEInterface &operator=(const OEInterface &)

      Assignment operator.

   .. oe:method:: AddDetail

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddDetail(const std::string& detail)

      .. oe:language:: python

         .. oe:api:: python

            AddDetail(detail: str) -> bool

      Adds a line to the detailed description of the
      :ref:`OEInterface <OESystem_OEInterface>`. Returns ``true`` if the add was
      successful and ``false`` otherwise. (The current implementation
      never fails)

   .. oe:method:: AddInterface

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInterface* AddInterface()

      .. oe:language:: python

         .. oe:api:: python

            AddInterface() -> OEInterface

      Adds a child :ref:`OEInterface <OESystem_OEInterface>` and returns a
      pointer to the newly created object (which is owned by the
      current :ref:`OEInterface <OESystem_OEInterface>` object).

   .. oe:method:: AddParameter

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEParameter* AddParameter(std::string classid)

      .. oe:language:: python

         .. oe:api:: python

            AddParameter(classid: str) -> OEParameter

      Adds a parameter to the :ref:`OEInterface <OESystem_OEInterface>`
      instance. The returned pointer points to the newly created
      :ref:`OEParameter <OESystem_OEParameter>` object. This memory is **owned** by
      the :ref:`OEInterface <OESystem_OEInterface>` object. If the add fails
      ``NULL`` will be returned.

      The implementation of the returned :ref:`OEParameter <OESystem_OEParameter>`
      pointer will always be a subclass of

      .. code-block:: c++

         template <TT> OETypedParameter

      The specific type depends upon the value of classid as follows :

      string
          ``TT`` is ``std::string`` parameter 

      double
          ``TT`` is ``double`` parameter
 
      float
          ``TT`` is ``float`` parameter 

      bool
          ``TT`` is ``bool`` parameter
 
      int
          ``TT`` is ``int`` parameter
 
      file
          ``TT`` is :ref:`oeisstream <OEPlatform_oeisstream>` parameter

      param_file
          ``TT`` is :ref:`oeisstream <OEPlatform_oeisstream>` and additionally the
          parameter is specially recognized by :oe:func:`OESystem::OEParseCommandLine` 
          as a text file holding parameter settings.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> bool

      Returns the :ref:`OEInterface <OESystem_OEInterface>` object to the default constructed
      state of an :ref:`OEInterface <OESystem_OEInterface>`.

   .. oe:method:: DeleteInterface

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteInterface(OEInterface& itf)

      .. oe:language:: python

         .. oe:api:: python

            DeleteInterface(itf: OEInterface) -> bool

      Deletes a child :ref:`OEInterface <OESystem_OEInterface>` object. 'itf' is
      the child :ref:`OEInterface <OESystem_OEInterface>` to be deleted. The
      method returns ``true`` if the deletion is successful and
      ``false`` otherwise. 'itf' must be directly owned by the
      :ref:`OEInterface <OESystem_OEInterface>`, not one of its child
      :oe:cls:`OEInterfaces<OESystem::OEInterface>`.

   .. oe:method:: DeleteParameter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteParameter(OEParameter& param)

      .. oe:language:: python

         .. oe:api:: python

            DeleteParameter(param: OEParameter) -> bool

      Deletes a parameter ('param') owned by this
      :ref:`OEInterface <OESystem_OEInterface>` object. The function returns
      ``true`` if the delete succeeds and ``false`` otherwise. The
      parameter must be **owned** by the :ref:`OEInterface <OESystem_OEInterface>`
      object to be deleted (it will not delete parameters that belong
      to child :ref:`OEInterface <OESystem_OEInterface>` objects of this
      :ref:`OEInterface <OESystem_OEInterface>`).

   .. oe:method:: Factory

      .. oe:language:: c++ java csharp

         .. oe:api::

            static OESimpleFactory<std::string, OEParameter>& Factory()

      .. oe:language:: python

         .. oe:api:: python

            Factory() -> OESimpleFactory< str,OEParameter >

      Returns the :ref:`OEInterface <OESystem_OEInterface>` class's factory
      used to create new parameters.

   .. oe:method:: Get

      .. oe:api::

         template <class TT>
         TT Get(std::string name, unsigned int ilist = 0) const

      Returns the setting (either the value, or default if the value
      is not set) of the parameter with the given name and
      instance. The parameter must be of type ``TT``, and must have
      either have a value or default set. If the parameter cannot be
      found (*i.e.*, a call to :oe:meth:`OESystem::OEInterface::Has` with 
      the same ``TT`` and 'name' returns
      ``false``) a warning is issued and a default constructed ``TT`` is
      returned.

   .. oe:method:: GetBrief

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetBrief() const

      .. oe:language:: python

         .. oe:api:: python

            GetBrief() -> str

      Returns the brief description of the :ref:`OEInterface <OESystem_OEInterface>` object.

   .. oe:method:: GetDetail

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const std::string>* GetDetail() const

      .. oe:language:: python

         .. oe:api:: python

            GetDetail() -> Iterable[str]

      Returns the detailed description of the :ref:`OEInterface <OESystem_OEInterface>` object.

   .. oe:method:: GetInterface

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInterface* GetInterface(std::string name)
            const OEInterface* GetInterface(std::string name) const

      .. oe:language:: python

         .. oe:api:: python

            GetInterface(name: str) -> OEInterface

      Returns a pointer to a child :ref:`OEInterface <OESystem_OEInterface>` with
      a given 'name' owned by any child
      :ref:`OEInterface <OESystem_OEInterface>`. The search is recursive
      searching through all child's child
      :oe:cls:`OEInterfaces<OESystem::OEInterface>`, etc. If no such
      :ref:`OEInterface <OESystem_OEInterface>` exists ``NULL`` is returned.

   .. oe:method:: GetInterfaces

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase< OEInterface>* GetInterfaces(bool recursive = false)
            OEIterBase<const OEInterface>* GetInterfaces(bool recursive = false) const

      .. oe:language:: python

         .. oe:api:: python

            GetInterfaces(recursive: bool = False) -> OEInterfaceIter
            GetInterfaces(recursive: bool = False) -> Iterable[OEInterface]

      Returns and iterator over all child
      :oe:cls:`OEInterfaces<OESystem::OEInterface>` of this object. If
      recursive is ``true``, the iterator will include all of the
      children's :oe:cls:`OEInterfaces<OESystem::OEInterface>`
      recursively in arbitrary order. If recursive is ``false`` only
      the immediate child :oe:cls:`OEInterfaces<OESystem::OEInterface>`
      will be returned, and they will be sorted by
      :oe:meth:`OESystem::OEInterface::GetOrderPriority` (lowest values
      first) and then name.

   .. oe:method:: GetList

      .. oe:api::

         template <class TT>
         OEIterBase<const TT>* GetList(std::string name) const

   .. seealso::

     .. oe:language:: c++

         * Example program :ref:`catmols.cpp<section_example_oechem_catmols>`

     .. oe:language:: python
   
         * Example program :ref:`catmols.py<section_example_oechem_catmols>`

     .. oe:language:: java

         * Example program :ref:`CatMols.java<section_example_oechem_catmols>`

     .. oe:language:: csharp

         * Example program :ref:`CatMols.cs<section_example_oechem_catmols>`

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the name of the :ref:`OEInterface <OESystem_OEInterface>` object.

   .. oe:method:: GetOrderPriority

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetOrderPriority() const

      .. oe:language:: python

         .. oe:api:: python

            GetOrderPriority() -> int

      Returns the order priority of the :ref:`OEInterface <OESystem_OEInterface>` object.

   .. oe:method:: GetParameter

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEParameter* GetParameter(std::string name)
            const OEParameter* GetParameter(std::string name) const

      .. oe:language:: python

         .. oe:api:: python

            GetParameter(name: str) -> OEParameter

      Returns a pointer to a :ref:`OEParameter <OESystem_OEParameter>` with a
      given 'name' owned by the :ref:`OEInterface <OESystem_OEInterface>` object
      or one of its child :oe:cls:`OEInterfaces<OESystem::OEInterface>` 
      (or child's child
      :ref:`OEInterface <OESystem_OEInterface>`, etc). If no such parameter
      exists ``NULL`` is returned.

   .. oe:method:: GetParameters

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<OEParameter>* GetParameters(bool recursive = true)
            OEIterBase<const OEParameter>* GetParameters(bool recursive = true) const

      .. oe:language:: python

         .. oe:api:: python

            GetParameters(recursive: bool = True) -> OEParameterIter
            GetParameters(recursive: bool = True) -> Iterable[OEParameter]

      Returns an iterator over all
      :oe:cls:`OEParameters<OESystem::OEParameter>` of the
      :ref:`OEInterface <OESystem_OEInterface>` object. If recursive is ``true``
      the search is recursive including parameters held by all child
      :oe:cls:`OEInterfaces<OESystem::OEInterface>` and their children
      in arbitrary order. If recursive is ``false`` parameters held by
      child :oe:cls:`OEInterfaces<OESystem::OEInterface>` will not be
      included and they will be sorted by the parameters order
      priority (lowest values first), followed by name.

   .. oe:method:: GetTypedParameter

      .. oe:api::

         template<class TT>
         OETypedParameter<TT> *GetTypedParameter(std::string name)
         template<class TT>
         const OETypedParameter<TT> *GetTypedParameter(std::string name) const

   .. oe:method:: Has

      .. oe:api::

         template<class TT>
         bool Has(std::string name, unsigned int ilist = 0) const

      Returns ``true`` if all of the following are ``true``:

      1. A parameter with name `name` is contained by the :ref:`OEInterface <OESystem_OEInterface>`.
      2. The parameter is of type ``TT``
      3. The parameters value of default is set.

      In all other cases the function returns ``false``. 

   .. oe:method:: Parent

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInterface* Parent()
            const OEInterface* Parent() const

      .. oe:language:: python

         .. oe:api:: python

            Parent() -> OEInterface

      Returns a pointer to the parent :ref:`OEInterface <OESystem_OEInterface>` of
      this object, or ``NULL`` if this :ref:`OEInterface <OESystem_OEInterface>`
      object does not have a parent.

   .. oe:method:: SetBrief

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBrief(std::string brief)

      .. oe:language:: python

         .. oe:api:: python

            SetBrief(brief: str) -> bool

      Sets the brief description of the
      :ref:`OEInterface <OESystem_OEInterface>`. Returns ``true`` if the brief
      was successfully set and ``false`` otherwise. (The current
      implementation never fails)

   .. oe:method:: SetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetName(std::string name)

      .. oe:language:: python

         .. oe:api:: python

            SetName(name: str) -> bool

      Sets the name of the :ref:`OEInterface <OESystem_OEInterface>`. Returns
      ``true`` if the name was successfully set and ``false``
      otherwise. (The current implementation never fails).

   .. oe:method:: SetOrderPriority

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOrderPriority(int priority)

      .. oe:language:: python

         .. oe:api:: python

            SetOrderPriority(priority: int) -> bool

      Sets the order priority of the
      :ref:`OEInterface <OESystem_OEInterface>`. The order priority overrides the
      default sorting by name that is used when calling the
      :oe:meth:`GetInterfaces(false)<OESystem::OEInterface::GetInterfaces>` 
      member function. Child :oe:cls:`OEInterfaces<OESystem::OEInterface>` with
      lower priority values will appear first.
      This function returns ``true`` if  the priority was successfully
      set and ``false`` otherwise.  (The current  implementation never
      fails).


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEIsFalse, IsFalse

.. _OESystem_OEIsFalse:

.. oe:class:: OEIsFalse

   .. oe:api::

      template<class Arg> struct OEIsFalse : public OEUnaryPredicate<Arg>

   This functor always returns ``false`` for any argument passed to it.
   The following specializations are provided to make using this class easier: 

   * ``OEIsFalseAtom``
   * ``OEIsFalseBond``
   * ``OEIsFalseConf``

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   The following classes derive from this class:
    * :ref:`IsFalse <OESystem_IsFalse>`
    * :ref:`OEUnaryFalse <OESystem_OEUnaryFalse>`

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const Arg &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(Arg) -> bool

      Always returns ``false``.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUnaryFunction<Arg, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsFalse


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEIsTrue, IsTrue

.. _OESystem_OEIsTrue:

.. oe:class:: OEIsTrue

   .. oe:api::

      template<class Arg> struct OEIsTrue : public OEUnaryPredicate<Arg>

   This functor always returns ``true`` for any argument passed to it. The
   following specializations are provided to make using this class easier: 

   * ``OEIsTrueAtom``
   * ``OEIsTrueBond``
   * ``OEIsTrueConf``

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   The following classes derive from this class:
    * :ref:`IsTrue <OESystem_IsTrue>`
    * :ref:`OEUnaryTrue <OESystem_OEUnaryTrue>`
   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const Arg &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(Arg) -> bool

      Always returns ``true``.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUnaryFunction<Arg, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsTrue


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEIter

.. _OESystem_OEIter:

.. oe:class:: OEIter

   .. oe:api::

      template<class A>
      class OEIter

   This class represents `OEIter`.

   The :ref:`OEIter <OESystem_OEIter>` template class is used to represent
   *iterator* functionality. The template is parameterized over
   ``class A``, defining the behavior of iterators of across collections
   of type ``A``. The iterator can be thought of a behaving like a pointer
   to type ``A``.

   :oe:cls:`OEIters<OESystem::OEIter>` are typically initialized by assigning 
   them the value of an  :oe:cls:`OEIterBase(of compatible type T)<OESystem::OEIterBase>`,
   return from a function.

   .. oe:method:: Constructors

      .. oe:api::

         OEIter()
         OEIter(OEIterBase<A>* rhs)
         OEIter(const OEIter<A>& rhs)
         OEIter(OEIterBase<NonConstA>* rhs)
         template<typename P>
         OEIter(const P& pred, OEIter<A>& rhs)
         template<typename P>
         OEIter(const P& pred, OEIterBase<A>* rhs)

      Default and copy constructors.

   .. oe:method:: operator!
      :language: c++

      .. oe:api::

         bool operator!() const

   .. oe:method:: operator*
      :language: c++

      .. oe:api::

         A& operator*() const

      Dereference the iterator as a reference. This operator returns a
      C++ reference to the current item pointed to by the iterator.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIter<A>& operator=(OEIterBase<A>* rhs)
         OEIter<A>& operator=(const OEIter<A>& rhs)

      The assignment operator initializes the :ref:`OEIter <OESystem_OEIter>` to the given
      :ref:`OEIterBase <OESystem_OEIterBase>`, typically returned by an *OEChem* or *OESystem*
      function. If the :ref:`OEIter <OESystem_OEIter>` has already been initialized, the
      internal :ref:`OEIterBase <OESystem_OEIterBase>` is destroy and replaced with the new value.

      Assignment operator.

   .. oe:method:: operator!=
      :language: c++

      .. oe:api::

         bool operator!=(const OEIter<A>& rhs) const

      Returns ``true`` if the item pointed to by the first iterator is not
      the same as the item pointed to by the second iterator (using
      pointer inequality). 
      This operator is the negation of :oe:meth:`OESystem::OEIter::operator==`.

   .. oe:method:: operator++
      :language: c++

      .. oe:api::

         OEIter<A>& operator++()

      This prefix :oe:meth:`OESystem::OEIter::operator++` advances the
      iterator one position. 

   .. oe:method:: operator+=
      :language: c++

      .. oe:api::

         OEIter<A>& operator+=(int x)
         OEIter<A>& operator+=(unsigned int x)

      Advances the iterator 'x' places forward.

   .. oe:method:: operator--
      :language: c++

      .. oe:api::

         OEIter<A>& operator--()

      This prefix  :oe:meth:`OESystem::OEIter::operator--` operator moves the iterator 
      back one position, if possible. 

   .. oe:method:: operator-=
      :language: c++

      .. oe:api::

         OEIter<A>& operator-=(int x)
         OEIter<A>& operator-=(unsigned int x)

      Attempts to move the iterator 'x' places backward.

   .. oe:method:: operator->
      :language: c++ java csharp

      .. oe:api::

         A* operator->() const

      Dereferences the iterator as a pointer. This operator returns a
      pointer to the current item pointed to by the iterator.

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEIter<A>& rhs) const

      Returns ``true`` if the item pointed to by the first iterator is
      the same as the item pointed to by the second iterator (using
      pointer equality). This operator is the negation of
      :oe:meth:`OESystem::OEIter::operator!=`.

   .. oe:method:: operator A &
      :language: c++

      .. oe:api::

         operator A &() const

   .. oe:method:: operator A *
      :language: c++

      .. oe:api::

         operator A *() const

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns true if the current iterator position is valid. This
      should typically be checked before each dereference of an
      iterator.

   .. oe:method:: Copy

      .. oe:api::

         OEIterBase<A> *Copy() const

      Copies an :ref:`OEIter <OESystem_OEIter>`. The returned value is a newly allocated
      :ref:`OEIterBase <OESystem_OEIterBase>` <A>* that should be immediately assigned to an
      :ref:`OEIter <OESystem_OEIter>`. The current location in the iterator is preserved by the
      copy.

   .. oe:method:: Push

      .. oe:api::

         void Push(OEIter<A> &iter)
         void Push(OEIterBase<A> *ib)
         template<typename F>
         void Push(const F &pred)

   .. oe:method:: Sort

      .. oe:api::

         void Sort(const OESystem::OEBinaryPredicate<A, A> &sort_criterion)

      Sorts contents of the iterator and
      resets the iterator to its first item. The re-ordering is local
      to the given instance of the iterator (*i.e.*, the container
      holding the items the iterator traverses is unchanged). Once
      this function is called the iterator is never delete safe, even
      if it normally would be.

      The :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>` <A,A> passed
      to this function is used as
      the less comparison in the sort. It should return ``true`` if the
      first argument is less than the second argument and ``false``
      otherwise. An item that is less than another item will appear
      first after sorting.

   .. oe:method:: ToFirst

      .. oe:api::

         OEIter<A> &ToFirst()

      Resets the iterator to its first item, if possible.

   .. oe:method:: ToLast

      .. oe:api::

         OEIter<A> &ToLast()

      Resets the iterator to its last item, if  possible.



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEIterBase, IterBase

.. _OESystem_OEIterBase:

.. oe:class:: OEIterBase

   .. oe:api::

      template<class A>
      class OEIterBase

   This class represents `OEIterBase`.

   The :ref:`OEIterBase <OESystem_OEIterBase>` class is an internal abstract
   template class. All iterators returned by *OESystem* and *OEChem*
   are pointers to instances derived from this class. However, users
   should not use or access this class/template directly. Instead the
   :ref:`OEIterBase <OESystem_OEIterBase>` pointer should be assigned to an
   :ref:`OEIter <OESystem_OEIter>`. The :ref:`OEIter <OESystem_OEIter>`, for
   example, ensures that the contents of the
   :ref:`OEIterBase <OESystem_OEIterBase>` will be destroyed when the
   :ref:`OEIter <OESystem_OEIter>` goes out of scope, thus preventing
   potential memory leaks.

   The following classes derive from this class:
    * :ref:`OEConcatIter <OESystem_OEConcatIter>`
    * :ref:`OEPredIter <OESystem_OEPredIter>`
   
   .. oe:method:: Constructors

      .. oe:api::

         OEIterBase()

      Default and copy constructors.

   .. oe:method:: operator*
      :language: c++

      .. oe:api::

         A& operator*() const = 0

   .. oe:method:: operator++
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator++()=0

   .. oe:method:: operator+=
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator+=(int)=0
         OEIterBase<A>& operator+=(unsigned int)=0

   .. oe:method:: operator--
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator--()=0

   .. oe:method:: operator-=
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator-=(int)=0
         OEIterBase<A>& operator-=(unsigned int)=0

   .. oe:method:: operator->
      :language: c++ java csharp

      .. oe:api::

         A* operator->() const = 0

   .. oe:method:: operator A *
      :language: c++

      .. oe:api::

         operator A *() const

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

   .. oe:method:: Copy

      .. oe:api::

         OEIterBase<A> *Copy() const = 0

   .. oe:method:: Push

      .. oe:api::

         OEIterBase<A> *Push(OEIterBase<A> *ib)

   .. oe:method:: ToFirst

      .. oe:api::

         OEIterBase<A> &ToFirst()=0

   .. oe:method:: ToLast

      .. oe:api::

         OEIterBase<A> &ToLast()=0



.. oe:namespace:: OESystem

.. meta::
   :keywords: OELinearColorGradient, LinearColorGradient

.. _OESystem_OELinearColorGradient:

.. oe:class:: OELinearColorGradient

   .. oe:api::

      class OELinearColorGradient : public OEColorGradientBase

   The :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class interpolates between colors that
   are defined by using the OEColorStop class.
   See :ref:`Figure Example of linear color gradient<figure_OELinearColorGradient>`

   .. _figure_OELinearColorGradient:

   .. figure:: oechemtk/images/OELinearColorGradient.*
      :align:  center

      **Example of linear color gradient** with (-1.0, OERed), (0.0,
      OEWhite) and (+1.0, OEBlue) color stops

   .. seealso::

      * :ref:`OEColorStop <OESystem_OEColorStop>` class
      * :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` class
      * :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>` class
      * :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>` class

   The following methods are publicly inherited from :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>`:

   ======================================================================= ======================================================================= ========================================================================
   :oe:meth:`operator=<OESystem::OEColorGradientBase::operator=>`          :oe:meth:`GetMaxColor<OESystem::OEColorGradientBase::GetMaxColor>`      :oe:meth:`GetStops<OESystem::OEColorGradientBase::GetStops>`            
   :oe:meth:`AddStop<OESystem::OEColorGradientBase::AddStop>`              :oe:meth:`GetMaxValue<OESystem::OEColorGradientBase::GetMaxValue>`      :oe:meth:`IsEmpty<OESystem::OEColorGradientBase::IsEmpty>`              
   :oe:meth:`DeleteStop<OESystem::OEColorGradientBase::DeleteStop>`        :oe:meth:`GetMinColor<OESystem::OEColorGradientBase::GetMinColor>`      :oe:meth:`NumStops<OESystem::OEColorGradientBase::NumStops>`            
   :oe:meth:`GetColorAt<OESystem::OEColorGradientBase::GetColorAt>`        :oe:meth:`GetMinValue<OESystem::OEColorGradientBase::GetMinValue>`      :oe:meth:`TransformValue<OESystem::OEColorGradientBase::TransformValue>`
   ======================================================================= ======================================================================= ========================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELinearColorGradient()

      .. oe:language:: python

         .. oe:api:: python

            OELinearColorGradient() -> OELinearColorGradient

      Default constructor that creates an "empty" color gradient.

      .. note::

         An "empty" color gradient always returns the :oe:const:`OEBlack<OESystem::OESystem::OEBlack>`
         color, when calling the :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`,
         the :oe:meth:`OESystem::OEColorGradientBase::GetMinColor` or
         the :oe:meth:`OESystem::OEColorGradientBase::GetMaxColor` methods.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELinearColorGradient(const OEColorStop& oneStop)

      .. oe:language:: python

         .. oe:api:: python

            OELinearColorGradient(oneStop: OEColorStop) -> OELinearColorGradient

      Creates an :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` object with
      one color stop. An :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>`
      object that has only one color stop will always return that
      color when calling the
      :oe:meth:`OESystem::OEColorGradientBase::GetColorAt` method.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELinearColorGradient(const OEColorStop& bgnStop,
                                  const OEColorStop& endStop)

      .. oe:language:: python

         .. oe:api:: python

            OELinearColorGradient(bgnStop: OEColorStop, endStop: OEColorStop) -> OELinearColorGradient

      Creates an :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` object with
      interpolation range between the two specified color stops.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELinearColorGradient(const OELinearColorGradient& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OELinearColorGradient(rhs: OELinearColorGradient) -> OELinearColorGradient

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELinearColorGradient &operator=(const OELinearColorGradient &rhs)

      Assignment operator.

   .. oe:method:: TransformValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            double TransformValue(double value) const

      .. oe:language:: python

         .. oe:api:: python

            TransformValue(value: float) -> float

      Performs a :math:`f(x) = x` linear transformation.
      This method is called by :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`
      method to transform a value before performing color interpolation.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OELogarithmicColorGradient, LogarithmicColorGradient

.. _OESystem_OELogarithmicColorGradient:

.. oe:class:: OELogarithmicColorGradient

   .. oe:api::

      class OELogarithmicColorGradient : public OEColorGradientBase

   The :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>` class interpolates
   between colors that are defined by using the OEColorStop class.
   The :oe:meth:`OESystem::OELogarithmicColorGradient::TransformValue` method
   defines the transformation that is performed before returning an
   interpolated color associated with a floating point value.
   The :ref:`Figure: Example of linear and logarithmic color gradients
   <figure_OELogarithmicColorGradient>`
   illustrates the difference between a linear and a logarithmic colors
   gradients constructed with the same color stops.

   .. _figure_OELogarithmicColorGradient:

   .. figure:: oechemtk/images/OELogarithmicAndLinearColorGradient.*
      :align:  center

      **Example of linear and logarithmic color gradients** generated with (-4.0, OERed), (0.0,
      OEWhite) and (+4.0, OEBlue) color stops

   .. seealso::

      * :ref:`OEColorStop <OESystem_OEColorStop>` class
      * :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` class
      * :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>` class
      * :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class

   This class represents `OELogarithmicColorGradient`.

   The following methods are publicly inherited from :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>`:

   ======================================================================= ======================================================================= ========================================================================
   :oe:meth:`operator=<OESystem::OEColorGradientBase::operator=>`          :oe:meth:`GetMaxColor<OESystem::OEColorGradientBase::GetMaxColor>`      :oe:meth:`GetStops<OESystem::OEColorGradientBase::GetStops>`            
   :oe:meth:`AddStop<OESystem::OEColorGradientBase::AddStop>`              :oe:meth:`GetMaxValue<OESystem::OEColorGradientBase::GetMaxValue>`      :oe:meth:`IsEmpty<OESystem::OEColorGradientBase::IsEmpty>`              
   :oe:meth:`DeleteStop<OESystem::OEColorGradientBase::DeleteStop>`        :oe:meth:`GetMinColor<OESystem::OEColorGradientBase::GetMinColor>`      :oe:meth:`NumStops<OESystem::OEColorGradientBase::NumStops>`            
   :oe:meth:`GetColorAt<OESystem::OEColorGradientBase::GetColorAt>`        :oe:meth:`GetMinValue<OESystem::OEColorGradientBase::GetMinValue>`      :oe:meth:`TransformValue<OESystem::OEColorGradientBase::TransformValue>`
   ======================================================================= ======================================================================= ========================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELogarithmicColorGradient()

      .. oe:language:: python

         .. oe:api:: python

            OELogarithmicColorGradient() -> OELogarithmicColorGradient

      Default constructor that creates an "empty" color gradient.

      .. note::

         An "empty" color gradient always returns the :oe:const:`OEBlack<OESystem::OESystem::OEBlack>`
         color, when calling the :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`,
         the :oe:meth:`OESystem::OEColorGradientBase::GetMinColor` or
         the :oe:meth:`OESystem::OEColorGradientBase::GetMaxColor` methods.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELogarithmicColorGradient(const OEColorStop& oneStop)

      .. oe:language:: python

         .. oe:api:: python

            OELogarithmicColorGradient(oneStop: OEColorStop) -> OELogarithmicColorGradient

      Creates an :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>` object with
      one color stop. An :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>`
      object that has only one color stop will always return that
      color when calling the
      :oe:meth:`OESystem::OEColorGradientBase::GetColorAt` method.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELogarithmicColorGradient(const OEColorStop& bgnStop,
                                       const OEColorStop& endStop)

      .. oe:language:: python

         .. oe:api:: python

            OELogarithmicColorGradient(bgnStop: OEColorStop,
                                       endStop: OEColorStop) -> OELogarithmicColorGradient

      Creates an :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>` object with
      interpolation range between the two specified color stops.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELogarithmicColorGradient(const OELogarithmicColorGradient& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OELogarithmicColorGradient(rhs: OELogarithmicColorGradient) -> OELogarithmicColorGradient

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELogarithmicColorGradient &operator=(const OELogarithmicColorGradient &rhs)

      Assignment operator.

   .. oe:method:: TransformValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            double TransformValue(double value) const

      .. oe:language:: python

         .. oe:api:: python

            TransformValue(value: float) -> float

      Performs a
      :math:`f(x) = -log(-x+1.0)` transformation when x is less than 0.0 and
      :math:`f(x) =  log(x+1.0)` transformation when x is greater than 0.0.
      This method is called by :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`
      method to transform a value before performing color interpolation.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMultiGrid, MultiGrid

.. _OESystem_OEMultiGrid:

.. oe:class:: OEMultiGrid

   .. oe:api::

      template<class GridType>
      class OEMultiGrid : public OEFixedMultiGrid<GridType>

   This class represents `OEMultiGrid`.

   The following methods are publicly inherited from :ref:`OEFixedMultiGrid <OESystem_OEFixedMultiGrid>`:

   =============================================================== =============================================================== ===============================================================
   :oe:meth:`operator[]<OESystem::OEFixedMultiGrid::operator[]>`   :oe:meth:`GetNumGrids<OESystem::OEFixedMultiGrid::GetNumGrids>` :oe:meth:`SetNumGrids<OESystem::OEFixedMultiGrid::SetNumGrids>`
   :oe:meth:`CreateCopy<OESystem::OEFixedMultiGrid::CreateCopy>`   :oe:meth:`GetValues<OESystem::OEFixedMultiGrid::GetValues>`                                                                    
   :oe:meth:`GetDataType<OESystem::OEFixedMultiGrid::GetDataType>` :oe:meth:`IsDataType<OESystem::OEFixedMultiGrid::IsDataType>`                                                                  
   =============================================================== =============================================================== ===============================================================

   The following methods are publicly inherited from :ref:`OEGridBase <OESystem_OEGridBase>`:

   ============================================================================= ============================================================================ =============================================================================
   :oe:meth:`Clear<OESystem::OEGridBase::Clear>`                                 :oe:meth:`GetXMid<OESystem::OEGridBase::GetXMid>`                            :oe:meth:`GetZMin<OESystem::OEGridBase::GetZMin>`                            
   :oe:meth:`CreateCopy<OESystem::OEGridBase::CreateCopy>`                       :oe:meth:`GetXMin<OESystem::OEGridBase::GetXMin>`                            :oe:meth:`GridIdxToElement<OESystem::OEGridBase::GridIdxToElement>`          
   :oe:meth:`ElementToGridIdx<OESystem::OEGridBase::ElementToGridIdx>`           :oe:meth:`GetY<OESystem::OEGridBase::GetY>`                                  :oe:meth:`GridIdxToSpatialCoord<OESystem::OEGridBase::GridIdxToSpatialCoord>`
   :oe:meth:`ElementToSpatialCoord<OESystem::OEGridBase::ElementToSpatialCoord>` :oe:meth:`GetYDim<OESystem::OEGridBase::GetYDim>`                            :oe:meth:`IsDataType<OESystem::OEGridBase::IsDataType>`                      
   :oe:meth:`GetDataType<OESystem::OEGridBase::GetDataType>`                     :oe:meth:`GetYIdx<OESystem::OEGridBase::GetYIdx>`                            :oe:meth:`IsInGrid<OESystem::OEGridBase::IsInGrid>`                          
   :oe:meth:`GetDim<OESystem::OEGridBase::GetDim>`                               :oe:meth:`GetYInc<OESystem::OEGridBase::GetYInc>`                            :oe:meth:`IsSpacingSet<OESystem::OEGridBase::IsSpacingSet>`                  
   :oe:meth:`GetMid<OESystem::OEGridBase::GetMid>`                               :oe:meth:`GetYMax<OESystem::OEGridBase::GetYMax>`                            :oe:meth:`IsTitleSet<OESystem::OEGridBase::IsTitleSet>`                      
   :oe:meth:`GetSize<OESystem::OEGridBase::GetSize>`                             :oe:meth:`GetYMid<OESystem::OEGridBase::GetYMid>`                            :oe:meth:`IsXMidSet<OESystem::OEGridBase::IsXMidSet>`                        
   :oe:meth:`GetSpacing<OESystem::OEGridBase::GetSpacing>`                       :oe:meth:`GetYMin<OESystem::OEGridBase::GetYMin>`                            :oe:meth:`IsYMidSet<OESystem::OEGridBase::IsYMidSet>`                        
   :oe:meth:`GetTitle<OESystem::OEGridBase::GetTitle>`                           :oe:meth:`GetZ<OESystem::OEGridBase::GetZ>`                                  :oe:meth:`IsZMidSet<OESystem::OEGridBase::IsZMidSet>`                        
   :oe:meth:`GetX<OESystem::OEGridBase::GetX>`                                   :oe:meth:`GetZDim<OESystem::OEGridBase::GetZDim>`                            :oe:meth:`SetTitle<OESystem::OEGridBase::SetTitle>`                          
   :oe:meth:`GetXDim<OESystem::OEGridBase::GetXDim>`                             :oe:meth:`GetZIdx<OESystem::OEGridBase::GetZIdx>`                            :oe:meth:`SpatialCoordToElement<OESystem::OEGridBase::SpatialCoordToElement>`
   :oe:meth:`GetXIdx<OESystem::OEGridBase::GetXIdx>`                             :oe:meth:`GetZInc<OESystem::OEGridBase::GetZInc>`                            :oe:meth:`SpatialCoordToGridIdx<OESystem::OEGridBase::SpatialCoordToGridIdx>`
   :oe:meth:`GetXInc<OESystem::OEGridBase::GetXInc>`                             :oe:meth:`GetZMax<OESystem::OEGridBase::GetZMax>`                                                                                                         
   :oe:meth:`GetXMax<OESystem::OEGridBase::GetXMax>`                             :oe:meth:`GetZMid<OESystem::OEGridBase::GetZMid>`                                                                                                         
   ============================================================================= ============================================================================ =============================================================================

   The following methods are publicly inherited from :ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>`:

   ================================================================== ================================================================== ===================================================================
   :oe:meth:`Clear<OESystem::OEGridAbstractBase::Clear>`              :oe:meth:`GetTitle<OESystem::OEGridAbstractBase::GetTitle>`        :oe:meth:`GetZMid<OESystem::OEGridAbstractBase::GetZMid>`          
   :oe:meth:`GetDataType<OESystem::OEGridAbstractBase::GetDataType>`  :oe:meth:`GetXDim<OESystem::OEGridAbstractBase::GetXDim>`          :oe:meth:`IsDataType<OESystem::OEGridAbstractBase::IsDataType>`    
   :oe:meth:`GetDim<OESystem::OEGridAbstractBase::GetDim>`            :oe:meth:`GetXMid<OESystem::OEGridAbstractBase::GetXMid>`          :oe:meth:`IsSpacingSet<OESystem::OEGridAbstractBase::IsSpacingSet>`
   :oe:meth:`GetMid<OESystem::OEGridAbstractBase::GetMid>`            :oe:meth:`GetYDim<OESystem::OEGridAbstractBase::GetYDim>`          :oe:meth:`SetTitle<OESystem::OEGridAbstractBase::SetTitle>`        
   :oe:meth:`GetSize<OESystem::OEGridAbstractBase::GetSize>`          :oe:meth:`GetYMid<OESystem::OEGridAbstractBase::GetYMid>`                                                                             
   :oe:meth:`GetSpacing<OESystem::OEGridAbstractBase::GetSpacing>`    :oe:meth:`GetZDim<OESystem::OEGridAbstractBase::GetZDim>`                                                                             
   ================================================================== ================================================================== ===================================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEMultiGrid()
         OEMultiGrid(const OEMultiGrid<GridType>& rhs)
         OEMultiGrid(const OEFixedMultiGrid<GridType>& rhs)
         OEMultiGrid(const float minmax[6], float spacing, int ngrids,
                     const char* title = "")
         OEMultiGrid(const double minmax[6], double spacing, int ngrids,
                     const char* title = "")
         OEMultiGrid(int xdim, int ydim, int zdim, float midx, float midy,
                     float midz, float spacing, int ngrids, std::string title,
                     GridType* dataptr)

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         const OEMultiGrid<GridType>& operator=(const OEMultiGrid<GridType>& rhs)
         const OEMultiGrid<GridType>& operator=(const OEFixedMultiGrid<GridType>& rhs)

      Assignment operator.

   .. oe:method:: Clear

      .. oe:api::

         void Clear()

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMultiGrid

   .. oe:method:: GetDataType

      .. oe:api::

         const void *GetDataType() const

   .. oe:method:: IsDataType

      .. oe:api::

         bool IsDataType(const void *type) const

   .. oe:method:: SetDim

      .. oe:api::

         bool SetDim(unsigned int ixdim, unsigned int iydim, unsigned int izdim)

   .. oe:method:: SetMid

      .. oe:api::

         bool SetMid(float x, float y, float z)

   .. oe:method:: SetSpacing

      .. oe:api::

         bool SetSpacing(float spacing)

   .. oe:method:: SetValues

      .. oe:api::

         bool SetValues(unsigned int igrid, const GridType *dataptr,
                        unsigned int length)

   .. oe:method:: SetXDim

      .. oe:api::

         bool SetXDim(unsigned int ixdim)

   .. oe:method:: SetXMid

      .. oe:api::

         bool SetXMid(float x)

   .. oe:method:: SetYDim

      .. oe:api::

         bool SetYDim(unsigned int iydim)

   .. oe:method:: SetYMid

      .. oe:api::

         bool SetYMid(float y)

   .. oe:method:: SetZDim

      .. oe:api::

         bool SetZDim(unsigned int izdim)

   .. oe:method:: SetZMid

      .. oe:api::

         bool SetZMid(float z)



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMultiParameter, MultiParameter

.. _OESystem_OEMultiParameter:

.. oe:class:: OEMultiParameter

   .. oe:api::

      template<class TT>
      class OEMultiParameter : public OESystem::OEPointerParameter<TT>

   OWMultiParameter represents parametera that have three different representations
   of the values.  The three representations are an unsigned , a std::string , and an object representation.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   The :ref:`OEMultiParameter <OESystem_OEMultiParameter>` class defines the following public methods:
    * :oe:meth:`AddLegalEntry<OESystem::OEMultiParameter::AddLegalEntry>` 
    * :oe:meth:`GetDefault<OESystem::OEMultiParameter::GetDefault>` and
      :oe:meth:`SetDefault<OESystem::OEMultiParameter::SetDefault>` 
    * :oe:meth:`GetSetting<OESystem::OEMultiParameter::GetSetting>`
    * :oe:meth:`GetValue<OESystem::OEMultiParameter::GetValue>` and
      :oe:meth:`SetValue<OESystem::OEMultiParameter::SetValue>`

   .. oe:method:: Constructors

      .. oe:api::

         OEMultiParameter()
         OEMultiParameter(const std::string& name, const bool customAllowed)
         OEMultiParameter(const OEMultiParameter&)

      Default and copy constructors.

      Constructs an OEMultiParameter instance using the specified set of parameters.
      The second argument in the second constructor represents if a custom object (not already defined 
      as a legal entry) could be used as a parameter.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMultiParameter& operator=(const OEMultiParameter &)

      The assignment operator.

   ..   _OESystem_OEMultiParameter_AddLegalEntry:

      Assignment operator.

   .. oe:method:: AddLegalEntry

      .. oe:api::

        bool AddLegalEntry(const unsigned idxKey, const std::string& strKey,
                           const TT& lib)

      Add new legal entry for this parameter. The three argument value represents the three
      representations of the same legal value.

   ..   _OESystem_OEMultiParameter_GetDefault:

   .. oe:method:: GetDefault

      .. oe:api::

         TT* GetDefault() const

      Returns the current default value of the parameter.

   ..   _OESystem_OEMultiParameter_GetSetting:

   .. oe:method:: GetSetting

      .. oe:api::

         TT* GetSetting() const

      Returns the current setting of the parameter.

   ..   _OESystem_OEMultiParameter_GetValue:

   .. oe:method:: GetValue

      .. oe:api::

         TT* GetValue() const

      Returns the current user-defined value of the parameter.

   ..   _OESystem_OEMultiParameter_SetDefault:

   .. oe:method:: SetDefault

      .. oe:api::

         bool SetValue(const unsigned)

      Sets the default value of the parameter.

   ..   _OESystem_OEMultiParameter_SetValue:

   .. oe:method:: SetValue

      .. oe:api::

         bool SetValue(const unsigned)
         bool SetValue(const std::string&)
         bool SetValue(const TT&)
         bool SetValue(OEPlatform::oeistream& ifs)

      Sets the user-defined value of the parameter.



.. oe:namespace:: OESystem

.. meta::
   :keywords: OENot

.. _OESystem_OENot:

.. oe:class:: OENot

   .. oe:api::

      template<class Arg>
      class OENot : public OEUnaryPredicate<Arg>

   This class represents `OENot`.

   This class template is a composition predicate which generates a predicate
   which is the logical *not* operation of the predicate passed as
   argument.

   .. seealso::

    * :ref:`section_predicates_composition_functors` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:language:: python java csharp

      The following specializations exist for this template :

      ==================== =====================================================
      OENotAtom            OESystem::OENot<OEChem::OEAtomBase>
      OENotBond            OESystem::OENot<OEChem::OEBondBase>
      OENotGroup           OESystem::OENot<OEChem::OEGroupBase>
      OENotConf            OESystem::OENot<OEChem::OEConfBase>
      OENotRoleSet         OESystem::OENot<OEChem::OERoleSet>
      OENotInteractionHint OESystem::OENot<OEChem::OEInteractionHint>
      ==================== =====================================================

   .. oe:method:: Constructors

      .. oe:api::

         OENot()
         OENot(const OENot<Arg>& rhs)
         OENot(const OEUnaryPredicate<Arg>& func)

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OENot& operator=(const OENot<Arg>& rhs)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const Arg& arg) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg: Arg) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUnaryFunction<Arg, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OENot



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEOptions, Options

.. _OESystem_OEOptions:

.. oe:class:: OEOptions

   .. oe:api::

      class OEOptions

   The :ref:`OEOptions <OESystem_OEOptions>` is an abstract base class. The Options represent
   a collection of :ref:`OEParameter <OESystem_OEParameter>` class that defines the set of parameters
   associated with settings of various objects or calculations.

   .. seealso::

      * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

   .. admonition:: Code Examples

      * :ref:`section_example_oechem_options` example

   The :ref:`OEOptions <OESystem_OEOptions>` class defines the following public methods:
    * :oe:meth:`AddDetail<OESystem::OEOptions::AddDetail>` and 
      :oe:meth:`GetDetail<OESystem::OEOptions::GetDetail>`
    * :oe:meth:`AddOption<OESystem::OEOptions::AddOption>`
    * :oe:meth:`AddParameter<OESystem::OEOptions::AddParameter>`
    * :oe:meth:`AddParameterPrefix<OESystem::OEOptions::AddParameterPrefix>`
    * :oe:meth:`AddParameterSuffix<OESystem::OEOptions::AddParameterSuffix>`
    * :oe:meth:`Clear<OESystem::OEOptions::Clear>`
    * :oe:meth:`DeleteOptions<OESystem::OEOptions::DeleteOptions>`
    * :oe:meth:`DeleteParameter<OESystem::OEOptions::DeleteParameter>`
    * :oe:meth:`FindDupParameters<OESystem::OEOptions::FindDupParameters>`
    * :oe:meth:`GetBrief<OESystem::OEOptions::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEOptions::SetBrief>`
    * :oe:meth:`GetName<OESystem::OEOptions::GetName>` and
      :oe:meth:`SetName<OESystem::OEOptions::SetName>`
    * :oe:meth:`GetOption<OESystem::OEOptions::GetOption>`
    * :oe:meth:`GetOptions<OESystem::OEOptions::GetOptions>`
    * :oe:meth:`GetOrderPriority<OESystem::OEOptions::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEOptions::SetOrderPriority>`
    * :oe:meth:`GetParameter<OESystem::OEOptions::GetParameter>`
    * :oe:meth:`GetParameters<OESystem::OEOptions::GetParameters>`
    * :oe:meth:`HasDupParameters<OESystem::OEOptions::HasDupParameters>`
    * :oe:meth:`HasOption<OESystem::OEOptions::HasOption>`
    * :oe:meth:`HasParameter<OESystem::OEOptions::HasParameter>`
    * :oe:meth:`SetParameterVisibility<OESystem::OEOptions::SetParameterVisibility>`
    * :oe:meth:`UpdateValues<OESystem::OEOptions::UpdateValues>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOptions & operator=(const OEOptions &)

      Assignment operator.

   
   .. oe:method:: AddDetail

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddDetail(const std::string& detail)

      .. oe:language:: python

         .. oe:api:: python

            AddDetail(detail: str) -> bool

      Adds a line to the detailed description of the options.

   .. oe:method:: AddOption

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOptions* AddOption(const OEOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            AddOption(opts: OEOptions) -> OEOptions

      Adds a copy of the specified options as sub-options to this options.

   .. oe:method:: AddParameter

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEParameter* AddParameter(const OEParameter&)

      .. oe:language:: python

         .. oe:api:: python

            AddParameter(param: OEParameter) -> OEParameter

      Adds a copy of the specified parameter to the options.

      .. oe:method:: AddParameterPrefix

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddParameterPrefix(const std::string& prefix,
                                    const bool underScore = true)

      .. oe:language:: python

         .. oe:api:: python

            AddParameterPrefix(prefix: str, underScore: bool = True) -> bool

      Add the specified prefix to the name of all the parameters.

   .. oe:method:: AddParameterSuffix

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddParameterSuffix(const std::string& suffix)

      .. oe:language:: python

         .. oe:api:: python

            AddParameterSuffix(suffix: str) -> bool

      Add the specified suffix to the name of all the parameters.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Removes all parameters and sub-options.

   .. oe:method:: DeleteOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteOptions(OEOptions&)

      .. oe:language:: python

         .. oe:api:: python

            DeleteOptions(arg2: OEOptions) -> bool

      Deletes the specified sub-options, if it belongs to this options.

   .. oe:method:: DeleteParameter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteParameter(OEParameter& param)

      .. oe:language:: python

         .. oe:api:: python

            DeleteParameter(param: OEParameter) -> bool

      Deletes the specified parameter, if it belongs to this options.

   .. oe:method:: FindDupParameters

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<OEParameter>* FindDupParameters(const bool visibleOnly = true)
            OEIterBase<const OEParameter>* FindDupParameters(const bool visibleOnly = true) const

      .. oe:language:: python

         .. oe:api:: python

            FindDupParameters(const: bool) -> OEParameterIter
            FindDupParameters(const: bool) -> Iterable[OEParameter]

      Returns duplicate parameters.  Two parameters are considered duplicates if they have
      a common name.  If ``visibleOnly`` is set to ``True``, parameters with visibility
      :oe:const:`OESystem::OEParamVisibility::Hidden` are ignored from this list. This operation 
      is always recursive to the associated sub-options.

   .. oe:method:: GetBrief

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetBrief() const

      .. oe:language:: python

         .. oe:api:: python

            GetBrief() -> str

      See :oe:meth:`SetBrief<OESystem::OEOptions::SetBrief>` method.

   .. oe:method:: GetDetail

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const std::string>* GetDetail() const

      .. oe:language:: python

         .. oe:api:: python

            GetDetail() -> Iterable[str]

      See :oe:meth:`AddDetail<OESystem::OEOptions::AddDetail>` method.

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      See :oe:meth:`SetName<OESystem::OEOptions::SetName>` method.

   .. oe:method:: GetOption

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOptions* GetOption(const std::string& name)
            const OEOptions* GetOption(const std::string& name) const

      .. oe:language:: python

         .. oe:api:: python

            GetOption(name: str) -> OEOptions

      Get the sub-options with the specified name. Returns a NULL pointer if a sub-options with
      specified name does not exist.

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const OEOptions>* GetOptions(const bool recursive = true) const
            OEIterBase<OEOptions>* GetOptions(const bool recursive = true)

      .. oe:language:: python

         .. oe:api:: python

            GetOptions(const: bool) -> Iterable[OEOptions]

      Get the sub-options of this options. A value of ``true`` for ``recursive`` compiles all 
      the sub-options from the subsequent sub-options.

   .. oe:method:: GetOrderPriority

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetOrderPriority() const

      .. oe:language:: python

         .. oe:api:: python

            GetOrderPriority() -> int

      See :oe:meth:`SetOrderPriority<OESystem::OEOptions::SetOrderPriority>` method.

   .. oe:method:: GetParameter

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEParameter* GetParameter(const std::string& name)
            const OEParameter* GetParameter(const std::string& name) const

      .. oe:language:: python

         .. oe:api:: python

            GetParameter(name: str) -> OEParameter

      Get the parameter with the specified name. Returns a NULL pointer if a parameter with
      specified name does not exist.

   .. oe:method:: GetParameters

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const OEParameter>* GetParameters(const bool recursive = true) const
            OEIterBase<OEParameter>* GetParameters(const bool recursive = true)
            OEIterBase<const OEParameter>* GetParameters(const std::string& name,
                                                         const bool recursive = true) const
            OEIterBase<OEParameter>* GetParameters(const std::string& name,
                                                   const bool recursive = true)

      .. oe:language:: python

         .. oe:api:: python

            GetParameters(const: bool) -> Iterable[OEParameter]
            GetParameters(const: bool) -> OEParameterIter
            GetParameters(arg1: str, recursive: bool = True) -> Iterable[OEParameter]
            GetParameters(arg1: str, recursive: bool = True) -> OEParameterIter

      Get the parameters from this options. If a name is specified only parameters with the specified 
      name are provided. A value of ``true`` for ``recursive`` compiles all the parameters from the
      subsequent sub-options.

   .. oe:method:: HasDupParameters

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasDupParameters(const bool visibleOnly = true) const

      .. oe:language:: python

         .. oe:api:: python

            HasDupParameters(visibleOnly: bool = True) -> bool

      Check if a there are duplicate parameters in this options. Two parameters are considered 
      duplicates if they have a common name.  If ``visibleOnly`` is set to ``True``, parameters with 
      visibility :oe:const:`OESystem::OEParamVisibility::Hidden` are ignored from this check. This 
      operation is always recursive to the associated sub-options.

   .. oe:method:: HasOption

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasOption(const std::string& name) const

      .. oe:language:: python

         .. oe:api:: python

            HasOption(name: str) -> bool

      Check if a sub-options with the specified name exists in the options.

   .. oe:method:: HasParameter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasParameter(const std::string& name) const

      .. oe:language:: python

         .. oe:api:: python

            HasParameter(name: str) -> bool

      Check if a parameter with the specified name (or alias) exists in the options.

   .. oe:method:: SetBrief

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBrief(std::string brief)

      .. oe:language:: python

         .. oe:api:: python

            SetBrief(brief: str) -> bool

      Sets the brief description of the Options.

   .. oe:method:: SetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetName(std::string name)

      .. oe:language:: python

         .. oe:api:: python

            SetName(name: str) -> bool

      Sets the name of the Options. 

   .. oe:method:: SetOrderPriority

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOrderPriority(int order)

      .. oe:language:: python

         .. oe:api:: python

            SetOrderPriority(priority: int) -> bool

      Sets the order priority of the Options, which is used to
      control the order Options appear in help lists. **Default: 0**

   .. oe:method:: SetParameterVisibility

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetParameterVisibility(const unsigned visibility)
            bool SetParameterVisibility(const std::string& name,
                                        const unsigned visibility)

      .. oe:language:: python

         .. oe:api:: python

            SetParameterVisibility(visibility: int) -> bool
            SetParameterVisibility(name: str, visibility: int) -> bool

      Sets the visibility of the parameters to the specified value.  This operation is
      always recursive to the associated sub-options. Valid settings are defined in the :oe:constns:`OESystem::OEParamVisibility` namespace.

   .. oe:method:: UpdateValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool UpdateValues(const OEOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            UpdateValues(opts: OEOptions) -> bool

      Update parameters values of this options, from the parameter values of the soecified
      options.  Two parameters are considered same if they have a common name and data type. 
      This operation is always recursive to the associated sub-options.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEOr

.. _OESystem_OEOr:

.. oe:class:: OEOr

   .. oe:api::

      template<class Arg>
      class OEOr : public OEUnaryPredicate<Arg>

   This class represents `OEOr`.

   This class template is a composition predicate which generates a predicate
   which is the logical *or* operation of the two predicates passed as
   arguments.

   .. seealso::

    * :ref:`section_predicates_composition_functors` section

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================

   .. oe:language:: python java csharp

      The following specializations exist for this template :

      ==================== =====================================================
      OEOrAtom             OESystem::OEOr<OEChem::OEAtomBase>
      OEOrBond             OESystem::OEOr<OEChem::OEBondBase>
      OEOrConf             OESystem::OEOr<OEChem::OEConfBase>
      OEOrGroup            OESystem::OEOr<OEChem::OEGroupBase>
      OEOrRoleSet          OESystem::OEOr<OEChem::OERoleSet>
      OEOrInteractionHint  OESystem::OEOr<OEChem::OEInteractionHint>
      ==================== =====================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEOr()
         OEOr(const OEOr<Arg>& rhs)
         OEOr(const OEUnaryPredicate<Arg>& func1,
              const OEUnaryPredicate<Arg>& func2)

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOr& operator=(const OEOr<Arg>& rhs)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const Arg& arg) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg: Arg) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUnaryFunction<Arg, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEOr



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEOwnedPtr, OwnedPtr

.. _OESystem_OEOwnedPtr:

.. oe:class:: OEOwnedPtr

   .. oe:api::

      template<class T>
      class OEOwnedPtr

   .. warning::

      This class has been deprecated. Use ``std::unique_ptr`` instead.
      C++ only class. This class is not visible in any other languages.

   This class is a classic `smart pointer
   <http://en.wikipedia.org/wiki/Smart_pointer>`_ used for
   automatically managing the dynamic memory allocated for the object
   ``T``. Explicitly calling ``delete`` is generally frowned upon
   in modern C++ due to the propensity of explicit ``delete`` leading
   to resource leaks and crashes. Deleting memory should be handled
   more automatically by mechanisms like
   :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` and :ref:`OESharedPtr <OESystem_OESharedPtr>`.

   :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` is designed to mimic the C++11
   `std::unique_ptr
   <http://en.cppreference.com/w/cpp/memory/unique_ptr>`_ in
   functionality with some important differences.

   The first and most obvious difference is that
   :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` will compile and work in non-C++11
   compilers. This provides the convenience and safety of
   `std::unique_ptr
   <http://en.cppreference.com/w/cpp/memory/unique_ptr>`_ without
   having to wait for every *OpenEye* platform to support C++11. That
   means the following will compile on all *OpenEye* supported
   platforms:

   .. code-block:: c++

      struct Foo { };

      struct BarOwnsFoo
      {
        OEOwnedPtr<Foo> _owned;
        Foo *GetFoo() { return _owned; }
      };

   .. note::

      Users are free to use C++11 features with the OpenEye toolkits in
      their own code. OpenEye will be slowly phasing in more support
      for C++11 features over many releases. For example,
      :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` has `move constructors
      <http://en.cppreference.com/w/cpp/language/move_constructor>`_
      to allow for the following idiom to work in C++11 compilers:

      .. code-block:: c++

         OEOwnedPtr<Foo> MakeFoo()
         {
           return OEOwnedPtr<Foo>(new Foo);
         };

   The second key difference between :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>`
   and `std::unique_ptr
   <http://en.cppreference.com/w/cpp/memory/unique_ptr>`_ is whether
   ``const`` is maintained when accessing the object being pointed
   to. By default, in order to maintain compatibility with C, C++
   allows non-const access to const pointers. By extension, this same
   rule applied to C++ smart pointers. This leads to very surprising
   behavior like the following:

   .. code-block:: c++

      struct Foo
      {
        int _x;
        void AlterFoo() { _x = 1; }
      };

      struct BarOwnsFoo
      {
        Foo *_foo;
        void AConstMethod() const { _foo->AlterFoo(); }
      };

   Even though ``AConstMethod`` is ``const``, it isn't actually
   logically const. The internals of the class are changing. This
   behavior may seem benign at first, but it has vast implications in
   a library seeking to be thread-safe. The ``const`` on a method
   implies that the method is thread-safe, especially in C++11. In
   order to enforce thread-safety at runtime,
   :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` maintains the "const'ness" of its
   accessor methods. Therefore, the following is actually a compile
   error:

   .. code-block:: c++

      struct Foo
      {
        int _x;
        void AlterFoo() { _x = 1; }
      };

      struct BarOwnsFoo
      {
        OEOwnedPtr<Foo> _foo;
        void AConstMethod() const { _foo->AlterFoo(); }
      };

   Catching thread-safety problems very early, at compilation, is
   highly desirable for *OpenEye*. Hence the reason to differ from the
   standard smart pointer semantics in this way.

   .. oe:method:: Constructors

      .. oe:api::

         OEOwnedPtr()
         OEOwnedPtr(T* ptr)

      Default constructors the pointer to ``NULL``. Or constructs a
      smart pointer around the pointer ``ptr``.

      .. oe:api::

         OEOwnedPtr(OEOwnedPtr&& rhs)

      Move constructor to safely transfer ownership of the underlying
      pointer from one :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` to another. This
      allows :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` to be usable in container
      objects like ``std::vector`` in C++11 compatible compilers.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOwnedPtr<T>& operator=(T* rhs)

      Construct a smart pointer around the pointer ``ptr``.

      .. warning::

         :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` does not have a copy
         constructor or assignment operator for very good
         reason. It does not know how to properly deep copy the
         pointer, or how to properly "share" the pointer among
         multiple users. If this behavior is desired, for example,
         to use a smart pointer inside an ``std::vector`` prior to
         C++11, use :ref:`OESharedPtr <OESystem_OESharedPtr>` instead.

      .. oe:api::

         OEOwnedPtr<T>& operator=(OEOwnedPtr<T>&& rhs)

      Move assignment operator to work around the above warning
      message. This is only available in C++11 compatible compilers.

      Assignment operator.

   .. oe:method:: operator*
      :language: c++

      .. oe:api::

         T& operator*()
         const T& operator*() const

      Dereference the smart pointer and return a reference to the held
      object while maintaining ``const`` correctness. Note,
      dereferencing a ``NULL`` pointer is undefined.

   .. oe:method:: operator->
      :language: c++

      .. oe:api::

         T* operator->()
         const T* operator->() const

      Access the pointer held by this smart pointer while maintaining
      ``const`` correctness.

   .. oe:method:: operator T *
      :language: c++

      .. oe:api::

         operator T *()

      Implicit conversion to a pointer to ``T``.

   .. oe:method:: operator const T *
      :language: c++

      .. oe:api::

         operator const T *() const

      Implicit conversion to a pointer to ``const T``.

   .. oe:method:: Get

      .. oe:api::

         T* Get()
         const T* Get() const

      Access the pointer held by this smart pointer while maintaining
      ``const`` correctness.

   .. oe:method:: Release

      .. oe:api::

         T* Release()

      Returns the pointer owned by this smart pointer. The smart
      pointer will cease to "own" the pointer in question. The smart
      pointer will effectively become a ``NULL`` pointer.

      .. warning::

         The user is expected to ``delete`` the pointer, usually by
         passing to a different smarter pointer class immediately.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEPODParameter, PODParameter

.. _OESystem_OEPODParameter:

.. oe:class:: OEPODParameter

   .. oe:api::

      template<class TT>
      class OEPODParameter : public OETypedParameter<TT>

   The :ref:`OEPODParameter <OESystem_OEPODParameter>` is an abstract base class, derived from :ref:`OETypedParameter <OESystem_OETypedParameter>`. This is a templated class that provides type-specific
   implementation of parameters that has plain-old-data (POD) type value.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OETypedParameter <OESystem_OETypedParameter>`:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   The :ref:`OEPODParameter <OESystem_OEPODParameter>` class defines the following public methods:
    * :oe:meth:`GetDefaultsVector<OESystem::OEPODParameter::GetDefaultsVector>`
    * :oe:meth:`GetSettingsVector<OESystem::OEPODParameter::GetSettingsVector>`
    * :oe:meth:`GetValuesVector<OESystem::OEPODParameter::GetValuesVector>`

   The following classes derive from this class:
    * :ref:`OEBoolParameter <OESystem_OEBoolParameter>`
    * :ref:`OEDoubleParameter <OESystem_OEDoubleParameter>`
    * :ref:`OEFloatParameter <OESystem_OEFloatParameter>`
    * :ref:`OEIntParameter <OESystem_OEIntParameter>`
    * :ref:`OEStringParameter <OESystem_OEStringParameter>`
    * :ref:`OEUIntParameter <OESystem_OEUIntParameter>`

   ..   _OESystem_GetDefaultsVector:

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPODParameter & operator=(const OEPODParameter &)

      Assignment operator.

   .. oe:method:: GetDefaultsVector

      .. oe:api::

         std::vector<TT> GetDefaultsVector() const

      Returns a vector of values containing the current defaults.

   ..   _OESystem_GetSettingsVector:

   .. oe:method:: GetSettingsVector

      .. oe:api::

         std::vector<TT> GetSettingsVector() const

      Returns a vector of values containing the current settings.

   ..   _OESystem_GetValuesVector:

   .. oe:method:: GetValuesVector

      .. oe:api::

         std::vector<TT> GetValuesVector() const

      Returns a vector of values containing the current user-defined values.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEParameter, Parameter

.. _OESystem_OEParameter:

.. oe:class:: OEParameter

   .. oe:api::

      class OEParameter

   The :ref:`OEParameter <OESystem_OEParameter>` is an abstract base class. The parameters represent
   indivudual options in a :ref:`OEOptions <OESystem_OEOptions>` class, that can eventually translate
   to a parameter in a command-line interface application.

   The :ref:`OEParameter <OESystem_OEParameter>` class defines the following public methods:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`GetLegalValues<OESystem::OEParameter::GetLegalValues>` and
      :oe:meth:`GetPrettyLegalValues<OESystem::OEParameter::GetPrettyLegalValues>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   The following classes derive from this class:
    * :ref:`OETypedParameter <OESystem_OETypedParameter>`
    * :ref:`OEPointerParameter <OESystem_OEPointerParameter>`
   

   ..  _OESystem_OEParameter_AddAlias:

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEParameter & operator=(const OEParameter &)

      Assignment operator.

   .. oe:method:: AddAlias

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddAlias(const std::string& alias)

      .. oe:language:: python

         .. oe:api:: python

            AddAlias(alias: str) -> bool

      Adds an 'alias' name for this parameter. The alias must be a single word and begin with 
      a ``'-'``. This function returns ``true`` if the alias is valid and the add succeeds.

   ..  _OESystem_OEParameter_AddDetail:

   .. oe:method:: AddDetail

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddDetail(const std::string& detail)

      .. oe:language:: python

         .. oe:api:: python

            AddDetail(detail: str) -> bool

      Adds a line to the detailed description of the parameter. Return ``true`` if completed successfully.

   ..  _OESystem_OEParameter_AddIllegalRange:

   .. oe:method:: AddIllegalRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddIllegalRange(const std::string& hi_val,
                                 const std::string& low_val)

      .. oe:language:: python

         .. oe:api:: python

            AddIllegalRange(hi: str, low: str) -> bool

      Adds an illegal range for this parameter in string format. This function succeeds and returns ``true`` 
      if the parameter can have illegal ranges.

   ..  _OESystem_OEParameter_AddIllegalValue:

   .. oe:method:: AddIllegalValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddIllegalValue(const std::string& val)

      .. oe:language:: python

         .. oe:api:: python

            AddIllegalValue(val: str) -> bool

      Adds an illegal value in string format. This function succeeds and returns ``true`` if the parameter 
      can have illegal values.

   ..  _OESystem_OEParameter_AddLegalRange:

   .. oe:method:: AddLegalRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddLegalRange(const std::string& hi_val,
                               const std::string& low_val)

      .. oe:language:: python

         .. oe:api:: python

            AddLegalRange(hi: str, low: str) -> bool

      Adds a legal range for the parameter in string format. This function succeeds and returns ``true`` 
      if the parameter can have legal ranges. 

   ..  _OESystem_OEParameter_AddLegalValue:

 

   .. oe:method:: AddLegalValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddLegalValue(const std::string& val)

      .. oe:language:: python

         .. oe:api:: python

            AddLegalValue(val: str) -> bool

      Adds a legal value in string format. This function succeeds and returns ``true`` if the parameter 
      can have legal values.

   ..  _OESystem_OEParameter_AddStringDefault:

   .. oe:method:: AddStringDefault

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddStringDefault(const std::string& string_default)

      .. oe:language:: python

         .. oe:api:: python

            AddStringDefault(value: str) -> bool

      Adds a default value in string format. This function succeeds and returns ``true`` if the default
      value can be set.

   ..  _OESystem_OEParameter_AddStringValue:

   .. oe:method:: AddStringValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddStringValue(const std::string& string_value)

      .. oe:language:: python

         .. oe:api:: python

            AddStringValue(value: str) -> bool

      Adds a value for the parameter in string format. This function succeeds and returns ``true`` if the 
      value can be set.

   ..  _OESystem_OEParameter_ClearDefaults:

   .. oe:method:: ClearDefaults

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ClearDefaults()

      .. oe:language:: python

         .. oe:api:: python

            ClearDefaults() -> bool

      Clear all currently set default values. Returns ``true`` if done successfully.

   ..  _OESystem_OEParameter_ClearValues:

   .. oe:method:: ClearValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ClearValues()

      .. oe:language:: python

         .. oe:api:: python

            ClearValues() -> bool

      Clear all currently set parameter values. Returns ``true`` if done successfully.

   ..  _OESystem_OEParameter_CreateCopy:

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEParameter* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEParameter

      Creates a copy of this :ref:`OEParameter <OESystem_OEParameter>` instance.

   ..  _OESystem_OEParameter_GetAliases:

   .. oe:method:: GetAliases

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const std::string>* GetAliases() const

      .. oe:language:: python

         .. oe:api:: python

            GetAliases() -> Iterable[str]

      See :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` method.

   ..  _OESystem_OEParameter_GetBrief:

   .. oe:method:: GetBrief

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetBrief() const

      .. oe:language:: python

         .. oe:api:: python

            GetBrief() -> str

      See :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>` method.

   ..  _OESystem_OEParameter_GetDetail:

   .. oe:method:: GetDetail

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const std::string>* GetDetail() const

      .. oe:language:: python

         .. oe:api:: python

            GetDetail() -> Iterable[str]

      See :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` method.

   ..  _OESystem_OEParameter_GetHasDefault:

   .. oe:method:: GetHasDefault

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetHasDefault(const unsigned idx = 0) const

      .. oe:language:: python

         .. oe:api:: python

            GetHasDefault(idx: int = 0) -> bool

      Returns ``true`` if a default value for the parameter is set.

   ..  _OESystem_OEParameter_GetHasValue:

   .. oe:method:: GetHasValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetHasValue(const unsigned idx = 0) const

      .. oe:language:: python

         .. oe:api:: python

            GetHasValue(idx: int = 0) -> bool

      Returns ``true`` if the value of the :ref:`OEParameter <OESystem_OEParameter>` object is set.

   ..  _OESystem_OEParameter_GetIllegalRanges:

   .. oe:method:: GetIllegalRanges

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const std::pair<std::string, std::string> > * GetIllegalRanges() const

      .. oe:language:: python

         .. oe:api:: python

            GetIllegalRanges() -> Iterable[Tuple[str,str]]

      See :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` method.

   ..  _OESystem_OEParameter_GetIllegalValues:

   .. oe:method:: GetIllegalValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const std::string>* GetIllegalValues() const

      .. oe:language:: python

         .. oe:api:: python

            GetIllegalValues() -> Iterable[str]

      See :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` method.

   ..  _OESystem_OEParameter_GetIsList:

   .. oe:method:: GetIsList

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetIsList() const

      .. oe:language:: python

         .. oe:api:: python

            GetIsList() -> bool

      See :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>` method.

   ..  _OESystem_OEParameter_GetKeyless:

   .. oe:method:: GetKeyless

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetKeyless() const

      .. oe:language:: python

         .. oe:api:: python

            GetKeyless() -> int

      See :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>` method.

   ..  _OESystem_OEParameter_GetLegalRanges:

   .. oe:method:: GetLegalRanges

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const std::pair<std::string, std::string> > * GetLegalRanges() const

      .. oe:language:: python

         .. oe:api:: python

            GetLegalRanges() -> Iterable[Tuple[str,str]]

      Returns the legal ranges in string format.

   ..  _OESystem_OEParameter_GetLegalValues:

   .. oe:method:: GetLegalValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const std::string>* GetLegalValues() const

      .. oe:language:: python

         .. oe:api:: python

            GetLegalValues() -> Iterable[str]

      Returns the legal values of the parameter in string format.

   ..  _OESystem_OEParameter_GetPrettyLegalValues:

   .. oe:method:: GetPrettyLegalValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const std::string>* GetPrettyLegalValues() const

      .. oe:language:: python

         .. oe:api:: python

            GetPrettyLegalValues() -> Iterable[str]

      Returns the named legal values of the parameter in string format. This list of legal values may or may-not 
      be idential to the one obtained from :oe:meth:`GetLegalValues<OESystem::OEParameter::GetLegalValues>`,
      depending on the parameter type.  

   ..  _OESystem_OEParameter_GetName:
  

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      See :oe:meth:`SetName<OESystem::OEParameter::SetName>` method.

   ..  _OESystem_OEParameter_GetOrderPriority:

   .. oe:method:: GetOrderPriority

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetOrderPriority() const

      .. oe:language:: python

         .. oe:api:: python

            GetOrderPriority() -> int

      See :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>` method.

   ..  _OESystem_OEParameter_GetRequired:

   .. oe:method:: GetRequired

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRequired() const

      .. oe:language:: python

         .. oe:api:: python

            GetRequired() -> bool

      See :oe:meth:`SetRequired<OESystem::OEParameter::SetRequired>` method.

   ..  _OESystem_OEParameter_GetStringDefault:

   .. oe:method:: GetStringDefault

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetStringDefault(const unsigned idx = 0) const

      .. oe:language:: python

         .. oe:api:: python

            GetStringDefault(idx: int = 0) -> str

      Returns the string default of the parameter at the specified index. See 
      :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` method.

   ..  _OESystem_OEParameter_GetStringDefaults:

   .. oe:method:: GetStringDefaults

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const std::string>* GetStringDefaults() const

      .. oe:language:: python

         .. oe:api:: python

            GetStringDefaults() -> Iterable[str]

      See :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` method.

   ..  _OESystem_OEParameter_GetStringValue:

   .. oe:method:: GetStringValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetStringValue(const unsigned idx = 0) const

      .. oe:language:: python

         .. oe:api:: python

            GetStringValue(idx: int = 0) -> str

      Returns the string value of the parameter at the specified index. See 
      :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` method.

   ..  _OESystem_OEParameter_GetStringValues:

   .. oe:method:: GetStringValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const std::string>* GetStringValues() const

      .. oe:language:: python

         .. oe:api:: python

            GetStringValues() -> Iterable[str]

      See :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` method.

   ..  _OESystem_OEParameter_GetVisibility:

   .. oe:method:: GetVisibility

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetVisibility() const

      .. oe:language:: python

         .. oe:api:: python

            GetVisibility() -> int

      See :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>` method.

   ..  _OESystem_OEParameter_IsLegalString:

   .. oe:method:: IsLegalString

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsLegalString(const std::string& value) const

      .. oe:language:: python

         .. oe:api:: python

            IsLegalString(value: str) -> bool

      Returns if the specified value in the string format is a legal
      value. A setting is considered a legal value if it does not
      match and illegal value or fall within an illegal range (see
      :oe:meth:`OESystem::OEParameter::AddIllegalValue` and
      :oe:meth:`OESystem::OEParameter::AddIllegalRange` member
      functions of this class). Additionally if the parameter has at
      least one legal value or legal range the setting must match
      either a legal value or legal range.

   ..  _OESystem_OEParameter_IsSet:

   .. oe:method:: IsSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsSet(const unsigned idx = 0) const

      .. oe:language:: python

         .. oe:api:: python

            IsSet(idx: int = 0) -> bool

      Returns if the parameter current contains a setting, i.e., a default or an user-defined value. 

   ..  _OESystem_OEParameter_IsSetToString:
 

   .. oe:method:: IsSetToString

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsSetToString(const std::string& val) const

      .. oe:language:: python

         .. oe:api:: python

            IsSetToString(val: str) -> bool

      Returns if the parameters current setting (i.e., a default or an user-defined value) matches
      the specified string value.

   ..  _OESystem_OEParameter_Load:

   .. oe:method:: Load

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Load()

      .. oe:language:: python

         .. oe:api:: python

            Load() -> bool

      Converts the string defaults and values of this parameter into actual defaults and values.
      This function will return ``false`` if the string defaults or values cannot be converted to the 
      actual defaults or values, as well as if the values do not satisfy the specified ranges.

   ..  _OESystem_OEParameter_LoadDefault:

   .. oe:method:: LoadDefault

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool LoadDefault()

      .. oe:language:: python

         .. oe:api:: python

            LoadDefault() -> bool

      Converts the string defaults of this parameter into actual defaults.
      This function will return ``false`` if the string defaults cannot be converted to the actual defaults,
      as well as if the default values do not satisfy the specified ranges.

   ..  _OESystem_OEParameter_LoadValue:

   .. oe:method:: LoadValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool LoadValue()

      .. oe:language:: python

         .. oe:api:: python

            LoadValue() -> bool

      Converts the user-defined string values of this parameter into actual values.
      This function will return ``false`` if the string values cannot be converted to the actual values,
      as well as if the values do not satisfy the specified ranges.

   ..  _OESystem_OEParameter_SetBrief:

   .. oe:method:: SetBrief

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBrief(std::string brief)

      .. oe:language:: python

         .. oe:api:: python

            SetBrief(brief: str) -> bool

      Sets the brief description of the parameter.

   ..  _OESystem_OEParameter_SetIsList:

   .. oe:method:: SetIsList

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIsList(bool is_list_parameter)

      .. oe:language:: python

         .. oe:api:: python

            SetIsList(isList: bool) -> bool

      Set if the parameter is a list parameter, i.e., if the parameters can value of list of defaults 
      or user-defined values. **Default: False**

   ..  _OESystem_OEParameter_SetKeyless:

   .. oe:method:: SetKeyless

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetKeyless(const unsigned keyless)

      .. oe:language:: python

         .. oe:api:: python

            SetKeyless(keyless: int) -> bool

      Sets the keyless setting of the parameter. To enable a prrameter to be keyless the entry must be a
      non-zero value.  A value of 0 (default) specifies the parameter to be not-keyless.
      **Default: 0**

   ..  _OESystem_OEParameter_SetName:

   .. oe:method:: SetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetName(std::string name)

      .. oe:language:: python

         .. oe:api:: python

            SetName(name: str) -> bool

      Sets the name of the parameter, which must be a single word and
      begin with ``'-'``. 

   ..  _OESystem_OEParameter_SetOrderPriority:
 

   .. oe:method:: SetOrderPriority

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOrderPriority(int order)

      .. oe:language:: python

         .. oe:api:: python

            SetOrderPriority(order: int) -> bool

      Sets the order priority of the parameter, which is used to
      control the order parameters appear in help lists. **Default: 0**

   ..  _OESystem_OEParameter_SetRequired:

   .. oe:method:: SetRequired

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRequired(bool required)

      .. oe:language:: python

         .. oe:api:: python

            SetRequired(required: bool) -> bool

      Sets the flag indicating if the parameter is required (i.e., must be guven a user-defined value).
      **Default: False**

   ..  _OESystem_OEParameter_SetStringDefault:

   .. oe:method:: SetStringDefault

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStringDefault(const std::string& string_default)

      .. oe:language:: python

         .. oe:api:: python

            SetStringDefault(value: str) -> bool

      Sets the default value of the parameter as a string. This string
      default is not converted into the read default until the
      :oe:meth:`OESystem::OEParameter::LoadDefault` member function is
      called. **Default: None**

   ..  _OESystem_OEParameter_SetStringValue:

   .. oe:method:: SetStringValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStringValue(const std::string& string_value)

      .. oe:language:: python

         .. oe:api:: python

            SetStringValue(value: str) -> bool

      Sets the value of the parameter as a string. This string value
      is not converted into the real value until
      the :oe:meth:`OESystem::OEParameter::LoadValue` member function is
      called. **Default: None**

   ..  _OESystem_OEParameter_SetVisibility:

   .. oe:method:: SetVisibility

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetVisibility(const unsigned visibility)

      .. oe:language:: python

         .. oe:api:: python

            SetVisibility(visibility: int) -> bool

      Sets the visibility of the parameter. Valid settings are defined in the :oe:constns:`OESystem::OEParamVisibility` namespace. 
      ** Default :oe:const:`OESystem::OEParamVisibility::Simple` **


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEPointerParameter, PointerParameter

.. _OESystem_OEPointerParameter:

.. oe:class:: OEPointerParameter

   .. oe:api::

      template<class TT>
      class OEPointerParameter : public OEParameter

   The :ref:`OEPointerParameter <OESystem_OEPointerParameter>` is an abstract base class, derived from :ref:`OEParameter <OESystem_OEParameter>`. This is a templated class that provides type-specific
   implementation of parameters that has object-pointer-type value.  A 
   :ref:`OEPointerParameter <OESystem_OEPointerParameter>` always contains a single default or user-defined value.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPointerParameter & operator=(const OEPointerParameter & rhs)

      Assignment operator.



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEPredIter, PredIter

.. warning::

   This functionality is only available in the C++ toolkits.

.. _OESystem_OEPredIter:

.. oe:class:: OEPredIter

   .. oe:api::

      template<class P>
      class OEPredIter : public OEIterBase<typename P::argument_type>

   This class represents `OEPredIter`.

   The following methods are publicly inherited from :ref:`OEIterBase <OESystem_OEIterBase>`:

   ============================================================ ============================================================= ============================================================
   :oe:meth:`operator*<OESystem::OEIterBase::operator*>`        :oe:meth:`operator-=<OESystem::OEIterBase::operator-=>`       :oe:meth:`Copy<OESystem::OEIterBase::Copy>`
   :oe:meth:`operator++<OESystem::OEIterBase::operator++>`      :oe:meth:`operator-><OESystem::OEIterBase::operator->>`       :oe:meth:`Push<OESystem::OEIterBase::Push>`
   :oe:meth:`operator+=<OESystem::OEIterBase::operator+=>`      :oe:meth:`operator A *<OESystem::OEIterBase::operator A *>`   :oe:meth:`ToFirst<OESystem::OEIterBase::ToFirst>`
   :oe:meth:`operator--<OESystem::OEIterBase::operator-->`      :oe:meth:`operator bool<OESystem::OEIterBase::operator bool>` :oe:meth:`ToLast<OESystem::OEIterBase::ToLast>`
   ============================================================ ============================================================= ============================================================

   .. oe:method:: Constructors

      .. oe:api::

         OEPredIter()
         OEPredIter(const OEPredIter<P>& rhs)
         OEPredIter(const P& pred, OEIterBase<A>* rhs)

      Default and copy constructors.

   .. oe:method:: operator*
      :language: c++

      .. oe:api::

         A& operator*() const

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPredIter<P>& operator=(OEIterBase<A>* rhs)
         OEPredIter<P>& operator=(const OEPredIter<P>& rhs)

      Assignment operator.

   .. oe:method:: operator++
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator++()

   .. oe:method:: operator+=
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator+=(int x)
         OEIterBase<A>& operator+=(unsigned int x)

   .. oe:method:: operator--
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator--()

   .. oe:method:: operator-=
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator-=(int x)
         OEIterBase<A>& operator-=(unsigned int x)

   .. oe:method:: operator->
      :language: c++

      .. oe:api::

         A* operator->() const

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

   .. oe:method:: Copy

      .. oe:api::

         OEIterBase<A> *Copy() const

   .. oe:method:: Predicate

      .. oe:api::

         P &Predicate()

   .. oe:method:: ToFirst

      .. oe:api::

         OEIterBase<A> &ToFirst()

   .. oe:method:: ToLast

      .. oe:api::

         OEIterBase<A> &ToLast()



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEProtectedBuffer, ProtectedBuffer

.. attention::

   |CPPONLY|

.. _OESystem_OEProtectedBuffer:

.. oe:class:: OEProtectedBuffer

   .. oe:api::

      template<class BUFFER>
      class OEProtectedBuffer

   Thread-safe first-in-first-out (FIFO) queue that can have multiple
   producers and consumers. Meant to wrap around either a
   :ref:`OEBoundedBuffer <OESystem_OEBoundedBuffer>` or
   :ref:`OEUnboundedBuffer <OESystem_OEUnboundedBuffer>` object to provide thread-safe
   access to those buffers. The :ref:`OEBoundedBuffer <OESystem_OEBoundedBuffer>`
   queue should be used to control memory consumption, as the
   :oe:meth:`OESystem::OEProtectedBuffer::Put` operation will block,
   allowing the queue to empty first. The
   :ref:`OEUnboundedBuffer <OESystem_OEUnboundedBuffer>` queue will continue to
   consume memory with every
   :oe:meth:`OESystem::OEProtectedBuffer::Put` operation.

   .. oe:method:: Constructors

      .. oe:api::

         OEProtectedBuffer(oesize_t maxsize)
         OEProtectedBuffer(oesize_t maxsize, oesize_t threshold)

      Constructs a new ``BUFFER``, passing ``maxsize`` to the child
      buffer implementation. The ``threshold`` argument is a
      performance tuning parameter that determines how often
      :oe:meth:`OEPlatform::OECondition::Broadcast` is
      called. Broadcasting to other queue users too often can have
      negative performance implications as threads can be woken when
      there is not enough work in the queue to fill up their time
      quantum. Too infrequently means threads are left idle too long
      before being awoken with new to perform. The default
      ``threshold`` is half of ``maxsize``.

   .. oe:method:: Get

      .. oe:api::

         value_type Get()

      Return the next item from the queue in a thread-safe manner.

   .. oe:method:: Null

      .. oe:api::

         value_type Null()

      The value used to signal termination to the queue. Calling
      :oe:meth:`OESystem::OEProtectedBuffer::Put` with the value
      returned by the ``Null`` method signals that the queue is 'done'
      and should not accept anymore data. Subsequent
      :oe:meth:`OESystem::OEProtectedBuffer::Put` operations will fail
      and return
      ``false``. :oe:meth:`OESystem::OEProtectedBuffer::Get` will
      continue to return data until the queue is empty, and then start
      returning the result of the ``Null`` method as well. Note, this
      method returns the default constructed value for the
      ``value_type`` being stored in the queue, this is typically
      ``0`` or ``NULL`` for integral or pointer types respectively.

   .. oe:method:: Peek

      .. oe:api::

         value_type Peek()

      Returns the item that will be returned by the next call to
      :oe:meth:`OESystem::OEProtectedBuffer::Get`, but does not remove
      it from the buffer.

      .. warning::

         The above is not guaranteed if there are multiple consumers,
         i.e., other threads calling
         :oe:meth:`OESystem::OEProtectedBuffer::Get` interleaved with
         the thread calling
         :oe:meth:`OESystem::OEProtectedBuffer::Peek`.

   .. oe:method:: Put

      .. oe:api::

         bool Put(value_type obj)

      Place an item into the queue in a thread-safe manner.



.. oe:namespace:: OESystem
.. meta::
   :keywords: OERandom, Random

.. _OESystem_OERandom:

.. oe:class:: OERandom

   .. oe:api::

      class OERandom

   This class represents `OERandom`.

   The :ref:`OERandom <OESystem_OERandom>` class provides a portable pseudo-random number generator.

   .. oe:method:: Constructors

      .. oe:api::

         OERandom(bool timeseed = false)

      The 'timeseed' argument to the
      :ref:`OERandom <OESystem_OERandom>` constructor indicates whether the pseudo
      random number generator should initialize (or seed) its sequence from
      the system clock.

   .. oe:method:: GetSeed

      .. oe:api::

         unsigned int GetSeed() const

      Return the current state of the random number generator so that
      a new :ref:`OERandom <OESystem_OERandom>` object can be created and
      restarted from the given state. To restart a
      :ref:`OERandom <OESystem_OERandom>` object at a given location, pass
      this seed into :oe:meth:`OESystem::OERandom::Seed`.

      .. warning::

         The datatype of this method will likely change in a future
         release when a better random number generator will be
         implemented.

   .. oe:method:: NextFloat

      .. oe:api::

         float NextFloat()

      Returns the next pseudo-random floating point value in the range
      ``[0.0, 1.0)``. To convert this value into an integer range, for
      example ``10`` discrete values, use ``int i =
      (int)floor(10.0*r.NextFloat())``, which should return values in
      the range ``0`` to ``9`` inclusive.

   .. oe:method:: NextInt

      .. oe:api::

         int NextInt()

      Return the next random integer in this sequence of random
      numbers. The returned integer will never be negative.

   .. oe:method:: Seed

      .. oe:api::

         void Seed(unsigned int seed)

      Sets the pseudo random number generator seed to a given
      value. The :ref:`OERandom <OESystem_OERandom>` class uses a
      deterministic linear congruential class of pseudo random number
      generator (PRNG). Setting the seed to a specific value, causes
      the sequence of subsequent
      :oe:meth:`OESystem::OERandom::NextFloat` values to be identical
      on all platforms. This may be useful for testing stochastic
      algorithms on different architectures/operating systems.

   .. oe:method:: TimeSeed

      .. oe:api::

         void TimeSeed()

      Seeds this random number generator based upon the number of
      seconds since January 1, 1970, Coordinated Universal Time.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDataFlow

.. attention::

   |TWOLANGUAGE|

.. meta::
   :keywords: OERange

.. _OEDataFlow_OERange:

.. oe:class:: OERange

   .. oe:language:: c++

      .. oe:api::
   
         class OERange
   
      The :ref:`OERange <OEDataFlow_OERange>` class is used to represent
      numerical intervals that may be bounded or unbounded.

      .. oe:method:: Constructors
   
         .. oe:api::
   
            OERange()
   
         The default constructor initializes an empty (and invalid) range object.
   
         .. oe:api::
   
            OERange(const OERange& rhs)
   
         Copy constructor.
   
         .. oe:api::
   
            OERange(const std::optional<double>& low,
                    const std::optional<double>& high,
                    const std::string& incl = "[]")
   
         Constructs a range between *low* and *high*, with the provided inclusivity.
   
         low
           The low value of the range. For an unbounded interval,
           -std::numeric_limits<double>::infinity() can be specified.
   
         high
           The high value of the range. For an unbounded interval,
           std::numeric_limits<double>::infinity() can be specified.
   
         inclusivity
           Represents the inclusivity of *low* and *high* in the range. Allowed values are
   
           ============ ===============================
           inclusivity  Range value
           ============ ===============================
           "[]"         [low, high] or low <= x <= high
           "(]"         (low, high] or low < x <= high
           "[)"         [low, high) or low <= x < high
           "()"         (low, high) or low < x < high
           ============ ===============================
   
   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERange & operator=(const OERange &)

      Assignment operator.

   
      .. oe:method:: operator==
         :language: c++
   
         .. oe:api::

            bool operator==(const OERange& rhs) const

         Returns true if the lower, upper, and inclusivity values are all equal
         between the two OERange values.
   
      .. oe:method:: IsValid
   
         .. oe:api::

            bool IsValid() const

         Returns true if either of the low or high values is bounded.
   
   
      .. oe:method:: GetLow
   
         .. oe:api::

            double GetLow() const

         Returns the lower value of the range. This will return 
         -std::numeric_limits<double>::infinity() if the range is unbounded at
         the low end.
   
      .. oe:method:: GetHigh
   
         .. oe:api::

            double GetHigh() const

         Returns the upper value of the range. This will return 
         std::numeric_limits<double>::infinity() if the range is unbounded at
         the high end.
   
   
      .. oe:method:: GetInclusivityString
   
         .. oe:api::

            std::string GetInclusivityString() const

         Returns one of the four strings, "[]", "(]", "[)", or "()" representing
         the inclusivity of the range.
   
      .. oe:method:: IsUnboundedLow
   
         .. oe:api::

            bool IsUnboundedLow() const

         Returns true if this OERange object has -infinity as a lower value.
   
      .. oe:method:: IsUnboundedHigh
   
         .. oe:api::

            bool IsUnboundedHigh() const

         Returns true if this OERange object has infinity as an upper value.
   
   .. oe:language:: python

      .. oe:api::
   
         class OERange
   
      The :ref:`OERange <OEDataFlow_OERange>` class is used to represent
      numerical intervals that may be bounded or unbounded.
   
      .. ################################################################
         # Constructors
         ################################################################
   
      .. oe:method:: Constructors
   
         .. oe:api::
   
            OERange()
   
         The default constructor initializes an empty (and invalid) range object.
   
         .. oe:api::
   
            OERange(rhs: OERange)
   
         Copy constructor.
   
         .. oe:api::
   
            OERange(low: float, high: float, inclusivity: str = "[]")
   
         Constructs a range between *low* and *high*, with the provided inclusivity.
   
         low
           The low value of the range. For an unbounded interval,
           -math.inf can be specified.
   
         high
           The high value of the range. For an unbounded interval,
           math.inf can be specified.
   
         inclusivity
           Represents the inclusivity of *low* and *high* in the range. Allowed values are
   
           ============ ===============================
           inclusivity  Range value
           ============ ===============================
           "[]"         [low, high] or low <= x <= high
           "(]"         (low, high] or low < x <= high
           "[)"         [low, high) or low <= x < high
           "()"         (low, high) or low < x < high
           ============ ===============================
   
      .. oe:method:: __eq__
   
         .. oe:api::
   
            __eq__(rhs: OERange) -> bool
   
         Returns *True* if the lower, upper, and inclusivity values are all equal
         between the two OERange values.
   
      .. oe:method:: is_valid
   
         .. oe:api::
   
            is_valid() -> bool
   
         Returns *True* if either of the low or high values is bounded.
   
   
      .. oe:method:: get_low
   
         .. oe:api::
   
            get_low() -> float
   
         Returns the lower value of the range. This will return 
         -math.inf if the range is unbounded at the low end.
   
      .. oe:method:: get_high
   
         .. oe:api::
   
            get_high() -> float
   
         Returns the upper value of the range. This will return 
         math.inf if the range is unbounded at the high end.
   
   
      .. oe:method:: get_inclusivity_string
   
         .. oe:api::
   
            get_inclusivity_string() -> str
   
         Returns one of the four strings, "[]", "(]", "[)", or "()" representing
         the inclusivity of the range.
   
      .. oe:method:: is_unbounded_low
   
         .. oe:api::
   
            is_unbounded_low() -> bool
   
         Returns *True* if this OERange object has -infinity as a lower value.
   
      .. oe:method:: is_unbounded_high
   
         .. oe:api::
   
            is_unbounded_high() -> bool
   
         Returns *True* if this OERange object has infinity as an upper value.
   


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDataFlow

.. attention::

   |TWOLANGUAGE|

.. meta::
   :keywords: OERecord datarecord

.. _OEDataFlow_OERecord:

.. oe:class:: OERecord

   .. seealso::

      * :ref:`chapter_oerecord` chapter

   .. oe:language:: c++

      .. attention::

        |TWOLANGUAGE|

      .. oe:api::

         class OERecord

      The :ref:`OERecord <OEDataFlow_OERecord>` class is a data container for
      named, typed data.

      .. ################################################################
         Constructors

      .. oe:method:: Constructors

         .. oe:api::

            OERecord()

         The default constructor initializes the record object to an empty
         record with no fields or values.

         .. oe:api::

            OERecord(const OERecord& rhs)

         Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERecord & operator=(OERecord & &)
         OERecord & operator=(const OERecord & rhs)

      Assignment operator.

         ################################################################

      .. oe:method:: AddField

         .. oe:api::

            bool AddField(const OEFieldBase& field)

         Adds an empty field to the record.

      .. seealso::

         * :ref:`OEField <OEDataFlow_OEField>`

      .. oe:method:: Clear

         .. oe:api::

            void Clear()

         Removes all fields and data from the record, leaving it empty.

      .. oe:method:: ClearValue

         .. oe:api::

            bool ClearValue(const OEFieldBase& field)

         Removes the specified field's value from the record. The field
         will still exist, but will have no associated value. Returns false
         if no such field or value exist.

      .. oe:method:: DeleteField

         .. oe:api::

            bool DeleteField(const OEFieldBase& field)

         Removes the field and the associated data from the record.

      .. seealso::

         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` class

      .. oe:method:: GetField

         .. oe:api::

            template<typename T> OEField<T> GetField(const std::string& name,
                                                     bool includeMeta = true) const

         Returns the field with the specified name and type from the record.
         If no such field exists on the record, an empty (and unusable)
         OEField<T> object is returned.

         name
           The name of the field to retrieve from the record.

         includeMeta
           If this is true, the returned field will include the record's
           metadata for the field.

      .. seealso::

         * :oe:meth:`OEDataFlow::OERecord::HasField` method
         * :ref:`OEField <OEDataFlow_OEField>`

      .. oe:method:: GetFieldMeta

         .. oe:api::

            OEFieldMeta GetFieldMeta(const std::string& name) const

         Returns an :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` object containing
         the metadata from the named field. If the field does not exist, or the
         field exists but contains no metadata, an empty OEFieldMeta object is
         returned.

         name
           The name of the field to retrieve the metadata from.

      .. seealso::

         * :oe:meth:`OEDataFlow::OERecord::HasField` method
         * :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` class

      .. oe:method:: GetFields

         .. oe:api::

            std::vector<OEFieldBase> GetFields() const
            template <typename T> std::vector<OEField<T>> GetFields(const OEFieldType<T>& fieldType) const
            template <typename T> std::vector<OEVectorField<T>> GetFields(const OEVectorFieldType<T>& fieldType) const

         Returns the field objects from the record.

         fieldType
           This parameter specifies the type of the field to match.

      .. seealso::

         * :oe:meth:`OEDataFlow::OERecord::HasField` method
         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` class

      .. oe:method:: GetValue

         .. oe:api::

            template<typename T> T GetValue(const OEField<T>& field) const

         Retrieves the value from a field on the record. If no such value exists
         on the record, this will return a default-constructed T value.

         field
           The field from which the value is retrieved.

         .. oe:api::

            template<typename T> bool GetValue(T& ret, const OEField<T>& field) const

         Retrieves the value from a field on the record. If no such value exists
         on the record, this will return false and leave the value
         unchanged. This overload can avoid a copy of the T value.

         field
           The field from which the value is retrieved.

         value
           The returned value. If no such field exists on the record, this
           is left unchanged.

      .. seealso::

         * :ref:`OEField <OEDataFlow_OEField>`

      .. oe:method:: GetVectorField

         .. oe:api::

            template<typename T> OEVectorField<T> GetVectorField(const std::string& name,
                                                                 bool includeMeta = true) const

         Returns the vector field with the specified name and type from the
         record. If no such field exists on the record, an empty (and unusable)
         :ref:`OEVectorField <OEDataFlow_OEVectorField>` object is returned.

         name
           The name of the field to return.

         includeMeta
           When true, the returned field will include metadata from the record.

      .. seealso::

         * :oe:meth:`OEDataFlow::OERecord::HasField` method

      .. oe:method:: HasField

         .. oe:api::

            bool HasField(const OEFieldBase& field, bool matchMeta = false) const

         Tests for existence of a field on the record, and returns true if a
         field of the specified name and type exists, regardless of whether
         the field contains a value.

         field
           The field to test for on the record.

         matchMeta
           When true, all metadata on the *field* parameter must be present on
           the record's field to return true.

      .. seealso::

         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>`

      .. oe:method:: HasValue

         .. oe:api::

            bool HasValue(const OEFieldBase& field) const

         Tests for presence of a value on the record for the specified field,
         and returns true if such a value exists. The method will return false
         if no matching value can be found or if the specified field does not
         exist on the record.

         field
           The field to check for a value.

      .. seealso::

         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>`

      .. oe:method:: IsEmpty

         .. oe:api::

            bool IsEmpty() const

        Returns true if the record contains no fields or data.

      .. oe:method:: IsNA

         .. oe:api::

            bool IsNA(const OEFieldBase& field) const
            bool IsNA(const std::string& fieldName) const

        Returns true if the specified field contains a null value. Note that this
        is different from the field not containing a value at all.

        field
          The field to test.

        fieldName
          The name of the field to test.

      .. oe:method:: SetValue

         .. oe:api::

            template<typename T, typename U> bool SetValue(const OEField<T>& field,
                                                           const U& value)
            template<typename T, typename U> bool SetValue(const OEVectorField<T>& field,
                                                           const std::vector<U>& value)

        Sets the specified value on the record, and returns true if successful.

        field
          The field to set the value for. If the field exists, its value will
          be overwritten. If the field doesn't exist on the record, it will
          be added.

        value
          The value to be added to the record.

      .. seealso::

         * :ref:`OEField <OEDataFlow_OEField>`

      .. oe:method:: CheckField

         .. oe:api::

            unsigned int CheckField(const OEFieldBase& field,
                                    bool matchMeta = false) const

         Tests the existence and state of a field on a record, and returns a
         value from the :oe:constns:`OEDataFlow::OERecordReturnCode`
         namespace.

         field
           The field to test.

         matchMeta
           If this argument is true, the test for a matching field will include
           the *field* parameter's metadata.

      .. seealso::

         * :oe:meth:`OEDataFlow::OERecord::HasField` method
         * :oe:meth:`OEDataFlow::OERecord::HasValue` method
         * :ref:`OEField <OEDataFlow_OEField>`

   .. oe:language:: python

      .. oe:api::

         class OERecord

      The :ref:`OERecord <OEDataFlow_OERecord>` class is a data container for
      named, typed data.

      .. ################################################################
         # Constructors
         ################################################################

      .. oe:method:: Constructors

         .. oe:api::

            OERecord()

         The default constructor initializes the record object to an empty
         record with no fields or values.

         .. oe:api::

            OERecord(rhs: OERecord)

         Copy constructor.

      .. oe:method:: add_field

         .. oe:api::

            add_field(field: OEFieldBase) -> bool

         Adds an empty field to the record and returns *True* if
         successful.

      .. seealso::

         * :ref:`OEField <OEDataFlow_OEField>`

      .. oe:method:: clear

         .. oe:api::

            clear() -> None

         Removes all fields and data from the record, leaving it empty.

      .. oe:method:: clear_value

         .. oe:api::

            clear_value(field: OEFieldBase) -> bool

         Removes the specified field's value from the record. The field
         will still exist, but will have no associated value. Returns *False*
         if no such field or value exist.

      .. oe:method:: delete_field

         .. oe:api::

            delete_field(field: OEFieldBase) -> bool

         Removes the field and the associated data from the record.

      .. seealso::

         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>`

      .. oe:method:: get_field

         .. oe:api::

            get_field(name: str, includeMeta: bool = True) -> object

         Returns the field with the specified name and type from the record.
         If no such field exists on the record, an empty (and unusable)
         field object is returned.

         name
           The name of the field to retrieve from the record.

         includeMeta
           If this is *True*, the returned field will include the record's
           metadata for the field.

      .. seealso::

         * :oe:meth:`OEDataFlow::OERecord::has_field` method
         * :ref:`OEField <OEDataFlow_OEField>`

      .. oe:method:: get_field_meta

         .. oe:api::

            get_field_meta(name: str) -> OEFieldMeta

         Returns an :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` object containing
         the metadata from the named field. If the field does not exist, or the
         field exists but contains no metadata, an empty OEFieldMeta object is
         returned.

         name
           The name of the field to retrieve the metadata from.

      .. seealso::

         * :oe:meth:`OEDataFlow::OERecord::has_field` method
         * :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` class

      .. oe:method:: get_fields

         .. oe:api::

            get_fields() -> List[object]
            get_fields(fieldType: OEFieldTypeHandler) -> List[object]

         Returns the field objects from the record.

         fieldType
           This parameter specifies the type of the field to match.

      .. seealso::

         * :oe:meth:`OEDataFlow::OERecord::has_field` method
         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` class

      .. oe:method:: get_value

         .. oe:api::

            get_value(field: OEField) -> Any

         Retrieves the value from a field on the record. If no such value exists
         on the record, this will return *None*.

         field
           The field from which the value is retrieved.

      .. seealso::

         * :ref:`OEField <OEDataFlow_OEField>`

      .. oe:method:: has_field

         .. oe:api::

            has_field(field: OEField, matchMeta: bool = false) -> bool

         Tests for existence of a field on the record, and returns *True* if a
         field of the specified name and type exists, regardless of whether
         the field contains a value.

         field
           The field to test for on the record.

         matchMeta
           When true, all metadata on the *field* parameter must be present on
           the record's field to return true.

      .. seealso::

         * :ref:`OEField <OEDataFlow_OEField>`

      .. oe:method:: has_value

         .. oe:api::

            has_value(field: OEFieldBase) -> bool

         Tests for presence of a value on the record for the specified field,
         and returns true if such a value exists. The method will return
         *false* if no matching value can be found or if the specified field
         does not exist on the record.

         field
           The field to check for a value.

      .. seealso::

         * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>` class

      .. oe:method:: is_empty

         .. oe:api::

            is_empty() -> bool

        Returns *True* if the record contains no fields or data.

      .. oe:method:: is_na

         .. oe:api::

            is_na(field: OEFieldBase) -> bool
            is_na(fieldName: str) -> bool

        Returns *True* if the specified field contains a null value. Note that
        this is different from the field not containing a value at all.

        field
          The field to test.

        fieldName
          The name of the field to test.

      .. oe:method:: set_value

         .. oe:api::

            set_value(field: OEField, value: Any) -> bool

        Sets the specified value on the record, and returns *True* if successful.

        field
          The field to set the value for. If the field exists, its value will
          be overwritten. If the field doesn't exist on the record, it will
          be added.

        value
          The value to be added to the record.

      .. seealso::

         * :ref:`OEField <OEDataFlow_OEField>`

      .. oe:method:: check_field

         .. oe:api::

            check_field(const OEFieldBase &field, bool matchMeta = false) -> int

         Tests the existence and state of a field on a record, and returns a
         value from the :oe:constns:`OEDataFlow::OERecordReturnCode`
         namespace.

         field
           The field to test.

         matchMeta
           If this argument is True, the test for a matching field will include
           the *field* parameter's metadata.

      .. seealso::

         * :oe:meth:`OEDataFlow::OERecord::has_field` method
         * :oe:meth:`OEDataFlow::OERecord::has_value` method
         * :ref:`OEField <OEDataFlow_OEField>`


.. oe:namespace:: OESystem

.. meta::
   :keywords: OERole, Role

.. _OESystem_OERole:

.. oe:class:: OERole

   .. oe:api::

      class OERole

   This class represents `OERole`, an object that can be used
   in a some classification scheme to define a category or role.
   Each `OERole` is defined by a `role name` string.

   .. oe:source:: RoleSet.py
      :language: python
      :noindent:
      :frag:     SNIPPET-CREATE-ROLE-OBJECT

   .. oe:source:: RoleSet.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-CREATE-ROLE-OBJECT

   Objects inherited from :ref:`OERoleSet <OESystem_OERoleSet>` can
   have :oe:cls:`OERole<OESystem::OERole>` objects added
   to them as a way of marking them for particular uses.

   .. oe:source:: RoleSet.py
      :language: python
      :noindent:
      :frag:     SNIPPET-ADD-ROLE-OBJECT

   .. oe:source:: RoleSet.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-ADD-ROLE-OBJECT

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERole()
            OERole(const OERole& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OERole() -> OERole
            OERole(rhs: OERole) -> OERole

      Default and copy constructors.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERole(const std::string& name)

      .. oe:language:: python

         .. oe:api:: python

            OERole(name: str) -> OERole

      Standard constructor. It is recommended that classification schemes
      use hierarchical naming systems, such as ``oebio:component:cofactor``,
      so that they will not conflict with one another when multiple schemes
      are mixed together.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERole &operator=(const OERole &rhs)

      Assignment operator.

   .. oe:method:: operator<
      :language: c++

      .. oe:api::

         bool operator<(const OERole &rhs) const

      Allows :oe:cls:`OERole<OESystem::OERole>` objects to be ordered.

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OERole &rhs) const

      Allows :oe:cls:`OERole<OESystem::OERole>` objects to be compared for equivalence.

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the character string representing the name of the role.
      An empty character string is returned for a default :oe:cls:`OERole<OESystem::OERole>`
      or one constructed with a random unsigned integer.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OERoleSet, RoleSet

.. _OESystem_OERoleSet:

.. oe:class:: OERoleSet

   .. oe:api::

      class OERoleSet

   This class represents `OERoleSet`, a parent class for objects that
   need to store :ref:`OERole <OESystem_OERole>` objects.

   An :oe:cls:`OERole<OESystem::OERole>` is an object that helps
   define a classification (naming) scheme
   to represent a category or functional role.

   .. oe:source:: RoleSet.py
      :language: python
      :noindent:
      :frag:     SNIPPET-CREATE-ROLE-OBJECT

   .. oe:source:: RoleSet.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-CREATE-ROLE-OBJECT

   Objects derived from :ref:`OERoleSet <OESystem_OERoleSet>` can
   have :oe:cls:`OERole<OESystem::OERole>` objects added
   to them as a way of marking them for particular uses.

   .. oe:source:: RoleSet.py
      :language: python
      :noindent:
      :frag:     SNIPPET-ADD-ROLE-OBJECT

   .. oe:source:: RoleSet.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-ADD-ROLE-OBJECT

   The following classes derive from this class:
    * :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`
    * :ref:`OEMatch <OEChem_OEMatch>`
    * :ref:`OEMatchBase <OEChem_OEMatchBase>`
   
   It is possible to test if an :oe:cls:`OERole<OESystem::OERole>`
   has been added using the :oe:meth:`HasRole<OESystem::OERoleSet::HasRole>`
   method, or with the :ref:`OEHasRole <OESystem_OEHasRole>` predicate.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERoleSet & operator=(const OERoleSet & rhs)

      Assignment operator.

   .. oe:method:: AddRole

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddRole(const OERole& role)

      .. oe:language:: python

         .. oe:api:: python

            AddRole(role: OERole) -> bool

      Add the specified :oe:cls:`OERole<OESystem::OERole>` to
      this :oe:cls:`OERoleSet<OESystem::OERoleSet>`.
      Returns ``true`` if successful.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddRole(const std::string& name)

      .. oe:language:: python

         .. oe:api:: python

            AddRole(name: str) -> bool

      Convenience method for adding a
      :oe:cls:`OERole<OESystem::OERole>` by name.

      .. oe:source:: RoleSet.py
         :language: python
         :noindent:
         :frag:     SNIPPET-ADD-ROLE-STRING

      .. oe:source:: RoleSet.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-ADD-ROLE-STRING

   .. oe:method:: ClearRoles

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearRoles()

      .. oe:language:: python

         .. oe:api:: python

            ClearRoles() -> None

      Delete all the :oe:cls:`OERole<OESystem::OERole>` objects from
      this :oe:cls:`OERoleSet<OESystem::OERoleSet>`.

   .. oe:method:: DeleteRole

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteRole(const OERole& role)
            bool DeleteRole(const std::string& name)

      .. oe:language:: python

         .. oe:api:: python

            DeleteRole(role: OERole) -> bool
            DeleteRole(name: str) -> bool

      Delete the specified :oe:cls:`OERole<OESystem::OERole>` from
      this :oe:cls:`OERoleSet<OESystem::OERoleSet>`.
      Returns ``true`` if successful.

      .. oe:source:: RoleSet.py
         :language: python
         :noindent:
         :frag:     SNIPPET-DELETE-ROLE

      .. oe:source:: RoleSet.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-DELETE-ROLE

   .. oe:method:: GetRoles

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIterBase<const OERole>* GetRoles() const

      .. oe:language:: python

         .. oe:api:: python

            GetRoles() -> Iterable[OERole]

      Returns an iterator of every :oe:cls:`OERole<OESystem::OERole>` object
      in this :oe:cls:`OERoleSet<OESystem::OERoleSet>`.

      .. oe:source:: RoleSet.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GET-ALL-ROLES

      .. oe:source:: RoleSet.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GET-ALL-ROLES

   .. oe:method:: HasRole

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasRole(const OERole& role) const

      .. oe:language:: python

         .. oe:api:: python

            HasRole(role: OERole) -> bool

      Returns ``true`` if the :oe:cls:`OERoleSet<OESystem::OERoleSet>` contains
      the specified role.

      .. oe:source:: RoleSet.py
         :language: python
         :noindent:
         :frag:     SNIPPET-HAS-ROLE-OBJECT

      .. oe:source:: RoleSet.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-HAS-ROLE-OBJECT

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasRole(const std::string& name) const

      .. oe:language:: python

         .. oe:api:: python

            HasRole(name: str) -> bool

      Convenience method for testing membership with a string.

      .. oe:source:: RoleSet.py
         :language: python
         :noindent:
         :frag:     SNIPPET-HAS-ROLE-STRING

      .. oe:source:: RoleSet.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-HAS-ROLE-STRING

   .. oe:method:: NumRoles

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumRoles() const

      .. oe:language:: python

         .. oe:api:: python

            NumRoles() -> int

      Returns the current number of :oe:cls:`OERole<OESystem::OERole>` objects
      in this :oe:cls:`OERoleSet<OESystem::OERoleSet>`.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OERoles, Roles

.. _OESystem_OERoles:

.. oe:class:: OERoles

   .. oe:api::

      class OERoles : public OESystem::OERoleSet

   The :ref:`OERoles <OESystem_OERoles>` class is a concrete instance of the
   :ref:`OERoleSet <OESystem_OERoleSet>` abstract base class.
   It is designed to be a very simple set
   container for :ref:`OERole <OESystem_OERole>` objects.
   Other containers with more specific purposes include
   :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`, :ref:`OEMatch <OEChem_OEMatch>`,
   and :ref:`OEMatchBase <OEChem_OEMatchBase>`.

   The following methods are publicly inherited from :ref:`OERoleSet <OESystem_OERoleSet>`:
   
   ====================================================== ====================================================== ====================================================== 
   :oe:meth:`AddRole<OESystem::OERoleSet::AddRole>`       :oe:meth:`DeleteRole<OESystem::OERoleSet::DeleteRole>` :oe:meth:`HasRole<OESystem::OERoleSet::HasRole>`
   :oe:meth:`ClearRoles<OESystem::OERoleSet::ClearRoles>` :oe:meth:`GetRoles<OESystem::OERoleSet::GetRoles>`     :oe:meth:`NumRoles<OESystem::OERoleSet::NumRoles>`
   ====================================================== ====================================================== ====================================================== 
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERoles()

      .. oe:language:: python

         .. oe:api:: python

            OERoles() -> OERoles

      Default constructor that generates an empty set.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERoles(const OESystem::OERoleSet& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OERoles(rhs: OERoleSet) -> OERoles

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERoles &operator=(const OESystem::OERoleSet &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERoles* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OERoles

      Deep copy constructor that returns a copy of the object.
      The memory for the returned object
      is dynamically allocated and owned by the caller.

      .. oe:language:: c++ 

         To avoid a memory leak in C++,
         the returned pointer should be
         stored in a variable of the
         :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` template class
         or deallocated with the ``delete`` operator.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEScalarGrid, ScalarGrid

.. _OESystem_OEScalarGrid:

.. oe:class:: OEScalarGrid

   .. oe:api::

      class OEScalarGrid : public OEGrid<float>

   This class represents `OEScalarGrid`.

   An :ref:`OEScalarGrid <OESystem_OEScalarGrid>` represents a cubic grid with regular intervals in Cartesian space.

   The following methods are publicly inherited from :ref:`OEGrid <OESystem_OEGrid>`:

   ===================================================== ==================================================== ====================================================
   :oe:meth:`operator=<OESystem::OEGrid::operator=>`     :oe:meth:`SetAll<OESystem::OEGrid::SetAll>`          :oe:meth:`SetXMid<OESystem::OEGrid::SetXMid>`       
   :oe:meth:`Clear<OESystem::OEGrid::Clear>`             :oe:meth:`SetDim<OESystem::OEGrid::SetDim>`          :oe:meth:`SetYDim<OESystem::OEGrid::SetYDim>`       
   :oe:meth:`CreateCopy<OESystem::OEGrid::CreateCopy>`   :oe:meth:`SetMid<OESystem::OEGrid::SetMid>`          :oe:meth:`SetYMid<OESystem::OEGrid::SetYMid>`       
   :oe:meth:`GetDataType<OESystem::OEGrid::GetDataType>` :oe:meth:`SetSpacing<OESystem::OEGrid::SetSpacing>`  :oe:meth:`SetZDim<OESystem::OEGrid::SetZDim>`       
   :oe:meth:`IsDataType<OESystem::OEGrid::IsDataType>`   :oe:meth:`SetXDim<OESystem::OEGrid::SetXDim>`        :oe:meth:`SetZMid<OESystem::OEGrid::SetZMid>`       
   ===================================================== ==================================================== ====================================================

   The following methods are publicly inherited from :ref:`OEFixedGrid <OESystem_OEFixedGrid>`:

   ========================================================= ========================================================== =========================================================
   :oe:meth:`operator()<OESystem::OEFixedGrid::operator()>`  :oe:meth:`GetDataType<OESystem::OEFixedGrid::GetDataType>` :oe:meth:`SetValues<OESystem::OEFixedGrid::SetValues>`   
   :oe:meth:`operator[]<OESystem::OEFixedGrid::operator[]>`  :oe:meth:`GetValues<OESystem::OEFixedGrid::GetValues>`                                                              
   :oe:meth:`CreateCopy<OESystem::OEFixedGrid::CreateCopy>`  :oe:meth:`IsDataType<OESystem::OEFixedGrid::IsDataType>`                                                            
   ========================================================= ========================================================== =========================================================

   The following methods are publicly inherited from :ref:`OEGridBase <OESystem_OEGridBase>`:

   ============================================================================= ============================================================================ =============================================================================
   :oe:meth:`Clear<OESystem::OEGridBase::Clear>`                                 :oe:meth:`GetXMid<OESystem::OEGridBase::GetXMid>`                            :oe:meth:`GetZMin<OESystem::OEGridBase::GetZMin>`                            
   :oe:meth:`CreateCopy<OESystem::OEGridBase::CreateCopy>`                       :oe:meth:`GetXMin<OESystem::OEGridBase::GetXMin>`                            :oe:meth:`GridIdxToElement<OESystem::OEGridBase::GridIdxToElement>`          
   :oe:meth:`ElementToGridIdx<OESystem::OEGridBase::ElementToGridIdx>`           :oe:meth:`GetY<OESystem::OEGridBase::GetY>`                                  :oe:meth:`GridIdxToSpatialCoord<OESystem::OEGridBase::GridIdxToSpatialCoord>`
   :oe:meth:`ElementToSpatialCoord<OESystem::OEGridBase::ElementToSpatialCoord>` :oe:meth:`GetYDim<OESystem::OEGridBase::GetYDim>`                            :oe:meth:`IsDataType<OESystem::OEGridBase::IsDataType>`                      
   :oe:meth:`GetDataType<OESystem::OEGridBase::GetDataType>`                     :oe:meth:`GetYIdx<OESystem::OEGridBase::GetYIdx>`                            :oe:meth:`IsInGrid<OESystem::OEGridBase::IsInGrid>`                          
   :oe:meth:`GetDim<OESystem::OEGridBase::GetDim>`                               :oe:meth:`GetYInc<OESystem::OEGridBase::GetYInc>`                            :oe:meth:`IsSpacingSet<OESystem::OEGridBase::IsSpacingSet>`                  
   :oe:meth:`GetMid<OESystem::OEGridBase::GetMid>`                               :oe:meth:`GetYMax<OESystem::OEGridBase::GetYMax>`                            :oe:meth:`IsTitleSet<OESystem::OEGridBase::IsTitleSet>`                      
   :oe:meth:`GetSize<OESystem::OEGridBase::GetSize>`                             :oe:meth:`GetYMid<OESystem::OEGridBase::GetYMid>`                            :oe:meth:`IsXMidSet<OESystem::OEGridBase::IsXMidSet>`                        
   :oe:meth:`GetSpacing<OESystem::OEGridBase::GetSpacing>`                       :oe:meth:`GetYMin<OESystem::OEGridBase::GetYMin>`                            :oe:meth:`IsYMidSet<OESystem::OEGridBase::IsYMidSet>`                        
   :oe:meth:`GetTitle<OESystem::OEGridBase::GetTitle>`                           :oe:meth:`GetZ<OESystem::OEGridBase::GetZ>`                                  :oe:meth:`IsZMidSet<OESystem::OEGridBase::IsZMidSet>`                        
   :oe:meth:`GetX<OESystem::OEGridBase::GetX>`                                   :oe:meth:`GetZDim<OESystem::OEGridBase::GetZDim>`                            :oe:meth:`SetTitle<OESystem::OEGridBase::SetTitle>`                          
   :oe:meth:`GetXDim<OESystem::OEGridBase::GetXDim>`                             :oe:meth:`GetZIdx<OESystem::OEGridBase::GetZIdx>`                            :oe:meth:`SpatialCoordToElement<OESystem::OEGridBase::SpatialCoordToElement>`
   :oe:meth:`GetXIdx<OESystem::OEGridBase::GetXIdx>`                             :oe:meth:`GetZInc<OESystem::OEGridBase::GetZInc>`                            :oe:meth:`SpatialCoordToGridIdx<OESystem::OEGridBase::SpatialCoordToGridIdx>`
   :oe:meth:`GetXInc<OESystem::OEGridBase::GetXInc>`                             :oe:meth:`GetZMax<OESystem::OEGridBase::GetZMax>`                                                                                                         
   :oe:meth:`GetXMax<OESystem::OEGridBase::GetXMax>`                             :oe:meth:`GetZMid<OESystem::OEGridBase::GetZMid>`                                                                                                         
   ============================================================================= ============================================================================ =============================================================================

   The following methods are publicly inherited from :ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>`:

   ================================================================== ================================================================== ===================================================================
   :oe:meth:`Clear<OESystem::OEGridAbstractBase::Clear>`              :oe:meth:`GetTitle<OESystem::OEGridAbstractBase::GetTitle>`        :oe:meth:`GetZMid<OESystem::OEGridAbstractBase::GetZMid>`          
   :oe:meth:`GetDataType<OESystem::OEGridAbstractBase::GetDataType>`  :oe:meth:`GetXDim<OESystem::OEGridAbstractBase::GetXDim>`          :oe:meth:`IsDataType<OESystem::OEGridAbstractBase::IsDataType>`    
   :oe:meth:`GetDim<OESystem::OEGridAbstractBase::GetDim>`            :oe:meth:`GetXMid<OESystem::OEGridAbstractBase::GetXMid>`          :oe:meth:`IsSpacingSet<OESystem::OEGridAbstractBase::IsSpacingSet>`
   :oe:meth:`GetMid<OESystem::OEGridAbstractBase::GetMid>`            :oe:meth:`GetYDim<OESystem::OEGridAbstractBase::GetYDim>`          :oe:meth:`SetTitle<OESystem::OEGridAbstractBase::SetTitle>`        
   :oe:meth:`GetSize<OESystem::OEGridAbstractBase::GetSize>`          :oe:meth:`GetYMid<OESystem::OEGridAbstractBase::GetYMid>`                                                                             
   :oe:meth:`GetSpacing<OESystem::OEGridAbstractBase::GetSpacing>`    :oe:meth:`GetZDim<OESystem::OEGridAbstractBase::GetZDim>`                                                                             
   ================================================================== ================================================================== ===================================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEScalarGrid()

      .. oe:language:: python

         .. oe:api:: python

            OEScalarGrid() -> OEScalarGrid

      Creates a one point :ref:`OEScalarGrid <OESystem_OEScalarGrid>` grid object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEScalarGrid(const OEScalarGrid& rhs)
            OEScalarGrid(const OEFixedGrid<float>& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEScalarGrid(rhs: OEScalarGrid) -> OEScalarGrid
            OEScalarGrid(rhs: OEFixedFloatGrid) -> OEScalarGrid

      Creates a :ref:`OEScalarGrid <OESystem_OEScalarGrid>` object and copies the entire contents of the 'rhs' grid.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEScalarGrid(float minmax[6], float spacing, const char* title = "")
            OEScalarGrid(double minmax[6], double spacing,
                         const char* title = "")

      .. oe:language:: python

         .. oe:api:: python

            OEScalarGrid(minmax: OEFloatArray, spacing: float, title: str = "") -> OEScalarGrid
            OEScalarGrid(minmax: OEDoubleArray, spacing: float, title: str = "") -> OEScalarGrid

      Creates a :ref:`OEScalarGrid <OESystem_OEScalarGrid>` object from a minimum bounding box ('minmax').
      The size of each length between grid points is determined by the 'spacing' parameter. 
      The 'title' parameter is provided as a convenience for setting the title upon construction. 
      It can later be retrieved with the :oe:meth:`OESystem::OEGridBase::GetTitle` method.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEScalarGrid(int xdim, int ydim, int zdim, float midx, float midy,
                         float midz, float spacing, std::string title = "",
                         float* dataptr = 0)

      .. oe:language:: python

         .. oe:api:: python

            OEScalarGrid(xdim: int, ydim: int, zdim: int, midx: float,
                         midy: float, midz: float, spacing: float,
                         title: str = "", dataptr: OEFloatArray = None) -> OEScalarGrid

      Creates and initializes a :ref:`OEScalarGrid <OESystem_OEScalarGrid>` object. The
      grid data can be copied from the optional parameter
      'dataptr'. The pointer should be an array of size
      ``xdim*ydim*zdim*sizeof(float)``.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEScalarGrid& operator=(const OEScalarGrid& rhs)
         OEScalarGrid& operator=(const OEFixedGrid<float>& rhs)

      Copies the contents of 'rhs' grid.

      Assignment operator.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Reallocates memory for the grid, effectively clearing all the grid values. 
      Calls through to :oe:meth:`OESystem::OEBase::Clear`.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEScalarGrid

      Makes a copy of the grid instance.

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

      Returns the data type of the grid.

   .. oe:method:: GetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetType() const

      .. oe:language:: python

         .. oe:api:: python

            GetType() -> int

      Returns the data type tag for the grid.

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void* type) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(type: void) -> bool

      Returns whether type is the same as the instance this method is called on
      (*i.e.* :ref:`OEScalarGrid <OESystem_OEScalarGrid>`).

   .. oe:method:: SetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetType(unsigned int t)

      .. oe:language:: python

         .. oe:api:: python

            SetType(t: int) -> bool

      Sets the tag associated with this grid.



.. oe:namespace:: OESystem

.. meta::
   :keywords: OESharedPtr, SharedPtr

.. _OESystem_OESharedPtr:

.. oe:class:: OESharedPtr

   .. oe:api::

      template<class T>
      class OESharedPtr

   .. warning::

      This class has been deprecated. Use ``std::shared_ptr`` instead.
      C++ only class. This class is not visible in any other languages.

   This class is a classic `smart pointer
   <http://en.wikipedia.org/wiki/Smart_pointer>`_ used for
   automatically managing the dynamic memory allocated for the object
   ``T``. Explicitly calling ``delete`` is generally frowned upon
   in modern C++ due to the propensity of explicit ``delete`` leading
   to resource leaks and crashes. Deleting memory should be handled
   more automatically by mechanisms like
   :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` and :ref:`OESharedPtr <OESystem_OESharedPtr>`.

   .. hint::

      One of the most important differences to understand between
      :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` and
      :ref:`OESharedPtr <OESystem_OESharedPtr>` is that
      :ref:`OESharedPtr <OESystem_OESharedPtr>` is always usable inside STL
      containers like ``std::vector<OESharedPtr<T> >``.
      :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` can only be used inside STL
      containers if the compiler supports C++11 move
      constructors. Once all common compilers support C++11, the use
      of :ref:`OESharedPtr <OESystem_OESharedPtr>` should be replaced with
      :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` in many cases.

   :ref:`OESharedPtr <OESystem_OESharedPtr>` is designed to mimic the standard
   C++ `std::shared_ptr
   <http://en.cppreference.com/w/cpp/memory/shared_ptr>`_ in
   functionality with some important differences.

   The first and most obvious difference is that
   :ref:`OESharedPtr <OESystem_OESharedPtr>` will compile and work in all
   compilers *OpenEye* supports without having to juggle whether it is
   coming from the ``std`` or ``std::tr1`` namespaces.

   The second key difference between :ref:`OESharedPtr <OESystem_OESharedPtr>`
   and `std::shared_ptr
   <http://en.cppreference.com/w/cpp/memory/shared_ptr>`_ is whether
   ``const`` is maintained when accessing the object being pointed
   to. By default, in order to maintain compatibility with C, C++
   allows non-const access to const pointers. By extension, this same
   rule applied to C++ smart pointers. This leads to very surprising
   behavior like the following:

   .. code-block:: c++

      struct Foo
      {
        int _x;
        void AlterFoo() { _x = 1; }
      };

      struct BarOwnsFoo
      {
        Foo *_foo;
        void AConstMethod() const { _foo->AlterFoo(); }
      };

   Even though ``AConstMethod`` is ``const``, it isn't actually
   logically const. The internals of the class are changing. This
   behavior may seem benign at first, but it has vast implications in
   a library seeking to be thread-safe. The ``const`` on a method
   implies that the method is thread-safe, especially in C++11. In
   order to enforce thread-safety at runtime,
   :ref:`OESharedPtr <OESystem_OESharedPtr>` maintains the "const'ness" of its
   accessor methods. Therefore, the following is actually a compile
   error:

   .. code-block:: c++

      struct Foo
      {
        int _x;
        void AlterFoo() { _x = 1; }
      };

      struct BarOwnsFoo
      {
        OESharedPtr<Foo> _foo;
        void AConstMethod() const { _foo->AlterFoo(); }
      };

   Catching thread-safety problems very early, at compilation, is
   highly desirable for *OpenEye*. Hence the reason to differ from the
   standard smart pointer semantics in this way.

   .. oe:method:: Constructors

      .. oe:api::

         OESharedPtr()
         OESharedPtr(T* ptr)

      Default constructors the pointer to ``NULL``. Or constructs a
      smart pointer around the pointer ``ptr``.

   .. oe:method:: operator*
      :language: c++

      .. oe:api::

         T& operator*()
         const T& operator*() const

      Dereference the smart pointer and return a reference to the held
      object while maintaining ``const`` correctness. Note,
      dereferencing a ``NULL`` pointer is undefined.

   .. oe:method:: operator->
      :language: c++

      .. oe:api::

         T* operator->()
         const T* operator->() const

      Access the pointer held by this smart pointer while maintaining
      ``const`` correctness.

   .. oe:method:: operator T *
      :language: c++

      .. oe:api::

         operator T *()

      Implicit conversion to a pointer to ``T``.

   .. oe:method:: operator const T *
      :language: c++

      .. oe:api::

         operator const T *() const

      Implicit conversion to a pointer to ``const T``.

   .. oe:method:: Get

      .. oe:api::

         T* Get()
         const T* Get() const

      Access the pointer held by this smart pointer while maintaining
      ``const`` correctness.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OESkewGrid, SkewGrid

.. _OESystem_OESkewGrid:

.. oe:class:: OESkewGrid

   .. oe:api::

      class OESkewGrid : public OEGridAbstractBase

   This class represents `OESkewGrid`.

   The following methods are publicly inherited from :ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>`:

   ================================================================== ================================================================== ===================================================================
   :oe:meth:`Clear<OESystem::OEGridAbstractBase::Clear>`              :oe:meth:`GetTitle<OESystem::OEGridAbstractBase::GetTitle>`        :oe:meth:`GetZMid<OESystem::OEGridAbstractBase::GetZMid>`          
   :oe:meth:`GetDataType<OESystem::OEGridAbstractBase::GetDataType>`  :oe:meth:`GetXDim<OESystem::OEGridAbstractBase::GetXDim>`          :oe:meth:`IsDataType<OESystem::OEGridAbstractBase::IsDataType>`    
   :oe:meth:`GetDim<OESystem::OEGridAbstractBase::GetDim>`            :oe:meth:`GetXMid<OESystem::OEGridAbstractBase::GetXMid>`          :oe:meth:`IsSpacingSet<OESystem::OEGridAbstractBase::IsSpacingSet>`
   :oe:meth:`GetMid<OESystem::OEGridAbstractBase::GetMid>`            :oe:meth:`GetYDim<OESystem::OEGridAbstractBase::GetYDim>`          :oe:meth:`SetTitle<OESystem::OEGridAbstractBase::SetTitle>`        
   :oe:meth:`GetSize<OESystem::OEGridAbstractBase::GetSize>`          :oe:meth:`GetYMid<OESystem::OEGridAbstractBase::GetYMid>`                                                                             
   :oe:meth:`GetSpacing<OESystem::OEGridAbstractBase::GetSpacing>`    :oe:meth:`GetZDim<OESystem::OEGridAbstractBase::GetZDim>`                                                                             
   ================================================================== ================================================================== ===================================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESkewGrid()

      .. oe:language:: python

         .. oe:api:: python

            OESkewGrid() -> OESkewGrid

      Creates a one point :ref:`OESkewGrid <OESystem_OESkewGrid>` grid object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESkewGrid(const OEScalarGrid& rhs)
            OESkewGrid(const OESkewGrid& rhs)
            OESkewGrid(const OESkewGridImpl& rhs)
            OESkewGrid(const OEFixedGrid<float>& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESkewGrid(rhs: OESkewGrid) -> OESkewGrid
            OESkewGrid(f: OESkewGridImpl) -> OESkewGrid
            OESkewGrid(g: OEScalarGrid) -> OESkewGrid
            OESkewGrid(f: OEFixedFloatGrid) -> OESkewGrid

      Creates a :ref:`OESkewGrid <OESystem_OESkewGrid>` object and copies the entire contents of the 'rhs'.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESkewGrid& operator=(const OESkewGrid& rhs)
         OESkewGrid& operator=(const OEScalarGrid& rhs)
         OESkewGrid& operator=(const OESkewGridImpl& rhs)
         OESkewGrid& operator=(const OEFixedGrid<float>& rhs)

      Copies the contents of 'rhs'.

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

   .. oe:method:: AsRegularGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFixedGrid<float>& AsRegularGrid() const

      .. oe:language:: python

         .. oe:api:: python

            AsRegularGrid() -> OEFixedFloatGrid

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Reallocates memory for the grid, effectively clearing all the grid values. 
      Calls through to :oe:meth:`OESystem::OEBase::Clear`.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESkewGrid

      Makes a copy of the grid instance.

   .. oe:method:: ElementToGridIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ElementToGridIdx(unsigned int el, unsigned int& ix,
                                  unsigned int& iy, unsigned int& iz) const

      .. oe:language:: python

         .. oe:api:: python

            ElementToGridIdx(el: int) -> Tuple[int, int, int]

      The element 'el' is the one dimensional index into the grid points. 
      This function converts this one dimensional index into the three dimensional 
      indices (ix, iy, iz) for the associated grid point. 
      Returns ``false`` if 'el' is outside the array bounds.

   .. oe:method:: ElementToSpatialCoord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ElementToSpatialCoord(unsigned int el, float& x, float& y,
                                       float& z) const

      .. oe:language:: python

         .. oe:api:: python

            ElementToSpatialCoord(el: int) -> Tuple[float, float, float]

      The element 'el' is the one dimensional index into the grid points. 
      This function converts this one dimensional index into the Cartesian coordinates 
      (x,y,z) of the associated grid point. Returns false if 'el' is outside the array bounds.

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

      Returns the data type of the grid.

   .. oe:method:: GetDim

      .. oe:api::

         bool GetDim(unsigned int &xdim, unsigned int &ydim, unsigned int &zdim) const

      Retrieves the grid dimensions (*i.e.* the wideness of the grid for a specific axis) 
      into 'xdim', 'ydim', 'zdim' arguments. 

   .. oe:method:: GetMid

      .. oe:api::

         bool GetMid(float &midx, float &midy, float &midz) const

      Retrieves the grid midpoint (*i.e.* the center of the grid) into 'midx', 'midy' and 
      'midz' arguments. The midpoint defines where the grid is located in Cartesian space. 
      Returns ``false`` if the midpoint is not completely defined 
      (! :oe:meth:`IsXMidSet()<OESystem::OEGridBase::IsXMidSet>` || 
      ! :oe:meth:`IsYMidSet()<OESystem::OEGridBase::IsYMidSet>` || 
      ! :oe:meth:`IsZMidSet()<OESystem::OEGridBase::IsZMidSet>`)

   .. oe:method:: GetReentrant

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetReentrant() const

      .. oe:language:: python

         .. oe:api:: python

            GetReentrant() -> int

   .. oe:method:: GetSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetSize() -> int

      Returns the number of grid points inside this grid.

   .. oe:method:: GetSpaceGroup

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSpaceGroup() const

      .. oe:language:: python

         .. oe:api:: python

            GetSpaceGroup() -> int

   .. oe:method:: GetSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSpacing() const

      .. oe:language:: python

         .. oe:api:: python

            GetSpacing() -> float

      Returns the length between grid points.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Returns the title of this grid. The title defaults to an empty string.

   .. oe:method:: GetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetType() const

      .. oe:language:: python

         .. oe:api:: python

            GetType() -> int

      Returns the data type tag for the grid.

   .. oe:method:: GetUnitCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUnitCell(float& A, float& B, float& C, float& alpha,
                             float& beta, float& gamma) const

      .. oe:language:: python

         .. oe:api:: python

            GetUnitCell(A: float, B: float, C: float, alpha: float,
                        beta: float, gamma: float) -> bool

   .. oe:method:: GetValues
      :language: c++ java csharp

      .. oe:api::

         float *GetValues()
         const float *GetValues() const

   .. oe:method:: GetXDim

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetXDim() const

      .. oe:language:: python

         .. oe:api:: python

            GetXDim() -> int

      Returns how many grid points there are for the x-dimension of the grid. 

   .. oe:method:: GetXMid

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetXMid() const

      .. oe:language:: python

         .. oe:api:: python

            GetXMid() -> float

      Returns the center of this grid along the x-axis.

   .. oe:method:: GetYDim

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetYDim() const

      .. oe:language:: python

         .. oe:api:: python

            GetYDim() -> int

      Returns how many grid points there are for the y-dimension of the grid. 

   .. oe:method:: GetYMid

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetYMid() const

      .. oe:language:: python

         .. oe:api:: python

            GetYMid() -> float

      Returns the center of this grid along the y-axis.

   .. oe:method:: GetZDim

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetZDim() const

      .. oe:language:: python

         .. oe:api:: python

            GetZDim() -> int

      Returns how many grid points there are for the z-dimension of the grid. 

   .. oe:method:: GetZMid

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZMid() const

      .. oe:language:: python

         .. oe:api:: python

            GetZMid() -> float

      Returns the center of this grid along the z-axis.

   .. oe:method:: HasSpaceGroup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasSpaceGroup() const

      .. oe:language:: python

         .. oe:api:: python

            HasSpaceGroup() -> bool

   .. oe:method:: HasUnitCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasUnitCell() const

      .. oe:language:: python

         .. oe:api:: python

            HasUnitCell() -> bool

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void* type) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(type: void) -> bool

      Returns whether type is the same as the instance this method is called on
      (*i.e.* :ref:`OESkewGrid <OESystem_OESkewGrid>`).

   .. oe:method:: IsRegular

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsRegular() const

      .. oe:language:: python

         .. oe:api:: python

            IsRegular() -> bool

   .. oe:method:: IsSpacingSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsSpacingSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsSpacingSet() -> bool

      Returns whether the spacing for this grid has been specified.

   .. oe:method:: IsTitleSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsTitleSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsTitleSet() -> bool

      Returns whether there is a title associated with this grid.

   .. oe:method:: SetDim

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDim(unsigned int xdim, unsigned int ydim, unsigned int zdim)

      .. oe:language:: python

         .. oe:api:: python

            SetDim(xdim: int, ydim: int, zdim: int) -> bool

      Sets the number of grid points for each dimension.

   .. oe:method:: SetMid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMid(float midx, float midy, float midz)

      .. oe:language:: python

         .. oe:api:: python

            SetMid(midx: float, midy: float, midz: float) -> bool

      Sets the mid-point (center) of the grid.

   .. oe:method:: SetReentrant

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetReentrant(bool state = true)

      .. oe:language:: python

         .. oe:api:: python

            SetReentrant(state: bool = True) -> None

   .. oe:method:: SetSpaceGroup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSpaceGroup(unsigned int group)

      .. oe:language:: python

         .. oe:api:: python

            SetSpaceGroup(group: int) -> bool

   .. oe:method:: SetSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSpacing(float spacing)

      .. oe:language:: python

         .. oe:api:: python

            SetSpacing(spacing: float) -> bool

      Sets the length between grid points.

   .. oe:method:: SetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTitle(const std::string& title)

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(title: str) -> bool

      Sets the title associated with this grid.

   .. oe:method:: SetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetType(type: int) -> None

      Sets the tag associated with this grid.

   .. oe:method:: SetUnitCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUnitCell(float A, float B, float C, float alpha,
                             float beta, float gamma, unsigned int nx,
                             unsigned int ny, unsigned int nz)

      .. oe:language:: python

         .. oe:api:: python

            SetUnitCell(A: float, B: float, C: float, alpha: float,
                        beta: float, gamma: float, nx: int, ny: int, nz: int) -> bool

   .. oe:method:: SetValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetValues(const float* values, unsigned int length)

      .. oe:language:: python

         .. oe:api:: python

            SetValues(values: OEFloatArray, length: int) -> bool



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStopwatch, Stopwatch

.. _OESystem_OEStopwatch:

.. oe:class:: OEStopwatch

   .. oe:api::

      class OEStopwatch

   This class represents `OEStopwatch`.

   The :ref:`OEStopwatch <OESystem_OEStopwatch>` class provides a portable
   mechanism for measuring elapsed CPU time of a process.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEStopwatch()

      .. oe:language:: python

         .. oe:api:: python

            OEStopwatch() -> OEStopwatch

      Default constructor.

   .. oe:method:: Elapsed

      .. oe:language:: c++ java csharp

         .. oe:api::

            float Elapsed()

      .. oe:language:: python

         .. oe:api:: python

            Elapsed() -> float

      Returns the number of elapsed CPU seconds (as a floating point
      value) since :oe:meth:`OESystem::OEStopwatch::Start` was last
      called. This method is identical to
      :oe:meth:`OESystem::OEStopwatch::Lap`. This method does not
      update the internal 'start' time.

   .. oe:method:: Lap

      .. oe:language:: c++ java csharp

         .. oe:api::

            float Lap()

      .. oe:language:: python

         .. oe:api:: python

            Lap() -> float

      Returns the number of elapsed CPU seconds (as a floating point
      value) since :oe:meth:`OESystem::OEStopwatch::Start` was last
      called. This method is identical to
      :oe:meth:`OESystem::OEStopwatch::Elapsed`. This method does not
      update the internal 'start' time.

   .. oe:method:: Start

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Start()

      .. oe:language:: python

         .. oe:api:: python

            Start() -> None

      Sets the internal 'start' time of the
      :ref:`OEStopwatch <OESystem_OEStopwatch>` to the current time. This method
      should be called before calling either
      :oe:meth:`OESystem::OEStopwatch::Elapsed` or
      :oe:meth:`OESystem::OEStopwatch::Lap`. This method may be called
      more than once to reinitialize the 'start' time to the current
      time.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringParameter, StringParameter

.. _OESystem_OEStringParameter:

.. oe:class:: OEStringParameter

   .. oe:api::

      class OEStringParameter : public OEPODParameter<std::string>

   The :ref:`OEStringParameter <OESystem_OEStringParameter>` represents parameter that has ``string`` value.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OETypedParameter <OESystem_OETypedParameter>`:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   Following methods are publicly inherited from :ref:`OEPODParameter <OESystem_OEPODParameter>`:
    * :oe:meth:`GetDefaultsVector<OESystem::OEPODParameter::GetDefaultsVector>`
    * :oe:meth:`GetSettingsVector<OESystem::OEPODParameter::GetSettingsVector>`
    * :oe:meth:`GetValuesVector<OESystem::OEPODParameter::GetValuesVector>`

   The following classes derive from this class:
    * :ref:`OEMolReaderParameter <OEChem_OEMolReaderParameter>`
    * :ref:`OEMolWriterParameter <OEChem_OEMolWriterParameter>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEStringParameter()
            OEStringParameter(const std::string& name)
            OEStringParameter(const std::string& name,
                              const std::string& default)
            OEStringParameter(const OEStringParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEStringParameter(name: str) -> OEStringParameter
            OEStringParameter(name: str, defValue: str) -> OEStringParameter
            OEStringParameter() -> OEStringParameter
            OEStringParameter(arg2: OEStringParameter) -> OEStringParameter

      Default and copy constructors.

      Constructs an :ref:`OEStringParameter <OESystem_OEStringParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEStringParameter &operator=(const OEStringParameter &)

      The assignment operator.

      Assignment operator.



.. _chapter_oesystemclasses:

*******************
OESystem Classes
*******************

.. oe:namespace:: OESystem

.. toctree::

   IsFalse
   IsTrue
   OEAnd
   OEAnnotation
   OEBInitializer
   OEBase
   OEBaseData
   OEBaseDataT
   OEBaseDataTPtr
   OEBinaryAnd
   OEBinaryFalse
   OEBinaryFunction
   OEBinaryIOHandler
   OEBinaryIOHandlerBase
   OEBinaryNot
   OEBinaryOr
   OEBinaryPredicate
   OEBinaryTrue
   OEBitVector
   OEBoundedBuffer
   OEColor
   OEColorGradientBase
   OEColorStop
   OEConcatIter
   OEConsoleProgressTracer
   OEContainer
   OECycleTimer
   OEDots
   OEErrorHandler
   OEErrorHandlerImplBase
   OEExponentColorGradient
   OEExponentialColorGradient
   OEFixedGrid
   OEFixedMultiGrid
   OEGaussian
   OEGaussianBase
   OEGaussianContainer
   OEGaussianContainerBase
   OEGrid
   OEGridAbstractBase
   OEGridBase
   OEHasRole
   OEHeader
   OEInterface
   OEIsFalse
   OEIsTrue
   OEIter
   OEIterBase
   OELinearColorGradient
   OELogarithmicColorGradient
   OEMultiGrid
   OENot
   OEOr
   OEOwnedPtr
   OEParameter
   OEPredIter
   OEProtectedBuffer
   OERandom
   OERole
   OERoleSet
   OERoles
   OEScalarGrid
   OESharedPtr
   OESkewGrid
   OEStopwatch
   OEThreadedDots
   OETracerBase
   OETypedParameter
   OEUnaryFalse
   OEUnaryFunction
   OEUnaryPredicate
   OEUnaryTrue
   OEUnboundedBuffer
   OEUnownedPtr
   OEWallTimer
   oeprogressstream


.. oe:namespace:: OESystem

.. _OESystem_OEThreadedDots:

.. oe:class:: OEThreadedDots

   .. oe:api::

      class OEThreadedDots

   This class provides a threadsafe version of
   :ref:`OEDots <OESystem_OEDots>`. Multiple threads can call
   :oe:meth:`OESystem::OEThreadedDots::Update` to update the progress
   in an efficient manner in a thread-safe way. This class will create
   an internal operating system thread to handle output to
   :oe:const:`OEPlatform::OEPlatform::oeerr`. The complete progress is
   not guaranteed to be output to the terminal until
   :oe:meth:`OESystem::OEThreadedDots::Total` is called.

   .. warning::

      It is an error to call
      :oe:meth:`OESystem::OEThreadedDots::Update` after calling
      :oe:meth:`OESystem::OEThreadedDots::Total`. The object is
      essentially shut down and new one should be created.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEThreadedDots(unsigned int bigstep, unsigned int smallstep,
                           const char* objectname = "")

      .. oe:language:: python

         .. oe:api:: python

            OEThreadedDots(bigstep: int, smallstep: int, objectname: str = "") -> OEThreadedDots

      Controls how the following output gets updated::

         .......... 10000 things processed.
         .......... 20000 things processed.
         .......... 30000 things processed.
         .......... 40000 things processed.
         .......... 50000 things processed.
         .......... 60000 things processed.
         .......... 70000 things processed.
         .......... 80000 things processed.

      *bigstep*

        The number of elements before a new line is generated. The
        above example is a ``bigstep`` of ``10000``.

      *smallstep*

        The number of elements before a single new dot, ``.``, is
        printed.  The above example is a ``smallstep`` of ``1000``. Or
        10 dots per line.

      *objectname*

        A description of what is being processed. In the above
        example, this is "things".

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEThreadedDots & operator=(const OEThreadedDots &)

      Assignment operator.

   

   .. oe:method:: Total

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Total()

      .. oe:language:: python

         .. oe:api:: python

            Total() -> None

      Prints a final summary line like the following::

         Total: 80000 things processed.

      .. note::

         Calling this method waits for all information to flush to the
         IO thread and then terminates and joins that thread. So this
         function is effectively a blocking call on those
         operations. But the operations are typically very cheap, so
         the blocking nature is not noticeable.

   .. oe:method:: Update

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Update(unsigned int step = 1)

      .. oe:language:: python

         .. oe:api:: python

            Update(step: int = 1) -> None

      Update the progress with the number of elements specified by
      ``step``. The default is ``1`` element, but any number can be
      specified. However, ``0`` is not a valid step size and will
      throw an error.

      .. note::

         For :ref:`OEThreadedDots <OESystem_OEThreadedDots>`, this method is
         thread-safe to call from multiple threads even though it is a
         non-const method.


*******************************************************************************
Preliminary OESystem Classes
*******************************************************************************

.. oe:namespace:: OESystem

.. toctree::

   OEBoolParameter
   OEConstParameter
   OEDoubleParameter
   OEFloatParameter
   OEIntParameter
   OEMultiParameter
   OEOptions
   OEPODParameter
   OEPointerParameter
   OEStringParameter
   OEUIntParameter
   OERecord

..  oe:language:: c++ python

    ..  toctree::

        OEField
        OEFieldMeta
        OEFieldType
        OEBytes
        OERange


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEUIntParameter, UIntParameter

.. _OESystem_OEUIntParameter:

.. oe:class:: OEUIntParameter

   .. oe:api::

      class OEUIntParameter : public OEPODParameter<unsigned>

   The :ref:`OEUIntParameter <OESystem_OEUIntParameter>` represents parameter that has ``unsigned`` value.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OETypedParameter <OESystem_OETypedParameter>`:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   Following methods are publicly inherited from :ref:`OEPODParameter <OESystem_OEPODParameter>`:
    * :oe:meth:`GetDefaultsVector<OESystem::OEPODParameter::GetDefaultsVector>`
    * :oe:meth:`GetSettingsVector<OESystem::OEPODParameter::GetSettingsVector>`
    * :oe:meth:`GetValuesVector<OESystem::OEPODParameter::GetValuesVector>`

   The following classes derive from this class:
    * :ref:`OEConstParameter <OESystem_OEConstParameter>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEUIntParameter()
            OEUIntParameter(const std::string& name)
            OEUIntParameter(const std::string& name, const unsigned default)
            OEUIntParameter(const OEUIntParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEUIntParameter(name: str) -> OEUIntParameter
            OEUIntParameter(name: str, defValue: int) -> OEUIntParameter
            OEUIntParameter() -> OEUIntParameter
            OEUIntParameter(arg2: OEUIntParameter) -> OEUIntParameter

      Default and copy constructors.

      Constructs an :ref:`OEUIntParameter <OESystem_OEUIntParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEUIntParameter &operator=(const OEUIntParameter &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OESystem

.. _OESystem_OETracerBase:

.. oe:class:: OETracerBase

   .. oe:api::

      class OETracerBase

   :ref:`OETracerBase <OESystem_OETracerBase>` is an abstract class which defines the
   interface necessary for setting up and using a tracer to report progress of
   task(s).

   The following class derives from this class:

    * :ref:`OEConsoleProgressTracer <OESystem_OEConsoleProgressTracer>`

   .. oe:method:: Aborted

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Aborted()=0

      .. oe:language:: python

         .. oe:api:: python

            Aborted() -> bool

   .. oe:method:: Pop

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Pop()=0

      .. oe:language:: python

         .. oe:api:: python

            Pop() -> None

   .. oe:method:: Push

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Push(std::string task)=0

      .. oe:language:: python

         .. oe:api:: python

            Push(task: str) -> None

   .. oe:method:: Refresh

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Refresh()=0

      .. oe:language:: python

         .. oe:api:: python

            Refresh() -> None

   .. oe:method:: SetProgress

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetProgress(double percent)=0
            void SetProgress(unsigned int current, unsigned int total)=0

      .. oe:language:: python

         .. oe:api:: python

            SetProgress(percent: float) -> None
            SetProgress(current: int, total: int) -> None

      This pure virtual method should report the current progress of the task
      when it has reached the percentage of completion specified
      by ``percent`` or by ``current`` / ``total``.

   .. oe:method:: SetTask

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTask(std::string task)=0

      .. oe:language:: python

         .. oe:api:: python

            SetTask(task: str) -> None

      This pure virtual method should register the tracer with a task name specified by,
      ``task``. It should start the timer to trace the progress of the task.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OETypedParameter, TypedParameter

.. _OESystem_OETypedParameter:

.. oe:class:: OETypedParameter

   .. oe:api::

      template<class TT>
      class OETypedParameter : public OEParameter

   The :ref:`OETypedParameter <OESystem_OETypedParameter>` is an abstract base class. This is a templated
   class that provides type-specific implementation of parameters.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   The :ref:`OETypedParameter <OESystem_OETypedParameter>` class defines the following public methods:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   The following classes derive from this class:
    * :ref:`OEPODParameter <OESystem_OEPODParameter>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETypedParameter & operator=(const OETypedParameter &)

      Assignment operator.

   .. oe:method:: AddDefault

      .. oe:api::

         bool AddDefault(const TT& dflt)

      Add the specified value as a default for the parameter.

   .. oe:method:: AddValue

      .. oe:api::

         bool AddValue(const TT& value)

      Add the specified value as a user-defined value for the parameter.

   .. oe:method:: GetDefault

      .. oe:api::

         bool GetDefault(TT& dflt, const unsigned idx = 0) const

      Returns the default value of the parameter at the specified index, if available. See 
      :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` method.

   .. oe:method:: GetDefaults

      .. oe:api::

         OEIterBase<const TT>* GetDefaults() const = 0

      See :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` method.

   .. oe:method:: GetSetting

      .. oe:api::

         bool GetSetting(TT& setting, unsigned int idx = 0) const

      Returns the current settings of the parameter at the specified index, if available.

   .. oe:method:: GetSettings

      .. oe:api::

         OEIterBase<const TT>* GetSettings() const

      Returns all the current settings of the parameter.

   .. oe:method:: GetValue

      .. oe:api::

         bool GetValue(TT& value, const unsigned idx = 0) const

      Returns the user defined value of the parameter at the specified index, if available. See 
      :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` method.

   .. oe:method:: GetValues

      .. oe:api::

         OEIterBase<const TT>* GetValues() const = 0

      See :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` method.

   .. oe:method:: SetDefault

      .. oe:api::

         bool SetDefault(const TT& dflt)

      Sets the parameter default value. Overrides any existing defaults.
      See :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` method.

   .. oe:method:: SetValue

      .. oe:api::

         bool SetValue(const TT& value)

      Sets the parameter user-defined value. Overrides any existing user-defined value.
      See :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` method.



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEUnaryFalse, UnaryFalse

.. _OESystem_OEUnaryFalse:

.. oe:class:: OEUnaryFalse

   .. oe:api::

      template<class T>
      class OEUnaryFalse : public OEIsFalse<T>

   This class is just a synonym for :ref:`OEIsFalse <OESystem_OEIsFalse>`.

   The following methods are publicly inherited from :ref:`OEIsFalse <OESystem_OEIsFalse>`:

   ====================================================== ====================================================== ===================================================
   :oe:meth:`operator()<OESystem::OEIsFalse::operator()>` :oe:meth:`CreateCopy<OESystem::OEIsFalse::CreateCopy>`                                                    
   ====================================================== ====================================================== ===================================================

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEUnaryFunction, UnaryFunction

.. _OESystem_OEUnaryFunction:

.. oe:class:: OEUnaryFunction

   .. oe:api::

      template<class Arg, class Result, bool ConstArg, bool ConstFcn>
      class OEUnaryFunction

   This class represents `OEUnaryFunction`.

   This is the default functor base-class in *OEChem*.

   The following specializations exist for this template:

    * OESystem::OEUnaryFunction< Arg, Result, false, false >
    * OESystem::OEUnaryFunction< Arg, Result, false, true >
    * OESystem::OEUnaryFunction< Arg, Result, true, false >

   The following classes derive from this class:
    * :ref:`OEHasAlternateLocation <OEBio_OEHasAlternateLocation>`
    * :ref:`OEHasPDBAtomIndex <OEBio_OEHasPDBAtomIndex>`
    * :ref:`OEIsAlphaCarbon <OEBio_OEIsAlphaCarbon>`
    * :ref:`OEIsBackboneAtom <OEBio_OEIsBackboneAtom>`
    * :ref:`OEHasIdx <OEChem_OEHasIdx>`
    * :ref:`OEIdxSelected <OEChem_OEIdxSelected>`
    * :ref:`OEIsMember <OEChem_OEIsMember>`
    * :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>`
    * :ref:`OEMatch <OEChem_OEMatch>`
    * :ref:`OEAtomIsInAgent <OEChem_OEAtomIsInAgent>`
    * :ref:`OEAtomIsInProduct <OEChem_OEAtomIsInProduct>`
    * :ref:`OEAtomIsInReactant <OEChem_OEAtomIsInReactant>`
    * :ref:`OEAtomIsInResidue <OEChem_OEAtomIsInResidue>`
    * :ref:`OEAtomIsInRing <OEChem_OEAtomIsInRing>`
    * :ref:`OEBondIsInRing <OEChem_OEBondIsInRing>`
    * :ref:`OEGetNbrAtom <OEChem_OEGetNbrAtom>`
    * :ref:`OEHasAtomName <OEChem_OEHasAtomName>`
    * :ref:`OEHasAtomStereoSpecified <OEChem_OEHasAtomStereoSpecified>`
    * :ref:`OEHasAtomicNum <OEChem_OEHasAtomicNum>`
    * :ref:`OEHasBondStereoSpecified <OEChem_OEHasBondStereoSpecified>`
    * :ref:`OEHasChainID <OEChem_OEHasChainID>`
    * :ref:`OEHasFragmentNumber <OEChem_OEHasFragmentNumber>`
    * :ref:`OEHasIdx <OEChem_OEHasIdx>`
    * :ref:`OEHasMapIdx <OEChem_OEHasMapIdx>`
    * :ref:`OEHasOrder <OEChem_OEHasOrder>`
    * :ref:`OEHasResidueNumber <OEChem_OEHasResidueNumber>`
    * :ref:`OEIsAromaticAtom <OEChem_OEIsAromaticAtom>`
    * :ref:`OEIsAromaticBond <OEChem_OEIsAromaticBond>`
    * :ref:`OEIsCAlpha <OEChem_OEIsCAlpha>`
    * :ref:`OEIsCarbon <OEChem_OEIsCarbon>`
    * :ref:`OEIsChiralAtom <OEChem_OEIsChiralAtom>`
    * :ref:`OEIsChiralBond <OEChem_OEIsChiralBond>`
    * :ref:`OEIsHalide <OEChem_OEIsHalide>`
    * :ref:`OEIsHalogen <OEChem_OEIsHalogen>`
    * :ref:`OEIsHeavy <OEChem_OEIsHeavy>`
    * :ref:`OEIsHydrogen <OEChem_OEIsHydrogen>`
    * :ref:`OEIsMember <OEChem_OEIsMember>`
    * :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>`
    * :ref:`OEIsNitrogen <OEChem_OEIsNitrogen>`
    * :ref:`OEIsOxygen <OEChem_OEIsOxygen>`
    * :ref:`OEIsPhosphorus <OEChem_OEIsPhosphorus>`
    * :ref:`OEIsPolar <OEChem_OEIsPolar>`
    * :ref:`OEIsPolarHydrogen <OEChem_OEIsPolarHydrogen>`
    * :ref:`OEIsRGroup <OEChem_OEIsRGroup>`
    * :ref:`OEIsRotor <OEChem_OEIsRotor>`
    * :ref:`OEIsSulfur <OEChem_OEIsSulfur>`
    * :ref:`OEIsValidAtomValence <OEChem_OEIsValidAtomValence>`
    * :ref:`OEIsValidMDLAtomValence <OEChem_OEIsValidMDLAtomValence>`
    * :ref:`OEMatchFunc <OEChem_OEMatchFunc>`
    * :ref:`OENthAtom <OEChem_OENthAtom>`
    * :ref:`OEPartPredT <OEChem_OEPartPredT>`
    * :ref:`OEAnd <OESystem_OEAnd>`
    * :ref:`OENot <OESystem_OENot>`
    * :ref:`OEOr <OESystem_OEOr>`
    * :ref:`OEUnaryFalse <OESystem_OEUnaryFalse>`
    * :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            Result operator()(const Arg &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(Arg) -> Result

      It is a virtual const :oe:meth:`OESystem::OEUnaryFunction::operator()` which takes
      a const argument.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryFunction

      It is a virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEUnaryPredicate, UnaryPredicate

.. _OESystem_OEUnaryPredicate:

.. oe:class:: OEUnaryPredicate

   .. oe:api::

      template<class Arg>
      class OEUnaryPredicate : public OEUnaryFunction<Arg, bool>

   This class represents `OEUnaryPredicate`.

   This abstract base-class defines predicates in *OEChem*. Predicates
   are a special class of functors which, by convention, has several
   restriction. These restrictions make predicates predictable and
   reliable. To the degree possible, these restrictions are enforced by
   the API. :oe:meth:`OESystem::OEUnaryPredicate::CreateCopy` is a virtual
   constructor which allows copying of concrete derived objects using a
   reference to this base class.

   By definition, a predicates is a functor which always return a
   boolean. By convention, the
   :oe:meth:`OESystem::OEUnaryPredicate::operator()` of a predicate does
   not modify the object it takes as an argument and itself is not
   modified by the evaluation. These conventions guarantee that the
   result of a series of predicate evaluations will not be order
   dependent.

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   The following atom predicate classes classes derive from this class:

    * :ref:`OEAtomIsInAgent <OEChem_OEAtomIsInAgent>`
    * :ref:`OEAtomIsInChain <OEChem_OEAtomIsInChain>`
    * :ref:`OEAtomIsInProduct <OEChem_OEAtomIsInProduct>`
    * :ref:`OEAtomIsInReactant <OEChem_OEAtomIsInReactant>`
    * :ref:`OEAtomIsInResidue <OEChem_OEAtomIsInResidue>`
    * :ref:`OEAtomIsInRing <OEChem_OEAtomIsInRing>`
    * :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>`
    * :ref:`OEHasAlphaBetaUnsat <OEChem_OEHasAlphaBetaUnsat>`
    * :ref:`OEHasAlternateLocation <OEBio_OEHasAlternateLocation>`
    * :ref:`OEHasAnisou <OEChem_OEHasAnisou>`
    * :ref:`OEHasAtomicNum <OEChem_OEHasAtomicNum>`
    * :ref:`OEHasAtomName <OEChem_OEHasAtomName>`
    * :ref:`OEHasAtomStereoSpecified <OEChem_OEHasAtomStereoSpecified>`
    * :ref:`OEHasChainID <OEChem_OEHasChainID>`
    * :ref:`OEHasFormalCharge <OEChem_OEHasFormalCharge>`
    * :ref:`OEHasFragmentNumber <OEChem_OEHasFragmentNumber>`
    * :ref:`OEHasHvyDegree <OEChem_OEHasHvyDegree>`
    * :ref:`OEHasIdx <OEChem_OEHasIdx>`
    * :ref:`OEHasMapIdx <OEChem_OEHasMapIdx>`
    * :ref:`OEHasPDBAtomIndex <OEBio_OEHasPDBAtomIndex>`
    * :ref:`OEHasResidueNumber <OEChem_OEHasResidueNumber>`
    * :ref:`OEHasSecondaryStructure <OEBio_OEHasSecondaryStructure>`
    * :ref:`OEIsAlphaCarbon <OEBio_OEIsAlphaCarbon>`
    * :ref:`OEIsAromaticAtom <OEChem_OEIsAromaticAtom>`
    * :ref:`OEIsAtomHybridization <OEChem_OEIsAtomHybridization>`
    * :ref:`OEIsBackboneAtom <OEBio_OEIsBackboneAtom>`
    * :ref:`OEIsCAlpha <OEChem_OEIsCAlpha>`
    * :ref:`OEIsCarbon <OEChem_OEIsCarbon>`
    * :ref:`OEIsChiralAtom <OEChem_OEIsChiralAtom>`
    * :ref:`OEIsColorAtomPred <OEShape_OEIsColorAtomPred>`
    * :ref:`OEIsHalide <OEChem_OEIsHalide>`
    * :ref:`OEIsHalogen <OEChem_OEIsHalogen>`
    * :ref:`OEIsHeavy <OEChem_OEIsHeavy>`
    * :ref:`OEIsHetero <OEChem_OEIsHetero>`
    * :ref:`OEIsHydrogen <OEChem_OEIsHydrogen>`
    * :ref:`OEIsInvertibleNitrogen <OEChem_OEIsInvertibleNitrogen>`
    * :ref:`OEIsMetal <OEChem_OEIsMetal>`
    * :ref:`OEIsNitrogen <OEChem_OEIsNitrogen>`
    * :ref:`OEIsNonRingAtomDoubleBondedToRing <OEChem_OEIsNonRingAtomDoubleBondedToRing>`
    * :ref:`OEIsNucleicAcidBase <OEBio_OEIsNucleicAcidBase>`
    * :ref:`OEIsNucleicAcidPhosphate <OEBio_OEIsNucleicAcidPhosphate>`
    * :ref:`OEIsNucleicAcidSugar <OEBio_OEIsNucleicAcidSugar>`
    * :ref:`OEIsOxygen <OEChem_OEIsOxygen>`
    * :ref:`OEIsPhosphorus <OEChem_OEIsPhosphorus>`
    * :ref:`OEIsPolar <OEChem_OEIsPolar>`
    * :ref:`OEIsPolarHydrogen <OEChem_OEIsPolarHydrogen>`
    * :ref:`OEIsRGroup <OEChem_OEIsRGroup>`
    * :ref:`OEIsSulfur <OEChem_OEIsSulfur>`
    * :ref:`OEIsValidAtomValence <OEChem_OEIsValidAtomValence>`
    * :ref:`OEIsValidMDLAtomValence <OEChem_OEIsValidMDLAtomValence>`
    * :ref:`OEIsWater <OEBio_OEIsWater>`

    The following bond predicate classes derive from this class:

    * :ref:`OEBondIsInChain <OEChem_OEBondIsInChain>`
    * :ref:`OEBondIsInRing <OEChem_OEBondIsInRing>`
    * :ref:`OEHasBondStereoSpecified <OEChem_OEHasBondStereoSpecified>`
    * :ref:`OEHasOrder <OEChem_OEHasOrder>`
    * :ref:`OEIsAromaticBond <OEChem_OEIsAromaticBond>`
    * :ref:`OEIsChiralBond <OEChem_OEIsChiralBond>`
    * :ref:`OEIsRotor <OEChem_OEIsRotor>`

    The following template predicate classes derive from this class:

    * :ref:`OEIdxSelected <OEChem_OEIdxSelected>`
    * :ref:`OEIsMember <OEChem_OEIsMember>`
    * :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>`
    * :ref:`OEIsMember <OEChem_OEIsMember>`
    * :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>`

    * :ref:`OEMatchFunc <OEChem_OEMatchFunc>`
    * :ref:`OENthAtom <OEChem_OENthAtom>`
    * :ref:`OEPartPredT <OEChem_OEPartPredT>`

    * :ref:`IsFalse <OESystem_IsFalse>`
    * :ref:`IsTrue <OESystem_IsTrue>`

    * :ref:`OEAnd <OESystem_OEAnd>`
    * :ref:`OENot <OESystem_OENot>`
    * :ref:`OEOr <OESystem_OEOr>`
    * :ref:`OEUnaryFalse <OESystem_OEUnaryFalse>`

   .. oe:language:: python java csharp

      The following specializations exist for this template:

      ==================== =====================================================
      OEUnaryBasePred      OESystem::OEUnaryPredicate< OESystem::OEBase >
      OEUnaryAtomPred      OESystem::OEUnaryPredicate< OEChem::OEAtomBase >
      OEUnaryBondPred      OESystem::OEUnaryPredicate< OEChem::OEBondBase >
      OEUnaryConfPred      OESystem::OEUnaryPredicate< OEChem::OEConfBase >
      OEUnaryMolBasePred   OESystem::OEUnaryPredicate< OEChem::OEMolBase >
      OEUnaryGraphMolPred  OESystem::OEUnaryPredicate< OEChem::OEGraphMol >
      ==================== =====================================================

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const Arg& a) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(a: Arg) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryPredicate

   .. oe:method:: CreatePredicateCopy

      .. oe:api::

         OEFORCEINLINE OEUnaryPredicate<Arg> * CreatePredicateCopy() const



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEUnaryTrue, UnaryTrue

.. _OESystem_OEUnaryTrue:

.. oe:class:: OEUnaryTrue

   .. oe:api::

      template<class T> class OEUnaryTrue : public OEIsTrue<T>

   This class is just a synonym for :ref:`OEIsTrue <OESystem_OEIsTrue>`.

   The following methods are publicly inherited from :ref:`OEIsTrue <OESystem_OEIsTrue>`:

   ===================================================== ===================================================== ====================================================
   :oe:meth:`operator()<OESystem::OEIsTrue::operator()>` :oe:meth:`CreateCopy<OESystem::OEIsTrue::CreateCopy>`                                                     
   ===================================================== ===================================================== ====================================================

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`                                                            
   ============================================================ ============================================================ ===========================================================



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEUnboundedBuffer, UnboundedBuffer

.. attention::

   |CPPONLY|

.. _OESystem_OEUnboundedBuffer:

.. oe:class:: OEUnboundedBuffer

   .. oe:api::

      template<class T>
      class OEUnboundedBuffer

   First-in-first-out (FIFO) queue that only allows for any number of items
   to be stored in the buffer, hence, "unbounded".  It is not
   inherently thread safe by itself. Use this in conjunction with a
   :ref:`OEProtectedBuffer <OESystem_OEProtectedBuffer>` to make a thread-safe queue.

   .. oe:method:: Constructors

      .. oe:api::

         OEUnboundedBuffer(oesize_t)

      The constructor argument is unused and reserved for future
      use. It is only there to comply with the
      :ref:`OEBoundedBuffer <OESystem_OEBoundedBuffer>` constructor interface.

   .. oe:method:: Empty

      .. oe:api::

         bool Empty() const

      Returns whether the queue contains any items.

   .. oe:method:: Full

      .. oe:api::

         bool Full() const

      Returns ``true`` if the queue contains ``maxsize`` items.

   .. oe:method:: Get

      .. oe:api::

         T Get()

      Pops the next item off of the queue.

   .. oe:method:: Peek

      .. oe:api::

         T Peek()

      Returns the item that will be returned by the next call to
      :oe:meth:`OESystem::OEBoundedBuffer::Get`, but does not remove
      it from the queue.

   .. oe:method:: Put

      .. oe:api::

         void Put(T obj)

      Pushes an item into the queue.

   .. oe:method:: Size

      .. oe:api::

         oesize_t Size() const

      Returns the current number of items in the queue.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEUnownedPtr, UnownedPtr

.. _OESystem_OEUnownedPtr:

.. oe:class:: OEUnownedPtr

   .. oe:api::

      template<class T>
      class OEUnownedPtr

   .. warning::

      This class has been deprecated. Use raw pointers instead.
      C++ only class. This class is not visible in any other languages.

   This class is designed to provide the same "const correct-ness"
   guarantees that :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` provides. A
   description of this "const correct-ness" can be found in the
   :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` section. This class is really only
   useful to ensure pointer dereferencing does not inadvertently
   create a thread safety problem.

   .. oe:method:: Constructors

      .. oe:api::

         OEUnownedPtr()
         OEUnownedPtr(T* ptr)

      Default constructors the pointer to ``NULL``. Or constructor a
      smart pointer around the pointer ``ptr``.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEUnownedPtr<T>& operator=(T* rhs)

      Construct a from the pointer ``ptr``.

      Assignment operator.

   .. oe:method:: operator*
      :language: c++

      .. oe:api::

         T& operator*()
         const T& operator*() const

      Dereference the object and return a reference to the held
      object while maintaining ``const`` correctness. Note,
      dereference a ``NULL`` pointer is undefined.

   .. oe:method:: operator->
      :language: c++

      .. oe:api::

         T* operator->()
         const T* operator->() const

      Access the pointer held by this object while maintaining
      ``const`` correctness.

   .. oe:method:: operator T *
      :language: c++

      .. oe:api::

         operator T *()

      Implicit conversion to a pointer to ``T``. Note, the implicit
      conversion does not break ``const`` correctness.

   .. oe:method:: operator const T *
      :language: c++

      .. oe:api::

         operator const T *() const

      Implicit conversion to a pointer to ``const T``. Note, the
      implicit conversion does not break ``const`` correctness.

   .. oe:method:: Get

      .. oe:api::

         T* Get()
         const T* Get() const

      Access the pointer held by this smart pointer while maintaining
      ``const`` correctness.

   .. oe:method:: Release

      .. oe:api::

         T* Release()

      Returns the pointer owned by this smart pointer. This object
      will cease to point to the object in question. The object will
      effectively become a ``NULL`` pointer.

      .. warning::

         No memory management is performed on the pointer with
         ``delete``.


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEWallTimer, WallTimer

.. _OESystem_OEWallTimer:

.. oe:class:: OEWallTimer

   .. oe:api::

      class OEWallTimer

   This class represents `OEWallTimer`.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEWallTimer()

      .. oe:language:: python

         .. oe:api:: python

            OEWallTimer() -> OEWallTimer

      Default and copy constructors.

   .. oe:method:: Elapsed

      .. oe:language:: c++ java csharp

         .. oe:api::

            float Elapsed()

      .. oe:language:: python

         .. oe:api:: python

            Elapsed() -> float

   .. oe:method:: Lap

      .. oe:language:: c++ java csharp

         .. oe:api::

            float Lap()

      .. oe:language:: python

         .. oe:api:: python

            Lap() -> float

   .. oe:method:: Start

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Start()

      .. oe:language:: python

         .. oe:api:: python

            Start() -> None



.. oe:namespace:: OESystem

.. meta::
   :keywords: oeprogressstream, progressstream

.. _OESystem_oeprogressstream:

.. oe:class:: oeprogressstream

   .. oe:api::

      class oeprogressstream : public OEPlatform::oeiwrapperstream

   This class represents `oeprogressstream`.

   The following methods are publicly inherited from :ref:`oeiwrapperstream <OEPlatform_oeiwrapperstream>`:

   ====================================================== ====================================================== =======================================================
   :oe:meth:`clear<OEPlatform::oeiwrapperstream::clear>`  :oe:meth:`set<OEPlatform::oeiwrapperstream::set>`      :oe:meth:`stream<OEPlatform::oeiwrapperstream::stream>`
   ====================================================== ====================================================== =======================================================

   The following methods are publicly inherited from :ref:`oeistream <OEPlatform_oeistream>`:

   ======================================================== ======================================================= =======================================================
   :oe:meth:`operator>><OEPlatform::oeistream::operator>>>` :oe:meth:`gettoken<OEPlatform::oeistream::gettoken>`    :oe:meth:`skipbyte<OEPlatform::oeistream::skipbyte>`   
   :oe:meth:`close<OEPlatform::oeistream::close>`           :oe:meth:`open<OEPlatform::oeistream::open>`            :oe:meth:`skipline<OEPlatform::oeistream::skipline>`   
   :oe:meth:`get<OEPlatform::oeistream::get>`               :oe:meth:`peekbyte<OEPlatform::oeistream::peekbyte>`                                                           
   :oe:meth:`getbyte<OEPlatform::oeistream::getbyte>`       :oe:meth:`read<OEPlatform::oeistream::read>`                                                                   
   :oe:meth:`getline<OEPlatform::oeistream::getline>`       :oe:meth:`skip<OEPlatform::oeistream::skip>`                                                                   
   ======================================================== ======================================================= =======================================================

   The following methods are publicly inherited from :ref:`oestream <OEPlatform_oestream>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`operator bool<OEPlatform::oestream::operator bool>` :oe:meth:`rewind<OEPlatform::oestream::rewind>`              :oe:meth:`tell<OEPlatform::oestream::tell>`                 
   :oe:meth:`eof<OEPlatform::oestream::eof>`                     :oe:meth:`seek<OEPlatform::oestream::seek>`                                                                              
   :oe:meth:`length<OEPlatform::oestream::length>`               :oe:meth:`size<OEPlatform::oestream::size>`                                                                              
   ============================================================= ============================================================ ============================================================

   .. oe:method:: Constructors

      .. oe:api::

         oeprogressstream(OEPlatform::oeistream* istream, bool ownstream,
                          OETracerBase* tracer = new OEDefaultProgressTracer,
                          bool owntracer = true)

      Default and copy constructors.

   .. oe:method:: SetTracer

      .. oe:api::

         void SetTracer(OETracerBase* tracer, bool owntracer = true)



.. oe:namespace:: OESystem

.. oe:constnamespace:: OEAnnotationPrimitive

   This namespace contains constants.

   .. oe:constant:: Container
   

   .. oe:constant:: Sphere
   

   .. oe:constant:: Ellipsoid
   

   .. oe:constant:: Box
   

   .. oe:constant:: Cylinder
   

   .. oe:constant:: Arrow
   

   .. oe:constant:: Line
   

   .. oe:constant:: Surface
   

   .. oe:constant:: Spline
   

   .. oe:constant:: SplineSurface
   

   .. oe:constant:: Torus
   

   .. oe:constant:: Text
   

   .. oe:constant:: Symbol
   



.. oe:namespace:: OESystem

.. oe:constnamespace:: OEAnnotationRenderHint

   This namespace contains constants.

   .. oe:constant:: Solid
   

   .. oe:constant:: Mesh
   

   .. oe:constant:: Points
   



.. oe:namespace:: OESystem

.. oe:constnamespace:: OEErrorLevel

   This namespace contains constants.

   .. oe:constant:: Undefined
   

   .. oe:constant:: Debug
   

   .. oe:constant:: Verbose
   

   .. oe:constant:: Info
   

   .. oe:constant:: Warning
   

   .. oe:constant:: Error
   

   .. oe:constant:: Fatal
   

   .. oe:constant:: Usage
   

   .. oe:constant:: Quiet
   

   .. oe:constant:: MAX
   

   .. oe:constant:: MIN
   

   .. oe:constant:: Default
   
      The default error level is
      :oe:const:`OESystem::OEErrorLevel::Info`. 



.. oe:namespace:: OESystem

..  _OESystem_OEGridFileType:

.. oe:constnamespace:: OEGridFileType

   This namespace contains constants.

   .. oe:constant:: UNDEFINED
   

   .. oe:constant:: Grasp
   

   .. oe:constant:: GRD
   

   .. oe:constant:: CCP4
   

..  _OESystem_OEGridFileType_XPLOR:

   .. oe:constant:: XPLOR
   

   .. oe:constant:: Ascii
   



.. oe:namespace:: OESystem

.. oe:constnamespace:: OEGridMaskType

   This namespace contains constants.

   .. oe:constant:: ValuePlus
   

   .. oe:constant:: ValueMinus
   

   .. oe:constant:: GridPlus
   

   .. oe:constant:: GridMinus
   

   .. oe:constant:: Gaussian
   

   .. oe:constant:: GaussianMinus
   

   .. oe:constant:: GaussianSmooth
   

   .. oe:constant:: GaussianSmoothMinus
   

   .. oe:constant:: Default
   



.. oe:namespace:: OESystem

.. oe:constnamespace:: OEGridType

   This namespace contains constants.

   .. oe:constant:: GenericGrid
   

   .. oe:constant:: ElectrostaticGrid
   

   .. oe:constant:: FredGrid
   

   .. oe:constant:: RegularMap
   

   .. oe:constant:: DifferenceMap
   

   .. oe:constant:: ETGrid
   

   .. oe:constant:: EonGrid
   

   .. oe:constant:: MaxGridType
   



.. oe:namespace:: OESystem

.. oe:constnamespace:: OEMTZMapType

   This namespace contains constants.

   .. seealso::

      * :oe:func:`OESystem::OEReadMTZ` function
      * :oe:func:`OESystem::OEMTZMapTypeToString` function
      * :oe:func:`OESystem::OEMTZMapTypeFromString` function

   .. oe:constant:: Fc

.. _OESystem_OEMTZMapType_Fdelwt:

   .. oe:constant:: Fdelwt

   .. oe:constant:: FiveFoThreeFc

   .. oe:constant:: Fo

   .. oe:constant:: FoFc

   .. oe:constant:: FoFcSigmaA

   .. oe:constant:: FoFom

   .. oe:constant:: FoSquared

.. _OESystem_OEMTZMapType_Fwt:

   .. oe:constant:: Fwt

   .. oe:constant:: None

   .. oe:constant:: ThreeFoTwoFc

   .. oe:constant:: TwoFoFc

   .. oe:constant:: TwoFoFcSigmaA

   .. oe:constant:: User

   .. oe:constant:: UserDiff


.. oe:namespace:: OESystem

.. oe:constnamespace:: OEMemPoolMode

   This namespace contains constants.

   .. oe:constant:: SingleThreaded
   

   .. oe:constant:: Mutexed
   

   .. oe:constant:: Spinlocked

   .. oe:constant:: ThreadLocal
   

   .. oe:constant:: BoundedCache
   

   .. oe:constant:: UnboundedCache
   

   .. oe:constant:: System
   

   .. oe:constant:: Default
   



.. oe:namespace:: OEDataFlow

.. _OEDataFlow_OEMetadata:

.. meta::
   :keywords: OEMetadata datarecord

.. oe:language:: python

   .. oe:class:: OEMetadata

      A nested class containing constants for use with OEFieldMeta. Metadata
      has two forms: **options** are simple flags, while **attributes** are
      key-value pairs. The hierarchy of metadata constants is shown below, with
      each constant's use as either an option or attribute indicated.

      Meta
         **Annotation**
         *(attributes with value type of str)*

           Description

           Author

           Comments

         **Source**
         *(attributes with value type of str)*

           ID

           JobID

           ServiceID

           Version

           Query

         **Flags**
         *(options)*

           ID

           Deprecated

           Range

           Categorical

           Ordinal

           Invalid

           Readonly

           DoNotSave

           Independent

           Experimental

           Calculated

           SDData

           GenericData

           PDBData

           UserCreated

           Optional

           Predicted

         **Hints**
         *(options)*

           Image

           Image_SVG

           Image_PNG

           Image_JPG

           Date

           URL

           ImageURL

           LargerValuesBetter

           SmallerValuesBetter

           ShardID

           **Chem**

             PrimaryMol

             SMILES

             SMARTS

             Protein

             Receptor

             Conformer

             Reaction

             Markush

             FingerPrint

             SelectivityTarget

             PrimaryTarget

             Ligand

             Query

             MolReference

             ProteinSequence

             DNASequence

             RNASequence

             InChi

             InChiKey

             OrionMolURL

             ChemicalName

             RotorOffsetCompression

             GraphMol

             Virtual
             
	     VirtualID

             CXSMILES

         **Display**
         *(options)*

           Hidden

           AsMean

           AsRange

           Precision1

           Precision2

           Precision3

           Precision4

           PreferLog

           ColorBy

           MarkerBy

           SizeBy

           XAxis

           YAxis

           HiddenFrom3D

           HiddenFromSpreadsheet

           HiddenFromPlot

           HiddenFromTileView

           HiddenByDefault

           **Chem**

             AsDepiction

         **Relations**
         *(A class defining relationship attributes to other columns. The attribute type is str, for column names.)*

           ErrorsFor

           ChildOf

           UnitsFor

           DetailsFor

           MeanFor

           GroupID

           ReplacedBy

           AppliesTo

           CommentFor

           MeasurementUpperLimitFor

           MeasurementLowerLimitFor

           QualifierFor

           SplitFrom

           **Chem**

             MolDataFor

             ConfDataFor

             AtomDataFor

             BondDataFor

             LigandFor

             ReceptorFor

             QueryFor

         **Units**
         *(options)*

           Concentration
             M

             mM

             uM

             nM

             mg_per_kg

             ng_per_ml

             ppm

             ppb

           Energy
             Cal

             kCal

             J

             kJ

             Hartree

             eV

             kCal_per_mol

             kJ_per_mol

             kT

             RT

           Entropy
             kCal_per_mol_K

             kJ_per_mol_K

           Velocity
             m_per_s

             A_per_ps

           Density
             e_per_A3

             n_per_A3

             item_per_m3

             item_per_cm3

           Amount
             Mol

             Item

           Charge
             Coulomb

             PlanckCharge

           Angle(Constants):
             rad

             deg

           Force
             N

             dyn

             H_per_Bohr

             eV_per_A

             kJ_per_mol_rad

             kJ_per_mol_nm

             kJ_per_mol_A

             kCal_per_mol_rad

             kCal_per_mol_nm

             kCal_per_mol_A

           Power
             W

           Current
             A

             mA

             uA

           ElectricalPotential
             V

           MagneticField
             T

             G

           Pressure
             Pa

             kPa

             bar

             atm

             mmHg

             tor

           DipoleMoment
             D

             statCm

           Length
             m

             mm

             um

             nm

             Ang

             Bohr

           Time
             s

             ms

             us

             ns

             ps

             fs

             days

             min

             hours

           Mass
             kg

             g

             mg

             ug

             ng

             Da

           Volume
             l

             ml

             ul

             nl

             A3

           Frequency
             Hz

             kHz

             MHz

             GHz

             THz

             Recip_cm

           Temp
             C

             F

             K

       **Limits**
       *(attributes with float values)*

         Lower

         Upper

       **Constraints**
       *(attributes with float values)*

         AllowedValues

         Limits

.. oe:language:: c++

   .. oe:class:: OEMetadata

      A nested class containing constants for use with OEFieldMeta. Metadata
      has two forms: **options** are simple flags, while **attributes** are
      key-value pairs. The hierarchy of metadata constants is shown below, with
      each constant's use as either an option or attribute indicated.

      OEMetadata
         **Annotation**
         *(attributes with value type of str)*

           Description

           Author

           Comments

         **Source**
         *(attributes with value type of str)*

           ID

           JobID

           ServiceID

           Version

           Query

         **Flags**
         *(options)*

           ID

           Deprecated

           Range

           Categorical

           Ordinal

           Invalid

           Readonly

           DoNotSave

           Independent

           Experimental

           Calculated

           SDData

           GenericData

           PDBData

           UserCreated

           Optional

           Predicted

         **Hints**
         *(options)*

           Image

           Image_SVG

           Image_PNG

           Image_JPG

           Date

           URL

           ImageURL

           LargerValuesBetter

           SmallerValuesBetter

           ShardID

           **Chem**

             PrimaryMol

             SMILES

             SMARTS

             Protein

             Receptor

             Conformer

             Reaction

             Markush

             FingerPrint

             SelectivityTarget

             PrimaryTarget

             Ligand

             Query

             MolReference

             ProteinSequence

             DNASequence

             RNASequence

             InChi

             InChiKey

             OrionMolURL

             ChemicalName

             RotorOffsetCompression

             GraphMol

         **Display**
         *(options)*

           Hidden

           AsMean

           AsRange

           Precision1

           Precision2

           Precision3

           Precision4

           PreferLog

           ColorBy

           MarkerBy

           SizeBy

           XAxis

           YAxis

           **Chem**

             AsDepiction

         **Relations**
         *(A class defining relationship attributes to other columns. The attribute type is str, for column names.)*

           ErrorsFor

           ChildOf

           UnitsFor

           DetailsFor

           MeanFor

           GroupID

           ReplacedBy

           AppliesTo

           CommentFor

           MeasurementUpperLimitFor

           MeasurementLowerLimitFor

           QualifierFor

           SplitFrom

           **Chem**

             MolDataFor

             ConfDataFor

             AtomDataFor

             BondDataFor

             LigandFor

             ReceptorFor

             QueryFor

         **Units**
         *(options)*

           Concentration
             M

             mM

             uM

             nM

             mg_per_kg

             ng_per_ml

             ppm

             ppb

           Energy
             Cal

             kCal

             J

             kJ

             Hartree

             eV

             kCal_per_mol

             kJ_per_mol

             kT

             RT

           Entropy
             kCal_per_mol_K

             kJ_per_mol_K

           Velocity
             m_per_s

             A_per_ps

           Density
             e_per_A3

             n_per_A3

             item_per_m3

             item_per_cm3

           Amount
             Mol

             Item

           Charge
             Coulomb

             PlanckCharge

           Angle(Constants):
             rad

             deg

           Force
             N

             dyn

             H_per_Bohr

             eV_per_A

             kJ_per_mol_rad

             kJ_per_mol_nm

             kJ_per_mol_A

             kCal_per_mol_rad

             kCal_per_mol_nm

             kCal_per_mol_A

           Power
             W

           Current
             A

             mA

             uA

           ElectricalPotential
             V

           MagneticField
             T

             G

           Pressure
             Pa

             kPa

             bar

             atm

             mmHg

             tor

           DipoleMoment
             D

             statCm

           Length
             m

             mm

             um

             nm

             Ang

             Bohr

           Time
             s

             ms

             us

             ns

             ps

             fs

             days

             min

             hours

           Mass
             kg

             g

             mg

             ug

             ng

             Da

           Volume
             l

             ml

             ul

             nl

             A3

           Frequency
             Hz

             kHz

             MHz

             GHz

             THz

             Recip_cm

           Temp
             C

             F

             K

       **Limits**
       *(attributes with float values)*

         Lower

         Upper

       **Constraints**
       *(attributes with float values)*

         AllowedValues

         Limits



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. oe:constnamespace:: OEOptsConfigureStatus

   This namespace contains constants.

   .. oe:constant:: Success
   
      Options configuration finished successfully.

   .. oe:constant:: Help
   
      Options help requested at configuration

   .. oe:constant:: Failed
   
      Options configuration failed.



.. oe:namespace:: OESystem

.. oe:constnamespace:: OEParamVisibility

   This namespace contains constants.

   .. oe:constant:: Simple
   

   .. oe:constant:: Normal
   

   .. oe:constant:: Hidden
   

   .. oe:constant:: MAX
   



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDataFlow

.. meta::
   :keywords: OEFieldType, OEField, OERecord, datarecord

.. oe:constnamespace:: OERecordReturnCode

   .. attention::

     |TWOLANGUAGE|

   The :oe:constns:`OEDataFlow::OERecordReturnCode` returns codes that convey
   status regarding fields in a :ref:`OERecord <OEDataFlow_OERecord>`.

   This namespace contains the following constants:

   .. oe:constant:: OK
   
      Returned if the desired field exists.

   .. oe:constant:: NoValue
   
      Returned if the field does not have a value.

   .. oe:constant:: NullValue

      Returned if the field has a null value.

   .. oe:constant:: TypeMismatch

      Returned if the field has a different type than the one specified in the call.

   .. oe:constant:: MetadataMismatch

      Returned if the field being queried has different metadata than the metadata specified in the call.


.. oe:namespace:: OESystem

.. oe:constnamespace:: OESystem

   This namespace contains constants.

   .. oe:constant:: OEBlack

      .. image:: oechemtk/images/OEBlack.*

   .. oe:constant:: OEBlue

      .. image:: oechemtk/images/OEBlue.*

   .. oe:constant:: OEBlueTint

      .. image:: oechemtk/images/OEBlueTint.*

   .. oe:constant:: OEBrass

      .. image:: oechemtk/images/OEBrass.*

   .. oe:constant:: OEBrown

      .. image:: oechemtk/images/OEBrown.*

   .. oe:constant:: OECopper

      .. image:: oechemtk/images/OECopper.*

   .. oe:constant:: OECyan

      .. image:: oechemtk/images/OECyan.*

   .. oe:constant:: OEDarkBlue

      .. image:: oechemtk/images/OEDarkBlue.*

   .. oe:constant:: OEDarkBrown

      .. image:: oechemtk/images/OEDarkBrown.*

   .. oe:constant:: OEDarkCyan

      .. image:: oechemtk/images/OEDarkCyan.*

   .. oe:constant:: OEDarkGreen

      .. image:: oechemtk/images/OEDarkGreen.*

   .. oe:constant:: OEDarkGrey

      .. image:: oechemtk/images/OEDarkGrey.*

   .. oe:constant:: OEDarkMagenta

      .. image:: oechemtk/images/OEDarkMagenta.*

   .. oe:constant:: OEDarkOrange

      .. image:: oechemtk/images/OEDarkOrange.*

   .. oe:constant:: OEDarkPurple

      .. image:: oechemtk/images/OEDarkPurple.*

   .. oe:constant:: OEDarkRed

      .. image:: oechemtk/images/OEDarkRed.*

   .. oe:constant:: OEDarkRose

      .. image:: oechemtk/images/OEDarkRose.*

   .. oe:constant:: OEDarkSalmon

      .. image:: oechemtk/images/OEDarkSalmon.*

   .. oe:constant:: OEDarkYellow

      .. image:: oechemtk/images/OEDarkYellow.*

   .. oe:constant:: OEGold

      .. image:: oechemtk/images/OEGold.*

   .. oe:constant:: OEGreen

      .. image:: oechemtk/images/OEGreen.*

   .. oe:constant:: OEGreenBlue

      .. image:: oechemtk/images/OEGreenBlue.*

   .. oe:constant:: OEGreenTint

      .. image:: oechemtk/images/OEGreenTint.*

   .. oe:constant:: OEGrey

      .. image:: oechemtk/images/OEGrey.*

   .. oe:constant:: OEHotPink

      .. image:: oechemtk/images/OEHotPink.*

   .. oe:constant:: OELightBlue

      .. image:: oechemtk/images/OELightBlue.*

   .. oe:constant:: OELightBrown

      .. image:: oechemtk/images/OELightBrown.*

   .. oe:constant:: OELightGreen

      .. image:: oechemtk/images/OELightGreen.*

   .. oe:constant:: OELightGrey

      .. image:: oechemtk/images/OELightGrey.*

   .. oe:constant:: OELightOrange

      .. image:: oechemtk/images/OELightOrange.*

   .. oe:constant:: OELightPurple

      .. image:: oechemtk/images/OELightPurple.*

   .. oe:constant:: OELightSalmon

      .. image:: oechemtk/images/OELightSalmon.*

   .. oe:constant:: OELimeGreen

      .. image:: oechemtk/images/OELimeGreen.*

   .. oe:constant:: OEMagenta

      .. image:: oechemtk/images/OEMagenta.*

   .. oe:constant:: OEMandarin

      .. image:: oechemtk/images/OEMandarin.*

   .. oe:constant:: OEMediumBlue

      .. image:: oechemtk/images/OEMediumBlue.*

   .. oe:constant:: OEMediumBrown

      .. image:: oechemtk/images/OEMediumBrown.*

   .. oe:constant:: OEMediumGreen

      .. image:: oechemtk/images/OEMediumGreen.*

   .. oe:constant:: OEMediumOrange

      .. image:: oechemtk/images/OEMediumOrange.*

   .. oe:constant:: OEMediumPurple

      .. image:: oechemtk/images/OEMediumPurple.*

   .. oe:constant:: OEMediumSalmon

      .. image:: oechemtk/images/OEMediumSalmon.*

   .. oe:constant:: OEMediumYellow

      .. image:: oechemtk/images/OEMediumYellow.*

   .. oe:constant:: OEOliveBrown

      .. image:: oechemtk/images/OEOliveBrown.*

   .. oe:constant:: OEOliveGreen

      .. image:: oechemtk/images/OEOliveGreen.*

   .. oe:constant:: OEOliveGrey

      .. image:: oechemtk/images/OEOliveGrey.*

   .. oe:constant:: OEOrange

      .. image:: oechemtk/images/OEOrange.*

   .. oe:constant:: OEPewter

      .. image:: oechemtk/images/OEPewter.*

   .. oe:constant:: OEPink

      .. image:: oechemtk/images/OEPink.*

   .. oe:constant:: OEPinkTint

      .. image:: oechemtk/images/OEPinkTint.*

   .. oe:constant:: OEPurple

      .. image:: oechemtk/images/OEPurple.*

   .. oe:constant:: OERed

      .. image:: oechemtk/images/OERed.*

   .. oe:constant:: OERedOrange

      .. image:: oechemtk/images/OERedOrange.*

   .. oe:constant:: OERoyalBlue

      .. image:: oechemtk/images/OERoyalBlue.*

   .. oe:constant:: OESeaGreen

      .. image:: oechemtk/images/OESeaGreen.*

   .. oe:constant:: OESilver

      .. image:: oechemtk/images/OESilver.*

   .. oe:constant:: OESkyBlue

      .. image:: oechemtk/images/OESkyBlue.*

   .. oe:constant:: OETransparentColor

      The color that can be used to generate images with
      transparent background.

      .. seealso::

         * :ref:`section_mol_display_transparent` section in the **OEDepict TK** manual

   .. oe:constant:: OEViolet

      .. image:: oechemtk/images/OEViolet.*

   .. oe:constant:: OEWhite

      .. image:: oechemtk/images/OEWhite.*

   .. oe:constant:: OEYellow

      .. image:: oechemtk/images/OEYellow.*

   .. oe:constant:: OEYellowTint

      .. image:: oechemtk/images/OEYellowTint.*


.. _OESystemConstants:

*******************
OESystem Constants
*******************

.. oe:namespace:: OESystem

.. toctree::

   OEAnnotationPrimitive
   OEAnnotationRenderHint
   OEErrorLevel
   OEGridFileType
   OEGridMaskType
   OEGridType
   OEMemPoolMode
   OEMTZMapType
   OERecordReturnCode
   OESystem
   OEThrow
   OEParamVisibility


.. oe:namespace:: OESystem

.. oe:constnamespace:: OEThrow

   This is the globally available error handler that is used to
   report all diagnostics generated by the *OEChem*, *OESystem* and *OEPlatform* libraries. The behavior of :oe:constns:`OESystem::OEThrow`
   may be customized via the various methods available to
   :ref:`OEErrorHandler <OESystem_OEErrorHandler>`. For example, warning and error
   messages may be redirected to a file or string stream, instead of to
   :oe:const:`OEPlatform::OEPlatform::oeerr` (the default).

   **Example**

   .. oe:source:: OEThrowFile.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEThrowFile

   .. oe:source:: OEThrowFile.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEThrowFile

   .. oe:source:: OEThrowFile.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEThrowFile

   .. oe:source:: OEThrowFile.cs
      :language: cs
      :noindent:
      :frag:     SNIPPET-OEThrowFile



*******************************************************************************
Preliminary OESystem Constants
*******************************************************************************

.. oe:namespace:: OESystem

.. toctree::

   OEOptsConfigureStatus.rst
   Types.rst

..  oe:language:: python c++

    .. toctree::

       OEMetadata.rst


.. oe:namespace:: OEDataFlow

..  _OEDataFlow_Types:

.. oe:constnamespace:: Types

   The :oe:constns:`OEDataFlow::Types` namespace contains a number
   of :ref:`OEFieldType <OEDataFlow_OEFieldType>` objects. These are used
   as arguments to the :ref:`OEMakeField <OEDataFlow_OEMakeField>` function,
   to indicate the data type of the field to be created.

   The following table shows the members of the :oe:constns:`OEDataFlow::Types`
   namespace and the corresponding value types.

   ===================== ========================================
   `Types` member        Type stored on OERecord
   ===================== ========================================
   Int                   OELongLong (64-bit signed int)
   Float                 double
   String                std::string
   Bool                  bool
   Blob                  std::vector<unsigned char>
   Range                 :ref:`OERange <OEDataFlow_OERange>`
   Record                :ref:`OERecord <OEDataFlow_OERecord>`
   Chem::Mol             :ref:`OEMol <OEChem_OEMol>`
   Chem::DesignUnit      :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
   Chem::Grid            :ref:`OEScalarGrid <OESystem_OEScalarGrid>`
   Chem::SkewGrid        :ref:`OESkewGrid <OESystem_OESkewGrid>`
   Chem::FingerPrint     :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`
   Chem::Surface         :ref:`OESurface <OESpicoli_OESurface>`
   Chem::ShapeQuery      :ref:`OEShapeQuery <OEShape_OEShapeQuery>`

   IntVec                std::vector<OELongLong>
   FloatVec              std::vector<double>
   StringVec             std::vector<std::string>
   BoolVec               std::vector<bool>
   BlobVec               std::vector<std::vector<unsigned char>>
   RecordVec             std::vector<OERecord>
   Chem::MolVec          std::vector<OEMol>
   Chem::GridVec         std::vector<OEScalarGrid>
   Chem::SkewGridVec     std::vector<OESkewGrid>
   Chem::FingerPrintVec  std::vector<OEFingerPrint>
   Chem::SurfaceVec      std::vector<OESurface>
   Chem::ShapeQueryVec   std::vector<OEShapeQuery>
   ===================== ========================================

   .. note::
      
      The types not defined in the OESystem namespace are not available 
      until the higher level toolkits have been initialized.

   .. seealso::

      * :ref:`OEMakeField <OEDataFlow_OEMakeField>`


.. # split from OESystemFunctions.rst:7

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAddContour

.. oe:function:: OEAddContour

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddContour(OEGridAbstractBase& grid, float level,
                           const OEColor& c)

   .. oe:language:: python

      .. oe:api:: python

         OEAddContour(grid: OEGridAbstractBase, level: float, c: OEColor) -> None

   Adds a grid contour at 'level' to the 'grid'  (:ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>`)
   with the color 'c'.

   .. note::

     Contours are only persistent if written to OEBinary (``.oeb``).

   .. seealso::

      * :oe:func:`OESystem::OEGetContourLevel`
      * :oe:func:`OESystem::OEGetContourColor`
      * :oe:func:`OESystem::OENumContours`



.. # split from OESystemFunctions.rst:26

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAddGrid

.. oe:function:: OEAddGrid

   .. oe:api::

      template<class GridType1, class GridType2>
      bool OEAddGrid(GridType1& grid1, const GridType2& grid2)



.. # split from OESystemFunctions.rst:34

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAnnotateArrow

.. oe:function:: OEAnnotateArrow

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAnnotation OEAnnotateArrow(const char* title, float* A, float* B,
                                      float percentCylinder, float r1,
                                      float r2, float r3)

   .. oe:language:: python

      .. oe:api:: python

         OEAnnotateArrow(title: str, A: OEFloatArray, B: OEFloatArray,
                         percentCylinder: float, r1: float, r2: float,
                         r3: float) -> OEAnnotation



.. # split from OESystemFunctions.rst:42

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAnnotateBox

.. oe:function:: OEAnnotateBox

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAnnotation OEAnnotateBox(const char* title, float* center,
                                    float* extents)

   .. oe:language:: python

      .. oe:api:: python

         OEAnnotateBox(title: str, center: OEFloatArray, extents: OEFloatArray) -> OEAnnotation



.. # split from OESystemFunctions.rst:49

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAnnotateCylinder

.. oe:function:: OEAnnotateCylinder

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAnnotation OEAnnotateCylinder(const char* title, float* A, float* B,
                                         float r1, float r2)

   .. oe:language:: python

      .. oe:api:: python

         OEAnnotateCylinder(title: str, A: OEFloatArray, B: OEFloatArray,
                            r1: float, r2: float) -> OEAnnotation



.. # split from OESystemFunctions.rst:57

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAnnotateEllipsoid

.. oe:function:: OEAnnotateEllipsoid

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAnnotation OEAnnotateEllipsoid(const char* title, float* center,
                                          float a, float b, float c,
                                          float* dir1, float* dir2, float* dir3)

   .. oe:language:: python

      .. oe:api:: python

         OEAnnotateEllipsoid(title: str, center: OEFloatArray, a: float,
                             b: float, c: float, dir1: OEFloatArray,
                             dir2: OEFloatArray, dir3: OEFloatArray) -> OEAnnotation



.. # split from OESystemFunctions.rst:66

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAnnotateLine

.. oe:function:: OEAnnotateLine

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAnnotation OEAnnotateLine(const char* title, float* A, float* B)

   .. oe:language:: python

      .. oe:api:: python

         OEAnnotateLine(title: str, A: OEFloatArray, B: OEFloatArray) -> OEAnnotation



.. # split from OESystemFunctions.rst:73

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAnnotateSphere

.. oe:function:: OEAnnotateSphere

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAnnotation OEAnnotateSphere(const char* title, float* center,
                                       float radius,
                                       float* hemisphereDirection = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEAnnotateSphere(title: str, center: OEFloatArray, radius: float,
                          hemisphereDirection: OEFloatArray = None) -> OEAnnotation



.. # split from OESystemFunctions.rst:81

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAnnotateSpline

.. oe:function:: OEAnnotateSpline

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAnnotation OEAnnotateSpline(const char* title, float* coords,
                                       unsigned int numPoints,
                                       unsigned int splineResolution)

   .. oe:language:: python

      .. oe:api:: python

         OEAnnotateSpline(title: str, coords: OEFloatArray, numPoints: int,
                          splineResolution: int) -> OEAnnotation



.. # split from OESystemFunctions.rst:90

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAnnotateSplineSurface

.. oe:function:: OEAnnotateSplineSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAnnotation OEAnnotateSplineSurface(const char* title, float* coords,
                                              unsigned int numPoints,
                                              unsigned int splineResolution,
                                              int segmentResolution,
                                              int crossResolution, float width,
                                              float thickness, int splineType,
                                              int style)

   .. oe:language:: python

      .. oe:api:: python

         OEAnnotateSplineSurface(title: str, coords: OEFloatArray,
                                 numPoints: int, splineResolution: int,
                                 segmentResolution: int, crossResolution: int,
                                 width: float, thickness: float,
                                 splineType: int, style: int) -> OEAnnotation



.. # split from OESystemFunctions.rst:102

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAnnotateSymbol

.. oe:function:: OEAnnotateSymbol

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAnnotation OEAnnotateSymbol(const char* title, float* A,
                                       const char* symbol)

   .. oe:language:: python

      .. oe:api:: python

         OEAnnotateSymbol(title: str, A: OEFloatArray, symbol: str) -> OEAnnotation



.. # split from OESystemFunctions.rst:109

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAnnotateText

.. oe:function:: OEAnnotateText

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAnnotation OEAnnotateText(const char* title, float* A,
                                     const char* text)

   .. oe:language:: python

      .. oe:api:: python

         OEAnnotateText(title: str, A: OEFloatArray, text: str) -> OEAnnotation



.. # split from OESystemFunctions.rst:116

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAnnotateTorus

.. oe:function:: OEAnnotateTorus

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAnnotation OEAnnotateTorus(const char* title, float* A, float r1,
                                      float r2, float* direction)

   .. oe:language:: python

      .. oe:api:: python

         OEAnnotateTorus(title: str, A: OEFloatArray, r1: float, r2: float,
                         direction: OEFloatArray) -> OEAnnotation



.. # split from OESystemFunctions.rst:124

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEAttachData

.. oe:function:: OEAttachData
   
   .. oe:language:: c++

      .. oe:api::

         void OEAttachData(const OEUnknownOEBData &, ...)
         void OEAttachData(const OEUnknownOEBData &, OEBase &)
         void OEAttachData(const OEUnknownOEBData &, OEBase *)



.. # split from OESystemFunctions.rst:133

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBDataLengthBytes

.. oe:function:: OEBDataLengthBytes

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEBDataLengthBytes(OEULongLong)
         unsigned int OEBDataLengthBytes(unsigned int)

   .. oe:language:: python

      .. oe:api:: python

         OEBDataLengthBytes(arg1: OEULongLong) -> int
         OEBDataLengthBytes(arg1: int) -> int



.. # split from OESystemFunctions.rst:155

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBFPosTEndian

.. oe:function:: OEBFPosTEndian

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned char OEBFPosTEndian()
         bool OEBFPosTEndian(unsigned int)

   .. oe:language:: python

      .. oe:api:: python

         OEBFPosTEndian() -> str
         OEBFPosTEndian(arg1: int) -> bool

   The first overload returns a character representing the endian-ness
   of a ``oefpos_t`` so that ``oefpos_t`` data can be directly written to a
   file. The second overload interprets this character and returns
   ``true`` if the data will need to be swapped to match the current
   machine endian-ness.



.. # split from OESystemFunctions.rst:141

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBFloatEndian

.. oe:function:: OEBFloatEndian

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned char OEBFloatEndian()
         bool OEBFloatEndian(unsigned int)

   .. oe:language:: python

      .. oe:api:: python

         OEBFloatEndian() -> str
         OEBFloatEndian(arg1: int) -> bool

   The first overload returns a character representing the endian-ness
   of a ``float`` or ``double`` so that ``float`` or ``double`` data
   can be directly written to a file. The second overload interprets
   this character and returns ``true`` if the data will need to be
   swapped to match the current machine endian-ness.



.. # split from OESystemFunctions.rst:169

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBIntEndian

.. oe:function:: OEBIntEndian

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned char OEBIntEndian()
         bool OEBIntEndian(unsigned int)

   .. oe:language:: python

      .. oe:api:: python

         OEBIntEndian() -> str
         OEBIntEndian(arg1: int) -> bool

   The first overload returns a character representing the endian-ness
   of a ``int`` or ``unsigned int`` so that ``int`` or ``unsigned
   int`` data can be directly written to a file. The second overload
   interprets this character and returns ``true`` if the data will
   need to be swapped to match the current machine endian-ness.



.. # split from OESystemFunctions.rst:182

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBPeekTag

.. oe:function:: OEBPeekTag

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBPeekTag(OEPlatform::oeistream& ifs, char* tag)
         bool OEBPeekTag(OEPlatform::oeistream& ifs, char* tag,
                         unsigned char& tagtype)

   .. oe:language:: python

      .. oe:api:: python

         OEBPeekTag(ifs: oeistream, tag: str) -> bool
         OEBPeekTag(ifs: oeistream, tag: str, tagtype: str) -> bool



.. # split from OESystemFunctions.rst:190

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBReadData

.. attention::

   |CPPONLY|

.. oe:function:: OEBReadData

   .. oe:api::

      template<class T>
      bool OEBReadData(OEPlatform::oeistream& ifs, T& t, bool swab)
      template<class T>
      bool OEBReadData(OEPlatform::oeistream& ifs, T t, size_t nbytes,
                       bool swab)


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBReadDataLength

.. oe:function:: OEBReadDataLength

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEULongLong OEBReadDataLength(OEPlatform::oeistream &,
                                       OEULongLong maxLen = UINT_MAX)

   .. oe:language:: python

      .. oe:api:: python

         OEBReadDataLength(arg1: oeistream, maxLen: OEULongLong = UINT_MAX) -> OEULongLong

   Reads a variable length encoding integer from a binary file.


.. # split from OESystemFunctions.rst:208

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBReadOEBase

.. oe:function:: OEBReadOEBase

   .. oe:api::

      unsigned int OEBReadOEBase(OEPlatform::oeistream& ifs, OEBase& base,
                                 OEULongLong len,
                                 const OEBinaryIOHandlerBase& handler)



.. # split from OESystemFunctions.rst:217

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBReadPOD

.. oe:function:: OEBReadPOD

   .. oe:api::

      unsigned int OEBReadPOD(OEPlatform::oeistream& ifs, OEBase& b,
                              OEULongLong len)



.. # split from OESystemFunctions.rst:224

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBReadTag

.. oe:function:: OEBReadTag

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBReadTag(OEPlatform::oeistream& ifs, char* tag)
         bool OEBReadTag(OEPlatform::oeistream& ifs, char* tag,
                         unsigned char& tagtype)

   .. oe:language:: python

      .. oe:api:: python

         OEBReadTag(ifs: oeistream, tag: str) -> bool
         OEBReadTag(ifs: oeistream, tag: str, tagtype: str) -> bool



.. # split from OESystemFunctions.rst:232

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBShortEndian

.. oe:function:: OEBShortEndian

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned char OEBShortEndian()
         bool OEBShortEndian(unsigned int)

   .. oe:language:: python

      .. oe:api:: python

         OEBShortEndian() -> str
         OEBShortEndian(arg1: int) -> bool

   The first overload returns a character representing the endian-ness
   of a ``short`` so that ``short`` data can be directly written to a
   file. The second overload interprets this character and returns
   ``true`` if the data will need to be swapped to match the current
   machine endian-ness.



.. # split from OESystemFunctions.rst:253

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBWriteData

.. oe:function:: OEBWriteData

   .. oe:api::

      template<class T>
      bool OEBWriteData(OEPlatform::oeostream& ofs, const T& t)

   Write the binary representation of ``t`` to the file stream
   ``ofs``. It is assumed the endian-ness will be stored in a separate
   part of the file to help with decoding later. Returns ``true`` if
   all the data was successfully written.



.. # split from OESystemFunctions.rst:245

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBWriteDataLength

.. oe:function:: OEBWriteDataLength

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBWriteDataLength(OEPlatform::oeostream &, OEULongLong)
         bool OEBWriteDataLength(OEPlatform::oeostream &, unsigned int)

   .. oe:language:: python

      .. oe:api:: python

         OEBWriteDataLength(arg1: oeostream, arg2: OEULongLong) -> bool
         OEBWriteDataLength(arg1: oeostream, arg2: int) -> bool



.. # split from OESystemFunctions.rst:265

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBWriteOEBase

.. oe:function:: OEBWriteOEBase

   .. oe:api::

      bool OEBWriteOEBase(OEPlatform::oeostream &, const OEBase &,
                          const std::string &,
                          const OEBinaryIOHandlerBase& hand)



.. # split from OESystemFunctions.rst:273

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBWritePOD

.. oe:function:: OEBWritePOD

   .. oe:api::

      bool OEBWritePOD(OEPlatform::oeostream &, const OEBase &,
                       const std::string &)



.. # split from OESystemFunctions.rst:280

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBWriteTag

.. oe:function:: OEBWriteTag

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBWriteTag(OEPlatform::oeostream& ofs, const char *)
         bool OEBWriteTag(OEPlatform::oeostream& ofs, const char *,
                          unsigned char tagtype)

   .. oe:language:: python

      .. oe:api:: python

         OEBWriteTag(ofs: oeostream, arg2: str) -> bool
         OEBWriteTag(ofs: oeostream, arg2: str, tagtype: str) -> bool



.. # split from OESystemFunctions.rst:327

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBitIsPowerOf2

.. oe:function:: OEBitIsPowerOf2

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBitIsPowerOf2(unsigned int bitmask,
                              const bool allowZero = false)

   .. oe:language:: python

      .. oe:api:: python

         OEBitIsPowerOf2(bitmask: int, allowZero: bool = False) -> bool

   Returns ``true`` if ``bitmask`` is a power of 2; otherwise, it returns ``false``.

   allowZero
      If this value is set to ``true``, 0 is considered a power of 2. The default
      is ``false``.


.. # split from OESystemFunctions.rst:327

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBitVectorAnd

.. oe:function:: OEBitVectorAnd

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEBitVector OEBitVectorAnd(const OEBitVector& a, const OEBitVector& b)

   .. oe:language:: python

      .. oe:api:: python

         OEBitVectorAnd(a: OEBitVector, b: OEBitVector) -> OEBitVector

   Returns boolean conjunction (or 'and')
   of two :oe:cls:`OEBitVectors<OESystem::OEBitVector>`.
   The result will have the same number of bits
   as the larger of the two arguments.

   .. oe:language:: c++

      This function is identical to
      the ``operator&`` operation of two
      :oe:cls:`OEBitVectors<OESystem::OEBitVector>`.



.. # split from OESystemFunctions.rst:345

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBitVectorEqual

.. oe:function:: OEBitVectorEqual

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBitVectorEqual(const OEBitVector& a, const OEBitVector& b)

   .. oe:language:: python

      .. oe:api:: python

         OEBitVectorEqual(a: OEBitVector, b: OEBitVector) -> bool

   Determines whether two :oe:cls:`OEBitVectors<OESystem::OEBitVector>`
   are considered equal. The two :oe:cls:`OEBitVectors<OESystem::OEBitVector>`
   are only considered equal
   if they have the same size, *i.e.* ``a.GetSize() == b.GetSize()``, and all
   of the bits have the same value.



.. # split from OESystemFunctions.rst:357

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBitVectorNot

.. oe:function:: OEBitVectorNot

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEBitVector OEBitVectorNot(const OEBitVector& bv)

   .. oe:language:: python

      .. oe:api:: python

         OEBitVectorNot(bv: OEBitVector) -> OEBitVector

   Returns the boolean negation (or 'inversion') of an
   :ref:`OEBitVector <OESystem_OEBitVector>`.
   The result will have the same number of bits as the argument.

   .. oe:language:: c++

      This function is identical to
      the ``operator~`` operation of two
      :oe:cls:`OEBitVectors<OESystem::OEBitVector>`.



.. # split from OESystemFunctions.rst:374

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBitVectorNumBytes

.. oe:function:: OEBitVectorNumBytes

   .. oe:language:: c++ java csharp

      .. oe:api::

         inline size_t OEBitVectorNumBytes(size_t bits)

   .. oe:language:: python

      .. oe:api:: python

         OEBitVectorNumBytes(bits: int) -> int

   Returns the number of words required to store the number of bits
   passed as the ``bits`` parameter, rounded up to a multiple of
   machine word size.



.. # split from OESystemFunctions.rst:385

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBitVectorNumWords

.. oe:function:: OEBitVectorNumWords

   .. oe:language:: c++ java csharp

      .. oe:api::

         inline size_t OEBitVectorNumWords(size_t bits)

   .. oe:language:: python

      .. oe:api:: python

         OEBitVectorNumWords(bits: int) -> int

   Returns the number of words required to store the number of bits
   passed as the ``bits`` parameter.



.. # split from OESystemFunctions.rst:395

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBitVectorOr

.. oe:function:: OEBitVectorOr

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEBitVector OEBitVectorOr(const OEBitVector& a, const OEBitVector& b)

   .. oe:language:: python

      .. oe:api:: python

         OEBitVectorOr(a: OEBitVector, b: OEBitVector) -> OEBitVector

   Returns the boolean disjunction (or 'or') of two
   :oe:cls:`OEBitVectors<OESystem::OEBitVector>`.
   The result will have the same number of bits as the larger of the two arguments.

   .. oe:language:: c++

      This function is identical to
      the ``operator|`` operation of two
      :oe:cls:`OEBitVectors<OESystem::OEBitVector>`.



.. # split from OESystemFunctions.rst:412

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBitVectorSub

.. oe:function:: OEBitVectorSub

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEBitVector OEBitVectorSub(const OEBitVector& a, const OEBitVector& b)

   .. oe:language:: python

      .. oe:api:: python

         OEBitVectorSub(a: OEBitVector, b: OEBitVector) -> OEBitVector

   Returns the boolean difference of two
   :oe:cls:`OEBitVectors<OESystem::OEBitVector>`
   This function returns an :ref:`OEBitVector <OESystem_OEBitVector>` where each bit
   is set only if that position is set in the first operand and clear
   in the second.
   The result will have the same number of bits as the larger of the two arguments.

   .. oe:language:: c++

      This function is identical to
      the ``operator-`` operation of two
      :oe:cls:`OEBitVectors<OESystem::OEBitVector>`.



.. # split from OESystemFunctions.rst:432

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEBitVectorXor

.. oe:function:: OEBitVectorXor

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEBitVector OEBitVectorXor(const OEBitVector& a, const OEBitVector& b)

   .. oe:language:: python

      .. oe:api:: python

         OEBitVectorXor(a: OEBitVector, b: OEBitVector) -> OEBitVector

   Returns that Boolean exclusive or (or 'xor') of two
   :oe:cls:`OEBitVectors<OESystem::OEBitVector>`.
   This function returns an :ref:`OEBitVector <OESystem_OEBitVector>`
   where each bit is set only if the equivalent bit positions in the
   two operands have different values. The result will have the same
   number of bits as the large of the two arguments.

   .. oe:language:: c++

      This function is identical to
      the ``operator^`` operation of two
      :oe:cls:`OEBitVectors<OESystem::OEBitVector>`.



.. # split from OESystemFunctions.rst:451

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OECastData

.. attention::

   |CPPONLY|

.. oe:function:: OECastData

   .. oe:api::

      template<class T>
      const T& OECastData(OEBaseData* b)


.. # split from OESystemFunctions.rst:459

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OECheckHelp

.. oe:function:: OECheckHelp

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECheckHelp(const OEInterface& itf, int argc, char** argv,
                          bool help_for_no_args = true,
                          OEPlatform::oeostream& ostr = OEERR)

   .. oe:language:: python

      .. oe:api:: python

         OECheckHelp(itf: OEInterface, input: List[str],
                     help_for_no_args: bool = True, ostr: oeostream = oeerr) -> bool

   Return ``true`` if ``--help`` is specified on the commandline given by
   the ``argc`` and ``argv`` arguments. If ``--help`` was found, print
   out a help message to the stream specified by the ``ostr``
   argument, by default, standard error. The ``--help`` flag can also
   be passed as an argument to cause detailed information to be printed
   about that parameter.

   .. seealso::

      Most users should not need to call this function directly. The
      :ref:`OEInterface <OESystem_OEInterface>` constructor and
      :oe:func:`OESystem::OEParseCommandLine` call this function
      internally.



.. # split from OESystemFunctions.rst:481

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEClearGridBoundary

.. oe:function:: OEClearGridBoundary

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEClearGridBoundary(OESystem::OEScalarGrid& grid)

   .. oe:language:: python

      .. oe:api:: python

         OEClearGridBoundary(grid: OEScalarGrid) -> bool

   Assigns ``0.0`` to every grid point located at the edge of a 'grid'
   (:ref:`OEScalarGrid <OESystem_OEScalarGrid>`).

.. ################################################################
   #
   ################################################################



.. # split from OESystemFunctions.rst:495

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEColorCreate

.. oe:function:: OEColorCreate

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEColor OEColorCreate(double r, double g, double b)
         OEColor OEColorCreate(double r, double g, double b, double a)

   .. oe:language:: python

      .. oe:api:: python

         OEColorCreate(r: float, g: float, b: float) -> OEColor
         OEColorCreate(r: float, g: float, b: float, a: float) -> OEColor

   Creates a color with the specified color components that are mapped
   into the internal representation in the range ``[0, 255]``.

   *r, g, b*
      The red, green and blue components of the color.
      These numbers have to be in the range ``[0.0, 1.0]``.
      Setting a color to be opaque black is equivalent to
      :oe:func:`OESystem::OEColorSet` (0.0, 0.0, 0.0).

   *a*
      The alpha value defines the transparency of a color and can be
      represented by a float value in the range ``[0.0, 1.0]``.
      An alpha value of ``1.0`` means that the color is completely opaque and
      an alpha value of ``0.0``  means that the color is completely transparent.
      If the alpha value is not specified, then a completely opaque
      color is created.

   .. note::

      The components of the color are always clamped into the range
      ``[0, 255]`` that is the internal representation of the color.

   .. seealso::

      * :ref:`OEColor <OESystem_OEColor>` class

.. ################################################################
   #
   ################################################################



.. # split from OESystemFunctions.rst:534

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEColorGet

.. oe:function:: OEColorGet

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEColorGet(const OEColor &, float& r, float& g, float& b)
         void OEColorGet(const OEColor &, double& r, double& g, double& b)
         void OEColorGet(const OEColor &, float& r, float& g, float& b,
                         float& a)
         void OEColorGet(const OEColor &, double& r, double& g, double& b,
                         double& a)

   .. oe:language:: python

      .. oe:api:: python

         OEColorGet(arg1: OEColor, r: float, g: float, b: float) -> None
         OEColorGet(arg1: OEColor, r: float, g: float, b: float, a: float) -> None

   Converts the internal unsigned integer representation of the color
   components into floating point numbers in the range ``[0.0, 1.0]``.

   *r, g, b, a*
      The red, green, blue and alpha components of the color.

   .. seealso::

      * :ref:`OEColor <OESystem_OEColor>` class
      * :oe:func:`OESystem::OEColorSet` function

.. ################################################################
   #
   ################################################################



.. # split from OESystemFunctions.rst:559

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEColorPacked

.. oe:function:: OEColorPacked

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEColorPacked(unsigned int r, unsigned int g,
                                    unsigned int b, unsigned int a = 255)

   .. oe:language:: python

      .. oe:api:: python

         OEColorPacked(r: int, g: int, b: int, a: int = 255) -> int

.. ################################################################
   #
   ################################################################



.. # split from OESystemFunctions.rst:571

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEColorSet

.. oe:function:: OEColorSet

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEColorSet(OEColor &, double r, double g, double b)
         void OEColorSet(OEColor &, double r, double g, double b, double a)

   .. oe:language:: python

      .. oe:api:: python

         OEColorSet(arg1: OEColor, r: float, g: float, b: float) -> None
         OEColorSet(arg1: OEColor, r: float, g: float, b: float, a: float) -> None

   Sets a color with the specified color components that are mapped
   into the internal representation in the range ``[0, 255]``.

   *r, g, b*
      The red, green and blue components of the color.
      These numbers have to be in the range ``[0.0, 1.0]``.
      Setting a color to be opaque black is equivalent to
      :oe:func:`OESystem::OEColorSet` (0.0, 0.0, 0.0).

   *a*
      The alpha value defines the transparency of a color and can be
      represented by a float value in the range ``[0.0, 1.0]``.
      An alpha value of ``1.0`` means that the color is completely opaque and
      an alpha value of ``0.0``  means that the color is completely transparent.
      If the alpha value is not specified, then a completely opaque
      color is created.

   .. note::

      The components of the color are always clamped into the range
      ``[0, 255]`` that is the internal representation of the color.

   .. seealso::

      * :ref:`OEColor <OESystem_OEColor>` class
      * :oe:func:`OESystem::OEColorGet` function

.. ################################################################
   #
   ################################################################



.. # split from OESystemFunctions.rst:611

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEConfigure

.. oe:function:: OEConfigure

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigure(OEInterface& itf, OEPlatform::oeistream& istr)
         bool OEConfigure(OEInterface& itf, const unsigned char* dataptr)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigure(itf: OEInterface, istr: oeistream) -> bool
         OEConfigure(itf: OEInterface, itfdata: str) -> bool

   Provides a mechanism for adding parameters and child
   :ref:`OEInterface <OESystem_OEInterface>`'s to an :ref:`OEInterface <OESystem_OEInterface>` object, itf, by parsing a
   specifically formatted text file. The text file must be converted
   into a null terminated character array at compile time, and passed
   as the configdata to this function. The format of the config file
   is a series of parameter or category records.

   When :oe:func:`OESystem::OEConfigure` encounters a parameter record, it adds an
   :ref:`OEParameter <OESystem_OEParameter>` object to the :ref:`OEInterface <OESystem_OEInterface>`.
   A parameter record takes the following form.

   .. code-block:: bash

      !PARAMETER <name> [order priority]
        !TYPE <type>
        !ALIAS <alias>
        !BRIEF <brief description>
        !DEFAULT <default value>
        !REQUIRED <true or false>
        !VISIBILITY <visibility>
        !KEYLESS <keyless setting>
        !LEGAL_VALUE <value>
        !ILLEGAL_VALUE <value>
        !LEGAL_RANGE <hi value> <low value>
        !ILLEGAL_RANGE <hi_value> <low_value>
        !DETAIL
          <detailed description line 1>
          <detailed description line 2>
          <detailed description line 3>
          .
          .
          .
      !END

   The order of individual fields appear within the parameter record
   is unimportant. Each parameter record must begin with ``!PARAMETER``
   and end with ``!END``, and each record must have a ``!TYPE`` field. All
   other fields within the parameter record are optional. So the
   simplest possible parameter record is.

   .. code-block:: bash

      !PARAMETER <name> [order priority]
        !TYPE <type>
      !END

   When :oe:func:`OESystem::OEConfigure` parses this record it does the
   equivalent of the
   following C++ code.

   .. code-block:: c++

      OEParameter* param = itf.AddParameter(<type>);
      param->SetName(<name>);
      param->SetOrderPriority([order priority]);

   If [order priority] isn't specified, zero is assumed.

   Legitimate values of <type> are

   *string*
       Creates a ``std::string`` parameter
   *double*
       Creates a double parameter
   *float*
       Creates a float parameter
   *bool*
       Creates a bool parameter
   *int*
       Creates an int parameter
   *file*
       Creates a :ref:`oeisstream <OEPlatform_oeisstream>` parameter
   *param_file*
       Creates a :ref:`oeisstream <OEPlatform_oeisstream>` parameter that is recognized as a
       text file holding parameter settings, by :oe:func:`OESystem::OEParseCommandLine`.

   The remaining fields in a parameter record are optional and do the following:

   **!ALIAS**
       *alias*

       .. code-block:: c++

          param->AddAlias(alias);

       This field can appear multiple times.

   **!BRIEF**
       *brief description*

       .. code-block:: c++

          param->SetBrief(brief description);

       This field can only appear once.

   **!DEFAULT**
       *default value*

       .. code-block:: c++

           param->SetStringDefault(default value);

       This field can only appear once.

   **!REQUIRED**
       *true* or *false*

       .. code-block:: c++

          param->SetRequired(true or false);

       This field can only appear once.

   **!VISIBILITY**
       *visibility*

       Visibility must be either `simple`, `normal` or `hidden`
       This causes either:

       .. code-block:: c++

          param->SetVisibility(OEParamVisibility::Simple);
          param->SetVisibility(OEParamVisibility::Normal);
          param->SetVisibility(OEParamVisibility::Hidden);

       to be called respectively. This field can only appear once in a parameter record.

   **!KEYLESS**
       *keyless setting*

       .. code-block:: c++

          param->SetKeyless(keyless setting);

       The keyless setting must be a non-negative integer. This field can
       only appear once in a parameter record.

   **!LEGAL_VALUE**
       *value*

       .. code-block:: c++

          param->AddLegalValue(value);

       Parameters of type bool cannot have a ``!LEGAL_VALUE`` field. This
       field can appear multiple times in a parameter record.

   **!ILLEGAL_VALUE**
       *value*

       .. code-block:: c++

          param->AddIllegalValue(value);

       Parameters of type bool cannot have an ``!ILLEGAL_VALUE`` field. This
       field can appear multiple times in a parameter record.

   **!LEGAL_RANGE**
       *high value low value*

       .. code-block:: c++

          param->AddLegalRange(hi value, low value);

       Parameters of type bool, string, file and file_param cannot have a
       ``!LEGAL_RANGE`` field. This field can appear multiple times in a
       parameter record.

   **!ILLEGAL_RANGE**
       *high value low value*

       .. code-block:: c++

          param->AddIllegalRange(hi value, low value);

       Parameters of type bool, string, file and file_param cannot have
       an ``!ILLEGAL_RANGE`` field. This field can appear multiple times in a
       parameter record.

   **!DETAIL**
       *multi-line*

       All the lines following the ``!DETAIL`` keyword up until a line
       beginning with another parameter record keyword are added to the
       parameter.

       This field can only appear once.

   **!CATEGORY**

      *Category record format*

      When :oe:func:`OESystem::OEConfigure` encounters a category record it adds a child
      :ref:`OEInterface <OESystem_OEInterface>` object to the current :ref:`OEInterface <OESystem_OEInterface>`.
      A category record
      takes the following form:

      .. code-block:: bash

         !CATEGORY <name> [order priority]
           !DETAIL
             <detailed description line 1>
             [detailed description line 2]
             [detailed description line 3]
             .
             .
             .
           !BRIEF <brief description>
           [Parameter Record]
           [Category Record]
         !END

      The order individual fields appear within the category record is
      unimportant. All fields within the category record are optional. So
      the following is the minimal category allowed:

      .. code-block:: bash

         !CATEGORY <name> [order priority]
         !END

      When parsed by :oe:func:`OESystem::OEConfigure` is equivalent to:

      .. code-block:: c++

         OEInterface* child_itf = itf.AddInterface();
         child_itf->SetName(<name>);
         child_itf->SetOrderPriority([order priority]);

      If [order priority] is not specified 0 is assumed.

      Fields within the category record have the following meaning:

      **!DETAIL**
          *multi-line*

          All the lines following the ``!DETAIL`` keyword up until a line
          beginning with another category record keyword are added to the
          parameter.

          This field can appear once in a category record.

      **!BRIEF**
         *brief description*

       .. code-block:: c++

          param->SetBrief(brief description);

       This field can only appear once.

      **parameter record**
         Parameter records can appear inside category records. Their format
         is the same as those outside the category record, however the
         parameter will be added to the child interface. A category record
         can hold any number of parameter records.

      **category record**
         Category records can be nested within category records, thus
         creating a child :ref:`OEInterface <OESystem_OEInterface>` of a child :ref:`OEInterface <OESystem_OEInterface>`.
         There is no
         limit to the depth of nesting, and any number of nested category
         records can appear within a category record.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEConfigureItf

.. _OESystem_OEConfigureItf:

.. oe:function:: OEConfigureItf
   
   .. oe:language:: c++ java csharp
      
      .. oe:api::

         bool OEConfigureItf(OEInterface& itf, const OEOptions& opts)

   This method populates the specified :ref:`OEInterface <OESystem_OEInterface>` with parameters and child
   :ref:`OEInterface <OESystem_OEInterface>` from the specified :ref:`OEOptions <OESystem_OEOptions>`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEConfigureOpts

.. _OESystem_OEConfigureOpts:

.. oe:function:: OEConfigureOpts
      
   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEConfigureOpts(OEOptions& opts, int argc, char** argv,
                                  const bool writeSettings = true)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureOpts(opts: OEOptions, argc: int, argv: str,
                         writeSettings: bool = True) -> int

   This method configures the parameter settings of the specified :ref:`OEOptions <OESystem_OEOptions>`
   from the specified command line arguments.

   *opts*
      The interface to configure.

   *argc*
      Command line arguments count.

   *argv*
      Command line argument values.

   *writeSettings*
      If the visible parameter settings should be written in standard out. 


.. # split from OESystemFunctions.rst:887

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OECopyArray

.. attention::

   |CPPONLY|

.. oe:function:: OECopyArray

   .. oe:api::

      template<class T, class U>
      void OECopyArray(T* dst, const U* src, size_t num)
      template<class T>
      void OECopyArray(T* dst, const T* src, size_t num, OETrueType)
      template<class T, class U>
      void OECopyArray(T* dst, const U* src, size_t num, OEBoolType)



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OECopyBaseData

.. oe:function:: OECopyBaseData

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECopyBaseData(OEBase& dst, const OEBase& src)

   .. oe:language:: python

      .. oe:api:: python

         OECopyBaseData(dst: OEBase, src: OEBase) -> None

   Copy :ref:`generic data<chapter_genericdata>` from one :ref:`OEBase <OESystem_OEBase>` to
   another.

   *dst*
     The destination of the generic data.
     :oe:meth:`OESystem::OEBase::Clear` is first called on
     this object to remove all data prior to copying.

   *src*
     The source of the generic data that is copied over.


.. # split from OESystemFunctions.rst:910

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OECopyBits

.. oe:function:: OECopyBits

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OECopyBits(OEBitVector& bv, const std::vector<bool>& vb)
         void OECopyBits(std::vector<bool>& vb, const OEBitVector& bv)

   .. oe:language:: python

      .. oe:api:: python

         OECopyBits(bv: OEBitVector, vb: List[bool]) -> None
         OECopyBits(vb: List[bool], bv: OEBitVector) -> None



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OECount

.. oe:function:: OECount

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         unsigned int OECount(OEIter<T>& iter)
         template<class T>
         unsigned int OECount(OEIterBase<T>* iter)

   .. oe:language:: python

      .. oe:api:: python

         OECount(abset: OEAtomBondSet, atompred: OEUnaryAtomPred) -> int
         OECount(abset: OEAtomBondSet, bondpred: OEUnaryBondPred) -> int
         OECount(monomers: OEMonomerSet, pred: OEUnaryMonomerPred) -> int
         OECount(arg1: Union[OEGraphMol,OEMol,OEQMol], arg2: OEUnaryAtomPred) -> int
         OECount(arg1: Union[OEGraphMol,OEMol,OEQMol], arg2: OEUnaryBondPred) -> int
         OECount(arg1: Union[OEGraphMol,OEMol,OEQMol], arg2: OEUnaryGroupPred) -> int
         OECount(arg1: Union[OEGraphMol,OEMol,OEQMol], arg2: OESubSearch,
                 uniquematch: bool = False) -> int

   Count the number of elements in an iterator.

   .. note::

      These templated functions are only available in C++.
      Please see the :oe:func:`OEChem::OECount` functions
      in **OEChem TK**.

   These methods have the following behavior:

   * The OEIter version resets the iterator to the
     first element.

   * The OEIterBase version consumes the iterator.


.. # split from OESystemFunctions.rst:943

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEDivideGrid

.. oe:function:: OEDivideGrid

   .. oe:api::

      template<class GridType1, class GridType2>
      bool OEDivideGrid(GridType1& grid1, const GridType2& grid2)



.. # split from OESystemFunctions.rst:951

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEErrorLevelToString

.. oe:function:: OEErrorLevelToString

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEErrorLevelToString(unsigned int level)

   .. oe:language:: python

      .. oe:api:: python

         OEErrorLevelToString(level: int) -> str

   Return a string representation of the constants in the
   :oe:constns:`OESystem::OEErrorLevel` namespace.



.. # split from OESystemFunctions.rst:960

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEFileExtension

.. oe:function:: OEFileExtension

   .. oe:api::

      std::string OEFileExtension(const std::string& filename,
                                  const std::string& ignore)



.. # split from OESystemFunctions.rst:968

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEFileExtensions

.. oe:function:: OEFileExtensions

   .. oe:api::

      std::vector<std::string> OEFileExtensions(const std::string& filename)



.. # split from OESystemFunctions.rst:975

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetBitCounts

.. oe:function:: OEGetBitCounts

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEGetBitCounts(const OEBitVector& a, const OEBitVector& b,
                             unsigned int* onlyA, unsigned int* onlyB,
                             unsigned int* bothAB)
         void OEGetBitCounts(const OEBitVector& a, const OEBitVector& b,
                             unsigned int* onlyA, unsigned int* onlyB,
                             unsigned int* bothAB, unsigned int* neitherAB)

   .. oe:language:: python

      .. oe:api:: python

         OEGetBitCounts(a: OEBitVector, b: OEBitVector) -> (onlyA: int, onlyB: int, bothAB: int, neitherAB: int)

   Count the number of bits when comparing the two
   :ref:`OEBitVector <OESystem_OEBitVector>` arguments ``a`` and ``b``. This
   function is optimized so that the bitvectors only need to be
   traversed once.

   The counts are returned as the following arguments with the
   corresponding values.

   .. code-block:: c++

      *onlyA     =   a  & ~b;
      *onlyB     =  ~a  &  b;
      *bothAB    =   a  &  b;
      *neitherAB = ~(a  &  b);

   .. seealso::

      These values correspond with the **a**, **b**, **c**, **d**
      values found on the `Daylight theory page
      <http://www.daylight.com/dayhtml/doc/theory/theory.finger.html#RTFToC83>`_.



:orphan:

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetByteArrayFromScalarGrid

.. oe:function:: OEGetByteArrayFromScalarGrid

   .. oe:api::

      byte [] OEGetByteArrayFromScalarGrid(OEScalarGrid grid, int gtype)

   Converts a grid (:ref:`OEScalarGrid <OESystem_OEScalarGrid>`) with the file
   type, ``gtype`` (:oe:constns:`OESystem::OEGridFileType`), to byte[].

   .. seealso::

      * :oe:func:`OESystem::OEGetGridFileType` function
      * :oe:func:`OESystem::OEGetScalarGridFromByteArray` function

:orphan:

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetByteArrayFromSkewGrid

.. oe:function:: OEGetByteArrayFromSkewGrid

   .. oe:api::

      byte [] OEGetByteArrayFromSkewGrid(OESkewGrid grid, int gtype)

   Converts a grid (:ref:`OESkewGrid <OESystem_OESkewGrid>`) with the file
   type, ``gtype`` (:oe:constns:`OESystem::OEGridFileType`), to byte[].

   .. seealso::

      * :oe:func:`OESystem::OEGetGridFileType` function
      * :oe:func:`OESystem::OEGetSkewGridFromByteArray` function

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetBytesFromGrid

.. oe:function:: OEGetBytesFromGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEGetBytesFromGrid(grid: OEScalarGrid, gtype: int) - > bytes
         OEGetBytesFromGrid(grid: OESkewGrid, gtype: int) - > bytes

   .. oe:language:: python

      .. oe:api:: python

         OEGetBytesFromGrid(grid: OEScalarGrid, gType: int) -> bytes
         OEGetBytesFromGrid(grid: OESkewGrid, gType: int) -> bytes

   Converts a grid (:ref:`OEScalarGrid <OESystem_OEScalarGrid>`,
   :ref:`OESkewGrid <OESystem_OESkewGrid>`) with the file
   type, ``gtype`` (:oe:constns:`OESystem::OEGridFileType`), to bytes.

   .. seealso::

      * :oe:func:`OESystem::OEGetGridFileType` function
      * :oe:func:`OESystem::OEGetScalarGridFromBytes` function
      * :oe:func:`OESystem::OEGetSkewGridFromBytes` function

.. # split from OESystemFunctions.rst:1007

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetCenterAndExtents

.. oe:function:: OEGetCenterAndExtents

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEGetCenterAndExtents(const OESkewGrid& grid, float* center,
                                    float* extents)
         void OEGetCenterAndExtents(const OESystem::OEGridBase& grid,
                                    float* center, float* extents)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCenterAndExtents(grid: OEGridBase, center: OEFloatArray,
                               extents: OEFloatArray) -> None

.. ################################################################
   #
   ################################################################



.. # split from OESystemFunctions.rst:1022

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetColors

..  _OESystem_OEGetColors:

.. oe:function:: OEGetColors

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEIterBase<OEColor>* OEGetColors(const std::vector<OEColor>& colors)

   .. oe:language:: python

      .. oe:api:: python

         OEGetColors(colors: OEColorVec) -> Iterable[OEColor]

   Returns the iterator from the vector of specified colors in the vector order, enabling
   setting a custom color iterator.

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEIterBase<OEColor>* OEGetColors(const OEColor& fromcolor,
                                          const OEColor& tocolor,
                                          unsigned int nrcolors)

   .. oe:language:: python

      .. oe:api:: python

         OEGetColors(fromcolor: OEColor, tocolor: OEColor, nrcolors: int) -> Iterable[OEColor]

   Returns the iterator over `nrcolors` colors between the two
   given colors using a :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class.
   See example in :ref:`Figure: The ten colors that are returned from OEYellow
   to OEDarkRed colors<figure_OEGetColors>`.

   .. _figure_OEGetColors:

   .. figure:: oechemtk/images/OEGetColors.*
      :align:  center

      **The ten colors that are returned from OEYellow to OEDarkRed colors**



.. # split from OESystemFunctions.rst:1153

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetContourColor

.. oe:function:: OEGetContourColor

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEColor OEGetContourColor(const OEGridAbstractBase& grid,
                                   unsigned int idx)

   .. oe:language:: python

      .. oe:api:: python

         OEGetContourColor(grid: OEGridAbstractBase, idx: int) -> OEColor

   Returns the color for the contour associated with 'idx' from a 'grid'
   (:ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>`).

   .. seealso::

      * :oe:func:`OESystem::OEAddContour`
      * :oe:func:`OESystem::OEGetContourLevel`
      * :oe:func:`OESystem::OENumContours`



.. # split from OESystemFunctions.rst:1169

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetContourLevel

.. oe:function:: OEGetContourLevel

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEGetContourLevel(const OEGridAbstractBase& grid,
                                 unsigned int idx)

   .. oe:language:: python

      .. oe:api:: python

         OEGetContourLevel(grid: OEGridAbstractBase, idx: int) -> float

   Returns the level for the contour associated with 'idx' from a 'grid'
   (:ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>`)

   .. seealso::

      * :oe:func:`OESystem::OEAddContour`
      * :oe:func:`OESystem::OEGetContourColor`
      * :oe:func:`OESystem::OENumContours`



.. # split from OESystemFunctions.rst:1047

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetContrastColors

.. oe:function:: OEGetContrastColors

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEIterBase<OEColor>* OEGetContrastColors(bool whiteblack = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetContrastColors(whiteblack: bool = False) -> Iterable[OEColor]

   Returns the iterator over colors of maximum contrast depicted in
   :ref:`Figure: Colors of maximum contrast<figure_OEGetContrastColors>`.

   *whiteblack*
      If true, then :oe:const:`OEWhite<OESystem::OESystem::OEWhite>` and
      :oe:const:`OEBlack<OESystem::OESystem::OEBlack>` are returned as the first
      and second color by the :oe:func:`OESystem::OEGetContrastColors` function.

   .. _figure_OEGetContrastColors:

   .. figure:: oechemtk/images/OEGetContrastColors.*
      :align:  center

      **Colors of maximum contrast**

   .. _figure_OEGetContrastColors_BW:

   .. figure:: oechemtk/images/OEGetContrastColors_BW.*
      :align:  center

      **Colors of maximum contrast with white and black**

   The 22 colors depicted in :ref:`Figure: Colors of maximum contrast with white
   and black<figure_OEGetContrastColors_BW>` are called Kelly's colors.
   The order of colors in Kelly's list is designed to maximize contrast between
   colors in a set.
   The first nine colors (white, black, yellow, purple, orange, light blue, red, buff, grey)
   are selected to be discriminating even for people with
   color vision deficiency.

   .. seealso::

      * [Kelly-1965]_
      * [Green-Armytage-2010]_



.. # split from OESystemFunctions.rst:1184

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetDataType

.. oe:function:: OEGetDataType

   .. oe:api::

      template<typename T>
      const void* OEGetDataType()
      template<typename T>
      inline const void* OEGetDataType(T&)
      template<>
      const void* OEGetDataType<unsigned int>()

   These template functions provide a convenient and efficient
   mechanism for run-time type identification (RTTI). A unique
   const void pointer is returned for each requested data
   type. Template classes which derive from a base class which has
   a data type identification interface can then be resolved by
   comparisons to data types returned by the :oe:func:`OESystem::OEGetDataType` template
   function. Type comparisons are valid across compile
   units. Run-time type identification using this function is
   likely to be more efficient than built-in C++ RTTI.



.. # split from OESystemFunctions.rst:1093

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetDeepColors

.. oe:function:: OEGetDeepColors

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEIterBase<OEColor>* OEGetDeepColors()

   .. oe:language:: python

      .. oe:api:: python

         OEGetDeepColors() -> Iterable[OEColor]

   Returns the iterator over eight deep colors depicted in
   :ref:`Figure: Deep colors<figure_OEGetDeepColors>`.

   .. _figure_OEGetDeepColors:

   .. figure:: oechemtk/images/OEGetDeepColors.*
      :align:  center

   **Deep colors**



.. # split from OESystemFunctions.rst:1205

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetFileEndian

.. oe:function:: OEGetFileEndian

   .. oe:api::

      template<class T>
      bool OEGetFileEndian(unsigned int)
      template<>
      bool OEGetFileEndian<int>(unsigned int byte)
      template<>
      bool OEGetFileEndian<unsigned int>(unsigned int byte)
      template<>
      bool OEGetFileEndian<float>(unsigned int byte)
      template<>
      bool OEGetFileEndian<double>(unsigned int byte)
      template<>
      bool OEGetFileEndian<short>(unsigned int byte)
      template<>
      bool OEGetFileEndian<oefpos_t>(unsigned int byte)
      template<>
      bool OEGetFileEndian<OEPlatform::OEHalfFloat>(unsigned int byte)

   Given the endianness encoded in the ``byte``, return whether this
   machine needs to swap bytes for the given data type ``T``. Always
   returns ``false`` if ``sizeof(T)`` is 1. Will fail to compile if
   the size is greater than 1 and an explicit template specialization
   is not given.

   .. seealso::

      Designed to work in conjunction with
      :oe:func:`OESystem::OEGetHostEndian`. The byte returned by
      :oe:func:`OESystem::OEGetHostEndian` should be written to the
      output file, then :oe:func:`OESystem::OEGetFileEndian` will
      determine whether the bytes of the given type ``T`` need to be
      swapped while being read by :oe:func:`OESystem::OEBReadData`.



.. # split from OESystemFunctions.rst:1242

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetGridFileType

.. oe:function:: OEGetGridFileType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetGridFileType(const char* ext)

   .. oe:language:: python

      .. oe:api:: python

         OEGetGridFileType(ext: str) -> int

   Returns a symbolic constant from the :oe:constns:`OESystem::OEGridFileType`
   namespace for the file extension 'ext'.



.. # split from OESystemFunctions.rst:1251

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetGridFormatExtension

.. oe:function:: OEGetGridFormatExtension

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetGridFormatExtension(unsigned int tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetGridFormatExtension(tag: int) -> str

   Returns a comma-separated list of possible file extensions
   corresponding to the specified parameter. The parameter, 'tag',
   should be drawn from the :oe:constns:`OESystem::OEGridFileType`
   namespace.



.. # split from OESystemFunctions.rst:1262

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetGridFormatString

.. oe:function:: OEGetGridFormatString

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetGridFormatString(unsigned int tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetGridFormatString(tag: int) -> str

   Returns the name of the file format associated with the symbolic
   constant 'tag' from the :oe:constns:`OESystem::OEGridFileType`
   namespace.



.. # split from OESystemFunctions.rst:1272

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetHostEndian

.. attention::

   |CPPONLY|

.. oe:function:: OEGetHostEndian

   .. oe:api::

      template<class T>
      unsigned char OEGetHostEndian()
      template<>
      unsigned char OEGetHostEndian<int>()
      template<>
      unsigned char OEGetHostEndian<unsigned int>()
      template<>
      unsigned char OEGetHostEndian<float>()
      template<>
      unsigned char OEGetHostEndian<double>()
      template<>
      unsigned char OEGetHostEndian<short>()
      template<>
      unsigned char OEGetHostEndian<oefpos_t>()
      template<>
      unsigned char OEGetHostEndian<OEPlatform::OEHalfFloat>()

   Returns the endianness of this machine so it can be encoded to a
   binary output file. The byte is used to indicate whether multi-byte
   binary values will need to be swapped when read on a different
   machine.

   .. seealso::

      Designed to work in conjunction with
      :oe:func:`OESystem::OEGetFileEndian`. The byte returned by
      :oe:func:`OESystem::OEGetHostEndian` should be written to the
      output file, then :oe:func:`OESystem::OEGetFileEndian` will
      determine whether the bytes of the given type ``T`` need to be
      swapped while being read by :oe:func:`OESystem::OEBReadData`.



.. # split from OESystemFunctions.rst:1308

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetKappa

.. oe:function:: OEGetKappa

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetKappa(double prefactor)
         double OEGetKappa(const OEGaussianBase &)

   .. oe:language:: python

      .. oe:api:: python

         OEGetKappa(prefactor: float) -> float
         OEGetKappa(arg1: OEGaussianBase) -> float



.. # split from OESystemFunctions.rst:1113

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetLightColors

.. oe:function:: OEGetLightColors

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEIterBase<OEColor>* OEGetLightColors()

   .. oe:language:: python

      .. oe:api:: python

         OEGetLightColors() -> Iterable[OEColor]

   Returns the iterator over eight light colors depicted in
   :ref:`Figure: Light colors<figure_OEGetLightColors>`.

   .. _figure_OEGetLightColors:

   .. figure:: oechemtk/images/OEGetLightColors.*
      :align:  center

   **Light colors**



.. # split from OESystemFunctions.rst:1316

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetMemPoolMode

.. oe:function:: OEGetMemPoolMode

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetMemPoolMode()

   .. oe:language:: python

      .. oe:api:: python

         OEGetMemPoolMode() -> int



.. # split from OESystemFunctions.rst:1323

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetOEBReturnString

.. oe:function:: OEGetOEBReturnString

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetOEBReturnString(unsigned int idx)

   .. oe:language:: python

      .. oe:api:: python

         OEGetOEBReturnString(idx: int) -> str



.. # split from OESystemFunctions.rst:1330

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetPrefactor

.. oe:function:: OEGetPrefactor

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetPrefactor(double kappa)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPrefactor(kappa: float) -> float



.. # split from OESystemFunctions.rst:1337

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetRadius

.. oe:function:: OEGetRadius

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetRadius(const OEGaussianBase &)
         double OEGetRadius(double prefactor, double width)

   .. oe:language:: python

      .. oe:api:: python

         OEGetRadius(prefactor: float, width: float) -> float
         OEGetRadius(arg1: OEGaussianBase) -> float



:orphan:

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetScalarGridFromByteArray

.. oe:function:: OEGetScalarGridFromByteArray

   .. oe:api::

      OEScalarGrid OEGetScalarGridFromByteArray(byte[] bytes, int gType)

   Converts a byte array to a grid (:ref:`OEScalarGrid <OESystem_OEScalarGrid>`) with the file
   type, ``gtype`` (:oe:constns:`OESystem::OEGridFileType`).

   .. seealso::

      * :oe:func:`OESystem::OEGetGridFileType` function
      * :oe:func:`OESystem::OEGetByteArrayFromScalarGrid` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetScalarGridFromBytes

.. oe:function:: OEGetScalarGridFromBytes

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEGetScalarGridFromBytes(bytes: bytes, gtype: int) - > OEScalarGrid

   .. oe:language:: python

      .. oe:api:: python

         OEGetScalarGridFromBytes(bytes: bytes, gType: int) -> OEFloatGrid

   Converts bytes to a grid (:ref:`OEScalarGrid <OESystem_OEScalarGrid>`) with the file
   type, ``gtype`` (:oe:constns:`OESystem::OEGridFileType`).

   .. seealso::

      * :oe:func:`OESystem::OEGetGridFileType` function
      * :oe:func:`OESystem::OEGetBytesFromGrid` function


:orphan:

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetSkewGridFromByteArray

.. oe:function:: OEGetSkewGridFromByteArray

   .. oe:api::

      OESkewGrid OEGetSkewGridFromByteArray(byte[] bytes, int gType)

   Converts a byte array to a grid (:ref:`OESkewGrid <OESystem_OESkewGrid>`) with the file
   type, ``gtype`` (:oe:constns:`OESystem::OEGridFileType`).

   .. seealso::

      * :oe:func:`OESystem::OEGetGridFileType` function
      * :oe:func:`OESystem::OEGetByteArrayFromSkewGrid` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetSkewGridFromBytes

.. oe:function:: OEGetSkewGridFromBytes

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEGetSkewGridFromBytes(bytes: bytes, gtype: int) - > OESkewGrid

   .. oe:language:: python

      .. oe:api:: python

         OEGetSkewGridFromBytes(bytes: bytes, gType: int) -> OESkewGrid

   Converts bytes to a grid (:ref:`OESkewGrid <OESystem_OESkewGrid>`) with the file
   type, ``gtype`` (:oe:constns:`OESystem::OEGridFileType`).

   .. seealso::

      * :oe:func:`OESystem::OEGetGridFileType` function
      * :oe:func:`OESystem::OEGetBytesFromGrid` function


.. # split from OESystemFunctions.rst:1345

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetTag

.. oe:function:: OEGetTag

   Associates a text string tag with a
   corresponding unsigned integer tag. Because integer comparisons are
   often faster than character string comparisons, operations which
   require a potentially large number of data comparisons may benefit
   by using integer instead of string data. The :oe:func:`OESystem::OEGetTag` functions
   serve to associate, store and retrieve string and integer tags.

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetTag(unsigned int tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetTag(arg1: int) -> str

   Retrieves a character string tag associated with an
   integer tag. If no string tag has been associated with the passed
   integer tag, a pointer to a null-terminated pointer character
   string is returned. The function should always return a non-zero
   pointer.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetTag(const std::string& tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetTag(arg1: str) -> int

   Retrieves an integer tag associated with the
   character string stored in the STL string object. The first call to
   :oe:func:`OESystem::OEGetTag` with a particular character string creates an association
   with an arbitrary unique integer, and returns the associated
   integer tag. Subsequent calls to :oe:func:`OESystem::OEGetTag` with the same character
   string value return the associated integer tag. No guarantees are
   made regarding the allocation of integer values associated with
   character string values.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetTag(const char* tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetTag(arg1: str) -> int

   Retrieves an integer tag associated with a constant
   character string. The first call to :oe:func:`OESystem::OEGetTag` with a particular
   character string creates an association with an arbitrary unique
   integer, and returns the associated integer tag. Subsequent calls
   to :oe:func:`OESystem::OEGetTag` with the same character string value return the
   associated integer tag. No guarantees are made regarding the
   allocation of integer values associated with character string
   values.



.. # split from OESystemFunctions.rst:1391

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetThreadSafe

.. oe:function:: OEGetThreadSafe

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGetThreadSafe()

   .. oe:language:: python

      .. oe:api:: python

         OEGetThreadSafe() -> bool

   Reports  whether *OESystem* memory  allocation  uses
   thread-safe  mutual  exclusion to  access  its  data structures.  By
   default, this value is ``true``. This allows *OEChem* molecules and other
   toolkit objects  to be allocated and  deallocated simultaneously in
   concurrent operating system threads. However, for applications that
   only  have a  single thread  of execution,  the use  of thread-safe
   memory allocation  can cause a  small performance overhead  on some
   platforms. Setting  this value to ``false``,  using the :oe:func:`OESystem::OESetThreadSafe`
   function can be  used to instruct *OESystem* (and  the toolkits built
   upon it) to use faster implementations when it is known to be safe.



.. # split from OESystemFunctions.rst:1133

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetVividColors

.. oe:function:: OEGetVividColors

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEIterBase<OEColor>* OEGetVividColors()

   .. oe:language:: python

      .. oe:api:: python

         OEGetVividColors() -> Iterable[OEColor]

   Returns the iterator over eight vivid colors depicted in
   :ref:`Figure: Vivid colors<figure_OEGetVividColors>`.

   .. _figure_OEGetVividColors:

   .. figure:: oechemtk/images/OEGetVividColors.*
      :align:  center

   **Vivid colors**



.. # split from OESystemFunctions.rst:1408

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGetWidth

.. oe:function:: OEGetWidth

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetWidth(double kappa, double radius)

   .. oe:language:: python

      .. oe:api:: python

         OEGetWidth(kappa: float, radius: float) -> float



.. # split from OESystemFunctions.rst:1415

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridAvgVal

.. attention::

   This function is available in C++ and Python only.

.. oe:function:: OEGridAvgVal

   .. oe:api::

      template<class GridType>
      GridType OEGridAvgVal(const OEFixedGrid<GridType>& grid)

   Returns the average value of the ``grid``.

   .. oe:language:: python

      The following specializations exist for this template:

      =================== =============================================
      OEDoubleGridAvgVal  OESystem::OEGridAvgVal<double>
      OEFloatGridAvgVal   OESystem::OEGridAvgVal<float>
      OEIntGridAvgVal     OESystem::OEGridAvgVal<int>
      =================== =============================================



.. # split from OESystemFunctions.rst:1423
.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridCopyContents

.. attention::

   |CPPONLY|

.. oe:function:: OEGridCopyContents

   .. oe:api::

      template<class GridType>
      bool OEGridCopyContents(OEFixedGrid<GridType>& dest,
                              const OEFixedGrid<GridType>& src)



.. # split from OESystemFunctions.rst:1432
.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridCopyGeometry

.. attention::

   |CPPONLY|

.. oe:function:: OEGridCopyGeometry

   .. oe:api::

      template<class GridObject1, class GridObject2>
      bool OEGridCopyGeometry(GridObject1& dest, const GridObject2& src)



.. # split from OESystemFunctions.rst:1440

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridGetArch

.. oe:function:: OEGridGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGridGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEGridGetArch() -> str



.. # split from OESystemFunctions.rst:1447

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridGetLicensee

.. oe:function:: OEGridGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGridGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEGridGetLicensee(licensee: str) -> bool
         OEGridGetLicensee() -> str



.. # split from OESystemFunctions.rst:1454

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridGetPlatform

.. oe:function:: OEGridGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGridGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEGridGetPlatform() -> str



.. # split from OESystemFunctions.rst:1461

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridGetRelease

.. oe:function:: OEGridGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGridGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEGridGetRelease() -> str

   Returns the release name of the *OEGrid* library being used. This
   returns a value similar to ``1.0`` for production versions of the
   library, and ``1.0 debug`` for the checking version of the library.

   .. seealso::

      * :oe:func:`OESystem::OEGridGetVersion`.



.. # split from OESystemFunctions.rst:1475

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridGetSite

.. oe:function:: OEGridGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGridGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEGridGetSite(site: str) -> bool
         OEGridGetSite() -> str



.. # split from OESystemFunctions.rst:1482

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridGetVersion

.. oe:function:: OEGridGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGridGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEGridGetVersion() -> int

   Returns the version number of the *OEGrid* library being used. This
   is an unsigned integer value indicating the date on which the
   library was built, for example ``20020903``, for the 3rd of
   September 2002. This value should be used when reporting problems,
   and unlike the release string returned by the
   :oe:func:`OESystem::OEGridGetRelease` function, may be used in
   comparisons if needed.



.. # split from OESystemFunctions.rst:1497

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridHasNonZeroValue

.. oe:function:: OEGridHasNonZeroValue

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGridHasNonZeroValue(const OESystem::OESkewGrid& g)
         bool OEGridHasNonZeroValue(const OESystem::OEScalarGrid& g)

   .. oe:language:: python

      .. oe:api:: python

         OEGridHasNonZeroValue(g: OEScalarGrid) -> bool
         OEGridHasNonZeroValue(g: OESkewGrid) -> bool

   Returns whether the data in the grid 'g' (:ref:`OESkewGrid <OESystem_OESkewGrid>` or
   :ref:`OEScalarGrid <OESystem_OEScalarGrid>`) is zeroed out.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridIsLicensed

.. oe:function:: OEGridIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGridIsLicensed(const char* feature = 0,
                               unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEGridIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **OEGrid TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **OEGrid TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **OEGrid TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function



.. # split from OESystemFunctions.rst:1514

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridMaxVal

.. attention::

   This function is available in C++ and Python only.

.. oe:function:: OEGridMaxVal

   .. oe:api::

      template<class GridType>
      GridType OEGridMaxVal(const OEFixedGrid<GridType>& grid)

   Returns the maximum value of the ``grid``.

   .. oe:language:: python

      The following specializations exist for this template:

      =================== =============================================
      OEDoubleGridMaxVal  OESystem::OEGridMaxVal<double>
      OEFloatGridMaxVal   OESystem::OEGridMaxVal<float>
      OEIntGridMaxVal     OESystem::OEGridMaxVal<int>
      =================== =============================================



.. # split from OESystemFunctions.rst:1522

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridMinVal

.. attention::

   This function is available in C++ and Python only.

.. oe:function:: OEGridMinVal

   .. oe:api::

      template<class GridType>
      GridType OEGridMinVal(const OEFixedGrid<GridType>& grid)

   Returns the minimum value of the ``grid``.

   .. oe:language:: python

      The following specializations exist for this template:

      =================== =============================================
      OEDoubleGridMinVal  OESystem::OEGridMinVal<double>
      OEFloatGridMinVal   OESystem::OEGridMinVal<float>
      OEIntGridMinVal     OESystem::OEGridMinVal<int>
      =================== =============================================



.. # split from OESystemFunctions.rst:1530
.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridSameGeometry

.. attention::

   |CPPONLY|

.. oe:function:: OEGridSameGeometry

   .. oe:api::

      template<class GridObject1, class GridObject2>
      bool OEGridSameGeometry(const GridObject1& grid1,
                              const GridObject2& grid2)



.. # split from OESystemFunctions.rst:1538
.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridSetAllElements

.. attention::

   |CPPONLY|

.. oe:function:: OEGridSetAllElements

   .. oe:api::

      template<class GridType>
      void OEGridSetAllElements(OEFixedGrid<GridType>& grid,
                                const GridType& value)



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEGridSizeMultiply

.. oe:function:: OEGridSizeMultiply

   .. oe:api::

      template<typename OutputType, typename X, typename Y, typename Z>
      OutputType OEGridSizeMultiply(X xdim, Y ydim, Z zdim)

   This template method is used by **OpenEye** toolkit grid handling
   to safely multiply the 3 dimensions of a grid together while
   ensuring it does not overflow the size of the ``OutputType``
   integer type. If the multiplication of ``xdim``, ``ydim``, and
   ``zdim`` would result in an integer overflow, ``0`` will be
   returned instead. If the multiplication can be safely performed,
   the total resulting grid size is returned.


.. # split from OESystemFunctions.rst:1546

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEHasTag

.. oe:function:: OEHasTag

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasTag(unsigned int tag)
         bool OEHasTag(const std::string& s)

   .. oe:language:: python

      .. oe:api:: python

         OEHasTag(arg1: int) -> bool
         OEHasTag(arg1: str) -> bool



.. # split from OESystemFunctions.rst:1556

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEInitAnnotationHandlers

.. oe:function:: OEInitAnnotationHandlers

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEInitAnnotationHandlers(OESystem::OEBinaryIOHandlerBase& hand)

   .. oe:language:: python

      .. oe:api:: python

         OEInitAnnotationHandlers(hand: OEBinaryIOHandlerBase) -> None



.. # split from OESystemFunctions.rst:1563

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEInitGridHandlers

.. oe:function:: OEInitGridHandlers

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEInitGridHandlers(OEChem::oemolstreambase& fs)

   .. oe:language:: python

      .. oe:api:: python

         OEInitGridHandlers(fs: oemolstreambase) -> None

   Adds the ability to read/write :ref:`OEScalarGrid <OESystem_OEScalarGrid>` and :ref:`OESkewGrid <OESystem_OESkewGrid>`
   attached to molecules.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEInitGridHandlers(OESystem::OEBinaryIOHandlerBase& b)

   .. oe:language:: python

      .. oe:api:: python

         OEInitGridHandlers(b: OEBinaryIOHandlerBase) -> bool

   Adds the ability to read/write :ref:`OEScalarGrid <OESystem_OEScalarGrid>` and :ref:`OESkewGrid <OESystem_OESkewGrid>`
   with any :ref:`OEBinaryIOHandlerBase <OESystem_OEBinaryIOHandlerBase>`.



.. # split from OESystemFunctions.rst:1579

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEInitializeHandler

.. oe:function:: OEInitializeHandler

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEInitializeHandler(OESystem::OEBinaryIOHandlerBase& hand)

   .. oe:language:: python

      .. oe:api:: python

         OEInitializeHandler(hand: OEBinaryIOHandlerBase) -> None



.. # split from OESystemFunctions.rst:1586

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEInterpolateBetweenGrids

.. oe:function:: OEInterpolateBetweenGrids

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEInterpolateBetweenGrids(OESystem::OEScalarGrid& dst,
                                        const OESystem::OEScalarGrid& src)

   .. oe:language:: python

      .. oe:api:: python

         OEInterpolateBetweenGrids(dst: OEScalarGrid, src: OEScalarGrid) -> bool

   Sets the values on 'dst' grid (:ref:`OEScalarGrid <OESystem_OEScalarGrid>`) by linearly
   interpolating the values from 'src' grid (:ref:`OEScalarGrid <OESystem_OEScalarGrid>`).



.. # split from OESystemFunctions.rst:1596

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEIsEmpty

.. oe:function:: OEIsEmpty

   .. oe:api::

      template<class T>
      unsigned int OEIsEmpty(OEIterBase<T>* iterbase)

   Returns whether the iterator is empty and consumes the iterator.

   .. code-block:: c++

      bool has_hydrogens = !OEIsEmpty<OEAtomBase>(mol.GetAtoms(OEIsHydrogen()));



.. # split from OESystemFunctions.rst:1610

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEIsGrid

.. oe:function:: OEIsGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsGrid(const OESystem::OEBase& b)

   .. oe:language:: python

      .. oe:api:: python

         OEIsGrid(b: OEBase) -> bool

   Returns whether 'b' is a :ref:`OEScalarGrid <OESystem_OEScalarGrid>` or
   a :ref:`OESkewGrid <OESystem_OESkewGrid>`.



.. # split from OESystemFunctions.rst:1619

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEIsReadableGrid

.. oe:function:: OEIsReadableGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsReadableGrid(unsigned int type)
         bool OEIsReadableGrid(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEIsReadableGrid(type: int) -> bool
         OEIsReadableGrid(filename: str) -> bool

   Returns ``true`` if the supplied file format is readable by
   *OEGrid*. The 'filename' can be a file name or a file extension. The
   'type' parameter should be drawn from the
   :oe:constns:`OESystem::OEGridFileType` namespace.



.. # split from OESystemFunctions.rst:1631

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEIsSafeCast

.. attention::

   |CPPONLY|

.. oe:function:: OEIsSafeCast

   .. oe:api::

      template<class Ret, class Input>
      inline bool OEIsSafeCast(Input arg, std::string& msg)

   Returns ``true`` if the input value in ``arg`` can be safely cast
   to the output type ``Ret`` without loss of information. Returns
   ``false`` if there would be lost information, i.e., casting an
   negative number to an unsigned type. If ``false`` is returned, an
   error message is placed into the ``msg`` argument string.


.. # split from OESystemFunctions.rst:1645

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEIsSameTypeTester

.. oe:function:: OEIsSameTypeTester

   .. oe:api::

      OEFalseType OEIsSameTypeTester(...)
      template<typename T>
      OETrueType OEIsSameTypeTester(T &, T &)



.. # split from OESystemFunctions.rst:1654

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEIsWriteableGrid

.. oe:function:: OEIsWriteableGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsWriteableGrid(unsigned int type)
         bool OEIsWriteableGrid(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEIsWriteableGrid(type: int) -> bool
         OEIsWriteableGrid(filename: str) -> bool

   Returns ``true`` if the supplied file format is writable by
   *OEGrid*. The 'filename' can be a file name or a file
   extension. The 'type' parameter value should be drawn from the
   :oe:constns:`OESystem::OEGridFileType` namespace.



.. # split from OESystemFunctions.rst:1666

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OELinearInterpolate

.. attention::

   This function is available in C++ and Python only.

.. oe:function:: OELinearInterpolate

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class GridType>
         inline GridType OELinearInterpolate(const OEFixedGrid<GridType>& grid,
                                             float x, float y, float z,
                                             const GridType& outside_grid_val)

   .. oe:language:: python

      .. oe:api:: python

         OELinearInterpolate(grid: OEFixedFloatGrid, x: float, y: float,
                             z: float, outside_grid_val: float) -> float

   Returns the tri-linear interpolation of the value at ``(x, y, z)``
   inside the ``grid``. If the point falls outside the grid,
   *outside_grid_val* is returned instead.

   .. oe:language:: python

      The following specializations exist for this template:

      =============================== =============================================
      OELinearInterpolate             OESystem::OELinearInterpolate<float>
      OEDoubleGridLinearInterpolate   OESystem::OELinearInterpolate<double>
      OEFloatGridLinearInterpolate    OESystem::OELinearInterpolate<float>
      OEIntGridLinearInterpolate      OESystem::OELinearInterpolate<int>
      =============================== =============================================


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMTZMapTypeFromString

.. oe:function:: OEMTZMapTypeFromString

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEMTZMapTypeFromString(const std::string& maptype)

   .. oe:language:: python

      .. oe:api:: python

         OEMTZMapTypeFromString(maptype: str) -> int

   Converts the human readable string output by :oe:func:`OESystem::OEMTZMapTypeToString`
   into the a MTZ map type.
   Returns :oe:const:`OESystem::OEMTZMapType::None` upon failure.

   .. seealso::

      * :oe:constns:`OESystem::OEMTZMapType` namespace
      * :oe:func:`OESystem::OEReadMTZ` function
      * :oe:func:`OESystem::OEMTZMapTypeToString` function

   .. seealso::

      * :oe:func:`OESystem::OEReadMTZ` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMTZMapTypeToString

.. oe:function:: OEMTZMapTypeToString

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEMTZMapTypeToString (unsigned int maptype)

   .. oe:language:: python

      .. oe:api:: python

         OEMTZMapTypeToString(maptype: int) -> str

   Converts a MTZ map type, such as :oe:const:`OESystem::OEMTZMapType::Fdelwt`
   to a human readable string.

   =========================== =====================
   MapType                     Human-Readable String
   =========================== =====================
   OEMTZMapType::Fo            "Fo"
   --------------------------- ---------------------
   OEMTZMapType::Fc            "Fc"
   --------------------------- ---------------------
   OEMTZMapType::TwoFoFc       "2Fo-Fc"
   --------------------------- ---------------------
   OEMTZMapType::FoFc          "Fo-Fc"
   --------------------------- ---------------------
   OEMTZMapType::ThreeFoTwoFc  "3Fo-2Fc"
   --------------------------- ---------------------
   OEMTZMapType::FiveFoThreeFc "5Fo-3Fc"
   --------------------------- ---------------------
   OEMTZMapType::TwoFoFcSigmaA "2Fo-Fc(SigmaA)"
   --------------------------- ---------------------
   OEMTZMapType::FoFcSigmaA    "Fo-Fc (SigmaA)
   --------------------------- ---------------------
   OEMTZMapType::FoSquared     "Fo*Fo"
   --------------------------- ---------------------
   OEMTZMapType::FoFom         "Fo*FOM"
   --------------------------- ---------------------
   OEMTZMapType::Fwt           "Fwt"
   --------------------------- ---------------------
   OEMTZMapType::Fdelwt        "Fdelwt"
   --------------------------- ---------------------
   OEMTZMapType::None          "None"
   =========================== =====================

   .. seealso::

      * :oe:constns:`OESystem::OEMTZMapType` namespace
      * :oe:func:`OESystem::OEReadMTZ` function
      * :oe:func:`OESystem::OEMTZMapTypeFromString` function


.. oe:namespace:: OEDataFlow

..  _OEDataFlow_OEMakeField:

.. meta::
   :keywords: OEMakeField OERecord datarecord

.. oe:language:: c++

   .. oe:function:: OEMakeField
   
      .. oe:api::
   
         template<typename T> OEField<T> OEMakeField(const std::string& name,
                                                     const OEFieldType<T>& t,
                                                     OEFieldMeta meta = OEFieldMeta(),
                                                     bool readonly = false,
                                                     bool nullable = false)
   
         template<type T>OEMakeField(const std::string& name,
                                     const OEVectorFieldType<T>& t,
                                     OEFieldMeta meta = OEFieldMeta(),
                                     bool readonly = false,
                                     bool nullable = false)
   
      Creates an :ref:`OEField <OEDataFlow_OEField>` object to be
      used for adding data to, or retrieving data from, an 
      :ref:`OERecord <OEDataFlow_OERecord>` object.
   
      name
        The name the field will be given.
   
      t
        This specifies the type of field to be created. This will usually
        come from the :oe:constns:`OEDataFlow::Types` namespace.
   
      meta
        Optional metadata to be applied to the field.
   
      readonly
        If true, the field can only be used to read data to a record, not
        write it.
   
      nullable
        If true, the field will allow setting of null values on a record.
   
      .. seealso::
   
         * :ref:`OEField <OEDataFlow_OEField>`
         * :ref:`OERecord <OEDataFlow_OERecord>`
         * :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>`
   
.. oe:language:: python

   .. oe:function:: OEMakeField
   
      .. oe:api::
   
         OEMakeField(name: str, t: OEFieldTypeHandler,
                     meta: OEFieldMeta = None, readonly: bool = false,
                     nullable: bool = false) -> OEField
   
      Creates an :ref:`OEField <OEDataFlow_OEField>` object to be
      used for adding data to, or retrieving data from, an 
      :ref:`OERecord <OEDataFlow_OERecord>` object.
   
      name
        The name the field will be given.
   
      t
        This specifies the type of field to be created. This will usually
        come from the :oe:constns:`OEDataFlow::Types` namespace.
   
      meta
        Optional metadata to be applied to the field.
   
      readonly
        If true, the field can only be used to read data to a record, not
        write it.
   
      nullable
        If true, the field will allow setting of null values on a record.
   
      .. seealso::
   
         * :ref:`OEField <OEDataFlow_OEField>`
         * :ref:`OERecord <OEDataFlow_OERecord>`
         * :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>`
   


.. # split from OESystemFunctions.rst:1678

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMakeGaussians

.. oe:function:: OEMakeGaussians

   .. oe:api::

      bool OEMakeGaussians(OEGaussianContainerBase& gaussians,
                           const OEChem::OEMolBase& mol, double prefactor = 2.7)



.. # split from OESystemFunctions.rst:1686

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMakeGridFromCenterAndExtents

.. oe:function:: OEMakeGridFromCenterAndExtents

   .. oe:language:: c++ java csharp

      .. oe:api::

         template<class T>
         bool OEMakeGridFromCenterAndExtents(OESystem::OEGrid<T>& fgrid,
                                             const float* center,
                                             const float* extents,
                                             float spacing)
         bool OEMakeGridFromCenterAndExtents(OESystem::OEScalarGrid& fgrid,
                                             const float* center,
                                             const float* extents,
                                             float spacing)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeGridFromCenterAndExtents(fgrid: OEScalarGrid,
                                        center: OEFloatArray,
                                        extents: OEFloatArray, spacing: float) -> bool

   Initiates the geometry of 'fgrid' from the midpoint ('center'),
   dimensions ('extents'), and length between grid points
   ('spacing').

   This is useful for creating grids that are guaranteed to
   encapsulate an arbitrary set of coordinates. For example, the
   following code uses :oe:func:`OEChem::OEGetCenterAndExtents` on the
   molecule and then uses
   :oe:func:`OESystem::OEMakeGridFromCenterAndExtents` to construct the
   grid.

   .. oe:source:: OEMakeGridFromCenterAndExtents.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEMakeGridFromCenterAndExtents
      :caption:  Initializing grid geometry from the coordinates of a molecule

   .. oe:source:: OEMakeGridFromCenterAndExtents.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEMakeGridFromCenterAndExtents
      :caption:  Initializing grid geometry from the coordinates of a molecule

   .. oe:source:: OEMakeGridFromCenterAndExtents.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEMakeGridFromCenterAndExtents
      :caption:  Initializing grid geometry from the coordinates of a molecule

   .. oe:source:: OEMakeGridFromCenterAndExtents.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEMakeGridFromCenterAndExtents
      :caption:  Initializing grid geometry from the coordinates of a molecule



.. # split from OESystemFunctions.rst:1733

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMakeHex

.. oe:function:: OEMakeHex

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeHex(std::string& hex, const OEBitVector &,
                        unsigned int columns = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeHex(hex: str, arg2: OEBitVector, columns: int = 0) -> bool

   Generates a hexadecimal string representation of an :ref:`OEBitVector <OESystem_OEBitVector>`.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeHex(std::string &, const std::vector<bool> &,
                        unsigned int columns = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeHex(arg1: str, arg2: List[bool], columns: int = 0) -> bool

   Generates a hexadecimal string representation of a boolean vector.

   .. seealso::

      * :oe:func:`OESystem::OEParseHex` function
      * :oe:meth:`OESystem::OEBitVector::FromHexString` and :oe:meth:`OESystem::OEBitVector::ToHexString` method method



.. oe:namespace:: OEDataFlow

.. meta::
   :keywords: OEMakeMatchField OERecord datarecord

.. oe:function:: OEMakeMatchField

   .. oe:language:: c++

      .. oe:api::

         template<typename T> OEField<T> OEMakeMatchField(const std::string& name,
                                                          const OEFieldType<T>& t,
                                                          OEFieldMeta meta = OEFieldMeta(),
                                                          bool readonly = false,
                                                          bool nullable = false)

         template<type T>OEMakeMatchField(const std::string& name,
                                          const OEVectorFieldType<T>& t,
                                          OEFieldMeta meta = OEFieldMeta(),
                                          bool readonly = false,
                                          bool nullable = false)
   .. oe:language:: python

      .. oe:api::

         OEMakeMatchField(name: str, t: OEFieldTypeHandler,
                          meta = OEFieldMeta = None, readonly: bool = false,
                          ol nullable = false) -> OEMatchField

   Creates an :ref:`OEMatchField <OEDataFlow_OEMatchField>` object to be
   used for adding data to, or retrieving data from, an 
   :ref:`OERecord <OEDataFlow_OERecord>` object. Match fields are used
   mainly to retrieve data from a record when you don't know the name
   of a field but know its type and associated metadata.

   name
     The name the field will be given.

   t
     This specifies the type of match field to be created. This will usually
     come from the :oe:constns:`OEDataFlow::Types` namespace.

   meta
     If this field is provided, the returned 
     :ref:`OEMatchField <OEDataFlow_OEMatchField>` object will only retrieve
     data from fields that match this metadata.

   readonly
     If true, the returned match field can only be used to read data to a
     record, not write it.

   nullable
     If true, the returned field match field will allow setting of null 
     values on a record.

   .. seealso::

      * :ref:`OEMatchField <OEDataFlow_OEMatchField>`
      * :ref:`OERecord <OEDataFlow_OERecord>`
      * :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>`



.. # split from OESystemFunctions.rst:1754

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMakeMolecularGaussianGrid

.. oe:function:: OEMakeMolecularGaussianGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeMolecularGaussianGrid(OESystem::OEScalarGrid& grid,
                                          const OEChem::OEMolBase& mol,
                                          float resolution)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeMolecularGaussianGrid(grid: OEScalarGrid,
                                     mol: Union[OEGraphMol,OEMol,OEQMol],
                                     resolution: float) -> bool

   Populates 'grid' (:ref:`OEScalarGrid <OESystem_OEScalarGrid>`) with floating
   point values determined by Gaussians centered at the atoms in mol
   (:ref:`OEMolBase <OEChem_OEMolBase>`). The grid will be resized to fit
   around the molecule with the specified ``resolution``.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeMolecularGaussianGrid(OESystem::OEScalarGrid& grid,
                                          const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeMolecularGaussianGrid(grid: OEScalarGrid,
                                     mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Similar to the above function, however, the passed in grid
   dimension and location will be used. Care must be taken to ensure
   the molecule lies entirely within the grid. The ``resolution`` of
   the grid is determined by the passed in
   :oe:meth:`OESystem::OEGridBase::GetSpacing`.



.. # split from OESystemFunctions.rst:1777

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMakeRegularGrid

.. oe:function:: OEMakeRegularGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeRegularGrid(OESystem::OEScalarGrid& gridout,
                                const OESystem::OESkewGrid& gridin,
                                float scale = 0.0f)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeRegularGrid(gridout: OEScalarGrid, gridin: OESkewGrid,
                           scale: float = 0.0) -> bool

   Regularizes the input grid, 'gridin' (:ref:`OESkewGrid <OESystem_OESkewGrid>`) into
   an orthogonal axis 'gridout' (:ref:`OEScalarGrid <OESystem_OEScalarGrid>`). The
   full extents of the :ref:`OESkewGrid <OESystem_OESkewGrid>` will be
   transferred, potentially causing some data redundancy in the resulting
   :ref:`OEScalarGrid <OESystem_OEScalarGrid>`.


.. # split from OESystemFunctions.rst:1790

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMakeRegularSubGrid

.. oe:function:: OEMakeRegularSubGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeRegularSubGrid(OESystem::OEScalarGrid& gridout,
                                   const OESystem::OESkewGrid& gridin,
                                   const float* center, const float* extents,
                                   float scale, bool reentrant)
         bool OEMakeRegularSubGrid(OESystem::OEScalarGrid& gridout,
                                   const OESystem::OEScalarGrid& gridin,
                                   const float* center, const float* extents,
                                   float scale, bool reentrant)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeRegularSubGrid(gridout: OEScalarGrid, gridin: OEScalarGrid,
                              center: OEFloatArray, extents: OEFloatArray,
                              scale: float, reentrant: bool) -> bool
         OEMakeRegularSubGrid(gridout: OEScalarGrid, gridin: OESkewGrid,
                              center: OEFloatArray, extents: OEFloatArray,
                              scale: float, reentrant: bool) -> bool

   Regularize a portion of 'gridin' (:ref:`OESkewGrid <OESystem_OESkewGrid>`)
   into 'gridout' (that can be either :ref:`OEScalarGrid <OESystem_OEScalarGrid>`
   or :ref:`OESkewGrid <OESystem_OESkewGrid>`)


.. # split from OESystemFunctions.rst:1806

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMakeString

.. attention::

   |CPPONLY|

.. oe:function:: OEMakeString

   .. oe:api::

      std::string OEMakeString(const char* format, ...)

   Return a formatted string using ``printf`` formatting rules.



.. # split from OESystemFunctions.rst:1815

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMaskGrid

.. oe:function:: OEMaskGrid

   .. oe:api::

      template<class GridType1, class GridType2>
      bool OEMaskGrid(GridType1& outgrid, const GridType2& mask_grid,
                      unsigned int type = OEGridMaskType::Default)



.. # split from OESystemFunctions.rst:1824

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMaskGridByCoordsAndRadii

.. oe:function:: OEMaskGridByCoordsAndRadii

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMaskGridByCoordsAndRadii(OESystem::OEScalarGrid& grid,
                                         const float* coords,
                                         const float* radii,
                                         unsigned int numcoords,
                                         unsigned int type = OEGridMaskType::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEMaskGridByCoordsAndRadii(grid: OEScalarGrid, coords: OEFloatArray,
                                    radii: OEFloatArray, numcoords: int,
                                    type: int = OEGridMaskType_Default) -> bool



.. # split from OESystemFunctions.rst:1834

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMaskGridByMolecule

.. oe:function:: OEMaskGridByMolecule

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMaskGridByMolecule(OESystem::OEScalarGrid& grid,
                                   const OEChem::OEMolBase& mol,
                                   unsigned int masktype, float contour)
         bool OEMaskGridByMolecule(OESystem::OEScalarGrid& grid,
                                   const OEChem::OEMolBase& mol,
                                   unsigned int masktype = OEGridMaskType::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEMaskGridByMolecule(grid: OEScalarGrid,
                              mol: Union[OEGraphMol,OEMol,OEQMol],
                              masktype: int = OEGridMaskType_Default) -> bool
         OEMaskGridByMolecule(grid: OEScalarGrid,
                              mol: Union[OEGraphMol,OEMol,OEQMol],
                              masktype: int, contour: float) -> bool



.. # split from OESystemFunctions.rst:1846

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMaskGridValues

.. oe:function:: OEMaskGridValues

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMaskGridValues(float* vals, const float* cvals,
                               unsigned int count,
                               unsigned int type = OEGridMaskType::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEMaskGridValues(vals: OEFloatArray, cvals: OEFloatArray, count: int,
                          type: int = OEGridMaskType_Default) -> bool



.. # split from OESystemFunctions.rst:1854

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMoveArray

.. attention::

   |CPPONLY|

.. oe:function:: OEMoveArray

   .. oe:api::

      template<class T, class U>
      void OEMoveArray(T* dst, const T* src, size_t num)
      template<class T>
      void OEMoveArray(T* dst, const T* src, size_t num, OETrueType)
      template<class T, class U>
      void OEMoveArray(T* dst, const U* src, size_t num, OEBoolType)



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMultiplicationWillOverflow

.. oe:function:: OEMultiplicationWillOverflow

   .. oe:api::

      template<typename NumType>
      bool OEMultiplicationWillOverflow(NumType m, NumType n)

   Returns ``true`` if the multiplication of ``m`` and ``n`` will
   overflow the integer number type ``NumType``. Returning ``false``
   indicates the numbers can be safely multiplied without incurring
   any undefined C++ behavior.


.. # split from OESystemFunctions.rst:1913

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEMultiplyGrid

.. oe:function:: OEMultiplyGrid

   .. oe:api::

      template<class GridType1, class GridType2>
      bool OEMultiplyGrid(GridType1& grid1, const GridType2& grid2)



.. # split from OESystemFunctions.rst:1921

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OENumContours

.. oe:function:: OENumContours

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OENumContours(const OEGridAbstractBase& grid)

   .. oe:language:: python

      .. oe:api:: python

         OENumContours(grid: OEGridAbstractBase) -> int

   Returns the number of contours stored on 'grid' (:ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>`).

   .. seealso::

      * :oe:func:`OESystem::OEAddContour`
      * :oe:func:`OESystem::OEGetContourColor`
      * :oe:func:`OESystem::OEGetContourLevel`



.. # split from OESystemFunctions.rst:1935

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OENumberToString

.. attention::

   |CPPONLY|

.. oe:function:: OENumberToString

   .. oe:api::

      std::string OENumberToString(const bool& x)
      std::string OENumberToString(const std::string& x)
      std::string OENumberToString(int value, int base = 10)
      std::string OENumberToString(short value, int base = 10)
      std::string OENumberToString(OELongLong number, int base = 10)
      std::string OENumberToString(OEULongLong number, int base = 10)
      std::string OENumberToString(unsigned int value, int base = 10)
      std::string OENumberToString(unsigned short value, int base = 10)
      std::string OENumberToString(float number, char f = 'f', int prec = 6)
      std::string OENumberToString(double number, char f = 'f', int prec = 12)
      std::string OENumberToString(long double number, char f = 'f',
                                   int prec = 12)
      bool OENumberToString(short value, std::string& numstr, int base = 10)
      inline bool OENumberToString(int value, std::string& numstr,
                                   int base = 10)
      bool OENumberToString(OELongLong value, std::string& numstr,
                            int base = 10)
      bool OENumberToString(OEULongLong value, std::string& numstr,
                            int base = 10)
      bool OENumberToString(unsigned int value, std::string& numstr,
                            int base = 10)
      bool OENumberToString(unsigned short value, std::string& numstr,
                            int base = 10)
      bool OENumberToString(double value, std::string& numstr,
                            char format = 'f', int precision = 6)
      bool OENumberToString(long double value, std::string& numstr,
                            char format = 'f', int precision = 6)

   Returns a string representation of the number ``value`` passed
   in. For integral types, the base should be between 2 and 36. For
   floating point types, the number of decimal places can be chosen
   with the ``prec`` argument. The format parameter, ``f`` should be
   one of the following: ``f``, ``g``, or ``e``.

   The overload that returns a boolean value can be used to detect
   whether the function fails. The overloads that return the string
   will return an empty string if the function fails.



.. # split from OESystemFunctions.rst:1972

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEParseCommandLine

.. oe:function:: OEParseCommandLine

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEParseCommandLine(OEInterface& itf, int argc, char** argv,
                                 const unsigned char* requirements = NULL,
                                 unsigned int error_level = OEErrorLevel::Error,
                                 bool checkhelp = true)
         bool OEParseCommandLine(OEInterface& itf, const char* version,
                                 int argc, char** argv,
                                 const unsigned char* requirements = NULL,
                                 unsigned int error_level = OEErrorLevel::Error,
                                 bool checkhelp = true)

   .. oe:language:: python

      .. oe:api:: python

         OEParseCommandLine(itf: OEInterface, argc: int, argv: str,
                            requirements: str = None, error_level: int,
                            checkhelp: bool = True) -> bool
         OEParseCommandLine(itf: OEInterface, version: str, argc: int,
                            argv: str, requirements: str = None,
                            error_level: int, checkhelp: bool = True) -> bool

   Sets parameters in the
   'itf' object by parsing the command line, 'argc' and 'argv'. This
   function returns ``true`` if it was successful and ``false``
   otherwise. Errors are reported at 'error_level' to
   :oe:constns:`OESystem::OEThrow`.

   The ``version`` argument specifies what should be printed whenever
   the ``--version`` is found in ``argv``.

   By default, ``checkhelp`` is true, forcing
   :oe:func:`OESystem::OECheckHelp` to be called at the very beginning
   of this function. If ``checkhelp`` is true and the ``--help``
   parameter is found, the ``exit`` system call is called to exit the
   process with a ``0`` exit code.

   Parameters are entered in key-value pairs after the executable name
   on the command line.

   .. code-block:: bash

      program <parameter1 key> <parameter1 value> <parameter2 key>  <parameter2 value>

   The order in which the parameter key-value pairs appear on the
   command line is unimportant, except when the same key is specified
   twice in which case the second value specified is used.

   .. code-block:: bash

      program <parameter2 key> <parameter2 value> <parameter1 key> <parameter1 value>

   is the same as the preceding example.

   The following special case rules also apply when parsing the command line.

   #. Boolean parameter keys can optionally not be followed by a
      boolean value in which case the boolean parameter is set to
      true

      .. code-block:: bash

         program -b true -x 5

      and

      .. code-block:: bash

         program -b -x 5

      are equivalent, provided that '-b' is a boolean parameter.

   #. Parameters of type 'param_file' will be assumed to be text files
      containing key-value parameter pairs for the :ref:`OEInterface <OESystem_OEInterface>` object,
      'itf'. These files will be parsed and the parameters set
      accordingly. The format of these files should be one key-value pair
      per line. Blank lines and lines beginning with ``#`` will be ignored. If
      a parameter is set both in a parameter file and on the command
      line, the command line setting will be used.

   #. Parameters with non-zero keyless values (see :oe:meth:`OESystem::OEParameter::GetKeyless`
      method) can be entered at the end of the command line as a
      value without a key. The format is as follows

      .. code-block:: bash

         program [<key> <value>]... <keyless1 value> [<keyless2 value>]...

   Any number of key-value pairs can be entered on the command line
   before the keyless values. Parsing from left to right the first
   argument on the command line not recognized as a key-value pair
   is assigned to the parameter with the keyless
   value ``1``. Additional arguments beyond the first are assigned to
   the parameter with keyless value ``2``, ``3``, ``4`` and so on. If the itf
   object does not have a parameter with the appropriate keyless
   value or has more than one parameter with the appropriate
   keyless value an error will be reported and the function will
   return false.

   .. note::

      There is a potential ambiguity in the command line when
      the last key-value pair specified before the first keyless
      parameter is a boolean, as in the following example.

      .. code-block:: bash

         program -b true keylessvalue

   If '-b' is a boolean parameter true could either be the setting of
   '-b' or the first keyless parameter. :oe:func:`OESystem::OEParseCommandLine` resolves
   this by always assuming that true, or any valid boolean setting
   (*i.e.*, ``true/yes/on/t/y`` or ``false/no/off/f/n``), is a setting for
   the boolean parameter '-b' and NOT the first keyless value.

   After :oe:func:`OESystem::OEParseCommandLine` parses the command line it then checks
   that all required parameters have been set. If all required
   parameters have not been set an error is issued and the function
   returns false.

   The following are the types of requirements:

   **single parameter requirements**

   This type of requirement forces that a particular parameter must
   be specified on the command line, in a parameter file, or by a
   default value. This requirement is turned on using the SetRequired
   method of the :ref:`OEParameter <OESystem_OEParameter>` class (or the ``!REQUIRED`` field on
   :oe:func:`OESystem::OEConfigure`).

   **multi-parameter requirements**

   This type of requirement can include inter-dependent settings of
   parameters. These requirements are specified by passing
   requirements to this function, which is a specially formatted text
   file that has been converted into a null terminated character
   array. The format is a series of one or more requirement records of
   the following format.

   .. code-block:: bash

      !REQUIREMENT
          !OPTION [[!]key [value] [[!]key [value]...
          !OPTION [[!]key [value] [[!]key [value]...
          .
          .
          .
          !ERROR_MSG
            <error message line 1>
            <error message line 2>
            .
            .
            .
      !END

   One or more ``!OPTION`` fields may appear in a requirement
   record. Each ``!OPTION`` field is a list of keys, optionally with
   values, to require. The rules for the format of the ``!OPTION`` line
   are as follows.

   #. If a key appears on the ``!OPTION`` line, but is not followed by
      a parameter value, then that parameter must have a valid
      setting (*e.g.*, the parameter method :oe:meth:`OESystem::OEParameter::IsSet`
      must return ``true``).

   #. If a key appears on the ``!OPTION`` line followed by a value,
      then that parameter must be set to the specified value.

   #. If a key appears on the ``!OPTION`` line preceded by a ``!``, but
      is not followed by a parameter value, then that parameter must
      not have a valid setting (*e.g.*, the parameter method
      :oe:meth:`OESystem::OEParameter::IsSet` must return ``false``).

   If any ``!OPTION`` field of a requirement record is satisfied, the
   entire requirement is satisfied. No !OPTION in the requirement
   record is satisfied, the error message is sent to :oe:constns:`OESystem::OEThrow` and the
   function returns false.

   The following is an example parameter record:

   .. code-block:: bash

      !REQUIREMENT
          !OPTION -a 5
          !OPTION !-b
          !OPTION -a -b !-c 1
          !ERROR_MSG
            The command line must satisfy one of the following criterion
            1) -a is set to 5
            2) -b is not set
            3) -a and -b are set and -c is not set to 1
      !END

   This requirement record requires that the settings in itf follow
   the rules listed between ``!ERROR_MSG`` and ``!END``. If it does not those
   lines are sent to :oe:constns:`OESystem::OEThrow` and the function returns ``false``.



.. # split from OESystemFunctions.rst:2166

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEParseCommandLineLW

.. oe:function:: OEParseCommandLineLW

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEParseCommandLineLW(OEInterface& itf, int argc, char** argv,
                                   const unsigned char* requirements = NULL,
                                   unsigned int error_level = OEErrorLevel::Error)
         bool OEParseCommandLineLW(OEInterface& itf, const char* version,
                                   int argc, char** argv,
                                   const unsigned char* requirements = NULL,
                                   unsigned int error_level = OEErrorLevel::Error)

   .. oe:language:: python

      .. oe:api:: python

         OEParseCommandLineLW(itf: OEInterface, argc: int, argv: str,
                              requirements: str = None, error_level: int) -> bool
         OEParseCommandLineLW(itf: OEInterface, version: str, argc: int,
                              argv: str, requirements: str = None,
                              error_level: int) -> bool

   Set parameters in the 'itf'
   object by parsing the command line, 'argc' and 'argv'. This is the same
   purpose as :oe:func:`OESystem::OEParseCommandLine`, however, this function has different
   rules for parsing the command line, most notably nothing is entered as
   a key-value pair, and is in general designed for small lightweight
   interfaces, hence the *LW* in the function name.

   The ``version`` argument specifies what should be printed whenever
   the ``--version`` is found in ``argv``.

   When using this function all parameters of itf must fall into one
   of two categories.

   *  A boolean parameter with a default value of false and a name
      beginning with a dash followed by a single character.

   *  A keyless parameter (*i.e.* a parameter with a non-zero keyless
      value).

   and the command line should be of the following form.

   .. code-block:: bash

      program [boolean parameter keys] [keyless parameter values]

   **boolean parameter keys**

   Boolean parameters with keys listed listed in this part of the
   command line will be set to true (those not appearing will use
   their default value which must be ``false``). The characters of the
   boolean keys may also be combined into a single argument on the
   command line. This is easiest to illustrate in the following
   example:

   .. code-block:: bash

      program -a -b -c [keyless parameter values]

   and

   .. code-block:: bash

      program -abc [keyless parameter values]

   and

   .. code-block:: bash

      program -c -ba [keyless parameter values]

   Are all equivalent, provided '-a', '-b' and '-c' are boolean parameters
   with default values of ``false``.

   **keyless parameter values**

   The first argument not recognized as a boolean parameter will be
   assigned as the value of the parameter with a keyless value of ``1``,
   the second to the parameter with keyless value of ``2``, etc. If no
   parameter have the appropriate keyless value, or more than one have
   the required keyless value are error is reported, and the function
   returns ``false``.

   This function returns true if it was successful and ``false``
   otherwise. Errors are reported at 'error_level' to :oe:constns:`OESystem::OEThrow`.



.. # split from OESystemFunctions.rst:2248

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEParseHex

.. oe:function:: OEParseHex

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEParseHex(std::vector<bool>& , const std::string&)

   .. oe:language:: python

      .. oe:api:: python

         OEParseHex(arg1: List[bool], arg2: str) -> bool

   Converts a hexadecimal string to boolean vector.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEParseHex(OEBitVector& , const std::string&)

   .. oe:language:: python

      .. oe:api:: python

         OEParseHex(arg1: OEBitVector, arg2: str) -> bool

   Converts a hexadecimal string to a :ref:`OEBitVector <OESystem_OEBitVector>` object.

   .. seealso::

      * :oe:func:`OESystem::OEMakeHex` function
      * :oe:meth:`OESystem::OEBitVector::FromHexString` and :oe:meth:`OESystem::OEBitVector::ToHexString` method method



.. # split from OESystemFunctions.rst:2268

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEParseParameterFile

.. oe:function:: OEParseParameterFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEParseParameterFile(OEInterface& itf,
                                   OEPlatform::oeistream& istr,
                                   bool over_ride = true,
                                   unsigned int error_level = OEErrorLevel::Warning)

   .. oe:language:: python

      .. oe:api:: python

         OEParseParameterFile(itf: OEInterface, istr: oeistream,
                              over_ride: bool = True, error_level: int) -> bool



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEReadCIFGridFile

..  _OESystem_OEReadCIFGridFile:

.. oe:function:: OEReadCIFGridFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadCIFGridFile(const std::string& filename,
                                OESystem::OESkewGrid& sgrid,
                                unsigned int maptype)

   .. oe:language:: python

      .. oe:api:: python

         OEReadCIFGridFile(filename: str, sgrid: OESkewGrid, maptype: int) -> bool

   Read a structure factor CIF file into an OpenEye skew grid.
   The grid requires that the proper column name be present to extract the
   appropriate reflection data. 

   The following map types can be read using predefined operations on the sfCIF data:

   ================================================= =========================================
   MapType                                           Description
   ================================================= =========================================
   :oe:const:`OESystem::OEMTZMapType::Fo`            Observed Reflections
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::Fc`            Map generated from calculated model
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::TwoFoFc`       2Fo - Fc
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::ThreeFoTwoFc`  3Fo - Fc
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::FiveFoThreeFc` 5Fo - 3Fc
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::TwoFoFcSigmaA` 2Fo - Fc Sigma-A weighted
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::FoFcSigmaA`    Fo - Fc Sigma-A weighted
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::FoSquared`     Fo*Fo
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::FoFom`         Fo * figure of merit
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::Fwt`           2mFo - DFc (normally)
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::Fdelwt`        mFo - DFc (normally)
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::None`          No reflections (used as a status flag)
   ================================================= =========================================



.. # split from OESystemFunctions.rst:2277

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEReadGrid

.. oe:function:: OEReadGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadGrid(const std::string& filename,
                         OESystem::OESkewGrid& grid)
         bool OEReadGrid(const std::string& filename,
                         OESystem::OEScalarGrid& grid)
         bool OEReadGrid(OEPlatform::oeistream& ifs,
                         OESystem::OESkewGrid& grid, unsigned int filetype)
         bool OEReadGrid(OEPlatform::oeistream& ifs,
                         OESystem::OEScalarGrid& grid, unsigned int filetype)

   .. oe:language:: python

      .. oe:api:: python

         OEReadGrid(filename: str, grid: OEScalarGrid) -> bool
         OEReadGrid(filename: str, grid: OESkewGrid) -> bool
         OEReadGrid(ifs: oeistream, grid: OEScalarGrid, filetype: int) -> bool
         OEReadGrid(ifs: oeistream, grid: OESkewGrid, filetype: int) -> bool

   Reads the contents of the file into grid (:ref:`OESkewGrid <OESystem_OESkewGrid>`,
   :ref:`OEScalarGrid <OESystem_OEScalarGrid>`).



.. # split from OESystemFunctions.rst:2291

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEReadMTZ

..  _OESystem_OEReadMTZ:

.. oe:function:: OEReadMTZ

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMTZ(const std::string& filename,
                        OESystem::OESkewGrid& sgrid, unsigned int maptype)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMTZ(filename: str, sgrid: OESkewGrid, maptype: int) -> bool

   Read an MTZ (crystallographic reflection format) into an OpenEye skew grid.
   MTZ grids require that the proper column names be known to extract the
   appropriate reflection data.  This form of :oe:func:`OESystem::OEReadMTZ` automatically
   chooses appropriate columns from the MTZ file to generate the requested
   map type.  :oe:func:`OESystem::OEReadMTZ` understands common refinement packages including REFMAC5,
   BUSTER and PHENIX.  If the columns cannot be found or if the map cannot
   be generated :oe:func:`OESystem::OEReadMTZ` returns false.

   The following map types can be generated using predefined operations on the MTZ
   column data:

   ================================================= =========================================
   MapType                                           Description
   ================================================= =========================================
   :oe:const:`OESystem::OEMTZMapType::Fo`            Observed Reflections
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::Fc`            Map generated from calculated model
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::TwoFoFc`       2Fo - Fc
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::ThreeFoTwoFc`  3Fo - Fc
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::FiveFoThreeFc` 5Fo - 3Fc
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::TwoFoFcSigmaA` 2Fo - Fc Sigma-A weighted
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::FoFcSigmaA`    Fo - Fc Sigma-A weighted
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::FoSquared`     Fo*Fo
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::FoFom`         Fo * figure of merit
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::Fwt`           2mFo - DFc (normally)
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::Fdelwt`        mFo - DFc (normally)
   ------------------------------------------------- -----------------------------------------
   :oe:const:`OESystem::OEMTZMapType::None`          No reflections (used as a status flag)
   ================================================= =========================================



.. # split from OESystemFunctions.rst:2337

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEReadOldStyleGrid

.. oe:function:: OEReadOldStyleGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadOldStyleGrid(OEPlatform::oeistream& istr,
                                 OEMultiGrid<float>& grid)

   .. oe:language:: python

      .. oe:api:: python

         OEReadOldStyleGrid(istr: oeistream, grid: OEMultiFloatGrid) -> bool



.. oe:namespace:: OEDataFlow

.. meta::
   :keywords: OEReadRecord OERecord datarecord

..  _OEDataFlow_OEReadRecord:

.. oe:function:: OEReadRecord

   .. oe:language:: c++

      .. oe:api::

         bool OEReadRecord(OERecord& record, OEPlatform::oeistream& ifs,
                           const std::string& fmt = "binary")

      Reads an :ref:`OERecord <OEDataFlow_OERecord>` object from a stream,
      and returns *true* if successful. Records can be read from the stream
      until this function returns *false*.

      record
        The record to be filled.

      ifs
        The stream to read the record from.

      fmt
        The format to read the record in. The default is "binary".  Other formats only used internally.

      .. seealso::

         * :ref:`OERecord <OEDataFlow_OERecord>`
         * :ref:`oeistream <OEPlatform_oeistream>`

   .. oe:language:: python

      .. oe:api::

         OEReadRecord(ifs: Union[TextIO, BinaryIO, oeistream],
                      fmt: str = "binary")
         OEReadRecords(ifs: Union[TextIO, BinaryIO, oeistream],
                       fmt: str = "binary")

      Reads and returns an :ref:`OERecord <OEDataFlow_OERecord>` object
      from a stream. Records can be read from the stream until this function
      returns a *None* value.

      record
        The record to be filled.

      ifs
        The stream to read the record from.

      fmt
        The format to read the record in. The default is "binary". Other formats only used internally.

      .. seealso::

         * :ref:`OERecord <OEDataFlow_OERecord>`
         * :ref:`oeistream <OEPlatform_oeistream>`

.. oe:language:: python

   .. oe:function:: read_record

      **read_record** is an alias to the
      :oe:func:`OEDataFlow::OEReadRecord` function.

   .. oe:function:: read_records

      **read_records** is an iterator for the
      :oe:func:`OEDataFlow::OEReadRecord` function.



.. oe:namespace:: OEDataFlow

..  _OEDataFlow_OERecordFromBytes:

.. meta::
   :keywords: OERecordFromBytes OERecord datarecord

.. oe:language:: c++

   .. oe:function:: OERecordFromBytes
   
      .. oe:api::
   
         bool OERecordFromBytes(OERecord& record, const OEBytes& buf)
   
      Reads an :ref:`OERecord <OEDataFlow_OERecord>` object from bytes in
      a binary format.
   
      .. seealso::
   
         * :ref:`OERecord <OEDataFlow_OERecord>`
         * :oe:func:`OEDataFlow::OERecordToBytes`
   
.. oe:language:: python

   .. oe:function:: OERecordFromBytes
   
      .. oe:api::
   
         OERecordFromBytes(record: OERecord, buf: bytes) -> bool
   
      Reads an :ref:`OERecord <OEDataFlow_OERecord>` object from bytes in
      a binary format.
   
      .. seealso::
   
         * :ref:`OERecord <OEDataFlow_OERecord>`
         * :oe:func:`OEDataFlow::OERecordToBytes`
  
   .. oe:function:: record_from_bytes

      **record_from_bytes** is an alias to
      :ref:`OERecordFromBytes <OEDataFlow_OERecordFromBytes>`.


.. oe:namespace:: OEDataFlow

..  _OEDataFlow_OERecordToBytes:

.. meta::
   :keywords: OERecordToBytes OERecord datarecord

.. oe:language:: c++

   .. oe:function:: OERecordToBytes
   
      .. oe:api::
   
         OEBytes OERecordToBytes(const OERecord& record)
   
      Converts an :ref:`OERecord <OEDataFlow_OERecord>` object to bytes
      in a binary format.
   
      .. seealso::
   
         * :ref:`OERecord <OEDataFlow_OERecord>`
         * :oe:func:`OEDataFlow::OERecordFromBytes`

.. oe:language:: python

   .. oe:function:: OERecordToBytes
   
      .. oe:api::
   
         OERecordToBytes(record: OERecord) -> bytes
   
      Converts an :ref:`OERecord <OEDataFlow_OERecord>` object to bytes
      in a binary format.
   
      .. seealso::
   
         * :ref:`OERecord <OEDataFlow_OERecord>`
         * :oe:func:`OEDataFlow::OERecordFromBytes`

   .. oe:function:: record_to_bytes

      record_to_bytes is an alias to the 
      :oe:func:`OEDataFlow::OERecordToBytes` function.



.. # split from OESystemFunctions.rst:2345

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OERegisterMolParameters

.. oe:function:: OERegisterMolParameters

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERegisterMolParameters()

   .. oe:language:: python

      .. oe:api:: python

         OERegisterMolParameters() -> bool



.. # split from OESystemFunctions.rst:2352

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OERegisterOEBInitializer

.. attention::

   |CPPONLY|

.. oe:function:: OERegisterOEBInitializer

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OERegisterOEBInitializer(OEBHandInitializer initializer)

   .. oe:language:: python

      .. oe:api:: python

         OERegisterOEBInitializer(initializer: OEBHandInitializer) -> None


.. # split from OESystemFunctions.rst:2359

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OERotate

.. oe:function:: OERotate

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OERotate(OESystem::OESkewGrid& g, const float* m)

   .. oe:language:: python

      .. oe:api:: python

         OERotate(conf: OEConfBase, m: OEFloatArray) -> None
         OERotate(mcmol: OEMol, m: OEFloatArray) -> None
         OERotate(mol: Union[OEGraphMol,OEQMol], m: OEFloatArray) -> None

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OERotate(OESystem::OESkewGrid& g, const double* m)

   .. oe:language:: python

      .. oe:api:: python

         OERotate(conf: OEConfBase, m: OEDoubleArray) -> None
         OERotate(mcmol: OEMol, m: OEDoubleArray) -> None
         OERotate(mol: Union[OEGraphMol,OEQMol], m: OEDoubleArray) -> None

   In functions above ``m`` is a 9-element array in row-major order


.. # split from OESystemFunctions.rst:2407

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OESNPrintf

.. attention::

   |CPPONLY|

.. oe:function:: OESNPrintf

   .. oe:api::

      int OESNPrintf(char* buffer, size_t bufferSize, const char* format, ...)

   Cross platform implementation of the safe ``snprintf`` C
   function. Provided as a performance improvement over
   :oe:func:`OESystem::OEMakeString`. :oe:func:`OESystem::OEMakeString`
   should still be preferred as it will automatically handle memory
   management.

   .. warning::

      Considered an advanced performance tuning API that may change in
      the future.



.. # split from OESystemFunctions.rst:2367

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OESetMemPoolMode

.. oe:function:: OESetMemPoolMode

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESetMemPoolMode(unsigned int mode)

   .. oe:language:: python

      .. oe:api:: python

         OESetMemPoolMode(mode: int) -> None



.. # split from OESystemFunctions.rst:2374

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OESetThreadSafe

.. oe:function:: OESetThreadSafe

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESetThreadSafe(bool)

   .. oe:language:: python

      .. oe:api:: python

         OESetThreadSafe(arg1: bool) -> None

   Controls whether the internal memory
   allocation and deallocation routines used by *OEChem* (and other
   OpenEye toolkits) should use slower thread-safe implementations, or
   faster single-threaded versions. By default, this value is
   ``true``. This allows *OEChem* molecules and other toolkit objects to be
   allocated and deallocated simultaneously in concurrent operating
   system threads. However, for applications that only have a single
   thread of execution, the use of thread-safe mutual exclusion can
   cause a small performance overhead on some platforms. The current
   setting can be inspected by calling the :oe:func:`OESystem::OEGetThreadSafe`
   function.



.. # split from OESystemFunctions.rst:2392
.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OESetupGrid

.. attention::

   |CPPONLY|

.. oe:function:: OESetupGrid

   .. oe:api::

      template <class GridObject> bool OESetupGrid(GridObject& grid,
                                                   float* xyz, unsigned int N,
                                                   float buffer = 0)



.. # split from OESystemFunctions.rst:2400

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OESigmaNormalizeGrid

.. oe:function:: OESigmaNormalizeGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OESigmaNormalizeGrid(OESystem::OESkewGrid& g)
         float OESigmaNormalizeGrid(OESystem::OEScalarGrid& g)

   .. oe:language:: python

      .. oe:api:: python

         OESigmaNormalizeGrid(g: OEScalarGrid) -> float
         OESigmaNormalizeGrid(g: OESkewGrid) -> float



.. # split from OESystemFunctions.rst:2425

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStaticGetTag

.. attention::

   |CPPONLY|

.. oe:function:: OEStaticGetTag

   .. oe:api::

      template<OEGetTagName GetTagName>
      unsigned int OEStaticGetTag()


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringCSVJoin

.. attention::

   |CPPONLY|

.. oe:function:: OEStringCSVJoin

   .. oe:api::

      std::string OEStringCSVJoin(const std::vector<std::string>& fields,
                                  char delim = ',', char quote = '"')

   Returns a string containing all the values of ``fields`` in the
   comma-separated-value, CSV, format specified by `RFC 4180
   <http://tools.ietf.org/html/rfc4180>`_. The fields will only be
   quoted and escaped if necessary to avoid excess file size. The
   delimiter and quoting character can be changed to alternative
   characters, e.g., a tab delimiter for tab separated files.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringCSVQuote

.. attention::

   |CPPONLY|

.. oe:function:: OEStringCSVQuote

   .. oe:api::

      std::string OEStringCSVQuote(const std::string& s, char delim = ', ',
                                   char quote = '"')

   Returns the string ``s`` optionally surrounded by quotes,
   ``quote``, only if the ``delim`` character occurs in the string or
   the first character of the string is the ``quote`` character. If
   quoted, instances of the ``quote`` character in the string will be
   escaped by inserting inserting another ``quote`` next to it. This
   is the quoting rules as defined by `RFC 4180
   <http://tools.ietf.org/html/rfc4180>`_ for the
   comma-separated-value, CSV, format. This is a low-level CSV
   function, most users can just use
   :oe:func:`OESystem::OEStringCSVJoin` and
   :oe:func:`OESystem::OEStringCSVTokenize`.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringCSVTokenize

.. attention::

   |CPPONLY|

.. oe:function:: OEStringCSVTokenize

   .. oe:api::

      bool OEStringCSVTokenize(std::vector<std::string>& tokens,
                               const std::string& text, char delim = ', ',
                               char quote = '"')

   Parse the ``text`` string into a number of ``tokens`` delimited
   according to the rules of the comma-separated-value, CSV, format
   specified by `RFC 4180 <http://tools.ietf.org/html/rfc4180>`_. The
   delimiter and quoting character can be changed to alternative
   characters, e.g., a tab delimiter for tab separated files.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringCollapseQuotes

.. attention::

   |CPPONLY|

.. oe:function:: OEStringCollapseQuotes

   .. oe:api::

      std::string OEStringCollapseQuotes(const std::string& str,
                                         const std::string& quotes = "\"")

   Replaces all the instance of two consecutive ``quotes`` in ``str``
   with a single instance of that quote. The default is a
   double-quote, the standard for comma-separated-value, CSV,
   files. This is a low-level CSV function, most users can just use
   :oe:func:`OESystem::OEStringCSVJoin` and
   :oe:func:`OESystem::OEStringCSVTokenize`.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringEquals

.. attention::

   |CPPONLY|

.. oe:function:: OEStringEquals

   .. oe:api::

      bool OEStringEquals(const std::string& a, const std::string& b)

   Returns whether the two given string is equivalent using case-insensitive comparison.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringJoin

.. attention::

   |CPPONLY|

.. oe:function:: OEStringJoin

   .. oe:api::

      std::string OEStringJoin(const std::list<std::string>& strgrp,
                               const std::string & delim = " ",
                               bool trailing_delim = true)
      std::string OEStringJoin(const std::vector<std::string>& strgrp,
                               const std::string & delim = " ",
                               bool trailing_delim = true)

   This function returns a new string created by concatenating the
   contents of the specified group of strings ``strgrp`` together
   delimited by the specified parameter ``delim``. If
   ``trailing_delim`` is ``true``, one additional delimiter will be
   appended to the string after the last member of ``strgrp``.



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringLower

.. attention::

   |CPPONLY|

.. oe:function:: OEStringLower

   .. oe:api::

      std::string OEStringLower(const std::string &)

   Returns a copy of the specified string  with all
   of its letters in lower-case format.

   .. seealso::

      * :oe:func:`OESystem::OEStringUpper` function


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringMatch

.. attention::

   |CPPONLY|

.. oe:function:: OEStringMatch

   .. oe:api::

      bool OEStringMatch(const std::string& str, const std::string& pat)

   Returns whether or not the specified pattern string ('pat')
   matches the specified search string ('str'). String matching is
   case-sensitive and wildcards are limited to no more than two per
   pattern.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringSimplifyWhiteSpace

.. attention::

   |CPPONLY|

.. oe:function:: OEStringSimplifyWhiteSpace

   .. oe:api::

      std::string OEStringSimplifyWhiteSpace(const std::string &)

   Returns a copy of the specified string parameter which has
   had all contiguous whitespace characters converted to a single ``' '``.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringStripQuotes

.. attention::

   |CPPONLY|

.. oe:function:: OEStringStripQuotes

   .. oe:api::

      std::string OEStringStripQuotes(const std::string& s,
                                      const std::string& quotes = "\"")

   Removes the leading and trailing character from the string ``s``
   only if the character is the same and is in the parameter
   ``quotes``. This is a low-level CSV function, most users can just
   use :oe:func:`OESystem::OEStringCSVJoin` and
   :oe:func:`OESystem::OEStringCSVTokenize`.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringStripWhiteSpace

.. attention::

   |CPPONLY|

.. oe:function:: OEStringStripWhiteSpace

   .. oe:api::

      std::string OEStringStripWhiteSpace(const std::string &)

   Returns a copy of the specified string parameter which has
   had all whitespace characters at the beginning and the end of the
   text string removed.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringTabsToSpaces

.. attention::

   |CPPONLY|

.. oe:function:: OEStringTabsToSpaces

   .. oe:api::

      std::string OEStringTabsToSpaces(const std::string& s)

   Return the string ``s`` with all the tab characters expanded to 4
   space characters.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringToNumber

.. attention::

   |CPPONLY|

.. oe:function:: OEStringToNumber

   .. oe:api::

      bool OEStringToNumber(const std::string& str, bool& x)
      bool OEStringToNumber(const std::string& str, std::string& x)
      bool OEStringToNumber(const std::string& numstr, float& value)
      bool OEStringToNumber(const std::string& numstr, double& value)
      bool OEStringToNumber(const std::string& numstr, int& value,
                            int base = 10)
      bool OEStringToNumber(const std::string& numstr, short& value,
                            int base = 10)
      bool OEStringToNumber(const std::string& numstr, OELongLong& value,
                            int base = 10)
      bool OEStringToNumber(const std::string& numstr, OEULongLong& value,
                            int base = 10)
      bool OEStringToNumber(const std::string& numstr, unsigned int& value,
                            int base = 10)
      bool OEStringToNumber(const std::string& numstr, unsigned short& value,
                            int base = 10)

   Attempts to convert the specified string  into
   a numerical value in the specified base ('base') and store the generated
   value in the format appropriate to the passed parameter ('value'). The
   function returns whether or not this conversion was successful. If
   the function fails, 'value' is set to ``0``.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`sdfilter.cpp<section_example_oechem_sdfilter>`

  .. oe:language:: python

      * Example program :ref:`sdfilter.py<section_example_oechem_sdfilter>`

  .. oe:language:: java

      * Example program :ref:`SDFilter.java<section_example_oechem_sdfilter>`

  .. oe:language:: csharp

      * Example program :ref:`SDFilter.cs<section_example_oechem_sdfilter>`


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringTokenize

.. attention::

   |CPPONLY|

.. oe:function:: OEStringTokenize

   .. oe:api::

      bool OEStringTokenize(std::list<std::string>& strgrp,
                            const std::string& str,
                            const std::string & delim = " \t\n",
                            bool concat_delim = true)
      bool OEStringTokenize(std::vector<std::string>& strgrp,
                            const std::string& str,
                            const std::string & delim = " \t\n",
                            bool concat_delim = true)

   Break ups the specified input string ('str') into
   individual tokens based on the specified delimiters ('delim'). The
   resulting tokens are stored in the specified string group
   (strgrp). This function always returns ``true``. If *concat_delim*
   is ``true``, the default, consecutive delimiters will be treated as
   a single delimiter. For example, for parsing CSV files *concat_delim*
   should be set to ``false`` to allow for empty fields.

   .. seealso::

      .. oe:language:: c++

         * Example program :ref:`csv2sdf.cpp<section_example_oechem_csv2sdf>`

      .. oe:language:: python

         * Example program using Python csv package: :ref:`csv2sdf.py<section_example_oechem_csv2sdf>`

      .. oe:language:: java

         * Example program :ref:`CSV2SDF.java<section_example_oechem_csv2sdf>`

      .. oe:language:: csharp

         * Example program :ref:`CSV2SDF.cs<section_example_oechem_csv2sdf>`



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringTokenizeQuoted

.. attention::

   |CPPONLY|

.. oe:function:: OEStringTokenizeQuoted

   .. oe:api::

      bool OEStringTokenizeQuoted(std::list<std::string>& strgrp,
                                  const std::string& str,
                                  const std::string & delim = " \t\n",
                                  const std::string & quote = "\'\"",
                                  bool concat_delim = true)
      bool OEStringTokenizeQuoted(std::vector<std::string>& strgrp,
                                  const std::string& str,
                                  const std::string & delim = " \t\n",
                                  const std::string & quote = "\'\"",
                                  bool concat_delim = true)

   Break up the specified input string ``str`` into
   individual tokens based on the specified delimiters ``delim`` while
   maintaining the integrity of quoted text specified by quote
   delimiters ``quote``. The resulting tokens are stored in the
   specified string group ``strgrp``. This function always returns ``true``.

   The ``concat_delim`` parameter specifies whether consecutive
   delimiters should be treated as a single delimiter. If ``false``,
   empty strings will be output into ``strgrp`` between consecutive
   delimiters.

   The defaults of this function are set up for parsing whitespace
   separated fields usually found in configuration files. For parsing
   comma separated or tab separated file formats, the
   :oe:func:`OESystem::OEStringCSVTokenize` will be easier to use.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringTranslate

.. attention::

   |CPPONLY|

.. oe:function:: OEStringTranslate

   .. oe:api::

      std::string OEStringTranslate(const std::string &)


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OEStringUpper

.. attention::

   |CPPONLY|

.. oe:function:: OEStringUpper

   .. oe:api::

      std::string OEStringUpper(const std::string &)

   Returns a copy of the specified string with all
   of its letters in upper-case format.

   .. seealso::

      * :oe:func:`OESystem::OEStringLower` function


.. # split from OESystemFunctions.rst:2702

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OESubtractGrid

.. oe:function:: OESubtractGrid

   .. oe:api::

      template<class GridType1, class GridType2>
      bool OESubtractGrid(GridType1& grid1, const GridType2& grid2)



.. # split from OESystemFunctions.rst:2710

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OETanimoto

.. oe:function:: OETanimoto

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OETanimoto(const OEBitVector& a, const OEBitVector& b)

   .. oe:language:: python

      .. oe:api:: python

         OETanimoto(a: OEBitVector, b: OEBitVector) -> float

   Calculates the ``Tanimoto similarity coefficient`` between two
   :oe:cls:`OEBitVectors<OESystem::OEBitVector>`.
   This is defined as the
   number of bits that the two bitmaps/fingerprints have in common
   divided by the total of bits set in either. This function does not
   require that the two :oe:cls:`OEBitVectors<OESystem::OEBitVector>`
   be the same size, the bits
   lacking from the shorter :ref:`OEBitVector <OESystem_OEBitVector>` being interpreted as all
   zeros. This function always returns ``1.0``, if the two
   :oe:cls:`OEBitVectors<OESystem::OEBitVector>`
   are equal, even if they are both empty.



.. # split from OESystemFunctions.rst:2729

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OETranslate

.. oe:function:: OETranslate

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OETranslate(OESystem::OESkewGrid& g, const float* t)
         void OETranslate(OESystem::OESkewGrid& g, const double* t)

   .. oe:language:: python

      .. oe:api:: python

         OETranslate(conf: OEConfBase, v: OEFloatArray) -> None
         OETranslate(mcmol: OEMol, v: OEFloatArray) -> None
         OETranslate(mol: Union[OEGraphMol,OEQMol], v: OEFloatArray) -> None
         OETranslate(conf: OEConfBase, v: OEDoubleArray) -> None
         OETranslate(mcmol: OEMol, v: OEDoubleArray) -> None
         OETranslate(mol: Union[OEGraphMol,OEQMol], v: OEDoubleArray) -> None



.. # split from OESystemFunctions.rst:2737

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESystem

.. meta::
   :keywords: OETrimToSigFigs

.. attention::

   |CPPONLY|

.. oe:function:: OETrimToSigFigs

   .. oe:api::

      std::string OETrimToSigFigs(const std::string& numstr)

   Strips trailing zeros from a string representing a decimal
   number. Nothing is stripped if no decimal point is given. A single
   zero character is left if only zeros follow the decimal point. The
   function is smart enough to properly deal with scientific notation
   formats. The following table is an example of inputs and outputs to
   the function.

   ===================== =====================
   Input                 Output
   ===================== =====================
   1.00000               1.0
   --------------------- ---------------------
   1.0                   1.0
   --------------------- ---------------------
   3.141600              3.1416
   --------------------- ---------------------
   3.141600E+00          3.1416E+00
   ===================== =====================



.. # split from OESystemFunctions.rst:2763

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEUnknownOEBDataTagName

.. oe:function:: OEUnknownOEBDataTagName

   .. oe:api::

      const char* OEUnknownOEBDataTagName()



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEUpdateOpts

.. _OESystem_OEUpdateOpts:

.. oe:function:: OEUpdateOpts

   .. oe:language:: c++ java csharp
      
      .. oe:api::

         bool OEUpdateOpts(OEOptions& opts, const OEInterface& itf)

   This method updates the parameter settings of the specified :ref:`OEOptions <OESystem_OEOptions>`
   with the corresponding parameter settings of the :ref:`OEInterface <OESystem_OEInterface>`.
   Two parameters between the :ref:`OEOptions <OESystem_OEOptions>` and :ref:`OEInterface <OESystem_OEInterface>`
   are considered same if they have a common name and data type.


.. # split from OESystemFunctions.rst:2770

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEWriteGrid

.. oe:function:: OEWriteGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteGrid(const std::string& filename,
                          const OESystem::OESkewGrid& grid)
         bool OEWriteGrid(const std::string& filename,
                          const OESystem::OEScalarGrid& grid)
         bool OEWriteGrid(OEPlatform::oeostream& ofs,
                          const OESystem::OESkewGrid& grid,
                          unsigned int filetype)
         bool OEWriteGrid(OEPlatform::oeostream& ofs,
                          const OESystem::OEScalarGrid& grid,
                          unsigned int filetype)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteGrid(filename: str, grid: OEScalarGrid) -> bool
         OEWriteGrid(filename: str, grid: OESkewGrid) -> bool
         OEWriteGrid(ofs: oeostream, grid: OEScalarGrid, filetype: int) -> bool
         OEWriteGrid(ofs: oeostream, grid: OESkewGrid, filetype: int) -> bool

   Writes a grid (:ref:`OESkewGrid <OESystem_OESkewGrid>`, :ref:`OEScalarGrid <OESystem_OEScalarGrid>` )
   to a file.



.. # split from OESystemFunctions.rst:2785

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEWriteHtml

.. oe:function:: OEWriteHtml

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteHtml(const OEInterface& itf, OEPlatform::oeostream& ostr,
                          std::string program_name, std::string program_version)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteHtml(itf: OEInterface, ostr: oeostream, program_name: str,
                     program_version: str) -> bool



.. # split from OESystemFunctions.rst:2793

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEWriteInterfaceConfigurationFile

.. oe:function:: OEWriteInterfaceConfigurationFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteInterfaceConfigurationFile(const OEInterface& itf,
                                                OEPlatform::oeostream& ostr)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteInterfaceConfigurationFile(itf: OEInterface, ostr: oeostream) -> bool



.. # split from OESystemFunctions.rst:2801

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. meta::
   :keywords: OEWriteOldStyleGrid

.. oe:function:: OEWriteOldStyleGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteOldStyleGrid(OEPlatform::oeostream& ostr,
                                  const OEFixedGrid<float>& grid)
         bool OEWriteOldStyleGrid(OEPlatform::oeostream& ostr,
                                  const OEFixedMultiGrid<float>& grid,
                                  unsigned int cur_grid = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteOldStyleGrid(ostr: oeostream, grid: OEFixedFloatGrid) -> bool
         OEWriteOldStyleGrid(ostr: oeostream, grid: OEFixedMultiFloatGrid,
                             cur_grid: int = 0) -> bool



.. oe:namespace:: OEDataFlow

..  _OEDataFlow_OEWriteRecord:

.. meta::
   :keywords: OEWriteRecord OERecord datarecord

.. oe:language:: c++

   .. oe:function:: OEWriteRecord

      .. oe:api::

         bool OEWriteRecord(OEPlatform::oeostream& ofs, const OERecord& record,
                            const std::string& fmt = "binary")

      Writes a record to an output stream, and returns *true* if the
      write is successful.

      ofs
        The output stream to which the record will be written.

      record
        The :ref:`OERecord <OEDataFlow_OERecord>` object to be written.

      fmt
        The format to be written. Default values is "binary". Other formats only used internally.

.. oe:language:: python

   .. oe:function:: OEWriteRecord

      .. oe:api::

         OEWriteRecord(ofs: Union[BinaryIO, TextIO, oeostream],
                       record: OERecord, fmt: str = "binary") -> bool

      Writes a record to an output stream, and returns *True* if the
      write is successful.

      ofs
        The output stream or file to which the record will be written.

      record
        The :ref:`OERecord <OEDataFlow_OERecord>` object to be written.

      fmt
        The format to be written.  Default values is "binary". Other formats only used internally.

   .. oe:function:: write_record

      **write_record** is an alias to the
      :oe:func:`OEDataFlow::OEWriteRecord` function.


.. # split from OESystemFunctions.rst:2812

.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. oe:namespace:: OESystem

.. _OESystem_OEWriteSettings:

.. meta::
   :keywords: OEWriteSettings

.. oe:function:: OEWriteSettings

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteSettings(const OEInterface& itf,
                              OEPlatform::oeostream& ostr = OEOUT,
                              bool include_default = true,
                              std::string mode = "")

   .. oe:language:: python

      .. oe:api:: python

         OEWriteSettings(itf: OEInterface, ostr: oeostream = oeout,
                         include_default: bool = True, mode: str = "") -> bool

   The function writes the current setting of 'itf' to 'ostr'.
   If 'include_default' is ``true`` all parameter will be listed, otherwise
   only parameters specified by the user will be listed.

   The format of this output is such that if 'ostr' is a file stream,
   the created file can be used as a parameter file (*i.e.* passed to a
   param_file parameter) in a subsequent run.
   The function returns ``true`` if it succeeds and ``false`` otherwise.

   'mode' specifies a name of an optimized parameter set for OpenEye's
   applications.

OEBitVector Operators
------------------------------------



*******************************************************************************
OESystem Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEAddContour.rst
   OEAddGrid.rst
   OEAnnotateArrow.rst
   OEAnnotateBox.rst
   OEAnnotateCylinder.rst
   OEAnnotateEllipsoid.rst
   OEAnnotateLine.rst
   OEAnnotateSphere.rst
   OEAnnotateSpline.rst
   OEAnnotateSplineSurface.rst
   OEAnnotateSymbol.rst
   OEAnnotateText.rst
   OEAnnotateTorus.rst
   OEAttachData.rst
   OEBDataLengthBytes.rst
   OEBFPosTEndian.rst
   OEBFloatEndian.rst
   OEBIntEndian.rst
   OEBPeekTag.rst
   OEBReadData.rst
   OEBReadDataLength.rst
   OEBReadOEBase.rst
   OEBReadPOD.rst
   OEBReadTag.rst
   OEBShortEndian.rst
   OEBWriteData.rst
   OEBWriteDataLength.rst
   OEBWriteOEBase.rst
   OEBWritePOD.rst
   OEBWriteTag.rst
   OEBitIsPowerOf2.rst
   OEBitVectorAnd.rst
   OEBitVectorEqual.rst
   OEBitVectorNot.rst
   OEBitVectorNumBytes.rst
   OEBitVectorNumWords.rst
   OEBitVectorOr.rst
   OEBitVectorSub.rst
   OEBitVectorXor.rst
   OECastData.rst
   OECheckHelp.rst
   OEClearGridBoundary.rst
   OEColorCreate.rst
   OEColorGet.rst
   OEColorPacked.rst
   OEColorSet.rst
   OEConfigure.rst
   OECopyArray.rst
   OECopyBaseData.rst
   OECopyBits.rst
   OECount.rst
   OEDivideGrid.rst
   OEErrorLevelToString.rst
   OEFileExtension.rst
   OEFileExtensions.rst
   OEGetBitCounts.rst

.. oe:language:: python

   .. toctree::
      :maxdepth: 1

      OEGetBytesFromGrid.rst

.. oe:language:: java

   .. toctree::
      :maxdepth: 1

      OEGetByteArrayFromScalarGrid.rst
      OEGetByteArrayFromSkewGrid.rst

.. toctree::
   :maxdepth: 1

   OEGetCenterAndExtents.rst
   OEGetColors.rst
   OEGetContourColor.rst
   OEGetContourLevel.rst
   OEGetContrastColors.rst
   OEGetDataType.rst
   OEGetDeepColors.rst
   OEGetFileEndian.rst
   OEGetGridFileType.rst
   OEGetGridFormatExtension.rst
   OEGetGridFormatString.rst

.. oe:language:: python

   .. toctree::
      :maxdepth: 1

      OEGetScalarGridFromBytes.rst
      OEGetSkewGridFromBytes.rst

.. oe:language:: java

   .. toctree::
      :maxdepth: 1

      OEGetScalarGridFromByteArray.rst
      OEGetSkewGridFromByteArray.rst

.. toctree::
   :maxdepth: 1

   OEGetHostEndian.rst
   OEGetKappa.rst
   OEGetLightColors.rst
   OEGetMemPoolMode.rst
   OEGetOEBReturnString.rst
   OEGetPrefactor.rst
   OEGetRadius.rst
   OEGetTag.rst
   OEGetThreadSafe.rst
   OEGetVividColors.rst
   OEGetWidth.rst
   OEGridAvgVal.rst
   OEGridCopyContents.rst
   OEGridCopyGeometry.rst
   OEGridGetArch.rst
   OEGridGetLicensee.rst
   OEGridGetPlatform.rst
   OEGridGetRelease.rst
   OEGridGetSite.rst
   OEGridGetVersion.rst
   OEGridHasNonZeroValue.rst
   OEGridIsLicensed.rst
   OEGridMaxVal.rst
   OEGridMinVal.rst
   OEGridSameGeometry.rst
   OEGridSizeMultiply.rst
   OEGridSetAllElements.rst
   OEHasTag.rst
   OEInitAnnotationHandlers.rst
   OEInitGridHandlers.rst
   OEInitializeHandler.rst
   OEInterpolateBetweenGrids.rst
   OEIsEmpty.rst
   OEIsGrid.rst
   OEIsReadableGrid.rst
   OEIsSafeCast.rst
   OEIsSameTypeTester.rst
   OEIsWriteableGrid.rst
   OELinearInterpolate.rst
   OEMTZMapTypeFromString.rst
   OEMTZMapTypeToString.rst
   OEMakeGaussians.rst
   OEMakeGridFromCenterAndExtents.rst
   OEMakeHex.rst
   OEMakeMolecularGaussianGrid.rst
   OEMakeRegularGrid.rst
   OEMakeRegularSubGrid.rst
   OEMakeString.rst
   OEMaskGrid.rst
   OEMaskGridByCoordsAndRadii.rst
   OEMaskGridByMolecule.rst
   OEMaskGridValues.rst
   OEMoveArray.rst
   OEMultiplicationWillOverflow.rst
   OEMultiplyGrid.rst
   OENumContours.rst
   OENumberToString.rst
   OEParseCommandLine.rst
   OEParseCommandLineLW.rst
   OEParseHex.rst
   OEParseParameterFile.rst
   OEReadCIFGridFile.rst
   OEReadGrid.rst
   OEReadMTZ.rst
   OEReadOldStyleGrid.rst
   OERegisterMolParameters.rst
   OERegisterOEBInitializer.rst
   OERotate.rst
   OESNPrintf.rst
   OESetMemPoolMode.rst
   OESetThreadSafe.rst
   OESetupGrid.rst
   OESigmaNormalizeGrid.rst
   OEStaticGetTag.rst
   OEStringCSVJoin.rst
   OEStringCSVQuote.rst
   OEStringCSVTokenize.rst
   OEStringCollapseQuotes.rst
   OEStringEquals.rst
   OEStringJoin.rst
   OEStringLower.rst
   OEStringMatch.rst
   OEStringSimplifyWhiteSpace.rst
   OEStringStripQuotes.rst
   OEStringStripWhiteSpace.rst
   OEStringTabsToSpaces.rst
   OEStringToNumber.rst
   OEStringTokenize.rst
   OEStringTokenizeQuoted.rst
   OEStringTranslate.rst
   OEStringUpper.rst
   OESubtractGrid.rst
   OETanimoto.rst
   OETranslate.rst
   OETrimToSigFigs.rst
   OEUnknownOEBDataTagName.rst
   OEWriteGrid.rst
   OEWriteHtml.rst
   OEWriteInterfaceConfigurationFile.rst
   OEWriteOldStyleGrid.rst
   OEWriteSettings.rst


*******************************************************************************
Preliminary OESystem Functions
*******************************************************************************

..  toctree::
    :maxdepth: 1

    OEConfigureItf.rst
    OEConfigureOpts.rst
    OEUpdateOpts.rst
    OEMakeMatchField.rst
    OEReadRecord.rst

..  oe:language:: c++ python

    ..  toctree::
        :maxdepth: 1

        OEMakeField.rst
        OERecordFromBytes.rst
        OERecordToBytes.rst
        OEWriteRecord.rst


.. _chapter_SMARTS:

********************************************************************************
SMARTS Pattern Matching
********************************************************************************

.. index:: SMARTS, Daylight SMARTS, Daylight

.. _section_SMARTS_syntax:

SMARTS Syntax
================================================================================

SMARTS is a line notation developed by Daylight Chemical Information Systems
for compactly representing molecular substructure queries.
The SMARTS language can be considered an extension or generalization of
Daylight's SMILES notation for representing discrete molecules.

A SMARTS syntax overview can be found at
`the documentation of SMARTS on the Daylight Chemical Information Systems site <http://www.daylight.com/dayhtml/doc/theory/theory.smarts.html>`_

.. _section_SMARTS_atomprim:

Atom Primitives
================================================================================

.. index:: SMARTS atom primitives

.. table::

   ======================= ================================= ============== ===============================
   Symbol                  Description                       Argument?      Default Value
   ======================= ================================= ============== ===============================
   ``A``                   non-aromatic (aliphatic) atom     no             (no default)
   ``a``                   aromatic atom                     no             (no default)
   ``D<n>``                degree (explicit connections)     yes            (no default)
   ``H<n>``                total hydrogen count              optional       exactly one
   ``h<n>``                implicit hydrogen count           optional       exactly one
   ``R<n>``                ring bond count [1]               optional       any ring atom
   ``x<n>``                ring bond count [2]               optional       any ring atom
   ``r<n>``                smallest ring size                optional       any ring atom
   ``v<n>``                valence (total bond order)        yes            (no default)
   ``X<n>``                connectivity (total connections)  yes            (no default)
   ``#<n>``                atomic number [3]                 yes            (no default)
   ``+<n>``                positive charge                   optional       +1 cation (++ is +2, etc)
   ``-<n>``                negative charge                   optional       -1 anion (-- is -2, etc)
   ``^<n>``                atomic hybridization [4]          yes            (no default)
   ``@``                   anticlockwise local chirality     no
   ``@@``                  clockwise local chirality         no
   ``@<n>``                chirality class                   optional       anticlockwise
   ``n``          explicit atomic mass              no
   ======================= ================================= ============== ===============================

**Table footnote:**

**[1]**
The semantics of the ring count primitive, ``R``, differs  slightly between
Daylight SMARTS and OpenEye SMARTS.
In Daylight semantics, ``R<n>`` means that an atom is in ``n`` rings of the
chosen SSSR.
As the choice of SSSR is non-deterministic, this interpretation can cause an
arbitrary set of atoms to match depending upon input order.
For example, in the symmetric molecule, cubane, four of the eight atoms will
appear in two SSSR rings, and half of the atoms appear in three, but the choice is
made almost randomly.  Rather than attempt to reproduce these weak
semantics, OpenEye strengthens the definition of ``R<n>`` to mean the
number of ring bonds to an atom, which is graph invariant and therefore
independent of a molecule's input order.  Notice, that the interpretation of
``[R]`` and ``[R0]``, *i.e.* ring membership, remains the same.
Similarly, Daylight ``[R1]`` is approximately equal to OpenEye ``[R2]``,
and Daylight ``[R2]`` is approximately equivalent to OpenEye ``[R3]``.

**[2]**
Note that ``[x]`` was implemented by Daylight v4.9 and **OEChem TK** 1.5, and is
exactly synonymous to **OEChem TK**'s ``[R]``.

**[3]**
In OEChem, ``#0`` indicates wildcard or attachment atoms.
For example, the :oe:meth:`OEChem::OEAtomBase::GetAtomicNum`
method returns ``0`` for R-Group atoms (for example it would match the R-groups of a molecule initialized 
as ``CC[R1]``, ``CC[R]``, or ``CC[*]``).
:oe:meth:`OEChem::OEAtomBase::GetAtomicNum` also returns 0 for color atoms.

**[4]**
The atomic hybridization primitive, ``^``, is an **OpenEye*** extension that
is not available in Daylight SMARTS, but can be implemented using
recursive SMARTS.

.. _section_SMARTS_bondprim:

Bond Primitives
================================================================================

.. index:: SMARTS bond primitives

.. table::

   ================== ======================================
   Syntax             Description
   ================== ======================================
   default            single or aromatic
   ``-``              single bond (not aromatic)
   ``=``              double bond (not aromatic)
   ``#``              triple bond
   ``~``              any bond (wildcard)
   ``:``              aromatic bond
   ``@``              ring bond
   ``/``              directional single 'up' bond
   ``\``              directional single 'down' bond
   ``/?``             directional 'up' or unspecified
   ``\?``             directional 'down' or unspecified
   ================== ======================================

.. _section_SMARTS_logic:

Logical Operators
================================================================================

.. index:: SMARTS logical operations

.. table::

   =============== ======================================
   Syntax          Description
   =============== ======================================
   ``!e``          not ``e``
   ``e1 & e2``     ``e1`` and ``e2`` (high precedence)
   ``e1,e2``       ``e1`` or ``e2``
   ``e1;e2``       ``e1`` and ``e2`` (low precedence)
   =============== ======================================

.. _section_SMARTS_examples:

Examples
================================================================================

.. list-table:: **Example of matching any defined stereo centers**

    * - SMARTS: ``[C;$([*@]([*])([*]))]``
    * - .. image:: images/SMARTS_MatchingDefinedStereo.*

.. list-table:: **Example of matching any undefined stereo centers**

    * - SMARTS: ``[C;!$([*@]([*])([*]))]``
    * - .. image:: images/SMARTS_MatchingUndefinedStereo.*



.. _chapter_SMILES:

********************************************************************************
SMILES Line Notation
********************************************************************************

.. index:: SMILES, Daylight SMILES, Daylight

A SMILES syntax overview can be found at
`the documentation of SMILES on the Daylight Chemical Information Systems site <http://www.daylight.com/dayhtml/doc/theory/theory.smiles.html>`_

Unfortunately, there are a number of ambiguities in the original paper
describing the Daylight SMILES syntax (refs below).  These have led to different SMILES
being accepted or rejected by different SMILES parser implementations.
The following historical table illustrates some of these corner-cases.
These types of cases continue to be an issue with SMILES parsers.

.. table:: **Differences between various SMILES parser implementations**

   ================ ============ ============ ============ ============ ============ ============ =================
   SMILES           Daylight     Corina       Corina       Concord      COBRA        Synopsis     OEChem
                    4.4-4.9      1.6          WWW          3.2.1        3.21A        4.0          |oechemversion|
   ================ ============ ============ ============ ============ ============ ============ =================
   ``C1.C1``        Y            Y            Y            N            N            Y            Y
   ``C%00CC%00``    Y            Y            Y            N            N            N            Y
   ``C(C.C)C``      Y            Y            Y            N            N            Y            Y
   ``C(C)1CC1``     Y            N            N            N            Y            N            Y
   ``C(.C)``        Y            Y            Y            N            N            Y            Y
   ``C()``          Y            Y            N            Y            Y            Y            Y
   ``(CO)=O``       N            N            N            N            N            Y            Y
   ``(C)``          N            N            N            N            N            Y            Y
   ``.C``           N            N            N            Y            Y            N            Y
   ``C..C``         N            Y            N            Y            Y            N            Y
   ``C.``           N            Y            Y            Y            Y            Y            Y
   ``C=(O)C``       N            Y            N            N            Y            N            N
   ``C((C))``       N            Y            N            Y            N            Y            Y
   ``C.(C)``        N            Y            N            Y            N            N            Y
   ``C1CC(=1)``     N            Y            N            N            N            N            Y
   ``C1CC(1)``      N            N            N            N            N            N            Y
   ``C(C.)``        N            Y            N            N            N            N            Y
   ``C==C``         N            Y            N            N            N            N            Y
   ``C(1CC1)``      N            N            N            N            N            N            Y
   ``C(1)CC1``      N            N            N            N            N            N            Y
   ================ ============ ============ ============ ============ ============ ============ =================

Because of these types of SMILES ambiguities, the **OEChem TK** SMILES parser
has two modes.  The default is *`relaxed`*, which is more forgiving
and accepts SMILES as per the table above and enables the SMILES extensions
described in the next section.  The SMILES parser also has a *`strict`* mode
that is far less forgiving about dubious SMILES strings.

Extensions to Daylight SMILES
================================================================================

The **OEChem TK** SMILES parsers support several minor extensions to Daylight syntax.
Each of these extensions and its motivations are listed below.

**Quadruple Bond**
  In addition to ``-``, ``=`` and ``#`` for specifying single, double and
  triple bonds respectively, **OEChem TK** also supports ``$`` for specifying
  quadruple bonds.  An example would be octachlorodirhenate (III), which
  is written as ``[Rh-](Cl)(Cl)(Cl)(Cl)$[Rh-](Cl)(Cl)(Cl)Cl``.

**Unquoted and Additional Elements**
  In addition to the standard Daylight unquoted elements, B, C, N, O, F,
  P, S, Cl, Br and I, **OEChem TK**'s SMILES readers also allow ``H``, ``D`` and ``T``
  to  specify hydrogen, deuterium and tritium.  Additionally, to support
  Syracuse SMILES, 'CL' and 'BR' are considered 'Cl' and 'Br'.
  The periodic table is also extended from 102 to 109 elements, *i.e.*
  ``[Sg]`` for Seaborgium, with the addition of ``[D]`` and
  ``[T]`` representing ``[2H]`` and ``[3H]`` respectively.

  **OEChem TK** may support ``Na``, ``Li``, and ``K`` as
  unquoted elements to support Syracuse SMILES at some point in the future.

**Aromatic Tellurium**
  In order to support OpenEye's aromaticity model, which allows
  Tellurium to be aromatic, the SMILES parser has been extended to
  support ``[te]``, such as in tellurophene, ``[te]1cccc1``,
  which follows in the sequence furan (``o1cccc1``),
  thiophene (``s1cccc1``) and selenophene (``[se]1cccc1``).

**Atom Maps in Molecules**
  Traditionally, SMILES atom maps, *i.e.* ``[Pb:1]``, are only ever
  used and specified in reaction molecules, ``[Pb:1]>>[Au:1]``.
  However, **OEChem TK** extends this notion to allow atom maps to be used in
  discrete molecules.
  This is often useful for denoting significant sites or attachment points
  in a molecule.  Traditionally in SMILES, isotopes of element zero have
  been used to perform this role, however in **OEChem TK** both ``[*:1]`` and
  ``[1*]`` may be used.

**RGroup Attachment Points**
  As a short hand to support specifying templates for combinatorial
  libraries, and to support existing Cactus and JChem/Marvin usage,
  **OEChem TK** allows ``[R2]`` to be used as short-hand for ``[*:2]``.
  For inquiring minds, the SMILES ``[R2:3]`` is interpreted as ``[*:3]``
  or ``[R3]``, with the last specification taking priority.

**External Bond Attachment Points**
  **OEChem TK** SMILES also allows supports external closures, or potentially
  unsatisfied *ring closures*.  These have the syntax, ampersand followed
  by a ring closure specification, *i.e.* an optional bond order followed
  by either a digit or a ``%`` character and two digits.  The index space
  of external bonds and ring closures is separate, so that the ring
  closure ``2`` and the external attachment point ``&2`` are unrelated.

  When external attachment points are paired within a SMILES string,
  they behave identically to ring closures, using a separate index
  space.  Hence, the SMILES ``c&1ccccc&1`` is interpreted the same
  way as ``c1ccccc1``, and ``C&1.C&1`` is interpreted like ``C1.C1``,
  *i.e.* the SMILES ``CC``.

  However, unlike ring closures, unpaired external attachment points
  are allowed and are interpreted like RGroup attachment points above.
  Hence, the SMILES ``CC&1`` (on its own) is equivalent to the RGroup
  attachment SMILES ``CC[R1]``, which is equivalent to the atom mapped
  molecule ``CC[*:1]``.

  The major advantage of these semantics, inspired by Daylight's CHUCKLES,
  is that it allows convenient enumeration of combinatorial libraries
  using string concatenation.  For example, three components of a library
  may be specified as ``C&1CCC&2``, ``F&1`` and ``Br&2``.
  The combined string ``C&1CCC&2.F&1.Br&2`` is interpreted as the reaction
  product, *i.e.* ``FCCCCBr``.

  As with ring closures, bond orders may be specified after the ampersand
  and before the closure index, ``C&=1``, and two digit closures are
  indicated by a ``%`` prefix, *i.e.* ``C&%12`` or ``C&=%12``.

.. seealso::

       * [Weininger-1988]_
       * [Weininger-1989]_


===
API
===

.. _oechem_part_api:

********************************
OEChem API
********************************

.. toctree::
   :maxdepth: 2

   OEChemClasses/OEChemClasses
   OEChemConstants/OEChemConstants
   OEChemFunctions/index

********************************
Preliminary OEChem API
********************************

.. toctree::
   :maxdepth: 2

   OEChemClasses/OEChemClasses-preliminary.rst
   OEChemConstants/OEChemConstants-preliminary.rst
   OEChemFunctions/index-preliminary.rst

********************************
OESystem API
********************************

.. toctree::
   :maxdepth: 2

   OESystemClasses/OESystemClasses
   OESystemConstants/OESystemConstants
   OESystemFunctions/index

********************************
Preliminary OESystem API
********************************

.. toctree::
   :maxdepth: 2

   OESystemClasses/OESystemClasses-preliminary.rst
   OESystemConstants/OESystemConstants-pre.rst
   OESystemFunctions/index-preliminary.rst

********************************
OEPlatform API
********************************

.. toctree::
   :maxdepth: 2

   OEPlatformClasses/OEPlatformClasses
   OEPlatformConstants/OEPlatformConstants
   OEPlatformFunctions/index

********************************
OEMath API
********************************

.. toctree::
   :maxdepth: 2

   OEMathClasses/OEMathClasses
   OEMathConstants/OEMathConstants
   OEMathFunctions/index

********************************
OEBio API
********************************

.. toctree::
   :maxdepth: 2

   OEBioClasses/OEBioClasses
   OEBioConstants/OEBioConstants
   OEBioFunctions/index

********************************
Preliminary OEBio API
********************************

.. toctree::
   :maxdepth: 2

   OEBioFunctions/index-preliminary


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _chapter_aromaticity:

********************************************************************************
Aromaticity Perception
********************************************************************************

.. _section_aromaticity_huckel:

Aromaticity and  |Huckel|'s rule
================================================================================

.. index: aromaticity models

**OEChem TK**'s aromaticity perception routines are based around the |Huckel|'s
rule that defines cyclic conjugated systems with :math:`(4N+2)` number of
:math:`\pi` electrons as aromatic (where :math:`N` is zero or any positive integer).

Aromaticity can be set using the
:oe:func:`OEAssignAromaticFlags<OEChem::OEAssignAromaticFlags>` function,
which takes an :oe:cls:`OEMolBase<OEChem::OEMolBase>` argument.
The :oe:func:`OEAssignAromaticFlags<OEChem::OEAssignAromaticFlags>` sets
the aromaticity flags on atoms and bonds using an aromaticity model.
(For the list of available aromaticity models in *OEChem TK** see
section :ref:`section_aromaticity_models`. )

.. oe:source:: PerceiveAromaticity.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-AROM-PERCEIVE

..  oe:language:: python

    .. oe:source:: PerceiveAromaticity.py
       :language: python
       :noindent:
       :frag:     SNIPPET-AROM-PERCEIVE

.. oe:source:: PerceiveAromaticity.py
   :language: python
   :caption:  Complete Code for PerceiveAromaticity.py

..  oe:language:: python

    ..  admonition:: Download PerceiveAromaticity.py

        :download:`PerceiveAromaticity.py <../../../../wrappers/python/docexamples/oechem/PerceiveAromaticity.py>`

.. oe:source:: PerceiveAromaticity.java
   :language: java
   :noindent:
   :frag:     SNIPPET-AROM-PERCEIVE

.. oe:source:: PerceiveAromaticity.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-AROM-PERCEIVE

.. hint::

   The :oe:func:`OEChem::OESmilesToMol` function automatically perceives
   the aromaticity of the molecule  using the *default*
   :oe:const:`OEChem::OEAroModel::OpenEye` aromaticity model.

The following two code snippets demonstrate how to loop over aromatic atoms
using the :oe:cls:`OEIsAromaticAtom<OEChem::OEIsAromaticAtom>` functor and
the :oe:meth:`IsAromatic<OEChem::OEAtomBase::IsAromatic>` method of
the :oe:cls:`OEAtomBase<OEChem::OEAtomBase>` class.

.. oe:source:: PerceiveAromaticity.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-AROM-LOOP1

.. oe:source:: PerceiveAromaticity.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-AROM-LOOP2

.. oe:source:: PerceiveAromaticity.py
   :language: python
   :noindent:
   :frag:     SNIPPET-AROM-LOOP1

.. oe:source:: PerceiveAromaticity.py
   :language: python
   :noindent:
   :frag:     SNIPPET-AROM-LOOP2

.. oe:source:: PerceiveAromaticity.java
   :language: java
   :noindent:
   :frag:     SNIPPET-AROM-LOOP1

.. oe:source:: PerceiveAromaticity.java
   :language: java
   :noindent:
   :frag:     SNIPPET-AROM-LOOP2

.. oe:source:: PerceiveAromaticity.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-AROM-LOOP1

.. oe:source:: PerceiveAromaticity.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-AROM-LOOP2

The aromatic bonds of a molecule can similarly be accessed using the
:oe:cls:`OEIsAromaticBond<OEChem::OEIsAromaticBond>` functor and the
:oe:meth:`IsAromatic<OEChem::OEBondBase::IsAromatic>` method of the
:oe:cls:`OEBondBase<OEChem::OEBondBase>` class.
For more information about functors see chapter :ref:`chapter_predicates`.

The user can also set the atom and bond aromaticity flags manually using the
:oe:meth:`OEChem::OEAtomBase::SetAromatic` and
:oe:meth:`OEChem::OEBondBase::SetAromatic` methods.

.. _section_aromaticity_models:

Aromaticity Models in OEChem TK
================================================================================

The :oe:func:`OEAssignAromaticFlags<OEChem::OEAssignAromaticFlags>` function can
also take an aromaticity model constant as an argument to perceive various
aromaticity models.
The following aromaticity models are available in **OEChem TK**:

#. :oe:const:`OpenEye<OEChem::OEAroModel::OpenEye>` (default model)

#. :oe:const:`Daylight<OEChem::OEAroModel::Daylight>`

#. :oe:const:`Tripos<OEChem::OEAroModel::Tripos>`

#. :oe:const:`MDL<OEChem::OEAroModel::MDL>`

#. :oe:const:`MMFF<OEChem::OEAroModel::MMFF>`

The following table demonstrates the differences between the five available aromaticity models.

.. figure:: oechemtk/images/OEAssignAromaticFlags_Table.*
   :scale:  100
   :align:  center

**Table footnotes:**

**[1]**
*Atomic elements such as Te, B, Se are not available in the  MMFF and Tripos
aromaticity models.*

**[2]**
*Only two out of the four five-membered rings are recognized as aromatic.*

..
   INTERNAL DOCUMENTATION! DO NOT PUBLISH OR EXPOSE VIA BETA-DOCS WITHOUT REVIEW/CONSENT FROM: KB, JH, BL

..
   The following table demonstrates the differences between the five available aromaticity
   models: each cell identifies the number of perceived aromatic bonds versus the total number of bonds from each model.

   **MDL classic** aromaticity is the legacy aromatic perception from MDL that identified alternating single and double 6-membered rings without regard for atom types.

   **MDL enhanced** aromaticity is an augmented perception from MDL that identified alternating single and double 6-membered rings, and added 5-membered hetero- or C-anion rings, and the perimeter ring of azulene.  Atom types were generally not considered except for the 5-ring case.

   .. figure:: oechemtk/images/OEAssignAromaticFlags_Table2.*
      :scale:  100
      :align:  center

   **Table footnotes:**

   **[1]**
   *Atomic elements such as Te, B, Se are not available in the  MMFF and Tripos
   aromaticity models.*

   **[2]**
   *Correct for MDL classic aromaticity*

   **[3]**
   *Incorrect for MDL classic aromaticity*

   **[4]**
   *Correct for MDL enhanced aromaticity*

   **[5]**
   *Incorrect for MDL enhanced aromaticity*

   **[6]**
   *Partially correct: MDL enhanced aromaticity - only one pyrrole ring would have been perceived as aromatic; MDL classic aromaticity - no bonds would have been considered aromatic*

The code in :oe:src:`Listing 1<SNIPPET-Aromaticity>` demonstrates how to perceive aromaticity
with these available models.

.. oe:source:: Aromaticity.cpp
   :language: c++
   :refnum:   1
   :caption:  Aromaticity perception with various models
   :frag:     SNIPPET

.. oe:source:: Aromaticity.py
   :language: python
   :refnum:   1
   :caption:  Aromaticity perception with various models
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-Aromaticity.py>`

.. oe:source:: Aromaticity.java
   :language: java
   :refnum:   1
   :caption:  Aromaticity perception with various models
   :frag:     SNIPPET

.. oe:source:: Aromaticity.cs
   :language: csharp
   :refnum:   1
   :caption:  Aromaticity perception with various models
   :frag:     SNIPPET

Since these models define aromaticity rules differently, the generated :term:`canonical SMILES`
depend on the applied aromaticity models.
The output of :oe:src:`Listing 1<SNIPPET-Aromaticity>` is the following:

.. code-block:: bash

   OEAroModel::OpenEye  : c1c[nH]c(cc1=O)c2cocc2c3cncnc3
   OEAroModel::Daylight : c1c[nH]c(cc1=O)c2cocc2c3cncnc3
   OEAroModel::Tripos   : c1c(cncn1)C2=COC=C2C3=CC(=O)C=CN3
   OEAroModel::MMFF     : c1c(cncn1)c2cocc2C3=CC(=O)C=CN3
   OEAroModel::MDL      : c1c(cncn1)C2=COC=C2C3=CC(=O)C=CN3

.. figure:: images/OEAssignAromaticFlags_Difference.*
   :scale:  100
   :align:  center

   *Example of aromaticity perception with different models*

.. _section_aromaticity_clearing:

Clearing Aromaticity
================================================================================

.. index:: Kekule SMILES

The aromatic property of all atoms and bonds in a molecule, can conveniently be
cleared (*i.e.* set to value false) by calling the
:oe:func:`OEClearAromaticFlags<OEChem::OEClearAromaticFlags>` function.
This is useful when  writing the |Kekule| form of a SMILES string, which can be done
by calling :oe:func:`OEClearAromaticFlags<OEChem::OEClearAromaticFlags>` before
calling :oe:func:`OEKekulize<OEChem::OEKekulize>` and
:oe:func:`OECreateSmiString<OEChem::OECreateSmiString>` functions.

.. oe:source:: ClearAromaticity.cpp
   :language: c++
   :refnum:   2
   :caption:  Clearing aromaticity
   :frag:     SNIPPET

.. oe:source:: ClearAromaticity.py
   :language: python
   :refnum:   2
   :caption:  Clearing aromaticity
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-ClearAromaticity.py>`

.. oe:source:: ClearAromaticity.java
   :language: java
   :refnum:   2
   :caption:  Clearing aromaticity
   :frag:     SNIPPET

.. oe:source:: ClearAromaticity.cs
   :language: csharp
   :refnum:   2
   :caption:  Clearing aromaticity
   :frag:     SNIPPET

The output of :oe:src:`Listing 2<SNIPPET-ClearAromaticity>` is the following:

.. code-block:: bash

   Canonical smiles : c1cnccn1
   Kekule smiles    : C1=CN=CC=N1

.. _section_aromaticity_readwrite:

Input/Output Aromaticity
================================================================================

Since :oe:func:`OEParseSmiles<OEChem::OEParseSmiles>` preserves the aromaticity
present (or absent) in the input SMILES string,
the :oe:func:`OEChem::OEClearAromaticFlags` or
the :oe:func:`OEChem::OEAssignAromaticFlags` have to be explicitly
called to remove or perceive aromaticity in a molecule, respectively.
(See examples in :oe:src:`Listing 1<SNIPPET-Aromaticity>` and :oe:src:`Listing 2<SNIPPET-ClearAromaticity>`)

However, when a molecule is imported from a file with a high-level
:oe:func:`OEReadMolecule<OEChem::OEReadMolecule>` function,
atom and bond aromaticity is automatically perceived using the default
:oe:const:`OEAroModelOpenEye<OEChem::OEAroModel::OpenEye>` model.

As mentioned before (in section :ref:`section_molreadwrite_proppreserv`), the
high-level :oe:func:`OEWriteMolecule`<OEChem::OEWriteMolecule>` writer function
may automatically update atom and bond properties (including aromaticity)
in order to standardize the exported molecules.
The following table shows the aromaticity models associated with various file
formats.

.. list-table::
   :widths: 30 30
   :header-rows: 1

   * - File Format
     - Default Output Aromaticity Models

   * - :oe:const:`OEChem::OEFormat::CAN`
     - :oe:const:`OEChem::OEAroModel::OpenEye`

   * - :oe:const:`OEChem::OEFormat::CDX`
     - :oe:const:`OEChem::OEAroModel::OpenEye`

   * - :oe:const:`OEChem::OEFormat::CSV`
     - :oe:const:`OEChem::OEAroModel::OpenEye`

   * - :oe:const:`OEChem::OEFormat::FASTA`
     -  [1]

   * - :oe:const:`OEChem::OEFormat::ISM`
     - :oe:const:`OEChem::OEAroModel::OpenEye`

   * - :oe:const:`OEChem::OEFormat::MDL`
     - :oe:func:`OEChem::OEClearAromaticFlags`

   * - :oe:const:`OEChem::OEFormat::MF`
     - [1]

   * - :oe:const:`OEChem::OEFormat::MMOD`
     - [1]

   * - :oe:const:`OEChem::OEFormat::MOL2`
     - :oe:const:`OEChem::OEAroModel`

   * - :oe:const:`OEChem::OEFormat::MOL2H`
     - :oe:const:`OEChem::OEAroModel::Tripos`

   * - :oe:const:`OEChem::OEFormat::MOPAC`
     - [1]

   * - :oe:const:`OEChem::OEFormat::OEB`
     - [1]

   * - :oe:const:`OEChem::OEFormat::PDB`
     - [1]

   * - :oe:const:`OEChem::OEFormat::SDF`
     - :oe:func:`OEChem::OEClearAromaticFlags`

   * - :oe:const:`OEChem::OEFormat::SLN`
     - :oe:const:`OEChem::OEAroModel::Tripos`

   * - :oe:const:`OEChem::OEFormat::SMI`
     - :oe:const:`OEChem::OEAroModel::OpenEye`

   * - :oe:const:`OEChem::OEFormat::XYZ`
     - [1]

   * - :oe:const:`OEChem::OEFormat::INCHI`
     - [1]

   * - :oe:const:`OEChem::OEFormat::INCHIKEY`
     - [1]

**Table footnote:**

**[1]** *The aromaticity model is not changed by the associated molecule writer.*

The following snippet shows how to overwrite the default aromaticity model
of a specific file format.

.. oe:source:: ChangeAromaticityFlavor.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-AROM-CHANGEFLAVOR

.. oe:source:: ChangeAromaticityFlavor.py
   :language: python
   :noindent:
   :frag:     SNIPPET-AROM-CHANGEFLAVOR

.. oe:source:: ChangeAromaticityFlavor.java
   :language: java
   :noindent:
   :frag:     SNIPPET-AROM-CHANGEFLAVOR

.. oe:source:: ChangeAromaticityFlavor.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-AROM-CHANGEFLAVOR

This will produce the following output:

.. code-block:: bash

   c1c[nH]cc1CO
   C1=CNC=C1CO

.. seealso::

   * [Lloyd-1996]_


.. _chapter_atombondindices:

********************************************************************************
Atom, Bond, and Conformer Indices
********************************************************************************

The following methods return the unique index assigned to its
associated object upon creation.

 - :oe:meth:`OEChem::OEAtomBase::GetIdx`
 - :oe:meth:`OEChem::OEBondBase::GetIdx`
 - :oe:meth:`OEChem::OEConfBase::GetIdx`

.. note::

   There is a parallel method `SetIdx` as well.  This is
   an advanced API that should never be used.

.. warning::

   Atoms, bonds and conformers are stored inside the molecule. If the 
   molecule is deallocated, the cached atoms, bonds, and conformers can 
   not be accessed any longer.

.. _section_atombondindices_uniqueidentifiers:

Unique Identifiers
================================================================================

This index can be used to distinguish one object from another, as it
is unique amongst all objects of the same type of the same molecule.
Indices are also stable, meaning a given object will have the same
index throughout its lifetime, independent of any other molecule
manipulations, *e.g.*, reordering the molecule
(:oe:meth:`OEChem::OEMolBase::OrderAtoms`), or the creation or deletion
of other objects (:oe:meth:`OEChem::OEMolBase::NewAtom` or
:oe:meth:`OEChem::OEMolBase::DeleteAtom`). The exception is the
following methods.

 - :oe:meth:`OEChem::OEMolBase::Sweep`
 - :oe:meth:`OEChem::OEMolBase::Compress`
 - :oe:meth:`OEChem::OEMolBase::UnCompress`
 - :oe:meth:`OEChem::OEMCMolBase::SweepConfs`

These methods were designed with the intent of changing something
about the underlying structure of the molecule, and thus are allowed
to invalidate indices if they deem it necessary.

Indices can be assumed to be dense small integers greater than or
equal to zero and less than the values returned by the following
methods.

 - :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx` for atoms
 - :oe:meth:`OEChem::OEMolBase::GetMaxBondIdx` for bonds
 - :oe:meth:`OEChem::OEMCMolBase::GetMaxConfIdx` for conformers

The index created on a new atom, bond, or conformer using
:oe:meth:`OEChem::OEMolBase::NewAtom`,
:oe:meth:`OEChem::OEMolBase::NewBond`, or
:oe:meth:`OEChem::OEMCMolBase::NewConf` respectively is guaranteed to
be greater than or equal to the index returned by the above methods.

.. _section_atombondindices_paralleldatastructures:

Parallel Data Structures
================================================================================

Indices are ideal for indexing into densely packed arrays of
information about the molecule. Many **OEChem TK** functions use them to
this end, *e.g.*, :oe:func:`OEChem::OEAddMols`,
:oe:func:`OEChem::OESubsetMol`, or
:oe:func:`OEChem::OEDetermineComponents`. The coordinates of a molecule
are retrieved as an array of floating point values indexed by the atom
indices. The following example demonstrates how to use the atom
indices for a rudimentary XYZ file format writer.

.. oe:source:: XYZWriter.cpp
   :language: c++
   :caption:  Rudimentary XYZ writer
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: XYZWriter.py
   :language: python
   :caption:  Rudimentary XYZ writer
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: XYZWriter.java
   :language: java
   :caption:  Rudimentary XYZ writer
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: XYZWriter.cs
   :language: csharp
   :caption:  Rudimentary XYZ writer
   :refnum:   1
   :frag:     SNIPPET

Computers are very efficient at doing this sort of sequential
lookup. Whenever an efficient temporary data structure is needed to
track information about a molecule indices should be used.

.. seealso: COMMENTED OUT

   The example :ref:`section_example_oechem_scaffoldextraction`
   demonstrates the use of atom indices to determine which atoms were
   already visited in a depth first search.

.. _section_atombondindices_dontdothis:

Indices for Molecule Lookup Considered Harmful
================================================================================

Note that atom, bond, and conformer indices are not guaranteed to be
sequential, or even created sequentially, and hence atom indices can
not and should not be used to retrieve all of the atoms of a molecule.
Even typing the following idiom may invalidate any chance of support
and eliminate any glimmer of respect from *OpenEye, Cadence Molecular Sciences*
or the computational chemistry/cheminformatics community.

.. oe:language:: c++

   .. warning::

      .. code-block:: c++

         // Never never, ever do this!!!
         OEAtomBase *aptr;
         unsigned int i;

         for (i=0; i<mol.NumAtoms(); ++i)
         {
            aptr = mol.GetAtom(OEHasAtomIdx(i));
            // Pretend that aptr is valid
         }

.. oe:language:: python

   .. warning::

      .. code-block:: python

         # Never ever, ever do this!!!
         for i in xrange(mol.NumAtoms()):
            atom = mol.GetAtom(OEHasAtomIdx(i))
            # pretend atom is valid

.. oe:language:: java

   .. warning::

      .. code-block:: java

         // Never ever, ever do this!!!
         for (int i=0;i<=mol.NumAtoms();++i) {
            OEAtomBase atom = mol.GetAtom(new OEHasAtomIdx(i));
            // pretend atom is valid
         }

.. oe:language:: csharp

   .. warning::

      .. code-block:: csharp

         // Never ever, ever do this!!!
         for (uint i=0; i<=mol.NumAtoms(); ++i)
         {
            OEAtomBase atom = mol.GetAtom(new OEHasAtomIdx(i));
            // pretend atom is valid
         }

There are far more efficient methods of crashing computer software
that should be used instead.

The common misconception is that **OEChem TK** indices should be stored in
order to reference back to an atom in the molecule. This leads to the
idiom used in :oe:src:`Listing 2<SNIPPET-AtomSubsetEvil>` which is technically
legal **OEChem TK**, however, is just as insidious as the previous code
snippet. The code is supposed to mimic a common technique to cache
particular atoms based on some expensive to calculate property. The
property in this instance is whether the atom is alpha beta
unsaturated.

.. warning::

   .. oe:source:: AtomSubsetEvil.cpp
      :language: c++
      :caption:  Evil atom cache
      :refnum:   2
      :frag:     SNIPPET

   .. oe:source:: AtomSubsetEvil.py
      :language: python
      :caption:  Evil atom cache
      :refnum:   2
      :frag:     SNIPPET

   .. oe:source:: AtomSubsetEvil.java
      :language: java
      :caption:  Evil atom cache
      :refnum:   2
      :frag:     SNIPPET

   .. oe:source:: AtomSubsetEvil.cs
      :language: csharp
      :caption:  Evil atom cache
      :refnum:   2
      :frag:     SNIPPET

The :oe:meth:`OEChem::OEMolBase::GetAtom` method performs a linear,
:math:`O(mol.NumAtoms())`, search over the molecule looking for the
first atom that matches the predicate. This leads to a multiplicative
effect when looping over multiple atoms, calling
:oe:meth:`GetAtom<OEChem::OEMolBase::GetAtom>` for each atom. The
resulting algorithm is quadratic :math:`O(mol.NumAtoms()^2)`, possibly
destroying any benefits of caching the user's expensive per atom
calculation.

.. oe:language:: c++

   The proper way to store references to atoms for later use is to
   store pointers to the :ref:`OEAtomBase <OEChem_OEAtomBase>` itself. It is
   guaranteed that the atoms will not be moved to another location in
   memory for the lifetime of the molecule.

.. oe:language:: python java csharp

   The proper way to store references to atoms for later use is to
   store the :ref:`OEAtomBase <OEChem_OEAtomBase>` itself. It is guaranteed that
   these atoms will be valid for the lifetime of the molecule.

This is regardless of molecule manipulations, *e.g.*, reordering the
molecule (:oe:meth:`OEChem::OEMolBase::OrderAtoms`), or the creation or
deletion of other atoms (:oe:meth:`OEChem::OEMolBase::NewAtom` or
:oe:meth:`OEChem::OEMolBase::DeleteAtom`). The ``Sweep`` and
``Compress`` methods are again exceptions to this rule.

:oe:src:`Listing 3<SNIPPET-AtomSubsetGood>` demonstrates the proper way to
create a cache of atoms. It is important to remember that the
:oe:cls:`OEAtomBases<OEChem::OEAtomBase>` in the container are only
valid while the molecule exists. Using the atoms after the molecule is
destroyed is undefined behavior (usually a segmentation fault).

.. oe:source:: AtomSubsetGood.cpp
   :language: c++
   :caption:  Atom caching
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: AtomSubsetGood.py
   :language: python
   :caption:  Atom caching
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: AtomSubsetGood.java
   :language: java
   :caption:  Atom caching
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: AtomSubsetGood.cs
   :language: csharp
   :caption:  Atom caching
   :refnum:   3
   :frag:     SNIPPET


.. _chapter_atombondtraversal:

********************************************************************************
Atom and Bond Traversal
********************************************************************************

**OEChem TK*** molecules contain atoms and bonds which have APIs described
by the :oe:cls:`OEAtomBase<OEChem::OEAtomBase>` and
:oe:cls:`OEBondBase<OEChem::OEBondBase>` abstract base-classes
respectively.  Atoms and bonds in **OEChem TK** can **only** be created and
destroyed in the context of an **OEChem TK** molecule.  While they can be
accessed as pointers through various member functions of molecules,
their memory is owned by the molecules and they are deallocated during
the molecules' destruction.  Attempting to use references to atoms or
bonds of a molecule after the molecule has gone out of scope results
in undefined behavior.

.. _section_atombondtraversal_iter:

Iterators
================================================================================

The standard way of processing each item or member of a set or
collection in **OEChem TK** is by the use of an iterator. The use of
iterators is a common abstraction (or design pattern) in object
oriented programming because it hides the way the collection/container
is implemented from the user. Hence a set of atoms could be
implemented internally as an array, a linked list, a hash table, or any
similar data structure, but its behavior to the programmer is
independent of the actual implementation. An iterator can be thought
of as a current position indicator.

.. oe:language:: c++

   **OEChem TK** iterators make use of C++'s template mechanism. The use of
   templates allows the functionality of an iterator to be specified
   (implemented) independently of the type of the collection being
   iterated over. An iterator over a type ``T``, has the type
   ``OEIter<T>``. Hence, an iterator over the atoms of a molecule
   (represented by :ref:`OEAtomBase <OEChem_OEAtomBase>`) has the type
   ``OEIter<OEAtomBase>`` and an iterator over the bonds of a molecule
   has type ``OEIter<OEBondBase>``.

   The three most common operations of an :ref:`OEIter <OESystem_OEIter>` are
   assignment, testing, and increment.  These three iterator methods
   allow **OEChem TK** iterators to resemble conventional ``for`` loops in high
   level programming languages.  Assignment specifies which
   collection/container the iterator is intended to loop over, testing
   determines whether the iterator has seen all of the items, and
   increment advances the iterator to the next position.

   One possible source of confusion is that most functions and methods
   that return an iterator actually return a result of type
   :oe:cls:`OEIterBase\<T><OESystem::OEIterBase>` rather than
   :oe:cls:`OEIter\<T><OESystem::OEIter>`. The template class
   :oe:cls:`OEIterBase\<T><OESystem::OEIterBase>` is an internal
   abstraction used by **OEChem TK**, and should be treated as an opaque type
   by the user.  Suffice it to say that values of type
   :oe:cls:`OEIterBase\<T><OESystem::OEIterBase>` can be assigned to
   variables of type :oe:cls:`OEIter\<T><OESystem::OEIter>` as created by
   the user.

   Another technical point is that **OEChem TK** iterators only support the
   prefix ``++`` operator, and not the suffix ``++`` operator.  This
   means that in order to advance the iterator, users must write ``++i``
   and not ``i++``.  This is actually a performance issue, since in C and
   C++ the operator ``i++`` must make a copy of its argument.  This is to
   support the syntax ``j = i++`` where ``j`` is assigned the value of
   ``i`` before the increment.  This copying may potentially be expensive
   and must be performed even if the value is not assigned.  For
   primitive types such as integers, most C/C++ compilers can determine
   the value is not used and optimize ``i++`` to ``++i``.  However, for
   C++ classes, most compilers are unable to perform this optimization,
   hence ``++i`` is the preferred idiom.  Even if **OEChem TK** changed the
   semantics of ``i++`` to perform the same thing as ``++i`` and return
   the value after the increment, the ``i++`` form is marginally less
   efficient (requiring an "invisible" integer argument to be passed to
   the operator).  Hence OpenEye's policy is to only implement the
   "correct" behavior and hope that users of **OEChem TK** will adopt ``++i``
   even for integer loops as good coding style.

   Finally, the template :ref:`OEIter <OESystem_OEIter>` is defined in the
   ``OESystem`` namespace rather than the ``OEChem`` namespace.  This is
   because iterators (like random number generators) are not chemistry
   specific, and the use of two namespaces makes this explicit.  It does
   however mean that ``using namespace OESystem;`` is required, as shown
   in our examples.

.. oe:language:: python
   
   **OEChem TK** makes extensive effort to support the Python iteration syntax. 
    
   .. code-block:: python

      for x in y:
          # do something with x

   The normal Python user does not have to care that an iterator
   is providing this convenient, yet powerful, abstraction. 

.. oe:language:: java

   **OEChem TK** makes extensive effort to support the Java iteration syntax. 
    
   .. code-block:: java

      for (MyType obj : list)
        obj.DoSomething();

.. oe:language:: csharp

   **OEChem TK** makes extensive effort to support the Java iteration syntax. 
    
   .. code-block:: csharp

      foreach (MyType obj in list)
        obj.DoSomething();
     

   So the normal C# user does not have to care that an iterator is
   providing this convenient, yet powerful, abstraction.
   
.. _section_atombondtraversal_molatombond:

Atom and Bond Iteration 
================================================================================

:oe:src:`Listing 1<SNIPPET-LoopingOverMolAtomsBonds>` shows the minimal use of
**OEChem TK**'s iterators.  These examples use the
:oe:cls:`OEMolBase<OEChem::OEMolBase>` methods
:oe:meth:`GetAtoms<OEChem::OEMolBase::GetAtoms>` and
:oe:meth:`GetBonds<OEChem::OEMolBase::GetBonds>`, which return
iterators over the atoms and bonds of a molecule, respectively.

.. oe:source:: LoopingOverMolAtomsBonds.cpp
   :language: c++
   :caption:  Using iterators to loop over atoms and bonds
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: LoopingOverMolAtomsBonds.py
   :language: python
   :caption:  Using iterators to loop over atoms and bonds
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: LoopingOverMolAtomsBonds.java
   :language: java
   :caption:  Using iterators to loop over atoms and bonds
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: LoopingOverMolAtomsBonds.cs
   :language: csharp
   :caption:  Using iterators to loop over atoms and bonds
   :refnum:   1
   :frag:     SNIPPET

.. oe:language:: c++

   One point to notice is that once again C++'s destructors mean that it is not
   necessary to explicitly deallocate or destroy the iterator after use.  
   Once the variable goes out of scope, it is cleaned up automatically.

.. note::

   :oe:src:`Listing 1<SNIPPET-LoopingOverMolAtomsBonds>` introduced the
   :oe:meth:`GetAtomicNum<OEChem::OEAtomBase::GetAtomicNum>` and
   :oe:meth:`GetOrder<OEChem::OEBondBase::GetOrder>` methods.  These and
   other :ref:`OEAtomBase <OEChem_OEAtomBase>` and :ref:`OEBondBase <OEChem_OEBondBase>`
   methods will be covered in more detail in chapters
   :ref:`chapter_atomproperties` and :ref:`chapter_bondproperties`,
   respectively.

.. _section_atombondtraversal_atombond:

Bonds of an Atom Iteration
================================================================================

The exact same idiom is used for iterating over the bonds attached to
an atom.  The :oe:meth:`GetBonds<OEChem::OEAtomBase::GetBonds>` method
returns an iterator over the bonds connected to that
atom. :oe:src:`Listing 2<SNIPPET-LoopingOverBonds>` shows how to use this
iterator to determine the explicit degree of an atom, *i.e.* the
number of bonds to it, not including bonds to implicit hydrogen atoms.

.. oe:source:: LoopingOverBonds.cpp
   :language: c++
   :caption:  Looping over the bonds of an atom
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: LoopingOverBonds.py
   :language: python
   :caption:  Looping over the bonds of an atom
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: LoopingOverBonds.java
   :language: java
   :caption:  Looping over the bonds of an atom
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: LoopingOverBonds.cs
   :language: csharp
   :caption:  Looping over the bonds of an atom
   :refnum:   2
   :frag:     SNIPPET

.. _section_atombondtraversal_nbr:

Atom Neighbor Iteration
================================================================================

Often it is not the bonds around the atoms that you wish to loop over,
but the neighboring atoms.  One way to do this would be to use the
:oe:meth:`GetBonds<OEChem::OEAtomBase::GetBonds>` method described in
the previous section and use the
:oe:meth:`GetNbr<OEChem::OEBondBase::GetNbr>` method on each
:oe:cls:`OEBondBase<OEChem::OEBondBase>` to get the atom across the
bond from the input atom.

.. oe:source:: LoopingOverNeighbors1.cpp
   :language: c++
   :caption:  Finding the neighbors of an atom (version 1)
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: LoopingOverNeighbors1.py
   :language: python
   :caption:  Finding the neighbors of an atom (version 1)
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: LoopingOverNeighbors1.java
   :language: java
   :caption:  Finding the neighbors of an atom (version 1)
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: LoopingOverNeighbors1.cs
   :language: csharp
   :caption:  Finding the neighbors of an atom (version 1)
   :refnum:   3
   :frag:     SNIPPET

However this can be done even more conveniently using the 
:oe:meth:`GetAtoms<OEChem::OEAtomBase::GetAtoms>` method of an 
:oe:cls:`OEAtomBase<OEChem::OEAtomBase>` directly, which allows 
loops over the neighbor atoms.

.. oe:source:: LoopingOverNeighbors2.cpp
   :language: c++
   :caption:  Finding the neighbors of an atom (version 2)
   :refnum:   4
   :frag:     SNIPPET

.. oe:source:: LoopingOverNeighbors2.py
   :language: python
   :caption:  Finding the neighbors of an atom (version 2)
   :refnum:   4
   :frag:     SNIPPET

.. oe:source:: LoopingOverNeighbors2.java
   :language: java
   :caption:  Finding the neighbors of an atom (version 2)
   :refnum:   4
   :frag:     SNIPPET

.. oe:source:: LoopingOverNeighbors2.cs
   :language: csharp
   :caption:  Finding the neighbors of an atom (version 2)
   :refnum:   4
   :frag:     SNIPPET

.. _section_atombondtraversal_subset:

Atom or Bond Subset Iteration
================================================================================

.. index:: predicate

It can sometimes be useful to loop over a subset of the atoms or bonds
of a molecule.  Traditionally, this is done with *if* statements
inside a loop, but it can sometimes be cleaner and more convenient to
subset the members being looped over inside the iterator itself.  To
do this, many of **OEChem TK**'s iterator generation functions (such as
:oe:meth:`GetAtoms<OEChem::OEMolBase::GetAtoms>`) can take an argument
which determines which subset of the object to loop over (these
functions are called *functors* are detailed in the chapter
:ref:`chapter_predicates`).  The details of these functions are not
important here.  Instead, a programmer can simply use the predefined
functors to control their loops.
:oe:src:`Listing 5<SNIPPET-LoopingOverCarbon>` shows the use of the predicate
:oe:cls:`OEHasAtomicNum<OEChem::OEHasAtomicNum>` to loop over only
carbon atoms in a molecule.

.. oe:source:: LoopingOverCarbon.cpp
   :language: c++
   :caption:  Looping over carbon atoms only
   :refnum:   5
   :frag:     SNIPPET

.. oe:source:: LoopingOverCarbon.py
   :language: python
   :caption:  Looping over carbon atoms only
   :refnum:   5
   :frag:     SNIPPET

.. oe:source:: LoopingOverCarbon.java
   :language: java
   :caption:  Looping over carbon atoms only
   :refnum:   5
   :frag:     SNIPPET

.. oe:source:: LoopingOverCarbon.cs
   :language: csharp
   :caption:  Looping over carbon atoms only
   :refnum:   5
   :frag:     SNIPPET

.. seealso::

   For a complete list of built-in predicates, see 
   :ref:`section_predicates_builtin` section.

Iterator Methods
================================================================================

.. oe:language:: c++

   The preceding examples show how to use an **OEChem TK** iterator to loop
   over objects. **OEChem TK** iterators provide four operators to allow
   the user to access the object at the current iterator position.

   The implicit cast :oe:meth:`operator A *<OESystem::OEIter::operator A *>`
   or :oe:meth:`operator-><OESystem::OEIter::operator->>` may be
   used to get a pointer to the current object. Also,
   :oe:meth:`operator*<OESystem::OEIter::operator*>` may be used to get
   a reference to the current object.

   For example, if variable ``iter`` has type ``OEIter<T>``, then
   ``(T*)iter`` is a pointer to the current object of type ``T *``,
   and ``*iter`` is a reference to the current object of type ``T&``.
   These operators mean that in most cases an **OEChem TK** iterator
   :oe:cls:`OEIter\<T><OESystem::OEIter>` behaves identically to a ``T *``.

   The following two examples demonstrate how iterators and pointers
   behave similarly. They are functionally equivalent. The only
   difference is that the second example assigns the iterator to an
   :oe:cls:`OEAtomBase<OEChem::OEAtomBase>` pointer before calling the
   :oe:meth:`GetAtomicNum<OEChem::OEAtomBase::GetAtomicNum>` method.
   
   .. list-table::
   
      * - .. oe:source:: ListingAtomicNumbers.cpp
             :language: c++
             :caption:  Dereferencing iterators   
             :frag:     SNIPPET

        - .. oe:source:: ListingAtomicNumbersPtr.cpp
             :language: c++
             :caption:  Assigning iterators to pointers 
             :frag:     SNIPPET

   The implicit cast of :oe:cls:`OEIter\<T><OESystem::OEIter>` to ``T*``
   is most useful when passing the object to a function which takes
   ``T`` by pointer.

   .. oe:source:: PassingIters.cpp
      :language: c++
      :caption:  Passing iterators to functions
      :frag:     SNIPPET

Iterators  offer a much wider range of iteration possibilities. For
example, the iterator can be reused by using the
:oe:meth:`ToFirst<OESystem::OEIter::ToFirst>` method. Or, the order of
iteration can be rearranged with the
:oe:meth:`Sort<OESystem::OEIter::Sort>` method.

.. oe:language:: c++ 

   The following table describes the full set of features offered by
   iterators.

   .. list-table::
      :header-rows: 1

      * - Description
        - C++ Code
      * - Increment
        - :oe:meth:`++i<OESystem::OEIter::operator++>`
      * - Increment by n
        - :oe:meth:`i += n<OESystem::OEIter::operator+=>`
      * - Decrement
        - :oe:meth:`--i<OESystem::OEIter::operator-->`
      * - Decrement by n
        - :oe:meth:`i -= n<OESystem::OEIter::operator-=>`
      * - Go to first
        - :oe:meth:`i.ToFirst()<OESystem::OEIter::ToFirst>`
      * - Go to last
        - :oe:meth:`i.ToLast()<OESystem::OEIter::ToLast>`
      * - Access current object
        - :oe:meth:`i->MethodName()<OESystem::OEIter::operator->>`
      * - Validity
        - :oe:meth:`if ((bool)i)<OESystem::OEIter::operator bool>`
      * - Sorting
        - :oe:meth:`i.Sort(predicate)<OESystem::OEIter::Sort>`

.. oe:language:: python java csharp

   The following table describes how to use the same rich set of
   iterator operations that C++ offers.

.. oe:language:: python

   ================= ================= =================
   Description       C++               Python           
   ================= ================= =================
   Increment         ``++i``           ``i.Next()``     
   Increment by n    ``i += n``        ``i.Next(n)``    
   Decrement         ``--i``           ``i.Prev()``     
   Decrement by n    ``i -= n``        ``i.Prev(n)``    
   Go to first       ``i.ToFirst()``   ``i.ToFirst()``  
   Go to last        ``i.ToLast()``    ``i.ToLast()``   
   Current Access    ``operator->``    ``i.Target()``   
   Validity          ``operator bool`` ``i.IsValid()``  
   ================= ================= =================

.. oe:language:: java

   ================== ================== ==================
   Description        C+ +               Java              
   ================== ================== ==================
   Increment          ``++i``            ``i.Increment()`` 
   Increment by n     ``i += n``         ``i.Increment(n)``
   Decrement          ``--i``            ``i.Decrement()`` 
   Decrement by n     ``i -= n``         ``i.Decrement(n)``
   Go to first        ``i.ToFirst()``    ``i.ToFirst()``   
   Go to last         ``i.ToLast()``     ``i.ToLast()``    
   Current Access     ``operator->``     ``i.Target()``    
   Validity           ``operator bool``  ``i.IsValid()``   
   ================== ================== ==================

.. oe:language:: csharp

   ================== ================== ==================
   Description        C+ +               C#
   ================== ================== ==================
   Increment          ``++i``            ``i.Increment()`` 
   Increment by n     ``i += n``         ``i.Increment(n)``
   Decrement          ``--i``            ``i.Decrement()`` 
   Decrement by n     ``i -= n``         ``i.Decrement(n)``
   Go to first        ``i.ToFirst()``    ``i.ToFirst()``   
   Go to last         ``i.ToLast()``     ``i.ToLast()``    
   Current Access     ``operator->``     ``i.Target()``    
   Validity           ``operator bool``  ``i.IsValid()``   
   ================== ================== ==================

:oe:src:`Listing 6<SNIPPET-ReverseIteration>` shows how to use an
:ref:`OEAtomBase <OEChem_OEAtomBase>` iterator to loop over the atoms in a
molecule in reverse order and print their atomic numbers.

.. note::

   The order of the atoms returned by
   :oe:meth:`OEChem::OEMolBase::GetAtoms` can be controlled by
   :oe:meth:`OEChem::OEMolBase::OrderAtoms`.

.. oe:source:: ReverseIteration.cpp
   :language: c++
   :caption:  Looping over atoms in reverse order
   :refnum:   6
   :frag:     SNIPPET

.. oe:source:: ReverseIteration.py
   :language: python
   :caption:  Looping over atoms in reverse order
   :refnum:   6
   :frag:     SNIPPET

.. oe:source:: ReverseIteration.java
   :language: java
   :caption:  Looping over atoms in reverse order
   :refnum:   6
   :frag:     SNIPPET

.. oe:source:: ReverseIteration.cs
   :language: csharp
   :caption:  Looping over atoms in reverse order
   :refnum:   6
   :frag:     SNIPPET


.. _chapter_atomproperties:

********************************************************************************
Atom Properties
********************************************************************************

.. index:: OEAtomBase, atom properties

The :oe:cls:`OEAtomBase<OEChem::OEAtomBase>` class is the workhorse of the
**OEChem TK** library, representing the atoms of a molecule.
This section details some of its important and often used properties and methods.

.. _section_atomproperties_readwrite:

Read/Write Atom Properties
================================================================================

.. index::
   single: atomic number
   single: formal charge
   single: implicit hydrogens
   single: isotopic mass
   single: partial charge
   single: atomic hybridization
   single: integer atom type
   single: atom name
   single: atom type name
   single: atom radius
   single: reaction role
   single: reaction map index
   single: atom ring membership
   single: atom aromaticity
   single: atom chirality
   single: atom stereo

.. list-table::
   :widths: 30 15 20 20 30
   :header-rows: 1

   * - Property Name
     - Type
     - Get Method
     - Set Method
     - See Also
   * - Atomic Number
     - unsigned int
     - :oe:meth:`GetAtomicNum<OEChem::OEAtomBase::GetAtomicNum>`
     - :oe:meth:`SetAtomicNum<OEChem::OEAtomBase::SetAtomicNum>`
     -
   * - Formal Charge
     - int
     - :oe:meth:`GetFormalCharge<OEChem::OEAtomBase::GetFormalCharge>`
     - :oe:meth:`SetFormalCharge<OEChem::OEAtomBase::SetFormalCharge>`
     - :ref:`Formal Charges<chapter_charges>`
   * - Implicit Hyd. Count
     - unsigned int
     - :oe:meth:`GetImplicitHCount<OEChem::OEAtomBase::GetImplicitHCount>`
     - :oe:meth:`SetImplicitHCount<OEChem::OEAtomBase::SetImplicitHCount>`
     - .. :ref:`chapter_hydrogens` STILL EMPTY CHAPTER
   * - Isotopic Mass
     - unsigned int
     - :oe:meth:`GetIsotope<OEChem::OEAtomBase::GetIsotope>`
     - :oe:meth:`SetIsotope<OEChem::OEAtomBase::SetIsotope>`
     -
   * - Partial Charge
     - double
     - :oe:meth:`GetPartialCharge<OEChem::OEAtomBase::GetPartialCharge>`
     - :oe:meth:`SetPartialCharge<OEChem::OEAtomBase::SetPartialCharge>`
     - :ref:`Partial Charges<chapter_charges>`
   * - Atomic Hybridization
     - unsigned int
     - :oe:meth:`GetHyb<OEChem::OEAtomBase::GetHyb>`
     - :oe:meth:`SetHyb<OEChem::OEAtomBase::SetHyb>`
     -
   * - Integer Atom Type
     - int
     - :oe:meth:`GetIntType<OEChem::OEAtomBase::GetIntType>`
     - :oe:meth:`SetIntType<OEChem::OEAtomBase::SetIntType>`
     -
   * - Atom Name
     - string
     - :oe:meth:`GetName<OEChem::OEAtomBase::GetName>`
     - :oe:meth:`SetName<OEChem::OEAtomBase::SetName>`
     -
   * - Atom Type Name
     - string
     - :oe:meth:`GetType<OEChem::OEAtomBase::GetType>`
     - :oe:meth:`SetType<OEChem::OEAtomBase::SetType>`
     -
   * - Atom Radius
     - double
     - :oe:meth:`GetRadius<OEChem::OEAtomBase::GetRadius>`
     - :oe:meth:`SetRadius<OEChem::OEAtomBase::SetRadius>`
     -
   * - Reaction Role
     - unsigned int
     - :oe:meth:`GetRxnRole<OEChem::OEAtomBase::GetRxnRole>`
     - :oe:meth:`SetRxnRole<OEChem::OEAtomBase::SetRxnRole>`
     - :ref:`chapter_reactions`
   * - Reaction Map Index
     - unsigned int
     - :oe:meth:`GetMapIdx<OEChem::OEAtomBase::GetMapIdx>`
     - :oe:meth:`SetMapIdx<OEChem::OEAtomBase::SetMapIdx>`
     - :ref:`chapter_reactions`
   * - Ring Membership
     - bool
     - :oe:meth:`IsInRing<OEChem::OEAtomBase::IsInRing>`
     - :oe:meth:`SetIsInRing<OEChem::OEAtomBase::SetInRing>`
     - :ref:`chapter_ring`
   * - Aromaticity
     - bool
     - :oe:meth:`IsAromatic<OEChem::OEAtomBase::IsAromatic>`
     - :oe:meth:`SetAromatic<OEChem::OEAtomBase::SetAromatic>`
     - :ref:`Aromaticity<chapter_aromaticity>`
   * -  Atom Chirality
     -  bool
     - :oe:meth:`IsChiral<OEChem::OEAtomBase::IsChiral>`
     - :oe:meth:`SetChiral<OEChem::OEAtomBase::SetChiral>`
     - :ref:`Stereochemistry<chapter_stereochemistry>`
   * -  Atom Stereo
     -  unsigned int
     - :oe:meth:`GetStereo<OEChem::OEAtomBase::GetStereo>`
     - :oe:meth:`SetStereo<OEChem::OEAtomBase::SetStereo>`
     - :ref:`Stereochemistry<chapter_stereochemistry>`

.. _section_atomproperties_readonly:

Read Only  Atom Properties
================================================================================

.. index::
   single: atom degree
   single: explicit atom degree
   single: explicit hydrogen count
   single: explicit valence
   single: atom heavy degree
   single: atom heavy valence
   single: atom parent
   single: total hydrogen count
   single: atom valence
   single  atom index
   single: atom connection

.. list-table::
   :widths: 30 15 20 30
   :header-rows: 1

   * - Property Name
     - Type
     - Get Method
     - See Also
   * - Atom Degree
     - unsigned int
     - :oe:meth:`GetDegree<OEChem::OEAtomBase::GetDegree>`
     -
   * - Explicit Atom Degree
     - unsigned int
     - :oe:meth:`GetExplicitDegree<OEChem::OEAtomBase::GetExplicitDegree>`
     -
   * - Explicit Hydrogen Count
     - unsigned int
     - :oe:meth:`GetExplicitHCount<OEChem::OEAtomBase::GetExplicitHCount>`
     - .. :ref:`chapter_hydrogens` STILL EMPTY CHAPTER
   * - Explicit Valence
     - unsigned int
     - :oe:meth:`GetExplicitValence<OEChem::OEAtomBase::GetExplicitValence>`
     - :ref:`chapter_valence`
   * - Atom Heavy Degree
     - unsigned int
     - :oe:meth:`GetHvyDegree<OEChem::OEAtomBase::GetHvyDegree>`
     -
   * - Atom Heavy Valence
     - unsigned int
     - :oe:meth:`GetHvyValence<OEChem::OEAtomBase::GetHvyValence>`
     - :ref:`chapter_valence`
   * - Atom Parent
     - :oe:cls:`OEMolBase<OEChem::OEMolBase>`
     - :oe:meth:`GetParent<OEChem::OEAtomBase::GetParent>`
     -
   * - Total Hydrogen Count
     - unsigned int
     - :oe:meth:`GetTotalHCount<OEChem::OEAtomBase::GetTotalHCount>`
     - .. :ref:`chapter_hydrogens` STILL EMPTY CHAPTER
   * - Atom Valence
     - unsigned int
     - :oe:meth:`GetValence<OEChem::OEAtomBase::GetValence>`
     - :ref:`chapter_valence`
   * - Atom Index
     - unsigned int
     - :oe:meth:`GetIdx<OEChem::OEAtomBase::GetIdx>`
     - :ref:`chapter_atombondindices`
   * - Atom Has Stereo
     - bool
     - :oe:meth:`HasStereoSpecified<OEChem::OEAtomBase::HasStereoSpecified>`
     - :ref:`chapter_stereochemistry`
   * - Atom Connection
     - bool
     - :oe:meth:`IsConnected<OEChem::OEAtomBase::IsConnected>`
     -

.. _section_atomproperties_genericdata:

Attach Generic Data to Atoms
================================================================================

Generic data (see :ref:`chapter_genericdata`) can be attached to any object that
derives from the :ref:`OEBase <OESystem_OEBase>` class. The following program shows
an example where hydrogen bonding donor property is attached as a ``bool`` value
to the corresponding :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

.. oe:source:: GenericDataToAtom.py
   :language: python
   :refnum:   2
   :caption:  Example of attaching generic data to atoms
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-GenericDataToAtom.py>`

.. oe:source:: GenericDataToAtom.cpp
   :language: c++
   :refnum:   2
   :caption:  Example of attaching generic data to atoms
   :frag:     SNIPPET

.. oe:source:: GenericDataToAtom.java
   :language: java
   :refnum:   2
   :caption:  Example of attaching generic data to atoms
   :frag:     SNIPPET

.. oe:source:: GenericDataToAtom.cs
   :language: csharp
   :refnum:   2
   :caption:  Example of attaching generic data to atoms
   :frag:     SNIPPET

The :ref:`OEAtomBase <OEChem_OEAtomBase>` API provides the following
methods, publicly inherited from :ref:`OEBase <OESystem_OEBase>`, that
allow the manipulation of generic data.

.. list-table:: **Methods to manipulate generic data**
   :widths: 15 40
   :header-rows: 1

   * - Method
     - Description

   * - :oe:meth:`SetData<OESystem::OEBase::SetData>`
     - sets a generic data associating it with the given tag

   * - :oe:meth:`AddData<OESystem::OEBase::AddData>`
     -  adds a generic data associating it with the given tag

   * - :oe:meth:`HasData<OESystem::OEBase::HasData>`
     - determines whether a molecule has any generic data with a given tag

   * - :oe:meth:`GetData<OESystem::OEBase::GetData>`
     - returns the generic data associated with the given tag

   * - :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`
     - deletes all generic data  with the given tag

   * - :oe:meth:`Clear<OESystem::OEBase::Clear>`
     - clears all stored generic data

.. note::

   Generic data attached to a molecule or any of its atoms or bonds is automatically
   saved when the molecule is written into an :file:`.oeb` file.

.. seealso::

   * :ref:`section_attaching_other_objects` section
   * :ref:`section_moltaggeddata_SD` section
   * :ref:`section_moltaggeddata_PDB` section


.. _chapter_atomstereo:

********************************************************************************
Atom Stereo From Bond Stereo
********************************************************************************

Tertiary
================================================================================

The following images depict how various tertiary bond stereo
configurations are interpreted by the
:oe:func:`OEChem::OEMDLStereoFromBondStereo` function.

.. figure:: oechemtk/images/OEAtomStereo_Tertiary_Undefined.*
   :align:  center

   Example of **unspecified** tertiary bond stereo configuration

.. figure:: oechemtk/images/OEAtomStereo_Tertiary_Left.*
   :align:  center

   Examples of **left** tertiary bond stereo configuration

.. figure:: oechemtk/images/OEAtomStereo_Tertiary_Right.*
   :align:  center

   Examples of **right** tertiary bond stereo configuration

.. figure:: oechemtk/images/OEAtomStereo_Tertiary_Invalid.*
   :align:  center

   Examples of **invalid** tertiary bond stereo configuration

.. note ::

   A stereo atom center with invalid bond stereo configuration is
   treated as :oe:const:`OEChem::OEAtomStereo::Undefined`.

Quaternary
================================================================================

The following images depict how various quaternary bond stereo
configurations are interpreted by the
:oe:func:`OEChem::OEMDLStereoFromBondStereo` function.

.. figure:: oechemtk/images/OEAtomStereo_Quaternary_Undefined.*
   :align:  center

   Example of **unspecified** quaternary bond stereo configuration

.. ##################################################################

.. figure:: oechemtk/images/OEAtomStereo_Quaternary_Left.*
   :align:  center

   Examples of **left** quaternary bond stereo configuration

.. _figure_OEAtomStereo_Quaternary_CorrectedLeft:

.. figure:: oechemtk/images/OEAtomStereo_Quaternary_CorrectedLeft.*
   :align:  center

   Examples of **corrected left** quaternary bond stereo configurations

.. note ::

   The :oe:func:`OEChem::OEMDLStereoFromBondStereo` function throws
   a warning message when detects bond stereo configurations depicted in
   the :ref:`Figure  Examples of corrected left quaternary bond stereo
   configurations <figure_OEAtomStereo_Quaternary_CorrectedLeft>` and
   treated these atom centers as :oe:const:`OEChem::OEAtomStereo::Left`.

.. ##################################################################

.. figure:: oechemtk/images/OEAtomStereo_Quaternary_Right.*
   :align:  center

   Examples of **right** quaternary bond stereo configuration

.. _figure_OEAtomStereo_Quaternary_CorrectedRight:

.. figure:: oechemtk/images/OEAtomStereo_Quaternary_CorrectedRight.*
   :align:  center

   Examples of **corrected right** quaternary bond stereo configurations

.. note ::

   The :oe:func:`OEChem::OEMDLStereoFromBondStereo` function throws
   a warning message when detects bond stereo configurations depicted in
   the :ref:`Figure  Examples of corrected right quaternary bond stereo
   configurations <figure_OEAtomStereo_Quaternary_CorrectedRight>` and
   treated these atom centers as :oe:const:`OEChem::OEAtomStereo::Right`.

.. ##################################################################

.. figure:: oechemtk/images/OEAtomStereo_Quaternary_Invalid.*
   :align:  center

   Examples of **invalid** quaternary bond stereo configuration

.. note ::

   A stereo atom center with invalid bond stereo configuration is
   treated as :oe:const:`OEChem::OEAtomStereo::Undefined`.

.. seealso::

   * :term:`stereo atom`
   * :oe:meth:`OEChem::OEAtomBase::GetStereo` method
   * :oe:meth:`OEChem::OEAtomBase::SetStereo` method
   * :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` method


.. _chapter_biopolymers:

********************************************************************************
Biopolymers
********************************************************************************

.. _section_biopolymer_residues:

Biopolymer Residues
================================================================================

.. index:: OEResidue, Biopolymer Residue, Residue

Living organisms manufacture an assortment of biopolymers:
proteins are polymers of amino-acid residues,
DNA and RNA are polymers of nucleotide bases,
and polysaccharides such as cellulose and starch
are polymers of sugars.
In a description of these often very large molecules,
it is useful to include with each atom
information about the monomer it resides in, the chain
the monomer is in, the model the chain is in, etc.
**OEChem TK**'s :oe:cls:`OEResidue<OEChem::OEResidue>`
is a container for just such information, and more.

.. _residue_stored_properties:

.. list-table:: Properties of OEResidues
   :widths: 40 15 35 35
   :header-rows: 1
   :stub-columns: 1

   * - Property
     - Type
     - Get Method
     - Set Method
   * - Residue Name
     - char*
     - :oe:meth:`GetName<OEChem::OEResidue::GetName>`
     - :oe:meth:`SetName<OEChem::OEResidue::SetName>`
   * - Residue Number
     - int
     - :oe:meth:`GetResidueNumber<OEChem::OEResidue::GetResidueNumber>`
     - :oe:meth:`SetResidueNumber<OEChem::OEResidue::SetResidueNumber>`
   * - Insertion Code
     - char
     - :oe:meth:`GetInsertCode<OEChem::OEResidue::GetInsertCode>`
     - :oe:meth:`SetInsertCode<OEChem::OEResidue::SetInsertCode>`
   * - Chain ID
     - char
     - :oe:meth:`GetChainID<OEChem::OEResidue::GetChainID>`
     - :oe:meth:`SetChainID<OEChem::OEResidue::SetChainID>`
   * - NMR Model Number
     - int
     - :oe:meth:`GetModelNumber<OEChem::OEResidue::GetModelNumber>`
     - :oe:meth:`SetModelNumber<OEChem::OEResidue::SetModelNumber>`
   * - Fragment Number
     - int
     - :oe:meth:`GetFragmentNumber<OEChem::OEResidue::GetFragmentNumber>`
     - :oe:meth:`SetFragmentNumber<OEChem::OEResidue::SetFragmentNumber>`
   * - Secondary Structure
     - int
     - :oe:meth:`GetSecondaryStructure<OEChem::OEResidue::GetSecondaryStructure>`
     - :oe:meth:`SetSecondaryStructure<OEChem::OEResidue::SetSecondaryStructure>`
   * - Heterogen
     - bool
     - :oe:meth:`IsHetAtom<OEChem::OEResidue::IsHetAtom>`
     - :oe:meth:`SetHetAtom<OEChem::OEResidue::SetHetAtom>`
   * - Atom Serial Number
     - int
     - :oe:meth:`GetSerialNumber<OEChem::OEResidue::GetSerialNumber>`
     - :oe:meth:`SetSerialNumber<OEChem::OEResidue::SetSerialNumber>`
   * - Alternate Location Code
     - char
     - :oe:meth:`GetAlternateLocation<OEChem::OEResidue::GetAlternateLocation>`
     - :oe:meth:`SetAlternateLocation<OEChem::OEResidue::SetAlternateLocation>`
   * - Occupancy
     - float
     - :oe:meth:`GetOccupancy<OEChem::OEResidue::GetOccupancy>`
     - :oe:meth:`SetOccupancy<OEChem::OEResidue::SetOccupancy>`
   * - Temperature Factor
     - float
     - :oe:meth:`GetBFactor<OEChem::OEResidue::GetBFactor>`
     - :oe:meth:`SetBFactor<OEChem::OEResidue::SetBFactor>`

.. _figure_pdb_atom_recs:

.. figure:: /_images/pdb-atom-records.png
   :scale:  100
   :align:  left

   *PDB format atom records*

Note that :oe:cls:`OEResidue<OEChem::OEResidue>` is actually a part
of **OEChem TK**, it is included in this **OEBio TK**
chapter because it underlies much of **OEBio TK**'s functionality.
:ref:`Table: Properties of OEResidues<residue_stored_properties>` lists
each property along with the *Get* and *Set* methods for each.
:ref:`Figure: PDB format atom records<figure_pdb_atom_recs>`
shows how these properties are encoded for a structure in PDB format.

The `residue number`, `insertion code`, `chain ID`, `model number`
and `fragment number` properties describe a hierarchy of structural elements,
but do not impose any explicit hierarchy. Because the biological world
is inherently messy, the flexibility of a flat representation such as this
is very useful. For example, because it does not require a chain to be
either `above` or `below` a fragment, it can describe both a chain with gaps,
composed of multiple covalently bonded fragments and one that is covalently
bonded to another chain. And, although residues are in a given sequence order,
it does not require the polymer to be linear and can easily handle a
glycosylated protein where a chain may have a tree-like, rather than linear,
structure.

On the other hand, for some tasks a hierarchical view of biopolymers is
more natural and more efficient, despite the limitations of a hierarchy.
For more information, see the section :ref:`section_hierview`.

Note that although infrequently used, the `insertion code` modifies
the `residue number`. When comparing residue numbers it is necessary
to compare `both` the residue number and the insertion code.
The best way to avoid errors when comparing OEResidues is to
use :oe:func:`OEChem::OESameResidue`.

.. oe:source:: SimpleResCountDoc.cpp
   :language: c++
   :refnum:   1
   :caption:  Accessing OEResidue properties
   :frag:     SNIPPET

.. oe:source:: SimpleResCountDoc.py
   :language: python
   :refnum:   1
   :caption:  Accessing OEResidue properties
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-SimpleResCountDoc.py>`

.. oe:source:: SimpleResCountDoc.java
   :language: java
   :refnum:   1
   :caption:  Accessing OEResidue properties
   :frag:     SNIPPET

.. oe:source:: SimpleResCountDoc.cs
   :language: csharp
   :refnum:   1
   :caption:  Accessing OEResidue properties
   :frag:     SNIPPET

It is important to keep in mind that
:oe:cls:`OEResidues<OEChem::OEResidue>`
are not `residues`, but instead are
information blocks associated with atoms.
Several of the properties of an
:oe:cls:`OEResidue<OEChem::OEResidue>`
such as `atom serial number` and `occupancy`
are not residue properties at all,
but instead are properties of a specific atom.
Changing an :oe:cls:`OEResidue<OEChem::OEResidue>` property
will not modify anything in the molecule
until the :oe:cls:`OEResidue<OEChem::OEResidue>`
is saved back into the molecule,
and this must be done for each atom
for which the property is to be changed.

.. oe:source:: MSE2METDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MSE-TO-MET-CORE
   :refnum:   2
   :caption:  Updating OEResidue properties

.. oe:source:: MSE2METDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MSE-TO-MET-CORE
   :refnum:   2
   :caption:  Updating OEResidue properties

.. oe:source:: MSE2METDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MSE-TO-MET-CORE
   :refnum:   2
   :caption:  Updating OEResidue properties

.. oe:source:: MSE2METDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MSE-TO-MET-CORE
   :refnum:   2
   :caption:  Updating OEResidue properties

The input routines for Protein Data Bank (PDB) files
are setup to automatically perceive
:oe:cls:`OEResidue<OEChem::OEResidue>` properties
but the perception can also be done explicitly,
if required, as shown below.

.. oe:source:: ResAtomsDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-PERCEIVE-RES
   :refnum:   3
   :caption:  Perceiving OEResidues

.. oe:source:: ResAtomsDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-PERCEIVE-RES
   :refnum:   3
   :caption:  Perceiving OEResidues

.. oe:source:: ResAtomsDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-PERCEIVE-RES
   :refnum:   3
   :caption:  Perceiving OEResidues

.. oe:source:: ResAtomsDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-PERCEIVE-RES
   :refnum:   3
   :caption:  Perceiving OEResidues

.. _section_resname_conv:

Residue Naming Conventions
================================================================================

.. index:: OEResidues,Residue

The standard residue name list is ALA, ARG, ASN, ASP, CYS, GLN, GLU, GLY, HIS, ILE, LEU, LYS, MET, PHE, PRO, SER, THR, TRP, TYR, VAL, ASX, GLX, CYX, CYH, HID, HIE or HIP.

GLX and ASX are the Protein Data Bank’s standard names for when it is not clear whether the residue is a GLU or GLN, or an ASP or ASN. 

CYH and CYX are ways that groups outside of the PDB describe explicitly reduced and oxidized version of CYS, either cysteine or cystine respectively.  

We generally follow the standard-non-standard names from the AMBER force field. For example, we show ASH, CYS, CYH, CYM, GLH, HID, HIE, HIP, LYN, TYM, where H at the end means reduced, N means neutral and M means deprotonated. We will not generate PDB files or rename residues in molecules based on their physical state, but will follow the standard residue names like HIS to cover all states of HIE, HID, HIP. We also respect residue names provided to us. 

We discourage the use of UNX, UNK and UNL according to: `Worldwide PDB Heterogen Section <https://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET>`_. They should only be used in instances where the chemical components for which the chemical identity is truly unknown. From the wwPDB: Unknown atoms or ions will be represented as UNX with the chemical formula X1. Unknown ligands are UNL; unknown amino acids are UNK.

.. _section_hierview:

A Hierarchy View
================================================================================

.. index:: OEHierView, OEHierChain, OEHierFragment, OEHierResidue, Hierarchical View

At times, it may be more convenient to loop over residues or chains directly,
rather than looping over atoms and keeping track as :oe:cls:`OEResidue<OEChem::OEResidue>`
properties change. The :ref:`OEHierView <OEBio_OEHierView>` class supports this approach
by representing a biopolymer molecule as a hierarchy
of the components: :oe:cls:`OEHierChain<OEBio::OEHierChain>`,
:oe:cls:`OEHierFragment<OEBio::OEHierFragment>`,
and :oe:cls:`OEHierResidue<OEBio::OEHierResidue>`.

.. oe:source:: ResCountDoc.cpp
   :language: c++
   :refnum:   4
   :caption:  Looping over hierarchical components
   :frag:     SNIPPET

.. oe:source:: ResCountDoc.py
   :language: python
   :refnum:   4
   :caption:  Looping over hierarchical components
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-ResCountDoc.py>`

.. oe:source:: ResCountDoc.java
   :language: java
   :refnum:   4
   :caption:  Looping over hierarchical components
   :frag:     SNIPPET

.. oe:source:: ResCountDoc.cs
   :language: csharp
   :refnum:   4
   :caption:  Looping over hierarchical components
   :frag:     SNIPPET

Be aware that :oe:cls:`OEHierView<OEBio::OEHierView>` works
with what amounts to a snapshot of the molecule, so if changes are
made to the original molecule (such as adding or deleting atoms)
it may be necessary to rebuild the :oe:cls:`OEHierView<OEBio::OEHierView>`.

The `OEHier...` classes provide direct access to chains, fragments and
residues using common identifiers such as `chain id`, `residue name`
and `residue number`.

.. oe:source:: ResAtomsDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-RES-ATOMS-CORE
   :refnum:   5
   :caption:  Selecting a residue

.. oe:source:: ResAtomsDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-RES-ATOMS-CORE
   :refnum:   5
   :caption:  Selecting a residue

.. oe:source:: ResAtomsDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-RES-ATOMS-CORE
   :refnum:   5
   :caption:  Selecting a residue

.. oe:source:: ResAtomsDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-RES-ATOMS-CORE
   :refnum:   5
   :caption:  Selecting a residue

.. _section_sequence_alignment:

Sequence Alignment
================================================================================

.. index:: OESequenceAlignment, Sequence Alignment, Alignment, PAM250, BLOSUM62, GONNET

Two proteins can be sequence aligned
with the function :oe:func:`OEBio::OEGetAlignment`
which returns the class :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>`.
Several different amino acid distance matrices are supplied, including
:oe:const:`OEBio::OESeqAlignmentMethod::PAM250` [Dayhoff-1978]_ for closely
related proteins, and
:oe:const:`OEBio::OESeqAlignmentMethod::BLOSUM62` [Henikoff-1992]_ &
:oe:const:`OEBio::OESeqAlignmentMethod::GONNET` [Gonnet-1992]_ for
more distantly related proteins.

Alignments can be written out in standard format using the function
:oe:func:`OEBio::OEWriteAlignment`.

The function :oe:func:`OEBio::OERMSD` will
calculate the backbone or C-:math:`\alpha` RMSD of previously aligned proteins.

.. _section_crystal_symmetry:

Crystal Symmetry
================================================================================

.. index:: Symmetry, Crystal Symmetry, Space Group, Crystallographic Space Group, Unit Cell, Crystallographic Unit Cell

The space group and unit cell parameters
(`a`, `b`, `c`, :math:`\alpha`, :math:`\beta`, :math:`\gamma`)
for an x-ray crystal structure
can be accessed and modified using the following *OEBio* functions:

* :oe:func:`OEHasCrystalSymmetry<OEBio::OEHasCrystalSymmetry>`
* :oe:func:`OEGetCrystalSymmetry<OEBio::OEGetCrystalSymmetry>`
* :oe:func:`OESetCrystalSymmetry<OEBio::OESetCrystalSymmetry>`
* :oe:func:`OECopyCrystalSymmetry<OEBio::OECopyCrystalSymmetry>`
* :oe:func:`OEGetSpaceGroupNumber<OEBio::OEGetSpaceGroupNumber>`
* :oe:func:`OEGetSpaceGroup<OEBio::OEGetSpaceGroup>`

The function :oe:func:`OEBio::OEExpandCrystalSymmetry` will
replicate the molecule to fill-in each of the symmetry related
molecules in other regions of the crystal lattice, out to a specified radius.

Protein Secondary Structure
===============================================================================

.. index:: Secondary Structure, Helix, Beta Sheet

*OEBio* provides functionality for perceiving secondary structural elements
in proteins.  Perception is performed according to the method of Kabsch and
Sander [Kabsch-1983]_ and identifies helices, beta sheets, and turns based on
hydrogen bonding patterns within a protein.  The function
:oe:func:`OEBio::OEPerceiveSecondaryStructure` determines secondary structure
for a protein molecule, and stores the assigned secondary structure types in
the :ref:`OEResidue <OEChem_OEResidue>` associated with each atom in the protein.
Secondary structure assignments are stored as single integer values within
:ref:`OEResidue <OEChem_OEResidue>`, into which are packed the type
(helix, sheet, etc.), helix/sheet/turn ID numbers, and strand
identifiers for individual strands within beta sheets. To help decode the
secondary structure information packed in these integers, several functions
are provided:

* :oe:func:`OEGetSecondaryStructureType<OEBio::OEGetSecondaryStructureType>`
* :oe:func:`OEGetSecondaryStructureID<OEBio::OEGetSecondaryStructureID>`
* :oe:func:`OEGetSecondaryStructureStrandID<OEBio::OEGetSecondaryStructureStrandID>`
* :oe:func:`OEGetSecondaryStructureName<OEBio::OEGetSecondaryStructureName>`

These functions all take an integer argument, which is typically the value
returned from :oe:meth:`OEChem::OEResidue::GetSecondaryStructure`.  An
additional function, :oe:func:`OEBio::OESecondaryStructurePacked`, will do the
reverse operation, namely, taking a secondary structure type, ID, and optional
strand ID, and packing them into an integer suitable for use with
:oe:meth:`OEChem::OEResidue::SetSecondaryStructure`.

Secondary structure types are defined in the
:oe:constns:`OEBio::OESecondaryStructure` namespace.

* :oe:const:`Unassigned<OEBio::OESecondaryStructure::Unassigned>`
* :oe:const:`Helix<OEBio::OESecondaryStructure::Helix>`
* :oe:const:`Helix310<OEBio::OESecondaryStructure::Helix310>`
* :oe:const:`HelixAlpha<OEBio::OESecondaryStructure::HelixAlpha>`
* :oe:const:`HelixPi<OEBio::OESecondaryStructure::HelixPi>`
* :oe:const:`Turn<OEBio::OESecondaryStructure::Turn>`
* :oe:const:`Turn3<OEBio::OESecondaryStructure::Turn3>`
* :oe:const:`Turn4<OEBio::OESecondaryStructure::Turn4>`
* :oe:const:`Turn5<OEBio::OESecondaryStructure::Turn5>`
* :oe:const:`Sheet<OEBio::OESecondaryStructure::Sheet>`
* :oe:const:`StrandSense<OEBio::OESecondaryStructure::StrandSense>`
* :oe:const:`HelixLeft<OEBio::OESecondaryStructure::HelixLeft>`
* :oe:const:`Any<OEBio::OESecondaryStructure::Any>`

A functor is also provided to help identify atoms belonging to particular
secondary structure features.
:oe:cls:`OEHasSecondaryStructure<OEBio::OEHasSecondaryStructure>` takes an
integer argument.  This integer can be one of the above constants (e.g.,
to find all atoms belonging to alpha helices); the value retrieved from a call
to :oe:meth:`OEChem::OEResidue::GetSecondaryStructure` (e.g., to find all atoms
belonging to the same helix as a particular residue); or a value returned
from :oe:func:`OEBio::OESecondaryStructurePacked`, which can be used to find
atoms from a specific secondary structural element, such as Helix number 4.

Functors
================================================================================

.. index:: Functor, Predicate

A number of atom predicates are provided
in *OEBio* to make it easy to identify atoms with particular properties:

* :oe:cls:`OEAtomMatchResidue<OEBio::OEAtomMatchResidue>`
* :oe:cls:`OEIsAlphaCarbon<OEBio::OEIsAlphaCarbon>`
* :oe:cls:`OEIsBackboneAtom<OEBio::OEIsBackboneAtom>`
* :oe:cls:`OEIsWater<OEBio::OEIsWater>`
* :oe:cls:`OEHasAlternateLocation<OEBio::OEHasAlternateLocation>`
* :oe:cls:`OEHasSecondaryStructure<OEBio::OEHasSecondaryStructure>`
* :oe:cls:`OEHasPDBAtomIndex<OEBio::OEHasPDBAtomIndex>`

This last predicate uses PDBAtoms (such as
:oe:const:`CA<OEChem::OEPDBAtomName::CA>`)
to refer to specific atom types
in a Protein Data Bank (PDB) structure.

Misc
================================================================================

.. index:: Classification, OEIsStandardProteinResidue, OEPDBClassify, OEGetResidueAtoms

The function :oe:func:`OEBio::OEIsStandardProteinResidue` indicates
whether a given :oe:cls:`OEHierResidue<OEBio::OEHierResidue>` is
a standard amino acid.

The function :oe:func:`OEBio::OEHasBondedResidues` indicates
whether the atoms in each residue have bonds to the same residue.

Given an :oe:cls:`OEAtomBase<OEChem::OEAtomBase>` or :oe:cls:`OEResidue<OEChem::OEResidue>`,
the function :oe:func:`OEBio::OEGetResidueAtoms` will return
an iterator over all the atoms in the residue.


.. _chapter_bondproperties:

********************************************************************************
Bond Properties
********************************************************************************

.. index:: OEBondBase, bond properties

The :oe:cls:`OEBondBase<OEChem::OEBondBase>` represents the bonds of a molecule.
This section details some of its important and often used properties and methods.

.. _section_bondproperties_readwrite:

Read/Write Bond Properties
================================================================================

.. index::
   single: bond order
   single: bond aromaticity
   single: bond ring membership
   single: integer bond type
   single: bond type name
   single: bond begin atom
   single: bond end atom
   single: bond chirality
   single: bond stereo

.. list-table::
   :widths: 30 15 20 20 30
   :header-rows: 1

   * - Property Name
     - Type
     - Get Method
     - Set Method
     - See Also
   * - Bond Order
     - unsigned int
     - :oe:meth:`GetOrder<OEChem::OEBondBase::GetOrder>`
     - :oe:meth:`SetOrder<OEChem::OEBondBase::SetOrder>`
     -
   * - Aromaticity
     - bool
     - :oe:meth:`IsAromatic<OEChem::OEBondBase::IsAromatic>`
     - :oe:meth:`SetAromatic<OEChem::OEBondBase::SetAromatic>`
     - :ref:`chapter_aromaticity`
   * - Ring Membership
     - bool
     - :oe:meth:`IsInRing<OEChem::OEBondBase::IsInRing>`
     - :oe:meth:`SetInRing<OEChem::OEBondBase::SetInRing>`
     - :ref:`chapter_ring`
   * - Integer Bond Type
     - int
     - :oe:meth:`GetIntType<OEChem::OEBondBase::GetIntType>`
     - :oe:meth:`SetIntType<OEChem::OEBondBase::SetIntType>`
     -
   * - Bond Type Name
     - string
     - :oe:meth:`GetType<OEChem::OEBondBase::GetType>`
     - :oe:meth:`SetType<OEChem::OEBondBase::SetType>`
     -
   * - Begin Atom
     - :oe:cls:`OEAtomBase<OEChem::OEAtomBase>`
     - :oe:meth:`GetBgn<OEChem::OEBondBase::GetBgn>`
     - :oe:meth:`SetBgn<OEChem::OEBondBase::SetBgn>`
     -
   * - End Atom
     - :oe:cls:`OEAtomBase<OEChem::OEAtomBase>`
     - :oe:meth:`GetEnd<OEChem::OEBondBase::GetEnd>`
     - :oe:meth:`SetEnd<OEChem::OEBondBase::SetEnd>`
     -
   * - Bond Chirality
     - bool
     - :oe:meth:`IsChiral<OEChem::OEBondBase::IsChiral>`
     - :oe:meth:`SetChiral<OEChem::OEBondBase::SetChiral>`
     - :ref:`chapter_stereochemistry`
   * - Bond Stereo
     - unsigned int
     - :oe:meth:`GetStereo<OEChem::OEBondBase::GetStereo>`
     - :oe:meth:`SetStereo<OEChem::OEBondBase::SetStereo>`
     - :ref:`chapter_stereochemistry`

.. _section_bondproperties_readonly:

Read Only Bond Properties
================================================================================

.. index::
   single: bond begin atom index
   single: bond end atom index
   single: bond index
   single: bond stereo
   single: bond parent
   single: rotatable bond

.. list-table::
   :widths: 30 15 20 30
   :header-rows: 1

   * - Property Name
     - Type
     - Get Method
     - See Also
   * - Begin Atom Index
     - unsigned int
     - :oe:meth:`GetBgnIdx<OEChem::OEBondBase::GetBgnIdx>`
     - :ref:`chapter_atombondindices`
   * - End Atom Index
     - unsigned int
     - :oe:meth:`GetEndIdx<OEChem::OEBondBase::GetEndIdx>`
     - :ref:`chapter_atombondindices`
   * - Bond Index
     - unsigned int
     - :oe:meth:`GetIdx<OEChem::OEBondBase::GetIdx>`
     - :ref:`chapter_atombondindices`
   * - Bond Has Stereo
     - bool
     - :oe:meth:`HasStereoSpecified<OEChem::OEBondBase::HasStereoSpecified>`
     - :ref:`chapter_stereochemistry`
   * - Bond Parent
     - :oe:cls:`OEMolBase<OEChem::OEMolBase>`
     - :oe:meth:`GetParent<OEChem::OEBondBase::GetParent>`
     -
   * - Rotatable
     - bool
     - :oe:meth:`IsRotor<OEChem::OEBondBase::IsRotor>`
     - :term:`rotatable bond`

.. _section_bondproperties_genericdata:

Attach Generic Data to Bonds
================================================================================

Generic data (see :ref:`chapter_genericdata`) can be attached to any object
that derives from the :ref:`OEBase <OESystem_OEBase>` class. The
:ref:`OEBondBase <OEChem_OEBondBase>` API provides the following methods, publicly
inherited from :ref:`OEBase <OESystem_OEBase>`, that allow the manipulation of
generic data.

.. list-table:: **Methods to manipulate generic data**
   :widths: 15 40
   :header-rows: 1

   * - Method
     - Description

   * - :oe:meth:`SetData<OESystem::OEBase::SetData>`
     - sets a generic data associating it with the given tag

   * - :oe:meth:`AddData<OESystem::OEBase::AddData>`
     -  adds a generic data associating it with the given tag

   * - :oe:meth:`HasData<OESystem::OEBase::HasData>`
     - determines whether a molecule has any generic data with a given tag

   * - :oe:meth:`GetData<OESystem::OEBase::GetData>`
     - returns the generic data associated with the given tag

   * - :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`
     - deletes all generic data  with the given tag

   * - :oe:meth:`Clear<OESystem::OEBase::Clear>`
     - clears all stored generic data

.. note::

   Generic data attached to a molecule or any of its atoms or bonds is automatically
   saved when the molecule is written into an :file:`.oeb` file.

.. seealso::

   * :ref:`section_attaching_other_objects` section
   * :ref:`section_moltaggeddata_SD` section
   * :ref:`section_moltaggeddata_PDB` section


.. _chapter_charges:

********************************************************************************
Formal and Partial Charges
********************************************************************************

.. index:: formal charge, partial charge

Each :oe:cls:`OEAtomBase<OEChem::OEAtomBase>` keeps track of two types of charges:  

* The first, **formal charge**, is an integer property that is essential for the correct 
  valence representation of a molecule.  
  Together with atomic valences, bond order and the connectivity, this field 
  defines the identity of a molecule.

* The second type of charge, **partial charge**, is a floating 
  point property used in computational chemistry and molecular modeling.  
  This value is used to represent the electronic distribution/wave-function of a 
  molecule by approximating the molecule's electrostatic field with a set of point
  charges located at each atom.

.. list-table::
   :widths: 30 15 20 20 
   :header-rows: 1

   * - Property Name
     - Type
     - Get Method
     - Set Method
   * - Formal Charge
     - integer
     - :oe:meth:`GetFormalCharge<OEChem::OEAtomBase::GetFormalCharge>`
     - :oe:meth:`SetFormalCharge<OEChem::OEAtomBase::SetFormalCharge>`
   * - Partial Charge
     - double
     - :oe:meth:`GetPartialCharge<OEChem::OEAtomBase::GetPartialCharge>`
     - :oe:meth:`SetPartialCharge<OEChem::OEAtomBase::SetPartialCharge>`

Neither the formal charge nor the partial charge is a directly observable property 
of an atom.  
Instead the same molecule may be represented by different valence representations, 
each placing the formal charges in different locations, *i.e.* different partial 
charging algorithms may assign significantly different partial charges to the same atom
(for example benzene can be represented as ``[cH+]1[cH-][cH+][cH-][cH+][cH-]1``)

Formal Charges Assignment
================================================================================

Normally, file formats such as SMILES, SLN or MDL's SDF format, specify the formal 
charges on each atom of a connection table.  
However, when reading from other file formats or when repairing 'broken' molecules, 
it may be convenient to assign formal charges to each atom such that the atomic
valence is consistent.  
**OEChem TK** provides this functionality via the 
:oe:func:`OEAssignFormalCharges<OEChem::OEAssignFormalCharges>` function.  
This function requires that bond orders and implicit hydrogen counts have been set 
on a molecule.  
It then adjusts the formal charge on each uncharged atom to correct common valence
model mismatches.  
For example, quaternary nitrogens are assigned a +1 formal charge, and terminal 
oxygen connected only by a single bond (with no implicit hydrogens) is assigned a 
-1 formal charge.

A more technical discussion of the formal charges that are assigned by
this function are described in the :ref:`subsection_valence_openeye_charge`
section.

.. _section_charges_Gasteiger:

Gasteiger Partial Charge Calculation
================================================================================

.. index:: Gasteiger charge

To assign Marsilli-Gasteiger partial charges to a molecule, **OEChem TK** provides the 
:oe:func:`OEGasteigerPartialCharges<OEChem::OEGasteigerPartialCharges>` function.  
This sets the partial charge property of each atom, using the 
:oe:meth:`SetPartialCharge<OEChem::OEAtomBase::SetPartialCharge>` method.  
The algorithm itself reproduces the partial charges as calculated by Tripos Inc's Sybyl
software, with default parameter settings, which is the *de facto*
reference implementation for Gasteiger charges.

The Gasteiger partial charge algorithm currently assumes that all hydrogen atoms are 
represented explicitly, for example by calling 
:oe:func:`OEAddExplicitHydrogens<OEChem::OEAddExplicitHydrogens>`.

The current version of :oe:func:`OEGasteigerPartialCharges<OEChem::OEGasteigerPartialCharges>`
should return the same results independent of the currently assigned aromaticity 
models and the values of each  atom's "integer atom type" property.
Early versions of **OEChem TK** allowed customization of the Gasteiger charge calculation 
by explicitly assigning the Tripos atoms types of each atom of the molecule.  
Unfortunately, this required assigning Tripos' aromaticity and assigning Tripos 
atom types before each call to 
:oe:func:`OEGasteigerPartialCharges<OEChem::OEGasteigerPartialCharges>`.  
The more recent behavior is less error-prone (as it's no longer possible to forget 
to prepare a molecule) and greatly simplifies common usage.

The first stage of the Marsilli-Gasteiger *"Partial Equalization of Orbital 
Electronegativities"* (PEOE)" calculation [Gasteiger-1980]_  is assignment of
seed charges to each atom.  
Typically for neutral atoms the partial charge seed is zero, but for example, 
each oxygen in a carboxylate is assigned -0.5, and the net formal charge on 
conjugated rings is shared equally amongst the atoms of the ring system.  
These seed charges may also be useful in some applications, and can be assigned
using the :oe:func:`OEGasteigerInitialCharges<OEChem::OEGasteigerInitialCharges>` 
method.

.. seealso::

   * [Gasteiger-1978]_  
   * [Gasteiger-1980]_
 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _chapter_connectivity:

********************************************************************************
Connectivity Perception
********************************************************************************

**OEChem TK** provides several functions for determining the connectivity and/or bond
orders from various input file formats.
For correct molecule processing, **OEChem TK** requires all the covalent bonds to be
represented in a molecule and each bond to have a defined bond order,
1 for single, 2 for double, 3 for triple and 4 for quadruple.
Given this explicit |Kekule| representation of a molecule, **OEChem TK** can perceive
and re-perceive high order attributes such as ring membership or aromaticity
as defined by different aromaticity models.

Alas, unlike MDL's SD file format, not all file formats explicitly specify a
|Kekule| form of a molecule with explicit bond orders.
The functions, described in this chapter, attempt to deduce such a representation
from the information that is available in such file formats.

.. _section_connectivity_from3d:

Connectivity From 3D Coordinates
================================================================================

For file formats that provide 3D coordinates, but not explicit bond information
(or only partial bond information), **OEChem TK** uses the
:oe:func:`OEDetermineConnectivity<OEChem::OEDetermineConnectivity>` function.
This function deduces the pattern of covalent bonding in a molecule from the
proximity of atoms.
Two atoms are considered bonded if they are located within the sum of their
covalent radii (:oe:func:`OEGetCovalentRadius<OEChem::OEGetCovalentRadius>`)
plus an additional "slop" factor of 0.45 Angstroms.

.. _figure_connectivity_nobond:

.. figure:: /_images/connectivity-01.png
   :scale:  100
   :align:  center

   *Example of 3D molecule with no explicit bond information*

:oe:func:`OEDetermineConnectivity<OEChem::OEDetermineConnectivity>` will not
create a bond between two atoms that are less than 0.4 Angstroms apart.
Such unreasonably short bond lengths indicate the structure is either severely
distorted, or doesn't have coordinate information at all.

All bonds created by :oe:func:`OEDetermineConnectivity<OEChem::OEDetermineConnectivity>`
have bond orders set to one.
To perceive bond order information, see **OEChem TK**'s
:oe:func:`OEPerceiveBondOrders<OEChem::OEPerceiveBondOrders>` function described
in the next section.

.. figure:: /_images/connectivity-02.png
   :scale:  100
   :align:  center

   *Example of 3D molecule with perceived bond connectivity*

The :oe:func:`OEDetermineConnectivity<OEChem::OEDetermineConnectivity>` function
checks whether a bond already exists between two atoms before creating a new
bond.
This allows this function to be used with file formats that may specify partial
connectivity, such as only multiple (double, triple or quadruple) bonds.

.. _section_connectivity_bond_order_perception:

Bond Order Perception
================================================================================

The :oe:func:`OEPerceiveBondOrders<OEChem::OEPerceiveBondOrders>` function is
used to deduce bond orders from the 3D coordinates and simple connectivity
of a molecule.
If the simple connectivity, *i.e.* bonds without bond orders isn't specified in
the input file, :oe:func:`OEDetermineConnectivity<OEChem::OEDetermineConnectivity>`
should be called first to deduce this information from the 3D coordinates.

.. figure:: /_images/connectivity-03.png
   :scale:  100
   :align:  center

   *Example of 3D molecule with perceived connectivity and bond order*

The following code snippet shows how to perceive connectivity and bond order if a
molecule has 3D information but no explicit bond information:

.. oe:source:: PerceiveConnectivity.cpp
   :language: c++
   :frag:     SNIPPET-CONNECT-PERCEIVE
   :noindent:

.. oe:source:: PerceiveConnectivity.py
   :language: python
   :frag:     SNIPPET-CONNECT-PERCEIVE
   :noindent:

.. oe:source:: PerceiveConnectivity.java
   :language: java
   :frag:     SNIPPET-CONNECT-PERCEIVE
   :noindent:

.. oe:source:: PerceiveConnectivity.cs
   :language: csharp
   :frag:     SNIPPET-CONNECT-PERCEIVE
   :noindent:

.. seealso::

   * :oe:func:`OEChem::OEDetermineConnectivity`
   * :oe:func:`OEChem::OEFindRingAtomsAndBonds`
   * :oe:func:`OEChem::OEPerceiveBondOrders`
   * :oe:func:`OEChem::OEAssignImplicitHydrogens`
   * :oe:func:`OEChem::OEAssignFormalCharges`

|Kekule| Form Assignment
================================================================================

.. index::  Kekule form, kekulization

A number of file formats don't represent a connection table as a
single representative |Kekule| form but instead denote some bonds,
such as those in benzene, as aromatic.  **OEChem TK** provides a method for
determining a valid, but arbitrary, |Kekule| form for such connection
tables using the :oe:func:`OEKekulize<OEChem::OEKekulize>` function
(see example in :ref:`Figure: Kekulization of
quinolin<figure_connectivity_kekule>`).  On input to
:oe:func:`OEKekulize<OEChem::OEKekulize>`, the integer bond type
property of each bond represents either the bond order (1 for single,
2 for double, 3 for triple or 4 for quadruple) or the value 5
indicating the bond is aromatic or resonant.  The algorithm sets the
bond order property from the bond type property, with the exception of
bond type 5, which is assigned a bond order of either 1 or 2
representing either a single or double bond.  The boolean return value
indicates whether a valid |Kekule| form could be assigned.

.. seealso::

   :oe:func:`OEKekulize<OEChem::OEKekulize>` function is normally only used by
   low-level file readers for interpreting input connection tables.
   To write out a |Kekule| SMILES string, the aromaticity atom and bond flags
   have to be cleared by the :oe:func:`OEClearAromaticFlags<OEChem::OEClearAromaticFlags>`
   function in order to consider a molecule as aliphatic with explicit bond order.
   See example code in :ref:`section_aromaticity_clearing`.

.. _figure_connectivity_kekule:

.. figure:: oechemtk/images/OEKekulize.*
   :scale:  100
   :align:  center

   **Kekulization of quinolin**

   *OEKekulize() function arbitrary generates one of the three valid Kekulé forms*

.. seealso::

   * [Baber-1992]_
   * [Hendlich-1997]_
   * [Kearsley-1993]_
   * [Labute-1996]_
   * [Meng-1991]_

.. _section_kekule_assignment_of_new_bonds:

|Kekule| Assignment of New Bonds
================================================================================

Molecules input to
:oe:func:`OEKekulize<OEChem::OEKekulize>` must have their integer bond type set.
The property of each bond represents either the bond order (1 for single,
2 for double, 3 for triple or 4 for quadruple) or the value 5 indicating
the bond is aromatic or resonant. When creating new atoms and bonds internally
the integer type is set to a default value of 0. The following code snippet
outlines how to prepare modified molecules by setting the bond int type so that
they can be passed to :oe:func:`OEKekulize<OEChem::OEKekulize>`:

.. oe:source:: PerceiveKekule.cpp
   :language: c++
   :frag:     SNIPPET-CORRECT-COMPLEX
   :noindent:

.. oe:source:: PerceiveKekule.py
   :language: python
   :frag:     SNIPPET-CORRECT-COMPLEX
   :noindent:

.. oe:source:: PerceiveKekule.java
   :language: java
   :frag:     SNIPPET-CORRECT-COMPLEX
   :noindent:

.. oe:source:: PerceiveKekule.cs
   :language: csharp
   :frag:     SNIPPET-CORRECT-COMPLEX
   :noindent:



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. _oechem_chapter_cookbook_examples:

********************************************************************************
Python Cookbook Examples
********************************************************************************

There are large number of code examples available in
`OpenEye Python Cookbook <http://docs.eyesopen.com/python_modules/cookbook/index.html>`_
that use **OpenEye Toolkits** to solve a wide range of cheminformatics and molecular
modeling problems.

* `2D Depiction <http://docs.eyesopen.com/python_modules/cookbook/depiction/depiction.html>`_ chapter
  contains examples that illustrate how the **OEDepict TK** and **Grapheme TK** can be
  utilized to depict molecules and visualize properties calculated with other OpenEye toolkits.

* `Visualizing 3D Information <http://docs.eyesopen.com/python_modules/cookbook/visualization/visualization.html>`_
  chapter contains examples that illustrate how the **Grapheme TK** can be utilized to project
  complex 3D information into the 2D molecular graph.

* `Cheminformatics <https://docs.eyesopen.com/python_modules/cookbook/cheminfo/cheminfo.html>`_
  chapter contains examples that solve various cheminformatics problems such as similarity search,
  ring perception and manipulating molecular graphs.

* `Peptide Informatics <https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptideinfo.html>`_
  chapter contains examples that solve various peptide informatics problems such as generating custom monomer sets,
  parsing and generating :term:`HELM` representations, and visualizing peptides.


.. admonition:: OpenEye Python Cookbook examples using OEChem TK 

   * `Manipulating Large Molecule Files`_
   * `Enumerating Fragment Combinations`_
   * `Ring Perception`_
   * `Enumerating Atom Substitutions`_
   * `Reordering CSV File`_

.. admonition:: OpenEye Python Cookbook examples related to peptide informatics using OEChem TK

   * `Generating Custom Monomer Set`_
   * `Convert HELM to SMILES`_
   * `Convert HELM File to Molecule File`_
   * `Convert SMILES to HELM`_
   * `Convert Molecule File to HELM File`_
   * `Generate Random Peptides`_
   * `Mutate Peptide`_

.. admonition:: OpenEye Python Cookbook examples related to protein-ligand interactions using OEBio TK

   * `Accessing Interaction Hint Information`_
   * `Print Protein-Ligand Interactions to Console`_
   * `Print the Summary of Protein-Ligand Interactions for a Set of Molecules`_


.. _chapter_designdecisions:

********************************************************************************
Design Decisions
********************************************************************************

This chapter seeks to give a general overview of the major design
decisions behind **OEChem TK**. The reader should have an understanding of
the basic **OEChem TK** objects and functions. The reader should also be
familiar with the basics of object oriented programming.

Throughout this manual, the :ref:`OEMol <OEChem_OEMol>`,
:ref:`OEGraphMol <OEChem_OEGraphMol>`, and :ref:`OEQMol <OEChem_OEQMol>` are the
concrete classes which handle most molecular representation in
**OEChem TK**. The :ref:`OEGraphMol <OEChem_OEGraphMol>` API is defined in the
:ref:`OEMolBase <OEChem_OEMolBase>` abstract base-class, the
:ref:`OEMol <OEChem_OEMol>` API is defined by the
:ref:`OEMolBase <OEChem_OEMolBase>` and
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` abstract base-classes, and
the :ref:`OEQMol <OEChem_OEQMol>` API is defined by the
:ref:`OEMolBase <OEChem_OEMolBase>` and :ref:`OEQMolBase <OEChem_OEQMolBase>` abstract
base-classes. The :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` class
publicly inherits from the :ref:`OEMolBase <OEChem_OEMolBase>` class, which in
turn inherits from the :ref:`OEBase <OESystem_OEBase>` class. Similarly, the
:ref:`OEQMolBase <OEChem_OEQMolBase>` class publicly inherits from the
:ref:`OEMolBase <OEChem_OEMolBase>` class, which again inherits from the
:ref:`OEBase <OESystem_OEBase>` class. An :ref:`OEGraphMol <OEChem_OEGraphMol>`, can
be passed to any function which takes an :ref:`OEMolBase <OEChem_OEMolBase>`
argument. An :ref:`OEMol <OEChem_OEMol>` can be passed to any function
which takes an :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` or
:ref:`OEMolBase <OEChem_OEMolBase>` argument, and an :ref:`OEQMol <OEChem_OEQMol>`
can be passed to any function which takes an
:ref:`OEQMolBase <OEChem_OEQMolBase>` or :ref:`OEMolBase <OEChem_OEMolBase>`
argument. :ref:`Figure: Hierarchy A<figure_molhierarchy>` represents the **OEChem TK**
molecule hierarchy described in this paragraph.

.. _figure_molhierarchy:

.. figure:: oechemtk/images/OEChemMoleculeHierarchy.*
   :align:  center
   :scale:  100

   **Hierarchy A**

   **OEChem TK** Molecule Hierarchy

.. seealso: STILL EMPTY CHAPTER

   The :ref:`chapter_genericdata` chapter discusses why everything
   derives from :ref:`OEBase <OESystem_OEBase>`.

.. _section_designdecisions_abstract_baseclasses:

Abstract Base-Classes
================================================================================

The most important data types in the **OEChem TK** library are
:ref:`OEMolBase <OEChem_OEMolBase>`, :ref:`OEAtomBase <OEChem_OEAtomBase>`, and
:ref:`OEBondBase <OEChem_OEBondBase>`. These three classes describe the
behaviors of molecules, atoms, and bonds respectively. However, these
types are `abstract classes
<http://en.wikipedia.org/wiki/Abstract_type>`_, describing the methods
and semantics of molecules, atoms and bonds, but without defining an
actual implementation.
(See :ref:`Figure: Hierarchy B<figure_baseclass_hierarchy>`)

.. _figure_baseclass_hierarchy:

.. figure:: oechemtk/images/OEChemBaseHierarchy.*
   :align:  center
   :scale:  100

   **Hierarchy B**

   **OEChem TK** Abstract Base-Classes

Hiding the implementation of these types is very important to the
longevity of **OEChem TK**. It avoids the problem of the `leaky abstraction
<http://en.wikipedia.org/wiki/Leaky_abstraction>`_. If code was
written that was expecting a certain behavior from the implementation
it would be fragile to arbitrary changes in implementation.
Therefore, these abstract base-classes are considered
stable, with a guarantee that they will not change from version to
version.

.. *OpenEye* spends quite a bit of resources in tuning implementations, doing so
   should not break downstream code from one version to the
   next.

.. note::

   Since :ref:`OEAtomBase <OEChem_OEAtomBase>`, :ref:`OEBondBase <OEChem_OEBondBase>`, and
   :oe:cls:`OEConfBase<OEChem::OEConfBase>` can only be accessed
   through their parent molecules, there is no need for concrete
   instances of these classes. In **OEChem TK**, these three classes are
   accessed via references to their respective base-classes, or
   through the iterator interface discussed in the
   :ref:`chapter_atombondtraversal` chapter.

.. _section_designdecisions_factoryfunctions:

Factory Functions
================================================================================

It is standard practice when working with abstract base-classes, such
as the :ref:`OEMolBase <OEChem_OEMolBase>`, to define a function which returns
a pointer to one of these objects. These functions, called `factories
<http://en.wikipedia.org/wiki/Factory_method_pattern>`_, give library
users access to concrete objects even when only the abstract
base-class is exposed in the public API. The following factory
functions are provided to create molecule objects in **OEChem TK**. The
associated symbolic namespace is used to control what type of molecule
implementation is returned.

.. list-table::
   :header-rows: 1

   * - Factory Function
     - Symbolic Namespace
   * - :oe:func:`OEChem::OENewMolBase`
     - :oe:constns:`OEChem::OEMolBaseType`
   * - :oe:func:`OEChem::OENewMCMolBase`
     - :oe:constns:`OEChem::OEMCMolType`
   * - :oe:func:`OEChem::OENewQMolBase`
     - :oe:constns:`OEChem::OEQMolType`

.. _section_designdecisions_smartpointers:

Smart Pointers
================================================================================

The problem with factory functions is that they require the user to
manage the object's memory. When the factory function returns a
pointer to an abstract base-class, it also passes ownership of the
memory to the programmer. To alleviate the problems associated with
memory management introduced by factories, the `smart-pointer
<http://en.wikipedia.org/wiki/Smart_pointer>`_ idiom is often
used. Simply put, a smart-pointer holds a real pointer to an object,
and deallocates the pointer's memory when the smart-pointer goes out
of scope (*e.g.* in its destructor). In **OEChem TK**,
:oe:cls:`OEGraphMols<OEChem::OEGraphMol>`,
:oe:cls:`OEMols<OEChem::OEMol>`, and :oe:cls:`OEQMols<OEChem::OEQMol>`
fulfill the function of both factories and smart-pointers. This gives
the user access to multiple implementations without the need of
worrying about memory management. The constructors allow the user to
specify which implementation they would like using the associated
symbolic namespace described in the previous table. Then the objects
themselves act as smart-pointers, cleaning up the implementation
pointers when the molecules go out of scope.

:oe:src:`Listing 1<SNIPPET-MolBaseType>` demonstrates how to specify an
alternative molecule implementation. A :ref:`SMILES <chapter_SMILES>`
string is then read into different implementation. This
demonstrates how implementations that adhere to the
:ref:`OEMolBase <OEChem_OEMolBase>` interface can reuse existing algorithms
written towards it.

.. oe:source:: MolBaseType.cpp
   :language: c++
   :caption:  Using an alternative molecule implementation
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: MolBaseType.py
   :language: python
   :caption:  Using an alternative molecule implementation
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: MolBaseType.java
   :language: java
   :caption:  Using an alternative molecule implementation
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: MolBaseType.cs
   :language: csharp
   :caption:  Using an alternative molecule implementation
   :refnum:   1
   :frag:     SNIPPET

.. _section_molimplementations_inmemorymolecules:

.. In Memory Molecules
.. ============================================================================

.. _section_molimplementations_querymolecules:

Query Molecules
============================================================================

It is not uncommon in chemical informatics to consider the equivalence
of the graph which represents a molecule and the graph which
represents a substructure query.  Indeed the simplest of queries are
molecules themselves.  If one considers each node (or atom) as a
potentially complex atom query, even highly complex queries can be
represented as molecules.

In **OEChem TK**, this concept of a query as a molecule is represented by
the :ref:`OEQMolBase <OEChem_OEQMolBase>` abstract base-class.  An
:ref:`OEQMolBase <OEChem_OEQMolBase>` contains :ref:`OEQAtomBase <OEChem_OEQAtomBase>` and
:ref:`OEQBondBase <OEChem_OEQBondBase>` atom and bond representations.  These
versions of **OEChem TK** atoms and bonds manage the atom and bond
expressions which comprise the query.

**OEChem TK** defines the concrete :ref:`OEQMol <OEChem_OEQMol>` class which
provides a programmer access to the API defined by the
:ref:`OEQMolBase <OEChem_OEQMolBase>` class.  This is analogous to the way an
:ref:`OEGraphMol <OEChem_OEGraphMol>` provides concrete access to
:ref:`OEMolBase <OEChem_OEMolBase>` API. :ref:`Figure: Hierarchy C<figure_qmolhierarchy>`
represents the **OEChem TK** query molecule hierarchy.

.. _figure_qmolhierarchy:

.. figure:: oechemtk/images/OEChemQueryMoleculeHierarchy.*
   :align:  center
   :scale:  100

   **Hierarchy C**

   **OEChem TK** Query Molecule Hierarchy

This abstraction allows **OEChem TK** to treat separate query mechanisms to
work similarly. This is similar to how **OEChem TK** can represent any
molecular file format through a single :ref:`OEMolBase <OEChem_OEMolBase>`
interface. For example, :ref:`SMARTS <chapter_SMARTS>` can be parsed
into an :ref:`OEQMolBase <OEChem_OEQMolBase>` using the
:oe:func:`OEChem::OEParseSmarts` function. Also, :ref:`MDL Queries
<chapter_mdlqueries>` can be parsed into an
:ref:`OEQMolBase <OEChem_OEQMolBase>` using the
:oe:func:`OEChem::OEReadMDLQueryFile` file.

.. seealso::

   :ref:`chapter_patternmatch` for a general discussion of **OEChem TK**
   pattern matching facilities.

.. _section_designdecisions_freefunctions:

Free-Functions
============================================================================

**OEChem TK** is an object-oriented library. However, the design philosophy
is that molecule objects are primarily data containers with data
access member functions. Most powerful data analysis and manipulation
routines in **OEChem TK** are implemented as free functions rather than
member functions. This decision is based on the realization that the
abstraction of a molecule can be neither stable nor consistent. To one
programmer, a molecule should describe and perceive the space group of
organometallic complexes, while to another a molecule should describe
the residues and secondary structure of a macromolecule. Both of these
perspectives are reasonable and should be supported. Further, a nearly
infinite additional list of molecule designs can be imagined and
should be supported. In order to do this, the **OEChem TK** molecule must be
extensible, light-weight, and easily re-implemented. Thus, major
changes to the **OEChem TK** molecules can be made, without need to
re-implement more than a handful of functions. Conversely, an entire
new area of chemistry can be added to the **OEChem TK** repertoire through
free-functions without needing to implement the function in multiple
molecules. We have used namespaces extensively to keep the
free-functions from cluttering the global namespace.

.. oe:language:: c++ java csharp

   The concrete classes are provided for the reasons described in the
   :ref:`section_designdecisions_smartpointers` section. Function
   parameters should never specify these concrete classes. Instead,
   they should always be declared using the corresponding abstract
   base-classes. For instance, rather than:

.. oe:language:: c++

   .. code-block:: c++

      void fcn(const OEGraphMol &mol)
      {
        ...
      }

.. oe:language:: java

   .. code-block:: java

      void fcn(OEGraphMol mol)
      {
        ...
      }

.. oe:language:: csharp

   .. code-block:: csharp

      void fcn(OEGraphMol mol)
      {
        ...
      }

.. oe:language:: c++ java csharp

   Functions parameters should use the appropriate abstract base-class
   like the following:

.. oe:language:: c++

   .. code-block:: c++

      void fcn(const OEMolBase &mol)
      {
        ...
      }

.. oe:language:: java

   .. code-block:: java

      void fcn(OEMolBase mol)
      {
        ...
      }

.. oe:language:: csharp

   .. code-block:: csharp

      void fcn(OEMolBase mol)
      {
        ...
      }

.. seealso::

   The :ref:`OEChem Functions<chapter_oechemfunctions>` API section for
   a complete listing of all of **OEChem TK**'s free-functions.

.. _section_designdecisions_programminglayers:

Programming Layers: The Deep and Twisted Path
================================================================================

**OEChem TK** was designed to provide a library which puts powerful
algorithms in the hands of novice users without hand-cuffing the
expert. For this reason, **OEChem TK** can at the same time seem trivial
and overwhelming. There are often several ways to carry out certain
tasks in **OEChem TK** each with its subtle advantages, which can benefit
an experienced user. There are very few algorithms we have shied away
from including in **OEChem TK**, and many of the methods are new, unique
and powerful. This gives **OEChem TK** a very rich interface, yet to gain
this efficiency and power **OEChem TK** may force the user to think about
problems in ways they are not accustomed to doing. The hope is that
the user can benefit from the experience.

.. If it appears difficult to
   carry out a task with **OEChem TK**, please do not hesitate to contact
   *OpenEye* support (support@eyesopen.com).

**OEChem TK** has several layers of interfaces to most of its
functionality. There are "high-level" interfaces, which provide the
user with an enormous amount of power with minimal code. This level is
exemplified by the :oe:func:`OEChem::OEReadMolecule` and
:oe:func:`OEChem::OEWriteMolecule` functions. With these functions the
functionality of the ``babel`` file-format conversion program is
trivial. While this is trivial to write and understand (maybe after
understanding this manual), it should not belie the fact that **OEChem TK**
is carrying out an enormous amount of work under the surface.

A perhaps "mid-level" interface in **OEChem TK** is the ability to fine
tune molecule file-formats using flavors described in
:ref:`section_molreadwrite_flavoredinputandoutput` section. Flavors
are most useful when file-formats are being used for more than they
were originally intended, for example, PDB files.  While this
functionality is perhaps not for the first-day user, it certainly
doesn't require a stout heart.

Finally, for advanced programmers, **OEChem TK** provides access to nearly
all of the details. **OEChem TK** molecules have a simple API which can be
used to derived custom molecule implementations. The free-function
heavy API lets the user apply **OEChem TK's** powerful algorithms on custom
data structures. Similarly, many of the functions that are wrapped in
high level functions (like the molecule readers and writers) are also
available directly to the user at the low level. For instance,
:oe:func:`OEChem::OEWritePDBFile` allows the user to write out a PDB
file with a very specific flavor without any normalization that
:oe:func:`OEChem::OEWriteMolecule` may perform.

**OEChem TK** is a still a live moving software project. If a roadblock is
found a particular level, dig deeper into the next level. Often, the
functionality is already present.


.. _oechem_part_examples:

********************************
Examples
********************************

.. toctree::
   :maxdepth: 2

   oechem_examples_summary
   oebio_examples_summary
   oemath_examples
   cookbook-examples


.. _chapter_examplesoechem_summary:

********************************************************************************
OEChem Examples
********************************************************************************

The following table lists the currently available **OEChem TK** examples.

.. _section_example_oechem_molecule_processing:

Molecule Processing
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`convert<section_example_oechem_convert>`
        - converting molecule files
      * - :ref:`catmols<section_example_oechem_catmols>`
        - concatenating molecules
      * - :ref:`parts2mols<section_example_oechem_parts2mols>`
        - splitting multicomponent molecules
      * - :ref:`molextract<section_example_oechem_molextract>`
        - extracting molecules by title
      * - :ref:`uniqmol<section_example_oechem_uniqmol>`
        - writing out unique molecules (canonical SMILES)
      * - :ref:`uniqinchi<section_example_oechem_uniqinchi>`
        - writing out unique molecules (InChI)
      * - :ref:`randomizeatoms<section_example_oechem_randomizeatoms>`
        - randomizing atoms of molecules
      * - :ref:`cansmi<section_example_oechem_cansmi>`
        - generating canonical smiles
      * - :ref:`sizefilter<section_example_oechem_sizefilter>`
        - filtering molecules by weight or heavy atom count
      * - :ref:`stripsalts<section_example_oechem_stripsalts>`
        - stripping salt
      * - :ref:`ringsubset<section_example_oechem_ringsubset>`
        - extracting rings
      * - :ref:`extractscaffold<section_example_oechem_extractscaffold>`
        - extracting molecule scaffolds
      * - :ref:`randomsample<section_example_oechem_randomsample>`
        - extracting random molecule subset
      * - :ref:`molchunk<section_example_oechem_molchunk>`
        - split molecule file into N chunks or chunks of size N  

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`convert.py<section_example_oechem_convert>`
        - converting molecule files
      * - :ref:`catmols.py<section_example_oechem_catmols>`
        - concatenating molecules
      * - :ref:`parts2mols.py<section_example_oechem_parts2mols>`
        - splitting multicomponent molecules
      * - :ref:`molextract.py<section_example_oechem_molextract>`
        - extracting molecules by title
      * - :ref:`uniqmol.py<section_example_oechem_uniqmol>`
        - writing out unique molecules (canonical SMILES)
      * - :ref:`uniqinchi.py<section_example_oechem_uniqinchi>`
        - writing out unique molecules (InChI)
      * - :ref:`randomizeatoms.py<section_example_oechem_randomizeatoms>`
        - randomizing atoms of molecules
      * - :ref:`cansmi.py<section_example_oechem_cansmi>`
        - generating canonical smiles
      * - :ref:`sizefilter.py<section_example_oechem_sizefilter>`
        - filtering molecules by weight or heavy atom count
      * - :ref:`stripsalts.py<section_example_oechem_stripsalts>`
        - stripping salt
      * - :ref:`ringsubset.py<section_example_oechem_ringsubset>`
        - extracting rings
      * - :ref:`extractscaffold.py<section_example_oechem_extractscaffold>`
        - extracting molecule scaffolds
      * - :ref:`randomsample.py<section_example_oechem_randomsample>`
        - extracting random molecule subset
      * - :ref:`molchunk.py<section_example_oechem_molchunk>`
        - split molecule file into N chunks or chunks of size N

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`Convert<section_example_oechem_convert>`
        - converting molecule files
      * - :ref:`CatMols<section_example_oechem_catmols>`
        - concatenating molecules
      * - :ref:`Parts2Mols<section_example_oechem_parts2mols>`
        - splitting multicomponent molecules
      * - :ref:`MolExtract<section_example_oechem_molextract>`
        - extracting molecules by title
      * - :ref:`UniqMol<section_example_oechem_uniqmol>`
        - writing out unique molecules (canonical SMILES)
      * - :ref:`UniqInchi<section_example_oechem_uniqinchi>`
        - writing out unique molecules (InChI)
      * - :ref:`RandomizeAtoms<section_example_oechem_randomizeatoms>`
        - randomizing atoms of molecules
      * - :ref:`CanSmi<section_example_oechem_cansmi>`
        - generating canonical smiles
      * - :ref:`SizeFilter<section_example_oechem_sizefilter>`
        - filtering molecules by weight or heavy atom count
      * - :ref:`StripSalts<section_example_oechem_stripsalts>`
        - stripping salt
      * - :ref:`RingSubset<section_example_oechem_ringsubset>`
        - extracting rings
      * - :ref:`ExtractScaffold<section_example_oechem_extractscaffold>`
        - extracting molecule scaffolds
      * - :ref:`RandomSample<section_example_oechem_randomsample>`
        - extracting random molecule subset
      * - :ref:`MolChunk<section_example_oechem_molchunk>`
        - split molecule file into N chunks or chunks of size N

.. _section_example_oechem_reactions:

Reactions
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`unimolrxn<section_example_oechem_unimolrxn>`
        - performing a reaction
      * - :ref:`libgen<section_example_oechem_libgen>`
        - generating a library

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`applytransform.py<section_example_oechem_applytransform>`
        - use a SMIRKS specification to perform individual reaction transformations on single molecules
      * - :ref:`applytransformiter.py<section_example_oechem_applytransformiter>`
        - use a SMIRKS specification to perform individual reaction transformations on each input molecule
      * - :ref:`unimolrxn.py<section_example_oechem_unimolrxn>`
        - perform a reaction
      * - :ref:`libgen.py<section_example_oechem_libgen>`
        - generate a library

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`UniMolRxn<section_example_oechem_unimolrxn>`
        - performing a reaction
      * - :ref:`LibGen<section_example_oechem_libgen>`
        - generating a library

.. _section_example_oechem_molecule_searching:

Molecule Searching
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`molgrep<section_example_oechem_molgrep>`
        - performing substructure search
      * - :ref:`makefastss<section_example_oechem_makefastss>`
        - generating database for fast substructure search
      * - :ref:`searchfastss<section_example_oechem_searchfastss>`
        - performing search on substructure database file

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`molgrep.py<section_example_oechem_molgrep>`
        - performing substructure search
      * - :ref:`makefastss.py<section_example_oechem_makefastss>`
        - generating database for fast substructure search
      * - :ref:`searchfastss.py<section_example_oechem_searchfastss>`
        - performing search on substructure database file

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`MolGrep<section_example_oechem_molgrep>`
        - performing substructure search

.. _section_example_oechem_molecule_alignment:

Molecule Alignment
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`mcs3dalign<section_example_oechem_mcs3dalign>`
        - aligning molecules by maximum common substructure
      * - :ref:`cliquealign<section_example_oechem_cliquealign>`
        - aligning molecules by clique match
      * - :ref:`smartsalign<section_example_oechem_smartsalign>`
        - aligning molecules by SMARTS match
      * - :ref:`rmsd<section_example_oechem_rmsd>`
        - aligning multiconformer molecules

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`mcs3dalign.py<section_example_oechem_mcs3dalign>`
        - aligning molecules by maximum common substructure
      * - :ref:`cliquealign.py<section_example_oechem_cliquealign>`
        - aligning molecules by clique match
      * - :ref:`smartsalign.py<section_example_oechem_smartsalign>`
        - aligning molecules by SMARTS match
      * - :ref:`rmsd.py<section_example_oechem_rmsd>`
        - aligning multiconformer molecules

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`MCS3DAlign<section_example_oechem_mcs3dalign>`
        - aligning molecules by maximum common substructure
      * - :ref:`CliqueAlign<section_example_oechem_cliquealign>`
        - aligning molecules by clique match
      * - :ref:`SMARTSAlign<section_example_oechem_smartsalign>`
        - aligning molecules by SMARTS match
      * - :ref:`RMSD<section_example_oechem_rmsd>`
        - aligning multiconformer molecules

.. _section_example_oechem_sdf_specific:

SDF Specific
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`sdfmodprops<section_example_oechem_sdfmodprops>`
        - modifying SD tags
      * - :ref:`sdf2csv<section_example_oechem_sdf2csv>`
        - exporting SD data to a CSV file
      * - :ref:`csv2sdf<section_example_oechem_csv2sdf>`
        - adding CSV data as SD tags
      * - :ref:`sdfrename<section_example_oechem_sdfrename>`
        - renaming molecules by SD field
      * - :ref:`sdfilter<section_example_oechem_sdfilter>`
        - filtering molecules by SD data

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`sdfmodprops.py<section_example_oechem_sdfmodprops>`
        - modifying SD tags
      * - :ref:`sdf2csv.py<section_example_oechem_sdf2csv>`
        - exporting SD data to a CSV file
      * - :ref:`csv2sdf.py<section_example_oechem_csv2sdf>`
        - adding CSV data as SD tags
      * - :ref:`sdfrename.py<section_example_oechem_sdfrename>`
        - renaming molecules by SD field
      * - :ref:`sdfilter.py<section_example_oechem_sdfilter>`
        - filtering molecules by SD data

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`SDFModProps<section_example_oechem_sdfmodprops>`
        - modifying SD tags
      * - :ref:`SDF2CSV<section_example_oechem_sdf2csv>`
        - exporting SD data to a CSV file
      * - :ref:`CSV2SDF<section_example_oechem_CSV2SDF>`
        - adding CSV data as SD tags
      * - :ref:`sdfrename<section_example_oechem_sdfrename>`
        - renaming molecules by SD field
      * - :ref:`sdfilter<section_example_oechem_sdfilter>`
        - filtering molecules by SD data

Molecule Information Examples
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`molcount<section_example_oechem_molcount>`
        - counting molecules
      * - :ref:`gettitles<section_example_oechem_gettitles>`
        - getting molecule titles
      * - :ref:`molstats<section_example_oechem_molstats>`
        - printing simple molecule information
      * - :ref:`rotorcount<section_example_oechem_rotorcount>`
        - printing rotor count distribution
      * - :ref:`minpath<section_example_oechem_minpath>`
        - finding minimum path in a molecule
      * - :ref:`printatomnames<section_example_oechem_printatomnames>`
        - printing molecule atom names

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`molcount.py<section_example_oechem_molcount>`
        - counting molecules
      * - :ref:`gettitles.py<section_example_oechem_gettitles>`
        - get molecule titles
      * - :ref:`molstats.py<section_example_oechem_molstats>`
        - printing simple molecule information
      * - :ref:`rotorcount.py<section_example_oechem_rotorcount>`
        - printing rotor count distribution
      * - :ref:`minpath.py<section_example_oechem_minpath>`
        - finding minimum path in a molecule
      * - :ref:`printatomnames.py<section_example_oechem_printatomnames>`
        - printing molecule atom names

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`MolCount<section_example_oechem_molcount>`
        - counting molecules
      * - :ref:`GetTitles<section_example_oechem_gettitles>`
        - get molecule titles
      * - :ref:`MolStats<section_example_oechem_molstats>`
        - printing simple molecule information
      * - :ref:`RotorCount<section_example_oechem_rotorcount>`
        - printing rotor count distribution
      * - :ref:`MinPath<section_example_oechem_minpath>`
        - finding minimum path in a molecule
      * - :ref:`PrintAtomNames<section_example_oechem_printatomnames>`
        - printing molecule atom names

.. _section_example_oechem_2D_coordinate_generation:

2D Coordinate Generation Examples
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`extractringtemplates<section_example_oechem_extractringtemplates>`
        - extracting 2D ring templates
      * - :ref:`createringdict<section_example_oechem_createringdict>`
        - creating 2D ring dictionary
      * - :ref:`appendringdict<section_example_oechem_appendringdict>`
        - appending 2D ring dictionary
      * - :ref:`generate2D<section_example_oechem_generate2D>`
        - generating 2D coordinates

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`extractringtemplates.py<section_example_oechem_extractringtemplates>`
        - extracting 2D ring templates
      * - :ref:`createringdict.py<section_example_oechem_createringdict>`
        - creating 2D ring dictionary
      * - :ref:`appendringdict.py<section_example_oechem_appendringdict>`
        - appending 2D ring dictionary
      * - :ref:`generate2D.py<section_example_oechem_generate2D>`
        - generating 2D coordinates

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`ExtractRingTemplates<section_example_oechem_extractringtemplates>`
        - extracting 2D ring templates
      * - :ref:`CreateRingDict<section_example_oechem_createringdict>`
        - creating 2D ring dictionary
      * - :ref:`AppendRingDict<section_example_oechem_appendringdict>`
        - appending 2D ring dictionary
      * - :ref:`Generate2D<section_example_oechem_generate2D>`
        - generating 2D coordinates

3D Molecule Styling Examples
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`basicStyle<section_example_oechem_basicmolstyle>`
        - applies a basic :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` to molecules 
      * - :ref:`bFactorStyle<section_example_oechem_bFactorStyle>`
        - applies an :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` that focuses on B-Factor to molecules
      * - :ref:`styleHierarchy<section_oechem_example_stylehierarchy>`
        - applies multiple :ref:`OE3DMolStyles <OEChem_OE3DMolStyle>` to molecules, displaying the hierarchy between the different :ref:`OE3DMolStyles <OEChem_OE3DMolStyle>` applied to the molecule, conformers, and atoms

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`basicStyle.py<section_example_oechem_basicmolstyle>`
        - applies a basic :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` to molecules
      * - :ref:`bFactorStyle.py<section_example_oechem_bFactorStyle>`
        - applies an :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` that focuses on B-Factor to molecules
      * - :ref:`styleHierarchy.py<section_oechem_example_stylehierarchy>`
        - applies multiple :ref:`OE3DMolStyles <OEChem_OE3DMolStyle>` to molecules, displaying the hierarchy between the different :ref:`OE3DMolStyles <OEChem_OE3DMolStyle>` applied to the molecule, conformers, and atoms

Miscellaneous Examples
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`oecheminfo<section_example_oechem_oecheminfo>`
        - printing OEChem and format information
      * - :ref:`anisou<section_example_oechem_anisou>`
        - printing anisotropic B-factors
      * - :ref:`dots<section_example_oechem_dots>`
        - printing dots
      * - :ref:`options<section_example_oechem_options>`
        - defining parameters

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`oecheminfo.py<section_example_oechem_oecheminfo>`
        - printing OEChem and format information
      * - :ref:`anisou.py<section_example_oechem_anisou>`
        - printing anisotropic B-factors
      * - :ref:`dots.py<section_example_oechem_dots>`
        - printing dots
      * - :ref:`oecifdata<section_example_oechem_cifdata>`
        - using OECIFData
      * - :ref:`setchemcomp.py<section_example_oechem_setchemcomp>`
        - setting CIF _chem_comp data
      * - :ref:`options<section_example_oechem_options>`
        - defining parameters

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`OEChemInfo<section_example_oechem_oecheminfo>`
        - printing OEChem and format information
      * - :ref:`Anisou<section_example_oechem_anisou>`
        - printing anisotropic B-factors
      * - :ref:`Dots<section_example_oechem_dots>`
        - printing dots
      * - :ref:`Options<section_example_oechem_options>`
        - defining parameters

**Examples**

.. toctree::
   :maxdepth: 1

   oechem_examples/oechem_example_convert
   oechem_examples/oechem_example_catmols
   oechem_examples/oechem_example_parts2mols
   oechem_examples/oechem_example_molextract
   oechem_examples/oechem_example_uniqmol
   oechem_examples/oechem_example_uniqinchi
   oechem_examples/oechem_example_randomizeatoms
   oechem_examples/oechem_example_cansmi
   oechem_examples/oechem_example_sizefilter
   oechem_examples/oechem_example_stripsalts
   oechem_examples/oechem_example_ringsubset
   oechem_examples/oechem_example_extractscaffold
   oechem_examples/oechem_example_randomsample
   oechem_examples/oechem_example_molchunk
   oechem_examples/oechem_example_unimolrxn
   oechem_examples/oechem_example_libgen
   oechem_examples/oechem_example_molgrep
   oechem_examples/oechem_example_makefastss
   oechem_examples/oechem_example_searchfastss
   oechem_examples/oechem_example_mcs3dalign
   oechem_examples/oechem_example_cliquealign
   oechem_examples/oechem_example_smartsalign
   oechem_examples/oechem_example_rmsd
   oechem_examples/oechem_example_sdfmodprops
   oechem_examples/oechem_example_sdf2csv
   oechem_examples/oechem_example_csv2sdf
   oechem_examples/oechem_example_sdfrename
   oechem_examples/oechem_example_sdfilter
   oechem_examples/oechem_example_oecheminfo
   oechem_examples/oechem_example_molcount
   oechem_examples/oechem_example_gettitles
   oechem_examples/oechem_example_molstats
   oechem_examples/oechem_example_rotorcount
   oechem_examples/oechem_example_minpath
   oechem_examples/oechem_example_printatomnames
   oechem_examples/oechem_example_extractringtemplates
   oechem_examples/oechem_example_createringdict
   oechem_examples/oechem_example_appendringdict
   oechem_examples/oechem_example_generate2D
   oechem_examples/oechem_example_anisou
   oechem_examples/oechem_example_dots
   oechem_examples/oechem_example_options
   oechem_examples/oechem_example_basicmolstyle
   oechem_examples/oechem_example_bfactorSty
   oechem_examples/oechem_example_stylehierarchy
   oechem_examples/oechem_example_cifdata
   oechem_examples/oechem_example_setchemcomp

.. _section_example_oechem_convert:

Convert molecule files
================================================================================

A program that converts molecules from one format to another based on
the file extension. 

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> convert input.mol2 output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> convert.py input.mol2 output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> Convert input.mol2 output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> Convert input.mol2 output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`convert.cpp <../../../../../sublibs/tklibs/oechem/examples/convert.cpp>`

   .. only:: oepdf

      .. oe:source:: convert.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`convert.py <../../../../../wrappers/python/examples/oechem/convert.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/convert.py

   .. only:: oepdf

      .. oe:source:: convert.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Convert.java <../../../../../wrappers/java/examples/openeye/examples/oechem/Convert.java>`

   .. only:: oepdf

      .. oe:source:: Convert.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Convert.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/Convert.cs>`

   .. only:: oepdf

      .. oe:source:: Convert.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OEReadMolecule` function
   * :oe:func:`OEChem::OEWriteMolecule` function


.. _section_example_oechem_catmols:

Concatenating molecules
================================================================================

A program that takes an input molecule file (or files) and
concatenates all the molecules into a single molecule file.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> catmols -i file1.oeb.gz file2.oeb.gz -o output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> catmols.py -i file1.oeb.gz file2.oeb.gz -o output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> CatMols -i file1.oeb.gz file2.oeb.gz -o output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> CatMols -i file1.oeb.gz file2.oeb.gz -o output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`catmols.cpp <../../../../../sublibs/tklibs/oechem/examples/catmols.cpp>`

   .. only:: oepdf

      .. oe:source:: catmols.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`catmols.py <../../../../../wrappers/python/examples/oechem/catmols.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/catmols.py

   .. only:: oepdf

      .. oe:source:: catmols.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CatMols.java <../../../../../wrappers/java/examples/openeye/examples/oechem/CatMols.java>`

   .. only:: oepdf

      .. oe:source:: CatMols.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CatMols.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/CatMols.cs>`

   .. only:: oepdf

      .. oe:source:: CatMols.cs
         :language: csharp

.. seealso::

  * :oe:func:`OEChem::OEAddMols` function
  * :oe:meth:`OESystem::OEInterface::GetList` method


.. _section_example_oechem_parts2mols:

Splitting multicomponent molecules
================================================================================

A program that splits multicomponent molecules into their constituent
parts. The program will output the molecules to stdout as SMILES if no
output file is set.  The program will print the number of input and
output molecules to stderr.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> parts2mols file1.oeb.gz output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> parts2mols.py inputfile1.oeb.gz output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> Parts2Mols inputfile1.oeb.gz output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> Parts2Mols inputfile1.oeb.gz output.oeb.gz

If the output-file argument is omitted, the output is written to standard output.

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`parts2mols.cpp <../../../../../sublibs/tklibs/oechem/examples/parts2mols.cpp>`

   .. only:: oepdf

      .. oe:source:: parts2mols.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`parts2mols.py <../../../../../wrappers/python/examples/oechem/parts2mols.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/parts2mols.py

   .. only:: oepdf

      .. oe:source:: parts2mols.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Parts2Mols.java <../../../../../wrappers/java/examples/openeye/examples/oechem/Parts2Mols.java>`

   .. only:: oepdf

      .. oe:source:: Parts2Mols.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Parts2Mols.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/Parts2Mols.cs>`

   .. only:: oepdf

      .. oe:source:: Parts2Mols.cs
         :language: csharp

.. seealso::

   * :ref:`section_ring_system_components` section
   * :oe:func:`OEChem::OEDetermineComponents` function
   * :oe:func:`OEChem::OESubsetMol` function


.. _section_example_oechem_molextract:

Extract molecules by title
================================================================================

A program that extracts molecules from a file based on their
title. The program can take as input either a specific title or a file
containing a list of titles.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> molextract -title Mol0001 -i dbase.oeb.gz -o Mol0001.oeb.gz
      prompt> molextract -list names.txt dbase.oeb.gz output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> molextract.py -title Mol0001 -i dbase.oeb.gz -o Mol0001.oeb.gz
      prompt> molextract.py -list names.txt dbase.oeb.gz output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> MolExtract -title Mol0001 -i dbase.oeb.gz -o Mol0001.oeb.gz
      prompt> MolExtract -list names.txt dbase.oeb.gz output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolExtract -title Mol0001 -i dbase.oeb.gz -o Mol0001.oeb.gz
      prompt> MolExtract -list names.txt dbase.oeb.gz output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molextract.cpp <../../../../../sublibs/tklibs/oechem/examples/molextract.cpp>`

   .. only:: oepdf

      .. oe:source:: molextract.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molextract.py <../../../../../wrappers/python/examples/oechem/molextract.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/molextract.py

   .. only:: oepdf

      .. oe:source:: molextract.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolExtract.java <../../../../../wrappers/java/examples/openeye/examples/oechem/MolExtract.java>`

   .. only:: oepdf

      .. oe:source:: MolExtract.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolExtract.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/MolExtract.cs>`

   .. only:: oepdf

      .. oe:source:: MolExtract.cs
         :language: csharp

.. seealso::

   * :oe:meth:`OEChem::OEMolBase::GetTitle` method


.. _section_example_oechem_uniqmol:

Write out unique molecules (canonical SMILES)
================================================================================

A program that loads a database of molecules and outputs those that
are unique. Uniqueness is defined by whether they have the same
canonical isomeric SMILES.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> uniqmol dbase.oeb.gz output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> uniqmol.py dbase.oeb.gz output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> UniqMol dbase.oeb.gz output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> UniqMol dbase.oeb.gz output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`uniqmol.cpp <../../../../../sublibs/tklibs/oechem/examples/uniqmol.cpp>`

   .. only:: oepdf

      .. oe:source:: uniqmol.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`uniqmol.py <../../../../../wrappers/python/examples/oechem/uniqmol.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/uniqmol.py

   .. only:: oepdf

      .. oe:source:: uniqmol.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`UniqMol.java <../../../../../wrappers/java/examples/openeye/examples/oechem/UniqMol.java>`

   .. only:: oepdf

      .. oe:source:: UniqMol.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`UniqMol.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/UniqMol.cs>`

   .. only:: oepdf

      .. oe:source:: UniqMol.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OECreateIsoSmiString` function
   * :ref:`section_example_oechem_uniqinchi` section


.. _section_example_oechem_uniqinchi:

Write out unique molecules (InChI)
================================================================================

A program that loads a database of molecules and outputs those that
are unique. Uniqueness is defined by whether they have the same
standard InChI.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> uniqinchi dbase.oeb.gz output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> uniqinchi.py dbase.oeb.gz output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> UniqInChI dbase.oeb.gz output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> UniqInChI dbase.oeb.gz output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`uniqinchi.cpp <../../../../../sublibs/tklibs/oechem/examples/uniqinchi.cpp>`

   .. only:: oepdf

      .. oe:source:: uniqinchi.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`uniqinchi.py <../../../../../wrappers/python/examples/oechem/uniqinchi.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/uniqinchi.py

   .. only:: oepdf

      .. oe:source:: uniqinchi.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`UniqInChI.java <../../../../../wrappers/java/examples/openeye/examples/oechem/UniqInChI.java>`

   .. only:: oepdf

      .. oe:source:: UniqInChI.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`UniqInChI.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/UniqInChI.cs>`

   .. only:: oepdf

      .. oe:source:: UniqInChI.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OECreateInChI` function
   * :ref:`section_example_oechem_uniqmol` section


.. _section_example_oechem_randomizeatoms:

Randomize atoms of molecules
================================================================================

A program that randomizes the order of the atoms within the molecule file. The
structure of the molecule is not changed.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> randomizeatoms dbase.oeb.gz output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> randomizeatoms.py dbase.oeb.gz output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> RandomizeAtoms dbase.oeb.gz output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> RandomizeAtoms dbase.oeb.gz output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`randomizeatoms.cpp <../../../../../sublibs/tklibs/oechem/examples/randomizeatoms.cpp>`

   .. only:: oepdf

      .. oe:source:: randomizeatoms.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`randomizeatoms.py <../../../../../wrappers/python/examples/oechem/randomizeatoms.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/randomizeatoms.py

   .. only:: oepdf

      .. oe:source:: randomizeatoms.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RandomizeAtoms.java <../../../../../wrappers/java/examples/openeye/examples/oechem/RandomizeAtoms.java>`

   .. only:: oepdf

      .. oe:source:: RandomizeAtoms.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RandomizeAtoms.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/RandomizeAtoms.cs>`

   .. only:: oepdf

      .. oe:source:: RandomizeAtoms.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OEScrambleMolecule` function


.. _section_example_oechem_cansmi:

Generate canonical SMILES
================================================================================

A program that generates the canonical SMILES of the molecules in the
input file. It has a number of options such as ``-from3d``, which
perceives stereo from the 3D coordinates, ``-isomeric``, which
produces the canonical isomeric SMILES, and ``-kekule``, which
produces the Kekulé SMILES form.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> cansmi dbase.oeb.gz output.smi
      prompt> cansmi -from3d true -i dbase.sdf -o output.smi

.. oe:language:: python

   .. code-block:: console

      prompt> cansmi.py dbase.oeb.gz output.smi
      prompt> cansmi.py  -from3d true -i dbase.sdf -o output.smi

.. oe:language:: java

   .. code-block:: console

      prompt> CanSmi dbase.oeb.gz output.smi
      prompt> CanSmi -from3d true -i dbase.sdf -o output.smi

.. oe:language:: csharp

   .. code-block:: console

      prompt> CanSmi dbase.oeb.gz output.smi
      prompt> CanSmi -from3d -i dbase.sdf -o output.smi

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`cansmi.cpp <../../../../../sublibs/tklibs/oechem/examples/cansmi.cpp>`

   .. only:: oepdf

      .. oe:source:: cansmi.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`cansmi.py <../../../../../wrappers/python/examples/oechem/cansmi.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/cansmi.py

   .. only:: oepdf

      .. oe:source:: cansmi.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CanSmi.java <../../../../../wrappers/java/examples/openeye/examples/oechem/CanSmi.java>`

   .. only:: oepdf

      .. oe:source:: CanSmi.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CanSmi.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/CanSmi.cs>`

   .. only:: oepdf

      .. oe:source:: CanSmi.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OEFindRingAtomsAndBonds` function
   * :oe:func:`OEChem::OEAssignAromaticFlags` function
   * :oe:func:`OEChem::OEKekulize` function
   * :oe:func:`OEChem::OECanonicalOrderAtoms` function
   * :oe:func:`OEChem::OECanonicalOrderBonds` function


.. _section_example_oechem_sizefilter:

Filter molecules by weight or heavy atom count
================================================================================

A program that filters molecules by their weight and/or heavy atom
count. The program has four flags: ``-minhac``, the minimum heavy atom
count, ``-maxhac``, the maximum heavy atom count, ``-minwt``, the
minimum molecular weight and ``-maxwt`` the maximum molecular
weight. Any combination of the flags can be set. The program will
output the molecules to stdout as SMILES if no output file is set.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> sizefilter -minhac 10 dbase.oeb.gz
      prompt> sizefilter -minhac 10 -maxwt 300 -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> sizefilter.py -minhac 10 dbase.oeb.gz
      prompt> sizefilter.py -minhac 10 -maxwt 300 -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> SizeFilter -minhac 10 dbase.oeb.gz
      prompt> SizeFilter -minhac 10 -maxwt 300 -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> SizeFilter -minhac 10 dbase.oeb.gz
      prompt> SizeFilter -minhac 10 -maxwt 300 -i dbase.oeb.gz -o output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sizefilter.cpp <../../../../../sublibs/tklibs/oechem/examples/sizefilter.cpp>`

   .. only:: oepdf

      .. oe:source:: sizefilter.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sizefilter.py <../../../../../wrappers/python/examples/oechem/sizefilter.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/sizefilter.py

   .. only:: oepdf

      .. oe:source:: sizefilter.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SizeFilter.java <../../../../../wrappers/java/examples/openeye/examples/oechem/SizeFilter.java>`

   .. only:: oepdf

      .. oe:source:: SizeFilter.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SizeFilter.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/SizeFilter.cs>`

   .. only:: oepdf

      .. oe:source:: SizeFilter.cs
         :language: csharp

.. seealso::

   * :ref:`OEIsHeavy <OEChem_OEIsHeavy>` functor
   * :oe:func:`OEChem::OECalculateMolecularWeight` function


.. _section_example_oechem_stripsalts:

Strip salts
================================================================================

A program that removes all but the largest molecule from molecules
that contain more than one part. If the molecule contains two or more
parts that are equal in size it keeps the larger.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> stripsalts dbase.oeb.gz output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> stripsalts.py dbase.oeb.gz output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> StripSalts dbase.oeb.gz output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> StripSalts dbase.oeb.gz output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`stripsalts.cpp <../../../../../sublibs/tklibs/oechem/examples/stripsalts.cpp>`

   .. only:: oepdf

      .. oe:source:: stripsalts.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`stripsalts.py <../../../../../wrappers/python/examples/oechem/stripsalts.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/stripsalts.py

   .. only:: oepdf

      .. oe:source:: stripsalts.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`StripSalts.java <../../../../../wrappers/java/examples/openeye/examples/oechem/StripSalts.java>`

   .. only:: oepdf

      .. oe:source:: StripSalts.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`StripSalts.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/StripSalts.cs>`

   .. only:: oepdf

      .. oe:source:: StripSalts.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OETheFunctionFormerlyKnownAsStripSalts` function


.. _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


.. _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


.. _section_example_oechem_randomsample:

Extract random molecule subset
================================================================================

A program that extracts a randomized subset of molecules from a
molecule file. The program has two flags, ``-p``, extract a percentage
of the database, or ``-n``, extract a specific number from the
database. If neither flag is set then the whole database will be
randomized.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> randomsample -n 1000 dbase.oeb.gz output.oeb.gz
      prompt> randomsample -p 10 -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> randomsample.py -n 1000 dbase.oeb.gz output.oeb.gz
      prompt> randomsample.py -p 10 -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> RandomSample -n 1000 dbase.oeb.gz output.oeb.gz
      prompt> RandomSample -p 10 -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> RandomSample -n 1000 dbase.oeb.gz output.oeb.gz
      prompt> RandomSample -p 10 -i dbase.oeb.gz -o output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`randomsample.cpp <../../../../../sublibs/tklibs/oechem/examples/randomsample.cpp>`

   .. only:: oepdf

      .. oe:source:: randomsample.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`randomsample.py <../../../../../wrappers/python/examples/oechem/randomsample.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/randomsample.py

   .. only:: oepdf

      .. oe:source:: randomsample.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RandomSample.java <../../../../../wrappers/java/examples/openeye/examples/oechem/RandomSample.java>`

   .. only:: oepdf

      .. oe:source:: RandomSample.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RandomSample.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/RandomSample.cs>`

   .. only:: oepdf

      .. oe:source:: RandomSample.cs
         :language: csharp

.. seealso::

   * :oe:meth:`OEChem::OEMolBase::Compress` method
   * :oe:meth:`OEChem::OEMolBase::UnCompress` method
   * `Manipulating Large Molecule Files <https://docs.eyesopen.com/toolkits/cookbook/python/cheminfo/moldb.html>`_ recipe in Python cookbook.


.. _section_example_oechem_molchunk:

Split molecule file
================================================================================

A program that splits molecule file into N chunks or chunks of size N. Number of 
chunks (``-num``) or the size of each chunk (``-size``) must be specified and are 
mutually exclusive. By default the program splits molecule file by number of 
conformers not molecules. This can be changed by setting the flag ``-confs`` to 
false.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> molchunk -num 3 -i drugs.sdf -o foo.sdf
      prompt> molchunk -confs false -size 20 -i conftest.sdf -o foo.sdf

.. oe:language:: python

   .. code-block:: console

      prompt> molchunk.py -num 3 -i drugs.sdf -o foo.sdf
      prompt> molchunk.py -confs false -size 20 -i conftest.sdf -o foo.sdf

.. oe:language:: java

   .. code-block:: console

      prompt> MolChunk -num 3 -i drugs.sdf -o foo.sdf
      prompt> MolChunk -confs false -size 20 -i conftest.sdf -o foo.sdf

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolChunk -num 3 -i drugs.sdf -o foo.sdf
      prompt> MolChunk -confs false -size 20 -i conftest.sdf -o foo.sdf

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molchunk.cpp <../../../../../sublibs/tklibs/oechem/examples/molchunk.cpp>`

   .. only:: oepdf

      .. oe:source:: molchunk.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molchunk.py <../../../../../wrappers/python/examples/oechem/molchunk.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/molchunk.py

   .. only:: oepdf

      .. oe:source:: molchunk.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolChunk.java <../../../../../wrappers/java/examples/openeye/examples/oechem/MolChunk.java>`

   .. only:: oepdf

      .. oe:source:: MolChunk.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolChunk.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/MolChunk.cs>`

   .. only:: oepdf

      .. oe:source:: MolChunk.cs
         :language: csharp

.. seealso::

   * :ref:`OEIsomericConfTest <OEChem_OEIsomericConfTest>` class


.. _section_example_oechem_unimolrxn:

Performing a reaction
================================================================================

A program that uses a SMIRKS to perform reactions on single
molecules. The OpenEye OEUniMolecularRxn class is designed to react
every instance of the reactant pattern in the input molecules and so
is useful for normalization reactions.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> unimolrxn '[NH2:1]>>[Nh3+:1]' dbase.oeb.gz output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> unimolrxn.py '[NH2:1]>>[Nh3+:1]' dbase.oeb.gz output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> UniMolRxn '[NH2:1]>>[Nh3+:1]' dbase.oeb.gz output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> UniMolRxn '[NH2:1]>>[Nh3+:1]' dbase.oeb.gz output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`unimolrxn.cpp <../../../../../sublibs/tklibs/oechem/examples/unimolrxn.cpp>`

   .. only:: oepdf

      .. oe:source:: unimolrxn.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`unimolrxn.py <../../../../../wrappers/python/examples/oechem/unimolrxn.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/unimolrxn.py

   .. only:: oepdf

      .. oe:source:: unimolrxn.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`UniMolRxn.java <../../../../../wrappers/java/examples/openeye/examples/oechem/UniMolRxn.java>`

   .. only:: oepdf

      .. oe:source:: UniMolRxn.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`UniMolRxn.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/UniMolRxn.cs>`

   .. only:: oepdf

      .. oe:source:: UniMolRxn.cs
         :language: csharp

.. seealso::

   * :oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>` class
   * :ref:`section_example_oechem_libgen` section


.. _section_example_oechem_libgen:

Library generation
================================================================================

A program that uses a SMIRKS string or an MDL reaction file to perform
reactions on input molecules. The program has a number of
flags. OELibraryGen options are: ``-implicitH``, performs the reaction
with implicit hydrogens (default ``false``), ``-relax``, ensures
unmapped atoms on the reactant side are not deleted during reaction
(default ``false``), ``-valence``, applies automatic valence
correction (default ``false``). SMILES generation options are:
``-isomeric``, includes atom and bond stereochemistry in the output
(default ``false``), ``-unique``, only include unique product
canonical SMILES (default ``false``). Input and output options are:
``-reactants``, a molecule file, or files, of reactants, ``-smirks``,
a SMIRKS string of the reaction or ``-rxn``, an MDL reaction file of
the reaction, and optionally, ``-product``, the output molecule
file. The program will output the molecules to stdout as SMILES if no
output file is set.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt > libgen -smirks '[C:1]c1c([N:2])cccc1>>[C:1]c1cc([N:2])ccc1' -reactants input.smi
      prompt > libgen -rxn reaction.rxn -reactants input.smi -product output.smi -valence -isomeric

.. oe:language:: python

   .. code-block:: console

      prompt > libgen.py -smirks '[C:1]c1c([N:2])cccc1>>[C:1]c1cc([N:2])ccc1' -reactants input.smi
      prompt > libgen.py -rxn reaction.rxn -reactants input.smi -product output.smi -valence -isomeric

.. oe:language:: java

   .. code-block:: console

      prompt > LibGen -smirks '[C:1]c1c([N:2])cccc1>>[C:1]c1cc([N:2])ccc1' -reactants input.smi
      prompt > LibGen -rxn reaction.rxn -reactants input.smi -product output.smi -valence -isomeric

.. oe:language:: csharp

   .. code-block:: console

      prompt > LibGen -smirks '[C:1]c1c([N:2])cccc1>>[C:1]c1cc([N:2])ccc1' -reactants input.smi
      prompt > LibGen -rxn reaction.rxn -reactants input.smi -product output.smi -valence -isomeric

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`libgen.cpp <../../../../../sublibs/tklibs/oechem/examples/libgen.cpp>`

   .. only:: oepdf

      .. oe:source:: libgen.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`libgen.py <../../../../../wrappers/python/examples/oechem/libgen.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/libgen.py

   .. only:: oepdf

      .. oe:source:: libgen.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`LibGen.java <../../../../../wrappers/java/examples/openeye/examples/oechem/LibGen.java>`

   .. only:: oepdf

      .. oe:source:: LibGen.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`LibGen.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/LibGen.cs>`

   .. only:: oepdf

      .. oe:source:: LibGen.cs
         :language: csharp

.. seealso::

   * :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` class
   * :oe:func:`OEChem::OEParseSmirks` function
   * :oe:func:`OEReadMDLReactionQueryFile<OEChem::OEReadMDLReactionQueryFile>` function


.. _section_example_oechem_molgrep:

Perform substructure searches
================================================================================

A program that searches a molecule file using a SMARTS pattern. Flags
include: ``-c``, count the number of matches, ``-o``, output the
matches to a file, ``-p``, the SMARTS pattern to use, ``-r``, do the
reverse search ``i.e.`` all molecules that don't match the
SMARTS.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> molgrep -p 'c1ccccc1' -c dbase.oeb.gz
      prompt> molgrep -r -p 'c1ccccc1' -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> molgrep.py -p 'c1ccccc1' -c dbase.oeb.gz
      prompt> molgrep.py -r -p 'c1ccccc1' -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> MolGrep -p 'c1ccccc1' -c dbase.oeb.gz
      prompt> MolGrep -r -p 'c1ccccc1' -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolGrep -p 'c1ccccc1' -c dbase.oeb.gz
      prompt> MolGrep -r -p 'c1ccccc1' -i dbase.oeb.gz -o output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molgrep.cpp <../../../../../sublibs/tklibs/oechem/examples/molgrep.cpp>`

   .. only:: oepdf

      .. oe:source:: molgrep.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molgrep.py <../../../../../wrappers/python/examples/oechem/molgrep.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/oechem/molgrep.py

   .. only:: oepdf

      .. oe:source:: molgrep.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolGrep.java <../../../../../wrappers/java/examples/openeye/examples/oechem/MolGrep.java>`

   .. only:: oepdf

      .. oe:source:: MolGrep.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolGrep.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/MolGrep.cs>`

   .. only:: oepdf

      .. oe:source:: MolGrep.cs
         :language: csharp

.. seealso::

   * :ref:`OESubSearch <OEChem_OESubSearch>` class
   * :oe:meth:`OEChem::OESubSearch::SingleMatch` method
   * :oe:func:`OEChem::OEPrepareSearch` function


.. _section_example_oechem_makefastss:

Generate database for fast substructure search
================================================================================

A program that generates a binary file for fast substructure search.
For more explanation, see :oe:func:`OEChem::OECreateSubSearchDatabaseFile` function.

.. figure:: oechemtk/images/FastSSGeneration.*
   :width: 350 pt
   :align: center

   **Schematic representation of substructure search database file generation process**

.. admonition:: Code Example

   * :ref:`section_example_oechem_searchfastss` example

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> makefastss --help

.. oe:language:: python

   .. code-block:: console

      prompt> python makefastss.py --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    input/output options
      -in : Input molecule filename
      -out : Output substructure database filename

    other options
      -keep-title : Whether to keep the title of the molecule as unique
                    identifier
      -nrthreads : Number of processors used (zero means all available)
      -screentype : Screen type generated
      -sort : Whether to sort the molecules based on their screen bit counts.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> makefastss -in dataset.ism -out ss-search-dataset-SMARTS.oeb -stype SMARTS

.. oe:language:: python

   .. code-block:: console

      prompt> makefastss.py -in dataset.ism -out sss-search-dataset-SMARTS.oeb -stype SMARTS

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`makefastss.cpp <../../../../../sublibs/tklibs/oechem/examples/makefastss.cpp>`

   .. only:: oepdf

      .. oe:source:: makefastss.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`makefastss.py <../../../../../wrappers/python/examples/oechem/makefastss.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/makefastss.py

   .. only:: oepdf

      .. oe:source:: makefastss.py
         :language: python

.. seealso::

   * :ref:`OECreateSubSearchDatabaseOptions <OEChem_OECreateSubSearchDatabaseOptions>` class
   * :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>` class
   * :ref:`OEConsoleProgressTracer <OESystem_OEConsoleProgressTracer>` class
   * :oe:func:`OEChem::OEGetSubSearchScreenType` function
   * :oe:func:`OEChem::OECreateSubSearchDatabaseFile` function
   * :oe:func:`OEChem::OECreateSubSearchDatabaseOptions` function


.. _section_example_oechem_searchfastss:

Perform SMARTS search on substructure database file
================================================================================

A program that searches substructure search database using a :term:`SMARTS` pattern.
For more explanation, see :oe:func:`OEChem::OESubSearchDatabase` class.

.. figure:: oechemtk/images/FastSSSearch.*
   :width: 350 pt
   :align: center

   **Schematic representation of using substructure search database**

.. admonition:: Code Example

   * :ref:`section_example_oechem_makefastss` example

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> searchfastss --help

.. oe:language:: python

   .. code-block:: console

      prompt> python searchfastss.py --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    input/output options
      -database : Input substructure search database filename
      -smarts : SMARTS pattern, quote for safety

    other options
      -maxmatches : The maximum number of matches returned in case of parameters
                    (-titles) and (-out)
      -nrthreads : Number of processors used (zero means all available)

    search types
      -count : Output count of number matched
      -out : Output molecule filename of matches
      -titles : Output title of matches

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> searchfastss -db ss-search-dataset-SMARTS.oeb -s "C1CC[O,N]CC1" -out matches.ism
      prompt> searchfastss -db ss-search-dataset-SMARTS.oeb -s "C1CC[O,N]CC1" -count
      prompt> searchfastss -db ss-search-dataset-SMARTS.oeb -s "C1CC[O,N]CC1" -titles

.. oe:language:: python

   .. code-block:: console

      prompt> searchfastss.py -db ss-search-dataset-SMARTS.oeb -s "C1CC[O,N]CC1" -out matches.ism
      prompt> searchfastss.py -db ss-search-dataset-SMARTS.oeb -s "C1CC[O,N]CC1" -count
      prompt> searchfastss.py -dbss-search-dataset-SMARTS.oeb -s "C1CC[O,N]CC1"  -titles

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`searchfastss.cpp <../../../../../sublibs/tklibs/oechem/examples/searchfastss.cpp>`

   .. only:: oepdf

      .. oe:source:: searchfastss.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`searchfastss.py <../../../../../wrappers/python/examples/oechem/searchfastss.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/searchfastss.py

   .. only:: oepdf

      .. oe:source:: searchfastss.py
         :language: python

.. seealso::

   * :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` class
   * :ref:`OESubSearchQuery <OEChem_OESubSearchQuery>` class
   * :ref:`OESubSearchResult <OEChem_OESubSearchResult>` class
   * :ref:`OEConsoleProgressTracer <OESystem_OEConsoleProgressTracer>` class
   * :oe:func:`OEChem::OEGetSubSearchScreenType` function
   * :oe:func:`OEChem::OEIsValidSubSearchDatabase` function
   * :oe:func:`OEChem::OESubSearchStatusToName` function


.. _section_example_oechem_mcs3dalign:

Align molecules by maximum common substructure
================================================================================

A program that aligns a database of molecules with a reference
molecule based on the maximum common substructure (MCS) between the
reference and each query. The output file consists of the input
reference molecule and then each aligned database molecule.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt > mcs3dalign ligand.pdb dbase.oeb.gz output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt > mcs3dalign.py ligand.pdb dbase.oeb.gz output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt > MCS3DAlign ligand.pdb dbase.oeb.gz output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt > MCS3DAlign ligand.pdb dbase.oeb.gz output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mcs3dalign.cpp <../../../../../sublibs/tklibs/oechem/examples/mcs3dalign.cpp>`

   .. only:: oepdf

      .. oe:source:: mcs3dalign.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mcs3dalign.py <../../../../../wrappers/python/examples/oechem/mcs3dalign.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/mcs3dalign.py

   .. only:: oepdf

      .. oe:source:: mcs3dalign.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MCS3DAlign.java <../../../../../wrappers/java/examples/openeye/examples/oechem/MCS3DAlign.java>`

   .. only:: oepdf

      .. oe:source:: MCS3DAlign.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MCS3DAlign.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/MCS3DAlign.cs>`

   .. only:: oepdf

      .. oe:source:: MCS3DAlign.cs
         :language: csharp

.. seealso::

   * :ref:`OEMCSSearch <OEChem_OEMCSSearch>` class
   * :oe:func:`OEChem::OERotate` function
   * :oe:func:`OEChem::OETranslate` function


.. _section_example_oechem_cliquealign:

Align molecules by clique match
================================================================================

A program that aligns a database of molecules with a reference
molecule based on the clique of matches between the reference and each
query. Clique detection is the process of finding all possible
correspondences between two graphs within a set of bounds, the upper
bound being the MCS, and in the this example, the lower bound is up to
five atoms different to the MCS.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt > cliquealign ligand.pdb dbase.oeb.gz output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt > cliquealign.py ligand.pdb dbase.oeb.gz output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt > CliqueAlign ligand.pdb dbase.oeb.gz output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt > CliqueAlign ligand.pdb dbase.oeb.gz output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`cliquealign.cpp <../../../../../sublibs/tklibs/oechem/examples/cliquealign.cpp>`

   .. only:: oepdf

      .. oe:source:: cliquealign.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`cliquealign.py <../../../../../wrappers/python/examples/oechem/cliquealign.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/cliquealign.py

   .. only:: oepdf

      .. oe:source:: cliquealign.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CliqueAlign.java <../../../../../wrappers/java/examples/openeye/examples/oechem/CliqueAlign.java>`

   .. only:: oepdf

      .. oe:source:: CliqueAlign.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CliqueAlign.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/CliqueAlign.cs>`

   .. only:: oepdf

      .. oe:source:: CliqueAlign.cs
         :language: csharp

.. seealso::

   * :ref:`OECliqueSearch <OEChem_OECliqueSearch>` class
   * :oe:func:`OEChem::OERMSD` function
   * :oe:func:`OEChem::OEWriteConstMolecule` function
   * :oe:func:`OEChem::OESuppressHydrogens` function


.. _section_example_oechem_smartsalign:

Align molecules by SMARTS match
================================================================================

A program that aligns a database of molecules with a reference
molecule based on the SMARTS matches between the reference and each
query.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt > smartsalign ligand.pdb dbase.oeb.gz output.oeb.gz 'a1aaaa1NC'

.. oe:language:: python

   .. code-block:: console

      prompt > smartsalign.py ligand.pdb dbase.oeb.gz output.oeb.gz 'a1aaaa1NC'

.. oe:language:: java

   .. code-block:: console

      prompt > SMARTSAlign ligand.pdb dbase.oeb.gz output.oeb.gz 'a1aaaa1NC'

.. oe:language:: csharp

   .. code-block:: console

      prompt > SMARTSAlign ligand.pdb dbase.oeb.gz output.oeb.gz 'a1aaaa1NC'

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`smartsalign.cpp <../../../../../sublibs/tklibs/oechem/examples/smartsalign.cpp>`

   .. only:: oepdf

      .. oe:source:: smartsalign.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`smartsalign.py <../../../../../wrappers/python/examples/oechem/smartsalign.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/smartsalign.py

   .. only:: oepdf

      .. oe:source:: smartsalign.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SMARTSAlign.java <../../../../../wrappers/java/examples/openeye/examples/oechem/SMARTSAlign.java>`

   .. only:: oepdf

      .. oe:source:: SMARTSAlign.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SMARTSAlign.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/SMARTSAlign.cs>`

   .. only:: oepdf

      .. oe:source:: SMARTSAlign.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OERMSD` function
   * :oe:meth:`OEChem::OEMatch::AddPair` method
   * :oe:func:`OEChem::OEIs3DFormat` function
   * :oe:func:`OEChem::OEPrepareSearch` function


.. _section_example_oechem_rmsd:

Align multi-conformer molecules
================================================================================

A program that performs RMSD calculation between a 3D reference molecule
and multi-conformation molecules.

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`rmsd.cpp <../../../../../sublibs/tklibs/oechem/examples/rmsd.cpp>`

   .. only:: oepdf

      .. oe:source:: rmsd.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`rmsd.py <../../../../../wrappers/python/examples/oechem/rmsd.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/rmsd.py

   .. only:: oepdf

      .. oe:source:: rmsd.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RMSD.java <../../../../../wrappers/java/examples/openeye/examples/oechem/RMSD.java>`

   .. only:: oepdf

      .. oe:source:: RMSD.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RMSD.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/RMSD.cs>`

   .. only:: oepdf

      .. oe:source:: RMSD.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OERMSD` function
   * :oe:func:`OEChem::OERotate` function
   * :oe:func:`OEChem::OETranslate` function


.. _section_example_oechem_sdfmodprops:

Modifying SD tags
================================================================================

A program that can modify the SD tags on an SD molecule. The flags
are: ``-remove``, a list of property tags to be removed (non-matching
tags are kept), ``-keep```, a list of property tags to be kept
(non-matching tags are removed), ``-clearAll``, all SD tags are
removed. The program formats are limited to those that can have SD
data ``i.e.`` SDF, OEB, and CSV.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt > sdfmodprops -keep NAME ID_NUM -i dbase.sdf -o output.sdf
      prompt > sdfmodprops -clearAll -i dbase.sdf -o output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt > sdfmodprops.py -keep NAME ID_NUM -i dbase.sdf -o output.sdf
      prompt > sdfmodprops.py -clearAll -i dbase.sdf -o output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt > SDFModProps -keep NAME ID_NUM -i dbase.sdf -o output.sdf
      prompt > SDFModProps -clearAll -i dbase.sdf -o output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt > SDFModProps -keep NAME ID_NUM -i dbase.sdf -o output.sdf
      prompt > SDFModProps -clearAll -i dbase.sdf -o output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sdfmodprops.cpp <../../../../../sublibs/tklibs/oechem/examples/sdfmodprops.cpp>`

   .. only:: oepdf

      .. oe:source:: sdfmodprops.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sdfmodprops.py <../../../../../wrappers/python/examples/oechem/sdfmodprops.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/sdfmodprops.py

   .. only:: oepdf

      .. oe:source:: sdfmodprops.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SDFModProps.java <../../../../../wrappers/java/examples/openeye/examples/oechem/SDFModProps.java>`

   .. only:: oepdf

      .. oe:source:: SDFModProps.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SDFModProps.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/SDFModProps.cs>`

   .. only:: oepdf

      .. oe:source:: SDFModProps.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OEDeleteSDData` function
   * :oe:func:`OEChem::OEClearSDData` function


.. _section_example_oechem_sdf2csv:

Exporting SD data to a CSV file
================================================================================

A program that converts the tags on an SD file to CSV format. The
output has on the first line the molecule title, followed by all the
unique tags found in the input database.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt > sdf2csv input.sdf output.csv

.. oe:language:: python

   .. code-block:: console

      prompt > sdf2csv.py input.sdf output.csv

.. oe:language:: java

   .. code-block:: console

      prompt > SDF2CSV input.sdf output.csv

.. oe:language:: csharp

   .. code-block:: console

      prompt > SDF2CSV input.sdf output.csv

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sdf2csv.cpp <../../../../../sublibs/tklibs/oechem/examples/sdf2csv.cpp>`

   .. only:: oepdf

      .. oe:source:: sdf2csv.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sdf2csv.py <../../../../../wrappers/python/examples/oechem/sdf2csv.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/sdf2csv.py

   .. only:: oepdf

      .. oe:source:: sdf2csv.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SDF2CSV.java <../../../../../wrappers/java/examples/openeye/examples/oechem/SDF2CSV.java>`

   .. only:: oepdf

      .. oe:source:: SDF2CSV.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SDF2CSV.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/SDF2CSV.cs>`

   .. only:: oepdf

      .. oe:source:: SDF2CSV.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OEGetSDData` function
   * :oe:func:`OEChem::OEGetSDDataPairs` function


.. _section_example_oechem_csv2sdf:

Adding csv data as SD tags
================================================================================

A program that adds the data in a csv file as SD tags to a database of
molecules. The csv data and molecules are paired by the molecule
title.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt > csv2sdf input.csv output.sdf

.. oe:language:: python

   .. code-block:: console

      prompt > csv2sdf.py input.csv output.sdf

.. oe:language:: java

   .. code-block:: console

      prompt > CSV2SDF input.csv output.sdf

.. oe:language:: csharp

   .. code-block:: console

      prompt > CSV2SDF input.csv output.sdf

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`csv2sdf.cpp <../../../../../sublibs/tklibs/oechem/examples/csv2sdf.cpp>`

   .. only:: oepdf

      .. oe:source:: csv2sdf.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`csv2sdf.py <../../../../../wrappers/python/examples/oechem/csv2sdf.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/csv2sdf.py

   .. only:: oepdf

      .. oe:source:: csv2sdf.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CSV2SDF.java <../../../../../wrappers/java/examples/openeye/examples/oechem/CSV2SDF.java>`

   .. only:: oepdf

      .. oe:source:: CSV2SDF.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CSV2SDF.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/CSV2SDF.cs>`

   .. only:: oepdf

      .. oe:source:: CSV2SDF.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OESetSDData` function
   * :oe:func:`OESystem::OEStringTokenize` function


.. _section_example_oechem_sdfrename:

Renaming molecules by SD field
================================================================================

A program that renames a molecule by a particular SD tag attached to
that molecule.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt > sdfrename ID_NUM input.sdf output.smi

.. oe:language:: python

   .. code-block:: console

      prompt > sdfrename.py ID_NUM input.sdf output.smi

.. oe:language:: java

   .. code-block:: console

      prompt > SDFRename ID_NUM input.sdf output.smi

.. oe:language:: csharp

   .. code-block:: console

      prompt > SDFRename ID_NUM input.sdf output.smi

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sdfrename.cpp <../../../../../sublibs/tklibs/oechem/examples/sdfrename.cpp>`

   .. only:: oepdf

      .. oe:source:: sdfrename.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sdfrename.py <../../../../../wrappers/python/examples/oechem/sdfrename.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/sdfrename.py

   .. only:: oepdf

      .. oe:source:: sdfrename.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SDFRename.java <../../../../../wrappers/java/examples/openeye/examples/oechem/SDFRename.java>`

   .. only:: oepdf

      .. oe:source:: SDFRename.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SDFRename.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/SDFRename.cs>`

   .. only:: oepdf

      .. oe:source:: SDFRename.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OEHasSDData` function
   * :oe:meth:`OEChem::OEMolBase::SetTitle` method


.. _section_example_oechem_sdfilter:

Filter molecules by SD data
================================================================================

A program that can filter a database of molecules based on SD
tags. Any SD tag that contains numerical data can be used. Flags are:
``-tag``, the SD tag to use, ``-min``, the minimum value of the tag,
``-max``, the maximum value of the tag. The program formats are
limited to those that can have SD data ``i.e.`` SDF, OEB, and CSV.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt > sdfilter -tag LOGD -min -2 -max 5 -i input.sdf -o output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt > sdfilter.py -tag LOGD -min -2 -max 5 -i input.sdf -o output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt > SDFilter -tag LOGD -min -2 -max 5 -i input.sdf -o output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt > SDFilter -tag LOGD -min -2 -max 5 -i input.sdf -o output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sdfilter.cpp <../../../../../sublibs/tklibs/oechem/examples/sdfilter.cpp>`

   .. only:: oepdf

      .. oe:source:: sdfilter.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sdfilter.py <../../../../../wrappers/python/examples/oechem/sdfilter.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/sdfilter.py

   .. only:: oepdf

      .. oe:source:: sdfilter.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SDFilter.java <../../../../../wrappers/java/examples/openeye/examples/oechem/SDFilter.java>`

   .. only:: oepdf

      .. oe:source:: SDFilter.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SDFilter.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/SDFilter.cs>`

   .. only:: oepdf

      .. oe:source:: SDFilter.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OEHasSDData` function
   * :oe:func:`OEChem::OEGetSDData` function
   * :oe:func:`OESystem::OEStringToNumber` function



.. _section_example_oechem_oecheminfo:

Print OEChem and file format information
================================================================================

A program that prints the current OEChem version, platform, build
date, and the release name of the overall toolkits being used. It also
prints details of all the molecule file formats supported by the OEChem
toolkit and whether they are readable and/or writable.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> oecheminfo

.. oe:language:: python

   .. code-block:: console

      prompt> oecheminfo.py

.. oe:language:: java

   .. code-block:: console

      prompt> OEChemInfo

.. oe:language:: csharp

   .. code-block:: console

      prompt> OEChemInfo

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`oecheminfo.cpp <../../../../../sublibs/tklibs/oechem/examples/oecheminfo.cpp>`

   .. only:: oepdf

      .. oe:source:: oecheminfo.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`oecheminfo.py <../../../../../wrappers/python/examples/oechem/oecheminfo.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/oecheminfo.py

   .. only:: oepdf

      .. oe:source:: oecheminfo.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`OEChemInfo.java <../../../../../wrappers/java/examples/openeye/examples/oechem/OEChemInfo.java>`

   .. only:: oepdf

      .. oe:source:: OEChemInfo.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`OEChemInfo.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/OEChemInfo.cs>`

   .. only:: oepdf

      .. oe:source:: OEChemInfo.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OEGetFormatString` function
   * :oe:func:`OEChem::OEGetFormatExtension` function
   * :oe:func:`OEChem::OEChemGetRelease` function
   * :oe:func:`OEChem::OEChemGetVersion` function
   * :oe:func:`OEChem::OEChemGetPlatform` function
   * :oe:func:`OEPlatform::OEToolkitsGetRelease` function


.. _section_example_oechem_molcount:

Counting molecules
================================================================================

A program that counts the number of molecules, or the number of
conformers, in an input molecule file, or files. The flag ``-conf`` is
used to count conformers. The output is the total molecules or
conformers per file, and the total sum if more than one file is used
as input. If conformers are counted the average conformer count per
molecule is also output.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> molcount -conf input1.oeb.gz input2.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> molcount.py -conf input1.oeb.gz input2.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> MolCount -conf input1.oeb.gz input2.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolCount -conf input1.oeb.gz input2.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molcount.cpp <../../../../../sublibs/tklibs/oechem/examples/molcount.cpp>`

   .. only:: oepdf

      .. oe:source:: molcount.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molcount.py <../../../../../wrappers/python/examples/oechem/molcount.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/molcount.py

   .. only:: oepdf

      .. oe:source:: molcount.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolCount.java <../../../../../wrappers/java/examples/openeye/examples/oechem/MolCount.java>`

   .. only:: oepdf

      .. oe:source:: MolCount.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolCount.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/MolCount.cs>`

   .. only:: oepdf

      .. oe:source:: MolCount.cs
         :language: csharp



.. _section_example_oechem_gettitles:

Get molecule titles
================================================================================

A program that prints the molecule titles found in an input molecule
database.  The program will output the titles to stdout if no output
file is set. Molecules with no title are shown as "untitled".

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> gettitles input.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> gettitles.py input.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> GetTitles input.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> GetTitles input.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`gettitles.cpp <../../../../../sublibs/tklibs/oechem/examples/gettitles.cpp>`

   .. only:: oepdf

      .. oe:source:: gettitles.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`gettitles.py <../../../../../wrappers/python/examples/oechem/gettitles.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/gettitles.py

   .. only:: oepdf

      .. oe:source:: gettitles.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`GetTitles.java <../../../../../wrappers/java/examples/openeye/examples/oechem/GetTitles.java>`

   .. only:: oepdf

      .. oe:source:: GetTitles.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`GetTitles.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/GetTitles.cs>`

   .. only:: oepdf

      .. oe:source:: GetTitles.cs
         :language: csharp

.. seealso::

   * :oe:meth:`OEChem::OEMolBase::GetTitle` method



.. _section_example_oechem_molstats:

Print simple molecule information
================================================================================

A program that prints some simple molecule information for a database
of molecules. This includes the title, molecular weight, number of
atoms, number of heavy atoms, number of ring atoms, number of rotors
and number of conformers.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> molstats input.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> molstats.py input.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> MolStats input.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolStats input.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molstats.cpp <../../../../../sublibs/tklibs/oechem/examples/molstats.cpp>`

   .. only:: oepdf

      .. oe:source:: molstats.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molstats.py <../../../../../wrappers/python/examples/oechem/molstats.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/molstats.py

   .. only:: oepdf

      .. oe:source:: molstats.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolStats.java <../../../../../wrappers/java/examples/openeye/examples/oechem/MolStats.java>`

   .. only:: oepdf

      .. oe:source:: MolStats.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolStats.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/MolStats.cs>`

   .. only:: oepdf

      .. oe:source:: MolStats.cs
         :language: csharp

.. seealso::

   * :ref:`OEIsHeavy <OEChem_OEIsHeavy>` functor
   * :ref:`OEIsRotor <OEChem_OEIsRotor>` functor
   * :oe:func:`OEChem::OECalculateMolecularWeight` function


.. _section_example_oechem_rotorcount:

Print rotor count distribution
================================================================================

A program that prints the rotorcount distribution for a database of
molecules. It uses :ref:`OEIsRotor <OEChem_OEIsRotor>` functor to determine
if a bond is freely :term:`rotatable<rotatable bond>`. Use the 
:oe:func:`OEMolProp::OEGetRotatableBondCount` function to get a more precise count 
of rotatable bonds in a molecule.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt > rotorcount input.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt > rotorcount.py input.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt > RotorCount input.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt > RotorCount input.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`rotorcount.cpp <../../../../../sublibs/tklibs/oechem/examples/rotorcount.cpp>`

   .. only:: oepdf

      .. oe:source:: rotorcount.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`rotorcount.py <../../../../../wrappers/python/examples/oechem/rotorcount.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/rotorcount.py

   .. only:: oepdf

      .. oe:source:: rotorcount.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RotorCount.java <../../../../../wrappers/java/examples/openeye/examples/oechem/RotorCount.java>`

   .. only:: oepdf

      .. oe:source:: RotorCount.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RotorCount.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/RotorCount.cs>`

   .. only:: oepdf

      .. oe:source:: RotorCount.cs
         :language: csharp

.. seealso::

   * :ref:`OEIsRotor <OEChem_OEIsRotor>` functor
   * :oe:func:`OEMolProp::OEGetRotatableBondCount` function


.. _section_example_oechem_minpath:

Find minimum path in a molecule
================================================================================

A program that finds and outputs the minimum path in a molecule. The
input can be two specific named atoms or two SMARTS matches. As SMARTS
matches could hit more than one atom this could result in multiple
different paths. To use atom names a helper program, printatomnames,
is provided (see below).  If ``-o`` is set then the atoms in the path
will be output to a molecule file, otherwise just the length of the
path is reported. ``-verbose`` outputs more details on the
path.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> minpath -i input.oeb.gz -atom1 'N1' -atom2 'S1'
      prompt> minpath -i input.oeb.gz -smarts1 'c1cccs1' -smarts2 'OC(=O)C' -o output.smi

.. oe:language:: python

   .. code-block:: console

      prompt> minpath.py -i input.oeb.gz -atom1 'N1' -atom2 'S1'
      prompt> minpath.py -i input.oeb.gz -smarts1 'c1cccs1' -smarts2 'OC(=O)C' -o output.smi

.. oe:language:: java

   .. code-block:: console

      prompt> MinPath -i input.oeb.gz -atom1 'N1' -atom2 'S1'
      prompt> MinPath -i input.oeb.gz -smarts1 'c1cccs1' -smarts2 'OC(=O)C' -o output.smi

.. oe:language:: csharp

   .. code-block:: console

      prompt> MinPath -i input.oeb.gz -atom1 'N1' -atom2 'S1'
      prompt> MinPath -i input.oeb.gz -smarts1 'c1cccs1' -smarts2 'OC(=O)C' -o output.smi

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`minpath.cpp <../../../../../sublibs/tklibs/oechem/examples/minpath.cpp>`

   .. only:: oepdf

      .. oe:source:: minpath.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`minpath.py <../../../../../wrappers/python/examples/oechem/minpath.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/minpath.py

   .. only:: oepdf

      .. oe:source:: minpath.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MinPath.java <../../../../../wrappers/java/examples/openeye/examples/oechem/MinPath.java>`

   .. only:: oepdf

      .. oe:source:: MinPath.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MinPath.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/MinPath.cs>`

   .. only:: oepdf

      .. oe:source:: MinPath.cs
         :language: csharp

.. seealso::

   * :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>` specialized functor `OEIsAtomMember`
   * :oe:func:`OEChem::OEGetPathLength` function
   * :oe:func:`OEChem::OEShortestPath` function
   * :oe:func:`OEChem::OEPrepareSearch` function


.. _section_example_oechem_printatomnames:

Print molecule atom names
================================================================================

A program that prints the Tripos atom names for each atom in a
molecule. Useful for specifying atoms in the minpath example (see
above).

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> printatomnames input.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> printatomnames.py input.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> PrintAtomNames input.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> PrintAtomNames input.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`printatomnames.cpp <../../../../../sublibs/tklibs/oechem/examples/printatomnames.cpp>`

   .. only:: oepdf

      .. oe:source:: printatomnames.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`printatomnames.py <../../../../../wrappers/python/examples/oechem/printatomnames.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/printatomnames.py

   .. only:: oepdf

      .. oe:source:: printatomnames.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`PrintAtomNames.java <../../../../../wrappers/java/examples/openeye/examples/oechem/PrintAtomNames.java>`

   .. only:: oepdf

      .. oe:source:: PrintAtomNames.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`PrintAtomNames.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/PrintAtomNames.cs>`

   .. only:: oepdf

      .. oe:source:: PrintAtomNames.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OETriposAtomNames` function


.. _section_example_oechem_extractringtemplates:

Extract 2D ring templates
================================================================================

A program that extracts anonymized ring systems that can be potential new ring templates
in the **OEChem TK** 2D coordinate generation system.

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`extractringtemplates.cpp <../../../../../sublibs/tklibs/oechem/examples/extractringtemplates.cpp>`

   .. only:: oepdf

      .. oe:source:: extractringtemplates.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`extractringtemplates.py <../../../../../wrappers/python/examples/oechem/extractringtemplates.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/extractringtemplates.py

   .. only:: oepdf

      .. oe:source:: extractringtemplates.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ExtractRingTemplates.java <../../../../../wrappers/java/examples/openeye/examples/oechem/ExtractRingTemplates.java>`

   .. only:: oepdf

      .. oe:source:: ExtractRingTemplates.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ExtractRingTemplates.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/ExtractRingTemplates.cs>`

   .. only:: oepdf

      .. oe:source:: ExtractRingTemplates.cs
         :language: csharp

.. seealso::

   * :ref:`OEExtractRingTemplateOptions <OEChem_OEExtractRingTemplateOptions>` class
   * :oe:func:`OEChem::OEExtractRingTemplates` function


.. _section_example_oechem_createringdict:

Create 2D ring dictionary
================================================================================

A program that creates a dictionary of 2D ring layouts that can be plugged into
the 2D coordinates generation system.

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`createringdict.cpp <../../../../../sublibs/tklibs/oechem/examples/createringdict.cpp>`

   .. only:: oepdf

      .. oe:source:: createringdict.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`createringdict.py <../../../../../wrappers/python/examples/oechem/createringdict.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/createringdict.py

   .. only:: oepdf

      .. oe:source:: createringdict.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateRingDict.java <../../../../../wrappers/java/examples/openeye/examples/oechem/CreateRingDict.java>`

   .. only:: oepdf

      .. oe:source:: CreateRingDict.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateRingDict.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/CreateRingDict.cs>`

   .. only:: oepdf

      .. oe:source:: CreateRingDict.cs
         :language: csharp

.. seealso::

   * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
   * :ref:`OE2DRingDictionaryCreatorOptions <OEChem_OE2DRingDictionaryCreatorOptions>` class
   * :oe:func:`OEChem::OEWrite2DRingDictionary` function


.. _section_example_oechem_appendringdict:

Append 2D ring dictionary
================================================================================

A program that adds new ring layouts to a ring dictionary that can be plugged into
the 2D coordinates generation system.

.. note::

   If a ring template already exists in the dictionary then the new template
   will be ignored *i.e.* currently ring templates can not be overwritten in
   the :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` object.

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`appendringdict.cpp <../../../../../sublibs/tklibs/oechem/examples/appendringdict.cpp>`

   .. only:: oepdf

      .. oe:source:: appendringdict.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`appendringdict.py <../../../../../wrappers/python/examples/oechem/appendringdict.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/appendringdict.py

   .. only:: oepdf

      .. oe:source:: appendringdict.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`AppendRingDict.java <../../../../../wrappers/java/examples/openeye/examples/oechem/AppendRingDict.java>`

   .. only:: oepdf

      .. oe:source:: AppendRingDict.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`AppendRingDict.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/AppendRingDict.cs>`

   .. only:: oepdf

      .. oe:source:: AppendRingDict.cs
         :language: csharp

.. seealso::

   * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
   * :oe:func:`OEChem::OEIsValid2DRingDictionary` function
   * :oe:func:`OEChem::OEWrite2DRingDictionary` function


.. _section_example_oechem_generate2D:

Generate 2D coordinates with user-defined ring templates
================================================================================

A program that generates 2D coordinates with user-defined ring layouts.

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`generate2D.cpp <../../../../../sublibs/tklibs/oechem/examples/generate2D.cpp>`

   .. only:: oepdf

      .. oe:source:: generate2D.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`generate2D.py <../../../../../wrappers/python/examples/oechem/generate2D.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/generate2D.py

   .. only:: oepdf

      .. oe:source:: generate2D.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Generate2D.java <../../../../../wrappers/java/examples/openeye/examples/oechem/Generate2D.java>`

   .. only:: oepdf

      .. oe:source:: Generate2D.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Generate2D.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/Generate2D.cs>`

   .. only:: oepdf

      .. oe:source:: Generate2D.cs
         :language: csharp

.. seealso::

   * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
   * :oe:func:`OEChem::OEWrite2DRingDictionary` function
   * :oe:func:`OEChem::OEInit2DRingDictionary` function


.. _section_example_oechem_anisou:

Print anisotropic B-factors
================================================================================

A program that prints anisotropic B-factors for each atom in a
molecule that has those parameters. Useful for checking a PDB file
for anisotropic B factors.

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`anisou.cpp <../../../../../sublibs/tklibs/oechem/examples/anisou.cpp>`

   .. only:: oepdf

      .. oe:source:: anisou.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`anisou.py <../../../../../wrappers/python/examples/oechem/anisou.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/anisou.py

   .. only:: oepdf

      .. oe:source:: anisou.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Anisou.java <../../../../../wrappers/java/examples/openeye/examples/oechem/Anisou.java>`

   .. only:: oepdf

      .. oe:source:: Anisou.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Anisou.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/Anisou.cs>`

   .. only:: oepdf

      .. oe:source:: Anisou.cs
         :language: csharp

.. seealso::

   * :ref:`OEHasAnisou <OEChem_OEHasAnisou>` class
   * :oe:func:`OEChem::OEGetAnisou` function
   * :oe:func:`OEChem::OESetAnisou` function


.. _section_example_oechem_dots:

Print dots
================================================================================

A program that enables dots to printed to the screen to show the
progress of another example program.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> convert input.mol2 .oeb.gz | dots .oeb.gz output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> convert.py input.mol2 .oeb.gz | dots.py .oeb.gz output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> Convert input.mol2 .oeb.gz | Dots .oeb.gz output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> Convert input.mol2 .oeb.gz | Dots .oeb.gz output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`dots.cpp <../../../../../sublibs/tklibs/oechem/examples/dots.cpp>`

   .. only:: oepdf

      .. oe:source:: dots.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`dots.py <../../../../../wrappers/python/examples/oechem/dots.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/dots.py

   .. only:: oepdf

      .. oe:source:: dots.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Dots.java <../../../../../wrappers/java/examples/openeye/examples/oechem/Dots.java>`

   .. only:: oepdf

      .. oe:source:: Dots.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Dots.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/Dots.cs>`

   .. only:: oepdf

      .. oe:source:: Dots.cs
         :language: csharp

.. seealso::

   * :ref:`OEDots <OESystem_OEDots>` class


.. _section_example_oechem_options:

Define parameters
================================================================================

A program that shows definition of parameters.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> options

.. oe:language:: python

   .. code-block:: console

      prompt> options.py

.. oe:language:: java csharp

   .. note::

     This example uses Preliminary API that currently only available in
     C++ and Python.

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`options.cpp <../../../../../sublibs/tklibs/oechem/examples/options.cpp>`

   .. only:: oepdf

      .. oe:source:: options.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`options.py <../../../../../wrappers/python/examples/oechem/options.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/options.py

   .. only:: oepdf

      .. oe:source:: options.py
         :language: python

.. seealso::

   * :ref:`OEOptions <OESystem_OEOptions>` class


:orphan:

.. _section_example_oechem_applytransform:

Performing a reaction
================================================================================

A program that uses a SMIRKS specification to perform reaction transformations on single molecules.
The :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` class is designed to transform every instance of the reactant pattern
in the input molecules and can be useful for structure normalization activities.

Example
--------------------------------------------------------------------------------

.. oe:language:: python

   .. code-block:: console

      prompt> applytransform.py '[NH2:1]>>[Nh3+:1]' dbase.oeb.gz output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`applytransform.py <../../../../../wrappers/python/examples/oechem/applytransform.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/applytransform.py

   .. only:: oepdf

      .. oe:source:: applytransform.py
         :language: python

.. seealso::

   * :oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>` class
   * :ref:`section_example_oechem_libgen` section


:orphan:

.. _section_example_oechem_applytransformiter:

Performing a reaction
================================================================================

A program that uses a SMIRKS specification to perform individual reaction transformations on each input molecule.
This utility demonstrates how a loop using :oe:func:`OEChem::OEGetUniMolecularRxnIter` would be coded which could
then be augmented to score or choose the "best" transformed product by some user specified criteria if there were
multiple sites where the transformation could occur.

Example
--------------------------------------------------------------------------------

.. oe:language:: python

   .. code-block:: console

      prompt> applytransformiter.py '[NH2:1]>>[Nh3+:1]' dbase.oeb.gz output.oeb.gz

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`applytransformiter.py <../../../../../wrappers/python/examples/oechem/applytransformiter.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/applytransformiter.py

   .. only:: oepdf

      .. oe:source:: applytransformiter.py
         :language: python

.. seealso::

   * :oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>` class
   * :ref:`section_example_oechem_libgen` section


.. _section_example_oechem_basicmolstyle:

Basic example of setting up an OE3DMolStyle on a molecule
================================================================================

A program that is an example for setting an :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` to a :ref:`OEMolBase <OEChem_OEMolBase>`. 
The style being apply will label and color atoms by element. The atoms will be displayed in ball and stick format. The 
protein structures will be displayed as ribbons and colored based off residue. Hydrogen visibility is set to polar, and 
the interaction style is set to Inter molecular hydrogen bonds.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

    .. code-block:: console

        prompt> basicStyle input.mol2 output.oeb.gz

.. oe:language:: python
    
   .. code-block:: console

      prompt> basicStyle.py input.oeb output.oeb

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

    .. only:: oehtml

        .. admonition:: Download code

           :download:`basicStyle.cpp <../../../../../sublibs/tklibs/oechem/examples/basicStyle.cpp>`

    .. only:: oepdf

        .. oe:source:: basicStyle.cpp
            :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`basicStyle.py <../../../../../wrappers/python/examples/oechem/basicStyle.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/basicStyle.py

   .. only:: oepdf

      .. oe:source:: basicStyle.py
         :language: python

.. seealso::

    * :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` class
    * :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>` class

.. _section_example_oechem_bFactorStyle:

OE3DMolStyle focused on B-Factor styling
================================================================================

A program utilized to visualize a :ref:`OEMolBase <OEChem_OEMolBase>` by B-Factor with a :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. 
This example shows all ways to visualize B-Factor from atoms to protein ribbon coloring and atom labeling.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

    .. code-block:: console

        prompt> bFactorStyle input.mol2 output.oeb.gz

.. oe:language:: python
    
   .. code-block:: console

      prompt> bFactorStyle.py input.oeb output.oeb

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

    .. only:: oehtml

        .. admonition:: Download code

           :download:`bFactorStyle.cpp <../../../../../sublibs/tklibs/oechem/examples/bFactorStyle.cpp>`

    .. only:: oepdf

        .. oe:source:: bFactorStyle.cpp
            :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`bFactorStyle.py <../../../../../wrappers/python/examples/oechem/bFactorStyle.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/bFactorStyle.py

   .. only:: oepdf

      .. oe:source:: bFactorStyle.py
         :language: python

.. seealso::

    * :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` class
    * :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>` class

.. _section_example_oechem_cifdata:

Creating an OECIFData Object
--------------------------------------------------------------------------------

In this example, we will use the :oe:cls:`OEChem::OECIFData` to get, add, delete, and set header data for an input
CIF file. We will use the PDB code 5NEV read using the mmCIF format, but any CIF header can be accessed with these APIs.
First, the molecule is read and the OECIFData object is created. This object holds the header data for easy editing.
To save any changes made to the header back onto the molecule, use the
:oe:func:`OEChem::OESetMMCIFChemCompData` function.

Read the data and generate the OECIFData object.

.. oe:source:: cifdata.py
   :language: python
   :frag:     SNIPPET-CIFDATA-READCIF

:ref:`Full listing. <listing-cifdata.py>`

The OECIFData class allows access to all the data in a CIF header, but each CIF header category in a data block
is broken into smaller :oe:cls:`OEChem::OECIFCategory` objects which can be accessed and modified.

.. oe:source:: cifdata.py
   :language: python
   :frag:     SNIPPET-CIFDATA-CATEGORY

:ref:`Full listing. <listing-cifdata.py>`

For more information about OECIFData, OECIFCategory, and the CIF file format, see :ref:`section_moldata_CIF`.

Attribute data is accessed by first specifying the CIF category name, and a specific data value in that category can be
accessed with the attribute. For the following example, the category is '_audit_author.', and the values correlate
with the attribute names.

.. oe:source:: cifdata.py
   :language: python
   :frag:     SNIPPET-CIFDATA-ATTRIBUTES

:ref:`Full listing. <listing-cifdata.py>`

Editing data items can be done using the Set, Add, and Delete OECIFData functions. When specifying a data value
with multiple rows of data (i.e., CIF Loop Data), attribute values on a specific row can be accessed with a
base-0 row index:

.. oe:source:: cifdata.py
   :language: python
   :frag:     SNIPPET-CIFDATA-SETDELETEADD

:ref:`Full listing. <listing-cifdata.py>`

The :oe:cls:`OEChem::OECIFData` object can be used to update or synchronize header data with changes to the
molecule. We can simulate this by first modifying a part of the molecule:

.. oe:source:: cifdata.py
   :language: python
   :frag:     SNIPPET-CIFDATA-MODMOL

:ref:`Full listing. <listing-cifdata.py>`

Updating requires the user to specify which parts of the header are to be updated. This is done using the
:oe:cls:`OEChem::OECIFOptions` class. A more detailed explanation about which data items are affected by perception
can be found in the :ref:`section_moldata_CIF` theory. In the following example, we update the header and check
to make sure that our residue changes from above have been applied to the pertinent header locations.

.. oe:source:: cifdata.py
   :language: python
   :frag:     SNIPPET-CIFDATA-UPDATE

:ref:`Full listing. <listing-cifdata.py>`

* :oe:func:`OEChem::OESetMMCIFChemCompData` function
* :oe:func:`OEChem::OEUpdateMMCIFData` function
* :oe:cls:`OEChem::OECIFData` class
* :oe:cls:`OEChem::OECIFCategory` class


.. _section_example_oechem_setchemcomp:

Setting mmCIF Chemical Component Header
================================================================================

Use the reference molecule to populate or replace a residue's _chem_comp., _chem_comp_atom., and _chem_comp_bond.
header information from the input CIF file.

Example
--------------------------------------------------------------------------------

.. oe:language:: python

   .. code-block:: console

      prompt > setchemcomp.py input.cif reference.odb output.cif

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`setchemcomp.py <../../../../../wrappers/python/examples/oechem/setchemcomp.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/setchemcomp.py

   .. only:: oepdf

      .. oe:source:: setchemcomp.py
         :language: python

.. seealso::

   * :oe:func:`OEChem::OESetMMCIFChemCompData` function
   * :oe:cls:`OEChem::OECIFData` class


.. _section_oechem_example_stylehierarchy:

OE3DMolStyle hierarchy between molecule, conformers, and atoms
================================================================================

A program that shows how the style hierarchy in :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` is inherited between molecules, conformer, and atoms. 
The style applied to the main molecule will be the top level style. The style applied to each conformer will take priority over any overlapping 
style options between the two. The style applied to each atom will take priority over both the conformers and the molecule. The output file will 
have a molecule style of: Wireframe, blue, yellow molecular surface, and no hydrogens. The first conformer will have a style that indludes: CPK, blue, 
yellow molecular surface, and polar hydrogens. The second conformer will have the same style as the molecule. The first atom on the first conformer 
will have a style that includes: Stick, white, no surface, and polar hydrogens. The first atom on the second conformer will have a style that includes: 
Stick, white, no surface, and no hydrogens. The second atom on the first conformer will have a style that includes: CPK, pink, blue molecular surface, and polar H.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

    .. code-block:: console

        prompt> styleHierarchy input.mol2 output.oeb.gz

.. oe:language:: python
    
   .. code-block:: console

      prompt> styleHierarchy.py input.oeb output.oeb

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

    .. only:: oehtml

        .. admonition:: Download code

           :download:`styleHierarchy.cpp <../../../../../sublibs/tklibs/oechem/examples/styleHierarchy.cpp>`

    .. only:: oepdf

        .. oe:source:: styleHierarchy.cpp
            :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`styleHierarchy.py <../../../../../wrappers/python/examples/oechem/styleHierarchy.py>`

      .. literalinclude:: ../../../wrappers/python/examples/oechem/styleHierarchy.py

   .. only:: oepdf

      .. oe:source:: styleHierarchy.py
         :language: python

.. seealso::

    * :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` class
    * :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>` class


.. _chapter_examplesoebio_summary:

********************************************************************************
OEBio Examples
********************************************************************************

The following table lists the currently available **OEBio TK** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`backbone<section_example_oebio_backbone>`
        - extracting protein backbone

      * - :ref:`extract_ligand_oedu.cpp<section_example_oebio_extract_ligand>`
        - extracting ligand from :ref:`OEDesignUnit <OEBio_OEDesignUnit>`

      * - :ref:`reshist<section_example_oebio_reshist>`
        - printing protein amino acids histogram

      * - :ref:`splitmolcomplex<section_example_oebio_splitmolcomplex>`
        - splitting protein complex

      * - :ref:`splitmolcomplexlowlevel<section_example_oebio_splitmolcomplexlowlevel>`
        - splitting protein complex (low level)

      * - :ref:`splitmolcomplexfrags<section_example_oebio_splitmolcomplexfrags>`
        - splitting protein complex into fragments

      * - :ref:`proteinprep<section_example_oebio_proteinprep>`
        - protein prep

      * - :ref:`printinteractions<section_example_oebio_printinteractions>`
        - interaction perception

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`backbone.py<section_example_oebio_backbone>`
        - extracting protein backbone

      * - :ref:`extract_ligand_oedu.py<section_example_oebio_extract_ligand>`
        - extracting ligand from :ref:`OEDesignUnit <OEBio_OEDesignUnit>`

      * - :ref:`reshist.py<section_example_oebio_reshist>`
        - printing protein amino acids histogram

      * - :ref:`splitmolcomplex.py<section_example_oebio_splitmolcomplex>`
        - splitting protein complex

      * - :ref:`splitmolcomplexlowlevel.py<section_example_oebio_splitmolcomplexlowlevel>`
        - splitting protein complex (low level)

      * - :ref:`splitmolcomplexfrags.py<section_example_oebio_splitmolcomplexfrags>`
        - splitting protein complex into fragments

      * - :ref:`proteinprep.py<section_example_oebio_proteinprep>`
        - protein prep

      * - :ref:`printinteractions.py<section_example_oebio_printinteractions>`
        - interaction perception

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`Backbone<section_example_oebio_backbone>`
        - extracting protein backbone

      * - :ref:`ResHist<section_example_oebio_reshist>`
        - printing protein amino acids histogram

      * - :ref:`SplitMolComplex<section_example_oebio_splitmolcomplex>`
        - splitting protein complex

      * - :ref:`SplitMolComplexLowLevel<section_example_oebio_splitmolcomplexlowlevel>`
        - splitting protein complex (low level)

      * - :ref:`SplitMolComplexFrags<section_example_oebio_splitmolcomplexfrags>`
        - splitting protein complex into fragments

      * - :ref:`ProteinPrep<section_example_oebio_proteinprep>`
        - protein prep

      * - :ref:`PrintInteractions<section_example_oebio_printinteractions>`
        - interaction perception

**Examples:**

.. toctree::
  :maxdepth: 1

  oebio_examples/oebio_example_backbone
  oebio_examples/oebio_example_extract_ligand
  oebio_examples/oebio_example_reshist
  oebio_examples/oebio_example_splitmolcomplex
  oebio_examples/oebio_example_splitmolcomplexlowlevel
  oebio_examples/oebio_example_splitmolcomplexfrags
  oebio_examples/oebio_example_proteinprep
  oebio_examples/oebio_example_printinteractions


.. _section_example_oebio_backbone:

Extracting Protein Backbone
================================================================================

A program that extracts the backbone from a protein.
An example command would be:

.. oe:language:: c++

   .. code-block:: console

      prompt> backbone input.pdb output.pdb

.. oe:language:: python

   .. code-block:: console

      prompt> python backbone.py input.pdb output.pdb

.. oe:language:: java

   .. code-block:: console

      prompt> java Backbone input.pdb output.pdb

.. oe:language:: csharp

   .. code-block:: console

      prompt> Backbone input.pdb output.pdb

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`backbone.cpp <../../../../../sublibs/tklibs/bio/examples/backbone.cpp>`

   .. only:: oepdf

      .. oe:source:: backbone.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`backbone.py <../../../../../wrappers/python/examples/bio/backbone.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/bio/backbone.py

   .. only:: oepdf

      .. oe:source:: backbone.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Backbone.java <../../../../../wrappers/java/examples/openeye/examples/oebio/Backbone.java>`

   .. only:: oepdf

      .. oe:source:: Backbone.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Backbone.cs <../../../../../wrappers/csharp/Csharp-Examples/OEBio/Backbone.cs>`

   .. only:: oepdf

      .. oe:source:: Backbone.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OEPerceiveResidues` function
   * :ref:`OEIsBackboneAtom <OEBio_OEIsBackboneAtom>` predicate
   * :oe:func:`OEChem::OESubsetMol` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _section_example_oebio_extract_ligand:

Extracting Ligand from :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
================================================================================

.. oe:language:: python

   A program that extracts the ligand from an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.
   An example command would be:
   
   .. code-block:: console

      prompt> python extract_ligand_oedu.py input.oedb output.sdf

.. oe:language:: c++

   A program that extracts the ligand from an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.
   An example command would be:

   .. code-block:: console

      prompt> extract_ligand_oedu input.oedb output.sdf

.. oe:language:: java

   A program that extracts the ligand from an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.
   See the C++ and python examples.

.. oe:language:: csharp

   A program that extracts the ligand from an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.
   See the C++ and python examples.

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`extract_ligand_oedu.py <../../../../../wrappers/python/examples/bio/extract_ligand_oedu.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/bio/extract_ligand_oedu.py

   .. only:: oepdf

      .. oe:source:: extract_ligand_oedu.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`extract_ligand_oedu.cpp <../../../../../sublibs/tklibs/bio/examples/extract_ligand_oedu.cpp>`

   .. only:: oepdf

      .. oe:source:: extract_ligand_oedu.cpp
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. attention::

         |TWOLANGUAGE|
         See the C++ and python examples.

.. oe:language:: csharp

   .. only:: oehtml

      .. attention::

         |TWOLANGUAGE|
         See the C++ and python examples.

.. oe:language:: c++ python

   .. seealso::

      * :oe:func:`OEBio::OEDesignUnit::HasLigand` predicate


.. _section_example_oebio_reshist:

Printing protein amino acids histograms
================================================================================

A program that prints a histogram of the occurrences of various amino acids in a protein. An example command would be:

.. oe:language:: c++

   .. code-block:: console

      prompt> reshist input.pdb

.. oe:language:: python

   .. code-block:: console

      prompt> python reshist.py input.pdb

.. oe:language:: java

   .. code-block:: console

      prompt> java ResHist input.pdb

.. oe:language:: csharp

   .. code-block:: console

      prompt> ResHist input.pdb

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`reshist.cpp <../../../../../sublibs/tklibs/bio/examples/reshist.cpp>`

   .. only:: oepdf

      .. oe:source:: reshist.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`reshist.py <../../../../../wrappers/python/examples/bio/reshist.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/bio/reshist.py

   .. only:: oepdf

      .. oe:source:: reshist.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ResHist.java <../../../../../wrappers/java/examples/openeye/examples/oebio/ResHist.java>`

   .. only:: oepdf

      .. oe:source:: ResHist.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ResHist.cs <../../../../../wrappers/csharp/Csharp-Examples/OEBio/ResHist.cs>`

   .. only:: oepdf

      .. oe:source:: ResHist.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OEPerceiveResidues` function
   * :ref:`OEHierView <OEBio_OEHierView>` class
   * :ref:`OEHierResidue <OEBio_OEHierResidue>` class
   * :oe:meth:`OEBio::OEHierResidue::GetOEResidue` method


.. _section_example_oebio_splitmolcomplex:

Splitting a Macro-molecular Complex
================================================================================

A program that splits components of a protein structure,
returning separate *ligand, protein-complex, waters,*
and *other* molecules.

An example command that limits the protein-complex output to just
the binding site residues would be:

.. oe:language:: c++

   .. code-block:: console

      prompt> splitmolcomplex -separateresidues input.pdb output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> python splitmolcomplex.py -separateresidues input.pdb output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> SplitMolComplex -separateresidues input.pdb output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> SplitMolComplex -separateresidues input.pdb output.oeb.gz

Help is available for all the supported
:ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` parameters:

.. oe:language:: c++

   .. code-block:: console

      prompt> splitmolcomplex --help all

.. oe:language:: python

   .. code-block:: console

      prompt> python splitmolcomplex.py --help all

.. oe:language:: java

   .. code-block:: console

      prompt> SplitMolComplex --help all

.. oe:language:: csharp

   .. code-block:: console

      prompt> SplitMolComplex --help all

::

   Complete parameter list
    Display options :
      -verbose : If true, return more verbose output

    SplitMolComplex options :
      -bindingsitenum : Select this binding site
      -covalentbondtreatment : Covalent bond treatment
      -covalentligand : Split covalent ligands
      -ligandfilter : Ligand filter category
      -ligandname : Ligand name
      -maxsitedistance : Maximum distance to be associated with the binding site
      -maxsurfacedistance : Maximum distance to be associated with the protein
                            surface
      -modelnum : Select this NMR model number
      -proteinfilter : Protein filter category
      -separateresidues : Separate individual residues before selection
      -surfacewaters : Select surface waters
      -waterfilter : Water filter category

    input/output options :
      -in : Input molecule (usually a pdb file)
      -out : Output molecule (usually an oeb)

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`splitmolcomplex.cpp <../../../../../sublibs/tklibs/bio/examples/splitmolcomplex.cpp>`
         and
         :download:`splitmolcomplex.txt <../../../../../sublibs/tklibs/bio/examples/splitmolcomplex.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: splitmolcomplex.cpp
         :language: c++

      with interface file

      .. oe:source:: splitmolcomplex.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`splitmolcomplex.py <../../../../../wrappers/python/examples/bio/splitmolcomplex.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/bio/splitmolcomplex.py

   .. only:: oepdf

      .. oe:source:: splitmolcomplex.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SplitMolComplex.java <../../../../../wrappers/java/examples/openeye/examples/oebio/SplitMolComplex.java>`
         and
         :download:`SplitMolComplex.txt <../../../../../wrappers/java/examples/openeye/examples/oebio/SplitMolComplex.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: SplitMolComplex.java
         :language: java

      with interface file

      .. oe:source:: SplitMolComplex.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SplitMolComplex.cs <../../../../../wrappers/csharp/Csharp-Examples/OEBio/SplitMolComplex.cs>`

   .. only:: oepdf

      .. oe:source:: SplitMolComplex.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEBio::OESplitMolComplex` function
   * :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` object
   * :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function
   * :oe:func:`OEBio::OESplitMolComplexSetup` function



.. _section_example_oebio_splitmolcomplexlowlevel:

Splitting a Macro-molecular Complex Efficiently and Flexibly
================================================================================

A program that splits components of a protein structure,
returning separate *ligand, protein-complex, waters,*
and *other* molecules. This version uses the low-level API to fragment
and then combine selected components.

An example command that limits the protein-complex output to just
the binding site residues would be:

.. oe:language:: c++

   .. code-block:: console

      prompt> splitmolcomplexlowlevel -separateresidues input.pdb output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> python splitmolcomplexlowlevel.py -separateresidues input.pdb output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> SplitMolComplexLowLevel -separateresidues input.pdb output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> SplitMolComplexLowLevel -separateresidues input.pdb output.oeb.gz

Help is available for all the supported
:ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` parameters:

.. oe:language:: c++

   .. code-block:: console

      prompt> splitmolcomplexlowlevel --help all

.. oe:language:: python

   .. code-block:: console

      prompt> python splitmolcomplexlowlevel.py --help all

.. oe:language:: java

   .. code-block:: console

      prompt> SplitMolComplexLowLevel --help all

.. oe:language:: csharp

   .. code-block:: console

      prompt> SplitMolComplexLowLevel --help all

::

   splitmolcomplexlowlevel <inmol> [<outmol>]
   Complete parameter list
       Display options :
         -verbose : If true, show molecule titles and number of binding sites

       SplitMolComplex options :
         -bindingsitenum : Select this binding site
         -covalentbondtreatment : Covalent bond treatment
         -covalentcofactor : Split covalent cofactors
         -covalentligand : Split covalent ligands
         -ligandfilter : Ligand filter category
         -ligandname : Ligand name
         -maxsitedistance : Maximum distance to be associated with the binding site
         -maxsurfacedistance : Maximum distance to be associated with the protein
                               surface
         -modelnum : Select this NMR model number
         -proteinfilter : Protein filter category
         -separateresidues : Separate individual residues before selection
         -surfacewaters : Select surface waters
         -waterfilter : Water filter category

       input/output options :
         -in : Input molecule (usually a pdb file)
         -out : Output molecule (usually an oeb)

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`splitmolcomplexlowlevel.cpp <../../../../../sublibs/tklibs/bio/examples/splitmolcomplexlowlevel.cpp>`
         and
         :download:`splitmolcomplexlowlevel.txt <../../../../../sublibs/tklibs/bio/examples/splitmolcomplexlowlevel.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: splitmolcomplexlowlevel.cpp
         :language: c++

      with interface file

      .. oe:source:: splitmolcomplexlowlevel.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`splitmolcomplexlowlevel.py <../../../../../wrappers/python/examples/bio/splitmolcomplexlowlevel.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/bio/splitmolcomplexlowlevel.py

   .. only:: oepdf

      .. oe:source:: splitmolcomplexlowlevel.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SplitMolComplexLowLevel.java <../../../../../wrappers/java/examples/openeye/examples/oebio/SplitMolComplexLowLevel.java>`
         and
         :download:`SplitMolComplexLowLevel.txt <../../../../../wrappers/java/examples/openeye/examples/oebio/SplitMolComplexLowLevel.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: SplitMolComplexLowLevel.java
         :language: java

      with interface file

      .. oe:source:: SplitMolComplexLowLevel.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SplitMolComplexLowLevel.cs <../../../../../wrappers/csharp/Csharp-Examples/OEBio/SplitMolComplexLowLevel.cs>`

   .. only:: oepdf

      .. oe:source:: SplitMolComplexLowLevel.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEBio::OEGetMolComplexFragments` function
   * :oe:func:`OEBio::OECombineMolComplexFragments` function
   * :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` object
   * :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function
   * :oe:func:`OEBio::OESplitMolComplexSetup` function


.. _section_example_oebio_splitmolcomplexfrags:

Split a Macro-molecular Complex Into Fragments
================================================================================

A program that extracts and filters components of a protein structure,
returning individual fragments.

An example command that returns just the ligands for all binding sites would be:

.. oe:language:: c++

   .. code-block:: console

      prompt> splitmolcomplexfrags -waterfilter nothing -proteinfilter nothing -bindingsitenum 0 input.pdb output.sdf

.. oe:language:: python

   .. code-block:: console

      prompt> python splitmolcomplexfrags.py -waterfilter nothing -proteinfilter nothing -bindingsitenum 0 input.pdb output.sdf

.. oe:language:: java

   .. code-block:: console

      prompt> SplitMolComplexFrags -waterfilter nothing -proteinfilter nothing -bindingsitenum 0 input.pdb output.sdf

.. oe:language:: csharp

   .. code-block:: console

      prompt> SplitMolComplexFrags -waterfilter nothing -proteinfilter nothing -bindingsitenum 0 input.pdb output.sdf

Help is available for all the supported
:ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` parameters:

.. oe:language:: c++

   .. code-block:: console

      prompt> splitmolcomplexfrags --help all

.. oe:language:: python

   .. code-block:: console

      prompt> python splitmolcomplexfrags.py --help all

.. oe:language:: java

   .. code-block:: console

      prompt> SplitMolComplexFrags --help all

.. oe:language:: csharp

   .. code-block:: console

      prompt> SplitMolComplexFrags --help all

::

   Complete parameter list
    Display options :
      -verbose : If true, return more verbose output

    SplitMolComplex options :
      -bindingsitenum : Select this binding site
      -covalentbondtreatment : Covalent bond treatment
      -covalentligand : Split covalent ligands
      -ligandfilter : Ligand filter category
      -ligandname : Ligand name
      -maxsitedistance : Maximum distance to be associated with the binding site
      -maxsurfacedistance : Maximum distance to be associated with the protein
                            surface
      -modelnum : Select this NMR model number
      -proteinfilter : Protein filter category
      -separateresidues : Separate individual residues before selection
      -surfacewaters : Select surface waters
      -waterfilter : Water filter category

    input/output options :
      -in : Input molecule (usually a pdb file)
      -out : Output molecule (usually an oeb)

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`splitmolcomplexfrags.cpp <../../../../../sublibs/tklibs/bio/examples/splitmolcomplexfrags.cpp>`
         and
         :download:`splitmolcomplexfrags.txt <../../../../../sublibs/tklibs/bio/examples/splitmolcomplexfrags.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: splitmolcomplexfrags.cpp
         :language: c++

      with interface file

      .. oe:source:: splitmolcomplexfrags.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`splitmolcomplexfrags.py <../../../../../wrappers/python/examples/bio/splitmolcomplexfrags.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/bio/splitmolcomplexfrags.py

   .. only:: oepdf

      .. oe:source:: splitmolcomplexfrags.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SplitMolComplexFrags.java <../../../../../wrappers/java/examples/openeye/examples/oebio/SplitMolComplexFrags.java>`
         and
         :download:`SplitMolComplexFrags.txt <../../../../../wrappers/java/examples/openeye/examples/oebio/SplitMolComplexFrags.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: SplitMolComplexFrags.java
         :language: java

      with interface file

      .. oe:source:: SplitMolComplexFrags.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SplitMolComplexFrags.cs <../../../../../wrappers/csharp/Csharp-Examples/OEBio/SplitMolComplexFrags.cs>`

   .. only:: oepdf

      .. oe:source:: SplitMolComplexFrags.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEBio::OEGetMolComplexComponents` function
   * :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` object
   * :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function
   * :oe:func:`OEBio::OESplitMolComplexSetup` function


.. _section_example_oebio_proteinprep:

Preparing a Protein
================================================================================

A program that selects the highest occupancy alternate locations of a protein,
adds hydrogens in orientations that make appropriate hydrogen bonds,
and splits out the complex for the selected binding site (optionally separating
the ligand from the protein complex). This is an initial prototype of a
"protein prep" workflow.

An example command that splits out the ligand and limits water sampling
is as follows:

.. oe:language:: c++

   .. code-block:: console

      prompt> proteinprep -waterprocessing ignore input.pdb prot.oeb.gz lig.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> python proteinprep.py -waterprocessing ignore input.pdb prot.oeb.gz lig.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> ProteinPrep -waterprocessing ignore input.pdb prot.oeb.gz lig.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> ProteinPrep -waterprocessing ignore input.pdb prot.oeb.gz lig.oeb.gz

Help is available for all the supported parameters:

.. oe:language:: c++

   .. code-block:: console

       prompt> proteinprep --help all

.. oe:language:: python

   .. code-block:: console

      prompt> python proteinprep.py --help all

.. oe:language:: java

   .. code-block:: console

      prompt> ProteinPrep --help all

.. oe:language:: csharp

   .. code-block:: console

      prompt> ProteinPrep --help all

::

   proteinprep [-options] <inmol> [<outcplx> [<outlig>]]
   Complete parameter list
       SplitMolComplex options :
         -bindingsitenum : Select this binding site
         -covalentligand : Split covalent ligands
         -ligandfilter : Ligand filter category
         -ligandname : Ligand name
         -maxsitedistance : Maximum distance to be associated with the binding site
         -maxsurfacedistance : Maximum distance to be associated with the protein
                               surface
         -modelnum : Select this NMR model number
         -proteinfilter : Protein filter category
         -separateresidues : Separate individual residues before selection
         -surfacewaters : Select surface waters
         -waterfilter : Water filter category

       input/output options :
         -in : Input molecule filename (must have 3D coordinates)
         -cplxout : Output complex filename
         -ligout : Output ligand filename

       Calculation options :
         -alts : Alternate location atom handling (affects atom:atom interactions)
         -placehydrogens : If false, hydrogens will not be added
         -waterprocessing : How waters are processed (can greatly affect runtime)
         -standardizehyd : If false, bonds for hydrogens are not adjusted to standard
                         lengths
         -clashcutoff : Van der Waals overlap (in Angstroms) defined to be a bad
                        clash
         -flipbias : Scale factor for the bias against flipping sidechains such as
                     HIS

       Display options :
         -verbose : Display more information about the process

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`proteinprep.cpp <../../../../../sublibs/tklibs/bio/examples/proteinprep.cpp>`
         and
         :download:`proteinprep.txt <../../../../../sublibs/tklibs/bio/examples/proteinprep.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: proteinprep.cpp
         :language: c++

      with interface file

      .. oe:source:: proteinprep.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`proteinprep.py <../../../../../wrappers/python/examples/bio/proteinprep.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/bio/proteinprep.py

   .. only:: oepdf

      .. oe:source:: proteinprep.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ProteinPrep.java <../../../../../wrappers/java/examples/openeye/examples/oebio/ProteinPrep.java>`
         and
         :download:`ProteinPrep.txt <../../../../../wrappers/java/examples/openeye/examples/oebio/ProteinPrep.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: ProteinPrep.java
         :language: java

      with interface file

      .. oe:source:: ProteinPrep.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ProteinPrep.cs <../../../../../wrappers/csharp/Csharp-Examples/OEBio/ProteinPrep.cs>`

   .. only:: oepdf

      .. oe:source:: ProteinPrep.cs
         :language: csharp

.. seealso::

   * :ref:`chapter_protein_prep` section
   * :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>` object
   * :oe:const:`OEChem::OEIFlavor::PDB::ALTLOC` flavor
   * :oe:func:`OEBio::OEGetMolComplexFragments` function
   * :oe:func:`OEBio::OECombineMolComplexFragments` function
   * :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` object
   * :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` function
   * :oe:func:`OEBio::OESplitMolComplexSetup` function
   * :oe:func:`OEBio::OEPlaceHydrogens` function
   * :ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>` object
   * :ref:`OEPlaceHydrogensDetails <OEBio_OEPlaceHydrogensDetails>` object


.. _section_example_oebio_printinteractions:

Perceive and Print Protein-Ligand Interactions
================================================================================

The program that perceives protein-ligand interactions and prints them out.

An example command would be:

.. oe:language:: c++

   .. code-block:: console

      prompt> printinteractions complex.pdb

.. oe:language:: python

   .. code-block:: console

      prompt> printinteractions.py complex.pdb

.. oe:language:: java

   .. code-block:: console

      prompt> PrintInteractions complex.pdb

.. oe:language:: csharp

   .. code-block:: console

      prompt> PrintInteractions complex.pdb

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`printinteractions.cpp <../../../../../sublibs/tklibs/bio/examples/printinteractions.cpp>`

   .. only:: oepdf

      .. oe:source:: printinteractions.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`printinteractions.py <../../../../../wrappers/python/examples/bio/printinteractions.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/bio/printinteractions.py

   .. only:: oepdf

      .. oe:source:: printinteractions.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`PrintInteractions.java <../../../../../wrappers/java/examples/openeye/examples/oebio/PrintInteractions.java>`

   .. only:: oepdf

      .. oe:source:: PrintInteractions.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`PrintInteractions.cs <../../../../../wrappers/csharp/Csharp-Examples/OEBio/PrintInteractions.cs>`

   .. only:: oepdf

      .. oe:source:: PrintInteractions.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEBio::OESplitMolComplex` function
   * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class
   * :oe:func:`OEBio::OEGetActiveSiteInteractionHintTypes` function
   * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` and
     :ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>` classes
   * :oe:func:`OEBio::OEIsValidActiveSite` function
   * :oe:func:`OEBio::OEPerceiveInteractionHints` function
   * :oe:func:`OEBio::OEGetResidues` function
   * :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>` and
     :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>` classes
   * :ref:`OEHasResidueInteractionHint <OEBio_OEHasResidueInteractionHint>` and
     :ref:`OEHasInteractionHint <OEBio_OEHasInteractionHint>` predicate classes


.. _chapter_oemath_sexamples:

********************************************************************************
OEMath Examples
********************************************************************************

The following table lists the currently available **OEMath** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`docking<section_examples_kpls>`
        - Fitting model with kernel PLS

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`docking<section_examples_kpls>`
        - Fitting model with kernel PLS

.. _section_examples_kpls:

Fitting model with kernel PLS
--------------------------------------------------------------------------------

The following code example shows how to fit a kernel PLS model.
The input descriptors matrix must be symmetric for fitting
with kernel PLS.

.. seealso::

   * :ref:`OEKernelPLS <OEMath_OEKernelPLS>` class

.. oe:source:: kpls.cpp
   :language: c++
   :caption:  Fitting model with kernel PLS
   :refnum:   1

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`kpls.cpp <../../../../sublibs/tklibs/oechem/examples/kpls.cpp>`

.. oe:source:: kpls.py
   :language: python
   :caption:  Fitting model with kernel PLS
   :refnum:   1

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`kpls.py <../../../../wrappers/python/examples/oechem/kpls.py>`



.. _chapter_genericdata:

********************************************************************************
Generic Data
********************************************************************************

Previous chapters :ref:`chapter_molproperties`, :ref:`chapter_atomproperties`,
:ref:`chapter_bondproperties` have described how common global properties 
of molecule, atoms, and bonds can be modified and accessed.
There are applications, however, when associating arbitrary
data with objects such as molecules, atoms and bonds is necessary.
**OEChem TK** provides a framework to solve this problem by allowing to attach
**generic data** to an object by association either with an integer or
character string, called **tag** identifier.

The following two snippets demonstrate how generic data (for example
molecule weight) can be attached to a molecule:

.. oe:source:: GenericData.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SET-DATA-INTEGER

.. oe:source:: GenericData.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SET-DATA-STRING

.. oe:source:: GenericData.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SET-DATA-INTEGER

.. oe:source:: GenericData.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SET-DATA-STRING

.. oe:source:: GenericData.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SET-DATA-INTEGER

.. oe:source:: GenericData.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SET-DATA-STRING

.. oe:source:: GenericData.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SET-DATA-INTEGER

.. oe:source:: GenericData.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SET-DATA-STRING

After annotation, the data can be accessed with the same integer or character string
identifier:

.. oe:source:: GenericData.py
  :language: python
  :noindent:
  :frag:     SNIPPET-GET-DATA-INTEGER

.. oe:source:: GenericData.py
  :language: python
  :noindent:
  :frag:     SNIPPET-GET-DATA-STRING

.. oe:source:: GenericData.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-GET-DATA-INTEGER

.. oe:source:: GenericData.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-GET-DATA-STRING

.. oe:source:: GenericData.java
   :language: java
   :noindent:
   :frag:     SNIPPET-GET-DATA-INTEGER

.. oe:source:: GenericData.java
   :language: java
   :noindent:
   :frag:     SNIPPET-GET-DATA-STRING

.. oe:source:: GenericData.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-GET-DATA-INTEGER

.. oe:source:: GenericData.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-GET-DATA-STRING

.. warning::

   The integer tag of a generic data should always be allocated
   using the :oe:func:`OESystem::OEGetTag` function.

The following table shows the basic methods of the
:ref:`OEBase <OESystem_OEBase>` class that allow the manipulation of generic
data.

.. list-table:: **Methods to manipulate generic data**
   :widths: 15 40
   :header-rows: 1

   * - Method
     - Description

   * - :oe:meth:`OESystem::OEBase::SetData`
     - sets a generic data associating it with the given tag

   * - :oe:meth:`OESystem::OEBase::AddData`
     -  adds a generic data associating it with the given tag

   * - :oe:meth:`OESystem::OEBase::HasData`
     - determines whether a molecule has any generic data with a given tag

   * - :oe:meth:`OESystem::OEBase::GetData`
     - returns the generic data associated with the given tag

   * - :oe:meth:`OESystem::OEBase::DeleteData`
     - deletes all generic data  with the given tag

   * - :oe:meth:`OESystem::OEBase::Clear`
     - clears all stored generic data

The main difference between the :oe:meth:`OESystem::OEBase::SetData`
method and the :oe:meth:`OESystem::OEBase::AddData` method is that if a
data with the same identifier is already attached to an object then:

* by using :oe:meth:`OESystem::OEBase::SetData`, the data is replaced
* by using :oe:meth:`OESystem::OEBase::AddData`, the data is appended

Furthermore, :oe:meth:`OESystem::OEBase::SetData` does not allow
replacing an existing tag with a different data type:

.. oe:source:: GenericDataTypeMismatch.py
   :language: python
   :noindent:
   :frag:     SNIPPET-TYPE-MISMATCH

.. oe:source:: GenericDataTypeMismatch.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-TYPE-MISMATCH

.. oe:source:: GenericDataTypeMismatch.java
   :language: java
   :noindent:
   :frag:     SNIPPET-TYPE-MISMATCH

.. oe:source:: GenericDataTypeMismatch.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-TYPE-MISMATCH

The above code will throw the following warning:

::

   Warning: data type mismatch found when using generic data

.. _section_attaching_plain_old_data:

Attaching plain old data
================================================================================

The following simple code demonstrate how data calculated and attached
to a molecule in one function can be accessed later on through the tag
identifier.

.. oe:source:: GenericDataMolWeight.py
   :language: python
   :refnum:   1
   :caption:  Example of using generic data
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-GenericDataMolWeight.py>`

.. oe:source:: GenericDataMolWeight.cpp
   :language: c++
   :refnum:   1
   :caption:  Example of using generic data
   :frag:     SNIPPET

.. oe:source:: GenericDataMolWeight.java
   :language: java
   :refnum:   1
   :caption:  Example of using generic data
   :frag:     SNIPPET

.. oe:source:: GenericDataMolWeight.cs
   :language: csharp
   :refnum:   1
   :caption:  Example of using generic data
   :frag:     SNIPPET

.. note::

   It is a good programming practice to call :oe:meth:`OESystem::OEBase::HasData`
   in order to check whether or not a data exists before trying to access it by
   the :oe:meth:`OESystem::OEBase::GetData` method.

.. oe:language:: c++ python

   The :oe:meth:`OESystem::OEBase::GetData` method returns only the first
   instance of data stored previously with the associated data tag.  Data
   can also be accessed by using the
   :oe:meth:`OESystem::OEBase::GetDataIter` method that returns an
   iterator over all data stored.

   .. oe:source:: GenericDataIter.py
      :language: python
      :noindent:
      :frag:     SNIPPET-DATA-ITER

   .. oe:source:: GenericDataIter.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-DATA-ITER

   The output of code snippet above is the following:

   ::

      activity antiarthritic
      activity antiinflammatory
      weight 128.16898

   The :oe:meth:`OESystem::OEBase::GetDataIter` method can also take a
   tag identifier. In this case it iterates over only data associated
   with the given tag.
   For example, the following code will only prints out the two piece of
   'activity' data.

   .. oe:source:: GenericDataIter.py
      :language: python
      :noindent:
      :frag:     SNIPPET-DATA-ITER-WITH-TAG

   .. oe:source:: GenericDataIter.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-DATA-ITER-WITH-TAG

.. _section_attaching_data_to_atoms:

Attaching data to atoms
================================================================================

Generic data can be attached to any object that derives
from the :ref:`OEBase <OESystem_OEBase>` class.
The following program shows an example where hydrogen bonding donor
property is attached as a bool value to the corresponding :ref:`OEAtomBase <OEChem_OEAtomBase>`
object.

.. oe:source:: GenericDataToAtom.py
   :language: python
   :refnum:   2
   :caption:  Example of attaching generic data to atoms
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-GenericDataToAtom.py>`

.. oe:source:: GenericDataToAtom.cpp
   :language: c++
   :refnum:   2
   :caption:  Example of attaching generic data to atoms
   :frag:     SNIPPET

.. oe:source:: GenericDataToAtom.java
   :language: java
   :refnum:   2
   :caption:  Example of attaching generic data to atoms
   :frag:     SNIPPET

.. oe:source:: GenericDataToAtom.cs
   :language: csharp
   :refnum:   2
   :caption:  Example of attaching generic data to atoms
   :frag:     SNIPPET

.. seealso::

   * :ref:`OEBase <OESystem_OEBase>` class in the :ref:`chapter_oesystemclasses`
     chapter for the full list of derived classes.

.. _section_attaching_other_objects:

Attaching other objects
================================================================================

The type of the generic data is not restricted to fundamental data
types of the programming language.  High-level **OEChem TK** objects such as
:ref:`OEMolBase <OEChem_OEMolBase>`, :ref:`OEAtomBase <OEChem_OEAtomBase>`,
:ref:`OEBondBase <OEChem_OEBondBase>` :ref:`OEScalarGrid <OESystem_OEScalarGrid>`,
:ref:`OESkewGrid <OESystem_OESkewGrid>` and :ref:`OESurface <OESpicoli_OESurface>` can
also be stored through this mechanism. The following program
demonstrates how to attach a subset of a molecule to the original
molecule as generic data.

.. oe:source:: GenericDataMol.py
   :language: python
   :refnum:   3
   :caption:  Example of attaching a molecule as generic data
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-GenericDataMol.py>`

.. oe:source:: GenericDataMol.cpp
   :language: c++
   :refnum:   3
   :caption:  Example of attaching a molecule as generic data
   :frag:     SNIPPET

.. oe:source:: GenericDataMol.java
   :language: java
   :refnum:   3
   :caption:  Example of attaching a molecule as generic data
   :frag:     SNIPPET

.. oe:source:: GenericDataMol.cs
   :language: csharp
   :refnum:   3
   :caption:  Example of attaching a molecule as generic data
   :frag:     SNIPPET

.. oe:language:: c++ python

   Sequences of objects can be stored as well. The following example
   shows how to attach a sequence of atoms into an
   :ref:`OEAtomBase <OEChem_OEAtomBase>` object.

   .. oe:source:: GenericDataContainer.py
      :language: python
      :refnum:   4
      :caption:  Example of attaching list of atoms as generic data
      :frag:     SNIPPET

   .. oe:source:: GenericDataContainer.cpp
      :language: c++
      :refnum:   4
      :caption:  Example of attaching vector of atoms as generic data
      :frag:     SNIPPET

   .. seealso::

      * Example in :ref:`section_grids_genericdata` section that shows how to
        attach grids to molecules

.. note::

   Generic data attached to a molecule or any of its atoms or bonds is automatically
   saved when the molecule is written into an :file:`.oeb` file.

.. seealso::

   * :ref:`section_moltaggeddata_SD` section
   * :ref:`section_moltaggeddata_PDB` section


.. _chapter_grids:

********************************************************************************
Scalar Grids
********************************************************************************

A grid is a data container that holds a value at every point in a
three dimensional lattice. The simplest type of value to hold is a
floating point value. In **OEChem TK**, these are called
:oe:cls:`OEScalarGrids<OESystem::OEScalarGrid>`.
:oe:cls:`OEScalarGrids<OESystem::OEScalarGrid>` are inherently cubic.

The following fundamental parameters define a grid:

:Dimension: The number of grid points per axis
:Midpoint:  The center of the grid in Cartesian space
:Spacing:   The length between grid points

.. _figure_gridfundamentals:

.. figure:: /_images/OEGridParameters.png
   :scale:  100
   :align:  center

   **Fundamental Grid Parameters**

:oe:src:`Listing 1<SNIPPET-ScalarGridCtor>` demonstrates how to
:oe:meth:`construct<OESystem::OEScalarGrid::Constructors>` a grid with
64 points in each direction, a midpoint at the origin, and a spacing
of 0.5 between each point in the grid.

.. oe:source:: ScalarGridCtor.cpp
   :language: c++
   :refnum:   1
   :caption:  Constructing a scalar grid
   :frag:     SNIPPET

.. oe:source:: ScalarGridCtor.py
   :language: python
   :refnum:   1
   :caption:  Constructing a scalar grid
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-ScalarGridCtor.py>`

.. oe:source:: ScalarGridCtor.java
   :language: java
   :refnum:   1
   :caption:  Constructing a scalar grid
   :frag:     SNIPPET

.. oe:source:: ScalarGridCtor.cs
   :language: csharp
   :refnum:   1
   :caption:  Constructing a scalar grid
   :frag:     SNIPPET

.. note::

   The memory footprint of the grid is determined by the
   dimensions. It is easy to create grids that are too large for
   memory. For example, the grid in :oe:src:`Listing 1<SNIPPET-ScalarGridCtor>`
   will consume :math:`64^3 * sizeof(float) = 1048576 bytes = 1 MB` of
   memory for this nominally sized grid.

Minimum and maximum
-----------------------

Every grid can have its maximum and minimum vales reported by GetXMax,
GetXMin etc. The image ``Grid coordinates`` shows a 2D representation
for simplicity. It shows 4 grid points centered at (0,0), with a
spacing of 1.0. Each grid point will have spatial coordinates
(0.5,0.5), (-0.5,0.5) etc. However each grid point lies at the center
of a pixel (or rather a voxel in 3D). Any property that falls into the
area (volume) of that grid point is mapped to that grid point. This
means that the maximum value of x is the extent of the grid, not just
the maximum value of the grid point coordinates. In this case that
value is 1.0.

.. _figure_minmaxgrid:

.. figure:: oechemtk/images/OEGrid.*
   :align:  center

   **Grid coordinates**

.. _section_dataaccess:

Data Access
================================================================================

Grids provide three ways to index data inside the grid. They are
ordered here by speed of access, i.e., grid elements perform simple
pointer arithmetic where spatial coordinates require floating point
computation.

:Grid Element: Index into the underlying data array
:Grid Indices: Unsigned integers less than the dimension for that axis
:Spatial Coordinates:
   Cartesian coordinates of any point inside the grid, the grid will
   determine the closest grid point

Spatial Coordinates
-----------------------

Assuming ``grid`` is already filled with relevant values,
:oe:src:`Listing 2<SNIPPET-SpatialGet-SpatialCoordAccess>` demonstrates
how to retrieve the grid value closest to the atoms in the molecule
``mol``.

.. oe:source:: SpatialCoordAccess.cpp
   :language: c++
   :noindent:
   :refnum:   2
   :frag:     SNIPPET-SpatialGet
   :caption:  Getting values associated with coordinates

.. oe:source:: SpatialCoordAccess.py
   :language: python
   :noindent:
   :refnum:   2
   :frag:     SNIPPET-SpatialGet
   :caption:  Getting values associated with coordinates

.. oe:source:: SpatialCoordAccess.java
   :language: java
   :noindent:
   :refnum:   2
   :frag:     SNIPPET-SpatialGet
   :caption:  Getting values associated with coordinates

.. oe:source:: SpatialCoordAccess.cs
   :language: csharp
   :noindent:
   :refnum:   2
   :frag:     SNIPPET-SpatialGet
   :caption:  Getting values associated with coordinates

Spatial coordinates can also be used to set data on the grid.
:oe:src:`Listing 3<SNIPPET-SpatialSet-SpatialCoordAccess>` demonstrates
how to assign an atom's partial charge to the grid point it is closest
to.

.. oe:source:: SpatialCoordAccess.cpp
   :language: c++
   :noindent:
   :refnum:   3
   :frag:     SNIPPET-SpatialSet
   :caption:  Setting values associated with coordinates

.. oe:source:: SpatialCoordAccess.py
   :language: python
   :noindent:
   :refnum:   3
   :frag:     SNIPPET-SpatialSet
   :caption:  Setting values associated with coordinates

.. oe:source:: SpatialCoordAccess.java
   :language: java
   :noindent:
   :refnum:   3
   :frag:     SNIPPET-SpatialSet
   :caption:  Setting values associated with coordinates

.. oe:source:: SpatialCoordAccess.cs
   :language: csharp
   :noindent:
   :refnum:   3
   :frag:     SNIPPET-SpatialSet
   :caption:  Setting values associated with coordinates

.. note::

   In the preceding two code fragments bounds checking was explicitly
   performed using the
   :oe:meth:`IsInGrid<OESystem::OEGridBase::IsInGrid>`
   method. Accessing data outside the grid is undefined behavior
   (usually a segmentation fault). However,
   :oe:meth:`IsInGrid<OESystem::OEGridBase::IsInGrid>` can become an
   expensive operation if performed excessively. One way to avoid this
   cost is to make sure your grid is big enough to enclose the object
   being worked on. See
   :oe:func:`OESystem::OEMakeGridFromCenterAndExtents` for an example
   of constructing a grid that covers the entire molecule to ensure no
   spatial coordinate access is outside the bounds of the grid.

Grid Indices
-----------------------

Grid indices are faster than spatial coordinates because there is no
floating point arithmetic to perform. Grid indices make it easy to
iterate over the neighbors of any particular point in the
grid. :oe:src:`Listing 4<SNIPPET-NeighborPoints-NeighborPoints>`
demonstrates iterating over all 27 grid points adjacent to and
including the grid point given by the grid indices: ``ix``, ``iy``,
``iz``.

.. oe:source:: NeighborPoints.cpp
   :language: c++
   :noindent:
   :refnum:   4
   :frag:     SNIPPET-NeighborPoints
   :caption:  Iterating over neighbor points

.. oe:source:: NeighborPoints.py
   :language: python
   :noindent:
   :refnum:   4
   :frag:     SNIPPET-NeighborPoints
   :caption:  Iterating over neighbor points

.. oe:source:: NeighborPoints.java
   :language: java
   :noindent:
   :refnum:   4
   :frag:     SNIPPET-NeighborPoints
   :caption:  Iterating over neighbor points

.. oe:source:: NeighborPoints.cs
   :language: csharp
   :noindent:
   :refnum:   4
   :frag:     SNIPPET-NeighborPoints
   :caption:  Iterating over neighbor points

Grid Elements
-----------------------

Grid values are actually stored in a large one dimensional block of
memory. The fastest way to access all the data is to linearly scan
through memory. :oe:src:`Listing 5<SNIPPET-SquarePoints-SquarePoints>`
demonstrates how to square every value in the grid.

.. oe:source:: SquarePoints.cpp
   :language: c++
   :noindent:
   :refnum:   5
   :frag:     SNIPPET-SquarePoints
   :caption:  Squaring every grid value

.. oe:source:: SquarePoints.py
   :language: python
   :noindent:
   :refnum:   5
   :frag:     SNIPPET-SquarePoints
   :caption:  Squaring every grid value

.. oe:source:: SquarePoints.java
   :language: java
   :noindent:
   :refnum:   5
   :frag:     SNIPPET-SquarePoints
   :caption:  Squaring every grid value

.. oe:source:: SquarePoints.cs
   :language: csharp
   :noindent:
   :refnum:   5
   :frag:     SNIPPET-SquarePoints
   :caption:  Squaring every grid value

.. oe:language:: c++

   Direct access to the memory is given by the
   :oe:meth:`GetValues<OESystem::OEFixedGrid::GetValues>` method. This
   allows faster memory functions, *e.g.*, memset and memcpy, to be
   applied to grid values. The following code is the quickest way to
   zero out all the grid values.

   .. oe:source:: SquarePoints.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-ZeroValues
      :caption:  Clearing all grid data

.. _section_grid_input_output:

Input and Output
================================================================================

The following grid file formats are supported:

.. table::  **OEChem TK grid file format support**

   ===========================================  ======================  =====================================================================================  =======  ======
   Grid File Type (or reader)                   File Extension(s)       Description                                                                            Read     Write
   ===========================================  ======================  =====================================================================================  =======  ======
   :oe:const:`OESystem::OEGridFileType::Grasp`  ``.phi``                GRASP                                                                                  Yes      Yes
   :oe:const:`OESystem::OEGridFileType::GRD`    ``.grd``                OpenEye Binary format                                                                  Yes      Yes
   :oe:const:`OESystem::OEGridFileType::Ascii`  ``.agd``                OpenEye ASCII format                                                                   Yes      Yes
   :oe:const:`OESystem::OEGridFileType::CCP4`   ``.map .ccp .ccp4``     CCP4 format                                                                            Yes      Yes
   :oe:const:`OESystem::OEGridFileType::XPLOR`  ``.xplor .xplmap``      XPLOR format                                                                           Yes      No
   :oe:func:`OESystem::OEReadMTZ`               ``.mtz``                `MTZ <http://www.ccp4.ac.uk/html/mtzformat.html>`_ crystallographic reflection format  Yes      No
   ===========================================  ======================  =====================================================================================  =======  ======

The ASCII format (``.agd``) was developed by OpenEye to allow for easy
integration with other software. The following is an example of the
ASCII output for a grid centered at the origin, 2 points along
each axis, a spacing of 0.5, and every value zero.

.. code-block:: bash

   Title: Example Grid
   Mid:     0.000000     0.000000     0.000000
   Dim:      2      2      2
   Spacing:     0.500000
   Values:
   0.000000e+00
   0.000000e+00
   0.000000e+00
   0.000000e+00
   0.000000e+00
   0.000000e+00
   0.000000e+00
   0.000000e+00

:oe:src:`Listing 6<SNIPPET-ASCIIWriter>` is the code used to write the ASCII
format out. It is provided here to leave no doubt as to how to
inter-operate with the format.

.. oe:source:: ASCIIWriter.cpp
   :language: c++
   :noindent:
   :refnum:   6
   :caption:  Writing the ASCII format
   :frag:     SNIPPET

.. oe:source:: ASCIIWriter.py
   :language: python
   :noindent:
   :refnum:   6
   :caption:  Writing the ASCII format
   :frag:     SNIPPET

.. oe:source:: ASCIIWriter.java
   :language: java
   :noindent:
   :refnum:   6
   :caption:  Writing the ASCII format
   :frag:     SNIPPET

.. oe:source:: ASCIIWriter.cs
   :language: csharp
   :noindent:
   :refnum:   6
   :caption:  Writing the ASCII format
   :frag:     SNIPPET

.. _section_grids_genericdata:

Grid as Generic Data
================================================================================

Grids can also be attached to molecules and then written out to
OEBinary (:file:`.oeb`) files. A visualizer can then read in the
molecule and grid without any other means of making the association.
:oe:src:`Listing 7<SNIPPET-AttachGaussianGrid-AttachGaussianGrid>`
demonstrates how to attach a Gaussian grid to the molecule it was
created from.

The grid is attached to a molecule using the 'generic data' interface
provided by the :ref:`OEBase <OESystem_OEBase>` base class.  This allows an
arbitrary number of grids (or any type of data) to be attached to
molecules.
Since all grids also derive from :ref:`OEBase <OESystem_OEBase>` generic
data can be attached to grids as well allowing for arbitrarily complex
data hierarchies.

.. oe:source:: AttachGaussianGrid.cpp
   :language: c++
   :noindent:
   :refnum:   7
   :frag:     SNIPPET-AttachGaussianGrid
   :caption:  Attaching a grid to a molecule

.. oe:source:: AttachGaussianGrid.py
   :language: python
   :noindent:
   :refnum:   7
   :frag:     SNIPPET-AttachGaussianGrid
   :caption:  Attaching a grid to a molecule

.. oe:source:: AttachGaussianGrid.java
   :language: java
   :noindent:
   :refnum:   7
   :frag:     SNIPPET-AttachGaussianGrid
   :caption:  Attaching a grid to a molecule

.. oe:source:: AttachGaussianGrid.cs
   :language: csharp
   :noindent:
   :refnum:   7
   :frag:     SNIPPET-AttachGaussianGrid
   :caption:  Attaching a grid to a molecule

.. seealso::

   * :ref:`chapter_genericdata` chapter


.. _chapter_inchivalidation:

********************************************************************************
InChI validation
********************************************************************************

The InChI strings returned by :oe:func:`OEChem::OECreateInChI` were rigorously tested to ensure
that they were identical to the InChI strings generated by the standalone InChI utility program.

.. table:: Performance of **OECreateInChI** to generate *standard InChI*

   =================== ========= =================== ============
   Database            Size      Number of failures  Success Rate
   =================== ========= =================== ============
   eMolecules          9.1M      1,350               99.97 %
   ChEMBL_23           1.7M      8,255               99.52 %
   =================== ========= =================== ============

Many failures are due to the problem that **OEChem TK** and *InChI* handle some incorrect bond stereo configurations differently.
See example in :ref:`Difference due atom stereo perception<table_InChI_problem_atom_stereo>`

Additionally there are approximately 7,300 structures in ChEMBL_23 where the InChI, ``SMILES``
and SDF forms for the record are in disagreement resulting in ambiguity for the expected or reference InChI.

.. _table_InChI_problem_atom_stereo:

 .. list-table::  **Differences due atom stereo perception**
    :widths: 20 200

    * -
      - .. image:: ./images/InChI-problem-atom-stereo-A.*
    * - **InChI standalone**
      - InChI=1S/C3H7NO2/c1-2(4)3(5)6/h2H,4H2,1H3,(H,5,6)
    * - **OECreateInChI**
      - InChI=1S/C3H7NO2/c1-2(4)3(5)6/h2H,4H2,1H3,(H,5,6)/t2-/m1/s1

 See example in :ref:`Difference due atom stereo perception<table_InChI_problem_atom_stereo>`



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. _chapter_interactions:

********************************************************************************
Interaction Perception
********************************************************************************

**OEBio TK** provides the following APIs to perceive protein-ligand interactions:

   :oe:func:`OEBio::OEPerceiveInteractionHints`
      The function that perceives protein-ligand interactions.

   :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>`
      The class that stores the parameters that control the interaction perception.

      The default geometric parameters have been set based on literature data
      ([Kumar-2002]_, [Cavallo-2016]_, [Bissantz-2010]_, and [Marcou-2007]_ ).

Interaction Hint Container
================================================================================

Interactions perceived by the :oe:func:`OEBio::OEPerceiveInteractionHints` function are stored
in an :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.
The architecture of the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class is depicted
in :ref:`figure_OEInteractionHintContainer`.

.. only:: oehtml

   .. _figure_OEInteractionHintContainer:

   .. figure::  /_images/interactionhint.svg
      :align:  center
      :width:  800 pt

      **Schematic representation of interaction hint container**

   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>`
     This is the main container that stores typed molecules (:ref:`OEMolBase <OEChem_OEMolBase>`), fragments of those
     molecules (:ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>`) and typed interactions (:ref:`OEInteractionHint <OEBio_OEInteractionHint>`)
     between the fragments.

   :ref:`OEInteractionHintComponentTypeBase <OEBio_OEInteractionHintComponentTypeBase>`
     The abstract class that enables to type molecules stored in the interaction container.
     Each molecule added to the container has to have a specific type.
     Currently, there are two built-in component types available:

     * :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>`  -- component type that classifies a molecule as a 'ligand'
     * :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>` -- component type that classifies a molecule as a 'protein'

   :ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>`
     Set of atoms of a molecule that is stored in the interaction container. These are the
     atoms that are contribute to an interaction (:ref:`OEInteractionHint <OEBio_OEInteractionHint>`).
     Some interactions, such as hydrogen bonds, are between two atoms; other ones define
     interactions between set of atoms.
     For example, a stacking interaction is between atoms of two aromatic ring systems.

   :ref:`OEInteractionHint <OEBio_OEInteractionHint>`
     An iteration is defined between two fragments (:ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>`) stored in the
     container. An interaction can be either inter (:oe:meth:`OEBio::OEInteractionHint::IsInter`) or intra
     (:oe:meth:`OEBio::OEInteractionHint::IsIntra`) molecular. Each interaction has a specific type that is
     derived from the :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>` class.

   :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`
     The abstract class that enables to type interactions stored in the interaction container.
     The table below shows the specific interaction types currently available in **OEBio TK**.
     Some interaction classes are also associated with namespaces that enable to
     *subtype* the main interaction types.
     For example, the stacking interaction has the following subtypes:

     * Pi-stacking -- :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` ( :oe:const:`OEBio::OEStackingInteractionHintType::Pi` )
     * T-stacking  -- :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` ( :oe:const:`OEBio::OEStackingInteractionHintType::T` )
     * Intra-molecular Pi-stacking (ligand)  -- :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` ( :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularLigandPi` )
     * Intra-molecular T-stacking (ligand)   -- :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` ( :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularLigandT` )
     * Intra-molecular Pi-stacking (protein) -- :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` ( :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularProteinPi` )
     * Intra-molecular T-stacking (protein)  -- :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` ( :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularProteinT` )

     Similarly, the cation-pi interaction has the following subtypes:

     * Cation-Pi (ligand pi)              -- :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` ( :oe:const:`OEBio::OECationPiInteractionHintType::LigandPi` )
     * Cation-Pi (protein pi)             -- :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` ( :oe:const:`OEBio::OECationPiInteractionHintType::ProteinPi` )
     * Intra-molecular cation-Pi (ligand)  -- :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` ( :oe:const:`OEBio::OECationPiInteractionHintType::IntramolecularLigand` )
     * Intra-molecular cation-Pi (protein) -- :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` ( :oe:const:`OEBio::OECationPiInteractionHintType::IntramolecularProtein` )

     .. list-table:: **Interaction types currently available in OEBio TK**
        :header-rows: 1
        :widths: 300 500 500

        * - name
          - corresponding interaction class
          - corresponding interaction type namespace

        * - cation-pi
          - :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`
          - :ref:`OECationPiInteractionHintType <OEBio_OECationPiInteractionHintType>`

        * - chelator
          - :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
          - :ref:`OEChelatorInteractionHintType <OEBio_OEChelatorInteractionHintType>`

        * - clash
          - :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>`
          - None

        * - contact
          - :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`
          -  None

        * - covalent
          - :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>`
          -  None

        * - halogen bond
          - :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>`
          - :ref:`OEHalogenBondInteractionHintType <OEBio_OEHalogenBondInteractionHintType>`

        * - hydrogen bond
          - :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
          - :ref:`OEHBondInteractionHintType <OEBio_OEHBondInteractionHintType>`

        * - salt-bridge
          - :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`
          - :ref:`OESaltBridgeInteractionHintType <OEBio_OESaltBridgeInteractionHintType>`

        * - stacking (T and Pi)
          - :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>`
          - :ref:`OEStackingInteractionHintType <OEBio_OEStackingInteractionHintType>`

Other related APIs:

   :ref:`OEIsValidActiveSite <OEBio_OEIsValidActiveSite>`
      This function checks whether the interaction container initialized correctly as
      **active site** i.e. containing two molecules: one typed as *ligand* and one typed as *protein*.

   :ref:`OEGetActiveSiteInteractionHintTypes <OEBio_OEGetActiveSiteInteractionHintTypes>`
      This function iterates over all interaction types (including subtypes) that are
      perceived by the :ref:`OEPerceiveInteractionHints <OEBio_OEPerceiveInteractionHints>` function.

.. admonition:: Code Examples

   * :ref:`section_example_oebio_printinteractions` **OEChem TK** example
   * :ref:`section_examples_summary_complex2img` **Grapheme TK** example

   **OpenEye Python Cookbook** recipes:

   * `Accessing Interaction Hint Information`_
   * `Print Protein-Ligand Interactions to Console`_
   * `Print the Summary of Protein-Ligand Interactions for a Set of Molecules`_

Interaction Hint Predicates
================================================================================

The table below list all interaction predicates that are currently available in
**OEBio TK**.

.. table:: **OEBio TK interaction predicates**

   ========================================= ===========================================================
   Access interactions                       Functor Name
   ========================================= ===========================================================
   with given interaction type               :ref:`OEHasInteractionHintType <OEBio_OEHasInteractionHintType>`
   with given atom                           :ref:`OEHasInteractionHint <OEBio_OEHasInteractionHint>`
   with given residue                        :ref:`OEHasResidueInteractionHint <OEBio_OEHasResidueInteractionHint>`
   contact                                   :ref:`OEIsContactInteractionHint <OEBio_OEIsContactInteractionHint>`
   hydrogen bond                             :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>`
   inter-molecular hydrogen bond             :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>`
   intra-molecular hydrogen bond             :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>`
   chelator                                  :ref:`OEIsChelatorInteractionHint <OEBio_OEIsChelatorInteractionHint>`
   inter-molecular chelator                  :ref:`OEIsIntermolecularChelatorInteractionHint <OEBio_OEIsIntermolecularChelatorInteractionHint>`
   intra-molecular chelator                  :ref:`OEIsIntramolecularChelatorInteractionHint <OEBio_OEIsIntramolecularChelatorInteractionHint>`
   covalent                                  :ref:`OEIsCovalentInteractionHint <OEBio_OEIsCovalentInteractionHint>`
   clash                                     :ref:`OEIsClashInteractionHint <OEBio_OEIsClashInteractionHint>`
   clashing hydrogen bond                    :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>`
   salt-bridge                               :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>`
   inter-molecular salt-bridge               :ref:`OEIsIntermolecularSaltBridgeInteractionHint <OEBio_OEIsIntermolecularSaltBridgeInteractionHint>`
   intra-molecular salt-bridge               :ref:`OEIsIntramolecularSaltBridgeInteractionHint <OEBio_OEIsIntramolecularSaltBridgeInteractionHint>`
   T and Pi-stacking                         :ref:`OEIsStackingInteractionHint <OEBio_OEIsStackingInteractionHint>`
   inter-molecular stacking                  :ref:`OEIsIntermolecularStackingInteractionHint <OEBio_OEIsIntermolecularStackingInteractionHint>`
   intra-molecular stacking                  :ref:`OEIsIntramolecularStackingInteractionHint <OEBio_OEIsIntramolecularStackingInteractionHint>`
   cation-Pi                                 :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>`
   inter-molecular cation-Pi                 :ref:`OEIsIntermolecularCationPiInteractionHint <OEBio_OEIsIntermolecularCationPiInteractionHint>`
   intra-molecular cation-Pi                 :ref:`OEIsIntramolecularCationPiInteractionHint <OEBio_OEIsIntramolecularCationPiInteractionHint>`
   halogen bond                              :ref:`OEIsHalogenBondInteractionHint <OEBio_OEIsHalogenBondInteractionHint>`
   inter-molecular halogen bond              :ref:`OEIsIntermolecularHalogenBondInteractionHint <OEBio_OEIsIntermolecularHalogenBondInteractionHint>`
   intra-molecular halogen bond              :ref:`OEIsIntramolecularHalogenBondInteractionHint <OEBio_OEIsIntramolecularHalogenBondInteractionHint>`
   inter-molecular                           :ref:`OEIsInterInteractionHint <OEBio_OEIsInterInteractionHint>`
   intra-molecular                           :ref:`OEIsIntraInteractionHint <OEBio_OEIsIntraInteractionHint>`
   non-ideal hydrogen bond                   :ref:`OEIsNonIdealHBondInteractionHint <OEBio_OEIsNonIdealHBondInteractionHint>`
   unpaired (hbond or salt-bridge)           :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>`
   unpaired ligand                           :ref:`OEIsUnpairedLigandInteractionHint <OEBio_OEIsUnpairedLigandInteractionHint>`
   unpaired protein                          :ref:`OEIsUnpairedProteinInteractionHint <OEBio_OEIsUnpairedProteinInteractionHint>`
   ========================================= ===========================================================

The following logical operations allow to combine both the built-in and the
user defined interaction predicates.

.. oe:language:: c++

   .. table:: **Interaction Composite Functors**

      ===================================== ========================================
      Composite Functor                     Description
      ===================================== ========================================
      :oe:cls:`OENot<OESystem::OENot>`      logical not
      :oe:cls:`OEOr<OESystem::OEOr>`        logical or
      :oe:cls:`OEAnd<OESystem::OEAnd>`      logical and
      ===================================== ========================================

.. oe:language:: python java csharp

   .. table:: **Interaction Composite Functors**

      ================================================ ========================================
      Composite Functor                                Description
      ================================================ ========================================
      :oe:cls:`OENotInteractionHint<OESystem::OENot>`  logical not
      :oe:cls:`OEOrInteractionHint<OESystem::OEOr>`    logical or
      :oe:cls:`OEAndInteractionHint<OESystem::OEAnd>`  logical and
      ================================================ ========================================

.. _chapter_interactions_geometry:

Accessing Calculated Interaction Hint Geometries
================================================================================

When interaction hints are perceived using the :oe:func:`OEBio::OEPerceiveInteractionHints`
function, various geometries (such as distances and angles) are calculated
that are checked against the geometric constraints stored in the given
:ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class.

The following code snippet shows how to access these calculated geometries:

.. oe:source:: InteractionGeometry.py
   :language: python
   :noindent:
   :frag:     SNIPPET-INTER

.. oe:source:: InteractionGeometry.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-INTER

.. oe:source:: InteractionGeometry.java
   :language: java
   :noindent:
   :frag:     SNIPPET-INTER

.. oe:source:: InteractionGeometry.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-INTER

For the :oe:const:`OEBio::OEHBondInteractionHintType::LigandDonates` hydrogen bond
interaction type, three geometries are calculated:

* the distance between the acceptor and the donor heavy atoms
  (see also the :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance` method)
* the acceptor angle (see also the :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle` method)
* the donor angle (see also the :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle` method)

The "distance" values are always given in Angstroms and the "angle" values
are always given in radians.
The output of the code snippet above might look like this:

.. code-block:: console

   Calculated geometries for 'bio:active-site:hbond:ligand2protein' interaction type:
   bio:interaction:distance       : 2.722
   bio:intaraction:acceptor-angle : 0.155
   bio:interaction:donor-angle    : 0.241

For different interactions, different geometries are calculated.
The following snippet shows how to access the names of the geometries that are
available for a given interaction type using the :oe:func:`OEBio::OEGetCalculatedInteractionGeometries` function:

.. oe:source:: InteractionGeometry.py
   :language: python
   :noindent:
   :frag:     SNIPPET-INTER-TYPE

.. oe:source:: InteractionGeometry.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-INTER-TYPE

.. oe:source:: InteractionGeometry.java
   :language: java
   :noindent:
   :frag:     SNIPPET-INTER-TYPE

.. oe:source:: InteractionGeometry.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-INTER-TYPE

All interaction geometry names start with the ``bio:interaction:`` prefix.
However, both the :oe:meth:`OEBio::OEInteractionHint::HasCalculatedGeometry` and
:oe:meth:`OEBio::OEInteractionHint::GetCalculatedGeometry` methods accept
names with or without the ``bio:interaction:`` prefix.

The following code snippet shows how to access the calculated geometries directly:

.. oe:source:: InteractionGeometry.py
   :language: python
   :noindent:
   :frag:     SNIPPET-HAS-GEOMETRY

.. oe:source:: InteractionGeometry.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-HAS-GEOMETRY

.. oe:source:: InteractionGeometry.java
   :language: java
   :noindent:
   :frag:     SNIPPET-HAS-GEOMETRY

.. oe:source:: InteractionGeometry.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-HAS-GEOMETRY

The output of the code snippet above might look like this:

.. code-block:: console

   distance: 2.722  Angstrom(s)
   acceptor angle: 8.863 degree(s)

.. hint::

   It is a good practice to call :oe:meth:`OEBio::OEInteractionHint::HasCalculatedGeometry`
   prior to invoking the :oe:meth:`OEBio::OEInteractionHint::GetCalculatedGeometry`
   method to check whether the interaction hint has a geometry with a given name.

Currently, the following names are used for the interaction geometries:

* ``bio:interaction:distance``
* ``bio:interaction:angle``
* ``bio:interaction:acceptor-angle``
* ``bio:interaction:donor-angle``

For most interactions (except the unpaired ones), the calculated distance
is available by using the ``bio:interaction:distance`` name.
None of the unpaired interactions have any calculated geometries since
they only "suggest" how they could contribute to the binding but are not
actually formed in the complex.

A calculated geometry, such as a distance, can have different meanings based on
the interaction type.
For example, in a hydrogen bond interaction it means the distance between
the acceptor and donor heavy atoms. For a pi-staking interaction,
it means the distance between the center of the two ring systems.
The following table shows the correspondence between the calculated
geometries and the geometric constraints.

.. list-table::
   :widths: 100 100 100

   * - Set method
     - Interaction type
     - Associated geometry name

   * - :oe:meth:`SetMaxHBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance>`
     - hbond
     - ``bio:interaction:distance``

   * - :oe:meth:`SetMaxChargeAidedHBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance>`
     - hbond (charged)
     - ``bio:interaction:distance``

   * - :oe:meth:`SetMaxNonIdealHBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealHBondDistance>`
     - non-ideal hbond
     - ``bio:interaction:distance``

   * - :oe:meth:`SetMaxAcceptorAngle<OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle>`
     - hbond
     - ``bio:interaction:acceptor-angle``

   * - :oe:meth:`SetMaxDonorAngle<OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle>`
     - hbond
     - ``bio:interaction:donor-angle``

   * - :oe:meth:`SetMaxNonIdealAcceptorAngle<OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealAcceptorAngle>`
     - non-ideal hbond
     - ``bio:interaction:acceptor-angle``

   * - :oe:meth:`SetMaxNonIdealDonorAngle<OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealDonorAngle>`
     - non-ideal hbond
     - ``bio:interaction:donor-angle``

   * - :oe:meth:`SetMaxMetalBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxMetalBondDistance>`
     - chelator
     - ``bio:interaction:distance``

   * - :oe:meth:`SetMaxSaltBridgeDistance<OEBio::OEPerceiveInteractionOptions::SetMaxSaltBridgeDistance>`
     - salt bridge
     - ``bio:interaction:distance``

   * - :oe:meth:`SetMaxCationPiDistance<OEBio::OEPerceiveInteractionOptions::SetMaxCationPiDistance>`
     - cation-Pi
     - ``bio:interaction:distance``

   * - :oe:meth:`SetMaxCationPiAngle<OEBio::OEPerceiveInteractionOptions::SetMaxCationPiAngle>`
     - cation-Pi
     - ``bio:interaction:angle``

   * - :oe:meth:`SetMaxPiStackDistance<OEBio::OEPerceiveInteractionOptions::SetMaxPiStackDistance>`
     - Pi-stacking
     - ``bio:interaction:distance``

   * - :oe:meth:`SetMaxPiStackAngle<OEBio::OEPerceiveInteractionOptions::SetMaxPiStackAngle>`
     - Pi-stacking
     - ``bio:interaction:angle``

   * - :oe:meth:`SetMaxTStackDistance<OEBio::OEPerceiveInteractionOptions::SetMaxTStackDistance>`
     - T-stacking
     - ``bio:interaction:distance``

   * - :oe:meth:`SetMaxTStackAngle<OEBio::OEPerceiveInteractionOptions::SetMaxTStackAngle>`
     - T-stacking
     - ``bio:interaction:angle``

   * - :oe:meth:`SetMinStackOffset<OEBio::OEPerceiveInteractionOptions::SetMinStackOffset>`
     - Pi-stacking and T-stacking
     - (no geometry — acts as a filter)

   * - :oe:meth:`SetMaxHalogenBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxHalogenBondDistance>`
     - halogen bond
     - ``bio:interaction:distance``

   * - :oe:meth:`SetMaxHalogenAngle<OEBio::OEPerceiveInteractionOptions::SetMaxHalogenAngle>`
     - halogen bond
     - ``bio:interaction:angle``


.. _chapter_oechem_interface:

********************************************************************************
Command Line Interface Definition 
********************************************************************************
.. index :: command line interface definition

When not working with **Options** derived from :ref:`OEOptions <OESystem_OEOptions>`,
:ref:`OEInterface <OESystem_OEInterface>` class can still be used to create a command line
application. For such usage, :ref:`OEInterface <OESystem_OEInterface>` has a convenience
constructor that takes an interface definition and a command line to
parse. The constructor will configure the interface with the specified
definition, then parse the options from command line passed in through
``argv``.

.. oe:source:: GettingStartedWithOEInterface.cpp
   :language: c++
   :refnum:   1
   :caption:  Getting started with OEInterface command line parsing
   :frag:     SNIPPET

.. oe:source:: GettingStartedWithOEInterface.py
   :language: python
   :refnum:   1
   :caption:  Getting started with OEInterface command line parsing
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-GettingStartedWithOEInterface.py>`

.. oe:source:: GettingStartedWithOEInterface.java
   :language: java
   :refnum:   1
   :caption:  Getting started with OEInterface command line parsing
   :frag:     SNIPPET

.. oe:source:: GettingStartedWithOEInterface.cs
   :language: csharp
   :refnum:   1
   :caption:  Getting started with OEInterface command line parsing
   :frag:     SNIPPET

The values specified on the command line are then accessed on the
:ref:`OEInterface <OESystem_OEInterface>` object using a ``Get`` method that
corresponds to the type of the parameter. The following is an example
of executing the program in :oe:src:`Listing
1<SNIPPET-GettingStartedWithOEInterface>`:

.. oe:language:: c++

   .. code-block:: bash

      prompt> ./GettingStartedWithOEInterface -b -i 12345 -f 0.5 -str foo
      -b = 1
      -i = 12345
      -f = 0.5
      -str = foo

.. oe:language:: python

   .. code-block:: bash

      prompt> ./GettingStartedWithOEInterface.py -b -i 12345 -f 0.5 -str foo
      -b = True
      -i = 12345
      -f = 0.5
      -str = foo

.. oe:language:: java

   .. code-block:: bash

      prompt> java openeye.docexamples.oechem.GettingStartedWithOEInterface -b -i 12345 -f 0.5 -str foo
      -b = true
      -i = 12345
      -f = 0.5
      -str = foo

.. warning::

   The convenience constructor will call the system exit function
   forcing the program to exit in the following situations:

   - The interface definition is malformed
   - The user has requested help on any of the parameters, *e.g.*, ``--help -str``
   - The command line is malformed, *i.e.*, missing or extra parameters

   For these reasons the convenience constructor may not be suitable
   for use in a library setting, it is intended for standalone
   applications.

.. _section_accessing_parameter_values:

Parameter Value Access
================================================================================

The ``Get`` methods of the :ref:`OEInterface <OESystem_OEInterface>` returns the
value of the specified parameter the user entered on the command line,
or in the case that the parameter was not specified by the user on the
command line the default value specified in the interface definition
is returned.  If there is no default or user specified value the
default constructed object is returned (*i.e.*, 0.0f for ``float``
parameters and an empty string for ``string`` parameters) and a
warning is issued. For example, the following demonstrates how running
the program in :oe:src:`Listing 1<SNIPPET-GettingStartedWithOEInterface>`
without any arguments will display a lot of warnings about
uninitialized values being used.

.. oe:language:: c++

   .. code-block:: bash

      prompt> ./GettingStartedWithOEInterface
      Warning: OEInterface::Get, requesting value of unset parameter -b
      -b = 0
      Warning: OEInterface::Get, requesting value of unset parameter -i
      -i = 0
      Warning: OEInterface::Get, requesting value of unset parameter -f
      -f = 0
      Warning: OEInterface::Get, requesting value of unset parameter -str
      -str =

.. oe:language:: python

   .. code-block:: bash

      prompt> ./GettingStartedWithOEInterface.py
      Warning: OEInterface::Get, requesting value of unset parameter -b
      -b = False
      Warning: OEInterface::Get, requesting value of unset parameter -i
      -i = 0
      Warning: OEInterface::Get, requesting value of unset parameter -f
      -f = 0.0
      Warning: OEInterface::Get, requesting value of unset parameter -str
      -str =

.. oe:language:: java

   .. code-block:: bash

      prompt> java openeye.docexamples.oechem.GettingStartedWithOEInterface
      Warning: OEInterface::Get, requesting value of unset parameter -b
      -b = false
      Warning: OEInterface::Get, requesting value of unset parameter -i
      -i = 0
      Warning: OEInterface::Get, requesting value of unset parameter -f
      -f = 0.0
      Warning: OEInterface::Get, requesting value of unset parameter -str
      -str =

The warnings can be avoided by using the
:oe:meth:`OESystem::OEInterface::Has` method to check if there is no
default value or user specified value. :oe:src:`Listing
2<SNIPPET-UsingOEInterfaceHas>` demonstrates how to check for the existence of
certain parameters.

.. oe:source:: UsingOEInterfaceHas.cpp
   :language: c++
   :refnum:   2
   :caption:  Testing for parameter existence with the Has method
   :frag:     SNIPPET

.. oe:source:: UsingOEInterfaceHas.py
   :language: python
   :refnum:   2
   :caption:  Testing for parameter existence with the Has method
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-UsingOEInterfaceHas.py>`

.. oe:source:: UsingOEInterfaceHas.java
   :language: java
   :refnum:   2
   :caption:  Testing for parameter existence with the Has method
   :frag:     SNIPPET

.. oe:source:: UsingOEInterfaceHas.cs
   :language: csharp
   :refnum:   2
   :caption:  Testing for parameter existence with the Has method
   :frag:     SNIPPET

The following demonstrates the output of the program in :oe:src:`Listing
2<SNIPPET-UsingOEInterfaceHas>`. Notice that only variables present on the
command line will trigger :oe:meth:`OESystem::OEInterface::Has` to
return ``true``. This is an important distinction when dealing with
``boolean`` parameters, :oe:meth:`OESystem::OEInterface::Has` will not
return the value of the ``boolean`` parameter, just the existence of
it.

.. oe:language:: c++

   .. code-block:: bash

      prompt> ./UsingOEInterfaceHas
      prompt> ./UsingOEInterfaceHas -b
      -b = 1
      prompt> ./UsingOEInterfaceHas -i 2
      -i = 2
      prompt> ./UsingOEInterfaceHas -f 0.5
      -f = 0.5
      prompt> ./UsingOEInterfaceHas -str foo
      -str = foo

.. oe:language:: python

   .. code-block:: bash

      prompt> ./UsingOEInterfaceHas.py
      prompt> ./UsingOEInterfaceHas.py -b
      -b = True
      prompt> ./UsingOEInterfaceHas.py -i 2
      -i = 2
      prompt> ./UsingOEInterfaceHas.py -f 0.5
      -f = 0.5
      prompt> ./UsingOEInterfaceHas.py -str foo
      -str = foo

.. oe:language:: java

   .. code-block:: bash

      prompt> java openeye.docexamples.oechem.UsingOEInterfaceHas -b
      -b = true
      prompt> java openeye.docexamples.oechem.UsingOEInterfaceHas -i 2
      -i = 2
      prompt> java openeye.docexamples.oechem.UsingOEInterfaceHas -f 0.5
      -f = 0.5
      prompt> java openeye.docexamples.oechem.UsingOEInterfaceHas -str foo
      -str = foo

.. _section_default_values:

Default Values
================================================================================

Using :oe:meth:`OESystem::OEInterface::Has` all over a program can
become quite clumsy. Therefore it is recommended to use ``!DEFAULT``
in the parameter interface definition to specify the parameter's
default value whenever a default value can be specified. When a
parameter has a default value :oe:meth:`OESystem::OEInterface::Has`
will always return ``true``. :oe:src:`Listing 3<SNIPPET-UsingOEInterfaceDefaults>`
demonstrates how to set a default value for a parameter.

.. oe:source:: UsingOEInterfaceDefaults.cpp
   :language: c++
   :refnum:   3
   :caption:  Setting a default value for a parameter
   :frag:     SNIPPET

.. oe:source:: UsingOEInterfaceDefaults.py
   :language: python
   :refnum:   3
   :caption:  Setting a default value for a parameter
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-UsingOEInterfaceDefaults.py>`

.. oe:source:: UsingOEInterfaceDefaults.java
   :language: java
   :refnum:   3
   :caption:  Setting a default value for a parameter
   :frag:     SNIPPET

.. oe:source:: UsingOEInterfaceDefaults.cs
   :language: csharp
   :refnum:   3
   :caption:  Setting a default value for a parameter
   :frag:     SNIPPET

This allows the code to take a very simple structure that doesn't have
to care whether the parameter was actually specified on the command
line. The following is what is printed by the program in
:oe:src:`Listing 3<SNIPPET-UsingOEInterfaceDefaults>` when no arguments are
given.

.. oe:language:: c++

   .. code-block:: bash

      prompt> ./UsingOEInterfaceDefaults
      -b = 0
      -i = 2
      -f = 0.5
      -str = foo

.. oe:language:: python

   .. code-block:: bash

      prompt> ./UsingOEInterfaceDefaults.py
      -b = False
      -i = 2
      -f = 0.5
      -str = foo

.. oe:language:: java

   .. code-block:: bash

      prompt> java openeye.docexamples.oechem.UsingOEInterfaceDefaults
      -b = false
      -i = 2
      -f = 0.5
      -str = foo

.. _section_requiring_parameters:

Requiring Parameters
================================================================================

Programs usually have a bare minimum set of parameters that must be
specified. A parameter can be marked as required in the interface
definition by using ``!REQUIRED true`` in the parameter
definition. :oe:src:`Listing 4<SNIPPET-UsingOEInterfaceRequired>` demonstrates
making all the parameters used in the previous example required.

.. oe:source:: UsingOEInterfaceRequired.cpp
   :language: c++
   :refnum:   4
   :caption:  Requiring all parameters to be specified.
   :frag:     SNIPPET

.. oe:source:: UsingOEInterfaceRequired.py
   :language: python
   :refnum:   4
   :caption:  Requiring all parameters to be specified.
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-UsingOEInterfaceRequired.py>`

.. oe:source:: UsingOEInterfaceRequired.java
   :language: java
   :refnum:   4
   :caption:  Requiring all parameters to be specified.
   :frag:     SNIPPET

.. oe:source:: UsingOEInterfaceRequired.cs
   :language: csharp
   :refnum:   4
   :caption:  Requiring all parameters to be specified.
   :frag:     SNIPPET

If any required parameter is missing from the command line
during the command line parsing stage an appropriate error message
will be thrown. The following demonstrates the error messages thrown
by the program in :oe:src:`Listing 4<SNIPPET-UsingOEInterfaceRequired>`:

.. oe:language:: c++

   .. code-block:: bash

      prompt> ./UsingOEInterfaceRequired
      No arguments specified on the command line
      Required parameters:
          -b : An boolean parameter
          -i : An integer parameter
          -f : A float parameter
          -str : A string parameter
      For more help type:
        ./UsingOEInterfaceRequired --help

      prompt> ./UsingOEInterfaceRequired -b
      Fatal: Missing required parameter -i

.. oe:language:: python

   .. code-block:: bash

      prompt> ./UsingOEInterfaceRequired.py
      No arguments specified on the command line
      Required parameters:
          -b : An boolean parameter
          -i : An integer parameter
          -f : A float parameter
          -str : A string parameter
      For more help type:
        ./UsingOEInterfaceRequired.py --help

      prompt> ./UsingOEInterfaceRequired.py -b
      Fatal: Missing required parameter -i

.. oe:language:: java

   .. code-block:: bash

      prompt> java openeye.docexamples.oechem.UsingOEInterfaceRequired
      No arguments specified on the command line
      Required parameters:
          -b : An boolean parameter
          -i : An integer parameter
          -f : A float parameter
          -str : A string parameter
      For more help type:
        UsingOEInterfaceRequired --help

      prompt> java openeye.docexamples.oechem.UsingOEInterfaceRequired -b
      Fatal: Missing required parameter -i

.. _section_legal_and_illegal_values_and_ranges:

Legal and Illegal Values and Ranges
================================================================================

Some parameter types can have legal/illegal ranges and values.  These
are set with the ``!LEGAL_VALUE``, ``!ILLEGAL_VALUE``,
``!LEGAL_RANGE``, and ``!ILLEGAL_RANGE`` fields. The following are the
restrictions for certain parameter types:

.. describe:: bool

   Boolean parameters cannot have legal/illegal ranges and values.

.. describe:: int and float

   These parameters can have legal/illegal ranges and values.
   Checks for illegal ranges and values are performed first and if an
   invalid range or value is detected an error is returned.  Then
   legal ranges and values are checked, and if the parameter setting
   matches or there are no legal ranges or values it passes.  ``inf``
   and ``-inf`` can be used as range limits, along with regular
   numerical values.

.. describe:: string

   String parameters can have legal/illegal values, but not
   ranges. Checks for illegal values are performed first and if an
   invalid value is detected an error is returned. Then legal values are
   checked, and if the parameter setting matches it passes. Legal/illegal
   values for the string type support up to 2 ``*`` wildcards for
   pattern matches.  This is commonly used to force a file extension,
   *e.g.*, ``!LEGAL_VALUE *.txt``.

.. _section_parameter_lists:

Parameter Lists
================================================================================

Sometimes it is useful to allow multiple values for a given
parameter. The ``!LIST`` field is used to specify that a parameter can
have multiple values separated by spaces on the command line. The
:oe:meth:`OESystem::OEInterface::GetList` method should then be used to
get an iterator over the parameter's values. :oe:src:`Listing
5<SNIPPET-UsingOEInterfaceList>` demonstrates how to specify that a parameter
is a list of values and then how to access it with the
:oe:meth:`OESystem::OEInterface::GetList` method.

.. oe:source:: UsingOEInterfaceList.cpp
   :language: c++
   :refnum:   5
   :caption:  Specifying that a parameter is a list of values
   :frag:     SNIPPET

.. oe:source:: UsingOEInterfaceList.py
   :language: python
   :refnum:   5
   :caption:  Specifying that a parameter is a list of values
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-UsingOEInterfaceList.py>`

.. oe:source:: UsingOEInterfaceList.java
   :language: java
   :refnum:   5
   :caption:  Specifying that a parameter is a list of values
   :frag:     SNIPPET

.. oe:source:: UsingOEInterfaceList.cs
   :language: csharp
   :refnum:   5
   :caption:  Specifying that a parameter is a list of values
   :frag:     SNIPPET

The command line parser will then assign elements as values based upon
their position in the ``argv`` that was passed to the program. This
allows the user to pass values that have spaces in them by simply
quoting the relevant section. The following demonstrates the behavior
of the program in :oe:src:`Listing 5<SNIPPET-UsingOEInterfaceList>`:

.. oe:language:: c++

   .. code-block:: bash

      prompt> ./UsingOEInterfaceList -strs foo bar blah
      -strs = foo
              bar
              blah

      prompt> ./UsingOEInterfaceList -strs "foo bar" blah
      -strs = foo bar
              blah

.. oe:language:: python

   .. code-block:: bash

      prompt> ./UsingOEInterfaceList.py -strs foo bar blah
      -strs = foo
              bar
              blah

      prompt> ./UsingOEInterfaceList.py -strs "foo bar" blah
      -strs = foo bar
              blah

.. oe:language:: java

   .. code-block:: bash

      prompt> java openeye.docexamples.oechem.UsingOEInterfaceList -strs foo bar blah
      -strs = foo
              bar
              blah

      prompt> java openeye.docexamples.oechem.UsingOEInterfaceList -strs "foo bar" blah
      -strs = foo bar
              blah

.. _section_positional_parameters:

Positional Parameters
================================================================================

For commonly used parameters it is often useful to allow them to be
specified by their position on the command line. The ``!KEYLESS``
record is used to specify that a parameter can be assigned from a
positional value on the command line. :oe:src:`Listing
6<SNIPPET-UsingOEInterfaceKeyless>` demonstrates how to specify input and
output file name parameters that can be specified from their position
on the command line.

.. oe:source:: UsingOEInterfaceKeyless.cpp
   :language: c++
   :refnum:   6
   :caption:  Specifying keyless input and output file parameters
   :frag:     SNIPPET

.. oe:source:: UsingOEInterfaceKeyless.py
   :language: python
   :refnum:   6
   :caption:  Specifying keyless input and output file parameters
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-UsingOEInterfaceKeyless.py>`

.. oe:source:: UsingOEInterfaceKeyless.java
   :language: java
   :refnum:   6
   :caption:  Specifying keyless input and output file parameters
   :frag:     SNIPPET

.. oe:source:: UsingOEInterfaceKeyless.cs
   :language: csharp
   :refnum:   6
   :caption:  Specifying keyless input and output file parameters
   :frag:     SNIPPET

``!KEYLESS`` parameters can still be specified using their command
line flag. However, positional arguments need to be the last values on
the command line. The following demonstrates how ``!KEYLESS``
parameters can and cannot be specified on the command line:

.. oe:language:: c++

   .. code-block:: bash

      prompt> ./UsingOEInterfaceKeyless -i foo -o bar
      Input file = foo
      Output file = bar

      prompt> ./UsingOEInterfaceKeyless foo bar
      Input file = foo
      Output file = bar

      prompt> ./UsingOEInterfaceKeyless -i foo bar
      Input file = foo
      Output file = bar

      prompt> ./UsingOEInterfaceKeyless foo -o bar
      Fatal: Unknown parameter, foo, on command line

.. oe:language:: python

   .. code-block:: bash

      prompt> ./UsingOEInterfaceKeyless.py -i foo -o bar
      Input file name = foo
      Output file name = bar

      prompt> ./UsingOEInterfaceKeyless.py foo bar
      Input file name = foo
      Output file name = bar

      prompt> ./UsingOEInterfaceKeyless.py -i foo bar
      Input file name = foo
      Output file name = bar

      prompt> ./UsingOEInterfaceKeyless.py foo -o bar
      Fatal: Unknown parameter, foo, on command line

.. oe:language:: java

   .. code-block:: bash

      prompt> java openeye.docexamples.oechem.UsingOEInterfaceKeyless -i foo -o bar
      Input file name = foo
      Output file name = bar

      prompt> java openeye.docexamples.oechem.UsingOEInterfaceKeyless foo bar
      Input file name = foo
      Output file name = bar

      prompt> java openeye.docexamples.oechem.UsingOEInterfaceKeyless -i foo bar
      Input file name = foo
      Output file name = bar

      prompt> java openeye.docexamples.oechem.UsingOEInterfaceKeyless foo -o bar
      Fatal: Unknown parameter, foo, on command line

.. warning::

   An ambiguity occurs when mixing ``!KEYLESS`` with ``!LIST``. There
   is no way for the parser to differentiate between multiple values
   for a ``!LIST`` and different ``!KEYLESS`` parameters.
   :ref:`OEInterface <OESystem_OEInterface>` resolves this by requiring that any
   keyless list parameter must be the *last* keyless parameter.

.. _section_parameter_molecule:

Molecule Parameters
================================================================================

As the previous example illustrated how to handle simple parameters
such as ``float``, ``int`` or ``string``.
The :ref:`OEInterface <OESystem_OEInterface>` also provides a convenient way to
open a molecule file and return its first molecule.

.. oe:source:: OEInterfaceMolParam.cpp
   :language: c++
   :refnum:   7
   :caption:  Example of using molecule parameter
   :frag:     SNIPPET

.. oe:source:: OEInterfaceMolParam.py
   :language: python
   :refnum:   7
   :caption:  Example of using molecule parameter
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-OEInterfaceMolParam.py>`

.. oe:language:: c++

   .. code-block:: bash

      prompt> ./OEInterfaceMolParam -mol benzene.mol
      Number of heavy atoms in molecule = 6

.. oe:language:: python

   .. code-block:: bash

      prompt> python OEInterfaceMolParam.py -mol benzene.mol
      Number of heavy atoms in molecule = 6

Similarly the first multi-conformer molecule can be imported from a molecule
file by setting the type of a parameter as ``!TYPE OEMol``.

.. _section_command_line_help:

Command Line Help
================================================================================

The :ref:`OEInterface <OESystem_OEInterface>` object can have a significant
amount of information, default values, text descriptions, etc., about
the parameters it holds. All this information allows the
:ref:`OEInterface <OESystem_OEInterface>` to provide help to the user
interactively automatically based upon the interface
definition. :oe:src:`Listing 8<SNIPPET-UsingOEInterfaceHelp>` is a fairly
simple program, it just concatenates all the molecules given into a
single molecule. Though it has a fairly complex set of command line
parameters which :ref:`OEInterface <OESystem_OEInterface>` handles
automatically.

.. oe:source:: UsingOEInterfaceHelp.cpp
   :language: c++
   :refnum:   8
   :caption:  A program to concatenate any number of molecules together
   :frag:     SNIPPET

.. oe:source:: UsingOEInterfaceHelp.py
   :language: python
   :refnum:   8
   :caption:  A program to concatenate any number of molecules together
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-UsingOEInterfaceHelp.py>`

.. oe:source:: UsingOEInterfaceHelp.java
   :language: java
   :refnum:   8
   :caption:  A program to concatenate any number of molecules together
   :frag:     SNIPPET

.. oe:source:: UsingOEInterfaceHelp.cs
   :language: csharp
   :refnum:   8
   :caption:  A program to concatenate any number of molecules together
   :frag:     SNIPPET

.. note::

   - ``!BRIEF`` can be used outside of a ``!PARAMETER`` to give a
     concise one line command line usage.
   - ``!ALIAS`` is used to specify an alternative name the parameter
     can be specified with.
   - ``!DETAIL`` is used for a more detailed description of the
     parameter.

Whenever there are ``!REQUIRED`` parameters the
:ref:`OEInterface <OESystem_OEInterface>` will complain about an empty command
line. This is usually the first way users interact with a command line
program so the goal is to give them only enough information to get the
program running. This is where specifying a top-level ``!BRIEF`` is
exceptionally useful to the end user. The following is the output of
the program in :oe:src:`Listing 8<SNIPPET-UsingOEInterfaceHelp>` when no
parameters are given:

.. oe:language:: c++

   .. code-block:: bash

      prompt> ./UsingOEInterfaceHelp
      No arguments specified on the command line
      ./UsingOEInterfaceHelp : UsingOEInterfaceHelp [-d <delimiter>] [-o] <output> [-i] <input1> <input2> ...
      Required parameters:
          -output : The output file
          -inputs : The input files
      For more help type:
        ./UsingOEInterfaceHelp --help

.. oe:language:: python

   .. code-block:: bash

      prompt> ./UsingOEInterfaceHelp.py
      No arguments specified on the command line
      ./UsingOEInterfaceHelp.py : UsingOEInterfaceHelp.py [-d <delimiter>] [-o] <output> [-i] <input1> <input2> ...
      Required parameters:
          -output : The output file
          -inputs : The input files
      For more help type:
        ./UsingOEInterfaceHelp.py --help

.. oe:language:: java

   .. code-block:: bash

      prompt> java openeye.docexamples.oechem.UsingOEInterfaceHelp
      No arguments specified on the command line
      UsingOEInterfaceHelp : UsingOEInterfaceHelp [-d <delimiter>] [-o] <output> [-i] <input1> <input2> ...
      Required parameters:
          -output : The output file
          -inputs : The input files
      For more help type:
        UsingOEInterfaceHelp --help

More information is accessible from the command line by specifying
``--help`` as the first argument on the command line. The following is
an example of requesting help from the program in :oe:src:`Listing
7<SNIPPET-UsingOEInterfaceHelp>`:

.. oe:language:: c++

   .. code-block:: bash

      prompt> ./UsingOEInterfaceHelp --help
      ./UsingOEInterfaceHelp : UsingOEInterfaceHelp [-d <delimiter>] [-o] <output> [-i] <input1> <input2> ...
      Simple parameter list
          -delim : Title delimiter
          -inputs : The input files
          -output : The output file

      Additional help functions:
        ./UsingOEInterfaceHelp --help simple      : Get a list of simple parameters (as seen above)
        ./UsingOEInterfaceHelp --help all         : Get a complete list of parameters
        ./UsingOEInterfaceHelp --help defaults    : List the defaults for all parameters
        ./UsingOEInterfaceHelp --help <parameter> : Get detailed help on a parameter
        ./UsingOEInterfaceHelp --help html        : Create an html help file for this program

.. oe:language:: python

   .. code-block:: bash

      prompt>./UsingOEInterfaceHelp.py --help
      ./UsingOEInterfaceHelp.py : UsingOEInterfaceHelp.py [-d <delimiter>] [-o] <output> [-i] <input1> <input2> ...
      Simple parameter list
          -delim : Title delimiter
          -inputs : The input files
          -output : The output file

      Additional help functions:
        ./UsingOEInterfaceHelp.py --help simple      : Get a list of simple parameters (as seen above)
        ./UsingOEInterfaceHelp.py --help all         : Get a complete list of parameters
        ./UsingOEInterfaceHelp.py --help defaults    : List the defaults for all parameters
        ./UsingOEInterfaceHelp.py --help <parameter> : Get detailed help on a parameter
        ./UsingOEInterfaceHelp.py --help html        : Create an html help file for this program

.. oe:language:: java

   .. code-block:: bash

      prompt> java openeye.docexamples.oechem.UsingOEInterfaceHelp --help
      UsingOEInterfaceHelp : UsingOEInterfaceHelp [-d <delimiter>] [-o] <output> [-i] <input1> <input2> ...
      Simple parameter list
          -delim : Title delimiter
          -inputs : The input files
          -output : The output file

      Additional help functions:
        UsingOEInterfaceHelp --help simple      : Get a list of simple parameters (as seen above)
        UsingOEInterfaceHelp --help all         : Get a complete list of parameters
        UsingOEInterfaceHelp --help defaults    : List the defaults for all parameters
        UsingOEInterfaceHelp --help <parameter> : Get detailed help on a parameter
        UsingOEInterfaceHelp --help html        : Create an html help file for this program

As seen above ``--help`` can take arguments that allow the user
introspect even further into the semantics of a particular parameter.

.. oe:language:: c++

   .. code-block:: bash

      prompt> ./UsingOEInterfaceHelp --help -inputs

      Contents of parameter -inputs
          Aliases : -i
          Type : string
          Allow list : true
          Default : (parameter does not have a default)
          Keyless : 2
          Simple : true
          Required : true
          Brief : The input files
          Detail
              A list of molecule files to add together. Note, only the
              first molecule from every file will be added.

.. oe:language:: python

   .. code-block:: bash

      prompt> ./UsingOEInterfaceHelp.py --help -inputs

      Contents of parameter -inputs
          Aliases : -i
          Type : string
          Allow list : true
          Default : (parameter does not have a default)
          Keyless : 2
          Simple : true
          Required : true
          Brief : The input files
          Detail
              A list of molecule files to add together. Note, only the
              first molecule from every file will be added.

.. oe:language:: java

   .. code-block:: bash

      prompt> java openeye.docexamples.oechem.UsingOEInterfaceHelp --help -inputs

      Contents of parameter -inputs
          Aliases : -i
          Type : string
          Allow list : true
          Default : (parameter does not have a default)
          Keyless : 2
          Simple : true
          Required : true
          Brief : The input files
          Detail
              A list of molecule files to add together. Note, only the
              first molecule from every file will be added.

.. note::

   :oe:func:`OESystem::OECheckHelp` is the low-level function used to
   check a command line for ``--help``. By default the
   :oe:meth:`OEInterface
   constructor<OESystem::OEInterface::Constructors>` and the
   :oe:func:`OESystem::OEParseCommandLine` function call
   :oe:func:`OESystem::OECheckHelp` automatically so most users will
   never need to use this function directly.

.. _section_interface_definition:

Interface Definition Specification
================================================================================

.. index :: itf interface definition specification

Configuring an :ref:`OEInterface <OESystem_OEInterface>` is the process of
telling the name, type, and other details of all the command line
parameters the program is going to use. An interface definition
consists of a collection of ``PARAMETER`` blocks optionally organized
into ``CATEGORY`` blocks. A ``PARAMETER`` block must always have the
following information:

:NAME: The command line flag, *e.g.*, ``-i``, ``-str``, ``-cutoff``
:TYPE: The kind of information being passed, *e.g.*, ``float``, ``int``, ``string``, ``bool``

A ``PARAMETER`` can also optionally contain the following additional
information:

:ALIAS: One or more aliases for the parameter name that are generally
        used to create shorthand for lengthy parameter names. For
        example a parameter named ``-energy_cutoff_window`` could be
        given an alias ``-ecw``, that would make typing
        ``-energy_cutoff_window 10.0`` on the command line equivalent
        to ``-ecw 10.0``.

:DEFAULT: A default value for the parameter that will be used if the
          parameter is not specified by the user on the command line.

:REQUIRED: A flag specifying that the parameter is required. If a
           parameter is required the program will throw an error if
           the user does not specify that parameter. By default
           parameters are not required.

:LIST: A flag specifying whether the parameter is a list of multiple
       values. For example, ``./program -inputs file1.smi file2.smi
       file3.smi``.

:KEYLESS: A number, ``N``, that specifies that this parameter may be
          fulfilled by the ``Nth`` value on the command line that does
          not have a parameter flag specifically associated with
          it. For example, if ``-i`` had a ``KEYLESS`` value of ``1``
          specified the following are equivalent command lines,
          ``./program -i foo.smi`` and ``./program foo.smi``.

:VISIBILITY: A visibility level that controls when the parameter
             appears when the users requests ``--help``. Valid values
             are: ``simple``, ``normal``, ``hidden``. The default is
             ``simple`` if a ``VISIBILITY`` isn't specified.

:LEGAL_VALUE: A valid value that the parameter can be. The parameter
              specified must be one of the values specified in a
              ``LEGAL_VALUE`` field.

:ILLEGAL_VALUE: A value that cannot be specified as the parameter
                value.

:LEGAL_RANGE: A range that the parameter value must fall into. More
              useful than ``LEGAL_VALUE`` when the parameter is a
              ``float``.

:ILLEGAL_RANGE: A range that the parameter value must not fall
                into. More useful than ``ILLEGAL_VALUE`` when the
                parameter is a ``float``.

:BRIEF: A one line description of the parameter that will be displayed
        to users when listing multiple command line options using the
        high-level ``--help`` functions.

:DETAIL: A multi line description of the parameter that will be displayed
         to users when the user requests help about a specific
         parameter, *e.g.*, ``--help -foo``.

Therefore, a ``PARAMETER`` block takes the following form:

.. code-block:: bash

   !PARAMETER <name> [order priority]
     !ALIAS <alias>
     !TYPE <type>
     !DEFAULT <default value>
     !REQUIRED <true or false>
     !LIST <true or false>
     !KEYLESS <N>
     !VISIBILITY <visibility>
     !LEGAL_VALUE <value>
     !ILLEGAL_VALUE <value>
     !LEGAL_RANGE <hi value> <low value>
     !ILLEGAL_RANGE <hi_value> <low_value>
     !BRIEF <brief description>
     !DETAIL
       <detailed description line 1>
       <detailed description line 2>
       <detailed description line 3>
       .
       .
       .
   !END

``PARAMETER`` blocks can then be organized into ``CATEGORY``
blocks. ``CATEGORY`` blocks can also contain nested ``CATEGORY``
blocks, there is no limit to the amount of nesting. The value
specified after the ``!CATEGORY`` specifier is the name of the
``CATEGORY``. The ``CATEGORY`` can also contain a ``!BRIEF`` to give a
human readable description of the grouping. The following interface
definition defines an interface definition with an "Input and Output"
category with sub-categories for input and output respectively. As
well as a category for various other parameters.

.. code-block:: bash

   !CATEGORY Input and Output
     !CATEGORY Input
       !PARAMETER -i
         ...
       !END
     !CATEGORY Output
       !PARAMETER -o
         ...
       !END
     !END
   !END
   !CATEGORY Other Stuff
     !PARAMETER -o
       ...
     !END
   !END

By default parameters and categories appear in alphabetical order. This
order can be adjusted however by adding an integer after the category or
parameter name in the interface definition. Parameters and categories
are then sorted first by this integer and secondarily by their names. If
this integer is unspecified, it is assumed to be zero. The following
example illustrates re-ordering of both categories and variables.

.. code-block:: bash

   !CATEGORY Input and Output 1
     !CATEGORY Input 1
       !PARAMETER -input 1
         ...
       !END
       !PARAMETER -dbase 2
         ...
       !END
    !CATEGORY Output 2
       !PARAMETER -output 1
         ...
       !END
       !PARAMETER -hits 2
         ...
       !END
     !END
   !END
   !CATEGORY Other Stuff 2
     !PARAMETER -o
       ...
     !END
   !END



.. _chapter_oechem_interface_new:

********************************************************************************
Command Line Interface and Options
********************************************************************************
.. index :: command line options parsing

This chapter describes how **Options** classes that are derived from 
:ref:`OEOptions <OESystem_OEOptions>` can be configured with command line
inputs passed in through ``argv``.

The :ref:`OEConfigureOpts <OESystem_OEConfigureOpts>` function is a convenience function
that takes an :ref:`OEOptions <OESystem_OEOptions>` derivative options class and
the command line arguments ``argv``, parses the command line arguments, 
and configures the option parameters with command line inputs. A
:ref:`OEInterface <OESystem_OEInterface>` is generated internally from the
:ref:`OEOptions <OESystem_OEOptions>`, which performs the command lines parsing.

Note that this only applies to **Options** classes that are derived from the 
:ref:`OEOptions <OESystem_OEOptions>`.  There are a handful of **Options** classes
that still does not derive from :ref:`OEOptions <OESystem_OEOptions>`, and hence cannot
be configured with command line inputs directly. 
:ref:`Command Line Interface Definitions <chapter_oechem_interface>` is an
alternative way to work with command line interfaces for such cases.

In addition to the convenience function :ref:`OEConfigureOpts <OESystem_OEConfigureOpts>`,
two additional general purpose **Options** classes,  :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>`,
and :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>`, are provided that extends
any other options classes to include necessary input/output parameters that are
generally required to create an application. 

.. seealso::

   * :oe:func:`OESystem::OEConfigureOpts` function
   * :ref:`OEOptions <OESystem_OEOptions>` class
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class
   * :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>` class

.. _section_oechem_interface_simple_app:

Application with Input, output, and Options
================================================================================

The following example shows how to use the :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>`
class to extend an **Options** class with an additional input and output file.

The specific example is taken from **OEDocking**, and uses the
the :oe:func:`OEDocking::OEMakeReceptor` function to make a receptor in
a design unit. In this example, the :ref:`OEMakeReceptorOptions <OEDocking_OEMakeReceptorOptions>`
is extended with an input and output.

.. oe:source:: MakeReceptor.cpp
   :language: c++
   :caption:  Application with input, output, and options (Making Receptor)
   :refnum:   1

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeReceptor.cpp <../../../../sublibs/tklibs/docking/examples/MakeReceptor.cpp>`

.. oe:source:: MakeReceptor.py
   :language: python
   :caption:  Application with input, output, and options (Making Receptor)
   :refnum:   1

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeReceptor.py <../../../../wrappers/python/examples/docking/MakeReceptor.py>`

.. oe:source:: MakeReceptor.java
   :language: java
   :caption:  Application with input, output, and options (Making Receptor)
   :refnum:   1

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeReceptor.java <../../../../wrappers/java/examples/openeye/examples/oedocking/MakeReceptor.java>`

.. oe:source:: MakeReceptor.cs
   :language: csharp
   :caption:  Application with input, output, and options (Making Receptor)
   :refnum:   1

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeReceptor.cs <../../../../wrappers/csharp/Csharp-Examples/OEDocking/MakeReceptor.cs>`

.. _section_oechem_interface_ref_app:

Application with Reference system, Input, output, and Options
================================================================================

Besides an input and output, some applications require an additional 
reference system input. The :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>` class
can be used to extend an options class with three additional parameters,
an input, output, and a reference system.

The following code example is taken from **OEDocking**, and uses
the :ref:`OEDock <OEDocking_OEDock>` object to perform docking. In this example,
the :ref:`OEDockOptions <OEDocking_OEDockOptions>` is extended with an input, output,
and a **receptor** (i.e., the reference system).

.. oe:source:: DockMolecules.cpp
   :language: c++
   :caption:  Application with input, reference, output, and options (Docking Molecules)
   :refnum:   2

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`DockMolecules.cpp <../../../../sublibs/tklibs/docking/examples/DockMolecules.cpp>`

.. oe:source:: DockMolecules.py
   :language: python
   :caption:  Application with input, reference, output, and options (Docking Molecules)
   :refnum:   2

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`DockMolecules.py <../../../../wrappers/python/examples/docking/DockMolecules.py>`

.. oe:source:: DockMolecules.java
   :language: java
   :caption:  Application with input, reference, output, and options (Docking Molecules)
   :refnum:   2

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`DockMolecules.java <../../../../wrappers/java/examples/openeye/examples/oedocking/DockMolecules.java>`

.. oe:source:: DockMolecules.cs
   :language: csharp
   :caption:  Application with input, reference, output, and options (Docking Molecules)
   :refnum:   2

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`DockMolecules.cs <../../../../wrappers/csharp/Csharp-Examples/OEDocking/DockMolecules.cs>`

.. _section_oechem_interface_no_options:

Application with Input and output only
================================================================================

Some applications do not have any additional options or parameters, and only require
an input and output. The :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class
has an overload that does not require an :ref:`OEOptions <OESystem_OEOptions>` input argument.

The following code example is taken from **OEQuacpac**, and uses
the :oe:func:`OEProton::OEAssignCharges` method to assign charges in
an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`. This example only configures an
input and output, and does not have any additional parameters to configure.

.. oe:source:: applycharges_oedu.cpp
   :language: c++
   :caption:  Application with input and output only (DesignUnit Charges)
   :refnum:   3

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`applycharges_oedu.cpp <../../../../sublibs/tklibs/quacpac/examples/applycharges_oedu.cpp>`

.. oe:source:: applycharges_oedu.py
   :language: python
   :caption:  Application with input and output only (DesignUnit Charges)
   :refnum:   3

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`applycharges_oedu.py <../../../../wrappers/python/examples/quacpac/applycharges_oedu.py>`

.. _section_oechem_interface_add_param:

Adding custom parameters
================================================================================

Custom parameters can also be added to an application API when a built-in **Options**
class does not contain all required parameters for the application.

The following code example is taken from **OEDocking**, and uses
the :ref:`OEPosit <OEDocking_OEPosit>` object to generate pose structures. In this example,
the :ref:`OEPositOptions <OEDocking_OEPositOptions>` is extended with an input, output,
and **receptor** (i.e., the reference system). However, the number of 
poses to generate is not a built-in parameter into the :ref:`OEPositOptions <OEDocking_OEPositOptions>`.
This example shows how to add an additional parameter, for the number of poses,
to be configured through the command line.

.. oe:source:: GenerateMultiplePose.cpp
   :language: c++
   :caption:  Adding custom parameters (POSIT with Multiple Receptors)
   :refnum:   4

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`GenerateMultiplePose.cpp <../../../../sublibs/tklibs/docking/examples/GenerateMultiplePose.cpp>`

.. oe:source:: GenerateMultiplePose.py
   :language: python
   :caption:  Adding custom parameters (POSIT with Multiple Receptors)
   :refnum:   4

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`GenerateMultiplePose.py <../../../../wrappers/python/examples/docking/GenerateMultiplePose.py>`

.. oe:source:: GenerateMultiplePose.java
   :language: java
   :caption:  Adding custom parameters (POSIT with Multiple Receptors)
   :refnum:   4

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`GenerateMultiplePose.java <../../../../wrappers/java/examples/openeye/examples/oedocking/GenerateMultiplePose.java>`

.. oe:source:: GenerateMultiplePose.cs
   :language: csharp
   :caption:  Adding custom parameters (POSIT with Multiple Receptors)
   :refnum:   4

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`GenerateMultiplePose.cs <../../../../wrappers/csharp/Csharp-Examples/OEDocking/GenerateMultiplePose.cs>`

.. _section_oechem_interface_custom_options:

Defining new options class
================================================================================

Options classes, derived from :ref:`OEOptions <OESystem_OEOptions>`, can also be defined
at the script level, and wrapped with the :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>`
or :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>`, to build applications.

The following code example is taken from **OEFF**, and optimizes molecule
conformations using a force field. In this example, a new **Options** class
is defined to accept command line input for the force field.

.. oe:source:: FFOptimize.cpp
   :language: c++
   :caption:  Defining Options class (Optimize molecule)
   :refnum:   5

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFOptimize.cpp <../../../../sublibs/tklibs/ff/examples/FFOptimize.cpp>`

.. oe:source:: FFOptimize.py
   :language: python
   :caption:  Defining Options class (Optimize molecule)
   :refnum:   5

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFOptimize.py <../../../../wrappers/python/examples/ff/FFOptimize.py>`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _chapter_mdlqueries:

********************************************************************************
Substructure Search with MDL Queries
********************************************************************************

.. index :: MDL query

Section :ref:`section_patternmatch_sss` describes how to perform substructure
search initialized with a SMILES or SMARTS string.
**OEChem TK** also provides the ability to interpret and utilize query structures
expressed in the :term:`MDL` query  file format
(see MDL query example in :ref:`Figure: Example of MDL query substructure<figure_mdlq_query>`).
:oe:src:`Listing 1<SNIPPET-MDLQuerySearchSingleMatch>` shows how to initialize an
:oe:cls:`OESubSearch<OEChem::OESubSearch>` object from a MDL query file and
perform a substructure search.

.. _figure_mdlq_query:

.. figure:: /_images/MDLQuery.png
   :align: center

   **Example of MDL query substructure**

.. oe:source:: MDLQuerySearchSingleMatch.cpp
   :language: c++
   :caption:  Example of substructure search using MDL query file
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: MDLQuerySearchSingleMatch.py
   :language: python
   :caption:  Example of substructure search using MDL query file
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: MDLQuerySearchSingleMatch.java
   :language: java
   :caption:  Example of substructure search using MDL query file
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: MDLQuerySearchSingleMatch.cs
   :language: csharp
   :caption:  Example of substructure search using MDL query file
   :refnum:   1
   :frag:     SNIPPET

After opening the MDL query and the target files, the model used to assign
aromaticity to the imported structures can be adjusted.

.. oe:source:: MDLQuerySearchSingleMatch.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SETAROMODEL

.. oe:source:: MDLQuerySearchSingleMatch.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SETAROMODEL

.. oe:source:: MDLQuerySearchSingleMatch.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SETAROMODEL

.. oe:source:: MDLQuerySearchSingleMatch.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SETAROMODEL

If the aromaticity model is not specified for the input files, then the **OpenEye**'s
aromaticity model is used by default.
For more information about the various aromaticity models of **OEChem TK**
see :ref:`chapter_aromaticity`.

.. oe:source:: MDLQuerySearchSingleMatch.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-READQMOL

.. oe:source:: MDLQuerySearchSingleMatch.py
   :language: python
   :noindent:
   :frag:     SNIPPET-READQMOL

.. oe:source:: MDLQuerySearchSingleMatch.java
   :language: java
   :noindent:
   :frag:     SNIPPET-READQMOL

.. oe:source:: MDLQuerySearchSingleMatch.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-READQMOL

In general, the aromaticity model chosen should be consistent between the
query and target molecules to be searched.
Using different aromaticity models may produce false negatives as aromatic
systems may be treated differently.
Section :ref:`section_mdlqueries_aromaticity` further explains the effects of
using various aromaticity models when performing a substructure search.

.. index:: OEReadMDLQueryFile

:oe:func:`OEReadMDLQueryFile<OEChem::OEReadMDLQueryFile>` function reads the
MDL query directly into a :oe:cls:`OEQMolBase<OEChem::OEQMolBase>` object ,
which then can be used to initialize an :oe:cls:`OESubSearch<OEChem::OESubSearch>`
instance.

.. index :: OEBuildMDLQueryExpression

The MDL query structure can also be read into a :oe:cls:`OEMolBase<OEChem::OEMolBase>`
object (see code snippet below).
In this case, the :oe:func:`OEReadMDLQueryFile<OEChem::OEReadMDLQueryFile>`
function attaches the query features present in the input MDL file to the related
atoms and bonds of the :oe:cls:`OEMolBase<OEChem::OEMolBase>` object.
The :oe:cls:`OEQMolBase<OEChem::OEQMolBase>` object can be subsequently created by
calling the :oe:func:`OEBuildMDLQueryExpressions<OEChem::OEBuildMDLQueryExpressions>`
function.

.. oe:language:: c++

   .. code-block:: c++

      OEGraphMol mol;
      OEReadMDLQueryFile(qfile,mol);
      // mol can be manipulated here
      OEQMol qmol;
      // build OEQMol with OEMDLQueryOpts::Default option
      OEBuildMDLQueryExpressions(qmol,mol);
      OESubSearch ss(qmol);

.. oe:language:: python

   .. code-block:: python

      mol = OEGraphMol()
      OEReadMDLQueryFile(qfile,mol)
      # mol can be manipulated here
      qmol = OEQMol()
      # build OEQMol with OEMDLQueryOpts_Default option
      OEBuildMDLQueryExpressions(qmol,mol)
      ss = OESubSearch(qmol)

.. oe:language:: java

   .. code-block:: java

      OEGraphMol mol = new OEGraphMol();
      oechem.OEReadMDLQueryFile(qfile,mol);
      // mol can be manipulated here
      OEQMol qmol = new OEQMol();
      // build OEQMol with OEMDLQueryOpts.Default option
      oechem.OEBuildMDLQueryExpressions(qmol,mol);
      OESubSearch ss = new OESubSearch(qmol);

.. oe:language:: csharp

   .. code-block:: csharp

      OEGraphMol mol = new OEGraphMol();
      OEChem.OEReadMDLQueryFile(qfile,mol);
      // mol can be manipulated here
      OEQMol qmol = new OEQMol();
      // build OEQMol with OEMDLQueryOpts.Default option
      OEChem.OEBuildMDLQueryExpressions(qmol,mol);
      OESubSearch ss = new OESubSearch(qmol);

The declaration of these functions are:

.. oe:language:: c++

   .. code-block:: c++

      bool OEReadMDLQueryFile(oemolistream &ifs, OEMolBase& mol)
      bool OEReadMDLQueryFile(oemolistream &ifs, OEQMolBase& qmol,
                              unsigned int opts = OEMDLQueryOpts::Default)
      bool OEBuildMDLQueryExpressions(OEQMolBase &qmol, const OEMolBase &mol,
                                      unsigned int opts = OEMDLQueryOpts::Default)

.. oe:language:: python

   .. code-block:: python

      OEReadMDLQueryFile(ifs,mol)
      # ifs-oemolistream, mol-OEMolBase
      # returns true or false
      OEReadMDLQueryFile(ifs,qmol,opts)
      # ifs-oemolistream, mol-OEQMolBase, opts-integer with OEMDLQueryOpts_Default
      # returns true or false
      OEBuildMDLQueryExpressions(qmol,mol,opts)
      # ifs-oemolistream, mol-OEQMolBase, opts-integer with OEMDLQueryOpts_Default
      # returns true or false

.. oe:language:: java

   .. code-block:: java

      boolean OEReadMDLQueryFile(oemolistream ifs, OEMolBase mol);
      boolean OEReadMDLQueryFile(oemolistream ifs, OEQMolBase qmol, int opts);
      // opts (default value = OEMDLQueryOpts.Default)
      boolean OEBuildMDLQueryExpressions(OEQMolBase qmol, OEMolBase mol, int opts);
      // opts (default value = OEMDLQueryOpts.Default)

.. oe:language:: csharp

   .. code-block:: csharp

      bool OEReadMDLQueryFile(oemolistream ifs, OEMolBase mol);
      bool OEReadMDLQueryFile(oemolistream ifs, OEQMolBase qmol, int opts);
      // opts (default value = OEMDLQueryOpts.Default)
      bool OEBuildMDLQueryExpressions(OEQMolBase qmol, OEMolBase mol, uint opts);
      // opts (default value = OEMDLQueryOpts.Default)

.. _section_mdlqueries_interpret:

MDL Query Interpretation
================================================================================

The `opts` parameter defines how the MDL query is interpreted when
an :oe:cls:`OEQMolBase<OEChem::OEQMolBase>` object is constructed.
The following options are present in the :oe:constns:`OEChem::OEMDLQueryOpts`
namespace:

#. :oe:const:`OEChem::OEMDLQueryOpts::Default`

   Only constraints explicitly specified in the MDL file are added to the
   :ref:`OEQMolBase <OEChem_OEQMolBase>` query structure.
   See section :ref:`section_mdlqueries_features` for the supported MDL
   query features.

#. :oe:const:`OEChem::OEMDLQueryOpts::SuppressExplicitH`

   This option controls how the explicit hydrogens of the query are matched
   to the explicit/implicit hydrogens of the target structures.
   For more information see :ref:`section_mdlqueries_hydrogens`.

#. :oe:const:`OEChem::OEMDLQueryOpts::AddBondAliphaticConstraint`

   If this option is specified, then an aliphatic query bond can only be mapped
   to the aliphatic bonds in the target structure.
   :ref:`Figure: Interpretation A<figure_mdlq_aliphatic>` shows how the MDL query
   structure is interpreted when the
   :oe:const:`OEChem::OEMDLQueryOpts::AddBondAliphaticConstraint`  option is used.

   Query 'A' will match all three of the target compounds displayed in
   :ref:`Figure: Interpretation A<figure_mdlq_aliphatic>`.
   If the *OpenEye* model is used to perceive aromatic rings, then query 'B'
   substructure is present only in target '2'.
   If the MDL aromaticity model is used, then target '3' is also a hit, since
   five-membered heterocycles are not considered aromatic in this model.
   For more information about different aromaticity models and their effects
   on substructure searching see section :ref:`section_mdlqueries_aromaticity`.

   .. _figure_mdlq_aliphatic:

   .. figure:: /_images/mdlq-ConstAliphatic.png
      :scale: 100
      :align: center

      **Interpretation A**

      *Interpretation of the MDL query with 'AddBondAliphaticConstraint' option.*

#. :oe:const:`OEChem::OEMDLQueryOpts::AddBondTopologyConstraint`

   By default, ring bonds in the query structure can only be mapped to ring bonds in the target,
   and chain bonds in the query can be mapped to both ring and chain bonds.
   The :oe:const:`OEChem::OEMDLQueryOpts::AddBondTopologyConstraint` option enables enforcement
   of bond topology constraint during substructure search i.e. ring bonds in the query can
   only be mapped to ring bonds, and chain bonds in the query can
   only be mapped to chain bonds.

   :ref:`Figure: Interpretation B<figure_mdlq_topology>` shows how the MDL query structure
   is interpreted when the :oe:const:`OEChem::OEMDLQueryOpts::AddBondTopologyConstraint`
   option is used.
   Query 'A' will match all three of the target compounds displayed in
   :ref:`Figure: Interpretation B<figure_mdlq_topology>`, while query 'B' is present
   only in target '3'.

   If the 'ring' property is specified in the MDL query file for a particular chain
   bond in the query structure, then its topology constraint is overridden.

   .. _figure_mdlq_topology:

   .. figure:: /_images/mdlq-ConstTopology.png
      :scale: 100
      :align: center

      **Interpretation B**

      *Interpretation of the MDL query with `AddBondTopologyConstrain' option.*

#. :oe:const:`OEChem::OEMDLQueryOpts::MatchAtomStereo`

   When this option is enabled, an S/R atom stereo configuration in the query will only match any S/R configuration in the target molecule,
   but not to a R/S (opposite) or an unspecified one. If an atom stereo configuration is undefined in the query, it is allowed to match to
   any target atom regardless of its stereo configuration.

#. :oe:const:`OEChem::OEMDLQueryOpts::MatchIsotope`

   When this option is enabled, query atoms with an isotope can match to a target atom only if they have the same atomic mass.
   If the query atom has no specified isotope number, it will match to any target atom regardless of its atomic mass.

.. _section_mdlqueries_features:

Supported MDL Query Features
================================================================================

The table below summarizes the MDL query features currently supported by the **OEChem TK**.
These query feature can only be read with the low level :oe:func:`OEChem::OEReadMDLQueryFile`
function and not the high-level :oe:func:`OEChem::OEReadMolecule` function.

.. _table_mdlqueries_summary:

.. list-table:: **Summary of supported MDL query features in V2000 and V3000**
   :widths: 30 30 100
   :header-rows: 1

   * - CTFile V2K
     - CTFile V3K
     - Notes
   * - ``M  CHG``
     - ``CHG=``
     - formal charge
   * - ``<atomblock>``
     - ``HCOUNT=``
     - number of allowed hydrogens V2K:0=off, 1=H0, 2-5 for H1-H4; V3K:0=off, -1=H0, 1-5 for H1-H5
   * - ``M  ISO``
     - ``MASS=``
     - mass difference
   * - ``M  RBC``
     - ``RBCNT=``
     - limit of number of allowed ring bonds attached to an atom
   * - ``M  SUB``
     - ``SUBST=``
     - number of allowed substitutions of an atom
   * - ``M  ALS``
     - ``[aaa,bbb,..]``
     - list alternative atom types for an atom
   * - ``<atomblock>``
     - ``STBOX=``
     - stereo care (e.g. for c/t doubles)
   * - ``L,A,Q``
     - ``L,A,Q``
     - L=atom list, A=Any atom except hydrogen, Q=Any atom except hydrogen and carbon
   * - ``M  UNS``
     - ``UNSAT=``
     - specifies whether or not an atom is unsaturated, *i.e.*, having at least one multiple bond
   * - ``<bondblock>``
     - ``STBOX=``
     - bond stereochemistry that is considered, if both ends of the bond are marked with
       *stereo care* flags in the atom block
   * - ``<bondblock>``
     - ``TOPO=``
     - bond topology (0=off, 1=ring, 2=chain)
   * - ``<bondblock>``
     - ``<bondblock>``
     - 4-aromatic, 5=single or double, 6=single or aromatic, 7=double or aromatic, 8=any

.. _figure_mdlq_example_query:

.. figure:: /_images/mdlq-Example-Query.png
   :scale: 100
   :align: center

   **Query**

   **Example of MDL query structure.**

.. seealso::

   * :ref:`chapter_mdlquery` chapter for the depiction of the supported query features
   * Accelrys `CTfile Formats  document <http://accelrys.com/products/collaborative-science/biovia-draw/ctfile-no-fee.html>`_
     for more information about the atom and bond query features

.. _section_mdlqueries_aromaticity:

Aromaticity
================================================================================

Perceiving aromaticity in the query and the target structures is important in
order to ensure that the result of a substructure search is independent of the
different |Kekule| representations of the participating structures.
A query bond which is part of an aromatic ring system can be mapped to any
aromatic bonds in the target.
:ref:`Figure: Aromaticity Match<figure_mdlq_aromaticity_Kekule>`  shows an example where both
|Kekule| representations of the benzene-1,2-diol substructure are present
in the two target structures.

.. _figure_mdlq_aromaticity_Kekule:

.. figure:: /_images/mdlq-Aromaticity-Kekule.png
   :scale: 100
   :align: center

   **Aromaticity Match**

   *The result of substructure search is independent of the Kekulé representations of the participating structures.*

Altering the aromaticity model will affect the results of a  substructure search.
:ref:`Figure: Aromaticity A<figure_mdlq_aromaticity_A>` --
:ref:`Figure: Aromaticity C<figure_mdlq_aromaticity_C>`
show several examples where different results were obtained by applying
the MDL and the OpenEye aromaticity models.
This is a consequence of the fact that in the MDL aromaticity
model, five-membered heterocycles are not considered aromatic.

.. note::

   It is highly recommended to apply the same aromaticity model to the
   query and the target structures.

:oe:src:`Listing 1<SNIPPET-MDLQuerySearchSingleMatch>` shows an example of how to
change the aromaticity flavor of input files.

.. _figure_mdlq_aromaticity_A:

.. figure:: /_images/mdlq-Aromaticity-A.png
   :scale: 100
   :align: center

   **Aromaticity A**

   *Example of a substructure search applying different aromaticity models.*

.. _figure_mdlq_aromaticity_B:

.. figure:: /_images/mdlq-Aromaticity-B.png
   :scale: 100
   :align: center

   **Aromaticity B**

   *Example of a substructure search applying different aromaticity models.*

.. _figure_mdlq_aromaticity_C:

.. figure:: /_images/mdlq-Aromaticity-C.png
   :scale: 100
   :align: center

   **Aromaticity C**

   *Example of a substructure search applying different aromaticity models.*

.. _section_mdlqueries_arom_generic:

Aromaticity with Generic Atoms
================================================================================

If a ring in the query structure contains generic atom(s) (see example in
:ref:`Figure: Generic atom example A<figure_mdlq_aromaticity_ring6_GA>`), then the aromaticity of the ring can
not be perceived.
In order to maintain the independence from the |Kekule| representation,
6-membered rings with alternating single/double bonds are assumed to be
aromatic.

.. _figure_mdlq_aromaticity_ring6_GA:

.. figure:: /_images/mdlq-Aromaticity-Mem6-GenericAtom.png
   :scale: 100
   :align: center

   **Generic atom example A**

   *Example of aromaticity assumption in a 6-membered ring with generic atoms.*

Similarly, a 5-membered ring with generic atom(s) is considered aromatic if it is
composed of two single and two double bonds.
See Example in :ref:`Figure: Generic atom example B<figure_mdlq_aromaticity_ring5_GA>`.

.. _figure_mdlq_aromaticity_ring5_GA:

.. figure:: /_images/mdlq-Aromaticity-Mem5-GenericAtom.png
   :scale: 100
   :align: center

   **Generic atom example B**

   *Example of aromaticity assumption in a 5-membered ring with generic atoms.*

.. _section_mdlqueries_hydrogens:

Explicit Hydrogens
================================================================================
During the substructure search, each query atom has to be mapped to a target atom
in order to detect subgraph isomorphism.
Therefore, a problem can arise if the query structure contains explicit hydrogens
or an atom list with hydrogens (see example in :ref:`Figure: Query<figure_mdlq_explicitH_query>`),
but the target structure has implicit hydrogens :ref:`Figure: Targets<figure_mdlq_explicitH_targets>`)

.. _figure_mdlq_explicitH_query:

.. figure:: /_images/MDLQueryExplicitH.png
   :align: center

   **Example of MDL query structure with explicit hydrogens**

.. oe:source:: MDLQuerySearchMapping.cpp
   :language: c++
   :caption:  Example of substructure search with accessing atom mapping
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: MDLQuerySearchMapping.py
   :language: python
   :caption:  Example of substructure search with accessing atom mapping
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: MDLQuerySearchMapping.java
   :language: java
   :caption:  Example of substructure search with accessing atom mapping
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: MDLQuerySearchMapping.cs
   :language: csharp
   :caption:  Example of substructure search with accessing atom mapping
   :refnum:   2
   :frag:     SNIPPET

This problem can be solved in two ways:

1. The explicit hydrogens in the query molecule can be suppressed during
   :oe:cls:`OEQMolBase<OEChem::OEQMolBase>` construction by using the
   :oe:const:`OEChem::OEMDLQueryOpts::SuppressExplicitH` option
   (see example in :oe:src:`Listing 1<SNIPPET-MDLQuerySearchSingleMatch>`).
   A query atom can only be mapped to a target atom if it has at least as many
   implicit hydrogens as explicit hydrogens were removed from the query atom.
   This solution is recommended only if the presence or absence of the query
   substructure is of interest, but not the complete mapping between the query and
   the target.
   The :oe:meth:`SingleMatch<OEChem::OESubSearch::SingleMatch>` function returns
   whether or not the query is present in the target, but the mapping is not
   accessible.

.. index:: OEAddExplicitHydrogens

2. If the complete mapping between the query and the target is of interest,
   the :oe:func:`OEAddExplicitHydrogens<OEChem::OEAddExplicitHydrogens>` function
   has to be called for each target structure before performing the substructure
   search.
   (See example in  :oe:src:`Listing 2<SNIPPET-MDLQuerySearchMapping>`).

In both cases, the query presented in :ref:`Figure: Query<figure_mdlq_explicitH_query>` will match
only target 'C' and 'D' shown in :ref:`Figure: Targets<figure_mdlq_explicitH_targets>`.
:ref:`Figure: Atom mapping<figure_mdlq_explicitH_target_mapping>` shows the three
detected substructures in target 'C' when adding explicit hydrogens to the target structures.

The execution of the substructure search is significantly faster if the hydrogens
are suppressed in the target structures, since the search space can be an
order of magnitude smaller.

.. _figure_mdlq_explicitH_targets:

.. figure:: oechemtk/images/MDLQueryExplicitHMatch.*
   :align: center

   **Targets -- Example of target structures with implicit hydrogens**

.. _figure_mdlq_explicitH_target_mapping:

.. figure:: oechemtk/images/MDLQueryExplicitHMapping.*
   :align: center

   **Atom mapping -- Example of substructure search with atom mapping**


.. _chapter_mmolconformations:

********************************************************************************
Macromolecule Conformations
********************************************************************************

.. _section_alternate_location_factory:

Alternate Locations
================================================================================

.. index:: OEAltLocationFactory, OEAltGroup, OEAltLocation, Alternate Locations

Because macro-molecular structures are usually represented as static
shapes, this gives the mistaken impression that proteins, nucleic acids,
etc. are rigid molecules. In truth, these molecules move around quite
a lot and in a crystal, loops and other bits are often disordered. Crystallographers
work to model multiple conformations in parts of the structure where disorder
is observed. If they can, they include a separate copy of each moving atom for
each conformation, marking each with an 'alternate location code', a
fractional 'occupancy' and a 'temperature factor' quantifying the atom's
thermal motion. Section :ref:`section_biopolymer_residues` discusses how
these properties are stored in an :ref:`OEResidue <OEChem_OEResidue>`.

Because a structure with alternate locations describes an `ensemble of molecules`
rather than a single molecule, they are unsuitable as-is for calculating
molecular properties. Often, this is dealt with by dropping all but the first
alternate location from the molecule and this is what
:oe:func:`OEReadMolecule<OEChem::OEReadMolecule>` does for
Protein Data Bank (PDB) files, by default. The first step in dealing with
alternate locations is to retain all the alternate location atoms
by setting the input flavor before reading the molecule, as shown below.

.. oe:source:: AltlocfactMakeAltMolDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-MAKEALTMOL-FLAVOR

.. oe:source:: AltlocfactMakeAltMolDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-MAKEALTMOL-FLAVOR

.. oe:source:: AltlocfactMakeAltMolDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-MAKEALTMOL-FLAVOR

.. oe:source:: AltlocfactMakeAltMolDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-MAKEALTMOL-FLAVOR

With all the alternate atoms retained, you can use the predicate
:ref:`OEHasAlternateLocation <OEBio_OEHasAlternateLocation>` to identify these atoms.
Although alternate locations are atom properties, they usually
describe the coordinated motion of groups of atoms. Each connected
set of atoms with alternate location codes that move in a coordinated
fashion is called an `alternate location group` (represented by an
:oe:cls:`OEAltGroup<OEBio::OEAltGroup>`) and each conformation
of a group's atoms is called an `alternate location` (represented
by an :oe:cls:`OEAltLocation<OEBio::OEAltLocation>`). The
second step in dealing with alternate locations is to use the
:ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>`, a class that will
manage these groups and locations for you.

.. oe:source:: AltlocfactGroupsDoc.cpp
   :language: c++
   :refnum:   1
   :caption:  Alternate location factory groups
   :frag:     SNIPPET

.. oe:source:: AltlocfactGroupsDoc.py
   :language: python
   :refnum:   1
   :caption:  Alternate location factory groups
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-AltlocfactGroupsDoc.py>`

.. oe:language:: python

.. oe:source:: AltlocfactGroupsDoc.py

.. oe:source:: AltlocfactGroupsDoc.java
   :language: java
   :refnum:   1
   :caption:  Alternate location factory groups
   :frag:     SNIPPET

.. oe:source:: AltlocfactGroupsDoc.cs
   :language: csharp
   :refnum:   1
   :caption:  Alternate location factory groups
   :frag:     SNIPPET

In addition to providing methods to work with alternate locations and
groups, the :oe:cls:`OEAltLocationFactory<OEBio::OEAltLocationFactory>`
corrects its copy of the input source molecule for bond and formal charge problems
caused by atoms having multiple locations (something the standard
molecule perception routines are not setup to handle).

The :oe:cls:`OEAltLocationFactory<OEBio::OEAltLocationFactory>`
also provides methods for manufacturing subset molecules that represent
specific selections among the different groups of alternate locations.
The initial (`primary`) selection is the alternate location in each group
with the largest average occupancy. In the example below, the subset
is for the previous set of location selections plus the location
with code ``'B'`` that includes the residue of the specified atom.

.. oe:source:: AltlocfactMakeAltMolDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-MAKEALTMOL-SSMOL
   :refnum:   2
   :caption:  Making an alternate location factory subset mol

.. oe:source:: AltlocfactMakeAltMolDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-MAKEALTMOL-SSMOL
   :refnum:   2
   :caption:  Making an alternate location factory subset mol

.. oe:source:: AltlocfactMakeAltMolDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-MAKEALTMOL-SSMOL
   :refnum:   2
   :caption:  Making an alternate location factory subset mol

.. oe:source:: AltlocfactMakeAltMolDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-MAKEALTMOL-SSMOL
   :refnum:   2
   :caption:  Making an alternate location factory subset mol

.. _section_dihedral:

Dihedrals and Sidechain Rotamers
================================================================================

.. index:: Sidechain Rotamer, Rotamer, Dihedral, Torsion

The function :oe:func:`OEBio::OEGetRotamers` returns an iterator of 'rotameric'
sidechain conformations for a given amino-acid type, while
:oe:func:`OEBio::OESetRotamer` will set the sidechain chi angles of a specified
:oe:cls:`OEHierResidue<OEBio::OEHierResidue>` or :oe:cls:`OEAtomBase<OEChem::OEAtomBase>` to a given rotamer.
The :oe:const:`Dunbrack<OEBio::OERotamerLibrary::Dunbrack>` [Dunbrack-1997]_, 
:oe:const:`Richardson<OEBio::OERotamerLibrary::Richardson>` [Lovell-2000]_, and 
newer :oe:const:`Richardson_2016<OEBio::OERotamerLibrary::Richardson_2016>` [Hintze-2016]_ 
rotamer libraries are supported.

There are also functions that return backbone
and sidechain dihedral angles
(:oe:func:`OEGetPhi<OEBio::OEGetPhi>`, :oe:func:`OEGetPsi<OEBio::OEGetPsi>`,
:oe:func:`OEGetChis<OEBio::OEGetChis>`, :oe:func:`OEGetTorsion<OEBio::OEGetTorsion>`)
and modify dihedrals (:oe:func:`OESetTorsion<OEBio::OESetTorsion>`).

Swapping Ambiguous Isoelectronic Residue Atoms
================================================================================

.. index:: Swap Ambiguous, OESwapAIEResidueAtoms, AIER

The function :oe:func:`OEBio::OESwapAIEResidueAtoms` exchanges the coordinates
of nitrogen and oxygen atoms in aspartic acid, asparagine,
glutamic acid and glutamine sidechains
and the ND1/CD2 and CE1/NE2 atoms in histidine rings.
These are atoms that may be confused with one another in an
electron density map because they have the same or very similar
electron density and swapping coordinates is occasionally
required to correct an error in a structure.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _chapter_molctordtor:

********************************************************************************
Molecules
********************************************************************************

The :ref:`OEGraphMol <OEChem_OEGraphMol>` is the object
representing a molecule used in most example programs you will find in
**OEChem TK**'s example directories, or in the code examples of this
manual.  An :ref:`OEGraphMol <OEChem_OEGraphMol>` is a concrete class which can
be declared and used for most molecular functions in **OEChem TK**.  Much
of an :ref:`OEGraphMol <OEChem_OEGraphMol>`'s API is defined by the
:ref:`OEMolBase <OEChem_OEMolBase>` abstract base-class.  An
:ref:`OEGraphMol <OEChem_OEGraphMol>` can be passed to any function which takes
an :ref:`OEMolBase <OEChem_OEMolBase>` argument.

.. seealso::

   An :oe:cls:`OEGraphMol<OEChem::OEGraphMol>` contains atoms and
   bonds. Their access is discussed in chapter :ref:`chapter_atombondtraversal`.

.. _section_molctordtor_molcreatedestroy:

Construction and Destruction
================================================================================

.. oe:language:: c++

   **OEChem TK** molecules use C++ constructors and destructors, allowing
   them to be defined and used much like normal variables.  The
   following example represents the smallest possible **OEChem TK**
   program.  This creates a molecule called
   :oe:cls:`OEGraphMol<OEChem::OEGraphMol>` when the program is run,
   and destroys it automatically when the program finishes.

   .. oe:source:: CreateOEGraphMol.cpp
      :language: c++
      :caption:  Create a molecule
      :frag:     SNIPPET

   By using C++ constructors and destructors there is no need to
   explicitly call a function to allocate and initialize the molecule.
   There is also no need to explicitly de-initialize and destroy it
   when we're done.

   Of course, there may be times when it is necessary to create and
   destroy molecules dynamically.  This is possible using C++'s
   ``new`` and ``delete`` operators to allocate a molecule.

   .. oe:source:: CreateOEGraphMolPointer.cpp
      :language: c++
      :caption:  Allocate memory for a molecule
      :frag:     SNIPPET

   .. note::

      An :ref:`OEGraphMol <OEChem_OEGraphMol>` is essentially a smart pointer
      around any arbitrary :ref:`OEMolBase <OEChem_OEMolBase>`
      implementation. If dynamic allocation is truly needed it is
      often more beneficial to use the factory function
      :oe:func:`OEChem::OENewMolBase`.

.. oe:language:: python

   The example below represents the smallest possible Python **OEChem TK**
   program.  This program creates an :ref:`OEGraphMol <OEChem_OEGraphMol>` called
   ``mol`` when run.  When the program ends, Python automatically
   cleans up the molecule when there are no more references to it.

   .. oe:source:: CreateOEGraphMol.py
      :language: python
      :caption:  Create a molecule
      :frag:     SNIPPET

   There may be times when you want to delete (destroy) a molecule
   before the end of the script. This can be done by using the
   built-in command, ``del``.

   .. oe:source:: DestroyOEGraphMol.py
      :language: python
      :caption:  Destroy a molecule
      :frag:     SNIPPET

.. oe:language:: java

   The example below represents the smallest possible Java **OEChem TK**
   program.  This program creates an :ref:`OEGraphMol <OEChem_OEGraphMol>` called
   ``mol`` when run.  When the program ends, Java automatically
   cleans up the molecule when there are no more references to it.

   .. oe:source:: CreateOEGraphMol.java
      :language: java
      :caption:  Create a molecule
      :frag:     SNIPPET

.. oe:language:: csharp

   The example below represents the smallest possible C\# **OEChem TK**
   program.  This program creates an :ref:`OEGraphMol <OEChem_OEGraphMol>` called
   ``mol`` when run.  When the program ends, C# automatically
   cleans up the molecule when there are no more references to it.

   .. oe:source:: CreateOEGraphMol.cs
      :language: csharp
      :caption:  Create a molecule
      :frag:     SNIPPET

.. _section_molctordtor_molfromsmiles:

Construction from SMILES
================================================================================

.. index :: SMILES

A common method of creating a molecule in **OEChem TK** is via the SMILES
representation. SMILES notation is commonly used in chemical
information systems, as it provides a convenient string representation
of a molecule. An introduction to SMILES syntax is provided in chapter
:ref:`chapter_SMILES`. The following examples will use the SMILES
``c1ccccc1`` which describes the molecule benzene. A molecule can be
created from a SMILES string using the :oe:func:`OEChem::OESmilesToMol`
function. Similarly, a molecule can be created from a CXSMILES string
using the :oe:func:`OEChem::OECXSMILESToMol`

.. oe:source:: CreateOEGraphMolFromSMILES.cpp
   :language: c++
   :caption:  Creating a molecule from a SMILES string (version 1)
   :frag:     SNIPPET

.. oe:source:: CreateOEGraphMolFromSMILES.py
   :language: python
   :caption:  Creating a molecule from a SMILES string (version 1)
   :frag:     SNIPPET

.. oe:source:: CreateOEGraphMolFromSMILES.java
   :language: java
   :caption:  Creating a molecule from a SMILES string (version 1)
   :frag:     SNIPPET

.. oe:source:: CreateOEGraphMolFromSMILES.cs
   :language: csharp
   :caption:  Creating a molecule from a SMILES string (version 1)
   :frag:     SNIPPET

The :oe:func:`OEChem::OESmilesToMol` function returns a boolean value
indicating whether the input string was a valid SMILES representation
of a molecule. It is good programming practice to check the return
value and report an error message if anything went wrong.
The following example shows adding a check on the return status of
:oe:func:`OEChem::OESmilesToMol` and printing an error message if the
string was not a valid SMILES representation of a molecule.

.. oe:source:: OEGraphMolFromSMILESCheck.cpp
   :language: c++
   :caption:  Creating a molecule from a SMILES string (version 2)
   :frag:     SNIPPET

.. oe:source:: OEGraphMolFromSMILESCheck.py
   :language: python
   :caption:  Creating a molecule from a SMILES string (version 2)
   :frag:     SNIPPET

.. oe:source:: OEGraphMolFromSMILESCheck.java
   :language: java
   :caption:  Creating a molecule from a SMILES string (version 2)
   :frag:     SNIPPET

.. oe:source:: OEGraphMolFromSMILESCheck.cs
   :language: csharp
   :caption:  Creating a molecule from a SMILES string (version 2)
   :frag:     SNIPPET

The :oe:func:`OEChem::OESmilesToMol` is considered a **high-level** function.
In addition, to parsing the given SMILES string, the
:oe:func:`OEChem::OESmilesToMol` function also perceives:

* the rings of the molecule, by invoking the  :oe:func:`OEChem::OEFindRingAtomsAndBonds` function
* the aromaticity of the molecule, by calling the :oe:func:`OEChem::OEAssignAromaticFlags`
  function using the :oe:const:`OEChem::OEAroModel::OpenEye` aromaticity model
* the chirality of the molecule, by calling the :oe:func:`OEChem::OEPerceiveChiral`
  function

In cases where you want to preserve the aromaticity of the SMILES string (or the lack of it),
a **low-level** :oe:func:`OEChem::OEParseSmiles`
function can be used.
For example, if benzene is expressed as ``c1ccccc1``, all atoms and bonds
are marked as aromatic. But if it is expressed as a |Kekule| form,
``C1=CC=CC=C1``, all atoms and bonds are kept aliphatic.
The aromaticity of the molecule can be perceived by calling the
:oe:func:`OEChem::OEAssignAromaticFlags` function.

.. oe:source:: OEGraphMolFromSMILESAromatic.cpp
   :language: c++
   :caption:  Creating molecules from a SMILES string (version 3)
   :frag:     SNIPPET

.. oe:source:: OEGraphMolFromSMILESAromatic.py
   :language: python
   :caption:  Creating molecules from a SMILES string (version 3)
   :frag:     SNIPPET

.. oe:source:: OEGraphMolFromSMILESAromatic.java
   :language: java
   :caption:  Creating molecules from a SMILES string (version 3)
   :frag:     SNIPPET

.. oe:source:: OEGraphMolFromSMILESAromatic.cs
   :language: csharp
   :caption:  Creating molecules from a SMILES string (version 3)
   :frag:     SNIPPET

The output of the preceding program is the following:

.. code-block:: console

   Number of aromatic atoms = 0
   Number of aromatic atoms = 6

.. hint::

   We highly recommend the use of the :oe:func:`OEChem::OESmilesToMol`
   function when creating a molecule from a SMILES string.

   We highly recommend the use of the :oe:func:`OEChem::OECXSMILESToMol`
   function when creating a molecule from either a SMILES or CXSMILES string
   and the specific format is not known.

.. seealso::

   * :ref:`chapter_aromaticity` chapter for further information about aromaticity models.
   * :oe:func:`OEChem::OESmilesToMol`
   * :oe:func:`OEChem::OECXSMILESToMol`

.. _section_molctordtor_molreuse:

Reuse
================================================================================

Consider the following code examples to parse two separate SMILES strings,
benzene and phenol, and print the number of heavy atoms in each.

.. oe:source:: ReuseMoleculeOESmilesToMol.cpp
   :language: c++
   :caption:  Reusing a molecule (OESmilesToMol)
   :frag:     SNIPPET

.. oe:source:: ReuseMoleculeOESmilesToMol.py
   :language: python
   :caption:  Reusing a molecule (OESmilesToMol)
   :frag:     SNIPPET

.. oe:source:: ReuseMoleculeOESmilesToMol.java
   :language: java
   :caption:  Reusing a molecule (OESmilesToMol)
   :frag:     SNIPPET

.. oe:source:: ReuseMoleculeOESmilesToMol.cs
   :language: csharp
   :caption:  Reusing a molecule (OESmilesToMol)
   :frag:     SNIPPET

The **high-level** :oe:func:`OEChem::OESmilesToMol` function automatically
clears the molecule before parsing the SMILES string.
The output of the preceding program is the following:

.. code-block:: console

   Number of benzene atoms: 6
   Number of phenol atoms: 7

.. oe:source:: ReuseMolecule.cpp
   :language: c++
   :caption:  Reusing a molecule (OEParseSmiles)
   :frag:     SNIPPET

.. oe:source:: ReuseMolecule.py
   :language: python
   :caption:  Reusing a molecule (OEParseSmiles)
   :frag:     SNIPPET

.. oe:source:: ReuseMolecule.java
   :language: java
   :caption:  Reusing a molecule (OEParseSmiles)
   :frag:     SNIPPET

.. oe:source:: ReuseMolecule.cs
   :language: csharp
   :caption:  Reusing a molecule (OEParseSmiles)
   :frag:     SNIPPET

In the second example the **low-level** :oe:func:`OEChem::OEParseSmiles`
function is called.
The output of the preceding program is the following:

.. code-block:: console

   Number of benzene atoms: 6
   Number of phenol atoms: 13

The second line, ``Number of phenol atoms: 13``, will be surprising to
some. The behavior of the :oe:func:`OEChem::OEParseSmiles` function is to
**add** the given SMILES to the current molecule. **OEChem TK** provides a
mechanism for reusing a molecule by calling the
:oe:meth:`Clear<OEChem::OEMolBase::Clear>` method.
:oe:meth:`Clear<OEChem::OEMolBase::Clear>` deletes all atoms and bonds
of a molecule, thereby resetting a molecule into its original "empty"
state.

.. oe:source:: ReuseMoleculeClear.cpp
   :language: c++
   :caption:  Clearing and reusing a molecule (OEParseSmiles)
   :frag:     SNIPPET

.. oe:source:: ReuseMoleculeClear.py
   :language: python
   :caption:  Clearing and reusing a molecule (OEParseSmiles)
   :frag:     SNIPPET

.. oe:source:: ReuseMoleculeClear.java
   :language: java
   :caption:  Clearing and reusing a molecule (OEParseSmiles)
   :frag:     SNIPPET

.. oe:source:: ReuseMoleculeClear.cs
   :language: csharp
   :caption:  Clearing and reusing a molecule (OEParseSmiles)
   :frag:     SNIPPET

The output of the preceding program is the following

.. code-block:: console

   Number of benzene atoms: 6
   Number of phenol atoms: 7

Using the :oe:meth:`Clear<OEChem::OEMolBase::Clear>` method is
recommended, for example, when processing multiple molecules
sequentially in a database. Instead of requiring a new molecule to be
allocated and destroyed for each entry, the
:oe:meth:`Clear<OEChem::OEMolBase::Clear>` method can be used to reset
a molecule to its initial "empty" state.

.. _section_molctordtor_smilesfrommol:

Unique Representation
================================================================================

It is sometimes useful to generate a unique representation of a
molecule for use as an identifier for a database key. The compact
nature of SMILES strings makes them ideal candidates for the
task. However, the same molecule can be represented by many different
SMILES strings. **OEChem TK** features an advanced algorithm for
generating a (unique) :term:`canonical isomeric SMILES` string.
A canonical isomeric SMILES string can be generated from a molecule
by calling the :oe:func:`OEChem::OEMolToSmiles` or :oe:func:`OEChem::OEMolToCXSMILES` functions.

.. oe:source:: OEMolToSmiles.cpp
   :language: c++
   :caption:  Creating a canonical isomeric SMILES string from a molecule
   :frag:     SNIPPET

.. oe:source:: OEMolToSmiles.py
   :language: python
   :caption:  Creating a canonical isomeric SMILES string from a molecule
   :frag:     SNIPPET

.. oe:source:: OEMolToSmiles.java
   :language: java
   :caption:  Creating a canonical isomeric SMILES string from a molecule
   :frag:     SNIPPET

.. oe:source:: OEMolToSmiles.cs
   :language: csharp
   :caption:  Creating a canonical isomeric SMILES string from a molecule
   :frag:     SNIPPET

The output of the preceding program is the following:

.. code-block:: console

   Canonical isomeric SMILES is c1ccccc1

The following slightly more complicated example reads SMILES from
standard input and writes the corresponding :term:`canonical isomeric SMILES` to
standard output.

.. oe:source:: OEMolToSmilesRW.cpp
   :language: c++
   :caption:  Creating canonical isomeric SMILES strings
   :frag:     SNIPPET

.. oe:source:: OEMolToSmilesRW.py
   :language: python
   :caption:  Creating canonical isomeric SMILES strings
   :frag:     SNIPPET

.. oe:source:: OEMolToSmilesRW.java
   :language: java
   :caption:  Creating canonical isomeric SMILES strings
   :frag:     SNIPPET

.. oe:source:: OEMolToSmilesRW.cs
   :language: csharp
   :caption:  Creating canonical isomeric SMILES strings
   :frag:     SNIPPET

.. table::

   ========================= ===========================================
   input                     output (:term:`canonical isomeric SMILES`)
   ========================= ===========================================
   C1CCCN[C@@H]1(O)          C1CCN[C@@H](C1)O
   C1CN[C@H](O)CC1           C1CCN[C@@H](C1)O
   C1CC[C@H](O)CC1           C1CC[C@@H](CC1)O
   C1CCC(O)CC1               C1CCC(CC1)O
   C1=NC=CN1C[C@H](N)C(=O)O  c1cn(cn1)C[C@@H](C(=O)O)N
   ========================= ===========================================

The :oe:func:`OEChem::OEMolToSmiles` and :oe:func:`OEChem::OEMolToCXSMILES` functions
are considered a **high-level** functions.
Prior to creating the :term:`canonical isomeric SMILES`, the
:oe:func:`OEChem::OEMolToSmiles` function perceives the following properties
*if necessary*:

* the rings of the molecule, by using :oe:func:`OEChem::OEFindRingAtomsAndBonds`.
* the aromaticity of the molecule, by calling the :oe:func:`OEChem::OEAssignAromaticFlags`.
  function using the :oe:const:`OEChem::OEAroModel::OpenEye` aromaticity model
* the atom and bond stereochemistry.

It is also possible to generate :term:`canonical SMILES` without
isomeric information by using the :oe:func:`OEChem::OECreateCanSmiString`
**low-level** function.
As was shown in the :ref:`section_molctordtor_molfromsmiles` section,
:oe:func:`OEChem::OEParseSmiles` preserves the aromaticity present in
the input SMILES string.  The function
:oe:func:`OEChem::OEAssignAromaticFlags` has to be used to perceive
aromaticity in a molecule.

.. oe:source:: CreateSMILESFromOEGraphMolRW.cpp
   :language: c++
   :caption:  Creating canonical SMILES strings
   :frag:     SNIPPET

.. oe:source:: CreateSMILESFromOEGraphMolRW.py
   :language: python
   :caption:  Creating canonical SMILES strings
   :frag:     SNIPPET

.. oe:source:: CreateSMILESFromOEGraphMolRW.java
   :language: java
   :caption:  Creating canonical SMILES strings
   :frag:     SNIPPET

.. oe:source:: CreateSMILESFromOEGraphMolRW.cs
   :language: csharp
   :caption:  Creating canonical SMILES strings
   :frag:     SNIPPET

Notice that the preceding program does not construct and destruct
molecules each time through the loop, but rather uses the
:oe:meth:`Clear<OEChem::OEMolBase::Clear>` function to reuse the
molecule.  If the line ``mol.Clear()`` were removed from the program,
the output would contain longer and longer SMILES containing
disconnected fragments. See section
:ref:`section_molctordtor_molreuse` for more details.

.. table::

   ====================== ===================================
   input                  output (:term:`canonical SMILES`)
   ====================== ===================================
   c1cccnc1(O)            c1ccnc(c1)O
   C1=CC=CC=C1            c1ccccc1
   C1=CN=CC=C1            c1ccncc1
   C1=CC=CC=N1            c1ccncc1
   C1=NC=CN1CCC(=O)O      c1cn(cn1)CCC(=O)O
   ====================== ===================================

.. hint::

   We highly recommend the usage of the :oe:func:`OEChem::OEMolToSmiles`
   function when creating a SMILES string.

   We highly recommend the usage of the :oe:func:`OEChem::OEMolToCXSMILES`
   function when structures may contain enhanced stereogroup information.

.. seealso::

   * :oe:func:`OEChem::OEMolToSmiles`
   * :oe:func:`OEChem::OEMolToCXSMILES`

.. _section_molctordtor_inchifrommol:

InChI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Canonical SMILES is not the only unique representation available.
The IUPAC International Chemical Identifier (InChI), and its corresponding
hashkey representation (InChIKey) are also unique to the compound
they describe [InChI-2013]_.
InChIs can be created from molecules using the :oe:func:`OEChem::OECreateInChI`,
:oe:func:`OEChem::OEMolToInChI`, or :oe:func:`OEChem::OEMolToSTDInChI` functions.

.. oe:source:: CreateStandardInChI.cpp
   :language: c++
   :caption:  Creating standard InChI
   :frag:     SNIPPET

.. oe:source:: CreateStandardInChI.py
   :language: python
   :caption:  Creating standard InChI
   :frag:     SNIPPET

.. oe:source:: CreateStandardInChI.java
   :language: java
   :caption:  Creating standard InChI
   :frag:     SNIPPET

.. oe:source:: CreateStandardInChI.cs
   :language: csharp
   :caption:  Creating standard InChI
   :frag:     SNIPPET

.. table::

   =============================================== ===============================================
   input (SMILES)                                  output (Standard InChI)
   =============================================== ===============================================
   c1ccnc(c1)O                                     InChI=1S/C5H5NO/c7-5-3-1-2-4-6-5/h1-4H,(H,6,7)
   =============================================== ===============================================

.. note::

   The 'S' in 'InChI=1S' denotes standard InChI.

The following slightly more complicated example reads InChI strings from
standard input and writes InChI strings to standard output.

.. oe:source:: OEMolToInChIRW.cpp
   :language: c++
   :caption:  Reading and writing InChI strings
   :frag:     SNIPPET

.. oe:source:: OEMolToInChIRW.py
   :language: python
   :caption:  Reading and writing InChI strings
   :frag:     SNIPPET

.. oe:source:: OEMolToInChIRW.java
   :language: java
   :caption:  Reading and writing InChI strings
   :frag:     SNIPPET

.. oe:source:: OEMolToInChIRW.cs
   :language: csharp
   :caption:  Reading and writing InChI strings
   :frag:     SNIPPET

A nonstandard InChI can be generated by passing in an :ref:`OEInChIOptions <OEChem_OEInChIOptions>`
object to the :oe:func:`OEChem::OECreateInChI` function.
The options available are documented in the :ref:`OEInChIOptions <OEChem_OEInChIOptions>` class.

.. oe:source:: CreateNonStandardInChI.cpp
   :language: c++
   :caption:  Creating nonstandard InChI strings
   :frag:     SNIPPET

.. oe:source:: CreateNonStandardInChI.py
   :language: python
   :caption:  Creating nonstandard InChI strings
   :frag:     SNIPPET

.. oe:source:: CreateNonStandardInChI.java
   :language: java
   :caption:  Creating nonstandard InChI strings
   :frag:     SNIPPET

.. oe:source:: CreateNonStandardInChI.cs
   :language: csharp
   :caption:  Creating nonstandard InChI strings
   :frag:     SNIPPET

.. table::

   ===================================================== =====================================================
   input (SMILES)                                        output (nonstandard InChI)
   ===================================================== =====================================================
   c1ccnc(c1)O                                           InChI=1/C5H5NO/c7-5-3-1-2-4-6-5/h1-4H,(H,6,7)/f/h7H
   ===================================================== =====================================================

The 27-character-long InChIKey is made of three parts connected by hyphens.
The first part is 14 characters long and is based on the connectivity and 
proton layers of an InChI string. The second part, contains 9 characters 
that are related to all other InChI layers (isotopes, stereochemistry, etc.) 
and also contains the version of InChI and its standard/nonstandard property
in the last two characters. The third part is one letter, describing the 
(de)protonation layer of the original InChI.

.. oe:source:: CreateInChIKey.cpp
   :language: c++
   :caption:  CreateInChIKey
   :frag:     SNIPPET

.. oe:source:: CreateInChIKey.py
   :language: python
   :caption:  CreateInChIKey
   :frag:     SNIPPET

.. oe:source:: CreateInChIKey.java
   :language: java
   :caption:  CreateInChIKey
   :frag:     SNIPPET

.. oe:source:: CreateInChIKey.cs
   :language: csharp
   :caption:  CreateInChIKey
   :frag:     SNIPPET

.. table::

   ================================= =================================
   input (**SMILES**)                output (InChI Key)
   ================================= =================================
   c1ccnc(c1)O                       UBQKCCHYAOITMY-UHFFFAOYSA-N
   ================================= =================================


.. _chapter_moldatabase:

********************************************************************************
Molecular Database Handling
********************************************************************************

.. index:: OEMolDatabase, file formats

The :ref:`OEMolDatabase <OEChem_OEMolDatabase>` class provides a fundamentally
different abstraction over a molecule file than the combination of
:ref:`oemolistream <OEChem_oemolistream>` and
:oe:func:`OEChem::OEReadMolecule`. The central underlying principle
utilized by this class is that many operations can be performed on a
molecular file without requiring the overhead of fully parsing the
molecule record into an :ref:`OEMolBase <OEChem_OEMolBase>` object. Instead, we
can think of a molecular file as a database that can be manipulated
with much cheaper operations than :oe:func:`OEChem::OEReadMolecule` and
:oe:func:`OEChem::OEWriteMolecule`.

.. _section_open_and_read:

Opening and Reading
================================================================================

:ref:`OEMolDatabase <OEChem_OEMolDatabase>` objects provide the ability to access
any molecule in a molecular database file in constant time,
``O(1)``. This is accomplished by paying the overhead of scanning the
file during the :oe:meth:`OEChem::OEMolDatabase::Open` call. However,
:oe:meth:`OEChem::OEMolDatabase::Open` is designed to operate extremely
fast on any molecule file format **OEChem TK**
supports. :oe:meth:`OEChem::OEMolDatabase::Open` is usually limited by
disk bandwidth instead of parsing and perception like
:oe:func:`OEChem::OEReadMolecule` and
:oe:func:`OEChem::OEWriteMolecule`.

After a database file is opened, the memory overhead of
:ref:`OEMolDatabase <OEChem_OEMolDatabase>` is minimal since no molecules are
stored in memory. Instead, the :ref:`OEMolDatabase <OEChem_OEMolDatabase>` only
stores a 8 byte file offset for each molecule record in the
file. :oe:src:`Listing 1<SNIPPET-NthMolecule>` demonstrates how to utilize this
feature to retrieve the "Nth" molecule from a molecule file using the
:oe:meth:`OEChem::OEMolDatabase::GetMolecule` method.

.. oe:source:: NthMolecule.cpp
   :language: c++
   :refnum:   1
   :caption:  Retrieving the Nth molecule in a file
   :frag:     SNIPPET

.. oe:source:: NthMolecule.py
   :language: python
   :refnum:   1
   :caption:  Retrieving the Nth molecule in a file
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-NthMolecule.py>`

.. oe:source:: NthMolecule.java
   :language: java
   :refnum:   1
   :caption:  Retrieving the Nth molecule in a file
   :frag:     SNIPPET

.. oe:source:: NthMolecule.cs
   :language: csharp
   :refnum:   1
   :caption:  Retrieving the Nth molecule in a file
   :frag:     SNIPPET

:oe:src:`Listing 1<SNIPPET-NthMolecule>` checks the return value of
:oe:meth:`OEChem::OEMolDatabase::GetMolecule` for false, indicating the
molecule record at that position in the file does not contain a valid
molecule. For example, molecules without any atoms are valid records
in :file:`.sdf` files.

.. note::

   :oe:meth:`OEChem::OEMolDatabase::Open` is still a ``O(N)`` operation
   in order to know the position of each molecule record in the
   file. However, this method is significantly cheaper than using
   :oe:func:`OEChem::OEReadMolecule`, instead being limited by hard
   disk bandwidth instead of processing speed. The
   :oe:meth:`OEChem::OEMolDatabase::Open` method can also be sped up by
   creating an associated :file:`.idx` file as described by the
   :ref:`section_index_files` section.

.. _section_direct_data_access:

Direct Data Access
================================================================================

:ref:`OEMolDatabase <OEChem_OEMolDatabase>` achieves much of its speed by treating
molecules as chunks of bytes instead of :ref:`OEMolBase <OEChem_OEMolBase>`
objects. This abstraction is leaked a little bit by providing users
the ability to access the raw bytes of the molecule record as well
through the :oe:meth:`OEChem::OEMolDatabase::GetMolecule` method that
takes a :ref:`oemolostream <OEChem_oemolostream>`. For example, the user could
pass this method a :ref:`oemolostream <OEChem_oemolostream>` that has been opened
with :oe:meth:`OEChem::oemolostream::openstring` in order to dump the
desired bytes to an in memory buffer. :oe:src:`Listing
2<SNIPPET-DatabaseSubset>` demonstrates how to use this feature to retrieve a
subset of molecules from a database file similar to how the ``LIMIT``
and ``OFFSET`` keywords work for an SQL query.

.. oe:source:: DatabaseSubset.cpp
   :language: c++
   :refnum:   2
   :caption:  Retrieving a subset of a file
   :frag:     SNIPPET

.. oe:source:: DatabaseSubset.py
   :language: python
   :refnum:   2
   :caption:  Retrieving a subset of a file
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-DatabaseSubset.py>`

.. oe:source:: DatabaseSubset.java
   :language: java
   :refnum:   2
   :caption:  Retrieving a subset of a file
   :frag:     SNIPPET

.. oe:source:: DatabaseSubset.cs
   :language: csharp
   :refnum:   2
   :caption:  Retrieving a subset of a file
   :frag:     SNIPPET

.. note::

   The :ref:`oemolostream <OEChem_oemolostream>` must be set up to write output to
   the exact same file format that the :ref:`OEMolDatabase <OEChem_OEMolDatabase>`
   is opened on. If file format conversion is also desired during the
   read operation, the user should user
   :oe:meth:`OEChem::OEMolDatabase::GetMolecule` to read the molecule
   into an :ref:`OEMolBase <OEChem_OEMolBase>` and then use
   :oe:func:`OEChem::OEWriteMolecule`.

.. _section_title_access:

Title Access
================================================================================

Molecule meta-data is often useful for manipulating databases
regardless of the molecule connection table. For this reason the
:ref:`OEMolDatabase <OEChem_OEMolDatabase>` provides access to the molecule title
through the :oe:meth:`OEChem::OEMolDatabase::GetTitle` method. The
:oe:meth:`OEChem::OEMolDatabase::GetTitle` returns the same string that
would be returned by :oe:meth:`OEChem::OEMolBase::GetTitle` if the
molecule was read in with :oe:func:`OEChem::OEReadMolecule`. The
difference is that the :oe:meth:`OEChem::OEMolDatabase::GetTitle`
method is more efficient because it will only parse the title from the
molecule record, and skip the rest of the bytes in the molecule
record. :oe:src:`Listing 3<SNIPPET-DatabaseExtract>` demonstrates how to use
:oe:meth:`OEChem::OEMolDatabase::GetTitle` to implement a more
efficient version of the :oe:src:`molextract` example.

.. oe:source:: DatabaseExtract.cpp
   :language: c++
   :refnum:   3
   :caption:  Extract molecules by title
   :frag:     SNIPPET

.. oe:source:: DatabaseExtract.py
   :language: python
   :refnum:   3
   :caption:  Extract molecules by title
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-DatabaseExtract.py>`

.. oe:source:: DatabaseExtract.java
   :language: java
   :refnum:   3
   :caption:  Extract molecules by title
   :frag:     SNIPPET

.. oe:source:: DatabaseExtract.cs
   :language: csharp
   :refnum:   3
   :caption:  Extract molecules by title
   :frag:     SNIPPET

.. note::

   Multi-conformer :file:`.oeb` files can have multiple titles per
   molecule record. The top-level :ref:`OEMCMolBase <OEChem_OEMCMolBase>` can
   have a title, as well as each :ref:`OEConfBase <OEChem_OEConfBase>` can have
   a title. :oe:meth:`OEChem::OEMolDatabase::GetTitle` will only return
   the title of the top-level :ref:`OEMCMolBase <OEChem_OEMCMolBase>` object and
   make no attempt to search for a title among the conformer data. In
   practice, this is fine since *OMEGA* will leave the
   :ref:`OEMCMolBase <OEChem_OEMCMolBase>` title the same as the input file, and
   append warts to the individual conformer titles.

.. _section_index_files:

Index Files
================================================================================

The speed of :oe:meth:`OEChem::OEMolDatabase::Open` is limited by how
fast data can be read from disk. For this reason, file position
offsets can be precomputed and stored in a parallel :file:`.idx`
file. :oe:meth:`OEChem::OEMolDatabase::Open` will automatically detect
the presence of this file based upon the file name of the file being
opened and use those file offsets instead. For example, if the
database file is called, "my_corporate_conformers.oeb",
:oe:meth:`OEChem::OEMolDatabase::Open` will look for a file named
"my_corporate_conformers.oeb.idx" to open as an index file. If an index
file can not be located, a full file scan will occur instead. For
files written once, and read many times, it can be highly beneficial
to create a parallel index file with the
:oe:func:`OEChem::OECreateMolDatabaseIdx` function.

.. note::

   :oe:meth:`OEChem::OEMolDatabase::Save` will automatically create a
   :file:`.idx` file parallel to the file being saved. This behavior
   can be modified by the
   :oe:meth:`OEChem::OEMolDatabaseSaveOptions::SetWriteIdx` method on
   the :ref:`OEMolDatabaseSaveOptions <OEChem_OEMolDatabaseSaveOptions>` options class.

.. seealso::

   * :oe:func:`OEChem::OEGetMolDatabaseIdxFileName` for the default way
     index file names are created.

.. _section_database_generic_data:

Database Generic Data
================================================================================

:ref:`OEMolDatabase <OEChem_OEMolDatabase>` inherits from
:ref:`OEBase <OESystem_OEBase>`, allowing it to contain and round-trip
generic data as described in the :ref:`chapter_genericdata`
chapter. This data is only written and read from :file:`.oeb`
files. It is stored in the :file:`.oeb` file as a
:ref:`OEHeader <OESystem_OEHeader>` record at the beginning of the
file. :oe:meth:`OEChem::OEMolDatabase::Save` will write this record
back out the :file:`.oeb` file so that it be read by a subsequent
:oe:meth:`OEChem::OEMolDatabase::Open` operation.

.. _section_database_caveats:

Caveats
================================================================================

.. warning::

   :ref:`OEMolDatabase <OEChem_OEMolDatabase>` will make an uncompressed copy of a
   molecular database file when opened on a :file:`.gz`, GZipped
   file. The temporary file will be deleted upon the destruction of
   the :ref:`OEMolDatabase <OEChem_OEMolDatabase>` object, however, it is still
   recommended to not use :file:`.gz` files with
   :ref:`OEMolDatabase <OEChem_OEMolDatabase>` if it can be avoided. If a
   different directory is desired for the uncompressed file, alter the
   environment variables used by the
   :oe:func:`OEPlatform::OEFileTempPath` function.

The largest caveat when working with :ref:`OEMolDatabase <OEChem_OEMolDatabase>`
objects is that they require a file on disk to provide storage. This
allows the object to have a very small in-memory footprint at the
expense of higher latency access to individual molecule records. The
:ref:`OEMolDatabase <OEChem_OEMolDatabase>` object makes no attempt to cache
molecules that may be frequently read, instead leaving this up to the
user at a higher level, or up to the operating system to cache frequently
accessed disk pages.

The above reason is why :file:`.gz` files are not well supported. The
:ref:`OEMolDatabase <OEChem_OEMolDatabase>` needs to be able to read a molecule
record by seeking to a particular location in the file. Though the
result is that multi-threaded applications can efficiently call
``const`` :ref:`OEMolDatabase <OEChem_OEMolDatabase>` methods like
:oe:meth:`OEChem::OEMolDatabase::GetMolecule` without any
synchronization overhead.


.. _chapter_molproperties:

********************************************************************************
Molecule Properties
********************************************************************************

.. index:: OEMolBase

Molecules in **OEChem TK** are represented by
:oe:cls:`OEMolBases<OEChem::OEMolBase>`. In addition to keeping track
of the atoms and bonds that constitute a molecule, the
:ref:`OEMolBase <OEChem_OEMolBase>` is also used to store global information
and :ref:`chapter_genericdata` about the molecule.

.. _section_molproperties_readwrite:

Read/Write Molecule Properties
================================================================================

The :ref:`OEMolBase <OEChem_OEMolBase>` API provides the following methods for
storing common global information about the molecule.

.. index:: molecule dimension, molecule energy, reaction molecule, molecule title

.. list-table::
   :widths: 30 15 20 20 30
   :header-rows: 1

   * - Property Name
     - Type
     - Get Method
     - Set Method
     - See Also
   * - Coordinates
     - ``float`` array
     - :oe:meth:`GetCoords<OEChem::OEMolBase::GetCoords>`
     - :oe:meth:`SetCoords<OEChem::OEMolBase::SetCoords>`
     - :oe:meth:`ClearCoords<OEChem::OEMolBase::ClearCoords>`
   * - Dimension
     - ``unsigned int``
     - :oe:meth:`GetDimension<OEChem::OEMolBase::GetDimension>`
     - :oe:meth:`SetDimension<OEChem::OEMolBase::SetDimension>`
     -
   * - Energy
     - ``float``
     - :oe:meth:`GetEnergy<OEChem::OEMolBase::GetEnergy>`
     - :oe:meth:`SetEnergy<OEChem::OEMolBase::SetEnergy>`
     -
   * - Perception
     - ``bool``
     - :oe:meth:`HasPerceived<OEChem::OEMolBase::HasPerceived>`
     - :oe:meth:`SetPerceived<OEChem::OEMolBase::SetPerceived>`
     -
   * - Rxn
     - ``bool``
     - :oe:meth:`IsRxn<OEChem::OEMolBase::IsRxn>`
     - :oe:meth:`SetRxn<OEChem::OEMolBase::SetRxn>`
     - :ref:`chapter_reactions`
   * - Title
     - ``string``
     - :oe:meth:`GetTitle<OEChem::OEMolBase::GetTitle>`
     - :oe:meth:`SetTitle<OEChem::OEMolBase::SetTitle>`
     - :ref:`section_mprop_title`

.. _section_mprop_title:

Title
================================================================================

.. index:: molecule title

The **Title** property is a string used to represent the name of the
molecule.  The default value is an empty string.  This field may be used
to store a registry number or other identifier, instead of a common name.
The string is typically trimmed of white space by most file format
readers.

The following code uses the :oe:meth:`GetTitle<OEChem::OEMolBase::GetTitle>`
method to list the names of the molecules in a file.
The input file is read and the list of identifiers
(molecule names) are written to standard-out.

.. oe:source:: GetTitle.cpp
   :language: c++
   :caption:  Printing molecule titles
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: GetTitle.py
   :language: python
   :caption:  Printing molecule titles
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: GetTitle.java
   :language: java
   :caption:  Printing molecule titles
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: GetTitle.cs
   :language: csharp
   :caption:  Printing molecule titles
   :refnum:   1
   :frag:     SNIPPET

.. _section_molproperties_atomsandbonds:

Atoms and Bonds
================================================================================

The :ref:`OEMolBase <OEChem_OEMolBase>` API provides the following methods for
accessing and altering the connection table of the molecule.

.. index:: number of atoms, number of bonds, maximum atom index, maximum bond index

.. list-table::
   :widths: 30 15 20 30
   :header-rows: 1

   * - Description
     - Return Type
     - Method
     - See Also
   * - Number of Atoms
     - ``unsigned int``
     - :oe:meth:`NumAtoms<OEChem::OEMolBase::NumAtoms>`
     -
   * - Number of Bonds
     - ``unsigned int``
     - :oe:meth:`NumBonds<OEChem::OEMolBase::NumBonds>`
     -
   * - Maximum Atom Index
     - ``unsigned int``
     - :oe:meth:`GetMaxAtomIdx<OEChem::OEMolBase::GetMaxAtomIdx>`
     - :ref:`chapter_atombondindices`
   * - Maximum Bond Index
     - ``unsigned int``
     - :oe:meth:`GetMaxBondIdx<OEChem::OEMolBase::GetMaxBondIdx>`
     - :ref:`chapter_atombondindices`
   * - Access to an Atom
     - :oe:cls:`OEAtomBase<OEChem::OEAtomBase>`
     - :oe:meth:`GetAtom<OEChem::OEMolBase::GetAtom>`
     - :ref:`chapter_predicates`
   * - Access to a Bond
     - :oe:cls:`OEBondBase<OEChem::OEBondBase>`
     - :oe:meth:`GetBond<OEChem::OEMolBase::GetBond>`
     - :ref:`chapter_predicates`
   * - Access to all Atoms
     - :oe:cls:`OEIterBase\<OEAtomBase><OESystem::OEIterBase>`
     - :oe:meth:`GetAtoms<OEChem::OEMolBase::GetAtoms>`
     - :ref:`chapter_atombondtraversal`
   * - Access to all Bonds
     - :oe:cls:`OEIterBase\<OEBondBase><OESystem::OEIterBase>`
     - :oe:meth:`GetBonds<OEChem::OEMolBase::GetBonds>`
     - :ref:`chapter_atombondtraversal`
   * - Create a new Atom
     - :ref:`OEAtomBase <OEChem_OEAtomBase>`
     - :oe:meth:`NewAtom<OEChem::OEMolBase::NewAtom>`
     - :ref:`section_molproperties_atomandbondcreation`
   * - Create a new Bond
     - :ref:`OEBondBase <OEChem_OEBondBase>`
     - :oe:meth:`NewBond<OEChem::OEMolBase::NewBond>`
     - :ref:`section_molproperties_atomandbondcreation`
   * - Remove an Atom
     - ``bool``
     - :oe:meth:`DeleteAtom<OEChem::OEMolBase::DeleteAtom>`
     -
   * - Remove a Bond
     - ``bool``
     - :oe:meth:`DeleteBond<OEChem::OEMolBase::DeleteBond>`
     -
   * - Rearrange Atoms
     - ``bool``
     - :oe:meth:`OrderAtoms<OEChem::OEMolBase::OrderAtoms>`
     -
   * - Rearrange Bonds
     - ``bool``
     - :oe:meth:`OrderBonds<OEChem::OEMolBase::OrderBonds>`
     -

.. _section_molproperties_atomandbondcreation:

Atom and Bond Creation
================================================================================

**OEChem TK** contains functions that allow molecules to be constructed
from atoms and bonds explicitly. :oe:src:`Listing 2<SNIPPET-CreatingAtoms>`
demonstrates how to create the water molecule.

Atoms are created by calling the :oe:meth:`OEChem::OEMolBase::NewAtom`
method, and bonds are created by calling the
:oe:meth:`OEChem::OEMolBase::NewBond`
method. :oe:meth:`NewAtom<OEChem::OEMolBase::NewAtom>` takes the atomic
number of the atom to create and returns the new
:ref:`OEAtomBase <OEChem_OEAtomBase>`.
:oe:meth:`NewBond<OEChem::OEMolBase::NewBond>` takes two
:oe:cls:`OEAtomBases<OEChem::OEAtomBase>` and an integer bond order as
arguments and returns the new :ref:`OEBondBase <OEChem_OEBondBase>`.

.. oe:source:: CreatingAtoms.cpp
   :language: c++
   :caption:  Creating new atoms and bonds
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: CreatingAtoms.py
   :language: python
   :caption:  Creating new atoms and bonds
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: CreatingAtoms.java
   :language: java
   :caption:  Creating new atoms and bonds
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: CreatingAtoms.cs
   :language: csharp
   :caption:  Creating new atoms and bonds
   :refnum:   2
   :frag:     SNIPPET

In :oe:src:`Listing 2<SNIPPET-CreatingAtoms>` the atomic numbers of oxygen, 8,
and hydrogen, 1, are explicitly encoded in the program. To make code
easier to read and less error prone, **OEChem TK** provides symbolic
constants for the first 109 elements in the
:oe:constns:`OEChem::OEElemNo` namespace. The
:oe:constns:`OEChem::OEElemNo` namespace defines the atomic symbols
with the appropriate atomic number.

.. oe:source:: CreatingAtoms2.cpp
   :language: c++
   :caption:  Using OEElemNo namespace
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: CreatingAtoms2.py
   :language: python
   :caption:  Using OEElemNo namespace
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: CreatingAtoms2.java
   :language: java
   :caption:  Using OEElemNo namespace
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: CreatingAtoms2.cs
   :language: csharp
   :caption:  Using OEElemNo namespace
   :refnum:   3
   :frag:     SNIPPET

.. note::

   The atoms and bonds of a molecule are automatically deleted when
   their parent molecule is destroyed.

.. _section_molproperties_genericdata:

Attach Generic Data to Molecules
================================================================================

Generic data can be attached to any object that derives from the
:ref:`OEBase <OESystem_OEBase>` class. The following two snippets demonstrate how
generic data (e.g. molecule weight) can be attached to a molecule:

.. oe:source:: GenericData.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SET-DATA-INTEGER

.. oe:source:: GenericData.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SET-DATA-STRING

.. oe:source:: GenericData.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SET-DATA-INTEGER

.. oe:source:: GenericData.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SET-DATA-STRING

.. oe:source:: GenericData.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SET-DATA-INTEGER

.. oe:source:: GenericData.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SET-DATA-STRING

.. oe:source:: GenericData.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SET-DATA-INTEGER

.. oe:source:: GenericData.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SET-DATA-STRING

After annotation, the data can be accessed with the same integer or character string
identifier:

.. oe:source:: GenericData.py
  :language: python
  :noindent:
  :frag:     SNIPPET-GET-DATA-INTEGER

.. oe:source:: GenericData.py
  :language: python
  :noindent:
  :frag:     SNIPPET-GET-DATA-STRING

.. oe:source:: GenericData.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-GET-DATA-INTEGER

.. oe:source:: GenericData.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-GET-DATA-STRING

.. oe:source:: GenericData.java
   :language: java
   :noindent:
   :frag:     SNIPPET-GET-DATA-INTEGER

.. oe:source:: GenericData.java
   :language: java
   :noindent:
   :frag:     SNIPPET-GET-DATA-STRING

.. oe:source:: GenericData.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-GET-DATA-INTEGER

.. oe:source:: GenericData.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-GET-DATA-STRING

The :ref:`OEMolBase <OEChem_OEMolBase>` API provides the following
methods, publicly inherited from :ref:`OEBase <OESystem_OEBase>`, that
allow the manipulation of generic data.

.. list-table:: **Methods to manipulate generic data**
   :widths: 15 40
   :header-rows: 1

   * - Method
     - Description

   * - :oe:meth:`SetData<OESystem::OEBase::SetData>`
     - sets a generic data associating it with the given tag

   * - :oe:meth:`AddData<OESystem::OEBase::AddData>`
     -  adds a generic data associating it with the given tag

   * - :oe:meth:`HasData<OESystem::OEBase::HasData>`
     - determines whether a molecule has any generic data with a given tag

   * - :oe:meth:`GetData<OESystem::OEBase::GetData>`
     - returns the generic data associated with the given tag

   * - :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`
     - deletes all generic data  with the given tag

   * - :oe:meth:`Clear<OESystem::OEBase::Clear>`
     - clears all stored generic data

.. note::

   Generic data attached to a molecule or any of its atoms or bonds is automatically
   saved when the molecule is written into an :file:`.oeb` file.

.. seealso::

   * :ref:`section_attaching_other_objects` section
   * :ref:`section_moltaggeddata_SD` section
   * :ref:`section_moltaggeddata_PDB` section
   * For using tag data with multi-conformer molecules, see :ref:`section_oemol_sddata`


.. _chapter_molreadwrite:

*****************************
Molecule Reading and Writing
*****************************

.. index::
   single: oemolistream
   single: oemolostream
   single: oemolstreambase

.. _section_molreadwrite_oemolstreams:

Molecule Streams
============================================================================

The :ref:`previous section <section_molctordtor_smilesfrommol>`
demonstrated reading and writing :ref:`SMILES <chapter_SMILES>`
strings from  standard input. This required the programmer to perform the file
I/O explicitly.  Whilst this may be reasonable for :ref:`SMILES
<chapter_SMILES>` strings that may be read via STD
`getline <http://www.cplusplus.com/reference/string/string/getline/>`_,
it isn't suitable for more
complex file formats.  To ease this task, **OEChem TK** provides the
:oe:cls:`oemolstream<OEChem::oemolstreambase>` abstraction.  The
classes :ref:`oemolistream <OEChem_oemolistream>` and
:ref:`oemolostream <OEChem_oemolostream>` allow input and output of molecules
using the :oe:func:`OEChem::OEReadMolecule` and
:oe:func:`OEChem::OEWriteMolecule` functions, respectively.

.. oe:language:: java

   .. warning::

      The :oe:meth:`OEChem::oemolstreambase::close` method must be
      explicitly called on all molecule streams in Java. Java does not
      guarantee that finalizers are ever called. There is also a delay
      before a finalizer is called, possibly causing the operating
      system to run out of resources, e.g., file handles.

.. oe:source:: oemolstream.cpp
   :language: c++
   :caption:  High-level Molecule I/O using molstreams
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: oemolstream.py
   :language: python
   :caption:  High-level Molecule I/O using molstreams
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: oemolstream.java
   :language: java
   :caption:  High-level Molecule I/O using molstreams
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: oemolstream.cs
   :language: csharp
   :caption:  High-level Molecule I/O using molstreams
   :refnum:   1
   :frag:     SNIPPET

:oe:src:`Listing 1<SNIPPET-oemolstream>` will read molecules from stdin in
:ref:`SMILES <chapter_SMILES>` format and write them to stdout in
:oe:func:`absolute SMILES<OEChem::OECreateAbsSmiString>` format.
Notice that in this example, the following is done automatically for you by
:oe:func:`OEChem::OEReadMolecule`:

- :oe:meth:`OEChem::OEMolBase::Clear` method to reset the molecule.
- :oe:func:`OEChem::OEAssignAromaticFlags` to normalize aromaticity.
- :oe:meth:`OEChem::OEMolBase::operator bool` to test the validity of the molecule.

.. note::

   :oe:func:`OEChem::OEReadMolecule` will skip any invalid molecules automatically.

.. oe:language:: python

   **OEChem TK** provides the following more *Python-like* generator methods to
   read molecules out of an :ref:`oemolistream <OEChem_oemolistream>` if the user
   prefers. It is important to realize that the same
   :ref:`OEGraphMol <OEChem_OEGraphMol>` instance is reused for every molecule
   being read from the :ref:`oemolistream <OEChem_oemolistream>`.

    .. oe:source:: GetOEGraphMols.py
       :language: python
       :caption:  Generator methods for reading molecules
       :frag:     SNIPPET

Since the same :ref:`OEGraphMol <OEChem_OEGraphMol>` instance is being reused
for every molecule in the stream, special precautions must be taken to
load up an entire file into memory. :oe:src:`Listing
2<SNIPPET-ReadMolIntoMemory>` will read molecules into memory by making sure
there is a copy made when inserting the molecule into the
container. This is useful if the molecules need to be repeatedly
accessed.

.. oe:source:: ReadMolIntoMemory.cpp
   :language: c++
   :caption:  Reading molecules into memory
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: ReadMolIntoMemory.py
   :language: python
   :caption:  Reading molecules into memory
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: ReadMolIntoMemory.java
   :language: java
   :caption:  Reading molecules into memory
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: ReadMolIntoMemory.cs
   :language: csharp
   :caption:  Reading molecules into memory
   :refnum:   2
   :frag:     SNIPPET

.. _section_molreadwrite_fileformats:

File Formats
============================================================================

.. index::
   single: SetFormat
   single: GetFormat

In addition to :ref:`SMILES <chapter_SMILES>` strings, **OEChem TK** is able
to read numerous other molecular file formats, including :oe:func:`MDL
SD<OEChem::OEReadMDLFile>` files, Tripos :oe:func:`Tripos
MOL2<OEChem::OEReadMol2File>` files and :oe:func:`PDB<OEChem::OEReadPDBFile>`
files. The format of an input file or stream may be associated with an
:ref:`oemolistream <OEChem_oemolistream>` using the
:oe:meth:`SetFormat<OEChem::oemolistream::SetFormat>` method, and may
be retrieved with
:oe:meth:`GetFormat<OEChem::oemolstreambase::GetFormat>`. The file
format is represented by an unsigned integer, which should be one of
the constants defined in the :ref:`the OEFormat namespace <OEChem_OEFormat>`.
A value of :oe:const:`OEChem::OEFormat::UNDEFINED` means that there is
no file format associated with the
:oe:cls:`oemolstream<OEChem::oemolstreambase>`.

.. note::

   The default format associated with an
   :oe:cls:`oemolstream<OEChem::oemolstreambase>` is
   :oe:const:`OEChem::OEFormat::SMI`.

:oe:src:`Listing 3<SNIPPET-ReadWriteSettingFormats>` demonstrates how to use
:oe:cls:`oemolstreams<OEChem::oemolstreambase>` to convert :oe:func:`MDL
SD<OEChem::OEReadMDLFile>` files into :oe:func:`Tripos
MOL2<OEChem::OEReadMol2File>` files.

.. oe:source:: ReadWriteSettingFormats.cpp
   :language: c++
   :caption:  Explicitly setting file formats
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: ReadWriteSettingFormats.py
   :language: python
   :caption:  Explicitly setting file formats
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: ReadWriteSettingFormats.java
   :language: java
   :caption:  Explicitly setting file formats
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: ReadWriteSettingFormats.cs
   :language: csharp
   :caption:  Explicitly setting file formats
   :refnum:   3
   :frag:     SNIPPET

.. table::  **OEChem TK file format support**

   ====================================== ====================================================== ======= ======
   File Format                            Description                                            Read    Write
   ====================================== ====================================================== ======= ======
   :oe:const:`OEChem::OEFormat::CAN`      :term:`Canonical SMILES`                               Yes     Yes
   :oe:const:`OEChem::OEFormat::CDX`      ChemDraw CDX                                           Yes     Yes
   :oe:const:`OEChem::OEFormat::CIF`      Crystallographic Information File                      Yes     Yes
   :oe:const:`OEChem::OEFormat::CSV`      Comma separated values                                 Yes     Yes
   :oe:const:`OEChem::OEFormat::CXSMILES` Chemaxon Extended SMILES                               Yes     Yes
   :oe:const:`OEChem::OEFormat::FASTA`    FASTA protein sequence                                 Yes     Yes
   :oe:const:`OEChem::OEFormat::INCHI`    IUPAC InChI                                            No      Yes
   :oe:const:`OEChem::OEFormat::INCHIKEY` IUPAC InChI Key                                        No      Yes
   :oe:const:`OEChem::OEFormat::ISM`      :term:`Canonical isomeric SMILES`                      Yes     Yes
   :oe:const:`OEChem::OEFormat::MDL`      MDL Mol File                                           Yes     Yes
   :oe:const:`OEChem::OEFormat::MF`       Molecular Formula (Hill order)                         No      Yes
   :oe:const:`OEChem::OEFormat::MMCIF`    Macromolecular Crystallographic Information File       Yes     Yes
   :oe:const:`OEChem::OEFormat::MMOD`     Macromodel                                             Yes     Yes
   :oe:const:`OEChem::OEFormat::MOL2`     Tripos Sybyl mol2 file                                 Yes     Yes
   :oe:const:`OEChem::OEFormat::MOL2H`    Sybyl mol2 with explicit hydrogens                     Yes     Yes
   :oe:const:`OEChem::OEFormat::MOPAC`    MOPAC file format(s)                                   No      Yes
   :oe:const:`OEChem::OEFormat::OEB`      *OpenEye* OEBinary                                     Yes     Yes
   :oe:const:`OEChem::OEFormat::OEZ`      Zstd Compressed *OpenEye* OEBinary                     Yes     Yes
   :oe:const:`OEChem::OEFormat::PDB`      Protein Databank PDB file                              Yes     Yes
   :oe:const:`OEChem::OEFormat::RDF`      MDL RDF File                                           Yes     No
   :oe:const:`OEChem::OEFormat::SDF`      MDL SD File                                            Yes     Yes
   :oe:const:`OEChem::OEFormat::SKC`      MDL ISIS Sketch File                                   Yes     No
   :oe:const:`OEChem::OEFormat::SLN`      Tripos Sybyl Line Notation                             No      Yes
   :oe:const:`OEChem::OEFormat::SMI`      :term:`Canonical isomeric SMILES`                      Yes     Yes
   :oe:const:`OEChem::OEFormat::USM`      :term:`SMILES`                                         Yes     Yes
   :oe:const:`OEChem::OEFormat::XYZ`      XMol XYZ format                                        Yes     Yes
   ====================================== ====================================================== ======= ======

.. _section_molreadwrite_fileinputandoutput:

File Input and Output
============================================================================

In addition to standard in and standard out, **OEChem TK**'s
:oe:cls:`oemolstreams<OEChem::oemolstreambase>` also support reading
from files.  To open a file, use the
:oe:meth:`open<OEChem::oemolstreambase::open>` method with the required
filename.  For input :oe:cls:`oemolistreams<OEChem::oemolistream>`, if
the file does not exist the
:oe:meth:`open<OEChem::oemolstreambase::open>` fails and returns false,
for output :oe:cls:`oemolostreams<OEChem::oemolostream>`, the output
file is created if it did not previously exist and overwritten if it
did.  If a filename is passed to the :oe:meth:`open<OEChem::oemolstreambase::open>`
method, the format and gz compression flags are set based on the file extension of the filename for the
:ref:`oemolistream <OEChem_oemolistream>` or :ref:`oemolostream <OEChem_oemolostream>` instance.
If *no* arguments are passed to
:oe:meth:`open<OEChem::oemolstreambase::open>`, an
:ref:`oemolistream <OEChem_oemolistream>` will use standard in, and an
:ref:`oemolostream <OEChem_oemolostream>` will use standard out, the format
will be set to :oe:const:`OEChem::OEFormat::Default` and gz compression will be disabled.
Much like regular file I/O, :oe:cls:`oemolstreams<OEChem::oemolstreambase>` can be closed after use, using the
:oe:meth:`close<OEChem::oemolstreambase::close>` method.
:oe:cls:`oemolstreams<OEChem::oemolstreambase>` are automatically
closed by their destructors.

.. oe:source:: ReadWriteToFiles.cpp
   :language: c++
   :caption:  Reading and writing molecule files
   :refnum:   4
   :frag:     SNIPPET

.. oe:source:: ReadWriteToFiles.py
   :language: python
   :caption:  Reading and writing molecule files
   :refnum:   4
   :frag:     SNIPPET

.. oe:source:: ReadWriteToFiles.java
   :language: java
   :caption:  Reading and writing molecule files
   :refnum:   4
   :frag:     SNIPPET

.. oe:source:: ReadWriteToFiles.cs
   :language: csharp
   :caption:  Reading and writing molecule files
   :refnum:   4
   :frag:     SNIPPET

One convenient feature of the
:oe:meth:`open<OEChem::oemolstreambase::open>` method of
:oe:cls:`oemolstreams<OEChem::oemolstreambase>` is that it sets the
file format and gz compression associated with the stream from the file extension of the
filename used as an argument. :oe:src:`Listing 4<SNIPPET-ReadWriteToFiles>`
converts the file 'input.sdf' in MDL file format into the file
'output.mol2' in Tripos MOL2 file format.  This behavior can be
overridden by calling
:oe:meth:`SetFormat<OEChem::oemolistream::SetFormat>` after the
:oe:meth:`open<OEChem::oemolstreambase::open>` but before the first
molecule is read or written to a stream.

.. _section_molreadwrite_stringinputandoutput:

String Input and Output
============================================================================

The :ref:`oemolistream <OEChem_oemolistream>` and :ref:`oemolostream <OEChem_oemolostream>`
provide the ability to read and write memory buffers instead of
files.

.. oe:language:: java

   This is accomplished through the methods,
   :oe:meth:`OEChem::oemolistream::openByteArray` and
   :oe:meth:`OEChem::oemolostream::getByteArray`.

.. oe:language:: csharp

   This is accomplished through the methods,
   :oe:meth:`OEChem::oemolistream::OpenByteArray` and
   :oe:meth:`OEChem::oemolostream::GetByteArray`.

.. oe:language:: c++ python

   This is accomplished through the methods,
   :oe:meth:`OEChem::oemolistream::openstring` and
   :oe:meth:`OEChem::oemolostream::GetString`.

The :oe:src:`Listing 5<SNIPPET-StringIO>` example below demonstrates how to read and write molecules from memory buffers.

.. oe:source:: StringIO.cpp
   :language: c++
   :caption:  Reading and writing molecule from memory buffers
   :refnum:   5
   :frag:     SNIPPET

.. oe:source:: StringIO.py
   :language: python
   :caption:  Reading and writing molecule from memory buffers
   :refnum:   5
   :frag:     SNIPPET

.. oe:source:: StringIO.java
   :language: java
   :caption:  Reading and writing molecule from memory buffers
   :refnum:   5
   :frag:     SNIPPET

.. oe:source:: StringIO.cs
   :language: csharp
   :caption:  Reading and writing molecule from memory buffers
   :refnum:   5
   :frag:     SNIPPET

.. _section_molreadwrite_compressed:

Compressed Input and Output
============================================================================

For any of the molecular file formats supported by **OEChem TK**, it is often
convenient to read and write compressed
:ref:`files<section_molreadwrite_fileinputandoutput>` or
:ref:`strings<section_molreadwrite_stringinputandoutput>`.
Molecule streams support gzipped input and output via the `zlib
<http://www.zlib.net/>`_ library.  The ``.gz`` suffix on any filename
used to open a stream is recognized and the stream is read or written
in compressed format.  This mechanism does not interfere with the
format perception.  For instance, ``foo.sdf.gz`` is recognized as a
gzipped file in MDL's SD format.

The :oe:src:`Listing 6<SNIPPET-ReadWriteCompressedFiles>` example below
converts all of the molecules in a gzipped SD format file into a gzipped OEBinary
file.

.. oe:source:: ReadWriteCompressedFiles.cpp
   :language: c++
   :caption:  Reading and writing compressed molecule files
   :refnum:   6
   :frag:     SNIPPET

.. oe:source:: ReadWriteCompressedFiles.py
   :language: python
   :caption:  Reading and writing compressed molecule files
   :refnum:   6
   :frag:     SNIPPET

.. oe:source:: ReadWriteCompressedFiles.java
   :language: java
   :caption:  Reading and writing compressed molecule files
   :refnum:   6
   :frag:     SNIPPET

.. oe:source:: ReadWriteCompressedFiles.cs
   :language: csharp
   :caption:  Reading and writing compressed molecule files
   :refnum:   6
   :frag:     SNIPPET

The **OEChem TK**'s binary file format :oe:const:`OEChem::OEFormat::OEB` is
well suited  (and our preferred way) to store multi-conformer molecules.
When working with multi-conformer molecules of +1M datasets, the generated files
can easily reach a size when transferring them between computers or networks can be
slow.
One way to handle this issue is to compress the files with gzip before transfer.
As the above example shows  **OEChem TK**  seamlessly handles gzipped molecule
files with ``gz`` extension.
Alternatively, **OEChem TK** also provides a native compressed file format,
called :oe:const:`OEChem::OEFormat::OEZ`, with the ``oez`` file extension.
This file format currently only supports multi-conformer molecules
derived from the :ref:`OEMCMolBase <OEChem_OEMCMolBase>` class.

One of the main differences between the gzipped :oe:const:`OEChem::OEFormat::OEB`
and the :oe:const:`OEChem::OEFormat::OEZ` files that while gzip compresses a
molecular file as a whole, in an :oe:const:`OEChem::OEFormat::OEZ` file,
each molecule is individually compressed using the
`Zstandard <https://facebook.github.io/zstd/>`_ compression algorithm.

This difference makes :oe:const:`OEChem::OEFormat::OEZ` suitable to work
really well with :ref:`OEMolDatabase <OEChem_OEMolDatabase>` that is designed to provide
fast read-only random access to molecular files.
When an :ref:`OEMolDatabase <OEChem_OEMolDatabase>` opens a gzipped molecule file,
uncompressing the whole file is necessary to access any molecule in the
dataset.
When working with a :oe:const:`OEChem::OEFormat::OEZ` file,  accessing a
specific molecule in the file only triggers the un-compression of the
associated data chunk.

The table below lists the file sizes of the same dataset of 1M molecules
in uncompressed and compressed formats with different numbers of conformations
per molecule.

====================================== ======= ======= =======
Dataset                                oeb     oeb.gz  oez
====================================== ======= ======= =======
1M molecules with 10 conformations     5.4GB   1.9GB   2.2GB
1M molecules with 50 conformations     22GB    5.7GB   5.5GB
1M molecules with 200 conformations    69GB    16GB    13GB
====================================== ======= ======= =======

.. note::

   The :oe:const:`OEChem::OEFormat::OEZ` file format was introduced in the
   ``2019.Apr`` toolkits.
   OpenEye applications or toolkits released before Apr/2019 will **not**
   be able to read or write this new file format.

.. _section_molreadwrite_commandlineformatcontrol:

Command Line Format Control
============================================================================

Using the methods outlined above, it is possible to allow the stream
format to be controlled from the command line.  **OEChem TK**'s
:oe:cls:`oemolstreams<OEChem::oemolstreambase>` control the format by
interpreting the input and output file names.

.. oe:source:: ReadWriteCommandLineArgs.cpp
   :language: c++
   :caption:  Controlling File Format from the Command Line
   :refnum:   7
   :frag:     SNIPPET

.. oe:source:: ReadWriteCommandLineArgs.py
   :language: python
   :caption:  Controlling File Format from the Command Line
   :refnum:   7
   :frag:     SNIPPET

.. oe:source:: ReadWriteCommandLineArgs.java
   :language: java
   :caption:  Controlling File Format from the Command Line
   :refnum:   7
   :frag:     SNIPPET

.. oe:source:: ReadWriteCommandLineArgs.cs
   :language: csharp
   :caption:  Controlling File Format from the Command Line
   :refnum:   7
   :frag:     SNIPPET

:oe:src:`Listing 7<SNIPPET-ReadWriteCommandLineArgs>` is an example of using
command-line arguments to allow **OEChem TK** programs to support many file
formats at run-time. For instance, if :oe:src:`Listing
7<SNIPPET-ReadWriteCommandLineArgs>` is a program called *convert*::

   prompt> convert file1.sdf file1.smi

This command will convert *file1.sdf* from SD format to SMILES format.
A first extension of this idea allows access to standard in and
standard out via the "-" filename. For instance::

   prompt> convert file2.mol2 -

This command will convert ``file2.mol2`` in MOL2 format and write the
molecules to standard out in SMILES, the default format.

Thus if you have another program, *GetFromDatabase*, which retrieves
molecules from a database and writes them in SMILES format, you can
chain it with any **OEChem TK** program.  Using your operating systems
redirection commands (*e.g.* - Unix pipe "|" or redirect
">") you can move molecules directly from *GetFromDatabase*
to *convert* without a temporary file::

   prompt> GetFromDatabase | convert - file3.sdf

This command will take the SMILES format output from *GetFromDatabase*
and generate an SD format file.

However, to make this concept of using standard in and standard out
for piping data really useful, one needs to be able to control the
format of standard in and standard out similarly to the way it would
be controlled for temporary files.  To facilitate this,
:oe:cls:`oemolstreams<OEChem::oemolstreambase>` interpret filenames
which are ONLY format extensions to indicate format control for
standard in and standard out.

.. oe:source:: ReadWriteStdinStdoutFormatC.cpp
   :language: c++
   :caption:  Controlling standard in and standard out File Format
   :refnum:   8
   :frag:     SNIPPET

.. oe:source:: ReadWriteStdinStdoutFormatC.py
   :language: python
   :caption:  Controlling standard in and standard out File Format
   :refnum:   8
   :frag:     SNIPPET

.. oe:source:: ReadWriteStdinStdoutFormatC.java
   :language: java
   :caption:  Controlling standard in and standard out File Format
   :refnum:   8
   :frag:     SNIPPET

.. oe:source:: ReadWriteStdinStdoutFormatC.cs
   :language: csharp
   :caption:  Controlling standard in and standard out File Format
   :refnum:   8
   :frag:     SNIPPET

:oe:src:`Listing 8<SNIPPET-ReadWriteStdinStdoutFormatC>` is an example of
opening an :ref:`oemolistream <OEChem_oemolistream>` to standard in with the
format set to SDF. The output :ref:`oemolostream <OEChem_oemolostream>` is opened
to standard out with the format set to MOL2.  This is exactly
equivalent to :oe:src:`Listing 3<SNIPPET-ReadWriteSettingFormats>`.  However,
it demonstrates the extensibility of controlling the format of standard
in and standard out from the command line.

.. note::

   This prevents you from naming files as pure extensions: ``.mol2``,
   ``.sdf``, etc.

Now, using our program *convert* from :oe:src:`Listing 7<SNIPPET-ReadWriteCommandLineArgs>`
 it is possible to do the following::

   prompt> convert .sdf .mol2

This command opens standard in with the SDF format and opens standard
out with the MOL2 format.

Now there is complete format control of standard in and standard out
from the command line.  If we have a program *GenerateStructures*,
which only writes the MOL2 format and another program *GenerateData*,
which only reads the SD format, we can use them from the command line
with any **OEChem TK** program which uses command-line arguments for file
specification::

   prompt> GenerateStructures | convert .mol2 .sdf | GenerateData

This command demonstrates how any **OEChem TK** program with command-line
file specification can be used to pipe formatted input and output.

.. _section_molreadwrite_flavoredinputandoutput:

Flavored Input and Output
============================================================================

.. index::
   single: SetFlavor
   single: GetFlavor

The general goal of the :oe:cls:`oemolstream<OEChem::oemolstreambase>`
input and output classes in **OEChem TK** is to provide the user with
transparent access to the very complex task of reading and writing
molecules in a wide variety of formats.  However, occasionally, a
programmer may want to tweak the behavior of specific readers or
writers without abandoning the
:oe:cls:`oemolstreams<OEChem::oemolstreambase>` to use the low level
writers (such as :oe:func:`OEChem::OEWriteMDLFile`).  For these
instances, :oe:cls:`oemolstreams<OEChem::oemolstreambase>` provide the
:oe:meth:`OEChem::oemolstreambase::SetFlavor` and
:oe:meth:`OEChem::oemolstreambase::GetFlavor` methods.

The :oe:meth:`OEChem::oemolstreambase::SetFlavor` method takes two
unsigned integer arguments, the first is the format for which the
flavor is being specified and the second is the flavor itself.  The
formats are specified as discussed in
:ref:`section_molreadwrite_fileformats`.  The input flavors are
specified in the :oe:constns:`OEChem::OEIFlavor` namespace and the
output flavors are specified in the :oe:constns:`OEChem::OEOFlavor`
namespace.  Unlike the formats, the flavors are a bitmask and may be
binary OR'd together.  Under the :oe:constns:`OEChem::OEIFlavor` and
:oe:constns:`OEChem::OEOFlavor` namespaces, there is a namespace for
each format as well as a :oe:constns:`OEChem::OEIFlavor::Generic`
namespace.  The :oe:constns:`OEChem::OEOFlavor::Generic` namespace is
used to control aromaticity perception and other properties common to
all formats.  To completely specify a flavor, one would typically
binary-OR a :oe:constns:`OEChem::OEOFlavor::Generic` flag and a format
specific flag and pass the resultant value to
:oe:meth:`OEChem::oemolstreambase::SetFlavor`.

The default behavior for the :oe:func:`PDB
reader<OEChem::OEReadPDBFile>` is that
:oe:const:`TER<OEChem::OEIFlavor::PDB::TER>` specifies the termination
of a disconnected fragment within the same molecule while
:oe:const:`END<OEChem::OEIFlavor::PDB::END>` specifies the termination
of a connection table.  However, some users may want to have the
reader split :oe:func:`PDB<OEChem::OEReadPDBFile>` input files into
different molecules every time a
:oe:const:`TER<OEChem::OEIFlavor::PDB::TER>` appears.

The following code is an example of changing the
:oe:func:`PDB<OEChem::OEReadPDBFile>` reader flavor.

.. oe:source:: ReadWriteFlavors.cpp
   :language: c++
   :caption:  Changing oemolistream Reader Flavor
   :refnum:   9
   :frag:     SNIPPET

.. oe:source:: ReadWriteFlavors.py
   :language: python
   :caption:  Changing oemolistream Reader Flavor
   :refnum:   9
   :frag:     SNIPPET

.. oe:source:: ReadWriteFlavors.java
   :language: java
   :caption:  Changing oemolistream Reader Flavor
   :refnum:   9
   :frag:     SNIPPET

.. oe:source:: ReadWriteFlavors.cs
   :language: csharp
   :caption:  Changing oemolistream Reader Flavor
   :refnum:   9
   :frag:     SNIPPET

Similar low-level control can be exerted over both input and output
:oe:cls:`oemolstreams<OEChem::oemolstreambase>` using the powerful
:oe:meth:`OEChem::oemolstreambase::SetFlavor` method. See the API
documentation for the associated low-level routine and namespace for
details on the effects of specific flavor flags.

.. list-table:: **OEChem TK low-level readers and input flavors**
   :widths: 30 50 30
   :header-rows: 1

   * - File Format
     - Low-Level Reader
     - Input Flavors

   * - :oe:const:`OEChem::OEFormat::CAN`
     - :oe:func:`OEChem::OEParseSmiles`
     - :oe:constns:`OEChem::OEIFlavor::CAN`

   * - :oe:const:`OEChem::OEFormat::CDX`
     - :oe:func:`OEChem::OEReadCDXFile`
     - :oe:constns:`OEChem::OEIFlavor::CDX`

   * - :oe:const:`OEChem::OEFormat::CIF`
     - :oe:func:`OEChem::OEReadCIFFile`
     - :oe:constns:`OEChem::OEIFlavor::CIF`

   * - :oe:const:`OEChem::OEFormat::CSV`
     - :oe:func:`OEChem::OEReadCSVFile`
     - :oe:constns:`OEChem::OEIFlavor::CSV`

   * - :oe:const:`OEChem::OEFormat::CXSMILES`
     - 
     - :oe:constns:`OEChem::OEIFlavor::CXSMILES`

   * - :oe:const:`OEChem::OEFormat::FASTA`
     - :oe:func:`OEChem::OEReadFASTAFile`
     - :oe:constns:`OEChem::OEIFlavor::FASTA`

   * - :oe:const:`OEChem::OEFormat::ISM`
     - :oe:func:`OEChem::OEParseSmiles`
     - :oe:constns:`OEChem::OEIFlavor::ISM`

   * - :oe:const:`OEChem::OEFormat::MDL`
     - :oe:func:`OEChem::OEReadMDLFile`
     - :oe:constns:`OEChem::OEIFlavor::MDL`

   * - :oe:const:`OEChem::OEFormat::MF`
     -
     -

   * - :oe:const:`OEChem::OEFormat::MMCIF`
     - :oe:func:`OEChem::OEReadCIFFile`
     - :oe:constns:`OEChem::OEIFlavor::MMCIF`

   * - :oe:const:`OEChem::OEFormat::MMOD`
     - :oe:func:`OEChem::OEReadMacroModelFile`
     - :oe:constns:`OEChem::OEIFlavor::MMOD`

   * - :oe:const:`OEChem::OEFormat::MOL2`
     - :oe:func:`OEChem::OEReadMol2File`
     - :oe:constns:`OEChem::OEIFlavor::MOL2`

   * - :oe:const:`OEChem::OEFormat::MOL2H`
     - :oe:func:`OEChem::OEReadMol2File`
     - :oe:constns:`OEChem::OEIFlavor::MOL2H`

   * - :oe:const:`OEChem::OEFormat::MOPAC`
     -
     -

   * - :oe:const:`OEChem::OEFormat::OEB`
     - :oe:func:`OEChem::OEReadOEBFile`
     -
   * - :oe:const:`OEChem::OEFormat::OEZ`
     - N/A (:oe:func:`OEChem::OEReadMolecule` works)
     -

   * - :oe:const:`OEChem::OEFormat::PDB`
     - :oe:func:`OEChem::OEReadPDBFile`
     - :oe:constns:`OEChem::OEIFlavor::PDB`

   * - :oe:const:`OEChem::OEFormat::SDF`
     - :oe:func:`OEChem::OEReadMDLFile`
     - :oe:constns:`OEChem::OEIFlavor::SDF`

   * - :oe:const:`OEChem::OEFormat::SKC`
     - :oe:func:`OEChem::OEReadSketchFile`
     - :oe:constns:`OEChem::OEIFlavor::SKC`

   * - :oe:const:`OEChem::OEFormat::SLN`
     -
     -

   * - :oe:const:`OEChem::OEFormat::SMI`
     - :oe:func:`OEChem::OEParseSmiles`
     - :oe:constns:`OEChem::OEIFlavor::SMI`

   * - :oe:const:`OEChem::OEFormat::XYZ`
     - :oe:func:`OEChem::OEReadXYZFile`
     - :oe:constns:`OEChem::OEIFlavor::XYZ`

.. list-table:: **OEChem TK low-level writers and output flavors**
   :widths: 30 50 30
   :header-rows: 1

   * - File Format
     - Low-Level Writer
     - Output Flavors

   * - :oe:const:`OEChem::OEFormat::CAN`
     - :oe:func:`OEChem::OECreateCanSmiString`
     - :oe:constns:`OEChem::OEOFlavor::CAN`

   * - :oe:const:`OEChem::OEFormat::CIF`
     - :oe:func:`OEChem::OEWriteCIFFile`
     - :oe:constns:`OEChem::OEOFlavor::CIF`

   * - :oe:const:`OEChem::OEFormat::CDX`
     - :oe:func:`OEChem::OEWriteCDXFile`
     - :oe:constns:`OEChem::OEOFlavor::CDX`

   * - :oe:const:`OEChem::OEFormat::CSV`
     - :oe:func:`OEChem::OEWriteCSVFile`
     - :oe:constns:`OEChem::OEOFlavor::CSV`

   * - :oe:const:`OEChem::OEFormat::CXSMILES`
     - 
     - :oe:constns:`OEChem::OEOFlavor::CXSMILES`

   * - :oe:const:`OEChem::OEFormat::FASTA`
     - :oe:func:`OEChem::OEWriteFASTAFile`
     - :oe:constns:`OEChem::OEOFlavor::FASTA`

   * - :oe:const:`OEChem::OEFormat::ISM`
     - :oe:func:`OEChem::OECreateIsoSmiString`
     - :oe:constns:`OEChem::OEOFlavor::ISM`

   * - :oe:const:`OEChem::OEFormat::MDL`
     - :oe:func:`OEChem::OEWriteMDLFile`
     - :oe:constns:`OEChem::OEOFlavor::MDL`

   * - :oe:const:`OEChem::OEFormat::MF`
     - :oe:func:`OEChem::OEMolecularFormula`
     - :oe:constns:`OEChem::OEOFlavor::MF`

   * - :oe:const:`OEChem::OEFormat::MMCIF`
     - :oe:func:`OEChem::OEWriteCIFFile`
     - :oe:constns:`OEChem::OEOFlavor::MMCIF`

   * - :oe:const:`OEChem::OEFormat::MMOD`
     - :oe:func:`OEChem::OEWriteMacroModelFile`
     - :oe:constns:`OEChem::OEOFlavor::MMOD`

   * - :oe:const:`OEChem::OEFormat::MOL2`
     - :oe:func:`OEChem::OEWriteMol2File`
     - :oe:constns:`OEChem::OEOFlavor::MOL2`

   * - :oe:const:`OEChem::OEFormat::MOL2H`
     - :oe:func:`OEChem::OEWriteMol2File`
     - :oe:constns:`OEChem::OEOFlavor::MOL2H`

   * - :oe:const:`OEChem::OEFormat::MOPAC`
     - :oe:func:`OEChem::OEWriteMOPACInputFile`
     - :oe:constns:`OEChem::OEOFlavor::MOPAC`

   * - :oe:const:`OEChem::OEFormat::OEB`
     - N/A (:oe:func:`OEChem::OEWriteMolecule` works)
     -

   * - :oe:const:`OEChem::OEFormat::OEZ`
     - N/A (:oe:func:`OEChem::OEWriteMolecule` works)
     -

   * - :oe:const:`OEChem::OEFormat::PDB`
     - :oe:func:`OEChem::OEWritePDBFile`
     - :oe:constns:`OEChem::OEOFlavor::PDB`

   * - :oe:const:`OEChem::OEFormat::SDF`
     - :oe:func:`OEChem::OEWriteMDLFile`
     - :oe:constns:`OEChem::OEOFlavor::SDF`

   * - :oe:const:`OEChem::OEFormat::SKC`
     -
     -

   * - :oe:const:`OEChem::OEFormat::SLN`
     - :oe:func:`OEChem::OECreateSlnString`
     - :oe:constns:`OEChem::OEOFlavor::SLN`

   * - :oe:const:`OEChem::OEFormat::SMI`
     - :oe:func:`OEChem::OECreateSmiString`
     - :oe:constns:`OEChem::OEOFlavor::SMI`

   * - :oe:const:`OEChem::OEFormat::XYZ`
     - :oe:func:`OEChem::OEWriteXYZFile`
     - :oe:constns:`OEChem::OEOFlavor::XYZ`

   * - :oe:const:`OEChem::OEFormat::INCHI`
     - :oe:func:`OEChem::OECreateInChI`
     - :oe:constns:`OEChem::OEOFlavor::INCHI`

   * - :oe:const:`OEChem::OEFormat::INCHIKEY`
     - :oe:func:`OEChem::OECreateInChIKey`
     - :oe:constns:`OEChem::OEOFlavor::INCHIKEY`

.. note::

   Low-level readers will not call
   :oe:meth:`Clear<OEChem::OEMolBase::Clear>` on the molecule before
   reading the molecule into it. This is useful for concatenating
   multiple molecules together.

.. _section_molreadwrite_proppreserv:

Molecular Property Preservation
============================================================================

.. warning::

   :oe:func:`OEChem::OEWriteMolecule` will change your molecule!

The high-level :oe:func:`OEChem::OEWriteMolecule` function
standardizes the molecule according to the output type for uniformity.
For writing molecules without changing them, there are two options.
If you would like the data to appear in the file exactly as it is in
the molecule (perhaps *Tripos* atom names in a .pdb format), then you
should use a low level writer.  On the other hand, if you would like
to write a standardized molecule (*e.g.* *Tripos* atom types in a MOL2
file), but don't want your molecule changed, you can use
:oe:func:`OEChem::OEWriteConstMolecule`.
The :oe:func:`OEChem::OEWriteConstMolecule` function makes a copy of the
input molecule before performing the necessary perceptions and standardizations.


.. |InChIVersionID| replace:: The underlying InChI code is v1.06 released on December 15, 2020.

.. _`InChI Software Download`:  http://www.inchi-trust.org/downloads
.. _`InChI Technical Manual`:   http://www.inchi-trust.org/download/104/InChI_TechMan.pdf
.. _`InChI API Reference`:      http://www.inchi-trust.org/download/104/InChI_API_Reference.pdf

.. HYPERLINKS

.. _AUTHOR: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#AUTHOR
.. _CAVEAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#CAVEAT
.. _COMPND: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#COMPND
.. _EXPDTA: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#EXPDTA
.. _HEADER: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#HEADER
.. _JRNL:   http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#JRNL
.. _KEYWDS: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#KEYWDS
.. _OBSLTE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#OBSLTE
.. _SOURCE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SOURCE
.. _SPRSDE: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#SPRSDE
.. _REMARK: http://www.wwpdb.org/documentation/file-format-content/format33/remarks.html
.. _REVDAT: http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#REVDAT
.. _TITLE:  http://www.wwpdb.org/documentation/file-format-content/format33/sect2.html#TITLE


.. _DBREF:  http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#DBREF
.. _MODRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#MODRES
.. _SEQRES: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQRES
.. _SEQADV: http://www.wwpdb.org/documentation/file-format-content/format33/sect3.html#SEQADV

.. _FORMUL: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#FORMUL
.. _HET:    http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HET
.. _HETNAM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETNAM
.. _HETSYM: http://www.wwpdb.org/documentation/file-format-content/format33/sect4.html#HETSYN

.. _HELIX : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#HELIX
.. _SHEET : http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#SHEET
.. _TURN:   http://www.wwpdb.org/documentation/file-format-content/format33/sect5.html#TURN

.. _SSBOND: http://www.wwpdb.org/documentation/file-format-content/format33/sect6.html#SSBOND

.. _SITE:   http://www.wwpdb.org/documentation/file-format-content/format33/sect7.html#SITE

.. _CRYST1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#CRYST1
.. _MTRIX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _MTRIX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#MTRIXn
.. _ORIGX1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _ORIGX3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#ORIGXn
.. _SCALE1: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn
.. _SCALE2: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn 
.. _SCALE3: http://www.wwpdb.org/documentation/file-format-content/format33/sect8.html#SCALEn

.. _ATOM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ATOM
.. _HETATM: http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#HETATM
.. _TER:    http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#TER
.. _ENDM:   http://www.wwpdb.org/documentation/file-format-content/format33/sect9.html#ENDMOL

.. _CONECT: http://www.wwpdb.org/documentation/file-format-content/format33/sect10.html#CONECT

.. _END:    http://www.wwpdb.org/documentation/file-format-content/format33/sect11.html#END


.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. _chapter_moltaggeddata:

********************************************************************************
Tagged Data Manipulation
********************************************************************************

.. _section_moltaggeddata_SD:

SD Tagged Data Manipulation
================================================================================

.. index::
   single: SD data

Meta information about a molecule is stored in what is known as
'tagged data'. The most common example of this is the data fields
found in SDF files.  Since SD files are a common form of data storage
and transfer from one system to another, **OEChem TK** provides several
methods to manipulate this data.  **OEChem TK** also provides round
tripping SD data through the OEBinary, :file:`.oeb`, and
comma-separated-values, :file:`.csv` file formats.

A simple class, :ref:`OESDDataPair <OEChem_OESDDataPair>` is used to set and retrieve SD data.

.. list-table::
   :widths: 20 30 30
   :header-rows: 1

   * - Data
     - Set method
     - Get method

   * -  tag
     - :oe:meth:`OEChem::OESDDataPair::SetTag`
     - :oe:meth:`OEChem::OESDDataPair::GetTag`

   * - data
     - :oe:meth:`OEChem::OESDDataPair::SetValue`
     - :oe:meth:`OEChem::OESDDataPair::GetValue`

The following functions provide access to the SD data.

.. list-table:: **Functions to manipulate SD data**
   :widths: 15 30
   :header-rows: 1

   * - Function
     - Description

   * - :oe:func:`OEChem::OEIsSDDataFormat`
     - determines whether a file format support SD data

   * - :oe:func:`OEChem::OESetSDData`
     - set a tag and value data pair

   * - :oe:func:`OEChem::OEAddSDData`
     - add a tag and value data pair

   * - :oe:func:`OEChem::OEHasSDData`
     - determine whether a molecule has data with a given tag

   * - :oe:func:`OEChem::OEGetSDData`
     - get the value for the given tag

   * - :oe:func:`OEChem::OEGetSDDataPairs`
     - return an iterator over all the SD data pairs of the molecule

   * - :oe:func:`OEChem::OECopySDData`
     - copy the entire set of SD data from one molecule to another

   * - :oe:func:`OEChem::OEDeleteSDData`
     - delete all SD data items with the given tag

   * - :oe:func:`OEChem::OEClearSDData`
     - clear all SD data from a molecule

.. oe:language:: c++

   Since :ref:`OESDDataPair <OEChem_OESDDataPair>` stores SD data information in a string,
   numeric values have to be converted to a string with
   :oe:func:`OESystem::OENumberToString` function
   before storing a value with  either :oe:func:`OEChem::OESetSDData` or
   :oe:func:`OEChem::OEAddSDData` functions.

   .. oe:source:: ManipulateSDDataConvert.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-SET-SD

   Similarly the retrieved string can be converted to a numeric value with
   :oe:func:`OESystem::OEStringToNumber` function.

   .. oe:source:: ManipulateSDDataConvert.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-GET-SD

.. oe:language:: python

   Since :ref:`OESDDataPair <OEChem_OESDDataPair>` stores SD data information in a string,
   numeric values have to be converted to a string with Python's ``str()`` method
   before storing a value with  either :oe:func:`OEChem::OESetSDData` or
   :oe:func:`OEChem::OEAddSDData` functions.

   .. oe:source:: ManipulateSDDataConvert.py
      :language: python
      :noindent:
      :frag:     SNIPPET-SET-SD

   Similarly the retrieved string can be converted to a numeric value with
   ``int()`` or ``float()`` functions.

   .. oe:source:: ManipulateSDDataConvert.py
      :language: python
      :noindent:
      :frag:     SNIPPET-GET-SD

.. oe:language:: java

   Since :ref:`OESDDataPair <OEChem_OESDDataPair>` stores SD data information in a string,
   numeric values have to be converted to a string with Java's ``toString()`` method
   before storing a value with  either :oe:func:`OEChem::OESetSDData` or
   :oe:func:`OEChem::OEAddSDData` functions.

   .. oe:source:: ManipulateSDDataConvert.java
      :language: java
      :noindent:
      :frag:     SNIPPET-SET-SD

   Similarly the retrieved string can be converted to a numeric value with
   ``valueOf()`` methods.

   .. oe:source:: ManipulateSDDataConvert.java
      :language: java
      :noindent:
      :frag:     SNIPPET-GET-SD

.. oe:language:: csharp

   Since :ref:`OESDDataPair <OEChem_OESDDataPair>` stores SD data information in a string,
   numeric values have to be converted to a string with C#'s ``ToString()`` method
   before storing a value with either :oe:func:`OEChem::OESetSDData` or
   :oe:func:`OEChem::OEAddSDData` functions.

   .. oe:source:: ManipulateSDDataConvert.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-SET-SD

   Similarly the retrieved string can be converted to a numeric value with
   ``ToSingle()`` style methods.

   .. oe:source:: ManipulateSDDataConvert.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-GET-SD

The following example shows how to manipulate SD tagged data.

.. oe:source:: ManipulateSDData.cpp
   :language: c++
   :refnum:   1
   :caption:  SD data manipulation
   :frag:     SNIPPET

.. oe:source:: ManipulateSDData.py
   :language: python
   :refnum:   1
   :caption:  SD data manipulation
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-ManipulateSDData.py>`

.. oe:source:: ManipulateSDData.java
   :language: java
   :refnum:   1
   :caption:  SD data manipulation
   :frag:     SNIPPET

.. oe:source:: ManipulateSDData.cs
   :language: csharp
   :refnum:   1
   :caption:  SD data manipulation
   :frag:     SNIPPET

.. note::

   If a data with the same tag already exists:

   * it is replaced, when using :oe:func:`OEChem::OESetSDData` function

   * it is added, when using :oe:func:`OEChem::OEAddSDData` function

The output of the preceding program is the following:

.. code-block:: bash

   SD data of benzene
   color : brown
   size : small

   SD data of benzene
   color : brown

   SD data of benzene
   color : brown
   color : black

   SD data of benzene

.. note::

   Note that SD tagged data is specific to MDL's SD file format.  Any
   SD data added to a molecule will only be written out to SD files,
   OEBinary files, or CSV files.  The SD data fields will only be
   filled when reading from SD files that contain SD tagged data, CSV
   data files, or from OEBinary files previously created to contain
   this data.

.. seealso::

   * :ref:`chapter_genericdata` chapter

Multi-conformer molecules
================================================================================

.. seealso::

   For using tag data with multi-conformer molecules, see :ref:`section_oemol_sddata`.

.. _section_moltaggeddata_CSV:

CSV File Format
================================================================================

.. index::
   single: CSV

The CSV, comma-separated-values, file format is a comma file format
used for data exchange in a wide variety of software. Over the years,
the popularity of the format has out-stripped the robustness of many
of its implementations leading to some subtle differences in how it is
implemented between different software packages. This has led to
creation and adoption of `RFC 4180
<http://tools.ietf.org/html/rfc4180>`_ as a standard for the CSV
format. **OEChem TK** supports this standard as the base format for reading
and writing molecules, :ref:`OEMolBase <OEChem_OEMolBase>` objects, to
:file:`.csv` files. **OEChem TK** will read and write :file:`.csv` files
in the following layout:

1. The first line can optionally contain a header to use as the SD tag.

   * **OEChem TK** decides if the first line is a header by trying to
     interpret the first column of the first line as
     :term:`SMILES`. See the :oe:const:`OEChem::OEIFlavor::CSV::Header` flavor.

2. The first column is expected to be a :term:`SMILES` string representing
   the molecule.
3. The second column is the molecule title, as accessed through
   :oe:meth:`OEChem::OEMolBase::GetTitle`.
4. Remaining columns will be read into SD data fields. The data is
   then accessible through :oe:func:`OEChem::OEGetSDData` and
   :oe:func:`OEChem::OESetSDData`.

   * If the file did not contain a header line, the SD tags will be
     named in the following pattern: ``OE_CSV_COLUMN_1``,
     ``OE_CSV_COLUMN_2``, ..., ``OE_CSV_COLUMN_N``.

5. New-line characters are not supported inside a CSV record. They are
   round-tripped using the pipe character, ``|``, instead.

Point #5 is a subtlety of meta-data interchange between SD files and
CSV files. On the one hand, many CSV implementations do not support
line-breaks inside CSV fields, Microsoft Excel does not and neither
does **OEChem TK**. However, it is common to use multiple lines inside an
SD data file like the following::

   >  <activ_class>
   Antiarthritic
   Antiinflammatory
   Cyclooxygenase-2 Inhibitor

**OEChem TK** implements a solution to this problem that ChemAxon has
implemented and documented `here
<http://www.chemaxon.com/instantjchem/ijc_latest/docs/user/help/htmlfiles/moving_data/exporting_data.html#relational_databetween
the interchange>`_. The solution is to use the pipe character, ``|``,
to represent line breaks inside a data field. For example, the
previous example of a multi-line SD data field would look like the
following::

   SMILES,TITLE,active_class
   ...,...,Antiarthritic|Antiinflammatory|Cyclooxygenase-2 Inhibitor

This does cause a different problem for pipe characters inside data
fields: how pipe characters are escaped? **OEChem TK** works around this
problem by embedding the same semantics for CSV parsing to parse
multi-line fields, just using the pipe character as the separator and
the single quote character as the quoting escape
character. :oe:src:`Listing 2<SNIPPET-WriteCSV>` demonstrates an example that
writes out a tricky set of data to the
:oe:const:`OEChem::OEFormat::CSV` format.

.. oe:source:: WriteCSV.cpp
   :language: c++
   :refnum:   2
   :caption:  Writing out SD data as CSV
   :frag:     SNIPPET

.. oe:source:: WriteCSV.py
   :language: python
   :refnum:   2
   :caption:  Writing out SD data as CSV
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-WriteCSV.py>`

.. oe:source:: WriteCSV.java
   :language: java
   :refnum:   2
   :caption:  Writing out SD data as CSV
   :frag:     SNIPPET

.. oe:source:: WriteCSV.cs
   :language: csharp
   :refnum:   2
   :caption:  Writing out SD data as CSV
   :frag:     SNIPPET

The output of :oe:src:`Listing 2<SNIPPET-WriteCSV>` will look like the following::

   SMILES,TITLE,phases,uses
   O,water,"gas,liquid,solid",bathing|water guns|'tea|earl grey|hot'

.. admonition:: Code Example

   * `Reordering CSV File`_ **OpenEye Python Cookbook** recipe

.. _section_moltaggeddata_PDB:

PDB Tagged Data Manipulation
================================================================================

.. index::
   single: PDB data

The :oe:cls:`OEChem::OEPDBDataPair<OEChem::OESDDataPair>` class is used to set
and retrieve PDB data pairs.

.. list-table::
   :widths: 20 30 30
   :header-rows: 1

   * - Data
     - Set method
     - Get method

   * -  tag
     - :oe:meth:`OEChem::OEPDBDataPair::SetTag<OEChem::OESDDataPair::SetTag>`
     - :oe:meth:`OEChem::OEPDBDataPair::GetTag<OEChem::OESDDataPair::GetTag>`

   * - data
     - :oe:meth:`OEChem::OEPDBDataPair::SetValue<OEChem::OESDDataPair::SetValue>`
     - :oe:meth:`OEChem::OEPDBDataPair::GetValue<OEChem::OESDDataPair::GetValue>`

.. oe:language:: c++

   If you wish to store a numeric value, use :oe:func:`OESystem::OENumberToString`
   function to convert it to a string and then use :oe:func:`OESystem::OEStringToNumber`
   on the value when retrieving the data (see examples in :ref:`section_moltaggeddata_SD`).

.. oe:language:: python

   If you wish to store a numeric value, use Python's ``str()`` method to
   convert it to a string and then use ``int()`` or ``float()`` on the
   value when retrieving the data (see examples in :ref:`section_moltaggeddata_SD`).

.. oe:language:: java

   If you wish to store a numeric value, use Java's
   ``.toString()`` method to convert it to a string
   (see examples in :ref:`section_moltaggeddata_SD`).

.. oe:language:: csharp

   If you wish to store a numeric value, use C#'s
   ``.ToString()`` method to convert it to a string
   (see examples in :ref:`section_moltaggeddata_SD`).

The following functions provide access to the PDB data.

.. list-table::  Functions to manipulate PDB data
   :widths: 15 30
   :header-rows: 1

   * - Function
     - Description

   * - :oe:func:`OEChem::OESetPDBData`
     - set a tag and value data pair

   * - :oe:func:`OEChem::OEAddPDBData`
     - add a tag and value data pair

   * - :oe:func:`OEChem::OEHasPDBData`
     - determine whether a molecule has data with a given tag

   * - :oe:func:`OEChem::OEGetPDBData`
     - get the value for the given tag

   * - :oe:func:`OEChem::OEGetPDBDataPairs`
     - return an iterator over all the PDB data pairs of the molecule

   * - :oe:func:`OEChem::OECopyPDBData`
     - copy the entire set of PDB data from one molecule to another

   * - :oe:func:`OEChem::OEDeletePDBData`
     - delete all PDB data items with the given tag

   * - :oe:func:`OEChem::OEClearPDBData`
     - clear all PDB data from a molecule

.. note::

   In case of PDB header items like REMARK, each line is treated as a
   separate instance, Therefore these multiple lines have to be added
   with :oe:func:`OEChem::OEAddPDBData` and can be accessed via
   :oe:func:`OEChem::OEGetPDBDataPairs`.

The following PDB fields are stored as tagged PDB data when
:oe:const:`OEChem::OEIFlavor::PDB::DATA` input flavor is set:

.. list-table:: **Imported PDB data fields**
   :widths: 25 25 25 25 25
   :header-rows: 0

   * - `AUTHOR`_
     - `CAVEAT`_
     - `COMPND`_
     - `CRYST1`_
     - `DBREF`_

   * - `EXPDTA`_
     - `FORMUL`_
     - `HEADER`_
     - `HELIX`_
     - `HET`_

   * - `HETNAM`_
     - `HETSYM`_
     - `JRNL`_
     - `KEYWDS`_
     - `MODRES`_

   * - `MTRIX1`_
     - `MTRIX2`_
     - `MTRIX3`_
     - `OBSLTE`_
     - `ORIGX1`_

   * - `ORIGX2`_
     - `ORIGX3`_
     - `REMARK`_
     - `REVDAT`_
     - `SCALE1`_

   * - `SCALE2`_
     - `SCALE3`_
     - `SEQRES`_
     - `SEQADV`_
     - `SHEET`_

   * - `SITE`_
     - `SOURCE`_
     - `SPRSDE`_
     - `SSBOND`_
     - `TITLE`_

   * - `TURN`_
     -
     -
     -
     -

.. warning::

   The tags of PDB data are always 6 characters long and space-padded
   (for example ``"HELIX "`` and not ``"HELIX"`` ).

The following example shows how to manipulate PDB tagged data.

.. oe:source:: ManipulatePDBData.cpp
   :language: c++
   :refnum:   3
   :caption:  PDB data manipulation
   :frag:     SNIPPET

.. oe:source:: ManipulatePDBData.py
   :language: python
   :refnum:   3
   :caption:  PDB data manipulation
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-ManipulatePDBData.py>`

.. oe:source:: ManipulatePDBData.java
   :language: java
   :refnum:   3
   :caption:  PDB data manipulation
   :frag:     SNIPPET

.. oe:source:: ManipulatePDBData.cs
   :language: csharp
   :refnum:   3
   :caption:  PDB data manipulation
   :frag:     SNIPPET

The output of the preceding program for 1D1H is the following:

.. code-block:: bash

   COMPND:
       MOL_ID: 1;
   HELIX:
      1   1 THR A   11  ASP A   14  5
   SSBOND:
      1 CYS A    2    CYS A   16                          1555   1555
      2 CYS A    9    CYS A   21                          1555   1555
      3 CYS A   15    CYS A   28                          1555   1555

.. note::

   Note that PDB tagged data is specific to PDB file format.
   Any PDB data added to a molecule will only be written out to PDB files
   or OEBinary files.

.. seealso::

   * :ref:`chapter_genericdata` chapter

.. _section_moldata_cif:

CIF File Format
================================================================================
.. index::
   single: CIF data

The CIF file format is built around keywords, terminology, and structure to allow for a robust and customizable
file format for atomic coordinate and biomolecule structure files.
This format has generated multiple different sub-genres of CIF file formats: Small Molecule CIF (smCIF),
Macro Molecular CIF (mmCIF), Chemical Component CIF (ccCIF), and Structure Factor CIF (sfCIF).
All CIF file formats follow the same general terminology.
Below is a brief introduction to this terminology using an mmCIF example, but for a more complete
explanation of CIF syntax, see the `PDBx/mmCIF User Guide 
<https://mmcif.wwpdb.org/docs/user-guide/guide.html>`_ from the `wwPDB <https://www.wwpdb.org>`_.

The following example comes from the mmCIF file for the 3TPP PDB code.

.. code-block:: bash

   data_3TPP
   #
   _entry.id   3TPP
   #
   _audit_conform.dict_name       mmcif_pdbx.dic
   _audit_conform.dict_version    5.397
   _audit_conform.dict_location   http://mmcif.pdb.org/dictionaries/ascii/mmcif_pdbx.dic
   #
   loop_
   _database_2.database_id
   _database_2.database_code
   _database_2.pdbx_database_accession
   _database_2.pdbx_DOI
   PDB   3TPP         pdb_00003tpp 10.2210/pdb3tpp/pdb
   RCSB  RCSB067767   ?            ?
   WWPDB D_1000067767 ?            ?

Data blocks are used to organize an entire set of related data. Because all the data in this CIF file relate to the
3TPP structure, all data in this example are in the same data block. The start of a data block uses the ``data_`` keyword
at the start of the line.

CIF categories are a grouping of related information within the data block and all data within the same category will
have the same category name.

In the above example, there are three categories: ``_entity.``, ``_audit_conform.``, and ``_database_2.``. 
Toolkit function references to category names require these values to be formatted with a
leading underscore + the category name + a trailing period. This category name nomenclature ensures consistency and
reduces the potential for misidentifying categories with similar names.

Attributes name the different data types of values saved in the category, and the combination of a category and
attribute is called a data item. In the example, the ``_database_2.`` category contains four attributes:
``database_id``, ``database_code``, ``pdbx_database_accession``, and ``pdbx_DOI``, and combining a category and
an attribute results in a data item: ``_database_2.database_id``.

Categories can come in two types: pair and loop. In a pair category, every data item is paired with a single value.
The ``_audit_conform.`` is a pair type data item. In a loop category, multiple rows of data correlate with
the data items where the number of data columns equal and correlate to the number of data items in the category.
The ``_database_2`` is a loop type category.

The :oe:cls:`OEChem::OECIFData<OEChem::OECIFData>` class can be used to access row and attribute (column) data in a
category. For example, use the `GetRow("_database_2.", 1)` method to get the second row in the ``database_2`` category:
``"RCSB"``, ``"RCSB067767"``, ``"?"``, ``"?"``.
Use the ``GetAttributeValues("_database_2.", "database_id")`` method to get the ``database_id`` column values:
``"PDB"``, ``"RCSB"``, ``"WWPDB"``.

.. seealso::

   * :ref:`chapter_genericdata` chapter 
   * :oe:cls:`OEChem::OECIFData<OEChem::OECIFData>` class
   * :oe:func:`OESystem::OEReadCIFGridFile` function

.. _section_moldata_mmcif:

mmCIF Metadata Manipulation
================================================================================

.. index::
   single: MMCIF data

mmCIF metadata is not stored as tagged data in the same way that PDB data is. Instead,
the mmCIF metadata is stored as a single string that can be retrieved, manipulated, and
set or appended to.

The following functions provide access to the mmCIF data.

.. list-table::  Functions to manipulate mmCIF metadata
   :widths: 15 30
   :header-rows: 1

   * - Function
     - Description

   * - :oe:func:`OEChem::OESetMMCIFData`
     - Sets mmCIF metadata on a molecule, overwrites if any existing metadata

   * - :oe:func:`OEChem::OEAddMMCIFData`
     - Adds mmCIF metadata on a molecule, appends to any existing metadata

   * - :oe:func:`OEChem::OEHasMMCIFData`
     - Determines whether a molecule has mmCIF metadata stored

   * - :oe:func:`OEChem::OEGetMMCIFData`
     - Retrieves the mmCIF metadata stored on a molecule

   * - :oe:func:`OEChem::OECopyMMCIFData`
     - Copies the mmCIF metadata from one molecule to another

   * - :oe:func:`OEChem::OEClearMMCIFData`
     - Clears the mmCIF metadata from a molecule

   * - :oe:func:`OEChem::OEUpdateMMCIFData`
     - Updates mmCIF metadata using molecule structural information

When writing mmCIF metadata, the default behavior is to write the header as is and without modification so long as it is
formatted correctly. The only exception is if important CIF sections of the header are missing, in which case they will
be perceived at write time or if header data is updated. See the :ref:`section_mmcif_perception` section below.

For mmCIF, these essential categories are:
   * _entity.
   * _entity_poly_seq.
   * _chem_comp.
   * _cell.
   * _symmetry.
   * _struct_asym.
   * _struct_conn.

For Chemical Component CIF, these essential categories are:
   * _chem_comp.
   * _chem_comp_atom.
   * _chem_comp_bond.

To synchronize header data with a molecule, or to manually interact with header data, the
:oe:cls:`OEChem::OECIFData` class allows for programmatic access to the header values and includes
functionality to update specific sections of the header with a molecule's structural data.
The :oe:func:`OEChem::OEUpdateMMCIFData` function can be used to run a one-time update to the header metadata.

.. seealso::

   * :ref:`chapter_genericdata` chapter 
   * :oe:cls:`OEChem::OECIFData<OEChem::OECIFData>` class
   * :oe:func:`OEChem::OEUpdateMMCIFData` function

.. _section_mmcif_perception:

mmCIF Header Perception
================================================================================

.. index::
   single: MMCIF data perception

A molecule can contain information used to perceive data item values in the mmCIF header. This information is coordinated
and can be called using the :oe:cls:`OEChem::OECIFData` class or :oe:func:`OEChem::OEUpdateMMCIFData`
function. Which data items are perceived during that update is controlled by the :oe:cls:`OEChem::OECIFOptions`
class. This class breaks perception into seven categories: ``Entity``, ``ChemComp``,
``Cell``, ``Symmetry``, ``Struct``, ``Experimental``,
and ``Other``.
If perception is turned on for any of these categories, category attributes and values can be altered or deleted.

The follow table outlines what CIF categories and attributes could be affected by perception during header updates:

.. table:: OECIFOptions and Corresponding Perceived Categories
   :widths: 20 20

   +-------------------------+-------------------------------------------------+
   | OECIFOptions            | Related mmCIF Categories                        |
   +=========================+=================================================+
   | SetPerceiveEntity       | | **_entity.id**                                |
   |                         | | **_entity.type**                              |
   |                         | | **_entity_poly.entity_id**                    |
   |                         | | **_entity_poly.type**                         |
   |                         | | **_entity_poly.pdbx_seq_one_letter_code**     |
   |                         | | **_entity_poly.pdbx_seq_one_letter_code_can** |
   |                         | | **_entity_poly_seq.entity_id**                |
   |                         | | **_entity_poly_seq.num**                      |
   |                         | | **_entity_poly_seq.mon_id**                   |
   |                         | | **_entity_poly_seq.hetero**                   |
   +-------------------------+-------------------------------------------------+
   | SetPerceiveChemComp     | | **_chem_comp.id**                             |
   |                         | | **_chem_comp.type**                           |
   |                         | | **_chem_comp.mon_nstd_flag**                  |
   |                         | | **_chem_comp.name**                           |
   |                         | | **_chem_comp.pdbx_synonyms**                  |
   |                         | | **_chem_comp.formula**                        |
   |                         | | **_chem_comp.formula_weight**                 |
   |                         | | **_chem_comp_atom.comp_id**                   |
   |                         | | **_chem_comp_atom.atom_id**                   |
   |                         | | **_chem_comp_atom.type_symbol**               |
   |                         | | **_chem_comp_atom.charge**                    |
   |                         | | **_chem_comp_bond.comp_id**                   |
   |                         | | **_chem_comp_bond.atom_id_1**                 |
   |                         | | **_chem_comp_bond.atom_id_2**                 |
   |                         | | **_chem_comp_bond.type**                      |
   |                         | | **_chem_comp_bond.aromaticc**                 |
   +-------------------------+-------------------------------------------------+
   | SetPerceiveStruct       | | **_struct_asym.id**                           |
   |                         | | **_struct_asym.entity_id**                    |
   |                         | | **_struct_conn.**                             |
   |                         | | _struct.                                      |
   |                         | | _struct_ref.                                  |
   |                         | | _struct_ref_seq.                              |
   |                         | | _struct_conf.                                 |
   |                         | | _struct_sheet.                                |
   |                         | | _struct_biol.                                 |
   |                         | | _struct_keywords.                             |
   |                         | | _struct_ncs_opr.                              |
   |                         | | pdbx_struct_mod_residues.                     |
   +-------------------------+-------------------------------------------------+
   | SetPerceiveSymmetry     | | _symmetry.entry_id                            |
   |                         | | _symmetry.space_group_name_H-M                |
   +-------------------------+-------------------------------------------------+
   | SetPerceiveCell         | | _cell.                                        |
   |                         | | _atom_sites.                                  |
   +-------------------------+-------------------------------------------------+
   | SetPerceiveExperimental | | _exptl.                                       |
   |                         | | _refine.                                      |
   |                         | | _refine_analysis.                             |
   |                         | | _refine_is_restr.                             |
   |                         | | _reflns.                                      |
   |                         | | _reflns_shell.                                |
   |                         | | _diffrn.                                      |
   |                         | | _pdbx_refine_tls.                             |
   +-------------------------+-------------------------------------------------+
   | SetPerceiveOther        | | _audit_author.                                |
   |                         | | _pdbx_database_status.                        |
   |                         | | _database_PDB_matrix .                        |
   |                         | | _software.                                    |
   +-------------------------+-------------------------------------------------+

Categories that are bold are primarily defined or affected by molecule structural data and
are consequently entirely redefined when updated. The remaining categories are coordinated with other parts of header
data when updating, but primarily contain attributes not perceived by molecular structure. The exhaustive list of these
coordinated but not perceived categories are outside the scope of this document, and only the most common are listed.

The ``_entity_poly_seq.`` category and associated ``_entity_poly.`` attributes allow for microheterogeneity between the
actual molecule sequence and the values in these categories. Consequently, these sequences are not a reflection of the
molecule, but a reference to the intended polymeric sequence of molecule.
This may result in unexpected behavior during perception if data is missing or inconsistent with the polymeric sequence.
When disagreement between attribute values and molecule sequences are encountered, disagreeing values
may be deleted from the header.
For these sequence-based attributes to persist through perception, all existing values must align with the macro molecules
sequence data, otherwise it is considered undefined and will not be populated. If these attribute values are missing
prior to perception, they are considered unknowable and will not be populated.

It is important to note that perception and synchronization only occur with the molecule informing header data.
Changes in the header will not alter the molecular structure in any way.


.. _chapter_multithreading:

********************************************************************************
Multi-Threading
********************************************************************************

**OpenEye** deems only the following toolkits "thread-safe":

 - OEChem TK (including oeplatform, oesystem, oechem, and oebio)
 - OEDepict TK
 - OEDocking TK
 - Grapheme TK
 - GraphSim TK
 - Lexichem TK
 - Omega TK

.. warning::

   Absolutely no guarantee is made about the thread-safety of any
   other library not on the preceding list.

The most common reason to multi-thread a program is for
performance. However, threading has certain overhead costs associated
with it. The user should profile their application to determine the
best possible way to parallelize it. There is no guarantee
that multi-threading a program will make it run faster, in fact, it
can make it run dramatically more slowly. Some of the examples presented in
this chapter will perform more slowly than their single-threaded counterparts. 
They were chosen for the simplicity of demonstrating certain
concepts. The user should perform timing analysis on the code in this
chapter on their own systems to determine whether the methods are
appropriate for them.

.. oe:language:: c++ python

   .. warning::

      By default, it is not safe to pass instances of the following
      **OpenEye Toolkit** objects between threads:

      - Any **OpenEye Toolkit** :ref:`iterator object
        <section_atombondtraversal_iter>`, i.e., something derived
        from :ref:`OEIterBase <OESystem_OEIterBase>`.
      - Any :ref:`OEGetNbrAtom <OEChem_OEGetNbrAtom>` functor. This is used by
        some implementations of
        :oe:meth:`OEChem::OEAtomBase::GetAtoms` that returns an
        iterator as well, see previous.
      - The :ref:`OEMatch <OEChem_OEMatch>` class. Used by almost any API
        that operates with an instance of
        :ref:`OEMatchBase <OEChem_OEMatchBase>`.
      - :oe:const:`OEChem::OEMolBaseType::OEMiniMol` instances of
        :ref:`OEGraphMol <OEChem_OEGraphMol>`.
      
      Doing so will likely cause a crash due to **OpenEye Toolkits**
      use of thread-local memory caches that can not be shared across
      threads. If a multi-threaded **OpenEye Toolkit** program
      crashes, a good first solution to try is inserting the following
      at the beginning of ``main``.

      .. oe:language:: c++

         .. code-block:: c++

            OESetMemPoolMode(OEMemPoolMode::System);

      .. oe:language:: python

         .. code-block:: python

            OESetMemPoolMode(OEMemPoolMode_System)

      However, there is a performance cost to turning off all
      **OpenEye Toolkits** memory caches using the above. It may be
      possible to gain that performance back by using an allocator
      better tuned to the specific application. For multi-threaded
      applications, the following allocators are known to be very
      performant:

       - `TCMalloc <http://goog-perftools.sourceforge.net/doc/tcmalloc.html>`_
       - `Hoard <http://www.hoard.org>`_

      .. note:: 

         Prior to the 2015.Oct release, molecule and substructure
         search objects could not be shared between threads. This
         could easily cause crashes to occur whenever using the
         following classes inside an :ref:`OEOnce <OEPlatform_OEOnce>`
         construct:
         
         - :ref:`OEGraphMol <OEChem_OEGraphMol>` (note:
           :oe:const:`OEChem::OEMolBaseType::OEMiniMol` is still not
           safe)
         - :ref:`OEMol <OEChem_OEMol>`
         - :ref:`OEQMol <OEChem_OEQMol>`
         - :ref:`OESubSearch <OEChem_OESubSearch>`

         The above objects can now be safely passed between threads
         and used in :ref:`OEOnce <OEPlatform_OEOnce>` function local
         statics. As of 2015.Oct, the above objects now manage their
         own memory pools on a per-object basis. This can possibly
         lead to more memory waste, as each molecule has enough space
         to store 64 atoms and bonds by default, even if it is
         empty. This is why the
         :oe:const:`OEChem::OEMolBaseType::OEMiniMol` molecule
         implementation uses the older memory pooling, as that is
         designed for memory efficiency.

.. _section_inputandoutputthreads:

Input and Output Threads
================================================================================

**OEChem TK** provides a rather advanced mechanism for spawning a thread to
handle I/O asynchronously. Parallelizing I/O operations can yield
significant performance gains when dealing with  bulky file
formats like SDF and MOL2, or when dealing with files on network
mounted directories. Naturally, performance gains may vary based upon
the system configuration in question.

The input and output threads are encapsulated inside the
:oe:cls:`oemolthread<OEChem::oemolthreadbase>`
abstraction. :oe:cls:`oemolthreads<OEChem::oemolthreadbase>` are
designed to behave as similarly as possible to
:oe:cls:`oemolstreams<OEChem::oemolstreambase>`. This should allow easy
drop in replacement to existing code by simply changing the type of a
variable from :ref:`oemolistream <OEChem_oemolistream>` to
:ref:`oemolithread <OEChem_oemolithread>` for input, and
:ref:`oemolostream <OEChem_oemolostream>` to :ref:`oemolothread <OEChem_oemolothread>` for
output.

For example, the :oe:src:`MolFind<MolFind>` program described in the
:ref:`section_patternmatch_sss` section can be modified to the nearly
identical program in :oe:src:`Listing 1<SNIPPET-ThreadedMolFind>`.

.. oe:source:: ThreadedMolFind.cpp
   :language: c++
   :refnum:   1
   :caption:  Using Threaded Input and Output
   :frag:     SNIPPET

.. oe:source:: ThreadedMolFind.py
   :language: python
   :refnum:   1
   :caption:  Using Threaded Input and Output
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-ThreadedMolFind.py>`

.. oe:source:: ThreadedMolFind.java
   :language: java
   :refnum:   1
   :caption:  Using Threaded Input and Output
   :frag:     SNIPPET

.. oe:source:: ThreadedMolFind.cs
   :language: csharp
   :refnum:   1
   :caption:  Using Threaded Input and Output
   :frag:     SNIPPET

.. note:: 

   Both :oe:cls:`oemolstreams<OEChem::oemolstreambase>` and
   :oe:cls:`oemolthreads<OEChem::oemolthreadbase>` should be evaluated
   for performance. :oe:cls:`oemolthreads<OEChem::oemolthreadbase>`
   increase user time CPU usage to save on potentially expensive
   system calls.

The difference in :oe:src:`Listing 1<SNIPPET-oemolthread-ThreadedMolFind>` may be a little
difficult to spot for the experienced **OEChem TK** programmer used to
seeing :oe:cls:`oemolstream<OEChem::oemolstreambase>` declarations,
however, the following two declarations are not
:oe:cls:`oemolstreams<OEChem::oemolstreambase>`. They are
:oe:cls:`oemolthreads<OEChem::oemolthreadbase>` meant to behave as
closely as possible to :oe:cls:`oemolstreams<OEChem::oemolstreambase>`.

.. oe:source:: ThreadedMolFind.cpp
   :language: c++
   :frag:     SNIPPET-oemolthread

.. oe:source:: ThreadedMolFind.py
   :language: python
   :frag:     SNIPPET-oemolthread

.. oe:source:: ThreadedMolFind.java
   :language: java
   :frag:     SNIPPET-oemolthread

.. oe:source:: ThreadedMolFind.cs
   :language: csharp
   :frag:     SNIPPET-oemolthread

However, :oe:cls:`oemolthreads<OEChem::oemolthreadbase>` could not be
made to behave *exactly* like
:oe:cls:`oemolstreams<OEChem::oemolstreambase>`. The following key
differences between :oe:cls:`oemolthreads<OEChem::oemolthreadbase>` and
:oe:cls:`oemolstreams<OEChem::oemolstreambase>` should be taken into
account:

:oe:cls:`oemolthreads<OEChem::oemolthreadbase>` do not support stream
methods: :oe:meth:`read<OEChem::oemolistream::read>`,
:oe:meth:`seek<OEChem::oemolistream::seek>`,
:oe:meth:`size<OEChem::oemolistream::size>`, and
:oe:meth:`tell<OEChem::oemolistream::tell>`.

   These do not make much sense in a multi-threaded environment where
   the I/O thread can be at any arbitrary location in the file. Using
   the methods would be prone to race conditions.

The :ref:`oemolithread <OEChem_oemolithread>` default
:oe:meth:`constructor<OEChem::oemolithread::Constructors>` does not
default to ``stdin``.

   The default constructor of :ref:`oemolistream <OEChem_oemolistream>` will open
   the stream on ``stdin``. However, read operations are handled by a
   separate opaque I/O thread inside the
   :ref:`oemolithread <OEChem_oemolithread>`. The I/O thread uses blocking reads
   that do not return unless the user closes ``stdin`` of the
   process. :oe:cls:`oemolithreads<OEChem::oemolithread>` can still
   read from ``stdin`` using the same syntactic trick described in the
   :ref:`section_molreadwrite_commandlineformatcontrol` section
   supplied to :oe:meth:`open<OEChem::oemolstreambase::open>` or the
   :oe:meth:`constructor<OEChem::oemolithread::Constructors>` which
   takes a ``string``.
  
The :ref:`oemolithread <OEChem_oemolithread>` does not support the
:oe:meth:`SetConfTest<OEChem::oemolistream::SetConfTest>` interface.

   As will be described later, the I/O threads inside
   :oe:cls:`oemolthreads<OEChem::oemolthreadbase>` do a minimal amount
   of work to maximize scalability in parallel applications. The work
   described in the :ref:`section_oemol_inputandoutput` section to
   recover multi-conformer molecules from single-conformer file formats
   can be quite expensive. Note, this does not preclude
   :oe:cls:`oemolithreads<OEChem::oemolithread>` from reading
   multi-conformer molecules from file formats that support them
   inherently, *e.g.*, multi-conformer molecules can be read out of
   multi-conformer OEB files through
   :oe:cls:`oemolithreads<OEChem::oemolithread>`.

With all the preceding considerations taken into account the real gain
of :oe:cls:`oemolthreads<OEChem::oemolthreadbase>` is that
:oe:func:`OEChem::OEReadMolecule` and :oe:func:`OEChem::OEWriteMolecule`
can be safely called from multiple threads onto the same
:oe:cls:`oemolthread<OEChem::oemolthreadbase>`. They are guaranteed to
be free of race conditions when applied to
:oe:cls:`oemolthreads<OEChem::oemolthreadbase>`. Not only that, the
expensive parsing (:oe:func:`OEChem::OEReadMolecule`) and serialization
(:oe:func:`OEChem::OEWriteMolecule`) occurs in the thread that calls
the function, not in the :oe:cls:`oemolthread<OEChem::oemolthreadbase>`
itself. The :oe:cls:`oemolthread<OEChem::oemolthreadbase>` takes care
of I/O and compression if reading or writing to a ``.gz`` file.

.. _figure_oemolithread:

.. figure:: /_images/oemolithread.png
   :align:  center
   :scale:  100

   **oemolithread**

   *Diagram of data flow inside an oemolithread*

.. _figure_oemolothread:

.. figure:: /_images/oemolothread.png
   :align:  center
   :scale:  100

   **oemolothread**

   *Diagram of data flow inside an oemolothread*

:ref:`Figure: oemolithread<figure_oemolithread>` and 
:ref:`Figure: oemolothread<figure_oemolothread>` shows how
data flows between an arbitrary number of worker threads and the I/O
thread. Molecule data passes through a protected bounded buffer. It is
"protected" against race conditions when multiple threads operate on
the buffer. It is "bounded" in size to prevent increasing the required
amount of memory by inserting many items into the buffer faster than
can be consumed on the other side. The I/O threads will be put to
sleep, allowing other threads to use the CPU, when there is not a
sufficient amount of work for them to do. This means the number of
worker threads should typically be the number of available CPUs. The
I/O threads don't require much CPU time, therefore, they don't need
their own dedicated CPU. This could change as the number of worker
threads increases, or if the I/O thread is expected to handle data
compression or uncompression.

:oe:src:`Listing 2<SNIPPET-MultiCoreMolFind>` demonstrates how to scale the
:ref:`molecule searching <section_patternmatch_sss>` program to
multiple CPUs. A worker thread is dedicated for each CPU. There are
also I/O threads to handle the input and output operations. The data
parsing (:oe:func:`OEChem::OEReadMolecule`), substructure
searching(:oe:meth:`OEChem::OESubSearch::SingleMatch`), and data
serialization (:oe:func:`OEChem::OEWriteMolecule`) is all done in
parallel by the worker threads. The costly synchronization point of
reading and writing data is handled by the separate I/O threads.

.. oe:source:: MultiCoreMolFind.cpp
   :language: c++
   :refnum:   2
   :caption:  Using multiple threads to read and write to molthreads
   :frag:     SNIPPET

.. oe:source:: MultiCoreMolFind.py
   :language: python
   :refnum:   2
   :caption:  Using multiple threads to read and write to molthreads
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-MultiCoreMolFind.py>`

.. oe:source:: MultiCoreMolFind.java
   :language: java
   :refnum:   2
   :caption:  Using multiple threads to read and write to molthreads
   :frag:     SNIPPET

.. oe:source:: MultiCoreMolFind.cs
   :language: csharp
   :refnum:   2
   :caption:  Using multiple threads to read and write to molthreads
   :frag:     SNIPPET

.. oe:language:: c++

   .. note:: 

      Threading is automatically handled by `OpenMP
      <http://openmp.org>`_ pragmas.

.. oe:language:: python

   .. warning:: 

      The `global interpreter lock
      <http://docs.python.org/c-api/init.html#thread-state-and-the-global-interpreter-lock>`_
      can eliminate any chance of scaling across multiple
      processors. It depends how much of the run time is in C++ and
      how much is in Python. 

:oe:src:`Listing 2<SNIPPET-MultiCoreMolFind>` will generate the same set of
molecules in the output file as :oe:src:`Listing
1<ThreadedMolFind>`. However, there is big difference between the
output files, the molecule order is non-deterministic. For most users
this does not matter, database files are treated as arbitrarily
ordered sets of molecules. If the order of the molecule database is
important do not use the program in :oe:src:`Listing
2<SNIPPET-MultiCoreMolFind>`.

.. note:: 
   
   Database order is preserved by the program in :oe:src:`Listing
   1<SNIPPET-ThreadedMolFind>` because there is only one worker thread. This
   allows users with database order restrictions to still take
   advantage of threaded asynchronous I/O.

.. _section_threadsafety:

Thread Safety
================================================================================

**OEChem TK** is considered to be a "thread-safe" library. It makes the
same guarantees the C++ Standard Template Library (STL) makes in
concern of threads:

::

   Unless otherwise specified, standard library classes may safely be
   instantiated from multiple threads and standard library functions
   are reentrant, but non-const use of objects of standard library
   types is not safe if shared between threads. Use of non-constness
   to determine thread-safety requirements ensures consistent
   thread-safety specifications without having to add additional
   wording to each and every standard library type.

.. seealso::

   * `Thread-Safety in the Standard Library
     <http://www.open-std.org/JTC1/sc22/wg21/docs/papers/2008/n2669.htm>`_

Classes
----------

Unless otherwise stated in the API documentation, :ref:`OEChem objects
<OEChemClasses>` can be instantiated and used in multiple
threads. For example, in :oe:src:`Listing 2<SNIPPET-MultiCoreMolFind>`, special
care was taken to make the molecule object local to each thread.

.. oe:language:: c++
   
   This was accomplished through the private clause to the `OpenMP
   <http://openmp.org>`_ parallel pragma.

.. oe:language:: python

   This was accomplished by calling the
   ``OEChem::oemolithread::GetOEGraphMols``
   method in each thread. An :ref:`OEGraphMol <OEChem_OEGraphMol>` is
   constructed local to each
   ``OEChem::oemolithread::GetOEGraphMols``
   generator invocation.
   
.. oe:language:: java

   This was accomplished by making an :ref:`OEGraphMol <OEChem_OEGraphMol>`
   instance local to the thread's ``run`` method. Therefore, ensuring
   each thread had a separate :ref:`OEGraphMol <OEChem_OEGraphMol>` to read
   molecules into.

.. oe:language:: csharp

   This was accomplished by making an :ref:`OEGraphMol <OEChem_OEGraphMol>`
   instance local to the thread's ``run`` method. Therefore, ensuring
   each thread had a separate :ref:`OEGraphMol <OEChem_OEGraphMol>` to read
   molecules into.

.. oe:source:: MultiCoreMolFind.cpp
   :noindent:
   :language: c++
   :frag:     SNIPPET-privatemol

.. oe:source:: MultiCoreMolFind.py
   :noindent:
   :language: python
   :frag:     SNIPPET-privatemol

.. oe:source:: MultiCoreMolFind.java
   :noindent:
   :language: java
   :frag:     SNIPPET-privatemol

.. oe:source:: MultiCoreMolFind.cs
   :noindent:
   :language: csharp
   :frag:     SNIPPET-privatemol

The same object can be accessed from multiple threads if all access is
through a ``const`` method. A ``const`` method is any method that does
not change data internal to the class. In C++, a method can be
explicitly marked ``const``, allowing the compiler to cause the
code to not compile if this guarantee is not kept.

For example, the :oe:meth:`OEChem::OESubSearch::SingleMatch` method is
a ``const`` method. Therefore, the same :ref:`OESubSearch <OEChem_OESubSearch>`
object can be used from multiple threads without the need to make
local copies of the :ref:`OESubSearch <OEChem_OESubSearch>` object in
:oe:src:`Listing 2<SNIPPET-MultiCoreMolFind>`. However, notice that the
molecule argument passed to :oe:meth:`OEChem::OESubSearch::SingleMatch`
is local to each thread. Otherwise, one thread could be reading data
into the molecule object while another thread is trying to perform the
substructure search, leading to a race condition and undefined
behavior.

.. oe:source:: MultiCoreMolFind.cpp
   :noindent:
   :language: c++
   :frag:     SNIPPET-constmethod

.. oe:source:: MultiCoreMolFind.py
   :noindent:
   :language: python
   :frag:     SNIPPET-constmethod

.. oe:source:: MultiCoreMolFind.java
   :noindent:
   :language: java
   :frag:     SNIPPET-constmethod

.. oe:source:: MultiCoreMolFind.cs
   :noindent:
   :language: csharp
   :frag:     SNIPPET-constmethod

.. warning::
   
   Care must be taken when reusing the same objects in multiple
   threads. Only one invocation of a non-``const`` method
   (*e.g.* :oe:meth:`OEChem::OESubSearch::AddConstraint`) concurrently
   could crash the program. Concurrent execution of non-``const``
   methods must to be protected by :oe:cls:`mutual
   exclusion<OEPlatform::OEMutex>`.

Functions
----------

:ref:`OEChem functions <chapter_oechemfunctions>`, unless otherwise
stated in the API documentation, can be safely called from multiple
threads. For example, :oe:func:`OESystem::OEGetTag` needs to access a
global table to make ``string`` to ``unsigned integer`` associations
global to the program. :oe:func:`OESystem::OEGetTag` ensures its own
thread safety so that it is safe to call from multiple threads.

However, mutual exclusion can be very expensive. This is why **OEChem TK**
(and the STL) make no effort to make concurrent object access
safe. So when mutual exclusion can not be avoided, as in the case of
:oe:func:`OESystem::OEGetTag`, faster alternatives should be
sought. For example, the return of :oe:func:`OESystem::OEGetTag` can
be cached to a local variable.

.. oe:language:: c++ 

   .. code-block:: c++

      void func()
      {
         static unsigned int tag = OEGetTag("foo");
         ...
      }

   or reuse that tag,

   .. code-block:: c++

      unsigned int MyFooTag()
      {
          static unsigned int tag = OEGetTag("foo");
          return tag;
      }

It is important to realize that even though the function may be
thread-safe, the function may be altering the state of its arguments,
which could be shared across threads. Again, the "const-ness" of the
arguments must be taken into account. For example, it is not safe to
call :oe:func:`OEChem::OEWriteMolecule` on the same molecule from
separate threads (even on different
:oe:cls:`oemolostreams<OEChem::oemolostream>`) because the molecule
argument to :oe:func:`OEChem::OEWriteMolecule` is non-``const``. The
molecule argument is non-``const`` for performance, the molecule may
need to be changed to conform to the file format being written
to. **OEChem TK** provides :oe:func:`OEChem::OEWriteConstMolecule` that will
make a local copy of the molecule before making necessary changes for
the file format being requested.

Exceptions to the ``const`` argument rule must be explicitly stated in
the API documentation. For example, the
:oe:func:`OEChem::OEWriteMolecule` function applied to the
non-``const`` argument of :ref:`oemolothread <OEChem_oemolothread>` is thread-safe
only by virtue of design. 

.. oe:source:: MultiCoreMolFind.cpp
   :noindent:
   :language: c++
   :frag:     SNIPPET-writemolecule

.. oe:source:: MultiCoreMolFind.py
   :noindent:
   :language: python
   :frag:     SNIPPET-writemolecule

.. oe:source:: MultiCoreMolFind.java
   :noindent:
   :language: java
   :frag:     SNIPPET-writemolecule

.. oe:source:: MultiCoreMolFind.cs
   :noindent:
   :language: csharp
   :frag:     SNIPPET-writemolecule

.. _section_memorymanagement:

Memory Management
================================================================================

Memory allocation is often a bottleneck in any program. This is
especially the case in multi-threaded programs because memory
allocation must protect a globally shared resource, the memory space
of the process. Most ``malloc`` implementations use mutual exclusion
to make themselves thread-safe. However, mutual exclusion is
expensive, and cuts down on the scalability of the multi-threaded
program.  **OEChem TK** attempts to alleviate the problem by implementing a
memory cache for the following small objects: 

- Any **OpenEye Toolkit** :ref:`iterator object
  <section_atombondtraversal_iter>`, i.e., something derived
  from :ref:`OEIterBase <OESystem_OEIterBase>`.
- Any :ref:`OEGetNbrAtom <OEChem_OEGetNbrAtom>` functor. This is used by
  some implementations of
  :oe:meth:`OEChem::OEAtomBase::GetAtoms` that returns an
  iterator as well, see previous.
- The :ref:`OEMatch <OEChem_OEMatch>` class. Used by almost any API
  that operates with an instance of
  :ref:`OEMatchBase <OEChem_OEMatchBase>`.
- :oe:const:`OEChem::OEMolBaseType::OEMiniMol` instances of
  :ref:`OEGraphMol <OEChem_OEGraphMol>`.

The cache is totally opaque to the normal **OEChem TK** user. However, it
can cause problems in multi-threaded situations.

The small object cache implementation is controlled through the
:oe:func:`OESystem::OESetMemPoolMode` function. The parameter passed to
this function determines what sort of cache implementation to use, the
possible options are a set of values bit-wise or'd from the
:oe:constns:`OESystem::OEMemPoolMode` constant namespace. The possible
combinations are as follows:

.. oe:language:: java

   .. warning:: 

      :oe:func:`OESystem::OESetMemPoolMode` is not available in
      Java. The reason is explained :ref:`later
      <multithreading_javamempoolmode>`.

.. |SingleThreaded| replace:: Makes no attempt at thread safety. 

.. |Mutexed| replace:: Protects a single global cache with a mutex.

.. |ThreadLocal| replace:: Uses a separate cache for each thread.

.. |BoundedCache| replace:: Will only cache allocations up to a
   certain size, then further allocations will be sent to the global
   ``operator new(size_t)`` function.

.. |UnboundedCache| replace:: Will cache all allocations up to any
   size, never returning memory to the operating system after it has
   been requested.

:SingleThreaded|BoundedCache: 

   |SingleThreaded| |BoundedCache|

:SingleThreaded|UnboundedCache:

   |SingleThreaded| |UnboundedCache|

:Mutexed|BoundedCache:

   |Mutexed| |BoundedCache|

:Mutexed|UnboundedCache:

   |Mutexed| |UnboundedCache|

:ThreadLocal|BoundedCache:

   |ThreadLocal| |BoundedCache|

:ThreadLocal|UnboundedCache:

   |ThreadLocal| |UnboundedCache|

:System:

   Forwards all allocations to the global ``operator new(size_t)``
   function. This allows the user to circumvent the entire caching
   system in preference to their own ``operator new(size_t)`` function
   allowing other third party memory allocators to be linked against.

.. oe:language:: c++ python

   The default implementation is ``ThreadLocal|UnboundedCache`` for
   performance in single threaded programs and thread safety in the
   most common multi-threaded programs (*e.g.* :oe:src:`Listing
   2<SNIPPET-MultiCoreMolFind>`).

.. oe:language:: java

   The default implementation in Java is ``Mutexed|UnboundedCache``.
   :oe:const:`Unbounded<OESystem::OEMemPoolMode::UnboundedCache>` for
   performance, however,
   :oe:const:`Mutexed<OESystem::OEMemPoolMode::Mutexed>` since the Java
   garbage collector runs in a separate thread.

.. oe:language:: csharp

   The default implementation in C# is ``Mutexed|UnboundedCache``.
   :oe:const:`Unbounded<OESystem::OEMemPoolMode::UnboundedCache>` for
   performance, however,
   :oe:const:`Mutexed<OESystem::OEMemPoolMode::Mutexed>` since the C#
   garbage collector runs in a separate thread.

Thread Safety Options
-----------------------

.. _multithreading_javamempoolmode:

.. oe:language:: java

   .. warning::

      The small object cache in Java **OEChem TK** must always be mutexed
      since the garbage collector runs in another thread. This is why
      :oe:func:`OESystem::OESetMemPoolMode` is not exposed in the Java
      interface.

.. oe:language:: c++ python

   :oe:func:`OESystem::OESetMemPoolMode` offers the following options
   for deciding the thread-safety of the cache implementation:
   :oe:const:`SingleThreaded<OESystem::OEMemPoolMode::SingleThreaded>`,
   :oe:const:`Mutexed<OESystem::OEMemPoolMode::Mutexed>`, 
   :oe:const:`ThreadLocal<OESystem::OEMemPoolMode::ThreadLocal>`, and
   :oe:const:`System<OESystem::OEMemPoolMode::System>`.

   If the program is known to only have a single thread there is a
   potential performance benefit in using the
   :oe:const:`OESystem::OEMemPoolMode::SingleThreaded` option. This
   flag tells the cache implementation it does not have to worry about
   being thread-safe.

.. oe:source:: SingleThreadedMolFind.cpp
   :language: c++
   :caption:  Setting single threaded memory pool mode
   :frag:     SNIPPET

.. oe:source:: SingleThreadedMolFind.py
   :language: python
   :caption:  Setting single threaded memory pool mode
   :frag:     SNIPPET

.. oe:language:: c++ python

   .. note::
   
      :oe:cls:`oemolthreads<OEChem::oemolthreadbase>` can still be used
      since they do not use the small object cache.

   The preceding program demonstrates how to use
   :oe:func:`OESystem::OESetMemPoolMode` to tell **OEChem TK** the program
   only contains a single thread using
   :oe:const:`OESystem::OEMemPoolMode::SingleThreaded`.
   :oe:const:`OESystem::OEMemPoolMode::UnboundedCache` is also used to get
   the maximum amount of performance out of **OEChem TK**. The options for
   the cache implementation are bitwise or'd together as shown in the
   following code snippet:

.. oe:source:: SingleThreadedMolFind.cpp
   :noindent:
   :language: c++
   :frag:     SNIPPET-SetMemPoolMode

.. oe:source:: SingleThreadedMolFind.py
   :noindent:
   :language: python
   :frag:     SNIPPET-SetMemPoolMode

.. oe:language:: c++ python

   The default thread safety level in **OEChem TK** is to use
   :oe:const:`OESystem::OEMemPoolMode::ThreadLocal` since it can offer
   performance nearly as good as
   :oe:const:`OESystem::OEMemPoolMode::SingleThreaded`. It also means
   the vast majority of multi-threaded **OEChem TK** programs will be
   thread-safe. This is because each thread gets its own dedicated
   small object cache.

   However, this introduces a memory leak when certain cached objects
   are created in one thread and then passed to another thread to be
   deleted.

If database order is a necessity it may be possible to gain
performance from threading using "pipeline"
parallelism. :oe:src:`Listing 3<SNIPPET-PipelineMolFind>` demonstrates how the
molecule searching problem can be broken down into 5 stages, each
running in a separate thread. In order, the 5 stages are:

 #. Reading data from disk - :ref:`oemolithread <OEChem_oemolithread>`
 #. Parsing the data into a molecule - ``ParseThread``
 #. Performing the substructure search on the molecule - ``SearchThread``
 #. Serializing the molecule - ``main thread``
 #. Writing data to disk - :ref:`oemolothread <OEChem_oemolothread>`

.. oe:source:: PipelineMolFind.cpp
   :language: c++
   :refnum:   3
   :caption:  Setting mutexed memory pool mode
   :frag:     SNIPPET

.. oe:source:: PipelineMolFind.py
   :language: python
   :refnum:   3
   :caption:  Setting mutexed memory pool mode
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-PipelineMolFind.py>`

.. oe:source:: PipelineMolFind.java
   :language: java
   :refnum:   3
   :caption:  Using pipeline parallelism in Java OEChem TK
   :frag:     SNIPPET

.. oe:source:: PipelineMolFind.cs
   :language: csharp
   :refnum:   3
   :caption:  Using pipeline parallelism in Java OEChem TK
   :frag:     SNIPPET

.. oe:language:: c++ python

   :oe:src:`Listing 3<SNIPPET-PipelineMolFind>` shows how a molecule can be
   passed down a pipeline of threads. 

.. oe:language:: c++ 
   
   .. note:: 
      
      The molecule factory, :oe:func:`OEChem::OENewMolBase`, is used so
      that pointers to molecules can be passed around. If
      :oe:cls:`OEGraphMols<OEChem::OEGraphMol>` were passed through the
      :ref:`OEProtectedBuffer <OESystem_OEProtectedBuffer>` it would require costly
      molecule copy operations to be performed in the
      :oe:meth:`Put<OESystem::OEProtectedBuffer::Put>` and
      :oe:meth:`Get<OESystem::OEProtectedBuffer::Get>`
      methods. Pointers are small and quick to copy, though care must
      be taken to ``delete`` the molecule in ``SearchThread`` or the
      ``main thread``.

Overriding the allocator
------------------------

.. oe:language:: csharp

   **OpenEye Toolkits** are hardcoded to use
   :oe:const:`OESystem::OEMemPoolMode::System` for C# and can not be
   changed at this time. Please contact support@eyesopen.com if you
   think this option may help you. 

.. oe:language:: java

   Memory pooling is even more important in Java because all **OpenEye
   Toolkit** memory allocation actually allocates memory from the JVM
   heap. Java maintains strict control over the amount of heap memory
   the JVM should use through the -Xmx flag. In order for the
   **OpenEye Toolkits** to adhere to these limits and put pressure on
   the garbage collector, all **OpenEye Toolkit** memory is allocated
   through the JNI as byte array objects. This makes small object
   memory caching even more important for Java as there is a higher
   overhead in both space and time for each memory allocation. 

   **OpenEye** testing has shown that the current default of
   ``Mutexed|UnboundedCache`` to be a good balance of performance and
   memory usage. However, it is not particularly suited to heavily
   multi-threaded Java programs due to the use of a mutex. While
   :oe:func:`OESystem::OESetMemPoolMode` is not available in Java
   because it is very race condition prone inside the JVM, there are
   the following environment variables that can be set to experiment
   with a better memory strategy:

   - ``OEJAVA_BOUNDED_CACHE``
   - ``OEJAVA_MEM_POOL_MODE``

   ``OEJAVA_BOUNDED_CACHE`` specifies that the memory pool mode should
   be ``Mutexed|UnboundedCache`` to be more aggressive about returning
   memory to the operating system.
   
   ``OEJAVA_MEM_POOL_MODE`` can take any integral value that
   :oe:func:`OESystem::OESetMemPoolMode` will accept. The user will
   have to go investigate the ``oesystem/threadsafe.h`` to figure out
   the right integer. The most common one is to use the integer ``16``
   for :oe:const:`OESystem::OEMemPoolMode::System` to bypass all small
   object caching. 

   .. warning::

      The use of these variable is intentionally difficult. This is an
      area of active research at **OpenEye** and we hope to remove
      them entirely in the future with a better default mode that
      works well for both multi-threaded and single threaded Java
      programs. Encouraging results have been seen by tighter
      integration with `TCMalloc
      <http://goog-perftools.sourceforge.net/doc/tcmalloc.html>`_, and
      these variable are only here to encourage such experimentation.

.. oe:language:: c++ python

   Passing :oe:const:`OESystem::OEMemPoolMode::System` to
   :oe:func:`OESystem::OESetMemPoolMode` tells the **OpenEye
   Toolkits** to using the system defined ``operator
   new(size_t)``. The implementation is thread-safe on all modern
   systems and may even be faster than using a mutexed cache. It is up
   to the user to figure out which is best for their system. The
   following code snippet will bypass the cache entirely in favor of
   calling the systems memory allocation routines:

   .. oe:language:: c++

      .. code-block:: c++

         OESetMemPoolMode(OEMemPoolMode::System);

   .. oe:language:: python

      .. code-block:: python

         OESetMemPoolMode(OEMemPoolMode_System)

   The real benefit of specifying
   :oe:const:`OESystem::OEMemPoolMode::System` is the ability to plug
   in third party memory allocators. The following memory allocators
   are recommended for multi-threaded programs:

    - `TCMalloc <http://goog-perftools.sourceforge.net/doc/tcmalloc.html>`_
    - `Hoard <http://www.hoard.org>`_
    

(Un)bounded Options
----------------------

Two types of small object caches can be set with
:oe:func:`OESystem::OESetMemPoolMode`:
:oe:const:`Bounded<OESystem::OEMemPoolMode::BoundedCache>` and
:oe:const:`Unbounded<OESystem::OEMemPoolMode::UnboundedCache>`. The default
is an :oe:const:`Unbounded<OESystem::OEMemPoolMode::UnboundedCache>` cache
for performance. The assumption is most **OEChem TK** programs will have a
constant memory usage. Even if the program has a steadily rising
memory footprint the program will usually exit after it has maxed out
its memory requirements.

This may not be the case for long running programs, for example, a web
service. These programs may need to create a temporarily large memory
footprint and then release it back to the system for some other
program to use. An
:oe:const:`Unbounded<OESystem::OEMemPoolMode::UnboundedCache>` cache
will hold onto all memory it sees, never returning any to the
operating system.

A :oe:const:`Bounded<OESystem::OEMemPoolMode::BoundedCache>` cache will
only cache allocations up to a limit. After that limit has been
reached all further allocations will be sent to the system memory
allocator. This allows the deallocations later in the program to
return the memory to the operating system. This allows certain objects
to still use the fast cache while the other objects that are bloating
the memory footprint will incur the cost of asking the operating
system for the memory they require.

.. oe:language:: java

   .. note:: 

      Since :oe:func:`OESystem::OESetMemPoolMode` is not available in
      Java the bounded cache is selected by turning on the
      ``OEJAVA_BOUNDED_CACHE`` environment variable.

   
 


.. _chapter_oemol:

********************************************************************************
Multi-conformer Molecules
********************************************************************************

.. _section_oemol_multiconf:

OEMols
================================================================================

Up to this point in the manual, all of the examples have involved
using concrete :ref:`OEGraphMol <OEChem_OEGraphMol>` molecules. These molecules
have been utilizing the functionality defined in the API of the
:ref:`OEMolBase <OEChem_OEMolBase>` abstract base-class. At this point we will
introduce another layer of abstraction in **OEChem TK**'s representation of
molecules. In **OEChem TK**, we draw a distinction between molecules that
are limited to a single conformer and those that may have any number
of conformers. While this may be an arbitrary decision, it is a
pragmatic one which allows more efficient implementation of both
classes. The single-conformer molecule's API is defined by the already
familiar :ref:`OEMolBase <OEChem_OEMolBase>` abstract base-class. The
multi-conformer molecule's API is defined by another abstract
base-class, the :ref:`OEMCMolBase <OEChem_OEMCMolBase>` (here the *MC* stands for
Multi-Conformer). The :ref:`OEMCMolBase <OEChem_OEMCMolBase>` class inherits
publicly from :ref:`OEMolBase <OEChem_OEMolBase>`, thus the multi-conformer
molecule supports the single-conformer API but adds additional
functions to manage conformers. Both the single-conformer and the
multi-conformer molecules contain atoms and bonds, but only the
multi-conformer molecule contains conformers as first-class objects.

.. _section_oemol_multiconf_typedef:

.. note::

   :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` conformer coordinates can
   be stored in :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` (16-bit), ``float``
   (32-bit), ``double`` (64-bit), or ``long double`` (>= 64-bit). The
   precision is determined by the constructor argument given to
   :ref:`OEMol <OEChem_OEMol>`, taken from the
   :oe:constns:`OEChem::OEMCMolType` namespace. However, ``float`` is
   the default implementation as a space optimization and for
   historical purposes.

The :ref:`OEGraphMol <OEChem_OEGraphMol>` is a concrete class that supports the
:ref:`OEMolBase <OEChem_OEMolBase>` API and can be passed to functions which
take an :ref:`OEMolBase <OEChem_OEMolBase>` as an argument. The
:ref:`OEMol <OEChem_OEMol>` is a concrete class that supports the
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` API in addition to the
:ref:`OEMolBase <OEChem_OEMolBase>` API. Therefore, an :ref:`OEMol <OEChem_OEMol>`
can be passed to any function which takes either an
:ref:`OEMolBase <OEChem_OEMolBase>` or an
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` as an argument.

Since an :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` `is-a
<http://en.wikipedia.org/wiki/Is-a>`_ :ref:`OEMolBase <OEChem_OEMolBase>` all
the same powerful graph functions can be applied to the
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`. This powerful type of
abstraction allows for pure graph algorithms to still be applied to
multi-conformer molecules without requiring the algorithms to know
that they are operating on a different molecule representation. When
the algorithm should be changed to accommodate multiple conformers the
function can be overloaded to provide the different functionality for
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`.

For example, the behavior in the following are slightly different based upon
whether the molecule being passed is an :ref:`OEMolBase <OEChem_OEMolBase>` or an
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`.

 - :oe:func:`OEChem::OEAddExplicitHydrogens`
 - :oe:func:`OEChem::OECenter`
 - :oe:func:`OEChem::OEReadMolecule`
 - :oe:func:`OEChem::OERMSD`
 - :oe:func:`OEChem::OERotate`
 - :oe:func:`OEChem::OESubsetMol`
 - :oe:func:`OEChem::OETranslate`
 - :oe:func:`OEChem::OEWriteMolecule`

There are also functions that only make sense for multi-conformer
molecules. In this case an overload for :ref:`OEMolBase <OEChem_OEMolBase>` is
simply not provided. This prevents users from inadvertently passing a
single-conformer molecule when a multi-conformer molecule is
required. An example of this would be in the OEOmega toolkit which is
designed to generate multi-conformer molecules, hence it requires an
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` for the conformers to be
output to.

.. _section_oemol_conformers:

Conformers
================================================================================

An :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` contains one or more
conformers. These conformers are managed in a manner very similar to
:oe:cls:`atoms<OEChem::OEAtomBase>` and
:oe:cls:`bonds<OEChem::OEBondBase>`. Conformers can only be created or
destroyed in the context of an
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`, and must be accessed via
member functions laid out in that API. Conformers are represented by
the abstract base-class :ref:`OEConfBase <OEChem_OEConfBase>`.
The :oe:meth:`GetActive<OEChem::OEMCMolBase::GetActive>` and
:oe:meth:`SetActive<OEChem::OEMCMolBase::SetActive>` methods are often sufficient
for accessing conformations in multi-conformer molecules, but alternate
access methods are also provided, e.g.,
:oe:meth:`GetConf<OEChem::OEMCMolBase::GetConf>` and
:oe:meth:`GetConfs<OEChem::OEMCMolBase::GetConfs>`.

It is sometimes convenient to be able to treat a conformer object as
its own single-conformer molecule. For this reason,
:oe:cls:`OEConfBase<OEChem::OEConfBase>` inherits from
:ref:`OEMolBase <OEChem_OEMolBase>`. Therefore, although a conformer is contained
within a multi-conformer molecule, it can act as a single-conformer
molecule, and can be passed to functions that have an
:ref:`OEMolBase <OEChem_OEMolBase>` argument.

One must be cautious when utilizing this :ref:`OEMolBase <OEChem_OEMolBase>`
inheritance functionality. Each multi-conformer molecule has only a
single heavy-atom graph. For functions which query the graph portion
of a molecule, a conformer will reflect the graph properties of its
parent multi-conformer molecule. Graph properties include the
connection table of atoms and bonds, as well as any properties stored
by the atoms and bonds. A conformer is only independent of its parent
for non-graph (*e.g.* conformational) properties. The logical extension
of this principle is that changes made to the graph properties of one
conformer will effect its parent multi-conformer molecule and thus all
the other conformers in that molecule as well. The sharing of a common
connection table prevents tautomers from being modeled together with
an :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`.

.. seealso::

   See :ref:`chapter_designdecisions` for a complete inheritance graph
   explaining the relationship of **OEChem TK** molecules.

Coordinate information is stored by the conformer, not the shared atoms
and bonds, which allows the conformers to share the same heavy-atom
graph but have different spatial configurations. In **OEChem TK**, these
conformers are represented by
:oe:cls:`OEConfBases<OEChem::OEConfBase>`, which are first-class
objects. The conformer is the only additional property presented by
the :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`. Access to conformers
is similar to :ref:`atoms and
bonds<section_molproperties_atomsandbonds>`, as shown by the following
table.

.. list-table::
   :widths: 30 15 20 30
   :header-rows: 1

   * - Description
     - Return Type
     - Method
     - See Also
   * - Number of Conformers
     - ``unsigned int``
     - :oe:meth:`NumConfs<OEChem::OEMCMolBase::NumConfs>`
     -
   * - Maximum Conformer Index
     - ``unsigned int``
     - :oe:meth:`GetMaxConfIdx<OEChem::OEMCMolBase::GetMaxConfIdx>`
     - :ref:`chapter_atombondindices`
   * - Access to a Conformer
     - :oe:cls:`OEConfBase<OEChem::OEConfBase>`
     - :oe:meth:`GetConf<OEChem::OEMCMolBase::GetConf>`
     - :ref:`chapter_predicates`
   * - Access to all Conformers
     - :oe:cls:`OEIterBase<OESystem::OEIterBase>`
     - :oe:meth:`GetConfs<OEChem::OEMCMolBase::GetConfs>`
     - :ref:`chapter_atombondtraversal`
   * - Create a new Conformer
     - :oe:cls:`OEConfBase<OEChem::OEConfBase>`
     - :oe:meth:`NewConf<OEChem::OEMCMolBase::NewConf>`
     - :ref:`section_molproperties_atomandbondcreation`
   * - Remove a Conformer
     - ``bool``
     - :oe:meth:`DeleteConf<OEChem::OEMCMolBase::DeleteConf>`
     -
   * - Rearrange Conformers
     - ``bool``
     - :oe:meth:`OrderConfs<OEChem::OEMCMolBase::OrderConfs>`
     -

.. _section_oemol_conformeriteration:

Conformer Iteration
================================================================================

Conformers of an :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` can be
iterated over the same way :ref:`atoms and
bonds<section_atombondtraversal_molatombond>` of an
:ref:`OEMolBase <OEChem_OEMolBase>` are iterated
over. :oe:meth:`GetConfs<OEChem::OEMCMolBase::GetConfs>` returns an
iterator over the conformers of the molecule. This allows one to have
multiple conformation objects at once and to treat the
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` as a container of
single-conformer molecules.

:oe:src:`Listing 1<SNIPPET-ConfBoundingBox>` demonstrates the use of the
conformers as first class objects. Each conformer is represented by an
:oe:cls:`OEConfBase<OEChem::OEConfBase>` which inherits from
:ref:`OEMolBase <OEChem_OEMolBase>`. Thus, each conformer can be treated as an
independent molecule with respect to its coordinates as shown in the
example code below.

.. oe:source:: ConfBoundingBox.cpp
   :language: c++
   :caption:  Retrieving the bounding box for a set of conformers
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: ConfBoundingBox.py
   :language: python
   :caption:  Retrieving the bounding box for a set of conformers
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: ConfBoundingBox.java
   :language: java
   :caption:  Retrieving the bounding box for a set of conformers
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: ConfBoundingBox.cs
   :language: csharp
   :caption:  Retrieving the bounding box for a set of conformers
   :refnum:   1
   :frag:     SNIPPET

:oe:func:`OEChem::OEGetCenterAndExtents` takes an
:ref:`OEMolBase <OEChem_OEMolBase>` as an argument, not an
:oe:cls:`OEConfBase<OEChem::OEConfBase>`. However, it is still usable
on each conformer since :oe:cls:`OEConfBase<OEChem::OEConfBase>`
inherits from :ref:`OEMolBase <OEChem_OEMolBase>`. Therefore, all the functions
that were written for :ref:`OEMolBase <OEChem_OEMolBase>` are automatically
usable on conformers.

.. note::

   **OEChem TK** makes the same guarantees on conformers of a
   multi-conformer molecule as it does for atoms and bonds of a
   molecule. That is, conformer objects and their indices are stable
   across any other method call, with the exception of
   :oe:meth:`SweepConfs<OEChem::OEMCMolBase::SweepConfs>`.

.. _section_oemol_conformercreation:

Conformer Creation
================================================================================

The most common method to create conformers in a molecule is by
reading a molecule from a file (see section :ref:`section_oemol_inputandoutput`).
However, when manipulating
molecules it is often necessary to create conformers on-the-fly. In
**OEChem TK**, this is done with the
:oe:meth:`OEMCMolBase::NewConf<OEChem::OEMCMolBase::NewConf>`
method. There are numerous overloads of
:oe:meth:`NewConf<OEChem::OEMCMolBase::NewConf>`. All of the overloads
create conformers with the capacity to store coordinates for the current
number of atoms in the molecule. :oe:meth:`NewAtom<OEChem::OEMolBase::NewAtom>`
adjusts this capacity as necessary. The default
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` constructor puts the
molecule in a state with a single empty conformer (as does the
:oe:meth:`OEMCMolBase::Clear<OEChem::OEMolBase::Clear>` method).

.. seealso::

   :ref:`section_atombondindices_paralleldatastructures` for a
   discussion of how indices are used to index into coordinate arrays.

:oe:src:`Listing 2<SNIPPET-NewConfFromCoords>` demonstrates how to generate a
multi-conformer water molecule from scratch. It then measures the
hydrogen-oxygen-hydrogen angle of the two conformers. Remember, the
**OEChem TK** definition of conformer is very loose, any set of Cartesian
coordinates constitutes another conformer. In this case the
configuration of the atoms to each other is the same, the location of
the molecule has just changed. No effort is given to prevent the user
from creating duplicate conformers.

.. oe:source:: NewConfFromCoords.cpp
   :language: c++
   :caption:  Creating conformers from explicit sets of coordinates
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: NewConfFromCoords.py
   :language: python
   :caption:  Creating conformers from explicit sets of coordinates
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: NewConfFromCoords.java
   :language: java
   :caption:  Creating conformers from explicit sets of coordinates
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: NewConfFromCoords.cs
   :language: csharp
   :caption:  Creating conformers from explicit sets of coordinates
   :refnum:   2
   :frag:     SNIPPET

.. warning::

   An :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` is constructed with
   one conformer already present. Special care must be taken in
   :oe:src:`Listing 2<SNIPPET-NewConfFromCoords>` to insert the coordinates of
   the first conformer into this conformer.

There is also a version of
:oe:meth:`NewConf<OEChem::OEMCMolBase::NewConf>` which takes an
:ref:`OEMolBase <OEChem_OEMolBase>` and copies the coordinates of the passed
molecule into the new
conformer. :oe:meth:`NewConf<OEChem::OEMCMolBase::NewConf>` is
expecting that the molecule passed has the same graph as the
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` which is the parent of the
new conformer. It is important to note that this version of
:oe:meth:`NewConf<OEChem::OEMCMolBase::NewConf>` can take any instance
of an :ref:`OEMolBase <OEChem_OEMolBase>`, such as an
:ref:`OEGraphMol <OEChem_OEGraphMol>` or an :ref:`OEMol <OEChem_OEMol>`. When an
:ref:`OEMol <OEChem_OEMol>` is passed to
:oe:meth:`NewConf<OEChem::OEMCMolBase::NewConf>`, the coordinates of
the newly created conformer will come from the first conformation of
the molecule passed.

:oe:src:`Listing 3<SNIPPET-FilterConfs>` demonstrates how to use
:oe:meth:`NewConf<OEChem::OEMCMolBase::NewConf>` with another
conformer as the argument. The purpose of this code is to only copy
conformers within an arbitrary energy cutoff from the ``src`` to the
``dst`` molecule.

.. oe:source:: FilterConfs.cpp
   :language: c++
   :caption:  Filtering conformers based upon energy cutoff
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: FilterConfs.py
   :language: python
   :caption:  Filtering conformers based upon energy cutoff
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: FilterConfs.java
   :language: java
   :caption:  Filtering conformers based upon energy cutoff
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: FilterConfs.cs
   :language: csharp
   :caption:  Filtering conformers based upon energy cutoff
   :refnum:   3
   :frag:     SNIPPET

The ``dst`` molecule is copy constructed from the single-conformer
representation (the first conformer) of the ``src`` molecule. This is
to grab the molecule graph information and any other
non-conformational information. Then
:oe:meth:`DeleteConfs<OEChem::OEMCMolBase::DeleteConfs>` is called to
get rid of the first conformer. It may be copied back in the conformer
loop later in the code if it meets the energy criteria.

.. warning::

   An :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` with no conformers
   can be dangerous to pass to other **OEChem TK** functions, so the
   number of conformers is checked before calling
   :oe:func:`OEChem::OEWriteMolecule`.

.. _section_oemol_inputandoutput:

Input and Output
================================================================================

:ref:`Molecule streams<section_molreadwrite_oemolstreams>` can read
both single and multi-conformer molecules from any file format. Many
of the file formats supported by **OEChem TK** are inherently a single
conformer format (SDF and MOL2, for example). However, a common
practice is to store multiple conformers in these files. **OEChem TK**
supports a rather advanced mechanism for recovering these separate
conformers into a single, multi-conformer
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`. Note that this does not
apply to file formats where conformers are stored together, OEBinary
(.oeb), for example. OEBinary files store either single-conformer or
multi-conformer molecules explicitly, so the file itself determines
how to deal with conformers. Additionally, file formats that have no
notion of conformers (*i.e.* :term:`SMILES`) are unaffected by this
feature.

The :oe:meth:`OEChem::oemolistream::SetConfTest` method sets a functor
that is used to compare the graphs of incoming molecules in order to
determine whether to combine them. These functors are subclasses of
:ref:`OEConfTestBase <OEChem_OEConfTestBase>`. Several predefined versions include:

:OEDefaultConfTest:

   The :ref:`OEDefaultConfTest <OEChem_OEDefaultConfTest>` never combines connection
   tables into multi-conformer molecules.

:OEIsomericConfTest:

   The :ref:`OEIsomericConfTest <OEChem_OEIsomericConfTest>` combines subsequent
   connection tables into a multi-conformer molecule if they:

    #. Have the same title (optional)
    #. Have the same numbers of atoms and bonds in the same order
    #. Each atom and bond must have identical properties with its
       order correspondent in the subsequent connection table
    #. Have the same atom and bond stereochemistry

   No changes are made to the connection table.

   The constructor for :ref:`OEIsomericConfTest <OEChem_OEIsomericConfTest>` has a
   default argument for whether or not to compare titles. If the
   constructor is called with no arguments or with the argument
   ``true``, the titles will be required to be the same. Otherwise,
   the titles will not be compared. In the latter instance, each
   conformer will have the individual title of its original connection
   table and the multi-conformer molecule will reflect the title of
   the active conformer.

:OEOmegaConfTest:

   The :ref:`OEOmegaConfTest <OEChem_OEOmegaConfTest>` is almost exactly the same as
   :ref:`OEIsomericConfTest <OEChem_OEIsomericConfTest>` with the exception that
   differences in invertible nitrogens are disregarded. Therefore,
   invertible nitrogens with different stereo chemistry are considered
   conformers of the same molecule.

   This definition is meant to be exactly in line with what **Omega**
   will generate. Therefore, :ref:`OEOmegaConfTest <OEChem_OEOmegaConfTest>` can be
   used on non-:file:`OEB` files to generated with **Omega** to
   recover the exact set of conformers **Omega** generated for a
   particular molecule.

:OEAbsoluteConfTest:

   The :ref:`OEAbsoluteConfTest <OEChem_OEAbsoluteConfTest>` combines subsequent
   connection tables into a multi-conformer molecule if they:

    #. Have the same title (optional)
    #. Have the same number of atoms and bonds in the same order
    #. Each atom and bond must have identical properties with its
       order correspondent in the subsequent connection table

   This conformer test sets all fully specified isomeric values to
   UNDEFINED.

   The constructor for :ref:`OEAbsoluteConfTest <OEChem_OEAbsoluteConfTest>` has a
   default argument for whether or not to compare titles. If the
   constructor is called with no arguments or with the argument true,
   the titles will be required to be the same. Otherwise, the titles
   will not be compared. In the latter instance, each conformer will
   have the individual title of its original connection table and the
   multi-conformer molecule will reflect the title of the active
   conformer.

:OEAbsCanonicalConfTest:

   The :ref:`OEAbsCanonicalConfTest <OEChem_OEAbsCanonicalConfTest>` combines subsequent
   connection tables into a multi-conformer molecule if they:

      #. Have the same absolute (non-isomeric) graph

   This conformer test puts all of the molecules in their canonical
   atom order. In addition, all fully specified isomeric values are
   set to UNDEFINED.

.. oe:source:: ReadInMultiConf.cpp
   :language: c++
   :caption:  Reading in multi-conformer molecules from single-conformer files
   :refnum:   4
   :frag:     SNIPPET

.. oe:source:: ReadInMultiConf.py
   :language: python
   :caption:  Reading in multi-conformer molecules from single-conformer files
   :refnum:   4
   :frag:     SNIPPET

.. oe:source:: ReadInMultiConf.java
   :language: java
   :caption:  Reading in multi-conformer molecules from single-conformer files
   :refnum:   4
   :frag:     SNIPPET

.. oe:source:: ReadInMultiConf.cs
   :language: csharp
   :caption:  Reading in multi-conformer molecules from single-conformer files
   :refnum:   4
   :frag:     SNIPPET

:oe:src:`Listing 4<SNIPPET-ReadInMultiConf>` will read multi-conformer
molecules from an input file based on
:ref:`OEIsomericConfTest <OEChem_OEIsomericConfTest>`. This assumes that the conformers
are ordered next to each other in the input file.

.. note::

   The :ref:`OEIsomericConfTest <OEChem_OEIsomericConfTest>` constructor can be passed
   ``false`` to allow conformers to be combined when they have
   different titles. This is very useful when dealing with files
   created by programs that modify molecule titles to indicate
   conformer number (*i.e.* acetsali_1, acetsali_2, acetsali_3). The
   modified titles are accessible through the
   :oe:meth:`GetTitle<OEChem::OEConfBase::GetTitle>` method on each
   individual :oe:cls:`OEConfBase<OEChem::OEConfBase>`.

.. _section_oemol_sddata:

Dude, where's my SD data?
================================================================================

SD tag data can be added to anything that derives from
:ref:`OEMolBase <OEChem_OEMolBase>`, including
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` or
:oe:cls:`OEConfBase<OEChem::OEConfBase>`. Generally, **OEChem TK** will
never lose any data when reading or writing. However, there are
constraints placed on **OEChem TK** as to where the SD data must go based
upon the file format being used.

An ambiguity occurs when adding SD tag data to an
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` and then writing it to
SDF. SDF files do not support multiple conformers. However, **OEChem TK**
can automatically read consecutive conformers out of a SDF file into a
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`. To preserve the SD data
**OEChem TK** has no choice but to push the data onto the conformers.

OEB files do not have this restriction upon them because they do
support multi-conformer molecules. The following table shows how to
round-trip SD tag data through the SDF and OEB formats.

.. list-table::
   :header-rows: 1

   * - Attached To
     - Written To
     - Read Into
     - Attached To
   * - :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`
     - :oe:const:`SDF<OEChem::OEFormat::SDF>`
     - :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`
     - :oe:cls:`OEConfBase<OEChem::OEConfBase>`
   * - :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`
     - :oe:const:`SDF<OEChem::OEFormat::SDF>`
     - :ref:`OEMolBase <OEChem_OEMolBase>`
     -
   * - :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`
     - :oe:const:`OEB<OEChem::OEFormat::OEB>`
     - :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`
     -
   * - :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`
     - :oe:const:`OEB<OEChem::OEFormat::OEB>`
     - :ref:`OEMolBase <OEChem_OEMolBase>`
     -
   * - :oe:cls:`OEConfBase<OEChem::OEConfBase>`
     - :oe:const:`SDF<OEChem::OEFormat::SDF>`
     - :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`
     - :oe:cls:`OEConfBase<OEChem::OEConfBase>`
   * - :oe:cls:`OEConfBase<OEChem::OEConfBase>`
     - :oe:const:`SDF<OEChem::OEFormat::SDF>`
     - :ref:`OEMolBase <OEChem_OEMolBase>`
     -
   * - :oe:cls:`OEConfBase<OEChem::OEConfBase>`
     - :oe:const:`OEB<OEChem::OEFormat::OEB>`
     - :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`
     - :oe:cls:`OEConfBase<OEChem::OEConfBase>`
   * - :oe:cls:`OEConfBase<OEChem::OEConfBase>`
     - :oe:const:`OEB<OEChem::OEFormat::OEB>`
     - :ref:`OEMolBase <OEChem_OEMolBase>`
     -
   * - :ref:`OEMolBase <OEChem_OEMolBase>`
     - :oe:const:`SDF<OEChem::OEFormat::SDF>`
     - :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`
     - :oe:cls:`OEConfBase<OEChem::OEConfBase>`
   * - :ref:`OEMolBase <OEChem_OEMolBase>`
     - :oe:const:`SDF<OEChem::OEFormat::SDF>`
     - :ref:`OEMolBase <OEChem_OEMolBase>`
     -
   * - :ref:`OEMolBase <OEChem_OEMolBase>`
     - :oe:const:`OEB<OEChem::OEFormat::OEB>`
     - :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`
     - :oe:cls:`OEConfBase<OEChem::OEConfBase>`
   * - :ref:`OEMolBase <OEChem_OEMolBase>`
     - :oe:const:`OEB<OEChem::OEFormat::OEB>`
     - :ref:`OEMolBase <OEChem_OEMolBase>`
     -

.. note::

   The :oe:const:`OEChem::OEFormat::CSV` format behaves identical to
   the :oe:const:`OEChem::OEFormat::SDF` format for how SD data is
   handled.

Practically, it is best to never attach SD tag data to an
:oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`. This should only be done
as a space optimization when it is assured that the multi-conformer
molecule will only be written to OEB.

To this end, when an :ref:`OEMol <OEChem_OEMol>` copy constructs from an
:ref:`OEGraphMol <OEChem_OEGraphMol>` the SD tag data is attached to the first
conformer.

.. seealso::

   * :ref:`chapter_genericdata` chapter
   * :ref:`section_moltaggeddata_SD` section
   * :ref:`section_moltaggeddata_PDB` section


.. _chapter_oemolrecord:

********************************************************************************
OEMolRecord
********************************************************************************

.. seealso::

   * :ref:`chapter_oerecord` chapter

:ref:`OEMolRecord <OEDataFlow_OEMolRecord>` is a specialized
:ref:`OERecord <OEDataFlow_OERecord>` with some extra methods
for handling molecules. The presence of convenience methods for handling
molecules is the only difference between an
:ref:`OEMolRecord <OEDataFlow_OEMolRecord>` and an
:ref:`OERecord <OEDataFlow_OERecord>`. The
underlying representation is identical, and either class can be copy-constructed
from the other with no loss of information.

The following example shows how an OEMolRecord can be used, and illustrates
that OEMolRecords are just OERecords with some additional methods.

.. oe:source:: OERecord.py
  :language: python
  :noindent:
  :frag:     SNIPPET-MOL-RECORD

.. oe:source:: OERecord.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MOL-RECORD

Conformer data on records
=======================================================================

:ref:`OEMolRecord <OEDataFlow_OEMolRecord>` also has methods for managing data
for conformers. Each conformer of a molecule can get its own record to store
conformer-specific data onto.

.. oe:source:: OERecord.py
  :language: python
  :noindent:
  :frag:     SNIPPET-CONF-RECORDS

.. oe:source:: OERecord.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-CONF-RECORDS



.. _chapter_oerecord:

********************************************************************************
OERecord
********************************************************************************

An :ref:`OERecord <OEDataFlow_OERecord>` is a data container that holds a
variety of strongly-typed, named values, plus associated metadata. It is used
to pass data between cubes in Orion workfloes, and is the main mechanism by
which data is communicated to and from Orion. OERecords also provide a 
general way to create and store structured data within the **OpenEye** 
ecosystem.

The most straightforward use of an :ref:`OERecord <OEDataFlow_OERecord>` is
for storage and retrieval of simple values. The following example illustrates 
how to use a record to store and retrieve integer, string, and floating point 
values.

.. oe:source:: OERecord.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SET-DATA-VALUES

.. oe:source:: OERecord.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SET-DATA-VALUES

:ref:`OERecord <OEDataFlow_OERecord>` has methods that allow you to
interrogate the record for the presence of fields and values.

.. oe:source:: OERecord.py
  :language: python
  :noindent:
  :frag:     SNIPPET-TEST-FIELDS

.. oe:source:: OERecord.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-TEST-FIELDS

Other types of data can be stored on OERecords, including molecules and even
other OERecords.

.. oe:source:: OERecord.py
  :language: python
  :noindent:
  :frag:     SNIPPET-OTHER-DATA

.. oe:source:: OERecord.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-OTHER-DATA

OERecords can be written to files and read from files using the 
:ref:`OEWriteRecord <OEDataFlow_OEWriteRecord>`  and
:ref:`OEReadRecord <OEDataFlow_OEReadRecord>` functions.

.. oe:source:: OERecord.py
  :language: python
  :noindent:
  :frag:     SNIPPET-RECORD-IO

.. oe:source:: OERecord.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-RECORD-IO

Metadata on fields
=======================================================================

.. oe:language:: c++

   In addition to holding various types of data, 
   :ref:`OERecord <OEDataFlow_OERecord>` can also hold various pieces of
   metadata about its fields. The metadata is stored onto field objects using the
   :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` class and constants from the
   :ref:`OEMetadata <OEDataFlow_OEMetadata>` class.

.. oe:language:: python

   In addition to holding various types of data, 
   :ref:`OERecord <OEDataFlow_OERecord>` can also hold various pieces of
   metadata about its fields. The metadata is stored onto field objects using the
   :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>` class and constants from the
   :ref:`OEMetadata <OEDataFlow_OEMetadata>` class.

There are two types of metadata: *options* which are simple flags, and 
*attributes* which are key/value pairs with user-supplied values.

In the following example, two pieces of metadata, one option and one attribute,
are put on a field to describe the contents of that field.

.. oe:source:: OERecord.py
  :language: python
  :noindent:
  :frag:     SNIPPET-FIELD-METADATA

.. oe:source:: OERecord.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-FIELD-METADATA

Metadata can also be used to designate relationships between fields on a
record. The following example shows how to attach error values to a field using
metadata.

.. oe:source:: OERecord.py
  :language: python
  :noindent:
  :frag:     SNIPPET-FIELD-METADATA-RELATION

.. oe:source:: OERecord.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-FIELD-METADATA-RELATION

.. seealso::

   * :ref:`chapter_oemolrecord` chapter


.. _chapter_patternmatch:

********************************************************************************
Pattern Matching
********************************************************************************
.. index :: pattern matching

**OEChem TK** includes facilities to perform different types of pattern
(graph) matching.  Graph matching is based on node (atom) and edge
(bond) correspondences.  An atom which satisfies the conditions of a
node in a query graph is said to match.  Likewise, a bond which
satisfies the conditions of an edge in a query graph is said to match.
Pattern matching is the process of identifying groupings of matching
nodes and edges.  Substructure search, or subgraph isomorphism, is the
process of finding a graph match which is less than or equal to a
larger graph.  Maximum common substructure search is the process of
identifying the maximal graph correspondence between two
graphs. Clique detection is the process of finding all possible
correspondences between two graphs within a set of bounds.

.. _section_patternmatch_sss:

Substructure Search
================================================================================

.. index :: substructure search, SMARTS

Substructure searches can be done in **OEChem TK** using the
:ref:`OESubSearch <OEChem_OESubSearch>` class.  The :ref:`OESubSearch <OEChem_OESubSearch>`
class can be initialized with a :ref:`SMARTS <chapter_SMARTS>`
pattern, an :ref:`OEQMolBase <OEChem_OEQMolBase>` query molecule, or an
:ref:`OEMolBase <OEChem_OEMolBase>` with expression options.  The following
example demonstrates how to initialize a :ref:`OESubSearch <OEChem_OESubSearch>`
instance with a :ref:`SMARTS <chapter_SMARTS>` pattern, and perform a
substructure search.

.. oe:source:: SubstructureSearch.cpp
   :language: c++
   :refnum:   1
   :caption:  Simple substructure search example
   :frag:     SNIPPET

.. oe:source:: SubstructureSearch.py
   :language: python
   :refnum:   1
   :caption:  Simple substructure search example
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-SubstructureSearch.py>`

.. oe:source:: SubstructureSearch.java
   :language: java
   :refnum:   1
   :caption:  Simple substructure search example
   :frag:     SNIPPET

.. oe:source:: SubstructureSearch.cs
   :language: csharp
   :refnum:   1
   :caption:  Simple substructure search example
   :frag:     SNIPPET

In :oe:src:`Listing 1<SNIPPET-SubstructureSearch>`, the query pattern is
benzene and the molecule in which the substructure is being searched
for is toluene.  Since benzene is a substructure of toluene the
:oe:meth:`OEChem::OESubSearch::SingleMatch` method will return
``true``.  The :oe:meth:`SingleMatch<OEChem::OESubSearch::SingleMatch>`
method returns ``true`` if a single subgraph isomorphism is detected
in the molecule passed as the function argument.

Using the :oe:meth:`SingleMatch<OEChem::OESubSearch::SingleMatch>`
function  in :oe:src:`Listing 2<SNIPPET-MolFind>`, it is possible to loop through any molecular
file and extract molecules that match a particular :ref:`SMARTS <chapter_SMARTS>`
pattern.

.. oe:source:: MolFind.cpp
   :language: c++
   :refnum:   2
   :caption:  Extracting molecules based upon a substructure
   :frag:     SNIPPET

.. oe:source:: MolFind.py
   :language: python
   :refnum:   2
   :caption:  Extracting molecules based upon a substructure
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-MolFind.py>`

.. oe:source:: MolFind.java
   :language: java
   :refnum:   2
   :caption:  Extracting molecules based upon a substructure
   :frag:     SNIPPET

.. oe:source:: MolFind.cs
   :language: csharp
   :refnum:   2
   :caption:  Extracting molecules based upon a substructure
   :frag:     SNIPPET

The :oe:cls:`OESubSearch<OEChem::OESubSearch>` class is able to
identify the atom and bond correspondences of the pattern and target
structures.  :oe:src:`Listing 3<SNIPPET-AtomMap>` extends the simple match
example to write out all atom correspondences between benzene and
toluene.

.. oe:source:: AtomMap.cpp
   :language: c++
   :refnum:   3
   :caption:  Substructure search with atom mappings
   :frag:     SNIPPET

.. oe:source:: AtomMap.py
   :language: python
   :refnum:   3
   :caption:  Substructure search with atom mappings
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-AtomMap.py>`

.. oe:source:: AtomMap.java
   :language: java
   :refnum:   3
   :caption:  Substructure search with atom mappings
   :frag:     SNIPPET

.. oe:source:: AtomMap.cs
   :language: csharp
   :refnum:   3
   :caption:  Substructure search with atom mappings
   :frag:     SNIPPET

The output of :oe:src:`Listing 3<SNIPPET-AtomMap>` is the following:

.. code-block:: bash

   Match 1 : pattern atoms: 0 1 2 3 4 5 target atoms:  0 1 2 3 4 5
   Match 2 : pattern atoms: 0 1 2 3 4 5 target atoms:  0 5 4 3 2 1
   Match 3 : pattern atoms: 0 1 2 3 4 5 target atoms:  1 2 3 4 5 0
   Match 4 : pattern atoms: 0 1 2 3 4 5 target atoms:  1 0 5 4 3 2
   Match 5 : pattern atoms: 0 1 2 3 4 5 target atoms:  2 3 4 5 0 1
   Match 6 : pattern atoms: 0 1 2 3 4 5 target atoms:  2 1 0 5 4 3
   Match 7 : pattern atoms: 0 1 2 3 4 5 target atoms:  3 4 5 0 1 2
   Match 8 : pattern atoms: 0 1 2 3 4 5 target atoms:  3 2 1 0 5 4
   Match 9 : pattern atoms: 0 1 2 3 4 5 target atoms:  4 5 0 1 2 3
   Match 10 : pattern atoms: 0 1 2 3 4 5 target atoms:  4 3 2 1 0 5
   Match 11 : pattern atoms: 0 1 2 3 4 5 target atoms:  5 0 1 2 3 4
   Match 12 : pattern atoms: 0 1 2 3 4 5 target atoms:  5 4 3 2 1 0

The :oe:meth:`OEChem::OESubSearch::Match` method performs subgraph
isomorphism determination for instances of
:oe:cls:`OEMolBase<OEChem::OEMolBase>` or
:oe:cls:`OEQMolBase<OEChem::OEQMolBase>` and returns an iterator over
all detected subgraphs. Each of the detected subgraphs can be queried
for their atom and bond correspondences. In this particular example,
the benzene substructure is identified twelve times in toluene.  There
are twelve matches because the benzene ring can be rotated around for
6 matches, and then flipped and rotated around for another 6 matches,
yielding a total of 12 matches. Each of the matches differ in their
atom and bond correspondences to the pattern substructure.

A match or subgraph is considered unique if it differs from all other
subgraphs found previously by at least one atom. When doing unique
matching, two subgraph matches which cover the same atoms, albeit in
different orders, will be called duplicates and it will be discarded.
In order to retrieve only unique matches, the
:oe:meth:`Match<OEChem::OESubSearch::Match>` method has to be called
with a second argument being set to ``true``.  In :oe:src:`Listing
3<SNIPPET-AtomMap>`, using unique search would yield only a single match for
benzene in toluene.

An :ref:`OESubSearch <OEChem_OESubSearch>` may be initialized using a
:ref:`SMARTS <chapter_SMARTS>` or a query molecule
:oe:cls:`OEQMolBase<OEChem::OEQMolBase>`. Query molecules must have
atom and bond expressions built for the entire molecule to be able to
initialize the search object (see
:oe:meth:`OEChem::OEQMolBase::BuildExpressions` in the API).

:oe:meth:`OEChem::OESubSearch::GetPattern` returns a read-only
reference to the query molecule contained in an instance of
:ref:`OESubSearch <OEChem_OESubSearch>`.  :ref:`OEQMolBase <OEChem_OEQMolBase>` methods can
be used to interrogate the returned :ref:`OEQMolBase <OEChem_OEQMolBase>`
reference.

The :oe:meth:`OEChem::OESubSearch::SetMaxMatches` method sets the
maximum number of subgraphs to be returned by the
:oe:meth:`OEChem::OESubSearch::Match` method. Once the maximum number
of subgraphs has been found the search is terminated. By default, an
:ref:`OESubSearch <OEChem_OESubSearch>` is constructed with the maximum number of
matches set to ``1024``. The constraint on the maximum number of matches
can be removed by calling :oe:meth:`OEChem::OESubSearch::SetMaxMatches`
with a value of ``0``.

When an :ref:`OESubSearch <OEChem_OESubSearch>` object is initialized with a query molecule,
the :oe:meth:`OEChem::OESubSearch::Match` method returns a match between the copy
of the query molecule stored inside the  :ref:`OESubSearch <OEChem_OESubSearch>` object and the
target molecule.

The :oe:src:`Listing 4<SNIPPET-SubstructureSearchMatch>` example below
illustrates how to reconstruct matches between the original query
molecule that is used to initialize a search and a target molecule.

.. oe:language:: c++

   In order to keep track of the atoms, each atom of the query molecule is
   attached to itself before the
   :ref:`OESubSearch <OEChem_OESubSearch>` object is constructed.
   After the matches are returned by calling the
   :oe:cls:`OEChem::OESubSearch::Match` the original atoms can be
   retrieved by these pointers.

.. oe:language:: python java csharp

   In order to keep track of the atoms, each atom of the query molecule is
   marked with its own unique atom index before the
   :ref:`OESubSearch <OEChem_OESubSearch>` object is constructed.
   After the matches are returned by calling the
   :oe:cls:`OEChem::OESubSearch::Match` the original atoms can be
   retrieved by these indices.

.. oe:source:: SubstructureSearchMatch.cpp
   :language: c++
   :refnum:   4
   :caption:  Substructures match for query molecule
   :frag:     SNIPPET

.. oe:source:: SubstructureSearchMatch.py
   :language: python
   :refnum:   4
   :caption:  Substructures match for query molecule
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-SubstructureSearchMatch.py>`

.. oe:source:: SubstructureSearchMatch.java
   :language: java
   :refnum:   4
   :caption:  Substructures match for query molecule
   :frag:     SNIPPET

.. oe:source:: SubstructureSearchMatch.cs
   :language: csharp
   :refnum:   1
   :caption:  Substructures match for query molecule
   :frag:     SNIPPET

.. seealso::

   * [Figueras-1972]_
   * [Ullman-1976]_

.. _section_patternmatch_mcss:

Maximum Common Substructure Search
================================================================================

.. index :: maximum common substructure search, MCSS

The maximum common substructure (henceforth MCS) of two molecular
graphs can be identified using the :ref:`OEMCSSearch <OEChem_OEMCSSearch>` class.
:oe:src:`Listing 5<SNIPPET-MaximumCommonSS>` demonstrates how to initialize an
:ref:`OEMCSSearch <OEChem_OEMCSSearch>` object, perform a maximum common
substructure search, and then retrieve the matches.

.. oe:source:: MaximumCommonSS.cpp
   :refnum:   5
   :language: c++
   :caption:  Maximum common substructure search
   :frag:     SNIPPET

.. oe:source:: MaximumCommonSS.py
   :refnum:   5
   :language: python
   :caption:  Maximum common substructure search
   :frag:     SNIPPET

.. oe:source:: MaximumCommonSS.java
   :refnum:   5
   :language: java
   :caption:  Maximum common substructure search
   :frag:     SNIPPET

.. oe:source:: MaximumCommonSS.cs
   :refnum:   5
   :language: csharp
   :caption:  Maximum common substructure search
   :frag:     SNIPPET

The first molecule, ``pattern``, is dopamine, and the second molecule,
``target``, is a dopamine analog.  The :ref:`OEMCSSearch <OEChem_OEMCSSearch>`
instance is initialized with the dopamine query, atom and bond
expressions, and the type of the search.

.. oe:source:: MaximumCommonSS.cpp
   :language: c++
   :frag:     SNIPPET-INIT
   :noindent:

.. oe:source:: MaximumCommonSS.py
   :language: python
   :frag:     SNIPPET-INIT
   :noindent:

.. oe:source:: MaximumCommonSS.java
   :language: java
   :frag:     SNIPPET-INIT
   :noindent:

.. oe:source:: MaximumCommonSS.cs
   :language: csharp
   :frag:     SNIPPET-INIT
   :noindent:

The atom and bond expressions define criteria for atom and bond
equivalence used during the search and are defined in the
:oe:constns:`OEChem::OEExprOpts` namespace.  See the
:ref:`section_patternmatch_OEExprOpts` section for more information.

An :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object can also be constructed from a
:ref:`SMARTS <chapter_SMARTS>` string directly. In this case standard
SMARTS matching rules apply for what constitutes a match.  If it is
constructed with an :ref:`OEQMolBase <OEChem_OEQMolBase>`, then whatever atom
and bond expressions have been applied to the
:ref:`OEQMolBase <OEChem_OEQMolBase>` will apply in the MCS search.

The last argument of the initialization defines the search type,
either :oe:const:`Approximate<OEChem::OEMCSType::Approximate>` or
:oe:const:`Exhaustive<OEChem::OEMCSType::Exhaustive>`. The difference
between the two search types is detailed in the
:ref:`section_patternmatch_mcss_rearchmode` section. This argument is
optional, if it is not specified, then the
:oe:const:`exhaustive<OEChem::OEMCSType::Exhaustive>` method is
employed.

During the search process, each identified common substructure is
evaluated by a scoring function and only substructures with the best
score are retained.  The :oe:meth:`OEChem::OEMCSSearch::SetMCSFunc`
method provides an ability to set the scoring function of an
:ref:`OEMCSSearch <OEChem_OEMCSSearch>` object, thereby influencing the result of
the maximum common substructure search process.  See the
:ref:`section_patternmatch_mcss_score` section for more information.

.. oe:source:: MaximumCommonSS.cpp
   :language: c++
   :frag:     SNIPPET-SCORE
   :noindent:

.. oe:source:: MaximumCommonSS.py
   :language: python
   :frag:     SNIPPET-SCORE
   :noindent:

.. oe:source:: MaximumCommonSS.java
   :language: java
   :frag:     SNIPPET-SCORE
   :noindent:

.. oe:source:: MaximumCommonSS.cs
   :language: csharp
   :frag:     SNIPPET-SCORE
   :noindent:

The :oe:meth:`OEChem::OEMCSSearch::Match` method returns an iterator
over the maximum common substructures.

.. oe:source:: MaximumCommonSS.cpp
   :language: c++
   :frag:     SNIPPET-MATCH
   :noindent:

.. oe:source:: MaximumCommonSS.py
   :language: python
   :frag:     SNIPPET-MATCH
   :noindent:

.. oe:source:: MaximumCommonSS.java
   :language: java
   :frag:     SNIPPET-MATCH
   :noindent:

.. oe:source:: MaximumCommonSS.cs
   :language: csharp
   :frag:     SNIPPET-MATCH
   :noindent:

The :ref:`OEMatchBase <OEChem_OEMatchBase>` is then passed as an argument to the
:oe:func:`OEChem::OESubsetMol` function, and subsequently converted
into a :term:`SMILES` string.

.. oe:source:: MaximumCommonSS.cpp
   :language: c++
   :frag:     SNIPPET-SUBSET
   :noindent:

.. oe:source:: MaximumCommonSS.py
   :language: python
   :frag:     SNIPPET-SUBSET
   :noindent:

.. oe:source:: MaximumCommonSS.java
   :language: java
   :frag:     SNIPPET-SUBSET
   :noindent:

.. oe:source:: MaximumCommonSS.cs
   :language: csharp
   :frag:     SNIPPET-SUBSET
   :noindent:

The detected maximum common substructure of the example program is
depicted in :ref:`Figure: Example of MCSS<figure_mcss_dopamine>`. The following is the output
of the program in :oe:src:`Listing 5<SNIPPET-MaximumCommonSS>`:

.. code-block:: bash

   Match 1:
   pattern atoms: 0 1 2 3 4 5 6 7 8 9
   target atoms:  7 5 3 4 1 2 0 8 9 10
   match smiles = CCc1ccc(c(c1)O)O

.. _figure_mcss_dopamine:

.. figure:: oechemtk/images/OEMCSSearch.*
   :scale: 100
   :align: center

   **Example of MCSS**

   *The maximum common substructure (highlighted by light blue) of dopamine and dopamine analog.*

The maximum common substructure search can perform unique or
non-unique substructure searching by changing the second argument of
the :oe:meth:`OEChem::OEMCSSearch::Match` method. The default is a
non-unique search.

By definition, a match or subgraph is considered unique if it differs
from all other subgraphs found previously by at least one atom or
bond.  Additionally, it is also considered unique if the pattern
subgraph is mapped to a different part of the target.

:ref:`Figure: Unique match<figure_mcss_umatch>` shows an example in which the two matches
are identified using the unique search method.  Even though the two
obtained subgraphs are identical, they represent different mappings
between the pattern and the target, therefore they are both considered
unique. Using a non-unique search would result in four matches, since
the phenol can flip, yielding two additional matches.

.. _figure_mcss_umatch:

.. figure:: oechemtk/images/OEMCSSearchUnique.*
   :scale: 100
   :align: center

   **Unique match**

   *Example for unique maximum common substructures*

The search space of a maximum common subgraph determination can be
restricted by constraining pairs of atoms or bonds to be mapped onto
one another in all subgraph solutions.  This is done using the
:oe:meth:`OEChem::OEMCSSearch::AddConstraint` method. Failure to
satisfy atom or bond pairwise constraints will prevent any subgraph
solutions from being identified. Constraints are considered satisfied
in subgraphs which do not contain any constrained atoms or bonds in
either the pattern or target molecules.

The :oe:meth:`AddConstraint<OEChem::OEMCSSearch::AddConstraint>` method
returns ``true`` if a constraint is added successfully. If the pattern
atom or bond in the :ref:`OEMatchPair <OEChem_OEMatchPair>` does not exist as
part of the query molecule created in the initialization of the
:ref:`OESubSearch <OEChem_OESubSearch>` object then
:oe:meth:`AddConstraint<OEChem::OEMCSSearch::AddConstraint>` will
return ``false``. Multiple calls to
:oe:meth:`AddConstraint<OEChem::OEMCSSearch::AddConstraint>` using the
same pattern atom or bond will cause previously stored constraints to
be overwritten as constraints are mutually exclusive. It is impossible
to satisfy multiple simultaneous constraints for a single pattern atom
or bond, hence the exclusivity.

A read-only reference to the query molecule
:ref:`OEQMolBase <OEChem_OEQMolBase>` contained in an instance of
:ref:`OEMCSSearch <OEChem_OEMCSSearch>` can be obtained with the
:oe:meth:`GetPattern<OEChem::OEMCSSearch::GetPattern>` method.  Note
that if the :ref:`OEMCSSearch <OEChem_OEMCSSearch>` was constructed with an
:ref:`OEQMolBase <OEChem_OEQMolBase>`, the returned :ref:`OEQMolBase <OEChem_OEQMolBase>`
is a separate object. :ref:`OEQMolBase <OEChem_OEQMolBase>` methods can then be
used to interrogate the returned :ref:`OEQMolBase <OEChem_OEQMolBase>`
reference.

The :oe:meth:`SetMaxMatches<OEChem::OEMCSSearch::SetMaxMatches>` method
alters the maximum number of maximum common subgraph matches that will
be returned by the :oe:meth:`OEChem::OEMCSSearch::Match` method. The
search for maximum common substructures will not terminate immediately
upon reaching this limit. The maximum common subgraph cannot be known
unless the MCS is composed of all atoms and bonds of at least one of
the graphs being compared. The limit of subgraphs to be returned may
be reached with a smaller subgraph than the maximum. In such a case
the search continues for larger subgraphs until the search is
exhausted. :oe:meth:`OEChem::OEMCSSearch::Match` will return the first
``N`` maximum common subgraphs where ``N`` is less than or equal to the
maximum match limit.  The default limit set upon construction of an
:ref:`OEMCSSearch <OEChem_OEMCSSearch>` instance is ``1024`` matches.

The :oe:meth:`SetMinAtoms<OEChem::OEMCSSearch::SetMinAtoms>` method
sets the minimum number of atoms required of a subgraph match to be
returned by a MCS search. For example, changing the parameter of
:oe:meth:`SetMinAtoms<OEChem::OEMCSSearch::SetMinAtoms>` in
:oe:src:`Listing 5<SNIPPET-MaximumCommonSS>` to 11 would result in no solution
since there are only 10 atoms of the largest maximum common
substructure (see :ref:`Figure: Example of MCSS<figure_mcss_dopamine>`).

.. oe:source:: MaximumCommonSS.cpp
   :language: c++
   :frag:     SNIPPET-MINATOMS
   :noindent:

.. oe:source:: MaximumCommonSS.py
   :language: python
   :frag:     SNIPPET-MINATOMS
   :noindent:

.. oe:source:: MaximumCommonSS.java
   :language: java
   :frag:     SNIPPET-MINATOMS
   :noindent:

.. oe:source:: MaximumCommonSS.cs
   :language: csharp
   :frag:     SNIPPET-MINATOMS
   :noindent:

A single atom can be a perfectly valid maximum common subgraph,
however, for many applications such a small subgraph may not be
considered useful.  Setting the minimum number of atoms to a useful
size prevents unproductive subgraph matches from being returned by the
:oe:meth:`OEChem::OEMCSSearch::Match` method. The default set upon
construction of an :ref:`OEMCSSearch <OEChem_OEMCSSearch>` instance for the
minimum number of atoms is one.

.. _section_patternmatch_mcss_rearchmode:

Exhaustive and approximate MCSS
================================================================================

The maximum common substructure search can be performed in two
different modes: a very fast method,
:oe:const:`OEChem::OEMCSType::Approximate`, or a more comprehensive
method, :oe:const:`OEChem::OEMCSType::Exhaustive`.

The type of the :ref:`OEMCSSearch <OEChem_OEMCSSearch>` can be set at
initialization.  The default value is
:oe:const:`OEChem::OEMCSType::Exhaustive`.

The approximate method is based on traversing through pre-defined
paths of the query structure and trying to map the visited query atoms
into target atoms. Because these pre-defined paths represent only a
fraction of all possible paths of a compound, it is not guaranteed
that the approximate method can find the largest and all common
substructures. Significant difference between the detected matches of the
two methods could exist in cases when the query or target structure
contains complex ring systems (fused or bridged) or stereo centers.
However, comparing the two methods for thousands of structures
revealed that these cases are rare and the approximate method provides
a good trade-off between identifying MCS matches accurately and doing
it 3 to 6 times faster than the exhaustive method.

:ref:`Figure: Approximate MCSS<figure_mcss_approximate>` and
:ref:`Figure: Exhaustive MCSS<figure_mcss_exhaustive>`,
show an example where the substructure identified by the approximate
method is smaller by one atom then the solution identified by the
exhaustive method.

.. _figure_mcss_approximate:

.. figure:: oechemtk/images/OEMCSSearchApproximate.*
   :scale: 100
   :align: center

   **Approximate MCSS**

   *Example for maximum common substructure identified by the approximate method.*

.. _figure_mcss_exhaustive:

.. figure:: oechemtk/images/OEMCSSearchExhaustive.*
   :scale: 100
   :align: center

   **Exhaustive MCSS**

   *Example for maximum common substructure identified by the exhaustive method.*

.. note::

   Using the approximate MCS is recommended if the speed of the search
   is crucial.

.. _section_patternmatch_mcss_score:

MCS scoring functions
================================================================================

:ref:`OEMCSFunc <OEChem_OEMCSFunc>` is an abstract base-class that defines the
API used for scoring subgraph matches. The scores generated by
implementations of :ref:`OEMCSFunc <OEChem_OEMCSFunc>` influence the sorting
and retention of maximum common subgraph matches generated by the
:ref:`OEMCSSearch <OEChem_OEMCSSearch>` class. The scoring function is set by the
:oe:meth:`OEChem::OEMCSSearch::SetMCSFunc` method.

It is important to mention that using different scoring functions does
not alter the way the search space is traversed to identify common
substructures. It affects only how these identified substructures are
evaluated.

Four implementations of the :ref:`OEMCSFunc <OEChem_OEMCSFunc>` class are
available in **OEChem TK**:

.. rubric:: OEMCSMaxAtoms

The :ref:`OEMCSMaxAtoms <OEChem_OEMCSMaxAtoms>` class is designed to order
maximum common substructure matches by the maximum number of atoms
included in the graph match.  If two matches have the same number
of atoms, then the tie is split based on the number of bonds
contained in the match.
(See example in :ref:`figure_mcss_maxatoms`.)

**Scoring function:**

:math:`num.\ of\ mapped\ atoms + \frac{num.\ of\ mapped\ bonds}{100}`

.. _figure_mcss_maxatoms:

.. figure:: oechemtk/images/OEMCSSearchOEMCSMaxAtoms.*
   :scale: 100
   :align: center

   **Scoring A**

   *Retrieved matches using 'OEMCSMaxAtoms' as scoring function.*

.. rubric:: OEMCSMaxBonds

The :oe:cls:`OEMCSMaxBonds<OEChem::OEMCSMaxBonds>` class is designed to
order maximum common substructure matches by the maximum number of bonds
included in the graph match.
If two matches have the same number of bonds, then the tie is split based on the
number of atoms contained in the match.
(See example in :ref:`figure_mcss_maxbonds`.)

**Scoring function:**

:math:`num.\ of\ mapped\ bonds + \frac{num.\ of\ mapped\ atoms}{100}`

.. _figure_mcss_maxbonds:

.. figure:: oechemtk/images/OEMCSSearchOEMCSMaxBonds.*
   :scale: 100
   :align: center

   **Scoring B**

   *Retrieved matches using 'OEMCSMaxBonds' as scoring function.*

.. rubric:: OEMCSMaxAtomsCompleteCycles

The  :oe:cls:`OEMCSMaxAtomsCompleteCycles<OEChem::OEMCSMaxAtomsCompleteCycles>`
class is the same  as the :oe:cls:`OEMCSMaxAtoms<OEChem::OEMCSMaxAtoms>` with
the addition of penalizing cyclic query bonds that are not mapped to any target
bonds, thereby giving priority to matches which contain complete cycles
common to both the pattern and the target structure.
(See example in :ref:`figure_mcss_maxatomscc`.)

**Scoring function:**

:math:`num.\ of\ mapped\ atoms + \frac{num.\ of\ mapped\ bonds}{100} - penalty \times num.\ of\ unmapped\ cyclic\ query\ bonds`

The default penalty for each unmapped cyclic query bond is 1.0.

.. _figure_mcss_maxatomscc:

.. figure:: oechemtk/images/OEMCSSearchOEMCSMaxAtomsCompleteCycles.*
   :scale: 100
   :align: center

   **Scoring C**

   *Retrieved matches using 'OEMCSMaxAtomsCompleteCycles' as scoring function.*

.. rubric:: OEMCSMaxBondsCompleteCycles

The :ref:`OEMCSMaxBondsCompleteCycles <OEChem_OEMCSMaxBondsCompleteCycles>` class is the same
as the :ref:`OEMCSMaxBonds <OEChem_OEMCSMaxBonds>` class with the
addition of penalizing cyclic query bonds that are not mapped to
any target bonds, thereby giving priority to matches which contain
complete cycles common to both the pattern and the target
structure.
(See example in :ref:`figure_mcss_maxbondscc`.)

**Scoring function:**

:math:`num.\ of\ mapped\ bonds + \frac{num.\ of\ mapped\ atoms}{100} - penalty \times  num.\ of\ unmapped\ cyclic\ query\ bonds`

The default penalty for each unmapped cyclic query bond is 1.0.

.. _figure_mcss_maxbondscc:

.. figure:: oechemtk/images/OEMCSSearchOEMCSMaxAtomsCompleteCycles.*
   :scale: 100
   :align: center

   **Scoring D**

   *Retrieved matches using  'OEMCSMaxBondsCompleteCycles' as scoring function.*

It is important to remember that not only matches with the highest
score are retained, but also matches with scores higher than the best
score rounded down to the highest integer. In the example shown in
:ref:`figure_mcss_maxbonds` three common substructures are detected
using the :ref:`OEMCSMaxBonds <OEChem_OEMCSMaxBonds>` scoring function. The first
two matches are scored ``5.06``, since they are composed of 5 mapped
bonds and 6 mapped atoms. There is only one other match which scored
higher than 5.0, this is the third retained match with a score of
``5.05``.

.. seealso::

   * [Bunke-2002]_
   * [McGregor-1982]_
   * [Raymond-2002]_
   * [Wang-T-1997]_

.. _section_patternmatch_clique:

Clique Search
================================================================================

Clique detection is a bounded common substructure search.  It is a
useful search method in cases where common substructures other than
the maximum common substructure need to be identified.  The following
example demonstrates a clique search.

.. oe:source:: CliqueSearch.cpp
   :language: c++
   :caption:  Clique search example
   :refnum:   6
   :frag:     SNIPPET

.. oe:source:: CliqueSearch.py
   :language: python
   :caption:  Clique search example
   :refnum:   6
   :frag:     SNIPPET

.. oe:source:: CliqueSearch.java
   :language: java
   :caption:  Clique search example
   :refnum:   6
   :frag:     SNIPPET

.. oe:source:: CliqueSearch.cs
   :language: csharp
   :caption:  Clique search example
   :refnum:   6
   :frag:     SNIPPET

The same molecules and expression options are used as in
:oe:src:`Listing 5<SNIPPET-MaximumCommonSS>`, however, an iterator over all
identified cliques is returned by the
:oe:meth:`OEChem::OECliqueSearch::Match` method.  The
:oe:meth:`OEChem::OECliqueSearch::SetSaveRange` method bounds the
search. In this case, cliques returned will only differ by five nodes
relative to the maximum common substructure.  The atom correspondences
for each of the returned cliques are printed in the example program.

.. _section_patternmatch_OEExprOpts:

OEExprOpts Namespace
================================================================================

Pattern matching in **OEChem TK** is always done using query molecules or
query graphs. Non-query molecules, *i.e.* those that are defined only
by :ref:`OEMolBase <OEChem_OEMolBase>` abstract base-class must be converted
into a query molecule. Conversion into a query molecule is controlled
using the values in the :oe:constns:`OEChem::OEExprOpts` namespace.
Expression options can either be specified in the constructor for an
:ref:`OEQMol <OEChem_OEQMol>`, or using the convenience constructors in the
pattern matching classes, :ref:`OESubSearch <OEChem_OESubSearch>`,
:ref:`OEMCSSearch <OEChem_OEMCSSearch>`, :ref:`OECliqueSearch <OEChem_OECliqueSearch>` which
take expression options as arguments.

:ref:`Figure: Default example<figure_expr_default>` shows an example where the maximum common
substructure search is performed using the
:oe:const:`OEChem::OEExprOpts::DefaultAtoms` and
:oe:const:`OEChem::OEExprOpts::DefaultBonds` options.

.. _figure_expr_default:

.. figure:: oechemtk/images/OEExprOpts-Default-Default.*
   :scale: 100
   :align: center

   **Default example**

   *Example of maximum common substructure search with 'DefaultAtoms' and 'DefaultBonds' options*

The :oe:const:`OEChem::OEExprOpts::DefaultAtoms` option means that two
atoms are considered to be equivalent if they have the same atomic
number, aromaticity, and formal charge.  The
:oe:const:`OEChem::OEExprOpts::DefaultBonds` option means that two
bonds can be mapped to each other if they have the same bond order and
aromaticity.

.. oe:source:: MCSSOEExprOpts.cpp
   :language: c++
   :caption:  MCSS with atom and bond expressions
   :refnum:   7
   :frag:     SNIPPET

.. oe:source:: MCSSOEExprOpts.py
   :language: python
   :caption:  MCSS with atom and bond expressions
   :refnum:   7
   :frag:     SNIPPET

.. oe:source:: MCSSOEExprOpts.java
   :language: java
   :caption:  MCSS with atom and bond expressions
   :refnum:   7
   :frag:     SNIPPET

.. oe:source:: MCSSOEExprOpts.cs
   :language: csharp
   :caption:  MCSS with atom and bond expressions
   :refnum:   7
   :frag:     SNIPPET

The best way to understand how various atom and bond expressions
influence the pattern matching is to change the atom and bond
expressions in :oe:src:`Listing 7<SNIPPET-MCSSOEExprOpts>` and compare the
obtained matches.

.. oe:source:: MCSSOEExprOpts.cpp
   :language: c++
   :frag:     SNIPPET-EXPR
   :noindent:

.. oe:source:: MCSSOEExprOpts.py
   :language: python
   :frag:     SNIPPET-EXPR
   :noindent:

.. oe:source:: MCSSOEExprOpts.java
   :language: java
   :frag:     SNIPPET-EXPR
   :noindent:

.. oe:source:: MCSSOEExprOpts.cs
   :language: csharp
   :frag:     SNIPPET-EXPR
   :noindent:

After constructing the pattern molecule, the
:oe:meth:`BuildExpressions<OEChem::OEQMolBase::BuildExpressions>`
method defines the level of atom and bond matching between the pattern
molecule and any target molecule.

.. oe:source:: MCSSOEExprOpts.cpp
   :language: c++
   :frag:     SNIPPET-BUILDEXPR
   :noindent:

.. oe:source:: MCSSOEExprOpts.py
   :language: python
   :frag:     SNIPPET-BUILDEXPR
   :noindent:

.. oe:source:: MCSSOEExprOpts.java
   :language: java
   :frag:     SNIPPET-BUILDEXPR
   :noindent:

.. oe:source:: MCSSOEExprOpts.cs
   :language: csharp
   :frag:     SNIPPET-BUILDEXPR
   :noindent:

By modifying the atom and bond expression options, very diverse
pattern matching can be performed. :ref:`Figure: Example A<figure_expr_A>` --
:ref:`Figure: Example E<figure_expr_E>` show several examples where maximum common
substructure searches are performed for the same query and target
molecules, but with various atom and bond expression options.

In the first example in :ref:`Figure: Example A<figure_expr_A>`, the
:oe:const:`OEChem::OEExprOpts::ExactAtoms` expression option is used to
give a higher degree of discrimination of the equivalence of atoms,
*i.e.* atoms can only be mapped to each other if they have the same
degree, number of hydrogens, chirality, mass, and ring membership, in
addition to the requirements of the
:oe:const:`OEChem::OEExprOpts::DefaultAtoms` option.

.. _figure_expr_A:

.. figure:: oechemtk/images/OEExprOpts-Exact-Default.*
   :scale: 100
   :align: center

   **Example A**

   *`ExactAtoms` and 'DefaultBonds`*

:ref:`Figure: Example B<figure_expr_B>` -- :ref:`Figure: Example E<figure_expr_E>`
show examples where the
discrimination capability of the
:oe:const:`OEChem::OEExprOpts::DefaultAtoms` is decreased by adding
various modifiers.  For example, using the
:oe:const:`OEChem::OEExprOpts::EqAromatic` modifier, atoms in any
aromatic ring systems are considered equivalent. As a result, the
pyridine and pyrimidine ring can be mapped to each other in
:ref:`Figure: Example B<figure_expr_B>`. Similarly,
:oe:const:`OEChem::OEExprOpts::EqHalogen` (:ref:`Figure: Example C<figure_expr_C>`) and
:oe:const:`OEChem::OEExprOpts::EqONS` (:ref:`Figure: Example D<figure_expr_D>`) define
equivalency between halogen atoms and oxygen-nitrogen-sulfur atoms,
respectively.  Using :oe:const:`OEChem::OEExprOpts::EqCAliphaticONS`
(:ref:`Figure: Example E<figure_expr_E>`) an aliphatic query carbon atom is considered
equivalent to any oxygen, nitrogen, or sulfur atom.

.. _figure_expr_B:

.. figure:: oechemtk/images/OEExprOpts-DefaultEqArom-Default.*
   :scale: 100
   :align: center

   **Example B**

   *'DefaultAtoms|EqAromatic' and 'DefaultBonds'*

.. _figure_expr_C:

.. figure:: oechemtk/images/OEExprOpts-DefaultEqHal-Default.*
   :scale: 100
   :align: center

   **Example C**

   *'DefaultAtoms|EqHalogen' and 'DefaultBonds'*

.. _figure_expr_D:

.. figure:: oechemtk/images/OEExprOpts-DefaultEqONS-Default.*
   :scale: 100
   :align: center

   **Example D**

   *'DefaultAtoms|EqONS' and 'DefaultBonds'*

.. _figure_expr_E:

.. figure:: oechemtk/images/OEExprOpts-DefaultEqCAlipONS-Default.*
   :scale: 100
   :align: center

   **Example E**

   *'DefaultAtoms|EqCAliphaticONS' and 'DefaultBonds'*

Similar modifiers exist for altering bond equivalency.
:ref:`Figure: Example F<figure_expr_F>` shows an example where single and double bonds
are considered identical when
:oe:const:`OEChem::OEExprOpts::EqSingleDouble` modifier is utilized.

.. _figure_expr_F:

.. figure:: oechemtk/images/OEExprOpts-Default-DefaultEqSingleDouble.*
   :scale: 100
   :align: center

   **Example F**

   *'DefaultAtoms' and 'DefaultBonds|EqSingleDouble'*

The last example in :ref:`Figure: Example G<figure_expr_G>` represents a very
unrestrained search, where both the atom and bond expression options
have weak discrimination power.

.. _figure_expr_G:

.. figure:: oechemtk/images/EqAromEqCAlONSEqHalEqONSEqSnglDbl.*
   :scale: 100
   :align: center

   **Example G**

   *'DefaultAtoms|EqAromatic|EqCAliphaticONS|EqHalogen|EqONS' and 'DefaultBonds|EqSingleDouble'*

Even though only maximum common substructure search examples are
presented here, atom and bond expression options can be similarly used
with substructure searches or clique detections.  For a full
description of expression options and their usage please refer to the
:oe:constns:`OEChem::OEExprOpts` namespace section in **OEChem TK** API.


.. _chapter_periodictable:

********************************************************************************
Periodic Table Functions
********************************************************************************

To simplify the task of dealing with the elements of the periodic table,
**OEChem TK** contains several functions to obtain useful properties of the elements.

Atomic Symbol/Atomic Number
================================================================================

.. index:: atomic symbol, atomic number

A common task is to obtain or display the atomic symbol of an atom
represented by an :ref:`OEAtomBase <OEChem_OEAtomBase>`.  To save space and
reduce redundancy and consistency issues, the
:ref:`OEAtomBase <OEChem_OEAtomBase>` class contains only an ``unsigned
integer`` representing the atom's atomic number.  This value may be
obtained using the :oe:meth:`OEChem::OEAtomBase::GetAtomicNum` method.
This value can be converted into an atomic symbol using the
:oe:func:`OEChem::OEGetAtomicSymbol` function.

.. oe:source:: UsingPeriodicTableFunctions.cpp
   :language: c++
   :frag:     SNIPPET-ATOMIC2SYMBOL
   :noindent:

.. oe:source:: UsingPeriodicTableFunctions.py
   :language: python
   :frag:     SNIPPET-ATOMIC2SYMBOL
   :noindent:

.. oe:source:: UsingPeriodicTableFunctions.java
   :language: java
   :frag:     SNIPPET-ATOMIC2SYMBOL
   :noindent:

.. oe:source:: UsingPeriodicTableFunctions.cs
   :language: csharp
   :frag:     SNIPPET-ATOMIC2SYMBOL
   :noindent:

The example above uses the integer constant
:oe:const:`OEChem::OEElemNo::C` from the :oe:constns:`OEChem::OEElemNo`
namespace.  This namespace represents the atomic numbers of the 111
elements as their symbols as a convenience.

The inverse of :oe:func:`OEChem::OEGetAtomicSymbol`, *i.e.* obtaining
the atomic numbers from an atomic symbol, is performed by the
:oe:func:`OEChem::OEGetAtomicNum` function.

.. oe:source:: UsingPeriodicTableFunctions.cpp
   :language: c++
   :frag:     SNIPPET-SYMBOL2ATOMIC
   :noindent:

.. oe:source:: UsingPeriodicTableFunctions.py
   :language: python
   :frag:     SNIPPET-SYMBOL2ATOMIC
   :noindent:

.. oe:source:: UsingPeriodicTableFunctions.java
   :language: java
   :frag:     SNIPPET-SYMBOL2ATOMIC
   :noindent:

.. oe:source:: UsingPeriodicTableFunctions.cs
   :language: csharp
   :frag:     SNIPPET-SYMBOL2ATOMIC
   :noindent:

.. _section_periodictable_elemprop:

Element Properties
================================================================================

**OEChem TK** provides several functions for obtaining properties of the elements, all
of which take an unsigned integer argument representing the element's atomic number.

.. list-table::
   :widths: 25 10 20
   :header-rows: 1

   * - Property Name
     - Return Value
     - Function
   * - Average Atomic Weight
     - double
     - :oe:func:`OEGetAverageWeight<OEChem::OEGetAverageWeight>`
   * - Most Abundant Isotope
     - unsigned int
     - :oe:func:`OEGetDefaultMass<OEChem::OEGetDefaultMass>`

The **OEChem TK** library also provides the following two functions to deal with
specific isotopes:

* :oe:func:`OEChem::OEGetIsotopicWeight`

* :oe:func:`OEChem::OEIsCommonIsotope`

Both functions take an unsigned integer representing the isotope's atomic
number (number of protons), and an unsigned integer representing the
isotope's mass (number of protons plus neutrons).

The following example shows how to calculate molecular weight
(:oe:func:`OEChem::OECalculateMolecularWeight`) :

.. oe:source:: CalcAveMolecularWeight.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MOL-WEIGHT

.. oe:source:: CalcAveMolecularWeight.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MOL-WEIGHT

.. oe:source:: CalcAveMolecularWeight.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MOL-WEIGHT

.. oe:source:: CalcAveMolecularWeight.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MOL-WEIGHT

.. _section_periodictable_atomradius:

Atom Radius Functions
================================================================================

.. list-table::
   :widths: 15 15 18 8
   :header-rows: 1

   * - Property Name
     - Get Method
     - Applied on :oe:cls:`OEMolBase<OEChem::OEMolBase>`
     - Reference
   * - Covalent Radius
     - :oe:func:`OEGetCovalentRadius<OEChem::OEGetCovalentRadius>`
     - :oe:func:`OEChem::OEAssignCovalentRadii`
     -
   * - Default Radius used by DelPhi
     - :oe:func:`OEGetDelphiRadius<OEChem::OEGetDelphiRadius>`
     - :oe:func:`OEChem::OEAssignDelphiRadii`
     -  Accelrys
   * - Effective Ionic Radius
     - :oe:func:`OEGetHonigIonicCavityRadius<OEChem::OEGetHonigIonicCavityRadius>`
     - :oe:func:`OEChem::OEAssignHonigIonicCavityRadii`
     - [Rashin-1985]_
   * - Van der Waals Radius
     - :oe:func:`OEGetBondiVdWRadius<OEChem::OEGetBondiVdWRadius>`
     - :oe:func:`OEChem::OEAssignBondiVdWRadii`
     - [Bondi-1964]_
   * - Van der Waals Radius
     - :oe:func:`OEGetPaulingVdWRadius<OEChem::OEGetPaulingVdWRadius>`
     - :oe:func:`OEChem::OEAssignPaulingVdWRadii`
     - [Pauling-1960]_
   * - Van der Waals Radius
     - N/A [1]
     - :oe:func:`OEChem::OEAssignZap9Radii`
     - [Nicholls-2008]_
   * - Van der Waals Radius
     - 
     - :oe:func:`OEChem::OEAssignZap7Radii`
     - [Nicholls-2010]_
   * - Generic Assignment Function
     - N/A [2]
     - :oe:func:`OEChem::OEAssignRadii`
     -

**Table footnote:**

**[1]** The get method is not available, since the radius value of :oe:const:`OEChem::OEElemNo::O`
and  :oe:const:`OEChem::OEElemNo::N` (defined in  [Nicholls-2008]_) depend on the chemical
environment of the given atom.

**[2]** Can be used to call any of the other methods to assign radii as well as
to clear atomic radii.

The following snippet shows how to set and access the "Pauling" van der Waals
radius in a given :ref:`OEMolBase <OEChem_OEMolBase>`:

.. oe:source:: UsingPeriodicTableFunctions.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SET-RADII

.. oe:source:: UsingPeriodicTableFunctions.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SET-RADII

.. oe:source:: UsingPeriodicTableFunctions.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SET-RADII

.. oe:source:: UsingPeriodicTableFunctions.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SET-RADII

.. figure:: oechemtk/images/OEAssignPaulingVdWRadii.*
   :align:  center
   :scale:  100

   *Example of setting "Pauling" van der Waals radius*


.. _chapter_predicates:

********************************************************************************
Predicate Functors
********************************************************************************

.. oe:language:: c++

   A *functor* (function object) is simply any object that can be called as if it is a
   function *i.e.* an object of a class that overload ``operator()`` the function call
   operator.
   A functor can be considered as a C++ equivalent of function pointers in C.
   However, functors can also maintain state, be copied, created and destroyed.

.. oe:language:: python

   A *functor* (function object) is simply any object that can be called as if it is a
   function *i.e.* an object of a class that defines the ``__call__()`` method.

Functors that return bool are an important special case. A unary function
whose return type is bool is called a *predicate*.

In **OEChem TK**, these functors are often passed into another function.
The functors are then called from inside the second
function. This is the concept of a *callback*, because the second
function provides the argument and 'call's back' to the functor which
was passed into the function.
Generator method such as :oe:meth:`OEChem::OEMolBase::GetAtoms` can take a functor
as an argument and use the callback mechanism to iterate over
atoms that satisfy the functor passed to it.
See example in :ref:`section_atombondtraversal_subset` section.

In the example below, the function ``CountAtoms`` loops over the atoms
and performs a call-back to the predicate functor ``pred`` for each
atom. If the predicate returns true, a counter is incremented.
The ``main`` function passes :ref:`OEIsOxygen <OEChem_OEIsOxygen>` predefined atom predicates
to the ``CountAtoms`` function that  counts the number of oxygen atoms in the molecule.
(Please note that this function is already implemented in **OEChem TK** and called
:oe:func:`OEChem::OECount`.)

.. oe:source:: Functors.cpp
   :language: c++
   :refnum:   1
   :caption:  Using functor callbacks
   :frag:     SNIPPET

.. oe:source:: Functors.py
   :language: python
   :refnum:   1
   :caption:  Using functor callbacks
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-Functors.py>`

.. oe:source:: Functors.java
   :language: java
   :refnum:   1
   :caption:  Using functor callbacks
   :frag:     SNIPPET

.. oe:source:: Functors.cs
   :language: csharp
   :refnum:   1
   :caption:  Using functor callbacks
   :frag:     SNIPPET

.. _section_predicates_builtin:

Built-in Functors
================================================================================

There are many useful functors already defined in **OEChem TK**.  These can
be used by programmers with little or no understanding of the details
of how functors work. A programmer can simply pass them to one of the
many **OEChem TK** functions and methods which take predicates as arguments.

.. _section_predicates_builtin_atom:

Atom Functors
--------------------------------------------------------------------------------

.. table::

   =================================================== =====================================================================
   Access                                              Functor Name
   =================================================== =====================================================================
   ring atoms                                          :oe:cls:`OEAtomIsInRing<OEChem::OEAtomIsInRing>`
   chain atoms                                         :oe:cls:`OEAtomIsInChain<OEChem::OEAtomIsInChain>`
   atom with specified atom index                      :oe:cls:`OEHasAtomIdx<OEChem::OEHasIdx>`
   atom with selected  atom index                      :oe:cls:`OEAtomIdxSelected<OEChem::OEIdxSelected>`
   atom with specified atom name                       :oe:cls:`OEHasAtomName<OEChem::OEHasAtomName>`
   atoms with specified atom stereo                    :oe:cls:`OEHasAtomStereoSpecified<OEChem::OEHasAtomStereoSpecified>`
   atoms with specified formal charge                  :oe:cls:`OEHasFormalCharge<OEChem::OEHasFormalCharge>`
   atoms with specified number of heavy atom neighbors :oe:cls:`OEHasHvyDegree<OEChem::OEHasHvyDegree>`
   aromatic atoms                                      :oe:cls:`OEIsAromaticAtom<OEChem::OEIsAromaticAtom>`
   atoms with specific hybridization                   :oe:cls:`OEIsAtomHybridization<OEChem::OEIsAtomHybridization>`
   chiral atoms                                        :oe:cls:`OEIsChiralAtom<OEChem::OEIsChiralAtom>`
   atoms with anisotropic B-factor parameters          :oe:cls:`OEHasAnisou<OEChem::OEHasAnisou>`
   atoms with specified map index                      :oe:cls:`OEHasMapIdx<OEChem::OEHasMapIdx>`
   atoms representing R-Groups                         :oe:cls:`OEIsRGroup<OEChem::OEIsRGroup>`
   valid atoms (by OpenEye valence conventions)        :oe:cls:`OEIsValidAtomValence<OEChem::OEIsValidAtomValence>`
   valid atoms (by MDL valence conventions)            :oe:cls:`OEIsValidMDLAtomValence<OEChem::OEIsValidMDLAtomValence>`
   :math:`n^{th}` atom                                 :oe:cls:`OENthAtom<OEChem::OENthAtom>`
   atoms that are both terminal and heavy              :oe:cls:`OEIsTermHeavyAtom<OEChem::OEIsTermHeavyAtom>`
   atom membership in a set of atoms                   :ref:`OEIsAtomMember <OEChem_OEIsMemberPtr_OEIsAtomMember>`
   =================================================== =====================================================================

.. oe:source:: FunctorsAtom.cpp
   :language: c++
   :refnum:   2
   :caption:  Using predefined atom functors
   :frag:     SNIPPET

.. oe:source:: FunctorsAtom.py
   :language: python
   :refnum:   2
   :caption:  Using predefined atom functors
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-FunctorsAtom.py>`

.. oe:source:: FunctorsAtom.java
   :language: java
   :refnum:   2
   :caption:  Using predefined atom functors
   :frag:     SNIPPET

.. oe:source:: FunctorsAtom.cs
   :language: csharp
   :refnum:   2
   :caption:  Using predefined atom functors
   :frag:     SNIPPET

The output of the preceding program is the following:

.. code-block:: bash

   Number of heavy atoms = 12
   Number of ring atoms  = 11

Atomic Number Functors
--------------------------------------------------------------------------------

.. table::

   =================================== =====================================================================
   Access                              Functor Name
   =================================== =====================================================================
   atoms with specified atomic number  :oe:cls:`OEHasAtomicNum<OEChem::OEHasAtomicNum>`
   carbon atoms                        :oe:cls:`OEIsCarbon<OEChem::OEIsCarbon>`
   halogen atoms                       :oe:cls:`OEIsHalogen<OEChem::OEIsHalogen>`
   heavy atoms                         :oe:cls:`OEIsHeavy<OEChem::OEIsHeavy>`
   hetero atoms                        :oe:cls:`OEIsHetero<OEChem::OEIsHetero>`
   explicit hydrogen atoms             :oe:cls:`OEIsHydrogen<OEChem::OEIsHydrogen>`
   metal atoms                         :oe:cls:`OEIsMetal<OEChem::OEIsMetal>`
   nitrogen atoms                      :oe:cls:`OEIsNitrogen<OEChem::OEIsNitrogen>`
   oxygen atoms                        :oe:cls:`OEIsOxygen<OEChem::OEIsOxygen>`
   sulfur atoms                        :oe:cls:`OEIsSulfur<OEChem::OEIsSulfur>`
   phosphorus atoms                    :oe:cls:`OEIsPhosphorus<OEChem::OEIsPhosphorus>`
   non-carbon atoms                    :oe:cls:`OEIsPolar<OEChem::OEIsPolar>`
   polar hydrogen atoms                :oe:cls:`OEIsPolarHydrogen<OEChem::OEIsPolarHydrogen>`
   =================================== =====================================================================

Please note that the following two lines produce the same result.

.. oe:source:: FunctorsAtomic.cpp
   :language: c++
   :frag:     SNIPPET-PRED-ATOMIC

.. oe:source:: FunctorsAtomic.py
   :language: python
   :frag:     SNIPPET-PRED-ATOMIC

.. oe:source:: FunctorsAtomic.java
   :language: java
   :frag:     SNIPPET-PRED-ATOMIC

.. oe:source:: FunctorsAtomic.cs
   :language: csharp
   :frag:     SNIPPET-PRED-ATOMIC

Bond Functors
--------------------------------------------------------------------------------

.. table::

   =================================== =====================================================================
   Access                              Functor Name
   =================================== =====================================================================
   ring bonds                          :oe:cls:`OEBondIsInRing<OEChem::OEBondIsInRing>`
   chain bonds                         :oe:cls:`OEBondIsInChain<OEChem::OEBondIsInChain>`
   bond with specified bond index      :oe:cls:`OEHasBondIdx<OEChem::OEHasIdx>`
   bond with selected  bond index      :oe:cls:`OEBondIdxSelected<OEChem::OEIdxSelected>`
   bonds with specified bond order     :oe:cls:`OEHasOrder<OEChem::OEHasOrder>`
   rotatable bonds                     :oe:cls:`OEIsRotor<OEChem::OEIsRotor>`
   chiral bonds                        :oe:cls:`OEIsChiralBond<OEChem::OEIsChiralBond>`
   bonds with specific bond  stereo    :oe:cls:`OEHasBondStereoSpecified<OEChem::OEHasBondStereoSpecified>`
   aromatic bonds                      :oe:cls:`OEIsAromaticBond<OEChem::OEIsAromaticBond>`
   bond membership in a set of bonds   :ref:`OEIsBondMember <OEChem_OEIsMemberPtr_OEIsBondMember>`
   =================================== =====================================================================

.. oe:source:: FunctorsBond.cpp
   :language: c++
   :refnum:   3
   :caption:  Using predefined bond functors
   :frag:     SNIPPET

.. oe:source:: FunctorsBond.py
   :language: python
   :refnum:   3
   :caption:  Using predefined bond functors
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-FunctorsBond.py>`

.. oe:source:: FunctorsBond.java
   :language: java
   :refnum:   3
   :caption:  Using predefined bond functors
   :frag:     SNIPPET

.. oe:source:: FunctorsBond.cs
   :language: csharp
   :refnum:   3
   :caption:  Using predefined bond functors
   :frag:     SNIPPET

The output of the preceding program is the following:

.. code-block:: bash

   Number of ring bonds  = 5
   Number of rotor bonds = 2

Group Functors
--------------------------------------------------------------------------------

.. table::

   ========================================== =========================================================
   Access                                     Functor Name
   ========================================== =========================================================
   groups with a specific atom                :oe:cls:`OEHasAtomInGroup<OEChem::OEHasAtomInGroup>`
   groups with a specific bond                :oe:cls:`OEHasBondInGroup<OEChem::OEHasBondInGroup>`
   groups with a specific type                :oe:cls:`OEHasGroupType<OEChem::OEHasGroupType>`
   groups that store MDL stereo information   :oe:cls:`OEIsMDLStereoGroup<OEChem::OEIsMDLStereoGroup>`
   ========================================== =========================================================

Reaction Component Functors
--------------------------------------------------------------------------------

.. table::

   ================================================= =========================================================
   Access                                            Functor Name
   ================================================= =========================================================
   atoms of the catalysts or solvents of a reaction  :oe:cls:`OEAtomIsInAgent<OEChem::OEAtomIsInAgent>`
   atoms of the product molecule(s)                  :oe:cls:`OEAtomIsInProduct<OEChem::OEAtomIsInProduct>`
   atoms of the reactant molecule(s)                 :oe:cls:`OEAtomIsInReactant<OEChem::OEAtomIsInReactant>`
   ================================================= =========================================================

Conformer Functors
--------------------------------------------------------------------------------

.. table::

   =================================== ==================================================
   Access                              Functor Name
   =================================== ==================================================
   conformer with specified index      :oe:cls:`OEHasConfIdx<OEChem::OEHasIdx>`
   conformer with selected  index      :oe:cls:`OEConfIdxSelected<OEChem::OEIdxSelected>`
   =================================== ==================================================

.. _section_predicates_reside_data_functors:

Residue Data Functors
--------------------------------------------------------------------------------

.. table::

   ======================================= ===============================================================
   Access                                  Functor Name
   ======================================= ===============================================================
   atoms with specified residue properties :oe:cls:`OEAtomMatchResidue<OEBio::OEAtomMatchResidue>`
   atoms with specified chain id           :oe:cls:`OEHasChainID<OEChem::OEHasChainID>`
   atoms with specified residue number     :oe:cls:`OEHasResidueNumber<OEChem::OEHasResidueNumber>`
   atoms with an alternate location        :oe:cls:`OEHasAlternateLocation<OEBio::OEHasAlternateLocation>`
   atoms with specified fragment number    :oe:cls:`OEHasFragmentNumber<OEChem::OEHasFragmentNumber>`
   atoms with specified PDB index          :oe:cls:`OEHasPDBAtomIndex<OEBio::OEHasPDBAtomIndex>`
   alpha carbon                            :oe:cls:`OEIsCAlpha<OEChem::OEIsCAlpha>`
   backbone atom                           :oe:cls:`OEIsBackboneAtom<OEBio::OEIsBackboneAtom>`
   water                                   :oe:cls:`OEIsWater<OEBio::OEIsWater>`
   nucleic acid base                       :oe:cls:`OEIsNucleicAcidBase<OEBio::OEIsNucleicAcidBase>`
   nucleic acid sugar                      :oe:cls:`OEIsNucleicAcidSugar<OEBio::OEIsNucleicAcidSugar>`
   nucleic acid phosphate                  :oe:cls:`OEIsNucleicAcidPhosphate<OEBio::OEIsNucleicAcidPhosphate>`
   ======================================= ===============================================================

.. _section_predicates_composition_functors:

Composite Functors
================================================================================

Occasionally, one may want to use a logical operator to join two or
more functors. The following table shows the composite functors
defined in **OEChem TK**.

.. oe:language:: c++

   .. table:: **Composite Functors**

      ===================================== ======================================== ========================================
      Composite Functor                     Description                              Example atom composite functor
      ===================================== ======================================== ========================================
      :oe:cls:`OENot<OESystem::OENot>`      logical not                              `OENot<OEAtomBase>`
      :oe:cls:`OEOr<OESystem::OEOr>`        logical or                               `OEOr<OEAtomBase>`
      :oe:cls:`OEAnd<OESystem::OEAnd>`      logical and                              `OEAnd<OEAtomBase>`
      ===================================== ======================================== ========================================

.. oe:language:: python java csharp

   .. table:: **Composite Functors**

      ======================================= ======================================= ========================================== ==========================================
      Logical Not                             Logical or                              Logical and                                Description
      ======================================= ======================================= ========================================== ==========================================
      :oe:cls:`OENotAtom<OESystem::OENot>`    :oe:cls:`OEOrAtom<OESystem::OEOr>`      :oe:cls:`OEAndAtom<OESystem::OEAnd>`       atom composite functors
      :oe:cls:`OENotBond<OESystem::OENot>`    :oe:cls:`OEOrBond<OESystem::OEOr>`      :oe:cls:`OEAndBond<OESystem::OEAnd>`       bond composite functors
      :oe:cls:`OENotConf<OESystem::OENot>`    :oe:cls:`OEOrConf<OESystem::OEOr>`      :oe:cls:`OEAndConf<OESystem::OEAnd>`       conformation composite functors
      :oe:cls:`OENotGroup<OESystem::OENot>`   :oe:cls:`OEOrGroup<OESystem::OEOr>`     :oe:cls:`OEAndGroup<OESystem::OEAnd>`      group composite functors
      :oe:cls:`OENotRoleSet<OESystem::OENot>` :oe:cls:`OEOrRoleSet<OESystem::OEOr>`   :oe:cls:`OEAndRoleSet<OESystem::OEAnd>`    roleset composite functors
      ======================================= ======================================= ========================================== ==========================================

Each composite functor takes the appropriate number of predicates as
arguments and generates a single unary predicate.
The following example demonstrates how to use composite functors to
build expressions from **OEChem TK**'s predefined atom predicates.

.. oe:source:: CompositionFunctorsAtom.cpp
   :language: c++
   :refnum:   4
   :caption:  Combining predefined atom predicates
   :frag:     SNIPPET

.. oe:source:: CompositionFunctorsAtom.py
   :language: python
   :refnum:   4
   :caption:  Combining predefined atom predicates
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-CompositionFunctorsAtom.py>`

.. oe:source:: CompositionFunctorsAtom.java
   :language: java
   :refnum:   4
   :caption:  Combining predefined atom predicates
   :frag:     SNIPPET

.. oe:source:: CompositionFunctorsAtom.cs
   :language: csharp
   :refnum:   4
   :caption:  Combining predefined atom predicates
   :frag:     SNIPPET

The :oe:func:`OEChem::OECount` function returns the number or objects (in this case atoms)
matching the given predicate argument.

The output of the preceding program is the following:

.. code-block:: bash

   Number of chain atoms = 5
   Number of aromatic nitrogens = 1
   Number of non-carbons = 3
   Number of nitrogen and oxygen atoms = 2

.. oe:language:: c++

   Though the explicit template type instantiation isn't strictly
   necessary, in practice it is required to help several parsers make
   it through the expression.  As a convenience to programmers, three
   related template free functions have been defined. These are operator ``&&``,
   operator ``||``, and operator ``!``, which take one or more
   :oe:cls:`OEUnaryPredicates<OESystem::OEUnaryPredicate>` as arguments
   and return the appropriate composite predicate. Not only do these
   make code much easier to read, but in our experience, they also
   make the code easier for C++ parsers to parse.
   The following example is identical to the previous composite
   listing except that the composite predicates have been replaced
   by the operator free-functions.

   .. oe:source:: CompositionFunctors.cpp
      :language: c++
      :frag:     SNIPPET-PRED-COMPOSITION-ATOM

Composite functors can be used similarly to combine predefined
bond predicates.

.. oe:source:: CompositionFunctorsBond.cpp
   :language: c++
   :refnum:   5
   :caption:  Combining predefined bond predicates
   :frag:     SNIPPET

.. oe:source:: CompositionFunctorsBond.py
   :language: python
   :refnum:   5
   :caption:  Combining predefined bond predicates
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-CompositionFunctorsBond.py>`

.. oe:source:: CompositionFunctorsBond.java
   :language: java
   :refnum:   5
   :caption:  Combining predefined bond predicates
   :frag:     SNIPPET

.. oe:source:: CompositionFunctorsBond.cs
   :language: csharp
   :refnum:   5
   :caption:  Combining predefined bond predicates
   :frag:     SNIPPET

The output of the preceding program is the following:

.. code-block:: bash

   Number of non-rotatable bonds = 8
   Number of ring double bonds = 1
   Number of double or triple bonds = 2

User Defined Functors
================================================================================

While many predefined functors exist in **OEChem TK**, it is not difficult
to find a situation which calls for a new user-defined functor.

.. oe:language:: c++

   User-defined functor can be written by deriving from the
   :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>` base template class.

.. oe:language:: python java csharp

   User-defined functor can be written by deriving from either
   the :oe:cls:`OEUnaryAtomPred<OESystem::OEUnaryPredicate>`
   or the :oe:cls:`OEUnaryBondPred<OESystem::OEUnaryPredicate>` class.

The following example shows a user defined atom functor which returns true
for aliphatic nitrogens.

.. oe:source:: UserPredAtom.cpp
   :language: c++
   :refnum:   6
   :caption:  User defined atom predicate
   :frag:     SNIPPET

.. oe:source:: UserPredAtom.py
   :language: python
   :refnum:   6
   :caption:  User defined atom predicate
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-UserPredAtom.py>`

.. oe:source:: UserPredAtom.java
   :language: java
   :refnum:   6
   :caption:  User defined atom predicate
   :frag:     SNIPPET

.. oe:source:: UserPredAtom.cs
   :language: csharp
   :refnum:   6
   :caption:  User defined atom predicate
   :frag:     SNIPPET

The output of the preceding program is the following:

.. code-block:: bash

   Number of aliphatic N atoms = 1

.. oe:language:: python

   The previous example can be alternatively rewritten using the PyAtomPredicate class.
   PyAtomPredicate takes a Python function as the single argument. This passed
   function  has to take a single :ref:`OEAtomBase <OEChem_OEAtomBase>` argument and return a
   boolean value.
   In essence, we are creating a predicate that itself holds a predicate.

   .. oe:source:: UserPyAtomPred.py
      :language: python
      :frag:     SNIPPET-PRED-PYATOM

.. oe:language:: c++

   A bond predicate can be similarly defined by deriving from the
   :oe:cls:`OEUnaryBondPred<OESystem::OEUnaryPredicate>` class.

.. oe:language:: python java csharp

   A bond predicate can be similarly defined by deriving from the
   :oe:cls:`OEUnaryBondPred<OESystem::OEUnaryPredicate>` class.

.. oe:source:: UserPredBond.cpp
   :language: c++
   :refnum:   7
   :caption:  User defined bond predicate
   :frag:     SNIPPET

.. oe:source:: UserPredBond.py
   :language: python
   :refnum:   7
   :caption:  User defined bond predicate
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-UserPredBond.py>`

.. oe:source:: UserPredBond.java
   :language: java
   :refnum:   7
   :caption:  User defined bond predicate
   :frag:     SNIPPET

.. oe:source:: UserPredBond.cs
   :language: csharp
   :refnum:   7
   :caption:  User defined bond predicate
   :frag:     SNIPPET

The output of the preceding program is the following:

.. code-block:: bash

   Number of amide bonds = 1

.. oe:language:: python

   Similarly, the previous example can be rewritten using the PyBondPredicate class.
   PyBondPredicate takes a Python function as the single argument. This passed
   function  has to take a single :ref:`OEBondBase <OEChem_OEBondBase>` argument and return a
   boolean value.

   .. oe:source:: UserPyBondPred.py
      :language: python
      :frag:     SNIPPET-PRED-PYBOND

One advantage of functors over function pointers is that they can hold
state. Since this state is held by the instance of the object it can
be thread safe (unlike static-variables inside functions used with
function pointers). The state of a functor can be initialized at
construction. For instance, :ref:`OEHasAtomicNum <OEChem_OEHasAtomicNum>` functor
takes an argument on construction which defines which atomic number is
required for the functor to return true.

.. oe:source:: UserPredAtomArg.cpp
   :language: c++
   :refnum:   8
   :caption:  User defined atom predicate with state
   :frag:     SNIPPET

.. oe:source:: UserPredAtomArg.py
   :language: python
   :refnum:   8
   :caption:  User defined atom predicate with state
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-UserPredAtomArg.py>`

.. oe:source:: UserPredAtomArg.java
   :language: java
   :refnum:   8
   :caption:  User defined atom predicate with state
   :frag:     SNIPPET

.. oe:source:: UserPredAtomArg.cs
   :language: csharp
   :refnum:   8
   :caption:  User defined atom predicate with state
   :frag:     SNIPPET

.. _section_predicates_match:

Functor substructure-based matching
================================================================================

The :oe:src:`Listing 6<SNIPPET-UserPredAtom>` shows an example how to create a
user-defined atom predicate. **OEChem TK** also provides a functor template,
called :ref:`OEMatchFunc <OEChem_OEMatchFunc>`, that allows convenient substructure-based
atom matching.

In the following example functors are initialized with a
:term:`SMARTS` string.  These functors return true only if the atom
matches the substructure pattern specified in construction.

.. oe:source:: FunctorsOEMatch.cpp
   :language: c++
   :refnum:   9
   :caption:  Functor substructure-based matching
   :frag:     SNIPPET

.. oe:source:: FunctorsOEMatch.py
   :language: python
   :refnum:   9
   :caption:  Functor substructure-based matching
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-FunctorsOEMatch.py>`

.. oe:source:: FunctorsOEMatch.java
   :language: java
   :refnum:   9
   :caption:  Functor substructure-based matching
   :frag:     SNIPPET

.. oe:source:: FunctorsOEMatch.cs
   :language: csharp
   :refnum:   9
   :caption:  Functor substructure-based matching
   :frag:     SNIPPET

The output of :oe:src:`Listing 9<SNIPPET-FunctorsOEMatch>` is the following:

.. code-block:: bash

   Number of non-amide nitrogen = 2
   Number of 5-membered ring oxygen = 1
   Number of carbon attached to halogen = 2

.. _section_predicates_partitioning:

Molecule Partitioning
================================================================================

The :oe:func:`OEChem::OESubsetMol` function can take any atom predicate
as an argument and generate a subset molecule from only atoms for which the
specified predicate returns true.  In the following example, ring atoms are
extracted from a molecule by using the :ref:`OEAtomIsInRing <OEChem_OEAtomIsInRing>`
atom functor.

.. oe:source:: FunctorsOESubsetMol.cpp
   :language: c++
   :refnum:   10
   :caption:  Ring system extraction
   :frag:     SNIPPET

.. oe:source:: FunctorsOESubsetMol.py
   :language: python
   :refnum:   10
   :caption:  Ring system extraction
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-FunctorsOESubsetMol.py>`

.. oe:source:: FunctorsOESubsetMol.java
   :language: java
   :refnum:   10
   :caption:  Ring system extraction
   :frag:     SNIPPET

.. oe:source:: FunctorsOESubsetMol.cs
   :language: csharp
   :refnum:   10
   :caption:  Ring system extraction
   :frag:     SNIPPET

The output of :oe:src:`Listing 10<SNIPPET-FunctorsOESubsetMol>` is the following:

.. code-block:: bash

   c1cc[nH]c1.C1CNCOC1

In the following example, ring systems are extracted from a molecule
by using :oe:cls:`OEPartPred<OEChem::OEPartPredT>` functor.

.. oe:source:: FunctorsOEPartPred.cpp
   :language: c++
   :refnum:   11
   :caption:  Ring system extraction
   :frag:     SNIPPET

.. oe:source:: FunctorsOEPartPred.py
   :language: python
   :refnum:   11
   :caption:  Ring system extraction
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-FunctorsOEPartPred.py>`

.. oe:source:: FunctorsOEPartPred.java
   :language: java
   :refnum:   11
   :caption:  Ring system extraction
   :frag:     SNIPPET

.. oe:source:: FunctorsOEPartPred.cs
   :language: csharp
   :refnum:   11
   :caption:  Ring system extraction
   :frag:     SNIPPET

The output of :oe:src:`Listing 11<SNIPPET-FunctorsOEPartPred>` is the following:

.. code-block:: bash

   Number of rings = 2
   1 -> c1cc[nH]c1
   2 -> C1CNCOC1


.. _chapter_protein_prep:

********************************************************************************
Protein Preparation
********************************************************************************

Protein preparation is the process of transforming a macromolecular structure
into a form more suitable for a computational experiment. The specific set of
tasks required depends on the experiment and the source of the structure.
Tools for several common prep tasks are described below.
For a demonstration of how these can be combined, see
the :ref:`section_example_oebio_proteinprep` example.

For a more comprehensive protein preparation process, :ref:`sprucetk_prep_advanced_example` shows an
end-to-end preparation workflow to process protein structures for molecular modeling.
For more information on **Spruce TK** see the associated :ref:`Theory <sprucetk_theory>`
and :ref:`Spruce API <oespruce_part_api>`.

.. _section_process_alt_locations:

Processing Alternate Locations
================================================================================

.. index:: AltLoc AltConf OEAltLocationFactory

Protein structures rarely describe whole molecules. Instead, they are usually
missing atoms that could not be resolved well. In addition, many structures
contain *multiple* copies of atoms called alternate ("alt") locations
or alternate conformations that can indicate that part of the structure is
moving. As the resolution of X-ray crystal structures improves, alt locations
can be expected to become ubiquitous. These conformations are indexed by an
ID character such as ``A`` or ``B`` that is stored in the residue information
for that atom (see :ref:`section_biopolymer_residues`).

Having extra copies of atoms can interfere with some experiments, such as
docking. One way to handle this is to eliminate all but one conformation.
By default, **OEChem TK** drops all but the ``A`` or *blank* conformations when
reading atoms in  a PDB format file. To prevent this, the file
must be read with the :oe:const:`OEChem::OEIFlavor::PDB::ALTLOC` flavor.

.. oe:source:: PrepStepsDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-FLAVOR
   :refnum:   1
   :caption:  Setting the PDB Flavor to Retain All Alts

.. oe:source:: PrepStepsDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-FLAVOR
   :refnum:   1
   :caption:  Setting the PDB Flavor to Retain All Alts

.. oe:source:: PrepStepsDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-FLAVOR
   :refnum:   1
   :caption:  Setting the PDB Flavor to Retain All Alts

.. oe:source:: PrepStepsDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-FLAVOR
   :refnum:   1
   :caption:  Setting the PDB Flavor to Retain All Alts

Another way to drop all but one conformation is to use the
:ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>` object (see the
:ref:`section_alternate_location_factory` section) and generate, for example,
a molecule that retains only the highest occupancy conformation of each location
group. This object can be used to iterate through each combination of
alt locations (for example, when a group is moving in an active site).

.. oe:source:: PrepStepsDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-PRIMARY
   :refnum:   2
   :caption:  Keeping the Highest Occupancy Alt Locations

.. oe:source:: PrepStepsDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-PRIMARY
   :refnum:   2
   :caption:  Keeping the Highest Occupancy Alt Locations

.. oe:source:: PrepStepsDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-PRIMARY
   :refnum:   2
   :caption:  Keeping the Highest Occupancy Alt Locations

.. oe:source:: PrepStepsDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-ALTLOCFACT-PRIMARY
   :refnum:   2
   :caption:  Keeping the Highest Occupancy Alt Locations

.. _section_place_hydrogens:

Adding Hydrogens and Optimizing Hydrogen Bonds
================================================================================

.. index:: HBonds OEPlaceHydrogens

Traditionally, most protein structures have been generated with either no
explicit hydrogens or only polar hydrogens.
However, having all atoms explicitly represented and positioned to make
appropriate hydrogen bonds is sometimes necessary.
The function :oe:func:`OEBio::OEPlaceHydrogens` does this by adding and
placing hydrogens and by "flipping" certain functional groups
(e.g., sidechain amides and imidazoles) as required.

.. figure:: oechemtk/images/1eocN403FLIPS405.*
   :scale:  100
   :align:  center

   **Asparagine has been flipped and serine oriented to H-bond with main-chain atoms**

.. oe:source:: PrepStepsDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-BASIC
   :refnum:   3
   :caption:  Adding and Optimizing the Positions of Hydrogens

.. oe:source:: PrepStepsDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-BASIC
   :refnum:   3
   :caption:  Adding and Optimizing the Positions of Hydrogens

.. oe:source:: PrepStepsDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-BASIC
   :refnum:   3
   :caption:  Adding and Optimizing the Positions of Hydrogens

.. oe:source:: PrepStepsDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-BASIC
   :refnum:   3
   :caption:  Adding and Optimizing the Positions of Hydrogens

There are several :ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>` parameters
that control the process. For example, it is possible to prevent the
bond lengths of any covalent bonds to pre-existing hydrogens from
being altered:

.. oe:source:: PrepStepsDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-OPTIONS
   :refnum:   4
   :caption:  Setting Options for Placing Hydrogens

.. oe:source:: PrepStepsDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-OPTIONS
   :refnum:   4
   :caption:  Setting Options for Placing Hydrogens

.. oe:source:: PrepStepsDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-OPTIONS
   :refnum:   4
   :caption:  Setting Options for Placing Hydrogens

.. oe:source:: PrepStepsDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-OPTIONS
   :refnum:   4
   :caption:  Setting Options for Placing Hydrogens

There are also :oe:cls:`OEPlaceHydrogensOptions<OEBio::OEPlaceHydrogensOptions>`
parameters for restraining which states a mover group is sampled over.
:oe:src:`Listing 5<SNIPPET-IS-SAME-RESIDUE-PRED-PlaceHydrogensPredDoc>` shows a predicate for identifying
atoms belonging to a specific residue.

.. oe:source:: PlaceHydrogensPredDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-IS-SAME-RESIDUE-PRED
   :refnum:   5
   :caption:  Predicate for Residue Equivalence

.. oe:source:: PlaceHydrogensPredDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-IS-SAME-RESIDUE-PRED
   :refnum:   5
   :caption:  Predicate for Residue Equivalence

.. oe:source:: PlaceHydrogensPredDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-IS-SAME-RESIDUE-PRED
   :refnum:   5
   :caption:  Predicate for Residue Equivalence

.. oe:source:: PlaceHydrogensPredDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-IS-SAME-RESIDUE-PRED
   :refnum:   5
   :caption:  Predicate for Residue Equivalence

We can use that predicate to prevent a selected residue from flipping:

.. oe:source:: PlaceHydrogensPredDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-PRED
   :refnum:   6
   :caption:  Preventing a Residue from Flipping

.. oe:source:: PlaceHydrogensPredDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-PRED
   :refnum:   6
   :caption:  Preventing a Residue from Flipping

.. oe:source:: PlaceHydrogensPredDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-PRED
   :refnum:   6
   :caption:  Preventing a Residue from Flipping

.. oe:source:: PlaceHydrogensPredDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-PRED
   :refnum:   6
   :caption:  Preventing a Residue from Flipping

Using an :ref:`OEPlaceHydrogensDetails <OEBio_OEPlaceHydrogensDetails>` object enables examination
of the results, showing the clusters of movable groups explored and the scores.
A simple way to get at this information is to display a summary description:

.. oe:source:: PrepStepsDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-DETAILS
   :refnum:   7
   :caption:  Examining the Details of Placing Hydrogens

.. oe:source:: PrepStepsDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-DETAILS
   :refnum:   7
   :caption:  Examining the Details of Placing Hydrogens

.. oe:source:: PrepStepsDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-DETAILS
   :refnum:   7
   :caption:  Examining the Details of Placing Hydrogens

.. oe:source:: PrepStepsDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-PLACE-HYDROGENS-DETAILS
   :refnum:   7
   :caption:  Examining the Details of Placing Hydrogens

The following is a fragment from a details object description:

.. code-block:: bash

   OEBio 2.1.1: score system MMFF-NIE: flip bias 2.000
   87 clusters : 5 flips
   cluster 0  : score -53.935!
                CG  ASN44(A)   :      amide:   -6.084  (o=-53.93!,f=-8.42!)
                NZ  LYS47(A)   : NH3 150deg:  -14.865
                CG  HIS80(A)   :    +bothHN:   -5.628  (o=-53.93!,f=-15.89!)
                OG1 THR81(A)   : OH   65deg:    1.255
                CD  GLN87(A)   :FLIP  amide:   -4.976  (o=-26.48!,f=-53.93!)
                CG  ASN126(A)  :      amide:   -5.193  (o=-53.93!,f=-35.33!)
                CG  ASN169(A)  :      amide:   -2.230  (o=-53.93!,f=-33.02!)
                CD  GLN203(A)  :      amide:   -1.400  (o=-53.93!,f=-15.53!)
                CG  HIS205(A)  :    +bothHN:   -8.693! (o=-53.93!,f=-6.89!)
                OG1 THR232(A)  : OH  179deg:    9.120
                O3B XYP601(A)  : OH  280deg:   -5.020
                O2B XYP601(A)  : OH  173deg:    3.917
                O4B XYP601(A)  : OH   50deg:    1.236
                O3  XIF602(A)  : OH   29deg:   -3.688
   cluster 1  : score -85.724!
                CG  HIS85(A)   :    +bothHN:   -7.737! (o=-85.72!,f=-84.85!)
                OG  SER86(A)   : OH  241deg:    2.116
                OG  SER139(A)  : OH  185deg:    3.367!
                OH  TYR171(A)  : OH   25deg:   -3.384
                CG  ASN172(A)  :      amide:    1.153  (o=-85.72!,f=-68.75!)
                NZ  LYS179(A)  : NH3 188deg:  -39.497
   ...
   single  13 : OG1 THR2(A)    : OH  151deg:    1.545
   single  14 : OG  SER25(A)   : OH  292deg:    2.046
   single  15 : OH  TYR29(A)   : OH  199deg:   -1.262
   single  16 : OG  SER35(A)   : OH  254deg:    1.935
   ...

.. seealso::

   * the :oe:meth:`OEBio::OEPlaceHydrogensDetails::Describe` method
     for more details about the output above
     and the ``MMFF-NIE`` scoring system that generated it.

.. _section_split_mol_complex:

Splitting Macromolecular Complexes
================================================================================

.. index:: PDB Splitting, OESplitMolComplex, OEGetMolComplexComponents, OEGetMolComplexFragments, OECombineMolComplexFragments

One common step in preparing a macromolecular complex
for use as input to a calculation is to separate components based
on their functional roles.
For example, a **SZMAP** calculation on a four-chain protein crystal structure
might require one of four copies of the ligand to be extracted
and the protein-complex associated with that ligand binding site
to be separately extracted, ignoring any waters, buffers, etc.

:oe:src:`Listing 8<SNIPPET-SPLIT-MOL-COMPLEX-SIMPLE-SplitMolComplexOptDoc>` uses the
:oe:func:`OEBio::OESplitMolComplex` function to separate the input molecule
into the ligand for the first binding site, the protein-complex
(including cofactors) for that site, the binding site waters,
and everything else. In this example, the ligand is identified automatically
and the binding site contains components near the ligand. If a ligand cannot be
located, the entirety of each protein and everything nearby defines each
binding site. If the input molecule is empty or there is some other
problem that prevents processing, :oe:func:`OEBio::OESplitMolComplex`
will return ``false``.

.. oe:source:: SplitMolComplexOptDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-SIMPLE
   :refnum:   8
   :caption:  Splitting an Input Molecule

.. oe:source:: SplitMolComplexOptDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-SIMPLE
   :refnum:   8
   :caption:  Splitting an Input Molecule

.. oe:source:: SplitMolComplexOptDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-SIMPLE
   :refnum:   8
   :caption:  Splitting an Input Molecule

.. oe:source:: SplitMolComplexOptDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-SIMPLE
   :refnum:   8
   :caption:  Splitting an Input Molecule

:oe:src:`Listing 8<SNIPPET-SPLIT-MOL-COMPLEX-SIMPLE-SplitMolComplexOptDoc>` uses the defaults,
so no attempt would be made to recognize covalent ligands.
:oe:src:`Listing 9<SNIPPET-SPLIT-MOL-COMPLEX-SPLIT-COVALENT-SplitMolComplexOptDoc>` uses an option
to turn on the splitting of covalent ligands. There are a
large number of options to control the process of splitting
a molecule. See :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>`
for a complete list.

.. oe:source:: SplitMolComplexOptDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-SPLIT-COVALENT
   :refnum:   9
   :caption:  Splitting Covalent Ligands

.. oe:source:: SplitMolComplexOptDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-SPLIT-COVALENT
   :refnum:   9
   :caption:  Splitting Covalent Ligands

.. oe:source:: SplitMolComplexOptDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-SPLIT-COVALENT
   :refnum:   9
   :caption:  Splitting Covalent Ligands

.. oe:source:: SplitMolComplexOptDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-SPLIT-COVALENT
   :refnum:   9
   :caption:  Splitting Covalent Ligands

A related approach uses :oe:func:`OEBio::OEGetMolComplexComponents`
to return an iterator of molecules.
:oe:src:`Listing 10<SNIPPET-SPLIT-MOL-COMPLEX-ITER-LIGNAME-SplitMolComplexIterDoc>` also illustrates
providing an explicit ligand residue name that must match
for the ligand to be identified.

.. oe:source:: SplitMolComplexIterDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ITER-LIGNAME
   :refnum:   10
   :caption:  Iterating Over Split Components

.. oe:source:: SplitMolComplexIterDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ITER-LIGNAME
   :refnum:   10
   :caption:  Iterating Over Split Components

.. oe:source:: SplitMolComplexIterDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ITER-LIGNAME
   :refnum:   10
   :caption:  Iterating Over Split Components

.. oe:source:: SplitMolComplexIterDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ITER-LIGNAME
   :refnum:   10
   :caption:  Iterating Over Split Components

The process used by the :oe:func:`OEBio::OESplitMolComplex`
and :oe:func:`OEBio::OEGetMolComplexComponents` functions involves
two steps:

#. separating components and assigning functional roles
#. filtering by roles to select the desired components

:oe:func:`OEBio::OESplitMolComplex` accesses separate filters
for ``lig``, ``prot``, ``wat``, and ``other`` from the
:ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` object.
In :oe:func:`OEBio::OEGetMolComplexComponents`,
the combination of the ligand, protein, and water filters
is used to select the output components. The options method
:oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters`
can be used for basic changes to the filters, such as selecting
a different binding site (see :oe:src:`Listing 11<SNIPPET-SPLIT-MOL-COMPLEX-ALL-SITES-SplitMolComplexOptDoc>`).

.. oe:source:: SplitMolComplexOptDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ALL-SITES
   :refnum:   11
   :caption:  Resetting Filters for All Sites

.. oe:source:: SplitMolComplexOptDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ALL-SITES
   :refnum:   11
   :caption:  Resetting Filters for All Sites

.. oe:source:: SplitMolComplexOptDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ALL-SITES
   :refnum:   11
   :caption:  Resetting Filters for All Sites

.. oe:source:: SplitMolComplexOptDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ALL-SITES
   :refnum:   11
   :caption:  Resetting Filters for All Sites

The function :oe:func:`OEBio::OECountMolComplexSites`
returns the number of binding sites.

:oe:src:`Listing 12<SNIPPET-SPLIT-MOL-COMPLEX-COMBINE-FILTERS-SplitMolComplexOptDoc>`
shows a more involved case, combining protein-complex
and binding-site waters into
the protein filter and nothing in the water filter.

.. oe:source:: SplitMolComplexOptDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-COMBINE-FILTERS
   :refnum:   12
   :caption:  Modifying Filters

.. oe:source:: SplitMolComplexOptDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-COMBINE-FILTERS
   :refnum:   12
   :caption:  Modifying Filters

.. oe:source:: SplitMolComplexOptDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-COMBINE-FILTERS
   :refnum:   12
   :caption:  Modifying Filters

.. oe:source:: SplitMolComplexOptDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-COMBINE-FILTERS
   :refnum:   12
   :caption:  Modifying Filters

:oe:src:`Listing 13<SNIPPET-SPLIT-MOL-COMPLEX-ITER-FILTER-SplitMolComplexIterDoc>`
illustrates using an explicit filter when
iterating. :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` objects
can be of arbitrary complexity.

.. oe:source:: SplitMolComplexIterDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ITER-FILTER
   :refnum:   13
   :caption:  Explicit Filter When Iterating

.. oe:source:: SplitMolComplexIterDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ITER-FILTER
   :refnum:   13
   :caption:  Explicit Filter When Iterating

.. oe:source:: SplitMolComplexIterDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ITER-FILTER
   :refnum:   13
   :caption:  Explicit Filter When Iterating

.. oe:source:: SplitMolComplexIterDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ITER-FILTER
   :refnum:   13
   :caption:  Explicit Filter When Iterating

For more complex workflows, it is useful to explicitly separate
the tasks of assigning roles and filtering, if only to avoid
the expense of assigning roles multiple times.
:oe:src:`Listing 14<SNIPPET-SPLIT-MOL-COMPLEX-LOWLEVEL-FRAGMENT-SplitMolComplexLowLevelDoc>`
shows how to assign roles to each fragment in a molecule
for later use.

.. oe:source:: SplitMolComplexLowLevelDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-LOWLEVEL-FRAGMENT
   :refnum:   14
   :caption:  Assigning Roles to Each Mol Fragment

.. oe:source:: SplitMolComplexLowLevelDoc.py
   :language: python
   :noindent:
   :frag:    SNIPPET-SPLIT-MOL-COMPLEX-LOWLEVEL-FRAGMENT
   :refnum:   14
   :caption:  Assigning Roles to Each Mol Fragment

.. oe:source:: SplitMolComplexLowLevelDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-LOWLEVEL-FRAGMENT
   :refnum:   14
   :caption:  Assigning Roles to Each Mol Fragment

.. oe:source:: SplitMolComplexLowLevelDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-LOWLEVEL-FRAGMENT
   :refnum:   14
   :caption:  Assigning Roles to Each Mol Fragment

In :oe:src:`Listing 15<SNIPPET-SPLIT-MOL-COMPLEX-LOWLEVEL-COMBINE-SplitMolComplexLowLevelDoc>`,
the role information for each fragment is used to determine the
number of binding sites and is filtered
to produce ligand and protein complex mols.

.. oe:source:: SplitMolComplexLowLevelDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-LOWLEVEL-COMBINE
   :refnum:   15
   :caption:  Filtering Mol Fragments

.. oe:source:: SplitMolComplexLowLevelDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-LOWLEVEL-COMBINE
   :refnum:   15
   :caption:  Filtering Mol Fragments

.. oe:source:: SplitMolComplexLowLevelDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-LOWLEVEL-COMBINE
   :refnum:   15
   :caption:  Filtering Mol Fragments

.. oe:source:: SplitMolComplexLowLevelDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-LOWLEVEL-COMBINE
   :refnum:   15
   :caption:  Filtering Mol Fragments

The basic idea behind automatic ligand identification is
that the list of compounds that are *not* ligands (cofactors,
buffers, etc.) grows faster than the list of ligands.
The :ref:`OEResidueCategoryData <OEBio_OEResidueCategoryData>` object
contained within an :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>`
is a database of these non-ligands. Although this database
is being updated as we run across more cofactors, buffers, etc.,
it is possible for users to update the database as needed.
:oe:src:`Listing 16<SNIPPET-SPLIT-MOL-COMPLEX-ADD-COFACTOR-SplitMolComplexIterDoc>` shows how
this is done, involving the Russian nesting doll-like organization of a
:ref:`OEResidueCategoryData <OEBio_OEResidueCategoryData>` within a
:ref:`OEMolComplexCategorizer <OEBio_OEMolComplexCategorizer>` within a
:ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` object.

.. oe:source:: SplitMolComplexIterDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ADD-COFACTOR
   :refnum:   16
   :caption:  Adding a Cofactor

.. oe:source:: SplitMolComplexIterDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ADD-COFACTOR
   :refnum:   16
   :caption:  Adding a Cofactor

.. oe:source:: SplitMolComplexIterDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ADD-COFACTOR
   :refnum:   16
   :caption:  Adding a Cofactor

.. oe:source:: SplitMolComplexIterDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ADD-COFACTOR
   :refnum:   16
   :caption:  Adding a Cofactor

.. note::

   Please help **OpenEye** maintain and expand
   the built-in :ref:`OEResidueCategoryData <OEBio_OEResidueCategoryData>`
   by informing us of any oversights or mistakes.

The most important :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` parameters
can be controlled from the command line using
:oe:func:`OEBio::OEConfigureSplitMolComplexOptions` and
:oe:func:`OEBio::OESplitMolComplexSetup`
(see :oe:src:`Listing 17<SNIPPET-SPLIT-MOL-COMPLEX-ITF-SplitMolComplexDoc>`).

.. oe:source:: SplitMolComplexDoc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ITF
   :refnum:   17
   :caption:  Command Line Options

.. oe:source:: SplitMolComplexDoc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ITF
   :refnum:   17
   :caption:  Command Line Options

.. oe:source:: SplitMolComplexDoc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ITF
   :refnum:   17
   :caption:  Command Line Options

.. oe:source:: SplitMolComplexDoc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SPLIT-MOL-COMPLEX-ITF
   :refnum:   17
   :caption:  Command Line Options


.. _chapter_reactions:

********************************************************************************
Reactions
********************************************************************************

.. index :: OEUniMolecularRxn, OELibraryGen

Reaction processing in **OEChem TK** is divided into two categories: unimolecular
reactions and library generation.
Unimolecular reactions are useful for (although not limited to) normalization
reactions.
The :oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>` class in **OEChem TK**
applies chemical transformations to individual molecules.
Reactions can also be used to generate combinatorial libraries using **OEChem TK**.
Both 'clipping' and reaction based enumeration can be achieved using the
:oe:cls:`OELibraryGen<OEChem::OELibraryGen>` class.

:ref:`Figure: OEUniMolecularRxn<figure_oeuni_concept>`  and
:ref:`Figure: OELibraryGen <figure_oelibgen_concept_A>` demonstrate
the difference between the operation of
:oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>` and the operation of
:oe:cls:`OELibraryGen<OEChem::OELibraryGen>`.

:oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>` always takes one
starting compound (see :ref:`Figure: OEUniMolecularRxn<figure_oeuni_concept>`)
to which the specified transformation is applied recursively, until no further reactant
pattern are
matched, thereby generating one final product.
See more details about :oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>` class
in section :ref:`section_reactions_normalization`.

.. _figure_oeuni_concept:

.. figure:: oechemtk/images/OEUniMolecularRxn.*
   :scale:  100
   :align:  center

   **OEUniMolecularRxn**

   *Example of amine nitrogen protonation using 'OEUniMolecularRxn'. Transformations are applied to the starting material recursively*

:oe:cls:`OELibraryGen<OEChem::OELibraryGen>` performs transformations independently to
each other, enumerating all possible combinations.
As a result, three different products are generated when the same protonation transformation
is applied to the starting material using :oe:cls:`OELibraryGen<OEChem::OELibraryGen>`
(see :ref:`Figure: OELibraryGen<figure_oelibgen_concept_A>`).

.. _figure_oelibgen_concept_A:

.. figure:: oechemtk/images/OELibraryGen.*
   :scale:  100
   :align:  center

   **OELibraryGen**

   *Example of amine nitrogen protonation using 'OELibraryGen'. Transformations are applied to the starting material independently*

When :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` is used to generate combinatorial
libraries (see :ref:`Figure: Library generation<figure_oelibgen_concept_B>`),
all starting material combinations are enumerated to generate products by
considering that any reactant patterns can be mapped to any
starting materials multiple times.
See more details about :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` class in section
:ref:`section_reactions_libgen`.

.. _figure_oelibgen_concept_B:

.. figure:: oechemtk/images/AmideReaction.*
   :scale:  100
   :align:  center

   **Library generation**

   *Example of library generation. 'OELibraryGen' enumerates all possible reacting pattern combinations to generate products.*

Reactions are represented in **OEChem TK** as query molecules ( :oe:cls:`OEQMolBase<OEChem::OEQMolBase>` ).
Sets of chemical transform operations are derived from reaction molecules by
differences between the reactant and product patterns and in the reaction
molecule.
For example, atoms and bonds that appear in the reactant pattern, but are
absent in the product pattern are *destroyed*.
Atoms and bonds that appear in the product pattern but not in the reactant
pattern are *created*.
Atoms are tracked between reactants and products by atom maps.
Atom maps are stored and retrieved using
the :oe:meth:`SetMapIdx<OEChem::OEAtomBase::SetMapIdx>` and
the :oe:meth:`GetMapIdx<OEChem::OEAtomBase::GetMapIdx>` methods.
Product atoms that have the same map index as reactant atoms originate from
their reactant counterpart.
Reactions are completely defined by a fields in a query molecule.
Reaction molecules can be created from virtually any reaction file format
(:term:`SMIRKS`, MDL RXN, etc.), and can even be constructed programmatically.

.. _section_reactions_normalization:

Normalization Reactions
================================================================================
.. index :: OEUniMolecularRxn

The :oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>` class is designed to
apply a set of transformations defined by a reaction to exactly one reactant
molecule.
All possible transformations are applied to the initial set of atoms and bonds of
an input molecule.
For example, a reaction that affects a particular type of functional group will
be automatically applied twice to a bi-functional molecule.
The number of transformations applied by the
:oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>` class is limited in order
to prevent infinite loops.
Consider a hypothetical reaction that methylates a methyl group.
If a methyl group added in a reaction were allowed to react again, the methyl
groups of a molecule would be methylated *ad infinitum*.
The first protection against infinite loops provided by
:oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>` is that only original
atoms and bonds of the input molecule are allowed to react.
Atoms and bonds created by a reaction are excluded from involvement in further
reactions.
A more subtle source of potential infinite loops are reactions where product
atoms still match the reactant pattern after they have been involved in a
chemical transformation.
The :oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>` class allows a set of
atoms that match a reactant pattern to react only once.

The following code demonstrates the use of the
:oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>` class.
:oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>` in this case is initialized
using a :term:`SMIRKS` pattern.
The example reaction (see :ref:`Figure: Protonation<figure_oeuni_example>`) protonates and charges
an amine nitrogen.
The reaction demonstrates the protection mechanisms in place to prevent
under-specified reactions from causing infinite loops.
The product in :ref:`Figure: Protonation<figure_oeuni_example>` still matches the reactant pattern,
however, subsequent reactions terminate when no unreacted atoms are identified.

.. oe:source:: Normalization.cpp
   :language: c++
   :caption:  Normalization
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: Normalization.py
   :language: python
   :caption:  Normalization
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: Normalization.java
   :language: java
   :caption:  Normalization
   :refnum:   1
   :frag:     SNIPPET

.. oe:source:: Normalization.cs
   :language: csharp
   :caption:  Normalization
   :refnum:   1
   :frag:     SNIPPET

The output of :oe:src:`Listing 1<SNIPPET-Normalization>` is the following:

.. code-block:: bash

   smiles =  C(C[NH3+])[NH3+]

.. _figure_oeuni_example:

.. figure:: oechemtk/images/AmineProtonation.*
   :scale:  100
   :align:  center

   **Protonation**

   *Example of amine nitrogen protonation.*

.. _section_reactions_libgen:

Library Generation
================================================================================

.. index :: OELibraryGen

The :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` was designed to give programmers a
high degree of control when applying chemical transformations.
It was also designed for efficiency. Potentially costly preprocessing is performed
once before transformations can be carried out.
The relative setup cost of a :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` instance may
be high, and the memory use large as preprocessed reactants are stored in memory.
Subsequent generation of products, however, is very efficient because setup
costs are paid in advance.
The  :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` class serves a dual purpose of
managing sets of preprocessed starting materials, and storing a list of chemical
transform operations defined by a reaction molecule.

Chemical transform operations are carried out on starting materials.
Starting materials provide most of the virtual matter that goes into
making virtual product molecules.
The :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` class provides an interface to
associate starting materials with reactant patterns using the
:oe:meth:`SetStartingMaterial<OEChem::OELibraryGen::SetStartingMaterial>`  and
:oe:meth:`AddStartingMaterial<OEChem::OELibraryGen::AddStartingMaterial>`  methods.
These methods associate starting materials to reactant patterns using the index
(reactant number) of the pattern.
In a SMIRKS pattern the first reactant (reactant number zero) is the furthest
reactant on the left.
Disconnected reactant patterns may be grouped into a single component using
component level grouping in SMIRKS, denoted by parentheses.

.. _subsection_reactions_libgen_initsmirks:

Initialization with SMIRKS
--------------------------------------------------------------------------------

:oe:cls:`OELibraryGen<OEChem::OELibraryGen>` objects can be directly initialized
with a SMIRKS pattern or an :oe:cls:`OEQMolBase<OEChem::OEQMolBase>` object.
See example codes in :oe:src:`Listing 2<SNIPPET-ReactionsNonUnique>` --
:oe:src:`Listing 5<SNIPPET-ReactionsUsingValenceCorr>`.

A boolean argument is used to specify whether the SMIRKS string should be
interpreted using strict SMIRKS semantics. See the :term:`SMIRKS` definition
describing the strict SMIRKS semantics.
Passing a boolean value of false to the second method argument will relax
the strict SMIRKS restrictions.
The :oe:meth:`Init<OEChem::OELibraryGen::Init>` function returns false,
if :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` can not be initialized.

:oe:cls:`OELibraryGen<OEChem::OELibraryGen>` objects can also be initialized from
an MDL reaction query file, for more details and examples see section
:ref:`subsection_reactions_libgen_MDL`.

.. _subsection_reactions_libgen_sm:

Starting Materials
--------------------------------------------------------------------------------

The :oe:meth:`SetStartingMaterial<OEChem::OELibraryGen::SetStartingMaterial>`  and
:oe:meth:`AddStartingMaterial<OEChem::OELibraryGen::AddStartingMaterial>`  methods
are used to initialize the starting materials corresponding to a reaction component
(reactant).
The declaration of these functions are:

.. oe:language:: c++

   .. code-block:: c++

      unsigned int SetStartingMaterial(OEIter<OEMolBase>&,     unsigned int reacnum, bool umatch=true);
      unsigned int AddStartingMaterial(OEIter<OEMolBase>&,     unsigned int reacnum, bool umatch=true);

      unsigned int SetStartingMaterial(OEIterBase<OEMolBase>*, unsigned int reacnum, bool umatch=true);
      unsigned int AddStartingMaterial(OEIterBase<OEMolBase>*, unsigned int reacnum, bool umatch=true);

      unsigned int SetStartingMaterial(const OEMolBase&,       unsigned int reacnum, bool umatch=true);
      unsigned int AddStartingMaterial(const OEMolBase&,       unsigned int reacnum, bool umatch=true);

.. oe:language:: python

   .. code-block:: python

      SetStartingMaterial(miter,reacnum,umatch)
      AddStartingMaterial(miter,reacnum,umatch)
      # miter - OEMolBaseIter, reacnum - int, umatch - bool (default value = True)
      # returns int

      SetStartingMaterial(mol,reacnum,umatch)
      AddStartingMaterial(mol,reacnum,umatch)
      # mol - OEMolBase, reacnum - int, umatch - bool (default value = True)
      # returns int

.. oe:language:: java

   .. code-block:: java

      int SetStartingMaterial(OEMolBaseIterBase, int reacnum, boolean umatch);
      int AddStartingMaterial(OEMolBaseIterBase, int reacnum, boolean umatch);
      // umatch (default value = true)

      int SetStartingMaterial(OEMolBase, int reacnum, boolean umatch);
      int AddStartingMaterial(OEMolBase, int reacnum, boolean umatch);
      // umatch (default value = true)

.. oe:language:: csharp

   .. code-block:: csharp

      uint SetStartingMaterial(OEMolBaseIterBase, uint reacnum, bool umatch);
      uint AddStartingMaterial(OEMolBaseIterBase, uint reacnum, bool umatch);
      // umatch (default value = true)

      uint SetStartingMaterial(OEMolBase, uint reacnum, bool umatch);
      uint AddStartingMaterial(OEMolBase, uint reacnum, bool umatch);
      // umatch (default value = true)

An iterator over molecules or a single molecule may be passed as the first argument
to these methods.
A copy of each starting material is stored internally along with the atom maps
obtained by performing a substructure search with the corresponding reactant pattern.

The difference between using :oe:meth:`SetStartingMaterial<OEChem::OELibraryGen::SetStartingMaterial>` and
:oe:meth:`AddStartingMaterial<OEChem::OELibraryGen::AddStartingMaterial>`  methods is that
by calling  :oe:meth:`SetStartingMaterial<OEChem::OELibraryGen::SetStartingMaterial>` the
starting materials set in prior calls are discarded, while the
:oe:meth:`AddStartingMaterial<OEChem::OELibraryGen::AddStartingMaterial>` methods append
to the list of starting materials set in prior calls.

The second argument specifies the reactant by number, starting with
zero, to which the starting materials correspond.  These numbers
correspond with the left to right lexical ordering of reactants in the
SMIRKS.  In the :oe:src:`Listing 2<SNIPPET-ReactionsNonUnique>` example code,
there is only one reactant pattern specified in the SMIRKS string,
therefore 0 is used to add the corresponding starting materials.

The final argument is used to control the pattern matching of the
reactant pattern to the starting material.  If the default true value
is used, then only matches that contain a unique set of atoms relative
to previously identified matches are used.  If the value is false,
every possible match including those related by symmetry will be used.
:oe:src:`Listing 2<SNIPPET-ReactionsNonUnique>` and the corresponding
:ref:`Figure: Non-unique search<figure_oelibgen_nonunique>` shows an
example in which two unique products are generated because the
reactant pattern can be mapped twice when a non-unique substructure
search is performed.  For more information about substructure searches
see section :ref:`section_patternmatch_sss`.

Both the :oe:meth:`SetStartingMaterial<OEChem::OELibraryGen::SetStartingMaterial>` and
the :oe:meth:`AddStartingMaterial<OEChem::OELibraryGen::AddStartingMaterial>` methods
return the number of matches found in the starting materials.

.. oe:source:: ReactionsNonUnique.cpp
   :language: c++
   :caption:  Library generation with non-unique pattern matching
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: ReactionsNonUnique.py
   :language: python
   :caption:  Library generation with non-unique pattern matching
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: ReactionsNonUnique.java
   :language: java
   :caption:  Library generation with non-unique pattern matching
   :refnum:   2
   :frag:     SNIPPET

.. oe:source:: ReactionsNonUnique.cs
   :language: csharp
   :caption:  Library generation with non-unique pattern matching
   :refnum:   2
   :frag:     SNIPPET

.. _figure_oelibgen_nonunique:

.. figure:: oechemtk/images/DepictNonUniqueReactionmMatch.*
   :scale:  100
   :align:  center

   **Non-unique search**

   *Example of generating two unique products when performing non-unique pattern matching.*

The output of :oe:src:`Listing 2<SNIPPET-ReactionsNonUnique>` is shown below:

.. code-block:: bash

   number of matches = 2
   product smiles = c1cnc2nccn2c1O
   product smiles = c1cn2ccnc2nc1O

.. _subsection_reactions_libgen_modes:

Valence Correction Modes
--------------------------------------------------------------------------------

Once a reaction has been defined, and starting materials have been associated with
each of the reactant patterns, chemical transformations can be applied to
combinations of starting materials.
To achieve a chemically reasonable output attention should be given to the mode
of valence (or hydrogen count) correction that matches the reaction.

The :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` class has three possible modes of
valence correction:

#.  the default explicit hydrogen mode (see example in section :ref:`subsection_reactions_libgen_explicitH`)

#.  the implicit hydrogen mode (see example in section :ref:`subsection_reactions_libgen_implicitH`)

#.  the automatic valence correction mode (see example in section :ref:`subsection_reactions_libgen_vcorrect`)

The valence correction mode must be assigned prior to adding starting materials
to an :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` instance by calling the
:oe:meth:`SetExplicitHydrogens<OEChem::OELibraryGen::SetExplicitHydrogens>` and the
:oe:meth:`SetValenceCorrection<OEChem::OELibraryGen::SetValenceCorrection>` methods.

Note that the explicit hydrogen setting in effect modifies the semantics of SMIRKS.
If the programmer wishes to implement strict SMIRKS according to the Daylight
standard, in full, explicit hydrogens should be set on.

.. _subsection_reactions_libgen_explicitH:

Explicit Hydrogen Handling
--------------------------------------------------------------------------------
The default mode for valence correction and SMIRKS interpretation is to emulate
the Daylight Reaction Toolkit.
Hydrogen counts are adjusted using explicit hydrogens in SMIRKS patterns.
Reactions are carried out using explicit hydrogens, and valence
correction occurs when explicit hydrogens are added or deleted as
defined by a reaction.
The following example demonstrates strict SMIRKS and explicit hydrogen handling.

.. oe:source:: ReactionsUsingExplH.cpp
   :language: c++
   :caption:  Library generation using explicit hydrogens
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: ReactionsUsingExplH.py
   :language: python
   :caption:  Library generation using explicit hydrogens
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: ReactionsUsingExplH.java
   :language: java
   :caption:  Library generation using explicit hydrogens
   :refnum:   3
   :frag:     SNIPPET

.. oe:source:: ReactionsUsingExplH.cs
   :language: csharp
   :caption:  Library generation using explicit hydrogens
   :refnum:   3
   :frag:     SNIPPET

The output of :oe:src:`Listing 3<SNIPPET-ReactionsUsingExplH>` is shown below:

.. code-block:: bash

   product smiles = CCNC(=O)C
   product smiles = CCNC(=O)C

The program generates two products, each of them corresponds to the equivalent
protons attached to the amine (see example in :ref:`Figure: Hydrogen handling<figure_oelibgen_strict>`).
If a unique set of products is desired, canonical smiles strings may be stored
for verification that products generated are indeed unique.

.. _figure_oelibgen_strict:

.. figure:: oechemtk/images/DepictExplicitHydrogenHandling.*
   :scale:  100
   :align:  center

   **Hydrogen handling**

   *Example of strict SMIRKS reaction handling with explicit hydrogen*

.. _subsection_reactions_libgen_implicitH:

Implicit Hydrogen Handling
--------------------------------------------------------------------------------

The following code demonstrates how the same basic reaction given in the previous
example can be carried out using the implicit hydrogen correction mode.
Notice that no explicit hydrogens appear in the reaction.
Instead, the SMARTS implicit hydrogen count operator appears on the right hand
side of the reaction and is used to assign the implicit hydrogen count of the
product nitrogen.

.. oe:source:: ReactionsUsingImplH.cpp
   :language: c++
   :caption:  Library generation using implicit hydrogens
   :refnum:   4
   :frag:     SNIPPET

.. oe:source:: ReactionsUsingImplH.py
   :language: python
   :caption:  Library generation using implicit hydrogens
   :refnum:   4
   :frag:     SNIPPET

.. oe:source:: ReactionsUsingImplH.java
   :language: java
   :caption:  Library generation using implicit hydrogens
   :refnum:   4
   :frag:     SNIPPET

.. oe:source:: ReactionsUsingImplH.cs
   :language: csharp
   :caption:  Library generation using implicit hydrogens
   :refnum:   4
   :frag:     SNIPPET

The output of :oe:src:`Listing 4<SNIPPET-ReactionsUsingImplH>` is the following:

.. code-block:: bash

   product smiles = CCNC(=O)C

The reaction is written to work with implicit hydrogens (using the lowercase
'h' primitive), and the :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` instance
is set to work in implicit hydrogen mode using the
:oe:meth:`SetExplicitHydrogens<OEChem::OELibraryGen::SetExplicitHydrogens>`
method.

The :oe:meth:`SetExplicitHydrogens<OEChem::OELibraryGen::SetExplicitHydrogens>`
method sets the hydrogen handling mode for the :oe:cls:`OELibraryGen<OEChem::OELibraryGen>`
instance.
:oe:cls:`OELibraryGen<OEChem::OELibraryGen>` instances are constructed by default
with the explicit hydrogen mode set to true.
If the value is true, the  :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` instance will add
explicit hydrogens to reactant molecules when they are initialized using either the
:oe:meth:`SetStartingMaterial<OEChem::OELibraryGen::SetStartingMaterial>` or the
:oe:meth:`AddStartingMaterial<OEChem::OELibraryGen::AddStartingMaterial>` methods.

If the value is false, then the :oe:meth:`SetStartingMaterial<OEChem::OELibraryGen::SetStartingMaterial>`
and  the :oe:meth:`AddStartingMaterial<OEChem::OELibraryGen::AddStartingMaterial>`
methods will suppress any explicit hydrogens in the reactant molecules, and simply
retain the implicit hydrogen counts for remaining non-hydrogen atoms.

Note that the explicit hydrogen setting in effect modifies the semantics of SMIRKS.
If the programmer wishes to implement strict SMIRKS according to the Daylight
standard, in full, explicit hydrogens should be set on.

.. _subsection_reactions_libgen_vcorrect:

Automatic Valence Correction
--------------------------------------------------------------------------------

The final example demonstrates automatic valence correction with implicit hydrogen mode.
The automatic valence correction attempts to add or subtract implicit
hydrogens in order to retain the valence state observed in the starting materials.

:oe:cls:`OELibraryGen<OEChem::OELibraryGen>` instances are constructed by default
with the valence correction mode being turned off.
It can be turned on by passing a boolean true value to
:oe:meth:`SetValenceCorrection<OEChem::OELibraryGen::SetValenceCorrection>`
method of :oe:cls:`OELibraryGen<OEChem::OELibraryGen>`
(see example in :oe:src:`Listing 5<SNIPPET-ReactionsUsingValenceCorr>`).

When valence correction mode is enabled, the valence state for each mapped reacting
atom is recorded before any chemical transformations commence.
After the transform operations are complete, :oe:cls:`OELibraryGen<OEChem::OELibraryGen>`
will attempt to adjust (either increase or decrease) the implicit hydrogen
count on atoms in the product molecule that are involved in the reaction
to match the original valence state of the corresponding reactant atom.
Formal charge is taken into account during the hydrogen count adjustment.

.. oe:source:: ReactionsUsingValenceCorr.cpp
   :language: c++
   :caption:  Library generation with automatic valence correction
   :refnum:   5
   :frag:     SNIPPET

.. oe:source:: ReactionsUsingValenceCorr.py
   :language: python
   :caption:  Library generation with automatic valence correction
   :refnum:   5
   :frag:     SNIPPET

.. oe:source:: ReactionsUsingValenceCorr.java
   :language: java
   :caption:  Library generation with automatic valence correction
   :refnum:   5
   :frag:     SNIPPET

.. oe:source:: ReactionsUsingValenceCorr.cs
   :language: csharp
   :caption:  Library generation with automatic valence correction
   :refnum:   5
   :frag:     SNIPPET

The output of :oe:src:`Listing 5<SNIPPET-ReactionsUsingValenceCorr>` is shown
below:

.. code-block:: bash

   product smiles = CCNC(=O)C

Note that valence correction in effect modifies the semantics of SMIRKS.
Thus, if the programmer wishes to implement strict SMIRKS according to the
Daylight standard, in full, valence correction should be turned off.

In general, automatic valence correction is a convenience that allows
straightforward reactions to be written in a simplified manner and
reduces the burden of valence state bookkeeping.  However, reactions that alter
the preferred valence state of an atom, oxidation for example, **may not
be automatically correctable**.

.. _subsection_reactions_libgen_tracking:

Reactant Tracking
--------------------------------------------------------------------------------

The title of a product molecule is generated by concatenating reactant molecule
titles with a delimiter or separator inserted between them.
The default separator is the underscore character '_'.
The title separator string may be changed by calling the
:oe:meth:`SetTitleSeparator<OEChem::OELibraryGen::SetTitleSeparator>` method
(see example in :oe:src:`Listing 6<SNIPPET-ReactionsReactantTrace>`).

.. oe:source:: ReactionsReactantTrace.cpp
   :language: c++
   :caption:  Tracing reactants
   :refnum:   6
   :frag:     SNIPPET

.. oe:source:: ReactionsReactantTrace.py
   :language: python
   :caption:  Tracing reactants
   :refnum:   6
   :frag:     SNIPPET

.. oe:source:: ReactionsReactantTrace.java
   :language: java
   :caption:  Tracing reactants
   :refnum:   6
   :frag:     SNIPPET

.. oe:source:: ReactionsReactantTrace.cs
   :language: csharp
   :caption:  Tracing reactants
   :refnum:   6
   :frag:     SNIPPET

If every reactant added to an :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` instance
has a unique identifier or name, then the title of a generated product unambiguous
determines from which reactants the product was constructed.
The output of :oe:src:`Listing 6<SNIPPET-ReactionsReactantTrace>` is shown below:

.. code-block:: bash

   Number of products=4
   product smiles = CCNC(=O)C acetyl chloride#ethanamine
   product smiles = CC(=O)NCCO acetyl chloride#2-aminoethanol
   product smiles = CCNC(=O)c1ccccc1 benzoyl chloride#ethanamine
   product smiles = c1ccc(cc1)C(=O)NCCO benzoyl chloride#2-aminoethanol

Both :oe:meth:`SetStartingMaterial<OEChem::OELibraryGen::SetStartingMaterial>` and
:oe:meth:`AddStartingMaterial<OEChem::OELibraryGen::AddStartingMaterial>` methods
return the number of substructure matches detected in the compounds(s) added to
:oe:cls:`OELibraryGen<OEChem::OELibraryGen>`.
Because :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` enumerates all possible reactant
combinations to generate products, the number of products that will be generated
can be calculated by multiplying the number of reactant matches.
In the example in :oe:src:`Listing 6<SNIPPET-ReactionsReactantTrace>`, there are four
expected products, because only one substructure match is detected for each reactant.

.. _subsection_reactions_libgen_atommapping:

Atom Mapping
--------------------------------------------------------------------------------

The atom mapping defines which atoms and bonds remain the same and which are altered
on the reactant and products sides of the reaction.

#.  Atoms that appear in both sides of the reaction are left intact.

#.  Atoms and bonds that appear in the product pattern(s) but not in the reactant
    pattern(s) are created.

#.  Atoms and bonds that disappear in the reactant pattern(s) but not in the product
    pattern(s) are deleted.
    When an atom is deleted all of its unmapped explicit hydrogens are automatically
    removed.

#.  Unmapped reactant atoms are deleted only in strict semantics.

The user should carefully consider whether to add a mapping or to leave unmapped an atom
in the reaction.
Consider, for example, the first reactant pattern in
:ref:`Figure: Incorrect reaction mapping (top)<figure_oelibgen_mapping_01_A>`
that can be mapped both to aldehydes or ketones.
Because the carbon atom of the carbonyl (mapping index 2) appears in both side of the
reaction, it remains intact during the reaction with all of its neighbor atoms that
are not described in the reactant pattern.
As a result, when the reactant pattern is mapped to an acyl chloride (see
:ref:`Figure: Incorrect reaction mapping (bottom)<figure_oelibgen_mapping_01_A>`) the chlorine atom is still bonded to
the carbon in the generated product.

.. _figure_oelibgen_mapping_01_A:

.. figure:: /_images/OELibGen-mapping-reaction-01-A.png
   :scale:  100
   :align:  center

   **Incorrect reaction mapping**

   *Example of incorrect reaction mapping; (top) reaction definition, (bottom) product generation.*

By removing the atom mapping from the carbon atom of the carbonyl
(:ref:`Figure: Correct reaction mapping (top)<figure_oelibgen_mapping_01_B>`), the carbon atom will be created on the
product side during the product generation.
As a result, when the reactant pattern is mapped to an acyl chloride
(see :ref:`Figure: Correct reaction mapping (bottom)<figure_oelibgen_mapping_01_B>`), the bond between the carbon
and the chlorine atom is broken.

.. _figure_oelibgen_mapping_01_B:

.. figure:: /_images/OELibGen-mapping-reaction-01-B.png
   :scale:  100
   :align:  center

   **Correct reaction mapping**

   *Example of correct reaction mapping; (top) reaction definition, (bottom) product generation.*

The :oe:meth:`SetRemoveUnmappedFragments<OEChem::OELibraryGen::SetRemoveUnmappedFragments>`
method  of :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` controls whether to keep
or remove the unmapped components on the product side after the reaction is
executed.
When it is enabled, by calling
:oe:meth:`SetRemoveUnmappedFragments<OEChem::OELibraryGen::SetRemoveUnmappedFragments>`
with the boolean value of 'true', any component on the product side that has no
mapped atom is automatically removed.
In case of the example in :ref:`Figure: Correct reaction mapping (bottom)<figure_oelibgen_mapping_01_B>`, this means
deleting the isolated chlorine atom.
The default behavior is to keep all components.

:ref:`Figure: Incomplete reaction (top)<figure_oelibgen_mapping_02_A>` shows an example, where not all ring
atoms in the reactants are mapped.
During the product generation, the unmapped atoms on the reactant side are deleted,
while the unmapped atoms on the products side are created.
As a result, ring substitutions are removed from the generated product in all
positions where atom mapping is missing (see generated product and the removed
ring substitution in :ref:`Figure: Incomplete reaction (bottom)<figure_oelibgen_mapping_02_A>`).
The unmapped fragment (CCN) can be automatically removed from the final product
by calling
:oe:meth:`SetRemoveUnmappedFragments<OEChem::OELibraryGen::SetRemoveUnmappedFragments>`
with the boolean value of 'true'.

.. _figure_oelibgen_mapping_02_A:

.. figure:: /_images/OELibGen-mapping-reaction-02-A.png
   :scale:  100
   :align:  center

   **Incomplete reaction**

   *Example of incomplete reaction ring mapping; (top) reaction definition, (bottom) product generation.*

By mapping all ring atoms in the reactants (see :ref:`Figure: Complete reaction (top)<figure_oelibgen_mapping_02_B>`),
all ring substitutions are left intact in the generated product
(see :ref:`Figure: Complete reaction (bottom)<figure_oelibgen_mapping_02_B>`).

.. _figure_oelibgen_mapping_02_B:

.. figure:: /_images/OELibGen-mapping-reaction-02-B.png
   :scale:  100
   :align:  center

   **Complete reaction**

   *Example of complete reaction ring mapping; (top) reaction definition, (bottom) product generation.*

.. _subsection_reactions_libgen_MDL:

MDL Reaction Query File
--------------------------------------------------------------------------------

An MDL reaction query file is comprised of a series of structural data
with various atom and bond query features to define each reactant and
product of a reaction.  Mapping indices on the atom blocks define
which reactant atom becomes which product atom through the reaction.

See section :ref:`section_mdlqueries_features` for the supported MDL query features
in **OEChem TK** and https://discover.3ds.com/ctfile-documentation-request-form
for the MDL reaction file format.

:oe:src:`Listing 7<SNIPPET-ReactionsRXN>` shows an example how to initialize an
:oe:cls:`OELibraryGen<OEChem::OELibraryGen>` object from MDL reaction query.
The reaction defined in the 'amide.rxn' file is shown
:ref:`Figure: MDL query<figure_oelibgen_rxn_reaction>`.

.. oe:source:: ReactionsRXN.cpp
   :language: c++
   :caption:  Library generation using a MDL reaction query
   :refnum:   7
   :frag:     SNIPPET

.. oe:source:: ReactionsRXN.py
   :language: python
   :caption:  Library generation using a MDL reaction query
   :refnum:   7
   :frag:     SNIPPET

.. oe:source:: ReactionsRXN.java
   :language: java
   :caption:  Library generation using a MDL reaction query
   :refnum:   7
   :frag:     SNIPPET

.. oe:source:: ReactionsRXN.cs
   :language: csharp
   :caption:  Library generation using a MDL reaction query
   :refnum:   7
   :frag:     SNIPPET

The output of :oe:src:`Listing 7<SNIPPET-ReactionsRXN>` is the following:

.. code-block:: bash

   Reactant atoms:
    atom: 0 C in component 1 with map index 1
    atom: 1 O in component 1 with map index 0
    atom: 2 O in component 1 with map index 2
    atom: 3 C in component 2 with map index 4
    atom: 4 N in component 2 with map index 3
   Product atoms :
    atom: 5 C in component 3 with map index 1
    atom: 6 N in component 3 with map index 3
    atom: 7 C in component 3 with map index 4
    atom: 8 O in component 3 with map index 2
   product smiles = CC(C)CNC(=O)c1ccccc1

.. index:: OEReadMDLReactionQueryFile

:oe:func:`OEReadMDLReactionQueryFile<OEChem::OEReadMDLReactionQueryFile>` function
reads the MDL reaction query directly into a :oe:cls:`OEQMolBase<OEChem::OEQMolBase>`
object, which then can be used to initialize an
:oe:cls:`OELibraryGen<OEChem::OELibraryGen>` object.

.. oe:source:: ReactionsRXN.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-READREACTION

.. oe:source:: ReactionsRXN.py
   :language: python
   :noindent:
   :frag:     SNIPPET-READREACTION

.. oe:source:: ReactionsRXN.java
   :language: java
   :noindent:
   :frag:     SNIPPET-READREACTION

.. oe:source:: ReactionsRXN.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-READREACTION

The user can iterate over the reactant and product atoms of a reaction using
the :oe:cls:`OEAtomIsInReactant<OEChem::OEAtomIsInReactant>` and the
:oe:cls:`OEAtomIsInProduct<OEChem::OEAtomIsInProduct>` functors, respectively.

.. oe:source:: ReactionsRXN.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-RXN-ATOMS

.. oe:source:: ReactionsRXN.py
   :language: python
   :noindent:
   :frag:     SNIPPET-RXN-ATOMS

.. oe:source:: ReactionsRXN.java
   :language: java
   :noindent:
   :frag:     SNIPPET-RXN-ATOMS

.. oe:source:: ReactionsRXN.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-RXN-ATOMS

.. _figure_oelibgen_rxn_reaction:

.. figure:: /_images/OELibGen-rxn-reaction.png
   :scale:  100
   :align:  center

   **MDL Query**

   *Example of MDL query reaction*

The reaction 'role' property of an atom can also be accessed with the
:oe:meth:`GetRxnRole<OEChem::OEAtomBase::GetRxnRole>` method
of the :oe:cls:`OEAtomBase<OEChem::OEAtomBase>` class.

The :oe:meth:`GetMapIdx<OEChem::OEAtomBase::GetMapIdx>`  method returns the
atom map index read from the reaction file.

.. oe:source:: ReactionsRXN.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-RXN-MAPIDX

.. oe:source:: ReactionsRXN.py
   :language: python
   :noindent:
   :frag:     SNIPPET-RXN-MAPIDX

.. oe:source:: ReactionsRXN.java
   :language: java
   :noindent:
   :frag:     SNIPPET-RXN-MAPIDX

.. oe:source:: ReactionsRXN.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-RXN-MAPIDX

An unmapped atom has a map index zero.
For more information about these functions and the :oe:constns:`OEChem::OERxnRole`
namespace, please refer to the :ref:`oechem_part_api` manual.

Since the explicit hydrogens are suppressed when the reaction is converted
into a query molecule,

.. oe:source:: ReactionsRXN.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-RXN-OPT

.. oe:source:: ReactionsRXN.py
   :language: python
   :noindent:
   :frag:     SNIPPET-RXN-OPT

.. oe:source:: ReactionsRXN.java
   :language: java
   :noindent:
   :frag:     SNIPPET-RXN-OPT

.. oe:source:: ReactionsRXN.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-RXN-OPT

the explicit hydrogens in the starting materials
can also be suppressed, yielding faster performance while still generating the same products.

.. oe:source:: ReactionsRXN.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-RXN-EXPH

.. oe:source:: ReactionsRXN.py
   :language: python
   :noindent:
   :frag:     SNIPPET-RXN-EXPH

.. oe:source:: ReactionsRXN.java
   :language: java
   :noindent:
   :frag:     SNIPPET-RXN-EXPH

.. oe:source:: ReactionsRXN.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-RXN-EXPH

More details on suppressing hydrogens in a query can be found in section
:ref:`section_mdlqueries_hydrogens`.
It is also recommended to set the valence correction mode on.

.. oe:source:: ReactionsRXN.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-RXN-VCORRECT

.. oe:source:: ReactionsRXN.py
   :language: python
   :noindent:
   :frag:     SNIPPET-RXN-VCORRECT

.. oe:source:: ReactionsRXN.java
   :language: java
   :noindent:
   :frag:     SNIPPET-RXN-VCORRECT

.. oe:source:: ReactionsRXN.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-RXN-VCORRECT

.. index:: OEBuildMDLQueryExpressions

The MDL reaction query can also be read into a :oe:cls:`OEMolBase<OEChem::OEMolBase>`
object (see code snippet below).
In this case, the :oe:func:`OEReadMDLReactionQueryFile<OEChem::OEReadMDLReactionQueryFile>`
function attaches the query features present in the input MDL file to the related
atoms and bonds of the :oe:cls:`OEMolBase<OEChem::OEMolBase>` object.
The :oe:cls:`OEQMolBase<OEChem::OEQMolBase>` object can be subsequently created by
calling the :oe:func:`OEBuildMDLQueryExpressions<OEChem::OEBuildMDLQueryExpressions>`
function with :oe:const:`OEChem::OEMDLQueryOpts::ReactionQuery` option.

.. oe:language:: c++

   .. code-block:: c++

      OEGraphMol reaction;
      OEReadMDLReactionQueryFile(rfile,reaction);
      // reaction can be manipulated here
      OEQMol qreaction;
      // build OEQMol with OEMDLQueryOpts::ReactionQuery option
      OEBuildMDLQueryExpressions(qreaction,reaction,OEMDLQueryOpts::ReactionQuery);
      OELibraryGen libgen;
      libgen.Init(qreaction);

.. oe:language:: python

   .. code-block:: python

      reaction = OEGraphMol()
      OEReadMDLReactionQueryFile(rfile,reaction)
      # reaction can be manipulated here
      qreaction = OEQMol()
      # build OEQMol with OEMDLQueryOpts_ReactionQuery option
      OEBuildMDLQueryExpressions(qreaction,reaction,OEMDLQueryOpts_ReactionQuery)
      libgen OELibraryGen()
      libgen.Init(qreaction)

.. oe:language:: java

   .. code-block:: java

      OEGraphMol reaction = new OEGraphMol();
      oechem.OEReadMDLReactionQueryFile(rfile,reaction);
      // reaction can be manipulated here
      OEQMol qreaction = new OEQMol();
      // build OEQMol with OEMDLQueryOpts.ReactionQuery option
      oechem.OEBuildMDLQueryExpressions(qreaction,reaction,OEMDLQueryOpts.ReactionQuery);
      OELibraryGen libgen = new OELibraryGen();
      libgen.Init(qreaction);

.. oe:language:: csharp

   .. code-block:: csharp

      OEGraphMol reaction = new OEGraphMol();
      OEChem.OEReadMDLReactionQueryFile(rfile,reaction);
      // reaction can be manipulated here
      OEQMol qreaction = new OEQMol();
      // build OEQMol with OEMDLQueryOpts.ReactionQuery option
      OEChem.OEBuildMDLQueryExpressions(qreaction,reaction,OEMDLQueryOpts.ReactionQuery);
      OELibraryGen libgen = new OELibraryGen();
      libgen.Init(qreaction);

The declarations of these functions are:

.. oe:language:: c++

   .. code-block:: c++

      bool OEReadMDLReactionQueryFile(oemolistream &ifs, OEMolBase& mol);
      bool OEReadMDLReactionQueryFile(oemolistream &ifs, OEQMolBase& qmol,
                                      unsigned int opts = OEMDLQueryOpts::ReactionQuery);

      bool OEBuildMDLQueryExpressions(OEQMolBase &qmol, const OEMolBase &mol,
                                      unsigned int opts = OEMDLQueryOpts::Default);

.. oe:language:: python

   .. code-block:: python

      OEReadMDLReactionQueryFile(ifs,mol)
      # ifs - oemolistream, mol - OEMolBase
      # returns True or False
      OEReadMDLReactionQueryFile(ifs,qmol,opts)
      # ifs - oemolistream, mol - OEQMolBase,
      # opts - integer ( default value = OEMDLQueryOpts_ReactionQuery )
      # returns True or False
      OEBuildMDLQueryExpressions(qmol,mol,opts)
      # ifs - oemolistream, mol - OEQMolBase,
      # opts - integer ( default value = OEMDLQueryOpts_Default )
      # returns True or False

.. oe:language:: java

   .. code-block:: java

      boolean OEReadMDLReactionQueryFile(oemolistream ifs, OEMolBase mol);
      boolean OEReadMDLQueryFile(oemolistream ifs, OEQMolBase qmol, int opts);
      // opts (default value = OEMDLQueryOpts.ReactionQuery)
      boolean OEBuildMDLQueryExpressions(OEQMolBase qmol, OEMolBase mol, int opts);
      // opts (default value = OEMDLQueryOpts.Default)

.. oe:language:: csharp

   .. code-block:: csharp

      bool OEReadMDLReactionQueryFile(oemolistream ifs, OEMolBase mol);
      bool OEReadMDLQueryFile(oemolistream ifs, OEQMolBase qmol, uint opts);
      // opts (default value = OEMDLQueryOpts.ReactionQuery)
      bool OEBuildMDLQueryExpressions(OEQMolBase qmol, OEMolBase mol, uint opts);
      // opts (default value = OEMDLQueryOpts.Default)

The 'opts' parameter defines how the MDL query is interpreted when
:oe:cls:`OEQMolBase<OEChem::OEQMolBase>` object is constructed.

For more details on the various options in the :oe:constns:`OEChem::OEMDLQueryOpts`
namespace and the MDL query based substructure search, please see chapter
:ref:`chapter_mdlqueries`.

.. _subsection_reactions_libgen_reactH:

Hydrogens on the Reactant Side
--------------------------------------------------------------------------------

When defining a reaction it is very important to consider not only correct atom
mapping but also to anticipate the different kind of starting materials the reactant
pattern(s) will match.

At first glance, the reaction shown in :ref:`Figure: Missing hydrogen (reaction)<figure_oelibgen_missing_hydrogen_reaction>`
seems correct, however some of the generated products have carbon atom with incorrect 5 valences
see example 'A' in :ref:`Figure: Missing hydrogen (products)<figure_oelibgen_missing_hydrogen_example>`.

.. _figure_oelibgen_missing_hydrogen_reaction:

.. figure:: /_images/OELibGen-hydrogen-reaction.png
   :scale:  100
   :align:  center

   **Missing hydrogen (reaction)**

   *Example of missing explicit/implicit hydrogen in reactant (equivalent  SMIRKS: [c:2]1[c:3][c:4][c:5][c:6][c:1]1([C:7](=O)[C:8])>>[c:2]1[c:3][c:4][c:5][c:6][c:1]1([C:7]2[C:8]=CCC(=O)C2)*

.. _figure_oelibgen_missing_hydrogen_example:

.. figure:: /_images/OELibGen-hydrogen-example.png
   :scale:  100
   :align:  center

   **Missing hydrogen (products)**

   *Example of products generated with reaction defined in 'Missing hydrogen (reaction)'*

By adding two explicit (or implicit) hydrogens to the reactant atom with atom map ``8``
in :ref:`Figure: Missing hydrogen (reaction)<figure_oelibgen_missing_hydrogen_reaction>`,
ensures that only reaction 'B'
is executed, since the starting material of reaction 'A' no longer matches the
reaction pattern.

.. note::

   In order to generate products with correct valences, a mapped reactant atom should
   have as many as explicit or implicit hydrogens as many as new bonds the atom
   forms on the product side

.. _subsection_reactions_libgen_kekule:

Product Kekulization
--------------------------------------------------------------------------------

.. index:: OEKekulize, OEAssignAromaticFlags

Prior to returning a generated product, :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` calls
the :oe:func:`OEKekulize<OEChem::OEKekulize>` and
:oe:func:`OEAssignAromaticFlags<OEChem::OEAssignAromaticFlags>` functions to
determine the Kekulé form and aromaticity of the generated product.
Since :oe:func:`OEKekulize<OEChem::OEKekulize>` requires the correct specification
of the formal charges and implicit hydrogen counts of each atom, the Kekulé form of
a generated product depends on the reaction specification.

The three reactions shown in :ref:`figure_oelibgen_arom_reaction` describe the
same set of transformations, but they generate products with different but valid
Kekulé forms.
Reactions 'A' and 'B' in :ref:`figure_oelibgen_arom_reaction` will produce products
'A' and 'B' in  :ref:`figure_oelibgen_arom_example`, respectively.
However, reaction 'C' arbitrarily generates either product 'A' or its tautomer
product 'B', since this reaction describes ambiguous  Kekulé form for the 5-membered
ring in the product.

.. _figure_oelibgen_arom_reaction:

.. figure:: /_images/OELibGen-arom-reaction.png
   :scale:  100
   :align:  center

   **Identical transformations**

   *Three reactions describing the same transformation*

.. _figure_oelibgen_arom_example:

.. figure:: /_images/OELibGen-arom-example.png
   :scale:  100
   :align:  center

   **Products**

   *Example of products generated with reactions defined in 'Identical transformations'*

.. note::

   In order to generate products with the desired Kekulé form, either the product
   has to have only specific bonds or explicit/implicit hydrogens have to be
   specified to eliminate ambiguities.

Even though the reaction in :ref:`figure_oelibgen_arom_reaction_2` defines an
unambiguous Kekulé form, this form is not suited for every product generated by
the reaction (see examples in :ref:`figure_oelibgen_arom_example_2`).
In order to ensure that the :oe:cls:`OELibraryGen<OEChem::OELibraryGen>` generates
products with valid Kekulé form the following steps are performed.
First, Kekulization is performed based on the reaction specification.
If it is unsuccessful, *i.e.* :oe:func:`OEKekulize<OEChem::OEKekulize>` function
returns false, alternatives are tried by adding and removing implicit hydrogens
from aromatic nitrogens, until a valid Kekulé form is found.

.. _figure_oelibgen_arom_reaction_2:

.. figure:: /_images/OELibGen-arom-reaction-2.png
   :scale:  100
   :align:  center

   **Reaction**

   *Example of reaction with generic atoms in an aromatic ring system (``s*`` = number of non-hydrogen substituents as drawn).*

.. _figure_oelibgen_arom_example_2:

.. figure:: /_images/OELibGen-arom-example-2.png
   :scale:  100
   :align:  center

   **Products**

   *Example of products generated with the reaction shown in previous figure*



.. _chapter_receptor_oechem:

.. meta::
   :keywords: chapter_receptor


********************************************************************************
Receptors
********************************************************************************

In receptor objects contain information about the location and characteristics 
of the binding pocket, and required for docking (see :ref:`chapter_docking`),
posit (see :ref:`chapter_posit`), and scoring (see :ref:`chapter_scoring`).

A receptor is an :ref:`OEReceptor <OEBio_OEReceptor>` object that resides within a
:ref:`OEDesignUnit <OEBio_OEDesignUnit>`. The essential component of a valid receptor is
the negative image that describes the shape of the active site.

Creating a Receptor
================================================================================

Within the Docking toolkit the :oe:func:`OEDocking::OEMakeReceptor` function
is used to create a receptor from the structure of a target protein containing
in a :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.

The protein structure should only include molecules the ligand is expected to
interact with.  In general crystallographic waters, other solvents and the bound
ligand should be not be included as part of the target protein structure passed to the
:oe:func:`OEDocking::OEMakeReceptor` function, although in certain cases, the
user may wish to retain certain key molecules as part of the target protein
structure (*e.g.* a crystallographic water).


Contents of a Receptor
================================================================================

Negative Image
--------------------------------------------------------------------------------

The negative image describes the shape of the active site.  It is stored as a
potential grid surrounding the active site.  Potential values are always greater
than or equal to zero.  The negative image has high potentials where ligand
atoms make many contacts with atoms of the active site without clashing and
in positions some ligand atoms are likely to occupy when other atoms of the
ligand make good contacts with the receptor (*e.g.* bridging positions ligand
atoms will likely occupy when a ligand is stretched between two pockets).

During docking two shapes are created by contouring the negative image
potential grid.  The two shapes control the docking process as follows:

*Outer Contour* Shape

   During docking any pose examined by the exhaustive search that does not fit
   within this shape will be rejected.  A pose is considered to fit if the
   center of every heavy atom is within this shape.  The volume of this shape
   is typically between 500 and 2000 cubic Angstroms.

*Inner Contour* Shape

   During docking any pose examined by the exhaustive search that does not
   touch this shape is rejected.  A pose is considered to touch if the center
   of at least one heavy atom falls within this shape.  The volume of this
   shape is typically 50 to 100 cubic angstroms.

While neither the *outer contour* nor the *inner contour* shape are required, it is
recommended that the *outer contour* always be used (docking speed will be
dramatically slower without the *outer contour*).  Using the *inner contour*
improves docking speed slightly at the expense of sampling. However, if the 
*inner contour* size is nearly as large as the *outer contour*, there will be 
little to no difference in compute time.

The negative image of the receptor is set up when the receptor is created
with the :oe:func:`OEDocking::OEMakeReceptor` function (see
the section on creating a receptor).  The size of the *outer contour*
and *inner contour* shapes are controllable by setting the contour level
used to create the shape from the negative image.  The
:oe:func:`OEDocking::OEMakeReceptor` function will automatically set a
reasonable contour level for both the *inner contour* and *outer contour*,
however the *inner contour* will be disabled by setting the value
to be negative (see below).

The negative image grid has only positive values, thus only contour levels
that are positive create a shape.  When either the *outer contour* level
or *inner contour* level are negative that contour shape will be disabled
(*i.e.* ignored during the docking process).  

The volume of the *outer contour* shape has a significant effect on docking
speed, while the volume of the *inner contour* shape has a modest effect on
docking speed.  In both cases the smaller volumes increase docking speed by
reducing the number of poses that are scored.  In general an outer and inner
contour volume of between 500-2000 and 50-100 cubic Angstroms respectively is
recommended.

Constraints
--------------------------------------------------------------------------------

Constraints are key interactions ligands are required to make when docking into
the active site.  They are optional and user defined.

Constraints do not affect how a given pose scores, however they do affect how
the docking algorithm chooses poses to score during the docking process.  Any
pose that does not match the docking constraints will be rejected and replaced
by the next best scoring pose.  If no poses of a ligand match the docking
constraints the ligand will not be docked.  If multiple constraints are
specified every constraint must be satisfied or the pose will be rejected.

.. note::

   The docking process has a resolution
   of approximately 1 Ångström, and thus the constraints have a similar resolution.
   Therefore it is possible that poses docked with a constraint may have small
   violations of the constraint distance, up to approximately 1 Ångström.

Receptors support two general classes of constraints; protein constraints and
custom constraints.  There may be any number of either class of constraint.

.. note::

   Each individual custom or protein constraint has an enabled flag.  A disabled
   constraint is ignored during the docking process.

Protein Constraints
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A protein constraint specifies an interaction that must be made with a
**heavy atom** of the protein structure (*i.e.* protein constraints cannot be
placed on hydrogen atoms).  There are five types of protein
constraints.

**Contact**

    A contact constraint is satisfied when any ligand heavy atom is within
    4 angstroms of the protein heavy atom.

**Lipophilic**

    A lipophilic constraint is satisfied when any non-polar heavy atom on
    the ligand is within 4 angstroms of the protein heavy atom.

**Donor**

    A donor constraint is satisfied when a *donor on the ligand* makes a
    hydrogen bond interaction with the protein heavy atom.

**Acceptor**

    An acceptor constraint is satisfied when an *acceptor on the ligand* makes
    a hydrogen bond interaction with the protein heavy atom.  Acceptor
    constraints must be placed on the protein heavy atom the donor hydrogen is
    interacting with.

**Chelator**

    A chelator constraint is satisfied when a *chelator on the ligand* makes
    a metal-chelator interaction with the protein heavy atom.

Only one protein constraint is allowed per protein heavy atom.  If a protein
constraint is set on a protein atom that already has a protein constraint the
original protein constraint will be discarded and replaced by the new
constraint.

Custom Constraints
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A custom constraint consists of one or more spheres within the receptor active
site, and optionally a list of SMARTS patterns.  A custom constraint is satisfied
when a matching atom on the ligand falls within any of the spheres associated
with the custom constraint.  If no SMARTS patterns are specified any heavy atom
on the ligand can satisfy the constraint, otherwise only atoms that match one
of the smarts patterns can satisfy the constraint.



.. _oechem_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version5_0_0
   version4_3_0
   version4_2_0
   version4_1_1
   version4_1_0
   version4_0_0
   version3_4_0
   version3_3_1
   version3_3_0
   version3_2_0
   version3_1_1
   version3_1_0
   version3_0_0
   version2_3_0
   version2_2_0
   version2_1_5
   version2_1_4
   version2_1_3
   version2_1_2
   version2_1_1
   version2_1_0
   version2_0_7
   version2_0_6
   version2_0_5
   version2_0_4
   version2_0_3
   version2_0_2
   version2_0_1
   version2_0_0
   version1_9_3
   version1_9_2
   version1_9_1
   version1_9_0
   version1_8_0
   version1_7_7
   version1_7_6
   version1_7_5
   version1_7_4
   version1_7_3
   version1_7_2
   version1_7_1
   version1_7_0
   version1_6_1
   version1_6_0
   version1_5_1
   version1_5_0
   version1_4_2
   version1_4_1
   version1_4_0
   version1_3_4
   version1_3_3
   version1_3_2
   version1_3_1
   version1_3_0



OEChem TK 5.0.0
================================================================================

New Features
--------------------------------------------------------------------------------

* The following preliminary APIs have been added for monomer, HELM, and peptide
  support.

  **Classes:**

  * :oe:cls:`OEChem::OEMonomer` — represents a monomer in a monomer set.
  * :oe:cls:`OEChem::OEMonomerData` — stores the definition of a monomer.
  * :oe:cls:`OEChem::OEMonomerSet` — a collection of monomers.
  * :oe:cls:`OEChem::OEMonomerValidationResult` — stores the result of monomer data validation.
  * :oe:cls:`OEChem::OEHelmParsingResult` — stores the result of HELM parsing.
  * :oe:cls:`OEChem::OEHelmGenerationResult` — stores the result of HELM generation.
  * :oe:cls:`OEChem::OEHelmGenerationOptions` — gives options for HELM generation.

  **Predicates:**

  * :oe:cls:`OEChem::OEIsInMonomerCodeSet` — filters monomers by code set.
  * :oe:cls:`OEChem::OEHasPolymerType` — filters monomers by polymer type.
  * :oe:cls:`OEChem::OEHasMonomerType` — filters monomers by monomer type.
  * :oe:cls:`OEChem::OEHasAminoAcidType` — filters monomers by amino acid type.
  * :oe:cls:`OEChem::OEIsMonomerGroup` — identifies groups that store monomer information.
  * :oe:cls:`OEChem::OEHasMonomerGroup` — identifies groups that match a monomer group by code set and code.

  **Constants:**

  * :oe:constns:`OEChem::OEAminoAcidType` — amino acid type constants.
  * :oe:constns:`OEChem::OEPolymerType` — polymer type constants.
  * :oe:constns:`OEChem::OEMonomerType` — monomer type constants.
  * :oe:constns:`OEChem::OEMonomerValidationReturnCode` — monomer validation return codes.
  * :oe:constns:`OEChem::OEHelmParsingReturnCode` — HELM parsing return codes.
  * :oe:constns:`OEChem::OEHelmGenerationReturnCode` — HELM generation return codes.
  * :oe:const:`OEChem::OEGroupType::Monomer` — monomer group type constant.
  * :oe:const:`OEChem::OEProperty::Monomer` — monomer property type constant.

  **Monomer data and validation functions:**

  * :oe:func:`OEChem::OEIsValidMonomerData`
  * :oe:func:`OEChem::OEAminoAcidTypeToString`
  * :oe:func:`OEChem::OEPolymerTypeToString`
  * :oe:func:`OEChem::OEStringToPolymerType`
  * :oe:func:`OEChem::OEMonomerTypeToString`
  * :oe:func:`OEChem::OEStringToMonomerType`

  **Monomer set I/O functions:**

  * :oe:func:`OEChem::OEReadMonomerSet`
  * :oe:func:`OEChem::OEWriteMonomerSet`
  * :oe:func:`OEChem::OELoadStandardMonomerSet`
  * :oe:func:`OEChem::OELoadOpenEyeMonomerSet`

  **Monomer perception and detection functions:**

  * :oe:func:`OEChem::OEDetectMonomers`
  * :oe:func:`OEChem::OEGetPolymerType`
  * :oe:func:`OEChem::OEGetMonomerType`
  * :oe:func:`OEChem::OEGetAminoAcidType`
  * :oe:func:`OEChem::OEIsStandardMonomer`
  * :oe:func:`OEChem::OEGetStandardAnalog`
  * :oe:func:`OEChem::OECreatePeptideMonomerConnectionSmiles`
  * :oe:func:`OEChem::OEMonomerConnectionSmilesFromCXSmiles`
  * :oe:func:`OEChem::OEPerceivePeptideMonomerConnections`

  **HELM functions:**

  * :oe:func:`OEChem::OEHelmToMol`
  * :oe:func:`OEChem::OEMolToHelm`
  * :oe:func:`OEChem::OEGetHelmChainNames`
  * :oe:func:`OEChem::OEGetHelmMonomerCodes`

  **Peptide perception functions:**

  * :oe:func:`OEChem::OEIsPeptide`
  * :oe:func:`OEChem::OEPerceivePeptideBackbone`

* A new function, :oe:func:`OEChem::OEHasRadii`, has been added to check if
  a molecule has radii assigned to all atoms. The function takes an optional 
  boolean argument ``all`` (default: ``true``) to specify whether to check 
  for radii on every atom or whether to return early on the first atom without radii.

* More :oe:constns:`OEChem::OEIFlavor` constants have been added for better control of perception steps when reading mmCIF files.

Minor Bug Fixes
--------------------------------------------------------------------------------

* When generating a substructure search database with :oe:func:`OEChem::OECreateSubSearchDatabaseFile`,
  molecules with high graph complexity (such as https://www.rcsb.org/ligand/ZRW) are now
  skipped since they are unlikely to be useful for substructure searching and can cause 
  significant performance degradation during database generation.

* The stack size of threads used in the :oe:func:`OEChem::OECreateSubSearchDatabaseFile`
  function have been increased to avoid memory allocation issues when processing :file:`.oeb` files with large number of
  generic data.

* An issue has been fixed in :oe:func:`OEBio::OEGetTorsion` where residue perception was called
  on a const atom changing the underlying perception state of the molecule.
  The function now correctly returns an invalid value when the residue is not already perceived
  with a warning to perceive it.

Python-Specific Changes
--------------------------------------------------------------------------------

* The :oe:meth:`OEChem::OEMolBase::NewGroup` method raises :py:class:`TypeError` if
  invoked with an invalid argument type.

* The hashing function for OEResidue has been updated to work with 
  multicharacter chain IDs.

OEBio TK
================================================================================

New Features
--------------------------------------------------------------------------------

* The following preliminary APIs have been added to serializing and deserializing
  interaction hints into :file:`.oeb` files.

  * :oe:func:`OEBio::OEConstructInteractionHintContainer`
  * :oe:func:`OEBio::OEDeleteInteractionsHintSerializationData`
  * :oe:func:`OEBio::OEDeleteInteractionsHintSerializationIds`
  * :oe:func:`OEBio::OEHasInteractionHintSerializationIds`
  * :oe:func:`OEBio::OEHasInteractionsHintSerializationData`
  * :oe:func:`OEBio::OESerializeInteractionsHintContainer`
  * :oe:func:`OEBio::OESetInteractionsHintSerializationIds`

* The serialization API for interaction hints now supports
  :ref:`OEDesignUnit <OEBio_OEDesignUnit>` directly. The following functions
  have new overloads accepting an :oe:cls:`OEBio::OEDesignUnit`:

  * :oe:func:`OEBio::OEConstructInteractionHintContainer`
  * :oe:func:`OEBio::OEDeleteInteractionsHintSerializationData`
  * :oe:func:`OEBio::OEDeleteInteractionsHintSerializationIds`
  * :oe:func:`OEBio::OEHasInteractionsHintSerializationData`
  * :oe:func:`OEBio::OESetInteractionsHintSerializationIds`

* The :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class
  now supports a new :ref:`constructor overload <OEBio_OEInteractionHintContainer_Constructors>` that accepts an
  :oe:cls:`OEBio::OEDesignUnit`, assembling the receptor from the design unit
  components and the ligand (if present) automatically.

* Intramolecular interaction perception is now supported for a single component
  (either ligand or protein) by passing an empty molecule for the other
  component to the
  :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>`
  constructor. For example, passing an empty molecule as the ligand argument
  will perceive only intramolecular interactions within the protein, and
  vice versa. This also applies when using the
  :oe:cls:`OEBio::OEDesignUnit` constructor overload: if a design unit has
  site residues but no ligand, intramolecular receptor interactions are
  perceived automatically.

* The following new predicates have been added for finer-grained filtering of
  interaction hints:

  * :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>`
    identifies clashing hydrogen bond interactions (i.e.,
    :oe:const:`OEBio::OEHBondInteractionHintType::ClashAcceptorAcceptor` and
    :oe:const:`OEBio::OEHBondInteractionHintType::ClashDonorDonor` types).

  * :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>`
    identifies all unpaired interactions, including unpaired hydrogen bond
    donors/acceptors and unpaired salt-bridge charges.

  * :ref:`OEIsIntermolecularSaltBridgeInteractionHint <OEBio_OEIsIntermolecularSaltBridgeInteractionHint>`
    identifies intermolecular (ligand-protein) salt-bridge interactions.

  * :ref:`OEIsIntramolecularSaltBridgeInteractionHint <OEBio_OEIsIntramolecularSaltBridgeInteractionHint>`
    identifies intramolecular salt-bridge interactions within the ligand or protein.

  * :ref:`OEIsIntermolecularStackingInteractionHint <OEBio_OEIsIntermolecularStackingInteractionHint>`
    identifies intermolecular (ligand-protein) pi- and T-stacking interactions.

  * :ref:`OEIsIntramolecularStackingInteractionHint <OEBio_OEIsIntramolecularStackingInteractionHint>`
    identifies intramolecular pi- and T-stacking interactions within the ligand
    or protein.

  * :ref:`OEIsIntermolecularCationPiInteractionHint <OEBio_OEIsIntermolecularCationPiInteractionHint>`
    identifies intermolecular (ligand-protein) cation-pi interactions.

  * :ref:`OEIsIntramolecularCationPiInteractionHint <OEBio_OEIsIntramolecularCationPiInteractionHint>`
    identifies intramolecular cation-pi interactions within the ligand or protein.

  * :ref:`OEIsIntermolecularHalogenBondInteractionHint <OEBio_OEIsIntermolecularHalogenBondInteractionHint>`
    identifies intermolecular (ligand-protein) halogen bond interactions.

  * :ref:`OEIsIntramolecularHalogenBondInteractionHint <OEBio_OEIsIntramolecularHalogenBondInteractionHint>`
    identifies intramolecular halogen bond interactions within the ligand or protein.

* Intramolecular stacking and cation-pi interactions are now perceived and
  reported. The following new type constants have been added:

  * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularLigandPi`
  * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularLigandT`
  * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularProteinPi`
  * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularProteinT`
  * :oe:const:`OEBio::OECationPiInteractionHintType::IntramolecularLigand`
  * :oe:const:`OEBio::OECationPiInteractionHintType::IntramolecularProtein`

* A new option has been added to
  :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` to
  control the minimum stack offset required for a pi-stacking or T-stacking
  interaction to be reported:

  * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinStackOffset` /
    :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMinStackOffset`

  The stack offset is defined as
  :math:`\max(|\hat{c}\cdot\hat{n}_1|, |\hat{c}\cdot\hat{n}_2|)`, where
  :math:`\hat{c}` is the unit vector between the ring centers and
  :math:`\hat{n}_1` and :math:`\hat{n}_2` are the ring plane normals.
  This filter ensures that one ring sits above or below the other (i.e., a
  genuinely stacked arrangement) rather than side by side in the same plane.
  The default value is **0.5**.

* The following existing predicates have been updated to accept optional
  parameters that control whether intramolecular interactions and nonideal
  interactions are included in their results. All parameters default to ``True``
  to preserve backward-compatible behavior where interactions were previously
  returned without distinction:

  * :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` —
    new constructor ``OEIsHBondInteractionHint(bool includeIntra = true, bool includeNonIdeal = true)``

  * :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>` —
    new constructor ``OEIsIntermolecularHBondInteractionHint(bool includeNonIdeal = true)``

  * :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>` —
    new constructor ``OEIsIntramolecularHBondInteractionHint(bool includeNonIdeal = true)``

  * :ref:`OEIsChelatorInteractionHint <OEBio_OEIsChelatorInteractionHint>` —
    new constructor ``OEIsChelatorInteractionHint(bool includeIntra = true)``

  * :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>` —
    new constructor ``OEIsSaltBridgeInteractionHint(bool includeIntra = true)``

  * :ref:`OEIsStackingInteractionHint <OEBio_OEIsStackingInteractionHint>` —
    new constructor ``OEIsStackingInteractionHint(bool includeIntra = true)``

  * :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>` —
    new constructor ``OEIsCationPiInteractionHint(bool includeIntra = true)``

  * :ref:`OEIsHalogenBondInteractionHint <OEBio_OEIsHalogenBondInteractionHint>` —
    new constructor ``OEIsHalogenBondInteractionHint(bool includeIntra = true)``

* :ref:`OEDesignUnit <OEBio_OEDesignUnit>` now supports an additional
  ``SetSiteResidues`` overload that accepts
  ``std::vector<OEChem::OEResidue>``. The method validates that residues are
  present in the target, supports ligand coverage checks through ``threshold``
  and ``addBox``, supports optional component reassignment through
  ``rearrangeComponents``, and updates site-associated cofactors through
  ``siteSize``.

* A new overload to the function :oe:func:`OEChem::OEAssignRadii` that operates on
  :oe:cls:`OEBio::OEDesignUnit` has been added. The function
  takes a mask argument and radii types to assign specific radii to specified components.

* The :oe:cls:`OEBio::OEDesignUnit` now tracks the bond order of covalent bonds between components.

* The dictionaries used in :oe:cls:`OEBio::OEResidueCategoryData` have been updated.
  Specifically, `GCP` has been added as a cofactor. In addition, polymers were reclassified
  based on how often they appear as a standalone in the wwPDB, so they can be targeted as ligands, or,
  if they appear frequently as part of larger complexes, they can be treated as cofactors. 

Major Bug Fixes
--------------------------------------------------------------------------------

* An issue has been fixed where using :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>`
  with the :oe:const:`OEBio::OEAltLocFactOption::TrustInputBonds` option
  could lead to incorrect perception of formal charges for atoms that had an atom with 
  multiple alternative locations bonded to it instead of proper reassignment of the implicit
  hydrogen count first.

* The :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` predicate
  previously returned ``true`` for clashing hydrogen bond interactions
  (:oe:const:`OEBio::OEHBondInteractionHintType::ClashAcceptorAcceptor` and
  :oe:const:`OEBio::OEHBondInteractionHintType::ClashDonorDonor`) and for
  unpaired hydrogen bond interactions
  (:oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandDonor`,
  :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandAcceptor`,
  :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinDonor`, and
  :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinAcceptor`).
  These interaction types are now **excluded** from
  :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>`, as they
  represent geometrically unfavorable or unpaired contacts rather than genuine
  hydrogen bonds. Use the new
  :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>`
  predicate to retrieve clashing interactions, and the new
  :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>` predicate
  for unpaired interactions (note: ``OEIsUnpairedInteractionHint`` also returns
  unpaired salt-bridge interactions).

* Similarly, :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>`
  no longer includes clashing types, and
  :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>`
  no longer includes unpaired types.

* The directionality of intramolecular hydrogen bond, salt bridge, and chelator interactions
  has been corrected:

  * Intramolecular hydrogen bond interactions now consistently
    report the donor as the begin fragment and the acceptor as the end fragment.
  * Intramolecular salt bridge interactions now consistently report the positive
    charge as the begin fragment and the negative charge as the end fragment.
  * Intramolecular chelator interactions now consistently report the metal as the
    begin fragment and the chelating atom as the end fragment.

* The :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxAtomPairDistance` has been updated
  to also include the MaxUnpairedDistance in the calculation of the maximum atom pair distance.

Minor Bug Fixes
--------------------------------------------------------------------------------

* :oe:func:`OEBio::OEGetActiveSiteInteractionHintTypes` no longer returns duplicate
  interaction hint types.

* An issue has been fixed where incorrect perception of stacking interactions would occur.
  The new feature mentioned above fixes this issue with an option to control the minimum stack offset
  required for a pi-stacking or T-stacking.

* An issue has been fixed where chelators were incorrectly perceived because of a missing angular term.

* An issue has been fixed where halogen interactions were incorrectly perceived because of a missing angular term.

* An issue has been fixed where, in the :oe:cls:`OEBio::OEIsCTerminalAtom` and :oe:cls:`OEBio::OEIsNTerminalAtom`
  methods, incorrect terminal atom identification could occur for nonstandard amino acid residues.

Python-Specific Changes
--------------------------------------------------------------------------------

* Python wrapping of :oe:meth:`OEBio::OEInteractionHintContainer::GetMolecules` methods has been fixed.




********************************************************************************
Version 1.3.0
********************************************************************************

OEChem 1.3.0
================================================================================

New Features
--------------------------------------------------------------------------------

*  Added reaction parsing and processing including: :ref:`OELibraryGen <OEChem_OELibraryGen>`
   class for generating combinatorial libraries; :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>`
   class primarily for applying normalizations; :oe:func:`OEChem::OEParseSmirks` function
   for converting Daylight's SMIRKS format to an :ref:`OEQMolBase <OEChem_OEQMolBase>`; and
   :oe:func:`OEChem::OEReadRxnFile` that takes an :ref:`OEMolBase <OEChem_OEMolBase>` for reading MDL's rxn
   files.

*  Added :ref:`OEVectorBindings <OEChem_OEVectorBindings>` class to handle SMARTS vector bindings.

*  Added ChemDraw CDX reader and writer functions.

*  Added ability to perceive symmetry classes useful for automorphism
   detection.

*  Added factory methods for allocating molecules.  Implemented
   :ref:`OEGraphMol <OEChem_OEGraphMol>`, :ref:`OEMol <OEChem_OEMol>` and :ref:`OEQMol <OEChem_OEQMol>` in
   terms of the factory methods.

*  Added ``int`` and ``float`` grid handlers to :ref:`OEBinaryIOHandler <OESystem_OEBinaryIOHandler>`.

*  Added :oe:func:`OEChem::OEDisassembleExpressions` function which converts query
   expressions into data directly on atoms/bonds.

*  Added OEMiniMol -- a small memory footprint molecule
   useful for in-memory graph searching.

*  Added utility functors :ref:`OEUnaryToBinaryAnd <OEChem_OEUnaryToBinaryAnd>` and
   :ref:`OEUnaryToBinaryOr <OEChem_OEUnaryToBinaryOr>` that turn a unary functor into a binary 'or' or
   'and' functor.

*  Add default 64 bit file support on Linux.

*  Added functions to set and get comment on molecules.  These comments
   are written to the appropriate fields of .sdf, ``.mol2`` and ``.oeb`` file formats.

*  New function :oe:func:`OEChem::OEMDLStereoFromParity` that sets the *OEChem*
   stereochemistry of each atom from the MDL stereo parity flag stored in
   generic data.

Improvements and Optimizations
--------------------------------------------------------------------------------

*  Performance enhancement to :oe:func:`OEChem::OESetDistance`.

*  Modified the implementation of the :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`
   member function :oe:meth:`SetActive<OEChem::OEMCMolBase::SetActive>` for
   significant performance gains in binary i/o.

*  Optimization of copy construction of :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`.

*  Added warning when :ref:`oemolistream <OEChem_oemolistream>` and :ref:`oemolostream <OEChem_oemolostream>`
   fail to allocate a :ref:`oeogzstream <OEPlatform_oeogzstream>` or :ref:`oeigzstream <OEPlatform_oeigzstream>` .

*  Made :ref:`OEMol <OEChem_OEMol>` and :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`
   contain a separate dimensionality (*e.g.* - the value returned by
   :oe:meth:`OEChem::OEMolBase::GetDimension`) for each conformer rather than
   a single value for the molecule.  This allows depictions and conformers to be stored
   on the same molecules and still be handled correctly by the .sd writers.

*  Numerous improvements/enhancements to *OEChem*'s PDB file reader.  The
   list of exceptional residue names has been updated to match the May 2004
   list of public PDB files from RCSB.

*  The MDL mol file reader is tweaked to record unrecognized atomic
   symbols (just like we do for 3-letter superatom codes) storing them in the
   atom's name property/field.

*  The routine :oe:func:`OEChem::OEMDLPerceiveParity` (and thereby the MDL mol file
   writer) is improved to record chiral centers that don't have stereo
   specified as the MDL parity value 3 (unspecified chiral center).

*  Improved performance for :ref:`OEMolBase <OEChem_OEMolBase>` member functions
   :oe:meth:`OEChem::OEMolBase::GetAtom`,
   :oe:meth:`OEChem::OEMolBase::GetBond` and
   :oe:meth:`OEChem::OEMolBase::Sweep`.

*  All parity values were being stored for atoms (including value == 0)
   which was unnecessary, and was consuming both memory and space on disk in the
   form of OEB files.

*  Added call to seed random number generator from the clock in
   :oe:func:`OEChem::OERandomizeTorsions`.

*  Added more ``float`` multi-grid handlers to be initialized by default.

*  A warning message was added to the SMARTS parser to alert users in cases
   of attempted assignment of map index to zero.

*  Moved implementation of :ref:`OEInSamePart <OEChem_OEInSamePart>` to a template class so
   that parts can be tested for bonds (and other objects) as well atoms.

*  Extended to :ref:`OEIsRotor <OEChem_OEIsRotor>` constructor to allow the option of hydrogen
   rotors.

*  Created and exposed :oe:func:`OEChem::OEMDLStereoFromBondStereo` function from
   previously internal code.

Major bug fixes
--------------------------------------------------------------------------------

*  Fixed bug in :oe:func:`OEChem::OECalcCartesianCoord` when rotating around the y
   axis.  Prior implementation would give wildly incorrect results.

*  Removed dangerous allocation of too small a temporary array for use
   in writing conformer coordinates to OEBinary files.

*  Fixed bug in ``.mol2`` file format reader that resulted in connection
   tables occasionally being skipped when reading files from stdin, pipes
   and/or sockets.  The :oe:func:`OEChem::OEReadMol2File` function no longer requires the
   use of tell and seek on its input stream.

*  Modified the heuristic in :oe:func:`OEChem::OERMSD` for recognizing and dealing with
   degenerate roots.  When the heuristic fails, inappropriate rotation matrices
   were generated.

*  Fixed bug in :oe:func:`OEChem::OESet3DHydrogenGeom` where ``memcmp`` was comparing
   coordinates of type ``double``, but using ``sizeof(float)``, so only a
   partial comparison was being carried out.

*  Modifications which provide the ability to read OEBinary v2 files which
   contain unrecognized data, without losing the data.

*  Added 1 byte at the end of OEMolCT record for molecules with >255 &&
   <65536 bonds to store the endianness of short integers which are used to store
   bond records.  The extra byte won't break old format readers, although oeb
   files written with old version writers won't be portable.  This change doesn't
   break anything either direction, but does allow for portability of oeb files.

Minor bug fixes
--------------------------------------------------------------------------------

*  OEB files now properly store and read conformer energy.

*  Fixed bug that prevented OEB's large molecules (>255 atoms) from
   being cross platform.

*  Reading and writing molecules in OEB format no longer fails if a
   string of 0 length has been tagged to the molecules generic data.

*  Fixed bug in :oe:meth:`OEChem::OEMolBase::Sweep` to ensure that atoms/bonds are
   reindexed sequentially even if there have been no deletions.

*  Fixed bug in :oe:func:`OEChem::OEParseSmiles` that incorrectly parsed atom map
   indices.

*  Fixed bug that :oe:meth:`OEChem::OEAtomBase::SetStereo` was returning ``false``
   even when the stereo was set correctly.

*  Fixed a bug in the copy constructor of OEMolTmplt that was only apparent
   for OEDBMol`s.

*  Bug fixes to MDL superatom expansion to avoid problems with the order
   in which superatoms expanded.

*  Fixed the return value of the :oe:meth:`DeleteAtom<OEChem::OEMolBase::DeleteAtom>`
   and :oe:meth:`DeleteBond<OEChem::OEMolBase::DeleteBond>`
   member functions of :oe:cls:`OEMolBase<OEChem::OEMolBase>` and ``OEMol``.
   The behavior of these functions was not changed.

*  Added missing :oe:meth:`IsDeleted(OEAtomBase*)<OEChem::OEMolBase::IsDeleted>` and
   :oe:meth:`IsDeleted(OEBondBase*)<OEChem::OEMolBase::IsDeleted>` methods to
   :ref:`OEMolBase <OEChem_OEMolBase>`.

*  Fixed API misspelling of :oe:func:`OEChem::OESuppressHydrogens`

*  Fixed :oe:func:`OEChem::OEAddExplicitHydrogens` to return bool rather than void
   to reflect its failures.

*  Fixed :oe:func:`OEChem::OESet3DHydrogenGeom` to return an appropriate boolean
   value rather than always returning true.

*  In  ``bool``  :oe:func:`OEChem::OERMSD` ``(const OEMolBase&, const OEMCMolBase&, double
   *rmsdArray, const OEMatchBase &match, bool overlay = false, double *rot =
   0, double *trans = 0)`` fixed bug that the first conformer of the
   :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` was used repeatedly rather than using
   each conformer in succession.

.. oe:language:: c++

   *  Fixed behavior of :oe:meth:`OEChem::oemolostream::GetString` when the stream is
      wrapping a :ref:`oeogzstream <OEPlatform_oeogzstream>`.

*  Corrected behavior of :oe:func:`OEChem::OESubsetMol` in the case when a
   ring bond it the only item removed from the original molecule.

*  Fixed a bug in *OEChem*'s default :ref:`OEAtomBase <OEChem_OEAtomBase>` implementation that
   caused problems for an atom after 65536 neighboring bonds had been deleted.
   This occurred in codes repeatedly created temporary bonds then deleted them
   without calling :oe:meth:`OEChem::OEAtomBase::Sweep`.

*  Fixes to atom naming bugs in *OEChem*'s peptide reside perception
   routines.  Also adds support for the PTR residue, representing
   phosphotyrosine.  Additional fixes to tie splitting of C-terminal serine
   residues.  Use `` H' `` to name C-terminal aldehyde hydrogens (`` H  `` denotes
   the backbone amide nitrogen's hydrogen).

*  Changed :oe:meth:`OEChem::OEFuzzy::operator!=` and
   :oe:meth:`OEChem::OEFuzzy::operator==` to return bool instead
   of :ref:`OEFuzzy <OEChem_OEFuzzy>`.

*  Removed overloaded `OEChem::OEMatch::operator new` as it was incompatible
   with some versions of STL.

OESystem 1.3.0
================================================================================

New Features
--------------------------------------------------------------------------------

*  Added two functions `OESystem::OEFizzGrid::GetFloatsSet` and
   `OESystem::OEFizzGrid::GetIntegersSet` to determine if the floats and integers
   are set for this grid.

*  Added the new functions :oe:meth:`OESystem::OEBitVector::SetRangeOn` and
   :oe:meth:`OESystem::OEBitVector::SetRangeOff` to :ref:`OEBitVector <OESystem_OEBitVector>`.

*  Classes to handle grid I/O in OEB files.

*  Add default 64 bit file support on Linux.

*  Added :oe:meth:`OESystem::OEIter::Sort` member function to
   iterators.  This allows arbitrary sorting of the order in which objects
   come out of any :ref:`OEIter <OESystem_OEIter>`.

*  Added two functions: :oe:func:`OESystem::OEFileExtension` and
   :oe:func:`OESystem::OEFileExtensions`
   which return a string containing the specified filenames file extension or list
   of extensions respectively.

Improvements and Optimizations
--------------------------------------------------------------------------------

*  :oe:func:`OESystem::OECheckHelp` now also checks for ``--help defaults``, which
   will list the default arguments of all parameters.

*  Added a new function for configuring :ref:`OEInterface <OESystem_OEInterface>` which takes
   an ``unsigned char*`` rather than a ``char*``.

*  The :oe:func:`OESystem::OEWriteSettings` function now defaults to using OEERR rather
   than OEOUT.

*  Added the non-virtual function :oe:meth:`OESystem::OEUnaryPredicate::CreatePredicateCopy`
   to the :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>` and :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>`
   base classes which allow users to use this virtual constructor method without
   unnecessary casts.

Major bug fixes
--------------------------------------------------------------------------------

*  Fixed the previously broken :oe:meth:`OESystem::OEBitVector::FirstBit`,
   :oe:meth:`OESystem::OEBitVector::LastBit`, :oe:meth:`OESystem::OEBitVector::NextBit`,
   and :oe:meth:`OESystem::OEBitVector::PrevBit` functions.

*  Fixed OEBinary writer bug where atom types were being written as atom names.

*  Added handling for unknown data in OEB files for lossless data conversion
   even when older software versions are unable to parse data.

Minor bug fixes
--------------------------------------------------------------------------------

*  Removed a bug where `OESystem::OEFizzGrid::IsDataType` calls
   :oe:meth:`OESystem::OEBase::IsDataType` as well

*  Fixed a bug in OEConcatIter that would cause the iterator to appear
   to have only part of its contents of two empty iterators were pushed back
   onto the concat iterator.

*  OEB read and write functions now return with meaningful values
   (previously the writers always returned false regardless and the readers
   always returned success regardless).

*  Fixed problem with some interface parameters calling ``new`` on
   zero bytes, then reset the pointer, causing small leaks on some platforms.

*  Corrected the error descriptor for FATAL errors.

*  Fixed MSVC 7.1 ambiguity in ``operator && (const OEIter<T>&,  bool)``.

*  Added endianness test for short integers to fix problems with small
   number of OEB files.

*  Fixed recurring compile problem in cygwin where ``ssize_t`` isn't defined.

OEPlatform 1.3.0
================================================================================

New Features
--------------------------------------------------------------------------------

*  Added an :ref:`OETryMutex <OEPlatform_OETryMutex>` class that allows for an *attempted lock*
   through the function :oe:meth:`OEPlatform::OETryMutex::Try`

*  Added :oe:func:`OEPlatform::OEFileCorrectSeparators` and
   :oe:func:`OEPlatform::OEFileDeterminePathAndName` functions.

*  Added new platform-independent :oe:func:`OEPlatform::OEIsNaN` function which
   is overloaded for ``float`` and ``double``.  As the name implies, this function
   returns a boolean which is true if the number passed is a nan.

Improvements and Optimizations
--------------------------------------------------------------------------------

*  :ref:`OEMutex <OEPlatform_OEMutex>` implementation now uses pthreads for icc 8.0

*  Add default 64 bit file support on Linux.

Major bug fixes
--------------------------------------------------------------------------------

*  Defined NONMINMAX in ``openeye.h`` under win32, which prevents conflicts
   between STL min/max and windows min/max macros.

Minor bug fixes
--------------------------------------------------------------------------------

*  Made gzip set and initialization functions work with std::cin.

*  Fixed a bug in the gzip seek function.

*  Fixed a few minor issues with the handling of trailing separators in path
   names.

*  Fix bug in `OEPlatform::OEStreamManager::openInput` function.
   When there was no protocol part of the ``filename`` parameter, the internal
   protocol string was not properly NULL-terminated.

*  Added code to properly initialize :ref:`OEMutex <OEPlatform_OEMutex>`.

*  Used ``&&`` to replace ``and`` for more consistent compiler support in
   :ref:`OEMutex <OEPlatform_OEMutex>`.

*  Implemented copy constructor and assignment operator for oeisstream.




********************************************************************************
Version  1.3.1 
********************************************************************************

OEChem  1.3.1 
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

*  Fix cis/trans bond stereochemistry perception when reading MDL
   MOL and SD files via :oe:func:`OEChem::OEReadMDLFile`.  We were overly aggressive
   when marking double bonds in rings as cis vs. trans due to a missing
   call to :oe:func:`OEChem::OEFindRingAtomsAndBonds`.  We also no longer attempt
   to attribute E/Z stereochemistry to connection tables without coordinates,
   or when any of the relevant bond lengths are zero.

Minor bug fixes
--------------------------------------------------------------------------------

*  Accidentally *OEChem*`s zmatrix handling functions were documented
   in the *OEChem* documentation but were missing from the distributed list
   of header files.  This oversight has been corrected and the classes
   `OEChem::OECartesianToInternal` and `OEChem::OEInternalToCartesian` 
   and the functions :oe:func:`OEChem::OECalcCartesianCoord` and 
   :oe:func:`OEChem::OECalcInternalCoord` are now publicly available.

*  Handle (and optimize) the case where :oe:func:`OEChem::OECanonicalOrderAtoms`
   or :oe:func:`OEChem::OECanonicalOrderBonds` is called with less then two atoms.

*  Fixes :oe:func:`OEChem::OEGetSmallestSubtree` to correctly return the smallest
   set of atoms on either side of a given bond when the molecule contains
   disconnected components.

*  Performance improvements to **OEGraphMolParameter**, to avoid
   using :ref:`OEIsomericConfTest <OEChem_OEIsomericConfTest>` when loading single conformer molecules.

*  Bug fix to :oe:meth:`OEMCMolBase::DeleteConf<OEChem::OEMCMolBase::DeleteConf>` 
   that could occasionally result in that multi-conformer molecule's active 
   conformer being corrupted.

*  Tweak to :oe:func:`OEChem::OEMDLPerceiveBondStereo` to preferentially place the
   wedge or hash bond on the bond to an explicit hydrogen, for chiral stereo
   centers of degree three.

*  Enhancements to :oe:func:`OEChem::OEMDLPerceiveParity` to support chiral
   atoms with two heavy atom neighbors and an explicit hydrogen.  These
   aren't supported by MDL software (including ISIS/Draw) but this allows
   *OEChem* to convert ``X[N@H]Y`` to an MDL mol file and back to isomeric
   SMILES without loss of information.

*  Improvements to :oe:func:`OEChem::OEMDLStereoFromParity` to set *OEChem*'s
   atomic chirality for the MDL stereo parity flag for both degree three
   and degree four atom stereo centers.

*  Correct problem in `OEChem::OEMiniAtom::Copy` where duplicating an
   atom would preserve the explicit degree of the original, as returned by
   :oe:meth:`OEChem::OEAtomBase::GetExplicitDegree`.

*  Fixes to both `OEChem::OEMiniBond::SetOrder` and
   `OEChem::OEMiniBond::SetIntType` that would incorrectly reset the
   aromaticity and in-ring flags of a bond as a side-effect.

*  Miscellaneous fixes and improvements to `OEChem::OEMiniMol::Copy`.

*  Fix to :oe:meth:`OEChem::oemolostream::openstring` to allow an 
   :ref:`oemolostream <OEChem_oemolostream>`
   to be reused multiple times, rather than constructed and destructed for each
   use.

*  :oe:func:`OEChem::OEPerceiveSymmetry` would previously segmentation fault on some 
   platforms if passed a molecule with no atoms.  This routine has now been
   idiot-proofed.

*  Maintenance updates to :oe:func:`OEChem::OEReadPDBFile` to handle PDB files
   deposited at RCSB, up to July 2004.  For example, correctly handling
   the hetero atoms of the ``NZQ`` residue of pdb1oj7.ent.

*  A serious performance regression in :oe:func:`OEChem::OERMSD` has been addressed.
   A change to :oe:func:`OEChem::OERMSD` for *OEChem* 1.3 unexpectedly resulted in a
   significant drop in superposition speed.  This has now been resolved and
   :oe:func:`OEChem::OERMSD` is as fast as (or faster than) it was in *OEChem* 1.2.

*  The string reference argument to :oe:func:`OEChem::OESetComment` is now correctly
   marked as `const`.  This value is never modified by this function.

*  The sanity checking in :oe:func:`OEChem::OESetTorsion` has been improved such
   that we now return false for dubious calls to that function.  For example,
   when the first and four atom pointers refer to the same atom.  Previously,
   we'd do nothing, but not indicate a failure with the return value.

*  Improvements to match limit test in :ref:`OESubSearch <OEChem_OESubSearch>` that prevent
   excessive run-times for pathological substructure search patterns. Previously,
   substructure searching of ``*.*.*.*`` wouldn't honor the match limit setting,
   and spew multiple *match limit reached* warnings.

*  Enhancement to :oe:func:`OEChem::OEWritePDBFile` to allow it to honor the
   :oe:const:`OEChem::OEOFlavor::PDB::RADIUS` flag to write an atom's radius in the PDB
   occupancy field, even when writing a molecule without residue information.

*  Better handling of out of range coordinates in :oe:func:`OEChem::OEWriteMDLFile`,
   :oe:func:`OEChem::OEWritePDBFile` and :oe:func:`OEChem::OEWriteMacroModelFile`.  
   Previously, a Cartesian coordinate larger than these file format's fixed 
   width fields would corrupt the following fields on the same line.

OESystem 1.3.1 
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

*  A fix to the function :oe:func:`OESystem::OECheckHelp` that prevents displaying
   on-line help for ``HIDDEN`` command line interface options.

*  Fixed a bug in :oe:meth:`OESystem::OEInterface::GetInterface` that would fail
   to find the correct interface by name.

*  Correct the return value for :oe:meth:`OESystem::OEInterface::DeleteInterface`.
   We now return false if we failed to delete the given interface.

*  Fixed an off-by-one error with the `OEPredVectorPtrIter::ToLast` 
   method on some kinds of iterators  (specifically, `OESystem::OEPredVectorPtrIter` s).




********************************************************************************
Version 1.3.2
********************************************************************************

OEChem 1.3.2 
================================================================================

New Features
--------------------------------------------------------------------------------

*  New function :oe:func:`OEChem::OEReadRxnFile` to read MDL RXN (reaction) file
   format.

*  New functions :oe:func:`OEChem::OEGetAtomComment` and :oe:func:`OEChem::OESetAtomComment` 
   that allow arbitrary text strings to be associated with atoms.  This is currently
   used to preserve/manipulate atom aliases from MDL file formats.

*  Changes to :oe:func:`OEChem::OEReadMDLFile` and :oe:func:`OEChem::OEWriteMDLFile` to read
   and write atom alias information.  Atom alias information is stored on
   an atom by the reader using :oe:func:`OEChem::OESetAtomComment`, and any such atom
   comments are written to the MDL connection table on output.

*  New function :oe:func:`OEChem::OEInvertCenter` to invert a tetrahedral center.
   For chiral atoms, this function flips the molecule from one isomeric
   form to the other.  This function returns false if the center can't
   easily be inverted.

*  Query molecules, represented by an :ref:`OEQMolBase <OEChem_OEQMolBase>` can now be
   read from and written to OEB binary files.

*  New function(s) :oe:func:`OEChem::OECorrectAcidProtonGeometry` to expose the
   new functionality in :oe:func:`OEChem::OESet3DHydrogenGeom` to ensure that protons
   on carboxylic acid groups are cis.

*  A new SMILES flavor, :oe:const:`OEChem::OESMILESFlag::ExtBonds` allows *OEChem*
   to write out SMILES strings using the external bond notation, {*i.e.*
   ``[*:1]CC[*:2]`` (a.k.a. ``[R1]CC[R2]``) can now be written out as ``C&1C&2``.

*  Constructors that take an STL ``std::string`` have been added
   to both :ref:`oemolistream <OEChem_oemolistream>` and :ref:`oemolostream <OEChem_oemolostream>`,
   allowing then to take C++ strings, in addition to ``const char*``.

*  A :oe:meth:`OEChem::oemolistream::rewind` method has been added to :ref:`oemolistream <OEChem_oemolistream>` to
   match the functionality available with :ref:`oeistream <OEPlatform_oeistream>`.  This
   method rewinds the stream to the beginning (if possible) and is equivalent
   to :oe:meth:`OEChem::oemolistream::seek` (0).

*  Added a new :oe:meth:`OEChem::OECliqueSearch::SetMCSFunc` method to 
   :ref:`OECliqueSearch <OEChem_OECliqueSearch>` to
   allow callers to customize the MCS function used in clique searching.

*  A new constructor to the :ref:`OEIsMember <OEChem_OEIsMember>` functor allows it to be
   used with an STL `std::set`.  Additionally :ref:`OEIsMember <OEChem_OEIsMember>` and
   :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>` now have assignment operator
   :oe:meth:`OEChem::OEIsMemberPtr::operator=` and 
   :oe:meth:`OEChem::OEIsMemberPtr::Set` methods.

*  Added new function :oe:func:`OEChem::OEGetHonigIonicCavityRadius` to return the
   effective ionic radius of each element to be used in solvation calculations.
   These values are described in [Rashin-1985]_ .

*  New example programs ``catmols``, ``movemol``, ``pdbdata``, ``rings``,
   and ``rmsd_selftest``.

Minor bug fixes
--------------------------------------------------------------------------------

*  Fixed a problem with reading multi-conformer molecules from MDL SD
   file format, where we wouldn't correctly record that each conformer already
   had MDL atom parity information (so we'd re-perceive it upon output which
   wouldn't preserve the original input values).

*  The dimension of an :ref:`OEMolBase <OEChem_OEMolBase>` (as returned by the
   :oe:meth:`OEChem::OEMolBase::GetDimension` method), is now read and written to
   OEB binary files.  Previously, all molecules in OEB were implicitly
   3D (which remains the default), but we now explicitly record when
   the dimension has a value other than three.

*  Fixed a bug in :oe:func:`OEChem::OEPerceiveChiral` that failed to recognize
   that double bonds in rings of size seven or greater are potentially
   chiral.

*  Fixed an obscure bug in the MDL file reader.  We were doing
   chirality and bond stereochemistry processing before we'd kekulized
   any aromatic bonds (from MDL substructure queries) or set the implicit
   hydrogen counts.  This occasionally confused :oe:func:`OEChem::OEPerceiveSymmetry`'s
   graph invariants and :oe:func:`OEChem::OEPerceiveChiral`'s tests for potential chiral
   atoms.

*  Corrected the high-level file writer, :oe:func:`OEChem::OEWriteMolecule`, such
   that when calculating MDL atom parity bits prior to writing MDL file
   formats, to first extract chirality from 3D coordinates if present.
   This is now consistent with similar logic prior to writing isomeric SMILES.

*  When writing isomeric SMILES, the :oe:func:`OEChem::OECreateSmiString` function
   was suppressing explicit hydrogens necessary to represent double bond
   stereochemistry.  These necessary *stereo* hydrogens are now written
   out explicitly.

*  Fixed some issues in the *OEChem* SMILES parser where there was
   insufficient validity checking in the processing of external bonds.
   These problems caused SMILES strings such as ``C&1&1``,
   ``C&1C&1`` and even ``&=9`` to crash the parser.  We
   now more politely generate a warning message and return false.

*  Improvements to :oe:func:`OEChem::OESet3DHydrogenGeom` to improve the
   geometry of protons added to carboxylic acids (which are now guaranteed
   to be cis). :oe:func:`OEChem::OESet3DHydrogenGeom` also avoids calling the function
   :oe:func:`OEChem::OEAssignHybridization` on the molecule, using a user-assigned
   hybridization if available and calling :oe:func:`OEChem::OEGetHybridization` otherwise.

*  Several fixes and improvements to the SMARTS parser.  We weren't
   correctly handling SMARTS with double digit ring closures, and we didn't
   recognize ``[te]`` as aromatic tellurium.  Also fixes to cis/trans stereo
   chemistry in a few corner cases.

*  Fixed by in a bug in reaction handling of the :ref:`OELibraryGen <OEChem_OELibraryGen>`
   class that caused a segmentation fault when using a reaction to delete
   unmapped atoms.

*  Fixed a bug in :oe:func:`OEChem::OERMSD` where if asked to overlay two sets
   of coordinates, and the user didn't ask for either the rotation matrix
   or translation vector, and the two structures overlaid perfectly, we'd
   generate a segmentation fault (we were writing a unit matrix to a NULL
   pointer).

*  Fixed a bug in :oe:meth:`OEMCMolBase::SweepConfs<OEChem::OEMCMolBase::SweepConfs>` 
   where we'd fail to
   renumber conformer indices, if there were no deleted conformers.

*  Minor tweak to :oe:func:`OEChem::OEGetHybridization` for uncharged sulfur,
   selenium, tellurium and polonium.  These are now always considered sp3
   unless they're aromatic, in which case they are sp2.

*  The :oe:meth:`OEChem::OEQBase::SetExpr` has been changed to make a copy of the
   passed :ref:`OEExprBase <OEChem_OEExprBase>` pointer which fixes issues with copying/assigning
   :ref:`OEQMolBase <OEChem_OEQMolBase>` s.

*  Fixed a rare bug in :oe:meth:`OEChem::OEAtomBase::GetStereo` that could
   occasionally return either :oe:const:`OEChem::OEAtomStereo::Left` or 
   :oe:const:`OEChem::OEAtomStereo::Right` for an atom
   without :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified`.  
   This has now been fixed such that whenever :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` 
   returns false, :oe:meth:`OEChem::OEAtomBase::GetStereo` 
   will always return :oe:const:`OEChem::OEAtomStereo::Undefined`.

*  A minor tweak to :oe:func:`OEChem::OEGetFileType` to perform case-insensitive
   string comparison, allows this code to recognize file format extensions
   independent of capitalization, *i.e.* ``.mol2`` and ``.MOL2``.

*  Improvements to the heuristics used by :oe:func:`OEChem::OEMDLPerceiveBondStereo`
   for placing wedge and hash bonds on a connection table.  These include
   avoiding placing the wedge/hash on the fusion bond for chiral bridgehead
   atoms, and arbitrarily choosing amongst the best bonds when no unique
   best is found (previously a tie caused the algorithm to choose randomly
   between all neighboring bonds).

*  Tweak to :oe:func:`OEChem::OEDetermineConnectivity` such that atoms that are
   marked as PDB residues ``CL``, ``BR`` and ``IOD`` (*i.e.* chloride,
   bromide and iodide ions) are treated like solvent, and are never bonded
   to other residues (in this case other atoms).

*  Routine maintenance improvements to *OEChem*'s PDB file format readers
   to handle files recently released by RCSB.  For example, residue ``GCP``
   in pdb1rca.ent, residue ``783`` in pdb1o2t, and similar fixes in PDB codes
   1ta2, 1ta6, 1o3m, 1o3n and 1o3o.

*  Improvement to :oe:func:`OEChem::OEReadMacroModelFile` to read the atomic partial
   charge out of the charge-charge interaction column and fixed a bug in
   extracting the atom name field.

*  Enhancement to the :oe:func:`OEChem::OEWriteMacroModelFile` function to write
   out the atomic partial charge to both the charge-charge and charge-multipole
   fields of the MacroModel connection table.  Previously, we only stored the
   partial charge in the charge-charge field, and wrote 0.0 to the
   charge-multipole field.

Python wrappers
--------------------------------------------------------------------------------

Major bug fixes
^^^^^^^^^^^^^^^^

*  Fixed a major bug in SD tag handling for :ref:`OEGraphMol <OEChem_OEGraphMol>` s.
   In *OEChem* 1.3.1, re-using an :ref:`OEGraphMol <OEChem_OEGraphMol>` and reading from
   an SD file, could result in one molecule getting SD tags from the previous molecule. 

Minor bug fixes
^^^^^^^^^^^^^^^^

*  Alternate implementations of :ref:`OEGraphMol <OEChem_OEGraphMol>` are now exposed by passing
   a constant to the constructor. This was exposed in 1.3.1, but the C++ 
   constants from ``molfactory.h`` were not wrapped.

*  molchunk.py stopped working in 1.3.1 due to changes to 
   :oe:meth:`OEChem::oemolistream::seek` on a stream. 
   A new method :oe:meth:`OEChem::oemolistream::rewind` has been added 
   to :ref:`oemolistream <OEChem_oemolistream>` to take the place of the old seek(0).

OESystem 1.3.2 
================================================================================

New Features
--------------------------------------------------------------------------------

*  A new two argument variant of :oe:func:`OEMath::OEGeom3DAngle` allows the
   calculation of the angle between two vectors.  This is an efficient
   form of the three argument variant, where the middle point is defined
   to be the origin.

*  Added a new :oe:func:`OESystem::OELinearInterpolate` function (template) that
   can be used to linearly interpolate the value at an arbitrary point
   inside an :ref:`OEFixedGrid <OESystem_OEFixedGrid>`.

*  Two new functors :ref:`OEBinaryAnd <OESystem_OEBinaryAnd>` and :ref:`OEBinaryOr <OESystem_OEBinaryOr>`
   for constructing a single binary predicate from two binary predicates.
   These are equivalent to the :ref:`OEAnd <OESystem_OEAnd>` and :ref:`OEOr <OESystem_OEOr>`
   functors for unary predicates.

Major bug fixes
--------------------------------------------------------------------------------

*  Exposed the ``_baseimpl`` member of :ref:`OEBase <OESystem_OEBase>`.
   This allows the *OEChem* python wrappers to associate generic data correctly
   with a molecule.

Minor bug fixes
--------------------------------------------------------------------------------

*  Made :ref:`OEBitVector <OESystem_OEBitVector>`'s destructor virtual to allow classes to
   be derived from them.

OEPlatform 1.3.2 
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

*  Fixed the STL standard file I/O wrappers, :ref:`oeistdstream <OEPlatform_oeistdstream>` and
   :ref:`oeostdstream <OEPlatform_oeostdstream>` that wrap/transform C++'s ``std::istream`` and
   ``std:ostream`` into the :ref:`oeistream <OEPlatform_oeistream>` and
   :ref:`oeostream <OEPlatform_oeostream>` required by *OEChem*'s file functions.



********************************************************************************
Version 1.3.3
********************************************************************************

OEChem 1.3.3
================================================================================

New Features
--------------------------------------------------------------------------------

*  Several enhancements have been made to the protein perception
   algorithms used in :oe:func:`OEChem::OEPerceiveResidues`.  These allow *OEChem* to
   recognize the N-terminal capping group ``ACE``, and the nonstandard
   amino acid residues ``ABA``, ``CGU``, ``CME``, ``CSD``, ``MLY``, ``MSE``,
   ``PCA``, ``PTR``, ``SEP`` and ``TPO``.  Support for these additional amino
   acid types has also been added to :oe:func:`OEChem::OEGetResidueIndex` and friends.
   The sidechain pattern matching algorithm now has improved *fallback*
   functionality for better handling of modified/substituted residues.

*  Improved support from aromatic boron and aromatic silicon
   in :oe:func:`OEChem::OEKekulize`. The *OEChem* toolkit currently doesn't perceive
   either boron or silicon to be aromatic (with any aromaticity model),
   but this enhancement allows us to Kekulize structures so specified.

*  Added improved support of parsing SMILES containing aromatic boron
   and aromatic silicon, allowing the *OEChem* toolkit to parse ``b1ccccc1``
   (borinine).

*  A new :oe:func:`OEChem::OEGetDelphiRadius` function has been added to *OEChem*
   to return the default radius for a given element used by the Accelrys'
   Delphi program for electrostatics calculations.

*  A new function :oe:func:`OEChem::OEGetAminoAcidCode` can be used to convert
   an index from the :oe:constns:`OEChem::OEResidueIndex` namespace to a IUMB single
   character code (``A`` for alanine, ``R`` for arginine, etc...).

*  Several new convenience functions, :oe:func:`OEChem::OEAssignCovalentRadii`,
   :oe:func:`OEChem::OEAssignDelphiRadii`, :oe:func:`OEChem::OEAssignBondiVdWRadii`,
   :oe:func:`OEChem::OEAssignPaulingVdWRadii` and
   :oe:func:`OEChem::OEAssignHonigIonicCavityRadii`, are now provided to set
   the radius property on each atom of a molecule to the value
   specified by the corresponding ``OEGet...Radius`` function.

*  A new function :oe:func:`OEChem::OEIsBinary` is provided to determine
   whether the specified file format is binary or not, for example,
   ``.oeb``, ``.bin`` and ``.cdx``.

*  The new function :oe:func:`OEChem::OEGetFormatExtension` can be used
   to return a comma separated list of lowercase file format extensions
   that can be used to aid implementing directory scans and file
   format dialog boxes.

*  A new :ref:`OEMCSFunc <OEChem_OEMCSFunc>` functor, :ref:`OEMCSMaxBondsCompleteCycles <OEChem_OEMCSMaxBondsCompleteCycles>`
   can be used as an objective function to *OEChem*'s maximal common subgraph
   matching algorithms.

Major bug fixes
--------------------------------------------------------------------------------

*  A problem in *OEChem*'s graph canonicalization algorithm was
   identified by the NCBI's PubChem project for the single molecule:
   ``C12C3C4C3C5C4C1C25``.  This problem has been fixed in *OEChem*
   1.3.3.  Unfortunately, this failure didn't show up on our testing
   of 100 random permutations of 2.5 million compound test set.
   Efforts are now on-going to validate *OpenEye*'s canonicalization
   against all theoretical connection tables with less than :math:`N` atoms,
   for some :math:`N > 10`.

*  A bug in the OEB file format readers and writers that could
   cause the titles and/or comments attached to molecules or conformers
   to be lost, has been corrected.

Minor bug fixes
--------------------------------------------------------------------------------

*  Fixed bug in the *OEChem* SMARTS parser that failed to follow the
   Daylight semantics for patterns such as ``[H]``, ``[2H]`` and ``[H+]``
   where the ``H`` specifies the pattern must match a hydrogen, and not
   the expected hydrogen count on an atom.

*  The *OEChem* SMILES writers have been modified to prevent them
   generating atoms such as ``[C@H2]`` or ``[C@@H2]`` for centers that
   have stereo explicitly specified (on non-chiral centers) with
   explicit hydrogens, when the hydrogens are being automatically
   suppressed by the output SMILES flavor.

*  The methods :oe:meth:`OEChem::OEAtomBase::SetStereo`, 
   :oe:meth:`OEChem::OEAtomBase::GetStereo`,
   :oe:meth:`OEChem::OEBondBase::SetStereo` and 
   :oe:meth:`OEChem::OEBondBase::GetStereo` 
   have been enhanced such that the internal representation of
   stereochemistry is invariant of hydrogen suppression.  The functions
   :oe:func:`OEChem::OESuppressHydrogens` and 
   :oe:func:`OEChem::OEAddExplicitHydrogens` no longer
   invalidate stereochemistry.

*  The old-style OE binary, ``.bin``, file format reader now
   automatically sets the dimension property of molecules and conformers
   to 3.  Whilst new-style OE binary, ``.oeb``, files explicitly record
   the dimensionality of the stored coordinates, the old format didn't
   and its contents should be assumed to be 3-dimensional.

*  Correct a minor logic problem in :oe:meth:`OEChem::OEQMolBase::BuildExpressions`
   when constructing the expressions to match bond orders but not aromaticity.

*  Fixed a problem in the SMILES parser, which would cause a
   segmentation fault if ever a SMILES string longer than 4096
   characters encountered a syntax or Kekulization error.  We no
   longer try to report the location of the syntax error for SMILES
   strings longer than 2048 characters.

*  A bug in :oe:func:`OEChem::OEPerceiveBondOrders` that assumed/required that
   the incoming molecule not have any aromaticity specified, has been
   fixed by calling :oe:func:`OEChem::OEClearAromaticFlags` on the incoming molecule.
   This assumption was valid for its existing use by the high-level
   file format readers, but meant that calling :oe:func:`OEChem::OEPerceiveBondOrders`
   twice in a row could sometimes produce different results.

*  Fixed a potential problem in several file format readers that
   caused a run-time abort in Microsoft's runtime libraries on Windows
   when reading corrupt or binary files.  The Microsoft implementation of
   the standard ``<ctype.h>`` functions, such as ``isdigit`` and
   ``isupper`` will abort when passed negative values, such as
   when interpreting the bytes of a file as (signed) char.

*  Fixed a segmentation fault in :oe:func:`OEChem::OEScrambleMolecule` that
   was triggered by chiral molecules.

*  Fixed a bug in :oe:func:`OEChem::OEMDLCorrectBondStereo` that could cause
   that routine to crash, if the chiral atom on which the stereo
   chemistry needed to be corrected was degree three instead of
   degree 4.  This routine has been made more robust, and can now
   correct wedges and hashes around degree three atoms that conflict
   with the specified MDL parity bit.

*  The *OEChem* MDL mol file reader has been made more robust by
   checking for negative values in the atom count, bond count and list
   count fields.  These are now interpreted as being zero.  Corrupted
   SD files could previously cause *OEChem* to crash.

*  Calling close on an :ref:`oemolistream <OEChem_oemolistream>` that wraps
   :oe:const:`OEPlatform::OEPlatform::oein`,
   will now correctly make :oe:meth:`OEChem::oemolistream::operator bool` return
   false, and stop it reading (even though :oe:const:`OEPlatform::OEPlatform::oein`,
   itself shouldn't be closed).

*  The *OEChem* SMILES parser, :oe:func:`OEChem::OEParseSmiles` function, has
   been fixed to set the default bond order of unspecified external
   bonds, *i.e.* ``C&1``, to be single.  Previously these were left
   initialized as bond order zero, although ``C&=1`` and ``C&#1`` were
   correctly handled as double and triple bonds respectively.

*  The function :oe:func:`OEChem::OEPDBOrderAtoms` has been improved to only
   compare atoms names for recognized residues when sorting.  This
   prevents atoms being needlessly reordered for no good reason.

*  :oe:func:`OEChem::OEPerceiveResidues` has been improved to assign unique
   atom names to every atom within an unknown or unrecognized residue.
   Previously, all six atoms in benzene would be given the same atom
   name ``C `` which confuses software that assumes PDB atom names are
   unique within a residue. *OEChem* now assigns ``C1``, ``C2``, etc...

*  Add goof-proofing to return calls to :oe:func:`OEChem::OEInvertCenter`
   where the specified atom is not trivially invertible (*i.e.* a 
   center with 3 or more ring bonds).

*  Improved handling of the hydrogen isotopes ``D`` and ``T`` when
   reading MDL connection tables.  These symbols now automatically
   set the isotope field appropriately.  Previous versions of *OEChem*
   interpreted these symbols as forms of hydrogen, but relied on the
   MDL's mass field or ``M ISO`` line being correctly set to specify
   a/which isotope.

*  A very minor bug in :oe:func:`OEChem::OEPerceiveResidues` has been fixed
   that prevented residue information from being assigned to lone protons.
   The algorithm previously assumed all hydrogens were bonded to a 
   heavy atom parent.

*  In :oe:func:`OEChem::OESubsetMol` the dummy atoms used to represent attachment
   points are no assigned map indices starting from one, *i.e.* R1, R2, R3,
   instead of from zero, *i.e.*, R1, R2.

*  :oe:func:`OEChem::OESubsetMol` now attempts to preserve or undefine the
   specified stereochemistry at atoms and bonds affected by attachment
   points.

*  The performance of :oe:func:`OEChem::OEDetermineConnectivity` has been
   dramatically improved for very large molecules.  This greatly speeds
   up the reading of proteins like ``pdb1jj2.ent`` (which contains 98,543 atoms)
   several fold.

*  Replaced an inefficient :math:`O(n^2)` algorithm in the
   `OEChem::OEMolBaseImpl::OrderAtoms` method that checked that the
   input vector was a valid permutation of a subset of the atoms
   in the molecule.  This dramatically improves the performance
   of writing large PDB files.

*  The performance of many of the :ref:`OEMolBase <OEChem_OEMolBase>`,
   :ref:`OEAtomBase <OEChem_OEAtomBase>` and :ref:`OEBondBase <OEChem_OEBondBase>`
   methods has been improved in *OEChem* 1.3.3.

*  The methods :oe:meth:`OEChem::oemolistream::operator bool`,
   :oe:meth:`OEChem::oemolostream::operator bool` and 
   :oe:meth:`OEChem::oemolistream::eof` have
   been marked *const* to enable better compiler optimization.

Java wrappers
--------------------------------------------------------------------------------

New Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*  With this release of *OEChem*, Java wrappers are now provided. This
   first version only supports Sun's JVM version 1.4.2.

Python wrappers
--------------------------------------------------------------------------------

New Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*  The :ref:`OEInterface <OESystem_OEInterface>` class and associated machinery for creating
   and parsing command lines is now available in Python. While Python has
   native command line argument support, this provides an alternative that
   is functionally similar to the C++ *OEChem* version. The example program
   ``molextract.py`` has been updated to demonstrate this new feature.

Major bug fixes
--------------------------------------------------------------------------------

*  Fixed a memory leak in :ref:`OENot <OESystem_OENot>`, :ref:`OEAnd <OESystem_OEAnd>`
   and :ref:`OEOr <OESystem_OEOr>` predicates.

*  Fixed a bug in **PyAtomPredicate**, **PyBondPredicate** and
   **PyConfPredicate** where a syntax error in the Python callable function
   would silently fail.  Now, if there is an error in the Python function,
   the exception will propagate back to the Python interpreter.

OESystem 1.3.3
================================================================================

New Features
--------------------------------------------------------------------------------

*  By default the *OpenEye* toolkits now use thread-safe memory
   management internally to allow multiple molecules (and other objects)
   to be manipulated by different concurrent threads.  Modifying the
   same object concurrently is still unsafe.  On some operating systems,
   *OEChem* intensive applications may experience a slight overhead which
   may be explicitly disabled with the new :oe:func:`OESystem::OESetThreadSafe` function
   call.  Timings on modern GNU/Linux systems show almost no overhead,
   and the performance benefits of upgrading to g++ 3.4.x means that most
   applications should run faster with *OEChem* 1.3.3 than with previous
   releases even with thread-safety enabled.

*  The ``--help`` functionality of the :ref:`OEInterface <OESystem_OEInterface>` class
   has been improved to indent and wrap the on-line help text at 80 columns.
   The default screen width can be controlled by specifying the column width
   on the command line, for example ``--help all 100``.

*  The :ref:`OEInterface <OESystem_OEInterface>` parser has been improved to allow
   ``!CATEGORY`` names to be quoted, allowing names to contain spaces.

*  The `OESystem::OEFizzGrid` class now has an  
   `OESystem::OEFizzGrid::operator bool`
   method, which returns true if either floats or integers have been set.

Major bug fixes
--------------------------------------------------------------------------------

*  The semantics of how quaternions are represented within the
   *OpenEye* toolkits have now been standardized, as scalar-first.  Hence,
   of the four floating point values that define a quaternion,
   the first represents the scalar component and the final three values
   represent the vector component.  The failure to explicitly document
   which of the two possible forms was used, resulted in some *OEMath*
   functions assuming scalar-first whilst others assumed scalar-last.
   (The quaternion functions in OELib, for example, used scalar-last).
   Functions affected by this include `OEMath::OEGeomQuaternionMultiply`,
   `OEMath::OEGeom3DUnitQuaternionRotate`
   `OEMath::OEGeom3DQuaternionToRotMatrix` and
   `OEMath::OEGeom3DRotMatrixToQuaternion`.

Minor bug fixes
--------------------------------------------------------------------------------

*  Fixed a potential memory leak in :ref:`OEBinaryNot <OESystem_OEBinaryNot>`.

*  :ref:`OEInterface <OESystem_OEInterface>`'s methods :oe:meth:`OESystem::OEInterface::DeleteInterface` and
   :oe:meth:`OESystem::OEInterface::DeleteParameter` now recursively search through sub-interfaces
   for the object to delete.

*  The :oe:func:`OESystem::OEStringTokenize` and :oe:func:`OESystem::OEStringTokenizeQuoted`
   functions have been completely rewritten.  Both previous implementations
   could potentially thrown C++ exceptions, and the latter was just plain
   broken.

*  A minor bug in the :ref:`OEInterface <OESystem_OEInterface>` class, that in some
   cases caused the detailed description to end with ``!END``,
   has been fixed.

*  The behavior of the ``!REQUIRED`` keyword has changed
   in :ref:`OEInterface <OESystem_OEInterface>` files.  If an option has a default value,
   specified by the ``!DEFAULT`` keyword, then the ``!REQUIRED``
   option is ignored.

OEPlatform 1.3.3
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

*  Modified :oe:func:`OEPlatform::OEFileDeterminePathAndName` to canonicalize
   directory separators to the appropriate form for the host operating
   system.

*  Improved the performance of :ref:`OEMutex <OEPlatform_OEMutex>` when using g++,
   by using the low-level ``gthr`` API, rather than using the
   higher-level locking primitives used by the ``libstdc++`` STL
   library.

*  Fixes to :ref:`oestream <OEPlatform_oestream>` classes to prevent accidentally
   closing ``stdin``.  Minor bug fix to :ref:`oeiwrapperstream <OEPlatform_oeiwrapperstream>`
   implementation.



********************************************************************************
Version 1.3.4
********************************************************************************

OEChem 1.3.4
================================================================================

New Features
--------------------------------------------------------------------------------

*  A new :oe:func:`OEChem::OEChemIsLicensed` API point has been provided
   to allow an application to check whether the *OEChem*, *OESystem* and
   *OEPlatform* libraries have managed to find a suitable run-time
   license.  This function can safely be called from programs to
   determine *a priori* whether using *OEChem* functionality may
   trigger a fatal error, allowing a warning to be issued and/or
   calls the affected functionality to be avoided.

*  A new ``MOL2::Substructure`` flavor has been added to the
   high-level writers (and a new default argument to the low-level
   :oe:func:`OEChem::OEWriteMol2File`) to force the writer to emit a suitable
   ``@TRIPOS<SUBSTRUCTURE>`` record even for molecules having only
   a single substructure.  The default behavior remains the same
   (to omit the record for *small* molecules) to save space in
   the common case.

*  *OEChem*'s SMILES format parser, :oe:func:`OEChem::OEParseSmiles`, has been
   tweaked to treat SMILES with inconsistent cis/trans bond stereo,
   such as ``C/C=C(/C)/C``, as a soft warning rather than as a hard
   error.  Previously, *OEChem* followed the Daylight toolkits, treating
   this as a serious error, and returning an empty molecule.  The
   new behavior is that a warning is now thrown to :oe:constns:`OESystem::OEThrow`,
   but the molecule is returned, just without specified stereochemistry
   for the problematic bond(s).  This allows *OEChem* to be used to
   correct/recover SMILES generated by buggy SMILES writers.

*  The functions :oe:func:`OEChem::OEAtomSetMDLParity` and
   :oe:func:`OEChem::OEAtomGetMDLParity` have been introduced, to simplify the
   task of storing and retrieving the MDL parity value associated
   with each atom.

*  The OEB file format readers and writers will now preserve PDB
   file header records, if they are present on the original molecule.

*  A new function :oe:func:`OEChem::OEGetCenterAndExtents` can be used to
   retrieve the center and 3D extents of a given :ref:`OEMolBase <OEChem_OEMolBase>`.

*  The file format extension ``.isosmi`` is now treated as
   a synonym for ``.ism``, indicating isomeric SMILES.

*  The :oe:meth:`OEChem::OEQMolBase::BuildExpressions` function now avoids
   constructing an atomic hybridization constraint if the query atom's
   :oe:meth:`OEChem::OEAtomBase::GetHyb` method returns zero.

Major bug fixes
--------------------------------------------------------------------------------^

*  A problem with the generation of canonical isomeric SMILES has
   been fixed, that for pathological molecules with specified cis/trans
   stereochemistry could cause the canonical SMILES string to be written
   using ``/`` (forward slash) for some input orderings and
   ``/`` (backslash) for others.  The resulting SMILES weren't
   incorrect (and the perceived symmetry invariants were fine), but this
   allowed equivalent isomers to be given non-identical isomeric SMILES
   strings.

*  Fixed a bug in the 1.3.3 changes to the :oe:func:`OEChem::OEPerceiveResidues`
   function.  The new functionality to identify an acetyl as an N-terminal
   blocking group, PDB code ``ACE``, could get confused when pattern
   matching some pathological graphs, such as proteins with N-terminal
   proline residues.

*  Fixed a bug in the OEB file format writer that could result in
   the coordinates of a multiconformer molecule becoming scrambled if
   the atoms of the :ref:`OEMolBase <OEChem_OEMolBase>` has been reordered, with
   :oe:meth:`OEChem::OEMolBase::OrderAtoms`, (and no atoms had been deleted) before
   writing the molecule.  This could also affected the :oe:meth:`OEChem::OEMolBase::Compress`
   and :oe:meth:`OEChem::OEMolBase::UnCompress` methods.

*  Fixed a bug that could cause a core dump when making a copy of
   an :ref:`OESubSearch <OEChem_OESubSearch>` instance that contains atom or bond stereo.

Minor bug fixes
--------------------------------------------------------------------------------^

*  Fixed a segmentation fault when calling either :oe:func:`OEChem::OEIsCommonIsotope`
   or :oe:func:`OEChem::OEGetIsotopicWeight` with both atomic number and atomic mass of
   zero.  If ever :oe:func:`OEChem::OEIsCommonIsotope` is called with a mass of zero (for
   any element) it now returns false, and whenever :oe:func:`OEChem::OEGetIsotopicWeight`
   is called with a mass of zero, it now returns the corresponding isotopically
   averaged atomic weight, *i.e.* via :oe:func:`OEChem::OEGetAverageWeight`.

*  The :ref:`OEMatch <OEChem_OEMatch>` class was missing an explicit assignment
   operator, which could cause memory corruption if one :ref:`OEMatch <OEChem_OEMatch>`
   was ever assigned to another.  This has now been implemented.

*  Improved *OEChem*'s :oe:func:`OEChem::OEDetermineConnectivity` functionality
   to restrict proximity-based bonding of hydrogen atoms preferably to
   their nearest suitable heavy (non-hydrogen) neighbor.  Previously,
   hydrogens only bonded to their nearest neighbor, which for all-atom
   molecules with bad clashes caused the overlapping protons to sublimate
   as molecular hydrogen, leaving their original parents in strange
   charge (or radical) states.

*  The generation of ``@TRIPOS<SUBSTRUCTURE>`` records in Sybyl
   ``.mol2`` files has been rewritten to ensure that ligands, solvent
   molecules and nonstandard amino acids are correctly placed in their
   own Tripos substructure.  Previously, PDB ``HETATM`` s would be
   placed in substructure 1, sharing it with a valid ``RESIDUE``.
   Each :ref:`OEResidue <OEChem_OEResidue>` is now allocated a unique Tripos substructure,
   and nonstandard (or unrecognized) residues are marked as ``GROUP``.

*  The geometry functions :oe:func:`OEChem::OESetAngle` and :oe:func:`OEChem::OESetDistance`
   have both been made more robust to molecules without coordinates (and
   zero bond lengths).

*  A refactoring of the SMILES generation routines in the *OEChem*
   source code means that the non-canonical SMILES created by the
   function  :oe:func:`OEChem::OECreateAbsSmiString` are now identical to those
   created by :oe:func:`OEChem::OECreateSmiString` with just the
   :oe:const:`OEChem::OESMILESFlag::AtomMaps`  and :oe:const:`OEChem::OESMILESFlag::RGroups`
   flags.

*  Tweaks :oe:func:`OEChem::OEDetermineConnectivity` to avoid generating bonds
   between atoms in alternate locations/conformations.  This is only a
   problem for PDB files read with the ``ALL`` input flavor.  There
   are still multiple bonds between invariant *hinge* atoms and the
   multiple copies of its neighbors in alternate conformations.

*  Fixed a potential performance problem in :ref:`OEMolBase <OEChem_OEMolBase>`'s
   `OEChem::OEMolBase::operator+=`, and the equivalent
   :oe:func:`OEChem::OEAddMols` function
   calls, when concatenating large molecules with coordinates.

*  The performance of reading MDL SD files containing a large
   quantity of SD tag data and for PDB files containing a large
   amount of header information (with the ``DATA`` flavor) has
   been improved.  Instead of attaching each data item to the
   molecule as it's encountered, the file format readers now
   accumulate the data first, and then attach it to the molecule
   on encountering the end of the connection table.

*  The performance of handling generic data tags when reading
   OEB files containing large numbers of atoms or bonds has been
   improved.

*  The consistency of file format flavors have been improved.
   The SMILES :oe:const:`OEChem::OEOFlavor::SMI::ExtBonds` flavor that was previously
   only available to the :oe:const:`OEChem::OEFormat::SMI` file format, is now also available
   to the :oe:const:`OEChem::OEFormat::CAN` and :oe:const:`OEChem::OEFormat::ISM` formats.
   Likewise, the flavors available
   to the :oe:const:`OEChem::OEFormat::MOL2` and :oe:const:`OEChem::OEFormat::MOL2H` file formats
   have been synchronized, with  :oe:const:`OEChem::OEFormat::MOL2H` becoming a flavor of
   :oe:const:`OEChem::OEFormat::MOL2`
   (*i.e.* the file extension effectively specifies a different default flavor).

*  The :ref:`OEMCSMaxAtomsCompleteCycles <OEChem_OEMCSMaxAtomsCompleteCycles>` objective function
   requires that ring atoms and bonds of the query molecule have been
   perceived (using :oe:func:`OEChem::OEFindRingAtomsAndBonds`) before the
   corresponding :ref:`OEMCSSearch <OEChem_OEMCSSearch>` instance is constructed.  To
   avoid unexpected behavior, the :ref:`OEMCSSearch <OEChem_OEMCSSearch>` constructors
   now call :oe:func:`OEChem::OEFindRingAtomsAndBonds` themselves if allowed to
   make a copy of the query molecule (the default), or issue a
   warning to :oe:constns:`OESystem::OEThrow` otherwise.

OESystem  1.3.4
================================================================================

New Features
--------------------------------------------------------------------------------^

*  New *OEMath* template functions :oe:func:`OEMath::OEGeom3DGetCenterAndExtents`
   and :oe:func:`OEMath::OEGeom3DGetCenterOfMass` have been added to calculate the
   center, extents and (weighted) center of mass of a set of 3D coordinates.

*  The :ref:`OEInterface <OESystem_OEInterface>` class now has new
   :oe:meth:`OESystem::OEInterface::GetTypedParameter` template member functions.

*  A new function :oe:func:`OEChem::OEGetCenterAndExtents` has been added to
   *OESystem*'s grid handling code, to retrieve the center and extents of
   a grid.

Minor bug fixes
--------------------------------------------------------------------------------^

*  A complete new implementation of :ref:`OEConcatIter <OESystem_OEConcatIter>` to avoid
   potential problems caused by the fact that appending items to an
   STL ``std::vector`` invalidates iterators over it.  The new
   implementation uses offsets rather than pointers to avoid problems.
   This also fixes a crash of :oe:meth:`OESystem::OEConcatIter::operator++` on an
   empty iterator.

*  Fixed a bug in :oe:meth:`OESystem::OEIter::Push` that caused problems if the
   iterator was previously empty.

*  Fixed a bug in :oe:func:`OESystem::OEFileExtension` that was causing crashes
   when no extension was present.

*  Fixed a bug in :oe:meth:`OESystem::OEInterface::GetParameters` that caused
   parameters in sub sub interfaces to appear multiple times in the
   returned iterator.

*  The :oe:func:`OESystem::OEWriteSettings` function now takes a *const*
   :ref:`OEInterface <OESystem_OEInterface>` reference.

OEPlatform 1.3.4
================================================================================

New Features
--------------------------------------------------------------------------------^

*  New functions :oe:func:`OEPlatform::OEFileDetermineName` and
   :oe:func:`OEPlatform::OEFileDeterminePath`
   to extract the basename and path of a filename respectively.

Minor bug fixes
--------------------------------------------------------------------------------^

*  Fixed a problem in the :ref:`oeigzstream <OEPlatform_oeigzstream>` constructor, that
   could cause problems determining the size of a file using ``size``,
   as zlib was not being correctly initialized.

*  Fixed a minor bug in :oe:func:`OEPlatform::OEFileCreate` that was failing to
   close the file descriptor for the newly created file.

*  The return type of the :oe:meth:`OEPlatform::OEFile::Size` method and the
   :oe:func:`OEPlatform::OEFileSize` function have been changed from ``size_t``
   to ``oefpos_t`` to allow correct handling of large files on
   32-bit platforms.

*  Fixed some minor bugs in :ref:`oeistream <OEPlatform_oeistream>` and
   :ref:`oeostream <OEPlatform_oeostream>` when these classes are used directly.



********************************************************************************
Version 1.4.0
********************************************************************************

OEChem 1.4.0
================================================================================

OEChem 1.4.0 is a major new feature release. *OpenEye* is introducing
*OEBio*, a new programming library extending *OEChem*'s convenience in
handling biopolymers.  In this initial release, *OEBio*'s API is small
but useful.  Over the life of the 1.4.x *OEChem* release series the
*OEBio* API will grow.  The purpose of *OEBio* is not to cover
Bioinformatics, but to extend *OEChem*'s strong cheminformatics
foundation to conveniently support protein modeling.

The source-code and examples in /openeye/examples/oechem have long
been caught in a conflict.  They served both as very useful tools and
as didactic coding examples.  To fulfill the role as tools, they
needed good command-line-interfaces and error reporting.
Unfortunately these features lead to more complex code.  To fulfill a
role as code examples, these programs need to be as simple as
possible, highlighting one or two programming principles.  In order to
better serve both purposes, the example programs have now been split
into /openeye/utilities and /openeye/examples, the first includes
programs with more complex code and better interfaces and the latter
with simple *OEChem* code examples.  In addition, nine new example
programs have been included to demonstrate common uses of the *OEBio*
API.

In addition to *OEBio*, the 1.4.0 release includes many new features
and bug fixes in the *OEChem*, *OESystem* and *OEPlatform* libraries.

New Features
--------------------------------------------------------------------------------

*  Split the programs previously in the examples directory into
   examples and utilities.  The utilities directory will contain
   programs or versions of programs that may be useful and convenient
   for modelers to carry out common tasks.  The examples directory
   will contain programs that may also be useful, but there primary
   purpose will be to provide didactic code examples of how to program
   common tasks using the *OEChem* library.

*  New support for highly compact ``rotor-offset compressed`` oeb files.

*  Added support for MDL ISIS Sketch file format with the ``.skc`` suffix.

*  Added support for writing hydrogens that are required for specifying cis-trans stereo.

*  Added support for ``[Ds]`` and ``[Rg]`` in SMILES and SMARTS.

*  Added support for writing high-atomic number atoms in SMILES using
   ``[\#123]`` notation.

*  New :oe:func:`OEChem::OEWriteConstMolecule` function class to support high-level
   writing of const molecules.  Introduced return-codes for the high-level writers
   that reflect that some molecules are inherently not supported by certain file
   formats (*e.g.* >999 atoms in .sdf).

*  Add an :oe:const:`OEChem::OEOFlavor::MOL2::Substructure` high-level writer flavor to
   force an ``@TRIPOS<SUBSTRUCTURE>`` idiom in the ``.mol2`` file.

*  New :oe:func:`OEChem::OEHasStereoHydrogens` function that determines if
   an atom has a proton that is required to specify stereochemistry.

*  Added ``retainStereo=false`` default argument to
   :oe:func:`OEChem::OESuppressHydrogens` that keeps hydrogens indicated by the
   :oe:func:`OEChem::OEHasStereoHydrogens` function.

*  Added :oe:meth:`OEChem::OEMatchBase::Clear` method.

*  Dramatically improved efficiency of  
   :oe:meth:`OEMCMolBase::DeleteConf<OEChem::OEMCMolBase::DeleteConf>` for
   deleting large numbers of conformers in order.  Worst case behavior of the
   algorithm was changed from :math:`N*N` to :math:`N`.

*  Allow the SD file reader to handle a blank line between the ``M END`` and
   the '$ $ $ $' lines.

*  Added convenience functions for getting and setting the MDL parity on
   atoms.

*  Added new bitmask initialization parameters to
   :oe:func:`OEChem::OEInitDefaultHandler` that allow easy specification of which handlers to
   initialize.  

*  New support for ``h``, ``d``, ``t``, ``[T]`` and ``[t]`` nonstandard
   SMILES representations.

*  Improved support for multiple NMR models in PDB files by reading,
   retaining and writing model number.

*  Added fully supported **OEPDBData** and :oe:cls:`OEPDBDataPair<OEChem::OESDDataPair>` 
   classes as well as the necessary function to store and retrieve them from molecules.

*  Three new convenience functions for clearing tag data:
   ``OEChem::OEClearTagData``, :oe:func:`OEChem::OEClearSDData` and 
   :oe:func:`OEChem::OEClearPDBData`.

*  Added support for determining whether the library is properly licensed
   with :oe:func:`OEChem::OEChemIsLicensed` function.

*  Added :oe:func:`OEChem::OEResidueHydrogens` function that will rename
   hydrogens an a heavy atom to their proper PDB atom names.

Major bug fixes
--------------------------------------------------------------------------------

*  Fixed :oe:meth:`OEChem::oemolistream::seek` and :oe:meth:`OEChem::oemolistream::tell` 
   to take into account any cached molecules that may exist in the stream.

*  Fixed low-level MDL reader to accept multiple SD tags with the same tag.
   
   .. note::

      It is not clear from the SD file specification if this is a valid SD
      format.

Minor bug fixes
--------------------------------------------------------------------------------

*  Added PDBData readers and writers to OEBinary file handlers.

*  Added defensive code to :oe:meth:`OEChem::OEMolBase::DeleteAtom` and
   :oe:meth:`OEChem::OEMolBase::DeleteBond` to confirm that the atom or bond are owned by that
   specific molecule.

*  Fixed rotation bug in inertial frame alignment.

*  Converted inconsistent ``/`` and ``\`` into a warning rather than
   an error, allowing the molecule to be parsed in a racemic fashion.

*  Added an upper bound to the degree of the atoms at either end of a
   cis-trans chiral double bond.

*  Added defensive code to prevent creation of atoms with atomic number
   greater than 255.

*  Improved perception of non-aromatic exo double-bonds.  This corrects a
   problem perceiving the progesterone in ``pdb1a28``.

*  Improved the exo-cyclic double bonds to sulfur.  This improves the
   connectivity perception in ``1hnv``, ``1rev``, ``1usn``, ``1uwb``, 
   ``2usn``, ``3usn`` and ``1zxv``.

*  Improved the bond order perception of nitroso, oxime, azide, and
   arylhydroxylamine functional groups.

*  Improved bond order perception of clashed structures by allowing
   hydrogens to only bond to their nearest heavy atoms.

*  Prevent alternate conformation representations to be bonded to one
   another during bond perception.

*  Made Up/Down choice for the first stereo bond in each resonance system
   canonical for writing isomeric smiles files.

*  Made :oe:func:`OEChem::OECanonicalOrderBonds` also order the bonds obtained with the
   :oe:meth:`OEChem::OEAtomBase::GetBonds` function call.

*  Fixed bug in binary search for atomic number ``0`` used in
   :oe:func:`OEChem::OEIsCommonIsotope`, :oe:func:`OEChem::OEGetAverageWeight` and
   :oe:func:`OEChem::OEGetIsotopicWeight`.

*  Fixed the high-level pdb writer to preserve residue information found on
   the molecule.

*  Corrected :oe:func:`OEChem::OEIsReadable` to return false for the MOPAC file format.

*  Added MOPAC flavors to the high-level molecule writers.

*  Changed the hybridization assignment of negatively charged resonant
   nitrogens such as ``*S(=O)(=O)[N-]C(=O)*``.

*  Fix bug in :oe:func:`OEChem::OESet3DHydrogenGeom` the could use a hydrogen's own
   coordinates as a reference for determining its geometry.

*  Fix ring perception bug in :ref:`OEMCSMaxAtomsCompleteCycles <OEChem_OEMCSMaxAtomsCompleteCycles>`.

*  Eliminate the redundancy between `OEChem::OEMDLSetBondStereo` and
   :oe:func:`OEChem::OE3DToBondStereo` by allowing :oe:func:`OEChem::OE3DToBondStereo` to take an 
   optional bond mask and work on 2D as well as 3D molecules.

*  Correct a bug in the *OEChem* interpretation of MDL wedge and hash bonds.
   In MDL connection tables, wedges and hashes only imply a specified stereo-center
   at the thin end (*i.e.* :oe:meth:`OEChem::OEBondBase::GetBgn`).  This has been confirmed by
   comparing the wedge/hash bonds with the atom stereo parity bit in MDL ISIS
   output (including large vendor databases such as the entire Asinex 2005
   collection).

*  Fixed MDL reader bug where unrecognized atomic symbols would ignore
   subsequent fields in the atom block such as stereo parity, reaction role and
   valence.

*  Added copy constructors and assignment operators to `OEMiniMols`,
   `OEChem::OEMiniBonds` and `OEMiniAtoms`.

*  Fixed a sign error in :oe:func:`OEChem::OESetAngle`.

*  Added a length==0.0 check for :oe:func:`OEChem::OESetDistance` and 
   :oe:func:`OEChem::OESetAngle`.

New Example Programs
--------------------------------------------------------------------------------

These examples show the best feature of *OEChem*.  Though most are less than 100
lines of simple code they demonstrate protein-protein sequence alignment, 2D
and 3D structure manipulation, residue perception, robust multi-format I/O, stl
integration, canonicalization, chirality perception and manipulation and many
other complex cheminformatics tasks.  While the main loop of each program is
often only 30 lines long, it brings to bear thousand of lines of *OEChem* code
and years of cumulative cheminformatics experience to easily combine 2D and 3D
structure analysis and manipulation.

*  ``backbone.cpp``: Code to show the use of functors to select and write the
   backbone atoms of a protein.

*  ``cischeck.cpp``: Demonstrates how to loop over residues and checking the
   omega torsion for cis amides.

*  ``makealpha.cpp``: A code example of protein structure manipulation.  This
   example modifies any protein into an alpha-helical structure with extended
   side-chains.

*  ``phipsi.cpp``: Simple code to report the phi-psi angles of a protein.

*  ``rescount.cpp``: Demonstrates an easy way to loop over the residues of a
   protein and query their information.

*  ``reshist.cpp``: Demonstrates and easy way to loop over a protein's residues
   and integrate the acquired data into an STL ``dictionary`` class.

*  ``seqalign.cpp``: This is perhaps the most complex program of the examples.
   It carries out protein-protein sequence alignment, alignment evaluation and
   printing as well as 3D structural alignment.

*  ``subsetres.cpp``: Simple code example of how to pull a specific residue out
   of a protein using its common name(*e.g.* ARG B 52).

*  ``swapaieres.cpp``: Demonstrates how a user can select a residue using its
   common name (*e.g.* GLN 252) and swap the ambiguous iso-electronic atoms.

OEBio 1.4.0
================================================================================

New Features
--------------------------------------------------------------------------------

*  Added :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` class with associated features for pairwise
   sequence alignment (including PAM250, BLOSUM62 and GONNET), writing an
   alignment to an :ref:`oeostream <OEPlatform_oeostream>` and carrying out RMSD alignment between two
   proteins based on the sequence alignment.

*  Simple methods for accessing and manipulating the torsion angles of
   biopolymers.

*  Introduce classes that allow a hierarchical view of the Chains, Fragments
   and Residues of a protein while maintaining the efficient *OEChem* internal data
   structures.

*  Added facility for swapping the terminal atoms of residues that are
   commonly ambiguous in protein crystal structures (*e.g.* terminal N,O of
   ASN).

*  Added nine new example programs demonstrating the use of the new *OEBio*
   API points.  These include: ``backbone``, ``cischeck``, ``makealpha``, 
   ``phipsi``, ``rescount``, ``reshist``, ``seqalign``, ``subsetres`` and 
   ``swapaieres``.

OESystem 1.4.0
================================================================================

New Features
--------------------------------------------------------------------------------

*  Moved superpose and tensor2mat API points from *OEChem* to *OESystem*.  Added
   deprecated support for their use in *OEChem*.

*  Added ability to assign an ``OEIterBase<foo>*`` to an
   ``OEIter<const foo>`` object.  This allows much wider use of iterators of
   const objects.

*  Made :oe:meth:`OESystem::OEIter::Sort` a stable sort.

*  Additional physical constants added to :oe:constns:`OEMath::OEConst<OEMath::OEConst>`.

*  Added the ability to parse :ref:`OEInterface <OESystem_OEInterface>` parameter files without use of
   command-line parsing.

*  New `OEChem::OEPDBOFlag::ELEMENT` and `OEChem::OEPDBOFlag::FORMALCHARGE` 
   flavors for pdb writer.
   `OEChem::OEPDBOFlag::ELEMENT` adds the atomic symbol to columns 77-78 and 
   `OEChem::OEPDBOFlag::FORMALCHARGE`
   add non-zero formal charges in columns 79-80.

*  Extended the :oe:const:`OEChem::OEOFlavor::SMI::ExtBonds` option from the ``.smi`` 
   writer to the ``.can`` and ``.ism`` writers.

Major bug fixes
--------------------------------------------------------------------------------

*  Protected the :oe:meth:`OESystem::OEIter::Sort` function from NaN (not a number)
   members.

Minor bug fixes
--------------------------------------------------------------------------------

*  Fixed OEGrid and OEMultiGrid constructor bug that could cause no
   memory to be allocated for the grid elements.

*  Corrected behavior of :oe:meth:`OESystem::OEGrid::Clear` to clear the :ref:`OEBase <OESystem_OEBase>`
   data, remove the title and reinitialize all the elements of the grid.

*  Fixed rotation bug in inertial-frame alignment.

*  Fixed bug in the atom index into coordinates used while calculating the
   center of mass.

*  Fixed bug in the calculation of :oe:meth:`OESystem::OEMultiGrid::SetSpacing` and
   :oe:meth:`OESystem::OEMultiGrid::SetMid` functions.

*  Fixed :ref:`OEInterface <OESystem_OEInterface>` category name bug, ``!KEYLESS`` bug and
   unterminated category bug.

OEPlatform 1.4.0
================================================================================

New Features
--------------------------------------------------------------------------------

*  Improved binary data handling in streams.

*  Significant improvements for user convenience in licensing code will
   allow future versions of *OpenEye* applications to manage licensing failures in a
   friendly manner.

Major bug fixes
--------------------------------------------------------------------------------

*  Fixed bug that prevented reading the final molecule in a file and then
   seeking to other positions in the file.

*  Fixed a 64bit stream seek and read bug that could cause memory overflows
   and crashes.

Minor bug fixes
--------------------------------------------------------------------------------

*  Fixed bug in cross-platform directory searching and checking for files on
   a file system.

*  Fixed bug in `OEPlatform::oeigzstream::size` that reported incorrect 
   sizes in some instances.

*  Added the ability to detect moved home directories under Windows.




********************************************************************************
Version 1.4.1
********************************************************************************

OEChem 1.4.1
================================================================================

*OEChem* 1.4.1 was an internal *OpenEye* release only.  All associated
release notes have been incorporated into the *OEChem* 1.4.2 release
notes (see above).



********************************************************************************
Version 1.4.2
********************************************************************************

OEChem 1.4.2
================================================================================

*OEChem* 1.4.2 is a bug fix release including dozens of minor and major bug
fixes.  It also includes numerous new minor features, and also brings
significant practical changes.  *OEChem* 1.4.2 is the first *OEChem* that is being
released along with all the other public *OpenEye* toolkits.  This will be a
major step forward for inter-operability between different *OpenEye* toolkits and
will open the way for easier support of customer applications that span
multiple *OpenEye* toolkits.

*OpenEye* continues to be committed to maintaining a stable *OEChem* API and thus
any programs written with previous versions of *OEChem* should re-build with the
1.4.2 version of *OEChem*.  However, as is the nature of C/C++ code, particularly
C++ template code, some of the bug fixes are in header files, so dependent
libraries such as most other *OpenEye* libraries may require a re-link.

*OEChem* 1.4.2 will be the first release in which *OpenEye* is beginning to move
toward synchronizing our library releases.  This will remedy problems some
people have experienced with link-problems when combining three or more *OpenEye*
libraries into a single application. 

Major bug fixes
--------------------------------------------------------------------------------

*  Added safeguards against stack over-runs in all molecule implementations.

*  Fixed a major bug in rotor-offset compressed OEBinary file handling that
   made these molecules fragile with respect to molecule copies.

*  Fixed thread-safety of reading SMILES.

*  Fixed crash-bug when :oe:func:`OEChem::OEPerceiveResidues` was called on unusual
   small-molecule peptide mimics such as ``O=CC(C)NC(C)C=O``.

*  Fixed dummy-atom handling in the CDX reader.  Also improves
   implicit-hydrogen handling, but limits the reader to reading a single
   connection table.  

*  Corrected failure to include Isotope information in OEBinary files.

*  Fixed crash-bug from processing stereochemistry on MDL atoms with degree
   three having hashes and wedges.

*  A major oemolistream bug was fixed by fixing a stream bug (see
   *OEPlatform*'s Major bug fixes above).

*  Fixed a bug where :ref:`OELibraryGen <OEChem_OELibraryGen>` failed to convert an aromatic ring
   to aliphatic accurately.

Minor bug fixes
--------------------------------------------------------------------------------

*  Dramatic improvement in the search speed of disconnected SMARTS such as
   ``(*).(*)``.

*  Speed optimizations were added to molecular geometry manipulations.

*  Fixed very rare search-path bug in aromaticity perception.

*  Allow support for ``C[N@H]O`` and ``C[N@@H]O`` in SMILES output.

*  Fixed side-effects of :oe:func:`OEChem::OECanonicalOrderBonds` on stereochemistry.

*  Added BondIntType I/O in OEBinary format.

*  Improve :oe:func:`OEChem::OEKekulize` fall-backs to it fails gracefully.

*  Add support for fully explicit Hydrogen flavor in SMILES (*i.e.* ``[CH4]``).

*  Fixed bug in the over-application of constraint for MCS searches.

*  Added support for aromatic lead, aluminum, germanium and tin.

*  Improved support for MDL's V3000 format.

*  Improved perception of cationic N.pl3 atoms with partial charge greater
   than one.

*  Added protection to SMILES writer for molecules with a terminal single
   bond that has stereochemistry specified.

*  Fixed initialization of OEBinaryHandlers.

*  Added support for the aromaticity model being used to effect chirality
   perception.

*  Improved carbon dioxide, acetonitrile, cyanamide, cyanic acid and
   thiocyanic acid fragment recognition in bond perception algorithms.

*  Fixed rounding error in :oe:func:`OEChem::OENetCharge` function.

*  Fixed endian bug in CDX reader for OS X.

*  Added protection from molecule titles >4K in length.

*  Added proper support for comments in MOPAC files.

*  Improved copy construction and assignment of :ref:`OEQAtomBase <OEChem_OEQAtomBase>` and
   :ref:`OEQBondBase <OEChem_OEQBondBase>`.

*  Added :oe:const:`OEChem::OEOFlavor::PDB::HETBONDS` flavor to the PDB writer that 
   causes any bond to or from a ``HETATOM`` to be written explicitly.  
   The HETBONDS flavor now part of the default
   output.

*  Added support for ``UNK`` atoms attached to a backbone and ``LIG`` atoms
   that are covalently bound ligand or post-translational modifications to be
   given the same chain ID and residue number as the residue to which they are
   bonded.

*  Added :oe:func:`OEChem::OESymmetryNumber` to calculate the symmetry number of a given
   conformer within a user-defined threshold.

*  Fixed bug that lost SD data attached to an :ref:`OEMol <OEChem_OEMol>` (not its conformers)
   when the molecule was written to OEB (Note, SD data is not generally stored on
   the parent molecule).

*  Fixed :oe:meth:`OEMCMolBase::OrderConfs<OEChem::OEMCMolBase::OrderConfs>` OS X memory bug.

*  Fixed strip salts to only count heavy atoms in determining the fragment
   with the largest size.  This makes the behavior remain consistent with implicit
   and explicit hydrogens.

*  Added support for ``x`` in SMARTS as defined in v4.9 of Daylight's toolkit. 

*  Prevent PDB writer from generating ``CONECT`` records that have the same
   serial number for the source and destination.

*  Fixed bug in automorphism calculations on molecules with hydrogen-defined
   cis-trans bond stereo.

*  Improved algorithm for perception of 3D bond stereo.

*  Added support for stable serial numbers, alternate locations, insertion
   codes and heteroatoms during calls to :oe:func:`OEChem::OEPerceiveResidues`.

*  Improved heuristics for residue perception in the presence of unusual
   chain terminations.

OEBio 1.4.2
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

*  Changed OEHierView constructor to assume initial perception has already
   occurred.  This prevents the constructor from over-aggressively re-perceiving
   residue information.

Minor bug fixes
--------------------------------------------------------------------------------

*  Made command-line usage more explicit for ``subsetres`` example.

*  Improved output format at water categorization for ``rescount`` example.

*  Converted `OEBio::GetChis` to :oe:func:`OEBio::OEGetChis`.

*  Improved support for g++ 4.x.

*  Corrected bug so that a new chain automatically starts a new fragment and
   a new chain or new fragment automatically start a new residue.

*  Fixed bug in **OEGetAtoms** from a  residue's flood-fill algorithm.

OESystem 1.4.2
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

*  Fixed bug that caused all the :ref:`OEErrorHandler <OESystem_OEErrorHandler>` parameters to be reset to
   default values when the stream was reset.

*  Increased error handler buffers to 8K to prevent crashes with very large
   warning and error messages.

*  Added specific handling of :oe:const:`OESystem::OEErrorLevel::Verbose` that was previously
   missing.

*  Protect Hanoi sort routine from sorting lists of size 0 or 1.

*  Prevent parameter mismatches in :ref:`OEMultiGrid <OESystem_OEMultiGrid>`'s owned grids.

Minor bug fixes
--------------------------------------------------------------------------------

*  Improved efficiency of sorting in OEIter class and fixed bug in the
   :ref:`OEBinaryPredicate <OESystem_OEBinaryPredicate>` sort implementation.

*  Added Push, Sort and the NonConst constructor to the primitive
   specializations of OEIter.

*  Allowed weighting of coordinates in inertial tensor and inertial
   alignment routines.

*  Fix :oe:meth:`OESystem::OEBitVector::FromHexString` function to skip over end of line
   characters in the input.

*  Allow :ref:`OEBitVector <OESystem_OEBitVector>` to properly read ``std::vector<bool>``.

*  Allow quoting parameter values in :ref:`OEInterface <OESystem_OEInterface>` parameter files.

*  Fixed bug in wildcard matching for :ref:`OEInterface <OESystem_OEInterface>` string parameters.

*  Fixed auto-link warnings resulting from ``--help html``.

*  Added :oe:meth:`OESystem::OEFixedGrid::SetValues` (note, the size of the grid is not mutable).

*  Fixed float/double precision bug in :oe:func:`OESystem::OEStringToNumber`.

OEPlatform 1.4.2
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

*  Improved support for both MSVC and mingw on 32 bit Windows.

*  Improved 64 bit support.

*  Improved compatibility with HPUX and IRIX64

*  Improved support for gcc 4.x.

Major bug fixes
--------------------------------------------------------------------------------

*  Fixed bug in :oe:meth:`OEPlatform::oeistream::close` that prevented 
   :oe:meth:`OEChem::oemolistream::close` from
   returning the molstream to a default state.

*  Fixed a size-check bug in low-level binary i/o routines.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



********************************************************************************
Version 1.5.0
********************************************************************************

OEChem 1.5.0
================================================================================

OEChem 1.5.0 is a new release including many major and minor bug fixes
along with several new features. This is also a continuation of a
complete release of all *OpenEye* toolkits as a consolidated set so that
there are no chances of incompatibilities between libraries.

Note, that in this release the directory structure has been changed to
allow multiple versions of the toolkits to be installed in the same
directory tree without conflicts. From this release on, all C++
releases will be under the openeye/toolkits main directory. There is
then a directory specific to the version of the release and then below
that, directories for each architecture/compiler combination. To
simplify end user Makefiles, ``openeye/toolkits/lib``,
``openeye/toolkits/include'', and ``openeye/toolkits/examples`` are
all symlinks to the specific last version and architecture that was
installed.

New users should look in ``openeye/toolkits/examples`` for all the
examples. Existing users updating existing Makefiles should change
their include directory from ``openeye/include`` to
``openeye/toolkits/include``.  As well, existing Makefiles should
change the library directory from ``openeye/lib`` to
``openeye/toolkits/lib``.

New features
--------------------------------------------------------------------------------

*  *OEChem* now has a 2D similarity implementation using the Lingos
   method of similarity. Lingos compares Isomeric SMILES strings
   instead of pre-computed fingerprints. This combination leads to very
   rapid 2D similarity calculation without any upfront cost to
   calculate fingerprints and without any storage requirements to store
   fingerprints.

*  MMFF94 charges are now available in *OEChem*. While we recommend
   AM1-BCC charges as the best available charge model, having MMFF94
   charges available at the *OEChem* level means that decent charges are
   available to all toolkit users.

*  In *OEChem* 1.2, there was an alternate implementation of MCS that
   used a fast, approximate method for determining the MCS. While it is
   less than exhaustive, the speed does have some appealing uses. In
   *OEChem* 1.5, we've restored this older algorithm and now both are
   available.

   .. code-block:: c++

      namespace OEMCSType
      {
        static const unsigned int Exhaustive  = 0;
        static const unsigned int Approximate = 1;
        static const unsigned int Default     = Exhaustive; 
      }

   :oe:const:`OEChem::OEMCSType::Exhaustive` implies the current, exhaustive algorithm from
   *OEChem* 1.3 and later, while   :oe:const:`OEChem::OEMCSType::Approximate` implements the
   older, fast but approximate algorithm.

*  The ability to get the license expiration date when calling
   :oe:func:`OEChem::OEChemIsLicensed` has been added.

*  Molecules (:ref:`OEMol <OEChem_OEMol>`, :ref:`OEGraphMol <OEChem_OEGraphMol>`) can now be attached to
   an existing :ref:`OEBase <OESystem_OEBase>` as generic data and they will be written to OEB and
   read back in.  Additional support for attaching grids and surfaces to
   molecules has been added to Grid and Spicoli.

*  There is a new retain Isotope flag to :oe:func:`OEChem::OESuppressHydrogens`. If
   false, ``[2H]`` and ``[3H]`` will also be removed by this call. By default,
   this is true so that the current behavior of :oe:func:`OEChem::OESuppressHydrogens` is
   identical to the previous version.

*  The *OEChem* CDX file reader can now Kekulize aromatic (single)
   bonds in the input ChemDraw file. It switches the internal bond
   order processing to use the bond's integer type field, and then
   calls :oe:func:`OEChem::OEKekulize` to do all of the heavy lifting.

*  Tweaks to the algorithm used for determining which bond(s)
   around a stereocenter should bear a wedge or a hash.  The bug fixed
   here includes an example where all three neighbors are
   stereocenters, but two are in a ring and one isn't.

*  There are new versions of :oe:func:`OEChem::OEIsReadable` and 
   :oe:func:`OEChem::OEIsWriteable` that  take a filename directly.

*  More exceptional atom naming support for the PDB residues CO6
   (pdb2ii5), SFC (pdb2gce), RFC (pdb2gce), MRR (pdb2gci), MRS
   (pdb2gd0), FSM (pdb2cgy) and YE1 (pdb2np9) has been added.

Major bug fixes
--------------------------------------------------------------------------------

*  The Bondi VdW radii tables have been completely updated and
   fixed.  Additionally, any element not covered by the original Bondi
   paper is assigned a radius of 2.0 |Angstroms|.

*  Corrected a serious glitch in the *OEChem* SMILES parser, where
   ``[X-2]`` would be incorrectly interpreted as ``[X+2]``.  This bug was
   an unintentional side-effect of the recent changes to warn about
   ``[X+0]`` and ``[X-0]`` when the parser is in strict mode.

*  Fixed a bug in :oe:func:`OEChem::OEKekulize` of very large molecules. Almost all
   small molecules continue to use the faster light-weight method, but
   we avoid exponential behavior for the large non-Kekulizable cases.

*  Fixed a bug dealing with the semantics of wedge/hash bonds when
   the thin end is on a terminal atom.  Clearly, in such cases the
   author probably intended to specify some aspect of the chirality of
   the atom at the other end of the bond.  First, when drawing such
   structures into MDL's ISIS/Draw, it does not perceive specified
   chirality at the thick end of a wedge/hash bond from a hydrogen.
   However, this patch adds support for conveniently handling this case
   via :oe:func:`OEChem::OEMDLHasIncorrectBondStereo` and 
   :oe:func:`OEChem::OEMDLCorrectBondStereo`, which
   notices this case, and either inverts the sense of the bond if the
   other end has explicit degree three or four, or removes the ignored
   *wedge/hash* bond annotation.

*  Bug-fix improvement to :oe:func:`OEChem::OEMDLCorrectBondStereo` such that whenever
   we introduce a new wedge/hash bond (on a previously unmarked bond),
   we now ensure that the we correctly set the thin end on the
   appropriate chiral atom.

*  Fixed a bug in OEB reading/writing that makes sure that any
   unknown tags are simply passed from input to output without loss.

*  Fixed a bug in reactions where the final valence was being
   computed incorrectly, such that the bond orders aren't modified directly
   until after valence correction is applied.

Minor bug fixes
--------------------------------------------------------------------------------

*  Tweaked the way the SMILES parser calculates implicit hydrogen
   counts on un-bracketed aromatic atoms in SMILES strings.  This fixes
   ``Scc`` and ``S1cccc1``.

*  :oe:func:`OESystem::OEParseCommandLine` now lists the legal and illegal values for a
   parameter if the user specifies an invalid value for the parameter.

*  Fixed a bug where a warning was issued when writing >999 atoms
   to a V3000 MOL file. V3000 MOL files can contain >999 atoms, unlike
   V2000 files.

*  Fixed a bug where round-off differences between Windows and
   Linux could result in stereo perception differences for 2D
   coordinates with angles very nearly equal to 180 degrees.

*  Corrected the atomic number perception in the PDB file reader
   for the residues "G5P", "COK" and "COZ" (from the recently added PDB
   files pdb2f35, pdb2ges and pdb2g2z).

*  Added residue perception support for the nonstandard amino
   acids "LYZ" and "MEN", which denote 5-hydroxylysine and
   N-methylasparagine.

*  Fixed a bug where :oe:func:`OEChem::OEGetHybridization` failed to classify the
   sulfur in ``C=S`` as sp2 hybridized.

*  Completed the coverage of the MDL valence model to all atoms to
   handle charges less than or equal -2, or greater than or equal to
   +2. Many of the common cases of these strange charge states were
   already handled.

*  The generic data reader now calls AddData instead of SetData.
   This means that multiple objects with the same tag can be handled
   appropriately.

*  Added checks to prevent division-by-zero in several geometry
   routines in *OEMath*.

*  :oe:func:`OEChem::OESetComment` now safer to either a NULL pointer for the comment
   or a NULL pointer for the :ref:`OEAtomBase <OEChem_OEAtomBase>`.

*  Fixed copy constructor and assignment operator for :ref:`OECoordArray <OEChem_OECoordArray>`.


********************************************************************************
Version 1.5.1
********************************************************************************

OEChem 1.5.1
================================================================================

New features
--------------------------------------------------------------------------------

*  Added new :oe:func:`OEChem::OEAssignFormalCharges` function that operates on a 
   single atom instead of just a version for the entire molecule. 

*  Renamed the **OESystem::ParamVis** namespace to
   :oe:constns:`OESystem::OEParamVisibility` to make it consistent with
   other *OpenEye* namespaces.

Mayor bug fixes
--------------------------------------------------------------------------------

*  Fixed two bugs in kekulization of large molecules. First, some large
   molecules would fail kekulization when they were actually ok. Second, even
   when they were kekulized correctly, the method would still return false. 

*  This tweaks the MDL mol file reader to use the test ``dimension !=
   3`` instead of "dimension == 2" when deciding to honor the
   wedge/hash bonds or to determine the chirality from 3D
   coordinates.  The subtle difference is that at the point this code
   is called, the dimension is not necessarily "2" or "3" if the
   (optional) header line is missing.  If the header has been omitted,
   we treat the molfile like a 2D file (which it most probably is).
 
*  Changed SMARTS parser to allow a TAB character (``\t``) to be
   treated as a separator following a SMARTS pattern.  This reflects
   similar functionality in the SMILES parser and simplifies the task
   of writing "patty"-like applications.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



********************************************************************************
Version 1.6.0
********************************************************************************

OEChem 1.6.0
================================================================================

New features
--------------------------------------------------------------------------------

*  *OEChem*'s PDB residue perception code now follows the changes required
   by the PDB version 3.0 standard.  This includes disambiguation of the DNA
   residues "DA", "DC" and "DG" from the RNA residues "D", "C" and "G".  Nucleic
   acid backbone atom names now end in an apostrophe instead of a star/asterisk.
   The default ligand name in *OEChem* is now "UNL" instead of "MOL" or "LIG".

*  There have been significant improvements to *OEChem*'s bond order
   perception code including phosphates, thiophosphates, dithioic acids,
   oximes, aldoximes, sulfur oxides, sulfites and iron-sulfur clusters.

*  The cis/trans detection logic in :oe:func:`OEChem::OE3DToBondStereo` has been
   robustified to do better with 2D depictions containing bonds that are
   co-linear with a chiral double bond or have zero length.  The code now
   continues searching for additional incident bonds that have non-zero
   length and aren't co-linear.

*  Significant improvements have been made to *OEChem*'s DNA/RNA perception
   code.  The code now handles/recognizes truncated RNA biopolymers, and
   recognizes the bases "1MA", "2MC", "5MC", "5MU", "7MG", "M2G", "OMG", "OMC",
   "PSU", etc...

*  *OEChem*'s residue perception code now handles/recognizes a much larger
   set of common co-factors and ligands, including "ADP", "ATP", "DMS", "EDO",
   "FAD", "HEM", "NAD", "NAG", "PEO" etc...

*  *OEChem*'s residue perception code now handles the nonstandard amino
   acid ornithine (ORN).

*  A new :oe:func:`OEChem::OEAssignFormalCharges` function variant has been added
   to the *OEChem* API to allow assignment of formal charges on a specific
   :ref:`OEAtomBase <OEChem_OEAtomBase>` pointer.
   The existing :oe:func:`OEChem::OEAssignFormalCharges` function
   continues to operate on the whole molecule.

*  A new :oe:const:`OEChem::OEPreserveResInfo::AtomName` flavor has been added to
   the :oe:constns:`OEChem::OEPreserveResInfo` namespace to allow the 
   :oe:func:`OEChem::OEPerceiveResidues`
   function to preserve the original PDB atom name.

*  The *OpenEye* formal charge model has been extended such that a
   four-valent aluminum (aluminium) now has an implicit negative charge,
   and aluminum ions have a +3 formal charge.  The model has also been
   tweaked to consider the sulfurs in iron-sulfur clusters as neutral
   ``[S]`` radicals.

*  The *OpenEye* hydrogen count model has been tweaked to prefer
   five-valent phosphorus, such as ``O=[PH2]O`` over three-valent
   ``O=PO``.

*  The values returned by :oe:func:`OEChem::OEGetAverageWeight` have been updated
   and revised to follow the latest (2007) recommendations of the IUPAC
   Commission on Isotopic Abundances and Atomic Weights.

*  The :oe:func:`OEChem::OEParseSmarts` and :oe:func:`OEChem::OEParseSmirks` 
   functions have been enhanced to allow a TAB character ``\t`` to be treated
   as a separator after a SMARTS pattern.  This matches the behavior of the
   SMILES parser, :oe:func:`OEChem::OEParseSmiles`, and simplifies the task of writing
   "patty"-like applications.

*  The *OEChem* SMILES and SMARTS parsers have been tweaked to allow
   the backslash used in specifying cis/trans stereochemistry to be
   duplicated in the input string, *i.e.* 
   ``C\\C=C\\C`` is now interpreted as ``C\C=C\C``.  This is
   convenient when working with programming languages such as C and C++
   where the backslash is used as an escape character.  Embedding SMILES in
   C/C++ source files requires the strings look like
   ``C\\C=C\\C`` which previously couldn't be cut'n'paste like regular SMILES strings.

*  The interpretation of acyclic aromatic elements by *OEChem*'s SMILES
   reader now more accurately follows the Daylight toolkit.  For example,
   ``n`` is interpreted as ``[NH2]`` and not ``[N]``, and ``nn`` now means ``N=N``
   instead of ``[N]=[N]``.

*  Fixed an obscure corner case in the *OEChem* SMILES writer, when
   not performing aromaticity perception and using the low-level SMILES
   writer.  We need to preserve the explicit single bond (hyphen/minus) in
   ``[cH2]-[cH2]`` otherwise ``[cH2][cH2]`` would get
   interpreted like ``cc`` and result in ``c=c`` and ``[cH2]=[cH2]``.

*  The MDL file format reader has been enhanced to allow TABs in addition
   to spaces as separators in ``M CHG``, ``M RAD`` and ``M ISO`` lines.

*  The Sybyl ``.mol2`` file format reader has been enhanced to recognize
   pyrylium-like ring systems, containing charged oxygen atoms.  A minor
   bug has also been fixed that could assign inappropriate formal charges
   to substituted nitrates.

*  In Sybyl ``.mol2`` format files, the atoms types ``d`` and ``t`` are now
   treated identically to ``D`` and ``T`` and interpreted as Deuterium and
   Tritium respectively.  Previously, they'd be interpreted as hydrogen
   atoms, but the isotope specification wasn't getting set.

*  The Tripos bond types in Sybyl .mol2 format files are now treated
   as case-insensitive.  We now treat ``AR`` and ``Ar`` as identical to ``ar``,
   and ``AM`` and ``Am`` as identical to ``am``, etc...

*  The CambridgeSoft CDX file format reader has been significantly
   rewritten to address bugs in the reading/writing of 3D coordinates.

*  The *OpenEye* OEB file format reader is now more robust to invalid,
   corrupt and/or truncated input files.

*  Added versions of :oe:func:`OEChem::OEIsReadable` and 
   :oe:func:`OEChem::OEIsWriteable` that can directly take a filename or extension.

*  Significant work was done on SD data robustness.

   * If SD data was attached to an :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` and an
     :oe:cls:`OEConfBase<OEChem::OEConfBase>` then written to OEB and read back into an
     :ref:`OEMolBase <OEChem_OEMolBase>` the data from the :oe:cls:`OEConfBase<OEChem::OEConfBase>`
     would appear to disappear. This would result in losing the data if then written to SDF.

   * SD data attached to an :ref:`OEMolBase <OEChem_OEMolBase>`, written to OEB, then
     read into an :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` will now be attached to the
     :oe:cls:`OEConfBase<OEChem::OEConfBase>` instead of the 
     :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>`.

   * Significant speed improvements were made to SD data (*e.g.* csv2sdf saw
     a 4-fold speed improvement).

   * See :ref:`section_oemol_sddata` in the programming theory
     manual for more details.

*  The :oe:func:`OEChem::OEReadPDBFile` and :oe:func:`OEChem::OEWritePDBFile` functions are
   able to read and write ANISOU records, respectively.  ANISOU
   records, which are atom property representing anisotropic
   temperature factors in PDB, are scaled by a factor of :math:`10^4` and
   represented as integers.
*  :oe:func:`OEChem::OEGetCenterOfMass` function, which computes the center of
   mass of a molecule (with or without atomic weights), was added to
   the ``OEChem`` namespace.

Major bug fixes
--------------------------------------------------------------------------------

*  The algorithm that generates canonical SMILES did not ignore
   cis/trans stereo hydrogens and produced ``[H]N=CC``, rather
   than the correct ``N=CC`` canonical SMILES.

.. warning::

   Even though this bug fix has affected only a small
   percentage of canonical SMILES, we highly recommend the
   regeneration of all canonical SMILES.

*  Small improvements have been made to the generation canonical
   isomeric smiles.

*  A problem has been fixed in *OEChem*'s Kekulization algorithms for
   large molecules (with between 250 and 1000 atoms) that can't be
   assigned a valid |Kekule| form.  The changes in *OEChem* 1.5.0 that
   attempted to assign as much of a |Kekule| form as possible upon
   failure could occasionally lead to :oe:func:`OEChem::OEKekulize`
   returning ``true`` for an invalid molecule.

*  A performance problem in *OEChem*'s aromaticity perception has been
   resolved.  Previously pathological substituted fullerenes and PAHs could
   cause *OEChem*'s aromaticity routines to take over a minute to perceive all
   of the conjugated cycles.  Algorithmic improvements to *OEChem*'s aromaticity
   perception now allow all of the reported cases to be processed in a fraction
   of a second.

*  A rare problem interpreting the stereo from wedge/hash bonds around
   atoms of degree three has been resolved.  When we have two bonds in the
   plane, and the third marked as a wedge or a hash, we need to determine
   whether the raised/lowered bond is in the larger or smaller sector
   subtended by the two in-plane bonds.  A bug in this code failed to handle
   the case when all three bonds lay in the same half-circle.  This problem
   is extremely rare, for example, no cases were found in the 250,251 MDL
   connection tables distributed by the NCI as the NCI August 2000 database.

*  Memory leak problem was fixed in :ref:`OELibraryGen <OEChem_OELibraryGen>`.

Minor bug fixes
--------------------------------------------------------------------------------

*  The *OEChem* MDL mol file reader has been improved to allow the
   dimension field in the connection table header line to be omitted,
   and still correctly decide whether to process wedge/hash bonds or 
   determine chirality from 3D coordinates.  Previously, the molecule's
   stereochemistry would be set incorrectly if the optional header line
   was missing.

*  The MDL file reader now perceives aromatic cycles using the MDL
   aromaticity model prior to calling :oe:func:`OEChem::OEPerceiveChiral`.  This
   ensures that alternate |Kekule| forms of substituted phenyl rings (for
   example) don't inappropriately split symmetry groups, causing achiral
   double bonds to acquire specified cis/trans stereochemistry.

*  An aesthetic improvement has been made to the rules used in
   the :oe:func:`OEChem::OEMDLPerceiveBondStereo` function that assigns wedge and
   hash bonds to depictions.  For acyclic bonds, we now prefer to place
   the wedge or hash on bonds to non-ring atoms.  A typo in the previous
   rules reversed this priority.

*  The *OEChem* SMILES writer was being miscompiled on IBM AIX 5.x
   resulting in canonical SMILES that differed from those on other platforms.
   The code has been rewritten to avoid the issue in IBM's xlC compiler,
   so the SMILES are once again identical to the other platforms.

*  The *OEChem* PDB file parser has been updated to reflect the latest
   atom name exceptions in the RCSB/wwPDB database.  These changes should
   eliminate the spurious Holmium and Helium atoms perceived in recently
   added ligand residues.

*  Numerous small performance improvements have been made to *OEChem*.

*  The torsion cutoff values for perceiving cis/trans
   bond stereo from 3D are relaxed in :oe:func:`OEChem::OE3DToBondStereo` function.
   The cis cutoff is increased to 30 from 15, the trans cutoff is lowered
   to 150 from 165.

*  Even when the maximum number of matches is set, the MCS search
   can not be terminated upon reaching this limit, since there is no
   guarantee that the maximum common substructure has been detected.
   Instead, the search continues, then the best *N* matches are returned,
   where *N* is set by :oe:meth:`OEChem::OEMCSSearch::SetMaxMatches`.

*  The exhaustive and the approximate MCS algorithms no longer use different
   functions to determine whether a match is unique or not. Several other small
   problems were fixed in order to ensure that all matches located by the
   approximate method are also detected by the exhaustive one.

*  After changing the atomic number of an atom with
   :oe:meth:`OEChem::OEAtomBase::SetAtomicNum`, the aromaticity and chirality of
   the molecule have to be re-perceived with the
   :oe:func:`OEChem::OEAssignAromaticFlags` and :oe:func:`OEChem::OEPerceiveChiral` 
   functions, respectively.

*  Improved the stability of :oe:func:`OEChem::OEPerceiveResidues` to not
   reorder atoms.

*  An API point was added to :ref:`OELibraryGen <OEChem_OELibraryGen>` to change the
   character used to separate product molecules title when
   concatenating reaction molecule titles together.  For more
   information see :oe:meth:`OEChem::OELibraryGen::SetTitleSeparator` and
   :oe:meth:`OEChem::OELibraryGen::GetTitleSeparator` in the API manual.

*  A rare problem occurred in the substructure search when hydrogen
   atoms were matched first.  This problem has been solved by
   rearranging the order in which atoms are taken into consideration,
   moving hydrogens to the end of the match order.  Other small
   modifications have been made to improve the performance of
   substructure search.

*  :oe:func:`OEChem::OEFindRingAtomsAndBonds` is automatically called to perceive
   rings in structures returned by :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>`
   or :ref:`OELibraryGen <OEChem_OELibraryGen>`.

*  Bug was fixed that caused :ref:`OEGraphMol <OEChem_OEGraphMol>` and
   :ref:`OEMol <OEChem_OEMol>` parameters to always fail to load in
   :oe:func:`OESystem::OERegisterMolParameters`.

Changes in documentation
--------------------------------------------------------------------------------

*  :oe:func:`OEChem::OEDeleteSDData` was improperly documented in the theory
   manual. 
   The old documentation stated that only the first instance of
   a tag was deleted when all instances of the tag were actually
   deleted. The documentation has been corrected to state that all
   instances of a tag are deleted.

*  :ref:`section_patternmatch_mcss` has been revised
   adding new examples, explaining the difference between the exhaustive
   and the approximate methods and providing more details about the built-in
   MCS scoring functions.

*  Figures have been added to :ref:`section_patternmatch_OEExprOpts` in order to
   demonstrate the effect of various atom and bond expression options
   on pattern matching.

*  C++, Python, and Java manuals brought into closer alignment with
   each other.

OESystem 1.6.0
================================================================================

New features
--------------------------------------------------------------------------------

*  :ref:`OEInterface <OESystem_OEInterface>` allows multiple values per parameter.
   The values can be accessed by calling the :oe:meth:`OESystem::OEInterface::GetList` 
   template member function of :ref:`OEInterface <OESystem_OEInterface>`.

*  :ref:`OEAnnotation <OESystem_OEAnnotation>` class provides ability to attach various
   graphical objects (sphere, box, surface, etc) to classes
   derived from :ref:`OEBase <OESystem_OEBase>` by using the generic data functions
   :oe:meth:`OESystem::OEBase::SetData` and 
   :oe:meth:`OESystem::OEBase::GetData`.

Minor bug fixes
--------------------------------------------------------------------------------

*  The memory allocation performance of multi-threaded *OEChem*
   applications on both Windows and recent Linux/UNIX distributions
   (that use pthreads) has been dramatically improved.  A new thread
   hashing algorithm is now used in *OESystem*'s memory pooling code
   which should dramatically reduce contention in allocation heavy
   multi-threaded code.

*  A number of minor performance and numerical stability improvements
   have been made to *OEMath*'s geometry routines.

*  When parsing the command line ``--help -foo`` is no
   longer sensitive to the case of ``-foo``.

OEPlatform 1.6.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

*  The Microsoft Windows implementation of
   :ref:`OEMutex <OEPlatform_OEMutex>` has been rewritten to use interlocked
   intrinsics and semaphores instead of the Windows' ``Mutex``
   objects, which were much slower.

*  The :ref:`OETryMutex <OEPlatform_OETryMutex>` class is now more efficient, using a
   platform-specific implementation on each supported target.




********************************************************************************
Version 1.6.1
********************************************************************************

OEChem 1.6.1
================================================================================

New features
--------------------------------------------------------------------------------

*  ``RegisterMolParameters`` renamed to :oe:func:`OESystem::OERegisterMolParameters`. 
   However, the function is now automatically called at link time alleviating the 
   user from having to call this function in order to use molecules with
   :ref:`OEInterface <OESystem_OEInterface>` s.

*  :oe:func:`OEChem::OEReadXYZFile` uses the "Unichem" numeric
   convention for elements that don't have a one or two-character IUPAC symbol.

*  Adding ``const string&`` variants of :oe:func:`OEChem::OEParseSmiles`
   and :oe:func:`OEChem::OESmilesAtomCount` functions to the *OEChem* API.

Major bug fixes
--------------------------------------------------------------------------------

*  :oe:func:`OEChem::OEPerceiveBondOrders` function is improved by:
 
   * distinguishing unsaturated allene (``C=C=C``) from propyne
     (``C#CC``)
   * assigning the double bond to a shorter of the bonds to a
     terminal oxygen in functional groups such as ``*C(=O)O`` or ``*C(=O)[O-]``

Minor bug fixes
--------------------------------------------------------------------------------

*  Hydrogen bond lengths for As, Ge, Se and Te elements are added
   to improve the 3D coordinates assigned for explicit hydrogens by
   :oe:func:`OEChem::OESet3DHydrogenGeom` function.

*  Optimization of ``OEChem::OEDBMol`` compression.

*  Memory leak was fixed in :oe:func:`OEChem::OERMSD`.

*  Bug was fixed in the binary write routine of :ref:`OEGraphMol <OEChem_OEGraphMol>`
   and :oe:const:`OEChem::OEMolBaseType::OEDBMol` parameters, that caused
   problems during a multiprocessor run.

*  Memory problem that occurred when reading molecules with large
   number of conformations was fixed by allocating memory from the heap
   rather than stack in such cases.

*  Using :oe:meth:`OEMol::operator=(const OEMolBase &)<OEChem::OEMol::operator=>`   
   on itself will no longer crash.

OESystem 1.6.1
================================================================================

New features
--------------------------------------------------------------------------------

*  New constructor added to the :ref:`OEInterface <OESystem_OEInterface>` class, that
   takes the interface data along with ``argc`` and ``argv``
   arguments of ``main()``.  
   Using this constructor, an :ref:`OEInterface <OESystem_OEInterface>` object is configured,
   parses the command line, and prints the help message if requested.

Major bug fixes
--------------------------------------------------------------------------------

*  The direction of rotation matrix given by
   :oe:func:`OEMath::OEGeom3DEulerToRotMatrix` and
   :oe:func:`OEMath::OEGeom3DQuaternionToRotMatrix` functions is now consistent
   with the other geometry handling routines.

*  Memory leak, that could occur in multi-threaded environment
   (such as Java), was fixed.

Minor bug fixes
--------------------------------------------------------------------------------

*  :oe:func:`OESystem::OEParseCommandLine` prints more sensible error message.

OEPlatform 1.6.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

*  Retrieving the host identifier for MAC Darwin platform is improved.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



********************************************************************************
Version 1.7.0
********************************************************************************

OEChem 1.7.0
================================================================================

New features
--------------------------------------------------------------------------------

* Canonical isomeric SMILES generation has been significantly improved
  (:oe:func:`OEChem::OECreateIsoSmiString`). On a test set of
  9,962,003 compounds (4,025,817 with atom or bond stereo) *OEChem*
  1.6.1 would generate different canonical isomeric smiles for
  135,985 of the compounds based on random reordering of the
  atoms. This failure rate has been reduced to just 78 compounds, a
  99.94% improvement. Furthermore, the generation has been optimized
  so that it is roughly 10-30% faster than the *OEChem* 1.6.1
  algorithm.

* :oe:func:`OEChem::OEReadMDLQueryFile` has been added to read MDL
  query files into the :ref:`OEQMol <OEChem_OEQMol>` object. This allows for
  easy integration of MDL query files with the swath of *OEChem* tools
  based upon query molecules.  The MDL query based substructure search
  was tested on a set of 655 query files. 

  .. seealso::

     The :ref:`Substructure Search with MDL Queries <chapter_mdlqueries>`
     chapter in the *OEChem* theory manual.

* *OEChem* also supports MDL reaction based library generation.
  Reaction file can be imported into a :ref:`OEQMol <OEChem_OEQMol>` object
  by calling :oe:func:`OEChem::OEReadMDLReactionQueryFile` function.
  The :ref:`OELibraryGen <OEChem_OELibraryGen>` object then can be initialized
  with the imported reaction.  The library generation was extensive
  tested on a set of 160 diverse reactions. 

  .. seealso::
  
     The :ref:`MDL Reaction Query File <subsection_reactions_libgen_MDL>`
     section in the *OEChem* theory manual.

* The :oe:const:`MiniMol<OEChem::OEMolBaseType::OEMiniMol>`
  implementation of :ref:`OEGraphMol <OEChem_OEGraphMol>` has been made more
  robust and optimized significantly for both speed and size. There
  used to be an arbitrary 1000 atom and bond limit, the limit is now a
  lot higher, :math:`2^{15}`. This implementation requires
  :oe:meth:`Compress<OEChem::OEMolBase::Compress>` be called on the
  molecule after construction to maximize space efficiency, but does
  not require :oe:meth:`UnCompress<OEChem::OEMolBase::UnCompress>` be
  called on it before it can be used. This makes it an ideal molecule
  implementation for in-memory substructure searching.

* Added :ref:`oemolithread <OEChem_oemolithread>` and
  :ref:`oemolothread <OEChem_oemolothread>` for threaded molecule
  I/O. :oe:func:`OEChem::OEReadMolecule` and
  :oe:func:`OEChem::OEWriteMolecule` are thread-safe on
  :ref:`oemolithread <OEChem_oemolithread>` and :ref:`oemolothread <OEChem_oemolothread>`
  respectively. 

  .. seealso::
   
     The :ref:`Input and Output Threads <section_inputandoutputthreads>`
     section in the *OEChem* theory manual.

* Added implementation of Zap 9 Radii from [Nicholls-2008]_
  through the :oe:func:`OEChem::OEAssignZap9Radii` function.

* Added :oe:func:`OEChem::OEShortestPath` function since it is an
  often-asked-for algorithm.

* Added :ref:`OEIdxSelected <OEChem_OEIdxSelected>` predicate for easy sub-setting
  of a molecule using an array of ``bool`` indexed by :ref:`indices
  <chapter_atombondindices>`.

* Added :oe:func:`OEChem::OECount` function for easily counting atoms
  or bonds in a molecule based on arbitrary :ref:`predicates
  <chapter_predicates>`.

Major bug fixes
--------------------------------------------------------------------------------

* Fixed seg fault in SMARTS parsing when the SMARTS contained the
  [<atomic mass>H<charge>] combination.

* Fixed ``invalid address alignment`` crash in the sketch file reader on
  Sparc.

* SD tag names were limited to 75 characters. This release raises the
  limit to 4096.

* Several major changes are made in the library generation process in
  order to ensure that products are generated with a valid |Kekule|
  form.  If there is an explicit hydrogen in the product side of the
  input reaction, then :ref:`OELibraryGen <OEChem_OELibraryGen>` will add
  hydrogens to the generated products accordingly and the first
  Kekulization will be based on this reaction specification.  If it is
  unsuccessful, *i.e.* :oe:func:`OEChem::OEKekulize` returns ``false``,
  then alternatives are tried by adding and removing implicit
  hydrogens from specific atoms until a valid (but arbitrary) |Kekule|
  form is identified. 

  .. seealso:: 
   
     The :ref:`Product Kekulization
     <subsection_reactions_libgen_kekule>` section in the *OEChem*
     theory manual.

* Significant number of improvements were added to *OEChem*'s PDB file parser 
  (:oe:func:`OEChem::OEReadPDBFile`) in the area of atomic number
  determination. By default PDB atomic symbol field is used to determine
  the atom type.
  However, for a subset of "known" residues, including all of the
  amino and nucleic acids, we continue to use the atom name
  heuristics, which for this subset are more reliable.
  Currently, there are no conflicts/discrepancies between the PDB atomic
  symbol and the atomic number we perceive in the PDB file
  reader in the entire wwPDB repository. 

* The refinement of the hydrogen placement method (:oe:func:`OEChem::OESet3DHydrogenGeom`)  
  improved numerical stability and increased speed for most 
  simple placement operations, special heuristics for carboxylic acids, 
  toluene-like methyl rotors attached to aromatic rings,
  fleeing heuristics for alkanes and perpendicular support for allenic systems.
  Additionally, hydroxyl rotors are placed using a quick local scan for strong
  acceptors (alpha acceptors) within a 3.0 Angstrom radius. 
  More hydrogen bond lengths data  specifically to As, Ge, Se and
  Te was also added ([Sutton-1958]_).

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEChem::OEGraphMol::operator=` does the same thing as the
  :ref:`OEGraphMol <OEChem_OEGraphMol>` copy constructor. This allows
  :ref:`OEGraphMol <OEChem_OEGraphMol>` to be used directly inside STL containers
  without losing the selected :ref:`OEMolBase <OEChem_OEMolBase>`
  implementation. Previous versions of *OEChem* would change the
  molecule implementation unexpectedly if the STL container needed
  to relocate the object in memory. However, the following code changes
  meaning with the switch from 1.6.1 to 1.7.0:

  .. code-block:: c++
   
     OEGraphMol gm1; 
     OEGraphMol gm2(OEMolBaseType::OEDBMol); 
     gm1 = gm2;
     // gm1 is now an OEDBMol implementation, 
     // in 1.6.1 it would be the default implementation

* The :oe:const:`OEChem::OEMolBaseType::OEDBMol` implementation can
  now copy construct in compressed mode.

* :oe:func:`OEChem::OEReadMolecule` would sometimes return ``true`` when an
  empty molecule was present in the input file. The high level
  :oe:func:`OEChem::OEReadMolecule` function will never return ``true`` when the
  molecule does not contain any atoms. Low-level molecule routines
  should be used if empty molecules are desired.

* Stabilized the atom output order from successive calls to
  :oe:func:`OEChem::OEWriteMolecule` to MOL2 when the molecule contained
  residues. 

* Deprecated the non-OE prefixed ``SmartsLexReplace`` function
  name. Renamed to :oe:func:`OEChem::OESmartsLexReplace`. 

* Fixed the bug in substructure search that occurred when :ref:`OESubSearch <OEChem_OESubSearch>`
  was initialized with a SMARTS string starting with a hydrogen atom (such as ``[#1]O[C,N,S,P]=O``).
  The order of the atoms were reordered  even when  allowReorder parameter was set to be
  ``false``.

* When initializing an :ref:`OESubSearch <OEChem_OESubSearch>` object with a SMARTS pattern the
  'reorder' parameter is  changed to ``false`` by default.  
  This parameter is currently ignored *i.e* the atom order in the returned 
  matches is always identical of the atom order in the SMARTS pattern.

* Fixed a bug in ``OEGetAromatic`` and ``OEGetBondOrder`` 
  to retrieve aromaticity/bond order from query expressions.

* A restriction is added to the interpretation of SMIRKS in 'strict' mode. 
  This requires that all atom maps in the reaction have to be pairwise
  when :ref:`OELibraryGen <OEChem_OELibraryGen>` is initialized with a SMIRKS string
  or :ref:`OEQMolBase <OEChem_OEQMolBase>` object.

* DBREF, SEQADV, MTRIX1, MTRIX2 and MTRIX3 pdb data lines are now kept when
  parsing the file. The data can be accessed by :oe:func:`OEChem::OEGetPDBData`. 

* Fixed the bug in :oe:func:`OEChem::OEWritePDBFile` that caused writing the MODEL 
  number into a wrong position in a pdb file.
   
* Fixed the bug in the SMILES canonicalization process for special cases when the input
  SMILES contains R-Group information (such as  ``[R1]c1ccc(cc1c2cccc(c2)[R3]``).

* Tweaked the *OpenEye* charge model such that the three valent Beryllium has a negative 
  one charge.  
  This makes ``F[Be-](F)F`` equivalent to the charge separated form ``[Be+2].[F-].[F-].[F-]``
  fixing 61 ligands in the PDB data set.

* Improved the bond order perception (:oe:func:`OEChem::OEPerceiveBondOrders`) support:

     * for arsenic acids, including the 'cacodylate' ion (example in 3DUE pdb).

     * for uric acid and related heterocycles.

     * for azobenzenes and similar compounds.  All acyclic 'nitrogen(2)-nitrogen(2)' bonds 
       now undergo a strict distance check independent of the (single) bond angle at each end.  
       This corrects 1SRE, 1SRF and 2GBY pdb entries.  

     * for benzoquinones and anthraquinones.

* Addressed the problem in :oe:func:`OEChem::OEAssignAromaticFlags` that caused long
  processing times when reading  (:oe:func:`OEChem::OEReadMDLFile`) on some pathological pseudo-fullerenes.

* Added PDB support for the following:
   
   * sidechain recognition for the RNA residue 'YG' and 'H2U'

   * naming of PDB residue 'BME'

   * the N-terminal modification 'FOR'

   * the cofactor 'FMT' (which is "formic acid" or "formate")

* The following problems were fixed in the PDB file parser (:oe:func:`OEChem::OEReadPDBFile`):  

  * 'anomalous mercury' problem for the  residue 'DVA' (example in 2IZQ pdb)
   
  *  spurious Holmium problem (in residues 'CEH' and 'NGR')

  *  naming of the ' P  ', ' O1P', ' O2P' and ' O3P' atoms in the 
     nonstandard PDB residues 'PTR', 'SEP' and 'TPO'.

* Improved the initial partial charge parameterization (:oe:func:`OEChem::OEMMFF94InitialCharges`)
  for selenium (atom type 83).

* Improved the perception of reactions in ISIS Sketch files.  
  Most importantly we now support the 'rxnarrow' object generated by recent versions 
  of ISIS, such as MDL Draw and Symyx Draw.  We also now allow the sketch to contain
  multiple lines, provided that only one has an arrow, and to allow
  the arrow direction and arrow coordinates to be specified in
  arbitrary order.

.. oe:language:: java
 
   * In order to make the Java interface more user-friendly, many
     functions that formerly took an opaque pointer wrapper (*i.e*
     ``SWIGTYPE_p_float``) now take an instance of OEFloatArray, for
     example. This eliminates the need to call OEFloatArray.cast() to
     call the function.

OEGrid 1.3.2
================================================================================

New features
--------------------------------------------------------------------------------

* The user is no longer required to call
  :oe:func:`OESystem::OEInitGridHandlers` in order to attach grids to
  molecules and then write them out to OEB. This occurs at library
  link time now.

  .. seealso::
   
     The :ref:`Generic Data <section_grids_genericdata>` section in
     the :ref:`Grids <chapter_grids>` chapter for details of attaching
     grids to molecules.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OESystem::OEReadGrid` would crash on gzipped files. It now
  properly uncompresses the data before reading it into a grid.

OESystem 1.7.0
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OERandom <OESystem_OERandom>` can now produce random integers through
  the :oe:meth:`OESystem::OERandom::NextInt` method.

* Added an :ref:`OEBitVector <OESystem_OEBitVector>` constructor which takes an
  :ref:`OERandom <OESystem_OERandom>` for generating random bit strings. Added
  :oe:meth:`OESystem::OEBitVector::operator\<` method so
  :ref:`OEBitVector <OESystem_OEBitVector>` can be used in STL containers.

* Added :ref:`OEBoundedBuffer <OESystem_OEBoundedBuffer>` and
  :ref:`OEProtectedBuffer <OESystem_OEProtectedBuffer>` objects useful for communicating
  between threads in multi-threaded applications.

* Added :ref:`OEWallTimer <OESystem_OEWallTimer>` since
  :ref:`OEStopwatch <OESystem_OEStopwatch>` actually reports CPU time so if
  multiple threads are being used it reports the added CPU time from
  each thread. Also added :ref:`OECycleTimer <OESystem_OECycleTimer>` for doing
  high precision timing based on clock cycles. For example, on x86
  this uses the ``rdtsc`` instruction and is thus susceptible to its
  trade offs in comparison to using CPU time from
  :ref:`OEStopwatch <OESystem_OEStopwatch>`.

* Added :oe:meth:`convenience
  constructor<OESystem::OEInterface::Constructors>` to
  :ref:`OEInterface <OESystem_OEInterface>` for the most common use case. Where
  a commandline needs to be parsed relative to a particular interface
  definition.

Major bug fixes
--------------------------------------------------------------------------------

* Deprecated ``OESetThreadSafe`` as it only gave the illusion of
  thread safety to the *OEChem* toolkits. Use
  :oe:func:`OESystem::OESetMemPoolMode` instead as outlined in the
  :ref:`Memory Management <section_memorymanagement>` section. Most
  users should just ignore this issue altogether, as the defaults are
  sufficient (and have been optimized in 1.7.0). The user should only
  consider calling :oe:func:`OESystem::OESetMemPoolMode` when passing
  *OEChem* objects between threads.

* Fixed regression where
  :oe:meth:`OESystem::OEBitVector::FromHexString` would no longer
  recognize hex strings in lowercase. It should also be noted that
  :oe:meth:`OESystem::OEBitVector::ToHexString` encodes the fractional
  length of the last 4 bits as the last character.

Minor bug fixes
--------------------------------------------------------------------------------

* Added :oe:meth:`OESystem::OEErrorHandler::Debug` as another output option to
  match :oe:const:`OESystem::OEErrorLevel::Debug`

* :ref:`OEErrorHandler <OESystem_OEErrorHandler>` now properly does nothing when
  :oe:const:`OESystem::OEErrorLevel::Quiet` is passed.

* Added :ref:`OEUnaryTrue <OESystem_OEUnaryTrue>` and
  :ref:`OEBinaryTrue <OESystem_OEBinaryTrue>` to match their inverses that already
  existed.

OEPlatform  1.7.0
================================================================================

New features
--------------------------------------------------------------------------------

* Added :ref:`OELock <OEPlatform_OELock>` class to do scoped locking around
  :ref:`OEMutex <OEPlatform_OEMutex>` objects. This ensures mutexes are
  released in the event of stack unwinding, such as when exceptions
  are thrown.

* Added the following cross-platform threading primitives:
  :ref:`OEThread <OEPlatform_OEThread>`, :ref:`OEThreadLocal <OEPlatform_OEThreadLocal>`,
  :ref:`OECondition <OEPlatform_OECondition>`, and :ref:`OEOnce <OEPlatform_OEOnce>`.

* Added :oe:func:`OEPlatform::OEGetTimeOfDay` to wrap gettimeofday on
  posix, but provide our own implementation on Windows since it doesn't
  exist on Windows.

* Added :oe:func:`OEPlatform::OEGetNumProcessors` to return the number
  of cores available on the system.

Major bug fixes
--------------------------------------------------------------------------------

*  Fixed rare off by one buffer overflow in
   :ref:`oeogzstream <OEPlatform_oeogzstream>` initialization.

*  Fixed ``seek`` and ``tell`` on files greater than 4 gigabytes on
   Windows.

Minor bug fixes
--------------------------------------------------------------------------------

*  The :ref:`OEMutex <OEPlatform_OEMutex>` implementation would default to a
   no-op implementation even when a valid mutex implementation was
   available through pthreads and compiling with a non-GCC compiler.

*  :ref:`oeifstream <OEPlatform_oeifstream>` will return ``false`` when
   :oe:meth:`OEPlatform::oestream::seek` is called and return ``0`` when
   :oe:meth:`OEPlatform::oestream::size` is called when the stream points
   to ``stdin``.

*  Corrected instances where streams were using ``oefpos_t`` for
   memory operations and ``oesize_t`` for file operations. The rule is
   memory operations should use ``oesize_t``
   (*e.g.* :oe:meth:`OEPlatform::oeistream::read`), and file operations
   should use ``oefpos_t`` (*e.g.* :oe:meth:`OEPlatform::oestream::seek`).

*  Changing ``unsigned int`` arguments to ``oesize_t`` for
   :ref:`oeisstream <OEPlatform_oeisstream>` to be able to handle memory larger
   than 4 gigabytes on 64-bit machines.

*  The following functions were global scope:
   :oe:func:`OEPlatform::OEGetIPAddress`,
   :oe:func:`OEPlatform::OEGetHostIdent`,
   :oe:func:`OEPlatform::OEGetDomainName`, and
   :oe:func:`OEPlatform::OEGetHostName`. They are now located in the
   :ref:`OEPlatform <chapter_oeplatform_functions>` namespace.



********************************************************************************
Version 1.7.1 
********************************************************************************

OEChem 1.7.1
================================================================================

This was a limited Java only alpha release.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



********************************************************************************
Version 1.7.2
********************************************************************************

OEChem 1.7.2
================================================================================

* ``OEPDBIFlag``, ``OEPDBOFlag``,
  ``OEMDLOFlag``, ``OEMOPACFlag``
  constants namespaces are deprecated.

New features
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEReadMDLQueryFile` now sets the title of the query
  molecule.

* *OEChem* now recognizes the MDL "wavy" bond. An
  :ref:`OEBondBase <OEChem_OEBondBase>` can be queried for its stereo type by
  querying its generic data for the
  :oe:const:`OEChem::OEProperty::BondStereo` tag. The returned
  ``unsigned int`` will be from the :oe:constns:`OEChem::OEBondStereo`
  namespace.

* *OEChem* now supports MDL query file R group definitions. These are
  lines starting with ``M RGP``. The R group is represented as a
  :ref:`OEQAtomBase <OEChem_OEQAtomBase>` with a :oe:meth:`map
  index<OEChem::OEAtomBase::GetMapIdx>` the same as the R group number
  in the file.

* *OEChem* will now correct amidine and guanidinium functional groups
  where the bonds between C and N are marked as aromatic in MOL2
  files.

* Significant performance improvement to reading single-conformer
  molecules from OEB files. Other minor performance improvements were
  made to OEB as well (including multi-conformer molecules). This
  speeds up ``OEDBMol`` compression and uncompression as well.

* Removed ``OECopyHistory``
  function. ``OEChem::OEReadHeader`` is now smart enough to read
  the header into the :ref:`OEHeader <OESystem_OEHeader>` history if it is
  already populated with another header's information.

* :oe:cls:`oemolthreads<OEChem::oemolthreadbase>` now support reading
  and writing :ref:`OEHeader <OESystem_OEHeader>` objects.

* Added the :oe:meth:`OEChem::oemolthreadbase::PeekMol` method. 

.. oe:language:: python

   * Support for the copy module interface (__copy__ and __deepcopy__)
     for objects that inherit from :ref:`OEBase <OESystem_OEBase>`. This
     makes *OEChem* molecules behave a little more pythonic allowing
     the user to care a little less that they are C++ based objects.

   * Added support for :oe:meth:`OESystem::OEBase::GetData`. This
     improves the ability to use
     :oe:meth:`OESystem::OEBase::AddData` and
     :oe:meth:`OESystem::OEBase::GetDataIter` from python. 

   * Added partial support for :oe:meth:`OESystem::OEBase::AddData` in
     python. Only primitive data types will work. More complex data
     types (Molecules, Surfaces, etc) will fall back to
     :oe:meth:`OESystem::OEBase::SetData`.

   * :oe:func:`OEChem::OESmartsLexReplace` is now properly wrapped for python.

   * Added `OEChem::OEAtomArray` and
     `OEChem::OEBondArray` classes (similar to
     `OEChem::OEFloatArray`) for dealing with arrays of atom
     and bond pointers from python.

   * Fixed an inconsistency of using ``OEIter.Target``. Prior to 1.7.1
     if ``Target`` was used inside a python iteration the ``Target``
     would point to the next item in the iterator, not the current
     one. Therefore, the following assertion always holds:

     .. code-block:: python
        
        atomiter = mol.GetAtoms()
        for atom in atomiter:
            assert atom == atomiter.Target()

     This fix was implemented to support lazy iterators as returned by
     the new alternate location utilities:
     :oe:meth:`OEBio::OEAltLocationFactory::GetGroups` and
     :oe:meth:`OEBio::OEAltGroup::GetLocations`. 

     .. note:: 

        Since the fix was implemented as a reimplementation of the
        ``OEIter.__iter__`` method to make it return a python
        generator instead of the iterator object itself there is now a
        slight difference in the above code snippet and the
        alternative way of using the ``OEIter.next`` python iteration
        protocol as shown in the following code:

        .. code-block:: python

           atomiter = mol.GetAtoms()
           try:
               while True:
                   atom = atomiter.next()
                   assert atom != atomiter.Target()
           except StopIteration:
               pass
       
       This previous code snippet will behave the same in 1.7.0 and
       1.7.1. However, note that now ``OEIter.Target`` returns the
       next item in the iterator. This is fundamentally how
       ``OEIter.next`` is required to work. 

       We could have not provided ``OEIter.next`` at all since the
       only requirement for python iteration is the ``__iter__``
       method. However, we choose to leave a ``OEIter.next``
       implementation in order to not break code that was written like
       the following:

        .. code-block:: python

           atomiter = mol.GetAtoms()
           atom = atomiter.next() # grab the first atom

.. oe:language:: java

   * Added support for :oe:meth:`OESystem::OEBitVector::ToHexString` in
     Java.

Major bug fixes
--------------------------------------------------------------------------------

* Fixed a :oe:func:`OEChem::OEReadMDLQueryFile` segmentation fault when
  perceiving aromaticity with spirane rings containing generic atoms.

* Fixed a bug where atom parity was ignored when reading a 3D MOL file.

* Fixed a memory leak when initializing an
  :ref:`OEMCSSearch <OEChem_OEMCSSearch>` with its
  :oe:meth:`constructor<OEChem::OEMCSSearch::Constructors>`. The
  workaround in 1.7.0 is to use the
  :oe:meth:`OEChem::OEMCSSearch::Init` method instead.

* Fixed a memory leak with :ref:`OEMCSSearch <OEChem_OEMCSSearch>` when
  :oe:meth:`OEChem::OEMCSSearch::SetMaxMatches` was set to a number
  lower than the total number of matches found.

* Fixed memory leak when creating and destroying multiple
  :ref:`OELingoSim <OEChem_OELingoSim>` objects.

* Some :oe:constns:`OEChem::OEOFlavor::PDB` flavor combinations would
  generate corrupt data.

* :oe:func:`OEChem::OESmilesAtomCount` now includes atoms of the form
  ``[#6]`` in its count.

* Fixed a bug where map indices on explicit hydrogens would be ignored
  when generating SMILES. For example, ``[CH]`` would get generated even
  if the hydrogen had a map index specified. Now ``[H:1][C]`` will be
  generated.

.. oe:language:: java

   * Fixed a crash that was introduced in 1.7.0 that would occur when
     using :oe:meth:`OEChem::oemolostream::flush` or any
     :ref:`oemolostream <OEChem_oemolostream>` method that returned an instance of
     itself.

.. oe:language:: python

   * The feature added in 1.7.0 of retrieving a python dictionary of
     the contents of an :ref:`OEBase <OESystem_OEBase>` with the
     :oe:meth:`OESystem::OEBase::GetData` method was leaking
     memory. This has been fixed in this release.

Minor bug fixes
--------------------------------------------------------------------------------

* Energy set on an :ref:`OEGraphMol <OEChem_OEGraphMol>` using
  :oe:meth:`OEChem::OEMolBase::SetEnergy` would not get written out to
  OEB files. Energy data will now round-trip through the OEB format.

* Automatic conformer combining through the
  :oe:meth:`OEChem::oemolistream::SetConfTest` interface will now
  combine separate single-conformer molecules in an OEB into a
  multi-conformer molecule similar to the other file formats *OEChem*
  supports for that behavior (MOL2, SDF, etc).

* :oe:func:`OEChem::OEPerceiveBondOrders` is more stable to pre-existing bond
  orders on the molecule.

* Rare non-deterministic bug fixed for sulfur monoxide bug in
  :oe:func:`OEChem::OEPerceiveBondOrders`. 

* *OEChem* now recognizes the ``DU`` residue name and the mythical ``DT``
  residue which is synonym for ``  T``. 

* The new overload of :oe:func:`OEChem::OEIsReadable` to take a string
  would return ``true`` if there was no periods ('.') in the string
  and the string began with a readable file extension, for example,
  "MDL-FOO".

* Fixed a bug when :ref:`OELibraryGen <OEChem_OELibraryGen>` failed to generated
  products with correct |Kekule|-form. 

OESystem 1.7.2
================================================================================

New features
--------------------------------------------------------------------------------

* Added the :oe:func:`OESystem::OEGetBitCounts` function to efficiently
  get certain bit counts when comparing two
  :ref:`OEBitVector <OESystem_OEBitVector>` objects. This function is useful for
  implementing custom fingerprint similarity measures.

* Added the :oe:meth:`OESystem::OEBitVector::SetData` method to allow a
  rapid method of initializing an :ref:`OEBitVector <OESystem_OEBitVector>` with
  binary data.

* Added :oe:meth:`OESystem::OEErrorHandler::Verbose` method to send
  :oe:const:`OESystem::OEErrorLevel::Verbose` level messages. 

* Added ``OESystem::OEHeader::operator bool`` to test whether
  the :ref:`OEHeader <OESystem_OEHeader>` has any data in it.

* Added :oe:meth:`OESystem::OEBoundedBuffer::Peek` and
  :oe:meth:`OESystem::OEProtectedBuffer::Peek` methods. 

* Optimized writing generic data attached to an
  :ref:`OEBase <OESystem_OEBase>`. This optimized ``OEDBMol::Compress``.

* Minor optimization to a common *OEChem* iterator. 

Major bug fixes
--------------------------------------------------------------------------------

* Fixed a memory leak with ``OEConstIter``. 

Minor bug fixes
--------------------------------------------------------------------------------

* Renamed the ``OEMakeFP`` function to
  :oe:func:`OESystem::OEParseHex` to be more explicit about what is
  does.

* Valgrind would throw warnings about a change made in 1.7.0 for
  thread safety issues. Though this was not a true memory leak the
  code has been slightly changed to silence this warning.

* Fixed an exponential growth bug when adding history to an
  :ref:`OEHeader <OESystem_OEHeader>`.

* Assignment operators for :ref:`OEMultiGrid <OESystem_OEMultiGrid>` now properly
  copy the titles of the subgrids.

OEPlatform  1.7.2
================================================================================

New features
--------------------------------------------------------------------------------

* Added the :oe:func:`OEPlatform::OESetLicenseFile` function to allow
  dynamically setting which OpenEye license file to use.

* Added the :oe:func:`OEPlatform::OEGetCurrentWorkingDirectory` function
  to return the current working directory for the process.

* Optimized :oe:meth:`OEPlatform::oeigzstream::seek<OEPlatform::oestream::seek>`  to only rewind the stream if seeking backwards. Therefore, the optimal
  way to seek in a gzipped file is in increasing ``oefpos_t`` order. 

* Optimized :oe:meth:`OEPlatform::oeisstream::getbuffer`. 

* Optimized :oe:meth:`OEPlatform::oeosstream::clear`. 

Minor bug fixes
--------------------------------------------------------------------------------

* Revised the :oe:meth:`OEPlatform::oestream::length` and
  :oe:meth:`OEPlatform::oestream::size` documentation to be more
  accurate.

* ``oefpos_t`` now works for files greater than 4GB on 64-bit
  windows.

* Fixed an infinite loop that would occur from the following code:

  .. code-block:: c++

     oeosstream sfs;
     sfs.open("foobar");
     sfs.write("blah");

  :oe:meth:`OEPlatform::oeosstream::open<OEPlatform::oeostream::open>`
  will return ``false``. Ignoring the ``false`` return value would cause
  :oe:meth:`OEPlatform::oeosstream::write<OEPlatform::oeostream::write>` to
  loop indefinitely.

OEBio 1.7.2
================================================================================

New features
--------------------------------------------------------------------------------

* Introduced new *OEBio* classes to manage alternate locations in
  protein data bank structures along with a new PDB input flavor
  :oe:const:`OEChem::OEIFlavor::PDB::ALTLOC` to retain alternate
  location atoms on input. 

  .. seealso::

     :ref:`Alternate Locations <section_alternate_location_factory>`

Major bug fixes
--------------------------------------------------------------------------------

* The crystal symmetry routines were broken in the 1.7.0 release by a
  corrupted matrix.
   
* When reading symmetry from external sources (*i.e.* PDB files or maps)
  a warning is thrown when reading out of date space groups rather
  than fail to read symmetry.

* Setting space groups will fail unless the most current space group
  constraints are used.

* Added the following space group aliases for older style space groups.

  ::

     I 1 2 1 -> C 1 2 1
     P 1-    -> P -1

OEGrid 1.3.3
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OESystem::OEMakeGridFromCenterAndExtents` added for a grid
  of an arbitrary template type.

Major bug fixes
--------------------------------------------------------------------------------

* Fixed a rare crash in :oe:func:`OESystem::OEMakeRegularGrid` that was
  caused by floating point round-off error.



********************************************************************************
Version 1.7.3 
********************************************************************************

OEChem 1.7.3
================================================================================

This was a limited in-house release. 



********************************************************************************
Version 1.7.4
********************************************************************************

OEChem 1.7.4
================================================================================

New features
--------------------------------------------------------------------------------

* The substructure search algorithm was optimized resulting in a
  significant performance increase for certain queries.
  
* Adding CIP (Cahn-Ingold-Prelog) atom and bond stereo perception. 

  .. seealso::

    * :oe:func:`OEChem::OEPerceiveCIPStereo`
    * :oe:func:`OEChem::OESetCIPStereo` 
    * :ref:`section_stereochemistry_CIP` section

* Adding two new options to the :oe:constns:`OEChem::OEMDLQueryOpts` namespace.

  * The :oe:const:`OEChem::OEMDLQueryOpts::MatchAtomStereo` option allows
    R/S atom stereo configuration match.

  * The :oe:const:`OEChem::OEMDLQueryOpts::MatchIsotope` option allows
    isotope match.

* The CDX file reader was extended to read superatoms.  Superatoms
  such as (Me, OEt, Ph) are represented in CDX files as disconnected
  fragments with no coordinates.  OEChem now reads superatoms correctly,
  although no coordinates are assigned for the fragments.

Major bug fixes
--------------------------------------------------------------------------------

* The default bfactor of OEResidues was changed to 20.0 from 0.0. This
  is to allow OEResidues written out of *OEChem* to play nicer with other
  software that doesn't know what to do with a bfactor of 0.0. 

* :oe:const:`OEDBMCMols<OEChem::OEMCMolType::OEDBMCMol>` would crash
  during copy construction if already compressed. Allowing
  ``OEDBMCMols`` to copy construct while compressed allows them to be
  directly used inside of STL containers.

Minor bug fixes
--------------------------------------------------------------------------------

* Bug fixed in the MDL query interpretation
  (:oe:func:`OEChem::OEBuildMDLQueryExpressions`) that occurred when a
  hydrogen atom occurred in a generic atom list of a ring query atom.

* Bug fixed that occurred when "zero-level" parentheses are used in
  SMARTS to perform component queries.  The ``(X).(Y)`` SMARTS means
  that the ``X`` and ``Y`` SMARTS pattern have to be located in
  separate components of the target structure.  For example
  ``(CO).(C=O)`` has a match in ``CCO.CC=O`` but not in ``OCCC(=O)``.

* Fixed bug that broke reading of any map idx greater than 9 from OEB
  files.

* Fixed a rare crash when using DBMols from Python or Java. 

* Fixed a bug where MDL parity bits were ignored when reading a mol
  file with no dimension set.

* Modified the coordinate handling in CDX to invert and scale
  coordinates correctly.  

OESystem 1.7.4
================================================================================

New features
--------------------------------------------------------------------------------

* Many usability improvements and a new documentation chapter,
  :ref:`chapter_oechem_interface`, on using :ref:`OEInterface <OESystem_OEInterface>`
  for command line parsing.

* Adding new :ref:`OEColor <OESystem_OEColor>` constants such as
  :oe:const:`OESystem::OESystem::OEBrown` and
  :oe:const:`OESystem::OESystem::OEViolet`.  For the full list see the
  :oe:constns:`OESystem::OESystem` namespace.

* Adding the :oe:func:`OEMath::OEGeom3DMatrixTranspose` and
  :oe:func:`OEMath::OECenter` OEMath functions.

* Major optimization to :oe:meth:`OESystem::OEAnnotation::AddChild`.

.. oe:language:: python

   * Added support for :oe:meth:`OESystem::OEInterface::GetList` in Python. 

.. oe:language:: java

   * Can now access ``oeout``, ``oeerr``, and ``oenul`` streams as static
     members of the ``oechem`` class.

   * Added support for :oe:meth:`OESystem::OEInterface::GetList` in Java. 

OEPlatform  1.7.4
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Fixed a bug where some operations on an oeigzstream (including
  molstreams on gzipped files) could result in an infinite loop when
  the associated gz file was prematurely truncated.

OEBio 1.7.4
================================================================================

New features
--------------------------------------------------------------------------------

* Added a new overload of :oe:func:`OEBio::OEExpandCrystalSymmetry`.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEBio::OEGetSpaceGroup` now properly trims the input string
  enabling better matches.

* :oe:func:`OEBio::OEGetCrystalSymmetry` now properly assigns the
  spacegroup number.

OEGrid 1.3.4
================================================================================

New features
--------------------------------------------------------------------------------

* Added the ``OESystem::OEQuadraticInterpolationAndDerivatives``
  function.

Minor bug fixes
--------------------------------------------------------------------------------

* Fixed bug where grids were not written out when attached to
  molecules. This could only sometimes occur in a statically linked
  C++ application depending on what set of **OEGrid** functions were
  being used. 


********************************************************************************
Version 1.7.5
********************************************************************************

OEChem 1.7.5
================================================================================

Documentation changes
--------------------------------------------------------------------------------

* :ref:`Generic Data handling <chapter_genericdata>` chapter added.
* All the ``OEChem`` examples have been overhauled. Several examples
  have been removed, new ones have been created and all the examples
  (across all the languages we support) have been reviewed to bring
  them up to a similar standard. For the details of example toolkit
  scripts see the :ref:`examples
  summary chapter<chapter_examplesoechem_summary>`. Source code
  is also included in the documentation.

New features
--------------------------------------------------------------------------------

* :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` container added.
* :ref:`OEIsAtomHybridization <OEChem_OEIsAtomHybridization>` functor added.
* :oe:meth:`OESystem::OEBase::GetDataIter` that takes an unsigned
  integer added for convenience. 
* :ref:`OEIsMember <OEChem_OEIsMember>` and :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>` can
  now be initialized with an :ref:`OEIterBase <OESystem_OEIterBase>` pointer.
* :oe:func:`OEChem::OEParseSmiles` function will now ignore extra
  leading spaces in non-strict mode.
* :oe:meth:`OEChem::OELibraryGen::SetTitleSeparator` will now store an
  internal copy of the string, fixing issues in wrapped languages. 
* :oe:func:`OEChem::OEIs3DFormat` function added as a convenience function for
  the user to determine whether a file format supports 3D coordinates.
* :oe:meth:`OEChem::OEMolBase::Clear` can now be called on a
  compressed DBMol and DBMCMol to wipe out the molecule
  entirely. 
* :ref:`OEIsNonRingAtomDoubleBondedToRing <OEChem_OEIsNonRingAtomDoubleBondedToRing>` functor added to
  detect atoms double bonded to a ring. Most users consider atoms
  double bonded to a ring system as part of the "scaffold". 
* MiniMols can now store coordinates, energy, and dimension. These are
  stored as generic data, so not particularly "mini". Just meant to
  allow MiniMols to be used as a more general purpose molecule
  implementation. 
* Safety precautions to prevent corrupted molecules from being written
  were placed into the OEB writer for rotor-offset-compressed
  molecules. These molecules should not be modified, and definitely
  should not be written if they were modified.
* Both old format and new format PDB hydrogen atom names are now supported.
  The new PDB naming format is used when new H atom names are assigned.
  The call :oe:func:`OEChem::OEResidueHydrogens` now supports an option
  to control which style of H atom names is assigned.
* Four new residue types have been defined:
  :oe:const:`OEChem::OEResidueIndex::NHE` (carboxy-terminal amine)
  :oe:const:`OEChem::OEResidueIndex::NME` (carboxy-terminal methyl amine)
  :oe:const:`OEChem::OEResidueIndex::CIP` (AmberFF's +1 ion)
  :oe:const:`OEChem::OEResidueIndex::CIM` (AmberFF's -1 ion).

.. oe:language:: python

   * The Python global interpreter lock will be released when calling
     :oe:meth:`OEMolBase::Compress<OEChem::OEMolBase::Compress>` and
     :oe:meth:`OEMolBase::UnCompress<OEChem::OEMolBase::UnCompress>` on a molecule. Since
     these are relatively expensive methods this should improve the
     performance of multi-threaded python applications. 

.. oe:language:: java

  * :ref:`OENearestNbrs <OEChem_OENearestNbrs>` now supports ``OEFloatArray`` in
     Java. 
  * All of the native array wrapper classes like ``OEFloatArray``
    have two new methods: a constructor that takes a Java array
    of the same base type, and a ``toArray`` method that will return
    a Java array of the same type. 

Major bug fixes
--------------------------------------------------------------------------------

.. oe:language:: python

   * Fixed memory leak in :oe:meth:`OEChem::OEMolBase::SetCoords` when taking a
     Python sequence or dictionary. :oe:meth:`OEChem::OEMolBase::SetCoords`
     will also throw a Python exception if the object passed does not
     conform to what is expected. 

.. oe:language:: java

  * :ref:`OENearestNbrs <OEChem_OENearestNbrs>` fixed in java to not randomly crash
    due to early garbage collection of the atoms in the returned
    iterators.

  * :oe:func:`OEChem::OENewMolBase`, :oe:func:`OEChem::OENewMCMolBase`,
    :oe:func:`OEChem::OENewQMolBase` no longer leak the memory of the
    molecules. 

* Fixed a crash in the OEB writer that occurred when very large values
  were set for the map index or isotope atom properties. 

* Fixed a bug with parity bits in SDF files. This would occur if
  :oe:func:`OEChem::OEPerceiveChiral` was called with an aromaticity
  model other than MDL before the molecule was written. The SDF writer
  now makes sure to re-perceive chirality based upon the MDL
  aromaticity model to get the correct parity bits. 

* Fixed a memory leak that would occur when reusing a
  :ref:`oemolistream <OEChem_oemolistream>` for many different files under certain
  circumstances. 

* :oe:meth:`OEChem::OEMol::operator=` fixed to not duplicate SD data
  when being assigned from an :ref:`OEGraphMol <OEChem_OEGraphMol>`.

* The FASTA reader now assigns the proper stereochemistry to the molecules
  it produces.

* The function :oe:func:`OEChem::OEPerceiveResidues` now respects the following
  data preservation flags:
  :oe:const:`OEChem::OEPreserveResInfo::Occupancy`,
  :oe:const:`OEChem::OEPreserveResInfo::BFactor`, and
  :oe:const:`OEChem::OEPreserveResInfo::FragmentNumber` both individually and
  implicitly as part of the flag:
  :oe:const:`OEChem::OEPreserveResInfo::All`.
  Using the flag
  :oe:const:`OEChem::OEPreserveResInfo::SerialNumber`
  will leave only the serial number of new atoms altered.

Minor bug fixes
--------------------------------------------------------------------------------

* :ref:`OELibraryGen <OEChem_OELibraryGen>` fixed when explicitly defined
  bonds on the reactant side are not set correctly. This used to
  generate products with incorrect valence.

* *OEMiniMol::Sweep()* fixed to properly re-index atoms and bonds after
  some atoms and bonds were deleted. 

* :oe:func:`OEChem::OEKekulize` will now fail if the integer bond types
  are set correctly, i.e., not between ``1`` and ``5`` inclusive. 

* :oe:const:`OEChem::OEOFlavor::Generic::Default` will now be
  consistent in molstreams for all flavors. The
  :oe:func:`OEChem::OEIsWriteable` function that takes a format and a
  flavor will now check the generic and specific flavor bits
  separately.

* :oe:func:`OEChem::OERMSD` fixed when dealing with multi-conformer
  molecules with suppressed hydrogen atoms.

* :oe:func:`OEChem::OERMSD` will now check whether the associated
  :ref:`OEMatchBase <OEChem_OEMatchBase>` actually belongs to the molecule being
  passed in. 

* :oe:func:`OEChem::OEParseSmiles` fixed to not crash when parsing
  empty strings in strict mode. 

* :oe:meth:`OEChem::OELibraryGen::GetTitleSeparator` method signature
  changed to return a string directly. The previous signature and
  function couldn't operate and didn't actually do anything.

* :oe:func:`OEChem::OESmartsLexReplace` fixed to not give incorrect
  SMARTS whenever a name appears twice in the bindings
  vector. Instead, the first pair is used, and a warning is thrown to
  indicate to the user about there being multiple pairs. 

* :ref:`OEIsHeavy <OEChem_OEIsHeavy>` is fixed to not return ``true`` for dummy
  atoms, that is, any atom with an atomic number of
  ``0``. :ref:`OEIsHeavy <OEChem_OEIsHeavy>` will only return ``true`` if the
  atomic number is greater than ``1``. 

* :oe:meth:`OEChem::oemolithread::openstring` crash fixed when used
  without a valid format being set. 

* Atom names perceived for unknown ligand types
  (:oe:const:`OEChem::OEResidueIndex::UNK` and
  :oe:const:`OEChem::OEResidueIndex::UNL`) are now
  constructed from the element name and an integer. 

* :oe:func:`OEChem::OEAddExplicitHydrogens` is fixed to produce better hydrogen
  placement geometries when adding hydrogens to sp3 carbons where the
  carbon's existing attachments vary significantly from ideal tetrahedral
  geometry.

.. oe:language:: python

   * :oe:constns:`OEChem::OEFuzzVal` namespace constants now properly
     wrapped in Python. The :oe:const:`OEChem::OEFuzzVal::True` and
     :oe:const:`OEChem::OEFuzzVal::False` constants would override the
     built in Python ``True`` and ``False`` by redefining them to the
     integral values of ``1`` and ``0`` respectively. This wouldn't
     cause any problems, in fact, Python 2.2 and previous versions
     used to define ``True`` and ``False`` exactly this way. 
  
OEBio 1.7.5
================================================================================

New features
--------------------------------------------------------------------------------

*  New :oe:meth:`OEBio::OEAltLocationFactory::GetCurrentLocations` methods
   provide a way to determine which alternate locations are selected. A new
   :oe:meth:`OEBio::OEAltLocationFactory::GetGroup` method is provided to
   convert from an :ref:`OEAltLocation <OEBio_OEAltLocation>` to an :ref:`OEAltGroup <OEBio_OEAltGroup>`.

*  A new :oe:func:`OEBio::OEGetRotamers` call that takes an
   :ref:`OEResidue <OEChem_OEResidue>` is now provided as a convenience.

*  A new :oe:func:`OEBio::OEExpandCrystalSymmetry` function expands the crystal
   symmetry of the source molecule into different conformers in the destination
   molecule.

Minor bug fixes
--------------------------------------------------------------------------------

.. oe:language:: python

   * :ref:`OERotamer <OEBio_OERotamer>` is now properly wrapped in Python.

.. oe:language:: java

   * :ref:`OERotamer <OEBio_OERotamer>` is now properly wrapped in Java.
   * Crystal symmetry API is now properly wrapped in Java.

*  :meth:`OEBio::OEHierResidue::GetOEResidue` now returns a reference to a blank
   residue when the class is uninitialized instead of a reference to random memory.

*  Adding :oe:meth:`OEBio::OESequenceAlignment::operator bool` method.
   An :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` object is considered invalid
   until its implementation is set.        
   Both the :oe:func:`OEBio::OEWriteAlignment` and the
   :oe:func:`OEBio::OERMSD` functions checks
   whether the passed alignment is valid and throw a warning if it is
   not.

OEGrid 1.3.5
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OESystem::OEGetCenterAndExtents` fixed to work on a
  :ref:`OESkewGrid <OESystem_OESkewGrid>` when it is regular grid, i.e. has no
  orientation.

* :oe:meth:`OESystem::OEErrorHandler::SetOutputStream` performance
  significantly improved to avoid quadratic behavior in certain
  circumstances.

* :oe:meth:`OESystem::OEWriteGrid` fixed to actually gzip the output if
  the file name ends in ``.gz``. Before it would just write the file
  in the specified format, but never gzip it. 

OESystem 1.7.5
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:const:`OESystem::OEErrorLevel::Default` has been changed from
  :oe:const:`OESystem::OEErrorLevel::Verbose` to
  :oe:const:`OESystem::OEErrorLevel::Info`. This allows
  ``OEThrow.Verbose`` to be used for printing more information to the
  terminal, but it will only appear when ``OEThrow.SetLevel`` is
  called with the :oe:const:`OESystem::OEErrorLevel::Verbose` level. In
  the past, the :oe:const:`OESystem::OEErrorLevel::Verbose` level was
  essentially ignored since it was nearly the same as
  :oe:const:`OESystem::OEErrorLevel::Info`.

* :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class added to interpolate
  colors between specified ranges. :ref:`OEColorStop <OESystem_OEColorStop>`
  class added to initialize :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>`
  objects.

* ``OESystem::OEBkgrdGrey`` added as a new color for
  using a light grey background of an image. 

* :oe:func:`OESystem::OECopyBaseData` convenience function added for
  copying :ref:`generic data<chapter_genericdata>`.

* :oe:func:`OESystem::OEGetTag` heavily optimized for multi-threaded
  use. 

Minor bug fixes
--------------------------------------------------------------------------------

.. oe:language:: python

   * Fixed memory leak in *OEArray* (OEFloatArray, OEDoubleArray,
     OEIntArray, etc) constructor when used on a Python sequence. 

   * Fixed memory leak in :ref:`OEInterface <OESystem_OEInterface>` constructor.

* :oe:meth:`OESystem::OEBitVector::SetData` crash fixed where it would
  try to copy more bytes than the actual size of the given data.

* :oe:func:`OESystem::OEStringToNumber` function now allows for
  new-line characters, ``\n``, to appear after the digits in the
  string. 

* :ref:`OEBase <OESystem_OEBase>` :ref:`generic data<chapter_genericdata>`
  can now handle an empty ``std::vector`` through OEB reading and
  writing.

* :oe:func:`OESystem::OEStringTokenize` now has an additional
  parameter, *concat_delim*, that specifies whether consecutive
  delimiters should be treated as a single delimiter. This is useful
  for parsing CSV files with empty fields. However, the default
  behavior is to behave as before, treating consecutive delimiters as
  a single delimiter.

* :oe:meth:`OESystem::OEGridBase::GetXIdx`,
  :oe:meth:`OESystem::OEGridBase::GetYIdx`,
  :oe:meth:`OESystem::OEGridBase::GetZIdx` fixed so that the dimensions
  are guaranteed to always be within the dimensions of the grid. These
  methods would sometimes return indices that were outside the range
  of the dimensions of the grid due to floating point rounding errors.

* ``unsigned`` can now be used as the ``!TYPE`` in interface files for
  unsigned int parameters. 

* :oe:func:`OESystem::OELinearInterpolate` performance has been
  significantly improved. 

OEPlatform  1.7.5
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* ``OEEOF`` is now defined by the ``OEPlatform`` headers and is the
  value returned by ``oestream`` methods to indicate that the end of
  the file has been reached. 

* :oe:meth:`OEPlatform::oeostream::operator\<<` can not properly write a
  ``size_t`` on 64-bit Windows. 



********************************************************************************
Version 1.7.6
********************************************************************************

OESystem 1.7.6
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* Internal debugging mechanism was left on in the previous
  release. This version turns it off improving performance across all
  libraries.

OEBio 1.7.6
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* As long as the :oe:const:`OEBio::OEAssumption::BondedResidue` flag is
  turned off, :oe:func:`OEBio::OEGetResidueAtoms` now correctly returns
  an iterator for every atom in a residue when some atoms in the
  residue are not connected to others. 

* Because some crystal symmetry space-groups share the same
  space-group number which can lead to the use of the wrong space
  group operators, when possible the name of the symmetry is now used
  rather than the space group number.


********************************************************************************
Version 1.7.7 
********************************************************************************

OEChem 1.7.7
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The :ref:`OELibraryGen <OEChem_OELibraryGen>` class checks the connectivity of each
  generated product. If any of the atom pairs of a product is connected by 
  more then one bond, for example in molecule ``C1C``, then that product is 
  rejected and not returned by the :oe:meth:`OEChem::OELibraryGen::GetProducts` 
  method.

* Fixed a bug that would invalidate an atom iterator after deleting
  the atom the iterator currently points at. This would only occur on
  molecules that already had deleted atoms when the iterator was
  constructed from a ``GetAtoms`` method that takes a predicate.

* :oe:meth:`OEChem::oemolstreambase::GetFlavor` will no longer crash
  when given a format larger than
  :oe:const:`OEChem::OEFormat::MAXFORMAT`.

* :oe:func:`OEChem::OEAddMols` will now set the dimension of the left
  hand side to the dimension of the right hand side if the dimension of
  the left hand side is zero. This allows an empty molecule to be used to 
  accumulate 3 dimensional molecule without losing the dimension. 

* Fixed a bug in the procedure for generating atom names for PDB files
  that could cause a crash when some atoms have very high atom
  indices.

.. oe:language:: python

   * Added an :oe:func:`OEChem::OERMSD` overload to accept two
     :ref:`OEMolBase <OEChem_OEMolBase>` objects and an array of double and
     throw an error to protect against implicit casts to boolean in Python. 

OEBio 1.7.7
================================================================================

New features
--------------------------------------------------------------------------------

* Added the :oe:func:`OEBio::OESymmetryFractionalToCartesian` and
  :oe:func:`OEBio::OESymmetryCartesianToFractional` functions to swap
  between crystal coordinates and cartesian coordinates.

* Added the :oe:func:`OEBio::OEBuildUnitCell` function to apply the
  symmetry operations to the asymmetric unit cell to
  generate the complete unit cell given a molecule and a spacegroup.

* :oe:func:`OEBio::OESetCrystalSymmetry` now has a force flag that sets the 
  symmetry parameters even if the cell restrictions are violated.

Bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEBio::OECopyCrystalSymmetry` now follows standard OpenEye guidelines for 
  argument position and naming to always have the output parameter
  first.  This is an API breaking change,
  code that previously used :oe:func:`OEBio::OECopyCrystalSymmetry`
  will no longer work.

* Slightly reduced memory footprint of symmetry operations.

* Crystal spacegroup names from PDB files are now handled more robustly when
  searching for CCP4 long and short names.

* Added symmetry operations for the P21/n space group.

OESystem 1.7.7
================================================================================

New features
--------------------------------------------------------------------------------

* Adding the :oe:const:`OESystem::OESystem::OETransparentColor` color constant 
  that is used in **OEDepict TK** to generate PNG images with a transparent background.

* The ``OEGeom*`` functions should now be fully wrapped in the target
  languages: Python, Java, and C#.

Bug fixes
--------------------------------------------------------------------------------

* The :ref:`OEPredIter <OESystem_OEPredIter>` increment and decrement methods
  will now always move the underlying iterator before checking the
  validity of the underlying iterator. This fixed the OEChem bug that
  invalidated an atom iterator after the current atom was deleted.

* Fixed a memory leak inside :oe:meth:`OESystem::OEIter::Push` that
  takes a predicate.

* :oe:func:`OESystem::OECopyBaseData` used to call ``Clear`` on the
  destination object before copying the data. This could clear an entire
  molecule instead of the just the generic
  data. :oe:func:`OESystem::OECopyBaseData` will now only delete the
  existing generic data.

OEPlatform 1.7.7
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEPlatform::OEIsNormalNum` added to return whether a
  floating point number is normalized, denormalized, or zero. 

* :oe:func:`OEPlatform::OEGetProcessMemUsage` added to return the
  amount of memory being used by the current process.

Bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEPlatform::OEIsNaN` fixed to actually work when the
  compiler was passed ``-ffast-math``. Also, it will now return
  ``true`` whenever passed ``NaN`` or ``Infinity``.

* ``OEAllocate`` and
  ``OEDeallocate`` were deprecated long ago and are
  now removed.


********************************************************************************
Version 1.8.0
********************************************************************************

OEChem 1.8.0
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OERMSD` and its many related overloaded functions have been optimized
  using recent algorithms from the literature.  The algorithm now solves a
  quaternion-based characteristic polynomial (Theobald-2005).  For typical 
  cases, this new algorithm runs 3-5 times faster than the prior algorithm for 
  calculating either an optimum RMSD with or without an overlay transformation.

.. oe:language:: c++

   * C++ comparison operators (=, !=, <, <=, >, >=)  have been created for 
     :ref:`OEResidue <OEChem_OEResidue>` objects, allowing OEResidues to be compared to
     each other directly, used for sorting, and as keys in a std::map.

* A new PDB input flavor, :oe:const:`OEChem::OEIFlavor::PDB::SecStruct` has been
  created, to control perception of protein secondary structure from PDB files.
  This flavor is on by default when using :oe:func:`OEChem::OEReadMolecule`.
  When this flavor is on, secondary structure is automatically perceived using 
  :oe:func:`OEBio::OEPerceiveSecondaryStructure`.  Otherwise, secondary 
  structure information is taken from HELIX and SHEET records in a PDB file.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEAssignAromaticFlags` performance is significantly
  improved for molecules with a large number of rings, such as
  buckyballs. Since :oe:func:`OEChem::OEAssignAromaticFlags` is called
  when reading from every file format **OEChem** supports this solves
  problems where **OEChem** would appear to hang indefinitely trying
  to read certain molecules. :oe:func:`OEChem::OEAssignAromaticFlags`
  will now automatically adjust the maximum path considered for
  aromaticity perception based upon the following heuristics:

  * If a molecule has more than 15 rings, than the maximum
    path considered for aromaticity is 50. 

  * If a molecule has more than 30 rings and is potentially a
    buckyball, than the maximum path considered for aromaticity is 30.

  In the case of buckyballs and other fused ring systems of 5 and 6
  membered rings, this change has no effect other than to
  significantly improve the speed of the perception.

* Isomeric canonical smiles improved in the following ways: 

  * Performance improvement to isomeric canonical smiles generation by
    not performing the more expensive isomeric canonical smiles
    generation on disconnected components that do not contain stereo
    information.

  * Very complex ring system corner case fixed that would cause
    isomeric canonical smiles generation to run for longer than was
    required leading to slightly different isomeric canonical smiles. 

.. oe:language:: python
   
   * Fixed possible inter-process race condition that could occur
     while importing openeye libraries in Python due to duplicate
     temporary file names.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEBuildMDLQueryExpressions` fixed to properly
  evaluate expressions with zero charge as a valid atom property. 

* :oe:func:`OEChem::OEMDLStereoFromBondStereo` no longer throws a
  spurious platform dependent warning about '''Stereochemistry
  corrected on atom number # of #''' when the 2D atom coordinates
  around a tetrahedral center were all 90 degrees from each other.

* :oe:func:`OEChem::OEParseSmiles` no longer crashes when passed a
  ``NULL`` pointer as a string.

* :oe:meth:`OEChem::oemolistream::GetReadFailureCt` now returns a
  non-garbage number. The internal counter was not always properly
  initialized to ``0``, requiring the user to first call
  :oe:meth:`OEChem::oemolistream::ResetReadFailureCt` to get meaningful
  results.

* :oe:func:`OEChem::OEAssignAromaticFlags` now resets all atom
  aromaticity flags to ``false`` if no rings are found in the
  molecule. 

* :oe:meth:`OEChem::oemolistream::seek` and
  :oe:meth:`OEChem::oemolistream::tell` now works as expected for
  ``MOL2`` files. This was accomplished by making
  :oe:func:`OEChem::OEReadMol2File` robust enough to not care whether
  ``@<TRIPOS>MOLECULE`` was encountered, and continue to read the rest
  of the molecule regardless of its existence. Additional checks are
  now done on subsequent lines to ensure the file is indeed in the
  ``MOL2`` format.

* :oe:func:`OEChem::OEResidueHydrogens` has been fixed to remove a possible
  buffer overflow. 

* :oe:func:`OEChem::OEResidueHydrogens` now preserves assigned atom names
  for UNL residues.

* :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>` constructors now correctly processes
  the value of the constructor option
  :oe:const:`OEBio::OEAltLocFactOption::TrustInputBonds`
  rather than always trusting input bonds.

OEBio 1.8.0
================================================================================

New features
--------------------------------------------------------------------------------

* Several new functions have been added for the perception and handling of 
  protein secondary structural elements:

  - :oe:func:`OEBio::OEPerceiveSecondaryStructure`
  - :oe:func:`OEBio::OEGetSecondaryStructureName`
  - :oe:func:`OEBio::OEGetSecondaryStructureID`
  - :oe:func:`OEBio::OEGetSecondaryStructureStrandID`
  - :oe:func:`OEBio::OEGetSecondaryStructureType`
  - :oe:func:`OEBio::OESecondaryStructurePacked`
  - :ref:`OEHasSecondaryStructure <OEBio_OEHasSecondaryStructure>`

  Sheets, helices, and turns are
  perceived using the method of Kabsch & Sander **1983**, and are stored
  in atoms' :ref:`OEResidue <OEChem_OEResidue>` records.  Secondary structure perception
  is performed by default when reading PDB files, but can be controlled
  with a new PDB input flavor, :oe:const:`OEChem::OEIFlavor::PDB::SecStruct`.
 
  
OEGrid 1.4.0
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OESystem::OEReadMTZ` has been added.  This allows reading
  of standard MTZ crystallographic data files where the default
  MTZ column names from popular refinement packages were used.

OESystem 1.8.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OESystem::OEColorGradientBase::GetColorAt` fixed to
  correctly round color components after interpolation. 

* `OESystem::OEGeom3DGetOverlayRotTrans` renamed from
  ``OEGeomGetOverlayRotTrans`` and argument order changed to mimic
  other 3D geometry functions.

* The following :ref:`OEColor <OESystem_OEColor>` functions and methods will
  automatically clamp color values to the range [0,255] and [0.0, 1.0]
  for integers and floating point numbers respectively: 

  * :oe:meth:`OEColor constructors<OESystem::OEColor::Constructors>`
  * :oe:meth:`OESystem::OEColor::SetR`
  * :oe:meth:`OESystem::OEColor::SetG`
  * :oe:meth:`OESystem::OEColor::SetB`
  * :oe:meth:`OESystem::OEColor::SetA`
  * :oe:func:`OESystem::OEColorCreate`
  * :oe:func:`OESystem::OEColorSet`

  A warning will be thrown to ``OEThrow`` if a clamping occurs.

* Valgrind warning silenced caused by mismatching ``new []`` and
  ``delete`` in OEChem's :ref:`small object memory
  allocator<section_memorymanagement>`. The proper ``delete []`` is
  now used though no real issue was observed by this bug in
  production. 

* :ref:`OEInterface<chapter_oechem_interface>` no longer returns duplicate
  and confusing error messages by properly respecting the
  ``error_level`` argument in all failure conditions instead of using
  ``OEThrow.Error``.

* ``operator-=`` and ``operator+=`` now function properly for negative
  numbers for :ref:`OEPredIter <OESystem_OEPredIter>` and :ref:`OEConcatIter <OESystem_OEConcatIter>`.

OEPlatform 1.8.0
================================================================================

New features
--------------------------------------------------------------------------------

* ``OEPlatform::OEMallocaPtr::IsValid`` added to provide a more
  straightforward way of testing whether the held pointer is
  ``NULL``. 

Major bug fixes
--------------------------------------------------------------------------------

* :ref:`OEThreadLocal <OEPlatform_OEThreadLocal>` will now properly destroy thread
  local variables upon thread termination for Visual Studio 2005 and
  later. 

* :oe:meth:`OEPlatform::oeostream::operator\<<` fixed to not crash when
  writing out a ``double`` that needs more than 80 characters to fully
  represent it. 

* ``OEPlatform::oeistream::pushline`` method removed as it was a
  hack to implement ``MOL2`` file reading since the molecule delimiter
  comes at the beginning of the next
  molecule. :oe:meth:`OEPlatform::oeistream::getline` was the only
  other :ref:`oeistream <OEPlatform_oeistream>` method that was aware of a
  ``pushline`` call. See the release note about the improvements to
  :oe:func:`OEChem::OEReadMol2File` that justify the removal of this
  method.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEPlatform::OEGetIPAddress` should be more robust for
  grabbing the IP address, not returning the loopback interface or
  inactive interfaces. 

* :ref:`OEDirectoryScan <OEPlatform_OEDirectoryScan>` fixed to actually work on
  Windows. 

* :ref:`OEThread <OEPlatform_OEThread>` no longer has a copy constructor or
  ``operator=`` as these were dangerous and undefined. 

Documentation changes
--------------------------------------------------------------------------------

* The following chapters have been updated to new 2D depictions using
  the *OEDepict 2.x* library:

  * :ref:`Ring Perception<chapter_ring>` chapter
  * :ref:`Aromaticity Perception<chapter_aromaticity>` chapter
  * :ref:`Connectivity Perception<chapter_connectivity>` chapter
  * :ref:`Stereochemistry Perception<chapter_stereochemistry>` chapter
  * :ref:`Pattern Matching<chapter_patternmatch>` chapter
  * :ref:`Design Decisions<chapter_designdecisions>` chapter
  * :ref:`Periodic Table Functions<chapter_periodictable>` chapter

* :oe:func:`OEChem::OE3DToInternalStereo` documentation clarified to
  specify how it behaves in the absence of 3D coordinates.

* :ref:`Substructure Search<section_patternmatch_sss>` section fixed
  to more accurately reflect that subgraph uniqueness does not
  actually consider differences in matched bonds.


.. _section_oechem_releasenotes_190:

********************************************************************************
Version 1.9.0
********************************************************************************

OEChem 1.9.0
================================================================================

New features
--------------------------------------------------------------------------------

* Added support for reading the ``V3000`` file format for
  molecules, queries, and reactions. By default, whether to read the
  ``V3000`` format will be detected automatically from the header inside
  ``.sdf``, ``.mol``, and ``.rxn`` files. 

* :ref:`OEGroupBase <OEChem_OEGroupBase>` class added as a container of atoms and
  bonds inside a :ref:`OEMolBase <OEChem_OEMolBase>` to store MDL enhanced
  stereo information. See the :oe:constns:`OEChem::OEGroupType`
  namespace for the different types of enhanced stereo information
  that can be processed. Only the following subset of **OEChem**
  functions handle :ref:`OEGroupBase <OEChem_OEGroupBase>` information at this
  time:

  - :oe:func:`OEChem::OEAddMols`
  - :oe:func:`OEChem::OECount`
  - :oe:func:`OEChem::OEReadMDLFile`
  - :oe:func:`OEChem::OEReadMDLQueryFile`
  - :oe:func:`OEChem::OEReadMDLReactionQueryFile`
  - :oe:func:`OEChem::OESubsetMol`

  By virtue of the above low level reader functions populating
  :ref:`OEGroupBase <OEChem_OEGroupBase>` information,
  :oe:func:`OEChem::OEReadMolecule` from a ``V3000`` file format will
  also populate :ref:`OEGroupBase <OEChem_OEGroupBase>` information on a
  molecule. 

* Adding the following predicates for handling
  :ref:`OEGroupBase <OEChem_OEGroupBase>` objects on molecules.

  - :ref:`OEHasGroupType <OEChem_OEHasGroupType>`
  - :ref:`OEIsMDLStereoGroup <OEChem_OEIsMDLStereoGroup>`
  - :ref:`OEHasAtomInGroup <OEChem_OEHasAtomInGroup>`
  - :ref:`OEHasBondInGroup <OEChem_OEHasBondInGroup>`

* :oe:func:`OEChem::OEAssignZap9Radii` has been updated to use the
  method published in the 2010 Journal of Computer-Aided Molecular
  Design by Nicholls, Wlodek, and Grant. The old behavior can be
  accessed by passing constants found in the
  :oe:constns:`OEChem::OEZap9Version` namespace.

* :ref:`oemolithread <OEChem_oemolithread>` now works with ``CDX`` files.

* :oe:const:`OEChem::OEIFlavor::PDB::FORMALCHARGE` input flavor for PDB
  file reading added. This flavor is provided for advanced users who
  wish to read the formal charge from the file and do their own bond
  and hydrogen perception. It is not yet turned on by default.

* SD data tags and value in ``SDF`` files can now be up to 64
  kilobytes in length, up from the previous limit of just 4 kilobytes. 

* :oe:func:`OEChem::OEMolecularFormula` extended to include hydrogen
  isotopes deuterium (``D``) and tritium (``T``) in the molecular
  formula output. Note, the default behavior has not changed, the
  user is required to pass an additional parameter to enable this
  feature.

* The Amber C-terminal capping residue :oe:const:`OEChem::OEResidueIndex::NME`
  is now supported. Support for the Amber C-terminal
  capping residue `OEChem::OEResidueIndex::NMH` is incomplete.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OESubsetMol` will no longer crash
  non-deterministically when setting the ``RGroup`` parameter to
  ``true``.

* :ref:`OEInterface <OESystem_OEInterface>` had a rare one time initialization
  thread safety bug when dealing with molecule parameters that has
  been fixed. 

* :oe:func:`OEChem::OEGetResidueName` will now handle
  :oe:const:`OEChem::OEResidueIndex::GLH` appropriately. 

* :oe:const:`OEChem::OEMCSType::Approximate` search method will now
  terminate once the :oe:meth:`OEChem::OEMCSSearch::GetMaxMatches`
  limit has been reached. The previous behavior was to keep
  enumerating all possible matches, then choose the first matches up
  to the limit. This significantly speeds up
  :oe:const:`OEChem::OEMCSType::Approximate` searches that results in a
  lot of matches, e.g., matching a molecule onto itself. 

  .. note:: 

     It is highly recommended to call
     :oe:func:`OEChem::OESuppressHydrogens` before trying to perform a
     self match on a molecule. 

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEResidueHydrogens` will now throw an error check
  when attempting to assign a PDB atom name when there are more than
  than 9 hydrogens attached to a single atom.

OESystem 1.9.0
================================================================================

New features
--------------------------------------------------------------------------------

.. oe:language:: c++
   
   * :oe:func:`OESystem::OETrimToSigFigs` added to strip string representations
     of decimal numbers to a scientifically reasonable set of digits.  

Minor bug fixes
--------------------------------------------------------------------------------

* :ref:`OEInterface <OESystem_OEInterface>` help messages now only print a
  reasonable number of digits when printing floating point
  values.

* :oe:func:`OEChem::OEReadCDXFile` and :oe:func:`OEChem::OEReadMolecule` now 
  preserve stereochemistry when loading ChemDraw CDX files.  Additionally,
  some incorrect warning messages have been removed from the CDX file reader.

Documentation changes
--------------------------------------------------------------------------------

* Figures added to the documentation of
  :oe:func:`OEChem::OEMDLCorrectBondStereo`,
  :oe:func:`OEChem::OEMDLPerceiveBondStereo`, and
  :oe:func:`OEChem::OEMDLStereoFromBondStereo` to help explain the
  differences between those functions.

OEPlatform 1.9.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEPlatform::OEFile::AbsPath` fixed to not have a leading ``/``
  if the directory path specified is empty.

OEBio 1.9.0
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* The method :oe:meth:`OEBio::OEHierResidue::GetAtom` now correctly interprets
  the input :oe:constns:`OEChem::OEPDBAtomName` parameter rather than failing
  to find the requested atom.

OEGrid 1.4.1
================================================================================

.. oe:language:: java

   * :oe:func:`OESystem::OEReadMTZ` is now accessible from Java. 

.. oe:language:: csharp

   * :oe:func:`OESystem::OEReadMTZ` is now accessible from C#. 

.. oe:language:: c++ python

   * Internal build system improvements. 



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _section_oechem_releasenotes_191:

********************************************************************************
Version 1.9.1
********************************************************************************

OEChem 1.9.1
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OEOmegaConfTest <OEChem_OEOmegaConfTest>` has been created specifically for output from
  OMEGA.  This conftest ignores invertible nitrogen stereochemistry that OMEGA
  freely adjusts in order to allow these conformers to be read into the same
  :ref:`OEMol <OEChem_OEMol>`.

* :oe:meth:`OEChem::OELibraryGen::SetValidateKekule` added to set
  whether alternative |Kekule| forms are enumerated until a valid form
  is identified before returning a product.

.. oe:language:: python

   * ``OEChem::oemolithread::GetMolData`` method added to return
     a generator over all the molecules of a file in their string
     representation in the source format.

* The :oe:meth:`OEChem::oemolthreadbase::GetMol` method for
  :ref:`oemolithread <OEChem_oemolithread>` class will now return chunks of
  molecule files that can be directly written to files to enable faster
  tokenization of a molecule file. Before this release, this method
  would often not return whitespace that was necessary to delineate
  boundaries between molecules.

.. oe:language:: python java csharp

   * :oe:meth:`OEChem::oemolthreadbase::PutMol` and
     :oe:meth:`OEChem::oemolthreadbase::GetMol` support added to the
     wrapped languages: Python, Java, and C#.

.. oe:language:: csharp

   * :ref:`OETrans <OEChem_OETrans>` and its sibling classes for high-level 3D
     manipulation have been added to C#. These include :ref:`OEQuaternion <OEChem_OEQuaternion>`,
     :ref:`OEEuler <OEChem_OEEuler>`, :ref:`OERotMatrix <OEChem_OERotMatrix>` and
     :ref:`OETranslation <OEChem_OETranslation>`.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEPerceiveResidues` had a bug introduced in the
  2012.Feb release that could cause crashes or strange
  data to be written to the :oe:meth:`OEChem::OEAtomBase::GetName`
  field whenever :oe:meth:`OEChem::OEAtomBase::GetAtomicNum` returned
  ``0``. Atoms with an atomic number of ``0`` will now be given the
  name of `` UNK`` (note, the leading space to match PDB style
  names).

* :oe:func:`OEChem::OEAssignAromaticFlags` no longer takes an
  ``OEAroModel``, which was a ``unsigned short *`` typedef, but takes
  an integer from the :oe:constns:`OEChem::OEAroModel` namespace
  instead. Global constants prepended with ``OEAroModel*`` are now
  deprecated. This works around a serious bug that would sometimes
  cause :oe:func:`OEChem::OEAssignAromaticFlags` to not do anything to
  the molecule. This may break source-level backwards compatibility
  for strongly typed languages (C++, Java, and C#) if a global
  constant prepended with ``OEAroModel*`` was stored as a
  variable.

.. oe:language:: c++ java csharp

   Code may have to be ported like the following:

.. oe:language:: c++

   .. code-block:: c++

      OEAroModel m = OEChem::OEAroModelOpenEye;
      // change the previous line to the following
      unsigned int = OEChem::OEAroModel::OpenEye;

      OEAssignAromaticFlags(mol, m);

.. oe:language:: java

   .. code-block:: java

      short[] m = oechem.getOEAroModelOpenEye();
      // change the previous line to the following
      int m = OEAroModel.OpenEye;

      OEAssignAromaticFlags(mol, m);

.. oe:language:: csharp

   .. code-block:: csharp

      SWIGTYPE_p_unsigned_char m = OEChem.OEAroModelOpenEye;
      // change the previous line to the following
      uint m = OEAroModel.OpenEye;

      OEAssignAromaticFlags(mol, m);

.. oe:language:: python

   Python code should continue to work due to dynamic typing. The only
   change for python is that the following ``OEAroModel*`` global
   constants are now deprecated.

Minor bug fixes
--------------------------------------------------------------------------------

.. oe:language:: java

   * The :ref:`oemolistream <OEChem_oemolistream>` constructor that takes a
     :ref:`oeistream <OEPlatform_oeistream>` argument had its ownership flag
     default changed from ``true`` to ``false`` for Java. There is no
     way to pass ownership to the object from Java without usually
     resulting in a crash, so passing the value of ``true`` to this
     constructor will now throw an error message.

* :ref:`oemolithread <OEChem_oemolithread>` and :ref:`oemolothread <OEChem_oemolothread>` can
  no longer to be copy constructed. They are heavy weight objects
  representing real operating system threads and thus should not be
  copied.

.. oe:language:: java

   * Resolved an issue in Java where compiling against the OpenEye jar
     would cause additional class files to appear in the current
     directory.

   .. warning::

      There is a known bug concerning OpenEye constants that occurs
      when compiling against an older version of the OpenEye jar and
      running against a newer version of the OpenEye jar. Please make
      sure to run against java programs against the same version it
      was compiled with.

* The MDL V3000 reader now throws a warning that the ``ENDPTR`` and ``ATTACH`` bond
  properties will be ignored.

* :oe:meth:`OEChem::OEMatch::AddPair` now checks whether the atom and
  bond pairs belong to the same molecule.

* :ref:`OELibraryGen <OEChem_OELibraryGen>` now allows an aromatic bond to become
  a triple bond when breaking a ring.

OESystem 1.9.1
================================================================================

New features
--------------------------------------------------------------------------------

* Adding a default constructor for the
  :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class that generates a
  color gradient with no color stop. The
  :oe:meth:`OESystem::OEColorGradientBase::IsEmpty` was added to be
  able to determine if the object was default constructed.
  Additionally, the
  :oe:meth:`OESystem::OEColorGradientBase::GetColorAt` method will
  always return the color
  :oe:const:`OEBlack<OESystem::OESystem::OEBlack>` for a color gradient
  with no color stops, i.e.,
  :oe:meth:`OESystem::OEColorGradientBase::IsEmpty` returns ``true``.

* :oe:func:`OESystem::OEStringTabsToSpaces` function added to expand
  tab characters to 4 space characters.

* :oe:meth:`OESystem::OEBitVector::FromHexString` performance has been
  significantly improved.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OESystem::OEStringTokenizeQuoted` now treats consecutive
  delimiters as blank fields.

* :ref:`OEErrorHandler <OESystem_OEErrorHandler>`, and thus
  :oe:constns:`OESystem::OEThrow`, will no longer record the
  number of messages that did not actually get through due to the
  message not meeting the :oe:meth:`OESystem::OEErrorHandler::SetLevel`
  threshold.

* :oe:func:`OESystem::OEParseCommandLine` will now call ``exit(0)`` if
  the internal call to :oe:func:`OESystem::OECheckHelp` returns
  ``true`` that a ``--help`` parameter is found. That is, program
  execution with the ``--help`` parameter should not be considered
  abnormal program termination.

* :oe:func:`OEMath::OEGeom3DRotVectorToTransform` return type changed
  from ``void`` to ``bool`` to be able to indicate cases when the
  function can fail.

.. oe:language:: python

   * :oe:meth:`OESystem::OEAnnotation::GetChildren` will now work in
     Python.

   * ``ProcessCommandLineStreams`` was deprecated, and is now
     removed.

Documentation fixes
--------------------------------------------------------------------------------

* :oe:meth:`OESystem::OEBitVector::FromHexString` and
  `OESystem::OEBitVector::ToHexString` documentation has been
  corrected to explain their behavior with respect to bit vector
  lengths and the handling of non-hexadecimal digits in the
  translation process.

* :oe:func:`OESystem::OECheckHelp` is now documented.

OEPlatform 1.9.1
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:meth:`OEPlatform::oeifstream::pread` method added to allow
  multiple threads to read from a single file.

* :ref:`oeiofstream <OEPlatform_oeiofstream>` class added to support reading and
  writing to the same open file.

* :oe:meth:`OEPlatform::oeistream::read` method added to read the
  entire contents of the stream or throw ``std::bad_alloc`` whenever
  the system runs out of memory.

.. oe:language:: c++

   * :ref:`oeistream <OEPlatform_oeistream>` methods that read into
     ``std::string`` objects have been significantly optimized.

   * `OEPlatform::oeifstream::getline` that takes a
     ``std::string`` without a size parameter was arbitrarily capped
     to only read a line 64K long. The method will now keep reading
     data provided there is enough memory to allocate for the
     ``std::string``.

   * OE_CURRENT_FUNCTION macro added that provides a ``const char *``
     to the name of the current C++ function.

* :ref:`oemultiostream <OEPlatform_oemultiostream>` has been added.  More than one
  :ref:`oeostream <OEPlatform_oeostream>` can be added to this class for simultaneous output.

* :oe:func:`OEPlatform::OEFileTempDescriptor` added to safely create
  temporary files without race
  conditions. :oe:func:`OEPlatform::OEFileRandomName` is now deprecated
  as it can lead to race conditions in the file names it generates.

Major bug fixes
--------------------------------------------------------------------------------

* `OEPlatform::oeifstream::getline` would sometimes cause
  buffer overflows whenever ``max`` characters were actually in the
  line. The documentation was not very clear what this ``max``
  parameter meant, it used to be the line size, not including the null
  terminator. Now it means the size of available memory in the ``buffer``
  passed in, including the null terminator, and the documentation is
  now more clear on the subject.

* `OEPlatform::oeifstream::append` will now close the previous
  file before opening the next file. Before, calling the ``append``
  method in a loop could lead to the process easily running out of a
  available file descriptors.

* The macros ``OE32BIT`` and ``OE64BIT`` were improperly set on 64-bit
  Windows.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEPlatform::OEGetHostIdent` fixed to work on machines where
  ``eth0`` was not in use for network traffic.

OEBio 1.9.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` methods
  :oe:meth:`GetBackboneMatch<OEBio::OESequenceAlignment::GetBackboneMatch>` and
  :oe:meth:`GetCAlphaMatch<OEBio::OESequenceAlignment::GetCAlphaMatch>`
  now returns :ref:`OEMatchBase <OEChem_OEMatchBase>` instead of :ref:`OEMatch <OEChem_OEMatch>`.

Documentation fixes
--------------------------------------------------------------------------------

* :ref:`OERotamer <OEBio_OERotamer>` class is now documented for working with
  frequently observed conformations of amino-acid sidechains .

OEGrid 1.4.2
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OESystem::OEReadGrid` no longer leaks memory for
  :oe:const:`CCP4<OESystem::OEGridFileType::CCP4>` files.


.. _section_oechem_releasenotes_192:

********************************************************************************
Version 1.9.2
********************************************************************************

OEChem 1.9.2
================================================================================

New features
--------------------------------------------------------------------------------

* OEChem now supports the creation of InChI. OEChem produces the same
  InChI as the InChI library provided application for 99.77% of MDDR
  in the SDF format. The differences fall into two categories:

  - Corrupted molecules where the tools have to make arbitrary
    decisions about how to correctly interpret the data.
  - Bond stereo being perceived by the InChI application where bond
    stereo does not actually exist. OEChem does not assign bond stereo
    and generates what appears to be a more "correct" InChI for these cases. 

  The inclusion of InChI support added the following: 

  - :oe:func:`OEChem::OECreateInChI`
  - :oe:func:`OEChem::OECreateInChIKey`
  - :oe:const:`OEChem::OEFormat::INCHI`
  - :oe:const:`OEChem::OEFormat::INCHIKEY`
  - :oe:constns:`OEChem::OEOFlavor::INCHI`
  - :oe:constns:`OEChem::OEOFlavor::INCHIKEY`
  - :ref:`OEInChIOptions <OEChem_OEInChIOptions>`

  In addition, :ref:`oemolostream <OEChem_oemolostream>` will automatically write
  InChI when using the ``.inchi`` file extension. 

* :oe:func:`OEChem::OEPrepareSearch` added that perceives atom and
  bond properties of a molecule that are necessary to successfully execute a
  given substructure search. It is now highly recommended to run this
  function on a molecule before passing the molecule to any of
  OEChem's graph matching algorithms.

.. oe:language:: java

   * Several Java API points that pass primitive arrays of doubles or
     floats were optimized with good results.  The following API
     points that take these primitive array types were optimized:
     ``NewConf``, ``SetCoords``, and ``GetCoords``. 

     .. list-table::  **The following figures should be indicative of the performance increase in the 2013.June release:**

        * - .. image:: ../../oechemtk/releasenotes/images/javagraph1.png
          - .. image:: ../../oechemtk/releasenotes/images/javagraph2.png

* Changed the default input and output molecule file formats for
  molstreams and molthreads from :oe:const:`OEChem::OEFormat::SMI` to
  :oe:const:`OEChem::OEFormat::ISM`.

* :oe:func:`OEChem::OEWriteMDLFile` writes MDL enhanced stereo
  groups.

* :oe:func:`OEChem::OEWriteMDLFile` will now automatically write a molecule
  in the V3000 file format if it has more than 999 atoms or if it has any
  MDL enhanced stereo group regardless of the given file format
  flavor.

* :oe:func:`OEChem::OESetMCSExhaustiveSearchTruncationLimit` and
  :oe:func:`OEChem::OEGetMCSExhaustiveSearchTruncationLimit` functions
  added that control how thoroughly the search is performed by the
  :oe:const:`exhaustive<OEChem::OEMCSType::Exhaustive>` MCS search. 
 

* Added the following standard SYBYL atom types:
  :oe:const:`OEChem::OETriposType::Cu`
  :oe:const:`OEChem::OETriposType::Cooh`,
  :oe:const:`OEChem::OETriposType::Croh`,
  :oe:const:`OEChem::OETriposType::Crth`,
  :oe:const:`OEChem::OETriposType::Fe`,
  :oe:const:`OEChem::OETriposType::Mg`,
  :oe:const:`OEChem::OETriposType::Mn`,
  :oe:const:`OEChem::OETriposType::Mo`,
  :oe:const:`OEChem::OETriposType::Se`,
  :oe:const:`OEChem::OETriposType::Sn`, and
  :oe:const:`OEChem::OETriposType::Zn`.
  Atoms for which no SYBYL atom type exists are still internally handled with the 
  :oe:const:`OEChem::OETriposType::Du` type, however when writing these atoms into
  a ``MOL2`` file their atomic symbol is written to the SYBYL atom type
  column instead of a string "Du".

* Added :oe:func:`OEChem::OEGetDimensionFromCoords` function that returns the
  dimension of the molecule from its coordinates.

* Residue information is now retained when reading files with MacroModel formats
  (.mmod, .mmd, and .dat).

Major bug fixes
--------------------------------------------------------------------------------

* It used to be possible to perform a substructure search for
  stereochemistry or hybridization on a molecule that did not yet have
  those properties perceived. This led to very subtle to detect
  problems where molecules would not match that were expected to
  match. 

  To combat this, the following :ref:`OESubSearch <OEChem_OESubSearch>` methods
  now throw warnings in case some property that is necessary to
  successfully execute the substructure search has not been perceived
  yet:

  * :oe:meth:`OEChem::OESubSearch::Match`
  * :oe:meth:`OEChem::OESubSearch::SingleMatch`
  * :oe:meth:`OEChem::OESubSearch::AtomMatch`

  These warnings can be suppressed by calling the
  :oe:func:`OEChem::OEPrepareSearch` function on the molecule
  first.

* Utilizing the :oe:const:`OEChem::OEPerceived::AtomStereo` and
  :oe:const:`OEChem::OEPerceived::BondStereo` flag to mark whether
  the atom and bond stereo information is perceived in a molecule.

* It is now thread-safe to copy the same :ref:`OEMol <OEChem_OEMol>` from
  multiple threads at the same time. This was caused by some
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>` methods not actually being const. The
  following methods were marked as const, but were not actually const,
  leading to subtle race conditions:

  - :oe:meth:`OEChem::OEConfBase::GetTitle`
  - :oe:meth:`OEChem::OEMCMolBase::GetActive`

.. oe:language:: c++

   * The const-ness of many OEChem functions and methods have been
     fixed. This can potentially cause code to not compile if the code
     was incorrectly abusing the const-ness of the object. For
     example, the following code used to compile before this release:

     .. code-block:: c++

        const OEGraphMol mol;
        OEAddExplicitHydrogens(mol);

     The const-ness of the following functions and methods have been fixed: 

     - :oe:meth:`OEChem::OEGraphMol::SCMol`
     - :oe:meth:`OEChem::OEGraphMol::operator OEMolBase &`
     - :oe:meth:`OEChem::OEConfBase::GetMCMol`
     - :oe:meth:`OEChem::OEMol::SCMol`
     - :oe:meth:`OEChem::OEMol::MCMol`
     - :oe:meth:`OEChem::OEMol::operator OEMCMolBase &`
     - :oe:meth:`OEChem::OEQMol::SCMol`
     - :oe:meth:`OEChem::OEQMol::operator OEMolBase &`
     - :oe:meth:`OEChem::OEQMol::QMol`
     - :oe:meth:`OEChem::OEQMol::operator OEQMolBase &`
     - :oe:meth:`OEChem::OEQBase::GetExpr`
     - :oe:meth:`OEChem::OEGetNbrAtom::Constructors`
     - :oe:meth:`OEChem::oemolithread::GetIStream`
     - :oe:meth:`OEChem::oemolithread::GetMolStream`
     - :oe:meth:`OEChem::oemolothread::GetOStream`
     - :oe:meth:`OEChem::oemolothread::GetMolStream`

* :oe:meth:`OEChem::OEMCMolBase::GetMCMolTitle` method added to
  provide a way to differentiate between a top-level
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>` title and a conformer title.

* :oe:meth:`OEChem::OEMCSSearch::AddConstraint` now requires that the
  constraint is satisfied in all resulting matches. Previously, the
  documentation stated the following, "Constraints are considered
  satisfied in subgraphs which do not contain any constrained atoms or
  bonds in either the pattern or target molecules." This is no longer
  the intended behavior.

* :oe:meth:`OEChem::OEMCSSearch::AddConstraint` now returns ``false``
  if passed the same pattern atom or bond twice. The user must now use
  :oe:meth:`OEChem::OEMCSSearch::ClearConstraints` in order to rebuild
  a set of constraints.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OE3DToBondStereo` function returns false if the molecule
  dimension is 0, since no cis or trans bonds can be perceived if there are no
  coordinates.

* Fixed a problem when the max matches value of the :ref:`OESubSearch <OEChem_OESubSearch>`
  was reset to the default value ``1024`` every time the search was initialized
  by the :oe:meth:`OEChem::OESubSearch::Init` method.

* Adjusted the dimension of a molecule to 0 if it is read from either a ``MDL``
  or an ``SDF`` file with no coordinates.

* :oe:func:`OEChem::OE3DToAtomStereo` function throws a warning and
  returns ``false`` if any chiral atom of the molecule is not
  tetrahedral, i.e., if the atom stereo can not be determined from the
  3D coordinates, usually because it is flat.

* The following functions and methods throw additional warnings in cases where either the
  :oe:func:`OEChem::OE3DToAtomStereo` or the :oe:func:`OEChem::OE3DToBondStereo`
  functions encounter any problems when assigning stereo from coordinates:

  * :oe:func:`OEChem::OEPrepareSearch` functions
  * :oe:func:`OEChem::OEWriteMolecule` function when writing the following formats:
    :oe:const:`OEChem::OEFormat::MDL`,
    :oe:const:`OEChem::OEFormat::SDF`
    :oe:const:`OEChem::OEFormat::ISM`,
    :oe:const:`OEChem::OEFormat::INCHI` and
    :oe:const:`OEChem::OEFormat::INCHIKEY`
  * :oe:meth:`OEChem::OEAbsoluteConfTest::CompareMols` method
  * :oe:meth:`OEChem::OEIsomericConfTest::CompareMols` method
  * :oe:meth:`OEChem::OEAbsCanonicalConfTest::CompareMols` method
  * :oe:meth:`OEChem::OEOmegaConfTest::CompareMols` method
  * :oe:meth:`OEChem::OEDefaultConfTest::CompareMols` method

* :oe:func:`OEChem::OESubsetMol` now produces correct results when
  the ``RGroup`` flag was ``true`` and the molecule contained
  :ref:`OEGroupBase <OEChem_OEGroupBase>` objects.

* :oe:func:`OEChem::OEPerceiveChiral` function considers hydrogens with different
  mass as being different *i.e.* it will recognize the C atom in a molecule
  "[3H]C(N)F" as a chiral atom, since it has four different neighbors: N, F, H  and 3H.
 

* The first argument of the following methods is not const any longer:

  * :oe:meth:`OEChem::OEAbsoluteConfTest::CompareMols` method
  * :oe:meth:`OEChem::OEIsomericConfTest::CompareMols` method
  * :oe:meth:`OEChem::OEAbsCanonicalConfTest::CompareMols` method
  * :oe:meth:`OEChem::OEOmegaConfTest::CompareMols` method
  * :oe:meth:`OEChem::OEDefaultConfTest::CompareMols` method

* Improved the performance of the following methods:

  * :oe:meth:`OEChem::OEAbsoluteConfTest::CompareMols` method
  * :oe:meth:`OEChem::OEIsomericConfTest::CompareMols` method
  * :oe:meth:`OEChem::OEOmegaConfTest::CompareMols` method

* :oe:meth:`OEChem::OEAtomBondSet::AddAtom` and
  :oe:meth:`OEChem::OEAtomBondSet::AddBond` will now return false when
  the trying to mix atoms from different molecules.

* :oe:meth:`OEChem::OEAtomBondSet::HasAtom` and
  :oe:meth:`OEChem::OEAtomBondSet::HasBond` added for testing for
  membership.

.. oe:language:: python 

   * :oe:func:`OEChem::OEGetTorsions` now works from Python.

.. oe:language:: python java csharp
 
   * The following functors are now properly wrapped in Python, Java,
     and C#:

     - :oe:cls:`OEIsTrueAtom<OESystem::OEIsTrue>`
     - :oe:cls:`OEIsFalseAtom<OESystem::OEIsFalse>`
     - :oe:cls:`OEIsTrueBond<OESystem::OEIsTrue>`
     - :oe:cls:`OEIsFalseBond<OESystem::OEIsFalse>`
     - :oe:cls:`OEIsTrueConf<OESystem::OEIsTrue>`
     - :oe:cls:`OEIsFalseConf<OESystem::OEIsFalse>`

   * The following functors are now deprecated: 

     - `OEChem::IsTrueAtom` 
     - `OEChem::IsFalseAtom` 
     - `OEChem::IsTrueBond` 
     - `OEChem::IsFalseBond` 
     - `OEChem::IsTrueConf` 
     - `OEChem::IsFalseConf` 

Documentation fixes
--------------------------------------------------------------------------------

* The :oe:constns:`OEChem::OEAroModel` namespace is now accessible from the table
  of contents.

OESystem 1.9.2
================================================================================

New features
--------------------------------------------------------------------------------

* Added the following non-linear color gradients:

  * :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>`
  * :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>`
  * :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>`

  These classes along with the :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class
  now derive from the :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>` base class.

.. oe:language:: c++

   * :oe:func:`OESystem::OECount` convenience function added for
     counting the number of items being held in an iterator.

   * :oe:func:`OESystem::OEIsEmpty` convenience function added for
     determining whether an iterator contains any items. 

Minor bug fixes
--------------------------------------------------------------------------------

* Fixed a possible link-time race condition with
  :oe:func:`OESystem::OEGetTag` that could cause a crash if
  :oe:func:`OESystem::OEGetTag` was used during link-time (library
  loading). 

* :ref:`OEColor <OESystem_OEColor>` could encounter a benign race condition
  during color clamping operations. 

.. oe:language:: c++

   * Parameter types for :oe:func:`OESystem::OECopyArray` and
     :oe:func:`OESystem::OEMoveArray` have been changed from unsigned
     int to size_t to reduce compiler warnings and increase
     compatibility with the underlying syscall.

   * :oe:cls:`OESystem::OEProtectedBuffer::Put` fixed to avoid a rare
     race condition when pushing in a null value.

   * :ref:`OEErrorHandler <OESystem_OEErrorHandler>` copy constructor and
     ``operator=`` argument changed from const to non-const as they
     were not actually const. These methods can pass ownership from
     the right-hand-side to the left-hand-side for the underling
     :ref:`OEErrorHandlerImplBase <OESystem_OEErrorHandlerImplBase>` object.

OEPlatform 1.9.2
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

.. oe:language:: c++

   * Windows C++ MT projects will no longer randomly crash at process
     exit due to OpenEye toolkit internals.

   * :ref:`OEThreadLocal <OEPlatform_OEThreadLocal>` destructor will now delete the
     object associated with the current thread. The object has to be
     destroyed at this point since after the
     :ref:`OEThreadLocal <OEPlatform_OEThreadLocal>` destructor finishes it is
     impossible to get the data stored in it again. Note, it is still
     undefined behavior to destroy a
     :ref:`OEThreadLocal <OEPlatform_OEThreadLocal>` object that is still being used by
     another thread.

* Calling `OEPlatform::oeofstream::append` after
  `OEPlatform::oeofstream::open` will no longer hang
  indefinitely once data is written to it.

Minor bug fixes
--------------------------------------------------------------------------------

.. oe:language:: c++
   
   * :ref:`OEOnce <OEPlatform_OEOnce>` performance improvement by using the
     clang compiler's built-in support instead of relying on a pthread
     implementation.

.. oe:language:: java

   * The java JVM can run out of memory when trying to free memory. If
     this is detected, the OpenEye toolkits will print the following
     message, "JNI::OutOfMemory -- the JAVA heap may need to be
     increased -- program terminating". Please increase the size of
     the java heap using the ``-Xmx`` option.

OEBio 1.9.2
================================================================================

* Minor internal improvements. 

OEGrid 1.4.3
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* :ref:`OESkewGrid <OESystem_OESkewGrid>` now properly initializes its base
  class :ref:`OEGridAbstractBase <OESystem_OEGridAbstractBase>` during construction.

* The :oe:const:`OESystem::OEGridFileType::Ascii` format will now try
  harder to detect any incorrect file formatting issues and warn about
  them.

Documentation fixes
--------------------------------------------------------------------------------

* The ``ASCIIWriter`` documentation example in the :ref:`Grid Input
  and Output<section_grid_input_output>` section was incorrect as it
  was writing out both grid indices and grid values.


.. _section_oechem_releasenotes_193:

********************************************************************************
Version 1.9.3
********************************************************************************

OEChem 1.9.3
================================================================================

New features
--------------------------------------------------------------------------------

* Added the following atom and bond predicates:

  * :ref:`OEAtomIsInChain <OEChem_OEAtomIsInChain>`
  * :ref:`OEBondIsInChain <OEChem_OEBondIsInChain>`
  * :ref:`OEIsHetero <OEChem_OEIsHetero>`
  * :ref:`OEIsMetal <OEChem_OEIsMetal>`
  * :ref:`OEHasHvyDegree <OEChem_OEHasHvyDegree>`
  * :ref:`OEHasFormalCharge <OEChem_OEHasFormalCharge>`

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OECreateInChI` now passes the following information
  to the InChI library when calling the :oe:func:`OEChem::OECreateInChI`
  function:

  - atom coordinates 
  - wedge/hash bond property for single bonds
  - "either" bond property read from MDL file formats for double bonds
 
  These changes have reduced the number of failure cases to 10 when 
  reading the MDDR database in SDF format and testing the InChI strings 
  generated by :oe:func:`OEChem::OECreateInChI` against the strings generated 
  by the stand-alone InChI application.

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:meth:`OEChem::OEIsAtomHybridization::operator()` method now
  checks whether the hybridization was perceived and calculates the 
  hybridization of the atom on the fly by calling 
  :oe:func:`OEChem::OEGetHybridization` if necessary.

* The previously release of **OEChem**, 1.9.2, started considering
  different isotopes of hydrogen for chirality perception. This
  incorrectly perceived the following molecules as chiral: "C[2H]",
  "CC[2H]" and "C([2H])[3H]". Atoms with one or two isotope hydrogen neighbors
  and at least two implicit hydrogens will no longer be considered chiral.

* When reading MacroModel molecule files (.mmod, .mmd, and .dat), atom serial 
  numbers and HETATM designations were not being set, and subsequently saving
  the molecules in PDB format resulted in poorly formed files.  This has been
  corrected so that conversion from MacroModel to PDB files preserves residue 
  information properly.

* :oe:func:`OEChem::OESmilesToMol` and :oe:func:`OEChem::OEInChIToMol`
  will now call :oe:meth:`OEChem::OEMolBase::Clear` before parsing the
  string into the molecule.

Documentation fixes
--------------------------------------------------------------------------------

* The ``OEMMFF*`` functions are now properly documented. 

OESystem 1.9.3
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* ``OESystem::OEErrorHandlerStream::Msg`` now calls ``exit(EXIT_FAILURE)``
  in case of :oe:const:`OESystem::OEErrorLevel::Fatal` level 
  and calls ``exit(EXIT_SUCCESS)`` in case of :oe:const:`OESystem::OEErrorLevel::Usage`.

* :ref:`OEInterface <OESystem_OEInterface>` will no longer strip trailing zero
  characters from parameters that are non-floating point types. For
  example, "-prefix 1.10" used to return "1.1". This bug was
  introduced in OEChem 1.9.0.

OEPlatform 1.9.3
================================================================================

* :oe:meth:`OEPlatform::oeistream::gettoken` will no longer improperly
  write a NULL character at ``buffer[max]`` location in memory in rare
  circumstances when the token is the exact same size as the buffer.

OEGrid 1.4.4
================================================================================

* Fixed a rare crash when interpolating between grids. This affects
  many API points, including GridBabel, whenever converting a grid to
  another grid type.


.. _section_oechem_releasenotes_200:

********************************************************************************
Version 2.0.0
********************************************************************************

OEChem 2.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OEMolDatabase <OEChem_OEMolDatabase>` class added for providing fast random
  read-only access to all the file formats **OEChem** supports. Please
  see the new :ref:`Molecular Database Handling <chapter_moldatabase>` chapter
  of the documentation for a more thorough description.

.. warning::

   The meaning of the :file:`.smi` file extension has changed in
   OEChem 2.0. The :file:`.smi` file extension will now retain
   stereochemistry information. This could cause problems for systems
   that relied upon :file:`.smi` to strip away stereo chemistry.

* The following changes have been made to how OEChem defines the
  various flavors of SMILES (see images demonstrating these changes in
  :ref:`Table: SMILES File Formats <table_SMILES_changes>`):

  * The ``.smi``, :oe:const:`OEChem::OEFormat::SMI`, file format outputs
    :term:`Canonical isomeric SMILES`.

  * :oe:const:`OEChem::OEFormat::USM` file format added (with the
    :file:`.usm` file extension) that allows the generation of
    non-canonical, non-isomeric :term:`SMILES`, i.e., the OEChem 1.x
    definition of the :file:`.smi` file extension.

  * :oe:func:`OEChem::OEGetFormatString` returns more descriptive
    values for the various flavors of :term:`SMILES` regarding
    canonicalization and stereo information.

  * The default file format for molecule streams is now
    :oe:const:`OEChem::OEFormat::SMI` and is identical to the
    :oe:const:`OEChem::OEFormat::ISM` format.

  .. _table_SMILES_changes:

  .. list-table:: **SMILES File Formats**

     * - .. image:: ../../oechemtk/images/releasenotes-2.0.0/SmilesFormats-Version1_9_3.*
       - .. image:: ../../oechemtk/images/releasenotes-2.0.0/SmilesFormats-Version2_0_0.*

* :oe:const:`OEChem::OEFormat::CSV` file format added to **OEChem** for
  round-tripping molecules and SD data to other software packages that
  support the comma-separate-value, :file:`.csv`, file
  format. **OEChem** supports the :file:`.csv` file format that has
  largely become ubiquitous and is now standardized by `RFC 4180
  <http://tools.ietf.org/html/rfc4180>`_. The following APIs were
  added for handling CSV files in **OEChem**:

  - :oe:func:`OEChem::OEReadCSVFile`
  - :oe:func:`OEChem::OEWriteCSVFile`
  - :oe:func:`OEChem::OECreateCSVHeader`
  - :ref:`OECSVHeader <OEChem_OECSVHeader>`
  - :oe:meth:`OEChem::oemolstreambase::GetCSVHeader`
  - :oe:meth:`OEChem::oemolstreambase::ClearCSVHeader`

* Added automatic 2D coordinate generation to the following file formats when
  invoking the :oe:func:`OEChem::OEWriteMolecule` high-level molecule writer:

  * In case of the :oe:const:`OEChem::OEFormat::MDL` and the
    :oe:const:`OEChem::OEFormat::SDF` file formats,
    2D coordinates are generated if the molecule has no coordinates *i.e.*
    existing 2D or 3D coordinates will be left intact.

  * In case of the :oe:const:`OEChem::OEFormat::CDX` file format, 2D coordinates
    are generated if the molecule has no 2D coordinates.

  This default behavior can be turned off by using the
  :oe:const:`OEChem::OEOFlavor::MDL::Add2D`,
  :oe:const:`OEChem::OEOFlavor::SDF::Add2D` and
  :oe:const:`OEChem::OEOFlavor::CDX::Add2D` flags, respectively.

* :oe:func:`OEChem::OEGetFormatExtension` will now return the most
  common file extension as the first element in the comma separated
  list for the :oe:const:`OEChem::OEFormat::PDB`,
  :oe:const:`OEChem::OEFormat::SDF`, and
  :oe:const:`OEChem::OEFormat::RDF` file formats.

* :oe:func:`OEChem::OEGenerate2DCoordinates` added to assign 2D
  coordinates to the given molecule.

* :oe:meth:`OEChem::OEMatchBase::IsValid` and :oe:meth:`operator
  bool<OEChem::OEMatchBase::operator bool>` methods added.

* :ref:`OERoleSet <OESystem_OERoleSet>` abstract base class added as a mixin
  class to allow a class to contain a set of :ref:`OERole <OESystem_OERole>`
  objects for classification purposes. This is similar to how the
  :ref:`OEBase <OESystem_OEBase>` class provides associative data container
  behavior as "generic data". The following classes already derive
  from :ref:`OERoleSet <OESystem_OERoleSet>`:

  - :ref:`OEMatchBase <OEChem_OEMatchBase>`
  - :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`

  More classes across the toolkits may be added in the future as
  dictated by needs.

* :oe:meth:`OEChem::oemolstreambase::GetFileName` method added to all
  molecule streams to return the file name used to open the stream, if
  a file name was used.

* :oe:meth:`OEChem::OEMatchBase::IsValid` method added for determining
  whether the match contains any atoms or bonds.

* :oe:func:`OEChem::OEAssignZap7Radii` function added to assign radii
  from the ZAP7 set.

* :oe:func:`OEChem::OEParseSmilesOptions` class added for adding more
  complex :term:`SMILES` parsing options for the
  :oe:func:`OEChem::OEParseSmiles` function. This added the ability to
  make :oe:func:`OEChem::OEParseSmiles` quiet with regard to parsing
  failures through the
  :oe:meth:`OEChem::OEParseSmilesOptions::SetQuiet` method.

.. oe:language:: python

   * :ref:`OEGraphMol <OEChem_OEGraphMol>` and :ref:`OEMol <OEChem_OEMol>` are now
     picklable through the Python ``pickle.dumps`` and
     ``pickle.loads``.

   * :ref:`OEResidue <OEChem_OEResidue>` is now hashable in Python and thus
     usable as a dictionary key.

.. oe:language:: c++

   .. warning::

      ``OEChem::OEConfBase::operator C *`` has been removed
      from the API. C++ users who used this API for direct coordinate
      access or derived their own classes from
      :ref:`OEConfBase <OEChem_OEConfBase>` will need to change to the
      following different idiom.

   * ``OEChem::OEConfBase::operator C *`` has been removed in
     favor of the new :oe:meth:`OEChem::OEConfBase::GetCoordsPtr`
     methods. This allows implementations of
     :ref:`OEConfBase <OEChem_OEConfBase>` to use alternative data storage for
     coordinates, e.g., 64-bit ``double`` precision floating
     point. Users of :ref:`OEConfBase <OEChem_OEConfBase>` should not use
     :oe:meth:`OEChem::OEConfBase::GetCoordsPtr` directly, instead
     relying on the :ref:`OEConstCoords <OEChem_OEConstCoords>` and
     :ref:`OEMutableCoords <OEChem_OEMutableCoords>` convenience classes.

   * Due to the above change, the following code will now fail to compile:

     .. code-block:: c++

        OEMol mol;
        for (OEIter<OEConfBase> conf = mol.GetConfs(); conf; ++conf)
          mol.NewConf(*conf);

     This code was not doing what most programmers thought it was
     doing. It was actually implicitly casting the ``OEConfBase &``
     into a ``float *`` and then calling the version of ``NewConf``
     that takes a ``float`` pointer. Users should change their code to
     the following:

     .. code-block:: c++

        OEMol mol;
        for (OEIter<OEConfBase> conf = mol.GetConfs(); conf; ++conf)
          mol.NewConf(conf);

   * The following methods that rely on ``OEConfBaseT<float, 2>`` and
     ``OEConfBaseT<double, 3>`` template instatiations were removed and
     replaced with :ref:`OEMolBase <OEChem_OEMolBase>` versions:

     - :oe:meth:`OEChem::OETransBase::Transform`
     - :oe:meth:`OEChem::OETrans::Transform`

   .. note::

      This is part of a larger effort to migrate away from the
      ``OEChem::OEConfBaseT`` template class in favor a pure
      abstract :ref:`OEConfBase <OEChem_OEConfBase>` class to allow for
      conformer storage in formats other than 32-bit precision
      ``float``. This will only affect C++ users of the toolkit, even
      then, users who only used ``OEConfBase`` as a typedef should not
      be affected.

Major bug fixes
--------------------------------------------------------------------------------

* The :oe:const:`OEChem::OEFormat::MDL` V3000 file format was unable to
  read multiple molecules from the same file if they were all in the
  V3000 format. Note, this did not affect the
  :oe:const:`OEChem::OEFormat::SDF` files containing V3000 as those
  files contain '$ $ $ $' to delimit separate molecule records.

* ``OEChem::OEReadHeader`` will no longer corrupt the stack by
  arbitrarily zeroing out bytes on the stack whenever no
  :ref:`OEHeader <OESystem_OEHeader>` record is found in the
  :oe:const:`OEChem::OEFormat::OEB` file.

* :oe:meth:`OEChem::OEMatch::AddPair` will no longer crash if
  :oe:meth:`OEChem::OEMatch::Clear` was previously called.

* :oe:meth:`OEChem::oemolthreadbase::PutMol` will now destroy the
  pointer passed to it if the underlying buffer returns ``false``,
  e.g., the buffer has already been closed.

* :oe:func:`OEChem::OEAddMols`, :oe:func:`OEChem::OESuppressHydrogens`,
  and :oe:func:`OEChem::OEPerceiveSymmetry` will no longer cause a
  stack overflow and crash when the molecule has a large number of
  atoms.

.. oe:language:: java

   - This fixed a non-deterministic Java JVM hotspot crashes.

.. oe:language:: java

   * Java performance optimized for functions that return arrays of
     :ref:`OEAtomBase <OEChem_OEAtomBase>` or :ref:`OEBondBase <OEChem_OEBondBase>` as
     output arguments, like :oe:func:`OEChem::OESubsetMol`.

.. oe:language:: python java csharp

   * A subtle memory and performance bug was fixed for the
     :ref:`OEMol <OEChem_OEMol>`, :ref:`OEGraphMol <OEChem_OEGraphMol>`, and
     :ref:`OEQMol <OEChem_OEQMol>` copy constructors. Every time a copy was
     made an extra layer of proxy object was created, causing memory
     consumption to increase, as well as making any subsequent use of
     that object slower.

Minor bug fixes
--------------------------------------------------------------------------------

* Removed unimplemented ``OEChem::OEFormat::TDT`` file format.

* Removed ``OEChem::OEFormat::BIN`` format after being
  deprecated for 10 years.

* :oe:func:`OEChem::OEMolToSmiles` no longer outputs the title of the
  molecule.

* If :oe:func:`OEChem::OE3DToAtomStereo` or
  :oe:func:`OEChem::OE3DToBondStereo` throws a warning message during a
  call to :oe:func:`OEChem::OEMolToSmiles`, the warning message will no
  longer erroneously say it is during a call to ``OEWriteMolecule``.

* :oe:func:`OEChem::OESetComment` and :oe:func:`OEChem::OEGetComment`
  have have been slightly optimized for speed. There is also a larger
  optimization for memory and file space in the :file:`.oeb`
  format. Previously, setting the comment to an empty string would
  write superfluous data to the :file:`.oeb` file.

* :oe:func:`OEChem::OECopySDData` and :oe:func:`OEChem::OECopyPDBData`
  will no longer increase the memory consumption of the destination
  molecule whenever the source molecule does not contain any
  data. This was causing :oe:const:`OEChem::OEFormat::PDB` files read
  into a :ref:`OEMCMolBase <OEChem_OEMCMolBase>` to use more memory than
  necessary.

* :oe:const:`OEChem::OEFormat::MOL2` parser will no longer create bonds
  with zero-order from "dummy bonds". Zero-order bonds cause problems
  for many **OEChem** algorithms like :oe:func:`OEChem::OEKekulize`.

* :oe:const:`OEChem::OEFormat::MOL2` parser will now properly ignore
  lines between molecule records that start with the pound sign,
  "#". Previously, these lines would cause **OEChem** to spew a lot of
  warnings and cause the parser to fail.

Documentation fixes
--------------------------------------------------------------------------------

* The chapter about InChI failures has been removed since most of the
  InChI failures were fixed in the last release, **OEChem** 1.9.3 in
  2013.Oct.

* Release notes section re-organized to make the current release more
  prominent.

.. oe:language:: python

   * How to use :oe:func:`OEChem::OEDetermineRingSystems` from Python
     more thoroughly described.

.. oe:language:: c++ python

   * Added documentation and code example for
     :oe:func:`OEChem::OESmartsLexReplace`. The old function named
     ``SmartsLexReplace`` without the leading ``OE`` is considered
     deprecated and has been removed from the documentation.

OESystem 2.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* Added support for handling the comma-separated-value, CSV, format
  specified by `RFC 4180 <http://tools.ietf.org/html/rfc4180>`_ with
  the following two free functions:

  - :oe:func:`OESystem::OEStringCSVJoin` for creating a CSV record
  - :oe:func:`OESystem::OEStringCSVTokenize` for parsing a CSV record

  The following low-level functions were added support
  CSV handling but can be ignored by most users:

  - :oe:func:`OESystem::OEStringCSVQuote` added
  - :oe:func:`OESystem::OEStringCollapseQuotes` added
  - :oe:func:`OESystem::OEStringStripQuotes` added

.. oe:language:: c++

   * :oe:func:`OESystem::OEStringJoin` now accepts a parameter to
     determine if the output string should end with the selected
     delimiter.

   * :oe:func:`OESystem::OEStringTokenizeQuoted` added a parameter for
     whether consecutive delimiters should be treated as a single
     delimiter. The default behavior is exactly the same as previous
     versions.

* :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` class added for storing floating
  point data as a 16-bit representation as specified by the `IEEE
  754-2008 standard
  <http://ieeexplore.ieee.org/xpl/articleDetails.jsp?reload=true&arnumber=4610935>`_
  to save on memory consumption and bandwidth.

.. oe:language:: c++

   - Collections of :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` objects,
     ``std::vector`` and arrays, can be attached to
     :ref:`OEBase <OESystem_OEBase>` objects and round-tripped through
     :file:`.oeb` files to save on disk size.

* The performance of reading plain-old-data attached to
  :ref:`OEBase <OESystem_OEBase>` objects from :file:`.oeb` files has been
  improved by about %10.

* :oe:func:`OESystem::OEErrorLevelToString` free function added.

* :oe:func:`OESystem::OEBFPosTEndian` added for allowing 64-bit
  integers to be round-tripped to binary formats regardless of machine
  endian-ness.

.. oe:language:: c++

  * ``OESystem::OEWriteData`` added to allow easily writing any
     data type as binary.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:constns:`OESystem::OEThrow` mutex handling has been
  migrated from :ref:`OEErrorHandler <OESystem_OEErrorHandler>` down a level into
  ``OESystem::OEErrorHandlerStreamImpl``. This fixes the following issues:

  - The mutex can now be properly released during a process exit like
    :oe:meth:`OESystem::OEErrorHandler::Fatal`.
  - A deadlock will no longer occur if the implementation of
    :oe:meth:`OESystem::OEErrorHandlerImplBase::Msg` needs to throw a
    message itself.
  - Allows alternative faster and more scalable implementations of
    :ref:`OEErrorHandlerImplBase <OESystem_OEErrorHandlerImplBase>` to be created and used
    with :oe:constns:`OESystem::OEThrow`.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OESystem::OEBitVectorNumWords` and
  :oe:func:`OESystem::OEBitVectorNumBytes` now take and return
  ``size_t``.

* ``OESystem::OEBinaryTagMaxLength`` constant added and set to
  1024, the maximum length of an explicit string tag in the
  :file:`.oeb` file format.

* :oe:func:`OESystem::OEStringTokenizeQuoted` will no longer treat a
  quote as the end quote of a field if it is escaped by another
  quote. :ref:`Table: OEStringTokenizeQuoted Change
  <table_OEStringTokenizeQuoted_changes>` demonstrates the change to
  support proper CSV parsing.

  .. _table_OEStringTokenizeQuoted_changes:

  .. list-table:: **OEStringTokenizeQuoted Change**

     * - OEChem 1.x
       - "foo"",bar",blah
       - ``"foo""``|``bar"``|``blah``
     * - OEChem 2.0+
       - "foo"",bar",blah
       - ``"foo"",bar"``|``blah``

* The size of :oe:func:`OESystem::OEBitVector` object has been
  increased from 12 bytes to 16 bytes on 64-bit machines. The size is
  still 8 bytes on a 32-bit machine.

.. oe:language:: python java csharp

   * The :ref:`OEErrorHandlerImplBase <OESystem_OEErrorHandlerImplBase>` copy constructor is
     now usable in Python, Java, and C#.

Documentation fixes
--------------------------------------------------------------------------------

* :ref:`IsTrue <OESystem_IsTrue>` and :ref:`IsFalse <OESystem_IsFalse>` are
  deprecated and will be removed in ``OEChem 3.0``, please convert to
  using :ref:`OEIsTrue <OESystem_OEIsTrue>` and :ref:`OEIsFalse <OESystem_OEIsFalse>`.

* :ref:`OEUnaryTrue <OESystem_OEUnaryTrue>` and :ref:`OEUnaryFalse <OESystem_OEUnaryFalse>`
  documented as acceptable synonyms of :ref:`OEIsTrue <OESystem_OEIsTrue>` and
  :ref:`OEIsFalse <OESystem_OEIsFalse>`.

OEPlatform 2.0.0
================================================================================

New features
--------------------------------------------------------------------------------

.. oe:language:: python java csharp

   * :oe:func:`OEPlatform::OEAddLicenseFromHttp` added to license
     the current process with an OpenEye license file retrieved from a
     valid URL. The only supported URL schemes are HTTP and HTTPS. A
     reference implementation of a license server can be found at:
     (https://github.com/oess/HttpLicenseServer).

* :oe:func:`OEPlatform::OEAddLicenseData` function added to parse a
  string as if it is an OpenEye license file and then license the
  current process with it.

.. oe:language:: c++

   * :ref:`OELockCondition <OEPlatform_OELockCondition>` class added to provide a
     scoped lock on :ref:`OECondition <OEPlatform_OECondition>` objects.

Major bug fixes
--------------------------------------------------------------------------------

* `OEPlatform::oeistream::size` was incorrectly being
  truncated to 32-bits on 32-bit machines. This resulted in incorrect
  file sizes being reported for files over 4 gigabytes in size on
  32-bit machines.

* `OEPlatform::oeifstream::tell` would return incorrect values
  if called after `OEPlatform::oeifstream::size` and after
  some bytes were already read from the stream.

Minor bug fixes
--------------------------------------------------------------------------------

* ``OEPlatform::OEMallocaPtr::GetPtr`` added to allow the object
  to be explicitly converted to a pointer type.

* :ref:`OEMutex <OEPlatform_OEMutex>` and :ref:`OETryMutex <OEPlatform_OETryMutex>`
  destructors will now destroy themselves on ``pthread`` based
  systems. Destroying mutexes is optional according to the ``pthread``
  standard, but helpful in debugging possible deadlocks.

* :ref:`OEMutex <OEPlatform_OEMutex>` and :ref:`OETryMutex <OEPlatform_OETryMutex>` no
  longer use ``gthreads``, instead using ``pthreads``, allowing for
  integration with non-GCC systems like libc++ on OSX.

OEGrid 1.4.5
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* :oe:const:`OESystem::OEGridFileType::Ascii` file writer will no
  longer sometimes corrupt the stack and crash.

* When reading a CCP4 file, the standard deviation stored in the CCP4 header
  is now used to normalize the file.

* OENormalizeGrid now properly normalizes by sigma (not variance)

* Writing CCP4 maps now uses the original map statistics when possible.

* Rotated skew grids attached as generic data are now round-trippable when saved to OEB

* Fixed a crash when interpolating grids where the rotation matrix inverts the target grids
  bounding box

* MTZ files with more than 18 columns are now read properly

* Fixed a memory leak in :oe:meth:`OEBio::OESequenceAlignment`.

* The constructor for the predicate :ref:`OEHasResidueNumber <OEChem_OEHasResidueNumber>` now takes
  an int rather than an unsigned int because residue numbers can be negative.




.. _section_oechem_releasenotes_201:

********************************************************************************
Version 2.0.1
********************************************************************************

OEChem 2.0.1
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:meth:`OEChem::OEMolBase::SetCoords` will now reset the atom and
  bond stereo perception flags,
  :oe:const:`OEChem::OEPerceived::AtomStereo` and
  :oe:const:`OEChem::OEPerceived::BondStereo` respectively. This can
  force reperception of the stereo information from the new
  coordinates by other functions that may need it. For example, a
  later call to :oe:func:`OEChem::OEWriteMolecule` will now
  automatically call :oe:func:`OEChem::OE3DToAtomStereo`.

* :oe:func:`OEChem::OECopyMol` function added to make a copy of a molecule and return
  the atom or bond associations between the source and destination molecules.

* :oe:meth:`OEChem::OEMolBase::ClearBase` method added to allow
  clearing generic data on the :ref:`OEMolBase <OEChem_OEMolBase>` without
  destroying the molecule itself.

* :oe:meth:`OEChem::OEUniMolecularRxn::SetValidateKekule` method added
  to allow skipping the Kekule validation step after the reaction is
  applied. Note, this allows :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` to
  return radicals, leaving clean up to the user.

* :oe:func:`OEChem::OESuppressHydrogens` can now suppress hydrogens at
  specific heavy atom sites.

* :ref:`OENthAtom <OEChem_OENthAtom>` predicate's 2nd argument now defaults to ``0`` to be
  easier to use.

* :oe:func:`OEChem::OEGetMolDatabaseIdxFileName` added to generate
  index file names from database file names using the same rules as
  :oe:func:`OEChem::OECreateMolDatabaseIdx` and
  :oe:cls:`OEChem::OEMolDatabase::Save`.

.. oe:language:: python

   * :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` now supports the ``str`` Python
     built-in function. Calling ``str`` on an
     :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` will now return a string like the
     following:

     .. code-block:: python

        >>> mol = OEGraphMol()
        >>> OESmilesToMol(mol, "c1ccccc1O")
        True
        >>> str(OEAtomBondSet(mol.GetAtoms()))
        '[7] 0C 1C 2C 3C 4C 5C 6O '

   * :ref:`oemolistream <OEChem_oemolistream>`, :ref:`oemolithread <OEChem_oemolithread>`,
     :ref:`oemolostream <OEChem_oemolostream>`, :ref:`oemolothread <OEChem_oemolothread>` now
     support the Python ``with`` statement. This ensures that files
     are automatically flushed and closed whenever falling out of
     the ``with`` scope. For example:

     .. code-block:: python

        mol = # some initialized molecule
        with oemolostream("file.oeb") as ofs:
            OEWriteMolecule(ofs, mol)

        # file.oeb is guaranteed to contain the molecule
        with oemolistream("file.oeb") as ifs:
            for mol in ifs.GetOEMols():
                # do something with mol

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEMMFFAtomType` will no longer crash whenever an
  unbonded sulfur with a single implicit hydrogen is encountered.

* :oe:func:`OEChem::OEAssignAromaticFlags` now invokes the
  :oe:func:`OEChem::OEFindRingAtomsAndBonds` function, when necessary.
  If no ring atoms are detected in the molecule, the
  :oe:func:`OEChem::OEAssignAromaticFlags` functions
  returns after setting all atoms and bonds of the molecule to be non-aromatic.

* The :ref:`OESubSearch <OEChem_OESubSearch>` class now throws a warning in the following
  two cases:

  * If there are only explicit hydrogens in the pattern, but the target has only
    implicit hydrogens.
  * If there are only implicit hydrogens in the pattern, but the target has only
    explicit hydrogens.

  These warnings are necessary in order to avoid substructure match failures that
  are the result of mismatched hydrogen representation.

* The :oe:func:`OEChem::OEGetFileType` function now returns
  :oe:const:`OEChem::OEFormat::UNDEFINED` for file extensions that
  contain extra characters after the known file extension. For
  example, ``ismama`` used to inappropriately return
  :oe:const:`OEChem::OEFormat::ISM`. The only exception is if the extra
  characters are preceded by ".". Therefore, the following strings are
  still considered valid: ``sdf.gz``, ``sdf.bin``, and ``sdf.zip``.

* V3000 entries with a broken atom or bond block will no longer crash,
  the reader will now throw a warning and skip the molecule.

* :oe:func:`OEChem::OEMDLPerceiveBondStereo` function will no longer
  clear wavy bonds, :oe:const:`OEChem::OEBondStereo::Wavy`, since this
  property can not be re-perceived from other information.  The MDL
  bond stereo can be removed by calling the new
  :oe:func:`OEChem::OEMDLClearBondStereo` function.

* :oe:func:`OEChem::OEWriteMDLFile` no longer has a subtle race
  condition that could lead to incorrect time stamps being written in
  the header. The race condition was caused by the use of the standard
  C library ``localtime`` function.

* `OEChem::oemolithread::open` will no longer crash when given
  an empty :file:`.csv` file.

* :oe:func:`OEChem::OEReadMDLReactionQueryFile` previously incorrectly
  required "M END" lines between reactant and product blocks. These
  lines are no longer required and will be ignored if they are
  encountered. This change allows reaction query files to be read that
  are generated by ChemDraw and the Accelrys Enterprise Platform.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEChem::OEMolDatabase::GetTitle` will no longer return a
  corrupted title for multi-molecule :file:`.mol2` files.

* :oe:func:`OEChem::OEGenerate2DCoordinates` will now handle a molecule
  as a reaction if any of its atoms have a reaction role other than
  :oe:const:`OEChem::OERxnRole::None`. Previously, only molecules that
  returned ``true`` from :oe:meth:`OEChem::OEMolBase::IsRxn` would be
  handled as reactions.

* **OEChem 2.0.0**, the previous release, introduced automatic 2D
  coordinate generation when writing to the following file formats:
  :oe:const:`OEChem::OEFormat::SDF`, :oe:const:`OEChem::OEFormat::MDL`,
  and :oe:const:`OEChem::OEFormat::CDX`. However, coordinate generation
  will only occur if :oe:meth:`OEChem::OEMolBase::GetDimension` does
  not return 2 or 3, indicating that the molecule already contains
  coordinates. :oe:func:`OEChem::OEWriteMolecule` will now throw a
  warning message if coordinates are detected on the molecule and
  :oe:meth:`OEChem::OEMolBase::SetDimension` was not appropriately
  called. Users should either call
  :oe:meth:`OEChem::OEMolBase::SetDimension` to the appropriate
  dimensionality of the molecule, or clear the molecule's coordinates.

  .. note::

     :file:`.cdx` files will still automatically generate 2D
     coordinates from 3D molecules since :file:`.cdx` is a 2D molecule
     format only.

* :oe:func:`OEChem::OEAssignAromaticFlags` used to only set atoms to
  non-aromatic if no ring bonds were found. Bond aromaticity will now
  be cleared as well if no ring atoms are found.

* :oe:func:`OEChem::OECreateMolDatabaseIdx` will no longer crash
  whenever called inside a directory without write permissions.

* `OEChem::oemolostream::seekp` removed since it did not do
  anything.

* :oe:func:`OEChem::OESmartsLexReplace` argument is now ``const`` since
  the function does not need to alter the vector.

* Removed unbounded stack allocations.

* The partial support for CPSS-style rxnfiles has been entirely removed as this format
  is documented as obsolete in the CTfile format specification.

* :oe:func:`OEChem::OEAddExplicitHydrogens` no longer has the rare
  chance of using uninitialized memory when sprouting hydrogens in 3D.

* :oe:func:`OEChem::OEReadMDLQueryFile` will now interpret ``![N,O,S]``
  as ``![N,O,S,H]`` to be consistent with MDL matching
  behavior.

* :oe:meth:`OEChem::OEOmegaConfTest::CompareMols`,
  :oe:meth:`OEChem::OEIsomericConfTest::CompareMols`,
  :oe:meth:`OEChem::OEAbsoluteConfTest::CompareMols` will all now
  return ``true`` if the only difference between the bonds of the two
  molecules is whether the ``Bgn`` and ``End`` bonds have been
  swapped.

.. oe:language:: java

   * :oe:func:`OEChem::OESmartsLexReplace` is now properly wrapped in Java.

.. oe:language:: java csharp

   * The :ref:`OETorsion <OEChem_OETorsion>` parameters to
     :oe:meth:`OEChem::OEMCMolBase::NewConf` are now properly wrapped.

Documentation fixes
--------------------------------------------------------------------------------

* All examples should now use :oe:func:`OEChem::OESmilesToMol` instead of
  :oe:func:`OEChem::OEParseSmiles`. :oe:func:`OEChem::OESmilesToMol` is
  the preferred safer method for parsing :term:`SMILES`.

* Simplified the documentation for the basic molecule class
  hierarchy. Previously, documentation was spread between the base
  class and the concrete classes. The base class sections should now
  be the canonical place to look for specific method documentation.

  * For :ref:`OEGraphMol <OEChem_OEGraphMol>` methods, see the
    :ref:`OEMolBase <OEChem_OEMolBase>` section

  * For :ref:`OEMol <OEChem_OEMol>` methods, see the
    :ref:`OEMCMolBase <OEChem_OEMCMolBase>` section

  * For :ref:`OEQMol <OEChem_OEQMol>` methods, see the
    :ref:`OEMolBase <OEChem_OEMolBase>` section

* Added documentation for :ref:`OEConfBase <OEChem_OEConfBase>` and
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>` classes that are instantiations of
  ``OEChem::OEConfBaseT`` and ``OEChem::OEMCMolBaseT``
  template classes, respectively.

* Added missing documentation for the :ref:`OEConfBase <OEChem_OEConfBase>`
  and :ref:`OEMCMolBase <OEChem_OEMCMolBase>` classes.

* Generated new images for the :ref:`Explicit Hydrogens
  <section_mdlqueries_hydrogens>` section of the :ref:`Substructure
  Search with MDL Queries <chapter_mdlqueries>` chapter

* Memory leak fixed in ``NewConfFromCoords`` documentation example.

* Corrected a link to the CTfile format document from Accelrys, Inc.

* :oe:constns:`OEChem::OEProperty` namespace formatting fixed in PDF
  files to actually be readable.

* :ref:`OEOmegaConfTest <OEChem_OEOmegaConfTest>` added to the conformer test section
  for :ref:`Input and Output <section_oemol_inputandoutput>`.

.. oe:language:: csharp

   * C# code snippets added to the :ref:`Molecular Database Handling
     <chapter_moldatabase>` chapter.

OEBio 2.0.1
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEBio::OESetRotamer` can properly set rotamers with angles of 0.0.
  Previously the angle was silently left unchanged.

OESystem 2.0.1
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OEInterface <OESystem_OEInterface>` can now report all the OpenEye
  toolkit libraries being used by specifying ``--help versions`` on
  the command line.

* :oe:func:`OESystem::OEParseCommandLine` now accepts an argument for
  specifying the program's version number. This version number will be
  printed whenever ``--version`` is found on the command line.

* :oe:const:`OESystem::OEMemPoolMode::Spinlocked` memory pool mode
  added to provide a more efficient mutual exclusion mechanism than
  mutexes for the small object caches.

* Added the following functions to provide predefined sets
  of colors:

  * :oe:func:`OESystem::OEGetColors`
  * :oe:func:`OESystem::OEGetContrastColors`
  * :oe:func:`OESystem::OEGetDeepColors`
  * :oe:func:`OESystem::OEGetLightColors`
  * :oe:func:`OESystem::OEGetVividColors`

* Added the following colors:

  * :oe:const:`OESystem::OESystem::OEBrass`
  * :oe:const:`OESystem::OESystem::OECopper`
  * :oe:const:`OESystem::OESystem::OEGold` (the original color was renamed to :oe:const:`OESystem::OESystem::OEMandarin`)
  * :oe:const:`OESystem::OESystem::OESilver`
  * :oe:const:`OESystem::OESystem::OEPewter`

.. oe:language:: python

   * :oe:meth:`OESystem::OEBase::SetData` now accepts Python sequences
     of strings for data. Note, this data can not be read or written
     to :file:`.oeb` files.

   * :ref:`OEColor <OESystem_OEColor>` will now ``repr`` to a more
     appropriate string representation suitable for the Python
     interpreter as shown below.

   .. code-block:: python

      >>> OERed
      OEColor(r=255,g=0,b=0,a=255)
      >>> OEGreen
      OEColor(r=0,g=255,b=0,a=255)
      >>> OETransparentColor
      OEColor(r=255,g=255,b=255,a=0)

Minor bug fixes
--------------------------------------------------------------------------------

* Removed unbounded stack allocations.

* :oe:cls:`OESystem::OEHeader::SetDate` no longer has a subtle race
  condition due to the use of the standard C library ``localtime``
  function.

.. oe:language:: python

   * ``OE*Array`` classes will now throw a reasonable error message
     when attempting to index with a floating point number. This can
     occur more easily due to division change in Python 3.

.. oe:language:: c++

   * :oe:func:`OESystem::OEMakeString` used to be limited by an
     internal buffer to only output strings with less than 8192
     characters. The function will now allow any output size string to
     be created.

Documentation fixes
--------------------------------------------------------------------------------

* Added missing documentation for the following colors:

  * :oe:const:`OESystem::OESystem::OEGreenBlue`
  * :oe:const:`OESystem::OESystem::OEGreenTint`

OEPlatform 2.0.1
================================================================================

New features
--------------------------------------------------------------------------------

.. oe:language:: c++

   * :ref:`OESpinlock <OEPlatform_OESpinlock>` and
     :ref:`OELockSpinlock <OEPlatform_OELockSpinlock>` classes added to provide
     mutual exclusion to cheap sections of code with less overhead
     than :ref:`OEMutex <OEPlatform_OEMutex>`.

   * :oe:func:`OEPlatform::OELocalTime` added as a cross platform thread
     safe equivalent to the standard C library ``localtime`` function.

   * :oe:func:`OEPlatform::OECurrentTime` overload added to return the
     current time in a standard C library ``struct tm`` object in a
     thread safe manner.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEPlatform::OEGetPlatformInfo` will now return Windows
  versions for ``Windows Vista`` through ``Windows 8.1``.

* :oe:func:`OEPlatform::OEGetProcessorInfo` would previously only show
  Pentium III for newer chips on Windows. The function will now interrogate the
  chip using the ``cpuid`` instruction.

.. oe:language:: c++

   * :oe:func:`OEPlatform::OECurrentTime` is now thread safe. The function
     was not thread safe due to the standard C library ``localtime`` and
     ``asctime`` functions not being thread safe. This was causing
     writing files to the following file formats to not be thread safe:
     :file:`.svg`, :file:`.ps`.

   * :oe:meth:`OEPlatform::OEFile::DirContents` will no longer leak
     memory by leaving open a ``DIR *`` object.

Minor bug fixes
--------------------------------------------------------------------------------

.. oe:language:: java python csharp

   * :oe:func:`OEPlatform::OEAddLicenseFromHttp` will now accept HTTP
     responses with a content-type of ``text/html;
     charset=utf-8``. Previously, only ``text/plain`` was accepted.

.. oe:language:: c++

   * :oe:func:`OEPlatform::OEGetTimeOfDay` will now return a ``bool``
     instead of an ``int`` to more clearly show when the function fails.

   * :oe:meth:`OEPlatform::OEOnce::GetValue` method is now provided on
     all platforms.

Documentation fixes
--------------------------------------------------------------------------------

.. oe:language:: java python csharp

   * :oe:func:`OEPlatform::OEAddLicenseFromHttp` now includes example
     code in the documentation for its use.

.. oe:language:: c++

   * The following functions and class are not available in Python, Java, or C# and
     are only documented in the C++ documentation:

     - :oe:func:`OEPlatform::OECurrentTime`
     - :oe:func:`OEPlatform::OEGetTimeOfDay`
     - :oe:func:`OEPlatform::OELocalTime`
     - :oe:func:`OEPlatform::OESleep`
     - :oe:cls:`OESystem::OECycleTimer`

OEGrid 1.4.6
================================================================================

New Features
--------------------------------------------------------------------------------

* :oe:func:`OESystem::OEMakeMolecularGaussianGrid` now has an overload
  to allow a grid with existing dimensions, mid-point, and spacing to
  be filled. Previously, the grid size would always be recreated based
  upon the size of the molecule.

Major bug fixes
--------------------------------------------------------------------------------

* Better support for output of non crystallographic grids to CCP4
  file. Now the CCP4 ARMS value is set to 1.0 and the CCP4 MEAN is
  set to 0.0 to prevent scaling and offsetting in CCP4 map
  visualizers. Additionally, the spacegroup is now output as 146 (H3)
  as opposed to the nonstandard 1146 (R3) to facilitate viewing in
  MOE. Please note that values appearing outside of the
  specified unit cell will be incorrect.

Documentation fixes
--------------------------------------------------------------------------------

* Adding missing :oe:constns:`OESystem::OEMTZMapType` namespace to the
  documentation.

* OEChem release notes for 2.0.0 and 1.9.3 had the OEGrid version
  slightly wrong. The OEGrid version numbers have been corrected to
  1.4.5 and 1.4.4 respectively.



.. _section_oechem_releasenotes_202:

********************************************************************************
Version 2.0.2
********************************************************************************

OEChem 2.0.2
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEGenerate2DCoordinates` has an additional 550
  complex ring systems that it can use while laying out
  coordinates. Any structures that contain one of these complex ring
  systems will see dramatically better 2D coordinate generation. 

* ``OEChem::OEMCMolBaseT`` and ``OEChem::OEConfBaseT`` have
  been renamed to :ref:`OEMCMolBase <OEChem_OEMCMolBase>` and
  :ref:`OEConfBase <OEChem_OEConfBase>` respectively. This can only really have
  a technical effect on users of the direct C++ API. Python, Java, and
  C# users never saw a distinction between the template classes with
  the ``T`` suffix. For higher level language users, navigating the
  documentation and OEChem's type hierarchy should be greatly
  simplified.

* :oe:func:`OEChem::OEUncolorMol` is a new function for performing tunable
  uncoloring strategies for an input molecule.  Additional uncoloring
  strategies may be available in future versions.

* Significant performance improvement for
  :oe:meth:`OEChem::OEMolBase::GetAtoms`. Algorithms that do  
  molecular graph traversal should see a significant performance
  benefit. For example, :oe:func:`OEChem::OEShortestPath` was measured
  to be 25% faster. 

* :oe:func:`OEChem::OEPreserveRotCompress` added as a convenience
  function to ensure rotor-offset-compression is preserved when
  reading and writing molecules to OEB files. This function should be
  called on any :ref:`oemolistream <OEChem_oemolistream>` object that should
  preserve the rotor-offset-compression data needed to reproduce a
  smaller OEB file. 

* The performance of reading and writing rotor-offset-compression
  files has been improved, both when rotor-offset-compression data is
  preserved, and when it is not.

* Multiple lines of a CSV file format can be read into successive
  conformers of a :ref:`OEMCMolBase <OEChem_OEMCMolBase>` object. The SD data
  representing the data in the CSV file will be attached to each
  conformer.

* :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` added the following new methods to support the
  addition and removal of atom and bond object from the set:

  - :oe:meth:`OEChem::OEAtomBondSet::Add`
  - :oe:meth:`OEChem::OEAtomBondSet::ClearAtoms`
  - :oe:meth:`OEChem::OEAtomBondSet::ClearBonds`
  - :oe:meth:`OEChem::OEAtomBondSet::ClearAtomsAndBonds`
  - :oe:meth:`OEChem::OEAtomBondSet::Remove`
  - :oe:meth:`OEChem::OEAtomBondSet::RemoveAtom`
  - :oe:meth:`OEChem::OEAtomBondSet::RemoveBond`

  Adding of objects now verifies the membership of the object in the
  set prior to addition which will incur slightly more overhead than
  previous versions. This membership checking is in keeping with the
  spirit of uniqueness for a "set" implementation.

* :oe:func:`OEChem::OESubsetMol` has new overloads to support use of
  subsetting activities using the :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`
  object to define the subset.

* :oe:func:`OEChem::OEMDLPerceiveBondStereo` will cause
  :oe:func:`OEChem::OEReadMolecule` to produce fewer warning messages.
  :oe:func:`OEChem::OEMDLPerceiveBondStereo` was creating ambiguous
  stereo bond marks, additional attempts are now made to apply
  unambiguous stereo bond marks. In some cases, this may result in >1
  bond mark to a center to fulfill the requirements of the internal
  checking algorithm for validly marked centers.  Pathological
  geometries remain where no valid marks can unambiguously define the
  stereocenter.  For example, for some fused ring systems, the
  required (perhaps multiple) stereomarks would result in unpalatable
  marked stereocenters.

  .. hint::

     For some cases, :oe:func:`OEChem::OEMDLPerceiveBondStereo` will
     **not** be able to apply marks that will satisfy the
     :oe:func:`OEChem::OEReadMolecule` perception, and a warning
     message will be thrown by :oe:func:`OEChem::OEReadMolecule`
     indicating that these should be redrawn or have coordinates
     regenerated, e.g., adding an explicit hydrogen at the
     bridgehead(s) to carry a stereomark.

  .. note:: 

     :oe:func:`OEChem::OEWriteMolecule` automatically calls
     :oe:func:`OEChem::OEMDLPerceiveBondStereo` when writing to the
     :oe:const:`OEChem::OEFormat::MDL` and
     :oe:const:`OEChem::OEFormat::SDF` file formats.

* :oe:func:`OEChem::OEMDLHasIncorrectBondStereo` has been modified to
  check additional stereo environments for potential errors.  For example,
  both example structures below are now identified as having incorrect bond
  stereo marks where previously only the left structure was identified. 

  .. list-table::

     * - .. image:: ../../oechemtk/images/releasenotes-2.0.2/incorrect-stereo-A.*
       - .. image:: ../../oechemtk/images/releasenotes-2.0.2/incorrect-stereo-B.*

* :ref:`OEMol <OEChem_OEMol>` can now represent conformer coordinates in
  :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` (16-bit), ``double`` (64-bit), and
  ``long double`` (>=64-bit) precision. These molecule types can be
  accessed through the corresponding constants in the
  :oe:constns:`OEChem::OEMCMolType` namespace. 

  The following features were added to work in parallel with this new
  feature:
   
  - Reading and writing :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` (16-bit)
    precision conformers to the :oe:const:`OEChem::OEFormat::OEB` file
    format, including rotor-offset-compressed files. 
  - Reading and writing ``double`` (64-bit) precision conformers to
    the :oe:const:`OEChem::OEFormat::OEB` file format, including
    rotor-offset-compressed files.
  - Reading and writing ``double`` (64-bit) precision conformers to
    the :oe:const:`OEChem::OEFormat::XYZ` file format. By default, the
    XYZ writer will introspect the molecule type to determine how many
    significant digits to
    write. :oe:const:`OEChem::OEOFlavor::XYZ::SinglePrecision` and
    :oe:const:`OEChem::OEOFlavor::XYZ::DoublePrecision` can be used to force
    either 5 or 18 significant digits.
  - :oe:meth:`OEChem::OEMolBase::SetCoords`,
    :oe:meth:`OEChem::OEMolBase::GetCoords`, and
    :oe:meth:`OEChem::OEMCMolBase::NewConf` can now take coordinates in
    :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` and ``long double`` precision.
  - :oe:meth:`OEChem::OEConfBase::GetCoordsPtr` signature has been
    changed for better performance. Users should still prefer using
    :ref:`OEConstCoords <OEChem_OEConstCoords>` and :ref:`OEMutableCoords <OEChem_OEMutableCoords>`.
  - Conformer geometry operations will now preserve the precision of
    the input conformer coordinates.

  .. note::

     These alternative precision conformer implementations are not
     used by default. They require the user to explicitly specify a
     constant from the :oe:constns:`OEChem::OEMCMolType` namespace to
     the :ref:`OEMol <OEChem_OEMol>` constructor.

  .. warning:: 

     Older versions of OEChem, and thus many previously released
     OpenEye applications will not be able to read ``OEB`` files
     created from these alternative precision conformer
     molecules. Care should be taken to only pass these files to
     toolkits and applications that use at least the 2.0.2 version of
     OEChem. Note, this is not the default, the default is still to
     generate OEB files that can interoperate with older versions of
     OEChem.

.. oe:language:: java

   * New methods were added that utilize native Java collections interface:

     * :ref:`OEMolBase <OEChem_OEMolBase>` received three new methods that use java.util.List:

       - :oe:meth:`OEChem::OEMolBase::GetAtomList` returns a list of atoms
       - :oe:meth:`OEChem::OEMolBase::GetBondList` returns a list of bonds
       - :oe:meth:`OEChem::OEMolBase::GetGroupList` returns a list of groups
    
     * :ref:`OEMCMolBase <OEChem_OEMCMolBase>` received a new method that use java.util.List:
       - :oe:meth:`OEChem::OEMCMolBase::GetConfList` returns a list of conformers

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEMDLStereoFromBondStereo` and
  :oe:func:`OEChem::OEMDLPerceiveBondStereo` will now generate
  consistent atom stereo when a wedge or hash bond occurs between
  atoms with an angle less than 180 degrees as shown in the following
  figure. This will make OEChem consistent with the official
  Accelrys definition of stereo in this case. As well as ensuring that
  SMILES can be round-tripped through an OEChem generated ``SDF``
  file that has had 2D coordinates automatically generated.

  .. image:: oechemtk/images/releasenotes-2.0.2/AtomStereoProblem-toolkits2014_Oct.*

* :oe:func:`OEChem::OEMDLHasIncorrectBondStereo` had a major bug
  introduced in the 2014.Jun release. The bug was an incorrect array
  allocation and an out of bound access that resulted in
  nondeterministic processing of stereocenters and potential stack
  corruption. The 2014.Jun release should not be used for the
  :oe:func:`OEChem::OEMDLHasIncorrectBondStereo` function.

* :oe:func:`OEChem::OEWriteMolecule` will no longer improperly flip
  bond stereochemistry of complex macro-cycles when writing to
  :oe:const:`OEChem::OEFormat::MDL`, :oe:const:`OEChem::OEFormat::SDF`,
  or :oe:const:`OEChem::OEFormat::CDX` file formats. This was caused by
  the addition of automatically generating 2D coordinates when writing
  to these file formats in OEChem 2.0.0, the 2014.Feb release. In
  cases when the generated 2D coordinates are inconsistent with the
  cis/trans bond stereo configuration of the molecule, the coordinates
  will be zeroed out, i.e., the molecule will be written with no
  coordinates.  This can occur when generating 2D coordinates for a
  molecule that contains a macro-cycle with specified cis/trans stereo
  bond configuration like the following:

  .. image:: oechemtk/images/releasenotes-2.0.2/BondStereoProblem-toolkits2014_Oct.*

* Writing to the :oe:const:`OEChem::OEFormat::SDF` and
  :oe:const:`OEChem::OEFormat::MDL` file formats will no longer
  improperly promote structures with relative stereochemistry to
  absolute stereochemistry in some cases. This case was when an input
  structure had atom stereomarks and a molecule chiral flag of '0'
  (i.e. relative stereochemistry) erroneously causing a promotion of
  relative stereochemistry to absolute stereochemistry on export to
  :oe:const:`OEChem::OEFormat::SDF` or
  :oe:const:`OEChem::OEFormat::MDL`.  This change only affects
  structures that originate from the V2000 and V3000 molfile formats
  without 3D coordinates. Structures from SMILES and other formats 
  don't represent relative stereochemistry, therefore, those formats
  will still only translate absolute stereochemistry.

* :oe:meth:`OEChem::OEMolDatabase::GetTitle` would sometimes return an
  empty title for multi-conformer OEB files that had their titles
  stored on the conformer. :oe:meth:`OEChem::OEMolDatabase::GetTitle`
  will now recognize this case and use the title from the first
  conformer if the top-level :ref:`OEMCMolBase <OEChem_OEMCMolBase>` does not
  have a title.

* Rotor-offset-compressed OEB files created on big-endian machines
  should now be readable on little-endian machines again. This bug was
  introduced in the 2011.1 release, the OEChem 1.7.5 release. The only
  big-endian architecture supported since then was PowerPC, and that
  support was dropped due to lack of usage. 

* :oe:func:`OEChem::OEGetDistance2` that takes a
  :ref:`OEConfBase <OEChem_OEConfBase>` will now return the square of the
  distance instead of the distance as it should. This bug was
  introduced in 2014.Feb, the OEChem 2.0.0 release.
  OEGetDistance2 functions that take arguments other than OEConfBase, e.g,
  OEMolBase, never had a bug introduced and will continue to return the
  square of the distance between the two atoms.

* :oe:func:`OEChem::OECreateInChI` will no longer crash and instead
  throw a warning when the InChI library returns an empty string.

* :oe:meth:`OEChem::OEConfBase::GetTitle` will be preferred over the
  :oe:meth:`OEChem::OEMolBase::GetTitle` when writing multi-conformer
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>` molecules out to file formats that
  support titles. Previously, users were required to set the
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>` title to an empty string,
  ``mol.SetTitle("")``, to achieve this behavior. This code will
  continue to work, but is no longer necessary to get the more specific
  conformer titles to be written out. ``OEB`` files will continue to
  write out both titles.

* :ref:`OEConstCoords <OEChem_OEConstCoords>` and :ref:`OEMutableCoords <OEChem_OEMutableCoords>`
  will no longer crash when given an empty molecule. 

.. oe:language:: python

   * The Python global interpreter lock is now handled properly by
     the following methods:

     - :oe:meth:`OEChem::oemolistream::openstring`
     - :oe:meth:`OEChem::oemolostream::GetString`
     - :oe:meth:`OEChem::oemolithread::openstring`
     - :oe:meth:`OEChem::oemolthreadbase::GetMol`
     - :oe:meth:`OEChem::oemolthreadbase::PeekMol`
     - :oe:meth:`OEChem::oemolthreadbase::PutMol`
     - :oe:meth:`OEChem::oemolothread::GetString`

     A race-condition was introduced in the previous release,
     2014.Jun, when Python 3 support was added. This race condition
     would occur when using any of the above methods in a
     multi-threaded environment.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OE3DToAtomStereo`, for the perception of atom
  stereo from 3D coordinates, depends on the following properties:
  :oe:const:`OEChem::OEPerceived::RingAtomsAndBonds`,
  :oe:const:`OEChem::OEPerceived::Aromaticity`, and
  :oe:const:`OEChem::OEPerceived::Chiral`. If any of these properties
  are un-set when calling :oe:func:`OEChem::OE3DToAtomStereo`, they
  will be automatically reperceived before calculating the atom stereo
  properties.

* :oe:func:`OEChem::OE3DToBondStereo`, for the perception of bond
  stereo from 3D coordinates, depends on the following properties:
  :oe:const:`OEChem::OEPerceived::RingAtomsAndBonds`,
  :oe:const:`OEChem::OEPerceived::Aromaticity`, and
  :oe:const:`OEChem::OEPerceived::Chiral`. If any of these properties
  are un-set when calling :oe:func:`OEChem::OE3DToBondStereo`, they
  will be automatically reperceived before calculating the bond stereo
  properties.

* :oe:const:`OEChem::OEOFlavor::ISM::ExtBonds` will no longer be used
  when generating SMILES with :oe:func:`OEChem::OEMolToSmiles`.  This
  will cause :oe:func:`OEChem::OEMolToSmiles` to generate the same
  :term:`canonical isomeric SMILES` as when writing into an
  :oe:const:`OEChem::OEFormat::ISM` file format.

* ``OEChem::OEMCMolType::Torsion`` and
  ``OEChem::OEMCMolType::Rotation`` constants have been removed.

* :oe:func:`OEChem::OEInitHandler` called on the options specified by
  :oe:func:`OEChem::OEBDefaultOpts` will now initialize the handler to
  the exact same set of handlers as
  :oe:func:`OEChem::OEInitDefaultHandler`. The noticeable difference
  between the two was that :oe:func:`OEChem::OEInitHandler` would
  inadvertently turn on writing out the
  :oe:meth:`OEChem::OEBondBase::GetIntType` field, resulting in larger
  file sizes. :oe:meth:`OEChem::OEBondBase::GetIntType` was also turned
  on for the :oe:func:`OEChem::OEBRotCompressOpts` options as
  well. :oe:meth:`OEChem::OEBondBase::GetIntType` will now only be
  turned on by the :oe:func:`OEChem::OEBAtomIntTypeOpts` options. 

* :oe:const:`OEChem::OEMolBaseType::OEMiniMol` will now copy
  coordinates of other molecule implementations during copy
  construction.

* :ref:`OEMCMolBase <OEChem_OEMCMolBase>` read through
  :ref:`OEConfTestBase <OEChem_OEConfTestBase>` from non-SDF file formats should
  have a slightly smaller memory footprint. The ``MDLParity`` flag was
  always being stored in generic data, regardless of whether the
  molecule had the property or not.

* :oe:func:`OEChem::OEWriteMolecule` will no longer change the active
  conformer of an :ref:`OEMCMolBase <OEChem_OEMCMolBase>` while writing to file
  formats that do not support multi-conformer molecules like SDF and
  MOL2.

* :oe:func:`OEChem::OEWriteConstMolecule` will no longer ignore the
  flavors specified by the :ref:`oemolostream <OEChem_oemolostream>` for the
  :oe:const:`OEChem::OEFormat::XYZ` format.

* Warning message about an invalid format used with
  :oe:func:`OEChem::OEReadMolecule` was previously saying there was a
  problem with :oe:func:`OEChem::OEWriteMolecule`. This was incorrect,
  and the message now states "OEReadMolecule" instead. 

* Molecules read through :oe:meth:`OEChem::OEMolDatabase::GetMolecule`
  will no longer have their indices written to the OEB file
  format. This was just causing file size bloat and possibly confusing
  behavior with :oe:func:`OEChem::OEHasMolDBIdx` when the molecule was
  written and then read again from OEB through an
  :ref:`oemolistream <OEChem_oemolistream>`.

* :oe:meth:`OEChem::OEMolDatabase::GetTitle` fixed for PDB files that
  include data beyond the 72nd column. 

* Some redundant information is removed from OEB files written from
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>` objects. This should make OEB files the
  exact same size when round-tripping molecules now instead of
  becoming slightly larger.

* :oe:const:`OEChem::OEFormat::SDF` and :oe:const:`OEChem::OEFormat::MDL` 
  file formats no longer support the long deprecated CPSS reaction
  fields. More deprecated atom and bond fields in the V2000 molfile format
  continue to be exported but will be removed entirely in future
  versions.

* :oe:func:`OEChem::OEMDLSetParity` added to allow
  explicitly setting the chiral flag status.  This was added for
  symmetry with :oe:func:`OEChem::OEMDLGetParity` and to allow explicit
  control of the exported chiral flag state by the user.

* :term:`SMILES` containing explicit hydrogens in stereo
  configurations were being non-optimally depicted. :term:`SMILES`
  parsing will now set the reaction role
  (:oe:meth:`OEChem::OEAtomBase::SetRxnRole`) of stereo explicit
  hydrogens.

* :oe:meth:`OEChem::OEMCMolBase::NewConf` will now return a ``NULL``
  :ref:`OEConfBase <OEChem_OEConfBase>` pointer instead of crashing when passed a
  ``NULL`` coordinates pointer.

Documentation fixes
--------------------------------------------------------------------------------

* :oe:constns:`OEChem::OEMolBaseType` is now documented. 

* :oe:constns:`OEChem::OEOFlavor::XYZ` is now documented. 

* All OpenEye code examples will now prefer to use
  :oe:func:`OEChem::OEMolToSmiles` and :oe:func:`OEChem::OESmilesToMol`
  instead of the ``OECreate*SmiString`` and ``OEParseSmiles``
  functions.

OEBio 2.0.2
================================================================================

* Minor internal improvements. 

OESystem 2.0.2
================================================================================

New features
--------------------------------------------------------------------------------

* Small performance improvements when writing generic data to OEB files. 

* :oe:func:`OESystem::OEGetHostEndian` and
  :oe:func:`OESystem::OEGetHostEndian` added to make template
  programming generic binary readers and writers easier.

* :oe:func:`OEMath::OEGeom3DAllZero` added to determine whether an
  array of floating point numbers is all zero.

* Many ``OEMath::OEGeom`` functions can now automatically up-cast
  :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` to float during their operation
  making working with :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` more seamless
  and requiring less temporary arrays.

* :oe:func:`OEMath::OEGeom3DReflect` added to reflect coordinates
  around any given axis.

* :oe:func:`OESystem::OECopyArray` should now be significantly faster
  for ``long double`` data arrays.

Documentation fixes
--------------------------------------------------------------------------------

* :oe:meth:`OESystem::OEBitVector::ToHexString` more thoroughly explained. 

* :ref:`OEBitVector <OESystem_OEBitVector>` documentation table was malformed.

OEPlatform 2.0.2
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:meth:`OEPlatform::OEThread::Start` now returns a boolean value to
  indicate whether thread creation has failed. 

* :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` can now interconvert with
  ``double`` and ``long double`` more easily.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEPlatform::OEFileRandomName` will now throw a warning that
  it is deprecated and will be removed in a future release. It is
  very dangerous and prone to race conditions.

* :ref:`OEMutex <OEPlatform_OEMutex>` data members are no longer exposed as
  ``public`` access on Windows.

Documentation fixes
--------------------------------------------------------------------------------

* :ref:`OEThread <OEPlatform_OEThread>` is now documented.

OEGrid 1.4.7
================================================================================

* Minor internal improvements. 



.. _section_oechem_releasenotes_203:

********************************************************************************
Version 2.0.3
********************************************************************************

OEChem 2.0.3
================================================================================

New features
--------------------------------------------------------------------------------

- :oe:func:`OEChem::OEGenerate2DCoordinates` added the following new
  features to improve the 2D layout of molecules:

  * The ring template dictionary search algorithm now has the ability
    to preserve cis/trans bond stereo. The 2014.Feb and 2014.Jun
    releases contained a bug that caused bond stereo to be erroneously
    inverted. The 2014.Oct release prevented the erroneous inversion
    by disallowing creation of such 2D coordinate layouts. This
    release is the next step in improving 2D coordinate generation for
    large macrocycles: ring templates with matching cis/trans
    stereo chemistry can now be used.

  * 252 new ring templates have been added:

    -  180 complex ring systems with anonymized carbon frameworks
    -  72 common macrocycle ring systems with specified cis/trans bond configuration

  .. _table_macroring_bondstereo:

  .. list-table:: **Example of 2D coordinate generation for macrocycles with cis/trans bond stereo**

     * - **OEChem TK 2.0.2**
       - **OEChem TK 2.0.3**
     * - .. image:: ../../oechemtk/images/releasenotes-2.0.3/macroring-bondstereo-2014_Oct.*
       - .. image:: ../../oechemtk/images/releasenotes-2.0.3/macroring-bondstereo-2015_Feb.*

  * A new :ref:`OEExtractRingTemplateOptions <OEChem_OEExtractRingTemplateOptions>` class and
    :oe:func:`OEChem::OEExtractRingTemplates` function, which are
    used to extract potential new ring templates, have been added.

  * A new **OEChem TK** example that extracts ring templates for 2D
    coordinate generation has been added.
    For more information, see the
    :ref:`section_example_oechem_extractringtemplates` section.

    .. note:: 

       To improve the depiction of the ring systems in a collection of
       molecules, please run the
       :ref:`section_example_oechem_extractringtemplates`
       script on the collection and send the results to
       support@eyesopen.com. **OpenEye** will be happy to include the
       ring systems in the next release of the toolkits.

- A new :oe:func:`OEChem::OEIs2DFormat` function that can determine
  whether the given file format supports 2D coordinate information has been added.

- :term:`Canonical SMILES` generated with the
  :oe:const:`OEChem::OESMILESFlag::SuperAtoms` flag will now respect
  any value that is placed in the
  :oe:meth:`OEChem::OEAtomBase::GetName` field while canonical
  ordering the molecule. This feature is useful for creating
  specialized SMILES that can be canonicalized and deduplicated.

- A new :oe:func:`OEChem::OEReadOEBFile` reader has been
  added that makes low-level OEB parsing available to Python,
  Java, and C#. Note: this function is considered advanced;
  :oe:func:`OEChem::OEReadMolecule` is still preferred. 

Major bug fixes
--------------------------------------------------------------------------------

- InChI creation will now fail if the molecule being converted cannot
  be handled by the InChI reference implementation. The **OEChem TK** will 
  throw a warning message about the molecular data that cannot be
  converted and return an empty string. This also protects against
  many possible crashes inside the InChI reference implementation due
  to abnormal molecules.

- InChI creation will no longer overflow the stack when an atom has
  more than 20 neighbors.

- The state of the ``chiral`` flag from MDL files is now correctly
  managed and maintained by :oe:func:`OEChem::OEReadMolecule` and
  :oe:func:`OEChem::OEWriteMolecule`.  Previously, ``non-chiral``
  (relative) stereochemistry structures were being promoted
  incorrectly to ``chiral`` (absolute) stereochemistry.

- :ref:`OESubSearch <OEChem_OESubSearch>` constructors no longer create or use uninitialized memory.
  This bug was introduced in the 2014.Jun release and caused 
  erroneous warning messages about explicit and implicit hydrogen mismatches. 

- :oe:func:`OEChem::OEPDBOrderAtoms` previously sorted residues improperly due to 
  a buffer overflow for the :oe:const:`OEChem::OEResidueIndex::YG` residue index 
  corresponding to the T-RNA base wybutosine.  This has been fixed.

- :oe:func:`OEChem::OEWritePDBFile` will no longer buffer overflow for
  atoms that have their name fields set.

- :oe:func:`OEChem::OEWriteMacroModelFile` will no longer buffer overflow for
  atoms that have their name fields set.

- :ref:`OELibraryGen <OEChem_OELibraryGen>` previously had a thread-safety issue when
  generating libraries. This has been fixed.

Java-specific changes
--------------------------------------------------------------------------------

- :oe:func:`OEChem::OEGetSDDataPairs` will again return a
  ``OESDDataIter``. The return value changed in the 2014.Jun
  release from "OESDDataIter" to "OEPDBDataIter" by accident.

API changes
--------------------------------------------------------------------------------

- The following public API points were largely undocumented and have been removed
  as internal implementation details, including the removal of the public header:

  - ``OEFuzzy OEGetAtomicNumconst OEExprBase*,...``
  - ``OEFuzzy OEGetAromatic(const OEExprBase*,...)``
  - ``OEFuzzy OEGetFormalCharge(const OEExprBase*,...)``
  - ``OEFuzzy OEGetImplicitHCount(const OEExprBase*,...)``
  - ``OEFuzzy OEGetHCount(const OEExprBase *expr,...)``
  - ``OEFuzzy OEGetBondOrder(const OEExprBase*,...)``
  - ``bool OEIsSingleOrAromatic(const OEExprBase*)``
  - ``OEFuzzy OEGetStereo(const OEExprBase *expr,...)``

  Additionally, the function :oe:func:`OEChem::OEDisassembleExpressions`
  has been explicitly marked as deprecated in the documentation and will be
  removed in a future release.

Minor bug fixes
--------------------------------------------------------------------------------

- :oe:meth:`OEChem::OEMolBase::Clear` will no longer leak memory for
  :oe:const:`OEChem::OEMCMolType::OEDBMCMol` after
  :oe:meth:`OEChem::OEMolBase::Compress` has been called.

- A warning is now thrown if kekulization is skipped and 
  :oe:func:`OEChem::OEParseSmiles` subsequently finds a bond with a bond order of five.

- Warnings will now be issued for enhanced stereo collection in V3000
  format files that have atoms in more than one enhanced stereo collection.
  A given stereo center atom can be in no more than one stereo collection type.

- Enhanced stereo collection information in V3000 MDL files is now correctly
  parsed for multiline appendix information.

- Parsing of V3000 stereo collection information has been corrected to
  combine explicitly named stereo collections.  Previously,
  multiple stereo collection entries of the same name in separate
  appendix entries generated different stereo groups.

- For V3000 MDL files, implicitly defined stereo collection information is
  now explicitly exported from :oe:func:`OEChem::OEWriteMolecule`. Defined
  stereocenters that are not included in the explicit enhanced stereo collections
  will be added to the appropriate stereo collection based on the state of the
  ``chiral`` flag.

- For MDL files, the writer will always attempt to export in V2000 format
  to ensure maximum compatibility with third party programs. If
  V3000 format files are explicitly desired regardless of whether
  the molecule is compatible with V2000, use :oe:const:`OEChem::OEOFlavor::MDL::MV30`.

- Undefined behavior in :oe:const:`OEChem::OEMolBaseType::OEMiniMol` has been fixed.

- :oe:meth:`OEChem::OEMolDatabase::Save` will now throw a warning
  message and return ``false`` when attempting to save the
  database to the same file.

- :oe:meth:`OEChem::OEMCMolBase::NewConf` will now throw a warning
  message if the number of atoms in the :ref:`OEMolBase <OEChem_OEMolBase>` or
  :ref:`OEConfBase <OEChem_OEConfBase>` is different than the
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>` into which the conformer is being constructed.
  This addresses the common problem of creating conformers
  from molecules that simply differ in the number of implicit or explicit
  hydrogens. Note: :oe:meth:`OEChem::OEMCMolBase::NewConf` is still
  designed to be very fast, so the safety checks are intentionally
  kept minimal.

- :oe:func:`OEBio::OESetRotamer` now properly returns ``true`` to
  indicate success when applied to residues that have fewer than four chi
  angles.

Documentation fixes
--------------------------------------------------------------------------------

- Extensive documentation has been added to the
  :oe:constns:`OEChem::OEExprOpts` namespace and how it affects
  :ref:`OESubSearch <OEChem_OESubSearch>` and :ref:`OEMCSSearch <OEChem_OEMCSSearch>`.

- An example code has been added that describes how to retrieve an
  :ref:`OEGraphMol <OEChem_OEGraphMol>` object as a :ref:`OEInterface <OESystem_OEInterface>` parameter.

- A large warning message has been added to the :ref:`Multi-Threaded OEChem
  <chapter_multithreading>` chapter, alerting users that passing molecules
  between threads is not supported by default.

OEBio 2.0.3
================================================================================

New features
--------------------------------------------------------------------------------

- A new `OEBio::OEFragmentNetwork` class that represents networks 
  of fragments and their interactions has been added. This is being used by
  the new protein-ligand rendering capability in the **Grapheme TK**. This
  class is considered beta and will likely change over the next year
  as the protein-ligand rendering feature is refined.

OESystem 2.0.3
================================================================================

New features
--------------------------------------------------------------------------------

- :oe:func:`OESystem::OENumberToString` will now accept ``long
  double`` arguments.

- :oe:func:`OESystem::OEIsSafeCast` has been added for determining whether a
  given value can be safely cast to a particular return type without
  loss of information.

Minor bug fixes
--------------------------------------------------------------------------------

- ``OESystem::OEBinaryRead`` no longer crashes nor displays undefined 
  behavior when there is a mismatch between the template
  parameter and the registered reader objects. 

- :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` now strips internal generic atom
  data annotations on the generated product molecules.

- :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` now corrects implicit hydrogen
  counts on charged atoms in the product molecules.

Documentation fixes
--------------------------------------------------------------------------------

- Function documentation for :oe:func:`OESystem::OEParseHex` has been added. 

OEPlatform 2.0.3
================================================================================

New features
--------------------------------------------------------------------------------

- :oe:func:`OEPlatform::OEGetPlatformInfo` will now generate more
  accurate descriptions of modern Windows operating systems.

Minor bug fixes
--------------------------------------------------------------------------------

- :oe:func:`OEPlatform::OEGetHostIdent` will no longer leak memory.

Documentation fixes
--------------------------------------------------------------------------------

- Documentation has been added for the following functions: 

  * :oe:func:`OEPlatform::OEGetDomainName`
  * :oe:func:`OEPlatform::OEGetHostIdent`
  * :oe:func:`OEPlatform::OEGetHostName`
  * :oe:func:`OEPlatform::OEGetIPAddress`
  * :oe:func:`OEPlatform::OEGetNumProcessors`
  * :oe:func:`OEPlatform::OEGetPlatformInfo`

OEGrid 1.5.0
================================================================================

New features
--------------------------------------------------------------------------------

- :oe:func:`OESystem::OEReadMTZ` will now automatically recognize
  column names generated by PHENIX in MTZ files. 




.. _section_oechem_releasenotes_204:

********************************************************************************
Version 2.0.4
********************************************************************************

OEChem 2.0.4
================================================================================

New features
--------------------------------------------------------------------------------

* The following API have been added to generate and use 2D ring dictionaries:

  * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
  * :oe:func:`OEChem::OEIsValid2DRingDictionary` function
  * :oe:func:`OEChem::OEWrite2DRingDictionary` function
  * :oe:func:`OEChem::OEInit2DRingDictionary` function

  The following sections provide examples to generate and utilize user-defined
  2D ring dictionaries:

  * :ref:`section_example_oechem_createringdict`
  * :ref:`section_example_oechem_appendringdict`
  * :ref:`section_example_oechem_generate2D`

.. seealso::

   :ref:`ringdict2pdf<section_examples_summary_ringdict2pdf>` example in
   **OEDepict TK** will generate a multi-page PDF report of a 2D ring dictionary.

* 221 new ring templates have been added to the built-in ring dictionary.

  .. list-table:: **Example of the New 2D Ring Templates**
     :widths: 15 7

     * - **Pure Carbon Skeleton Ring Templates**
       - **Ring Templates with Specified CIS/Trans Bonds**

     * - .. image:: ../../oechemtk/images/releasenotes-2.0.4/toolkits-2015-Jun-CarbonSkeletonTemplates.*
       - .. image:: ../../oechemtk/images/releasenotes-2.0.4/toolkits-2015-Jun-CisTransTemplates.*

* :oe:const:`OEChem::OEIFlavor::MOL2::Forcefield` flavor has been added to the MOL2 reader.
  This allows atom names in the MOL2 file to be interpreted as chemical
  elements while not using the second character if capitalized; for example, CA and CD
  are both carbon instead of calcium and cadmium. This will help reading
  :oe:const:`OEChem::OEFormat::MOL2` files
  that contain forcefield information like partial charges.

* :oe:func:`OEChem::OEAddCustomFASTAResidue` now provides the ability to
  customize :oe:const:`OEChem::OEFormat::FASTA` input files with
  unnatural nucleic acids.
  :oe:const:`OEChem::OEIFlavor::FASTA::CustomResidues` flavor is used
  to activate the new feature.
  :oe:const:`OEChem::OEIFlavor::FASTA::EmbeddedSMILES` flavor has also been
  added to experiment with adding cyclizations to peptides using
  custom tethers. These features are currently considered
  experimental; please send feedback to support@eyesopen.com.

.. oe:language:: c++

   * :oe:func:`OEChem::OEReadMolFromString` and
     :oe:func:`OEChem::OEWriteMolToString` have been added.  These
     functions provide efficient molecule encoding to all the **OEChem**
     file formats. We anticipate significant performance improvements using
     these functions instead of the :oe:meth:`OEChem::oemolostream::openstring`
     method.

* :oe:const:`OEChem::OEOFlavor::SDF::UnsetBad2DStereo` and
  :oe:const:`OEChem::OEOFlavor::CDX::UnsetBad2DStereo`, new output
  flavors for SDF and CDX output formats, have been added.  These
  constants control behavior when generating 2D coordinates during
  output.  When used, the writer will set the stereo to "undefined" for
  any misleading stereochemistry that may result from layout
  limitations.

* :oe:func:`OEChem::OESubsetMol` has a new overload that supports the
  use of :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` input. This can offer
  significant performance improvements over the predicate overloads since
  a full molecule iteration can be avoided.

* :oe:meth:`OEChem::OEMolBase::ClearCoords` has been added to fully clear
  molecule coordinates, clear the dimension code, and reset perception flags.

* :oe:meth:`OEChem::OEMolDatabase::WriteMolecule` has been added to
  automatically extract a molecule from the database and write it to
  the :ref:`oemolostream <OEChem_oemolostream>`. This function is optimized for
  performance to simply move bytes around if the input
  :ref:`OEMolDatabase <OEChem_OEMolDatabase>` format and the output format match exactly.

* :oe:meth:`OEChem::OEMolDatabase::GetMoleculeString` has been added to allow
  direct access to the molecular record data.

* :oe:func:`OEChem::OEPRECompress` and
  :oe:func:`OEChem::OESweepRotorCompressHydrogens` have been added and
  documented to allow advanced users to start experimenting with
  perfect-rotor-encoding OEB files to achieve higher rates of conformer
  compression. This feature is currently only available to the C++
  toolkits.

* :oe:func:`OEChem::OEMDLGetValence` has been added to provide direct
  access to the MDL valence model. See the :ref:`section_valence_mdl`
  section for more information.

* The following free functions have been added for handling dummy atoms
  in forcefield calculations in special circumstances:

  - :oe:func:`OEFF::OESetForceFieldDummyAtom`
  - :oe:func:`OEFF::OEClearForceFieldDummyAtom`
  - :oe:func:`OEFF::OEClearForceFieldDummyAtoms`
  - :oe:func:`OEFF::OEIsForceFieldDummyAtom`

  Currently, dummy atoms are only allowed in **Szybki TK** for
  non-bonded interactions.

* :oe:func:`OEChem::OEAssignRadii` free function has been added to
  allow for a central entry point for any **OpenEye Toolkit** atomic
  radii assignment. This free function uses the
  :oe:constns:`OEChem::OERadiiType` namespace for choosing the type of
  radii to assign.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEReadMolecule` will now correctly handle
  right-justified atomic symbols in MDL molfiles. These files are
  being generated by the RCSB PDB custom SDF file writer.

* :oe:func:`OEChem::OEPerceiveCIPStereo`, the Cahn-Ingold-Prelog
  stereochemistry perception algorithm, has been rewritten to solve
  the following issues:

  * Performance issues for large molecules have been resolved.

  * Incorrect chirality perception for certain isotopic molecules,
    detailed in the blog post
    `R or S? Let's Vote <http://nextmovesoftware.com/blog/2015/01/21/r-or-s-lets-vote/>`_,
    has been corrected.

  * Incorrect chirality perception for stereocenters with both
    a hydrogen and either a deuterium or tritium attached has been fixed.

  * Incorrect chirality perception for stereocenters with both a
    hydrogen and a \*atom (atomic number 0) has been fixed.

.. oe:language:: c++

  * :oe:meth:`OEChem::oemolistream::openstring` will now properly reset
    the state of the :ref:`oemolistream <OEChem_oemolistream>` to use the new data
    passed to :oe:meth:`OEChem::oemolistream::openstring` whenever
    :oe:meth:`OEChem::oemolistream::Setgz` was previously
    called. In earlier releases, :oe:meth:`OEChem::oemolistream::openstring`
    would only work the first time it was called; subsequent calls would
    fail to use the new data, even though the function was returning
    ``true`` as if it had succeeded.

* :oe:meth:`OEChem::oemolistream::Setgz` with a ``false`` argument
  called after a stream has finished reading molecules will no longer
  cause :oe:func:`OEChem::OEReadMolecule` to crash on subsequent
  calls. It will now return ``false`` to indicate that the stream has
  finished.

* :oe:meth:`OEChem::OEMolDatabase::Open` will now fail and throw a
  warning message if there is no disk space left for uncompressing
  compressed input files. In earlier releases, the operation would appear to
  succeed and lead to corrupted molecules past a certain
  point. Furthermore, the directory that :ref:`OEMolDatabase <OEChem_OEMolDatabase>`
  uses for temporary files can now be controlled through the ``TEMP``
  or ``TMP`` environment variables on Windows or the ``TMPDIR``
  environment variable on `Linux and OSX <http://pubs.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap08.html>`_.

* :ref:`OEMol <OEChem_OEMol>` will now work with the ``V3000`` file format
  much more reliably. This was accomplished by making sure that
  multi-conformer molecules can handle groups appropriately.  The
  :ref:`OEGroupBase <OEChem_OEGroupBase>` class is a container of atom and bond
  pointers inside an :ref:`OEMCMolBase <OEChem_OEMCMolBase>`.  The
  :ref:`OEGroupBase <OEChem_OEGroupBase>` class is currently used to store
  MDL-enhanced stereo information.  Each conformer of the multi-conformer
  molecule has its own separate container.  Now methods such as
  :oe:meth:`OEChem::OEMolBase::GetGroups` will provide access to the
  groups of the active conformation.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:const:`OEChem::OEFormat::OEB` format reading will no longer
  cause a rare crash when dealing with large amounts of SD data, PDB
  data, or bond integer types.

* :ref:`OEMatchBase <OEChem_OEMatchBase>` now checks parameters to the overloaded versions of
  the :oe:func:`OEChem::OESubsetMol` function to ensure that the given match corresponds
  to source and destination molecules.

* :oe:meth:`OEChem::OEMolBase::NewGroup` method signatures now take
  ``const std::vector`` of atom and/or bond pointers. Previously,
  these arguments were not ``const`` even though the vectors were not
  altered.

* :oe:func:`OEChem::OEReadMolecule` will now perform chirality
  perception for 0D MDL molfiles to ensure that
  :oe:meth:`OEChem::OEAtomBase::IsChiral` and
  :oe:meth:`OEChem::OEBondBase::IsChiral` are correct.

* :oe:func:`OEChem::OEGetAtomicNum` is now tolerant of leading spaces for the
  string argument passed in.

Java-specific changes
--------------------------------------------------------------------------------

* :ref:`OEBinaryIOHandlerBase <OESystem_OEBinaryIOHandlerBase>` had accidentally been
  removed from Java in the 2014.Oct release. This broke
  the older idiom for preserving rotor-offset compression in OEB files
  using :oe:func:`OEChem::OEInitDefaultHandler`. The preferred API is
  to now use :oe:func:`OEChem::OEPreserveRotCompress` directly on the
  molecule streams, avoiding the need to access the
  :ref:`OEBinaryIOHandlerBase <OESystem_OEBinaryIOHandlerBase>` internals entirely.

* The ``OEUnaryRoleSetPredicateFunc`` function was renamed to
  ``OEUnaryRoleSetBoolFunc`` for the sake of consistency.

* :ref:`OERoleSet <OESystem_OERoleSet>` predicates can now be created and
  customized in the same way as atom and bond predicates.
  :ref:`OERoleSet <OESystem_OERoleSet>` predicates are an important part of
  customizing the new **OEBio TK** :ref:`Splitting Macromolecular
  Complexes <section_split_mol_complex>` feature.

* :ref:`OERoles <OESystem_OERoles>` class has been added as a concrete implementation
  of the :ref:`OERoleSet <OESystem_OERoleSet>` abstract base class.

Documentation changes
--------------------------------------------------------------------------------

* :ref:`chapter_2D_coordinates` chapter has been added.

OEBio 2.0.4
================================================================================

New features
--------------------------------------------------------------------------------

* An API has been added for classifying and separating the various components of a
  macromolecular complex by their functional roles.
  See the :ref:`Splitting Macromolecular Complexes <section_split_mol_complex>`
  section for more information.

  * :oe:func:`OEBio::OESplitMolComplex` function
  * :oe:func:`OEBio::OEGetMolComplexComponents` function
  * :oe:func:`OEBio::OECountMolComplexSites` function
  * :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` class
  * :ref:`OEMolComplexCategorizer <OEBio_OEMolComplexCategorizer>` class
  * :ref:`OEResidueCategoryData <OEBio_OEResidueCategoryData>` class
  * :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>` class

* :oe:func:`OEBio::OEGetResidues` function has been added to allow
  iteration over all unique :ref:`OEResidue <OEChem_OEResidue>` objects in
  an :ref:`OEMolBase <OEChem_OEMolBase>`.

Documentation changes
--------------------------------------------------------------------------------

* :ref:`chapter_protein_prep` chapter has been added to document the
  APIs for splitting macromolecular complexes into their components.

OESystem 2.0.4
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:meth:`OEThrow.SetLevel <OESystem::OEErrorHandler::SetLevel>` and
  :oe:meth:`OEThrow.GetLevel <OESystem::OEErrorHandler::GetLevel>`
  race conditions should be largely alleviated
  now. :oe:meth:`OESystem::OEErrorHandler::SetLevel` and
  :oe:meth:`OESystem::OEErrorHandler::GetLevel` will now affect the
  error message level for the current thread only; all new threads
  launch with the default error level of
  :oe:const:`OESystem::OEErrorLevel::Default` (``Info`` or above).

  .. warning::

     Multi-threaded **OpenEye Toolkit** programs may need to be
     updated to allow the desired output to be sent to standard
     error. However, the previous behavior was race-condition prone
     and difficult to get correct.

Minor bug fixes
--------------------------------------------------------------------------------

* :ref:`OERandom <OESystem_OERandom>` constructor will no longer take an
  ``unsigned int`` as input. Previously, the ``unsigned int`` would be
  implicitly cast to ``bool`` and would control whether to time
  seed the constructor. However, most users actually intend to use an
  ``unsigned int`` as a random number seed meant for the
  :oe:meth:`OESystem::OERandom::Seed` method. This change should catch
  this common mistake at compile time.

Documentation changes
--------------------------------------------------------------------------------

* :ref:`OEMath Functions <chapter_math_functions>` chapter now
  contains more detailed descriptions of the functions.

* Documentation has been added for the following classes:

  - :ref:`OEBinaryIOHandlerBase <OESystem_OEBinaryIOHandlerBase>`
  - :ref:`OEBinaryIOHandler <OESystem_OEBinaryIOHandler>`
  - :ref:`OEBInitializer <OESystem_OEBInitializer>`
  - :ref:`OEBoundedBuffer <OESystem_OEBoundedBuffer>`
  - :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>`
  - :ref:`OEProtectedBuffer <OESystem_OEProtectedBuffer>`
  - :ref:`OEUnboundedBuffer <OESystem_OEUnboundedBuffer>`

OEPlatform 2.0.4
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEPlatform::OEFileTempPath` will now use the directory
  specified by the ``TMPDIR`` environment variable on
  `Linux and OSX
  <http://pubs.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap08.html>`_. This
  allows the user to control where **OpenEye Toolkits** will create
  temporary files. This is especially useful since
  :ref:`OEMolDatabase <OEChem_OEMolDatabase>` can use a lot of temporary
  storage when dealing with compressed data files.

OEGrid 1.5.1
================================================================================

* Minor internal changes have been made.


********************************************************************************
Version 2.0.5
********************************************************************************

OEChem 2.0.5
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEReadMolecule` into an :ref:`OEMol <OEChem_OEMol>` is
  now equivalent to reading into an :ref:`OEGraphMol <OEChem_OEGraphMol>` for
  the majority of use cases. To achieve this, it is now supported to
  call :oe:func:`OEChem::OEReadMolecule` on :ref:`OEConfBase <OEChem_OEConfBase>` as returned by
  :oe:meth:`OEChem::OEMCMolBase::GetActive`.
  See table :ref:`table_ImportPerformance` below that shows the improvements by 
  supported languages.

.. _table_ImportPerformance:

.. list-table:: **Performance improvement of importing molecules from various file formats**

   * - .. image:: ../../releasenotes/images/2015-Oct/ImportPerformance-Cpp.*
          :width: 300 pt
     - .. image:: ../../releasenotes/images/2015-Oct/ImportPerformance-Python.*
          :width: 300 pt
   * - .. image:: ../../releasenotes/images/2015-Oct/ImportPerformance-Java.*
          :width: 300 pt
     -

.. note::

   * OEB-OEMol - **OpenEye** OEBinary file format storing molecules as :ref:`OEMol <OEChem_OEMol>`
     (multi-conformer molecule representation)
   * OEB-OEGraphMol - **OpenEye** OEBinary file format storing molecules as :ref:`OEGraphMol <OEChem_OEGraphMol>`
     (single-conformer molecule representation)

* The performance of reading V2000 MDL MOL files has been significantly
  improved. See table :ref:`table_ImportPerformance` above.

* The performance of 2D coordinate generation has been improved by as much
  as 33% in some cases.

* :oe:meth:`OEChem::OEIsMember::Add` and
  :oe:meth:`OEChem::OEIsMemberPtr::Add` methods have been added.

* Added new :oe:const:`OEChem::OESMILESFlag::AllBonds` output Flavor
  for SMILES generation.  When set all bonds will be explicit in the
  generated output SMILES.

* A new :oe:func:`OEChem::OEIsSDDataFormat` function that can return
  whether the given file format supports SD data information has been added.

* :oe:func:`OEChem::OEGetMDLDimensionFromCoords` and
  :ref:`OESetMDLDimensionFromCoords <OEChem_OESetMDLDimensionFromCoords>` function have been added.

* :ref:`OEMMFFTypeResult <OEChem_OEMMFFTypeResult>` class was added along with a new
  :oe:func:`OEChem::OEMMFFAtomType` overloaded function that provides
  better support for the wrapped languages (Python, Java and C#).

* 213 new ring templates have been added to the built-in ring dictionary.

  .. list-table:: **Example of the New 2D Ring Templates**
     :widths: 20 4

     * - **Carbon Skeleton**
       - **Specified Cis/Trans**

     * - .. image:: ../../oechemtk/images/releasenotes-2.0.5/toolkits-2015-Oct-CarbonSkeletonTemplates.*
       - .. image:: ../../oechemtk/images/releasenotes-2.0.5/toolkits-2015-Oct-CisTransTemplates.*

* The performance of reading :oe:const:`OEChem::OEFormat::CDX` files has been
  improved.

* :oe:meth:`SetTitle<OEChem::OEMolBase::SetTitle>` method of :ref:`OEConfBase <OEChem_OEConfBase>` class
  is now slightly faster.

Major bug fixes
--------------------------------------------------------------------------------

* The memory subsystem in the **OpenEye Toolkits** has been revamped
  to allow more types of objects to pass safely between operating
  system threads by default. The following objects are no longer
  affected by :oe:func:`OESystem::OESetMemPoolMode`:

  - :ref:`OEMol <OEChem_OEMol>`
  - :ref:`OEGraphMol <OEChem_OEGraphMol>`
  - :ref:`OEQMol <OEChem_OEQMol>`
  - :ref:`OESubSearch <OEChem_OESubSearch>`
  - :ref:`OEBase <OESystem_OEBase>`

  The upgrade fixes crashes observed in the **OEMolProp TK** and **OEDocking
  TK** in multi-threaded web servers. A more thorough
  description of what can and can't be done with threads with the
  **OpenEye Toolkits** can be found in the recently updated
  :ref:`chapter_multithreading` chapter.

  Care was taken to ensure the same or better level of performance
  with the new system. However, if you experience a performance
  degradation when switching to the **Toolkit 2015.Oct** release, please
  do not hesitate to contact support@eyesopen.com.

  .. warning: IGNORED DUE TO BOB'S REQUEST (IMPLEMENTATION DETAILS)

     **OEChem TK** will now perform a license check during
     molecule construction, instead of at atom and bond creation.
     This earlier license check may cause issues for users doing dynamic license
     addition in their code.

* Previously, :oe:meth:`OEChem::OEMolBase::NewAtom` would not copy coordinates when the
  molecule was the :oe:const:`OEChem::OEMolBaseType::OEMiniMol`
  implementation. This problem has been fixed.

* :oe:meth:`OEChem::OEMCMolBase::GetMCMolTitle` will now be consistent when
  reading single-conformer file formats. Previously, reading SMILES
  and CDX files would set the title on the parent
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>`, but MOL2, CSV, SDF, and single-conformer OEB
  file formats would not.
  All these file formats will now initialize the parent :ref:`OEMCMolBase <OEChem_OEMCMolBase>` title
  allowing more consistent behavior when annotating
  conformer titles (warting) across all file formats. The conformers
  can be warted, leaving the parent title intact as well.

* ``OEChem::OEConfBase::operator bool`` will now conform better
  to the :ref:`OEMolBase <OEChem_OEMolBase>` API by returning whether the
  molecule contains atoms. The previous behavior was odd and unused,
  returning the state of the coordinates in the conformer.

* ``OEChem::OEConfBase::Clear`` will now be consistent with the
  :oe:meth:`OEChem::OEMolBase::Clear` API effectively clearing away all
  generic data, SD data, atoms, and bonds from the parent
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>`.

* :oe:func:`OEChem::OEPerceiveResidues` will no longer crash when a
  thread has a small stack size and the molecule is very large.

* :oe:func:`OEChem::OEAddMols` will no longer crash when used on
  :oe:const:`OEChem::OEMolBaseType::OEMiniMol` molecule implementations.

* :oe:meth:`OEChem::OEBondBase::Clear` will now clear generic data for
  :oe:const:`OEChem::OEMolBaseType::OEMiniMol` molecule
  implementations.

* The following changes were made to improve the support for
  :oe:const:`OEChem::OEFormat::CDX` file format:

  * The problem that caused 2D coordinates to be flipped resulting in
    flipped atom stereo after round-tripping has been fixed.
  * Hydrogen counts for charged aromatic atoms such as ``[cH-]1cccc1`` have been fixed.
  * :oe:const:`OEChem::OEBondStereo::Wavy` and
    :oe:const:`OEChem::OEBondStereo::DoubleEither` bonds are now correctly handled.

Minor bug fixes
--------------------------------------------------------------------------------

* The following methods of the :ref:`OEAtomBase <OEChem_OEAtomBase>`
  class are deprecated and will throw a warning when called:

  * :oe:meth:`OEChem::OEAtomBase::HasAlphaBetaUnsat`
    (use :ref:`OEHasAlphaBetaUnsat <OEChem_OEHasAlphaBetaUnsat>` predicate instead)
  * :oe:meth:`OEChem::OEAtomBase::GetAxial`
  * :oe:meth:`OEChem::OEAtomBase::SetAxial`

* Previously, when the function :oe:func:`OEChem::OEParseSmiles` was called with a non-empty
  molecule, the hydrogen counts of the previously-existing atoms would be
  erroneously modified to satisfy normal valences.  Now, the existing atom
  hydrogen counts are untouched.

* The function :oe:func:`OEChem::OEReadMolecule` will now attempt to
  read malformed Rgroup atom information present in the atom block.
  Although an atom symbol of ``R1`` in the atom block may seem
  reasonable, it does not strictly conform to the **CTfile**
  specification. The :oe:func:`OEChem::OEWriteMolecule` function will
  never export information in this form, but an attempt will be made
  to read malformed information on input.

* The function :oe:func:`OEChem::OEReadMolecule` will no longer emit a warning
  when encountering the atom symbol ``*`` with CTfile format input, Instead, it
  will be treated as a :oe:const:`OEChem::OEElemNo::Du` atom.  This is
  in keeping with the return value from :oe:func:`OEChem::OEGetAtomicNum` for ``*``
  and a desire to reduce the number of warnings from :oe:func:`OEChem::OEReadMolecule`.

* The function :oe:func:`OEChem::OEReadMolecule` will now read Rgroup atom
  label information from V3000 format input.  Previously this information was ignored.

* The function :oe:func:`OEChem::OEReadMolecule` will now make a more concerted effort
  to read malformed DOS line endings from input (text) files.  This fix was added
  to :ref:`oeistream <OEPlatform_oeistream>`.

* Trailing white spaces are now removed from SMILES titles.

* When calling the :oe:func:`OEChem::OE3DToInternalStereo` function, the bond stereo
  is perceived from 3D even if the atom stereo perception fails.

* Coordinates in MDL MOL files that cannot be parsed as a real
  floating point number will now be ``0.0`` as per the MDL
  specification. Previously, the string "NaN" would actually translate
  to the floating point ``NaN`` binary representation.

* :oe:meth:`OEChem::oemolistream::GetConfTest` is now ``const``
  correct. The ``const-ness`` of the underlying
  :ref:`OEConfTestBase <OEChem_OEConfTestBase>` is no longer disregarded.

* :oe:meth:`OEChem::oemolistream::GetFileName<OEChem::oemolstreambase::GetFileName>`
  will no longer return an empty string when :ref:`oemolistream <OEChem_oemolistream>` constructor was
  called on a real file.

* During substructure search, the warning: ``OESubSearch::SingleMatch() is unable
  to match bond stereo in the target for patterns with bond stereo, call
  OEPrepareSearch on the target first`` was sometimes incorrectly
  thrown. The underlying stereo perception has been revamped.

* :ref:`OESubSearch <OEChem_OESubSearch>` no longer throws the following message in
  case when :oe:func:`OEChem::OEPrepareSearch` is invoked on the target molecule.
  ``OESubSearch::SingleMatch() is unable to match hybridization in the target
  for patterns with set hybridization, call OEPrepareSearch on the target first.``

* The :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` has been improved to reduce
  the number of odd valence and broken aromatic ring results from transformations.

* :oe:func:`OEChem::OEPerceiveChiral` now sets the relevant perception flag
  for empty molecules.

.. oe:language:: c++

   * :oe:func:`OEChem::OEReadMolFromString` and
     :oe:func:`OEChem::OEWriteMolToString` functions now accept file format
     strings without the ``.`` prefix. So both "sdf" and "".sdf"" will be
     interpreted as the :oe:const:`OEChem::OEFormat::SDF` file format.

* :oe:const:`OEChem::OEIFlavor::SMI::Strict` and :oe:const:`OEChem::OEIFlavor::SMI::Canon`
  flavor combination is now valid for the :oe:const:`OEChem::OEFormat::SMI` file
  format.

* :oe:func:`OEChem::OE3DToAtomStereo` and :oe:func:`OEChem::OE3DToBondStereo` functions
  remove the stereo property of an atom (or bond), respectively,
  if it is not chiral or if its stereo configuration can not be determined
  from the 3D.

* :oe:meth:`OEChem::OEAtomBase::SetStereo` and
  :oe:meth:`OEChem::OEBondBase::SetStereo`
  methods now remove the stereo generic data from the atoms (or bonds)
  when calling with the :oe:const:`OEChem::OEAtomStereo::Undefined` or
  :oe:const:`OEChem::OEBondStereo::Undefined` value, respectively.

* :oe:func:`OEChem::OEHasAtomStereoHydrogens` was fixed, it returns ``true``
  for a tetrahedral atom with specified stereo and one explicit hydrogen neighbor.

* :oe:func:`OEChem::OEHasBondStereoHydrogens` was fixed, it returns ``true``
  for an atom that belongs to a cis/trans double bond with one explicit
  hydrogen neighbor.

* :oe:func:`OEChem::OEReadOEBFile` can now be successfully used to
  read and round-trip an empty molecule (no atoms) to an OEB
  file. :oe:func:`OEChem::OEReadMolecule` will still automatically
  skip molecules with no atoms.

* :oe:func:`OESystem::OEBReadDataLength` now takes a default parameter for the
  maximum length.

* :oe:const:`OEChem::OEFormat::Default` now has the same numerical
  value as :oe:const:`OEChem::OEFormat::SMI` instead of
  :oe:const:`OEChem::OEFormat::ISM`. As of **OEChem TK** 2.0.0 (the 2014.Feb
  release), :oe:const:`OEChem::OEFormat::SMI` and
  :oe:const:`OEChem::OEFormat::ISM` are functionally equivalent
  in **OEChem TK's** file handling, so this is mostly a cosmetic change for
  consistency in that effort.

* Explicit hydrogens created by parsing stereo in :term:`SMILES`
  strings is now capped to a maximum of eight explicit
  hydrogens. Previously, a :term:`SMILES` such as ``[C@@H1000000000]``
  would seem to make **OEChem TK** hang indefinitely as it tried to create
  all those explicit hydrogens.

* :oe:func:`OESystem::OEMaskGridByCoordsAndRadii` has been corrected to fix
  a bug introduced in OEGrid 1.5.0 that produced grids of
  the wrong size.

* The function :oe:func:`OEChem::OEReadMolecule` will now simply ignore the V3000
  highlight collection information that was previously causing a read error.

* Previously, the function :oe:func:`OEChem::OEWriteMolecule` could emit lines exceeding 80 chars in
  V3000 format for structures containing many stereocenters.  This is in violation of the
  **CTfile** specification and has been corrected.

* An obscure issue causing a crash in :ref:`OESubSearch <OEChem_OESubSearch>` or
  :oe:meth:`OEChem::OEQMolBase::BuildExpressions` for imines and related
  queries with cis/trans parity and explicit hydrogens has been corrected,
  e.g., ``[H]/N=C/C``.

Documentation changes
--------------------------------------------------------------------------------

* :ref:`rmsd<section_example_oechem_rmsd>` example
  has been added to generate RMSD alignment for multi-conformer molecules.

* Links to the **CTfile** format document from Biovia (previously Accelrys, Inc.)
  has been updated.
  Note that registration is required to download this document.

* :oe:meth:`OEChem::OE2DRingDictionary::AddRings` return value is now documented.

OEBio 2.0.5
================================================================================

New features
--------------------------------------------------------------------------------

* `OEBio::OEFragmentNetwork` class is now exposed in order to allow the
  investigation of the protein-ligand interactions perceived by **OEDocking TK**
  and visualized by **Grapheme TK**.
  The current API is **read only** - *i.e.*, the user cannot build a fragment
  network.

  * The fragment network (`OEBio::OEFragmentNetwork`) is a container
    of typed molecules.
    The following classes are available to classify molecules in a fragment
    network:

    * `OEBio::OEComponentTypeBase` abstract class
    * `OEBio::OEProteinComponentType` concrete type that identifies protein
      molecule of complexes.
    * `OEBio::OELigandComponentType` concrete type that identifies ligand
      molecule of complexes.

  * A fragment (`OEBio::OEFragment`) is a set of atoms of a molecule
    that is stored in the fragment network.

  * A fragment connection (`OEBio::OEFragmentConnection`) is a typed
    link between two fragments of the network.
    The following classes have been added to handle interactions perceived
    by **OEDocking TK**
    (see also :oe:func:`OEDocking::OEAddDockingInteractions` function):

    * `OEBio::OEFragmentConnectionTypeBase` abstract class
    * `OEBio::OEFragmentContactInteraction`
    * `OEBio::OEFragmentHBondInteraction`  along with the related
      `OEBio::OEFragmentHBondType` namespace
    * `OEBio::OEFragmentChelatorInteraction`  along with the related
      `OEBio::OEFragmentChelatorType` namespace

  * The following fragment connection predicates have been added:

    * `OEBio::OEHasConnectionType`
    * `OEBio::OEHasConnection`
    * `OEBio::OEHasResidueConnection`
    * `OEBio::OEIsChelatorInteraction`
    * `OEBio::OEIsHBondInteraction`
    * `OEBio::OEIsInterConnection`
    * `OEBio::OEIsIntraConnection`

  * The following functions have been added:

    * :oe:func:`OEBio::OEIsValidActiveSite` function
    * `OEBio::OEGetConnections` function

* The database of non-ligand residue types maintained by the
  :ref:`OEResidueCategoryData <OEBio_OEResidueCategoryData>` object
  contained within an :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>`
  has been curated.
  Only about 40 percent of the entries previously listed under the category
  :oe:const:`OEBio::OEMolComplexFilterCategory::Misc` remain,
  the remaining entries were recognized to be obscure ligands
  or were moved to other categories, such as
  :oe:const:`OEBio::OEMolComplexFilterCategory::CofactorAndLigand`.
  The category :oe:const:`OEBio::OEMolComplexFilterCategory::DNA_RNA`
  has been expanded to include the more obscure RNA bases.

* Setting modelNum to 0 in the :oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters` 
  method of :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` now selects all models.

* Protein Data Bank *biological assembly* files, with extensions like ``.pdb1.gz``,
  can now be read. These files use model numbers to refer to each part of an assembly
  (model numbers are also used to distinguish NMR models). By default, each model
  will be loaded as a separate molecule.
  See :ref:`splitmolcomplex<section_example_oebio_splitmolcomplex>` for an example
  of how to remove the ``ENDM`` flavor in order to load
  all models from a Protein Data Bank file into a single molecule.

Minor bug fixes
--------------------------------------------------------------------------------

* A problem that may have affected which residues were selected when
  the option method
  :oe:meth:`OEBio::OESplitMolComplexOptions::SetSeparateResidues` was used
  to select binding site residues has been fixed.

Documentation changes
--------------------------------------------------------------------------------

* :ref:`printinteractions<section_example_oebio_printinteractions>`
  example has been added to list protein-ligand interactions perceived by
  **OEDocking TK**.

* The :ref:`chapter_stereochemistry` chapter has been rewritten for the sake of clarity.

* Examples :ref:`splitmolcomplex<section_example_oebio_splitmolcomplex>` and
  :ref:`splitmolcomplexfrags<section_example_oebio_splitmolcomplexfrags>`
  have been updated to support the reading of multiple models from a ``PDB`` file.

OESystem 2.0.5
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:meth:`OESystem::OERandom::GetSeed` has been added to return
  the current state of the :ref:`OERandom <OESystem_OERandom>` class enabling
  the restart of the random number generator with the given seed.

* :oe:func:`OESystem::OEGridSizeMultiply` has been added to safely multiply
  grid dimensions together while ensuring that it will not cause the
  value to overflow the integer type.

* :ref:`OEOwnedPtr <OESystem_OEOwnedPtr>` is now move-constructable for any
  C++11 enabled compiler. OpenEye's first foray into supporting C++11
  directly in our APIs. C++11 will eventually provide broader usage of
  smart pointers across the **OpenEye Toolkits** API.

Minor bug fixes
--------------------------------------------------------------------------------

* :ref:`OEAnnotation <OESystem_OEAnnotation>` can now be successfully round-tripped
  through OEB.

Python-specific changes
--------------------------------------------------------------------------------

* ``HasUnsignedInt`` and ``GetUnsignedInt`` methods have been added to the
  :ref:`OEInterface <OESystem_OEInterface>` class Python wrapping to allow accessing
  command line parameters with ``!TYPE unsigned``.

C#-specific changes
--------------------------------------------------------------------------------

* ``HasUnsignedInt`` and ``GetUnsignedInt`` methods have been added to the
  :ref:`OEInterface <OESystem_OEInterface>` class C# wrapping to allow accessing
  command line parameters with ``!TYPE unsigned``.

OEPlatform 2.0.5
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEPlatform::OEGetAbsolutePath` is a new function that
  returns the full absolute path of a file.

* :oe:meth:`OEPlatform::OEThread::SetStackSize` has been added to allow
  controlling the maximum amount of stack size that the operating system
  thread will have when it is started with
  :oe:meth:`OEPlatform::OEThread::Start`.

* If a toolkit program fails due to a license error, the paths of any
  license file(s) actually read will be output for diagnostic purposes.

Major bug fixes
--------------------------------------------------------------------------------

* ``OEPlatform::OEMalloca`` will no longer cause crashes when
  attempting to allocate amounts of memory near the maximum allowable
  ``size_t``. ``std::bad_alloc`` will now be thrown instead in these
  situations. Since ``OEPlatform::OEMalloca`` is actually a
  C-preprocessor macro, this change may result in user code throwing
  additional compiler warnings when signed integer types like 'int'
  are passed to ``OEPlatform::OEMalloca``.
  We recommend that users change this code to use ``size_t`` to avoid these warnings.

Minor bug fixes
--------------------------------------------------------------------------------

* ``oepstream`` class has been removed since it never worked as originally intended.

* :oe:func:`OEPlatform::OEUncompress` and
  :oe:func:`OEPlatform::OECompress` can now take ``size_t`` instead of
  ``unsigned int`` allowing use on data in excess of 4GB on 64-bit
  machines.

Documentation changes
--------------------------------------------------------------------------------

* :ref:`OEOnce <OEPlatform_OEOnce>` example code in the documentation will
  now actually compile. Previously, the code would actually crash
  prior to the :ref:`OESubSearch <OEChem_OESubSearch>` memory pool refactoring of this release,
  if any other thread besides the ``main`` thread called the function first.

C++-specific changes
--------------------------------------------------------------------------------

* **OpenEye Toolkits** header files should no longer contain the C++11
  deprecated "register" keyword causing compilations with ``-Werror``
  to fail.

* :ref:`oestream <OEPlatform_oestream>` and derived classes will no longer
  allow implicit conversion to ``int`` and ``unsigned int``. This
  avoids surprising behavior like the following from compiling:

  .. code-block:: c++

     oeisstream is1;
     oeisstream is2;
     bool what = (is1 == is2);

OEGrid
================================================================================

New features
--------------------------------------------------------------------------------

* **OEGrid TK** now features more efficient use of memory while
  reading grids from files. Previously, several unnecessary memory allocations
  had sometimes been performed during the read process.

* **OEGrid TK** grids are now officially capped to 4GB of memory since
  the API is designed around ``unsigned int``.

Major bug fixes
--------------------------------------------------------------------------------

* :ref:`OEScalarGrid <OESystem_OEScalarGrid>` and all other grid types will no
  longer crash when the dimensions would cause overflow of an
  ``unsigned int``. The grid types will now throw ``std::bad_alloc``
  if attempting to make the grid memory larger than 4GB.



********************************************************************************
Version 2.0.6
********************************************************************************

OEChem 2.0.6
================================================================================

New features
--------------------------------------------------------------------------------

* The performance of the SDF V3000 format file parsing has been significantly
  improved and is now approximately 50% faster.
  The speed of importing an SDF file in V3000 format is now comparable to V2000.
  See table :ref:`table_ImportPerformance_V3000` below that shows the improvements.

.. _table_ImportPerformance_V3000:

.. list-table:: **Performance improvement of importing SDF V3000 file format**

   * - .. image:: ../../releasenotes/images/2016-Feb/ImportPerformance-V3000.*
          :width: 300 pt
     - .. image:: ../../releasenotes/images/2016-Feb/ImportPerformance-V3000-PATH.*
          :width: 300 pt

.. note::

   There are some pathological cases when only a slight improvement
   has been achieved.  From the parsing viewpoint, a pathological or
   atypical SDF V3000 file contains an excessive number of non-default
   property values, redundantly specified atom or bond properties,
   and/or atom coordinates in scientific notation which requires a more
   general but slower parsing activity.  For typical SDF V3000 files,
   a significant improvement was seen, but generally the magnitude of
   the improvement is largely input data dependent.

.. oe:language:: c++ csharp

   * :oe:func:`OEChem::OEWriteMolToString` and
     :oe:func:`OEChem::OEReadMolFromString` overload functions have been
     added to allow specification of the file format using the
     :ref:`the OEFormat namespace <OEChem_OEFormat>`.

.. oe:language:: python

   * :oe:func:`OEChem::OEWriteMolToBytes` and
     :oe:func:`OEChem::OEReadMolFromBytes` overload functions have been
     added to allow specification of the file format using the
     :ref:`the OEFormat namespace <OEChem_OEFormat>`.

.. oe:language:: java

   * :oe:func:`OEChem::OEWriteMolToByteArray` and
     :oe:func:`OEChem::OEReadMolFromByteArray` overload functions have been
     added to allow specification of the file format using the
     :ref:`the OEFormat namespace <OEChem_OEFormat>`.

* :oe:meth:`OEChem::OEMolBase::Clear` performance has been
  improved whenever the molecule is already empty.

* The following flavors have been added to the
  :oe:constns:`OEChem::OEOFlavor::MOL2`
  namespace: :oe:const:`OEChem::OEOFlavor::MOL2::Forcefield`,
  :oe:const:`OEChem::OEOFlavor::MOL2::ChargePrecision`, and
  :oe:const:`OEChem::OEOFlavor::MOL2::GeneralFFFormat`.
  These flavors allow writing nonstandard variants of Tripos MOL2 files
  targeted at the general force field community.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEMMFF94PartialCharges` function no longer crashes with
  incorrect atom types.

* :oe:func:`OEChem::OEUniMolecularRxn` function no longer crashes when 
  bonds to mapped explicit hydrogens are deleted.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OESortConfsByTag` function can now sort conformations by
  generic data with double type.

* :oe:meth:`OEChem::OE2DRingDictionary::AddRings` method now allows the addition of ring templates
  with extremely high average bond length. These ring templates are normalized before
  inserting them into the ring dictionary.

* **OEChem TK**'s MDL V2000 and V3000 readers have been improved  
  to handle nonstandard or incorrect MDL or SDF files.

  * :oe:func:`OEChem::OEReadMolecule` now warns about invalid
    bond stereo marks on non-single bond types and will ignore them.  Additionally, a common
    error in CTfile format files is the presence of a "wedge either" bond on a double bond.
    This latter error is now automatically changed to the assumed (non-wedge) "double either"
    bond mark and a warning is generated.

  * :oe:func:`OEChem::OEReadMolecule` now attempts to read a
    variant of the SDFile format that contains blank line(s) before the start of the
    SD data appendices.  Although this is a deviation from the CTfile format,
    this format has been known to occur in the wild. This change now impacts the use of
    concatenated MOL files when the structures have blank molecule titles.
    In general, concatenated MOL files are a much less preferred strategy for multiple
    record structure input and should be avoided. It is highly recommended to always use
    SDF files for multi-record input since an explicit record delimiter is always present.

  * When :oe:func:`OEChem::OEReadMolecule` encounters a connection table
    format error for SDF format files, it now advances to the next record delimiter.
    Previously, it would have attempted to reset and reread at an arbitrary point in the
    corrupted file, possibly generating additional warnings.

  * :oe:func:`OEChem::OEReadMolecule` and low level MDL format readers are now more tolerant
    for V3000 format files that contain  arbitrary collection types.  Previously, only
    stereo collections and highlight collections were allowed. Now a message about
    unknown types generates the warning
    ``Skipping unknown collection type, XXX/YYY``, with ``XXX/YYY`` indicating
    the specific collection type that was ignored.  Unknown collection information
    is not persisted to any output format types: it is well and truly skipped!

  * A warning is now thrown when multiple rgroup label sites (e.g., R1R2)
    are encountered, indicating that this type of representation is not yet supported.

  * When reading V3000 format containing pseudo-atoms (i.e., atoms not in the internal
    **OpenEye** element list), the atom symbol information is no longer lost
    but can be retrieved from :oe:meth:`OEChem::OEAtomBase::GetName` and is now the same 
    as V2000 file format handling.

* When an :oe:const:`OEChem::OEMolBaseType::OEMiniMol` molecule
  implementation is instantiated from another :ref:`OEMolBase <OEChem_OEMolBase>` instance that
  contains one or more atoms, the dimension code is also copied so that
  :oe:meth:`OEChem::OEMolBase::GetDimension`
  matches the dimension setting from the original :ref:`OEMolBase <OEChem_OEMolBase>`
  instance.

* :oe:func:`OEChem::OEReadMolecule` is now more tolerant
  for SKC format files containing explicit string tags of 0-length.

* :oe:func:`OEChem::OEAssignHybridization` now ignores transition metals,
  lanthanides, and actinides and sets their hybridization to
  :oe:const:`OEChem::OEHybridization::Unknown`.
  As a result, these atoms are no longer inadvertently considered to be potential tetrahedral
  stereocenters.

* :ref:`OEMolDatabase <OEChem_OEMolDatabase>` cannot support file formats without explicit
  record delimiters, so files such as MOL, MDL, and RXN
  cannot be supported.
  A properly formatted SDF file is the preferred input to initialize the
  :ref:`OEMolDatabase <OEChem_OEMolDatabase>` class.

* :ref:`OEMolDatabase <OEChem_OEMolDatabase>` now fails early and refuses to
  parse the junk data when a file changes underneath an  
  :ref:`OEMolDatabase <OEChem_OEMolDatabase>`.
  This can happen when an NFS client changes a file that is already open on 
  another NFS directory, invalidating the NFS client that is using
  :ref:`OEMolDatabase <OEChem_OEMolDatabase>`.

* :oe:func:`OEChem::OESweepRotorCompressHydrogens`
  no longer returns ``false`` when the molecule passed in does not
  contain any hydrogens. However, it returns ``false`` if the
  molecule contains any deleted atoms, as it is then likely that
  the rotor compression data is already corrupted.

* :oe:func:`OEMath::OEGeom3DMatrixInvert` function has been fixed. 

* A bug that allowed the ``!DEFAULT`` value of a parameter in the configuration 
  file to be set to a value that is illegal for that parameter has been fixed.
  A warning is now thrown when an illegal value is set. 

* A bug that caused PDB Data records, such as ``REMARK`` and ``SSBON``, to be
  clipped at 72 characters instead of 80 characters has been fixed.

C++-specific changes
--------------------------------------------------------------------------------

* A const :ref:`OEGraphMol <OEChem_OEGraphMol>`,
  :ref:`OEMol <OEChem_OEMol>`, or :ref:`OEQMol <OEChem_OEQMol>` no longer
  results in a compilation error when using the following generic
  data getters that should have been previously marked ``const`` in the header file:
  :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`, 
  :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`, 
  :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`,
  :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>`, and
  :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>`.

* :oe:func:`OEChem::OEPRECompress` that outputs an
  :ref:`OEMol <OEChem_OEMol>` has been deprecated in favor of the
  :oe:func:`OEFastROCS::OEPrepareFastROCSMol` function. 
  This function will be removed in a future release.

  .. note::

     :oe:func:`OEChem::OEPRECompress` that alters the binary IO
     handlers on an :ref:`oemolstreambase <OEChem_oemolstreambase>` is still
     supported and is the appropriate way to turn on PRE-compressed ``OEB``.

Python-specific changes
--------------------------------------------------------------------------------

* Passing ``None`` to the :ref:`oemolistream <OEChem_oemolistream>` and :ref:`oemolostream <OEChem_oemolostream>`
  constructors no longer results in a crash.

Documentation changes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEDeleteEverythingExceptTheFirstLargestComponent` function 
  is now documented. 
  
OEBio 2.0.6
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:meth:`OEBio::OESplitMolComplexOptions::SetSplitCovalentCofactors` and
  :oe:meth:`OEBio::OESplitMolComplexOptions::GetSplitCovalentCofactors` methods have
  been added to control the splitting of covalent cofactors from a macromolecular complex.
  The new constant :oe:const:`OEBio::OESplitMolComplexSetup::CovCofactor` controls whether
  :oe:func:`OEBio::OEConfigureSplitMolComplexOptions` sets up command-line parsing
  for this option.

* :ref:`OEMolComplexCategorizer <OEBio_OEMolComplexCategorizer>` can now recognize a multi-residue
  :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` as a covalently attached ligand or cofactor.

* :oe:const:`AminoAcid<OEBio::OEResidueDatabaseCategory::AminoAcid>`,
  a new residue database category, has been introduced. 
  It consists of standard amino acids and common variants
  such as seleno-methionine. Previously, these had been listed in the category
  :oe:const:`Cofactor<OEBio::OEResidueDatabaseCategory::Cofactor>`.

* :oe:meth:`OEBio::OESplitMolComplexOptions::SetWarnNoLigand` and
  :oe:meth:`OEBio::OESplitMolComplexOptions::GetWarnNoLigand` methods have been
  added to control whether the molecular complex splitting functions generate
  a verbose message warning whenever a ligand is not identified.

* :oe:func:`OEBio::OEClearMolComplexSDData` function has been added to remove
  SD tags generated by :oe:func:`OEBio::OEGetMolComplexComponents`.

* :oe:func:`OEBio::OEGetAlignments` has been added to deal with multiple chains
  in each structure. The method returns an iterator of alignments, one for
  each pairwise chain alignment.  
  :oe:func:`OEBio::OEGetAlignment` now returns the highest scored alignment 
  from :oe:func:`OEBio::OEGetAlignments`.
  :oe:func:`OEBio::OEGetSimpleAlignment` is
  a replacement for :oe:func:`OEBio::OEGetAlignment`, which only looks at the first 
  chain in each sequence.

* :oe:func:`OEBio::OEWriteAlignment` has gained a third parameter to allow varying
  the width of the output.

* The following methods have been added to the :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` class:

  * :oe:meth:`OEBio::OESequenceAlignment::GetChainID`
  * :oe:meth:`OEBio::OESequenceAlignment::GetSequenceIdentity`
  * :oe:meth:`OEBio::OESequenceAlignment::GetSequenceSimilarity`.

Minor bug fixes
--------------------------------------------------------------------------------

* Titles generated by functions :oe:func:`OEBio::OESplitMolComplex` and
  :oe:func:`OEBio::OEGetMolComplexComponents` no longer contain single quotes or
  blank characters.

* Ongoing maintenance has been performed in the :ref:`OEResidueCategoryData <OEBio_OEResidueCategoryData>`
  database used by :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>`. Residues have been
  removed from the :oe:const:`Polymer<OEBio::OEResidueDatabaseCategory::Polymer>` and
  :oe:const:`Misc<OEBio::OEResidueDatabaseCategory::Misc>` lists.

Documentation changes
--------------------------------------------------------------------------------

* The examples have been updated to perceive residues when this is
  not performed by the default molecule reader activity (for example, in the case of :file:`.mol2`).
  With this update, examples that had previously been transforming input
  hydrogen names from a PDB file to the new nomenclature
  (``closecontacts``, ``makealpha``, ``subsetres``, and ``swapaieres``)
  now retain the input hydrogen names.

OESystem 2.0.6
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OEThreadedDots <OESystem_OEThreadedDots>` has been added to provide a
  thread-safe way to output progress bar dots to the terminal when the
  work is being updated from multiple threads simultaneously.

OEPlatform 2.0.6
================================================================================

* Minor internal improvements have been made.

OEGrid 1.5.3
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OESystem::OEMakeGridFromCenterAndExtents` now
  propagates errors with the grid construction.

* :oe:func:`OESystem::OEReadGrid` can now read a gzipped
  `OESystem::OEFizzGrid`.



********************************************************************************
Version 2.0.7
********************************************************************************

OEChem 2.0.7
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEGetPathLength` function's performance has been
  significantly improved.

* The APIs of the functions for accessing
  anisotropic B-factor parameters :oe:func:`OEChem::OEGetAnisou` and
  :oe:func:`OEChem::OESetAnisou` have been expanded for easier use
  in wrapped languages.
  The predicate :ref:`OEHasAnisou <OEChem_OEHasAnisou>` and the container object
  :ref:`OEAnisoUij <OEChem_OEAnisoUij>` have been added to support this functionality.

* The ability to request bond stereomark corrections to reduce
  the number of stereo-center correction warnings when reading MDL format files
  has been added.
  For more information, see :oe:func:`OEChem::OEMDLStereoFromBondStereo` function,
  :oe:const:`OEChem::OEIFlavor::SDF::FixBondMarks`,
  :oe:const:`OEChem::OEIFlavor::MDL::FixBondMarks`, and
  :oe:const:`OEChem::OEIFlavor::RDF::FixBondMarks` constants.

* 41 new ring templates have been added to the built-in ring dictionary.

  .. list-table:: **Example of the new 2D ring templates**

     * - **Carbon Skeleton**

     * - .. image:: ../../oechemtk/images/releasenotes-2.0.7/toolkits-2016-Jun-CarbonSkeletonTemplates.*
            :width: 400

Major bug fixes
--------------------------------------------------------------------------------

* :oe:const:`OEChem::OEMCSType::Approximate` method for calculating the
  :ref:`maximum-common-substructure <section_patternmatch_mcss>` of two molecules
  will no longer leak memory.
  This memory leak was introduced in the
  :ref:`2015.Oct<toolkit_release_highlights_2015_Oct>` release.

* The following functions and methods will no longer crash when used after
  :oe:meth:`OEChem::oemolithread::open<OEChem::oemolstreambase::open>` or
  :oe:meth:`OEChem::oemolothread::open<OEChem::oemolstreambase::open>`, but
  will fail and return ``false``:

  - :oe:func:`OEChem::OEReadMolecule`
  - :oe:func:`OEChem::OEWriteMolecule`
  - :oe:meth:`OEChem::oemolthreadbase::PutMol`
  - :oe:meth:`OEChem::oemolthreadbase::GetMol`
  - :oe:meth:`OEChem::oemolthreadbase::PeekMol`

Minor bug fixes
--------------------------------------------------------------------------------

* The following problems have been fixed for reading V3000 MDL files:

  * :oe:func:`OEChem::OEReadMDLQueryFile` function has been
    generalized to more reliably identify a V3000 header and dispatch to
    the correct reader.

  * A parsing error for V3000 MDL files with an atom list has been fixed.

  * An issue with atom lists in V3000 format that resulted
    in the export of invalid atom symbols has been fixed.
    Atom lists will now export as "L" but
    will lose the original atom list information.
    Query features are not yet supported for molecule writing.

* A new warning will be issued for any V3000 MDL files that contain
  SCSR template information. This information is currently ignored.

* A new warning will be issued for any MDL files that contain
  Sgroup information or Rgroup definition. This information is currently ignored.

* An issue that occurred when valid cis/trans bond stereo were being converted
  to ``double either`` bonds in MDL reaction files has been corrected.
  This problem was introduced in the
  :ref:`2015.Oct<toolkit_release_highlights_2015_Oct>` release.

* The function to access anisotropic B-factor parameters
  :oe:func:`OEChem::OEGetAnisou` now sets all the parameters to ``0`` if no
  data is associated with the given atom, rather than leaving the parameters
  in an uninitialized state.
  The new predicate :ref:`OEHasAnisou <OEChem_OEHasAnisou>` can be used to determine if
  an atom has these parameters.

* :ref:`OEMCSSearch <OEChem_OEMCSSearch>` constructor no longer throws a warning when
  initialized with a molecule that has up-to-date ring perception information.

* :oe:func:`OEChem::OEAssignAromaticFlags` function now invalidates the
  hybridization perception flag since different aromaticity models affect
  the recorded hybridization values.

* Atom stereochemistry is more thoroughly examined and may result in multiple
  marks to the stereocenter(s) and/or marks to ring bond(s) for
  :oe:func:`OEChem::OEMDLStereoFromBondStereo` activity to reduce the number
  of ``Stereochemistry corrected ...`` warnings on re-read of the exported
  structure.

  .. list-table::

     * - .. image:: ../../oechemtk/images/releasenotes-2.0.7/OEMDLStereoFromBondStereo-2.*
            :width: 450

Documentation changes
--------------------------------------------------------------------------------

* Minor corrections to the :oe:constns:`OEChem::OEPerceived` namespace have been
  made.

OEBio 2.0.7
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEBio::OEPerceiveInteractionHints` function has been added to perceive
  possible ligand-protein interactions (contact, clash, hydrogen bond, salt-bridge,
  chelator, and aromatic ring stacking).

  The following classes and namespaces have been introduced to handle the new
  interaction types:

  * :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>` class and corresponding
    :ref:`OEIsClashInteractionHint <OEBio_OEIsClashInteractionHint>` predicate

  * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>` class and corresponding
    :oe:constns:`OEBio::OESaltBridgeInteractionHintType` namespace and
    :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>` predicate

  * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` class and corresponding
    :oe:constns:`OEBio::OEStackingInteractionHintType` namespace and
    :ref:`OEIsStackingInteractionHint <OEBio_OEIsStackingInteractionHint>` predicate

* :oe:func:`OEBio::OEGetActiveSiteInteractionHintTypes` function has been added to
  return the interaction types perceived
  by the new :oe:func:`OEBio::OEPerceiveInteractionHints` function.

* :ref:`OECrystalSymmetryParams <OEBio_OECrystalSymmetryParams>` class has been added, along with
  overloaded versions of :oe:func:`OEBio::OEGetCrystalSymmetry` and
  :oe:func:`OEBio::OESetCrystalSymmetry` functions taking an
  :ref:`OECrystalSymmetryParams <OEBio_OECrystalSymmetryParams>` object.
  This is the recommended API to use in the wrapped languages.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEBio::OEMolComplexCategorizer::SetMaxPeptideResidues` method
  now properly sets the maximum number of residues that can be considered
  a peptide by :ref:`OEMolComplexCategorizer <OEBio_OEMolComplexCategorizer>`.

* Lower-case chain IDs are now supported by
  :oe:func:`OEBio::OESplitMolComplex` and related functions.

* :oe:func:`OEBio::OERMSD` now checks whether the
  match stored in the given :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` object is
  valid prior to attempting to calculate RMSD.

* An uninitialized memory problem that occurred when
  :oe:func:`OEBio::OEGetAlignment` failed to perceive an acceptable alignment
  has been fixed.

.. _oebio_fragment_network_deprecation:

Deprecated OEFragmentNetwork and related API
--------------------------------------------------------------------------------

The following warning will be thrown when using the above deprecated APIs:

.. warning::

   "Warning: OEFragmentNetwork is deprecated. Use OEInteractionHintContainer instead."

================================================= ===============================================================
Deprecated class                                  Replaced by
================================================= ===============================================================
`OEFragmentNetwork`                               :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>`
`OEFragment`                                      :ref:`OEInteractionHintFragment <OEBio_OEInteractionHintFragment>`
`OEFragmentConnection`                            :ref:`OEInteractionHint <OEBio_OEInteractionHint>`
`OEFragmentConnectionTypeBase`                    :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`
`OEFragmentContactInteraction`                    :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`
`OEFragmentHBondInteraction`                      :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
`OEFragmentChelatorInteraction`                   :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
`OEComponentTypeBase`                             :ref:`OEInteractionHintComponentTypeBase <OEBio_OEInteractionHintComponentTypeBase>`
`OELigandComponentType`                           :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>`
`OEProteinComponentType`                          :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>`
================================================= ===============================================================

============================================= ===============================================================
Deprecated predicate                          Replaced by
============================================= ===============================================================
`OEHasConnection`                             :oe:constns:`OEBio::OEHasInteractionHint`
`OEHasConnectionType`                         :oe:constns:`OEBio::OEHasInteractionHintType`
`OEHasResidueConnection`                      :oe:constns:`OEBio::OEHasResidueInteractionHint`
`OEIsChelatorInteraction`                     :oe:constns:`OEBio::OEIsChelatorInteractionHint`
`OEIsHBondInteraction`                        :oe:constns:`OEBio::OEIsHBondInteractionHint`
`OEIsInterConnection`                         :oe:constns:`OEBio::OEIsInterInteractionHint`
`OEIsIntraConnection`                         :oe:constns:`OEBio::OEIsIntraInteractionHint`
============================================= ===============================================================

==================================================== ==============================================================================================
Deprecated function                                  Replaced by
==================================================== ==============================================================================================
`OEIsValidActiveSite(OEFragmentNetwork)`             :oe:func:`OEIsValidActiveSite(OEInteractionHintContainer)<OEBio::OEIsValidActiveSite>`
`OEGetConnections(OEMolBase,OEFragmentNetwork)`      :oe:func:`OEGetInteractions(OEMolBase,OEInteractionHintContainer)<OEBio::OEGetInteractions>`
`OEGetConnections(OEAtomBase,OEFragmentNetwork)`     :oe:func:`OEGetInteractions(OEAtomBase,OEInteractionHintContainer)<OEBio::OEGetInteractions>`
==================================================== ==============================================================================================

============================================= ===============================================================
Deprecated namespace                          Replaced by
============================================= ===============================================================
`OEFragmentHBondType`                         :oe:constns:`OEBio::OEHBondInteractionHintType`
`OEFragmentChelatorType`                      :oe:constns:`OEBio::OEChelatorInteractionHintType`
============================================= ===============================================================

Documentation changes
--------------------------------------------------------------------------------

* A link has been added from the :ref:`OEResidue <OEChem_OEResidue>` API documentation
  back to the :ref:`section_biopolymer_residues` section to better clarify details
  about residue data.

* A note has been added to the :oe:meth:`OEChem::OEResidue::IsHetAtom` documentation
  concerning heterogen atoms being distinguished by ``HETATM`` records in a PDB file.

* Java and C# versions of examples
  :ref:`section_example_oebio_splitmolcomplex` and
  :ref:`section_example_oebio_splitmolcomplexfrags`
  have been fixed.

* :ref:`section_example_oebio_printinteractions` example has
  been updated to use the new :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>`
  class and corresponding API.

OESystem 2.0.7
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEMath::OEGeom3DRotate` template math function can now
  be used with :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` coordinate types.

OEPlatform 2.0.7
================================================================================

New features
--------------------------------------------------------------------------------

* ``OELIMITEDSTACK`` macro define value can now be controlled from
  compiler flags like ``-DOELIMITEDSTACK=0``. This allows projects to use the C++
  header files when compiling **OpenEye** C++ code
  for use with **OpenEye** Java toolkits.

  For more information on compiling custom **OpenEye** C++ code for use by
  **OpenEye** Java toolkit projects, see
  https://github.com/oess/oejava_extension.



********************************************************************************
Version 2.1.0
********************************************************************************

OEChem 2.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* The :oe:const:`OEB<OEChem::OEFormat::OEB>` format has been
  extended to support MDL enhanced stereogroup information.

* The :oe:const:`OEB<OEChem::OEFormat::OEB>` format has been enhanced
  to support reaction atom-atom mapping and reaction component information.

* The :ref:`OEGroupBase <OEChem_OEGroupBase>` API has been augmented to support reaction
  component information.  In addition, new predicates have been added to
  loop over the new :ref:`OEGroupBase <OEChem_OEGroupBase>` collection types. See
  :oe:meth:`OEChem::OEGroupBase::IsEmpty`,
  :oe:meth:`OEChem::OEGroupBase::GetGroupDefinition`,
  :ref:`OEHasGroupType <OEChem_OEHasGroupType>`,
  :ref:`OEIsRxnComponentGroup <OEChem_OEIsRxnComponentGroup>`,
  :ref:`OEIsReactantGroup <OEChem_OEIsReactantGroup>`,
  :ref:`OEIsProductGroup <OEChem_OEIsProductGroup>`.

* The :oe:const:`SDF<OEChem::OEFormat::SDF>` reader is now
  more tolerant of molfile header lines that exceed the specification
  maximum of 80 characters.  A warning is issued on read and the longer
  lines are truncated to 80 characters on write to prohibit generating files
  that do not meet the format specification.

* New functions for computing weighted RMS deviation between pairs of
  Cartesian coordinates, molecules, and partial molecules have been added.
  See :oe:func:`OEChem::OEWeightedRMSD` for details.

Minor bug fixes
--------------------------------------------------------------------------------

* The tag used to identify style data in :oe:const:`OEB<OEChem::OEFormat::OEB>`
  files has been changed.  The old tag was not updated when the data structure
  was modified last year.  As a result,
  :oe:const:`OEB<OEChem::OEFormat::OEB>` files with style data that were
  generated before 2015.Jun cannot be read with more recent toolkits.
  Data with the old tag will be ignored.  Since style data is only used
  internally, we do not anticipate any read problems with
  :oe:const:`OEB<OEChem::OEFormat::OEB>` files generated by our customers.
   
* Functions :oe:func:`OEChem::OEGetFileExtension` and
  :oe:func:`OEChem::OEIsGZip` now recognize capitalized extensions
  (for example, ``.GZ``).

* Several problems with the internal implementation of 
  :oe:const:`OEChem::OEMolBaseType::OEMiniMol` have been fixed.

* A problem in the :oe:const:`SDF<OEChem::OEFormat::SDF>` reader where
  uninitialized memory was being accessed during the perception of V3000
  reaction files has been fixed.

* A problem in the :oe:const:`SDF<OEChem::OEFormat::SDF>` writer relating
  to relative stereochemistry has been fixed.  Previously, the writer
  incorrectly exported an input V3000 format file as a V2000 format output,
  resulting in the incorrect promotion of racemic stereocollection information
  to absolute stereochemistry.

* A problem with the :oe:const:`MOL2<OEChem::OEFormat::MOL2>` reader
  that limited input lines to 80 characters has been fixed.
  The reader now supports 512 character lines for this format.

C++-specific changes
--------------------------------------------------------------------------------

.. oe:language:: c++

   * The :oe:func:`OEChem::OEWriteMolToString` function has been overloaded to
     take a string reference argument into which a molecule is encoded.

.. oe:language:: csharp java python

   * New overloads of ``OEChem::OEWriteMolToString`` in C++ allow more
     efficient encoding of molecules to strings.

Python-specific changes
--------------------------------------------------------------------------------

.. oe:language:: python

  * :ref:`OEWriteMolToBytes <OEChem_OEWriteMolToBytes>` takes advantage of the new
    overloaded versions of the ``OEChem::OEWriteMolToString`` C++
    functions to improve encoding performance.

.. oe:language:: c++ java csharp

  * Python functions ``OEChem::OEWriteMolToBytes`` take advantage of the
    new overloaded versions of the ``OEChem::OEWriteMolToString`` C++
    functions to improve encoding performance.

Documentation changes
--------------------------------------------------------------------------------

* Examples have been added to the :ref:`SMARTS<section_SMARTS_examples>`
  chapter that illustrate how to match specified and unspecified stereocenters.

* The description of :ref:`oemolistream <OEChem_oemolistream>` formats has been clarified.

OEBio 2.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEBio::OEPlaceHydrogens` is a new function that adds hydrogens to
  a molecule and builds hydrogen bonding networks, flipping amide and imidazole
  groups if necessary.

* The following API has been added to customize and improve the perception
  of potential protein-ligand interactions:
 
  * :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class
  * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` class
  * :ref:`OEIsHalogenBondInteractionHint <OEBio_OEIsHalogenBondInteractionHint>` predicate
  * :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>` predicate
  * :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>` predicate
  * :oe:constns:`OEBio::OEHalogenBondInteractionHintType` namespace (new)
  * :oe:constns:`OEBio::OESaltBridgeInteractionHintType` namespace (extended)
  * :oe:constns:`OEBio::OEHBondInteractionHintType` namespace (extended)

* A variant of the :oe:func:`OEBio::OESplitMolComplex` function enables a more
  efficient two-step process. The function
  :oe:func:`OEBio::OEGetMolComplexFragments`
  analyzes a molecule and returns an :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`
  vector describing the role of each fragment. Functions
  :oe:func:`OEBio::OECombineMolComplexFragments` and
  :oe:func:`OEBio::OEFilterMolComplexFragments` then use this information
  to create new subset molecules.

Major bug fixes
--------------------------------------------------------------------------------

* The class :ref:`OEMolComplexCategorizer <OEBio_OEMolComplexCategorizer>` now recognizes small
  peptides.

Minor bug fixes
--------------------------------------------------------------------------------

* The function :oe:func:`OEBio::OEClearMolComplexSDData` now correctly
  identifies data by tag prefixes.

* The function :oe:func:`OEBio::OEHasCrystalSymmetry` now returns ``false``
  if the molecule has a default ``CRYST1`` record. PDB format rules lead to
  these default records, which should be interpreted to mean the molecule has
  no symmetry record.

Documentation changes
--------------------------------------------------------------------------------

* The description of the output parameters for the function
  :oe:func:`OEBio::OEExpandCrystalSymmetry` has been improved.

* The :ref:`chapter_protein_prep` chapter has been expanded and an example, 
  :ref:`section_example_oebio_proteinprep`, has been added.

* The file type in the warning associated with the functions
  :oe:func:`OEBio::OESplitMolComplex` and
  :oe:func:`OEBio::OEGetMolComplexComponents` has been clarified.

OEPlatform 2.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* Functions :oe:func:`OEPlatform::OESetAllocaThreshold` and
  :oe:func:`OEPlatform::OEGetAllocaThreshold` have been added to
  manage stack memory usage.  Rather than keeping track of stack usage, which
  impacts performance, the new functions set/get the threshold for the
  largest single allocation from the stack.  Above the threshold, memory
  is allocated from the heap.  Although this only indirectly controls total
  stack usage, it is lightweight and can help mitigate stack memory problems.


********************************************************************************
Version 2.1.1
********************************************************************************

OEChem 2.1.1
================================================================================

New features
--------------------------------------------------------------------------------

* A new functor class, :ref:`OESimilarByRMSD <OEChem_OESimilarByRMSD>`, has been added that
  checks similarity between a pair of conformers based on RMSD.

Major bug fixes
--------------------------------------------------------------------------------

* On Windows, a defect that caused a crash in :oe:func:`OEChem::OEReadMolecule`
  for :oe:const:`OEB<OEChem::OEFormat::OEB>` format or
  :oe:func:`OEChem::OEReadOEBFile` when
  processing large amounts of :oe:const:`OEChem::OEFormat::SDF` or
  :oe:const:`OEChem::OEFormat::PDB` data has been fixed.

* A crash that occurred when explicitly calling
  :oe:meth:`OEChem::oemolostream::Setgz` after opening a file that was
  implicitly gzipped has been fixed.

* Water hydrogens created by :oe:func:`OEChem::OEAddExplicitHydrogens`
  had previously been assigned the incorrect names ``"H 2"`` and ``"H 3"``.
  This has been corrected to give these hydrogens the expected names
  ``"H1"`` and ``"H2"``.
  The :oe:constns:`PDB atom indices<OEChem::OEPDBAtomName>`
  ``OEChem::OEPDBAtomName::H1`` and
  ``OEChem::OEPDBAtomName::H2`` can be used to refer to them.
  The constant ``OEChem::OEPDBAtomName::H`` has been deprecated.

Minor bug fixes
--------------------------------------------------------------------------------

* The algorithm used by the :oe:func:`OEChem::OEPerceiveBondOrders` function
  for detecting sp2 hybridized planar ring systems has been improved.

* For certain complex ring systems, the function
  :oe:func:`OEChem::OECreateSmiString` previously attempted to write a SMILES
  with more than 99 ring closures and output an invalid SMILES.  It now throws
  a warning and returns an empty string.

* If the function :oe:func:`OEChem::OECreateSmiString` cannot generate a
  valid SMILES for a molecule, a molecule title will no longer be output.

* When extracting ring templates for depiction, the
  :oe:meth:`OEChem::OE2DRingDictionary` class's normalization process
  no longer rejects long or short bonds.  This allows the creation of
  non-regular ring templates.

* The :oe:meth:`OEChem::OECenter` overload for :ref:`OEMCMolBase <OEChem_OEMCMolBase>`
  now optionally accepts an array which, when present, returns the
  translations applied for each conformer during the centering operation.
  The additional overload does not affect any existing usage.

* The :oe:meth:`OEChem::OESymmetryNumber` overload that works with
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>` had previously not properly calculated the
  symmetry numbers for all conformers.  This has been fixed.

Java-specific changes
--------------------------------------------------------------------------------

* The Java ``verify`` script has been updated to correctly identify
  a **Szybki TK** license.

* The Java ``verify`` script has been updated to return an error status if
  there was a problem when generating a subset jar.

C#-specific changes
--------------------------------------------------------------------------------

* The Python-based C# ``verify`` script has been modified to run correctly with
  either Python 2 or Python 3.

Documentation changes
--------------------------------------------------------------------------------

* Documentation for :oe:meth:`OEChem::OECenter` and other molecular geometry
  functions has been improved.

OEBio 2.1.1
================================================================================

New features
--------------------------------------------------------------------------------

* A new scoring system, ``MMFF-NIE`` ("MMFF Neighbor Interaction
  Energies"), has been added to improve optimizing hydrogen bonding
  networks and avoiding clashes in the function
  :oe:func:`OEBio::OEPlaceHydrogens`.  This physics-based scoring system
  includes Coulombic
  and Van der Waals terms from ``MMFF94``, including MMFF partial charges.
  Interactions are scored between moveable functional groups 
  (see :ref:`OEPlaceHydrogensMoverClass <OEBio_OEPlaceHydrogensMoverClass>`) as well as
  between moveable functional groups and non-moving neighboring background
  atoms. The optimizer has also been improved to be much more memory-efficient.

* :oe:func:`OEBio::OEPlaceHydrogens` now samples waters more densely by default.
  A new constant, :oe:const:`OEBio::OEPlaceHydrogensWaterProcessing::Focused`,
  can be used to revert to the more limited sampling. Waters are processed
  individually, in order, starting at the molecular surface and moving outward,
  after all other moveable functional groups have been optimized.

* :oe:func:`OEBio::OEPlaceHydrogens` now detects bad clashes more accurately.

* :oe:func:`OEBio::OEPlaceHydrogens` now deprotonates certain acidic groups
  (e.g., SH) in the presence of a metal. In addition, imidazoles can now be
  doubly deprotonated when between two metals.  A new constant,
  :oe:const:`OEBio::OEPlaceHydrogensMoverClass::AroN`, has been
  added to describe aromatic nitrogens that can be deprotonated by metals.

* :oe:func:`OEBio::OEPlaceHydrogens` now recognizes neutral carboxylic acids.
  Hydrogen positions are sampled on both oxygens.

* :oe:func:`OEBio::OEPlaceHydrogens` now includes alternate location codes
  in atom descriptions.

* Two new methods,
  :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetMaxSubstateCutoff`
  and :oe:meth:`OEBio::OEPlaceHydrogensOptions::GetMaxSubstateCutoff`,
  have been
  added to control how many substates the optimizer will consider in a single
  step.  This prevents calculations from running long
  because of overly dense networks.

* Class :ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>` objects can now be compared for
  equivalence and non-equivalence.

Minor bug fixes
--------------------------------------------------------------------------------

* Previously, :oe:func:`OEBio::OEPlaceHydrogens` was limited to processing
  1,024 moveable functional groups.  This limitation has been removed.

* :oe:func:`OEBio::OEPlaceHydrogens` has been improved for adding
  explicit hydrogens to molecules with multiple alternate locations when
  :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetAltsMustBeCompatible`
  is set to ``true``, issuing a warning when it fails rather than halting.

Documentation changes
--------------------------------------------------------------------------------

* A description of the :oe:func:`OEBio::OEPlaceHydrogens`
  scoring system ``MMFF-NIE`` in the documentation for
  :oe:meth:`OEBio::OEPlaceHydrogensDetails::Describe` has been added and
  includes a link from the :ref:`chapter_protein_prep` example.

* The :ref:`section_example_oebio_proteinprep` example has been modified to
  cover the expanded range of options in water processing as well as the
  maximum number of optimization substates. It also now repairs bonding
  mistakes when the command line option ``-alt compare`` is used to retain
  all alternates
  by calling the method :oe:meth:`OEBio::OEAltLocationFactory::GetSourceMol`.
  This is a recommended approach for other workflows that read
  :oe:const:`OEChem::OEFormat::PDB` files and
  retain all alternate location atoms.

OEPlatform 2.1.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The :ref:`OEFile <OEPlatform_OEFile>` API has been augmented to support large
  (>2Gb) files on Windows.

Java-specific changes
--------------------------------------------------------------------------------

* The SWIG Java wrapper no longer creates finalizers for **OpenEye** objects
  that do not own memory: ``OEBase``, ``OEAtomBase``, ``OEBondBase``,
  ``OEConfBase``, and ``OEGroupBase``.  Previously, the SWIG wrapper created
  empty finalizers, which resulted in garbage collection bottlenecks for
  processes that used a lot of objects (e.g., looping over atoms and bonds in
  a protein).  This fix improves overall throughput for Java toolkit programs.

OESystem 2.1.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:meth:`OEMath::OEGeom2DRotate` method previously assumed inputs
  with 3-dimensional coordinates.  It now assumes 2-dimensional coordinates.

* The :oe:meth:`OEMath::OEGeom2DTranslate` method previously assumed inputs
  with 3-dimensional coordinates.  It now assumes 2-dimensional coordinates.

Documentation changes
--------------------------------------------------------------------------------

* Documentation for the public 2D and 3D geometry functions has been improved.


********************************************************************************
Version 2.1.2
********************************************************************************

OEChem TK 2.1.2
================================================================================

New features
--------------------------------------------------------------------------------

* A new function, :oe:func:`OEChem::OEGetSmiStringOrder`, has been added to
  retrieve the atoms of a molecule in the order that they are encoded in the
  :term:`SMILES` string for that molecule.

* New methods :oe:meth:`OEChem::OELibraryGen::SetClearCoordinates` and
  :oe:meth:`OEChem::OEUniMolecularRxn::SetClearCoordinates` have been
  added to clear the coordinates of generated products.

Minor bug fixes
--------------------------------------------------------------------------------

* The function :oe:func:`OEChem::OECount` has been fixed to return the number
  of substructure search matches. An extra parameter has been added to control
  whether the count of unique or non-unique matches is returned.

* The following functions have been fixed to properly handle multi-conformer
  molecules with no active conformation:

  * :oe:meth:`OEChem::OEMolBase::SetDimension`
  * :oe:meth:`OEChem::OEMolBase::GetDimension`
  * :oe:meth:`OEChem::OEMolBase::SetEnergy`
  * :oe:meth:`OEChem::OEMolBase::GetEnergy`

* Several problems with the internal implementation of
  :oe:const:`OEChem::OEMolBaseType::OEMiniMol` have been fixed.  Perception
  flags are now cleared correctly when deleting atoms or bonds.  Coordinates
  are no longer lost when a molecule is swept.

* The :oe:func:`OEChem::OEGenerate2DCoordinates` function now clears MDL
  bond stereo that can be re-perceived by calling the
  :oe:func:`OEChem::OEMDLPerceiveBondStereo` function.

* The :oe:meth:`OEChem::OESubSearch::Init` method now checks that the given
  query molecule is valid. In case of an invalid molecule a warning is thrown
  and the method returns ``false``.

Python-specific changes
--------------------------------------------------------------------------------

* The message for the ``ValueError`` exception raised when trying to attach
  an unrecognized type to an **OpenEye** object as generic data has been
  clarified.

Documentation changes
--------------------------------------------------------------------------------

*  The documentation for the following APIs has been improved:

   * :oe:func:`OEChem::OEAddMols` function
   * :oe:func:`OEChem::OEWriteConstMolecule` function
   * :ref:`OEWriteMolecule <OEChem_OEWriteMolecule>` function
   * :oe:func:`OEChem::OEParseSmiles` function
   * :oe:func:`OEChem::OESubsetMol` function
   * :oe:constns:`OEChem::OEPDBAtomName` namespace

OEBio TK 2.1.2
================================================================================

New features
--------------------------------------------------------------------------------

* A new method, :oe:meth:`OEBio::OEInteractionHintContainer::DeleteInteraction`,
  has been added.

* The set of water orientations sampled by
  :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`
  is now strictly based on local donor/acceptor interactions instead
  of the more generic quaternion sampling used previously.

* The following methods have been added to
  :oe:cls:`OEPlaceHydrogensOptions<OEBio::OEPlaceHydrogensOptions>` to
  control the optimization of conformations of moveable functional groups by
  :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`:

  * :oe:meth:`SetBypassPredicate<OEBio::OEPlaceHydrogensOptions::SetBypassPredicate>`
  * :oe:meth:`SetFlipPredicate<OEBio::OEPlaceHydrogensOptions::SetFlipPredicate>`
  * :oe:meth:`SetNoFlipPredicate<OEBio::OEPlaceHydrogensOptions::SetNoFlipPredicate>`
  * :oe:meth:`GetBypassPredicate<OEBio::OEPlaceHydrogensOptions::GetBypassPredicate>`
  * :oe:meth:`GetFlipPredicate<OEBio::OEPlaceHydrogensOptions::GetFlipPredicate>`
  * :oe:meth:`GetNoFlipPredicate<OEBio::OEPlaceHydrogensOptions::GetNoFlipPredicate>`

* The new method :oe:meth:`OEBio::OEPlaceHydrogensMoverNote::IsRestrained`
  indicates whether a given moveable functional group has been restrained.

* Extended chelation interactions to cases where a protein is chelating a
  ligand metal.

* For interaction hints between any two atoms, implement a perception
  precedence as follows: ``Chelation`` > ``Charge`` > ``Hydrogen-bonding``.

* Added chelation perception to protein intramolecular interaction hints.
  See :oe:const:`OEBio::OEChelatorInteractionHintType::IntramolecularProtein`.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>` results have been
  significantly improved after fixing a bug related to the treatment of
  certain non-moving background atoms.

* :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>` no longer fails
  with a segmentation fault when encountering an H-bond where there
  is a missing covalent bond. It also no longer fails in certain cases when
  adding explicit hydrogens.

* :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>` now uses a more concise
  definition of moveable groups and no longer fails due to matching atoms
  multiple times.

* The MMFF-NIE scoring system used by
  :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>` now works with elements
  such as :oe:const:`Mn<OEChem::OEElemNo::Mn>` that are not parameterized
  in the MMFF94 force field.

* :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>` now generates correct
  hydrogen geometry on carboxylic acid (COOH) groups.

* :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>` no longer orients
  phenolic hydrogens at high angles to the ring plane.

* :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>` generates improved
  orientations for amines deprotonated upon chelating a metal.

Minor bug fixes
--------------------------------------------------------------------------------

* The ordering of :oe:cls:`moveable groups<OEBio::OEPlaceHydrogensMoverNote>`
  associated with a cluster in an
  :oe:cls:`OEPlaceHydrogensDetails<OEBio::OEPlaceHydrogensDetails>` object
  is now consistent across operating systems and platforms.

* :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>` now produces fewer
  warning messages.

* Improved specificity of OEAcceptor definitions for interaction hint
  perception.
  


********************************************************************************
Version 2.1.3
********************************************************************************

OEChem TK 2.1.3
================================================================================

New features
--------------------------------------------------------------------------------

* The :term:`InChI` code has been updated to the v1.05 source released on
  January 27, 2017.  This code is available from the
  `InChI Trust <http://www.inchi-trust.org/downloads/>`_
  and was validated against
  `eMolecules <https://www.emolecules.com/info/products-data-downloads.html>`_
  and
  `ChEMBL_23 <https://www.ebi.ac.uk/chembl/downloads>`_
  public structure sources.

* :term:`InChI` is now a fully supported read/write format for chemical
  structures.  New public API points have been added to support this format:
  :oe:func:`OEChem::OEMolToSTDInChI`, :oe:func:`OEChem::OEMolToSTDInChIKey`,
  :oe:func:`OEChem::OEInChIToMol`, and :oe:func:`OEChem::OEParseInChI`.

.. warning::

  The standard InChI format includes chemical normalization activity that
  results in round-trip structure alterations to a very high percentage of
  structures when unnormalized or when arbitrary input chemistry is used.
  Even the output of :oe:func:`OEChem::OEMolToInChI`, which generates a
  nonstandard InChI and attempts to minimize structure normalizations, results
  in many changes to input chemical structures.

* :ref:`OEInChIOptions <OEChem_OEInChIOptions>` now supports relative stereo and
  racemic stereo :term:`InChI` output as well as control of the timeout
  condition.

* The default output flavor for writing :term:`InChI` or :term:`InChIKey` via
  :oe:func:`OEChem::OEWriteMolecule` has been changed to include the molecule
  title as well as the InChI information to synchronize behavior with
  other output formats.  Since the InChI identifiers never include white space,
  there should be no ambiguity for separating the InChI information from the
  title. If there are third-party readers that have problems with the title,
  the following output flavor bits are now available to control whether the
  title is added to the output: :oe:const:`OEChem::OEOFlavor::INCHI::Title` and
  :oe:const:`OEChem::OEOFlavor::INCHIKEY::Title`.

* An overload of :oe:func:`OEChem::OEShortestPath` has been added to take an
  atom predicate and return the shortest path between atoms that are not
  excluded by the predicate.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEChem::OEParseSmiles` no longer throws an "Unable to
  Kekulize SMILES" warning in quiet mode (see also
  :ref:`OEParseSmilesOptions <OEChem_OEParseSmilesOptions>`).

* :oe:func:`OEChem::OEDeleteEverythingExceptTheFirstLargestComponent`
  has been reimplemented using :ref:`OEDetermineComponents <OEChem_OEDetermineComponents>` and
  no longer returns ``true`` for one-component molecules with explicit
  hydrogens.

* :oe:func:`OEChem::OEWriteMolecule` and :oe:func:`OEChem::OEWriteConstMolecule`
  now return the new :oe:const:`OEChem::OEWriteMolReturnCode::NoConformer`
  constant in cases when a multi-conformer molecule is being written
  without any conformer.

* :oe:func:`OEChem::OEGetSmiStringOrder` now has both a ``const`` and
  a ``non-const`` version.

* :oe:func:`OEChem::OEGetSmiStringOrder` could crash for structures
  that were modified by deleting atoms.  This has been fixed.

* The :oe:const:`OEChem::OESMILESFlag::AllBonds` flavor flag had been missing
  from the :oe:constns:`OEChem::OEOFlavor` namespace and has been added to the
  :oe:constns:`OEChem::OEOFlavor::SMI`, :oe:constns:`OEChem::OEOFlavor::ISM`,
  :oe:constns:`OEChem::OEOFlavor::CAN` and :oe:constns:`OEChem::OEOFlavor::USM`
  namespaces.

OESystem TK 2.1.3
================================================================================

New features
--------------------------------------------------------------------------------

* A new parameter has been added to the constructor of
  :ref:`OEDots <OESystem_OEDots>` that enables changing the "processed" label in
  the output lines.

Minor bug fixes
--------------------------------------------------------------------------------

* The function :oe:func:`OESystem::OEGetTag` and method
  :oe:meth:`OESystem::OEBase::GetData` could segfault when called with a
  null ``char *`` argument in C++ or with an empty argument in the wrapped
  languages.  These have been fixed.

OEBio TK 2.1.3
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEBio::OESetupSplitMolComplexOptions` now has
  two additional parameters, ``siteOverride`` and ``modelOverride``, that
  make it easier to configure filters while iterating over binding sites
  and/or model numbers. The new constant
  :oe:const:`OEBio::OESplitMolComplexParam::DoNotOverride`
  is used control the behavior of these constants.

* A new atom predicate, :ref:`OEIsWater <OEBio_OEIsWater>`, has been added.

* Two new methods, :oe:meth:`OEBio::OEInteractionHint::GetDetails` and
  :oe:meth:`OEBio::OEInteractionHint::SetDetails`, have been added.

* Two new interaction hint types have been added to interaction perceptions:
  :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>` and
  :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`.  When covalent interactions
  are present, nearby clash interactions are no longer perceived.

* The :ref:`OECrystalSymmetryParams <OEBio_OECrystalSymmetryParams>` class now stores the Z-value
  parsed from the ``CRYST1`` line of a PDB file.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:cls:`OEBio::OEAltLocationFactory::GetGroups` no longer crashes on Windows
  in cases where no alternate location group exists.

* Calling the function :oe:func:`OEBio::OEBuildUnitCell` on protein molecules
  had previously consumed large amounts of memory and, as a result, would
  often crash.  This issue has been addressed, and the performance of the
  function has been improved for molecules of small or medium size.

* Interaction perception for anionic carbonyl groups has been fixed.

* :oe:func:`OEBio::OEIsValidActiveSite` now takes into account the non-default
  parameter ligand component type.

Documentation changes
--------------------------------------------------------------------------------

* An example in :ref:`section_example_oebio_proteinprep` has been modified
  to work properly when splitting a ligand from a binding site other
  than the first one.

OEGrid TK 1.6.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OESystem::OEMaskGridByMolecule` no longer segfaults for an empty
  molecule or for a molecule without 2D coordinates.  It now throws a warning
  and returns ``false``.

* On Windows, UTF8 file and directory names are now correctly supported for
  toolkit file I/O operations.

Java-specific changes
--------------------------------------------------------------------------------

* The following methods are now wrapped correctly as ``constCall``:

  * :oe:meth:`OEChem::OEIsRxnComponentGroup::operator()`
  * :oe:meth:`OEChem::OEIsReactantGroup::operator()`
  * :oe:meth:`OEChem::OEIsProductGroup::operator()`

Documentation changes
--------------------------------------------------------------------------------

* Read/write examples have been added to demonstrate the use of the
  :term:`InChI` structure format.

* Examples of using the preferred :oe:func:`OEChem::OEMolToSTDInChI` and
  :oe:func:`OEChem::OEMolToSTDInChIKey` API points when creating standard
  :term:`InChI` strings have been updated.

* Examples have been updated to now use
  :oe:func:`OEChem::OEDeleteEverythingExceptTheFirstLargestComponent`
  rather than the deprecated function
  :oe:func:`OEChem::OETheFunctionFormerlyKnownAsStripSalts`.

* The classes :ref:`OENearestNbrs <OEChem_OENearestNbrs>` and :ref:`OENbrs <OEChem_OENbrs>`,
  function :oe:func:`OEChem::OEGetNearestNbrs`, and namespace
  :oe:constns:`OEChem::OENearestNbrsMethod` have been documented.


********************************************************************************
Version 2.1.4
********************************************************************************

OEChem TK 2.1.4
================================================================================

New features
--------------------------------------------------------------------------------

* Two new overload functions, ``OEChem::OEReadMolFromString`` and
  ``OEChem::OEWriteMolToString``, have been added to specify
  input or output flavors from the
  :oe:constns:`OEChem::OEIFlavor` and :oe:constns:`OEChem::OEOFlavor`
  namespaces.

* A new class, :ref:`OE2DRingDictionaryCreatorOptions <OEChem_OE2DRingDictionaryCreatorOptions>`,
  has been added to customize generating user-defined ring template
  dictionaries.

* A new constructor, :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>`, has been added
  that takes an :ref:`OE2DRingDictionaryCreatorOptions <OEChem_OE2DRingDictionaryCreatorOptions>` option
  class as a parameter.

* A new function, :oe:func:`OEChem::OEClear2DRingDictionary`, has been
  added to clear the global user-defined ring dictionary used for 2D
  coordinate generation.

* A new function, :oe:func:`OEChem::OESet2DHydrogenGeom`, has been added
  to assign approximate 2D coordinates to explicit hydrogen atoms.

Major bug fixes
--------------------------------------------------------------------------------

* The ``OEChem::OEReadMolFromString`` and
  ``OEChem::OEWriteMolToString`` functions use internal buffers for
  the encoding or decoding of molecules from bytes.  Previously, depending
  on library load order, internal buffers could be initialized without the
  complete set of binary input/output handlers.  This could result in the
  loss of custom datatypes when translating to or from bytes.
  These internal buffers now are updated during subsequent loads of
  **OpenEye** libraries to ensure that the complete set of custom datatypes
  is handled correctly.

* The implementations of ``OEChem::OEDBMol`` and
  ``OEChem::OEMiniMol`` have been corrected to avoid a potential crash
  after an :oe:meth:`OEChem::OEMolBase::Compress` and
  :oe:meth:`OEChem::OEMolBase::UnCompress` call sequence when the molecule
  contains :ref:`OEGroupBase <OEChem_OEGroupBase>` objects (e.g., reaction component
  information or V3000 enhanced stereo information).  While the
  ``OEChem::OEMiniMol`` supports :ref:`OEGroupBase <OEChem_OEGroupBase>` objects,
  it cannot save and restore following
  :oe:meth:`OEChem::OEMolBase::Compress` and
  :oe:meth:`OEChem::OEMolBase::UnCompress` calls, so this class must never be
  used if :ref:`OEGroupBase <OEChem_OEGroupBase>` information is to be maintained.
  The ``OEChem::OEDBMol`` implementation is the preferred class for
  low memory footprint applications when :ref:`OEGroupBase <OEChem_OEGroupBase>`
  may be present.

* When writing a 2D molecule with explicit hydrogens to an MDL file,
  the coordinates of the stereo hydrogens are now reassigned by
  calling the :ref:`OESet2DHydrogenGeom <OEChem_OESet2DHydrogenGeom>` function
  if they are identical to their parent heavy atom coordinates.
  This ensures that reinterpretation of the MDL file does not
  inadvertently flip stereo configurations.

Minor bug fixes
--------------------------------------------------------------------------------

* The algorithm used by :oe:func:`OEChem::OEGenerate2DCoordinates` to
  detect and resolve atom clashes when generating 2D coordinates has
  been improved.

* When calling the :oe:func:`OEChem::OERMSD` function for a multi conformer
  fit molecule, the returned RMSD array will now have a -1.0 value for
  conformation indices that are not valid for the fit molecule.

* The :oe:func:`OEChem::OEAssignAromaticFlags` function now limits the search
  path to 30 bonds when the bond/atom ratio is higher than 1.3.
  As a result, buckyball-like molecules can be processed in reasonable time.

C++-specific changes
--------------------------------------------------------------------------------

* A deprecated overload of the :oe:func:`OEChem::OEPRECompress` function,
  ``OEPRECompress(OEMol &, const OEMCMolBase &)``, has been removed from
  the C++ API.  :oe:func:`OEFastROCS::OEPrepareFastROCSMol` should now be
  used to create molecules optimized for **ROCS**-type calculations.
  The documentation has been updated to reflect this change.

Python-specific changes
--------------------------------------------------------------------------------

* Two new overload functions, :ref:`OEReadMolFromBytes <OEChem_OEReadMolFromBytes>` and
  :ref:`OEWriteMolToBytes <OEChem_OEWriteMolToBytes>`, have been added to specify
  input or output flavors from the :oe:constns:`OEChem::OEIFlavor` and
  :oe:constns:`OEChem::OEOFlavor` namespaces.

* A crash in the Python interpreter due to malformed UTF-8 input character
  sequences has been fixed.

* Binary data now can be safely attached to objects as generic data without
  being truncated at a ``\0`` character.

Java-specific changes
--------------------------------------------------------------------------------

* Two new overload functions, ``OEChem::OEReadMolFromByteArray`` and
  ``OEChem::OEWriteMolToByteArray``, have been
  added to specify input or output flavors from
  the :oe:constns:`OEChem::OEIFlavor` and :oe:constns:`OEChem::OEOFlavor`
  namespaces.

C#-specific changes
--------------------------------------------------------------------------------

* Two new overload functions, :ref:`OEReadMolFromBytes <OEChem_OEReadMolFromBytes>` and
  :ref:`OEWriteMolToBytes <OEChem_OEWriteMolToBytes>`, have been
  added to specify input or output flavors from
  the :oe:constns:`OEChem::OEIFlavor` and :oe:constns:`OEChem::OEOFlavor`
  namespaces.

* A minor issue with the C# ``verify.py`` script that caused the
  validation to halt if one or more toolkit licenses was missing from the
  active license file has been fixed.

OESystem TK 2.1.4
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The :ref:`OEColor <OESystem_OEColor>` constructor and
  :oe:meth:`OESystem::OEColor::SetRGBA`
  method now throw warnings for a null pointer.

OEBio TK 2.1.4
================================================================================

New features
--------------------------------------------------------------------------------

* A new method, :oe:meth:`OEBio::OEInteractionHintFragment::GetAtom`,
  has been added.

* A new predicate, :ref:`OEIsIntermolecularChelatorInteractionHint <OEBio_OEIsIntermolecularChelatorInteractionHint>`,
  has been added.

Minor bug fixes
--------------------------------------------------------------------------------

* The :ref:`OEIsChelatorInteractionHint <OEBio_OEIsChelatorInteractionHint>` predicate has been fixed to
  recognize the
  :oe:const:`OEBio::OEChelatorInteractionHintType::IntramolecularProtein` type.

* The :oe:const:`OEBio::OEHBondInteractionHintType::Clash` type has
  been deprecated and replaced with
  :oe:const:`OEBio::OEHBondInteractionHintType::ClashAcceptorAcceptor` and
  :oe:const:`OEBio::OEHBondInteractionHintType::ClashDonorDonor` types.

* The :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedLigand` type
  has been deprecated and replaced with
  :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedLigandPositive`
  and
  :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedLigandNegative`
  types.

* The :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedProtein`
  type has been deprecated and replaced with
  :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedProteinPositive`
  and
  :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedProteinNegative`
  types.

* The implementation of :oe:const:`OEBio::OEHBondInteractionHintType::Clash`
  has been corrected to use proper geometric constraints in determining these
  unfavorable interactions.  In addition,
  :oe:const:`OEBio::OEHBondInteractionHintType::Clash`
  has been split into
  :oe:const:`OEBio::OEHBondInteractionHintType::ClashDonorDonor` and
  :oe:const:`OEBio::OEHBondInteractionHintType::ClashAcceptorAcceptor`
  to provide more specificity.  These interactions are assigned only after
  other stronger or more favorable interactions have been assessed.
  Finally, hydrogen-bonding interaction clashes will not be assigned to
  groups that could avoid the interaction with a simple hydrogen rotation.


********************************************************************************
Version 2.1.5
********************************************************************************

OEChem TK 2.1.5
================================================================================

New features
--------------------------------------------------------------------------------

* New :oe:func:`OEChem::OEHasExplicitHydrogenExpression` and
  :oe:func:`OEChem::OEHasImplicitHydrogenExpression` functions have been added.

* The :oe:func:`OEChem::OEPrepareSearch` function now takes a parameter that determines
  whether to adjust the hydrogen of a target molecule based on the presence or absence
  of implicit and explicit hydrogens on the query molecule of the substructure
  search.

* Both :oe:func:`OEChem::OEGetSubtree` and :oe:func:`OEChem::OEGetSmallestSubtree` functions
  now take an optional max depth parameter that allows partial traversal of
  subtrees.
  For example, the parameter allows identification of the subtree of a proline residue without traversing back
  onto the main chain. Similarly, it is possible to get the subtree of a cysteine residue
  involved in a disulfide without traversing across the disulfide bond and back on the main chain.

* Two new constants, :oe:const:`OEChem::OEIFlavor::MDL::SuppressImp2ExpENHSTE` and
  :oe:const:`OEChem::OEOFlavor::MDL::SuppressImp2ExpENHSTE`,
  have been added with related MDL input and output formats (e.g., SDF, RDF)
  to allow suppression of explicit MDL stereogroup generation for implied
  stereocollection membership. By default, marked stereocenters not explicitly included in
  stereocollections are added to their implied stereocollection membership based on the chiral flag setting.

* A new :oe:const:`OEChem::OEGroupType::UserDefined` type has been added
  to :ref:`OEGroupBase <OEChem_OEGroupBase>` to support serialization and deserialization
  via the ``OEB`` format.

* A new :ref:`OEIsBridgeHead <OEChem_OEIsBridgeHead>` functor has been added to identify bridge
  head atoms in a molecule.

* A new :oe:func:`OEChem::OERingBondCount` function has been added that returns
  the number of bonds connected to an atom that are part of a ring.

Major bug fixes
--------------------------------------------------------------------------------

* The FASTA reader has been fixed to support reading multiline FASTA strings.

* Generic data attached to :ref:`OEGroupBase <OEChem_OEGroupBase>` is no longer
  lost when the molecule is copied.

* Generic data attached to :ref:`OEGroupBase <OEChem_OEGroupBase>` is no longer
  lost when the molecule is added to another molecule by invoking the
  :oe:func:`OEChem::OEAddMols` function.

* Relative stereo (e.g., 1,4-disubstituted cyclohexanes) information is now preserved
  on input, ensuring that the conformers generated will respect the input stereochemistry.
  Previously, such relative stereocenters would be cleared during activities to
  clear other illegally marked stereochemistry.

* The V3000 MDL format readers called by :oe:func:`OEChem::OEReadMolecule` now support
  noncontiguous object indices.  It previously had been assumed that such indices
  were contiguous, but recent third-party writers have demonstrated that this assumption
  is no longer valid.

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:func:`OEChem::OEGenerate2DCoordinates` function now returns ``false`` when it
  fails to generate coordinates that are consistent with the atom/bond stereo of a
  molecule.

* A memory corruption issue in the InChI generation code that previously required a check
  for hydrogen isotopes beyond ``[3H]`` will no longer generate InChI for these
  unrealistic hydrogen isotopes.

* Malformed SD bond lines that lacked both atom endpoints had previously been ignored.
  :oe:func:`OEChem::OEReadMolecule` now fails for these types of format errors.

* :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` internal validations have been relaxed to allow
  reaction transformations that create a bond between two separate fragments.

* :oe:func:`OEChem::OEGetHybridization` has been repaired to return
  :oe:const:`OEChem::OEHybridization::sp3d` and :oe:const:`OEChem::OEHybridization::sp3d2`
  for high valence halogens.  Previously, this
  function had only returned :oe:const:`OEChem::OEHybridization::sp3` for these cases.

* :oe:func:`OEChem::OEUncolorMol` has been augmented to remove stereogroups when stripping
  atom stereochemistry.  Additionally, a new option,
  :oe:const:`OEChem::OEUncolorStrategy::RemoveGroupStereo`, has been added to support
  the explicit stripping of stereogroups.

* :ref:`OEAnd <OESystem_OEAnd>` and :ref:`OEOr <OESystem_OEOr>` have been augmented to support
  using :ref:`OEGroupBase <OEChem_OEGroupBase>` types to allow a more complex selection
  of MDL stereogroup types via custom predicates.

* A new copy constructor and new assignment operator have been added to
  :ref:`OERotMatrix <OEChem_OERotMatrix>`.

Python-specific changes
--------------------------------------------------------------------------------

* Type comparisons between ``OEBase`` and non-``OEBase`` objects have been fixed
  to ensure that an exception is longer thrown.

* A new ``__str__()`` function has been added to :ref:`OEResidue <OEChem_OEResidue>` to provide
  a convenient string representation.

Java-specific changes
--------------------------------------------------------------------------------

* A new ``OELibExtractor.GetTmpDirName()`` method has been added to
  return the temporary directory used for the extraction of native
  libraries from the JarFile and the extraction lock file. This
  directory location can potentially be used to clean up extraction
  locks that have been left behind due to inadvertent or explicit Java
  process kill activities.

Documentation changes
--------------------------------------------------------------------------------

* The documentation for :oe:const:`OEChem::OESMILESFlag::Hydrogens` has been clarified.

* The porphyrin footnote in the aromaticity table in the
  :ref:`Aromaticity Perception<chapter_aromaticity>`
  section has been clarified.

OEBio TK 2.1.5
================================================================================

New features
--------------------------------------------------------------------------------

* The following APIs have been added to perform Ramachandran analyses on protein
  structures:

  * :ref:`OERamachandranAnalysis <OEBio_OERamachandranAnalysis>` class
  * :oe:func:`OEBio::OEGetRamachandranTypeName` and :oe:func:`OEBio::OEGetRamachandranCategoryName`
    functions
  * :oe:constns:`OEBio::OERamaType` and  :oe:constns:`OEBio::OERamaCategory`
    namespaces

* A new :oe:const:`OEBio::OERotamerLibrary::Richardson_2016` constant has been added
  to provide rotamers from the ultimate rotamer library [Hintze-2016]_  .
  This new rotamer library is now the default.

* The following atom predicates have been added to identify RNA atoms:

  * :ref:`OEIsNucleicAcidBase <OEBio_OEIsNucleicAcidBase>`
  * :ref:`OEIsNucleicAcidSugar <OEBio_OEIsNucleicAcidSugar>`
  * :ref:`OEIsNucleicAcidPhosphate <OEBio_OEIsNucleicAcidPhosphate>`

* A new :oe:func:`OEBio::OESetRotamer` overload has been added that takes a residue atom.

Minor bug fixes
--------------------------------------------------------------------------------

* It is now possible to set an alternative rotamer on proline residues.

C++-specific changes
--------------------------------------------------------------------------------

* **OEBio TK** now depends on **OEGrid TK**. As result,
  CMake files might need to be modified to reflect this library dependency.

Java-specific changes
--------------------------------------------------------------------------------

* The Java wrapping of the following predicates has been fixed:

  * :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>`
  * :ref:`OEIsCovalentInteractionHint <OEBio_OEIsCovalentInteractionHint>`
  * :ref:`OEIsIntermolecularChelatorInteractionHint <OEBio_OEIsIntermolecularChelatorInteractionHint>`

C#-specific changes
--------------------------------------------------------------------------------

* The C# wrapping of the following predicates has been fixed:

  * :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>`
  * :ref:`OEIsCovalentInteractionHint <OEBio_OEIsCovalentInteractionHint>`
  * :ref:`OEIsIntermolecularChelatorInteractionHint <OEBio_OEIsIntermolecularChelatorInteractionHint>`

OEPlatform TK 2.1.5
================================================================================

* Minor internal improvements have been made.

OESystem TK 2.1.5
================================================================================

* The :oe:func:`OESystem::OEWriteSettings` function now takes a 4th argument
  that specifies the name of an optimized parameter set for **OpenEye**'s
  applications.


********************************************************************************
Version 2.2.0
********************************************************************************

OEChem TK 2.2.0
================================================================================

New features
--------------------------------------------------------------------------------

* Atom and bond expressions of query molecules have been optimized for
  substructure search. The graphs below show the performance improvement since
  the 2018.Oct release.
  Optimization has been turned on for both MDL queries
  and SMARTS patterns and can be controlled by the following options:

  * :oe:const:`OEChem::OESmartsParseOpts::Optimize` when using the :oe:func:`OEChem::OEParseSmarts` function
  * :oe:const:`OEChem::OEMDLQueryOpts::Optimize` when using the :oe:func:`OEChem::OEReadMDLQueryFile` function

  .. list-table:: **Substructure search performance improvement for MDL queries**
     :widths: 250 350

     * - .. image:: ../../oechemtk/images/releasenotes-2.2.0/MDL-SearchTimes.png
            :width: 250pt
       - .. image:: ../../oechemtk/images/releasenotes-2.2.0/MDL-Improvement.png
            :width: 350pt

  .. list-table:: **Substructure search performance improvement for SMARTS patterns**
     :widths: 250 350

     * - .. image:: ../../oechemtk/images/releasenotes-2.2.0/SMARTS-SearchTimes.png
            :width: 250pt
       - .. image:: ../../oechemtk/images/releasenotes-2.2.0/SMARTS-Improvements.png
            :width: 350pt

* A new :oe:const:`OEChem::OEFormat::OEZ` compressed binary format has been
  added with the ``.oez`` extension.
  This file format only supports multi-conformer molecules derived
  from the :ref:`OEMCMolBase <OEChem_OEMCMolBase>` class.
  Each molecule is individually compressed in the file
  using the `Zstandard <https://facebook.github.io/zstd/>`_
  compression algorithm.
  See the :ref:`section_molreadwrite_compressed` section for more details.

  .. note::

     This new file format is not backwards compatible. **OpenEye** applications and
     toolkits released before April 2019 will *not* be able to read or write
     this file format.

* An :ref:`OEBitVector <OESystem_OEBitVector>` object now can be attached as generic data
  to any :ref:`OEBase <OESystem_OEBase>` object. Its derived classes now round-trip through the
  OEB format.

* Multi-conformer molecule overloads have been added to the following existing APIs:

  * :oe:func:`OEChem::OEMDLHasParity`
  * :oe:func:`OEChem::OEMDLGetParity`
  * :oe:func:`OEChem::OEMDLSetParity`
  * :oe:func:`OEChem::OEMDLClearParity`

* New input flavors, :oe:const:`OEChem::OEIFlavor::MDL::SuppressEmptyMolSkip`,
  :oe:const:`OEChem::OEIFlavor::SDF::SuppressEmptyMolSkip`,
  and :oe:const:`OEChem::OEIFlavor::RDF::SuppressEmptyMolSkip`, have been added to the MDL
  formats to allow returning empty molecule records.
  This allows the SD data to be recovered from these records.

* New output flavors, :oe:const:`OEChem::OEOFlavor::MDL::SuppressTimestamps` and
  :oe:const:`OEChem::OEOFlavor::SDF::SuppressTimestamps`,
  have been added to the MDL formats to explicitly suppress timestamps in the file header.
  This is convenient for generating diffable test files.

* A new :oe:func:`OEChem::OEResidueToString` function has been added to convert an
  :ref:`OEResidue <OEChem_OEResidue>` object into string representation.

* The following new classes have been added to provide alternative ways to access tagged property
  data in molecules:

  * :ref:`OEMolPropertyFxn <OEChem_OEMolPropertyFxn>`
  * :ref:`OEMolSDPropertyFxn <OEChem_OEMolSDPropertyFxn>`
  * :ref:`OEMolGDPropertyFxn <OEChem_OEMolGDPropertyFxn>`
  * :ref:`OEMolTaggedPropertyFxn <OEChem_OEMolTaggedPropertyFxn>`
  * :ref:`OEMolPropertyList <OEChem_OEMolPropertyList>`

* New predicates, :ref:`OEIsValidAtomValence <OEChem_OEIsValidAtomValence>` and :ref:`OEIsValidMDLAtomValence <OEChem_OEIsValidMDLAtomValence>`,
  have been added to provide the ability to loop over atoms that satisfy the **OpenEye** and
  MDL valence model requirements, respectively.

* The :oe:meth:`OEChem::OEMolBase::NewGroup` method now also takes
  an :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object.

* New :oe:func:`OEChem::OECheckAtomValence` and :oe:func:`OEChem::OECheckAtomValences` functions
  have been added that check if an atom or all atoms of a molecule have valid valences.

* A new :oe:meth:`OEChem::OELibraryGen::NumPossibleProducts` method
  has been added that returns the number of possible products that can be generated.

* New :oe:func:`OEChem::OEClearSDData` and :oe:func:`OEChem::OEClearPDBData`  function overloads
  have been added to clear SD or PDB data of multi-conformer molecules.

* A new :oe:func:`OEChem::OEShortestPath` overload function has been added
  that disallows traversing excluded bonds in the path.

* A new :oe:meth:`OEChem::OEAtomBondSet::GetParent` method has been added.

* A new :oe:func:`OEChem::OEGetResidueIndexFromCode` function has been added.

* The :oe:func:`OEChem::OEPDBOrderAtoms` function has been updated to take an argument
  that preserves the PDB residue order. It defaults to ``false`` to preserve
  backwards compatibility.

Major bug fixes
--------------------------------------------------------------------------------

* The number of cases where round-tripping to MDL file format results in stereo information loss
  has been significantly reduced.

Minor bug fixes
--------------------------------------------------------------------------------

* High-level SMILES readers such as :oe:func:`OEChem::OESmilesToMol` and
  :oe:func:`OEChem::OEReadMolecule`  now clear cis/trans bond specifications on bonds
  in small rings (less than 7 members).

* The :oe:meth:`OEChem::oemolistream::open<OEChem::oemolstreambase::open>` and
  :oe:meth:`OEChem::oemolostream::open<OEChem::oemolstreambase::open>`
  methods now correctly set the formats for ``gz`` filenames.

* A bug that caused a crash when an invalid :ref:`oemolostream <OEChem_oemolostream>` is finalized
  has been fixed.

* :oe:meth:`OEChem::oemolistream::Setgz` and :oe:meth:`OEChem::oemolostream::Setgz` methods
  are now a no-op if the state of the stream is unchanged.

* An issue that caused the JSON writer to crash with user-specified cis/trans stereo
  has been fixed.

* The MDL V3000 reader has been fixed and no longer marks "either" double bonds with cis/trans parity.

* The MDL V2000 reader has been fixed and no longer adds "either" double marks to chiral
  but unspecified cis/trans double bonds.

* :oe:func:`OEChem::OESubsetMol` no longer crashes when breaking and adding multiple R-groups
  to the same atoms.

* Cobalt ions are now assigned a formal charge when being read from the PDB file.

Python-specific changes
--------------------------------------------------------------------------------

* The ``__str__`` method of the :ref:`OEResidue <OEChem_OEResidue>` class now invokes the
  new :oe:func:`OEChem::OEResidueToString` function.

* The :oe:meth:`OEChem::OEMolDatabase::GetMoleculeString` method has been fixed
  and now returns ``bytes``.

Documentation changes
--------------------------------------------------------------------------------

* New code snippets have been added to the
  :oe:src:`Substructure Search<SNIPPET-SubstructureSearchMatch>` section to show
  how to reconstruct matches for the original molecule.

* A new :ref:`section_example_oechem_molchunk` example has been added.

* New code snippets have been added to the :oe:func:`OEChem::OEChemIsLicensed`
  function.

OEBio TK 2.2.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new :oe:func:`OEBio::OEIsCTerminalAtom` predicate has been added to identify the C-terminal
  atom(s) in a protein structure.

* A new :oe:func:`OEBio::OEIsNTerminalAtom` predicate has been added to identify the N-terminal
  atom(s) in a protein structure.

* A new :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>` predicate has been added to identify residue
  atoms by RegEx.

* New :oe:func:`OEBio::OEGetResidueAtom` functions have been added to provide easy access for
  specific residue atoms.

* The :oe:func:`OEBio::OEIsBackboneAtom` predicate has been updated to take an
  optional argument to consider the terminal oxygen atom (OXT) as part
  of the backbone.

* The :oe:func:`OEBio::OEIsWater` predicate has been updated to take two optional
  arguments:

  * to match hydrogen atoms in water molecules
  * to match the water ions :math:`OH^{-}` and :math:`H_{3}O^{+}`

* A new :oe:func:`OEBio::OEIsStandardProteinResidue` overload that
  takes an atom has been added.

New features (Preliminary)
--------------------------------------------------------------------------------

* The following preliminary APIs have been added to handle design units:

  * :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
  * :oe:const:`OEBio::OEDesignUnitFileType`
  * :oe:func:`OEBio::OEIsReadableDesignUnit`
  * :oe:func:`OEBio::OEIsWriteableDesignUnit`
  * :oe:func:`OEBio::OEReadDesignUnit`
  * :oe:func:`OEBio::OEWriteDesignUnit`

  * :oe:constns:`OEBio::OEDesignUnitComponents`

  * :oe:func:`OEBio::OESubsetDesignUnit`
  * :oe:func:`OEBio::OEUpdateDesignUnit`

  * :oe:constns:`OEBio::OEIridiumCategory`
  * :ref:`OEIridiumData <OEBio_OEIridiumData>`
  * :oe:func:`OEBio::OEGetIridiumCategoryName`
  * :oe:func:`OEBio::OEGetIridiumCategoryFromName`
  * :ref:`OEStructureQuality <OEBio_OEStructureQuality>`

  * :oe:func:`OEBio::OEGetDesignUnitComponentID`
  * :oe:func:`OEBio::OEGetDesignUnitComponentName`

  The above classes and functions are currently used by **Spruce TK** for
  protein handling.

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>` function has been improved:

  * The :oe:const:`OEBio::OEPlaceHydrogensMoverClass::NH2` mover perception has
    been updated.
  * The :oe:const:`OEBio::OEPlaceHydrogensMoverClass::COOH` mover perception
    has been updated to only mark the atoms involved in the mover.

Java-specific changes
--------------------------------------------------------------------------------

* The Java example in the :ref:`section_example_oebio_splitmolcomplexlowlevel`
  section has been fixed.

Documentation changes
--------------------------------------------------------------------------------

* A new :ref:`chapter_interactions` chapter has been added.

* Code snippets have been added to the :oe:func:`OEBio::OESetCrystalSymmetry` and
  :oe:func:`OEBio::OEGetCrystalSymmetry` functions.

OESystem TK 2.2.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:func:`OESystem::OEMakeMolecularGaussianGrid` function now returns ``false``
  for an empty molecule.

* New code snippets have been added to the :oe:constns:`OESystem::OEThrow`
  class to demonstrate how to redirect warning and error messages to a file.

OEPlatform TK 2.2.0
================================================================================

New features
--------------------------------------------------------------------------------

* The following APIs have been rewritten using standard C++11 classes:

  * :ref:`OEMutex <OEPlatform_OEMutex>` now uses `std::mutex <https://en.cppreference.com/w/cpp/thread/mutex>`_.
  * :ref:`OETryMutex <OEPlatform_OETryMutex>` now uses `std::try_lock <https://en.cppreference.com/w/cpp/thread/mutex/try_lock>`_.
  * :ref:`OELock <OEPlatform_OELock>` and :ref:`OELockSpinlock <OEPlatform_OELockSpinlock>`
    now use `std::lock_guard <https://en.cppreference.com/w/cpp/thread/lock_guard>`_.

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:func:`OEPlatform::OEAddLicenseFromHttp` function available in the wrapped
  languages (Python, Java, and C#) now accepts HTTP
  responses with a ``text/plain; charset=utf-8`` content type.

OEGrid TK 1.6.3
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:func:`OESystem::OEReadMTZ` function has been updated to read CCP4 alternative
  space group numbers (e.g., 4005).

* :oe:func:`OESystem::OEReadGrid` no longer loses its title beyond the first blank space.

* A potential memory corruption issue with Gaussian volume calculation has been fixed.


********************************************************************************
Version 2.3.0
********************************************************************************

.. _section_oechem_releasenotes_230:

OEChem TK 2.3.0
================================================================================

New features (Preliminary)
--------------------------------------------------------------------------------

* The following preliminary APIs have been added to perform fast substructure searches:

  * A new class, :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>`, has been added that stores
    bit-vector screens. In addition, a new :oe:constns:`OEChem::OESubSearchScreenType`
    namespace and :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>` class have been added that
    handle various screen types.

  * Two new low-level functions, :oe:func:`OEChem::OEMakeSubSearchQueryScreen`
    and :oe:func:`OEChem::OEMakeSubSearchTargetScreen`, have been added that
    generate query and target molecule screens, respectively. The
    :oe:func:`OEChem::OEScreen` low-level function can be used to determine
    whether a query molecule can potentially be matched to a target molecule by
    comparing their screens.

  * A new function, :oe:func:`OEChem::OEIsComplementaryScreenType`, has been
    added that determines which screen types are suited for a specific
    query molecule.

  * New helper functions, :oe:func:`OEChem::OESameSubSearchScreenTypes`,
    :oe:func:`OEChem::OEGetSubSearchScreenType`, and
    :oe:func:`OEChem::OEIsValidSubSearchScreenString`, have been added.

  * A new :ref:`OECreateSubSearchDatabaseOptions <OEChem_OECreateSubSearchDatabaseOptions>` option class
    and :oe:func:`OEChem::OECreateSubSearchDatabaseFile` function have
    been added that pre-generate databases for substructure search.
    A new :oe:func:`OEChem::OEIsValidSubSearchDatabase` function also has
    been added that checks whether a molecule file is valid for substructure search.

  * The :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` class is designed to perform
    rapid substructure searches. A new :oe:constns:`OEChem::OESubSearchDatabaseType`
    namespace has been added to this class that enables various database implementations.

  * A new class, :ref:`OESubSearchQuery <OEChem_OESubSearchQuery>`, has been added that
    sets up search queries. In addition, a new :ref:`OESubSearchResult <OEChem_OESubSearchResult>` class has
    been added that reports the progress of the search and retrieves the matches.

  * A new :oe:constns:`OEChem::OESubSearchStatus` namespace and
    :oe:func:`OEChem::OESubSearchStatusToName` helper function have been
    added that monitor the search progress.

* A new low-level function, :oe:func:`OEChem::OEReadCIFFile`, has been added that
  reads both small and macromolecule Crystallographic Information File
  (CIF and mmCIF) formats.

New features
--------------------------------------------------------------------------------

* Two new classes, :ref:`OEConfRMSDOptions <OEChem_OEConfRMSDOptions>` and :ref:`OEConfRMSD <OEChem_OEConfRMSD>`,
  have been added that set up :ref:`OEConfRMSD <OEChem_OEConfRMSD>` calculations and provide fast
  RMSD calculation of conformers of the same molecule, respectively.

* A new function, :oe:func:`OEChem::OEFastaToMol`, has been added that converts a
  FASTA sequence into a molecule.

* A new optional sorting argument has been added to the
  :oe:func:`OEChem::OEGetNearestNbrs` function that allows returned atom pairs
  to be sorted based on distance.

* :ref:`OEIsAlphaCarbon <OEBio_OEIsAlphaCarbon>` has been deprecated. The
  :ref:`OEIsCAlpha <OEChem_OEIsCAlpha>` predicate should be used instead.

* New :oe:func:`OEChem::OEUncolorMol` overload functions have been added to
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>`. A new constant, :oe:const:`OEChem::OEUncolorStrategy::RemoveDimension`,
  has been added that invalidates 3D coordinates and sets the dimension to ``0``
  when uncoloring molecules.

* Support has been added to :oe:func:`OEChem::OEReadMolecule` that enables reading
  both CIF and mmCIF files.

* Updates have been made to the :ref:`the OEFormat namespace <OEChem_OEFormat>` to include
  new CIF and mmCIF formats. Corresponding updates have also been added to
  :oe:constns:`OEChem::OEIFlavor` and :oe:constns:`OEChem::OEOFlavor`.

* Updates have been made to the :oe:constns:`OEChem::OEResidueIndex` namespace to
  include residue IDs for metals observed in PDB files.

* The formal charge assignment for less common metals observed in PDB files has been expanded.

* Updates have been made to the :oe:constns:`OEChem::OEExprType` namespace to allow for more
  fuzzy searches. For example, :oe:constns:`OEChem::OEExprType::ElemMinHCount` or
  :oe:constns:`OEChem::OEExprType::ElemMinDegree` can now be used to specify an atom's minimum
  hydrogen count or minimum degree.

* Changes have been made to the :ref:`OEResidue <OEChem_OEResidue>` class to support the mmCIF format.
  These changes include the following three new string member variables, with the appropriate
  getter and setter functions:

  * ``SequenceID`` captures the mmCIF field, `label_seq_id`, which is the sequential number of
    residues from 1.

  * ``ExtChainID`` captures the fact that the previous chainID in the `auth_asym_id` field can
    now have multiple characters. The :oe:meth:`OEChem::OEResidue::GetChainID` function now
    returns the first character of the ``ExtChainID`` variable, and
    :oe:meth:`OEChem::OEResidue::SetChainID` now overwrites and sets the ``ExtChainID``.

  * ``SubChainID`` captures the `label_asym_id` field, which commonly seems to be a further
    subdividing of the `auth_asym_id` field.

Minor bug fixes
--------------------------------------------------------------------------------

* A bug that caused :oe:const:`OEChem::OEWriteMolReturnCode::Success` to be returned
  even though an invalid output stream was used has been fixed.

* A bug that caused broken perception after implicit hydrogen assignment in the
  :oe:func:`OEChem::OEAssignImplicitHydrogens` and :oe:func:`OEChem::OEAssignMDLHydrogens`
  functions has been fixed.

* Handling of partially resonant nitrogen stereo perception in
  :oe:func:`OEChem::OE3DToAtomStereo` and :oe:func:`OEChem::OE3DToInternalStereo`
  has been improved.

* An issue that caused :ref:`OEIsCTerminalAtom <OEBio_OEIsCTerminalAtom>` to misperceive a minor
  number of C-terminal atoms has been fixed.

* Unpaired interactions are no longer triggered on ligands due to nearby water
  molecules. Similarly, water molecules can no longer present as having unpaired
  interactions.

Python-specific changes
--------------------------------------------------------------------------------

* Support for making custom MCS scoring functions from :ref:`OEMCSFunc <OEChem_OEMCSFunc>`
  has been added.

* New functions, :oe:func:`OESystem::OEGetBytesFromGrid`, :oe:func:`OESystem::OEGetScalarGridFromBytes`,
  and :oe:func:`OESystem::OEGetSkewGridFromBytes`, have been added to support
  the conversion between byte[] and grids (:ref:`OESkewGrid <OESystem_OESkewGrid>` or
  :ref:`OEScalarGrid <OESystem_OEScalarGrid>`).

* :oe:meth:`OEChem::OETrans::Extract` is now available in Python.

Java-specific changes
--------------------------------------------------------------------------------

* New functions, :oe:func:`OESystem::OEGetByteArrayFromScalarGrid`, :oe:func:`OESystem::OEGetByteArrayFromSkewGrid`,
  :oe:func:`OESystem::OEGetScalarGridFromByteArray`, and :oe:func:`OESystem::OEGetSkewGridFromByteArray`,
  have been added to support the conversion between byte[] and grids (:ref:`OESkewGrid <OESystem_OESkewGrid>` or
  :ref:`OEScalarGrid <OESystem_OEScalarGrid>`).

Documentation changes
--------------------------------------------------------------------------------

* Two new examples have been added that demonstrate performing fast substructure
  searches:

  * :ref:`section_example_oechem_makefastss`
  * :ref:`section_example_oechem_searchfastss`

* A new example program, :ref:`section_example_oebio_reshist`, has been added
  that demonstrates printing a histogram of the occurrences of various amino acids
  in a protein.

* The :ref:`section_example_oechem_oecheminfo` example program has been updated
  to demonstrate using the :oe:func:`OEPlatform::OEToolkitsGetRelease` function.

* New code snippets have been added to the :ref:`OEConfRMSD <OEChem_OEConfRMSD>` class
  that demonstrate finding the two conformers of a molecule with the smallest
  RMSD.

* New code snippets have been added to the :oe:func:`OEChem::OEFastaToMol`
  function that demonstrate creating a molecule from a FASTA sequence.

* New code snippets have been added to the section, :ref:`section_molreadwrite_stringinputandoutput`,
  that demonstrate reading and writing molecules from memory buffers.

* New code snippets (in C++ and Python) have been added to the
  :ref:`OEMCSFunc <OEChem_OEMCSFunc>` class that demonstrate using custom scoring functions.

* **OEChem TK** examples have been cleaned up to use the new C++11 style.

OEBio TK 2.3.0
================================================================================

New features
--------------------------------------------------------------------------------

* The following APIs have been added for perceiving non-ideal hydrogen bond
  interactions (i.e., hydrogen bonds with long donor-acceptor distances or
  poor geometries):

   * A new functor, :ref:`OEIsNonIdealHBondInteractionHint <OEBio_OEIsNonIdealHBondInteractionHint>`, has been added
     that easily identifies non-ideal hydrogen bonds.
   * New interaction types, :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandAccepts`
     and :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandDonates`, have been added.
   * The following methods have been added that customize the non-ideal hydrogen
     bond perceptions:

      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealDonorAngle`
        and :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealDonorAngle`

      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealAcceptorAngle`
        and :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealAcceptorAngle`

      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealHBondDistance`
        and :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealHBondDistance`

* A new functor, :ref:`OEIsHetAtom <OEBio_OEIsHetAtom>`, has been added that identifies atoms with the
  `hetero atom` property in an :oe:cls:`OEResidues<OEChem::OEResidue>` object.

* A new functor, :ref:`OEIsDisulfideBond <OEBio_OEIsDisulfideBond>`, has been added that identifies disulfide
  bonds.

* A new function, :oe:func:`OEBio::OECalculateDPI`, has been added that calculates the
  diffraction-component precision index (DPI) value.

* New categories, :oe:const:`OEBio::OEResidueDatabaseCategory::Lipid`
  and :oe:const:`OEBio::OEMolComplexFilterCategory::Lipid`, have been
  introduced that enable splitting lipids from a system.

* A new method, :oe:meth:`OEBio::OEInteractionHintContainer::DeleteInteractions`, has been added that
  removes all interactions.

* The functional group perception in :oe:func:`OEBio::OEPlaceHydrogens` has been improved.

Minor bug fixes
--------------------------------------------------------------------------------

* Perception of hydrogen bonds involving sulfur and anions in
  :oe:func:`OEBio::OEPerceiveInteractionHints` has been improved.

* The precedence of :ref:`OEInteractionHint <OEBio_OEInteractionHint>` perception has been improved.
  Chelation interactions now take precedence over charge-charge interactions.

* A check has been added to the :oe:func:`OEBio::OEPlaceHydrogens` function that
  causes it to exit early if two heavy atoms are within 0.5A of each other, since
  this is considered to be bad input and causes unspecified behavior.

OESystem TK 2.3.0
================================================================================

New features
--------------------------------------------------------------------------------

* The performance of :oe:func:`OESystem::OEGetDataType`, especially on
  Windows, has been improved. :oe:func:`OESystem::OEGetDataType` is now at
  least 500X faster when used with a single thread and about 2X faster with
  many simultaneous threads on Windows.

* A new method, :oe:meth:`OESystem::OEBitVector::CountRangeBits`, has been added that identifies the
  number of bits that are set to ``1`` in the given bit range.

* A new class, :ref:`OEConsoleProgressTracer <OESystem_OEConsoleProgressTracer>`, has been added that tracks
  the current progress of a task.

* A new function, :oe:func:`OESystem::OEStringEquals`, has been added that determines
  whether two strings are equivalent using a case-insensitive comparison.

* A new function, :oe:func:`OEMath::OEGeom3DReflectCoord`, has been added that
  reflects coordinates around a plane for a hydrogen atom.

* A new function, :oe:func:`OESystem::OEBitIsPowerOf2`, has been added that
  determines if a bitmask is a power of 2.

OEPlatform TK 2.3.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new :oe:func:`OEPlatform::OEToolkitsGetRelease` function has been added that
  displays the release name of the overall toolkit version being used.

OEGrid TK 1.6.4
================================================================================

* Minor internal improvements have been made.



********************************************************************************
Version 3.0.0.6
********************************************************************************

.. _section_oechem_releasenotes_3006:

OEChem TK 3.0.0.6
================================================================================

* A memory leak while reading string generic data in Python has been fixed.

OESystem TK 3.0.0.6
================================================================================

* When reading and writing large :ref:`OERecord <OEDataFlow_OERecord>`, sometimes memory
  usage would spike briefly due to temporary copies of data. The memory usage has been 
  optimized to reduce these spikes.

********************************************************************************
Version 3.0.0.5
********************************************************************************

.. _section_oechem_releasenotes_3005:

OEChem TK 3.0.0.5
================================================================================

* Added the ability to perceive chirality without including nitrogen atoms that could undergo nitrogen inversion.
  See :oe:func:`OEChem::OEPerceiveChiral` for details.

* Added a method to clear chiral perception before calling the perception function with a different flag.
  See :oe:func:`OEChem::OEClearChiralPerception` for details.

* The performance of converting large proteins to the JSON format has been improved.

OESystem TK 3.0.0.5
================================================================================

* Fixed an issue which allowed OERange objects to be created with a low value greater than the high value.

* The ``readonly`` flag on molecule fields was not being enforced properly in the Python API.
  Attempting to use a read-only field to set a molecule on an OERecord now raises an exception.

* Uninitialized OERange values stored on records were turning into None values on retrieval via the Python API.
  This has been fixed.

* In the Python API, the OERecord.get_fields method would return None values for fields whose types had not been imported.
  This has been fixed.

* Values of NaN and Infinity were causing errors when they appeared in JSON objects being read by any toolkit.
  This has been fixed.

OEGrid TK 3.0.0.5
================================================================================

* An issue causing some MTZ files to be read with the wrong space group has been fixed.

********************************************************************************
Version 3.0.0
********************************************************************************

.. _section_oechem_releasenotes_300:

OEChem TK 3.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new set of Preliminary API classes has been added as part of the extended
  set of :ref:`OEParameter <OESystem_OEParameter>` and :ref:`OEOptions <OESystem_OEOptions>` classes:

  * :ref:`OEMolParameter <OEChem_OEMolParameter>`
  * :ref:`OEMolReaderParameter <OEChem_OEMolReaderParameter>`
  * :ref:`OEMolWriterParameter <OEChem_OEMolWriterParameter>`
  * :ref:`OEPredicateParameter <OEChem_OEPredicateParameter>`
  * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>`

* A new functor, :ref:`OEIsTermHeavyAtom <OEChem_OEIsTermHeavyAtom>`, has been added that identifies terminal
  heavy atoms.

* A new function, :oe:func:`OEChem::OEOverlayConfsByRMSD`, has been added that overlays all
  conformers of an :ref:`OEMCMolBase <OEChem_OEMCMolBase>` molecule on the first conformer
  to minimize RMSD.

* The molecule database implementation of :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>`
  now loads scenes into memory using multiple threads.

Minor bug fixes
--------------------------------------------------------------------------------

* The full molecule-based multi-conformer :oe:func:`OEChem::OERMSD` calculation
  now returns ``false`` when the automorphism flag is set to ``true`` and no match can
  be identified between the reference target molecule (i.e., when no RMSD value can be
  calculated).

* An issue with using deleted atom pointers as templates for creating
  or recreating new atoms based on the deleted atom template has been fixed.  Previously, the newly
  created atom instance would be marked as a deleted atom.

* An issue that caused molecule SMILES string generation to erroneously output reaction information
  if :oe:constns:`OEChem::OERxnRole` information was present on atoms has been fixed.  Reaction
  information should only be added to the SMILES output if :oe:meth:`OEChem::OEMolBase::IsRxn` is ``true``.

* :oe:const:`OEChem::OERxnRole::Agent` and :oe:const:`OEChem::OERxnRole::Catalyst`
  enums have long had the same value, making them indistinguishable if applied to reaction atoms.
  The enum values have been changed to make them unique.  Formats (e.g., OEB) that support importing and exporting this information can now distinguish and retain this information.

* Some of the extraneous warnings about planar stereocenter geometry have been
  reduced via more rigorous checking of the stereocenter environment during structure file reading.

OEBio TK 3.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* The following new methods have been added to the :ref:`OEInteractionHint <OEBio_OEInteractionHint>`
  class to access the calculated geometries of the interactions by the
  :oe:func:`OEBio::OEPerceiveInteractionHints` function:

  * :oe:meth:`OEBio::OEInteractionHint::HasCalculatedGeometry`
  * :oe:meth:`OEBio::OEInteractionHint::GetCalculatedGeometry`
  * :oe:meth:`OEBio::OEInteractionHint::GetCalculatedGeometries`

* A new function, :oe:func:`OEBio::OETransformDesignUnit`, has been added to
  transform :ref:`OEDesignUnit <OEBio_OEDesignUnit>` objects.

OESystem TK 3.0.0
================================================================================

New features
--------------------------------------------------------------------------------
* A set of preliminary APIs for **OERecord** and its associated classes has been added to
  **OEChem TK**. **OERecord** is a data container for storing and transmitting
  strongly typed data and its associated metadata.
  The API set includes the following classes and functions:

  * :ref:`OERecord <OEDataFlow_OERecord>`
  * :ref:`OEField <OEDataFlow_OEField>`
  * :ref:`OEFieldBase <OEDataFlow_OEFieldBase>`
  * :ref:`OEFieldMeta <OEDataFlow_OEFieldMeta>`
  * :ref:`OERange <OEDataFlow_OERange>`
  * :ref:`OEWriteRecord <OEDataFlow_OEWriteRecord>`
  * :ref:`OEReadRecord <OEDataFlow_OEReadRecord>`
  * :ref:`OERecordToBytes <OEDataFlow_OERecordToBytes>`
  * :ref:`OERecordFromBytes <OEDataFlow_OERecordFromBytes>`

* A new set of preliminary APIs has been added to combine the concepts of
  :ref:`OEParameter <OESystem_OEParameter>` with :ref:`OEOptions <OESystem_OEOptions>`.  These new APIs
  provide an interface for configuring :ref:`OEOptions <OESystem_OEOptions>` directly from the command
  line, making it easier to write command line applications.
  The new API set includes the following:

  * :ref:`OEBoolParameter <OESystem_OEBoolParameter>`
  * :ref:`OEConstParameter <OESystem_OEConstParameter>`
  * :ref:`OEDoubleParameter <OESystem_OEDoubleParameter>`
  * :ref:`OEFloatParameter <OESystem_OEFloatParameter>`
  * :ref:`OEIntParameter <OESystem_OEIntParameter>`
  * :ref:`OEMultiParameter <OESystem_OEMultiParameter>`
  * :ref:`OEPODParameter <OESystem_OEPODParameter>`
  * :ref:`OEPointerParameter <OESystem_OEPointerParameter>`
  * :ref:`OEStringParameter <OESystem_OEStringParameter>`
  * :ref:`OEUIntParameter <OESystem_OEUIntParameter>`
  * :ref:`OEOptions <OESystem_OEOptions>`
  * :oe:func:`OESystem::OEConfigureItf`
  * :oe:func:`OESystem::OEConfigureOpts`
  * :oe:func:`OESystem::OEUpdateOpts`

* A new overload for :oe:meth:`OESystem::OEDots::Update` has been added that takes a
  character as an argument to display in lieu of ``.``.

OEPlatform TK 3.0.0
================================================================================

* Minor internal improvements have been made.

OEGrid TK 3.0.0
================================================================================

* Minor internal improvements have been made.



********************************************************************************
Version 3.1.0.2
********************************************************************************

.. _section_oechem_releasenotes_3102:

OEChem TK 3.1.0.2
================================================================================

*March 2021*

* Additional metadata constants were added to
  the :ref:`OEMetadata <OEDataFlow_OEMetadata>`
  namespace for
  controlling the visibility of fields in the Orion user interface.

.. _section_oebio_releasenotes_3102:

OEBio TK 3.1.0.2
================================================================================

* The :oe:meth:`OEBio::OEReceptorCustomConstraints::GetConstraintFeatures` method is now
  properly wrapped in python.

* The :ref:`GetCustomConstraints <OEBio_OEReceptor_GetCustomConstraints>` now returns a const or
  non const ref instead of a copy

* The :oe:meth:`OEBio::OEReceptor::GetProteinConstraints` can now also return
  a non-const iterator

********************************************************************************
Version 3.1.0
********************************************************************************

OEChem TK 3.1.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* A new function, :oe:func:`OEChem::OEGetHydrogenCounts`, has been added that provides
  implicit and explicit hydrogen counts in a molecule.

* A new function, :oe:func:`OEChem::OEApplyStateFromRef`, has been added that provides the ability
  to apply a certain state to a molecule. This could be used to apply tautomers to a molecule in 3D
  or to fix broken valence states using a known state.

* A new function, :oe:func:`OEChem::OERGroupsToHydrogens`, has been added that converts R-groups
  of a molecule to hydrogen atoms.

* A new preliminary namespace, :oe:constns:`OEChem::OEFileStringType`, has been defined that allows controlling
  file types in :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` and :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>`.

* Two new preliminary classes, :ref:`OEFileStringParameter <OEChem_OEFileStringParameter>` and :ref:`OEOutFileStringParameter <OEChem_OEOutFileStringParameter>`,
  have been added to allow better control over file types that can be used in :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>`
  and :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>`.

* The constructor of the preliminary class :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` has been
  modified to take constants defined in :oe:constns:`OEChem::OEFileStringType` to better control
  the desired input/output file types.

* A new preliminary class, :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>`, has been added to
  enable creating an interface to applications and scripts that require a second input,
  such as a reference or target system.

* A new method, :oe:meth:`OEBio::OEResidueCategoryData::AllInDB`, has been added that determines
  if all the specified residue names found in the list are associated with the specified category.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue that occurred when a change in the aromaticity model perception would result in double bonds that should
  have lost their cis/trans parity assignments has been fixed. The bond stereo parities had been incorrectly being
  retained on aromatic atom endpoints.

* An issue with parsing SMILES with ExtBond couplings that were not honoring the convention that a specified bond
  order takes precedence over an implicit one, similar to ring closures, has been fixed.

* Extra processing has been added to ensure that a common header corruption for SDF format files throws a warning to
  indicate a format problem. In general, attempts to skip individual corrupted records in a multi-record file format
  are employed to ensure that as much of the valid input as possible can be processed. Depending on the type of corruption
  as well as the specific file format, there is no guarantee that a warning will be emitted for all corrupted records.

* An issue that caused :oe:func:`OEChem::OECopyPDBData` and :oe:func:`OEChem::OECopySDData` to avoid the copy activity if the
  source and destination molecules are the same molecule instance, which can cause a crash, has been fixed.  The status return will be false,
  just like a general failure for the copy activity.

* An issue in :oe:func:`OEChem::OEPDBOrderAtoms` that caused bad behavior when
  atoms in a molecule do not have any residue information has been fixed.

OEBio TK 3.1.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* Two new methods, :oe:meth:`OEBio::OEDesignUnit::HasTransform` and
  :oe:meth:`OEBio::OEDesignUnit::GetTransform`, have been added
  that check whether a valid ``OETrans`` object is stored on the ``OEDesignUnit`` and retrieve it
  for use with :oe:func:`OEBio::OETransformDesignUnit`.

* A new method, :oe:meth:`OEBio::OEMolComplexCategorizer::GetResidueCategoryData`, has been added that returns
  the non-const reference to the :ref:`OEResidueCategoryData <OEBio_OEResidueCategoryData>` stored in the
  :ref:`OEMolComplexCategorizer <OEBio_OEMolComplexCategorizer>` class.

* A new class, :ref:`OEReceptor <OEBio_OEReceptor>`, has been added that represents a
  receptor as used in **OEDocking TK**.

* A new class, :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>`, has been added
  that represents a constraint feature for an :ref:`OEReceptor <OEBio_OEReceptor>`.

* A new class, :ref:`OEReceptorProteinConstraint <OEBio_OEReceptorProteinConstraint>`, has been added
  that represents a protein constraint for an :ref:`OEReceptor <OEBio_OEReceptor>`.

* A new preliminary namespace, :oe:constns:`OEBio::OEProteinConstraintType`, has been added
  that defines the valid types for :ref:`OEReceptorProteinConstraint <OEBio_OEReceptorProteinConstraint>`.

* A new class, :ref:`OEReceptorCustomConstraints <OEBio_OEReceptorCustomConstraints>`, has been added
  that represents custom constraints for an :ref:`OEReceptor <OEBio_OEReceptor>`.

* Two new methods, :oe:meth:`OEBio::OEDesignUnit::HasReceptor` and
  :oe:meth:`OEBio::OEDesignUnit::GetReceptor`, have been added
  that check whether a valid :ref:`OEReceptor <OEBio_OEReceptor>` object is stored on the OEDesignUnit
  and retrieve it.

* Several new constants have been added to the namespace :oe:const:`OEBio::OEDesignUnitComponents`,
  related to downstream usage, such as :ref:`OEMakeReceptor <OEDocking_OEMakeReceptor>`.

Major bug fixes
--------------------------------------------------------------------------------

* A bug that caused OEDesignUnits with the Iridium Category :oe:constns:`OEBio::OEIridiumCategory::NA`
  to be assigned :oe:constns:`OEBio::OEIridiumCategory::NT` when read from a file has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* A bug in :oe:func:`OEBio::OEPlaceHydrogens` that resulted in histidine residues being in an unoptimized state,
  depending on the input state, has been fixed.

OESystem TK 3.1.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* A new method, :oe:meth:`OESystem::OEOptions::AddOption`, has been added that allows adding a sub-option
  to an existing :ref:`OEOptions <OESystem_OEOptions>`.

Minor bug fixes
--------------------------------------------------------------------------------

* Behavior of the field metadata on :ref:`OERecord <OEDataFlow_OERecord>` has been fixed to
  ensure that at most one field on a record can have the `ID` flag.

* An issue that caused corruption when reusing an :ref:`OERecord <OEDataFlow_OERecord>` in a loop has been fixed.

OEPlatform TK 3.1.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* :ref:`OEOnce <OEPlatform_OEOnce>` has been deprecated. See the **OEPlatform TK**
  documentation for alternatives.

OEGrid TK 3.1.0
================================================================================

*Fall 2020*

Major bug fixes
--------------------------------------------------------------------------------

* A bug in the symmetry operators for the I121 space group has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue that caused the function :oe:func:`OESystem::OEReadGrid` to incorrectly change the
  :oe:constns:`OESystem::OEGridType` of grids to the :oe:constns:`OESystem::OEGridFileType`,
  where it was being used to read ``OESystem::OEFizzGrid`` from a file, has been fixed.
  The :oe:constns:`OESystem::OEGridType` now remains the same through a round trip grid write and read.

* An issue that caused the function :oe:func:`OESystem::OEReadMTZ` to crash when it read large MTZ files
  and converted them to an :ref:`OESkewGrid <OESystem_OESkewGrid>` as well as computing the AMIN and AMAX statistics
  for the resulting :ref:`OESkewGrid <OESystem_OESkewGrid>` incorrectly has been fixed.
  The code has been corrected so that the crash no longer happens for large grids;
  the AMIN and AMAX calculations have also been corrected.

* An issue that caused the script :ref:`make_design_units.py<spruce_examples_make_design_units>` to crash when reading PDB files using
  the function :oe:func:`OEReadMolecule<OEChem::OEReadMolecule>`, when space group numbers that could not be
  recognized has been fixed. These space group numbers had been preventing the code from reading symmetry correctly
  from the PDB file. The code has been changed so that incorrect space group numbers result in a warning instead of a fatal crash.

OEMath TK 3.1.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* Two new , :ref:`OEBox <OEMath_OEBox>` and :ref:`OESphere <OEMath_OESphere>`, have
  been added that represent a box and a sphere, respectively.

* The following functions have been added as access functions to the new
  :ref:`OEBox <OEMath_OEBox>` class:

  * :oe:func:`OEMath::OEBoxArea`
  * :oe:func:`OEMath::OEBoxExtend`
  * :oe:func:`OEMath::OEBoxTranslate`
  * :oe:func:`OEMath::OEBoxVolume`
  * :oe:func:`OEMath::OEBoxXDim`
  * :oe:func:`OEMath::OEBoxXMid`
  * :oe:func:`OEMath::OEBoxYDim`
  * :oe:func:`OEMath::OEBoxYMid`
  * :oe:func:`OEMath::OEBoxZDim`
  * :oe:func:`OEMath::OEBoxZMid`
  * :oe:func:`OEMath::OEInBox`
  * :oe:func:`OEMath::OESetupBox`

* The following functions have been added as access functions to the new
  :ref:`OESphere <OEMath_OESphere>` class:

  * :oe:func:`OEMath::OEInSphere`
  * :oe:func:`OEMath::OESphereArea`
  * :oe:func:`OEMath::OESphereVolume`


OEChem TK 3.1.1
================================================================================

*July 2021*

New features
--------------------------------------------------------------------------------

* OEZ has been made the default file format for storing molecules in :ref:`OERecord <OEDataFlow_OERecord>` objects.

* Two new functions, :oe:func:`OEChem::OECalcPMI` and :oe:func:`OEChem::OEGetRadiusOfGyration`, have been added. The
  first calculates the principal moment of inertia (PMI) for a molecule, and the second calculates the radius of gyration for
  that molecule using a previously calculated PMI.

* :term:`InChI` has been updated to ``v1.06``.  A new option to :ref:`OEInChIOptions <OEChem_OEInChIOptions>` supports generation of nonstandard
  :term:`InChI` strings with pseudoatoms present.

* Atom/bond SMARTS expressions can now be used as generic data for SMARTS queries.

* The function :oe:func:`OEChem::OEApplyStateFromRef` now transfers stereo/chiral information from the reference state molecule.

Major bug fixes
--------------------------------------------------------------------------------

* The function :oe:func:`OEChem::OEPerceiveResidues` has been enhanced to properly recognize
  ACE (acetyl) and NME (N-methyl) capping groups,
  which used to cause unexpected behaviors.
  Recognition of the NHE and FOR capping groups has also been improved.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue that caused a crash in the :oe:func:`OEChem::OEPDBOrderAtoms` function when
  running with preserveResOrder=True and molecules that do not have chain IDs has been fixed.

* An issue that caused :oe:func:`OEChem::OEApplyStateFromRef` to return redundant matches
  when doing partial matching with long hydrocarbon chains has been fixed.

* An issue that caused :oe:func:`OEChem::OEDetermineConnectivity` to break all bonds
  between atoms with wrong valences (possibly resulting in a
  broken backbone) has been fixed. It now tries to break the bonds between
  non-adjacent residues first and, if the valences of involved atoms are still wrong, all bonds.

Documentation changes
---------------------------------------------------------------------------------

* Added documentation for the functions :oe:func:`OEChem::OEGetSoleNeighbor`, :oe:func:`OEChem::OEGetSoleBond`,
  :oe:func:`OEChem::OEGetSoleDoubleBond`, and :oe:func:`OEChem::OEGetSoleSingleBond`.

OEBio TK 3.1.1
================================================================================

New features
--------------------------------------------------------------------------------

* Two new constructors have been added to the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class.
  These constructors are intended to be used with prepared molecules. The two APIs are for liganded or apo-structures, where in the latter case
  site-residues indicating the binding site are required.

* Predicate versions of :oe:func:`OEBio::OEIsStandardProteinResidue` and
  :oe:func:`OEBio::OEIsStandardNucleicAcidResidue` have
  been added as :ref:`OEIsStandardAminoAcid <OEBio_OEIsStandardAminoAcid>` and :ref:`OEIsStandardNucleicAcid <OEBio_OEIsStandardNucleicAcid>`, respectively.

* The :ref:`OEReceptor <OEBio_OEReceptor>` class now stores a predicate that can be used to subset an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class component.  For example,
  a specific water molecule in the solvent component that should be used when generating the receptor grid and during docking.

* The function :oe:func:`OEBio::OESubsetDesignUnit` and the method :oe:meth:`OEBio::OEDesignUnit::GetComponents` now take a predicate
  that will subset the component(s) they hit in the design unit.

* The functions :oe:func:`OEBio::OESubsetDesignUnit` and :oe:func:`OEBio::OEUpdateDesignUnit`
  will now clear the stored OEReceptor
  if the targetMask and targetPredicate of the receptor match the content being updated or subsetted away.

* Non-const methods for :ref:`GetCustomConstraints <OEBio_OEReceptor_GetCustomConstraints>`,
  :oe:meth:`OEBio::OEReceptor::GetProteinConstraints`, and
  :ref:`GetConstraintFeatures <OEBio_GetConstraintFeatures>` have been
  added giving access to edit constraint features.

Minor bug fixes
--------------------------------------------------------------------------------

* Nitriles (C#N) are now recognized as hydrogen bond acceptors in interaction hint perception.

* Hydrogen bonds to moeities that are also interacting as saltbridges are now properly perceived.

* Amide NH atoms are now properly counted as as UnpairedLigandDonor when appropriate.

* The default for :oe:meth:`OEBio::GetMaxCationPiAngle<OEBio::OEPerceiveInteractionOptions::GetMaxCationPiAngle>` was reduced to from 50 to 40 degrees.

* The default for :oe:meth:`OEBio::SetMaxNonIdealAcceptorAngle<OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealAcceptorAngle>` was increased from 70 to 90 degrees.

* The default for :oe:meth:`OEBio::GetMaxNonIdealDonorAngle<OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealDonorAngle>` was increased from 50 to 70 degrees.

* Several intra molecular interaction types are now properly perceived with
  :oe:func:`OEBio::OEPerceiveInteractionHints`

OESystem TK 3.1.1
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* An issue that caused the string format method on the :ref:`OEFieldType <OEDataflow_OEFieldType>` for
  ``double`` to be converted to ``int`` has been fixed.  The format method
  now writes with a precision of 12.

* An issue that caused the string format method on the :ref:`OEFieldType <OEDataflow_OEFieldType>`  for
  ``double`` to add a .0 after a ``NaN`` has been fixed.

* An issue that caused the string format method on the :ref:`OEFieldType <OEDataflow_OEFieldType>`  for
  ``string`` and ``JSON`` to be elided if longer than 100 characters has been fixed.

* An issue with metadata flags not getting properly updated when a field with new metadata
  was set on an existing field has been fixed.

OEPlatform TK 3.1.1
================================================================================

New features
--------------------------------------------------------------------------------

* `ZSTD <https://facebook.github.io/zstd/>`_ has been updated to version 1.4.9, resulting in improvements in compression
  and decompression performance for the OEZ file format.

OEGrid TK 3.1.1
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* :ref:`OEScalarGrid <OESystem_OEScalarGrid>` now preserves
  :oe:constns:`OESystem::OEGridType` through I/O.

OEMath TK 3.1.1
================================================================================

Minor internal improvements have been made.





OEChem TK 3.2.0
================================================================================

*Fall 2021*

New features
--------------------------------------------------------------------------------

* A new options class, :ref:`OEUniMolecularRxnOptions <OEChem_OEUniMolecularRxnOptions>`,
  has been added to provide control arguments to the unimolecular reaction APIs
  :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` and :oe:func:`OEChem::OEGetUniMolecularRxnIter`.
  The new options class adds support for enabling valence correction, as well as
  retrieval of altered atom information from the transform for post-processing
  of the transformed products.

* Small molecule crystal structures are now writeable as ``CIF`` files,
  see :oe:func:`OEChem::OEWriteCIFFile` for details.

* Macromolecule files are now writeable as ``MMCIF`` files,
  see :oe:func:`OEChem::OEWriteCIFFile` for details.

* ``CIF`` and ``MMCIF`` files are now readable using :ref:`oemolithread <OEChem_oemolithread>`. This enables
  their use as :ref:`OEMolDatabase <OEChem_OEMolDatabase>` as well.

* The gemmi library used to read and parse ``MMCIF`` files has been updated to version 0.4.8.

* New overloads of constructors for the :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>`
  and :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>` have been added to extend their
  abilities to be used when no sub-options are involved for an application or when
  custom file extensions are required.

* New overloads of constructors for the :ref:`OEFileStringParameter <OEChem_OEFileStringParameter>`
  and :ref:`OEOutFileStringParameter <OEChem_OEOutFileStringParameter>` have been added that accepts
  file extensions as arguments instead of predefined constants.

Major bug fixes
--------------------------------------------------------------------------------

* An issue causing missing amide (peptide) bonds when reading protein structures from
  ``MMCIF`` files has been fixed.

* An issue related to incorrect hydrogen atom stripping from stereocenters
  that are asymmetric by virtue of hydrogen isotope substitutions has been fixed. 
  Isomeric ``SMILES`` for structures containing hydrogen isotopes on stereogenic centers will now have
  the atom/bond parity information correctly preserved. A minor consequence
  of the fix is that a small number of isomeric ``SMILES`` with explicit (non-isotopic) hydrogens
  may have ``SMILES`` differences due to conversion to a fully hydrogen-suppressed ``SMILES`` form.

Minor bug fixes
--------------------------------------------------------------------------------
* An issue that could cause a crash during reads of :oe:const:`OEChem::OEFormat::OEB`
  format files has been fixed.  The read and write of :ref:`OEGroupBase <OEChem_OEGroupBase>` information in ``OEB``
  files is now more rigorously checked for invalid objects.  Existing corrupted ``OEB`` files will return
  an error status when read.

* An issue that could cause overflow in the MDL molecule reader has been fixed.

* An issue that caused return of an incorrect default value for
  :ref:`OEPredicateParameter <OEChem_OEPredicateParameter>` when it was set to
  a non-default value has been fixed.

OEBio TK 3.2.0
================================================================================

New features
--------------------------------------------------------------------------------

* The logic identifying aromatic nitrogen atoms has been updated in
  :oe:func:`OEBio::OEPlaceHydrogens`, enabling improved hydrogen network 
  optimization as well as the ability to properly distinguish and pick 
  appropriate ligand tautomers in the protein binding site.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue causing the ligand density coverage (LaD) to change as a result of 
  hydrogen placement in limited circumstances has been fixed.

* An issue causing the operator bool on :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>` to
  return true even if no valid data was provided to the constructor has been
  fixed.

* An issue causing an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` attached as generic data on
  molecules to be lost during I/O has been fixed.

* An issue causing proper backbone verification to fail for capping groups 
  has been fixed.

* An issue causing proper backbone verification to fail for nonstandard amino
  acids has been fixed.

* An issue causing histidine residues to be in the charged state (HIS+ or HIP) 
  when it clearly was not favorable has been fixed.

* The AspDyad mover rule in :oe:func:`OEBio::OEPlaceHydrogens` has been refined.

* The class :ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>` has been modified to derive
  from :ref:`OEOptions <OESystem_OEOptions>`.

OESystem TK 3.2.0
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OEParameter <OESystem_OEParameter>` classes that accept strings as
  input values now work with case-insensitive string inputs. 

* A new overload of :oe:meth:`OESystem::OEMultiParameter::SetValue`
  has been added that accepts :ref:`oeifstream <OEPlatform_oeifstream>` as input.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue that could cause :oe:func:`OESystem::OEStringToNumber` to crash has been fixed.

OEPlatform TK 3.2.0
================================================================================

* Minor internal improvements have been made.

OEGrid TK 3.2.0
================================================================================

* Minor internal improvements have been made.

OEMath TK 3.2.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new preliminary API class, :ref:`OEKernelPLS <OEMath_OEKernelPLS>`,
  has been added that builds QSAR models from kernelized descriptors using
  partial least squares (PLS).





OEChem TK 3.3.0
================================================================================
*Spring 2022*

New features
--------------------------------------------------------------------------------

* Support for :term:`CXSMILES` has been added as a new molecule I/O format, :oe:const:`OEChem::OEFormat::CXSMILES`.

* A new option flag, :oe:const:`OEChem::OESMILESFlag::EnhStereo` has been added to the :oe:constns:`OEChem::OESMILESFlag` flags
  for controlling the output of :term:`CXSMILES` enhanced stereo information.

* New methods were added to the :ref:`OEParseSmilesOptions <OEChem_OEParseSmilesOptions>` class to control
  the consideration of :term:`CXSMILES` appendices during the parse. See, :oe:meth:`GetCXSMILES<OEChem::OEParseSmilesOptions::GetCXSMILES>` and
  :oe:meth:`SetCXSMILES<OEChem::OEParseSmilesOptions::SetCXSMILES>`.

* New methods were added to the :ref:`OEInChIOptions <OEChem_OEInChIOptions>` class to control the ``SUU`` option
  during :term:`InChI` generation.  This will necessarily generate nonstandard InChIs when enabled.
  See, :oe:meth:`GetUndefinedStereo<OEChem::OEInChIOptions::GetUndefinedStereo>` and
  :oe:meth:`SetUndefinedStereo<OEChem::OEInChIOptions::SetUndefinedStereo>`.

* New flavor flags were added to :oe:cls:`OEFileStringParameter<OEChem::OEFileStringParameter>`
  and :oe:cls:`OEOutFileStringParameter<OEChem::OEOutFileStringParameter>` to support file type selections.
  See the :oe:constns:`OEChem::OEFileStringTypeFlavor` namespace.

* Overloads for :oe:func:`OEChem::OECalcPMI` and :oe:func:`OEChem::OEGetRadiusOfGyration` were added that accept
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>` and :oe:func:`OEChem::OEConfBase` objects.

Minor bug fixes
--------------------------------------------------------------------------------

* A minor bug related to uninitialized memory in :oe:func:`OEChem::OECalcPMI` was fixed.

* An issue disallowing the use of multiple options for :oe:constns:`OEChem::OEIFlavor` support with SDF, RDF, MDL formats has been fixed.

* An issue affecting copy activities of :ref:`OEGroupBase <OEChem_OEGroupBase>` objects during conformer copy activities has been fixed.

* The :oe:meth:`OEMolParameter::GetHasValue<OESystem::OEParameter::GetHasValue>` method now returns ``false``
  for a non-zero input argument, as appropriate.

OEBio TK 3.3.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* An issue with the assignment operator for :ref:`OEDesignUnit <OEBio_OEDesignUnit>` has been fixed.

* An issue with automated titles for :ref:`OEDesignUnit <OEBio_OEDesignUnit>` has been fixed.

* An issue with the default style on generated :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
  related to built residues has been fixed.

* The algorithm for :ref:`OEDesignUnit <OEBio_OEDesignUnit>` creating has been improved to better detect unnatural amino acids.

OESystem TK 3.3.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new method, :oe:meth:`AddParameterPrefix<OESystem::OEOptions::AddParameterPrefix>`, has been added
  for adding a prefix to all the command line parameter's names.

* a new method, :oe:meth:`OEConstParameter::GetPrettyLegalValues<OESystem::OEParameter::GetPrettyLegalValues>`,
  has been added to get the list of the named legal values.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue causing list parameters to be not updated properly in :oe:meth:`OEOptions::UpdateValues<OESystem::OEOptions::UpdateValues>` has been fixed.

OEPlatform TK 3.3.0
================================================================================

General notices
--------------------------------------------------------------------------------

* The ZSTD dependency has been updated to version 1.5.2, which should positively
  effect the :oe:const:`OEChem::OEFormat::OEZ` format type in both compression level
  and encoding and decoding performance.

* The ZLIB dependency has been updated to version 1.2.12 with latest security 
  improvements.

OEGrid TK 3.3.0
================================================================================

New features
--------------------------------------------------------------------------------

* The `mrc` file format is now recongized as a CPP4 grid file
  type in :oe:constns:`OESystem::OEGridFileType`.




OEChem TK 3.3.1
================================================================================

New features
--------------------------------------------------------------------------------
* New preliminary API class, :ref:`OEMCSFuncParameter <OEChem_OEMCSFuncParameter>`, 
  has been added to provide functionality for using :ref:`OEMCSFunc <OEChem_OEMCSFunc>` 
  as a parameter in :ref:`OEOptions <OESystem_OEOptions>`.

Major bug fixes
--------------------------------------------------------------------------------
* An uninitialized memory issue that could impact the output of
  correct :term:`InChI` identifiers based on prior identifier generations has been fixed.

* An issue that inadvertently collected enantiomers as equivalent conformers when :ref:`OEOmegaConfTest <OEChem_OEOmegaConfTest>` conformer tests are in use has been fixed.
  The behavior of prior releases has been restored for these conformer tests, which results in
  enantiomers being considered as separate conformers.

* An issue where the :oe:func:`OEChem::OEFastaToMol` the C-terminal residue contained an aldehyde
  instead of a carboxylic acid has been fixed. 

Minor bug fixes
--------------------------------------------------------------------------------
* The ability to modify isotopic information as part of
  transformation activity for :oe:cls:`OEChem::OEUniMolecularRxn`,
  :oe:func:`OEChem::OEGetUniMolecularRxnIter` and :oe:cls:`OEChem::OELibraryGen` has been added.

OEBio TK 3.3.1
================================================================================

New features
--------------------------------------------------------------------------------
* The residue code dictionary used for :oe:func:`OEBio::OESplitMolComplex` has been updated with new 
  lipid codes.

Minor bug fixes
--------------------------------------------------------------------------------
* An issue with :oe:cls:`OEBio::OEDesignUnit` where the atom
  order of the stored molecules in the design unit was not properly updated
  when components were updated has been fixed.

OESystem TK 3.3.1
================================================================================

New features
--------------------------------------------------------------------------------

* A new record metadata hint for CXSMILES was introduced in ::ref:`OEMetadata <OEDataFlow_OEMetadata>`.

Major bug fixes
--------------------------------------------------------------------------------

* A bug was fixed for the :ref:`XPLOR <OESystem_OEGridFileType_XPLOR>` grid file format reader.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue in :oe:func:`OEDataFlow::OEReadRecord` that could cause the reader to go into
  an infinite loop when given a corrupted/truncated oedb file has been fixed.

OEPlatform TK 3.3.1
================================================================================

Minor internal improvements have been made.





OEChem TK 3.4.0
================================================================================

New features
--------------------------------------------------------------------------------
*   New preliminary APIs have been added for generating SMARTS patterns
    for atoms and bonds that can then be used to construct a molecule SMARTS query:

    * :oe:func:`OEChem::OECreateAtomSmartsString`
    * :oe:func:`OEChem::OECreateBondSmartsString`
    * :oe:func:`OEChem::OECreateSmartsString`

* A new overload of the :oe:func:`OEChem::OECopyMol` has been
  added that takes :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` as an argument.

* An issue has been fixed where the input flavor
  :oe:const:`OEChem::OEIFlavor::MMCIF::ALTLOC` for retaining alternate locations
  when reading an MMCIF file was not being accepted as a proper constant.

Minor bug fixes
--------------------------------------------------------------------------------
* Reaction mapping semantics for SMARTS queries which
  force the query mapping to the respective reactants or products in the target have been activated.
  Previously, reaction SMIRKS queries would hit either reactants or products regardless
  of the presence of the ``>>``.  To restore the old behavior, remove the ``>>``
  from query patterns.

* An issue with the :oe:cls:`OEIsTermHeavyAtom<OEChem::OEIsTermHeavyAtom>`
  predicate, which did not properly account for atom type and implicit or explicit hydrogen environments
  of the interrogated atom, has been fixed.

* An issue in which the status of double ether
  bonds was not maintained when exported in V3000 format has been fixed.

* An issue in which the nondefault output flavor
  flags could not be used with the :oe:const:`OEChem::OEFormat::CXSMILES` format has been fixed.

* An issue with buffer overrun for V2000 SDF parsing that
  could result in erroneous application of properties from prior parsed lines has been fixed.

* An issue with stale OEGroup pointers that could result
  in a crash for molecule copy operations has been fixed.

Python-specific changes
--------------------------------------------------------------------------------
* An option has been added to the molcount.py example that allows
  use of an Omega-specific ContTest handling for Omega generated conformer inputs.

OESystem TK 3.3.1
================================================================================

Minor internal improvements have been made.

OEPlatform TK 3.3.1
================================================================================

Minor internal improvements have been made.

C++-specific changes
--------------------------------------------------------------------------------

* The code has been changed to define the statement “NOMINMAX” to trigger only if not already set.



OEChem TK 4.0.0
================================================================================

New features
--------------------------------------------------------------------------------
* A new preliminary API that supports generation of atom–atom
  mapping information for an input reaction has been provided in C++ and Python.
  See details at
  :oe:cls:`OERxnAutomapperOptions <OEChem::OERxnAutomapperOptions>`,
  :oe:cls:`OERxnAutomapper <OEChem::OERxnAutomapper>`,
  and :oe:constns:`OEChem::OERxnAutomapStatus`.

* A new nondefault input flavor has been added to support
  the conversion of implicit enhanced stereogroups from a V2000 SD format input file
  into explicit stereogroups.  This allows subsequent export of explicit enhanced stereogroups
  in formats that support that information, like :oe:const:`SDF<OEChem::OEFormat::SDF>` and
  :oe:const:`CXSMILES<OEChem::OEFormat::CXSMILES>`.
  See details at :ref:`SDF_ForceImp2ExpENHSTE <OEChem_OEIFlavor_SDF_ForceImp2ExpENHSTE>`.

* The explicit chiral-off designation (``r``) in the CXSMILES appendix is
  now tolerated when parsing the CXSMILES appendix.  This explicit designation is appearing
  more frequently in vendor structure sets.

* New overloads of :oe:cls:`OESimpleAppOptions <OEChem::OESimpleAppOptions>`
  and :oe:cls:`OERefInputAppOptions <OEChem::OERefInputAppOptions>` have been added to 
  support applications that do not produce an output file.
  
* The MMCIF reader now runs on Gemmi version 0.6.2. It is able to parse and write more sections in MMCIF files.

* The default OEIFlavor for :ref:`PDB <OEChem_OEIFlavor_PDB>` has been changed to include :ref:`PDB_DATA <OEChem_OEIFlavor_PDB_DATA>` by default.

* The default OEIFlavor for :ref:`MMCIF <OEChem_OEIFlavor_MMCIF>` has been changed to not include :ref:`MMCIF_ALTLOC <OEChem_OEIFlavor_MMCIF_ALTLOC>` by default,
  to match the :ref:`PDB <OEChem_OEIFlavor_PDB>` default behavior.

* Two new OEIFlavor defaults have been added, :ref:`PDB_SpruceDefault <OEChem_OEIFlavor_PDB_SpruceDefault>` and :ref:`MMCIF_SpruceDefault <OEChem_OEIFlavor_MMCIF_SpruceDefault>`,
  that add ``ALTLOC`` in addition to the default flavors for those file formats. These are being used in both the **SPRUCE** and **Make Receptor** applications.

* :ref:`OEHasAtomName <OEChem_OEHasAtomName>` has been extended to take a new optional argument called ``trimspaces`` (default=false) to more flexibly match atom names.

* :ref:`OEHasChainID <OEChem_OEHasChainID>` has been changed to internally operate on strings instead of characters to support multicharacter chain IDs. The character-based
  constructor is still available.

Minor bug fixes
--------------------------------------------------------------------------------
* The SD data format specifies that blank lines are the delimiters between
  different SD data fields.  If an SD file contains blanks within one or more
  SD data fields, the reader would previously complain about the format error.
  The reader has been augmented to be more tolerant of this case, but in the process it
  must strip blank lines from the input SD data to ensure that the SD output does not generate
  a noncompliant output file.  If blank lines are detected in the SD data for a molecule being
  exported in SD format, a new write status is returned to indicate the blank lines were removed in order to
  generate a compliant SD output file, and the generated output file will have the noncompliant blank line(s) removed.
  See details at :oe:const:`OEChem::OEWriteMolReturnCode::InvalidSDData`.

* A minor issue that caused :oe:func:`OEChem::OEGetTorsion` to crash if
  one or more of the atom arguments were null has been fixed.

* A minor issue that generated an invalid read error from V3000
  SD files with nonconsecutively ordered object indices has been fixed.  Generally,
  object indices in V3000 format files can be arbitrarily ordered.

* A defect that could result in a crash during MCS searching for
  targets containing single atom fragments has been fixed.

* An issue that caused :oe:cls:`OEMolParameter <OEChem::OEMolParameter>`
  to not be properly transmitted in MPI mode has been fixed.

* An issue with the assignment operator for :ref:`OEIsBridgeHead <OEChem_OEIsBridgeHead>` being incorrectly defined has been fixed.

* New overloads of :ref:`OESameResidue <OEChem_SameResidue>` and :ref:`OESameChain <OEChem_OESameChain>` that take atoms instead of residues have been added.
  This will prevent the need to get copies of :ref:`OEResidue <OEChem_OEResidue>` objects in wrapped languages, instead of using
  const references internally.

OEBio TK 4.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* Two new methods in :ref:`OEReceptor <OEBio_OEReceptor>`, :ref:`GetOuterContourVolume <OEBio_OEReceptor_GetOuterContourVolume>` and
  :ref:`GetInnerContourVolume <OEBio_OEReceptor_GetInnerContourVolume>`, have been added as convenience functions to get the volume of the receptor grid at
  the set contour level.

* The function :ref:`OEUpdateDesignUnit <OEBio_OEUpdateDesignUnit>` will not fail and return false if passed an empty molecule to update with.

* The function :ref:`OEUpdateDesignUnit <OEBio_OEUpdateDesignUnit>` has been updated to take an optional listIndex parameter if an item in a list molecule
  needs to be updated (e.g., one of several cofactors).

* The :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class has been extended with a method :ref:`ClearComponent <OEBio_OEDesignUnit_ClearComponent>`
  to remove or clear a component from a design unit; this method can also take an optional listIndex
  to remove a specific molecule in a list component  (e.g., one of several cofactors).

OESystem TK 4.0.0
================================================================================

New features
--------------------------------------------------------------------------------
  
* A new overload of the :ref:`OEGetColors <OESystem_OEGetColors>` function has been added that
  generates a custom color 
  iterator for use in depictions by passing a vector of desired colors.

OEPlatform TK 4.0.0
================================================================================

Minor internal improvements have been made.

OEGrid TK 4.0.0
================================================================================

Minor internal improvements have been made.





OEChem TK 4.1.0
================================================================================

New features
--------------------------------------------------------------------------------
* We are now able to read and parse the Chem Comp section of mmCIF files.

* We can now force a deterministic sorted order to the enhanced stereo information
  in generated :term:`CXSMILES` appendices.

* New overloads of the :ref:`OESimpleAppOptions<OEChem_OESimpleAppOptions>`
  constructors have been added to enable their usage when an output parameter is
  not desired.

* A new value, :oe:const:`OEChem::OEFileStringType::BroodQMol`,
  has been added to :oe:constns:`OEChem::OEFileStringType` to support molecule files
  containing BroodQuery.

* The following preliminary API classes have been made permanent.

  * :ref:`OECreateSubSearchDatabaseOptions<OEChem_OECreateSubSearchDatabaseOptions>`
  * :ref:`OESubSearchDatabase<OEChem_OESubSearchDatabase>`
  * :ref:`OESubSearchQuery<OEChem_OESubSearchQuery>`
  * :ref:`OESubSearchResult<OEChem_OESubSearchResult>`
  * :ref:`OESubSearchScreen<OEChem_OESubSearchScreen>`
  * :ref:`OESubSearchScreenTypeBase<OEChem_OESubSearchScreenTypeBase>`
  * :ref:`OEMolRecord<OEDataFlow_OEMolRecord>`
  * :ref:`OEMolParameter<OEChem_OEMolParameter>`
  * :ref:`OEFileStringParameter<OEChem_OEFileStringParameter>`
  * :ref:`OEMolReaderParameter<OEChem_OEMolReaderParameter>`
  * :ref:`OEMolWriterParameter<OEChem_OEMolWriterParameter>`
  * :ref:`OEOutFileStringParameter<OEChem_OEOutFileStringParameter>`
  * :ref:`OEPredicateParameter<OEChem_OEPredicateParameter>`
  * :ref:`OEUnAtomPredParameter<OEChem_OEUnAtomPredParameter>`
  * :ref:`OEUnBondPredParameter<OEChem_OEUnBondPredParameter>`
  * :ref:`OERefInputAppOptions<OEChem_OERefInputAppOptions>`
  * :ref:`OESimpleAppOptions<OEChem_OESimpleAppOptions>`

* The following preliminary API functions have been made permanent.

  * :ref:`OEReadCIFFile<OEChem_OEReadCIFFile>`
  * :ref:`OEWriteCIFFile<OEChem_OEWriteCIFFile>`
  * :ref:`OECreateSubSearchDatabaseFile<OEChem_OECreateSubSearchDatabaseFile>`
  * :ref:`OEGetSubSearchScreenType<OEChem_OEGetSubSearchScreenType>`
  * :ref:`OEIsComplementaryScreenType<OEChem_OEIsComplementaryScreenType>`
  * :ref:`OEIsValidSubSearchDatabase<OEChem_OEIsValidSubSearchDatabase>`
  * :ref:`OEIsValidSubSearchScreenString<OEChem_OEIsValidSubSearchScreenString>`
  * :ref:`OEMakeSubSearchQueryScreen<OEChem_OEMakeSubSearchQueryScreen>`
  * :ref:`OEMakeSubSearchTargetScreen<OEChem_OEMakeSubSearchTargetScreen>`
  * :ref:`OESameSubSearchScreenTypes<OEChem_OESameSubSearchScreenTypes>`
  * :ref:`OEScreen<OEChem_OEScreen>`
  * :ref:`OESubSearchStatusToName<OEChem_OESubSearchStatusToName>`

Major bug fixes
--------------------------------------------------------------------------------

* The handling of :oe:const:`OEChem::OESMILESFlag::ExtBonds` formatted fragments has been improved to better
  support explicit cis/trans parity information for the coupling bond.

* Parse multiply referenced enhanced stereogroups correctly from :term:`CXSMILES` appendices.

* The mapping behavior of \*atom and Rgroup atoms for both MDL and SMARTS queries is now synchronized.
  Rgroups and/or \*atoms in queries are now equivalently supported for :oe:func:`OEChem::OEMakeSubSearchQueryScreen`.

* Conversion of :ref:`OERecord <OEDataFlow_OERecord>` to CSV now writes :term:`CXSMILES` instead of :term:`SMILES` to
  ensure enhanced stereo is not dropped.

Minor bug fixes
--------------------------------------------------------------------------------

*  Null argument checks have been added to :oe:func:`OEChem::OESuppressHydrogens` to avoid causing a crash.

* Any attempt to kekulize partial structures for :oe:cls:`OEUniMolecularRxn<OEChem::OEUniMolecularRxn>`
  has been fully suppressed when specifically requested, which allows explicit nonaromatic/aromatic transformations for partial ring structures.

* ``.lst`` and ``.list`` no longer appear as viable input file
  types in the options in :ref:`OESimpleAppOptions<OEChem_OESimpleAppOptions>` and
  :ref:`OERefInputAppOptions<OEChem_OERefInputAppOptions>`.

OESystem TK 4.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* The following preliminary API classes have been made permanent.

  * :ref:`OERecord<OEDataFlow_OERecord>`
  * :ref:`OEOptions<OESystem_OEOptions>`
  * :ref:`OEBoolParameter<OESystem_OEBoolParameter>`
  * :ref:`OEConstParameter<OESystem_OEConstParameter>`
  * :ref:`OEDoubleParameter<OESystem_OEDoubleParameter>`
  * :ref:`OEFloatParameter<OESystem_OEFloatParameter>`
  * :ref:`OEIntParameter<OESystem_OEIntParameter>`
  * :ref:`OEMultiParameter<OESystem_OEMultiParameter>`
  * :ref:`OEPointerParameter<OESystem_OEPointerParameter>`
  * :ref:`OEPODParameter<OESystem_OEPODParameter>`
  * :ref:`OEStringParameter<OESystem_OEStringParameter>`
  * :ref:`OEUIntParameter<OESystem_OEUIntParameter>`

* The following preliminary API functions have been made permanent.

  * :ref:`OEConfigureItf<OESystem_OEConfigureItf>`
  * :ref:`OEConfigureOpts<OESystem_OEConfigureOpts>`
  * :ref:`OEUpdateOpts<OESystem_OEUpdateOpts>`

OEMath TK 4.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* The following preliminary API classes have been made permanent.

  * :ref:`OEKernelPLS<OEMath_OEKernelPLS>`
  * :ref:`OEMatrix<OEMath_OEMatrix>`
  * :ref:`OESquareMatrix<OEMath_OESquareMatrix>`

OEBio TK 4.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new overload of :oe:func:`OEBio::OESubsetDesignUnit` has been added to
  allow for in-place subsetting of a design unit to avoid generating a copy.

Major bug fixes
--------------------------------------------------------------------------------

* Several issues in :oe:func:`OEBio::OEPlaceHydrogens` have been added to address:

  * improved perception and geometry for sp\ :sup:`3` secondary amines.

  * improved chelation rules for primary amines.

  * improved chelation rules for phosphate and borate groups.

  * improved chelation rules for sulfonamide groups.

  * improved chelation rules for hydroxamate moieties.

Minor bug fixes
--------------------------------------------------------------------------------

* Null argument checks have been added to :oe:func:`OEBio::OEGetTorsion` to avoid causing a crash.

OEGrid TK 4.1.0
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* A problem in :ref:`OEReadMTZ <OESystem_OEReadMTZ>` has been fixed.

OESystem TK 4.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* The following preliminary API classes have been made permanent.

  * :ref:`OERecord<OEDataFlow_OERecord>`
  * :ref:`OEOptions<OESystem_OEOptions>`
  * :ref:`OEBoolParameter<OESystem_OEBoolParameter>`
  * :ref:`OEConstParameter<OESystem_OEConstParameter>`
  * :ref:`OEDoubleParameter<OESystem_OEDoubleParameter>`
  * :ref:`OEFloatParameter<OESystem_OEFloatParameter>`
  * :ref:`OEIntParameter<OESystem_OEIntParameter>`
  * :ref:`OEMultiParameter<OESystem_OEMultiParameter>`
  * :ref:`OEPointerParameter<OESystem_OEPointerParameter>`
  * :ref:`OEPODParameter<OESystem_OEPODParameter>`
  * :ref:`OEStringParameter<OESystem_OEStringParameter>`
  * :ref:`OEUIntParameter<OESystem_OEUIntParameter>`

* The following preliminary API functions have been made permanent.

  * :ref:`OEConfigureItf<OESystem_OEConfigureItf>`
  * :ref:`OEConfigureOpts<OESystem_OEConfigureOpts>`
  * :ref:`OEUpdateOpts<OESystem_OEUpdateOpts>`

OEMath TK 4.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* The following preliminary API classes have been made permanent.

  * :ref:`OEKernelPLS<OEMath_OEKernelPLS>`
  * :ref:`OEMatrix<OEMath_OEMatrix>`
  * :ref:`OESquareMatrix<OEMath_OESquareMatrix>`




.. _section_oechemtk_releasenotes_4111:

OEChem TK 4.1.1.1
================================================================================

Major bug fixes
--------------------------------------------------------------------------------
* An issue has been fixed where :oe:func:`OEChem::OEReadMolecule` would fail to read
  a molecule from an mmCIF file if an invalid LINK record was present. 

.. _section_oechemtk_releasenotes_4110:

OEChem TK 4.1.1.0
================================================================================

New features
--------------------------------------------------------------------------------
* Support has been implemented for OEGroup information for :oe:const:`OEMiniMol<OEChem::OEMolBaseType::OEMiniMol>` to support
  the return of enhanced stereogroup information from :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` hits.  Previously,
  enhanced stereogroup information on the indexed structures would be ignored during indexing and thus missed from returned hits.

* LINK records in the PDB metadata are now parsed to improve perception
  of covalently bound heterogens. The equivalent `_struct_conn` metadata is also parsed from mmCIF files.
  The distance between the listed atoms is confirmed before applying the bond.

Minor bug fixes
--------------------------------------------------------------------------------
* If any parse error results from parsing a :oe:const:`OEChem::OEFormat::CXSMILES` appendix specifically,
  the full appendix plus the molecule title are now returned in the molecule title to allow user inspection and corrective action.

* :oe:const:`OEChem::OEFormat::SDF` data parsing has been modified to ensure that ``>``-prefixed data is properly
  captured.  Since :term:`SDF` data field name lines are ``>``-prefixed as well, the new behavior explicitly requires a
  blank line delimiter to be present between data entries, including null data items, per the :term:`SDF` file format specification.
  This allows unambiguous identification of data field name header lines versus data entry lines.

* An issue has been fixed to avoid generating duplicate data tags from generic data that can result in invalid JSON output.

* Titles returned from :oe:meth:`OEChem::OEMolDatabase::GetTitle` when :oe:const:`OEChem::OEFormat::CXSMILES` files are indexed
  no longer contain the :term:`CXSMILES` appendix unless there is a parse error with the appendix information itself.

* An error has been fixed that sometimes resulted in missing atom parity information in output :term:`SDF`
  format files when a nondefault :oe:meth:`OEChem::oemolistream::SetConfTest` was provided.

* A line ending parse error has been fixed for :oe:const:`OEChem::OEFormat::FASTA` files affecting windows files.

* Propagation of perceived query aromaticity has been added for alternating single/double Kekulé forms
  so that alternate and equivalent s/d bond patterns are treated consistently.

* Null pointer protections have been added to some internal search matching code that could cause a crash.

* :oe:const:`OEChem::OEFileStringTypeFlavor::Default` has been augmented to exclude file types
  that are not suggested for use.  Accordingly, a new constant, :oe:const:`OEChem::OEFileStringTypeFlavor::Pretty`,
  has been defined and is part of the new definition of :oe:const:`OEChem::OEFileStringTypeFlavor::Default`.
  Removing :oe:const:`OEChem::OEFileStringTypeFlavor::Pretty` from :oe:const:`OEChem::OEFileStringTypeFlavor::Default`
  would provide the file types that include everything.

* A new type, :oe:const:`OEChem::OEMMFFType::CION`, has been added to define a generic
  type for counterions.

OEPlatform TK 4.1.1
================================================================================

New features
--------------------------------------------------------------------------------

* The ``ZSTD`` library has been updated from version ``1.5.2`` to ``1.5.6``.

OEBio TK 4.1.1
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* In the Iridium categorization of a design unit, a properly perceived,
  covalently bound ligand no longer triggers an HT to MT category transition. The
  rule flags atoms that are within what is considered a covalent bond distance, where
  a bond is not properly perceived.

* An issue has been fixed so that :ref:`ClearComponent <OEBio_OEDesignUnit_ClearComponent>` can be
  used to clear user-defined components.
  


OEChem TK 4.2.0
================================================================================

New Features
--------------------------------------------------------------------------------

*  If an mmCIF file with long residue names is written to PDB, it will first
   check whether the three-character version is unused and will use that if it is.

*  A new option parameter has been added to :ref:`OEUniMolecularRxnOptions <OEChem_OEUniMolecularRxnOptions>`
   that enables hydrogen count conversions and perceptions of the target(s) required for the
   specified transformation (default: ``true``).

Major Bug Fixes
--------------------------------------------------------------------------------

*  An issue has been fixed that caused mmCIF files with long residue names to break the
   long residue names into multiple residues.

Minor Bug Fixes
--------------------------------------------------------------------------------

*  An issue has been fixed that ensures that missing mmCIF metadata relevant for Iridium
   classification of a structure does not cause problems.

*  An issue has been fixed which ensures that LINK records are  parsed only if
   formatted correctly.

*  A new option parameter in :ref:`OEUniMolecularRxnOptions <OEChem_OEUniMolecularRxnOptions>`
   enables calling :ref:`OEPrepareSearch <OEChem_OEPrepareSearch>` for the query and
   target.  This call suppresses the warning messages about unsynchronized explicit or
   implicit hydrogens between the internal query and the target that were unable to be remedied by any user action.

*  The function :ref:`OEPrepareSearch <OEChem_OEPrepareSearch>` is now called as part of the initialization
   in :ref:`OELibraryGen <OEChem_OELibraryGen>` to eliminate warning messages about explicit or
   implicit hydrogens and stereo perceptions on the provided starting materials.

Python-Specific Changes
--------------------------------------------------------------------------------

*  A couple of issues have been fixed that caused crashes using Python 3.12, related
   to using :ref:`OEResidue <OEChem_OEResidue>` objects in a dictionary and setting 
   an :ref:`OEBitVector <OESystem_OEBitVector>` (or classes derived 
   from it) or an :ref:`OEHalfFloat <OEPlatform_OEHalfFloat>` as generic data on a molecule.

OEBio TK 4.2.0
================================================================================

Minor Bug Fixes
--------------------------------------------------------------------------------

*  An issue has been fixed in the :ref:`OEBio_OEIsNTerminalAtom <OEBio_OEIsNTerminalAtom>` predicate ensuring
   the NME capping group is not matched.

* :ref:`OEProteinConstraintType <OEBio_OEProteinConstraintType>` constants
  are now properly wrapped in Python.




OEChem TK 4.3.0
================================================================================

New Features
--------------------------------------------------------------------------------

* A new function, :oe:func:`OEChem::OESweepMDLStereoGroups`, has been added
  to strip nonstereo atoms from existing enhanced stereogroups, which can be used
  to reconcile the stereogroup information with the existing atom stereo parities.

* A new function, :oe:func:`OEChem::OESameAlternateLocation`, has been added
  to determine whether two atoms have the same alternate location set. It optionally 
  allows for one of the states to be blank or unspecified, similar to the predicate
  :oe:cls:`OEHasAlternateLocation<OEBio::OEHasAlternateLocation>`.

* A new function, :oe:func:`OEChem::OEClearFormalCharges`, has been added that resets all formal
  charges to zero.

* A new :oe:cls:`OECIFData <OEChem::OECIFData>` object has been added for easier
  access, coordination, validation, and updates to CIF header data. The full list of new
  features related to this object can be found on the :oe:cls:`OEChem::OECIFData`
  API page.
  Data available in this object reflects what is contained in the CIF ``data_`` section.

* A new :oe:cls:`OEChem::OECIFCategory` object holds CIF category data and acts as
  an interface to interact with this header data. The full list of new features
  related to this object can be found on the :oe:cls:`OEChem::OECIFCategory`
  API page.
  Data available in this object reflects what is contained in CIF pair or loop sections.

* A new :oe:cls:`OEChem::OECIFOptions` object is used during CIF update functions
  and informs what categories and data items in the CIF header will be updated.

* The :oe:func:`OEChem::OESetMMCIFData` function can also take an
  :oe:cls:`OEChem::OECIFData` object as an input to save data stored in the
  object on the input molecule.

* The new function :oe:func:`OEChem::OEUpdateMMCIFData` will update the molecule's
  CIF header data based on the molecule's current structure.

* The new function :oe:func:`OEChem::OESetMMCIFChemCompData` was created to
  override mmCIF chemical component data on the molecule's CIF header data.

* The new function :oe:func:`OEChem::OEIsCIFHeaderCompliant` takes the RCSB's
  PDB Exchange Dictionary as input and checks if the CIF categories stored on
  the molecule are supported by the RCSB.

* A new OEOFlavor for mmCIF, :ref:`PerceiveMetadata <OEChem_OEOFlavor_MMCIF_PerceiveMetadata>`, can be used to
  perceive all CIF header metadata at write time, based on the molecule's
  structure.

* Improvements have been made to CIF file reads that utilize chemical component header sections.

* The :oe:cls:`OEChem::OEIsDisulfideBridgeBond` functor identifies inter-residue disulfide
  bridge bonds and follows the same bond identification criteria that was
  in the OEBio :oe:cls:`OEBio::OEIsDisulfideBond` functor.

* The new :oe:cls:`OEChem::OEIsAmideBond` functor identifies inter-residue amide bonds.

* The new :oe:cls:`OEChem::OEIsIntraResidueBond` functor identifies intra-residue bonds.

Major Bug Fixes
--------------------------------------------------------------------------------

* Improvements have been made to mmCIF file writes for stability to minimize overwriting data
  stored in the header.

* Improved mmCIF file write stability has been added.

Minor Bug Fixes
--------------------------------------------------------------------------------

* A coding error in the assignment operator for
  :oe:const:`OEMiniMol<OEChem::OEMolBaseType::OEMiniMol>` has been fixed.

* An issue with invalid object pointers returned from
  :oe:func:`OEChem::OEGetAutomorphs` has been fixed.

* Various stability improvements to CIF header writes have been made.

* An issue reading certain LINK records from PDB files has been fixed

OEBio TK 4.3.0
================================================================================

New Features
--------------------------------------------------------------------------------

* A method, :oe:meth:`OEBio::OEDesignUnit::GetAltLoc`, has been added to
  the :oe:cls:`OEBio::OEDesignUnit` class that allows the user to get the alternate
  location identifier for the design unit.

Major Bug Fixes
--------------------------------------------------------------------------------

* An issue has been fixed in :oe:cls:`OEBio::OEAltLocationFactory` so that input options
  are fully respected.

Minor Bug Fixes
--------------------------------------------------------------------------------

* The following were removed from the polymers
  category in the residue database: ZYA, R99, RL2, VSC, ZU5, S89, 0I5, 0D6, 0E6, ZRA, I0Y, and K36.

* The :oe:cls:`OEBio::OEIsDisulfideBond` functor now uses the **OEChem**
  :oe:cls:`OEChem::OEIsDisulfideBridgeBond` functor for its implementation.

* The covalent perception distance in design unit splitting to components has been relaxed.

OEGrid 4.3.0
================================================================================

New Features
--------------------------------------------------------------------------------

* A new function, :oe:func:`OESystem::OEReadCIFGridFile`, has been added to
  read structure factor CIF (sfCIF) files into :oe:cls:`OESystem::OESkewGrid`.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. _chapter_ring:

********************************************************************************
Ring Perception
********************************************************************************

.. index:: ring processing, ring membership, cyclic membership

.. _section_ring_cyclic_membership:

Cycle Membership
================================================================================

The simplest form of ring processing in **OEChem TK** is testing
whether an atom or bond is in a ring or not.
The **OEChem TK** function
:oe:func:`OEFindRingAtomsAndBonds<OEChem::OEFindRingAtomsAndBonds>` is
used to determine which atoms and bonds are members of one or more
rings and which are acyclic.  This function uses an efficient
:math:`O(n)` algorithm.  Once
:oe:func:`OEFindRingAtomsAndBonds<OEChem::OEFindRingAtomsAndBonds>` has
been called, an atom or bond can be tested for being in a ring by
calling the :oe:meth:`OEChem::OEAtomBase::IsInRing` or the
:oe:meth:`OEChem::OEBondBase::IsInRing` methods respectively.

The function
:oe:func:`OEFindRingAtomsAndBonds<OEChem::OEFindRingAtomsAndBonds>` is
called automatically by the high-level file read function
:oe:func:`OEReadMolecule<OEChem::OEReadMolecule>` and 
:oe:func:`OESmilesToMol<OEChem::OESmilesToMol>`.  
However, whenever you modify a molecule by adding or deleting bonds, you'll need to
explicitly call :oe:func:`OEFindRingAtomsAndBonds<OEChem::OEFindRingAtomsAndBonds>`.

The following two 'equivalent' code snippets demonstrate
how to loop over chain
atoms using the :oe:cls:`OEAtomIsInRing<OEChem::OEAtomIsInRing>`
functor and the :oe:meth:`IsInRing<OEChem::OEAtomBase::IsInRing>`
method of the :oe:cls:`OEAtomBase<OEChem::OEAtomBase>` class.

.. oe:source:: PerceiveRing.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-RING-LOOP1

.. oe:source:: PerceiveRing.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-RING-LOOP2

.. oe:source:: PerceiveRing.py
   :language: python
   :noindent:
   :frag:     SNIPPET-RING-LOOP1

.. oe:source:: PerceiveRing.py
   :language: python
   :noindent:
   :frag:     SNIPPET-RING-LOOP2

.. oe:source:: PerceiveRing.java
   :language: java
   :noindent:
   :frag:     SNIPPET-RING-LOOP1

.. oe:source:: PerceiveRing.java
   :language: java
   :noindent:
   :frag:     SNIPPET-RING-LOOP2

.. oe:source:: PerceiveRing.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-RING-LOOP1

.. oe:source:: PerceiveRing.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-RING-LOOP2

The chain/ring bonds of a molecule can similarly be accessed using the
:oe:cls:`OEBondIsInRing<OEChem::OEBondIsInRing>` functor and the
:oe:meth:`IsInRing<OEChem::OEBondBase::IsInRing>` method of the
:oe:cls:`OEBondBase<OEChem::OEBondBase>` class.
For more information about functors see chapter :ref:`chapter_predicates`.

The user can also set the atom and bond ring flags manually using the
:oe:meth:`OEChem::OEAtomBase::SetInRing` and
:oe:meth:`OEChem::OEBondBase::SetInRing` methods.

.. admonition:: Code Example

   * `Ring Perception`_ **OpenEye Python Cookbook** recipe

.. _section_ring_ringsize_membership:

Membership in a Given Ring Size
================================================================================

.. index:: SSSR, smallest set of smallest rings

It is also possible to use **OEChem TK** to determine whether an atom or a bond is in a ring
of a given size, using the :oe:func:`OEAtomIsInRingSize<OEChem::OEAtomIsInRingSize>`
and :oe:func:`OEBondIsInRingSize<OEChem::OEBondIsInRingSize>` functions.

Both of these functions require that
:oe:func:`OEFindRingAtomsAndBonds<OEChem::OEFindRingAtomsAndBonds>` has previously been
called on the molecule.
Both of these functions take the query ring size as an argument, which should
be greater than or equal to three.
The definition of ring or cycle is not based upon the  ''smallest set of smallest rings''
(SSSR), and the functions return true if there is a bonded path of *size* unique atoms
where each atom is bonded to the next and the last is bonded to the first.

It is often the case that atoms may be in different sized cycles at
the same time.  For example, one way to identify the ring fusion atoms
in indole (the fusion of a five-membered pyrrole ring and a six-membered
benzene ring) is the following:

.. oe:source:: PerceiveRing.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-RING-SIZE

.. oe:source:: PerceiveRing.py
   :language: python
   :noindent:
   :frag:     SNIPPET-RING-SIZE

.. oe:source:: PerceiveRing.java
   :language: java
   :noindent:
   :frag:     SNIPPET-RING-SIZE

.. oe:source:: PerceiveRing.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-RING-SIZE

.. figure:: oechemtk/images/OEAtomIsInRingSize.*
   :scale:  100
   :align:  center

   **The fused atoms in indole belong to both a five- and a six-membered rings**

**OEChem TK** also provides an additional pair of functions,
:oe:func:`OEAtomIsInAromaticRingSize<OEChem::OEAtomIsInAromaticRingSize>` and
:oe:func:`OEBondIsInAromaticRingSize<OEChem::OEBondIsInAromaticRingSize>`, to
determine whether an atom or bond is in an aromatic ring or cycle of a given size.
These behave identically to :oe:func:`OEAtomIsInRingSize<OEChem::OEAtomIsInRingSize>`
and :oe:func:`OEBondIsInRingSize<OEChem::OEBondIsInRingSize>` except that each ring bond
in the path/cycle must be aromatic.
In addition to :oe:func:`OEFindRingAtomsAndBonds<OEChem::OEFindRingAtomsAndBonds>`,
these functions also require the user to have called
:oe:func:`OEAssignAromaticFlags<OEChem::OEAssignAromaticFlags>`.

.. admonition:: Code Example

   * `Ring Perception`_ **OpenEye Python Cookbook** recipe

.. _section_ring_smallestring_membership:

Smallest Ring Membership
================================================================================

.. index:: smallest ring membership

In addition to determining whether an atom or a bond is in a ring or cycle of
a given size, it's often useful to know the size of the smallest ring or cycle
that an atom or bond is in.
To do this **OEChem TK** provides the functions
:oe:func:`OEAtomGetSmallestRingSize<OEChem::OEAtomGetSmallestRingSize>` and
:oe:func:`OEBondGetSmallestRingSize<OEChem::OEBondGetSmallestRingSize>`.
For acyclic atoms and bonds, these functions return the value zero.
For cyclic atoms and bonds, they return a value greater than or equal to
three.

.. oe:source:: PerceiveRing.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-RING-SMALLEST-SIZE

.. oe:source:: PerceiveRing.py
   :language: python
   :noindent:
   :frag:     SNIPPET-RING-SMALLEST-SIZE

.. oe:source:: PerceiveRing.java
   :language: java
   :noindent:
   :frag:     SNIPPET-RING-SMALLEST-SIZE

.. oe:source:: PerceiveRing.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-RING-SMALLEST-SIZE

.. figure:: oechemtk/images/OEAtomGetSmallestRingSize.*
   :scale:  100
   :align:  center

   **OEAtomGetSmallestRingSize returns five for each heavy atom of norbornane**

.. admonition:: Code Example

   * `Ring Perception`_ **OpenEye Python Cookbook** recipe

.. _section_ring_system_components:

Connected Components Identification
================================================================================

.. index:: connected components identification

To aid in splitting molecules into discrete connected components, for
example to separate a parent compound from its salt, or a ligand from
a protein, **OEChem TK** provides the function
:oe:func:`OEDetermineComponents<OEChem::OEDetermineComponents>`.
This function arbitrarily assigns an integer index, starting from one, to
each disconnected part in the :oe:cls:`OEMolBase<OEChem::OEMolBase>`.

.. oe:language:: c++

   The user provides a pointer to an array of at least
   :oe:meth:`GetMaxAtomIdx<OEChem::OEMolBase::GetMaxAtomIdx>` unsigned ints,
   which is populated by the function.

On return this provides a mapping from each atom's index, obtained by
:oe:meth:`OEChem::OEAtomBase::GetIdx`, to its component index.
Unused atom indices are mapped to zero.
The function itself also returns the total number of components found, *i.e.*
the maximum part index stored in the array.
The following snippet provides a short example of how to use this function.

.. oe:source:: DetermineComponents.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-COMPONENTS

.. oe:source:: DetermineComponents.py
   :language: python
   :noindent:
   :frag:     SNIPPET-COMPONENTS

.. oe:source:: DetermineComponents.java
   :language: java
   :noindent:
   :frag:     SNIPPET-COMPONENTS

.. oe:source:: DetermineComponents.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-COMPONENTS

.. admonition:: Code Example

   * :ref:`section_example_oechem_parts2mols` **OEChem TK** example
   * `Ring Perception`_ **OpenEye Python Cookbook** recipe

.. _section_ring_system_identification:

Ring Systems Identification
================================================================================

.. index:: ring system identification, aromatic ring system identification

The **OEChem TK** function :oe:func:`OEChem::OEDetermineRingSystems`
and :oe:func:`OEChem::OEDetermineAromaticRingSystems`
behave very similarly to the :oe:func:`OEDetermineComponents<OEChem::OEDetermineComponents>`.
However, these functions return a mapping from atom indices to a ring or aromatic ring
system index, respectively (see example in :oe:src:`Listing 1<SNIPPET-PerceiveAromRingSystems>`).
These functions require that :oe:func:`OEFindRingAtomsAndBonds<OEChem::OEFindRingAtomsAndBonds>`
has been called previously. 
The function :oe:func:`OEChem::OEDetermineAromaticRingSystems` also requires
the aromaticity perception  by calling the :oe:func:`OEChem::OEAssignAromaticFlags` function.
The :oe:func:`OEChem::OESmilesToMol` used in the above example automatically calls 
both the :oe:func:`OEChem::OEFindRingAtomsAndBonds` and :oe:func:`OEChem::OEAssignAromaticFlags` 
functions.

When using the :oe:func:`OEDetermineRingSystems<OEChem::OEDetermineRingSystems>` function,
all acyclic atoms are mapped to the value zero.
When using the :oe:func:`OEDetermineAromaticRingSystems<OEChem::OEDetermineAromaticRingSystems>`
function, all aliphatic atoms are mapped to the value zero.

.. oe:source:: PerceiveAromRingSystems.cpp
   :language: c++
   :refnum:   1
   :caption:  Aromatic ring system identification
   :frag:     SNIPPET

.. oe:source:: PerceiveAromRingSystems.py
   :language: python
   :refnum:   1
   :caption:  Aromatic ring system identification
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-PerceiveAromRingSystems.py>`

.. oe:source:: PerceiveAromRingSystems.java
   :language: java
   :refnum:   1
   :caption:  Aromatic ring system identification
   :frag:     SNIPPET

.. oe:source:: PerceiveAromRingSystems.cs
   :language: csharp
   :refnum:   1
   :caption:  Aromatic ring system identification
   :frag:     SNIPPET

.. _figure_ring_aromsystems:

.. figure:: oechemtk/images/OEDetermineAromaticRingSystems.*
   :scale:  100
   :align:  center

   **Example structure of aromatic ring system identification**

The output of :oe:src:`Listing 1<SNIPPET-PerceiveAromRingSystems>` is the following:

.. code-block:: bash

   Aliphatic atoms: 0 1 2 11 12 13 14
   Number of aromatic ring systems = 2
   1 . aromatic ring system: 3 4 5 6 7 8 9 10 21
   2 . aromatic ring system: 15 16 17 18 19 20

.. admonition:: Code Example

   * `Ring Perception`_ **OpenEye Python Cookbook** recipe

.. _section_sssr:

Smallest Set of Smallest Rings (SSSR) Considered Harmful
================================================================================

.. index:: SSSR

In graph-theoretical terms, a bond is considered cyclic if its removal from the
structure  would not lead to the structure being broken into separate components.
Despite this simple definition, a large number of algorithms for ring detection
exist.
(See article [Downs-1989]_ for an extensive and comparative review.)
The diversity and multitude of the ring perception methods derives from the
fact that, while determining whether an atom is part of a ring is a very simple
problem,  the identification of "chemically meaningful" rings among the potentially
large number of cyclic subgraphs of a molecular structure can be a surprisingly
complex task.

The *Smallest set of smallest rings* (SSSR) [Plotkin-1971]_  is the most broadly used
type of ring set in computational chemistry. However SSSR is not a unique subset
of all possible cycles of a molecule (see :ref:`Figure: Example of SSSR<figure_ring_sssr>`).
Obviously SSSR membership can not be used as a graph theoretical invariant in symmetry
perception.  Indeed the choice of which rings are part of the SSSR and which are not
is arbitrary, and often dependent upon the input order of the molecule.
Because of the potential ambiguity of SSSR, many alternative ring set definitions to SSSR
have been proposed over the years, including extended SSSR,
the set of "synthetically important" rings, the set of elementary rings (SER),
the essential set of essential rings (ESER), :math:`\kappa`-rings, etc...

.. _figure_ring_sssr:

.. figure:: oechemtk/images/SSSR.*
   :scale:  100
   :align:  center

   **Example of SSSR**
   *SSSR is not an invariant subset of all possible rings; (a), (b) and (c) depict the three equally valid SSSR of the bridged structure (on the left)*

We believe that it is a great service to our customers that we do not
include any SSSR functionality in **OEChem TK**.  This is a conscious (and
consensus) decision.  The forerunners of **OEChem TK**, Babel and OELib,
both contained efficient algorithms for determining SSSR, and these
remain freely available on the Internet today.  Furthermore, many
useful ring perception routines are available in **OEChem TK**, including:

* the ability to detect whether an atom or bond is acyclic or part of a ring
  (For more details on  :oe:meth:`OEChem::OEAtomBase::IsInRing` and
  :oe:meth:`OEChem::OEBondBase::IsInRing`, see section :ref:`section_ring_cyclic_membership`)

* the ability to detect whether an atom or a bond is in a ring of a particular size
  (For more details on :oe:func:`OEAtomIsInRingSize<OEChem::OEAtomIsInRingSize>` and
  :oe:func:`OEBondIsInRingSize<OEChem::OEBondIsInRingSize>`,
  see section :ref:`section_ring_ringsize_membership`)

* the ability to detect whether an atom or a bond is in an aromatic ring of a particular size
  (For more details on :oe:func:`OEAtomIsInAromaticRingSize<OEChem::OEAtomIsInAromaticRingSize>` and
  :oe:func:`OEBondIsInAromaticRingSize<OEChem::OEBondIsInAromaticRingSize>`,
  see section :ref:`section_ring_ringsize_membership`)

* the size of the smallest ring an atom or bond belongs to
  (For more details on :oe:func:`OEAtomGetSmallestRingSize<OEChem::OEAtomGetSmallestRingSize>`
  and :oe:func:`OEBondGetSmallestRingSize<OEChem::OEBondGetSmallestRingSize>`,
  see section :ref:`section_ring_smallestring_membership`)

* the ability to determine whether atoms belong to the same ring system
  (:oe:func:`OEDetermineRingSystems<OEChem::OEDetermineRingSystems>`)
  or the same aromatic ring system
  (:oe:func:`OEDetermineAromaticRingSystems<OEChem::OEDetermineAromaticRingSystems>`).
  See section :ref:`section_ring_system_identification` for more details.

.. seealso::

   * [Balducci-1994]_
   * [Baumer-1991]_
   * [Downs-1989]_
   * [Figueras-1996]_
   * [Fujita-1988]_
   * [Gasteiger-1979]_
   * [Hanser-1996]_
   * [Plotkin-1971]_
   * [Qian-1990]_
   * [Roos-Kozel-1981]_
   * [Takahashi-1994]_
   * [Zamora-1976]_



###############################################
Appendix: Additional Examples in Python
###############################################

These are full listings of programming examples that are excerpted or offered for download in this chapter.
See the full list of examples
:ref:`elsewhere in this chapter <oechem_part_examples>`.

..	_listing-AltlocfactGroupsDoc.py:

.. oe:source:: AltlocfactGroupsDoc.py
   :language: python
   :refnum:   1
   :caption:  Alternate location factory groups

..	_listing-Aromaticity.py:

.. oe:source:: Aromaticity.py
   :language: python
   :refnum:   2
   :caption:  Aromaticity perception with various models

..	_listing-AtomMap.py:

.. oe:source:: AtomMap.py
   :language: python
   :refnum:   3
   :caption:  Substructure search with atom mappings

..	_listing-CompositionFunctorsAtom.py:

.. oe:source:: CompositionFunctorsAtom.py
   :language: python
   :refnum:   4
   :caption:  Combining predefined atom predicates

..	_listing-CompositionFunctorsBond.py:

.. oe:source:: CompositionFunctorsBond.py
   :language: python
   :refnum:   5
   :caption:  Combining predefined bond predicates

..	_listing-ClearAromaticity.py:

.. oe:source:: ClearAromaticity.py
   :language: python
   :refnum:   6
   :caption:  Clearing aromaticity

..	_listing-ResCountDoc.py:

.. oe:source:: ResCountDoc.py
   :language: python
   :refnum:   7
   :caption:  Looping over hierarchical components

..	_listing-DatabaseSubset.py:

.. oe:source:: DatabaseSubset.py
   :language: python
   :refnum:   10
   :caption:  Retrieving a subset of a file

..	_listing-DatabaseExtract.py:

.. oe:source:: DatabaseExtract.py
   :language: python
   :refnum:   11
   :caption:  Extract molecules by title

..	_listing-ManipulateSDData.py:

.. oe:source:: ManipulateSDData.py
   :language: python
   :refnum:   12
   :caption:  SD data manipulation

..	_listing-ThreadedMolFind.py:

.. oe:source:: ThreadedMolFind.py
   :language: python
   :refnum:   13
   :caption:  Using Threaded Input and Output

..	_listing-MultiCoreMolFind.py:

.. oe:source:: MultiCoreMolFind.py
   :language: python
   :refnum:   14
   :caption:  Using multiple threads to read and write to molthreads

..	_listing-PipelineMolFind.py:

.. oe:source:: PipelineMolFind.py
   :language: python
   :refnum:   15
   :caption:  Setting mutexed memory pool mode

..	_listing-ManipulatePDBData.py:

.. oe:source:: ManipulatePDBData.py
   :language: python
   :refnum:   16
   :caption:  PDB data manipulation

..	_listing-SubstructureSearch.py:

.. oe:source:: SubstructureSearch.py
   :language: python
   :refnum:   17
   :caption:  Simple substructure search example

..	_listing-MolFind.py:

.. oe:source:: MolFind.py
   :language: python
   :refnum:   18
   :caption:  Extracting molecules based upon a substructure

..	_listing-SubstructureSearchMatch.py:

.. oe:source:: SubstructureSearchMatch.py
   :language: python
   :refnum:   19
   :caption:  Substructures match for query molecule

..	_listing-Functors.py:

.. oe:source:: Functors.py
   :language: python
   :refnum:   20
   :caption:  Using functor callbacks

..	_listing-FunctorsAtom.py:

.. oe:source:: FunctorsAtom.py
   :language: python
   :refnum:   21
   :caption:  Using predefined atom functors

..	_listing-FunctorsBond.py:

.. oe:source:: FunctorsBond.py
   :language: python
   :refnum:   22
   :caption:  Using predefined bond functors

..	_listing-FunctorsOEMatch.py:

.. oe:source:: FunctorsOEMatch.py
   :language: python
   :refnum:   23
   :caption:  Functor substructure-based matching

..	_listing-FunctorsOEPartPred.py:

.. oe:source:: FunctorsOEPartPred.py
   :language: python
   :refnum:   24
   :caption:  Ring system extraction

..	_listing-FunctorsOESubsetMol.py:

.. oe:source:: FunctorsOESubsetMol.py
   :language: python
   :refnum:   25
   :caption:  Ring system extraction

..	_listing-GenericDataMol.py:

.. oe:source:: GenericDataMol.py
   :language: python
   :refnum:   26
   :caption:  Example of attaching a molecule as generic data

..	_listing-GenericDataMolWeight.py:

.. oe:source:: GenericDataMolWeight.py
   :language: python
   :refnum:   27
   :caption:  Example of using generic data

..	_listing-GenericDataToAtom.py:

.. oe:source:: GenericDataToAtom.py
   :language: python
   :refnum:   28
   :caption:  Example of attaching generic data to atoms

..	_listing-GettingStartedWithOEInterface.py:

.. oe:source:: GettingStartedWithOEInterface.py
   :language: python
   :refnum:   29
   :caption:  Getting started with OEInterface command line parsing

..	_listing-NthMolecule.py:

.. oe:source:: NthMolecule.py
   :language: python
   :refnum:   30
   :caption:  Retrieving the Nth molecule in a file

..	_listing-OEInterfaceMolParam.py:

.. oe:source:: OEInterfaceMolParam.py
   :language: python
   :refnum:   31
   :caption:  Example of using molecule parameter

..	_listing-PerceiveAromRingSystems.py:

.. oe:source:: PerceiveAromRingSystems.py
   :language: python
   :refnum:   32
   :caption:  Aromatic ring system identification

..	_listing-PrintAtomStereo.py:

.. oe:source:: PrintAtomStereo.py
   :language: python
   :refnum:   33
   :caption:  Accessing atom stereo information

..	_listing-PrintBondStereo.py:

.. oe:source:: PrintBondStereo.py
   :language: python
   :refnum:   34
   :caption:  Accessing bond stereo information

..	_listing-PrintCIPAtomStereo.py:

.. oe:source:: PrintCIPAtomStereo.py
   :language: python
   :refnum:   35
   :caption:  Perceiving CIP atom stereo information

..	_listing-PrintCIPBondStereo.py:

.. oe:source:: PrintCIPBondStereo.py
   :language: python
   :refnum:   36
   :caption:  Perceiving CIP bond stereo information

..	_listing-ScalarGridCtor.py:

.. oe:source:: ScalarGridCtor.py
   :language: python
   :refnum:   37
   :caption:  Constructing a scalar grid

..	_listing-SetAtomStereo.py:

.. oe:source:: SetAtomStereo.py
   :language: python
   :refnum:   38
   :caption:  Setting atom stereo information

..	_listing-SetBondStereo.py:

.. oe:source:: SetBondStereo.py
   :language: python
   :refnum:   39
   :caption:  Setting bond stereo information

..	_listing-SimpleResCountDoc.py:

.. oe:source:: SimpleResCountDoc.py
   :language: python
   :refnum:   40
   :caption:  Accessing OEResidue properties

..	_listing-UserPredAtom.py:

.. oe:source:: UserPredAtom.py
   :language: python
   :refnum:   41
   :caption:  User defined atom predicate

..	_listing-UserPredAtomArg.py:

.. oe:source:: UserPredAtomArg.py
   :language: python
   :refnum:   42
   :caption:  User defined atom predicate with state

..	_listing-UserPredBond.py:

.. oe:source:: UserPredBond.py
   :language: python
   :refnum:   43
   :caption:  User defined bond predicate

..	_listing-UsingOEInterfaceDefaults.py:

.. oe:source:: UsingOEInterfaceDefaults.py
   :language: python
   :refnum:   44
   :caption:  Setting a default value for a parameter

..	_listing-UsingOEInterfaceHas.py:

.. oe:source:: UsingOEInterfaceHas.py
   :language: python
   :refnum:   45
   :caption:  Testing for parameter existence with the Has method

..	_listing-UsingOEInterfaceHelp.py:

.. oe:source:: UsingOEInterfaceHelp.py
   :language: python
   :refnum:   46
   :caption:  A program to concatenate any number of molecules together

..	_listing-UsingOEInterfaceKeyless.py:

.. oe:source:: UsingOEInterfaceKeyless.py
   :language: python
   :refnum:   47
   :caption:  Specifying keyless input and output file parameters

..	_listing-UsingOEInterfaceList.py:

.. oe:source:: UsingOEInterfaceList.py
   :language: python
   :refnum:   48
   :caption:  Specifying that a parameter is a list of values

..	_listing-UsingOEInterfaceRequired.py:

.. oe:source:: UsingOEInterfaceRequired.py
   :language: python
   :refnum:   49
   :caption:  Requiring all parameters to be specified.

..	_listing-WriteCSV.py:

.. oe:source:: WriteCSV.py
   :language: python
   :refnum:   50
   :caption:  Writing out SD data as CSV

..	_listing-anisou.py:

..  oe:source:: anisou.py
    :language: python
    :refnum:   51
    :caption:  Print anisotropic B-factors.

..	_listing-appendringdict.py:

..  oe:source:: appendringdict.py
    :language: python
    :refnum:   52
    :caption:  Append 2D ring dictionary.

..	_listing-applytransform.py:

..  oe:source:: applytransform.py
    :language: python
    :refnum:   53
    :caption:  Use a SMIRKS specification to perform individual reaction transformations on single molecules.

..	_listing-applytransformiter.py:

..  oe:source:: applytransformiter.py
    :language: python
    :refnum:   54
    :caption:  Use a SMIRKS specification to perform individual reaction transformations on each input molecule.

..	_listing-basicStyle.py:

..  oe:source:: basicStyle.py
    :language: python
    :refnum:   55
    :caption:  Setting up an OE3DMolStyle on a molecule.

..	_listing-bFactorStyle.py:

..  oe:source:: bFactorStyle.py
    :language: python
    :refnum:   56
    :caption:  OE3DMolStyle focused on B-Factor styling.

..	_listing-cansmi.py:

..  oe:source:: cansmi.py
    :language: python
    :refnum:   57
    :caption:  Generate canonical SMILES.

..	_listing-catmols.py:

..  oe:source:: catmols.py
    :language: python
    :refnum:   58
    :caption:  Concatenating molecules.

..	_listing-cifdata.py:

..  oe:source:: cifdata.py
    :language: python
    :refnum:   59
    :caption:  Creating an OECIFData Object.

..	_listing-cliquealign.py:

..  oe:source:: cliquealign.py
    :language: python
    :refnum:   60
    :caption:  Align molecules by clique match.

..	_listing-convert.py:

..  oe:source:: convert.py
    :language: python
    :refnum:   61
    :caption:  Convert molecules.

..	_listing-createringdict.py:

..  oe:source:: createringdict.py
    :language: python
    :refnum:   62
    :caption:  Create 2D ring dictionary.

..	_listing-csv2sdf.py:

..  oe:source:: csv2sdf.py
    :language: python
    :refnum:   63
    :caption:  Adding CSV data as SD tags.

..	_listing-dots.py:

..  oe:source:: dots.py
    :language: python
    :refnum:   64
    :caption:  Print dots.

..	_listing-extractringtemplates.py:

..  oe:source:: extractringtemplates.py
    :language: python
    :refnum:   65
    :caption:  Extract 2D ring templates.

..	_listing-extractscaffold.py:

..  oe:source:: extractscaffold.py
    :language: python
    :refnum:   66
    :caption:  Extract molecule scaffolds.

..	_listing-generate2D.py:

..  oe:source:: generate2D.py
    :language: python
    :refnum:   67
    :caption:  Generate 2D coordinates with user-defined ring templates.

..	_listing-gettitles.py:

..  oe:source:: gettitles.py
    :language: python
    :refnum:   68
    :caption:  Get molecule titles.

..	_listing-libgen.py:

..  oe:source:: libgen.py
    :language: python
    :refnum:   69
    :caption:  Library generation.

..	_listing-makefastss.py:

..  oe:source:: makefastss.py
    :language: python
    :refnum:   70
    :caption:  Generate database for fast substructure search.

..	_listing-mcs3dalign.py:

..  oe:source:: mcs3dalign.py
    :language: python
    :refnum:   71
    :caption:  Align molecules by maximum common substructure.

..	_listing-minpath.py:

..  oe:source:: minpath.py
    :language: python
    :refnum:   72
    :caption:  Find minimum path in a molecule.

..	_listing-molchunk.py:

..  oe:source:: molchunk.py
    :language: python
    :caption: Split molecule file.
    :refnum: 73

..	_listing-molcount.py:

..  oe:source:: molcount.py
    :language: python
    :caption: Counting molecules.
    :refnum: 74

..	_listing-molextract.py:

..  oe:source:: molextract.py
    :language: python
    :caption: Extract molecules by title.
    :refnum: 75

..	_listing-molgrep.py:

..  oe:source:: molgrep.py
    :language: python
    :caption: Perform substructure searches.
    :refnum: 76

..	_listing-molstats.py:

..  oe:source:: molstats.py
    :language: python
    :caption: Print simple molecule information.
    :refnum: 77

..	_listing-oecheminfo.py:

..  oe:source:: oecheminfo.py
    :language: python
    :caption: Print OEChem and file format information.
    :refnum: 78

..	_listing-options.py:

..  oe:source:: options.py
    :language: python
    :caption: Define parameters.
    :refnum: 79

..	_listing-parts2mols.py:

..  oe:source:: parts2mols.py
    :language: python
    :caption: Splitting multicomponent molecules.
    :refnum: 80

..	_listing-printatomnames.py:

..  oe:source:: printatomnames.py
    :language: python
    :caption: Print molecule atom names.
    :refnum: 81

..	_listing-randomizeatoms.py:

..  oe:source:: randomizeatoms.py
    :language: python
    :caption: Randomize molecules of atom.
    :refnum: 82

..	_listing-randomsample.py:

..  oe:source:: randomsample.py
    :language: python
    :caption: Extract random molecule subset.
    :refnum: 83

..	_listing-ringsubset.py:

..  oe:source:: ringsubset.py
    :language: python
    :caption: Extract rings.
    :refnum: 84

..	_listing-rmsd.py:

..  oe:source:: rmsd.py
    :language: python
    :caption: Align multiconformer molecules.
    :refnum: 85

..	_listing-rotorcount.py:

..  oe:source:: rotorcount.py
    :language: python
    :caption: Print rotor count distribution.
    :refnum: 86

..	_listing-sdf2csv.py:

..  oe:source:: sdf2csv.py
    :language: python
    :caption: Exporting SD data to a CSV file.
    :refnum: 87

..	_listing-sdfilter.py:

..  oe:source:: sdfilter.py
    :language: python
    :caption: Filter molecules by SD data.
    :refnum: 88

..	_listing-sdfmodprops.py:

..  oe:source:: sdfmodprops.py
    :language: python
    :caption: Modifying SD tags.
    :refnum: 89

..	_listing-sdfrename.py:

..  oe:source:: sdfrename.py
    :language: python
    :caption: Renaming molecules by SD field.
    :refnum: 90

..	_listing-searchfastss.py:

..  oe:source:: searchfastss.py
    :language: python
    :caption: Perform SMARTS search on substructure database file.
    :refnum: 91

..	_listing-setchemcomp.py:

..  oe:source:: setchemcomp.py
    :language: python
    :caption: Setting mmCIF Chemical Component Header.
    :refnum: 92

..	_listing-sizefilter.py:

..  oe:source:: sizefilter.py
    :language: python
    :caption: Filter molecules by weight or heavy atom count.
    :refnum: 93

..	_listing-smartsalign.py:

..  oe:source:: smartsalign.py
    :language: python
    :caption: Align molecules by SMARTS match.
    :refnum: 94

..	_listing-stripsalts.py:

..  oe:source:: stripsalts.py
    :language: python
    :caption: Strip salts.
    :refnum: 95

..	_listing-styleHierarchy.py:

..  oe:source:: styleHierarchy.py
    :language: python
    :caption: OE3DMolStyle hierarchy between molecule, conformers, and atoms.
    :refnum: 96

..	_listing-unimolrxn.py:

..  oe:source:: unimolrxn.py
    :language: python
    :caption: Performing a reaction.
    :refnum: 97

..	_listing-uniqinchi.py:

..  oe:source:: uniqinchi.py
    :language: python
    :caption: Write out unique molecules (InChi).
    :refnum: 98

..	_listing-uniqmol.py:

..  oe:source:: uniqmol.py
    :language: python
    :caption: Write out unique molecules (canonical SMILES).
    :refnum: 99


.. _chapter_stereochemistry:

********************************************************************************
Stereochemistry Perception
********************************************************************************

**OEChem TK** has the ability to store and retrieve stereochemical information for
atoms and bonds independent of two or three dimensional coordinates.
The current version of **OEChem TK** supports stereochemistry definitions of *handedness*
around tetrahedral centers, and *cis*/*trans* configuration around bonds.

The table below lists the available **OEChem TK** functions related to stereochemical
information.

   .. list-table::
      :widths: 100 200
      :header-rows: 1

      * - Name
        - Description

      * - :oe:func:`OEChem::OE3DToAtomStereo`
        - Set the stereochemistry at the chiral atoms of a molecule, as specified 
          by the molecule’s 3D coordinates.

      * - :oe:func:`OEChem::OE3DToBondStereo`
        - Set the stereochemistry at the chiral bonds of a molecule, as specified 
          by the molecule’s 3D coordinates. 

      * - :oe:func:`OEChem::OE3DToInternalStereo`
        - Assigns the stereochemistry of a molecule from its 3D coordinates.

      * - :oe:func:`OEChem::OEMDLClearBondStereo`
        - Clears the bond stereo fields from all bonds of a molecule.

      * - :oe:func:`OEChem::OEMDLCorrectBondStereo`
        - Corrects the wedge/hash bond assignment of the 2D molecule.

      * - :oe:func:`OEChem::OEMDLHasIncorrectBondStereo`
        - Checks whether the wedge/hash bond assignment of the 2D molecule is 
          inconsistent or ambiguous.

      * - :oe:func:`OEChem::OEMDLPerceiveBondStereo`
        - Assigns wedge and hash bonds to a connection table from the **OEChem TK** 
          stereochemistry of each atom of the 2D molecule.

      * - :oe:func:`OEChem::OEMDLStereoFromBondStereo`
        - Sets the **OEChem TK** stereochemistry of each atom of the 2D molecule 
          from the wedge and hash bonds in the connection table. 

      * - :oe:func:`OEChem::OEMDLStereoFromParity`
        - Sets the **OEChem TK** stereochemistry for each atom from the 
          MDL stereo parity information.

      * - :oe:func:`OEChem::OEPerceiveCIPStereo`
        - Perceives the Cahn-Ingold-Prelog descriptor for the given atom.

      * - :oe:func:`OEChem::OESetCIPStereo`
        - Sets the internal **OEChem TK** stereochemistry from the given CIP 
          atom stereo descriptor. 

.. _section_stereochemistry_atom:

Atom Chirality
================================================================================

The following two code snippets demonstrate how to loop over :term:`chiral<chiral atom>`
atoms using the :oe:cls:`OEIsChiralAtom<OEChem::OEIsChiralAtom>` functor and
the :oe:meth:`IsChiral<OEChem::OEAtomBase::IsChiral>` method of
the :oe:cls:`OEAtomBase<OEChem::OEAtomBase>` class.

.. oe:source:: PerceiveChiral.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-CHIRAL-ATOM-LOOP1

.. oe:source:: PerceiveChiral.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-CHIRAL-ATOM-LOOP2

.. oe:source:: PerceiveChiral.py
   :language: python
   :noindent:
   :frag:     SNIPPET-CHIRAL-ATOM-LOOP1

.. oe:source:: PerceiveChiral.py
   :language: python
   :noindent:
   :frag:     SNIPPET-CHIRAL-ATOM-LOOP2

.. oe:source:: PerceiveChiral.java
   :language: java
   :noindent:
   :frag:     SNIPPET-CHIRAL-ATOM-LOOP1

.. oe:source:: PerceiveChiral.java
   :language: java
   :noindent:
   :frag:     SNIPPET-CHIRAL-ATOM-LOOP2

.. oe:source:: PerceiveChiral.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-CHIRAL-ATOM-LOOP1

.. oe:source:: PerceiveChiral.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-CHIRAL-ATOM-LOOP2

.. warning::

   When a molecule is imported from a file, its atom and bond chirality are not
   automatically perceived, the user has to call :oe:func:`OEPerceiveChiral<OEChem::OEPerceiveChiral>`
   explicitly.

Atom Stereochemistry
================================================================================

..  The definition *handedness* in **OEChem TK** is demonstrated pictorially
    in the following table:

    .. list-table::
       :widths: 40 40
       :header-rows: 1

       * -  R-configuration
         -  S-configuration
       * - .. image:: images/stereo-example-R.png
              :scale: 100
              :align: center
         - .. image:: images/stereo-example-S.png
          :scale: 100
          :align: center
       * - .. image:: images/OEAtomStereo_RightHanded.*
          :scale: 100
          :align: center
         - .. image:: images/OEAtomStereo_LeftHanded.*
          :scale:  100
          :align:  center
       * - :oe:const:`OEChem::OEAtomStereo::RightHanded` (clockwise)
         - :oe:const:`OEChem::OEAtomStereo::LeftHanded` (counter-clockwise)

    Looking down the bond between atom number one (hydrogen) and the central atom (carbon),
    *handedness* is defined as the direction of travel from atom number
    two (chlorine) to atom number three (bromine).
    The direction of travel must always be along the acute angle formed by atom two (chlorine),
    the central atom (carbon), and atom three (bromine).
    Right handed and left handed directions of travel can also be thought of as *clockwise*
    and *counterclockwise*, respectively.

Stereochemistry around atoms can be set and retrieved by the
:oe:meth:`OEChem::OEAtomBase::SetStereo` and :oe:meth:`OEChem::OEAtomBase::GetStereo`
methods, respectively.
The :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` method returns a boolean value
that indicates whether stereochemical information of a particular type has been
stored for an atom.
**OEChem TK** currently only supports :oe:const:`OEChem::OEAtomStereo::Tetrahedral`
atom stereochemistry class.

Note that the setting and retrieval of atom stereo requires
a vector containing pointers to the neighboring atoms as the first argument.
The *handedness* value returned from :oe:meth:`OEChem::OEAtomBase::GetStereo` will
depend on the order of the neighboring atoms as they appear in the
passed vector.

The first neighbor atom in the vector passed to :oe:meth:`OEChem::OEAtomBase::GetStereo`
is taken as atom number one for the determination of *handedness*.
Likewise, subsequent atoms in the neighbor atom vector are assigned
sequentially to positions in the *handedness* definition.
Although, three neighboring atoms are sufficient to determine the
*handedness* around a trigonal pyramidal or tetrahedral center, either three or four
atoms can be provided to the :oe:meth:`OEChem::OEAtomBase::GetStereo` function
when requesting a value for tetrahedral chirality.
The following table shows the return values of :oe:meth:`OEChem::OEAtomBase::GetStereo`
method by passing the neighbor atoms in different order.

======================== ================= =================
neighbor order           [C@@H](Cl)(Br)N   [C@H](Cl)(Br)N   
======================== ================= =================
H Cl Br N                right handed      left handed
H Br Cl N                left handed       right handed
H Cl N Br                left handed       right handed
...                      ...               ...
Cl Br N                  left handed       right handed
Br Cl N                  right handed      left handed
Cl N Br                  right handed      left handed
======================== ================= =================

.. note::

   The definition of *handedness* for tetrahedral stereochemistry
   does not imply :term:`chirality<chiral atom>` around a tetrahedral center, but rather
   indicates relative positions of neighboring atoms.

The following code sample demonstrates looping over atoms, testing for
atoms that have tetrahedral stereochemistry, and printing out the
value of the tetrahedral stereochemistry (either
:oe:const:`OEChem::OEAtomStereo::RightHanded`,
:oe:const:`OEChem::OEAtomStereo::LeftHanded`, or
:oe:const:`OEChem::OEAtomStereo::Undefined`).  See also the input
structure depicted in :ref:`Figure: Atom stereo<figure_stereo_atom>`.

.. oe:source:: PrintAtomStereo.cpp
   :language: c++
   :refnum:   1
   :caption:  Accessing atom stereo information
   :frag:     SNIPPET

.. oe:source:: PrintAtomStereo.py
   :language: python
   :refnum:   1
   :caption:  Accessing atom stereo information
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-PrintAtomStereo.py>`

.. oe:source:: PrintAtomStereo.java
   :language: java
   :refnum:   1
   :caption:  Accessing atom stereo information
   :frag:     SNIPPET

.. oe:source:: PrintAtomStereo.cs
   :language: csharp
   :refnum:   1
   :caption:  Accessing atom stereo information
   :frag:     SNIPPET

The output of the preceding program is the following:

.. oe:language:: c++

   .. code-block:: bash

      Atom: 1 chiral=0 stereo=left handed
      Atom: 4 chiral=1 stereo=right handed
      Atom: 7 chiral=1 stereo=undefined
      Atom: 10 chiral=0 stereo=left handed
      Atom: 14 chiral=0 stereo=right handed

.. oe:language:: python

   .. code-block:: bash

      Atom: 1 chiral= False stereo= left handed
      Atom: 4 chiral= True stereo= right handed
      Atom: 7 chiral= True stereo= undefined
      Atom: 10 chiral= False stereo= left handed
      Atom: 14 chiral= False stereo= right handed

.. oe:language:: java csharp

   .. code-block:: bash

      Atom: 1 chiral=false stereo=left handed
      Atom: 4 chiral=true stereo=right handed
      Atom: 7 chiral=true stereo=undefined
      Atom: 10 chiral=false stereo=left handed
      Atom: 14 chiral=false stereo=right handed

.. _figure_stereo_atom:

.. figure:: oechemtk/images/AtomStereo.*
   :scale:  100
   :align:  center

   **Atom stereo**

As mentioned before, tetrahedral stereochemistry (*i.e.* specified
atom stereo) does not imply chirality around a tetrahedral center.
For example atoms 1, 10 and 14 in :ref:`Figure: Atom
stereo<figure_stereo_atom>` have specified atom stereo, even though
they are non-chiral.  *Vice versa*, atom can be :term:`chiral<chiral atom>`
but with unspecified atom stereo configuration (such as atom 7
in :ref:`Figure: Atom stereo<figure_stereo_atom>` ).  Atoms 1 and 6
are non-chiral but they have atom stereo information and they are
relative to each other.

The following example shows how to manually set the atom stereo of atom 7 (chiral, undefined)
to *left* by the :oe:meth:`OEChem::OEAtomBase::SetStereo` method.

.. oe:source:: SetAtomStereo.cpp
   :language: c++
   :refnum:   2
   :caption:  Setting atom stereo information
   :frag:     SNIPPET

.. oe:source:: SetAtomStereo.py
   :language: python
   :refnum:   2
   :caption:  Setting atom stereo information
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-SetAtomStereo.py>`

.. oe:source:: SetAtomStereo.java
   :language: java
   :refnum:   2
   :caption:  Setting atom stereo information
   :frag:     SNIPPET

.. oe:source:: SetAtomStereo.cs
   :language: csharp
   :refnum:   2
   :caption:  Setting atom stereo information
   :frag:     SNIPPET

The output of the preceding program is the following:

.. code-block:: bash

   [H][C@@]1([C@@H](C[C@H](CN1)N)CO[C@H]2CC[C@@H](CC2)O)[H]

Just as in :oe:meth:`OEChem::OEAtomBase::GetStereo`, the vector of neighbor atoms provide
the references about which the *handedness* is defined.
The first of the integer arguments is the stereochemistry type
(*i.e.* :oe:const:`OEChem::OEAtomStereo::Tetrahedral` (or just  :oe:const:`OEChem::OEAtomStereo::Tetra`) ,
and the second is the associated value
(*i.e.* :oe:const:`OEChem::OEAtomStereo::Right` or  :oe:const:`OEChem::OEAtomStereo::Left`).

.. _section_chirality_bond:

Bond Chirality
================================================================================

The following two code snippets demonstrate how to loop over :term:`chiral<chiral bond>`
bonds using the :oe:cls:`OEIsChiralBond<OEChem::OEIsChiralBond>` functor and
the :oe:meth:`IsChiral<OEChem::OEBondBase::IsChiral>` method of
the :oe:cls:`OEBondBase<OEChem::OEBondBase>` class.

.. oe:source:: PerceiveChiral.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-CHIRAL-BOND-LOOP1

.. oe:source:: PerceiveChiral.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-CHIRAL-BOND-LOOP2

.. oe:source:: PerceiveChiral.py
   :language: python
   :noindent:
   :frag:     SNIPPET-CHIRAL-BOND-LOOP1

.. oe:source:: PerceiveChiral.py
   :language: python
   :noindent:
   :frag:     SNIPPET-CHIRAL-BOND-LOOP2

.. oe:source:: PerceiveChiral.java
   :language: java
   :noindent:
   :frag:     SNIPPET-CHIRAL-BOND-LOOP1

.. oe:source:: PerceiveChiral.java
   :language: java
   :noindent:
   :frag:     SNIPPET-CHIRAL-BOND-LOOP2

.. oe:source:: PerceiveChiral.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-CHIRAL-BOND-LOOP1

.. oe:source:: PerceiveChiral.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-CHIRAL-BOND-LOOP2

.. warning::

   When a molecule is imported from a file, its atom and bond chirality are not
   automatically perceived, the user has to call :oe:func:`OEPerceiveChiral<OEChem::OEPerceiveChiral>`
   explicitly.

.. _section_stereochemistry_bond:

Bond Stereochemistry
================================================================================

Stereochemistry around bonds can be specified in a similar fashion to
stereochemistry about atom centers.
The request for stereochemistry of a particular class can be made of an
:ref:`OEBondBase <OEChem_OEBondBase>` using the method :oe:meth:`OEChem::OEBondBase::HasStereoSpecified`.
**OEChem TK** currently only supports :oe:const:`OEChem::OEBondStereo::CisTrans`
bond stereochemistry class that defines whether the configuration
of two atoms around a non-rotatable bond is *cis* or *trans*.
If a bond has associated stereochemical data, it can be retrieved
using :oe:meth:`OEChem::OEBondBase::GetStereo` method.

The following code sample demonstrates a loop over bonds that tests for
bonds with associated stereochemistry, and retrieval of whether the
neighboring atoms are *cis* or *trans* relative to one another.  (See
also the input structure depicted in :ref:`Figure: Bond
stereo<figure_stereo_bond>`.

.. oe:source:: PrintBondStereo.cpp
   :language: c++
   :refnum:   3
   :caption:  Accessing bond stereo information
   :frag:     SNIPPET

.. oe:source:: PrintBondStereo.py
   :language: python
   :refnum:   3
   :caption:  Accessing bond stereo information
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-PrintBondStereo.py>`

.. oe:source:: PrintBondStereo.java
   :language: java
   :refnum:   3
   :caption:  Accessing bond stereo information
   :frag:     SNIPPET

.. oe:source:: PrintBondStereo.cs
   :language: csharp
   :refnum:   3
   :caption:  Accessing bond stereo information
   :frag:     SNIPPET

The output of the preceding program is the following:

.. code-block:: bash

   Atoms: 0 and 3 are trans
   Atoms: 2 and 5 are cis

.. _figure_stereo_bond:

.. figure:: oechemtk/images/BondStereo.*
   :scale:  100
   :align:  center

   **Bond stereo**

Note that even though the double bond defined by atoms 4--5--6--7
is depicted as *trans* (see :ref:`Figure: Bond stereo<figure_stereo_bond>`)
it is still considered undefined, since no stereo information is encoded for this bond
in the input SMILES.

The following example shows how to manually set this missing bond stereo to *trans*
by the :oe:meth:`OEChem::OEBondBase::SetStereo` method.

.. oe:source:: SetBondStereo.cpp
   :language: c++
   :refnum:   4
   :caption:  Setting bond stereo information
   :frag:     SNIPPET

.. oe:source:: SetBondStereo.py
   :language: python
   :refnum:   4
   :caption:  Setting bond stereo information
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-SetBondStereo.py>`

.. oe:source:: SetBondStereo.java
   :language: java
   :refnum:   4
   :caption:  Setting bond stereo information
   :frag:     SNIPPET

.. oe:source:: SetBondStereo.cs
   :language: csharp
   :refnum:   4
   :caption:  Setting bond stereo information
   :frag:     SNIPPET

The first integer argument of the method :oe:meth:`OEChem::OEBondBase::SetStereo`
is used to specify the type of stereochemistry (*i.e.*
:oe:const:`OEChem::OEBondStereo::CisTrans`).
The second integer argument specifies the bond stereo configuration (*i.e.*
:oe:const:`OEChem::OEBondStereo::Cis` or :oe:const:`OEChem::OEBondStereo::Trans`)

The output of the preceding program is the following:

::

   C/C=C/C=C\C=C\C

.. _section_stereochemistry_CIP:

CIP Stereo Perception
================================================================================

The following two examples demonstrate how to perceive CIP (Cahn–Ingold–Prelog)
atom and bond stereo information from the molecules created by the SMILES 
representation. If the input molecule has 3D coordinates, the :oe:func:`OEChem::OE3DToInternalStereo` 
function should be called.

.. _figure_cip_atom_stereo:

.. figure:: oechemtk/images/CIPAtomStereo.*
   :scale:  100
   :align:  center

   **CIP atom stereo**

.. oe:source:: PrintCIPAtomStereo.cpp
   :language: c++
   :refnum:   5
   :caption:  Perceiving CIP atom stereo information
   :frag:     SNIPPET

.. oe:source:: PrintCIPAtomStereo.py
   :language: python
   :refnum:   5
   :caption:  Perceiving CIP atom stereo information
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-PrintCIPAtomStereo.py>`

.. oe:source:: PrintCIPAtomStereo.java
   :language: java
   :refnum:   5
   :caption:  Perceiving CIP atom stereo information
   :frag:     SNIPPET

.. oe:source:: PrintCIPAtomStereo.cs
   :language: csharp
   :refnum:   5
   :caption:  Perceiving CIP atom stereo information
   :frag:     SNIPPET

The :oe:func:`OEChem::OEPerceiveCIPStereo` function detects the Cahn-Ingold-Prelog
descriptor of the given atom and returns a value from the
:oe:constns:`OEChem::OECIPAtomStereo` namespace.

The output of :oe:src:`Listing 5<SNIPPET-PrintCIPAtomStereo>` is the following:
(See also the input structure depicted in :ref:`Figure: CIP atom stereo<figure_cip_atom_stereo>`.

::

  atom 1 is R
  atom 4 is S
  atom 8 is a CIP stereo center without specified stereochemistry
  atom 12 is not a CIP stereo center
  atom 17 is not a CIP stereo center

.. _figure_cip_bond_stereo:

.. figure:: oechemtk/images/CIPBondStereo.*
   :scale:  100
   :align:  center

   **CIP bond stereo**

.. oe:source:: PrintCIPBondStereo.cpp
   :language: c++
   :refnum:   6
   :caption:  Perceiving CIP bond stereo information
   :frag:     SNIPPET

.. oe:source:: PrintCIPBondStereo.py
   :language: python
   :refnum:   6
   :caption:  Perceiving CIP bond stereo information
   :frag:     SNIPPET

.. oe:language:: python

	:ref:`Full listing. <listing-PrintCIPBondStereo.py>`

.. oe:source:: PrintCIPBondStereo.java
   :language: java
   :refnum:   6
   :caption:  Perceiving CIP bond stereo information
   :frag:     SNIPPET

.. oe:source:: PrintCIPBondStereo.cs
   :language: csharp
   :refnum:   6
   :caption:  Perceiving CIP bond stereo information
   :frag:     SNIPPET

The :oe:func:`OEChem::OEPerceiveCIPStereo` function detects the Cahn-Ingold-Prelog
descriptor of the given bond and returns a value from the
:oe:constns:`OEChem::OECIPBondStereo` namespace.

The output of :oe:src:`Listing 6<SNIPPET-PrintCIPBondStereo>` is the following:
(See also the input structure depicted in :ref:`Figure: CIP bond stereo<figure_cip_bond_stereo>`.

::

  bond 2 is not a CIP stereo center
  bond 7 is Z
  bond 12 is E
  bond 17 is a CIP stereo center without specified stereochemistry



.. _chapter_oemolstyle:

********************************************************************************
Molecule Styling
********************************************************************************

.. _section_oe3dmolstyle:

OE3DMolStyle
================================================================================

An :ref:`OEMolBase <OEChem_OEMolBase>` has a default style without the addition 
of an :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. The :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` 
class gives a multitude of customization options for the :ref:`OEMolBase <OEChem_OEMolBase>`, 
from coloring to labeling. Outside of :ref:`OEMolBase <OEChem_OEMolBase>`, :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` 
can be applied to an :ref:`OEAtomBase <OEChem_OEAtomBase>` and an :ref:`OEConfBase <OEChem_OEConfBase>`. 
There is a hierarchy when applying :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` to each one of these classes: 
:ref:`OEMolBase <OEChem_OEMolBase>` -> :ref:`OEConfBase <OEChem_OEConfBase>` -> :ref:`OEAtomBase <OEChem_OEAtomBase>`. 

.. _section_oemolstyle_atomlabel:

Atom Labeling
================================================================================

Preset labels can be applied using :ref:`SetAtomLabelType<OEChem_OE3DMolStyle_SetAtomLabelType>`.
Custom labels can be applied to specific atoms utilizing :ref:`SetAtomLabelText<OEChem_OE3DMolStyle_SetAtomLabelText>`.
:ref:`SetAtomLabelType<OEChem_OE3DMolStyle_SetAtomLabelType>` takes in :ref:`OEAtomLabelScheme <OEChem_OEAtomLabelScheme>`.
The example below depicts the B-Factor above each one of the respective atoms in the molecule.

.. oe:language:: c++

   .. code-block:: c++

      OEMolBase mol;
      OE3DMolStyle molSty;
      molSty.SetAtomLabelType(OEAtomLabelScheme::BFactor);
      OESetStyle(mol1, molSty);

.. oe:language:: python

   .. code-block:: python

      mol = oechem.OEMol()
      molSty = oechem.OE3DMolStyle()
      molSty.SetAtomLabelType(oechem.OEAtomLabelScheme_BFactor)
      oechem.OESetStyle(mol, molSty)

.. _section_oemolstyle_stylestypes:

Styling and Typing
================================================================================

There are multiple styling and typing options for an :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>`. 
:ref:`OEAtomStyle <OEChem_OEAtomStyle>` can be set using :ref:`SetAtomStyle<OEChem_OE3DMolStyle_SetAtomStyle>`.
This allows for customization of the visibility of the atoms in a molecule, which ranges from hidden atoms 
to CPK atom styling. In the example below the atoms are set to display as Ball and Stick.

.. oe:language:: c++

   .. code-block:: c++

      OEMolBase mol;
      OE3DMolStyle molSty;
      molSty.SetAtomStyle(OEAtomStyle::BallAndStick);
      OESetStyle(mol1, molSty);

.. oe:language:: python

   .. code-block:: python

      mol = oechem.OEMol()
      molSty = oechem.OE3DMolStyle()
      molSty.SetAtomStyle(oechem.OEAtomStyle_BallAndStick)
      oechem.OESetStyle(mol, molSty)

:ref:`OEProteinStyle <OEChem_OEProteinStyle>` can be set utilizing :ref:`SetProteinStyle<OEChem_OE3DMolStyle_SetProteinStyle>`.
This allows for customization of the protein from hidden to ribbon. The example below set the protein style to CAlpha, which 
depicts the protein with edges at the CAlphas.

.. oe:language:: c++

   .. code-block:: c++

      OEMolBase mol;
      OE3DMolStyle molSty;
      molSty.SetProteinStyle(OEProteinStyle::CAlpha);
      OESetStyle(mol1, molSty);

.. oe:language:: python

   .. code-block:: python

      mol = oechem.OEMol()
      molSty = oechem.OE3DMolStyle()
      molSty.SetProteinStyle(oechem.OEProteinStyle_CAlpha)
      oechem.OESetStyle(mol, molSty)

:ref:`OEContourStyle <OEChem_OEContourStyle>` can be set utilizing :ref:`SetContourStyle<OEChem_OE3DMolStyle_SetContourStyle>`.
This allows for customization of the contour from hidden to solid. :ref:`SetGridType<OEChem_OE3DMolStyle_SetGridType>`
takes in the :ref:`OEStyleGridType <OEChem_OEStyleGridType>` constant to specify the type of the grid being depicted. The example below
set the grid style to mesh and the drid type to electrostatic. This will depict the grid in mesh form for better visibility of 
the other components of the molecule.

.. oe:language:: c++

   .. code-block:: c++

      OEMolBase mol;
      OE3DMolStyle molSty;
      molSty.SetContourStyle(OEContourStyle::Mesh);
      molSty.SetGridType(OEStyleGridType::Electrostatic);
      OESetStyle(mol1, molSty);

.. oe:language:: python

   .. code-block:: python

      mol = oechem.OEMol()
      molSty = oechem.OE3DMolStyle()
      molSty.SetContourStyle(oechem.OEContourStyle_Mesh)
      molSty.SetGridType(oechem.OEStyleGridType_Electrostatic)
      oechem.OESetStyle(mol, molSty)

:ref:`SetSurfaceStyle<OEChem_OE3DMolStyle_SetSurfaceStyle>` utilizes :ref:`OEChem_OESurfaceStyle` to
depict the surface by mesh, point, and solid. :ref:`OESurfaceType <OEChem_OESurfaceType>` allows for surface typing when
set by :ref:`SetSurfaceType<OEChem_OE3DMolStyle_SetSurfaceType>`. The example below style a molecular surface
to be depicted in points.

.. oe:language:: c++

   .. code-block:: c++

      OEMolBase mol;
      OE3DMolStyle molSty;
      molSty.SetSurfaceStyle(OESurfaceStyle::Points);
      molSty.SetSurfaceType(OESurfaceType::Molecular);
      OESetStyle(mol1, molSty);

.. oe:language:: python

   .. code-block:: python

      mol = oechem.OEMol()
      molSty = oechem.OE3DMolStyle()
      molSty.SetSurfaceStyle(oechem.OESurfaceStyle_Points)
      molSty.SetSetSurfaceTypeGridType(oechem.OESurfaceType_Molecular)
      oechem.OESetStyle(mol, molSty)

Hydrogen visibility is customizable by utilizing :ref:`OEHydrogenVisibility <OEChem_OEHydrogenVisibility>` in
:ref:`SetHydrogenVisibility<OEChem_OE3DMolStyle_SetHydrogenVisibility>`. This allows for all
hydrogen, polar hydrogen, and hidden hydrogen depictions. In the example below sets up an 
:ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` to only depict the polar hydrogens in the molecule. 

.. oe:language:: c++

   .. code-block:: c++

      OEMolBase mol;
      OE3DMolStyle molSty;
      molSty.SetHydrogenVisibility(OEHydrogenVisibility::Polar);
      OESetStyle(mol1, molSty);

.. oe:language:: python

   .. code-block:: python

      mol = oechem.OEMol()
      molSty = oechem.OE3DMolStyle()
      molSty.SetHydrogenVisibility(oechem.OEHydrogenVisibility_Polar)
      oechem.OESetStyle(mol, molSty)

Atom to atom interactions is depicted using arrows from one atom to another. By default this is set to off. 
:ref:`SetInteractionStyle<OEChem_OE3DMolStyle_SetInteractionStyle>` utilizes :ref:`OEInteractionStyle <OEChem_OEInteractionStyle>`
to toggle between intermolecular hydrogen bond interaction depiction, intramolecular hydrogen bond interaction depiction, 
and no bond interaction depiction. In this example we set the the interaction style to intramolecular hydrogen bond depiction.

.. oe:language:: c++

   .. code-block:: c++

      OEMolBase mol;
      OE3DMolStyle molSty;
      molSty.SetInteractionStyle(OEInteractionStyle::IntramolecularHBonds);
      OESetStyle(mol1, molSty);

.. oe:language:: python

   .. code-block:: python

      mol = oechem.OEMol()
      molSty = oechem.OE3DMolStyle()
      molSty.SetInteractionStyle(oechem.OEInteractionStyle_IntramolecularHBonds)
      oechem.OESetStyle(mol, molSty)

.. _section_oemolstyle_colorer:

Colorer
================================================================================

Multple aspects of the molecule can be colored when :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` 
takes advantage of :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>`. There are preset color 
schemes for all parts of the molecule from atoms to protein, but custom colors can also be added for 
better personalization of the molecule.

:ref:`OEAtomColorScheme <OEChem_OEAtomColorScheme>` provides multple preset atom color schemes when specified in the construction
of an :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>`. :ref:`SetAtomColorer<OEChem_OE3DMolStyle_SetAtomColorer>`
takes in the :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>`. Atoms are colored by element by default, but this allows 
for coloring by b factor, residues, formal charge, and other aspects of the atoms and/or molecule. The labels of an atom can 
also be colored when an :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>` with a default color and/or custom colors by atom 
name or atomic number. The color of a grid can also be set with a default color specified in an :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>`.
The :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>` with the default color can be set to the :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` 
with :ref:`SetGridContourColorer<OEChem_OE3DMolStyle_SetGridContourColorer>`.

:ref:`OESurfaceColorScheme <OEChem_OESurfaceColorScheme>` provides customization of surfaces with preset color schemes. These color schemes
are applied similarly to how atom color schemes are applied but by utilizing :ref:`SetSurfaceColorer<OEChem_OE3DMolStyle_SetSurfaceColorer>`.
When a color scheme isn't specified the surface is colored by the default color, by default the surface is colored blue.

Proteins can be colored utilizing a color scheme from :ref:`OEProteinColorScheme <OEChem_OEProteinColorScheme>` but it can also colored
with a constant from :ref:`OEAtomColorScheme <OEChem_OEAtomColorScheme>`. The :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>` utilized for the protein
can be set to the :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` with :ref:`SetProteinColorer<OEChem_OE3DMolStyle_SetProteinColorer>`.
The example below adds the different coloring options to the molecule. The protein is colored by residue. The atoms are colored by element, 
with a default color of white, but the :ref:`OEMolStyleColorer <OEChem_OEMolStyleColorer>` also overwrites preset colors of certain atoms by atomic number. 
The grid is colored pink and the surface is colored by surface potential.

.. oe:language:: c++

   .. code-block:: c++

      OEMolBase mol;
      OE3DMolStyle molSty;
      OEMolStyleColorer protCol(OEAtomColorScheme::Residue);
      OEMolStyleColorer atomCol(OEAtomColorScheme::Element, OEWhite);
      OEMolStyleColorer gridCol(OEPink);
      OEMolStyleColorer surfCol(OESurfaceColorScheme::SurfacePotential);

      atomCol.AddColor(6, OEGreen);
      atomCol.AddColor(7, OERed);
      atomCol.AddColor(8, OEBlue);

      molSty.SetAtomColorer(atomCol);
      molSty.SetProteinColorer(protCol);
      molSty.SetGridContourColorer(gridCol);
      molSty.SetSurfaceColorer(surfCol);
      OESetStyle(mol1, molSty);

.. oe:language:: python

   .. code-block:: python

      mol = oechem.OEMol()
      molSty = oechem.OE3DMolStyle()
      protCol = oechem.OEMolStyleColorer(oechem.OEAtomColorScheme_Residue)
      atomCol = oechem.OEMolStyleColorer(oechem.OEAtomColorScheme_Element, oechem.OEWhite)
      gridCol = oechem.OEMolStyleColorer(OEPink)
      surfCol = oechem.OEMolStyleColorer(OESurfaceColorScheme::SurfacePotential)

      atomCol.AddColor(6, oechem.OEGreen)
      atomCol.AddColor(7, oechem.OERed)
      atomCol.AddColor(8, oechem.OEBlue)
    

      molSty.SetAtomColorer(atomCol)
      molSty.SetProteinColorer(protCol)
      molSty.SetGridContourColorer(gridCol)
      molSty.SetSurfaceColorer(surfCol)
      oechem.OESetStyle(mol, molSty)

.. seealso::

   * :ref:`basicStyle<section_example_oechem_basicmolstyle>` example
   * :ref:`bFactorStyle<section_example_oechem_bFactorStyle>` example
   * :ref:`styleHierarchy<section_oechem_example_stylehierarchy>` example

======
Theory
======

.. _oechem_part_theory:

********************************
OEChem Theory
********************************

.. rubric:: Introduction to Molecules

.. toctree::

   molctordtor
   molreadwrite
   moltaggeddata

.. rubric:: Atoms and Bonds

.. toctree::

   atombondtraversal
   atombondindices
   atomproperties
   bondproperties
   valence

.. rubric:: Molecules

.. toctree::

   molproperties
   ring
   aromaticity
   connectivity
   stereochemistry
   charges
   2Dcoordinates
   style

.. rubric:: Molecule Algorithms

.. toctree::

   patternmatch
   mdlqueries
   reactions

.. rubric:: Advanced OEChem

.. toctree::

   oemol
   moldatabase
   designdecisions
   multithreading
   predicates
   oemolrecord

.. rubric:: Reference Appendices

.. toctree::

   periodictable
   SMILES
   SMARTS
   atomstereo
   inchivalidation

.. _oesystem_part_theory:

********************************
OESystem Theory
********************************

.. toctree::

   interface_new
   interface
   genericdata
   oerecord

.. _oeplatform_part_theory:

.. ################################
.. OEPlatform Theory
.. ################################

.. toctree:

   ioutils

.. _oebio_part_theory:

********************************
OEBio Theory
********************************

.. rubric:: Working With Macromolecules

.. toctree::

   biopolymers
   proteinprep
   mmolconformations
   interactions
   receptor

.. _oegrid_part_theory:

********************************
OEGrid Theory
********************************

.. toctree::

   grids



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _chapter_valence:

********************************************************************************
Valence Models
********************************************************************************

.. index:: valence models

This section describes the three valence models currently implemented by
**OEChem TK**.

#. For molecules that have fully specified formal charges, the MDL valence model
   may be used to assign hydrogen counts.
   (See section :ref:`section_valence_mdl`.)
#. For molecules that have fully specified hydrogen counts, the OpenEye ''charge''
   model may be used to assign formal charges.
   (See section :ref:`subsection_valence_openeye_charge`.)
#. Finally, for molecules with neither formal charges nor hydrogen counts,
   **OEChem TK** uses the OpenEye hydrogen count model to assign both hydrogen
   counts and formal charges.
   (See section :ref:`subsection_valence_openeye_hydrogen`.)

.. _section_valence_mdl:

MDL Valence Model
================================================================================

.. seealso::

   The following APIs support the **MDL valence model**:

   * :oe:func:`OEChem::OEDefaultMDLHCount` function
   * :oe:func:`OEChem::OEAssignMDLHydrogens` function
   * :oe:func:`OEChem::OEMDLGetValence` function
   * :oe:cls:`OEChem::OEIsValidMDLAtomValence` predicate

.. index::
   single: valence models; MDL valence model

The MDL valence model was developed by MDL to allow hydrogen counts to be
implicit in MDL SD and MOL file formats.  MDL valence is simply the number of
covalent bonds to an atom (i.e., the sum of the bond orders), not the number of bonded neighbors.
It assumes that the bond orders to an atom are specified (explicit valence), and
that the atomic number and formal charge are correctly set.
The MDL valence model then prescribes the number of implicit hydrogens on a
particular atom. The periodic table graphic :ref:`below<figure_mdlvalence>` shows the MDL valence model as implemented in
**OEChem TK**.

The valence rules are,

* For transition metals, lanthanides and actinides, all valences are allowed which
  means that implicit hydrogen counts will never be applied.

* For the main group elements, allowed valences are listed parenthetically for each atom in the graphic below.

* Charges are handled by a simple shift: for positive and negative charges, convert the charged
  atom to its isoelectronic neutral atom; positive charges move atoms to the left and negative charges
  move the atom to the right in the periodic table, skipping the transition metal block.
  Thus, ``C+`` is considered to be isoelectronic to ``B``, ``C(+2)`` is equivalent to ``Be``,
  ``C(-1)`` is equivalent to ``N``, and ``C(-2)`` is equivalent to ``O``.

* If the isolectronic version of a charged atom is a Group I or II atom, no implicit hydrogen counts are applied (e.g., ``Sn(+2)``)

* A charged atom is considered an illegal valence if its neutral isolectronic atom type wraps beyond a noble
  gas configuration (e.g., ``Li(+2)`` or ``F(-2)``)

.. _figure_mdlvalence:

.. figure:: oechemtk/images/MDL_valence.*
   :align:  center

   **MDL Valence Model**

.. _section_valence_openeye:

OpenEye Valence Model
================================================================================

.. seealso::

   The following APIs support the **OpenEye valence model**:

   * :oe:func:`OEChem::OEDefaultImplicitHCount` function
   * :oe:func:`OEChem::OEAssignImplicitHydrogens` function
   * :oe:func:`OEChem::OEAssignFormalCharges` function
   * :oe:func:`OEChem::OECheckAtomValence` function
   * :oe:func:`OEChem::OECheckAtomValences` function
   * :oe:cls:`OEChem::OEIsValidAtomValence` predicate

.. _subsection_valence_openeye_charge:

OpenEye Charge Model
--------------------------------------------------------------------------------

.. index::
   single: valence models;  OpenEye charge valence model

The *OpenEye* formal charge model assigns formal charges to elements based upon
their total valence.
In **OEChem TK**, this functionality is invoked by the
:oe:func:`OEAssignFormalCharges<OEChem::OEAssignFormalCharges>` function.
If the formal charge on an atom is non-zero, it is left unchanged.

**Hydrogen**
  If the valence isn't one, the formal charge is +1.

**Boron**
  If the valence is four, the formal charge is +1.

**Carbon**
  If the valence is three, the formal charge is +1 if the atom has
  a polar neighbor, *i.e.* N, O or S, and formal charge -1 otherwise.

**Nitrogen**
  If the valence is two, the formal charge is -1, and if the
  valence is four the formal charge is +1.

**Oxygen**
  If the valence is one, the formal charge is -1, and if the
  valence is three the formal charge is +1.

**Phosphorous**
  If the valence is four, the formal charge is +1.

**Sulfur**
  If the valence is 1, the formal charge is -1, if the valence is three the
  formal charge is +1, if the valence is 5, the formal charge is -1, if
  the valence is four and the degree is four the charge is +2.

**Chlorine**
  If the valence is 0 the formal charge is -1, if the valence is
  four the formal charge is +3.

**Fluorine, Bromine, Iodine**
  If the valence is zero, the formal charge is -1.

**Magnesium, Calcium, Zinc**
  If the valence is zero, the formal charge is +2.

**Lithium, Sodium, Potassium**
  If the valence is zero, the formal charge is +1.

**Iron**
  If the valence is zero, the formal charge is +3 if the partial
  charge is 3.0, and +2 otherwise.

**Copper**
  If the valence is zero, the formal charge is +2 if the partial
  charge is 2.0, and +1 otherwise.

For the remaining elements, if the valence of an atom is zero, its formal charge
is set from its partial charge.

.. _subsection_valence_openeye_hydrogen:

OpenEye Hydrogen Count Model
--------------------------------------------------------------------------------

.. index::
   single: valence models;  OpenEye hydrogen count valence model

*OpenEye*'s hydrogen count valence model is used by **OEChem TK** when neither hydrogen
counts nor valence are specified.
The typical uses are reading molecules from PDB or XYZ format files without explicit
hydrogens.
This functionality is invoked by
:oe:func:`OEAssignImplicitHydrogens<OEChem::OEAssignImplicitHydrogens>`, which must
always be followed by a call to
:oe:func:`OEAssignFormalCharges<OEChem::OEAssignFormalCharges>`.
This valence model is unique in that it only partially updates hydrogen counts,
assuming the unfilled valences will be corrected by *OpenEye*'s charge valence
model above.
In MDL's model for example, a neutral sodium atom is assumed to have one implicit hydrogen,
*i.e.* sodium hydride instead of sodium metal.
In *OpenEye*'s hydrogen count valence model, a disconnected sodium atom is assumed
to be a sodium cation, ``[Na+]``.
When reading from PDB files, this is a very reasonable assumption.

Note that although the *OpenEye* hydrogen count valence model often sets charge
and protonation states to physiological conditions, it is neither intended to
be a pKa nor ionization state predictor.  Instead, it is a normalization.
Much like many registry systems and the MDL valence model which will convert
``C(=O)[O-]`` to ``C(=O)O`` for registration purposes, this valence
model converts the opposite direction to ``C(=O)[O-]``.

* **Carbon** is always assumed to be at least four valent, and therefore
  neutral.

* **Nitrogens** that are conjugated (have double bonds, or have neighbors that
  have double bonds, in their  |Kekule| representations) are assumed at least
  three valent and neutral, whilst all other nitrogens are assumed to be
  (minimum) four valent, with a +1 formal charge.

* **Oxygens** are assumed to be at least two valent and neutral, unless they
  have a single bond to an atom that is doubly bonded to oxygen, in which case
  it's assumed to be one valent, with a -1 formal charge.

* **Sulfur** is assumed to always be at least two valent.

All other elements are assumed to have no implicit hydrogens, and the formal
charge as specified by the *OpenEye* charge model.  This models all disconnected
halogens as halide anions, and when disconnected the metals listed above as
cations.

These rules are sufficient to reasonably protonate proteins read from PDB
files.
However, as described above, these rules are not intended to be a comprehensive
rule-based pKa predictor.
Users interested in predicting physiological ionization, and
protonation/disassociation state enumeration should contact *OpenEye, Cadence Molecular Sciences*
(http://www.eyesopen.com/) about our tools for exactly this task.


.. depicttk toolkit documentation master file

#################################
OEDepict Toolkit |depict_version|
#################################

.. toctree::
   :maxdepth: 2

   introduction
   theory
   examples
   api
   appendices

..  oe:language:: python

    .. toctree::
       :maxdepth: 1

       selected_examples_python
   
.. toctree::
   :maxdepth: 2

   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt




.. _oedepict_chapter_intro:

********************************************************************************
Introduction
********************************************************************************

**OEDepict TK** provides functionalities to render chemical structures and
output molecule depictions to a wide range of graphical file formats.

In addition to standard depiction routines, **OEDepict TK** provides a powerful
graphics engine which supports:

* :ref:`Basic shape drawing <chapter_basic>`
* :ref:`Highly customizable molecule depiction <chapter_mol_display>`
* :ref:`Variety of highlighting styles <chapter_highlighting>`
* :ref:`Customizable layout options <chapter_image_layout>`
* :ref:`Depictions aligned by MCS or substructure <chapter_molalign>`
* :ref:`MDL Query <chapter_mdlquery>` and :ref:`MDL Reaction <chapter_mdlreaction>` depictions


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OE2DAtomDisplay, 2DAtomDisplay

.. _OEDepict_OE2DAtomDisplay:

.. oe:class:: OE2DAtomDisplay

   .. oe:api::

      class OE2DAtomDisplay : public OEAtomDisplayBase

   This class stores 2D depiction information of an atom.
   See :ref:`Figure: OEDepict TK atom display class hierarchy<figure_OE2DAtomDisplay_Hierarchy>`.

   .. _figure_OE2DAtomDisplay_Hierarchy:

   .. figure:: depicttk/images/OEAtomDisplayHierarchy.*
      :align:  center

      **OEDepict TK atom display class hierarchy**

   The following figure
   (:ref:`Figure: Example of the layout of an atom<figure_OE2DAtomDisplay_Layout>`)
   illustrates how atoms are rendered in the **OEDepict TK**.

   * The atom label is positioned at the coordinates returned by the
     :oe:meth:`OEDepict::OE2DAtomDisplay::GetCoords` method.
     The string that is rendered as an atom label is returned by the
     :oe:meth:`OEDepict::OE2DAtomDisplay::GetLabel` method.

   * If the atom has a charge, then it is rendered as a super-script
     on the right side of the atomic label.

     .. seealso::

        * :oe:meth:`OEDepict::OE2DAtomDisplay::GetCharge` method

   * If the atom has isotope information, then it is rendered as a super-script
     on the left side of the atomic label.

     .. seealso::

        * :oe:meth:`OEDepict::OE2DAtomDisplay::GetMass` method

   * If the atom has implicit hydrogen(s), then the *hydrogen label*
     is positioned in a cardinal direction relative to
     the *atomic label*.
     The number of implicit hydrogens and the position can be accessed
     by calling the :oe:meth:`OEDepict::OE2DAtomDisplay::GetHCount`
     and the :oe:meth:`OEDepict::OE2DAtomDisplay::GetHPosition` methods,
     respectively.

     .. seealso::

        * :oe:constns:`OEDepict::OEHydrogenStyle` namespace
        * :oe:constns:`OEDepict::OEHydrogenPos` namespace

   * All labels (isotope, atomic, charge and explicit hydrogen) has the
     same color that is associated with the atomic number.

     .. seealso::

        * :oe:constns:`OEDepict::OEAtomColorStyle` namespace
        * :ref:`chapter_element_color` chapter

   .. _figure_OE2DAtomDisplay_Layout:

   .. figure:: depicttk/images/OE2DAtomDisplay_Layout.*
      :align:  center

      **Example of the layout of an atom**

   The following methods are publicly inherited from :ref:`OEAtomDisplayBase <OEDepict_OEAtomDisplayBase>`:

   ================================================================ =============================================================== ===============================================================
   :oe:meth:`GetDataType<OEDepict::OEAtomDisplayBase::GetDataType>` :oe:meth:`IsDataType<OEDepict::OEAtomDisplayBase::IsDataType>`  :oe:meth:`SetVisible<OEDepict::OEAtomDisplayBase::SetVisible>`
   :oe:meth:`GetAtom<OEDepict::OEAtomDisplayBase::GetAtom>`         :oe:meth:`IsVisible<OEDepict::OEAtomDisplayBase::IsVisible>`
   ================================================================ =============================================================== ===============================================================

   The :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - rendered formal charge
        - :oe:meth:`GetCharge<OEDepict::OE2DAtomDisplay::GetCharge>`
        - :oe:meth:`SetCharge<OEDepict::OE2DAtomDisplay::SetCharge>`
        - integer

      * - position of the atom label
        - :oe:meth:`GetCoords<OEDepict::OE2DAtomDisplay::GetCoords>`
        - :oe:meth:`SetCoords<OEDepict::OE2DAtomDisplay::SetCoords>`
        - :ref:`OE2DPoint <OEDepict_OE2DPoint>` class

      * - hydrogen count
        - :oe:meth:`GetHCount<OEDepict::OE2DAtomDisplay::GetHCount>`
        - :oe:meth:`SetHCount<OEDepict::OE2DAtomDisplay::SetHCount>`
        - unsigned int

      * - position of hydrogen label
        - :oe:meth:`GetHPosition<OEDepict::OE2DAtomDisplay::GetHPosition>`
        - :oe:meth:`SetHPosition<OEDepict::OE2DAtomDisplay::SetHPosition>`
        - :oe:constns:`OEDepict::OEHydrogenPos` namespace

      * - rendered atom label
        - :oe:meth:`GetLabel<OEDepict::OE2DAtomDisplay::GetLabel>`
        - :oe:meth:`SetLabel<OEDepict::OE2DAtomDisplay::SetLabel>`
        - string

      * - font of atom label
        - :oe:meth:`GetLabelFont<OEDepict::OE2DAtomDisplay::GetLabelFont>`
        - :oe:meth:`SetLabelFont<OEDepict::OE2DAtomDisplay::SetLabelFont>`
        - :ref:`OEFont <OEDepict_OEFont>` class

      * - rendered isotope number
        - :oe:meth:`GetMass<OEDepict::OE2DAtomDisplay::GetMass>`
        - :oe:meth:`SetMass<OEDepict::OE2DAtomDisplay::SetMass>`
        - integer

      * - rendered string as property
        - :oe:meth:`GetProperty<OEDepict::OE2DAtomDisplay::GetProperty>`
        - :oe:meth:`SetProperty<OEDepict::OE2DAtomDisplay::SetProperty>`
        - string

      * - font of property string
        - :oe:meth:`GetPropertyFont<OEDepict::OE2DAtomDisplay::GetPropertyFont>`
        - :oe:meth:`SetPropertyFont<OEDepict::OE2DAtomDisplay::SetPropertyFont>`
        - :ref:`OEFont <OEDepict_OEFont>` class

      * - position of property label
        - :oe:meth:`GetPropertyOffset<OEDepict::OE2DAtomDisplay::GetPropertyOffset>`
        - :oe:meth:`SetPropertyOffset<OEDepict::OE2DAtomDisplay::SetPropertyOffset>`
        - :ref:`OE2DPoint <OEDepict_OE2DPoint>` class

      * - rendered radical type
        - :oe:meth:`GetRadical<OEDepict::OE2DAtomDisplay::GetRadical>`
        - :oe:meth:`SetRadical<OEDepict::OE2DAtomDisplay::SetRadical>`
        - :oe:constns:`OEDepict::OERadicalDisplayType` namespace

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DAtomDisplay(const OEChem::OEAtomBase* atom)

      .. oe:language:: python

         .. oe:api:: python

            OE2DAtomDisplay(arg2: OEAtomBase) -> OE2DAtomDisplay

      Construct an :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object that
      contains the style information for ``atom``.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DAtomDisplay(const OE2DAtomDisplay& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DAtomDisplay(rhs: OE2DAtomDisplay) -> OE2DAtomDisplay

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE2DAtomDisplay &operator=(const OE2DAtomDisplay &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

      Deep copy constructor that returns a pointer to a copy of the
      object.  The memory returned is dynamically allocated and owned
      by the caller.

   .. oe:method:: GetCharge

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetCharge() const

      .. oe:language:: python

         .. oe:api:: python

            GetCharge() -> int

      Returns the charge rendered next to the atomic label.
      See example in :ref:`Figure: Example of charge representation<figure_OE2DAtomDisplay_GetCharge>`.
      The number will be rendered in the following ways:

      :0: nothing is rendered
      :-1: negative sign "-" is rendered
      :1: positive sign "+" is rendered
      :less than -1: "-<n>" is rendered
      :greater than 1: "+<n>" is rendered

      .. _figure_OE2DAtomDisplay_GetCharge:

      .. figure:: depicttk/images/OE2DAtomDisplay-GetCharge.*
         :align:  center

         **Example of charge representation**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetCharge` method

   .. oe:method:: GetCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OE2DPoint& GetCoords() const

      .. oe:language:: python

         .. oe:api:: python

            GetCoords() -> OE2DPoint

      Returns the coordinates of the atom in the coordinate system that
      is defined when a :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object is
      constructed with a specific width and height. This is the
      exact location of the atom when it is rendered into an image.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetCoords` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` method

   .. oe:method:: GetHCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetHCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetHCount() -> int

      Returns the hydrogen count to render for this atom.
      See example in :ref:`Figure: Example of hydrogen count representation<figure_OE2DAtomDisplay_GetHCount>`.
      The number will be rendered in the following ways:

      :0: no "H" label is rendered
      :1: "H" is rendered next to the atomic label
      :greater than 1: this number is rendered as a
        sub-script of the "H" label

      .. _figure_OE2DAtomDisplay_GetHCount:

      .. figure:: depicttk/images/OE2DAtomDisplay-GetHCount.*
         :align:  center

         **Example of hydrogen count representation**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetHCount` method
         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetHPosition` method

   .. oe:method:: GetHPosition

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetHPosition() const

      .. oe:language:: python

         .. oe:api:: python

            GetHPosition() -> int

      Returns the position of the hydrogen label relative to the
      atomic label.  The return value is taken from the
      :oe:constns:`OEDepict::OEHydrogenPos` namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetHPosition` method
         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetHCount` method
         * :oe:constns:`OEDepict::OEHydrogenPos` namespace

   .. oe:method:: GetLabel

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetLabel() const

      .. oe:language:: python

         .. oe:api:: python

            GetLabel() -> str

      Returns the string that is rendered as the atomic label at the
      coordinates returned by the
      :oe:meth:`OEDepict::OE2DAtomDisplay::GetCoords` method.
      The color of the font is set by the

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetLabel` method

   .. oe:method:: GetLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont& GetLabelFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetLabelFont() -> OEFont

      Returns the font that is used when rendering the atomic label
      string of the :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetLabelFont` method
         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetLabel` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. oe:method:: GetMass

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMass() const

      .. oe:language:: python

         .. oe:api:: python

            GetMass() -> int

      Returns the isotope information rendered as a super-script next
      to the atomic label. If zero, nothing is rendered.
      See example in :ref:`Figure: Example of isotope representation<figure_OE2DAtomDisplay_GetMass>`.

      .. _figure_OE2DAtomDisplay_GetMass:

      .. figure:: depicttk/images/OE2DAtomDisplay-GetMass.*
         :align:  center

         **Example of isotope representation**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetMass` method

   .. oe:method: GetPen # IGNORE CURRENTLY NOT USED

      .. oe:api::

         const OEPen &GetPen() const

   .. oe:method:: GetProperty

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetProperty() const

      .. oe:language:: python

         .. oe:api:: python

            GetProperty() -> str

      Returns the string rendered next to the atom. If the string is
      empty, nothing is rendered.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetProperty` method
         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetPropertyFont` method

   .. oe:method:: GetPropertyFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont& GetPropertyFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetPropertyFont() -> OEFont

      Returns the font that is used when rendering the property string of the
      :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetPropertyFont` method
         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetProperty` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. oe:method:: GetPropertyOffset

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OE2DPoint& GetPropertyOffset() const

      .. oe:language:: python

         .. oe:api:: python

            GetPropertyOffset() -> OE2DPoint

      Returns the offset vector relative to the coordinates returned
      by :oe:meth:`OEDepict::OE2DAtomDisplay::GetCoords` that is used
      to position the property label of the atom. These vectors are
      calculated during :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` construction
      to minimize potentially clashing with the rest of the
      depiction.
      See :ref:`Figure: The property offset vector is relative to coordinates returned by
      the GetCoords method<figure_OE2DAtomDisplay_GetPropertyOffset>`.

      .. _figure_OE2DAtomDisplay_GetPropertyOffset:

      .. figure:: depicttk/images/OE2DAtomDisplay-GetPropertyOffset.*
         :align:  center

         **The property offset vector is relative to coordinates returned by
         the OE2DAtomDisplay::GetCoords method**

      This allows for any string representable information to be
      rendered at a logical location near the atom.
      See example in :ref:`Example of indices as an atom property<figure_OE2DAtomDisplay_GetProperty>`.

      .. _figure_OE2DAtomDisplay_GetProperty:

      .. figure:: depicttk/images/OE2DAtomDisplay-GetProperty.*
         :align:  center

         **Example of indices as an atom property**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetPropertyOffset` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class

   .. oe:method:: GetRadical

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRadical() const

      .. oe:language:: python

         .. oe:api:: python

            GetRadical() -> int

      Returns the radical display type of the atom.  The return value
      is taken from the :oe:constns:`OEDepict::OERadicalDisplayType`
      namespace.
      See example in :ref:`Example of rendering radicals<figure_OE2DAtomDisplay_GetRadical>`.

      .. _figure_OE2DAtomDisplay_GetRadical:

      .. figure:: depicttk/images/OE2DAtomDisplay-GetRadical.*
         :align:  center

         **Example of rendering radicals**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetRadical` method
         * :oe:constns:`OEDepict::OERadicalDisplayType` namespace

   .. oe:method:: HasLabel

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasLabel() const

      .. oe:language:: python

         .. oe:api:: python

            HasLabel() -> bool

      Returns whether or not the atomic label string of the
      :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object is empty.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::GetLabel` method
         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetLabel` method

   .. oe:method:: HasProperty

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasProperty() const

      .. oe:language:: python

         .. oe:api:: python

            HasProperty() -> bool

      Returns whether or not the property string of the
      :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object is empty.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::GetProperty` method
         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetProperty` method

   .. oe:method:: SetCharge

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCharge(int charge)

      .. oe:language:: python

         .. oe:api:: python

            SetCharge(charge: int) -> None

      Sets the charge rendered next to the atomic label.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::GetCharge` method

   .. oe:method:: SetCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCoords(const OE2DPoint& coords)

      .. oe:language:: python

         .. oe:api:: python

            SetCoords(coord: OE2DPoint) -> None

      Sets the exact coordinates of the atom in the rendered image.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::GetCoords` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` method

   .. oe:method:: SetHCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHCount(unsigned int hcount)

      .. oe:language:: python

         .. oe:api:: python

            SetHCount(hcount: int) -> None

      Set the hydrogen count to render for this atom.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::GetHCount` method for
           more information on the meaning of various input integers.

   .. oe:method:: SetHPosition

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHPosition(unsigned int hpos)

      .. oe:language:: python

         .. oe:api:: python

            SetHPosition(hpos: int) -> None

      Sets the position of hydrogen label relative to the atomic
      label.

      *hpos*
         This value has to be from the :oe:constns:`OEDepict::OEHydrogenPos`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::GetHPosition` method
         * :oe:constns:`OEDepict::OEHydrogenPos` namespace

   .. oe:method:: SetLabel

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLabel(const std::string& label)

      .. oe:language:: python

         .. oe:api:: python

            SetLabel(label: str) -> None

      Sets the string that is rendered as the "atomic" label at the position
      returned by the :oe:meth:`OEDepict::OE2DAtomDisplay::GetCoords`
      method.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::GetLabel` method

   .. oe:method:: SetLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLabelFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetLabelFont(font: OEFont) -> None

      Sets the font that is used when rendering the atomic label of the
      :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::GetLabelFont` method

   .. oe:method:: SetMass

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMass(unsigned int mass)

      .. oe:language:: python

         .. oe:api:: python

            SetMass(mass: int) -> None

      Sets the isotope information rendered next to the atomic label.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::GetMass` method

   .. oe:method: SetPen  # IGNORE CURRENTLY NOT USED

      .. oe:api::

         void SetPen(const OEPen &pen)

   .. oe:method:: SetProperty

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetProperty(const std::string& label)

      .. oe:language:: python

         .. oe:api:: python

            SetProperty(label: str) -> None

      Sets the string rendered next to the atom.

      .. warning::

         The preferred way to set the atom property strings is to use the
         :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor`
         method.
         See example in the :ref:`section_mol_display_atom_prop`
         section.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetProperty` method
         * :oe:meth:`OEDepict::OE2DAtomDisplay::SetPropertyFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor` method

   .. oe:method:: SetPropertyFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPropertyFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetPropertyFont(font: OEFont) -> None

      Sets the font that is used when rendering the property string of the
      :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object.

      .. warning::

         The preferred way to set the font of the atom property strings
         is to use the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont`
         method.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::GetPropertyFont` method
         * :oe:meth:`OEDepict::OE2DAtomDisplay::GetProperty` method
         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont` method

   .. oe:method:: SetPropertyOffset

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPropertyOffset(const OE2DPoint& offset)

      .. oe:language:: python

         .. oe:api:: python

            SetPropertyOffset(offset: OE2DPoint) -> None

      Sets the offset vector that is used to position the property label
      of the atom.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::GetPropertyOffset` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class

   .. oe:method:: SetRadical

      .. oe:language:: c++ java csharp

         .. oe:api::

            void  SetRadical(unsigned int radical)

      .. oe:language:: python

         .. oe:api:: python

            SetRadical(radical: int) -> None

      Sets the radical type of the atom.

      *radical*
         This value has to be from the :oe:constns:`OEDepict::OERadicalDisplayType`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DAtomDisplay::GetRadical` method
         * :oe:constns:`OEDepict::OERadicalDisplayType` namespace


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OE2DBondDisplay, 2DBondDisplay

.. _OEDepict_OE2DBondDisplay:

.. oe:class:: OE2DBondDisplay

   .. oe:api::

      class OE2DBondDisplay : public OEBondDisplayBase

   This class stores 2D depiction information of a bond.
   See :ref:`Figure: OEDepict TK bond display class hierarchy<figure_OE2DBondDisplay_Hierarchy>`.

   .. _figure_OE2DBondDisplay_Hierarchy:

   .. figure:: depicttk/images/OEBondDisplayHierarchy.*
      :align:  center

      **OEDepict TK bond display class hierarchy**

   The following methods are publicly inherited from :ref:`OEBondDisplayBase <OEDepict_OEBondDisplayBase>`:

   ================================================================ =============================================================== ===============================================================
   :oe:meth:`GetDataType<OEDepict::OEBondDisplayBase::GetDataType>` :oe:meth:`IsDataType<OEDepict::OEBondDisplayBase::IsDataType>`  :oe:meth:`SetVisible<OEDepict::OEBondDisplayBase::SetVisible>`
   :oe:meth:`GetBond<OEDepict::OEBondDisplayBase::GetBond>`         :oe:meth:`IsVisible<OEDepict::OEBondDisplayBase::IsVisible>`
   ================================================================ =============================================================== ===============================================================

   The :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - pen used to draw the begin of the bond
        - :oe:meth:`GetBgnPen<OEDepict::OE2DBondDisplay::GetBgnPen>`
        - :oe:meth:`SetBgnPen<OEDepict::OE2DBondDisplay::SetBgnPen>`
        - :ref:`OEPen <OEDepict_OEPen>` class

      * - pen used to draw the end of the bond
        - :oe:meth:`GetEndPen<OEDepict::OE2DBondDisplay::GetEndPen>`
        - :oe:meth:`SetEndPen<OEDepict::OE2DBondDisplay::SetEndPen>`
        - :ref:`OEPen <OEDepict_OEPen>` class

      * - position of multi-line bonds
        - :oe:meth:`GetDisplayPos<OEDepict::OE2DBondDisplay::GetDisplayPos>`
        - :oe:meth:`SetDisplayPos<OEDepict::OE2DBondDisplay::SetDisplayPos>`
        - :oe:constns:`OEDepict::OEBondDisplayPosition` namespace

      * - rendered bond type
        - :oe:meth:`GetDisplayType<OEDepict::OE2DBondDisplay::GetDisplayType>`
        - :oe:meth:`SetDisplayType<OEDepict::OE2DBondDisplay::SetDisplayType>`
        - :oe:constns:`OEDepict::OEBondDisplayType` namespace

      * - rendered string as property
        - :oe:meth:`GetProperty<OEDepict::OE2DBondDisplay::GetProperty>`
        - :oe:meth:`SetProperty<OEDepict::OE2DBondDisplay::SetProperty>`
        - string

      * - font of property string
        - :oe:meth:`GetPropertyFont<OEDepict::OE2DBondDisplay::GetPropertyFont>`
        - :oe:meth:`SetPropertyFont<OEDepict::OE2DBondDisplay::SetPropertyFont>`
        - :ref:`OEFont <OEDepict_OEFont>` class

      * - position of property label
        - :oe:meth:`GetPropertyOffset<OEDepict::OE2DBondDisplay::GetPropertyOffset>`
        - :oe:meth:`SetPropertyOffset<OEDepict::OE2DBondDisplay::SetPropertyOffset>`
        - :ref:`OE2DPoint <OEDepict_OE2DPoint>` class

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DBondDisplay(const OEChem::OEBondBase* bond)

      .. oe:language:: python

         .. oe:api:: python

            OE2DBondDisplay(arg2: OEBondBase) -> OE2DBondDisplay

      Construct an :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` object that
      contains the style information for ``bond``.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DBondDisplay(const OE2DBondDisplay& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DBondDisplay(rhs: OE2DBondDisplay) -> OE2DBondDisplay

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE2DBondDisplay &operator=(const OE2DBondDisplay &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

      Deep copy constructor that returns a pointer to a copy of the
      object.  The memory returned is dynamically allocated and owned
      by the caller.

   .. oe:method:: GetBgnPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEPen& GetBgnPen() const

      .. oe:language:: python

         .. oe:api:: python

            GetBgnPen() -> OEPen

      Returns the pen used to draw the bond from the "begin" atom coordinates
      to the middle of the bond.

      .. _figure_OE2DBondDisplay_GetBgnPen:

      .. figure:: depicttk/images/OE2DBondDisplay-GetBgnPen.*
         :align:  center

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::SetBgnPen` method
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. oe:method:: GetDisplayPos

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetDisplayPos() const

      .. oe:language:: python

         .. oe:api:: python

            GetDisplayPos() -> int

      Returns how multi-line bonds should be rendered.  The return
      value is taken from the
      :oe:constns:`OEDepict::OEBondDisplayPosition` namespace.

      .. note::

         The :oe:constns:`OEDepict::OEBondDisplayPosition` namespace
         only affects bonds of the following types (as returned by
         :oe:meth:`OEDepict::OE2DBondDisplay::GetDisplayType`):

         * :oe:const:`OEDepict::OEBondDisplayType::Double`
         * :oe:const:`OEDepict::OEBondDisplayType::AromaticDash`
         * :oe:const:`OEDepict::OEBondDisplayType::SingleDouble`
         * :oe:const:`OEDepict::OEBondDisplayType::SingleArom`
         * :oe:const:`OEDepict::OEBondDisplayType::DoubleArom`
         * :oe:const:`OEDepict::OEBondDisplayType::Aromatic`

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::SetDisplayPos` method
         * :oe:constns:`OEDepict::OEBondDisplayPosition` namespace

   .. oe:method:: GetDisplayType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetDisplayType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDisplayType() -> int

      Returns how bond orders, stereochemistry, and aromaticity is
      rendered for the bond. The return value is taken from the
      :oe:constns:`OEDepict::OEBondDisplayType` namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::SetDisplayType` method
         * :oe:constns:`OEDepict::OEBondDisplayType` namespace

   .. oe:method:: GetEndPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEPen& GetEndPen() const

      .. oe:language:: python

         .. oe:api:: python

            GetEndPen() -> OEPen

      Returns the pen used to draw the bond from the "end" atom coordinates
      to the middle of the bond.

      .. _figure_OE2DBondDisplay_GetEndPen:

      .. figure:: depicttk/images/OE2DBondDisplay-GetEndPen.*
         :align:  center

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::SetEndPen` method
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. oe:method:: GetProperty

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetProperty() const

      .. oe:language:: python

         .. oe:api:: python

            GetProperty() -> str

      Returns the string displayed next to the bond.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::SetProperty` method
         * :oe:meth:`OEDepict::OE2DBondDisplay::SetPropertyFont` method

   .. oe:method:: GetPropertyFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont& GetPropertyFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetPropertyFont() -> OEFont

      Returns the font that is used when displaying the property string of the
      :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` object.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::SetPropertyFont` method
         * :oe:meth:`OEDepict::OE2DBondDisplay::SetProperty` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. oe:method:: GetPropertyOffset

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OE2DPoint& GetPropertyOffset() const

      .. oe:language:: python

         .. oe:api:: python

            GetPropertyOffset() -> OE2DPoint

      Returns the offset vector (relative to the middle of the bond)
      that is used to position the property label of the bond.
      See :ref:`Figure: The property offset vector is relative to the middle of the
      displayed bond<figure_OE2DBondDisplay_GetPropertyOffset>`.

      .. _figure_OE2DBondDisplay_GetPropertyOffset:

      .. figure:: depicttk/images/OE2DBondDisplay-GetPropertyOffset.*
         :align:  center

         **The property offset vector is relative to the middle of the
         displayed bond**

      This allows for any string representable information to be
      rendered at a logical location near the bond.
      See example in :ref:`Example of displaying indices as bond property<figure_OE2DBondDisplay_GetProperty>`.

      .. _figure_OE2DBondDisplay_GetProperty:

      .. figure:: depicttk/images/OE2DBondDisplay-GetProperty.*
         :align:  center

         **Example of displaying indices as bond property**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::SetPropertyOffset` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class

   .. oe:method:: HasProperty

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasProperty() const

      .. oe:language:: python

         .. oe:api:: python

            HasProperty() -> bool

      Return whether or not the property string of the
      :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` object is empty.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::GetProperty` method
         * :oe:meth:`OEDepict::OE2DBondDisplay::SetProperty` method

   .. oe:method:: SetBgnPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBgnPen(const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            SetBgnPen(pen: OEPen) -> None

      Sets the pen used to draw the bond from the "begin" atom coordinates
      to the middle of the bond.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::GetBgnPen` method
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. oe:method:: SetDisplayPos

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDisplayPos(unsigned int pos)

      .. oe:language:: python

         .. oe:api:: python

            SetDisplayPos(pos: int) -> None

      Sets the display position of the bond.

      *pos*
         This value has to be from the :oe:constns:`OEDepict::OEBondDisplayPosition`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::GetDisplayPos` method
         * :oe:constns:`OEDepict::OEBondDisplayPosition` namespace

   .. oe:method:: SetDisplayType

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDisplayType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetDisplayType(type: int) -> None

      Sets the display style of the bond.

      *type*
         This value has to be from the :oe:constns:`OEDepict::OEBondDisplayType`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::GetDisplayType` method
         * :oe:constns:`OEDepict::OEBondDisplayType` namespace

   .. oe:method:: SetEndPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetEndPen(const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            SetEndPen(pen: OEPen) -> None

      Sets the pen used to draw the bond from the "end" atom coordinates
      to the middle of the bond.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::GetEndPen` method
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. oe:method:: SetProperty

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetProperty(const std::string& label)

      .. oe:language:: python

         .. oe:api:: python

            SetProperty(label: str) -> None

      Sets the string displayed next to the bond.

      .. warning::

         The preferred way to set the bond property strings is to use
         :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor`
         method.
         See example in the :ref:`section_mol_display_bond_prop`
         section.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::SetProperty` method
         * :oe:meth:`OEDepict::OE2DBondDisplay::SetPropertyFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor` method

   .. oe:method:: SetPropertyFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPropertyFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetPropertyFont(font: OEFont) -> None

      Sets the font that is used when displaying the property string of the
      :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` object.

      .. warning::

         The preferred way to set the font of the bond property strings
         is to use :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont`
         method.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::GetPropertyFont` method
         * :oe:meth:`OEDepict::OE2DBondDisplay::GetProperty` method
         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont` method

   .. oe:method:: SetPropertyOffset

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPropertyOffset(const OE2DPoint& offset)

      .. oe:language:: python

         .. oe:api:: python

            SetPropertyOffset(arg2: OE2DPoint) -> None

      Sets the offset vector (relative to the middle of the bond)
      that is used to position the property label of the bond.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DBondDisplay::GetPropertyOffset` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OE2DMolDisplay, 2DMolDisplay

.. _OEDepict_OE2DMolDisplay:

.. oe:class:: OE2DMolDisplay

   .. oe:api::

      class OE2DMolDisplay : public OEMolDisplayBase

   This class represents :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` that stores
   the depiction information (such as atom coordinates, molecule scaling,
   representation styles etc.) of a molecule.
   See :ref:`Figure: OEDepict TK molecule display class hierarchy<figure_OE2DMolDisplay_Hierarchy>`.

   .. _figure_OE2DMolDisplay_Hierarchy:

   .. figure:: depicttk/images/OEMolDisplayHierarchy.*
      :align:  center

      **OEDepict TK molecule display class hierarchy**

   .. seealso::

      * :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class
      * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` class
      * :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` class

   The following methods are publicly inherited from :ref:`OEMolDisplayBase <OEDepict_OEMolDisplayBase>`:

   =============================================================== =============================================================== ==============================================================
   :oe:meth:`GetDataType<OEDepict::OEMolDisplayBase::GetDataType>` :oe:meth:`GetMolecule<OEDepict::OEMolDisplayBase::GetMolecule>` :oe:meth:`IsDataType<OEDepict::OEMolDisplayBase::IsDataType>`
   =============================================================== =============================================================== ==============================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DMolDisplay(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            OE2DMolDisplay(arg2: Union[OEGraphMol,OEMol,OEQMol]) -> OE2DMolDisplay

      Initializes an :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object using
      default display options.

      *mol*
         The molecule for which display information is stored in the
         :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::Constructors` method
           for the list of default display options
         * :oe:meth:`OEDepict::OE2DMolDisplay::IsValid` method

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DMolDisplay(const OEChem::OEMolBase& mol,
                           const OE2DMolDisplayOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            OE2DMolDisplay(arg2: Union[OEGraphMol,OEMol,OEQMol],
                           arg3: OE2DMolDisplayOptions) -> OE2DMolDisplay

      Initializes an :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object using
      the given display options.

      *mol*
         The molecule for which display information is stored in the
         :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object.

      *opts*
         The :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object that stores
         properties that determine the styles of the molecule depiction.

      .. warning::

         * An :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object does not make a copy of the
           :ref:`OEMolBase <OEChem_OEMolBase>` object from which it is initialized but only stores
           its pointer.
           Therefore, the user responsibility is to not let the molecule
           go out of scope, before the corresponding :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`
           object.

         * Changing the :ref:`OEMolBase <OEChem_OEMolBase>` object from which
           :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object is initialized has no effect
           on the display itself after initialization.
           However, the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object become
           invalid if the molecule graph is modified (atoms or bonds added or
           deleted).

      .. note::

         * A warning is thrown when an :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object
           is initialized with a molecule with 3D coordinates.

         * An :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object is considered invalid
           and an error is thrown when it is initialized:

           * with an empty molecule (*i.e.* molecule with no atoms)

           * with a molecule that has neither 2D nor 3D coordinates

           See also: :oe:meth:`OEDepict::OE2DMolDisplay::IsValid` method

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DMolDisplay(const OE2DMolDisplay& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DMolDisplay(rhs: OE2DMolDisplay) -> OE2DMolDisplay

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE2DMolDisplay &operator=(const OE2DMolDisplay &rhs)

      Assignment operator.

   .. ################################################################
      # CreateCopy
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

      Deep copy constructor that returns a copy of the object. The
      memory for the returned :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object
      is dynamically allocated and owned by the caller.

   .. ################################################################
      # GetAtomDisplay
      ################################################################

   .. oe:method:: GetAtomDisplay

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DAtomDisplay* GetAtomDisplay(const OEChem::OEAtomBase* atom)

      .. oe:language:: python

         .. oe:api:: python

            GetAtomDisplay(atom: OEAtomBase) -> OE2DAtomDisplay

      Returns the pointer of the :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>`
      object that stores the depiction information of the given atom.

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OE2DAtomDisplay* GetAtomDisplay(const OEChem::OEAtomBase* atom) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomDisplay(atom: OEAtomBase) -> OE2DAtomDisplay

      Returns the const pointer of the :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>`
      object that stores the depiction information of the given atom.

      .. note::

         The :oe:meth:`OEDepict::OE2DMolDisplay::GetAtomDisplay` methods
         returns a zero pointer if the given atom does not correspond to any
         display atom stored in the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object.
         It is a good programming practice to check the returned pointer
         before using it. See code snippet below.

      .. oe:source:: AccessAtomDisplay.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETATOMDISPLAY

      .. oe:source:: AccessAtomDisplay.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETATOMDISPLAY

      .. oe:source:: AccessAtomDisplay.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETATOMDISPLAY

      .. oe:source:: AccessAtomDisplay.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETATOMDISPLAY

      .. seealso::

          * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` class

   .. ################################################################
      # GetAtomDisplays
      ################################################################

   .. oe:method:: GetAtomDisplays

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OE2DAtomDisplay>* GetAtomDisplays() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomDisplays() -> Iterable[OE2DAtomDisplay]

      Returns an iterator over all :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` objects
      stored in the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object.

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OE2DAtomDisplay>* GetAtomDisplays(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomDisplays(pred: OEUnaryAtomPred) -> Iterable[OE2DAtomDisplay]

      Returns an iterator over only those  :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` objects
      for which the corresponding atom passes the given predicate.
      For example, the following code snippet shows how to access the atom
      displays of oxygen atoms:

      .. oe:source:: AccessAtomDisplay.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETATOMDISPLAYS-PREDICATE

      .. oe:source:: AccessAtomDisplay.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETATOMDISPLAYS-PREDICATE

      .. oe:source:: AccessAtomDisplay.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETATOMDISPLAYS-PREDICATE

      .. oe:source:: AccessAtomDisplay.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETATOMDISPLAYS-PREDICATE

      .. seealso::

          * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` class
          * :oe:src:`Listing 4<SNIPPET-DEPICT-MOL-GRAPH-DepictMolGraph>` example in the
            :ref:`section_mol_display_customize` section

   .. oe:method:: GetBondDisplay

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DBondDisplay* GetBondDisplay(const OEChem::OEBondBase* bond)

      .. oe:language:: python

         .. oe:api:: python

            GetBondDisplay(bond: OEBondBase) -> OE2DBondDisplay

      Returns the pointer of the :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>`
      object, that stores the depiction information of the given bond.

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OE2DBondDisplay* GetBondDisplay(const OEChem::OEBondBase* bond) const

      .. oe:language:: python

         .. oe:api:: python

            GetBondDisplay(bond: OEBondBase) -> OE2DBondDisplay

      Returns the const pointer of the :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>`
      object, that stores the depiction information of the given bond.

      .. seealso::

          * :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` class

      .. note::

         The :oe:meth:`OEDepict::OE2DMolDisplay::GetBondDisplay` methods
         returns a zero pointer if the given bond does not correspond to any
         display bond stored in the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object.
         It is a good programming practice to check the returned pointer
         before using it. See code snippet below.

      .. oe:source:: AccessBondDisplay.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETBONDDISPLAY

      .. oe:source:: AccessBondDisplay.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETBONDDISPLAY

      .. oe:source:: AccessBondDisplay.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETBONDDISPLAY

      .. oe:source:: AccessBondDisplay.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETBONDDISPLAY

      .. seealso::

          * :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` class

   .. ################################################################
      # GetBondDisplays
      ################################################################

   .. oe:method:: GetBondDisplays

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OE2DBondDisplay>* GetBondDisplays() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondDisplays() -> Iterable[OE2DBondDisplay]

      Returns an iterator over all :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` objects
      stored in the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object.

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OE2DBondDisplay>* GetBondDisplays(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            GetBondDisplays(pred: OEUnaryBondPred) -> Iterable[OE2DBondDisplay]

      .. seealso::

          * :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` class

      Returns an iterator over only those :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` objects
      for which the corresponding bond passes the given predicate.
      For example, the following code snippet shows how to access the bond
      displays of aromatic bonds:

      .. oe:source:: AccessBondDisplay.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETBONDDISPLAYS-PREDICATE

      .. oe:source:: AccessBondDisplay.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETBONDDISPLAYS-PREDICATE

      .. oe:source:: AccessBondDisplay.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETBONDDISPLAYS-PREDICATE

      .. oe:source:: AccessBondDisplay.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-GETBONDDISPLAYS-PREDICATE

      .. seealso::

          * :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` class
          * :oe:src:`Listing 4<SNIPPET-DEPICT-MOL-GRAPH-DepictMolGraph>` example in the
            :ref:`section_mol_display_customize` section

   .. ################################################################
      # GetDataType
      ################################################################

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

      This function is used to perform run-time type
      identification.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::GetDataType` method in the **OEChem TK** manual

   .. ################################################################
      # GetHeight
      ################################################################

   .. oe:method:: GetHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeight() -> float

      Returns the height of the displayed molecule.

      .. seealso::

          * :ref:`section_mol_display_size` section
          * :oe:meth:`OEDepict::OE2DMolDisplay::GetScale` method
          * :oe:meth:`OEDepict::OE2DMolDisplay::GetWidth` method

   .. ################################################################
      # GetLayer
      ################################################################

   .. oe:method:: GetLayer

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImage& GetLayer(unsigned int position, unsigned int idx = 0)
            const OEImage& GetLayer(unsigned int position, unsigned int idx = 0) const

      .. oe:language:: python

         .. oe:api:: python

            GetLayer(position: int, idx: int = 0) -> OEImage

      Provides access to the layers of the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`
      object.
      Currently, an :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object has two layers
      (one :oe:const:`OEDepict::OELayerPosition::Above` and
      one :oe:const:`OEDepict::OELayerPosition::Below` ) that allows
      drawing of objects over or underneath the molecular structure, respectively.

      *position*
         This value has to be from the :oe:constns:`OEDepict::OELayerPosition`
         namespace.

      *idx*
         This parameter is currently not used.

      .. seealso::

          * :ref:`OEImage <OEDepict_OEImage>` class
          * :oe:constns:`OEDepict::OELayerPosition` namespace

   .. ################################################################
      # GetOptions
      ################################################################

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OE2DMolDisplayOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OE2DMolDisplayOptions

      Returns the options used to initialized the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`
      object.

      .. seealso::

          * :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class

   .. ################################################################
      # GetScale
      ################################################################

   .. oe:method:: GetScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetScale() -> float

      Returns the scaling factor of the displayed molecule.

      .. seealso::

          * :ref:`section_mol_display_size` section
          * :oe:meth:`OEDepict::OE2DMolDisplay::GetHeight` method
          * :oe:meth:`OEDepict::OE2DMolDisplay::GetWidth` method

   .. ################################################################
      # GetWidth
      ################################################################

   .. oe:method:: GetWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetWidth() -> float

      Returns the width of the displayed molecule.

      .. seealso::

          * :ref:`section_mol_display_size` section
          * :oe:meth:`OEDepict::OE2DMolDisplay::GetHeight` method
          * :oe:meth:`OEDepict::OE2DMolDisplay::GetScale` method

   .. ################################################################
      # IsDataType
      ################################################################

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

      Returns whether type is the same as the instance this method is
      called on.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::IsDataType` method in the **OEChem TK** manual

   .. ################################################################
      # IsValid
      ################################################################

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object
      was initialized successfully.  If initialization was attempted
      with an empty molecule or a molecule with no coordinates
      (neither 2D nor 3D), then this method returns false.
      An :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object becomes invalid
      if the molecule, from which it was initialized, is modified.
      For example, atom or bonds added to or deleted from the
      molecule.

      .. hint::

         It is highly recommend to check whether a molecule display
         is valid after initialization.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OE2DMolDisplayOptions, 2DMolDisplayOptions

.. _OEDepict_OE2DMolDisplayOptions:

.. oe:class:: OE2DMolDisplayOptions

   .. oe:api::

      class OE2DMolDisplayOptions

   This class represents the :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class
   that encapsulates properties that determine how a molecule is depicted.

   The :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - aromatic style
        - :oe:meth:`GetAromaticStyle<OEDepict::OE2DMolDisplayOptions::GetAromaticStyle>`
        - :oe:meth:`SetAromaticStyle<OEDepict::OE2DMolDisplayOptions::SetAromaticStyle>`
        - :oe:constns:`OEDepict::OEAromaticStyle`

      * - atomic number colors
        - :oe:meth:`GetAtomColor<OEDepict::OE2DMolDisplayOptions::GetAtomColor>`
        - :oe:meth:`SetAtomColor<OEDepict::OE2DMolDisplayOptions::SetAtomColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - atom color style
        - :oe:meth:`GetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle>`
        - :oe:meth:`SetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle>`
        - :oe:constns:`OEDepict::OEAtomColorStyle`

      * - atom label font
        - :oe:meth:`GetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFont>`
        - :oe:meth:`SetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - atom label font scale
        - :oe:meth:`GetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFontScale>`
        - :oe:meth:`SetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale>`
        - positive floating point number in the range of ``[0.5, 3.0]`` or ``0.0``

      * - atom property font
        - :oe:meth:`GetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFont>`
        - :oe:meth:`SetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - atom property label font scale
        - :oe:meth:`GetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFontScale>`
        - :oe:meth:`SetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale>`
        - positive floating point number in the range of ``[0.5, 2.0]``

      * - atom property initializer
        - :oe:meth:`GetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetAtomPropertyFunctor>`
        - :oe:meth:`SetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor>`
        - :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>`

      * - atom stereo style
        - :oe:meth:`GetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::GetAtomStereoStyle>`
        - :oe:meth:`SetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle>`
        - :oe:constns:`OEDepict::OEAtomStereoStyle`

      * - atom SVG markup
        - :oe:meth:`GetAtomSVGMarkupFunctor<OEDepict::OE2DMolDisplayOptions::GetAtomSVGMarkupFunctor>`
        - :oe:meth:`SetAtomSVGMarkupFunctor<OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor>`
        - :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>`

      * - atom visibility initializer
        - :oe:meth:`GetAtomVisibilityFunctor<OEDepict::OE2DMolDisplayOptions::GetAtomVisibilityFunctor>`
        - :oe:meth:`SetAtomVisibilityFunctor<OEDepict::OE2DMolDisplayOptions::SetAtomVisibilityFunctor>`
        - :oe:cls:`OEUnaryAtomPred<OESystem::OEUnaryPredicate>`

      * - background color
        - :oe:meth:`GetBackgroundColor<OEDepict::OE2DMolDisplayOptions::GetBackgroundColor>`
        - :oe:meth:`SetBackgroundColor<OEDepict::OE2DMolDisplayOptions::SetBackgroundColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - bond color style
        - :oe:meth:`GetBondColorStyle<OEDepict::OE2DMolDisplayOptions::GetBondColorStyle>`
        - :oe:meth:`SetBondColorStyle<OEDepict::OE2DMolDisplayOptions::SetBondColorStyle>`
        - :oe:constns:`OEDepict::OEBondColorStyle`

      * - bond line gap scale
        - :oe:meth:`GetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineGapScale>`
        - :oe:meth:`SetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineGapScale>`
        - positive floating point number in the range of ``[0.5, 2.0]``

      * - bond line atom label gap scale
        - :oe:meth:`GetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineAtomLabelGapScale>`
        - :oe:meth:`SetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineAtomLabelGapScale>`
        - positive floating point number in the range of ``[0.5, 2.0]``

      * - bond property font
        - :oe:meth:`GetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFont>`
        - :oe:meth:`SetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - bond property label font scale
        - :oe:meth:`GetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFontScale>`
        - :oe:meth:`SetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale>`
        - positive floating point number in the range of ``[0.5, 2.0]``

      * - bond property initializer
        - :oe:meth:`GetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetBondPropertyFunctor>`
        - :oe:meth:`SetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor>`
        - :ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>`

      * - bond stereo style
        - :oe:meth:`GetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::GetBondStereoStyle>`
        - :oe:meth:`SetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle>`
        - :oe:constns:`OEDepict::OEBondStereoStyle`

      * - bond pen
        - :oe:meth:`GetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::GetDefaultBondPen>`
        - :oe:meth:`SetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen>`
        - :ref:`OEPen <OEDepict_OEPen>`

      * - bond width scaling
        - :oe:meth:`GetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::GetBondWidthScaling>`
        - :oe:meth:`SetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::SetBondWidthScaling>`
        - boolean

      * - bond SVG markup
        - :oe:meth:`GetBondSVGMarkupFunctor<OEDepict::OE2DMolDisplayOptions::GetBondSVGMarkupFunctor>`
        - :oe:meth:`SetBondSVGMarkupFunctor<OEDepict::OE2DMolDisplayOptions::SetBondSVGMarkupFunctor>`
        - :ref:`OEBondSVGMarkupBase <OEDepict_OEBondSVGMarkupBase>`

      * - explicit atom label angle
        - :oe:meth:`GetExplicitAtomLabelAngle<OEDepict::OE2DMolDisplayOptions::GetExplicitAtomLabelAngle>`
        - :oe:meth:`SetExplicitAtomLabelAngle<OEDepict::OE2DMolDisplayOptions::SetExplicitAtomLabelAngle>`
        - positive floating point number in the range of ``[120.0, 180.0]``

      * - height
        - :oe:meth:`GetHeight<OEDepict::OE2DMolDisplayOptions::GetHeight>`
        - :oe:meth:`SetHeight<OEDepict::OE2DMolDisplayOptions::SetHeight>`
        - positive floating point number

      * - hydrogen style
        - :oe:meth:`GetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::GetHydrogenStyle>`
        - :oe:meth:`SetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle>`
        - :oe:constns:`OEDepict::OEHydrogenStyle`

      * - margin(s)
        - :oe:meth:`GetMargin<OEDepict::OE2DMolDisplayOptions::GetMargin>`
        - :oe:meth:`SetMargin<OEDepict::OE2DMolDisplayOptions::SetMargin>`, :oe:meth:`SetMargins<OEDepict::OE2DMolDisplayOptions::SetMargins>`
        - positive floating point number in the range of ``[2.5, 25.0]``

      * - scale
        - :oe:meth:`GetScale<OEDepict::OE2DMolDisplayOptions::GetScale>`
        - :oe:meth:`SetScale<OEDepict::OE2DMolDisplayOptions::SetScale>`
        - positive floating point number

      * - super atom label font
        - :oe:meth:`GetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetSuperAtomLabelFont>`
        - :oe:meth:`SetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetSuperAtomLabelFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - super atom display style
        - :oe:meth:`GetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle>`
        - :oe:meth:`SetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle>`
        - :oe:constns:`OEDepict::OESuperAtomStyle`

      * - protective group label font
        - :oe:meth:`GetProtectiveGroupLabelFont<OEDepict::OE2DMolDisplayOptions::GetProtectiveGroupLabelFont>`
        - :oe:meth:`SetProtectiveGroupLabelFont<OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupLabelFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - protective group display style
        - :oe:meth:`HasProtectiveGroupStyle<OEDepict::OE2DMolDisplayOptions::HasProtectiveGroupStyle>`
        - :oe:meth:`SetProtectiveGroupStyle<OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupStyle>`
        - :oe:constns:`OEDepict::OEProtectiveGroupStyle`

      * - title font
        - :oe:meth:`GetTitleFont<OEDepict::OE2DMolDisplayOptions::GetTitleFont>`
        - :oe:meth:`SetTitleFont<OEDepict::OE2DMolDisplayOptions::SetTitleFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - title font scale
        - :oe:meth:`GetTitleFontScale<OEDepict::OE2DMolDisplayOptions::GetTitleFontScale>`
        - :oe:meth:`SetTitleFontScale<OEDepict::OE2DMolDisplayOptions::SetTitleFontScale>`
        - positive floating point number in the range of ``[0.5, 2.0]`` or ``0.0``

      * - title height
        - :oe:meth:`GetTitleHeight<OEDepict::OE2DMolDisplayOptions::GetTitleHeight>`
        - :oe:meth:`SetTitleHeight<OEDepict::OE2DMolDisplayOptions::SetTitleHeight>`
        - :oe:constns:`OEDepict::OETitleLocation`

      * - title location
        - :oe:meth:`GetTitleLocation<OEDepict::OE2DMolDisplayOptions::GetTitleLocation>`
        - :oe:meth:`SetTitleLocation<OEDepict::OE2DMolDisplayOptions::SetTitleLocation>`
        - :oe:constns:`OEDepict::OETitleLocation`

      * - width
        - :oe:meth:`GetWidth<OEDepict::OE2DMolDisplayOptions::GetWidth>`
        - :oe:meth:`SetWidth<OEDepict::OE2DMolDisplayOptions::SetWidth>`
        - positive floating point number

   The images below illustrate the three possible molecule display layouts depending on the position of the title.
   These layouts can be controlled by the following parameters:

   * The width and the height can be set either by the constructor of the
     :oe:meth:`OE2DMolDisplayOptions<OEDepict::OE2DMolDisplayOptions::Constructors>` class,
     by calling the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method or by the
     :oe:meth:`SetWidth<OEDepict::OE2DMolDisplayOptions::SetWidth>` and
     :oe:meth:`SetHeight<OEDepict::OE2DMolDisplayOptions::SetHeight>` methods, respectively.

   * The location of the title area (blue box) can be set by the
     :oe:meth:`SetTitleLocation<OEDepict::OE2DMolDisplayOptions::SetTitleLocation>` method.
     The height of the title area (blue arrows) can be modified by invoking
     the :oe:meth:`SetTitleHeight<OEDepict::OE2DMolDisplayOptions::SetTitleHeight>` method.

   * The padding around the molecule (red arrows) can be changed by calling either the
     :oe:meth:`SetMargin<OEDepict::OE2DMolDisplayOptions::SetMargin>` or the
     :oe:meth:`SetMargins<OEDepict::OE2DMolDisplayOptions::SetMargins>` methods.

   .. _table_moldisplay_layouts:

   .. list-table:: **Example of molecule display layouts depending on position of the title**
      :widths: 250 250 250
      :header-rows: 1

      * - title hidden
        - title at the top
        - title at the bottom

      * - .. image:: ../images/OE2DMolDisplayLayout_TitleHidden.*
        - .. image:: ../images/OE2DMolDisplayLayout_TitleTop.*
        - .. image:: ../images/OE2DMolDisplayLayout_TitleBottom.*

   .. seealso::

      * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class
      * :ref:`section_mol_display_size` section

   .. hint::

      Even though **OEDepict TK** provides access to manipulate the
      properties of the atom and bond displays after the
      :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object is constructed,
      it is highly recommended to determine the style of the depiction by using
      the :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class.
      Only by knowing all properties (such as labels, font styles and sizes *etc.*)
      in advance can ensure the **best depiction layout** *i.e.* that
      the molecule diagram is rendered without any label clippings
      and the labels are displayed with the minimum number of overlaps.

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DMolDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OE2DMolDisplayOptions() -> OE2DMolDisplayOptions

      Default constructor that initializes an :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`
      object with the following properties:

      See example in :ref:`Molecule depiction with default options<figure_OE2DMolDisplayOptions_Default>`)

      .. list-table::  **Default parameters of OE2DMolDisplayOptions**
         :widths: 100 100
         :header-rows: 1

         * - Property
           - Default value

         * - aromatic style
           - :oe:const:`OEDepict::OEAromaticStyle::Default`

         * - atomic number colors
           - initialized based on :oe:const:`OEDepict::OEAtomColorStyle::Default`

         * - atom color style
           - :oe:const:`OEDepict::OEAtomColorStyle::Default`

         * - atom label font
           - :oe:const:`OEDepict::OEDepict::OEDefaultFont`

         * - atom label font scale
           - 1.0

         * - atom property font
           - OEFont(OEColor(75, 75, 75))

         * - atom property label font scale
           - 1.0

         * - atom property initializer
           - :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>`

         * - atom stereo style
           - :oe:const:`OEDepict::OEAtomStereoStyle::Default`

         * - atom SVG markup
           - :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>`

         * - atom visibility initializer
           - :oe:cls:`OEIsTrueAtom<OESystem::OEIsTrue>`

         * - background color
           - :oe:const:`OEDepict::OEDepict::OELightBackgroundColor` initialized based on :oe:const:`OEDepict::OEAtomColorStyle::Default`

         * - bond color style
           - :oe:const:`OEDepict::OEBondColorStyle::Default`

         * - bond line gap scale
           - 1.0

         * - bond line atom label gap scale
           - 1.0

         * - bond property font
           - OEFont(OEColor(75, 75, 75))

         * - bond property label font scale
           - 1.0

         * - bond property initializer
           - :ref:`OEDisplayNoBondProp <OEDepict_OEDisplayNoBondProp>`

         * - bond stereo style
           - :oe:const:`OEDepict::OEBondStereoStyle::Default`

         * - bond pen
           - :oe:const:`OEDepict::OEDepict::OEBlackPen`

         * - bond width scaling
           - `false`

         * - bond SVG markup
           - :ref:`OEBondSVGNoMarkup <OEDepict_OEBondSVGNoMarkup>`

         * - explicit atom label angle
           - 170.0 (degree)

         * - height
           - 0.0 (initialized based on scale)

         * - hydrogen style
           - :oe:const:`OEDepict::OEHydrogenStyle::Default`

         * - margins
           - left and right margin `5.0%` of the width; top and bottom margin `5.0%` of the height of the molecule display

         * - scale
           - :oe:const:`OEDepict::OEScale::AutoScale`

         * - super atom label font
           - OEFont(OEPink)

         * - super atom display style
           - :oe:const:`OEDepict::OESuperAtomStyle::Default`

         * - protective group label font
           - OEFont(OEPink)

         * - protective group display style
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Default`

         * - title font
           - :oe:const:`OEDepict::OEDepict::OEDefaultFont`

         * - title font scale
           - 1.0

         * - title location
           - :oe:const:`OEDepict::OETitleLocation::Default`

         * - title height
           - `10%` of the height of the molecule display

         * - width
           - 0.0 (initialized based on scale)

      .. _figure_OE2DMolDisplayOptions_Default:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_Default.*
         :align:  center

         **Molecule depiction with default options**

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DMolDisplayOptions(double scale)

      .. oe:language:: python

         .. oe:api:: python

            OE2DMolDisplayOptions(scale: float) -> OE2DMolDisplayOptions

      Creates an :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object with
      the specified scaling.

      *scale*
        A non-negative number that controls the magnification of the
        depicted molecule.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DMolDisplayOptions(double width, double height, double scale)

      .. oe:language:: python

         .. oe:api:: python

            OE2DMolDisplayOptions(width: float, height: float, scale: float) -> OE2DMolDisplayOptions

      Creates an :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object with
      the specified dimension and scaling.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DMolDisplayOptions(const OE2DMolDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DMolDisplayOptions(rhs: OE2DMolDisplayOptions) -> OE2DMolDisplayOptions

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE2DMolDisplayOptions &operator=(const OE2DMolDisplayOptions &rhs)

      Assignment operator.

   .. _OEDepict_GetAromaticStyle:

   .. oe:method:: GetAromaticStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetAromaticStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetAromaticStyle() -> int

      Returns the style that controls how aromatic rings are displayed.
      The return value is taken from the :oe:constns:`OEDepict::OEAromaticStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAromaticStyle` method
         * :oe:constns:`OEDepict::OEAromaticStyle` namespace

   .. _OEDepict_GetAtomSVGMarkupFunctor:

   .. oe:method:: GetAtomSVGMarkupFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEAtomSVGMarkupBase& GetAtomSVGMarkupFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomSVGMarkupFunctor() -> OEAtomSVGMarkupBase

      Returns the functor that defines how atoms are marked in
      :file:`svg` image.
      By default, residues are not marked (:ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor` method

   .. _OEDepict_GetAtomColor:

   .. oe:method:: GetAtomColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetAtomColor(unsigned int atomic) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomColor(atomic: int) -> OEColor

      Returns the color associated with a specific atomic number.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomColor` method
         * :ref:`OEColor <OESystem_OEColor>` class
         * :ref:`chapter_element_color` section

   .. _OEDepict_GetAtomColorStyle:

   .. oe:method:: GetAtomColorStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetAtomColorStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomColorStyle() -> int

      Returns the style that is used to define the color of the
      background and the default color of atom labels.
      The return value is taken from the :oe:constns:`OEDepict::OEAtomColorStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle` method
         * :oe:constns:`OEDepict::OEAtomColorStyle` namespace

   .. _OEDepict_GetAtomLabelFont:

   .. oe:method:: GetAtomLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont& GetAtomLabelFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelFont() -> OEFont

      Returns the font that is used to initialize the depiction style
      of the atom labels
      (:oe:meth:`OEDepict::OE2DAtomDisplay::GetLabelFont`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. _OEDepict_GetAtomLabelFontScale:

   .. oe:method:: GetAtomLabelFontScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetAtomLabelFontScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelFontScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the size of the atom label fonts.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale` method

   .. _OEDepict_GetAtomPropLabelFont:

   .. oe:method:: GetAtomPropLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont& GetAtomPropLabelFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomPropLabelFont() -> OEFont

      Returns the font that is used to initialize the depiction style
      of the atom property labels
      (:oe:meth:`OEDepict::OE2DAtomDisplay::GetPropertyFont`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. _OEDepict_GetAtomPropLabelFontScale:

   .. oe:method:: GetAtomPropLabelFontScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetAtomPropLabelFontScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomPropLabelFontScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the size of the atom property label fonts.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale` method

   .. _OEDepict_GetAtomPropertyFunctor:

   .. oe:method:: GetAtomPropertyFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEDisplayAtomPropBase& GetAtomPropertyFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomPropertyFunctor() -> OEDisplayAtomPropBase

      Returns the functor that is used to initialize the atom property
      labels (:oe:meth:`OEDepict::OE2DAtomDisplay::GetProperty`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor` method
         * :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>` class
         * :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>` class
         * :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>` class
         * :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>` class

   .. _OEDepict_GetAtomVisibilityFunctor:

   .. oe:method:: GetAtomVisibilityFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& GetAtomVisibilityFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomVisibilityFunctor() -> OEUnaryAtomPred

      Returns the functor that is used to identify visible atoms.  The default
      functor is the :oe:cls:`OEIsTrueAtom<OESystem::OEIsTrue>` class which
      results in all atoms being displayed.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomVisibilityFunctor` method
         * :oe:cls:`OEUnaryAtomPred<OESystem::OEUnaryPredicate>`

   .. _OEDepict_GetAtomStereoStyle:

   .. oe:method:: GetAtomStereoStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetAtomStereoStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomStereoStyle() -> int

      Returns the style that controls what atom stereo information is displayed.
      The return value is taken from the :oe:constns:`OEDepict::OEAtomStereoStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle` method
         * :oe:constns:`OEDepict::OEAtomStereoStyle` namespace

   .. _OEDepict_GetBackgroundColor:

   .. oe:method:: GetBackgroundColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetBackgroundColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetBackgroundColor() -> OEColor

      Returns the color that is used to clear the background of an image
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      before rendering the molecule.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBackgroundColor` method
         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:func:`OEDepict::OERenderMolecule` function

   .. _OEDepict_GetBondColorStyle:

   .. oe:method:: GetBondColorStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetBondColorStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondColorStyle() -> int

      Returns the style that controls how bonds are colored.
      The return value is taken from the :oe:constns:`OEDepict::OEBondColorStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondColorStyle` method
         * :oe:constns:`OEDepict::OEBondColorStyle` namespace

   .. _OEDepict_GetBondLineGapScale:

   .. oe:method:: GetBondLineGapScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBondLineGapScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondLineGapScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the gap between the lines of double and triple bonds.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondLineGapScale` method

   .. _OEDepict_GetBondLineAtomLabelGapScale:

   .. oe:method:: GetBondLineAtomLabelGapScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBondLineAtomLabelGapScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondLineAtomLabelGapScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the gap between the line(s) of bonds and the adjacent atom labels.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondLineAtomLabelGapScale` method

   .. _OEDepict_GetBondPropLabelFont:

   .. oe:method:: GetBondPropLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont& GetBondPropLabelFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondPropLabelFont() -> OEFont

      Returns the font that is used to initialize the depiction style
      of the bond property labels
      (:oe:meth:`OEDepict::OE2DBondDisplay::GetPropertyFont`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. _OEDepict_GetBondPropLabelFontScale:

   .. oe:method:: GetBondPropLabelFontScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBondPropLabelFontScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondPropLabelFontScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the size of the bond property label fonts.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale` method

   .. _OEDepict_GetBondPropertyFunctor:

   .. oe:method:: GetBondPropertyFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEDisplayBondPropBase& GetBondPropertyFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondPropertyFunctor() -> OEDisplayBondPropBase

      Returns the functor that is used to initialize the bond property
      labels (:oe:meth:`OEDepict::OE2DBondDisplay::GetProperty`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor` method
         * :ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>` class
         * :ref:`OEDisplayBondIdx <OEDepict_OEDisplayBondIdx>` class
         * :ref:`OEDisplayNoBondProp <OEDepict_OEDisplayNoBondProp>` class

   .. _OEDepict_GetBondStereoStyle:

   .. oe:method:: GetBondStereoStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetBondStereoStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondStereoStyle() -> int

      Returns the style that controls what bond stereo information is displayed.
      The return value is taken from the :oe:constns:`OEDepict::OEBondStereoStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle` method
         * :oe:constns:`OEDepict::OEBondStereoStyle` namespace

   .. _OEDepict_GetBondSVGMarkupFunctor:

   .. oe:method:: GetBondSVGMarkupFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEBondSVGMarkupBase& GetBondSVGMarkupFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondSVGMarkupFunctor() -> OEBondSVGMarkupBase

      Returns the functor that defines how bonds are marked in
      :file:`svg` image.
      By default, residues are not marked (:ref:`OEBondSVGNoMarkup <OEDepict_OEBondSVGNoMarkup>`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondSVGMarkupFunctor` method

   .. _OEDepict_GetBondWidthScaling:

   .. oe:method:: GetBondWidthScaling

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetBondWidthScaling() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondWidthScaling() -> bool

      Returns whether the line width of the bond are increase or decreased based
      on the molecule scaling factor (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale`)

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondWidthScaling` method

   .. _OEDepict_GetDefaultBondPen:

   .. oe:method:: GetDefaultBondPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEPen& GetDefaultBondPen() const

      .. oe:language:: python

         .. oe:api:: python

            GetDefaultBondPen() -> OEPen

      Returns the pen that is used to initialize the bond pens
      (:oe:meth:`OEDepict::OE2DBondDisplay::GetBgnPen` and
      :oe:meth:`OEDepict::OE2DBondDisplay::GetBgnPen`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen` method
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. _OEDepict_GetExplicitAtomLabelAngle:

   .. oe:method:: GetExplicitAtomLabelAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetExplicitAtomLabelAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetExplicitAtomLabelAngle() -> float

      In the case of an almost linear X-C-X bond, an explicit "C" label
      will be drawn if the angle is more that the returned value of this
      function. 180.0 degree means that the "C" label will never be drawn.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetExplicitAtomLabelAngle` method

   .. _OEDepict_GetHeight:

   .. oe:method:: GetHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeight() -> float

      Returns the vertical limit into which the molecule has to be fitted.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetHeight` method

   .. _OEDepict_GetHydrogenStyle:

   .. oe:method:: GetHydrogenStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetHydrogenStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetHydrogenStyle() -> int

      Returns the style that controls of how implicit and explicit
      hydrogens are displayed.
      The return value is taken from the :oe:constns:`OEDepict::OEHydrogenStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle` method
         * :oe:constns:`OEDepict::OEHydrogenStyle` namespace

   .. _OEDepict_GetMargin:

   .. oe:method:: GetMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMargin(unsigned int margin) const

      .. oe:language:: python

         .. oe:api:: python

            GetMargin(margin: int) -> float

      Returns the ratio of a specific margin of the
      :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object.

      *margin*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetMargin` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetMargins` method
         * :oe:constns:`OEDepict::OEMargin` namespace

   .. _OEDepict_GetProtectiveGroupLabelFont:

   .. oe:method:: GetProtectiveGroupLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont& GetProtectiveGroupLabelFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetProtectiveGroupLabelFont() -> OEFont

      Returns the font that is used to display the protective group labels.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. _OEDepict_GetProtectiveGroupStyle:

   .. oe:method:: GetProtectiveGroupStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetProtectiveGroupStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetProtectiveGroupStyle() -> int

      Returns the style that controls whether or not specific pre-defined
      protective group are contracted and labeled with corresponding
      abbreviations.
      The return value is taken from the :oe:constns:`OEDepict::OEProtectiveGroupStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::HasProtectiveGroupStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle` method
         * :oe:constns:`OEDepict::OESuperAtomStyle` namespace
   
   .. warning::

      |DEPRECATED-API|
      Please use :oe:meth:`OEDepict::OE2DMolDisplayOptions::HasProtectiveGroupStyle` 
      to determine which protective groups are set.     

   .. _OEDepict_GetScale:

   .. oe:method:: GetScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetScale() -> float

      Returns the scaling factor used to magnify a molecule.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetScale` method

   .. _OEDepict_GetSuperAtomLabelFont:

   .. oe:method:: GetSuperAtomLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont& GetSuperAtomLabelFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuperAtomLabelFont() -> OEFont

      Returns the font that is used to display the abbreviations
      of contracted functional groups.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupStyle` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. _OEDepict_GetSuperAtomStyle:

   .. oe:method:: GetSuperAtomStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSuperAtomStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuperAtomStyle() -> int

      Returns the style that controls whether or not specific pre-defined
      functional groups are contracted and labeled with corresponding
      abbreviations.
      The return value is taken from the :oe:constns:`OEDepict::OESuperAtomStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupStyle` method
         * :oe:constns:`OEDepict::OESuperAtomStyle` namespace

   .. _OEDepict_GetTitleFont:

   .. oe:method:: GetTitleFont

      Returns the font that is used to display the title of the molecule
      (*i.e.* the string returned by the :oe:meth:`OEChem::OEMolBase::GetTitle`
      method).

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont& GetTitleFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitleFont() -> OEFont

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFontScale` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. _OEDepict_GetTitleFontScale:

   .. oe:method:: GetTitleFontScale

      Returns the multiplier that can be used to increase or decrease
      the size of the title font.

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTitleFontScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitleFontScale() -> float

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFontScale` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFont` method

   .. _OEDepict_GetTitleLocation:

   .. oe:method:: GetTitleLocation

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetTitleLocation() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitleLocation() -> int

      Returns the position of the molecule title.
      The return value is taken from the :oe:constns:`OEDepict::OETitleLocation`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleLocation` method
         * :oe:constns:`OEDepict::OETitleLocation` namespace

   .. _OEDepict_GetTitleHeight:

   .. oe:method:: GetTitleHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTitleHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitleHeight() -> float

      Returns the height of the title area.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleHeight` method

   .. _OEDepict_GetWidth:

   .. oe:method:: GetWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetWidth() -> float

      Returns the horizontal limit into which the molecule has to be fitted.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetWidth` method

   .. _OEDepict_HasProtectiveGroupStyle:

   .. oe:method:: HasProtectiveGroupStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasProtectiveGroupStyle(unsigned int style) const

      .. oe:language:: python

         .. oe:api:: python

            HasProtectiveGroupStyle(style: int) -> bool

      Returns true if the specific pre-defined protective group style is contracted 
      and labeled with corresponding abbreviations.
      
      *style*
         This value has to be from the :oe:constns:`OEDepict::OEProtectiveGroupStyle`
         namespace.

   .. _OEDepict_SetAromaticStyle:

   .. oe:method:: SetAromaticStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAromaticStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetAromaticStyle(style: int) -> None

      Sets the style that controls how aromatic rings are displayed.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEAromaticStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetAromaticStyle method<figure_OE2DMolDisplayOptions_SetAromaticStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-AROMATIC-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-AROMATIC-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-AROMATIC-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-AROMATIC-STYLE

      .. _figure_OE2DMolDisplayOptions_SetAromaticStyle:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetAromaticStyle.*
         :align:  center

         **Example of using the SetAromaticStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAromaticStyle` method
         * :oe:constns:`OEDepict::OEAromaticStyle` namespace

   .. _OEDepict_SetAtomColor:

   .. oe:method:: SetAtomColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomColor(unsigned int atomic,
                              const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomColor(atomic: int, color: OEColor) -> None

      Sets the color associated with a specific atomic number.

      *atomic*
         This value has to be from the :oe:constns:`OEChem::OEElemNo`
         namespace of **OEChem TK**.

      *color*
         The color being associated with the given atomic number.

      **Example:** (:ref:`Figure: Example of using the SetAtomColor method<figure_OE2DMolDisplayOptions_SetAtomColor>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR

      .. _figure_OE2DMolDisplayOptions_SetAtomColor:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetAtomColor.*
         :align:  center

         **Example of using the SetAtomColor method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomColor` method
         * :ref:`OEColor <OESystem_OEColor>` class
         * :ref:`chapter_element_color` section
  
      .. note::

         * The color of the atom also depends on the atom color style (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle`).
         * Setting atom color style (:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle`) 
           to WhiteMonochrome sets white background and black color for all atoms. Likewise, setting 
           atom color style to BlackMonochrome sets black background and white color for all atoms. 
           But, user can choose to have another color for all atoms (in monochrome atom color style) by 
           setting another atom color (:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomColor`) for Carbon atoms. 
           The example in :oe:src:`Listing 4<SNIPPET-DEPICT-MOL-GRAPH-DepictMolGraph>` demonstrates setting non-default atom colors in monochrome mode. 
           Setting atom color for other than Carbon atoms sets color of only specified atom types, not for all atoms.

   .. _OEDepict_SetAtomColorStyle:

   .. oe:method:: SetAtomColorStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomColorStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomColorStyle(style: int) -> None

      Sets the style that is used to define the color of the background and the
      default color of atom labels.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEAtomColorStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetAtomColorStyle method<figure_OE2DMolDisplayOptions_SetAtomColorStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR-STYLE

      .. _figure_OE2DMolDisplayOptions_SetAtomColorStyle:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetAtomColorStyle.*
         :align:  center

         **Example of using the SetAtomColorStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle` method
         * :oe:constns:`OEDepict::OEAtomColorStyle` namespace

   .. _OEDepict_SetAtomLabelFont:

   .. oe:method:: SetAtomLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomLabelFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelFont(font: OEFont) -> None

      Sets the font that is used to initialize the depiction style
      of the atom labels
      (:oe:meth:`OEDepict::OE2DAtomDisplay::GetLabelFont`).

      **Example:** (:ref:`Figure: Example of using the SetAtomLabelFont method<figure_OE2DMolDisplayOptions_SetAtomLabelFont>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT

      .. _figure_OE2DMolDisplayOptions_SetAtomLabelFont:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetAtomLabelFont.*
         :align:  center

         **Example of using the SetAtomLabelFont method**

      .. note::

         * The color of the atom label fonts also depends on
           the atom color style (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle`).

         * The size of fonts of the atom labels also depends on:

           - the scaling factor used to fit a molecule to a given dimension
             (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale`)
           - the multiplier set by the
             :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale`
             method

           See example in :ref:`Figure: Example of scaling the font of the atom label
           along with the molecule<figure_OE2DMolDisplayOptions_SetAtomLabelFont_Scaling>`

      .. _figure_OE2DMolDisplayOptions_SetAtomLabelFont_Scaling:

      .. figure:: depicttk/images/AtomLabelFontScaling.*
         :align:  center

         **Example of scaling the font of the atom label along with the molecule**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomLabelFont` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. _OEDepict_SetAtomLabelFontScale:

   .. oe:method:: SetAtomLabelFontScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomLabelFontScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelFontScale(scale: float) -> None

      Sets the multiplier that can be used increase or decrease the
      size of the fonts of the atom labels.

      *scale*
         This value has to be either ``0.0`` or in a range of ``[0.5, 3.0]``.
         See examples in :ref:`Figure: Examples of scaling the font of the atom label relative to the molecule
         <figure_OE2DMolDisplayOptions_SetAtomLabelFont_ScalingFactor>`

         In case of ``0.0``, the atom labels are not scaled with the molecule
         but rather fixed font size are used regardless of the size of the molecule.
         See example in :ref:`Figure: Example of atom labels with fixed font size
         <figure_OE2DMolDisplayOptions_SetAtomLabelFont_NoScaling>`

      .. _figure_OE2DMolDisplayOptions_SetAtomLabelFont_ScalingFactor:

      .. figure:: depicttk/images/AtomLabelFontScalingFactor.*
         :align:  center

         **Examples of scaling the font of the atom label relative to the molecule**

      .. _figure_OE2DMolDisplayOptions_SetAtomLabelFont_NoScaling:

      .. figure:: depicttk/images/NoAtomLabelFontScaling.*
         :align:  center

         **Example of atom labels with fixed font size**

      **Example:** (:ref:`Figure: Example of using the SetAtomLabelFontScale method<figure_OE2DMolDisplayOptions_SetAtomLabelFontScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT-SCALE

      .. _figure_OE2DMolDisplayOptions_SetAtomLabelFontScale:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetAtomLabelFontScale.*
         :align:  center

         **Example of using the SetAtomLabelFontScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomLabelFontScale` method

   .. _OEDepict_SetAtomPropLabelFont:

   .. oe:method:: SetAtomPropLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomPropLabelFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomPropLabelFont(cont: OEFont) -> None

      Sets the font that is used to initialize the depiction style
      of the atom property labels
      (:oe:meth:`OEDepict::OE2DAtomDisplay::GetPropertyFont`).

      **Example:** (:ref:`Figure: Example of using the SetAtomPropLabelFont method<figure_OE2DMolDisplayOptions_SetAtomPropLabelFont>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT

      .. _figure_OE2DMolDisplayOptions_SetAtomPropLabelFont:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetAtomPropLabelFont.*
         :align:  center

         **Example of using the SetAtomPropLabelFont method**

      .. note::

         * The size of the atom property label fonts also depends on
           the scaling factor used to fit a molecule to a given dimension
           (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale`)
           and the multiplier set by the
           :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale`
           method.
           See example in
           :ref:`Figure: Example of scaling the font of the atom property labels
           along with the molecule<figure_OE2DMolDisplayOptions_SetAtomLabelFont_Scaling>`

      .. _figure_OE2DMolDisplayOptions_SetAtomPropLabelFont_Scaling:

      .. figure:: depicttk/images/AtomPropLabelFontScaling.*
         :align:  center

         **Example of scaling the font of the atom property labels along with the molecule**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFont` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. _OEDepict_SetAtomPropLabelFontScale:

   .. oe:method:: SetAtomPropLabelFontScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomPropLabelFontScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomPropLabelFontScale(scale: float) -> None

      Sets the multiplier that can be used increase or decrease the
      size of the fonts of the atom property labels.

      *scale*
         This value has to be in the range of ``[0.5, 2.0]``.
         See examples in :ref:`Figure: Examples of scaling the font of the atom property labels relative to the molecule
         <figure_OE2DMolDisplayOptions_SetPropAtomLabelFont_ScalingFactor>`

      .. _figure_OE2DMolDisplayOptions_SetPropAtomLabelFont_ScalingFactor:

      .. figure:: depicttk/images/AtomPropLabelFontScalingFactor.*
         :align:  center

         **Examples of scaling the font of the atom property labels relative to the molecule**

      **Example:** (:ref:`Figure: Example of using the SetAtomPropLabelFontScale method<figure_OE2DMolDisplayOptions_SetAtomPropLabelFontScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT-SCALE

      .. _figure_OE2DMolDisplayOptions_SetAtomPropLabelFontScale:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetAtomPropLabelFontScale.*
         :align:  center

         **Example of using the SetAtomPropLabelFontScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFontScale` method

   .. _OEDepict_SetAtomPropertyFunctor:

   .. oe:method:: SetAtomPropertyFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomPropertyFunctor(const OEDisplayAtomPropBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomPropertyFunctor(func: OEDisplayAtomPropBase) -> None

      Sets the functor that is used to initialize the atom property
      labels (:oe:meth:`OEDepict::OE2DAtomDisplay::GetProperty`)

      **Example:** (:ref:`Figure: Example of using the SetAtomPropertyFunctor method<figure_OE2DMolDisplayOptions_SetAtomPropertyFunctor>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROPERTY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROPERTY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROPERTY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROPERTY-FUNCTOR

      .. _figure_OE2DMolDisplayOptions_SetAtomPropertyFunctor:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetAtomPropertyFunctor.*
         :align:  center

         **Example of using the SetAtomPropertyFunctor method**

      .. hint::

         It is recommended to use the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor`
         method to define the atom property labels when the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`
         object is constructed.
         All labels displayed on the molecule diagram have to be known in advance in order to be
         able to minimize the number of label clashes and clippings when calculating
         the positions of the bond property labels.

         See example of user-defined atom properties in :ref:`section_mol_display_atom_prop`
         section.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomPropertyFunctor` method
         * :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>` class
         * :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>` class
         * :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>` class
         * :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>` class

   .. _OEDepict_SetAtomStereoStyle:

   .. oe:method:: SetAtomStereoStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomStereoStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomStereoStyle(style: int) -> None

      Sets the style that controls what atom stereo information is displayed.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEAtomStereoStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetAtomStereoStyle method<figure_OE2DMolDisplayOptions_SetAtomStereoStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-STEREO-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-STEREO-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-STEREO-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-STEREO-STYLE

      .. _figure_OE2DMolDisplayOptions_SetAtomStereoStyle:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetAtomStereoStyle.*
         :align:  center

         **Example of using the SetAtomStereoStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomStereoStyle` method
         * :oe:constns:`OEDepict::OEAtomStereoStyle` namespace

   .. _OEDepict_SetAtomSVGMarkupFunctor:

   .. oe:method:: SetAtomSVGMarkupFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomSVGMarkupFunctor(const OEAtomSVGMarkupBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomSVGMarkupFunctor(func: OEAtomSVGMarkupBase) -> None

      Sets the functor that defines how atoms are marked in :file:`svg` image.
      Drawing elements representing atoms in :file:`svg` image are grouped together
      in the following format in which the ``<group id>`` and ``<class name>``
      strings are defined by the given functor:

      ::

          <g id='<group id>' class='<class name>'>
          ..
          list of drawing elements
          ..
          </g>

      .. note::

         This setting has only effect when generating :file:`.svg`
         images.

      .. seealso::

         * :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>` abstract base class
         * :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>` class
         * :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>` class
         * :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>` class
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomSVGMarkupFunctor` method

   .. _OEDepict_SetAtomVisibilityFunctor:

   .. oe:method:: SetAtomVisibilityFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomVisibilityFunctor(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& func)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomVisibilityFunctor(func: OEUnaryAtomPred) -> None

      Sets the functor that is used to identify visible atoms.

      **Example:** (:ref:`Figure: Example of using the SetAtomVisibilityFunctor method<figure_OE2DMolDisplayOptions_SetAtomVisibilityFunctor>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-VISIBILITY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-VISIBILITY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-VISIBILITY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-VISIBILITY-FUNCTOR

      .. _figure_OE2DMolDisplayOptions_SetAtomVisibilityFunctor:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetAtomVisibilityFunctor.*
         :align:  center

         **Example of using the SetAtomVisibilityFunctor method to only display rings**

      .. hint::

         It is recommended to use the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomVisibilityFunctor`
         method to identify the visible atoms when the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`
         object is constructed. All objects displayed in the molecule diagram have to be known in advance in order to be
         able to correctly size and scale the molecule.

         See additional examples of atom visibility control in the :ref:`section_mol_display_atom_prop`
         section.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomVisibilityFunctor` method
         * :oe:cls:`OEUnaryAtomPred<OESystem::OEUnaryPredicate>`

   .. _OEDepict_SetBackgroundColor:

   .. oe:method:: SetBackgroundColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBackgroundColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetBackgroundColor(color: OEColor) -> None

      Sets the color that is used to clear the background of an image
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      before rendering the molecule.

      **Example:** (:ref:`Figure: Example of using the SetBackgroundColor method<figure_OE2DMolDisplayOptions_SetBackgroundColor>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BACKGROUND-COLOR

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BACKGROUND-COLOR

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BACKGROUND-COLOR

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BACKGROUND-COLOR

      .. _figure_OE2DMolDisplayOptions_SetBackgroundColor:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetBackgroundColor.*
         :align:  center

         **Example of using the SetBackgroundColor method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBackgroundColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. _OEDepict_SetBondColorStyle:

   .. oe:method:: SetBondColorStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBondColorStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetBondColorStyle(style: int) -> None

      Sets the style that controls how bonds are colored.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEBondColorStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetBondColorStyle method<figure_OE2DMolDisplayOptions_SetBondColorStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-COLOR-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-COLOR-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-COLOR-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-COLOR-STYLE

      .. _figure_OE2DMolDisplayOptions_SetBondColorStyle:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetBondColorStyle.*
         :align:  center

         **Example of using the SetBondColorStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondColorStyle` method
         * :oe:constns:`OEDepict::OEBondColorStyle` namespace

   .. _OEDepict_SetBondLineGapScale:

   .. oe:method:: SetBondLineGapScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBondLineGapScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetBondLineGapScale(scale: float) -> None

      Sets the multiplier that can be used increase or decrease the
      gap between the lines of double and triple bonds.

      *scale*
         This value has to be in the range of ``[0.5, 2.0]``.
         See examples in :ref:`Figure: Examples of altering the gap between the lines of double and triple bonds
         <figure_OE2DMolDisplayOptions_BondLineGapScale>`

      .. _figure_OE2DMolDisplayOptions_BondLineGapScale:

      .. figure:: depicttk/images/BondLineGapScale.*
         :align:  center

         **Examples of altering the gap between the lines of double and triple bonds**

      **Example:** (:ref:`Figure: Example of using the SetBondLineGapScale method<figure_OE2DMolDisplayOptions_SetBondLineGapScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-GAP-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-GAP-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-GAP-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-GAP-SCALE

      .. _figure_OE2DMolDisplayOptions_SetBondLineGapScale:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetBondLineGapScale.*
         :align:  center

         **Example of using the SetBondLineGapScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondLineGapScale` method

   .. _OEDepict_SetBondLineAtomLabelGapScale:

   .. oe:method:: SetBondLineAtomLabelGapScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBondLineAtomLabelGapScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetBondLineAtomLabelGapScale(scale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the gap between the line(s) of bonds and the adjacent atom labels.

      *scale*
         This value has to be in the range of ``[0.5, 2.0]``.
         See examples in :ref:`Figure: Examples of altering the gap between the line(s) of bonds and adjacent atom labels
         <figure_OE2DMolDisplayOptions_BondLineAtomLabelGapScale>`

      .. _figure_OE2DMolDisplayOptions_BondLineAtomLabelGapScale:

      .. figure:: depicttk/images/BondLineAtomLabelGapScale.*
         :align:  center

         **Examples of altering the gap between the line(s) of bonds and adjacent atom labels**

      **Example:** (:ref:`Figure: Example of using the SetBondLineAtomLabelGapScale method<figure_OE2DMolDisplayOptions_SetBondLineAtomLabelGapScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-ATOM-LABEL-GAP-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-ATOM-LABEL-GAP-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-ATOM-LABEL-GAP-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-ATOM-LABEL-GAP-SCALE

      .. _figure_OE2DMolDisplayOptions_SetBondLineAtomLabelGapScale:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetBondLineAtomLabelGapScale.*
         :align:  center

         **Example of using the SetBondLineAtomLabelGapScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondLineAtomLabelGapScale` method

   .. _OEDepict_SetBondPropLabelFont:

   .. oe:method:: SetBondPropLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBondPropLabelFont(const OEFont& color)

      .. oe:language:: python

         .. oe:api:: python

            SetBondPropLabelFont(color: OEFont) -> None

      Sets the font that is used to initialize the depiction style
      of the bond property labels
      (:oe:meth:`OEDepict::OE2DBondDisplay::GetPropertyFont`).

      **Example:** (:ref:`Figure: Example of using the SetBondPropLabelFont method<figure_OE2DMolDisplayOptions_SetBondPropLabelFont>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT

      .. _figure_OE2DMolDisplayOptions_SetBondPropLabelFont:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetBondPropLabelFont.*
         :align:  center

         **Example of using the SetBondPropLabelFont method**

      .. note::

         * The size of the bond property label fonts also depends on
           the scaling factor used to fit a molecule to a given dimension
           (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale`)
           and the multiplier set by the
           :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale`
           method.
           See example in
           :ref:`Figure: Example of scaling the font of the bond property labels
           along with the molecule<figure_OE2DMolDisplayOptions_SetBondPropLabelFont_Scaling>`

      .. _figure_OE2DMolDisplayOptions_SetBondPropLabelFont_Scaling:

      .. figure:: depicttk/images/BondPropLabelFontScaling.*
         :align:  center

         **Example of scaling the font of the bond property labels along with the molecule**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFont` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. _OEDepict_SetBondPropLabelFontScale:

   .. oe:method:: SetBondPropLabelFontScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBondPropLabelFontScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetBondPropLabelFontScale(scale: float) -> None

      Sets the multiplier that can be used increase or decrease the
      size of the fonts of the bond property labels.

      *scale*
         This value has to be in the range of ``[0.5, 2.0]``.
         See examples in :ref:`Figure:*Examples of scaling the font of the bond property labels relative to the molecule
         SetBondPropLabelFontScale method<figure_OE2DMolDisplayOptions_SetPropBondLabelFont_ScalingFactor>`

      .. _figure_OE2DMolDisplayOptions_SetPropBondLabelFont_ScalingFactor:

      .. figure:: depicttk/images/BondPropLabelFontScalingFactor.*
         :align:  center

         **Examples of scaling the font of the bond property labels relative to the molecule**

      **Example:** (:ref:`Figure: Example of using the SetBondPropLabelFontScale method<figure_OE2DMolDisplayOptions_SetBondPropLabelFontScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT-SCALE

      .. _figure_OE2DMolDisplayOptions_SetBondPropLabelFontScale:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetBondPropLabelFontScale.*
         :align:  center

         **Example of using the SetBondPropLabelFontScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFontScale` method

   .. _OEDepict_SetBondPropertyFunctor:

   .. oe:method:: SetBondPropertyFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBondPropertyFunctor(const OEDisplayBondPropBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetBondPropertyFunctor(func: OEDisplayBondPropBase) -> None

      Sets the functor that is used to initialize the bond property
      labels (:oe:meth:`OEDepict::OE2DBondDisplay::GetProperty`)

      **Example:** (:ref:`Figure: Example of using the SetBondPropertyFunctor method<figure_OE2DMolDisplayOptions_SetBondPropertyFunctor>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROPERTY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROPERTY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROPERTY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROPERTY-FUNCTOR

      .. _figure_OE2DMolDisplayOptions_SetBondPropertyFunctor:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetBondPropertyFunctor.*
         :align:  center

         **Example of using the SetBondPropertyFunctor method**

      .. hint::

         It is recommended to use the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor`
         method to define the bond property labels when the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`
         object is constructed.
         All labels displayed on the molecule diagram have to be known in advance in order to be
         able to minimize the number of label clashes and clippings when calculating
         the positions of the bond property labels.

         See example of user-defined bond properties in :ref:`section_mol_display_bond_prop`
         section.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondPropertyFunctor` method
         * :ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>` class
         * :ref:`OEDisplayBondIdx <OEDepict_OEDisplayBondIdx>` class
         * :ref:`OEDisplayNoBondProp <OEDepict_OEDisplayNoBondProp>` class

   .. _OEDepict_SetBondStereoStyle:

   .. oe:method:: SetBondStereoStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBondStereoStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetBondStereoStyle(style: int) -> None

      Sets the style that controls what bond stereo information is displayed.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEBondStereoStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetBondStereoStyle method<figure_OE2DMolDisplayOptions_SetBondStereoStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-STEREO-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-STEREO-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-STEREO-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-STEREO-STYLE

      .. _figure_OE2DMolDisplayOptions_SetBondStereoStyle:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetBondStereoStyle.*
         :align:  center

         **Example of using the SetBondStereoStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondStereoStyle` method
         * :oe:constns:`OEDepict::OEBondStereoStyle` namespace

   .. _OEDepict_SetBondSVGMarkupFunctor:

   .. oe:method:: SetBondSVGMarkupFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBondSVGMarkupFunctor(const OEBondSVGMarkupBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetBondSVGMarkupFunctor(func: OEBondSVGMarkupBase) -> None

      Sets the functor that defines how bonds are marked in :file:`svg` image.
      Drawing elements representing bonds in :file:`svg` image are grouped together
      in the following format in which the ``<group id>`` and ``<class name>``
      strings are defined by the given functor:

      ::

          <g id='<group id>' class='<class name>'>
          ..
          list of drawing elements
          ..
          </g>

      .. note::

         This setting has only effect when generating :file:`.svg`
         images.

      .. seealso::

         * :ref:`OEBondSVGMarkupBase <OEDepict_OEBondSVGMarkupBase>` abstract base class
         * :ref:`OEBondSVGNoMarkup <OEDepict_OEBondSVGNoMarkup>` class
         * :ref:`OEBondSVGBondIdxMarkup <OEDepict_OEBondSVGBondIdxMarkup>` class
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondSVGMarkupFunctor` method

   .. _OEDepict_SetBondWidthScaling:

   .. oe:method:: SetBondWidthScaling

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBondWidthScaling(bool scale)

      .. oe:language:: python

         .. oe:api:: python

            SetBondWidthScaling(scale: bool) -> None

      Sets whether the line width of the bond are increase or decreased based
      on the molecule scaling factor (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale`).
      See examples in :ref:`Figure: Examples of bond line width <figure_OE2DMolDisplayOptions_BondWidthScaling>`.

      .. note::

         * The line width of the bonds also depends on the default bond pen that
           can be set by using the
           :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen` method.

      .. _figure_OE2DMolDisplayOptions_BondWidthScaling:

      .. figure:: depicttk/images/BondWidthScaling.*
         :align:  center

         **Examples of bond line width: (A) scaling the line width of the bonds relative
         to the molecule; (B) using constant line width that does not depend on the
         molecule scaling**

      **Example:** (:ref:`Figure: Example of using the SetBondWithScaling method<figure_OE2DMolDisplayOptions_SetBondWidthScaling>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-WIDTH-SCALING

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-WIDTH-SCALING

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-WIDTH-SCALING

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-WIDTH-SCALING

      .. _figure_OE2DMolDisplayOptions_SetBondWidthScaling:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetBondWidthScaling.*
         :align:  center

         **Example of using the SetBondWidthScaling method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondWidthScaling` method

   .. _OEDepict_SetDefaultBondPen:

   .. oe:method:: SetDefaultBondPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDefaultBondPen(const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            SetDefaultBondPen(pen: OEPen) -> None

      Sets the pen that is used to initialize the bond pens
      (:oe:meth:`OEDepict::OE2DBondDisplay::GetBgnPen` and
      :oe:meth:`OEDepict::OE2DBondDisplay::GetEndPen`)

      **Example:** (:ref:`Figure: Example of using the SetDefaultBondPen method<figure_OE2DMolDisplayOptions_SetDefaultBondPen>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DEFAULT-BOND-PEN

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DEFAULT-BOND-PEN

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DEFAULT-BOND-PEN

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DEFAULT-BOND-PEN

      .. _figure_OE2DMolDisplayOptions_SetDefaultBondPen:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetDefaultBondPen.*
         :align:  center

         **Example of using the SetDefaultBondPen method**

      .. note::

         * The style of the pens being used to draw bonds also depends on
           the bond display style (:ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>`)

         * The color of the pens being used to draw bonds also depends on
           the given atom and bond color styles
           (:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle` and
           :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondColorStyle`,
           respectively)

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetDefaultBondPen` method
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. _OEDepict_SetDimensions:

   .. oe:method:: SetDimensions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDimensions(double width, double height, double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetDimensions(width: float, height: float, scale: float) -> None

      Sets parameters that control the size of the depicted molecule.

      *width*
         A non-negative number that controls the horizontal limit.

      *height*
         A non-negative number that controls the vertical limit.

      *scale*
         A non-negative number that controls the magnification of the
         depicted molecule.
         :oe:const:`OEDepict::OEScale::AutoScale` scaling means
         that the molecule is scaled to maximally fit the given dimensions.

      **Example:** (:ref:`Figure: Example of using the SetDimensions method<figure_OE2DMolDisplayOptions_SetDimensions>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DIMENSIONS

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DIMENSIONS

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DIMENSIONS

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DIMENSIONS

      .. _figure_OE2DMolDisplayOptions_SetDimensions:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetDimensions.*
         :align:  center

         **Example of using the SetDimensions method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetHeight` and :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetHeight` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale`  and :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetScale` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetWidth`  and :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetWidth` method
         * :ref:`section_mol_display_size` section

   .. _OEDepict_SetExplicitAtomLabelAngle:

   .. oe:method:: SetExplicitAtomLabelAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetExplicitAtomLabelAngle(const double angle)

      .. oe:language:: python

         .. oe:api:: python

            SetExplicitAtomLabelAngle(angle: float) -> None

      In the case of an almost linear X-C-X bond, an explicit "C" label
      will be drawn if the angle is more that the given angle.
      180.0 degree means that the "C" label will never be drawn.

      .. _figure_OE2DMolDisplayOptions_SetExplicitAtomLabelAngle:

      .. figure:: depicttk/images/OE2DMolDisplay_SetExplicitAtomLabelAngle.*
         :align:  center

         **Example of using the SetExplicitAtomLabelAngle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetExplicitAtomLabelAngle` method

   .. _OEDepict_SetHeight:

   .. oe:method:: SetHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHeight(double height)

      .. oe:language:: python

         .. oe:api:: python

            SetHeight(height: float) -> None

      Sets the vertical limit into which the molecule has to be fitted.

      *height*
         This number has to be non-negative number.

      **Example:** (:ref:`Figure: Example of using the SetHeight method<figure_OE2DMolDisplayOptions_SetHeight>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HEIGHT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HEIGHT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HEIGHT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HEIGHT

      .. _figure_OE2DMolDisplayOptions_SetHeight:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetHeight.*
         :align:  center

         **Example of using the SetHeight method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetHeight` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method
         * :ref:`section_mol_display_size` section

   .. _OEDepict_SetHydrogenStyle:

   .. oe:method:: SetHydrogenStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHydrogenStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetHydrogenStyle(style: int) -> None

      Sets the style that controls how implicit and explicit
      hydrogens are displayed.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEHydrogenStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetHydrogenStyle method<figure_OE2DMolDisplayOptions_SetHydrogenStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HYDROGEN-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HYDROGEN-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HYDROGEN-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HYDROGEN-STYLE

      .. _figure_OE2DMolDisplayOptions_SetHydrogenStyle:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetHydrogenStyle.*
         :align:  center

         **Example of using the SetHydrogenStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetHydrogenStyle` method
         * :oe:constns:`OEDepict::OEHydrogenStyle` namespace

   .. _OEDepict_SetMargin:

   .. oe:method:: SetMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMargin(unsigned int marginloc, double margin)

      .. oe:language:: python

         .. oe:api:: python

            SetMargin(margin: int, percent: float) -> bool

      Sets the size of a specific margin of the
      :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object.

      *marginloc*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      *margin*
         This number is considered as a percentage of either the width or the height
         of the molecule display and has to be in the range of ``[2.5%, 25.0%]``.
         See example in :ref:`Table: Example of setting specific margins to 5% (default), 15% and 25%
         <table_OE2DMolDisplayLayout_SetMargin>`.
         For example, when setting a margin to 15.0%:

         - in case of the **top** or the **bottom** margins, it means that the margin will be 15% of the total height
           of the molecule display
         - in case of the **left** or the **right** margins, it means that the margin will be 15% of the total width
           of the molecule display

      .. _table_OE2DMolDisplayLayout_SetMargin:

      .. list-table:: **Example of setting specific margins to 5% (default), 15% and 25%**
         :widths: 250 250

         * - **top margin**
           - **bottom margin**
         * - .. image:: ../images/OE2DMolDisplayLayout_SetMargin_Top.*
           - .. image:: ../images/OE2DMolDisplayLayout_SetMargin_Bottom.*

         * - **left margin**
           - **right margin**

         * - .. image:: ../images/OE2DMolDisplayLayout_SetMargin_Left.*
           - .. image:: ../images/OE2DMolDisplayLayout_SetMargin_Right.*

      **Example:** (:ref:`Figure: Example of using the SetMargin method<figure_OE2DMolDisplayOptions_SetMargin>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGIN

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGIN

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGIN

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGIN

      .. _figure_OE2DMolDisplayOptions_SetMargin:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetMargin.*
         :align:  center

         **Example of using the SetMargin method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetMargin` method
         * :oe:constns:`OEDepict::OEMargin` namespace

   .. _OEDepict_SetMargins:

   .. oe:method:: SetMargins

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMargins(double margin)

      .. oe:language:: python

         .. oe:api:: python

            SetMargins(percent: float) -> bool

      Sets the size of all margins of the
      :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object.

      *margin*
         This number is considered as a percentage of either the width or the height
         of the molecule display and has to be in the range of ``[2.5%, 25.0%]``.
         For example, 15.0% means, that the left and right margin
         are 15% of the total width of the molecule display, and the top and bottom margins
         are 15% of the total height of the molecule display.
         See example in :ref:`Figure: Example of setting all margins to 5% (default), 15% and 25%
         <figure_OE2DMolDisplayLayout_SetMargins>`.

      .. _figure_OE2DMolDisplayLayout_SetMargins:

      .. figure:: depicttk/images/OE2DMolDisplayLayout_SetMargins.*
         :align:  center

         **Example of setting all margins to 5% (default), 15% and 25%**

      **Example:** (:ref:`Figure: Example of using the SetMargin method<figure_OE2DMolDisplayOptions_SetMargin>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGINS

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGINS

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGINS

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGINS

      .. _figure_OE2DMolDisplayOptions_SetMargins:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetMargins.*
         :align:  center

         **Example of using the SetMargins method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetMargin` method
         * :oe:constns:`OEDepict::OEMargin` namespace

   .. _OEDepict_SetProtectiveGroupLabelFont:

   .. oe:method:: SetProtectiveGroupLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetProtectiveGroupLabelFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetProtectiveGroupLabelFont(font: OEFont) -> None

      Sets the font that is used to display the abbreviations
      of contracted functional groups.

      **Example:** (:ref:`Figure: Example of using the ProtectiveGroupLabelFont method<figure_OE2DMolDisplayOptions_SetProtectiveGroupLabelFont>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-LABEL-FONT

      .. _figure_OE2DMolDisplayOptions_SetProtectiveGroupLabelFont:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetProtectiveGroupLabelFont.*
         :align:  center

         **Example of using the SetProtectiveGroupLabelFont method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetProtectiveGroupLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetProtectiveGroupStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle` method
         * :ref:`OEFont <OEDepict_OEFont>` class

      .. note::

         * The size of the protective group fonts also depends on
           the scaling factor used to fit a molecule to a given dimension
           (:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetScale`).

   .. _OEDepict_SetProtectiveGroupStyle:

   .. oe:method:: SetProtectiveGroupStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetProtectiveGroupStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetProtectiveGroupStyle(style: int) -> None

      Sets the style that controls whether or not specific pre-defined
      protective group are contracted and labeled with corresponding
      abbreviations.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEProtectiveGroupStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetProtectiveGroupStyle method<figure_OE2DMolDisplayOptions_SetProtectiveGroupStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-STYLE

      .. _figure_OE2DMolDisplayOptions_SetProtectiveGroupStyle:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetProtectiveGroupStyle.*
         :align:  center

         **Example of using the SetProtectiveGroupStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::HasProtectiveGroupStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetProtectiveGroupLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle` method
         * :oe:constns:`OEDepict::OEProtectiveGroupStyle` namespace

   .. _OEDepict_SetScale:

   .. oe:method:: SetScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetScale(scale: float) -> None

      Sets the scaling factor used to magnify a molecule.

      *scale*
         This number has to be non-negative number.

      **Example:** (:ref:`Figure: Example of using the SetScale method<figure_OE2DMolDisplayOptions_SetScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SCALE

      .. _figure_OE2DMolDisplayOptions_SetScale:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetScale.*
         :align:  center

         **Example of using the SetScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method
         * :ref:`section_mol_display_size` section

   .. _OEDepict_SetSuperAtomLabelFont:

   .. oe:method:: SetSuperAtomLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSuperAtomLabelFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetSuperAtomLabelFont(font: OEFont) -> None

      Sets the font that is used to display the abbreviations
      of contracted functional groups.

      **Example:** (:ref:`Figure: Example of using the SetSuperAtomLabelFont method<figure_OE2DMolDisplayOptions_SetSuperAtomLabelFont>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-LABEL-FONT

      .. _figure_OE2DMolDisplayOptions_SetSuperAtomLabelFont:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetSuperAtomLabelFont.*
         :align:  center

         **Example of using the SetSuperAtomLabelFont method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetSuperAtomLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle` method
         * :ref:`OEFont <OEDepict_OEFont>` class

      .. note::

         * The size of the super atom  fonts also depends on
           the scaling factor used to fit a molecule to a given dimension
           (:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetScale`).

   .. _OEDepict_SetSuperAtomStyle:

   .. oe:method:: SetSuperAtomStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSuperAtomStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetSuperAtomStyle(style: int) -> None

      Sets the style that controls whether or not specific pre-defined
      functional groups are contracted and labeled with corresponding
      abbreviations.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OESuperAtomStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetSuperAtomStyle method<figure_OE2DMolDisplayOptions_SetSuperAtomStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-STYLE

      .. _figure_OE2DMolDisplayOptions_SetSuperAtomStyle:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetSuperAtomStyle.*
         :align:  center

         **Example of using the SetSuperAtomStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetSuperAtomLabelFont` method
         * :oe:constns:`OEDepict::OESuperAtomStyle` namespace

   .. _OEDepict_SetTitleFont:

   .. oe:method:: SetTitleFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTitleFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetTitleFont(font: OEFont) -> None

      Sets the font that is used to display the title of the molecule
      (*i.e.* the string returned by the :oe:meth:`OEChem::OEMolBase::GetTitle`
      method).

      **Example:** (:ref:`Figure: Example of using the SetTitleFont method<figure_OE2DMolDisplayOptions_SetTitleFont>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT

      .. _figure_OE2DMolDisplayOptions_SetTitleFont:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetTitleFont.*
         :align:  center

         **Example of using the SetTitleFont method**

      .. note::

         The size of the title font also depends on:

         * the width and height of the molecule display

         * the height of the title area that can be set by :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleHeight`
           method

         * the multiplier that can be set by the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFontScale`
           method

         See example in :ref:`Figure: Example of scaling the title along with the molecule
         <figure_OE2DMolDisplayOptions_SetTitleFont_Scaling>`

      .. _figure_OE2DMolDisplayOptions_SetTitleFont_Scaling:

      .. figure:: depicttk/images/TitleFontScaling.*
         :align:  center

         **Example of scaling the title along with molecule**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetTitleFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFontScale` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleHeight` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. _OEDepict_SetTitleFontScale:

   .. oe:method:: SetTitleFontScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTitleFontScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetTitleFontScale(scale: float) -> None

      Sets the multiplier that can be used increase or decrease the
      size of the fonts of the atom labels.

      *scale*
         This value has to be either ``0.0`` or in a range of ``[0.5, 2.0]``.
         See examples in :ref:`Examples of scaling the font of title relative to the molecule
         <figure_OE2DMolDisplayOptions_SetTitleFont_ScalingFactor>`
         In case of ``0.0``, the title is not scaled with the molecule
         but rather fixed font size is used regardless of dimensions of the
         image.
         See example in :ref:`Figure: Example of titles with fixed font size<figure_OE2DMolDisplayOptions_SetTitleFont_NoScaling>`

      .. _figure_OE2DMolDisplayOptions_SetTitleFont_ScalingFactor:

      .. figure:: depicttk/images/TitleFontScalingFactor.*
         :align:  center

         **Examples of scaling the font of title relative to the molecule**

      .. _figure_OE2DMolDisplayOptions_SetTitleFont_NoScaling:

      .. figure:: depicttk/images/NoTitleFontScaling.*
         :align:  center

         **Example of titles with fixed font size**

      **Example:** (:ref:`Figure: Example of using the SetTitleFontScale method<figure_OE2DMolDisplayOptions_SetTitleFontScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT-SCALE

      .. _figure_OE2DMolDisplayOptions_SetTitleFontScale:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetTitleFontScale.*
         :align:  center

         **Example of using the SetTitleFontScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetTitleFontScale` method

   .. _OEDepict_SetTitleLocation:

   .. oe:method:: SetTitleLocation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTitleLocation(unsigned int loc)

      .. oe:language:: python

         .. oe:api:: python

            SetTitleLocation(loc: int) -> None

      Sets the position of the molecule title.

      *loc*
         This value has to be from the :oe:constns:`OEDepict::OETitleLocation`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetTitleLocation method<figure_OE2DMolDisplayOptions_SetTitleLocation>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-LOCATION

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-LOCATION

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-LOCATION

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-LOCATION

      .. _figure_OE2DMolDisplayOptions_SetTitleLocation:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetTitleLocation.*
         :align:  center

         **Example of using the SetTitleLocation method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetTitleLocation` method
         * :oe:constns:`OEDepict::OETitleLocation` namespace

   .. _OEDepict_SetTitleHeight:

   .. oe:method:: SetTitleHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTitleHeight(double height)

      .. oe:language:: python

         .. oe:api:: python

            SetTitleHeight(percent: float) -> bool

      Sets the height of the title area of the
      :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object.

      *height*
         This number is considered as a percentage of the height
         of the molecule display and has to be in the range of ``[5.0%, 25.0%]``.
         See example in :ref:`Figure: Example of setting height of the title area to 5%, 10% (default) and 25%
         <figure_OE2DMolDisplayLayout_SetTitleHeight>`.

      .. _figure_OE2DMolDisplayLayout_SetTitleHeight:

      .. figure:: depicttk/images/OE2DMolDisplayLayout_SetTitleHeight.*
         :align:  center

         **Example of setting height of the title area to 5%, 10% (default) and 25%**

      .. note::

         A molecule display has a title area only if the title location is not
         hidden. See also :oe:constns:`OEDepict::OETitleLocation` namespace.

      **Example:** (:ref:`Figure: Example of using the SetTitleHeight method<figure_OE2DMolDisplayOptions_SetTitleHeight>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-HEIGHT

      .. _figure_OE2DMolDisplayOptions_SetTitleHeight:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetTitleHeight.*
         :align:  center

         **Example of using the SetTitleHeight method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetTitleHeight` method

   .. _OEDepict_SetWidth:

   .. oe:method:: SetWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetWidth(double width)

      .. oe:language:: python

         .. oe:api:: python

            SetWidth(width: float) -> None

      Sets the horizontal limit into which the molecule has to be fitted.

      *width*
         This number has to be non-negative number.

      **Example:** (:ref:`Figure: Example of using the SetWidth method<figure_OE2DMolDisplayOptions_SetWidth>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-WIDTH

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-WIDTH

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-WIDTH

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-WIDTH

      .. _figure_OE2DMolDisplayOptions_SetWidth:

      .. figure:: depicttk/images/OE2DMolDisplayOptions_SetWidth.*
         :align:  center

         **Example of using the SetWidth method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetWidth` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method
         * :ref:`section_mol_display_size` section


.. oe:namespace:: OEDepict


.. |Bezier|    replace:: Bézier



.. meta::
   :keywords: OE2DPath, 2DPath

.. _OEDepict_OE2DPath:

.. oe:class:: OE2DPath

   .. oe:api::

      class OE2DPath

   A sequence of lines and curves.

   .. _figure_OE2DPath:

   .. figure:: depicttk/images/OEImageBase-DrawPath.*
      :align:  center
      :scale:  100

      **Example of path**

   .. seealso::

      * :oe:meth:`OEDepict::OEImageBase::DrawPath`

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPath()

      .. oe:language:: python

         .. oe:api:: python

            OE2DPath() -> OE2DPath

      Default constructor.
      The starting point of the path have to be defined using the
      :oe:meth:`OEDepict::OE2DPath::AddStartPoint` method.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPath(const OE2DPoint& start, bool closed = true)

      .. oe:language:: python

         .. oe:api:: python

            OE2DPath(start: OE2DPoint, closed: bool = True) -> OE2DPath

      Create a new path with a starting point.

      *start*
        The **current point** that will be starting point of the first
        line or curve.

      *closed*
        If true, than a line segment will be added from the starting point to
        the end point of the last line or curve segment of the path.
        See examples in :ref:`Table: Examples of closed and open paths<table_OE2DPath_ClosedOpen>`.

      .. note::

         The starting point of the path will be associated with the
         :oe:const:`OEDepict::OE2DPathPointType::Start`
         type when returned by the :oe:meth:`OEDepict::OE2DPath::GetPoints` method.

      .. _table_OE2DPath_ClosedOpen:

      .. list-table:: **Examples of closed and open paths**
         :widths: 10 10
         :header-rows: 1

         * - closed paths
           - open paths
         * - .. image:: ../images/OE2DPath-closed.*
           - .. image:: ../images/OE2DPath-open.*

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPath(const OE2DPath& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DPath(rhs: OE2DPath) -> OE2DPath

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPath(const OE2DPath& rhs, double scale)

      .. oe:language:: python

         .. oe:api:: python

            OE2DPath(rhs: OE2DPath, scale: float) -> OE2DPath

      Copy constructor with scaling.

      *scale*
         The scaling factor is used to create a new image from the given one.
         The scaling factor has to be a positive (non-zero) number.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPath(const OE2DPath& rhs, const OE2DPoint& offset)

      .. oe:language:: python

         .. oe:api:: python

            OE2DPath(rhs: OE2DPath, offset: OE2DPoint) -> OE2DPath

      Copy constructor with offset.

      *offset*
        The offset of new path relative to the copied one.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPath(const OE2DPath& rhs, const OE2DPoint& center,
                     double degrees)

      .. oe:language:: python

         .. oe:api:: python

            OE2DPath(rhs: OE2DPath, center: OE2DPoint, degree: float) -> OE2DPath

      Copy constructor with rotation.

      *center*
        The center of the rotation.

      *degree*
        The rotation in degrees.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE2DPath &operator=(const OE2DPath &rhs)

      Assignment operator.

   .. oe:method:: AddCurveSegment

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddCurveSegment(const OE2DPoint& c1, const OE2DPoint& c2,
                                 const OE2DPoint& end)

      .. oe:language:: python

         .. oe:api:: python

            AddCurveSegment(c1: OE2DPoint, c2: OE2DPoint, end: OE2DPoint) -> None

      Adds a cubic |Bezier| curve to the path from the end point of the last line or curve
      segment of the path to the position **end** using **c1** and **c2** control points.

      *c1, c2*
        The control points of the curve.

      *end*
        The end point of the curve segment.

      .. _figure_OE2DPath_AddCurveSegment:

      .. figure:: depicttk/images/OE2DPoint_AddCurveSegment.*
         :align:  center
         :scale:  100

         **Example of adding a curve segment to a path**

      .. note::

         Points added to the path with the :oe:meth:`OEDepict::OE2DPath::AddCurveSegment`
         method will be associated with the following types when returned by the
         :oe:meth:`OEDepict::OE2DPath::GetPoints` method:

         * :oe:const:`OEDepict::OE2DPathPointType::CurveC1`
         * :oe:const:`OEDepict::OE2DPathPointType::CurveC2`
         * :oe:const:`OEDepict::OE2DPathPointType::CurveEnd`

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :oe:meth:`OEDepict::OEImageBase::DrawCubicBezier` method
         * :oe:meth:`OEDepict::OE2DPath::GetPoints` method

   .. oe:method:: AddLineSegment

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddLineSegment(const OE2DPoint& end)

      .. oe:language:: python

         .. oe:api:: python

            AddLineSegment(end: OE2DPoint) -> None

      Adds a line to the path from the end point of the last line or curve
      segment of the path to the position **end**.

      *end*
        The end point of the line segment.

      .. _figure_OE2DPath_AddLineSegment:

      .. figure:: depicttk/images/OE2DPoint_AddLineSegment.*
         :align:  center
         :scale:  100

         **Example of adding a line segment to a path**

      .. note::

         Points added to the path with the :oe:meth:`OEDepict::OE2DPath::AddLineSegment`
         method will be associated with the :oe:const:`OEDepict::OE2DPathPointType::LineEnd`
         type when returned by the :oe:meth:`OEDepict::OE2DPath::GetPoints` method.

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :oe:meth:`OEDepict::OEImageBase::DrawLine` method

   .. oe:method:: AddStartPoint

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddStartPoint(const OE2DPoint& start)

      .. oe:language:: python

         .. oe:api:: python

            AddStartPoint(start: OE2DPoint) -> None

      Adds the starting point of the path. If clears all previously added
      line or curve segments.

   .. oe:method:: GetEnd

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPoint GetEnd() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnd() -> OE2DPoint

      Returns the end position of the path.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DPath::GetStart` method

   .. oe:method:: GetPoints

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OE2DPathPoint>* GetPoints() const

      .. oe:language:: python

         .. oe:api:: python

            GetPoints() -> Iterable[OE2DPathPoint]

      Returns an iterator over all points of the path.
      Each point is associated with a type from the
      :oe:constns:`OEDepict::OE2DPathPointType` namespace.

      **Example:**

      .. oe:source:: DrawObjects.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GET-PATH-POINTS

      .. oe:source:: DrawObjects.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GET-PATH-POINTS

      .. oe:source:: DrawObjects.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GET-PATH-POINTS

      .. oe:source:: DrawObjects.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GET-PATH-POINTS

      .. seealso::

         * :ref:`OE2DPathPoint <OEDepict_OE2DPathPoint>` class
         * :oe:constns:`OEDepict::OE2DPathPointType` namespace

   .. oe:method:: GetStart

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPoint GetStart() const

      .. oe:language:: python

         .. oe:api:: python

            GetStart() -> OE2DPoint

      Returns the starting position of the path.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DPath::GetEnd` method

   .. oe:method:: IsClosed

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsClosed() const

      .. oe:language:: python

         .. oe:api:: python

            IsClosed() -> bool

      Returns whether a line segment will be added from the starting point to
      the end point of the last line or curve segment of the path.
      See examples in :ref:`Table: Examples of closed and open paths<table_OE2DPath_ClosedOpen>`.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DPath::SetClosed` method

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OE2DPath <OEDepict_OE2DPath>` object is valid.
      A path is considered valid if it has a starting point.

   .. oe:method:: SetClosed

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetClosed(bool closed)

      .. oe:language:: python

         .. oe:api:: python

            SetClosed(closed: bool) -> None

      Sets whether a line segment will be added from the starting point to
      the end point of the last line or curve segment of the path.


.. oe:namespace:: OEDepict


.. |Bezier|    replace:: Bézier



.. meta::
   :keywords: OE2DPathPoint

.. _OEDepict_OE2DPathPoint:

.. oe:class:: OE2DPathPoint

   .. oe:api::

      class OE2DPathPoint

   Represent a 2D point of a path with associated type from the 
   :oe:constns:`OEDepict::OE2DPathPointType` namespace.

   .. list-table::
      :widths: 100 100

      * - .. image:: ../images/OE2DPoint_AddCurveSegment.*
        - .. image:: ../images/OE2DPoint_AddLineSegment.*

   .. seealso::
  
      * :oe:meth:`OEDepict::OE2DPath::GetPoints` method

   .. ################################################################
      # Constructors
      ################################################################
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPathPoint(const OE2DPoint& point, unsigned int ptype)

      .. oe:language:: python

         .. oe:api:: python

            OE2DPathPoint(point: OE2DPoint, ptype: int) -> OE2DPathPoint

      Constructs an :ref:`OE2DPathPoint <OEDepict_OE2DPathPoint>` object with a
      given type from the  :oe:constns:`OEDepict::OE2DPathPointType`
      namespace.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPathPoint(const OE2DPathPoint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DPathPoint(arg2: OE2DPathPoint) -> OE2DPathPoint

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE2DPathPoint &operator=(const OE2DPathPoint &rhs)

      Assignment operator.

   .. oe:method:: GetPoint

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OE2DPoint& GetPoint() const

      .. oe:language:: python

         .. oe:api:: python

            GetPoint() -> OE2DPoint

      Returns the 2D coordinates of the point.

   .. oe:method:: GetPointType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetPointType() const

      .. oe:language:: python

         .. oe:api:: python

            GetPointType() -> int

      Returns the type of the point from the 
      :oe:constns:`OEDepict::OE2DPathPointType` namespace.


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OE2DPoint, 2DPoint

.. _OEDepict_OE2DPoint:

.. oe:class:: OE2DPoint

   .. oe:api::

      class OE2DPoint

   This class represents :ref:`OE2DPoint <OEDepict_OE2DPoint>` that stores
   an x (horizontal), y (vertical) coordinate pair.

   The coordinate system used in **OEDepict TK** has the origin (x=0.0,
   y=0.0) at the top/left with the x-axis pointing to the right and
   the y-axis pointing down.
   See :ref:`Figure: 2D coordinate system<figure_OE2DPoint_CoordinateXY>`.

   .. _figure_OE2DPoint_CoordinateXY:

   .. figure:: depicttk/images/CoordinateXY.*
      :align:  center

      **2D coordinate system (X = horizontal, Y = vertical)**

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPoint()

      .. oe:language:: python

         .. oe:api:: python

            OE2DPoint() -> OE2DPoint

      Default constructor that initializes an :ref:`OE2DPoint <OEDepict_OE2DPoint>`
      object with x = 0.0, y = 0.0 coordinates.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPoint(double x, double y)

      .. oe:language:: python

         .. oe:api:: python

            OE2DPoint(x: float, y: float) -> OE2DPoint

      Constructor that initializes an :ref:`OE2DPoint <OEDepict_OE2DPoint>` object
      with the give x, y coordinates. 

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPoint(const OE2DPoint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DPoint(arg2: OE2DPoint) -> OE2DPoint

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE2DPoint &operator=(const OE2DPoint &rhs)

      Assignment operator.

   .. oe:method:: operator+
      :language: c++

      .. oe:api::

         OE2DPoint operator+(const OE2DPoint &rhs) const

      Addition operator: :math:`(a_x, a_y) + (b_x, b_y) = (a_x + b_x, a_y + b_y)`

   .. oe:method:: operator-
      :language: c++

      .. oe:api::

         OE2DPoint operator-(const OE2DPoint &rhs) const

      Subtraction operator: :math:`(a_x, a_y) - (b_x, b_y) = (a_x - b_x, a_y - b_y)`

   .. oe:method:: operator/
      :language: c++

      .. oe:api::

         OE2DPoint operator/(double) const

      Division operator: :math:`(a_x, a_y) / D = (a_x / D, a_y / D)`

   .. oe:method:: operator *
      :language: c++

      .. oe:api::

         OE2DPoint operator *(double) const

      Multiplication operator: :math:`(a_x, a_y) * D = (a_x * D, a_y * D)`

   .. oe:method:: operator+=
      :language: c++ java csharp

      .. oe:api::

         OE2DPoint &operator+=(const OE2DPoint &p)

      Addition assignment operator.

   .. oe:method:: operator-=
      :language: c++

      .. oe:api::

         OE2DPoint &operator-=(const OE2DPoint &p)

      Subtraction assignment operator.

   .. oe:method:: operator/=
      :language: c++

      .. oe:api::

         OE2DPoint &operator/=(double)

      Division assignment operator.

   .. oe:method:: operator*=
      :language: c++

      .. oe:api::

         OE2DPoint &operator *=(double)

      Multiplication assignment operator.

   .. ################################################################
      # GetX
      ################################################################

   .. oe:method:: GetX

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetX() const

      .. oe:language:: python

         .. oe:api:: python

            GetX() -> float

      Returns the x (horizontal) coordinate of the :ref:`OE2DPoint <OEDepict_OE2DPoint>`
      object.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DPoint::SetY` method

   .. oe:method:: GetY

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetY() const

      .. oe:language:: python

         .. oe:api:: python

            GetY() -> float

      Returns the y (vertical) coordinate of the :ref:`OE2DPoint <OEDepict_OE2DPoint>`
      object.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DPoint::SetY` method

   .. ################################################################
      # SetX
      ################################################################

   .. oe:method:: SetX

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetX(double x)

      .. oe:language:: python

         .. oe:api:: python

            SetX(x: float) -> None

      Sets the x (horizontal) coordinate of the :ref:`OE2DPoint <OEDepict_OE2DPoint>`
      object.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DPoint::GetX` method

   .. ################################################################
      # SetY
      ################################################################

   .. oe:method:: SetY

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetY(double y)

      .. oe:language:: python

         .. oe:api:: python

            SetY(y: float) -> None

      Sets the y (vertical) coordinate of the :ref:`OE2DPoint <OEDepict_OE2DPoint>`
      object.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DPoint::GetY` method



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEAlignmentOptions, AlignmentOptions

.. _OEDepict_OEAlignmentOptions:

.. oe:class:: OEAlignmentOptions

   .. oe:api::

      class OEAlignmentOptions

   This class represents :ref:`OEAlignmentOptions <OEDepict_OEAlignmentOptions>` and
   stores the following parameters which are used when performing molecule
   alignment.

   .. list-table::
      :widths: 150 100 100
      :header-rows: 1

      * - Property
        - Get method
        - Set method

      * - re-generating 2D coordinates
        - :oe:meth:`GetClearCoords<OEDepict::OEAlignmentOptions::GetClearCoords>`
        - :oe:meth:`SetClearCoords<OEDepict::OEAlignmentOptions::SetClearCoords>`

      * - adding depiction hydrogens
        - :oe:meth:`GetAddDepictionHydrogens<OEDepict::OEAlignmentOptions::GetAddDepictionHydrogens>`
        - :oe:meth:`SetAddDepictionHydrogens<OEDepict::OEAlignmentOptions::SetAddDepictionHydrogens>`

      * - starting from the 2D coords of the reference molecule
        - :oe:meth:`GetFixedCoords<OEDepict::OEAlignmentOptions::GetFixedCoords>`
        - :oe:meth:`SetFixedCoords<OEDepict::OEAlignmentOptions::SetFixedCoords>`

      * - max number of allowed atom pair clushes
        - :oe:meth:`GetMaxAllowedAtomPairClashes<OEDepict::OEAlignmentOptions::GetMaxAllowedAtomPairClashes>`
        - :oe:meth:`SetMaxAllowedAtomPairClashes<OEDepict::OEAlignmentOptions::SetMaxAllowedAtomPairClashes>`

      * - max number of bond rotations
        - :oe:meth:`GetMaxBondRotations<OEDepict::OEAlignmentOptions::GetMaxBondRotations>`
        - :oe:meth:`SetMaxBondRotations<OEDepict::OEAlignmentOptions::SetMaxBondRotations>`

      * - max number of pattern matches
        - :oe:meth:`GetMaxPatternMatches<OEDepict::OEAlignmentOptions::GetMaxPatternMatches>`
        - :oe:meth:`SetMaxPatternMatches<OEDepict::OEAlignmentOptions::SetMaxPatternMatches>`

      * - RMSD cutoff
        - :oe:meth:`GetRMSDCutoff<OEDepict::OEAlignmentOptions::GetRMSDCutoff>`
        - :oe:meth:`SetRMSDCutoff<OEDepict::OEAlignmentOptions::SetRMSDCutoff>`

      * - rotation around bonds
        - :oe:meth:`GetRotateAroundBonds<OEDepict::OEAlignmentOptions::GetRotateAroundBonds>`
        - :oe:meth:`SetRotateAroundBonds<OEDepict::OEAlignmentOptions::SetRotateAroundBonds>`

      * - suppressing hydrogens
        - :oe:meth:`GetSuppressHydrogens<OEDepict::OEAlignmentOptions::GetSuppressHydrogens>`
        - :oe:meth:`SetSuppressHydrogens<OEDepict::OEAlignmentOptions::SetSuppressHydrogens>`

   .. seealso::

      * :oe:func:`OEDepict::OEPrepareAlignedDepiction` function

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAlignmentOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEAlignmentOptions() -> OEAlignmentOptions

      Default constructor that initializes an :ref:`OEAlignmentOptions <OEDepict_OEAlignmentOptions>`
      object with the following properties:

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - Property
           - Default value

         * - re-generating 2D coordinates
           - true

         * - adding depiction hydrogens
           - true

         * - starting from the 2D coordinates of the reference molecule
           - false

         * - max number of allowed atom pair clushes
           - `0` (means an alignment is rejected if there is any atom clash)

         * - max number of bond rotations
           - :math:`2^{16} = 65536` (max allowed number is :math:`2^{31}`)

         * - max number of pattern matches
           - `0` (means no limit)

         * - RMSD cutoff
           - `0.1`

         * - rotation around bonds
           - true

         * - suppressing hydrogens
           - true

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAlignmentOptions(bool rotatebonds, bool clearcoords,
                               bool suppressH)

      .. oe:language:: python

         .. oe:api:: python

            OEAlignmentOptions(rotateBonds: bool, clearcoords: bool,
                               suppressH: bool) -> OEAlignmentOptions

      Creates an :ref:`OEAlignmentOptions <OEDepict_OEAlignmentOptions>` object with
      the specified parameters.

      *rotatebonds*
         See the :oe:meth:`OEDepict::OEAlignmentOptions::SetRotateAroundBonds` method.

      *clearcoords*
         See the :oe:meth:`OEDepict::OEAlignmentOptions::SetClearCoords` method.

      *suppressH*
         See the :oe:meth:`OEDepict::OEAlignmentOptions::SetSuppressHydrogens` method.

      By default, the RMSD cutoff is `0.1` (see the :oe:meth:`OEDepict::OEAlignmentOptions::SetRMSDCutoff` method)
      and maximum number of bond rotations is
      :math:`2^{16} = 65536` (see the :oe:meth:`OEDepict::OEAlignmentOptions::SetMaxBondRotations` method).

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAlignmentOptions(const OEAlignmentOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEAlignmentOptions(arg2: OEAlignmentOptions) -> OEAlignmentOptions

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAlignmentOptions &operator=(const OEAlignmentOptions &rhs)

      Assignment operator.

   .. oe:method:: GetAddDepictionHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAddDepictionHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddDepictionHydrogens() -> bool

      Returns whether the depiction hydrogens are kept/added during the molecule
      alignment.

   .. seealso::

      * :oe:meth:`OEDepict::OEAlignmentOptions::SetAddDepictionHydrogens` method

   .. oe:method:: GetClearCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetClearCoords() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearCoords() -> bool

      Returns whether the 2D coordinates of the *fit* molecule will be
      re-calculated prior to the alignment process.

      .. seealso::

         * :oe:func:`OEDepict::OEDepictCoordinates` function
         * :oe:meth:`OEDepict::OEAlignmentOptions::SetClearCoords` method

   .. oe:method:: GetFixedCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFixedCoords() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixedCoords() -> bool

      Returns whether the :oe:func:`OEDepict::OEPrepareAlignedDepiction`
      function can start the alignment process by copying over the
      coordinates of the *reference* molecule to the *fit* molecule.

      .. seealso::

         * :oe:meth:`OEDepict::OEAlignmentOptions::SetFixedCoords` method

   .. oe:method:: GetMaxAllowedAtomPairClashes

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxAllowedAtomPairClashes() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxAllowedAtomPairClashes() -> int

      Returns the maximum number of atom pair clashes allowed in fix
      coordinate mode.

       .. seealso::

         * :oe:meth:`OEDepict::OEAlignmentOptions::SetMaxAllowedAtomPairClashes` method

   .. oe:method:: GetMaxBondRotations

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxBondRotations() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxBondRotations() -> int

      Returns the maximum number of bond rotations performed during
      the alignment process.

      The default value for maximum number of bond rotations is
      :math:`2^{16} = 65536`. This means that by default only the first
      16 single bonds of the *fit* molecule will be rotated to maximize
      molecule alignment. The max allowed number is :math:`2^{31}` that
      allows the rotate `31` bonds independently to find the best
      alignment.

      .. seealso::

         * :oe:meth:`OEDepict::OEAlignmentOptions::SetMaxBondRotations` method

   .. oe:method:: GetMaxPatternMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxPatternMatches() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxPatternMatches() -> int

      Returns the maximum number of matches utilized to performed
      molecule alignments.

      .. seealso::

         * :oe:meth:`OEDepict::OEAlignmentOptions::SetMaxPatternMatches` method

   .. oe:method:: GetRMSDCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRMSDCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetRMSDCutoff() -> float

      Returns the RMSD cutoff value used to identify acceptable
      alignments.

      .. seealso::

         * :oe:meth:`OEDepict::OEAlignmentOptions::SetRMSDCutoff` method

   .. oe:method:: GetRotateAroundBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRotateAroundBonds() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotateAroundBonds() -> bool

      Returns whether rotation around the bonds of the *fit* molecule
      is allowed.

      .. seealso::

         * :oe:meth:`OEDepict::OEAlignmentOptions::SetRotateAroundBonds` method

   .. oe:method:: GetSuppressHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSuppressHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuppressHydrogens() -> bool

      Returns whether the explicit hydrogens are suppressed in the *fit*
      molecule prior to the alignment process.

      .. seealso::

         * :oe:meth:`OEDepict::OEAlignmentOptions::SetSuppressHydrogens` method

   .. oe:method:: SetAddDepictionHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAddDepictionHydrogens(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAddDepictionHydrogens(a: bool) -> None

      Sets whether depiction hydrogens are kept/added during alignment.

      .. seealso::

         * :oe:func:`OEDepict::OEAddDepictionHydrogens` function
         * :oe:meth:`OEDepict::OEPrepareDepictionOptions::GetAddDepictionHydrogens` method

   .. oe:method:: SetClearCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetClearCoords(bool clearcoords)

      .. oe:language:: python

         .. oe:api:: python

            SetClearCoords(c: bool) -> None

      Sets whether the 2D coordinates of the *fit* molecule will be
      re-calculated prior to the alignment process by calling the
      :oe:func:`OEDepict::OEPrepareDepiction` function.

      .. seealso::

         * :oe:func:`OEDepict::OEDepictCoordinates` function
         * :oe:meth:`OEDepict::OEAlignmentOptions::GetClearCoords` method

   .. oe:method::  SetFixedCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFixedCoords(bool fixed)

      .. oe:language:: python

         .. oe:api:: python

            SetFixedCoords(f: bool) -> None

      Sets whether the :oe:func:`OEDepict::OEPrepareAlignedDepiction`
      function can start the alignment process by copying over the
      coordinates of the *reference* molecule to the *fit* molecule based
      on the provided match.

      If the alignment process based of 'fixed' coordinates can not be
      performed or it is unsuccessful *i.e.* no alignment is found
      without atom clashes
      than the :oe:func:`OEDepict::OEPrepareAlignedDepiction` function
      falls back to maximizing the overlap between the *fit* and the
      *reference* 2D molecules by rotating around single bonds.
      See also :oe:meth:`OEDepict::OEAlignmentOptions::SetMaxAllowedAtomPairClashes`
      method that can be used to allow some atom clashes.

      The alignment process based on 'fixed' coordinates currently
      can only be performed if:

      * neither the *reference* nor the *fit* molecule have more
        than one component
      * there is no partial ring match *i.e.* if a ring atom of
        the *fit* molecule is matched for alignment than all of the atom
        of the same ring systems have to be matched for alignment

      .. seealso::

         * :oe:meth:`OEDepict::OEAlignmentOptions::GetFixedCoords` method

   .. oe:method:: SetMaxAllowedAtomPairClashes

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxAllowedAtomPairClashes(unsigned int maxclashes)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxAllowedAtomPairClashes(m: int) -> None

      Sets the number of atom pair clashes allowed after the 'fixed'
      coordinates alignment process
      (see :oe:meth:`OEDepict::OEAlignmentOptions::SetFixedCoords` method).
      The default value is ``0``, i.e. no atom clashes are allowed.
      If the number of clashes exceeds this
      limit the alignment is rejected and process falls back to
      maximizing the overlap between the *fit* and the
      *reference* 2D molecules by rotating around single bonds.

      .. seealso::

         * :oe:meth:`OEDepict::OEAlignmentOptions::SetMaxAllowedAtomPairClashes` method

   .. oe:method:: SetMaxBondRotations

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxBondRotations(unsigned int maxrotations)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxBondRotations(m: int) -> None

      Sets the maximum number of bond rotations performed during
      the alignment process.

      *maxrotations*
        The zero value means that there is no limit.
        Upon reaching this limit, the alignment process terminates
        and returns the best alignment identified up to that point.

      .. hint::

         The default value for maximum number of bond rotations is
         :math:`2^{16} = 65536`. This means that by default only the first
         16 single bonds of the *fit* molecule will be rotated to maximize
         molecule alignment.

         It is recommended to use this parameter in the following cases:

         * if the *fit* molecule being aligned has a large number of rotatable
           bonds

         * if the match that determines the atoms of the *fit* molecule
           that will be aligned to the atoms of the *reference* molecule
           has a large number of rotatable bonds

      .. seealso::

         * :oe:meth:`OEDepict::OEAlignmentOptions::GetMaxBondRotations` method

   .. oe:method:: SetMaxPatternMatches

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxPatternMatches(unsigned int maxmatches)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxPatternMatches(m: int) -> None

      Sets the maximum number of matches utilized to perform molecule
      alignments.

      *maxmatches*
         The zero value means that there is no limit.
         If the molecule alignment is based on more than one matches,
         then upon reaching this limit, the alignment process terminates
         and returns the best alignment identified up to that point.

      .. hint::

         It is recommended to use this parameter in the following cases:

         * if the alignment is based on substructure or maximum common
           substructure matches and the *reference* or/and *fit* molecules
           are highly symmetrical *i.e.* a large number of matches
           returned by the substructure or maximum common substructure
           search algorithms, respectively.

      .. seealso::

         * :oe:meth:`OEDepict::OEAlignmentOptions::GetMaxPatternMatches` method

   .. oe:method:: SetRMSDCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRMSDCutoff(double rmsdcutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetRMSDCutoff(r: float) -> None

      Sets the RMSD cutoff value used to identify acceptable
      alignments.

      *rmsdcutoff*
        This number has to be non-negative number.
        The alignment procedure terminates when the *rmsdcutoff* between
        the *fit* and the *reference* molecule is below this limit and there is no
        internal clash detected between the atoms of the *fit* molecule.

      .. seealso::

        * :oe:meth:`OEDepict::OEAlignmentOptions::GetRMSDCutoff` method

   .. oe:method:: SetRotateAroundBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRotateAroundBonds(bool rotatebonds)

      .. oe:language:: python

         .. oe:api:: python

            SetRotateAroundBonds(r: bool) -> None

      Sets whether rotation around the bonds of the *fit* molecule
      is allowed.

      *rotatebonds*
         If 'true', then bond of the *fit* molecule will be rotated to
         find the best alignment between molecules.
         If 'false', then only 2D rotation and translation of the *fit*
         molecule is allowed (*i.e.* no rotations around bonds) in order
         to align it to the *reference* molecule

      .. seealso::

        * :oe:meth:`OEDepict::OEAlignmentOptions::GetRotateAroundBonds` method

   .. oe:method:: SetSuppressHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSuppressHydrogens(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetSuppressHydrogens(s: bool) -> None

      Sets whether the explicit hydrogens are suppressed in the *fit*
      molecule prior to the alignment process.
      Only hydrogens that are necessary to faithfully represent
      tetrahedral stereochemistry will be kept.

      .. seealso::

         * :oe:func:`OEDepict::OEAddDepictionHydrogens` function
         * :oe:func:`OEDepict::OEHasDepictionHydrogens` function
         * :oe:meth:`OEDepict::OEAlignmentOptions::GetSuppressHydrogens` method


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEAlignmentResult, AlignmentResult

.. _OEDepict_OEAlignmentResult:

.. oe:class:: OEAlignmentResult

   .. oe:api::

      class OEAlignmentResult : public OEChem::OEMatchBase

   The :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>` class is a concrete instance of the
   :ref:`OEMatchBase <OEChem_OEMatchBase>` abstract base class.
   An :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>` object represents a pairwise correspondence between
   atoms and/or bonds in two different molecules being aligned by the
   :oe:func:`OEDepict::OEPrepareAlignedDepiction` function.

   The following methods are publicly inherited from :ref:`OEMatchBase <OEChem_OEMatchBase>`:

   =============================================================== ================================================================ ===============================================================
   :oe:meth:`operator bool<OEChem::OEMatchBase::operator bool>`    :oe:meth:`GetBonds<OEChem::OEMatchBase::GetBonds>`               :oe:meth:`GetTargetBonds<OEChem::OEMatchBase::GetTargetBonds>` 
   :oe:meth:`Clear<OEChem::OEMatchBase::Clear>`                    :oe:meth:`GetPatternAtoms<OEChem::OEMatchBase::GetPatternAtoms>` :oe:meth:`IsValid<OEChem::OEMatchBase::IsValid>`               
   :oe:meth:`CreateCopy<OEChem::OEMatchBase::CreateCopy>`          :oe:meth:`GetPatternBonds<OEChem::OEMatchBase::GetPatternBonds>` :oe:meth:`NumAtoms<OEChem::OEMatchBase::NumAtoms>`             
   :oe:meth:`GetAtoms<OEChem::OEMatchBase::GetAtoms>`              :oe:meth:`GetTargetAtoms<OEChem::OEMatchBase::GetTargetAtoms>`   :oe:meth:`NumBonds<OEChem::OEMatchBase::NumBonds>`             
   =============================================================== ================================================================ ===============================================================

   .. seealso::

      * :ref:`OEMatchBase <OEChem_OEMatchBase>` class in the **OEChem TK** manual
      * :oe:func:`OEDepict::OEPrepareAlignedDepiction` function
      * :ref:`chapter_molalign` chapter

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAlignmentResult()

      .. oe:language:: python

         .. oe:api:: python

            OEAlignmentResult() -> OEAlignmentResult

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAlignmentResult(const OEChem::OEMatchBase& match)

      .. oe:language:: python

         .. oe:api:: python

            OEAlignmentResult() -> OEAlignmentResult
            OEAlignmentResult(rhs: OEMatchBase) -> OEAlignmentResult
            OEAlignmentResult(rhs: OEAlignmentResult) -> OEAlignmentResult

      Constructors an :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>` object from a match.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAlignmentResult(const OEAlignmentResult& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEAlignmentResult(rhs: OEMatchBase) -> OEAlignmentResult
            OEAlignmentResult(rhs: OEAlignmentResult) -> OEAlignmentResult

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAlignmentResult &operator=(const OEAlignmentResult &rhs)

      Assignment operator.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Removes all atom and bond of pairs from the
      :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>` object.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatchBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMatchBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned object derived from :ref:`OEMatchBase <OEChem_OEMatchBase>`
      is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. oe:method:: GetAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEMatchPair<OEChem::OEAtomBase> >* GetAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> Iterable[OEMatchPair[OEAtomBase]]

      Returns an iterator over :ref:`OEMatchPair <OEChem_OEMatchPair>` which contain the
      atom to atom correspondences in the :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>` object.

      .. seealso::

         :ref:`OEMatchPair <OEChem_OEMatchPair>` class in the **OEChem TK** manual

   .. oe:method:: GetBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEMatchPair<OEChem::OEBondBase> >* GetBonds() const

      .. oe:language:: python

         .. oe:api:: python

            GetBonds() -> Iterable[OEMatchPair[OEBondBase]]

      Returns an iterator over :ref:`OEMatchPair <OEChem_OEMatchPair>` which contain the
      bond to bond correspondences in the :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>` object.

      .. seealso::

         :ref:`OEMatchPair <OEChem_OEMatchPair>` class in the **OEChem TK** manual

   .. oe:method:: GetRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetRMSD() -> float

      Returns the RMSD of the alignment based on the correspondence
      stored in the :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>` object.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns true if there at least one atom to atom or bond to bonds
      correspondence is stored in the :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>`
      object *i.e.* whether the alignment performed by the
      :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>` function was successful.

   .. oe:method:: NumAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            NumAtoms() -> int

      Returns the number of atom equivalences in the :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>`
      object.

   .. oe:method:: NumBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumBonds() const

      .. oe:language:: python

         .. oe:api:: python

            NumBonds() -> int

      Returns the number of bond equivalences in the :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>`
      object.


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEAtomDisplayBase, AtomDisplayBase

.. _OEDepict_OEAtomDisplayBase:

.. oe:class:: OEAtomDisplayBase

   .. oe:api::

      class OEAtomDisplayBase : public OESystem::OEBase

   The :ref:`OEAtomDisplayBase <OEDepict_OEAtomDisplayBase>` class is the abstract
   interface for representing atom display information 
   within **OEDepict TK**.
   See :ref:`Figure: OEDepict TK atom display class hierarchy<figure_OEAtomDisplayBase_Hierarchy>`.

   .. _figure_OEAtomDisplayBase_Hierarchy:

   .. figure:: depicttk/images/OEAtomDisplayHierarchy.*
      :align:  center

      **OEDepict TK atom display class hierarchy**

   The following classes derive from this class:
    * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAtomDisplayBase & operator=(const OEAtomDisplayBase &)

      Assignment operator.

   .. ################################################################
      # GetDataType
      ################################################################

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

      This function is used to perform run-time type
      identification.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::GetDataType` method in the **OEChem TK** manual

   .. ################################################################
      # GetAtom
      ################################################################

   .. oe:method:: GetAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEAtomBase* GetAtom() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtom() -> OEAtomBase

      Returns the const pointer of the :ref:`OEAtomBase <OEChem_OEAtomBase>`
      object for which display properties are stored in the class derived
      from the :ref:`OEAtomDisplayBase <OEDepict_OEAtomDisplayBase>` abstract class.

   .. ################################################################
      # IsDataType
      ################################################################

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

      Returns whether type is the same as the instance this method is  
      called on.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::IsDataType` method in the **OEChem TK** manual

   .. ################################################################
      # IsVisible
      ################################################################

   .. oe:method:: IsVisible

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsVisible() const

      .. oe:language:: python

         .. oe:api:: python

            IsVisible() -> bool

      Returns whether or not the atom is depicted (*i.e.* visible).

   .. ################################################################
      # SetVisible
      ################################################################

   .. oe:method:: SetVisible

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetVisible(bool visible)

      .. oe:language:: python

         .. oe:api:: python

            SetVisible(visible: bool) -> None

      Sets the visibility of an atom.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEAtomSVGAtomIdxMarkup:

.. oe:class:: OEAtomSVGAtomIdxMarkup

   .. oe:api::

      class OEAtomSVGAtomIdxMarkup : public OEAtomSVGMarkupBase

   This class represents the :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>` atom
   SVG markup functor.  If this functor is passed to the
   :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor`
   method, the atoms will be not marked in the :file:`svg` image when
   calling the :ref:`OERenderMolecule <OEDepict_OERenderMolecule>` function.

   .. seealso::

      * :ref:`chapter_svg` chapter
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor` method
      * :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>` class
      * :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>` class

   The following methods are publicly inherited from
   :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>`:

   ==================================================================== ==================================================================== ====================================================================
   :oe:meth:`CreateCopy<OEDepict::OEAtomSVGMarkupBase::CreateCopy>`     :oe:meth:`GetClassName<OEDepict::OEAtomSVGMarkupBase::GetClassName>` :oe:meth:`GetGroupId<OEDepict::OEAtomSVGMarkupBase::GetGroupId>`
   ==================================================================== ==================================================================== ====================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomSVGAtomIdxMarkup(const std::string prefix = "",
                                   const std::string classname = "atom")

      .. oe:language:: python

         .. oe:api:: python

            OEAtomSVGAtomIdxMarkup(prefix: str = "", classname: str = "atom") -> OEAtomSVGAtomIdxMarkup

      Creates an :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>` object.

      prefix
         The string that will be added at the beginning of each atom
         :oe:cls:`group id <OEDepict::OESVGGroup>`.
         For information about valid ids see
         :oe:func:`OEDepict::OEIsValidSVGGroupId` function.
         By default, no prefix will be added.

      classname
         The :oe:cls:`class name <OEDepict::OESVGClass>` that is going to
         be used to mark atoms.
         For information about valid names see
         :oe:func:`OEDepict::OEIsValidSVGClassName` function.

      By default, the svg image for the first atom of a molecule will be
      marked as follows:

      ::

          <g id='idx=0' class='atom'>
          ..
          list of drawing elements
          ..
          <circle ... >
          </g>

      The transparent circle will be drawn with the atom position
      :oe:meth:`OEDepict::OE2DAtomDisplay::GetCoords` center.
      This can be used to manipulate the generated :file:`.svg` image
      and associate event with the SVG groups.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomSVGMarkupBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomSVGMarkupBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetClassName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetClassName(const OEChem::OEAtomBase &) const

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg2: OEAtomBase) -> str

      Returns the string that specifies the
      :oe:cls:`group id <OEDepict::OESVGGroup>`
      of an atom in an :file:`svg` image.

   .. oe:method:: GetGroupId

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetGroupId(const OEChem::OEAtomBase &) const

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(atom: OEAtomBase) -> str

      Returns the string that specifies the
      :oe:cls:`class name <OEDepict::OESVGClass>`
      of an atom in an :file:`svg` image.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEAtomSVGMarkupBase:

.. oe:class:: OEAtomSVGMarkupBase

   .. oe:api::

      class OEAtomSVGMarkupBase

   :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>` is an abstract base class.
   Concrete classes derived from the base class define the markup of
   the atoms in :file:`.svg` images that are generated
   when calling the :ref:`OERenderMolecule <OEDepict_OERenderMolecule>` function.
   Drawing elements representing atoms in the :file:`.svg` images are grouped together
   in the following format in which the ``<group id>`` and ``<class name>``
   strings can be defined in the derived concrete classes.

   ::

      <g id='<group id>' class='<class name>'>
      ..
      list of drawing elements
      ..
      </g>

   The following classes derive from this class:

    * :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>`
    * :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>`
    * :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>`

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor` method
      * :ref:`chapter_svg` chapter

   .. note::

      User defined SVG atom marking can be implemented by deriving from this class
      and implementing all the methods listed below.

   .. oe:source:: UserAtomMarkup.py
      :language: python
      :noindent:
      :frag:     SNIPPET-USER-DEF-ATOM-MARKUP
      :caption:  Example of using user defined SVG atom markings

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomSVGMarkupBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomSVGMarkupBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetClassName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetClassName(const OEChem::OEAtomBase &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg0: OEAtomBase) -> str

      Returns the ``<class name>`` associated with a specific atom group
      in the :file:`.svg` image.
      This is a virtual method that has to be implemented in the concrete
      derived classes.
      The return string will be verified by the
      :oe:func:`OEDepict::OEIsValidSVGClassName` function.
      Invalid SVG class names will be ignored.

      .. seealso::

         * :oe:func:`OEDepict::OEIsValidSVGClassName` function

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetGroupId

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetGroupId(const OEChem::OEAtomBase &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(arg0: OEAtomBase) -> str

      Returns the ``<group id>`` associated with a specific atom group
      in the :file:`.svg` image.
      This is a virtual method that has to be implemented in the concrete
      derived classes.
      The return string will be verified by the
      :oe:func:`OEDepict::OEIsValidSVGGroupId` function.
      Invalid SVG group ids will be ignored.

      .. seealso::

         * :oe:func:`OEDepict::OEIsValidSVGGroupId` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEAtomSVGNoMarkup:

.. oe:class:: OEAtomSVGNoMarkup

   .. oe:api::

      class OEAtomSVGNoMarkup : public OEAtomSVGMarkupBase

   This class represents the :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>` atom
   SVG markup functor.
   If this functor is passed to the
   :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor`
   method, the atoms will be not marked in the :file:`svg` image when
   calling the :ref:`OERenderMolecule <OEDepict_OERenderMolecule>` function.

   .. seealso::

      * :ref:`chapter_svg` chapter
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor` method
      * :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>` class
      * :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>` class

   The following methods are publicly inherited from :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>`:
 
   ==================================================================== ==================================================================== ==================================================================== 
   :oe:meth:`CreateCopy<OEDepict::OEAtomSVGMarkupBase::CreateCopy>`     :oe:meth:`GetClassName<OEDepict::OEAtomSVGMarkupBase::GetClassName>` :oe:meth:`GetGroupId<OEDepict::OEAtomSVGMarkupBase::GetGroupId>`
   ==================================================================== ==================================================================== ==================================================================== 
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomSVGNoMarkup()

      .. oe:language:: python

         .. oe:api:: python

            OEAtomSVGNoMarkup() -> OEAtomSVGNoMarkup

      Default constructor.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomSVGMarkupBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomSVGMarkupBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetClassName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetClassName(const OEChem::OEAtomBase &) const

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg2: OEAtomBase) -> str

      Returns an empty string.

   .. oe:method:: GetGroupId

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetGroupId(const OEChem::OEAtomBase &) const

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(arg2: OEAtomBase) -> str

      Returns an empty string.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEAtomSVGResidueMarkup:

.. oe:class:: OEAtomSVGResidueMarkup

   .. oe:api::

      class OEAtomSVGResidueMarkup : public OEAtomSVGMarkupBase

   This class represents the :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>` atom
   SVG markup functor.  If this functor is passed to the
   :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor`
   method, the atoms will be not marked in the :file:`svg` image when
   calling the :ref:`OERenderMolecule <OEDepict_OERenderMolecule>` function.

   .. seealso::

      * :ref:`chapter_svg` chapter
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor` method
      * :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>` class
      * :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>` class

   The following methods are publicly inherited from :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>`:

   ==================================================================== ==================================================================== ====================================================================
   :oe:meth:`CreateCopy<OEDepict::OEAtomSVGMarkupBase::CreateCopy>`     :oe:meth:`GetClassName<OEDepict::OEAtomSVGMarkupBase::GetClassName>` :oe:meth:`GetGroupId<OEDepict::OEAtomSVGMarkupBase::GetGroupId>`
   ==================================================================== ==================================================================== ====================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomSVGResidueMarkup(const std::string prefix = "",
                                   const std::string classname = "ligand-atom",
                                   const char separator = '-')

      .. oe:language:: python

         .. oe:api:: python

            OEAtomSVGResidueMarkup(prefix: str = "",
                                   classname: str = "ligand-atom",
                                   separator: str = '-') -> OEAtomSVGResidueMarkup

      Creates an :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>` object.

      prefix
         The string that will be added at the beginning of each atom
         :oe:cls:`group id <OEDepict::OESVGGroup>`.
         For information about valid ids see
         :oe:func:`OEDepict::OEIsValidSVGGroupId` function.
         By default, no prefix will be added.

      classname
         The :oe:cls:`class name <OEDepict::OESVGClass>` that is going to
         be used to mark atoms.  For information about valid names see
         :oe:func:`OEDepict::OEIsValidSVGClassName` function.

      separator
         The character used to separate the components
         (residue name, chain id, residue number, atom name)
         of the :oe:cls:`group id <OEDepict::OESVGGroup>`

      By default, the following will be showed in :file:`svg` image for
      marking of the first atom of  molecule ``NC(CCCNC(N)=N)C(O)=O``
      with residue information:

      By default, the :file:`svg` image for the first atom of molecule
      ``NC(CCCNC(N)=N)C(O)=O`` with residue information will be marked as
      follows:

      ::

          <g id='ARG-A-1-_N__' class='ligand-atom'>
          ..
          list of drawing elements
          ..
          <circle ... >
          </g>

      If there is no residue information attached to the atom the ``UNK``
      label will be used for the residue name. The residue information
      can be perceived by calling the :oe:func:`OEChem::OEPerceiveResidues`
      function.

      Since a valid :oe:cls:`group id <OEDepict::OESVGGroup>` can not have
      a space character, each space character of the atom name
      (returned by :oe:meth:`OEChem::OEAtomBase::GetName`) is replaces by
      an ``_`` (underline).

      The transparent circle will be drawn with the atom position
      :oe:meth:`OEDepict::OE2DAtomDisplay::GetCoords` center.
      This can be used to manipulate the generated :file:`.svg` image
      and associate event with the SVG groups.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomSVGMarkupBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomSVGMarkupBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetClassName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetClassName(const OEChem::OEAtomBase &) const

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg2: OEAtomBase) -> str

      Returns the string that specifies the
      :oe:cls:`group id <OEDepict::OESVGGroup>`
      of an atom in an :file:`svg` image.

   .. oe:method:: GetGroupId

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetGroupId(const OEChem::OEAtomBase &) const

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(atom: OEAtomBase) -> str

      Returns the string that specifies the
      :oe:cls:`class name <OEDepict::OESVGClass>`
      of an atom in an :file:`svg` image.


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEBondDisplayBase, BondDisplayBase

.. _OEDepict_OEBondDisplayBase:

.. oe:class:: OEBondDisplayBase

   .. oe:api::

      class OEBondDisplayBase : public OESystem::OEBase

   The :ref:`OEBondDisplayBase <OEDepict_OEBondDisplayBase>` class is the abstract
   interface for representing bond display information 
   within **OEDepict TK**.
   See :ref:`Figure: OEDepict TK bond display class hierarchy<figure_OEBondDisplayBase_Hierarchy>`.

   .. _figure_OEBondDisplayBase_Hierarchy:

   .. figure:: depicttk/images/OEBondDisplayHierarchy.*
      :align:  center

      **OEDepict TK bond display class hierarchy**

   The following classes derive from this class:
    * :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBondDisplayBase & operator=(const OEBondDisplayBase &)

      Assignment operator.

   .. ################################################################
      # GetDataType
      ################################################################

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

      This function is used to perform run-time type
      identification.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::GetDataType` method in the **OEChem TK** manual

   .. ################################################################
      # GetBond
      ################################################################

   .. oe:method:: GetBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEBondBase* GetBond() const

      .. oe:language:: python

         .. oe:api:: python

            GetBond() -> OEBondBase

      Returns the const pointer of the :ref:`OEBondBase <OEChem_OEBondBase>`
      object for which display properties are stored in the class derived
      from the :ref:`OEBondDisplayBase <OEDepict_OEBondDisplayBase>` abstract class.

   .. ################################################################
      # IsDataType
      ################################################################

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

      Returns whether type is the same as the instance this method is  
      called on.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::IsDataType` method in the **OEChem TK** manual

   .. ################################################################
      # IsVisible
      ################################################################

   .. oe:method:: IsVisible

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsVisible() const

      .. oe:language:: python

         .. oe:api:: python

            IsVisible() -> bool

      Returns whether or not the bond is depicted (*i.e.* visible).

   .. ################################################################
      # SetVisible
      ################################################################

   .. oe:method:: SetVisible

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetVisible(bool visible)

      .. oe:language:: python

         .. oe:api:: python

            SetVisible(visible: bool) -> None

      Sets the visibility of a bond.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEBondSVGBondIdxMarkup:

.. oe:class:: OEBondSVGBondIdxMarkup

   .. oe:api::

      class OEBondSVGBondIdxMarkup : public OEBondSVGMarkupBase

   This class represents the :ref:`OEBondSVGBondIdxMarkup <OEDepict_OEBondSVGBondIdxMarkup>` bond
   SVG markup functor.  If this functor is passed to the
   :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondSVGMarkupFunctor`
   method, the bonds will be not marked in the :file:`svg` image when
   calling the :ref:`OERenderMolecule <OEDepict_OERenderMolecule>` function.

   .. seealso::

      * :ref:`chapter_svg` chapter
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondSVGMarkupFunctor` method
      * :ref:`OEBondSVGNoMarkup <OEDepict_OEBondSVGNoMarkup>` class

   The following methods are publicly inherited from
   :ref:`OEBondSVGMarkupBase <OEDepict_OEBondSVGMarkupBase>`:

   ==================================================================== ==================================================================== ====================================================================
   :oe:meth:`CreateCopy<OEDepict::OEBondSVGMarkupBase::CreateCopy>`     :oe:meth:`GetClassName<OEDepict::OEBondSVGMarkupBase::GetClassName>` :oe:meth:`GetGroupId<OEDepict::OEBondSVGMarkupBase::GetGroupId>`
   ==================================================================== ==================================================================== ====================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondSVGBondIdxMarkup(const std::string prefix = "",
                                   const std::string classname = "bond")

      .. oe:language:: python

         .. oe:api:: python

            OEBondSVGBondIdxMarkup(prefix: str = "", classname: str = "bond") -> OEBondSVGBondIdxMarkup

      Creates an :ref:`OEBondSVGBondIdxMarkup <OEDepict_OEBondSVGBondIdxMarkup>` object.

      prefix
         The string that will be added at the beginning of each bond
         :oe:cls:`group id <OEDepict::OESVGGroup>`.
         For information about valid ids see
         :oe:func:`OEDepict::OEIsValidSVGGroupId` function.
         By default, no prefix will be added.

      classname
         The :oe:cls:`class name <OEDepict::OESVGClass>` that is going to
         be used to mark bonds.
         For information about valid names see
         :oe:func:`OEDepict::OEIsValidSVGClassName` function.

      By default, the svg image for the first bond of a molecule will be
      marked as follows:

      ::

          <g id='idx=0' class='bond'>
          ..
          list of drawing elements
          ..
          <circle ... >
          </g>

      The transparent circle will be drawn at the middle of the bond.
      This can be used to manipulate the generated :file:`.svg` image
      and associate event with the SVG groups.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondSVGMarkupBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondSVGMarkupBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBondSVGBondIdxMarkup <OEDepict_OEBondSVGBondIdxMarkup>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetClassName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetClassName(const OEChem::OEBondBase &) const

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg2: OEBondBase) -> str

      Returns the string that specifies the
      :oe:cls:`group id <OEDepict::OESVGGroup>`
      of an bond in an :file:`svg` image.

   .. oe:method:: GetGroupId

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetGroupId(const OEChem::OEBondBase &) const

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(bond: OEBondBase) -> str

      Returns the string that specifies the
      :oe:cls:`class name <OEDepict::OESVGClass>`
      of an bond in an :file:`svg` image.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEBondSVGMarkupBase:

.. oe:class:: OEBondSVGMarkupBase

   .. oe:api::

      class OEBondSVGMarkupBase

   :ref:`OEBondSVGMarkupBase <OEDepict_OEBondSVGMarkupBase>` is an abstract base class.
   Concrete classes derived from the base class define the markup of
   the bonds in :file:`.svg` images that are generated
   when calling the :ref:`OERenderMolecule <OEDepict_OERenderMolecule>` function.
   Drawing elements representing bonds in the :file:`.svg` images are grouped together
   in the following format in which the ``<group id>`` and ``<class name>``
   strings can be defined in the derived concrete classes.

   ::

      <g id='<group id>' class='<class name>'>
      ..
      list of drawing elements
      ..
      </g>

   The following classes derive from this class:

    * :ref:`OEBondSVGBondIdxMarkup <OEDepict_OEBondSVGBondIdxMarkup>`
    * :ref:`OEBondSVGNoMarkup <OEDepict_OEBondSVGNoMarkup>`

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondSVGMarkupFunctor` method
      * :ref:`chapter_svg` chapter

   .. note::

      User defined SVG atom marking can be implemented by deriving from this class
      and implementing all the methods listed below.

   .. oe:source:: UserBondMarkup.py
      :language: python
      :noindent:
      :frag:     SNIPPET-USER-DEF-BOND-MARKUP
      :caption:  Example of using user defined SVG atom markings

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondSVGMarkupBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondSVGMarkupBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetClassName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetClassName(const OEChem::OEBondBase &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg0: OEBondBase) -> str

      Returns the ``<class name>`` associated with a specific bond group
      in the :file:`.svg` image.
      This is a virtual method that has to be implemented in the concrete
      derived classes.
      The return string will be verified by the
      :oe:func:`OEDepict::OEIsValidSVGClassName` function.
      Invalid SVG class names will be ignored.

      .. seealso::

         * :oe:func:`OEDepict::OEIsValidSVGClassName` function

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetGroupId

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetGroupId(const OEChem::OEBondBase &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(arg0: OEBondBase) -> str

      Returns the ``<group id>`` associated with a specific bond group
      in the :file:`.svg` image.
      This is a virtual method that has to be implemented in the concrete
      derived classes.
      The return string will be verified by the
      :oe:func:`OEDepict::OEIsValidSVGGroupId` function.
      Invalid SVG group ids will be ignored.

      .. seealso::

         * :oe:func:`OEDepict::OEIsValidSVGGroupId` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEBondSVGNoMarkup:

.. oe:class:: OEBondSVGNoMarkup

   .. oe:api::

      class OEBondSVGNoMarkup : public OEBondSVGMarkupBase

   This class represents the :ref:`OEBondSVGNoMarkup <OEDepict_OEBondSVGNoMarkup>` bond
   SVG markup functor.
   If this functor is passed to the
   :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondSVGMarkupFunctor`
   method, the bonds will be not marked in the :file:`svg` image when
   calling the :ref:`OERenderMolecule <OEDepict_OERenderMolecule>` function.

   .. seealso::

      * :ref:`chapter_svg` chapter
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondSVGMarkupFunctor` method
      * :ref:`OEBondSVGBondIdxMarkup <OEDepict_OEBondSVGBondIdxMarkup>` class

   The following methods are publicly inherited from :ref:`OEBondSVGMarkupBase <OEDepict_OEBondSVGMarkupBase>`:

   ==================================================================== ==================================================================== ====================================================================
   :oe:meth:`CreateCopy<OEDepict::OEBondSVGMarkupBase::CreateCopy>`     :oe:meth:`GetClassName<OEDepict::OEBondSVGMarkupBase::GetClassName>` :oe:meth:`GetGroupId<OEDepict::OEBondSVGMarkupBase::GetGroupId>`
   ==================================================================== ==================================================================== ====================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondSVGNoMarkup()

      .. oe:language:: python

         .. oe:api:: python

            OEBondSVGNoMarkup() -> OEBondSVGNoMarkup

      Default constructor.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondSVGMarkupBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondSVGMarkupBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBondSVGNoMarkup <OEDepict_OEBondSVGNoMarkup>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetClassName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetClassName(const OEChem::OEBondBase &) const

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg2: OEBondBase) -> str

      Returns an empty string.

   .. oe:method:: GetGroupId

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetGroupId(const OEChem::OEBondBase &) const

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(arg2: OEBondBase) -> str

      Returns an empty string.


.. _OEDepictClasses:

*******************
OEDepict Classes
*******************

.. oe:namespace:: OEDepict

.. toctree::

   OE2DAtomDisplay
   OE2DBondDisplay
   OE2DMolDisplay
   OE2DMolDisplayOptions
   OE2DPath
   OE2DPathPoint
   OE2DPoint
   OEAlignmentOptions
   OEAlignmentResult
   OEAtomDisplayBase
   OEAtomSVGAtomIdxMarkup
   OEAtomSVGMarkupBase
   OEAtomSVGNoMarkup
   OEAtomSVGResidueMarkup
   OEBondDisplayBase
   OEBondSVGBondIdxMarkup
   OEBondSVGMarkupBase
   OEBondSVGNoMarkup
   OEDisplayAtomIdx
   OEDisplayAtomMapIdx
   OEDisplayAtomPropBase
   OEDisplayBondIdx
   OEDisplayBondPropBase
   OEDisplayNoAtomProp
   OEDisplayNoBondProp
   OEFont
   OEHighlightBase
   OEHighlightByBallAndStick
   OEHighlightByCogwheel
   OEHighlightByColor
   OEHighlightByLasso
   OEHighlightByStick
   OEHighlightLabel
   OEHighlightOverlayBase
   OEHighlightOverlayByBallAndStick
   OEImage
   OEImageBase
   OEImageFileBase
   OEImageFileCreatorBase
   OEImageFrame
   OEImageGrid
   OEImageTable
   OEImageTableOptions

.. oe:language:: java

    .. toctree::

       OEJavaImageBase

.. toctree::

   OELegendLayout
   OELegendLayoutOptions
   OEMolDisplayBase
   OEMultiPageImageFile
   OENearestAtom
   OENearestBond
   OEPen
   OEPrepareDepictionOptions
   OEReport
   OEReportOptions
   OESVGClass
   OESVGGroup


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDisplayAtomIdx, DisplayAtomIdx

.. _OEDepict_OEDisplayAtomIdx:

.. oe:class:: OEDisplayAtomIdx

   .. oe:api::

      class OEDisplayAtomIdx : public OEDisplayAtomPropBase

   This class represents :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>` atom property label
   functor.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor` method
      * :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>` class
      * :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>` class
      * :oe:src:`Listing 5<SNIPPET-ATOM-PROP-INDEX-AtomPropIndex>` example in the
        :ref:`chapter_mol_display` chapter

   The following methods are publicly inherited from :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>`:

   ================================================================== ==================================================================
   :oe:meth:`CreateCopy<OEDepict::OEDisplayAtomPropBase::CreateCopy>` :oe:meth:`operator()<OEDepict::OEDisplayAtomPropBase::operator()>`
   ================================================================== ==================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDisplayAtomIdx()

      .. oe:language:: python

         .. oe:api:: python

            OEDisplayAtomIdx() -> OEDisplayAtomIdx

      Default constructor.

   .. ################################################################
      # operator()
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> str

      Returns the string representation of the index of the atom
      (*i.e.* the number returned by the :oe:meth:`OEChem::OEAtomBase::GetIdx`
      method).

   .. ################################################################
      # CreateCopy
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDisplayAtomPropBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDisplayAtomMapIdx, DisplayAtomMapIdx

.. _OEDepict_OEDisplayAtomMapIdx:

.. oe:class:: OEDisplayAtomMapIdx

   .. oe:api::

      class OEDisplayAtomMapIdx : public OEDisplayAtomPropBase

   This class represents :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>` atom property label
   functor.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor` method
      * :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>` class
      * :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>` class
      * :oe:src:`Listing 2<SNIPPET-DEPICTMDLREACTION-MAPIDX-DepictMDLReactionMapIdx>` example in the
        :ref:`chapter_mdlreaction` chapter

   The following methods are publicly inherited from :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>`:

   ================================================================== ==================================================================
   :oe:meth:`CreateCopy<OEDepict::OEDisplayAtomPropBase::CreateCopy>` :oe:meth:`operator()<OEDepict::OEDisplayAtomPropBase::operator()>`
   ================================================================== ==================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDisplayAtomMapIdx()

      .. oe:language:: python

         .. oe:api:: python

            OEDisplayAtomMapIdx() -> OEDisplayAtomMapIdx

      Default constructor.

   .. ################################################################
      # operator()
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> str

      Returns the string representation of the *reaction map index*
      property of the atom. 
      (i.e. the number returned by the :oe:meth:`OEChem::OEAtomBase::GetMapIdx` 
      method).
      The `reaction map index` is used for tracking equivalent atom
      positions in the reaction.
      If `the reaction map index` is zero, meaning that the atom isn't
      mapped in the reaction, than this function returns an empty string.

   .. ################################################################
      # CreateCopy
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDisplayAtomPropBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDisplayAtomPropBase, DisplayAtomPropBase

.. _OEDepict_OEDisplayAtomPropBase:

.. oe:class:: OEDisplayAtomPropBase

   .. oe:api::

      OESystem::OEUnaryFunction<OEChem::OEAtomBase, std::string, true, true>
      OEDisplayAtomPropBase

   :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>` is an abstract class that
   defines the API used for setting atom property labels.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor` method
      * :oe:src:`Listing 6<SNIPPET-ATOM-PROP-USER-AtomPropUser>` example in the
        :ref:`chapter_mol_display` chapter

   The following classes derive from this class:

   * :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>` class
   * :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>` class
   * :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>` class

   .. ################################################################
      # operator()
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string operator () (const OEChem::OEAtomBase& atom) const
 
      .. oe:language:: python

         .. oe:api:: python

            __call__(arg0: OEAtomBase) -> str

      It is a virtual const method that is implemented in the concrete 
      derived classes to set atom property labels.

      *atom*
         The :ref:`OEAtomBase <OEChem_OEAtomBase>` object for which the display
         label is set.

   .. ################################################################
      # CreateCopy
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDisplayAtomPropBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDisplayBondIdx, DisplayBondIdx

.. _OEDepict_OEDisplayBondIdx:

.. oe:class:: OEDisplayBondIdx

   .. oe:api::

      class OEDisplayBondIdx : public OEDisplayBondPropBase

   This class represents `OEDisplayBondIdx`.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor` method
      * :ref:`OEDisplayNoBondProp <OEDepict_OEDisplayNoBondProp>` class
      * :oe:src:`Listing 7<SNIPPET-BOND-PROP-INDEX-BondPropIndex>` example in the
        :ref:`chapter_mol_display` chapter

   The following methods are publicly inherited from :ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>`:

   ================================================================== ==================================================================
   :oe:meth:`CreateCopy<OEDepict::OEDisplayBondPropBase::CreateCopy>` :oe:meth:`operator()<OEDepict::OEDisplayBondPropBase::operator()>`
   ================================================================== ==================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDisplayBondIdx()

      .. oe:language:: python

         .. oe:api:: python

            OEDisplayBondIdx() -> OEDisplayBondIdx

      Default constructor.

   .. ################################################################
      # operator()
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string operator()(const OEChem::OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> str

      Returns the string representation of the index of the bond 
      (*i.e.* the number returned by the :oe:meth:`OEChem::OEBondBase::GetIdx` 
      method)

   .. ################################################################
      # CreateCopy
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDisplayBondPropBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEDisplayBondIdx <OEDepict_OEDisplayBondIdx>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDisplayBondPropBase, DisplayBondPropBase

.. _OEDepict_OEDisplayBondPropBase:

.. oe:class:: OEDisplayBondPropBase

   .. oe:api::

      OESystem::OEUnaryFunction<OEChem::OEBondBase, std::string, true, true>
      class OEDisplayBondPropBase

   :ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>` is an abstract class that
   defines the API used for setting bond property labels.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor` method
      * :oe:src:`Listing 8<SNIPPET-BOND-PROP-USER-BondPropUser>` example in the
        :ref:`chapter_mol_display` chapter

   The following classes derive from this class:

   * :ref:`OEDisplayBondIdx <OEDepict_OEDisplayBondIdx>` class
   * :ref:`OEDisplayNoBondProp <OEDepict_OEDisplayNoBondProp>` class

   .. ################################################################
      # operator()
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string operator () (const OEChem::OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg0: OEBondBase) -> str

      It is a virtual const method that is implemented in the concrete
      derived classes to set bond property labels.

      *bond*
         The :ref:`OEBondBase <OEChem_OEBondBase>` object for which the display label
         is set.

   .. ################################################################
      # CreateCopy
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDisplayBondPropBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDisplayNoAtomProp, DisplayNoAtomProp

.. _OEDepict_OEDisplayNoAtomProp:

.. oe:class:: OEDisplayNoAtomProp

   .. oe:api::

      class OEDisplayNoAtomProp : public OEDisplayAtomPropBase

   This class represents :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>` atom property label
   functor.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor` method
      * :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>` class
      * :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>` class

   The following methods are publicly inherited from :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>`:

   ================================================================== ==================================================================
   :oe:meth:`CreateCopy<OEDepict::OEDisplayAtomPropBase::CreateCopy>` :oe:meth:`operator()<OEDepict::OEDisplayAtomPropBase::operator()>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDisplayNoAtomProp()

      .. oe:language:: python

         .. oe:api:: python

            OEDisplayNoAtomProp() -> OEDisplayNoAtomProp

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string operator()(const OEChem::OEAtomBase & atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: OEAtomBase) -> str

      Returns an empty string which means no atom property 
      is displayed.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDisplayAtomPropBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>`
      object is dynamically allocated and owned by the caller.



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDisplayNoBondProp, DisplayNoBondProp

.. _OEDepict_OEDisplayNoBondProp:

.. oe:class:: OEDisplayNoBondProp

   .. oe:api::

      class OEDisplayNoBondProp : public OEDisplayBondPropBase

   This class represents `OEDisplayNoBondProp`.

   The following methods are publicly inherited from :ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>`:

   ================================================================== ==================================================================
   :oe:meth:`CreateCopy<OEDepict::OEDisplayBondPropBase::CreateCopy>` :oe:meth:`operator()<OEDepict::OEDisplayBondPropBase::operator()>`
   ================================================================== ==================================================================

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor` method
      * :ref:`OEDisplayBondIdx <OEDepict_OEDisplayBondIdx>` class

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDisplayNoBondProp()

      .. oe:language:: python

         .. oe:api:: python

            OEDisplayNoBondProp() -> OEDisplayNoBondProp

      Default constructor.

   .. ################################################################
      # operator()
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string operator()(const OEChem::OEBondBase & bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: OEBondBase) -> str

      Returns an empty string, which means that no bond property
      is displayed.

   .. ################################################################
      # CreateCopy
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDisplayBondPropBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEDisplayNoBondProp <OEDepict_OEDisplayNoBondProp>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEFont, Font

.. _OEDepict_OEFont:

.. oe:class:: OEFont

   .. oe:api::

      class OEFont

   The :ref:`OEFont <OEDepict_OEFont>` class encapsulates properties that determine
   the display style of texts.

   Currently the :ref:`OEFont <OEDepict_OEFont>` class stores the following properties:

   .. list-table::
      :widths: 60 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace/class/type
      * - alignment
        - :oe:meth:`GetAlignment<OEDepict::OEFont::GetAlignment>`
        - :oe:meth:`SetAlignment<OEDepict::OEFont::SetAlignment>`
        - :oe:constns:`OEDepict::OEAlignment`
      * - color
        - :oe:meth:`GetColor<OEDepict::OEFont::GetColor>`
        - :oe:meth:`SetColor<OEDepict::OEFont::SetColor>`
        - :ref:`OEColor <OESystem_OEColor>`
      * - font family
        - :oe:meth:`GetFamily<OEDepict::OEFont::GetFamily>`
        - :oe:meth:`SetFamily<OEDepict::OEFont::SetFamily>`
        - :oe:constns:`OEDepict::OEFontFamily`
      * - font size
        - :oe:meth:`GetSize<OEDepict::OEFont::GetSize>`
        - :oe:meth:`SetSize<OEDepict::OEFont::SetSize>`
        - None
      * - font style
        - :oe:meth:`GetStyle<OEDepict::OEFont::GetStyle>`
        - :oe:meth:`SetStyle<OEDepict::OEFont::SetStyle>`
        - :oe:constns:`OEDepict::OEFontStyle`
      * - hyperlink
        - :oe:meth:`GetHyperlink<OEDepict::OEFont::GetHyperlink>` / :oe:meth:`HasHyperlink<OEDepict::OEFont::HasHyperlink>`
        - :oe:meth:`SetHyperlink<OEDepict::OEFont::SetHyperlink>`
        - string
      * - rotation angle
        - :oe:meth:`GetRotationAngle<OEDepict::OEFont::GetRotationAngle>`
        - :oe:meth:`SetRotationAngle<OEDepict::OEFont::SetRotationAngle>`
        - floating point number in range of :math:`[0.0^{\circ}, 360.0^{\circ}]`

   ..  seealso::

       * :oe:meth:`OEDepict::OEImageBase::DrawText` method

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFont()

      .. oe:language:: python

         .. oe:api:: python

            OEFont() -> OEFont

      Default constructor that initializes an :ref:`OEFont <OEDepict_OEFont>`
      object with the following properties:
      See example in :ref:`Figure: Example of drawing text with default OEFont object<figure_OEFont_Default>`.

      .. list-table:: Default parameters of OEFont
         :widths: 100 100
         :header-rows: 1

         * - Property
           - Default value
         * - alignment
           - :oe:const:`OEDepict::OEAlignment::Default`
         * - color
           - :oe:const:`OEBlack<OESystem::OESystem::OEBlack>` = OEColor(0,0,0)
         * - font family
           - :oe:const:`OEDepict::OEFontFamily::Default`
         * - font size
           - 12
         * - hyperlink
           - empty string (i.e. no hyperlink)
         * - font style
           - :oe:const:`OEDepict::OEFontStyle::Default`
         * - rotation angles
           - 0.0 (i.e. no rotation)

      .. _figure_OEFont_Default:

      .. figure:: depicttk/images/OEFont_Default.*
         :align:  center

         **Example of drawing text with default OEFont object**

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFont(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            OEFont(color: OEColor) -> OEFont

      Constructor that initializes an :ref:`OEFont <OEDepict_OEFont>` object
      with the default parameters and the given :ref:`OEColor <OESystem_OEColor>`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFont(unsigned int family, unsigned int style, unsigned int size,
                   unsigned int align, const OESystem::OEColor& color,
                   double rotangle = 0.0)

      .. oe:language:: python

         .. oe:api:: python

            OEFont(family: int, style: int, size: int, align: int,
                   color: OEColor, rotangle: float = 0.0) -> OEFont

      Constructor that initializes an :ref:`OEFont <OEDepict_OEFont>` object
      with the given parameters.

      *family*
         The family of the font.
         This value has to be from the :oe:constns:`OEDepict::OEFontFamily`
         namespace.
         See also :oe:meth:`OEDepict::OEFont::SetFamily` method.

      *style*
         The style of the font.
         This value has to be from the :oe:constns:`OEDepict::OEFontStyle`
         namespace.
         See also :oe:meth:`OEDepict::OEFont::SetSize` method.
      *size*
         The size of the font.
         See also :oe:meth:`OEDepict::OEFont::SetSize` method.

      *align*
         The alignment of the text.
         This value has to be from the :oe:constns:`OEDepict::OEAlignment`
         namespace.
         See also :oe:meth:`OEDepict::OEFont::SetAlignment` method.

      *color*
         The color of the font.
         See also :oe:meth:`OEDepict::OEFont::SetColor` method.

      *rotangle*
         The rotation angle of the text.
         The default value is 0.0 which means no rotation is applied *i.e.*
         the text using the :ref:`OEFont <OEDepict_OEFont>` object is rendered
         horizontally.
         See also :oe:meth:`OEDepict::OEFont::SetRotationAngle` method.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFont(const OEFont& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEFont(arg2: OEFont) -> OEFont

      Copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFont &operator=(const OEFont &rhs)

      Assignment operator.

   .. oe:method:: operator!=
      :language: c++

      .. oe:api::

         bool operator!=(const OEFont &rhs) const

      Determines whether two :ref:`OEFont <OEDepict_OEFont>` objects are
      different.
      Two :ref:`OEFont <OEDepict_OEFont>` objects are considered different
      if any of their properties (such as color, size, etc.) are
      different.

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEFont &rhs) const

      Determines whether two :ref:`OEFont <OEDepict_OEFont>` objects are
      equal.
      Two :ref:`OEFont <OEDepict_OEFont>` objects are considered equivalent
      only if all of their properties (such as color, size, etc.) are
      identical.

   .. oe:method:: GetAlignment

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetAlignment() const

      .. oe:language:: python

         .. oe:api:: python

            GetAlignment() -> int

      Returns the *alignment* property of the :ref:`OEFont <OEDepict_OEFont>`
      object.
      The returned value is taken from the :oe:constns:`OEDepict::OEAlignment`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::SetAlignment` method
         * :oe:constns:`OEDepict::OEAlignment` namespace

   .. oe:method:: GetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> OEColor

      Returns the color of the :ref:`OEFont <OEDepict_OEFont>` object.

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::SetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: GetFamily

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFamily() const

      .. oe:language:: python

         .. oe:api:: python

            GetFamily() -> int

      Returns the *font family* property of the :ref:`OEFont <OEDepict_OEFont>`
      object.
      The returned value is taken from the :oe:constns:`OEDepict::OEFontFamily`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::SetFamily` method
         * :oe:constns:`OEDepict::OEFontFamily` namespace

   .. oe:method:: GetHyperlink

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetHyperlink() const

      .. oe:language:: python

         .. oe:api:: python

            GetHyperlink() -> str

      Returns the URI string associated with the :ref:`OEFont <OEDepict_OEFont>`
      object.

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::HasHyperlink` method
         * :oe:meth:`OEDepict::OEFont::SetHyperlink` method

   .. oe:method:: GetRotationAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRotationAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotationAngle() -> float

      Returns the angle of the rotation that is used to render a
      text when using the :ref:`OEFont <OEDepict_OEFont>` object.

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::SetRotationAngle` method

   .. oe:method:: GetSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetSize() -> int

      Returns the size of the :ref:`OEFont <OEDepict_OEFont>` object.

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::SetSize` method

   .. oe:method:: GetStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetStyle() -> int

      Returns the *font style* property of the :ref:`OEFont <OEDepict_OEFont>`
      object.
      The returned value is taken from the :oe:constns:`OEDepict::OEFontStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::SetStyle` method
         * :oe:constns:`OEDepict::OEFontStyle` namespace

   .. oe:method:: HasHyperlink

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasHyperlink() const

      .. oe:language:: python

         .. oe:api:: python

            HasHyperlink() -> bool

      Returns whether an URI string is associated with the :ref:`OEFont <OEDepict_OEFont>`
      object.

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::GetHyperlink` method
         * :oe:meth:`OEDepict::OEFont::SetHyperlink` method

   .. oe:method:: SetAlignment

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAlignment(unsigned int align)

      .. oe:language:: python

         .. oe:api:: python

            SetAlignment(arg2: int) -> None

      Sets the *alignment* property of the :ref:`OEFont <OEDepict_OEFont>`
      object.

      *align*
         This value has to be from the :oe:constns:`OEDepict::OEAlignment`
         namespace.

      Example (:ref:`Figure: Example of using the SetAlignment method<figure_OEFont_SetAlignment>`)

      .. oe:source:: OEFont_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-ALIGNMENT

      .. oe:source:: OEFont_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-ALIGNMENT

      .. oe:source:: OEFont_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-ALIGNMENT

      .. oe:source:: OEFont_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-ALIGNMENT

      .. _figure_OEFont_SetAlignment:

      .. figure:: depicttk/images/OEFont_SetAlignment.*
         :align:  center

         **Example of using the SetAlignment method**

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::GetAlignment` method
         * :oe:constns:`OEDepict::OEAlignment` namespace

   .. oe:method:: SetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetColor(color: OEColor) -> None

      Sets the color of the :ref:`OEFont <OEDepict_OEFont>` object.

      Example (:ref:`Figure: Example of using the SetColor method<figure_OEFont_SetColor>`)

      .. oe:source:: OEFont_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-COLOR

      .. oe:source:: OEFont_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-COLOR

      .. oe:source:: OEFont_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-COLOR

      .. oe:source:: OEFont_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-COLOR

      .. _figure_OEFont_SetColor:

      .. figure:: depicttk/images/OEFont_SetColor.*
         :align:  center

         **Example of using the SetColor method**

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::GetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: SetFamily

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFamily(unsigned int family)

      .. oe:language:: python

         .. oe:api:: python

            SetFamily(arg2: int) -> None

      Sets the *font family* property of the :ref:`OEFont <OEDepict_OEFont>`
      object.

      *family*
         This value has to be from the :oe:constns:`OEDepict::OEFontFamily`
         namespace.

      Example (:ref:`Figure: Example of using the SetFamily method<figure_OEFont_SetFamily>`)

      .. oe:source:: OEFont_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-FAMILY

      .. oe:source:: OEFont_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-FAMILY

      .. oe:source:: OEFont_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-FAMILY

      .. oe:source:: OEFont_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-FAMILY

      .. _figure_OEFont_SetFamily:

      .. figure:: depicttk/images/OEFont_SetFamily.*
         :align:  center

         **Example of using the SetFamily method**

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::GetFamily` method
         * :oe:constns:`OEDepict::OEFontFamily` namespace

   .. oe:method:: SetHyperlink

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHyperlink(const string& uri)

      .. oe:language:: python

         .. oe:api:: python

            SetHyperlink(link: str) -> None

      Associates URI string with the :ref:`OEFont <OEDepict_OEFont>`
      object.

      *uri*
         After associating a **valid** URI with a :ref:`OEFont <OEDepict_OEFont>`
         object, texts drawn with the given font become "click-able"
         and by clicking on them will send you to the given address.

      .. meta:
         :keywords: URI, hyperlink

      Example (:ref:`Figure: Example of using the SetHyperlink method<figure_OEFont_SetHyperlink>`)

      .. oe:source:: DepictMolWithHyperlink.py
         :language: python
         :noindent:
         :frag:     SNIPPET-DEPICT-MOL-WITH-HYPERLINK

      .. oe:source:: DepictMolWithHyperlink.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-DEPICT-MOL-WITH-HYPERLINK

      .. oe:source:: DepictMolWithHyperlink.java
         :language: java
         :noindent:
         :frag:     SNIPPET-DEPICT-MOL-WITH-HYPERLINK

      .. oe:source:: DepictMolWithHyperlink.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-DEPICT-MOL-WITH-HYPERLINK

      .. _figure_OEFont_SetHyperlink:

      .. figure:: depicttk/images/DepictMolWithHyperlink.*
         :align:  center
         :width: 250 pt

         **Example of using the SetHyperlink method**

         (Clicking on the blue text at the bottom send you to the OEDepict TK web page)

      .. note::

         Associating texts with hyperlinks is **only available** for :file:`.pdf`
         and :file:`.svg` image formats.

      .. warning::

         **OEDepict TK** does **not** check whether the given
         string is a valid `URI <http://en.wikipedia.org/wiki/Uniform_resource_identifier>`_.

         It is recommended to always keep the `URI scheme <http://en.wikipedia.org/wiki/URI_scheme>`_
         prefix of the `URI <http://en.wikipedia.org/wiki/Uniform_resource_identifier>`_ string for the sake
         of compatibility.
         For example, some application can interpret the ``www.eyesopen.com`` string as a valid
         `URI <http://en.wikipedia.org/wiki/Uniform_resource_identifier>`_,
         others only work when using ``http://www.eyesopen.com``.

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::GetHyperlink` method
         * :oe:meth:`OEDepict::OEFont::GetHyperlink` method

   .. oe:method:: SetRotationAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRotationAngle(double angle)

      .. oe:language:: python

         .. oe:api:: python

            SetRotationAngle(arg2: float) -> None

      Sets the rotation angle of the :ref:`OEFont <OEDepict_OEFont>` object.

      *angle*
         The rotation angle of the text (in degrees).
         The value of the angle has to be in a range of
         :math:`[0.0^{\circ}, 360.0^{\circ}]`.

      Example (:ref:`Figure: Example of using the SetRotationAngle method<figure_OEFont_SetRotationAngle>`)

      .. oe:source:: OEFont_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-ROTATION-ANGLE

      .. oe:source:: OEFont_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-ROTATION-ANGLE

      .. oe:source:: OEFont_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-ROTATION-ANGLE

      .. oe:source:: OEFont_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-ROTATION-ANGLE

      .. _figure_OEFont_SetRotationAngle:

      .. figure:: depicttk/images/OEFont_SetRotationAngle.*
         :align:  center

         **Example of using the SetRotationAngle method**

      .. note::

         The angles are interpreted in an anti-clockwise direction.
         The :math:`0.0^{\circ}` and :math:`360.0^{\circ}`
         degrees are at the 3 o'clock position *i.e.* the text is
         rendered horizontally.
         While the :math:`180.0^{\circ}` degrees corresponds to
         rendering the text upside down.
         See examples in :ref:`Figure: Example of drawing texts with various
         rotation angle<figure_OEImageBase_DrawText_Rotations>`.

      .. _figure_OEImageBase_DrawText_Rotations:

      .. figure:: depicttk/images/OEImageBase-DrawText-Rotations.*
         :align:  center
         :scale:  100

         **Example of drawing texts with various rotation angles**

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::GetRotationAngle` method

   .. oe:method:: SetSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSize(unsigned int size)

      .. oe:language:: python

         .. oe:api:: python

            SetSize(arg2: int) -> None

      Sets the size of the :ref:`OEFont <OEDepict_OEFont>` object.

      Example (:ref:`Figure: Example of using the SetSize method<figure_OEFont_SetSize>`)

      .. oe:source:: OEFont_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-SIZE

      .. oe:source:: OEFont_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-SIZE

      .. oe:source:: OEFont_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-SIZE

      .. oe:source:: OEFont_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-SIZE

      .. _figure_OEFont_SetSize:

      .. figure:: depicttk/images/OEFont_SetSize.*
         :align:  center

         **Example of using the SetSize method**

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::GetSize` method

   .. oe:method:: SetStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetStyle(arg2: int) -> None

      Sets the *font style* property (such as **bold**, *italic* etc.)
      of the :ref:`OEFont <OEDepict_OEFont>` object.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEFontStyle`
         namespace.

      Example (:ref:`Figure: Example of using the SetStyle method<figure_OEFont_SetStyle>`)

      .. oe:source:: OEFont_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-STYLE

      .. oe:source:: OEFont_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-STYLE

      .. oe:source:: OEFont_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-STYLE

      .. oe:source:: OEFont_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEFONT-SET-STYLE

      .. _figure_OEFont_SetStyle:

      .. figure:: depicttk/images/OEFont_SetStyle.*
         :align:  center

         **Example of using the SetStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OEFont::GetStyle` method
         * :oe:constns:`OEDepict::OEFontStyle` namespace


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEHighlightBase, HighlightBase

.. _OEDepict_OEHighlightBase:

.. oe:class:: OEHighlightBase

   .. oe:api::

      class OEHighlightBase

   :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` is an abstract class
   used for highlighting atoms and/or bonds.

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlighting` function.

   The following classes derive from this class:

    * :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>`
    * :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>`
    * :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>`
    * :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>`
    * :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>`

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightBase()
            OEHighlightBase(OEHighlightBaseImpl* impl)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightBase() -> OEHighlightBase

      Default constructors.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            virtual OEHighlightBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHighlightBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEHighlightByBallAndStick, HighlightByBallAndStick

.. _OEDepict_OEHighlightByBallAndStick:

.. oe:class:: OEHighlightByBallAndStick

   .. oe:api::

      class OEHighlightByBallAndStick : public OEHighlightBase

   The :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>` class allows the
   customization of the **ball and stick** highlighting style that is
   associated with the :oe:const:`OEDepict::OEHighlightStyle::BallAndStick`
   constant.
   See example in :ref:`Figure: Example of highlighting using the
   'ball and stick' style<figure_OEHighlightStyle_BallAndStick>`.

   .. _figure_OEHighlightStyle_BallAndStick:

   .. figure:: depicttk/images/OEHighlightStyle_BallAndStick.*
      :align:  center

      **Example of highlighting using the 'ball and stick' style**

   The :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - atom label
        - :oe:meth:`GetAtomLabelMonochrome<OEDepict::OEHighlightByBallAndStick::GetAtomLabelMonochrome>`
        - :oe:meth:`SetAtomLabelMonochrome<OEDepict::OEHighlightByBallAndStick::SetAtomLabelMonochrome>`
        - boolean

      * - ball radius scale
        - :oe:meth:`GetBallRadiusScale<OEDepict::OEHighlightByBallAndStick::GetBallRadiusScale>`
        - :oe:meth:`SetBallRadiusScale<OEDepict::OEHighlightByBallAndStick::SetBallRadiusScale>`
        - floating point number

      * - color
        - :oe:meth:`GetColor<OEDepict::OEHighlightByBallAndStick::GetColor>`
        - :oe:meth:`SetColor<OEDepict::OEHighlightByBallAndStick::SetColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - stick width scale
        - :oe:meth:`GetStickWidthScale<OEDepict::OEHighlightByBallAndStick::GetStickWidthScale>`
        - :oe:meth:`SetStickWidthScale<OEDepict::OEHighlightByBallAndStick::SetStickWidthScale>`
        - floating point number

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlighting` function
      * :oe:constns:`OEDepict::OEHighlightStyle` namespace
      * :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` class
      * :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` class
      * :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>` class
      * :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>` class
      * :ref:`chapter_highlighting` chapter

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightByBallAndStick(const OESystem::OEColor& c,
                                      double stickWidthScale = 3.0,
                                      double ballRadiusScale = 3.0,
                                      bool monochrome = true)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightByBallAndStick(color: OEColor,
                                      stickWidthScale: float = 3.0,
                                      ballRadiusScale: float = 3.0,
                                      monochrome: bool = True) -> OEHighlightByBallAndStick

      Creates an :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>` object with the
      specified parameters.

      *color*
         The color used for highlighting.
         See also :oe:meth:`OEDepict::OEHighlightByBallAndStick::SetColor` method.

      *stickWidthScale*
         The multiplier that can be used to increase or decrease
         the stick width of the highlighted bond(s).
         See also :oe:meth:`OEDepict::OEHighlightByBallAndStick::SetStickWidthScale` method.

      *ballRadiusScale*
         The multiplier that can be used to increase or decrease
         the ball radius of the highlighted atom(s).
         See also :oe:meth:`OEDepict::OEHighlightByBallAndStick::SetBallRadiusScale` method.

      *monochrome*
         Defines whether or not to change the color of the atom label
         of the highlighted atom(s).
         See also :oe:meth:`OEDepict::OEHighlightByBallAndStick::SetAtomLabelMonochrome` method.

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightByBallAndStick(const OEHighlightByBallAndStick& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightByBallAndStick(rhs: OEHighlightByBallAndStick) -> OEHighlightByBallAndStick

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHighlightByBallAndStick &operator=(const OEHighlightByBallAndStick &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHighlightByBallAndStick

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetAtomLabelMonochrome

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAtomLabelMonochrome() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelMonochrome() -> bool

      Returns whether or not the color of the atom label of the highlighted
      atom(s) is changed.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByBallAndStick::SetAtomLabelMonochrome` method

   .. oe:method:: GetBallRadiusScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBallRadiusScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetBallRadiusScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the ball radius of the highlighted atom(s).

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByBallAndStick::SetBallRadiusScale` method

   .. oe:method:: GetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> OEColor

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByBallAndStick::SetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: GetStickWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetStickWidthScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetStickWidthScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the stick width of the highlighted bond(s).

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByBallAndStick::SetStickWidthScale` method

   .. oe:method:: SetAtomLabelMonochrome

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomLabelMonochrome(bool monochrome)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelMonochrome(monochrome: bool) -> None

      Sets whether or not to change the color of the atom label
      of the highlighted atom(s).

      Example (:ref:`Figure: Example of using the SetAtomLabelMonochrome method<figure_OEHighlightByBallAndStick_SetAtomLabelMonochrome>`)

      .. oe:source:: HighlightByBallAndStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByBallAndStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByBallAndStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByBallAndStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETATOMLABELMONOCHROME

      .. _figure_OEHighlightByBallAndStick_SetAtomLabelMonochrome:

      .. figure:: depicttk/images/OEHighlightByBallAndStick_SetAtomLabelMonochrome.*
         :align:  center

         **Example of using the SetAtomLabelMonochrome method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByBallAndStick::GetAtomLabelMonochrome` method

   .. oe:method:: SetBallRadiusScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBallRadiusScale(double ballRadiusScale)

      .. oe:language:: python

         .. oe:api:: python

            SetBallRadiusScale(ballRadiusScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the ball radius of the highlighted atom(s).

      Example (:ref:`Figure: Example of using the SetBallRadiusScale method<figure_OEHighlightByBallAndStick_SetBallRadiusScale>`)

      .. oe:source:: HighlightByBallAndStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETBALLRADIUSSCALE

      .. oe:source:: HighlightByBallAndStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETBALLRADIUSSCALE

      .. oe:source:: HighlightByBallAndStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETBALLRADIUSSCALE

      .. oe:source:: HighlightByBallAndStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETBALLRADIUSSCALE

      .. _figure_OEHighlightByBallAndStick_SetBallRadiusScale:

      .. figure:: depicttk/images/OEHighlightByBallAndStick_SetBallRadiusScale.*
         :align:  center

         **Example of using the SetBallRadiusScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByBallAndStick::GetBallRadiusScale` method

   .. oe:method:: SetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetColor(color: OEColor) -> None

      Sets the color of the highlighting.

      Example (:ref:`Figure: Example of using the SetColor method<figure_OEHighlightByBallAndStick_SetColor>`)

      .. oe:source:: HighlightByBallAndStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETCOLOR

      .. oe:source:: HighlightByBallAndStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETCOLOR

      .. oe:source:: HighlightByBallAndStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETCOLOR

      .. oe:source:: HighlightByBallAndStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETCOLOR

      .. _figure_OEHighlightByBallAndStick_SetColor:

      .. figure:: depicttk/images/OEHighlightByBallAndStick_SetColor.*
         :align:  center

         **Example of using the SetColor method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByBallAndStick::GetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: SetStickWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStickWidthScale(double stickWidthScale)

      .. oe:language:: python

         .. oe:api:: python

            SetStickWidthScale(stickWidthScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the stick width of the highlighted bond(s).

      Example (:ref:`Figure: Example of using the SetStickWidthScale method<figure_OEHighlightByBallAndStick_SetStickWidthScale>`)

      .. oe:source:: HighlightByBallAndStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightByBallAndStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightByBallAndStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightByBallAndStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYBALLANDSTICK-SETSTICKWIDTHSCALE

      .. _figure_OEHighlightByBallAndStick_SetStickWidthScale:

      .. figure:: depicttk/images/OEHighlightByBallAndStick_SetStickWidthScale.*
         :align:  center

         **Example of using the SetStickWidthScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByBallAndStick::GetStickWidthScale` method


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEHighlightByCogwheel, HighlightByCogwheel

.. _OEDepict_OEHighlightByCogwheel:

.. oe:class:: OEHighlightByCogwheel

   .. oe:api::

      class OEHighlightByCogwheel : public OEHighlightBase

   The :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` class allows the
   customization of the **cogwheel** highlighting style that is
   associated with the :oe:const:`OEDepict::OEHighlightStyle::Cogwheel`
   constant.
   See example in :ref:`Figure: Example of highlighting using the 'cogwheel' style<figure_OEHighlightStyle_Cogwheel>`.

   .. _figure_OEHighlightStyle_Cogwheel:

   .. figure:: depicttk/images/OEHighlightStyle_Cogwheel.*
      :align:  center

      **Example of highlighting using the color style**

   The :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - atom label
        - :oe:meth:`GetAtomLabelMonochrome<OEDepict::OEHighlightByCogwheel::GetAtomLabelMonochrome>`
        - :oe:meth:`SetAtomLabelMonochrome<OEDepict::OEHighlightByCogwheel::SetAtomLabelMonochrome>`
        - boolean

      * - ball radius scale
        - :oe:meth:`GetBallRadiusScale<OEDepict::OEHighlightByCogwheel::GetBallRadiusScale>`
        - :oe:meth:`SetBallRadiusScale<OEDepict::OEHighlightByCogwheel::SetBallRadiusScale>`
        - floating point number

      * - color
        - :oe:meth:`GetColor<OEDepict::OEHighlightByCogwheel::GetColor>`
        - :oe:meth:`SetColor<OEDepict::OEHighlightByCogwheel::SetColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - inner contour
        - :oe:meth:`GetInnerContour<OEDepict::OEHighlightByCogwheel::GetInnerContour>`
        - :oe:meth:`SetInnerContour<OEDepict::OEHighlightByCogwheel::SetInnerContour>`
        - boolean

      * - line width scale
        - :oe:meth:`GetLineWidthScale<OEDepict::OEHighlightByCogwheel::GetLineWidthScale>`
        - :oe:meth:`SetLineWidthScale<OEDepict::OEHighlightByCogwheel::SetLineWidthScale>`
        - floating point number

      * - stick width scale
        - :oe:meth:`GetStickWidthScale<OEDepict::OEHighlightByCogwheel::GetStickWidthScale>`
        - :oe:meth:`SetStickWidthScale<OEDepict::OEHighlightByCogwheel::SetStickWidthScale>`
        - floating point number

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlighting` function
      * :oe:constns:`OEDepict::OEHighlightStyle` namespace
      * :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>` class
      * :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` class
      * :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>` class
      * :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>` class
      * :ref:`chapter_highlighting` chapter

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightByCogwheel(const OESystem::OEColor& color,
                                  double lineWidthScale = 1.5,
                                  double stickWidthScale = 2.0,
                                  double ballRadiusScale = 2.0,
                                  bool innerContour = true,
                                  bool monochrome = true)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightByCogwheel(color: OEColor, lineWidthScale: float = 1.5,
                                  stickWidthScale: float = 2.0,
                                  ballRadiusScale: float = 2.0,
                                  innerContour: bool = True,
                                  monochrome: bool = True) -> OEHighlightByCogwheel

      Creates an :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` object with the
      specified parameters.

      *color*
         The color used for highlighting.
         See also :oe:meth:`OEDepict::OEHighlightByCogwheel::SetColor` method.

      *lineWidthScale*
         The multiplier that can be used to increase or decrease
         the line width of the 'cogwheel'.
         See also :oe:meth:`OEDepict::OEHighlightByCogwheel::SetLineWidthScale` method.

      *stickWidthScale*
         The multiplier that can be used to increase or decrease
         the stick width of the 'cogwheel' of the highlighted bond(s).
         See also :oe:meth:`OEDepict::OEHighlightByCogwheel::SetStickWidthScale` method.

      *ballRadiusScale*
         The multiplier that can be used to increase or decrease
         the ball radius of the 'cogwheel' of the highlighted atom(s).
         See also :oe:meth:`OEDepict::OEHighlightByCogwheel::SetBallRadiusScale` method.

      *innerContour*
         Defines whether the inner contour of the 'cogwheel' is drawn or committed.
         See also :oe:meth:`OEDepict::OEHighlightByCogwheel::SetInnerContour` method.

      *monochrome*
         Defines whether or not to change the color of the atom label
         of the highlighted atom(s).
         See also :oe:meth:`OEDepict::OEHighlightByCogwheel::SetAtomLabelMonochrome` method.

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightByCogwheel(const OEHighlightByCogwheel& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightByCogwheel(rhs: OEHighlightByCogwheel) -> OEHighlightByCogwheel

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHighlightByCogwheel &operator=(const OEHighlightByCogwheel &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHighlightByCogwheel

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetAtomLabelMonochrome

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAtomLabelMonochrome() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelMonochrome() -> bool

      Returns whether or not the color of the atom label of the highlighted
      atom(s) is changed.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::SetAtomLabelMonochrome` method

   .. oe:method:: GetBallRadiusScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBallRadiusScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetBallRadiusScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the ball radius of the 'cogwheel' of the highlighted atom(s).

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::SetBallRadiusScale` method

   .. oe:method:: GetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> OEColor

      Returns the color of the highlighting.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::SetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: GetInnerContour

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetInnerContour() const

      .. oe:language:: python

         .. oe:api:: python

            GetInnerContour() -> bool

      Returns whether the inner contour of the 'cogwheel' is drawn or committed.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::SetInnerContour` method

   .. oe:method:: GetLineWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLineWidthScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetLineWidthScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the line width of the 'cogwheel'

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::SetLineWidthScale` method

   .. oe:method:: GetStickWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetStickWidthScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetStickWidthScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the stick width of the 'cogwheel' of the highlighted bond(s).

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::SetStickWidthScale` method

   .. oe:method:: SetAtomLabelMonochrome

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomLabelMonochrome(bool monochrome)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelMonochrome(monochrome: bool) -> None

      Sets whether or not to change the color of the atom label
      of the highlighted atom(s).

      Example (:ref:`Figure: Example of using the SetAtomLabelMonochrome method<figure_OEHighlightByCogwheel_SetAtomLabelMonochrome>`)

      .. oe:source:: HighlightByCogwheel.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByCogwheel.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByCogwheel.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByCogwheel.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETATOMLABELMONOCHROME

      .. _figure_OEHighlightByCogwheel_SetAtomLabelMonochrome:

      .. figure:: depicttk/images/OEHighlightByCogwheel_SetAtomLabelMonochrome.*
         :align:  center

         **Example of using the SetAtomLabelMonochrome method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::GetAtomLabelMonochrome` method

   .. oe:method:: SetBallRadiusScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBallRadiusScale(double ballRadiusScale)

      .. oe:language:: python

         .. oe:api:: python

            SetBallRadiusScale(ballRadiusScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the ball radius of the 'cogwheel' of the highlighted atom(s).

      Example (:ref:`Figure: Example of using the SetBallRadiusScale method<figure_OEHighlightByCogwheel_SetBallRadiusScale>`)

      .. oe:source:: HighlightByCogwheel.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETBALLRADIUSSCALE

      .. oe:source:: HighlightByCogwheel.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETBALLRADIUSSCALE

      .. oe:source:: HighlightByCogwheel.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETBALLRADIUSSCALE

      .. oe:source:: HighlightByCogwheel.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETBALLRADIUSSCALE

      .. _figure_OEHighlightByCogwheel_SetBallRadiusScale:

      .. figure:: depicttk/images/OEHighlightByCogwheel_SetBallRadiusScale.*
         :align:  center

         **Example of using the SetBallRadiusScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::GetBallRadiusScale` method

   .. oe:method:: SetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetColor(color: OEColor) -> None

      Sets the color of the highlighting.

      Example (:ref:`Figure: Example of using the SetColor method<figure_OEHighlightByCogwheel_SetColor>`)

      .. oe:source:: HighlightByCogwheel.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETCOLOR

      .. oe:source:: HighlightByCogwheel.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETCOLOR

      .. oe:source:: HighlightByCogwheel.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETCOLOR

      .. oe:source:: HighlightByCogwheel.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETCOLOR

      .. _figure_OEHighlightByCogwheel_SetColor:

      .. figure:: depicttk/images/OEHighlightByCogwheel_SetColor.*
         :align:  center

         **Example of using the SetColor method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::GetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: SetInnerContour

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetInnerContour(bool innerContour)

      .. oe:language:: python

         .. oe:api:: python

            SetInnerContour(innerContour: bool) -> None

      Sets whether the inner contour of the 'cogwheel' is drawn or omitted.

      Example (:ref:`Figure: Example of using the SetInnerContour method<figure_OEHighlightByCogwheel_SetInnerContour>`)

      .. oe:source:: HighlightByCogwheel.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETINNERCONTOUR

      .. oe:source:: HighlightByCogwheel.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETINNERCONTOUR

      .. oe:source:: HighlightByCogwheel.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETINNERCONTOUR

      .. oe:source:: HighlightByCogwheel.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETINNERCONTOUR

      .. _figure_OEHighlightByCogwheel_SetInnerContour:

      .. figure:: depicttk/images/OEHighlightByCogwheel_SetInnerContour.*
         :align:  center

         **Example of using the SetInnerContour method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::GetInnerContour` method

   .. oe:method:: SetLineWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLineWidthScale(double lineWidthScale)

      .. oe:language:: python

         .. oe:api:: python

            SetLineWidthScale(lineWidthScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the line width of the 'cogwheel'

      Example (:ref:`Figure: Example of using the SetLineWidthScale method<figure_OEHighlightByCogwheel_SetLineWidthScale>`)

      .. oe:source:: HighlightByCogwheel.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETLINEWIDTHSCALE

      .. oe:source:: HighlightByCogwheel.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETLINEWIDTHSCALE

      .. oe:source:: HighlightByCogwheel.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETLINEWIDTHSCALE

      .. oe:source:: HighlightByCogwheel.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETLINEWIDTHSCALE

      .. _figure_OEHighlightByCogwheel_SetLineWidthScale:

      .. figure:: depicttk/images/OEHighlightByCogwheel_SetLineWidthScale.*
         :align:  center

         **Example of using the SetLineWidthScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::GetLineWidthScale` method

   .. oe:method:: SetStickWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStickWidthScale(double stickWidthScale)

      .. oe:language:: python

         .. oe:api:: python

            SetStickWidthScale(stickWidthScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the stick width of the 'cogwheel' of the highlighted bond(s).

      Example (:ref:`Figure: Example of using the SetStickWidthScale method<figure_OEHighlightByCogwheel_SetStickWidthScale>`)

      .. oe:source:: HighlightByCogwheel.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightByCogwheel.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightByCogwheel.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightByCogwheel.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETSTICKWIDTHSCALE

      .. _figure_OEHighlightByCogwheel_SetStickWidthScale:

      .. figure:: depicttk/images/OEHighlightByCogwheel_SetStickWidthScale.*
         :align:  center

         **Example of using the SetStickWidthScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::GetStickWidthScale` method


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEHighlightByColor, HighlightByColor

.. _OEDepict_OEHighlightByColor:

.. oe:class:: OEHighlightByColor

   .. oe:api::

      class OEHighlightByColor : public OEHighlightBase

   The :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` class allows the
   customization of the **color** highlighting style that is
   associated with the :oe:const:`OEDepict::OEHighlightStyle::Color`
   constant.
   See example in :ref:`Figure: Example of highlighting using the
   'color' style<figure_OEHighlightStyle_Color>`.

   .. _figure_OEHighlightStyle_Color:

   .. figure:: depicttk/images/OEHighlightStyle_Color.*
      :align:  center

      **Example of highlighting using the 'color' style**

   The :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - external highlight
        - :oe:meth:`GetAtomExternalHighlight<OEDepict::OEHighlightByColor::GetAtomExternalHighlight>`
        - :oe:meth:`SetAtomExternalHighlight<OEDepict::OEHighlightByColor::SetAtomExternalHighlight>`
        - boolean

      * - color
        - :oe:meth:`GetColor<OEDepict::OEHighlightByColor::GetColor>`
        - :oe:meth:`SetColor<OEDepict::OEHighlightByColor::SetColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - line width scale
        - :oe:meth:`GetLineWidthScale<OEDepict::OEHighlightByColor::GetLineWidthScale>`
        - :oe:meth:`SetLineWidthScale<OEDepict::OEHighlightByColor::SetLineWidthScale>`
        - floating point

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlighting` function
      * :oe:constns:`OEDepict::OEHighlightStyle` namespace
      * :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>` class
      * :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` class
      * :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>` class
      * :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>` class
      * :ref:`chapter_highlighting` chapter

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightByColor(const OESystem::OEColor& color,
                               double lineWidthScale = 1.5,
                               bool atomExternalHighlight = false)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightByColor(color: OEColor, lineWidthScale: float = 1.5,
                               atomExternalHighlight: bool = False) -> OEHighlightByColor

      Creates an :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` object with the
      specified parameters.

      *color*
         The color used for highlighting.
         See also :oe:meth:`OEDepict::OEHighlightByColor::SetColor` method.

      *lineWidthScale*
         The multiplier that can be used to increase or decrease
         the line width of highlighted bond(s).
         See also :oe:meth:`OEDepict::OEHighlightByColor::SetLineWidthScale` method.

      *atomExternalHighlight*
         Sets whether atom highlights are extended to bonds not being
         highlighted.
         See also :oe:meth:`OEDepict::OEHighlightByColor::SetAtomExternalHighlight` method.

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightByColor(const OEHighlightByColor& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightByColor(rhs: OEHighlightByColor) -> OEHighlightByColor

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHighlightByColor &operator=(const OEHighlightByColor &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHighlightByColor

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetAtomExternalHighlight

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAtomExternalHighlight() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomExternalHighlight() -> bool

      Returns whether external atom highlight is applied.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByColor::SetAtomExternalHighlight` method

   .. oe:method:: GetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> OEColor

      Returns the color of the highlighting.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByColor::GetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: GetLineWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLineWidthScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetLineWidthScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the line width of highlighted bond(s).

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByColor::SetLineWidthScale` method

   .. oe:method:: SetAtomExternalHighlight

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomExternalHighlight(bool set)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomExternalHighlight(atomexternal: bool) -> None

      Sets whether atom highlights are extended to bonds not being
      highlighted.

      Example (:ref:`Figure: Example of using the SetAtomExternalHighlight method<figure_OEHighlightByColor_SetAtomExternalHighlight>`)

      .. oe:source:: HighlightByColor.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOLOR-SETATOMEXTERNALHIGHLIGHT

      .. oe:source:: HighlightByColor.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOLOR-SETATOMEXTERNALHIGHLIGHT

      .. oe:source:: HighlightByColor.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOLOR-SETATOMEXTERNALHIGHLIGHT

      .. oe:source:: HighlightByColor.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOLOR-SETATOMEXTERNALHIGHLIGHT

      .. _figure_OEHighlightByColor_SetAtomExternalHighlight:

      .. figure:: depicttk/images/OEHighlightByColor_SetAtomExternalHighlight.*
         :align:  center

         **Example of using the SetAtomExternalHighlight method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByColor::GetAtomExternalHighlight` method

   .. oe:method:: SetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetColor(color: OEColor) -> None

      Sets the color of the highlighting.

      Example (:ref:`Figure: Example of using the SetColor method<figure_OEHighlightByColor_SetColor>`)

      .. oe:source:: HighlightByColor.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOLOR-SETCOLOR

      .. oe:source:: HighlightByColor.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOLOR-SETCOLOR

      .. oe:source:: HighlightByColor.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOLOR-SETCOLOR

      .. oe:source:: HighlightByColor.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOLOR-SETCOLOR

      .. _figure_OEHighlightByColor_SetColor:

      .. figure:: depicttk/images/OEHighlightByColor_SetColor.*
         :align:  center

         **Example of using the SetColor method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByColor::GetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: SetLineWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLineWidthScale(double lineWidthScale)

      .. oe:language:: python

         .. oe:api:: python

            SetLineWidthScale(lineWidthScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the line width of highlighted bond(s).

      Example (:ref:`Figure: Example of using the SetLineWidthScale method<figure_OEHighlightByColor_SetLineWidthScale>`)

      .. oe:source:: HighlightByColor.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOLOR-SETLINEWIDTHSCALE

      .. oe:source:: HighlightByColor.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOLOR-SETLINEWIDTHSCALE

      .. oe:source:: HighlightByColor.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOLOR-SETLINEWIDTHSCALE

      .. oe:source:: HighlightByColor.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOLOR-SETLINEWIDTHSCALE

      .. _figure_OEHighlightByColor_SetLineWidthScale:

      .. figure:: depicttk/images/OEHighlightByColor_SetLineWidthScale.*
         :align:  center

         **Example of using the SetLineWidthScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByColor::GetLineWidthScale` method


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEHighlightByLasso, HighlightByLasso

.. _OEDepict_OEHighlightByLasso:

.. oe:class:: OEHighlightByLasso

   .. oe:api::

      class OEHighlightByLasso : public OEHighlightBase

   The :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>` class allows the
   customization of the **lasso** highlighting style that is
   associated with the :oe:const:`OEDepict::OEHighlightStyle::Lasso`
   constant.
   See example in :ref:`Figure: Example of highlighting using the
   'lasso' style<figure_OEHighlightStyle_Lasso>`.

   .. _figure_OEHighlightStyle_Lasso:

   .. figure:: depicttk/images/OEHighlightStyle_Lasso.*
      :align:  center

      **Example of highlighting using the 'lasso' style**

   The :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - atom label color
        - :oe:meth:`GetAtomLabelMonochrome<OEDepict::OEHighlightByCogwheel::GetAtomLabelMonochrome>`
        - :oe:meth:`SetAtomLabelMonochrome<OEDepict::OEHighlightByCogwheel::SetAtomLabelMonochrome>`
        - boolean

      * - atom label box
        - :oe:meth:`GetConsiderAtomLabelBoundingBox<OEDepict::OEHighlightByLasso::GetConsiderAtomLabelBoundingBox>`
        - :oe:meth:`SetConsiderAtomLabelBoundingBox<OEDepict::OEHighlightByLasso::SetConsiderAtomLabelBoundingBox>`
        - boolean

      * - color
        - :oe:meth:`GetColor<OEDepict::OEHighlightByLasso::GetColor>`
        - :oe:meth:`SetColor<OEDepict::OEHighlightByLasso::SetColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - pen
        - :oe:meth:`GetPen<OEDepict::OEHighlightByLasso::GetPen>`
        - :oe:meth:`SetPen<OEDepict::OEHighlightByLasso::SetPen>`
        - :ref:`OEPen <OEDepict_OEPen>`

      * - position
        - :oe:meth:`GetPosition<OEDepict::OEHighlightByLasso::GetPosition>`
        - :oe:meth:`SetPosition<OEDepict::OEHighlightByLasso::SetPosition>`
        - :oe:constns:`OEDepict::OELayerPosition` namespace

      * - lasso scale
        - :oe:meth:`GetLassoScale<OEDepict::OEHighlightByLasso::GetLassoScale>`
        - :oe:meth:`SetLassoScale<OEDepict::OEHighlightByLasso::SetLassoScale>`
        - floating point number

      * - line width scale
        - :oe:meth:`GetLineWidthScale<OEDepict::OEHighlightByLasso::GetLineWidthScale>`
        - :oe:meth:`SetLineWidthScale<OEDepict::OEHighlightByLasso::SetLineWidthScale>`
        - floating point

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlighting` function
      * :oe:constns:`OEDepict::OEHighlightStyle` namespace
      * :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>` class
      * :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` class
      * :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` class
      * :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>` class
      * :ref:`chapter_highlighting` chapter

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightByLasso(const OESystem::OEColor& color,
                               double lassoScale = 3.0, bool monochrome = true,
                               bool considerAtomLabelBox = false,
                               unsigned int position = OELayerPosition::Below,
                               double lineWidthScale = 1.0)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightByLasso(color: OEColor, lassoScale: float = 3.0,
                               monochrome: bool = True,
                               considerAtomLabelBox: bool = False,
                               position: int, lws: float = 1.0) -> OEHighlightByLasso

      Creates an :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>` object with the
      specified parameters.

      *color*
         The color used for highlighting.
         See also :oe:meth:`OEDepict::OEHighlightByLasso::SetColor` method.

      *lassoScale*
         The multiplier that can be used to increase or decrease
         the distance of the "lasso" from the highlighted atom(s) and bond(s).
         See also :oe:meth:`OEDepict::OEHighlightByLasso::SetLassoScale` method.

      *monochrome*
         Defines whether or not to change the color of the atom label of the highlighted atom(s).
         See also :oe:meth:`OEDepict::OEHighlightByLasso::SetAtomLabelMonochrome` method.

      *considerAtomLabelBox*
         Determines whether or not to consider the atom label bounding boxes when
         generating the 'lasso' highlights.
         See also :oe:meth:`OEDepict::OEHighlightByLasso::SetConsiderAtomLabelBoundingBox` method.

      *position*
         Defines whether the 'lasso' highlight is going to be rendered below
         or above the molecule.
         See also :oe:meth:`OEDepict::OEHighlightByLasso::SetPosition` method.

      *lineWidthScale*
         The multiplier that can be used to increase or decrease
         the line width of lasso.
         See also :oe:meth:`OEDepict::OEHighlightByLasso::SetLineWidthScale` method.

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightByLasso(const OEHighlightByLasso& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightByLasso(rhs: OEHighlightByLasso) -> OEHighlightByLasso

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHighlightByLasso &operator=(const OEHighlightByLasso &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHighlightByLasso

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetAtomLabelMonochrome

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAtomLabelMonochrome() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelMonochrome() -> bool

      Returns whether or not the color of the atom label of the highlighted
      atom(s) is changed.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::SetAtomLabelMonochrome` method

   .. oe:method:: GetConsiderAtomLabelBoundingBox

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetConsiderAtomLabelBoundingBox() const

      .. oe:language:: python

         .. oe:api:: python

            GetConsiderAtomLabelBoundingBox() -> bool

      Returns whether or not to consider the atom label bounding boxes when
      generating the 'lasso' highlights.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::SetConsiderAtomLabelBoundingBox` method

   .. oe:method:: GetLassoScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLassoScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetLassoScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the distance of the line of the 'lasso' from the highlighted atom(s) and bonds(s).

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::SetLassoScale` method

   .. oe:method:: GetLineWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLineWidthScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetLineWidthScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the line width of the lasso.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::SetLineWidthScale` method

   .. oe:method:: GetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> OEColor

      Returns the foreground color of the highlighting.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::GetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: GetPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEPen& GetPen() const

      .. oe:language:: python

         .. oe:api:: python

            GetPen() -> OEPen

      Returns the pen of the highlighting.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::SetPen` method
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. oe:method:: GetPosition

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetPosition() const

      .. oe:language:: python

         .. oe:api:: python

            GetPosition() -> int

      Returns whether the 'lasso' highlight is going to be render above or
      below the molecule.
      The return value is taken from the :oe:constns:`OEDepict::OELayerPosition`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::SetPosition` method
         * :oe:constns:`OEDepict::OELayerPosition` namespace

   .. oe:method:: SetAtomLabelMonochrome

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomLabelMonochrome(bool monochrome)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelMonochrome(monochrome: bool) -> None

      Sets whether or not to change the color of the atom label
      of the highlighted atom(s).

      Example (:ref:`Figure: Example of using the SetAtomLabelMonochrome method<figure_OEHighlightByLasso_SetAtomLabelMonochrome>`)

      .. oe:source:: HighlightByLasso.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByLasso.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByLasso.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByLasso.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETATOMLABELMONOCHROME

      .. _figure_OEHighlightByLasso_SetAtomLabelMonochrome:

      .. figure:: depicttk/images/OEHighlightByLasso_SetAtomLabelMonochrome.*
         :align:  center

         **Example of using the SetAtomLabelMonochrome method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::GetAtomLabelMonochrome` method

   .. oe:method:: SetConsiderAtomLabelBoundingBox

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetConsiderAtomLabelBoundingBox(bool consider)

      .. oe:language:: python

         .. oe:api:: python

            SetConsiderAtomLabelBoundingBox(consider: bool) -> None

      Sets whether or not to consider the atom label bounding boxes when
      generating the 'lasso' highlights.
      By considering the bounding boxes, the number cases when the
      lines of the highlight clash with the atom label can be reduced.

      Example (:ref:`Figure: Example of using the SetConsiderAtomLabelBoundingBox method<figure_OEHighlightByLasso_SetConsiderAtomLabelBoundingBox>`)

      .. oe:source:: HighlightByLasso.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETCONSIDERATOMLABELBOUNDINGBOX

      .. oe:source:: HighlightByLasso.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETCONSIDERATOMLABELBOUNDINGBOX

      .. oe:source:: HighlightByLasso.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETCONSIDERATOMLABELBOUNDINGBOX

      .. oe:source:: HighlightByLasso.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETCONSIDERATOMLABELBOUNDINGBOX

      .. _figure_OEHighlightByLasso_SetConsiderAtomLabelBoundingBox:

      .. figure:: depicttk/images/OEHighlightByLasso_SetConsiderAtomLabelBoundingBox.*
         :align:  center

         **Example of using the SetConsiderAtomLabelBoundingBox method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::SetConsiderAtomLabelBoundingBox` method

   .. oe:method:: SetLassoScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLassoScale(double lassoScale)

      .. oe:language:: python

         .. oe:api:: python

            SetLassoScale(lassoScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the distance of the line of the 'lasso' from the highlighted atom(s) and bond(s).

      Example (:ref:`Figure: Example of using the SetLassoScale method<figure_OEHighlightByLasso_SetLassoScale>`)

      .. oe:source:: HighlightByLasso.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETLASSOSCALE

      .. oe:source:: HighlightByLasso.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETLASSOSCALE

      .. oe:source:: HighlightByLasso.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETLASSOSCALE

      .. oe:source:: HighlightByLasso.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETLASSOSCALE

      .. _figure_OEHighlightByLasso_SetLassoScale:

      .. figure:: depicttk/images/OEHighlightByLasso_SetLassoScale.*
         :align:  center

         **Example of using the SetLassoScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::GetLassoScale` method

   .. oe:method:: SetLineWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLineWidthScale(double lineWidthScale)

      .. oe:language:: python

         .. oe:api:: python

            SetLineWidthScale(lineWidthScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the line width of the lasso.

      Example (:ref:`Figure: Example of using the SetLineWidthScale method<figure_OEHighlightByLasso_SetLineWidthScale>`)

      .. oe:source:: HighlightByLasso.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETLINEWIDTHSCALE

      .. oe:source:: HighlightByLasso.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETLINEWIDTHSCALE

      .. oe:source:: HighlightByLasso.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETLINEWIDTHSCALE

      .. oe:source:: HighlightByLasso.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETLINEWIDTHSCALE

      .. _figure_OEHighlightByLasso_SetLineWidthScale:

      .. figure:: depicttk/images/OEHighlightByLasso_SetLineWidthScale.*
         :align:  center

         **Example of using the SetLineWidthScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::GetLineWidthScale` method

   .. oe:method:: SetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetColor(color: OEColor) -> None

      Sets the foreground color of the highlighting.

      Example (:ref:`Figure: Example of using the SetColor method<figure_OEHighlightByLasso_SetColor>`)

      .. oe:source:: HighlightByLasso.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETCOLOR

      .. oe:source:: HighlightByLasso.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETCOLOR

      .. oe:source:: HighlightByLasso.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETCOLOR

      .. oe:source:: HighlightByLasso.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETCOLOR

      .. _figure_OEHighlightByLasso_SetColor:

      .. figure:: depicttk/images/OEHighlightByLasso_SetColor.*
         :align:  center

         **Example of using the SetColor method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::GetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: SetPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPen(const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            SetPen(pen: OEPen) -> None

      Sets the pen of the highlighting.

      Example (:ref:`Figure: Example of using the SetPen method<figure_OEHighlightByLasso_SetPen>`)

      .. oe:source:: HighlightByLasso.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETPEN

      .. oe:source:: HighlightByLasso.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETPEN

      .. oe:source:: HighlightByLasso.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETPEN

      .. oe:source:: HighlightByLasso.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYLASSO-SETPEN

      .. _figure_OEHighlightByLasso_SetPen:

      .. figure:: depicttk/images/OEHighlightByLasso_SetPen.*
         :align:  center

         **Example of using the SetPen method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::GetPen` method
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. oe:method:: SetPosition

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPosition(unsigned int position)

      .. oe:language:: python

         .. oe:api:: python

            SetPosition(arg2: int) -> None

      Sets whether the 'lasso' highlight is going to be render above or
      below the molecule.

      *position*
         This value has to be from the :oe:constns:`OEDepict::OELayerPosition`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByLasso::GetPosition` method


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEHighlightByStick, HighlightByStick

.. _OEDepict_OEHighlightByStick:

.. oe:class:: OEHighlightByStick

   .. oe:api::

      class OEHighlightByStick : public OEHighlightBase

   The :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>` class allows the
   customization of the **stick** highlighting style that is
   associated with the :oe:const:`OEDepict::OEHighlightStyle::Stick`
   constant.
   See example in :ref:`Figure: Example of highlighting using the
   'stick' style<figure_OEHighlightStyle_Stick>`.

   .. _figure_OEHighlightStyle_Stick:

   .. figure:: depicttk/images/OEHighlightStyle_Stick.*
      :align:  center

      **Example of highlighting using the 'stick' style**

   The :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - external highlight
        - :oe:meth:`GetAtomExternalHighlightRatio<OEDepict::OEHighlightByStick::GetAtomExternalHighlightRatio>`
        - :oe:meth:`SetAtomExternalHighlightRatio<OEDepict::OEHighlightByStick::SetAtomExternalHighlightRatio>`
        - floating point

      * - atom label
        - :oe:meth:`GetAtomLabelMonochrome<OEDepict::OEHighlightByStick::GetAtomLabelMonochrome>`
        - :oe:meth:`SetAtomLabelMonochrome<OEDepict::OEHighlightByStick::SetAtomLabelMonochrome>`
        - boolean

      * - color
        - :oe:meth:`GetColor<OEDepict::OEHighlightByStick::GetColor>`
        - :oe:meth:`SetColor<OEDepict::OEHighlightByStick::SetColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - stick width scale
        - :oe:meth:`GetStickWidthScale<OEDepict::OEHighlightByStick::GetStickWidthScale>`
        - :oe:meth:`SetStickWidthScale<OEDepict::OEHighlightByStick::SetStickWidthScale>`
        - floating point number

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlighting` function
      * :oe:constns:`OEDepict::OEHighlightStyle` namespace
      * :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>` class
      * :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` class
      * :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` class
      * :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>` class
      * :ref:`chapter_highlighting` chapter

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightByStick(const OESystem::OEColor& color,
                               double stickWidthScale = 3.0,
                               bool monochrome = true,
                               double atomExternalHighlightRatio = 0.0)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightByStick(color: OEColor, stickWidthScale: float = 3.0,
                               monochrome: bool = True,
                               atomExternalHighlightRatio: float = 0.0) -> OEHighlightByStick

      Creates an :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>` object with the
      specified parameters.

      *color*
         The color used for highlighting.
         See also :oe:meth:`OEDepict::OEHighlightByStick::SetColor` method.

      *stickWidthScale*
         The multiplier that can be used to increase or decrease
         the stick width of the highlighted bond(s).
         See also :oe:meth:`OEDepict::OEHighlightByStick::SetStickWidthScale` method.

      *monochrome*
         Defines whether or not to change the color of the atom label
         of the highlighted atom(s).
         See also :oe:meth:`OEDepict::OEHighlightByStick::SetAtomLabelMonochrome` method.

      *atomExternalHighlightRatio*
         A ratio that can be used to extend atom highlights to bonds not being highlighted.
         See also :oe:meth:`OEDepict::OEHighlightByStick::SetAtomExternalHighlightRatio` method.

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightByStick(const OEHighlightByStick& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightByStick(rhs: OEHighlightByStick) -> OEHighlightByStick

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHighlightByStick &operator=(const OEHighlightByStick &rhs)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHighlightByStick

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetAtomExternalHighlightRatio

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetAtomExternalHighlightRatio() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomExternalHighlightRatio() -> float

      Returns the ratio of the external highlight of the atoms.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByStick::SetAtomExternalHighlightRatio` method

   .. oe:method:: GetAtomLabelMonochrome

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAtomLabelMonochrome() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelMonochrome() -> bool

      Returns whether or not the color of the atom label of the highlighted
      atom(s) is changed.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByStick::SetAtomLabelMonochrome` method

   .. oe:method:: GetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> OEColor

      Returns the color of the highlighting.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByStick::SetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: GetStickWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetStickWidthScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetStickWidthScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the stick width of the highlighted bond(s).

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByStick::SetStickWidthScale` method

   .. oe:method:: SetAtomExternalHighlightRatio

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomExternalHighlightRatio(double ratio)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomExternalHighlightRatio(ratio: float) -> None

      Sets the ratio of the external highlight of the atoms *i.e.*
      atom highlights are extended to bonds not being highlighted.

      *ratio*
         This value has to be in the range of ``[0.0, 0.5]``.

      Example (:ref:`Figure: Example of using the SetAtomExternalHighlightRatio method<figure_OEHighlightByStick_SetAtomExternalHighlightRatio>`)

      .. oe:source:: HighlightByStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETATOMEXTERNALHIGHLIGHTRATIO

      .. oe:source:: HighlightByStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETATOMEXTERNALHIGHLIGHTRATIO

      .. oe:source:: HighlightByStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETATOMEXTERNALHIGHLIGHTRATIO

      .. oe:source:: HighlightByStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETATOMEXTERNALHIGHLIGHTRATIO

      .. _figure_OEHighlightByStick_SetAtomExternalHighlightRatio:

      .. figure:: depicttk/images/OEHighlightByStick_SetAtomExternalHighlightRatio.*
         :align:  center

         **Example of using the SetAtomExternalHighlightRatio method**

      .. figure:: depicttk/images/OEHighlightByStick_Scaling_SetAtomExternalHighlightRatio.*
         :align:  center

         **Example of scaling the 'Stick' style highlighting along with the molecule**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByStick::GetColor` method

   .. oe:method:: SetAtomLabelMonochrome

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomLabelMonochrome(bool monochrome)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelMonochrome(monochrome: bool) -> None

      Sets whether or not to change the color of the atom label
      of the highlighted atom(s).

      Example (:ref:`Figure: Example of using the SetAtomLabelMonochrome method<figure_OEHighlightByStick_SetAtomLabelMonochrome>`)

      .. oe:source:: HighlightByStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETATOMLABELMONOCHROME

      .. _figure_OEHighlightByStick_SetAtomLabelMonochrome:

      .. figure:: depicttk/images/OEHighlightByStick_SetAtomLabelMonochrome.*
         :align:  center

         **Example of using the SetAtomLabelMonochrome method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByStick::GetAtomLabelMonochrome` method

   .. oe:method:: SetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetColor(color: OEColor) -> None

      Sets the color of the highlighting.

      Example (:ref:`Figure: Example of using the SetColor method<figure_OEHighlightByStick_SetColor>`)

      .. oe:source:: HighlightByStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETCOLOR

      .. oe:source:: HighlightByStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETCOLOR

      .. oe:source:: HighlightByStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETCOLOR

      .. oe:source:: HighlightByStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETCOLOR

      .. _figure_OEHighlightByStick_SetColor:

      .. figure:: depicttk/images/OEHighlightByStick_SetColor.*
         :align:  center

         **Example of using the SetColor method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByStick::GetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: SetStickWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStickWidthScale(double stickWidthScale)

      .. oe:language:: python

         .. oe:api:: python

            SetStickWidthScale(stickWidthScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the stick width of the highlighted bond(s).

      Example (:ref:`Figure: Example of using the SetStickWidthScale method<figure_OEHighlightByStick_SetStickWidthScale>`)

      .. oe:source:: HighlightByStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightByStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightByStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightByStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYSTICK-SETSTICKWIDTHSCALE

      .. _figure_OEHighlightByStick_SetStickWidthScale:

      .. figure:: depicttk/images/OEHighlightByStick_SetStickWidthScale.*
         :align:  center

         **Example of using the SetStickWidthScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByStick::GetStickWidthScale` method



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEHighlightLabel:

.. oe:class:: OEHighlightLabel

   .. oe:api::

      class OEHighlightLabel

   The :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` class allows the
   customization the style of the label that can be position
   on molecule depiction by calling the :oe:func:`OEDepict::OEAddLabel`
   function.

   The :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - text
        - :oe:meth:`GetText<OEDepict::OEHighlightLabel::GetText>`
        - :oe:meth:`OEHighlightLabel constructors<OEDepict::OEHighlightLabel::Constructors>`
        - string

      * - bounding box pen
        - :oe:meth:`GetBoundingBoxPen<OEDepict::OEHighlightLabel::GetBoundingBoxPen>`
        - :oe:meth:`SetBoundingBoxPen<OEDepict::OEHighlightLabel::SetBoundingBoxPen>`
        - :ref:`OEPen <OEDepict_OEPen>`

      * - label font
        - :oe:meth:`GetFont<OEDepict::OEHighlightLabel::GetFont>`
        - :oe:meth:`SetFont<OEDepict::OEHighlightLabel::SetFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - label font scale
        - :oe:meth:`GetFontScale<OEDepict::OEHighlightLabel::GetFontScale>`
        - :oe:meth:`SetFontScale<OEDepict::OEHighlightLabel::SetFontScale>`
        - positive floating point number in the range of ``[0.25, 1.5]`` or ``0.0``

   .. ################################################################
      # Constructors
      ################################################################
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightLabel(const std::string& text)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightLabel(text: str) -> OEHighlightLabel
            OEHighlightLabel(arg2: OEHighlightLabel) -> OEHighlightLabel

      Creates an :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` object with default style.

      *text*
        The text that is going to be positioned on the molecule depiction.

      **Example:**

      .. oe:source:: OEHighlightLabel_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-DEFAULT

      .. oe:source:: OEHighlightLabel_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-DEFAULT

      .. oe:source:: OEHighlightLabel_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-DEFAULT

      .. oe:source:: OEHighlightLabel_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-DEFAULT

      .. figure:: depicttk/images/OEHighlightLabel_Default.*
         :align:  center

         **Example of adding label with default style**

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightLabel(const std::string& text, const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightLabel(text: str, font: OEFont) -> OEHighlightLabel

      Creates an :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` object with user-defined font.

      *text*
         The text that is going to be positioned on the molecule depiction.

      *font*
         The :ref:`OEFont <OEDepict_OEFont>` object that encapsulates properties
         that determine the display style of text.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class

      **Example:**

      .. oe:source:: OEHighlightLabel_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-FONT

      .. oe:source:: OEHighlightLabel_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-FONT

      .. oe:source:: OEHighlightLabel_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-FONT

      .. oe:source:: OEHighlightLabel_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-FONT

      .. figure:: depicttk/images/OEHighlightLabel_Font.*
         :align:  center

         **Example of adding label with user-defined font**

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightLabel(const std::string& text,
                             const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightLabel(text: str, color: OEColor) -> OEHighlightLabel

      Creates an :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` object with user-defined border color.

      *text*
         The text that is going to be positioned on the molecule depiction.

      *color*
         The color of the border around the label.

      **Example:**

      .. oe:source:: OEHighlightLabel_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-COLOR

      .. figure:: depicttk/images/OEHighlightLabel_Color.*
         :align:  center

         **Example of adding label with user-defined border color**

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetBoundingBoxPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEPen& GetBoundingBoxPen() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundingBoxPen() -> OEPen

      Returns the pen that is used to draw a border around the label.

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:cls:`OEDepict::OEHighlightLabel::SetBoundingBoxPen` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont& GetFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetFont() -> OEFont

      Returns the font of the label.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OEHighlightLabel::SetFont` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetFontScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetFontScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetFontScale() -> float

      Returns the multiplier that can be used to increase or decrease the font size
      of the label relative to the font size used to render labels of the 
      of the depicted molecule.
      The default value is ``0.75``.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OEHighlightLabel::SetFontScale` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetText

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetText() const

      .. oe:language:: python

         .. oe:api:: python

            GetText() -> str

      Returns the text of the label.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: SetBoundingBoxPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBoundingBoxPen(const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            SetBoundingBoxPen(pen: OEPen) -> None

      Sets the pen that is used to draw a border around the label.

      **Example:**

      .. oe:source:: OEHighlightLabel_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-SETBOUNDINGBOXPEN

      .. oe:source:: OEHighlightLabel_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-SETBOUNDINGBOXPEN

      .. oe:source:: OEHighlightLabel_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-SETBOUNDINGBOXPEN

      .. oe:source:: OEHighlightLabel_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-SETBOUNDINGBOXPEN

      .. figure:: depicttk/images/OEHighlightLabel_SetBoundingBoxPen.*
         :align:  center

         **Example of adding label with user-defined border**

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: SetFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetFont(font: OEFont) -> None

      Set the font of the label.

      **Example:**

      .. oe:source:: OEHighlightLabel_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-SETFONT

      .. oe:source:: OEHighlightLabel_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-SETFONT

      .. oe:source:: OEHighlightLabel_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-SETFONT

      .. oe:source:: OEHighlightLabel_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-SETFONT

      .. figure:: depicttk/images/OEHighlightLabel_SetFont.*
         :align:  center

         **Example of adding label with user-defined font**

      .. note::

         The size of fonts of the label depends on:

         * the size of the font used  to render atom labels of the
           the depicted molecule
         * the multiplier set by the :oe:meth:`OEDepict::OEHighlightLabel::SetFontScale` method

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: SetFontScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFontScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetFontScale(scale: float) -> None

      Sets the multiplier that can be used to increase or decrease the font size
      of the label relative to the font size used to render atom labels of the
      of the depicted molecule.

      *scale*
         This value has to be either ``0.0`` or in a range of ``[0.25, 1.50]``.
         The default value is ``0.75``.

         In case of ``0.0``, the label is not scaled with the molecule
         but rather fixed font size is used regardless of the size of
         the depicted molecule.

      **Example:**

      .. oe:source:: OEHighlightLabel_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-SETFONTSCALE

      .. oe:source:: OEHighlightLabel_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-SETFONTSCALE

      .. oe:source:: OEHighlightLabel_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-SETFONTSCALE

      .. oe:source:: OEHighlightLabel_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTLABEL-SETFONTSCALE

      .. figure:: depicttk/images/OEHighlightLabel_SetFontScale.*
         :align:  center

         **Example of adding label with user-defined font scaling**


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEHighlightOverlayBase, HighlightOverlayBase

.. _OEDepict_OEHighlightOverlayBase:

.. oe:class:: OEHighlightOverlayBase

   .. oe:api::

      class OEHighlightOverlayBase

   The :ref:`OEHighlightOverlayBase <OEDepict_OEHighlightOverlayBase>` is an abstract class
   used for highlighting a set of atoms and/or bonds.

   The following classes derive from this class:

    * :ref:`OEHighlightOverlayByBallAndStick <OEDepict_OEHighlightOverlayByBallAndStick>`

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlightOverlay` function
      * :ref:`section_highlighting_overlap` section

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightOverlayBase()
            OEHighlightOverlayBase(OEHighlightOverlayBaseImpl* impl)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightOverlayBase() -> OEHighlightOverlayBase

      Default constructors.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetColors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESystem::OEColor>* GetColors() const

      .. oe:language:: python

         .. oe:api:: python

            GetColors() -> Iterable[OEColor]

      Returns an iterator over the colors used for highlighting.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: SetColors

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColors(OESystem::OEIter<OESystem::OEColor>& colors)
            void SetColors(OESystem::OEIterBase<OESystem::OEColor>* colors)

      .. oe:language:: python

         .. oe:api:: python

            SetColors(colors: OEColorIter) -> None

      Sets the colors used for highlighting.


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEHighlightOverlayByBallAndStick, HighlightOverlayByBallAndStick

.. _OEDepict_OEHighlightOverlayByBallAndStick:

.. oe:class:: OEHighlightOverlayByBallAndStick

   .. oe:api::

      class  OEHighlightOverlayByBallAndStick : public OEHighlightOverlayBase

   The :ref:`OEHighlightOverlayByBallAndStick <OEDepict_OEHighlightOverlayByBallAndStick>` class allows the
   customization of the **ball and stick** highlighting style that is
   associated with the :oe:const:`OEDepict::OEHighlightOverlayStyle::BallAndStick`
   constant.
   This style enables the highlighting of overlapping patterns.
   See example in :ref:`Figure: Example of overlay highlighting using the
   'ball and stick' style<figure_OEHighlightOverlayStyle_BallAndStick>`.

   .. _figure_OEHighlightOverlayStyle_BallAndStick:

   .. figure:: depicttk/images/OEHighlightOverlayStyle_BallAndStick.*
      :align:  center

      **Example of overlay highlighting using the 'ball and stick' style**

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlightOverlay` function.
      * :oe:constns:`OEDepict::OEHighlightOverlayStyle` namespace
      * :ref:`section_highlighting_overlap` section

   .. note::

      It is recommended to select colors with high contrast when highlighting overlapped
      patterns with the :ref:`OEHighlightOverlayByBallAndStick <OEDepict_OEHighlightOverlayByBallAndStick>` class.

      .. seealso::

         * :oe:func:`OESystem::OEGetContrastColors` function

   The following methods are publicly inherited from :ref:`OEHighlightOverlayBase <OEDepict_OEHighlightOverlayBase>`:

   ================================================================= =================================================================
   :oe:meth:`GetColors<OEDepict::OEHighlightOverlayBase::GetColors>` :oe:meth:`SetColors<OEDepict::OEHighlightOverlayBase::SetColors>`
   ================================================================= =================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightOverlayByBallAndStick(OESystem::OEIter<OESystem::OEColor>& colors,
                                             double stickWidthScale = 3.0,
                                             double ballRadiusScale = 3.0,
                                             bool monochrome = true)
            OEHighlightOverlayByBallAndStick(OESystem::OEIterBase<OESystem::OEColor>* colors,
                                             double stickWidthScale = 3.0,
                                             double ballRadiusScale = 3.0,
                                             bool monochrome = true)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightOverlayByBallAndStick(colors: OEColorIter,
                                             stickWidthScale: float = 3.0,
                                             ballRadiusScale: float = 3.0,
                                             monochrome: bool = True) -> OEHighlightOverlayByBallAndStick

      Creates an :ref:`OEHighlightOverlayByBallAndStick <OEDepict_OEHighlightOverlayByBallAndStick>` object with the
      specified parameters

      *colors*
         The colors used for highlighting.
         See also :oe:meth:`OEDepict::OEHighlightOverlayBase::SetColors` method.

      *stickWidthScale*
         The multiplier that can be used to increase or decrease
         the stick width of the highlighted bond(s).
         See also :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::SetStickWidthScale` method.

      *ballRadiusScale*
         The multiplier that can be used to increase or decrease
         the ball radius of the highlighted atoms(s).
         See also :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::SetBallRadiusScale` method.

      *monochrome*
         Defines whether or not to change the color of the atom label
         of the highlighted atom(s).
         See also :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::SetAtomLabelMonochrome` method.

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightOverlayByBallAndStick(const OEHighlightOverlayByBallAndStick& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightOverlayByBallAndStick(rhs: OEHighlightOverlayByBallAndStick) -> OEHighlightOverlayByBallAndStick

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHighlightOverlayByBallAndStick &operator=(const OEHighlightOverlayByBallAndStick &rhs)

      Assignment operator.

   .. oe:method:: GetAtomLabelMonochrome

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAtomLabelMonochrome() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelMonochrome() -> bool

      Returns whether or not the color of the atom label of the highlighted
      atom(s) is changed.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::SetAtomLabelMonochrome` method

   .. oe:method:: GetBallRadiusScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBallRadiusScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetBallRadiusScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the ball radius of the highlighted atoms(s).

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::SetBallRadiusScale` method

   .. oe:method:: GetStickWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetStickWidthScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetStickWidthScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the stick width of the highlighted bond(s).

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::SetStickWidthScale` method

   .. oe:method:: SetAtomLabelMonochrome

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtomLabelMonochrome(bool monochrome)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelMonochrome(monochrome: bool) -> None

      Sets whether or not to change the color of the atom label
      of the highlighted atom(s).

      Example (:ref:`Figure: Example of using the SetAtomLabelMonochrome method<figure_OEHighlightOverlayByBallAndStick_SetAtomLabelMonochrome>`)

      .. oe:source:: HighlightOverlayBallStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightOverlayBallStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETATOMLABELMONOCHROME

      .. oe:language:: java

      .. oe:source:: HighlightOverlayBallStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETATOMLABELMONOCHROME

      .. oe:language:: csharp

      .. oe:source:: HighlightOverlayBallStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETATOMLABELMONOCHROME

      .. _figure_OEHighlightOverlayByBallAndStick_SetAtomLabelMonochrome:

      .. figure:: depicttk/images/OEHighlightOverlayByBallAndStick_SetAtomLabelMonochrome.*
         :align:  center

         **Example of using the SetAtomLabelMonochrome method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::GetAtomLabelMonochrome` method

   .. oe:method:: SetBallRadiusScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBallRadiusScale(double ballRadiusScale)

      .. oe:language:: python

         .. oe:api:: python

            SetBallRadiusScale(ballRadiusScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the ball radius of the highlighted atoms(s).

      Example (:ref:`Figure: Example of using the SetBallRadiusScale method<figure_OEHighlightOverlayByBallAndStick_SetBallRadiusScale>`)

      .. oe:source:: HighlightOverlayBallStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETBALLRADIUSSCALE

      .. oe:source:: HighlightOverlayBallStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETBALLRADIUSSCALE

      .. oe:language:: java

      .. oe:source:: HighlightOverlayBallStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETBALLRADIUSSCALE

      .. oe:language:: csharp

      .. oe:source:: HighlightOverlayBallStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETBALLRADIUSSCALE

      .. _figure_OEHighlightOverlayByBallAndStick_SetBallRadiusScale:

      .. figure:: depicttk/images/OEHighlightOverlayByBallAndStick_SetBallRadiusScale.*
         :align:  center

         **Example of using the SetBallRadiusScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::GetBallRadiusScale` method

   .. oe:method:: SetStickWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStickWidthScale(double stickWidthScale)

      .. oe:language:: python

         .. oe:api:: python

            SetStickWidthScale(stickWidthScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the stick width of the highlighted bond(s).

      Example (:ref:`Figure: Example of using the SetStickWidthScale method<figure_OEHighlightOverlayByBallAndStick_SetStickWidthScale>`)

      .. oe:source:: HighlightOverlayBallStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightOverlayBallStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightOverlayBallStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETSTICKWIDTHSCALE

      .. oe:language:: csharp

      .. oe:source:: HighlightOverlayBallStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETSTICKWIDTHSCALE

      .. _figure_OEHighlightOverlayByBallAndStick_SetStickWidthScale:

      .. figure:: depicttk/images/OEHighlightOverlayByBallAndStick_SetStickWidthScale.*
         :align:  center

         **Example of using the SetStickWidthScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::GetStickWidthScale` method


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEImage

.. _OEDepict_OEImage:

.. oe:class:: OEImage

   .. oe:api::

      class OEImage : public OEImageBase

   :ref:`OEImage <OEDepict_OEImage>` class is implemented as a **display list** i.e.
   a container of drawing commands.
   For example, when the :oe:meth:`OEDepict::OEImage::DrawLine` method is
   called, rather than immediately drawing a line specified by the parameters,
   a line drawing operation is created that copies all parameters for later
   execution.

   When the :oe:meth:`OEDepict::OEImage::Render` method is invoked, the
   drawing commands stored in the :ref:`OEImage <OEDepict_OEImage>` object are
   executed in the same order in which they were issued.

   The following methods are publicly inherited from :ref:`OEImageBase <OEDepict_OEImageBase>`:

   ========================================================================= ========================================================================== =========================================================================
   :oe:meth:`Clear<OEDepict::OEImageBase::Clear>`                            :oe:meth:`DrawPie<OEDepict::OEImageBase::DrawPie>`                         :oe:meth:`DrawTriangle<OEDepict::OEImageBase::DrawTriangle>`
   :oe:meth:`DrawArc<OEDepict::OEImageBase::DrawArc>`                        :oe:meth:`DrawPoint<OEDepict::OEImageBase::DrawPoint>`                     :oe:meth:`GetGlobalOffset<OEDepict::OEImageBase::GetGlobalOffset>`
   :oe:meth:`DrawCircle<OEDepict::OEImageBase::DrawCircle>`                  :oe:meth:`DrawPolygon<OEDepict::OEImageBase::DrawPolygon>`                 :oe:meth:`GetHeight<OEDepict::OEImageBase::GetHeight>`
   :oe:meth:`DrawCubicBezier<OEDepict::OEImageBase::DrawCubicBezier>`        :oe:meth:`DrawQuadraticBezier<OEDepict::OEImageBase::DrawQuadraticBezier>` :oe:meth:`GetMinFontSize<OEDepict::OEImageBase::GetMinFontSize>`
   :oe:meth:`DrawLine<OEDepict::OEImageBase::DrawLine>`                      :oe:meth:`DrawRectangle<OEDepict::OEImageBase::DrawRectangle>`             :oe:meth:`GetWidth<OEDepict::OEImageBase::GetWidth>`
   :oe:meth:`DrawPath<OEDepict::OEImageBase::DrawPath>`                      :oe:meth:`DrawText<OEDepict::OEImageBase::DrawText>`                       :oe:meth:`GetSVGClass<OEDepict::OEImageBase::GetSVGClass>`
   :oe:meth:`GetSVGGroup<OEDepict::OEImageBase::GetSVGGroup>`                :oe:meth:`GetSVGGroups<OEDepict::OEImageBase::GetSVGGroups>`               :oe:meth:`NewSVGClass<OEDepict::OEImageBase::NewSVGClass>`
   :oe:meth:`NewSVGGroup<OEDepict::OEImageBase::NewSVGGroup>`                :oe:meth:`PopGroup<OEDepict::OEImageBase::PopGroup>`                       :oe:meth:`PushGroup<OEDepict::OEImageBase::PushGroup>`
   :oe:meth:`SetMinFontSize<OEDepict::OEImageBase::SetMinFontSize>`
   ========================================================================= ========================================================================== =========================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImage(double width, double height,
                    const OESystem::OEColor& bgColor = OESystem::OEWhite)

      .. oe:language:: python

         .. oe:api:: python

            OEImage(width: float, height: float, bgColor: OEColor = OEWhite) -> OEImage

      Default constructor that creates an :ref:`OEImage <OEDepict_OEImage>`
      with the specified width and height.

      *width, height*
        The dimensions of the image, both have to be positive (non-zero)
        numbers.

      *bgColor*
        The color that is used to clear the image  upon construction.
      The default background color is :oe:const:`OEWhite<OESystem::OESystem::OEWhite>`.
        A :file:`.png` image with transparent background can be
        generated by passing the
      :oe:const:`OETransparentColor<OESystem::OESystem::OETransparentColor>`
        as the background color.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImage(const OEImage& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEImage(rhs: OEImage) -> OEImage

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImage(const OEImage& src, double scale)

      .. oe:language:: python

         .. oe:api:: python

            OEImage(rhs: OEImage, scale: float) -> OEImage

      Copy constructor with scaling.

      *scale*
        The scaling factor is used to create a new image from the given one.
        The scaling factor has to be a positive (non-zero) number.

      The following code snippet shows how to half and double the size of an image.

      .. oe:source:: ImageScale.py
         :language: python
         :noindent:
         :frag:     SNIPPET-IMAGE-SCALE

      .. oe:source:: ImageScale.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-IMAGE-SCALE

      .. oe:source:: ImageScale.java
         :language: java
         :noindent:
         :frag:     SNIPPET-IMAGE-SCALE

      .. oe:source:: ImageScale.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-IMAGE-SCALE

      .. _table_OEImage_scale:

      .. list-table:: **Examples of image scaling**
         :widths: 250 250 250
         :header-rows: 1

         * - original image
           - scale = 0.5
           - scale = 2.0
         * - .. image:: ../images/image.*
           - .. image:: ../images/halfimage.*
           - .. image:: ../images/doubleimage.*

   .. ################################################################
      # Clear
      ################################################################

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            Clear(color: OEColor) -> None

      Appends a clear command to the display list of the
      :ref:`OEImage <OEDepict_OEImage>` object.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::Clear` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. ################################################################
      # DrawArc
      ################################################################

   .. oe:method:: DrawArc

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawArc(const OE2DPoint& center, double bgnAngle,
                         double endAngle, double radius, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawArc(center: OE2DPoint, bgnAngle: float, endAngle: float,
                    radius: float, pen: OEPen) -> None

      Appends an arc drawing command to the display list of the
      :ref:`OEImage <OEDepict_OEImage>` object.
      See example in :ref:`Figure: Example of drawing an arc<figure_OEImage_DrawArc>`.

      .. _figure_OEImage_DrawArc:

      .. figure:: depicttk/images/OEImageBase-DrawArc.*
         :align:  center
         :scale:  100

         **Example of drawing an arc**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawArc` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawCircle
      ################################################################

   .. oe:method:: DrawCircle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawCircle(const OE2DPoint& center, double radius,
                            const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawCircle(center: OE2DPoint, radius: float, pen: OEPen) -> None

      Appends a circle drawing command to the display list of the
      :ref:`OEImage <OEDepict_OEImage>` object.
      See example in :ref:`Figure: Example of drawing a circle<figure_OEImage_DrawCircle>`.

      .. _figure_OEImage_DrawCircle:

      .. figure:: depicttk/images/OEImageBase-DrawCircle.*
         :align:  center

         **Example of drawing a circle**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawCircle` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawCubicBezier
      ################################################################

   .. oe:method:: DrawCubicBezier

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawCubicBezier(const OE2DPoint& bgn, const OE2DPoint& c1,
                                 const OE2DPoint& c2, const OE2DPoint& end,
                                 const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawCubicBezier(bgn: OE2DPoint, c1: OE2DPoint, c2: OE2DPoint,
                            end: OE2DPoint, pen: OEPen) -> None

      Appends a cubic |Bezier| curve drawing command to the display
      list of the :ref:`OEImage <OEDepict_OEImage>` object.
      See example in :ref:`Figure: Example of drawing a cubic Bezier curve<figure_OEImage_DrawCubicBezier>`.

      .. _figure_OEImage_DrawCubicBezier:

      .. figure:: depicttk/images/OEImageBase-DrawCubicBezier.*
         :align:  center

         **Example of drawing a cubic Bezier curve**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawCubicBezier` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` classes

   .. ################################################################
      # DrawLine
      ################################################################

   .. oe:method:: DrawLine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawLine(const OE2DPoint& bgn, const OE2DPoint& end,
                          const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawLine(bgn: OE2DPoint, end: OE2DPoint, pen: OEPen) -> None

      Appends a line drawing command to the display list of the
      :ref:`OEImage <OEDepict_OEImage>` object.
      See example in :ref:`Figure: Example of drawing a line<figure_OEImage_DrawLine>`.

      .. _figure_OEImage_DrawLine:

      .. figure:: depicttk/images/OEImageBase-DrawLine.*
         :align:  center

         **Example of drawing a line**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawLine` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawPath
      ################################################################

   .. oe:method:: DrawPath

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawPath(const OE2DPath& path, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawPath(path: OE2DPath, pen: OEPen) -> None

      Appends a path drawing command to the display list of the
      :ref:`OEImage <OEDepict_OEImage>` object.
      See example in :ref:`Figure: Example of drawing a path<figure_OEImage_DrawPath>`.

      .. _figure_OEImage_DrawPath:

      .. figure:: depicttk/images/OEImageBase-DrawPath.*
         :align:  center
         :scale:  100

         **Example of drawing a path**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawPath` method
         * :ref:`OE2DPath <OEDepict_OE2DPath>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawPie
      ################################################################

   .. oe:method:: DrawPie

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawPie(const OE2DPoint& center, double bgnAngle,
                         double endAngle, double radius, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawPie(center: OE2DPoint, bgnAngle: float, endAngle: float,
                    radius: float, pen: OEPen) -> None

      Appends a pie drawing command to the display list of the
      :ref:`OEImage <OEDepict_OEImage>` object.
      See example in :ref:`Figure: Example of drawing a pie<figure_OEImage_DrawPie>`.

      .. _figure_OEImage_DrawPie:

      .. figure:: depicttk/images/OEImageBase-DrawPie.*
         :align:  center
         :scale:  100

         **Example of drawing a pie**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawPie` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawPoint
      ################################################################

   .. oe:method:: DrawPoint

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawPoint(const OE2DPoint& p, const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            DrawPoint(p: OE2DPoint, color: OEColor) -> None

      Appends a point drawing command to the display list of the
      :ref:`OEImage <OEDepict_OEImage>` object.
      See example in :ref:`Figure: Example of drawing a point<figure_OEImage_DrawPoint>`.

      .. _figure_OEImage_DrawPoint:

      .. figure:: depicttk/images/OEImageBase-DrawPoint.*
         :align:  center

         **Example of drawing a point**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawPoint` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEColor <OESystem_OEColor>` class

   .. ################################################################
      # DrawPolygon
      ################################################################

   .. oe:method:: DrawPolygon

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawPolygon(const std::vector<OE2DPoint>& points,
                             const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawPolygon(points: OE2DPointVector, pen: OEPen) -> None

      Appends a polygon drawing command to the display list of the
      :ref:`OEImage <OEDepict_OEImage>` object.
      See example in :ref:`Figure: Example of drawing a polygon<figure_OEImage_DrawPolygon>`.

      .. _figure_OEImage_DrawPolygon:

      .. figure:: depicttk/images/OEImageBase-DrawPolygon.*
         :align:  center

         **Example of drawing a polygon**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawPolygon` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawQuadraticBezier
      ################################################################

   .. oe:method:: DrawQuadraticBezier

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawQuadraticBezier(const OE2DPoint& bgn, const OE2DPoint& c,
                                     const OE2DPoint& end, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawQuadraticBezier(bgn: OE2DPoint, c1: OE2DPoint, end: OE2DPoint,
                                pen: OEPen) -> None

      Appends a quadratic |Bezier| curve drawing command to the display
      list of the :ref:`OEImage <OEDepict_OEImage>` object.
      See example in :ref:`Figure: Example of drawing a quadratic Bezier curve<figure_OEImage_DrawQuadraticBezier>`.

      .. _figure_OEImage_DrawQuadraticBezier:

      .. figure:: depicttk/images/OEImageBase-DrawQuadraticBezier.*
         :align:  center

         **Example of drawing a quadratic Bezier curve**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawQuadraticBezier` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` classes

   .. ################################################################
      # DrawRectangle
      ################################################################

   .. oe:method:: DrawRectangle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawRectangle(const OE2DPoint& tl, const OE2DPoint& br,
                               const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawRectangle(tl: OE2DPoint, br: OE2DPoint, pen: OEPen) -> None

      Appends a polygon drawing command to the display list of the
      :ref:`OEImage <OEDepict_OEImage>` object.
      See example in :ref:`Figure: Example of drawing a rectangle<figure_OEImage_DrawRectangle>`.

      .. _figure_OEImage_DrawRectangle:

      .. figure:: depicttk/images/OEImageBase-DrawRectangle.*
         :align:  center

         **Example of drawing a rectangle**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawRectangle` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawText
      ################################################################

   .. oe:method:: DrawText

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawText(const OE2DPoint& c, const std::string& text,
                          const OEFont& font, double maxwidth = 0.0)

      .. oe:language:: python

         .. oe:api:: python

            DrawText(c: OE2DPoint, text: str, font: OEFont,
                     maxwidth: float = 0.0) -> None

      Appends a text drawing command to the display list of the
      :ref:`OEImage <OEDepict_OEImage>` object.
      See example in :ref:`Figure: Example of drawing a text<figure_OEImage_DrawText>`.

      .. _figure_OEImage_DrawText:

      .. figure:: depicttk/images/OEImageBase-DrawText.*
         :align:  center

         **Example of drawing a text**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawText` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. ################################################################
      # DrawTriangle
      ################################################################

   .. oe:method:: DrawTriangle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawTriangle(const OE2DPoint& a, const OE2DPoint& b,
                              const OE2DPoint& c, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawTriangle(pA: OE2DPoint, pB: OE2DPoint, pC: OE2DPoint,
                         pen: OEPen) -> None

      Appends a triangle drawing command to the display list of the
      :ref:`OEImage <OEDepict_OEImage>` object.
      See example in :ref:`Figure: Example of drawing a triangle<figure_OEImage_DrawTriangle>`.

      .. _figure_OEImage_DrawTriangle:

      .. figure:: depicttk/images/OEImageBase-DrawTriangle.*
         :align:  center

         **Example of drawing a triangle**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawTriangle` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # GetHeight
      ################################################################

   .. oe:method:: GetHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeight() -> float

      Returns the height of the :ref:`OEImage <OEDepict_OEImage>` object.

   .. ################################################################
      # GetWidth
      ################################################################

   .. oe:method:: GetWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetWidth() -> float

      Returns the width of the :ref:`OEImage <OEDepict_OEImage>` object.

   .. ################################################################
      # IsEmpty
      ################################################################

   .. oe:method:: IsEmpty

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsEmpty() const

      .. oe:language:: python

         .. oe:api:: python

            IsEmpty() -> bool

      Returns whether or not the display list of the
      :ref:`OEImage <OEDepict_OEImage>` object is empty.

   .. ################################################################
      # Render
      ################################################################

   .. oe:method:: Render

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Render(OEImageBase& image) const

      .. oe:language:: python

         .. oe:api:: python

            Render(image: OEImageBase) -> bool

      Renders the image stored in the :ref:`OEImage <OEDepict_OEImage>`
      object by executing the stored drawing commands in the order in
      which they were issued.

   .. ################################################################
      # RenderLayer
      ################################################################

   .. oe:method: RenderLayer DO NOT DOCUMENT USED ONLY INTERNALLY

      .. oe:api::

         bool RenderLayer(OEImageBase& image) const
         bool RenderLayer(OEImageBase& image, const OE2DPoint&) const

      Used to transfer push / pop instructions from one image to another.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEImageBase, ImageBase

.. _OEDepict_OEImageBase:

.. oe:class:: OEImageBase

   .. oe:api::

      class OEImageBase

   The :ref:`OEImageBase <OEDepict_OEImageBase>` is an abstract class that
   provides methods for drawing basic geometric shapes such as lines,
   circles, rectangles etc.

   The following classes derive from this class:

    * :ref:`OEImage <OEDepict_OEImage>`
    * :ref:`OEImageFrame <OEDepict_OEImageFrame>`

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageBase(double width = 200.0, double height = 200.0)

      .. oe:language:: python

         .. oe:api:: python

            OEImageBase(width: float = 200.0, height: float = 200.0) -> OEImageBase

      Default constructor that creates an image with the specified
      width and height.

      *width, height*
        The dimensions of the image, both have to be positive (non-zero)
        numbers.

   .. ################################################################
      # Clear
      ################################################################

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear(const OESystem::OEColor& color = OESystem::OEWhite)

      .. oe:language:: python

         .. oe:api:: python

            Clear(color: OEColor = OEWhite) -> None

      Clears the image with the given color.

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class

   .. ################################################################
      # DrawArc
      ################################################################

   .. oe:method:: DrawArc

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawArc(const OE2DPoint& center, double bgnAngle,
                         double endAngle, double radius, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawArc(c: OE2DPoint, bgnAngle: float, endAngle: float,
                    radius: float, pen: OEPen) -> None

      Draws the outline of an arc.
      See example in :ref:`Figure: Example of arc<figure_OEImageBase_DrawArc>`.

      .. _figure_OEImageBase_DrawArc:

      .. figure:: depicttk/images/OEImageBase-DrawArc.*
         :align:  center
         :scale:  100

         **Example of arc**

      *center*
         The center of the arc.

      *bgnAngle*, *endAngle*
         The two endpoints of the arc (in degrees).
         Both angles are in degrees and their values have to be in a
         range of :math:`[0.0^{\circ}, 360.0^{\circ}]`.
         Angles are interpreted such that :math:`0.0^{\circ}` and
         :math:`360.0^{\circ}` degrees are at the *12 o'clock*
         position, :math:`90.0^{\circ}` degrees corresponds
         to *3 o'clock*, etc.

      *radius*
         The radius of the arc.

      *pen*
         The graphical properties of the curve (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing arcs with various pens<figure_OEImageBase_DrawArc_Pen>`.

      .. _figure_OEImageBase_DrawArc_Pen:

      .. figure:: depicttk/images/OEImageBase-DrawArc-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing arcs with various pens**

      .. note::

         :oe:meth:`OEDepict::OEImageBase::DrawArc` supports all the
         :ref:`OEPen <OEDepict_OEPen>`  properties (i.e. color, line width, line
         stipple) except the fill property.
         See also :oe:meth:`OEDepict::OEImageBase::DrawPie` method.

      Arcs are always drawn in a clockwise direction. This means that
      bgn = :math:`0.0^{\circ}`, end = :math:`90.0^{\circ}` angle pair
      is not the same as bgn = :math:`90.0^{\circ}`, end =
      :math:`0.0^{\circ}` angle pair.
      See examples in :ref:`Table: Example of interpreting the begin and end angles of the arc<table_OEImageBase_DrawArc>`.

      .. _table_OEImageBase_DrawArc:

      .. list-table:: **Example of interpreting the begin and end angles of the arc**
         :widths: 10 10
         :header-rows: 1

         * - bgn = :math:`0.0^{\circ}` end = :math:`90.0^{\circ}`
           - bgn = :math:`90.0^{\circ}` end = :math:`0.0^{\circ}`
         * - .. image:: ../images/OEImageBase-DrawArc-AngleAB.*
               :align:  center
               :scale:  100
           - .. image:: ../images/OEImageBase-DrawArc-AngleBA.*
               :align:  center
               :scale:  100

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawCircle
      ################################################################

   .. oe:method:: DrawCircle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawCircle(const OE2DPoint& center, double radius,
                            const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawCircle(c: OE2DPoint, radius: float, pen: OEPen) -> None

      Draws a circle.
      See example in :ref:`Figure: Example of circle<figure_OEImageBase_DrawCircle>`.

      .. _figure_OEImageBase_DrawCircle:

      .. figure:: depicttk/images/OEImageBase-DrawCircle.*
         :align:  center

         **Example of circle**

      *center*
         The center of the circle.

      *radius*
         The radius of the circle.

      *pen*
         The graphical properties of the circle (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing circles with various pens<figure_OEImageBase_DrawCircle_Pen>`.

      .. _figure_OEImageBase_DrawCircle_Pen:

      .. figure:: depicttk/images/OEImageBase-DrawCircle-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing circles with various pens**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawCubicBezier
      ################################################################

   .. oe:method:: DrawCubicBezier

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawCubicBezier(const OE2DPoint& bgn, const OE2DPoint& c1,
                                 const OE2DPoint& c2, const OE2DPoint& end,
                                 const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawCubicBezier(bgn: OE2DPoint, c1: OE2DPoint, c2: OE2DPoint,
                            end: OE2DPoint, pen: OEPen) -> None

      Draws a cubic |Bezier| curve.
      See example in :ref:`Figure: Example of cubic Bezier curve<figure_OEImageBase_DrawCubicBezier>`.

      .. _figure_OEImageBase_DrawCubicBezier:

      .. figure:: depicttk/images/OEImageBase-DrawCubicBezier.*
         :align:  center

         **Example of cubic Bezier curve**

      *bgn, end*
         The end points of the Bezier curve.

      *c1, c2*
         The control points of the curve.

      *pen*
         The graphical properties of the |Bezier| curve (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing cubic Bezier curves with various pens<figure_OEImageBase_DrawCubicBezier_Pen>`.

      .. _figure_OEImageBase_DrawCubicBezier_Pen:

      .. figure:: depicttk/images/OEImageBase-DrawCubicBezier-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing cubic Bezier curves with various pens**

      Example (:ref:`Figure: Example of drawing a cubic Bezier curve<figure_OEImageBase_DrawCubicBezie_Example>`)

      .. oe:source:: DrawObjects.py
         :language: python
         :noindent:
         :frag:     SNIPPET-CUBIC-BEZIER

      .. oe:source:: DrawObjects.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-CUBIC-BEZIER

      .. oe:source:: DrawObjects.java
         :language: java
         :noindent:
         :frag:     SNIPPET-CUBIC-BEZIER

      .. oe:source:: DrawObjects.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-CUBIC-BEZIER

      .. _figure_OEImageBase_DrawCubicBezie_Example:

      .. figure:: depicttk/images/DrawCubicBezier.*
         :align:  center

         **Example of drawing a cubic Bezier curve**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` classes

   .. ################################################################
      # DrawLine
      ################################################################

   .. oe:method:: DrawLine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawLine(const OE2DPoint& bgn, const OE2DPoint& end,
                          const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawLine(bgn: OE2DPoint, end: OE2DPoint, pen: OEPen) -> None

      Draws a line.
      See example in :ref:`Figure: Example of line<figure_OEImageBase_DrawLine>`.

      .. _figure_OEImageBase_DrawLine:

      .. figure:: depicttk/images/OEImageBase-DrawLine.*
         :align:  center

         **Example of line**

      *bgn*, *end*
         The two endpoints of the line.

      *pen*
         The graphical properties of the line (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing lines with various pens<figure_OEImageBase_DrawLine_Pen>`.

      .. _figure_OEImageBase_DrawLine_Pen:

      .. figure:: depicttk/images/OEImageBase-DrawLine-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing lines with various pens**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawPath
      ################################################################

   .. oe:method:: DrawPath

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawPath(const OE2DPath& path, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawPath(path: OE2DPath, pen: OEPen) -> None

      Draws as path.
      See example in :ref:`Figure: Example of path<figure_OEImageBase_DrawPath>`.

      .. _figure_OEImageBase_DrawPath:

      .. figure:: depicttk/images/OEImageBase-DrawPath.*
         :align:  center
         :scale:  100

         **Example of path**

      *path*
         The :ref:`OE2DPath <OEDepict_OE2DPath>` object that defines a path as
         a sequence of lines and curves.

      *pen*
         The graphical properties of the pie (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing paths with various pens<figure_OEImageBase_DrawPath_Pen>`.

      .. _figure_OEImageBase_DrawPath_Pen:

      .. figure:: depicttk/images/OEImageBase-DrawPath-Closed-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing paths with various pens**

      Example (:ref:`Figure: Example of drawing a path<figure_OEImageBase_DrawPath_Example>`)

      .. oe:source:: DrawObjects.py
         :language: python
         :noindent:
         :frag:     SNIPPET-DRAW-PATH

      .. oe:source:: DrawObjects.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-DRAW-PATH

      .. oe:source:: DrawObjects.java
         :language: java
         :noindent:
         :frag:     SNIPPET-DRAW-PATH

      .. oe:source:: DrawObjects.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-DRAW-PATH

      .. _figure_OEImageBase_DrawPath_Example:

      .. figure:: depicttk/images/DrawPath.*
         :align:  center

         **Example of drawing a path**

      .. seealso::

         * :ref:`OE2DPath <OEDepict_OE2DPath>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawPie
      ################################################################

   .. oe:method:: DrawPie

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawPie(const OE2DPoint& center, double bgnAngle,
                         double endAngle, double radius, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawPie(c: OE2DPoint, bgnAngle: float, endAngle: float,
                    radius: float, pen: OEPen) -> None

      Draws a pie.
      See example in :ref:`Figure: Example of drawing a pie<figure_OEImageBase_DrawPie>`.

      .. _figure_OEImageBase_DrawPie:

      .. figure:: depicttk/images/OEImageBase-DrawPie.*
         :align:  center
         :scale:  100

      *center*
         The center of the pie.

      *bgnAngle*, *endAngle*
         The two endpoints of the pie (in degrees).
         Both angles are in degrees and their values have to be in a
         range of :math:`[0.0^{\circ}, 360.0^{\circ}]`.
         Angles are interpreted such that :math:`0.0^{\circ}` and
         :math:`360.0^{\circ}` degrees are at the *12 o'clock*
         position, :math:`90.0^{\circ}` degrees corresponds
         to *3 o'clock*, etc.

      *radius*
         The radius of the pie.

      *pen*
         The graphical properties of the pie (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing pies with various pens<figure_OEImageBase_DrawPie_Pen>`.

      .. _figure_OEImageBase_DrawPie_Pen:

      .. figure:: depicttk/images/OEImageBase-DrawPie-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing pies with various pens**

      Pies are always drawn in a clockwise direction. This means that
      bgn = :math:`0.0^{\circ}`, end = :math:`90.0^{\circ}` angle pair
      is not the same as bgn = :math:`90.0^{\circ}`, end =
      :math:`0.0^{\circ}` angle pair.
      See examples in :ref:`Table: Example of interpreting the begin and end angles of the pie<table_OEImageBase_DrawPie>`.

      .. _table_OEImageBase_DrawPie:

      .. list-table:: **Example of interpreting the begin and end angles of the pie**
         :widths: 10 10
         :header-rows: 1

         * - bgn = :math:`0.0^{\circ}` end = :math:`90.0^{\circ}`
           - bgn = :math:`90.0^{\circ}` end = :math:`0.0^{\circ}`
         * - .. image:: ../images/OEImageBase-DrawPie-AngleAB.*
               :align:  center
               :scale:  100
           - .. image:: ../images/OEImageBase-DrawPie-AngleBA.*
               :align:  center
               :scale:  100

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawPoint
      ################################################################

   .. oe:method:: DrawPoint

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawPoint(const OE2DPoint& p, const OESystem::OEColor& color) = 0

      .. oe:language:: python

         .. oe:api:: python

            DrawPoint(p: OE2DPoint, color: OEColor) -> None

      Draws a point.
      See example in :ref:`Figure: Example of point<figure_OEImageBase_DrawPoint>`.

      .. _figure_OEImageBase_DrawPoint:

      .. figure:: depicttk/images/OEImageBase-DrawPoint.*
         :align:  center

         **Example of point**

      *p*
         The position of the point, where p = OE2DPoint(x, y).

      *color*
         The color of the point.

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class

   .. ################################################################
      # DrawPolygon
      ################################################################

   .. oe:method:: DrawPolygon

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawPolygon(const std::vector<OE2DPoint>& points,
                             const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawPolygon(endPoints: OE2DPointVector, pen: OEPen) -> None

      Draws a closed polygon.
      See example in :ref:`Figure: Example of polygon<figure_OEImageBase_DrawPolygon>`.

      .. _figure_OEImageBase_DrawPolygon:

      .. figure:: depicttk/images/OEImageBase-DrawPolygon.*
         :align:  center

         **Example of polygon**

      *points*
         The series of points that defines the polygon.
         The polygon will be closed *i.e.* the first connected with
         the last point.

      *pen*
         The graphical properties of the polygon (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of polygons lines with various pens<figure_OEImageBase_DrawPolygon_Pen>`.

      .. _figure_OEImageBase_DrawPolygon_Pen:

      .. figure:: depicttk/images/OEImageBase-DrawPolygon-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing polygons with various pens**

      Example (:ref:`Figure: Example of drawing a polygon<figure_OEImageBase_DrawPolygon_Example>`)

      .. oe:source:: DrawObjects.py
         :language: python
         :noindent:
         :frag:     SNIPPET-DRAW-POLYGON

      .. oe:source:: DrawObjects.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-DRAW-POLYGON

      .. oe:source:: DrawObjects.java
         :language: java
         :noindent:
         :frag:     SNIPPET-DRAW-POLYGON

      .. oe:source:: DrawObjects.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-DRAW-POLYGON

      .. _figure_OEImageBase_DrawPolygon_Example:

      .. figure:: depicttk/images/DrawPolygon.*
         :align:  center

         **Example of drawing a polygon**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawQuadraticBezier
      ################################################################

   .. oe:method:: DrawQuadraticBezier

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawQuadraticBezier(const OE2DPoint& bgn, const OE2DPoint& c,
                                     const OE2DPoint& end, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawQuadraticBezier(bgn: OE2DPoint, c1: OE2DPoint, end: OE2DPoint,
                                pen: OEPen) -> None

      Draws a quadratic |Bezier| curve.
      See example in :ref:`Figure: Example of quadratic Bezier curve<figure_OEImageBase_DrawQuadraticBezier>`.

      .. _figure_OEImageBase_DrawQuadraticBezier:

      .. figure:: depicttk/images/OEImageBase-DrawQuadraticBezier.*
         :align:  center

         **Example of quadratic Bezier curve**

      *bgn, end*
         The end points of the |Bezier| curve.

      *c*
         The control point of the curve.

      *pen*
         The graphical properties of the |Bezier| curve (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing quadratic Bezier curves with various pens<figure_OEImageBase_DrawQuadraticBezier_Pen>`.

      .. _figure_OEImageBase_DrawQuadraticBezier_Pen:

      .. figure:: depicttk/images/OEImageBase-DrawQuadraticBezier-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing quadratic Bezier curves with various pens**

      Example (:ref:`Figure: Example of drawing a polygon<figure_OEImageBase_DrawQuadraticBezier_Example>`)

      .. oe:source:: DrawObjects.py
         :language: python
         :noindent:
         :frag:     SNIPPET-DRAW-QUADRATIC-BEZIER

      .. oe:source:: DrawObjects.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-DRAW-QUADRATIC-BEZIER

      .. oe:source:: DrawObjects.java
         :language: java
         :noindent:
         :frag:     SNIPPET-DRAW-QUADRATIC-BEZIER

      .. oe:source:: DrawObjects.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-DRAW-QUADRATIC-BEZIER

      .. _figure_OEImageBase_DrawQuadraticBezier_Example:

      .. figure:: depicttk/images/DrawQuadraticBezier.*
         :align:  center

         **Example of drawing a quadratic Bezier**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` classes

   .. ################################################################
      # DrawRectangle
      ################################################################

   .. oe:method:: DrawRectangle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawRectangle(const OE2DPoint& tl, const OE2DPoint& br,
                               const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawRectangle(tl: OE2DPoint, br: OE2DPoint, pen: OEPen) -> None

      Draws a rectangle.
      See example in :ref:`Figure: Example of rectangle<figure_OEImageBase_DrawRectangle>`.

      .. _figure_OEImageBase_DrawRectangle:

      .. figure:: depicttk/images/OEImageBase-DrawRectangle.*
         :align:  center

         **Example of rectangle**

      *tl*
        The top left corner of the rectangle.

      *br*
        The bottom right corner of the rectangle.

      *pen*
         The graphical properties of the rectangle (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of polygons rectangles with various pens<figure_OEImageBase_DrawRectangle_Pen>`.

      .. _figure_OEImageBase_DrawRectangle_Pen:

      .. figure:: depicttk/images/OEImageBase-DrawRectangle-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing rectangles with various pens**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawText
      ################################################################

   .. oe:method:: DrawText

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawText(const OE2DPoint& center, const std::string& text,
                          const OEFont& font, double maxwidth = 0.0)

      .. oe:language:: python

         .. oe:api:: python

            DrawText(c: OE2DPoint, text: str, font: OEFont,
                     maxwidth: float = 0.0) -> None

      Draws a text.
      See example in :ref:`Figure: Example of text<figure_OEImageBase_DrawText>`.

      .. _figure_OEImageBase_DrawText:

      .. figure:: depicttk/images/OEImageBase-DrawText.*
         :align:  center

         **Example of text**

      *center*
         The position of the text.

      *text*
         The characters to be displayed.

      *font*
         The graphical properties of the displayed text (such as color,
         font size, etc).
         See examples in :ref:`Figure: Example of drawing texts with various fonts<figure_OEImageBase_DrawText_Font>`.

      *maxwidth*
         If *maxwidth* is specified and the width of the text would exceed
         the given limit, than the size of the font used to display
         the text is automatically reduced.

      .. note::

         The displayed position of the text not only depends on 'c'
         position but also the alignment style of the given
         :ref:`OEFont <OEDepict_OEFont>`.

      .. _figure_OEImageBase_DrawText_Font:

      .. figure:: depicttk/images/OEImageBase-DrawText-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing texts with various fonts**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :oe:constns:`OEDepict::OEAlignment` namespace
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. ################################################################
      # DrawTriangle
      ################################################################

   .. oe:method:: DrawTriangle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawTriangle(const OE2DPoint& a, const OE2DPoint& b,
                              const OE2DPoint& c, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawTriangle(arg0: OE2DPoint, arg1: OE2DPoint, arg2: OE2DPoint,
                         arg3: OEPen) -> None

      Draws a triangle.
      See example in :ref:`Figure: Example of triangle<figure_OEImageBase_DrawTriangle>`.

      .. _figure_OEImageBase_DrawTriangle:

      .. figure:: depicttk/images/OEImageBase-DrawTriangle.*
         :align:  center

         **Example of triangle**

      *a*, *b*, *c*
        The three corners of the triangle.

      *pen*
         The graphical properties of the triangle (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of polygons triangles with various pens<figure_OEImageBase_DrawTriangle_Pen>`.

      .. _figure_OEImageBase_DrawTriangle_Pen:

      .. figure:: depicttk/images/OEImageBase-DrawTriangle-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing triangles with various fonts**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # GetGlobalOffset
      ################################################################

   .. oe:method:: GetGlobalOffset

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OE2DPoint& GetGlobalOffset() const

      .. oe:language:: python

         .. oe:api:: python

            GetGlobalOffset() -> OE2DPoint

      Returns the offset from the origin (x=0.0, y=0.0) to the
      top-left corner of the given image.

   .. ################################################################
      # GetHeight
      ################################################################

   .. oe:method:: GetHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeight() -> float

      Returns the height of the :ref:`OEImageBase <OEDepict_OEImageBase>` object.

   .. ################################################################
      # GetMinFontSize
      ################################################################

   .. oe:method:: GetMinFontSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMinFontSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinFontSize() -> int

      Returns the minimum size of the font that can be displayed.

   .. ################################################################
      # GetWidth
      ################################################################

   .. oe:method:: GetWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetWidth() -> float

      Returns the width of the :ref:`OEImageBase <OEDepict_OEImageBase>` object.

   .. ################################################################
      # SetMinFontSize
      ################################################################

   .. oe:method:: SetMinFontSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMinFontSize(unsigned int fontsize)

      .. oe:language:: python

         .. oe:api:: python

            SetMinFontSize(fontsize: int) -> None

      Sets the minimum size of the font that can be displayed.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetSVGClass

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESVGClass* GetSVGClass(const std::string& name)
            const OESVGClass* GetSVGClass(const std::string& name) const

      .. oe:language:: python

         .. oe:api:: python

            GetSVGClass(name: str) -> OESVGClass

      Returns the :ref:`OESVGClass <OEDepict_OESVGClass>` object with the given
      name. Null pointer will be returned if no class exists on the
      image with the given name.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGClass <OEDepict_OESVGClass>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetSVGGroup

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESVGGroup* GetSVGGroup(const std::string& id)
            const OESVGGroup* GetSVGGroup(const std::string& id) const

      .. oe:language:: python

         .. oe:api:: python

            GetSVGGroup(id: str) -> OESVGGroup

      Returns the :ref:`OESVGGroup <OEDepict_OESVGGroup>` object with the given
      name. Null pointer will be returned if no group exists on the
      image with the given name.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetSVGGroups

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESVGGroup>* GetSVGGroups()

      .. oe:language:: python

         .. oe:api:: python

            GetSVGGroups() -> Iterable[OESVGGroup]

      Returns an iterator over the SVG groups (:ref:`OESVGGroup <OEDepict_OESVGGroup>`)
      of the image.

      **Example:**

      .. oe:source:: CreateSVGGroup.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GETSVGGROUPS

      .. oe:source:: CreateSVGGroup.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GETSVGGROUPS

      .. oe:source:: CreateSVGGroup.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GETSVGGROUPS

      .. oe:source:: CreateSVGGroup.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GETSVGGROUPS

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NewSVGClass

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESVGClass* NewSVGClass(const std::string& name)

      .. oe:language:: python

         .. oe:api:: python

            NewSVGClass(name: str) -> OESVGClass

      Creates a new :ref:`OESVGClass <OEDepict_OESVGClass>` on the given image.
      A null pointer will be returned and warning message will be thrown
      if the SVG class can not be created.

      *name*
         The name of the :ref:`OESVGClass <OEDepict_OESVGClass>` object.
         For information about valid group names see the documentation
         of the :oe:func:`OEDepict::OEIsValidSVGClassName` function.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGClass <OEDepict_OESVGClass>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NewSVGGroup

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESVGGroup* NewSVGGroup(const std::string& id)

      .. oe:language:: python

         .. oe:api:: python

            NewSVGGroup(id: str) -> OESVGGroup

      Creates a new :ref:`OESVGGroup <OEDepict_OESVGGroup>` on the given image.
      A null pointer will be returned and warning message will be thrown
      if the SVG group can not be created.

      *name*
         The name of the :ref:`OESVGGroup <OEDepict_OESVGGroup>` object.
         For information about valid group names see the documentation
         of the :oe:func:`OEDepict::OEIsValidSVGGroupId` function.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: PopGroup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool PopGroup(const OESVGGroup *)

      .. oe:language:: python

         .. oe:api:: python

            PopGroup(arg0: OESVGGroup) -> bool

      Pops the :ref:`OESVGGroup <OEDepict_OESVGGroup>` object.

      .. note::

         An :ref:`OESVGGroup <OEDepict_OESVGGroup>` object can be used (pushed / popped) only once.
         :ref:`OESVGGroup <OEDepict_OESVGGroup>` objects can be nested.
         They should be used in LIFO (for last in, first out)
         i.e. the group that has been pushed last should be popped first.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class
         * :oe:meth:`OEDepict::OEImageBase::PushGroup` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: PushGroup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool PushGroup(const OESVGGroup *)

      .. oe:language:: python

         .. oe:api:: python

            PushGroup(arg0: OESVGGroup) -> bool

      Pushes the :ref:`OESVGGroup <OEDepict_OESVGGroup>` object.

      .. note::

         An :ref:`OESVGGroup <OEDepict_OESVGGroup>` object can be used (pushed / popped) only once.
         :ref:`OESVGGroup <OEDepict_OESVGGroup>` objects can be nested.
         They should be used in LIFO (for last in, first out)
         i.e. the group that has been pushed last should be popped first.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class
         * :oe:meth:`OEDepict::OEImageBase::PopGroup` method


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEImageFileBase, ImageFileBase

.. _OEDepict_OEImageFileBase:

.. oe:class:: OEImageFileBase

   .. oe:api::

      class OEImageFileBase : public OEImageBase

   The :ref:`OEImageFileBase <OEDepict_OEImageFileBase>` is an abstract class
   that is used to write concrete image files.

   The following methods are publicly inherited from :ref:`OEImageBase <OEDepict_OEImageBase>`:

   ========================================================================= ========================================================================== =========================================================================
   :oe:meth:`Clear<OEDepict::OEImageBase::Clear>`                            :oe:meth:`DrawPoint<OEDepict::OEImageBase::DrawPoint>`                     :oe:meth:`GetHeight<OEDepict::OEImageBase::GetHeight>`
   :oe:meth:`DrawArc<OEDepict::OEImageBase::DrawArc>`                        :oe:meth:`DrawPolygon<OEDepict::OEImageBase::DrawPolygon>`                 :oe:meth:`GetMinFontSize<OEDepict::OEImageBase::GetMinFontSize>`
   :oe:meth:`DrawCircle<OEDepict::OEImageBase::DrawCircle>`                  :oe:meth:`DrawQuadraticBezier<OEDepict::OEImageBase::DrawQuadraticBezier>` :oe:meth:`GetWidth<OEDepict::OEImageBase::GetWidth>`
   :oe:meth:`DrawCubicBezier<OEDepict::OEImageBase::DrawCubicBezier>`        :oe:meth:`DrawRectangle<OEDepict::OEImageBase::DrawRectangle>`             :oe:meth:`SetMinFontSize<OEDepict::OEImageBase::SetMinFontSize>`
   :oe:meth:`DrawLine<OEDepict::OEImageBase::DrawLine>`                      :oe:meth:`DrawText<OEDepict::OEImageBase::DrawText>`
   :oe:meth:`DrawPie<OEDepict::OEImageBase::DrawPie>`                        :oe:meth:`DrawTriangle<OEDepict::OEImageBase::DrawTriangle>`
   ========================================================================= ========================================================================== =========================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:api::

         OEImageFileBase(double width, double height)

      Default constructors that creates an image file with the
      given dimensions.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetExtension

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetExtension() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetExtension() -> str

      Returns the file extension associated with the concrete image
      file type.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: IsVisible

      .. oe:language:: c++ java csharp

         .. oe:api::

            virtual bool IsVisible() const

      .. oe:language:: python

         .. oe:api:: python

            IsVisible() -> bool

      Returns whether the top active SVG group is visible i.e.
      returns :oe:meth:`OEDepict::OESVGGroup::IsVisible`.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: PopGroup

      .. oe:language:: c++ java csharp

         .. oe:api::

            virtual bool PopGroup (const OESVGGroup*)

      .. oe:language:: python

         .. oe:api:: python

            PopGroup(arg2: OESVGGroup) -> bool

      Pops the :ref:`OESVGGroup <OEDepict_OESVGGroup>` object.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class
         * :oe:meth:`OEDepict::OEImageFileBase::PushGroup` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: PushGroup

      .. oe:language:: c++ java csharp

         .. oe:api::

            virtual bool PushGroup(const OESVGGroup*)

      .. oe:language:: python

         .. oe:api:: python

            PushGroup(arg2: OESVGGroup) -> bool

      Pushes the :ref:`OESVGGroup <OEDepict_OESVGGroup>` object.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class
         * :oe:meth:`OEDepict::OEImageFileBase::PopGroup` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Write

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Write(OEPlatform::oeostream& os)=0

      .. oe:language:: python

         .. oe:api:: python

            Write(os: oeostream) -> bool

      The :oe:meth:`OEDepict::OEImageFileBase::Write` is
      a virtual method that has to be implemented in the concrete
      derived classes and it writes the image into the given output
      stream.



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEImageFileCreatorBase, ImageFileCreatorBase

.. _OEDepict_OEImageFileCreatorBase:

.. oe:class:: OEImageFileCreatorBase

   .. oe:api::

      class OEImageFileCreatorBase

   The :ref:`OEImageFileCreatorBase <OEDepict_OEImageFileCreatorBase>` is an abstract class
   that is used to register concrete image types.

   .. seealso::

      * :oe:func:`OEDepict::OERegisterImageFile` function

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:api::

         OEImageFileCreatorBase(const std::string& ext, bool multi = false)

      Default constructor.

      *ext*
        The file extension that will be used to identify the concrete
        image type.
        For example, the Portable Document Format (:file:`PDF`) is registered
        with the "pdf" file extension.

      *multi*
        Determines whether the specific image type can be used to
        create multi-page images.

   .. ################################################################
      # CreateCopy
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageFileCreatorBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEImageFileCreatorBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.

   .. ################################################################
      # CreateImage
      ################################################################

   .. oe:method:: CreateImage

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageFileBase* CreateImage(double width, double height) const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateImage(width: float, height: float) -> OEImageFileBase

      The :oe:meth:`OEDepict::OEImageFileCreatorBase::CreateImage` is
      a virtual method that has to be implemented in the concrete
      derived classes and it returns a pointer of concrete image 
      with the given dimensions.

      *width*
         The width of the returned image.

      *height*
         The height of the returned image. 

   .. ################################################################
      # GetExtension
      ################################################################

   .. oe:method:: GetExtension

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string GetExtension() const

      .. oe:language:: python

         .. oe:api:: python

            GetExtension() -> str

      Return the file extension of which the concrete image type is
      being registered.
    
   .. ################################################################
      # IsMultiPage
      ################################################################

   .. oe:method:: IsMultiPage

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsMultiPage() const

      .. oe:language:: python

         .. oe:api:: python

            IsMultiPage() -> bool

      Returns whether the image type registered as multi-page image.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEImageFrame, ImageFrame

.. _OEDepict_OEImageFrame:

.. oe:class:: OEImageFrame

   .. oe:api::

      class OEImageFrame : public OEImageBase

   :ref:`OEImageFrame <OEDepict_OEImageFrame>` class provides a convenient way
   to create a *frame* with a specific dimension and offset relative to
   an :ref:`OEImageBase <OEDepict_OEImageBase>` object.
   See :ref:`Figure: Schematic representation of OEImageFrame objects<figure_OEImageFrame>`.

   .. _figure_OEImageFrame:

   .. figure:: depicttk/images/OEImageFrame.*
      :align:  center

      **Schematic representation of OEImageFrame objects**

   .. seealso::

      * :ref:`section_image_layout_frame` section

   The following methods are publicly inherited from :ref:`OEImageBase <OEDepict_OEImageBase>`:

   ========================================================================= ========================================================================== =========================================================================
   :oe:meth:`Clear<OEDepict::OEImageBase::Clear>`                            :oe:meth:`DrawPie<OEDepict::OEImageBase::DrawPie>`                         :oe:meth:`DrawTriangle<OEDepict::OEImageBase::DrawTriangle>`
   :oe:meth:`DrawArc<OEDepict::OEImageBase::DrawArc>`                        :oe:meth:`DrawPoint<OEDepict::OEImageBase::DrawPoint>`                     :oe:meth:`GetGlobalOffset<OEDepict::OEImageBase::GetGlobalOffset>`
   :oe:meth:`DrawCircle<OEDepict::OEImageBase::DrawCircle>`                  :oe:meth:`DrawPolygon<OEDepict::OEImageBase::DrawPolygon>`                 :oe:meth:`GetHeight<OEDepict::OEImageBase::GetHeight>`
   :oe:meth:`DrawCubicBezier<OEDepict::OEImageBase::DrawCubicBezier>`        :oe:meth:`DrawQuadraticBezier<OEDepict::OEImageBase::DrawQuadraticBezier>` :oe:meth:`GetMinFontSize<OEDepict::OEImageBase::GetMinFontSize>`
   :oe:meth:`DrawLine<OEDepict::OEImageBase::DrawLine>`                      :oe:meth:`DrawRectangle<OEDepict::OEImageBase::DrawRectangle>`             :oe:meth:`GetWidth<OEDepict::OEImageBase::GetWidth>`
   :oe:meth:`DrawPath<OEDepict::OEImageBase::DrawPath>`                      :oe:meth:`DrawText<OEDepict::OEImageBase::DrawText>`                       :oe:meth:`GetSVGClass<OEDepict::OEImageBase::GetSVGClass>`
   :oe:meth:`GetSVGGroup<OEDepict::OEImageBase::GetSVGGroup>`                :oe:meth:`GetSVGGroups<OEDepict::OEImageBase::GetSVGGroups>`               :oe:meth:`NewSVGClass<OEDepict::OEImageBase::NewSVGClass>`
   :oe:meth:`NewSVGGroup<OEDepict::OEImageBase::NewSVGGroup>`                :oe:meth:`PopGroup<OEDepict::OEImageBase::PopGroup>`                       :oe:meth:`PushGroup<OEDepict::OEImageBase::PushGroup>`
   :oe:meth:`SetMinFontSize<OEDepict::OEImageBase::SetMinFontSize>`
   ========================================================================= ========================================================================== =========================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageFrame(OEImageBase& parent, double width, double height,
                         const OE2DPoint& offset)

      .. oe:language:: python

         .. oe:api:: python

            OEImageFrame(parent: OEImageBase, width: float, height: float,
                         offset: OE2DPoint) -> OEImageFrame

      Creates an :ref:`OEImageFrame <OEDepict_OEImageFrame>` object with the given
      dimension.

      *parent*
        The parent :ref:`OEImageBase <OEDepict_OEImageBase>` object in which the
        :ref:`OEImageFrame <OEDepict_OEImageFrame>` object is placed.

      *width*
        The width of the :ref:`OEImageFrame <OEDepict_OEImageFrame>` object.

      *height*
        The height of the :ref:`OEImageFrame <OEDepict_OEImageFrame>` object.

      *offset*
        The offset of the :ref:`OEImageFrame <OEDepict_OEImageFrame>` object relative
        to top/left corner of its :ref:`OEImageBase <OEDepict_OEImageBase>` parent.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageFrame(OEImageBase& parent, double padding)

      .. oe:language:: python

         .. oe:api:: python

            OEImageFrame(parent: OEImageBase, padding: float) -> OEImageFrame

      Creates an :ref:`OEImageFrame <OEDepict_OEImageFrame>` object equal paddings
      around the given image positioning the image frame to the center
      of the image.

      *parent*
        The parent :ref:`OEImageBase <OEDepict_OEImageBase>` object in which the
        :ref:`OEImageFrame <OEDepict_OEImageFrame>` object is placed.

      *padding*
        The padding that applied in all four sides around the parent
        image. The padding is capped by the :math:`\frac{1}{3}` of
        width and height of the **parent** image.

   .. ################################################################
      # Clear
      ################################################################

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            Clear(arg2: OEColor) -> None

      Clears the image with the given color.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::Clear` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. ################################################################
      # DrawArc
      ################################################################

   .. oe:method:: DrawArc

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawArc(const OE2DPoint& center, double bgnAngle,
                         double endAngle, double radius, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawArc(c: OE2DPoint, bgnAngle: float, endAngle: float, rad: float,
                    pen: OEPen) -> None

      Draws the outline of an arc.
      See example in :ref:`Figure: Example of drawing an arc<figure_OEImageFrame_DrawArc>`.

      .. _figure_OEImageFrame_DrawArc:

      .. figure:: depicttk/images/OEImageBase-DrawArc.*
         :align:  center
         :scale:  100

         **Example of drawing an arc**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawArc` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawCircle
      ################################################################

   .. oe:method:: DrawCircle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawCircle(const OE2DPoint& center, double radius,
                            const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawCircle(c: OE2DPoint, rad: float, pen: OEPen) -> None

      Draws a circle.
      See example in :ref:`Figure: Example of drawing a circle<figure_OEImageFrame_DrawCircle>`.

      .. _figure_OEImageFrame_DrawCircle:

      .. figure:: depicttk/images/OEImageBase-DrawCircle.*
         :align:  center

         **Example of drawing a circle**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawCircle` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawCubicBezier
      ################################################################

   .. oe:method:: DrawCubicBezier

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawCubicBezier(const OE2DPoint& bgn, const OE2DPoint& c1,
                                 const OE2DPoint& c2, const OE2DPoint& end,
                                 const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawCubicBezier(bgn: OE2DPoint, c1: OE2DPoint, c2: OE2DPoint,
                            end: OE2DPoint, pen: OEPen) -> None

      Draws a cubic |Bezier| curve.
      See example in :ref:`Figure: Example of drawing a cubic Bezier curve<figure_OEImageFrame_DrawCubicBezier>`.

      .. _figure_OEImageFrame_DrawCubicBezier:

      .. figure:: depicttk/images/OEImageBase-DrawCubicBezier.*
         :align:  center

         **Example of drawing a cubic Bezier curve**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawCubicBezier` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` classes

   .. ################################################################
      # DrawLine
      ################################################################

   .. oe:method:: DrawLine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawLine(const OE2DPoint& bgn, const OE2DPoint& end,
                          const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawLine(bgn: OE2DPoint, end: OE2DPoint, pen: OEPen) -> None

      Draws a line.
      See example in :ref:`Figure: Example of drawing a line<figure_OEImageFrame_DrawLine>`.

      .. _figure_OEImageFrame_DrawLine:

      .. figure:: depicttk/images/OEImageBase-DrawLine.*
         :align:  center

         **Example of drawing a line**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawLine` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` classes

   .. ################################################################
      # DrawPath
      ################################################################

   .. oe:method:: DrawPath

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawPath(const OE2DPath& path, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawPath(path: OE2DPath, pen: OEPen) -> None

      Draws a path.
      See example in :ref:`Figure: Example of drawing a path<figure_OEImageFrame_DrawPath>`.

      .. _figure_OEImageFrame_DrawPath:

      .. figure:: depicttk/images/OEImageBase-DrawPath.*
         :align:  center
         :scale:  100

         **Example of drawing a path**

     .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawPath` methods
         * :ref:`OE2DPath <OEDepict_OE2DPath>` class
         * :ref:`OEPen <OEDepict_OEPen>` classes

   .. ################################################################
      # DrawPie
      ################################################################

   .. oe:method:: DrawPie

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawPie(const OE2DPoint& center, double bgnAngle,
                         double endAngle, double radius, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawPie(c: OE2DPoint, bgnAngle: float, endAngle: float, rad: float,
                    pen: OEPen) -> None

      Draws a pie.
      See example in :ref:`Figure: Example of drawing a pie<figure_OEImageFrame_DrawPie>`.

      .. _figure_OEImageFrame_DrawPie:

      .. figure:: depicttk/images/OEImageBase-DrawPie.*
         :align:  center
         :scale:  100

         **Example of drawing a pie**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawPie` methods
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` classes

   .. ################################################################
      # DrawPoint
      ################################################################

   .. oe:method:: DrawPoint

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawPoint(const OE2DPoint& p, const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            DrawPoint(p: OE2DPoint, color: OEColor) -> None

      Draws a point.
      See example in :ref:`Figure: Example of drawing a point<figure_OEImageFrame_DrawPoint>`.

      .. _figure_OEImageFrame_DrawPoint:

      .. figure:: depicttk/images/OEImageBase-DrawPoint.*
         :align:  center

         **Example of drawing a point**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawPoint` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEColor <OESystem_OEColor>` class

   .. ################################################################
      # DrawPolygon
      ################################################################

   .. oe:method:: DrawPolygon

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawPolygon(const std::vector<OE2DPoint>& points,
                             const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawPolygon(p: OE2DPointVector, pen: OEPen) -> None

      Draws a closed polygon.
      See example in :ref:`Figure: Example of drawing a polygon<figure_OEImageFrame_DrawPolygon>`.

      .. _figure_OEImageFrame_DrawPolygon:

      .. figure:: depicttk/images/OEImageBase-DrawPolygon.*
         :align:  center

         **Example of drawing a polygon**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawPolygon` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawQuadraticBezier
      ################################################################

   .. oe:method:: DrawQuadraticBezier

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawQuadraticBezier(const OE2DPoint& bgn, const OE2DPoint& c,
                                     const OE2DPoint& end, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawQuadraticBezier(bgn: OE2DPoint, c1: OE2DPoint, end: OE2DPoint,
                                pen: OEPen) -> None

      Draws a quadratic |Bezier| curve.
      See example in :ref:`Figure: Example of drawing a quadratic Bezier curve<figure_OEImage_DrawQuadraticBezier>`.

      .. _figure_OEImageFrame_DrawQuadraticBezier:

      .. figure:: depicttk/images/OEImageBase-DrawQuadraticBezier.*
         :align:  center

         **Example of drawing a quadratic Bezier curve**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawQuadraticBezier` methods
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` classes

   .. ################################################################
      # DrawRectangle
      ################################################################

   .. oe:method:: DrawRectangle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawRectangle(const OE2DPoint& tl, const OE2DPoint& br,
                               const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawRectangle(tl: OE2DPoint, br: OE2DPoint, pen: OEPen) -> None

      Draws a rectangle.
      See example in :ref:`Figure: Example of drawing a rectangle<figure_OEImageFrame_DrawRectangle>`.

      .. _figure_OEImageFrame_DrawRectangle:

      .. figure:: depicttk/images/OEImageBase-DrawRectangle.*
         :align:  center

         **Example of drawing a rectangle**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawRectangle` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawText
      ################################################################

   .. oe:method:: DrawText

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawText(const OE2DPoint& c, const std::string& text,
                          const OEFont& font, double maxwidth = 0.0)

      .. oe:language:: python

         .. oe:api:: python

            DrawText(c: OE2DPoint, text: str, font: OEFont,
                     maxwidth: float = 0.0) -> None

      Draws a text.
      See example in :ref:`Figure: Example of drawing a text<figure_OEImageFrame_DrawText>`.

      .. _figure_OEImageFrame_DrawText:

      .. figure:: depicttk/images/OEImageBase-DrawText.*
         :align:  center

         **Example of drawing a text**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawText` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. ################################################################
      # DrawTriangle
      ################################################################

   .. oe:method:: DrawTriangle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void DrawTriangle(const OE2DPoint& a, const OE2DPoint& b,
                              const OE2DPoint& c, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawTriangle(arg2: OE2DPoint, arg3: OE2DPoint, arg4: OE2DPoint,
                         arg5: OEPen) -> None

      Draws a triangle.
      See example in :ref:`Figure: Example of drawing a triangle<figure_OEImageFrame_DrawTriangle>`.

      .. _figure_OEImageFrame_DrawTriangle:

      .. figure:: depicttk/images/OEImageBase-DrawTriangle.*
         :align:  center

         **Example of drawing a triangle**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageBase::DrawTriangle` method
         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` classes

   .. ################################################################
      # GetHeight
      ################################################################

   .. oe:method:: GetHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeight() -> float

      Returns the height of the :ref:`OEImageFrame <OEDepict_OEImageFrame>` object.

   .. ################################################################
      # GetOffset
      ################################################################

   .. oe:method:: GetOffset

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OE2DPoint& GetOffset() const

      .. oe:language:: python

         .. oe:api:: python

            GetOffset() -> OE2DPoint

      Returns the offset of the :ref:`OEImageFrame <OEDepict_OEImageFrame>` object
      relative to its :ref:`OEImageBase <OEDepict_OEImageBase>` parent.

   .. ################################################################
      # GetWidth
      ################################################################

   .. oe:method:: GetWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetWidth() -> float

      Returns the width of the :ref:`OEImageFrame <OEDepict_OEImageFrame>` object.



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEImageGrid, ImageGrid

.. _OEDepict_OEImageGrid:

.. oe:class:: OEImageGrid

   .. oe:api::

      class OEImageGrid

   This class represents :ref:`OEImageGrid <OEDepict_OEImageGrid>` which is a
   layout manager that aligns cells into rows and columns.
   The cells of the grid are equal-sized and evenly spaced.
   See :ref:`Figure: Schematic representation of an OEImageGrid object<figure_OEImageGrid>`.

   .. _figure_OEImageGrid:

   .. figure:: depicttk/images/OEImageGrid.*
      :align:  center

      **Schematic representation of an OEImageGrid object**

   .. note::

      In the image grid, each cell has the same width and height.
      The width and height of the cells are calculated based on the
      height and width of the :ref:`OEImageGrid <OEDepict_OEImageGrid>`,
      its margins and gap set between the cells.

   .. seealso::

      * :ref:`section_image_layout_grid` section
      * :ref:`OEImageTable <OEDepict_OEImageTable>` class

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageGrid(OEImageBase& parent, unsigned int rows,
                        unsigned int cols)

      .. oe:language:: python

         .. oe:api:: python

            OEImageGrid(image: OEImageBase, rows: int, cols: int) -> OEImageGrid

      Creates an :ref:`OEImageGrid <OEDepict_OEImageGrid>` object with the specified
      number of rows and columns.

      *parent*
          The :ref:`OEImageBase <OEDepict_OEImageBase>` object on which the
          :ref:`OEImageGrid <OEDepict_OEImageGrid>` object is placed.

      *rows*
         The number of rows in the :ref:`OEImageGrid <OEDepict_OEImageGrid>` object.

      *cols*
         The number of columns in the :ref:`OEImageGrid <OEDepict_OEImageGrid>` object.

      .. note::

         The width and the height of the :ref:`OEImageGrid <OEDepict_OEImageGrid>`
         object are identical to the width and height of the *parent*
         :ref:`OEImageBase <OEDepict_OEImageBase>`, respectively.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageGrid::NumCols` method
         * :oe:meth:`OEDepict::OEImageGrid::NumRows` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageBase* GetCell(unsigned int r, unsigned int c)

      .. oe:language:: python

         .. oe:api:: python

            GetCell(row: int, col: int) -> OEImageBase

      Returns the :ref:`OEImageBase <OEDepict_OEImageBase>` pointer for the cell
      positioned in the :math:`r^{th}` row and :math:`c^{th}` columns.

      *r*
         This value has to be in the range from `1` to
         :oe:meth:`OEDepict::OEImageGrid::NumRows()<OEDepict::OEImageGrid::NumRows>`.

      *c*
         This value has to be in the range from `1` to
         :oe:meth:`OEDepict::OEImageGrid::NumCols()<OEDepict::OEImageGrid::NumCols>`.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetCellGap

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCellGap() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellGap() -> float

      Returns the space between the cells of the :ref:`OEImageGrid <OEDepict_OEImageGrid>`
      object.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageGrid::SetCellGap` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetCellHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCellHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellHeight() -> float

      Returns the height of the cells of the
      :ref:`OEImageGrid <OEDepict_OEImageGrid>` object.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetCellWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCellWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellWidth() -> float

      Returns the width of the cells of the
      :ref:`OEImageGrid <OEDepict_OEImageGrid>` object.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetCells

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEImageBase>* GetCells(unsigned int row = 0u,
                                                        unsigned int col = 0u)

      .. oe:language:: python

         .. oe:api:: python

            GetCells(row: int = 0, col: int = 0) -> Iterable[OEImageBase]

      Returns an iterator over the cells of the :ref:`OEImageGrid <OEDepict_OEImageGrid>`
      object.
      The cells are returned from left to right and top to bottom order.

      *row*
         This value has to be in the range from `0` to
         :oe:meth:`OEDepict::OEImageGrid::NumRows()<OEDepict::OEImageGrid::NumRows>`.

      *col*
         This value has to be in the range from `0` to
         :oe:meth:`OEDepict::OEImageGrid::NumCols()<OEDepict::OEImageGrid::NumCols>`.

      Example (:ref:`Figure Example of accessing all cells of the grid<figure_ImageGridIter_All>`)

      .. oe:source:: ImageGridIter.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGEGRID-GETCELLS-ALL

      .. oe:source:: ImageGridIter.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGEGRID-GETCELLS-ALL

      .. oe:source:: ImageGridIter.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGEGRID-GETCELLS-ALL

      .. oe:source:: ImageGridIter.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGEGRID-GETCELLS-ALL

      .. _figure_ImageGridIter_All:

      .. figure:: depicttk/images/ImageGridIter-all.*
         :align:  center

         **Example of accessing all cells of the grid.**

         *(The numbers inside the cells represent the order in which
         the cells are returned)*

      If the *col* number is zero then :oe:meth:`OEDepict::OEImageGrid::GetCells`
      returns an iterator over the cells of the specified row.

      Example (:ref:`Figure Example of accessing a specific row of the grid<figure_ImageGridIter_Row>`)

      .. oe:source:: ImageGridIter.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGEGRID-GETCELLS-ROW

      .. oe:source:: ImageGridIter.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGEGRID-GETCELLS-ROW

      .. oe:source:: ImageGridIter.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGEGRID-GETCELLS-ROW

      .. oe:source:: ImageGridIter.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGEGRID-GETCELLS-ROW

      .. _figure_ImageGridIter_Row:

      .. figure:: depicttk/images/ImageGridIter-row.*
         :align:  center

         **Example of accessing a specific row of the grid.**

         *(The numbers inside the cells represent the order in which
         the cells are returned)*

      If the *row* number is zero then :oe:meth:`OEDepict::OEImageGrid::GetCells`
      returns an iterator over the cells of the specified column.

      Example (:ref:`Figure Example of accessing a specific column of the grid<figure_ImageGridIter_Col>`)

      .. oe:source:: ImageGridIter.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGEGRID-GETCELLS-COL

      .. oe:source:: ImageGridIter.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGEGRID-GETCELLS-COL

      .. oe:source:: ImageGridIter.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGEGRID-GETCELLS-COL

      .. oe:source:: ImageGridIter.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGEGRID-GETCELLS-COL

      .. _figure_ImageGridIter_Col:

      .. figure::  depicttk/images/ImageGridIter-col.*
         :align:  center

         **Example of accessing a specific column of the grid.**

         *(The numbers inside the cells represent the order in which
         the cells are returned)*

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMargin(unsigned int margin) const

      .. oe:language:: python

         .. oe:api:: python

            GetMargin(margin: int) -> float

      Returns the size of a specific margin of the
      :ref:`OEImageGrid <OEDepict_OEImageGrid>` object.

      *margin*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageGrid::SetMargin` method
         * :oe:meth:`OEDepict::OEImageGrid::SetMargins` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumCols

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumCols() const

      .. oe:language:: python

         .. oe:api:: python

            NumCols() -> int

      Returns the number of columns of the :ref:`OEImageGrid <OEDepict_OEImageGrid>`
      object.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumRows

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumRows() const

      .. oe:language:: python

         .. oe:api:: python

            NumRows() -> int

      Returns the number of rows of the :ref:`OEImageGrid <OEDepict_OEImageGrid>`
      object.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: SetCellGap

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCellGap(double size)

      .. oe:language:: python

         .. oe:api:: python

            SetCellGap(size: float) -> bool

      Sets the space between the cells of the :ref:`OEImageGrid <OEDepict_OEImageGrid>`
      object to the given size.

      *size*
         This value has to be a positive number.

      .. warning: # IGNORE

         After accessing the cells of the :ref:`OEImageGrid <OEDepict_OEImageGrid>`
         object, the space between the cell can not be changed.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageGrid::GetCellGap` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: SetMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMargin(unsigned int margin, double size)

      .. oe:language:: python

         .. oe:api:: python

            SetMargin(margin: int, size: float) -> bool

      Sets the size of a specific margin of the
      :ref:`OEImageGrid <OEDepict_OEImageGrid>` object.

      *margin*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      *size*
         This value has to be a positive number.

      .. warning: IGNORE

         After accessing the cells of the :ref:`OEImageGrid <OEDepict_OEImageGrid>`
         object, the margins of the grid can not be changed.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageGrid::GetMargin` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: SetMargins

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMargins(double size)

      .. oe:language:: python

         .. oe:api:: python

            SetMargins(size: float) -> bool

      Sets the size of all margins of the
      :ref:`OEImageGrid <OEDepict_OEImageGrid>` object.

      *size*
         This value has to be a positive number.

      .. warning: IGNORE

         After accessing the cells of the :ref:`OEImageGrid <OEDepict_OEImageGrid>`
         object, the margins of the grid can not be changed.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageGrid::GetMargin` method



.. oe:namespace:: OEDepict

.. _OEDepict_OEImageTable:

.. oe:class:: OEImageTable

   .. oe:api::

      class OEImageTable

   This class represents :ref:`OEImageTable <OEDepict_OEImageTable>` which is a
   layout manager that allows to arrange information in rows and columns with
   variable height and width, respectively.

   .. figure:: depicttk/images/ImageTable.*
      :align:  center

      **Example of using image table**

   .. seealso::

      * :ref:`section_image_layout_table` section
      * :ref:`OEImageTableOptions <OEDepict_OEImageTableOptions>` class
      * :oe:constns:`OEDepict::OEImageTableStyle` namespace
      * :ref:`OEImageGrid <OEDepict_OEImageGrid>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageTable(OEImageBase& parent, const OEImageTableOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            OEImageTable(image: OEImageBase, opts: OEImageTableOptions) -> OEImageTable

      Creates an :ref:`OEImageTable <OEDepict_OEImageTable>` object with the specified
      options.

      *parent*
          The :ref:`OEImageBase <OEDepict_OEImageBase>` object on which the
          :ref:`OEImageTable <OEDepict_OEImageTable>` object is placed.

      *opts*
          The :ref:`OEImageTableOptions <OEDepict_OEImageTableOptions>` object that
          defines the properties and style of the table.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTable::GetOptions` method
         * :oe:meth:`OEDepict::OEImageTable::NumColumns` method
         * :oe:meth:`OEDepict::OEImageTable::NumRows` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: DrawText

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DrawText(OEImageBase* cell, const std::string& text,
                          double padding = 5.0)

      .. oe:language:: python

         .. oe:api:: python

            DrawText(cell: OEImageBase, text: str, padding: float = 5.0) -> bool

      Draws a text to the given table cell. Returns ``false`` if the given image
      does not belong to the table.

      *padding*
        Defines the padding used on the left and right of the given cell
        as a percentage of the width of the cell.

      .. note::

         The font that is used to render the text is defined in the
         :ref:`OEImageTableOptions <OEDepict_OEImageTableOptions>` class.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetCellFont` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetHeaderFont` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetStubColumnFont` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetBodyCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageBase* GetBodyCell(unsigned int row, unsigned int col)

      .. oe:language:: python

         .. oe:api:: python

            GetBodyCell(row: int, col: int) -> OEImageBase

      Returns the :ref:`OEImageBase <OEDepict_OEImageBase>` for the cell
      positioned in the :math:`r^{th}` row and :math:`c^{th}` columns of
      the 'body' of the table.
      A cell is considered to be part of the 'body' of the table if it is neither
      in the header nor in the stub column.

      *row*
         This value has to be in the range from :math:`1` to
         :oe:meth:`OEDepict::OEImageTable::NumRows(true)<OEDepict::OEImageTable::NumRows>`.

      *col*
         This value has to be in the range from :math:`1` to
         :oe:meth:`OEDepict::OEImageTable::NumColumns(true)<OEDepict::OEImageTable::NumColumns>`.

      .. note::

         A null pointer is returned if the **row** or the **col** parameters are
         outside the acceptable range.

      **Example**

      The image below marks the cell returned by
      :oe:meth:`OEDepict::OEImageTable::GetBodyCell` method
      for row = 1 and col = 2 parameters.

      .. _figure_OEImageTable_GetBodyCell:

      .. figure:: depicttk/images/OEImageTable-GetBodyCell.*
         :align:  center

         **Example of accessing a specific 'body' cell of the table.**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTable::GetCell` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetBodyCells

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEImageBase>* GetBodyCells(unsigned int row = 0u,
                                                            unsigned int col = 0u)

      .. oe:language:: python

         .. oe:api:: python

            GetBodyCells(row: int = 0, col: int = 0) -> Iterable[OEImageBase]

      Returns an iterator over the 'body' cells of the
      :ref:`OEImageTable <OEDepict_OEImageTable>` object.
      A cell is considered to be part of the 'body' of the table if it is neither
      in the header nor in the stub column.
      The cells are returned from left to right and top to bottom order.

      *row*
         This value has to be in the range from :math:`0` to
         :oe:meth:`OEDepict::OEImageTable::NumRows(true)<OEDepict::OEImageTable::NumRows>`.

      *col*
         This value has to be in the range from :math:`0` to
         :oe:meth:`OEDepict::OEImageTable::NumColumns(true)<OEDepict::OEImageTable::NumColumns>`.

      .. note::

         An empty iterator is returned if the **row** or the **col** parameters are
         outside the acceptable range.

      **Examples**

      If the :oe:meth:`OEDepict::OEImageTable::GetBodyCells` method is invoked
      without any parameter, then all 'body cells' are returned.

      .. _figure_OEImageTable_GetBodyCells:

      .. figure:: depicttk/images/OEImageTable-GetBodyCells.*
         :align:  center

         **Example of accessing all 'body' cells of the table**

         *(The numbers inside the cells represent the order in which
         the cells are returned)*

      If the **row** parameter is zero, then the :oe:meth:`OEDepict::OEImageTable::GetBodyCells`
      method returns an iterator over the 'body' cells of the specified column.
      The image below marks the cells returned by
      :oe:meth:`OEDepict::OEImageTable::GetBodyCell` method
      for row = 0 and col = 2 parameters.

      .. _figure_OEImageTable_GetBodyColCells:

      .. figure:: depicttk/images/OEImageTable-GetBodyColCells.*
         :align:  center

         **Example of accessing 'body' cells of a specific columns in the table**

         *(The numbers inside the cells represent the order in which
         the cells are returned)*

      If the **column** parameter is zero, then the :oe:meth:`OEDepict::OEImageTable::GetBodyCells`
      method returns an iterator over the 'body' cells of the specified column.
      The image below marks the cells returned by
      :oe:meth:`OEDepict::OEImageTable::GetBodyCell` method
      for row = 2 and col = 0 parameters.

      .. _figure_OEImageTable_GetBodyRowCells:

      .. figure:: depicttk/images/OEImageTable-GetBodyRowCells.*
         :align:  center

         **Example of accessing 'body' cells of a specific row in the table**

         *(The numbers inside the cells represent the order in which
         the cells are returned)*

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTable::GetCells` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageBase* GetCell(unsigned int row, unsigned int col)

      .. oe:language:: python

         .. oe:api:: python

            GetCell(row: int, col: int) -> OEImageBase

      Returns the :ref:`OEImageBase <OEDepict_OEImageBase>` pointer for the cell
      positioned in the :math:`r^{th}` row and :math:`c^{th}` columns.

      *row*
         This value has to be in the range from :math:`1` to
         :oe:meth:`OEDepict::OEImageTable::NumRows()<OEDepict::OEImageTable::NumRows>`.

      *col*
         This value has to be in the range from :math:`1` to
         :oe:meth:`OEDepict::OEImageTable::NumColumns()<OEDepict::OEImageTable::NumColumns>`.

      .. note::

         A null pointer is returned if the **row** or the **col** parameters are
         outside the acceptable range.

      **Example**

      The image below marks the cell returned by
      :oe:meth:`OEDepict::OEImageTable::GetCell` method
      for row = 1 and col = 2 parameters.

      .. _figure_OEImageTable_GetCell:

      .. figure:: depicttk/images/OEImageTable-GetCell.*
         :align:  center

         **Example of accessing a specific cell of the table**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTable::GetBodyCell` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetCells

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEImageBase>* GetCells (unsigned int row = 0u,
                                                         unsigned int col = 0u)

      .. oe:language:: python

         .. oe:api:: python

            GetCells(row: int = 0, col: int = 0) -> Iterable[OEImageBase]

      Returns an iterator over the cells of the :ref:`OEImageTable <OEDepict_OEImageTable>`
      object.
      The cells are returned from left to right and top to bottom order.

      *row*
         This value has to be in the range from :math:`0` to
         :oe:meth:`OEDepict::OEImageTable::NumRows()<OEDepict::OEImageTable::NumRows>`.

      *col*
         This value has to be in the range from :math:`0` to
         :oe:meth:`OEDepict::OEImageTable::NumColumns()<OEDepict::OEImageTable::NumColumns>`.

      .. note::

         An empty iterator is returned if the **row** or the **col** parameters are
         outside the acceptable range.

      **Examples**

      If the :oe:meth:`OEDepict::OEImageTable::GetCells` method is invoked
      without any parameter, then all cells of the table are returned.

      .. _figure_OEImageTable_GetCells:

      .. figure:: depicttk/images/OEImageTable-GetCells.*
         :align:  center

         **Example of accessing all cells of the table**

         *(The numbers inside the cells represent the order in which
         the cells are returned)*

      If the **row** parameter is zero, then the :oe:meth:`OEDepict::OEImageTable::GetCells`
      method returns an iterator over the cells of the specified column.
      The image below marks the cells returned by
      :oe:meth:`OEDepict::OEImageTable::GetCell` method
      for row = 0 and col = 2 parameters.

      .. _figure_OEImageTable_GetColCells:

      .. figure:: depicttk/images/OEImageTable-GetColCells.*
         :align:  center

         **Example of accessing all cells of a specific columns of the table.**

         *(The numbers inside the cells represent the order in which
         the cells are returned)*

      If the **column** parameter is zero, then the :oe:meth:`OEDepict::OEImageTable::GetCells`
      method returns an iterator over the cells of the specified row.
      The image below marks the cells returned by
      :oe:meth:`OEDepict::OEImageTable::GetCell` method
      for row = 2 and col = 0 parameters.

      .. _figure_OEImageTable_GetRowCells:

      .. figure:: depicttk/images/OEImageTable-GetRowCells.*
         :align:  center

         **Example of accessing all cells of a specific row of the table.**

         *(The numbers inside the cells represent the order in which
         the cells are returned)*

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTable::GetBodyCells` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetHeaderCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageBase* GetHeaderCell(unsigned int col, bool skipstub = true)

      .. oe:language:: python

         .. oe:api:: python

            GetHeaderCell(col: int, skipstub: bool = True) -> OEImageBase

      Returns the :ref:`OEImageBase <OEDepict_OEImageBase>` for the cell
      positioned in the :math:`c^{th}` columns of the 'header' of the table.

      *col*
         This value has to be in the range:

         * from :math:`1` to
           :oe:meth:`OEDepict::OEImageTable::NumColumns(false)<OEDepict::OEImageTable::NumColumns>`
           if **skipstub** is true.

         * from :math:`1` to
           :oe:meth:`OEDepict::OEImageTable::NumColumns(true)<OEDepict::OEImageTable::NumColumns>`
           if **skipstub** is false.

      **skipstub**
        The parameter that determines whether to consider the stub column.
        If **skipstub** is `false` and the table has a stub column, than that stub column
        is considered as the first column.

      .. note::

         A null pointer is returned if the table has no header or
         if the **col** parameters is outside the acceptable range.

      **Example**

      The image below marks the cell returned by
      :oe:meth:`OEDepict::OEImageTable::GetHeaderCell` method
      for col = 2 and skipstub = true parameters.

      .. _figure_OEImageTable_GetHeaderCell:

      .. figure:: depicttk/images/OEImageTable-GetHeaderCell.*
         :align:  center

         **Example of accessing a specific header cell of the table**

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetHeaderCells

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEImageBase>* GetHeaderCells(bool skipstub = true)

      .. oe:language:: python

         .. oe:api:: python

            GetHeaderCells(skipstub: bool = True) -> Iterable[OEImageBase]

      Returns an iterator over the header cells of the :ref:`OEImageTable <OEDepict_OEImageTable>` object.
      The cells are returned from left to right order.

      **skipstub**
        The parameter that determines whether to consider the stub column.
        If **skipstub** is `false` and the table has a stub column, than that stub column
        is considered as the first column.

      .. note::

         An empty iterator is returned if table has no header row.

      **Example**

       The image below marks the cells returned by
       :oe:meth:`OEDepict::OEImageTable::GetHeaderCells` for skipstub = true parameter.

      .. _figure_OEImageTable_GetHeaderCells:

      .. figure:: depicttk/images/OEImageTable-GetHeaderCells.*
         :align:  center

         **Example of accessing header cells of the table**

         *(The numbers inside the cells represent the order in which
         the cells are returned)*

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEImageTableOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEImageTableOptions

      Returns the options used to initialized the :ref:`OEImageTable <OEDepict_OEImageTable>`
      object.

      .. seealso::

          * :ref:`OEImageTableOptions <OEDepict_OEImageTableOptions>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetStubColumnCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageBase* GetStubColumnCell(unsigned int row)

      .. oe:language:: python

         .. oe:api:: python

            GetStubColumnCell(row: int) -> OEImageBase

      Returns the :ref:`OEImageBase <OEDepict_OEImageBase>` for the cell
      positioned in the :math:`r^{th}` row of the 'stub column' of the table.

      *row*
         This value has to be in the range from :math:`1` to
         :oe:meth:`OEDepict::OEImageTable::NumRows(true)<OEDepict::OEImageTable::NumColumns>`.

      .. note::

         A null pointer is returned if the table has no stub column or
         if the **row** parameters is outside the acceptable range.

      **Example**

      The image below marks the cell returned by
      :oe:meth:`OEDepict::OEImageTable::GetStubColumnCell` method
      for row=1 parameter.

      .. _figure_OEImageTable_GetStubColumnCell:

      .. figure:: depicttk/images/OEImageTable-GetStubColumnCell.*
         :align:  center

         **Example of accessing a specific stub column cell of the table**

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetStubColumnCells

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEImageBase>* GetStubColumnCells()

      .. oe:language:: python

         .. oe:api:: python

            GetStubColumnCells() -> Iterable[OEImageBase]

      Returns an iterator over the stub column cells of the :ref:`OEImageTable <OEDepict_OEImageTable>` object.
      The cells are returned from top to bottom order.

      .. note::

         An empty iterator is returned if table has no stub column.

      **Example**

       The image below marks the cells returned by
       :oe:meth:`OEDepict::OEImageTable::GetStubColumnCells` method.

      .. _figure_OEImageTable_GetStubColumnCells:

      .. figure:: depicttk/images/OEImageTable-GetStubColumnCells.*
         :align:  center

         **Example of accessing stub column cells of the table**

         *(The numbers inside the cells represent the order in which
         the cells are returned)*

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumColumns

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumColumns(bool onlybody = false) const

      .. oe:language:: python

         .. oe:api:: python

            NumColumns(onlybody: bool = False) -> int

      Returns the number of columns of the :ref:`OEImageTable <OEDepict_OEImageTable>`
      object.

      *onlybody*
        If this parameter is 'true', than stub column is not counted if exists.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumRows

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumRows(bool onlybody = false) const

      .. oe:language:: python

         .. oe:api:: python

            NumRows(onlybody: bool = False) -> int

      Returns the number of rows of the :ref:`OEImageTable <OEDepict_OEImageTable>`
      object.

      *onlybody*
        If this parameter is 'true', than header row is not counted if exists.


.. oe:namespace:: OEDepict

.. _OEDepict_OEImageTableOptions:

.. oe:class:: OEImageTableOptions

   .. oe:api::

      class OEImageTableOptions

   This class represents the :ref:`OEImageTableOptions <OEDepict_OEImageTableOptions>` class
   that encapsulates properties that determine how an image table is depicted.

   The :ref:`OEImageTableOptions <OEDepict_OEImageTableOptions>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - number of columns
        - :oe:meth:`NumColumns<OEDepict::OEImageTableOptions::NumColumns>`
        -
        - integer greater than 0

      * - number of rows
        - :oe:meth:`NumRows<OEDepict::OEImageTableOptions::NumRows>`
        -
        - integer greater than 1

      * - width of columns
        -
        - :oe:meth:`SetColumnWidths<OEDepict::OEImageTableOptions::SetColumnWidths>`
        - vector of non zero integers

      * - height of rows
        -
        - :oe:meth:`SetRowHeights<OEDepict::OEImageTableOptions::SetRowHeights>`
        - vector of non zero integers

      * - cell font size
        -
        - :oe:meth:`SetBaseFontSize<OEDepict::OEImageTableOptions::SetBaseFontSize>`
        - positive non-zero integer

      * - pen used around cells cells
        - :oe:meth:`GetCellBorderPen<OEDepict::OEImageTableOptions::GetCellBorderPen>`
        - :oe:meth:`SetCellBorderPen<OEDepict::OEImageTableOptions::SetCellBorderPen>`
        - :ref:`OEPen <OEDepict_OEPen>`

      * - table cell color
        - :oe:meth:`GetCellColor<OEDepict::OEImageTableOptions::GetCellColor>`
        - :oe:meth:`SetCellColor<OEDepict::OEImageTableOptions::SetCellColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - table cell font
        - :oe:meth:`GetCellFont<OEDepict::OEImageTableOptions::GetCellFont>`
        - :oe:meth:`SetCellFont<OEDepict::OEImageTableOptions::SetCellFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - header
        - :oe:meth:`HasHeader<OEDepict::OEImageTableOptions::HasHeader>`
        - :oe:meth:`SetHeader<OEDepict::OEImageTableOptions::SetHeader>`
        - boolean

      * - header color
        - :oe:meth:`GetHeaderColor<OEDepict::OEImageTableOptions::GetHeaderColor>`
        - :oe:meth:`SetHeaderColor<OEDepict::OEImageTableOptions::SetHeaderColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - header font
        - :oe:meth:`GetHeaderFont<OEDepict::OEImageTableOptions::GetHeaderFont>`
        - :oe:meth:`SetHeaderFont<OEDepict::OEImageTableOptions::SetHeaderFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - table margins
        - :oe:meth:`GetMargin<OEDepict::OEImageTableOptions::GetMargin>`
        - :oe:meth:`SetMargin<OEDepict::OEImageTableOptions::SetMargin>` / :oe:meth:`SetMargins<OEDepict::OEImageTableOptions::SetMargins>`
        - positive floating point number in the range of :math:`[0.0, 25.0]`

      * - stub column
        - :oe:meth:`HasStubColumn<OEDepict::OEImageTableOptions::HasStubColumn>`
        - :oe:meth:`SetStubColumn<OEDepict::OEImageTableOptions::SetStubColumn>`
        - boolean

      * - stub column color
        - :oe:meth:`GetStubColumnColor<OEDepict::OEImageTableOptions::GetStubColumnColor>`
        - :oe:meth:`SetStubColumnColor<OEDepict::OEImageTableOptions::SetStubColumnColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - stub column font
        - :oe:meth:`GetStubColumnFont<OEDepict::OEImageTableOptions::GetStubColumnFont>`
        - :oe:meth:`SetStubColumnFont<OEDepict::OEImageTableOptions::SetStubColumnFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

   .. seealso::

      * :ref:`section_image_layout_table` section
      * :ref:`OEImageTable <OEDepict_OEImageTable>` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageTableOptions(unsigned int rows, unsigned int cols,
                                unsigned int style = OEImageTableStyle::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEImageTableOptions(rows: int, cols: int, style: int) -> OEImageTableOptions

      Creates an :ref:`OEImageTableOptions <OEDepict_OEImageTableOptions>` object with
      the given parameters.

      **rows**
         The total number of rows in the table including the header.

      **cols**
         The total number of columns in the table including the stub column.

      **style**
         This value has to be from the :oe:constns:`OEDepict::OEImageTableStyle`
         namespace.

      .. note::

         By default, the columns and rows of a table are created with equal
         widths and heights.
         The relative width and height ratio of the columns and rows can be adjusted using the
         :oe:meth:`OEDepict::OEImageTableOptions::SetColumnWidths` and
         :oe:meth:`OEDepict::OEImageTableOptions::SetRowHeights` methods,
         respectively.

      **Example** (:ref:`figure_OEImageTableOptions_Default`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-DEFAULT

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-DEFAULT

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-DEFAULT

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-DEFAULT

      .. _figure_OEImageTableOptions_Default:

      .. figure:: depicttk/images/OEImageTableOptions_Default.*
         :align:  center

         **Example of generating a 4 x 4 image table with header and 'MediumBlue' style**

      .. seealso::

         * :oe:constns:`OEDepict::OEImageTableStyle` namespace
         * :oe:meth:`OEDepict::OEImageTableOptions::NumRows` method
         * :oe:meth:`OEDepict::OEImageTableOptions::NumColumns` method

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageTableOptions(const OEImageTableOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEImageTableOptions(arg2: OEImageTableOptions) -> OEImageTableOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEImageTableOptions &operator=(const OEImageTableOptions &)

      Assignment operator.

   .. oe:method:: GetCellBorderPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEPen& GetCellBorderPen() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellBorderPen() -> OEPen

      Returns the pen that is used to mark the border of the cells in the table.

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetCellBorderPen` method

   .. oe:method:: GetCellColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor GetCellColor(bool even = true) const

      .. oe:language:: python

         .. oe:api:: python

            GetCellColor(even: bool = True) -> OEColor

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::SetCellColor` method

      Returns the color used to highlight the 'body' cells in the table.
      A cell is considered to be part of the 'body' of the table if it is neither
      in the header nor in the stub column.

      *even*
        This parameter determines whether to return the color of the even or odd
        rows in the table.

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetCellColor` method

   .. oe:method:: GetCellFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont GetCellFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellFont() -> OEFont

      Returns the font used by the :oe:meth:`OEDepict::OEImageTable::DrawText`
      method to draw text on the 'body' cells.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetCellFont` method

   .. oe:method:: GetHeaderColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor GetHeaderColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeaderColor() -> OEColor

      Returns the color used to highlight the 'header' cells in the table.

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetHeaderColor` method

   .. oe:method:: GetHeaderFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont GetHeaderFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeaderFont() -> OEFont

      Returns the font used by the :oe:meth:`OEDepict::OEImageTable::DrawText`
      method to draw text on the 'header' cells.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetHeaderFont` method

   .. oe:method:: GetMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMargin(unsigned int margin) const

      .. oe:language:: python

         .. oe:api:: python

            GetMargin(margin: int) -> float

      Returns the ratio of a specific margin of the table.

      *margin*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::SetMargin` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetMargins` method

   .. oe:method:: GetStubColumnColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor GetStubColumnColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetStubColumnColor() -> OEColor

      Returns the color used to highlight the 'stub column' cells in the table.

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetStubColumnColor` method

   .. oe:method:: GetStubColumnFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont GetStubColumnFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetStubColumnFont() -> OEFont

      Returns the font used by the :oe:meth:`OEDepict::OEImageTable::DrawText`
      method to draw text on the 'stub column' cells.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetStubColumnFont` method

   .. oe:method:: HasHeader

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasHeader() const

      .. oe:language:: python

         .. oe:api:: python

            HasHeader() -> bool

      Returns whether a table has a 'header' row.
      By default, a table is generated with a 'header' row.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::SetHeader` method
         * :oe:meth:`OEDepict::OEImageTableOptions::HasStubColumn` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetStubColumn` method

   .. oe:method:: HasStubColumn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasStubColumn() const

      .. oe:language:: python

         .. oe:api:: python

            HasStubColumn() -> bool

      Returns whether the table has a 'stub' column.
      By default, a table is generated without a 'stub' column.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::SetStubColumn` method
         * :oe:meth:`OEDepict::OEImageTableOptions::HasHeader` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetHeader` method

   .. oe:method:: NumColumns

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumColumns() const

      .. oe:language:: python

         .. oe:api:: python

            NumColumns() -> int

      Returns the total number of columns in the table including the
      stub column.

   .. oe:method:: NumRows

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumRows() const

      .. oe:language:: python

         .. oe:api:: python

            NumRows() -> int

      Returns the total number of rows in the table including the
      header row.

   .. oe:method:: SetBaseFontSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBaseFontSize(unsigned int fontsize)

      .. oe:language:: python

         .. oe:api:: python

            SetBaseFontSize(fsize: int) -> None

      Controls the font size in add table cells (including cells of header,
      stub column and body).

      .. seealso::

         The other properties of the used fonts can be controlled with
         the following methods:

         * :oe:meth:`OEDepict::OEImageTableOptions::SetCellFont` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetHeaderFont` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetStubColumnFont` method

   .. oe:method:: SetCellBorderPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCellBorderPen(const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            SetCellBorderPen(p: OEPen) -> None

      Sets the pen that is used to mark the border of the cells in the table.

      **Example** (:ref:`figure_OEImageTableOptions_SetCellBorderPen`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLBORDERPEN

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLBORDERPEN

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLBORDERPEN

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLBORDERPEN

      .. _figure_OEImageTableOptions_SetCellBorderPen:

      .. figure:: depicttk/images/OEImageTableOptions_SetCellBorderPen.*
         :align:  center

         **Example of using the SetCellBorderPen method**

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::GetCellBorderPen` method

   .. oe:method:: SetCellColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCellColor(const OESystem::OEColor& color, bool even = true)

      .. oe:language:: python

         .. oe:api:: python

            SetCellColor(arg2: OEColor, even: bool = True) -> None

      Sets the color used to highlight the 'body' cells in the table.
      A cell is considered to be part of the 'body' of the table if it is neither
      in the header nor in the stub column.

      *color*
        The color of the cells.

      *even*
        This parameter determines whether the color is applied to the even or to
        the odd rows of the table.

      **Example** (:ref:`figure_OEImageTableOptions_SetCellColor`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLCOLOR

      .. _figure_OEImageTableOptions_SetCellColor:

      .. figure:: depicttk/images/OEImageTableOptions_SetCellColor.*
         :align:  center

         **Example of using the SetCellColor method**

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::GetCellColor` method

   .. oe:method:: SetCellFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCellFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetCellFont(arg2: OEFont) -> None

      Sets the font used by the :oe:meth:`OEDepict::OEImageTable::DrawText`
      method to draw text on the 'body' cells.
      A cell is considered to be part of the 'body' of the table if it is neither
      in the header nor in the stub column.

      **Example** (:ref:`figure_OEImageTableOptions_SetCellFont`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLFONT

      .. _figure_OEImageTableOptions_SetCellFont:

      .. figure:: depicttk/images/OEImageTableOptions_SetCellFont.*
         :align:  center

         **Example of using the SetCellFont method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::GetCellFont` method

   .. oe:method:: SetColumnWidths

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColumnWidths(const std::vector<unsigned int>& widths)

      .. oe:language:: python

         .. oe:api:: python

            SetColumnWidths(arg2: OEUIntVector) -> bool

      Sets the relative widths of the columns.

      **widths**
        The relative widths of the columns.
        The size of the vector has to be :oe:meth:`OEDepict::OEImageTableOptions::NumColumns()<OEDepict::OEImageTable::NumColumns>`.

      **Example** (:ref:`figure_OEImageTableOptions_SetColumnWidths`)

      The following example show how to adjust the width ratio of the columns.

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCOLUMNWIDTHS

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCOLUMNWIDTHS

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCOLUMNWIDTHS

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCOLUMNWIDTHS

      .. _figure_OEImageTableOptions_SetColumnWidths:

      .. figure:: depicttk/images/OEImageTableOptions_SetColumnWidths.*
         :align:  center

         **Example of using the SetColumnWidths method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::SetRowHeights` method

   .. oe:method:: SetHeader

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetHeader(bool has)

      .. oe:language:: python

         .. oe:api:: python

            SetHeader(has: bool) -> bool

      Sets whether to have a 'header' row in the table.

      **Example** (:ref:`figure_OEImageTableOptions_SetHeader`)

      By default, a table is generated with a header row on the top.
      The following example show how to remove the header.

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADER

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADER

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADER

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADER

      .. _figure_OEImageTableOptions_SetHeader:

      .. figure:: depicttk/images/OEImageTableOptions_SetHeader.*
         :align:  center

         **Example of using the SetHeader method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::HasHeader` method
         * :oe:meth:`OEDepict::OEImageTableOptions::HasStubColumn` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetStubColumn` method

   .. oe:method:: SetHeaderColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHeaderColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetHeaderColor(arg2: OEColor) -> None

      Sets the color used to highlight the 'header' cells in the table.

      **Example** (:ref:`figure_OEImageTableOptions_SetHeaderColor`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERCOLOR

      .. _figure_OEImageTableOptions_SetHeaderColor:

      .. figure:: depicttk/images/OEImageTableOptions_SetHeaderColor.*
         :align:  center

         **Example of using the SetHeaderColor method**

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::GetHeaderColor` method

   .. oe:method:: SetHeaderFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHeaderFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetHeaderFont(arg2: OEFont) -> None

      Sets the font used by the :oe:meth:`OEDepict::OEImageTable::DrawText`
      method to draw text on the 'header' cells.

      **Example** (:ref:`figure_OEImageTableOptions_SetHeaderFont`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERFONT

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERFONT

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERFONT

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERFONT

      .. _figure_OEImageTableOptions_SetHeaderFont:

      .. figure:: depicttk/images/OEImageTableOptions_SetHeaderFont.*
         :align:  center

         **Example of using the SetHeaderFont method**

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::GetHeaderFont` method

   .. oe:method:: SetMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMargin(unsigned int marginloc, double margin)

      .. oe:language:: python

         .. oe:api:: python

            SetMargin(margin: int, percent: float) -> bool

      Sets the size of a specific margin of the table.

      *marginloc*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      *margin*
         This number is considered as a percentage of either the width or the height
         of image on which the table will be drawn and has to be in the range of :math:`[0.0, 25.0]`.
         For example, 10.0% means, that the left and right margin
         are 10% of the total width of the image, and the top and bottom margins
         are 10% of the total height of the image.

      **Example** (:ref:`figure_OEImageTableOptions_SetMargin`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGIN

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGIN

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGIN

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGIN

      .. _figure_OEImageTableOptions_SetMargin:

      .. figure:: depicttk/images/OEImageTableOptions_SetMargin.*
         :align:  center

         **Example of using the SetMargin method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::GetMargin` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetMargins` method

   .. oe:method:: SetMargins

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMargins(double margin)

      .. oe:language:: python

         .. oe:api:: python

            SetMargins(percent: float) -> bool

      Sets the size of all margins of the table.

      *margin*
         This number is considered as a percentage of either the width or the height
         of image on which the table will be drawn and has to be in the range of :math:`[0.0, 25.0]`.
         For example, 10.0% means, that the left and right margin
         are 10% of the total width of the image, and the top and bottom margins
         are 10% of the total height of the image.

      **Example** (:ref:`figure_OEImageTableOptions_SetMargins`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGINS

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGINS

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGINS

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGINS

      .. _figure_OEImageTableOptions_SetMargins:

      .. figure:: depicttk/images/OEImageTableOptions_SetMargins.*
         :align:  center

         **Example of using the SetMargins method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::GetMargin` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetMargin` method

   .. oe:method:: SetRowHeights

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRowHeights(const std::vector<unsigned int>& heights)

      .. oe:language:: python

         .. oe:api:: python

            SetRowHeights(arg2: OEUIntVector) -> bool

      Sets the relative heights of the rows.

      **heights**
        The relative heights of the rows.
        The size of the vector has to be :oe:meth:`OEDepict::OEImageTableOptions::NumRows()<OEDepict::OEImageTable::NumRows>`.

      **Example** (:ref:`figure_OEImageTableOptions_SetRowHeights`)

      The following example show how to adjust the height ratio of the rows.

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETROWHEIGHTS

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETROWHEIGHTS

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETROWHEIGHTS

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETROWHEIGHTS

      .. _figure_OEImageTableOptions_SetRowHeights:

      .. figure:: depicttk/images/OEImageTableOptions_SetRowHeights.*
         :align:  center

         **Example of using the SetRowHeights method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::SetColumnWidths` method

   .. oe:method:: SetStubColumn

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStubColumn(bool has)

      .. oe:language:: python

         .. oe:api:: python

            SetStubColumn(has: bool) -> bool

      Sets whether to have a 'stub' column in the table.

      **Example** (:ref:`figure_OEImageTableOptions_SetStubColumn`)

      By default, a table is generated without a 'stub' column.
      The following example show how to add one on the left.

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMN

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMN

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMN

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMN

      .. _figure_OEImageTableOptions_SetStubColumn:

      .. figure:: depicttk/images/OEImageTableOptions_SetStubColumn.*
         :align:  center

         **Example of using the SetStubColumn method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::HasStubColumn` method
         * :oe:meth:`OEDepict::OEImageTableOptions::HasHeader` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetHeader` method

   .. oe:method:: SetStubColumnColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStubColumnColor(const OESystem::OEColor & color)

      .. oe:language:: python

         .. oe:api:: python

            SetStubColumnColor(arg2: OEColor) -> None

      Sets the color used to highlight the 'stub' cells in the table.

      **Example** (:ref:`figure_OEImageTableOptions_SetStubColumnColor`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNCOLOR

      .. _figure_OEImageTableOptions_SetStubColumnColor:

      .. figure:: depicttk/images/OEImageTableOptions_SetStubColumnColor.*
         :align:  center

         **Example of using the SetStubColumnColor method**

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::GetStubColumnColor` method

   .. oe:method:: SetStubColumnFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStubColumnFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetStubColumnFont(arg2: OEFont) -> None

      Sets the font used by the :oe:meth:`OEDepict::OEImageTable::DrawText`
      method to draw text on the 'stub column' cells.

      **Example** (:ref:`figure_OEImageTableOptions_SetStubColumnFont`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNFONT

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNFONT

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNFONT

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNFONT

      .. _figure_OEImageTableOptions_SetStubColumnFont:

      .. figure:: depicttk/images/OEImageTableOptions_SetStubColumnFont.*
         :align:  center

         **Example of using the SetStubColumnFont method**

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::GetStubColumnFont` method


:orphan:

.. oe:namespace:: OEDepict

.. _OEDepict_OEJavaImageBase:

.. oe:class:: OEJavaImageBase

   .. oe:api::

      class OEJavaImageBase extends OEImageBase

   The :ref:`OEJavaImageBase <OEDepict_OEJavaImageBase>` is an an implementation of
   :ref:`OEImageBase <OEDepict_OEImageBase>` that uses a
   `java.awt.Graphics <http://docs.oracle.com/javase/7/docs/api/java/awt/Graphics.html>`_
   object as a canvas to draw on.  This may be faster in some circumstances,
   since the JNI layer is avoided. 

   The following Java example demonstrates the usage of :ref:`OEJavaImageBase <OEDepict_OEJavaImageBase>`
   class.

   .. admonition:: Download code

      :download:`JavaImageBase.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/JavaImageBase.java>`
   

   The following methods are publicly inherited from :ref:`OEImageBase <OEDepict_OEImageBase>`:

   ========================================================================= ========================================================================== =========================================================================
   :oe:meth:`Clear<OEDepict::OEImageBase::Clear>`                            :oe:meth:`DrawPie<OEDepict::OEImageBase::DrawPie>`                         :oe:meth:`DrawTriangle<OEDepict::OEImageBase::DrawTriangle>`
   :oe:meth:`DrawArc<OEDepict::OEImageBase::DrawArc>`                        :oe:meth:`DrawPoint<OEDepict::OEImageBase::DrawPoint>`                     :oe:meth:`GetGlobalOffset<OEDepict::OEImageBase::GetGlobalOffset>`
   :oe:meth:`DrawCircle<OEDepict::OEImageBase::DrawCircle>`                  :oe:meth:`DrawPolygon<OEDepict::OEImageBase::DrawPolygon>`                 :oe:meth:`GetHeight<OEDepict::OEImageBase::GetHeight>`
   :oe:meth:`DrawCubicBezier<OEDepict::OEImageBase::DrawCubicBezier>`        :oe:meth:`DrawQuadraticBezier<OEDepict::OEImageBase::DrawQuadraticBezier>` :oe:meth:`GetMinFontSize<OEDepict::OEImageBase::GetMinFontSize>`
   :oe:meth:`DrawLine<OEDepict::OEImageBase::DrawLine>`                      :oe:meth:`DrawRectangle<OEDepict::OEImageBase::DrawRectangle>`             :oe:meth:`GetWidth<OEDepict::OEImageBase::GetWidth>`
   :oe:meth:`DrawPath<OEDepict::OEImageBase::DrawPath>`                      :oe:meth:`DrawText<OEDepict::OEImageBase::DrawText>`                       :oe:meth:`GetSVGClass<OEDepict::OEImageBase::GetSVGClass>`
   :oe:meth:`GetSVGGroup<OEDepict::OEImageBase::GetSVGGroup>`                :oe:meth:`NewSVGClass<OEDepict::OEImageBase::NewSVGClass>`                 :oe:meth:`NewSVGGroup<OEDepict::OEImageBase::NewSVGGroup>`
   :oe:meth:`PopGroup<OEDepict::OEImageBase::PopGroup>`                      :oe:meth:`PushGroup<OEDepict::OEImageBase::PushGroup>`                     :oe:meth:`SetMinFontSize<OEDepict::OEImageBase::SetMinFontSize>`
   ========================================================================= ========================================================================== =========================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:api::

         OEJavaImageBase(java.awt.Graphics graphics, double width,
                         double height)

      Default constructor that creates an :ref:`OEJavaImageBase <OEDepict_OEJavaImageBase>`
      with the specified width and height.

      graphics
         A java.awt.Graphics object.

      *width, height*
         The dimensions of the image, both have to be positive (non-zero)
         numbers.

   .. ################################################################
      # SetAntiAliasing
      ################################################################

   .. oe:method:: SetAntiAliasing

      .. oe:api::

         void SetAntiAliasing(boolean state)

      Enables or disables antialiasing on the Graphics object.  Antialiasing
      is on by default.
         
   .. ################################################################
      # GetAntiAliasing
      ################################################################

   .. oe:method:: GetAntiAliasing

      .. oe:api::

         boolean GetAntiAliasing()

      Returns a boolean indicating if antialiasing is on.

   .. ################################################################
      # GetGraphics
      ################################################################

   .. oe:method:: GetGraphics

      .. oe:api::

         Graphics GetGraphics()

      Returns the graphics object used to construct this object with.



.. |Bezier|    replace:: Bézier


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDepict

.. _OEDepict_OELegendLayout:

.. oe:class:: OELegendLayout

   .. oe:api::

      class OELegendLayout

   This class represents :ref:`OELegendLayout <OEDepict_OELegendLayout>` which is a
   layout manager that allows to create interactive legends in
   :file:`SVG` image format.

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>click on the "Legend" label</b>
         </p>

         <p align="center">
         <object data="../../_images/LegendLayout.svg" type="image/svg+xml"  width = "350" ></object>
         <p>

         <p align="center">
         <b>Example of legend layout</b>
         <p>

      .. image:: /_images/LegendLayout.svg
         :width: 1pt

      .. only:: oepdf

         |NOPDFIMAGE|

   .. seealso::

      * :ref:`OELegendLayoutOptions <OEDepict_OELegendLayoutOptions>` class
      * :oe:func:`OEDepict::OEDrawLegendLayout` function
      * :oe:constns:`OEDepict::OELegendLayoutStyle` namespace
      * :oe:constns:`OEDepict::OELegendColorStyle` namespace
      * :oe:constns:`OEDepict::OELegendInteractiveStyle` namespace

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELegendLayout(OEImageBase& parent, const std::string& text,
                           const OELegendLayoutOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            OELegendLayout(image: OEImageBase, buttontext: str,
                           opts: OELegendLayoutOptions) -> OELegendLayout

      Creates an :ref:`OELegendLayout <OEDepict_OELegendLayout>` object with the specified
      options.

      *parent*
          The :ref:`OEImageBase <OEDepict_OEImageBase>` object on which the
          :ref:`OELegendLayout <OEDepict_OELegendLayout>` object is placed.

      *text*
          The text of the button of the legend.

      *opts*
          The :ref:`OELegendLayoutOptions <OEDepict_OELegendLayoutOptions>` object that
          defines the properties and style of the legend layout.

      .. seealso::

         * :oe:meth:`OEDepict::OELegendLayout::GetOptions` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetLegendArea

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImage& GetLegendArea()

      .. oe:language:: python

         .. oe:api:: python

            GetLegendArea() -> OEImage

      Provides access to the legend area of the :ref:`OELegendLayout <OEDepict_OELegendLayout>`
      object.

      .. seealso::

          * :ref:`OEImage <OEDepict_OEImage>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OELegendLayoutOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OELegendLayoutOptions

      Returns the options used to initialized the :ref:`OELegendLayout <OEDepict_OELegendLayout>`
      object.

      .. seealso::

          * :ref:`OELegendLayoutOptions <OEDepict_OELegendLayoutOptions>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method: Render INTERNAL ONLY

      .. oe:api::

         bool Render()


.. oe:namespace:: OEDepict

.. _OEDepict_OELegendLayoutOptions:

.. oe:class:: OELegendLayoutOptions

   .. oe:api::

      class OELegendLayoutOptions

   This class represents the :ref:`OELegendLayoutOptions <OEDepict_OELegendLayoutOptions>` class
   that encapsulates properties that determine how an legend layout is depicted.

   The :ref:`OELegendLayoutOptions <OEDepict_OELegendLayoutOptions>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - legend layout style
        - :oe:meth:`GetLayoutStyle<OEDepict::OELegendLayoutOptions::GetLayoutStyle>`
        - (set by the constructor)
        - :oe:constns:`OEDepict::OELegendLayoutStyle` namespace

      * - legend color style
        - :oe:meth:`GetColorStyle<OEDepict::OELegendLayoutOptions::GetColorStyle>`
        - (set by the constructor)
        - :oe:constns:`OEDepict::OELegendColorStyle` namespace

      * - legend interactive style
        - :oe:meth:`GetInteractiveStyle<OEDepict::OELegendLayoutOptions::GetInteractiveStyle>`
        - (set by the constructor)
        - :oe:constns:`OEDepict::OELegendInteractiveStyle` namespace

      * - button label font
        - :oe:meth:`GetButtonFont<OEDepict::OELegendLayoutOptions::GetButtonFont>`
        - :oe:meth:`SetButtonFont<OEDepict::OELegendLayoutOptions::SetButtonFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - button pen(s)
        - :oe:meth:`GetButtonPen<OEDepict::OELegendLayoutOptions::GetButtonPen>`
        - :oe:meth:`SetButtonPen<OEDepict::OELegendLayoutOptions::SetButtonPen>`
        - :ref:`OEPen <OEDepict_OEPen>`

      * - button height scale
        - :oe:meth:`GetButtonHeightScale<OEDepict::OELegendLayoutOptions::GetButtonHeightScale>`
        - :oe:meth:`SetButtonHeightScale<OEDepict::OELegendLayoutOptions::SetButtonHeightScale>`
        - positive floating point number in the range of :math:`[0.5, 3.0]`

      * - button width scale
        - :oe:meth:`GetButtonWidthScale<OEDepict::OELegendLayoutOptions::GetButtonWidthScale>`
        - :oe:meth:`SetButtonWidthScale<OEDepict::OELegendLayoutOptions::SetButtonWidthScale>`
        - positive floating point number in the range of :math:`[0.5, 5.0]`

      * - legend box pen
        - :oe:meth:`GetLegendBoxPen<OEDepict::OELegendLayoutOptions::GetLegendBoxPen>`
        - :oe:meth:`SetLegendBoxPen<OEDepict::OELegendLayoutOptions::SetLegendBoxPen>`
        - :ref:`OEPen <OEDepict_OEPen>`

      * - layout margins
        - :oe:meth:`GetMargin<OEDepict::OELegendLayoutOptions::GetMargin>`
        - :oe:meth:`SetMargin<OEDepict::OELegendLayoutOptions::SetMargin>` / :oe:meth:`SetMargins<OEDepict::OELegendLayoutOptions::SetMargins>`
        - positive floating point number in the range of :math:`[0.0, 90.0]`

   .. seealso::

      * :ref:`OELegendLayout <OEDepict_OELegendLayout>` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELegendLayoutOptions(unsigned int layout = OELegendLayoutStyle::Default,
                                  unsigned int color = OELegendColorStyle::Default,
                                  unsigned int inter = OELegendInteractiveStyle::Default)

      .. oe:language:: python

         .. oe:api:: python

            OELegendLayoutOptions(layout: int, color: int, inter: int) -> OELegendLayoutOptions

      .. seealso::

         * :oe:constns:`OEDepict::OELegendLayoutStyle` namespace
         * :oe:constns:`OEDepict::OELegendColorStyle` namespace
         * :oe:constns:`OEDepict::OELegendInteractiveStyle` namespace

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELegendLayoutOptions(const OELegendLayoutOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OELegendLayoutOptions(arg2: OELegendLayoutOptions) -> OELegendLayoutOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELegendLayoutOptions &operator=(const OELegendLayoutOptions &rhs)

      Assignment operator.

   .. oe:method:: GetButtonFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFont& GetButtonFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetButtonFont() -> OEFont

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OELegendLayoutOptions::SetButtonFont` method

   .. oe:method:: GetButtonHeightScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetButtonHeightScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetButtonHeightScale() -> float

      .. seealso::

         * :oe:meth:`OEDepict::OELegendLayoutOptions::SetButtonHeightScale` method

   .. oe:method:: GetButtonPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEPen& GetButtonPen(bool on) const

      .. oe:language:: python

         .. oe:api:: python

            GetButtonPen(on: bool) -> OEPen

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEDepict::OELegendLayoutOptions::SetButtonPen` method

   .. oe:method:: GetButtonWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetButtonWidthScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetButtonWidthScale() -> float

      .. seealso::

         * :oe:meth:`OEDepict::OELegendLayoutOptions::SetButtonWidthScale` method

   .. oe:method:: GetColorStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetColorStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorStyle() -> int

      .. seealso::

         * :oe:constns:`OEDepict::OELegendColorStyle` namespace

   .. oe:method:: GetInteractiveStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetInteractiveStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetInteractiveStyle() -> int

      .. seealso::

         * :oe:constns:`OEDepict::OELegendInteractiveStyle` namespace

   .. oe:method:: GetLayoutStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetLayoutStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetLayoutStyle() -> int

      .. seealso::

         * :oe:constns:`OEDepict::OELegendLayoutStyle` namespace

   .. oe:method:: GetLegendBoxPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEPen& GetLegendBoxPen() const

      .. oe:language:: python

         .. oe:api:: python

            GetLegendBoxPen() -> OEPen

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEDepict::OELegendLayoutOptions::SetLegendBoxPen` method

   .. oe:method:: GetMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMargin(unsigned int percent) const

      .. oe:language:: python

         .. oe:api:: python

            GetMargin(percent: int) -> float

      Returns the ratio of a specific margin of the legend layout.

      *margin*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OELegendLayoutOptions::SetMargin` method
         * :oe:meth:`OEDepict::OELegendLayoutOptions::SetMargins` method

   .. oe:method:: SetButtonFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetButtonFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetButtonFont(font: OEFont) -> None

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OELegendLayoutOptions::GetButtonFont` method

   .. oe:method:: SetButtonHeightScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetButtonHeightScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetButtonHeightScale(s: float) -> None

      .. seealso::

         * :oe:meth:`OEDepict::OELegendLayoutOptions::GetButtonHeightScale` method

   .. oe:method:: SetButtonPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetButtonPen(const OEPen& pen, bool on)

      .. oe:language:: python

         .. oe:api:: python

            SetButtonPen(pen: OEPen, on: bool) -> None

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEDepict::OELegendLayoutOptions::GetButtonPen` method

   .. oe:method:: SetButtonWidthScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetButtonWidthScale(double s)

      .. oe:language:: python

         .. oe:api:: python

            SetButtonWidthScale(s: float) -> None

      .. seealso::

         * :oe:meth:`OEDepict::OELegendLayoutOptions::GetButtonWidthScale` method

   .. oe:method:: SetLegendBoxPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLegendBoxPen(const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            SetLegendBoxPen(pen: OEPen) -> None

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEDepict::OELegendLayoutOptions::GetLegendBoxPen` method

   .. oe:method:: SetMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMargin(unsigned int margin, double percent)

      .. oe:language:: python

         .. oe:api:: python

            SetMargin(margin: int, percent: float) -> bool

      Sets the size of a specific margin of the legend layout.

      *marginloc*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      *margin*
         This number is considered as a percentage of either the width or the height
         of image on which the legend layout will be drawn and has to be in the range of :math:`[0.0, 90.0]`.
         For example, 10.0% means, that the left and right margin
         are 10% of the total width of the image, and the top and bottom margins
         are 10% of the total height of the image.

      .. seealso::

         * :oe:meth:`OEDepict::OELegendLayoutOptions::GetMargin` method
         * :oe:meth:`OEDepict::OELegendLayoutOptions::SetMargins` method

   .. oe:method:: SetMargins

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMargins(double margin)

      .. oe:language:: python

         .. oe:api:: python

            SetMargins(percent: float) -> bool

      Sets the size of all margins of the legend layout.

      *margin*
         This number is considered as a percentage of either the width or the height
         of image on which the legend layout will be drawn and has to be in the range of :math:`[0.0, 90.0]`.
         For example, 10.0% means, that the left and right margin
         are 10% of the total width of the image, and the top and bottom margins
         are 10% of the total height of the image.

      .. seealso::

         * :oe:meth:`OEDepict::OELegendLayoutOptions::GetMargin` method
         * :oe:meth:`OEDepict::OELegendLayoutOptions::SetMargin` method


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEMolDisplayBase, MolDisplayBase

.. _OEDepict_OEMolDisplayBase:

.. oe:class:: OEMolDisplayBase

   .. oe:api::

      class OEMolDisplayBase : public OESystem::OEBase

   The :ref:`OEMolDisplayBase <OEDepict_OEMolDisplayBase>` class is the abstract
   interface for representing molecule display information
   within **OEDepict TK**.
   See :ref:`Figure: OEDepict TK molecule display class hierarchy<figure_OEMolDisplayBase_Hierarchy>`.

   .. _figure_OEMolDisplayBase_Hierarchy:

   .. figure:: depicttk/images/OEDisplayHierarchy.*
      :align:  center

      **OEDepict TK molecule display class hierarchy**

   .. seealso::

      * :ref:`OEAtomDisplayBase <OEDepict_OEAtomDisplayBase>` class
      * :ref:`OEBondDisplayBase <OEDepict_OEBondDisplayBase>` class

   The following classes derive from this class:
    * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolDisplayBase & operator=(const OEMolDisplayBase &)

      Assignment operator.

   .. ################################################################
      # GetDataType
      ################################################################

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

      This function is used to perform run-time type
      identification.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::GetDataType` method in the **OEChem TK** manual

   .. ################################################################
      # GetMolecule
      ################################################################

   .. oe:method:: GetMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase* GetMolecule() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolecule() -> OEGraphMol

      Returns the const pointer of the :ref:`OEMolBase <OEChem_OEMolBase>`
      object for which the display properties are stored in the class derived
      from the :ref:`OEMolDisplayBase <OEDepict_OEMolDisplayBase>` abstract class.

   .. ################################################################
      # IsDataType
      ################################################################

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

      Returns whether type is the same as the instance this method is
      called on.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::IsDataType` method in the **OEChem TK** manual


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEMultiPageImageFile, MultiPageImageFile

.. _OEDepict_OEMultiPageImageFile:

.. oe:class:: OEMultiPageImageFile

   .. oe:api::

      class OEMultiPageImageFile

   The :ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` class supports the
   creation of multi-page images. The dimensions and orientation of
   the pages are determined when an
   :ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` object is created.
   Pages are created by calling the
   :oe:meth:`OEDepict::OEMultiPageImageFile::NewPage` method.
   See :ref:`Figure: Schematic representation of an OEMultiPageImageFile object<figure_OEMultiPageImageFile>`.

   .. _figure_OEMultiPageImageFile:

   .. figure:: depicttk/images/OEMultiPageImageFile.*
      :align:  center

      **Schematic representation of an OEMultiPageImageFile object**

   .. seealso::

      * :ref:`chapter_multipage` chapter
      * :oe:func:`OEDepict::OEGetSupportedMultiPageImageFileExtensions` function

   .. hint::

       We highly recommend to usage of the more convenient high-level
       :ref:`OEReport <OEDepict_OEReport>` class when generating multi-page images.

       * :ref:`section_multipage_report` section
       * :ref:`section_examples_summary_mols2pdf` example
       * :ref:`section_examples_summary_viewmdlsearch` example

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMultiPageImageFile(double pagewidth, double pageheight)

      .. oe:language:: python

         .. oe:api:: python

            OEMultiPageImageFile(width: float, height: float) -> OEMultiPageImageFile

      Creates an :ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` object with a
      specified page width and height.
      Both the width and the height parameters have to be positive
      (non-zero) numbers.

      .. ################################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMultiPageImageFile(unsigned int orientation,
                                 unsigned int imagesize)

      .. oe:language:: python

         .. oe:api:: python

            OEMultiPageImageFile(orientation: int, imagesize: int) -> OEMultiPageImageFile

      Creates an :ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` object with
      the given orientation and size.

      *orientation*
         Determine the orientation of the pages. 
         This value has to be from the
         :oe:constns:`OEDepict::OEPageOrientation` namespace.

      *imagesize*
         Determine the width and height of the pages. 
         This value has to be from the :oe:constns:`OEDepict::OEPageSize`
         namespace.

      .. seealso::

         * :oe:func:`OEDepict::OEGetPageHeight` function
         * :oe:func:`OEDepict::OEGetPageWidth` function

   .. ################################################################
      # GetOrientation
      ################################################################

   .. oe:method:: GetOrientation

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetOrientation() const

      .. oe:language:: python

         .. oe:api:: python

            GetOrientation() -> int

      Returns the orientation of the pages.
      The return value is taken from the
      :oe:constns:`OEDepict::OEPageOrientation` namespace.

   .. ################################################################
      # GetPageHeight
      ################################################################

   .. oe:method:: GetPage

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImage* GetPage(unsigned int page)
            const OEImage* GetPage(unsigned int page) const

      .. oe:language:: python

         .. oe:api:: python

            GetPage(page: int) -> OEImage

      Returns the :math:`p^{th}` page .

      *p*
         This value has to be in the range from `1` to
         :oe:meth:`OEDepict::OEMultiPageImageFile::NumPages()<OEDepict::OEMultiPageImageFile::NumPages>`.

      .. note::

         If :math:`p` page index is out of range, then the
         :oe:meth:`OEDepict::OEMultiPageImageFile::GetPage` method
         returns a NULL pointer.

   .. ################################################################
      # GetPageHeight
      ################################################################

   .. oe:method:: GetPageHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPageHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetPageHeight() -> float

      Returns the height of the pages.

   .. ################################################################
      # GetPageWidth
      ################################################################

   .. oe:method:: GetPageWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPageWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetPageWidth() -> float

      Returns the width of the pages.

   .. ################################################################
      # GetPages
      ################################################################

   .. oe:method:: GetPages

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEImage>* GetPages()
            OESystem::OEIterBase<const OEImage>* GetPages() const

      .. oe:language:: python

         .. oe:api:: python

            GetPages() -> Iterable[OEImage]

      Returns an iterator over all pages stored in the
      :ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` object.

   .. ################################################################
      # NewPage
      ################################################################

   .. oe:method:: NewPage

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImage& NewPage()

      .. oe:language:: python

         .. oe:api:: python

            NewPage() -> OEImage

      Returns a new page as an :ref:`OEImage <OEDepict_OEImage>` object.

   .. ################################################################
      # NumPages
      ################################################################

   .. oe:method:: NumPages

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumPages() const

      .. oe:language:: python

         .. oe:api:: python

            NumPages() -> int

      Returns the number of pages stored in the
      :ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` object.


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OENearestAtom, NearestAtom

.. _OEDepict_OENearestAtom:

.. oe:class:: OENearestAtom

   .. oe:api::

      class OENearestAtom

   The :ref:`OENearestAtom <OEDepict_OENearestAtom>` class that is used by
   :oe:func:`OEDepict::OEGetNearestAtom` and
   :oe:func:`OEDepict::OEGetNearbyAtom` functions.
   It stores an atom pointer, an associated distance and the
   display position of the atom.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENearestAtom(const OEChem::OEAtomBase* atom, double distance)
            OENearestAtom(const OEChem::OEAtomBase* atom, double distance,
                          const OE2DPoint& displaypos)

      .. oe:language:: python

         .. oe:api:: python

            OENearestAtom() -> OENearestAtom
            OENearestAtom(atom: OEAtomBase, dist: float) -> OENearestAtom
            OENearestAtom(atom: OEAtomBase, dist: float, pos: OE2DPoint) -> OENearestAtom
            OENearestAtom(arg2: OENearestAtom) -> OENearestAtom

      Constructors.

      If no display position is given then it will be initialized to
      `OE2DPoint(0.0, 0.0)`.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OENearestAtom & operator=(const OENearestAtom &)

      Assignment operator.

   .. ################################################################
      # GetAtom
      ################################################################

   .. oe:method:: GetAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEAtomBase* GetAtom() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtom() -> OEAtomBase

      Returns the atom pointer stored in the
      :ref:`OENearestAtom <OEDepict_OENearestAtom>` object.

   .. ################################################################
      # GetDisplayPosition
      ################################################################

   .. oe:method:: GetDisplayPosition

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OE2DPoint& GetDisplayPosition() const

      .. oe:language:: python

         .. oe:api:: python

            GetDisplayPosition() -> OE2DPoint

      Returns the display position of the nearest atom.

   .. ################################################################
      # GetDist
      ################################################################

   .. oe:method:: GetDist

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDist() const

      .. oe:language:: python

         .. oe:api:: python

            GetDist() -> float

      Returns the distance associated with the atom.

   .. ################################################################
      # IsValid
      ################################################################

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OENearestAtom <OEDepict_OENearestAtom>` object is
      initialized correctly.


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OENearestBond, NearestBond

.. _OEDepict_OENearestBond:

.. oe:class:: OENearestBond

   .. oe:api::

      class OENearestBond

   The :ref:`OENearestBond <OEDepict_OENearestBond>` class, used by
   :oe:func:`OEDepict::OEGetNearestBond` and
   :oe:func:`OEDepict::OEGetNearbyBond` functions.
   It stores a bond pointer, the associated distance and
   the display position of the bond.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENearestBond()
            OENearestBond(const OEChem::OEBondBase* bond, double dist)
            OENearestBond(const OEChem::OEBondBase* bond, double dist,
                          const OE2DPoint& pos)
            OENearestBond(const OENearestBond&)

      .. oe:language:: python

         .. oe:api:: python

            OENearestBond() -> OENearestBond
            OENearestBond(bond: OEBondBase, dist: float) -> OENearestBond
            OENearestBond(bond: OEBondBase, dist: float, pos: OE2DPoint) -> OENearestBond
            OENearestBond(arg2: OENearestBond) -> OENearestBond

      Constructors.

      If no display position is given then it will be initialized to
      `OE2DPoint(0.0, 0.0)`.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OENearestBond & operator=(const OENearestBond &)

      Assignment operator.

   .. ################################################################
      # GetBond
      ################################################################

   .. oe:method:: GetBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEBondBase* GetBond() const

      .. oe:language:: python

         .. oe:api:: python

            GetBond() -> OEBondBase

      Returns the bond pointer stored in the
      :ref:`OENearestBond <OEDepict_OENearestBond>` object.

   .. ################################################################
      # GetDisplayPosition
      ################################################################

   .. oe:method:: GetDisplayPosition

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OE2DPoint& GetDisplayPosition() const

      .. oe:language:: python

         .. oe:api:: python

            GetDisplayPosition() -> OE2DPoint

      Returns the display position of the middle of the nearest bond.

   .. ################################################################
      # GetDist
      ################################################################

   .. oe:method:: GetDist

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDist() const

      .. oe:language:: python

         .. oe:api:: python

            GetDist() -> float

      Returns the distance associated with the bond.

   .. ################################################################
      # IsValid
      ################################################################

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OENearestBond <OEDepict_OENearestBond>` object is
      initialized correctly.



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEPen

.. _OEDepict_OEPen:

.. oe:class:: OEPen

   .. oe:api::

      class OEPen

   The :ref:`OEPen <OEDepict_OEPen>` class encapsulates properties that
   determine the way various lines, curves and shapes are drawn.

   Currently the :ref:`OEPen <OEDepict_OEPen>` class stores the following properties:

   .. list-table::
      :widths: 60 150 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace/class
      * - background color
        - :oe:meth:`OEDepict::OEPen::GetBackColor`
        - :oe:meth:`OEDepict::OEPen::SetBackColor`
        - :ref:`OEColor <OESystem_OEColor>`
      * - foreground color
        - :oe:meth:`OEDepict::OEPen::GetForeColor`
        - :oe:meth:`OEDepict::OEPen::SetForeColor`
        - :ref:`OEColor <OESystem_OEColor>`
      * - fill
        - :oe:meth:`OEDepict::OEPen::GetFill`
        - :oe:meth:`OEDepict::OEPen::SetFill`
        - :oe:constns:`OEDepict::OEFill`
      * - line join
        - :oe:meth:`OEDepict::OEPen::GetLineJoin`
        - :oe:meth:`OEDepict::OEPen::SetLineJoin`
        - :oe:constns:`OEDepict::OELineJoin`
      * - line cap
        - :oe:meth:`OEDepict::OEPen::GetLineCap`
        - :oe:meth:`OEDepict::OEPen::SetLineCap`
        - :oe:constns:`OEDepict::OELineCap`
      * - line width
        - :oe:meth:`OEDepict::OEPen::GetLineWidth`
        - :oe:meth:`OEDepict::OEPen::SetLineWidth`
        - none
      * - line stipple
        - :oe:meth:`OEDepict::OEPen::SetLineStipple`
        - :oe:meth:`OEDepict::OEPen::GetLineStipple`
        - :oe:constns:`OEDepict::OEStipple`
      * - stipple factor
        - :oe:meth:`OEDepict::OEPen::SetStippleFactor`
        - :oe:meth:`OEDepict::OEPen::GetStippleFactor`
        - none

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPen()

      .. oe:language:: python

         .. oe:api:: python

            OEPen() -> OEPen

      Default constructor that initializes an :ref:`OEPen <OEDepict_OEPen>`
      object with the following properties:

      .. list-table::  Default parameters of OEPen
         :widths: 100 100
         :header-rows: 1

         * - Property
           - Default value
         * - background color
           - :oe:const:`OEWhite<OESystem::OESystem::OEWhite>` = OEColor(255,255,255)
         * - foreground color
           - :oe:const:`OEBlack<OESystem::OESystem::OEBlack>` = OEColor(0,0,0)
         * - fill
           - :oe:const:`OEDepict::OEFill::Default`
         * - line join
           - :oe:const:`OEDepict::OELineJoin::Default`
         * - line cap
           - :oe:const:`OEDepict::OELineCap::Default`
         * - line width
           - 1.0
         * - line stipple
           - :oe:const:`OEDepict::OEStipple::Default`
         * - stipple factor
           - 1

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPen(const OESystem::OEColor& bg, const OESystem::OEColor& fg,
                  unsigned int fill = OEFill::Off, double linewidth = 1.0,
                  unsigned short stipple = OEStipple::Solid)

      .. oe:language:: python

         .. oe:api:: python

            OEPen(bg: OEColor, fg: OEColor, fill: int, linewidth: float = 1.0,
                  stipple: short) -> OEPen

      Creates and initializes an :ref:`OEPen <OEDepict_OEPen>` object
      with the given parameters. The other properties of the pen
      are set to the default values (see table above).

      *bg, fg*
         The background and foreground color of the pen.

      *fill*
         The *fill* property of the pen.

      *linewidth*
          The *line width* property of the pen.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPen(const OEPen& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEPen(arg2: OEPen) -> OEPen

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPen &operator=(const OEPen &rhs)

      Assignment operator.

   .. ################################################################
      #  operator!=
      ################################################################

   .. oe:method:: operator!=
      :language: c++

      .. oe:api::

         bool operator!=(const OEPen &) const

      Determines whether two :ref:`OEPen <OEDepict_OEPen>` objects are
      different.
      Two :ref:`OEPen <OEDepict_OEPen>` objects are considered different,
      if any of their properties (such as line width, background color,
      etc.) are different.

   .. ################################################################
      # operator==
      ################################################################

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEPen &) const

      Determines whether two :ref:`OEPen <OEDepict_OEPen>` objects are
      equal.
      Two :ref:`OEPen <OEDepict_OEPen>` objects are considered equivalent
      only if all of their properties (such as line width, background
      color, etc.) are identical.

   .. ################################################################
      # GetBackColor
      ################################################################

   .. oe:method:: GetBackColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetBackColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetBackColor() -> OEColor

      Returns the background color of the :ref:`OEPen <OEDepict_OEPen>`
      object that is used to fill shapes.

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::SetBackColor` method
         * :oe:meth:`OEDepict::OEPen::SetFill` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. ################################################################
      # GetFill
      ################################################################

   .. oe:method:: GetFill

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFill() const

      .. oe:language:: python

         .. oe:api:: python

            GetFill() -> int

      If the returned value is :oe:const:`OEDepict::OEFill::On`, than
      shapes drawn with the :ref:`OEPen <OEDepict_OEPen>` object are filled with
      the background color of the pen.
      If the returned value is :oe:const:`OEDepict::OEFill::Off`, than
      shapes drawn with the :ref:`OEPen <OEDepict_OEPen>` object are left
      "empty" *i.e.* only their outlines are drawn using the
      foreground color of the pen.

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::SetFill` method
         * :oe:meth:`OEDepict::OEPen::SetBackColor` method
         * :oe:constns:`OEDepict::OEFill` namespace

   .. ################################################################
      # GetForeColor
      ################################################################

   .. oe:method:: GetForeColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetForeColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetForeColor() -> OEColor

      Returns the foreground color of the :ref:`OEPen <OEDepict_OEPen>`
      object that controls the color of the strokes when drawing lines,
      curves and outlines of shapes.

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::SetForeColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. ################################################################
      # GetLineCap
      ################################################################

   .. oe:method:: GetLineCap

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetLineCap() const

      .. oe:language:: python

         .. oe:api:: python

            GetLineCap() -> int

      Returns the *line cap* property of the :ref:`OEPen <OEDepict_OEPen>`
      object that controls how the endpoints of lines are drawn.
      The return value is taken from the :oe:constns:`OEDepict::OELineCap`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::SetLineCap` method
         * :oe:constns:`OEDepict::OELineCap` namespace

   .. ################################################################
      # GetLineJoin
      ################################################################

   .. oe:method:: GetLineJoin

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetLineJoin() const

      .. oe:language:: python

         .. oe:api:: python

            GetLineJoin() -> int

      Returns the *line join* property of the :ref:`OEPen <OEDepict_OEPen>`
      object that controls how lines connect at corners when drawing
      outlines.
      The return value is taken from the :oe:constns:`OEDepict::OELineJoin`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::SetLineJoin` method
         * :oe:constns:`OEDepict::OELineJoin` namespace

   .. ################################################################
      # GetLineStipple
      ################################################################

   .. oe:method:: GetLineStipple

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned short GetLineStipple() const

      .. oe:language:: python

         .. oe:api:: python

            GetLineStipple() -> short

      Returns the *line stipple* property of the :ref:`OEPen <OEDepict_OEPen>`
      object that controls the pattern of dashes and gaps used to draw
      lines and outlines.
      The return value is taken from the :oe:constns:`OEDepict::OEStipple`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::SetLineStipple` method
         * :oe:meth:`OEDepict::OEPen::SetStippleFactor` method
         * :oe:constns:`OEDepict::OEStipple` namespace

   .. ################################################################
      # GetLineWidth
      ################################################################

   .. oe:method:: GetLineWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLineWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetLineWidth() -> float

      Returns the *line width* of the :ref:`OEPen <OEDepict_OEPen>` object
      that controls the width of strokes used when drawing lines, curves
      and outlines of shapes.

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::SetLineWidth` method

   .. ################################################################
      # GetStippleFactor
      ################################################################

   .. oe:method:: GetStippleFactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned short GetStippleFactor() const

      .. oe:language:: python

         .. oe:api:: python

            GetStippleFactor() -> short

      Returns the *stipple factor* of the :ref:`OEPen <OEDepict_OEPen>` object.
      The stipple factor is a multiplier that is used when drawing
      stipple patterns. For example, if the factor is three, then the
      stipple pattern is stretched to three times of its original size.

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::SetStippleFactor` method
         * :oe:meth:`OEDepict::OEPen::SetLineStipple` method

   .. ################################################################
      # SetBackColor
      ################################################################

   .. oe:method:: SetBackColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBackColor(const OESystem::OEColor& col)

      .. oe:language:: python

         .. oe:api:: python

            SetBackColor(col: OEColor) -> None

      Sets the background color of the :ref:`OEPen <OEDepict_OEPen>`
      object that is used to fill shapes.

      Example (:ref:`Figure: Example of using the SetBackColor method<figure_OEPen_SetBackColor>`)

      .. oe:source:: OEPen_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-BACKCOLOR

      .. oe:source:: OEPen_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-BACKCOLOR

      .. oe:source:: OEPen_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-BACKCOLOR

      .. oe:source:: OEPen_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-BACKCOLOR

      .. _figure_OEPen_SetBackColor:

      .. figure:: depicttk/images/OEPen_SetBackColor.*
         :align:  center

         **Example of using the SetBackColor method**

      .. note::

         In order to fill a shape using the background color, the fill
         property of the :ref:`OEPen <OEDepict_OEPen>` has to be turned on
         (:oe:const:`OEDepict::OEFill::On`).
         (See :oe:meth:`OEDepict::OEPen::SetFill` method and
         :oe:constns:`OEDepict::OEFill` namespace)

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::GetBackColor` method
         * :oe:meth:`OEDepict::OEPen::GetFill` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. ################################################################
      # SetFill
      ################################################################

   .. oe:method:: SetFill

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFill(unsigned int fill)

      .. oe:language:: python

         .. oe:api:: python

            SetFill(f: int) -> None

      Sets the *fill* property of the :ref:`OEPen <OEDepict_OEPen>` object.

      *fill*
         This value has to be from the :oe:constns:`OEDepict::OEFill`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::GetFill` method
         * :oe:meth:`OEDepict::OEPen::GetBackColor` method
         * :oe:constns:`OEDepict::OEFill` namespace

   .. ################################################################
      # SetForeColor
      ################################################################

   .. oe:method:: SetForeColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetForeColor(const OESystem::OEColor& col)

      .. oe:language:: python

         .. oe:api:: python

            SetForeColor(col: OEColor) -> None

      Sets the foreground color of the :ref:`OEPen <OEDepict_OEPen>`
      object that controls the color of the stroke when drawing lines,
      curves and outlines of shapes.

      Example (:ref:`Figure: Example of using the SetForeColor method<figure_OEPen_SetForeColor>`)

      .. oe:source:: OEPen_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-FORECOLOR

      .. oe:source:: OEPen_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-FORECOLOR

      .. oe:source:: OEPen_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-FORECOLOR

      .. oe:source:: OEPen_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-FORECOLOR

      .. _figure_OEPen_SetForeColor:

      .. figure:: depicttk/images/OEPen_SetForeColor.*
         :align:  center

         **Example of using the SetForeColor method**

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::GetForeColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. ################################################################
      # SetLineCap
      ################################################################

   .. oe:method:: SetLineCap

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLineCap(unsigned int cap)

      .. oe:language:: python

         .. oe:api:: python

            SetLineCap(cap: int) -> None

      Sets the *line cap* property of the :ref:`OEPen <OEDepict_OEPen>`
      object that controls how the endpoints of lines are drawn.

      *cap*
         This value has to be from the :oe:constns:`OEDepict::OELineCap`
         namespace.

      Example (:ref:`Figure: Example of using the SetLineCap method<figure_OEPen_SetLineCap>`)

      .. oe:source:: OEPen_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINECAP

      .. oe:source:: OEPen_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINECAP

      .. oe:source:: OEPen_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINECAP

      .. oe:source:: OEPen_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINECAP

      .. _figure_OEPen_SetLineCap:

      .. figure:: depicttk/images/OEPen_SetLineCap.*
         :align:  center

         **Example of using the SetLineCap method**

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::GetLineCap` method
         * :oe:constns:`OEDepict::OELineCap` namespace

   .. ################################################################
      # SetLineJoin
      ################################################################

   .. oe:method:: SetLineJoin

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLineJoin(unsigned int join)

      .. oe:language:: python

         .. oe:api:: python

            SetLineJoin(join: int) -> None

      Sets the *line join* property of the :ref:`OEPen <OEDepict_OEPen>`
      object that controls how lines connect at corners when drawing
      outlines.

      *join*
         This value has to be from the :oe:constns:`OEDepict::OELineJoin`
         namespace.

      Example (:ref:`Figure: Example of using the SetLineJoin method<figure_OEPen_SetLineJoin>`)

      .. oe:source:: OEPen_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINEJOIN

      .. oe:source:: OEPen_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINEJOIN

      .. oe:source:: OEPen_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINEJOIN

      .. oe:source:: OEPen_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINEJOIN

      .. _figure_OEPen_SetLineJoin:

      .. figure:: depicttk/images/OEPen_SetLineJoin.*
         :align:  center

         **Example of using the SetLineJoin method**

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::GetLineJoin` method
         * :oe:constns:`OEDepict::OELineJoin` namespace

   .. ################################################################
      # SetLineStipple
      ################################################################

   .. oe:method:: SetLineStipple

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLineStipple(unsigned short pattern)

      .. oe:language:: python

         .. oe:api:: python

            SetLineStipple(p: short) -> None

      Sets the *line stipple* property of the :ref:`OEPen <OEDepict_OEPen>`
      object that controls the pattern of dashes and gaps used to draw
      lines and outlines.

      *pattern*
         This value has to be from the :oe:constns:`OEDepict::OEStipple`
         namespace.

      Example (:ref:`Figure: Example of using the SetLineStipple method<figure_OEPen_SetLineStipple>`)

      .. oe:source:: OEPen_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINE-STIPPLE

      .. oe:source:: OEPen_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINE-STIPPLE

      .. oe:source:: OEPen_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINE-STIPPLE

      .. oe:source:: OEPen_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINE-STIPPLE

      .. _figure_OEPen_SetLineStipple:

      .. figure:: depicttk/images/OEPen_SetLineStipple.*
         :align:  center

         **Example of using the SetLineStipple method**

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::SetLineStipple` method
         * :oe:meth:`OEDepict::OEPen::SetStippleFactor` method
         * :oe:constns:`OEDepict::OEStipple` namespace

   .. oe:method:: SetLineWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLineWidth(double width)

      .. oe:language:: python

         .. oe:api:: python

            SetLineWidth(w: float) -> None

      Sets the *line width* of the :ref:`OEPen <OEDepict_OEPen>` object
      that controls the width of strokes used when drawing lines, curves
      and outlines of shapes.

      *width*
         This value has to be a positive number.

      Example (:ref:`Figure: Example of using the SetLineWidth method<figure_OEPen_SetLineWidth>`)

      .. oe:source:: OEPen_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINE-WIDTH

      .. oe:source:: OEPen_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINE-WIDTH

      .. oe:source:: OEPen_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINE-WIDTH

      .. oe:source:: OEPen_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-LINE-WIDTH

      .. _figure_OEPen_SetLineWidth:

      .. figure:: depicttk/images/OEPen_SetLineWidth.*
         :align:  center

         **Example of using the SetLineWidth method**

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::GetLineWidth` method

   .. oe:method:: SetStippleFactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStippleFactor(unsigned short factor)

      .. oe:language:: python

         .. oe:api:: python

            SetStippleFactor(f: short) -> None

      Sets the *stipple factor* of the :ref:`OEPen <OEDepict_OEPen>` object.
      The stipple factor is a multiplier that is used when drawing
      stipple patterns.

      Example (:ref:`Figure: Example of using the SetStippleFactor method<figure_OEPen_SetStippleFactor>`)

      .. oe:source:: OEPen_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-STIPPLE-FACTOR

      .. oe:source:: OEPen_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-STIPPLE-FACTOR

      .. oe:source:: OEPen_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-STIPPLE-FACTOR

      .. oe:source:: OEPen_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEPEN-SET-STIPPLE-FACTOR

      .. _figure_OEPen_SetStippleFactor:

      .. figure:: depicttk/images/OEPen_SetStippleFactor.*
         :align:  center

         **Example of using the SetStippleFactor method**

      .. seealso::

         * :oe:meth:`OEDepict::OEPen::GetStippleFactor` method
         * :oe:meth:`OEDepict::OEPen::GetLineStipple` method


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEPrepareDepictionOptions, PrepareDepictionOptions

.. _OEDepict_OEPrepareDepictionOptions:

.. oe:class:: OEPrepareDepictionOptions

   .. oe:api::

      class OEPrepareDepictionOptions

   This class represents :ref:`OEPrepareDepictionOptions <OEDepict_OEPrepareDepictionOptions>` that
   stores the following parameters that are used when preparing a molecule
   for depiction.

   .. list-table::
      :widths: 150 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / type

      * - re-generating 2D coordinates
        - :oe:meth:`GetClearCoords<OEDepict::OEPrepareDepictionOptions::GetClearCoords>`
        - :oe:meth:`SetClearCoords<OEDepict::OEPrepareDepictionOptions::SetClearCoords>`
        - boolean

      * - adding depiction hydrogens
        - :oe:meth:`GetAddDepictionHydrogens<OEDepict::OEPrepareDepictionOptions::GetAddDepictionHydrogens>`
        - :oe:meth:`SetAddDepictionHydrogens<OEDepict::OEPrepareDepictionOptions::SetAddDepictionHydrogens>`
        - boolean

      * - perceiving MDL bond stereo (wedge/hash)
        - :oe:meth:`GetPerceiveBondStereo<OEDepict::OEPrepareDepictionOptions::GetPerceiveBondStereo>`
        - :oe:meth:`SetPerceiveBondStereo<OEDepict::OEPrepareDepictionOptions::SetPerceiveBondStereo>`
        - boolean

      * - suppressing explicit (non-depiction) hydrogens
        - :oe:meth:`GetSuppressHydrogens<OEDepict::OEPrepareDepictionOptions::GetSuppressHydrogens>`
        - :oe:meth:`SetSuppressHydrogens<OEDepict::OEPrepareDepictionOptions::SetSuppressHydrogens>`
        - boolean

      * - depiction orientation
        - :oe:meth:`GetDepictOrientation<OEDepict::OEPrepareDepictionOptions::GetDepictOrientation>`
        - :oe:meth:`SetDepictOrientation<OEDepict::OEPrepareDepictionOptions::SetDepictOrientation>`
        - :oe:constns:`OEDepict::OEDepictOrientation`

      * - algorithmic macrocycle ring depiction
        - :oe:meth:`GetOptimizeMacrocycles<OEDepict::OEPrepareDepictionOptions::GetOptimizeMacrocycles>`
        - :oe:meth:`SetOptimizeMacrocycles<OEDepict::OEPrepareDepictionOptions::SetOptimizeMacrocycles>`
        - boolean

   .. seealso::

      * :oe:func:`OEDepict::OEPrepareDepiction` function

   See the effect of the above parameters in :ref:`Table: Depictions generated with various parameter combinations <table_OEPrepareDepictionOptions>`
   when depiction are generated from the following input:

   **SMILES**
     Parsing the "CC([C@@H]1C[C@@H]2C[C@H]1NC2)N(H)(H)" string with three explicit hydrogens necessary
     to define tetrahedral stereo centers and two additional explicit hydrogens.

   **MDL**
     Reading an MDL file with 2D coordinates and pre-assigned wedge/hash bonds.
     It also includes two explicit hydrogens.

   .. _table_OEPrepareDepictionOptions:

   .. list-table:: **Depictions generated with various parameter combinations**
      :widths: 10 20 20 20 20 30 30
      :header-rows: 1

      * - index
        - clear coordinates
        - suppress explicit H
        - add depict H
        - perceive wedge/hash
        - from SMILES
        - from MDL

      * - **(1)**
        - F
        - F
        - F
        - F
        - .. image:: ../images/OEPrepDepictOpts-SMI-cc-0-sH-0-aH-0-pBS-0.*
        - .. image:: ../images/OEPrepDepictOpts-MDL-cc-0-sH-0-aH-0-pBS-0.*

      * - **(2)**
        - F
        - F
        - F
        - **T**
        -
        -

      * - **(3)**
        - F
        - F
        - **T**
        - F
        -
        -

      * - **(4)**
        - F
        - F
        - **T**
        - **T**
        - .. image:: ../images/OEPrepDepictOpts-SMI-cc-0-sH-0-aH-1-pBS-1.*
        - .. image:: ../images/OEPrepDepictOpts-MDL-cc-0-sH-0-aH-1-pBS-1.*

      * - **(5)**
        - F
        - **T**
        - F
        - F
        -
        -

      * - **(6)**
        - F
        - **T**
        - F
        - **T**
        -
        -

      * - **(7)**
        - F
        - **T**
        - **T**
        - F
        -
        -

      * - **(8)**
        - F
        - **T**
        - **T**
        - **T**
        - .. image:: ../images/OEPrepDepictOpts-SMI-cc-0-sH-1-aH-1-pBS-1.*
        - .. image:: ../images/OEPrepDepictOpts-MDL-cc-0-sH-1-aH-1-pBS-1.*

      * - **(9)**
        - **T**
        - F
        - F
        - F
        -
        -

      * - **(10)**
        - **T**
        - F
        - F
        - **T**
        - .. image:: ../images/OEPrepDepictOpts-SMI-cc-1-sH-0-aH-0-pBS-1.*
        - .. image:: ../images/OEPrepDepictOpts-MDL-cc-1-sH-0-aH-0-pBS-1.*

      * - **(11)**
        - **T**
        - F
        - **T**
        - F
        -
        -

      * - **(12)**
        - **T**
        - F
        - **T**
        - **T**
        - .. image:: ../images/OEPrepDepictOpts-SMI-cc-1-sH-0-aH-1-pBS-1.*
        - .. image:: ../images/OEPrepDepictOpts-MDL-cc-1-sH-0-aH-1-pBS-1.*

      * - **(13)**
        - **T**
        - **T**
        - F
        - F
        -
        -

      * - **(14)**
        - **T**
        - **T**
        - F
        - **T**
        -
        -

      * - **(15)**
        - **T**
        - **T**
        - **T**
        - F
        -
        -

      * - **(16)**
        - **T**
        - **T**
        - **T**
        - **T**
        - .. image:: ../images/OEPrepDepictOpts-SMI-cc-1-sH-1-aH-1-pBS-1.*
        - .. image:: ../images/OEPrepDepictOpts-MDL-cc-1-sH-1-aH-1-pBS-1.*

   **Comments:**

   **(1)**
       MDL = no op; SMILES = generating 2D coordinates is necessary

   **(4)**
       MDL = keeping original 2D coordinates, adding depiction hydrogens, re-perceiving wedge/hash bonds;
       SMILES = generating 2D coordinates, depiction hydrogens are kept; perceiving wedge/hash bonds

   **(8)**
       Default parameters; MDL = keeping original 2D coordinates, re-perceiving all other information;
       SMILES = generating 2D coordinates, regenerating all other information;

   **(10)**
       MDL = regenerating 2D coordinates and re-perceiving wedge/hash bonds (since no depiction hydrogens are added the wedge/hash bonds are on ring bonds);
       SMILES generating 2D coordinates and perceiving wedge/hash bonds;

   **(12)**
       Regenerating all information and keeping all explicit hydrogens

   **(16)**
       Regenerating all information; the depiction of identical molecules imported from SMILES and MDL will be identical

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPrepareDepictionOptions(bool clearcoords = false,
                                      bool suppressH = true)

      .. oe:language:: python

         .. oe:api:: python

            OEPrepareDepictionOptions(clearcoords: bool = False,
                                      suppressH: bool = True) -> OEPrepareDepictionOptions

      Default constructor that initializes an :ref:`OEPrepareDepictionOptions <OEDepict_OEPrepareDepictionOptions>`
      object with the following properties:

      *clearcoords*
         See the :oe:meth:`OEDepict::OEPrepareDepictionOptions::SetClearCoords` method.

      *suppressH*
         See the :oe:meth:`OEDepict::OEPrepareDepictionOptions::SetSuppressHydrogens` method.

      .. list-table::  **Default parameters of the OEPrepareDepictionOptions class**
         :widths: 100 100
         :header-rows: 1

         * - Property
           - Default value

         * - re-generating 2D coordinates
           - false

         * - adding depiction hydrogens
           - true

         * - perceiving MDL bond stereo (wedge/hash)
           - true

         * - suppressing explicit (non-depiction) hydrogens
           - true

         * - depiction orientation
           - :oe:const:`OEDepict::OEDepictOrientation::Default`

         * - algorithmic macrocycle ring depiction
           - false

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPrepareDepictionOptions(const OEPrepareDepictionOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEPrepareDepictionOptions(arg2: OEPrepareDepictionOptions) -> OEPrepareDepictionOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPrepareDepictionOptions &operator=(const OEPrepareDepictionOptions &rhs)

      Assignment operator.

   .. _OEDepict_GetAddDepictionHydrogens:

   .. oe:method:: GetAddDepictionHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAddDepictionHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddDepictionHydrogens() -> bool

      Returns whether the depiction hydrogens are kept/added.

   .. seealso::

      * :oe:meth:`OEDepict::OEPrepareDepictionOptions::SetAddDepictionHydrogens` method

   .. _OEDepict_GetClearCoords:

   .. oe:method:: GetClearCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetClearCoords() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearCoords() -> bool

      Returns whether the 2D coordinates of a molecule are re-calculated.

      .. seealso::

         * :oe:meth:`OEDepict::OEPrepareDepictionOptions::SetClearCoords` method

   .. _OEDepict_GetDepictOrientation:

   .. oe:method:: GetDepictOrientation

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetDepictOrientation() const

      .. oe:language:: python

         .. oe:api:: python

            GetDepictOrientation() -> int

      Returns the preferred orientation of the 2D coordinates.
      The return value is taken from the
      :oe:constns:`OEDepict::OEDepictOrientation` namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEPrepareDepictionOptions::SetDepictOrientation` method

   .. _OEDepict_OEPrepareDepictionOptions_GetOptimizeMacrocycles:

   .. oe:method:: GetOptimizeMacrocycles

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetOptimizeMacrocycles() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizeMacrocycles() -> bool

      Returns whether the algorithmic macrocycle ring depiction is enabled.

      .. seealso::

         * :oe:meth:`OEDepict::OEPrepareDepictionOptions::SetOptimizeMacrocycles` method

   .. _OEDepict_GetPerceiveBondStereo:

   .. oe:method:: GetPerceiveBondStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveBondStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveBondStereo() -> bool

      Returns whether the hash/wedge bonds are re-assigned.

      .. seealso::

         * :oe:meth:`OEDepict::OEPrepareDepictionOptions::SetPerceiveBondStereo` method

   .. _OEDepict_GetSuppressHydrogens:

   .. oe:method:: GetSuppressHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSuppressHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuppressHydrogens() -> bool

      Returns whether the explicit (non-depiction) hydrogens are suppressed.

      .. seealso::

         * :oe:meth:`OEDepict::OEPrepareDepictionOptions::SetSuppressHydrogens` method

   .. _OEDepict_SetAddDepictionHydrogens:

   .. oe:method:: SetAddDepictionHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAddDepictionHydrogens(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAddDepictionHydrogens(value: bool) -> bool

      Sets whether depiction hydrogens are kept/added.

      .. seealso::

         * :oe:func:`OEDepict::OEAddDepictionHydrogens` function
         * :oe:meth:`OEDepict::OEPrepareDepictionOptions::GetAddDepictionHydrogens` method

   .. _OEDepict_SetClearCoords:

   .. oe:method:: SetClearCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetClearCoords(bool clearcoords)

      .. oe:language:: python

         .. oe:api:: python

            SetClearCoords(value: bool) -> bool

      Sets whether the 2D coordinates of the molecule are re-calculated.
      If the molecule has no 2D coordinates, then the 2D coordinates are
      always calculated by calling the :oe:func:`OEDepict::OEDepictCoordinates`
      regardless of this setting.

      .. seealso::

         * :oe:func:`OEDepict::OEDepictCoordinates` function
         * :oe:meth:`OEDepict::OEPrepareDepictionOptions::GetClearCoords` method

   .. _OEDepict_SetDepictOrientation:

   .. oe:method:: SetDepictOrientation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDepictOrientation(unsigned int orientation)

      .. oe:language:: python

         .. oe:api:: python

            SetDepictOrientation(value: int) -> bool

      Sets the preferred orientation of the 2D coordinates.

      *orientation*
         This value has to be from the :oe:constns:`OEDepict::OEDepictOrientation`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEPrepareDepictionOptions::GetDepictOrientation` method
         * :oe:constns:`OEDepict::OEDepictOrientation` namespace

   .. _OEDepict_OEPrepareDepictionOptions_SetOptimizeMacrocycles:

   .. oe:method:: SetOptimizeMacrocycles

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptimizeMacrocycles(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizeMacrocycles(value: bool) -> bool

      Sets whether to use the algorithmic layout for macrocycle
      ring systems. When enabled, :oe:func:`OEDepict::OEPrepareDepiction`
      will attempt to generate improved algorithmic 2D layout for macrocycles rather than
      using the template lookup or polygon fallback. If the algorithm cannot handle a
      particular ring topology, coordinate generation
      fails and :oe:func:`OEDepict::OEPrepareDepiction` returns ``false``.
      It is the caller's responsibility to retry without this option enabled
      if a fallback depiction is required.

      .. seealso::

         * :oe:meth:`OEDepict::OEPrepareDepictionOptions::GetOptimizeMacrocycles` method
         * :oe:func:`OEDepict::OEPrepareDepiction` function

   .. _OEDepict_SetPerceiveBondStereo:

   .. oe:method:: SetPerceiveBondStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveBondStereo(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveBondStereo(value: bool) -> bool

      Sets whether to re-assign the wedge and hash bonds by calling the
      :oe:func:`OEChem::OEMDLPerceiveBondStereo` function.

      .. seealso::

         * :oe:func:`OEChem::OEMDLPerceiveBondStereo` function in the **OEChem TK** manual
         * :oe:meth:`OEDepict::OEPrepareDepictionOptions::GetPerceiveBondStereo` method

   .. _OEDepict_SetSuppressHydrogens:

   .. oe:method:: SetSuppressHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSuppressHydrogens(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetSuppressHydrogens(value: bool) -> bool

      Sets whether the explicit (non-depiction) hydrogens are suppressed
      in the molecule.
      Only hydrogens that are necessary to faithfully represent
      tetrahedral stereo-chemistry will be kept.

      .. seealso::

         * :oe:func:`OEChem::OESuppressHydrogens` function in the **OEChem TK** manual
         * :oe:meth:`OEDepict::OEPrepareDepictionOptions::GetSuppressHydrogens` method



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEReport

.. _OEDepict_OEReport:

.. oe:class:: OEReport

   .. oe:api::

      class OEReport

   This class represents a layout manager that allows generation of
   multi-page images with two types of page layouts:

   **body**
      The *body* page layout provides a convenient way to position information
      in the middle of the page relative to the page footers and headers.
      For example, see the :math:`1^{st}` page in
      :ref:`Figure: Schematic representation of documents that can be created using the OEReport class<figure_OEReport>`.

   **grid**
      The *grid* page layout provides a convenient way to organize information
      (such as text and molecule depiction) into rows and columns.
      For example, see the :math:`2^{nd}` and  :math:`3^{rd}` pages in
      :ref:`Figure: Schematic representation of documents that can be created using the OEReport class<figure_OEReport>`.

   .. _figure_OEReport:

   .. figure:: depicttk/images/OEReportLayout.*
      :align:  center

      **Schematic representation of documents that can be created using the OEReport class**

   .. seealso::

      * :ref:`section_multipage_report` section
      * :ref:`section_examples_summary_mols2pdf` example
      * :ref:`section_examples_summary_viewmdlsearch` example
      * :ref:`OEReportOptions <OEDepict_OEReportOptions>` class
      * :oe:func:`OEDepict::OEWriteReport` function
      * :oe:func:`OEDepict::OEWriteReportToString` function

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEReport(const OEReportOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            OEReport(opts: OEReportOptions) -> OEReport

      Initializes an :ref:`OEReport <OEDepict_OEReport>` object using
      the given options.

      *opts*
         The :ref:`OEReportOptions <OEDepict_OEReportOptions>` object that stores
         parameters determining the layout of the *body* and the
         *grid* pages of the report.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEReport(unsigned int rowsperpage, unsigned int colsperpage)

      .. oe:language:: python

         .. oe:api:: python

            OEReport(rowsperpage: int, colsperpage: int) -> OEReport

      Initializes an :ref:`OEReport <OEDepict_OEReport>` object with the
      given parameters.

      *rowsperpage*
         The number of rows on each *grid* layout page.

      *colsperpage*
         The number of columns on each *grid* layout page.

      .. note::

        When a report is initialized with only the number of rows and
        columns per page parameter, all other parameters defining
        the layout of the pages will be initialized from the default
        constructor of the :ref:`OEReportOptions <OEDepict_OEReportOptions>` class.

      .. seealso::

         * :ref:`OEReportOptions <OEDepict_OEReportOptions>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetBodies

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEImageBase>* GetBodies()

      .. oe:language:: python

         .. oe:api:: python

            GetBodies() -> Iterable[OEImageBase]

      Returns an iterator over all page bodies that have been created by
      calling the :oe:meth:`OEDepict::OEReport::NewBody` method.

      .. note::

         If no page has been created by the :oe:meth:`OEDepict::OEReport::NewBody`
         method, then the :oe:meth:`OEDepict::OEReport::GetBodies` method returns
         an empty iterator.

      See example in :ref:`Figure: Example of accessing all page bodies of the report<figure_OEReport_GetBodies>`,
      where *body* areas in the :math:`1^{st}` and :math:`5^{th}` page are returned.

      .. oe:source:: OEReportIter.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETBODIES

      .. oe:source:: OEReportIter.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETBODIES

      .. oe:source:: OEReportIter.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETBODIES

      .. oe:source:: OEReportIter.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETBODIES

      .. _figure_OEReport_GetBodies:

      .. list-table:: **Example of accessing all page bodies of the report**. (The numbers inside the cells represent the order in which they are returned)
         :widths: 150 150 150 150 150
         :header-rows: 1

         * - page 1
           - page 2
           - page 3
           - page 4
           - page 5

         * - .. image:: ../images/OEReportIter-bodies-1.*
           - .. image:: ../images/OEReportIter-bodies-2.*
           - .. image:: ../images/OEReportIter-bodies-3.*
           - .. image:: ../images/OEReportIter-bodies-4.*
           - .. image:: ../images/OEReportIter-bodies-5.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::GetBody` method
         * :oe:meth:`OEDepict::OEReport::NewBody` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetBody

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageBase* GetBody(unsigned int p)

      .. oe:language:: python

         .. oe:api:: python

            GetBody(page: int) -> OEImageBase

      Returns the :ref:`OEImageBase <OEDepict_OEImageBase>` pointer of the body
      area of the :math:`p^{th}` page.

      *p*
         This value has to be in the range from `1` to
         :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`.

      .. note::

         If the :math:`p^{th}` page of the report was not created by
         the :oe:meth:`OEDepict::OEReport::NewBody` method or the :math:`p`
         page index is out of range, then the :oe:meth:`OEDepict::OEReport::GetBody`
         method returns a NULL pointer.

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::GetBodies` method
         * :oe:meth:`OEDepict::OEReport::NewBody` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageBase* GetCell(unsigned int p, unsigned int r, unsigned int c)

      .. oe:language:: python

         .. oe:api:: python

            GetCell(page: int, row: int, col: int) -> OEImageBase

      Returns the :ref:`OEImageBase <OEDepict_OEImageBase>` pointer for the cell
      positioned in the :math:`r^{th}` row and :math:`c^{th}` columns on
      the :math:`p^{th}` page.

      *p*
         This value has to be in the range from `1` to
         :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`.

      *r*
         This value has to be in the range from `1` to
         :oe:meth:`OEDepict::OEReport::NumRowsPerPage()<OEDepict::OEReport::NumRowsPerPage>`.

      *c*
         This value has to be in the range from `1` to
         :oe:meth:`OEDepict::OEReport::NumColsPerPage()<OEDepict::OEReport::NumColsPerPage>`.

      .. note::

         If the cell positioned in the :math:`r^{th}` row and
         :math:`c^{th}` columns on the :math:`p^{th}` page has not been
         created by the :oe:meth:`OEDepict::OEReport::NewCell` method,
         then the :oe:meth:`OEDepict::OEReport::GetCell` method returns
         a NULL  pointer.

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::GetCells` method
         * :oe:meth:`OEDepict::OEReport::NewCell` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetCellHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCellHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellHeight() -> float

      Returns the height of the cells on the grid page of the
      :ref:`OEReport <OEDepict_OEReport>` object.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetCellWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCellWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellWidth() -> float

      Returns the width of the cells on the grid page of the
      :ref:`OEReport <OEDepict_OEReport>` object.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetCells

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEImageBase>* GetCells(unsigned int page = 0u,
                                                        unsigned int row = 0u,
                                                        unsigned int col = 0u)

      .. oe:language:: python

         .. oe:api:: python

            GetCells(page: int = 0, row: int = 0, col: int = 0) -> Iterable[OEImageBase]

      Returns an iterator over cells that have been created by calling the
      :oe:meth:`OEDepict::OEReport::NewCell` method.
      The cells are returned in the order in which they have been created
      *i.e.* from left to right and top to bottom order on each grid page.

      *page*
         This value has to be in the range from `0` to
         :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`.

      *row*
         This value has to be in the range from `0` to
         :oe:meth:`OEDepict::OEReport::NumRowsPerPage()<OEDepict::OEReport::NumRowsPerPage>`.

      *col*
         This value has to be in the range from `0` to
         :oe:meth:`OEDepict::OEReport::NumColsPerPage()<OEDepict::OEReport::NumColsPerPage>`.

      Example (:ref:`Figure: Example of accessing all cells of the report<figure_OEReport_GetCells_All>`)

      .. oe:source:: OEReportIter.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALL

      .. oe:source:: OEReportIter.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALL

      .. oe:source:: OEReportIter.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALL

      .. oe:source:: OEReportIter.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALL

      .. _figure_OEReport_GetCells_All:

      .. list-table:: **Example of accessing all cells of the report**. (The numbers inside the cells represent the order in which they are returned)
         :widths: 150 150 150 150 150
         :header-rows: 1

         * - page 1
           - page 2
           - page 3
           - page 4
           - page 5

         * - .. image:: ../images/OEReportIter-cells-all-1.*
           - .. image:: ../images/OEReportIter-cells-all-2.*
           - .. image:: ../images/OEReportIter-cells-all-3.*
           - .. image:: ../images/OEReportIter-cells-all-4.*
           - .. image:: ../images/OEReportIter-cells-all-5.*

      Example (:ref:`Figure: Example of accessing all cells on the given row on each page<figure_OEReport_GetCells_AllPages_Row_AllCols>`)

      .. oe:source:: OEReportIter.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALLPAGES-ROW-ALLCOLS

      .. oe:source:: OEReportIter.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALLPAGES-ROW-ALLCOLS

      .. oe:source:: OEReportIter.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALLPAGES-ROW-ALLCOLS

      .. oe:source:: OEReportIter.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALLPAGES-ROW-ALLCOLS

      .. _figure_OEReport_GetCells_AllPages_Row_AllCols:

      .. list-table:: **Example of accessing all cells on the given row on each page**. (The numbers inside the cells represent the order in which they are returned)
         :widths: 150 150 150 150 150
         :header-rows: 1

         * - page 1
           - page 2
           - page 3
           - page 4
           - page 5

         * - .. image:: ../images/OEReportIter-cells-allpages-row-allcols-1.*
           - .. image:: ../images/OEReportIter-cells-allpages-row-allcols-2.*
           - .. image:: ../images/OEReportIter-cells-allpages-row-allcols-3.*
           - .. image:: ../images/OEReportIter-cells-allpages-row-allcols-4.*
           - .. image:: ../images/OEReportIter-cells-allpages-row-allcols-5.*

      Example (:ref:`Figure: Example of accessing all cells on the given column on each page<figure_OEReport_GetCells_AllPages_AllRows_Col>`)

      .. oe:source:: OEReportIter.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALLPAGES-ALLROWS-COL

      .. oe:source:: OEReportIter.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALLPAGES-ALLROWS-COL

      .. oe:source:: OEReportIter.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALLPAGES-ALLROWS-COL

      .. oe:source:: OEReportIter.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALLPAGES-ALLROWS-COL

      .. _figure_OEReport_GetCells_AllPages_AllRows_Col:

      .. list-table:: **Example of accessing all cells on the given column on each page**. (The numbers inside the cells represent the order in which they are returned)
         :widths: 150 150 150 150 150
         :header-rows: 1

         * - page 1
           - page 2
           - page 3
           - page 4
           - page 5

         * - .. image:: ../images/OEReportIter-cells-allpages-allrows-col-1.*
           - .. image:: ../images/OEReportIter-cells-allpages-allrows-col-2.*
           - .. image:: ../images/OEReportIter-cells-allpages-allrows-col-3.*
           - .. image:: ../images/OEReportIter-cells-allpages-allrows-col-4.*
           - .. image:: ../images/OEReportIter-cells-allpages-allrows-col-5.*

      Example (:ref:`Figure: Example of accessing all cells on the given row and column on each page<figure_OEReport_GetCells_AllPages_Row_Col>`)

      .. oe:source:: OEReportIter.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALLPAGES-ROW-COL

      .. oe:source:: OEReportIter.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALLPAGES-ROW-COL

      .. oe:source:: OEReportIter.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALLPAGES-ROW-COL

      .. oe:source:: OEReportIter.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-ALLPAGES-ROW-COL

      .. _figure_OEReport_GetCells_AllPages_Row_Col:

      .. list-table:: **Example of accessing all cells on the given row and column on each page**. (The numbers inside the cells represent the order in which they are returned)
         :widths: 150 150 150 150 150
         :header-rows: 1

         * - page 1
           - page 2
           - page 3
           - page 4
           - page 5

         * - .. image:: ../images/OEReportIter-cells-allpages-row-col-1.*
           - .. image:: ../images/OEReportIter-cells-allpages-row-col-2.*
           - .. image:: ../images/OEReportIter-cells-allpages-row-col-3.*
           - .. image:: ../images/OEReportIter-cells-allpages-row-col-4.*
           - .. image:: ../images/OEReportIter-cells-allpages-row-col-5.*

      Example (:ref:`Figure: Example of accessing all cells on the given row and page<figure_OEReport_GetCells_Page_Row_AllCols>`)

      .. oe:source:: OEReportIter.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-PAGE-ROW-ALLCOLS

      .. oe:source:: OEReportIter.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-PAGE-ROW-ALLCOLS

      .. oe:source:: OEReportIter.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-PAGE-ROW-ALLCOLS

      .. oe:source:: OEReportIter.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-PAGE-ROW-ALLCOLS

      .. _figure_OEReport_GetCells_Page_Row_AllCols:

      .. list-table:: **Example of accessing all cells on the given row and page**. (The numbers inside the cells represent the order in which they are returned)
         :widths: 150 150 150 150 150
         :header-rows: 1

         * - page 1
           - page 2
           - page 3
           - page 4
           - page 5

         * - .. image:: ../images/OEReportIter-cells-page-row-allcols-1.*
           - .. image:: ../images/OEReportIter-cells-page-row-allcols-2.*
           - .. image:: ../images/OEReportIter-cells-page-row-allcols-3.*
           - .. image:: ../images/OEReportIter-cells-page-row-allcols-4.*
           - .. image:: ../images/OEReportIter-cells-page-row-allcols-5.*

      Example (:ref:`Figure: Example of accessing all cells on the given column and page<figure_OEReport_GetCells_Page_AllRows_Col>`)

      .. oe:source:: OEReportIter.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-PAGE-ALLROWS-COL

      .. oe:source:: OEReportIter.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-PAGE-ALLROWS-COL

      .. oe:source:: OEReportIter.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-PAGE-ALLROWS-COL

      .. oe:source:: OEReportIter.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-PAGE-ALLROWS-COL

      .. _figure_OEReport_GetCells_Page_AllRows_Col:

      .. list-table:: **Example of accessing all cells on the given column and page**. (The numbers inside the cells represent the order in which they are returned)
         :widths: 150 150 150 150 150
         :header-rows: 1

         * - page 1
           - page 2
           - page 3
           - page 4
           - page 5

         * - .. image:: ../images/OEReportIter-cells-page-allrows-col-1.*
           - .. image:: ../images/OEReportIter-cells-page-allrows-col-2.*
           - .. image:: ../images/OEReportIter-cells-page-allrows-col-3.*
           - .. image:: ../images/OEReportIter-cells-page-allrows-col-4.*
           - .. image:: ../images/OEReportIter-cells-page-allrows-col-5.*

      Example (:ref:`Figure: Example of accessing a cell on the given row, column and page<figure_OEReport_GetCells_Page_Row_Col>`)

      .. oe:source:: OEReportIter.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-PAGE-ROW-COL

      .. oe:source:: OEReportIter.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-PAGE-ROW-COL

      .. oe:source:: OEReportIter.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-PAGE-ROW-COL

      .. oe:source:: OEReportIter.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETCELLS-PAGE-ROW-COL

      .. _figure_OEReport_GetCells_Page_Row_Col:

      .. list-table:: **Example of accessing a cell on the given row, column and page**. (The numbers inside the cells represent the order in which they are returned)
         :widths: 150 150 150 150 150
         :header-rows: 1

         * - page 1
           - page 2
           - page 3
           - page 4
           - page 5

         * - .. image:: ../images/OEReportIter-cells-page-row-col-1.*
           - .. image:: ../images/OEReportIter-cells-page-row-col-2.*
           - .. image:: ../images/OEReportIter-cells-page-row-col-3.*
           - .. image:: ../images/OEReportIter-cells-page-row-col-4.*
           - .. image:: ../images/OEReportIter-cells-page-row-col-5.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::GetCell` method
         * :oe:meth:`OEDepict::OEReport::NewCell` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetFooter

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageBase* GetFooter(unsigned int p)

      .. oe:language:: python

         .. oe:api:: python

            GetFooter(page: int) -> OEImageBase

      Returns the :ref:`OEImageBase <OEDepict_OEImageBase>` pointer of the
      footer on the :math:`p^{th}` page.

      *p*
         This value has to be in the range from `1` to
         :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`.

      .. note::

         If the  :ref:`OEReport <OEDepict_OEReport>` object was initialized with footer
         height `0.0` or the :math:`p` page index is out of range, then
         the :oe:meth:`OEDepict::OEReport::GetFooter` method returns
         a NULL pointer.

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::GetFooterHeight` method
         * :oe:meth:`OEDepict::OEReport::GetFooterWidth` method
         * :oe:meth:`OEDepict::OEReport::GetFooters` methods

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetFooterHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetFooterHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetFooterHeight() -> float

      Returns the height of the footer at the bottom of each page.

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::GetFooterWidth` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetFooterWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetFooterWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetFooterWidth() -> float

      Returns the width of the footer at the bottom of each page.

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::GetFooterHeight` methods

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetFooters

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEImageBase>* GetFooters()

      .. oe:language:: python

         .. oe:api:: python

            GetFooters() -> Iterable[OEImageBase]

      Returns an iterator over all footers of the :ref:`OEReport <OEDepict_OEReport>`
      object.

      .. note::

         If the  :ref:`OEReport <OEDepict_OEReport>` object was initialized with footer
         height `0.0`, then the :oe:meth:`OEDepict::OEReport::GetFooters` method
         returns an empty iterator.

      Example (:ref:`Figure: Example of accessing all page footers of the report<figure_OEReport_GetFooters>`)

      .. oe:source:: OEReportIter.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETFOOTERS

      .. oe:source:: OEReportIter.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETFOOTERS

      .. oe:source:: OEReportIter.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETFOOTERS

      .. oe:source:: OEReportIter.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETFOOTERS

      .. _figure_OEReport_GetFooters:

      .. list-table:: **Example of accessing all page footers of the report**. (The numbers inside the footer areas represent the order in which they are returned)
         :widths: 150 150 150 150 150
         :header-rows: 1

         * - page 1
           - page 2
           - page 3
           - page 4
           - page 5

         * - .. image:: ../images/OEReportIter-footers-1.*
           - .. image:: ../images/OEReportIter-footers-2.*
           - .. image:: ../images/OEReportIter-footers-3.*
           - .. image:: ../images/OEReportIter-footers-4.*
           - .. image:: ../images/OEReportIter-footers-5.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::GetFooter` method
         * :oe:meth:`OEDepict::OEReport::GetFooterHeight` method
         * :oe:meth:`OEDepict::OEReport::GetFooterWidth` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetHeader

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageBase* GetHeader(unsigned int p)

      .. oe:language:: python

         .. oe:api:: python

            GetHeader(page: int) -> OEImageBase

      Returns the :ref:`OEImageBase <OEDepict_OEImageBase>` pointer of the
      header on the :math:`p^{th}` page.

      *p*
         This value has to be in the range from `1` to
         :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`.

      .. note::

         If the  :ref:`OEReport <OEDepict_OEReport>` object was initialized with header
         height `0.0` or the :math:`p` page index is out of range, then the
         :oe:meth:`OEDepict::OEReport::GetHeader` method returns a NULL pointer.

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::GetHeaderHeight` method
         * :oe:meth:`OEDepict::OEReport::GetHeaderWidth` method
         * :oe:meth:`OEDepict::OEReport::GetHeaders` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetHeaderHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHeaderHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeaderHeight() -> float

      Returns the height of the header at the top of each page.

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::GetHeaderWidth` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetHeaderWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHeaderWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeaderWidth() -> float

      Returns the width of the header at the top of each page.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::GetHeaderHeight` methods

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetHeaders

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEImageBase>* GetHeaders()

      .. oe:language:: python

         .. oe:api:: python

            GetHeaders() -> Iterable[OEImageBase]

      Returns an iterator over all headers of the :ref:`OEReport <OEDepict_OEReport>`
      object.

      .. note::

         If the  :ref:`OEReport <OEDepict_OEReport>` object was initialized with header
         height `0.0`, then the :oe:meth:`OEDepict::OEReport::GetHeaders` method
         returns an empty iterator.

      Example (:ref:`Figure: Example of accessing all page headers of the report<figure_OEReport_GetHeaders>`)

      .. oe:source:: OEReportIter.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETHEADERS

      .. oe:source:: OEReportIter.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETHEADERS

      .. oe:source:: OEReportIter.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETHEADERS

      .. oe:source:: OEReportIter.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORT-GETHEADERS

      .. _figure_OEReport_GetHeaders:

      .. list-table:: **Example of accessing all page headers of the report**. (The numbers inside the header areas represent the order in which they are returned)
         :widths: 150 150 150 150 150
         :header-rows: 1

         * - page 1
           - page 2
           - page 3
           - page 4
           - page 5

         * - .. image:: ../images/OEReportIter-headers-1.*
           - .. image:: ../images/OEReportIter-headers-2.*
           - .. image:: ../images/OEReportIter-headers-3.*
           - .. image:: ../images/OEReportIter-headers-4.*
           - .. image:: ../images/OEReportIter-headers-5.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::GetHeader` method
         * :oe:meth:`OEDepict::OEReport::GetHeaderHeight` method
         * :oe:meth:`OEDepict::OEReport::GetHeaderWidth` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEReportOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEReportOptions

      Returns the options used to initialize the
      :ref:`OEReport <OEDepict_OEReport>` object.

      .. seealso::

          * :ref:`OEReportOptions <OEDepict_OEReportOptions>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetPage

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageBase* GetPage(unsigned int p)

      .. oe:language:: python

         .. oe:api:: python

            GetPage(page: int) -> OEImageBase

      Returns the :ref:`OEImageBase <OEDepict_OEImageBase>` pointer of the
      :math:`p^{th}` page.

      *p*
         This value has to be in the range from `1` to
         :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`.

      .. note::

         If :math:`p` page index is out of range, then the
         :oe:meth:`OEDepict::OEReport::GetPage` method returns a NULL
         pointer.

      .. seealso::

          * :oe:meth:`OEDepict::OEReport::GetPages` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetPageHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPageHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetPageHeight() -> float

      Returns the height of the pages of the report.

      .. seealso::

          * :oe:meth:`OEDepict::OEReportOptions::SetPageHeight` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetPageWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPageWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetPageWidth() -> float

      Returns the width of the pages of the report.

      .. seealso::

          * :oe:meth:`OEDepict::OEReportOptions::SetPageWidth` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetPages

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEImageBase>* GetPages()

      .. oe:language:: python

         .. oe:api:: python

            GetPages() -> Iterable[OEImageBase]

      Returns an iterator over all the pages of the
      :ref:`OEReport <OEDepict_OEReport>` object.

      .. seealso::

          * :oe:meth:`OEDepict::OEReport::GetPage` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: IsBodyPage

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsBodyPage(unsigned int p) const

      .. oe:language:: python

         .. oe:api:: python

            IsBodyPage(page: int) -> bool

      Returns whether the :math:`p^{th}` page of the report
      is created by calling the :oe:meth:`OEDepict::OEReport::NewBody`
      method.

      *p*
         This value has to be in the range from `1` to
         :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`.

      For example, the :oe:meth:`OEDepict::OEReport::IsBodyPage` method
      returns `true` for the :math:`1^{st}` and :math:`5^{th}` pages of the report
      shown in :ref:`Figure: Example of report layout<figure_OEReport_IsBodyPage>`.

      .. _figure_OEReport_IsBodyPage:

      .. list-table:: **Example of report layout**
         :widths: 150 150 150 150 150 150
         :header-rows: 1

         * -
           - page 1
           - page 2
           - page 3
           - page 4
           - page 5

         * -
           - .. image:: ../images/OEReportIter-pages-1.*
           - .. image:: ../images/OEReportIter-pages-2.*
           - .. image:: ../images/OEReportIter-pages-3.*
           - .. image:: ../images/OEReportIter-pages-4.*
           - .. image:: ../images/OEReportIter-pages-5.*

         * - IsBodyPage
           - true
           - false
           - false
           - false
           - true

      .. seealso::

          * :oe:meth:`OEDepict::OEReport::IsGridPage`  method
          * :oe:meth:`OEDepict::OEReport::NewBody` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: IsGridPage

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsGridPage(unsigned int p) const

      .. oe:language:: python

         .. oe:api:: python

            IsGridPage(page: int) -> bool

      Returns whether the :math:`p^{th}` page of the report
      is created by calling the :oe:meth:`OEDepict::OEReport::NewCell`
      method.

      *p*
         This value has to be in the range from `1` to
         :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`.

      For example, the :oe:meth:`OEDepict::OEReport::IsGridPage` method returns
      `true` for the :math:`2^{nd}`, :math:`3^{rd}`, and :math:`4^{th}` pages
      of the report shown in
      :ref:`Figure: Example of report layout<figure_OEReport_IsGridPage>`.

      .. _figure_OEReport_IsGridPage:

      .. list-table:: **Example of report layout**
         :widths: 150 150 150 150 150 150
         :header-rows: 1

         * -
           - page 1
           - page 2
           - page 3
           - page 4
           - page 5

         * -
           - .. image:: ../images/OEReportIter-pages-1.*
           - .. image:: ../images/OEReportIter-pages-2.*
           - .. image:: ../images/OEReportIter-pages-3.*
           - .. image:: ../images/OEReportIter-pages-4.*
           - .. image:: ../images/OEReportIter-pages-5.*

         * - IsGridPage
           - false
           - true
           - true
           - true
           - false

      .. seealso::

          * :oe:meth:`OEDepict::OEReport::IsBodyPage` method
          * :oe:meth:`OEDepict::OEReport::NewCell` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NewBody

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageBase* NewBody()

      .. oe:language:: python

         .. oe:api:: python

            NewBody() -> OEImageBase

      Creates a new *body* layout page and returns the area
      between the header and the footer.
      See example in :ref:`Figure: Example of creating a new body page<figure_OEReport_NewBody>`.

      .. note::

         The height and width of the returned area depend on the options
         with which the :ref:`OEReport <OEDepict_OEReport>` object was constructed:
         page margins, gap between the cells, and the height of the
         header and footer.

      .. _figure_OEReport_NewBody:

      .. list-table:: **Example of creating a new body page** (The area returned by the NewBody method is highlighted by red color)
         :widths: 150 150 150
         :header-rows: 1

         * - page 1
           - page 2
           - page 3

         * - .. image:: ../images/OEReport-NewBody-1.*
           - .. image:: ../images/OEReport-NewBody-2.*
           - .. image:: ../images/OEReport-NewBody-3.*

      .. seealso::

          * :oe:meth:`OEDepict::OEReport::IsBodyPage` method
          * :oe:meth:`OEDepict::OEReport::GetBody` method
          * :oe:meth:`OEDepict::OEReport::GetBodies` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NewCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEImageBase* NewCell()

      .. oe:language:: python

         .. oe:api:: python

            NewCell() -> OEImageBase

      Creates and returns a new cell.
      If the last page of the report is a *grid* page, then a new cell
      is created from left to right and top to bottom order.
      If no more cells are left on the *grid* page or the last page is a *body*
      page, then a new *grid* page is created before returning the
      first cell of this new page.
      See example in :ref:`Figure: Example of creating a new cell<figure_OEReport_NewCell>`.

      .. note::

         The cells of a grid page are equal-sized and evenly spaced.
         The height and width of the cells depend on the options with which the
         :ref:`OEReport <OEDepict_OEReport>` object was constructed: the number of
         rows and columns per page, page margins, gap between the cells,
         and the height of the header and footer.

      .. _figure_OEReport_NewCell:

      .. list-table:: **Example of creating a new cell** (The area i.e. the cell returned by the NewCell method is highlighted by red color)
         :widths: 150 150 150
         :header-rows: 1

         * - page 1
           - page 2
           - page 3

         * - .. image:: ../images/OEReport-NewCell-1.*
           - .. image:: ../images/OEReport-NewCell-2.*
           - .. image:: ../images/OEReport-NewCell-3.*

      .. seealso::

          * :oe:meth:`OEDepict::OEReport::IsGridPage` method
          * :oe:meth:`OEDepict::OEReport::GetCell` method
          * :oe:meth:`OEDepict::OEReport::GetCells` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumBodyPages

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumBodyPages() const

      .. oe:language:: python

         .. oe:api:: python

            NumBodyPages() -> int

      Returns the number of *body* pages of the :ref:`OEReport <OEDepict_OEReport>`
      object, *i.e.* the number of pages for which the
      :oe:meth:`OEDepict::OEReport::IsBodyPage` method returns `true`.

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::IsBodyPage` method
         * :oe:meth:`OEDepict::OEReport::NumGridPages` method
         * :oe:meth:`OEDepict::OEReport::NumPages` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumColsPerPage

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumColsPerPage() const

      .. oe:language:: python

         .. oe:api:: python

            NumColsPerPage() -> int

      Returns the number of columns on each *grid* page of the
      :ref:`OEReport <OEDepict_OEReport>` object.

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::NumRowsPerPage` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumGridPages

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumGridPages() const

      .. oe:language:: python

         .. oe:api:: python

            NumGridPages() -> int

      Returns the number of *grid* pages of the :ref:`OEReport <OEDepict_OEReport>`
      object, *i.e.* the number of pages for which the
      :oe:meth:`OEDepict::OEReport::IsGridPage` method returns `true`.

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::IsGridPage` method
         * :oe:meth:`OEDepict::OEReport::NumBodyPages` method
         * :oe:meth:`OEDepict::OEReport::NumPages` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumPages

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumPages() const

      .. oe:language:: python

         .. oe:api:: python

            NumPages() -> int

      Returns the number of pages of the :ref:`OEReport <OEDepict_OEReport>`
      object. This is the sum of the numbers returned by the
      :oe:meth:`OEDepict::OEReport::NumBodyPages` and
      :oe:meth:`OEDepict::OEReport::NumGridPages` methods.

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::NumBodyPages` method
         * :oe:meth:`OEDepict::OEReport::NumGridPages` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumRowsPerPage

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumRowsPerPage() const

      .. oe:language:: python

         .. oe:api:: python

            NumRowsPerPage() -> int

      Returns the number of rows on each *grid* page of the
      :ref:`OEReport <OEDepict_OEReport>` object.

      .. seealso::

         * :oe:meth:`OEDepict::OEReport::NumColsPerPage` method


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEReportOptions, ReportOptions

.. _OEDepict_OEReportOptions:

.. oe:class:: OEReportOptions

   .. oe:api::

      class OEReportOptions

   This class represents the :ref:`OEReportOptions <OEDepict_OEReportOptions>` class
   that encapsulates properties that determine the layout of a
   :ref:`OEReport <OEDepict_OEReport>` object.

   See :ref:`Figure: Schematic representation of documents that can be created using the OEReport class<figure_OEReportOptions>`.

   .. _figure_OEReportOptions:

   .. figure:: depicttk/images/OEReportLayout.*
      :align:  center

      **Schematic representation of documents that can be created using the OEReport class**

   The :ref:`OEReportOptions <OEDepict_OEReportOptions>` class stores the following properties:

      .. list-table::
         :widths: 40 40 80 100
         :header-rows: 1

         * - Property
           - Get method
           - Set method
           - Corresponding namespace / class / type

         * - rows per page
           - :oe:meth:`NumRowsPerPage<OEDepict::OEReportOptions::NumRowsPerPage>`
           - set upon construction
           - integer greater than 0

         * - columns per page
           - :oe:meth:`NumColsPerPage<OEDepict::OEReportOptions::NumColsPerPage>`
           - set upon construction
           - integer greater than 0

         * - page width
           - :oe:meth:`GetPageWidth<OEDepict::OEReportOptions::GetPageWidth>`
           - :oe:meth:`SetPageWidth<OEDepict::OEReportOptions::SetPageWidth>` / :oe:meth:`SetPageSize<OEDepict::OEReportOptions::SetPageSize>` / :oe:meth:`SetPageOrientation<OEDepict::OEReportOptions::SetPageOrientation>`
           - floating point number / :oe:constns:`OEDepict::OEPageSize` / :oe:constns:`OEDepict::OEPageOrientation`

         * - page height
           - :oe:meth:`GetPageHeight<OEDepict::OEReportOptions::GetPageHeight>`
           - :oe:meth:`SetPageHeight<OEDepict::OEReportOptions::SetPageHeight>` / :oe:meth:`SetPageSize<OEDepict::OEReportOptions::SetPageSize>` / :oe:meth:`SetPageOrientation<OEDepict::OEReportOptions::SetPageOrientation>`
           - floating point number / :oe:constns:`OEDepict::OEPageSize` / :oe:constns:`OEDepict::OEPageOrientation`

         * - page margins
           - :oe:meth:`GetPageMargin<OEDepict::OEReportOptions::GetPageMargin>`
           - :oe:meth:`SetPageMargin<OEDepict::OEReportOptions::SetPageMargins>` / :oe:meth:`SetPageMargins<OEDepict::OEReportOptions::SetPageMargins>`
           - :oe:constns:`OEDepict::OEMargin`

         * - cell gap
           - :oe:meth:`GetCellGap<OEDepict::OEReportOptions::GetCellGap>`
           - :oe:meth:`SetCellGap<OEDepict::OEReportOptions::SetCellGap>`
           - floating point number

         * - header height
           - :oe:meth:`GetHeaderHeight<OEDepict::OEReportOptions::GetHeaderHeight>`
           - :oe:meth:`SetHeaderHeight<OEDepict::OEReportOptions::SetHeaderHeight>`
           - floating point number

         * - header width
           - :oe:meth:`GetHeaderWidth<OEDepict::OEReportOptions::GetHeaderWidth>`
           -  N/A
           - floating point number

         * - footer height
           - :oe:meth:`GetFooterHeight<OEDepict::OEReportOptions::GetFooterHeight>`
           - :oe:meth:`SetFooterHeight<OEDepict::OEReportOptions::SetFooterHeight>`
           - floating point number

         * - footer width
           - :oe:meth:`GetFooterWidth<OEDepict::OEReportOptions::GetFooterWidth>`
           -  N/A
           - floating point number

   .. seealso::

      * :ref:`OEReport <OEDepict_OEReport>` class

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEReportOptions(unsigned int rowsperpage = 3u,
                            unsigned int colsperpage = 2u)

      .. oe:language:: python

         .. oe:api:: python

            OEReportOptions(rowsperpage: int = 3, colsperpage: int = 2) -> OEReportOptions

      *rowsperpage*
         The number of rows on each *grid* page of the report.

      *colsperpage*
         The number of columns on each *grid* page of the report.

      .. note::

        Both the number of rows and columns per page have to be greater than 0.

      .. list-table::  **Default parameters of OEReportOptions**
         :widths: 120 600
         :header-rows: 1

         * - Property
           - Default value

         * - rows per page
           - 3

         * - columns per page
           - 2

         * - page width
           - :oe:func:`OEDepict::OEGetPageWidth` ( :oe:const:`OEDepict::OEPageSize::US_Letter` )

         * - page height
           - :oe:func:`OEDepict::OEGetPageHeight` ( :oe:const:`OEDepict::OEPageSize::US_Letter` )

         * - margins
           - 20.0 (for each margins: :oe:const:`top<OEDepict::OEMargin::Top>`, :oe:const:`bottom<OEDepict::OEMargin::Bottom>`, :oe:const:`left<OEDepict::OEMargin::Left>` and :oe:const:`right<OEDepict::OEMargin::Right>`)

         * - cell gap
           - 5.0

         * - header height
           - 0.0 (no header is generated by default)

         * - footer height
           - 0.0 (no footer is generated by default)

      Example (:ref:`Figure: Example of report generation with default options<figure_OEReportOptions_Default>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-DEFAULT

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-DEFAULT

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-DEFAULT

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-DEFAULT

      .. _figure_OEReportOptions_Default:

      .. list-table:: **Example of report generation with default options** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_Default-1.*
           - .. image:: ../images/OEReportOptions_Default-2.*

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEReportOptions(const OEReportOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEReportOptions(rhs: OEReportOptions) -> OEReportOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEReportOptions &operator=(const OEReportOptions &rhs)

      Assignment operator.

   .. oe:method:: GetCellGap

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCellGap() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellGap() -> float

      Returns the space between the cells of the report.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetCellGap` method

   .. oe:method:: GetCellHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCellHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellHeight() -> float

      Returns the height of the cells on the *grid* pages of the report.

      .. note::

         The height of the cells depends on the number of rows per page,
         the top and bottom margins, header and footer heights, and
         the gap between the cells

   .. oe:method:: GetCellWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCellWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellWidth() -> float

      Returns the width of the cells on the *grid* pages of the report.

      .. note::

         The width of the cells depends on the number of columns per page,
         the left and right margins, and the gap between the cells.

   .. oe:method:: GetFooterHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetFooterHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetFooterHeight() -> float

      Returns the height of the footer at the bottom of each page.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetFooterHeight` method

   .. oe:method:: GetFooterWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetFooterWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetFooterWidth() -> float

      Returns the width of the footer at the bottom of each page.

   .. oe:method:: GetHeaderHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHeaderHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeaderHeight() -> float

      Returns the height of the header at the top of each page.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetHeaderHeight` method

   .. oe:method:: GetHeaderWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHeaderWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeaderWidth() -> float

      Returns the width of the header at the top of each page.

   .. oe:method:: GetPageHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPageHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetPageHeight() -> float

      Returns the height of the page of the report.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageHeight` method

   .. oe:method:: GetPageMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPageMargin(unsigned int margin) const

      .. oe:language:: python

         .. oe:api:: python

            GetPageMargin(margin: int) -> float

      Returns the size of a specific page margin of the report.

      *margin*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageMargin` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageMargins` method

   .. oe:method:: GetPageWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPageWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetPageWidth() -> float

      Returns the width of the page of the report.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageWidth` method

   .. oe:method:: NumColsPerPage

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumColsPerPage() const

      .. oe:language:: python

         .. oe:api:: python

            NumColsPerPage() -> int

      Returns the number of columns on each *grid* page of the
      report.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::NumRowsPerPage` method

   .. oe:method:: NumRowsPerPage

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumRowsPerPage() const

      .. oe:language:: python

         .. oe:api:: python

            NumRowsPerPage() -> int

      Returns the number of rows on each *grid* page of the
      report.

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::NumColsPerPage` method

   .. oe:method:: SetCellGap

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCellGap(double size)

      .. oe:language:: python

         .. oe:api:: python

            SetCellGap(size: float) -> None

      Sets the space between the cells of the report.

      *size*
         This value has to be a non-negative number.

      Example (:ref:`Figure: Example of using the SetCellGap method<figure_OEReportOptions_SetCellGap>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETCELLGAP

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETCELLGAP

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETCELLGAP

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETCELLGAP

      .. _figure_OEReportOptions_SetCellGap:

      .. list-table:: **Example of using the SetCellGap method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetCellGap-1.*
           - .. image:: ../images/OEReportOptions_SetCellGap-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::GetCellGap` method

   .. oe:method:: SetFooterHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFooterHeight(double height)

      .. oe:language:: python

         .. oe:api:: python

            SetFooterHeight(height: float) -> None

      Sets the height of the footer at the bottom of each page.

      *height*
         This value has to be a non-negative number.

      .. note::

         `0.0` means that a footer is **not** going to be created
         on the pages.

      Example (:ref:`Figure: Example of using the SetFooterHeight method<figure_OEReportOptions_SetFooterHeight>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETFOOTERHEIGHT

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETFOOTERHEIGHT

      .. oe:source:: OEReportOptions_SetProps.java
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETFOOTERHEIGHT

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETFOOTERHEIGHT

      .. _figure_OEReportOptions_SetFooterHeight:

      .. list-table:: **Example of using the SetFooterHeight method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetFooterHeight-1.*
           - .. image:: ../images/OEReportOptions_SetFooterHeight-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::GetFooterHeight` method

   .. oe:method:: SetHeaderHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHeaderHeight(double height)

      .. oe:language:: python

         .. oe:api:: python

            SetHeaderHeight(height: float) -> None

      Sets the height of the header at the top of each page.

      *height*
         This value has to be a non-negative number.

      .. note::

         `0.0` means that a header is **not** going to be created
         on the pages.

      Example (:ref:`Figure: Example of using the SetHeaderHeight method<figure_OEReportOptions_SetHeaderHeight>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETHEADERHEIGHT

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETHEADERHEIGHT

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETHEADERHEIGHT

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETHEADERHEIGHT

      .. _figure_OEReportOptions_SetHeaderHeight:

      .. list-table:: **Example of using the SetHeaderHeight method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetHeaderHeight-1.*
           - .. image:: ../images/OEReportOptions_SetHeaderHeight-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::GetHeaderHeight` method

   .. oe:method:: SetPageHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPageHeight(double height)

      .. oe:language:: python

         .. oe:api:: python

            SetPageHeight(height: float) -> None

      Sets the height of the pages of the report.

      *height*
         This number has to be greater than 0.0.

      Example (:ref:`Figure: Example of using the SetPageHeight method<figure_OEReportOptions_SetPageHeight>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEHEIGHT

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEHEIGHT

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEHEIGHT

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEHEIGHT

      .. _figure_OEReportOptions_SetPageHeight:

      .. list-table:: **Example of using the SetPageHeight method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetPageHeight-1.*
           - .. image:: ../images/OEReportOptions_SetPageHeight-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageOrientation` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageSize` method
         * :oe:meth:`OEDepict::OEReportOptions::GetPageWidth` method

   .. oe:method:: SetPageMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPageMargin(unsigned int margin, double size)

      .. oe:language:: python

         .. oe:api:: python

            SetPageMargin(margin: int, size: float) -> None

      Sets the size of a specific page margin of the report.

      *margin*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      *size*
         This value has to be a non-negative number.

      Example (:ref:`Figure: Example of using the SetPageMargin method<figure_OEReportOptions_SetPageMargin>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGIN

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGIN

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGIN

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGIN

      .. _figure_OEReportOptions_SetPageMargin:

      .. list-table:: **Example of using the SetPageMargin method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetPageMargin-1.*
           - .. image:: ../images/OEReportOptions_SetPageMargin-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::GetPageMargin` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageMargins` method

   .. oe:method:: SetPageMargins

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPageMargins(double size)

      .. oe:language:: python

         .. oe:api:: python

            SetPageMargins(size: float) -> None

      Sets the size of all the margins of the report.

      *size*
         This value has to be a non-negative number.

      Example (:ref:`Figure: Example of using the SetPageMargins method<figure_OEReportOptions_SetPageMargins>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGINS

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGINS

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGINS

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEMARGINS

      .. _figure_OEReportOptions_SetPageMargins:

      .. list-table:: **Example of using the SetPageMargins method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetPageMargins-1.*
           - .. image:: ../images/OEReportOptions_SetPageMargins-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::GetPageMargin` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageMargin` method

   .. oe:method:: SetPageOrientation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPageOrientation(unsigned int orientation)

      .. oe:language:: python

         .. oe:api:: python

            SetPageOrientation(orientation: int) -> None

      Sets the orientation of the pages of the report.

      *orientation*
         This value has to be from the
         :oe:constns:`OEDepict::OEPageOrientation` namespace.

      Example (:ref:`Figure: Example of using the SetPageOrientation method<figure_OEReportOptions_SetPageOrientation>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEORIENTATION

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEORIENTATION

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEORIENTATION

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEORIENTATION

      .. _figure_OEReportOptions_SetPageOrientation:

      .. list-table:: **Example of using the SetPageOrientation method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetPageOrientation-1.*
           - .. image:: ../images/OEReportOptions_SetPageOrientation-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageHeight` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageSize` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageWidth` method

   .. oe:method:: SetPageSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPageSize(unsigned int pagesize)

      .. oe:language:: python

         .. oe:api:: python

            SetPageSize(pagesize: int) -> None

      Sets the width and height of the pages of the report.

      *pagesize*
         This value has to be from the :oe:constns:`OEDepict::OEPageSize`
         namespace.

      Example (:ref:`Figure: Example of using the SetPageSize method<figure_OEReportOptions_SetPageSize>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGESIZE

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGESIZE

      .. oe:source:: OEReportOptions_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGESIZE

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGESIZE

      .. _figure_OEReportOptions_SetPageSize:

      .. list-table:: **Example of using the SetPageSize method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetPageSize-1.*
           - .. image:: ../images/OEReportOptions_SetPageSize-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageOrientation` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageHeight` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageWidth` method

   .. oe:method:: SetPageWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPageWidth(double width)

      .. oe:language:: python

         .. oe:api:: python

            SetPageWidth(width: float) -> None

      Sets the width of the pages of the report.

      *width*
         This number has to be greater than 0.0.

      Example (:ref:`Figure: Example of using the SetPageWidth method<figure_OEReportOptions_SetPageWidth>`)

      .. oe:source:: OEReportOptions_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEWIDTH

      .. oe:source:: OEReportOptions_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEWIDTH

      .. oe:source:: OEReportOptions_SetProps.java
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEWIDTH

      .. oe:source:: OEReportOptions_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEREPORTOPTIONS-SETPAGEWIDTH

      .. _figure_OEReportOptions_SetPageWidth:

      .. list-table:: **Example of using the SetPageWidth method** (The scale of the shown pages is 1:4)
         :widths: 150 150

         * - .. image:: ../images/OEReportOptions_SetPageWidth-1.*
           - .. image:: ../images/OEReportOptions_SetPageWidth-2.*

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageOrientation` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageHeight` method
         * :oe:meth:`OEDepict::OEReportOptions::SetPageSize` method


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OESVGClass:

.. oe:class:: OESVGClass

   .. oe:api::

      class OESVGClass

   SVG `class <https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/class>`_
   is a name that can be assigned with SVG elements.

   .. seealso::

      * :oe:func:`OEDepict::OEIsValidSVGClassName` function
      * :ref:`chapter_svg` chapter
      * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:api: DO NO DOCUMENT / SHOULD NOT BE CALLED DIRECTLY

         OESVGClass(const OEImageBase *parent, const std::string &name)

      To create an :ref:`OESVGClass <OEDepict_OESVGClass>` object on an image
      use the :oe:meth:`OEDepict::OEImageBase::NewSVGClass` method.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the name of the :ref:`OESVGClass <OEDepict_OESVGClass>` object.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OESVGGroup:

.. oe:class:: OESVGGroup

   .. oe:api::

      class OESVGGroup

   SVG `group <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/g>`_
   is a container for grouping and naming collections of SVG drawing elements.

   .. seealso::

      * :oe:func:`OEDepict::OEIsValidSVGGroupId` function
      * :ref:`chapter_svg` chapter
      * :ref:`OESVGClass <OEDepict_OESVGClass>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:api: DO NO DOCUMENT / SHOULD NOT BE CALLED DIRECTLY

         OESVGGroup(const OEImageBase *parent, const std::string &id)

      To create an :ref:`OESVGGroup <OEDepict_OESVGGroup>` object on an image
      use the :oe:meth:`OEDepict::OEImageBase::NewSVGGroup` method.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: AddSVGClass

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddSVGClass(const OESVGClass* svg_class)

      .. oe:language:: python

         .. oe:api:: python

            AddSVGClass(svg_class: OESVGClass) -> bool

      Adds an :ref:`OESVGClass <OEDepict_OESVGClass>` object to the group.
      The SVG class and the SVG group have to be created on the same
      image.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetId

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetId() const

      .. oe:language:: python

         .. oe:api:: python

            GetId() -> str

      Returns the name of the :ref:`OESVGGroup <OEDepict_OESVGGroup>` object.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: IsVisible

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsVisible() const

      .. oe:language:: python

         .. oe:api:: python

            IsVisible() -> bool

      Returns whether the objects drawn inside the given
      :ref:`OESVGGroup <OEDepict_OESVGGroup>` will be visible
      when the image is opened.


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OE2DMolDisplaySetup

   This namespace encodes symbolic constants used as bit-masks to
   indicate which molecule depiction parameters are being
   created when invoking the
   :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function.

   .. seealso::
   
      * :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEDepict::OE2DMolDisplaySetup::AromaticStyle`
      * :oe:const:`OEDepict::OE2DMolDisplaySetup::AtomColorStyle`
      * :oe:const:`OEDepict::OE2DMolDisplaySetup::AtomPropDisplay`
      * :oe:const:`OEDepict::OE2DMolDisplaySetup::AtomStereoStyle`
      * :oe:const:`OEDepict::OE2DMolDisplaySetup::BondColorStyle`
      * :oe:const:`OEDepict::OE2DMolDisplaySetup::BondPropDisplay`
      * :oe:const:`OEDepict::OE2DMolDisplaySetup::BondStereoStyle`
      * :oe:const:`OEDepict::OE2DMolDisplaySetup::DefaultLineWidth`
      * :oe:const:`OEDepict::OE2DMolDisplaySetup::HydrogenStyle`
      * :oe:const:`OEDepict::OE2DMolDisplaySetup::ProtectiveGroupStyle`
      * :oe:const:`OEDepict::OE2DMolDisplaySetup::Scale`
      * :oe:const:`OEDepict::OE2DMolDisplaySetup::SuperAtomStyle`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AromaticStyle

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function result
      in generating the following default interface to configure
      the aromatic ring style.

      ::

         Contents of parameter -aromstyle
             Aliases : -astl
             Type : string
             Allow list : false
             Default : Kekule
             Simple : true
             Required : false
             Legal values : Kekule Circle Dash
             Brief : Aromatic ring display style
             Detail

                 API : OE2DMolDisplayOptions::SetAromaticStyle method and OEAromaticStyle namespace

      .. seealso::

         * :oe:constns:`OEDepict::OEAromaticStyle` namespace
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAromaticStyle` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AtomColorStyle

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function result
      in generating the following default interface to configure
      the atom color style.

      ::

         Contents of parameter -atomcolor
             Aliases : -acolor
             Type : string
             Allow list : false
             Default : WhiteCPK
             Simple : true
             Required : false
             Legal values : WhiteCPK BlackCPK WhiteMonochrome BlackMonochrome cow cob bow wob
             Brief : Atom coloring style
             Detail

                API : OE2DMolDisplayOptions::SetAtomColorStyle method and OEAtomColorStyle namespace

                cow          - (color on white) same as WhiteCPK
                cob          - (color on black) same as BlackCPK
                bow          - (black on white) same as WhiteMonochrome
                wob          - (white on black) same as BlackMonochrome

      .. seealso::

         * :oe:constns:`OEDepict::OEAtomColorStyle` namespace
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AtomPropDisplay

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function result
      in generating the following default interface to configure
      the atom property display.

      ::

         Contents of parameter -atomprop
             Aliases : -aprop
             Type : string
             Allow list : false
             Default : Hidden
             Simple : true
             Required : false
             Legal values : Hidden AtomIdx MapIdx
             Brief : Atom property display
             Detail

                 API : OE2DMolDisplayOptions::SetAtomPropertyFunctor method, OEDisplayNoAtomProp, OEDisplayAtomIdx, and OEDisplayAtomMapIdx functors

      .. seealso::

         * :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>` class
         * :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>` class
         * :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>` class
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AtomStereoStyle

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function result
      in generating the following default interface to configure
      the atom stereo display style.

      ::

         Contents of parameter -atomstereostyle

             Aliases : -atomsstl
             Type : string
             Allow list : false
             Default : AtomStereo|MDLStereoCenter|FancyStyle
             Simple : true
             Required : false
             Brief : Atom stereo display style
             Detail

                 API : OE2DMolDisplayOptions::SetAtomStereoStyle method and OEAtomStereoStyle namespace

                 Primitive expressions :
                 Hidden       - no atom stereo information is displayed
                 AtomStereo   - display wedge/hash bonds
                 CIPAtomStereo - display S/R CIP stereo labels
                 MDLStereoCenter - display ABS/AND/OR stereo labels
                 StandardStyle - standard hash/wedge style
                 FancyStyle   - fancy hash/wedge style

                 Combined expressions :
                 Created by combining primitive tokens with |

      .. seealso::

         * :oe:constns:`OEDepict::OEAtomStereoStyle` namespace
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BondColorStyle

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function result
      in generating the following default interface to configure
      the bond color style.

      ::

         Contents of parameter -bondcolor
             Aliases : -bcolor
             Type : string
             Allow list : false
             Default : ByElement
             Simple : true
             Required : false
             Legal values : ByElement Monochrome
             Brief : Bond coloring style
             Detail

                API : OE2DMolDisplayOptions::SetBondColorStyle method and OEBondColorStyle namespace

      .. seealso::

         * :oe:constns:`OEDepict::OEBondColorStyle` namespace
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondColorStyle` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BondPropDisplay

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function result
      in generating the following default interface to configure
      the bond property display.

      ::

         Contents of parameter -bondprop
             Aliases : -bprop
             Type : string
             Allow list : false
             Default : Hidden
             Simple : true
             Required : false
             Legal values : Hidden BondIdx
             Brief : Bond property display
             Detail

                API : OE2DMolDisplayOptions::SetBondPropertyFunctor method, OEDisplayNoBondProp and OEDisplayBondIdx functors

      .. seealso::

         * :ref:`OEDisplayBondIdx <OEDepict_OEDisplayBondIdx>` class
         * :ref:`OEDisplayNoBondProp <OEDepict_OEDisplayNoBondProp>` class
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BondStereoStyle

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function result
      in generating the following default interface to configure
      the bond stereo display style.

      ::

         Contents of parameter -bondstereostyle
             Aliases : -bondsstl
             Type : string
             Allow list : false
             Default : BondStereo
             Simple : true
             Required : false
             Brief : Bond stereo display style
             Detail

                 API : OE2DMolDisplayOptions::SetBondStereoStyle method and OEBondStereoStyle namespace

                 Primitive expressions :
                 Hidden
                 BondStereo
                 CIPBondStereo

                 Combined expressions :
                 Created by combining primitive tokens with |

      .. seealso::

         * :oe:constns:`OEDepict::OEBondStereoStyle` namespace
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DefaultLineWidth

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function result
      in generating the following default interface to configure
      the default bond line width.

      ::

         Contents of parameter -linewidth
             Aliases : -linew
             Type : int
             Allow list : false
             Default : 2
             Simple : true
             Required : false
             Legal ranges :
                 8 to 1
             Brief : Default bond line width
             Detail

                API : OE2DMolDisplayOptions::SetDefaultBondPen method and OEPen class

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen` method
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: HydrogenStyle

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function result
      in generating the following default interface to configure
      the hydrogen display style.

      ::

         Contents of parameter -hydrstyle
             Aliases : -hstl
             Type : string
             Allow list : false
             Default : ImplicitHetero|ExplicitAll
             Simple : true
             Required : false
             Brief : Hydrogen display style
             Detail

                 API : OE2DMolDisplayOptions::SetHydrogenStyle method and OEHydrogenStyle namespace

                 Primitive expressions :
                 Hidden
                 ImplicitHetero
                 ImplicitTerminal
                 ImplicitAll
                 ExplicitHetero
                 ExplicitTerminal
                 ExplicitAll

                 Combined expressions :
                 Created by combining primitive tokens with |

      .. seealso::

         * :oe:constns:`OEDepict::OEHydrogenStyle` namespace
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ProtectiveGroupStyle

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function result
      in generating the following default interface to configure
      the protective group display style.

      ::

         Contents of parameter -protgroupdisp
             Aliases : -pgroup
             Type : string
             Allow list : false
             Default : Off
             Simple : true
             Required : false
             Brief : Protective group display style
             Detail

                 API : OE2DMolDisplayOptions::SetProtectiveGroupStyle method and OEProtectiveGroupStyle namespace

                 Primitive expressions :
                 Off            -  no protective group detection
                 All            -  detect all protective groups
                 Ac             -  R-C(=O)C
                 Ad             -  R-C12CC3CC(C1)CC(C3)C2
                 Alloc          -  R-C(=O)OCC=C
                 Bn,Bzl,Benzyl  -  R-Cc1ccccc1
                 BOC            -  R-C(=O)OC(C)(C)(C)
                 Bom            -  R-COCc1ccccc1
                 Bpoc           -  R-C(=O)OC(C)(C)c1ccc(cc1)c2ccccc2
                 Bs             -  R-S(=O)(=O)c1ccc(cc1)Br
                 Bt             -  R-n1c2ccccc2nn1
                 Btm            -  R-CSc1ccccc1
                 Bz, Benzoyl    -  R-C(=O)c1ccccc1
                 Bzh            -  R-C(c1ccccc1)c2ccccc2
                 BzOM           -  R-COc1ccccc1
                 cHx            -  R-C1CCCCC1
                 Dan, Dansyl    -  R-S(=O)(=O)c1cccc2c1cccc2N(C)C
                 DCB            -  R-Cc1c(cccc1Cl)Cl
                 DDE            -  R-C(=C1C(=O)CC(CC1=O)(C)C)C
                 DDIV           -  R-C(=C1C(=O)CC(CC1=O)(C)C)CC(C)C 
                 DEIPS          -  R-[Si](CC)(CC)C(C)C
                 DMAB           -  R-Cc1ccc(cc1)NC(=C2C(=O)CC(CC2=O)(C)C)CC(C)C
                 DMIPS          -  R-[Si](C)(C)C(C)C
                 DMPM           -  R-Cc1ccc(c(c1)OC)OC
                 DMPS           -  R-[Si](C)(C)c1ccccc1
                 DMTr           -  R-C(c1ccccc1)(c2ccc(cc2)OC)c3ccc(cc3)OC
                 DNBZ           -  R-C(=O)c1cc(cc(c1)[N+](=O)[O-])[N+](=O)[O-]
                 DNP            -  R-c1ccc(cc1[N+](=O)[O-])[N+](=O)[O-]
                 DOC            -  R-C(=O)OC(C(C)C)C(C)C
                 DPIPS          -  R-[Si](c1ccccc1)(c2ccccc2)OC(C)C
                 Dpp            -  R-P(=O)(c1ccccc1)c2ccccc2
                 DTBMS          -  R-[Si](C)(C(C)(C)C)C(C)(C)C
                 EE             -  R-C(C)OCC
                 ESC            -  R-C(=O)OCCS(=O)(=O)CC
                 Fmoc           -  R-C(=O)OCC3c1ccccc1c2ccccc23
                 FourOMeBz      -  R-C(=O)c1ccc(cc1)OC
                 FPMP           -  R-C1(CCN(CC1)c2ccccc2F)OC
                 Im             -  R-n1ccnc1
                 Lev            -  R-C(=O)CCC(=O)C
                 MDIPS          -  R-[Si](C)(C(C)C)C(C)C
                 MDPS           -  R-[Si](C)(c1ccccc1)c2ccccc2
                 MEM            -  R-COCCOC
                 Mes            -  R-c1c(cc(cc1C)C)C
                 MMTR           -  R-C(c1ccccc1)(c2ccccc2)c3ccc(cc3)OC
                 MOM            -  R-COC
                 Moz            -  R-C(=O)OCc1ccc(cc1)OC
                 MPC            -  R-C(=O)OC(C)(C)c1ccc(cc1)C
                 MPM            -  R-c1ccccc1OC
                 MS             -  R-S(=O)(=O)C
                 MTHP           -  R-C1(CCOCC1)OC
                 MTM            -  R-CSC
                 MTr            -  R-S(=O)(=O)c1c(cc(c(c1C)C)OC)C
                 NPE            -  R-CCc1ccc(cc1)[N+](=O)[O-]
                 NPEOC          -  R-C(=O)OCCc1ccc(cc1)[N+](=O)[O-]
                 NPES           -  R-S(=O)(=O)CCc1ccc(cc1)[N+](=O)[O-]
                 Np             -  R-c1ccc(cc1)[N+](=O)[O-]
                 NPS            -  R-Sc1ccccc1[N+](=O)[O-]
                 NVOC           -  R-C(=O)OCc1cc(c(cc1[N+](=O)[O-])OC)OC
                 OBzl           -  R-OCc1ccccc1
                 ONOS           -  R-S(=O)(=O)c1ccccc1[N+](=O)[O-]
                 OtBu           -  R-OC(C)(C)C
                 OTf            -  R-S(=O)(=O)(C(F)(F)F)
                 PAC            -  R-CC(=O)c1ccccc1
                 PBF            -  R-S(=O)(=O)c1c(c(c2c(c1C)CC(O2)(C)C)C)C
                 PCB            -  R-c1ccc(cc1)Cl
                 PHF            -  R-C1(c2ccccc2-c3c1cccc3)c4ccccc4
                 Pht            -  R-C(=O)c1ccccc1C=O
                 Piv            -  R-C(=O)C(C)(C)C
                 PMB            -  R-Cc1ccc(cc1)OC
                 PMBM           -  R-COCc1ccc(cc1)OC
                 Poc            -  R-C(=O)OC1CCCC1
                 PPi            -  R-P(=O)([O-])OP(=O)([O-])[O-]
                 SEM            -  R-COCC[Si](C)(C)C
                 SES            -  R-S(=O)(=O)CC[Si](C)(C)C
                 StBu           -  R-SC(C)(C)C
                 TBDPS          -  R-[Si](C(C)(C)(C))(c1ccccc1)(c1ccccc1)
                 TBMPS          -  R-[Si](c1ccccc1)(C(C)(C)C)C(C)(C)C
                 TBS, TBDMS     -  R-[Si](C)(C)C(C)(C)C
                 TCP            -  R-c1cc(c(cc1Cl)Cl)Cl
                 Teoc           -  R-C(=O)OCC[Si](C)(C)C
                 TES            -  R-[Si](CC)(CC)CC
                 TFA            -  R-C(=O)C(F)(F)F
                 Thexyl         -  R-C(C)(C)C(C)C
                 THF            -  R-C1CCCO1
                 THP            -  R-C1CCCCO1
                 TIPS           -  R-[Si](C(C)C)(C(C)C)C(C)C
                 TMOB           -  R-Cc1c(cc(cc1OC)OC)OC
                 TMS            -  R-[Si](C)(C)C
                 transCinnamyl  -  R-C/C=C/c1ccccc1
                 Trisyl         -  R-S(=O)(=O)c1c(cc(cc1C(C)C)C(C)C)C(C)C
                 Troc           -  R-C(=O)OCC(Cl)(Cl)Cl
                 TRT            -  R-C(c1ccccc1)(c2ccccc2)c3ccccc3
                 TS, Tos        -  R-S(=O)(=O)c1ccc(cc1)C
                 Xyl            -  R-c1c(cccc1C)C
                 Z, Cbz         -  R-C(=O)OCc1ccccc1

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Scale

      ::

         Contents of parameter -scale
             Aliases : -s
             Type : float
             Allow list : false
             Default : 0.0
             Simple : true
             Required : false
             Legal ranges :
                500.0 to 0.0
             Brief :  Scaling of the depicted molecule
             Detail

                 API : OE2DMolDisplayOptions::SetScale method

                 0.0 value means that the molecule is scaled to
                 auto-fit the (width/height) dimensions of the image

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetScale` method
         * :ref:`section_mol_display_size` section

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SuperAtomStyle

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function result
      in generating the following default interface to configure
      the super atom display style.

      ::

         Contents of parameter -superdisp
         Aliases : -super
         Type : string
         Allow list : false
         Default : Off
         Simple : true
         Required : false
         Brief : Super atom display style
         Detail

            API : OE2DMolDisplayOptions::SetSuperAtomStyle method and OESuperAtomStyle namespace

            Primitive expressions :
            Off          -  no super atom detection
            COOH         -  R-C(=O)OH
            COO_         -  R-C(=O)[O-]
            CHO          -  R-C(=O)H
            NC           -  R-C#[NX1]
            CN           -  R-[N+]#[C-]
            N2           -  R=[N+]=[N-]
            N3           -  R-N=[N+]=[N-]
            NCO          -  R-N=C=O
            NO2          -  R-N(=O)(=0) or R-[N+]([O-])(=0)
            CNO          -  R-C#[N+]-[O-]
            ONO          -  R-O-N=0
            SO3H         -  R-S(=O)(=O)(-OH)
            SO3_         -  R-S(=O)(=O)(-[O-])
            PO3H2        -  R-P(=O)(-OH)(-OH)
            CF3          -  R-C(-F)(-F)(-F)
            CCl3         -  R-C(-Cl)(-Cl)(-Cl)
            Me           -  R-CH3
            Et           -  R-CH2-CH3
            Pr           -  R-CH2-CH2-CH3
            Bu           -  R-CH2-CH2-CH2-CH3
            iBu          -  R-CH2-CH(-CH3)(-CH3)
            sBu          -  R-CH(-CH2-CH3)(-CH3)
            tBu          -  R-C(-CH3)(-CH3)(-CH3)
            OMe          -  R-O-CH3
            OEt          -  R-O-CH2-CH3
            OPr          -  R-O-CH2-CH2-CH3
            OBu          -  R-O-CH2-CH2-CH2-CH3
            All          -  Detect all super atoms

            Combined expressions :
            Created by combining primitive tokens with |

      .. seealso::

         * :oe:constns:`OEDepict::OESuperAtomStyle` namespace
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TitleLocation

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function result
      in generating the following default interface to configure
      the location of the molecule title.

      ::

         Contents of parameter -titleloc
             Aliases : -tloc
             Type : string
             Allow list : false
             Default : Top
             Simple : true
             Required : false
             Legal values : Hidden Top Bottom
             Brief : Location of the molecule title
             Detail

                API : OE2DMolDisplayOptions::SetTitleLocation method and OETitleLocation namespace

      .. seealso::

         * :oe:constns:`OEDepict::OETitleLocation` namespace
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleLocation` method


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OE2DPathPointType

   This namespace contains constants representing types of points 
   added to a :ref:`OE2DPath <OEDepict_OE2DPath>` object.

   .. seealso::

      * :ref:`OE2DPathPoint <OEDepict_OE2DPathPoint>` class
      * :oe:meth:`OEDepict::OE2DPath::GetPoints` method

   .. oe:constant:: CurveC1

      The first control point of a curve segment added to a path 
      with the :oe:meth:`OEDepict::OE2DPath::AddCurveSegment` method.
      See point marked as 'c1' in :ref:`Figure: Example of the points of a curve segment<figure_OE2DPath_CurveSegment>`.

   .. oe:constant:: CurveC2

      The second control point of a curve segment added to a path 
      with the :oe:meth:`OEDepict::OE2DPath::AddCurveSegment` method.
      See point marked as 'c2' in :ref:`Figure: Example of the points of a curve segment<figure_OE2DPath_CurveSegment>`.

   .. oe:constant:: CurveEnd

      The end point of a curve segment added to a path 
      with the :oe:meth:`OEDepict::OE2DPath::AddCurveSegment` method.
      See point marked as 'end' in :ref:`Figure: Example of the points of a curve segment<figure_OE2DPath_CurveSegment>`.

      .. _figure_OE2DPath_CurveSegment:

      .. figure:: depicttk/images/OE2DPoint_AddCurveSegment.*
         :align:  center
         :scale:  100

         **Example of the points of a curve segment**

   .. oe:constant:: LineEnd

      Represents the end point of a line segment added to a path 
      with the :oe:meth:`OEDepict::OE2DPath::AddLineSegment` method.
      See point marked as 'end' in :ref:`Figure: Example of the points of a line segment<figure_OE2DPath_LineSegment>`.

      .. _figure_OE2DPath_LineSegment:

      .. figure:: depicttk/images/OE2DPoint_AddLineSegment.*
         :align:  center
         :scale:  100

         **Example of the point of a line segment**

   .. oe:constant:: Start

      Represents the first point of a path.


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEAlignment

   This namespace contains constants that control how texts are
   aligned.

   .. seealso::

      * :oe:meth:`OEDepict::OEFont::GetAlignment` method
      * :oe:meth:`OEDepict::OEFont::SetAlignment` method
      * :oe:meth:`OEDepict::OEImageBase::DrawText`

   The :oe:constns:`OEDepict::OEAlignment` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default text alignment style is 
      :oe:const:`OEDepict::OEAlignment::Center`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Center

      The text is aligned to the center of the position passed as the 
      first parameter of the :oe:meth:`OEDepict::OEImageBase::DrawText`
      method. 
      (This position is marked with a red dot in
      :ref:`Figure: Example of using the 'Center' alignment<figure_OEAlignment_Center>`)

      .. _figure_OEAlignment_Center:

      .. figure:: depicttk/images/OEAlignment_Center.*
         :align:  center

         **Example of using the 'Center' alignment**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Left

      The text is left adjusted to the position passed as the 
      first parameter of the :oe:meth:`OEDepict::OEImageBase::DrawText`
      method. 
      (This position is marked with a red dot in
      :ref:`Figure: Example of using the 'Left' alignment<figure_OEAlignment_Left>`)

      .. _figure_OEAlignment_Left:

      .. figure:: depicttk/images/OEAlignment_Left.*
         :align:  center

         **Example of using the 'Left' alignment**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Right

      The text is right adjusted to the position passed as the 
      first parameter of the :oe:meth:`OEDepict::OEImageBase::DrawText`
      method. 
      (This position is marked with a red dot in
      :ref:`Figure: Example of using the 'Right' alignment<figure_OEAlignment_Right>`)

      .. _figure_OEAlignment_Right:

      .. figure:: depicttk/images/OEAlignment_Right.*
         :align:  center

         **Example of using the 'Right' alignment**


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEAromaticStyle, aromaticity depiction

.. oe:constnamespace:: OEAromaticStyle

   This namespace contains constants representing various styles
   of aromatic ring depictions.

   .. _table_OEAromaticStyle_Examples:

   .. list-table:: **Examples of aromatic display styles**
      :widths: 50 100 100 100
      :header-rows: 0

      * -
        - :oe:const:`OEDepict::OEAromaticStyle::Kekule` (default)
        - :oe:const:`OEDepict::OEAromaticStyle::Circle`
        - :oe:const:`OEDepict::OEAromaticStyle::Dash`

      * -  example A
        - .. image:: ../images/OEAromaticStyle_example-A-kekule.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-A-circle.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-A-dash.*
             :align:  center

      * - example B
        - .. image:: ../images/OEAromaticStyle_example-B-kekule.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-B-circle.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-B-dash.*
             :align:  center

      * - example C
        - .. image:: ../images/OEAromaticStyle_example-C-kekule.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-C-circle.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-C-dash.*
             :align:  center

      * - example D
        - .. image:: ../images/OEAromaticStyle_example-D-kekule.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-D-circle.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-D-dash.*
             :align:  center

   .. seealso::

      * :ref:`chapter_aromaticity` chapter in **OEChem TK** manual
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAromaticStyle`
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAromaticStyle`

   The :oe:constns:`OEDepict::OEAromaticStyle` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default aromatic style is
      :oe:const:`OEDepict::OEAromaticStyle::Kekule`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Circle

      Aromatic rings up to 6-membered are depicted by drawing a circle 
      inside.
      See example in :ref:`Figure: Example of using the 'Circle' aromaticity style<figure_OEAromaticStyle_Circle>`.

      .. _figure_OEAromaticStyle_Circle:

      .. figure:: depicttk/images/OEAromaticStyle_Circle.*
         :align:  center

         **Examples of using the 'Circle' aromaticity style**

      .. note::

         **OEDepict TK** applies the "circle" style only for rings up to 6-membered.
         The remaining aromatic bonds are depicted using the "dash" style.
         See example B and C in :ref:`Table Examples of aromatic display styles <table_OEAromaticStyle_Examples>`.
         **OEDepict TK** does not apply the "circle" style either if not all bonds of the rings
         are perceived as aromatic.
         See example A and D in :ref:`Table Examples of aromatic display styles <table_OEAromaticStyle_Examples>`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Dash

      See example in :ref:`Figure: Example of using the 'Dash' aromaticity style<figure_OEAromaticStyle_Dash>`.

      .. _figure_OEAromaticStyle_Dash:

      .. figure:: depicttk/images/OEAromaticStyle_Dash.*
         :align:  center

         **Example of using the 'Dash' aromaticity style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Kekule

      See example in :ref:`Figure: Example of using the 'Kekule' aromaticity style<figure_OEAromaticStyle_Kekule>`.

      .. _figure_OEAromaticStyle_Kekule:

      .. figure:: depicttk/images/OEAromaticStyle_Kekule.*
         :align:  center

         **Example of using the 'Kekule' aromaticity style**


.. oe:namespace:: OEDepict

..  _OEDepict_OEAtomColorStyle:

.. oe:constnamespace:: OEAtomColorStyle

   This namespace contains constants representing various atom
   coloring styles of molecule depiction.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle` method
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle` method
      * :oe:func:`OEDepict::OEGetDefaultAtomColor` function

   **After** setting the atom color style of an
   :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object:

   * The color of the background can be changed by using the
     :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBackgroundColor`
     method.

   * The color that is associated with a specific atomic number can
     be changed by using the
     :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomColor`
     method.

   The :oe:constns:`OEDepict::OEAtomColorStyle` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default atom color style is
      :oe:const:`OEDepict::OEAtomColorStyle::WhiteCPK`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BlackCPK

      The color of the background is
      :oe:const:`OEDarkBackgroundColor<OEDepict::OEDepict::OEDarkBackgroundColor>`.
      The atoms are colored using the :term:`CPK` color convention.
      See example in :ref:`Figure: Example of using the 'BlackCPK'
      atom color style<figure_OEAtomColorStyle_BlackCPK>`.

      .. _figure_OEAtomColorStyle_BlackCPK:

      .. figure:: depicttk/images/OEAtomColorStyle_BlackCPK.*
         :align:  center

         **Example of using the 'BlackCPK' atom color style**

      .. seealso::

         * :ref:`chapter_element_color` chapter

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BlackMonochrome

      The color of the background is
      :oe:const:`OEDarkBackgroundColor<OEDepict::OEDepict::OEDarkBackgroundColor>`.
      Atoms and bonds are depicted using the :oe:const:`OEWhite<OESystem::OESystem::OEWhite>` color.
      See example in :ref:`Figure: Example of using the 'BlackMonochrome'
      atom color style<figure_OEAtomColorStyle_BlackMonochrome>`.

      .. _figure_OEAtomColorStyle_BlackMonochrome:

      .. figure:: depicttk/images/OEAtomColorStyle_BlackMonochrome.*
         :align:  center

         **Example of using the 'BlackMonochrome' atom color style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: WhiteCPK

      The color of the background is
      :oe:const:`OELightBackgroundColor<OEDepict::OEDepict::OELightBackgroundColor>`.
      The atoms are colored using the :term:`CPK` color convention.
      See example in :ref:`Figure: Example of using the 'WhiteCPK'
      atom color style<figure_OEAtomColorStyle_WhiteCPK>`.

      .. _figure_OEAtomColorStyle_WhiteCPK:

      .. figure:: depicttk/images/OEAtomColorStyle_WhiteCPK.*
         :align:  center

         **Example of using the 'WhiteCPK' atom color style**

      .. seealso::

         * :ref:`chapter_element_color` chapter

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: WhiteMonochrome

      The color of the background is
      :oe:const:`OELightBackgroundColor<OEDepict::OEDepict::OELightBackgroundColor>`.
      Atoms and bonds are depicted using the :oe:const:`OEBlack<OESystem::OESystem::OEBlack>` color.
      See example in :ref:`Figure: Example of using the WhiteMonochrome'
      atom color style<figure_OEAtomColorStyle_WhiteMonochrome>`.

      .. _figure_OEAtomColorStyle_WhiteMonochrome:

      .. figure:: depicttk/images/OEAtomColorStyle_WhiteMonochrome.*
         :align:  center

         **Example of using the 'WhiteMonochrome' atom color style**



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEAtomStereoStyle

   This namespace encodes symbolic constants used as bit-masks to 
   indicate what and how atom stereo information is displayed.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomStereoStyle`
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle`

   The :oe:constns:`OEDepict::OEAtomStereoStyle` namespace contains the 
   following constants and nested namespaces:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The combination of the following flags:

      * :oe:const:`OEDepict::OEAtomStereoStyle::Display::Default`
      * :oe:const:`OEDepict::OEAtomStereoStyle::HashWedgeStyle::Default`

      See example in :ref:`Figure: Example of using the 'Default'
      atom stereo style<figure_OEAtomStereoStyle_Default>`.

      .. _figure_OEAtomStereoStyle_Default:

      .. figure:: depicttk/images/OEAtomStereoStyle_Default.*
         :align:  center

         **Example of using the 'Default' atom stereo style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Hidden

      Displays no atom stereo information.
      See example in :ref:`Figure: Example of using the 'Hidden'
      atom stereo style<figure_OEAtomStereoStyle_Hidden>`.

      .. _figure_OEAtomStereoStyle_Hidden:

      .. figure:: depicttk/images/OEAtomStereoStyle_Hidden.*
         :align:  center

         **Example of using the 'Hidden' atom stereo style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant: DisplayMask # IGNORE

   .. ################################################################
      #
      ################################################################

   .. oe:constant: HashWedgeStyleMask #IGNORE

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEAtomStereoStyle::Display

      This nested namespace encodes symbolic constants used as bit-masks to
      indicate what atom stereo information is displayed.

      .. ################################################################
         #
         ################################################################

      .. oe:constant:: Default

         The combination of the following flags:

         * :oe:const:`OEDepict::OEAtomStereoStyle::Display::AtomStereo`
         * :oe:const:`OEDepict::OEAtomStereoStyle::Display::MDLStereoCenter`

      .. ################################################################
         #
         ################################################################

      .. oe:constant:: AtomStereo

         Displays atom stereo information in the form of hash/wedge bonds.
         See example in :ref:`Table: Example of using the 'AtomStereo'
         display style<table_OEAtomStereoStyle_Display_AtomStereo>`.

         .. _table_OEAtomStereoStyle_Display_AtomStereo:

         .. list-table::  **Example of using the 'AtomStereo' display style**

            * -  `O[C@@H]1CN[C@@H](O)CC1`
              -  `O[C@@H]1CC[C@@H](O)CC1`
            * - .. image:: ../images/OEAtomStereoStyle_Display_AtomStereo_RS.*
                  :align:  center
              - .. image:: ../images/OEAtomStereoStyle_Display_AtomStereo_X.*
                  :align:  center

         If the molecule is imported from an MOL or SDF file with an "either"
         stereo than it is depicted as a wavy bond.
         See example in :ref:`Figure: Example of depiction of up, down and
         either (wavy) bonds<figure_OEAtomStereoStyle_Display_Wavy>`.
 
         .. _figure_OEAtomStereoStyle_Display_Wavy:

         .. figure:: depicttk/images/OEAtomStereoStyle_AtomStereo_Wavy.*
            :align:  center

            **Example of depiction of up, down and either (wavy) bonds**

      .. ################################################################
         #
         ################################################################

      .. oe:constant:: CIPAtomStereo

         Displays the CIP atom stereo information next to the
         corresponding atom.
         See example in :ref:`Table: Example of using the 'CIPAtomStereo'
         display style<table_OEAtomStereoStyle_Display_AtomStereo>`.

         .. _table_OEAtomStereoStyle_Display_CIPAtomStereo:

         .. list-table::   **Example of using the 'CIPAtomStereo' display style**

            * -  `O[C@@H]1CN[C@@H](O)CC1`
              -  `O[C@@H]1CC[C@@H](O)CC1`
            * - .. image:: ../images/OEAtomStereoStyle_Display_CIPAtomStereo_RS.*
                   :align:  center
              - .. image:: ../images/OEAtomStereoStyle_Display_CIPAtomStereo_X.*
                   :align:  center

      .. ################################################################
         #
         ################################################################

      .. oe:constant:: MDLStereoCenter

         Displays the MDL enhanced stereochemical atom labels.

         .. list-table::   **Example of using the 'MDLStereoCenter' display style**

            * - **MDL stereo group type**
              - Absolute
              - AND
              - OR

            * - **Label in molfile**
              - STEABS
              - STERACn
              - STERELn

            * - **Display label**
              - 'abs'
              - '&n'
              - 'orn'

            * - **Example**
              - .. image:: ../images/OEAtomStereoStyle_MDLStereoCenter_ABS.*
              - .. image:: ../images/OEAtomStereoStyle_MDLStereoCenter_AND.*
              - .. image:: ../images/OEAtomStereoStyle_MDLStereoCenter_OR.*

      .. ################################################################
         #
         ################################################################

      .. oe:constant:: All

         The combination of the following flags:

         * :oe:const:`OEDepict::OEAtomStereoStyle::Display::AtomStereo`
         * :oe:const:`OEDepict::OEAtomStereoStyle::Display::CIPAtomStereo`
         * :oe:const:`OEDepict::OEAtomStereoStyle::Display::MDLStereoCenter`

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEAtomStereoStyle::HashWedgeStyle

      This nested namespace encodes symbolic constants used to
      indicate the style of the hash/wedge bonds that depict
      atom stereo information.

      .. #############################################################
         #
         #############################################################

      .. oe:constant:: Default

         The default hash/wedge display style is
         :oe:const:`OEDepict::OEAtomStereoStyle::HashWedgeStyle::Fancy`

      .. #############################################################
         #
         #############################################################

      .. oe:constant:: Fancy

         See example in :ref:`Figure: Example of using the 'Fancy'
         hash/wedge style <figure_OEAtomStereoStyle_HashWedgeStyle_Fancy>`.

         .. _figure_OEAtomStereoStyle_HashWedgeStyle_Fancy:

         .. figure:: depicttk/images/OEAtomStereoStyle_HashWedgeStyle_Fancy.*
            :scale:  100
            :align:  center

            **Example of using the 'Fancy' hash/wedge style**

      .. #############################################################
         #
         #############################################################

      .. oe:constant:: Standard

         See example in :ref:`Figure: Example of using the 'Standard'
         hash/wedge style <figure_OEAtomStereoStyle_HashWedgeStyle_Standard>`.

         .. _figure_OEAtomStereoStyle_HashWedgeStyle_Standard:

         .. figure:: depicttk/images/OEAtomStereoStyle_HashWedgeStyle_Standard.*
            :scale:  100
            :align:  center

            **Example of using the 'Standard' hash/wedge style**



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEBondColorStyle

   This namespace contains constants representing various bond
   coloring styles of molecule depiction.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondColorStyle`
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondColorStyle`

   The :oe:constns:`OEDepict::OEBondColorStyle` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default bond color style is
      :oe:const:`OEDepict::OEBondColorStyle::ByElement`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ByElement

      See example in :ref:`Figure: Example of using the 'ByElement' bond color style<figure_OEBondColorStyle_ByElement>`.

      .. _figure_OEBondColorStyle_ByElement:

      .. figure:: depicttk/images/OEBondColorStyle_ByElement.*
         :align:  center

         **Example of using the 'ByElement' bond color style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Monochrome

      See example in :ref:`Figure: Example of using the 'Monochrome' bond color style<figure_OEBondColorStyle_Monochrome>`.

      .. _figure_OEBondColorStyle_Monochrome:

      .. figure:: depicttk/images/OEBondColorStyle_Monochrome.*
         :align:  center

         **Example of using the 'Monochrome' bond color style**



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEBondDisplayPosition

   This namespace controls how multi-line bonds are rendered. The
   :oe:constns:`OEDepict::OEBondDisplayPosition` only affects bonds of
   the following types (as returned by
   :oe:meth:`OEDepict::OE2DBondDisplay::GetDisplayType`):

   * :oe:const:`OEDepict::OEBondDisplayType::Double`
   * :oe:const:`OEDepict::OEBondDisplayType::AromaticDash`
   * :oe:const:`OEDepict::OEBondDisplayType::SingleDouble`
   * :oe:const:`OEDepict::OEBondDisplayType::SingleArom` 
   * :oe:const:`OEDepict::OEBondDisplayType::DoubleArom`  
   * :oe:const:`OEDepict::OEBondDisplayType::Aromatic`

   The concept of
   :oe:const:`Left<OEDepict::OEBondDisplayPosition::Left>` and
   :oe:const:`Right<OEDepict::OEBondDisplayPosition::Right>` are
   relative to the "begin" and "end" atoms of the associated
   :ref:`OEBondBase <OEChem_OEBondBase>`. The side of
   :oe:const:`Left<OEDepict::OEBondDisplayPosition::Left>` and
   :oe:const:`Right<OEDepict::OEBondDisplayPosition::Right>` is defined
   by standing on the "begin" atom and looking towards the "end"
   atom. 

   The following figure shows how both
   :oe:const:`Left<OEDepict::OEBondDisplayPosition::Left>` and
   :oe:const:`Right<OEDepict::OEBondDisplayPosition::Right>` double
   bonds can appear in a benzene ring. 

   .. figure:: depicttk/images/OEBondDisplayPosition.*
      :align:  center

      *Example of various multi-line bond positions*

   .. note::

      The :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` does not store pointers
      to the "begin" and "end" atoms. The "begin" and "end" atoms can
      be retrieved by accessing the associated
      :ref:`OEBondBase <OEChem_OEBondBase>` through the
      :oe:meth:`OEDepict::OEBondDisplayBase::GetBond` method and then
      calling the :oe:meth:`OEChem::OEBondBase::GetBgn` and
      :oe:meth:`OEChem::OEBondBase::GetEnd` methods respectively. 

   .. seealso::

      * :oe:meth:`OEDepict::OE2DBondDisplay::GetDisplayPos` method
      * :oe:meth:`OEDepict::OE2DBondDisplay::SetDisplayPos` method

   The :oe:constns:`OEDepict::OEBondDisplayPosition` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant: Undefined # IGNORED

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Center

      Renders a double bond so that the "begin" and "end" atom
      coordinates end up between each line of the double bond.
      See example in :ref:`Figure: Example of a double bond rendered in the center<figure_OEBondDisplayPosition_Center>`.

      .. _figure_OEBondDisplayPosition_Center:

      .. figure:: depicttk/images/OEBondDisplayPosition_Center.*
         :align:  center

         *Example of a double bond rendered in the center*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Left

      Renders a double bond by drawing a line between the "begin" and
      "end" atom coordinates, and then drawing a parallel line to the
      left of that line.
      See example in :ref:`Figure: Example of a double bond rendered with its parallel line to the left<figure_OEBondDisplayPosition_Left>`.

      .. _figure_OEBondDisplayPosition_Left:

      .. figure:: depicttk/images/OEBondDisplayPosition_Left.*
         :align:  center

         *Example of a double bond rendered with its parallel line to the left*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Right

      Renders a double bond by drawing a line between the "begin" and
      "end" atom coordinates, and then drawing a parallel line to the
      right of that line.
      See example in :ref:`Figure: Example of a double bond rendered with its parallel line to the right<figure_OEBondDisplayPosition_Right>`.

      .. _figure_OEBondDisplayPosition_Right:

      .. figure:: depicttk/images/OEBondDisplayPosition_Right.*
         :align:  center

         *Example of a double bond rendered with its parallel line to the right*



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEBondDisplayType

   This namespace contains constants representing various styles
   of bond representations.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DBondDisplay::GetDisplayType` method
      * :oe:meth:`OEDepict::OE2DBondDisplay::SetDisplayType` method

   The :oe:constns:`OEDepict::OEBondDisplayType` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:  Undefined # IGNORED

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Single

      The :oe:const:`OEDepict::OEBondDisplayType::Single` type is
      used to represent single bonds.
      See example in :ref:`Figure: Example of depicting a 'Single' bond type<figure_OEBondDisplayType_Single>`.

      .. _figure_OEBondDisplayType_Single:

      .. figure:: depicttk/images/OEBondDisplayType_Single.*
         :align:  center

         **Example of depicting a 'Single' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Double

      The :oe:const:`OEDepict::OEBondDisplayType::Double` type is
      used to represent double bonds.
      See example in :ref:`Figure: Example of depicting a 'Double' bond type<figure_OEBondDisplayType_Double>`.

      .. _figure_OEBondDisplayType_Double:

      .. figure:: depicttk/images/OEBondDisplayType_Double.*
         :align:  center

         **Example of depicting a 'Double' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Triple

      The :oe:const:`OEDepict::OEBondDisplayType::Triple` type is
      used to represent triple bonds.
      See example in :ref:`Figure: Example of depicting a 'Triple' bond type<figure_OEBondDisplayType_Triple>`.

      .. _figure_OEBondDisplayType_Triple:

      .. figure:: depicttk/images/OEBondDisplayType_Triple.*
         :align:  center

         **Example of depicting a 'Triple' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Quadruple

      The :oe:const:`OEDepict::OEBondDisplayType::Quadruple` type is
      used to represent quadruple bonds.
      See example in :ref:`Figure: Example of depicting a 'Quadruple' bond type<figure_OEBondDisplayType_Quadruple>`.

      .. _figure_OEBondDisplayType_Quadruple:

      .. figure:: depicttk/images/OEBondDisplayType_Quadruple.*
         :align:  center

         **Example of depicting a 'Quadruple' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Wedge

      See example in :ref:`Figure: Example of depicting a 'Wedge' bond type<figure_OEBondDisplayType_Wedge>`.

      .. _figure_OEBondDisplayType_Wedge:

      .. figure:: depicttk/images/OEBondDisplayType_Wedge.*
         :align:  center

         **Example of depicting a 'Wedge' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Hash

      See example in :ref:`Figure: Example of depicting a 'Hash' bond type<figure_OEBondDisplayType_Hash>`.

      .. _figure_OEBondDisplayType_Hash:

      .. figure:: depicttk/images/OEBondDisplayType_Hash.*
         :align:  center

         **Example of depicting a 'Hash' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Wavy

      See example in :ref:`Figure: Example of depicting a 'Wavy' bond type<figure_OEBondDisplayType_Wavy>`.

      .. _figure_OEBondDisplayType_Wavy:

      .. figure:: depicttk/images/OEBondDisplayType_Wavy.*
         :align:  center

         **Example of depicting a 'Wavy' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AromaticDash

      The :oe:const:`OEDepict::OEBondDisplayType::AromaticDash` type is
      used to represent aromatic rings when the
      :oe:const:`OEDepict::OEAromaticStyle::Dash` style is turned on.
      See example in :ref:`Figure: Example of depicting an 'AromaticDash' bond type<figure_OEBondDisplayType_AromaticDash>`.

      .. _figure_OEBondDisplayType_AromaticDash:

      .. figure:: depicttk/images/OEBondDisplayType_AromaticDash.*
         :align:  center

         **Example of depicting an 'AromaticDash' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DoubleBowTie

      See example in :ref:`Figure: Example of depicting an 'DoubleBowTie' bond type<figure_OEBondDisplayType_DoubleBowTie>`.

      .. _figure_OEBondDisplayType_DoubleBowTie:

      .. figure:: depicttk/images/OEBondDisplayType_DoubleBowTie.*
         :align:  center

         **Example of depicting a 'DoubleBowTie' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SingleDouble

      The :oe:const:`OEDepict::OEBondDisplayType::SingleDouble` type is
      used to represent MDL query bonds that can be matched to any
      single or double bonds in the target molecule(s)
      (*i.e.* bond type `5` in the MDL query files)
      See example in :ref:`Figure: Example of depicting an 'SingleDouble' bond type<figure_OEBondDisplayType_SingleDouble>`.

      .. _figure_OEBondDisplayType_SingleDouble:

      .. figure:: depicttk/images/OEBondDisplayType_SingleDouble.*
         :align:  center

         **Example of depicting a 'SingleDouble' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SingleArom

      The :oe:const:`OEDepict::OEBondDisplayType::SingleArom` type is 
      used to represent MDL query bonds that can be matched to any single
      or aromatic bonds in the target  molecule(s)
      (*i.e.* bond type `6` in the MDL query files)
      See example in :ref:`Figure: Example of depicting an 'SingleDouble' bond type<figure_OEBondDisplayType_SingleDouble>`.

      .. _figure_OEBondDisplayType_SingleArom:

      .. figure:: depicttk/images/OEBondDisplayType_SingleArom.*
         :align:  center

         **Example of depicting a 'SingleArom' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DoubleArom

      The :oe:const:`OEDepict::OEBondDisplayType::DoubleArom` type is
      used to represent MDL query bonds that can be matched to any double
      or aromatic bonds in the target  molecule(s)
      (*i.e.* bond type `7` in the MDL query files)
      See example in :ref:`Figure: Example of depicting an 'DoubleArom' bond type<figure_OEBondDisplayType_DoubleArom>`.

      .. _figure_OEBondDisplayType_DoubleArom:

      .. figure:: depicttk/images/OEBondDisplayType_DoubleArom.*
         :align:  center

         **Example of depicting a 'DoubleArom' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Aromatic

      The :oe:const:`OEDepict::OEBondDisplayType::Aromatic` type is
      used to represent MDL query bonds that can be matched to any
      aromatic bonds in the target molecule(s)
      (*i.e.* bond type `4` in the MDL query files)
      See example in :ref:`Figure: Example of depicting an 'Aromatic' bond type<figure_OEBondDisplayType_Aromatic>`.

      .. _figure_OEBondDisplayType_Aromatic:

      .. figure:: depicttk/images/OEBondDisplayType_Aromatic.*
         :align:  center

         **Example of depicting an 'Aromatic' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Any

      The :oe:const:`OEDepict::OEBondDisplayType::Any` type is
      used to represent MDL query bonds that can be matched to any bonds
      in the target  molecule(s)
      (*i.e.* bond type `8` in the MDL  query files)
      See example in :ref:`Figure: Example of depicting an 'Any' bond type<figure_OEBondDisplayType_Any>`.

      .. _figure_OEBondDisplayType_Any:

      .. figure:: depicttk/images/OEBondDisplayType_Any.*
         :align:  center

         **Example of depicting an 'Any' bond type**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Hidden

      The bond is not displayed.



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEBondStereoStyle

   This namespace encodes symbolic constants used as bit-masks to
   indicate what bond stereo information is displayed.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondStereoStyle`
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle`

   The :oe:constns:`OEDepict::OEBondStereoStyle` namespace contains the
   following constants and nested namespaces:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default bond stereo  style is
      :oe:const:`OEDepict::OEBondStereoStyle::Display::Default`.
      See example in :ref:`Figure: Example of using the 'Default'
      bond stereo style<figure_OEBondStereoStyle_Default>`.

      .. _figure_OEBondStereoStyle_Default:

      .. figure:: depicttk/images/OEBondStereoStyle_Default.*
         :align:  center

         **Example of using the 'Default' bond stereo style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Hidden

      Displays no bond stereo information.
      See example in :ref:`Figure: Example of using the 'Hidden'
      bond stereo style<figure_OEAtomStereoStyle_Hidden>`.

      .. _figure_OEBondStereoStyle_Hidden:

      .. figure:: depicttk/images/OEBondStereoStyle_Hidden.*
         :align:  center

         **Example of using the 'Hidden' bond stereo style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant: DisplayMask # IGNORE

   .. ################################################################
      #
      ################################################################

   .. oe:constnamespace:: OEBondStereoStyle::Display

      This nested namespace encodes symbolic constants used as bit-masks to
      indicate what bond stereo information is displayed.

      .. ################################################################
         #
         ################################################################

      .. oe:constant:: Default

         The default bond stereo display style is
         :oe:const:`OEDepict::OEBondStereoStyle::Display::BondStereo`.

      .. ################################################################
         #
         ################################################################

      .. oe:constant:: BondStereo

         See example in :ref:`Table: Example of using the 'BondStereo'
         display style<table_OEBondStereoStyle_Display_BondStereo>`.

         .. _table_OEBondStereoStyle_Display_BondStereo:

         .. list-table::  **Example of using the 'BondStereo' display style**
            :widths: 100 100 100 100
            :header-rows: 1

            * -  cis
              -  trans
              -  undefined 
              -  over-defined
            * -  `C\\C(Br)=C(/C)Br`
              -  `C\\C(Br)=C(\\C)Br`
              -  `CC(Br)=C(C)Br`
              -  `Br\\C(Br)=C(\\Br)Br`
            * - .. image:: ../images/OEBondStereoStyle_Display_BondStereo_Cis.*
                  :scale:  100
                  :align:  center
              - .. image:: ../images/OEBondStereoStyle_Display_BondStereo_Trans.*
                  :scale:  100
                  :align:  center
              - .. image:: ../images/OEBondStereoStyle_Display_BondStereo_Undef.*
                  :scale:  100
                  :align:  center
              - .. image:: ../images/OEBondStereoStyle_Display_BondStereo_Overdef.*
                  :scale:  100
                  :align:  center

      .. ################################################################
         #
         ################################################################

      .. oe:constant:: CIPBondStereo

         Displays the CIP bond stereo information next to the
         corresponding bond.
         See example in :ref:`Table: Example of using the 'CIPBondStereo'
         display style<table_OEBondStereoStyle_Display_CIPBondStereo>`.

         .. _table_OEBondStereoStyle_Display_CIPBondStereo:

         .. list-table::  **Example of using the 'CIPBondStereo' display style**
            :widths: 100 100 100 100
            :header-rows: 1

            * -  cis
              -  trans
              -  undefined 
              -  over-defined
            * -  `C\\C(Br)=C(/C)Br`
              -  `C\\C(Br)=C(\\C)Br`
              -  `CC(Br)=C(C)Br`
              -  `Br\\C(Br)=C(\\Br)Br`
            * - .. image:: ../images/OEBondStereoStyle_Display_CIPBondStereo_Cis.*
                  :scale:  100
                  :align:  center
              - .. image:: ../images/OEBondStereoStyle_Display_CIPBondStereo_Trans.*
                  :scale:  100
                  :align:  center    

              - .. image:: ../images/OEBondStereoStyle_Display_CIPBondStereo_Undef.*
                  :scale:  100
                  :align:  center
              - .. image:: ../images/OEBondStereoStyle_Display_CIPBondStereo_Overdef.*
                  :scale:  100
                  :align:  center

      .. ################################################################
         #
         ################################################################

      .. oe:constant:: All

         The combination of the following flags:

         * :oe:const:`OEDepict::OEBondStereoStyle::Display::CIPBondStereo`
         * :oe:const:`OEDepict::OEBondStereoStyle::Display::BondStereo`

         See example in :ref:`Table: Example of using the 'All'
         display style<figure_OEBondStereoStyle_Display_All>`.

         .. _figure_OEBondStereoStyle_Display_All:

         .. figure:: depicttk/images/OEBondStereoStyle_Display_All.*
            :align:  center

            **Example of using the 'All' display style**



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEDepict

   This namespace contains constants.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEDarkBackgroundColor

      This color is used as a background color for the
      :oe:const:`OEDepict::OEAtomColorStyle::BlackMonochrome` and the
      :oe:const:`OEDepict::OEAtomColorStyle::BlackCPK` atom
      color styles.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OELightBackgroundColor

      This color is used as a background color for the
      :oe:const:`OEDepict::OEAtomColorStyle::WhiteMonochrome` and the
      :oe:const:`OEDepict::OEAtomColorStyle::WhiteCPK` atom
      color styles.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEBlackBoxPen

      See example in :ref:`Figure: Example of using the 'OEBlackBoxPen' pen to draw a rectangle<figure_OEBlackBoxPen>`.

      .. _figure_OEBlackBoxPen:

      .. figure:: depicttk/images/OEBlackBoxPen.*
         :align:  center

         **Example of using the 'OEBlackBoxPen' pen to draw a rectangle**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEBlackPen

      See example in :ref:`Figure: Example of using the 'OEBlackPen' pen to draw a rectangle<figure_OEBlackPen>`.

      .. _figure_OEBlackPen:

      .. figure:: depicttk/images/OEBlackPen.*
         :align:  center

         **Example of using the 'OEBlackPen' pen to draw a rectangle**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEBlueBoxPen

      See example in :ref:`Figure: Example of using the 'OEBlueBoxPen' pen to draw a rectangle<figure_OEBlueBoxPen>`.

      .. _figure_OEBlueBoxPen:

      .. figure:: depicttk/images/OEBlueBoxPen.*
         :align:  center

         **Example of using the 'OEBlueBoxPen' pen to draw a rectangle**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEBluePen

      See example in :ref:`Figure: Example of using the 'OEBluePen' pen to draw a rectangle<figure_OEBluePen>`.

      .. _figure_OEBluePen:

      .. figure:: depicttk/images/OEBluePen.*
         :align:  center

         **Example of using the 'OEBluePen' pen to draw a rectangle**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEDefaultFont

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEGreenBoxPen

      See example in :ref:`Figure: Example of using the 'OEGreenBoxPen' pen to draw a rectangle<figure_OEGreenBoxPen>`.

      .. _figure_OEGreenBoxPen:

      .. figure:: depicttk/images/OEGreenBoxPen.*
         :align:  center

         **Example of using the 'OEGreenBoxPen' pen to draw a rectangle**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEGreenPen

      See example in :ref:`Figure: Example of using the 'OEGreenPen' pen to draw a rectangle<figure_OEGreenPen>`.

      .. _figure_OEGreenPen:

      .. figure:: depicttk/images/OEGreenPen.*
         :align:  center

         **Example of using the 'OEGreenPen' pen to draw a rectangle**

   .. ################################################################
      # OELightGreyBoxPen
      ################################################################

   .. oe:constant:: OELightGreyBoxPen

      See example in :ref:`Figure: Example of using the 'OELightGreyBoxPen' pen to draw a rectangle<figure_OELightGreyBoxPen>`.

      .. _figure_OELightGreyBoxPen:

      .. figure:: depicttk/images/OELightGreyBoxPen.*
         :align:  center

         **Example of using the 'OELightGreyBoxPen' pen to draw a rectangle**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OELightGreyPen

      See example in :ref:`Figure: Example of using the 'OELightGreyPen' pen to draw a rectangle<figure_OELightGreyPen>`.

      .. _figure_OELightGreyPen:

      .. figure:: depicttk/images/OELightGreyPen.*
         :align:  center

         **Example of using the 'OELightGreyPen' pen to draw a rectangle**

   .. ################################################################
      # OERedBoxPen
      ################################################################

   .. oe:constant:: OERedBoxPen

      See example in :ref:`Figure: Example of using the 'OERedBoxPen' pen to draw a rectangle<figure_OERedBoxPen>`.

      .. _figure_OERedBoxPen:

      .. figure:: depicttk/images/OERedBoxPen.*
         :align:  center

         **Example of using the 'OERedBoxPen' pen to draw a rectangle**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OERedPen

      See example in :ref:`Figure: Example of using the 'OERedPen' pen to draw a rectangle<figure_OERedPen>`.

      .. _figure_OERedPen:

      .. figure:: depicttk/images/OERedPen.*
         :align:  center

         **Example of using the 'OERedPen' pen to draw a rectangle**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OETransparentPen

      Pen with fully transparent foreground and background colors.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OESVGAreaPen

      Pen with almost transparent foreground and background colors.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEWhiteBoxPen

      See example in :ref:`Figure: Example of using the 'OEWhiteBoxPen' pen to draw a rectangle<figure_OEWhiteBoxPen>`.

      .. _figure_OEWhiteBoxPen:

      .. figure:: depicttk/images/OEWhiteBoxPen.*
         :align:  center

         **Example of using the 'OEWhiteBoxPen' pen to draw a rectangle**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEWhitePen

      See example in :ref:`Figure: Example of using the 'OEWhitePen' pen to draw a rectangle<figure_OEWhitePen>`.

      .. _figure_OEWhitePen:

      .. figure:: depicttk/images/OEWhitePen.*
         :align:  center

         **Example of using the 'OEWhitePen' pen to draw a rectangle**


.. _OEDepictConstants:

*******************
OEDepict Constants
*******************

.. oe:namespace:: OEDepict

.. toctree::

   OE2DMolDisplaySetup
   OE2DPathPointType
   OEAlignment
   OEAromaticStyle
   OEAtomColorStyle
   OEAtomStereoStyle
   OEBondColorStyle
   OEBondDisplayPosition
   OEBondDisplayType
   OEBondStereoStyle
   OEDepict
   OEDepictOrientation
   OEFill
   OEFontFamily
   OEFontStyle
   OEHighlightOverlayStyle
   OEHighlightParamName
   OEHighlightSetup
   OEHighlightStyle
   OEHydrogenPos
   OEHydrogenStyle
   OEIconLocation
   OEImageGridParamName
   OEImageGridSetup
   OEImageParamName
   OEImageSetup
   OEImageTableStyle
   OEInteractiveEffect
   OELayerPosition
   OELegendColorStyle
   OELegendInteractiveStyle
   OELegendLayoutStyle
   OELineCap
   OELineJoin
   OEMargin
   OEMultiPageParamName
   OEMultiPageSetup
   OEPageOrientation
   OEPageSize
   OEPrepareDepictionSetup
   OEProtectiveGroupStyle
   OERadicalDisplayType
   OEReportSetup
   OEScale
   OEStipple
   OESuperAtomStyle
   OETitleLocation


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEDepictOrientation

   This namespace contains constants that control the preferred orientation 
   of the 2D coordinates when calling the :oe:func:`OEDepict::OEPrepareDepiction` 
   function. 

   .. seealso::

      * :oe:meth:`OEDepict::OEPrepareDepictionOptions::GetDepictOrientation` method
      * :oe:meth:`OEDepict::OEPrepareDepictionOptions::SetDepictOrientation` method
      * :oe:func:`OEDepict::OEPrepareDepiction` function

   The :oe:constns:`OEDepict::OEDepictOrientation` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default orientation is 
      :oe:const:`OEDepict::OEDepictOrientation::Original`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Horizontal

      The orientation of the 2D coordinates is changed in order to maximize
      the scaling of the molecule for horizontal images.   
      See example above of depicting molecules with   
      :oe:const:`OEDepict::OEDepictOrientation::Default` and
      :oe:const:`OEDepict::OEDepictOrientation::Horizontal` orientations.

      .. _table_OEDepictOrientation_Horizonal:

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEDepictOrientation::Default`
           - :oe:const:`OEDepict::OEDepictOrientation::Horizontal`
         * - .. image:: ../images/OEDepictOrientation_Horizontal_Default.*
           - .. image:: ../images/OEDepictOrientation_Horizontal.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Original

      No-op *i.e* the orientation of the 2D coordinates are not
      optimized in order to maximize the molecule scaling.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Square

      The orientation of the 2D coordinates is changed in order to maximize
      the scaling of the molecule for square images.   
      See example above of depicting molecules with     
      :oe:const:`OEDepict::OEDepictOrientation::Default` and
      :oe:const:`OEDepict::OEDepictOrientation::Square` orientations.

      .. _table_OEDepictOrientation_Square:

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEDepictOrientation::Default`
           - :oe:const:`OEDepict::OEDepictOrientation::Square`
         * - .. image:: ../images/OEDepictOrientation_Square_Default.*
           - .. image:: ../images/OEDepictOrientation_Square.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Vertical
   
      The orientation of the 2D coordinates is changed in order to maximize
      the scaling of the molecule for vertical images.   
      See example above of depicting molecules with   
      :oe:const:`OEDepict::OEDepictOrientation::Default` and
      :oe:const:`OEDepict::OEDepictOrientation::Vertical` orientations.

      .. _table_OEDepictOrientation_Vertical:

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEDepictOrientation::Default`
           - :oe:const:`OEDepict::OEDepictOrientation::Vertical`
         * - .. image:: ../images/OEDepictOrientation_Vertical_Default.*
           - .. image:: ../images/OEDepictOrientation_Vertical.*
   



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEFill

   This namespace contains constants representing whether or not 
   background color of an :ref:`OEPen <OEDepict_OEPen>` object is used
   to *fill* a shape that is being drawn. 

   .. seealso::

      * :oe:meth:`OEDepict::OEPen::GetFill` method
      * :oe:meth:`OEDepict::OEPen::SetFill` method

   The :oe:constns:`OEDepict::OEFill` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default fill style is :oe:const:`OEDepict::OEFill::Off`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Off

      If the fill property of an :ref:`OEPen <OEDepict_OEPen>` object is
      **off** than the interior of the shape being drawn will be
      unfilled.
      See example in :ref:`Figure: Example of turning the object filling off<figure_OEFill_Off>`.

      .. _figure_OEFill_Off:

      .. figure:: depicttk/images/OEFill_Off.*
         :align:  center

         **Example of turning the object filling off**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: On

      If the fill property of an :ref:`OEPen <OEDepict_OEPen>` object is
      **on** than its background color is used to fill the interior of
      the shape being drawn.
      See example in :ref:`Figure: Example of turning the object filling off<figure_OEFill_On>`.

      .. _figure_OEFill_On:

      .. figure:: depicttk/images/OEFill_On.*
         :align:  center

         **Example of turning the object filling on**


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEFontFamily

   This namespace contains constants representing various font 
   family styles of the :ref:`OEFont <OEDepict_OEFont>` class.

   .. seealso::

      * :oe:meth:`OEDepict::OEFont::GetFamily` method
      * :oe:meth:`OEDepict::OEFont::SetFamily` method

   The :oe:constns:`OEDepict::OEFontFamily` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default font family is
      :oe:const:`OEDepict::OEFontFamily::Arial`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Arial

      Sans-serif typeface.
      See example in :ref:`Figure: Example of drawing text with 'Arial' font family<figure_OEFontFamily_Arial>`.

      .. _figure_OEFontFamily_Arial:

      .. figure:: depicttk/images/OEFontFamily_Arial.*
         :align:  center

         **Example of drawing text with 'Arial' font family**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Courier

      Mono-spaced slab serif typeface
      See example in :ref:`Figure: Example of drawing text with 'Courier' font family<figure_OEFontFamily_Courier>`.

      .. _figure_OEFontFamily_Courier:

      .. figure:: depicttk/images/OEFontFamily_Courier.*
         :align:  center

         **Example of drawing text with 'Courier' font family**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Helvetica

      Sans-serif typeface.
      See example in :ref:`Figure: Example of drawing text with 'Helvetica' font family<figure_OEFontFamily_Helvetica>`.

      .. _figure_OEFontFamily_Helvetica:

      .. figure:: depicttk/images/OEFontFamily_Helvetica.*
         :align:  center

         **Example of drawing text with 'Helvetica' font family**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Times

      Serif typeface.
      See example in :ref:`Figure: Example of drawing text with 'Times' font family<figure_OEFontFamily_Times>`.

      .. _figure_OEFontFamily_Times:

      .. figure:: depicttk/images/OEFontFamily_Times.*
         :align:  center

         **Example of drawing text with 'Times' font family**



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEFontStyle

   This namespace encodes symbolic constants used as bit-masks to 
   indicate the style of an :ref:`OEFont <OEDepict_OEFont>` object.

   .. seealso::

      * :oe:meth:`OEDepict::OEFont::GetStyle` method
      * :oe:meth:`OEDepict::OEFont::SetStyle` method

   The :oe:constns:`OEDepict::OEFontStyle` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default font style is :oe:const:`OEDepict::OEFontStyle::Normal`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bold

      See example in :ref:`Figure: Example of drawing text with 'Bold' font style<figure_OEFontStyle_Bold>`.

      .. _figure_OEFontStyle_Bold:

      .. figure:: depicttk/images/OEFontStyle_Bold.*
         :align:  center

         **Example of drawing text with 'Bold' font style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Italic

      See example in :ref:`Figure: Example of drawing text with 'Italic' font style<figure_OEFontStyle_Italic>`.

      .. _figure_OEFontStyle_Italic:

      .. figure:: depicttk/images/OEFontStyle_Italic.*
         :align:  center

         **Example of drawing text with 'Italic' font style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Normal

      See example in :ref:`Figure: Example of drawing text with 'Normal' font style<figure_OEFontStyle_Normal>`.

      .. _figure_OEFontStyle_Normal:

      .. figure:: depicttk/images/OEFontStyle_Normal.*
         :align:  center

         **Example of drawing text with 'Normal' font style**


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEHighlightOverlayStyle

   This namespace contains constants representing various styles
   of overlay highlighting.

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlightOverlay` function
      * :ref:`OEHighlightOverlayBase <OEDepict_OEHighlightOverlayBase>` class
      * :ref:`section_highlighting_overlap` section

   The :oe:constns:`OEDepict::OEHighlightOverlayStyle` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default highlighting style is
      :oe:const:`OEDepict::OEHighlightOverlayStyle::BallAndStick`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BallAndStick

      See example in :ref:`Figure: Example of overlay highlighting using the 'BallAndStick' style<figure_Overlay_BallAndStick>`.

      * Atoms are highlighted by depicting spheres underneath them.
        If an atom is part of more than one patterns, then all the
        colors associated with the patterns are used by turns to color
        pie segments of the sphere.

      * Bonds are highlighted by depicting sticks underneath them.
        If a bond is part of more than one patterns, then all the
        colors associated with the patterns are used by turns to color
        line segments of the stick.

      .. _figure_Overlay_BallAndStick:

      .. figure:: depicttk/images/OEHighlightOverlayStyle_BallAndStick.*
         :align:  center

         **Example of overlay highlighting using the 'BallAndStick' style**

      The radius of the spheres and the width of the sticks are automatically
      scaled with the molecule.
      See example in :ref:`Figure: Example of scaling the 'BallAndStick' style highlighting along with the molecule<figure_Overlay_BallAndStick_Scaling>`.

      .. _figure_Overlay_BallAndStick_Scaling:

      .. figure:: depicttk/images/HighlightOverlayScaling_BallAndStick.*
         :align:  center

         **Example of scaling the 'BallAndStick' style highlighting along with the molecule**

      .. seealso::

         * :ref:`OEHighlightOverlayByBallAndStick <OEDepict_OEHighlightOverlayByBallAndStick>` class

      .. note::

         It is recommended to select colors with high contrast when highlighting overlapped
         patterns with the :oe:const:`OEDepict::OEHighlightOverlayStyle::BallAndStick`
         style.

         .. seealso::

            * :oe:func:`OESystem::OEGetContrastColors` function

      Even though there is no limit on the number of overlapping patterns that can
      be highlighted simultaneously, attempting to highlight too many patterns will
      result in a complex image that will be difficult to visually interpret.
      See example in :ref:`Figure: Example of highlighting extremely overlapping patterns<figure_Overlay_BallAndStick_ManyPatterns>`
      In this image, all unique 'phenol' substructures of a molecule are
      highlighted simultaneously.

      .. _figure_Overlay_BallAndStick_ManyPatterns:

      .. figure:: depicttk/images/HighlightOverlayManyPatterns_BallAndStick.*
         :align:  center

         **Example of highlighting extremely overlapping patterns**


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEHighlightParamName

   This namespace contains the default parameter names used when the  
   interface generated by invoking the  
   :oe:func:`OEDepict::OEConfigureHighlightParams` function.

   .. seealso::

      * :oe:constns:`OEDepict::OEHighlightSetup` namespace.

   The :oe:constns:`OEDepict::OEHighlightParamName` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Color

      The default name of highlight color parameter is **"-highlightcolor"**.

      .. seealso::

         * :oe:const:`OEDepict::OEHighlightSetup::Color` constant
         * :oe:func:`OEDepict::OEConfigureHighlightColor` function
         * :oe:func:`OEDepict::OEGetHighlightColor` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Style

      The default name of highlight stylecolor parameter is **"-highlightstyle"**.

      .. seealso::

         * :oe:const:`OEDepict::OEHighlightSetup::Style` constant
         * :oe:func:`OEDepict::OEConfigureHighlightStyle` function
         * :oe:func:`OEDepict::OEGetHighlightStyle` function



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEHighlightSetup

   This namespace encodes symbolic constants used as bit-masks to 
   indicate which highlighting interface parameters are being 
   created when invoking the  
   :oe:func:`OEDepict::OEConfigureHighlightParams` function.

   .. seealso::

      * :oe:constns:`OEDepict::OEHighlightParamName` namespace

   The :oe:constns:`OEDepict::OEHighlightSetup` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEDepict::OEHighlightSetup::Color`
      * :oe:const:`OEDepict::OEHighlightSetup::Style`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Color

      Passing this constant to the  
      :oe:func:`OEDepict::OEConfigureHighlightParams` function result
      in generating the following default interface to configure
      the color of the highlighting by invoking
      the :oe:func:`OEDepict::OEConfigureHighlightColor` function.

      ::

         Contents of parameter -highlightcolor
             Aliases : -hcolor
             Type : string
             Allow list : false
             Default : red
             Simple : true
             Required : false
             Legal values : black blue bluetint brass brown copper cyan darkblue 
               darkbrown darkcyan darkgreen darkgrey darkmagenta darkorange 
               darkpurple darkred darkrose darksalmon darkyellow gold green 
               greenblue greentint grey hotpink lightblue lightbrown lightgreen 
               lightgrey lightorange lightpurple lightsalmon limegreen magenta 
               mediumblue mediumbrown mediumgreen mediumorange mediumpurple 
               mediumsalmon mediumyellow olivebrown olivegreen olivegrey pewter 
               orange pink pinktint purple red redorange royalblue seagreen silver 
               skyblue violet white yellow yellowtint

      .. seealso::

         * :oe:const:`OEDepict::OEHighlightParamName::Color` constant
         * :oe:func:`OEDepict::OEConfigureHighlightColor` function
         * :oe:func:`OEDepict::OEGetHighlightColor` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Style

      Passing this constant to the  
      :oe:func:`OEDepict::OEConfigureHighlightParams` function result 
      in generating the following default interface to configure 
      the style of the highlighting by invoking 
      the :oe:func:`OEDepict::OEConfigureHighlightStyle` function.

      ::

         Contents of parameter -highlightstyle
             Aliases : -hstyle
             Type : string
             Allow list : false
             Default : Color
             Simple : true
             Required : false
             Legal values : Color Stick BallAndStick Cogwheel Lasso
             Brief : Highlighting style

      .. seealso::

         * :oe:const:`OEDepict::OEHighlightParamName::Style` constant
         * :oe:func:`OEDepict::OEConfigureHighlightStyle` function
         * :oe:func:`OEDepict::OEGetHighlightStyle` function



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEHighlightStyle

   This namespace contains constants representing various styles
   of highlighting.

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlighting` function
      * :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` class
      * :ref:`chapter_highlighting` chapter

   The :oe:constns:`OEDepict::OEHighlightStyle` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default highlighting style is
      :oe:const:`OEDepict::OEHighlightStyle::Color`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BallAndStick

      See example in :ref:`Figure: Example of highlighting using the 'ball and stick' style<figure_BallAndStick>`.

      * Atoms are highlighted by depicting spheres underneath them.
      * Bonds are highlighted by depicting sticks underneath them.

      .. _figure_BallAndStick:

      .. figure:: depicttk/images/OEHighlightStyle_BallAndStick.*
         :align:  center

         **Example of highlighting using the 'ball and stick' style**

      The radius of the spheres and the width of the sticks are automatically
      scaled with the molecule.
      See example in :ref:`Figure: Example of scaling the 'ball and stick' style highlighting along with the molecule<figure_BallAndStick_Scaling>`.

      .. _figure_BallAndStick_Scaling:

      .. figure:: depicttk/images/HighlightScaling_BallAndStick.*
         :align:  center

         **Example of scaling the 'ball and stick' style highlighting along with the molecule**

      .. seealso::

         * :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>` class

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Color

      See example in :ref:`Figure: Example of highlighting using the 'color' style<figure_Color>`.

      * Atoms are highlighted by changing the color of their label,
        if present. If the atom being highlighted is an isolated carbon atom,
        then its atom label is explicitly displayed.
        See example in :ref:`Figure: Example of highlighting isolated atoms using the 'color' style<figure_Color_IsolatedAtoms>`.

      * Bonds are highlighted by changing their color.

      .. _figure_Color:

      .. figure:: depicttk/images/OEHighlightStyle_Color.*
         :align:  center

         **Example of highlighting using the 'color' style**

      .. _figure_Color_IsolatedAtoms:

      .. figure:: depicttk/images/HighlightingIsolatedAtoms_Color.*
         :align:  center

         **Example of highlighting isolated atoms using the 'color' style**

      .. seealso::

         * :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` class

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Cogwheel

      See example in :ref:`Figure: Example of highlighting using the 'cogwheel' style<figure_Cogwheel>`.

      .. _figure_Cogwheel:

      .. figure:: depicttk/images/OEHighlightStyle_Cogwheel.*
         :align:  center

         **Example of highlighting using the 'cogwheel' style**

      The radius of the spheres and the width of the sticks are automatically
      scaled with the molecule.
      See example in :ref:`Figure: Example of scaling the 'cogwheel' style highlighting
      along with the molecule<figure_Cogwheel_Scaling>`.

      .. _figure_Cogwheel_Scaling:

      .. figure:: depicttk/images/HighlightScaling_Cogwheel.*
         :align:  center

         **Example of scaling the 'cogwheel' style highlighting along with the molecule**

      .. seealso::

         * :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` class

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Lasso

      See example in :ref:`Figure: Example of highlighting using the 'lasso' style<figure_Lasso>`.

      Atoms and bond are highlighted by drawing a "curved" convex hull around
      them.

      .. _figure_Lasso:

      .. figure:: depicttk/images/OEHighlightStyle_Lasso.*
         :align:  center

         **Example of highlighting using the 'lasso' style**

      The width of "lasso" line is automatically scaled with the molecule.
      See example in :ref:`Figure: Example of scaling the 'lasso' style highlighting along with the molecule<figure_Lasso_Scaling>`.

      .. _figure_Lasso_Scaling:

      .. figure:: depicttk/images/HighlightScaling_Lasso.*
         :align:  center

         **Example of scaling the 'lasso' style highlighting along with the molecule**

      .. seealso::

         * :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>` class

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Stick

      See example in :ref:`Figure: Example of highlighting using the 'stick' style<figure_Stick>`.

      * Atoms are highlighted by changing the color of their label to
        be monochrome, if present.
        Isolated atoms are highlighted by depicting spheres underneath them.
        See example in :ref:`Figure: Example of highlighting isolated atoms using the 'stick' style<figure_Stick_IsolatedAtoms>`.

      * Bonds are highlighted by depicting sticks underneath them.

      .. _figure_Stick:

      .. figure:: depicttk/images/OEHighlightStyle_Stick.*
         :align:  center

         **Example of highlighting using the 'stick' style**

      .. _figure_Stick_IsolatedAtoms:

      .. figure:: depicttk/images/HighlightingIsolatedAtoms_Stick.*
         :align:  center

         **Example of highlighting isolated atoms using the 'stick' style**

      The width of the sticks is automatically scaled with the molecule.
      See example in :ref:`Figure: Example of scaling the 'stick' style highlighting along with the molecule<figure_Stick_Scaling>`.

      .. _figure_Stick_Scaling:

      .. figure:: depicttk/images/HighlightScaling_Stick.*
         :align:  center

         **Example of scaling the 'stick' style highlighting along with the molecule**

      .. seealso::

         * :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>` class


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEHydrogenPos

   This namespace contains constants representing the position of
   hydrogen relative to the atomic label.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DAtomDisplay::GetHPosition` method
      * :oe:meth:`OEDepict::OE2DAtomDisplay::SetHPosition` method

   .. _figure_hydrogen_pos:

   .. figure:: depicttk/images/OEHydrogenPos.*
      :align:  center

      Example of various hydrogen positions

   The :oe:constns:`OEDepict::OEHydrogenPos` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Undefined

      The position of the hydrogen is not calculated yet.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: East

      See atom with index 4 in
      :ref:`Figure: Example of various hydrogen positions<figure_hydrogen_pos>` 

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: North

      See atom with index 14 in
      :ref:`Figure: Example of various hydrogen positions<figure_hydrogen_pos>` 

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: South

      See atom with index 2 in
      :ref:`Figure: Example of various hydrogen positions<figure_hydrogen_pos>` 

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: West

      See atom with index 6 in
      :ref:`Figure: Example of various hydrogen positions<figure_hydrogen_pos>` 



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEHydrogenStyle

   This namespace contains constants that control how explicit and
   implicit hydrogen information is depicted.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetHydrogenStyle` method
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle` method

   The :oe:constns:`OEDepict::OEHydrogenStyle` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default hydrogen display style is the combination of
      :oe:const:`OEDepict::OEHydrogenStyle::ImplicitHetero` and
      :oe:const:`OEDepict::OEHydrogenStyle::ExplicitAll`.
      See example in :ref:`Figure: Example of the default hydrogens depiction<figure_OEHydrogenStyle_Default>`.

      .. _figure_OEHydrogenStyle_Default:

      .. figure:: depicttk/images/OEHydrogenStyle_Default.*
         :align:  center

         **Example of the default hydrogens depiction**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ExplicitAll

      Depicts all explicit hydrogens.
      See example in :ref:`Figure: Example of depicting all explicit hydrogens<figure_OEHydrogenStyle_ExplicitAll>`.

      .. _figure_OEHydrogenStyle_ExplicitAll:

      .. figure:: depicttk/images/OEHydrogenStyle_ExplicitAll.*
         :align:  center

         **Example of depicting all explicit hydrogens**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ExplicitHetero

      Depicts explicit hydrogens attached to hetero atoms.
      See example in :ref:`Figure: Example of depicting explicit hydrogens attached to hetero atoms<figure_OEHydrogenStyle_ExplicitHetero>`.

      .. _figure_OEHydrogenStyle_ExplicitHetero:

      .. figure:: depicttk/images/OEHydrogenStyle_ExplicitHetero.*
         :align:  center

         **Example of depicting explicit hydrogens attached to hetero atoms**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ExplicitTerminal

      Depicts explicit hydrogens attached to terminal atoms.
      See example in :ref:`Figure: Example of depicting explicit hydrogens attached to terminal atoms<figure_OEHydrogenStyle_ExplicitTerminal>`.

      .. _figure_OEHydrogenStyle_ExplicitTerminal:

      .. figure:: depicttk/images/OEHydrogenStyle_ExplicitTerminal.*
         :align:  center

         **Example of depicting explicit hydrogens attached to terminal atoms**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Hidden

      No hydrogen information is displayed.
      See example in :ref:`Figure: Example of hiding all hydrogens<figure_OEHydrogenStyle_Hidden>`.

      .. _figure_OEHydrogenStyle_Hidden:

      .. figure:: depicttk/images/OEHydrogenStyle_Hidden.*
         :align:  center

         **Example of hiding all hydrogens**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ImplicitAll

      Depicts all implicit hydrogens.
      See example in :ref:`Figure: Example of depicting all implicit hydrogens<figure_OEHydrogenStyle_ImplicitAll>`.

      .. _figure_OEHydrogenStyle_ImplicitAll:

      .. figure:: depicttk/images/OEHydrogenStyle_ImplicitAll.*
         :align:  center

         **Example of depicting all implicit hydrogens**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ImplicitHetero

      Depicts implicit hydrogens attached to hetero atoms.
      See example in :ref:`Figure: Example of depicting implicit hydrogens attached to hetero atoms<figure_OEHydrogenStyle_ImplicitHetero>`.

      .. _figure_OEHydrogenStyle_ImplicitHetero:

      .. figure:: depicttk/images/OEHydrogenStyle_ImplicitHetero.*
         :align:  center

         **Example of depicting implicit hydrogens attached to hetero atoms**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ImplicitTerminal

      Depicts implicit hydrogens attached to terminal atoms.
      See example in :ref:`Figure: Example of depicting implicit hydrogens attached to terminal atoms<figure_OEHydrogenStyle_ImplicitTerminal>`.

      .. _figure_OEHydrogenStyle_ImplicitTerminal:

      .. figure:: depicttk/images/OEHydrogenStyle_ImplicitTerminal.*
         :align:  center

         **Example of depicting implicit hydrogens attached to terminal atoms**



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEIconLocation

   This namespace contains constants representing the position of
   the logo when using the :oe:func:`OEDepict::OEAddOpenEyeIcon`
   and :oe:func:`OEDepict::OEAddInteractiveIcon` functions.
   The :oe:constns:`OEDepict::OEIconLocation` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default title location is
      :oe:const:`OEDepict::OEIconLocation::BottomRight`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BottomLeft

      .. figure:: depicttk/images/OEIconLocation_BottomLeft.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BottomRight

      .. figure:: depicttk/images/OEIconLocation_BottomRight.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TopLeft

      .. figure:: depicttk/images/OEIconLocation_TopLeft.*

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TopRight

      .. figure:: depicttk/images/OEIconLocation_TopRight.*


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEImageGridParamName

   This namespace contains the default parameter names used when the  
   interface generated by invoking the  
   :oe:func:`OEDepict::OEConfigureImageGridParams` function.

   .. seealso::

      * :oe:constns:`OEDepict::OEImageGridSetup` namespace.

   The :oe:constns:`OEDepict::OEImageGridParamName` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NumColumns

      The default name of number of grid columns parameter is **"-cols"**.

      .. seealso::

         * :oe:const:`OEDepict::OEImageGridSetup::NumColumns` constant
         * :oe:func:`OEDepict::OEConfigureImageGridNumColumns` function
         * :oe:func:`OEDepict::OEGetImageGridNumColumns` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NumRows

      The default name of number of grid rows parameter is **"-rows"**.

      .. seealso::
 
         * :oe:const:`OEDepict::OEImageGridSetup::NumRows` constant
         * :oe:func:`OEDepict::OEConfigureImageGridNumRows` function
         * :oe:func:`OEDepict::OEGetImageGridNumRows` function


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEImageGridSetup

   This namespace encodes symbolic constants used as bit-masks to 
   indicate which image grid interface parameters are being 
   created when invoking the  
   :oe:func:`OEDepict::OEConfigureImageGridParams` function.

   .. seealso::

      * :oe:constns:`OEDepict::OEImageGridParamName` namespace.

   The :oe:constns:`OEDepict::OEImageGridSetup` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEDepict::OEImageGridSetup::NumColumns`
      * :oe:const:`OEDepict::OEImageGridSetup::NumRows`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NumColumns

      Passing this constant to the  
      :oe:func:`OEDepict::OEConfigureImageGridParams` function result 
      in generating the following default interface to configure 
      the number of columns of image grid  by invoking 
      the :oe:func:`OEDepict::OEConfigureImageGridNumColumns` function.

      ::

         Contents of parameter -cols
             Aliases : -cols
             Type : int
             Allow list : false
             Default : 2
             Simple : true
             Required : false
             Legal ranges :
                 10 to 1
             Brief : Number of columns

      .. seealso::

         * :oe:const:`OEDepict::OEImageGridParamName::NumColumns` constant
         * :oe:func:`OEDepict::OEConfigureImageGridNumColumns` function
         * :oe:func:`OEDepict::OEGetImageGridNumColumns` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NumRows

      Passing this constant to the  
      :oe:func:`OEDepict::OEConfigureImageGridParams` function result 
      in generating the following default interface to configure 
      the number of row of image grid  by invoking 
      the :oe:func:`OEDepict::OEConfigureImageGridNumRows` function.

      ::

         Contents of parameter -rows
             Aliases : -rows
             Type : int
             Allow list : false
             Default : 3
             Simple : true
             Required : false
             Legal ranges :
                 10 to 1
             Brief : Number of rows

      .. seealso::

         * :oe:const:`OEDepict::OEImageGridParamName::NumRows` constant
         * :oe:func:`OEDepict::OEConfigureImageGridNumRows` function
         * :oe:func:`OEDepict::OEGetImageGridNumRows` function



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEImageParamName

   This namespace contains the default parameter names used when the  
   interface generated by invoking the  
   :oe:func:`OEDepict::OEConfigureImageOptions` function.

   .. seealso::

      * :oe:constns:`OEDepict::OEImageSetup` namespace.

   The :oe:constns:`OEDepict::OEMultiPageParamName` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Height

      The default name of the image height parameter is **"-height"**.

      .. seealso::

         * :oe:const:`OEDepict::OEImageSetup::Height` constant
         * :oe:func:`OEDepict::OEConfigureImageOptions` function
         * :oe:func:`OEDepict::OEGetImageHeight` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Width

      The default name of the image width parameter is **"-width"**.

      .. seealso::

         * :oe:const:`OEDepict::OEImageSetup::Width` constant
         * :oe:func:`OEDepict::OEConfigureImageOptions` function
         * :oe:func:`OEDepict::OEGetImageWidth` function


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEImageSetup

   This namespace encodes symbolic constants used as bit-masks to 
   indicate which image interface parameters are being 
   created when invoking the  
   :oe:func:`OEDepict::OEConfigureImageOptions` function.

   .. seealso::

      * :oe:constns:`OEDepict::OEImageParamName` namespace.

   The :oe:constns:`OEDepict::OEImageSetup` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEDepict::OEImageSetup::Width`
      * :oe:const:`OEDepict::OEImageSetup::Height`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Height

      Passing this constant to the  
      :oe:func:`OEDepict::OEConfigureImageOptions` function result 
      in generating the following default interface to configure 
      image width.

      ::

        Contents of parameter -width
            Aliases : -w
            Type : int
            Allow list : false
            Default : 0
            Simple : true
            Required : false
            Legal ranges :
                5000 to 0
            Brief : Width of output image

      .. seealso::

         * :oe:const:`OEDepict::OEImageParamName::Height` function
         * :oe:func:`OEDepict::OEConfigureImageOptions` function
         * :oe:func:`OEDepict::OEGetImageHeight` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Width

      Passing this constant to the  
      :oe:func:`OEDepict::OEConfigureImageOptions` function result 
      in generating the following default interface to configure 
      image width.

      ::

        Contents of parameter -height
            Aliases : -h
            Type : int
            Allow list : false
            Default : 0
            Simple : true
            Required : false
            Legal ranges :
                5000 to 0
            Brief : Height of output image

      .. seealso::

         * :oe:const:`OEDepict::OEImageParamName::Width` function
         * :oe:func:`OEDepict::OEConfigureImageOptions` function
         * :oe:func:`OEDepict::OEGetImageWidth` function



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEImageTableStyle

   This namespace contains constants that define built-in image table styles.

   .. seealso::

      * :ref:`OEImageTable <OEDepict_OEImageTable>` class
      * :ref:`OEImageTableOptions <OEDepict_OEImageTableOptions>` class

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default image table style is
      :oe:const:`OEDepict::OEImageTableStyle::NoStyle`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: LightBlue

      .. figure:: depicttk/images/OEImageTableStyle_LightBlue.*
         :align:  center

         **Examples of using the 'LightBlue' image table style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: LightGreen

      .. figure:: depicttk/images/OEImageTableStyle_LightGreen.*
         :align:  center

         **Examples of using the 'LightGreen' image table style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: LightGrey

      .. figure:: depicttk/images/OEImageTableStyle_LightGrey.*
         :align:  center

         **Examples of using the 'LightGrey' image table style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MediumBlue

      .. figure:: depicttk/images/OEImageTableStyle_MediumBlue.*
         :align:  center

         **Examples of using the 'MediumBlue' image table style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MediumGreen

      .. figure:: depicttk/images/OEImageTableStyle_MediumGreen.*
         :align:  center

         **Examples of using the 'MediumGreen' image table style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MediumGrey

      .. figure:: depicttk/images/OEImageTableStyle_MediumGrey.*
         :align:  center

         **Examples of using the 'MediumGrey' image table style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NoStyle

      .. figure:: depicttk/images/OEImageTableStyle_NoStyle.*
         :align:  center

         **Examples of using the 'NoStyle' image table style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SantaFe

      .. figure:: depicttk/images/OEImageTableStyle_SantaFe.*
         :align:  center

         **Examples of using the 'SantaFe' image table style**


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEInteractiveEffect

   This namespace contains constants related to interactive effects when generating
   :file:`SVG` images.

   .. oe:constant:: None

      No interactive effect.

   .. oe:constant:: Hover

      Interactive effect triggered when hovering over some area in the image.

   .. oe:constant:: Toggle

      Interactive effect triggered when clicking on some area in the image.



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OELayerPosition

   This namespace contains constants representing the position of
   layers available for an :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplay::GetLayer`

   The :oe:constns:`OEDepict::OELayerPosition` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Above

      Provides access to **above** image (:ref:`OEImage <OEDepict_OEImage>`) of a
      :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object.
      Everything drawn to this image  will be rendered last 
      when calling the :oe:func:`OEDepict::OERenderMolecule` function,
      as a result the image will appear **above** the molecule depiction.
      See example in :ref:`Figure: Example of drawing a triangle into the above layer<figure_OELayerPosition_Above>`.

      .. _figure_OELayerPosition_Above:

      .. figure:: depicttk/images/OELayerPosition_Above.*
         :align:  center

         **Example of drawing a triangle into the above layer**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Below

      Provides access to **below** image (:ref:`OEImage <OEDepict_OEImage>`) of a
      :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object.
      Everything drawn to this image  will be rendered first 
      when calling the :oe:func:`OEDepict::OERenderMolecule` function,
      as a result the image will appear **below** the molecule depiction.

      For example, the sticks drawn to highlighting bonds when using the
      :oe:const:`OEDepict::OEHighlightStyle::Stick` style all drawn 
      into a *below* layer.
      See example in :ref:`Figure: Example of drawing a triangle into the below layer<figure_OELayerPosition_Below>`.

      .. _figure_OELayerPosition_Below:

      .. figure:: depicttk/images/OELayerPosition_Below.*
         :align:  center

         **Example of drawing a triangle into the below layer**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SVG

      This layer is used internally when generating interactive SVG
      images.


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OELegendColorStyle

   This namespace contains constants that define built-in legend color styles.

   .. seealso::

      * :ref:`OELegendLayout <OEDepict_OELegendLayout>` class
      * :ref:`OELegendLayoutOptions <OEDepict_OELegendLayoutOptions>` class
      * :oe:constns:`OEDepict::OELegendLayoutStyle` namespace
      * :oe:constns:`OEDepict::OELegendInteractiveStyle` namespace

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default legend color style is
      :oe:const:`OEDepict::OELegendColorStyle::NoStyle`.

   .. oe:constant:: LightBlue

      .. figure:: depicttk/images/OELegendColorStyle_LightBlue.*
         :align:  center

         **Example of using the 'LightBlue' color style**

   .. oe:constant:: LightGreen

      .. figure:: depicttk/images/OELegendColorStyle_LightGreen.*
         :align:  center

         **Example of using the 'LightGreen' color style**

   .. oe:constant:: LightGrey

      .. figure:: depicttk/images/OELegendColorStyle_LightGrey.*
         :align:  center

         **Example of using the 'LightGrey' color style**

   .. oe:constant:: NoStyle

      .. figure:: depicttk/images/OELegendColorStyle_NoStyle.*
         :align:  center

         **Example of using the 'NoStyle' color style**




.. |Bezier|    replace:: Bézier


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OELegendInteractiveStyle

   This namespace contains constants that define built-in legend interactive styles.

   .. seealso::

      * :ref:`OELegendLayout <OEDepict_OELegendLayout>` class
      * :ref:`OELegendLayoutOptions <OEDepict_OELegendLayoutOptions>` class
      * :oe:constns:`OEDepict::OELegendLayoutStyle` namespace
      * :oe:constns:`OEDepict::OELegendColorStyle` namespace

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default legend interactive style is
      :oe:const:`OEDepict::OELegendInteractiveStyle::Hover`.

   .. oe:constant:: Hover

      .. note::

         This style is **only available** for :file:`.svg` image format.

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover mouse over the "Legend" label</b>
         </p>

         <p align="center">
         <object data="../../_images/OELegendInteractiveStyle_Hover.svg" type="image/svg+xml"  width = "300" ></object>
         <p>

         <p align="center">
         <b>Example of using the 'Hover' interactive style</b>
         <p>

      .. image:: /_images/OELegendInteractiveStyle_Hover.svg
         :width: 1pt

      .. only:: oepdf

         |NOPDFIMAGE|

   .. oe:constant:: Permanent

   .. only:: oehtml

      .. figure:: /_images/OELegendInteractiveStyle_Permanent.svg
         :align:  center
         :width: 300 pt

         **Example of using the 'Permanent' style (not interactive)**

      .. only:: oepdf

         |NOPDFIMAGE|

   .. oe:constant:: Toggle

      .. note::

         This style is **only available** for :file:`.svg` image format.

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>click on the "Legend" label</b>
         </p>

         <p align="center">
         <object data="../../_images/OELegendInteractiveStyle_Toggle.svg" type="image/svg+xml"  width = "300" ></object>
         <p>

         <p align="center">
         <b>Example of using the 'Toggle' interactive style</b>
         <p>

      .. image:: /_images/OELegendInteractiveStyle_Toggle.svg
         :width: 1pt

      .. only:: oepdf

         |NOPDFIMAGE|


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OELegendLayoutStyle

   This namespace contains constants that define built-in legend layout styles.

   .. seealso::

      * :ref:`OELegendLayout <OEDepict_OELegendLayout>` class
      * :ref:`OELegendLayoutOptions <OEDepict_OELegendLayoutOptions>` class
      * :oe:constns:`OEDepict::OELegendColorStyle` namespace
      * :oe:constns:`OEDepict::OELegendInteractiveStyle` namespace

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default legend layout style is
      :oe:const:`OEDepict::OELegendLayoutStyle::HorizontalTopLeft`.

   .. oe:constant:: HorizontalBottomLeft

      .. figure:: depicttk/images/OELegendLayoutStyle_HorizontalBottomLeft.*
         :align:  center

         **Example of using the 'HorizontalBottomLeft' layout style**

   .. oe:constant:: HorizontalBottomRight

      .. figure:: depicttk/images/OELegendLayoutStyle_HorizontalBottomRight.*
         :align:  center

         **Example of using the 'HorizontalBottomRight' layout style**

   .. oe:constant:: HorizontalTopLeft

      .. figure:: depicttk/images/OELegendLayoutStyle_HorizontalTopLeft.*
         :align:  center

         **Example of using the 'HorizontalTopLeft' layout style**

   .. oe:constant:: HorizontalTopRight

      .. figure:: depicttk/images/OELegendLayoutStyle_HorizontalTopRight.*
         :align:  center

         **Example of using the 'HorizontalTopRight' layout style**

   .. oe:constant:: VerticalBottomLeft

      .. figure:: depicttk/images/OELegendLayoutStyle_VerticalBottomLeft.*
         :align:  center

         **Example of using the 'VerticalBottomLeft' layout style**

   .. oe:constant:: VerticalBottomRight

      .. figure:: depicttk/images/OELegendLayoutStyle_VerticalBottomRight.*
         :align:  center

         **Example of using the 'VerticalBottomRight' layout style**

   .. oe:constant:: VerticalTopLeft

      .. figure:: depicttk/images/OELegendLayoutStyle_VerticalTopLeft.*
         :align:  center

         **Example of using the 'VerticalTopLeft' layout style**

   .. oe:constant:: VerticalTopRight

      .. figure:: depicttk/images/OELegendLayoutStyle_VerticalTopRight.*
         :align:  center

         **Example of using the 'VerticalTopRight' layout style**


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OELineCap

   This namespace contains constants that control how the endpoints 
   of lines are drawn. 

   .. seealso::

      * :oe:meth:`OEDepict::OEPen::GetLineCap` method
      * :oe:meth:`OEDepict::OEPen::SetLineCap` method

   The :oe:constns:`OEDepict::OELineCap` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default line cap style is
      :oe:const:`OEDepict::OELineCap::Round`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Butt

      Closes the line off with a straight edge that's normal (at 90
      degrees to) the direction of the stroke and crosses its end.
      See example in :ref:`Figure: Example of line drawing with 'Butt' line cap style<figure_OELineCap_Butt>`.

      .. _figure_OELineCap_Butt:

      .. figure:: depicttk/images/OELineCap_Butt.*
         :align:  center

         **Example of line drawing with 'Butt' line cap style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Round

      Produces a rounded effect on the end of the line.
      See example in :ref:`Figure: Example of line drawing with 'Round' line cap style<figure_OELineCap_Round>`.

      .. _figure_OELineCap_Round:

      .. figure:: depicttk/images/OELineCap_Round.*
         :align:  center

         **Example of line drawing with 'Round' line cap style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Square

      Has the same appearance as the :oe:const:`OEDepict::OELineCap::Butt` 
      style, but stretches the line slightly beyond the actual path.
      See example in :ref:`Figure: Example of line drawing with 'Square' line cap style<figure_OELineCap_Square>`.

      .. _figure_OELineCap_Square:

      .. figure:: depicttk/images/OELineCap_Square.*
         :align:  center

         **Example of line drawing with 'Square' line cap style**


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OELineJoin

   The line join style  controls how lines connect at corners when
   drawing outlines.

   .. seealso::

      * :oe:meth:`OEDepict::OEPen::GetLineJoin` method
      * :oe:meth:`OEDepict::OEPen::SetLineJoin` method

   The :oe:constns:`OEDepict::OELineJoin` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default line join style is
      :oe:const:`OEDepict::OELineJoin::Round`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bevel

      See example in :ref:`Figure: Example of line drawing with 'Bevel' line join style<figure_OELineJoin_Bevel>`.

      .. _figure_OELineJoin_Bevel:

      .. figure:: depicttk/images/OELineJoin_Bevel.*
         :align:  center

         **Example of line drawing with 'Bevel' line join style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Miter

      See example in :ref:`Figure: Example of line drawing with 'Miter' line join style<figure_OELineJoin_Miter>`.

      .. _figure_OELineJoin_Miter:

      .. figure:: depicttk/images/OELineJoin_Miter.*
         :align:  center

         **Example of line drawing with 'Miter' line join style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Round

      See example in :ref:`Figure: Example of line drawing with 'Round' line join style<figure_OELineJoin_Round>`.

      .. _figure_OELineJoin_Round:

      .. figure:: depicttk/images/OELineJoin_Round.*
         :align:  center

         **Example of line drawing with 'Round' line join style**



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEMargin

   This namespace contains constants representing the position of
   margins for the :ref:`OEImageGrid <OEDepict_OEImageGrid>` and
   the :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` classes .

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetMargin`
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetMargin`
      * :oe:meth:`OEDepict::OEImageGrid::SetMargin`
      * :oe:meth:`OEDepict::OEImageGrid::GetMargin`

   The :oe:constns:`OEDepict::OEMargin` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Top

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bottom

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Left

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Right



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEMultiPageParamName

   This namespace contains the default parameter names used when the  
   interface generated by invoking the  
   :oe:func:`OEDepict::OEConfigureMultiPageParams` function.

   .. seealso::

      * :oe:constns:`OEDepict::OEMultiPageSetup` namespace.

   The :oe:constns:`OEDepict::OEMultiPageParamName` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PageOrientation

      The default name of the page orientation parameter is **"-pageorientation"**.

      .. seealso::

         * :oe:const:`OEDepict::OEMultiPageSetup::PageOrientation` constant
         * :oe:func:`OEDepict::OEConfigureMultiPageOrientation` function
         * :oe:func:`OEDepict::OEGetMultiPageOrientation` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PageSize

      The default name of the page size parameter is **"-pagesize"**. 

      .. seealso::

         * :oe:const:`OEDepict::OEMultiPageSetup::PageSize` constant
         * :oe:func:`OEDepict::OEConfigureMultiPageSize` function
         * :oe:func:`OEDepict::OEGetMultiPageSize` function



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEMultiPageSetup

   This namespace encodes symbolic constants used as bit-masks to 
   indicate which multi page interface parameters are being 
   created when invoking the  
   :oe:func:`OEDepict::OEConfigureMultiPageParams` function.

   .. seealso::

      * :oe:constns:`OEDepict::OEMultiPageParamName` namespace.

   The :oe:constns:`OEDepict::OEMultiPageSetup` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEDepict::OEMultiPageSetup::PageOrientation`
      * :oe:const:`OEDepict::OEMultiPageSetup::PageSize`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PageOrientation

      Passing this constant to the  
      :oe:func:`OEDepict::OEConfigureMultiPageParams` function result 
      in generating the following default interface to configure 
      the page orientation by invoking 
      the :oe:func:`OEDepict::OEConfigureMultiPageOrientation` function.

      ::

         Contents of parameter -pageorientation
             Aliases : -pori
             Type : string
             Allow list : false
             Default : Portrait
             Simple : true
             Required : false
             Legal values : Portrait Landscape
             Brief : Page orientation

      .. seealso::

         * :oe:const:`OEDepict::OEMultiPageParamName::PageOrientation` constant
         * :oe:func:`OEDepict::OEConfigureMultiPageOrientation` function
         * :oe:func:`OEDepict::OEGetMultiPageOrientation` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PageSize

      Passing this constant to the  
      :oe:func:`OEDepict::OEConfigureMultiPageParams` function result 
      in generating the following default interface to configure 
      the page size by invoking 
      the :oe:func:`OEDepict::OEConfigureMultiPageSize` function.

      ::

         Contents of parameter -pagesize
             Aliases : -psize
             Type : string
             Allow list : false
             Default : US_Letter
             Simple : true
             Required : false
             Legal values : ISO_A4 US_Letter US_Legal Custom
             Brief : Page size

      .. seealso::

         * :oe:const:`OEDepict::OEMultiPageParamName::PageSize` constant
         * :oe:func:`OEDepict::OEConfigureMultiPageSize` function
         * :oe:func:`OEDepict::OEGetMultiPageSize` function


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEPageOrientation

   This namespace contains constants representing two page 
   orientations defined for multi-page images.

   .. seealso::

      * :ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` class

   The :oe:constns:`OEDepict::OEPageSize` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default page orientation is
      :oe:const:`OEDepict::OEPageOrientation::Portrait`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Portrait

      Orientation where the height of the page is greater than its 
      width.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Landscape

      Orientation where the width of the page is greater than its 
      height.



.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEPageSize

   This namespace contains constants representing various page sizes
   defined for multi-page images.

   .. seealso::

      * :ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` class
      * :oe:func:`OEDepict::OEGetPageWidth` function
      * :oe:func:`OEDepict::OEGetPageHeight` function

   The :oe:constns:`OEDepict::OEPageSize` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default page size is
      :oe:const:`OEDepict::OEPageSize::US_Letter`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ISO_A4

      Dimensions:  210 mm × 297 mm (8.27 in × 11.69 in)

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: US_Letter

      Dimensions:  216 mm × 279 mm (8.5 in × 11.0 in)

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: US_Legal

      Dimension:   216 mm × 356 mm  (8.5 in × 14.0 in)

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Custom

      Custom size


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEPrepareDepictionSetup

   This namespace encodes symbolic constants used as bit-masks to
   indicate which parameters are being created when invoking the
   :oe:func:`OEDepict::OEConfigurePrepareDepictionOptions` function.

   .. seealso::

      * :ref:`OEPrepareDepictionOptions <OEDepict_OEPrepareDepictionOptions>` class
      * :oe:func:`OEDepict::OEPrepareDepiction` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEDepict::OEPrepareDepictionSetup::ClearCoords`
      * :oe:const:`OEDepict::OEPrepareDepictionSetup::DepictOrientation`
      * :oe:const:`OEDepict::OEPrepareDepictionSetup::SuppressHydrogens`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ClearCoords

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigurePrepareDepictionOptions` result
      in generating the following default interface to configure
      whether the 2D coordinates of the molecule have to cleared and
      re-generated prior to molecule depiction.

      .. code-block:: console

         Contents of parameter -clearcoords
             Aliases : -clear
             Type : bool
             Allow list : false
             Default : false
             Simple : true
             Required : false
             Brief : Clears and regenerates 2D coordinates of depicted molecule

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DepictOrientation

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigurePrepareDepictionOptions` result
      in generating the following default interface to configure
      the preferred orientation of the 2D coordinates of the molecules.

      .. code-block:: console

         Contents of parameter -orientation
             Aliases : -orient
             Type : string
             Allow list : false
             Default : Original
             Simple : true
             Required : false
             Legal values : Original Square Vertical Horizontal
             Brief : Set the preferred orientation of 2D coordinates
             Detail
                 Original     - no-op
                 Square       - orient the molecule for square images
                 Vertical     - orient the molecule vertically
                 Horizontal   - orient the molecule horizontally

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SuppressHydrogens

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigurePrepareDepictionOptions` result
      in generating the following default interface to configure
      whether the hydrogens have to be suppressed prior to molecule
      depiction.

      .. code-block:: console

         Contents of parameter -suppressH
             Aliases : -sh
             Type : bool
             Allow list : false
             Default : false
             Simple : true
             Required : false
             Brief :  Suppress explicit hydrogens of depicted molecule
             Detail
                 Explicit hydrogens that are necessary to represent tetrahedral stereochemistry are kept


.. oe:namespace:: OEDepict

..  _OEDepict_OEProtectiveGroupStyle:

.. oe:constnamespace:: OEProtectiveGroupStyle

   This namespace contains constants representing the various protective
   group styles supported by **OEDepict TK**.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetProtectiveGroupStyle` method
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupStyle` method
      * :oe:constns:`OEDepict::OESuperAtomStyle` namespace

   The :oe:constns:`OEDepict::OEProtectiveGroupStyle` namespace contains the
   following constants. For some protective groups, more than one abbreviation can
   be used. The default is listed first.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default protective group style is
      :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Off

      No structural abbreviation is performed.
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of all protective group flags.

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::All`
         * - .. image:: ../images/OEProtectiveGroupStyle_All_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_All.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Ac

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Ac`
         * - .. image:: ../images/OEProtectiveGroupStyle_Ac_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Ac.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Ad

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Ad`
         * - .. image:: ../images/OEProtectiveGroupStyle_Ad_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Ad.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Alloc

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Alloc`
         * - .. image:: ../images/OEProtectiveGroupStyle_Alloc_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Alloc.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bn
   
   .. oe:constant:: Bzl

   .. oe:constant:: Benzyl  
   
      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Bn`
         * - 
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Bzl`
         * - 
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Benzyl`
         * - .. image:: ../images/OEProtectiveGroupStyle_Bn_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Bn.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   ..   _OEDepict_Boc:

   .. oe:constant:: Boc

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :ref:`Boc <OEDepict_Boc>`
         * - .. image:: ../images/OEProtectiveGroupStyle_Boc_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Boc.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bom

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Bom`
         * - .. image:: ../images/OEProtectiveGroupStyle_Bom_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Bom.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bpoc

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Bpoc`
         * - .. image:: ../images/OEProtectiveGroupStyle_Bpoc_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Bpoc.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bs

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Bs`
         * - .. image:: ../images/OEProtectiveGroupStyle_Bs_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Bs.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bt

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Bt`
         * - .. image:: ../images/OEProtectiveGroupStyle_Bt_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Bt.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Btm

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Btm`
         * - .. image:: ../images/OEProtectiveGroupStyle_Btm_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Btm.*
               :scale:  100
               :align:  center
   

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bz
   
   .. oe:constant:: Benzoyl

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Bz`
         * - 
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Benzoyl`
         * - .. image:: ../images/OEProtectiveGroupStyle_Benzoyl_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Benzoyl.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bzh

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Bzh`
         * - .. image:: ../images/OEProtectiveGroupStyle_Bzh_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Bzh.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BzOM

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::BzOM`
         * - .. image:: ../images/OEProtectiveGroupStyle_BzOM_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_BzOM.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: cHx

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::cHx`
         * - .. image:: ../images/OEProtectiveGroupStyle_cHx_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_cHx.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Dan
   
   .. oe:constant:: Dansyl

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Dan`
         * - 
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Dansyl`
         * - .. image:: ../images/OEProtectiveGroupStyle_Dan_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Dan.*
               :scale:  100
               :align:  center
   

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DCB

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DCB`
         * - .. image:: ../images/OEProtectiveGroupStyle_DCB_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DCB.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DDE

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DDE`
         * - .. image:: ../images/OEProtectiveGroupStyle_DDE_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DDE.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DDIV

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DDIV`
         * - .. image:: ../images/OEProtectiveGroupStyle_DDIV_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DDIV.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DEIPS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DEIPS`
         * - .. image:: ../images/OEProtectiveGroupStyle_DEIPS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DEIPS.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DMAB

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DMAB`
         * - .. image:: ../images/OEProtectiveGroupStyle_DMAB_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DMAB.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DMIPS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DMIPS`
         * - .. image:: ../images/OEProtectiveGroupStyle_DMIPS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DMIPS.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DMPM

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DMPM`
         * - .. image:: ../images/OEProtectiveGroupStyle_DMPM_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DMPM.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DMPS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DMPS`
         * - .. image:: ../images/OEProtectiveGroupStyle_DMPS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DMPS.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DMTr

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DMTr`
         * - .. image:: ../images/OEProtectiveGroupStyle_DMTr_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DMTr.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DNBZ

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DNBZ`
         * - .. image:: ../images/OEProtectiveGroupStyle_DNBZ_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DNBZ.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DNP

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DNP`
         * - .. image:: ../images/OEProtectiveGroupStyle_DNP_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DNP.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DOC

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DOC`
         * - .. image:: ../images/OEProtectiveGroupStyle_DOC_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DOC.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DPIPS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DPIPS`
         * - .. image:: ../images/OEProtectiveGroupStyle_DPIPS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DPIPS.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Dpp

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Dpp`
         * - .. image:: ../images/OEProtectiveGroupStyle_Dpp_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Dpp.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DTBMS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::DTBMS`
         * - .. image:: ../images/OEProtectiveGroupStyle_DTBMS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_DTBMS.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: EE

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::EE`
         * - .. image:: ../images/OEProtectiveGroupStyle_EE_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_EE.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ESC

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::ESC`
         * - .. image:: ../images/OEProtectiveGroupStyle_ESC_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_ESC.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Fmoc

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Fmoc`
         * - .. image:: ../images/OEProtectiveGroupStyle_Fmoc_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Fmoc.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FourOMeBz

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::FourOMeBz`
         * - .. image:: ../images/OEProtectiveGroupStyle_FourOMeBz_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_FourOMeBz.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FPMP

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::FPMP`
         * - .. image:: ../images/OEProtectiveGroupStyle_FPMP_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_FPMP.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Im

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Im`
         * - .. image:: ../images/OEProtectiveGroupStyle_Im_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Im.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Lev

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Lev`
         * - .. image:: ../images/OEProtectiveGroupStyle_Lev_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Lev.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MDIPS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::MDIPS`
         * - .. image:: ../images/OEProtectiveGroupStyle_MDIPS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_MDIPS.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MDPS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::MDPS`
         * - .. image:: ../images/OEProtectiveGroupStyle_MDPS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_MDPS.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MEM

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::MEM`
         * - .. image:: ../images/OEProtectiveGroupStyle_MEM_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_MEM.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Mes

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Mes`
         * - .. image:: ../images/OEProtectiveGroupStyle_Mes_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Mes.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MMTR

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::MMTR`
         * - .. image:: ../images/OEProtectiveGroupStyle_MMTR_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_MMTR.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MOM

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::MOM`
         * - .. image:: ../images/OEProtectiveGroupStyle_MOM_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_MOM.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Moz

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Moz`
         * - .. image:: ../images/OEProtectiveGroupStyle_Moz_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Moz.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MPC

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::MPC`
         * - .. image:: ../images/OEProtectiveGroupStyle_MPC_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_MPC.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MPM

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::MPM`
         * - .. image:: ../images/OEProtectiveGroupStyle_MPM_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_MPM.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::MS`
         * - .. image:: ../images/OEProtectiveGroupStyle_MS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_MS.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MTHP

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::MTHP`
         * - .. image:: ../images/OEProtectiveGroupStyle_MTHP_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_MTHP.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MTM

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::MTM`
         * - .. image:: ../images/OEProtectiveGroupStyle_MTM_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_MTM.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MTr

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::MTr`
         * - .. image:: ../images/OEProtectiveGroupStyle_MTr_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_MTr.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Np

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Np`
         * - .. image:: ../images/OEProtectiveGroupStyle_Np_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Np.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NPE

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::NPE`
         * - .. image:: ../images/OEProtectiveGroupStyle_NPE_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_NPE.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NPEOC

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::NPEOC`
         * - .. image:: ../images/OEProtectiveGroupStyle_NPEOC_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_NPEOC.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NPES

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::NPES`
         * - .. image:: ../images/OEProtectiveGroupStyle_NPES_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_NPES.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NPS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::NPS`
         * - .. image:: ../images/OEProtectiveGroupStyle_NPS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_NPS.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NVOC

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::NVOC`
         * - .. image:: ../images/OEProtectiveGroupStyle_NVOC_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_NVOC.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OBzl

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::OBzl`
         * - .. image:: ../images/OEProtectiveGroupStyle_OBzl_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_OBzl.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ONOS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::ONOS`
         * - .. image:: ../images/OEProtectiveGroupStyle_ONOS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_ONOS.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OtBu

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::OtBu`
         * - .. image:: ../images/OEProtectiveGroupStyle_OtBu_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_OtBu.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PAC

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::PAC`
         * - .. image:: ../images/OEProtectiveGroupStyle_PAC_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_PAC.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PBF

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::PBF`
         * - .. image:: ../images/OEProtectiveGroupStyle_PBF_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_PBF.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PCB

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::PCB`
         * - .. image:: ../images/OEProtectiveGroupStyle_PCB_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_PCB.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PHF

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::PHF`
         * - .. image:: ../images/OEProtectiveGroupStyle_PHF_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_PHF.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Pht

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Pht`
         * - .. image:: ../images/OEProtectiveGroupStyle_Pht_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Pht.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Piv

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Piv`
         * - .. image:: ../images/OEProtectiveGroupStyle_Piv_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Piv.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PMB

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::PMB`
         * - .. image:: ../images/OEProtectiveGroupStyle_PMB_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_PMB.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PMBM

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::PMBM`
         * - .. image:: ../images/OEProtectiveGroupStyle_PMBM_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_PMBM.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Poc

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Poc`
         * - .. image:: ../images/OEProtectiveGroupStyle_Poc_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Poc.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PPi

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::PPi`
         * - .. image:: ../images/OEProtectiveGroupStyle_PPi_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_PPi.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SEM

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::SEM`
         * - .. image:: ../images/OEProtectiveGroupStyle_SEM_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_SEM.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SES

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::SES`
         * - .. image:: ../images/OEProtectiveGroupStyle_SES_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_SES.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: StBu

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::StBu`
         * - .. image:: ../images/OEProtectiveGroupStyle_StBu_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_StBu.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TBMPS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::TBMPS`
         * - .. image:: ../images/OEProtectiveGroupStyle_TBMPS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_TBMPS.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################
   
   .. oe:constant:: TBDPS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::TBDPS`
         * - .. image:: ../images/OEProtectiveGroupStyle_TBDPS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_TBDPS.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TBDMS

   .. oe:constant:: TBS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::TBDMS`
         * - 
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::TBS`
         * - .. image:: ../images/OEProtectiveGroupStyle_TBS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_TBS.*
               :scale:  100
               :align:  center
   

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TCP

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::TCP`
         * - .. image:: ../images/OEProtectiveGroupStyle_TCP_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_TCP.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Teoc

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Teoc`
         * - .. image:: ../images/OEProtectiveGroupStyle_Teoc_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Teoc.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TES

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::TES`
         * - .. image:: ../images/OEProtectiveGroupStyle_TES_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_TES.*
               :scale:  100
               :align:  center

     
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Tf

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Tf`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Tf`
         * - .. image:: ../images/OEProtectiveGroupStyle_Tf_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Tf.*
               :scale:  100
               :align:  center
 
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TFA

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::TFA`
         * - .. image:: ../images/OEProtectiveGroupStyle_TFA_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_TFA.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Thexyl

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Thexyl`
         * - .. image:: ../images/OEProtectiveGroupStyle_Thexyl_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Thexyl.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: THF

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::THF`
         * - .. image:: ../images/OEProtectiveGroupStyle_THF_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_THF.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: THP

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::THP`
         * - .. image:: ../images/OEProtectiveGroupStyle_THP_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_THP.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TIPS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::TIPS`
         * - .. image:: ../images/OEProtectiveGroupStyle_TIPS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_TIPS.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TMOB

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::TMOB`
         * - .. image:: ../images/OEProtectiveGroupStyle_TMOB_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_TMOB.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TMS

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::TMS`
         * - .. image:: ../images/OEProtectiveGroupStyle_TMS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_TMS.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: transCinnamyl

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::transCinnamyl`
         * - .. image:: ../images/OEProtectiveGroupStyle_transCinnamyl_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_transCinnamyl.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Trisyl

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Trisyl`
         * - .. image:: ../images/OEProtectiveGroupStyle_Trisyl_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Trisyl.*
               :scale:  100
               :align:  center
   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Troc

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Troc`
         * - .. image:: ../images/OEProtectiveGroupStyle_Troc_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Troc.*
               :scale:  100
               :align:  center

   
   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TRT

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::TRT`
         * - .. image:: ../images/OEProtectiveGroupStyle_TRT_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_TRT.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TS
   
   .. oe:constant:: Tos

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::TS`
         * - .. image:: ../images/OEProtectiveGroupStyle_TS_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_TS.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Xyl

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Xyl`
         * - .. image:: ../images/OEProtectiveGroupStyle_Xyl_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Xyl.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Z
   
   .. oe:constant:: Cbz

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEProtectiveGroupStyle::Off`
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Z`
         * - 
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Cbz`
         * - .. image:: ../images/OEProtectiveGroupStyle_Cbz_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEProtectiveGroupStyle_Cbz.*
               :scale:  100
               :align:  center


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OERadicalDisplayType

   The :oe:constns:`OEDepict::OERadicalDisplayType` namespace contains the
   following constants:

   .. seealso::

      * :oe:meth:`OEDepict::OE2DAtomDisplay::GetRadical` method
      * :oe:meth:`OEDepict::OE2DAtomDisplay::SetRadical` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Off

      The atom is not a radical *i.e.* no information is rendered.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Diradical

      Atom with two unpaired electrons. Either electron-paired
      (singlet state) or electron-unpaired (triplet state).
      See example in :ref:`Figure: Example of a diradical carbon depiction<figure_OERadicalDisplayType_Diradical>`.

      .. _figure_OERadicalDisplayType_Diradical:

      .. figure:: depicttk/images/OERadicalDisplayType_Diradical.*
         :align:  center

         **Example of a diradical carbon depiction**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Monoradical

      Atom with one unpaired electron.
      See example in :ref:`Figure: Example of a monoradical carbon depiction<figure_OERadicalDisplayType_Monoradical>`.

      .. _figure_OERadicalDisplayType_Monoradical:

      .. figure:: depicttk/images/OERadicalDisplayType_Monoradical.*
         :align:  center

         **Example of a monoradical carbon depiction**


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEReportSetup

   This namespace encodes symbolic constants used as bit-masks to
   indicate which image report layout parameters are being
   created when invoking the
   :oe:func:`OEDepict::OEConfigureReportOptions` function.

   .. seealso::
   
      * :ref:`OEReport <OEDepict_OEReport>` class
      * :ref:`OEReportOptions <OEDepict_OEReportOptions>` class

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEDepict::OEReportSetup::NumColsPerPage`
      * :oe:const:`OEDepict::OEReportSetup::NumRowsPerPage`
      * :oe:const:`OEDepict::OEReportSetup::PageHeight`
      * :oe:const:`OEDepict::OEReportSetup::PageOrientation`
      * :oe:const:`OEDepict::OEReportSetup::PageSize`
      * :oe:const:`OEDepict::OEReportSetup::PageWidth`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NumColsPerPage

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigureReportOptions` function result
      in generating the following default interface to configure
      the number of columns per page.

      ::

         Contents of parameter -colsperpage
             Aliases : -cols
             Type : int
             Allow list : false
             Default : 2
             Simple : true
             Required : false
             Legal ranges :
                 10 to 1
             Brief : Number of columns per page

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::NumColsPerPage` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NumRowsPerPage

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigureReportOptions` function result
      in generating the following default interface to configure
      the number of rows per page.

      ::

         Contents of parameter -rowsperpage
             Aliases : -rows
             Type : int
             Allow list : false
             Default : 3
             Simple : true
             Required : false
             Legal ranges :
                 10 to 1
             Brief : Number of rows per page

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::NumRowsPerPage` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PageHeight

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigureReportOptions` function result
      in generating the following default interface to configure
      the page height of the report.

      ::

         Contents of parameter -pageheight
             Aliases : -h
             Type : double
             Allow list : false
             Default : (parameter does not have a default)
             Simple : true
             Required : false
             Legal ranges :
                 2000.0 to 100.0
             Brief : Page height

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageHeight` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PageOrientation

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigureReportOptions` function result
      in generating the following default interface to configure
      the page orientation of the report.

      ::

         Contents of parameter -pageorientation
             Aliases : -pori
             Type : string
             Allow list : false
             Default : Portrait
             Simple : true
             Required : false
             Legal values : Portrait Landscape
             Brief : Page orientation

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageOrientation` method
         * :oe:constns:`OEDepict::OEPageOrientation` namespace

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PageSize

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigureReportOptions` function result
      in generating the following default interface to configure
      the page size of the report.

      ::

         Contents of parameter -pagesize
             Aliases : -psize
             Type : string
             Allow list : false
             Default : US_Letter
             Simple : true
             Required : false
             Legal values : ISO_A4 US_Letter US_Legal Custom
             Brief : Page size

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageSize` method
         * :oe:constns:`OEDepict::OEPageSize` namespace

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PageWidth

      Passing this constant to the
      :oe:func:`OEDepict::OEConfigureReportOptions` function result
      in generating the following default interface to configure
      the page width of the report.

      ::

         Contents of parameter -pagewidth
             Aliases : -w
             Type : double
             Allow list : false
             Default : (parameter does not have a default)
             Simple : true
             Required : false
             Legal ranges :
                 2000.0 to 100.0
             Brief : Page width

      .. seealso::

         * :oe:meth:`OEDepict::OEReportOptions::SetPageWidth` method


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEScale

   This namespace contains constants that determine the scaling 
   factor of a molecule when positioned in an image.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale`
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetScale`
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions`

   The :oe:constns:`OEDepict::OEScale` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      Specifies the default scaling of a molecule.

      .. figure:: depicttk/images/DepictMol-Size-0-0-Default.*
         :align:  center

         **Default scaling of benzene**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AutoScale

      Auto scaling means that a depicted molecule is
      scaled to maximally fit the given image dimensions.   

      .. seealso::

        * :ref:`section_mol_display_size` section


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEStipple

   This namespace contains constants representing various stipple
   patterns.

   .. seealso::

      * :oe:meth:`OEDepict::OEPen::GetLineStipple` method
      * :oe:meth:`OEDepict::OEPen::SetLineStipple` method
      * :oe:meth:`OEDepict::OEPen::GetStippleFactor` method
      * :oe:meth:`OEDepict::OEPen::SetStippleFactor` method

   The :oe:constns:`OEDepict::OEStipple` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default line stipple style is
      :oe:const:`OEDepict::OEStipple::Solid`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Dot

      See example in :ref:`Figure: Example of line drawing with 'Dot' stipple style<figure_OEStipple_Dot>`.

      .. _figure_OEStipple_Dot:

      .. figure:: depicttk/images/OEStipple_Dot.*
         :align:  center

         **Example of line drawing with 'Dot' stipple style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DotDash

      See example in :ref:`Figure: Example of line drawing with 'DotDash' stipple style<figure_OEStipple_DotDash>`.

      .. _figure_OEStipple_DotDash:

      .. figure:: depicttk/images/OEStipple_DotDash.*
         :align:  center

         **Example of line drawing with 'DotDash' stipple style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DotDashDash

      See example in :ref:`Figure: Example of line drawing with 'DotDashDash' stipple style<figure_OEStipple_DotDashDash>`.

      .. _figure_OEStipple_DotDashDash:

      .. figure:: depicttk/images/OEStipple_DotDashDash.*
         :align:  center

         **Example of line drawing with 'DotDashDash' stipple style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: LongDash

      See example in :ref:`Figure: Example of line drawing with 'LongDash' stipple style<figure_OEStipple_LongDash>`.

      .. _figure_OEStipple_LongDash:

      .. figure:: depicttk/images/OEStipple_LongDash.*
         :align:  center

         **Example of line drawing with 'LongDash' stipple style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NoLine

      See example in :ref:`Table: Example of drawing rectangles with various stipple styles<table_OEStipple_Rectangle>`.

      .. _table_OEStipple_Rectangle:

      .. list-table:: **Example of drawing rectangles with various stipple styles**
         :widths: 100 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OEStipple::Solid`
           - :oe:const:`OEDepict::OEStipple::Dot`
           - :oe:const:`OEDepict::OEStipple::NoLine`
         * - .. image:: ../images/OEStipple_Rectangle_Solid.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEStipple_Rectangle_Dot.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OEStipple_Rectangle_NoLine.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ShortDash

      See example in :ref:`Figure: Example of line drawing with 'ShortDash' stipple style<figure_OEStipple_ShortDash>`.

      .. _figure_OEStipple_ShortDash:

      .. figure:: depicttk/images/OEStipple_ShortDash.*
         :align:  center

         **Example of line drawing with 'ShortDash' stipple style**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Solid

      See example in :ref:`Figure: Example of line drawing with 'Solid' stipple style<figure_OEStipple_Solid>`.

      .. _figure_OEStipple_Solid:

      .. figure:: depicttk/images/OEStipple_Solid.*
         :align:  center

         **Example of line drawing with 'Solid' stipple style**


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OESuperAtomStyle

   This namespace contains constants representing the various super
   atom styles supported by **OEDepict TK**.
   Super atoms are representing specific functional groups that are
   contracted into a single label.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle` method
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle` method
      * :oe:constns:`OEDepict::OEProtectiveGroupStyle` namespace

   The :oe:constns:`OEDepict::OESuperAtomStyle` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default super atom display style is
      :oe:const:`OEDepict::OESuperAtomStyle::Off`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of all super atom flags.

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::All`
         * - .. image:: ../images/OESuperAtomStyle_All_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_All.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Off

      No structural abbreviation is performed.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: COOH

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::COOH`
         * - .. image:: ../images/OESuperAtomStyle_COOH_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_COOH.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: COO_

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::COO_`
         * - .. image:: ../images/OESuperAtomStyle_COO_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_COO_.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: CHO

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::CHO`
         * - .. image:: ../images/OESuperAtomStyle_CHO_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_CHO.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NC

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::NC`
         * - .. image:: ../images/OESuperAtomStyle_NC_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_NC.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: CN

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::CN`
         * - .. image:: ../images/OESuperAtomStyle_CN_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_CN.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: N2

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::N2`
         * - .. image:: ../images/OESuperAtomStyle_N2_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_N2.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: N3

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::N3`
         * - .. image:: ../images/OESuperAtomStyle_N3_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_N3.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NCO

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::NCO`
         * - .. image:: ../images/OESuperAtomStyle_NCO_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_NCO.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NO2

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::NO2`
         * - .. image:: ../images/OESuperAtomStyle_NO2_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_NO2.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: CNO

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::CNO`
         * - .. image:: ../images/OESuperAtomStyle_CNO_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_CNO.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ONO

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::ONO`
         * - .. image:: ../images/OESuperAtomStyle_ONO_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_ONO.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SO3H

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::SO3H`
         * - .. image:: ../images/OESuperAtomStyle_SO3H_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_SO3H.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SO3_

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::SO3_`
         * - .. image:: ../images/OESuperAtomStyle_SO3_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_SO3_.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PO3H2

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::PO3H2`
         * - .. image:: ../images/OESuperAtomStyle_PO3H2_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_PO3H2.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: CF3

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::CF3`
         * - .. image:: ../images/OESuperAtomStyle_CF3_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_CF3.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: CCl3

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::CCl3`
         * - .. image:: ../images/OESuperAtomStyle_CCl3_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_CCl3.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Me

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::Me`
         * - .. image:: ../images/OESuperAtomStyle_Me_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_Me.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Et

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::Et`
         * - .. image:: ../images/OESuperAtomStyle_Et_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_Et.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Pr

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::Pr`
         * - .. image:: ../images/OESuperAtomStyle_Pr_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_Pr.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bu

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::Bu`
         * - .. image:: ../images/OESuperAtomStyle_Bu_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_Bu.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: iBu

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::iBu`
         * - .. image:: ../images/OESuperAtomStyle_iBu_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_iBu.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: sBu

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::sBu`
         * - .. image:: ../images/OESuperAtomStyle_sBu_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_sBu.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: tBu

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::tBu`
         * - .. image:: ../images/OESuperAtomStyle_tBu_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_tBu.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OMe

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::OMe`
         * - .. image:: ../images/OESuperAtomStyle_OMe_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_OMe.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OEt

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::OEt`
         * - .. image:: ../images/OESuperAtomStyle_OEt_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_OEt.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OPr

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::OPr`
         * - .. image:: ../images/OESuperAtomStyle_OPr_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_OPr.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OBu

      .. list-table::
         :widths: 100 100
         :header-rows: 1

         * - :oe:const:`OEDepict::OESuperAtomStyle::Off`
           - :oe:const:`OEDepict::OESuperAtomStyle::OBu`
         * - .. image:: ../images/OESuperAtomStyle_OBu_OFF.*
               :scale:  100
               :align:  center
           - .. image:: ../images/OESuperAtomStyle_OBu.*
               :scale:  100
               :align:  center

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Oxygen

      The combination of following super atom flags:

      * :oe:const:`OEDepict::OESuperAtomStyle::COOH`
      * :oe:const:`OEDepict::OESuperAtomStyle::COO_`
      * :oe:const:`OEDepict::OESuperAtomStyle::CHO`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Nitrogen

      The combination of the following super atom flags:

      * :oe:const:`OEDepict::OESuperAtomStyle::NC`
      * :oe:const:`OEDepict::OESuperAtomStyle::CN`
      * :oe:const:`OEDepict::OESuperAtomStyle::N2`
      * :oe:const:`OEDepict::OESuperAtomStyle::N3`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OxygenAndNitrogen

      The combination of the following super atom flags:

      * :oe:const:`OEDepict::OESuperAtomStyle::NCO`
      * :oe:const:`OEDepict::OESuperAtomStyle::NO2`
      * :oe:const:`OEDepict::OESuperAtomStyle::CNO`
      * :oe:const:`OEDepict::OESuperAtomStyle::ONO`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Sulfur

      The combination of the following super atom flags:

      * :oe:const:`OEDepict::OESuperAtomStyle::SO3H`
      * :oe:const:`OEDepict::OESuperAtomStyle::SO3_`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Phosphorus

      The combination of the  following super atom flags:

      * :oe:const:`OEDepict::OESuperAtomStyle::PO3H2`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Halide

      The combination of the following super atom flags:

      * :oe:const:`OEDepict::OESuperAtomStyle::CF3`
      * :oe:const:`OEDepict::OESuperAtomStyle::CCl3`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Carbon

      The combination of the following super atom flags:

      * :oe:const:`OEDepict::OESuperAtomStyle::Me`
      * :oe:const:`OEDepict::OESuperAtomStyle::Et`
      * :oe:const:`OEDepict::OESuperAtomStyle::Pr`
      * :oe:const:`OEDepict::OESuperAtomStyle::Bu`
      * :oe:const:`OEDepict::OESuperAtomStyle::iBu`
      * :oe:const:`OEDepict::OESuperAtomStyle::sBu`
      * :oe:const:`OEDepict::OESuperAtomStyle::tBu`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Ether

      The combination of the following super atom flags:

      * :oe:const:`OEDepict::OESuperAtomStyle::OMe`
      * :oe:const:`OEDepict::OESuperAtomStyle::OEt`
      * :oe:const:`OEDepict::OESuperAtomStyle::OPr`
      * :oe:const:`OEDepict::OESuperAtomStyle::OBu`


.. oe:namespace:: OEDepict

.. oe:constnamespace:: OETitleLocation

   This namespace contains constants representing the position of
   the molecule title:

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetTitleLocation`
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleLocation`

   The :oe:constns:`OEDepict::OETitleLocation` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default title location is
      :oe:const:`OEDepict::OETitleLocation::Top`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bottom

      See example in :ref:`Figure: Example of displaying molecule title at the bottom<figure_OETitleLocation_Bottom>`.

      .. _figure_OETitleLocation_Bottom:

      .. figure:: depicttk/images/OETitleLocation_Bottom.*
         :align:  center

         **Example of displaying molecule title at the bottom**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Hidden

      See example in :ref:`Figure: Example of displaying molecule with no title<figure_OETitleLocation_Hidden>`.

      .. _figure_OETitleLocation_Hidden:

      .. figure:: depicttk/images/OETitleLocation_Hidden.*
         :align:  center

         **Example of displaying molecule with no title**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Top

      See example in :ref:`Figure: Example of displaying molecule title at the top<figure_OETitleLocation_Top>`.

      .. _figure_OETitleLocation_Top:

      .. figure:: depicttk/images/OETitleLocation_Top.*
         :align:  center

         **Example of displaying molecule title at the top**


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEAddBuiltInHiddenSVGClass:

.. oe:function:: OEAddBuiltInHiddenSVGClass

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OESVGClass* OEAddBuiltInHiddenSVGClass(OEImageBase& image)

   .. oe:language:: python

      .. oe:api:: python

         OEAddBuiltInHiddenSVGClass(image: OEImageBase) -> OESVGClass

   Adds an :ref:`OESVGClass <OEDepict_OESVGClass>` to the given image that can be
   used to mark up a group of SVG elements to be hidden.

   .. seealso::

      * :ref:`OESVGClass <OEDepict_OESVGClass>` class
      * :ref:`OEImage <OEDepict_OEImage>` class
      * :oe:func:`OEDepict::OEAddBuiltInVisibleSVGClass` function
      * :oe:func:`OEDepict::OEGetBuiltInHiddenSVGClass` function
      * :oe:func:`OEDepict::OEGetBuiltInVisibleSVGClass` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEAddBuiltInVisibleSVGClass:

.. oe:function:: OEAddBuiltInVisibleSVGClass

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OESVGClass* OEAddBuiltInVisibleSVGClass(OEImageBase& image)

   .. oe:language:: python

      .. oe:api:: python

         OEAddBuiltInVisibleSVGClass(image: OEImageBase) -> OESVGClass

   Adds an :ref:`OESVGClass <OEDepict_OESVGClass>` to the given image that can be
   used to mark up a group of SVG elements to be visible.

   .. seealso::

      * :ref:`OESVGClass <OEDepict_OESVGClass>` class
      * :ref:`OEImage <OEDepict_OEImage>` class
      * :oe:func:`OEDepict::OEAddBuiltInHiddenSVGClass` function
      * :oe:func:`OEDepict::OEGetBuiltInHiddenSVGClass` function
      * :oe:func:`OEDepict::OEGetBuiltInVisibleSVGClass` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEAddDepictionHydrogens

.. _OEDepict_OEAddDepictionHydrogens:

.. oe:function:: OEAddDepictionHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddDepictionHydrogens(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEAddDepictionHydrogens(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Adds explicit "depiction" hydrogens to the specified
   :ref:`OEMolBase <OEChem_OEMolBase>`.
   Depiction hydrogens are hydrogens that need to be explicitly drawn
   in a 2D depiction to faithfully represent tetrahedral
   atom stereochemistry or cis/trans bond stereochemistry.

   The :oe:func:`OEDepict::OEAddDepictionHydrogens` function identifies
   all implicit depiction hydrogens (using the
   :oe:func:`OEDepict::OEHasDepictionHydrogens` function), and converts
   them into explicit hydrogens using the
   :oe:func:`OEChem::OEAddExplicitHydrogens` function.
   This function returns true if any depiction hydrogens were
   converted into explicit atoms.

   .. seealso::

      * :oe:func:`OEDepict::OEHasDepictionHydrogens` function
      * :oe:func:`OEDepict::OESuppressNonDepictionHydrogens` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEAddHighlightOverlay

.. _OEDepict_OEAddHighlightOverlay:

.. oe:function:: OEAddHighlightOverlay

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddHighlightOverlay(OE2DMolDisplay& disp,
                                    const OEHighlightOverlayBase& highlight,
                                    OESystem::OEIter<OEChem::OEMatchBase>& matches)
         void OEAddHighlightOverlay(OE2DMolDisplay& disp,
                                    const OEHighlightOverlayBase& highlight,
                                    OESystem::OEIter<OEChem::OEAtomBondSet>& absets)
         void OEAddHighlightOverlay(OE2DMolDisplay& disp,
                                    const OEHighlightOverlayBase& highlight,
                                    OESystem::OEIterBase<OEChem::OEMatchBase>* matches)
         void OEAddHighlightOverlay(OE2DMolDisplay& disp,
                                    const OEHighlightOverlayBase& highlight,
                                    OESystem::OEIterBase<OEChem::OEAtomBondSet>* absets)
         void OEAddHighlightOverlay(OE2DMolDisplay& disp,
                                    const OEHighlightOverlayBase& highlight,
                                    const std::vector<OEChem::OEAtomBondSet>& absets)

   .. oe:language:: python

      .. oe:api:: python

         OEAddHighlightOverlay(disp: OE2DMolDisplay,
                               highlight: OEHighlightOverlayBase,
                               matches: OEMatchBaseIter) -> None
         OEAddHighlightOverlay(disp: OE2DMolDisplay,
                               highlight: OEHighlightOverlayBase,
                               absets: OEAtomBondSetIter) -> None
         OEAddHighlightOverlay(disp: OE2DMolDisplay,
                               highlight: OEHighlightOverlayBase,
                               absets: OEAtomBondSetVector) -> None

   Highlights a set of atoms and/or bonds of the displayed molecule.

   **Parameters :**

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object of which atoms
      add/or bonds being highlighted.

   *highlight*
      The :ref:`OEHighlightOverlayBase <OEDepict_OEHighlightOverlayBase>` object that specifies the style of the highlighting.

   *matches*
      The iterator of :ref:`OEMatchBase <OEChem_OEMatchBase>` objects of which
      target atoms and bonds being highlighted.

   *absets*
      The iterator of :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` objects of which
      atoms and bonds being highlighted.

   .. note::

      Each pattern will be highlighted with a different color returned by the
      :oe:meth:`OEDepict::OEHighlightOverlayBase::GetColors` method.

   .. seealso::

      * :ref:`OEHighlightOverlayBase <OEDepict_OEHighlightOverlayBase>` class
      * :oe:constns:`OEDepict::OEHighlightOverlayStyle` namespace
      * :ref:`section_highlighting_overlap` section




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEAddHighlighting

.. _OEDepict_OEAddHighlighting:

.. oe:function:: OEAddHighlighting

   Highlights atoms and/or bonds of the displayed molecule.

   .. list-table:: **The overloaded versions of the OEAddHighlighting function using OEHighlightBase**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OEAddHighlighting(disp, highlight, atompred)<api_OEAddHighlighting_OE2DMolDisplay_OEHighlightBase_AtomPred>`
        - highlights atoms with :ref:`OEHighlightBase <OEDepict_OEHighlightBase>`
      * - :ref:`OEAddHighlighting(disp, highlight, bondpred)<api_OEAddHighlighting_OE2DMolDisplay_OEHighlightBase_BondPred>`
        - highlights bonds  with :ref:`OEHighlightBase <OEDepict_OEHighlightBase>`
      * - :ref:`OEAddHighlighting(disp, highlight, atompred, bondpred)<api_OEAddHighlighting_OE2DMolDisplay_OEHighlightBase_AtomAndBondPred>`
        - highlights atoms and bonds  with :ref:`OEHighlightBase <OEDepict_OEHighlightBase>`
      * - :ref:`OEAddHighlighting(disp, highlight, match)<api_OEAddHighlighting_OE2DMolDisplay_OEHighlightBase_OEMatchBase>`
        - highlights atoms and bonds of a match  with :ref:`OEHighlightBase <OEDepict_OEHighlightBase>`
      * - :ref:`OEAddHighlighting(disp, highlight, abset)<api_OEAddHighlighting_OE2DMolDisplay_OEHighlightBase_OEAtomBondSet>`
        - highlights atoms and bonds of a set with :ref:`OEHighlightBase <OEDepict_OEHighlightBase>`
      * - :ref:`OEAddHighlighting(disp, highlight, subsearch)<api_OEAddHighlighting_OE2DMolDisplay_OEHighlightBase_OESubSearch>`
        - highlights atoms and bonds of substructure matches :ref:`OEHighlightBase <OEDepict_OEHighlightBase>`

   .. list-table:: **The overloaded versions of the OEAddHighlighting function using color and style**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OEAddHighlighting(disp, color, style, atompred)<api_OEAddHighlighting_OE2DMolDisplay_OEColor_OEHighlightStyle_AtomPred>`
        - highlights atoms with color and style
      * - :ref:`OEAddHighlighting(disp, color, style, bondpred)<api_OEAddHighlighting_OE2DMolDisplay_OEColor_OEHighlightStyle_BondPred>`
        - highlights bonds with color and style
      * - :ref:`OEAddHighlighting(disp, color, style, atompred, bondpred)<api_OEAddHighlighting_OE2DMolDisplay_OEHighlightBase_AtomAndBondPred>`
        - highlights atoms and bonds with color and style
      * - :ref:`OEAddHighlighting(disp, color, style, match)<api_OEAddHighlighting_OE2DMolDisplay_OEColor_OEHighlightStyle_OEMatchBase>`
        - highlights atoms and bonds of a match with color and style
      * - :ref:`OEAddHighlighting(disp, color, style, abset)<api_OEAddHighlighting_OE2DMolDisplay_OEColor_OEHighlightStyle_OEAtomBondSet>`
        - highlights atoms and bonds of a set with color and style
      * - :ref:`OEAddHighlighting(disp, color, style, subsearch)<api_OEAddHighlighting_OE2DMolDisplay_OEColor_OEHighlightStyle_OESubSearch>`
        - highlights atoms and bonds of substructure matches

   **Parameters :**

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object of which atoms
      add/or bonds being highlighted.

   *highlight*
      The :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` object that specifies the style of the highlighting.

   *color*
      The :ref:`OEColor <OESystem_OEColor>` object that specifies the color of the highlighting.

   *style*
      The style of the highlighting from the
      :oe:constns:`OEDepict::OEHighlightStyle` namespace.

   *atompred*
      :oe:func:`OEDepict::OEAddHighlighting` function highlights
      only atoms for which the given atom predicate returns `true`.

   *bondpred*
      :oe:func:`OEDepict::OEAddHighlighting` function highlights
      only bonds for which the given bond predicate returns `true`.

   *match*
      :oe:func:`OEDepict::OEAddHighlighting` function highlights the
      target atoms and bonds of the :ref:`OEMatchBase <OEChem_OEMatchBase>` object.

   *abset*
      Stores the atoms and bonds being highlighted.

   *subsearch*
      The substructure search object of the matches being highlighted.

   **Highlights atom and/or bonds with the style implemented in the given**
   :ref:`OEHighlightBase <OEDepict_OEHighlightBase>`  **object**

   The atoms and bonds being highlighted can be specified either
   by a predicate or an :ref:`OEMatchBase <OEChem_OEMatchBase>` object or an
   :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object.

   The following code snippets show different ways to highlight any 6
   membered aromatic ring in a molecule using the
   :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>` highlighting class.
   They all generate the image shown in
   :ref:`Figure: Example of highlighting 6-membered aromatic rings
   <figure_OEAddHighlighting_OEHighlightBase>`.

   #. Highlighting using **atom** and **bond predicates**:

      .. _api_OEAddHighlighting_OE2DMolDisplay_OEHighlightBase_AtomPred:

      .. oe:api::

         void OEAddHighlighting(OE2DMolDisplay& disp,
                                const OEHighlightBase& highlight,
                                const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& atompred)

      Highlights atoms with the style implemented in the given :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` object.
      The atoms being highlighted are specified by given atom predicate.

      .. _api_OEAddHighlighting_OE2DMolDisplay_OEHighlightBase_BondPred:

      .. oe:api::

         void OEAddHighlighting(OE2DMolDisplay& disp,
                                const OEHighlightBase& highlight,
                                const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& bondpred)

      Highlights bonds with the style implemented in the given :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` object.
      The bonds being highlighted are specified by given bond predicates.

      .. _api_OEAddHighlighting_OE2DMolDisplay_OEHighlightBase_AtomAndBondPred:

      .. oe:api::

          void OEAddHighlighting(OE2DMolDisplay& disp,
                                 const OEHighlightBase& highlight,
                                 const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& atompred,
                                 const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& bondpred)

      Highlights atoms and bonds with the style implemented in the given :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` object.
      The atoms and bonds being highlighted are specified by given atom and bond predicates, respectively.

      **Example:** (See image generated in :ref:`figure_OEAddHighlighting_OEHighlightBase`)

      .. oe:source:: OEAddHighlighting_Base.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-PREDICATE

      .. oe:source:: OEAddHighlighting_Base.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-PREDICATE

      .. oe:source:: OEAddHighlighting_Base.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-PREDICATE

      .. oe:source:: OEAddHighlighting_Base.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-PREDICATE

   #. Highlighting using an :ref:`OEMatchBase <OEChem_OEMatchBase>` object that is
      initialized by substructure search or maximum common substructure search:

      .. _api_OEAddHighlighting_OE2DMolDisplay_OEHighlightBase_OEMatchBase:

      .. oe:api::

         void OEAddHighlighting(OE2DMolDisplay& disp,
                                const OEHighlightBase& highlight,
                                const OEChem::OEMatchBase& match)

      **Example:** (See image generated in :ref:`figure_OEAddHighlighting_OEHighlightBase`)

      .. oe:source:: OEAddHighlighting_Base.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEMATCH

      .. oe:source:: OEAddHighlighting_Base.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEMATCH

      .. oe:source:: OEAddHighlighting_Base.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEMATCH

      .. oe:source:: OEAddHighlighting_Base.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEMATCH

   #. Highlighting using an :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object that stores
      the atoms and bonds being highlighted:

      .. _api_OEAddHighlighting_OE2DMolDisplay_OEHighlightBase_OEAtomBondSet:

      .. oe:api::

          void OEAddHighlighting(OE2DMolDisplay& disp,
                                 const OEHighlightBase& highlight,
                                 const OEChem::OEAtomBondSet& abset)

      **Example:** (See image generated in :ref:`figure_OEAddHighlighting_OEHighlightBase`)

      .. oe:source:: OEAddHighlighting_Base.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEATOMBONDSET

      .. oe:source:: OEAddHighlighting_Base.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEATOMBONDSET

      .. oe:source:: OEAddHighlighting_Base.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEATOMBONDSET

      .. oe:source:: OEAddHighlighting_Base.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEATOMBONDSET

   #. Highlighting using an :ref:`OESubSearch <OEChem_OESubSearch>` of which matches are being highlighted:

      .. _api_OEAddHighlighting_OE2DMolDisplay_OEHighlightBase_OESubSearch:

      .. oe:api::

         void OEAddHighlighting(OE2DMolDisplay& disp,
                                const OEHighlightBase& highlight,
                                const OEChem::OESubSearch& subsearch)

      **Example:** (See image generated in :ref:`figure_OEAddHighlighting_OEHighlightBase`)

      .. oe:source:: OEAddHighlighting_Base.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OESUBSEARCH

      .. oe:source:: OEAddHighlighting_Base.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OESUBSEARCH

      .. oe:source:: OEAddHighlighting_Base.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OESUBSEARCH

      .. oe:source:: OEAddHighlighting_Base.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OESUBSEARCH

   .. _figure_OEAddHighlighting_OEHighlightBase:

   .. figure:: depicttk/images/OEAddHighlighting-OEHighlightBase-OEMatch.*
      :align:  center

      **Example of highlighting 6-membered aromatic rings**

   .. seealso::

      * :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` class
      * :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` class
      * :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>` class
      * :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>` class
      * :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>` class
      * :oe:func:`OEDepict::OEDrawHighlighting` function
      * :ref:`chapter_highlighting` chapter

   .. #############################################################

   **Highlights atoms and/or bonds with the given color and style**

   The atoms and bonds being highlighted can be specified either
   by a predicate or an :ref:`OEMatchBase <OEChem_OEMatchBase>` object or an
   :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object.

   The following code snippets show three different ways to highlight any 6
   membered aromatic ring in a molecule using the
   built-in highlighting styles.
   They all generate the image shown in
   :ref:`Figure: Example of highlighting 6-membered aromatic rings
   <figure_OEAddHighlighting_OEHighlightStyle>`.

   #. Highlighting using **atom** and **bond predicates**:

      .. _api_OEAddHighlighting_OE2DMolDisplay_OEColor_OEHighlightStyle_AtomPred:

      .. oe:api::

         void OEAddHighlighting(OE2DMolDisplay& disp,
                                const OESystem::OEColor& color,
                                unsigned int style,
                                const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& atompred)

      Highlights atoms with the given color and style.
      The atoms being highlighted are specified by given atom predicate.

      .. _api_OEAddHighlighting_OE2DMolDisplay_OEColor_OEHighlightStyle_BondPred:

      .. oe:api::

         void OEAddHighlighting(OE2DMolDisplay& disp,
                                const OESystem::OEColor& color,
                                unsigned int style,
                                const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& bondpred)

      Highlights bonds with the given color and style.
      The bonds being highlighted are specified by given bonds predicate.

      .. _api_OEAddHighlighting_OE2DMolDisplay_OEColor_OEHighlightStyle_AtomAndBondPred:

      .. oe:api::

         void OEAddHighlighting(OE2DMolDisplay& disp,
                                const OESystem::OEColor& color,
                                unsigned int style,
                                const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& atompred,
                                const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& bondpred)

      Highlights atoms and bonds with the given color and style.
      The atoms and bonds being highlighted are specified by given atom and bond predicates, respectively.

      **Example:** (See image generated in :ref:`figure_OEAddHighlighting_OEHighlightStyle`)

      .. oe:source:: OEAddHighlighting_Style.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-PREDICATE

      .. oe:source:: OEAddHighlighting_Style.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-PREDICATE

      .. oe:source:: OEAddHighlighting_Style.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-PREDICATE

      .. oe:source:: OEAddHighlighting_Style.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-PREDICATE

   #. Highlighting using an :ref:`OEMatchBase <OEChem_OEMatchBase>` object that is
      initialized by substructure search or maximum common substructure search:

      .. _api_OEAddHighlighting_OE2DMolDisplay_OEColor_OEHighlightStyle_OEMatchBase:

      .. oe:api::

         void OEAddHighlighting(OE2DMolDisplay& disp,
                                const OESystem::OEColor& color,
                                unsigned int style,
                                const OEChem::OEMatchBase& match)

      **Example:** (See image generated in :ref:`figure_OEAddHighlighting_OEHighlightStyle`)

      .. oe:source:: OEAddHighlighting_Style.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEMATCH

      .. oe:source:: OEAddHighlighting_Style.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEMATCH

      .. oe:source:: OEAddHighlighting_Style.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEMATCH

      .. oe:source:: OEAddHighlighting_Style.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEMATCH

   #. Highlighting using an :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object that stores
      the atoms and bonds being highlighted:

      .. _api_OEAddHighlighting_OE2DMolDisplay_OEColor_OEHighlightStyle_OEAtomBondSet:

      .. oe:api::

         void OEAddHighlighting(OE2DMolDisplay& disp,
                                const OESystem::OEColor& color,
                                unsigned int style,
                                const OEChem::OEAtomBondSet& abset)

      **Example:** (See image generated in :ref:`figure_OEAddHighlighting_OEHighlightStyle`)

      .. oe:source:: OEAddHighlighting_Style.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEATOMBONDSET

      .. oe:source:: OEAddHighlighting_Style.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEATOMBONDSET

      .. oe:source:: OEAddHighlighting_Style.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEATOMBONDSET

      .. oe:source:: OEAddHighlighting_Style.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OEATOMBONDSET

   #. Highlighting using an :ref:`OESubSearch <OEChem_OESubSearch>` of which matches are being highlighted:

   .. _api_OEAddHighlighting_OE2DMolDisplay_OEColor_OEHighlightStyle_OESubSearch:

      .. oe:api::

         void OEAddHighlighting(OE2DMolDisplay& disp,
                                const OESystem::OEColor& color,
                                unsigned int style,
                                const OEChem::OESubSearch& subsearch)

      **Example:** (See image generated in :ref:`figure_OEAddHighlighting_OEHighlightStyle`)

      .. oe:source:: OEAddHighlighting_Style.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OESUBSEARCH

      .. oe:source:: OEAddHighlighting_Style.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OESUBSEARCH

      .. oe:source:: OEAddHighlighting_Style.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OESUBSEARCH

      .. oe:source:: OEAddHighlighting_Style.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEADDHIGHLIGHTING-OESUBSEARCH

   .. _figure_OEAddHighlighting_OEHighlightStyle:

   .. figure:: depicttk/images/OEAddHighlighting-OEHighlightStyle-OEMatch.*
      :align:  center

      **Example of highlighting 6-membered aromatic rings**

   .. seealso::

      * :ref:`OEColor <OESystem_OEColor>` class
      * :oe:constns:`OEDepict::OEHighlightStyle` namespace
      * :ref:`chapter_highlighting` chapter



.. |Bezier|    replace:: Bézier


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDepict

.. _OEDepict_OEAddInteractiveIcon:

.. oe:function:: OEAddInteractiveIcon

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddInteractiveIcon(OE2DMolDisplay& disp,
                                   unsigned int loc = OEIconLocation::Default,
                                   double scale = 1.0)
         void OEAddInteractiveIcon(OEImageBase& image,
                                   unsigned int loc = OEIconLocation::Default,
                                   double scale = 1.0)

   .. oe:language:: python

      .. oe:api:: python

         OEAddInteractiveIcon(disp: OE2DMolDisplay, loc: int,
                              scale: float = 1.0) -> None
         OEAddInteractiveIcon(image: OEImageBase, loc: int, scale: float = 1.0) -> None

   Adds an icon to an image or a molecule display that indicates that the image
   is interactive.

   *loc*
      This value has to be from the :oe:constns:`OEDepict::OEIconLocation`
      namespace.

   *scale*
      The multiplier that can be used to increase or decrease the size of the icon.
      This value has to be in the range of ``[0.5, 2.0]``.

.. only:: oehtml

   .. raw:: html

      <p align="center">
      <b>hover the mouse over on the rectangle below</b>
      </p>

      <p align="center">
      <object data="../../_images/AddSVGHover.svg" type="image/svg+xml"  width = "300" ></object>
      <p>

      <p align="center">
      <b>Example of adding the logo to an interactive SVG image</b>
      <p>

   .. image:: /_images/AddSVGHover.svg
      :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEAddLabel

.. _OEDepict_OEAddLabel:

.. oe:function:: OEAddLabel

   Adds label to an image or molecule display.

   .. list-table:: **The overloaded versions of the OEAddLabel function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OEAddLabel(image, position, label)<api_OEAddLabel_OEImageBase_OE2DPoint_OEHighlightLabel>`
        - adding label to an image

      * - :ref:`OEAddLabel(disp, label, match)<api_OEAddLabel_OE2DMolDisplay_OEHighlightLabel_OEMatchBase>`
        - adding label to atoms of a match

      * - :ref:`OEAddLabel(disp, label, abset)<api_OEAddLabel_OE2DMolDisplay_OEHighlightLabel_OEAtomBondSet>`
        - adding label to set of atoms

      * - :ref:`OEAddLabel(disp, label, atompred)<api_OEAddLabel_OE2DMolDisplay_OEHighlightLabel_AtomPredicate>`
        - adding label to atoms specified by a predicate

   .. note::

      When adding label associated with atoms it is recommended to use the
      :oe:func:`OEDepict::OEAddLabel` along with the :oe:func:`OEDepict::OEAddHighlighting`
      function for visual clarity.

   .. _api_OEAddLabel_OEImageBase_OE2DPoint_OEHighlightLabel:

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddLabel(OEImageBase& image, const OE2DPoint& center,
                         const OEHighlightLabel& label)

   .. oe:language:: python

      .. oe:api:: python

         OEAddLabel(image: OEImageBase, center: OE2DPoint,
                    label: OEHighlightLabel) -> None

   *image*
      The image in which the label is drawn.

   *center*
      The center of the label on the image.

   *label*
      The :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` object that stores properties that
      determine the styles of the label along with the text of the label itself.

   **Example:**

   .. oe:source:: OEAddLabel.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-TO-IMAGE

   .. oe:source:: OEAddLabel.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-TO-IMAGE

   .. oe:source:: OEAddLabel.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-TO-IMAGE

   .. oe:source:: OEAddLabel.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-TO-IMAGE

   .. _figure_OEAddLabel_OEImageBase:

   .. figure:: depicttk/images/OEAddLabel-OEImageBase.*
      :align:  center

      **Example of adding labels to an image**

   .. _api_OEAddLabel_OE2DMolDisplay_OEHighlightLabel_OEMatchBase:

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddLabel(OE2DMolDisplay& disp, const OEHighlightLabel& label,
                         const OEChem::OEMatchBase& match)

   .. oe:language:: python

      .. oe:api:: python

         OEAddLabel(disp: OE2DMolDisplay, label: OEHighlightLabel,
                    match: OEMatchBase) -> None

   Adds label to atoms of an :ref:`OEMatchBase <OEChem_OEMatchBase>` object that can be
   initialized by substructure search or maximum common substructure search.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object on which the label is going to
      be positioned.

   *label*
      The :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` object that stores properties that
      determine the styles of the label along with the text of the label itself.

   *match*
      The label is positioned  based on the target atoms of the
      :ref:`OEMatchBase <OEChem_OEMatchBase>` object.

   **Example:**

   .. oe:source:: OEAddLabel.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-OEMATCH

   .. oe:source:: OEAddLabel.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-OEMATCH

   .. oe:source:: OEAddLabel.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-OEMATCH

   .. oe:source:: OEAddLabel.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-OEMATCH

   .. _figure_OEAddLabel_OEMatchBase:

   .. figure:: depicttk/images/OEAddLabel-OEMatch.*
      :align:  center

      **Example of adding label to 6-membered aromatic ring**

   .. _api_OEAddLabel_OE2DMolDisplay_OEHighlightLabel_OEAtomBondSet:

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddLabel(OE2DMolDisplay& disp, const OEHighlightLabel& label,
                         const OEChem::OEAtomBondSet& abset)

   .. oe:language:: python

      .. oe:api:: python

         OEAddLabel(disp: OE2DMolDisplay, label: OEHighlightLabel,
                    abset: OEAtomBondSet) -> None

   Adds label to atoms stored in the :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object on which the label is going to
      be positioned.

   *label*
      The :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` object that stores properties that
      determine the styles of the label along with the text of the label itself.

   *abset*
      The label is positioned based on the atoms stored in the
      :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object.

   **Example:**

   .. oe:source:: OEAddLabel.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-OEATOMBONDSET

   .. oe:source:: OEAddLabel.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-OEATOMBONDSET

   .. oe:source:: OEAddLabel.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-OEATOMBONDSET

   .. oe:source:: OEAddLabel.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-OEATOMBONDSET

   .. _figure_OEAddLabel_OEAtomBondSet:

   .. figure:: depicttk/images/OEAddLabel-OEAtomBondSet.*
      :align:  center

      **Example of adding label to ring and chain components of a molecule**

   .. _api_OEAddLabel_OE2DMolDisplay_OEHighlightLabel_AtomPredicate:

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddLabel(OE2DMolDisplay& disp, const OEHighlightLabel& label,
                         const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& atompred)

   .. oe:language:: python

      .. oe:api:: python

         OEAddLabel(disp: OE2DMolDisplay, label: OEHighlightLabel,
                    atompred: OEUnaryAtomPred) -> None

   Adds label to atoms for which the given atom predicate returns `true`.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object on which the label is going to
      be positioned.

   *label*
      The :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` object that stores properties that
      determine the styles of the label along with the text of the label itself.

   *atompred*
      The label is positioned based on the atoms for which the given
      atom predicate returns `true`.

   **Example:**

   .. oe:source:: OEAddLabel.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-PREDICATE

   .. oe:source:: OEAddLabel.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-PREDICATE

   .. oe:source:: OEAddLabel.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-PREDICATE

   .. oe:source:: OEAddLabel.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEADDLABEL-PREDICATE

   .. _figure_OEAddLabel_AtomPredicate:

   .. figure:: depicttk/images/OEAddLabel-Predicate.*
      :align:  center

      **Example of adding label to ring and chain components of a molecule**



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEAddOpenEyeIcon:

.. oe:function:: OEAddOpenEyeIcon

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddOpenEyeIcon(OEImageBase& image,
                               unsigned int loc = OEIconLocation::Default,
                               double scale = 1.0)
         void OEAddOpenEyeIcon(OE2DMolDisplay& disp,
                               unsigned int loc = OEIconLocation::Default,
                               double scale = 1.0)

   .. oe:language:: python

      .. oe:api:: python

         OEAddOpenEyeIcon(image: OEImageBase, loc: int, scale: float = 1.0) -> None
         OEAddOpenEyeIcon(disp: OE2DMolDisplay, loc: int, scale: float = 1.0) -> None

   Adds an OpenEye logo to an image or a molecule display.

   *loc*
      This value has to be from the :oe:constns:`OEDepict::OEIconLocation`
      namespace.

   *scale*
      The multiplier that can be used to increase or decrease the size of the icon.
      This value has to be in the range of ``[0.5, 2.0]``.

   .. figure:: depicttk/images/OEIconLocation_BottomRight.*
      :align: center

      **Example of using the OEAddOpenEyeIcon function**


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEAddSVGClickEvent:

.. oe:function:: OEAddSVGClickEvent

   .. list-table:: **The overloaded versions of the  OEAddSVGClickEvent function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OEAddSVGClickEvent(disp, adisp, message)<api_OEAddSVGClickEvent_OE2DMolDisplay>`
        - adding click event to :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>`
      * - :ref:`OEAddSVGClickEvent(disp, bdisp, message)<api_OEAddSVGClickEvent_OE2DMolDisplay>`
        - adding click event to :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>`
      * - :ref:`OEAddSVGClickEvent(svggroup, message)<api_OEAddSVGClickEvent_OESVGGroup>`
        - adding click event to :ref:`OESVGGroup <OEDepict_OESVGGroup>` (low-level function)

   .. _api_OEAddSVGClickEvent_OE2DMolDisplay:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddSVGClickEvent(OE2DMolDisplay& disp, OE2DAtomDisplay* adisp,
                                 const std::string& message)
         bool OEAddSVGClickEvent(OE2DMolDisplay& disp, OE2DBondDisplay* bdisp,
                                 const std::string& message)

   .. oe:language:: python

      .. oe:api:: python

         OEAddSVGClickEvent(arg1: OE2DMolDisplay, arg2: OE2DAtomDisplay,
                            message: str) -> bool
         OEAddSVGClickEvent(arg1: OE2DMolDisplay, arg2: OE2DBondDisplay,
                            message: str) -> bool

   Adds a click event to an atom or bond in an :file:`.svg` image.
   When clicking at the position defined by the given atom or bond
   display, an event is triggered with the given message.

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format.

   .. seealso::

      * :ref:`chapter_svg` chapter including the
        :ref:`section_svg_event` section

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that holds the
      data necessary to depict the molecule with which it is
      initialized.

   *adisp*
      The :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object that defines the
      mouse click position.

   *bdisp*
      The :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` object that defines the
      mouse click position

   *message*
      The text that will be emitted when an event is triggered
      on mouse click.

   **Example for adding event for atom displays**

   .. oe:source:: AddAtomClickEvent.cpp
      :language: c++
      :frag:     SNIPPET-ADDATOMCLICKEVENT

   .. oe:source:: AddAtomClickEvent.py
      :language: python
      :frag:     SNIPPET-ADDATOMCLICKEVENT

   .. oe:source:: AddAtomClickEvent.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ADDATOMCLICKEVENT

   .. oe:source:: AddAtomClickEvent.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ADDATOMCLICKEVENT

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

            :download:`AddAtomClickEvent.cpp <../../../../../sublibs/tklibs/depict/examples/docs/AddAtomClickEvent.cpp>`

      .. oe:language:: python

         .. admonition:: Download code

            :download:`AddAtomClickEvent.py <../../../../../wrappers/python/docexamples/depict/AddAtomClickEvent.py>`

      .. oe:language:: java

         .. admonition:: Download code

            :download:`AddAtomClickEvent.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/AddAtomClickEvent.java>`

      .. oe:language:: csharp

         .. admonition:: Download code

            :download:`AddAtomClickEvent.cs <../../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/AddAtomClickEvent.cs>`

   **Example for adding event for bond displays**

   .. oe:source:: AddBondClickEvent.cpp
      :language: c++
      :frag:     SNIPPET-ADDBONDCLICKEVENT

   .. oe:source:: AddBondClickEvent.py
      :language: python
      :frag:     SNIPPET-ADDBONDCLICKEVENT

   .. oe:source:: AddBondClickEvent.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ADDBONDCLICKEVENT

   .. oe:source:: AddBondClickEvent.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ADDBONDCLICKEVENT

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

            :download:`AddBondClickEvent.cpp <../../../../../sublibs/tklibs/depict/examples/docs/AddBondClickEvent.cpp>`

      .. oe:language:: python

         .. admonition:: Download code

            :download:`AddBondClickEvent.py <../../../../../wrappers/python/docexamples/depict/AddBondClickEvent.py>`

      .. oe:language:: java

         .. admonition:: Download code

            :download:`AddBondClickEvent.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/AddBondClickEvent.java>`

      .. oe:language:: csharp

         .. admonition:: Download code

            :download:`AddBondClickEvent.cs <../../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/AddBondClickEvent.cs>`

   .. seealso::

      * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class
      * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` and :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` classes

   .. #######################################################################################

   .. _api_OEAddSVGClickEvent_OESVGGroup:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddSVGClickEvent(OESVGGroup* svggroup,
                                 const std::string& message)

   .. oe:language:: python

      .. oe:api:: python

         OEAddSVGClickEvent(svggroup: OESVGGroup, message: str) -> bool

   Adds a click event to a specific SVG group in :file:`.svg` image.
   When clicking at the elements drawn inside the given
   :ref:`OESVGGroup <OEDepict_OESVGGroup>` object, an event is triggered
   with the given message

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format.

   .. hint::

      The :oe:func:`OEDepict::OEAddSVGClickEvent` function should always be called
      prior to pushing / popping the :ref:`OESVGGroup <OEDepict_OESVGGroup>` object.

   **Example:**

   The following example creates an :file:`.svg` image with a red rectangle and
   a blue circle.
   Both drawing elements are rendered inside :ref:`OESVGGroup <OEDepict_OESVGGroup>` objects
   that are associated with messages ``clicked on rectangle`` and ``clicked on circle``,
   respectively.
   When the generated :file:`.svg` image is displayed in a HTTP server, clicking
   on the rectangle and the circle triggers events with the corresponding messages.

   .. oe:source:: AddSVGClickEvent.cpp
      :language: c++
      :frag:     SNIPPET-ADD-CLICK-EVENT

   .. oe:source:: AddSVGClickEvent.py
      :language: python
      :frag:     SNIPPET-ADD-CLICK-EVENT

   .. oe:source:: AddSVGClickEvent.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ADD-CLICK-EVENT

   .. oe:source:: AddSVGClickEvent.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ADD-CLICK-EVENT

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

            :download:`AddSVGClickEvent.cpp <../../../../../sublibs/tklibs/depict/examples/docs/AddBondClickEvent.cpp>`

      .. oe:language:: python

         .. admonition:: Download code

            :download:`AddSVGClickEvent.py <../../../../../wrappers/python/docexamples/depict/AddSVGClickEvent.py>`

      .. oe:language:: java

         .. admonition:: Download code

            :download:`AddSVGClickEvent.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/AddSVGClickEvent.java>`

      .. oe:language:: csharp

         .. admonition:: Download code

            :download:`AddSVGClickEvent.cs <../../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/AddSVGClickEvent.cs>`

   .. seealso::

      * :ref:`chapter_svg` chapter including the
        :ref:`section_svg_event` section that shows how to test
        the :file:`.svg` image file generated by this example.
      * :oe:func:`OEDepict::OEAddSVGHover` function
      * :oe:func:`OEDepict::OEAddSVGToggle` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEAddSVGHover:

.. oe:function:: OEAddSVGHover

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddSVGHover(OESVGGroup* area, OESVGGroup* target)

   .. oe:language:: python

      .. oe:api:: python

         OEAddSVGHover(area: OESVGGroup, target: OESVGGroup) -> bool

   Adds a hover effect to the objects drawn between the two given
   groups.
   While hovering the mouse over objects drawn inside the **area** group
   the objects drawn in the **target** group are displayed.

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format.

   .. seealso::

      * :ref:`chapter_svg` chapter
      * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class
      * :oe:func:`OEDepict::OEAddSVGClickEvent` function
      * :oe:func:`OEDepict::OEAddSVGToggle` function

   **Example:**

   .. oe:source:: AddSVGHover.cpp
      :language: c++
      :frag:     SNIPPET-ADD-SVG-HOVER

   .. oe:source:: AddSVGHover.py
      :language: python
      :frag:     SNIPPET-ADD-SVG-HOVER

   .. oe:source:: AddSVGHover.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ADD-SVG-HOVER

   .. oe:source:: AddSVGHover.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ADD-SVG-HOVER

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

            :download:`AddSVGHover.cpp <../../../../../sublibs/tklibs/depict/examples/docs/AddSVGHover.cpp>`

      .. oe:language:: python

         .. admonition:: Download code

            :download:`AddSVGHover.py <../../../../../wrappers/python/docexamples/depict/AddSVGHover.py>`

      .. oe:language:: java

         .. admonition:: Download code

            :download:`AddSVGHover.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/AddSVGHover.java>`

      .. oe:language:: csharp

         .. admonition:: Download code

            :download:`AddSVGHover.cs <../../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/AddSVGHover.cs>`

   .. hint::

      The :oe:func:`OEDepict::OEAddSVGHover` function should always be called
      prior to pushing / popping the :ref:`OESVGGroup <OEDepict_OESVGGroup>` objects.

.. only:: oehtml

   .. raw:: html

      <p align="center">
      <b>hover the mouse over the red rectangle below</b>
      </p>

      <p align="center">
      <object data="../../_images/AddSVGHover.svg" type="image/svg+xml"  width = "300" ></object>
      <p>

      <p align="center">
      <b>Example of using the OEAddSVGHover function</b>
      <p>

   .. image:: /_images/AddSVGHover.svg
      :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. oe:api::

      bool OEAddSVGHover(OESVGGroup* area, OESVGGroup* targetA,
                         OESVGGroup* targetB)

   Adds a hover effect to the objects drawn between the three given
   groups.
   While hovering the mouse over objects drawn inside the **area** group
   the objects drawn in the **targetA** and  **targetB** groups are displayed.

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEAddSVGToggle:

.. oe:function:: OEAddSVGToggle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddSVGToggle(OESVGGroup* area, OESVGGroup* target,
                             bool on = false)

   .. oe:language:: python

      .. oe:api:: python

         OEAddSVGToggle(area: OESVGGroup, target: OESVGGroup, on: bool = False) -> bool

   Adds a toggle effect to the objects drawn between the two given
   groups.
   When clicking on the objects drawn inside the **area** group
   the objects drawn in the **target** group appear / disappear.

   *on*
      The parameter that determine whether the objects drawn inside
      the **target** group are displayed initially.

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format.

   .. seealso::

      * :ref:`chapter_svg` chapter
      * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class
      * :oe:func:`OEDepict::OEAddSVGClickEvent` function
      * :oe:func:`OEDepict::OEAddSVGHover` function

   **Example:**

   .. oe:source:: AddSVGToggle.cpp
      :language: c++
      :frag:     SNIPPET-ADD-SVG-TOGGLE

   .. oe:source:: AddSVGToggle.py
      :language: python
      :frag:     SNIPPET-ADD-SVG-TOGGLE

   .. oe:source:: AddSVGToggle.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ADD-SVG-TOGGLE

   .. oe:source:: AddSVGToggle.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ADD-SVG-TOGGLE

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

            :download:`AddSVGToggle.cpp <../../../../../sublibs/tklibs/depict/examples/docs/AddSVGToggle.cpp>`

      .. oe:language:: python

         .. admonition:: Download code

            :download:`AddSVGToggle.py <../../../../../wrappers/python/docexamples/depict/AddSVGToggle.py>`

      .. oe:language:: java

         .. admonition:: Download code

            :download:`AddSVGToggle.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/AddSVGToggle.java>`

      .. oe:language:: csharp

         .. admonition:: Download code

            :download:`AddSVGToggle.cs <../../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/AddSVGToggle.cs>`

   .. hint::

      The :oe:func:`OEDepict::OEAddSVGToggle` function should always be called
      prior to pushing / popping the :ref:`OESVGGroup <OEDepict_OESVGGroup>` objects.

.. only:: oehtml

   .. raw:: html

      <p align="center">
      <b>click on the red rectangle below</b>
      </p>

      <p align="center">
      <object data="../../_images/AddSVGToggle.svg" type="image/svg+xml"  width = "300" ></object>
      <p>

      <p align="center">
      <b>Example of using the OEAddSVGToggle function</b>
      <p>

   .. image:: /_images/AddSVGToggle.svg
      :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|



.. |Bezier|    replace:: Bézier


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDepict

.. _OEDepict_OEAddWatermark:

.. oe:function:: OEAddWatermark

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddWatermark(OEImageBase& image, const std::string& text,
                             double scale = 1.0)
         void OEAddWatermark(OE2DMolDisplay& disp, const std::string& text,
                             double scale = 1.0)

   .. oe:language:: python

      .. oe:api:: python

         OEAddWatermark(image: OEImageBase, text: str, scale: float = 1.0) -> None
         OEAddWatermark(disp: OE2DMolDisplay, text: str, scale: float = 1.0) -> None

   Adds a watermark to an image or a molecule display.

   *text*
      The text of the watermark.

   *scale*
      The multiplier that can be used to increase or decrease the font size of the watermark text.
      This value has to be in the range of ``[0.5, 2.0]``.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEAnnotateDepictionProblems

.. _OEDepict_OEAnnotateDepictionProblems:

.. oe:function:: OEAnnotateDepictionProblems

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAnnotateDepictionProblems(OE2DMolDisplay& disp)

   .. oe:language:: python

      .. oe:api:: python

         OEAnnotateDepictionProblems(disp: OE2DMolDisplay) -> bool

   Annotates various depiction problems on the molecule.
   Currently it can mark double bonds which are not depicted
   correctly according to their cis/trans stereo
   specifications.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object being
      annotated.

   The following code snippet show how to use the
   :oe:func:`OEDepict::OEAnnotateDepictionProblems` function.
   See the generated image in :ref:`Figure: Example of incorrect
   trans double bond depiction <figure_OEAnnotateDepictionProblems>`.
   The highlighting indicates that the double bond specified in the
   input SMILES string as trans is depicted as cis.

   .. oe:source:: OEAnnotateDepictionProblems.py
      :language: python
      :noindent:
      :frag:     SNIPPET-ANNOTATE-DEPICTION-PROBLEMS

   .. oe:source:: OEAnnotateDepictionProblems.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-ANNOTATE-DEPICTION-PROBLEMS

   .. oe:source:: OEAnnotateDepictionProblems.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ANNOTATE-DEPICTION-PROBLEMS

   .. oe:source:: OEAnnotateDepictionProblems.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ANNOTATE-DEPICTION-PROBLEMS

   .. _figure_OEAnnotateDepictionProblems:

   .. figure:: depicttk/images/OEAnnotateDepictionProblems.*
      :align:  center

      **Example of incorrect trans double bond depiction**

   .. note::

      **OEDepict TK** uses built-in ring system templates when
      generating 2D coordinates.
      Generating 2D coordinates which are inconsistent with
      cis/trans stereo bond specification can occur due to
      a missing ring template.
      The :oe:func:`OEDepict::OEPrepareDepiction` function throws
      a warning when this problem occurs.




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEAnnotateValenceProblems

.. _OEDepict_OEAnnotateValenceProblems:

.. oe:function:: OEAnnotateValenceProblems

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAnnotateValenceProblems(OE2DMolDisplay& disp)

   .. oe:language:: python

      .. oe:api:: python

         OEAnnotateValenceProblems(disp: OE2DMolDisplay) -> bool

   Annotates potential valence problems on the molecule.
   An atom is considered to have a valence problem when its bond count exceeds
   the maximum valence defined by the MDL valence model for its atomic number
   and formal charge.

   .. note::

      Aromaticity must be perceived (e.g.\ via :oe:func:`OEChem::OEAssignAromaticFlags`)
      before calling this function. Without aromaticity perception, aromatic
      ring atoms may be incorrectly flagged as having valence problems because
      their bonds are treated as alternating single/double bonds.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object being
      annotated.

   The following code snippet show how to use the
   :oe:func:`OEDepict::OEAnnotateValenceProblems` function.
   See the generated image in :ref:`Figure: Example of molecule with incorrect
   valences <figure_OEAnnotateValenceProblems>`.

   .. oe:source:: OEAnnotateValenceProblems.py
      :language: python
      :noindent:
      :frag:     SNIPPET-ANNOTATE-VALENCE-PROBLEMS

   .. oe:source:: OEAnnotateValenceProblems.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-ANNOTATE-VALENCE-PROBLEMS

   .. oe:source:: OEAnnotateValenceProblems.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ANNOTATE-VALENCE-PROBLEMS

   .. oe:source:: OEAnnotateValenceProblems.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ANNOTATE-VALENCE-PROBLEMS

   .. _figure_OEAnnotateValenceProblems:

   .. figure:: depicttk/images/OEAnnotateValenceProblems.*
      :align:  center

      **Example of molecule with incorrect valences**

   .. note::

      The :oe:func:`OEDepict::OEAnnotateValenceProblems` function uses
      the :ref:`section_valence_mdl`.



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigure2DMolDisplayOptions

.. _OEDepict_OEConfigure2DMolDisplayOptions:

.. oe:function:: OEConfigure2DMolDisplayOptions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigure2DMolDisplayOptions(OESystem::OEInterface& itf,
                                             unsigned int config = OE2DMolDisplaySetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigure2DMolDisplayOptions(itf: OEInterface, config: int) -> bool

   Configures the given interface to add molecule depiction style
   parameters.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface
      This value has to be from the
      :oe:constns:`OEDepict::OE2DMolDisplaySetup` namespace.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEDepict::OE2DMolDisplaySetup` namespace
      * :oe:func:`OEDepict::OESetup2DMolDisplayOptions` function

   :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` is the utility function
   that allows to easily generate consistent command line interface for
   depiction examples and applications.
   For each command line options the generated interface will include
   information about related APIs in **OEDepict TK**, For example:

   .. oe:language:: c++

      .. code-block:: console

         prompt> mol2img --help -aromstyle

   .. oe:language:: python

      .. code-block:: console

         prompt> python mol2img.py --help -aromstyle

   .. oe:language:: java

      .. code-block:: console

         prompt> java Mol2Img --help -aromstyle

   .. oe:language:: csharp

      .. code-block:: console

         prompt> Mol2Img --help -aromstyle

   will reveals that the `-aromstyle` command line parameter is related to the
   :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAromaticStyle` method and the
   :oe:constns:`OEDepict::OEAromaticStyle` namespace
   (see the "Details" section below):

   .. code-block:: console

      Contents of parameter -aromstyle
       Aliases : -astl
       Type : string
       Allow list : false
       Default : Kekule
       Simple : true
       Required : false
       Legal values : Kekule Circle Dash
       Brief : Aromatic ring display style
       Detail

      API : OE2DMolDisplayOptions::SetAromaticStyle method and OEAromaticStyle namespace

   When generating an html help file:

   .. oe:language:: c++

      .. code-block:: console

         prompt> mol2img --help html

         Creating 'mol2img.py_help.html'

   .. oe:language:: python

      .. code-block:: console

         prompt> python mol2img.py --help html

         Creating 'mol2img.py_help.html'

   .. oe:language:: java

      .. code-block:: console

         prompt> java Mol2Img --help html
         Creating 'mol2img.py_help.html'

   .. oe:language:: csharp

      .. code-block:: console

         prompt> Mol2Img --help html

         Creating 'mol2img.py_help.html'

   The generated 'mol2img.py_help.html' file will contain hyperlinks to
   related APIs in the **OEDepict TK** documentation.

   .. seealso::

      * :ref:`section_examples_summary_mol2img`



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureColor

.. _OEDepict_OEConfigureColor:

.. oe:function:: OEConfigureColor

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureColor(OESystem::OEInterface& itf,
                               const std::string& name,
                               const std::string& alias,
                               const std::string& brief,
                               std::string defcolor = "red")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureColor(itf: OEInterface, name: str, alias: str, brief: str,
                          defcolor: str = "red") -> bool

   Adds a *color* parameter to the given interface.

   *itf*
      The interface being configured.

   *name*
      The name of the color parameter.

   *alias*
      The alternative *i.e.* alias name of the parameter.

   *brief*
      The brief description of the parameter.

   *defcolor*
      The default color of the parameter.

   **Example:**

   .. oe:source:: OEConfigureColor.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OECONFIGURECOLOR

   .. oe:source:: OEConfigureColor.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OECONFIGURECOLOR

   .. oe:source:: OEConfigureColor.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OECONFIGURECOLOR

   .. oe:source:: OEConfigureColor.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OECONFIGURECOLOR

   The above snippet will generate the following  parameter:

   .. code-block:: console

      Contents of parameter mycolor
          Aliases : c
          Type : string
          Allow list : false
          Default : blue
          Simple : true
          Required : false
          Legal values : black blue bluetint brass brown copper cyan darkblue
             darkbrown darkcyan darkgreen darkgrey darkmagenta darkorange
             darkpurple darkred darkrose darksalmon darkyellow gold green
             greenblue greentint grey hotpink lightblue lightbrown lightgreen
             lightgrey lightorange lightpurple lightsalmon limegreen magenta
             mediumblue mediumbrown mediumgreen mediumorange mediumpurple
             mediumsalmon mediumyellow olivebrown olivegreen olivegrey pewter
             orange pink pinktint purple red redorange royalblue seagreen silver
             skyblue violet white yellow yellowtint
          Brief : Example of using OEConfigureColor

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:func:`OEDepict::OEGetColor` function
      * :ref:`OEColor <OESystem_OEColor>` class



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureHighlightColor

.. _OEDepict_OEConfigureHighlightColor:

.. oe:function:: OEConfigureHighlightColor

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureHighlightColor(OESystem::OEInterface& itf,
                                        std::string name = OEHighlightParamName::Color,
                                        std::string alias = "-hcolor")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureHighlightColor(itf: OEInterface, name: str,
                                   alias: str = "-hcolor") -> bool

   Adds a *highlighting color* parameter to the given interface.

   *itf*
      The interface being configured.

   *name*
      The name of the color parameter.

   *alias*
      The alternative *i.e.* alias name of the parameter.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :ref:`OEColor <OESystem_OEColor>` class
      * :oe:const:`OEDepict::OEHighlightSetup::Color` constant
      * :oe:const:`OEDepict::OEHighlightParamName::Color` constant
      * :oe:func:`OEDepict::OEGetHighlightColor` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureHighlightParams

.. _OEDepict_OEConfigureHighlightParams:

.. oe:function:: OEConfigureHighlightParams

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureHighlightParams(OESystem::OEInterface& itf,
                                         unsigned int config = OEHighlightSetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureHighlightParams(itf: OEInterface, config: int) -> bool

   Configures the given interface to add highlight style
   parameters.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface.
      This value has to be from the
      :oe:constns:`OEDepict::OEHighlightSetup` namespace.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEDepict::OEHighlightSetup` namespace
      * :oe:func:`OEDepict::OEGetHighlightColor` function
      * :oe:func:`OEDepict::OEGetHighlightStyle` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureHighlightStyle

.. _OEDepict_OEConfigureHighlightStyle:

.. oe:function:: OEConfigureHighlightStyle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureHighlightStyle(OESystem::OEInterface& itf,
                                        std::string name = OEHighlightParamName::Style,
                                        std::string alias = "-hstyle")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureHighlightStyle(itf: OEInterface, name: str,
                                   alias: str = "-hstyle") -> bool

   Adds a *highlighting style* parameter to the given interface.

   *itf*
      The interface being configured.

   *name*
      The name of the style parameter.

   *alias*
      The alternative *i.e.* alias name of the parameter.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:const:`OEDepict::OEHighlightSetup::Style` constant
      * :oe:const:`OEDepict::OEHighlightParamName::Style` constant
      * :oe:func:`OEDepict::OEGetHighlightStyle` function
      * :oe:constns:`OEDepict::OEHighlightStyle` namespace



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureImageGridNumColumns

.. _OEDepict_OEConfigureImageGridNumColumns:

.. oe:function:: OEConfigureImageGridNumColumns

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureImageGridNumColumns(OESystem::OEInterface& itf,
                                             std::string name = OEImageGridParamName::NumColumns,
                                             std::string alias = "-cols")
         bool OEConfigureImageGridNumColumns(OESystem::OEInterface& itf,
                                             unsigned int defnumcols,
                                             std::string = OEImageGridParamName::NumColumns,
                                             std::string alias = "-cols")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureImageGridNumColumns(itf: OEInterface, name: str,
                                        alias: str = "-cols") -> bool
         OEConfigureImageGridNumColumns(itf: OEInterface, defnumcols: int,
                                        arg3: str, alias: str = "-cols") -> bool

   Adds a parameter to the given interface to allows the configuration
   of the number of grid columns.

   *itf*
      The interface being configured.

   *defnumcols*
      The default number of columns.

   *name*
      The name of the parameter.

   *alias*
      The alternative *i.e.* alias name of the parameter.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:const:`OEDepict::OEImageGridSetup::NumColumns` constant
      * :oe:const:`OEDepict::OEImageGridParamName::NumColumns` constant
      * :oe:func:`OEDepict::OEConfigureImageGridParams` function
      * :oe:func:`OEDepict::OEGetImageGridNumColumns` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureImageGridNumRows

.. _OEDepict_OEConfigureImageGridNumRows:

.. oe:function:: OEConfigureImageGridNumRows

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureImageGridNumRows(OESystem::OEInterface& itf,
                                          std::string name = OEImageGridParamName::NumRows,
                                          std::string alias = "-rows")
         bool OEConfigureImageGridNumRows(OESystem::OEInterface& itf,
                                          unsigned int defnumrows,
                                          std::string = OEImageGridParamName::NumRows,
                                          std::string alias = "-rows")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureImageGridNumRows(itf: OEInterface, name: str,
                                     alias: str = "-rows") -> bool
         OEConfigureImageGridNumRows(itf: OEInterface, defnumrows: int,
                                     arg3: str, alias: str = "-rows") -> bool

   Adds a parameter to the given interface to allows the configuration
   of the number of grid rows.

   *itf*
      The interface being configured.

   *defnumrows*
      The default number of rows.

   *name*
      The name of the parameter.

   *alias*
      The alternative *i.e.* alias name of the parameter.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:const:`OEDepict::OEImageGridSetup::NumRows` constant
      * :oe:const:`OEDepict::OEImageGridParamName::NumRows` constant
      * :oe:func:`OEDepict::OEConfigureImageGridParams` function
      * :oe:func:`OEDepict::OEGetImageGridNumRows` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureImageGridParams

.. _OEDepict_OEConfigureImageGridParams:

.. oe:function:: OEConfigureImageGridParams

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureImageGridParams(OESystem::OEInterface& itf,
                                         unsigned int config = OEImageGridSetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureImageGridParams(itf: OEInterface, config: int) -> bool

   Configures the given interface to add highlight style
   parameters.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface.
      This value has to be from the
      :oe:constns:`OEDepict::OEImageSetup` namespace.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEDepict::OEImageSetup` namespace
      * :oe:func:`OEDepict::OEConfigureImageGridNumColumns` function
      * :oe:func:`OEDepict::OEConfigureImageGridNumRows` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureImageHeight

.. _OEDepict_OEConfigureImageHeight:

.. oe:function:: OEConfigureImageHeight

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureImageHeight(OESystem::OEInterface& itf,
                                     double defheight = 0.0,
                                     std::string = OEImageParamName::Height,
                                     std::string alias = "-h")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureImageHeight(itf: OEInterface, defheight: float = 0.0,
                                arg3: str, alias: str = "-h") -> bool

   Adds a parameter to the given interface to allows the configuration
   of the image height.

   *itf*
      The interface being configured.

   *defheight*
      Default height value.

   *name*
      The name of the parameter.

   *alias*
      The alternative *i.e.* alias name of the parameter.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:const:`OEDepict::OEImageSetup::Height` constant
      * :oe:const:`OEDepict::OEImageParamName::Height` constant
      * :oe:func:`OEDepict::OEConfigureImageOptions` function
      * :oe:func:`OEDepict::OEGetImageHeight` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureImageOptions

.. _OEDepict_OEConfigureImageOptions:

.. oe:function:: OEConfigureImageOptions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureImageOptions(OESystem::OEInterface& itf,
                                      unsigned int config = OEImageSetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureImageOptions(itf: OEInterface, config: int) -> bool

   Configures the given interface to add image parameters.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface.
      This value has to be from the
      :oe:constns:`OEDepict::OEImageSetup` namespace.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEDepict::OEImageSetup` namespace




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureImageWidth

.. _OEDepict_OEConfigureImageWidth:

.. oe:function:: OEConfigureImageWidth

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureImageWidth (OESystem::OEInterface& itf,
                                     double defwidth = 0.0,
                                     std::string = OEImageParamName::Width,
                                     std::string alias = "-w")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureImageWidth(itf: OEInterface, defwidth: float = 0.0,
                               arg3: str, alias: str = "-w") -> bool

   Adds a parameter to the given interface to allows the configuration
   of the image width.

   *itf*
      The interface being configured.

   *defwidth*
      Default width value.

   *name*
      The name of the parameter.

   *alias*
      The alternative *i.e.* alias name of the parameter.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:const:`OEDepict::OEImageSetup::Width` constant
      * :oe:const:`OEDepict::OEImageParamName::Width` constant
      * :oe:func:`OEDepict::OEConfigureImageOptions` function
      * :oe:func:`OEDepict::OEGetImageWidth` function




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureMultiPageOrientation

.. _OEDepict_OEConfigureMultiPageOrientation:

.. oe:function:: OEConfigureMultiPageOrientation

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureMultiPageOrientation(OESystem::OEInterface& itf,
                                              std::string name = OEMultiPageParamName::PageOrientation,
                                              std::string alias = "-pori")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureMultiPageOrientation(itf: OEInterface, name: str,
                                         alias: str = "-pori") -> bool

   Adds a parameter to the given interface to allows the configuration
   of the page orientation.

   *itf*
      The interface being configured.

   *name*
      The name of the parameter.

   *alias*
      The alternative *i.e.* alias name of the parameter.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:const:`OEDepict::OEMultiPageSetup::PageOrientation` constant
      * :oe:const:`OEDepict::OEMultiPageParamName::PageOrientation` constant
      * :oe:func:`OEDepict::OEConfigureMultiPageParams` function
      * :oe:func:`OEDepict::OEGetMultiPageOrientation` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureMultiPageParams

.. _OEDepict_OEConfigureMultiPageParams:

.. oe:function:: OEConfigureMultiPageParams

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureMultiPageParams(OESystem::OEInterface& itf,
                                         unsigned int config = OEMultiPageSetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureMultiPageParams(itf: OEInterface, config: int) -> bool

   Configures the given interface to add multi-page parameters.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface.
      This value has to be from the
      :oe:constns:`OEDepict::OEMultiPageSetup` namespace.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEDepict::OEMultiPageSetup` namespace
      * :oe:func:`OEDepict::OEConfigureMultiPageOrientation` function
      * :oe:func:`OEDepict::OEConfigureMultiPageSize` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureMultiPageSize

.. _OEDepict_OEConfigureMultiPageSize:

.. oe:function:: OEConfigureMultiPageSize

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureMultiPageSize(OESystem::OEInterface& itf,
                                       std::string name = OEMultiPageParamName::PageSize,
                                       std::string alias = "-psize")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureMultiPageSize(itf: OEInterface, name: str,
                                  alias: str = "-psize") -> bool

   Adds a parameter to the given interface to allows the configuration
   of the page size.

   *itf*
      The interface being configured.

   *name*
      The name of the parameter.

   *alias*
      The alternative *i.e.* alias name of the parameter.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:const:`OEDepict::OEMultiPageSetup::PageSize` constant
      * :oe:const:`OEDepict::OEMultiPageParamName::PageSize` constant
      * :oe:func:`OEDepict::OEConfigureMultiPageParams` function
      * :oe:func:`OEDepict::OEGetMultiPageSize` function




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigurePrepareDepictionOptions

.. _OEDepict_OEConfigurePrepareDepictionOptions:

.. oe:function:: OEConfigurePrepareDepictionOptions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigurePrepareDepictionOptions(OESystem::OEInterface& itf,
                                                 unsigned int config = OEPrepareDepictionSetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigurePrepareDepictionOptions(arg1: OEInterface, config: int) -> bool

   Configures the given interface to add parameters for preparing
   molecules for depiction.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface
      This value has to be from the
      :oe:constns:`OEDepict::OEPrepareDepictionSetup` namespace.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEDepict::OEPrepareDepictionSetup` namespace
      * :oe:func:`OEDepict::OESetupPrepareDepictionOptions` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureReportOptions

.. _OEDepict_OEConfigureReportOptions:

.. oe:function:: OEConfigureReportOptions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureReportOptions(OESystem::OEInterface& itf,
                                       unsigned int config = OEReportSetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureReportOptions(itf: OEInterface, config: int) -> bool

   Configures the given interface to add parameters for the report layout.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface
      This value has to be from the
      :oe:constns:`OEDepict::OEReportSetup` namespace.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEDepict::OEReportSetup` namespace
      * :oe:func:`OEDepict::OESetupReportOptions` function


.. oe:namespace:: OEDepict

.. meta::
   :keywords: OECreateWin32GraphicsImage

.. _OEDepict_OECreateWin32GraphicsImage:

.. oe:function:: OECreateWin32GraphicsImage

   .. oe:language:: c++

      .. oe:api::

         OEImageBase* OECreateWin32GraphicsImage(std::shared_ptr<Gdiplus::Graphics>& graphics)

      .. note::

         This function is only available on the Windows operating
         system through C++.

      Returns an new :ref:`OEImageBase <OEDepict_OEImageBase>` pointer that will
      forward all the draw commands to the passed in
      `GDI+ Graphics class <http://msdn.microsoft.com/en-us/library/windows/desktop/ms534453(v=vs.85).aspx>`_
      object. The user is expected to take ownership and delete the
      :ref:`OEImageBase <OEDepict_OEImageBase>` pointer. The
      :ref:`OEImageBase <OEDepict_OEImageBase>` will share ownership of the
      passed in graphics object. It important that the user does not
      destroy the `Gdiplus::Graphics <http://msdn.microsoft.com/en-us/library/windows/desktop/ms534453(v=vs.85).aspx>`_
      object before the :ref:`OEImageBase <OEDepict_OEImageBase>` is done with it.

      *graphics*
        An :ref:`OESharedPtr <OESystem_OESharedPtr>` holding ownership of a
        `Gdiplus::Graphics <http://msdn.microsoft.com/en-us/library/windows/desktop/ms534453(v=vs.85).aspx>`_ object. 
        Ownership can thus be shared by the caller and the :ref:`OEImageBase <OEDepict_OEImageBase>` object
        simultaneously in a thread-safe fashion.

      The following code demonstrates how to interact with this
      function:

      .. oe:source:: OECreateWin32GraphicsImage.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECREATEWIN32GRAPHICSIMAGE

   .. oe:language:: csharp java python

      .. note::

         This function is only available on the Windows operating
         system through C++.



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDepictCoordinates

.. _OEDepict_OEDepictCoordinates:

.. oe:function:: OEDepictCoordinates

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDepictCoordinates(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEDepictCoordinates(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Assigns 2D coordinates to the given :ref:`OEMolBase <OEChem_OEMolBase>`
   object by invoking the :oe:func:`OEChem::OEGenerate2DCoordinates`
   function.
   The coordinates of each explicit atom are assigned using the
   :oe:meth:`OEChem::OEMolBase::SetCoords` method.
   This function automatically sets the dimensionality of the molecule
   to two, using the :oe:meth:`OEChem::OEMolBase::SetDimension` method.

   .. warning::

      ``OEDepictCoordinates`` is considered deprecated and will be
      removed in OEDepict 3.0. Please switch to using
      :oe:func:`OEChem::OEGenerate2DCoordinates`.



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDepictGetArch

.. _OEDepict_OEDepictGetArch:

.. oe:function:: OEDepictGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEDepictGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEDepictGetArch() -> str




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDepictGetLicensee

.. _OEDepict_OEDepictGetLicensee:

.. oe:function:: OEDepictGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDepictGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEDepictGetLicensee(licensee: str) -> bool



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDepictGetPlatform

.. _OEDepict_OEDepictGetPlatform:

.. oe:function:: OEDepictGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEDepictGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEDepictGetPlatform() -> str



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDepictGetRelease

.. _OEDepict_OEDepictGetRelease:

.. oe:function:: OEDepictGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEDepictGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEDepictGetRelease() -> str



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDepictGetSite

.. _OEDepict_OEDepictGetSite:

.. oe:function:: OEDepictGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDepictGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEDepictGetSite(site: str) -> bool



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDepictGetVersion

.. _OEDepict_OEDepictGetVersion:

.. oe:function:: OEDepictGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEDepictGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEDepictGetVersion() -> int



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDepictIsLicensed

.. _OEDepict_OEDepictIsLicensed:

.. oe:function:: OEDepictIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDepictIsLicensed(const char* feature = 0,
                                 unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEDepictIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **OEDepict TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **OEDepict TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **OEDepict TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawBorder

.. _OEDepict_OEDrawBorder:

.. oe:function:: OEDrawBorder

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawBorder(OEImageBase& image, const OEPen& pen)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawBorder(image: OEImageBase, arg2: OEPen) -> None

   Draws a border around the image with the given pen.

   *image*
      The image around which the border is drawn.

   *pen*
      The graphical properties of the border.

   See code snippet below and the corresponding image in
   :ref:`Figure: Example of using the OEDrawBorder function <figure_OEDrawBorder>`.

   .. oe:source:: OEDrawBorder.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEDrawBorder

   .. oe:source:: OEDrawBorder.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEDrawBorder

   .. oe:source:: OEDrawBorder.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEDrawBorder

   .. oe:source:: OEDrawBorder.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEDrawBorder

   .. _figure_OEDrawBorder:

   .. figure:: depicttk/images/OEDrawBorder.*
      :align:  center

      **Example of using the OEDrawBorder function**

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class
      * :ref:`OEPen <OEDepict_OEPen>` class
      * :oe:func:`OEDepict::OEDrawCurvedBorder` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawChevronArrow

.. _OEDepict_OEDrawChevronArrow:

.. oe:function:: OEDrawChevronArrow

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawChevronArrow(OEImageBase& image, const OE2DPoint& bgn,
                                 const OE2DPoint& end, const OEPen& pen,
                                 double arrowWidth = 5.0, double gapScale = 2.0)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawChevronArrow(image: OEImageBase, bgn: OE2DPoint, end: OE2DPoint,
                            pen: OEPen, arrowWidth: float = 5.0,
                            gapScale: float = 2.0) -> None

   Draws a chevron arrow.
   See example in :ref:`Figure: Example of drawing a chevron arrows<figure_OEDrawChevronArrow>`.

   .. _figure_OEDrawChevronArrow:

   .. figure:: depicttk/images/OEDrawChevronArrow.*
      :align:  center

      **Example of drawing a chevron arrow**

   *image*
      The image in which the arrow is drawn.

   *bgn*, *end*
      The begin and end points of the arrow.

   *pen*
      The graphical properties of the arrow.

   *width*
      The width of the arrow.

   *gapScale*
      The multiplier that defines the space between the lines of the chevron.

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class
      * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
      * :ref:`OEPen <OEDepict_OEPen>` class




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawCurvedArrow

.. _OEDepict_OEDrawCurvedArrow:

.. oe:function:: OEDrawCurvedArrow

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawCurvedArrow(OEImageBase& image, const OE2DPoint& center,
                                double bgnAngle, double endAngle,
                                double radius, bool clockwise, const OEPen& pen)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawCurvedArrow(image: OEImageBase, center: OE2DPoint,
                           bgnAngle: float, endAngle: float, radius: float,
                           clockwise: bool, pen: OEPen) -> None

   Draws a curved arrow.
   See example in :ref:`Figure: Example of drawing curved arrows<figure_OEDrawCurvedArrow>`.

   .. _figure_OEDrawCurvedArrow:

   .. figure:: depicttk/images/OEDrawCurvedArrow.*
      :align:  center

      **Example of drawing curved arrows**

   *image*
      The image in which the arrow is drawn.

   *center*
      The center of the arc.

   *bgnAngle*, *endAngle*
      The two endpoints of the arc (in degrees).
      Both angles are in degrees and their values have to be in a
      range of :math:`[0.0^{\circ}, 360.0^{\circ}]`.
      Angles are interpreted such that :math:`0.0^{\circ}` and
      :math:`360.0^{\circ}` degrees are at the *12 o'clock*
      position, :math:`90.0^{\circ}` degrees corresponds
      to *3 o'clock*, etc.

   *radius*
      The radius of the arc.

   *clockwise*
      The direction of the arrow.

   *pen*
      The graphical properties of the curved arrow.

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class
      * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
      * :ref:`OEPen <OEDepict_OEPen>` class




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawCurvedBorder

.. _OEDepict_OEDrawCurvedBorder:

.. oe:function:: OEDrawCurvedBorder

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawCurvedBorder(OEImageBase& image, const OEPen& pen,
                                 double radius)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawCurvedBorder(image: OEImageBase, pen: OEPen, radius: float) -> None

   Draws a round rectangle around the image with the given pen.

   *image*
      The image around which the border is drawn.

   *pen*
      The graphical properties of the border.

   *radius*
      The parameter that determines the roundedness of the corners of the rectangle.

   See code snippet below and the corresponding image in
   :ref:`Figure: Example of using the OEDrawCurvedBorder function <figure_OEDrawCurvedBorder>`.

   .. oe:source:: OEDrawBorder.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEDrawCurvedBorder

   .. oe:source:: OEDrawBorder.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEDrawCurvedBorder

   .. oe:source:: OEDrawBorder.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEDrawCurvedBorder

   .. oe:source:: OEDrawBorder.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEDrawCurvedBorder

   .. _figure_OEDrawCurvedBorder:

   .. figure:: depicttk/images/OEDrawCurvedBorder.*
      :align:  center

      **Example of using the OEDrawCurvedBorder function**

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class
      * :ref:`OEPen <OEDepict_OEPen>` class
      * :oe:func:`OEDepict::OEDrawBorder` function
      * :oe:func:`OEDepict::OEDrawCurvedRectangle` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawCurvedRectangle

.. _OEDepict_OEDrawCurvedRectangle:

.. oe:function:: OEDrawCurvedRectangle

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawCurvedRectangle(OEImageBase& image, const OE2DPoint& tl,
                                    const OE2DPoint& br, const OEPen& pen,
                                    double radius)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawCurvedRectangle(image: OEImageBase, tl: OE2DPoint,
                               br: OE2DPoint, pen: OEPen, radius: float) -> None

   Draws a round rectangle with the given pen.

   *image*
      The image around which the border is drawn.

   *tl, br*
      The position of the top-left and bottom-right corner of the rectangle.

   *pen*
      The graphical properties of the border.

   *radius*
      The parameter that determines the roundedness of the corners of the rectangle.

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class
      * :ref:`OEPen <OEDepict_OEPen>` class
      * :oe:func:`OEDepict::OEDrawBorder` function
      * :oe:func:`OEDepict::OEDrawCurvedBorder` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawEquilibriumArrow

.. _OEDepict_OEDrawEquilibriumArrow:

.. oe:function:: OEDrawEquilibriumArrow

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawEquilibriumArrow(OEImageBase& image, const OE2DPoint& bgn,
                                     const OE2DPoint& end, const OEPen& pen)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawEquilibriumArrow(image: OEImageBase, bgn: OE2DPoint,
                                end: OE2DPoint, pen: OEPen) -> None

   Draws an equilibrium arrow between two points using the given pen.
   See example in :ref:`Figure: Example of drawing an equilibrium arrow<figure_OEDrawEquilibriumArrow>`.

   .. _figure_OEDrawEquilibriumArrow:

   .. figure:: depicttk/images/OEDrawEquilibriumArrow.*
      :align:  center

      **Example of drawing an equilibrium arrow**

   *image*
      The image in which the arrow is drawn.

   *bgn*, *end*
      The begin and end points of the arrow.

   *pen*
      The graphical properties of the arrow.

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class
      * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
      * :ref:`OEPen <OEDepict_OEPen>` class



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawHighlighting

.. _OEDepict_OEDrawHighlighting:

.. oe:function:: OEDrawHighlighting

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawHighlighting(OEImageBase& image,
                                 const OE2DMolDisplay& disp,
                                 const OEHighlightBase& highlight,
                                 const OEChem::OEAtomBondSet& abset)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawHighlighting(image: OEImageBase, disp: OE2DMolDisplay,
                            highlight: OEHighlightBase, abset: OEAtomBondSet) -> None

   Draws atom and bond highlighting into the image.

   *image*
      The image in which the highlighting is drawn.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object of which atoms
      add/or bonds being highlighted.

   *highlight*
      The :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` object that specifies the style of the highlighting.

   *abset*
      Stores the atoms and bonds being highlighted.

   .. note::

      This function renders the highlighting into an image rather than into the
      molecule display as does the :oe:func:`OEDepict::OEAddHighlighting` function.
      Since this function does not change the molecule display it is **not available**
      for the :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` highlighting style.

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlighting` function



.. |Bezier|    replace:: Bézier


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDepict

.. _OEDepict_OEDrawLegendLayout:

.. oe:function:: OEDrawLegendLayout

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawLegendLayout(OELegendLayout& layout)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawLegendLayout(layout: OELegendLayout) -> bool

   Draws the legend layout.

   .. note::

      Interactive legend can only be used in :file:`.svg` image format.

   .. seealso::

      * :ref:`OELegendLayout <OEDepict_OELegendLayout>` class
      * :ref:`OELegendLayoutOptions <OEDepict_OELegendLayoutOptions>` class
      * :oe:constns:`OEDepict::OELegendLayoutStyle` namespace
      * :oe:constns:`OEDepict::OELegendColorStyle` namespace
      * :oe:constns:`OEDepict::OELegendInteractiveStyle` namespace

   **Example**

   .. oe:source:: LegendLayout.cpp
      :language: c++
      :frag:     SNIPPET-LEGEND-LAYOUT

   .. oe:source:: LegendLayout.py
      :language: python
      :frag:     SNIPPET-LEGEND-LAYOUT

   .. oe:source:: LegendLayout.java
      :language: java
      :noindent:
      :frag:     SNIPPET-LEGEND-LAYOUT

   .. oe:source:: LegendLayout.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-LEGEND-LAYOUT

   .. hint::

      The :oe:func:`OEDepict::OEDrawLegendLayout` function should be called
      after rendering all other information to the image.

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

            :download:`LegendLayout.cpp <../../../../../sublibs/tklibs/depict/examples/docs/LegendLayout.cpp>`

      .. oe:language:: python

         .. admonition:: Download code

            :download:`LegendLayout.py <../../../../../wrappers/python/docexamples/depict/LegendLayout.py>`

      .. oe:language:: java

         .. admonition:: Download code

            :download:`LegendLayout.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/LegendLayout.java>`

      .. oe:language:: csharp

         .. admonition:: Download code

            :download:`LegendLayout.cs <../../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/LegendLayout.cs>`

.. only:: oehtml

   .. raw:: html

      <p align="center">
      <b>click on the "Legend" label</b>
      </p>

      <p align="center">
      <object data="../../_images/LegendLayout.svg" type="image/svg+xml"  width = "350" ></object>
      <p>

      <p align="center">
      <b>Example of using the OEDrawLegendLayout function</b>
      <p>

   .. image:: /_images/LegendLayout.svg
      :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. seealso::

      * :ref:`chapter_svg` chapter



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawReactionArrow

.. _OEDepict_OEDrawReactionArrow:

.. oe:function:: OEDrawReactionArrow

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawReactionArrow(OEImageBase& image, const OE2DPoint& bgn,
                                  const OE2DPoint& end, const OEPen& pen)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawReactionArrow(image: OEImageBase, bgn: OE2DPoint,
                             end: OE2DPoint, pen: OEPen) -> None

   Draws a reaction arrow between two points using the given pen.
   See example in :ref:`Figure: Example of drawing a reaction arrow<figure_OEDrawReactionArrow>`.

   .. _figure_OEDrawReactionArrow:

   .. figure:: depicttk/images/OEDrawReactionArrow.*
      :align:  center

      **Example of drawing a reaction arrow**

   *image*
      The image in which the arrow is drawn.

   *bgn*, *end*
      The begin and end points of the arrow.

   *pen*
      The graphical properties of the arrow.

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class
      * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
      * :ref:`OEPen <OEDepict_OEPen>` class



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawResonanceArrow

.. _OEDepict_OEDrawResonanceArrow:

.. oe:function:: OEDrawResonanceArrow

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawResonanceArrow(OEImageBase& image, const OE2DPoint& bgn,
                                   const OE2DPoint& end, const OEPen& pen)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawResonanceArrow(image: OEImageBase, bgn: OE2DPoint,
                              end: OE2DPoint, pen: OEPen) -> None

   Draws a resonance arrow between two points using the given pen.
   See example in :ref:`Figure: Example of drawing a resonance arrow<figure_OEDrawResonanceArrow>`.

   .. _figure_OEDrawResonanceArrow:

   .. figure:: depicttk/images/OEDrawResonanceArrow.*
      :align:  center

      **Example of drawing a resonance arrow**

   *image*
      The image in which the arrow is drawn.

   *bgn*, *end*
      The begin and end points of the arrow.

   *pen*
      The graphical properties of the arrow.

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class
      * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
      * :ref:`OEPen <OEDepict_OEPen>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEDrawSVGHoverText:

.. oe:function:: OEDrawSVGHoverText

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawSVGHoverText(OE2DMolDisplay& disp, OE2DAtomDisplay* adisp,
                                 const std::string& text, const OEFont& font)
         bool OEDrawSVGHoverText(OE2DMolDisplay& disp, OE2DBondDisplay* bdisp,
                                 const std::string& text, const OEFont& font)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawSVGHoverText(arg1: OE2DMolDisplay, arg2: OE2DAtomDisplay,
                            text: str, font: OEFont) -> bool
         OEDrawSVGHoverText(arg1: OE2DMolDisplay, arg2: OE2DBondDisplay,
                            text: str, font: OEFont) -> bool

   Creates and interactive effect in :file:`.svg` images.
   The given text will appear when the mouse is hovering
   over the position defined by the given atom / bond display.

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format. In other image formats it has no effect.

      The generated :file:`svg` image should be included into and
      HTML page with the SVG MIME type.

      .. code-block:: console

         <object data="<imagename>.svg" type="image/svg+xml"></object>

   .. seealso::

      * :ref:`chapter_svg` chapter

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that holds the
      data necessary to depict the molecule with which it is
      initialized.

   *adisp*
      The :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object that defines where the
      text will appear.

   *bdisp*
      The :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` object that defines where the
      text will appear.

   *text*
      The text that appears when the cursor is hovered over the given position.

   *font*
      The graphical properties of the font used to draw the text.

   .. oe:source:: HoverAtomText.cpp
      :language: c++
      :frag:     SNIPPET-HOVERATOMTEXT

   .. oe:source:: HoverAtomText.py
      :language: python
      :frag:     SNIPPET-HOVERATOMTEXT

   .. oe:source:: HoverAtomText.java
      :language: java
      :noindent:
      :frag:     SNIPPET-HOVERATOMTEXT

   .. oe:source:: HoverAtomText.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-HOVERATOMTEXT

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

            :download:`HoverAtomText.cpp <../../../../../sublibs/tklibs/depict/examples/docs/HoverAtomText.cpp>`

      .. oe:language:: python

         .. admonition:: Download code

            :download:`HoverAtomText.py <../../../../../wrappers/python/docexamples/depict/HoverAtomText.py>`

      .. oe:language:: java

         .. admonition:: Download code

            :download:`HoverAtomText.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/HoverAtomText.java>`

      .. oe:language:: csharp

         .. admonition:: Download code

            :download:`HoverAtomText.cs <../../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/HoverAtomText.cs>`

   .. _figure_OEDrawSVGHoverText_Atom:

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover mouse over any atoms</b>
         </p>

         <p align="center">
         <object data="../../_images/HoverAtomText.svg" type="image/svg+xml"  width = "400" ></object>
         <p>

         <p align="center">
         <b>Example of using the OEDrawSVGHoverText function for atom positions</b>
         <p>

      .. the below is necessary to copy over the image to the build subdirectory

      .. image:: /_images/HoverAtomText.svg
         :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. oe:source:: HoverBondText.cpp
      :language: c++
      :frag:     SNIPPET-HOVERBONDTEXT

   .. oe:source:: HoverBondText.py
      :language: python
      :frag:     SNIPPET-HOVERBONDTEXT

   .. oe:source:: HoverBondText.java
      :language: java
      :noindent:
      :frag:     SNIPPET-HOVERBONDTEXT

   .. oe:source:: HoverBondText.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-HOVERBONDTEXT

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

            :download:`HoverBondText.cpp <../../../../../sublibs/tklibs/depict/examples/docs/HoverBondText.cpp>`

      .. oe:language:: python

         .. admonition:: Download code

            :download:`HoverBondText.py <../../../../../wrappers/python/docexamples/depict/HoverBondText.py>`

      .. oe:language:: java

         .. admonition:: Download code

            :download:`HoverBondText.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/HoverBondText.java>`

      .. oe:language:: csharp

         .. admonition:: Download code

            :download:`HoverBondText.cs <../../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/HoverBondText.cs>`

   .. _figure_OEDrawSVGHoverText_Bond:

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover mouse over the middle of any bonds</b>
         </p>

         <p align="center">
         <object data="../../_images/HoverBondText.svg" type="image/svg+xml"  width = "400" ></object>
         <p>

         <p align="center">
         <b>Example of using the OEDrawSVGHoverText function for bond positions</b>
         <p>

      .. the below is necessary to copy over the image to the build subdirectory

      .. image:: /_images/HoverBondText.svg
         :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. seealso::

      * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class
      * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` and :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` classes
      * :ref:`OEFont <OEDepict_OEFont>` class
      * :oe:func:`OEDepict::OEDrawSVGToggleText` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEDrawSVGToggleText:

.. oe:function:: OEDrawSVGToggleText

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawSVGToggleText(OE2DMolDisplay& disp, OE2DAtomDisplay* adisp,
                                  const std::string& text, const OEFont& font)
         bool OEDrawSVGToggleText(OE2DMolDisplay& disp, OE2DBondDisplay* bdisp,
                                  const std::string& text, const OEFont& font)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawSVGToggleText(arg1: OE2DMolDisplay, arg2: OE2DAtomDisplay,
                             text: str, font: OEFont) -> bool
         OEDrawSVGToggleText(arg1: OE2DMolDisplay, arg2: OE2DBondDisplay,
                             text: str, font: OEFont) -> bool

   Creates and interactive effect in :file:`.svg` images.
   The given text will appear / disappear when clicking
   at the position defined by the given atom / bond display.

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format. In other image formats it has no effects.

      The generated :file:`svg` image should be included into and
      HTML page with the SVG MIME type.

      .. code-block:: console

         <object data="<imagename>.svg" type="image/svg+xml"></object>

   .. seealso::

      * :ref:`chapter_svg` chapter

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that holds the
      data necessary to depict the molecule with which it is
      initialized.

   *adisp*
      The :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object that defines where the
      text will appear.

   *bdisp*
      The :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` object that defines where the
      text will appear.

   *text*
      The text that appears/disappears on mouse clicks.

   *font*
      The graphical properties of the font used to draw the text.

   .. oe:source:: ToggleAtomText.cpp
      :language: c++
      :frag:     SNIPPET-TOGGLEATOMTEXT

   .. oe:source:: ToggleAtomText.py
      :language: python
      :frag:     SNIPPET-TOGGLEATOMTEXT

   .. oe:source:: ToggleAtomText.java
      :language: java
      :noindent:
      :frag:     SNIPPET-TOGGLEATOMTEXT

   .. oe:source:: ToggleAtomText.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-TOGGLEATOMTEXT

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

            :download:`ToggleAtomText.cpp <../../../../../sublibs/tklibs/depict/examples/docs/ToggleAtomText.cpp>`

      .. oe:language:: python

         .. admonition:: Download code

            :download:`ToggleAtomText.py <../../../../../wrappers/python/docexamples/depict/ToggleAtomText.py>`

      .. oe:language:: java

         .. admonition:: Download code

            :download:`ToggleAtomText.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/ToggleAtomText.java>`

      .. oe:language:: csharp

         .. admonition:: Download code

            :download:`ToggleAtomText.cs <../../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/ToggleAtomText.cs>`

   .. _figure_OEDrawSVGToggleText_Atom:

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>click on any atoms</b>
         </p>

         <p align="center">
         <object data="../../_images/ToggleAtomText.svg" type="image/svg+xml"  width = "400" ></object>
         <p>

         <p align="center">
         <b>Example of using the OEDrawSVGToggleText function for atom positions</b>
         <p>

      .. the below is necessary to copy over the image to the build subdirectory

      .. image:: /_images/ToggleAtomText.svg
         :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. oe:source:: ToggleBondText.cpp
      :language: c++
      :frag:     SNIPPET-TOGGLEBONDTEXT

   .. oe:source:: ToggleBondText.py
      :language: python
      :frag:     SNIPPET-TOGGLEBONDTEXT

   .. oe:source:: ToggleBondText.java
      :language: java
      :noindent:
      :frag:     SNIPPET-TOGGLEBONDTEXT

   .. oe:source:: ToggleBondText.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-TOGGLEBONDTEXT

   .. only:: oehtml

      .. oe:language:: c++

         .. admonition:: Download code

            :download:`ToggleBondText.cpp <../../../../../sublibs/tklibs/depict/examples/docs/ToggleBondText.cpp>`

      .. oe:language:: python

         .. admonition:: Download code

            :download:`ToggleBondText.py <../../../../../wrappers/python/docexamples/depict/ToggleBondText.py>`

      .. oe:language:: java

         .. admonition:: Download code

            :download:`ToggleBondText.java <../../../../../wrappers/java/examples/openeye/docexamples/oedepict/ToggleBondText.java>`

      .. oe:language:: csharp

         .. admonition:: Download code

            :download:`ToggleBondText.cs <../../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/ToggleBondText.cs>`

   .. _figure_OEDrawSVGToggleText_Bond:

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>click on the middle of any bonds</b>
         </p>

         <p align="center">
         <object data="../../_images/ToggleBondText.svg" type="image/svg+xml"  width = "400" ></object>
         <p>

         <p align="center">
         <b>Example of using the OEDrawSVGToggleText function for bond positions</b>
         <p>

      .. the below is necessary to copy over the image to the build subdirectory

      .. image:: /_images/ToggleBondText.svg
         :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. seealso::

      * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class
      * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` and :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` classes
      * :ref:`OEFont <OEDepict_OEFont>` class
      * :oe:func:`OEDepict::OEDrawSVGHoverText` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawText

.. _OEDepict_OEDrawText:

.. oe:function:: OEDrawText

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawText(OEImageBase& image, const std::string& text,
                         const OEFont& font, double padding = 5.0)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawText(image: OEImageBase, text: str, font: OEFont,
                    padding: float = 5.0) -> None

   Draws the given text to the image respecting the font alignment.

   *text*
      The text that is going to be rendered into the given image.

   *font*
      The :ref:`OEFont <OEDepict_OEFont>` object that encapsulates properties
      that determine the display style of text.

   *padding*
      Defines the padding used on the left and right of the given cell
      as a percentage of the width of the cell.

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class
      * :ref:`OEFont <OEDepict_OEFont>` class
      * :oe:func:`OEDepict::OEDrawTextToCenter` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawTextToCenter

.. _OEDepict_OEDrawTextToCenter:

.. oe:function:: OEDrawTextToCenter

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawTextToCenter(OEImageBase& image, const std::string& text,
                                 const OEFont& font)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawTextToCenter(image: OEImageBase, text: str, font: OEFont) -> None

   Draws the given text to the center of the image.

   See code snippet below and the corresponding image in
   :ref:`Figure: Example of using the OEDrawTextToCenter function <figure_OEDrawTextToCenter>`.

   .. oe:source:: OEDrawTextToCenter.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEDrawTextToCenter

   .. oe:source:: OEDrawTextToCenter.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEDrawTextToCenter

   .. oe:source:: OEDrawTextToCenter.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEDrawTextToCenter

   .. oe:language:: csharp

   .. oe:source:: OEDrawTextToCenter.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEDrawTextToCenter

   .. _figure_OEDrawTextToCenter:

   .. figure:: depicttk/images/OEDrawTextToCenter.*
      :align:  center

      **Example of using the OEDrawTextToCenter function**

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class
      * :ref:`OEFont <OEDepict_OEFont>` class
      * :oe:func:`OEDepict::OEDrawBorder` function
      * :oe:func:`OEDepict::OEDrawText` function




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEEstimateTextWidth

.. _OEDepict_OEEstimateTextWidth:

.. oe:function:: OEEstimateTextWidth

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEEstimateTextWidth(const std::string& text, const OEFont& font)

   .. oe:language:: python

      .. oe:api:: python

         OEEstimateTextWidth(text: str, font: OEFont) -> float

   Estimates the width of string depicted with a specific style.

   *text*
      The string of which width is being estimated.

   *font*
      The :ref:`OEFont <OEDepict_OEFont>` object that defines the style of
      the depiction.

   .. seealso::

      * :oe:func:`OEDepict::OEReduceFontSizeToFit` function
      * :ref:`OEFont <OEDepict_OEFont>` class



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetAverageBondLengthInDispCoords

.. _OEDepict_OEGetAverageBondLengthInDispCoords:

.. oe:function:: OEGetAverageBondLengthInDispCoords

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetAverageBondLengthInDispCoords(const OE2DMolDisplay& disp)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAverageBondLengthInDispCoords(disp: OE2DMolDisplay) -> float

   Returns the average bond length of the molecule in "display" coordinate system.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEGetBuiltInHiddenSVGClass:

.. oe:function:: OEGetBuiltInHiddenSVGClass

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OESVGClass* OEGetBuiltInHiddenSVGClass(OEImageBase& image)

   .. oe:language:: python

      .. oe:api:: python

         OEGetBuiltInHiddenSVGClass(image: OEImageBase) -> OESVGClass

   Returns an :ref:`OESVGClass <OEDepict_OESVGClass>` that have been previously added to the
   given image by calling the :oe:func:`OEDepict::OEAddBuiltInHiddenSVGClass` function.

   .. seealso::

      * :ref:`OESVGClass <OEDepict_OESVGClass>` class
      * :ref:`OEImage <OEDepict_OEImage>` class
      * :oe:func:`OEDepict::OEAddBuiltInHiddenSVGClass` function
      * :oe:func:`OEDepict::OEAddBuiltInVisibleSVGClass` function
      * :oe:func:`OEDepict::OEGetBuiltInVisibleSVGClass` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEGetBuiltInVisibleSVGClass:

.. oe:function:: OEGetBuiltInVisibleSVGClass

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OESVGClass* OEGetBuiltInVisibleSVGClass(OEImageBase& image)

   .. oe:language:: python

      .. oe:api:: python

         OEGetBuiltInVisibleSVGClass(image: OEImageBase) -> OESVGClass

   Returns an :ref:`OESVGClass <OEDepict_OESVGClass>` that have been previously added to the
   given image by calling the :oe:func:`OEDepict::OEAddBuiltInVisibleSVGClass` function.

   .. seealso::

      * :ref:`OESVGClass <OEDepict_OESVGClass>` class
      * :ref:`OEImage <OEDepict_OEImage>` class
      * :oe:func:`OEDepict::OEAddBuiltInHiddenSVGClass` function
      * :oe:func:`OEDepict::OEAddBuiltInVisibleSVGClass` function
      * :oe:func:`OEDepict::OEGetBuiltInHiddenSVGClass` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetCenter

.. _OEDepict_OEGetCenter:

.. oe:function:: OEGetCenter

   .. oe:language:: c++ java csharp

      .. oe:api::

         OE2DPoint OEGetCenter(const OEImageBase& image)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCenter(image: OEImageBase) -> OE2DPoint

   Returns the center of the image.

   .. seealso::

      * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetColor

.. _OEDepict_OEGetColor:

.. oe:function:: OEGetColor

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEColor OEGetColor(const OESystem::OEInterface& itf,
                                      const std::string& name)

   .. oe:language:: python

      .. oe:api:: python

         OEGetColor(itf: OEInterface, name: str) -> OEColor

   Returns the color initialized in the given interface.

   *itf*
      The interface in which the parameter is configured.

   *name*
      The name of the parameter.

   .. seealso::

      * :oe:func:`OEDepict::OEConfigureColor` function
      * :ref:`OEColor <OESystem_OEColor>` class



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetDefaultAtomColor

.. _OEDepict_OEGetDefaultAtomColor:

.. oe:function:: OEGetDefaultAtomColor

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEColor OEGetDefaultAtomColor(unsigned int atomic,
                                                 unsigned int style = OEAtomColorStyle::WhiteCPK)

   .. oe:language:: python

      .. oe:api:: python

         OEGetDefaultAtomColor(atomic: int, style: int) -> OEColor

   Returns the default color associated with an atomic number for the given atom
   color style.

   *atomic*
      Atomic number.

   *style*
      This value has to be from the :oe:constns:`OEDepict::OEAtomColorStyle`
      namespace.

   .. seealso::

      :ref:`chapter_element_color` chapter



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetDisplayCoords

.. _OEDepict_OEGetDisplayCoords:

.. oe:function:: OEGetDisplayCoords

   .. oe:language:: c++ java csharp

      .. oe:api::

         OE2DPoint OEGetDisplayCoords(const OE2DMolDisplay& disp,
                                      const OE2DPoint& p)

   .. oe:language:: python

      .. oe:api:: python

         OEGetDisplayCoords(disp: OE2DMolDisplay, p: OE2DPoint) -> OE2DPoint

   Converts a 2D point from the "molecule" 2D coordinate system" to "display"
   2D coordinate system.

   This is the reverse operation from :oe:func:`OEDepict::OEGetDisplayCoords`.

   .. seealso::

      * :oe:func:`OEDepict::OEGetMoleculeCoords` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetHighlightColor

.. _OEDepict_OEGetHighlightColor:

.. oe:function:: OEGetHighlightColor

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEColor OEGetHighlightColor(const OESystem::OEInterface& itf,
                                               std::string name = OEHighlightParamName::Color)

   .. oe:language:: python

      .. oe:api:: python

         OEGetHighlightColor(itf: OEInterface, name: str) -> OEColor

   Returns the highlight color initialized in the given interface.

   *itf*
      The interface in which the parameter is configured.

   *name*
      The name of the parameter.

   .. seealso::

      * :oe:func:`OEDepict::OEConfigureHighlightParams` function
      * :oe:func:`OEDepict::OEConfigureHighlightColor` function
      * :ref:`OEColor <OESystem_OEColor>` class



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetHighlightStyle

.. _OEDepict_OEGetHighlightStyle:

.. oe:function:: OEGetHighlightStyle

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetHighlightStyle(const OESystem::OEInterface& itf,
                                          std::string name = OEHighlightParamName::Style)

   .. oe:language:: python

      .. oe:api:: python

         OEGetHighlightStyle(itf: OEInterface, name: str) -> int

   Returns the highlight style initialized in the given interface.
   The return value is taken from the :oe:constns:`OEDepict::OEHighlightStyle`
   namespace.

   *itf*
      The interface in which the parameter is configured.

   *name*
      The name of the parameter.

   .. seealso::

      * :oe:func:`OEDepict::OEConfigureHighlightParams` function
      * :oe:func:`OEDepict::OEConfigureHighlightStyle` function
      * :oe:constns:`OEDepict::OEHighlightStyle` namespace



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetImageGridNumColumns

.. _OEDepict_OEGetImageGridNumColumns:

.. oe:function:: OEGetImageGridNumColumns

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetImageGridNumColumns(const OESystem::OEInterface& itf,
                                               std::string name = OEImageGridParamName::NumColumns)

   .. oe:language:: python

      .. oe:api:: python

         OEGetImageGridNumColumns(itf: OEInterface, name: str) -> int

   Returns the number of grid columns initialized in the given interface.

   *itf*
      The interface in which the parameter is configured.

   *name*
      The name of the parameter.

   .. seealso::

      * :oe:func:`OEDepict::OEConfigureImageGridNumColumns` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetImageGridNumRows

.. _OEDepict_OEGetImageGridNumRows:

.. oe:function:: OEGetImageGridNumRows

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetImageGridNumRows(const OESystem::OEInterface& itf,
                                            std::string name = OEImageGridParamName::NumRows)

   .. oe:language:: python

      .. oe:api:: python

         OEGetImageGridNumRows(itf: OEInterface, name: str) -> int

   Returns the number of grid rows initialized in the given interface.

   *itf*
      The interface in which the parameter is configured.

   *name*
      The name of the parameter.

   .. seealso::

      * :oe:func:`OEDepict::OEConfigureImageGridNumRows` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetImageHeight

.. _OEDepict_OEGetImageHeight:

.. oe:function:: OEGetImageHeight

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetImageHeight(const OESystem::OEInterface& itf,
                                 std::string name = OEImageParamName::Height)

   .. oe:language:: python

      .. oe:api:: python

         OEGetImageHeight(itf: OEInterface, name: str) -> float

   Returns the height of the image initialized in the given interface.

   *itf*
      The interface in which the parameter is configured.

   *name*
      The name of the parameter.

   .. seealso::

      * :oe:func:`OEDepict::OEConfigureImageHeight` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetImageWidth

.. _OEDepict_OEGetImageWidth:

.. oe:function:: OEGetImageWidth

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetImageWidth(const OESystem::OEInterface& itf,
                                std::string name = OEImageParamName::Width)

   .. oe:language:: python

      .. oe:api:: python

         OEGetImageWidth(itf: OEInterface, name: str) -> float

   Returns the width of the image initialized in the given interface.

   *itf*
      The interface in which the parameter is configured.

   *name*
      The name of the parameter.

   .. seealso::

      * :oe:func:`OEDepict::OEConfigureImageWidth` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetLabelPosition

.. _OEDepict_OEGetLabelPosition:

.. oe:function:: OEGetLabelPosition

   Returns the position used to add a label to an image or molecule display.

   .. list-table:: **The overloaded versions of the OEGetLabelPosition function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OEGetLabelPosition(disp, label, match)<api_OEGetLabelPosition_OE2DMolDisplay_OEHighlightLabel_OEMatchBase>`
        - getting label position related to atoms of a match

      * - :ref:`OEGetLabelPosition(disp, label, abset)<api_OEGetLabelPosition_OE2DMolDisplay_OEHighlightLabel_OEAtomBondSet>`
        - getting label position related to set of atoms

      * - :ref:`OEGetLabelPosition(disp, label, atompred)<api_OEGetLabelPosition_OE2DMolDisplay_OEHighlightLabel_AtomPredicate>`
        - getting label position related to atoms specified by a predicate

   .. note::

      When adding label associated with atoms it is recommended to use the
      :oe:func:`OEDepict::OEAddLabel` along with the :oe:func:`OEDepict::OEAddHighlighting`
      function for visual clarity.

   .. _api_OEGetLabelPosition_OE2DMolDisplay_OEHighlightLabel_OEAtomBondSet:

   .. oe:language:: c++ java csharp

      .. oe:api::

         OE2DPoint OEGetLabelPosition(const OE2DMolDisplay& disp,
                                      const OEHighlightLabel& label,
                                      const OEChem::OEAtomBondSet& abset)

   .. oe:language:: python

      .. oe:api:: python

         OEGetLabelPosition(disp: OE2DMolDisplay, label: OEHighlightLabel,
                            abset: OEAtomBondSet) -> OE2DPoint

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object on which the label is going to
      be positioned.

   *label*
      The :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` object that stores properties that
      determine the styles of the label along with the text of the label itself.

   *abset*
      The label is positioned based on the atoms stored in the
      :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object.

   .. _api_OEGetLabelPosition_OE2DMolDisplay_OEHighlightLabel_OEMatchBase:

   .. oe:language:: c++ java csharp

      .. oe:api::

         OE2DPoint OEGetLabelPosition(const OE2DMolDisplay& disp,
                                      const OEHighlightLabel& label,
                                      const OEChem::OEMatchBase& match)

   .. oe:language:: python

      .. oe:api:: python

         OEGetLabelPosition(disp: OE2DMolDisplay, label: OEHighlightLabel,
                            match: OEMatchBase) -> OE2DPoint

   Adds label to atoms of an :ref:`OEMatchBase <OEChem_OEMatchBase>` object that can be
   initialized by substructure search or maximum common substructure search.

      *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object on which the label is going to
      be positioned.

   *label*
      The :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` object that stores properties that
      determine the styles of the label along with the text of the label itself.

   *match*
      The label is positioned  based on the target atoms of the
      :ref:`OEMatchBase <OEChem_OEMatchBase>` object.

   .. _api_OEGetLabelPosition_OE2DMolDisplay_OEHighlightLabel_AtomPredicate:

   .. oe:language:: c++ java csharp

      .. oe:api::

         OE2DPoint OEGetLabelPosition(const OE2DMolDisplay& disp,
                                      const OEHighlightLabel& label,
                                      const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& atompred)

   .. oe:language:: python

      .. oe:api:: python

         OEGetLabelPosition(disp: OE2DMolDisplay, label: OEHighlightLabel,
                            atompred: OEUnaryAtomPred) -> OE2DPoint

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object on which the label is going to
      be positioned.

   *label*
      The :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` object that stores properties that
      determine the styles of the label along with the text of the label itself.

   *atompred*
      The label is positioned based on the atoms for which the given
      atom predicate returns `true`.



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetMoleculeCoords

.. _OEDepict_OEGetMoleculeCoord:

.. oe:function:: OEGetMoleculeCoords

   .. oe:language:: c++ java csharp

      .. oe:api::

         OE2DPoint OEGetMoleculeCoords(const OE2DMolDisplay& disp,
                                       const OE2DPoint& p)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMoleculeCoords(disp: OE2DMolDisplay, p: OE2DPoint) -> OE2DPoint

   Converts a 2D point from the "display" 2D coordinate system" to "molecule"
   2D coordinate system.

   This is the reverse operation from :oe:func:`OEDepict::OEGetMoleculeCoords`.

   .. seealso::

      * :oe:func:`OEDepict::OEGetMoleculeCoords` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetMoleculeScale

.. _OEDepict_OEGetMoleculeScale:

.. oe:function:: OEGetMoleculeScale

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetMoleculeScale(const OEChem::OEMolBase& mol,
                                   const OE2DMolDisplayOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMoleculeScale(mol: Union[OEGraphMol,OEMol,OEQMol],
                            opts: OE2DMolDisplayOptions) -> float

   Estimates the scaling factor of the molecule depiction based on the
   parameters stored in given :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`
   object.

   *mol*
     The molecule of which scaling factor is determined.

   *opts*
     The :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object that stores
     the parameters that determine the scaling factor
     (such as width and height).

   .. seealso::

      * :ref:`section_mol_display_size` section



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetMultiPageOrientation

.. _OEDepict_OEGetMultiPageOrientation:

.. oe:function:: OEGetMultiPageOrientation

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetMultiPageOrientation(const OESystem::OEInterface& itf,
                                                std::string name = OEMultiPageParamName::PageOrientation)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMultiPageOrientation(itf: OEInterface, name: str) -> int

   Returns the page orientation initialized in the given interface.
   The return value is taken from the :oe:constns:`OEDepict::OEPageOrientation`
   namespace.

   *itf*
      The interface in which the parameter is configured.

   *name*
      The name of the parameter.

   .. seealso::

      * :oe:func:`OEDepict::OEConfigureMultiPageOrientation` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetMultiPageSize

.. _OEDepict_OEGetMultiPageSize:

.. oe:function:: OEGetMultiPageSize

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetMultiPageSize(const OESystem::OEInterface& itf,
                                         std::string name = OEMultiPageParamName::PageSize)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMultiPageSize(itf: OEInterface, name: str) -> int

   Returns the page orientation initialized in the given interface.
   The return value is taken from the :oe:constns:`OEDepict::OEPageSize`
   namespace.

   *itf*
      The interface in which the parameter is configured.

   *name*
      The name of the parameter.

   .. seealso::

      * :oe:func:`OEDepict::OEConfigureMultiPageSize` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetNearbyAtom

.. _OEDepict_OEGetNearbyAtom:

.. oe:function:: OEGetNearbyAtom

   .. oe:language:: c++ java csharp

      .. oe:api::

         OENearestAtom OEGetNearbyAtom(const OE2DMolDisplay& disp,
                                       const OE2DPoint& point,
                                       double radiusscale = 1.0)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearbyAtom(disp: OE2DMolDisplay, p: OE2DPoint,
                         radiusscale: float = 1.0) -> OENearestAtom

   Returns an :ref:`OENearestAtom <OEDepict_OENearestAtom>` object that stores a pointer
   of the atom which is depicted nearest to a given 2D display coordinates.
   By default, only atoms that are no further than half bond away from the given
   point will be considered.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object of which atoms are being
      considered.
      Only atoms of which atom display is visible are examined
      (:oe:meth:`OEDepict::OEAtomDisplayBase::IsVisible`)

   *point*
      Specifies the 2D display coordinates.

   *radiusscale*
       The multiplier that can be used to increase or to decrease the
       radius around the given point to be considered.
       This value has to be in a range of :math:`[0.25, 2.0]`.

   .. note::

      If there is no atom close to the given display coordinates,
      then the :oe:meth:`OEDepict::OENearestAtom::IsValid` method returns
      `false`.

   .. seealso::

      * :ref:`OENearestAtom <OEDepict_OENearestAtom>` class
      * :oe:func:`OEDepict::OEGetNearestAtom` function
      * :oe:func:`OEDepict::OEGetNearbyBond` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetNearbyBond

.. _OEDepict_OEGetNearbyBond:

.. oe:function:: OEGetNearbyBond

   .. oe:language:: c++ java csharp

      .. oe:api::

         OENearestBond OEGetNearbyBond(const OE2DMolDisplay& disp,
                                       const OE2DPoint& point,
                                       double radiusscale = 1.0)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearbyBond(disp: OE2DMolDisplay, p: OE2DPoint,
                         radiusscale: float = 1.0) -> OENearestBond

   Returns an :ref:`OENearestAtom <OEDepict_OENearestAtom>` object that stores a pointer
   of the bond which is depicted nearest to a given 2D display coordinates.
   By default, only bonds that are no further than half bond away from the given
   point will be considered.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object of which bonds are being
      considered.
      Only bonds of which bond display is visible are examined
      (:oe:meth:`OEDepict::OEBondDisplayBase::IsVisible`)

   *point*
      Specifies the 2D display coordinates.

   *radiusscale*
       The multiplier that can be used to increase or to decrease the
       radius around the given point to be considered.
       This value has to be in a range of :math:`[0.25, 2.0]`.

   .. note::

      If there is no bond close to the given display coordinates,
      then the :oe:meth:`OEDepict::OENearestBond::IsValid` method returns
      `false`.

   .. seealso::

      * :ref:`OENearestBond <OEDepict_OENearestBond>` class
      * :oe:func:`OEDepict::OEGetNearestBond` function
      * :oe:func:`OEDepict::OEGetNearbyAtom` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetNearestAtom

.. _OEDepict_OEGetNearestAtom:

.. oe:function:: OEGetNearestAtom

   .. oe:language:: c++ java csharp

      .. oe:api::

         OENearestAtom OEGetNearestAtom(const OE2DMolDisplay& disp,
                                        const OE2DPoint& point)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearestAtom(disp: OE2DMolDisplay, p: OE2DPoint) -> OENearestAtom

   Returns an :ref:`OENearestAtom <OEDepict_OENearestAtom>` object that stores a pointer
   of the atom which is depicted nearest to a given 2D display coordinates.

   .. figure:: depicttk/images/OEGetNearestAtom.*
      :align:  center

      **Example of using the OEGetNearestAtom function
      to determine the nearest atom to a specific 2D point on the canvas**

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object of which atoms are being
      considered.
      Only atoms of which atom display is visible are examined
      (:oe:meth:`OEDepict::OEAtomDisplayBase::IsVisible`)

   *point*
      Specifies the 2D display coordinates.

   .. seealso::

      * :ref:`OENearestAtom <OEDepict_OENearestAtom>` class
      * :oe:func:`OEDepict::OEGetNearbyAtom` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetNearestBond

.. _OEDepict_OEGetNearestBond:

.. oe:function:: OEGetNearestBond

   .. oe:language:: c++ java csharp

      .. oe:api::

         OENearestBond OEGetNearestBond(const OE2DMolDisplay& disp,
                                        const OE2DPoint& point)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearestBond(disp: OE2DMolDisplay, p: OE2DPoint) -> OENearestBond

   Returns an :ref:`OENearestBond <OEDepict_OENearestBond>` object that stores a pointer
   of the bond which is depicted nearest to a given 2D display coordinates.

   .. figure:: depicttk/images/OEGetNearestBond.*
      :align:  center

      **Example of using the OEGetNearestBond function
      to determine the nearest bond to a specific 2D point on the canvas**

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object of which bonds are being
      considered.
      Only bonds of which bond display is visible are examined
      (:oe:meth:`OEDepict::OEBondDisplayBase::IsVisible`)

   *point*
      Specifies the 2D display coordinates.

   .. seealso::

      * :ref:`OENearestBond <OEDepict_OENearestBond>` class
      * :oe:func:`OEDepict::OEGetNearbyBond` function




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetPageHeight

.. _OEDepict_OEGetPageHeight:

.. oe:function:: OEGetPageHeight

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetPageHeight(unsigned int size)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPageHeight(size: int) -> float

   Returns the page height for the given size.

   *size*
      This value has to be from the :oe:constns:`OEDepict::OEPageSize`
      namespace.

   .. seealso::

      * :oe:constns:`OEDepict::OEPageSize` namespace
      * :oe:func:`OEDepict::OEGetPageWidth` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetPageWidth

.. _OEDepict_OEGetPageWidth:

.. oe:function:: OEGetPageWidth

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetPageWidth(unsigned int size)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPageWidth(size: int) -> float

   Returns the page width for the given size.

   *size*
      This value has to be from the :oe:constns:`OEDepict::OEPageSize`
      namespace.

   .. seealso::

      * :oe:constns:`OEDepict::OEPageSize` namespace
      * :oe:func:`OEDepict::OEGetPageHeight` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetSupportedImageFileExtensions

.. _OEDepict_OEGetSupportedImageFileExtensions:

.. oe:function:: OEGetSupportedImageFileExtensions

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<const std::string>* OEGetSupportedImageFileExtensions()

   .. oe:language:: python

      .. oe:api:: python

         OEGetSupportedImageFileExtensions() -> Iterable[str]

   Returns an iterator over the file extensions of the supported
   image file formats.

   ====================================== ======================
   Graphics File Format                   File Extension
   ====================================== ======================
   PNG (Portable Network Graphics)        :file:`.png`
   :term:`SVG` (Scalable Vector Graphics) :file:`.svg`
   *bare* :term:`SVG` (with no header)    :file:`.bsvg`
   Postscript                             :file:`.ps`
   Encapsulated PostScript                :file:`.eps`
   PDF (Portable Document Format)         :file:`.pdf`
   ====================================== ======================



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEGetSupportedMultiPageImageFileExtensions

.. _OEDepict_OEGetSupportedMultiPageImageFileExtensions:

.. oe:function:: OEGetSupportedMultiPageImageFileExtensions

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<const std::string>* OEGetSupportedMultiPageImageFileExtensions()

   .. oe:language:: python

      .. oe:api:: python

         OEGetSupportedMultiPageImageFileExtensions() -> Iterable[str]

   Returns an iterator over the file extensions of the supported
   multi-page image file formats.

   ====================================== ==================
   Multi-page Image File Format           File Extension
   ====================================== ==================
   Postscript                             :file:`.ps`
   PDF (Portable Document Format)         :file:`.pdf`
   ====================================== ==================



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEHasDepictionHydrogens

.. _OEDepict_OEHasDepictionHydrogens:

.. oe:function:: OEHasDepictionHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasDepictionHydrogens(const OEChem::OEAtomBase *)

   .. oe:language:: python

      .. oe:api:: python

         OEHasDepictionHydrogens(arg1: OEAtomBase) -> bool

   Determines whether the specified heavy atom has a
   "depiction" hydrogen.
   Depiction hydrogens are hydrogens that need to be explicitly drawn
   in a 2D depiction to faithfully represent tetrahedral
   atom stereochemistry or cis/trans bond stereochemistry.

   .. list-table:: **Example of molecules with "depiction" hydrogen(s)**
      :widths: 300 300

      * - .. image:: ../images/OEHasDepictionHydrogens_CisTrans.*
        - .. image:: ../images/OEHasDepictionHydrogens_Tetrahedral.*

   .. seealso::

      * :oe:func:`OEDepict::OEAddDepictionHydrogens` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEIsRegisteredImageFile

.. _OEDepict_OEIsRegisteredImageFile:

.. oe:function:: OEIsRegisteredImageFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsRegisteredImageFile(const std::string& ext)

   .. oe:language:: python

      .. oe:api:: python

         OEIsRegisteredImageFile(ext: str) -> bool

   Returns whether or not an image file format is registered (*i.e.*
   supported) with the given extension. The following snippet of code
   demonstrates how to check whether a file name is a supported file
   format.

   .. oe:source:: OEIsRegisteredImageFile.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEIsRegisteredImageFile

   .. oe:source:: OEIsRegisteredImageFile.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEIsRegisteredImageFile

   .. oe:source:: OEIsRegisteredImageFile.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEIsRegisteredImageFile

   .. oe:source:: OEIsRegisteredImageFile.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEIsRegisteredImageFile



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEIsRegisteredMultiPageImageFile

.. _OEDepict_OEIsRegisteredMultiPageImageFile:

.. oe:function:: OEIsRegisteredMultiPageImageFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsRegisteredMultiPageImageFile(const std::string& ext)

   .. oe:language:: python

      .. oe:api:: python

         OEIsRegisteredMultiPageImageFile(ext: str) -> bool

   Returns whether or not a multi-page image file format is registered
   (*i.e.* supported) with the given extension.



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEIsValidSVGClassName:

.. oe:function:: OEIsValidSVGClassName

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsValidSVGClassName(const std::string& name)

   .. oe:language:: python

      .. oe:api:: python

         OEIsValidSVGClassName(name: str) -> bool

   Returns whether the given string can be used as an SVG class name.

   The rules of **valid** SVG classes names (:ref:`OESVGClass <OEDepict_OESVGClass>`)
   in **OEDepict TK** are:

   * It must start with an alphabetic character.
   * It must not contain any space characters.
   * It may contain any alphanumeric characters, ``-`` (hyphen) and
     ``_`` (underscore).
   * The size of the SVG class name should not exceed ``64`` characters.

   .. note::

      SVG class names starting with ``oedepict`` are reserved by
      **OEDepict TK** for internal usage.



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. _OEDepict_OEIsValidSVGGroupId:

.. oe:function:: OEIsValidSVGGroupId

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsValidSVGGroupId(const std::string& id)

   .. oe:language:: python

      .. oe:api:: python

         OEIsValidSVGGroupId(id: str) -> bool

   Returns whether the given string can be used as an SVG group identifier.

   The rules of **valid** SVG group ids (:ref:`OESVGClass <OEDepict_OESVGClass>`)
   in **OEDepict TK** are:

   * It must start with an alphabetic character.
   * It must not contain any space characters.
   * It may contain alphanumeric character and ``-`` (hyphen), ``_``
     (underscore), ``;`` (semi-colon) or ``.`` (period).
   * The size of the SVG group id should not exceed ``64`` characters.

   .. note::

      The group id must be **unique** amongst all the ids in the
      document. This condition is not checked by the
      :oe:func:`OEDepict::OEIsValidSVGGroupId` function.



.. |Bezier|    replace:: Bézier


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDepict

.. _OEDepict_OELengthenVector:

.. oe:function:: OELengthenVector

   .. oe:language:: c++ java csharp

      .. oe:api::

         OE2DPoint OELengthenVector(const OE2DPoint& vect, double length)

   .. oe:language:: python

      .. oe:api:: python

         OELengthenVector(vect: OE2DPoint, length: float) -> OE2DPoint

   Lengthen the given vector.

   .. seealso::

      * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
      * :oe:func:`OEDepict::OERotateVector` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEOffsetMolDisplay

.. _OEDepict_OEOffsetMolDisplay:

.. oe:function:: OEOffsetMolDisplay

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEOffsetMolDisplay(OE2DMolDisplay& disp, const OE2DPoint& offset)
         void OEOffsetMolDisplay(OE2DMolDisplay& disp,
                                 const OE2DMolDisplay& refdisp)

   .. oe:language:: python

      .. oe:api:: python

         OEOffsetMolDisplay(disp: OE2DMolDisplay, offset: OE2DPoint) -> None
         OEOffsetMolDisplay(disp: OE2DMolDisplay, refdisp: OE2DMolDisplay) -> None

   When an :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object is created, the
   depicted molecule is positioned in the middle of the *canvas*.
   The :oe:func:`OEDepict::OEOffsetMolDisplay` function can be used to
   translate the depicted molecule either by specifying an *offset*
   vector or another :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that is
   used as a reference that defines the translation.

   .. figure:: depicttk/images/OEOffsetMolDisplay.*
      :align:  center

      **Example of translating the depiction of a molecule by using
      offset vector (red arrows)**



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEPrepareAlignedDepiction

.. _OEDepict_OEPrepareAlignedDepiction:

.. oe:function:: OEPrepareAlignedDepiction

   .. list-table:: **The overloaded versions of the OEPrepareAlignedDepiction function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OEPrepareAlignedDepiction(fitmol, refmol, match, clearcoords, suppressH)<api_OEPrepareAlignedDepiction_fit_ref_match>`
        - aligns a molecule to the reference

      * - :ref:`OEPrepareAlignedDepiction(fitmol, refmol, match, opts)<api_OEPrepareAlignedDepiction_fit_ref_match_opts>`
        - aligns a molecule to the reference according to options

      * - :ref:`OEPrepareAlignedDepiction(fitmol, mcss, opts)<api_OEPrepareAlignedDepiction_fit_mcss_opts>`
        - aligns a molecule to the reference based on maximum common substructure search

      * - :ref:`OEPrepareAlignedDepiction(fitmol, subsrc, opts)<api_OEPrepareAlignedDepiction_fit_ss_opts>`
        - aligns a molecule to the reference based on substructure search

      * - :ref:`OEPrepareAlignedDepiction(fitmol, refmol, matches, opts)<api_OEPrepareAlignedDepiction_fit_ref_iter_opts>`
        - aligns a molecule to the reference based on matches

   .. seealso:

      * :oe:func:`OEChem::OEPrepareMultiAlignedDepiction` function

   .. _api_OEPrepareAlignedDepiction_fit_ref_match:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPrepareAlignedDepiction(OEChem::OEMolBase& fitmol,
                                        const OEChem::OEMolBase& refmol,
                                        const OEChem::OEMatchBase& match,
                                        bool clearCoords = true,
                                        bool suppressH = true)

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareAlignedDepiction(fitmol: Union[OEGraphMol,OEMol,OEQMol],
                                   refmol: Union[OEGraphMol,OEMol,OEQMol],
                                   match: OEMatchBase,
                                   clearCoords: bool = True,
                                   suppressH: bool = True) -> bool

   Generates the 2D coordinates of a molecule by maximizing its overlap
   with a reference 2D molecule based on the given match between the
   two molecules.

   *fitmol*
      The molecule being fitted to be aligned to the reference molecule.

   *refmol*
      The reference molecule of which 2D coordinates are remain unchanged.

   *match*
      The match determines the atoms of the *fitmol* that will be aligned
      to the atoms of the *refmol*.
      The match can be generated by hand, or with any of **OEChem TK**‘s matching
      algorithms such as :ref:`OESubSearch <OEChem_OESubSearch>` or
      :ref:`OEMCSSearch <OEChem_OEMCSSearch>`.

   *clearcoords*
      If `true`, than the 2D coordinates of the fitted molecule are re-calculated
      by calling the :oe:func:`OEDepict::OEPrepareDepiction` function.
      After generating the coordinates, the alignment between the two molecules
      is maximized by rotating the single bonds of the fitted molecule
      while avoiding atom clashes.
      See example (C) in :ref:`Figure: Example of the molecule alignment
      <figure_OEPrepareAlignedDepiction_ClearCoords>`.

      If *clearcoords* is `false` and the *fitmol* has 2D coordinates than
      these coordinates are kept.
      In this case only 2D rotation and translation of the fitted molecule is
      allowed (*i.e.* no rotations around bonds) in order to align it
      to the reference molecule.
      See example (B) in :ref:`Figure: Example of the molecule alignment
      <figure_OEPrepareAlignedDepiction_ClearCoords>`.

   *suppressH*
      If true, than explicit hydrogens are suppressed in the input molecule
      by calling the :oe:func:`OEDepict::OESuppressNonDepictionHydrogens` function.

   .. _figure_OEPrepareAlignedDepiction_ClearCoords:

   .. figure:: depicttk/images/OEPrepareAlignedDepictionClearCoords.*
      :align:  center

      **Example of the molecule alignment**

      *(A) molecule with no alignment;
      (B) aligning the fit molecule to the reference molecule by allowing
      only 2D rotations (original coordinates are kept);
      (C) aligning the fit molecule to the reference by allowing rotation
      around single bonds (coordinates are regenerate)*

   .. seealso::

      * :ref:`chapter_molalign` chapter

   .. ################################################################

   .. _api_OEPrepareAlignedDepiction_fit_ref_match_opts:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPrepareAlignedDepiction(OEChem::OEMolBase& fitmol,
                                        const OEChem::OEMolBase& refmol,
                                        const OEChem::OEMatchBase& match,
                                        const OEAlignmentOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareAlignedDepiction(fitmol: Union[OEGraphMol,OEMol,OEQMol],
                                   refmol: Union[OEGraphMol,OEMol,OEQMol],
                                   match: OEMatchBase, opts: OEAlignmentOptions) -> bool

   Generates the 2D coordinates of a molecule by maximizing its overlap
   with a reference 2D molecule based on the given match between the
   two molecules.

   *fitmol*
      The molecule being fitted to be aligned to the reference molecule.

   *refmol*
      The reference molecule of which 2D coordinates are remain unchanged.

   *match*
      The match determines the atoms of the *fitmol* that will be aligned
      to the atoms of the *refmol*.
      The match can be generated by hand, or with any of **OEChem TK**‘s matching
      algorithms such as :ref:`OESubSearch <OEChem_OESubSearch>` or
      :ref:`OEMCSSearch <OEChem_OEMCSSearch>`.

   *opts*
      The :ref:`OEAlignmentOptions <OEDepict_OEAlignmentOptions>` object that stores
      properties that influence how the molecule alignment is performed.

   .. seealso::

      * :ref:`chapter_molalign` chapter

   .. ################################################################

   .. _api_OEPrepareAlignedDepiction_fit_mcss_opts:

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAlignmentResult OEPrepareAlignedDepiction(OEChem::OEMolBase& fitmol,
                                                     const OEChem::OEMCSSearch& mcss,
                                                     const OEAlignmentOptions& opts = OEAlignmentOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareAlignedDepiction(fitmol: Union[OEGraphMol,OEMol,OEQMol],
                                   mcss: OEMCSSearch,
                                   opts: OEAlignmentOptions = OEAlignmentOptions()) -> OEAlignmentResult

   Generates the 2D coordinates of a molecule by maximizing its overlap
   based on the maximum common substructure initialized with a
   reference 2D molecule.

   *fitmol*
      The molecule being fitted to be aligned to the reference molecule.

   *mcss*
      The :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object stores the reference
      molecule.
      The molecule alignments are performed based on the
      maximum common substructure(s) detected between the fit and the
      reference molecule.

   *opts*
      The :ref:`OEAlignmentOptions <OEDepict_OEAlignmentOptions>` object that stores
      properties that influence how the molecule alignment is performed.

   .. warning::

      The reference molecule has to have 2D coordinates prior to
      initializing the :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object.

   .. seealso::

      * :ref:`OEMCSSearch <OEChem_OEMCSSearch>` class in the **OEChem TK** manual
      * :oe:src:`Listing 1<SNIPPET-MCS-ALIGN-MCSAlign>` example code in :ref:`chapter_molalign` chapter

   .. ################################################################

   .. _api_OEPrepareAlignedDepiction_fit_ss_opts:

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAlignmentResult OEPrepareAlignedDepiction(OEChem::OEMolBase& fitmol,
                                                     const OEChem::OESubSearch& subsrc,
                                                     const OEAlignmentOptions& opts = OEAlignmentOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareAlignedDepiction(fitmol: Union[OEGraphMol,OEMol,OEQMol],
                                   subsrc: OESubSearch,
                                   opts: OEAlignmentOptions = OEAlignmentOptions()) -> OEAlignmentResult

   Generates the 2D coordinates of a molecule by maximizing its overlap
   based on substructure search initialized with a reference 2D molecule.

   In case of a successful alignment, the returned :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>`
   object stores the match between fit and reference molecules.

   *fitmol*
      The molecule being fitted to be aligned to the reference molecule.

   *subsrc*
      The :ref:`OESubSearch <OEChem_OESubSearch>` object stores the reference
      molecule.
      The molecule alignments are performed based on the
      substructure(s) detected between the fit and the
      reference molecule.

   *opts*
      The :ref:`OEAlignmentOptions <OEDepict_OEAlignmentOptions>` object that stores
      properties that influence how the molecule alignment is performed.

   .. warning::

      The reference molecule has to have 2D coordinates prior to
      initializing the :ref:`OESubSearch <OEChem_OESubSearch>` object.

   .. seealso::

      * :ref:`OESubSearch <OEChem_OESubSearch>` class in the **OEChem TK** manual
      * :oe:src:`Listing 2<SNIPPET-SUB-SEARCH-ALIGN-SubSearchAlign>` code example in :ref:`chapter_molalign` chapter

   .. ################################################################

   .. _api_OEPrepareAlignedDepiction_fit_ref_iter_opts:

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEAlignmentResult OEPrepareAlignedDepiction(OEChem::OEMolBase& fitmol,
                                                     const OEChem::OEMolBase& refmol,
                                                     OESystem::OEIter<const OEChem::OEMatchBase>& miter,
                                                     const OEAlignmentOptions& opts = OEAlignmentOptions())
         OEAlignmentResult OEPrepareAlignedDepiction(OEChem::OEMolBase& fitmol,
                                                     const OEChem::OEMolBase& refmol,
                                                     OESystem::OEIterBase<const OEChem::OEMatchBase>* miter,
                                                     const OEAlignmentOptions& opts = OEAlignmentOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareAlignedDepiction(fitmol: Union[OEGraphMol,OEMol,OEQMol],
                                   refmol: Union[OEGraphMol,OEMol,OEQMol],
                                   opts: OEAlignmentOptions = OEAlignmentOptions()) -> OEAlignmentResult

   Generates the 2D coordinates of a molecule by maximizing its overlap
   with a reference 2D molecule based on the given matches between the
   two molecules.

   *fitmol*
      The molecule being fitted to be aligned to the reference molecule.

   *refmol*
      The reference molecule of which 2D coordinates are remain unchanged.

   *miter*
      The iterator that stores the matches on which the molecule
      alignment is based on.

   *opts*
      The :ref:`OEAlignmentOptions <OEDepict_OEAlignmentOptions>` object that stores
      properties that influence how the molecule alignment is performed.

   .. seealso::

      * :ref:`chapter_molalign` chapter




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEPrepareDepiction

.. _OEDepict_OEPrepareDepiction:

.. oe:function:: OEPrepareDepiction

   .. list-table:: **The overloaded versions of the OEPrepareDepiction function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OEPrepareDepiction(mol, clearccords, suppressH)<api_OEPrepareDepiction_mol_bool_bool>`
        - prepare depiction

      * - :ref:`OEPrepareDepiction(mol, opts)<api_OEPrepareDepiction_mol_opts>`
        - prepare depiction according to options

.. _api_OEPrepareDepiction_mol_bool_bool:

   .. oe:api::

      bool OEPrepareDepiction(OEChem::OEMolBase& mol, bool clearcoords = false,
                              bool suppressH = true)

   Prepares a molecule before depiction that involves suppressing or
   adding explicit hydrogens, perceiving atom and bond stereo information
   and calculating 2D coordinates.

   *mol*
      The molecule being manipulated.

   *clearcoords*
      If true, than the 2D coordinates of the molecule are re-calculated.
      If false and the molecule has 2D coordinates than these coordinates
      are kept.

      If the molecule has no 2D coordinates, then the 2D coordinates are
      always generated by calling the :oe:func:`OEDepict::OEDepictCoordinates`
      function regardless of the value of the *clearcoords* parameter.

   *suppressH*
      If true, than explicit hydrogens are suppressed in the input molecule
      by calling the :oe:func:`OEDepict::OESuppressNonDepictionHydrogens` function.
      See example in :ref:`Figure: Example of the molecule depictions with
      kept and suppressed hydrogens
      <figure_OEPrepareDepiction_HydrogenHandling>`.

   .. _figure_OEPrepareDepiction_HydrogenHandling:

   .. figure:: depicttk/images/OEPrepareDepictionHydrogenHandling.*
      :align:  center

      **Example of the molecule depictions with kept and suppressed hydrogens**

   .. note::

      The :oe:func:`OEDepict::OEPrepareDepiction` function generates
      canonical 2D coordinates (when the *clearcoords* parameter is true)
      i.e. the layout of the same molecules will be identical regardless of
      their atom and bond orderings.

      The following code shows how to generate non-canonical 2D coordinates:

      .. oe:source:: PrepareDepiction.py
         :language: python
         :noindent:
         :frag:     SNIPPET-PREPARE-DEPICTION

      .. oe:source:: PrepareDepiction.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-PREPARE-DEPICTION

      .. oe:source:: PrepareDepiction.java
         :language: java
         :noindent:
         :frag:     SNIPPET-PREPARE-DEPICTION

      .. oe:source:: PrepareDepiction.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-PREPARE-DEPICTION

   .. seealso::

      * :oe:func:`OEDepict::OEAddDepictionHydrogens` function
      * :oe:func:`OEDepict::OEDepictCoordinates` function

.. _api_OEPrepareDepiction_mol_opts:

   .. oe:api::

      bool OEPrepareDepiction(OEChem::OEMolBase& mol,
                              const OEPrepareDepictionOptions& opts)

   Prepares a molecule before depiction.

   *mol*
      The molecule being manipulated.

   *opts*
      The :ref:`OEPrepareDepictionOptions <OEDepict_OEPrepareDepictionOptions>` object that stores
      properties that influence how the molecule is prepared.



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEPrepareMultiAlignedDepiction

.. _OEDepict_OEPrepareMultiAlignedDepiction:

.. oe:function:: OEPrepareMultiAlignedDepiction

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPrepareMultiAlignedDepiction(OEChem::OEMolBase& fitmol,
                                             const OEChem::OEMolBase& refmol,
                                             OESystem::OEIter<OEChem::OEMatchBase>& miter)
         bool OEPrepareMultiAlignedDepiction(OEChem::OEMolBase& fitmol,
                                             const OEChem::OEMolBase& refmol,
                                             OESystem::OEIterBase<OEChem::OEMatchBase>* miter)

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareMultiAlignedDepiction(fitmol: Union[OEGraphMol,OEMol,OEQMol],
                                        refmol: Union[OEGraphMol,OEMol,OEQMol],
                                        miter: OEMatchBaseIter) -> bool

   Generates the 2D coordinates of a molecule by maximizing its overlay
   with a reference 2D molecule based on multiple overlaps between the
   two molecules.

   *fitmol*
      The molecule being fitted to be aligned to the reference molecule.

   *refmol*
      The reference molecule of which 2D coordinates are remain unchanged.

   *miter*
      The iterator that stores the matches on which the molecule
      alignment is based on.

   .. _figure_OEPrepareMultiAlignedDepiction:

   .. figure:: depicttk/images/OEPrepareMultiAlignedDepiction.*
      :align:  center

      **Example of the molecule alignment based on multiple fragments**

      (left) - depiction of a reference molecule
      (middle) - default depiction of a fit molecule
      (right) - depiction of the fit molecule aligned to the reference based on multiple fragments

   .. hint::

      The overlap between two molecules can be generated by the
      :oe:func:`OEGraphSim::OEGetFPOverlap` function of  **GraphSim TK**.
      The :oe:func:`OEGraphSim::OEGetFPOverlap` returns matched fragments
      of two molecules that are considered equivalent based on a specific
      fingerprint type.

      .. figure:: depicttk/images/OEPrepareMultiAlignedDepictionVisualize.*
         :align:  center

      The Python script that visualizes molecule similarity based on fingerprints
      can be downloaded from the
      `OpenEye Python Cookbook <http://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html>`_

   .. seealso::

      * :ref:`chapter_molalign` chapter
      * :ref:`chapter_overlap` chapter in **GraphSim TK**
      * :oe:func:`OEDepict::OEPrepareAlignedDepiction` function
      * :oe:src:`Listing 3<SNIPPET-FINGERPRINT-ALIGN-FPAlign>` example code in :ref:`chapter_molalign` chapter



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEReduceFontSizeToFit

.. _OEDepict_OEReduceFontSizeToFit:

.. oe:function:: OEReduceFontSizeToFit

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEReduceFontSizeToFit(const std::string& text,
                                            const OEFont& font,
                                            unsigned int minfontsize,
                                            double maxwidth)

   .. oe:language:: python

      .. oe:api:: python

         OEReduceFontSizeToFit(text: str, font: OEFont, minfontsize: int,
                               maxwidth: float) -> int

   The :oe:func:`OEDepict::OEReduceFontSizeToFit` function
   gradually reduces the font size until the specified string can be drawn
   without exceeding the width limit.

   *text*
      The string for which the font size is calculated.

   *font*
      The :ref:`OEFont <OEDepict_OEFont>` object that defines the style of
      the depiction.

   *minfontsize*
      The minimum font size that can be returned.

   *maxwidth*
      The width that can not be exceeded when drawing the string.

   .. seealso::

      * :oe:func:`OEDepict::OEEstimateTextWidth` function
      * :ref:`OEFont <OEDepict_OEFont>` class



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OERegisterImageFile

.. _OEDepict_OERegisterImageFile:

.. oe:function:: OERegisterImageFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERegisterImageFile(const OEImageFileCreatorBase &)

   .. oe:language:: python

      .. oe:api:: python

         OERegisterImageFile(arg1: OEImageFileCreatorBase) -> bool

   Registers an :ref:`OEImageFileCreatorBase <OEDepict_OEImageFileCreatorBase>` object
   that handles a specific image file type.

   .. seealso::

      * :ref:`OEImageFileCreatorBase <OEDepict_OEImageFileCreatorBase>` class
      * :oe:func:`OEDepict::OEIsRegisteredImageFile` function
      * :oe:func:`OEDepict::OEIsRegisteredMultiPageImageFile` function



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OERenderMolecule

.. _OEDepict_OERenderMolecule:

.. oe:function:: OERenderMolecule

   .. list-table:: **The overloaded versions of the OERenderMolecule function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OERenderMolecule(image, disp)<api_OERenderMolecule_OEImageBase_OE2DMolDisplay>`
        - renders a molecule display into an image

      * - :ref:`OERenderMolecule(image, mol)<api_OERenderMolecule_OEImageBase_OEMolBase>`
        - renders molecule into an image using the **default** depiction style

      * - :ref:`OERenderMolecule(filename, disp)<api_OERenderMolecule_filename_OE2DMolDisplay>`
        - writes a molecule display into a file

      * - :ref:`OERenderMolecule(filename, mol)<api_OERenderMolecule_filename_OEMolBase>`
        - writes a molecule into a file using the **default** depiction style

      * - :ref:`OERenderMolecule(stream, ext, disp)<api_OERenderMolecule_oeostream_OE2DMolDisplay>`
        - writes a molecule display into an output stream

      * - :ref:`OERenderMolecule(stream, ext, mol)<api_OERenderMolecule_oeostream_OEMolBase>`
        - writes a molecule into an output stream using the **default** depiction style

   .. hint::

      Setting the `clearbackground` option to false, allows the generation of images with transparent background.

      .. list-table::
         :header-rows: 1

         * - clearbackground [#f1]_
           - effect
         * - true (default)
           - clears the image by drawing a rectangle underneath the molecule with the background color [#f2]_ before molecule rendering
         * - false
           - does **not** clear the image, enabling the generation of transparent images (for example PNG, SVG)

      .. [#f1] option of the :oe:func:`OEDepict::OERenderMolecule` function
      .. [#f2] background color can be set with the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBackgroundColor` method
         (default is :oe:const:`OEWhite<OESystem::OESystem::OEWhite>`)

      See the :ref:`Generating Transparent PNG <section_depiction_transparent>` Python cookbook example.

   .. _api_OERenderMolecule_OEImageBase_OE2DMolDisplay:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderMolecule(OEImageBase& image, const OE2DMolDisplay& disp,
                               bool clearbackground = true)

   .. oe:language:: python

      .. oe:api:: python

         OERenderMolecule(image: OEImageBase, disp: OE2DMolDisplay,
                          clearbackground: bool = True) -> bool

   Renders the molecule display into an image.

   *image*
      The image in which the molecule is drawn.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that holds the
      data necessary to depict the molecule with which it is
      initialized.

   *clearbackground*
      Determines whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to rendering the molecule; as a result, by default a white rectangle will be
      drawn underneath the molecule.

   **Example:**

   .. oe:source:: OERenderMolecule_image_disp.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-IMAGE-DISP

   .. oe:source:: OERenderMolecule_image_disp.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-IMAGE-DISP

   .. oe:source:: OERenderMolecule_image_disp.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-IMAGE-DISP

   .. oe:source:: OERenderMolecule_image_disp.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-IMAGE-DISP

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class
      * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class

   .. #############################################################

   .. _api_OERenderMolecule_OEImageBase_OEMolBase:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderMolecule(OEImageBase& image,
                               const OEChem::OEMolBase& mol,
                               bool clearbackground = true)

   .. oe:language:: python

      .. oe:api:: python

         OERenderMolecule(image: OEImageBase,
                          mol: Union[OEGraphMol,OEMol,OEQMol],
                          clearbackground: bool = True) -> bool

   Renders a molecule into an image using the **default** depiction style.

   *image*
      The image in which the molecule is drawn.

   *mol*
      The molecule being rendered has to have valid 2D coordinates
      before calling the :oe:func:`OEDepict::OERenderMolecule`
      function.

   *clearbackground*
      Determines whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to rendering the molecule; as a result, by default a white rectangle will be
      drawn underneath the molecule.

   **Example:**

   .. oe:source:: OERenderMolecule_image_mol.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-IMAGE-MOL

   .. oe:source:: OERenderMolecule_image_mol.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-IMAGE-MOL

   .. oe:source:: OERenderMolecule_image_mol.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-IMAGE-MOL

   .. oe:source:: OERenderMolecule_image_mol.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-IMAGE-MOL

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class

   .. #############################################################

   .. _api_OERenderMolecule_filename_OE2DMolDisplay:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderMolecule(const std::string& filename,
                               const OE2DMolDisplay& disp,
                               bool clearbackground = true)

   .. oe:language:: python

      .. oe:api:: python

         OERenderMolecule(filename: str, disp: OE2DMolDisplay,
                          clearbackground: bool = True) -> bool

   Writes the molecule display into a file.

   *filename*
      The name of the file into which the molecule display is being
      written.
      The extension of the filename determine the type of the image.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that holds the
      data necessary to depict the molecule with which it is
      initialized.

   *clearbackground*
      Determines whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to rendering the molecule; as a result, by default a white rectangle will be
      drawn underneath the molecule.

   **Example:**

   .. oe:source:: OERenderMolecule_fname_disp.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-FNAME-DISP

   .. oe:source:: OERenderMolecule_fname_disp.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-FNAME-DISP

   .. oe:source:: OERenderMolecule_fname_disp.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-FNAME-DISP

   .. oe:source:: OERenderMolecule_fname_disp.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-FNAME-DISP

   .. seealso::

      * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class

   .. #############################################################

   .. _api_OERenderMolecule_filename_OEMolBase:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderMolecule(const std::string& filename,
                               const OEChem::OEMolBase& mol,
                               bool clearbackground = true)

   .. oe:language:: python

      .. oe:api:: python

         OERenderMolecule(filename: str, mol: Union[OEGraphMol,OEMol,OEQMol],
                          clearbackground: bool = True) -> bool

   Writes a molecule into a file using the **default** depiction style.

   *filename*
      The name of the file into which the molecule is written.
      The extension of the filename determine the type of the image.

   *mol*
      The molecule being rendered  has to have valid 2D coordinates
      before calling the :oe:func:`OEDepict::OERenderMolecule`
      function.

   *clearbackground*
      Determines whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to rendering the molecule; as a result, by default a white rectangle will be
      drawn underneath the molecule.

   **Example:**

   .. oe:source:: OERenderMolecule_fname_mol.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-FNAME-MOL

   .. oe:source:: OERenderMolecule_fname_mol.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-FNAME-MOL

   .. oe:source:: OERenderMolecule_fname_mol.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-FNAME-MOL

   .. oe:source:: OERenderMolecule_fname_mol.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-FNAME-MOL

   .. #############################################################

   .. _api_OERenderMolecule_oeostream_OE2DMolDisplay:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderMolecule(OEPlatform::oeostream& os,
                               const std::string& extension,
                               const OE2DMolDisplay& disp,
                               bool clearbackground = true)

   .. oe:language:: python

      .. oe:api:: python

         OERenderMolecule(os: oeostream, extension: str, disp: OE2DMolDisplay,
                          clearbackground: bool = True) -> bool

   Writes the molecule display into a stream.

   *os*
      The stream into which the molecule display is being written.

   *ext*
      The extension which determine the type of the image.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that holds the
      data necessary to depict the molecule with which it is
      initialized.

   *clearbackground*
      Determines whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to rendering the molecule; as a result, by default a white rectangle will be
      drawn underneath the molecule.

   **Example:**

   .. oe:source:: OERenderMolecule_stream_disp.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-STREAM-DISP

   .. oe:source:: OERenderMolecule_stream_disp.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-STREAM-DISP

   .. oe:source:: OERenderMolecule_stream_disp.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-STREAM-DISP

   .. oe:source:: OERenderMolecule_stream_disp.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-STREAM-DISP

   .. seealso::

      * :ref:`oeostream <OEPlatform_oeostream>` class in the **OEChem TK** manual
      * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class

   .. #############################################################

   .. _api_OERenderMolecule_oeostream_OEMolBase:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderMolecule(OEPlatform::oeostream& os,
                               const std::string& extension,
                               const OEChem::OEMolBase& mol,
                               bool clearbackground = true)

   .. oe:language:: python

      .. oe:api:: python

         OERenderMolecule(os: oeostream, extension: str,
                          mol: Union[OEGraphMol,OEMol,OEQMol],
                          clearbackground: bool = True) -> bool

   Writes a molecule into a stream using the **default** depiction style.

   *os*
      The stream into which the molecule is being written.

   *ext*
      The extension which determine the type of the image.

   *mol*
      The molecule being rendered  has to have valid 2D coordinates
      before calling the :oe:func:`OEDepict::OERenderMolecule`
      function.

   *clearbackground*
      Determines whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to rendering the molecule; as a result, by default a white rectangle will be
      drawn underneath the molecule.

   **Example:**

   .. oe:source:: OERenderMolecule_stream_mol.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-STREAM-MOL

   .. oe:source:: OERenderMolecule_stream_mol.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-STREAM-MOL

   .. oe:source:: OERenderMolecule_stream_mol.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-STREAM-MOL

   .. oe:source:: OERenderMolecule_stream_mol.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEDEPICTMOLECULE-STREAM-MOL

   .. seealso::

      * :ref:`oeostream <OEPlatform_oeostream>` class in the **OEChem TK** manual



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OERenderMoleculeToBytes

.. _OEDepict_OERenderMoleculeToBytes:

.. oe:function:: OERenderMoleculeToBytes

   .. oe:language:: c++ java csharp

      .. oe:api::

         OERenderMoleculeToBytes(ext: str, disp: OE2DMolDisplay,
                                 clearbackground: bool = True) -> bytes
         OERenderMoleculeToBytes(ext: str, mol: OEMolBase,
                                 clearbackground: bool = True) -> bytes

   .. oe:language:: python

      .. oe:api:: python

         OERenderMoleculeToBytes(extension: str, disp: OE2DMolDisplay,
                                 clearbg: bool = True) -> bytes
         OERenderMoleculeToBytes(extension: str,
                                 mol: Union[OEGraphMol,OEMol,OEQMol],
                                 clearbg: bool = True) -> bytes

   Same as the :oe:func:`OEDepict::OERenderMoleculeToString` function.



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OERenderMoleculeToString

.. _OEDepict_OERenderMoleculeToString:

.. oe:function:: OERenderMoleculeToString

   .. list-table:: **The overloaded versions of the OERenderMoleculeToString function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OERenderMoleculeToString(ext, disp)<api_OERenderMoleculeToString_disp>`
        - writes a molecule display into a string (byte array)

      * - :ref:`OERenderMoleculeToString(ext, mol)<api_OERenderMoleculeToString_disp>`
        - writes a molecule into a string (byte array) using the **default** depiction style

.. _api_OERenderMoleculeToString_disp:

   .. oe:api::

      std::string OERenderMoleculeToString(const std::string& ext,
                                           const OE2DMolDisplay& disp,
                                           bool clearbackground = true)

   Writes a molecule display into a string.

   *ext*
      The extension which determine the type of the image.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that holds the
      data necessary to depict the molecule with which it is
      initialized.

   *clearbackground*
      Determines whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to the molecule rendering.

   .. seealso::

      * :oe:func:`OEDepict::OEIsRegisteredImageFile` function

   .. ################################################################

.. _api_OERenderMoleculeToString_mol:

   .. oe:api::

      std::string OERenderMoleculeToString(const std::string& ext,
                                           const OEChem::OEMolBase& mol,
                                           bool clearbackground = true)

   Writes a molecule into a string using the **default** depiction style.

   *ext*
      The extension which determine the type of the image.

   *mol*
      The molecule being rendered.

   *clearbackground*
      Determines whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to the molecule rendering.

   **Example:**

   .. oe:source:: RenderMoleculeToString.py
      :language: python
      :noindent:
      :frag:     SNIPPET-RENDER-MOL-TO-STRING

   .. oe:source:: RenderMoleculeToString.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-RENDER-MOL-TO-STRING

   .. oe:source:: RenderMoleculeToString.java
      :language: java
      :noindent:
      :frag:     SNIPPET-RENDER-MOL-TO-STRING

   .. oe:source:: RenderMoleculeToString.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-RENDER-MOL-TO-STRING

   .. oe:language:: python

      .. note::

         In **Python 3** the :oe:func:`OEDepict::OERenderMoleculeToString`
         function returns ``bytes``.

   .. seealso::

      * :oe:func:`OEDepict::OEIsRegisteredImageFile` function

      .. oe:language:: python

         * :oe:func:`OEDepict::OERenderMoleculeToBytes` function



.. |Bezier|    replace:: Bézier


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDepict

.. _OEDepict_OERotateVector:

.. oe:function:: OERotateVector

   .. oe:language:: c++ java csharp

      .. oe:api::

         OE2DPoint OERotateVector(const OE2DPoint& vect, double degree)

   .. oe:language:: python

      .. oe:api:: python

         OERotateVector(vect: OE2DPoint, degree: float) -> OE2DPoint

   Rotates the vector with the given degree. 

   .. seealso::

      * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
      * :oe:func:`OEDepict::OELengthenVector` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OESetup2DMolDisplayOptions

.. _OEDepict_OESetup2DMolDisplayOptions:

.. oe:function:: OESetup2DMolDisplayOptions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetup2DMolDisplayOptions(OE2DMolDisplayOptions& opts,
                                         const OESystem::OEInterface& itf)

   .. oe:language:: python

      .. oe:api:: python

         OESetup2DMolDisplayOptions(arg1: OE2DMolDisplayOptions,
                                    itf: OEInterface) -> bool

   Initializes an :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`
   object from the parameters of a given interface.

   .. seealso::

      * :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class
      * :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OESetupPrepareDepictionOptions

.. _OEDepict_OESetupPrepareDepictionOptions:

.. oe:function:: OESetupPrepareDepictionOptions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupPrepareDepictionOptions(OEPrepareDepictionOptions& opts,
                                             const OESystem::OEInterface& itf)

   .. oe:language:: python

      .. oe:api:: python

         OESetupPrepareDepictionOptions(arg1: OEPrepareDepictionOptions,
                                        itf: OEInterface) -> bool

   Initializes an :ref:`OEPrepareDepictionOptions <OEDepict_OEPrepareDepictionOptions>`
   object from the parameters of a given interface.

   .. seealso::

      * :ref:`OEPrepareDepictionOptions <OEDepict_OEPrepareDepictionOptions>` class
      * :oe:func:`OEDepict::OEConfigurePrepareDepictionOptions` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OESetupReportOptions

.. _OEDepict_OESetupReportOptions:

.. oe:function:: OESetupReportOptions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupReportOptions(OEReportOptions& opts,
                                   const OESystem::OEInterface& itf)

   .. oe:language:: python

      .. oe:api:: python

         OESetupReportOptions(opts: OEReportOptions, itf: OEInterface) -> bool

   Initializes an :ref:`OEReportOptions <OEDepict_OEReportOptions>`
   object from the parameters of a given interface.

   .. seealso::

      * :ref:`OEReportOptions <OEDepict_OEReportOptions>` class
      * :oe:func:`OEDepict::OEConfigureReportOptions` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OESuppressNonDepictionHydrogens

.. _OEDepict_OESuppressNonDepictionHydrogens:

.. oe:function:: OESuppressNonDepictionHydrogens

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESuppressNonDepictionHydrogens(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OESuppressNonDepictionHydrogens(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   The :oe:func:`OEDepict::OESuppressNonDepictionHydrogens` function
   suppresses all non-essential hydrogens of the molecule.
   Only the following hydrogens will be kept:

   * hydrogens with (non-zero) isotopic mass
   * hydrogens that are necessary to faithfully represent tetrahedral atom
     stereochemistry or cis/trans bond stereochemistry
     (defined by the :oe:func:`OEDepict::OEHasDepictionHydrogens` function).

   .. list-table::
      :widths: 200 200
      :header-rows: 1

      * - Before
        - After

      * - .. image:: ../images/OESuppressNonDepictionHydrogens-before.*
        - .. image:: ../images/OESuppressNonDepictionHydrogens-after.*

   .. seealso::

      * :oe:func:`OEDepict::OEHasDepictionHydrogens` function




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEWrite2DRingDictionaryReport

.. _OEDepict_OEWrite2DRingDictionaryReport:

.. oe:function:: OEWrite2DRingDictionaryReport

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWrite2DRingDictionaryReport(const std::string& filename,
                                            const OEChem::OE2DRingDictionary& ringdict,
                                            const OEReportOptions& opts)
         bool OEWrite2DRingDictionaryReport(OEPlatform::oeostream& os,
                                            const std::string& extension,
                                            const OEChem::OE2DRingDictionary& ringdict,
                                            const OEReportOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEWrite2DRingDictionaryReport(filename: str, rtd: OE2DRingDictionary,
                                       opts: OEReportOptions) -> bool
         OEWrite2DRingDictionaryReport(os: oeostream, extension: str,
                                       rtd: OE2DRingDictionary,
                                       opts: OEReportOptions) -> bool

   Writes a report of the 2D ring layouts stored in the given
   ring dictionary.
   See example in :ref:`Table Example of ring dictionary report<table_OEWrite2DRingDictionaryReport>`.

   *filename*
      The filename into which the report is written.
      The file extension determines the type of the multi-page image.

   *os*
      The stream into which the report is written.

   *ext*
      The extension which determine the type of the multi-page report.

   **ringdict**
      The :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` object that stores ring
      2D layouts that can be used to plug into the 2D coordinate
      generation system.

   **opts**
      The :ref:`OEReportOptions <OEDepict_OEReportOptions>` object that determines the layout
      of the pages of the report.

   The report depicts each ring systems stored in the ring dictionary.

   * The string at the top is the :term:`canonical isomeric SMILES` that is used as the identifier for the given ring system.
   * The larger depiction on the left shows the user-defined layout of the ring system
   * The smaller depiction on the right illustrates the default layout of the ring system *i.e.* when
     the 2D coordinates are generated by **OEChem TK** without utilizing the given user-defined ring
     dictionary.

     - The blue box indicates that **OEChem TK** has already have a built-in layout for
       the given ring system.
     - The pink box indicates that the layout of that ring system would be generated on the fly by default
       without utilizing any built-in templates.

   * There are cases when cis/trans bonds are marked on the macro-cycles depicted inside the blue/pink boxes.
     These annotations indicate potential depiction problem in **OEChem TK**.

   .. _table_OEWrite2DRingDictionaryReport:

   .. list-table:: **Example of ring dictionary report** (The pages are reduced here for visualization convenience)

      * - cover page
        - page 1
        - page 2

      * -  .. image:: ../images/rtd-example-report-1.*
        -  .. image:: ../images/rtd-example-report-2.*
        -  .. image:: ../images/rtd-example-report-3.*

   .. seealso::

      * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
      * :oe:func:`OEDepict::OEAnnotateDepictionProblems` function
      * :ref:`section_example_oechem_2D_coordinate_generation` section of
        the **OEChem TK** manual that shows examples about how to generate and
        utilize user-defined ring dictionaries.





.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEWriteImage

.. _OEDepict_OEWriteImage:

.. oe:function:: OEWriteImage

   .. list-table:: **The overloaded versions of the OEWriteImage function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OEWriteImage(filename, image)<api_OEWriteImage_fname_image>`
        - writes image into file

      * - :ref:`OEWriteImage(stream, ext, image)<api_OEWriteImage_stream_ext_image>`
        - writes image into output stream

.. _api_OEWriteImage_fname_image:

   .. oe:api::

      bool OEWriteImage(const std::string& filename, const OEImage& image)

   Writes the image into a file with the given name.

   *filename*
      The name of the file into which the image is written.
      The extension of the filename determine the type of the image.

   *image*
      The :ref:`OEImage <OEDepict_OEImage>` object which is being written
      into the given file.

   .. seealso::

      * :oe:func:`OEDepict::OEIsRegisteredImageFile` function

   .. ################################################################

.. _api_OEWriteImage_stream_ext_image:

   .. oe:api::

      bool OEWriteImage(OEPlatform::oeostream& os, const std::string& ext,
                        const OEImage& image)

   Writes the image into the given output stream.

   *os*
      The stream into which the image is written.

   *ext*
      The extension which determine the type of the image.

   *image*
      The :ref:`OEImage <OEDepict_OEImage>` object which is being written
      into the stream.

   .. seealso::

      * :oe:func:`OEDepict::OEIsRegisteredImageFile` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEWriteImageToBytes

.. _OEDepict_OEWriteImageToBytes:

.. oe:function:: OEWriteImageToBytes

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEWriteImageToBytes(ext: str, image: OEImage) -> bytes

   .. oe:language:: python

      .. oe:api:: python

         OEWriteImageToBytes(extension: str, image: OEImage) -> bytes

   Same as the :oe:func:`OEDepict::OEWriteImageToString` function.



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEWriteImageToString

.. _OEDepict_OEWriteImageToString:

.. oe:function:: OEWriteImageToString

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEWriteImageToString(const std::string& ext,
                                          const OEImage& image)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteImageToString(extension: str, image: OEImage) -> bytes

   Writes the image into a string.

   *ext*
      The extension which determine the type of the image.

   *image*
      The :ref:`OEImage <OEDepict_OEImage>` object which is being written
      into the string.

   **Example:**

   .. oe:source:: WriteImageToString.py
      :language: python
      :noindent:
      :frag:     SNIPPET-WRITE-IMAGE-TO-STRING

   .. oe:source:: WriteImageToString.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-WRITE-IMAGE-TO-STRING

   .. oe:source:: WriteImageToString.java
      :language: java
      :noindent:
      :frag:     SNIPPET-WRITE-IMAGE-TO-STRING

   .. oe:source:: WriteImageToString.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-WRITE-IMAGE-TO-STRING

   .. oe:language:: python

      .. note::

         In **Python 3** the :oe:func:`OEDepict::OEWriteImageToString`
         function returns ``bytes``.

   .. seealso::

      * :oe:func:`OEDepict::OEIsRegisteredImageFile` function

      .. oe:language:: python

         * :oe:func:`OEDepict::OEWriteImageToBytes` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEWriteMultiPageImage

.. _OEDepict_OEWriteMultiPageImage:

.. oe:function:: OEWriteMultiPageImage

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteMultiPageImage(const std::string& filename,
                                    const OEMultiPageImageFile& image)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteMultiPageImage(filename: str, image: OEMultiPageImageFile) -> bool

   Writes the multi-page image into a file with the given name.

   *filename*
      The name of the file into which the image is written.
      The extension of the filename determine the type of the image.

   *image*
      The :ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` object which is
      being written into the given file.

   .. seealso::

      * :oe:func:`OEDepict::OEIsRegisteredMultiPageImageFile` function

   .. ################################################################

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteMultiPageImage(OEPlatform::oeostream& os,
                                    const std::string& extension,
                                    const OEMultiPageImageFile& image)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteMultiPageImage(os: oeostream, extension: str,
                               image: OEMultiPageImageFile) -> bool

   Writes the multi-page image into the given output stream.

   *os*
      The stream into which the multi-page image is written.

   *ext*
      The extension which determine the type of the image.

   *image*
      The :ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` object which is
      being written into the stream.

   .. seealso::

      * :oe:func:`OEDepict::OEIsRegisteredMultiPageImageFile` function




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEWriteReport

.. _OEDepict_OEWriteReport:

.. oe:function:: OEWriteReport

   .. list-table:: **The overloaded versions of the OEWriteReport function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OEWriteReport(filename, report)<api_OEWriteReport_fname_report>`
        - writes report into file

      * - :ref:`OEWriteReport(stream, ext, report)<api_OEWriteReport_stream_ext_report>`
        - writes report into output stream

.. _api_OEWriteReport_fname_report:

   .. oe:api::

      bool OEWriteReport(const std::string& filename, const OEReport& report,
                         unsigned int page = 0u)

   Writes page(s) of the report into a file with the given name.

   *filename*
      The filename into which the page(s) of the report are written.
      The file extension determines the type of the multi-page image.

   *report*
      The :ref:`OEReport <OEDepict_OEReport>` object of which page(s) is/are
      being written into the given file.

   *pageidx*
      This value has to be in the range from `0` to
      :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`.

   .. note::

      If :math:`pageidx` is a valid page number *i.e* in the range from `1` to
      :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`,
      then only the :math:`pageidx^{th}` page of the report is written into the
      file.
      If :math:`pageidx` is zero and the file extension is recognized as a multi-page
      format, than all pages of the report are written into the file.

   .. seealso::

      * :oe:func:`OEDepict::OEIsRegisteredImageFile` function
      * :oe:func:`OEDepict::OEIsRegisteredMultiPageImageFile` function

   .. ################################################################

.. _api_OEWriteReport_stream_ext_report:

   .. oe:api::

      bool OEWriteReport(OEPlatform::oeostream& os,
                         const std::string& extension, const OEReport& report,
                         unsigned int page = 0u)

   Writes page(s) of the report into the given stream.

   *os*
      The stream into which the page(s) of the report are written.

   *ext*
      The extension which determine the type of the image.

   *report*
      The :ref:`OEReport <OEDepict_OEReport>` object of which page(s) is/are
      being written into the given file.

   *pageidx*
      This value has to be in the range from `0` to
      :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`.

   .. note::

      If :math:`pageidx` is a valid page number *i.e* in the range from `1` to
      :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`,
      then only the :math:`pageidx^{th}` page of the report is written into the
      stream.
      If :math:`pageidx` is zero and the file extension is recognized as a multi-page
      format, than all pages of the report are written into the stream.

   .. seealso::

      * :oe:func:`OEDepict::OEIsRegisteredImageFile` function
      * :oe:func:`OEDepict::OEIsRegisteredMultiPageImageFile` function
      * :oe:func:`OEDepict::OEWriteReportPageByPage` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEWriteReportPageByPage

.. _OEDepict_OEWriteReportPageByPage:

.. oe:function:: OEWriteReportPageByPage

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteReportPageByPage(const std::string& filename,
                                      const OEReport& report)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteReportPageByPage(filename: str, report: OEReport) -> bool

   A convenient function that writes pages of the report into the
   separate numbered files.

   *filename*
      The filename that serves as a prefix to write the report page by page.
      For example, if filename ``test.svg`` is given, the pages of the report
      will be written page by page into files: ``test-01.svg``, ``test-02.svg``
      ...
      The extension of file determines the type of the image.
 
   *report*
      The :ref:`OEReport <OEDepict_OEReport>` object of which pages are
      being written into the separate files.

   .. seealso::

      * :oe:func:`OEDepict::OEIsRegisteredImageFile` function
      * :oe:func:`OEDepict::OEIsRegisteredMultiPageImageFile` function
      * :oe:func:`OEDepict::OEWriteReport` function



.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEWriteReportToBytes

.. _OEDepict_OEWriteReportToBytes:

.. oe:function:: OEWriteReportToBytes

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEWriteReportToBytes(ext: str, report: OEReport) -> bytes

   .. oe:language:: python

      .. oe:api:: python

         OEWriteReportToBytes(extension: str, report: OEReport, page: int = 0) -> bytes

   Same as the :oe:func:`OEDepict::OEWriteReportToString` function.




.. |Bezier|    replace:: Bézier



.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEWriteReportToString

.. _OEDepict_OEWriteReportToString:

.. oe:function:: OEWriteReportToString

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEWriteReportToString(const std::string& ext,
                                           const OEReport& report,
                                           unsigned int page = 0u)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteReportToString(extension: str, report: OEReport, page: int = 0) -> bytes

   Writes the report into a string.

   *ext*
      The extension which determine the type of the image.

   *report*
      The :ref:`OEReport <OEDepict_OEReport>` object of which page(s) is/are
      being written into the string.

   *pageidx*
      This value has to be in the range from `0` to
      :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`.

   .. note::

      If :math:`pageidx` is a valid page number *i.e* in the range from `1` to
      :oe:meth:`OEDepict::OEReport::NumPages()<OEDepict::OEReport::NumPages>`,
      then only the :math:`pageidx^{th}` page of the report is written into the
      string.
      If :math:`pageidx` is zero and the file extension is recognized as a multi-page
      format, than all pages of the report are written into the string.

   **Example:**

   .. oe:source:: WriteReportToString.py
      :language: python
      :noindent:
      :frag:     SNIPPET-WRITE-REPORT-TO-STRING

   .. oe:source:: WriteReportToString.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-WRITE-REPORT-TO-STRING

   .. oe:source:: WriteReportToString.java
      :language: java
      :noindent:
      :frag:     SNIPPET-WRITE-REPORT-TO-STRING

   .. oe:source:: WriteReportToString.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-WRITE-REPORT-TO-STRING

   .. oe:language:: python

      .. note::

         In **Python 3** the :oe:func:`OEDepict::OEWriteReportToString`
         function returns ``bytes``.

   .. seealso::

      * :oe:func:`OEDepict::OEIsRegisteredMultiPageImageFile` function

      .. oe:language:: python

         * :oe:func:`OEDepict::OEWriteReportToBytes` function


*******************************************************************************
OEDepict Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEAddBuiltInHiddenSVGClass.rst
   OEAddBuiltInVisibleSVGClass.rst
   OEAddDepictionHydrogens.rst
   OEAddHighlighting.rst
   OEAddHighlightOverlay.rst
   OEAddInteractiveIcon.rst
   OEAddLabel.rst
   OEAddOpenEyeIcon.rst
   OEAddSVGClickEvent.rst
   OEAddSVGHover.rst
   OEAddSVGToggle.rst
   OEAddWatermark.rst
   OEAnnotateDepictionProblems.rst
   OEAnnotateValenceProblems.rst
   OEConfigure2DMolDisplayOptions.rst
   OEConfigureColor.rst
   OEConfigureHighlightColor.rst
   OEConfigureHighlightParams.rst
   OEConfigureHighlightStyle.rst
   OEConfigureImageGridNumColumns.rst
   OEConfigureImageGridNumRows.rst
   OEConfigureImageGridParams.rst
   OEConfigureImageHeight.rst
   OEConfigureImageOptions.rst
   OEConfigureImageWidth.rst
   OEConfigureMultiPageOrientation.rst
   OEConfigureMultiPageParams.rst
   OEConfigureMultiPageSize.rst
   OEConfigurePrepareDepictionOptions.rst
   OEConfigureReportOptions.rst
   OECreateWin32GraphicsImage.rst
   OEDepictCoordinates.rst
   OEDepictGetArch.rst
   OEDepictGetLicensee.rst
   OEDepictGetPlatform.rst
   OEDepictGetRelease.rst
   OEDepictGetSite.rst
   OEDepictGetVersion.rst
   OEDepictIsLicensed.rst
   OEDrawBorder.rst
   OEDrawChevronArrow.rst
   OEDrawCurvedArrow.rst
   OEDrawCurvedBorder.rst
   OEDrawCurvedRectangle.rst
   OEDrawEquilibriumArrow.rst
   OEDrawHighlighting.rst
   OEDrawLegendLayout.rst
   OEDrawReactionArrow.rst
   OEDrawResonanceArrow.rst
   OEDrawSVGHoverText.rst
   OEDrawSVGToggleText.rst
   OEDrawText.rst
   OEDrawTextToCenter.rst
   OEEstimateTextWidth.rst
   OEGetAverageBondLengthInDispCoords.rst
   OEGetBuiltInHiddenSVGClass.rst
   OEGetBuiltInVisibleSVGClass.rst
   OEGetCenter.rst
   OEGetColor.rst
   OEGetDefaultAtomColor.rst
   OEGetDisplayCoords.rst
   OEGetHighlightColor.rst
   OEGetHighlightStyle.rst
   OEGetImageGridNumColumns.rst
   OEGetImageGridNumRows.rst
   OEGetImageHeight.rst
   OEGetImageWidth.rst
   OEGetLabelPosition.rst
   OEGetMoleculeCoords.rst
   OEGetMoleculeScale.rst
   OEGetMultiPageOrientation.rst
   OEGetMultiPageSize.rst
   OEGetNearbyAtom.rst
   OEGetNearbyBond.rst
   OEGetNearestAtom.rst
   OEGetNearestBond.rst
   OEGetPageHeight.rst
   OEGetPageWidth.rst
   OEGetSupportedImageFileExtensions.rst
   OEGetSupportedMultiPageImageFileExtensions.rst
   OEHasDepictionHydrogens.rst
   OEIsRegisteredImageFile.rst
   OEIsRegisteredMultiPageImageFile.rst
   OEIsValidSVGClassName.rst
   OEIsValidSVGGroupId.rst
   OELengthenVector.rst
   OEOffsetMolDisplay.rst
   OEPrepareAlignedDepiction.rst
   OEPrepareDepiction.rst
   OEPrepareMultiAlignedDepiction.rst
   OEReduceFontSizeToFit.rst
   OERegisterImageFile.rst
   OERenderMolecule.rst

.. oe:language:: python

   .. toctree::
      :maxdepth: 1

      OERenderMoleculeToBytes.rst

.. toctree::
   :maxdepth: 1

   OERenderMoleculeToString.rst
   OERotateVector.rst
   OESetup2DMolDisplayOptions.rst
   OESetupPrepareDepictionOptions.rst
   OESetupReportOptions.rst
   OESuppressNonDepictionHydrogens.rst
   OEWrite2DRingDictionaryReport.rst
   OEWriteImage.rst

.. oe:language:: python

   .. toctree::
      :maxdepth: 1

      OEWriteImageToBytes.rst

.. toctree::
   :maxdepth: 1

   OEWriteImageToString.rst
   OEWriteMultiPageImage.rst
   OEWriteReport.rst
   OEWriteReportPageByPage.rst

.. oe:language:: python

   .. toctree::
      :maxdepth: 1

      OEWriteReportToBytes.rst

.. toctree::
   :maxdepth: 1

   OEWriteReportToString.rst


.. _oedepict_part_api:

*********************************
API
*********************************

.. toctree::
   :maxdepth: 2

   OEDepictClasses/OEDepictClasses
   OEDepictConstants/OEDepictConstants
   OEDepictFunctions/index


.. _oedepict_part_appendices:

*********************************
Appendices
*********************************

.. toctree::
   :maxdepth: 2

   elementcolor


.. _chapter_element_color:

********************************************************************************
Appendix: Element coloring (CPK)
********************************************************************************

The following two images show the default colors associated with various elements
when using the :oe:const:`OEDepict::OEAtomColorStyle::WhiteCPK` style.
 

.. figure:: depicttk/images/PeriodicTable-WhiteCPK.*
   :align:  center

   **Default CPK colors for white background**

.. figure:: depicttk/images/PeriodicTable-WhiteCPK-Example.*
   :align:  center

   **Example of molecule depiction with default CPK colors in a white background**

The following two images show the default colors associated with various elements
when using the :oe:const:`OEDepict::OEAtomColorStyle::BlackCPK` style.

.. figure:: depicttk/images/PeriodicTable-BlackCPK.*
   :align:  center

   **Default CPK colors for black background**

.. figure:: depicttk/images/PeriodicTable-BlackCPK-Example.*
   :align:  center

   **Example of molecule depiction with default CPK colors in a black background**


.. _chapter_basic:

********************************************************************************
Basic Drawing Primitives
********************************************************************************

The following example introduces how an image can be created in
**OEDepict TK** to generate a single black line across an image:

#. Create an :ref:`OEImage <OEDepict_OEImage>` object
   with a specific width and height.

#. Specify the two end points of the line with :ref:`OE2DPoint <OEDepict_OE2DPoint>` objects.

#. Draw the line with the
   :oe:meth:`OEDepict::OEImage::DrawLine` method using the :oe:const:`OEDepict::OEDepict::OEBlackPen` to specify the
   graphical properties of the line.

#. Write the image into a file by calling the
   :oe:func:`OEDepict::OEWriteImage` function.

   The :ref:`OEImage <OEDepict_OEImage>` class is implemented as a container of
   drawing commands. When a method such as :oe:meth:`OEDepict::OEImage::DrawLine`
   is called, rather than immediately drawing the line specified by the parameters,
   a line drawing operation is created in the :ref:`OEImage <OEDepict_OEImage>` class
   for later execution.

.. oe:source:: DrawLine.py
   :language: python
   :refnum:   1
   :caption:  Example of line drawing
   :frag:     SNIPPET-DRAW-LINE

.. oe:source:: DrawLine.cpp
   :language: c++
   :refnum:   1
   :caption:  Example of line drawing
   :frag:     SNIPPET-DRAW-LINE

.. oe:source:: DrawLine.java
   :language: java
   :refnum:   1
   :caption:  Example of line drawing
   :frag:     SNIPPET-DRAW-LINE

.. oe:source:: DrawLine.cs
   :language: csharp
   :refnum:   1
   :caption:  Example of line drawing
   :frag:     SNIPPET-DRAW-LINE

The image created by :oe:src:`Listing 1<SNIPPET-DRAW-LINE-DrawLine>` is shown in
:ref:`Figure: Example of line drawing<figure_basic_line_drawing>`.

.. _figure_basic_line_drawing:

.. figure:: depicttk/images/DrawLine.*
   :align:  center

   **Example of line drawing**

.. seealso::

   * :ref:`OEPen <OEDepict_OEPen>` class
   * :ref:`OEImage <OEDepict_OEImage>` class
   * :oe:func:`OEDepict::OEWriteImage` function

Coordinate System
================================================================================

The coordinate system used in **OEDepict TK** has the origin (x=0.0, y=0.0) at the
top left with the x-axis pointing to the right and the y-axis pointing down.

.. figure:: depicttk/images/CoordinateXY.*
   :align:  center

   **2D coordinate system** *(X = horizontal, Y = vertical)*

.. seealso::

   * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class

Basic Shapes
================================================================================

**OEDepict TK** supports drawing the following basic shapes:

   .. list-table::
      :widths: 100 100 100
      :header-rows: 0

      * - :oe:meth:`OEDepict::OEImageBase::DrawArc`
        - :oe:meth:`OEDepict::OEImageBase::DrawCircle`
        - :oe:meth:`OEDepict::OEImageBase::DrawCubicBezier`

      * - .. image:: images/OEImageBase-DrawArc.*
             :align:  center
        - .. image:: images/OEImageBase-DrawCircle.*
             :align:  center
        - .. image:: images/OEImageBase-DrawCubicBezier.*
             :align:  center

      * - :oe:meth:`OEDepict::OEImageBase::DrawLine`
        - :oe:meth:`OEDepict::OEImageBase::DrawPath`
        - :oe:meth:`OEDepict::OEImageBase::DrawPie`

      * - .. image:: images/OEImageBase-DrawLine.*
             :align:  center
        - .. image:: images/OEImageBase-DrawPath.*
             :align:  center
        - .. image:: images/OEImageBase-DrawPie.*
             :align:  center

      * - :oe:meth:`OEDepict::OEImageBase::DrawPoint`
        - :oe:meth:`OEDepict::OEImageBase::DrawPolygon`
        - :oe:meth:`OEDepict::OEImageBase::DrawQuadraticBezier`

      * - .. image:: images/OEImageBase-DrawPoint.*
             :align:  center
        - .. image:: images/OEImageBase-DrawPolygon.*
             :align:  center
        - .. image:: images/OEImageBase-DrawQuadraticBezier.*
             :align:  center

      * - :oe:meth:`OEDepict::OEImageBase::DrawRectangle`
        - :oe:meth:`OEDepict::OEImageBase::DrawText`
        - :oe:meth:`OEDepict::OEImageBase::DrawTriangle`

      * - .. image:: images/OEImageBase-DrawRectangle.*
             :align:  center
        - .. image:: images/OEImageBase-DrawText.*
             :align:  center
        - .. image:: images/OEImageBase-DrawTriangle.*
             :align:  center

Image File Formats
================================================================================

**OEDepict TK** natively supports a variety of graphical file
formats. :oe:func:`OEDepict::OEWriteImage` automatically detects the
desired file format from the file name passed to the function. The
following table lists the file formats natively supported
in **OEDepict TK** and their associated file extensions:

====================================== ===================== ============================
Graphics File Format                   Format Type           File Extension
====================================== ===================== ============================
PNG (Portable Network Graphics)        :term:`raster image`  :file:`.png`
:term:`SVG` (Scalable Vector Graphics) :term:`vector image`  :file:`.svg`
*bare* :term:`SVG` (with no header)    :term:`vector image`  :file:`.bsvg`
Postscript                             :term:`vector image`  :file:`.ps`
Encapsulated PostScript                :term:`vector image`  :file:`.eps`
PDF (Portable Document Format)         :term:`vector image`  :file:`.pdf`
====================================== ===================== ============================

The :oe:func:`OEDepict::OEIsRegisteredImageFile` function can be used
to query whether a given file extension is supported by **OEDepict TK**.
All the supported file formats can be queried using
the :oe:func:`OEDepict::OEGetSupportedImageFileExtensions` function.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. _oedepict_chapter_cookbook_examples:

********************************************************************************
Python Cookbook Examples
********************************************************************************

There are large number of code examples available in
`OpenEye Python Cookbook <http://docs.eyesopen.com/python_modules/cookbook/index.html>`_
that use **OpenEye Toolkits** to solve a wide range of cheminformatics and molecular
modeling problems.

* `2D Depiction <http://docs.eyesopen.com/python_modules/cookbook/depiction/depiction.html>`_ chapter
  contains examples that illustrate how the **OEDepict TK** and **Grapheme TK** can be
  utilized to depict molecules and visualize properties calculated with other OpenEye toolkits.

* `Visualizing 3D Information <http://docs.eyesopen.com/python_modules/cookbook/visualization/visualization.html>`_
  chapter contains examples that illustrate how the **Grapheme TK** can be utilized to project
  complex 3D information into the 2D molecular graph.

* `Cheminformatics <https://docs.eyesopen.com/python_modules/cookbook/cheminfo/cheminfo.html>`_
  chapter contains examples that solve various cheminformatics problems such as similarity search,
  ring perception and manipulating molecular graphs.

* `Peptide Informatics <https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptideinfo.html>`_
  chapter contains examples that solve various peptide informatics problems such as generating custom monomer sets,
  parsing and generating :term:`HELM` representations, and visualizing peptides.


.. admonition:: OpenEye Python Cookbook examples using OEDepict TK

   * `Depicting Reaction Components`_
   * `Depicting Multiple Matches`_
   * `Depicting Library Generation`_
   * `Depicting Molecular Graph Symmetry`_
   * `Highlighting Fragments`_



.. _oedepict_part_examples:

*********************************
Examples
*********************************

.. toctree::
   :maxdepth: 2

   examples_summary
   cookbook-examples


.. _oedepict_chapter_examples_summary:

*************************
OEDepict Examples
*************************

The following table lists the currently available **OEDepict TK** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`depict<section_examples_summary_depict>`
        - Generating 2D coordinates

      * - :ref:`match2img<section_examples_summary_match2img>`
        - Depicting substructure search match

      * - :ref:`mcsalign2D<section_examples_summary_mcsalign2D>`
        - Aligning molecules based on MCS

      * - :ref:`mdlquery2img<section_examples_summary_mdlquery2img>`
        - Depicting MDL query

      * - :ref:`mdlreaction2img<section_examples_summary_mdlreaction2img>`
        - Depicting MDL reaction

      * - :ref:`mol2img<section_examples_summary_mol2img>`
        - Depicting a single molecule

      * - :ref:`mols2pdf<section_examples_summary_mols2pdf>`
        - Depicting molecules in a multi-page image

      * - :ref:`mols2img<section_examples_summary_mols2img>`
        - Depicting molecules in a grid

      * - :ref:`ringdict2pdf<section_examples_summary_ringdict2pdf>`
        - Denerating 2D ring dictionary report

      * - :ref:`smartsalign2D<section_examples_summary_smartsalign2D>`
        - Aligning molecules based on substructure search

      * - :ref:`viewmdlsearch<section_examples_summary_viewmdlsearch>`
        - Depicting MDL query substructure search hits

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`depict.py<section_examples_summary_depict>`
        - Generating 2D coordinates.

      * - :ref:`match2img.py<section_examples_summary_match2img>`
        - Depicting substructure search match.

      * - :ref:`mcsalign2D.py<section_examples_summary_mcsalign2D>`
        - Aligning molecules based on MCS.

      * - :ref:`mdlquery2img.py<section_examples_summary_mdlquery2img>`
        - Depicting MDL query.

      * - :ref:`mdlreaction2img.py<section_examples_summary_mdlreaction2img>`
        - Depicting MDL reaction.

      * - :ref:`mol2img.py<section_examples_summary_mol2img>`
        - Depicting a single molecule.

      * - :ref:`mols2pdf.py<section_examples_summary_mols2pdf>`
        - Depicting molecules in a multi-page image.

      * - :ref:`mols2img.py<section_examples_summary_mols2img>`
        - Depicting molecules in a grid.

      * - :ref:`ringdict2pdf.py<section_examples_summary_ringdict2pdf>`
        - Denerating 2D ring dictionary report.

      * - :ref:`smartsalign2D.py<section_examples_summary_smartsalign2D>`
        - Aligning molecules based on substructure search.

      * - :ref:`viewmdlsearch.py<section_examples_summary_viewmdlsearch>`
        - Depicting MDL query substructure search hits.

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`Depict<section_examples_summary_depict>`
        - generating 2D coordinates

      * - :ref:`Match2Img<section_examples_summary_match2img>`
        - depicting substructure search match

      * - :ref:`MCSAlign2D<section_examples_summary_mcsalign2D>`
        - aligning molecules based on MCS

      * - :ref:`MDLQuery2Img<section_examples_summary_mdlquery2img>`
        - depicting MDL query

      * - :ref:`MDLReaction2Img<section_examples_summary_mdlreaction2img>`
        - depicting MDL reaction

      * - :ref:`Mol2Img<section_examples_summary_mol2img>`
        - depicting a single molecule

      * - :ref:`Mols2PDF<section_examples_summary_mols2pdf>`
        - depicting molecules in a multi-page image

      * - :ref:`Mols2Img<section_examples_summary_mols2img>`
        - depicting molecules in a grid

      * - :ref:`RingDict2PDF<section_examples_summary_ringdict2pdf>`
        - generating 2D ring dictionary report

      * - :ref:`SMARTSAlign2D<section_examples_summary_smartsalign2D>`
        - aligning molecules based on substructure search

      * - :ref:`ViewMDLSearch<section_examples_summary_viewmdlsearch>`
        - depicting MDL query substructure search hits

**Examples:**

.. toctree::
   :maxdepth: 1

   examples_summary_depict
   examples_summary_match2img
   examples_summary_mcsalign2D
   examples_summary_mdlquery2img
   examples_summary_mdlreaction2img
   examples_summary_mol2img
   examples_summary_mols2img
   examples_summary_mols2pdf
   examples_summary_ringdict2pdf
   examples_summary_smartsalign2D
   examples_summary_viewmdlsearch

.. oe:language:: java

   ..   Using OEJavaImageBase to render images
   ..   ================================================================================

   The following Java example demonstrates the usage of :ref:`OEJavaImageBase <OEDepict_OEJavaImageBase>`
   class.

   .. admonition:: Download code

      :download:`JavaImageBase.java <../../../../wrappers/java/examples/openeye/docexamples/oedepict/JavaImageBase.java>`


.. _section_examples_summary_depict:

Generating 2D coordinates
=========================

A program that assigns 2D coordinates to molecule(s).

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> depict --help

.. oe:language:: python

   .. code-block:: console

      prompt> python depict.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java Depict --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> Depict --help

will generate the following output:

.. code-block:: console

   Simple parameter list
   input/output options :
      -in : Input filename
      -out : Output filename
      -ringdict : User-defined 2D ring dictionary

    prepare depiction options :
      -orientation : Set the preferred orientation of 2D coordinates
      -suppressH : Suppress explicit hydrogens of molecule(s)

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`depict.cpp <../../../../sublibs/tklibs/depict/examples/depict.cpp>`
         and
         :download:`depict.txt <../../../../sublibs/tklibs/depict/examples/depict.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: depict.cpp
         :language: c++

      with interface file

      .. oe:source:: depict.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`depict.py <../../../../wrappers/python/examples/depict/depict.py>`

      .. literalinclude:: ../../../wrappers/python/examples/depict/depict.py

   .. only:: oepdf

      .. oe:source:: depict.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Depict.java <../../../../wrappers/java/examples/openeye/examples/oedepict/Depict.java>`
         and
         :download:`Depict.txt <../../../../wrappers/java/examples/openeye/examples/oedepict/Depict.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: Depict.java
         :language: java

      with interface file

      .. oe:source:: Depict.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Depict.cs <../../../../wrappers/csharp/Csharp-Examples/OEDepict/Depict.cs>`

   .. only:: oepdf

      .. oe:source:: Depict.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEDepict::OEConfigurePrepareDepictionOptions` function
   * :oe:func:`OEChem::OEIs2DFormat` function
   * :ref:`OEPrepareDepictionOptions <OEDepict_OEPrepareDepictionOptions>` class
   * :oe:func:`OEDepict::OESetupPrepareDepictionOptions` function
   * :oe:func:`OEDepict::OEPrepareDepiction` function

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> depict .ism .mol

      C(=O)N

.. oe:language:: python

   .. code-block:: console

      prompt> python depict.py .ism .mol

      C(=O)N

.. oe:language:: java

   .. code-block:: console

      prompt> java Depict .ism .mol

      C(=O)N

.. oe:language:: csharp

   .. code-block:: console

      prompt> Depict .ism .mol

      C(=O)N

will generate the following output:

::

     -OEChem-07031123462D

     3  2  0     0  0  0  0  0  0999 V2000
       0.0000    0.0000    0.0000 C   0  0  0  0  0  0  0  0  0  0  0  0
       1.0000    0.0000    0.0000 O   0  0  0  0  0  0  0  0  0  0  0  0
      -0.5000   -0.8660    0.0000 N   0  0  0  0  0  0  0  0  0  0  0  0
     1  2  2  0  0  0  0
     1  3  1  0  0  0  0
   M  END

.. note::

   The above program can generate 2D coordinates with user-defined 2D ring layouts when using the
   **-ringdict** parameter.

   See also the :ref:`section_example_oechem_2D_coordinate_generation` section of
   the **OEChem TK** manual that shows examples about how to generate and
   utilize user-defined ring dictionaries.


.. _section_examples_summary_match2img:

Depicting Substructure Search Match
================================================================================

A program that performs a substructure search initialized
with the given SMARTS pattern and highlights the identified
matches on the depicted molecule.

Command Line Interface
--------------------------------------------------------------------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> match2img --help

.. oe:language:: python

   .. code-block:: console

      prompt> python match2img.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java Match2Img --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> Match2Img --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    highlight options :
      -highlightcolor : Highlighting color
      -highlightstyle : Highlighting style

    image options :
      -height : Height of output image
      -width : Width of output image

    input/output options :
      -in : Input filename
      -out : Output filename
      -smarts : SMARTS pattern

    molecule display options :
      -aromstyle : Aromatic ring display style
      -atomcolor : Atom coloring style
      -atomlabelfontscale : Atom label font scale
      -atomprop : Atom property display
      -atomstereostyle : Atom stereo display style
      -bondcolor : Bond coloring style
      -bondprop : Bond property display
      -bondstereostyle : Bond stereo display style
      -hydrstyle : Hydrogen display style
      -linewidth : Default bond line width
      -protgroupdisp : Protective group display style
      -scale : Scaling of the depicted molecule
      -superdisp : Super atom display style
      -titleloc : Location of the molecule title

    prepare depiction options :
      -clearcoords : Clear and regenerate 2D coordinates of molecule(s)
      -orientation : Set the preferred orientation of 2D coordinates
      -suppressH : Suppress explicit hydrogens of molecule(s)

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`match2img.cpp <../../../../sublibs/tklibs/depict/examples/match2img.cpp>`
         and
         :download:`match2img.txt <../../../../sublibs/tklibs/depict/examples/match2img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: match2img.cpp
         :language: c++

      with interface file

      .. oe:source:: match2img.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`match2img.py <../../../../wrappers/python/examples/depict/match2img.py>`

      .. literalinclude:: ../../../wrappers/python/examples/depict/match2img.py

   .. only:: oepdf

      .. oe:source:: match2img.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Match2Img.java <../../../../wrappers/java/examples/openeye/examples/oedepict/Match2Img.java>`
         and
         :download:`Match2Img.txt <../../../../wrappers/java/examples/openeye/examples/oedepict/Match2Img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: Match2Img.java
         :language: java

      with interface file

      .. oe:source:: Match2Img.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Match2Img.cs <../../../../wrappers/csharp/Csharp-Examples/OEDepict/Match2Img.cs>`

   .. only:: oepdf

      .. oe:source:: Match2Img.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEDepict::OEConfigureImageOptions` function
   * :oe:func:`OEDepict::OEConfigurePrepareDepictionOptions` function
   * :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function
   * :oe:func:`OEDepict::OEConfigureHighlightParams` function
   * :oe:func:`OEDepict::OESetup2DMolDisplayOptions` function
   * :ref:`OESubSearch <OEChem_OESubSearch>` class
   * :ref:`OEPrepareDepictionOptions <OEDepict_OEPrepareDepictionOptions>` class
   * :oe:func:`OEDepict::OESetupPrepareDepictionOptions` function
   * :oe:func:`OEDepict::OEPrepareDepiction` function
   * :oe:func:`OEDepict::OEGetImageWidth` and :oe:func:`OEDepict::OEGetImageHeight` functions
   * :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class
   * :oe:func:`OEDepict::OESetup2DMolDisplayOptions` function
   * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class
   * :oe:func:`OEDepict::OEGetHighlightStyle` and :oe:func:`OEDepict::OEGetHighlightColor` functions
   * :oe:func:`OEChem::OEPrepareSearch` function
   * :oe:func:`OEDepict::OEAddHighlighting` function
   * :oe:func:`OEDepict::OERenderMolecule` function

Examples
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> match2img -in indole.ism -out image.png -smarts "c1ccccc1"

.. oe:language:: python

   .. code-block:: console

      prompt> python match2img.py -in indole.ism -out image.png -smarts "c1ccccc1"

.. oe:language:: java

   .. code-block:: console

      prompt> java Match2Img -in indole.ism -out image.png -smarts "c1ccccc1"

.. oe:language:: csharp

   .. code-block:: console

      prompt> Match2Img -in indole.ism -out image.png -smarts "c1ccccc1"

will generate the image shown in
:ref:`Figure: Example of using the program with default highlighting<figure_match2img_01>`

.. _figure_match2img_01:

.. figure:: depicttk/images/match2img-01.*
   :align:  center

   **Example of using the program with default highlighting**

.. -----------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> match2img -in indole.ism -out image.png -smarts "c1ccccc1" -highlightcolor green

.. oe:language:: python

   .. code-block:: console

      prompt> python match2img.py -in indole.ism -out image.png -smarts "c1ccccc1" -highlightcolor green

.. oe:language:: java

   .. code-block:: console

      prompt> java Match2Img -in indole.ism -out image.png -smarts "c1ccccc1" -highlightcolor green

.. oe:language:: csharp

   .. code-block:: console

      prompt> Match2Img -in indole.ism -out image.png -smarts "c1ccccc1" -highlightcolor green

will generate the image shown in
:ref:`Figure: Example of using the program with green highlighting<figure_match2img_02>`

.. _figure_match2img_02:

.. figure:: depicttk/images/match2img-02.*
   :align:  center

   **Example of using the program with green highlighting**

.. -----------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> match2img -in indole.ism -out image.png -smarts "c1ccccc1" -highlightstyle BallAndStick

.. oe:language:: python

   .. code-block:: console

      prompt> python match2img.py -in indole.ism -out image.png -smarts "c1ccccc1" -highlightstyle BallAndStick

.. oe:language:: java

   .. code-block:: console

      prompt> java Match2Img -in indole.ism -out image.png -smarts "c1ccccc1" -highlightstyle BallAndStick

.. oe:language:: csharp

   .. code-block:: console

      prompt> Match2Img -in indole.ism -out image.png -smarts "c1ccccc1" -highlightstyle BallAndStick

will generate the image shown in
:ref:`Figure: Example of using the program with ball and stick<figure_match2img_03>`

.. _figure_match2img_03:

.. figure:: depicttk/images/match2img-03.*
   :align:  center

   **Example of using the program with ball and stick highlighting**

.. seealso::

   * :ref:`chapter_highlighting` chapter


.. _section_examples_summary_mcsalign2D:

Aligning Molecule Based on MCS
================================================================================

A program that aligns molecules based on their maximum common substructure.

Command Line Interface
--------------------------------------------------------------------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> mcsalign2D --help

.. oe:language:: python

   .. code-block:: console

      prompt> python mcsalign2D.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java MCSAlign2D --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> MCSAlign2D --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    input/output options :
      -fit : Align filename
      -out : Output filename
      -ref : Ref filename

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mcsalign2D.cpp <../../../../sublibs/tklibs/depict/examples/mcsalign2D.cpp>`
         and
         :download:`mcsalign2D.txt <../../../../sublibs/tklibs/depict/examples/mcsalign2D.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: mcsalign2D.cpp
         :language: c++

      with interface file

      .. oe:source:: mcsalign2D.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mcsalign2D.py <../../../../wrappers/python/examples/depict/mcsalign2D.py>`

      .. literalinclude:: ../../../wrappers/python/examples/depict/mcsalign2D.py

   .. only:: oepdf

      .. oe:source:: mcsalign2D.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MCSAlign2D.java <../../../../wrappers/java/examples/openeye/examples/oedepict/MCSAlign2D.java>`
         and
         :download:`MCSAlign2D.txt <../../../../wrappers/java/examples/openeye/examples/oedepict/MCSAlign2D.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: MCSAlign2D.java
         :language: java

      with interface file

      .. oe:source:: MCSAlign2D.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MCSAlign2D.cs <../../../../wrappers/csharp/Csharp-Examples/OEDepict/MCSAlign2D.cs>`

   .. only:: oepdf

      .. oe:source:: MCSAlign2D.cs
         :language: csharp

.. seealso::

   * :ref:`chapter_molalign` chapter

   * :oe:func:`OEChem::OEIs2DFormat` function
   * :oe:func:`OEDepict::OEPrepareDepiction` function
   * :ref:`OEMCSSearch <OEChem_OEMCSSearch>` class
   * :oe:func:`OEDepict::OEPrepareAlignedDepiction` function

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> mcsalign2D -ref ace1.ism -fit ace2.ism -out out.mol

.. oe:language:: python

   .. code-block:: console

      prompt> python mcsalign2D.py -ref ace1.ism -fit ace2.ism -out out.mol

.. oe:language:: java

   .. code-block:: console

      prompt> java MCSAlign2D -ref ace1.ism -fit ace2.ism -out out.mol

.. oe:language:: csharp

   .. code-block:: console

      prompt> MCSAlign2D -ref ace1.ism -fit ace2.ism -out out.mol

.. oe:language:: c++ python

   taking the output coordinates and generating the images with the
   **mol2img** program will produce the images shown in
   :ref:`Table: Example of using the program to align two molecules based on MCS <table_mcsalign2D>`.

.. oe:language:: java csharp

   taking the output coordinates and generating the images with the
   **Mol2Img** program will produce the images shown in
   :ref:`Table: Example of using the program to align two molecules based on MCS <table_mcsalign2D>`.

.. _table_mcsalign2D:

.. list-table:: Example of using the program to align two molecules based on MCS
   :widths: 100 100
   :header-rows: 1

   * - reference molecule
     - aligned molecule
   * - .. image:: images/mcsalign2D-out-ref.*
          :align:  center
     - .. image:: images/mcsalign2D-out-fit.*
          :align:  center

.. seealso::

   * :ref:`chapter_molalign` chapter


.. _section_examples_summary_mdlquery2img:

Depicting MDL Query
================================================================================

A program that converts an MDL query structure into an image file.

Command Line Interface
--------------------------------------------------------------------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> mdlquery2img --help

.. oe:language:: python

   .. code-block:: console

      prompt> python mdlquery2img.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java MDLQuery2Img --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> MDLQuery2Img --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    image options :
      -height : Height of output image
      -width : Width of output image

    input/output options :
      -in : Input filename
      -out : Output filename

    molecule display options :
      -aromstyle : Aromatic ring display style
      -atomcolor : Atom coloring style
      -atomlabelfontscale : Atom label font scale
      -atomprop : Atom property display
      -atomstereostyle : Atom stereo display style
      -bondcolor : Bond coloring style
      -bondprop : Bond property display
      -bondstereostyle : Bond stereo display style
      -hydrstyle : Hydrogen display style
      -linewidth : Default bond line width
      -protgroupdisp : Protective group display style
      -scale : Scaling of the depicted molecule
      -superdisp : Super atom display style
      -titleloc : Location of the molecule title

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mdlquery2img.cpp <../../../../sublibs/tklibs/depict/examples/mdlquery2img.cpp>`
         and
         :download:`mdlquery2img.txt <../../../../sublibs/tklibs/depict/examples/mdlquery2img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: mdlquery2img.cpp
         :language: c++

      with interface file

      .. oe:source:: mdlquery2img.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mdlquery2img.py <../../../../wrappers/python/examples/depict/mdlquery2img.py>`

      .. literalinclude:: ../../../wrappers/python/examples/depict/mdlquery2img.py

   .. only:: oepdf

      .. oe:source:: mdlquery2img.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MDLQuery2Img.java <../../../../wrappers/java/examples/openeye/examples/oedepict/MDLQuery2Img.java>`
         and
         :download:`MDLQuery2Img.txt <../../../../wrappers/java/examples/openeye/examples/oedepict/MDLQuery2Img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: MDLQuery2Img.java
         :language: java

      with interface file

      .. oe:source:: MDLQuery2Img.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MDLQuery2Img.cs <../../../../wrappers/csharp/Csharp-Examples/OEDepict/MDLQuery2Img.cs>`

   .. only:: oepdf

      .. oe:source:: MDLQuery2Img.cs
         :language: csharp

.. seealso::

   * :ref:`chapter_mdlquery` chapter

   * :oe:func:`OEDepict::OEConfigureImageOptions` function
   * :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function
   * :oe:func:`OEDepict::OEIsRegisteredImageFile` function
   * :oe:func:`OEChem::OEReadMDLQueryFile` function
   * :oe:func:`OEDepict::OEPrepareDepiction` function
   * :oe:func:`OEDepict::OEGetImageWidth` and :oe:func:`OEDepict::OEGetImageHeight` functions
   * :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class
   * :oe:func:`OEDepict::OESetup2DMolDisplayOptions` function
   * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class
   * :oe:func:`OEDepict::OERenderMolecule` function

Examples
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> mdlquery2img -in mdlquery.mol -out image.png

.. oe:language:: python

   .. code-block:: console

      prompt> python mdlquery2img.py -in mdlquery.mol -out image.png

.. oe:language:: java

   .. code-block:: console

      prompt> java MDLQuery2Img -in mdlquery.mol -out image.png

.. oe:language:: c++

   .. code-block:: console

      prompt> MDLQuery2Img -in mdlquery.mol -out image.png

will generate the image shown in
:ref:`Figure: Example of depicting an MDL query<figure_mdlquery2img>`

.. _figure_mdlquery2img:

.. figure:: depicttk/images/mdlquery2img-01.*
   :align:  center

   **Example of depicting an MDL query**

.. seealso::

  * :ref:`chapter_mdlquery` chapter


.. _section_examples_summary_mdlreaction2img:

Depicting MDL Reaction
================================================================================

A program that converts an MDL reaction into an image file.

Command Line Interface
--------------------------------------------------------------------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> mdlreaction2img --help

.. oe:language:: python

   .. code-block:: console

      prompt> python mdlreaction2img.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java MDLReaction2Img --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> MDLReaction2Img --help

will generate the following output:

.. code-block:: console

   Simple parameter list

    image options :
      -height : Height of output image
      -width : Width of output image

    input/output options :
      -in : Input filename
      -out : Output filename

    molecule display options :
      -aromstyle : Aromatic ring display style
      -atomcolor : Atom coloring style
      -atomlabelfontscale : Atom label font scale
      -atomprop : Atom property display
      -atomstereostyle : Atom stereo display style
      -bondcolor : Bond coloring style
      -bondprop : Bond property display
      -bondstereostyle : Bond stereo display style
      -hydrstyle : Hydrogen display style
      -linewidth : Default bond line width
      -protgroupdisp : Protective group display style
      -scale : Scaling of the depicted molecule
      -superdisp : Super atom display style
      -titleloc : Location of the molecule title

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mdlreaction2img.cpp <../../../../sublibs/tklibs/depict/examples/mdlreaction2img.cpp>`
         and
         :download:`mdlreaction2img.txt <../../../../sublibs/tklibs/depict/examples/mdlreaction2img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: mdlreaction2img.cpp
         :language: c++

      with interface file

      .. oe:source:: mdlreaction2img.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mdlreaction2img.py <../../../../wrappers/python/examples/depict/mdlreaction2img.py>`

      .. literalinclude:: ../../../wrappers/python/examples/depict/mdlreaction2img.py

   .. only:: oepdf

      .. oe:source:: mdlreaction2img.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MDLReaction2Img.java <../../../../wrappers/java/examples/openeye/examples/oedepict/MDLReaction2Img.java>`
         and
         :download:`MDLReaction2Img.txt <../../../../wrappers/java/examples/openeye/examples/oedepict/MDLReaction2Img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: MDLReaction2Img.java
         :language: java

      with interface file

      .. oe:source:: MDLReaction2Img.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MDLReaction2Img.cs <../../../../wrappers/csharp/Csharp-Examples/OEDepict/MDLReaction2Img.cs>`

   .. only:: oepdf

      .. oe:source:: MDLReaction2Img.cs
         :language: csharp

.. seealso::

   * :ref:`chapter_mdlreaction` chapter

   * :oe:func:`OEDepict::OEConfigureImageOptions` function
   * :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function
   * :oe:func:`OEDepict::OEIsRegisteredImageFile` function
   * :oe:func:`OEChem::OEReadMDLReactionQueryFile` function
   * :oe:func:`OEDepict::OEPrepareDepiction` function
   * :oe:func:`OEDepict::OEGetImageWidth` and :oe:func:`OEDepict::OEGetImageHeight` functions
   * :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class
   * :oe:func:`OEDepict::OESetup2DMolDisplayOptions` function
   * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class
   * :oe:func:`OEDepict::OERenderMolecule` function

Examples
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> mdlreaction2img -in mdlreaction.sdf -out image.png

.. oe:language:: python

   .. code-block:: console

      prompt> python mdlreaction2img.py -in mdlreaction.sdf -out image.png

.. oe:language:: java

   .. code-block:: console

      prompt> java MDLReaction2Img -in mdlreaction.sdf -out image.png

.. oe:language:: csharp

   .. code-block:: console

      prompt> MDLReaction2Img -in mdlreaction.sdf -out image.png

will generate the following image:
:ref:`Figure: Example of depicting an MDL reaction<figure_mdlreaction2img_1>`

.. _figure_mdlreaction2img_1:

.. figure:: depicttk/images/mdlreaction2img-01.*
   :align:  center

   **Example of depicting an MDL reaction**

.. -----------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> mdlreaction2img -in mdlreaction.sdf -out image.png -atomprop MapIdx

.. oe:language:: python

   .. code-block:: console

      prompt> python mdlreaction2img.py -in mdlreaction.sdf -out image.png -atomprop MapIdx

.. oe:language:: java

   .. code-block:: console

      prompt> java MDLReaction2img -in mdlreaction.sdf -out image.png -atomprop MapIdx

.. oe:language:: c++

   .. code-block:: console

      prompt> MDLReaction2Img -in mdlreaction.sdf -out image.png -atomprop MapIdx

will generate the following image:
:ref:`Figure: Example of depicting an MDL reaction with atom map indices<figure_mdlreaction2img_2>`

.. _figure_mdlreaction2img_2:

.. figure:: depicttk/images/mdlreaction2img-02.*
   :align:  center

   **Example of depicting an MDL reaction with atom map indices**

.. -----------------------------------------------------------------------------

.. seealso::

  * :ref:`chapter_mdlreaction` chapter


.. _section_examples_summary_mol2img:

Depicting a Single Molecule
================================================================================

A program that converts a molecular structure into an image file.

Command Line Interface
--------------------------------------------------------------------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> mol2img --help

.. oe:language:: python

   .. code-block:: console

      prompt> python mol2img.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java Mol2Img --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> Mol2Img --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    image options :
      -height : Height of output image
      -width : Width of output image

    input/output options :
      -in : Input filename
      -out : Output filename
      -ringdict : User-defined 2D ring dictionary

    molecule display options :
      -aromstyle : Aromatic ring display style
      -atomcolor : Atom coloring style
      -atomlabelfontscale : Atom label font scale
      -atomprop : Atom property display
      -atomstereostyle : Atom stereo display style
      -bondcolor : Bond coloring style
      -bondprop : Bond property display
      -bondstereostyle : Bond stereo display style
      -hydrstyle : Hydrogen display style
      -linewidth : Default bond line width
      -protgroupdisp : Protective group display style
      -scale : Scaling of the depicted molecule
      -superdisp : Super atom display style
      -titleloc : Location of the molecule title

    prepare depiction options :
      -clearcoords : Clear and regenerate 2D coordinates of molecule(s)
      -orientation : Set the preferred orientation of 2D coordinates
      -suppressH : Suppress explicit hydrogens of molecule(s)

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mol2img.cpp <../../../../sublibs/tklibs/depict/examples/mol2img.cpp>`
         and
         :download:`mol2img.txt <../../../../sublibs/tklibs/depict/examples/mol2img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: mol2img.cpp
         :language: c++

      with interface file

      .. oe:source:: mol2img.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mol2img.py <../../../../wrappers/python/examples/depict/mol2img.py>`

      .. literalinclude:: ../../../wrappers/python/examples/depict/mol2img.py

   .. only:: oepdf

      .. oe:source:: mol2img.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Mol2Img.java <../../../../wrappers/java/examples/openeye/examples/oedepict/Mol2Img.java>`
         and
         :download:`Mol2Img.txt <../../../../wrappers/java/examples/openeye/examples/oedepict/Mol2Img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: Mol2Img.java
         :language: java

      with interface file

      .. oe:source:: Mol2Img.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Mol2Img.cs <../../../../wrappers/csharp/Csharp-Examples/OEDepict/Mol2Img.cs>`

   .. only:: oepdf

      .. oe:source:: Mol2Img.cs
         :language: csharp

.. seealso::

   * :ref:`chapter_mol_display` chapter

   * :oe:func:`OEDepict::OEConfigureImageOptions` function
   * :oe:func:`OEDepict::OEConfigurePrepareDepictionOptions` function
   * :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function
   * :oe:func:`OEDepict::OEIsRegisteredImageFile` function
   * :ref:`OEPrepareDepictionOptions <OEDepict_OEPrepareDepictionOptions>` class
   * :oe:func:`OEDepict::OESetupPrepareDepictionOptions` function
   * :oe:func:`OEDepict::OEPrepareDepiction` function
   * :oe:func:`OEDepict::OEGetImageWidth` and :oe:func:`OEDepict::OEGetImageHeight` functions
   * :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class
   * :oe:func:`OEDepict::OESetup2DMolDisplayOptions` function
   * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class
   * :oe:func:`OEDepict::OERenderMolecule` function

Examples
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> mol2img -in nexium.ism -out image.png

.. oe:language:: python

   .. code-block:: console

      prompt> python mol2img.py -in nexium.ism -out image.png

.. oe:language:: java

   .. code-block:: console

      prompt> java Mol2Img -in nexium.ism -out image.png

.. oe:language:: csharp

   .. code-block:: console

      prompt> Mol2img -in nexium.ism -out image.png

will generate the image shown in
:ref:`Figure: Example of using the program with default parameters<figure_mol2img_01>`.

.. _figure_mol2img_01:

.. figure:: depicttk/images/mol2img-01.*
   :align:  center

   **Example of using the program with default parameters**

.. -----------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> mol2img -in nexium.ism -out image.png -atomcolor WhiteMonochrome

.. oe:language:: python

   .. code-block:: console

      prompt> python mol2img.py -in nexium.ism -out image.png -atomcolor WhiteMonochrome

.. oe:language:: java

   .. code-block:: console

      prompt> java Mol2Img -in nexium.ism -out image.png -atomcolor WhiteMonochrome

.. oe:language:: csharp

   .. code-block:: console

      prompt> Mol2Img -in nexium.ism -out image.png -atomcolor WhiteMonochrome

will generate the image shown in
:ref:`Figure: Example of using the program with the white monochrome atom coloring style<figure_mol2img_02>`.

.. _figure_mol2img_02:

.. figure:: depicttk/images/mol2img-02.*
   :align:  center

   **Example of using the program with the white monochrome atom coloring style**

.. -----------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> mol2img -in nexium.ism -out image.png -aromstyle Circle

.. oe:language:: python

   .. code-block:: console

      prompt> python mol2img.py -in nexium.ism -out image.png -aromstyle Circle

.. oe:language:: java

   .. code-block:: console

      prompt> java Mol2Img -in nexium.ism -out image.png -aromstyle Circle

.. oe:language:: csharp

   .. code-block:: console

      prompt> Mol2Img -in nexium.ism -out image.png -aromstyle Circle

will generate the image shown in
:ref:`Figure: Example of using the program with aromaticity style 'Circle' <figure_mol2img_03>`.

.. _figure_mol2img_03:

.. figure:: depicttk/images/mol2img-03.*
   :align:  center

   **Example of using the program with aromaticity style 'Circle'**

.. -----------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

     prompt> mol2img -in nexium.ism -out image.png -atomstereostyle "AtomStereo|CIPAtomStereo"

.. oe:language:: python

   .. code-block:: console

     prompt> python mol2img.py -in nexium.ism -out image.png -atomstereostyle "AtomStereo|CIPAtomStereo"

.. oe:language:: java

   .. code-block:: console

     prompt> java Mol2Img -in nexium.ism -out image.png -atomstereostyle "AtomStereo|CIPAtomStereo"

.. oe:language:: csharp

   .. code-block:: console

     prompt> Mol2Img -in nexium.ism -out image.png -atomstereostyle "AtomStereo|CIPAtomStereo"

will generate the image shown in
:ref:`Figure: Example of the mol2img program with CIP atom stereo option<figure_mol2img_04>`.

.. _figure_mol2img_04:

.. figure:: depicttk/images/mol2img-04.*
   :align:  center

   **Example of using the program with CIP atom stereo option**

.. -----------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> mol2img -in nexium.ism -out image.png -linewidth 4

.. oe:language:: python

   .. code-block:: console

      prompt> python mol2img.py -in nexium.ism -out image.png -linewidth 4

.. oe:language:: java

   .. code-block:: console

      prompt> java Mol2Img -in nexium.ism -out image.png -linewidth 4

.. oe:language:: csharp

   .. code-block:: console

      prompt> Mol2Img -in nexium.ism -out image.png -linewidth 4

will generate the image shown in
:ref:`Figure: Example of using the program with user-defined line width<figure_mol2img_05>`.

.. _figure_mol2img_05:

.. figure:: depicttk/images/mol2img-05.*
   :align:  center

   **Example of using the program with user-defined line width**

.. -----------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> mol2img -in nexium.ism -out image.png -superdisp All

.. oe:language:: python

   .. code-block:: console

      prompt> python mol2img.py -in nexium.ism -out image.png -superdisp All

.. oe:language:: java

   .. code-block:: console

      prompt> java Mol2Img -in nexium.ism -out image.png -superdisp All

.. oe:language:: csharp

   .. code-block:: console

      prompt> Mol2Img -in nexium.ism -out image.png -superdisp All

will generate the image shown in
:ref:`Figure: Example of using the program with superatom style<figure_mol2img_06>`.

.. _figure_mol2img_06:

.. figure:: depicttk/images/mol2img-06.*
   :align:  center

   **Example of using the  program with superatom style**

.. note::

   The above program can generate 2D coordinates with user-defined 2D ring layouts when using the
   **-ringdict** parameter.

   See also the :ref:`section_example_oechem_2D_coordinate_generation` section of
   the **OEChem TK** manual that shows examples about how to generate and
   utilize user-defined ring dictionaries.

.. seealso::

   * :ref:`chapter_mol_display` chapter



.. _section_examples_summary_mols2img:

Depicting Molecules In a Grid
================================================================================

A program that converts molecular structures into an image with a grid layout.
By default the input molecules are depicted in a 3x2 grid.

Command Line Interface
--------------------------------------------------------------------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> mols2img --help

.. oe:language:: python

   .. code-block:: console

      prompt> python mols2img.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java Mols2Img --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> Mols2Img --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    -height : Height of output image
    -width : Width of output image

    image grid options :
      -cols : Number of columns
      -rows : Number of rows

    input/output options :
      -in : Input filename(s)
      -out : Output filename

    molecule display options :
      -aromstyle : Aromatic ring display style
      -atomcolor : Atom coloring style
      -atomlabelfontscale : Atom label font scale
      -atomprop : Atom property display
      -atomstereostyle : Atom stereo display style
      -bondcolor : Bond coloring style
      -bondprop : Bond property display
      -bondstereostyle : Bond stereo display style
      -hydrstyle : Hydrogen display style
      -linewidth : Default bond line width
      -protgroupdisp : Protective group display style
      -scale : Scaling of the depicted molecule
      -superdisp : Super atom display style
      -titleloc : Location of the molecule title

    prepare depiction options :
      -clearcoords : Clear and regenerate 2D coordinates of molecule(s)
      -orientation : Set the preferred orientation of 2D coordinates
      -suppressH : Suppress explicit hydrogens of molecule(s)

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mols2img.cpp <../../../../sublibs/tklibs/depict/examples/mols2img.cpp>`
         and
         :download:`mols2img.txt <../../../../sublibs/tklibs/depict/examples/mols2img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: mols2img.cpp
         :language: c++

      with interface file

      .. oe:source:: mols2img.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mols2img.py <../../../../wrappers/python/examples/depict/mols2img.py>`

      .. literalinclude:: ../../../wrappers/python/examples/depict/mols2img.py

   .. only:: oepdf

      .. oe:source:: mols2img.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Mols2Img.java <../../../../wrappers/java/examples/openeye/examples/oedepict/Mols2Img.java>`
         and
         :download:`Mols2Img.txt <../../../../wrappers/java/examples/openeye/examples/oedepict/Mols2Img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: Mols2Img.java
         :language: java

      with interface file

      .. oe:source:: Mols2Img.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Mols2Img.cs <../../../../wrappers/csharp/Csharp-Examples/OEDepict/Mols2Img.cs>`

   .. only:: oepdf

      .. oe:source:: Mols2Img.cs
         :language: csharp

.. seealso::

   * :ref:`chapter_image_layout` chapter

   * :oe:func:`OEDepict::OEConfigureImageWidth` function
   * :oe:func:`OEDepict::OEConfigureImageHeight` function
   * :oe:func:`OEDepict::OEConfigureImageGridParams` function
   * :oe:func:`OEDepict::OEConfigurePrepareDepictionOptions` function
   * :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function
   * :oe:func:`OEDepict::OEGetImageWidth` and :oe:func:`OEDepict::OEGetImageHeight` functions
   * :oe:func:`OEDepict::OEGetImageGridNumRows` and :oe:func:`OEDepict::OEGetImageGridNumColumns` functions
   * :ref:`OEImageGrid <OEDepict_OEImageGrid>` class
   * :ref:`OEPrepareDepictionOptions <OEDepict_OEPrepareDepictionOptions>` class
   * :oe:func:`OEDepict::OESetupPrepareDepictionOptions` function
   * :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class
   * :oe:func:`OEDepict::OESetup2DMolDisplayOptions` function
   * :oe:func:`OEDepict::OEPrepareDepiction` function
   * :oe:func:`OEDepict::OERenderMolecule` function
   * :oe:func:`OEDepict::OEWriteImage` function

Examples
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> mols2img -in amino.ism -out image.png

.. oe:language:: python

   .. code-block:: console

      prompt> python mols2img.py -in amino.ism -out image.png

.. oe:language:: java

   .. code-block:: console

      prompt> java Mols2Img -in amino.ism -out image.png

.. oe:language:: csharp

   .. code-block:: console

      prompt> Mols2Img -in amino.ism -out image.png

will generate the image shown in
:ref:`Figure: Example of using the program with default parameters <figure_mols2img_01>`.

.. _figure_mols2img_01:

.. figure:: depicttk/images/mols2img-01.*
   :align:  center

   **Example of using the program with default parameters**

.. note::

   By default the program depicts molecules in a 3x2 grid

.. -----------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> mols2img -in amino.ism -out image.png -rows 2 -cols 3

.. oe:language:: python

   .. code-block:: console

      prompt> python mols2img.py -in amino.ism -out image.png -rows 2 -cols 3

.. oe:language:: java

   .. code-block:: console

      prompt> java Mols2Img -in amino.ism -out image.png -rows 2 -cols 3

.. oe:language:: csharp

   .. code-block:: console

      prompt> Mols2Img -in amino.ism -out image.png -rows 2 -cols 3

will generate the image shown in
:ref:`Figure: Example of using the program with user-defined number of rows and columns<figure_mols2img_02>`.

.. _figure_mols2img_02:

.. figure:: depicttk/images/mols2img-02.*
   :align:  center

   **Example of using the program with user-defined number of rows and columns**

.. -----------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> mols2img -in amino.ism -out image.png  -rows 2 -cols 2 -titleloc Bottom

.. oe:language:: python

   .. code-block:: console

      prompt> python mols2img.py -in amino.ism -out image.png  -rows 2 -cols 2 -titleloc Bottom

.. oe:language:: java

   .. code-block:: console

      prompt> java Mols2Img -in amino.ism -out image.png  -rows 2 -cols 2 -titleloc Bottom

.. oe:language:: csharp

   .. code-block:: console

      prompt> Mols2Img -in amino.ism -out image.png  -rows 2 -cols 2 -titleloc Bottom

will generate the image shown in
:ref:`Figure: Example of using the program with molecule titles displayed at the bottom<figure_mols2img_03>`.

.. _figure_mols2img_03:

.. figure:: depicttk/images/mols2img-03.*
   :align:  center

   **Example of using the program with molecule titles displayed at the bottom**

.. seealso::

   * :ref:`section_image_layout_grid` section


.. _section_examples_summary_mols2pdf:

Depicting Molecules in Multi-Page
================================================================================

A program that converts molecular structures into a multipage :file:`PDF` image.

Command Line Interface
--------------------------------------------------------------------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> mols2pdf --help

.. oe:language:: python

   .. code-block:: console

      prompt> python mols2pdf.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java Mols2PDF --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> Mols2PDF --help

will generate the following output:

.. code-block:: console

    Simple parameter list
    input/output options :
      -in : Input filename
      -out : Output filename
      -ringdict : User-defined 2D ring dictionary

    molecule display options :
      -aromstyle : Aromatic ring display style
      -atomcolor : Atom coloring style
      -atomlabelfontscale : Atom label font scale
      -atomprop : Atom property display
      -atomstereostyle : Atom stereo display style
      -bondcolor : Bond coloring style
      -bondprop : Bond property display
      -bondstereostyle : Bond stereo display style
      -hydrstyle : Hydrogen display style
      -linewidth : Default bond line width
      -protgroupdisp : Protective group display style
      -scale : Scaling of the depicted molecule
      -superdisp : Super atom display style
      -titleloc : Location of the molecule title

    prepare depiction options :
      -clearcoords : Clear and regenerate 2D coordinates of molecule(s)
      -orientation : Set the preferred orientation of 2D coordinates
      -suppressH : Suppress explicit hydrogens of molecule(s)

    report options :
      -colsperpage : Number of columns per page
      -pageheight : Page height
      -pageorientation : Page orientation
      -pagesize : Page size
      -pagewidth : Page width
      -rowsperpage : Number of rows per page

.. seealso::

   * :ref:`section_multipage_report` chapter

.. note::

   The above program can generate 2D coordinates with user-defined 2D ring layouts when using the
   **-ringdict** parameter.

   See also the :ref:`section_example_oechem_2D_coordinate_generation` section of
   the **OEChem TK** manual that shows examples about how to generate and
   utilize user-defined ring dictionaries.

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mols2pdf.cpp <../../../../sublibs/tklibs/depict/examples/mols2pdf.cpp>`
         and
         :download:`mols2pdf.txt <../../../../sublibs/tklibs/depict/examples/mols2pdf.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: mols2pdf.cpp
         :language: c++

      with interface file

      .. oe:source:: mols2pdf.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mols2pdf.py <../../../../wrappers/python/examples/depict/mols2pdf.py>`

      .. literalinclude:: ../../../wrappers/python/examples/depict/mols2pdf.py

   .. only:: oepdf

      .. oe:source:: mols2pdf.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Mols2PDF.java <../../../../wrappers/java/examples/openeye/examples/oedepict/Mols2PDF.java>`
         and
         :download:`Mols2PDF.txt <../../../../wrappers/java/examples/openeye/examples/oedepict/Mols2PDF.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: Mols2PDF.java
         :language: java

      with interface file

      .. oe:source:: Mols2PDF.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Mols2PDF.cs <../../../../wrappers/csharp/Csharp-Examples/OEDepict/Mols2PDF.cs>`

   .. only:: oepdf

      .. oe:source:: Mols2PDF.cs
         :language: csharp

.. seealso::

   * :ref:`chapter_multipage` chapter

   * :oe:func:`OEDepict::OEConfigureReportOptions` function
   * :oe:func:`OEDepict::OEConfigurePrepareDepictionOptions` function
   * :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function
   * :ref:`OEReportOptions <OEDepict_OEReportOptions>` class
   * :oe:func:`OEDepict::OESetupReportOptions` function
   * :ref:`OEReport <OEDepict_OEReport>` class
   * :ref:`OEPrepareDepictionOptions <OEDepict_OEPrepareDepictionOptions>` class
   * :oe:func:`OEDepict::OESetupPrepareDepictionOptions` function
   * :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class
   * :oe:func:`OEDepict::OESetup2DMolDisplayOptions` function
   * :oe:func:`OEDepict::OEPrepareDepiction` function
   * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class
   * :oe:func:`OEDepict::OERenderMolecule` function
   * :ref:`OEFont <OEDepict_OEFont>` class
   * :oe:func:`OEDepict::OEDrawTextToCenter` function
   * :oe:func:`OEDepict::OEWriteReport` function


.. _section_examples_summary_ringdict2pdf:

Generating 2D Ring Dictionary Report
================================================================================

A program that generate a multi-page PDF report of the 2D ring
dictionary.

Command Line Interface
--------------------------------------------------------------------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> ringdict2pdf --help

.. oe:language:: python

   .. code-block:: console

      prompt> python ringdict2pdf.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java RingDict2PDF --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> RingSict2PDF --help

Will generate the following output:

.. code-block:: console

    Simple parameter list
        input/output options :
          -out : Output filename
          -ringdict : Input ring dictionary filename

        report options :
          -colsperpage : Number of columns per page
          -pageheight : Page height
          -pageorientation : Page orientation
          -pagesize : Page size
          -pagewidth : Page width
          -rowsperpage : Number of rows per page

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ringdict2pdf.cpp <../../../../sublibs/tklibs/depict/examples/ringdict2pdf.cpp>`
         and
         :download:`ringdict2pdf.txt <../../../../sublibs/tklibs/depict/examples/ringdict2pdf.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: ringdict2pdf.cpp
         :language: c++

      with interface file

      .. oe:source:: ringdict2pdf.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ringdict2pdf.py <../../../../wrappers/python/examples/depict/ringdict2pdf.py>`

      .. literalinclude:: ../../../wrappers/python/examples/depict/ringdict2pdf.py

   .. only:: oepdf

      .. oe:source:: ringdict2pdf.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RingDict2PDF.java <../../../../wrappers/java/examples/openeye/examples/oedepict/RingDict2PDF.java>`
         and
         :download:`RingDict2PDF.txt <../../../../wrappers/java/examples/openeye/examples/oedepict/RingDict2PDF.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: RingDict2PDF.java
         :language: java

      with interface file

      .. oe:source:: RingDict2PDF.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RingDict2PDF.cs <../../../../wrappers/csharp/Csharp-Examples/OEDepict/RingDict2PDF.cs>`

   .. only:: oepdf

      .. oe:source:: RingDict2PDF.cs
         :language: csharp

.. seealso::

   * :ref:`section_example_oechem_2D_coordinate_generation` section in the **OEChem TK** manual

   * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
   * :oe:func:`OEChem::OEIsValid2DRingDictionary` function
   * :oe:func:`OEDepict::OEWrite2DRingDictionaryReport` function

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> ringdict2pdf -ringdict rtd.oeb -out rtd.pdf

.. oe:language:: python

   .. code-block:: console

      prompt> python ringdict2pdf.py -ringdict rtd.oeb -out rtd.pdf

.. oe:language:: java

   .. code-block:: console

      prompt> java RingDict2PDF -ringdict rtd.oeb -out rtd.pdf

.. oe:language:: csharp

   .. code-block:: console

      prompt> RingDict2PDF -ringdict rtd.oeb -out rtd.pdf

will generate a multi-page PDF report similar to the one shown in
:ref:`Table: Example of ring dictionary report <table_OEWrite2DRingDictionaryReport_example>`.

.. _table_OEWrite2DRingDictionaryReport_example:

.. list-table:: **Example of ring dictionary report** (The pages are reduced here for visualization convenience)

   * - cover page
     - page 1
     - page 2

   * -  .. image:: images/rtd-example-report-1.*
     -  .. image:: images/rtd-example-report-2.*
     -  .. image:: images/rtd-example-report-3.*

.. seealso::

   * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class in the **OEChem TK** manual
   * :ref:`section_example_oechem_2D_coordinate_generation` section in the **OEChem TK** manual that shows examples
     about how to create and manipulate user-defined ring dictionaries.


.. _section_examples_summary_smartsalign2D:

Aligning Molecules Based on Substructure Search
================================================================================

A program that aligns the molecules based on a substructure search
initialized with the given SMARTS pattern.

Command Line Interface
--------------------------------------------------------------------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: bash

      prompt> smartsalign2D --help

.. oe:language:: python

   .. code-block:: bash

      prompt> python smartsalign2D.py --help

.. oe:language:: java

   .. code-block:: bash

      prompt> java SMARTSAlign2D --help

.. oe:language:: csharp

   .. code-block:: bash

      prompt> SMARTSAlign2D --help

Will generate the following output:

.. code-block:: console

   Simple parameter list
   input/output options :
      -in : Filename of input molecules
      -out : Output filename
      -smarts : SMARTS for alignment match

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`smartsalign2D.cpp <../../../../sublibs/tklibs/depict/examples/smartsalign2D.cpp>`
         and
         :download:`smartsalign2D.txt <../../../../sublibs/tklibs/depict/examples/smartsalign2D.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: smartsalign2D.cpp
         :language: c++

      with interface file

      .. oe:source:: smartsalign2D.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`smartsalign2D.py <../../../../wrappers/python/examples/depict/smartsalign2D.py>`

      .. literalinclude:: ../../../wrappers/python/examples/depict/smartsalign2D.py

   .. only:: oepdf

      .. oe:source:: smartsalign2D.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SMARTSAlign2D.java <../../../../wrappers/java/examples/openeye/examples/oedepict/SMARTSAlign2D.java>`
         and
         :download:`SMARTSAlign2D.txt <../../../../wrappers/java/examples/openeye/examples/oedepict/SMARTSAlign2D.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: SMARTSAlign2D.java
         :language: java

      with interface file

      .. oe:source:: SMARTSAlign2D.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SMARTSAlign2D.cs <../../../../wrappers/csharp/Csharp-Examples/OEDepict/SMARTSAlign2D.cs>`

   .. only:: oepdf

      .. oe:source:: SMARTSAlign2D.cs
         :language: csharp

.. seealso::

   * :ref:`chapter_molalign` chapter

   * :ref:`OESubSearch <OEChem_OESubSearch>` class
   * :oe:func:`OEChem::OEGenerate2DCoordinates` function
   * :oe:func:`OEChem::OEIs2DFormat` function
   * :oe:func:`OEChem::OEPrepareSearch` function
   * :oe:func:`OEDepict::OEPrepareAlignedDepiction` function
   * :oe:func:`OEDepict::OEPrepareDepiction` function

Examples
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

       prompt> smartsalign2D -in test.sdf -out aligned.sdf -smarts "c1cc[c,n]c2c1ncc2"

.. oe:language:: python

   .. code-block:: console

      prompt> python smartsalign2D.py -in test.sdf -out aligned.sdf -smarts "c1cc[c,n]c2c1ncc2" -out out.mol

.. oe:language:: java

   .. code-block:: console

       prompt> java SMARTSAlign2D -in test.sdf -out aligned.sdf -smarts "c1cc[c,n]c2c1ncc2" -out out.mol

.. oe:language:: csharp

   .. code-block:: console

       prompt> SMARTSAlign2D -in test.sdf -out aligned.sdf -smarts "c1cc[c,n]c2c1ncc2" -out out.mol

Taking the output coordinates and generating the images with the
:ref:`mol2img<section_examples_summary_mol2img>` program will produce the images shown in
:ref:`Table: Example of using the program to align molecule<table_smartsalign2D>`

.. _table_smartsalign2D:

.. list-table:: **Example of using the program to align molecules**
   :widths: 100 100 100

   * - .. image:: images/smartsalign2D-out-1.*
         :align:  center
     - .. image:: images/smartsalign2D-out-2.*
         :align:  center
     - .. image:: images/smartsalign2D-out-3.*
         :align:  center

.. seealso::

   * :ref:`chapter_molalign` chapter


.. _section_examples_summary_viewmdlsearch:

Depicting MDL Query Substructure Search Hits
================================================================================

A program that performs substructure search on a molecule
using an :file:`MDL` query and generates an image file
one match per molecule.

Command Line Interface
--------------------------------------------------------------------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> viewmdlsearch --help

.. oe:language:: python

   .. code-block:: console

      prompt> python viewmdlsearch.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java ViewMDLSearch --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> ViewMDLSearch --help

Will generate the following output:

.. code-block:: console

   Simple parameter list
    general options :
      -align : Align hits to query

    highlight options :
      -highlightcolor : Highlighting color
      -highlightstyle : Highlighting style

    input/output options :
      -out : Output image filename
      -query : Input query filename
      -target : Input target filename

    molecule display options :
      -aromstyle : Aromatic ring display style
      -atomcolor : Atom coloring style
      -atomlabelfontscale : Atom label font scale
      -atomprop : Atom property display
      -atomstereostyle : Atom stereo display style
      -bondcolor : Bond coloring style
      -bondprop : Bond property display
      -bondstereostyle : Bond stereo display style
      -hydrstyle : Hydrogen display style
      -linewidth : Default bond line width
      -protgroupdisp : Protective group display style
      -scale : Scaling of the depicted molecule
      -superdisp : Super atom display style
      -titleloc : Location of the molecule title

    report options :
      -colsperpage : Number of columns per page
      -pageheight : Page height
      -pageorientation : Page orientation
      -pagesize : Page size
      -pagewidth : Page width
      -rowsperpage : Number of rows per page

.. seealso::

   * :ref:`section_multipage_report` chapter

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`viewmdlsearch.cpp <../../../../sublibs/tklibs/depict/examples/viewmdlsearch.cpp>`
         and
         :download:`viewmdlsearch.txt <../../../../sublibs/tklibs/depict/examples/viewmdlsearch.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: viewmdlsearch.cpp
         :language: c++

      with interface file

      .. oe:source:: viewmdlsearch.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`viewmdlsearch.py <../../../../wrappers/python/examples/depict/viewmdlsearch.py>`

      .. literalinclude:: ../../../wrappers/python/examples/depict/viewmdlsearch.py

   .. only:: oepdf

      .. oe:source:: viewmdlsearch.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ViewMDLSearch.java <../../../../wrappers/java/examples/openeye/examples/oedepict/ViewMDLSearch.java>`
         and
         :download:`ViewMDLSearch.txt <../../../../wrappers/java/examples/openeye/examples/oedepict/ViewMDLSearch.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: ViewMDLSearch.java
         :language: java

      with interface file

      .. oe:source:: ViewMDLSearch.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ViewMDLSearch.cs <../../../../wrappers/csharp/Csharp-Examples/OEDepict/ViewMDLSearch.cs>`

   .. only:: oepdf

      .. oe:source:: ViewMDLSearch.cs
         :language: csharp

.. seealso::

   * :ref:`chapter_multipage` and :ref:`chapter_mdlquery` chapters

   * :oe:func:`OEDepict::OEConfigureReportOptions` function
   * :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function
   * :oe:func:`OEDepict::OEConfigureHighlightParams` function
   * :oe:func:`OEDepict::OEIsRegisteredMultiPageImageFile` function
   * :oe:func:`OEChem::OEReadMDLQueryFile` function
   * :oe:func:`OEDepict::OEPrepareDepiction` function
   * :oe:func:`OEChem::OEBuildMDLQueryExpressions` function
   * :ref:`OESubSearch <OEChem_OESubSearch>` class
   * :oe:func:`OEDepict::OEGetHighlightStyle` and :oe:func:`OEDepict::OEGetHighlightColor` functions
   * :ref:`OEReportOptions <OEDepict_OEReportOptions>` class
   * :oe:func:`OEDepict::OESetupReportOptions` function
   * :ref:`OEReport <OEDepict_OEReport>` class
   * :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class
   * :oe:func:`OEDepict::OESetup2DMolDisplayOptions` function
   * :oe:func:`OEChem::OEPrepareSearch` function
   * :oe:func:`OEDepict::OEPrepareAlignedDepiction` function
   * :oe:func:`OEDepict::OEPrepareDepiction` function
   * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class
   * :oe:func:`OEDepict::OEAddHighlighting` function
   * :oe:func:`OEDepict::OERenderMolecule` function
   * :oe:func:`OEDepict::OEDrawBorder` function
   * :oe:func:`OEDepict::OEWriteReport` function


.. _chapter_highlighting:

********************************************************************************
Highlighting
********************************************************************************

Atoms and bonds of a molecule can be highlighted by using the
:oe:func:`OEDepict::OEAddHighlighting` functions.
**OEDepict TK** provides four built-in highlighting styles:

**color**
  This style is associated with the
  :oe:const:`OEDepict::OEHighlightStyle::Color`
  constant.
  See :ref:`Figure: Example of highlighting using the 'color' style<figure_highlighting_color>`.

  .. _figure_highlighting_color:

  .. figure:: depicttk/images/OEHighlightStyle_Color.*
     :align:  center

     **Example of highlighting using the 'color' style**

**stick**
  This style is associated with the
  :oe:const:`OEDepict::OEHighlightStyle::Stick`
  constant.
  See :ref:`Figure: Example of highlighting using the 'stick' style<figure_highlighting_stick>`.

  .. _figure_highlighting_stick:

  .. figure:: depicttk/images/OEHighlightStyle_Stick.*
     :align:  center

     **Example of highlighting using the 'stick' style**

**ball and stick**
  This style is associated with the
  :oe:const:`OEDepict::OEHighlightStyle::BallAndStick`
  constant.
  See :ref:`Figure: Example of highlighting using the 'ball and stick' style<figure_highlighting_ball_and_stick>`.

  .. _figure_highlighting_ball_and_stick:

  .. figure:: depicttk/images/OEHighlightStyle_BallAndStick.*
     :align:  center

     **Example of highlighting using the 'ball and stick' style**

**cogwheel**
  This style is associated with the
  :oe:const:`OEDepict::OEHighlightStyle::Cogwheel`
  constant.
  See :ref:`Figure: Example of highlighting using the 'cogwheel' style<figure_highlighting_cogwheel>`.

  .. _figure_highlighting_cogwheel:

  .. figure:: depicttk/images/OEHighlightStyle_Cogwheel.*
     :align:  center

     **Example of highlighting using the 'cogwheel' style**

**lasso**
  This style is associated with the
  :oe:const:`OEDepict::OEHighlightStyle::Lasso`
  constant.
  See :ref:`Figure: Example of highlighting using the 'lasso' style<figure_highlighting_lasso>`.

  .. _figure_highlighting_lasso:

  .. figure:: depicttk/images/OEHighlightStyle_Lasso.*
     :align:  center

     **Example of highlighting using the 'lasso' style**

Using Highlighting Styles
================================================================================

The following example (:oe:src:`Listing 1<SNIPPET-HIGHLIGHT-SIMPLE-HighlightSimple>`) shows how
to use the built-in highlighting styles.
The :oe:func:`OEDepict::OEAddHighlighting` function takes an
:ref:`OEMatchBase <OEChem_OEMatchBase>` object and highlights each of its target
atoms and bonds using the given style.
In this case, the two pyridine rings in the target structure are
highlighted by red color using the **stick** style.
The image created by :oe:src:`Listing 1<SNIPPET-HIGHLIGHT-SIMPLE-HighlightSimple>` is shown in
:ref:`Figure: Example of using 'stick' highlighting style<figure_highlighting_simple>`.

.. oe:source:: HighlightSimple.py
   :language: python
   :refnum:   1
   :caption:  Example of using highlighting style
   :frag:     SNIPPET-HIGHLIGHT-SIMPLE

.. oe:source:: HighlightSimple.cpp
   :language: c++
   :refnum:   1
   :caption:  Example of using highlighting style
   :frag:     SNIPPET-HIGHLIGHT-SIMPLE

.. oe:source:: HighlightSimple.java
   :language: java
   :refnum:   1
   :caption:  Example of using highlighting style
   :frag:     SNIPPET-HIGHLIGHT-SIMPLE

.. oe:source:: HighlightSimple.cs
   :language: csharp
   :refnum:   1
   :caption:  Example of using highlighting style
   :frag:     SNIPPET-HIGHLIGHT-SIMPLE

.. _figure_highlighting_simple:

.. figure:: depicttk/images/HighlightSimple.*
   :align:  center

   **Example of using 'stick' highlighting style**

.. seealso::

   * :oe:constns:`OEDepict::OEHighlightStyle` namespace
   * :oe:func:`OEDepict::OEAddHighlighting` function
   * :ref:`section_examples_summary_match2img` example

Using Highlighting Classes
================================================================================

**OEDepict TK** also provides the highlighting classes that correspond to
the highlighting styles.
Each highlighting style can be customized by using the corresponding class:

* :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>`
* :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>`
* :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>`
* :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>`
* :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>`

The next example (:oe:src:`Listing 2<SNIPPET-HIGHLIGHT-STYLE-HighlightStyle>`) shows how
the  **stick** style can be customized by using the corresponding
:ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>` class.
The image created by :oe:src:`Listing 2<SNIPPET-HIGHLIGHT-STYLE-HighlightStyle>` is shown in
:ref:`Figure: Example of customizing the 'stick' highlighting style<figure_highlighting_style>`.

.. oe:source:: HighlightStyle.py
   :language: python
   :refnum:   2
   :caption:  Example of using highlighting class
   :frag:     SNIPPET-HIGHLIGHT-STYLE

.. oe:source:: HighlightStyle.cpp
   :language: c++
   :refnum:   2
   :caption:  Example of using highlighting class
   :frag:     SNIPPET-HIGHLIGHT-STYLE

.. oe:source:: HighlightStyle.java
   :language: java
   :refnum:   2
   :caption:  Example of using highlighting class
   :frag:     SNIPPET-HIGHLIGHT-STYLE

.. oe:source:: HighlightStyle.cs
   :language: csharp
   :refnum:   2
   :caption:  Example of using highlighting class
   :frag:     SNIPPET-HIGHLIGHT-STYLE

.. _figure_highlighting_style:

.. figure:: depicttk/images/HighlightStyle.*
   :align:  center

   **Example of customizing the 'stick' highlighting style**

.. seealso::

   * :oe:func:`OEDepict::OEAddHighlighting` function

.. _section_highlighting_overlap:

Highlighting Overlapped Patterns
================================================================================

If more than one part of a molecule is highlighted, these highlights
can overlap resulting in loss of information.
For example, highlighting the matches of the `c1cc[c,n]cc1` SMARTS
pattern will produce the following image.

.. _figure_highlighting_all_in_one:

.. figure:: depicttk/images/HighlightAllInOne.*
   :align:  center

   **Example of highlighting multiple matches in the same image**

There are two ways how this can be avoided and correctly
highlight overlapping parts of a molecule.
The first example demonstrates how to depict multiple matches in
different image cells one by one.
The image created by :oe:src:`Listing 3<SNIPPET-HIGHLIGHT-MULTI-HighlightMulti>` is shown in
:ref:`Figure: Example of highlighting multiple matches one by one<figure_highlighting_multi>`.

.. oe:source:: HighlightMulti.py
   :language: python
   :refnum:   3
   :caption:  Example of highlighting multiple matches one by one
   :frag:     SNIPPET-HIGHLIGHT-MULTI

.. oe:source:: HighlightMulti.cpp
   :language: c++
   :refnum:   3
   :caption:  Example of highlighting multiple matches one by one
   :frag:     SNIPPET-HIGHLIGHT-MULTI

.. oe:source:: HighlightMulti.java
   :language: java
   :refnum:   3
   :caption:  Example of highlighting multiple matches one by one
   :frag:     SNIPPET-HIGHLIGHT-MULTI

.. oe:source:: HighlightMulti.cs
   :language: csharp
   :refnum:   3
   :caption:  Example of highlighting multiple matches one by one
   :frag:     SNIPPET-HIGHLIGHT-MULTI

.. _figure_highlighting_multi:

.. figure:: depicttk/images/HighlightMulti.*
   :align:  center

   **Example of highlighting multiple matches one by one**

.. seealso::

    * :ref:`OEImageGrid <OEDepict_OEImageGrid>` class
    * :ref:`section_image_layout_grid` section

The second example (:oe:src:`Listing 4<SNIPPET-HIGHLIGHT-OVERLAY-HighlightOverlay>`) illustrates how
to highlight overlapping matches at once using the
:ref:`OEHighlightOverlayByBallAndStick <OEDepict_OEHighlightOverlayByBallAndStick>` class.
In this example, the :oe:func:`OEDepict::OEAddHighlightOverlay` function takes
all matches being highlighted and colors the overlapped atoms and bonds
using the colors by turn.
The colors used for highlighting are determined when the
:ref:`OEHighlightOverlayByBallAndStick <OEDepict_OEHighlightOverlayByBallAndStick>` object is constructed.
The image created by :oe:src:`Listing 4<SNIPPET-HIGHLIGHT-OVERLAY-HighlightOverlay>` is shown in
:ref:`Figure: Example of highlighting overlapping matches at once<figure_highlighting_overlay>`.

.. oe:source:: HighlightOverlay.py
   :language: python
   :refnum:   4
   :caption:  Example of highlighting multiple matches simultaneously
   :frag:     SNIPPET-HIGHLIGHT-OVERLAY

.. oe:source:: HighlightOverlay.cpp
   :language: c++
   :refnum:   4
   :caption:  Example of highlighting multiple matches simultaneously
   :frag:     SNIPPET-HIGHLIGHT-OVERLAY

.. oe:source:: HighlightOverlay.java
   :language: java
   :refnum:   4
   :caption:  Example of highlighting multiple matches simultaneously
   :frag:     SNIPPET-HIGHLIGHT-OVERLAY

.. oe:source:: HighlightOverlay.cs
   :language: csharp
   :refnum:   4
   :caption:  Example of highlighting multiple matches simultaneously
   :frag:     SNIPPET-HIGHLIGHT-OVERLAY

.. _figure_highlighting_overlay:

.. figure:: depicttk/images/HighlightOverlay.*
   :align:  center

   **Example of highlighting overlapping matches at once**

.. seealso::

    * :ref:`OEHighlightOverlayBase <OEDepict_OEHighlightOverlayBase>` base class
    * :ref:`OEHighlightOverlayByBallAndStick <OEDepict_OEHighlightOverlayByBallAndStick>` class
    * :oe:constns:`OEDepict::OEHighlightOverlayStyle` namespace
    * :oe:func:`OESystem::OEGetColors`, :oe:func:`OESystem::OEGetContrastColors`,
      :oe:func:`OESystem::OEGetDeepColors`, :oe:func:`OESystem::OEGetLightColors` and
      :oe:func:`OESystem::OEGetVividColors` functions



.. _chapter_image_layout:

********************************************************************************
Molecule Layouts
********************************************************************************

The previous chapters described how to depict a single molecule in an image.
This chapter provides examples for drawing multiple molecular diagrams into the
same image.

.. _section_image_layout_frame:

Depicting Molecules in an Arbitrary Position
================================================================================

The :ref:`OEImageFrame <OEDepict_OEImageFrame>` class provides a general framework to
display a molecule in a specific region of the image by defining the following
parameters:

* the reference of the `parent` image
* the width and height of the generated `frame`
* the offset of the `frame` relative to the top-left corner of its
  `parent` (:ref:`OE2DPoint <OEDepict_OE2DPoint>`)

The :oe:src:`Listing 1<SNIPPET-IMAGE-FRAME-ImageFrame>` examples generates an image where the same
molecule is depicted in different regions of the image.
The molecular diagrams are automatically resized in order to fit into
the specific frame, since the corresponding
:ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object is constructed with the width
and height of the :ref:`OEImageFrame <OEDepict_OEImageFrame>` object.
When the :oe:func:`OEDepict::OERenderMolecule` function is called, the
offset of the :ref:`OEImageFrame <OEDepict_OEImageFrame>` object is added to the
coordinates stored in :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` in order to
transfer the molecule into the specific region of the image.
The image created by :oe:src:`Listing 1<SNIPPET-IMAGE-FRAME-ImageFrame>` is shown in
:ref:`Figure: Example of using OEImageFrame<figure_image_frame>`.

.. oe:source:: ImageFrame.py
   :language: python
   :refnum:   1
   :caption:  Example of using OEImageFrame
   :frag:     SNIPPET-IMAGE-FRAME

.. oe:source:: ImageFrame.cpp
   :language: c++
   :refnum:   1
   :caption:  Example of using OEImageFrame
   :frag:     SNIPPET-IMAGE-FRAME

.. oe:source:: ImageFrame.java
   :language: java
   :refnum:   1
   :caption:  Example of using OEImageFrame
   :frag:     SNIPPET-IMAGE-FRAME

.. oe:source:: ImageFrame.cs
   :language: csharp
   :refnum:   1
   :caption:  Example of using OEImageFrame
   :frag:     SNIPPET-IMAGE-FRAME

.. _figure_image_frame:

.. figure:: depicttk/images/ImageFrame.*
   :align:  center

   **Example of using OEImageFrame**

.. seealso::

   * :ref:`OEImageFrame <OEDepict_OEImageFrame>` class
   * :oe:func:`OEDepict::OEDrawBorder` function
   * :oe:func:`OEDepict::OERenderMolecule` function
   * :oe:func:`OEDepict::OEWriteImage` function

.. _section_image_layout_grid:

Depicting Molecules in a Grid
================================================================================

The :ref:`OEImageGrid <OEDepict_OEImageGrid>` class allows molecules to be aligned into
rows and columns.
After generating an :ref:`OEImageGrid <OEDepict_OEImageGrid>` object by specifying its number
of rows and columns, the cells of the grid can be accessed (from left to right, top
to bottom order) by calling the :oe:meth:`OEDepict::OEImageGrid::GetCells` method.
The image created by :oe:src:`Listing 2<SNIPPET-IMAGE-GRID-SIMPLE-ImageGridSimple>` is shown in
:ref:`Figure: Example of using OEImageGrid<figure_image_grid_simple>`.

.. oe:source:: ImageGridSimple.py
   :language: python
   :refnum:   2
   :caption:  Example of using OEImageGrid
   :frag:     SNIPPET-IMAGE-GRID-SIMPLE

.. oe:source:: ImageGridSimple.cpp
   :language: c++
   :refnum:   2
   :caption:  Example of using OEImageGrid
   :frag:     SNIPPET-IMAGE-GRID-SIMPLE

.. oe:source:: ImageGridSimple.java
   :language: java
   :refnum:   2
   :caption:  Example of using OEImageGrid
   :frag:     SNIPPET-IMAGE-GRID-SIMPLE

.. oe:source:: ImageGridSimple.cs
   :language: csharp
   :refnum:   2
   :caption:  Example of using OEImageGrid
   :frag:     SNIPPET-IMAGE-GRID-SIMPLE

.. _figure_image_grid_simple:

.. figure:: depicttk/images/ImageGridSimple.*
   :align:  center

   **Example of using OEImageGrid**

.. seealso::

   * :ref:`OEImageGrid <OEDepict_OEImageGrid>` class

.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   %
   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

When an :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object is initialized, the
dimensions of the depicted molecule is controlled by the width, height
and scale parameters of the :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`
object.

When only one molecule is depicted then auto scaling of this molecule is preferred
(i.e. scaling the molecule in order to maximally fit it to the given dimensions).
However, when more that one molecule, that are quite different in
sizes, are depicted next to each other, auto scaling of each molecule can be
visually misleading because it emphasizes molecules with greater scaling factors.
See example in :ref:`Figure: Example of using OEImageGrid<figure_image_grid_auto_scale>`
that is generated by :oe:src:`Listing 3<SNIPPET-IMAGE-GRID-AUTO-SCALE-ImageGridAutoScale>`.

.. oe:source:: ImageGridAutoScale.py
   :language: python
   :refnum:   3
   :caption:  Example of auto scaling of molecules
   :frag:     SNIPPET-IMAGE-GRID-AUTO-SCALE

.. oe:source:: ImageGridAutoScale.cpp
   :language: c++
   :refnum:   3
   :caption:  Example of auto scaling of molecules
   :frag:     SNIPPET-IMAGE-GRID-AUTO-SCALE

.. oe:source:: ImageGridAutoScale.java
   :language: java
   :refnum:   3
   :caption:  Example of auto scaling of molecules
   :frag:     SNIPPET-IMAGE-GRID-AUTO-SCALE

.. oe:source:: ImageGridAutoScale.cs
   :language: csharp
   :refnum:   3
   :caption:  Example of auto scaling of molecules
   :frag:     SNIPPET-IMAGE-GRID-AUTO-SCALE

.. _figure_image_grid_auto_scale:

.. figure:: depicttk/images/ImageGridAutoScale.*
   :align:  center

   **Example of auto scaling of molecules**

.. seealso::

   :ref:`section_mol_display_size` section

.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   %
   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

The following example (:oe:src:`Listing 4<SNIPPET-IMAGE-GRID-FIXED-SCALE-ImageGridFixedScale>`) shows
how to ensure that all molecules are depicted using the same scaling
factor.
After initializing the molecules, the minimum scaling factor is
determined by looping over the molecules being depicted and calling
the :oe:func:`OEDepict::OEGetMoleculeScale` function.
This function returns the scaling factor of the molecule considering
the depiction options stored in the given
:ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object.
After determining the minimum scaling factor, the molecules are
rendered to the cells of the grid by using this fixed scaling factor.
The image created by :oe:src:`Listing 4<SNIPPET-IMAGE-GRID-FIXED-SCALE-ImageGridFixedScale>` is shown in
:ref:`Figure: Example of using OEImageGrid<figure_image_grid_fixed_scale>`.

.. oe:source:: ImageGridFixedScale.py
   :language: python
   :refnum:   4
   :caption:  Example of identical scaling of molecules
   :frag:     SNIPPET-IMAGE-GRID-FIXED-SCALE

.. oe:source:: ImageGridFixedScale.cpp
   :language: c++
   :refnum:   4
   :caption:  Example of identical scaling of molecules
   :frag:     SNIPPET-IMAGE-GRID-FIXED-SCALE

.. oe:source:: ImageGridFixedScale.java
   :language: java
   :refnum:   4
   :caption:  Example of identical scaling of molecules
   :frag:     SNIPPET-IMAGE-GRID-FIXED-SCALE

.. oe:source:: ImageGridFixedScale.cs
   :language: csharp
   :refnum:   4
   :caption:  Example of identical scaling of molecules
   :frag:     SNIPPET-IMAGE-GRID-FIXED-SCALE

.. _figure_image_grid_fixed_scale:

.. figure:: depicttk/images/ImageGridFixedScale.*
   :align:  center

   **Example of identical scaling of molecules**

.. seealso::

    * :oe:meth:`OEDepict::OEImageGrid::GetCellHeight` method
    * :oe:meth:`OEDepict::OEImageGrid::GetCellWidth` method

.. _section_image_layout_table:

Depicting Molecules in a Table
================================================================================

The following example demonstrates how to depict molecules and display data
alongside them by using the :ref:`OEImageTable <OEDepict_OEImageTable>`.
The individual cells of an :ref:`OEImageTable <OEDepict_OEImageTable>` object can be accessed
by calling the any of the following methods:

* :oe:meth:`OEDepict::OEImageTable::GetCell`
* :oe:meth:`OEDepict::OEImageTable::GetBodyCell`
* :oe:meth:`OEDepict::OEImageTable::GetHeaderCell`
* :oe:meth:`OEDepict::OEImageTable::GetStubColumnCell`

These methods return an image (:ref:`OEImageBase <OEDepict_OEImageBase>`) on which
molecule can be drawn or text can be displayed using the
:oe:meth:`OEDepict::OEImageTable::DrawText` method.
The image created by :oe:src:`Listing 5<SNIPPET-IMAGE-TABLE-ImageTable>` is shown in
:ref:`Figure: Example of depicting molecules and data using image table<figure_image_table>`.

.. oe:source:: ImageTable.py
   :language: python
   :refnum:   5
   :caption:  Example of depicting molecules and data using image table
   :frag:     SNIPPET-IMAGE-TABLE

.. oe:source:: ImageTable.cpp
   :language: c++
   :refnum:   5
   :caption:  Example of depicting molecules and data using image table
   :frag:     SNIPPET-IMAGE-TABLE

.. oe:source:: ImageTable.java
   :language: java
   :refnum:   5
   :caption:  Example of depicting molecules and data using image table
   :frag:     SNIPPET-IMAGE-TABLE

.. oe:source:: ImageTable.cs
   :language: csharp
   :refnum:   5
   :caption:  Example of depicting molecules and data using image table
   :frag:     SNIPPET-IMAGE-TABLE

.. _figure_image_table:

.. figure:: depicttk/images/ImageTable.*
   :align:  center

   **Example of depicting molecules and data using image table**


.. _chapter_mdlquery:

********************************************************************************
MDL Query Depiction
********************************************************************************

In order to depict an MDL query the query molecule has to be imported by
calling the :oe:func:`OEChem::OEReadMDLQueryFile` function.
The rest of the process is identical to depicting a molecule.
First the :oe:func:`OEDepict::OEPrepareDepiction` function has to be
called to generate the 2D atom coordinates, then the image can be
created by rendering the molecule (:oe:func:`OEDepict::OERenderMolecule`).

.. oe:source:: DepictMDLQuery.py
   :language: python
   :refnum:   1
   :caption:  Example of MDL query depiction
   :frag:     SNIPPET-DEPICTMDLQUERY

.. oe:source:: DepictMDLQuery.cpp
   :language: c++
   :refnum:   1
   :caption:  Example of MDL query depiction
   :frag:     SNIPPET-DEPICTMDLQUERY

.. oe:source:: DepictMDLQuery.java
   :language: java
   :refnum:   1
   :caption:  Example of MDL query depiction
   :frag:     SNIPPET-DEPICTMDLQUERY

.. oe:source:: DepictMDLQuery.cs
   :language: csharp
   :refnum:   1
   :caption:  Example of MDL query depiction
   :frag:     SNIPPET-DEPICTMDLQUERY

.. seealso::

   * :oe:func:`OEChem::OEReadMDLQueryFile` function in the **OEChem TK** manual
   * :ref:`Table: Summary of supported MDL query features<table_mdlqueries_summary>`

Atom Query Features
================================================================================

The depiction of the following MDL atom query features is supported:

#.  The 8th column in the atom block in the V2K format
    file (or ``HCOUNT=`` in the V3K format file) is used to
    define the number of allowed hydrogens for an atom.
    (See examples in :ref:`Table: Example of depicting hydrogen count<table_molquery_hcount>`)

       - ``(H0)`` means no hydrogen atoms allowed unless explicitly drawn.
       - ``(Hn)`` means atom must have ``n`` or more implicit hydrogen(s)

    .. _table_molquery_hcount:

    .. list-table:: **Examples of depicting hydrogen count**
       :widths: 100 100 100
       :header-rows: 1

       * - query
         -
         -
       * - .. image:: images/MDLHCount-01-query.*
             :align:  center
         - .. image:: images/MDLHCount-01-match-0.*
             :align:  center
         - .. image:: images/MDLHCount-01-match-1.*
             :align:  center
       * - .. image:: images/MDLHCount-02-query.*
             :align:  center
         - .. image:: images/MDLHCount-02-match-0.*
             :align:  center
         - .. image:: images/MDLHCount-02-match-1.*
             :align:  center

#.  Query atom types:

    - ``A`` = any atom type except hydrogen
    - ``Q`` = any atom type except hydrogen and carbon
    - ``L`` = atom list

    The ``M  ALS`` line in the property block in the V2K
    format file ( or ``[aaa,bbb,..]`` in the V3K format)
    is used to list alternative atom types for an atom.
    (See examples in :ref:`Table: Examples of depicting query atom types<table_molquery_queryatom>`)

    .. _table_molquery_queryatom:

    .. list-table:: **Examples of depicting query atom types**
        :widths: 100 100 100 100
        :header-rows: 1

        * - query
          - target
          - target
          - target
        * - .. image:: images/MDLGenericAtom-01-query.*
               :align:  center
          - .. image:: images/MDLGenericAtom-01-match-0.*
               :align:  center
          - .. image:: images/MDLGenericAtom-01-match-1.*
               :align:  center
          - .. image:: images/MDLGenericAtom-01-match-2.*
               :align:  center
        * - .. image:: images/MDLGenericAtom-02-query.*
               :align:  center
          - .. image:: images/MDLGenericAtom-02-match-0.*
               :align:  center
          - .. image:: images/MDLGenericAtom-02-match-1.*
               :align:  center
          - .. image:: images/MDLGenericAtom-02-match-2.*
               :align:  center
        * - .. image:: images/MDLGenericAtom-03-query.*
               :align:  center
          - .. image:: images/MDLGenericAtom-03-match-0.*
               :align:  center
          - .. image:: images/MDLGenericAtom-03-match-1.*
               :align:  center
          - .. image:: images/MDLGenericAtom-03-match-2.*
               :align:  center
        * - .. image:: images/MDLGenericAtom-04-query.*
               :align:  center
          - .. image:: images/MDLGenericAtom-04-match-0.*
               :align:  center
          - .. image:: images/MDLGenericAtom-04-match-1.*
               :align:  center
          - .. image:: images/MDLGenericAtom-04-match-2.*
               :align:  center

#.  ``M  CHG`` line in the property block in the V2K format file
    (or ``CHG=`` in the V3K format) is used to define atom formal
    charges.
    (See examples in :ref:`Table: Example of depicting formal charge<table_molquery_charge>`)

    .. _table_molquery_charge:

    .. list-table:: **Examples of depicting formal charge**
       :widths: 100 100 100
       :header-rows: 1

       * - query
         - target
         - target
       * - .. image:: images/MDLCharge-01-query.*
              :align:  center
         - .. image:: images/MDLCharge-01-match-0.*
              :align:  center
         - .. image:: images/MDLCharge-01-match-1.*
              :align:  center

#.  ``M  RBC`` line in the property block in the V2K format file
    (or ``RBCNT=`` in the V3K format) is used to limit the number
    of allowed ring bonds attached to an atom.
    (See examples in :ref:`Table: Example of depicting ring count<table_molquery_ringcount>`)

       - ``(r0)`` means no ring bond allowed
       - ``(r*)`` means as drawn
       - ``(rn)`` means ``n`` number of ring bonds allowed

    .. _table_molquery_ringcount:

    .. list-table:: **Examples of depicting ring count**
       :widths: 100 100 100
       :header-rows: 1

       * - query
         - target
         - target
       * - .. image:: images/MDLRingCount-01-query.*
              :align:  center
         - .. image:: images/MDLRingCount-01-match-0.*
              :align:  center
         - .. image:: images/MDLRingCount-01-match-1.*
              :align:  center
       * - .. image:: images/MDLRingCount-02-query.*
              :align:  center
         - .. image:: images/MDLRingCount-02-match-0.*
              :align:  center
         - .. image:: images/MDLRingCount-02-match-1.*
              :align:  center

#.  ``M  SUB`` line in the property block in the V2K format file
    (or ``SUBST=`` in the V3K format) is used to set the number
    of allowed substitutions of an atom.
    (See examples in :ref:`Table: Examples of depicting substitution count<table_molquery_subcount>`)

       - ``(s0)`` means no substitution allowed
       - ``(s*)`` means as drawn
       - ``(sn)`` means ``n`` number of substitution(s) allowed

    .. _table_molquery_subcount:

    .. list-table:: **Examples of depicting substitution count**
       :widths: 100 100 100
       :header-rows: 1

       * - query
         - target
         - target
       * - .. image:: images/MDLSubCount-01-query.*
              :align:  center
         - .. image:: images/MDLSubCount-01-match-0.*
              :align:  center
         - .. image:: images/MDLSubCount-01-match-1.*
              :align:  center
       * - .. image:: images/MDLSubCount-02-query.*
              :align:  center
         - .. image:: images/MDLSubCount-02-match-0.*
              :align:  center
         - .. image:: images/MDLSubCount-02-match-1.*
              :align:  center

#.  ``M  UNS`` line in the property block in the V2K format file
    (or ``UNSAT=`` in the V3K format) is used to specify whether
    or not an atom is unsaturated, *i.e.*, having at least one multiple bond.
    (See examples in :ref:`Table: Examples of depicting unsaturated property<table_molquery_unsaturated>`)

    .. _table_molquery_unsaturated:

    .. list-table:: **Examples of depicting unsaturated property**
       :widths: 100 100 100
       :header-rows: 1

       * - query
         - target
         - target
       * - .. image:: images/MDLUnsaturated-01-query.*
              :align:  center
         - .. image:: images/MDLUnsaturated-01-match-0.*
              :align:  center
         - .. image:: images/MDLUnsaturated-01-match-1.*
              :align:  center

Bond Query Features
================================================================================

The depiction of the following MDL bond query features is supported:

#.  Alternative bond types in the bond block (4 = aromatic, 5 = single or double,
    6 = single or aromatic, 7 = double or aromatic, 8 = any bond).
    (See examples in :ref:`Table: Examples of depicting query bond types<table_molquery_querybond>`)

    .. _table_molquery_querybond:

    .. list-table:: **Examples of depicting query bond types**
        :widths: 100 100 100 100
        :header-rows: 1

        * - query
          - target
          - target
          - target
        * - .. image:: images/MDLGenericBond-01-query.*
               :align:  center
          - .. image:: images/MDLGenericBond-01-match-0.*
               :align:  center
          - .. image:: images/MDLGenericBond-01-match-1.*
               :align:  center
          - .. image:: images/MDLGenericBond-01-match-2.*
               :align:  center
        * - .. image:: images/MDLGenericBond-02-query.*
               :align:  center
          - .. image:: images/MDLGenericBond-02-match-0.*
               :align:  center
          - .. image:: images/MDLGenericBond-02-match-1.*
               :align:  center
          - .. image:: images/MDLGenericBond-02-match-2.*
               :align:  center
        * - .. image:: images/MDLGenericBond-03-query.*
               :align:  center
          - .. image:: images/MDLGenericBond-03-match-0.*
               :align:  center
          - .. image:: images/MDLGenericBond-03-match-1.*
               :align:  center
          - .. image:: images/MDLGenericBond-03-match-2.*
               :align:  center

    .. seealso::

       * :oe:constns:`OEDepict::OEBondDisplayType` namespace

#.  The 6th column in the atom block in the V2K format file
    ( or ``TOPO=`` in the V3K format) describes bond topology.
    (See examples in :ref:`Table: Examples of depicting bond topology<table_molquery_topology>`)

       - ``(rn)`` means that it can only mapped to ring bond
       - ``(ch)`` means that it can only mapped to chain bond

    .. _table_molquery_topology:

    .. list-table:: **Examples of depicting bond topology**
       :widths: 100 100 100
       :header-rows: 1

       * - query
         - target
         - target
       * - .. image:: images/MDLTopology-01-query.*
              :align:  center
         - .. image:: images/MDLTopology-01-match-0.*
              :align:  center
         - .. image:: images/MDLTopology-01-match-1.*
              :align:  center
       * - .. image:: images/MDLTopology-02-query.*
              :align:  center
         - .. image:: images/MDLTopology-02-match-0.*
              :align:  center
         - .. image:: images/MDLTopology-02-match-1.*
              :align:  center

#.  Double bond stereochemistry is considered if both ends of
    the bond are marked with *stereo care* flags in the atom block
    in the V2K format file ( or ``STBOX=`` in the V3K format).
    (See examples in :ref:`Table: Examples of depicting bond stereo care<table_molquery_bondstereo>`)

    .. _table_molquery_bondstereo:

    .. list-table:: **Examples of depicting bond stereo care**
       :widths: 100 100 100
       :header-rows: 1

       * - query
         - target
         - target
       * - .. image:: images/MDLBondStereo-01-query.*
              :align:  center
         - .. image:: images/MDLBondStereo-01-match-0.*
              :align:  center
         - .. image:: images/MDLBondStereo-01-match-1.*
              :align:  center
       * - .. image:: images/MDLBondStereo-02-query.*
              :align:  center
         - .. image:: images/MDLBondStereo-02-match-0.*
              :align:  center
         - .. image:: images/MDLBondStereo-02-match-1.*
              :align:  center

.. seealso::

   * :ref:`section_examples_summary_mdlquery2img` example

R-group Depiction
================================================================================

**OEDepict TK** can also depict R-group information by interpreting the ``M  RGP``
line in the property block of an MDL file
(See examples in :ref:`Table: Examples of depicting R-groups <table_molquery_rgroup>`)

.. _table_molquery_rgroup:

.. list-table:: **Examples of depicting R-groups**
   :widths: 100 100
   :header-rows: 0

   * - .. image:: images/RGroup-01.*
          :align:  center
     - .. image:: images/RGroup-02.*
          :align:  center



.. _chapter_mdlreaction:

********************************************************************************
MDL Reaction Depiction
********************************************************************************

**OEDepict TK** also supports MDL reaction depiction.
The reaction being depicted has to be imported by calling the
:oe:func:`OEChem::OEReadMDLReactionQueryFile` function.
The rest of the process is identical to depicting a molecule.
First the :oe:func:`OEDepict::OEPrepareDepiction` function has to be
called to generate the 2D atom coordinates, then the image can be
created by rendering the imported reaction (:oe:func:`OEDepict::OERenderMolecule`)
(See examples in :ref:`Figure: Example of MDL reaction depiction<figure_mdlreaction>`)

.. oe:source:: DepictMDLReaction.py
   :language: python
   :refnum:   1
   :caption:  Example of reaction depiction
   :frag:     SNIPPET-DEPICTMDLREACTION

.. oe:source:: DepictMDLReaction.cpp
   :language: c++
   :refnum:   1
   :caption:  Example of reaction depiction
   :frag:     SNIPPET-DEPICTMDLREACTION

.. oe:source:: DepictMDLReaction.java
   :language: java
   :refnum:   1
   :caption:  Example of reaction depiction
   :frag:     SNIPPET-DEPICTMDLREACTION

.. oe:source:: DepictMDLReaction.cs
   :language: csharp
   :refnum:   1
   :caption:  Example of reaction depiction
   :frag:     SNIPPET-DEPICTMDLREACTION

.. _figure_mdlreaction:

.. figure:: depicttk/images/DepictMDLReaction.*
   :align:  center

   **Example of MDL reaction depiction**

.. seealso::

   * :oe:func:`OEChem::OEReadMDLReactionQueryFile` function in the **OEChem TK** manual
   * :ref:`section_examples_summary_mdlreaction2img` example

The atom map information read from the reaction file can be depicted as
atom properties by using the :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>`
class.
(See examples in :ref:`Figure: Example of MDL reaction depiction with atom mapping<figure_mdlreaction_with_mapidx>`)

.. oe:source:: DepictMDLReactionMapIdx.py
   :language: python
   :refnum:   2
   :caption:  Example of reaction depiction with map indices
   :frag:     SNIPPET-DEPICTMDLREACTION-MAPIDX

.. oe:source:: DepictMDLReactionMapIdx.cpp
   :language: c++
   :refnum:   2
   :caption:  Example of reaction depiction with map indices
   :frag:     SNIPPET-DEPICTMDLREACTION-MAPIDX

.. oe:source:: DepictMDLReactionMapIdx.java
   :language: java
   :refnum:   2
   :caption:  Example of reaction depiction with map indices
   :frag:     SNIPPET-DEPICTMDLREACTION-MAPIDX

.. oe:source:: DepictMDLReactionMapIdx.cs
   :language: csharp
   :refnum:   2
   :caption:  Example of reaction depiction with map indices
   :frag:     SNIPPET-DEPICTMDLREACTION-MAPIDX

.. _figure_mdlreaction_with_mapidx:

.. figure:: depicttk/images/DepictMDLReactionWithMapIdx.*
   :align:  center

   **Example of MDL reaction depiction with atom mapping**

.. seealso::

   * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor` method
   * :oe:src:`Listing 5<SNIPPET-ATOM-PROP-INDEX-AtomPropIndex>` example in the
     :ref:`chapter_mol_display` chapter


.. _chapter_molalign:

*******************************************************************************
Molecule Alignment
*******************************************************************************

The following three code examples demonstrate how to align molecules either based
on:

* maximum common substructure (:oe:src:`Listing 1<SNIPPET-MCS-ALIGN-MCSAlign>`),
* substructure matches (:oe:src:`Listing 2<SNIPPET-SUB-SEARCH-ALIGN-SubSearchAlign>`), or
* molecular similarity (:oe:src:`Listing 3<SNIPPET-FINGERPRINT-ALIGN-FPAlign>`).

Molecule Alignment Based on MCS
================================================================================

The :ref:`Figure: Example of depiction without alignment<figure_mcss_no_alignment>`
is generated by highlighting the maximum common substructure of two molecules (MCS),
but keeping the original orientation of the compounds.

.. _figure_mcss_no_alignment:

.. figure:: depicttk/images/MCSNoAlignment.*
   :align:  center

   **Example of depiction without alignment**

The :oe:src:`Listing 1<SNIPPET-MCS-ALIGN-MCSAlign>` code example shows how to align these
two molecules by their maximum common substructures (*i.e.* by the
highlighted atoms and bonds in
:ref:`Figure: Example of depiction without alignment<figure_mcss_no_alignment>`).

* First, two molecules are initialized from SMILES string and
  prepared for depiction.

* A :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object is initialized with the
  *reference* 2D molecule onto which the *fit* molecule will be aligned.

* An :ref:`OEImageGrid <OEDepict_OEImageGrid>` object is constructed that allows
  to render the two molecules in a grid next to each other.

* The *fit* molecule is then aligned to the *reference* by
  calling the :oe:func:`OEDepict::OEPrepareAlignedDepiction`
  function that performs MCS search and then aligns the *fit* molecule
  to the *reference* based on the detected common substructure(s).

* An :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object is initialized that
  stores the properties determine how the molecules are rendered.
  In order to render the molecules in equal size the smallest
  depiction scaling factor is calculated.

* If the molecule alignment was successful
  (*i.e* :oe:meth:`OEDepict::OEAlignmentResult::IsValid` is *true*),
  then the correspondence between the two molecules stored in the
  :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>` returned by the
  :oe:func:`OEDepict::OEPrepareAlignedDepiction` function.
  This :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>` object can be used
  to highlight the matched common substructure by invoking the
  :oe:func:`OEDepict::OEAddHighlighting` function.

* After both molecules are rendered into the separate cells of the
  grid layout, the image is written into a :file:`png` file.

After initializing the two molecules and the :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object,
the :oe:meth:`OEChem::OEMCSSearch::Match` method is called to perform the
search and return an iterator over the identified maximum common
substructures.
The first match is then utilized to call the
:oe:func:`OEDepict::OEPrepareAlignedDepiction` function that aligns one molecule
to the other based on the given match.
After the alignment, the common atoms and bonds are highlighted by
invoking the :oe:func:`OEDepict::OEAddHighlighting` function.
The image created by :oe:src:`Listing 1<SNIPPET-MCS-ALIGN-MCSAlign>` is shown in
:ref:`Figure: Example of depiction with alignment based on MCS<figure_mcss_align>`.

.. oe:source:: MCSAlign.py
   :language: python
   :refnum:   1
   :caption:  Example of molecule alignment based on MCS
   :frag:     SNIPPET-MCS-ALIGN

.. oe:source:: MCSAlign.cpp
   :language: c++
   :refnum:   1
   :caption:  Example of molecule alignment based on MCS
   :frag:     SNIPPET-MCS-ALIGN

.. oe:source:: MCSAlign.java
   :language: java
   :refnum:   1
   :caption:  Example of molecule alignment based on MCS
   :frag:     SNIPPET-MCS-ALIGN

.. oe:source:: MCSAlign.cs
   :language: csharp
   :refnum:   1
   :caption:  Example of molecule alignment based on MCS
   :frag:     SNIPPET-MCS-ALIGN

.. _figure_mcss_align:

.. figure:: depicttk/images/MCSAlign.*
   :align:  center

   **Example of depiction with alignment based on maximum common substructure**

.. seealso::

   * :ref:`OEMCSSearch <OEChem_OEMCSSearch>` class in the **OEChem TK** manual
   * :ref:`OEImageGrid <OEDepict_OEImageGrid>` class
   * :oe:func:`OEDepict::OEAddHighlighting` function
   * :oe:func:`OEDepict::OERenderMolecule` function
   * :oe:func:`OEDepict::OEWriteImage` function
   * :ref:`section_examples_summary_mcsalign2D` example

Molecule Alignment Based on Substructure Search
================================================================================

The :ref:`Figure: Example of depiction without alignment<figure_ss_no_alignment>`
is generated by highlighting the "O=C(O)C(N)" substructures in four amino acids,
but keeping the original orientation of the compounds.

.. _figure_ss_no_alignment:

.. figure:: depicttk/images/SubSearchNoAlignment.*
   :align:  center

   **Example of depiction without alignment**

The :oe:src:`Listing 2<SNIPPET-SUB-SEARCH-ALIGN-SubSearchAlign>` code example shows how to align these
molecules by their matched substructures (*i.e.* by the highlighted atoms and bonds
in :ref:`Figure: Example of depiction without alignment<figure_ss_no_alignment>`).

* First, the :ref:`OESubSearch <OEChem_OESubSearch>` object is initialized with the
  *reference* 2D molecule onto which all amino acid structures will be
  aligned.

* Each amino acids structure is initialized from a SMILES string and
  prepared for depiction.

* An :ref:`OEImageGrid <OEDepict_OEImageGrid>` object is constructed that allows
  to render the molecules into a grid layout.

* An :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object is initialized that
  stores the properties determine how the molecules are rendered.
  In order to render the molecules in equal size the smallest
  depiction scaling factor is calculated.

* Looping over the amino acids:

  * Each molecule is aligned to the
    reference molecule by calling the :oe:func:`OEDepict::OEPrepareAlignedDepiction`
    function that performs the alignment based on the
    detected substructure search match(es).

  * If the molecule alignment was successful
    (*i.e* :oe:meth:`OEDepict::OEAlignmentResult::IsValid` is *true*),
    then the correspondence between the two molecules stored in the
    :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>` returned by the
    :oe:func:`OEDepict::OEPrepareAlignedDepiction` function.
    This :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>` object can be used
    to highlight the matched substructure by invoking the
    :oe:func:`OEDepict::OEAddHighlighting` function.

  * The aligned (and highlighted) molecule is then rendered to a
    next cell of the :ref:`OEImageGrid <OEDepict_OEImageGrid>` object.

* Finally, the image is written into a :file:`png` file.

The image created by :oe:src:`Listing 2<SNIPPET-SUB-SEARCH-ALIGN-SubSearchAlign>` is shown in
:ref:`Figure: Example of depiction with alignment based on substructure search<figure_ss_align>`.

.. oe:source:: SubSearchAlign.py
   :language: python
   :refnum:   2
   :caption:  Example of molecule alignment based on substructure search
   :frag:     SNIPPET-SUB-SEARCH-ALIGN

.. oe:source:: SubSearchAlign.cpp
   :language: c++
   :refnum:   2
   :caption:  Example of molecule alignment based on substructure search
   :frag:     SNIPPET-SUB-SEARCH-ALIGN

.. oe:source:: SubSearchAlign.java
   :language: java
   :refnum:   2
   :caption:  Example of molecule alignment based on substructure search
   :frag:     SNIPPET-SUB-SEARCH-ALIGN

.. oe:source:: SubSearchAlign.cs
   :language: csharp
   :refnum:   2
   :caption:  Example of molecule alignment based on substructure search
   :frag:     SNIPPET-SUB-SEARCH-ALIGN

.. _figure_ss_align:

.. figure:: depicttk/images/SubSearchAlign.*
   :align:  center

   **Example of depiction with alignment based on substructure match**

.. seealso::

   * :ref:`OESubSearch <OEChem_OESubSearch>` class in the **OEChem TK** manual
   * :ref:`OEImageGrid <OEDepict_OEImageGrid>` class
   * :oe:func:`OEDepict::OEAddHighlighting` function
   * :oe:func:`OEDepict::OERenderMolecule` function
   * :oe:func:`OEDepict::OEWriteImage` function
   * :ref:`section_examples_summary_smartsalign2D` example

.. _section_molalign_molsim:

Molecule Alignment Based on Molecular Similarity
================================================================================

The :ref:`Figure: Example of depiction without alignment<figure_fp_no_alignment>`
is generated by keeping the original orientation of the compounds.

.. _figure_fp_no_alignment:

.. figure:: depicttk/images/FPNoAlignment.*
   :align:  center

   **Example of depiction without alignment**

The :oe:src:`Listing 3<SNIPPET-FINGERPRINT-ALIGN-FPAlign>` code example shows how to align these
molecules based on their molecular similarity.

* First, two molecules are initialized from SMILES string and
  prepared for depiction.

* An :ref:`OEImageGrid <OEDepict_OEImageGrid>` object is constructed that allows
  to render the two molecules in a grid next to each other.

* The *fit* molecule is then aligned to the *reference*.
  The :oe:func:`OEGraphSim::OEGetFPOverlap` function is utilized to return all common fragments
  found between two molecules based on a given fingerprint type.
  These common fragments reveal the similar parts of the two molecules being compared that are
  used by the :oe:func:`OEDepict::OEPrepareMultiAlignedDepiction` function to find
  the best alignment between the molecules.
  See more fingerprint types in the :ref:`chapter_fptype` chapter of the  **GraphSim TK**
  manual.

* An :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object is initialized that
  stores the properties determine how the molecules are rendered.
  In order to render the molecules in equal size the smallest
  depiction scaling factor is calculated.

* Then both molecules are rendered into the separate cells of the
  grid layout, the image is written into a :file:`png` file.

The image created by :oe:src:`Listing 3<SNIPPET-FINGERPRINT-ALIGN-FPAlign>` is shown in
:ref:`Figure: Example of depiction with alignment based on molecular similarity<figure_fp_align>`.

.. note::

   **GraphSim TK** license in **not** required to run the :oe:src:`Listing 3<SNIPPET-FINGERPRINT-ALIGN-FPAlign>` example.

.. oe:source:: FPAlign.py
   :language: python
   :refnum:   3
   :caption:  Example of molecule alignment based on molecular similarity
   :frag:     SNIPPET-FINGERPRINT-ALIGN

.. oe:source:: FPAlign.cpp
   :language: c++
   :refnum:   3
   :caption:  Example of molecule alignment based on molecular similarity
   :frag:     SNIPPET-FINGERPRINT-ALIGN

.. oe:source:: FPAlign.java
   :language: java
   :refnum:   3
   :caption:  Example of molecule alignment based on molecular similarity
   :frag:     SNIPPET-FINGERPRINT-ALIGN

.. oe:source:: FPAlign.cs
   :language: csharp
   :refnum:   3
   :caption:  Example of molecule alignment based on molecular similarity
   :frag:     SNIPPET-FINGERPRINT-ALIGN

.. _figure_fp_align:

.. figure:: depicttk/images/FPAlign.*
   :align:  center

   **Example of depiction with alignment based on molecule similarity**

.. seealso::

   * :ref:`OEImageGrid <OEDepict_OEImageGrid>` class
   * :oe:func:`OEDepict::OERenderMolecule` function
   * :oe:func:`OEDepict::OEWriteImage` function

.. seealso::

   .. figure:: depicttk/images/OEPrepareMultiAlignedDepictionVisualize.*
      :align:  center

   The Python script that visualizes molecule similarity based on fingerprints
   can be downloaded from the
   `OpenEye Python Cookbook <http://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html>`_


.. _chapter_mol_display:

********************************************************************************
Molecule Depiction
********************************************************************************

The previous chapter introduced how to create images and draw basic
geometric elements (such as text, lines rectangles, etc.)
Drawing these basic graphical elements provides a framework to
construct more complex images such as molecular diagrams.

The molecule depiction is divided into two separate steps
(see :ref:`Figure: Process of Molecule Depiction<figure_mol_depiction>` ):

#. Generating 2D coordinates
#. Rendering molecule that involves

   - transforming and scaling coordinates in order to fit the
     molecule into an image with a specific width and height
   - setting atom and bond display properties based on depiction style
   - creating an image (such as drawing lines for bonds, drawing text for
     atomic labels)

.. _figure_mol_depiction:

.. figure:: depicttk/images/Depiction.*
   :align:  center

   **Process of molecule depiction**

The next example (:oe:src:`Listing 1<SNIPPET-DEPICT-MOL-SIMPLE-DepictMolSimple>`) demonstrates
how easy is to depict a molecule using the **OEDepict TK**.
After creating a molecule (for example by parsing a SMILES string) the
image can be generated by calling two functions.

#. The :oe:func:`OEDepict::OEPrepareDepiction` function prepares the
   molecule for depiction.  This process may involve perceiving atom
   and bond stereo information and suppressing or adding hydrogens.
   It also calls the :oe:func:`OEDepict::OEDepictCoordinates`
   function to generate the 2D coordinates of the molecule.

#. The :oe:func:`OEDepict::OERenderMolecule` function generates the
   image of the molecule using the default depiction styles and then
   writes the image into the given file.

The image created by :oe:src:`Listing 1<SNIPPET-DEPICT-MOL-SIMPLE-DepictMolSimple>` 
is shown in
:ref:`Figure: Example of depicting a molecule<figure_mol_display_simple>`.

.. oe:source:: DepictMolSimple.py
   :language: python
   :refnum:   1
   :caption:  Example of molecule depiction
   :frag:     SNIPPET-DEPICT-MOL-SIMPLE

.. oe:source:: DepictMolSimple.cpp
   :language: c++
   :refnum:   1
   :caption:  Example of molecule depiction
   :frag:     SNIPPET-DEPICT-MOL-SIMPLE

.. oe:source:: DepictMolSimple.java
   :language: java
   :refnum:   1
   :caption:  Example of molecule depiction
   :frag:     SNIPPET-DEPICT-MOL-SIMPLE

.. oe:source:: DepictMolSimple.cs
   :language: csharp
   :refnum:   1
   :caption:  Example of molecule depiction
   :frag:     SNIPPET-DEPICT-MOL-SIMPLE

.. _figure_mol_display_simple:

.. figure:: depicttk/images/DepictMolSimple.*
   :align:  center

   **Example of molecule depiction**

.. seealso::

   * :oe:func:`OEDepict::OEPrepareDepiction` function
   * :oe:func:`OEDepict::OERenderMolecule` function

.. _section_mol_display_customize:

Customizing Molecule Depiction
================================================================================

The previous example showed how to generate a molecule diagram with
default parameters.
**OEDepict TK** provides the ability to customize molecule depiction.
The :oe:src:`Listing 2<SNIPPET-DEPICT-MOL-SIZE-DepictMolSize>` example shows how to depict a
molecule width specific width and height parameters.

.. oe:source:: DepictMolSize.py
   :language: python
   :refnum:   2
   :caption:  Example of depicting a molecule
   :frag:     SNIPPET-DEPICT-MOL-SIZE

.. oe:source:: DepictMolSize.cpp
   :language: c++
   :refnum:   2
   :caption:  Example of depicting a molecule
   :frag:     SNIPPET-DEPICT-MOL-SIZE

.. oe:source:: DepictMolSize.java
   :language: java
   :refnum:   2
   :caption:  Example of depicting a molecule
   :frag:     SNIPPET-DEPICT-MOL-SIZE

.. oe:source:: DepictMolSize.cs
   :language: csharp
   :refnum:   2
   :caption:  Example of depicting a molecule
   :frag:     SNIPPET-DEPICT-MOL-SIZE

.. seealso::

   * :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class
   * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class

Apart from defining the dimensions of a depicted molecule, the
:ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class stores all properties
that determine how a molecule is depicted.
The following example shows how to set various depiction styles before
initializing the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object.
The image created by :oe:src:`Listing 3<SNIPPET-DEPICT-MOL-STYLE-DepictMolStyle>` is shown in
:ref:`Figure: Example of customizing depiction style<figure_mol_display_style>`.

.. oe:source:: DepictMolStyle.py
   :language: python
   :refnum:   3
   :caption:  Example of customizing the depiction style
   :frag:     SNIPPET-DEPICT-MOL-STYLE

.. oe:source:: DepictMolStyle.cpp
   :language: c++
   :refnum:   3
   :caption:  Example of customizing the depiction style
   :frag:     SNIPPET-DEPICT-MOL-STYLE

.. oe:source:: DepictMolStyle.java
   :language: java
   :refnum:   3
   :caption:  Example of customizing the depiction style
   :frag:     SNIPPET-DEPICT-MOL-STYLE

.. oe:source:: DepictMolStyle.cs
   :language: csharp
   :refnum:   3
   :caption:  Example of customizing the depiction style
   :frag:     SNIPPET-DEPICT-MOL-STYLE

.. _figure_mol_display_style:

.. figure:: depicttk/images/DepictMolStyle.*
   :align:  center

   **Example of customizing the depiction style**

Apart from controlling the depiction style through the
:ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class, **OEDepict TK** also provides
access to manipulate individual atom and bond 2D display properties.
The :oe:meth:`OEDepict::OE2DMolDisplay::GetAtomDisplays` method
returns an iterator over :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` objects
that store atom display information.
Similarly, the :oe:meth:`OEDepict::OE2DMolDisplay::GetBondDisplays` method
returns an iterator over :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` objects
that store bond display information.

The following example demonstrates how to change atom and bond display
properties and depict the graph of the molecule by ignoring atom
labels and setting bond display styles.
The image created by :oe:src:`Listing 4<SNIPPET-DEPICT-MOL-GRAPH-DepictMolGraph>` is shown in
:ref:`Figure:  Example of molecule graph depiction<figure_mol_display_graph>`.

.. oe:source:: DepictMolGraph.py
   :language: python
   :refnum:   4
   :caption:  Example of molecule graph depiction
   :frag:     SNIPPET-DEPICT-MOL-GRAPH

.. oe:source:: DepictMolGraph.cpp
   :language: c++
   :refnum:   4
   :caption:  Example of molecule graph depiction
   :frag:     SNIPPET-DEPICT-MOL-GRAPH

.. oe:source:: DepictMolGraph.java
   :language: java
   :refnum:   4
   :caption:  Example of molecule graph depiction
   :frag:     SNIPPET-DEPICT-MOL-GRAPH

.. oe:source:: DepictMolGraph.cs
   :language: csharp
   :refnum:   4
   :caption:  Example of molecule graph depiction
   :frag:     SNIPPET-DEPICT-MOL-GRAPH

.. _figure_mol_display_graph:

.. figure:: depicttk/images/DepictMolGraph.*
   :align:  center

   **Example of molecule graph depiction**

.. hint::

   Even though **OEDepict TK** provides the ability to manipulate
   atom and bond display properties of after the
   :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object is constructed,
   it is highly recommended to set the depiction properties using
   the :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class.
   Only by knowing all properties (such as labels, font styles and sizes *etc.*)
   in advance can one ensure the **best depiction layout** *i.e.* that
   the molecule diagram is rendered without any label clippings
   and the labels are displayed with the minimum number of overlaps.

.. seealso::

   * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` class
   * :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` class

.. _section_mol_display_size:

Controlling the Size of Depicted Molecules
================================================================================

The dimensions of a depicted molecule are controlled by the width,
height and scale parameters of the :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`
that is used to initialized the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object.
(See example in :oe:src:`Listing 2<SNIPPET-DEPICT-MOL-SIZE-DepictMolSize>`)

.. seealso::

   * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method
   * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetHeight` method
   * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetScale` method
   * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetWidth` method

If the width and the height of the image is not specified (set to be
zero), then scaling value determine the dimensions of the image.
(See examples in :ref:`Examples of image scaling<table_moldisplay_size_scale>`).
The default scale is defined to be :oe:const:`OEDepict::OEScale::Default`
constant, and the image may be enlarged or shrunk by specifying a
floating point scaling value.
For example, the scaling :oe:const:`OEDepict::OEScale::Default` *
``0.5`` generates an image a half of the default size, and scaling
:oe:const:`OEDepict::OEScale::Default` * ``1.5`` generates an image one
and a half times the default.

.. _table_moldisplay_size_scale:

.. list-table:: **Examples of image scaling** *(width = 0.0, height = 0.0)*
   :widths: 250 250 250
   :header-rows: 1

   * - OEScale::Default * 0.5
     - OEScale::Default
     - OEScale::Default * 1.5
   * - .. image:: images/DepictMol-Size-0-0-Half.*
          :align:  center
     - .. image:: images/DepictMol-Size-0-0-Default.*
          :align:  center
     - .. image:: images/DepictMol-Size-0-0-OneAndHalf.*
          :align:  center

If an :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object is initialized with
zero width and / or height, then the real dimensions of the image can be
accessed after creating an :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object.

.. oe:source:: DepictMolRealSize.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MOL-DISPLAY-DIMENSIONS

.. oe:source:: DepictMolRealSize.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MOL-DISPLAY-DIMENSIONS

.. oe:source:: DepictMolRealSize.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MOL-DISPLAY-DIMENSIONS

.. oe:source:: DepictMolRealSize.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MOL-DISPLAY-DIMENSIONS

The output of the preceding snippet is the following:

.. code-block:: console

   width  137.0
   height 181.0
   scale  50.0

.. seealso::

  :oe:meth:`OEDepict::OE2DMolDisplay::GetHeight` method
  :oe:meth:`OEDepict::OE2DMolDisplay::GetWidth` method
  :oe:meth:`OEDepict::OE2DMolDisplay::GetScale` method

If both the width and the height of are specified, then
:oe:const:`OEDepict::OEScale::AutoScale` scaling indicates
that the molecule is scaled to maximally fit the given dimensions.
The specified width and height will not be altered, not even if the
given scaling would require it *i.e* if necessary the scaling will be
reduced in order to fit the molecule into the given dimension.
(See examples in :ref:`Examples of image scaling<table_moldisplay_size_fixed>`).

.. _table_moldisplay_size_fixed:

.. list-table:: **Examples of fixed sized image** *(width = 120.0, height = 120.0)*
   :widths: 250 250 250
   :header-rows: 1

   * - OEScale::Default * 0.5
     - OEScale::Default
     - OEScale::Default * 1.5
   * - .. image:: images/DepictMol-Size-120-120-Half.*
          :align:  center
     - .. image:: images/DepictMol-Size-120-120-Default.*
          :align:  center
     - .. image:: images/DepictMol-Size-120-120-OneAndHalf.*
          :align:  center

.. note::

   Specifying a width and / or height larger than what is required by the
   scale, causes the molecule to float in the middle of the image of
   the requested size.

If only either the width or the height of the image is specified, then
the unspecified dimension will be set based on the scaling and the
specified width / height, respectively.

.. list-table::
   :widths: 250 250
   :header-rows: 1

   * - OEScale::Default, width = 250.0, height = 0.0
     - OEScale::Default, width = 0.0, height = 250.0
   * - .. image:: images/DepictMol-Size-250-0-Default.*
          :align:  center
     - .. image:: images/DepictMol-Size-0-250-Default.*
          :align:  center

.. _section_mol_display_transparent:

Molecule Depiction with Transparent Background
================================================================================

.. meta:
   :keywords: transparent

The following code snippet shows how to generate a molecule depiction with transparent
background.
First, the :ref:`OEImage <OEDepict_OEImage>` object, onto which the depiction is going to be rendered,
has to be constructed with the :oe:const:`OETransparentColor<OESystem::OESystem::OETransparentColor>`
color.
Then the :oe:func:`OEDepict::OERenderMolecule` function has to be called with a
parameter that ensures that the background in not cleared prior to rendering the molecule.

.. oe:source:: DepictMolTransparent.py
   :language: python
   :noindent:
   :frag:     SNIPPET-DEPICT-MOL-TRANSPARENT

.. oe:source:: DepictMolTransparent.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-DEPICT-MOL-TRANSPARENT

.. oe:source:: DepictMolTransparent.java
   :language: java
   :noindent:
   :frag:     SNIPPET-DEPICT-MOL-TRANSPARENT

.. oe:source:: DepictMolTransparent.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-DEPICT-MOL-TRANSPARENT

.. note:

   The **OEDepict TK** supports transparent background for :file:`png`, :file:`svg` and
   :file:`pdf` image files.

.. _section_mol_display_atom_prop:

Displaying Atom Properties
================================================================================

**OEDepict TK** provides ability the display atom properties as strings.
When a :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object is created, the
positions where atom properties can be displayed are calculated.
(see :ref:`Figure: Example of generating atom property positions<figure_mol_display_atom_prop>`.)

.. _figure_mol_display_atom_prop:

.. figure:: depicttk/images/OE2DAtomDisplay-GetPropertyOffset.*
   :align:  center

   **Example of generating atom property positions**

The following  example shows how to display the atom indices
by using the :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>` functor.
The font used to depict the atom property strings also can be
modified by using the
:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont`
method.
The image created by :oe:src:`Listing 5<SNIPPET-ATOM-PROP-INDEX-AtomPropIndex>` is shown in
:ref:`Figure: Example of displaying atom indices<figure_mol_display_atom_prop_idx>`.

.. oe:source:: AtomPropIndex.py
   :language: python
   :refnum:   5
   :caption:  Example of depicting atom indices
   :frag:     SNIPPET-ATOM-PROP-INDEX

.. oe:source:: AtomPropIndex.cpp
   :language: c++
   :refnum:   5
   :caption:  Example of depicting atom indices
   :frag:     SNIPPET-ATOM-PROP-INDEX

.. oe:source:: AtomPropIndex.java
   :language: java
   :refnum:   5
   :caption:  Example of depicting atom indices
   :frag:     SNIPPET-ATOM-PROP-INDEX

.. oe:source:: AtomPropIndex.cs
   :language: csharp
   :refnum:   5
   :caption:  Example of depicting atom indices
   :frag:     SNIPPET-ATOM-PROP-INDEX

.. _figure_mol_display_atom_prop_idx:

.. figure:: depicttk/images/AtomPropIndex.*
   :align:  center

   **Example of displaying atom indices**

.. hint::

   It is recommended to use the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor`
   method to define the atom property labels when the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`
   object is constructed.
   All labels displayed on the molecule diagram have to be known in advance in order to be
   able to minimize the number of label clashes and clippings when calculating
   the positions of the atom property labels.

.. seealso::

   **OEDepict TK** provides the following built-in atom property functors:

   * :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>` class
   * :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>` class
   * :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>` class

In order to display user-defined atom properties, the functor that is
passed to the
:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor`
method has to be derived from the :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>`
abstract base class.
The :oe:src:`Listing 6<SNIPPET-ATOM-PROP-USER-AtomPropUser>` example shows 
how to implement a user-defined functor that marks aromatic atoms.
The image created by :oe:src:`Listing 6<SNIPPET-ATOM-PROP-USER-AtomPropUser>` is shown in
:ref:`Figure: Example of displaying user-defined atom properties<figure_mol_display_atom_prop_user>`.

.. oe:source:: AtomPropUser.py
   :language: python
   :refnum:   6
   :caption:  Example of depicting user-defined atom properties
   :frag:     SNIPPET-ATOM-PROP-USER

.. oe:source:: AtomPropUser.cpp
   :language: c++
   :refnum:   6
   :caption:  Example of depicting user-defined atom properties
   :frag:     SNIPPET-ATOM-PROP-USER

.. oe:source:: AtomPropUser.java
   :language: java
   :refnum:   6
   :caption:  Example of depicting user-defined atom properties
   :frag:     SNIPPET-ATOM-PROP-USER

.. oe:source:: AtomPropUser.cs
   :language: csharp
   :refnum:   6
   :caption:  Example of depicting user-defined atom properties
   :frag:     SNIPPET-ATOM-PROP-USER

.. _figure_mol_display_atom_prop_user:

.. figure:: depicttk/images/AtomPropUser.*
   :align:  center

   **Example of displaying user-defined atom properties**

.. seealso::

   * :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>` class

.. _section_mol_display_bond_prop:

Displaying Bond Properties
================================================================================

Similarly to atom properties, bond properties can be
displayed as strings.
(see :ref:`Figure: Example of generating bond property positions<figure_mol_display_bond_prop>`.)

.. _figure_mol_display_bond_prop:

.. figure:: depicttk/images/OE2DBondDisplay-GetPropertyOffset.*
   :align:  center

   **Example of generating bond property positions**

The :oe:src:`Listing 7<SNIPPET-BOND-PROP-INDEX-BondPropIndex>` demonstrates how to 
display bond indices by using the :ref:`OEDisplayBondIdx <OEDepict_OEDisplayBondIdx>` functor.
The font used to depict the bond property strings can be
set by using the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont`
method.
The image created by :oe:src:`Listing 7<SNIPPET-BOND-PROP-INDEX-BondPropIndex>` is shown in
:ref:`Figure: Example of displaying bond indices<figure_mol_display_bond_prop_idx>`.

.. oe:source:: BondPropIndex.py
   :language: python
   :refnum:   7
   :caption:  Example of depicting bond indices
   :frag:     SNIPPET-BOND-PROP-INDEX

.. oe:source:: BondPropIndex.cpp
   :language: c++
   :refnum:   7
   :caption:  Example of depicting bond indices
   :frag:     SNIPPET-BOND-PROP-INDEX

.. oe:source:: BondPropIndex.java
   :language: java
   :refnum:   7
   :caption:  Example of depicting bond indices
   :frag:     SNIPPET-BOND-PROP-INDEX

.. oe:source:: BondPropIndex.cs
   :language: csharp
   :refnum:   7
   :caption:  Example of depicting bond indices
   :frag:     SNIPPET-BOND-PROP-INDEX

.. _figure_mol_display_bond_prop_idx:

.. figure:: depicttk/images/BondPropIndex.*
   :align:  center

   **Example of displaying bond indices**

.. hint::

   It is recommended to use the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor`
   method to define the bond property labels when the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`
   object is constructed.
   All labels displayed on the molecule diagram have to be known in advance in order to be
   able to minimize the number of label clashes and clippings when calculating
   the positions of the bond property labels.

.. seealso::

   **OEDepict TK** provides the following built-in bond property functors:

   * :ref:`OEDisplayBondIdx <OEDepict_OEDisplayBondIdx>` class
   * :ref:`OEDisplayNoBondProp <OEDepict_OEDisplayNoBondProp>` class

In order to display user-defined bond properties, the functor that is
passed to the
:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor`
method has to be derived from the :ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>`
abstract base class.
The :oe:src:`Listing 8<SNIPPET-BOND-PROP-USER-BondPropUser>` example shows how to implement a
user-defined functor that marks chain and ring bonds.
The image created by :oe:src:`Listing 8<SNIPPET-BOND-PROP-USER-BondPropUser>` is shown in
:ref:`Figure: Example of displaying user-defined bond properties<figure_mol_display_bond_prop_user>`.

.. oe:source:: BondPropUser.py
   :language: python
   :refnum:   8
   :caption:  Example of depicting user-defined bond properties
   :frag:     SNIPPET-BOND-PROP-USER

.. oe:source:: BondPropUser.cpp
   :language: c++
   :refnum:   8
   :caption:  Example of depicting user-defined bond properties
   :frag:     SNIPPET-BOND-PROP-USER

.. oe:source:: BondPropUser.java
   :language: java
   :refnum:   8
   :caption:  Example of depicting user-defined bond properties
   :frag:     SNIPPET-BOND-PROP-USER

.. oe:source:: BondPropUser.cs
   :language: csharp
   :refnum:   8
   :caption:  Example of depicting user-defined bond properties
   :frag:     SNIPPET-BOND-PROP-USER

.. _figure_mol_display_bond_prop_user:

.. figure:: depicttk/images/BondPropUser.*
   :align:  center

   **Example of displaying user-defined bond properties**

.. seealso::

   * :ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>` class

Hiding Atoms and Bonds
================================================================================

**OEDepict TK** provides ability the suppress the display of specific atom and bonds.
When a :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object is created, the
visibility of every atom is evaluated.  Bonds with both atom endpoints visible are also displayed.
(see :ref:`Figure: Example of hiding a portion of a structure<figure_rxn_display_hidden>`.)

The following  example shows how to selectively display only
a portion of the structure by using a custom class derived from
the :oe:cls:`OEUnaryAtomPred<OESystem::OEUnaryPredicate>` functor.
The images created by :oe:src:`Listing 9<SNIPPET-ATOM-VISIBILITY-AtomVisibility>` is shown in
:ref:`Figure: Example of hiding a portion of a structure<figure_rxn_display_hidden>`.

.. hint::

   It is recommended to use the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomVisibilityFunctor`
   method to identify the visible atoms when the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`
   object is constructed. All objects displayed on the molecule diagram have to be known in advance in order to be
   able to correctly size and scale the molecule.

.. oe:source:: AtomVisibility.py
   :language: python
   :refnum:   9
   :caption:  Example of selectively displaying atoms
   :frag:     SNIPPET-ATOM-VISIBILITY

.. oe:source:: AtomVisibility.cpp
   :language: c++
   :refnum:   9
   :caption:  Example of selectively displaying atoms
   :frag:     SNIPPET-ATOM-VISIBILITY

.. oe:source:: AtomVisibility.java
   :language: java
   :refnum:   9
   :caption:  Example of selectively displaying atoms
   :frag:     SNIPPET-ATOM-VISIBILITY

.. oe:source:: AtomVisibility.cs
   :language: csharp
   :refnum:   9
   :caption:  Example of selectively displaying atoms
   :frag:     SNIPPET-ATOM-VISIBILITY

.. _figure_rxn_display_hidden:

.. figure:: depicttk/images/AtomVisibility.*
   :align:  center

   **Example of hiding a portion of a structure**

Configuring Molecule Display
================================================================================

**OEDepict TK** provides a mechanism to generate a standard interface that
allows configuration of molecule displays.
By calling the :oe:func:`OEDepict::OEConfigureImageOptions` function,
"-height" and "width" parameters are added to the interface
(:ref:`OEInterface <OESystem_OEInterface>`), at run-time the value of these
parameters can be obtained by calling the
:oe:func:`OEDepict::OEGetImageHeight` and
:oe:func:`OEDepict::OEGetImageWidth` functions, respectively.
(See the standard interface displayed when calling  the 
:oe:src:`Listing 10<SNIPPET-MOL-CONFIGURE-DepictMolConfigure>` example
with the "--help" parameter)

The :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function
generates an interface that allows setting of various molecule display
options (such as aromatic style, atom and bond coloring etc.)
The :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object, that stores
properties determine the molecule depiction style, can initialized
based on to the command line parameters by calling the
:oe:func:`OEDepict::OESetup2DMolDisplayOptions` function.

.. oe:source:: DepictMolConfigure.py
   :language: python
   :refnum:   10
   :caption:  Example of configuring mol display
   :frag:     SNIPPET-MOL-CONFIGURE

.. oe:source:: DepictMolConfigure.cpp
   :language: c++
   :refnum:   10
   :caption:  Example of configuring mol display
   :frag:     SNIPPET-MOL-CONFIGURE

.. oe:source:: DepictMolConfigure.java
   :language: java
   :refnum:   10
   :caption:  Example of configuring mol display
   :frag:     SNIPPET-MOL-CONFIGURE

.. oe:source:: DepictMolConfigure.cs
   :language: csharp
   :refnum:   10
   :caption:  Example of configuring mol display
   :frag:     SNIPPET-MOL-CONFIGURE

.. oe:language:: c++

   .. code-block:: bash

      prompt> DepictMolConfigure --help

.. oe:language:: python

   .. code-block:: bash

      prompt> python DepictMolConfigure.py --help

.. oe:language:: java

   .. code-block:: bash

      prompt> java DepictMolConfigure --help

.. oe:language:: csharp

   .. code-block:: bash

      prompt> DepictMolConfigure --help

will generate the following standard interface:

.. code-block:: console

   Simple parameter list
       image options
         -height : Height of output image
         -width : Width of output image

       input/output
         -in : Input filename
         -out : Output filename

       molecule display options
         -aromstyle : Aromatic ring display style
         -atomcolor : Atom coloring style
         -atomprop : Atom property display
         -atomstereostyle : Atom stereo display style
         -bondcolor : Bond coloring style
         -bondprop : Bond property display
         -bondstereostyle : Bond stereo display style
         -hydrstyle : Hydrogen display style
         -linewidth : Default bond line width
         -protgroupdisp : Protective group display style
         -scale : Scaling of the depicted molecule
         -superdisp : Super atom display style
         -titleloc : Location of the molecule title

.. seealso::

   * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
   * :ref:`oedepict_chapter_examples_summary` chapter

**OEDepict TK** provides the following high-level functions to build
standard interface of depiction applications:

.. list-table::
   :widths: 250 250
   :header-rows: 1

   * - Function name
     - Builds standard interface for ..

   * - :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions`
     - molecule depiction style

   * - :oe:func:`OEDepict::OEConfigureHighlightParams`
     - highlighting

   * - :oe:func:`OEDepict::OEConfigureImageGridParams`
     - image grid

   * - :oe:func:`OEDepict::OEConfigureImageOptions`
     - image

   * - :oe:func:`OEDepict::OEConfigureMultiPageParams`
     - multi-page image

   * - :oe:func:`OEDepict::OEConfigurePrepareDepictionOptions`
     - preparing molecules for 2D depiction

   * - :oe:func:`OEDepict::OEConfigureReportOptions`
     -  multi-page report


.. _chapter_multipage:

********************************************************************************
Multi Page Images
********************************************************************************

Multi-page images can be generated by the usage of the
:ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` class.
After generating a multi-page object by specifying the orientation and
the size of its pages, the individual pages can be accessed by calling
the :oe:meth:`OEDepict::OEMultiPageImageFile::NewPage` method.
The returned :ref:`OEImage <OEDepict_OEImage>` then can be used to depict
molecule(s) as demonstrated in the previous chapters.
The image created by :oe:src:`Listing 1<SNIPPET-MULTIPAGE-MultiPage>` is shown in
:ref:`Figure: Example multi-page depiction<figure_multipage>`.

.. oe:source:: MultiPage.py
   :language: python
   :refnum:   1
   :caption:  Example of multi-page depiction
   :frag:     SNIPPET-MULTIPAGE

.. oe:source:: MultiPage.cpp
   :language: c++
   :refnum:   1
   :caption:  Example of multi-page depiction
   :frag:     SNIPPET-MULTIPAGE

.. oe:source:: MultiPage.java
   :language: java
   :refnum:   1
   :caption:  Example of multi-page depiction
   :frag:     SNIPPET-MULTIPAGE

.. oe:source:: MultiPage.cs
   :language: csharp
   :refnum:   1
   :caption:  Example of multi-page depiction
   :frag:     SNIPPET-MULTIPAGE

.. _figure_multipage:

.. list-table:: **Example multi-page depiction** (The pages are reduced here for visualization convenience)
   :widths: 150 150 
   :header-rows: 1

   * - page 1
     - page 2
   * - .. image:: images/MultiPage-1.*
         :align:  center
     - .. image:: images/MultiPage-2.*
         :align:  center
 
The :oe:src:`Listing 1<SNIPPET-MULTIPAGE-MultiPage>` example creates a :file:`PDF` multi-page image
file, the multi-page image types supported by **OEDepict TK** can be accessed by
calling the :oe:func:`OEDepict::OEGetSupportedMultiPageImageFileExtensions`
function.
It returns an iterator over the file extensions that can be used when
writing a multi-page  image file by the
:oe:func:`OEDepict::OEWriteMultiPageImage` function.

.. _section_multipage_report:

Multi Page Reports
================================================================================

The :oe:src:`Listing 1<SNIPPET-MULTIPAGE-MultiPage>` example illustrates how depict a set of
molecules in a multi-page :file:`PDF` using the :ref:`OEImageGrid <OEDepict_OEImageGrid>`
and :ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` classes.
**OEDepict TK** also provides the :ref:`OEReport <OEDepict_OEReport>` class to do
this task in a more convenient way.
The :ref:`OEReport <OEDepict_OEReport>` class is a multi-page layout manager that
handles the page generation and the positioning of information
(such as text and molecule depiction).

In the :oe:src:`Listing 2<SNIPPET-MULTIPAGE-REPORT-MultiPageReport>` example, first a
:ref:`OEReportOptions <OEDepict_OEReportOptions>` object is created that stores
all properties that determine the layout of a documentation.
After generating the :ref:`OEReport <OEDepict_OEReport>` object a
molecule can be positioned on a cell that is returned by
the :oe:meth:`OEDepict::OEReport::NewCell` method.
The :oe:meth:`OEDepict::OEReport::NewCell` method creates cells
from left to right and top to bottom order on each page.
If no more cells are left on the page, then a new page is created
before returning the first cell of this new page.

After the document is generated, *i.e* all molecule are depicted,
the :oe:func:`OEDepict::OEWriteReport` function writes the multi-page
documentation into into a file with the given name.
The image created by the :oe:src:`Listing 2<SNIPPET-MULTIPAGE-REPORT-MultiPageReport>` example is the
same as depicted in :ref:`Figure: Example multi-page depiction<figure_multipage>`.

.. oe:source:: MultiPageReport.py
   :language: python
   :refnum:   2
   :caption:  Example of multi-page depiction using OEReport
   :frag:     SNIPPET-MULTIPAGE-REPORT

.. oe:source:: MultiPageReport.cpp
   :language: c++
   :refnum:   2
   :caption:  Example of multi-page depiction using OEReportOptions
   :frag:     SNIPPET-MULTIPAGE-REPORT

.. oe:source:: MultiPageReport.java
   :language: java
   :refnum:   2
   :caption:  Example of multi-page depiction using the OEReport class
   :frag:     SNIPPET-MULTIPAGE-REPORT

.. oe:source:: MultiPageReport.cs
   :language: csharp
   :refnum:   2
   :caption:  Example of multi-page depiction using the OEReport classes
   :frag:     SNIPPET-MULTIPAGE-REPORT

.. seealso::

   * :ref:`OEReportOptions <OEDepict_OEReportOptions>` class
   * :ref:`OEReport <OEDepict_OEReport>` class



.. _oedepict_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version2_7_0
   version2_6_0
   version2_5_6
   version2_5_5
   version2_5_4
   version2_5_3
   version2_5_2
   version2_5_1
   version2_5_0
   version2_4_7
   version2_4_6
   version2_4_5
   version2_4_4
   version2_4_3
   version2_4_2
   version2_4_1
   version2_4_0
   version2_3_6
   version2_3_5
   version2_3_4
   version2_3_3
   version2_3_2
   version2_3_1
   version2_3_0
   version2_2_6
   version2_2_5
   version2_2_4
   version2_2_3
   version2_2_2
   version2_2_1
   version2_2_0
   version2_1_0
   version2_0_4
   version2_0_3
   version2_0_2
   version2_0_1
   version2_0_0



OEDepict TK 2.7.0
================================================================================

New Features
--------------------------------------------------------------------------------

* Two new methods, :ref:`GetOptimizeMacrocycles<OEDepict_OEPrepareDepictionOptions_GetOptimizeMacrocycles>` and
  :ref:`SetOptimizeMacrocycles<OEDepict_OEPrepareDepictionOptions_SetOptimizeMacrocycles>`, have been
  added to :ref:`OEPrepareDepictionOptions<OEDepict_OEPrepareDepictionOptions>` to enable enhanced
  algorithmic depiction of macrocycle rings.


OEDepict TK 2.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* Using :ref:`OE2DPoint <OEDepict_OE2DPoint>` that represents coordinates
* Using :ref:`OEColor <OESystem_OEColor>` that handles transparency
* Adding :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class that allows
  color ramping   
* Supporting various font properties (:ref:`OEFont <OEDepict_OEFont>`)
     - size
     - color 
     - style (italic, bold) (:oe:constns:`OEDepict::OEFontStyle`)
     - family  (Arial, Helvetica, etc.) (:oe:constns:`OEDepict::OEFontFamily`)
* Supporting various line properties (:ref:`OEPen <OEDepict_OEPen>`)
     - line width
     - background, foreground color 
     - various stipple styles (:oe:constns:`OEDepict::OEStipple`)
     - standard line join, line cup styles (:oe:constns:`OEDepict::OELineJoin`, :oe:constns:`OEDepict::OELineCap`)
* Providing convenient molecule depiction that is highly customizable (:ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`)
    * different aromatic ring representations (:oe:constns:`OEDepict::OEAromaticStyle`)     
    * atom coloring (monochrome, CPK)  (:oe:constns:`OEDepict::OEAtomColorStyle`)  
    * bond coloring (atom-based, monochrome) (:oe:constns:`OEDepict::OEBondColorStyle`)  
    * various atom stereo representations  (:oe:constns:`OEDepict::OEAtomStereoStyle`)  
    * various bond stereo representations  (:oe:constns:`OEDepict::OEBondStereoStyle`)  
    * various explicit/implicit hydrogen representations (:oe:constns:`OEDepict::OEHydrogenStyle`) 
    * depicting atom properties (:ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>`)
    * depicting bond properties (:ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>`)
    * setting atom label, atom and bond property label font styles 
    * various super atom styles (:oe:constns:`OEDepict::OESuperAtomStyle`)
* Depicting atom radicals (:oe:constns:`OEDepict::OERadicalDisplayType`)
* Adding the :oe:func:`OEDepict::OEPrepareDepiction` function that
  prepares a molecule before depiction.
* Adding the :oe:func:`OEDepict::OEPrepareAlignedDepiction` function that
  generates 2D-coordinates of a molecule to maximize its alignment to a
  reference molecule.
* Introducing the :ref:`OEImageFrame <OEDepict_OEImageFrame>` and
  the :ref:`OEImageGrid <OEDepict_OEImageGrid>` classes that allows various molecule
  layouts (see the :ref:`Molecule Layouts<chapter_image_layout>` chapter)
* Implementing three customizable highlighting styles and allowing to
  utilize user-defined ones (see also the :ref:`Highlighting<chapter_highlighting>` chapter)
  - ball and stick (:ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>`)
  - color (:ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>`)
  - stick (:ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>`)
* Adding the :oe:func:`OEDepict::OEAddHighlighting` function that 
  helps to highlight atoms and/or bonds 
* Implementing three arrow drawing functions:
  * :oe:func:`OEDepict::OEDrawEquilibriumArrow`
  * :oe:func:`OEDepict::OEDrawReactionArrow`
  * :oe:func:`OEDepict::OEDrawResonanceArrow`
* Adding functions that automatically generate standard interfaces for 
  OEDepict applications:
  - :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions`
  - :oe:func:`OEDepict::OEConfigureHighlightParams`
  - :oe:func:`OEDepict::OEConfigureImageGridParams`
  - :oe:func:`OEDepict::OEConfigureMultiPageParams`
* Adding various rendering functions (:oe:func:`OEDepict::OERenderMolecule`)
* Adding functions to write images (:oe:func:`OEDepict::OEWriteImage`)
* Supporting the following image file formats:

  ======================================= =====================
  Graphics File Format                    File Extension       
  ======================================= =====================
  PNG (Portable Network Graphics)         :file:`.png`         
  SVG (Scalable Vector Graphics)          :file:`.svg`         
  *bare* SVG (with no header)             :file:`.bsvg`        
  Postscript                              :file:`.ps`          
  Encapsulated PostScript                 :file:`.eps`         
  PDF (Portable Document Format)          :file:`.pdf`         
  ======================================= =====================

.. oe:language:: python java

   .. note:: 

      *PNG* support is based upon the `cairo graphics library
      <http://cairographics.org>`_ on Linux. Most linux distributions
      install this shared library by default, but it may be possible
      for a super stripped down installation to not include
      it. **OEDepict TK** has no specific version requirement for this
      library, so the *cairo* package can be installed through
      traditional distribution specific means: rpm, yum, yast, zypper,
      etc.

.. oe:language:: c++

   .. note:: 

      *PNG* support is based upon the `cairo graphics library
      <http://cairographics.org>`_ on Linux. Building a C++
      application with *PNG* support will require a version
      of *libcairo* to be installed. **OEDepict TK** has no specific
      version requirement for this library, so the *cairo*
      package can be installed through traditional distribution
      specific means: rpm, yum, yast, zypper, etc.

      It is also possible to link to a version of **OEDepict TK**
      without any dependency on *libcairo* by linking
      *oedepict-noraster* instead.

* Supporting multi-page images (see the :ref:`Multi Page Image<chapter_multipage>` chapter)
* Supporting to depict MDL queries (see the :ref:`MDL Query Depiction<chapter_mdlquery>` chapter)
* Supporting MDL reaction depiction (see the :ref:`MDL Reaction Depiction<chapter_mdlreaction>` chapter)
* Providing more than 40 example codes in four different languages
  (C++, Python, Java, C#) that demonstrate the functionalities of the
  the new toolkit.
* Providing 10 C++ applications (see the
  :ref:`OEDepict Examples Summary<oedepict_chapter_examples_summary>` chapter)

.. _release_notes_deprecated_ogham:

Deprecated Ogham 
--------------------------------------------------------------------------------

The following classes, functions and namespaces are **not** going to be supported
any longer and will be deprecated in the future:  

  Deprecated Ogham classes:

  * ``OE8BitImage``
  * ``OEAtomStyle``
  * ``OEBondStyle``
  * ``OEDepictBase``
  * ``OEDepictColor``
  * ``OEDepictView``
  * ``OEPSImage``
  * ``OEPoly``
  * ``OEPolyF``
  * ``OESVGImage``
  * ``OEVert``
  * ``OEVertF``

  Deprecated Ogham functions:

  * ``OEWriteBMP``
  * ``OEWriteEPS``
  * ``OEWriteGIF``
  * ``OEWritePPM``
  * ``OEWriteRGB``
  * ``OEWriteXPM``

  Deprecated Ogham namespace:

  * ``OENamedColor``


OEDepict TK 2.0.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* On creation of an :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object its scale is adjusted
  by the average bond length of the original 2D coordinates of the molecule.
  This affected any rendering where the 2D coordinates are not generated by OEDepict.

* Speed optimization of the :oe:func:`OEDepict::OEPrepareAlignedDepiction` 
  function were added.

.. oe:language:: python

   * Adding mol2img python example



OEDepict TK 2.0.2
================================================================================

New features
--------------------------------------------------------------------------------

* Adding a scaling factor that can be used to increase or decrease the size
  of the fonts used to depict atom properties.
  (:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale`)

* Adding a scaling factor that can be used to increase or decrease the size
  of the fonts used to depict bond properties.
  (:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale`)

.. oe:language:: python

   * Adding the following examples:

     * :ref:`depict.py<section_examples_summary_depict>`
     * :ref:`match2img.py<section_examples_summary_match2img>`
     * :ref:`mcsalign2D.py<section_examples_summary_mcsalign2D>`
     * :ref:`mdlquery2img.py<section_examples_summary_mdlquery2img>`
     * :ref:`mdlreaction2img.py<section_examples_summary_mdlreaction2img>`
     * :ref:`mols2pdf.py<section_examples_summary_mols2pdf>`
     * :ref:`mols2img.py<section_examples_summary_mols2img>`
     * :ref:`smartsalign2D.py<section_examples_summary_smartsalign2D>`
     * :ref:`viewmdlsearch.py<section_examples_summary_viewmdlsearch>`

.. oe:language:: java

   * Adding the following examples:

     * :ref:`Depict.java<section_examples_summary_depict>`
     * :ref:`Match2Img.java<section_examples_summary_match2img>`
     * :ref:`MCSAlign2D.java<section_examples_summary_mcsalign2D>`
     * :ref:`MDLQuery2Img.java<section_examples_summary_mdlquery2img>`
     * :ref:`MDLReaction2Img.java<section_examples_summary_mdlreaction2img>`
     * :ref:`Mol2Img.java<section_examples_summary_mol2img>`
     * :ref:`Mols2Img.java<section_examples_summary_mols2img>`

.. oe:language:: csharp

   * Adding the following examples:

     * :ref:`Depict.cs<section_examples_summary_depict>`
     * :ref:`Match2Img.cs<section_examples_summary_match2img>`
     * :ref:`MCSAlign2D.cs<section_examples_summary_mcsalign2D>`
     * :ref:`MDLQuery2Img.cs<section_examples_summary_mdlquery2img>`
     * :ref:`MDLReaction2Img.cs<section_examples_summary_mdlreaction2img>`
     * :ref:`Mol2Img.cs<section_examples_summary_mol2img>`
     * :ref:`Mols2Img.cs<section_examples_summary_mols2img>`

*  The constructor of the :ref:`OEImage <OEDepict_OEImage>` class now takes a
   background color that is used to clear the image upon construction.
   A :file:`.png` image with transparent background can be generated by
   using the :oe:const:`OETransparentColor<OESystem::OESystem::OETransparentColor>`
   color as a background color when constructing an :ref:`OEImage <OEDepict_OEImage>`
   object.

*  Fixing the run-time initialization of the color that is used to
   depict super atoms.

Major bug fixes
--------------------------------------------------------------------------------

* The cairo graphics library (http://cairographics.org) used to draw
  :file:`.png` images on Linux has a bug where it is not thread safe
  when rendering text. **OEDepict TK** now performs its own mutual
  exclusion when calling into the cairo graphics library for text
  rendering to ensure thread safety.

* Improving the depiction of super atoms
  (See examples in the :oe:constns:`OEDepict::OESuperAtomStyle` namespace)

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEDepict::OERenderMolecule` called with an image and a
  molecule now uses the width and height of the image being passed.

* Fixing a problem where isolated atoms were not highlighted when using
  the :oe:const:`OEDepict::OEHighlightStyle::Color` and
  :oe:const:`OEDepict::OEHighlightStyle::Stick` highlighting styles.
 
* :oe:func:`OEDepict::OEDepictCoordinates` throws a warning when trying
  to generate 2D coordinates for a two member ring, for example,
  ``C1N1``. The function will then fall back to trying to generate
  coordinates for those atoms as a chain.

* The :oe:func:`OEChem::OEDisassembleExpressions` function tags atoms
  and bonds of the query molecule that can later be used by the
  :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` constructor when creating atom and
  bond displays. 
 
* Throwing a warning when attempting to draw a line or an arc with
  the :oe:const:`OEDepict::OEStipple::NoLine` pen property.
  Throwing a warning when attempting to draw a rectangle, circle, triangle
  or a polygon with :oe:const:`OEDepict::OEStipple::NoLine` and
  :oe:const:`OEDepict::OEFill::Off` pen properties.

* Making sure that no radical dots are displayed for a query atom that
  has implicit hydrogen count information.

* Before registering an aromatic ring for the
  :oe:const:`OEDepict::OEAromaticStyle::Circle` style,
  a check is performed to ensure that the detected ring is not a
  fused ring of two smaller rings.
 
* Making the background color consistent for the monochrome atom color
  styles.
  (See:  :oe:const:`OEDepict::OEAtomColorStyle::WhiteMonochrome` and
  :oe:const:`OEDepict::OEAtomColorStyle::BlackMonochrome`)

* When two molecules are aligned by calling the
  :oe:func:`OEDepict::OEPrepareAlignedDepiction`
  function, the fit molecule is scaled by the average bond length of the
  reference molecule.

Deprecated Ogham
--------------------------------------------------------------------------------

* Deprecating the ``OEDepictFixedCoordinates`` function.
  For molecule alignment, please use the :oe:func:`OEDepict::OEPrepareAlignedDepiction`
  function.

Documentation changes
--------------------------------------------------------------------------------

* Renaming the Application chapter to
  :ref:`OEDepict Examples Summary<oedepict_chapter_examples_summary>`
  and inserting the source code of the examples into the
  `Examples` chapter.

* Adding code snippets for the :oe:func:`OEDepict::OEAddHighlighting` function.

* Describing the layout of a depicted atom in the :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>`
  class.

* All images in this manual are now automatically generated as part of the release
  process and tested against benchmark images on all supported platforms.


OEDepict TK 2.0.3
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEDepict::OEDrawCurvedArrow` function added.

* :oe:func:`OEDepict::OEPrepareAlignedDepiction` now allows more
  advanced customization of the alignment process through the
  :ref:`OEAlignmentOptions <OEDepict_OEAlignmentOptions>` class.

* **OEChem TK's** new RMSD method is used in the molecule alignment
  process to improvement alignment performance.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEDepict::OEPrepareAlignedDepiction` performance
  improvement of 10% on average. 

* Windows :file:`png` images have been improved in the following ways:

  * Dash patterns for line drawing corrected.

  * Gamma correction turned off when colors are blended with
    background colors. As a result the generated :file:`png` images
    look sharper.

  * Text anti-aliasing methodology is now dependent on the font size
    to ensure fonts look good at all sizes. The method of
    anti-aliasing changes when increasing the font size from 8 to 9.

* The following atom label layout changes: 

  * If the atom has a charge, then it is rendered as a super-script on
    the right side of the atomic label.
    In the case when the implicit hydrogen symbol is placed on the right
    side of the atom, then the charge also follows the hydrogen symbol.
    (See section GR 5.1 in [Brecher-2008]_ )

  * The dot(s) representing the radical atom follows the atoms' element
    symbol on the left side.
    In the case when the implicit hydrogen symbol is placed on the right
    side of the atom, then the radical dot(s) also follows the hydrogen
    symbol.
    (See section GR 5.3 in [Brecher-2008]_ )

* Atom labels clashing with bonds have been improved by shortening the
  length of the depicted bond in certain cases. 

* MDL query molecule atom label rendering has been improved. 

* :oe:func:`OEDepict::OEDepictCoordinates` clash detection has been
  improved to avoid unnecessary stretching of the bonds of explicit
  hydrogens. A tolerance has been introduced that allows smaller
  distances between hydrogen atoms.

.. oe:language:: csharp

   * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` no longer crashes due to early
     garbage collection of the molecule.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale`
  upper limit has been increased from `2.0` to `3.0`. 

* New fused ring system templates added. 

* Atom and bond highlighting now scales with the molecule instead of the
  dimension of the image.

* Aromatic circles now ignore the fill style of the circle. 

* The following methods will now throw warnings if given nonsensical
  arguments:

  * :oe:meth:`OEDepict::OEImage::DrawCircle`
  * :oe:meth:`OEDepict::OEImage::DrawArc`
  * :oe:meth:`OEDepict::OEImage::DrawLine`
  * :oe:meth:`OEDepict::OEImage::DrawPolygon`
  * :oe:meth:`OEDepict::OEImage::DrawRectangle`
  * :oe:meth:`OEDepict::OEImage::DrawText`
  * :oe:meth:`OEDepict::OEImage::DrawTriangle`

  This should make drawing mistakes appear earlier in development,
  instead of only when they are rendered to a specific file format. 

* :oe:meth:`OEDepict::OE2DMolDisplay::GetAtomDisplay` and 
  :oe:meth:`OEDepict::OE2DMolDisplay::GetBondDisplay` no longer
  incorrectly check the atom and bond indices. 

* :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` constructors
  now throw a warning when a molecule being depicted has 3D
  coordinates and throw an error if the molecule has no coordinates.

* :oe:meth:`OEDepict::OEImage::Clear` is now called when
  constructing a new :ref:`OEImage <OEDepict_OEImage>` object.

Documentation changes
--------------------------------------------------------------------------------

* All images are automatically regenerated to reflect the changes made
  since the previous release.

..
    # comment

    Database ACD taking the first 1000 molecules between the heavy atom
    range [5-50] and aligning them if the MCSS match is greater
    than 2 atoms.

    version: toolkits2012_Feb
    Total: 963020 alignments processed.
    number of alignments 963020
    total 54024.622 sec
    alignment 53691.273 sec (0.055753 sec/alignment)
    avg rmsd 0.265

    version: master before tagging  (April 6) OEDEBUG turned off
    Total: 963020 alignments processed.
    number of alignments 963020
    total 49194.596 sec
    alignment 48871.690 sec (0.050748 sec/alignment)
    avg rmsd 0.266


OEDepict TK 2.0.4
================================================================================

New features
--------------------------------------------------------------------------------

* Pie drawing, semi-circle, methods added to the following classes:

  * :oe:meth:`OEDepict::OEImageBase<OEDepict::OEImageBase::DrawPie>`
  * :oe:meth:`OEDepict::OEImage<OEDepict::OEImage::DrawPie>`
  * :oe:meth:`OEDepict::OEImageFrame<OEDepict::OEImageFrame::DrawPie>`

* An example of a python-based web interface and web service have been added.
  The code for this example was on GitHub, as it required multiple files.

* Enabling the depiction of MDL's enhanced stereochemical
  representation by default. 
  See the :oe:const:`OEDepict::OEAtomStereoStyle::Display::MDLStereoCenter` constant.

Major bug fixes
--------------------------------------------------------------------------------

* The following molecule depiction defaults have been changed:

  * The background color is now pure white instead of a very light grey.
  * The bond width is now 2.0 instead of 1.0. 

  See the effect of these changes in :ref:`Table: Example of default molecule depictions
  <table_ExampleDepictionChange>`.

  .. _table_ExampleDepictionChange:

  .. list-table::  **Example of default molecule depictions**

     * - **OEDepict TK 2.0.3**
       - **OEDepict TK 2.0.4**
     * - .. image:: ../../depicttk/images/releasenotes-2.0.4/DepictMolSimple-toolkits2012_Jun.*
       - .. image:: ../../depicttk/images/releasenotes-2.0.4/DepictMolSimple-toolkits2012_Oct.*

Minor bug fixes
--------------------------------------------------------------------------------

* Adding the depiction of R-groups for molecules that have not been
  initialized from a MDL query file. See the example the in the
  :ref:`Table: Example of depicting R-Groups
  <table_ExampleOfRGroupDepiction>`.

  .. _table_ExampleOfRGroupDepiction:

  .. list-table::  **Example of depicting R-Groups**

     * - **OEDepict TK 2.0.3**
       - **OEDepict TK 2.0.4**
     * - .. image:: ../../depicttk/images/releasenotes-2.0.4/RGroupFromSmiles-toolkits2012_Jun.*
       - .. image:: ../../depicttk/images/releasenotes-2.0.4/RGroupFromSmiles-toolkits2012_Oct.*

* Fixed a bug that would erroneously hide the following types of hydrogens in a depiction:

  * isolated hydrogens
  * charged hydrogens
  * hydrogen isotopes

* Fused ring system templates added for 29 different types of complex
  depiction cases. 

* :oe:meth:`OEDepict::OE2DAtomDisplay::SetHCount` method will now place
  the hydrogen position correctly as returned by
  :oe:meth:`OEDepict::OE2DAtomDisplay::GetHPosition`, i.e., the
  position relative to the heavy atom. An incorrect position was
  possible when generating 2D coordinates with
  :oe:func:`OEDepict::OEPrepareDepiction` with the parameter
  ``suppressH`` set to ``false``.

* The stipple factor of a line in now based on the line width
  instead of the scaling factor of the molecule display. 

  .. list-table::  **Example of line width affecting the stipple factor**

     * - **OEDepict TK 2.0.3**
       - **OEDepict TK 2.0.4**
     * - .. image:: ../../depicttk/images/releasenotes-2.0.4/MoleculeAromaticDash-toolkits2012_Jun.*
       - .. image:: ../../depicttk/images/releasenotes-2.0.4/MoleculeAromaticDash-toolkits2012_Oct.*

* Atom stereo depiction improved: 
 
  * The number of individual lines used in the :oe:const:`OEDepict::OEBondDisplayType::Hash` and 
    the :oe:const:`OEDepict::OEBondDisplayType::Wavy` stereo bonds now
    depends on the bond width.
  * Heuristic used to shorten hash and wedge stereo bonds improved. 

  See the effect of these improvements in :ref:`Table: Example of depicting atom stereo
  <table_ExampleStereoBond>`.

  .. _table_ExampleStereoBond:

  .. list-table::  **Example of depicting atom stereo**

     * - **OEDepict TK 2.0.3**
       - **OEDepict TK 2.0.4**
     * - .. image:: ../../depicttk/images/releasenotes-2.0.4/StereoBond-toolkits2012_Jun.*
       - .. image:: ../../depicttk/images/releasenotes-2.0.4/StereoBond-toolkits2012_Oct.*

* :oe:const:`OEDepict::OEBondDisplayType::Any` bond type will now
  properly set the stipple factor for the end pen of that bond.

* Fixing the problem when the default atom label colors were not updated
  after atom color style change.
  For example when setting the atom color style to
  :oe:const:`OEDepict::OEAtomColorStyle::WhiteMonochrome`
  the super atoms remained pink rather than changed to black.
  See the effect of fix in :ref:`Table: Example of using the 'WhiteMonochrome'
  atom color style <table_WhiteMonochrome>`.

  .. _table_WhiteMonochrome:

  .. list-table::  **Example of using the 'WhiteMonochrome' atom color style**

     * - **OEDepict TK 2.0.3**
       - **OEDepict TK 2.0.4**
     * - .. image:: ../../depicttk/images/releasenotes-2.0.4/WhiteMonochrome-toolkits2012_Jun.*
       - .. image:: ../../depicttk/images/releasenotes-2.0.4/WhiteMonochrome-toolkits2012_Oct.*

Documentation changes
--------------------------------------------------------------------------------

* All images are automatically regenerated to reflect the changes made
  since the previous release.


OEDepict TK 2.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* Added a new highlighting style, :oe:const:`OEDepict::OEHighlightStyle::Cogwheel`,
  and the corresponding highlighting class :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>`.

* Added accessor methods for many parameters to the following highlighting classes:

  * :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>`
  * :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>`
  * :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>`

* Added :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondWidthScaling` method
  that allows line width of the bonds to be increased or decreased based upon
  the molecule scaling factor.

* Added the following classes and functions to provide a convenient way to
  generate multi-page reports.

  * :ref:`OEReportOptions <OEDepict_OEReportOptions>` and :ref:`OEReport <OEDepict_OEReport>` classes
  * :oe:func:`OEDepict::OEConfigureReportOptions` and :oe:func:`OEDepict::OESetupReportOptions` functions
  * :oe:func:`OEDepict::OEWriteReport` function

.. oe:language:: csharp

   * Fixed a bug in LineStipple in the C# native OEMolDepiction implementation. 
     And added the missing DrawPie() method.

.. oe:language:: c++

   * Reimplemented the following C++ **OEDepict TK** examples by utilizing the
     new :ref:`OEReport <OEDepict_OEReport>` class:

     * :ref:`mols2pdf<section_examples_summary_mols2pdf>`
     * :ref:`viewmdlsearch<section_examples_summary_viewmdlsearch>`

.. oe:language:: python

   * Reimplemented the following Python **OEDepict TK** examples by utilizing the
     new :ref:`OEReport <OEDepict_OEReport>` class:

     * :ref:`mols2pdf.py<section_examples_summary_mols2pdf>`
     * :ref:`viewmdlsearch.py<section_examples_summary_viewmdlsearch>`

.. oe:language:: java

   * Implemented the following Java **OEDepict TK** examples:

     * :ref:`Mols2PDF<section_examples_summary_mols2pdf>`
     * :ref:`ViewMDLSearch<section_examples_summary_viewmdlsearch>`
     * :ref:`SMARTSAlign2D<section_examples_summary_smartsalign2D>`

.. oe:language:: csharp

   * Implemented the following C# **OEDepict TK** examples:

     * :ref:`Mols2PDF<section_examples_summary_mols2pdf>`
     * :ref:`ViewMDLSearch<section_examples_summary_viewmdlsearch>`
     * :ref:`SMARTSAlign2D<section_examples_summary_smartsalign2D>`

* Added the :oe:meth:`OEDepict::OEMultiPageImageFile::GetPage` method that
  provides access to the individual pages of a multi-page image file.

* Added the :oe:func:`OEDepict::OEConfigureImageGridNumColumns` and
  :oe:func:`OEDepict::OEConfigureImageGridNumRows` functions to take
  the default number of columns and rows.

* :oe:func:`OEDepict::OEPrepareAlignedDepiction` has been improved the
  generate better 2D molecule alignments by:

  * Allowing rotations around unspecified cis/trans double bonds
  * Refining the method that scores alignments based on internal atom clashes

Major bug fixes
--------------------------------------------------------------------------------

* Added darker default colors for some of the elements for the
  :oe:const:`OEDepict::OEAtomColorStyle::WhiteCPK` color scheme.
  See the effect of these changes in :ref:`Table: Example of default element color changes
  <table_ElementColors>`.

  .. _table_ElementColors:

  .. list-table:: **Example of default element color changes**

     * - **OEDepict TK 2.0.4**
       - **OEDepict TK 2.1.0**
     * - .. image:: ../../depicttk/images/releasenotes-2.1.0/PeriodicTable-WhiteCPK-Example-toolkits2012_Oct.*
       - .. image:: ../../depicttk/images/releasenotes-2.1.0/PeriodicTable-WhiteCPK-Example-toolkits2013_Feb.*

Minor bug fixes
--------------------------------------------------------------------------------

* Fixed the coordinate system to start from the top-left corner for
  raster images on OS X when using the
  :oe:meth:`OEDepict::OEImageBase::DrawPoint` method. This was causing
  images to appear flipped around the y-axis.

* The colors for :oe:func:`OEDepict::OEGetHighlightColor` were
  sometimes not initialized properly due to undefined library
  initialization order. This was causing the function to always return
  white.

* Atoms that have both the atomic number and the atom map index of
  zero will now be rendered as ``*``.

* Synchronized code examples in all four supported languages
  (C++, Python, Java and C#) to ensure that they have the same behavior
  and generate identical images.

* :oe:func:`OEDepict::OEPrepareDepiction` and
  :oe:func:`OEDepict::OEDepictCoordinates` could crash or generate
  random coordinates for molecules with adjacent spiro centers.

.. oe:language:: python

   * Methods that return a :ref:`OE2DPoint <OEDepict_OE2DPoint>` reference,
     e.g. :oe:meth:`OEDepict::OE2DAtomDisplay::GetCoords`, will now
     return a copy of the :ref:`OE2DPoint <OEDepict_OE2DPoint>` instead in
     Python to avoid destructor ordering problems.

   * Wrapping the following methods in Python:

     * :oe:meth:`OEDepict::OE2DPoint::operator+=`
     * :oe:meth:`OEDepict::OE2DPoint::operator-=`
     * :oe:meth:`OEDepict::OE2DPoint::operator*=`
     * :oe:meth:`OEDepict::OE2DPoint::operator/=`

Documentation changes
--------------------------------------------------------------------------------

* Added the :ref:`Multi Page Reports<section_multipage_report>`
  section to document the usage of the :ref:`OEReport <OEDepict_OEReport>`
  object.

* All images in the documentation were automatically regenerated to
  reflect the changes made since the previous release.


OEDepict TK 2.2.0
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEDepict::OEPrepareDepiction` now generates canonical depiction
  coordinates, i.e., the same 2D coordinates are generated regardless of the atom and
  bond ordering in the molecule.
  See the effect of this change in :ref:`Table: Example of default element color changes
  <table_OEPrepareDepictionChange>`.

  .. _table_OEPrepareDepictionChange:

  .. list-table:: **Example of generating depiction coordinates by the OEPrepareDepiction function**

     * - **OEDepict TK 2.1.0**
       - **OEDepict TK 2.2.0**
     * - .. image:: ../../depicttk/images/releasenotes-2.2.0/CoordinateGeneration-toolkits2013_Feb.*
       - .. image:: ../../depicttk/images/releasenotes-2.2.0/CoordinateGeneration-toolkits2013_Jun.*

* Added the following non-linear color gradient to OESystem:

  * :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>`
  * :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>`
  * :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>`

  These classes along with the :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class
  now derive from the :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>` base class.

* :oe:func:`OEDepict::OEAddHighlighting` function overloads added that take both atom
  and bond predicates.

* :oe:meth:`OEDepict::OEAlignmentOptions::SetFixedCoords` method added
  that forces the :oe:func:`OEDepict::OEPrepareAlignedDepiction`
  function to use the coordinates in the reference molecule instead of
  depicting them from scratch. 

* :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondLineGapScale` method added
  for changing the gap between the lines of double and triple bonds.

* :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondLineAtomLabelGapScale`
  method added for changing the gap between the atom labels and the end
  of the bond lines.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:const:`OEDepict::OEStipple::NoLine` and
  :oe:const:`OEDepict::OEFill::On` pen fixed on Windows when drawing a
  pie.

* Refined the method that is used to calculate the gap between the
  atom labels and the lines of the bonds when there is a charge or
  there are more than 3 explicit hydrogen neighbors.

* Additional warning messages are thrown when either the
  :oe:func:`OEChem::OE3DToBondStereo` or the :oe:func:`OEChem::OE3DToAtomStereo`
  functions fail during :oe:func:`OEDepict::OEPrepareDepiction`.

.. oe:language:: csharp

   * :ref:`OEImageGrid <OEDepict_OEImageGrid>` and :ref:`OEImageFrame <OEDepict_OEImageFrame>` in C# now
     store a reference to their parent :ref:`OEImageBase <OEDepict_OEImageBase>` to
     prevent early garbage collection of the parent.

Documentation changes
--------------------------------------------------------------------------------

* All images in the documentation were automatically regenerated to
  reflect the changes made since the previous release.

* Added several code snippets to the :oe:func:`OEDepict::OERenderMolecule`
  function.



.. |Bezier|    replace:: Bézier



OEDepict TK 2.2.1
================================================================================

New features
--------------------------------------------------------------------------------

* Added cubic |Bezier| drawing method to the following classes:

  * :oe:meth:`OEDepict::OEImageBase<OEDepict::OEImageBase::DrawCubicBezier>`
  * :oe:meth:`OEDepict::OEImage<OEDepict::OEImage::DrawCubicBezier>`
  * :oe:meth:`OEDepict::OEImageFrame<OEDepict::OEImageFrame::DrawCubicBezier>`

* Added quadratic |Bezier| drawing method to the following classes:

  * :oe:meth:`OEDepict::OEImageBase<OEDepict::OEImageBase::DrawQuadraticBezier>`
  * :oe:meth:`OEDepict::OEImage<OEDepict::OEImage::DrawQuadraticBezier>`
  * :oe:meth:`OEDepict::OEImageFrame<OEDepict::OEImageFrame::DrawQuadraticBezier>`

* Added rotation angle property to the :ref:`OEFont <OEDepict_OEFont>` class that
  allows to render text in various angles when calling the
  :oe:meth:`OEDepict::OEImageBase::DrawText` method.

  * :oe:meth:`OEDepict::OEFont::GetRotationAngle`
  * :oe:meth:`OEDepict::OEFont::SetRotationAngle`

Major bug fixes
--------------------------------------------------------------------------------

* When aligning a molecule to a template, atom clashes between the
  template atoms are ignored.

* :oe:func:`OEDepict::OEPrepareDepiction` will now suppress hydrogens
  even when 2D coordinates are not generated, i.e., ``clearcoords =
  false``.

Minor bug fixes
--------------------------------------------------------------------------------

* Highlighting a single atom with the
  :oe:const:`OEDepict::OEHighlightStyle::Stick` will now work if that
  atom is bonded to a highlighted atom.

* Fixed problem when the scaling of small molecules resulted
  in depicting atom labels outside the canvas.

* Fixed problem that incorrectly positioned the "+" sign between
  reaction components introduced by the last **OEDepict TK** release,
  2.2.0.

Documentation changes
--------------------------------------------------------------------------------

* All images in this documentation were automatically regenerated to
  reflect the changes made since the previous release.



OEDepict TK 2.2.2
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEDepict::OEPrepareAlignedDepiction` can now take a
  :ref:`OESubSearch <OEChem_OESubSearch>` or :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object
  to allow the layout to be driven by multiple atom mappings at the
  same time. The mapping that generates the best alignment will be
  returned in an :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>` object.

* :oe:func:`OEDepict::OEGetDefaultAtomColor` added to return the
  default color associated with an atomic number for the given atom
  color style.

* :oe:const:`OEGreenBoxPen<OEDepict::OEDepict::OEGreenBoxPen>` and
  :oe:const:`OEGreenPen<OEDepict::OEDepict::OEGreenPen>` pens added.

* :oe:func:`OEDepict::OEDepictCoordinates` is now deprecated. 2D
  coordinate generation is now included in ``OEChem`` as the
  :oe:func:`OEChem::OEGenerate2DCoordinates` function. Please switch to
  using that function instead.

Major bug fixes
--------------------------------------------------------------------------------

* Improved the positioning of atom properties by considering the position of implicit
  hydrogen labels.
  See the effect of this change in :ref:`Table: Example of improving the positioning of atom properties
  <table_AtomPropPositioning>`.

  .. _table_AtomPropPositioning:

  .. list-table:: **Example of improving the positioning of atom properties**

     * - **OEDepict TK 2.2.1**
       - **OEDepict TK 2.2.2**
     * - .. image:: ../../depicttk/images/releasenotes-2.2.2/AtomPropPosition_toolkits2013_Oct.*
       - .. image:: ../../depicttk/images/releasenotes-2.2.2/AtomPropPosition_toolkits2014_Feb.*

Minor bug fixes
--------------------------------------------------------------------------------

* **OEDepict TK** will automatically render enhanced stereo by default
  now. Previously, the
  :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` function would
  not automatically enable rendering enhanced stereo information.  The
  behavior can be changed by the
  :oe:const:`OEDepict::OEAtomStereoStyle::Display::MDLStereoCenter` and
  :oe:const:`OEDepict::OE2DMolDisplaySetup::AtomStereoStyle` constants.

* Increased the gap between the bond end and the atomic label for
  iodine (atomic label "I").

* Added "BRIEF" line to interfaces of **OEDepict TK** examples.

* :oe:func:`OEDepict::OEWriteImage` and
  :oe:func:`OEDepict::OERenderMolecule` that take an
  :ref:`oeostream <OEPlatform_oeostream>` no longer call the stream's ``close``
  method. It is the responsibility of the caller to call ``close`` on
  the stream if it is appropriate.

Documentation changes
--------------------------------------------------------------------------------

* All images in this documentation were automatically regenerated to
  reflect the changes made since the previous release.



OEDepict TK 2.2.3
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OEPrepareDepictionOptions <OEDepict_OEPrepareDepictionOptions>` added to allow finer
  grained control of the :oe:func:`OEDepict::OEPrepareDepiction`
  function.

* :oe:func:`OEDepict::OEGetMoleculeCoords` and
  :oe:func:`OEDepict::OEGetDisplayCoords` functions added that convert
  2D points between the molecule and the display coordinate systems.

* :oe:func:`OEDepict::OEAddHighlightOverlay` added to elegantly
  highlight overlapping sections of a molecule.

* Added the following functions to *OESystem* to provide predefined sets
  of colors:

  * :oe:func:`OESystem::OEGetColors`
  * :oe:func:`OESystem::OEGetContrastColors`
  * :oe:func:`OESystem::OEGetDeepColors`
  * :oe:func:`OESystem::OEGetLightColors`
  * :oe:func:`OESystem::OEGetVividColors`

* Added the following colors to *OESystem* :

  * :oe:const:`OESystem::OESystem::OEBrass`
  * :oe:const:`OESystem::OESystem::OECopper`
  * :oe:const:`OESystem::OESystem::OEGold` (the original color was renamed :oe:const:`OESystem::OESystem::OEMandarin`)
  * :oe:const:`OESystem::OESystem::OESilver`
  * :oe:const:`OESystem::OESystem::OEPewter`

Major bug fixes
--------------------------------------------------------------------------------

* Fixed Linux thread safety when writing :file:`.png` files. The Cairo
  graphics library (http://cairographics.org) used to draw
  :file:`.png` images on Linux is not thread safe. **OEDepict TK** now
  performs its own mutual exclusion when calling into the Cairo
  graphics library to ensure thread safety. It is strongly recommended
  to use the :file:`.svg` file format when speed and server throughput
  is a concern. Web browser support for :file:`.svg` has improved
  significantly in recent years and it is more effective at
  representing molecule graphs since they are mostly vector
  graphics. The only time :file:`.png` is preferable over :file:`.svg`
  is when rendering heavy raster graphics like property maps from
  **Grapheme TK**.

* Fixed thread safety of creating :file:`.svg` images.

* Increased the default font size of the atom label and atom property label.
  See the effect of this change in :ref:`Table: Example of increasing the default font size
  <table_AtomLabelSize>`.

  .. _table_AtomLabelSize:

  .. list-table:: **Example of increasing the default font size**

     * - **OEDepict TK 2.2.2**
       - **OEDepict TK 2.2.3**
     * - .. image:: ../../depicttk/images/releasenotes-2.2.3/AtomLabelSize_toolkits2014_Feb.*
       - .. image:: ../../depicttk/images/releasenotes-2.2.3/AtomLabelSize_toolkits2014_Jun.*

* The reaction role of hydrogens will no longer be thrown away during
  the depiction process. Specifically, all information present on
  explicit hydrogens will be preserved during the depiction process.

* **OEDepict TK** generated :file:`.pdf` files opened by several PDF
  viewers would show the file as edited due to an internal
  representation problem. PDF viewers should no longer modify
  **OEDepict TK** generated :file:`.pdf` files.

* **OEDepict TK** generated :file:`.pdf` files should no longer cause
  the following warning messages when read into Adobe Acrobat:

  ::

     The font 'Arial-Bold' contains a bad /BBox.

  The Helvetica font will now be used as the default font in
  :file:`.pdf` files. The :oe:const:`OEDepict::OEFontFamily::Arial`
  constant will now map to Helvetica as well in :file:`.pdf` files.

Minor bug fixes
--------------------------------------------------------------------------------

* Isotope hydrogens are never suppressed by the
  :oe:func:`OEDepict::OEPrepareDepiction` function.

* :file:`.svg` and :file:`.bsvg` image dimensions are now specified by
  the "viewBox" parameter rather than the "width" and "height"
  parameters.  This allows scaling the images in web applications.

* Functions and constructors of classes of Ogham API
  will now throw warning messages about being deprecated.

* Removed unbounded stack allocations.

* Fixed the problem when wedge bonds were not highlighted correctly when using the
  :oe:const:`OEDepict::OEHighlightStyle::Color` highlighting style.
  See the effect of this change in :ref:`Table: Example of highlighting wedge bonds with "Color" style
  <table_WedgeColor>`.

  .. _table_WedgeColor:

  .. list-table:: **Example of highlighting wedge bonds with "Color" style**

     * - **OEDepict TK 2.2.2**
       - **OEDepict TK 2.2.3**
     * - .. image:: ../../depicttk/images/releasenotes-2.2.3/WedgeColor_toolkits2014_Feb.*
       - .. image:: ../../depicttk/images/releasenotes-2.2.3/WedgeColor_toolkits2014_Jun.*

.. oe:language:: python

   * :oe:cls:`OEDepict::OEImageBase::DrawPolygon` will now properly
     throw an exception when passed incorrect arguments.

   * Adding the following division operators to the
     :ref:`OE2DPoint <OEDepict_OE2DPoint>` class to be compatible with Python
     3.x:

     * __truediv__
     * __itruediv__
     * __floordiv__
     * __ifloordiv__

.. oe:language:: java csharp

  * Functions and methods that returned a :ref:`OE2DPoint <OEDepict_OE2DPoint>`
    to Java and C# no longer return a dangling reference that was easy
    to cause crashes with.

Documentation changes
--------------------------------------------------------------------------------

* Updated the :ref:`Highlighting Overlapped
  Patterns<section_highlighting_overlap>` section and added a new code
  example that shows how to highlight overlapping matches using the
  new :oe:func:`OEDepict::OEAddHighlightOverlay` function.

* Documentation updated to reflect that
  :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor`
  and
  :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor`
  are preferred over using
  :oe:meth:`OEDepict::OE2DAtomDisplay::SetProperty` and
  :oe:meth:`OEDepict::OE2DBondDisplay::SetProperty` directly to ensure
  molecule scaling fully accounts for the size of the labels.

* All images in this documentation were automatically regenerated to
  reflect the changes made since the previous release.

* Added the missing documentation for the following *OESystem* colors:

  * :oe:const:`OESystem::OESystem::OEGreenBlue`
  * :oe:const:`OESystem::OESystem::OEGreenTint`

* The example for a python-based web interface and web service have been
  moved to our `Python Cookbook <http://docs.eyesopen.com/toolkits/cookbook/python/>`_.



OEDepict TK 2.2.4
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEDepict::OEAnnotateDepictionProblems` added to mark atom
  and bond stereo coordinate generation problems on output images. 

* Added :oe:func:`OEDepict::OEDrawChevronArrow` function.

* Added :oe:func:`OEDepict::OESuppressNonDepictionHydrogens` function.

Major bug fixes
--------------------------------------------------------------------------------

* The :oe:func:`OEDepict::OEPrepareDepiction` function now throws a warning in cases 
  when 2D coordinates are generated that are inconsistent with the cis/trans bond stereo
  configuration of the molecule.

* :oe:func:`OEDepict::OEPrepareAlignedDepiction` can now handle
  molecules with more than 32 rotatable bonds. Previously, if the
  number of rotatable bonds was greater than 32, not enough sampling
  would be done to achieve a good alignment. Additionally, the set of
  bonds to rotate is decided in a dynamic fashion to mitigate the expense
  of fitting large flexible molecules.

Minor bug fixes
--------------------------------------------------------------------------------

* Added the metal colors introduced in the 2014.Jun release to the parameters
  generated by the :oe:func:`OEDepict::OEConfigureHighlightParams` function.

* Fixed potential memory leak in the :oe:func:`OEDepict::OERenderMolecule` functions.

.. oe:language:: csharp

   * :oe:func:`OEDepict::OEAddHighlightOverlay` that takes an iterator
     of matches is now usable in C#. 

Documentation changes
--------------------------------------------------------------------------------

* All images in this documentation were automatically regenerated to
  reflect the changes made since the previous release.



OEDepict TK 2.2.5
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:cls:`OEDepict::OEImage <OEDepict::OEImage::Constructors>`
  allows users to easily rescale images without
  having to re-render all the drawing commands.

* :oe:meth:`OEDepict::OEPrepareDepictionOptions::SetDepictOrientation`
  allows users to control the preferred orientation of the 2D
  coordinates. This allows optimizing 2D coordinate generation for a
  particular orientation: :oe:const:`horizontal
  <OEDepict::OEDepictOrientation::Horizontal>`, :oe:const:`vertical
  <OEDepict::OEDepictOrientation::Vertical>`, or :oe:const:`square
  <OEDepict::OEDepictOrientation::Square>`. For example,
  :oe:const:`OEDepict::OEDepictOrientation::Horizontal` should be
  preferred when vertical space is expensive, as on web pages and
  spreadsheets.

* :oe:meth:`OEDepict::OEHighlightByStick::SetAtomExternalHighlightRatio`
  has been added to generate better highlighting for very small images. See
  the image in the
  :oe:meth:`OEDepict::OEHighlightByStick::SetAtomExternalHighlightRatio`
  documentation for an example.

* :oe:func:`OEDepict::OEConfigurePrepareDepictionOptions` provides a 
  convenient way to translate command line parameters into
  options on a :ref:`OEPrepareDepictionOptions <OEDepict_OEPrepareDepictionOptions>` object.
  All **OEDepict TK** examples have been updated to use these
  functions for building consistent command line interfaces. See the
  examples in the :ref:`OEDepict Examples
  Summary<oedepict_chapter_examples_summary>` section.

* :oe:func:`OEDepict::OEGetCenter` and
  :oe:func:`OEDepict::OEDrawTextToCenter` are convenience functions added
  to ensure that text is drawn vertically and horizontally in the center
  of an :ref:`OEImageBase <OEDepict_OEImageBase>`.

* Two new pens, :oe:const:`OELightGreyBoxPen<OEDepict::OEDepict::OELightGreyBoxPen>` and
  :oe:const:`OELightGreyPen<OEDepict::OEDepict::OELightGreyPen>`, have been added.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEDepict::OEPrepareDepiction` now automatically
  regenerates 2D coordinates when the current 2D coordinates are not in
  the XY plane. :oe:func:`OEDepict::OEPrepareDepiction` now clears
  coordinates when any of the following conditions are ``true``:

  - :oe:meth:`OEDepict::OEPrepareDepictionOptions::GetClearCoords` returns ``true``.
  - :oe:meth:`OEChem::OEMolBase::GetDimension` does not return ``2``.
  - Any Z coordinate is not ``0.0``.

  This protects against corrupted coordinate states that may be
  caused by file formats not normally used for depiction, such as PDB.

* PNG images generated on Linux will now have properly filled
  objects and will no longer look different
  than those generated on OSX or Windows, as shown in the following images:

  .. _table_filled_objects_cairo:

  .. list-table:: **Example of drawing filled objects with Cairo**

     * - **OEDepict TK 2.2.4**
       - **OEDepict TK 2.2.5**
     * - .. image:: ../../depicttk/images/releasenotes-2.2.5/DrawObjectsForReleaseNote-toolkits2014_Oct.png
       - .. image:: ../../depicttk/images/releasenotes-2.2.5/DrawObjectsForReleaseNote-toolkits2015_Feb.png

* The cubic and quadratic curves drawn on OSX PNG images are
  no longer closed and are now consistent with PNG images generated
  on other platforms.

  .. _table_osx_png_curve:

  .. list-table:: **Example of drawing cubic and quadratic curves on OSX**

     * - **OEDepict TK 2.2.4**
       - **OEDepict TK 2.2.5**
     * - .. image:: ../../depicttk/images/releasenotes-2.2.5/DrawCubicBezier-osx-toolkits2014_Oct.png
       - .. image:: ../../depicttk/images/releasenotes-2.2.5/DrawCubicBezier-osx-toolkits2015_Feb.png
     * - .. image:: ../../depicttk/images/releasenotes-2.2.5/DrawQuadraticBezier-osx-toolkits2014_Oct.png
       - .. image:: ../../depicttk/images/releasenotes-2.2.5/DrawQuadraticBezier-osx-toolkits2015_Feb.png

* PDF files should no longer cause the following warning
  message when read into Adobe Acrobat:

  ::

     The font "Times" contains a bad/BBox.

Minor bug fixes
--------------------------------------------------------------------------------

* A new :oe:meth:`OEDepict::OE2DMolDisplay::IsValid` method has been added.
  A molecule display is considered valid only if it was initialized with a
  non-empty molecule with either 2D or 3D coordinates.
  An invalid molecule display cannot be rendered by the :oe:func:`OEDepict::OERenderMolecule`
  or the :oe:func:`OEDepict::OERenderMoleculeToString` functions.

* The :oe:const:`OEDepict::OEHydrogenStyle::Hidden` style will no longer
  show any hydrogen labels, even if the hydrogen has a charge,
  isotopic mass, or is a radical.

* The :oe:func:`OEDepict::OEAnnotateDepictionProblems` function now
  displays ``E/Z`` CIP bond labels rather than ``C/T`` in cases where
  double bonds are not correctly depicted according to their cis/trans
  stereo specifications.

Documentation changes
--------------------------------------------------------------------------------

* All images in this documentation were automatically regenerated to
  reflect the changes made since the previous release.

* The documentation of all deprecated Ogham classes, functions, and namespaces
  has been removed:

  Deprecated Ogham classes:

  * ``OE8BitImage``
  * ``OEAtomStyle``
  * ``OEBondStyle``
  * ``OEDepictBase``
  * ``OEDepictColor``
  * ``OEDepictView``
  * ``OEPSImage``
  * ``OEPoly``
  * ``OEPolyF``
  * ``OESVGImage``
  * ``OEVert``
  * ``OEVertF``

  Deprecated Ogham functions:

  * ``OEWriteBMP``
  * ``OEWriteEPS``
  * ``OEWriteGIF``
  * ``OEWritePPM``
  * ``OEWriteRGB``
  * ``OEWriteXPM``

  Deprecated Ogham namespace:

  * ``OENamedColor``

* Minor changes have been made to the documentation and examples for consistency and/or spelling errors.
* More C# examples have been added.

C++-specific changes
--------------------------------------------------------------------------------

.. oe:language:: c++

   * :oe:func:`OEDepict::OECreateWin32GraphicsImage` now allows
     interoperability with the Windows `GDI+ Graphics class
     <http://msdn.microsoft.com/en-us/library/windows/desktop/ms534453(v=vs.85).aspx>`_
     object. This function is only available on the Windows operating
     system through C++.

.. oe:language:: python java csharp

   * ``OECreateWin32GraphicsImage`` now allows
     interoperability with the Windows `GDI+ Graphics class
     <http://msdn.microsoft.com/en-us/library/windows/desktop/ms534453(v=vs.85).aspx>`_
     object. This function is only available on the Windows operating
     system through C++.

Python-specific changes
--------------------------------------------------------------------------------

* **OEDepict TK** no longer provides Python wrapping for the following methods of
  the deprecated ``OEDepictView`` class:

  - ``GetViewCoords``
  - ``GetForeColor`` and ``SetForeColor``
  - ``GetBackColor`` and ``SetBackColor``



OEDepict TK 2.2.6
================================================================================

New features
--------------------------------------------------------------------------------

* The following changes have been made to improve the SVG images
  containing certain geometries (especially those made by the
  :ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>` class):

  - :oe:const:`OEDepict::OELineCap::Butt` (the default line cup) and
    :oe:const:`OEDepict::OELineJoin::Miter` (the default line join)
    parameters for shapes (lines, rectangles, etc.) are no longer written
    into the SVG images.

  - :oe:meth:`OEDepict::OEImageBase::DrawRectangle` for SVG
    will now trim the trailing zeros and the decimal point.

  The above changes resulted in 40% smaller images and 10% faster image writing
  without any visual difference.

  .. For example:
  ..   <rect x="84.00" y="30.00" width="2.00" height="2.00" fill="#fefefe" stroke="#fefefe" stroke-linejoin="miter" stroke-linecap="round" />
  ..   <rect x="84" y="30" width="2" height="2" fill="#fefefe" stroke="#fefefe" />

* :ref:`OE2DPath <OEDepict_OE2DPath>` class has been added to allow drawing
  more complex lines connected by a series of points. The following
  methods were added to accept :ref:`OE2DPath <OEDepict_OE2DPath>` objects:

  * :oe:meth:`OEDepict::OEImageBase::DrawPath`
  * :oe:meth:`OEDepict::OEImage::DrawPath`
  * :oe:meth:`OEDepict::OEImageFrame::DrawPath`

* :oe:meth:`OEDepict::OEHighlightByColor::SetAtomExternalHighlight`
  was added to generate better highlighting for small images.

* :oe:func:`OEDepict::OEAnnotateValenceProblems` function was added
  to highlight potential atom valence problems on the molecule diagram.

* :oe:func:`OEDepict::OEWrite2DRingDictionaryReport` function was added
  to generate a multi-page report for user-defined ring dictionaries.
  See also the :ref:`chapter_2D_coordinates` chapter in the **OEChem TK** manual.

* :oe:meth:`OEDepict::OEImageBase::GetGlobalOffset` method was added
  to return the global position of the image. This is currently only
  useful for subframes of an :ref:`OEImageFrame <OEDepict_OEImageFrame>` object.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEDepict::OEPrepareAlignedDepiction` has been optimized
  to be twice as fast on average.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEDepict::OEAnnotateDepictionProblems` style has been redesigned to be
  more visually pleasing.

* The positioning of + signs for reactions has been improved. The + signs
  and the arrow of the reactions now scale with the default line width of
  the molecule.

Documentation changes
--------------------------------------------------------------------------------

* :ref:`ringdict2pdf<section_examples_summary_ringdict2pdf>` example
  has been added to generate a multi-page ring dictionary report.

* ``-ringdict`` parameter has been added to the following examples to utilize
  user-defined ring dictionaries:

  - :ref:`depict<section_examples_summary_depict>` example
  - :ref:`mol2img<section_examples_summary_mol2img>` example
  - :ref:`mols2pdf<section_examples_summary_mols2pdf>` example

* All images in this documentation were automatically regenerated to
  reflect the changes made since the previous release.



OEDepict TK 2.3.0
================================================================================

New features
--------------------------------------------------------------------------------

* Functionalities have been added to customize the general layout of the molecule display:

  * the margin(s) around the molecule can now be changed
    (for more details, see :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetMargin` and
    :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetMargins` methods)
  * the height of the title area can now be changed
    (for more details, see :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleHeight` method)

   .. list-table:: **Example of molecule display layouts depending on position of the title**
      :widths: 250 250 250
      :header-rows: 1

      * - title hidden
        - title at the top
        - title at the bottom

      * - .. image:: ../../depicttk/images/OE2DMolDisplayLayout_TitleHidden.*
        - .. image:: ../../depicttk/images/OE2DMolDisplayLayout_TitleTop.*
        - .. image:: ../../depicttk/images/OE2DMolDisplayLayout_TitleBottom.*

* A new highlighting style, :oe:const:`OEDepict::OEHighlightStyle::Lasso`,
  has been added along with the corresponding highlighting class :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>`.
  See the example in :ref:`Figure: Example of highlighting using the "lasso" style<figure_2015_lasso>`.
  below.

  .. _figure_2015_lasso:

  .. figure:: depicttk/images/releasenotes-2.3.0/Lasso-toolkits2015_Oct.*
     :align:  center

     **Example of highlighting using the "lasso" style**

* Text can now be associated with hyperlinks via the :ref:`OEFont <OEDepict_OEFont>` class.
  This functionality is only available for :file:`PDF` and :file:`SVG` image formats.
  For more details and an example see the :oe:meth:`OEDepict::OEFont::SetHyperlink` method.

* The title of the molecule is now scaled along with the size of the image by default.
  The :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFontScale` method was added
  to enable changing the scaling factor or allowing a fixed font size to be used
  regardless of the dimensions of the image.
  See also the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFont` method.

* The :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale` method now allows
  using a fixed font size regardless of size of the molecule.
  Previously, the atom labels of the molecule were scaled along with the size of molecule.

* In case of the :oe:const:`OEDepict::OEBondColorStyle::ByElement` style, the
  wedge/hash stereo bonds are also colored by the corresponding element types.
  See the effect of this change in :ref:`Table: Example of bond coloring<table_2015_bond_color>` below.

  .. _table_2015_bond_color:

  .. list-table:: **Example of bond coloring**

     * - **OEDepict TK 2.2.6 (2015.Jun)**
       - **OEDepict TK 2.3.0 (2015.Oct)**
     * - .. image:: ../../depicttk/images/releasenotes-2.3.0/BondColoring-toolkits2015_Jun.*
       - .. image:: ../../depicttk/images/releasenotes-2.3.0/BondColoring-toolkits2015_Oct.*

* If the width or the height of a molecule display is not specified it will be set to ``50.0``.

* :oe:func:`OEDepict::OEWriteReportToString` function has been added.

* :oe:func:`OEDepict::OEDrawCurvedBorder` function has been added.

Major bug fixes
--------------------------------------------------------------------------------

* The layout of the molecule depiction has been improved to eliminate atom label clippings.
  These label clippings used to occur in cases when font scales larger than
  the default value were used.
  See the effect of this change in
  :ref:`Table: Improved depiction layout<table_2015_depict_layout>` below.

  .. _table_2015_depict_layout:

  .. list-table:: **Improved depiction layout**

     * - **OEDepict TK 2.2.6 (2015.Jun)**
       - **OEDepict TK 2.3.0 (2015.Oct)**
     * - .. image:: ../../depicttk/images/releasenotes-2.3.0/DepictionLayout_toolkits2015_Jun.*
       - .. image:: ../../depicttk/images/releasenotes-2.3.0/DepictionLayout_toolkits2015_Oct.*

* The bounding boxes of labels are now considered when positioning atom properties.
  As a result, the number of overlaps is reduced in cases where font scales larger than
  the default value are used.
  See the effect of this change in
  :ref:`Table: Example of improving the positioning of atom properties<table_2015_AtomPropPositioning>`
  below.

  .. _table_2015_AtomPropPositioning:

  .. list-table:: **Example of improving the positioning of atom properties**

     * - **OEDepict TK 2.2.6 (2015.Jun)**
       - **OEDepict TK 2.3.0 (2015.Oct)**
     * - .. image:: ../../depicttk/images/releasenotes-2.3.0/AtomPropPosition_toolkits2015_Jun.*
       - .. image:: ../../depicttk/images/releasenotes-2.3.0/AtomPropPosition_toolkits2015_Oct.*

Minor bug fixes
--------------------------------------------------------------------------------

* The default parameter for the maximum number of bond rotations of the
  :ref:`OEAlignmentOptions <OEDepict_OEAlignmentOptions>` class is :math:`2^{16} = 65536`.
  This means that by default only the first 16 single bonds of the *fit*
  molecule will be rotated to maximize molecule alignment when invoking
  the :oe:func:`OEDepict::OEPrepareAlignedDepiction` function.

* :oe:func:`OEDepict::OEPrepareAlignedDepiction` has been optimized
  to be 10% faster on average. The algorithm was also revised to
  reduce the accumulation of floating point errors.

* The atom mapping index is no longer displayed (redundantly) in the case of R-groups.
  See the effect of this change in
  :ref:`Table: Example of displaying atom map indices<table_2015_atom_map_idx>` below.
  See also the :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>` class.

  .. _table_2015_atom_map_idx:

  .. list-table:: **Example of displaying atom map indices**

     * - **OEDepict TK 2.2.6 (2015.Jun)**
       - **OEDepict TK 2.3.0 (2015.Oct)**
     * - .. image:: ../../depicttk/images/releasenotes-2.3.0/RGroup-AtomMapIdx-toolkits2015_Jun.*
       - .. image:: ../../depicttk/images/releasenotes-2.3.0/RGroup-AtomMapIdx-toolkits2015_Oct.*

* :oe:const:`OEDepict::OEAromaticStyle::Circle` depiction style has been improved.
  See the effect of this change in
  :ref:`Table: Example of Kekule (default) and circle aromatic depiction styles<table_2015_AromaticityStyle>`
  below.

  .. _table_2015_AromaticityStyle:

  .. list-table:: **Example of Kekule (default) and circle aromatic depiction styles**

     * - aromaticity style
       - **OEDepict TK 2.2.6 (2015.Jun)**
       - **OEDepict TK 2.3.0 (2015.Oct)**

     * - :oe:const:`OEDepict::OEAromaticStyle::Kekule`
       - .. image:: ../../depicttk/images/releasenotes-2.3.0/AromaticStyle_Kekule_toolkits2015_Jun.*
       - .. image:: ../../depicttk/images/releasenotes-2.3.0/AromaticStyle_Kekule_toolkits2015_Oct.*

     * - :oe:const:`OEDepict::OEAromaticStyle::Circle`
       - .. image:: ../../depicttk/images/releasenotes-2.3.0/AromaticStyle_Circle_toolkits2015_Jun.*
       - .. image:: ../../depicttk/images/releasenotes-2.3.0/AromaticStyle_Circle_toolkits2015_Oct.*

* If a bond display style cannot be determined - for example, in case of a broken molecule -
  the bond is now displayed using the  :oe:const:`OEDepict::OEBondDisplayType::Any` style
  and no error message will be thrown.

* :oe:func:`OEDepict::OEAddHighlightOverlay` function no longer generates
  different images on different platforms.

Python-specific changes
--------------------------------------------------------------------------------

* The deprecated Ogham API is no longer tested in Python.
  See also :ref:`release_notes_deprecated_ogham` section.

Documentation changes
--------------------------------------------------------------------------------

* :ref:`section_mol_display_transparent` section was added to show how to generate
  molecule depiction with a transparent background.

* Code snippets have been added to the following functions:

  * :oe:func:`OEDepict::OERenderMoleculeToString`
  * :oe:func:`OEDepict::OEWriteImageToString`

* All images in this documentation  have been automatically regenerated to
  reflect the changes made since the previous release.


OEDepict TK 2.3.1
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:meth:`OEDepict::OEHighlightByLasso::SetConsiderAtomLabelBoundingBox` method
  has been added to keep lines of highlighting from clashing with the atom labels.

  .. list-table::  **Examples of highlighting using the lasso style**
     :widths: 250 250

     * - default style
       - new style

     * - .. image:: ../../depicttk/images/releasenotes-2.3.1/OEHighlightByLasso_Default.*
       - .. image:: ../../depicttk/images/releasenotes-2.3.1/OEHighlightByLasso_BoundingBox.*

Minor bug fixes
--------------------------------------------------------------------------------

* Bonds with the :oe:const:`OEChem::OEBondStereo::DoubleEither` property are now
  always depicted with the :oe:const:`OEDepict::OEBondDisplayType::DoubleBowTie`
  style.


OEDepict TK 2.3.2
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomVisibilityFunctor` and
  :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomVisibilityFunctor` methods have been
  added to support the ability to selectively hide portions of a structure from depictions.

* :oe:meth:`OEDepict::OEAlignmentOptions::SetAddDepictionHydrogens` and
  :oe:meth:`OEDepict::OEAlignmentOptions::GetAddDepictionHydrogens` methods
  have been added to control depiction hydrogens added during molecule
  alignment.

* :oe:func:`OEDepict::OEGetAverageBondLengthInDispCoords` function has been
  added.

* :oe:func:`OEDepict::OEGetNearbyAtom` and :oe:func:`OEDepict::OEGetNearbyBond`
  functions have been added.

* :ref:`OENearestAtom <OEDepict_OENearestAtom>` and :ref:`OENearestBond <OEDepict_OENearestBond>`
  classes now store the display position of the nearest atom and bond,
  respectively.

Major bug fixes
--------------------------------------------------------------------------------

* A memory issue that caused :oe:func:`OEDepict::OEPrepareAlignedDepiction`
  function to crash has been fixed.
  The performance of molecule alignment has been also improved.

Minor bug fixes
--------------------------------------------------------------------------------

* Clashes between atom labels and inside bond lines of rings have been
  eliminated in cases when font scales larger than the default
  value were used. See the example below.

  .. list-table::
     :widths: 250 250
     :header-rows: 1

     * - 2016.Feb
       - 2016.Jun

     * - .. image:: ../../depicttk/images/releasenotes-2.3.2/MitterBond-Scale-2016-Feb.*
       - .. image:: ../../depicttk/images/releasenotes-2.3.2/MitterBond-Scale-2016-Jun.*

C#-specific changes
--------------------------------------------------------------------------------

:oe:meth:`OEDepict::OEImageBase::DrawArc` method no longer throws an "Out Of Memory"
error message when drawing an arc with a small angle and/or small radius.
For more details, see
`Graphics.DrawArc Method <https://msdn.microsoft.com/en-us/library/system.drawing.graphics.drawarc%28VS.90%29.aspx>`_.

Documentation changes
--------------------------------------------------------------------------------

* All images in the **OEDepict TK** documentation were automatically regenerated to
  reflect the changes made since the previous release.


OEDepict TK 2.3.3
================================================================================

New features
--------------------------------------------------------------------------------

* The following APIs have been added to allow the interrogation of
  the :ref:`OE2DPath <OEDepict_OE2DPath>` class:

   * :oe:meth:`OEDepict::OE2DPath::GetPoints` and
     :oe:meth:`OEDepict::OE2DPath::IsClosed` methods
   * :ref:`OE2DPathPoint <OEDepict_OE2DPathPoint>` class
   * :oe:constns:`OEDepict::OE2DPathPointType` namespace

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEDepict::OEPrepareDepiction` has been fixed to correctly
  suppress all hydrogens when requested. Previously, it retained depiction
  hydrogens for some molecules.

* :oe:func:`OEDepict::OEPrepareDepiction` no longer crashes when used on
  :oe:const:`OEChem::OEMolBaseType::OEMiniMol` molecule implementations.

Documentation changes
--------------------------------------------------------------------------------

* All images in the **OEDepict TK** documentation have been regenerated to
  reflect the changes made since the 2016.Jun release.


OEDepict TK 2.3.4
================================================================================

New features
--------------------------------------------------------------------------------

* A new function, :oe:func:`OEDepict::OEPrepareMultiAlignedDepiction`,
  has been added that performs 2D molecule alignment based on common fragments
  between two molecules.

  .. figure:: depicttk/images/releasenotes-2.3.4/OEPrepareMultiAlignedDepiction-Example.*
     :align:  center

     **Example of depiction with alignment based on molecule similarity**

* A new method, :oe:meth:`CreateCopy<OEDepict::OEHighlightBase::CreateCopy>`,
  has been added to the :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` base class and
  all of its derived classes.

* A new function, :oe:func:`OEDepict::OEDrawCurvedRectangle`, has been added
  that renders a rectangle with rounded corners.

Major bug fixes
--------------------------------------------------------------------------------

* The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` constructor previously threw an
  error when initialized with an empty molecule or with a molecule
  with no coordinates. A warning is now thrown and the object is marked
  invalid (e.g., the :oe:meth:`OEDepict::OE2DMolDisplay::IsValid` method will
  return ``false``).  In addition, an :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object
  becomes invalid if the molecule from which it was initialized is modified
  (e.g., when atoms/bonds are added or deleted).  All **OEDepict TK** functions
  handling an :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object now check the
  validity of the object prior to use.

* Reactions with only product or only reactant components are now
  depicted correctly with a reaction arrow and the "+" sign between the
  components.

* The methods :oe:meth:`OEDepict::OEImageBase::DrawArc` and
  :oe:meth:`OEDepict::OEImageBase::DrawPie` have been unified when
  generating :file:`PDF` images. As a result, arc and pie objects
  in :file:`PDF` images appear more seamless.

Minor bug fixes
--------------------------------------------------------------------------------

* When generating an :file:`SVG` image, the opacity of the background
  is now written into the file. This allows generating images with
  a semi-transparent background.

* For the molecules C#C and C=C, the carbon atom labels are now always
  explicitly depicted.

* When determining the scaling of a depicted molecule, the bounding box
  of each multi-line bond is now considered to ensure that no bond is
  rendered outside the canvas.

* A minor molecule scaling issue that occurred when using fixed atom label
  fonts has been fixed.

* The function :oe:func:`OEDepict::OEDrawChevronArrow` has been improved
  to handle very short arrows.  In addition, the default parameters of the
  function have been changed.

Documentation changes
--------------------------------------------------------------------------------

* A new section, :ref:`section_molalign_molsim`, has been added to demonstrate
  the new :oe:func:`OEDepict::OEPrepareMultiAlignedDepiction`
  function.

* Warnings have been added to
  :oe:func:`OEDepict::OEWriteReportToString`,
  :oe:func:`OEDepict::OERenderMoleculeToString`, and
  :oe:func:`OEDepict::OEWriteImageToString` to alert that these functions
  return bytes in Python 3.


OEDepict TK 2.3.5
================================================================================

New features
--------------------------------------------------------------------------------

* A new function, :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions`, has
  been added to help generate consistent command line interfaces for depiction
  examples and utilities.  Generated interfaces now include correspondence
  between each command line option and its related entrypoint in
  **OEDepict TK**.  For more details see the documentation for
  :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions`.

* A position property has been added to the "lasso" highlighting style that
  allows drawing the highlights either below or above the depicted molecules.
  This property can be set either by the constructor of the
  :oe:meth:`OEDepict::OEHighlightByLasso` class or via the
  :oe:meth:`OEDepict::OEHighlightByLasso::SetPosition` method.

* The :ref:`OE2DPath <OEDepict_OE2DPath>` class has been extended to handle
  "empty" 2D paths:

  * :oe:meth:`OE2DPath<OEDepict::OE2DPath::Constructors>` default constructor
  * :oe:meth:`OEDepict::OE2DPath::AddStartPoint` method
  * :oe:meth:`OEDepict::OE2DPath::SetClosed` method
  * :oe:meth:`OEDepict::OE2DPath::IsValid` method

Preliminary API
--------------------------------------------------------------------------------

* A new :term:`Preliminary API` has been added to support the
  generation of interactive SVG images:

  * :ref:`OESVGClass <OEDepict_OESVGClass>` and
    :ref:`OESVGGroup <OEDepict_OESVGGroup>` classes
  * :oe:meth:`OEDepict::OEImageBase::PushGroup`,
    :oe:meth:`OEDepict::OEImageBase::PopGroup`,
    :oe:meth:`OEDepict::OEImageBase::NewSVGGroup`,
    :oe:meth:`OEDepict::OEImageBase::NewSVGClass`,
    :oe:meth:`OEDepict::OEImageBase::GetSVGGroup`, and
    :oe:meth:`OEDepict::OEImageBase::GetSVGClass` methods of the
    :ref:`OEImageBase <OEDepict_OEImageBase>` base class and its derived classes
  * :oe:func:`OEDepict::OEDrawSVGHoverText`,
    :oe:func:`OEDepict::OEDrawSVGToggleText`, and
    :oe:func:`OEDepict::OEAddSVGClickEvent` functions

.. only:: oehtml

   .. list-table:: **Gallery of OEDepict TK examples of interactive SVG images**
      :widths: 150 150

      * - Hover the mouse over any atom
        - Click on any atom

      * - .. raw:: html

             <p align="center">
             <object data="../../_images/HoverAtomText.svg" type="image/svg+xml"  width = "300" ></object>
             <p>

        - .. raw:: html

             <p align="center">
             <object data="../../_images/ToggleAtomText.svg" type="image/svg+xml"  width = "300" ></object>
             <p>

      * - Hover the mouse over any bond
        - Click on the middle on any bond

      * - .. raw:: html

             <p align="center">
             <object data="../../_images/HoverBondText.svg" type="image/svg+xml"  width = "300" ></object>
             <p>

        - .. raw:: html

             <p align="center">
             <object data="../../_images/ToggleBondText.svg" type="image/svg+xml"  width = "300" ></object>
             <p>

Major bug fixes
--------------------------------------------------------------------------------

* On OSX, the deprecated ``CGContextSelectFont`` and
  ``CGContextShowTextAtPoint`` Core Graphics functions have been replaced.
  These function were used to handle fonts when drawing text in PNG images.
  **OEDepict TK** currently supports the following font mapping on OSX for
  PNG images:

  .. list-table::
     :widths: 100 100
     :header-rows: 1

     * - OpenEye Font Family Type
       - Font Name

     * - :oe:const:`OEDepict::OEFontFamily::Arial`
       - ``Arial``

     * - :oe:const:`OEDepict::OEFontFamily::Courier`
       - ``CourierNewPS``

     * - :oe:const:`OEDepict::OEFontFamily::Helvetica`
       - ``Helvetica``

     * - :oe:const:`OEDepict::OEFontFamily::Times`
       - ``TimesNewRomanPS``

Minor bug fixes
--------------------------------------------------------------------------------

* When performing fixed coordinate molecule alignment
  (see :oe:meth:`OEDepict::OEAlignmentOptions::SetFixedCoords`),
  only the set of atoms considered during the alignment are now used to
  evaluate the quality of the alignment. As a result, fixed
  coordinate alignment succeeds more frequently, circumventing the need to
  fall back to the more exhaustive alignment method.

* Bond stereo information is now re-perceived by calling the
  :oe:func:`OEChem::OEMDLPerceiveBondStereo` function after
  finding the best 2D alignment with the
  :oe:func:`OEDepict::OEPrepareAlignedDepiction` function when the alignment
  is defined by either an :ref:`OESubSearch <OEChem_OESubSearch>` or an
  :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object.

Python-specific changes
--------------------------------------------------------------------------------

* The following Python functions have been added:

  * :oe:func:`OEDepict::OERenderMoleculeToBytes`
  * :oe:func:`OEDepict::OEWriteImageToBytes`
  * :oe:func:`OEDepict::OEWriteReportToBytes`

Documentation changes
--------------------------------------------------------------------------------

* A new chapter, :ref:`chapter_svg`, has been added.

* A new section, :ref:`oedepict_chapter_cookbook_examples`, has been added.


OEDepict TK 2.3.6
================================================================================

New features
--------------------------------------------------------------------------------

* The following API has been added to increase the reporting capabilities of
  **OEDepict TK**:

  * :ref:`OEImageTable <OEDepict_OEImageTable>` class
  * :ref:`OEImageTableOptions <OEDepict_OEImageTableOptions>` class
  * :oe:constns:`OEDepict::OEImageTableStyle` namespace

  .. figure:: depicttk/images/ImageTable.*
     :align:  center

     **Example of depicting molecules and data using image table**

* The following API has been added to render labels associated
  with certain parts of the depicted molecule:

  * :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` class
  * :oe:func:`OEDepict::OEAddLabel` function

  .. figure:: /_images/HighlightLabel.png
     :align: center
     :width: 250 pt

     **Example of adding labels on molecule depiction**

* A new function, :oe:func:`OEDepict::OEDrawText`, has been added.

* The constructor of the
  :oe:meth:`OEDepict::OEHighlightByLasso<OEDepict::OEHighlightByLasso::Constructors>`
  class now takes a parameter that determines the width of the "lasso" used for
  highlighting.  The corresponding
  :oe:cls:`OEDepict::OEHighlightByLasso::GetLineWidthScale` and
  :oe:cls:`OEDepict::OEHighlightByLasso::SetLineWidthScale` methods
  have been added.

* A new constructor has been added to the
  :oe:meth:`OEDepict::OEImageFrame<OEDepict::OEImageFrame::Constructors>`
  class that generates a new image with equal padding around it.

* A new function, :oe:func:`OEDepict::OEWriteReportPageByPage`, has been added.

* A new constructor has been added to the
  :oe:meth:`OEDepict::OE2DPath<OEDepict::OE2DPath::Constructors>` class that
  copies and rotates an already existing path.

Preliminary API - New Functionalities
--------------------------------------------------------------------------------

* A new overload of the function :oe:func:`OEDepict::OEAddSVGClickEvent`
  has been added that allows associating any :ref:`OESVGGroup <OEDepict_OESVGGroup>`
  object with an SVG click event.

* A new :term:`Preliminary API` has been added to generate and access
  built-in visibility SVG classes (:ref:`OESVGClass <OEDepict_OESVGClass>`):

  * :oe:func:`OEDepict::OEAddBuiltInHiddenSVGClass`
  * :oe:func:`OEDepict::OEGetBuiltInHiddenSVGClass`
  * :oe:func:`OEDepict::OEAddBuiltInVisibleSVGClass`
  * :oe:func:`OEDepict::OEGetBuiltInVisibleSVGClass`

* A new :term:`Preliminary API` has been added to mark up the atoms in SVG
  images generated by the :oe:func:`OEDepict::OERenderMolecule` function:

  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor`
  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomSVGMarkupFunctor`
  * :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>`
  * :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>`
  * :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>`
  * :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>`

* A new constant, :oe:const:`OEDepict::OELayerPosition::SVG`, has been added
  to the :oe:constns:`OEDepict::OELayerPosition` namespace.

* The following virtual methods have been added to the
  :ref:`OEImageFileBase <OEDepict_OEImageFileBase>` class:

  * :oe:meth:`OEDepict::OEImageFileBase::PushGroup`
  * :oe:meth:`OEDepict::OEImageFileBase::PopGroup`
  * :oe:meth:`OEDepict::OEImageFileBase::IsVisible`

* A new method, :oe:meth:`OEDepict::OESVGGroup::IsVisible`, has been added.

Preliminary API - API Changes
--------------------------------------------------------------------------------

* The atom and bond display parameters of the following functions are no
  longer ``const``:

  * :oe:func:`OEDepict::OEDrawSVGToggleText`
  * :oe:func:`OEDepict::OEDrawSVGHoverText`
  * :oe:func:`OEDepict::OEAddSVGClickEvent`

Major bug fixes
--------------------------------------------------------------------------------

* Objects that have been drawn in hidden SVG groups are no longer visible in
  other image file formats.  For example, when adding hover text to atoms
  (using the :oe:func:`OEDepict::OEDrawSVGHoverText` function),
  the text will only be visible in SVG images when the mouse is moved
  over a displayed atom. If the image is written into any other image
  file format, the hover text is no longer visible.

  .. list-table::
     :widths: 250 250
     :header-rows: 1

     * - 2017.Jun
       - 2017.Oct

     * - .. image:: ../../depicttk/images/releasenotes-2.3.6/HoverAtomText-2017-Jun.*
       - .. image:: ../../depicttk/images/releasenotes-2.3.6/HoverAtomText-2017-Oct.*

* When generating interactive SVG images, hover text
  (:oe:func:`OEDepict::OEDrawSVGToggleText`)
  and click events (:oe:func:`OEDepict::OEAddSVGClickEvent`) can both be
  added to atoms and bonds.

Minor bug fixes
--------------------------------------------------------------------------------

* The Ogham API, deprecated since 2014, is no longer available.

Documentation changes
--------------------------------------------------------------------------------

* A new section, :ref:`section_image_layout_table`, has been added.


OEDepict TK 2.4.0
================================================================================

New features
--------------------------------------------------------------------------------

* The following API for marking up SVG images, introduced in the 2017.Jun
  and 2017.Oct releases, is no longer preliminary.  It is now also available in
  both Java and C#:

  * :ref:`OESVGClass <OEDepict_OESVGClass>` class
  * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class
  * :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>` class
  * :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>` class
  * :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>` class
  * :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>` class

  * :oe:func:`OEDepict::OEAddBuiltInHiddenSVGClass` function
  * :oe:func:`OEDepict::OEAddBuiltInVisibleSVGClass` function
  * :oe:func:`OEDepict::OEAddSVGClickEvent` function
  * :oe:func:`OEDepict::OEDrawSVGHoverText` function
  * :oe:func:`OEDepict::OEDrawSVGToggleText` function
  * :oe:func:`OEDepict::OEGetBuiltInHiddenSVGClass` function
  * :oe:func:`OEDepict::OEGetBuiltInVisibleSVGClass` function

* Two new functions, :oe:func:`OEDepict::OEIsValidSVGGroupId` and
  :oe:func:`OEDepict::OEIsValidSVGClassName`, have been added.

* Two new low-level functions, :oe:func:`OEDepict::OEAddSVGHover` and
  :oe:func:`OEDepict::OEAddSVGToggle`, have been added to generate hover
  and toggle effects, respectively, between two SVG groups.

* The :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>` class now takes a
  separator option.

* A new function, :oe:func:`OEDepict::OEAddLabel`, has been added to
  render a label on an image at a user-defined location.

* Two new functions, :oe:func:`OEDepict::OEAddOpenEyeIcon` and
  :oe:func:`OEDepict::OEAddInteractiveIcon`, and the namespace
  :oe:constns:`OEDepict::OEIconLocation` have been added.

* Two new methods, :oe:meth:`OEDepict::OE2DPath::GetStart` and
  :oe:meth:`OEDepict::OE2DPath::GetEnd`, have been added.

* Two new pens,
  :oe:const:`OETransparentPen<OEDepict::OEDepict::OETransparentPen>` and
  :oe:const:`OESVGAreaPen<OEDepict::OEDepict::OESVGAreaPen>`, have been added.

Java-specific changes
--------------------------------------------------------------------------------

* The API for marking up SVG images is now fully supported in Java
  (see the list above).

C#-specific changes
--------------------------------------------------------------------------------

* The API for marking up SVG images is now fully supported in C# (see
  the list above).


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



OEDepict TK 2.4.1
================================================================================

New features
--------------------------------------------------------------------------------

* The following APIs have been added to generate consistent legend layouts:

  * :oe:constns:`OEDepict::OELegendLayoutStyle` namespace
  * :oe:constns:`OEDepict::OELegendColorStyle` namespace
  * :oe:const:`OEDepict::OELegendInteractiveStyle` namespace
  * :ref:`OELegendLayoutOptions <OEDepict_OELegendLayoutOptions>` class
  * :ref:`OELegendLayout <OEDepict_OELegendLayout>` class
  * :oe:func:`OEDepict::OEDrawLegendLayout` function

  .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>click on the Legend label</b>
         </p>

         <p align="center">
         <object data="../../_images/legend-layout.svg" type="image/svg+xml"  width = "300" ></object>
         <p>

         <p align="center">
         <b>Example of using legend layout</b>
         <p>

      .. image:: /_images/legend-layout.svg
         :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

* The following APIs have been added to depict common protective groups:

  * :oe:constns:`OEDepict::OEProtectiveGroupStyle` namespace
  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupLabelFont`
  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetProtectiveGroupLabelFont`
  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupStyle`
  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetProtectiveGroupStyle`

  .. list-table::
     :widths: 100 100
     :header-rows: 1

     * - default depiction
       - using :oe:const:`OEDepict::OEProtectiveGroupStyle::Fmoc` style
     * - .. image:: ../../depicttk/images/releasenotes-2.4.1/prot-group_Fmoc_OFF.*
            :scale:  100
            :align:  center
       - .. image:: ../../depicttk/images/releasenotes-2.4.1/prot-group_Fmoc.*
            :scale:  100
            :align:  center

* The following APIs have been added to mark up the bonds in SVG images generated
  by the :oe:func:`OEDepict::OERenderMolecule` functions:

  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondSVGMarkupFunctor`
  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomSVGMarkupFunctor`
  * :ref:`OEBondSVGMarkupBase <OEDepict_OEBondSVGMarkupBase>`
  * :ref:`OEBondSVGNoMarkup <OEDepict_OEBondSVGNoMarkup>`
  * :ref:`OEBondSVGBondIdxMarkup <OEDepict_OEBondSVGBondIdxMarkup>`

* A new :oe:func:`OEDepict::OEDrawHighlighting` function has been added to
  render molecule highlights into a separate image rather than into the molecule display.

* New :oe:func:`OEDepict::OEAddHighlighting` function overloads have been added
  that take an :ref:`OESubSearch <OEChem_OESubSearch>` object and highlight its matches
  on the molecule display.

* New :oe:func:`OEDepict::OEAddWatermark` functions have been added that render a light
  gray watermark onto an image or a molecule display.

* A new :oe:meth:`OEDepict::OEImageBase::GetSVGGroups` method has been added to return
  the SVG groups associated with the image.

* New :oe:func:`OEDepict::OERotateVector` and :oe:func:`OEDepict::OELengthenVector`
  functions have been added.

* A new :oe:func:`OEDepict::OEAddSVGHover` function has been added that takes two target
  SVG groups to create a "hover" effect.

Minor bug fixes
--------------------------------------------------------------------------------

* The minimum margin allowed for :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`
  has been reduced from ``5.0%`` to ``2.5%``.

* A duplicate SVG group warning is no longer thrown when transferring
  built-in SVG groups from one image to another.


OEDepict TK 2.4.2
================================================================================

New features
--------------------------------------------------------------------------------

* An option has been added to the molecule alignment process that allows it to
  accept alignments with a limited number of atom pair clashes in the fixed
  coordinates mode.
  See also the :oe:meth:`OEDepict::OEAlignmentOptions::GetMaxAllowedAtomPairClashes`
  and :oe:meth:`OEDepict::OEAlignmentOptions::SetMaxAllowedAtomPairClashes` methods of the
  :ref:`OEAlignmentOptions <OEDepict_OEAlignmentOptions>` class.

* In fixed coordinate alignment mode
  (see the :oe:meth:`OEDepict::OEAlignmentOptions::SetFixedCoords` method),
  the order in which single bonds are rotated in order to eliminate
  atom clashes has been improved.

* A new constructor has been added that allows the :ref:`OEAlignmentResult <OEDepict_OEAlignmentResult>`
  class to be initialized from an  :ref:`OEMatchBase <OEChem_OEMatchBase>` object.

Major bug fixes
--------------------------------------------------------------------------------

* A bug in the alignment process that occurred when the number
  of rotatable bonds of the fit molecule exceeded the built-in limit has been fixed. 

Minor bug fixes
--------------------------------------------------------------------------------

* A minor memory leak in the molecule alignment process has been fixed. 

* On macOS, the deprecated ``kCTLeftTextAlignment``, ``kCTRightTextAlignment``, and
  ``kCTCenterTextAlignment`` Core Graphics constants have been replaced with new APIs.
  These constants are used to handle text alignment when drawing in PNG images.

Documentation changes
--------------------------------------------------------------------------------

* The example in the :ref:`section_examples_summary_viewmdlsearch` section has been
  revised.


OEDepict TK 2.4.3
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The signature of the :oe:func:`OEDepict::OECreateWin32GraphicsImage` function
  has been changed to use
  `std::shared_ptr <https://en.cppreference.com/w/cpp/memory/shared_ptr>`_.

* SVG group IDs and names are now limited to 64 characters.

Python-specific changes
---------------------------------------------------------------------------------

* User-defined atom and bond SVG markings are now supported in Python.
  See the examples in the :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>` and
  :ref:`OEBondSVGMarkupBase <OEDepict_OEBondSVGMarkupBase>` base classes.


OEDepict TK 2.4.4
================================================================================

New features
--------------------------------------------------------------------------------

* Two new methods,
  :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetExplicitAtomLabelAngle` and
  :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetExplicitAtomLabelAngle`, have been added
  that control when explicit “C” labels will be displayed on the molecule graph.


OEDepict TK 2.4.5
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------
* A new function, :ref:`OEGetLabelPosition <OEDepict_OEGetLabelPosition>`, that identifies the position where atoms labels are added.

* Approximately 40 new protective groups have been added to the namespace
  :ref:`OEProtectiveGroupStyle <OEDepict_OEProtectiveGroupStyle>`.

* A new function, :ref:`HasProtectiveGroupStyle <OEDepict_HasProtectiveGroupStyle>`, has
  been added that determines whether a given protective group style has been set
  in :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`.

* The function :ref:`GetProtectiveGroupStyle <OEDepict_GetProtectiveGroupStyle>`
  has been deprecated. It can no longer be used to determine if multiple protective
  group styles from :ref:`OEProtectiveGroupStyle <OEDepict_OEProtectiveGroupStyle>` have been set.
  :ref:`HasProtectiveGroupStyle <OEDepict_HasProtectiveGroupStyle>`
  can now be used instead.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue that caused :ref:`OEPrepareAlignedDepiction <OEDepict_OEPrepareAlignedDepiction>` to generate incorrect stereo depictions when
  :ref:`SetClearCoords <OEDepict_SetClearCoords>`
  was set to ``false`` has been fixed.

* Figures have been added to show depiction with and without the new protective groups
  to :ref:`OEProtectiveGroupStyle <OEDepict_OEProtectiveGroupStyle>`.



OEDepict TK 2.4.6
================================================================================

*July 2021*

Minor internal improvements have been made.





OEDepict TK 2.4.7
================================================================================

*Fall 2021*

* Minor internal improvements have been made.
  



OEDepict TK 2.5.0
================================================================================

* Minor internal improvements have been made.




OEDepict TK 2.5.1
======================

Minor internal improvements have been made.





OEDepict TK 2.5.2
================================================================================

Minor internal improvements have been made.





OEDepict TK 2.5.3
================================================================================

Minor internal improvements have been made.





OEDepict TK 2.5.4
================================================================================

Minor internal improvements have been made.




OEDepict TK 2.5.5
================================================================================

Minor internal improvements have been made.



OEDepict TK 2.5.6
================================================================================

Minor internal improvements have been made.




OEDepict TK 2.6.0
================================================================================

Minor internal improvements have been made.


###############################################
Appendix: Selected Examples in Python
###############################################

These are full listings of programming examples that are excerpted or offered for download, elsewhere in this chapter.

.. oe:source:: AccessAtomDisplay.py
   :language: python

.. oe:source:: AccessBondDisplay.py
   :language: python

.. oe:source:: AddAtomClickEvent.py
   :language: python

.. oe:source:: AddBondClickEvent.py
   :language: python

.. oe:source:: AddSVGClickEvent.py
   :language: python

.. oe:source:: AddSVGHover.py
   :language: python

.. oe:source:: AddSVGToggle.py
   :language: python

.. oe:source:: AtomDisplayLabel.py
   :language: python

.. oe:source:: AtomPropIndex.py
   :language: python

.. oe:source:: AtomPropUser.py
   :language: python

.. oe:source:: AtomVisibility.py
   :language: python

.. oe:source:: BondPropIndex.py
   :language: python

.. oe:source:: BondPropUser.py
   :language: python

.. oe:source:: CreateSVGClass.py
   :language: python

.. oe:source:: CreateSVGGroup.py
   :language: python

.. oe:source:: DepictMDLQuery.py
   :language: python

.. oe:source:: DepictMDLReaction.py
   :language: python

.. oe:source:: DepictMDLReactionMapIdx.py
   :language: python

.. oe:source:: DepictMolConfigure.py
   :language: python

.. oe:source:: DepictMolGraph.py
   :language: python

.. oe:source:: DepictMolRealSize.py
   :language: python

.. oe:source:: DepictMolSimple.py
   :language: python

.. oe:source:: DepictMolSize.py
   :language: python

.. oe:source:: DepictMolStyle.py
   :language: python

.. oe:source:: DepictMolTransparent.py
   :language: python

.. oe:source:: DepictMolWithHyperlink.py
   :language: python

.. oe:source:: DrawLine.py
   :language: python

.. oe:source:: DrawObjects.py
   :language: python

.. oe:source:: FormatSupport.py
   :language: python

.. oe:source:: FPAlign.py
   :language: python

.. oe:source:: FPNoAlignment.py
   :language: python

.. oe:source:: HighlightByBallAndStick.py
   :language: python

.. oe:source:: HighlightByCogwheel.py
   :language: python

.. oe:source:: HighlightByColor.py
   :language: python

.. oe:source:: HighlightByLasso.py
   :language: python

.. oe:source:: HighlightByStick.py
   :language: python

.. oe:source:: HighlightMulti.py
   :language: python

.. oe:source:: HighlightOverlay.py
   :language: python

.. oe:source:: HighlightOverlayBallStick.py
   :language: python

.. oe:source:: HighlightSimple.py
   :language: python

.. oe:source:: HighlightStyle.py
   :language: python

.. oe:source:: HoverAtomText.py
   :language: python

.. oe:source:: HoverBondText.py
   :language: python

.. oe:source:: ImageFrame.py
   :language: python

.. oe:source:: ImageGridAutoScale.py
   :language: python

.. oe:source:: ImageGridFixedScale.py
   :language: python
    
.. oe:source:: ImageGridIter.py
   :language: python

.. oe:source:: ImageGridSimple.py
   :language: python

.. oe:source:: ImageScale.py
   :language: python

.. oe:source:: ImageTable.py
   :language: python

.. oe:source:: LegendLayout.py
   :language: python

.. oe:source:: MCSAlign.py
   :language: python

.. oe:source:: MCSNoAlignment.py
   :language: python

.. oe:source:: MultiPage.py
   :language: python

.. oe:source:: MultiPageReport.py
   :language: python

.. oe:source:: OE2DMolDisplayOpts.py
   :language: python    

.. oe:source:: OEAddHighlighting_Base.py
   :language: python

.. oe:source:: OEAddHighlighting_Style.py
   :language: python

.. oe:source:: OEAddLabel.py
   :language: python

.. oe:source:: OEAnnotateDepictionProblems.py
   :language: python

.. oe:source:: OEAnnotateValenceProblems.py
   :language: python

.. oe:source:: OEConfigureColor.py
   :language: python

.. oe:source:: OEDrawBorder.py
   :language: python

.. oe:source:: OEDrawTextToCenter.py
   :language: python
   
.. oe:source:: OEFont_SetProperties.py
   :language: python

.. oe:source:: OEHighlightLabel_SetProps.py
   :language: python

.. oe:source:: OEImageTableOpts_SetProps.py
   :language: python

.. oe:source:: OEIsRegisteredImageFile.py
   :language: python

.. oe:source:: OEPen_SetProperties.py
   :language: python

.. oe:source:: OERenderMolecule_fname_disp.py
   :language: python

.. oe:source:: OERenderMolecule_fname_mol.py
   :language: python

.. oe:source:: OERenderMolecule_image_disp.py
   :language: python

.. oe:source:: OERenderMolecule_image_mol.py
   :language: python

.. oe:source:: OERenderMolecule_stream_disp.py
   :language: python

.. oe:source:: OERenderMolecule_stream_mol.py
   :language: python

.. oe:source:: OEReportIter.py
   :language: python

.. oe:source:: OEReportOptions_SetProps.py
   :language: python

.. oe:source:: PrepareDepiction.py
   :language: python

.. oe:source:: RenderMoleculeToString.py
   :language: python

.. oe:source:: SubSearchAlign.py
   :language: python

.. oe:source:: SubSearchNoAlignment.py
   :language: python

.. oe:source:: ToggleAtomText.py
   :language: python

.. oe:source:: ToggleBondText.py
   :language: python

.. oe:source:: UserAtomMarkup.py
   :language: python

.. oe:source:: UserBondMarkup.py
   :language: python

.. oe:source:: WriteImageToString.py
   :language: python
   
.. oe:source:: WriteReportToString.py
   :language: python


.. |Bezier|    replace:: Bézier



.. _chapter_svg:

********************************************************************************
Generating Interactive SVG Images
********************************************************************************

SVG group
================================================================================

SVG `group <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/g>`_ is
a container for grouping and naming collections of SVG drawing elements.
In **OEDepict TK**, the :ref:`OESVGGroup <OEDepict_OESVGGroup>` class is to used
for grouping drawing instructions together.

The code snippet below shows how to create and use an
:ref:`OESVGGroup <OEDepict_OESVGGroup>` object.

.. oe:source:: CreateSVGGroup.py
   :language: python
   :noindent:
   :frag:     SNIPPET-CREATE-GROUP

.. oe:source:: CreateSVGGroup.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-CREATE-GROUP

.. oe:source:: CreateSVGGroup.java
   :language: java
   :noindent:
   :frag:     SNIPPET-CREATE-GROUP

.. oe:source:: CreateSVGGroup.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-CREATE-GROUP

.. only:: oehtml

   .. oe:language:: python

      .. admonition:: Download code

         :download:`CreateSVGGroup.py <../../../../wrappers/python/docexamples/depict/CreateSVGGroup.py>`

   .. oe:language:: c++

      .. admonition:: Download code

         :download:`CreateSVGGroup.cpp <../../../../sublibs/tklibs/depict/examples/docs/CreateSVGGroup.cpp>`

   .. oe:language:: java

      .. admonition:: Download code

         :download:`CreateSVGGroup.java <../../../../wrappers/java/examples/openeye/docexamples/oedepict/CreateSVGGroup.java>`

   .. oe:language:: csharp

      .. admonition:: Download code

         :download:`CreateSVGGroup.cs <../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/CreateSVGGroup.cs>`

* First an :ref:`OESVGGroup <OEDepict_OESVGGroup>` object is created on the image by
  calling the :oe:meth:`OEDepict::OEImageBase::NewSVGGroup` method.

* The  :ref:`OESVGGroup <OEDepict_OESVGGroup>` object is the can be utilized by
  invoking the :oe:meth:`OEDepict::OEImageBase::PushGroup` method.
  This result in writing the ``<g id='circle'>`` line into the :file:`svg`
  image.

* Each push has to be coupled with a corresponding pop.
  When the :oe:meth:`OEDepict::OEImageBase::PopGroup` method is invoked the
  ``</g>`` closing line will be written into the image file.

The above snippet will generate the following :file:`svg` image:

.. literalinclude:: depicttk/images/CreateSVGGroup.svg
   :emphasize-lines: 8, 10

The **guideline** below should be followed when using SVG groups
in **OEDepict TK**:

* The name of the :ref:`OESVGGroup <OEDepict_OESVGGroup>` has to be unique for the
  given image and it can only contain alphanumeric, ``_`` or ``-`` characters.

* An :ref:`OESVGGroup <OEDepict_OESVGGroup>` object can be used (pushed / popped) only
  once.

* :ref:`OESVGGroup <OEDepict_OESVGGroup>` objects can be nested.
  They should be used in LIFO (for last in, first out)
  i.e. the group that has been pushed last should be popped first.

.. seealso::

   * `Group SVG element <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/g>`_  section in MDN
   * `Grouping <https://www.w3.org/TR/SVG/struct.html#Groups>`_  section in W3C

SVG class
================================================================================

In **OEDepict TK**, the :ref:`OESVGClass <OEDepict_OESVGClass>` class can be used to add
`class <https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/class>`_
attributes to
`group <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/g>`_
containers.

The code snippet below shows how to create and use an
:ref:`OESVGClass <OEDepict_OESVGClass>` object.

.. oe:source:: CreateSVGClass.py
   :language: python
   :noindent:
   :frag:     SNIPPET-CREATE-CLASS

.. oe:source:: CreateSVGClass.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-CREATE-CLASS

.. oe:source:: CreateSVGClass.java
   :language: java
   :noindent:
   :frag:     SNIPPET-CREATE-CLASS

.. oe:source:: CreateSVGClass.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-CREATE-CLASS

.. only:: oehtml

   .. oe:language:: python

      .. admonition:: Download code

         :download:`CreateSVGClass.py <../../../../wrappers/python/docexamples/depict/CreateSVGClass.py>`

   .. oe:language:: c++

      .. admonition:: Download code

         :download:`CreateSVGClass.cpp <../../../../sublibs/tklibs/depict/examples/docs/CreateSVGClass.cpp>`

   .. oe:language:: java

      .. admonition:: Download code

         :download:`CreateSVGClass.java <../../../../wrappers/java/examples/openeye/docexamples/oedepict/CreateSVGClass.java>`

   .. oe:language:: csharp

      .. admonition:: Download code

         :download:`CreateSVGClass.cs <../../../../wrappers/csharp/Csharp-Examples/OEDepictDocs/CreateSVGClass.cs>`

* First two :ref:`OESVGGroup <OEDepict_OESVGGroup>` objects are created on the image,
  followed by creating a :ref:`OESVGClass <OEDepict_OESVGClass>` object by calling the
  :oe:meth:`OEDepict::OEImageBase::NewSVGClass` method.

* The :ref:`OESVGClass <OEDepict_OESVGClass>` object then can be added to any groups
  by calling :oe:meth:`OEDepict::OESVGGroup::AddSVGClass` method.

* When a :ref:`OESVGGroup <OEDepict_OESVGGroup>` object is pushed classes
  associated with it will be written into the :file:`svg` file:
  ``<g id='circle' class='object'>`` and ``<g id='rectangle' class='object'>``.

The above snippet will generate the following :file:`svg` image:

.. literalinclude:: depicttk/images/CreateSVGClass.svg
   :emphasize-lines: 8, 10-11, 13

The **guideline** below should be followed when using SVG
classes in **OEDepict TK**:

* The name of the :ref:`OESVGClass <OEDepict_OESVGClass>` has to be unique for the
  given image and it can only contain alphanumeric, ``_`` or ``-`` characters.

* An :ref:`OESVGClass <OEDepict_OESVGClass>` object can be associated with
  multiple :ref:`OESVGGroup <OEDepict_OESVGGroup>` objects.

* An :ref:`OESVGGroup <OEDepict_OESVGGroup>` object can be associated with
  multiple :ref:`OESVGClass <OEDepict_OESVGClass>` objects.

.. seealso::

   * `MDN Class attribute <https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/class>`_ section in MDN
   * `WSC Class attribute <https://www.w3.org/TR/SVG/styling.html#ClassAttribute>`_ section in WSC

Examples of Generating Interactive SVG Images
================================================================================

**OEDepict TK** also provides high-level APIs that are not only group SVG
elements together but also adds styles and events to them to generate
interactive images.

See the following **OEDepict TK** API:

* :oe:func:`OEDepict::OEAddSVGHover` and :oe:func:`OEDepict::OEAddSVGToggle`
  low-level functions that allow to add effects to any objects.

* :oe:func:`OEDepict::OEAddSVGClickEvent` low-level functions that allows
  to add click event to any objects.

* :oe:func:`OEDepict::OEDrawSVGHoverText` function that displays a text
  associated with an atom or bond when the mouse is hovering over their
  position on the image.

* :oe:func:`OEDepict::OEDrawSVGToggleText` function that displays a
  text associated with an atom or bond when clicking at their position on
  the image.

.. only:: oehtml

   .. list-table:: **Gallery of OEDepict TK examples of interactive SVG images**
      :widths: 150 150

      * - Hover the mouse over any atom
        - Click on any atom

      * - .. raw:: html

             <p align="center">
             <object data="../_images/HoverAtomText.svg" type="image/svg+xml"  width = "300" ></object>
             <p>

        - .. raw:: html

             <p align="center">
             <object data="../_images/ToggleAtomText.svg" type="image/svg+xml"  width = "300" ></object>
             <p>

      * - Hover the mouse over any bond
        - Click on the middle on any bond

      * - .. raw:: html

             <p align="center">
             <object data="../_images/HoverBondText.svg" type="image/svg+xml"  width = "300" ></object>
             <p>

        - .. raw:: html

             <p align="center">
             <object data="../_images/ToggleBondText.svg" type="image/svg+xml"  width = "300" ></object>
             <p>

   .. the above tiny images are necessary to copy them into the build subdirectory

   .. image:: /_images/HoverAtomText.svg
      :width: 1 pt

   .. image:: /_images/ToggleAtomText.svg
      :width: 1 pt

   .. image:: /_images/HoverBondText.svg
      :width: 1 pt

   .. image:: /_images/ToggleBondText.svg
      :width: 1 pt

See also the following **OEGrapheme TK** APIs that generate interactive
SVG images:

* :oe:func:`OEGrapheme::OERenderContactMap` function that generated an
  interactive protein-ligand contact map image.
  Clicking on any residue will highlight those ligand atoms that are interacting
  with the residue.

.. only:: oehtml

   .. raw:: html

      <p align="center">
      <b>click on any residue circles</b>
      </p>

      <p align="center">
      <object data="../_images/RenderContactMap.svg" type="image/svg+xml"  width = "400" ></object>
      <p>

   .. the above tiny image is necessary to copy it into the build subdirectory

   .. image:: /_images/RenderContactMap.svg
      :width: 1pt

* :oe:func:`OEGrapheme::OEDrawIridiumData` function
* :oe:func:`OEGrapheme::OEDrawPeptide` function
* :oe:func:`OEGrapheme::OERenderRamachandranPlot` function
* :oe:func:`OEGrapheme::OERenderBFactorMap` function

.. _section_svg_insert_html:

Inserting SVG Images into HTML
================================================================================

The interactive :file:`svg` image generated by **OEDepict TK**
and **Grapheme TK** can inserted into HTML files with the SVG MIME type:

.. code-block:: console

   <object data="<imagename>.svg" type="image/svg+xml"></object>

The following example inserts two :file:`svg` images into an HTML table:

.. literalinclude:: depicttk/images/svg/InsertSVG/insert-index.html
   :emphasize-lines: 16-17

Download the following three files and open the ``insert-index.html`` file
in a browser.

.. only:: oehtml

   .. admonition:: Download code

      :download:`insert-index.html <images/svg/InsertSVG/insert-index.html>`
      :download:`hover-atom-text.svg <images/svg/InsertSVG/hover-atom-text.svg>`
      :download:`toggle-atom-text.svg <images/svg/InsertSVG/toggle-atom-text.svg>`

.. _section_svg_event:

How to Catch SVG Events
================================================================================

The example in this section illustrates how to throw a mouse event in an
:file:`.svg` image and how to catch it in a :file:`html` file.

The code below shows how to create an :file:`.svg` image where each atom is
associated with an SVG event.  When clicking on an atom in the image, a
`click <https://developer.mozilla.org/en-US/docs/Web/Events/click>`_  event is
fired with the message specified in the :oe:func:`OEDepict::OEAddSVGClickEvent`
function.

.. oe:source:: AddAtomClickEvent.cpp
   :language: c++
   :frag:     SNIPPET-ADDATOMCLICKEVENT

.. oe:source:: AddAtomClickEvent.py
   :language: python
   :frag:     SNIPPET-ADDATOMCLICKEVENT

The events thrown by the :file:`AddAtomClickEvent.svg` image can be caught
in the :file:`html` file that contains the image.  The following :file:`html`
file illustrates how to catch the events and display the messages that were
associated with the atoms using the
:oe:func:`OEDepict::OEAddSVGClickEvent` function.

.. literalinclude:: depicttk/images/svg/AddAtomClickEvent/index.html
   :emphasize-lines: 10-14, 22

To try it out follow the instructions below:

1. Generate a directory (such as ``test``) that contains both the
   :download:`AddAtomClickEvent.svg <images/svg/AddAtomClickEvent/AddAtomClickEvent.svg>`
   and the :download:`index.html <images/svg/AddAtomClickEvent/index.html>`
   file (click on them to download).

2. Start up a HTTP server inside ``test`` directory

   .. code-block:: console

      prompt> python -m http.server

3. Open http://0.0.0.0:8000 in your browser (see image below)

4. Click on any atom on the image and the message specified by the
   :oe:func:`OEDepict::OEAddSVGClickEvent` function will be
   displayed below the image.

.. figure:: /_images/ScreenShot-AddAtomClickEven.png
   :align:  center
   :width: 300 pt

   **Screenshot of the OEAddSVGClickEvent example in the browser**



.. _oedepict_part_theory:

*********************************
Theory
*********************************

.. toctree::
   :maxdepth: 2

   basic
   moldisplay
   highlighting
   layout
   multipage
   mdlquery
   mdlreaction
   molalign
   svg

.. docking toolkit documentation master file

.. _oedocking_part_theory:

###################################
OEDocking Toolkit |docking_version|
###################################

..  oe:language:: python

    .. toctree::
       :maxdepth: 3

       introduction
       theory/theory
       examples
       examples_models
       selected_examples_python
       api
       releasenotes/index

..  oe:language:: java c++ csharp

    .. toctree::
       :maxdepth: 3

       introduction
       theory/theory
       examples
       examples_models
       api
       releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _oedocking_chapter_intro:

********************************************************************************
Introduction
********************************************************************************

Welcome to the Docking Toolkit documentation
=================================================

The *Docking Toolkit* library provides a facility for docking and
scoring molecules in the context of a protein active site.

The following basic functionalities are available:

* Docking (see :ref:`chapter_docking` chapter)
* Pose Prediction ( see :ref:`chapter_poseprediction` chapter)
* Scoring (see :ref:`chapter_scoring` chapter)

The aim of this manual is to familiarize the user with the *Docking Toolkit*
functionalities, however, it does not provide explanations
of basic *OEChem* classes and functions. Therefore reading the
*OEChem* manual beforehand is highly recommended.

.. oe:language:: c++

   .. seealso::

      * :ref:`C++ Quick Start Manual <section_cpp_getting_started>` for
        installation instructions.
      * :ref:`Importing C++ Toolkits <section_cpp_tk_import>` section

.. oe:language:: python

   .. seealso::

      * :ref:`Python Quick Start Manual <section_python_getting_started>` for
        installation instructions.
      * :ref:`Importing Python Toolkits <section_python_tk_import>` section

.. oe:language:: java

   .. seealso::

      * :ref:`Java Quick Start Manual <section_java_getting_started>` for
        installation instructions.
      * :ref:`Importing Java Toolkits <section_java_tk_import>` section

.. oe:language:: csharp

   .. seealso::

      * :ref:`C# Quick Start Manual <section_csharp_getting_started>` for
        installation instructions.
      * :ref:`Importing C# Toolkits <section_csharp_tk_import` section


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEAlignReceptorFunction, AlignReceptorFunction

.. _OEDocking_OEAlignReceptorFunction:

.. oe:class:: OEAlignReceptorFunction

   .. oe:api::

      class OEAlignReceptorFunction

   :ref:`OEAlignReceptorFunction <OEDocking_OEAlignReceptorFunction>` is a pure virtual class that defines an
   API for aligning two receptors.

   This pure virtual class is intended to be subclassed in order to create an
   aligned receptor.  This is necessary because the receptor has multiple
   components that need to be aligned properly, such as the inner and outer
   contours and any bound or extra molecules attached to the receptor.

   .. oe:method:: SetupTarget

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupTarget(const OEChem::OEMolBase& target) = 0

      .. oe:language:: python

         .. oe:api:: python

            SetupTarget(target: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Called when setting the target molecule.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            virtual OESystem::OEIterBase<const OEChem::OETrans>* operator()(const OEChem::OEMolBase&receptor_to_align) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: Union[OEGraphMol,OEMol,OEQMol]) -> Iterable[OETrans]

   Implement to return the transformations that take receptor_to_align into
   the targets reference frame.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            virtual OEAlignReceptorFunction * CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAlignReceptorFunction

   Must return a fully instantiated OEAlignReceptor.


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEBox

.. _OEDocking_OEBox:

.. oe:class:: OEBox

   .. oe:api::

      class OEBox : public OEBoxBase

   :ref:`OEBox <OEDocking_OEBox>` class represents a box aligned to the x, y and z coordinate axis.

   This class is an implementation of the :ref:`OEBoxBase <OEDocking_OEBoxBase>` class.

   The following free functions can take :ref:`OEBox <OEDocking_OEBox>` objects by virtue of
   their inheritance from :ref:`OEBoxBase <OEDocking_OEBoxBase>`.

   ======================================= ====================================
   :oe:func:`OEDocking::OEBoxXMid`         :oe:func:`OEDocking::OEBoxXDim`     
   :oe:func:`OEDocking::OEBoxYMid`         :oe:func:`OEDocking::OEBoxYDim`     
   :oe:func:`OEDocking::OEBoxZMid`         :oe:func:`OEDocking::OEBoxZDim`     
   :oe:func:`OEDocking::OEInBox`           :oe:func:`OEDocking::OEBoxTranslate`
   :oe:func:`OEDocking::OEBoxExtend`       :oe:func:`OEDocking::OESetupBox`    
   :oe:func:`OEDocking::OEBoxVolume`       :oe:func:`OEDocking::OEBoxArea`     
   :oe:func:`OEDocking::OEMakeBoxMolecule`                                     
   ======================================= ====================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBox()

      .. oe:language:: python

         .. oe:api:: python

            OEBox() -> OEBox

      Default constructor.  All xyz min and max values are set to 0.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBox(float x1, float y1, float z1, float x2, float y2, float z2)

      .. oe:language:: python

         .. oe:api:: python

            OEBox(x1: float, y1: float, z1: float, x2: float, y2: float,
                  z2: float) -> OEBox

      Constructor that sets up the box.  The max and min X values will be set
      to the max and min of *x1*, *x2* respectively.  Minimum and maximum values of Y
      and Z are selected in an analogous fashion.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBox(const OEChem::OEMolBase& mol, float addbox = 0.0f)

      .. oe:language:: python

         .. oe:api:: python

            OEBox(mol: Union[OEGraphMol,OEQMol], addbox: float = 0.0) -> OEBox

      Constructs a box around the given molecule.  The maximum and minimum
      x, y and z values are set to the maximum and minimum values x, y and z
      coordinates of any atom of the molecule.

      If *addbox* is specified then each edge of the box is extended by *addbox*.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBox(const OEChem::OEMCMolBase& mol, float addbox = 0.0f)

      .. oe:language:: python

         .. oe:api:: python

            OEBox(mol: OEMol, addbox: float = 0.0) -> OEBox

      Constructs a box around the given molecule.  The maximum and minimum
      x, y and z values are set to the maximum and minimum values x, y and z
      coordinates of any atom of any pose of the molecule.

      If *addbox* is specified then each edge of the box is extended by *addbox*.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBox(const OEBox& box)

      .. oe:language:: python

         .. oe:api:: python

            OEBox(arg2: OEBox) -> OEBox

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBox(const OEBoxBase& box)

      .. oe:language:: python

         .. oe:api:: python

            OEBox(box: OEBoxBase) -> OEBox

      Constructs an :ref:`OEBox <OEDocking_OEBox>` from an :ref:`OEBoxBase <OEDocking_OEBoxBase>`.

   .. oe:method:: operator=
      :language: c++
  
      .. oe:api::

         OEBox& operator=(const OEBox& rhs)

      Assignment operator for :ref:`OEBoxBase <OEDocking_OEBoxBase>`.


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEBoxBase, BoxBase

.. _OEDocking_OEBoxBase:

.. oe:class:: OEBoxBase

   .. oe:api::

      class OEBoxBase

   :ref:`OEBoxBase <OEDocking_OEBoxBase>` class represents a box aligned to the x, y and z coordinate axis.

   This pure virtual class is implemented by :ref:`OEBox <OEDocking_OEBox>`.

   The following free functions take :ref:`OEBoxBase <OEDocking_OEBoxBase>`.

   ======================================= ====================================
   :oe:func:`OEDocking::OEBoxXMid`         :oe:func:`OEDocking::OEBoxXDim`     
   :oe:func:`OEDocking::OEBoxYMid`         :oe:func:`OEDocking::OEBoxYDim`     
   :oe:func:`OEDocking::OEBoxZMid`         :oe:func:`OEDocking::OEBoxZDim`     
   :oe:func:`OEDocking::OEInBox`           :oe:func:`OEDocking::OEBoxTranslate`
   :oe:func:`OEDocking::OEBoxExtend`       :oe:func:`OEDocking::OESetupBox`    
   :oe:func:`OEDocking::OEBoxVolume`       :oe:func:`OEDocking::OEBoxArea`     
   :oe:func:`OEDocking::OEMakeBoxMolecule`                                     
   ======================================= ====================================

   .. oe:method:: operator=
      :language: c++
      
      .. oe:api::

         OEBoxBase& operator=(const OEBoxBase& rhs)

      Assignment operator to another OEBoxBase

      Assignment operator.

   .. oe:method:: Destructor
      
      .. oe:api::

         virtual ~OEBoxBase() {}

      Destructor

   .. oe:method:: GetXMax
     
   .. oe:api::

          virtual float GetXMax() const   = 0

   Returns the maximum X value of the box

.. oe:method:: GetYMax
      
   .. oe:api::

          virtual float GetYMax() const   = 0

   Returns the maximum Y value of the box

.. oe:method:: GetZMax
      
   .. oe:api::

          virtual float GetZMax() const   = 0

   Returns the maximum Z value of the box

.. oe:method:: GetXMin
      
   .. oe:api::

          virtual float GetXMin() const   = 0

   Returns the minimum X value of the box

.. oe:method:: GetYMin
      
   .. oe:api::

          virtual float GetYMin() const   = 0

   Returns the minimum Y value of the box

.. oe:method:: GetZMin
      
   .. oe:api::

          virtual float GetZMin() const   = 0

   Returns the minimum z value of the box

.. oe:method:: Setup
      
   .. oe:api::

          virtual bool Setup(float x1,
                             float y1,
                             float z1,
                             float x2,
                             float y2,
                             float z2)   = 0

   Sets up the box.  The max and min X values are the max and min
   of *x1*, *x2* respectively.  Minimum and maximum values of Y and Z are
   selected in an analogous fashion.








.. oe:namespace:: OEDocking

.. meta::
   :keywords: OECustomConstraints, CustomConstraints

.. _OEDocking_OECustomConstraints:

.. oe:class:: OECustomConstraints

   .. oe:api::

      class OECustomConstraints

   :ref:`OECustomConstraints <OEDocking_OECustomConstraints>` holds a set of custom docking
   constraints used by :ref:`OEDock <OEDocking_OEDock>`.  Each custom constraint is defined by an
   :ref:`OEFeature <OEDocking_OEFeature>` contained by this class.
   
   To use the constraints specified by an
   :ref:`OECustomConstraints <OEDocking_OECustomConstraints>` object the object must be
   passed to the receptor with
   :oe:func:`OEDocking::OEReceptorSetCustomConstraints` prior to calling the
   :oe:meth:`OEDocking::OEDock::Initialize` method of
   :ref:`OEDock <OEDocking_OEDock>`.

   .. oe:method:: Constructors
      
      .. oe:language:: c++ java csharp

         .. oe:api::

            OECustomConstraints()

      .. oe:language:: python

         .. oe:api:: python

            OECustomConstraints() -> OECustomConstraints

      Default constructor.  Object contains no features in the default constructed state.    

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECustomConstraints(const OECustomConstraints& )

      .. oe:language:: python

         .. oe:api:: python

            OECustomConstraints(arg2: OECustomConstraints) -> OECustomConstraints
            OECustomConstraints(constr: OEReceptorCustomConstraints) -> OECustomConstraints

      Copy Constructor.

   .. oe:method:: operator=
      :language: c++
      
      .. oe:api::

         OECustomConstraints& operator=(const OECustomConstraints&)

      Assignment operator.
      
   .. oe:method:: GetFeatures

   .. oe:api::

                OESystem::OEIterBase<      OEFeature>* GetFeatures(bool enabledOnly = true)       
                OESystem::OEIterBase<const OEFeature>* GetFeatures(bool enabledOnly = true) const 

   Returns an iterator over all features contained by this class, 
   or all enabled features if *enabledOnly* is true 
   (see :oe:meth:`OEDocking::OEFeature::GetEnabled` method).

.. oe:method:: AddFeature
      
   .. oe:api::

                OEFeature* AddFeature() 

   Adds a new :ref:`OEFeature <OEDocking_OEFeature>` object to this class and returns a pointer
   to the newly created :ref:`OEFeature <OEDocking_OEFeature>`.  The returned
   :ref:`OEFeature <OEDocking_OEFeature>` object is owned by this class, and will be destroyed
   by the destructor of this class.

.. oe:method:: DeleteFeature
      
   .. oe:api::

                bool DeleteFeature(const OEFeature* feature) 

   Deletes an :ref:`OEFeature <OEDocking_OEFeature>` owned by this class.  Note that after
   this method is called *feature* will no longer point to a valid 
   :ref:`OEFeature <OEDocking_OEFeature>` object.

.. oe:method:: NumFeatures
      
   .. oe:api::

                unsigned int NumFeatures(bool enabledOnly = true) const 

   Returns the number of :ref:`OEFeature <OEDocking_OEFeature>` objects contained by this
   class.  

   If *enabledOnly* is true then only :ref:`OEFeature <OEDocking_OEFeature>` objects
   for which the method :oe:meth:`OEDocking::OEFeature::GetEnabled` returns true will
   be counted.
 
.. oe:method:: Clear
      
   .. oe:api::

                bool Clear() 

   Returns this object to its default constructed state, deleting any 
   :ref:`OEFeature <OEDocking_OEFeature>` objects it may currently be holding.





.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDock, Dock

.. _OEDocking_OEDock:

.. oe:class:: OEDock

   .. oe:api::

      class OEDock

   :ref:`OEDock <OEDocking_OEDock>` is used to dock and score multiconformer
   molecules in an active site.

   Use the following procedure to dock and score molecules with this class.

   #. Initialize the active site by passing a design unit containing a receptor (see
      :ref:`chapter_receptor` chapter) to the
      :oe:meth:`OEDocking::OEDock::Initialize` method.

   #. Dock molecules using the
      :oe:meth:`OEDocking::OEDock::DockMultiConformerMolecule` method.

   #. Score docked molecules with any of the following methods

      * :oe:meth:`OEDocking::OEDock::ScoreLigand`
      * :oe:meth:`OEDocking::OEDock::ScoreAtom`
      * :oe:meth:`OEDocking::OEDock::ScoreLigandComponent`
      * :oe:meth:`OEDocking::OEDock::ScoreAtomComponent`
      * :oe:meth:`OEDocking::OEDock::AnnotatePose`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDock(unsigned int scoring = OEDockMethod::Default,
            unsigned int resolution = OESearchResolution::Default)
            OEDock(const OEDockOptions&)
            OEDock(const OEDock&)

      .. oe:language:: python

         .. oe:api:: python

            OEDock(scoring: int, resolution: int) -> OEDock
            OEDock(arg2: OEDockOptions) -> OEDock
            OEDock(arg2: OEDock) -> OEDock

   Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDock & operator=(const OEDock & rhs)

      Assignment operator.

   .. oe:method:: IsInitialized

   .. oe:api::

               bool IsInitialized() const

   Returns true if this object has been successfully initialized
   and is ready to dock molecules.
   
   .. oe:method:: Initialize

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Initialize(const OEBio::OEDesignUnit&)
            bool Initialize(const OEChem::OEMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            Initialize(du: OEDesignUnit) -> bool
            Initialize(receptor: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets up this object to dock molecules into a receptor. This function returns true if initialization was successful.
      This object does not depend upon receptor once this call is completed (*i.e.* receptor can be destroyed after
      calling this method).  The first overload expects a design unit that contains a receptor. The second overload works on a 
      variation of molecule that contains receptor data.

      Note: This method can take several minutes to complete with larger active sites.

   ..   _OEDocking_DockMultiConformerMolecule:

   .. oe:method:: DockMultiConformerMolecule

      Both overloads of this method dock *inputMol* into the receptor passed to the 
      :oe:meth:`OEDocking::OEDock::Initialize` method.  

      The return value of this method describes the result of the docking, 
      with a value from the :oe:constns:`OEDocking::OEDockingReturnCode` namespace.
      A result of :oe:const:`OEDocking::OEDockingReturnCode::Success` indicates
      docking was successful.

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int DockMultiConformerMolecule(OEChem::OEMolBase& dockedMol,
                                                    const OEChem::OEMCMolBase& inputMol)

      .. oe:language:: python

         .. oe:api:: python

            DockMultiConformerMolecule(dockedMol: Union[OEGraphMol,OEMol,OEQMol],
                                       inputMol: OEMol) -> int

      This overload of 
      :oe:meth:`OEDocking::OEDock::DockMultiConformerMolecule` returns 
      the top scoring pose.

         *dockedMol*   
            Top scoring docked pose of *inputMol*.

         *inputMol*    
            A multiconformer representation of a molecule to dock.
            Must have 3D coordinates assigned.

      The score of the docked pose can be obtained by calling the
      :oe:cls:`OEChem::OEMolBase::GetEnergy` method of *dockedMol*.

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int DockMultiConformerMolecule(OEChem::OEMCMolBase& dockedMol,
                                                    const OEChem::OEMCMolBase& inputMol,
                                                    unsigned int numPoses = 1)

      .. oe:language:: python

         .. oe:api:: python

            DockMultiConformerMolecule(dockedMol: OEMol, inputMol: OEMol,
                                       numPoses: int = 1) -> int

      This overload of 
      :oe:meth:`OEDocking::OEDock::DockMultiConformerMolecule` can
      return alternate docked poses, in addition to the top scoring pose.
         
         *dockedMol*   
            Docked poses of *inputMol*.  Poses are stored as
            conformers of the :ref:`OEMCMolBase <OEChem_OEMCMolBase>`
            and are sorted by score.

         *inputMol*    
            A multiconformer representation of a molecule to dock.
            Must have 3D coordinates assigned.

         *numPoses*    
            Maximum number of top scoring docked poses to return
            in *dockedMol*.  Typically this will be the number of
            poses returned, however, in highly restricted sites fewer
            than *numPoses* may be returned.  The value of *numPoses*
            must be greater than zero.

      The score of the docked poses can be obtained by calling the
      :oe:cls:`OEChem::OEMolBase::GetEnergy` method on the conformers of *dockedMol*.

   .. oe:method:: GetHighScoresAreBetter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetHighScoresAreBetter() const

      .. oe:language:: python

         .. oe:api:: python

            GetHighScoresAreBetter() -> bool

      Returns true if higher scores indicate a better result.

      Returns false if lower scores indicate a better result.

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the name of the scoring function docked poses are scored with.

   .. oe:method:: GetComponentNames

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<const std::string>* GetComponentNames() const

      .. oe:language:: python

         .. oe:api:: python

            GetComponentNames() -> Iterable[str]

   .. oe:method:: ScoreLigand

      .. oe:language:: c++ java csharp

         .. oe:api::

            float ScoreLigand(const OEChem::OEMolBase& pose)

      .. oe:language:: python

         .. oe:api:: python

            ScoreLigand(pose: Union[OEGraphMol,OEMol,OEQMol]) -> float

      Rescores a pose within the active site.

         *pose*        
            Structure of a pose within the active site

      If an error occurs this function will return FLT_MAX if 
      :oe:meth:`OEDocking::OEDock::GetHighScoresAreBetter` returns false
      or -FLT_MAX otherwise.

   .. oe:method:: ScoreAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            float ScoreAtom(const OEChem::OEAtomBase* atom,
            const OEChem::OEMolBase& pose)

      .. oe:language:: python

         .. oe:api:: python

            ScoreAtom(atom: OEAtomBase, pose: Union[OEGraphMol,OEMol,OEQMol]) -> float

      Returns the score of an atom of a given pose within the active site.

         *atom*        
            Atom of *pose* to score.

         *pose*
            Structure of a pose within the active site

      If an error occurs this function will return FLT_MAX if 
      :oe:meth:`OEDocking::OEDock::GetHighScoresAreBetter` returns false
      or -FLT_MAX otherwise.

   .. oe:method:: ScoreLigandComponent

      .. oe:language:: c++ java csharp

         .. oe:api::

            float ScoreLigandComponent(const OEChem::OEMolBase& pose,
                                       std::string compName)

      .. oe:language:: python

         .. oe:api:: python

            ScoreLigandComponent(pose: Union[OEGraphMol,OEMol,OEQMol],
                                 compName: str) -> float

      Returns the given components contribution to the total score.

         *pose*
            Structure of a pose within the active site

         *compName*
            Name of the score component to report.  Name must be one
            returned by 
            :oe:meth:`OEDocking::OEDock::GetComponentNames`.

      If an error occurs this function will return FLT_MAX if 
      :oe:meth:`OEDocking::OEDock::GetHighScoresAreBetter` returns false
      or -FLT_MAX otherwise.

   .. oe:method:: ScoreAtomComponent

      .. oe:language:: c++ java csharp

         .. oe:api::

            float ScoreAtomComponent(const OEChem::OEAtomBase* atom,
            const OEChem::OEMolBase& pose, std::string compName)

      .. oe:language:: python

         .. oe:api:: python

            ScoreAtomComponent(atom: OEAtomBase,
                               pose: Union[OEGraphMol,OEMol,OEQMol],
                               compName: str) -> float

      Returns the given components contribution to the score of a given atom score.

         *atom*
            Atom of *pose* to score.

         *pose*
            Structure of a pose within the active site

         *compName*
            Name of the score component to report.  Name must be one
            returned by 
            :oe:meth:`OEDocking::OEDock::GetComponentNames`.

      If an error occurs this function will return FLT_MAX if 
      :oe:meth:`OEDocking::OEDock::GetHighScoresAreBetter` returns false
      or -FLT_MAX otherwise.

   .. oe:method:: AnnotatePose

      Adds **VIDA** scoring annotation to the *pose* or *poses* passed.

      The annotated poses must be written out in either *oeb* or *oeb.gz* format
      and are only viewable in **VIDA**.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AnnotatePose(OEChem::OEMolBase& pose)

      .. oe:language:: python

         .. oe:api:: python

            AnnotatePose(pose: OEMol) -> bool
            AnnotatePose(pose: Union[OEGraphMol,OEQMol]) -> bool

      This overload of :oe:meth:`OEDocking::OEDock::AnnotatePose` 
      annotates a single pose. 

         *pose*
            Structure of a pose within the active site

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AnnotatePose(OEChem::OEMCMolBase& poses)

      .. oe:language:: python

         .. oe:api:: python

            AnnotatePose(pose: OEMol) -> bool
            AnnotatePose(pose: Union[OEGraphMol,OEQMol]) -> bool

      This overload of :oe:meth:`OEDocking::OEDock::AnnotatePose` 
      annotates all poses of a given ligand.

         *poses*
            An :ref:`OEMCMolBase <OEChem_OEMCMolBase>` the conformers of which are
            poses within the active site.

   .. oe:method:: CacheScoringSetup

      This function caches the current scoring setup of the 
      :ref:`OEDock <OEDocking_OEDock>` object onto a receptor object.  When
      another :ref:`OEDock <OEDocking_OEDock>` object is initialized with this
      receptor the it will read in the cached score data rather than 
      recalculating it from scratch, thus improving the startup time of the 
      :ref:`OEDock <OEDocking_OEDock>` object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CacheScoringSetup(OEBio::OEDesignUnit& receptor,
                                   bool clearOldData = true)
            bool CacheScoringSetup(OEChem::OEMolBase& receptor,
                                   bool clearOldData = true)

      .. oe:language:: python

         .. oe:api:: python

            CacheScoringSetup(du: OEDesignUnit, clearOldData: bool = True) -> bool
            CacheScoringSetup(receptor: Union[OEGraphMol,OEMol,OEQMol],
                              clearOldData: bool = True) -> bool

      *receptor*
         A receptor object.  This must be the same receptor object the :ref:`OEDock <OEDocking_OEDock>`
         object was initialized with or an exact copy.

      *clearOldData*
         Flag to clear cached data from a prior call to CacheScoringSetup with
         this receptor.  The cached data can be quite sizable (hundreds of
         megabytes), so leaving this flag at the default value of true is 
         recommended.

      .. note:: The cached score data on a receptor will be saved when the receptor is written to a file.



.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDockOptions, DockOptions

.. _OEDocking_OEDockOptions:

.. oe:class:: OEDockOptions

   .. oe:api::

      class OEDockOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for docking with *OEDock*.

   The :ref:`OEDockOptions <OEDocking_OEDockOptions>` class defines the following public methods:
    * :oe:meth:`GetResolution<OEDocking::OEDockOptions::GetResolution>` and
      :oe:meth:`SetResolution<OEDocking::OEDockOptions::SetResolution>`
    * :oe:meth:`GetScoreMethod<OEDocking::OEDockOptions::GetScoreMethod>` and
      :oe:meth:`SetScoreMethod<OEDocking::OEDockOptions::SetScoreMethod>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDockOptions()
            OEDockOptions(const OEDockOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEDockOptions() -> OEDockOptions
            OEDockOptions(arg2: OEDockOptions) -> OEDockOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDockOptions &operator=(const OEDockOptions &)

      Assignment operator.

   .. oe:method:: GetResolution

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetResolution() const

      .. oe:language:: python

         .. oe:api:: python

            GetResolution() -> int

      See :oe:meth:`SetResolution<OEDocking::OEDockOptions::SetResolution>` method.

   .. oe:method:: GetScoreMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetScoreMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreMethod() -> int

      See :oe:meth:`SetScoreMethod<OEDocking::OEDockOptions::SetScoreMethod>` method.

.. _OEDocking_OEDockOptions_SetResolution:

   .. oe:method:: SetResolution

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetResolution(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetResolution(value: int) -> bool

      Sets the **search resolution** for docking. Allowed resolutions are defined in the
      :oe:constns:`OEDocking::OESearchResolution` namespace.
      Default is :oe:const:`OEDocking::OESearchResolution::Standard`.

   .. oe:method:: SetScoreMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetScoreMethod(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreMethod(value: int) -> bool

      Sets the **scoring method** for docking. Allowed methods are defined in the
      :oe:constns:`OEDocking::OEDockMethod` namespace.
      Default is :oe:const:`OEDocking::OEDockMethod::Chemgauss4`.



.. _OEDockingClasses:

*******************
OEDocking Classes
*******************

.. oe:namespace:: OEDocking

.. toctree::

   OEDockOptions
   OEDock
   OEHybrid
   OEMakeReceptorOptions
   OEPoseOptimizer
   OEPoseOptimizerOptions
   OEPosit
   OEPositOptions
   OEPositProbability
   OEPositResults
   OEScore
   OESinglePoseResult


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEHybrid

.. _OEDocking_OEHybrid:

.. oe:class:: OEHybrid

   .. oe:api::

      class OEHybrid : public OEDock

   :ref:`OEHybrid <OEDocking_OEHybrid>` is used to dock and score multiconformer
   molecules in an active site using the :ref:`section_docking_hybrid`.

   The following methods are publicly inherited from :ref:`OEDock <OEDocking_OEDock>`:
    * :oe:meth:`IsInitialized<OEDocking::OEDock::IsInitialized>`
    * :oe:meth:`Initialize<OEDocking::OEDock::Initialize>`
    * :oe:meth:`DockMultiConformerMolecule<OEDocking::OEDock::DockMultiConformerMolecule>`
    * :oe:meth:`GetHighScoresAreBetter<OEDocking::OEDock::GetHighScoresAreBetter>`
    * :oe:meth:`GetName<OEDocking::OEDock::GetName>`
    * :oe:meth:`GetComponentNames<OEDocking::OEDock::GetComponentNames>`
    * :oe:meth:`ScoreLigand<OEDocking::OEDock::ScoreLigand>`
    * :oe:meth:`ScoreAtom<OEDocking::OEDock::ScoreAtom>`
    * :oe:meth:`ScoreLigandComponent<OEDocking::OEDock::ScoreLigandComponent>`
    * :oe:meth:`ScoreAtomComponent<OEDocking::OEDock::ScoreAtomComponent>`
    * :oe:meth:`AnnotatePose<OEDocking::OEDock::AnnotatePose>`
    * :oe:meth:`CacheScoringSetup<OEDocking::OEDock::CacheScoringSetup>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHybrid(unsigned int scoring = OEDockMethod::Hybrid2,
            unsigned int resolution = OESearchResolution::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEHybrid(scoring: int, resolution: int) -> OEHybrid

   Default and copy constructors.


.. _preliminary_OEDockingClasses:

*****************************
Preliminary OEDocking Classes
*****************************

.. oe:namespace:: OEDocking

.. toctree::

   OEShapeFit
   OEShapeFitOptions
   OEShapeFitResults


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEShapeFit, ShapeFit

.. _OEDocking_OEShapeFit:

.. oe:class:: OEShapeFit

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEShapeFit

   .. note::

      With the default settings, the :ref:`OEShapeFit <OEDocking_OEShapeFit>` flexibly optimizes
      shape overlap and force field.

   
   The :ref:`OEShapeFit <OEDocking_OEShapeFit>` class provides an interface for pose generation using 
   flexible overlay optimization between a reference bound ligand or a bound ligand present in a 
   reference design unit and a fit molecule conformers.

   The :ref:`OEShapeFit <OEDocking_OEShapeFit>` class defines the following public methods:
    * :oe:meth:`SetupRef<OEDocking::OEShapeFit::SetupRef>`
    * :oe:meth:`Fit<OEDocking::OEShapeFit::Fit>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeFit(const OEShapeFitOptions& options = OEShapeFitOptions())
            OEShapeFit(const OEShapeFit&)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeFit(options: OEShapeFitOptions = OEShapeFitOptions()) -> OEShapeFit
            OEShapeFit(arg2: OEShapeFit) -> OEShapeFit

      Constructors. The parameterized constructor accepts an
      :ref:`OEShapeFitOptions <OEDocking_OEShapeFitOptions>` object; if omitted
      the defaults are used.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeFit &operator=(const OEShapeFit&)

.. _OEDocking_OEShapeFit_SetupRef:

      Assignment operator.

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEBio::OEDesignUnit&)
            bool SetupRef(const OEChem::OEMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(du: OEDesignUnit) -> bool
            SetupRef(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This method defines the interface for setting up the reference for the 
      :ref:`OEShapeFit <OEDocking_OEShapeFit>` ShapeFit optimization process.  

   .. oe:method:: Fit

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEShapeFitResults>* Fit(OEChem::OEMCMolBase& fitmol,
                                                         const unsigned numPoses = 1)

      .. oe:language:: python

         .. oe:api:: python

            Fit(fitmol: OEMol, numPoses: int = 1) -> Iterable[OEShapeFitResults]

      This method optimizes the shape and chemical similarity between the fit molecule 
      and a bound ligand in the design unit, along with intra-molecular forcefield energies 
      of the fit molecule, simultaneously. The reference design unit must be set using 
      :oe:meth:`SetupRef<OEDocking::OEShapeFit::SetupRef>` method.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEShapeFitOptions, ShapeFitOptions

.. _OEDocking_OEShapeFitOptions:

.. oe:class:: OEShapeFitOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEShapeFitOptions : public OEShape::OEFlexiOverlayOptions

   This class provides an interface to setup options to generate pose conformers using
   **flexible overlay optimization** between the bound ligand present in the reference 
   design unit and a fit molecule 
   using :ref:`OEShapeFit <OEDocking_OEShapeFit>`.

   The :ref:`OEShapeFitOptions <OEDocking_OEShapeFitOptions>` class defines the following public methods:
    * :oe:meth:`GetFullConformationSearch<OEDocking::OEShapeFitOptions::GetFullConformationSearch>` and
      :oe:meth:`SetFullConformationSearch<OEDocking::OEShapeFitOptions::SetFullConformationSearch>`
    * :oe:meth:`GetMaxLocalStrain<OEDocking::OEShapeFitOptions::GetMaxLocalStrain>` and
      :oe:meth:`SetMaxLocalStrain<OEDocking::OEShapeFitOptions::SetMaxLocalStrain>`
    * :oe:meth:`GetMaxOptSteps<OEDocking::OEShapeFitOptions::GetMaxOptSteps>` and
      :oe:meth:`SetMaxOptSteps<OEDocking::OEShapeFitOptions::SetMaxOptSteps>`
    * :oe:meth:`GetTorLib<OEDocking::OEShapeFitOptions::GetTorLib>` and
      :oe:meth:`SetTorLib<OEDocking::OEShapeFitOptions::SetTorLib>`
    * :oe:meth:`GetFlexiOverlapOptions<OEDocking::OEShapeFitOptions::GetFlexiOverlapOptions>` and
      :oe:meth:`SetFlexiOverlapOptions<OEDocking::OEShapeFitOptions::SetFlexiOverlapOptions>`
    * :oe:meth:`GetRigidOverlayOptions<OEDocking::OEShapeFitOptions::GetRigidOverlayOptions>` and
      :oe:meth:`SetRigidOverlayOptions<OEDocking::OEShapeFitOptions::SetRigidOverlayOptions>`
    * :oe:meth:`CreateCopy<OEDocking::OEShapeFitOptions::CreateCopy>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeFitOptions()
            OEShapeFitOptions(const OEShapeFitOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeFitOptions() -> OEShapeFitOptions
            OEShapeFitOptions(arg2: OEShapeFitOptions) -> OEShapeFitOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeFitOptions &operator=(const OEShapeFitOptions&)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeFitOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEShapeFitOptions

      Creates and returns a deep copy of this object.

.. _OEDocking_OEShapeFitOptions_GetFullConformationSearch:

   .. oe:method:: GetFullConformationSearch

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFullConformationSearch() const

      .. oe:language:: python

         .. oe:api:: python

            GetFullConformationSearch() -> bool

      See :oe:meth:`SetFullConformationSearch<OEDocking::OEShapeFitOptions::SetFullConformationSearch>` method.

.. _OEDocking_OEShapeFitOptions_GetMaxOptSteps:

   .. oe:method:: GetMaxOptSteps

      .. oe:api::

         unsigned GetMaxOptSteps() const

      See :oe:meth:`SetMaxOptSteps<OEDocking::OEShapeFitOptions::SetMaxOptSteps>` method.

.. _OEDocking_OEShapeFitOptions_GetTorLib:

   .. oe:method:: GetTorLib

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEConfGen::OETorLib* GetTorLib() const

      .. oe:language:: python

         .. oe:api:: python

            GetTorLib() -> OETorLib

      See :oe:meth:`SetTorLib<OEDocking::OEShapeFitOptions::SetTorLib>` method.

.. _OEDocking_OEShapeFitOptions_GetFlexiOverlapOptions:

   .. oe:method:: GetFlexiOverlapOptions

      .. oe:api::

               OEFlexiOverlapOptions& GetFlexiOverlapOptions()
               const OEFlexiOverlapOptions& GetFlexiOverlapOptions() const

      Returns a reference to the :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` instance as currently set.
      These are options related to flexible overlap optimization using shape, color, and force field.
      See also :oe:meth:`SetFlexiOverlapOptions<OEDocking::OEShapeFitOptions::SetFlexiOverlapOptions>` method.

.. _OEDocking_OEShapeFitOptions_GetMaxLocalStrain:

   .. oe:method:: GetMaxLocalStrain

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMaxLocalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxLocalStrain() -> float

      See :ref:`SetMaxLocalStrain<OEDocking_OEShapeFitOptions_SetMaxLocalStrain>` method.

.. _OEDocking_OEShapeFitOptions_GetRigidOverlayOptions:

   .. oe:method:: GetRigidOverlayOptions

      .. oe:api::

               OEOverlayOptions& GetRigidOverlayOptions()
               const OEOverlayOptions& GetRigidOverlayOptions() const

      Returns a reference to the :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>` instance as currently set.
      These are options related to rigid overlay optimization using shape and color.
      See also :oe:meth:`SetRigidOverlayOptions<OEDocking::OEShapeFitOptions::SetRigidOverlayOptions>` method.

.. _OEDocking_OEShapeFitOptions_SetFullConformationSearch:

   .. oe:method:: SetFullConformationSearch

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFullConformationSearch(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetFullConformationSearch(value: bool) -> bool

      Sets flag **to perform full conformation search**.
      Setting this option to ``true`` enables internal rotamer conformer generation,
      prior to running :ref:`OEShapeFit <OEDocking_OEShapeFit>`. 
      Default: ``false``.

.. _OEDocking_OEShapeFitOptions_SetMaxLocalStrain:

   .. oe:method:: SetMaxLocalStrain

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxLocalStrain(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxLocalStrain(value: float) -> bool

      Sets the **Number allowable local strain** in the generated hits.
      **Default: 6.5.**

.. _OEDocking_OEShapeFitOptions_SetMaxOptSteps:

   .. oe:method:: SetMaxOptSteps

      .. oe:api::

         bool SetMaxOptSteps(const unsigned)

      Sets the maximum number of optimization iteration steps in flexible overlay optimization.
      Default: `2000` steps.

.. _OEDocking_OEShapeFitOptions_SetTorLib:

   .. oe:method:: SetTorLib

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTorLib(const unsigned)
            bool SetTorLib(const std::string&)
            bool SetTorLib(const OEConfGen::OETorLib&)

      .. oe:language:: python

         .. oe:api:: python

            SetTorLib(value: int) -> bool
            SetTorLib(value: str) -> bool
            SetTorLib(value: oeistream) -> bool
            SetTorLib(value: OETorLib) -> bool

      Sets the **torsion library** that is used for torsion driving during conformer generation.  
      The first overload takes an `unsigned` from the :ref:`OETorLibType <OEConfGen_OETorLibType>` namespace,
      and the second overload takes the corresponding string values.
      **Default:** :oe:const:`OEConfGen::OETorLibType::Original`

.. _OEDocking_OEShapeFitOptions_SetFlexiOverlapOptions:

   .. oe:method:: SetFlexiOverlapOptions

      .. oe:api::

         void SetFlexiOverlapOptions(const OEFlexiOverlapOptions&)

      Sets the options related to flexible overlap calculations by passing in :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` instance.

.. _OEDocking_OEShapeFitOptions_SetRigidOverlayOptions:

   .. oe:method:: SetRigidOverlayOptions

      .. oe:api::

         void SetRigidOverlayOptions(const OEOverlayOptions&)

      Sets the options related to overlay optimization using shape and color by passing in :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` instance.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEShapeFitResults, ShapeFitResults

.. _OEDocking_OEShapeFitResults:

.. oe:class:: OEShapeFitResults

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEShapeFitResults

   .. seealso::

      * :ref:`OEFlexiOverlapResults <OEShape_OEFlexiOverlapResults>` class
      * :ref:`OEOverlapResults <OEShape_OEOverlapResults>` class

   The :ref:`OEShapeFitResults <OEDocking_OEShapeFitResults>` class defines the following public method:
    * :oe:meth:`GetPose<OEDocking::OEShapeFitResults::GetPose>`
    * :oe:meth:`GetScore<OEDocking::OEShapeFitResults::GetScore>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeFitResults()
            OEShapeFitResults(const OEShapeFitResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeFitResults() -> OEShapeFitResults
            OEShapeFitResults(rhs: OEShapeFitResults) -> OEShapeFitResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeFitResults &operator=(const OEShapeFitResults&)

      Assignment operator.

   .. oe:method:: GetPose

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase& GetPose() const

      .. oe:language:: python

         .. oe:api:: python

            GetPose() -> OEGraphMol

      Returns the flexibly optimized pose.

   .. oe:method:: GetScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetScore() -> float

      Returns the **estimated probability of accuracy** of the generated pose to the bound ligand.



******************************
OEDocking Classes (Deprecated)
******************************

.. oe:namespace:: OEDocking

.. toctree::

   OEAlignReceptorFunction
   OEBoxBase
   OEBox
   OECustomConstraints
   OEFeature
   OEProteinConstraint
   OESphereBase


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEFeature

.. _OEDocking_OEFeature:

.. oe:class:: OEFeature

   .. oe:api::

      class OEFeature

   :ref:`OEFeature <OEDocking_OEFeature>` is a pure virtual class that defines a single
   custom docking constraint used by :ref:`OEDock <OEDocking_OEDock>`.

   :ref:`OEFeature <OEDocking_OEFeature>` objects are created by the
   :ref:`OECustomConstraints <OEDocking_OECustomConstraints>` class (see
   :oe:meth:`OEDocking::OECustomConstraints::AddFeature`).

   To satisfy a docking constraint a pose must either have: 

   #. At least one atom that
      matches one of the SMARTS patterns returned by 
      :oe:meth:`OEDocking::OEFeature::GetSmarts`
      **and** falls within one of the spheres returned by 
      :oe:meth:`OEDocking::OEFeature::GetSpheres`.  

   #. At least one heavy atom that falls within one of the spheres
      returned by :oe:meth:`OEDocking::OEFeature::GetSpheres`, **if**
      the :ref:`OEFeature <OEDocking_OEFeature>` has no SMARTS patterns.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFeature& operator=(const OEFeature&)

      Assignment operator.

   .. oe:method:: Destructor

      .. oe:api::

         virtual ~OEFeature() {}

      Destructor.

   .. oe:method:: GetSpheres

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<const OESphereBase>* GetSpheres() const
            OESystem::OEIterBase<OESphereBase>* GetSpheres()

      .. oe:language:: python

         .. oe:api:: python

            GetSpheres() -> Iterable[OESphereBase]

      Returns all spheres associated with this custom constraint feature.

   .. oe:method:: AddSphere

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESphereBase* AddSphere()
            OESphereBase* AddSphere(const OESphereBase& sph)

      .. oe:language:: python

         .. oe:api:: python

            AddSphere() -> OESphereBase
            AddSphere(arg2: OESphereBase) -> OESphereBase

      Adds an :ref:`OESphereBase <OEDocking_OESphereBase>` object to this class.  If
      *sph* is passed the created sphere will be a copy of *sph* otherwise
      a default constructed sphere will be created.

      Note that the returned memory is owned by this class and will be
      destroyed by the destructor of this class.

   .. oe:method:: DeleteSphere

      .. oe:api::

         bool DeleteSphere(const OEMath::OESphere* sph)

      Deletes a :ref:`OESphereBase <OEDocking_OESphereBase>` held by this class.  Note
      that after this call *sph* will no longer point to a valid 
      :ref:`OESphereBase <OEDocking_OESphereBase>` object.

   .. oe:method:: NumSpheres

      .. oe:api::

         unsigned NumSpheres() const

      Returns the number of spheres held by this object.

   .. oe:method:: ClearSpheres

      .. oe:api::

         bool ClearSpheres()

      Returns this object to its default constructed state.  Deleting all
      spheres and SMARTS patterns it currently holds.

   .. oe:method:: GetSmarts
      :language: c++

      .. oe:api::

         OESystem::OEIterBase<const std::string>* GetSmarts() const
         OESystem::OEIterBase<std::string>* GetSmarts()

      Returns an iterator over all SMARTS patterns associated with this
      :ref:`OEFeature <OEDocking_OEFeature>`.

   .. oe:method:: AddSmarts

      .. oe:api::

         bool AddSmarts(const std::string& smarts)

      Adds a SMARTS pattern to this :ref:`OEFeature <OEDocking_OEFeature>`.

   .. oe:method:: DeleteSmarts

      .. oe:api::

         bool DeleteSmarts(const std::string& smarts)

      Deletes the specified SMARTS pattern from this :ref:`OEFeature <OEDocking_OEFeature>`.

   .. oe:method:: NumSmarts

      .. oe:api::

         unsigned NumSmarts() const

      Returns the number of SMARTS patterns held by this 
      :ref:`OEFeature <OEDocking_OEFeature>`.

   .. oe:method:: ClearSmarts

      .. oe:api::

         bool ClearSmarts()

      Deletes all SMARTS patterns associated with this 
      :ref:`OEFeature <OEDocking_OEFeature>`.

   .. oe:method:: SetFeatureName

      .. oe:api::

         void SetFeatureName(const std::string&)

      Sets the name of this feature.

   .. oe:method:: GetFeatureName

      .. oe:api::

         std::string GetFeatureName() const

      Returns the name of the feature.

   .. oe:method:: SetEnabled

      .. oe:api::

         void SetEnabled(const bool enabled)

      Sets whether this feature is enabled or not.  If the feature
      is disabled the constraint will be ignored 
      during the docking process.

   .. oe:method:: GetEnabled

      .. oe:api::

         bool GetEnabled() const

      Returns whether this feature is enabled.  If this function
      returns false this constraint will be ignored during the
      docking process.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEReceptorConstraintFeature* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEFeature

      Creates a copy of this :ref:`OEFeature <OEDocking_OEFeature>`.  Note
      that the memory returned by this function is **not** owned by
      this class, and is the responsibility of the calling function.



.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEMakeReceptorOptions, MakeReceptorOptions

.. _OEDocking_OEMakeReceptorOptions:

.. oe:class:: OEMakeReceptorOptions

   .. oe:api::

      class OEMakeReceptorOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for *OEMakeReceptor*.

   The :ref:`OEMakeReceptorOptions <OEDocking_OEMakeReceptorOptions>` class defines the following public methods:
    * :oe:meth:`GetAutoConstraints<OEDocking::OEMakeReceptorOptions::GetAutoConstraints>` and
      :oe:meth:`SetAutoConstraints<OEDocking::OEMakeReceptorOptions::SetAutoConstraints>`
    * :oe:meth:`GetBoxExtension<OEDocking::OEMakeReceptorOptions::GetBoxExtension>` and
      :oe:meth:`SetBoxExtension<OEDocking::OEMakeReceptorOptions::SetBoxExtension>`
    * :oe:meth:`GetBoxMol<OEDocking::OEMakeReceptorOptions::GetBoxMol>` and
      :oe:meth:`SetBoxMol<OEDocking::OEMakeReceptorOptions::SetBoxMol>`
    * :oe:meth:`GetNegativeImageType<OEDocking::OEMakeReceptorOptions::GetNegativeImageType>` and
      :oe:meth:`SetNegativeImageType<OEDocking::OEMakeReceptorOptions::SetNegativeImageType>`
    * :oe:meth:`GetTargetMask<OEDocking::OEMakeReceptorOptions::GetTargetMask>` and
      :oe:meth:`SetTargetMask<OEDocking::OEMakeReceptorOptions::SetTargetMask>`
    * :oe:meth:`GetTargetPred<OEDocking::OEMakeReceptorOptions::GetTargetPred>` and
      :oe:meth:`SetTargetPred<OEDocking::OEMakeReceptorOptions::SetTargetPred>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMakeReceptorOptions()
            OEMakeReceptorOptions(const OEMakeReceptorOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEMakeReceptorOptions() -> OEMakeReceptorOptions
            OEMakeReceptorOptions(arg2: OEMakeReceptorOptions) -> OEMakeReceptorOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMakeReceptorOptions &operator=(const OEMakeReceptorOptions &)

      Assignment operator.

   .. oe:method:: GetAutoConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAutoConstraints() const

      .. oe:language:: python

         .. oe:api:: python

            GetAutoConstraints() -> bool

      See :oe:meth:`SetAutoConstraints<OEDocking::OEMakeReceptorOptions::SetAutoConstraints>` method.

   .. oe:method:: GetBoxExtension

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBoxExtension() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoxExtension() -> float

      See :oe:meth:`SetBoxExtension<OEDocking::OEMakeReceptorOptions::SetBoxExtension>` method.

   .. oe:method:: GetBoxMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase& GetBoxMol() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoxMol() -> OEGraphMol

      See :oe:meth:`SetBoxMol<OEDocking::OEMakeReceptorOptions::SetBoxMol>` method.

   .. oe:method:: GetNegativeImageType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetNegativeImageType() const

      .. oe:language:: python

         .. oe:api:: python

            GetNegativeImageType() -> int

      See :oe:meth:`SetNegativeImageType<OEDocking::OEMakeReceptorOptions::SetNegativeImageType>` method.

   .. oe:method:: GetTargetMask

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetTargetMask() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetMask() -> int

      See :oe:meth:`SetTargetMask<OEDocking::OEMakeReceptorOptions::SetTargetMask>` method.

   .. oe:method:: GetTargetPred

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetTargetPred() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetPred() -> str

      See :oe:meth:`SetTargetPred<OEDocking::OEMakeReceptorOptions::SetTargetPred>` method.

   ..   _OEDocking_SetAutoConstraints:

   .. oe:method:: SetAutoConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAutoConstraints(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAutoConstraints(value: bool) -> bool

      Sets flag if protein constraints should be automatically detected and added to the receptor. The auto 
      generated constraints are kept as disabled. Default: True.

   .. oe:method:: SetBoxExtension

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBoxExtension(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetBoxExtension(value: float) -> bool

      Sets the **amount** for each box face to be extended relative to the minimum box enclosing the 
      :oe:meth:`BoxMol<OEDocking::OEMakeReceptorOptions::SetBoxMol>`. Default: 0.0.

   ..   _OEDocking_SetBoxMol:

   .. oe:method:: SetBoxMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBoxMol(const OEChem::OEMolBase& value)

      .. oe:language:: python

         .. oe:api:: python

            SetBoxMol(value: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets the **molecule** representing the active site on the proteinStructure. The minimum size box that 
      encloses the molecule plus any desired :oe:meth:`extension<OEDocking::OEMakeReceptorOptions::SetBoxExtension>`
      is used as the active site encloser.

   .. oe:method:: SetNegativeImageType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNegativeImageType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetNegativeImageType(value: int) -> bool

      Sets the **negative image type** to be generated. Allowed methods are defined in the
      :oe:constns:`OEDocking::OENegativeImageType` namespace.
      Default is :oe:const:`OEDocking::OENegativeImageType::StandardShape`.

   .. oe:method:: SetTargetMask

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTargetMask(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetTargetMask(value: int) -> bool

      Sets the **target mask** specifying the components of the design unit to be used as receptor target.
      Allowed methods are defined in the :ref:`OEDesignUnitComponents <OEBio_OEDesignUnitComponents>` namespace.
      Default: :ref:`targetComplexNoSolvent <OEBio_targetComplexNoSolvent>`.

   ..   _OEDocking_SetTargetPred:

   .. oe:method:: SetTargetPred

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTargetPred(const std::string)

      .. oe:language:: python

         .. oe:api:: python

            SetTargetPred(value: str) -> bool

      Sets the **target predicate** which subsets the components in the TargetMask from the design unit if it matches
      anything in a specific component.


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEPoseOptimizer, PoseOptimizer

.. _OEDocking_OEPoseOptimizer:

.. oe:class:: OEPoseOptimizer

   .. oe:api::

      class OEPoseOptimizer

   The :ref:`OEPoseOptimizer <OEDocking_OEPoseOptimizer>` can be used to optimize a pose
   generated from :ref:`OEPosit <OEDocking_OEPosit>` calculation, to reduce clashes.

   The :ref:`OEPoseOptimizer <OEDocking_OEPoseOptimizer>` class defines the following public methods:
    * :oe:meth:`Optimize<OEDocking::OEPoseOptimizer::Optimize>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPoseOptimizer(const OEPoseOptimizerOptions& opts = OEPoseOptimizerOptions())
            OEPoseOptimizer(const OEPoseOptimizer &)

      .. oe:language:: python

         .. oe:api:: python

            OEPoseOptimizer(opts: OEPoseOptimizerOptions = OEPoseOptimizerOptions()) -> OEPoseOptimizer
            OEPoseOptimizer(arg2: OEPoseOptimizer) -> OEPoseOptimizer

   Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPoseOptimizer &operator=(const OEPoseOptimizer &)

   .. _OEDocking_OEPoseOptimizer_Optimize:

      Assignment operator.

   .. oe:method:: Optimize
   
      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Optimize(OEBio::OEDesignUnit& du,
                              const unsigned proteinMask,
                              const unsigned ligandMask)

      .. oe:language:: python

         .. oe:api:: python

            Optimize(du: OEDesignUnit, proteinMask: int, ligandMask: int) -> int

      Optimizes the pair of protein and ligand in the posed design unit.  Returns ``true`` if optimization
      was successful.


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEPoseOptimizerOptions, PoseOptimizerOptions

.. _OEDocking_OEPoseOptimizerOptions:

.. oe:class:: OEPoseOptimizerOptions

   .. oe:api::

      class OEPoseOptimizerOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for docking with *OEDock*.

   The :ref:`OEPoseOptimizerOptions <OEDocking_OEPoseOptimizerOptions>` class defines the following public methods:
    * :oe:meth:`GetFlexRange<OEDocking::OEPoseOptimizerOptions::GetFlexRange>` and
      :oe:meth:`SetFlexRange<OEDocking::OEPoseOptimizerOptions::SetFlexRange>`
    * :oe:meth:`GetForceField<OEDocking::OEPoseOptimizerOptions::GetForceField>` and
      :oe:meth:`SetForceField<OEDocking::OEPoseOptimizerOptions::SetForceField>`
    * :oe:meth:`GetNonBondCutoff<OEDocking::OEPoseOptimizerOptions::GetNonBondCutoff>` and
      :oe:meth:`SetNonBondCutoff<OEDocking::OEPoseOptimizerOptions::SetNonBondCutoff>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPoseOptimizerOptions()
            OEPoseOptimizerOptions(const OEPoseOptimizerOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEPoseOptimizerOptions() -> OEPoseOptimizerOptions
            OEPoseOptimizerOptions(arg2: OEPoseOptimizerOptions) -> OEPoseOptimizerOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPoseOptimizerOptions &operator=(const OEPoseOptimizerOptions &)

      Assignment operator.

   .. oe:method:: GetFlexRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetFlexRange() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlexRange() -> float

      See :oe:meth:`SetFlexRange<OEDocking::OEPoseOptimizerOptions::SetFlexRange>` method.

   .. oe:method:: GetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFF::OEComplexFF* GetForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEComplexFF

      See :oe:meth:`SetForceField<OEDocking::OEPoseOptimizerOptions::SetForceField>` method.

   .. oe:method:: GetNonBondCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetNonBondCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetNonBondCutoff() -> float

      See :oe:meth:`SetNonBondCutoff<OEDocking::OEPoseOptimizerOptions::SetNonBondCutoff>` method.

   .. oe:method:: SetFlexRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFlexRange(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetFlexRange(value: float) -> bool

      Sets the **distance from ligand** defining residues that should be considered flexible during
      pose optimization. Default: 2.0

   .. oe:method:: SetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceField(const unsigned)
            bool SetForceField(const std::string&)
            bool SetForceField(const OEFF::OEComplexFF&)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: int) -> bool
            SetForceField(value: str) -> bool
            SetForceField(value: oeistream) -> bool
            SetForceField(value: OEComplexFF) -> bool

      Sets the **force field** for pose optimization.

   .. oe:method:: SetNonBondCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNonBondCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetNonBondCutoff(value: float) -> bool

      Sets the **non-bonded interactions cutoff** during pose optimization. 
      Default: 40.0



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEPosit, Posit

.. _OEDocking_OEPosit:

.. oe:class:: OEPosit

   .. oe:api::

      class OEPosit

   :ref:`OEPosit <OEDocking_OEPosit>` is used to pose predict multiconformer
   molecules in an active site.

   The :ref:`OEPosit <OEDocking_OEPosit>` class defines the following public methods:
    * :oe:meth:`AddReceptor<OEDocking::OEPosit::AddReceptor>`
    * :oe:meth:`ClearReceptors<OEDocking::OEPosit::ClearReceptors>`
    * :oe:meth:`Dock<OEDocking::OEPosit::Dock>`
    * :oe:meth:`GetHighScoresAreBetter<OEDocking::OEPosit::GetHighScoresAreBetter>`
    * :oe:meth:`GetName<OEDocking::OEPosit::GetName>`
    * :oe:meth:`GetInvalidScore<OEDocking::OEPosit::GetInvalidScore>`
    * :oe:meth:`MethodChoice<OEDocking::OEPosit::MethodChoice>`
    * :oe:meth:`RankDesignUnits<OEDocking::OEPosit::RankDesignUnits>`
    * :oe:meth:`ScoreLigand<OEDocking::OEPosit::ScoreLigand>`

  Deprecated methods of the class:
    * :oe:meth:`DockMultiConformerMolecule<OEDocking::OEPosit::DockMultiConformerMolecule>`
    * :oe:meth:`Initialize<OEDocking::OEPosit::Initialize>`
    * :oe:meth:`RankReceptors<OEDocking::OEPosit::RankReceptors>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPosit( const OEPositOptions& options = OEPositOptions() )
            OEPosit(const OEPosit &)

      .. oe:language:: python

         .. oe:api:: python

            OEPosit(options: OEPositOptions = OEPositOptions()) -> OEPosit
            OEPosit(arg2: OEPosit) -> OEPosit

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPosit &operator=(const OEPosit &)

.. _OEDocking_OEPosit_AddReceptor:

      Assignment operator.

   .. oe:method:: AddReceptor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddReceptor(const OEBio::OEDesignUnit&)
            bool AddReceptor(const OEChem::OEMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            AddReceptor(du: OEDesignUnit) -> bool
            AddReceptor(receptor: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Adds a receptor to the list of receptors to pose against. The function returns ``true`` if receptor is 
      addded successful. The first overload expects a design unit that contains a receptor. The second overload 
      works on a variation of molecule that contains receptor data.

    .. note::

      Since **OEPosit** can generate pose using any of the methods described in :oe:constns:`OEDocking::OEPositMethod`,
      constraints present in the receptor may or may not play any role for the specific pose generation. 
      Constraints only effect the generated pose when :oe:const:`OEDocking::OEPositMethod::FRED` or 
      :oe:const:`OEDocking::OEPositMethod::HYBRID` is the underlying method.

.. _OEDocking_OEPosit_ClearReceptors:

   .. oe:method:: ClearReceptors

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearReceptors()

      .. oe:language:: python

         .. oe:api:: python

            ClearReceptors() -> None

      Removes all existing receptors. Removing receptors will un-initialize an
      already initialized :ref:`OEPosit <OEDocking_OEPosit>` instance.

.. _OEDocking_OEPosit_Dock:

   .. oe:method:: Dock

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Dock(OESinglePoseResult& res,
                          const OEChem::OEMCMolBase& mol) const
            unsigned Dock(OEPositResults& res, const OEChem::OEMCMolBase& mol,
                          const unsigned numPoses = 1) const

      .. oe:language:: python

         .. oe:api:: python

            Dock(res: OESinglePoseResult, mol: OEMol) -> int
            Dock(res: OEPositResults, mol: OEMol, numPoses: int = 1) -> int

      Dock the input molecule ``mol``.  The second overload can return alternate docked poses,
      in addition to the top scoring pose, with ``numPoses`` being the maximum desired number of poses.

      The return value of this method describes the result of the docking,
      with a value from the :oe:constns:`OEDocking::OEDockingReturnCode` namespace.
      A result of :oe:const:`OEDocking::OEDockingReturnCode::Success` indicates
      docking was successful.

.. _OEDocking_OEPosit_GetHighScoresAreBetter:

   .. oe:method:: GetHighScoresAreBetter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetHighScoresAreBetter() const

      .. oe:language:: python

         .. oe:api:: python

            GetHighScoresAreBetter() -> bool

      This always returns ``true`` for ``OEPosit``.

.. _OEDocking_OEPosit_GetName:

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the name of the scoring function docked poses are scored with.

.. _OEDocking_OEPosit_GetInvalidScore:

   .. oe:method:: GetInvalidScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            float  GetInvalidScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetInvalidScore() -> float

      Returns the invalid score returned by OEPosit. These values are set up to
      sort invalid values in reverse order from the best reported values.

.. _OEDocking_OEPosit_IsInitialized:

   .. oe:method:: IsInitialized

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsInitialized() const

      .. oe:language:: python

         .. oe:api:: python

            IsInitialized() -> bool

      Returns true if this object has been successfully initialized
      and is ready to dock molecules.

.. _OEDocking_OEPosit_MethodChoice:

   .. oe:method:: MethodChoice

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned MethodChoice(const unsigned recIdx,
                                  const OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            MethodChoice(recIdx: int, mol: OEMol) -> int

      Returns the method that would be used for pose prediction for a given ligand against a given receptor.

.. _OEDocking_OEPosit_RankDesignUnits:

   .. oe:method:: RankDesignUnits

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBio::OEDesignUnit>* RankDesignUnits(const OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            RankDesignUnits(mol: OEMol) -> Iterable[OEDesignUnit]

      Rank the design units, from best to worst receptors, to pose against, for the specified ligand.

.. _OEDocking_OEPosit_DockMultiConformerMolecule:

   .. oe:method:: DockMultiConformerMolecule

      .. warning::

         |DEPRECATED-API|
         Please use :oe:meth:`OEPosit::Dock<OEDocking::OEPosit::Dock>` instead.

      Both overloads of this method dock *inputMol* into the receptor added by the
      :oe:meth:`OEDocking::OEPosit::Initialize` method.

      The return value of this method describes the result of the docking,
      with a value from the :oe:constns:`OEDocking::OEDockingReturnCode` namespace.
      A result of :oe:const:`OEDocking::OEDockingReturnCode::Success` indicates
      docking was successful.

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int DockMultiConformerMolecule(OEChem::OEMolBase& dockedMol,
                                                    const OEChem::OEMCMolBase& inputMol)

      .. oe:language:: python

         .. oe:api:: python

            DockMultiConformerMolecule(dockedMol: Union[OEGraphMol,OEMol,OEQMol],
                                       inputMol: OEMol) -> int

      This overload of
      :oe:meth:`OEDocking::OEPosit::DockMultiConformerMolecule` returns
      the top scoring pose.

         *dockedMol*
            Docked pose with the best pose prediction probability of *inputMol*.

         *inputMol*
            A multiconformer representation of a molecule to dock.

      The score of the docked pose can be obtained by calling the
      :oe:cls:`OEChem::OEMolBase::GetEnergy` method of *dockedMol*.

.. _OEDocking_OEPosit_Initialize:

   .. oe:method:: Initialize

      .. warning::

         |DEPRECATED-API|
         Please use :oe:meth:`OEPosit::AddReceptor<OEDocking::OEPosit::AddReceptor>` instead.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Initialize(const OEChem::OEMolBase& receptor)

      .. oe:language:: python

         .. oe:api:: python

            Initialize(receptor: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Initializes :ref:`OEPosit <OEDocking_OEPosit>` with receptor to pose ligand against. Calling
      initialize will remove any existing receptors in the current :ref:`OEPosit <OEDocking_OEPosit>`
      instance. Function returns ``true`` if setup was successful and ``false`` otherwise.

.. _OEDocking_OEPosit_RankReceptors:

   .. oe:method:: RankReceptors

      .. warning::

         |DEPRECATED-API|
         Please use :oe:meth:`OEPosit::RankDesignUnits<OEDocking::OEPosit::RankDesignUnits>` instead.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEMolBase>* RankReceptors(const OEChem::OEMCMolBase&) const

      .. oe:language:: python

         .. oe:api:: python

            RankReceptors(mol: OEMol) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

      Rank the receptors, from best to worst, to pose against, for the specified ligand.

.. _OEDocking_OEPosit_ScoreLigand:

   .. oe:method:: ScoreLigand

      .. warning::

         |DEPRECATED-API|
         This method is only compatible with 
         :oe:meth:`DockMultiConformerMolecule<OEDocking::OEPosit::DockMultiConformerMolecule>`, for
         obtaining a score (pose probability) after the pose has been generated.

         Method provides invalid score when called on poses generated using 
         :oe:meth:`Dock<OEDocking::OEPosit::Dock>`.  The scores (pose probability) from that calculation 
         are available in the resulting :ref:`OESinglePoseResult <OEDocking_OESinglePoseResult>`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            float ScoreLigand(const OEChem::OEMolBase& pose) const

      .. oe:language:: python

         .. oe:api:: python

            ScoreLigand(pose: Union[OEGraphMol,OEMol,OEQMol]) -> float

      Rescores a pose within the active site.

      If an error occurs this function will return the limiting large double in C++.


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEPositOptions, PositOptions

.. _OEDocking_OEPositOptions:

.. oe:class:: OEPositOptions

   .. oe:api::

      class OEPositOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for performing
   pose prediction using POSIT.

   The :ref:`OEPositOptions <OEDocking_OEPositOptions>` class defines the following public methods:
    * :oe:meth:`GetAllowedClashType<OEDocking::OEPositOptions::GetAllowedClashType>` and
      :oe:meth:`SetAllowedClashType<OEDocking::OEPositOptions::SetAllowedClashType>`
    * :oe:meth:`GetBestReceptorPoseOnly<OEDocking::OEPositOptions::GetBestReceptorPoseOnly>` and
      :oe:meth:`SetBestReceptorPoseOnly<OEDocking::OEPositOptions::SetBestReceptorPoseOnly>`
    * :oe:meth:`GetExcludeSelf<OEDocking::OEPositOptions::GetExcludeSelf>` and
      :oe:meth:`SetExcludeSelf<OEDocking::OEPositOptions::SetExcludeSelf>`
    * :oe:meth:`GetFlexiOverlayOptions<OEDocking::OEPositOptions::GetFlexiOverlayOptions>` and
      :oe:meth:`SetFlexiOverlayOptions<OEDocking::OEPositOptions::SetFlexiOverlayOptions>`
    * :oe:meth:`GetFullConformationSearch<OEDocking::OEPositOptions::GetFullConformationSearch>` and
      :oe:meth:`SetFullConformationSearch<OEDocking::OEPositOptions::SetFullConformationSearch>`
    * :oe:meth:`GetIgnoreNitrogenStereo<OEDocking::OEPositOptions::GetIgnoreNitrogenStereo>` and
      :oe:meth:`SetIgnoreNitrogenStereo<OEDocking::OEPositOptions::SetIgnoreNitrogenStereo>`
    * :oe:meth:`GetMinProbability<OEDocking::OEPositOptions::GetMinProbability>` and
      :oe:meth:`SetMinProbability<OEDocking::OEPositOptions::SetMinProbability>`
    * :oe:meth:`GetPoserCacheCount<OEDocking::OEPositOptions::GetPoserCacheCount>` and
      :oe:meth:`SetPoserCacheCount<OEDocking::OEPositOptions::SetPoserCacheCount>`
    * :oe:meth:`GetPoseRelaxMode<OEDocking::OEPositOptions::GetPoseRelaxMode>` and
      :oe:meth:`SetPoseRelaxMode<OEDocking::OEPositOptions::SetPoseRelaxMode>`
    * :oe:meth:`GetPoseRelaxOptions<OEDocking::OEPositOptions::GetPoseRelaxOptions>` and
      :oe:meth:`SetPoseRelaxOptions<OEDocking::OEPositOptions::SetPoseRelaxOptions>`
    * :oe:meth:`GetPositMethods<OEDocking::OEPositOptions::GetPositMethods>` and
      :oe:meth:`SetPositMethods<OEDocking::OEPositOptions::SetPositMethods>`
    * :oe:meth:`GetTorLib<OEDocking::OEPositOptions::GetTorLib>` and
      :oe:meth:`SetTorLib<OEDocking::OEPositOptions::SetTorLib>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPositOptions(const bool fullConformationalSearch = true,
                           const unsigned ipositMethods = OEPositMethod::ALL)
            OEPositOptions(const OEPositOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEPositOptions(fullConformationalSearch: bool = True,
                           ipositMethods: int) -> OEPositOptions
            OEPositOptions(arg2: OEPositOptions) -> OEPositOptions

      Constructors.

      *fullConformationalSearch*
         If ``true``, a full flexible conformational search is performed
         during pose prediction. If ``false``, only a rigid overlay is used.
         Default: ``true``.

      *ipositMethods*
         Bit-mask of POSIT pose-prediction methods to enable.
         See :oe:constns:`OEDocking::OEPositMethod` for valid values.
         Default: :oe:const:`OEDocking::OEPositMethod::ALL`.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPositOptions &operator=(const OEPositOptions &)

   .. _OEDocking_OEPositOptions_GetAllowedClashType:

      Assignment operator.

   .. oe:method:: GetAllowedClashType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAllowedClashType() const

      .. oe:language:: python

         .. oe:api:: python

            GetAllowedClashType() -> int

      See :oe:meth:`SetAllowedClashType<OEDocking::OEPositOptions::SetAllowedClashType>` method.

   .. _OEDocking_OEPositOptions_GetBestReceptorPoseOnly:

   .. oe:method:: GetBestReceptorPoseOnly

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetBestReceptorPoseOnly() const

      .. oe:language:: python

         .. oe:api:: python

            GetBestReceptorPoseOnly() -> bool

      See :oe:meth:`SetBestReceptorPoseOnly<OEDocking::OEPositOptions::SetBestReceptorPoseOnly>` method.  

   .. _OEDocking_OEPositOptions_GetExcludeSelf:

   .. oe:method:: GetExcludeSelf

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetExcludeSelf() const

      .. oe:language:: python

         .. oe:api:: python

            GetExcludeSelf() -> bool

      See :oe:meth:`SetExcludeSelf<OEDocking::OEPositOptions::SetExcludeSelf>` method.

   .. _OEDocking_OEPositOptions_GetFlexiOverlayOptions:

   .. oe:method:: GetFlexiOverlayOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeFitOptions& GetFlexiOverlayOptions()
            const OEShapeFitOptions& GetFlexiOverlayOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlexiOverlayOptions() -> OEShapeFitOptions

      See :oe:meth:`SetFlexiOverlayOptions<OEDocking::OEPositOptions::SetFlexiOverlayOptions>` method.

   .. _OEDocking_OEPositOptions_GetFullConformationSearch:

   .. oe:method:: GetFullConformationSearch

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFullConformationSearch() const

      .. oe:language:: python

         .. oe:api:: python

            GetFullConformationSearch() -> bool

      See :oe:meth:`SetFullConformationSearch<OEDocking::OEPositOptions::SetFullConformationSearch>` method.

   .. _OEDocking_OEPositOptions_GetIgnoreNitrogenStereo:

   .. oe:method:: GetIgnoreNitrogenStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetIgnoreNitrogenStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetIgnoreNitrogenStereo() -> bool

      See :oe:meth:`SetIgnoreNitrogenStereo<OEDocking::OEPositOptions::SetIgnoreNitrogenStereo>` method.

   .. _OEDocking_OEPositOptions_GetMinProbability:

   .. oe:method:: GetMinProbability

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMinProbability() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinProbability() -> float

      See :oe:meth:`SetMinProbability<OEDocking::OEPositOptions::SetMinProbability>` method.

   .. _OEDocking_OEPositOptions_GetPoserCacheCount:

   .. oe:method:: GetPoserCacheCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetPoserCacheCount()const

      .. oe:language:: python

         .. oe:api:: python

            GetPoserCacheCount() -> int

      See :oe:meth:`SetPoserCacheCount<OEDocking::OEPositOptions::SetPoserCacheCount>` method.

   .. _OEDocking_OEPositOptions_GetPoseRelaxMode:

   .. oe:method:: GetPoseRelaxMode

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetPoseRelaxMode() const

      .. oe:language:: python

         .. oe:api:: python

            GetPoseRelaxMode() -> int

      See :oe:meth:`SetPoseRelaxMode<OEDocking::OEPositOptions::SetPoseRelaxMode>` method.

   .. _OEDocking_OEPositOptions_GetPoseRelaxOptions:

   .. oe:method:: GetPoseRelaxOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPoseOptimizerOptions& GetPoseRelaxOptions()
            const OEPoseOptimizerOptions& GetPoseRelaxOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetPoseRelaxOptions() -> OEPoseOptimizerOptions

      See :oe:meth:`SetPoseRelaxOptions<OEDocking::OEPositOptions::SetPoseRelaxOptions>` method.

   .. _OEDocking_OEPositOptions_GetPositMethods:

   .. oe:method:: GetPositMethods

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetPositMethods() const

      .. oe:language:: python

         .. oe:api:: python

            GetPositMethods() -> int

      See :oe:meth:`SetPositMethods<OEDocking::OEPositOptions::SetPositMethods>` method. 

   .. _OEDocking_OEPositOptions_GetTorLib:

   .. oe:method:: GetTorLib

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OETorLib* GetTorLib() const

      .. oe:language:: python

         .. oe:api:: python

            GetTorLib() -> OETorLib

      See :oe:meth:`SetTorLib<OEDocking::OEPositOptions::SetTorLib>` method.

   .. _OEDocking_OEPositOptions_SetAllowedClashType:

   .. oe:method:: SetAllowedClashType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAllowedClashType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetAllowedClashType(value: int) -> bool

      Sets the **allowed clash type** between the ligand pose and the protein,
      for pose generation. Allowed clash types are defined in the
      :oe:constns:`OEDocking::OEAllowedClashType` namespace.

      The allowed clash type defines if a generated pose contains a clash or not, as
      reported in a pose calculation result. The allowed clash type also determines if
      a relaxation of the pose would be carried out when
      :oe:meth:`SetPoseRelaxMode<OEDocking::OEPositOptions::SetPoseRelaxMode>` is set
      to :oe:const:`OEDocking::OEPoseRelaxMode::CLASHED`.
      Default is :oe:const:`OEDocking::OEAllowedClashType::HYDROGEN`.

   .. _OEDocking_OEPositOptions_SetBestReceptorPoseOnly:

   .. oe:method:: SetBestReceptorPoseOnly

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBestReceptorPoseOnly(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetBestReceptorPoseOnly(value: bool) -> bool

      Sets flag if **only the best receptor** should be considered for pose prediction.
      If this flag set to ``false`` the pose prediction is performed using all of the
      receptors and the best set of poses from all of the receptors combined is provided
      as the results. With the default setting of ``true`` pose prediction is only performed
      on the ``best receptor`` for any given ligand. Note that, setting the flag to ``false``
      could increase the runtime significantly depending on the number of receptors used
      for the calculation.

   .. _OEDocking_OEPositOptions_SetExcludeSelf:

   .. oe:method:: SetExcludeSelf

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetExcludeSelf(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetExcludeSelf(value: bool) -> bool

      Sets flag **to exclude receptor that contains a given ligand as its bound ligand**, when 
      choosing the best receptor for a ligand during pose prediction. This option is meant to 
      be used when running cross docking validation experiments, and allows the user to prevent 
      docking a ligand to a receptor containing itself, without having to generate a number of 
      leave one out receptor datasets.
      Default: **False.**

   .. _OEDocking_OEPositOptions_SetFlexiOverlayOptions:

   .. oe:method:: SetFlexiOverlayOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFlexiOverlayOptions(const OEShapeFitOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetFlexiOverlayOptions(opts: OEShapeFitOptions) -> None

      Sets :oe:cls:`options<OEDocking::OEShapeFitOptions>` related to flexible optimization 
      with shape, color, and forcefield, relevant for pose generation with 
      :oe:const:`OEDocking::OEPositMethod::SHAPEFIT`.

   .. _OEDocking_OEPositOptions_SetFullConformationSearch:

   .. oe:method:: SetFullConformationSearch

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFullConformationSearch(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetFullConformationSearch(value: bool) -> bool

      Sets flag **to perform full conformation search**.
      Setting this option to ``false`` disables internal rotamer conformer searching during 
      the flexible searching algorithm. If this option is set to ``false`` and a 3D input is 
      not given, this setting is ignored and a full conformation search is automatically performed. 
      Default: ``true``.

   .. _OEDocking_OEPositOptions_SetIgnoreNitrogenStereo:

   .. oe:method:: SetIgnoreNitrogenStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIgnoreNitrogenStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetIgnoreNitrogenStereo(value: bool) -> bool

      Sets flag **to ignore Nitrogen stereo specifications** in input molecule. 
      Setting this option to ``false`` ignores Nitrogen stereo specifications in the input molecule,
      and a value to ``true`` ensures that any specified Nitrogen stereo information is restored.
      A molecule would always be processed, irrespective of this setting. When Nitrogen stereo is 
      specified in the incoming molecule, setting flag is set to ``true`` would respect those
      stereo specifications. Default: ``false``.

   .. _OEDocking_OEPositOptions_SetMinProbability:

   .. oe:method:: SetMinProbability

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMinProbability(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMinProbability(value: float) -> bool

      Sets the minimum pose probability, for poses to be of interest.  Poses
      that has a probability below the minimum value are not relaxed even when
      the :oe:meth:`SetPoseRelaxMode<OEDocking::OEPositOptions::SetPoseRelaxMode>`
      is set to ``CLASHED`` or `ALL``. Default is ``0.33``.

   .. _OEDocking_OEPositOptions_SetPoserCacheCount:

   .. oe:method:: SetPoserCacheCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPoserCacheCount(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetPoserCacheCount(value: int) -> bool

      Sets the maximum number of posers to be kept in memory cache during **POSIT** calculation.
      Each poser takes ~0.75GB of memory.  Ability to keep more poser in the cache speeds
      up the calculation when working with multiple receptors. Default is ``10``.

   .. _OEDocking_OEPositOptions_SetPoseRelaxMode:

   .. oe:method:: SetPoseRelaxMode

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPoseRelaxMode(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetPoseRelaxMode(value: int) -> bool

      Sets the **trigger to perform relaxation** of the generated pose.  The relaxation is
      performed by allowing flexibility to the ligand and parts of the receptor. Turning on
      relaxation can significantly slow down the calculations. Pose relaxation modes are
      defined in the :oe:constns:`OEDocking::OEPoseRelaxMode` namespace.
      Default is :oe:const:`OEDocking::OEPoseRelaxMode::NONE`.

   .. _OEDocking_OEPositOptions_SetPoseRelaxOptions:

   .. oe:method:: SetPoseRelaxOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPoseRelaxOptions(const OEPoseOptimizerOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetPoseRelaxOptions(opts: OEPoseOptimizerOptions) -> None

      Sets :oe:cls:`options<OEDocking::OEPoseOptimizerOptions>` related to post-optimization
      of the generated pose.

   .. _OEDocking_OEPositOptions_SetPositMethods:

   .. oe:method:: SetPositMethods

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPositMethods(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetPositMethods(value: int) -> bool

      Sets the **posing methods** to be used. Methods are set as bits in the supplied integer,
      see the :oe:constns:`OEDocking::OEPositMethod` namespace for more details.
      Default is :oe:const:`OEDocking::OEPositMethod::ALL`.

   .. _OEDocking_OEPositOptions_SetTorLib:

   .. oe:method:: SetTorLib

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTorLib(const unsigned)
            bool SetTorLib(const std::string&)
            bool SetTorLib(const OEConfGen::OETorLib&)

      .. oe:language:: python

         .. oe:api:: python

            SetTorLib(value: int) -> bool
            SetTorLib(value: str) -> bool
            SetTorLib(value: oeistream) -> bool
            SetTorLib(value: OETorLib) -> bool

      Sets the **torsion library** that is used for torsion driving during conformer generation.  
      The first overload takes an `unsigned` from the :ref:`OETorlibType <OEConfGen_OETorLibType>` namespace,
      and the second overload takes the corresponding string values.
      **Default:** :ref:`Original <OEConfGen_OETorLibType_Original>`


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEPositProbability, PositProbability

.. _OEDocking_OEPositProbability:

.. oe:class:: OEPositProbability

   .. oe:api::

      class OEPositProbability

   The :ref:`OEPositProbability <OEDocking_OEPositProbability>` can be used to estimate
   confidence, in terms of probability, that a ligand pose can be accurately predicted,
   with respect to the reference ligand or design unit receptor.

   This function is helpful in selecting a receptor or reference ligand to pose against 
   from a group of receptors.

   The :ref:`OEPositProbability <OEDocking_OEPositProbability>` class defines the following public methods:
    * :oe:meth:`Estimate<OEDocking::OEPositProbability::Estimate>`
    * :oe:meth:`PoseEstimate<OEDocking::OEPositProbability::PoseEstimate>`
    * :oe:meth:`SetupRef<OEDocking::OEPositProbability::SetupRef>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPositProbability()
            OEPositProbability(const OEPositProbability &)

      .. oe:language:: python

         .. oe:api:: python

            OEPositProbability() -> OEPositProbability
            OEPositProbability(arg2: OEPositProbability) -> OEPositProbability

   Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPositProbability &operator=(const OEPositProbability &)

      Assignment operator.

   .. oe:method:: Estimate
   
      .. oe:language:: c++ java csharp

         .. oe:api::

            double Estimate(const OEChem::OEMolBase& mol)
            double Estimate(const OEChem::OEMCMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Estimate(mol: Union[OEGraphMol,OEQMol]) -> float
            Estimate(mol: OEMol) -> float

      Provides the estimated probability.  With the :ref:`OEMolBase <OEChem_OEMolBase>`
      variation of the argument, multi-conformer molecule is generated with
      internal settings before producing an estimate.

   .. oe:method:: PoseEstimate
   
      .. oe:language:: c++ java csharp

         .. oe:api::

            double PoseEstimate(const OEChem::OEMolBase& mol,
                                const unsigned poseMethod = OEPositMethod::UNKNOWN)

      .. oe:language:: python

         .. oe:api:: python

            PoseEstimate(mol: Union[OEGraphMol,OEMol,OEQMol], poseMethod: int) -> float

      Provides estimated probability assuming that the specified ligand pose was
      generated with the reference used in :oe:meth:`SetupRef<OEDocking::OEPositProbability::SetupRef>`. 
      The second argument ``poseMethod`` refers to specific methods from
      :oe:constns:`OEDocking::OEPositMethod`.

   .. oe:method:: SetupRef
   
      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEChem::OEMolBase& ligand)
            bool SetupRef(const OEBio::OEDesignUnit& du)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(ligand: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            SetupRef(du: OEDesignUnit) -> bool

      Sets up the reference system against which the pose is to be generated.


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEPositResults, PositResults

.. _OEDocking_OEPositResults:

.. oe:class:: OEPositResults

   .. oe:api::

      class OEPositResults

   This class provides results of a collection of poses, obtained from :ref:`OEPosit <OEDocking_OEPosit>`
   calculation.

   The :ref:`OEPositResults <OEDocking_OEPositResults>` class defines the following public methods:
    * :oe:meth:`GetNumPoses<OEDocking::OEPositResults::GetNumPoses>`
    * :oe:meth:`GetReturnCode<OEDocking::OEPositResults::GetReturnCode>`
    * :oe:meth:`GetSinglePoseResults<OEDocking::OEPositResults::GetSinglePoseResults>`

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPositResults()
            OEPositResults(const OEPositResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEPositResults() -> OEPositResults
            OEPositResults(arg2: OEPositResults) -> OEPositResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPositResults &operator=(const OEPositResults &)

      Assignment operator.

   .. oe:method:: GetNumPoses

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetNumPoses() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumPoses() -> int

      Returns the number of poses in this collection.

   .. oe:method:: GetReturnCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetReturnCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetReturnCode() -> int

      Returns the calculation return code, defined in 
      :oe:constns:`OEDocking::OEDockingReturnCode` namespace.

   .. oe:method:: GetSinglePoseResults

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESinglePoseResult>* GetSinglePoseResults() const

      .. oe:language:: python

         .. oe:api:: python

            GetSinglePoseResults() -> Iterable[OESinglePoseResult]

      Returns an iterator over the :ref:`OESinglePoseResult <OEDocking_OESinglePoseResult>` in this collection.


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEProteinConstraint, ProteinConstraint

.. _OEDocking_OEProteinConstraint:

.. oe:class:: OEProteinConstraint

   .. oe:api::

      class OEProteinConstraint

   This class holds information about a single receptor protein constraint.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEProteinConstraint & operator=(const OEProteinConstraint &)

      Assignment operator.

   .. oe:method:: GetAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEChem::OEAtomBase* GetAtom() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtom() -> OEAtomBase

      Hold the protein atom of the receptor the constraint is associated with.

   .. oe:method:: GetType

      .. oe:api::

         unsigned int GetType() const

      Type for the constraint (see :oe:constns:`OEDocking::OEProteinConstraintType`).

   .. oe:method:: GetEnabled

      .. oe:api::

         bool GetEnabled() const

      Returns true if the constraint is enabled and false otherwise.

   .. oe:method:: GetName

      .. oe:api::

         std::string GetName() const

      Returns the name of the constraint.

   .. oe:method:: SetAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAtom(OEChem::OEAtomBase* atom)

      .. oe:language:: python

         .. oe:api:: python

            SetAtom(atom: OEAtomBase) -> None

      Sets the atom of the receptor the constraint will be associated with.

   .. oe:method:: SetType

      .. oe:api::

         void SetType(unsigned int type)

      Sets the constraint type (see :oe:constns:`OEDocking::OEProteinConstraintType`).

   .. oe:method:: SetName

      .. oe:api::

         void SetEnabled(bool enabled)

      Sets the name of the constraint.

   .. oe:method:: SetEnabled

      .. oe:api::

         void SetName(std::string name)

      Sets the enabled flag of the constraint.



.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEScore

.. _OEDocking_OEScore:

.. oe:class:: OEScore

   .. oe:api::

      class OEScore

   :ref:`OEScore <OEDocking_OEScore>` is a class for scoring and optimizing
   poses within the active site.  Use of this class is as follows:

   #. Initialize the active site by passing either a receptor (see 
      :ref:`chapter_receptor` chapter) or a protein and box to the 
      :oe:meth:`OEDocking::OEScore::Initialize` method.

   #. Score or optimize the molecules using:

      * :oe:meth:`OEDocking::OEScore::ScoreLigand`
      * :oe:meth:`OEDocking::OEScore::ScoreAtom`
      * :oe:meth:`OEDocking::OEScore::ScoreLigandComponent`
      * :oe:meth:`OEDocking::OEScore::ScoreAtomComponent`
      * :oe:meth:`OEDocking::OEScore::SystematicSolidBodyOptimize`
      * :oe:meth:`OEDocking::OEScore::AnnotatePose`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEScore(const unsigned int scoring = OEScoreType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEScore(scoring: int) -> OEScore
            OEScore(arg2: OEScore) -> OEScore

      Constructs :ref:`OEScore <OEDocking_OEScore>` to use the specified *scoring*
      function from the :oe:constns:`OEDocking::OEScoreType` namespace.

.. _OEDocking_OEScore_IsInitialized:

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEScore & operator=(const OEScore &)

      Assignment operator.

   .. oe:method:: IsInitialized

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsInitialized() const

      .. oe:language:: python

         .. oe:api:: python

            IsInitialized() -> bool

      Returns true if this object has been successfully initialized
      and is ready to score poses.

   .. _OEDocking_OEScore_Initialize:

   .. oe:method:: Initialize

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Initialize(const OEBio::OEDesignUnit& du)
            bool Initialize(const OEChem::OEMolBase& receptor)
            bool Initialize(const OEChem::OEMolBase& pro,
                            const OEMath::OEBox& box)

      .. oe:language:: python

         .. oe:api:: python

            Initialize(du: OEDesignUnit) -> bool
            Initialize(receptor: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            Initialize(pro: Union[OEGraphMol,OEMol,OEQMol], box: OEBox) -> bool

      Sets up this object to score poses within an active site.  This function returns true if 
      initialization was successful. This object does not depend upon receptor once this call is 
      completed (*i.e.* receptor can be destroyed after calling this method).  The first overload 
      expects a design unit that contains a receptor. The second overload works on a 
      variation of molecule that contains receptor data.  The last overload works with a protein 
      and box enclosing the active site. Method returns ``true`` if setup was successful.

   .. _OEDocking_OEScore_GetName:

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the name of the scoring function.

   .. _OEDocking_OEScore_GetComponentNames:

   .. oe:method:: GetComponentNames

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<const std::string>* GetComponentNames() const

      .. oe:language:: python

         .. oe:api:: python

            GetComponentNames() -> Iterable[str]

      Returns the name of the scoring function components.

   .. _OEDocking_OEScore_GetHighScoresAreBetter:

   .. oe:method:: GetHighScoresAreBetter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetHighScoresAreBetter() const

      .. oe:language:: python

         .. oe:api:: python

            GetHighScoresAreBetter() -> bool

      Returns true if higher scores indicate a better result.

      Returns false if lower scores indicate a better result.

   .. _OEDocking_OEScore_ScoreLigand:

   .. oe:method:: ScoreLigand

      .. oe:language:: c++ java csharp

         .. oe:api::

            float ScoreLigand(const OEChem::OEMolBase& pose)

      .. oe:language:: python

         .. oe:api:: python

            ScoreLigand(lig: Union[OEGraphMol,OEMol,OEQMol]) -> float

      Scores a pose within the active site.

         *pose*
            Structure of a pose within the active site

      If an error occurs this function will return FLT_MAX if
      :oe:meth:`OEDocking::OEScore::GetHighScoresAreBetter` returns false
      or -FLT_MAX otherwise.

   .. _OEDocking_OEScore_ScoreAtom:

   .. oe:method:: ScoreAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            float ScoreAtom(const OEChem::OEAtomBase* atom,
            const OEChem::OEMolBase& lig)

      .. oe:language:: python

         .. oe:api:: python

            ScoreAtom(atom: OEAtomBase, lig: Union[OEGraphMol,OEMol,OEQMol]) -> float

      Returns the score of an atom of a given pose within the active site.

         *atom*
            Atom of *pose* to score.

         *pose*
            Structure of a pose within the active site

      If an error occurs this function will return FLT_MAX if
      :oe:meth:`OEDocking::OEScore::GetHighScoresAreBetter` returns false
      or -FLT_MAX otherwise.

   .. _OEDocking_OEScore_ScoreLigandComponent:

   .. oe:method:: ScoreLigandComponent

      .. oe:language:: c++ java csharp

         .. oe:api::

            float ScoreLigandComponent(const OEChem::OEMolBase& pose,
                                       std::string compName)

      .. oe:language:: python

         .. oe:api:: python

            ScoreLigandComponent(lig: Union[OEGraphMol,OEMol,OEQMol],
                                 compName: str) -> float

      Returns the given component's contribution to the total score.

         *pose*
            Structure of a pose within the active site

         *compName*
            Name of the score component to report.  Name must be one
            returned by
            :oe:meth:`OEDocking::OEScore::GetComponentNames`.

      If an error occurs this function will return FLT_MAX if
      :oe:meth:`OEDocking::OEScore::GetHighScoresAreBetter` returns false
      or -FLT_MAX otherwise.

   .. _OEDocking_OEScore_ScoreAtomComponent:

   .. oe:method:: ScoreAtomComponent

      .. oe:language:: c++ java csharp

         .. oe:api::

            float ScoreAtomComponent(const OEChem::OEAtomBase* atom,
            const OEChem::OEMolBase& lig, std::string compName)

      .. oe:language:: python

         .. oe:api:: python

            ScoreAtomComponent(atom: OEAtomBase,
                               lig: Union[OEGraphMol,OEMol,OEQMol],
                               compName: str) -> float

      Returns the given components contribution to the score of a given atom score.

         *atom*
           Atom of *pose* to score.

         *pose*
           Structure of a pose within the active site

         *compName*
            Name of the score component to report.  Name must be one
            returned by
            :oe:meth:`OEDocking::OEScore::GetComponentNames`.

      If an error occurs this function will return FLT_MAX if
      :oe:meth:`OEDocking::OEScore::GetHighScoresAreBetter` returns false
      or -FLT_MAX otherwise.

   .. _OEDocking_OEScore_SystematicSolidBodyOptimize:

   .. oe:method:: SystematicSolidBodyOptimize

      Performs a solid body optimization on the *pose* or *poses* passed.  Three
      rotational and three translational degrees of freedom are explored, the
      pose (and protein) are held rigid.  A plus and minus rotational step is
      taken for each rotational and translational degree of freedom
      (for a total of 3^6 or 729 positions tested for each pose).

      Both overloads return true if no error occurred.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SystematicSolidBodyOptimize(OEChem::OEMCMolBase& poses,
                                             unsigned int searchResolution = OESearchResolution::Default)

      .. oe:language:: python

         .. oe:api:: python

            SystematicSolidBodyOptimize(mol: OEMol, searchRes: int) -> bool

      This overload of 
      :oe:meth:`OEDocking::OEScore::SystematicSolidBodyOptimize`
      optimizes all poses of an :ref:`OEMCMolBase <OEChem_OEMCMolBase>`.
         
         *poses*
            An :ref:`OEMCMolBase <OEChem_OEMCMolBase>` with conformers that are
            poses within the active site to be optimized.  

         *searchResolution*
            Search resolution of the optimization (see 
            :oe:constns:`OEDocking::OESearchResolution` constant namespace).

      The optimized poses are returned in *poses*.  This poses retain their
      original ordering and are not ordered by the new optimized score.  

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SystematicSolidBodyOptimize(OEChem::OEMolBase& pose,
                                             unsigned int searchResolution = OESearchResolution::Default)

      .. oe:language:: python

         .. oe:api:: python

            SystematicSolidBodyOptimize(mol: Union[OEGraphMol,OEQMol],
                                        searchRes: int) -> bool

      This overload of 
      :oe:meth:`OEDocking::OEScore::SystematicSolidBodyOptimize`
      optimizes a single pose.
         
         *pose*
            A pose within the active site to be optimized. 

         *searchResolution*
            Search resolution of the optimization (see 
            :oe:constns:`OEDocking::OESearchResolution` constant namespace).

   .. _OEDocking_OEScore_AnnotatePose:

   .. oe:method:: AnnotatePose

      Adds **VIDA** scoring annotation to the *pose* or *poses* passed.

      The annotated poses must be written out in either *oeb* or *oeb.gz* format
      and are only viewable in **VIDA**.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AnnotatePose(OEChem::OEMolBase& pose)

      .. oe:language:: python

         .. oe:api:: python

            AnnotatePose(lig: Union[OEGraphMol,OEQMol]) -> bool

      This overload of :oe:meth:`OEDocking::OEScore::AnnotatePose`
      annotates a single pose.

         *pose*
            Structure of a pose within the active site

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AnnotatePose(OEChem::OEMCMolBase& poses)

      .. oe:language:: python

         .. oe:api:: python

            AnnotatePose(lig: OEMol) -> bool

      This overload of :oe:meth:`OEDocking::OEScore::AnnotatePose`
      annotates all poses of a given ligand.

         *poses*
            An :ref:`OEMCMolBase <OEChem_OEMCMolBase>` the conformers of which are
            poses within the active site.

   .. _OEDocking_OEScore_CacheScoringSetup:

   .. oe:method:: CacheScoringSetup

      This function caches the current scoring setup of the :ref:`OEScore <OEDocking_OEScore>` object onto a
      receptor object.  When another :ref:`OEScore <OEDocking_OEScore>` object is initialized with this
      receptor the it will read in the cached score data rather than
      recalculating it from scratch, thus improving the startup time of the
      :ref:`OEScore <OEDocking_OEScore>` object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CacheScoringSetup(OEBio::OEDesignUnit& receptor,
                                   bool clearOldData = true)
            bool CacheScoringSetup(OEChem::OEMolBase& receptor,
                                   bool clearOldData = true)

      .. oe:language:: python

         .. oe:api:: python

            CacheScoringSetup(du: OEDesignUnit, clearOldData: bool = True) -> bool
            CacheScoringSetup(receptor: Union[OEGraphMol,OEMol,OEQMol],
                              clearOldData: bool = True) -> bool

      *receptor*
         A receptor object.  This must be the same receptor object the :ref:`OEScore <OEDocking_OEScore>`
         object was initialized with or an exact copy.

      *clearOldData*
         Flag to clear cached data from a prior call to CacheScoringSetup with
         this receptor.  The cached data can be quite sizable (hundreds of
         megabytes), so leaving this flag at the default value of true is
         recommended.

      .. note:: The cached score data on a receptor will be saved when the receptor is written to a file.



.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESinglePoseResult, SinglePoseResult

.. _OEDocking_OESinglePoseResult:

.. oe:class:: OESinglePoseResult

   .. oe:api::

      class OESinglePoseResult

   This class provides results of a single pose, obtained from the :ref:`OEPosit <OEDocking_OEPosit>`
   calculation.

   The :ref:`OESinglePoseResult <OEDocking_OESinglePoseResult>` class defines the following public methods:
    * :oe:meth:`GetDesignUnit<OEDocking::OESinglePoseResult::GetDesignUnit>`
    * :oe:meth:`GetTargetMask<OEDocking::OESinglePoseResult::GetTargetMask>`
    * :oe:meth:`GetTargetPred<OEDocking::OESinglePoseResult::GetTargetPred>`
    * :oe:meth:`GetHasClash<OEDocking::OESinglePoseResult::GetHasClash>`
    * :oe:meth:`GetNumClashes<OEDocking::OESinglePoseResult::GetNumClashes>`
    * :oe:meth:`GetNumContacts<OEDocking::OESinglePoseResult::GetNumContacts>`
    * :oe:meth:`GetPose<OEDocking::OESinglePoseResult::GetPose>`
    * :oe:meth:`GetPositMethod<OEDocking::OESinglePoseResult::GetPositMethod>`
    * :oe:meth:`GetProbability<OEDocking::OESinglePoseResult::GetProbability>`
    * :oe:meth:`GetReceptorIndex<OEDocking::OESinglePoseResult::GetReceptorIndex>`
    * :oe:meth:`GetRelaxAttempted<OEDocking::OESinglePoseResult::GetRelaxAttempted>`
    * :oe:meth:`GetRelaxed<OEDocking::OESinglePoseResult::GetRelaxed>`
    * :oe:meth:`GetRelaxStatus<OEDocking::OESinglePoseResult::GetRelaxStatus>`
    * :oe:meth:`GetRelaxStatusStr<OEDocking::OESinglePoseResult::GetRelaxStatusStr>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESinglePoseResult()
            OESinglePoseResult(const OESinglePoseResult&)

      .. oe:language:: python

         .. oe:api:: python

            OESinglePoseResult() -> OESinglePoseResult
            OESinglePoseResult(arg2: OESinglePoseResult) -> OESinglePoseResult

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESinglePoseResult &operator=(const OESinglePoseResult &)

      Assignment operator.

   .. oe:method:: GetDesignUnit

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEBio::OEDesignUnit& GetDesignUnit() const

      .. oe:language:: python

         .. oe:api:: python

            GetDesignUnit() -> OEDesignUnit

      Returns the resulting design unit consisting of the target and the ligand pose.

   .. _OEDocking_OESinglePoseResult_GetTargetMask:

   .. oe:method:: GetTargetMask

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetTargetMask() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetMask() -> int

      Returns the target mask used to generate the receptor. The mask and predicate can be used with the
      :oe:meth:`OEBio::OEDesignUnit::GetComponents` method to generate the molecule used in receptor generation. 

   .. _OEDocking_OESinglePoseResult_GetTargetPred:

   .. oe:method:: GetTargetPred

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBio::OEAtomMatchResidue GetTargetPred() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetPred() -> OEAtomMatchResidue

      Returns the residue based :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>` predicate used with the corresponding
      target mask to generate the receptor. The mask and predicate can be used with the
      :oe:meth:`OEBio::OEDesignUnit::GetComponents` method to generate the molecule used in receptor generation. 

      .. seealso::

         * :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>` class
         * :oe:meth:`OEBio::OEDesignUnit::GetComponents` method

   .. _OEDocking_OESinglePoseResult_GetHasClash:

   .. oe:method:: GetHasClash

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetHasClash() const

      .. oe:language:: python

         .. oe:api:: python

            GetHasClash() -> bool

      Returns ``true`` if the pose contains clash, ``false`` otherwise.  The *clash*
      is defined based on the option used in the :ref:`OEPosit <OEDocking_OEPosit>` calculation.

   .. _OEDocking_OESinglePoseResult_GetNumContacts:

   .. oe:method:: GetNumContacts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetNumContacts() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumContacts() -> int

      Returns the *number of contacts* in the pose, based on the *clash* type
      defined during the :ref:`OEPosit <OEDocking_OEPosit>` calculation.

   .. _OEDocking_OESinglePoseResult_GetNumClashes:

   .. oe:method:: GetNumClashes

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetNumClashes() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumClashes() -> int

      Returns the *number of clashes* in the pose, based on the *clash* type
      defined during the :ref:`OEPosit <OEDocking_OEPosit>` calculation.

   .. _OEDocking_OESinglePoseResult_GetPose:

   .. oe:method:: GetPose

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase& GetPose() const

      .. oe:language:: python

         .. oe:api:: python

            GetPose() -> OEGraphMol

      Returns the ligand pose conformer.

   .. _OEDocking_OESinglePoseResult_GetPositMethod:

   .. oe:method:: GetPositMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetPositMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetPositMethod() -> int

      Returns the method used to generate this pose. The returned values correspond
      to :oe:constns:`OEDocking::OEPositMethod`.

   .. _OEDocking_OESinglePoseResult_GetProbability:

   .. oe:method:: GetProbability

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetProbability() const

      .. oe:language:: python

         .. oe:api:: python

            GetProbability() -> float

      Returns the **POSIT** probability corresponding to this pose.

   .. _OEDocking_OESinglePoseResult_GetReceptorIndex:

   .. oe:method:: GetReceptorIndex

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetReceptorIndex() const

      .. oe:language:: python

         .. oe:api:: python

            GetReceptorIndex() -> int

      Returns the receptor index corresponding to the order they were added to the
      :ref:`OEPosit <OEDocking_OEPosit>` instance.

   .. _OEDocking_OESinglePoseResult_GetRelaxAttempted:

   .. oe:method:: GetRelaxAttempted

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRelaxAttempted() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelaxAttempted() -> bool

      Returns ``true`` if relaxation was attempted.

   .. _OEDocking_OESinglePoseResult_GetRelaxed:

   .. oe:method:: GetRelaxed

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRelaxed() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelaxed() -> bool

      Returns ``true`` if the pose is relaxed.

   .. _OEDocking_OESinglePoseResult_GetRelaxStatus:

   .. oe:method:: GetRelaxStatus

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetRelaxStatus() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelaxStatus() -> int

      Returns ``status code`` corresponding to the attempted relaxation,
      with a value from the :oe:constns:`OEDocking::OEDockingReturnCode` namespace.

   .. _OEDocking_OESinglePoseResult_GetRelaxStatusStr:

   .. oe:method:: GetRelaxStatusStr

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetRelaxStatusStr() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelaxStatusStr() -> str

      Returns ``status`` corresponding to the attempted relaxation.


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESphereBase, SphereBase

.. _OEDocking_OESphereBase:

.. oe:class:: OESphereBase

   .. oe:api::OESphereBase

      class OESphere

   :ref:`OESphereBase <OEDocking_OESphereBase>` class represents a sphere.

   The following free functions take :ref:`OESphereBase <OEDocking_OESphereBase>`.

   ==================================== ==================================
   :oe:func:`OEDocking::OESphereVolume` :oe:func:`OEDocking::OESphereArea`
   :oe:func:`OEDocking::OEInSphere`                                       
   ==================================== ==================================

   .. oe:method:: Destructor
      
      .. oe:api::

         virtual ~OESphereBase() {}

   Destructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESphereBase& operator=(const OESphereBase& rhs)

   Assignment operator.

   .. oe:method:: GetX

   .. oe:api:: 

        virtual float GetX() const  = 0

   Returns the X coordinate of the center of the sphere

.. oe:method:: GetY

   .. oe:api::

        virtual float GetY() const  = 0

   Returns the Y coordinate of the center of the sphere

.. oe:method:: GetZ

   .. oe:api::

        virtual float GetZ() const  = 0

   Return the Z coordinate of the center of the sphere

.. oe:method:: GetRad

   .. oe:api::

        virtual float GetRad() const  = 0

   Returns the radius of the sphere

.. oe:method:: SetRad

   .. oe:api::

        virtual bool SetRad(float rad)  = 0

   Sets the radius of the sphere to *rad*.  Will
   fail and return false if *rad* < 0.

.. oe:method:: SetCenter

   .. oe:api::

        virtual bool SetCenter(float x,
                               float y,
                               float z)  = 0

   Sets the center of the sphere.



.. oe:namespace:: OEDocking

.. oe:constnamespace:: OEAllowedClashType

   Constants in this namespace are used to define clash types allowed
   in a :ref:`OEPosit <OEDocking_OEPosit>` calculation.

   .. oe:constant:: NONE

      *No clash is allowed*

   .. oe:constant:: HYDROGEN

      *Clash involving hydrogen is allowed, but not between heavy atoms*

   .. oe:constant:: ANY

      *Any clash is allowed*


.. oe:namespace:: OEDocking

.. oe:constnamespace:: OEDockMethod

   Constants in this namespace are used by the constructor of
   :ref:`OEDock <OEDocking_OEDock>` and :ref:`OEHybrid <OEDocking_OEHybrid>` (see
   :oe:meth:`OEDocking::OEDock::Constructor` and 
   :oe:meth:`OEDocking::OEHybrid::Constructor` respectively) to specify the
   scoring function used during the exhaustive search and 
   optimization and final scoring.

   .. oe:constant:: Shapegauss

      *Exhaustive Search*
         :ref:`section_scoring_shapegauss`

      *Optimization and Scoring*
         :ref:`section_scoring_shapegauss`

   .. oe:constant:: PLP

      *Exhaustive Search*
         :ref:`section_scoring_plp`

      *Optimization and Scoring*
         :ref:`section_scoring_plp`

   .. oe:constant:: Chemgauss3

      *Exhaustive Search*
         :ref:`section_scoring_chemgauss3`

      *Optimization and Scoring*
         :ref:`section_scoring_chemgauss3`

   .. oe:constant:: Chemgauss4

      *Exhaustive Search*
         :ref:`section_scoring_chemgauss3`

      *Optimization and Scoring*
         :ref:`section_scoring_chemgauss4`

   .. oe:constant:: Chemgauss

      Same as :oe:const:`OEDocking::OEDockMethod::Chemgauss4`

   .. oe:constant:: Chemscore

      *Exhaustive Search*
         :ref:`section_scoring_chemgauss3`

      *Optimization and Scoring*
         :ref:`section_scoring_chemscore`

   .. oe:constant:: Hybrid1

      *Exhaustive Search*
         :ref:`section_scoring_cgo`

      *Optimization and Scoring*
         :ref:`section_scoring_chemgauss3`

   .. oe:constant:: Hybrid2

      *Exhaustive Search*
         :ref:`section_scoring_cgo`

      *Optimization and Scoring*
         :ref:`section_scoring_chemgauss4`

   .. oe:constant:: Hybrid

      Same as :oe:const:`OEDocking::OEDockMethod::Hybrid2`

   .. oe:constant:: Default

      Same as :oe:const:`OEDocking::OEDockMethod::Chemgauss4`

   .. oe:constant:: INVALID

      Return value used to indicate an error



.. _OEDockingConstants:

******************************
OEDocking Constants
******************************

.. oe:namespace:: OEDocking

.. toctree::

   OEAllowedClashType
   OEDockingReturnCode
   OEDockMethod
   OENegativeImageType
   OEPoseRelaxMode
   OEPositMethod
   OEProteinConstraintType
   OEScoreType
   OESearchResolution


.. oe:namespace:: OEDocking

.. _OEDocking_OEDockingReturnCode:

.. oe:constnamespace:: OEDockingReturnCode

   A constant from this namespace is returned by
   :oe:meth:`OEDocking::OEDock::DockMultiConformerMolecule` and :oe:meth:`OEDocking::OEPosit::Dock`
   to indicate the outcome of the docking or posing.

   .. _OEDocking_OEDockingReturnCode_Aborted:

   .. oe:constant:: Aborted

      Docking was aborted by the user (via the
      :oe:meth:`OESystem::OETracerBase::Aborted` method)

   .. _OEDocking_OEDockingReturnCode_ConformerGenError:

   .. oe:constant:: ConformerGenError

      Typically indicates the failure of :oe:meth:`OEDocking::OEPosit::Dock` to generate
      any internal conformations.

   .. _OEDocking_OEDockingReturnCode_CoordError:

   .. oe:constant:: CoordError

      The geometry of the chemical interactions on the ligand could not be
      determined.  This generally indicates that the ligand is broken
      in some way (e.g. valence errors).

   .. _OEDocking_OEDockingReturnCode_EmptyLigand:

   .. oe:constant:: EmptyLigand

      Docking failed because the ligand contained no atoms.

   .. _OEDocking_OEDockingReturnCode_EmptyProtein:

   .. oe:constant:: EmptyProtein

      The protein passed to the :oe:meth:`OEDocking::OEDock::Initialize` or :oe:meth:`OEDocking::OEPosit::Initialize`
      methods contained no atoms.

   .. _OEDocking_OEDockingReturnCode_Failure:

   .. oe:constant:: Failure

      All other docking failures.

   .. _OEDocking_OEDockingReturnCode_GridSetupError:

   .. oe:constant:: GridSetupError

      One of the scoring grids could not be setup.  This generally indicates
      that the protein structure is broken.

   .. _OEDocking_OEDockingReturnCode_InvalidScore:

   .. oe:constant:: InvalidScore

      Calculated score is near numeric limits and not valid.

   .. _OEDocking_OEDockingReturnCode_NoConstraintMatch:

   .. oe:constant:: NoConstraintMatch

      The supplied ligand cannot match the docking constraints.

   .. _OEDocking_OEDockingReturnCode_NotInitialized:

   .. oe:constant:: NotInitialized

      Docking failed because the
      :ref:`OEDock <OEDocking_OEDock>` or :ref:`OEPosit <OEDocking_OEPosit>` object has not been
      initialized (see :oe:meth:`OEDocking::OEDock::Initialize` or
      :oe:meth:`OEDocking::OEPosit::Initialize`)

   .. _OEDocking_OEDockingReturnCode_NoValidNonClashPoses:

   .. oe:constant:: NoValidNonClashPoses

      For :ref:`OEPosit <OEDocking_OEPosit>`, no poses remaining after clash removal.

   .. _OEDocking_OEDockingReturnCode_NoValidPoses:

   .. oe:constant:: NoValidPoses

      No ligand poses could fit within the active site.  Increasing the
      size of the receptor's outer contour volume
      (see :ref:`section_receptor_negative_image` section) and re-initializing the
      :ref:`OEDock <OEDocking_OEDock>` object with the new receptor may allow
      the ligand to dock.

   .. _OEDocking_OEDockingReturnCode_OptimizationError:

   .. oe:constant:: OptimizationError

      Optimization of the ligand failed.

   .. oe:constant:: OutsideGrid

      This error code is not currently used.

   .. _OEDocking_OEDockingReturnCode_ScoreError:

   .. oe:constant:: ScoreError

      Problem assigning scores with
      :oe:meth:`OEChem::OEMolBase::SetEnergy` method.

   .. _OEDocking_OEDockingReturnCode_Success:

   .. oe:constant:: Success

      Docking was successful.

   .. _OEDocking_OEDockingReturnCode_TypingError:

   .. oe:constant:: TypingError

      One or more of the atoms on the ligand could not be typed.



.. oe:namespace:: OEDocking

.. oe:constnamespace:: OENegativeImageType

   These constants are used by the 
   :oe:func:`OEDocking::OEMakeReceptor` function to specify
   the type of negative image it should make.

   .. oe:constant:: LargeShape

      Create a negative image designed for larger sites.
      This type of negative image tends to prefer solvent
      exposed areas over tight cavities.

   .. oe:constant:: StandardShape

      Standard negative image appropriate for most sites

   .. oe:constant:: SmallShape

      Create a negative image designed for smaller sites.
      This type of negative image tends to prefer tight
      cavities over more solvent exposed areas.

   .. oe:constant:: Default

      Same as :oe:const:`OEDocking::OENegativeImageType::StandardShape`

   .. oe:constant:: INVALID

      Return value used to indicate an error



.. oe:namespace:: OEDocking

.. _OEDocking_OEPoseRelaxMode:

.. oe:constnamespace:: OEPoseRelaxMode

   Constants in this namespace are used to define pose relaxation modes
   (i.e., when to perform a pose relaxation) in a :ref:`OEPosit <OEDocking_OEPosit>` calculation.

   .. _OEDocking_OEPoseRelaxMode_NONE:

   .. oe:constant:: NONE

      *Do not perform relaxation on any generated pose*.

   .. _OEDocking_OEPoseRelaxMode_CLASHED:

   .. oe:constant:: CLASHED

      *To perform relaxation only on those poses that contain a clash*.

   .. _OEDocking_OEPoseRelaxMode_ALL:

   .. oe:constant:: ALL

      *To perform relaxation on all generated poses*.


.. oe:namespace:: OEDocking

..  _OEDocking_OEPositMethod:

.. oe:constnamespace:: OEPositMethod

   Constants in this namespace are used to indicate the
   available posing methods used by :oe:meth:`SetPositMethods<OEDocking::OEPositOptions::SetPositMethods>` and :oe:meth:`GetPositMethods<OEDocking::OEPositOptions::GetPositMethods>`.

..  _OEDocking_OEPositMethod_All:

   .. oe:constant:: ALL

      This is equivalent to "SHAPEFIT | HYBRID | FRED | MCS".  This is the default.

..  _OEDocking_OEPositMethod_FRED:

   .. oe:constant:: FRED

      The molecule was posed using the default method.
      See :oe:const:`OEDocking::OEDockMethod::Chemgauss4`.

..  _OEDocking_OEPositMethod_HYBRID:

   .. oe:constant:: HYBRID

      The molecule was posed using the HYBRID method. See :oe:const:`OEDocking::OEDockMethod::Hybrid2`.

..  _OEDocking_OEPositMethod_SHAPEFIT:

   .. oe:constant:: SHAPEFIT

      The molecule was posed using the shapefit method.  See :ref:`section_scoring_plp`.

..  _OEDocking_OEPositMethod_UNKNOWN:

   .. oe:constant:: UNKNOWN

      The ligand was not posed.



.. oe:namespace:: OEDocking

.. oe:constnamespace:: OEProteinConstraintType

   Constants in this namespace are used by the
   :ref:`OEProteinConstraint <OEDocking_OEProteinConstraint>` class
   to specify the type
   of ligand atom that is allowed to satisfy a protein docking
   constraint.

   .. oe:constant:: Chelator

      A chelating heavy atom on the ligand must interact
      with the protein metal constraint atom to satisfy
      the constraint.

   .. oe:constant:: Acceptor

      A hydrogen bond acceptor on the ligand must interact with
      the protein donor to satisfy the constraint.

   .. oe:constant:: Donor

      A hydrogen bond donor on the ligand must interact with
      the protein acceptor to satisfy the constraint.

   .. oe:constant:: Contact

      A heavy atom on the ligand must contact the protein
      constraint atom to satisfy the constraint.

   .. oe:constant:: Lipophilic

      A non-polar heavy atom on the ligand must contact the protein

   .. oe:constant:: Unknown

      Unknown constraint type.  Most likely this receptor
      was written by a future version of this toolkit or FRED.



.. oe:namespace:: OEDocking

.. oe:constnamespace:: OEScoreType

   Constants in this namespace are used by the constructor of
   :ref:`OEScore <OEDocking_OEScore>` (see
   :oe:meth:`OEDocking::OEScore::Constructor`) to specify the
   scoring function :ref:`OEScore <OEDocking_OEScore>` will use.

   .. oe:constant:: Shapegauss

      :ref:`section_scoring_shapegauss`.

   .. oe:constant:: PLP

      :ref:`section_scoring_plp`.

   .. oe:constant:: Chemgauss3

      :ref:`section_scoring_chemgauss3`.

   .. oe:constant:: Chemgauss4

      :ref:`section_scoring_chemgauss4`.

   .. oe:constant:: Chemgauss
    
      Same as :oe:const:`OEDocking::OEScoreType::Chemgauss4`.

   .. oe:constant:: Chemscore 

      :ref:`section_scoring_chemscore`.

   .. oe:constant:: Default

      Same as :oe:const:`OEDocking::OEScoreType::Chemgauss4`.

   .. oe:constant:: INVALID

      Used as a return type to indicate an error.



.. oe:namespace:: OEDocking

.. oe:constnamespace:: OESearchResolution

   Constants in this namespace are used by the constructor of
   :ref:`OEDock <OEDocking_OEDock>` (see
   :oe:meth:`OEDocking::OEDock::Constructor`) to specify the
   search resolution used during the exhaustive search and
   optimization as well as the number of poses passed from the
   exhaustive search to the optimization step.  It is also
   used by the 
   :oe:meth:`OEDocking::OEScore::SystematicSolidBodyOptimize`
   method to specify the resolution of the optimization (the
   exhaustive search values are ignored in this case).

 
   Rotational stepsize is the furthest distance any atom will
   move in a single rotational step.  

   All distances are measured in angstroms.

   .. oe:constant:: High

      *Exhaustive Search Resolution*

         Translational 1.0

         Rotational 1.0

      *Optimization Resolution*

         Translational 0.5

         Rotational 0.5

      *Number exhaustive search poses optimized during docking*

         1000

   .. oe:constant:: Standard

      *Exhaustive Search Resolution*

         Translational 1.0

         Rotational 1.5

      *Optimization Resolution*

         Translational 0.5

         Rotational 0.75

      *Number exhaustive search poses optimized during docking*

         100

   .. oe:constant:: Low

      *Exhaustive Search Resolution*

         Translational 1.5

         Rotational 2.0

      *Optimization Resolution*

         Translational 0.75

         Rotational 1.0

      *Number exhaustive search poses optimized during docking*

         100

   .. oe:constant:: Default

      Same as :oe:const:`OEDocking::OESearchResolution::Standard`

   .. oe:constant:: INVALID

      Used as a return type to indicate an error



.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEAddDockingInteractions

.. oe:function:: OEAddDockingInteractions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddDockingInteractions(OEBio::OEInteractionHintContainer& asite)

   .. oe:language:: python

      .. oe:api:: python

         OEAddDockingInteractions(container: OEInteractionHintContainer) -> bool

   Perceives interactions (contact, hydrogen bonding, chelator) between the two 
   molecules stored in the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

   .. seealso::

      * :oe:func:`OEBio::OEPerceiveInteractionHints` function
        of **OEChem TK**

      * Example in the :ref:`section_example_oebio_printinteractions`
        section of the **OEChem TK** manual about accessing the interactions.

      * Example in the :ref:`section_examples_summary_complex2img` section of 
        the **Grapheme TK** manual about visualizing the interactions.


.. # split from OEDockingFunctions.rst:6

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEAlignReceptors

.. oe:function:: OEAlignReceptors

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<const OEChem::OEMolBase>* OEAlignReceptors(const OEChem::OEMolBase& target_receptor,
                                                                         const OEChem::OEMolBase& receptor_to_align)

   .. oe:language:: python

      .. oe:api:: python

         OEAlignReceptors(target_receptor: Union[OEGraphMol,OEMol,OEQMol],
                          receptor_to_align: Union[OEGraphMol,OEMol,OEQMol]) -> Iterable[OEGraphMol]

    
   Given two receptors (a target and a receptor to align) return an
   iterator of aligned receptors.  In general, on success, 
   the iterator will only contain one aligned receptor and will
   be empty on failure.

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<const OEChem::OEMolBase>* OEAlignReceptors(const OEChem::OEMolBase& target_receptor,
                                                                         const OEChem::OEMolBase& receptor_to_align,
                                                                         const OEAlignReceptorFunction &)

   .. oe:language:: python

      .. oe:api:: python

         OEAlignReceptors(target_receptor: Union[OEGraphMol,OEMol,OEQMol],
                          receptor_to_align: Union[OEGraphMol,OEMol,OEQMol],
                          arg3: OEAlignReceptorFunction) -> Iterable[OEGraphMol]

    
   Align two receptors using the supplied OEAlignReceptorFunction.



.. # split from OEDockingFunctions.rst:72

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEBoxArea

.. oe:function:: OEBoxArea

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxArea(const OEBoxBase& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxArea(box: OEBoxBase) -> float

   Return the area of the box.



.. # split from OEDockingFunctions.rst:36

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEBoxExtend

.. oe:function:: OEBoxExtend

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBoxExtend(OEBoxBase& box, float x_ext, float y_ext, float z_ext)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxExtend(box: OEBoxBase, x_ext: float, y_ext: float, z_ext: float) -> bool

   Extends each side of the *box* by the specified amount.  *x_ext* extends
   the two faces of the box normal to the x-axis.  Thus the x dimension of
   the box will increase by 2 times *x_ext*.  The *y_ext* and *z_ext* perform
   the same function for the y and z faces respectively.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBoxExtend(OEBoxBase& box, float   ext)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxExtend(box: OEBoxBase, ext: float) -> bool

   Extends every face of *box* by *ext*.  Thus every dimension of the box
   will increase by 2 times *ext*.
   


.. # split from OEDockingFunctions.rst:56

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEBoxTranslate

.. oe:function:: OEBoxTranslate

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBoxTranslate(OEBoxBase& box, float x_trans, float y_trans,
                             float z_trans)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxTranslate(box: OEBoxBase, x_trans: float, y_trans: float,
                        z_trans: float) -> bool

   Translates *box* a distance specified by (*x_trans*, *y_trans*, *z_trans*)



.. # split from OEDockingFunctions.rst:64

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEBoxVolume

.. oe:function:: OEBoxVolume

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxVolume(const OEBoxBase& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxVolume(box: OEBoxBase) -> float

   Return the volume of the box



.. # split from OEDockingFunctions.rst:114

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEBoxXDim

.. oe:function:: OEBoxXDim

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxXDim(const OEBoxBase& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxXDim(box: OEBoxBase) -> float

   Returns the X dimension of the box.



.. # split from OEDockingFunctions.rst:90

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEBoxXMid

.. oe:function:: OEBoxXMid

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxXMid(const OEBoxBase& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxXMid(box: OEBoxBase) -> float

   Returns the X midpoint of the  box.



.. # split from OEDockingFunctions.rst:122

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEBoxYDim

.. oe:function:: OEBoxYDim

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxYDim(const OEBoxBase& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxYDim(box: OEBoxBase) -> float

   Returns the Y dimension of the box.



.. # split from OEDockingFunctions.rst:98

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEBoxYMid

.. oe:function:: OEBoxYMid

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxYMid(const OEBoxBase& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxYMid(box: OEBoxBase) -> float

   Returns the Y midpoint of the  box.



.. # split from OEDockingFunctions.rst:130

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEBoxZDim

.. oe:function:: OEBoxZDim

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxZDim(const OEBoxBase& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxZDim(box: OEBoxBase) -> float

   Returns the Z dimension of the box.



.. # split from OEDockingFunctions.rst:106

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEBoxZMid

.. oe:function:: OEBoxZMid

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEBoxZMid(const OEBoxBase& box)

   .. oe:language:: python

      .. oe:api:: python

         OEBoxZMid(box: OEBoxBase) -> float

   Returns the Z midpoint of the  box.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDesignUnit DesignUnit

.. oe:function:: OECreateDUFromReceptorMol

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool OECreateDUFromReceptorMol(OEBio::OEDesignUnit& du,
                                         const OEChem::OEMolBase& recMol)

    .. oe:language:: python

       .. oe:api:: python

          OECreateDUFromReceptorMol(du: OEDesignUnit,
                                    recMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Create a :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object from receptor molecule.

    .. seealso::

      * :oe:func:`OESpruce::OEMakeDesignUnits` function
      * :oe:func:`OEDocking::OEMakeReceptor` function


.. # split from OEDockingFunctions.rst:282

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDockMethodConfigure

.. oe:function:: OEDockMethodConfigure

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDockMethodConfigure(OESystem::OEInterface& itf,
                                    std::string flagName)

   .. oe:language:: python

      .. oe:api:: python

         OEDockMethodConfigure(itf: OEInterface, parameter: str) -> bool

   This function is used in conjunction with the 
   :oe:func:`OEDocking::OEDockMethodGetValue`.  It adds a command line flag to
   the *itf* to specify a dock method to use.  Once the command line has been
   parsed (:oe:func:`OESystem::OEParseCommandLine`) the *itf* and *flagName* 
   are passed to :oe:func:`OEDocking::OEDockMethodGetValue` that will
   return the constant from the :oe:constns:`OEDocking::OEDockMethod` namespace
   associated with the dock method the user selected (or the default scoring
   function if the user didn't specify one).

   .. note::
 
      The parameter added to *itf* will be of type string, name *flagName*, and
      have legal values associated with the dock method.
 


.. # split from OEDockingFunctions.rst:251

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDockMethodGetName

.. oe:function:: OEDockMethodGetName

   .. oe:language:: c++ java csharp

      .. oe:api::

         string OEDockMethodGetName(unsigned int method)

   .. oe:language:: python

      .. oe:api:: python

         OEDockMethodGetName(method: int) -> str

   Returns the name of the scoring function.  *method* is a constant from
   the :oe:constns:`OEDocking::OEDockMethod` namespace.



.. # split from OEDockingFunctions.rst:260

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDockMethodGetValue

.. oe:function:: OEDockMethodGetValue

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEDockMethodGetValue(std::string name)

   .. oe:language:: python

      .. oe:api:: python

         OEDockMethodGetValue(name: str) -> int

   Returns the value of a constant from the :oe:constns:`OEDocking::OEDockMethod`
   namespace associated with the scoring function *name*, or 
   :oe:const:`OEDocking::OEDockMethod::INVALID` if the name is not recognized.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEDockMethodGetValue(const OESystem::OEInterface& itf,
                                           std::string flagName)

   .. oe:language:: python

      .. oe:api:: python

         OEDockMethodGetValue(itf: OEInterface, parameter: str) -> int

   Used in conjunction with the :oe:func:`OEDocking::OEDockMethodConfigure`
   function.  Returns a constant from the :oe:constns:`OEDocking::OEDockMethod`
   namespace associated with the dock method the user specified on the
   command line, or :oe:const:`OEDocking::OEDockMethod::Default` if the user did
   not specify a value.  *itf* and *flagName* should be the same as those
   passed to the :oe:func:`OEDocking::OEDockMethodConfigure` function and 
   :oe:func:`OESystem::OEParseCommandLine` should have been called on *itf*.
 


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDockingGetArch

.. oe:function:: OEDockingGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEDockingGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEDockingGetArch() -> str

   Returns the architecture of the current version of the OEDocking
   toolkit. Examples include:

   * microsoft-win32-x86

   * redhat-RHEL5-x86_64


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDockingGetLicensee

.. oe:function:: OEDockingGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDockingGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEDockingGetLicensee(licensee: str) -> bool

   Returns the LICENSEE from the current valid Docking TK license.


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDockingGetPlatform

.. oe:function:: OEDockingGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEDockingGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEDockingGetPlatform() -> str

   Returns the platform, including compiler version, of the current
   version of the OEDocking toolkit. Examples include:

   * microsoft-win32-msvc9-MD-x86

   * redhat-RHEL5-g++4.1-x86_64


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDockingGetRelease

.. oe:function:: OEDockingGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEDockingGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEDockingGetRelease() -> str

   Returns the version of this toolkit release. For example: ``1.6.1``.


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDockingGetSite

.. oe:function:: OEDockingGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDockingGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEDockingGetSite(site: str) -> bool

   Returns the SITE from the current valid OEDocking TK license.


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDockingGetVersion

.. oe:function:: OEDockingGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEDockingGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEDockingGetVersion() -> int

   Returns the build date of the toolkit as an unsigned int. For example: ``20090227``.


.. # split from OEDockingFunctions.rst:251

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDockingReturnCodeGetName

.. oe:function:: OEDockingReturnCodeGetName

   .. oe:language:: c++ java csharp

      .. oe:api::

         string OEDockingReturnCodeGetName(unsigned int returnCode)

   .. oe:language:: python

      .. oe:api:: python

         OEDockingReturnCodeGetName(rcode: int) -> str

   Returns the name of the return code.  *returnCode* is a constant from
   the :oe:constns:`OEDocking::OEDockingReturnCode` namespace.



.. # split from OEDockingFunctions.rst:364

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEGetEstimatedPositProbability

..  _OEDocking_OEGetEstimatedPositProbability:

.. oe:function:: OEGetEstimatedPositProbability

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetEstimatedPositProbability(const OEChem::OEMCMolBase& ligand,
                                               const OEBio::OEDesignUnit& du)
         double OEGetEstimatedPositProbability(const OEChem::OEMCMolBase& ligand,
                                               const OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEGetEstimatedPositProbability(ligand: OEMol, du: OEDesignUnit) -> float
         OEGetEstimatedPositProbability(ligand: OEMol,
                                        receptor: Union[OEGraphMol,OEMol,OEQMol]) -> float

   Given a multi conformer ligand and a receptor, return the 
   probability that, if the ligand binds to the receptor, the
   binding pose of the ligand can be retrieved.

   This function is helpful in selecting a receptor to pose against 
   from a group of receptors.



.. # split from OEDockingFunctions.rst:379

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEGetPositMethod

.. oe:function:: OEGetPositMethod

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetPositMethod(const OEChem::OEMolBase &)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPositMethod(arg1: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Return the OEPositMethod used to pose the molecule.  The
   molecule must be posed first.  See the :oe:const:`OEDocking::OEPositMethod` namespace
   for more details.



.. # split from OEDockingFunctions.rst:364

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEHasClash

.. _OEDocking_OEHasClash:

.. oe:function:: OEHasClash

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasClash(const OEChem::OEMolBase& ligand,
                         const OEChem::OEMolBase& receptor,
                         const unsigned allowedType)

   .. oe:language:: python

      .. oe:api:: python

         OEHasClash(ligand: Union[OEGraphMol,OEMol,OEQMol],
                    receptor: Union[OEGraphMol,OEMol,OEQMol], allowedType: int) -> bool

   Returns ``true`` if there is clash between the supplied ligand and the receptor. Otherwise, it returns ``false``.
   The third argument, ``allowedType``, refers to definition of allowed clash
   type, according to the :oe:constns:`OEDocking::OEAllowedClashType` namespace.



.. # split from OEDockingFunctions.rst:80

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEInBox

.. oe:function:: OEInBox

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEInBox(const OEBoxBase& box, float x, float y, float z)

   .. oe:language:: python

      .. oe:api:: python

         OEInBox(box: OEBoxBase, x: float, y: float, z: float) -> bool

   Returns true if (*x* , *y*, *z*) is within *box*.

   Coordinates that lie on an edge of *box* are considered to be in *box*.



.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEInSphere

.. oe:function:: OEInSphere

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEInSphere(const OESphereBase& sph, float x, float y, float z)

   .. oe:language:: python

      .. oe:api:: python

         OEInSphere(sph: OESphereBase, x: float, y: float, z: float) -> bool

   Returns true if (*x* , *y*, *z*) is within the sphere *sph*.

   Coordinates that lie on an edge of *sph* are considered to be in *sph*.


.. # split from OEDockingFunctions.rst:509

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEIsReceptor

.. oe:function:: OEIsReceptor

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsReceptor(const OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEIsReceptor(rec: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns true if *rec* is a receptor.



.. # split from OEDockingFunctions.rst:220

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEMakeBoxMolecule

.. oe:function:: OEMakeBoxMolecule

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeBoxMolecule(OEChem::OEMolBase& mol,
                                const OEMath::OEBox& box)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeBoxMolecule(mol: Union[OEGraphMol,OEMol,OEQMol], box: OEBox) -> bool

   Creates a molecule (*mol*) out of *box*.  *mol* will have 8 nitrogen atoms,
   one at each corner of the box and a single bond between appropriate atoms.
  
   Note that this molecule is in no way chemically valid.  The purpose of this
   method is to create a molecule representing *box* that can be viewed in
   a molecular visualizer.



.. # split from OEDockingFunctions.rst:908

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEMakeReceptor

.. _OEDocking_OEMakeReceptor:

.. oe:function:: OEMakeReceptor

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeReceptor(OEBio::OEDesignUnit& designUnit,
                             const OEMakeReceptorOptions& opts = OEMakeReceptorOptions(),
                             OESystem::OETracerBase& tracer = OESystem::OENoTracer)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeReceptor(designUnit: OEDesignUnit,
                        opts: OEMakeReceptorOptions = OEMakeReceptorOptions(),
                        tracer: OETracerBase = OENoTracer) -> bool

   Create a *receptor* object in the *design unit*.
   This function returns true if successful.

   *designUnit*
      The design unit to receive the receptor.

   *opts*
      Options controlling receptor preparation.

   *tracer*
      Optional tracer for logging messages during receptor creation.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEMakeReceptor

.. oe:function:: OEMakeReceptorDeprecated

      .. warning::

         |DEPRECATED-API|
         The overloads below are deprecated. Please use :oe:func:`OEMakeReceptor<OEDocking::OEMakeReceptor>` instead.

   .. oe:api::

      bool OEMakeReceptor(OEChem::OEMolBase& receptor,
                          const OEChem::OEMolBase& proteinStructure,
                          const OEMath::OEBox& box, bool strip_water = true,
                          const unsigned int negImgType = OENegativeImageType::Default)

   Creates a *receptor* object using a *box* and the protein structure.

      *receptor*:
         The created receptor.

      *proteinStructure*:
         Structure of a target protein.

      *box*:
         An :ref:`OEBoxBase <OEDocking_OEBoxBase>` enclosing the active site on the
         *proteinStructure*.  The box should enclose all possible docked ligand
         positions (heavy atoms of the docked pose must fit within the box).
         It is not necessary to enclose the protein residues the docked ligand
         may interact with.

      *stripWater*:
         If this flag is true water molecules present in *proteinStructure*
         will be stripped from the protein structure of the *receptor* and
         added to the extra molecules information of the *receptor*.

      *negImgType*:
         Specifies the type of negative image to create
         (see :oe:constns:`OEDocking::OENegativeImageType` namespace).

   This function returns true if successful.

   .. oe:api::

      bool OEMakeReceptor(OEChem::OEMolBase& receptor,
                          const OEChem::OEMolBase& proteinStructure,
                          const OEChem::OEMolBase& boundLigand,
                          bool stripWater = true,
                          unsigned int negImgType = OENegativeImageType::Default)

   Creates a *receptor* object using a *boundLigand* and the protein structure.

      *receptor*:
         The created receptor.

      *proteinStructure*:
         Structure of a target protein.

      *boundLigand*:
         The structure of a ligand bound to the active site.

      *stripWater*:
         If this flag is true water molecules present in *proteinStructure*
         will be stripped from the protein structure of the *receptor* and
         added to the extra molecules information of the *receptor*.

      *negImgType*:
         Specifies the type of negative image to create
         (see :oe:constns:`OEDocking::OENegativeImageType` namespace).

   This function returns true if successful.

   .. oe:api::

      bool OEMakeReceptor(OEChem::OEMolBase& receptor,
                          const OEChem::OEMolBase& proteinStructure,
                          const OEChem::OEAtomBase* hint,
                          bool strip_water = true,
                          const unsigned int negImgType = OENegativeImageType::Default)

   Creates a *receptor* object using the protein structure and the identity of one
   atom of the protein structure near the active site.

      *receptor*:
         The created receptor.

      *proteinStructure*:
         Structure of a target protein.

      *hint*:
         An atom of *proteinStructure* that is near the binding site.

      *stripWater*:
         If this flag is true water molecules present in *proteinStructure*
         will be stripped from the protein structure of the *receptor* and
         added to the extra molecules information of the *receptor*.

      *negImgType*:
         Specifies the type of negative image to create
         (see :oe:constns:`OEDocking::OENegativeImageType` namespace).

   This function returns true if successful.

   .. oe:api::

      bool OEMakeReceptor(OEChem::OEMolBase& receptor,
                          const OEChem::OEMolBase& proteinStructure,
                          float hintX, float hintY, float hintZ,
                          bool stripWater = true,
                          unsigned int negImgType = OENegativeImageType::Default)

   Creates a *receptor* object using the protein structure and a coordinate near the
   active site.

      *receptor*:
         The created receptor.

      *proteinStructure*:
         Structure of a target protein.

      *hintX hintY hintZ*:
         Coordinate near the binding site of *proteinStructure*.

      *stripWater*:
         If this flag is true water molecules present in *proteinStructure*
         will be stripped from the protein structure of the *receptor* and
         added to the extra molecules information of the *receptor*.

      *negImgType*:
         Specifies the type of negative image to create
         (see :oe:constns:`OEDocking::OENegativeImageType` namespace).

   .. attention::

      The below API using an OEDesignUnit is currently available in C++ and Python.

   .. oe:api::

      bool OEMakeReceptor(OEChem::OEMolBase& receptor,
                          const OEBio::OEDesignUnit& designUnit,
                          bool stripWater = true,
                          unsigned int negImgType = OENegativeImageType::Default)

   Creates a *receptor* object using a *designunit*, where the binding site has already been defined

      *receptor*:
         The created receptor.

      *designUnit*:
         The designunit.

      *stripWater*:
         If this flag is true water molecules present in *designunit*
         will be stripped from the structure of the *receptor* and
         added to the extra molecules information of the *receptor*.

      *negImgType*:
         Specifies the type of negative image to create
         (see :oe:constns:`OEDocking::OENegativeImageType` namespace).

   This function returns true if successful.



.. # split from OEDockingFunctions.rst:339

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OENegativeImageTypeConfigure

.. oe:function:: OENegativeImageTypeConfigure

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OENegativeImageTypeConfigure(OESystem::OEInterface& itf,
                                           std::string flagName)

   .. oe:language:: python

      .. oe:api:: python

         OENegativeImageTypeConfigure(itf: OEInterface, parameter: str) -> bool

   This function is used in conjunction with the 
   :oe:func:`OEDocking::OENegativeImageTypeGetValue`.  It adds a command line flag to
   the *itf* to specify a negative image type to use.  Once the command line has been
   parsed (:oe:func:`OESystem::OEParseCommandLine`) the *itf* and *flagName* 
   are passed to :oe:func:`OEDocking::OENegativeImageTypeGetValue` that will
   return the constant from the :oe:constns:`OEDocking::OENegativeImageType` namespace
   associated with the negative image type the user selected (or the default scoring
   function if the user didn't specify one).

   .. note::
 
      The parameter added to *itf* will be of type string, name *flagName*, and
      have legal values associated with the negative image type.
 


.. # split from OEDockingFunctions.rst:307

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OENegativeImageTypeGetName

.. oe:function:: OENegativeImageTypeGetName

   .. oe:language:: c++ java csharp

      .. oe:api::

         string OENegativeImageTypeGetName(unsigned int method)

   .. oe:language:: python

      .. oe:api:: python

         OENegativeImageTypeGetName(arg1: int) -> str

   Returns the name of the scoring function.  *method* is a constant from
   the :oe:constns:`OEDocking::OENegativeImageType` namespace.



.. # split from OEDockingFunctions.rst:316

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OENegativeImageTypeGetValue

.. oe:function:: OENegativeImageTypeGetValue

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OENegativeImageTypeGetValue(std::string name)

   .. oe:language:: python

      .. oe:api:: python

         OENegativeImageTypeGetValue(name: str) -> int

   Returns the value of a constant from the :oe:constns:`OEDocking::OENegativeImageType`
   namespace associated with the scoring function *name*, or 
   :oe:const:`OEDocking::OENegativeImageType::INVALID` if the name is not recognized.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OENegativeImageTypeGetValue(const OESystem::OEInterface& itf,
                                                  std::string flagName)

   .. oe:language:: python

      .. oe:api:: python

         OENegativeImageTypeGetValue(itf: OEInterface, parameter: str) -> int

   Used in conjunction with the :oe:func:`OEDocking::OENegativeImageTypeConfigure`
   function.  Returns a constant from the :oe:constns:`OEDocking::OENegativeImageType`
   namespace associated with the negative image type the user specified on the
   command line, or :oe:const:`OEDocking::OENegativeImageType::Default` if the user did
   not specify a value.  *itf* and *flagName* should be the same as those
   passed to the :oe:func:`OEDocking::OENegativeImageTypeConfigure` function and 
   :oe:func:`OESystem::OEParseCommandLine` should have been called on *itf*.
 


.. meta::
   :keywords: OEPositMethodGetName

.. oe:namespace:: OEDocking

.. oe:function:: OEPositMethodGetName

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEPositMethodGetName(unsigned)

   .. oe:language:: python

      .. oe:api:: python

         OEPositMethodGetName(method: int) -> str

   Returns method name corresponding to constants defined in
   :oe:constns:`OEDocking::OEPositMethod` namespace.


.. # split from OEDockingFunctions.rst:1047

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReadReceptorFile

.. oe:function:: OEReadReceptorFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadReceptorFile(OEChem::OEMolBase& receptor,
                                 std::string filename)

   .. oe:language:: python

      .. oe:api:: python

         OEReadReceptorFile(receptor: Union[OEGraphMol,OEMol,OEQMol],
                            filename: str) -> bool

   Reads a receptor from file *filename* into *receptor*.  

   Returns true if successful.

   .. note::
      
      All receptor files must be in either .oeb or .oeb.gz format.




.. oe:language:: c++

   .. oe:namespace:: OEDocking

   .. meta::
      :keywords: OEReadReceptorFromString

   .. oe:function:: OEReadReceptorFromString

      .. oe:api:: c++

         bool OEReadReceptorFromString(OEMolBase& mol,
                                       const std::string& format,
                                       const std::string& data)
         bool OEReadReceptorFromString(OEMolBase& mol, unsigned format,
                                       unsigned flavor, bool gzip,
                                       const std::string& data)

         bool OEReadReceptorFromString(OEMCMolBase& mol,
                                       const std::string& format,
                                       const std::string& data)
         bool OEReadReceptorFromString(OEMCMolBase& mol, unsigned format,
                                       unsigned flavor, bool gzip,
                                       const std::string& data)

.. oe:language:: java

   .. oe:namespace:: OEDocking

   .. meta::
      :keywords: OEReadReceptorFromString, OEReadReceptorFromByteArray

   .. oe:function:: OEReadReceptorFromByteArray

      .. oe:api:: java

         boolean OEReadReceptorFromByteArray(OEMolBase mol, String format,
                                             byte[] data)
         boolean OEReadReceptorFromByteArray(OEMolBase mol, int format,
                                             int flavor, boolean gzip,
                                             byte[] data)

         boolean OEReadReceptorFromByteArray(OEMCMolBase mol, String format,
                                             byte[] data)
         boolean OEReadReceptorFromByteArray(OEMCMolBase mol, int format,
                                             int flavor, boolean gzip,
                                             byte[] data)

.. oe:language:: python

   .. oe:namespace:: OEDocking

   .. meta::
      :keywords: OEReadReceptorFromString, OEReadReceptorFromBytes

   .. oe:function:: OEReadReceptorFromBytes

      .. oe:api:: python

         OEReadReceptorFromBytes(OEMolBase, format, data) -> bool
         OEReadReceptorFromBytes(OEMolBase, format, flavor, gzip, data) -> bool

         OEReadReceptorFromBytes(OEMCMolBase, format, data) -> bool
         OEReadReceptorFromBytes(OEMCMolBase, format, flavor, gzip, data) -> bool

.. oe:language:: csharp

   .. oe:namespace:: OEDocking

   .. meta::
      :keywords: OEReadReceptorFromString, OEReadReceptorFromBytes

   .. oe:function:: OEReadReceptorFromBytes

      .. oe:api:: csharp

         boolean OEReadReceptorFromBytes(OEMolBase mol, String format,
                                         byte[] data)
         boolean OEReadReceptorFromBytes(OEMolBase mol, int format, int flavor,
                                         boolean gzip, byte[] data)

         boolean OEReadReceptorFromBytes(OEMCMolBase mol, String format,
                                         byte[] data)
         boolean OEReadReceptorFromBytes(OEMCMolBase mol, int format,
                                         int flavor, boolean gzip, byte[] data)

.. oe:language:: c++ python java csharp

   Instantiates a receptor from the contents of 'data' in terms of 'format'. 'format' must be a file extension
   that is readable by OpenEye, for example: ".oeb.gz". Overloads which take
   an unsigned 'format', unsigned 'flavor' and Boolean 'gzip' parameters expect
   the format and corresponding flavor to be specified by one of the constants 
   in :oe:constns:`OEChem::OEFormat` and :oe:constns:`OEChem::OEIFlavor`.

   Returns 'true' if decoding was successful and the decoded molecule is identified as a receptor.

.. oe:language:: c++

   .. oe:source:: ReceptorIO.cpp
      :language: c++
      :frag:     SNIPPET-RECEPTOR-IO-3
      :noindent:

   .. oe:source:: ReceptorIO.cpp
      :language: c++
      :frag:     SNIPPET-RECEPTOR-IO-4
      :noindent:

   .. oe:source:: ReceptorIO.cpp
      :language: c++
      :frag:     SNIPPET-RECEPTOR-IO-7
      :noindent:

   .. oe:source:: ReceptorIO.cpp
      :language: c++
      :frag:     SNIPPET-RECEPTOR-IO-8
      :noindent:

.. oe:language:: python

   .. oe:source:: ReceptorIO.py
      :language: python
      :frag:     SNIPPET-RECEPTOR-IO-3
      :noindent:

   :ref:`Full listing. <listing-ReceptorIO.py>`

   .. oe:source:: ReceptorIO.py
      :language: python
      :frag:     SNIPPET-RECEPTOR-IO-4
      :noindent:

   :ref:`Full listing. <listing-ReceptorIO.py>`

   .. oe:source:: ReceptorIO.py
      :language: python
      :frag:     SNIPPET-RECEPTOR-IO-7
      :noindent:

   :ref:`Full listing. <listing-ReceptorIO.py>`

   .. oe:source:: ReceptorIO.py
      :language: python
      :frag:     SNIPPET-RECEPTOR-IO-8
      :noindent:

   :ref:`Full listing. <listing-ReceptorIO.py>`

.. oe:language:: java

   .. oe:source:: ReceptorIO.java
      :language: java
      :frag:     SNIPPET-RECEPTOR-IO-3
      :noindent:

   .. oe:source:: ReceptorIO.java
      :language: java
      :frag:     SNIPPET-RECEPTOR-IO-4
      :noindent:

   .. oe:source:: ReceptorIO.java
      :language: java
      :frag:     SNIPPET-RECEPTOR-IO-7
      :noindent:

   .. oe:source:: ReceptorIO.java
      :language: java
      :frag:     SNIPPET-RECEPTOR-IO-8
      :noindent:

.. oe:language:: csharp

   .. oe:source:: ReceptorIO.cs
      :language: csharp
      :frag:     SNIPPET-RECEPTOR-IO-3
      :noindent:

   .. oe:source:: ReceptorIO.cs
      :language: csharp
      :frag:     SNIPPET-RECEPTOR-IO-4
      :noindent:

   .. oe:source:: ReceptorIO.cs
      :language: csharp
      :frag:     SNIPPET-RECEPTOR-IO-7
      :noindent:

   .. oe:source:: ReceptorIO.cs
      :language: csharp
      :frag:     SNIPPET-RECEPTOR-IO-8
      :noindent:



.. # split from OEDockingFunctions.rst:862

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorAddCachedScore

.. oe:function:: OEReceptorAddCachedScore

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorAddCachedScore(OEChem::OEMolBase& rec, OEScore& score)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorAddCachedScore(rec: Union[OEGraphMol,OEMol,OEQMol],
                                  score: OEScore) -> bool

   Equivalent to calling :oe:meth:`OEDocking::OEScore::CacheScoringSetup`
   with *clearOldData* false.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorAddCachedScore(OEChem::OEMolBase& rec, OEDock& dock)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorAddCachedScore(rec: Union[OEGraphMol,OEMol,OEQMol],
                                  dock: OEDock) -> bool

   Equivalent to calling :oe:meth:`OEDocking::OEDock::CacheScoringSetup`
   with *clearOldData* false.



.. # split from OEDockingFunctions.rst:706

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorAddExtraMol

.. oe:function:: OEReceptorAddExtraMol

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorAddExtraMol(OEChem::OEMolBase& receptor,
                                    const OEChem::OEMolBase& extraMol)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorAddExtraMol(rec: Union[OEGraphMol,OEMol,OEQMol],
                               arg2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Adds a copy of *extraMol* to *receptor's* extra molecules.

   Returns true if successful.

   It is only valid to call this function if *receptor* is a valid receptor 
   (i.e., :oe:func:`OEDocking::OEIsReceptor` returns true).



.. # split from OEDockingFunctions.rst:517

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorClear

.. oe:function:: OEReceptorClear

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorClear(OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorClear(rec: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Clears all receptor information from *receptor*, except the structure of the
   protein.



.. # split from OEDockingFunctions.rst:670

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorClearBoundLigand

.. oe:function:: OEReceptorClearBoundLigand

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorClearBoundLigand(OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorClearBoundLigand(rec: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Clears any bound ligand from *receptor*.

   Returns true if successful.

.. _section_receptor_api_extra_molecules:



.. # split from OEDockingFunctions.rst:894

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorClearCachedScore

.. oe:function:: OEReceptorClearCachedScore

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorClearCachedScore(OEChem::OEMolBase& rec)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorClearCachedScore(rec: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Clears all score setup caches, from :ref:`OEScore <OEDocking_OEScore>`
   or :ref:`OEDock <OEDocking_OEDock>` objects, from the receptor.



.. # split from OEDockingFunctions.rst:836

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorClearCustomConstraints

.. oe:function:: OEReceptorClearCustomConstraints

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorClearCustomConstraints(OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorClearCustomConstraints(rec: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Clears all custom constraints on a receptor.

   Returns true if successful.



.. # split from OEDockingFunctions.rst:720

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorClearExtraMols

.. oe:function:: OEReceptorClearExtraMols

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorClearExtraMols(OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorClearExtraMols(rec: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Clears all extra molecules from *receptor*.

   Returns true if successful.



.. # split from OEDockingFunctions.rst:777

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorClearProteinConstraint

.. oe:function:: OEReceptorClearProteinConstraint

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorClearProteinConstraint(OEChem::OEMolBase& rec,
                                               const OEProteinConstraint& pc)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorClearProteinConstraint(rec: Union[OEGraphMol,OEMol,OEQMol],
                                          arg2: OEProteinConstraint) -> bool

   Clears a given protein constraint from *receptor*.



.. # split from OEDockingFunctions.rst:786

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorClearProteinConstraints

.. oe:function:: OEReceptorClearProteinConstraints

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorClearProteinConstraints(OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorClearProteinConstraints(rec: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Clears all protein constraints from *receptor*.



.. # split from OEDockingFunctions.rst:643

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorGetBoundLigand

.. oe:function:: OEReceptorGetBoundLigand

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEChem::OEGraphMol OEReceptorGetBoundLigand(const OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorGetBoundLigand(rec: Union[OEGraphMol,OEMol,OEQMol]) -> OEGraphMol

   Returns a copy of the *receptor's* bound ligand.

   If the receptor does not have a bound ligand then an empty molecule will be returned

   It is only valid to call this function if *receptor* is a valid receptor 
   (i.e., :oe:func:`OEDocking::OEIsReceptor` returns true).



.. # split from OEDockingFunctions.rst:810

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorGetCustomConstraints

.. oe:function:: OEReceptorGetCustomConstraints

   .. oe:language:: c++ java csharp

      .. oe:api::

         OECustomConstraints OEReceptorGetCustomConstraints(const OEChem::OEMolBase& rec)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorGetCustomConstraints(rec: Union[OEGraphMol,OEMol,OEQMol]) -> OECustomConstraints

   Returns a copy of the *receptor's* custom constraints 
 
   It is only valid to call this function if *receptor* is a valid receptor 
   (i.e., :oe:func:`OEDocking::OEIsReceptor` returns true).



.. # split from OEDockingFunctions.rst:695

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorGetExtraMols

.. oe:function:: OEReceptorGetExtraMols

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEIterBase<const OEMolBase>* OEReceptorGetExtraMols(const OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorGetExtraMols(rec: Union[OEGraphMol,OEMol,OEQMol]) -> Iterable[OEGraphMol]

   Returns an iterator over the extra molecules held by *receptor*.

   It is only valid to call this function if *receptor* is a valid receptor 
   (i.e., :oe:func:`OEDocking::OEIsReceptor` returns true).



.. # split from OEDockingFunctions.rst:605

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorGetInnerContourLevel

.. oe:function:: OEReceptorGetInnerContourLevel

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEReceptorGetInnerContourLevel(const OEChem::OEMolBase& rec)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorGetInnerContourLevel(rec: Union[OEGraphMol,OEMol,OEQMol]) -> float

   Returns the inner contour *level* of the *receptor*. 

   It is only valid to call this function if *receptor* is a valid receptor 
   (i.e., :oe:func:`OEDocking::OEIsReceptor` returns true).



.. # split from OEDockingFunctions.rst:544

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorGetNegativeImageGrid

.. oe:function:: OEReceptorGetNegativeImageGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEGrid<float> OEReceptorGetNegativeImageGrid(const OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorGetNegativeImageGrid(rec: Union[OEGraphMol,OEMol,OEQMol]) -> OEFloatGrid

   Returns a copy of the *receptor*'s negative image grid.

   It is only valid to call this function if *receptor* is a valid receptor 
   (i.e., :oe:func:`OEDocking::OEIsReceptor` returns true).



.. # split from OEDockingFunctions.rst:568

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorGetOuterContourLevel

.. oe:function:: OEReceptorGetOuterContourLevel

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEReceptorGetOuterContourLevel(const OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorGetOuterContourLevel(rec: Union[OEGraphMol,OEMol,OEQMol]) -> float

   Returns the outer contour *level* of the *receptor*. 

   It is only valid to call this function if *receptor* is a valid receptor 
   (i.e., :oe:func:`OEDocking::OEIsReceptor` returns true).



.. # split from OEDockingFunctions.rst:747

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorGetProteinConstraints

.. oe:function:: OEReceptorGetProteinConstraints

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<const OEProteinConstraint>*
         OESystem::OEIterBase<const OEProteinConstraint>* OEReceptorGetProteinConstraints(const OEChem::OEMolBase& rec,
                                                                                          bool enabledOnly = true)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorGetProteinConstraints(rec: Union[OEGraphMol,OEMol,OEQMol],
                                         enabledOnly: bool = True) -> Iterable[OEProteinConstraint ]

   Returns an iterator over the *receptor's* protein constraints.  If 
   *enabledOnly* is true then only enabled constraints will be returned.

   It is only valid to call this function if *receptor* is a valid receptor 
   (i.e., :oe:func:`OEDocking::OEIsReceptor` returns true).



.. # split from OEDockingFunctions.rst:635

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorHasBoundLigand

.. oe:function:: OEReceptorHasBoundLigand

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorHasBoundLigand(const OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorHasBoundLigand(rec: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns true if *receptor* is a valid receptor and has a bound ligand.



.. # split from OEDockingFunctions.rst:852

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorHasCachedScore

.. oe:function:: OEReceptorHasCachedScore

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorHasCachedScore(const OEChem::OEMolBase& rec)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorHasCachedScore(rec: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns true if *rec* has a score setup cache for any 
   :ref:`OEScore <OEDocking_OEScore>` or :ref:`OEDock <OEDocking_OEDock>` object.



.. # split from OEDockingFunctions.rst:800

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorHasCustomConstraints

.. oe:function:: OEReceptorHasCustomConstraints

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorHasCustomConstraints(const OEChem::OEMolBase& receptor,
                                             bool enabledOnly = true)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorHasCustomConstraints(rec: Union[OEGraphMol,OEMol,OEQMol],
                                        enabledOnly: bool = True) -> bool

   Returns true if *receptor* has custom constraints.  If *enabledOnly* is true
   then at least one of the constraints must be enabled.
  


.. # split from OEDockingFunctions.rst:686

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorHasExtraMols

.. oe:function:: OEReceptorHasExtraMols

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorHasExtraMols(const OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorHasExtraMols(rec: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns true if the *receptor* is a valid receptor and has one or more
   extra molecules.



.. # split from OEDockingFunctions.rst:592

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorHasInnerContourLevel

.. oe:function:: OEReceptorHasInnerContourLevel

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorHasInnerContourLevel(const OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorHasInnerContourLevel(rec: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns true if the *receptor* has an inner contour level set.

   .. note::

      This function will return true even if the inner contour is disabled
      (*i.e.* even if the level is negative).



.. # split from OEDockingFunctions.rst:536

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorHasNegativeImageGrid

.. oe:function:: OEReceptorHasNegativeImageGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorHasNegativeImageGrid(const OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorHasNegativeImageGrid(rec: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns true if the *receptor* has a negative image grid.



.. # split from OEDockingFunctions.rst:555

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorHasOuterContourLevel

.. oe:function:: OEReceptorHasOuterContourLevel

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorHasOuterContourLevel(const OEChem::OEMolBase& receptor)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorHasOuterContourLevel(rec: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns true if the *receptor* has an outer contour level set.

   .. note::

      This function will return true even if the outer contour is disabled
      (*i.e.* even if the level is negative).



.. # split from OEDockingFunctions.rst:736

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorHasProteinConstraints

.. oe:function:: OEReceptorHasProteinConstraints

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorHasProteinConstraints(const OEChem::OEMolBase& receptor,
                                              bool enabledOnly = true)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorHasProteinConstraints(rec: Union[OEGraphMol,OEMol,OEQMol],
                                         enabledOnly: bool = True) -> bool

   Returns true if *receptor* is a valid receptor and has one or more
   protein constraints.  If *enabledOnly* the constraint(s) must also be
   enabled.



.. # split from OEDockingFunctions.rst:656

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorSetBoundLigand

.. oe:function:: OEReceptorSetBoundLigand

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorSetBoundLigand(OEChem::OEMolBase& receptor,
                                       const OEChem::OEMolBase& boundLigand)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorSetBoundLigand(rec: Union[OEGraphMol,OEMol,OEQMol],
                                  boundLig: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Sets the bound ligand on *receptor* to be a copy of *boundLigand*.

   Returns true if successful.

   It is only valid to call this function if *receptor* is a valid receptor 
   (i.e., :oe:func:`OEDocking::OEIsReceptor` returns true).



.. # split from OEDockingFunctions.rst:878

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorSetCachedScore

.. oe:function:: OEReceptorSetCachedScore

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorSetCachedScore(OEChem::OEMolBase& rec, OEScore& score)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorSetCachedScore(rec: Union[OEGraphMol,OEMol,OEQMol],
                                  score: OEScore) -> bool

   Equivalent to calling :oe:meth:`OEDocking::OEScore::CacheScoringSetup`
   with *clearOldData* true.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorSetCachedScore(OEChem::OEMolBase& rec, OEDock& dock)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorSetCachedScore(rec: Union[OEGraphMol,OEMol,OEQMol],
                                  dock: OEDock) -> bool

   Equivalent to calling :oe:meth:`OEDocking::OEDock::CacheScoringSetup`
   with *clearOldData* true.



.. # split from OEDockingFunctions.rst:822

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorSetCustomConstraints

.. oe:function:: OEReceptorSetCustomConstraints

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorSetCustomConstraints(OEChem::OEMolBase& rec,
                                             const OECustomConstraints& cc)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorSetCustomConstraints(rec: Union[OEGraphMol,OEMol,OEQMol],
                                        arg2: OECustomConstraints) -> bool

   Sets the *receptor's* custom constraints (copied from *customConstraints*).

   Returns true if successful.

   It is only valid to call this function if *receptor* is a valid receptor 
   (i.e., :oe:func:`OEDocking::OEIsReceptor` returns true).



.. # split from OEDockingFunctions.rst:616

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorSetInnerContourLevel

.. oe:function:: OEReceptorSetInnerContourLevel

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorSetInnerContourLevel(OEChem::OEMolBase& receptor,
                                             float level)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorSetInnerContourLevel(rec: Union[OEGraphMol,OEMol,OEQMol],
                                        level: float) -> bool

   Sets the inner contour *level* on the *receptor*.

   Returns true if successful.

   It is only valid to call this function if *receptor* is a valid receptor 
   (i.e., :oe:func:`OEDocking::OEIsReceptor` returns true).



.. # split from OEDockingFunctions.rst:579

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorSetOuterContourLevel

.. oe:function:: OEReceptorSetOuterContourLevel

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorSetOuterContourLevel(OEChem::OEMolBase& receptor,
                                             float level)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorSetOuterContourLevel(rec: Union[OEGraphMol,OEMol,OEQMol],
                                        level: float) -> bool

   Sets the outer contour *level* on the *receptor*.

   Returns true if successful.

   It is only valid to call this function if *receptor* is a valid receptor 
   (i.e., :oe:func:`OEDocking::OEIsReceptor` returns true).



.. # split from OEDockingFunctions.rst:761

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEReceptorSetProteinConstraint

.. oe:function:: OEReceptorSetProteinConstraint

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReceptorSetProteinConstraint(OEChem::OEMolBase& rec,
                                             const OEProteinConstraint& pc)

   .. oe:language:: python

      .. oe:api:: python

         OEReceptorSetProteinConstraint(rec: Union[OEGraphMol,OEMol,OEQMol],
                                        arg2: OEProteinConstraint) -> bool

   Sets a protein constraint.  If the *receptor* already has a constraint on 
   :oe:meth:`OEDocking::OEProteinConstraint::GetAtom` the constraint will be
   replaced, otherwise a new one will be created.

   Returns true if successful.

   It is only valid to call this function if *receptor* is a valid receptor 
   (i.e., :oe:func:`OEDocking::OEIsReceptor` returns true).



.. # split from OEDockingFunctions.rst:425

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEScoreTypeConfigure

.. oe:function:: OEScoreTypeConfigure

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEScoreTypeConfigure(OESystem::OEInterface& itf,
                                   std::string flagName)

   .. oe:language:: python

      .. oe:api:: python

         OEScoreTypeConfigure(itf: OEInterface, parameter: str) -> bool

   This function is used in conjunction with the
   :oe:func:`OEDocking::OEScoreTypeGetValue`.  It adds a command line flag to
   the *itf* to specify a scoring function to use.  Once the command line has been
   parsed (:oe:func:`OESystem::OEParseCommandLine`) the *itf* and *flagName*
   are passed to :oe:func:`OEDocking::OEScoreTypeGetValue` that will
   return the constant from this namespace associated with the scoring function the
   user selected (or the default scoring function if the user didn't specify one).

   .. note::

      The parameter added to *itf* will be of type string, name *flagName*, and
      have legal values associated with the scoring functions.


.. # split from OEDockingFunctions.rst:394

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEScoreTypeGetName

.. oe:function:: OEScoreTypeGetName

   .. oe:language:: c++ java csharp

      .. oe:api::

         string OEScoreTypeGetName(unsigned int scoring)

   .. oe:language:: python

      .. oe:api:: python

         OEScoreTypeGetName(scoring: int) -> str

   Returns the name of the scoring function.  *scoring* is a constant from this namespace.



.. # split from OEDockingFunctions.rst:402

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEScoreTypeGetValue

.. oe:function:: OEScoreTypeGetValue

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEScoreTypeGetValue(std::string name)

   .. oe:language:: python

      .. oe:api:: python

         OEScoreTypeGetValue(name: str) -> int

   Returns the value of a constant from this namespace associated with the
   scoring function *name*, or :oe:const:`OEDocking::OEScoreType::INVALID` if
   the name is not recognized.

   This function is defined within the OEScoreType namespace.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEScoreTypeGetValue(const OESystem::OEInterface& itf,
                                          std::string flagName)

   .. oe:language:: python

      .. oe:api:: python

         OEScoreTypeGetValue(itf: OEInterface, parameter: str) -> int

   Used in conjunction with the :oe:func:`OEDocking::OEScoreTypeConfigure` function.
   Returns a constant from this namespace associated with the scoring function the
   user specified on the command line, or :oe:const:`OEDocking::OEScoreType::Default`
   if the user did not specify a value.  *itf* and *flagName* should be the same as
   those passed to the :oe:func:`OEDocking::OEScoreTypeConfigure` function and
   :oe:func:`OESystem::OEParseCommandLine` should have been called on *itf*.



.. # split from OEDockingFunctions.rst:482

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESearchResolutionConfigure

.. oe:function:: OESearchResolutionConfigure

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESearchResolutionConfigure(OESystem::OEInterface& itf,
                                          std::string flagName)

   .. oe:language:: python

      .. oe:api:: python

         OESearchResolutionConfigure(itf: OEInterface, parameter: str) -> bool

   This function is used in conjunction with the
   :oe:func:`OEDocking::OESearchResolutionGetValue`.  It adds a command line flag to
   the *itf* to specify a dock resolution to use.  Once the command line has been
   parsed (:oe:func:`OESystem::OEParseCommandLine`) the *itf* and *flagName*
   are passed to :oe:func:`OEDocking::OESearchResolutionGetValue` that will
   return the constant from the :oe:constns:`OEDocking::OESearchResolution` namespace
   associated with the dock resolution the user selected (or the default scoring
   function if the user didn't specify one).

   .. note::

      The parameter added to *itf* will be of type string, name *flagName*, and
      have legal values associated with the dock resolutions.



.. # split from OEDockingFunctions.rst:449

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESearchResolutionGetName

.. oe:function:: OESearchResolutionGetName

   .. oe:language:: c++ java csharp

      .. oe:api::

         string OESearchResolutionGetName(unsigned int resolution)

   .. oe:language:: python

      .. oe:api:: python

         OESearchResolutionGetName(resolution: int) -> str

   Returns the name of the scoring function.  *resolution* is a
   constant from the :oe:constns:`OEDocking::OESearchResolution` namespace.



.. # split from OEDockingFunctions.rst:458

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESearchResolutionGetValue

.. oe:function:: OESearchResolutionGetValue

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OESearchResolutionGetValue(std::string name)

   .. oe:language:: python

      .. oe:api:: python

         OESearchResolutionGetValue(name: str) -> int

   Returns the value of a constant from the 
   :oe:constns:`OEDocking::OESearchResolution` namespace associated with the
   scoring function *name*, or :oe:const:`OEDocking::OESearchResolution::INVALID`
   if the name is not recognized.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OESearchResolutionGetValue(const OESystem::OEInterface& itf,
                                                 std::string flagName)

   .. oe:language:: python

      .. oe:api:: python

         OESearchResolutionGetValue(itf: OEInterface, parameter: str) -> int

   Used in conjunction with the :oe:func:`OEDocking::OESearchResolutionConfigure`
   function.  Returns a constant from the :oe:constns:`OEDocking::OESearchResolution`
   namespace associated with the dock resolution the user specified on the command
   line, or :oe:const:`OEDocking::OESearchResolution::Default` if the user did not
   specify a value.  *itf* and *flagName* should be the same as those passed to
   the :oe:func:`OEDocking::OESearchResolutionConfigure` function and 
   should have been called on *itf*.



.. # split from OEDockingFunctions.rst:1102

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESetEnergyScore

.. oe:function:: OESetEnergyScore

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetEnergyScore(OEChem::OEMolBase& pose, OEDock& dock)

   .. oe:language:: python

      .. oe:api:: python

         OESetEnergyScore(ligand: Union[OEGraphMol,OEMol,OEQMol],
                          scoreFxn: OEDock) -> bool

   Sets the energy of *pose* (:oe:meth:`OEChem::OEMolBase::GetEnergy`) to the score
   of the pose calculated with the :oe:meth:`OEDocking::OEDock::ScoreLigand`
   method of *dock*.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetEnergyScore(OEChem::OEMolBase& pose, OEScore& score)

   .. oe:language:: python

      .. oe:api:: python

         OESetEnergyScore(ligand: Union[OEGraphMol,OEMol,OEQMol],
                          scoreFxn: OEScore) -> bool

   Sets the energy of *pose* (:oe:meth:`OEChem::OEMolBase::GetEnergy`) to the score
   of the pose calculated with the :oe:meth:`OEDocking::OEScore::ScoreLigand`
   method of *score*.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetEnergyScore(OEChem::OEMCMolBase& poses, OEDock& dock,
                               bool sortPoses = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetEnergyScore(ligand: OEMol, scoreFxn: OEDock,
                          sortPoses: bool = False) -> bool

   Sets the energy of each pose of *poses* (:oe:meth:`OEChem::OEMolBase::GetEnergy`)
   to the score of the pose calculated with the 
   :oe:meth:`OEDocking::OEDock::ScoreLigand` method of *dock*.

   If *sortPoses* is true the poses of will also be sorted by score.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetEnergyScore(OEChem::OEMCMolBase& poses, OEScore& score,
                               bool sortPoses = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetEnergyScore(ligand: OEMol, scoreFxn: OEScore,
                          sortPoses: bool = False) -> bool

   Sets the energy of each pose of *poses* (:oe:meth:`OEChem::OEMolBase::GetEnergy`)
   to the score of the pose calculated with the 
   :oe:meth:`OEDocking::OEScore::ScoreLigand` method of *score*.

   If *sortPoses* is true the poses will also be sorted by score.



.. # split from OEDockingFunctions.rst:1247

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESetEnergyScoreComponent

.. oe:function:: OESetEnergyScoreComponent

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetEnergyScoreComponent(OEChem::OEMolBase& pose, OEDock& dock,
                                        std::string component)

   .. oe:language:: python

      .. oe:api:: python

         OESetEnergyScoreComponent(ligand: Union[OEGraphMol,OEMol,OEQMol],
                                   scoreFxn: OEDock, component: str) -> bool

   Sets the energy of *pose* (:oe:meth:`OEChem::OEMolBase::GetEnergy`) to the 
   *component* of the score calculated with *dock's* 
   :oe:meth:`OEDocking::OEDock::ScoreLigandComponent` method. 

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetEnergyScoreComponent(OEChem::OEMolBase& pose,
                                        OEScore& score, std::string component)

   .. oe:language:: python

      .. oe:api:: python

         OESetEnergyScoreComponent(ligand: Union[OEGraphMol,OEMol,OEQMol],
                                   scoreFxn: OEScore, component: str) -> bool

   Sets the energy of *pose* (:oe:meth:`OEChem::OEMolBase::GetEnergy`) to the 
   *component* of the score calculated with *score's* 
   :oe:meth:`OEDocking::OEScore::ScoreLigandComponent` method. 

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetEnergyScoreComponent(OEChem::OEMCMolBase& pose,
                                        OEDock& dock, std::string component,
                                        bool sortPoses = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetEnergyScoreComponent(ligand: OEMol, scoreFxn: OEDock,
                                   component: str, sortPoses: bool = False) -> bool

   Sets the energy of each pose of *poses* (:oe:meth:`OEChem::OEMolBase::GetEnergy`)
   to the *component* of the score calculate with *dock's* 
   :oe:meth:`OEDocking::OEDock::ScoreLigandComponent` method. 

   If *sortPoses* is true the poses will also be sorted by score.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetEnergyScoreComponent(OEChem::OEMCMolBase& pose,
                                        OEScore& score, std::string component,
                                        bool sortPoses = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetEnergyScoreComponent(ligand: OEMol, scoreFxn: OEScore,
                                   component: str, sortPoses: bool = False) -> bool

   Sets the energy of each pose of *poses* (:oe:meth:`OEChem::OEMolBase::GetEnergy`)
   to the *component* of the score calculated with *score's* 
   :oe:meth:`OEDocking::OEScore::ScoreLigandComponent` method. 

   If *sortPoses* is true the poses will also be sorted by score.



.. # split from OEDockingFunctions.rst:1146

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESetSDScore

.. oe:function:: OESetSDScore

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetSDScore(OEChem::OEMolBase& pose, OEDock& dock,
                           std::string sdtag)

   .. oe:language:: python

      .. oe:api:: python

         OESetSDScore(ligand: Union[OEGraphMol,OEMol,OEQMol], scoreFxn: OEDock,
                      tag: str) -> bool

   Assigns the score of *pose*, using the :oe:meth:`OEDocking::OEDock::ScoreLigand`
   method of *dock*, to SD data of *pose* with the given *sdtag*.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetSDScore(OEChem::OEMolBase& pose, OEPosit& poser,
                           std::string sdtag)

   .. oe:language:: python

      .. oe:api:: python

         OESetSDScore(ligand: Union[OEGraphMol,OEMol,OEQMol],
                      scoreFxn: OEPosit, tag: str) -> bool
         OESetSDScore(ligand: Union[OEGraphMol,OEMol,OEQMol], scoreFxn: OEPosit) -> bool

   Assigns the score of *pose*, using the :oe:meth:`OEDocking::OEPosit::ScoreLigand`
   method of *poser*, to SD data of *pose* with the given *sdtag*.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetSDScore(OEChem::OEMolBase& pose, OEScore& score,
                           std::string sdtag)

   .. oe:language:: python

      .. oe:api:: python

         OESetSDScore(ligand: Union[OEGraphMol,OEMol,OEQMol],
                      scoreFxn: OEScore, tag: str) -> bool

   Assigns the score of *pose*, using the :oe:meth:`OEDocking::OEScore::ScoreLigand`
   method of *score*, to SD data of *pose* with the given *sdtag*.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetSDScore(OEChem::OEMCMolBase& poses, OEDock& dock,
                           std::string sdtag, bool sortPoses = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetSDScore(ligand: OEMol, scoreFxn: OEDock, tag: str,
                      sortPoses: bool = False) -> bool
         OESetSDScore(ligand: OEMol, scoreFxn: OEPosit, tag: str,
                      sortPoses: bool = False) -> bool

   Assigns the score of each pose of *poses*, using the 
   :oe:meth:`OEDocking::OEDock::ScoreLigand` method of *dock*,
   to SD data of the pose with the given *sdtag*.

   If *sortPoses* is true the poses will also be sorted by score.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetSDScore(OEChem::OEMCMolBase& poses, OEScore& score,
                           std::string sdtag, bool sortPoses = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetSDScore(ligand: OEMol, scoreFxn: OEScore, tag: str,
                      sortPoses: bool = False) -> bool
         OESetSDScore(ligand: OEMol, scoreFxn: OEPosit, tag: str,
                      sortPoses: bool = False) -> bool

   Assigns the score of each pose of *poses*, using the 
   :oe:meth:`OEDocking::OEScore::ScoreLigand` method of *score*,
   to SD data of the pose with the given *sdtag*.

   If *sortPoses* is true the poses will also be sorted by score.



.. # split from OEDockingFunctions.rst:1295

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESetSDScoreComponent

.. oe:function:: OESetSDScoreComponent

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetSDScoreComponent(OEChem::OEMolBase& pose, OEDock& dock,
                                    std::string component, std::string sdtag)

   .. oe:language:: python

      .. oe:api:: python

         OESetSDScoreComponent(ligand: Union[OEGraphMol,OEMol,OEQMol],
                               scoreFxn: OEDock, component: str, tag: str) -> bool

   Assigns the *component* of *pose's* score,
   calculated with *dock's* 
   :oe:meth:`OEDocking::OEDock::ScoreLigandComponent` method, to
   *pose's* SD data (with tag *sdtag*).

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetSDScoreComponent(OEChem::OEMolBase& pose, OEScore& score,
                                    std::string component, std::string sdtag)

   .. oe:language:: python

      .. oe:api:: python

         OESetSDScoreComponent(ligand: Union[OEGraphMol,OEMol,OEQMol],
                               scoreFxn: OEScore, component: str, tag: str) -> bool

   Assigns the *component* of *pose's* score,
   calculated with *score's* 
   :oe:meth:`OEDocking::OEScore::ScoreLigandComponent` method, to
   *pose's* SD data (with tag *sdtag*).

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetSDScoreComponent(OEChem::OEMCMolBase& poses, OEDock& dock,
                                    std::string component, std::string sdtag,
                                    bool sortPoses = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetSDScoreComponent(ligand: OEMol, scoreFxn: OEDock, component: str,
                               tag: str, sortPoses: bool = False) -> bool

   Assigns the *component* of the score of each pose of *poses*,
   calculated with *dock's* 
   :oe:meth:`OEDocking::OEDock::ScoreLigandComponent` method, to
   SD data (with tag *sdtag*) on the pose.

   If *sortPoses* is true the poses will also be sorted by score.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetSDScoreComponent(OEChem::OEMCMolBase& ligand,
                                    OEDock& scoreFxn, std::string component,
                                    std::string tag, bool sortPoses = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetSDScoreComponent(ligand: OEMol, scoreFxn: OEScore,
                               component: str, tag: str,
                               sortPoses: bool = False) -> bool

   Assigns the *component* of the score of each pose of *poses*,
   calculated with *score's* 
   :oe:meth:`OEDocking::OEScore::ScoreLigandComponent` method, to
   SD data (with tag *sdtag*) on the pose.

   If *sortPoses* is true the poses will also be sorted by score.



.. # split from OEDockingFunctions.rst:1201

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESetScore

.. oe:function:: OESetScore

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetScore(OEChem::OEMolBase& pose, OEDock& dock, std::string tag)

   .. oe:language:: python

      .. oe:api:: python

         OESetScore(arg1: Union[OEGraphMol,OEMol,OEQMol], scoreFxn: OEDock,
                    tag: str) -> bool

   Assigns the score of *pose*, using the :oe:meth:`OEDocking::OEDock::ScoreLigand`
   method of *dock*, to float generic data of *pose* with the given *tag*.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetScore(OEChem::OEMolBase& pose, OEScore& score,
                         std::string tag)

   .. oe:language:: python

      .. oe:api:: python

         OESetScore(arg1: Union[OEGraphMol,OEMol,OEQMol], scoreFxn: OEScore,
                    tag: str) -> bool

   Assigns the score of *pose*, using the :oe:meth:`OEDocking::OEScore::ScoreLigand`
   method of *score*, to float generic data of *pose* with the given *tag*.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetScore(OEChem::OEMCMolBase& poses, OEDock& dock,
                         std::string tag, bool sortPoses = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetScore(ligand: OEMol, scoreFxn: OEDock, tag: str,
                    sortPoses: bool = False) -> bool

   Assigns the score of each pose of *poses*, using the 
   :oe:meth:`OEDocking::OEDock::ScoreLigand` method of *dock*,
   to float generic data of the pose with the given *tag*.

   If *sortPoses* is true the poses will also be sorted by score.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetScore(OEChem::OEMCMolBase& poses, OEScore& score,
                         std::string tag, bool sortPoses = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetScore(ligand: OEMol, scoreFxn: OEScore, tag: str,
                    sortPoses: bool = False) -> bool

   Assigns the score of each pose of *poses*, using the 
   :oe:meth:`OEDocking::OEScore::ScoreLigand` method of *score*,
   to float generic data of the pose with the given *tag*.

   If *sortPoses* is true the poses will also be sorted by score.



.. # split from OEDockingFunctions.rst:1351

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESetScoreComponent

.. oe:function:: OESetScoreComponent

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetScoreComponent(OEChem::OEMolBase& pose, OEDock& dock,
                                  std::string component, std::string tag)

   .. oe:language:: python

      .. oe:api:: python

         OESetScoreComponent(ligand: Union[OEGraphMol,OEMol,OEQMol],
                             scoreFxn: OEDock, component: str, tag: str) -> bool

   Assigns the *component* of *pose's* score,
   calculated with *dock's* 
   :oe:meth:`OEDocking::OEDock::ScoreLigandComponent` method, to
   *pose's* float generic data (with tag *tag*) on *pose*.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetScoreComponent(OEChem::OEMolBase& pose, OEScore& score,
                                  std::string component, std::string tag)

   .. oe:language:: python

      .. oe:api:: python

         OESetScoreComponent(ligand: Union[OEGraphMol,OEMol,OEQMol],
                             scoreFxn: OEScore, component: str, tag: str) -> bool

   Assigns the *component* of *pose's* score,
   calculated with *score's* 
   :oe:meth:`OEDocking::OEScore::ScoreLigandComponent` method, to
   *pose's* float generic data (with tag *tag*) on *pose*.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetScoreComponent(OEChem::OEMCMolBase& pose, OEDock& dock,
                                  std::string component, std::string tag,
                                  bool sortPoses = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetScoreComponent(ligand: OEMol, scoreFxn: OEDock, component: str,
                             tag: str, sortPoses: bool = False) -> bool

   Assigns the *component* of the score of each pose of *poses*,
   calculated with *dock's* 
   :oe:meth:`OEDocking::OEDock::ScoreLigandComponent` method, to
   float generic data (with tag *tag*) on the pose.

   If *sortPoses* is true the poses will also be sorted by score.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetScoreComponent(OEChem::OEMCMolBase& poses, OEScore& score,
                                  std::string component, std::string tag,
                                  bool sortPoses = false)

   .. oe:language:: python

      .. oe:api:: python

         OESetScoreComponent(ligand: OEMol, scoreFxn: OEScore, component: str,
                             tag: str, sortPoses: bool = False) -> bool

   Assigns the *component* of the score of each pose of *poses*,
   calculated with *score's* 
   :oe:meth:`OEDocking::OEScore::ScoreLigandComponent` method, to
   float generic data (with tag *tag*) on the pose.

   If *sortPoses* is true the poses will also be sorted by score.



.. # split from OEDockingFunctions.rst:138

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESetupBox

..  _OEDocking_OESetupBox:

.. oe:function:: OESetupBox

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupBox(OEBoxBase& box, float* xyz, unsigned int N,
                         bool addbox = 0.0f)

   .. oe:language:: python

      .. oe:api:: python

         OESetupBox(arg1: OEBoxBase, xyz: OEFloatArray, N: int,
                    addbox: bool = 0.0) -> bool

   Sets up *box* to contain the minimum size box that encloses all coordinates in
   the *xyz* array and then extends each box face by *addbox*.

      *box*
         Box to setup

      *xyz*
         Array of coordinates

      *N*
         Number of coordinates in *xyz* array

      *addbox*
         Optional parameter to extend each box face by a specified amount relative
         to the minimum box enclosing the *xyz* coordinates.

   Returns true if setup was successful.
 
   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupBox(OEMath::OEBox& box, const OEChem::OEMolBase& mol,
                         float addbox = 0.0f)

   .. oe:language:: python

      .. oe:api:: python

         OESetupBox(arg1: OEBox, arg2: Union[OEGraphMol,OEQMol],
                    addbox: float = 0.0) -> bool

   Sets up *box* to be the minimum size box that encloses *mol*
   and then extends each box face by *addbox*.

      *box*
         Box to setup

      *mol*
         A molecule the box will be setup around 

      *addbox*
         Optional parameter to extend each box face by a specified amount relative
         to the minimum box enclosing the *mol*.
 
   Returns true if setup was successful.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupBox(OEMath::OEBox& box, const OEChem::OEMCMolBase& mol,
                         float addbox = 0.0f)

   .. oe:language:: python

      .. oe:api:: python

         OESetupBox(arg1: OEBox, arg2: OEMol, addbox: float = 0.0) -> bool

   Sets up *box* to be the minimum size box that encloses all conformers of *mol*
   and then extends each box face by *addbox*.

      *box*
         Box to setup

      *mol*
         A multiconformer molecule the box will be setup around 

      *addbox*
         Optional parameter to extend each box face by a specified amount relative
         to the minimum box enclosing the *mol*.

   Returns true if setup was successful.




.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESetupBoxCenterAndExtents

.. oe:function:: OESetupBoxCenterAndExtents

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupBoxCenterAndExtents(OEBoxBase& box, float* center,
                                         float* extents)

   .. oe:language:: python

      .. oe:api:: python

         OESetupBoxCenterAndExtents(arg1: OEBoxBase, center: OEFloatArray,
                                    extents: OEFloatArray) -> bool

   Sets up *box* using a center coordinate and the dimension of the box.

      *box*
         Box to setup

      *center*
         A length 3 array holds the coordinate of the box center 

      *extends*
         A length 3 array holding the x, y and z dimensions of the box.

   Returns true if setup was successful.



.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESetupBox

.. oe:function:: OESetupBox

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupBox(OEMath::OEBox&, const OEChem::OEMolBase&,
                         float addbox = 0.0f)

   .. oe:language:: python

      .. oe:api:: python

         OESetupBox(arg1: OEBox, arg2: Union[OEGraphMol,OEQMol],
                    addbox: float = 0.0) -> bool

   This function sets up the minimum box size that encloses the passed-in molecule, 
   with an option to extend each box face by a specified value *addbox*.
 
   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupBox(OEMath::OEBox&, const OEChem::OEMCMolBase&,
                         float addbox = 0.0f)

   .. oe:language:: python

      .. oe:api:: python

         OESetupBox(arg1: OEBox, arg2: OEMol, addbox: float = 0.0) -> bool

   This function sets up the minimum box size that encloses all conformers of the 
   input molecules, with an option to extend each box face by a specified value *addbox*.


.. # split from OEDockingFunctions.rst:1419

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESphereArea

.. oe:function:: OESphereArea

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OESphereArea(const OESphereBase& sph)

   .. oe:language:: python

      .. oe:api:: python

         OESphereArea(sph: OESphereBase) -> float



.. # split from OEDockingFunctions.rst:1413

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESphereVolume

.. oe:function:: OESphereVolume

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OESphereVolume(const OESphereBase& sph)

   .. oe:language:: python

      .. oe:api:: python

         OESphereVolume(sph: OESphereBase) -> float



.. # split from OEDockingFunctions.rst:1062

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEWriteReceptorFile

.. oe:function:: OEWriteReceptorFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteReceptorFile(const OEChem::OEMolBase& receptor,
                                  std::string filename)
         bool OEWriteReceptorFile(OEChem::OEMolBase& receptor,
                                  std::string filename)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteReceptorFile(receptor: Union[OEGraphMol,OEMol,OEQMol],
                             filename: str) -> bool

   Writes a *receptor* to file *filename* 

   Returns true if successful.

   .. note::
      
      All receptor files must be in either .oeb or .oeb.gz format.




.. oe:language:: c++

   .. oe:namespace:: OEDocking

   .. meta::
      :keywords: OEWriteReceptorToString

   .. oe:function:: OEWriteReceptorToString

      .. oe:api:: c++

         std::string OEWriteReceptorToString(const std::string& format,
                                             const OEMolBase& mol)
         std::string OEWriteReceptorToString(const std::string& format,
                                             OEMolBase& mol)

         std::string OEWriteReceptorToString(unsigned int format,
                                             unsigned int flavor, bool gzip,
                                             const OEMolBase& mol)
         std::string OEWriteReceptorToString(unsigned int format,
                                             unsigned int flavor, bool gzip,
                                             OEMolBase& mol)

.. oe:language:: java

   .. oe:namespace:: OEDocking

   .. meta::
      :keywords: OEWriteReceptorToString, OEWriteReceptorToByteArray

   .. oe:function:: OEWriteReceptorToByteArray

      .. oe:api:: java

         byte[] OEWriteReceptorToByteArray(String format, OEMolBase mol)
         byte[] OEWriteReceptorToByteArray(int format, int flavor,
                                           boolean gzip, OEMolBase mol)

.. oe:language:: python

   .. oe:namespace:: OEDocking

   .. meta::
      :keywords: OEWriteReceptorToString, OEWriteReceptorToBytes

   .. oe:function:: OEWriteReceptorToBytes

      .. oe:api:: python

         OEWriteReceptorToBytes(format, oemol) -> bytes
         OEWriteReceptorToBytes(format, flavor, gzip, oemol) -> bytes

.. oe:language:: csharp

   .. oe:namespace:: OEDocking

   .. meta::
      :keywords: OEWriteReceptorToString, OEWriteReceptorToBytes

   .. oe:function:: OEWriteReceptorToBytes

      .. oe:api:: csharp

         byte[] OEWriteReceptorToBytes(String format, OEMolBase mol)
         byte[] OEWriteReceptorToBytes(int format, int flavor, boolean gzip,
                                       OEMolBase mol)

.. oe:language:: c++ python java csharp

   Encodes a receptor in terms of 'format'. 'format' must be a file extension
   that is writeable by OpenEye, for example: ".oeb.gz". Overloads which take
   an unsigned 'format', unsigned 'flavor' and Boolean 'gzip' parameters expect
   the format and flavor to be specified by one of the constants
   in :oe:constns:`OEChem::OEFormat` and :oe:constns:`OEChem::OEOFlavor`.

.. oe:language:: c++

   Returns a non-empty std::string if the molecule to encode is identified as a receptor and encoding was successful.

.. oe:language:: java csharp

   Returns a non-empty byte[] if the molecule to encode is identified as a receptor and encoding was successful.

.. oe:language:: python

   Returns bytes if the molecule to encode is identified as a receptor and encoding was successful, otherwise, ''None''.

.. oe:language:: c++

   .. oe:source:: ReceptorIO.cpp
      :language: c++
      :frag:     SNIPPET-RECEPTOR-IO-3
      :noindent:

   .. oe:source:: ReceptorIO.cpp
      :language: c++
      :frag:     SNIPPET-RECEPTOR-IO-4
      :noindent:

   ..
      .. oe:source:: ReceptorIO.cpp
         :language: c++
         :frag:     SNIPPET-RECEPTOR-IO-5
         :noindent:

      .. oe:source:: ReceptorIO.cpp
         :language: c++
         :frag:     SNIPPET-RECEPTOR-IO-6
         :noindent:

   .. oe:source:: ReceptorIO.cpp
      :language: c++
      :frag:     SNIPPET-RECEPTOR-IO-7
      :noindent:

   .. oe:source:: ReceptorIO.cpp
      :language: c++
      :frag:     SNIPPET-RECEPTOR-IO-8
      :noindent:

   ..
      .. oe:source:: ReceptorIO.cpp
         :language: c++
         :frag:     SNIPPET-RECEPTOR-IO-9
         :noindent:

      .. oe:source:: ReceptorIO.cpp
         :language: c++
         :frag:     SNIPPET-RECEPTOR-IO-10
         :noindent:

.. oe:language:: python

   .. oe:source:: ReceptorIO.py
      :language: python
      :frag:     SNIPPET-RECEPTOR-IO-3
      :noindent:

   .. oe:source:: ReceptorIO.py
      :language: python
      :frag:     SNIPPET-RECEPTOR-IO-4
      :noindent:

   ..
      .. oe:source:: ReceptorIO.py
         :language: python
         :frag:     SNIPPET-RECEPTOR-IO-5
         :noindent:

      .. oe:source:: ReceptorIO.py
         :language: python
         :frag:     SNIPPET-RECEPTOR-IO-6
         :noindent:

   .. oe:source:: ReceptorIO.py
      :language: python
      :frag:     SNIPPET-RECEPTOR-IO-7
      :noindent:

   .. oe:source:: ReceptorIO.py
      :language: python
      :frag:     SNIPPET-RECEPTOR-IO-8
      :noindent:

   ..
      .. oe:source:: ReceptorIO.py
         :language: python
         :frag:     SNIPPET-RECEPTOR-IO-9
         :noindent:

      .. oe:source:: ReceptorIO.py
         :language: python
         :frag:     SNIPPET-RECEPTOR-IO-10
         :noindent:

.. oe:language:: java

   .. oe:source:: ReceptorIO.java
      :language: java
      :frag:     SNIPPET-RECEPTOR-IO-3
      :noindent:

   .. oe:source:: ReceptorIO.java
      :language: java
      :frag:     SNIPPET-RECEPTOR-IO-4
      :noindent:

   ..
      .. oe:source:: ReceptorIO.java
         :language: java
         :frag:     SNIPPET-RECEPTOR-IO-5
         :noindent:

      .. oe:source:: ReceptorIO.java
         :language: java
         :frag:     SNIPPET-RECEPTOR-IO-6
         :noindent:

   .. oe:source:: ReceptorIO.java
      :language: java
      :frag:     SNIPPET-RECEPTOR-IO-7
      :noindent:

   .. oe:source:: ReceptorIO.java
      :language: java
      :frag:     SNIPPET-RECEPTOR-IO-8
      :noindent:

   ..
      .. oe:source:: ReceptorIO.java
         :language: java
         :frag:     SNIPPET-RECEPTOR-IO-9
         :noindent:

      .. oe:source:: ReceptorIO.java
         :language: java
         :frag:     SNIPPET-RECEPTOR-IO-10
         :noindent:

.. oe:language:: csharp

   .. oe:source:: ReceptorIO.cs
      :language: csharp
      :frag:     SNIPPET-RECEPTOR-IO-3
      :noindent:

   .. oe:source:: ReceptorIO.cs
      :language: csharp
      :frag:     SNIPPET-RECEPTOR-IO-4
      :noindent:

   ..
      .. oe:source:: ReceptorIO.cs
         :language: csharp
         :frag:     SNIPPET-RECEPTOR-IO-5
         :noindent:

      .. oe:source:: ReceptorIO.cs
         :language: csharp
         :frag:     SNIPPET-RECEPTOR-IO-6
         :noindent:

   .. oe:source:: ReceptorIO.cs
      :language: csharp
      :frag:     SNIPPET-RECEPTOR-IO-7
      :noindent:

   .. oe:source:: ReceptorIO.cs
      :language: csharp
      :frag:     SNIPPET-RECEPTOR-IO-8
      :noindent:

   ..
      .. oe:source:: ReceptorIO.cs
         :language: csharp
         :frag:     SNIPPET-RECEPTOR-IO-9
         :noindent:

      .. oe:source:: ReceptorIO.cs
         :language: csharp
         :frag:     SNIPPET-RECEPTOR-IO-10
         :noindent:



*******************************************************************************
OEDocking Functions
*******************************************************************************

.. _section_receptor_api:

.. toctree::
   :maxdepth: 1

   OEAddDockingInteractions.rst
   OECreateDUFromReceptorMol.rst
   OEDockingGetArch.rst
   OEDockingGetLicense.rst
   OEDockingGetPlatform.rst
   OEDockingGetRelease.rst
   OEDockingGetSite.rst
   OEDockingGetVersion.rst
   OEDockingReturnCodeGetName.rst
   OEDockMethodConfigure
   OEDockMethodGetName.rst
   OEDockMethodGetValue.rst
   OEGetEstimatedPositProbability.rst
   OEGetPositMethod.rst
   OEHasClash.rst
   OEMakeBoxMolecule.rst
   OEMakeReceptor.rst
   OENegativeImageTypeGetName.rst
   OENegativeImageTypeGetValue.rst
   OEPositMethodGetName.rst
   OEScoreTypeGetName.rst
   OEScoreTypeGetValue.rst
   OESearchResolutionGetName.rst
   OESearchResolutionGetValue.rst
   OESetEnergyScore.rst
   OESetEnergyScoreComponent.rst
   OESetSDScore.rst
   OESetSDScoreComponent.rst
   OESetScore.rst
   OESetScoreComponent.rst
   OESetupBoxMol.rst


********************************
OEDocking Functions (Deprecated)
********************************

.. _section_receptor_api:

.. toctree::
   :maxdepth: 1

   OEAlignReceptors.rst
   OEBoxArea.rst
   OEBoxExtend.rst
   OEBoxTranslate.rst
   OEBoxVolume.rst
   OEBoxXDim.rst
   OEBoxXMid.rst
   OEBoxYDim.rst
   OEBoxYMid.rst
   OEBoxZDim.rst
   OEBoxZMid.rst
   OEInBox.rst
   OEInSphere.rst
   OEIsReceptor.rst
   OEMakeReceptorDeprecated.rst
   OENegativeImageTypeConfigure.rst
   OEReadReceptorFile.rst
   OEReadReceptorFromString.rst
   OEReceptorAddCachedScore.rst
   OEReceptorAddExtraMol.rst
   OEReceptorClear.rst
   OEReceptorClearBoundLigand.rst
   OEReceptorClearCachedScore.rst
   OEReceptorClearCustomConstraints.rst
   OEReceptorClearExtraMols.rst
   OEReceptorClearProteinConstraint.rst
   OEReceptorClearProteinConstraints.rst
   OEReceptorGetBoundLigand.rst
   OEReceptorGetCustomConstraints.rst
   OEReceptorGetExtraMols.rst
   OEReceptorGetInnerContourLevel.rst
   OEReceptorGetNegativeImageGrid.rst
   OEReceptorGetOuterContourLevel.rst
   OEReceptorGetProteinConstraints.rst
   OEReceptorHasBoundLigand.rst
   OEReceptorHasCachedScore.rst
   OEReceptorHasCustomConstraints.rst
   OEReceptorHasExtraMols.rst
   OEReceptorHasInnerContourLevel.rst
   OEReceptorHasNegativeImageGrid.rst
   OEReceptorHasOuterContourLevel.rst
   OEReceptorHasProteinConstraints.rst
   OEReceptorSetBoundLigand.rst
   OEReceptorSetCachedScore.rst
   OEReceptorSetCustomConstraints.rst
   OEReceptorSetInnerContourLevel.rst
   OEReceptorSetOuterContourLevel.rst
   OEReceptorSetProteinConstraint.rst
   OEScoreTypeConfigure.rst
   OESearchResolutionConfigure.rst
   OESetupBox.rst
   OESetupBoxCenterAandExtents.rst
   OESphereArea.rst
   OESphereVolume.rst
   OEWriteReceptorFile.rst
   OEWriteReceptorToString.rst


.. _OEModelsClasses:

*****************************
Preliminary OEModels Classes
*****************************

.. oe:namespace:: OEModels

.. toctree::

   OEROCSQueryModelBuilder
   OEROCSQueryModelOptions


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEModels

.. meta::
   :keywords: OEROCSQueryModelBuilder, ROCSQueryModelBuilder

.. _OEModels_OEROCSQueryModelBuilder:

.. oe:class:: OEROCSQueryModelBuilder

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEROCSQueryModelBuilder
      
   The :ref:`OEROCSQueryModelBuilder <OEModels_OEROCSQueryModelBuilder>` is used to build models of
   :ref:`OEShapeQuery <OEShape_OEShapeQuery>` that can be used as reference systems for
   **ROCS**, :ref:`OEROCS <OEShape_OEROCS>`, :ref:`OEOverlay <OEShape_OEOverlay>`,
   and other similar functions.

   The :ref:`OEROCSQueryModelBuilder <OEModels_OEROCSQueryModelBuilder>` can be used for building a query
   from known ligands in their binding modes. The input ligands should be prepared by 
   aligning the protein crystal structures. The prepared :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
   structures can be used directly, or the ligands can be extracted and used, as input
   to the query model builder. The query model builder constructs a ROCS query employing 
   a few of the ligands that are most representative of the set as a whole.

   The :ref:`OEROCSQueryModelBuilder <OEModels_OEROCSQueryModelBuilder>` class defines the following public methods:
    * :oe:meth:`AddLigand<OEModels::OEROCSQueryModelBuilder::AddLigand>`
    * :oe:meth:`Build<OEModels::OEROCSQueryModelBuilder::Build>`
    * :oe:meth:`ClearLigands<OEModels::OEROCSQueryModelBuilder::ClearLigands>`
    * :oe:meth:`GetROCSQueryModelOptions<OEModels::OEROCSQueryModelBuilder::GetROCSQueryModelOptions>`
    * :oe:meth:`SetLigands<OEModels::OEROCSQueryModelBuilder::SetLigands>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEROCSQueryModelBuilder(const OEROCSQueryModelOptions& options = OEROCSQueryModelOptions())
            OEROCSQueryModelBuilder(const OEROCSQueryModelBuilder&)

      .. oe:language:: python

         .. oe:api:: python

            OEROCSQueryModelBuilder(options: OEROCSQueryModelOptions = OEROCSQueryModelOptions()) -> OEROCSQueryModelBuilder
            OEROCSQueryModelBuilder(arg2: OEROCSQueryModelBuilder) -> OEROCSQueryModelBuilder

      Constructors.

      *options*
         Options for the model builder. Default options are used if not provided.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEROCSQueryModelBuilder &operator=(const OEROCSQueryModelBuilder &)

      Assignment operator.

   .. oe:method:: AddLigand

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddLigand(const OEBio::OEDesignUnit& du)
            bool AddLigand(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            AddLigand(du: OEDesignUnit) -> bool
            AddLigand(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Adds the specified ligand to the set of ligands from which the query model(s) would be build.
      The first overload of the method adds the bound ligand from the design unit. Method returns ``True``
      if a ligand is added successfully.

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEShape::OEShapeQuery>* Build(OESystem::OETracerBase* tracer = &OESystem::NullTracer)

      .. oe:language:: python

         .. oe:api:: python

            Build(tracer: OETracerBase = &NullTracer) -> Iterable[OEShapeQuery]

      Build the query model(s). Method returns an iterator over the generated :ref:`OEShapeQuery <OEShape_OEShapeQuery>`.

   .. oe:method:: ClearLigands

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ClearLigands()

      .. oe:language:: python

         .. oe:api:: python

            ClearLigands() -> bool

      Clears set of ligands from which the query model(s) would be build. Method returns ``True``
      if all the ligands are removed successfully.

   .. oe:method:: GetROCSQueryModelOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEROCSQueryModelOptions& GetROCSQueryModelOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetROCSQueryModelOptions() -> OEROCSQueryModelOptions

      Get the :ref:`OEROCSQueryModelOptions <OEModels_OEROCSQueryModelOptions>` associated with this builder.

   .. oe:method:: SetLigands

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLigands(OEChem::oemolistream& ifs)
            bool SetLigands(OEPlatform::oeistream& ifs)

      .. oe:language:: python

         .. oe:api:: python

            SetLigands(ifs: oemolistream) -> bool
            SetLigands(ifs: oeistream) -> bool

      Sets the ligands from which the query model(s) would be build. Calling this method would
      clear any existing ligand that were previously added. The first overload adds all the 
      :ref:`OEMolBase <OEChem_OEMolBase>` from the specified :ref:`oemolistream <OEChem_oemolistream>`, and the
      second overload adds the bound ligands from all the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` of the
      specified :ref:`oeistream <OEPlatform_oeistream>`. Method returns ``True``
      if ligands are added successfully.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEModels

.. meta::
   :keywords: OEROCSQueryModelOptions, ROCSQueryModelOptions

.. _OEModels_OEROCSQueryModelOptions:

.. oe:class:: OEROCSQueryModelOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEROCSQueryModelOptions : public OESystem::OEOptions
      
   This class provides an interface to setup options required for building
   a **ROCS** query model using *OEROCSQueryModelBuilder*.

   The :ref:`OEROCSQueryModelOptions <OEModels_OEROCSQueryModelOptions>` class defines the following public methods:
    * :oe:meth:`GetColorForceField<OEModels::OEROCSQueryModelOptions::GetColorForceField>` and
      :oe:meth:`SetColorForceField<OEModels::OEROCSQueryModelOptions::SetColorForceField>`
    * :oe:meth:`GetMergeColorAtoms<OEModels::OEROCSQueryModelOptions::GetMergeColorAtoms>` and
      :oe:meth:`SetMergeColorAtoms<OEModels::OEROCSQueryModelOptions::SetMergeColorAtoms>`
    * :oe:meth:`GetMaxMoleculesPerModel<OEModels::OEROCSQueryModelOptions::GetMaxMoleculesPerModel>` and
      :oe:meth:`SetMaxMoleculesPerModel<OEModels::OEROCSQueryModelOptions::SetMaxMoleculesPerModel>`
    * :oe:meth:`GetNumModels<OEModels::OEROCSQueryModelOptions::GetNumModels>` and
      :oe:meth:`SetNumModels<OEModels::OEROCSQueryModelOptions::SetNumModels>`
    * :oe:meth:`CreateCopy<OEModels::OEROCSQueryModelOptions::CreateCopy>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEROCSQueryModelOptions()
            OEROCSQueryModelOptions(const OEROCSQueryModelOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEROCSQueryModelOptions() -> OEROCSQueryModelOptions
            OEROCSQueryModelOptions(arg2: OEROCSQueryModelOptions) -> OEROCSQueryModelOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEROCSQueryModelOptions &operator=(const OEROCSQueryModelOptions &)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEROCSQueryModelOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEROCSQueryModelOptions

      Creates and returns a deep copy of this object.

   .. oe:method:: GetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEColorForceField* GetColorForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceField() -> OEColorForceField

      See :oe:meth:`SetColorForceField<OEModels::OEROCSQueryModelOptions::SetColorForceField>` method.

   .. oe:method:: GetMergeColorAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMergeColorAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMergeColorAtoms() -> bool

      See :oe:meth:`SetMergeColorAtoms<OEModels::OEROCSQueryModelOptions::SetMergeColorAtoms>` method.

   .. oe:method:: GetMaxMoleculesPerModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxMoleculesPerModel() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMoleculesPerModel() -> int

      See :oe:meth:`SetMaxMoleculesPerModel<OEModels::OEROCSQueryModelOptions::SetMaxMoleculesPerModel>` method.

   .. oe:method:: GetNumModels

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetNumModels() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumModels() -> int

      See :oe:meth:`SetNumModels<OEModels::OEROCSQueryModelOptions::SetNumModels>` method.

   .. oe:method:: SetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorForceField(unsigned int type)
            bool SetColorForceField(OEPlatform::oeistream& is)
            bool SetColorForceField(const std::string& filename)
            bool SetColorForceField(const OEColorForceField& cff)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceField(value: int) -> bool
            SetColorForceField(value: oeistream) -> bool
            SetColorForceField(value: str) -> bool
            SetColorForceField(value: OEColorForceField) -> bool

      Sets the color force field to be used. By default the ImplicitMillsDean
      color force field is used.

   .. oe:method:: SetMergeColorAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMergeColorAtoms(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetMergeColorAtoms(value: bool) -> bool

      Sets **flag** if color atoms should be merged if applicable.
      **Default: True**

   .. oe:method:: SetMaxMoleculesPerModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxMoleculesPerModel(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxMoleculesPerModel(value: int) -> bool

      Sets the **maximum number of molecules** to be combined in creating a single query.
      **Default: 3**

   .. oe:method:: SetNumModels

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNumModels(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetNumModels(value: int) -> bool

      Sets the **maximum number query model** to be returned from modeling building.
      **Default: 1**


====
API
====

.. _oedocking_part_api:

********************************
OEDocking API
********************************

.. toctree::
   :maxdepth: 2

   OEDockingClasses/OEDockingClasses
   OEDockingConstants/OEDockingConstants
   OEDockingFunctions/index

********************************
Preliminary OEDocking API
********************************

.. toctree::
   :maxdepth: 2

   OEDockingClasses/OEDockingClasses_pre

********************************
Deprecated OEDocking API
********************************

.. toctree::
   :maxdepth: 2

   OEDockingClasses/OEDockingDeprecatedClasses
   OEDockingFunctions/indexDeprecated

********************************
OEModels API
********************************

.. toctree::
   :maxdepth: 2
   
   OEModelsClasses/OEModelsClasses


.. _chapter_dockingexamples:
.. _oedocking_part_examples:

********************************************************************************
OEDocking Examples
********************************************************************************

The following table lists the currently available **OEDocking TK** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`docking<section_examples_docking>`
        - docking molecules

      * - :ref:`rescoring<section_examples_scoring>`
        - rescore docked molecules

      * - :ref:`shapefit<section_examples_shapefit>`
        - flexible fitting with OEShapeFit

      * - :ref:`posing<section_examples_posing>`
        - generating poses

      * - :ref:`posing_multi<section_examples_posing_multi>`
        - posing with multiple receptors

      * - :ref:`make_receptor<section_examples_make_receptor>`
        - making a receptor

      * - :ref:`contour_volume<section_examples_contour_volume>`
        - receptor contour volume

      * - :ref:`inner_contour<section_examples_inner_contour>`
        - toggle inner contour

      * - :ref:`outer_contour<section_examples_outer_contour>`
        - set outer contour

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`docking<section_examples_docking>`
        - Docking molecules.

      * - :ref:`rescoring<section_examples_scoring>`
        - Rescore docked molecules.

      * - :ref:`shapefit<section_examples_shapefit>`
        - Flexible fitting with OEShapeFit.

      * - :ref:`posing<section_examples_posing>`
        - Generating poses.

      * - :ref:`posing_multi<section_examples_posing_multi>`
        - Posing with multiple receptors.

      * - :ref:`make_receptor<section_examples_make_receptor>`
        - Making a receptor.

      * - :ref:`contour_volume<section_examples_contour_volume>`
        - Receptor contour volume.

      * - :ref:`inner_contour<section_examples_inner_contour>`
        - Toggle inner contour.

      * - :ref:`outer_contour<section_examples_outer_contour>`
        - Set outer contour.

.. oe:language:: java

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`docking<section_examples_docking>`
        - docking molecules

      * - :ref:`rescoring<section_examples_scoring>`
        - rescore docked molecules

      * - :ref:`posing<section_examples_posing>`
        - generating poses

      * - :ref:`posing_multi<section_examples_posing_multi>`
        - posing with multiple receptors

      * - :ref:`make_receptor<section_examples_make_receptor>`
        - making a receptor

      * - :ref:`contour_volume<section_examples_contour_volume>`
        - receptor contour volume

      * - :ref:`inner_contour<section_examples_inner_contour>`
        - toggle inner contour

      * - :ref:`outer_contour<section_examples_outer_contour>`
        - set outer contour

.. oe:language:: csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`docking<section_examples_docking>`
        - docking molecules

      * - :ref:`rescoring<section_examples_scoring>`
        - rescore docked molecules

      * - :ref:`posing<section_examples_posing>`
        - generating poses

      * - :ref:`posing_multi<section_examples_posing_multi>`
        - posing with multiple receptors

      * - :ref:`make_receptor<section_examples_make_receptor>`
        - making a receptor

      * - :ref:`contour_volume<section_examples_contour_volume>`
        - receptor contour volume

      * - :ref:`inner_contour<section_examples_inner_contour>`
        - toggle inner contour

      * - :ref:`outer_contour<section_examples_outer_contour>`
        - set outer contour

Docking and Scoring Examples
================================================================================

.. _section_examples_docking:

Docking Molecules
--------------------------------------------------------------------------------

The following code example shows how to perform docking using
the :ref:`OEDock <OEDocking_OEDock>` object.

.. seealso::

   * :ref:`OEDockOptions <OEDocking_OEDockOptions>` class
   * :ref:`OEDock <OEDocking_OEDock>` class
   * :ref:`OEHybrid <OEDocking_OEHybrid>` class

.. oe:source:: DockMolecules.cpp
   :language: c++
   :caption:  Docking Molecules
   :refnum:   1

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`DockMolecules.cpp <../../../../sublibs/tklibs/docking/examples/DockMolecules.cpp>`

.. oe:source:: DockMolecules.py
   :language: python
   :caption:  Docking Molecules
   :refnum:   1

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`DockMolecules.py <../../../../wrappers/python/examples/docking/DockMolecules.py>`

.. oe:source:: DockMolecules.java
   :language: java
   :caption:  Docking Molecules
   :refnum:   1

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`DockMolecules.java <../../../../wrappers/java/examples/openeye/examples/oedocking/DockMolecules.java>`

.. oe:source:: DockMolecules.cs
   :language: csharp
   :caption:  Docking Molecules
   :refnum:   1

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`DockMolecules.cs <../../../../wrappers/csharp/Csharp-Examples/OEDocking/DockMolecules.cs>`

.. _section_examples_scoring:

Rescoring Docked Molecules
--------------------------------------------------------------------------------

The following code example shows how to rescore previously docked molecules,
using the :ref:`OEScore <OEDocking_OEScore>` object.

.. seealso::

   * :ref:`OEScore <OEDocking_OEScore>` class

.. oe:source:: RescorePoses.cpp
   :language: c++
   :caption:  Rescoring Docked Molecules
   :refnum:   2

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RescorePoses.cpp <../../../../sublibs/tklibs/docking/examples/RescorePoses.cpp>`

.. oe:source:: RescorePoses.py
   :language: python
   :caption:  Rescoring Docked Molecules
   :refnum:   2

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RescorePoses.py <../../../../wrappers/python/examples/docking/RescorePoses.py>`

.. oe:source:: RescorePoses.java
   :language: java
   :caption:  Rescoring Docked Molecules
   :refnum:   2

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RescorePoses.java <../../../../wrappers/java/examples/openeye/examples/oedocking/RescorePoses.java>`

.. oe:source:: RescorePoses.cs
   :language: csharp
   :caption:  Rescoring Docked Molecules
   :refnum:   2

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RescorePoses.cs <../../../../wrappers/csharp/Csharp-Examples/OEDocking/RescorePoses.cs>`

OEShapeFit Examples
================================================================================

.. _section_examples_shapefit:

Flexible Overlay Optimization with OEShapeFit API
--------------------------------------------------------------------------------

The following code example shows how to flexibly fit input multi conformer 
molecules in the design unit that contains bound ligand and get the score using
the :oe:cls:`OEDocking::OEShapeFit` and :oe:cls:`OEDocking::OEShapeFitResults` 
objects.

.. seealso::

   * :oe:cls:`OEShape::OEFlexiOverlapFunc` class
   * :oe:cls:`OEShape::OEFlexiOverlayOptions` class

.. oe:source:: ShapeFit.cpp
   :language: c++
   :caption:  Flexible fitting with OEShapeFit
   :refnum:   3

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeFit.cpp <../../../../sublibs/tklibs/docking/examples/ShapeFit.cpp>`

.. oe:source:: ShapeFit.py
   :language: python
   :caption:  Flexible fitting with OEShapeFit
   :refnum:   3

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeFit.py <../../../../wrappers/python/examples/docking/ShapeFit.py>`

**POSIT** Examples
================================================================================

.. _section_examples_posing:

Generating Poses with **POSIT**
--------------------------------------------------------------------------------

The following code example shows how to generate a single pose for each input ligand using
the :ref:`OEPosit <OEDocking_OEPosit>` object.

.. seealso::

   * :ref:`OEPositOptions <OEDocking_OEPositOptions>` class
   * :ref:`OEPosit <OEDocking_OEPosit>` class

.. oe:source:: PoseMolecules.cpp
   :language: c++
   :caption:  Generating Poses with POSIT
   :refnum:   4

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`PoseMolecules.cpp <../../../../sublibs/tklibs/docking/examples/PoseMolecules.cpp>`

.. oe:source:: PoseMolecules.py
   :language: python
   :caption:  Generating Poses with POSIT
   :refnum:   4

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`PoseMolecules.py <../../../../wrappers/python/examples/docking/PoseMolecules.py>`

.. oe:source:: PoseMolecules.java
   :language: java
   :caption:  Generating Poses with POSIT
   :refnum:   4

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`PoseMolecules.java <../../../../wrappers/java/examples/openeye/examples/oedocking/PoseMolecules.java>`

.. oe:source:: PoseMolecules.cs
   :language: csharp
   :caption:  Generating Poses with POSIT
   :refnum:   4

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`PoseMolecules.cs <../../../../wrappers/csharp/Csharp-Examples/OEDocking/PoseMolecules.cs>`

.. _section_examples_posing_multi:

Generating Multiple Poses with POSIT
--------------------------------------------------------------------------------

The following code example shows how to generate multiple poses for each input 
ligand, using the :ref:`OEPosit <OEDocking_OEPosit>` object.

.. seealso::

   * :ref:`OEPositOptions <OEDocking_OEPositOptions>` class
   * :ref:`OEPosit <OEDocking_OEPosit>` class

.. oe:source:: GenerateMultiplePose.cpp
   :language: c++
   :caption:  Posit for Generating Multiple Poses for each Ligand
   :refnum:   5

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`GenerateMultiplePose.cpp <../../../../sublibs/tklibs/docking/examples/GenerateMultiplePose.cpp>`

.. oe:source:: GenerateMultiplePose.py
   :language: python
   :caption:  Posit for Generating Multiple Poses for each Ligand
   :refnum:   5

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`GenerateMultiplePose.py <../../../../wrappers/python/examples/docking/GenerateMultiplePose.py>`

.. oe:source:: GenerateMultiplePose.java
   :language: java
   :caption:  Posit for Generating Multiple Poses for each Ligand
   :refnum:   5

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`GenerateMultiplePose.java <../../../../wrappers/java/examples/openeye/examples/oedocking/GenerateMultiplePose.java>`

.. oe:source:: GenerateMultiplePose.cs
   :language: csharp
   :caption:  Posit for Generating Multiple Poses for each Ligand
   :refnum:   5

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`GenerateMultiplePose.cs <../../../../wrappers/csharp/Csharp-Examples/OEDocking/GenerateMultiplePose.cs>`

Receptor Examples
================================================================================

.. _section_examples_make_receptor:

Making a Receptor
--------------------------------------------------------------------------------

The following code example shows how to make a receptor.

.. seealso::

   * :ref:`OEMakeReceptorOptions <OEDocking_OEMakeReceptorOptions>` class
   * :oe:func:`OEDocking::OEMakeReceptor` method

.. oe:source:: MakeReceptor.cpp
   :language: c++
   :caption:  Making a Receptor
   :refnum:   6

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeReceptor.cpp <../../../../sublibs/tklibs/docking/examples/MakeReceptor.cpp>`

.. oe:source:: MakeReceptor.py
   :language: python
   :caption:  Making a Receptor
   :refnum:   6

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeReceptor.py <../../../../wrappers/python/examples/docking/MakeReceptor.py>`

.. oe:source:: MakeReceptor.java
   :language: java
   :caption:  Making a Receptor
   :refnum:   6

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeReceptor.java <../../../../wrappers/java/examples/openeye/examples/oedocking/MakeReceptor.java>`

.. oe:source:: MakeReceptor.cs
   :language: csharp
   :caption:  Making a Receptor
   :refnum:   6

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeReceptor.cs <../../../../wrappers/csharp/Csharp-Examples/OEDocking/MakeReceptor.cs>`

.. _section_examples_contour_volume:

Receptor Contour Volume
--------------------------------------------------------------------------------

The following code example shows how to estimate a receptor
outer contour volume.

.. seealso::

   * :ref:`OEReceptor <OEBio_OEReceptor>` class
   * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class

.. oe:source:: ReceptorOuterContourVolume.cpp
   :language: c++
   :caption:  Receptor Contour Volume
   :refnum:   7

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ReceptorOuterContourVolume.cpp <../../../../sublibs/tklibs/docking/examples/ReceptorOuterContourVolume.cpp>`

.. oe:source:: ReceptorOuterContourVolume.py
   :language: python
   :caption:  Receptor Contour Volume
   :refnum:   7

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ReceptorOuterContourVolume.py <../../../../wrappers/python/examples/docking/ReceptorOuterContourVolume.py>`

.. oe:source:: ReceptorOuterContourVolume.java
   :language: java
   :caption:  Receptor Contour Volume
   :refnum:   7

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ReceptorOuterContourVolume.java <../../../../wrappers/java/examples/openeye/examples/oedocking/ReceptorOuterContourVolume.java>`

.. oe:source:: ReceptorOuterContourVolume.cs
   :language: csharp
   :caption:  Receptor Contour Volume
   :refnum:   7

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ReceptorOuterContourVolume.cs <../../../../wrappers/csharp/Csharp-Examples/OEDocking/ReceptorOuterContourVolume.cs>`

.. _section_examples_inner_contour:

Toggle Receptor Inner Contour
--------------------------------------------------------------------------------

The following code example shows how to toggle receptor contour volume.

.. seealso::

   * * :ref:`OEReceptor <OEBio_OEReceptor>` class
   * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class

.. oe:source:: ToggleInnerContour.cpp
   :language: c++
   :caption:  Toggle Receptor Inner Contour
   :refnum:   8

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ToggleInnerContour.cpp <../../../../sublibs/tklibs/docking/examples/ToggleInnerContour.cpp>`

.. oe:source:: ToggleInnerContour.py
   :language: python
   :caption:  Toggle Receptor Inner Contour
   :refnum:   8

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ToggleInnerContour.py <../../../../wrappers/python/examples/docking/ToggleInnerContour.py>`

.. oe:source:: ToggleInnerContour.java
   :language: java
   :caption:  Toggle Receptor Inner Contour
   :refnum:   8

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ToggleInnerContour.java <../../../../wrappers/java/examples/openeye/examples/oedocking/ToggleInnerContour.java>`

.. oe:source:: ToggleInnerContour.cs
   :language: csharp
   :caption:  Toggle Receptor Inner Contour
   :refnum:   8

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ToggleInnerContour.cs <../../../../wrappers/csharp/Csharp-Examples/OEDocking/ToggleInnerContour.cs>`

.. _section_examples_outer_contour:

Set Receptor Contour Volume
--------------------------------------------------------------------------------

The following code example shows how to change the receptor outer contour volume.

.. seealso::

   * * :ref:`OEReceptor <OEBio_OEReceptor>` class
   * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class

.. oe:source:: SetOuterContourVolume.cpp
   :language: c++
   :caption:  Set Receptor Contour Volume
   :refnum:   9

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SetOuterContourVolume.cpp <../../../../sublibs/tklibs/docking/examples/SetOuterContourVolume.cpp>`

.. oe:source:: SetOuterContourVolume.py
   :language: python
   :caption:  Set Receptor Contour Volume
   :refnum:   9

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SetOuterContourVolume.py <../../../../wrappers/python/examples/docking/SetOuterContourVolume.py>`

.. oe:source:: SetOuterContourVolume.java
   :language: java
   :caption:  Set Receptor Contour Volume
   :refnum:   9

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SetOuterContourVolume.java <../../../../wrappers/java/examples/openeye/examples/oedocking/SetOuterContourVolume.java>`

.. oe:source:: SetOuterContourVolume.cs
   :language: csharp
   :caption:  Set Receptor Contour Volume
   :refnum:   9

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SetOuterContourVolume.cs <../../../../wrappers/csharp/Csharp-Examples/OEDocking/SetOuterContourVolume.cs>`


.. _chapter_oemodelsexamples:

********************************************************************************
OEModels Examples
********************************************************************************

The following table lists the currently available **OEModels** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`docking<section_examples_rocs_query_model>`
        - Building ROCS Query Model

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`docking<section_examples_rocs_query_model>`
        - Building ROCS Query Model

.. _section_examples_rocs_query_model:

Building ROCS Query Model
--------------------------------------------------------------------------------

The following code example shows how to create a ROCS query
model from a set of known ligands in their binding modes. The
input ligands should be prepared by aligning the protein crystal 
structures.

.. seealso::

   * :ref:`OEROCSQueryModelBuilder <OEModels_OEROCSQueryModelBuilder>` class

.. oe:source:: RocsQueryModelBuilder.cpp
   :language: c++
   :caption:  Building ROCS Query Model
   :refnum:   1

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RocsQueryModelBuilder.cpp <../../../../sublibs/tklibs/docking/examples/RocsQueryModelBuilder.cpp>`

.. oe:source:: RocsQueryModelBuilder.py
   :language: python
   :caption:  Building ROCS Query Model
   :refnum:   1

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`RocsQueryModelBuilder.py <../../../../wrappers/python/examples/docking/RocsQueryModelBuilder.py>`



.. _oedocking_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version4_3_5
   version4_3_4
   version4_3_3
   version4_3_2
   version4_3_1
   version4_3_0
   version4_2_1
   version4_2_0
   version4_1_2
   version4_1_1
   version4_1_0
   version4_0_0
   version3_5_0
   version1_4_1
   version1_4_0
   version1_3_7
   version1_3_6
   version1_3_5
   version1_3_4
   version1_3_3
   version1_3_2
   version1_3_1
   version1_3_0
   version1_2_7
   version1_2_6
   version1_2_5
   version1_2_4
   version1_2_3
   version1_2_2
   version1_2_1
   version1_2_0
   version1_1_4
   version1_1_3
   version1_1_2
   version1_1_1
   version1_1_0
   version1_0_0



OEDocking TK 4.3.5
================================================================================

Minor Bug Fixes
-----------------

* An issue has been fixed that was causing :ref:`OEPosit <OEDocking_OEPosit>`
  to pick the wrong :ref:`method <OEDocking_OEPositMethod>` in posing some
  ligands.


.. _section_dockingtk_releasenotes_100:

OEDocking TK 1.0.0
================================================================================

                                                                                
* Docking features

   * Exhaustive Search docking followed by pose optimization

   * Hybrid docking (uses the structure a known bound active to guide docking)

   * Docking constraints (e.g., require specific hydrogen bonding interactions)

* Scoring features

   * Score optimization (systematic solid body optimization)

   * Break down of score by atom and/or scoring function component

   * Score annotating (stores score breakdown on molecule for visualization in VIDA)
   
* Implementation of four scoring functions 

   * Chemgauss3 

   * Chemscore

   * PLP

   * Shapegauss



.. _section_dockingtk_releasenotes_110:

OEDocking TK 1.1.0 
================================================================================

* The behavior of :oe:const:`OEDocking::OEDockMethod::Hybrid` from version
  1.0 has been changed.  :oe:const:`OEDocking::OEDockMethod::Hybrid` is now an
  alias for the most up to date docking method, currently 
  :oe:const:`OEDocking::OEDockMethod::Hybrid2`.  
  :oe:const:`OEDocking::OEDockMethod::Hybrid1` now provides the same
  functionality that :oe:const:`OEDocking::OEDockMethod::Hybrid` did in
  version 1.0 of *OEDocking TK*.
                                                                                
New Features
--------------------------------------------------------------------------------
* *OEDocking TK* is now thread safe.  For details on thread safety
  see the "Thread Safety" section of the OEChem toolkit.  

* :ref:`Chemgauss4<section_scoring_chemgauss4>` scoring function, available both as a
  docking method (:oe:const:`OEDocking::OEDockMethod::Chemgauss4`) and 
  scoring method (:oe:const:`OEDocking::OEScoreType::Chemgauss4`).

* Hybrid 2 docking method (:oe:const:`OEDocking::OEDockMethod::Hybrid2`), 
  that uses :ref:`Chemgauss4<section_scoring_chemgauss4>` for the structure
  based portion of the docking.

* :ref:`OEHybrid <OEDocking_OEHybrid>` class for doing hybrid docking added for
  convenience.  :ref:`OEHybrid <OEDocking_OEHybrid>` is identical to
  :ref:`OEDock <OEDocking_OEDock>`, except that the default method is
  :oe:const:`OEDocking::OEDockMethod::Hybrid` rather than 
  :oe:const:`OEDocking::OEDockMethod::Chemgauss`.

* Scoring function setup information from :ref:`OEDock <OEDocking_OEDock>`,
  :ref:`OEHybrid <OEDocking_OEHybrid>` and :ref:`OEScore <OEDocking_OEScore>` objects
  can now be saved on receptor files, decreasing the setup time for
  future runs.

* Fixed a bug where OEB handlers were not setup correctly sometimes
  due to link ordering problems. 

Bug fixes
--------------------------------------------------------------------------------

* Fixed bug generating negative image grids, that caused the negative image
  to extend further from the protein and penetrate less deeply into pockets
  than was intended.

* Fixed a bug in the local optimization (done during docking or with a call
  to :oe:meth:`OEDocking::OEScore::SystematicSolidBodyOptimize`) that caused
  the local rotations to be less evenly spaced than they could be.  This bug
  also affected the optimization done by the :ref:`OEDock <OEDocking_OEDock>`
  class.

 



.. _section_dockingtk_releasenotes_111:

OEDocking TK 1.1.1
================================================================================

Bug fixes
--------------------------------------------------------------------------------

* Fixed bug where SD data on the input molecules was not copied to the docked output
  molecule.

* Fixed memory leak when scoring a molecule that does not fit within the receptor
  site.

* Fixed an invalid memory access bug that occurred in rare cases when docking
  molecules.

 



.. _section_dockingtk_releasenotes_112:

OEDocking TK 1.1.2
================================================================================

Bug fixes
--------------------------------------------------------------------------------

* Fixed bug where OEDocking::OEDockBase::DockMultiConformerMolecule
  incorrectly returned :oe:const:`OEDocking::OEDockingReturnCode::Success` in
  cases where no poses of the molecule that fit in the active site could be
  found.  This method now correctly returns 
  :oe:const:`OEDocking::OEDockingReturnCode::NoValidPoses` in this case.

Improvements
--------------------------------------------------------------------------------

* Slightly increased speed of :ref:`Chemgauss4<section_scoring_chemgauss4>` 
  in both docking and optimization.



.. _section_dockingtk_releasenotes_113:

OEDocking TK 1.1.3
================================================================================

Bug fixes
--------------------------------------------------------------------------------

* Fixed a rare one time initialization race condition that could only
  occur when using the *Docking TK* :ref:`OEInterface <OESystem_OEInterface>`
  convenience functions.



.. _section_dockingtk_releasenotes_114:

OEDocking TK 1.1.4
================================================================================

New features
--------------------------------------------------------------------------------

* Hydrogen bond protein constraints now have improved recognition of appropriate
  hydrogen bond geometry. This should result in few false positives (i.e., 
  there should be few docked poses that make poor hydrogen bond interactions with
  the hydrogen bond constraint atom on the protein).

Minor bug fixes
--------------------------------------------------------------------------------

* Fixed a minor bug where the OEDock object could use more memory than 
  needed.

* Fixed a potential out of memory error when calling OEMakeReceptor on a very
  large protein.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _section_dockingtk_releasenotes_120:

OEDocking TK 1.2.0
================================================================================

New features
--------------------------------------------------------------------------------

The POSIT posing algorithm has been integrated into the OEDocking
toolkit. The algorithm uses known bound reference ligands to generate
a probability that, if the query ligand actually binds, the generated
pose is within 2.0 |Angstroms| of the experimentally derived
structure. This probability also guides the selection of the
appropriate receptors (if multiple are provided) for docking as well
as determining which docking methodology to use: SHAPEFIT, HYBRID, or
FRED. Specific details on each methodology can be found in OEDocking's
pose prediction chapter. 



.. _section_dockingtk_releasenotes_121:

OEDocking TK 1.2.1
================================================================================

New Features
--------------------------------------------------------------------------------
 
* OEPosit - When full conformer search is turned off, OMEGA is automatically run 
  when the docked ligand is not a 3D conformer.
  
Major bug fixes
--------------------------------------------------------------------------------

* OEPosit - Fixed a crash when setting full conformer search to false
  and docking a ligand with missing hydrogens.

Minor bug fixes
--------------------------------------------------------------------------------

* Uses of ``OEThrow.Fatal`` changed to ``OEThrow.Error``. 



.. _section_dockingtk_releasenotes_122:

OEDocking TK 1.2.2
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:constns:`OEDocking::OEPositMethod` constants added to select
  which :ref:`OEPosit <OEDocking_OEPosit>` to use at runtime.

* OEDocking::OEPositMethod::SHAPEFIT_EXHAUSTIVE search
  method added for better support of matching substructures of already
  posed ligands in binding sites. This has been accomplished by
  incorporating the Subrocs algorithm for initial starting points.

* :oe:meth:`OEDocking::OEPositOptions::SetIgnoreNitrogenStereo` added to
  allow :ref:`OEPosit <OEDocking_OEPosit>` to ignore nitrogen stereo centers
  in conformer enumeration.

* :ref:`OEPosit <OEDocking_OEPosit>` now annotates clashed molecules.

Major bug fixes
--------------------------------------------------------------------------------

* :ref:`OEPosit <OEDocking_OEPosit>` now retains SD data of the input molecule.

* Debugging information removed from :ref:`OEPosit <OEDocking_OEPosit>` docked molecules.

* :oe:func:`OEDocking::OEGetEstimatedPositProbability` is more robust with
  molecules missing explicit hydrogens.

Minor bug fixes
--------------------------------------------------------------------------------

* Fixed an issue where secondary sp3 hydrogen bonding groups had slightly skewed
  geometry.  In practice this causes the relevant HB angles to be about 15
  degrees off, and the net effect on the score was minimal.

Documentation Changes
--------------------------------------------------------------------------------

* :ref:`OECustomConstraints <OEDocking_OECustomConstraints>` class was improperly
  referred to as ``OECustomConstraint``, without the s, in the
  documentation.

* :oe:const:`OEDocking::OEPositMethod::UNKNOWN` capitalization in the
  documentation was wrong in previous versions.

* :ref:`OEPositOptions <OEDocking_OEPositOptions>` class has been updated with new
  settings: 
  - select the methods :ref:`OEPosit <OEDocking_OEPosit>` will run
  - ignore nitrogen stereo centers when making internal conformations




.. _section_dockingtk_releasenotes_123:

OEDocking TK 1.2.3
================================================================================

New features
--------------------------------------------------------------------------------

The following improvements have been made to :ref:`OEPosit <OEDocking_OEPosit>`:

  * Graph comparison is used to identify
    when default :ref:`OEOmega <OEConfGen_OEOmega>` sampling may not produce
    appropriate conformers. If this is detected, the ShapeFit
    methodology is used to further sample conformation space.

  * The initial overlays for ShapeFit are now chosen with the best TanimotoCombo overlay
    to the bound ligand prior to optimization.

  * The choice of fitting routine (ShapeFit, Hybrid, or FRED) now take
    into account both the TanimotoCombo overlay and the graph similarity
    of the molecule. The graph similarity helps during cases where
    OMEGA undersamples and by sampling more conformations, better overlays can
    be generated.
    
  * When generating conformer ensembles, the maximum number of conformers
    is set to 100 times the number of rotatable bonds with a minimum
    number of 200 conformers. This allows better sampling of floppy
    conformations.
    
  * The maximum MMFF94s induced strain is increased to 20 kCal for molecules
    with more than 12 rotatable bonds.

  * When FRED or HYBRID can not fit a molecule into the receptor, ShapeFit is
    automatically chosen regardless of the expected probability.

  * If the input conformations include 3D coordinates, they are retained 
    even when generating conformations.
    
Major bug fixes
--------------------------------------------------------------------------------

* ``OEDocking::OEPosit::DockMultiConformerMolecule`` would previously only
  generate one pose. Now up to ``numPoses`` poses will be generated.

* SDData is retained from the input molecule. In the case of
  an input conformer ensemble, the SDData is chosen
  from the conformer with the closest RMSD to
  the final optimized pose.

Minor bug fixes
--------------------------------------------------------------------------------

* A GOOD pose has been set to a probability of >= 0.5
  not > 0.5 to be the same as specified by the documentation.

* Removed unbounded stack allocations. 

* Removed annotation of optimization steps when writing to :file:`.oeb` format.

.. oe:language:: c++ python 

   * Rare crash in ShapeFit fixed for C++ and Python toolkits on OSX 10.8 and 10.9.



.. _section_dockingtk_releasenotes_124:

OEDocking TK 1.2.4
================================================================================

* Minor internal improvements. 



.. _section_dockingtk_releasenotes_125:

OEDocking TK 1.2.5
================================================================================

New features
--------------------------------------------------------------------------------

* A new :oe:func:`OEDocking::OEAddDockingInteractions` function 
  works with Grapheme's new active-site rendering functionality
  to perceive all necessary interactions.

Minor bug fixes
--------------------------------------------------------------------------------

* :ref:`OEPosit <OEDocking_OEPosit>` will no longer leak memory.

* An issue with hydrogen bonding groups on the protein being ignored when
  the available volume for an interacting molecule near the hydrogen bond group
  was less than 100 cubic angstroms has been fixed. Previously, the scoring 
  function was set up with a protein and box, rather than a receptor object.

* Internal refactoring has been added to improve stability. 

* A bug in the hydrogen bonding geometry perception of primary planar amines with 
  interaction directions perpendicular to the plane has been fixed. 
  Under this bug, such an interacting group had a 50% chance of selecting the 
  wrong perpendicular direction.


OEDocking TK 1.2.6
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:const:`OEChem::OEFormat::OEB` now supports the reading and writing of receptor
  information on :ref:`OEMCMolBase <OEChem_OEMCMolBase>` conformers. Previously, only
  :ref:`OEMolBase <OEChem_OEMolBase>` receptors
  were supported. The :ref:`receptor APIs<chapter_receptor>` should
  still be used only on the active conformer of multi-conformer
  molecules; see :oe:meth:`OEChem::OEMCMolBase::GetActive`. 

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:const:`OEChem::OEFormat::OEB` will no longer have receptor data
  written to it twice.  This caused the receptor OEBs to be
  approximately twice as large but was otherwise harmless.




OEDocking TK 1.2.7
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEDocking::OEAddDockingInteractions` has been updated after implementation
  changes were made to the `OEBio::OEFragmentNetwork` class.
  An :ref:`example<section_example_oebio_printinteractions>` has been
  added to **OEBio TK** that illustrates how to access the protein-ligand
  interactions perceived by the :oe:func:`OEDocking::OEAddDockingInteractions` function.



OEDocking TK 1.3.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* A bug that caused the docking toolkit to crash if :ref:`OEDock <OEDocking_OEDock>`
  or :ref:`OEScore <OEDocking_OEScore>` were given a receptor that contained an arginine with
  a negatively charged nitrogen has been fixed.

Python-specific changes
--------------------------------------------------------------------------------

* PoseMolsWithBestReceptor.py
  now avoids redundantly calculating the similarity of the docking and crystallographic
  ligand multiple times, improving the speed of this script when using multiple receptors.

* :ref:`OEDock <OEDocking_OEDock>` and :ref:`OEScore <OEDocking_OEScore>` methods
  will now release the global interpreter lock while performing
  expensive computations.


OEDocking TK 1.3.1
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEDocking::OEAddDockingInteractions` function has been overloaded
  and can now take an :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.
  The previous `OEFragmentNetwork` version has been deprecated and will throw a
  warning upon calling.

C++-specific changes
--------------------------------------------------------------------------------

* PoseMolsWithBestReceptor.cpp example has been
  rewritten to improve performance.


OEDocking TK 1.3.2
================================================================================

* Minor internal improvements have been made.


OEDocking TK 1.3.3
================================================================================

* Minor internal improvements have been made.


OEDocking TK 1.3.4
================================================================================

* Minor internal improvements have been made.


OEDocking TK 1.3.5
================================================================================

* Minor internal improvements have been made.


OEDocking TK 1.3.6
================================================================================

New features
--------------------------------------------------------------------------------

* Language-specific functions have been added to export receptors
  to bytes and read receptors from bytes.

.. oe:language:: c++

     For C++, see :oe:func:`OEDocking::OEReadReceptorFromString` and
     :oe:func:`OEDocking::OEWriteReceptorToString`.

.. oe:language:: python

     For Python, see :oe:func:`OEDocking::OEReadReceptorFromBytes` and
     :oe:func:`OEDocking::OEWriteReceptorToBytes`.

.. oe:language:: java

     For Java, see :oe:func:`OEDocking::OEReadReceptorFromByteArray` and
     :oe:func:`OEDocking::OEWriteReceptorToByteArray`.

.. oe:language:: csharp

     For C#, see :oe:func:`OEDocking::OEReadReceptorFromBytes` and
     :oe:func:`OEDocking::OEWriteReceptorToBytes`.


OEDocking TK 1.3.7
================================================================================

* Minor internal improvements have been made.


OEDocking TK 1.4.0
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* ``OEDocking::OEPosit::DockMultiConformerMolecule`` now correctly uses
  the :ref:`FRED<section_docking_algorithm>` method when there is no bound
  ligand in the receptor.

* ``OEDocking::OEPosit::DockMultiConformerMolecule`` now correctly uses
  the :ref:`FRED<section_docking_algorithm>` method when the similarity between
  the bound ligand and the posed ligand is very low.

Minor bug fixes
--------------------------------------------------------------------------------

* ``OEDocking::OEDock::DockMultiConformerMolecule`` now returns a failure
  code when the best scoring pose for a molecule has an unreasonable score.


OEDocking TK 1.4.1
================================================================================

New features
--------------------------------------------------------------------------------

* Two new result classes, :ref:`OESinglePoseResult <OEDocking_OESinglePoseResult>` and
  :ref:`OEPositResults <OEDocking_OEPositResults>`, have been added that better report
  :ref:`OEPosit <OEDocking_OEPosit>`-generated pose results.

* A new class, :ref:`OEPoseOptimizer <OEDocking_OEPoseOptimizer>`, has been added that optimizes
  an already generated pose to reduce clashes.

* A new method, :oe:meth:`Dock<OEDocking::OEPosit::Dock>`, has been introduced
  that provides greater flexibility in reporting the generated pose results.
  The ``OEDocking::OEPosit::DockMultiConformerMolecule`` method is now deprecated.

* Two new methods, :oe:meth:`AddReceptor<OEDocking::OEPosit::AddReceptor>` and
  :oe:meth:`ClearReceptors<OEDocking::OEPosit::ClearReceptors>`, have been added to the
  :ref:`OEPosit <OEDocking_OEPosit>` class that enable using multiple receptors
  in a single calculation.

* A new function, :oe:meth:`OEDocking::OEHasClash`, has been added that
  allows clash detection.

* The following new methods have been added to the :ref:`OEPositOptions <OEDocking_OEPositOptions>`
  class that enable working with multiple receptors as well as further refinement of generated
  poses:

  * :oe:meth:`GetAllowedClashType<OEDocking::OEPositOptions::GetAllowedClashType>`
  * :oe:meth:`SetAllowedClashType<OEDocking::OEPositOptions::SetAllowedClashType>`
  * :oe:meth:`GetMinProbability<OEDocking::OEPositOptions::GetMinProbability>`
  * :oe:meth:`SetMinProbability<OEDocking::OEPositOptions::SetMinProbability>`
  * :oe:meth:`GetPoserCacheCount<OEDocking::OEPositOptions::GetPoserCacheCount>`
  * :oe:meth:`SetPoserCacheCount<OEDocking::OEPositOptions::SetPoserCacheCount>`
  * :oe:meth:`GetPoseRelaxMode<OEDocking::OEPositOptions::GetPoseRelaxMode>`
  * :oe:meth:`SetPoseRelaxMode<OEDocking::OEPositOptions::SetPoseRelaxMode>`

* A new namespace, :oe:constns:`OEDocking::OEAllowedClashType`, has been added
  that defines constants for various allowed clash types.

* A new namespace, :oe:constns:`OEDocking::OEPoseRelaxMode`, has been added
  that defines if and when a relaxation should be performed.

* A new constant, :oe:const:`OEDocking::OEDockingReturnCode::NoValidNonClashPoses`, has been added
  that indicates that no nonclashing poses are found.

* A new function, :oe:meth:`OEDocking::OEDockingReturnCodeGetName`, has been added that
  converts :oe:constns:`OEDocking::OEDockingReturnCode` to a meaningful string.

* A new function, :oe:meth:`OEDocking::OEPositMethodGetName`, has been added that
  returns the name of an :oe:constns:`OEDocking::OEPositMethod` in a string format.

Major bug fixes
--------------------------------------------------------------------------------

* A rare crash that occurred during docking calculations in
  :oe:meth:`OEDock::DockMultiConformerMolecule<OEDocking::OEDock::DockMultiConformerMolecule>`
  has been fixed.

* :ref:`OEPosit <OEDocking_OEPosit>` no longer fails to generate poses due to unspecified stereo
  in the input molecule.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEDocking::OEMakeReceptor` now returns an empty receptor molecule when it fails.

* :oe:meth:`OEDocking::OEGetEstimatedPositProbability` no longer crashes when a
  failure occurs during conformer generation.

Documentation changes
--------------------------------------------------------------------------------

* Two new examples have been added in the sections, :ref:`section_example_oedocking_PoseMolsMultiReceptor`
  and :ref:`section_example_oedocking_PoseMolsProteinFlex`, that demonstrate new POSIT
  features for working with multiple receptors and for further refining generated poses,
  respectively.

* Docking examples have been updated for better coding practices that
  check the return code status of docking and print out any errors.



.. _section_oedocking_releasenotes_3505:

OEDocking TK 3.5.0.5
================================================================================

* The OEZ file format now correctly persists receptor information.

.. _section_oedocking_releasenotes_350:

OEDocking TK 3.5.0
================================================================================

As part of the integration of **OEToolkits** and **OEApplications** into a single
release, the version number of **OEDocking TK** has been upgraded to 3.5.0 to make
it consistent  with that of the **OEDocking** applications suite.

New features
--------------------------------------------------------------------------------

* Two new methods, :oe:meth:`OEDocking::OEPositOptions::SetExcludeSelf` and
  :oe:meth:`OEDocking::OEPositOptions::GetExcludeSelf`, have been added to
  simplify cross-docking validation experiments with :ref:`OEPosit <OEDocking_OEPosit>`.

* A new method, :oe:meth:`OEDocking::OEPosit::RankReceptors`, has been added that
  can rank receptors when posing with multiple receptors.

* The method :oe:meth:`OEDocking::OEMakeReceptor` has been overloaded to take
  an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object as input.

Major bug fixes
--------------------------------------------------------------------------------

* Memory management for :oe:meth:`OEDocking::OEPosit::Dock` has been improved to
  handle up to 100 receptors when posing with multiple receptors.

Minor bug fixes
--------------------------------------------------------------------------------

* The following methods now return ``bool`` instead of a ``void``:

  * :oe:meth:`OEDocking::OEPositOptions::SetAllowedClashType`
  * :oe:meth:`OEDocking::OEPositOptions::SetFullConformationSearch`
  * :oe:meth:`OEDocking::OEPositOptions::SetIgnoreNitrogenStereo`
  * :oe:meth:`OEDocking::OEPositOptions::SetMinProbability`
  * :oe:meth:`OEDocking::OEPositOptions::SetPoserCacheCount`
  * :oe:meth:`OEDocking::OEPositOptions::SetPoseRelaxMode`

* :oe:meth:`OEDocking::OEPosit::Dock` now fails gracefully when a single atom
  ligand is passed for posing.

* :oe:func:`OEDocking::OEMakeBoxMolecule` now sets the output molecule as 3D.

Documentation changes
--------------------------------------------------------------------------------

* The :ref:`PoseMolsMultiReceptor<section_example_oedocking_PoseMolsMultiReceptor>`
  example has been updated.

* An example has been added to the :ref:`Receptors<chapter_receptor>`
  section showing how to convert an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
  object to a receptor.



.. _section_oedocking_releasenotes_4002:

OEDocking TK 4.0.0.2
================================================================================

*March 2021*

* Default value of :oe:meth:`Target Mask<OEDocking::OEMakeReceptorOptions::SetTargetMask>`
  has been changed to :oe:const:`OEBio::OEDesignUnitComponents::TargetComplexNoSolvent`, to
  reflect best practices for receptor generation.

* :oe:meth:`Target Mask<OEDocking::OEMakeReceptorOptions::SetTargetMask>` in
  :ref:`OEMakeReceptorOptions <OEDocking_OEMakeReceptorOptions>` now provides added
  flexibility to create user defined mask.

* An issue causing :ref:`OEPosit <OEDocking_OEPosit>` to occasionally ignore the
  :oe:meth:`Posit Methods<OEDocking::OEPositOptions::SetPositMethods>` has been fixed.

* Constraints (both protein constraints and custom constraints) are now properly
  serialized in the :ref:`OEReceptor <OEBio_OEReceptor>` in a .OEDU file.

* All of the protein constraints, custom constraints, and extra molecules are now
  properly transferred in the :ref:`OEReceptor <OEBio_OEReceptor>` and the :ref:`OEDesignUnit <OEBio_OEDesignUnit>`,
  when OEB format receptors are used.

.. _section_oedocking_releasenotes_400:

OEDocking TK 4.0.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* A new class, :ref:`OEMakeReceptorOptions <OEDocking_OEMakeReceptorOptions>`, has been added that provides
  choices for making an :ref:`OEReceptor <OEBio_OEReceptor>` inside an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.

* The :oe:func:`OEDocking::OEMakeReceptor` function now takes an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
  and an :ref:`OEMakeReceptorOptions <OEDocking_OEMakeReceptorOptions>`, and adds an :ref:`OEReceptor <OEBio_OEReceptor>`
  inside the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

* A new class, :ref:`OEDockOptions <OEDocking_OEDockOptions>`, has been introduced that provides
  choices for :oe:constns:`OEDocking::OEDockMethod` and :oe:constns:`OEDocking::OESearchResolution`
  in the :ref:`OEDock <OEDocking_OEDock>` class.

* The :ref:`OEDock <OEDocking_OEDock>` class constructor now has an overload
  that takes an :ref:`OEDockOptions <OEDocking_OEDockOptions>` argument.

* The following methods now have an overload that accepts as an argument an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
  containing an :ref:`OEReceptor <OEBio_OEReceptor>`:

  * :oe:meth:`OEDocking::OEDock::Initialize`
  * :oe:meth:`OEDocking::OEDock::CacheScoringSetup`
  * :oe:meth:`OEDocking::OEScore::Initialize`
  * :oe:meth:`OEDocking::OEScore::CacheScoringSetup`
  * :oe:meth:`OEDocking::OEPosit::AddReceptor`

* A new method, :oe:meth:`OEDocking::OESinglePoseResult::GetDesignUnit`, has been added added that
  returns the resulting design unit containing the pose ligand and the target.

* A new class, :ref:`OEPoseOptimizerOptions <OEDocking_OEPoseOptimizerOptions>`, has been added that provides choices for
  force fields and flexibility in performing pose optimization with
  :ref:`OEPoseOptimizer <OEDocking_OEPoseOptimizer>`.

* The :ref:`OEPoseOptimizer <OEDocking_OEPoseOptimizer>` class constructor now has an overload
  that takes an :ref:`OEPoseOptimizerOptions <OEDocking_OEPoseOptimizerOptions>`.

* The :oe:meth:`OEDocking::OEPoseOptimizer::Optimize` method now takes an
  :ref:`OEDesignUnit <OEBio_OEDesignUnit>` to optimize.

* Flexible **POSIT** with :oe:meth:`OEDocking::OEPosit::Dock` now uses the
  :ref:`OEFF14SBParsley <OEFF_OEFF14SBParsley>` for pose optimization.

* A new method, :oe:meth:`OEDocking::OEPosit::RankDesignUnits`, has been added
  that ranks an  :ref:`OEDesignUnit <OEBio_OEDesignUnit>` containing an :ref:`OEReceptor <OEBio_OEReceptor>` for
  posing with multiple receptors.

* With the introduction of the new :ref:`OEReceptor <OEBio_OEReceptor>` class and the corresponding
  behavior of the **OEDocking TK**, several previously existing APIs have been deprecated.
  The following table shows the deprecated APIs and their replacements:

  =========================================================   ================================================================
  Deprecated API                                              New API
  ---------------------------------------------------------   ----------------------------------------------------------------
  ``OEDocking::OEBoxBase``                                    :ref:`OEBox <OEMath_OEBox>`
  ``OEDocking::OEBox``

  ``OEDocking::OECustomConstraints``                          :ref:`OEReceptorCustomConstraints <OEBio_OEReceptorCustomConstraints>`

  ``OEDocking::OEFeature``                                    :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>`

  ``OEDocking::OEProteinConstraint``                          :ref:`OEReceptorProteinConstraint <OEBio_OEReceptorProteinConstraint>`

  ``OEDocking::OESphereBase``                                 :ref:`OESphere <OEMath_OESphere>`

  ``OEDocking::OEAlignReceptors``                             :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>`

  ``OEDocking::OEIsReceptor``                                 :oe:meth:`OEBio::OEDesignUnit::HasReceptor`

  ``OEDocking::OEReceptorClear``                              :oe:meth:`OEBio::OEReceptor::Clear`

  ``OEDocking::OEReceptorClearCustomConstraints``             :oe:meth:`OEBio::OEReceptor::ClearCustomConstraints`

  ``OEDocking::OEReceptorClearProteinConstraints``            :oe:meth:`OEBio::OEReceptor::ClearProteinConstraints`

  ``OEDocking::OEReceptorGetBoundLigand``                     :oe:meth:`OEBio::OEDesignUnit::GetLigand`

  ``OEDocking::OEReceptorGetCustomConstraints``               :ref:`GetCustomConstraints <OEBio_OEReceptor_GetCustomConstraints>`

  ``OEDocking::OEReceptorGetInnerContourLevel``               :oe:meth:`OEBio::OEReceptor::GetInnerContourLevel`

  ``OEDocking::OEReceptorGetOuterContourLevel``               :oe:meth:`OEBio::OEReceptor::GetOuterContourLevel`

  ``OEDocking::OEReceptorHasBoundLigand``                     :oe:meth:`OEBio::OEDesignUnit::HasLigand`

  ``OEDocking::OEReceptorHasCustomConstraints``               :oe:meth:`OEBio::OEReceptor::HasCustomConstraints`

  ``OEDocking::OEReceptorHasInnerContourLevel``               :oe:meth:`OEBio::OEReceptor::HasInnerContourLevel`

  ``OEDocking::OEReceptorHasNegativeImageGrid``               :oe:meth:`OEBio::OEReceptor::HasNegativeImageGrid`

  ``OEDocking::OEReceptorHasOuterContourLevel``               :oe:meth:`OEBio::OEReceptor::HasOuterContourLevel`

  ``OEDocking::OEReceptorHasProteinConstraints``              :oe:meth:`OEBio::OEReceptor::HasProteinConstraints`

  ``OEDocking::OEReceptorSetCustomConstraints``               :oe:meth:`OEBio::OEReceptor::SetCustomConstraints`

  ``OEDocking::OEReceptorSetInnerContourLevel``               :oe:meth:`OEBio::OEReceptor::SetInnerContourLevel`

  ``OEDocking::OEReceptorSetOuterContourLevel``               :oe:meth:`OEBio::OEReceptor::SetOuterContourLevel`

  ``OEDocking::OEReceptorAddCachedScore``                     :oe:meth:`OEDocking::OEDock::CacheScoringSetup`
  ``OEDocking::OEReceptorSetCachedScore``                     :oe:meth:`OEDocking::OEScore::CacheScoringSetup`

  ``OEDocking::OEReadReceptorFile``                           :oe:func:`OEBio::OEReadDesignUnit`
  ``OEDocking::OEReadReceptorToBytes``

  ``OEDocking::OEWriteReceptorFile``                          :oe:func:`OEBio::OEWriteDesignUnit`
  ``OEDocking::OEWriteReceptorToBytes``

  ``OEDocking::OEBoxArea``                                    :oe:func:`OEMath::OEBoxArea`

  ``OEDocking::OEBoxExtend``                                  :oe:func:`OEMath::OEBoxExtend`

  ``OEDocking::OEBoxTranslate``                               :oe:func:`OEMath::OEBoxTranslate`

  ``OEDocking::OEBoxVolume``                                  :oe:func:`OEMath::OEBoxVolume`

  ``OEDocking::OEBoxXDim``                                    :oe:func:`OEMath::OEBoxXDim`

  ``OEDocking::OEBoxYDim``                                    :oe:func:`OEMath::OEBoxYDim`

  ``OEDocking::OEBoxZDim``                                    :oe:func:`OEMath::OEBoxZDim`

  ``OEDocking::OEBoxXMid``                                    :oe:func:`OEMath::OEBoxXMid`

  ``OEDocking::OEBoxYMid``                                    :oe:func:`OEMath::OEBoxYMid`

  ``OEDocking::OEBoxZMid``                                    :oe:func:`OEMath::OEBoxZMid`

  ``OEDocking::OEInBox``                                      :oe:func:`OEMath::OEInBox`

  ``OEDocking::OESetupBox``                                   :oe:func:`OEMath::OESetupBox`
  ``OEDocking::OESetupBoxCenterAndExtents``

  ``OEDocking::OEInSphere``                                   :oe:func:`OEMath::OEInSphere`

  ``OEDocking::OESphereArea``                                 :oe:func:`OEMath::OESphereArea`

  ``OEDocking::OESphereVolume``                               :oe:func:`OEMath::OESphereVolume`
  =========================================================   ================================================================

* With the introduction of the new APIs, several obsolete functionalities
  have been deprecated without any suitable replacements.  These functionalities were added in
  the early development days of **OEDocking TK** and are no longer deemed useful:

  * ``OEDocking::OEAlignReceptorFunction``
  * ``OEDocking::OEReceptorAddExtraMols``
  * ``OEDocking::OEReceptorClearBoundLigand``
  * ``OEDocking::OEReceptorClearExtraMols``
  * ``OEDocking::OEReceptorHasExtraMols``

Documentation changes
--------------------------------------------------------------------------------

* The :ref:`OEHybrid <OEDocking_OEHybrid>` class documentation has been modified to
  clarify that it is derived from :ref:`OEDock <OEDocking_OEDock>`.

* Documentation for ``OEDocking::OEDockBase`` and ``OEDocking::OEScoreBase``
  has been removed.

* All the **OEDocking TK** examples have been reorganized to reflect the
  modified API behavior.




OEDocking TK 4.1.0
================================================================================

*July 2021*

New features
--------------------------------------------------------------------------------

* A predicate string can now be supplied to :ref:`OEMakeReceptorOptions <OEDocking_OEMakeReceptorOptions>`
  using :ref:`SetTargetPred <OEDocking_SetTargetPred>`. This
  povides a way to specify a select set of water molecules in an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` to be part
  of the receptor when the docking grid is constructed and used in subsequent
  docking calculations.

* :ref:`OEMakeReceptor <OEDocking_OEMakeReceptor>` now autogenerates protein constraints.
  The constraints are left disabled by default for the docking calculations. These can be enabled using the toolkits,
  or the Make Receptor GUI application.
  The auto-generation of the constraints can be turned off using the
  :ref:`SetAutoConstraints <OEDocking_SetAutoConstraints>` method in
  :ref:`OEMakeReceptorOptions <OEDocking_OEMakeReceptorOptions>`.

Minor bug fixes
--------------------------------------------------------------------------------

* The default value for the :ref:`SetBoxMol <OEDocking_SetBoxMol>`
  has been set to ``0.0`` in the :ref:`OEMakeReceptorOptions <OEDocking_OEMakeReceptorOptions>` class.




OEDocking TK 4.1.1
================================================================================

*Fall 2021*

New features
--------------------------------------------------------------------------------

* :ref:`OEPosit <OEDocking_OEPosit>` can now generate poses using all the provided receptors.
  This can be controlled via a new method :oe:meth:`SetBestReceptorPoseOnly<OEDocking::OEPositOptions::SetBestReceptorPoseOnly>`.
  The default behavior remains posing with the best receptor only.

* A new preliminary API class, :ref:`OEROCSQueryModelBuilder <OEModels_OEROCSQueryModelBuilder>`,
  has been added that builds an :ref:`OEShapeQuery <OEShape_OEShapeQuery>` from structure-based
  data, and can be used as a query to perform an :ref:`OEOverlay <OEShape_OEOverlay>`
  or **ROCS** calculation.

* A new preliminary API class, :ref:`OEROCSQueryModelOptions <OEModels_OEROCSQueryModelOptions>`,
  has been added that provides choices for :ref:`OEROCSQueryModelBuilder <OEModels_OEROCSQueryModelBuilder>`
  calculations.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue with redundant SD data after docking a multi conformer molecule 
  using the :oe:meth:`OEDocking::OEDock::DockMultiConformerMolecule` method has been fixed.

Documentation changes
--------------------------------------------------------------------------------

* Two new examples have been added to the section, 
  :ref:`section_example_oedocking_PoseMolsMultiReceptor` that 
  handle multiple input receptors and generate single or multiple poses for each 
  ligand.

* Example ``PoseMolsMultiReceptor`` has removed.





OEDocking TK 4.1.2
================================================================================

*Spring 2022*

* Minor internal improvements have been made.



OEDocking TK 4.2.0
===================

New features
--------------------------------------------------------------------------------
* Two new preliminary API classes, :ref:`OEShapeFit <OEDocking_OEShapeFit>` 
  and :ref:`OEShapeFitResults <OEDocking_OEShapeFitResults>` have been added which 
  provides functionality for pose generation based on flexible fitting with Shape/Color 
  and Forcefield.

* The adiabatic optimization algorithm of ``ShapeFit`` method for pose 
  generation in :ref:`OEPosit <OEDocking_OEPosit>` has been replaced by a new
  simultaneous flexible fitting algorithm, as implemented in :ref:`OEShapeFit <OEDocking_OEShapeFit>`.
  The new algorithm uses :ref:`Sage <OEMolSmirnoff_OESage>` as the default forcefield,
  instead of :ref:`MMFF <OEMolMMFF_OEMMFF>`.

* Two new methods, :ref:`SetFlexiOverlayOptions <OEDocking_OEPositOptions_SetFlexiOverlayOptions>`
  and :ref:`GetFlexiOverlayOptions <OEDocking_OEPositOptions_GetFlexiOverlayOptions>`,
  have been added to :ref:`OEPositOptions <OEDocking_OEPositOptions>` to expose
  parameters related to :ref:`OEShapeFit <OEDocking_OEShapeFit>` in :ref:`OEPosit <OEDocking_OEPosit>`.

Major bug fixes
--------------------------------------------------------------------------------
* An issue that caused a segmentation fault when using 
  :ref:`CacheScoringSetup <OEDocking_OEScore_CacheScoringSetup>` has been fixed.

Documentation changes
--------------------------------------------------------------------------------
* New C++ and Python examples have been added to the :ref:`section_examples_shapefit` 
  section that demonstrate how to flexibly fit input multi-conformer molecules 
  into a design unit that contains a bound ligand.





OEDocking TK 4.2.1
================================================================================

New features
--------------------------------------------------------------------------------
* A new preliminary API class, :ref:`OEShapeFitOptions <OEDocking_OEShapeFitOptions>`,
  has been added to allow better control over option parameters for 
  :ref:`OEShapeFit <OEDocking_OEShapeFit>`. The constructor for the
  preliminary class :ref:`OEShapeFit <OEDocking_OEShapeFit>` now takes
  :ref:`OEShapeFitOptions <OEDocking_OEShapeFitOptions>` as an argument instead
  of :ref:`OEFlexiOverlayOptions <OEShape_OEFlexiOverlayOptions>`. Also,
  :ref:`SetFlexiOverlayOptions <OEDocking_OEPositOptions_SetFlexiOverlayOptions>`
  and :ref:`GetFlexiOverlayOptions <OEDocking_OEPositOptions_GetFlexiOverlayOptions>`
  now accept and return :ref:`OEShapeFitOptions <OEDocking_OEShapeFitOptions>`.

Major bug fixes
--------------------------------------------------------------------------------
* The :ref:`Dock <OEDocking_OEPosit_Dock>` method in :ref:`OEPosit <OEDocking_OEPosit>`
  now returns poses instead of a failure, if there is a failure during flexible optimization.

* An issue that caused intermittent crash for specific calculations on specific
  platforms when working with :ref:`OEPosit <OEDocking_OEPosit_Dock>` has been fixed.

* :ref:`OEPosit <OEDocking_OEPosit_Dock>` now accurately returns
  :ref:`NoValidNonClashPoses <OEDocking_OEDockingReturnCode_NoValidNonClashPoses>`
  as status when the predicted pose contains clashes based on the
  :ref:`defined clash allowed type<OEDocking_OEPositOptions_SetAllowedClashType>`.
  Note that the clashed poses can still be retrieved from the resulting
  :ref:`OESinglePoseResult <OEDocking_OESinglePoseResult>` if desired.

Minor bug fixes
--------------------------------------------------------------------------------
* The :ref:`RankDesignUnits <OEDocking_OEPosit_RankDesignUnits>` method is
  now properly wrapped in python.

Documentation changes
--------------------------------------------------------------------------------
* Documentation has been added for 
  :ref:`the function OEGetEstimatedPositProbability <OEDocking_OEGetEstimatedPositProbability>`, which works with
  :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.

* Documentation has been added for :ref:`the function OESetupBox <OEDocking_OESetupBox>`, which supports
  :ref:`OEMolBase <OEChem_OEMolBase>` and :ref:`OEMCMolBase <OEChem_OEMCMolBase>`.





OEDocking TK 4.3.0
================================================================================

New features
--------------------------------------------------------------------------------

* Flexible **Posit** now uses ``FF14SB-SAGE`` force field for the
  protein/ligand complex optimization. 

* A new overload of :ref:`SetupRef <OEDocking_OEShapeFit_SetupRef>` has
  been added that allows using  :ref:`OEShapeFit <OEDocking_OEShapeFit>` with
  a bound ligand as the reference.

* The following new methods have been added to enable internal conformation generation 
  in :ref:`OEShapeFitOptions <OEDocking_OEShapeFitOptions>`:

   * :ref:`SetFullConformationSearch <OEDocking_OEShapeFitOptions_SetFullConformationSearch>`
   * :ref:`GetFullConformationSearch <OEDocking_OEShapeFitOptions_GetFullConformationSearch>`

* A new class, :ref:`OEShapeFitOptions <OEDocking_OEShapeFitOptions>`, has been added
  that allows estimating pose prediction confidence against different reference systems.
  This new class is complementary to the existing function
  :ref:`OEGetEstimatedPositProbability <OEDocking_OEGetEstimatedPositProbability>`.

Major bug fixes
--------------------------------------------------------------------------------
* An issue has been fixed where relaxation failed
  in :ref:`OEPosit <OEDocking_OEPosit_Dock>` when the pose 
  relaxation mode was set to either :ref:`ALL <OEDocking_OEPoseRelaxMode_ALL>`
  or :ref:`CLASHED <OEDocking_OEPoseRelaxMode_CLASHED>`.

* An issue causing generation of bent ring structures 
  and high strain poses when performing :ref:`OEPosit <OEDocking_OEPosit_Dock>` 
  has been fixed.

* An issue has been fixed that caused flexible
  :ref:`OEPosit <OEDocking_OEPosit_Dock>` 
  with :ref:`ALL <OEDocking_OEPoseRelaxMode_ALL>` relaxation mode to fail while
  generating nonclashing poses when
  :ref:`NONE <OEDocking_OEPoseRelaxMode_NONE>` was successful.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue where :ref:`Dock <OEDocking_OEPosit_Dock>` passed too many conformers 
  for flexible optimization with relaxation in
  :ref:`OEPosit <OEDocking_OEPosit>` has been fixed. Now, :ref:`OEShapeFit <OEDocking_OEShapeFit>`
  no longer passes too many conformers for flexible optimization that could
  occasionally cause a less accurate conformer to become the top predicted pose.

* The :ref:`Dock <OEDocking_OEPosit_Dock>` method with relaxation has been modified to
  be more aligned with
  other modes of failure when ligand charge assignments fail.



.. _section_oedockingtk_releasenotes_4313:

OEDocking TK 4.3.1.3
================================================================================

* An issue has been fixed in :ref:`OEHasClash<OEDocking_OEHasClash>` such that
  strong atom clashes are no longer mistakenly marked as covalent bonds causing 
  failure to recognize those as actual clashes.

.. _section_oedockingtk_releasenotes_4310:

OEDocking TK 4.3.1.0
================================================================================

* An issue has been fixed that would occasionally cause segmentation faults
  when :ref:`OEPosit<OEDocking_OEPosit>` would internally fail to generate
  conformers.

* New methods, :ref:`GetPoseRelaxOptions<OEDocking_OEPositOptions_GetPoseRelaxOptions>`
  and :ref:`SetPoseRelaxOptions <OEDocking_OEPositOptions_SetPoseRelaxOptions>`,
  have been added to :ref:`OEPositOptions<OEDocking_OEPositOptions>` to allow more
  flexibility in relaxing the :ref:`OEPosit<OEDocking_OEPosit>` generated poses.

* Internal algorithms have been improved in :ref:`OEShapeFit<OEDocking_OEShapeFit>`
  to improve strain in generated poses.




OEDocking TK 4.3.2
================================================================================

New features
--------------------------------------------------------------------------------

* The method :ref:`Optimize<OEDocking_OEPoseOptimizer_Optimize>` in
  :ref:`OEPoseOptimizer<OEDocking_OEPoseOptimizer>` now returns an ``unsigned``
  code corresponding to any possible failure, instead of a ``bool``. The
  method also takes additional arguments for protein and ligand masks in
  the :ref:`OEDesignUnit<OEBio_OEDesignUnit>`.

* The following methods have been added to the :ref:`OESinglePoseResult<OEDocking_OESinglePoseResult>`:

  * :ref:`GetRelaxAttempted<OEDocking_OESinglePoseResult_GetRelaxAttempted>`
  * :ref:`GetRelaxStatus<OEDocking_OESinglePoseResult_GetRelaxStatus>`
  * :ref:`GetRelaxStatusStr<OEDocking_OESinglePoseResult_GetRelaxStatusStr>`

* A new method, :ref:`MethodChoice<OEDocking_OEPosit_MethodChoice>`, has been added
  to :ref:`OEPosit<OEDocking_OEPosit>` that provides information on the method
  that would be used for the pose prediction of a given ligand against a given receptor.

* The new methods :ref:`GetTorLib<OEDocking_OEPositOptions_GetTorLib>` and
  :ref:`SetTorLib<OEDocking_OEPositOptions_SetTorLib>` have been added to
  :ref:`OEPositOptions<OEDocking_OEPositOptions>` to provide a choice for the
  torsion library that would be used for conformer generation during pose prediction.

* The following methods have been added to the :ref:`OEShapeFitOptions<OEDocking_OEShapeFitOptions>`:

  * :ref:`GetMaxLocalStrain <OEDocking_OEShapeFitOptions_GetMaxLocalStrain>`
  * :ref:`SetMaxLocalStrain <OEDocking_OEShapeFitOptions_SetMaxLocalStrain>`
  * :ref:`GetTorLib<OEDocking_OEShapeFitOptions_GetTorLib>`
  * :ref:`SetTorLib<OEDocking_OEShapeFitOptions_SetTorLib>`

Major bug fixes
--------------------------------------------------------------------------------

* The method :ref:`Optimize<OEDocking_OEPoseOptimizer_Optimize>` in
  :ref:`OEPoseOptimizer<OEDocking_OEPoseOptimizer>` is now more robust in
  optimizing a docked pose.  Accordingly, :ref:`Docking<OEDocking_OEPosit_Dock>`
  with relaxation in :ref:`OEPosit<OEDocking_OEPosit>` is also now
  more robust.

* The function :ref:`OEHasClash<OEDocking_OEHasClash>` now properly
  recognizes all clashes between a ligand and a protein that were previously
  mistaken because of some misidentification of covalent bonds.

Minor bug fixes
--------------------------------------------------------------------------------

* Selection of the best receptor has been improved in :ref:`OEPosit<OEDocking_OEPosit_Dock>`,
  ensuring that the correct receptor will always be picked in case of a self-docking.

* The internal algorithm has been optimized to improve time requirements for
  :ref:`OEPosit<OEDocking_OEPosit_Dock>` when working with many receptors and a
  few ligands.



OEDocking TK 4.3.3
================================================================================

Minor internal improvements have been made.




OEDocking TK 4.3.4
================================================================================

Minor Bug Fixes
-----------------

*  An issue has been fixed where a receptor grid could not be constructed
   for covalently bonded ligands. 


###############################################
Appendix: Additional Examples in Python
###############################################

These are full listings of programming examples that are excerpted or offered for download, elsewhere in this chapter.
See :ref:`the list in this chapter <oedocking_part_examples>`
for the set of examples.

..	_listing-ReceptorIO.py:

..  oe:source:: ReceptorIO.py
    :language: python
    :caption: Using the string I/O functions.
    :refnum: 1


.. _chapter_docking:

********************************************************************************
Docking
********************************************************************************

Docking is the process of determining the structure of a ligand bound in the
active site of a target protein.  In the *Docking Toolkit* this is done with
the :ref:`OEDock <OEDocking_OEDock>` class that takes a multiconformer representation
of a ligand and returns the top scoring pose (or poses if desired) within the
active site.  Docking is done using an exhaustive search algorithm, followed
by optimization of the best poses from the exhaustive search
(see :ref:`section_docking_algorithm` section).

:ref:`section_examples_docking` is an example program that uses the
:ref:`OEDock <OEDocking_OEDock>` class to dock, score and annotate multiconformer
molecules.

.. _section_docking_construction:

Scoring Functions and Search Resolution
================================================================================

The resolution of the exhaustive search and scoring functions are required inputs
when constructing a :ref:`OEDock <OEDocking_OEDock>` object.

*dockMethod* is an unsigned int constant from the 
:oe:constns:`OEDocking::OEDockMethod` namespace, that specifies the combination
of scoring functions (or method) :ref:`OEDock <OEDocking_OEDock>` uses for the
exhaustive search and optimization.  The available scoring methods are:

   ================================================= ================================= =================================
   **Method**                                        **Exhaustive Search Scoring**     **Optimization Scoring**         
   ================================================= ================================= =================================
   :oe:const:`OEDocking::OEDockMethod::Shapegauss`   :ref:`section_scoring_shapegauss` :ref:`section_scoring_shapegauss`
   :oe:const:`OEDocking::OEDockMethod::PLP`          :ref:`section_scoring_plp`        :ref:`section_scoring_plp`       
   :oe:const:`OEDocking::OEDockMethod::Chemgauss3`   :ref:`section_scoring_chemgauss3` :ref:`section_scoring_chemgauss3`
   :oe:const:`OEDocking::OEDockMethod::Chemgauss4`   :ref:`section_scoring_chemgauss3` :ref:`section_scoring_chemgauss4`
   :oe:const:`OEDocking::OEDockMethod::Chemscore`    :ref:`section_scoring_chemgauss3` :ref:`section_scoring_chemscore` 
   :oe:const:`OEDocking::OEDockMethod::Hybrid1`      :ref:`section_scoring_cgo`        :ref:`section_scoring_chemgauss3`
   :oe:const:`OEDocking::OEDockMethod::Hybrid`       :ref:`section_scoring_cgo`        :ref:`section_scoring_chemgauss4`
   ================================================= ================================= =================================

*dockResolution* is an unsigned int constant from the 
:oe:constns:`OEDocking::OESearchResolution` namespace, that specifies the docking
resolution to use.  The docking resolution is the rotational and translational
stepsize used during the exhaustive search and optimization (the rotational
stepsize is the furthest distance any heavy atom of the ligand will move in
a single rotational step).  The following resolutions are supported

   ============================================================ ============================ =========================
   **Resolution**                                               **Exhaustive Translational** **Exhaustive Rotational**
   ============================================================ ============================ =========================
   :oe:const:`OEDocking::OESearchResolution::High`              1.0                          1.0                      
   :oe:const:`OEDocking::OESearchResolution::Standard`          1.0                          1.5                      
   :oe:const:`OEDocking::OESearchResolution::Low`               1.5                          2.0                      
   ============================================================ ============================ =========================

   ============================================================  ==============================  ===========================
   **Resolution**                                                **Optimization Translational**  **Optimization Rotational**
   ============================================================  ==============================  ===========================
   :oe:const:`OEDocking::OESearchResolution::High`                  0.5                             0.5
   :oe:const:`OEDocking::OESearchResolution::Standard`              0.5                             0.75
   :oe:const:`OEDocking::OESearchResolution::Low`                   0.75                            1.0
   ============================================================  ==============================  ===========================

All resolutions are in Angstroms.

.. seealso::

   Section :ref:`section_docking_algorithm` for more information docking 
   algorithm.

.. _section_docking_hybrid:

Hybrid Method
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

The hybrid (:oe:const:`OEDocking::OEDockMethod::Hybrid2`) docking method is 
distinguished from other docking methods because it uses information present in
the structure of a bound ligand to enhance docking performance.

The bound ligand information is used during the exhaustive search stage of the
docking process (see :ref:`section_docking_algorithm` section) by using the
:ref:`section_scoring_cgo` scoring function, which scores poses based on how
well a docked pose overlays the shape of the bound ligand and mimics the same
hydrogen bonding and interactions the bound ligand makes.  After the exhaustive
search, optimization is performed with :ref:`section_scoring_chemgauss4` which
is a standard structure based scoring function.

The final score a ligand receives using the hybrid docking method is based
only on its interactions with the protein.  Ligand information is used only
to guide the selection of poses during the exhaustive search.

.. note::

   In order to use the hybrid docking
   method the receptor :ref:`OEDesignUnit <OEBio_OEDesignUnit>` must have a bound ligand (see
   :oe:meth:`OEDesignUnit::HasLigand<OEBio::OEDesignUnit::HasLigand>`).

.. _section_docking_initialization:

Initialization
================================================================================

An :ref:`OEDock <OEDocking_OEDock>` object must be initialized with a receptor object,
prior to docking, scoring or annotating any molecules.  This is done by passing
a :ref:`OEDesignUnit <OEBio_OEDesignUnit>` containing a receptor (see :ref:`Receptors <chapter_receptor>`)
to the :oe:meth:`OEDocking::OEDock::Initialize` method.

.. _section_docking_molecules:

Docking Molecules
================================================================================

Once the :ref:`OEDock <OEDocking_OEDock>` object has been initialized molecules are
docked using the :oe:meth:`OEDocking::OEDock::DockMultiConformerMolecule` method.

Docking requires a multiconformer representation of the molecule as input. Docking
selects the top scoring docked pose from the provided ensemble of conformers.  The 
score of the docked molecule can be obtained by calling
the :oe:meth:`OEChem::OEMolBase::GetEnergy` method of *pose*.

:ref:`OEDock <OEDocking_OEDock>` can also return alternate as well as top scoring
poses of the docked molecule.

.. _section_docking_methods:

Scoring Molecules
================================================================================

The final score of a molecule (using the optimization scoring function) docked
with the :oe:meth:`OEDocking::OEDock::DockMultiConformerMolecule` method can
be obtained by calling the :oe:meth:`OEChem::OEMolBase::GetEnergy`.

:ref:`OEDock <OEDocking_OEDock>` can also recalculate a score of a pose (using
the optimization scoring function), and calculate the contribution for each
individual component of the score as in the following example.

.. _section_docking_algorithm:

Docking Algorithm
================================================================================

:ref:`OEDock <OEDocking_OEDock>` docks multiconformer molecules using an exhaustive
search that systematically searches rotations and translations of each conformer
of the ligand within the active site.  Following the exhaustive search the
top scoring poses are optimized and assigned a final score.  These two steps
are described in more detail below

*Exhaustive Search*

  #. Enumerates, to given resolution, every possible rotation and translation
     of each conformer of the ligand being docked within a box enclosing the
     active site. The resolution of the exhaustive search is determined by
     the overall resolution setting of :ref:`OEDock <OEDocking_OEDock>`
     (see :ref:`section_docking_construction` section).

  #. Discard out poses that either clash with the protein or extend to far
     from the binding site using the receptor's negative image outer contour
     (see :ref:`section_receptor_negative_image` section).  

  #. If the negative image inner contour is enabled discard any poses that
     do not have at least one heavy atom that falls within the inner contour.
     (see :ref:`section_receptor_negative_image` section).  

  #. Discard any poses that do no match any user specified constraints.
     (see :ref:`section_receptor_constraints` section).

  #. Score all remaining poses.  The scoring function used here depends
     on what scoring method is being used (see :ref:`section_docking_construction`
     section).

  #. Sort poses by score and pass the top scoring poses to optimization.
     The number of posses passed to optimization depends on the search
     resolution (see :oe:constns:`OEDocking::OESearchResolution` constant
     namespace).

*Optimization*

  #. Each pose moved to 729 nearby positions, scored and the top scoring
     position become the new optimized pose.  The positions
     are generated by having the initial pose take one positive and one
     negative step for each translational and rotational degree of freedom.
     The resolution of these steps is half that of the exhaustive search,
     and is determined by the overall resolution setting of 
     :ref:`OEDock <OEDocking_OEDock>`
     (see :ref:`section_docking_construction` section).

  #. The best scoring pose of the 729 tests poses is selected as the final
     docked structure (and score) for the ligand.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!




.. _chapter_poseprediction:

********************************************************************************
POSIT Theory
********************************************************************************

**POSIT** is a pose-prediction tool primarily based on the assumption that similar
ligands bind similarly.  Pose prediction is the process of determining the structure 
of a ligand bound in the active site of a target protein. Pose prediction with
*POSIT* assumes that the incoming ligand binds to the given protein and makes the 
best effort in correctly placing it in the active site. In conjunction to the
predicted pose, **POSIT** also provides an estimate of confidence, in terms of an
estimated probability, that the docked pose is within 2.0 |Angstroms| of the actual 
binding pose.

.. note::

 Note that this probability
 is not the probability of binding, rather, the probability that the
 pose is correct given the ligand actually binds to the receptor.


*POSIT* consists of multiple *Docking* or *Pose Prediction* methods intentionally
and automatically chooses the best method to use for any particular ligand based 
on the 2D (graph) and 3D (structure) similarity of the docked ligand to the bound 
ligand. The methods *POSIT* uses to dock are:

 #. :ref:`ShapeFit<shapefit_method>` - Shape-guided ligand minimization into the receptor site

 #. :ref:`Hybrid<section_docking_hybrid>` - hybrid method that uses
    ligand and protein information

 #. :ref:`Fred<section_docking_algorithm>` - Standard docking method that uses no ligand information

If there is no bound ligand in the receptor, the *Fred* method is used by default
since it does not rely upon the pressence of the bound ligand.


-------------------------------------------
Handling of isomerisms and chirality
-------------------------------------------

Stereo, and notably nitrogen aniline stereo centers, are currently
somewhat problematic for *POSIT*.  Many crystal structures have
flat geometries for some stereo centers due to time-averaging
during data collection.  This makes stereo centers appear to
have flat geometries in the 3D coordinates.

Because the POSIT algorithm internally expands conformations during
the flexible fitting procedure, the full molecule must be
labeled with stereo - either in the 3D coordinate sense or the
2D coordinate sense.  This means that some pdb ligand structures
will unfortunately be failed by the POSIT algorithm.

To get around this, posit can be told to ignore nitrogen stereo
during the conformer generation phase.

.. note::

 Output structures of *Posit* are not guaranteed to have the same
 conformations of the input molecule.  This is due to the fact that
 force-field minimization is occasionally performed during pose
 prediction.

.. _posit_algorithm:

---------------------------
Estimated Pose Probability
---------------------------

During a drug discovery campaign, thousands of small molecule
inhibitors are made in the course of optimizing molecular properties.
For projects that have X-Ray crystallographic (XRC) coordinates,
structure-based designs help guide the medicinal chemistry efforts.
In many cases XRC provides a detailed picture of the binding of a
small-molecule inhibitor into the binding site.

Many techniques exist for pose-prediction and are well documented
[Erickson-2004]_ .  However,
very few provide a probability that the generated pose is correct where
correct is typically considered to be less than 2.0 |Angstroms| RMSD
(root mean square distance) from experimental crystal structure.
In fact, many docking scores such as Chemscore, Chemgauss3,
PLP [Tuccinardi-2010]_ are not very correlated with correct ligand
pose, and worse are not transferable between systems. The best
docking score in one system may not even be close to the best
docking score in another.

*POSIT* overcomes these issues by comparing predicted poses to observed 
bound ligands in related co-crystals.  As the observed ligand becomes more 
similar to the the predicted pose, both the binding mode and the shape of 
the receptor pocket itself tends to become more similar.

The similarity measures being used are 2D path-based fingerprints and
the 3D *TanimotoCombo* [Hawkins-2010]_ that compares shape and the Mills-Dean
approximation of electrostatics [Mills-Dean-1996]_ . These similarity 
measures choose the most appropriate system to dock against (when multiple
receptors are available) and provide a prediction of the quality of the result.
The *TanimotoCombo* measure is agnostic of how the poses in question are
generated; it can be used to validate and provide a pose prediction
probability regardless of how the pose was generated.

*POSIT* probabilities were generated using a large test set containing
many pose predictions and verified against an independent set of predictions 
that were then validated with X-Ray crystallography.  It is important to note 
that *POSIT* does not give a probability of binding. Rather it gives a probability 
that **if the ligand does actually bind**, what is the likelihood of the *POSIT* 
pose being the actual pose.

Figure :ref:`POSIT Probability MAP<posit_heat_map>` shows how the
beliefs given by the 2D and 3D measures are combined into a
probability of having a good pose.  Remember that this probability has
been generated from ligands that actually bind, hence, it is not a
probability of binding.

.. _posit_heat_map:

.. figure:: /_images/POSIT-prob.png
   :width: 60%
   :align: center
   :alt: POSIT probability of finding poses within 2.0 |A|

   **POSIT Probability Map:** Given a 2D similarity (in this case the :term:`MACCS` 166 descriptor set [Durant-2002]_)
   and a 3D similarity (*TanimotoCombo*) *posit* computes a
   probability of finding the correct pose based on an analysis of
   historical and experimental data.


This result is different from the result shown in [Tuccinardi-2010]_ ,
where they reported that having a high *TanimotoCombo* to the known bound
ligand did not dramatically increase the quality of the resulting pose (even for
*FRED*).  The reason is subtle: Tuccinardi *et al* were computing the
highest *TanimotoCombo* that the two molecules could obtain, while *Posit*
computes the actual, docked, in-place *TanimotoCombo* of the fitted
pose.   That is, if the docking algorithm produces an alignment
of fit molecule to known bound ligand that overlaps with a given
*TanimotoCombo*, one can look up the probability the docking was successful.
In point of fact, *Posit* is specifically
designed so that the docked pose obtains the highest
*TanimotoCombo* score possible while simultaneously minimizing induced
strain and maintaining interactions with the protein.


Categorically the data shown in :ref:`POSIT Probability MAP<posit_heat_map>`,
for each pose can be binned into the following results:

   ============   =======================================================================
   Result         Meaning
   ============   =======================================================================
   GREAT          Computed pose is likely (75%-100% probability) to be within 2.0 |A| of
                  experimentally-derived pose.
   ------------   -----------------------------------------------------------------------
   GOOD           Computed pose may be (50%-75% probability) to be within 2.0 |A| of
                  experimentally-derived pose.
   ------------   -----------------------------------------------------------------------
   MEDIOCRE       Take with a grain of salt (33%-50% probability)
   ------------   -----------------------------------------------------------------------
   POOR           Take with a huge grain of salt (<33% probability)
   ============   =======================================================================

------------------------------
Additional MCS Constraints
------------------------------

Walter's *et al* noted that a large portion of ligands bound to the
same protein kinase share a large maximum common substructure (MCS).  This
was the basis for their **CORES** algorithm [Hare-2004]_ .  *Posit* can  optionally
identify matching regions and use them as additional constraints during
conformer generation. *Posit* performs the MCS match to the bound ligand
by default.

-----------
On Clashes
-----------

The definition of *clashes* is somewhat problematic for purposes of pose
prediction.  In general, serious clashes where interpenetration with the
protein should be avoided at all costs.  However, when docking into
a rigid protein that does not have the appropriate conformation, rigid
docking ignores that fact that the active site may adopt a conformation suitable
to the posed ligand.

*Posit* uses the definitions from :ref:`OEClashInteractionHint<OEBio_OEClashInteractionHint>`
to identify clashes. *Posit* allows the users to specify three
allowable clash levels.

   ================================== ============================================
   Allowed Clash                      Description
   ================================== ============================================
   noclashes (none)                   No clashes are allowed.
   ---------------------------------- --------------------------------------------
   hydrogen (mild clashes)            Only hydrogen clashes are allowed.
   ---------------------------------- --------------------------------------------
   allclashes                         All clashes are allowed.
   ================================== ============================================

.. _section_example_oedocking_PoseMolsMultiReceptor:

--------------------------
Using Multiple Receptors
--------------------------

Using multiple receptors to dock or pose molecules has been shown to
greatly increase the reliability of docking. 

When multiple receptors are provided *Posit* chooses the appropriate reference 
system based on the 2D/3D similarity to the bound ligand. The best reference, 
in general, has the highest 2D/3D similarity of the input molecule to the chosen 
bound ligand.  The similarity measure used here are similar to those used
in determining the best docking method in *Posit*.

.. _section_example_oedocking_PoseMolsProteinFlex:

----------------------
Receptor Flexibility
----------------------

Incorporating multiple receptors is the simplest way to account for receptor
flexibility during pose prediction. With multiple receptors, *Posit* would
pick the best suitable conformer of the receptor for a particular docked ligand.

Pose generated from *Posit* with provided receptor conformers can still sometimes 
contain clashes. Option is available to trigger post pose prediction relaxation,
that relaxes both the posed ligand and protein residues around it.

Note that optimization of a protein-ligand complex can sometimes be time consuming, 
especially if the target protein and associated components are large.

--------------
TanimotoCombo
--------------

*Posit* uses the *TanimotoCombo* measure to compare (and optimize)
predicted and bound ligands.  The *TanimotoCombo* measure is simply two
separate Tanimoto measures added together.  While most uses of Tanimoto have
been to compare fingerprints together, there is a direct relation
between the 1D fingerprint bit vector and 3D space:

The basic equation for a field Tanimoto between two fields A and B is:

.. math::

   Tanimoto_{A,B} = \frac{\int A(\vec{r})*B(\vec{r})}{\int A(\vec{r})*A(\vec{r}) + \int B(\vec{r})*B(\vec{r}) - \int A(\vec{r})*B(\vec{r})}


In the case of *Posit*, the field in question can be thought of as field of
voxel space.  For :math:`Tanimoto_{shape}`, where A and B are now
molecules:  if two objects fill the same voxels, then the Tanimoto
value is 1.0.  If two objects overlap by half, the Tanimoto value
is 0.5 and so on.  (The term voxel is used for purposes edification, in
actuality the volumes estimated using a fast approximate method)

.. _voxel:

.. figure:: /_images/voxel.png
   :width: 75%
   :align: center
   :alt: Voxel representation of space


   **Voxel Representation of Shape:** Similar to fingerprint bits in
   1D, voxels can be used to represent 3D
   space and compared with the Tanimoto measure.  The numerator
   *Overlap(q,t)* is essentially the volume of
   the **intersection** of *q* and *t* and the denominator
   *Overlap(q,q) + Overlap(t,t) - Overlap(q,t)* is essentially
   the volume of the **union** of *q* and *t*.

The field can also contain colored representations of chemistry.  For
example, if two voxels are colored as hydrogen bond donors and
overlap, the :math:`Tanimoto_{color}` increases.

Hence, *TanimotoCombo* is:

.. math::

  TanimotoCombo = Tanimoto_{shape} + Tanimoto_{color}

*TanimotoCombo* values range from 0 (no overlap) to 2.0 (full shape overlap and full
color or chemistry overlap).


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



********************************************************************************
Posit How to
********************************************************************************

Ignore Nitrogen stereo
-------------------------------------------

Nitrogen stereo can be ignored in *Posit* by constructing :ref:`OEPosit <OEDocking_OEPosit>` 
with an :ref:`OEPositOptions <OEDocking_OEPositOptions>` object that has the
:oe:meth:`OEDocking::OEPositOptions::SetIgnoreNitrogenStereo` method
set to ``True``.

Prepare molecules for Posit
-------------------------------------------

With default settings, *Posit* internally generates the required input conformers
and *Posit* can be used with 2D input molecules.  However, if it is desired to
pass a pre-generated set of conformers to *Posit*, following are the recommended 
ways to supply or prepare molecules for **POSIT**.

  1. Use *OMEGA* or the *OMEGA toolkit* to prepare molecules or
     expand the stereo chemistry using *OEFlipper*.  POSIT
     is guaranteed to work correctly if the input molecules
     have been generated by *OMEGA*.

  2. Set the :ref:`OEPositOptions <OEDocking_OEPositOptions>` fullConformationalSearch option
     to be false.  See the section :ref:`OEPositOptions <OEDocking_OEPositOptions>` for more details.
     This method of running POSIT is not recommended as a large portion of the
     flexible methodology will be deactivated.

Use multiple receptors
-------------------------------------------

Multiple receptors can be passed to *Posit* by
calling the :oe:meth:`AddReceptor<OEDocking::OEPosit::AddReceptor>`
with each of the receptors as shown in the example,
:oe:src:`Listing 5<GenerateMultiplePose>`.  The :oe:cls:`OEDocking::OEPosit`
will automatically detect the best receptor for the ligand in
action and dock to it.

One of the difficulties of docking to multiple receptors, is that
they can consume quite a large amount of memory so holding multiple
docking objects at the same time can be problematic.  This can be controlled
with the :oe:meth:`SetPoserCacheCount<OEDocking::OEPositOptions::SetPoserCacheCount>`
method, based on the available hardware capacity and the size of the
receptors in use.

Obtain clash-free pose
----------------------------------

Pose generated from **Posit** with the default options can sometimes contain
clashes. Users have the option to perform pose relaxation, either on the
clashed poses or on all generated poses, with the appropriate option using the
:oe:meth:`SetPoseRelaxMode<OEDocking::OEPositOptions::SetPoseRelaxMode>`
method.


.. _chapter_receptor_dockingtk:

.. meta::
   :keywords: chapter_receptor_dockingtk


********************************************************************************
Receptors
********************************************************************************

In receptor objects contain information about the location and characteristics 
of the binding pocket, and required for docking (see :ref:`chapter_docking`),
posit (see :ref:`chapter_posit`), and scoring (see :ref:`chapter_scoring`).

A receptor is an :ref:`OEReceptor <OEBio_OEReceptor>` object that resides within a
:ref:`OEDesignUnit <OEBio_OEDesignUnit>`. The essential component of a valid receptor is
the negative image that describes the shape of the active site.

Creating a Receptor
================================================================================

Within the Docking toolkit the :oe:func:`OEDocking::OEMakeReceptor` function
is used to create a receptor from the structure of a target protein containing
in a :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.

The protein structure should only include molecules the ligand is expected to
interact with.  In general crystallographic waters, other solvents and the bound
ligand should be not be included as part of the target protein structure passed to the
:oe:func:`OEDocking::OEMakeReceptor` function, although in certain cases, the
user may wish to retain certain key molecules as part of the target protein
structure (*e.g.* a crystallographic water).


Contents of a Receptor
================================================================================

Negative Image
--------------------------------------------------------------------------------

The negative image describes the shape of the active site.  It is stored as a
potential grid surrounding the active site.  Potential values are always greater
than or equal to zero.  The negative image has high potentials where ligand
atoms make many contacts with atoms of the active site without clashing and
in positions some ligand atoms are likely to occupy when other atoms of the
ligand make good contacts with the receptor (*e.g.* bridging positions ligand
atoms will likely occupy when a ligand is stretched between two pockets).

During docking two shapes are created by contouring the negative image
potential grid.  The two shapes control the docking process as follows:

*Outer Contour* Shape

   During docking any pose examined by the exhaustive search that does not fit
   within this shape will be rejected.  A pose is considered to fit if the
   center of every heavy atom is within this shape.  The volume of this shape
   is typically between 500 and 2000 cubic Angstroms.

*Inner Contour* Shape

   During docking any pose examined by the exhaustive search that does not
   touch this shape is rejected.  A pose is considered to touch if the center
   of at least one heavy atom falls within this shape.  The volume of this
   shape is typically 50 to 100 cubic angstroms.

While neither the *outer contour* nor the *inner contour* shape are required, it is
recommended that the *outer contour* always be used (docking speed will be
dramatically slower without the *outer contour*).  Using the *inner contour*
improves docking speed slightly at the expense of sampling. However, if the 
*inner contour* size is nearly as large as the *outer contour*, there will be 
little to no difference in compute time.

The negative image of the receptor is set up when the receptor is created
with the :oe:func:`OEDocking::OEMakeReceptor` function (see
the section on creating a receptor).  The size of the *outer contour*
and *inner contour* shapes are controllable by setting the contour level
used to create the shape from the negative image.  The
:oe:func:`OEDocking::OEMakeReceptor` function will automatically set a
reasonable contour level for both the *inner contour* and *outer contour*,
however the *inner contour* will be disabled by setting the value
to be negative (see below).

The negative image grid has only positive values, thus only contour levels
that are positive create a shape.  When either the *outer contour* level
or *inner contour* level are negative that contour shape will be disabled
(*i.e.* ignored during the docking process).  

The volume of the *outer contour* shape has a significant effect on docking
speed, while the volume of the *inner contour* shape has a modest effect on
docking speed.  In both cases the smaller volumes increase docking speed by
reducing the number of poses that are scored.  In general an outer and inner
contour volume of between 500-2000 and 50-100 cubic Angstroms respectively is
recommended.

Constraints
--------------------------------------------------------------------------------

Constraints are key interactions ligands are required to make when docking into
the active site.  They are optional and user defined.

Constraints do not affect how a given pose scores, however they do affect how
the docking algorithm chooses poses to score during the docking process.  Any
pose that does not match the docking constraints will be rejected and replaced
by the next best scoring pose.  If no poses of a ligand match the docking
constraints the ligand will not be docked.  If multiple constraints are
specified every constraint must be satisfied or the pose will be rejected.

.. note::

   The docking process has a resolution
   of approximately 1 Ångström, and thus the constraints have a similar resolution.
   Therefore it is possible that poses docked with a constraint may have small
   violations of the constraint distance, up to approximately 1 Ångström.

Receptors support two general classes of constraints; protein constraints and
custom constraints.  There may be any number of either class of constraint.

.. note::

   Each individual custom or protein constraint has an enabled flag.  A disabled
   constraint is ignored during the docking process.

Protein Constraints
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A protein constraint specifies an interaction that must be made with a
**heavy atom** of the protein structure (*i.e.* protein constraints cannot be
placed on hydrogen atoms).  There are five types of protein
constraints.

**Contact**

    A contact constraint is satisfied when any ligand heavy atom is within
    4 angstroms of the protein heavy atom.

**Lipophilic**

    A lipophilic constraint is satisfied when any non-polar heavy atom on
    the ligand is within 4 angstroms of the protein heavy atom.

**Donor**

    A donor constraint is satisfied when a *donor on the ligand* makes a
    hydrogen bond interaction with the protein heavy atom.

**Acceptor**

    An acceptor constraint is satisfied when an *acceptor on the ligand* makes
    a hydrogen bond interaction with the protein heavy atom.  Acceptor
    constraints must be placed on the protein heavy atom the donor hydrogen is
    interacting with.

**Chelator**

    A chelator constraint is satisfied when a *chelator on the ligand* makes
    a metal-chelator interaction with the protein heavy atom.

Only one protein constraint is allowed per protein heavy atom.  If a protein
constraint is set on a protein atom that already has a protein constraint the
original protein constraint will be discarded and replaced by the new
constraint.

Custom Constraints
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A custom constraint consists of one or more spheres within the receptor active
site, and optionally a list of SMARTS patterns.  A custom constraint is satisfied
when a matching atom on the ligand falls within any of the spheres associated
with the custom constraint.  If no SMARTS patterns are specified any heavy atom
on the ligand can satisfy the constraint, otherwise only atoms that match one
of the smarts patterns can satisfy the constraint.



.. _chapter_scoring:

********************************************************************************
Scoring
********************************************************************************

Scoring functions in the *Docking Toolkit* measure the fitness of ligands posed within the
active site of a target protein and assign them a numerical score.  Poses with
better scores are more likely to be correctly docked compared to other poses of
the same ligand.  The score of a ligand is the best score of any pose of that
ligand, and ligands with better scores are more likely to be active against the
target protein compared to other ligands docked.

The following scoring functions are implemented in *Docking TK* 
                                               
#. :ref:`section_scoring_shapegauss` (:oe:const:`OEDocking::OEScoreType::Shapegauss`)

#. :ref:`section_scoring_plp` (:oe:const:`OEDocking::OEScoreType::PLP`)

#. :ref:`section_scoring_chemgauss3`  (:oe:const:`OEDocking::OEScoreType::Chemgauss3`)

#. :ref:`section_scoring_chemgauss4`  (:oe:const:`OEDocking::OEScoreType::Chemgauss4`)

#. :ref:`section_scoring_chemscore` (:oe:const:`OEDocking::OEScoreType::Chemscore`)

In the *Docking Toolkit* scoring, optimization and score annotation with
any of these scoring functions is done using the :ref:`OEScore <OEDocking_OEScore>`
class.

:ref:`section_examples_scoring` is an example program that uses the
:ref:`OEScore <OEDocking_OEScore>` class to score, optimize and annotate poses.

.. _section_scoring_implementations:

Scoring Function Implementations
================================================================================

.. _section_scoring_shapegauss:

Shapegauss
--------------------------------------------------------------------------------

Shapegauss [McGann-2003]_ is a shape based scoring function that favors poses
that complement the active site well, regardless of any chemical interactions
(*e.g.* hydrogen bonds).  The Shapegauss scoring function represents the shape
of each atom as a smooth Gaussian function.

The Shapegauss score is calculated by summing a pairwise potential between all
protein atoms and all ligand heavy atoms.  This potential is most favorable
when the two atoms touch but do not overlap.  A correction term is then applied
to further penalize atoms which significantly overlap the protein.

For Shapegauss a lower score indicates a better result.

.. _section_scoring_plp:

PLP
--------------------------------------------------------------------------------

PLP [Verkhivker-2000]_ or Piecewise Linear Potential scoring function calculates
both the shape and hydrogen bond complementarity of poses to the active site.

The PLP score is a pairwise additive scoring function.  All pairs of 
ligand-protein heavy atoms are assigned either a hydrogen bonding potential,
if the pair is an acceptor-donor pair, or otherwise a lipophilic potential.
These pairwise potentials are summed to obtain the final pose score.

The PLP implementation in the *Docking Toolkit* has also been extended to
include interaction between metals on the target protein and acceptors on the
ligand. 

For PLP a lower score indicates a better result.

.. _section_scoring_chemscore:

Chemscore
--------------------------------------------------------------------------------

Chemscore [Eldridge-1997]_ is a sum of the following interaction terms

   *lipophilic*
   
      Favorable interactions that occur when two non-polar heavy atoms (one
      ligand atom and one protein atom) are placed near each other.

   *hydrogen bonding*
   
      Favorable interactions that occur when acceptor-donor interactions are 
      formed between the ligand and protein.

   *metal chelator*
   
      Favorable interactions that occur when acceptor atoms on the ligand are
      placed near metal atoms on the protein.

   *clash*
   
       Penalty term that occurs when heavy atoms on the ligand and protein 
       clash.

   *rotatable bond*
   
       This penalty term is proportional to the number of rotatable bonds on
       the ligand that are no longer free to rotate when the ligand is docked.

For Chemscore a lower score indicates a better result.

.. _section_scoring_chemgauss3:

Chemgauss3
--------------------------------------------------------------------------------
The Chemgauss3 scoring function uses Gaussian smoothed potentials to measure the
complementarity of ligand poses within the active site.  Chemgauss3 recognizes
the following types of interactions.

   * Shape 

   * Hydrogen bonding between ligand and protein

   * Hydrogen bonding interactions with implicit solvent

   * Metal-chelator interactions.  

All interaction potentials in Chemgauss are initially constructed using step
functions to describe the interaction of atom pairs (or other chemical points)
as a function of distance.  These interactions are mapped onto a grid that is
then convoluted with a spherical Gaussian function, which smoothes the potential
making it less sensitive to small changes in the ligand position.  Smoothing
the score in this way serves two purposes, first docking can be run at lower
resolution than would be required if the score were not smooth since small
changes in position to do not cause large changes in score.  Second it reduces
the error associated with the rigid protein approximation by effectively
accounting for the ability of the protein to make small structural
re-arrangements to accommodate the ligand.

Shape interactions in Chemgauss are based on a united atom model (*i.e.* only
heavy atoms are relevant to the shape calculation).  Each ligand heavy atom is
assigned a fixed clash penalty score if the distance between it and a protein
heavy atom is less than the sum of the VdW radii, otherwise it is assigned a
score proportional to the count of the number of protein heavy atoms within
1.25 and 2.5 times the sum of the VdW radii (atoms within 2.5 count one tenth
as much as those within 1.25).  From this score a penalty equal to two close
protein atom contacts is subtracted to represent the VdW interactions with
solvent water that are lost when the ligand docks.  This score is pre-computed
at grid points throughout the active site and the resulting grid is then
smoothed.

Hydrogen bonding groups are modeled with one or more lone-pair or polar-hydrogen
positions that describe the directionality of potential hydrogen bonds (with
respect to the hydrogen bonding group's heavy atom).  Donor groups have lone
pair positions representing the possible location of the donor hydrogen
atoms relative to the donating molecule, while acceptors have lone-pair
positions representing the possible locations of the donated hydrogen relative
to the acceptor.  A hydrogen bond is detected and assigned a constant score
when a hydrogen bonding position on the ligand is within 1.0 Angstroms of a
complementary hydrogen bonding position on the protein (*i.e.* when the
polar-hydrogen position of a donor overlaps the lone-pair position of an
acceptor).  If the ligand hydrogen bonding group has multiple polar-hydrogens
and/or lone-pair positions (groups can be both donors and acceptors) then this
calculation is performed for each position and the result is summed.  As with
all Chemgauss terms the hydrogen bond potential is pre-computed at grid points
throughout the site and then smoothed. 
 
Hydrogen bonds with solvent that break when the ligand docks into the active
site are penalized by the Chemgauss scoring function.  Broken protein-solvent
hydrogen bonds are accounted for by calculating how many hydrogen bonds water
can make with the protein at the position of each heavy atom of the docked
ligand, and a penalty score is assigned which is proportional to the number of hydrogen
bonds.  Broken ligand-solvent hydrogen bonds are accounted for by calculating
desolvation positions around each hydrogen-bonding group on the ligand that
represent the positions water could occupy when making a hydrogen bonding
interaction with the protein.  A penalty is then assessed that is proportional
to the number of desolvation positions that can no longer be occupied by water
because the water in these positions would clash with the protein.  As before,
this potential is placed on a grid and smoothed.

Chelating interactions between protein metals and ligand chelating groups are
accounted for by Chemgauss (protein-chelator and ligand-metal chelating
interactions are not).  For each chelator on the ligand one or more 
chelating-positions are calculated.  If a protein metal is within 1.0 Angstroms
of any chelating-position of a chelating group then a fixed score is assigned, 
otherwise a zero score is assigned.  As before this potential is placed on a
grid and smoothed.

For Chemgauss3 a lower score indicates a better result.

.. _section_scoring_chemgauss4:

Chemgauss4
--------------------------------------------------------------------------------
The Chemgauss4 is a modification of the Chemgauss3 scoring function that has
improved hydrogen bonding and metal chelator (The shape and implicit solvent
interaction terms are identical to those in Chemgauss3).  The new hydrogen
bonding and metal chelator terms have better perception of the directionality
of these interactions and also account for hydrogen bond networking effects.

To calculate the hydrogen bonding score for a ligand-protein hydrogen bond 
two distances are measured.

  #. How far the donor heavy atom is from the position the acceptor atom would
     consider to be an ideal for a hydrogen bonding to form.

  #. How far the acceptor heavy atom is from the position the donor atom would
     consider to be ideal for a hydrogen bonding interaction to occur.

The score for the hydrogen bond interaction is a product of two Gaussian
functions of these distances scaled by the strength of the hydrogen
bonding groups involved in the interaction.

  HBscore = strength*g(distance1)*g(distance2)

To compute the total hydrogen bonding score for the ligand-protein complex
the individual pairwise scores are calculated for all protein-ligand 
donor-acceptor.  Individual HB interaction are then eliminated if either 
the donor or acceptor exceeds the maximum number of interactions allowed
(e.g., a hydroxyl with one hydrogen is not allowed to make more than one
donor interaction), with the lowest scoring interactions eliminated first.
The final hydrogen bond score is then calculated by summing the scores of
the remained individual acceptor-donor interactions.

For Chemgauss4 a lower score indicates a better result.

.. _section_scoring_cgo:

Chemical Gaussian Overlay (CGO)
--------------------------------------------------------------------------------

The Chemical Gaussian Overlay function (or CGO) is a hybrid scoring function 
that scores poses based on their similarity to a known bound ligand and the
interactions both the docked and bound ligand make with the protein active site.
**This scoring function is not implemented by the** :ref:`OEScore <OEDocking_OEScore>`
**class.** This scoring function is used by the 
:ref:`OEDock <OEDocking_OEDock>` class during the exhaustive search (see
:ref:`section_docking_algorithm` section) when using the hybrid docking
method (see :ref:`section_docking_hybrid` section). 

CGO is primarily a ligand-based scoring functions although some information
from the protein structure is used as well.  The similarities computed are
based on the overall shape of the molecules as well as the position of
hydrogen bonding and metal chelating groups.  This scoring function requires
a bound ligand pose along with the structure of the target protein.  Typically
the ligand structure is obtained from X-ray crystallography along with the
structure of the target protein, although a docked ligand could also, in
principal, be used.

CGO represents molecules as a set of spherical Gaussian functions describing
the shape and chemistry (acceptors, donors and chelators) of the molecule.  The
Gaussians representing the shape of the molecule are centered at the heavy atom
positions, those for donors are centered on polar-hydrogen positions (*i.e.* 
positions where the donating hydrogen could be when it is involved in a hydrogen
bond), those for acceptors are centered on lone-pair positions (*i.e.* positions
where a donating hydrogen could be when a hydrogen bond is formed) and those
for chelators are centered at chelating positions (*i.e.* locations where a metal
could have a chelating interaction).  The overlap of the Gaussians on the docked
ligand to those on the bound ligand are computed for each type of Gaussian 
(*e.g.* shape, donor, acceptor and chelator) by summing the overlap of individual
pairs of Gaussian. The overlap of each individual pair is calculated by
integrating the product of the two.  To prevent chemistry not relevant to
binding from contributing to the overall score, when calculating the chemistry
overlaps (*i.e.* acceptor, donor and chelator) only groups that make the
interaction with the protein are accounted for (*e.g.* a chelator that does not
interact with a metal on the protein is ignored in the overlap calculation).
The sum of all four types of overlaps is the CGO score.

For CGO a lower score indicates a better result.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _shapefit_method:

********************************************************************************
ShapeFit
********************************************************************************

*SHAPEFIT* is a pose prediction method that is built up on the concept that
similar ligands have similar binding modes in a protein active site [Kelley-2015]_. Given a
molecule that is known to bind, and a ligand-protein complex containing a
similar ligand or the binding pose of a similar ligand, *SHAPEFIT* overlays
the docked ligand onto the known bound ligand. The approach used here is
an extension of the molecular- shape-based ligand-alignment algorithm used 
in *ROCS*. Although both are shape-based ligand alignment, unlike *ROCS*, 
*SHAPEFIT* allows for for intra-molecular flexibility of the docked ligand.
*SHAPEFIT* also guards against the docked ligand bumping into the protein,
when using a ligand-protein complex as reference system.

When multiple receptors, or bound ligand references are provided, *SHAPEFIT* 
searches through XRC coordinates of ligands, determines the bound-liagnd
best able to predict the pose of the molecule and then generates both
a pose and the probability that the pose is correct.

.. _shapefit_basic_algorithm:

*SHAPEFIT*'s basic algorithm:

.. _posit_figure:

 1. Given a set of potential complexes or bound-ligands, *SHAPEFIT* chooses
    the appropriate reference system based on the 2D/3D similarity to the
    bound ligand. The best reference, in general, has the highest 2D/3D
    similarity of the input molecule to the chosen bound ligand.

 2. After the complex is chosen, a flexible fitting is performed that
    attempts to maximize the shape and color similarities between 
    the input molecule and the bound ligand while at the same time 
    minimizing the intra-molecular force field on input molecule.

    *SHAPEFIT* seeds the flexible fit by expanding the poses generated by
    the original 3D similarity as described in (1) and then applying
    the shape constraint of the bound ligand.

    As shown in figure :ref:`SHAPEFIT Optimization<posit_figure>`,
    *SHAPEFIT* works by first using the known bound ligand to
    position the input molecule and follows up by using the bound ligand
    as a shape constraint during force field optimization.
    While the input
    molecule is being forced into the shape constraint, the generated pose 
    strain is monitored to avoid generating high strain poses.

 3. The interactions between the generated poses and proteins are utilized 
    to identify clash-free poses while simultaneously selecting the poses 
    with the highest Pose probability.  

Therefore, SHAPEFIT’s optimization attempts to match the molecule being posed
to the ligands' known binding mode without creating undue strain on that molecule.

.. figure:: /_images/posit_images_001.png
   :scale: 75
   :align: center
   :alt: *SHAPEFIT* Optimization Technique

   **SHAPEFIT Optimization:**  Starting from an initial alignment, use the
   shape constraint of the bound-ligand to drive a flexible fit while
   simultaneously minimizing intra-molecular force field of the fit molecule

As shown in figure :ref:`SHAPEFIT Cross Docking Results<posit_cross_docking_results>`,
analyzing the Kinase data set used in
[Tuccinardi-2010]_ pose-prediction using SHAPEFIT is
seen to perform remarkably better for similar ligands than standard
docking techniques at higher *TanimotoCombo* values:

.. _posit_cross_docking_results:

.. figure:: /_images/cross_docking_results.png
   :scale: 80
   :align: center
   :alt: Cross Docking probability of finding poses within 2.0 |Angstroms|

   **SHAPEFIT Cross Docking Results:** Probability of finding a good pose based on bound-ligand
   fit-ligand *TanimotoCombo* similarity.  Standard docking results
   are essentially the same and follow the same trajectories
   flattening out as they hit their limit of accuracy.  While *SHAPEFIT*
   performs worse at low similarities it continually increases as
   similarity increases.

While *SHAPEFIT* is not a good technique for determining the pose between
known bound-ligands and fit ligands with low similarity, as the
similarity increases, the probability of determining the correct pose
increases rapidly. This is most
likely because as the similarity increases, the active site
similarity also increases.

On Clashes
----------

Unlike the *FRED* and *HYBRID* methods, *SHAPEFIT* is heavily biased
towards the known bound ligand. In some cases this causes the pose
to clash with the protein.  This is especially true if the
*original bound ligand* already clashes with the protein.

.. raw:: latex

      \newpage % hard pagebreak at exactly this position




********************************
Theory
********************************

.. toctree::
   :maxdepth: 3

   receptor
   scoring
   docking
   shapefit
   pose_stub_tk
   posit_howto_tk


###################################
FastROCS Toolkit |fastrocs_version|
###################################

.. note::

   **FastROCS TK** is available in Python, Java,  
   and C++ on 64-bit Linux platforms only. 

.. oe:language:: python

    .. toctree::
       :maxdepth: 3

       introduction
       theory
       installation
       architecture
       examples
       selected_examples_python
       tutorials
       api
       releasenotes/index

.. oe:language:: java c++ csharp

    .. toctree::
       :maxdepth: 3

       introduction
       theory
       installation
       architecture
       examples
       tutorials
       api
       releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





..  _fastrocs-tk-introduction:

===============
Introduction
===============

FastROCS TK is an extremely fast shape comparison application, based on
the idea that molecules have similar shape if their volumes overlay
well and any volume mismatch is a measure of dissimilarity. It uses a
smooth Gaussian function to represent the molecular volume
[Grant-1996]_, so it is possible to routinely minimize to the best
global match. FastROCS will perform millions of these global shape
matches every second. See the :ref:`molecular_shape_section` section 
in the **Shape TK** theory documentation for a description of the
shape and color theory used in FastROCS TK. 

Now, in just seconds, FastROCS TK can perform a virtual screen over an
entire multi-conformer representation of a corporate collection to
find active compounds with similar shape to a lead compound (a task
that could previously take up to a day [Rush-2005]_). Recent work
suggests that the underlying ligand-based shape similarity approach is
competitive with, and often superior to, structure-based approaches in
virtual screening [Hawkins-2007]_ [Venhorst-2008]_, both in terms of
overall performance and consistency [Sheridan-2008]_. Alignments to
crystallographic conformations have also been useful in pose
prediction in the absence of a protein structure [Sutherland-2007]_.

In addition to virtual screening and lead hopping, FastROCS TK can be
used to perform NxN shape comparisons over an entire multiconformer
database. A prototype of clustering with FastROCS TK can be found in the
SphereExclusionClustering.py example program.


.. _chapter_custom_color:

===========================================
Using a Custom Color ForceField in FastROCS
===========================================

Similar to the **Shape Toolkit**, a custom color forcefield can be used to
compare color features beyond those captured with the default forcefield.
To use a custom color forcefield, specify your forcefield during the
initialization of your OEShapeDatabase :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>`

Custom color forcefields in FastROCS are constructed the same way they are
in the :ref:`OEColorForceField <OEShape_OEColorForceField>` class in the **OEShape TK**
but are restricted to the following:

#. Interactions can only be between atoms of the same type

#. Interactions can only be favorable

#. Interactions can only be of type "gaussian"

#. user defined types are not permitted

in the following code example:

.. oe:language:: c++

   .. oe:source:: customcolorff_snippet.cpp
      :language:  c++
      :frag:      SNIPPET-1

.. oe:language:: python

   .. oe:source:: CustomColorForceField_Snippet.py
      :language:  python
      :frag:      SNIPPET-1

   :ref:`Full listing. <listing-CustomColorForceField_Snippet.py>`

.. oe:language:: java

   .. oe:source:: CustomColorForceField_Snippet.java
      :language:  java
      :frag:      SNIPPET-1

a color forcefield is created that will only count interactions between pairs of
acceptors and pairs of donors. The -1.0 indicates a favorable interaction, with standard
weighting. 2.0 is the range of the color interaction in space.

.. seealso::

   * :ref:`OEColorForceField <OEShape_OEColorForceField>` class in the **OEShape TK**


.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEDBTracer, DBTracer

.. _OEFastROCS_OEDBTracer:

.. oe:class:: OEDBTracer

   .. oe:api::

      class OEDBTracer : public OEDBTracerBase

   A thread-safe implementation of :ref:`OEDBTracerBase <OEFastROCS_OEDBTracerBase>`
   meant for tracking the progress of a
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` query.

   The following methods are publicly inherited from :ref:`OEDBTracerBase <OEFastROCS_OEDBTracerBase>`:

   ========================================================= ========================================================= =========================================================
   :oe:meth:`SetTotal<OEFastROCS::OEDBTracerBase::SetTotal>` :oe:meth:`Update<OEFastROCS::OEDBTracerBase::Update>`
   ========================================================= ========================================================= =========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDBTracer(size_t numBins = 0)

      .. oe:language:: python

         .. oe:api:: python

            OEDBTracer(numBins: int = 0) -> OEDBTracer

      Construct a new thread-safe ``OEDBTracer`` object and initialize
      the internal synchronization primitives that are required.

      The ``numBins`` argument specifies how many bins the internal
      :ref:`OEFastROCSHistogram <OEFastROCS_OEFastROCSHistogram>` will have. The
      granularity of each bin is the determined by the range of the
      score divided by the number of bins. Note,
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` and
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Color` have a range
      of 0.0-1.0, while
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Combo` has a range
      of 0.0-2.0.

   .. oe:method:: GetCounts

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEULongLong GetCounts(bool blocking = false)

      .. oe:language:: python

         .. oe:api:: python

            GetCounts(blocking: bool = False) -> int

      Returns the current number of conformers already searched by a
      :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>`. This is a thread-safe
      function for querying the current progress of the database
      search. :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` will update the
      progress of this tracer through the
      :oe:meth:`OEFastROCS::OEDBTracer::Update` method from multiple
      threads. This function can be used by another thread to query
      that total progress.

      The optional ``blocking`` parameter specifies whether the call
      should wait until there has been an update to the tracer before
      returning. This can be useful for making progress updates not
      spin too rapidly reporting the same number every time.

   .. oe:method:: GetHistogram

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFastROCSHistogram GetHistogram()

      .. oe:language:: python

         .. oe:api:: python

            GetHistogram() -> OEFastROCSHistogram

      Return a copy of the histogram currently accumulated in this
      database query as a :ref:`OEFastROCSHistogram <OEFastROCS_OEFastROCSHistogram>`
      object. This histogram will be empty if ``numBins`` passed to
      the constructor is ``0``.

      This is a thread-safe function for querying the current
      distribution of scores for the molecules already processed. The
      full histogram of the scores is not available until the value
      returned by :oe:meth:`OEFastROCS::OEDBTracer::GetCounts` is
      equal to :oe:meth:`OEFastROCS::OEDBTracer::GetTotal`.

   .. oe:method:: GetNumBins

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t GetNumBins() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumBins() -> int

      Return the number of bins to use for the score histogram during
      this particular query. Returning '0', the default, will indicate
      to :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` to skip
      histogram creation all together.

   .. oe:method:: GetTotal

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEULongLong GetTotal()

      .. oe:language:: python

         .. oe:api:: python

            GetTotal() -> int

      Return the total number of conformers to be processed.

      .. warning::

         It is possible for this function to return ``0`` for a short
         time after a call to
         :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
         :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`. So a
         ``0`` return value should be taken with a grain of salt of
         that possible race-condition.

   .. oe:method:: SetTotal

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTotal(OEULongLong total)

      .. oe:language:: python

         .. oe:api:: python

            SetTotal(total: int) -> None

      Called by :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` and
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` to set
      whatever the total number of conformers that will be processed.

   .. oe:method:: Update

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Update(OEULongLong step = 1,
                        const OEFastROCSHistogram* hist = NULL)

      .. oe:language:: python

         .. oe:api:: python

            Update(step: int = 1, hist: OEFastROCSHistogram = None) -> None

      Called by :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` and
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` from
      multiple threads to communicate the current progress of the search.


.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEDBTracerBase, DBTracerBase

.. _OEFastROCS_OEDBTracerBase:

.. oe:class:: OEDBTracerBase

   .. oe:api::

      class OEDBTracerBase

   Abstract base class used by :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>`
   to track the progress of an individual search against the
   database. Users should derive from this class and pass the derived
   class into :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetTracer`
   for the options object later passed into
   :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
   :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`.

   .. warning::

      :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` and
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` are
      multi-threaded functions, so the ``Update`` method implemented
      by a derived class should be thread-safe.

   The following classes derive from this class and should be used in
   preference of creating a custom tracer:

    * :ref:`OEDBTracer <OEFastROCS_OEDBTracer>`

   .. oe:method:: GetNumBins

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t GetNumBins() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumBins() -> int

      Return the number of bins to use for the score histogram during
      this particular query. Returning '0', the default, will indicate
      to :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` to skip
      histogram creation all together.

   .. oe:method:: SetTotal

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTotal(OEULongLong total)=0

      .. oe:language:: python

         .. oe:api:: python

            SetTotal(total: int) -> None

      Called once by :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores`
      or :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` in a
      single thread to indicate the total number of conformers that
      will be searched.

   .. oe:method:: Update

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Update(OEULongLong step = 1,
                        const OEFastROCSHistogram* hist = NULL)=0

      .. oe:language:: python

         .. oe:api:: python

            Update(step: int = 1, hist: OEFastROCSHistogram = None) -> None

      Called many times by
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` from
      many operating system threads so this function should be
      thread-safe. The :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object
      will pass in a large ``step`` size to optimize the number of
      times this function is called, typically only hundreds of times
      will this method be called for a database containing millions of
      conformers. The ``step`` corresponds to the number of conformers
      already searched. Even so, this function should be implemented
      with very efficiently as it is called by the
      :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` search threads, so forward
      progress can not be made if this function is costly.

      The optional ``hist`` argument is a
      :ref:`OEFastROCSHistogram <OEFastROCS_OEFastROCSHistogram>` to accumulate into a
      master histogram for the entire query. Typically,
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` and
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` will
      submit will call this method once for very large chunks of the
      database. This makes the synchronization point of calling this
      function very minimal to the overall runtime of the query. If a
      ``NULL`` pointer is passed, the default, no histogram
      accumulation will occur.

      .. warning::

         The implementer of a sub-class of
         :ref:`OEDBTracerBase <OEFastROCS_OEDBTracerBase>` should guarantee the
         thread-safety of this method.


.. _OEFastROCSClasses:

*******************
OEFastROCS Classes
*******************

.. oe:namespace:: OEFastROCS

.. toctree::

   OEDBTracer
   OEDBTracerBase
   OEFastROCSHistogram
   OEShapeDatabase
   OEShapeDatabaseOptions
   OEShapeDatabaseScore


.. oe:namespace:: OEFastROCS

.. _OEFastROCS_OEFastROCSHistogram:

.. oe:class:: OEFastROCSHistogram

   .. oe:api::

      class OEFastROCSHistogram

   This class is returned from
   :oe:meth:`OEFastROCS::OEDBTracer::GetHistogram` during and after a
   query is sent to :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores`
   or :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`. It is
   used to contain a list of frequencies representing the distribution
   of scores. This same container is used to contain the frequencies
   of the following 3 score types:

   - :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape`
   - :oe:const:`OEFastROCS::OEShapeDatabaseType::Color`
   - :oe:const:`OEFastROCS::OEShapeDatabaseType::Combo`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFastROCSHistogram(size_t numBins = 200)

      .. oe:language:: python

         .. oe:api:: python

            OEFastROCSHistogram(numBins: int = 200) -> OEFastROCSHistogram

      Construct a new histogram with the specified number of "bins" in
      which to bin the score distribution. The same number of bins is
      applied to each score type.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFastROCSHistogram(const OEFastROCSHistogram& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEFastROCSHistogram(rhs: OEFastROCSHistogram) -> OEFastROCSHistogram

      Copy constructor for moving a
      :ref:`OEFastROCSHistogram <OEFastROCS_OEFastROCSHistogram>` in memory.

   .. oe:language:: c++

      .. oe:method:: operator=

         .. oe:api::

            OEFastROCSHistogram& operator=(const OEFastROCSHistogram& rhs)

         Assignment operator for moving a
         :ref:`OEFastROCSHistogram <OEFastROCS_OEFastROCSHistogram>` in memory.

      Assignment operator.

   .. oe:method:: GetHistogram

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetHistogram(std::vector<unsigned int>& frequencies,
                              unsigned int scoreType)

      .. oe:language:: python

         .. oe:api:: python

            GetHistogram(frequencies: OEUIntVector, scoreType: int) -> None

      Initializes the ``frequencies`` vector to the required size to
      contain the number of bins for this histogram, then fills it
      with the number of molecules that falls within each bin for the
      ``scoreType`` specified. The ``scoreType`` should be one of the following:

      - :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape`
      - :oe:const:`OEFastROCS::OEShapeDatabaseType::Color`
      - :oe:const:`OEFastROCS::OEShapeDatabaseType::Combo`

   .. oe:method:: GetNumBins

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t GetNumBins() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumBins() -> int

      Returns the number of bins used for this histogram. The number
      of bins determines the granularity of the scores.

   .. oe:method:: Update

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Update(const OEFastROCSHistogram& rhs)

      .. oe:language:: python

         .. oe:api:: python

            Update(rhs: OEFastROCSHistogram) -> None

      Sum the histogram ``rhs`` into this histogram. This histogram
      will then reflect the total of the two histograms. Used for
      aggregating histograms during the execution of
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Update(const OEShapeDatabaseScore& score)

      .. oe:language:: python

         .. oe:api:: python

            Update(score: OEShapeDatabaseScore) -> None

      Updates this histogram from an individual
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` object usually
      representing one molecule during the execution of
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`.


.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEShapeDatabase, ShapeDatabase

.. _OEFastROCS_OEShapeDatabase:

.. oe:class:: OEShapeDatabase

   .. oe:api::

       class OEShapeDatabase

   This is the primary class for performing **FastROCS TK**
   calculations. It is a very heavy-weight object: 

   - consuming many gigabytes of memory
   - managing many host threads
   - managing all GPU interaction 

   The goal is to allow abstracting away the complexities as much as
   possible to allow writing to a single API, allowing for the
   improvement of the underlying compute engine over time.

   Ideally, this class is initialized once per dataset. There is a
   fair amount of pre-calculation done on each molecule and conformer
   while being loaded into memory. Some of this can be alleviated by
   pre-calculating and caching, but not all of it, as there is a
   balance between caching and recalculation that is always being
   tuned.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeDatabase(const OEShape::OEColorForceField& cff,
                            unsigned int dbtype = OEShapeDatabaseType::Default)
            OEShapeDatabase(unsigned int dbtype = OEShapeDatabaseType::Default,
                            unsigned int cfftype = OEShape::OEColorFFType::OEDefault)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeDatabase(dbtype: int, cfftype: int = OEColorFFType_OEDefault) -> OEShapeDatabase
            OEShapeDatabase(cff: OEColorForceField, dbtype: int) -> OEShapeDatabase

      Create a new :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` for managing
      conformers and performing **FastROCS TK** calculations. 

      Whether the :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` can perform
      color calculations must be chosen at construction. If "shape
      only" is chosen by passing
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape`, then there
      can be significant memory and load-time performance
      improvements. Color atom assignment can be a significant cost
      during load and increase memory usage by roughly 2x.

      A custom :ref:`OEColorForceField <OEShape_OEColorForceField>` can be passed to
      this constructor as well to allow color scoring to be completely
      customized. Note, in the case of a custom color force field,
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Default` is
      assumed. It is currently not possible to perform a "color only"
      scoring.

      
   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeDatabase & operator=(const OEShapeDatabase &)

      Assignment operator.

   .. oe:method:: AddMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int AddMol(const OEChem::OEMCMolBase& mol,
                                const unsigned orient = OEFastROCSOrientation::Inertial)

      .. oe:language:: python

         .. oe:api:: python

            AddMol(mol: OEMol, orient: int) -> int

      Add a new collection of conformers to this database and return
      the index used to identify this molecule. This index will start
      at ``0`` and monotonically increase by ``1`` for every
      multi-conformer molecule
      added. :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetMolIdx`
      will return this index to be able to map **FastROCS** scores to
      molecules added through this mechanism.

      If using alternative start method
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs`, this
      constant needs to be passed as the final argument to the AddMol routine
      so the database can be loaded without pre-processing conformer coordinates.
      The final argument is ignored for all other use cases and does not need
      to be changed from the default argument as all molecules are identically
      pre-processed for all other starting points.

      .. warning::

         Databases must be re-added if using :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs`

      .. note::

         Even though this method is not ``const``, it has been made
         thread-safe so that it can be called from multiple
         threads. Furthermore, it has been optimized as much as
         possible to parallelize the pre-calculation this method
         performs. This makes it very efficient to use multiple
         threads to load a database file into memory.

   .. oe:method:: GetColorForceFieldType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetColorForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceFieldType() -> int

      Return a constant from the :oe:constns:`OEShape::OEColorFFType`
      namespace to indicate the color force field used to construct
      this database. Returns
      :oe:const:`OEShape::OEColorFFType::Custom` if a custom
      :ref:`OEColorForceField <OEShape_OEColorForceField>` object was passed to the
      constructor.

   .. oe:method:: GetColorGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetColorGridSpacing() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorGridSpacing() -> float

      Return the grid spacing used to calculate color scores. This
      defaults to ``0.5`` for good performance. Lower values will
      yield answers that agree more closely with the ``Exact``
      analytical calculation, at the expense of performance. Higher
      values can yield better performance. The default was chosen as a
      good balance of virtual screening statistical analysis (AUCs) versus
      raw throughput performance.

   .. oe:method:: GetDatabaseType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetDatabaseType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDatabaseType() -> int

      Returns a constant from the
      :oe:constns:`OEFastROCS::OEShapeDatabaseType` namespace
      indicating what type of calculations this database can perform. 

   .. oe:method:: GetDeviceToHostStrategy

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetDeviceToHostStrategy() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeviceToHostStrategy() -> int

   .. oe:method:: GetHostToDeviceStrategy

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetHostToDeviceStrategy() const

      .. oe:language:: python

         .. oe:api:: python

            GetHostToDeviceStrategy() -> int

   .. oe:method:: GetMaxNumDevices

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxNumDevices() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxNumDevices() -> int

      Returns the maximum number of GPU devices this database will use
      for calculations. The only way to restrict the GPUs seen by the
      database is to use the ``CUDA_VISIBLE_DEVICES`` environment
      variable before starting the process.
      
      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabase::SetNumDevices`

   .. oe:method:: GetMaxOptIterations

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxOptIterations() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxOptIterations() -> int

      Return the number of optimizer iterations the **FastROCS**
      algorithm should use when optimizing the alignment of the
      database conformer and the query conformer. This currently
      defaults to ``10`` based upon analysis of producing good virtual
      screening statistics (AUCs) without excessive iterations that
      would cost performance.

   .. oe:method:: GetNumDevices

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumDevices() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumDevices() -> int

      Returns the number of GPU devices this database will use for
      calculation. This will default to all the GPUs that are visible,
      i.e., the value returned from
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetMaxNumDevices`.

   .. oe:method:: GetNumThreadsPerDevice

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumThreadsPerDevice() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumThreadsPerDevice() -> int

   .. oe:method:: GetNumOpenThreads

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumOpenThreads() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumOpenThreads() -> int

      Return how many CPU threads will be used to read a
      :ref:`OEMolDatabase <OEChem_OEMolDatabase>` from disk into memory using the
      :oe:meth:`OEFastROCS::OEShapeDatabase::Open` method. The
      default, a value of ``0``, is to use as many CPUs as can be
      found on the system with
      :oe:func:`OEPlatform::OEGetNumProcessors`.

   .. oe:method:: GetScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEShapeDatabaseScore> * GetScores(const OEChem::OEMolBase& query,
                                                                   const OEShapeDatabaseOptions& options = OEShapeDatabaseOptions()) const
            OESystem::OEIterBase<OEShapeDatabaseScore> * GetScores(const OEShape::OEShapeQueryPublic& shapeQry,
                                                                   const OEShapeDatabaseOptions& options = OEShapeDatabaseOptions()) const
            OESystem::OEIterBase<OEShapeDatabaseScore> * GetScores(const OEShape::OEShapeQuery& shapeQry,
                                                                   const OEShapeDatabaseOptions& options = OEShapeDatabaseOptions()) const

      .. oe:language:: python

         .. oe:api:: python

            GetScores(arg1: OEShapeQueryPublic,
                      options: OEShapeDatabaseOptions = OEFastROCS_OEShapeDatabaseOptions()) -> Iterable[OEFastROCS_OEShapeDatabaseScore]
            GetScores(arg1: OEShapeQuery,
                      options: OEShapeDatabaseOptions = OEFastROCS_OEShapeDatabaseOptions()) -> Iterable[OEFastROCS_OEShapeDatabaseScore]
            GetScores(query: Union[OEGraphMol,OEMol,OEQMol],
                      options: OEShapeDatabaseOptions = OEFastROCS_OEShapeDatabaseOptions()) -> Iterable[OEFastROCS_OEShapeDatabaseScore]

      Return **ALL** scores of the query against the entire database
      subject to the options specified in the
      :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` passed to this
      method. This is useful for performing larger scale ``NxN``
      clustering type of calculations where all pairs of scores need
      to be processed.

      The query can be either a single conformer
      :ref:`OEMolBase <OEChem_OEMolBase>`, a :ref:`OEShapeQuery <OEShape_OEShapeQuery>` or a
      :ref:`OEShapeQueryPublic <OEShape_OEShapeQueryPublic>` object read from a ``.sq``
      file. :ref:`OEShapeQuery <OEShape_OEShapeQuery>` or :ref:`OEShapeQueryPublic <OEShape_OEShapeQueryPublic>`
      objects must contain a molecule. To determine if your OEShapeQuery object
      is **FastROCS**-friendly see :oe:func:`OEShape::OEIsFastROCSShapeQuery` in the
      **Shape TK**.

      When passing an :ref:`OEMolBase <OEChem_OEMolBase>` query, the molecule must
      have 3D coordinates assigned and must have been preprocessed with
      :oe:func:`OEFastROCS::OEPrepareFastROCSMol` before calling this method.

      .. warning:: 

         The order of the :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>`
         returned by the iterator is non-deterministic and will
         certainly change for each execution due to the multi-threaded
         nature of this method. However, the values calculated in each
         :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` will be the
         same. Therefore, users should rely on the return value of
         :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetMolIdx` and
         :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetConfIdx` to do further
         processing, not the location within the iterator.

      .. seealso:: 

         The :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` class is
         used to control many of the parameters to this method. For
         example, how many conformers per molecule to return.

   .. oe:method:: GetShapeGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetShapeGridSpacing() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeGridSpacing() -> float

      Return the grid spacing used to calculate shape scores and drive
      the alignment. This defaults to ``0.5`` for good
      performance. Lower values will yield answers that agree more
      closely with the ``Exact`` analytical calculation, at the
      expense of performance. Higher values can yield better
      performance. The default was chosen as a good balance of virtual
      screening statistical analysis (AUCs) versus raw throughput
      performance.

   .. oe:method:: GetSortedScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEShapeDatabaseScore> * GetSortedScores(const OEChem::OEMolBase& query,
                                                                         unsigned int limit = 0) const
            OESystem::OEIterBase<OEShapeDatabaseScore> * GetSortedScores(const OEChem::OEMolBase& query,
                                                                         const OEShapeDatabaseOptions& options) const
            OESystem::OEIterBase<OEShapeDatabaseScore> * GetSortedScores(const OEShape::OEShapeQueryPublic& shapeQry,
                                                                         const OEShapeDatabaseOptions& options = OEShapeDatabaseOptions()) const
            OESystem::OEIterBase<OEShapeDatabaseScore> * GetSortedScores(const OEShape::OEShapeQuery& shapeQry,
                                                                         const OEShapeDatabaseOptions& options = OEShapeDatabaseOptions()) const

      .. oe:language:: python

         .. oe:api:: python

            GetSortedScores(arg1: OEShapeQueryPublic,
                            options: OEShapeDatabaseOptions = OEFastROCS_OEShapeDatabaseOptions()) -> Iterable[OEFastROCS_OEShapeDatabaseScore]
            GetSortedScores(arg1: OEShapeQuery,
                            options: OEShapeDatabaseOptions = OEFastROCS_OEShapeDatabaseOptions()) -> Iterable[OEFastROCS_OEShapeDatabaseScore]
            GetSortedScores(query: Union[OEGraphMol,OEMol,OEQMol],
                            limit: int = 0) -> Iterable[OEFastROCS_OEShapeDatabaseScore]
            GetSortedScores(query: Union[OEGraphMol,OEMol,OEQMol],
                            options: OEShapeDatabaseOptions) -> Iterable[OEFastROCS_OEShapeDatabaseScore]

      Return a hitlist of the ``query`` against the database based
      upon the scoring options of the database and the
      :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` passed to this
      method. The :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` will be
      returned in descending order, i.e., the better 'hits' will come
      first in the iterator.

      The query can be either a single conformer
      :ref:`OEMolBase <OEChem_OEMolBase>`, a :ref:`OEShapeQuery <OEShape_OEShapeQuery>` or a
      :ref:`OEShapeQueryPublic <OEShape_OEShapeQueryPublic>` object read from a ``.sq``
      file. :ref:`OEShapeQuery <OEShape_OEShapeQuery>` or :ref:`OEShapeQueryPublic <OEShape_OEShapeQueryPublic>`
      objects must contain a molecule. To determine if your OEShapeQuery object
      is **FastROCS**-friendly see :oe:func:`OEShape::OEIsFastROCSShapeQuery` in the
      **Shape TK**.

      When passing an :ref:`OEMolBase <OEChem_OEMolBase>` query, the molecule must
      have 3D coordinates assigned and must have been preprocessed with
      :oe:func:`OEFastROCS::OEPrepareFastROCSMol` before calling this method.

      .. note:: 

         This method is typically used to select only a subset of the
         results based upon ``limit`` or
         :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetLimit`. It
         is optimized for rapidly constructing relatively small
         hitlists. If the entire set of scores for the database is
         desired, it can be faster to use the
         :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` to avoid
         the sorting operation.

      .. seealso:: 

         The :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` class is
         used to control many of the parameters to this method. For
         example, how many conformers per molecule to return.

   .. oe:method:: NumConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumConfs() const

      .. oe:language:: python

         .. oe:api:: python

            NumConfs() -> int

      Return the number of conformers the database is currently
      managing. Useful for getting a ballpark idea of the underlying
      memory usage.

      .. note::

         This value has no relation to the indexes returned by
         :oe:meth:`OEFastROCS::OEShapeDatabase::AddMol`, except that
         this value will always be larger than the last index
         returned.

   .. oe:method:: Open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Open(const OEChem::OEMolDatabase& moldb,
                      const unsigned int orient = OEFastROCSOrientation::Inertial)
            bool Open(const OEChem::OEMolDatabase& moldb,
                      OESystem::OEThreadedDots& dots,
                      const unsigned int orient = OEFastROCSOrientation::Inertial)

      .. oe:language:: python

         .. oe:api:: python

            Open(moldb: OEMolDatabase, orient: int) -> bool
            Open(moldb: OEMolDatabase, dots: OEThreadedDots, orient: int) -> bool

      Initialize the database using a
      :ref:`OEMolDatabase <OEChem_OEMolDatabase>`. This is the most efficient way
      to initialize a :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` as this
      method will launch an operating thread for each CPU core
      available and parallelize all the parsing and
      pre-calculation. The progress of the loading operation can be
      tracked through a thread-safe :ref:`OEThreadedDots <OESystem_OEThreadedDots>`
      object. 
      
      If using alternative start method
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs`, this
      constant needs to be passed as the final argument to the Open routine 
      so the database can be loaded without adjusting conformer coordinates. 
      The final argument can be left blank for all other use cases.

      .. warning::

         Databases must be re-opened if using :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs`

      This method will block and return ``true`` when the
      database has been successfully loaded into memory. 

      .. note::

         The indices returned by
         :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetMolIdx` are
         guaranteed to map directly into the
         :ref:`OEMolDatabase <OEChem_OEMolDatabase>` index space.
         :oe:meth:`OEChem::OEMolDatabase::GetMolecule` can fail and
         return no molecule for good reason, i.e., an empty molecule
         from an SD file. Therefore, the index space used by
         :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` can have "holes" when
         initialized from a :ref:`OEMolDatabase <OEChem_OEMolDatabase>`.

   .. oe:method:: PrintMemoryUsage

      .. oe:language:: c++ java csharp

         .. oe:api::

            void PrintMemoryUsage(OEPlatform::oeostream& os) const
            void PrintMemoryUsage() const

      .. oe:language:: python

         .. oe:api:: python

            PrintMemoryUsage(os: oeostream) -> None
            PrintMemoryUsage() -> None

      Print out memory usage statistics for this object. This will
      break down how much memory is being used to pre-cache various
      parts of the calculation. By default, the output will be written to
      :oe:const:`OEPlatform::OEPlatform::oeerr`. The output stream can also
      be passed as an argument. The diagnostic output is meant for human
      consumption and may change format in future releases. 

   .. oe:method:: SetColorGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorGridSpacing(float gridSpacing)

      .. oe:language:: python

         .. oe:api:: python

            SetColorGridSpacing(gridSpacing: float) -> bool

      Set the grid spacing to use for static color scoring. 

      .. seealso:: 

         - :oe:meth:`OEFastROCS::OEShapeDatabase::GetColorGridSpacing`

   .. oe:method:: SetDeviceToHostStrategy

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDeviceToHostStrategy(unsigned int strat)

      .. oe:language:: python

         .. oe:api:: python

            SetDeviceToHostStrategy(strat: int) -> None

   .. oe:method:: SetHostToDeviceStrategy

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHostToDeviceStrategy(unsigned int strat)

      .. oe:language:: python

         .. oe:api:: python

            SetHostToDeviceStrategy(strat: int) -> None

   .. oe:method:: SetMaxOptIterations

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxOptIterations(unsigned int maxIter)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxOptIterations(maxIter: int) -> None

      Set the number of optimizer iterations to use when optimizing
      the alignment by shape.

      .. seealso:: 

         - :oe:meth:`OEFastROCS::OEShapeDatabase::GetMaxOptIterations`

   .. oe:method:: SetNumDevices

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNumDevices(unsigned int ndevices)

      .. oe:language:: python

         .. oe:api:: python

            SetNumDevices(ndevices: int) -> None

      Set the number of GPU devices this calculation should use. This
      number should be between ``1`` and
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetMaxNumDevices`
      inclusively. This method is really only useful to efficiently
      collecting **FastROCS** scalability data across multiple
      GPUs. To restrict :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` to only
      run on a subset of GPUs on the machine, use the
      ``CUDA_VISIBLE_DEVICES`` environment variable instead before the
      process is launched.

   .. oe:method:: SetNumThreadsPerDevice

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNumThreadsPerDevice(unsigned int numThrds)

      .. oe:language:: python

         .. oe:api:: python

            SetNumThreadsPerDevice(numThrds: int) -> None

   .. oe:method:: SetNumOpenThreads

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNumOpenThreads(unsigned int numThrds)

      .. oe:language:: python

         .. oe:api:: python

            SetNumOpenThreads(numThrds: int) -> None

      Set how many CPU threads should be created to read a
      :ref:`OEMolDatabase <OEChem_OEMolDatabase>` from disk into memory using the
      :oe:meth:`OEFastROCS::OEShapeDatabase::Open` method. A value of
      ``0`` specifies that all CPUs in the system will be used. The
      value passed to this method should not exceed the value returned
      by :oe:func:`OEPlatform::OEGetNumProcessors`.

   .. oe:method:: SetShapeGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetShapeGridSpacing(float gridSpacing)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeGridSpacing(gridSpacing: float) -> bool

      Set the grid spacing to use for shape scoring and alignment. 

      .. seealso:: 

         - :oe:meth:`OEFastROCS::OEShapeDatabase::GetShapeGridSpacing`


.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEShapeDatabaseOptions, ShapeDatabaseOptions

.. _OEFastROCS_OEShapeDatabaseOptions:

.. oe:class:: OEShapeDatabaseOptions

   .. oe:api::

      class OEShapeDatabaseOptions

   This class is used to control the behavior of
   :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` and
   :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`. It allows
   setting options on a per-search basis.

   .. note::

      It is possible for the options selected in this class to not
      match the settings of the constructed
      :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` causing an error to be
      thrown.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeDatabaseOptions()
            OEShapeDatabaseOptions(const OEShapeDatabaseOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeDatabaseOptions() -> OEShapeDatabaseOptions
            OEShapeDatabaseOptions(arg2: OEShapeDatabaseOptions) -> OEShapeDatabaseOptions

      Default constructor for creating a new instance with default
      options. The copy constructor will copy all the options into a new object.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeDatabaseOptions &operator=(const OEShapeDatabaseOptions &)

      Assignment operator for making a copy of the options.

   .. _OEFastROCS_OEShapeDatabaseOptions_ClearCutoff:

      Assignment operator.

   .. oe:method:: ClearCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearCutoff()

      .. oe:language:: python

         .. oe:api:: python

            ClearCutoff() -> None

      Removes the cutoff from this set of options. The
      default is to have no cutoff value specified.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT`

   .. _OEFastROCS_OEShapeDatabaseOptions_ClearTracer:

   .. oe:method:: ClearTracer

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearTracer()

      .. oe:language:: python

         .. oe:api:: python

            ClearTracer() -> None

      Removes the progress bar tracer from this set of options.

      .. note::

         This does not release the memory of the
         :oe:meth:`OEFastROCS::OEDBTracerBase` previously passed to
         :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetTracer`.

      .. seealso::

         :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetTracer`

   .. _OEFastROCS_OEShapeDatabaseOptions_ClearUserStarts:

   .. oe:method:: ClearUserStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearUserStarts()

      .. oe:language:: python

         .. oe:api:: python

            ClearUserStarts() -> None

      Removes any user inertial starts that have been previously set. 

      .. seealso::

         :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`
         :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetUserStarts`
         :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetColorForceFieldType:

   .. oe:method:: GetColorForceFieldType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetColorForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceFieldType() -> int

   .. _OEFastROCS_OEShapeDatabaseOptions_GetColorOptimization:

   .. oe:method:: GetColorOptimization

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetColorOptimization() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorOptimization() -> bool

      Returns true if color score is being optimized in addition to shape score.

      .. seealso::
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetColorOptimization`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetCutoff:

   .. oe:method:: GetCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetCutoff() -> float

      Returns the cutoff currently set in this set of options. The
      default is a cutoff of ``0.0``, i.e., no cutoff, all scores will
      be returned.
      This is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoffLT`.

      .. note::

         This cutoff is applied to the final ranking score used. For a
         :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` database,
         that means only the "shape" score. For the default database
         type, :oe:const:`OEFastROCS::OEShapeDatabaseType::Default`,
         the cutoff is applied to the sum of the shape and color
         components
         (:oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTanimotoCombo`).

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetCutoffGT:

   .. oe:method:: GetCutoffGT

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetCutoffGT() const

      .. oe:language:: python

         .. oe:api:: python

            GetCutoffGT() -> float

      This method is identical in functionality to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoff`
      and is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoffLT`.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetCutoffLT:

   .. oe:method:: GetCutoffLT

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetCutoffLT() const

      .. oe:language:: python

         .. oe:api:: python

            GetCutoffLT() -> float

      Returns the cutoff currently set in this set of options. The
      default is no cutoff, all scores will be returned. 
      This method applies to a cutoff set using :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT`
      to retrieve results less than or equal to the cutoff value.

      .. note::

         This cutoff is applied to the final ranking score used. For a
         :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` database,
         that means only the "shape" score. For the default database
         type, :oe:const:`OEFastROCS::OEShapeDatabaseType::Default`,
         the cutoff is applied to the sum of the shape and color
         components
         (:oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTanimotoCombo`).

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetInitialOrientation:

   .. oe:method:: GetInitialOrientation

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetInitialOrientation() const

      .. oe:language:: python

         .. oe:api:: python

            GetInitialOrientation() -> int

      Returns the initial orientation to be used for the overlay optimization
      drawn from the :oe:constns:`OEFastROCS::OEFastROCSOrientation` namespace.
      The default orientation is :oe:constns:`OEFastROCS::OEFastROCSOrientation::Inertial`
      
      .. seealso::
     
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts`   .. oe:method:: GetInitialOrientation

   .. _OEFastROCS_OEShapeDatabaseOptions_GetFastROCSMode:

   .. oe:method:: GetFastROCSMode

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFastROCSMode() const

      .. oe:language:: python

         .. oe:api:: python

            GetFastROCSMode() -> int

      Returns the calculation mode to be used for the overlay optimization
      drawn from the :oe:constns:`OEFastROCS::OEFastROCSMode` namespace.
      The default mode is :oe:constns:`OEFastROCS::OEFastROCSMode::FastROCS`

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetFastROCSMode`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetLimit:

   .. oe:method:: GetLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetLimit() -> int

      Returns the number of individual molecule "hits" that will be
      returned from
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`, i.e.,
      the number of individual
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` objects that will be
      returned.

      .. note::

         This method has no effect on the
         :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` method.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetMaxConfs:

   .. oe:method:: GetMaxConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxConfs() -> int

      Returns the maximum number of conformers to return per
      molecule. By default this value is ``1`` indicating only the
      best conformer of a molecule that matched the query molecule
      will be returned as a single
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` object. The conformer
      with the highest score will be indicated by the
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetConfIdx` method.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetMaxOverlays:

   .. oe:method:: GetMaxOverlays

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxOverlays() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxOverlays() -> int

      Returns the maximum number of starting points per conformer
      overlaid. By default this value is ``1`` indicating only the
      best of all optimizations performed will be returned.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetMaxRandomTranslation:

   .. oe:method:: GetMaxRandomTranslation

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetMaxRandomTranslation() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxRandomTranslation() -> float

      Returns the maximum allowed translation when using random starting 
      orientations. The default maximum is 2 angstroms.  
 
      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetRandomSeed`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetRandomSeed`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetNumInertialStarts:

   .. oe:method:: GetNumInertialStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumInertialStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumInertialStarts() -> int

      Returns the number of inertial starts used as starting points
      for the shape optimization. The default value is ``4`` starting
      points oriented along the principle moment of inertia.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetNumStarts:

   .. oe:method:: GetNumStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumStarts() const
            unsigned int GetNumStarts(const OEChem::OEMolBase& query) const

      .. oe:language:: python

         .. oe:api:: python

            GetNumStarts() -> int
            GetNumStarts(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Returns the number of alternative starting points set
      for shape optimization. When using 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms` 
      or :oe:constns:`OEFastROCS::OEFastROCSOrientation::InertialAtColorAtoms`
      the query molecule is required by the method. 
      If alternative starts have **not** been set or 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs` is set, 
      these methods will return a value of ``1``. 

      .. seealso::
 
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearUserStarts`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetNumColorAtomStarts:

   .. oe:method:: GetNumColorAtomStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumColorAtomStarts(const OEChem::OEMolBase& query) const

      .. oe:language:: python

         .. oe:api:: python

            GetNumColorAtomStarts(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Returns the number of color atom starting points set
      for shape optimization. This method requires 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` to
      be set to 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::InertialAtColorAtoms` and
      the query molecule.
      If the query molecule does not have color atoms the search will throw a 
      warning and default to :oe:constns:`OEFastROCS::OEFastROCSOrientation::Inertial`.

      .. seealso::
 
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetNumHeavyAtomStarts:

   .. oe:method:: GetNumHeavyAtomStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumHeavyAtomStarts(const OEChem::OEMolBase& query) const

      .. oe:language:: python

         .. oe:api:: python

            GetNumHeavyAtomStarts(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Returns the number of heavy atom starting points set
      for shape optimization. This method requires 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` to
      be set to 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms` and
      the query molecule.

      .. seealso::
 
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetNumRandomStarts:

   .. oe:method:: GetNumRandomStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumRandomStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumRandomStarts() -> int

      Returns the number of random starting orientations when using the 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::Random` 
      alternative start. The default value is ``10``.
      
      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumRandomStarts`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetRandomSeed`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetRandomSeed`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetNumUserStarts:

   .. oe:method:: GetNumUserStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumUserStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumUserStarts() -> int

      Returns the number of user-defined starting points set
      for shape optimization. This method requires 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` to
      be set to 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::UserInertialStarts` and
      user-starts to have been set with 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`.

      .. seealso::
 
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearUserStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetRandomSeed:

   .. oe:method:: GetRandomSeed

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRandomSeed() const

      .. oe:language:: python

         .. oe:api:: python

            GetRandomSeed() -> int

      Returns the random seed to be used with :oe:constns:`OEFastROCS::OEFastROCSOrientation::Random`.
      The default random seed is set based on the time.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetRandomSeed`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetMaxRandomTranslation`

   .. _OEFastROCS_OEShapeDatabaseOptions_GetScoreType:

   .. oe:method:: GetScoreType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetScoreType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreType() -> int

      Returns the score type drawn from the
      :oe:constns:`OEFastROCS::OEShapeDatabaseType` namespace to be
      used for the search.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetSimFunc:

   .. oe:method:: GetSimFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSimFunc() const

      .. oe:language:: python

         .. oe:api:: python

            GetSimFunc() -> int

      Returns the type of similarity function to be used to score the
      search results. The constant type returned is either 'Tanimoto' or
      'Tversky' which is drawn from the :oe:constns:`OEFastROCS::OEShapeSimFuncType`
      namespace.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetTracer:

   .. oe:method:: GetTracer

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDBTracerBase* GetTracer() const

      .. oe:language:: python

         .. oe:api:: python

            GetTracer() -> OEDBTracerBase

      Returns a pointer to the :ref:`OEDBTracerBase <OEFastROCS_OEDBTracerBase>` to
      be used to track the progress of this search. Returns a ``NULL``
      pointer to indicate that no tracer has been registered.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetTverskyAlpha:

   .. oe:method:: GetTverskyAlpha

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTverskyAlpha() const

      .. oe:language:: python

         .. oe:api:: python

            GetTverskyAlpha() -> float

      Returns the alpha coefficient used in the Tversky similarity calculation.
      See :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetTverskyCoeffs` for
      details of how to set alpha. The default value is ``0.95``.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetTverskyBeta:

   .. oe:method:: GetTverskyBeta

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTverskyBeta() const

      .. oe:language:: python

         .. oe:api:: python

            GetTverskyBeta() -> float

      Returns the beta coefficient used in the Tversky similarity calculation.
      See :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetTverskyCoeffs` for
      details of how to set beta. The default value is ``0.05``.

   .. _OEFastROCS_OEShapeDatabaseOptions_GetUserStarts:

   .. oe:method:: GetUserStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUserStarts(vector<float>& startsCoords) const

      .. oe:language:: python

         .. oe:api:: python

            GetUserStarts(xyz: OEFloatVector) -> bool

      Fills a float vector of size ``number of starts * 3`` with the starting coordinates previously set with :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`.
      To ensure vector of the correct size is passed in as an argument, the :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts` method
      can be used to retrieve the number of starts set. 
      If successful the return value will be true. 

      .. oe:language:: c++ java csharp

      .. warning::

         Code is not available. **FastROCS TK** is supported only in Python.
      
      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearUserStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`

   .. _OEFastROCS_OEShapeDatabaseOptions_HasCutoff:

   .. oe:method:: HasCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            HasCutoff() -> bool

      Returns a boolean value indicating whether a cutoff value, at which all scores greater than
      or equal to the value will be saved and all scores less than the value will be discarded,
      has been previously registered with this set of options. By default this is ``false``, no cutoff. 
      If :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff` or :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffGT` 
      has been called already, this will return ``true``. :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`
      will set this back to ``false`` again.
      This method is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffLT`

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffGT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_HasCutoffGT:

   .. oe:method:: HasCutoffGT

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCutoffGT() const

      .. oe:language:: python

         .. oe:api:: python

            HasCutoffGT() -> bool

      This method is identical in functionality to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoff`
      and is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffLT`.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoffGT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffGT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_HasCutoffLT:

   .. oe:method:: HasCutoffLT

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCutoffLT() const

      .. oe:language:: python

         .. oe:api:: python

            HasCutoffLT() -> bool

      Returns a boolean value indicating whether a cutoff value, at which all scores less than
      or equal to the value will be saved and all scores greater than the value will be discarded,
      has been previously registered with this set of options. By default this is ``false``, no cutoffLT. 
      If :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT` 
      has been called already, this will return ``true``. :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`
      will set this back to ``false`` again.
      This method is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffGT`

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetColorForceField:

   .. oe:method:: SetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorForceField(const OEShape::OEColorForceField& cff)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceField(cff: OEColorForceField) -> bool

   .. _OEFastROCS_OEShapeDatabaseOptions_SetColorForceFieldType:

   .. oe:method:: SetColorForceFieldType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorForceFieldType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceFieldType(type: int) -> bool

   .. _OEFastROCS_OEShapeDatabaseOptions_SetColorOptimization:

   .. oe:method:: SetColorOptimization

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColorOptimization(bool ColorOptimization)

      .. oe:language:: python

         .. oe:api:: python

            SetColorOptimization(colorOptimization: bool) -> None

      Set to true to optimize over color score in addition to shape score. Default is false.

      .. note::

         optimizing over color will impact performance. A decrease in 5-20% can be expected.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetColorOptimization`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetCutoff:

   .. oe:method:: SetCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCutoff(float cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetCutoff(arg2: float) -> None

      Sets the cutoff to use when filtering the results of
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` and
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`. Only
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` objects greater than or equal to
      ``cutoff`` depending on the score type will be returned.
      This method is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT`

      .. note::

         This cutoff is applied to the final ranking score used. For a
         :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` database,
         that means only the "shape" score. For the default database
         type, :oe:const:`OEFastROCS::OEShapeDatabaseType::Default`,
         the cutoff is applied to the sum of the shape and color
         components
         (:oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTanimotoCombo`).

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoff`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetCutoffGT:

   .. oe:method:: SetCutoffGT

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCutoffGT(float cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetCutoffGT(arg2: float) -> None

      This method is identical in functionality to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff`
      and is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT`. 

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetCutoffLT:

   .. oe:method:: SetCutoffLT

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCutoffLT(float cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetCutoffLT(arg2: float) -> None

      Sets the cutoff to use when filtering the results of
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` and
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`. Only
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` objects less than or equal to
      ``cutoff`` depending on the score type will be returned.

      This method is mutually exclusive to :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoff`.

      .. note::

         This cutoff is applied to the final ranking score used. For a
         :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` database,
         that means only the "shape" score. For the default database
         type, :oe:const:`OEFastROCS::OEShapeDatabaseType::Default`,
         the cutoff is applied to the sum of the shape and color
         components
         (:oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTanimotoCombo`).

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::HasCutoffLT`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::ClearCutoff`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetFastROCSMode:

   .. oe:method:: SetFastROCSMode

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFastROCSMode(unsigned int FRMode)

      .. oe:language:: python

         .. oe:api:: python

            SetFastROCSMode(FRMode: int) -> None

      Sets the calculation mode to be used for the overlay optimization
      drawn from the :oe:constns:`OEFastROCS::OEFastROCSMode` namespace.
      The default mode is :oe:constns:`OEFastROCS::OEFastROCSMode::FastROCS`

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetFastROCSMode`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetInitialOrientation:

   .. oe:method:: SetInitialOrientation

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetInitialOrientation(unsigned int orient)

      .. oe:language:: python

         .. oe:api:: python

            SetInitialOrientation(orient: int) -> bool

      Set the initial orientation to be used for optimization of the overlap. The options are 
      drawn from the :oe:constns:`OEFastROCS::OEFastROCSOrientation` and the default is 
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::Inertial`. If user-defined inertial starts
      are to be used then the starting coordinates must be set using the :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`
      method. Returns true if successful. 

      .. seealso::
        
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetNumRandomStarts:

   .. oe:method:: SetNumRandomStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNumRandomStarts(unsigned int numStarts)

      .. oe:language:: python

         .. oe:api:: python

            SetNumRandomStarts(numStarts: int) -> bool

      Set the number of random starting orientations when using the :oe:constns:`OEFastROCS::OEFastROCSOrientation::Random` 
      alternative start. The default value is ``10``.
      
      .. warning::

         Search speed and the amount of RAM required are proportional to the number of starting orientations therefore
         speed & memory degradation are to be expected if searching with a large number of random
         starting orientations.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumRandomStarts`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetRandomSeed`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetRandomSeed`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetLimit:

   .. oe:method:: SetLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLimit(unsigned int limit)

      .. oe:language:: python

         .. oe:api:: python

            SetLimit(limit: int) -> None

      Set the number of individual
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` objects that will be
      returned by
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`. This is
      a hard limit regardless of the multiplicative effect of also
      setting the
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxConfs` and
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxOverlays`
      methods to values greater than ``1``.

      .. note::

         This method has no effect on the
         :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` method.

   ..   _

   .. _OEFastROCS_OEShapeDatabaseOptions_SetMaxConfs:

   .. oe:method:: SetMaxConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxConfs(unsigned int maxConfs)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxConfs(maxConfs: int) -> None

      Set how many conformers per molecule should be returned in the
      results. The default value is ``1``, only the best conformer for
      each database molecule will be returned as an
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` object. The conformer
      with the highest score will be indicated by the
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetConfIdx` method.

      Setting this value to ``0`` means all database conformers will
      be returned for every molecule in the database.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetMaxOverlays:

   .. oe:method:: SetMaxOverlays

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxOverlays(unsigned int maxOverlaysToReturn)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxOverlays(maxOverlaysToReturn: int) -> None

      Set how many starting points to return per conformer in the
      database. The default value is ``1``, only the best starting
      point for the conformer will be returned as an
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` object.

      Setting this value to ``0`` means all the starting points will
      be returned, i.e., there will be
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumInertialStarts`
      objects returned.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetMaxRandomTranslation:

   .. oe:method:: SetMaxRandomTranslation

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxRandomTranslation(float trans)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxRandomTranslation(trans: float) -> bool

      Set the maximum allowed translation for each random orientation. The
      default is 2 angstroms. This method requires 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` to
      be set to :oe:constns:`OEFastROCS::OEFastROCSOrientation::Random`. 

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetRandomSeed`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetRandomSeed`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetNumInertialStarts:

   .. oe:method:: SetNumInertialStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNumInertialStarts(unsigned int numStarts)

      .. oe:language:: python

         .. oe:api:: python

            SetNumInertialStarts(numInertialStarts: int) -> None

      Set how many starting points the shape optimization will
      use. Currently, only values between ``1`` and ``8`` inclusive
      can be set. The default value is ``4``, i.e., assume there is a
      dominant moment of inertia for both the query and database
      conformer. Setting this value higher can yield better global
      overlays. However, there is a direct linear relation between the
      performance of **FastROCS TK** and the number of starting
      points.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetRandomSeed:

   .. oe:method:: SetRandomSeed

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRandomSeed(unsigned int seed)

      .. oe:language:: python

         .. oe:api:: python

            SetRandomSeed(seed: int) -> bool

      Sets the random seed to be used with :oe:constns:`OEFastROCS::OEFastROCSOrientation::Random`.
      Returns true if successfully set. The default random seed is set based on the time.

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetRandomSeed`
         - :oe:constns:`OEFastROCS::OEFastROCSOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumRandomStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxRandomTranslation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetMaxRandomTranslation`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetScoreType:

   .. oe:method:: SetScoreType

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetScoreType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreType(type: int) -> None

      Sets which scores to perform during the search. The constant
      ``type`` should be drawn from the
      :oe:constns:`OEFastROCS::OEShapeDatabaseType` namespace.

      .. note::

         The score type must be a proper subset of the score enabled
         during :oe:meth:`OEShapeDatabase construction
         <OEFastROCS::OEShapeDatabase::Constructors>`. That means if
         the database was started in "shape only" mode, this value can
         not include :oe:const:`OEFastROCS::OEShapeDatabaseType::Color`.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetSimFunc:

   .. oe:method:: SetSimFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSimFunc(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetSimFunc(type: int) -> None

      Sets which type of similarity function to use to score search results.
      The constant type should be either "Tanimoto" or "Tversky" and should be
      drawn from the :oe:constns:`OEFastROCS::OEShapeSimFuncType`.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetTracer:

   .. oe:method:: SetTracer

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTracer(OEDBTracerBase& tracer)

      .. oe:language:: python

         .. oe:api:: python

            SetTracer(tracer: OEDBTracerBase) -> None

      Register a progress bar tracer with this set of options. The
      ``tracer`` will be updated with a count as chunks of the
      database are processed. It is very important that the
      implementation of :ref:`OEDBTracerBase <OEFastROCS_OEDBTracerBase>` is
      thread-safe as it will be updated from multiple threads
      simultaneously. It is also expected that the consumer of the
      progress bar will be operating in a separate thread to avoid
      wasting search thread time on progress update overhead.

      .. warning::

         The user must take care to keep the ``tracer`` in scope
         during the full duration of the
         :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
         :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`
         call. The options object will not make a copy of the tracer
         at all, merely storing a pointer to the ``tracer``. If the
         ``tracer`` is prematurely ``deleted``, this will very likely
         result in a crash. Probably in a non-deterministic way due to
         the threading involved.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetTverskyCoeffs:

   .. oe:method:: SetTverskyCoeffs

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTverskyCoeffs(float alpha, float beta)

      .. oe:language:: python

         .. oe:api:: python

            SetTverskyCoeffs(alpha: float = 0.95, beta: float = 0.05) -> None

      Sets the alpha and beta coefficients to be used in the Tversky similarity
      calculation. See the :ref:`molecular_shape_section` section in the
      **Shape TK** theory documentation for a description of how this is calculated.
      Default values for alpha and beta are 0.95 and 0.05, respectively.
      Any new values of alpha and beta can be chosen provided they add up to 1.00.

   .. _OEFastROCS_OEShapeDatabaseOptions_SetUserStarts:

   .. oe:method:: SetUserStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUserStarts(vector<float>& startsCoords,
                               unsigned int numStarts)

      .. oe:language:: python

         .. oe:api:: python

            SetUserStarts(startsCoords: OEFloatVector, numStarts: int) -> bool

      Sets the user-defined starting coordinates. The arguments are a vector of floats of
      length 3 * the number of starting points (x, y and z coordinates for each start) -
      ``startsCoords`` and the number of starting coordinates in an unsigned int variable - ``numStarts``. 

      .. warning::
      
         Currently, error checking is not performed for user-defined starting coordinates that fall out
         of scope of the molecule's coordinate range therefore, bad starting coordinates will yield
         zero shape/color overlap. It is the responsibility of the user to ensure sensible 
         starting coordinates.

      The following code snippet shows how to use :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
      and :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts` in a python example.

      .. oe:source:: OEShapeDatabaseOptions_SetUserStarts.py 
         :language:  python
         :noindent:
         :frag:      SNIPPET-SET-USER-STARTS

      :ref:`Full listing. <listing-OEShapeDatabaseOptions_SetUserStarts.py>`

      .. seealso::

         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`
         - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetUserStarts`

   .. _OEFastROCS_OEShapeDatabaseOptions_SetShapeScoreScale:

   .. oe:method:: SetShapeScoreScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetShapeScoreScale(float scale)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeScoreScale(scale: float) -> None

      Set a scale factor for the shape component, defaults to 1.0

   .. _OEFastROCS_OEShapeDatabaseOptions_SetColorScoreScale:

   .. oe:method:: SetColorScoreScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColorScoreScale(float scale)

      .. oe:language:: python

         .. oe:api:: python

            SetColorScoreScale(scale: float) -> None

      Set a scale factor for the color component, defaults to 1.0

   .. _OEFastROCS_OEShapeDatabaseOptions_GetShapeScoreScale:

   .. oe:method:: GetShapeScoreScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetShapeScoreScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeScoreScale() -> float

      Gets the scale factor for the shape component

   .. _OEFastROCS_OEShapeDatabaseOptions_GetColorScoreScale:

   .. oe:method:: GetColorScoreScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColorScoreScale(float scale)

      .. oe:language:: python

         .. oe:api:: python

            GetColorScoreScale() -> float

      Gets the scale factor for the color component

   .. Ignored as causes a performance slow-down so should only be used in the event
      that the perception of progress is more important than the performance.
   .. oe:method: GetSortLargest

      .. oe:api::

         bool GetSortLargest() const

      Returns true if set to sort the chunks in descending order (default) and false if
      set to sort the chunks in ascending order. This is good to improve the response
      time of a progress bar in a web interface scenario however, causes a performance
      slow-down.

   .. Ignored as causes a performance slow-down so should only be used in the event
      that the perception of progress is more important than the performance.
   .. oe:method: SetSortLargest

      .. oe:api::

         void SetSortLargest(bool sortLargest)

      Set to false if set to sort the chunks in ascending order.
      This is good to improve the response time of a progress bar in a web interface
      scenario however, causes a performance slow-down. Default is true (descending order).


.. oe:namespace:: OEFastROCS

.. sizeof(OEShapeDatabaseScore) = 48 bytes
.. sizeof(OEBestOverlayScore) = 96 bytes
.. probably not worth the difference... 

.. meta::
   :keywords: OEShapeDatabaseScore, ShapeDatabaseScore

.. _OEFastROCS_OEShapeDatabaseScore:

.. oe:class:: OEShapeDatabaseScore

   .. oe:api::

      class OEShapeDatabaseScore

   This object is used to represent the result of a **FastROCS TK**
   calculation returned by the
   :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` and
   :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` methods.

   It encapsulates the following information:

   - Score information:

     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorTanimoto`
     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeTanimoto`
     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTanimotoCombo`
     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorTversky`
     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeTversky`
     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTverskyCombo`
     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorScore`
     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeScore`
     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetScore`

   - Overlay recreation:

     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetQuat`
     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetRotMatrix`
     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTranslation`
     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::Transform`

   - Molecule retrieval:
     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetMolIdx`
     * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetConfIdx`

   .. _fastrocs_molecule_transforms_warning:
       
   .. warning:: 

      The molecular transforms returned by
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetQuat`,
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetRotMatrix`, and
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTranslation`
      assume the conformer has already been aligned by
      :oe:func:`OEFastROCS::OESetCoordsToInertialFrame`.

      While it was definitely in-elegant to require calling
      :oe:func:`OEFastROCS::OESetCoordsToInertialFrame` in order to
      reproduce overlays, this allows
      :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` to not store 28 bytes of
      memory per conformer, a significant space savings, especially
      when conformers are stored in rotor-compressed form.

      Overlays are usually only required for a small number of
      conformations, so re-calculating this for only the "hits" is a
      small price to pay for potentially saving gigabytes of memory on
      an already memory constrained problem. 

      Users should prefer to use the
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::Transform` directly
      to avoid having to deal with this subtlety, it will
      automatically do all the transformations necessary to generate
      overlays.

     
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeDatabaseScore(size_t molIdx, unsigned int confIdx,
                                 float shapeScore, float colorScore,
                                 const float* quat,
                                 unsigned int csimFunc = OEShapeSimFuncType::Default,
                                 unsigned int orient = OEFastROCSOrientation::Default)
            OEShapeDatabaseScore(size_t molIdx, unsigned int confIdx,
                                 float shapeScore, float colorScore,
                                 const double* quat,
                                 unsigned int csimFunc = OEShapeSimFuncType::Default,
                                 unsigned int orient = OEFastROCSOrientation::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeDatabaseScore(molIdx: int, confIdx: int, shapeScore: float,
                                 colorScore: float, quat: OEFloatArray,
                                 csimFunc: int, orient: int) -> OEShapeDatabaseScore
            OEShapeDatabaseScore(molIdx: int, confIdx: int, shapeScore: float,
                                 colorScore: float, quat: OEDoubleArray,
                                 csimFunc: int, orient: int) -> OEShapeDatabaseScore

      Constructs a new score object with the specified data. Typically
      only used by the internals of **FastROCS TK** in order to
      populate the hitlist.

      .. warning::
     
         The constructor has changed in order to support 
         :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs`. The constant 
         :oe:constns:`OEFastROCS::OEFastROCSOrientation::Default`, drawn from the 
         :oe:constns:`OEFastROCS::OEFastROCSOrientation` namespace, has been added to the argument
         list. The default is :oe:constns:`OEFastROCS::OEFastROCSOrientation::Inertial` and the 
         last argument should be left blank unless it is intended to use 
         :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs` starts on the database being loaded,
         in which case ``unsigned int orient=OEFastROCSOrientation::AsIs`` should be passed to the
         constructor. 

      .. warning:: 

         The constructor has changed in order to support Tversky scoring. The constant
         "OEShapeSimFuncType::Default", drawn from the :oe:constns:`OEFastROCS::OEShapeSimFuncType` 
         namespace, has been added to the argument list. The default is "Tanimoto". "Tversky"
         scoring is chosen by passing :oe:constns:`OEFastROCS::OEShapeSimFuncType::Tversky` and
         setting :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetSimFunc` to "Tversky". 

   .. oe:method:: GetColorScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetColorScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorScore() -> float

      Returns the “color” component of the score used for ranking molecules by **FastROCS TK**. 
      See the :ref:`molecular_shape_section` section of the **ShapeTK** theory documentation 
      for a description of the calculation. This function should be used in conjunction with 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetSimFunc` in order to determine which 
      similarity function ("Tanimoto" or "Tversky") was used to calculate the scores. This function
      will return ``0.0`` if the search was requested to be "shape only", i.e., only
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` was specified.
 

   .. oe:method:: GetColorTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetColorTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorTanimoto() -> float

      Returns the "color" component of the Tanimoto score used for ranking
      molecules by **FastROCS TK**. See the
      :ref:`shapetk_color_features` section in the **Shape TK** theory
      documentation for a description of what the "color" term is. This function
      will return ``0.0`` if the search was requested to be "shape
      only", i.e., only
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` was
      specified.

      .. note:: 

         A color tanimoto of ``0.0`` is also possible if either the
         query or database molecule does not contain any color
         atoms. Even more surprising is that this value can sometimes
         exceed ``1.0``, which appears to violate the definition of
         "tanimoto". This is due to the first-order-gaussian
         approximation used, i.e, intersection volumes are not
         actually subtracted out since they have little effect on
         virtual screening performance and would be significantly more
         costly to calculate. Typically, these cases are limited to
         complex cage systems like cubane that have many overlapping
         "ring" color atoms that heavily overlap. The use of the
         "ring" color term can be customized by using a custom color
         field specified through the :oe:meth:`OEShapeDatabase
         constructor<OEFastROCS::OEShapeDatabase::Constructors>`.

   .. oe:method:: GetColorTversky

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetColorTversky() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorTversky() -> float

      Returns the "color" component of the Tversky score used for ranking
      molecules by **FastROCS TK**. See the
      :ref:`shapetk_color_features` section in the **Shape TK** theory
      documentation for a description of what the "color" term is. This function
      will return ``0.0`` if the search was requested to be "shape
      only", i.e., only
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` was
      specified. If "Tversky" scoring was not set using
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetSimFunc` prior to the search
      this function will return with an error.
 
   .. oe:method:: GetConfIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetConfIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfIdx() -> int

      Returns the conformer's index of the matching conformer for this
      particular score. This index will match the index returned by
      the :oe:meth:`OEChem::OEConfBase::GetIdx` method. This allows
      retrieving the conformer from the
      :oe:meth:`OEChem::OEMCMolBase::GetConf` method using the
      :oe:cls:`OEHasConfIdx<OEChem::OEHasIdx>` predicate like the
      following:

      .. code:: python

         conf = mol.GetConf(OEHasIdx(score.GetConfIdx()))

   .. oe:method:: GetMolIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t GetMolIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolIdx() -> int

      Returns the molecule index that returned this particular
      "score". This index maps to the indices used by
      :ref:`OEMolDatabase <OEChem_OEMolDatabase>` to retrieve molecules assuming
      the :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` was initialized with
      the :oe:meth:`OEFastROCS::OEShapeDatabase::Open` method. This
      allows **FastROCS TK** to rely on disk-based storage through
      :ref:`OEMolDatabase <OEChem_OEMolDatabase>` to retrieve overlays and provide
      connection tables, a significant memory space savings. However,
      this does come at the added latency and computational expense of
      the :oe:meth:`OEChem::OEMolDatabase::GetMolecule` method. 

      To allow for use cases other than virtual screening where only a
      small number of "hits" need to be sent on for further
      processing. This index may map to the index returned by the
      :oe:meth:`OEFastROCS::OEShapeDatabase::AddMol` method. It is up
      to the user to decide how to store the
      :ref:`OEMCMolBase <OEChem_OEMCMolBase>` for later access. Previously
      versions of **FastROCS TK** used
      :oe:const:`OEChem::OEMCMolType::OEDBMCMol` molecules for this
      purpose.

   .. oe:method:: GetQuat

      .. oe:language:: c++ java csharp

         .. oe:api::

            const float* GetQuat() const

      .. oe:language:: python

         .. oe:api:: python

            GetQuat() -> OEFloatArray

      .. warning:: 
      
         It will be easier to use the
         :oe:meth:`OEFastROCS::OEShapeDatabaseScore::Transform` method
         than to use figure out how to use the data from this
         function.

      Returns a pointer to a 7-element quaternion that can be used to
      overlay the database conformer represented by this score with
      the query conformation. This 7-element quaternion contains both
      the rotation and translational components: the first 4 elements
      being the quaternion rotation; the second 3 elements are the
      translational component.

      .. warning::

         Read :ref:`FastROCS transforms
         warning<fastrocs_molecule_transforms_warning>` above about
         performing overlays with these more advanced methods. 

   .. oe:method:: GetRotMatrix

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRotMatrix(float* rmat) const

      .. oe:language:: python

         .. oe:api:: python

            GetRotMatrix(rmat: OEFloatArray) -> bool

      .. warning:: 
      
         It will be easier to use the
         :oe:meth:`OEFastROCS::OEShapeDatabaseScore::Transform` method
         than to use figure out how to use the data from this
         function.

      Fills in the 9-element rotation matrix ``rmat`` with the
      rotation component needed to overlay the database conformer
      represented by this score with the query conformation. Returns
      ``false`` if the rotation matrix is ill-defined, i.e., the
      conversion from the underlying quaternion failed. 

      .. warning::

         Read :ref:`FastROCS transforms
         warning<fastrocs_molecule_transforms_warning>` above about
         performing overlays with these more advanced methods. 

   .. oe:method:: GetScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetScore() -> float

      Returns the sum of the "shape" and "color" scores. This function
      should be used in conjunction with :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetSimFunc`
      in order to determine which similarity function ("Tanimoto" or "Tversky") was used
      to calculate the scores.

   .. oe:method:: GetShapeScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetShapeScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeScore() -> float

      Returns the “shape” component of the score used for ranking molecules by **FastROCS TK**. 
      See the :ref:`molecular_shape_section` section of the **Shape TK** theory documentation 
      for a description of the calculation. This function should be used in conjunction with 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetSimFunc` in order to determine which 
      similarity function ("Tanimoto" or "Tversky") was used to calculate the scores.

      Currently, it is not possible to request a "color only"
      calculation from **FastROCS TK**. Therefore, this function should
      always be greater than ``0.0``. A value of ``0.0`` would be a
      molecule with no volume, which is impossible. 

   .. oe:method:: GetShapeTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetShapeTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeTanimoto() -> float

      Returns the "shape" component of the tanimoto score used for ranking
      molecules by **FastROCS TK**. See the
      :ref:`molecular_shape_section` section in the **Shape TK**
      theory documentation for a description of how this is calculated. 

      Currently, it is not possible to request a "color only"
      calculation from **FastROCS TK**. Therefore, this function should
      always be greater than ``0.0``. A value of ``0.0`` would be a
      molecule with no volume, which is impossible. 

      .. note:: 

         It is possible, though rare, to see values slightly greater
         than ``1.0`` in the 2nd decimal place. This is due to the
         approximation **FastROCS TK** uses for performance and can be
         disregarded, especially since they usually only occur
         whenever a molecule is matched against itself.
      

   .. oe:method:: GetShapeTversky

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetShapeTversky() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeTversky() -> float

      Returns the "shape" component of the tversky score used for ranking
      molecules by **FastROCS TK**. See the
      :ref:`molecular_shape_section` section in the **Shape TK**
      theory documentation for a description of how this is calculated. 
      If "Tversky" scoring was not set using
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetSimFunc` prior to the search
      this function will return with an error.

      As with the "Tanimoto" scoring option, it is not currently 
      possible to request a “color only” calculation from **FastROCS TK**. 
      Therefore, this function should always be greater than ``0.0``. 
      If this is not the case an error has occurred.

      .. note:: 

         It is possible, though rare, to see values slightly greater
         than ``1.0`` in the 2nd decimal place. This is due to the
         approximation **FastROCS TK** uses for performance and can be
         disregarded, especially since they usually only occur
         whenever a molecule is matched against itself.
      
   .. oe:method:: GetSimFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSimFunc() const

      .. oe:language:: python

         .. oe:api:: python

            GetSimFunc() -> int

      Returns a constant from the :oe:constns:`OEFastROCS::OEShapeSimFuncType`
      namespace indicating what type of similarity function, "Tanimoto" or "Tversky", 
      is being used for scoring.

   .. oe:method:: GetTanimotoCombo

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTanimotoCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimotoCombo() -> float

      Returns the sum of the "color" and "shape" tanimotos. 

   .. oe:method:: GetTranslation

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetTranslation(float* trans) const

      .. oe:language:: python

         .. oe:api:: python

            GetTranslation(trans: OEFloatArray) -> bool

      .. warning:: 
      
         It will be easier to use the
         :oe:meth:`OEFastROCS::OEShapeDatabaseScore::Transform` method
         than to use figure out how to use the data from this
         function.

      Fills in the 3-element vector ``trans`` with the translation
      component needed to overlay the database conformer represented
      by this score with the query conformation. Returns ``false`` if
      the translation is ill-defined, i.e., something went horribly
      wrong.

      .. warning::

         Read :ref:`FastROCS transforms
         warning<fastrocs_molecule_transforms_warning>` above about
         performing overlays with these more advanced methods. 

   .. oe:method:: ExtractTransform

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ExtractTransform(OETrans& transform, OEChem::OEMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            ExtractTransform(transform: OETrans,
                             dbmol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Fills in the :ref:`OETrans <OEChem_OETrans>` object with the translation and rotation
      matrix necessary to transform mol onto the query. Note that
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::Transform` is the preferred method for
      visualizing overlays. This method is available for the case in which you need to know
      exactly what transform was performed. For example, when you want to use the same transform
      on another molecule.

   .. oe:method:: GetTverskyCombo

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTverskyCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetTverskyCombo() -> float

      Returns the sum of the "color" and "shape" Tversky scores. If "Tversky" scoring 
      was not set using :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetSimFunc` prior to the search
      this function will return with an error.

   .. oe:method:: Transform

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Transform(OEChem::OEMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            Transform(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Overlays the conformer represented by ``mol`` with the query
      conformation passed as the query to
      :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>`. This overlay will be the
      orientation that was used to calculate the scores returned by
      the rest of this class. 

      .. seealso:: 

         This is the preferred method for generating overlays with
         **FastROCS TK**. There is a more complete description of the
         process and its subtleties above in the :ref:`FastROCS transforms
         warning<fastrocs_molecule_transforms_warning>`.


.. _OEFastROCSConstants:

********************
OEFastROCS Constants
********************

.. oe:namespace:: OEFastROCS

.. toctree::

   OEFastROCSOrientation
   OEFastROCSReturnCode
   OEShapeDatabaseType
   OEShapeSimFuncType
   OEFastROCSMode


.. oe:namespace:: OEFastROCS

.. oe:constnamespace:: OEFastROCSOrientation 

   The **FastROCS TK** search algorithm performs an optimization to maximize
   the overlap between the query and the database molecule. This namespace
   defines a set of initial orientations for the optimization that are also
   referred to as alternative starts.  The default orientation is
   :oe:const:`OEFastROCS::OEFastROCSOrientation::Inertial`, which can also
   be accessed via :oe:const:`OEFastROCS::OEFastROCSOrientation::Default`. 
   As the optimization has a limited number of iterations, it may be
   beneficial to use alternative starting coordinates for some molecular
   systems.  To set an alternative initial orientation
   use :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`.

   At present there are 7 initial orientations available: 

      - :oe:const:`OEFastROCS::OEFastROCSOrientation::Inertial` 
      - :oe:const:`OEFastROCS::OEFastROCSOrientation::UserInertialStarts`
      - :oe:const:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`
      - :oe:const:`OEFastROCS::OEFastROCSOrientation::InertialAtColorAtoms`
      - :oe:const:`OEFastROCS::OEFastROCSOrientation::AsIs`
      - :oe:const:`OEFastROCS::OEFastROCSOrientation::Random`
      - :oe:const:`OEFastROCS::OEFastROCSOrientation::Subrocs`

   .. seealso::

      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`
      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetUserStarts`
      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts`
      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumUserStarts`
      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumHeavyAtomStarts`
      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumColorAtomStarts`

   .. oe:constant:: Default
   
      The default orientation is
      :oe:const:`OEFastROCS::OEFastROCSOrientation::Inertial`.

   .. oe:constant:: Inertial
  
      The query and the database molecule are aligned to the inertial frame
      and optimizations are performed for 4 inertial orientations of the
      database molecule, by rotating about its 2 major moments of inertia. 

   .. oe:constant:: UserInertialStarts
 
      The database molecule is translated to each user-defined starting
      position and optimizations are performed for 4 inertial starts for
      each translation.  See
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` and 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts` for
      more details on setting the starting coordinates. 

   .. warning::
      
      Currently, error checking is not performed for user-defined starting
      coordinates that fall out of scope of the molecule's coordinate range
      therefore, bad starting coordinates will yield zero shape/color overlap.
      
   .. oe:constant:: InertialAtHeavyAtoms
 
      The database molecule is translated to each heavy atom of the query
      molecule and optimizations are performed for 4 inertial starts
      for each translation.   
      See
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` and 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`

   .. oe:constant:: InertialAtColorAtoms
 
      The database molecule is translated to each color atom of the
      query molecule and 
      optimizations are performed for 4 inertial starts for each translation.   
      This method works for combo and shape-only searches. The only
      requirement is that the query molecule has color atoms. If the query
      molecule does not have color atoms the search will default to
      :oe:constns:`OEFastROCS::OEFastROCSOrientation::Inertial`.
      See :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`, 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation` and
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumColorAtomStarts`.

   .. oe:constant:: AsIs
 
      The query and database molecules are left ``AsIs``. It is presumed
      that the conformers are already positioned in space (perhaps through
      docking) therefore they are not centered or set to the inertial frame
      of reference. This method carries out a single
      optimization at the query and database molecule's original coordinates.
      No inertial orientations are optimized. 

      .. warning::
 
        In order to use this method on a database the entire database is
        required to be reloaded with the
        :oe:meth:`OEFastROCS::OEShapeDatabase::Open` or
        :oe:meth:`OEFastROCS::OEShapeDatabase::AddMol` routine using
        ``unsigned int orient=OEFastROCSOrientation::AsIs`` as the
        last argument. 

      .. warning::

        In order to use the
        :oe:meth:`OEFastROCS::OEShapeDatabaseScore::Constructors` with 
        this method it is required that the final argument to the constructor
        be ``unsigned int orient=OEFastROCSOrientation::AsIs``.

      See :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`, 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`,
      :oe:meth:`OEFastROCS::OEShapeDatabase::Open` and
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::Constructors`.
      
   .. oe:constant:: Random 

      N random starts are generated by randomly orientating the database molecule
      N times. This method includes the ability to set the maximum random 
      translation via the :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxRandomTranslation`,
      option. The default maximum is ``2`` angstroms. 
      The number of random starts can be set using the 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumRandomStarts` option. The default number 
      of random starts is ``10``. 
      The random seed can be set using the :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetRandomSeed`. 
      The default random seed is based on the time.   

      .. warning::

       The random API point is only deterministic when using the same seed if only 
       one thread  is set to open the database using :oe:meth:`OEFastROCS::OEShapeDatabase::SetNumOpenThreads` 
       between calls to GetScores or GetScores is called on the same opened database object.

      See :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxRandomTranslation`
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetMaxRandomTranslation`
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumRandomStarts`
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumRandomStarts`
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetRandomSeed`
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetRandomSeed`

   .. oe:constant:: Subrocs 

      Optimizations are carried for each inertial orientation at each heavy atom of the molecule with the
      most heavy atoms regardless of whether it is the query or the database molecule. This method is synonymous
      with :oe:const:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`.

      See :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` 
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation`

   See the :ref:`starts_for_optimization` section in the **Shape TK**
   theory documentation for a description of alternative starts. 


.. oe:namespace:: OEFastROCS

.. oe:constnamespace:: OEFastROCSMode

   This namespace can be used to activate "ROCS" mode, which will result in scores that are
   more directly comparable to ROCS.  The default option is
   :oe:constns:`OEFastROCS::OEFastROCSMode::FastROCS`.  ROCS mode is set using the
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetFastROCSMode` member function of
   :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>`.

   .. seealso::

      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetFastROCSMode`
      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetFastROCSMode`

   .. oe:constant:: Default 

      The default calculation mode is :oe:constns:`OEFastROCS::OEFastROCSMode::FastROCS`

   .. oe:constant:: FastROCS

      Set :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` to instruct
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` to
      calculate scores normally.

   .. oe:constant:: ROCS

      Set :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` to instruct
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` to
      calculate scores for search results more similar to
      ROCS.

   .. warning::

      setting :oe:constns:`OEFastROCS::OEFastROCSMode::ROCS` will impact performance.
      Between 5-20% performance decrease should be expected.



.. oe:namespace:: OEFastROCS

.. oe:constnamespace:: OEFastROCSReturnCode 

   This namespace contains constants returned by :oe:func:`OEFastROCS::OEFastROCSGPUStatus`
   to indicate the status of the GPU. 

   .. seealso::

      - :oe:func:`OEFastROCS::OEFastROCSGPUStatus`

   .. oe:constant:: Success 
   
      The API call returned with no errors. The GPU is ready.

   .. oe:constant::ErrorInvalidValue 

      GPU is not available or present. 

   .. oe:constant:: InitializationError 
 
      The CUDA driver and runtime could not be initialized.
 
   .. oe:constant:: InsufficientDriver 

      The NVIDIA CUDA driver is older than the CUDA runtime library. This is not a 
      supported configuration. Users should install an updated NVIDIA display 
      driver to allow the application to run. 

   .. oe:constant:: NoDevice
   
      No CUDA-capable devices were detected by the installed CUDA driver.    

   .. oe:constant:: NoDeviceDetected 
      
      No CUDA-capable devices were detected by the installed CUDA driver.  
  
   .. oe:constant:: NotPermitted

      The attempted operation is not permitted.

   .. oe:constant:: Unknown 
      
      Unknown failure. 
 


.. oe:namespace:: OEFastROCS

.. oe:constnamespace:: OEShapeDatabaseType

   This namespace is used to control whether a
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object should store the data
   necessary to calculate the following components of the output
   score:
   :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeTanimoto` and
   :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorTanimoto`. Each
   component has an associated memory and calculation overhead that
   can be avoided is desired. For example, passing
   :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` to the
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` constructor will cut memory
   consumption roughly in half and skip calculating static color scores.

   .. seealso::

      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::Constructors`
      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetScoreType`

   .. oe:constant:: Color

      Instructs :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` to cache the
      necessary color information so that a subsequent search with
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` will
      yield color scores. It is possible to pass this value into the
      :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` constructor and then turn
      it off for searches so the same database can be used for
      shape-only and shape+color searches. To turn off the color term
      for only a specific search, pass
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` into the
      :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetScoreType`
      method, then pass that options object into either
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
      :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`.

   .. oe:constant:: Combo

      The combination of
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` and
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Color` as a
      convenience using the name most often used. This is a synonym of
      :oe:const:`OEFastROCS::OEShapeDatabaseType::Default`.

   .. oe:constant:: Default

      The default setting for :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` is
      to calculate both "Color" and "Shape" scores.  The combination
      of both scores shows very good results for virtual screening
      performance.

   .. oe:constant:: Shape

      Must be specified as part of the
      :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` constructor or as a term
      in the :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>`
      class.

      .. warning::

         Color-only functionality is currently not supported.

   .. oe:constant:: Sitehopper

      Must be specified as part of the
      :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` constructor to run a
      Sitehopper calculation.

      .. warning::
         Sitehopper functionality requires a Sitehopper license in
         addition to a FastROCS license.


.. oe:namespace:: OEFastROCS

.. oe:constnamespace:: OEShapeSimFuncType

   This namespace is used to set which similarity function,
   'Tanimoto' or 'Tversky', :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` objects use to score search
   results.  The default option is :oe:constns:`OEFastROCS::OEShapeSimFuncType::Tanimoto`.
   Tversky scoring is set using the :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetSimFunc`
   member function of :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>`.

   .. note::
 
      Tanimoto and Tversky scoring options are mutually exclusive therefore, 
      whichever function was previously selected before performing a search 
      will be the one used to calculate the subsequent score. If no function
      is set the default function is used. 
 
   .. seealso::

      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetSimFunc`
      - :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetSimFunc`

   .. oe:constant:: Default 

      Set :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` to instruct
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` to
      calculate scores for search results using the tanimoto similarity
      function. See :oe:constns:`OEFastROCS::OEShapeSimFuncType::Tanimoto` for more
      details on usage.

   .. oe:constant:: Tanimoto

      Set :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` to instruct
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` to
      calculate scores for search results using the tanimoto similarity
      function.
      To retrieve the "shape" tanimoto score use either
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeTanimoto` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeScore`.
      To retrieve the "color" tanimoto score use either
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorTanimoto` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorScore`.
      To retrieve the combined "shape" and "color" tanimoto scores use either
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTanimotoCombo` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetScore`.

   .. oe:constant:: Tversky

      Set :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` to instruct
      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` to
      calculate scores for search results using the tversky similarity
      function.
      To retrieve the "shape" tversky score use either
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeTversky` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeScore`.
      To retrieve the "color" tversky score use either
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorTversky` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorScore`.
      To retrieve the combined "shape" and "color" tversky scores use either
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTverskyCombo` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetScore`.

   .. warning::

      If using the :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorScore`, 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeScore` or 
      :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetScore` methods to retrieve scores it
      is advised that the :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetSimFunc` method
      is used to determine which similarity function the scores were calculated with. 

   .. note::

      See :oe:constns:`OEFastROCS::OEShapeDatabaseType` for details 
      of how to set :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` to
      store only "shape" scores or both "shape" and "color" scores. 

   .. warning::

      Color-only functionality is currently not supported.

   See :ref:`molecular_shape_section` section in the **Shape TK** theory documentation for a 
   description of the Tanimoto and Tversky similarity functions.


.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEFastROCSCacheStuff

.. oe:function:: OEFastROCSCacheStuff

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEFastROCSCacheStuff(OEChem::OEMCMolBase& mol,
                                   const OEShape::OEColorForceField& cff)

   .. oe:language:: python

      .. oe:api:: python

         OEFastROCSCacheStuff(mol: OEMol, cff: OEColorForceField) -> bool

   .. warning::

      This function is deprecated and has been superseded by
      :oe:func:`OEFastROCS::OEPrepareFastROCSMol`. Please use
      :oe:func:`OEFastROCS::OEPrepareFastROCSMol` to optimize for
      :oe:meth:`OEFastROCS::OEShapeDatabase::Open` load time
      performance.


.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEFastROCSGPUStatus

.. oe:function:: OEFastROCSGPUStatus

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEFastROCSGPUStatus()

   .. oe:language:: python

      .. oe:api:: python

         OEFastROCSGPUStatus() -> int

   Queries the status of the GPU and returns an :oe:const:`OEFastROCS::OEFastROCSReturnCode`.   
   Useful for checking whether the machine has an accelerator properly setup and ready to accept FastROCS queries. 
   It is guaranteed that if this function returns :oe:const:`OEFastROCS::OEFastROCSReturnCode::Success` 
   that all subsequent :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` objects can successfully execute queries.


.. # split from OEFastROCSFunctions.rst:15

.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEFastROCSGetArch

.. oe:function:: OEFastROCSGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEFastROCSGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEFastROCSGetArch() -> str

   Returns the internal build string used by OpenEye, Cadence Molecular Sciences
   to identify the hardware architecture.  The format of these strings may
   change over time.



.. # split from OEFastROCSFunctions.rst:25

.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEFastROCSGetLicensee

.. oe:function:: OEFastROCSGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFastROCSGetLicensee()
         bool OEFastROCSGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEFastROCSGetLicensee(licensee: str) -> bool
         OEFastROCSGetLicensee() -> str

   Returns the licensee name from the license file.



.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEFastROCSGetNumDevices 

.. oe:function:: OEFastROCSGetNumDevices 

   .. oe:language:: c++ java csharp

      .. oe:api::

         size_t OEFastROCSGetNumDevices()

   .. oe:language:: python

      .. oe:api:: python

         OEFastROCSGetNumDevices() -> int

   Returns the number of compatible GPUs available for execution in the system 
   being queried. If no GPUs are visible the function will throw the following warning 
   ``Unable to find a suitable device``.


.. # split from OEFastROCSFunctions.rst:34

.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEFastROCSGetPlatform

.. oe:function:: OEFastROCSGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEFastROCSGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEFastROCSGetPlatform() -> str

   Returns the internal build string used by OpenEye, Cadence Molecular Sciences
   to identify a platform.  The format of these strings may change over
   time, and future distributions may contain different values even when
   using the same operating system, compiler and processor.  For example,
   on a ``x86_64`` Red Hat Enterprise Linux box this would return
   ``redhat-RHEL5-g++4.1-x64``.



.. # split from OEFastROCSFunctions.rst:47

.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEFastROCSGetRelease

.. oe:function:: OEFastROCSGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEFastROCSGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEFastROCSGetRelease() -> str

   Returns the release name of the *FastROCS* library being used.  This
   returns a value similar to ``0.10.0`` for production versions of the
   library, and ``0.10.0 debug`` for the checking version of the library.



.. # split from OEFastROCSFunctions.rst:57

.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEFastROCSGetSite

.. oe:function:: OEFastROCSGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFastROCSGetSite()
         bool OEFastROCSGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEFastROCSGetSite(site: str) -> bool
         OEFastROCSGetSite() -> str

   Returns the physical site location of the licensee as registered in the license file.



.. # split from OEFastROCSFunctions.rst:66

.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEFastROCSGetVersion

.. oe:function:: OEFastROCSGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEFastROCSGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEFastROCSGetVersion() -> int

   Returns the version number of the library being used.  This is an
   unsigned integer value indicating the date on which the library was
   built, for example ``20141001``, for the 1st of October 2014.  This
   value should be used when reporting problems, and unlike the release
   string, may be used in comparisons if needed.



.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEFastROCSIsGPUReady 

.. oe:function:: OEFastROCSIsGPUReady

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEFastROCSIsGPUReady()

   .. oe:language:: python

      .. oe:api:: python

         OEFastROCSIsGPUReady() -> bool

   Returns True if :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` can successfully execute queries. Useful for checking whether
   the machine has an accelerator properly setup and ready to accept FastROCS queries. It is guaranteed that if this function
   returns 'True' that all subsequent :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object can successfully execute queries. That
   means that this function will effectively initialize an underlying context that is re-used by
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` objects, possibly grabbing an "exclusive process" lock:
   http://docs.nvidia.com/cuda/cuda-c-programming-guide/#compute-modes


.. # split from OEFastROCSFunctions.rst:79

.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEFastROCSIsLicensed

.. oe:function:: OEFastROCSIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEFastROCSIsLicensed(const char* feature = 0,
                                   unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEFastROCSIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **FastROCS TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **FastROCS TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **FastROCS TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function



.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEIsDatabasePrepared

.. oe:function:: OEIsDatabasePrepared 

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsDatabasePrepared(OEChem::OEMolBase& mol)
         bool OEIsDatabasePrepared(OEChem::OEMolDatabase& moldb)

   .. oe:language:: python

      .. oe:api:: python

         OEIsDatabasePrepared(moldb: OEMolDatabase) -> bool
         OEIsDatabasePrepared(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns True if the database (:ref:`OEMolDatabase <OEChem_OEMolDatabase>`) or
   molecule (:ref:`OEMolBase <OEChem_OEMolBase>`) input has already been prepared with the
   :oe:func:`OEFastROCS::OEPrepareFastROCSMol` function and False if  
   preparation is still required.

   It is recommended that all sizable databases that are intended to be re-used 
   undergo preparation in order to benefit from significantly faster 
   load times.



.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEPrepareFastROCSMol

.. oe:function:: OEPrepareFastROCSMol

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPrepareFastROCSMol(OEChem::OEMCMolBase& mol)
         bool OEPrepareFastROCSMol(OEChem::OEMCMolBase& mol,
                                   const OEShape::OEColorForceField& cff)

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareFastROCSMol(mol: OEMol, cff: OEColorForceField) -> bool
         OEPrepareFastROCSMol(mol: OEMol) -> bool

   Prepares the molecule ``mol`` to improve the performance of loading
   the molecule into memory as an :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>`
   object from an :oe:const:`OEChem::OEFormat::OEB` file. The following
   steps are taken to improve the performance of
   :oe:meth:`OEFastROCS::OEShapeDatabase::Open` by as much as 10-fold:

   - Sets the energy of each conformer to ``0.0`` to avoid writing it
     to OEB.
   - Suppresses hydrogens and reorders reference conformers for
     compression.
   - Pre-calculates color atoms.
   - Pre-calculates self-color and self-shape terms for all conformers.

   It is recommended to call :oe:func:`OEChem::OEPRECompress` on
   the :ref:`oemolostream <OEChem_oemolostream>` before writing out to
   ``OEB``. This will store conformers in "PRE-compressed" form
   therefore alleviating the need to Gzip the ``OEB`` file and
   consequently improving the performance of
   :oe:meth:`OEChem::OEMolDatabase::Open`.
   In general, calling :oe:func:`OEFastROCS::OEPrepareFastROCSMol` and
   :oe:func:`OEChem::OEPRECompress` will result in a smaller ``OEB``
   file than the default ``OEB.GZ`` output from OMEGA.

   Additionally, if ``OEB`` file size is of chief concern a further reduction in
   file size can be achieved by using an
   :oe:const:`OEChem::OEMCMolType::HalfFloatCartesian` molecule, which
   stores reference coordinates and torsions in half floating
   point precision (16-bit). The following code snippet demonstrates
   how to cast the resultant molecule from :oe:func:`OEFastROCS::OEPrepareFastROCSMol`
   to use half precision:

   .. code-block:: c++

      OEPrepareFastROCSMol(mol);
      OEMol halfMol(mol, OEMCMolType::HalfFloatCartesian);
      OEWriteMolecule(ofs, halfMol);

   .. code-block:: python

      OEPrepareFastROCSMol(mol)
      halfMol = OEMol(mol, OEMCMolType_HalfFloatCartesian)
      OEWriteMolecule(ofs, halfMol)

   16-bit floating point will give a file size saving of approximately
   12% with a tradeoff of about 7% more performance when
   loading the OEB from disk into memory.

   .. note::

      By default, :oe:func:`OEFastROCS::OEPrepareFastROCSMol` will
      cache color atoms and self color terms for the
      :oe:const:`OEShape::OEColorFFType::ImplicitMillsDean` color
      force field. The second overload that takes a
      :ref:`OEColorForceField <OEShape_OEColorForceField>` can be used to override
      this default.



.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OESetCoordsToInertialFrame

.. oe:function:: OESetCoordsToInertialFrame

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetCoordsToInertialFrame(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OESetCoordsToInertialFrame(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Set the coordinates of ``mol`` to be aligned by its principle
   moments of inertia. The transformations returned by
   :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetQuat`,
   :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetRotMatrix`, and
   :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTranslation` assume
   the molecule has already been aligned by its principle moment of
   inertia. Users should prefer to use the
   :oe:meth:`OEFastROCS::OEShapeDatabaseScore::Transform` directly to
   avoid having to deal with this subtlety. 

   .. seealso:: 

      :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>`


.. oe:namespace:: OEFastROCS

.. meta::
   :keywords: OEShapeDatabasePrep

.. oe:function:: OEShapeDatabasePrep

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEShapeDatabasePrep(std::string filein, std::string fileout,
                                  unsigned int cfftype = OEShape::OEColorFFType::OEDefault)

   .. oe:language:: python

      .. oe:api:: python

         OEShapeDatabasePrep(filein: str, fileout: str,
                             cfftype: int = OEColorFFType_OEDefault) -> bool

   Prepares molecules stored in a :oe:const:`OEChem::OEFormat::OEB` file
   to improve the performance of loading the molecules into an
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object. This is a **multi-threaded**
   implementation of the :ref:`shapedatabaseprep<section_example_fastrocs_shapedatabaseprep>`
   example that takes the input ``OEB`` filename as the first argument
   and the output ``OEB`` filename as the second argument. An optional argument to
   specify the color force field type can be passed in. The default color force
   field is Implicit Mills Dean.

   Using this function to prep a database will result in as much as 10-fold
   performance improvement of
   :oe:meth:`OEFastROCS::OEShapeDatabase::Open`. OEShapeDatabasePrep does the
   following:

   - Pre-compresses the output file with :oe:func:`OEChem::OEPRECompress`,
     alleviating the need to Gzip the ``OEB`` and improving the
     performance of :oe:meth:`OEChem::OEMolDatabase::Open`.
   - Sets the energy of each conformer to ``0.0`` to avoid writing it
     to ``OEB``.
   - Suppresses hydrogens and reorders reference conformers for
     compression.
   - Pre-calculates color atoms.
   - Pre-calculates self-color and self-shape terms for all conformers.

   .. note::

      :oe:func:`OEFastROCS::OEShapeDatabasePrep` will
      cache color atoms and self color terms for the
      :oe:const:`OEShape::OEColorFFType::ImplicitMillsDean` color
      force field.

   .. warning::
      This function is non-deterministic so molecules will not appear in the
      same order as the input file.

   .. warning::
      This function should not be used to prepare a database intended to be
      used with a :oe:const:`OEFastROCS::OEShapeDatabaseType::Sitehopper`
      database


*******************************************************************************
OEFastROCS Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEFastROCSCacheStuff.rst
   OEFastROCSGetArch.rst
   OEFastROCSGetLicensee.rst
   OEFastROCSGetNumDevices.rst
   OEFastROCSGetPlatform.rst
   OEFastROCSGetRelease.rst
   OEFastROCSGetSite.rst
   OEFastROCSGetVersion.rst
   OEFastROCSGPUStatus.rst
   OEFastROCSIsGPUReady.rst
   OEFastROCSIsLicensed.rst
   OEShapeDatabasePrep.rst
   OEIsDatabasePrepared.rst
   OEPrepareFastROCSMol.rst
   OESetCoordsToInertialFrame.rst


*****************************************
OEFastROCS ShapeDatabaseServer XMLRPC API
*****************************************
.. oe:namespace:: ShapeDatabaseServer

This chapter documents the XMLRPC API that is exposed by the
``ShapeDatabaseServer.py`` server since the 1.0 release of
**FastROCS**. Since that release many users have created internal
clients to the server that depend on that XMLRPC API, so **OpenEye**
has strived to keep this API stable for pre-existing client code. This
chapter should serve as a guide for anyone looking to create a new
**FastROCS** server around the toolkit API.

Most users can just use the ``ShapeDatabaseClient.py`` script
directly, without the need to worry about the details of the protocol
between the client and server.

.. note::

   The XMLRPC API will be replaced by a RESTful API in a future
   version of **FastROCS TK**.

.. oe:function:: GetBestOverlays

   .. oe:api:: python

      GetBestOverlays(querymolstr, nhits, iformat = ".oeb", oformat = ".oeb") -> Binary

   Return the ``nhits`` results of the database search performed with
   the query ``querymolstr``. The file format of the data in the
   XML RPC Binary ``querymolstr`` is specified by the ``iformat``
   argument. Valid ``iformat`` arguments are any **OEChem** supported
   molecular file format that :oe:func:`OEChem::OEIs3DFormat` will
   return ``True`` for. This is because **FastROCS TK** requires a 3D
   conformation to search against.

   The returned XML RPC Binary will contain the best ``nhits`` of query
   against the database. The returned XML RPC Binary will contain the molecule
   sorted by the chosen scoring function for the database. ``nhits``
   of ``0`` specifies that all database molecules should be returned
   in sorted order, not a very advisable operation as that could move
   many megabytes to gigabytes of data over the network.

   The file format of the returned XML RPC Binary is specified by the
   ``oformat`` argument. This can be any **OEChem** supported file
   format that :oe:func:`OEChem::OEIsWriteable` will return ``True``
   for. However, scores are only stored as :ref:`SD data
   <section_moltaggeddata_SD>`, so only the following file formats
   will return score information:

   - :oe:const:`OEChem::OEFormat::OEB`
   - :oe:const:`OEChem::OEFormat::SDF`
   - :oe:const:`OEChem::OEFormat::CSV`

   Furthermore, the molecules returned will be aligned to the query
   molecule in 3D. So only formats that can represent 3D information
   will actually contain the resulting alignment.

   .. seealso::

      The :ref:`File Formats <section_molreadwrite_fileformats>`
      section of the **OEChem** documentation for a list of valid file
      formats.

   .. note::

      ``iformat`` and ``oformat`` default to ``.oeb`` in order to be
      compatible with versions of **FastROCS** clients prior to 1.4.0.

   .. warning::

      This XML RPC request will block until the search has
      completed. Since searches can take many seconds to minutes, the
      underlying network connection for the XML RPC request may time
      out. This remote procedure call should only be used when the
      search is known to be short. Using the
      :oe:func:`ShapeDatabaseServer::SubmitQuery` remote procedure
      call to queue up the query is highly preferred for creating a
      better user experience.

.. oe:function:: GetName

   .. oe:api:: python

      GetName() -> str

   Return the name of the database being served from the server. By
   default, this is the filename the server was started with. However,
   this can be changed by the :oe:func:`ShapeDatabaseServer::SetName`
   remote procedure call.

.. oe:function:: GetVersion

   .. oe:api:: python

      GetVersion() -> str

   Return the version of **FastROCS TK** being run on the server.

.. oe:function:: IsLoaded

   .. oe:api:: python

      IsLoaded(blocking = False) -> bool

   Returns ``True`` if the server has finished loading the database
   into memory and ready to accept queries. Returns ``False`` if the
   server is still initializing, causing any queries submitted to wait
   in a queue before they can be processed.

.. oe:function:: OEThrowSetLevel

   .. oe:api:: python

      OEThrowSetLevel(level)

   Turns on debugging information for the server, or turning it back
   off again. The integer ``level`` should be drawn from the
   :oe:constns:`OESystem::OEErrorLevel` namespace. **FastROCS TK**
   uses :oe:constns:`OESystem::OEThrow` to handle all logging
   information. **FastROCS TK** will throw lots of performance
   debugging information to the
   :oe:const:`OESystem::OEErrorLevel::Debug` level that will not be
   seen by default. When contacting OpenEye support about **FastROCS**
   (support@eyesopen.com), including this information would be very
   beneficial to helping solve the problem.

.. oe:function:: QueryHistogram

   .. oe:api:: python

      QueryHistogram(queryidx) -> [int, ..., int]

   Return the current distribution of scores for the search specified
   by the ``queryidx``. The distribution is returned as a list of
   integers. The distribution of scores can be retrieved in
   'real-time' during a search as well, though it is recommended to
   still use ``QueryStatus`` with the ``blocking`` parameter set to
   ``True`` to avoid spurious requests and load on the server.

   The distribution is only guaranteed to be a complete distribution
   of all the scores once the query has fully completed executing. A
   query is fully complete when the integers returned by
   ``QueryStatus`` are equal and both non-zero.

.. oe:function:: QueryStatus

   .. oe:api:: python

      QueryStatus(queryidx, blocking = False) -> (int, int)

   Return the current progress of the search specified by the
   ``queryidx``. The progress is returned as a pair of integers. The
   first integer in the pair is how many conformers have already been
   searched. The second integer in the pair is how many conformers
   there are total in the database to be searched. When the two
   integers are equal, the search has finished, and a call to
   :oe:func:`ShapeDatabaseServer::QueryResults` will return
   immediately with the resulting hits.

   ``queryidx`` must be an integer that was previously returned by the
   :oe:func:`ShapeDatabaseServer::SubmitQuery` remote procedure
   call. This remote procedure call can be called any number of times
   with the same ``queryidx`` between the matching
   :oe:func:`ShapeDatabaseServer::SubmitQuery` remote procedure call
   and the finishing :oe:func:`ShapeDatabaseServer::QueryResults`
   remote procedure call.

   The ``blocking`` parameter specifies whether this remote procedure
   call should return immediately. If ``blocking`` is ``False``, the
   remote procedure call will return immediately with the current
   status. However, this returned value could be identical to a
   previous call and provide no new information to the end user. If
   ``blocking`` is ``True``, this remote procedure call will not
   return until there is new information to return. This will result
   in less "busy waiting" network traffic constantly pinging the
   server for an update.

   .. note::

      It is possible for both values returned to be ``0`` even
      though the search is not complete. There is a very short period
      of time that the XML RPC service does not know the total number
      of conformers yet after the query has been submitted. Users can
      disregard this state and requery the server for a new status.

.. oe:function:: QueryResults

   .. oe:api:: python

      QueryResults(queryidx) -> Binary

   Return a XML RPC Binary of search results for the specified
   ``queryidx``. The contents of the XML RPC Binary, including file
   format and size, are controlled by the corresponding call to
   :oe:func:`ShapeDatabaseServer::SubmitQuery`.

   This remote procedure call will block if the search is not
   completed yet. Use the :oe:func:`ShapeDatabaseServer::QueryStatus`
   remote procedure call to determine if the results are ready to
   return.

   .. warning::

      This function can only be called once for a particular
      ``queryidx``. Once a query's results are retrieved with this
      remote procedure call, all record of the search are removed from
      the server's memory. The reverse is true as well though, if this
      function is not called, the query's results will stay resident
      in memory until the server is restarted.

.. oe:function:: SetName

   .. oe:api:: python

      SetName(name)

   Specify the name of the database this server is serving. Subsequent
   calls to the :oe:func:`ShapeDatabaseServer::GetName` remote
   procedure call will return this name.

.. oe:function:: SubmitQuery

   .. oe:api:: python

      SubmitQuery(querymolstr, nhits, iformat = ".oeb", oformat = ".oeb",
                  shapeOnly = False) -> int

   Submit a query 3D molecule to the server and begin processing
   immediately. If there is already a search in progress, the query
   will be submitted to a queue. An integer index is returned to allow
   tracking the progress of the search through the
   :oe:func:`ShapeDatabaseServer::QueryStatus` function, and then to retrieve the results
   through the :oe:func:`ShapeDatabaseServer::QueryResults` function. This function will
   return immediately, unlike the
   :oe:func:`ShapeDatabaseServer::GetBestOverlays` remote procedure
   call.

   The ``shapeOnly`` argument specifies that :ref:`color scoring
   <shapetk_color_features>` should not be performed and taken into
   account when scoring and sorting molecules. This defaults to
   ``False`` to be compatible with versions of **FastROCS** prior to
   1.5.0.

   The file format of the query in the XML RPC Binary ``querymolstr`` is
   specified by the ``iformat`` argument. Valid ``iformat`` arguments
   are any **OEChem** supported molecular file format that
   :oe:func:`OEChem::OEIs3DFormat` will return ``True`` for. This is
   because **FastROCS TK** requires a 3D conformation to search
   against. In addition to supporting 3D conformations from standard
   **OEChem** file formats, shape queries from ``.sq`` files are also
   supported as queries. ``.sq`` files are most easily constructed
   from within the vROCS GUI. They are usable from the **Shape TK**
   through the :ref:`OEShapeQueryPublic <OEShape_OEShapeQueryPublic>` APIs.

   The ``nhits`` argument specifies how many hits should be returned
   by the corresponding :oe:func:`ShapeDatabaseServer::QueryResults` remote procedure
   call. These hits will be returned in the order of the best score
   first. A value of ``0`` given to ``nhits`` specifies that all
   database molecules should be returned, not a very advisable
   operation as that can potentially push many megabytes to gigabytes
   of data over the network.

   The file format of the XML RPC Binary to return from
   :oe:func:`ShapeDatabaseServer::QueryResults` is specified by the ``oformat``
   argument. This can be any **OEChem** supported file format that
   :oe:func:`OEChem::OEIsWriteable` will return ``True`` for. However,
   scores are only stored as :ref:`SD data
   <section_moltaggeddata_SD>`, so only the following file formats
   will return score information:

   - :oe:const:`OEChem::OEFormat::OEB`
   - :oe:const:`OEChem::OEFormat::SDF`
   - :oe:const:`OEChem::OEFormat::CSV`

   Furthermore, the molecules returned will be aligned to the query
   molecule in 3D. So only formats that can represent 3D information
   will actually contain the resulting alignment.

   .. seealso::

      The :ref:`File Formats <section_molreadwrite_fileformats>`
      section of the **OEChem** documentation for a list of valid file
      formats.

   .. note::

      ``iformat`` and ``oformat`` default to ``.oeb`` in order to be
      compatible with versions of **FastROCS** clients prior to 1.4.0.



.. _fastrocs_part_api:

*********************************
API
*********************************

.. toctree::
   :maxdepth: 2

   OEFastROCSClasses/OEFastROCSClasses
   OEFastROCSConstants/OEFastROCSConstants
   OEFastROCSFunctions/index
   CustomColorInFastROCS/CustomColorInFastROCS
   OEFastROCS_XMLRPC


.. _fastrocs_part_architecture:

*********************************
FastROCS Architecture
*********************************

#####################
Memory Usage
#####################

A rule of thumb is 1 GB of main memory for every 4 million
conformers. The primary variable **FastROCS TK** users need to think
about is how many conformers per molecule is needed. The **OMEGA**
default of 200 conformers per molecule is much higher than it needs to
be due to **OEDocking** vs **ROCS** virtual screening
performance. **OEDocking** needs a higher number of conformers than
**ROCS** does. **ROCS** can perform quite well with 10-50 conformers
per molecule. The number of conformers chosen has a direct linear
relationship to **FastROCS** query performance and the amount of
memory needed.

.. note::

   The "rule of thumb" is based upon the number of heavy atoms being
   normally distributed around 25-30 heavy atoms. The number of heavy
   atoms also has a linear relationship to the memory consumption. So
   fragment databases will be significantly smaller, but large
   macro-cycle peptide databases will be significantly larger. 

.. note::

   The above "rule of thumb" assumes the default of four inertial starts
   and no alternative starting points. If you choose to use eight
   inertial starts, you should assume you'll need about 1.5 as much main
   memory, i.e. 1.5 GB for every 4 million conformers. If you choose to
   use alternative starts, you should multiply the amount of main memory
   by the number of alternative starts / 3.

Color scoring does significantly increase virtual screening
performance. As much color information, centroids and self terms, is
cached in memory as well. For doing pure
:oe:const:`OEFastROCS::OEShapeDatabaseType::Shape` analysis, color
information can be elided allowing for a small percentage in memory
size reduction, around 5-10%. For a more complete breakdown of memory
usage, use the
:oe:meth:`OEFastROCS::OEShapeDatabase::PrintMemoryUsage` method to
print statistics on memory usage.

.. note::

   Color atom and self term calculation is a dominating factor in
   how fast **FastROCS** can load molecules from disk. Therefore, it
   is heavily recommended to pre-process OEB files with
   :oe:func:`OEFastROCS::OEPrepareFastROCSMol`. 

It is important to note that **FastROCS** is most sensitive to host
main memory, not GPU memory. On board GPU memory size does not heavily
affect **FastROCS** performance, so buying the cheaper GPUs with less
memory is just fine for **FastROCS**. 

.. note::
   
   This memory overhead will be improved over time. Significant
   advances were made in version 1.4.0, memory consumption per
   conformer was cut in half. Then cut in half again for the 1.7.0
   release.

#####################
Multi-GPU Scaling 
#####################

**FastROCS** will automatically scale across as many GPUs as can be
found on the current machine. It is not uncommon or overly expensive
to get a machine with 4-8 GPUs in it. As with any parallel program,
truly optimal linear scaling is difficult to achieve, but FastROCS
gets fairly close as can be seen in the below graph. 

.. figure:: /_images/FastROCSScalingOnTeslaGenerations.png

   This graph is a comparison of the various generations of Tesla
   compute cards produced by NVidia for high performance computing
   purposes.

.. note:: 
   
   Static color calculations are still performed on the CPU. For best
   performance, a decent mid-range CPU with 2-cores per GPU is
   recommended.

The :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` class will by default
automatically scale across all GPUs and CPUs in the system. In this
way it can be a very large resource hog for CPU, GPU, and
memory. There are some methods provided on the class to control
resource utilization, but the current best control is through the
`CUDA_VISIBLE_DEVICES
<http://devblogs.nvidia.com/parallelforall/cuda-pro-tip-control-gpu-visibility-cuda_visible_devices>`_
environment variable.

#####################
Multi-Node Scaling 
#####################

Scaling FastROCS across multiple nodes is possible with the included
``ShapeDatabaseProxy.py`` example. 


.. _fastrocs_part_examples:

*********************************
Examples
*********************************

.. toctree::
   :maxdepth: 2

   examples_summary

.. _fastrocs_examples_suite:

##########################
FastROCS Example Suite
##########################

FastROCS comes with a variety of scripts for configuring, reporting,
and debugging. For more details of how to use these examples please see
the :ref:`fastrocs_part_tutorials` section.

.. _section_example_fastrocs_simple_examples:

Simple Examples
============================================================================

.. oe:language:: c++ python java

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`bestshapeoverlay<section_example_fastrocs_bestshapeoverlay>`
        - Database searching with queries.
      * - :ref:`bestshapeoverlaymulticonfquery<section_example_fastrocs_bestshapeoverlaymulticonfquery>`
        - Database searching with every conformer of every query.
      * - :ref:`besttverskyshapeoverlay<section_example_fastrocs_besttverskyshapeoverlay>`
        - Database searching with queries using Tversky similarity scoring.
      * - :ref:`coloroptimization<section_example_fastrocs_coloroptimization>`
        - Optimize over color overlap in addition to shape overlap.
      * - :ref:`customcolorffprep<section_example_fastrocs_customcolorffprep>`
        - Cache custom color atoms onto molecules.
      * - :ref:`implicitmillsdeannorings<section_example_fastrocs_implicitmillsdeannorings>`
        - Run FastROCS with the implicit Mills-Dean color force field, sans rings.
      * - :ref:`rocsmode<section_example_fastrocs_rocsmode>`
        - Turn on ROCS mode.
      * - :ref:`shapedatabasechunker<section_example_fastrocs_shapedatabasechunker>`
        - Split database into chunks.
      * - :ref:`shapedatabaseprep<section_example_fastrocs_shapedatabaseprep>`
        - Prepare OEB file for faster load performance.
      * - :ref:`shapedistancematrix<section_example_fastrocs_shapedistancematrix>`
        - Calculate distance between all molecules in database with themselves.
      * - :ref:`shapeclustering<section_example_fastrocs_shapeclustering>`
        - Cluster database into shape clusters.

.. _section_example_fastrocs_alternative_starts:

Alternative Starts
============================================================================

.. oe:language:: c++ python java

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`asisstarts<section_example_fastrocs_asisstarts>`
        - Database searching with queries using the As Is starting orientation.
      * - :ref:`inertialatheavyatomstarts<section_example_fastrocs_inertialatheavyatomstarts>`
        - Database searching with queries using the inertial at heavy atoms starting orientation.
      * - :ref:`userinertialstarts<section_example_fastrocs_userinertialstarts>`
        - Database searching with queries using the user inertial starts orientation.

.. _section_example_fastrocs_client_server:

Client-Server
=============

.. oe:language:: c++

   .. note::
 
      Currently there is no C++ based FastROCS TK client example.

.. oe:language:: java

   .. note::
 
      Currently there is no Java based FastROCS TK client example.

.. oe:language:: python
    
   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`shapedatabaseserver<section_example_fastrocs_shapedatabaseserver>`
        - Run the FastROCS server.
      * - :ref:`shapedatabaseclient<section_example_fastrocs_shapedatabaseclient>`
        - Send query to specified server.
      * - :ref:`shapedatabaseclienthistogram<section_example_fastrocs_shapedatabaseclienthistogram>`
        - Send query to specified server and print histogram.
      * - :ref:`shapedatabaseisloaded<section_example_fastrocs_shapedatabaseisloaded>`
        - Returns whether the database has completed loading in server:port.
      * - :ref:`multiserverloadbalancing<section_example_fastrocs_multiserverloadbalancing>`
        - Spread database across multiple servers.
      * - :ref:`shapedatabaseproxy<section_example_fastrocs_shapedatabaseproxy>`
        - Tie multiple servers to appear as a single server.
      * - :ref:`shapedatabaseoethrowsetlevel<section_example_fastrocs_shapedatabaseoethrowsetlevel>`
        - Adjust the verbosity of server running on server:port.


:orphan:

.. _section_example_fastrocs_asisstarts:

AsIsStarts
===================

Return the results for a database for each query sorted by their rank in that
search. Attaches the shape Tanimoto as SD data.
Demonstrates the usage of the :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>`
with the AsIs molecule starting orientation.

.. note::

   The :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` does not store molecular information, only
   coordinate information from each conformer. If the original molecule
   is required for output it is the responsibility of the programmer to
   maintain the relationship of the :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` indices to
   the molecule. The reason for this design decision is to not force an
   additional memory overhead for an already memory intensive
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object.

Code
--------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> asisstarts <database> [<queries> ... ]

   .. only:: oehtml

      .. admonition:: Download code

         :download:`asisstarts.cpp <../../../../../sublibs/tklibs/fastrocs/examples/asisstarts.cpp>`

   .. only:: oepdf

      .. oe:source:: asisstarts.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> AsIsStartsExample.py <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`AsIsStartsExample.py <../../../../../wrappers/python/examples/fastrocs/AsIsStartsExample.py>`

      .. :ref:`Full listing. <listing-AsIsStartsExample.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/AsIsStartsExample.py

   .. only:: oepdf

      .. oe:source:: AsIsStartsExample.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> AsIsStartsExample <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`AsIsStartsExample.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/AsIsStartsExample.java>`

   .. only:: oepdf

      .. oe:source:: AsIsStartsExample.java
         :language: java

.. seealso::

   * :oe:meth:`OEFastROCS::OEFastROCSOrientation::AsIs`


:orphan:

.. _section_example_fastrocs_bestshapeoverlay:

Best Shape Overlay
===================

Return the results for a database for each query sorted by their rank in that
search. The query file can be in .oeb, .sdf or .sq format.
Attaches the shape Tanimoto as SD data.  Demonstrates the
simplest possible usage of the OEShapeDatabase including keeping a
parallel list of compressed in-memory molecules to be used as output.

.. note::

   The :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` does not store molecular information, only
   coordinate information from each conformer. If the original molecule
   is required for output it is the responsibility of the programmer to
   maintain the relationship of the :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` indices to
   the molecule. The reason for this design decision is to not force an
   additional memory overhead for an already memory intensive
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object.

Code
--------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> bestshapeoverlay <database> [<queries> ... ]

   .. only:: oehtml

      .. admonition:: Download code

         :download:`bestshapeoverlay.cpp <../../../../../sublibs/tklibs/fastrocs/examples/bestshapeoverlay.cpp>`

   .. only:: oepdf

      .. oe:source:: bestshapeoverlay.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> BestShapeOverlay.py <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`BestShapeOverlay.py <../../../../../wrappers/python/examples/fastrocs/BestShapeOverlay.py>`

      .. :ref:`Full listing. <listing-BestShapeOverlay.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/BestShapeOverlay.py

   .. only:: oepdf

      .. oe:source:: BestShapeOverlay.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> BestShapeOverlay <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`BestShapeOverlay.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/BestShapeOverlay.java>`

   .. only:: oepdf

      .. oe:source:: BestShapeOverlay.java
         :language: java



:orphan:

.. _section_example_fastrocs_bestshapeoverlaymulticonfquery:

Best Shape Overlay Multiconformer Query
===========================================

This script gives an example of searching the database with every conformer
of every query.  The number of results depends on nHits and has a default
value of 100 per search. A cutoff can also be specified and the similarity
scoring function can be set to Tversky by adding the ``--tversky`` flag to
the command line (default = Tanimoto). Results are written to one file per
query molecule, with each conformer of the query molecule's results listed
sequentially.  The query conformer id is saved as an SD tag for ease of
identification.

.. warning::

   Running this script with large numbers of queries and high numbers of conformers will
      deplete system memory rapidly.

Code
--------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> bestshapeoverlaymulticonfquery <database> <queries> [--nHits 100] [--cutoff N] [--tversky]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`bestshapeoverlaymulticonfquery.cpp <../../../../../sublibs/tklibs/fastrocs/examples/bestshapeoverlaymulticonfquery.cpp>`

   .. only:: oepdf

      .. oe:source:: bestshapeoverlaymulticonfquery.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> BestShapeOverlayMultiConfQuery.py <database> <queries> [--nHits 100] [--cutoff N] [--tversky]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`BestShapeOverlayMultiConfQuery.py <../../../../../wrappers/python/examples/fastrocs/BestShapeOverlayMultiConfQuery.py>`

      .. :ref:`Full listing. <listing-BestShapeOverlayMultiConfQuery.py>`

      ..   literalinclude:: ../../../wrappers/python/examples/fastrocs/BestShapeOverlayMultiConfQuery.py

   .. only:: oepdf

      .. oe:source:: BestShapeOverlayMultiConfQuery.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> BestShapeOverlayMultiConfQuery <database> <queries> [--nHits 100] [--cutoff N] [--tversky]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`BestShapeOverlayMultiConfQuery.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/BestShapeOverlayMultiConfQuery.java>`

   .. only:: oepdf

      .. oe:source:: BestShapeOverlayMultiConfQuery.java
         :language: java


:orphan:

.. _section_example_fastrocs_besttverskyshapeoverlay:

Best Tversky Shape Overlay
==============================

Return the database for each query sorted by their rank in that
search. Attaches the shape Tversky as SD data.  Demonstrates a 
simple usage of the OEShapeDatabase including keeping a
parallel list of compressed in-memory molecules to be used as output.

.. note::
   The OEShapeDatabase does not store molecular information, only
   coordinate information from each conformer. If the original molecule
   is required for output it is the responsibility of the programmer to
   maintain the relationship of the OEShapeDatabase indices to
   the molecule. The reason for this design decision is to not force an
   additional memory overhead for an already memory intensive
   OEShapeDatabase object.

Code
--------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> besttverskyshapeoverlay <database> [<queries> ... ]

   .. only:: oehtml

      .. admonition:: Download code

         :download:`besttverskyshapeoverlay.cpp <../../../../../sublibs/tklibs/fastrocs/examples/besttverskyshapeoverlay.cpp>`

   .. only:: oepdf

      .. oe:source:: besttverskyshapeoverlay.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> BestTverskyShapeOverlay.py <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`BestTverskyShapeOverlay.py <../../../../../wrappers/python/examples/fastrocs/BestTverskyShapeOverlay.py>`

      .. :ref:`Full listing. <listing-BestTverskyShapeOverlay.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/BestTverskyShapeOverlay.py

   .. only:: oepdf

      .. oe:source:: BestTverskyShapeOverlay.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> BestTverskyShapeOverlay <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`BestTverskyShapeOverlay.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/BestTverskyShapeOverlay.java>`

   .. only:: oepdf

      .. oe:source:: BestTverskyShapeOverlay.java
         :language: java



:orphan:

.. _section_example_fastrocs_coloroptimization:

Color Optimization
===================

Return the results for a database for each query sorted by their rank in that
search. Attaches the shape Tanimoto as SD data.  Demonstrates the
usage of the :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetColorOptimization`
to optimize over color overlap as well as shape overlap.

.. note::

   The :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` does not store molecular information, only
   coordinate information from each conformer. If the original molecule
   is required for output it is the responsibility of the programmer to
   maintain the relationship of the :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` indices to
   molecule. The reason for this design decision is to not force a
   additional memory overhead for an already memory intensive
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object.

Code
--------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> coloroptimization <database> [<queries> ... ]

   .. only:: oehtml

      .. admonition:: Download code

         :download:`coloroptimization.cpp <../../../../../sublibs/tklibs/fastrocs/examples/coloroptimization.cpp>`

   .. only:: oepdf

      .. oe:source:: coloroptimization.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> ColorOptimizationExample.py <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`ColorOptimizationExample.py <../../../../../wrappers/python/examples/fastrocs/ColorOptimizationExample.py>`

      .. :ref:`Full listing. <listing-ColorOptimizationExample.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/ColorOptimizationExample.py

   .. only:: oepdf

      .. oe:source:: ColorOptimizationExample.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> ColorOptimizationExample <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`ColorOptimizationExample.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/ColorOptimizationExample.java>`

   .. only:: oepdf

      .. oe:source:: ColorOptimizationExample.java
         :language: java



:orphan:

.. _section_example_fastrocs_customcolorffprep:

Custom Color FF Prep
====================

Caches custom color atoms onto molecules. The output must
be OEB. OEShapeDatabase, ShapeDatabaseServer.py, and
ShapeDatabaseClient.py will honor cached color atoms if present on the
molecules. Make sure the script is run on both the database and the
query molecules before running a search.

Code
--------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> customcolorffprep <input> <output.oeb>

   .. only:: oehtml

      .. admonition:: Download code

         :download:`customcolorffprep.cpp <../../../../../sublibs/tklibs/fastrocs/examples/customcolorffprep.cpp>`

   .. only:: oepdf

      .. oe:source:: customcolorffprep.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> CustomColorFFPrep.py <input> <output.oeb>

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CustomColorFFPrep.py <../../../../../wrappers/python/examples/fastrocs/CustomColorFFPrep.py>`

      .. :ref:`Full listing. <listing-CustomColorFFPrep.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/CustomColorFFPrep.py

   .. only:: oepdf

      .. oe:source:: CustomColorFFPrep.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> CustomColorFFPrep <input> <output.oeb>

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CustomColorFFPrep.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/CustomColorFFPrep.java>`

   .. only:: oepdf

      .. oe:source:: CustomColorFFPrep.java
         :language: java



:orphan:

.. _section_example_fastrocs_implicitmillsdeannorings:

Implicit Mills Dean No Rings
===============================

Return the results for a database for each query sorted by their rank in that
search. Attaches the shape Tanimoto as SD data.  Demonstrates the
usage of the ImplicitMillsDeanNoRings subtype of the
:ref:`OEColorForceField <OEShape_OEColorForceField>` class. This will ignore rings when
calculating color score.

.. note::

   The :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` does not store molecular information, only
   coordinate information from each conformer. If the original molecule
   is required for output it is the responsibility of the programmer to
   maintain the relationship of the :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` indices to
   molecule. The reason for this design decision is to not force a
   additional memory overhead for an already memory intensive
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object.

Code
----

.. oe:language:: c++

   .. code-block:: console

      prompt> implicitmillsdeannorings <database> [<queries> ... ]

   .. only:: oehtml

      .. admonition:: Download code

         :download:`implicitmillsdeannorings.cpp <../../../../../sublibs/tklibs/fastrocs/examples/implicitmillsdeannorings.cpp>`

   .. only:: oepdf

      .. oe:source:: implicitmillsdeannorings.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> ImplicitMillsDeanNoRingsExample.py <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`ImplicitMillsDeanNoRingsExample.py <../../../../../wrappers/python/examples/fastrocs/ImplicitMillsDeanNoRingsExample.py>`

      .. :ref:`Full listing. <listing-ImplicitMillsDeanNoRingsExample.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/ImplicitMillsDeanNoRingsExample.py

   .. only:: oepdf

      .. oe:source:: ImplicitMillsDeanNoRingsExample.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> ImplicitMillsDeanNoRingsExample <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`ImplicitMillsDeanNoRingsExample.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/ImplicitMillsDeanNoRingsExample.java>`

   .. only:: oepdf

      .. oe:source:: ImplicitMillsDeanNoRingsExample.java
         :language: java



:orphan:

.. _section_example_fastrocs_inertialatheavyatomstarts:

Inertial At Heavy Atom Starts
================================

Return the results for a database for each query sorted by their rank in that
search. Attaches the shape Tanimoto as SD data.  Demonstrates the usage of the
OEShapeDatabase with the InertialAtHeavyAtomStarts molecule starting orientation.

.. note::
   The OEShapeDatabase does not store molecular information, only
   coordinate information from each conformer. If the original molecule
   is required for output it is the responsibility of the programmer to
   maintain the relationship of the OEShapeDatabase indices to
   the molecule. The reason for this design decision is to not force an
   additional memory overhead for an already memory intensive
   OEShapeDatabase object.

Code
--------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> inertialatheavyatomstarts <database> [<queries> ... ]

   .. only:: oehtml

      .. admonition:: Download code

         :download:`inertialatheavyatomstarts.cpp <../../../../../sublibs/tklibs/fastrocs/examples/inertialatheavyatomstarts.cpp>`

   .. only:: oepdf

      .. oe:source:: inertialatheavyatomstarts.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> InertialAtHeavyAtomStartsExample.py <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`InertialAtHeavyAtomStartsExample.py <../../../../../wrappers/python/examples/fastrocs/InertialAtHeavyAtomStartsExample.py>`

      .. :ref:`Full listing. <listing-InertialAtHeavyAtomStartsExample.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/InertialAtHeavyAtomStartsExample.py

   .. only:: oepdf

      .. oe:source:: InertialAtHeavyAtomStartsExample.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> InertialAtHeavyAtomStartsExample <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`InertialAtHeavyAtomStartsExample.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/InertialAtHeavyAtomStartsExample.java>`

   .. only:: oepdf

      .. oe:source:: InertialAtHeavyAtomStartsExample.java
         :language: java

.. seealso::

  * :oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`


:orphan:

.. _section_example_fastrocs_multiserverloadbalancing:

Multi-Server Load Balancing
===========================

To spread a database across multiple servers the database must first
be appropriately chunked. A ShapeDatabaseServer.py is started on each
host with its corresponding database chunk. ShapeDatabaseProxy.py is
then used to tie all the servers together to appear like a single
shape database service to client applications. Theoretically, there is
no need for the client to know whether it is querying one or many
servers.

The general work-flow is as follows:

1. Split up database into 2 servers::

      ShapeDatabaseChunker.py database.oeb.gz database_shapedb.oeb.gz 2

2. Start a shape database server on each host::

      # host1
      ShapeDatabaseServer.py database_shapedb_1.oeb.gz

      # host2:
      ShapeDatabaseServer.py database_shapedb_2.oeb.gz

3. Start a proxy server to point to all the hosts. Note, a different
   port number like 8081 may need to be specified if the proxy server
   is being started on a host that already has a
   ShapeDatabaseServer.py started on it.::

      # proxy
      ShapeDatabaseProxy.py host1:8080 host2:8080 8081

4. Query the proxy server::

      ShapeDatabaseClient.py proxy:8081 query.sdf overlays.oeb


:orphan:

.. _section_example_fastrocs_rocsmode:

ROCS Mode
===================

Return the results for a database for each query sorted by their rank in that
search. Attaches the shape Tanimoto as SD data.
Demonstrates the usage of the :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetFastROCSMode`.

.. note::

   The :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` does not store molecular information, only
   coordinate information from each conformer. If the original molecule
   is required for output it is the responsibility of the programmer to
   maintain the relationship of the :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` indices to
   molecule. The reason for this design decision is to not force a
   additional memory overhead for an already memory intensive
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object.

Code
--------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> rocsmode <database> [<queries> ... ]

   .. only:: oehtml

      .. admonition:: Download code

         :download:`rocsmode.cpp <../../../../../sublibs/tklibs/fastrocs/examples/rocsmode.cpp>`

   .. only:: oepdf

      .. oe:source:: rocsmode.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> ROCSModeExample.py <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`ROCSModeExample.py <../../../../../wrappers/python/examples/fastrocs/ROCSModeExample.py>`

      .. :ref:`Full listing. <listing-ROCSModeExample.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/ROCSModeExample.py

   .. only:: oepdf

      .. oe:source:: ROCSModeExample.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> ROCSModeExample <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`ROCSModeExample.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/ROCSModeExample.java>`

   .. only:: oepdf

      .. oe:source:: ROCSModeExample.java
         :language: java

.. seealso::

   * :oe:constns:`OEFastROCS::OEFastROCSMode::ROCS`



:orphan:

.. _section_example_fastrocs_shapeclustering:

Shape Clustering
================

Uses the OEShapeDatabase to cluster the input database into shape
clusters based on a rudimentary clustering algorithm. The output is an
OEB file with members of each cluster attached as children to the
cluster head molecule.

.. note::

   Conformers from the same molecule may be
   assigned to two separate clusters. No attempt is made to deal with
   this problem as the solution is dependent on what the clustering will
   be used for. This is supposed to just show the feasibility of shape
   clustering.

Code
---------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> sphereexclusionclustering <database> <clusters.oeb> [shape tanimoto cutoff = 0.75]

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sphereexclusionclustering.cpp <../../../../../sublibs/tklibs/fastrocs/examples/sphereexclusionclustering.cpp>`

   .. only:: oepdf

      .. oe:source:: sphereexclusionclustering.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> SphereExclusionClustering.py <database> <clusters.oeb> [shape tanimoto cutoff = 0.75]

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SphereExclusionClustering.py <../../../../../wrappers/python/examples/fastrocs/SphereExclusionClustering.py>`

      .. :ref:`Full listing. <listing-SphereExclusionClustering.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/SphereExclusionClustering.py

   .. only:: oepdf

      .. oe:source:: SphereExclusionClustering.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> SphereExclusionClustering.java <database> <clusters.oeb> [shape tanimoto cutoff = 0.75]

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SphereExclusionClustering.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/SphereExclusionClustering.java>`

   .. only:: oepdf

      .. oe:source:: SphereExclusionClustering.java
         :language: java



:orphan:

.. _section_example_fastrocs_shapedatabasechunker:

Shape Database Chunker
================================

Split a database into n_servers chunks. Due to the nature of the
OEShapeDatabase the chunking is performed based upon the number of
heavy atoms in each molecule. The OEShapeDatabase will actually triage
molecules by heavy atom counts, so it is better to keep molecules with
similar heavy atom counts together.

The chunker also takes the opportunity to cache a self shape term into
the OEB file using the OESetCachedSelfShape function. This
significantly improves (~5x) database load time.

Code
--------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> shapedatabasechunker <database> <prefix> <n_servers>

   .. only:: oehtml

      .. admonition:: Download code

         :download:`shapedatabasechunker.cpp <../../../../../sublibs/tklibs/fastrocs/examples/shapedatabasechunker.cpp>`

   .. only:: oepdf

      .. oe:source:: shapedatabasechunker.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> ShapeDatabaseChunker.py <database> <prefix> <n_servers>
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeDatabaseChunker.py <../../../../../wrappers/python/examples/fastrocs/ShapeDatabaseChunker.py>`

      .. :ref:`Full listing. <listing-ShapeDatabaseChunker.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/ShapeDatabaseChunker.py

   .. only:: oepdf

      .. oe:source:: ShapeDatabaseChunker.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> ShapeDatabaseChunker <database> <prefix> <n_servers>

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeDatabaseChunker.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/ShapeDatabaseChunker.java>`

   .. only:: oepdf

      .. oe:source:: ShapeDatabaseChunker.java
         :language: java



:orphan:

.. _section_example_fastrocs_shapedatabaseclient:

Shape Database Client
======================

.. code-block::

   ShapeDatabaseClient.py <server:port> <query> <results> [num_hits = 100]

Example script to send a query to a specified
ShapeDatabaseServer. Rudimentary progress is shown as a fraction
printed to standard out.

This is meant to be a simple example that can be customized to a
particular client application. For example, the Vida client was
adapted from this script.

.. only:: oehtml

   .. admonition:: Download code

         :download:`ShapeDatabaseClient.py <../../../../../wrappers/python/examples/fastrocs/ShapeDatabaseClient.py>`

      .. :ref:`Full listing. <listing-ShapeDatabaseClient.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/ShapeDatabaseClient.py

.. only:: oepdf

   .. oe:source:: ShapeDatabaseClient.py
      :language: python


:orphan:

.. _section_example_fastrocs_shapedatabaseclienthistogram:

Shape Database Client Histogram
===================================

.. code-block::

   ShapeDatabaseClientHistogram.py <server:port> <query> <results> [num_hits = 100]

Example script to send a query to a specified ShapeDatabaseServer and
print the histogram of scores for the entire database of
molecules. The histogram is a simple ASCII representation of the
distribution. The histogram will also be updated in 'real-time' as the
query progresses.

.. only:: oehtml

   .. admonition:: Download code

         :download:`ShapeDatabaseClientHistogram.py <../../../../../wrappers/python/examples/fastrocs/ShapeDatabaseClientHistogram.py>`

      .. :ref:`Full listing. <listing-ShapeDatabaseClientHistogram.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/ShapeDatabaseClientHistogram.py

.. only:: oepdf

   .. oe:source:: ShapeDatabaseClientHistogram.py
      :language: python


:orphan:

.. _section_example_fastrocs_shapedatabaseisloaded:

Shape Database Is Loaded
========================

.. code-block::

   ShapeDatabaseIsLoaded.py [-blocking] [-h] <server:port>

Returns whether the database at server:port has completed the initial
load step. By default, the program will return immediately with either
true or false. Specifying the -blocking argument will tell the program
to wait until the server has finished.

.. only:: oehtml

   .. admonition:: Download code

         :download:`ShapeDatabaseIsLoaded.py <../../../../../wrappers/python/examples/fastrocs/ShapeDatabaseIsLoaded.py>`

      .. :ref:`Full listing. <listing-ShapeDatabaseIsLoaded.py>`

   .. literalinclude:: ../../../wrappers/python/examples/fastrocs/ShapeDatabaseIsLoaded.py

.. only:: oepdf

   .. oe:source:: ShapeDatabaseIsLoaded.py 
      :language: python



:orphan:

.. _section_example_fastrocs_shapedatabaseoethrowsetlevel:

ShapeDatabaseOEThrowSetLevel
===============================

.. code-block::

   ShapeDatabaseOEThrowSetLevel.py (-debug|-info|-warning) <server:port>

Adjust the verbosity of the server running on server:port. Only one of
the levels can be specified. The verbosity level of "-debug" is useful
for obtaining some performance statistics about how well its servicing
queries.

.. only:: oehtml

   .. admonition:: Download code

         :download:`ShapeDatabaseOEThrowSetLevel.py <../../../../../wrappers/python/examples/fastrocs/ShapeDatabaseOEThrowSetLevel.py>`

      .. :ref:`Full listing. <listing-ShapeDatabaseOEThrowSetLevel.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/ShapeDatabaseOEThrowSetLevel.py

.. only:: oepdf

   .. oe:source:: ShapeDatabaseOEThrowSetLevel.py 
      :language: python



:orphan:

.. _section_example_fastrocs_shapedatabaseprep:

Shape Database Prep
======================

Prepares an OEB file for faster load performance (~10x) into
ShapeDatabaseServer.py. The script will fail if attempting to store
as ``.oeb.gz``, not ``.oeb``. A corresponding ``.oeb.idx`` index
file will be created that will also improve load performance.
The disk space lost due to not using gzip compression is offset by
removing unnecessary information from the OEB file as well as the newer
PRE-compressed OEB format.

The maximum number of conformers per molecule can also be reduced at
the same time by specifying the ``-maxConfs`` argument. The default
maximum number of conformers is set to ``10``.

By default, the coordinates are stored in half floating point precision to save space.
To store in full floating point precision run with the ``--storeFloat`` flag.

.. warning::

   The PRE-compress OEB format may not be readable by older OpenEye
   products built on versions of OEChem prior to OEChem 2.0.2
   (2014.Oct).

Code
---------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> shapedatabaseprep [-maxConfs 10] [-storeFloat] [-in] <database.oeb> [-out] <database.oeb>

   .. only:: oehtml

      .. admonition:: Download code

         :download:`shapedatabaseprep.cpp <../../../../../sublibs/tklibs/fastrocs/examples/shapedatabaseprep.cpp>`

   .. only:: oepdf

      .. oe:source:: shapedatabaseprep.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> ShapeDatabasePrep.py [-maxConfs 10] [-storeFloat] [-in] <database.oeb> [-out] <database.oeb>

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeDatabasePrep.py <../../../../../wrappers/python/examples/fastrocs/ShapeDatabasePrep.py>`

      .. :ref:`Full listing. <listing-ShapeDatabasePrep.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/ShapeDatabasePrep.py

   .. only:: oepdf

      .. oe:source:: ShapeDatabasePrep.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> ShapeDatabasePrep [-maxConfs 10] [-storeFloat] [-in] <database.oeb> [-out] <database.oeb>

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeDatabasePrep.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/ShapeDatabasePrep.java>`

   .. only:: oepdf

      .. oe:source:: ShapeDatabasePrep.java
         :language: java



:orphan:

.. _section_example_fastrocs_shapedatabaseproxy:

Shape Database Proxy
--------------------

.. code-block::

   ShapeDatabaseProxy.py <server 1> <server 2> ... <server n> [portnumber=8080]

Start a server to tie multiple remote ShapeDatabaseServers together
to appear as a single server. This is useful since there is no change
in client code to migrate from a single server to multiple servers
since the XMLRPC interface is exactly the same.

The ShapeDatabaseProxy is sufficiently performant that it does not
need its own dedicated node. It is perfectly acceptable to run it on
the same server as one of the ShapeDatabaseServers.

.. only:: oehtml

   .. admonition:: Download code

         :download:`ShapeDatabaseProxy.py <../../../../../wrappers/python/examples/fastrocs/ShapeDatabaseProxy.py>`

      .. :ref:`Full listing. <listing-ShapeDatabaseProxy.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/ShapeDatabaseProxy.py

.. only:: oepdf

   .. oe:source:: ShapeDatabaseProxy.py 
      :language: python



:orphan:

.. _section_example_fastrocs_shapedatabaseserver:

ShapeDatabaseServer
======================

.. code-block::

   ShapeDatabaseServer.py <database> [portnumber=8080]

Runs the FastROCS Server.  The preferred usage of ShapeDatabaseServer.py is as a
service that is left continuously running to avoid the overhead of
reading and parsing the database off disk. Run the above command to start a
server on a suitable host. By default the service will run on port 8080, though
this can be changed by the last command line option.

The server will output dots while loading the database into memory,
which can take a considerable amount of time. When the server is done
loading the database it will report a total and then go to sleep
waiting for queries on the specified port. Queries are serviced
through the XMLRPC protocol using the built-in libraries that ship
with a standard python distribution.

.. note::

   The database load time can be significantly improved by running
   ShapeDatabasePrep.py on the file first and saving it as uncompressed
   OEB. The ShapeDatabaseChunker.py program described later will perform
   such caching.

.. note::

   The server/client examples are for use with the **FastROCS Toolkit** product, only.
   They are not compatible with the commercially supported **FastROCS server** product,
   which provides an independent GUI and CLI.
   For more information about the commercially supported server please visit https://www.eyesopen.com/contact.

.. only:: oehtml

   .. admonition:: Download code

         :download:`ShapeDatabaseServer.py <../../../../../wrappers/python/examples/fastrocs/ShapeDatabaseServer.py>`

      .. :ref:`Full listing. <listing-ShapeDatabaseServer.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/ShapeDatabaseServer.py

.. only:: oepdf

   .. oe:source:: ShapeDatabaseServer.py
      :language: python



:orphan:

.. _section_example_fastrocs_shapedistancematrix:

Shape Distance Matrix
=====================

Calculates the distance between all molecules in a database with
themselves. There will only be one entry per molecule, though all
conformers will be considered in the comparison. This means the
conformer used in a particular row or column of the matrix will not be
consistent. The complete distance matrix is written out to the
clusters.csv in comma separated format, useful for feeding into
downstream clustering software.

.. note::

   The values output will be a "distance", not the tanimotos. That
   means a perfect match is '0.0', not 1.0 or 2.0 respectively. The
   default is to use Tanimoto Combo. The ``-shapeOnly`` flag can be
   used to get only the shape distance. 

.. warning::

   This will generate O(N^2) amount of data and runtime. This is not a
   cheap script to run. This script can generally handle 1,000s to
   10,000s in a reasonable timeframe on a modern GPU and a machine
   with decent memory and disk space.

Code
---------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> shapedistancematrix [-shapeOnly] [-dbase] <database> [-matrix] <clusters.csv>

   .. only:: oehtml

      .. admonition:: Download code

         :download:`shapedistancematrix.cpp <../../../../../sublibs/tklibs/fastrocs/examples/shapedistancematrix.cpp>`

   .. only:: oepdf

      .. oe:source:: shapedistancematrix.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> ShapeDistanceMatrix.py [-shapeOnly] [-dbase] <database> [-matrix] <clusters.csv>

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeDistanceMatrix.py <../../../../../wrappers/python/examples/fastrocs/ShapeDistanceMatrix.py>`

      .. :ref:`Full listing. <listing-ShapeDistanceMatrix.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/ShapeDistanceMatrix.py

   .. only:: oepdf

      .. oe:source:: ShapeDistanceMatrix.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> ShapeDistanceMatrix.java [-shapeOnly] [-dbase] <database> [-matrix] <clusters.csv>

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeDistanceMatrix.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/ShapeDistanceMatrix.java>`

   .. only:: oepdf

      .. oe:source:: ShapeDistanceMatrix.java
         :language: java


:orphan:

.. _section_example_fastrocs_userinertialstarts:

User Inertial Starts
=====================

Return the results for a database for each query sorted by their rank in that
search. Attaches the shape Tanimoto as SD data.  Demonstrates the usage of the
OEShapeDatabase with the UserInertialStarts molecule starting orientation.

.. note::

   The OEShapeDatabase does not store molecular information, only
   coordinate information from each conformer. If the original molecule
   is required for output it is the responsibility of the programmer to
   maintain the relationship of the OEShapeDatabase indices to
   the molecule. The reason for this design decision is to not force an
   additional memory overhead for an already memory intensive
   OEShapeDatabase object.

Code
--------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> userinertialstarts <database> [<queries> ... ]

   .. only:: oehtml

      .. admonition:: Download code

         :download:`userinertialstarts.cpp <../../../../../sublibs/tklibs/fastrocs/examples/userinertialstarts.cpp>`

   .. only:: oepdf

      .. oe:source:: userinertialstarts.cpp
         :language: c++

.. oe:language:: python

   .. code-block:: console

      prompt> UserInertialStartsExample.py <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`UserInertialStartsExample.py <../../../../../wrappers/python/examples/fastrocs/UserInertialStartsExample.py>`

      .. :ref:`Full listing. <listing-UserInertialStartsExample.py>`

      .. literalinclude:: ../../../wrappers/python/examples/fastrocs/UserInertialStartsExample.py

   .. only:: oepdf

      .. oe:source:: UserInertialStartsExample.py
         :language: python

.. oe:language:: java

   .. code-block:: console

      prompt> UserInertialStartsExample <database> [<queries> ... ]
   
   .. only:: oehtml

      .. admonition:: Download code

         :download:`UserInertialStartsExample.java <../../../../../wrappers/java/examples/openeye/examples/oefastrocs/UserInertialStartsExample.java>`

   .. only:: oepdf

      .. oe:source:: UserInertialStartsExample.java
         :language: java

.. seealso::

  * :oe:meth:`OEFastROCS::OEFastROCSOrientation::UserInertialStarts`


.. _fastrocs_part_installation:

*********************************
Installation
*********************************

#. Install the OpenEye Toolkits into a virtual environment::

      $ mkvirtualenv fastrocs
      (fastrocs) $ pip install --extra-index-url https://pypi.anaconda.org/OpenEye/simple OpenEye-toolkits

#. Once installed, follow the instructions in :ref:`tutorial_basic_usage` to get you started.

.. _chapter_fastrocs_prereq:

#####################
Prerequisites
#####################


GPU-Related Requirements
========================

The following features are required in order to use GPU-accelerated OpenEye toolkits and applications.


Supported Platforms
-------------------

CUDA-enabled OpenEye software is only available on supported Linux platforms.
For supported Linux platforms see the `Platform Support Page <https://www.eyesopen.com/supported-platforms>`_.


Supported GPUs
-------------------

An NVIDIA `Tesla <http://www.nvidia.com/object/tesla-supercomputing-solutions.html>`_,
`Quadro <http://www.nvidia.com/object/workstation-solutions.html>`_, or
`GeForce <http://www.nvidia.com/object/geforce_family.html>`_ GPU with a **compute capability of 3.5
or higher** is required on your system. For a comprehensive table of compute capability
categories for each GPU, please refer to the `CUDA <https://en.wikipedia.org/wiki/CUDA>`_ Wikipedia page.


NVIDIA Drivers
-------------------

* **Minimum NVIDIA Driver version: 450.x**.

* CUDA is **not** required to be installed.

We recommend driver `450.80.02 <https://www.nvidia.com/Download/driverResults.aspx/165294/en-us>`_, and
we strongly advise manually downloading and installing the appropriate NVIDIA driver
for your system as opposed to using a package manager.

To install, root privilege is required. Follow these steps:

  #. Download the driver to the machine you are installing it on.
  #. ``chmod +x`` the driver package to make it executable.
  #. Ensure you have disabled X-server by killing any running sessions.
     Reboot may be required if X-server is still running after this step.
     
     .. warning::

        Disabling X-server requires different processes to be killed depending on your Linux
        distribution.
        See the `NVIDIA installation guide
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_ for more details.

     .. warning::

        The NVIDIA kernel module can often conflict with the open source
        Nouveau display drivers, depending on your specific Linux
        distribution. The NVIDIA documentation is a much more complete
        and up-to-date source for information on how to work around this issue.
        See `Disabling Nouveau
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile-nouveau>`_ on the NVIDIA website.

  #. Install the driver by ``sudo ./NVIDIA-Linux-x86_64-450.80.02.run`` and follow the step-by-step installation instructions.

  For more details on driver installations, see the `CUDA Installation Guide
  <https://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_

.. note::

  The output of the ``nvidia-smi`` command is extremely useful when
  debugging GPU issues. Please include the output from
  ``nvidia-smi`` in any request to support@eyesopen.com.


Performance Tuning
-------------------

To get the most performance out of an NVIDIA graphics card, use the persistence daemon to switch persistence mode
across all cards on the system (root privilege required)::

  sudo nvidia-persistenced --user foo

This will automatically enable persistence mode after reboot.

For full instructions on the persistence daemon, see the `Persistence daemon section
<https://docs.nvidia.com/deploy/driver-persistence/index.html#persistence-daemon>`_ of the NVIDIA docs.

###############################
Hardware Performance Comparison
###############################

The following graph shows the performance of **FastROCS TK** on
some modern GPU models.

.. image:: /_images/FastROCS_Latest_GPU_Comparison.png
   :width: 500pt

.. note::

   Performance can vary with driver versions and other factors. The
   above graph is meant as a general guide of what performance
   customers can expect. It is highly recommended to go with a
   certified vendor like `Exxact
   <http://exxactcorp.com/index.php/solution/solu_list/83>`_ to ensure
   best performance.

.. _fastrocs_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version2_3_2
   version2_3_1
   version2_3_0
   version2_2_7
   version2_2_6
   version2_2_5
   version2_2_4
   version2_2_3
   version2_2_2
   version2_2_1
   version2_2_0
   version2_1_0
   version2_0_0
   version1_10_1
   version1_10_0
   version1_9_0
   version1_8_4
   version1_8_3
   version1_8_2
   version1_8_1
   version1_8_0
   version1_7_0
   version1_6_0
   version1_5_1
   version1_5_0
   version1_4_0
   version1_3_1
   version1_3_0
   version1_2_1
   version1_1_1
   version1_1_0
   version1_0_1
   version1_0_0
   version0_4_0
   version0_3_1
   version0_3_0
   version0_2_3
   version0_2_2
   version0_2_1
   version0_2_0
   version0_1_1
   version0_1_0



FastROCS TK 2.3.2
================================================================================

Minor internal improvements have been made.



FastROCS TK 0.1.0
=================

* First public release.


FastROCS TK 0.1.1
=================

* Adding the ShapeDatabaseOEThrowSetLevel.py script to adjust the
  verbosity level of the server without restarting it.


FastROCS TK 0.2.0
=================

* Added example of a XML RPC client written in Java. (See the javaclient directory.)

* Added example program for doing shape clustering. (See karma.py)

* Refactored benchmarking scripts into the benchmarks directory.

  * Added benchmarks for database size and random access patterns.

* Improved database load time of ShapeDatabaseServer.py by multithreading

  * It is now thread safe to use OEShapeDatabase::AddMol from multiple
    threads. Note, it is not thread safe to call Get(Sorted)Scores
    while calling AddMol. Let me know if this is desired.


FastROCS TK 0.2.1
=================

* Added support for SUSE 11.

* Added cuda.sh shell script that will create the appropriate nvidia
  device entries inside /dev/. It is a known issue on SLES11 the nvidia driver
  will create the /dev/ entries with the wrong permissions. Also, it
  is known issue that on RHEL5 LDAP users could not launch OpenCL
  based programs. Running this shell script as root (i.e. during boot)
  should fix these problems. We should push on NVidia to make this
  part of their driver installer.

* The PrintOpenCLDevices utility will now print "platform" information
  about the driver(s) found on the system. This is useful for
  displaying which version of CUDA is installed, instead of just what
  version of OpenCL is installed.

* Fixed problem where some systems without SWAP memory would crash
  with an out of memory error when the OEShapeDatabase object would
  try to reserve large swaths of memory. The virtual memory size of
  the process should now track more closely with the resident memory
  size.


FastROCS TK 0.2.2
=================

* Fixed a major bug that would cause very high shape tanimotos to be
  calculated when cached color atoms were present in the input
  database.

* Added symlink from SLES to SLED to work around OEToolkit issue of
  not recognizing those as equivalent systems.

* Querying the database with an empty molecule will no longer crash.

* Added BenchmarkDatabaseTransfer.py benchmark to determine the
  maximum speed being achieved when transferring database chunks across
  the bus.



FastROCS TK 0.2.3
=================

* OSX only release to fix obscure bug that occurred when using an
  NVidia GPU through Apple's OpenCL implementation.



FastROCS TK 0.3.0
=================

* Added ShapeDatabaseAddMols.py script to add molecules to a running
  ShapeDatabaseServer.

* Added ShapeDatabaseIsLoaded.py script to report whether the initial
  database load has completed.

* Added argument to ShapeDatabaseClient.py for the number of hits to
  return, defaults to 100.

* Redesigned how the BestShapeOverlay.py script runs to be more useful
  for doing evaluations.

* Restricting OEShapeDatabase to only run on one type of device and
  prefer to run on a GPU, and fall back to a CPU device only if there
  is no GPU present. Used to be that on OS X the search would run on
  the GPU and CPU simultaneously, however, the results of the overlay
  could differ depending on whether they were sent to the GPU or the
  CPU. Due to dynamic load balancing between the CPU and GPU this
  could change the rank of the results returned in an apparently
  non-deterministic manner. It is not pleasant for an end-user to run
  the same query multiple times and get different results so we
  restrict searches to either CPU or GPU, not both now. Note, this
  only would occur on OS X. The NVidia implementation doesn't support
  a CPU device, so this never occurred there.


FastROCS TK 0.3.1
=================

* The server would sometimes crash with a "clCreateContext"
  error. This is being thrown from the NVidia driver for some unknown
  reason. This release will continually try to create the worker
  thread despite all else. Note, if something is truly wrong, this
  could appear to hang queries as the server will keep retrying to
  create a context on the GPU, but at least the log will indicate an
  error code now that may tell us more about what is going on.



FastROCS TK 0.4.0
=================

* An experimental release that includes color support meant for
  scientific validation with the following implementation caveats:

  * Static color scores are calculated using the alignment generated by
    a shape driven optimization. Note, a color score is calculated for
    each of the 4 inertial starting points. Therefore, it is possible
    for a less favorable shape score to be picked due to a higher
    tanimoto combo. This is the only part color plays in the
    optimization.

* Color is calculated using the grid method in order to be fast
  enough to keep up with the GPU generated alignments.

* Color is calculated on the CPU so there is no increased bus
  overhead for color, but there is a significant increase in CPU
  usage. Calculating color on the CPU is a strategic move to see if
  we can get away with calculating color without any significant
  increase to the overall search time. This release gets part of the
  way towards that goal: a single core of a Xeon CPU E5520 at 2.27GHz
  is about 2 times slower at calculating static colors coming out of
  a single NVidia C2050. Future releases will spread this over
  multiple CPU cores to better even out the load.

  * The OEShapeScore object has been renamed to OEShapeDatabaseScore to
    disambiguate it. Renamed the method GetTanimoto to
    GetShapeTanimoto. Added GetColorTanimoto and GetTanimotoCombo.

  * Add the OEShapeDatabaseType constants namespace to indicate whether
    a database should store color information as well and whether a
    query should use color as well.

  * Added OEShapeDatabaseOptions::SetScoreType to be used with the
    OEShapeDatabaseType constants to indicate what type of search is
    being done.

  * Renamed OEShapeDatabase::SetGridSpacing to
    OEShapeDatabase::SetShapeGridSpacing. Added
    OEShapeDatabase::SetColorGridSpacing.

  * Load time has been significantly increased due to the calculation
    of color atoms during load time.


FastROCS TK 1.0.0
=================

* ShapeDatabaseServer.py now has a "-shapeOnly" option to run in a
  mode where color is not calculated at all. By default this option is
  off indicated that the server will use color. ShapeDatabaseProxy.py
  has been updated accordingly to automatically recognize whether to
  use ComboTanimoto and ShapeTanimoto to resort the results by.
* Fixing BestShapeOverlay.py to work with color. 
* karma.py has been updated to work with color. 


FastROCS TK 1.0.1
=================

* First version of FastROCS that is designed to only work on a
  specific hardware and driver configuration. This release will only
  work on NVidia hardware with the CUDA 3.2 driver. FastROCS will work
  on any modern NVidia card that reports a compute capability of 1.0 or
  greater. Typically this is any NVidia card shipped after 2006. For a
  complete list of cards refer to `Appendix A in the CUDA C Programming
  Guide <http://developer.download.nvidia.com/compute/cuda/3_2_prod/toolkit/docs/CUDA_C_Programming_Guide.pdf>`_.

.. note:: The more stringent requirement is on the driver version, CUDA
  3.2. For this reason FastROCS will be shipping with the required associated
  NVidia Linux driver embedded in the tar-ball:
  devdriver_3.2_linux_64_260.19.26.run

  This requirement is also embedded into the tar-ball name as
  "OpenCL-1.0-CUDA-3.2" in case we need to support multiple versions
  or rev'ing to OpenCL 1.1 breaks compatibility. If a driver upgrade
  needs to occur due to some bug in some other third party software, let
  OpenEye know and we will see how best we can accommodate you.

* Added ShapeSimilarityMatrix.py example to write out a similarity
  matrix of an input database into a csv file suitable for feeding to
  downstream tools like cluster analysis. Note, due to the current
  slow speed of clCreateContext, the example is not crazy performant
  on small datasets, but on larger sets it is as the cost of
  clCreateContext becomes amortized.


FastROCS TK 1.10.0
================================================================================

New features
--------------------------------------------------------------------------------

* **FastROCS TK** has been optimized to yield a further ~2-3x in performance
  compared to the previous release. The performance improvement will vary from
  system to system.
  See more details in the :ref:`highlights_2019_Apr` section.

Minor bug fixes
--------------------------------------------------------------------------------

* GPUs in prohibited mode will now be honored when querying the number of
  available devices on the system. Previously, a fatal error occurred during
  the search.

Python-specific changes
--------------------------------------------------------------------------------

* The example in the :ref:`section_example_fastrocs_shapedatabaseprep` section
  now defaults to a maximum of 10 conformers per molecule and saves the coordinates
  in half-float precision.
  A flag is provided to switch to full-float precision coordinates.

Documentation changes
--------------------------------------------------------------------------------

* A new :ref:`fastrocs_performance_tuning` section has been added to the installation guide.


FastROCS TK 1.10.1
================================================================================

New features
--------------------------------------------------------------------------------
* A new function, :oe:func:`OEFastROCS::OEFastROCSGPUStatus`, has been added that interrogates the
  status of the GPU and returns a code from the
  :oe:constns:`OEFastROCS::OEFastROCSReturnCode` namespace. The return codes
  now allow for more specific error reporting of the GPU system.

Major bug fixes
--------------------------------------------------------------------------------
* An issue that caused :oe:constns:`OEFastROCS::OEFastROCSOrientation::Subrocs` to fail to apply the
  correct number of starts to the color calculation has been fixed.
* :oe:meth:`OEFastROCS::OEShapeDatabase::SetColorGridSpacing` had been broken after
  the previous major version change. This has been fixed.
* :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetLimit` now returns all
  ``N`` overlays of all conformers and orientations when used in conjunction
  with :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxOverlays` set to ``0``
  and :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxConfs` set to ``0``.
* The default is now to run reference Tversky when running :oe:constns:`OEFastROCS::OEShapeSimFuncType::Tversky`.
  For more details about Tversky similarity scoring, see
  the :ref:`molecular_shape_section` section of the **Shape TK** theory documentation.

Minor bug fixes
--------------------------------------------------------------------------------
* :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumInertialStarts` is no
  longer order-dependent when using alternative starts.
* When running with Tversky similarity scoring, only a single warning about Tversky
  scores being greater than 1.0 will ever be thrown unless the debug
  error level is being used.


FastROCS TK 1.1.0
=================

Major Bug Fixes
---------------

* Fixed color bug that was calculating incorrect static color
  scores. Large errors were caused whenever the shape optimization
  produced large translations.
* Fixed bug that was causing certain database molecules (usually flat
  molecules) to be collapsed to a single point during the inertial
  alignment step of loading the database. This would sometimes
  manifest as tanimotos being outside the normal 0-1 range.

Minor Bug Fixes
---------------

* Fixed incorrect color Gaussian width used in the color score
  calculation.
* Handle zero division error in the color tanimoto calculation caused
  whenever a molecule has no color atoms. These tanimotos will now be
  0.0.
* In the event an error occurs in the OpenCL driver and a command
  queue can not be opened to the GPU device only retry a finite amount
  of time. That is, don't loop infinitely in the event of a lower
  level error. 
* Fixing order dependence problem caused whenever PYTHONPATH was
  explicitly set overriding the search path explicitly set inside
  ShapeDatabaseServer.py.
* Fixed bug in ShapeDatabaseServer.py caused by OEHeader objects in
  OEB files. This will be fixed in a more general sense by the next
  toolkit release.
* ShapeDatabaseServer.py will only allow one client query to process
  at a time to ensure that GPU resources are not exhausted. This
  restriction may be lifted in a future version, but for now this is
  the best way to keep the server robust in a multi-user environments.
* Cached color in OEB files use compressed color atoms in order to not
  corrupt the OEB rotor offset compression format. Also use the cached
  "AllColor" self term as it is closer to how the grid color overlap
  is calculated.

Major Features
--------------

* Added support for Shape Query (.sq) files generated from
  vROCS. These files can now be passed directly to
  ShapeDatabaseClient.(py/java).
* Significant performance improvement to post scoring with static
  color. Post scoring with static color is now essentially "free" as
  it occurs on the CPU after the shape optimization on the GPU. To
  achieve this at least 2 CPU cores per Fermi GPU is recommended.

Minor Features
--------------

* Significant performance improvement by caching the underlying GPU
  context more effectively. Some queries were seeing a 1-2 second
  overhead per GPU device because the GPU context could not be
  cached. Later versions of the driver seem to support this without
  crashing. If this version starts giving odd crashing behavior, try
  updating the NVidia driver first.
* ShapeDatabaseChunker.py is a little more robust in choosing output
  file names.
* Added ability to use 8 inertial starting points. 
* Added the CacheStuff.py script to cache as much as possible to
  improve database load time. ShapeDatabaseChunker.py updated to cache
  color stuff as well.
* Totally revamped the output of Debug mode to allow for timing the
  more asynchronous nature of FastROCS now.


FastROCS TK 1.1.1
=================

* Fixed bug with shape query support that would cause the server to
  crash when passing an empty shape query.
* Made the client/server interaction more robust in passing errors
  back from the server to the client.


FastROCS TK 1.2.1
=================

* FastROCS is now built with the 2011.Oct toolkit release. This has
  some significant performance improvements on the server load time.
* FastROCS is now built against the latest two shipping NVidia drivers:
  OpenCL 1.1 CUDA 4.1 inside the 285 NVidia driver; and OpenCL 1.0
  CUDA 4.0 inside the 275 NVidia driver. These drivers solve
  some search initialization costs that were seen in some setups.
* The Vida extension is being removed from the FastROCS distribution
  as a new version is being bundled directly into Vida.
* Significant updates to the README to remove a lot of cruft that had
  accumulated during development.


FastROCS TK 1.3.0
=================

* Major performance improvement in how FastROCS scales to multiple
  GPUs. The NVidia 275, 285, 295 driver introduced a severe performance
  regression that hampered FastROCS ability to scale across multiple
  GPUs. The solution was to use a different strategy to transfer data
  between the host and the device as well as scaling back the number of host
  threads launching jobs on the GPUs to only 1 per GPU. 

* Many additions to the python interface to allow tweaking how
  FastROCS is parallelized and memory is moved around in the system:
  SetNumDevices, SetHostToDeviceStrategy, SetDeviceToHostStrategy,
  SetNumThreadsPerDevice. The defaults should be reasonable for
  everyone while using the 295 NVidia driver. They're left here to allow
  easy tweaking on future drivers, though they may be removed once a
  toolkit version is released, so don't rely on them. 

* Fixed timer restart in OEShapeDatabaseOptions that would cause a
  reused OEShapeDatabaseOptions object to include time spent on previous
  searches.

* Only 4 decimal places are stored in the SD data fields for Shape
  Tanimoto, Color Tanimoto, and Tanimoto Combo.

* Made the NVidia driver install portion of the README easier to follow. 

* Removed the restriction to use molecules with less than 3 heavy atoms. 


FastROCS TK 1.3.1
=================

* Adding support for RHEL6-x64 based upon customer request. 
* Reducing the size of the FastROCS tar-ball by removing some of the
  toolkit bloat.



FastROCS TK 1.4.0
=================

* The structure of the FastROCS tar-ball has changed to mimic an
  openeye distribution tree usually seen on Linux. All programs can
  now be found in the openeye/bin directory.

* This version of FastROCS was built with the NVIDIA 310 driver
  included in this distribution. FastROCS should continue to work with
  the 295 driver as OpenCL and CUDA have not changed version between
  these driver versions. However, if problems are experienced during
  the upgrade, please try upgrading the NVIDIA driver to the 310
  version.

Features
--------

* FlaskROCS, an example web page service has been added. See
  openeye/FlaskROCS/README for more information.

* ShapeDatabaseClient (both Python and Java) no longer requires the
  OpenEye toolkits to run. This should make client applications a
  lot more portable and easier to write. Clients written against
  version 1.3.1 servers and prior versions will still continue to
  work. The following demonstrates client commands and that their
  behavior is unchanged when upgrading the server to version 1.4.0.

  The 1.3.1 and prior clients: 
  ./ShapeDatabaseClient.py 1_3_1_server_addr query.sdf results.oeb   # still works
  ./ShapeDatabaseClient.py 1_3_1_server_addr query.oeb results.oeb   # still works
  ./ShapeDatabaseClient.py 1_3_1_server_addr query.sdf results.sdf   # would never work, results had to be an oeb file

  ./ShapeDatabaseClient.py 1_4_0_server_addr query.sdf results.oeb   # still works
  ./ShapeDatabaseClient.py 1_4_0_server_addr query.oeb results.oeb   # still works
  ./ShapeDatabaseClient.py 1_4_0_server_addr query.sdf results.sdf   # would never work, results had to be an oeb file

  The 1.4.0 client will only work with 1.3.1 servers when the
  input and output format is oeb. However, the results file no longer
  needs to be oeb when running the 1.4.0 client against a 1.4.0
  server. The following demonstrates client commands and that their
  behavior unchanged when upgrading the server to version 1.4.0.

  The 1.4.0 client: 
  ./ShapeDatabaseClient.py 1_3_1_server_addr query.sdf results.oeb   # won't work, query is sdf file
  ./ShapeDatabaseClient.py 1_3_1_server_addr query.oeb results.oeb   # still works
  ./ShapeDatabaseClient.py 1_3_1_server_addr query.sdf results.sdf   # would never work, results had to be an oeb file

  ./ShapeDatabaseClient.py 1_4_0_server_addr query.sdf results.oeb   # still works
  ./ShapeDatabaseClient.py 1_4_0_server_addr query.oeb results.oeb   # still works
  ./ShapeDatabaseClient.py 1_4_0_server_addr query.sdf results.sdf   # works now! results can be any file format

.. note:: The servers (ShapeDatabaseServer.py and ShapeDatabaseProxy.py)
  still require an OEChem license. Though it is a long term to remove
  this deficiency in licensing.

  The following client scripts still require OEChem: 
  * ShapeDatabaseIsLoaded.py
  * ShapeDatabaseOEThrowSetLevel.py
  
  This can be coded around upon customer request. 

.. note:: the distribution no longer ships with the OpenEye Java jar files. 

* ShapeDatabasePrep multi-threaded program added to replace the
  CacheStuff.py script to quickly and efficiently prepare OEB database
  files for faster load times into FastROCS. It is now highly
  recommended to run this program on your database to save on load time
  performance by the server.

* The memory footprint of the ShapeDatabaseServer.py has been reduced
  by about half by making use of new experimental OEChem technology,
  the OEMolDatabase. This effectively uses the database file itself to
  serve requests for molecule connection tables. This also improved
  database load time performance by 2x. Load time is now affected by
  disk bandwidth, so better load times can be achieved by investing in
  faster hard drive, e.g., solid state drives.

  Note: it is now highly recommended to pass ShapeDatabaseServer.py an
  uncompressed .oeb file instead of a .oeb.gz file.

* ShapeDatabaseAddMols.py has been removed from the
  distribution. ShapeDatabaseServer.py is now a "read-only" database
  after it finishes loading.

* ShapeDatabaseOEThrowSetLevel.py can now set the server into the
  "Error" level, that is, warnings are not even printed.

* The ShapeDatabaseServer's XML RPC SubmitQuery method now takes 2
  additional optional arguments: iformat='.oeb' and
  iformat='.oeb'. The `iformat` arguments specifies what file format the
  query is being sent in at the first argument to SubmitQuery,
  `querymolstr`. The `oformat` argument specified what file
  format the results should be back in from the `QueryResults`
  method. The default is OEB since clients prior to this version always
  sent data in the OEB format.

* Added the NumConfs method to the OEShapeDatabase object. 

* OEFastROCSGetRelease added to return the version number of the library. 

* CustomColorFFPrep.py script added to demonstrate how to cache color
  atoms on molecules to force the server and client to use a custom
  color force field.

* Support has been added for custom OEColorForceFields to the
  OEShapeDatabase and OEShapeDatabaseOptions objects. The color force
  field given to the OEShapeDatabaseOptions must be a subset of the
  color force field used to construct the OEShapeDatabase. 

Bug Fixes
---------

* Fixed a license check issue that would call sys.exit when no OEChem
  license was present while importing the oeshapedatabase module.

* Fixed a crash that would be caused by using OESetMemPoolMode after
  loading the oeshapedatabase module.

* FastROCS results will now be returned in a deterministic order when
  the scores are identical. The order of hits with identical scores
  would sometimes appear in a different order upon subsequent runs due
  to results being sorted in parallel by the server. FastROCS will now
  break this tie by falling back to the order that the molecules are
  in the database.



FastROCS TK 1.5.0
================================================================================

* This is an initial public beta release of **FastROCS TK** as part of
  the larger **OpenEye Toolkit** suite. Initial support is being
  limited to 64-bit Linux Python platforms. Please bear with us as we
  work to bring **FastROCS TK** up to the same level of quality as you
  should expect from every **OpenEye** toolkit. 

* The core suite of :ref:`FastROCS TK examples
  <fastrocs_examples_suite>` have been tested and will work in this
  distribution. Note, the examples are present in the Windows and OSX
  distributions, but the following examples only work on 64-bit Linux
  Python platforms:

  - ShapeDatabaseServer.py
  - ShapeDatabaseChunker.py
  - BestShapeOverlay.py
  - karma.py

  As **FastROCS TK** works towards official release, example programs
  will likely change names and be re-designed. We will keep
  compatibility with the following core examples many of the current
  **FastROCS** users depend on:

  - ShapeDatabaseServer.py
  - ShapeDatabaseClient.py
  - ShapeDatabaseIsLoaded.py
  - ShapeDatabaseProxy.py

* ShapeDatabaseServer.py will no longer hang indefinitely whenever the
  gzipped results are requested by the client. 

* ShapeDatabaseServer.py now supports specifying a different color
  force field, including a custom color force through a .cff file. 

* ShapeDatabaseServer.py now supports specifying the hostname to bind
  to.

* BestShapeOverlay.py optimized by using
  :ref:`OEMolDatabase <OEChem_OEMolDatabase>` class.

* The name of **FastROCS TK** python module has changed from
  ``oeshapedatabase`` to ``oefastrocs``. The example scripts have
  already been updated to account for the name change. 

* :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` will be much more efficient
  when the database is in an empty state. 

* :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` will now co-exist with other
  GPU processes, including other instances of
  :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` objects. Previously,
  :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` was very aggressive in the
  amount of GPU memory allocated, even when the data set sizes were
  very small. :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` will now be much
  more frugal with the amount of GPU memory it allocates making it
  possible to use many more :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>`
  simultaneously, provided each dataset is small. 

* :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` and
  :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` will now error more
  reliably. Previously, an error could occur, like an out-of-memory
  problem on a GPU, and a partial list of results would be
  returned. This made it very difficult to notice when something was
  wrong, requiring someone to notice the error messages in the server
  log. Now, no results at all will be returned if any problem with the
  search occurs.

* :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` and
  :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` APIs have changed
  from strings of shape queries to take actual
  :ref:`OEShapeQueryPublic <OEShape_OEShapeQueryPublic>` objects.

* :oe:meth:`OEFastROCS::OEShapeDatabase::AddMol` will now throw an
  error immediately if there are no atoms or conformers in the molecule. 

.. note:: Supported NVIDIA Driver: 346.* 
 (see :ref:`Supported NVIDIA Drivers <fastrocs_part_installation>` for alternative **FastROCS TK** releases).




FastROCS TK 1.5.1
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OEFastROCSHistogram <OEFastROCS_OEFastROCSHistogram>` has been added to retrieve
  **FastROCS TK's** score distribution for the entire database, not just
  the hits, in real-time during a **FastROCS TK** query. The
  :ref:`ShapeDatabaseServer.py<section_example_fastrocs_shapedatabaseserver>`
  example was extended with the ``OEFastROCS::QueryHistogram``
  function, as well as the :ref:`ShapeDatabaseProxy.py<section_example_fastrocs_shapedatabaseproxy>`. The
  :ref:`ShapeDatabaseClientHistogram.py<section_example_fastrocs_shapedatabaseclienthistogram>` is
  an example of a client program
  to retrieve the histogram from the server in real time and print it
  to the terminal.

Major bug fixes
--------------------------------------------------------------------------------

* :ref:`ShapeDatabaseServer.py<section_example_fastrocs_shapedatabaseserver>` will
  now make sure to attach SD data from the parent
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>` to the output overlaid conformer.

* :ref:`ShapeDatabaseOEThrowSetLevel.py<section_example_fastrocs_shapedatabaseoethrowsetlevel>` will now
  work to effectively turn on additional performance debugging
  information. The additional operating system threads started by the
  :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` will now inherit the
  :oe:constns:`OESystem::OEErrorLevel` being used by the thread to
  execute the query through
  :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
  :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`.

* **FastROCS TK** will now be compatible with NVidia compute architecture
  2.0 cards. **FastROCS TK** beta in 2015.Jun.5 only worked on compute
  capability 3.x cards. The 2015.Jun.6 release was a bug fix release to fix this
  oversight. **FastROCS TK** in 2015.Oct should now work with any compute
  capability 2.0 card (the Fermi architecture) or greater.

Minor bug fixes
--------------------------------------------------------------------------------

* :ref:`ShapeDatabaseServer.py <section_example_fastrocs_shapedatabaseserver>` will
  now release its port number upon termination more quickly. Previously,
  the server would sometimes fail because when a new process was started
  the port number was already reserved by the previous process.

Documentation fixes
--------------------------------------------------------------------------------

* The :ref:`fastrocs_part_installation` section now recommends installing
  the NVidia driver with the ``--disable-nouveau`` flag to ensure that the
  open source ``nouveau`` display driver kernel module is turned
  off. The NVidia CUDA documentation is a much better source of this
  installation information:
  http://docs.nvidia.com/cuda/cuda-getting-started-guide-for-linux/#runfile-nouveau

.. _section_generalnotices:

General notices
--------------------------------------------------------------------------------
* This is the last release to support **FastROCS TK** on Ubuntu 12.
* Supported NVIDIA Driver: 352.* (see :ref:`Supported NVIDIA Drivers <fastrocs_part_installation>` for alternative **FastROCS TK** releases).


FastROCS TK 1.6.0
================================================================================

New features
--------------------------------------------------------------------------------

* The performance of **FastROCS** when loading a database into memory has
  been significantly improved when the appropriate caching has
  been done to the input OEB file.
  :oe:func:`OEFastROCS::OEPrepareFastROCSMol` function has been added
  to allow preparing a molecule to be written to OEB so that it can be
  read very quickly by :oe:meth:`OEFastROCS::OEShapeDatabase::Open`.
  It is highly recommended to pre-process input OEB
  files with this function to achieve faster load times. This works
  especially well in combination with :oe:func:`OEChem::OEPRECompress`,
  resulting in uncompressed OEB files that are comparable to their
  gzip-compressed counterparts, even with extra cached information
  inside them.

  .. warning::

     :oe:func:`OEFastROCS::OEPrepareFastROCSMol` strips out
     information that **OMEGA** generates (i.e., hydrogen coordinates and
     conformer energies). Care must be taken when using
     these OEB files for alternative use cases. Please refer to the
     :oe:func:`OEFastROCS::OEPrepareFastROCSMol` documentation for a
     full accounting of how the molecules are changed.

* ``OEFastROCSCacheStuff`` was never officially supported and has
  been replaced by the :oe:func:`OEFastROCS::OEPrepareFastROCSMol`
  function. It now throws a deprecation warning and will be
  removed in a future release.

* **FastROCS TK** should be binary compatible with more NVidia driver
  versions as of this release. Previously, **FastROCS TK** could only
  target a single NVidia driver version. Now, several can be targeted
  in a single toolkit build. This version of **FastROCS TK** will work
  on the following NVidia driver versions: 340.x, 346.x, and 352.x. This
  should significantly reduce **FastROCS TK** installation headaches.

* :oe:meth:`OEFastROCS::OEShapeDatabase::SetNumOpenThreads` method
  has been added to control how many CPU operating-system threads are created
  when calling :oe:meth:`OEFastROCS::OEShapeDatabase::Open` on an
  :ref:`OEMolDatabase <OEChem_OEMolDatabase>` object.

* All :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` instances now share the
  same GPU context. Previously, creating many
  :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` instances would result in many
  operating system threads created per instance. This would
  often hit resource limits around the number of threads
  allowed in a single process.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEFastROCS::OEShapeDatabase::Open` now returns ``false``
  if no molecules are read from the :ref:`OEMolDatabase <OEChem_OEMolDatabase>`
  object.

Python-specific changes
--------------------------------------------------------------------------------

* All **FastROCS TK** Python examples now use ``/usr/bin/env python``
  to determine the appropriate Python interpreter to use. Previously,
  some examples were erroneously hardcoded to use ``/usr/bin/python``.

* ``karma.py`` shape clustering example had a minor bug that affected how invalid
  file names were handled. This has been fixed.

Documentation changes
--------------------------------------------------------------------------------

* The **FastROCS TK** :ref:`fastrocs_part_installation` section is now
  more general and defers to the NVidia website for installation
  instructions. A list of supported NVidia drivers for **FastROCS TK**
  can also be found in the :ref:`fastrocs_part_installation` section.


FastROCS TK 1.7.0
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` now consumes
  approximately 50% less main memory. This improvement was gained by
  compressing color information in a more concise way. There should be
  negligible difference in color Tanimoto scores (only seen in the
  4th decimal place).

* Tversky similarity scoring is now available in **FastROCS TK** in addition to
  the default Tanimoto scoring.
  The following APIs have been added to support this new scoring:

  * :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetSimFunc` and
    :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetSimFunc` methods have been added
    to set and retrieve the scoring type.

  * :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetTverskyCoeffs` method has been
    included to allow custom tuning of the alpha and beta coefficients.
    :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetTverskyAlpha` and
    :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetTverskyBeta` methods have
    been added to retrieve the coefficients.

  * :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorTversky`,
    :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeTversky`,
    :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetTverskyCombo`,
    :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetColorScore`,
    :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetShapeScore`,
    and :oe:meth:`OEFastROCS::OEShapeDatabaseScore::GetScore` methods
    have been provided for retrieving Tversky scores.

  For more details about Tversky similarity
  scoring, see the :ref:`molecular_shape_section` section of the
  **Shape TK** theory documentation.

* :oe:func:`OEFastROCS::OEFastROCSIsGPUReady` function has been added to easily
  determine if the GPU is ready to accept **FastROCS TK** queries. It
  returns ``true`` if :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` can
  successfully execute queries on a supported accelerator device, and otherwise
  returns ``false``.  This function checks for the presence and status of
  GPU devices on the system, throwing an error message if the GPU is not
  ready for use. This function allows for any potential GPU issues to
  be caught prior to loading large databases.

* :oe:meth:`OEFastROCS::OEShapeDatabase::PrintMemoryUsage` has been added to
  write out simple statistics about how much memory a particular
  :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object is using and for what
  kinds of data.

* Driver support has been extended to include driver ``361.*``. A list of
  currently supported NVIDIA drivers for **FastROCS TK** can be found in the
  :ref:`fastrocs_part_installation` section.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` and
  :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` will no longer
  add color atoms to queries passed as :ref:`OEConfBase <OEChem_OEConfBase>`
  objects. Previously, the following code would yield non-deterministic
  color scores and bugs::

     for conf in mol.GetConfs():
         for score in shapedb.GetScores(conf):
             ...

  Users were previously instructed to make a temporary copy
  of the conformer into a new :ref:`OEGraphMol <OEChem_OEGraphMol>` before
  passing it to the methods that should have been logically ``const``.
  This is no longer necessary.

* :oe:meth:`OEFastROCS::OEShapeDatabaseScore::Transform` will now
  only change the coordinates of the molecule as the name implies.
  The method will transform hydrogens and color atoms in the
  molecule.

* ShapeDatabaseServer.py will now remove hydrogens from hit lists so
  that results from a cached OEB file (:oe:func:`OEFastROCS::OEPrepareFastROCSMol`)
  are identical to when the server is started on a non-cached OEB file.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEFastROCS::OEShapeDatabase::Open` and
  :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` methods now
  throw an error message if a molecule contains no heavy atoms.

Python-specific changes
--------------------------------------------------------------------------------

* :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` methods will
  no longer release the Python global interpreter lock.

Documentation changes
--------------------------------------------------------------------------------

* ShapeDatabasePrep.py  example now has an optional argument to trim to a
  desired lower number of conformers.

* BestShapeOverlay.py example will now output the proper filenames
  when a problem occurs while opening them.

* Bugs in ShapeDatabaseServer.py, ShapeDatabaseClient.py, and ShapeDatabaseHistogram.py
  that were exposed when tested using Python 3.5 have been fixed.
  Python 3.5 now has a more efficient caching
  system in which file objects are required to be explicitly closed to ensure
  data writes are flushed.


FastROCS TK 1.8.0
================================================================================

New features
--------------------------------------------------------------------------------

* **FastROCS TK** has been switched from an OpenCL backend to a CUDA backend.
  This should have no impact on **FastROCS** usage but may reduce the
  complexity of the installation process. The installation of CUDA development
  tools is *not* required to use **FastROCS TK**.

* NVIDIA driver support has been added for driver versions ``367.*``.
  Support has been dropped for ``340.*``. A list of currently supported
  NVIDIA drivers for **FastROCS TK** can be found in the
  :ref:`fastrocs_part_installation` section.

Minor bug fixes
--------------------------------------------------------------------------------

* The method :oe:meth:`OEFastROCS::OEShapeDatabase::Open` has been modified
  to give a warning rather than an error when a file contains some molecules
  with heavy
  atoms and some molecules without heavy atoms. This is to prevent an entire
  database upload from failing if only a handful of molecules are corrupt.

* ``ShapeSimilarityMatrix.py`` has been renamed ``ShapeDistanceMatrix.py``
  and the resultant matrix has been fixed to accurately reflect distance
  on the diagonal (i.e., 0.0).

Python-specific changes
--------------------------------------------------------------------------------

* The Python integration tests now check for the presence of a GPU and
  skip the **FastROCS** test if a GPU is not available.  Previously, the
  integration tests would fail.


.. _section_fastrocs-tk-1-8-1:

FastROCS TK 1.8.1
================================================================================

New features
--------------------------------------------------------------------------------

* This release extends the capabilities of **FastROCS TK** to allow for
  2 types of alternative starting points: user-defined starts and starts at
  heavy atoms.

  The **FastROCS TK** algorithm involves optimizing each overlaid query and
  database molecule by shape. Previously, the optimization had been performed
  for 4 orientations of each database molecule around its principle axes
  of inertia.

  User-defined starts allow users to input starting coordinates directly.
  The database molecule is now translated to each starting position
  and the 4 inertial poses are optimized.

  Starts at heavy atoms translate each database molecule to each heavy atom
  plus the center of mass of the query molecule.  Again, the 4 inertial
  poses are optimized at each translation.

  For more information, see
  :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` and
  :oe:constns:`OEFastROCS::OEFastROCSOrientation`.

* A new function, :oe:func:`OEFastROCS::OEFastROCSGetNumDevices`, has been
  added that returns the number of GPUs currently visible.  Since no
  **FastROCS TK** objects are required, it can be used to probe a
  system prior to running any queries.

* A new function, :oe:func:`OEFastROCS::OEIsDatabasePrepared`, has been added
  to check whether a database file has already been run through
  :oe:func:`OEFastROCS::OEPrepareFastROCSMol`. This is useful for
  ensuring that a database file has been prepared and also saves time by
  preventing it from being prepared twice. **OpenEye** recommends
  preparing all large databases in order to benefit from significantly
  faster :oe:meth:`OEFastROCS::OEShapeDatabase::Open` times.

* The cutoffs in **FastROCS TK** now support the retrieval of all scores less
  than or equal to the desired cutoff.
  See :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetCutoffLT`.

Major bug fixes
--------------------------------------------------------------------------------

* Customers using Tesla C2050 cards and GTX cards at compute capability 2.x
  may have experienced some issues with large databases of very small
  molecules since compute resources were being over-allocated in some
  scenarios. This issue has been resolved.

Minor bug fixes
--------------------------------------------------------------------------------

* Warnings had previously been thrown for Tversky scores greater than 1.0
  (shape/color).  For performance reasons, components of the Tversky/Tanimoto
  scores can be calculated on either the GPU or CPU.  This sometimes results
  in scores slightly greater than 1.0.  Customers should be aware of this
  possibility when handling scores.  A warning is now thrown if a score is
  greater than 1.2.

* When opening an :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object, the presence
  of invalid molecules now results in a warning rather than error.

* ``karma.py`` can now handle databases with molecules that don't have titles.
  A unique title is given to each untitled molecule.


FastROCS TK 1.8.2
================================================================================

New features
--------------------------------------------------------------------------------

* Alternative starting points in **FastROCS TK** have been extended to now
  include :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs` and
  :oe:constns:`OEFastROCS::OEFastROCSOrientation::InertialAtColorAtoms`.

  * :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs` presumes that the
    query and the database molecules are already correctly aligned in space
    (perhaps through docking), so a single optimization per query-database
    molecule pair is carried out.

  * :oe:constns:`OEFastROCS::OEFastROCSOrientation::InertialAtColorAtoms`
    translates each database molecule to each color atom of the query molecule
    and optimizes for 4 inertial poses at each translation. This method can
    be used with both shape-only searches and combo searches. The only
    requirement is that the query molecule must have color atoms; otherwise,
    the search will throw a warning and default to inertial starts.

  See :oe:constns:`OEFastROCS::OEFastROCSOrientation`
  and :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` for
  more information.

* The following new getter methods have been added to
  :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` for retrieving the number
  of starts for the relevant method:

   * :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumUserStarts`
   * :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumColorAtomStarts`
   * :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumHeavyAtomStarts`
   * :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts`

  :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts`
  has also been overloaded for each alternative start option.

* A new argument has been added to
  :oe:meth:`OEFastROCS::OEShapeDatabase::Open` to ensure that
  conformers are correctly handled when using
  :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs`.

  When using the new :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs`
  feature, the shape database must be opened with the additional argument set
  to :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs`.

  There is no need to alter existing scripts if the
  :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs` alternative
  starts feature is not being used since the default argument
  results in the correct execution path for all other use cases.

  See :oe:meth:`OEFastROCS::OEShapeDatabase::Open` and
  :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs` for more information.

* A new argument has been added to
  :oe:meth:`OEFastROCS::OEShapeDatabaseScore::Constructors` to
  correctly transform conformers to their resultant position when using
  :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs`.

  Generally, the constructor is not used in most scripts as the
  :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` object is constructed
  internally when calling
  :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or
  :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`.
  Therefore, most users will not be affected by this change.

  If the :ref:`OEShapeDatabaseScore <OEFastROCS_OEShapeDatabaseScore>` constructor is used and
  :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs` is set,
  the constructor can be modified with the additional argument set to
  :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs`.

  The default value for the additional argument satisfies all other use
  cases, so no action is required.

  See :oe:meth:`OEFastROCS::OEShapeDatabaseScore::Constructors` for more
  information.

Major bug fixes
--------------------------------------------------------------------------------

* Previously, GPU memory limits were being reached for routine searches when
  using :oe:constns:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`,
  causing searches to default to
  :oe:constns:`OEFastROCS::OEFastROCSOrientation::Inertial`.
  The improved alternative starts algorithm handles any number
  of starts without reaching GPU memory limits.

  .. warning::

     Performance will be affected by using large numbers of alternative
     starts.

* :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxOverlays` now sets
  the number of overlay results to return per conformer.  Previously, this
  was broken and was restricting the number of overlays to 1 per conformer
  regardless of its setting.
  :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxOverlays` is now fixed
  and works correctly with
  :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxConfs`,
  :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumInertialStarts`
  and alternative starts for both
  :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` and
  :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`.

* Tversky calculations no longer overestimate the score of caged systems or
  conformer pairs where one conformer is much larger than the other.

Minor bug fixes
--------------------------------------------------------------------------------

* A warning is now thrown if
  :oe:constns:`OEFastROCS::OEFastROCSOrientation::UserInertialStarts`
  is set with
  :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` and
  :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or if
  :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` is called before
  :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`.

Documentation changes
--------------------------------------------------------------------------------

* A tutorials page has been created that walks through features of
  **FastROCS TK** and gives detailed examples.  The first tutorial gives
  step-by-step instructions on how to use alternative starts.

  If you have a specific feature that you would like
  in a tutorial, please contact support at support@eyesopen.com
  with the subject header **FastROCS TK Tutorial Request**.


FastROCS TK 1.8.3
================================================================================

New features
--------------------------------------------------------------------------------

* Alternative starting points in **FastROCS TK** have been extended to
  include two additional API points:
  :oe:constns:`OEFastROCS::OEFastROCSOrientation::Random` and
  :oe:constns:`OEFastROCS::OEFastROCSOrientation::Subrocs`.

  * :oe:constns:`OEFastROCS::OEFastROCSOrientation::Random` now randomly
    orients the database molecule N times. By default, N is set to 10 with
    a maximum allowed translation of 2 angstroms.  Random alternative starts
    can be customized using the
    :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxRandomTranslation`,
    :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumRandomStarts`, and
    :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetRandomSeed` methods. The
    default random seed is time-dependent.

  * :oe:constns:`OEFastROCS::OEFastROCSOrientation::Subrocs` now
    performs optimizations at every heavy atom of the molecule with the
    most heavy atoms, regardless of which molecule is the query and which
    is the database molecule. At each translation, 4 inertial poses are
    optimized, resulting in a total of [4 * number of heavy atoms of the
    heaviest molecule] optimizations.

  See :oe:constns:`OEFastROCS::OEFastROCSOrientation`
  and :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` for
  more information.

* The following example scripts have been reworked to enable access to
  additional features of **FastROCS TK**:

    - ``ShapeDatabaseServer.py``
    - ``ShapeDatabaseClient.py``
    - ``ShapeDatabaseClientHistogram.py``
    - ``ShapeDatabaseProxy.py``

  Tversky sampling, shape-only searches, and basic alternative starting points
  can be accessed via the client without having to rerun or modify the
  server/proxy scripts. Users can submit a query as usual from the client
  adding the relevant flags. The new flags are:

    - ``--tversky``
    - ``--shapeOnly``
    - ``--alternativeStarts [inertialAtHeavyAtoms|inertialAtColorAtoms|subrocs|random [N]]``

  .. warning::
    These scripts are not backwards compatible. The behavior of running
    server/proxy/client scripts with mismatched versions is undefined.  In
    order to use the new client flags, ensure that the server and proxy
    scripts are also updated to this version.

* Warnings that are thrown for Tversky and Tanimoto scores greater than 1.0
  have been simplified.  Messages showing the actual Tversky/Tanimoto
  calculation are now Debug-level messages.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEFastROCS::OEDBTracer::GetTotal` now correctly accumulates the
  total when using the same :ref:`OEDBTracer <OEFastROCS_OEDBTracer>` object for
  multiple queries.

* :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetLimit` now correctly handles
  the scenario where the limit is greater than the maximum scores available.
  If the limit is greater than the possible number of scores able to be
  returned, a warning will be thrown and the limit will fall back to:
  ``number of conformers *``
  :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetMaxOverlays`.

Python-specific changes
--------------------------------------------------------------------------------

* The example script ``karma.py`` in
  :ref:`FastROCS TK examples <fastrocs_examples_suite>`
  has been renamed to the more descriptive ``SphereExclusionClustering.py``.

Documentation changes
--------------------------------------------------------------------------------

* A new tutorial, :ref:`Tutorial 2  <tutorial_database_prep>`,
  has been created for preparing a database to take advantage
  of faster :oe:meth:`OEFastROCS::OEShapeDatabase::Open` times.


FastROCS TK 1.8.4
================================================================================

New features
--------------------------------------------------------------------------------

* A new Python example script,
  :ref:`BestShapeOverlayMultiConfQuery.py<section_example_fastrocs_bestshapeoverlaymulticonfquery>`,
  has been added to perform a query search for every conformer of the query
  molecule and save the sorted results sequentially in a single file for
  each query molecule.

Minor bug fixes
--------------------------------------------------------------------------------

* A small modification has been made to ``ShapeDatabaseServer.py`` to reduce
  the number of server-related messages when running a query search via the
  client/proxy interface.


FastROCS TK 1.9.0
================================================================================

General notices
--------------------------------------------------------------------------------

* **FastROCS TK** no longer supports Nvidia Tesla, GEForce, and
  Quadro cards with a compute capability of less than 3.0. This includes all GPUs
  with Fermi architecture (e.g., Tesla C2050 and GEForce GTX 430).
  If you are running one of these older GPUs and cannot upgrade your hardware,
  do not update to this version of **FastROCS TK**.

New features
--------------------------------------------------------------------------------

* **FastROCS TK** is now supported for Java and C++. See the new documentation pages for
  `Java <https://docs.eyesopen.com/toolkits/java/fastrocstk>`_ and
  `C++ <https://docs.eyesopen.com/toolkits/cpp/fastrocstk>`_  for examples of
  toolkit usage and syntax.

  .. note::

     Java and C++ **FastROCS TK** API points are currently intended to be used
     only for toolkit functionality and not client-server functionality. The Python
     API should be used if client-server utilities are needed.

* A new :oe:func:`OEFastROCS::OEShapeDatabasePrep` function has been added to provide the same
  functionality as the :ref:`shapedatabaseprep<section_example_fastrocs_shapedatabaseprep>`
  example, except as a multi-threaded function. This should improve performance
  when prepping databases on systems with multiple cores.
  This function is non-deterministic, so molecules will not appear in the
  same order as the input file.

Major bug fixes
--------------------------------------------------------------------------------

* A memory leak that was only detectable when running large numbers of
  queries in succession against the same database without breaking context
  has been fixed.

* The :oe:meth:`OEFastROCS::OEShapeDatabase::AddMol` method was previously missing the ability
  to load molecules for :oe:constns:`OEFastROCS::OEFastROCSOrientation::AsIs` alternative starting
  points. :oe:meth:`OEFastROCS::OEShapeDatabase::AddMol` now takes the
  :oe:constns:`OEFastROCS::OEFastROCSOrientation` constant as an additional argument.
  The default is :oe:constns:`OEFastROCS::OEFastROCSOrientation::Inertial`.

Documentation changes
--------------------------------------------------------------------------------

* The examples section of the documentation has been reorganized by type:
  :ref:`section_example_fastrocs_simple_examples`,
  :ref:`section_example_fastrocs_alternative_starts`, and
  :ref:`section_example_fastrocs_client_server`.
  All are viewable from the :ref:`fastrocs_examples_suite`, which includes brief
  descriptions as well as links to the specific example pages.
  The example pages now provide more in-depth descriptions of usage and
  download links to the example code.

* New examples have been added to the :ref:`section_example_fastrocs_alternative_starts`
  section to demonstrate using **FastROCS TK** with alternative starts.

* Documentation for both the `Java <https://docs.eyesopen.com/toolkits/java/fastrocstk>`_ and
  `C++ <https://docs.eyesopen.com/toolkits/cpp/fastrocstk>`_
  versions of **FastROCS TK** has been added.





FastROCS TK 2.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* Two new options have been added to the :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` class:

  * :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetColorOptimization` is used for
    optimization over color overlap in addition to shape overlap during a **FastROCS**
    overlay calculation.

  * :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetFastROCSMode` is used to change
    several of the options in the :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` class to match
    what they would be in **ROCS** for a closer (though not identical) comparison
    to **ROCS**.

Minor bug fixes
--------------------------------------------------------------------------------

* A warning regarding Tversky scores greater than 1.0 will now only be thrown if
  running with the Tversky scoring function.

General Notices
--------------------------------------------------------------------------------

* The C++ **FastROCS TK** is not available on RHEL8 or Ubuntu18 in this release.



FastROCS TK 2.1.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------
* **FastROCS TK** now requires a minimum NVIDIA Driver version of 450.x.
  See :ref:`section_supported_gpus_drivers` for more details.
* **FastROCS TK** now requires a minimum GPU compute capability of 3.5. See :ref:`section_supported_gpus` for more details.
* :ref:`OEShapeQuery <OEShape_OEShapeQuery>` objects now have limited support for use as
  queries with the :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores`
  and :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` database searching methods.
* Support has been dropped for database files that are gzipped (e.g. ``oeb.gz``
  in the **FastROCS TK** examples). ``.oeb`` and ``.oez`` are still supported.
* A new database type, :oe:const:`OEFastROCS::OEShapeDatabaseType::Sitehopper`,
  has been added that runs Sitehopper calculations using fastrocs. Note that a
  Sitehopper license is required to run a Sitehopper calculation. Please visit https://www.eyesopen.com/contact or your account manager for a license.

Major bug fixes
--------------------------------------------------------------------------------
* Previously, GPU memory limits were being reached for routine searches when
  using :oe:constns:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`
  with :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetColorOptimization` set to true,
  causing the color calculation to default to the CPU. The improved alternative starts
  algorithm handles any number of starts without reaching GPU memory limits.

  .. warning::

     Performance will be affected by using large numbers (> 10) of alternative
     starts.

* Previously, the :ref:`section_example_fastrocs_shapeclustering` example suffered
  some performance degradation. This has now been fixed thanks to a performance bug
  fix in :oe:func:`OEShape::OESelfShape`. The script should now perform at its normal speed,
  ~10x that of the previous release.

Minor bug fixes
--------------------------------------------------------------------------------
* A warning is now thrown if users attempt to use a custom color forcefield that has either a non-Gaussian
  functional form or interactions between different color types.

Python specific changes
--------------------------------------------------------------------------------
* ``SimplePythonScript.py`` has been renamed ``SimpleFastROCSSearch.py`` in
  :ref:`Tutorial 1: Inertial At Heavy Atoms Alternative Starts<tutorial1_InertialAtHeavyAtoms_section>`.

* :oe:func:`OEChem::OEPreserveRotCompress` has been added to the molecule input
  stream in the ``SimplePrepScript.py`` script used in :ref:`tutorial_database_prep`.

Java specific changes
--------------------------------------------------------------------------------
* ``SimpleJavaScript.java`` has been renamed ``SimpleFastROCSSearch.java`` in
  :ref:`Tutorial 1: Inertial At Heavy Atoms Alternative Starts<tutorial1_InertialAtHeavyAtoms_section>`.

* :oe:func:`OEChem::OEPreserveRotCompress` has been added to the molecule input
  stream in the ``SimplePrepScript.java`` script used in :ref:`tutorial_database_prep`.

C++ specific changes
--------------------------------------------------------------------------------
* ``simplecppscript.cpp`` has been renamed ``simplefastrocssearch.cpp`` in
  :ref:`Tutorial 1: Inertial At Heavy Atoms Alternative Starts<tutorial1_InertialAtHeavyAtoms_section>`.

* :oe:func:`OEChem::OEPreserveRotCompress` has been added to the molecule input
  stream in the ``simpleprepscript.cpp`` script used in :ref:`tutorial_database_prep`.

Documentation changes
--------------------------------------------------------------------------------
* :ref:`tutorial_database_prep` now has an additional step explaining
  :oe:func:`OEChem::OEPreserveRotCompress`.




FastROCS TK 2.2.0
================================================================================

*July 2021*

New features
--------------------------------------------------------------------------------

* A new method, :oe:meth:`OEFastROCS::OEShapeDatabaseScore::ExtractTransform`, that extracts an
  entire transform (not just the post inertial frame transformation) has been added.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue with custom weights in FastROCS :ref:`custom color <chapter_custom_color>` has been fixed.



FastROCS TK 2.2.1
================================================================================

* Minor internal improvements have been made.




FastROCS TK 2.2.2
================================================================================

* Minor internal improvements have been made.





FastROCS TK 2.2.3
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* A memory leak which could cause a crash when calling :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores` or :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` has bee fixed.




FastROCS TK 2.2.4
================================================================================

Minor internal improvements have been made.




FastROCS TK 2.2.5
================================================================================

Minor internal improvements have been made.





FastROCS TK 2.2.6
================================================================================

Minor internal improvements have been made.





FastROCS TK 2.2.7
================================================================================

New features
--------------------------------------------------------------------------------

* New methods have been added to the :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` class
  that allow the shape and color scales to be modified.

  * :ref:`SetShapeScoreScale<OEFastROCS_OEShapeDatabaseOptions_SetShapeScoreScale>`
  * :ref:`GetShapeScoreScale<OEFastROCS_OEShapeDatabaseOptions_GetShapeScoreScale>`
  * :ref:`SetColorScoreScale<OEFastROCS_OEShapeDatabaseOptions_SetColorScoreScale>`
  * :ref:`GetColorScoreScale<OEFastROCS_OEShapeDatabaseOptions_GetColorScoreScale>`



FastROCS TK 2.3.0
================================================================================

New Features
--------------------------------------------------------------------------------

* **FastROCS TK** now supports shape grids in the input query, analogous to **Shape TK**.

Minor Bug Fixes
--------------------------------------------------------------------------------

* A bug in the overlaid database pose has been fixed in the transformation from the inertial
  frame to the original one. **FastROCS** scores are unaffected. As a result, the CPU steps
  on top of **FastROCS** poses are no longer needed in **SiteHopper**.




FastROCS TK 2.3.1
================================================================================

Minor internal improvements have been made.


###############################################
Appendix: Additional Examples in Python
###############################################

These are full listings of programming examples that are excerpted or offered for download, elsewhere in this chapter.
See the :ref:`full list of examples in this chapter <fastrocs_part_examples>`.

..	_listing-CustomColorForceField_Snippet.py:

..  oe:source:: CustomColorForceField_Snippet.py
    :language:  python
    :refnum: 1
    :caption: Full listing of CustomColorForceField.py.

..	_listing-OEShapeDatabaseOptions_SetUserStarts.py:

..  oe:source:: OEShapeDatabaseOptions_SetUserStarts.py
    :language:  python
    :refnum: 2
    :caption: Full listing of OEShapeDatabaseOptions_SetUserStarts.py.

..	_listing-Tutorial1_InertialAtHeavyAtoms_Snippet.py:

..  oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.py
    :language:  python
    :refnum: 3
    :caption: Full listing of Tutorial1_InertialAtHeavyAtoms_Snippet.py

..	_listing-ShapeDatabaseClientHistogram.py:

..  oe:source:: ShapeDatabaseClientHistogram.py
    :language:  python
    :refnum: 4
    :caption: Shape Database Client Histogram.

..	_listing-AsIsStartsExample.py:

..  oe:source:: AsIsStartsExample.py
    :language:  python
    :refnum: 6
    :caption: AsIs starts.

..	_listing-BestShapeOverlay.py:

..  oe:source:: BestShapeOverlay.py
    :language:  python
    :refnum: 7
    :caption: Database searching with queries.

..	_listing-BestShapeOverlayMultiConfQuery.py:

..  oe:source:: BestShapeOverlayMultiConfQuery.py
    :language:  python
    :refnum: 8
    :caption: Database searching with every conformer of every query.

..	_listing-BestTverskyShapeOverlay.py:

..  oe:source:: BestTverskyShapeOverlay.py
    :language:  python
    :refnum: 9
    :caption: Database searching with queries using Tversky similarity scoring.

..	_listing-ColorOptimizationExample.py:

..  oe:source:: ColorOptimizationExample.py
    :language:  python
    :refnum: 10
    :caption: Optimize over color overlap in addition to shape overlap.

..	_listing-CustomColorFFPrep.py:

..  oe:source:: CustomColorFFPrep.py
    :language:  python
    :refnum: 11
    :caption: Cache custom color atoms onto molecules.

..	_listing-ImplicitMillsDeanNoRingsExample.py:

..  oe:source:: ImplicitMillsDeanNoRingsExample.py
    :language:  python
    :refnum: 12
    :caption: Run FastROCS with the implicit Mills-Dean color force field, sans rings.

..	_listing-InertialAtHeavyAtomStartsExample.py:

..  oe:source:: InertialAtHeavyAtomStartsExample.py
    :language:  python
    :refnum: 13
    :caption: Database searching with queries using the inertial at heavy atoms starting orientation.

..	_listing-ROCSModeExample.py:

..  oe:source:: ROCSModeExample.py
    :language:  python
    :refnum: 14
    :caption: Turn on ROCS mode.

..	_listing-SphereExclusionClustering.py:

..  oe:source:: SphereExclusionClustering.py
    :language:  python
    :refnum: 15
    :caption: Cluster database into shape clusters.

..	_listing-ShapeDatabaseChunker.py:

..  oe:source:: ShapeDatabaseChunker.py
    :language:  python
    :refnum: 16
    :caption: Split database into chunks.

..	_listing-ShapeDatabaseClient.py:

..  oe:source:: ShapeDatabaseClient.py
    :language:  python
    :refnum: 17
    :caption: Send query to specified server.

..	_listing-ShapeDatabaseServer.py:

..  oe:source:: ShapeDatabaseServer.py
    :language:  python
    :refnum: 18
    :caption: Run the FastROCS server.

..	_listing-ShapeDatabaseIsLoaded.py:

..  oe:source:: ShapeDatabaseIsLoaded.py
    :language:  python
    :refnum: 19
    :caption: Returns whether the database has completed loading in server:port.

..	_listing-ShapeDatabaseOEThrowSetLevel.py:

..  oe:source:: ShapeDatabaseOEThrowSetLevel.py
    :language:  python
    :refnum: 20
    :caption: Adjust the verbosity of server running on server:port.

..	_listing-ShapeDatabasePrep.py:

..  oe:source:: ShapeDatabasePrep.py
    :language:  python
    :refnum: 21
    :caption: Prepare OEB file for faster load performance.

..	_listing-ShapeDatabaseProxy.py:

..  oe:source:: ShapeDatabaseProxy.py
    :language:  python
    :refnum: 22
    :caption: Tie multiple servers to appear as a single server.

..	_listing-ShapeDistanceMatrix.py:

..  oe:source:: ShapeDistanceMatrix.py
    :language:  python
    :refnum: 23
    :caption: Calculate distance between all molecules in database with themselves.

..	_listing-UserInertialStartsExample.py:

..  oe:source:: UserInertialStartsExample.py
    :language:  python
    :refnum: 24
    :caption: Database searching with queries using the user inertial starts orientation.



.. _fastrocs_part_theory:

################
FastROCS vs ROCS
################

OpenEye makes available two separate shape based virtual screening
technologies:

:ROCS: Thousands of conformers per second
:FastROCS: Millions of conformers per second

The ROCS technology is also embodied in the Shape TK. The Shape TK is
a very flexible toolkit for experimenting with molecular shape and
different ways that it can be applied. FastROCS is also deployed as a
toolkit, but with a very different goal in mind: **raw
performance**. In order to achieve this raw performance GPU hardware
is utilized. The use of GPUs required the complete rewrite of the
ROCS algorithm to work well on GPUs. Furthermore, the opportunity was
taken to completely rethink all trade-offs the algorithm makes in
preference to speed. Therefore, it is expected that ROCS and FastROCS
will output slightly different results.

In order for FastROCS to achieve a throughput of millions of
conformers per second the entire informatics base of shape comparison
had to be reimagined. FastROCS operates on millions of conformers in
memory, in parallel, all at once. Whereas, the Shape TK will typically
only operate on a single molecule at a time. Therefore, FastROCS is
designed as a web service to serve shape queries from a database
pre-loaded into memory: :ref:`ShapeDatabaseServer.py<section_example_fastrocs_shapedatabaseserver>` example. The
ShapeDatabaseServer.py is the best place for new users to start.

The ShapeDatabaseServer.py example is built around the most important
API in FastROCS TK, the :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>`. The
:ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` class is built to be a natural
extension of the :ref:`OEMolDatabase <OEChem_OEMolDatabase>` class in **OEChem
TK**. The :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object will manage the
storage of conformers in memory and interacting with any GPU in the
system. Theoretically, the user of
:ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` should not have to know that
their calculation is being performed on a GPU.

.. note::

   For batch processing operations where databases are brought into
   memory temporarily, the :ref:`BestShapeOverlay.py<section_example_fastrocs_bestshapeoverlay>`
   is a better first script to read and alter.


.. _fastrocs_part_tutorials:

*********************************
Tutorials
*********************************

.. oe:language:: c++ java

   .. toctree::
      :maxdepth: 3

      tutorials/Tutorial_1_Alternative_Starts/index
      tutorials/Tutorial_2_Database_Preparation/database_prep

.. oe:language:: python

   .. toctree::
      :maxdepth: 3

      tutorials/Tutorial_0_Basic_Usage/basic_usage
      tutorials/Tutorial_1_Alternative_Starts/index
      tutorials/Tutorial_2_Database_Preparation/database_prep



*******************************************************************************
Tutorial 1: Alternative Starts
*******************************************************************************

.. toctree::
   :maxdepth: 1

   Introduction.rst
   InertialAtHeavyAtoms.rst
   UserInertialStarts.rst
   AsIs.rst
   RetrievingResults.rst


.. _tutorial_alternative_starts_introduction_section:

Introduction
================================================================================

In this tutorial you will learn how to make use of the alternative starts
functionality in **FastROCS TK**. This functionality was introduced in the
**OpenEye Toolkits v2017.Feb** release of
:ref:`section_fastrocs-tk-1-8-1`.

.. note::
   The data used in this tutorial is **not** provided.

Alternative starting points refer to the starting orientations of the
query-conformer
pair when optimizing their overlap in space. The default method is
:oe:meth:`OEFastROCS::OEFastROCSOrientation::Inertial`. In this method, the
molecules are centered and set to an inertial frame of reference. The database
molecule is then rotated about its inertial axes, creating up to a possible 8
starting points at which overlays are then optimized.

The default optimizes the first
4 inertial starts only. This can be changed via the
:oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetNumInertialStarts` method.
The figure below shows the inertial starting points of caffeine.

.. _alternative_starts_figure_1:

.. figure:: /_images/Tutorial_1_Figure_1.png
   :align: center

   **Inertial Starting Points of Caffeine**

For some molecular structures these inertial starting positions may not lead to
adequate sampling of the molecular volume overlap space, resulting in poor
overlap/scores. Making use of alternative starts can solve this problem by
creating additional starting positions at which to perform the inertial
optimizations.  One example of this is the alignment of 4TMN and 3TMN
ligands of Thrombin [Grant-1996]_.

The figure below shows the 2D molecular structure of these ligands and their
x-ray alignment. The x-ray alignment shows a good overlap between
3TMN and the side chain of 4TMN.

.. _alternative_starts_figure_2:

.. figure:: /_images/Tutorial_1_Figure_2.png
   :align: center

   **Alternative Starts Use Case**

   4TMN ligand, 3TMN ligand, and their x-ray alignment.

The figure below shows the resultant overlays in **FastROCS TK**
when using default starting points compared to
:oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`
starting points.

.. _alternative_starts_figure_3:

.. figure:: /_images/Tutorial_1_Figure_3.png
   :align: center

   **Overlap Comparison**

   Overlay generated from performing a default search (left) compared
   with ”InertialAtHeavyAtoms” search (right).

The default search results in poor overlap between the two molecules (left).
When the new
:oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`
orientation option is used, the resultant overlap is much more
favorable (right) and correlates well with the x-ray alignment
from :ref:`alternative_starts_figure_2`.

There are 5 methods currently implemented in **FastROCS TK** that allow
different starting orientations to be experimented with. They are:

* :oe:meth:`OEFastROCS::OEFastROCSOrientation::Inertial`
* :oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`
* :oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtColorAtoms`
* :oe:meth:`OEFastROCS::OEFastROCSOrientation::UserInertialStarts`
* :oe:meth:`OEFastROCS::OEFastROCSOrientation::AsIs`

A description of these can be found in the
:oe:constns:`OEFastROCS::OEFastROCSOrientation` section of the docs.

This tutorial will focus on 3 alternative starts methods:

* :oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`
* :oe:meth:`OEFastROCS::OEFastROCSOrientation::UserInertialStarts`
* :oe:meth:`OEFastROCS::OEFastROCSOrientation::AsIs`

The methodology described can be adapted to the remaining starting point
options that are not described in this tutorial. For example, the use case for
:oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtColorAtoms`
is almost identical to
:oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms` except for
the constant passed in to
:oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`
and the use of
:oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumColorAtomStarts` instead of
:oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumHeavyAtomStarts`
to retrieve the number of starts.


.. _tutorial1_InertialAtHeavyAtoms_section:

InertialAtHeavyAtoms
================================================================================

:oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms` translates
the center of mass (COM) of each database molecule to each heavy atom of the
query molecule and to the query molecule’s COM. 4 inertial orientations are
then optimized at each translation.

The figures below demonstrate the starting positions optimized for the first 2
heavy atoms in the query molecule:

.. _alternative_starts_figure_4:

.. figure:: /_images/Tutorial_1_Figure_4a.png
   :align: center

   **Inertial starts optimized at heavy atom 1 (highlighted green)**

.. figure:: /_images/Tutorial_1_Figure_4b.png
   :align: center

   **Inertial starts optimized at heavy atom 2 (highlighted green)**

Inertial starts continue to be optimized for the remaining atoms of the query
molecule and it’s COM.

.. oe:language:: c++
  
   Below is a link to a c++ script demonstrating the most basic usage of **FastROCS TK**.
   After explaining this simple script it will be modified to make use of the
   :oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`
   function.

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simplefastrocssearch.cpp <../../../../../../sublibs/tklibs/fastrocs/examples/simplefastrocssearch.cpp>`

   .. only:: oepdf

      .. oe:source:: simplefastrocssearch.cpp
         :language: c++
    
   The script creates an :ref:`OEMolDatabase <OEChem_OEMolDatabase>` and an
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object. The database file is first
   opened as an :ref:`OEMolDatabase <OEChem_OEMolDatabase>` object, which is used to load
   the molecules into :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` via
   :oe:meth:`OEFastROCS::OEShapeDatabase::Open`. This is the simplest example
   of loading a database.  The database is now ready for either combo or
   shape-only searches.

   .. note::

      To restrict searches to shape-only, create a shape-only database object:

      .. oe:source:: tutorial1_inertialatheavyatoms_snippet.cpp
         :language:  c++
         :frag:      SNIPPET-1

      While this reduces the memory footprint of the database as color data is
      no longer stored, the database cannot be searched for color scores.
 
.. oe:language:: python
  
   Below is a link to a python script demonstrating the most basic usage of **FastROCS TK**.
   After explaining this simple script it will be modified to make use of the
   :oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`
   function.

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleFastROCSSearch.py <../../../../../../wrappers/python/examples/fastrocs/SimpleFastROCSSearch.py>`

   .. only:: oepdf

      .. oe:source:: SimpleFastROCSSearch.py
         :language: python
    
   The script creates an :ref:`OEMolDatabase <OEChem_OEMolDatabase>` and an
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object. The database file is first
   opened as an :ref:`OEMolDatabase <OEChem_OEMolDatabase>` object, which is used to load
   the molecules into :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` via
   :oe:meth:`OEFastROCS::OEShapeDatabase::Open`. This is the simplest example
   of loading a database.  The database is now ready for either combo or
   shape-only searches.

   .. note::

      To restrict searches to shape-only, create a shape-only database object:

      .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.py
         :language:  python
         :frag:      SNIPPET-1

      While this reduces the memory footprint of the database as color data is
      no longer stored, the database cannot be searched for color scores.

.. oe:language:: java
  
   Below is a link to a java script demonstrating the most basic usage of **FastROCS TK**.
   After explaining this simple script it will be modified to make use of the
   :oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`
   function.

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleFastROCSSearch.java <../../../../../../wrappers/java/examples/openeye/examples/oefastrocs/SimpleFastROCSSearch.java>`

   .. only:: oepdf

      .. oe:source:: SimpleFastROCSSearch.java
         :language: java
    
   The script creates an :ref:`OEMolDatabase <OEChem_OEMolDatabase>` and an
   :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` object. The database file is first
   opened as an :ref:`OEMolDatabase <OEChem_OEMolDatabase>` object, which is used to load
   the molecules into :ref:`OEShapeDatabase <OEFastROCS_OEShapeDatabase>` via
   :oe:meth:`OEFastROCS::OEShapeDatabase::Open`. This is the simplest example
   of loading a database.  The database is now ready for either combo or
   shape-only searches.

   .. note::

      To restrict searches to shape-only, create a shape-only database object:

      .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.java
         :language:  java
         :frag:      SNIPPET-1

      While this reduces the memory footprint of the database as color data is
      no longer stored, the database cannot be searched for color scores.

.. oe:language:: c++ python java

   In this example, an :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` object is
   also created and the number of results is limited to 5 via the
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetLimit` method.

   Next, the query molecule is set up is using a molecule stream and the
   :oe:func:`OEChem::OEReadMolecule` function. Queries are used to search the
   loaded database via the :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores`
   method. The :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` class is passed to
   customize the search options.   In this example, a subset of the eMolecules
   database was searched against a benzene query molecule.
   The top 5 scores are shown below.

   .. code-block:: console

      Opening database file eMolecules.2015.1_100subset.oeb ...
      Searching for benzene.oeb
      Score for mol 65(conf 1) 0.530182 shape 0.237350 color
      Score for mol 45(conf 1) 0.678128 shape 0.085376 color
      Score for mol 49(conf 1) 0.596801 shape 0.153465 color
      Score for mol 92(conf 0) 0.503204 shape 0.155330 color
      Score for mol 33(conf 1) 0.442559 shape 0.175599 color

.. oe:language:: c++

   To make use of the
   :oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`
   feature, modify the :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` object
   as follows:

      .. oe:source:: tutorial1_inertialatheavyatoms_snippet.cpp
         :language:  c++
         :frag:      SNIPPET-2

.. oe:language:: python

   To make use of the
   :oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`
   feature, modify the :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` object
   as follows:

      .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.py
         :language:  python
         :frag:      SNIPPET-2

.. oe:language:: java

   To make use of the
   :oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`
   feature, modify the :ref:`OEShapeDatabaseOptions <OEFastROCS_OEShapeDatabaseOptions>` object
   as follows:

      .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.java
         :language:  java
         :frag:      SNIPPET-2

.. oe:language:: c++ python java

   An additional option,
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`, is
   also set to the desired method,
   :oe:meth:`OEFastROCS::OEFastROCSOrientation::InertialAtHeavyAtoms`.
   The resultant scores reflect the change in starting points:

   .. code-block:: console

      Opening database file eMolecules.2015.1_100subset.oeb ...
      Searching for benzene.oeb
      Score for mol 45(conf 1) 0.669345 shape 0.121420 color
      Score for mol 65(conf 1) 0.530182 shape 0.237350 color
      Score for mol 49(conf 1) 0.596801 shape 0.153465 color
      Score for mol 92(conf 0) 0.503204 shape 0.155330 color
      Score for mol 33(conf 1) 0.442559 shape 0.175599 color

   The :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumHeavyAtomStarts`
   method can be used to
   find out how many heavy atom starts are being optimized.
   This method requires the query molecule in order to return the number of starts:

.. oe:language:: c++

      .. oe:source:: tutorial1_inertialatheavyatoms_snippet.cpp
         :language:  c++
         :frag:      SNIPPET-3

   When this code snippet is added to the C++ script, the output should
   look like this:

   .. code-block:: console

      This example will use 7 starts
      Searching for benzene.oeb
      Score for mol 45(conf 1) 0.669345 shape 0.121420 color
      Score for mol 65(conf 1) 0.530182 shape 0.237350 color
      Score for mol 49(conf 1) 0.596801 shape 0.153465 color
      Score for mol 92(conf 0) 0.503204 shape 0.155330 color
      Score for mol 33(conf 1) 0.442559 shape 0.175599 color

   .. only:: oehtml

      .. admonition:: Download code

         The fully modified c++ script used in this tutorial can be found here
         :download:`inertialatheavyatomstarts.cpp <../../../../../../sublibs/tklibs/fastrocs/examples/inertialatheavyatomstarts.cpp>`

   .. only:: oepdf

      .. oe:source:: inertialatheavyatomstarts.cpp
         :language: c++

.. oe:language:: python

      .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.py
         :language:  python
         :frag:      SNIPPET-3

   When this code snippet is added to the Python script, the output should
   look like this:

   .. code-block:: console

      This example will use 7 starts
      Searching for benzene.oeb
      Score for mol 45(conf 1) 0.669345 shape 0.121420 color
      Score for mol 65(conf 1) 0.530182 shape 0.237350 color
      Score for mol 49(conf 1) 0.596801 shape 0.153465 color
      Score for mol 92(conf 0) 0.503204 shape 0.155330 color
      Score for mol 33(conf 1) 0.442559 shape 0.175599 color

   .. only:: oehtml

      .. admonition:: Download code

         The fully modified python script used in this tutorial can be found here
         :download:`InertialAtHeavyAtomStartsExample.py <../../../../../../wrappers/python/examples/fastrocs/InertialAtHeavyAtomStartsExample.py>`

   .. only:: oepdf

      .. oe:source:: InertialAtHeavyAtomStartsExample.py
         :language: python

.. oe:language:: java

      .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.java
         :language:  java
         :frag:      SNIPPET-3

   When this code snippet is added to the Java script, the output should
   look like this:

   .. code-block:: console

      This example will use 7 starts
      Searching for benzene.oeb
      Score for mol 45(conf 1) 0.669345 shape 0.121420 color
      Score for mol 65(conf 1) 0.530182 shape 0.237350 color
      Score for mol 49(conf 1) 0.596801 shape 0.153465 color
      Score for mol 92(conf 0) 0.503204 shape 0.155330 color
      Score for mol 33(conf 1) 0.442559 shape 0.175599 color

   .. only:: oehtml

      .. admonition:: Download code

         The fully modified python script used in this tutorial can be found here
         :download:`InertialAtHeavyAtomStartsExample.java <../../../../../../wrappers/java/examples/openeye/examples/oefastrocs/InertialAtHeavyAtomStartsExample.java>`

   .. only:: oepdf

      .. oe:source:: InertialAtHeavyAtomStartsExample.java
         :language: java


.. _tutorial1_UserInertialStarts_section:

UserInertialStarts
================================================================================

:oe:meth:`OEFastROCS::OEFastROCSOrientation::UserInertialStarts` allows custom
coordinates to be used as starting positions for optimization. Using the
:ref:`4TMN ligand<alternative_starts_figure_2>` from the
:ref:`tutorial_alternative_starts_introduction_section` as an example,
optimization can be done at the atom highlighted in green below:

.. _alternative_starts_figure_5:

.. figure:: /_images/Tutorial_1_Figure_5.png
   :align: center
   :width: 400

   **4TMN Ligand with atom 34 highlighted green**

Before running the program, the index of the desired atom needs to be
identified.  This can be accomplished by loading the molecule in **VIDA** and
turning on atom indices.  In this example, the atom’s index is identified
as idx 34.  With this information, the x,y,z coordinates of atom idx 34 are
pulled via the code snippet below.
These coordinates are then used as user-defined starting coordinates:

.. oe:language:: c++

   .. oe:source:: tutorial1_inertialatheavyatoms_snippet.cpp
      :language:  c++
      :frag:      SNIPPET-4

   To use the :oe:meth:`OEFastROCS::OEFastROCSOrientation::UserInertialStarts`
   method, set
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` and then
   input the starts
   vector using :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`:

   .. oe:source:: tutorial1_inertialatheavyatoms_snippet.cpp
      :language:  c++
      :frag:      SNIPPET-5

   The first argument of
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts` is the
   startsCoords array created previously. This must be of the type
   ``float array``.  The second argument is the number of user-defined
   starting coordinates to optimize.

   In this example, only 1 user-defined starting point has been set.
   There is no limit to the number of user-defined starts however, it should
   be noted that performance is inversely proportional to the number of starts
   being optimized.

   To check that the starts have been set correctly, query
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation` and
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumUserStarts`:

   .. oe:source:: tutorial1_inertialatheavyatoms_snippet.cpp
      :language:  c++
      :frag:      SNIPPET-6

   The output from the modified C++ script now looks like this:

   .. code-block:: console

      Opening database file 3tmn_lig.sdf ...
      This example will use 1 starts
      Searching for 4tmn_lig.sdf
      Score for mol 0(conf 0) 0.289689 shape 0.358462 color
      Score for mol 0(conf 0) 0.320501 shape 0.098301 color
      Score for mol 0(conf 0) 0.283724 shape 0.012400 color
      Score for mol 0(conf 0) 0.145704 shape 0.023627 color

   .. only:: oehtml

      .. admonition:: Download code

         The fully modified c++ script used in this tutorial can be found here
         :download:`userinertialstarts.cpp <../../../../../../sublibs/tklibs/fastrocs/examples/userinertialstarts.cpp>`

   .. only:: oepdf

      .. oe:source:: userinertialstarts.cpp
         :language: c++

.. oe:language:: python

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.py
      :language:  python
      :frag:      SNIPPET-4

   :ref:`Full listing. <listing-Tutorial1_InertialAtHeavyAtoms_Snippet.py>`

   To use the :oe:meth:`OEFastROCS::OEFastROCSOrientation::UserInertialStarts`
   method, set
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` and then
   input the starts
   vector using :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`:

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.py
      :language:  python
      :frag:      SNIPPET-5

   :ref:`Full listing. <listing-Tutorial1_InertialAtHeavyAtoms_Snippet.py>`

   The first argument of
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts` is the
   startsCoords vector created previously. This must be of the type
   ``OEFloatVector``.  The second argument is the number of user-defined
   starting coordinates to optimize.

   In this example, only 1 user-defined starting point has been set.
   There is no limit to the number of user-defined starts however, it should
   be noted that performance is inversely proportional to the number of starts
   being optimized.

   To check that the starts have been set correctly, query
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation` and
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumUserStarts`:

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.py
      :language:  python
      :frag:      SNIPPET-6

   :ref:`Full listing. <listing-Tutorial1_InertialAtHeavyAtoms_Snippet.py>`

   The output from the modified Python script now looks like this:

   .. code-block:: console

      Opening database file 3tmn_lig.sdf ...
      This example will use 1 starts
      Searching for 4tmn_lig.sdf
      Score for mol 0(conf 0) 0.289689 shape 0.358462 color
      Score for mol 0(conf 0) 0.320501 shape 0.098301 color
      Score for mol 0(conf 0) 0.283724 shape 0.012400 color
      Score for mol 0(conf 0) 0.145704 shape 0.023627 color

   .. only:: oehtml

      .. admonition:: Download code

         The fully modified python script used in this tutorial can be found here
         :download:`UserInertialStartsExample.py <../../../../../../wrappers/python/examples/fastrocs/UserInertialStartsExample.py>`

   .. only:: oepdf

      .. oe:source:: UserInertialStartsExample.py
         :language: python

.. oe:language:: java

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.java
      :language:  java
      :frag:      SNIPPET-4

   To use the :oe:meth:`OEFastROCS::OEFastROCSOrientation::UserInertialStarts`
   method, set
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation` and then
   input the starts
   vector using :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts`:

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.java
      :language:  java
      :frag:      SNIPPET-5

   The first argument of
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetUserStarts` is the
   startsCoords array created previously. This must be of the type
   ``OEFloatArray``.  The second argument is the number of user-defined
   starting coordinates to optimize.

   In this example, only 1 user-defined starting point has been set.
   There is no limit to the number of user-defined starts however, it should
   be noted that performance is inversely proportional to the number of starts
   being optimized.

   To check that the starts have been set correctly, query
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetInitialOrientation` and
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumUserStarts`:

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.java
      :language:  java
      :frag:      SNIPPET-6

   The output from the modified Java script now looks like this:

   .. code-block:: console

      Opening database file 3tmn_lig.sdf ...
      This example will use 1 starts
      Searching for 4tmn_lig.sdf
      Score for mol 0(conf 0) 0.289689 shape 0.358462 color
      Score for mol 0(conf 0) 0.320501 shape 0.098301 color
      Score for mol 0(conf 0) 0.283724 shape 0.012400 color
      Score for mol 0(conf 0) 0.145704 shape 0.023627 color

   .. only:: oehtml

      .. admonition:: Download code

         The fully modified java script used in this tutorial can be found here
         :download:`UserInertialStartsExample.java <../../../../../../wrappers/java/examples/openeye/examples/oefastrocs/UserInertialStartsExample.java>`

   .. only:: oepdf

      .. oe:source:: UserInertialStartsExample.java
         :language: java


.. _tutorial1_AsIsStarts_section:

AsIs
================================================================================

The final method to be discussed is
:oe:meth:`OEFastROCS::OEFastROCSOrientation::AsIs`.
In this method, only one optimization is carried out at the query and the
database molecule's original coordinates. **No inertial starts are optimized.**

When using this method, the database intended to be searched must be reloaded
using :oe:meth:`OEFastROCS::OEShapeDatabase::Open`. This ensures that the
database molecules are not centered or set to an inertial frame of reference
as is usually done.  When reloading the database,
the :oe:meth:`OEFastROCS::OEFastROCSOrientation::AsIs`
constant must be passed to the ``Open`` routine:

.. oe:language:: c++

   .. oe:source:: tutorial1_inertialatheavyatoms_snippet.cpp
      :language:  c++
      :frag:      SNIPPET-7

   Next, set the :oe:meth:`OEFastROCS::OEFastROCSOrientation::AsIs` option with
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`:

   .. oe:source:: tutorial1_inertialatheavyatoms_snippet.cpp
      :language:  c++
      :frag:      SNIPPET-8

   This will force the number of starts and the number of inertial starts to
   both equal 1.  To check that the starts have been set correctly, query
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts` and
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumInertialStarts`:

   .. oe:source:: tutorial1_inertialatheavyatoms_snippet.cpp
      :language:  c++
      :frag:      SNIPPET-9

   The output from the modified C++ script now looks like this:

   .. code-block:: console

      Opening database file 3tmn_lig.sdf ...
      This example will use 1 starts & 1 inertial starts
      Searching for 4tmn_lig.sdf
      Score for mol 0(conf 0) 0.286799 shape 0.356514 color

   .. only:: oehtml

      .. admonition:: Download code

         The fully modified c++ script used in this tutorial can be found here
         :download:`asisstarts.cpp <../../../../../../sublibs/tklibs/fastrocs/examples/asisstarts.cpp>`

   .. only:: oepdf

      .. oe:source:: asisstarts.cpp
         :language: c++

.. oe:language:: python

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.py
      :language:  python
      :frag:      SNIPPET-7

   :ref:`Full listing. <listing-Tutorial1_InertialAtHeavyAtoms_Snippet.py>`

   Next, set the :oe:meth:`OEFastROCS::OEFastROCSOrientation::AsIs` option with
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`:

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.py
      :language:  python
      :frag:      SNIPPET-8

   :ref:`Full listing. <listing-Tutorial1_InertialAtHeavyAtoms_Snippet.py>`

   This will force the number of starts and the number of inertial starts to
   both equal 1.  To check that the starts have been set correctly, query
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts` and
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumInertialStarts`:

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.py
      :language:  python
      :frag:      SNIPPET-9

   :ref:`Full listing. <listing-Tutorial1_InertialAtHeavyAtoms_Snippet.py>`

   The output from the modified Python script now looks like this:

   .. code-block:: console

      Opening database file 3tmn_lig.sdf ...
      This example will use 1 starts & 1 inertial starts
      Searching for 4tmn_lig.sdf
      Score for mol 0(conf 0) 0.286799 shape 0.356514 color

   .. only:: oehtml

      .. admonition:: Download code

         The fully modified python script used in this tutorial can be found here
         :download:`AsIsStartsExample.py <../../../../../../wrappers/python/examples/fastrocs/AsIsStartsExample.py>`

   .. only:: oepdf

      .. oe:source:: AsIsStartsExample.py
         :language: python

.. oe:language:: java

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.java
      :language:  java
      :frag:      SNIPPET-7

   Next, set the :oe:meth:`OEFastROCS::OEFastROCSOrientation::AsIs` option with
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetInitialOrientation`:

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.java
      :language:  java
      :frag:      SNIPPET-8

   This will force the number of starts and the number of inertial starts to
   both equal 1.  To check that the starts have been set correctly, query
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumStarts` and
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::GetNumInertialStarts`:

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.java
      :language:  java
      :frag:      SNIPPET-9

   The output from the modified Java script now looks like this:

   .. code-block:: console

      Opening database file 3tmn_lig.sdf ...
      This example will use 1 starts & 1 inertial starts
      Searching for 4tmn_lig.sdf
      Score for mol 0(conf 0) 0.286799 shape 0.356514 color

   .. only:: oehtml

      .. admonition:: Download code

         The fully modified java script used in this tutorial can be found here
         :download:`AsIsStartsExample.java <../../../../../../wrappers/java/examples/openeye/examples/oefastrocs/AsIsStartsExample.java>`

   .. only:: oepdf

      .. oe:source:: AsIsStartsExample.java
         :language: java


.. _tutorial1_RetrievingResults_section:

Retrieving Results
================================================================================

Finally, when using alternative starts, the way the results are handled
should be taken into consideration. This will be unique to each specific
problem.  Here are some methods that may be useful:

.. oe:language:: c++

   .. oe:source:: tutorial1_inertialatheavyatoms_snippet.cpp
      :language:  c++
      :frag:      SNIPPET-10

   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxOverlays` allows the user to
   specify how many overlay results to return per conformer. In the above example,
   ``SetMaxOverlays`` has been set to return all possible overlays per conformer.
   This can be used along side the
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxConfs` and/or
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetLimit` options:

   .. oe:source:: tutorial1_inertialatheavyatoms_snippet.cpp
      :language:  c++
      :frag:      SNIPPET-11

.. oe:language:: python

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.py
      :language:  python
      :frag:      SNIPPET-10

   :ref:`Full listing. <listing-Tutorial1_InertialAtHeavyAtoms_Snippet.py>`

   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxOverlays` allows the user to
   specify how many overlay results to return per conformer. In the above example,
   ``SetMaxOverlays`` has been set to return all possible overlays per conformer.
   This can be used along side the
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxConfs` and/or
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetLimit` options:

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.py
      :language:  python
      :frag:      SNIPPET-11

   :ref:`Full listing. <listing-Tutorial1_InertialAtHeavyAtoms_Snippet.py>`

.. oe:language:: java

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.java
      :language:  java
      :frag:      SNIPPET-10

   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxOverlays` allows the user to
   specify how many overlay results to return per conformer. In the above example,
   ``SetMaxOverlays`` has been set to return all possible overlays per conformer.
   This can be used along side the
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetMaxConfs` and/or
   :oe:meth:`OEFastROCS::OEShapeDatabaseOptions::SetLimit` options:

   .. oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.java
      :language:  java
      :frag:      SNIPPET-11

.. oe:language:: c++ python java

   In this case, the results will be filtered twice. First, only the top ``5``
   conformers for each molecule will be kept. For these ``5`` conformers ``all``
   overlays will be kept.  Finally, during sorting, only the top ``50`` scores
   of all overlays for the top ``5`` conformers per molecule will remain.

   .. warning::

      It is not recommended to return all overlay results for all conformers of
      large databases as this will leak memory rapidly.

   .. note::

      Please send any feedback about this tutorial to support@eyesopen.com using
      the tutorial title as the subject header.


.. _tutorial_database_prep:

*******************************************************************************
Tutorial 2: How to prepare a database for faster load speeds
*******************************************************************************

In this tutorial, you will learn how to pre-process a conformer database
file for **FastROCS TK**, allowing for faster database load times with
:oe:meth:`OEFastROCS::OEShapeDatabase::Open`. Load times could be up to 10x
faster. See the figure below for an eMolecules dataset of 14 million
conformers.

.. _database_prep_figure_1:

.. figure:: /_images/Tutorial_2_Figure_1.png
   :align: center
   :height: 550
   :width: 700

   **Pre-Processing Performance Impact**

To gain this extra loading performance,  you need to use the following
functions:

#. :oe:func:`OEChem::OEPreserveRotCompress` - this function works on
   the input molecule stream to ensure that rotor-offset compression
   is preserved during the preparation process. Rotor offset compression
   is a way of storing conformers as a set of torsions instead of
   storing the coordinates for every single conformer of a molecule.
   This optimization reduces the memory footprint of a multi-conformer
   molecule.

#. :oe:func:`OEChem::OEPRECompress` – this function works on the output
   molecule stream object allowing the molecules to be stored in a
   ‘pre-compressed’ format:

    - Writes rotor-offset-compressed molecules in the perfect-rotor-encoding
      format
    - There is no need to Gzip which means faster
      :oe:meth:`OEChem::OEMolDatabase::Open`.

#. :oe:func:`OEFastROCS::OEPrepareFastROCSMol` – this function works on
   each :ref:`OEMol <OEChem_OEMol>` record of the input.oeb:

    - Sets the energy of each conformer to 0.0 to avoid writing it
      to OEB.
    - Suppresses hydrogens and reorders reference conformers for compression.
    - Pre-calculates color atoms.
    - Pre-calculates self-color and self-shape terms for all conformers.

    .. note::

      The color terms cached by :oe:func:`OEFastROCS::OEPrepareFastROCSMol`
      are from the :oe:const:`OEShape::OEColorFFType::ImplicitMillsDean`
      color force field. A different color
      force field can be given as the second argument to override
      ImplicitMillsDean.

In general, calling :oe:func:`OEFastROCS::OEPrepareFastROCSMol` and 
:oe:func:`OEChem::OEPRECompress` will result in a smaller OEB file
than the default OEB.GZ output from OMEGA.

Further reduction in file-size can be achieved by using an 
:oe:const:`OEChem::OEMCMolType::HalfFloatCartesian` molecule to store
reference coordinates and torsions as 16-bit floating point. 

Here is some example code showing how to pre-process a database with
:oe:func:`OEFastROCS::OEPrepareFastROCSMol`, save to a precompressed
format, and reduce the file size by using half precision:

.. oe:language:: c++

   For added convenience, we have created a shapedatabaseprep.cpp example
   script which can be modified to meet your exact needs:

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simpleprepscript.cpp <../../../../../../sublibs/tklibs/fastrocs/examples/simpleprepscript.cpp>`

   .. only:: oepdf

      .. oe:source:: simpleprepscript.cpp
         :language: c++

.. oe:language:: python

   For added convenience, we have created a SimplePrepScript.py example
   script which can be modified to meet your exact needs:

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimplePrepScript.py <../../../../../../wrappers/python/examples/fastrocs/SimplePrepScript.py>`

   .. only:: oepdf

      .. oe:source:: SimplePrepScript.py
         :language: python

.. oe:language:: java

   For added convenience, we have created a SimplePrepScript.java example
   script which can be modified to meet your exact needs:

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimplePrepScript.java <../../../../../../wrappers/java/examples/openeye/examples/oefastrocs/SimplePrepScript.java>`

   .. only:: oepdf

      .. oe:source:: SimplePrepScript.java
         :language: java


.. _tutorial_basic_usage:

*******************************************************************************
Tutorial 0: Basic usage of **FastROCS TK**
*******************************************************************************

.. oe:language:: python

   **FastROCS TK** is primarily designed to be used as a server/client interface. Example 
   scripts are provided with **FastROCS TK** to help you get up and running. This
   tutorial demonstrates the use of the :ref:`section_example_fastrocs_shapedatabaseserver` and
   :ref:`section_example_fastrocs_shapedatabaseclient`. 
   example scripts, which are provided below.

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeDatabaseServer.py <../../../../../../wrappers/python/examples/fastrocs/ShapeDatabaseServer.py>`
         :download:`ShapeDatabaseClient.py <../../../../../../wrappers/python/examples/fastrocs/ShapeDatabaseClient.py>`

   .. only:: oepdf

      .. oe:source:: ShapeDatabaseServer.py
         :language: python
      .. oe:source:: ShapeDatabaseClient.py
         :language: python

 
   After **FastROCS TK** has been installed follow these simple steps for the most
   basic usage of **FastROCS TK**:

   #. Start the server on an OMEGA conformer database in your terminal in the virtual environment
      you used to install the **OpenEye Toolkits**::

         (fastrocs) $ ShapeDatabaseServer.py your_database.oeb

   #. Query the server from another terminal using the same virtual environment::

         (fastrocs) $ ShapeDatabaseClient.py localhost:8080 your_query.sdf output_overlays.sdf

   .. note::

      The server can be queried from the same terminal by putting the ShapeDatabaseServer process
      in the background by doing ``ctrl z && bg``. 

   .. warning::

      For best performance, do not use GNU Zipped (.gz) molecule
      databases with FastROCS. Uncompress the ``.oeb.gz`` to ``.oeb``
      first.

   For more advanced options see the ``--help`` menu::

         (fastrocs) $ ShapeDatabaseClient.py --help

      .. code-block:: bash

         usage: ShapeDatabaseClient.py [-h] [--tversky] [--shapeOnly]
                                       [--alternativeStarts {random,subrocs,inertialAtHeavyAtoms,inertialAtColorAtoms}]
                                       server:port query results [nHits]

         positional arguments:
           server:port           Server name and port number of database to search i.e.
                                 localhost:8080.
           query                 File containing the query molecule to search (format
                                 not restricted to *.oeb).
           results               Output file to store results (format not restricted to
                                 *.oeb).
           nHits                 Number of hits to return (default=100).

         optional arguments:
           -h, --help            show this help message and exit
           --tversky             Switch to Tversky similarity scoring
                                              (default=Tanimoto).
           --shapeOnly           Switch to shape-only scores (default=Combo).
           --alternativeStarts {random,subrocs,inertialAtHeavyAtoms,inertialAtColorAtoms}
                                 Optimize using alternative starts (default=inertial).
                                 To perform N random starts do "--alternativeStarts
                                 random N" (default N=10)


.. graphemetk toolkit documentation master file

####################################
Grapheme Toolkit |grapheme_version|
####################################

.. toctree::
   :maxdepth: 2

   introduction
   theory
   examples
   api

..  oe:language:: python

    .. toctree::
       :maxdepth: 1

       selected_examples_python

.. toctree::
   :maxdepth: 2

   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _oegrapheme_chapter_introduction:

********************************************************************************
Introduction
********************************************************************************

2D structure diagrams can be considered to be the "natural
language" of chemists, since the graphical representation allows
molecules to be instantly conceivable.

Historically, 2D representations have mainly been used to visualize
the connection table of molecular graphs.
However, projecting 3D information into the 2D layout and displaying
various atom and bond properties on the molecular diagram open up a
novel way to present information to chemists.

The **Grapheme TK** provides several representation schemes that allow
visualization of complex molecular interactions and properties in a clear
and coherent 2D format that is the most natural to chemists.

**Oxford dictionary definition**

  `grapheme <http://en.wikipedia.org/wiki/Grapheme>`_  /'grafēm/

  The smallest meaningful contrastive unit in a writing system.

**Wiki definition**

   A `grapheme <http://en.wikipedia.org/wiki/Grapheme>`_ is the smallest semantically
   distinguishing unit in a written language, analogous to the phonemes of spoken languages.
   A grapheme may or may not carry meaning by itself, and may or may not correspond to
   a single phoneme.

.. only:: oehtml

   Graphemes include alphabetic letters, typographic ligatures, Chinese characters, numerical digits,
   punctuation marks, and other individual symbols of any of the world's writing systems.
   The word grapheme is derived from Greek γράφω gráphō ("write"), and the suffix -eme,
   by analogy with phoneme and other names of emic units.

.. only:: oepdf

   Graphemes include alphabetic letters, typographic ligatures, Chinese characters, numerical digits,
   punctuation marks, and other individual symbols of any of the world's writing systems.
   The word grapheme is derived from Greek gráphō ("write"), and the suffix -eme,
   by analogy with phoneme and other names of emic units.

.. note::

   This manual provides examples about molecule annotations, drawing
   2D molecule surfaces and displaying atom properties on a property
   map.
   However, the basic concepts of molecule depiction and image
   handling are discussed in the **OEDepict TK** manual.
   Therefore, studying the **OEDepict TK** manual is highly recommended
   prior to reading this documentation.




.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OE2DActiveSiteDisplay, 2DActiveSiteDisplay

.. _OEGrapheme_OE2DActiveSiteDisplay:

.. oe:class:: OE2DActiveSiteDisplay

   .. oe:api::

      class OE2DActiveSiteDisplay

   This class represents :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` that stores
   the depiction information (such as 2D coordinates, representation styles etc.)
   of an active site.

   An active site display can be rendered into an image using the
   :oe:func:`OEGrapheme::OEPrepareActiveSiteDepiction` and 
   :oe:func:`OEGrapheme::OERenderActiveSite` functions.

   .. admonition:: Code Example

      * :ref:`section_examples_summary_complex2img` example
      * `Visualizing Protein-Ligand Interactions`_ **OpenEye Python Cookbook** recipe

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DActiveSiteDisplay(const OEBio::OEInteractionHintContainer& asite,
                                  const OE2DActiveSiteDisplayOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            OE2DActiveSiteDisplay(asite: OEInteractionHintContainer,
                                  opts: OE2DActiveSiteDisplayOptions) -> OE2DActiveSiteDisplay

      Initializes an :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object using
      the given display options.

      *asite*
         The active site for which display information is stored in the
         :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object.

      *opts*
         The :ref:`OE2DActiveSiteDisplayOptions <OEGrapheme_OE2DActiveSiteDisplayOptions>` object that stores
         properties that determine the styles of the active site depiction.

      .. warning::

         * An :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object does not make a copy of the
           :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object from which it is
           initialized but only stores its pointer.
           Therefore, the user responsibility is to not let the interaction container object
           go out of scope, before the corresponding :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>`
           object.

      .. seealso::

         * :oe:func:`OEBio::OEIsValidActiveSite` function
         * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplay::IsValid` method

   .. ################################################################
      # GetActiveSite -> DEPRECATED
      ################################################################

   .. oe:method: GetActiveSite

      .. oe:api: DEPRECATED

         const OEBio::OEFragmentNetwork *GetActiveSite() const

         Returns the const pointer of the `OEBio::OEFragmentNetwork`  object for which the
         display properties are stored in :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetDisplayedLigand

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase* GetDisplayedLigand() const

      .. oe:language:: python

         .. oe:api:: python

            GetDisplayedLigand() -> OEGraphMol

      Returns a pointer to the display ligand of the active site.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetDisplayedResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEResidue>* GetDisplayedResidues(unsigned int renderstyle = OEActiveSiteRenderStyle::Default) const

      .. oe:language:: python

         .. oe:api:: python

            GetDisplayedResidues(renderstyle: int = Default) -> OEResidueIter

      Returns an iterator over the displayed residues of the given style.

      *renderstyle*
         This value has to be from the :oe:constns:`OEGrapheme::OEActiveSiteRenderStyle`
         namespace.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeight() -> float

      Returns the height of the displayed active site.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OE2DActiveSiteDisplayOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OE2DActiveSiteDisplayOptions

      Returns the options used to initialized the :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>`
      object.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetWidth() -> float

   .. ################################################################
      # IsValid
      ################################################################

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>`
      object was initialized successfully.

      .. hint::

         It is highly recommend to check whether an active site display
         is valid after initialization.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OE2DActiveSiteDisplayOptions, 2DActiveSiteDisplayOptions

.. _OEGrapheme_OE2DActiveSiteDisplayOptions:

.. oe:class:: OE2DActiveSiteDisplayOptions

   .. oe:api::

      class OE2DActiveSiteDisplayOptions: public OEDepict::OE2DMolDisplayOptions

   This class represents the :ref:`OE2DActiveSiteDisplayOptions <OEGrapheme_OE2DActiveSiteDisplayOptions>` class
   that encapsulates properties that determine how an active site is depicted.

   The following methods are publicly inherited from :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`:

   ====================================================================================================== ===================================================================================================== ======================================================================================================
   :oe:meth:`operator=<OEDepict::OE2DMolDisplayOptions::operator=>`                                       :oe:meth:`GetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::GetDefaultBondPen>`                      :oe:meth:`SetBondColorStyle<OEDepict::OE2DMolDisplayOptions::SetBondColorStyle>`
   :oe:meth:`GetAromaticStyle<OEDepict::OE2DMolDisplayOptions::GetAromaticStyle>`                         :oe:meth:`GetHeight<OEDepict::OE2DMolDisplayOptions::GetHeight>`                                      :oe:meth:`SetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineAtomLabelGapScale>`
   :oe:meth:`GetAtomColor<OEDepict::OE2DMolDisplayOptions::GetAtomColor>`                                 :oe:meth:`GetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::GetHydrogenStyle>`                        :oe:meth:`SetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineGapScale>`
   :oe:meth:`GetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle>`                       :oe:meth:`GetScale<OEDepict::OE2DMolDisplayOptions::GetScale>`                                        :oe:meth:`SetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont>`
   :oe:meth:`GetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFont>`                         :oe:meth:`GetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetSuperAtomLabelFont>`              :oe:meth:`SetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale>`
   :oe:meth:`GetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFontScale>`               :oe:meth:`GetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle>`                      :oe:meth:`SetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor>`
   :oe:meth:`GetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFont>`                 :oe:meth:`GetTitleFont<OEDepict::OE2DMolDisplayOptions::GetTitleFont>`                                :oe:meth:`SetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle>`
   :oe:meth:`GetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFontScale>`       :oe:meth:`GetTitleLocation<OEDepict::OE2DMolDisplayOptions::GetTitleLocation>`                        :oe:meth:`SetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::SetBondWidthScaling>`
   :oe:meth:`GetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetAtomPropertyFunctor>`             :oe:meth:`GetWidth<OEDepict::OE2DMolDisplayOptions::GetWidth>`                                        :oe:meth:`SetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen>`
   :oe:meth:`GetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::GetAtomStereoStyle>`                     :oe:meth:`SetAromaticStyle<OEDepict::OE2DMolDisplayOptions::SetAromaticStyle>`                        :oe:meth:`SetDimensions<OEDepict::OE2DMolDisplayOptions::SetDimensions>`
   :oe:meth:`GetBackgroundColor<OEDepict::OE2DMolDisplayOptions::GetBackgroundColor>`                     :oe:meth:`SetAtomColor<OEDepict::OE2DMolDisplayOptions::SetAtomColor>`                                :oe:meth:`SetHeight<OEDepict::OE2DMolDisplayOptions::SetHeight>`
   :oe:meth:`GetBondColorStyle<OEDepict::OE2DMolDisplayOptions::GetBondColorStyle>`                       :oe:meth:`SetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle>`                      :oe:meth:`SetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle>`
   :oe:meth:`GetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineAtomLabelGapScale>` :oe:meth:`SetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFont>`                        :oe:meth:`SetScale<OEDepict::OE2DMolDisplayOptions::SetScale>`
   :oe:meth:`GetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineGapScale>`                   :oe:meth:`SetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale>`              :oe:meth:`SetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetSuperAtomLabelFont>`
   :oe:meth:`GetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFont>`                 :oe:meth:`SetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont>`                :oe:meth:`SetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle>`
   :oe:meth:`GetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFontScale>`       :oe:meth:`SetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale>`      :oe:meth:`SetTitleFont<OEDepict::OE2DMolDisplayOptions::SetTitleFont>`
   :oe:meth:`GetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetBondPropertyFunctor>`             :oe:meth:`SetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor>`            :oe:meth:`SetTitleLocation<OEDepict::OE2DMolDisplayOptions::SetTitleLocation>`
   :oe:meth:`GetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::GetBondStereoStyle>`                     :oe:meth:`SetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle>`                    :oe:meth:`SetWidth<OEDepict::OE2DMolDisplayOptions::SetWidth>`
   :oe:meth:`GetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::GetBondWidthScaling>`                   :oe:meth:`SetBackgroundColor<OEDepict::OE2DMolDisplayOptions::SetBackgroundColor>`
   ====================================================================================================== ===================================================================================================== ======================================================================================================

   .. admonition:: Code Example

      * :ref:`section_examples_summary_complex2img` example
      * `Visualizing Protein-Ligand Interactions`_ **OpenEye Python Cookbook** recipe

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DActiveSiteDisplayOptions(double width, double height)

      .. oe:language:: python

         .. oe:api:: python

            OE2DActiveSiteDisplayOptions(width: float, height: float) -> OE2DActiveSiteDisplayOptions

      Creates an :ref:`OE2DActiveSiteDisplayOptions <OEGrapheme_OE2DActiveSiteDisplayOptions>` object with the specified dimension.

      *width*, *height*
        The width and height of the active site display.
        Both numbers have to be at least 200.0.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DActiveSiteDisplayOptions(const OE2DActiveSiteDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DActiveSiteDisplayOptions(rhs: OE2DActiveSiteDisplayOptions) -> OE2DActiveSiteDisplayOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE2DActiveSiteDisplayOptions &operator=(const OE2DActiveSiteDisplayOptions &rhs)

      Assignment operator.

   .. oe:method:: GetLigandAlignerFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OELigandAlignerBase& GetLigandAlignerFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandAlignerFunctor() -> OELigandAlignerBase

      Returns the functor that is used to align ligands in the active site display.
      By default, the functor is set to :oe:cls:`OEGrapheme::OENoOpLigandAligner`.

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetLigandAlignerFunctor` method

   .. oe:method:: GetOptimizeLigandOrientation

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetOptimizeLigandOrientation() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizeLigandOrientation() -> bool

      Returns whether the ligand orientation is optimized after generated the 2D layout.
      The default value is `true`.

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetOptimizeLigandOrientation` method

   .. oe:method:: GetRenderInteractiveLegend

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRenderInteractiveLegend() const

      .. oe:language:: python

         .. oe:api:: python

            GetRenderInteractiveLegend() -> bool

      Returns whether and interactive legend is rendered only when mouse is
      hovered  over the "Legend" button depicted on the right top corner
      on the active site depiction.

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetRenderInteractiveLegend` method

   .. oe:method:: GetResidueSVGMarkupFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEResidueSVGMarkupBase& GetResidueSVGMarkupFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidueSVGMarkupFunctor() -> OEResidueSVGMarkupBase

      Returns the functor that defines how the residues are marked in
      :file:`svg` image.
      By default, residues are not marked (:ref:`OEResidueSVGNoMarkup <OEGrapheme_OEResidueSVGNoMarkup>`).

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetResidueSVGMarkupFunctor` method

   .. oe:method:: GetSVGMagnifyResidueInHover

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSVGMagnifyResidueInHover() const

      .. oe:language:: python

         .. oe:api:: python

            GetSVGMagnifyResidueInHover() -> float

      Returns the scaling factor that is used to magnify residue glyphs
      when mouse is hover over them.

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetSVGMagnifyResidueInHover` method

   .. oe:method:: SetBackgroundColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBackgroundColor(const OESystem::OEColor &)

      .. oe:language:: python

         .. oe:api:: python

            SetBackgroundColor(arg2: OEColor) -> None

      This is a no-op method.
      The background of the active site display is always
      :oe:const:`OEWhite<OESystem::OESystem::OEWhite>`

   .. oe:method:: SetDimensions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDimensions(double width, double height, double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetDimensions(arg2: float, arg3: float, arg4: float) -> None

      This is a no-op method. The dimension of the active site display only be
      specified with the  :oe:cls:`OEGrapheme::OE2DActiveSiteDisplayOptions<OEGrapheme::OE2DActiveSiteDisplayOptions::Constructors>`
      constructor.

   .. oe:method:: SetHeight

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHeight(double)

      .. oe:language:: python

         .. oe:api:: python

            SetHeight(arg2: float) -> None

      This is a no-op method.
      The height of the active site display can only be specified with the
      :oe:cls:`OEGrapheme::OE2DActiveSiteDisplayOptions<OEGrapheme::OE2DActiveSiteDisplayOptions::Constructors>`
      constructor.

   .. oe:method:: SetLigandAlignerFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLigandAlignerFunctor(const OELigandAlignerBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetLigandAlignerFunctor(func: OELigandAlignerBase) -> None

      Sets the functor that can be used to custom align ligands in the active site display.

      .. hint::

         Turning off optimization of ligand orientation is also recommended for custom alignments with
         :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetOptimizeLigandOrientation` method.

      .. seealso::

         * :oe:cls:`OEGrapheme::OELigandAlignerBase` abstract base class

   .. oe:method:: SetOptimizeLigandOrientation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOptimizeLigandOrientation(bool optimize)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizeLigandOrientation(optimize: bool) -> None

      Sets whether the ligand orientation is optimized after generated the 2D layout to
      maximize scaling for the depiction.

      .. hint::

         Its is recommended to disable this feature when using custom ligand alignment.

   .. oe:method:: SetRenderInteractiveLegend

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRenderInteractiveLegend(bool render)

      .. oe:language:: python

         .. oe:api:: python

            SetRenderInteractiveLegend(render: bool) -> None

      Sets whether and interactive legend is rendered only when mouse is
      hovered  over the "Legend" button depicted on the right top corner
      on the active site depiction.

      .. note::

         This functionality is **only available** for :file:`.svg`
         image format. In other image formats it has no effect.

   .. oe:method:: SetResidueSVGMarkupFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetResidueSVGMarkupFunctor(const OEResidueSVGMarkupBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetResidueSVGMarkupFunctor(func: OEResidueSVGMarkupBase) -> None

      Sets the functor that defines how the residues are marked in :file:`svg` image.
      Drawing elements representing residues in :file:`svg` image are grouped together
      in the following format in which the ``<group id>`` and ``<class name>``
      strings are defined by the given functor:

      ::

          <g id='<group id>' class='<class name>'>
          ..
          list of drawing elements
          ..
          </g>

      .. note::

         This setting has only effect when generating :file:`.svg`
         images.

      **Example:**

      .. oe:source:: SVGMarkResidues.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEACTIVESITEOPTIONS-RESIDUE-SVGMARKUP

      .. oe:source:: SVGMarkResidues.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEACTIVESITEOPTIONS-RESIDUE-SVGMARKUP

      .. oe:source:: SVGMarkResidues.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEACTIVESITEOPTIONS-RESIDUE-SVGMARKUP

      .. oe:source:: SVGMarkResidues.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEACTIVESITEOPTIONS-RESIDUE-SVGMARKUP

      .. seealso::

         * :ref:`OEResidueSVGMarkupBase <OEGrapheme_OEResidueSVGMarkupBase>` abstract base class
         * :ref:`OEResidueSVGNoMarkup <OEGrapheme_OEResidueSVGNoMarkup>` class
         * :ref:`OEResidueSVGStandardMarkup <OEGrapheme_OEResidueSVGStandardMarkup>` class
         * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::GetResidueSVGMarkupFunctor` method

   .. oe:method:: SetSVGMagnifyResidueInHover

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSVGMagnifyResidueInHover(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetSVGMagnifyResidueInHover(scale: float) -> None

      Sets the scaling factor that is used to magnify residue glyphs
      when mouse is hover over them.

      scale
         This value has to be in a range of ``[1.00, 3.00]``.
         The default value is 1.00 which has has no effect.

      .. hint::

         This is a very useful feature when generating an active site
         image with residue labels that are too small to read.

      .. note::

         This functionality is **only available** for :file:`.svg`
         image format. In other image formats it has no effect.

   .. oe:method:: SetScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetScale(double)

      .. oe:language:: python

         .. oe:api:: python

            SetScale(arg2: float) -> None

      This is a no-op method.
      The active site display can not be scaled.

   .. oe:method:: SetSuperAtomStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSuperAtomStyle(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetSuperAtomStyle(arg2: int) -> None

      This is a no-op method.
      The super atom style can not be used when depicting an active site.

   .. oe:method:: SetWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetWidth(double)

      .. oe:language:: python

         .. oe:api:: python

            SetWidth(arg2: float) -> None

      This is a no-op method.
      The width of the active site display can only be specified with the
      :oe:cls:`OEGrapheme::OE2DActiveSiteDisplayOptions<OEGrapheme::OE2DActiveSiteDisplayOptions::Constructors>`
      constructor.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OE2DActiveSiteLegendDisplayOptions, 2DActiveSiteLegendDisplayOptions

.. _OEGrapheme_OE2DActiveSiteLegendDisplayOptions:

.. oe:class:: OE2DActiveSiteLegendDisplayOptions

   .. oe:api::

      class OE2DActiveSiteLegendDisplayOptions

   This class represents :ref:`OE2DActiveSiteLegendDisplayOptions <OEGrapheme_OE2DActiveSiteLegendDisplayOptions>` that encapsulates
   properties that determine how the legend of a color force field is depicted by
   the :oe:func:`OEGrapheme::OEDrawActiveSiteLegend` function.

   .. seealso::

      * :oe:func:`OEGrapheme::OE2DActiveSiteDisplay` class
      * :oe:func:`OEGrapheme::OEDrawActiveSiteLegend` function

   .. admonition:: Code Example

      * :ref:`section_examples_summary_complex2img` example
      * `Visualizing Protein-Ligand Interactions`_ **OpenEye Python Cookbook** recipe

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DActiveSiteLegendDisplayOptions(unsigned int rows,
                                               unsigned int cols)

      .. oe:language:: python

         .. oe:api:: python

            OE2DActiveSiteLegendDisplayOptions(rows: int, cols: int) -> OE2DActiveSiteLegendDisplayOptions

      Creates an :ref:`OE2DActiveSiteLegendDisplayOptions <OEGrapheme_OE2DActiveSiteLegendDisplayOptions>` object with the
      specified number of rows and columns..

      *rows*
        The number of rows in the legend.

      *cols*
         The number of columns in the legend.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DActiveSiteLegendDisplayOptions(const OE2DActiveSiteLegendDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DActiveSiteLegendDisplayOptions(rhs: OE2DActiveSiteLegendDisplayOptions) -> OE2DActiveSiteLegendDisplayOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE2DActiveSiteLegendDisplayOptions &operator=(const OE2DActiveSiteLegendDisplayOptions &rhs)

      Assignment operator.

   .. oe:method:: NumCols

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumCols() const

      .. oe:language:: python

         .. oe:api:: python

            NumCols() -> int

      Returns the number of columns of the legend.

   .. oe:method:: NumRows

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumRows() const

      .. oe:language:: python

         .. oe:api:: python

            NumRows() -> int




.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OE2DPropMap, 2DPropMap

.. _OEGrapheme_OE2DPropMap:

.. oe:class:: OE2DPropMap

   .. oe:api::

      class OE2DPropMap

   The :ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>` class maps atom properties
   into a 2D grid and then *blurs* the image by using a Gaussian
   function.
   The points of the 2D grid are then colored using the
   :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class that interpolates
   colors between a specified range.

   .. seealso::

      * :ref:`chapter_draw_prop_map` chapter

   .. admonition:: Code Example

      * `Visualizing Molecular Dipole Moment`_ **OpenEye Python Cookbook** recipe

   The :ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>` class can be customized with the following properties:

      .. list-table::
         :widths: 100 100 100 150
         :header-rows: 1

         * - Property
           - Get method
           - Set method
           - Corresponding namespace/class

         * - legend font
           - :oe:meth:`GetLegendFont<OEGrapheme::OE2DPropMap::GetLegendFont>`
           - :oe:meth:`SetLegendFont<OEGrapheme::OE2DPropMap::SetLegendFont>`
           - :ref:`OEFont <OEDepict_OEFont>`

         * - legend font scale
           - :oe:meth:`GetLegendFontScale<OEGrapheme::OE2DPropMap::GetLegendFontScale>`
           - :oe:meth:`SetLegendFontScale<OEGrapheme::OE2DPropMap::SetLegendFontScale>`
           -

         * - legend location
           - :oe:meth:`GetLegendLocation<OEGrapheme::OE2DPropMap::GetLegendLocation>`
           - :oe:meth:`SetLegendLocation<OEGrapheme::OE2DPropMap::SetLegendLocation>`
           - :oe:constns:`OEGrapheme::OELegendLocation`

         * - maximum value
           - :oe:meth:`GetMaxValue<OEGrapheme::OE2DPropMap::GetMaxValue>`
           - :oe:meth:`SetMaxValue<OEGrapheme::OE2DPropMap::SetMaxValue>`
           -

         * - minimum value
           - :oe:meth:`GetMinValue<OEGrapheme::OE2DPropMap::GetMinValue>`
           - :oe:meth:`SetMinValue<OEGrapheme::OE2DPropMap::SetMinValue>`
           -

         * - negative color
           - :oe:meth:`GetNegativeColor<OEGrapheme::OE2DPropMap::GetNegativeColor>`
           - :oe:meth:`SetNegativeColor<OEGrapheme::OE2DPropMap::SetNegativeColor>`
           - :ref:`OEColor <OESystem_OEColor>`

         * - positive color
           - :oe:meth:`GetPositiveColor<OEGrapheme::OE2DPropMap::GetPositiveColor>`
           - :oe:meth:`SetPositiveColor<OEGrapheme::OE2DPropMap::SetPositiveColor>`
           - :ref:`OEColor <OESystem_OEColor>`

         * - radius ratio
           - :oe:meth:`GetRadiusRatio<OEGrapheme::OE2DPropMap::GetRadiusRatio>`
           - :oe:meth:`SetRadiusRatio<OEGrapheme::OE2DPropMap::SetRadiusRatio>`
           -

         * - grid resolution
           - :oe:meth:`GetResolution<OEGrapheme::OE2DPropMap::GetResolution>`
           - :oe:meth:`SetResolution<OEGrapheme::OE2DPropMap::SetResolution>`
           -

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPropMap(const OESystem::OEColor& backgroundColor = OESystem::OEColor(255, 255, 255))

      .. oe:language:: python

         .. oe:api:: python

            OE2DPropMap(backgroundColor: OEColor = OEColor(255, 255, 255)) -> OE2DPropMap

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OE2DPropMap(const OE2DPropMap& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DPropMap(arg2: OE2DPropMap) -> OE2DPropMap

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE2DPropMap &operator=(const OE2DPropMap &)

      Assignment operator.

   .. ################################################################
      # Render
      ################################################################

   .. oe:method:: Render

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Render(OEDepict::OE2DMolDisplay& disp,
                        const std::string& tagname) const

      .. oe:language:: python

         .. oe:api:: python

            Render(disp: OE2DMolDisplay, tagname: str) -> bool

      Renders the property map into a molecule display.

      *disp*
         The molecule display that holds the molecule for which the
         property map is calculated and on which the property map is
         drawn.
         The property map is drawn onto the *below* layer of the molecule
         display *i.e.*, it appears underneath the molecular diagram.

      *tagname*
         The generic data identifier that is used to retrieve the
         properties being depicted on the property map.

      .. #############################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Render(OEDepict::OEImageBase& image,
                        const OEDepict::OE2DMolDisplay& disp,
                        const std::string& tagname) const

      .. oe:language:: python

         .. oe:api:: python

            Render(image: OEImageBase, disp: OE2DMolDisplay, tagname: str) -> bool

      Renders the property map into an image.

      *image*
         The image on which the property map is drawn.

      *disp*
         The molecule display that holds the molecule for which the
         property map is calculated.

      *tagname*
         The generic data identifier that is used to retrieve the
         properties being depicted on the property map.

      .. #############################################################

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Render(OEDepict::OE2DMolDisplay& disp,
                        const OEDepict::OE2DMolDisplay& refdisp,
                        const std::string& tagname) const

      .. oe:language:: python

         .. oe:api:: python

            Render(disp: OE2DMolDisplay, refdisp: OE2DMolDisplay, tagname: str) -> bool

      Renders the property map calculated for one display,
      onto another display.

      *disp*
         The molecule display on which the property map is drawn.
         The property map is drawn onto the *below* layer of the molecule
         display *i.e.*, it appears underneath the molecular diagram.

      *refdisp*
         The molecule display that holds the molecule for which the
         property map is calculated.

      *tagname*
         The generic data identifier that used to retrieve the
         properties being depicted on the property map.

   .. oe:method:: GetLegendFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEDepict::OEFont& GetLegendFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetLegendFont() -> OEFont

      Returns the font that is used to render the title of the legend
      and the color stops of the linear color gradient.

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetLegendFont` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. oe:method:: GetLegendFontScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLegendFontScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetLegendFontScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the size of the legend fonts.

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetLegendFontScale` method

   .. oe:method:: GetLegendLocation

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetLegendLocation() const

      .. oe:language:: python

         .. oe:api:: python

            GetLegendLocation() -> int

      Returns the position of the legend.
      The return value is taken from the
      :oe:constns:`OEGrapheme::OELegendLocation` namespace.

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetLegendLocation` method
         * :oe:constns:`OEGrapheme::OELegendLocation` namespace

   .. oe:method:: GetMaxValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMaxValue() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxValue() -> float

      Returns the maximum value that is used to construct the
      color gradient of the property map.

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetMaxValue` method

   .. oe:method:: GetMinValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMinValue() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinValue() -> float

      Returns the minimum value that is used to construct the
      color gradient of the property map.

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetMinValue` method

   .. oe:method:: GetNegativeColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetNegativeColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetNegativeColor() -> OEColor

      Returns the color that is used to represent negative atom
      property values.

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetNegativeColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: GetPositiveColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetPositiveColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetPositiveColor() -> OEColor

      Returns the color that is used to represent positive atom property
      values.

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetPositiveColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: GetRadiusRatio

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRadiusRatio() const

      .. oe:language:: python

         .. oe:api:: python

            GetRadiusRatio() -> float

      Returns he ratio that is used to scale the Gaussian radius.

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetRadiusRatio` method

   .. oe:method:: GetResolution

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetResolution() const

      .. oe:language:: python

         .. oe:api:: python

            GetResolution() -> int

      Returns the resolution of the property grid.

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetResolution` method

   .. oe:method:: SetLegendFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLegendFont(const OEDepict::OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetLegendFont(font: OEFont) -> None

      Sets the font that is used to render the title of the legend
      and the color stops of the linear color gradient.

      .. note::

         The size of fonts of the legend  also depends on
         the scaling factor used to fit the linear color gradient into the
         given dimensions and the multiplier set by the
         :oe:meth:`OEGrapheme::OE2DPropMap::SetLegendFontScale`
         method.

      Example (see :ref:`Figure: Example of using the SetLegendFont method
      <figure_OE2DPropMap_SetLegendFont>`)

      .. oe:source:: OE2DPropMap_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-LEGEND-FONT

      ..    oe:language:: python

            :ref:`Full listing. <listing-OE2DPropMap_SetProperties.py>`

      .. oe:source:: OE2DPropMap_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-LEGEND-FONT

      .. oe:source:: OE2DPropMap_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-LEGEND-FONT

      .. oe:source:: OE2DPropMap_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-LEGEND-FONT

      .. _figure_OE2DPropMap_SetLegendFont:

      .. figure:: graphemetk/images/OE2DPropMap_SetLegendFont.*
         :align:  center

         **Example of using the SetLegendFont method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::GetLegendFont` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. oe:method:: SetLegendFontScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLegendFontScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetLegendFontScale(scale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the size of the legend fonts.

      *scale*
         This value has to be in the range of ``[0.5, 2.0]``.

      Example (see :ref:`Figure: Example of using the SetLegendFontScale method
      <figure_OE2DPropMap_SetLegendFontScale>`)

      .. oe:source:: OE2DPropMap_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-LEGEND-FONT-SCALE

      ..    oe:language:: python

            :ref:`Full listing. <listing-OE2DPropMap_SetProperties.py>`

      .. oe:source:: OE2DPropMap_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-LEGEND-FONT-SCALE

      .. oe:source:: OE2DPropMap_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-LEGEND-FONT-SCALE

      .. oe:source:: OE2DPropMap_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-LEGEND-FONT-SCALE

      .. _figure_OE2DPropMap_SetLegendFontScale:

      .. figure:: graphemetk/images/OE2DPropMap_SetLegendFontScale.*
         :align:  center

         **Example of using the SetLegendFontScale method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::GetLegendFontScale` method

   .. oe:method:: SetLegendLocation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLegendLocation(unsigned int loc)

      .. oe:language:: python

         .. oe:api:: python

            SetLegendLocation(loc: int) -> None

      Sets the position of the legend.

      *loc*
         This value has to be from the
         :oe:constns:`OEGrapheme::OELegendLocation` namespace.

      Example (see :ref:`Figure: Example of using the SetLegendLocation method
      <figure_OE2DPropMap_SetLegendLocation>`)

      .. oe:source:: OE2DPropMap_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-LEGEND-LOCATION

      :ref:`Full listing. <listing-OE2DPropMap_SetProperties.py>`

      .. oe:source:: OE2DPropMap_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-LEGEND-LOCATION

      .. oe:source:: OE2DPropMap_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-LEGEND-LOCATION

      .. oe:source:: OE2DPropMap_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-LEGEND-LOCATION

      .. _figure_OE2DPropMap_SetLegendLocation:

      .. figure:: graphemetk/images/OE2DPropMap_SetLegendLocation.*
         :align:  center

         **Example of using the SetLegendLocation method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::GetLegendLocation` method
         * :oe:constns:`OEGrapheme::OELegendLocation` namespace

   .. oe:method:: SetMaxValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxValue(double maxv)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxValue(maxv: float) -> None

      Sets the maximum value that is used to construct the
      color gradient of the property map.
      If no maximum value is specified prior to calling the
      :oe:meth:`OEGrapheme::OE2DPropMap::Render` method, then the
      maximum value will be the largest atom property value.

      Example (see :ref:`Figure: Example of using the SetMaxValue method<figure_OE2DPropMap_SetMaxValue>`)

      .. oe:source:: OE2DPropMap_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-MAXVALUE

      ..    oe:language:: python

            :ref:`Full listing. <listing-OE2DPropMap_SetProperties.py>`

      .. oe:source:: OE2DPropMap_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-MAXVALUE

      .. oe:source:: OE2DPropMap_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-MAXVALUE

      .. oe:source:: OE2DPropMap_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-MAXVALUE

      .. _figure_OE2DPropMap_SetMaxValue:

      .. figure:: graphemetk/images/OE2DPropMap_SetMaxValue.*
         :align:  center

         **Example of using the SetMaxValue method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::GetMaxValue` method

   .. oe:method:: SetMinValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMinValue(double minv)

      .. oe:language:: python

         .. oe:api:: python

            SetMinValue(minv: float) -> None

      Sets the minimum value that is used to construct the
      color gradient of the property map.
      If no minimum value is specified prior to calling the
      :oe:meth:`OEGrapheme::OE2DPropMap::Render` method, then the
      minimum value will be the smallest atom property value.

      Example (see :ref:`Figure: Example of using the SetMinValue method<figure_OE2DPropMap_SetMinValue>`)

      .. oe:source:: OE2DPropMap_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-MINVALUE

      ..    oe:language:: python

            :ref:`Full listing. <listing-OE2DPropMap_SetProperties.py>`

      .. oe:source:: OE2DPropMap_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-MINVALUE

      .. oe:source:: OE2DPropMap_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-MINVALUE

      .. oe:source:: OE2DPropMap_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-MINVALUE

      .. _figure_OE2DPropMap_SetMinValue:

      .. figure:: graphemetk/images/OE2DPropMap_SetMinValue.*
         :align:  center

         **Example of using the SetMinValue method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::GetMinValue` method

   .. oe:method:: SetNegativeColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNegativeColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetNegativeColor(color: OEColor) -> None

      Sets the color that is used to represent negative atom
      property values.

      Example (see :ref:`Figure: Example of using the SetNegativeColor method<figure_OE2DPropMap_SetNegativeColor>`)

      .. oe:source:: OE2DPropMap_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-NEGATIVECOLOR

      :ref:`Full listing. <listing-OE2DPropMap_SetProperties.py>`

      .. oe:source:: OE2DPropMap_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-NEGATIVECOLOR

      .. oe:source:: OE2DPropMap_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-NEGATIVECOLOR

      .. oe:source:: OE2DPropMap_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-NEGATIVECOLOR

      .. _figure_OE2DPropMap_SetNegativeColor:

      .. figure:: graphemetk/images/OE2DPropMap_SetNegativeColor.*
         :align:  center

         **Example of using the SetNegativeColor method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::GetNegativeColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: SetPositiveColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPositiveColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetPositiveColor(color: OEColor) -> None

      Sets the color that is used to represent positive atom
      property values.

      Example (see :ref:`Figure: Example of using the SetPositiveColor method<figure_OE2DPropMap_SetPositiveColor>`)

      .. oe:source:: OE2DPropMap_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-POSITIVECOLOR

      ..    oe:language:: python

            :ref:`Full listing. <listing-OE2DPropMap_SetProperties.py>`

      .. oe:source:: OE2DPropMap_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-POSITIVECOLOR

      .. oe:source:: OE2DPropMap_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-POSITIVECOLOR

      .. oe:source:: OE2DPropMap_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-POSITIVECOLOR

      .. _figure_OE2DPropMap_SetPositiveColor:

      .. figure:: graphemetk/images/OE2DPropMap_SetPositiveColor.*
         :align:  center

         **Example of using the SetPositiveColor method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::GetPositiveColor` method
         * :ref:`OEColor <OESystem_OEColor>` class

   .. oe:method:: SetRadiusRatio

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRadiusRatio(double ratio)

      .. oe:language:: python

         .. oe:api:: python

            SetRadiusRatio(ratio: float) -> None

      Sets the ratio that is used to scale the Gaussian radius.

      *ratio*
         This value has to be in the range of [0.5, 2.0].

      Example (see :ref:`Figure: Example of using the SetRadiusRatio method<figure_OE2DPropMap_SetRadiusRatio>`)

      .. oe:source:: OE2DPropMap_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-RADIUS-RATIO

      :ref:`Full listing. <listing-OE2DPropMap_SetProperties.py>`

      .. oe:source:: OE2DPropMap_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-RADIUS-RATIO

      .. oe:source:: OE2DPropMap_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-RADIUS-RATIO

      .. oe:source:: OE2DPropMap_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-RADIUS-RATIO

      .. _figure_OE2DPropMap_SetRadiusRatio:

      .. figure:: graphemetk/images/OE2DPropMap_SetRadiusRatio.*
         :align:  center

         **Example of using the SetRadiusRatio method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::GetRadiusRatio` method

   .. oe:method:: SetResolution

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetResolution(unsigned int resolution)

      .. oe:language:: python

         .. oe:api:: python

            SetResolution(resolution: int) -> None

      Sets the resolution of the property grid.

      *resolution*
         This value has to be in the range of [2, 20].

      Example (see :ref:`Figure: Example of using the SetResolution method<figure_OE2DPropMap_SetResolution>`)

      .. oe:source:: OE2DPropMap_SetProperties.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-RESOLUTION

      ..    oe:language:: python

            :ref:`Full listing. <listing-OE2DPropMap_SetProperties.py>`

      .. oe:source:: OE2DPropMap_SetProperties.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-RESOLUTION

      .. oe:source:: OE2DPropMap_SetProperties.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-RESOLUTION

      .. oe:source:: OE2DPropMap_SetProperties.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DPROPMAP-RESOLUTION

      .. _figure_OE2DPropMap_SetResolution:

      .. figure:: graphemetk/images/OE2DPropMap_SetResolution.*
         :align:  center

         **Example of using the SetResolution method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::GetResolution` method.



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEAlignedDepictionFrom3DOptions, AlignedDepictionFrom3DOptions

.. _OEGrapheme_OEAlignedDepictionFrom3DOptions:

.. oe:class:: OEAlignedDepictionFrom3DOptions

   .. oe:api::

      class OEAlignedDepictionFrom3DOptions

   This class represents :ref:`OEAlignedDepictionFrom3DOptions <OEGrapheme_OEAlignedDepictionFrom3DOptions>` that
   stores parameters that are used when generating 2D coordinates by
   calling the :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D` function.

   .. list-table::
      :widths: 150 100 100
      :header-rows: 1

      * - Property
        - Get method
        - Set method

      * - clear coords
        - :oe:meth:`GetClearCoords<OEGrapheme::OEAlignedDepictionFrom3DOptions::GetClearCoords>`
        - :oe:meth:`SetClearCoords<OEGrapheme::OEAlignedDepictionFrom3DOptions::SetClearCoords>`

      * - max number of bond rotations
        - :oe:meth:`GetMaxBondRotations<OEGrapheme::OEAlignedDepictionFrom3DOptions::GetMaxBondRotations>`
        - :oe:meth:`SetMaxBondRotations<OEGrapheme::OEAlignedDepictionFrom3DOptions::SetMaxBondRotations>`

      * - suppressing hydrogens
        - :oe:meth:`GetSuppressHydrogens<OEGrapheme::OEAlignedDepictionFrom3DOptions::GetSuppressHydrogens>`
        - :oe:meth:`SetSuppressHydrogens<OEGrapheme::OEAlignedDepictionFrom3DOptions::SetSuppressHydrogens>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAlignedDepictionFrom3DOptions(bool clearCoords = true,
                                            bool suppressH = true)

      .. oe:language:: python

         .. oe:api:: python

            OEAlignedDepictionFrom3DOptions(clearFitCoords: bool = True,
                                            suppressH: bool = True) -> OEAlignedDepictionFrom3DOptions

      Default constructor that initializes an :ref:`OEAlignedDepictionFrom3DOptions <OEGrapheme_OEAlignedDepictionFrom3DOptions>`
      object with the following properties:

      .. list-table::  **Default parameters of the OEAlignedDepictionFrom3DOptions class**
         :widths: 100 100
         :header-rows: 1

         * - Property
           - Default value

         * - clear coordinates
           - true

         * - max number of bond rotations
           - :math:`2^{16} = 65536`

         * - suppressing hydrogens
           - true

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAlignedDepictionFrom3DOptions(const OEAlignedDepictionFrom3DOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEAlignedDepictionFrom3DOptions(rhs: OEAlignedDepictionFrom3DOptions) -> OEAlignedDepictionFrom3DOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAlignedDepictionFrom3DOptions &operator=(const OEAlignedDepictionFrom3DOptions &rhs)

      Assignment operator.

   .. oe:method:: GetClearCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetClearCoords() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearCoords() -> bool

      .. seealso::

         * :oe:meth:`OEGrapheme::OEAlignedDepictionFrom3DOptions::SetClearCoords` method

   .. oe:method:: GetMaxBondRotations

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxBondRotations() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxBondRotations() -> int

      .. seealso::

         * :oe:meth:`OEGrapheme::OEAlignedDepictionFrom3DOptions::SetSuppressHydrogens` method

   .. oe:method:: GetSuppressHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSuppressHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuppressHydrogens() -> bool

      Returns whether the explicit hydrogens are suppressed in the 
      molecule prior to generating the 2D coordinates.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEAlignedDepictionFrom3DOptions::SetSuppressHydrogens` method

   .. oe:method:: SetClearCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetClearCoords(bool clearcoords)

      .. oe:language:: python

         .. oe:api:: python

            SetClearCoords(arg2: bool) -> None

      If false and the fit molecule has 2D coordinates, then these coordinates are
      used for the alignment.
      Otherwise the 2D coordinates of the fitted molecule are generated
      by calling the :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` function.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEAlignedDepictionFrom3DOptions::GetClearCoords` method

   .. oe:method:: SetMaxBondRotations

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxBondRotations(unsigned int maxrotations)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxBondRotations(arg2: int) -> None

      Sets the maximum number of bond rotations performed during the 
      2D coordinate generation process.

      *maxrotations*

         The zero value means that there is no limit. Upon reaching this limit, 
         the process terminates and returns the "best" aligned 2D coordinates.

      .. hint::

         The default value for maximum number of bond rotations is
         :math:`2^{16} = 65536`. This means that by default only the first
         16 single bonds of the molecule will be rotated to find the "best"
         aligned 2D layout.

         It is recommended to use this parameter if the input 3D molecule has 
         a large number of rotatable bonds.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEAlignedDepictionFrom3DOptions::GetMaxBondRotations` method

   .. oe:method:: SetSuppressHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSuppressHydrogens(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetSuppressHydrogens(arg2: bool) -> None

      Sets whether the explicit hydrogens are suppressed in the
      molecule prior to generating the 2D coordinates.
      Only hydrogens that are necessary to faithfully represent tetrahedral
      stereochemistry will be kept.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEAlignedDepictionFrom3DOptions::GetSuppressHydrogens` method



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEAlphaRainbowArcFxn, AlphaRainbowArcFxn

.. _OEGrapheme_OEAlphaRainbowArcFxn:

.. oe:class:: OEAlphaRainbowArcFxn

   .. oe:api::

      class OEAlphaRainbowArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OEAlphaRainbowArcFxn <OEGrapheme_OEAlphaRainbowArcFxn>`.
   See example in :ref:`Figure: Example of drawing molecule surface using OEAlphaRainbowArcFxn<figure_OEAlphaRainbowArcFxn>`.

   .. _figure_OEAlphaRainbowArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OEAlphaRainbowArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OEAlphaRainbowArcFxn**

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawAlphaRainbowSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAlphaRainbowArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OEAlphaRainbowArcFxn(pen: OEPen = OEBlackPen) -> OEAlphaRainbowArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::AlphaRainbow` style.

      See example in :ref:`Figure: Example of drawing molecule surface using OEAlphaRainbowArcFxn<figure_OEAlphaRainbowArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAlphaRainbowArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAlphaRainbowArcFxn <OEGrapheme_OEAlphaRainbowArcFxn>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEAtomGlyphBase, AtomGlyphBase

.. _OEGrapheme_OEAtomGlyphBase:

.. oe:class:: OEAtomGlyphBase

   .. oe:api::

      class OEAtomGlyphBase

   :ref:`OEAtomGlyphBase <OEGrapheme_OEAtomGlyphBase>` is an abstract class that
   defines the interface used for atom annotation.

   .. seealso::

      * :ref:`chapter_annotation` chapter
      * :oe:func:`OEGrapheme::OEAddGlyph` function.

   The following classes derive from this class:

    * :ref:`OEAtomGlyphCircle <OEGrapheme_OEAtomGlyphCircle>`

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomGlyphBase()

      .. oe:language:: python

         .. oe:api:: python

            OEAtomGlyphBase() -> OEAtomGlyphBase

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            virtual OEAtomGlyphBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomGlyphBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: RenderGlyph

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RenderGlyph(OEDepict::OE2DMolDisplay& disp,
                             const OEChem::OEAtomBase* atom) const = 0

      .. oe:language:: python

         .. oe:api:: python

            RenderGlyph(disp: OE2DMolDisplay, atom: OEAtomBase) -> bool

      It is a virtual const method that is implemented in the concrete
      derived classes to annotate the given atom (*i.e.* to draw a `glyph` to
      mark the atom).

      *disp*
         The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that is modified
         to annotate the specified atom. 

      *atom*
         The :ref:`OEAtomBase <OEChem_OEAtomBase>` object being annotated.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEAtomGlyphCircle, AtomGlyphCircle

.. _OEGrapheme_OEAtomGlyphCircle:

.. oe:class:: OEAtomGlyphCircle

   .. oe:api::

      class OEAtomGlyphCircle : public OEAtomGlyphBase

   By using the :ref:`OEAtomGlyphCircle <OEGrapheme_OEAtomGlyphCircle>` class, atoms
   can be annotated by drawing a circle around them.

   .. seealso::

      * :ref:`chapter_annotation` chapter
      * :oe:constns:`OEGrapheme::OECircleStyle` namespace

   The following methods are publicly inherited from :ref:`OEAtomGlyphBase <OEGrapheme_OEAtomGlyphBase>`:

   ============================================================== ================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEAtomGlyphBase::CreateCopy>` :oe:meth:`RenderGlyph<OEGrapheme::OEAtomGlyphBase::RenderGlyph>`
   ============================================================== ================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomGlyphCircle(const OEDepict::OEPen& pen,
                              unsigned int circlestyle = OECircleStyle::Default,
                              double circleRadiusScale = 1.0,
                              unsigned int layer = OEDepict::OELayerPosition::Below)

      .. oe:language:: python

         .. oe:api:: python

            OEAtomGlyphCircle(pen: OEPen, circlestyle: int,
                              circleRadiusScale: float = 1.0, layer: int) -> OEAtomGlyphCircle

      Creates an :ref:`OEAtomGlyphCircle <OEGrapheme_OEAtomGlyphCircle>` object with the
      specified parameters

      .. _figure_OEAtomGlyphCircle:

      .. figure:: graphemetk/images/OEAtomGlyphCircle.*
         :align:  center

         **Example of atom annotations**

      *pen*
         The pen used when drawing a circle around an atom.

         See example (A) and (B) in :ref:`Figure: Example of atom annotations<figure_OEAtomGlyphCircle>`.

      *circlestyle*
         The style of the drawn circle from the 
         :oe:constns:`OEGrapheme::OECircleStyle` namespace.

         See examples (C) and (D) in :ref:`Figure: Example of atom annotations<figure_OEAtomGlyphCircle>`.

      *circleRadiusScale*
         The multiplier used to modify the radius of the drawn circles 

         See examples (D) and (E) in :ref:`Figure: Example of atom annotations<figure_OEAtomGlyphCircle>`.

      *layer*
         Specifies whether the circle is drawn above 
         (:oe:const:`OEDepict::OELayerPosition::Above`) or below 
         (:oe:const:`OEDepict::OELayerPosition::Below`) the molecule.  

         See examples (B) and (F) in :ref:`Figure: Example of atom annotations<figure_OEAtomGlyphCircle>`.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomGlyphBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomGlyphCircle

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAtomGlyphCircle <OEGrapheme_OEAtomGlyphCircle>`
      object is dynamically allocated and owned by the caller.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: RenderGlyph

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RenderGlyph(OEDepict::OE2DMolDisplay& disp,
                             const OEChem::OEAtomBase* atom) const

      .. oe:language:: python

         .. oe:api:: python

            RenderGlyph(disp: OE2DMolDisplay, atom: OEAtomBase) -> bool

      Draws a glyph (in this case a circle) around the given atom.

      *disp*
         The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that is modified
         to annotate the specified atom. 

      *atom*
         The :ref:`OEAtomBase <OEChem_OEAtomBase>` object being annotated.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEBondGlyphArrow, BondGlyphArrow

.. _OEGrapheme_OEBondGlyphArrow:

.. oe:class:: OEBondGlyphArrow

   .. oe:api::

      class OEBondGlyphArrow : public OEBondGlyphBase

   By using the :ref:`OEBondGlyphArrow <OEGrapheme_OEBondGlyphArrow>` class, bonds
   can be annotated by drawing an arrow across them.

   .. seealso::

      * :ref:`chapter_annotation` chapter
      * :ref:`OEBondGlyphCircle <OEGrapheme_OEBondGlyphCircle>` class
      * :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>` class
      * :ref:`OEBondGlyphCurvedArrow <OEGrapheme_OEBondGlyphCurvedArrow>` class
      * :ref:`OEBondGlyphScissors <OEGrapheme_OEBondGlyphScissors>` class
      * :ref:`OEBondGlyphStitch <OEGrapheme_OEBondGlyphStitch>` class
      * :ref:`OEBondGlyphZigZag <OEGrapheme_OEBondGlyphZigZag>` class

   The following methods are publicly inherited from :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>`:

   ============================================================== ================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEBondGlyphBase::CreateCopy>` :oe:meth:`RenderGlyph<OEGrapheme::OEBondGlyphBase::RenderGlyph>`
   ============================================================== ================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphArrow(const OEDepict::OEPen &,
                             double arrowLengthScale = 1.0,
                             unsigned int layer = OEDepict::OELayerPosition::Above)

      .. oe:language:: python

         .. oe:api:: python

            OEBondGlyphArrow(pen: OEPen, arrowLengthScale: float = 1.0,
                             layer: int) -> OEBondGlyphArrow

      Creates an :ref:`OEBondGlyphArrow <OEGrapheme_OEBondGlyphArrow>` object with the
      specified parameters.

      .. _figure_OEBondGlyphArrow:

      .. figure:: graphemetk/images/OEBondGlyphArrow.*
         :align:  center

         **Example of bond annotations**

      *pen*
         The pen used when drawing an arrow across the middle of the bond.

         See examples (A) and (B) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphArrow>`.

      *arrowLengthScale*
         The multiplier used to modify the length of the drawn arrows.

         See examples (A) and (C) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphArrow>`.

      *layer*
         Specifies whether the arrow is drawn above
         (:oe:const:`OEDepict::OELayerPosition::Above`) or below
         (:oe:const:`OEDepict::OELayerPosition::Below`) the molecule.

         See examples (B) and (D) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphArrow>`.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondGlyphArrow

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBondGlyphArrow <OEGrapheme_OEBondGlyphArrow>`
      object is dynamically allocated and owned by the caller.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: RenderGlyph

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RenderGlyph(OEDepict::OE2DMolDisplay& disp,
                             const OEChem::OEBondBase* bond) const

      .. oe:language:: python

         .. oe:api:: python

            RenderGlyph(disp: OE2DMolDisplay, bond: OEBondBase) -> bool

      Draws a glyph (in this case a straight arrow) in the middle of the given bond.

      *disp*
         The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that is modified
         to annotate the specified bond.

      *bond*
         The :ref:`OEBondBase <OEChem_OEBondBase>` object being annotated.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEBondGlyphBase, BondGlyphBase

.. _OEGrapheme_OEBondGlyphBase:

.. oe:class:: OEBondGlyphBase

   .. oe:api::

      class OEBondGlyphBase

   :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>` is an abstract class that
   defines the interface used for bond annotation.

   .. seealso::

      * :ref:`chapter_annotation` chapter
      * :oe:func:`OEGrapheme::OEAddGlyph` function.

   The following classes derive from this class:

    * :ref:`OEBondGlyphArrow <OEGrapheme_OEBondGlyphArrow>`
    * :ref:`OEBondGlyphCircle <OEGrapheme_OEBondGlyphCircle>`
    * :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>` class
    * :ref:`OEBondGlyphCurvedArrow <OEGrapheme_OEBondGlyphCurvedArrow>` class
    * :ref:`OEBondGlyphScissors <OEGrapheme_OEBondGlyphScissors>` class
    * :ref:`OEBondGlyphStitch <OEGrapheme_OEBondGlyphStitch>` class
    * :ref:`OEBondGlyphZigZag <OEGrapheme_OEBondGlyphZigZag>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphBase()

      .. oe:language:: python

         .. oe:api:: python

            OEBondGlyphBase() -> OEBondGlyphBase

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            virtual OEBondGlyphBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondGlyphBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: RenderGlyph

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RenderGlyph(OEDepict::OE2DMolDisplay &,
                             const OEChem::OEBondBase *) const = 0

      .. oe:language:: python

         .. oe:api:: python

            RenderGlyph(disp: OE2DMolDisplay, bond: OEBondBase) -> bool

      It is a virtual const method that is implemented in the concrete
      derived classes to annotate the given bond (*i.e.* to draw a `glyph` to
      mark the bond).

      *disp*
         The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that is modified
         to annotate the specified bond.

      *atom*
         The :ref:`OEBondBase <OEChem_OEBondBase>` object being annotated.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEBondGlyphCircle, BondGlyphCircle

.. _OEGrapheme_OEBondGlyphCircle:

.. oe:class:: OEBondGlyphCircle

   .. oe:api::

      class OEBondGlyphCircle : public OEBondGlyphBase

   By using the :ref:`OEBondGlyphCircle <OEGrapheme_OEBondGlyphCircle>` class, bonds
   can be annotated by drawing a circle in the middle of them.

   .. seealso::

      * :ref:`chapter_annotation` chapter
      * :oe:constns:`OEGrapheme::OECircleStyle` namespace
      * :ref:`OEBondGlyphArrow <OEGrapheme_OEBondGlyphArrow>` class
      * :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>` class
      * :ref:`OEBondGlyphCurvedArrow <OEGrapheme_OEBondGlyphCurvedArrow>` class
      * :ref:`OEBondGlyphScissors <OEGrapheme_OEBondGlyphScissors>` class
      * :ref:`OEBondGlyphStitch <OEGrapheme_OEBondGlyphStitch>` class
      * :ref:`OEBondGlyphZigZag <OEGrapheme_OEBondGlyphZigZag>` class

   The following methods are publicly inherited from :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>`:

   ============================================================== ================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEBondGlyphBase::CreateCopy>` :oe:meth:`RenderGlyph<OEGrapheme::OEBondGlyphBase::RenderGlyph>`
   ============================================================== ================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphCircle(const OEDepict::OEPen &,
                              unsigned int circlestyle = OECircleStyle::Default,
                              double circleRadiusScale = 1.0,
                              unsigned int layer = OEDepict::OELayerPosition::Above)

      .. oe:language:: python

         .. oe:api:: python

            OEBondGlyphCircle(pen: OEPen, circlestyle: int,
                              circleRadiusScale: float = 1.0, layer: int) -> OEBondGlyphCircle

      Creates an :ref:`OEBondGlyphCircle <OEGrapheme_OEBondGlyphCircle>` object with the
      specified parameters.

      .. _figure_OEBondGlyphCircle:

      .. figure:: graphemetk/images/OEBondGlyphCircle.*
         :align:  center

         **Example of bond annotations**

      *pen*
         The pen used when drawing a circle in the middle of a bond.

         See examples (A) and (B) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphCircle>`.

      *circlestyle*
         The style of the drawn circle from the
         :oe:constns:`OEGrapheme::OECircleStyle` namespace.

         See examples (C) and (D) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphCircle>`.

      *circleRadiusScale*
         The multiplier used to modify the radius of the drawn circles.

         See examples (D) and (E) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphCircle>`.

      *layer*
         Specifies whether the circle is drawn above
         (:oe:const:`OEDepict::OELayerPosition::Above`) or below
         (:oe:const:`OEDepict::OELayerPosition::Below`) the molecule.

         See examples (B) and (F) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphCircle>`.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondGlyphCircle

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBondGlyphCircle <OEGrapheme_OEBondGlyphCircle>`
      object is dynamically allocated and owned by the caller.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: RenderGlyph

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RenderGlyph(OEDepict::OE2DMolDisplay& disp,
                             const OEChem::OEBondBase* bond) const

      .. oe:language:: python

         .. oe:api:: python

            RenderGlyph(disp: OE2DMolDisplay, bond: OEBondBase) -> bool

      Draws a glyph (in this case a circle) in the middle of the given bond.

      *disp*
         The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that is modified
         to annotate the specified bond.

      *bond*
         The :ref:`OEBondBase <OEChem_OEBondBase>` object being annotated.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEBondGlyphCross, BondGlyphCross

.. _OEGrapheme_OEBondGlyphCross:

.. oe:class:: OEBondGlyphCross

   .. oe:api::

      class OEBondGlyphCross : public OEBondGlyphBase

   By using the :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>` class, bonds
   can be annotated by drawing a cross in the middle of them.

   .. seealso::

      * :ref:`chapter_annotation` chapter
      * :oe:constns:`OEGrapheme::OECircleStyle` namespace
      * :ref:`OEBondGlyphArrow <OEGrapheme_OEBondGlyphArrow>` class
      * :ref:`OEBondGlyphCircle <OEGrapheme_OEBondGlyphCircle>` class
      * :ref:`OEBondGlyphCurvedArrow <OEGrapheme_OEBondGlyphCurvedArrow>` class
      * :ref:`OEBondGlyphScissors <OEGrapheme_OEBondGlyphScissors>` class
      * :ref:`OEBondGlyphStitch <OEGrapheme_OEBondGlyphStitch>` class
      * :ref:`OEBondGlyphZigZag <OEGrapheme_OEBondGlyphZigZag>` class

   The following methods are publicly inherited from :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>`:

   =============================================================== ================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEBondGlyphBase::CreateCopy>`  :oe:meth:`RenderGlyph<OEGrapheme::OEBondGlyphBase::RenderGlyph>`
   =============================================================== ================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphCross(const OEDepict::OEPen& pen,
                             double crossLengthScale = 1.0,
                             unsigned int layer = OEDepict::OELayerPosition::Above)

      .. oe:language:: python

         .. oe:api:: python

            OEBondGlyphCross(pen: OEPen, crossLengthScale: float = 1.0,
                             layer: int) -> OEBondGlyphCross

      Creates an :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>` object with the
      specified parameters.

      .. _figure_OEBondGlyphCross:

      .. figure:: graphemetk/images/OEBondGlyphCross.*
         :align:  center

         **Example of bond annotations**

      *pen*
         The pen used when drawing a cross across the middle of the bond.

         See examples (A) and (B) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphCross>`.

      *crossLengthScale*
         The multiplier used to modify the length of the drawn cross.

         See examples (A) and (C) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphCross>`.

      *layer*
         Specifies whether the cross drawn above
         (:oe:const:`OEDepict::OELayerPosition::Above`) or below
         (:oe:const:`OEDepict::OELayerPosition::Below`) the molecule.

         See examples (B) and (D) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphCross>`.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondGlyphCross

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>`
      object is dynamically allocated and owned by the caller.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: RenderGlyph

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RenderGlyph(OEDepict::OE2DMolDisplay& disp,
                             const OEChem::OEBondBase* bond) const

      .. oe:language:: python

         .. oe:api:: python

            RenderGlyph(disp: OE2DMolDisplay, bond: OEBondBase) -> bool

      Draws a glyph (in this case a cross) in the middle of the given bond.

      *disp*
         The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that is modified
         to annotate the specified bond.

      *bond*
         The :ref:`OEBondBase <OEChem_OEBondBase>` object being annotated.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEBondGlyphCurvedArrow, BondGlyphCurvedArrow

.. _OEGrapheme_OEBondGlyphCurvedArrow:

.. oe:class:: OEBondGlyphCurvedArrow

   .. oe:api::

      class OEBondGlyphCurvedArrow : public OEBondGlyphBase

   By using the :ref:`OEBondGlyphCurvedArrow <OEGrapheme_OEBondGlyphCurvedArrow>` class, bonds
   can be annotated by drawing a curved arrow across them.

   .. seealso::

      * :ref:`chapter_annotation` chapter
      * :ref:`OEBondGlyphArrow <OEGrapheme_OEBondGlyphArrow>` class
      * :ref:`OEBondGlyphCircle <OEGrapheme_OEBondGlyphCircle>` class
      * :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>` class
      * :ref:`OEBondGlyphScissors <OEGrapheme_OEBondGlyphScissors>` class
      * :ref:`OEBondGlyphStitch <OEGrapheme_OEBondGlyphStitch>` class
      * :ref:`OEBondGlyphZigZag <OEGrapheme_OEBondGlyphZigZag>` class

   The following methods are publicly inherited from :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>`:

   =============================================================== ================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEBondGlyphBase::CreateCopy>`  :oe:meth:`RenderGlyph<OEGrapheme::OEBondGlyphBase::RenderGlyph>`
   =============================================================== ================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphCurvedArrow(const OEDepict::OEPen& pen,
                                   double arrowRadiusScale = 1.0,
                                   bool clockwise = true,
                                   double arcAngle = 270.0,
                                   unsigned int layer = OEDepict::OELayerPosition::Above)

      .. oe:language:: python

         .. oe:api:: python

            OEBondGlyphCurvedArrow(pen: OEPen, arrowRadiusScale: float = 1.0,
                                   clockwise: bool = True,
                                   arcAngle: float = 270.0, layer: int) -> OEBondGlyphCurvedArrow

      Creates an :ref:`OEBondGlyphCurvedArrow <OEGrapheme_OEBondGlyphCurvedArrow>` object with the
      specified parameters.

      .. _figure_OEBondGlyphCurvedArrow:

      .. figure:: graphemetk/images/OEBondGlyphCurvedArrow.*
         :align:  center

         **Example of bond annotations**

      *pen*
         The pen used when drawing a curved arrow at the middle of the bond.

         See examples (A) and (B) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphCurvedArrow>`.

      *arrowRadiusScale*
         The multiplier used to modify the radius of the drawn arc.

         See examples (A) and (C) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphCurvedArrow>`.

      *clockwise*
         The direction of the arrow.

         See examples (A) and (D) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphCurvedArrow>`.

      *arcAngle*
         The angel of the arc in degrees.
         The value has to be in a range of :math:`[0.0^{\circ}, 360.0^{\circ}]`.

         See examples (A) and (E) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphCurvedArrow>`.

      *layer*
         Specifies whether the curved arrow is drawn above
         (:oe:const:`OEDepict::OELayerPosition::Above`) or below
         (:oe:const:`OEDepict::OELayerPosition::Below`) the molecule.

         See examples (B) and (F) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphCurvedArrow>`.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondGlyphCurvedArrow

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBondGlyphCurvedArrow <OEGrapheme_OEBondGlyphCurvedArrow>`
      object is dynamically allocated and owned by the caller.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: RenderGlyph

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RenderGlyph(OEDepict::OE2DMolDisplay& disp,
                             const OEChem::OEBondBase* bond) const

      .. oe:language:: python

         .. oe:api:: python

            RenderGlyph(disp: OE2DMolDisplay, bond: OEBondBase) -> bool

      Draws a glyph (in this case a curved arrow) in the middle of the given bond.

      *disp*
         The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that is modified
         to annotate the specified bond.

      *bond*
         The :ref:`OEBondBase <OEChem_OEBondBase>` object being annotated.



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEBondGlyphScissors, BondGlyphScissors

.. _OEGrapheme_OEBondGlyphScissors:

.. oe:class:: OEBondGlyphScissors

   .. oe:api::

      class OEBondGlyphScissors : public OEBondGlyphBase

   By using the :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>` class, bonds
   can be annotated by drawing a cross in the middle of them.

   .. seealso::

      * :ref:`chapter_annotation` chapter
      * :oe:constns:`OEGrapheme::OECircleStyle` namespace
      * :ref:`OEBondGlyphArrow <OEGrapheme_OEBondGlyphArrow>` class
      * :ref:`OEBondGlyphCircle <OEGrapheme_OEBondGlyphCircle>` class
      * :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>` class
      * :ref:`OEBondGlyphCurvedArrow <OEGrapheme_OEBondGlyphCurvedArrow>` class
      * :ref:`OEBondGlyphStitch <OEGrapheme_OEBondGlyphStitch>` class
      * :ref:`OEBondGlyphZigZag <OEGrapheme_OEBondGlyphZigZag>` class

   The following methods are publicly inherited from :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>`:

   =============================================================== ================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEBondGlyphBase::CreateCopy>`  :oe:meth:`RenderGlyph<OEGrapheme::OEBondGlyphBase::RenderGlyph>`
   =============================================================== ================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphScissors(const OEDepict::OEPen& pen,
                                double scissorsLengthScale = 1.0,
                                unsigned int layer = OEDepict::OELayerPosition::Above)

      .. oe:language:: python

         .. oe:api:: python

            OEBondGlyphScissors(pen: OEPen, scissorsLengthScale: float = 1.0,
                                layer: int) -> OEBondGlyphScissors

      Creates an :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>` object with the
      specified parameters.

      .. _figure_OEBondGlyphScissors:

      .. figure:: graphemetk/images/OEBondGlyphScissors.*
         :align:  center

         **Example of bond annotations**

      *pen*
         The pen used when drawing scissors across the middle of the bond.

         See examples (A) and (B) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphScissors>`.

      *scissorsLengthScale*
         The multiplier used to modify the length of the drawn scissors.

         See examples (A) and (C) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphScissors>`.

      *layer*
         Specifies whether the scissors are drawn above
         (:oe:const:`OEDepict::OELayerPosition::Above`) or below
         (:oe:const:`OEDepict::OELayerPosition::Below`) the molecule.

         See examples (B) and (D) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphScissors>`.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondGlyphScissors

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBondGlyphScissors <OEGrapheme_OEBondGlyphScissors>`
      object is dynamically allocated and owned by the caller.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: RenderGlyph

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RenderGlyph(OEDepict::OE2DMolDisplay& disp,
                             const OEChem::OEBondBase* bond) const

      .. oe:language:: python

         .. oe:api:: python

            RenderGlyph(disp: OE2DMolDisplay, bond: OEBondBase) -> bool

      Draws a glyph (in this case a scissors) in the middle of the given bond.

      *disp*
         The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that is modified
         to annotate the specified bond.

      *bond*
         The :ref:`OEBondBase <OEChem_OEBondBase>` object being annotated.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEBondGlyphStitch, BondGlyphStitch

.. _OEGrapheme_OEBondGlyphStitch:

.. oe:class:: OEBondGlyphStitch

   .. oe:api::

      class OEBondGlyphStitch : public OEBondGlyphBase

   By using the :ref:`OEBondGlyphStitch <OEGrapheme_OEBondGlyphStitch>` class, bonds
   can be annotated by drawing perpendicular lines across them.

   .. seealso::

      * :ref:`chapter_annotation` chapter
      * :ref:`OEBondGlyphArrow <OEGrapheme_OEBondGlyphArrow>` class
      * :ref:`OEBondGlyphCircle <OEGrapheme_OEBondGlyphCircle>` class
      * :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>` class
      * :ref:`OEBondGlyphCurvedArrow <OEGrapheme_OEBondGlyphCurvedArrow>` class
      * :ref:`OEBondGlyphScissors <OEGrapheme_OEBondGlyphScissors>` class
      * :ref:`OEBondGlyphZigZag <OEGrapheme_OEBondGlyphZigZag>` class

   The following methods are publicly inherited from :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>`:

   =============================================================== ================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEBondGlyphBase::CreateCopy>`  :oe:meth:`RenderGlyph<OEGrapheme::OEBondGlyphBase::RenderGlyph>`
   =============================================================== ================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphStitch(const OEDepict::OEPen& pen,
                              unsigned int nrstitches = 2u,
                              double stitchLengthScale = 1.0,
                              unsigned int layer = OEDepict::OELayerPosition::Above)

      .. oe:language:: python

         .. oe:api:: python

            OEBondGlyphStitch(pen: OEPen, nrstitches: int = 2,
                              stitchLengthScale: float = 1.0, layer: int) -> OEBondGlyphStitch

      Creates an :ref:`OEBondGlyphZigZag <OEGrapheme_OEBondGlyphZigZag>` object with the
      specified parameters.

      .. _figure_OEBondGlyphStitch:

      .. figure:: graphemetk/images/OEBondGlyphStitch.*
         :align:  center

         **Example of bond annotations**

      *pen*
         The pen used when drawing the perpendicular lines across the bond.

         See examples (A) and (B) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphStitch>`.

      *nrstitches*
         The number of perpendicular lines drawn across the bond.
         This value has to be in the range of [1, 5].

         See examples (A) and (C) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphStitch>`.

      *stitchLengthScale*
         The multiplier used to modify the length of the drawn perpendicular lines.

         See examples (A) and (D) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphStitch>`.

      *layer*
         Specifies whether the perpendicular lines are drawn above
         (:oe:const:`OEDepict::OELayerPosition::Above`) or below
         (:oe:const:`OEDepict::OELayerPosition::Below`) the molecule.

         See examples (B) and (E) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphStitch>`.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondGlyphStitch

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBondGlyphStitch <OEGrapheme_OEBondGlyphStitch>`
      object is dynamically allocated and owned by the caller.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: RenderGlyph

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RenderGlyph(OEDepict::OE2DMolDisplay& disp,
                             const OEChem::OEBondBase* bond) const

      .. oe:language:: python

         .. oe:api:: python

            RenderGlyph(disp: OE2DMolDisplay, bond: OEBondBase) -> bool



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEBondGlyphZigZag, BondGlyphZigZag

.. _OEGrapheme_OEBondGlyphZigZag:

.. oe:class:: OEBondGlyphZigZag

   .. oe:api::

      class OEBondGlyphZigZag : public OEBondGlyphBase

   By using the :ref:`OEBondGlyphZigZag <OEGrapheme_OEBondGlyphZigZag>` class, bonds
   can be annotated by drawing a zig-zag line across them.

   .. seealso::

      * :ref:`chapter_annotation` chapter
      * :ref:`OEBondGlyphArrow <OEGrapheme_OEBondGlyphArrow>` class
      * :ref:`OEBondGlyphCircle <OEGrapheme_OEBondGlyphCircle>` class
      * :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>` class
      * :ref:`OEBondGlyphCurvedArrow <OEGrapheme_OEBondGlyphCurvedArrow>` class
      * :ref:`OEBondGlyphScissors <OEGrapheme_OEBondGlyphScissors>` class
      * :ref:`OEBondGlyphStitch <OEGrapheme_OEBondGlyphStitch>` class

   The following methods are publicly inherited from :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>`:

   =============================================================== ================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEBondGlyphBase::CreateCopy>`  :oe:meth:`RenderGlyph<OEGrapheme::OEBondGlyphBase::RenderGlyph>`
   =============================================================== ================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphZigZag(const OEDepict::OEPen& pen,
                              double zigzagLengthScale = 1.0,
                              unsigned int layer = OEDepict::OELayerPosition::Above,
                              bool diagonal = false)

      .. oe:language:: python

         .. oe:api:: python

            OEBondGlyphZigZag(pen: OEPen, zigzagLengthScale: float = 1.0,
                              layer: int, diagonal: bool = False) -> OEBondGlyphZigZag

      Creates an :ref:`OEBondGlyphZigZag <OEGrapheme_OEBondGlyphZigZag>` object with the
      specified parameters.

      .. _figure_OEBondGlyphZigZag:

      .. figure:: graphemetk/images/OEBondGlyphZigZag.*
         :align:  center

         **Example of bond annotations**

      *pen*
         The pen used when drawing a zig-zag line across bond.

         See examples (A) and (B) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphZigZag>`.

      *zigzagLengthScale*
         The multiplier used to modify the length of the drawn zig-zag line.

         See examples (A) and (C) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphZigZag>`.

      *layer*
         Specifies whether the zig-zag line is drawn above
         (:oe:const:`OEDepict::OELayerPosition::Above`) or below
         (:oe:const:`OEDepict::OELayerPosition::Below`) the molecule.

         See examples (B) and (D) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphZigZag>`.

      *diagonal*
         Specifies whether the zig-zag line is drawn across the bond or in parallel with it.

         See examples (A) and (E) in :ref:`Figure: Example of bond annotations<figure_OEBondGlyphZigZag>`.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBondGlyphBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondGlyphZigZag

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBondGlyphZigZag <OEGrapheme_OEBondGlyphZigZag>`
      object is dynamically allocated and owned by the caller.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: RenderGlyph

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RenderGlyph(OEDepict::OE2DMolDisplay& disp,
                             const OEChem::OEBondBase* bond) const

      .. oe:language:: python

         .. oe:api:: python

            RenderGlyph(disp: OE2DMolDisplay, bond: OEBondBase) -> bool

      Draws a glyph (in this case a zig-zag line) across the given bond.

      *disp*
         The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that is modified
         to annotate the specified bond.

      *bond*
         The :ref:`OEBondBase <OEChem_OEBondBase>` object being annotated.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEBrickRoadArcFxn, BrickRoadArcFxn

.. _OEGrapheme_OEBrickRoadArcFxn:

.. oe:class:: OEBrickRoadArcFxn

   .. oe:api::

      class OEBrickRoadArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OEBrickRoadArcFxn <OEGrapheme_OEBrickRoadArcFxn>`.
   See example in :ref:`Figure: Example of drawing molecule surface using OEBrickRoadArcFxn<figure_OEBrickRoadArcFxn>`.

   .. _figure_OEBrickRoadArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OEBrickRoadArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OEBrickRoadArcFxn**

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawBrickRoadSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBrickRoadArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OEBrickRoadArcFxn(pen: OEPen = OEBlackPen) -> OEBrickRoadArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::BrickRoad` style.

      See example in :ref:`Figure: Example of drawing molecule surface using OEBrickRoadArcFxn<figure_OEBrickRoadArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBrickRoadArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBrickRoadArcFxn <OEGrapheme_OEBrickRoadArcFxn>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OECastleArcFxn, CastleArcFxn

.. _OEGrapheme_OECastleArcFxn:

.. oe:class:: OECastleArcFxn

   .. oe:api::

      class OECastleArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OECastleArcFxn <OEGrapheme_OECastleArcFxn>`.
   See example in :ref:`Figure: Example of drawing molecule surface using OECastleArcFxn<figure_OECastleArcFxn>`.

   .. _figure_OECastleArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OECastleArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OECastleArcFxn**  

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawCastleSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECastleArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OECastleArcFxn(pen: OEPen = OEBlackPen) -> OECastleArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Castle` style.

      See example in :ref:`Figure: Example of drawing molecule surface using OECastleArcFxn<figure_OECastleArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OECastleArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OECastleArcFxn <OEGrapheme_OECastleArcFxn>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OECogArcFxn, CogArcFxn

.. _OEGrapheme_OECogArcFxn:

.. oe:class:: OECogArcFxn

   .. oe:api::

      class OECogArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OECogArcFxn <OEGrapheme_OECogArcFxn>`.
   See example in :ref:`Figure: Example of drawing molecule surface using OECogArcFxn<figure_OECogArcFxn>`.

   .. _figure_OECogArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OECogArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OECogArcFxn**  

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawCogSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECogArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OECogArcFxn(pen: OEPen = OEBlackPen) -> OECogArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Cog` style.

      See example in :ref:`Figure: Example of drawing molecule surface using OECogArcFxn<figure_OECogArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OECogArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OECogArcFxn <OEGrapheme_OECogArcFxn>`
      object is dynamically allocated and owned by the caller.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEColorForceFieldDisplay, ColorForceFieldDisplay

.. _OEGrapheme_OEColorForceFieldDisplay:

.. oe:class:: OEColorForceFieldDisplay

   .. oe:api::

      class OEColorForceFieldDisplay

   This class represents :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>` that
   stores the depiction information of a :ref:`OEColorForceField <OEShape_OEColorForceField>`
   object.
   See example in :ref:`Figure: Example of depicting a color force field in a legend<figure_OEColorForceFieldDisplay>`.

   .. seealso::

      * The Theory chapter of the **Shape TK** manual.
      * :ref:`OEColorForceFieldLegendDisplayOptions <OEGrapheme_OEColorForceFieldLegendDisplayOptions>` class
      * :oe:func:`OEGrapheme::OEDrawColorForceFieldLegend` function

   .. _figure_OEColorForceFieldDisplay:

   .. figure:: graphemetk/images/DrawColorForceFieldLegend.*
      :align:  center

      **Example of depicting a color force field in a legend**

   .. admonition:: Code Example

      * `Visualizing Shape and Color Overlap`_ **OpenEye Python Cookbook** recipe

   .. _OEGrapheme_OEColorForceFieldDisplay_Constructors:

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorForceFieldDisplay(const OEShape::OEColorForceField& cff,
                                     bool preserveQueryColors = false)

      .. oe:language:: python

         .. oe:api:: python

            OEColorForceFieldDisplay(cff: OEColorForceField,
                                     preserveQueryColors: bool = False) -> OEColorForceFieldDisplay

      Creates an :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>` object
      with a given color force field and an option to preserve colors on input query molecules.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorForceFieldDisplay(const OEColorForceFieldDisplay& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEColorForceFieldDisplay(rhs: OEColorForceFieldDisplay) -> OEColorForceFieldDisplay

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColorForceFieldDisplay &operator=(const OEColorForceFieldDisplay &rhs)

      Assignment operator. 

   .. _OEGrapheme_OEColorForceFieldDisplay_GetColor:

   .. oe:method:: GetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetColor(unsigned int type) const

      .. oe:language:: python

         .. oe:api:: python

            GetColor(type: int) -> OEColor

      Returns the color that is associated with the given color atom
      type.

   .. _OEGrapheme_OEColorForceFieldDisplay_GetColorTypes:

   .. oe:method:: GetColorTypes

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<unsigned int>* GetColorTypes() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorTypes() -> Iterable[int]

      Returns the iterator over the color atom types.

   .. _OEGrapheme_OEColorForceFieldDisplay_GetName:

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetName(unsigned int type) const

      .. oe:language:: python

         .. oe:api:: python

            GetName(type: int) -> str

      Returns the name that is associated with the given color atom
      type.

   .. _OEGrapheme_OEColorForceFieldDisplay_GetPreserveQueryColors:

   .. oe::method GetPreserveQueryColors
      
      .. oe:api::

         bool GetPreserveQueryColors() const

      Returns the state of the option to preserve a query molecule's color atoms.

   .. _OEGrapheme_OEColorForceFieldDisplay_NumColorTypes:

   .. oe:method:: NumColorTypes

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumColorTypes() const

      .. oe:language:: python

         .. oe:api:: python

            NumColorTypes() -> int

      Returns the number of color atom types.

   .. _OEGrapheme_OEColorForceFieldDisplay_SetColor:

   .. oe:method:: SetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColor(unsigned int type, const OEDepict::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetColor(type: int, color: OEColor) -> None

      Sets the color that is associated with the given color atom
      type.

   .. _OEGrapheme_OEColorForceFieldDisplay_SetName:

   .. oe:method:: SetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetName(unsigned int type, const std::string& name)

      .. oe:language:: python

         .. oe:api:: python

            SetName(type: int, name: str) -> None

      Sets the name that is associated with the given color atom
      type.

   .. _OEGrapheme_OEColorForceFieldDisplay_SetPreserveQueryColors:

   .. oe::method SetPreserveQueryColors
      
      .. oe:api::

         void SetPreserveQueryColors(bool value)

      Sets the option to preserve a query molecule's color atoms or not.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEColorForceFieldLegendDisplayOptions, ColorForceFieldLegendDisplayOptions

.. _OEGrapheme_OEColorForceFieldLegendDisplayOptions:

.. oe:class:: OEColorForceFieldLegendDisplayOptions

   .. oe:api::

      class OEColorForceFieldLegendDisplayOptions

   This class represents :ref:`OEColorForceFieldLegendDisplayOptions <OEGrapheme_OEColorForceFieldLegendDisplayOptions>`
   that encapsulates properties that determine how the legend of
   a color force field is depicted by the
   :oe:func:`OEGrapheme::OEDrawColorForceFieldLegend` function.

   .. seealso::

      * :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>` class
      * :oe:func:`OEGrapheme::OEDrawColorForceFieldLegend` function

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorForceFieldLegendDisplayOptions(unsigned int rows,
                                                  unsigned int cols)

      .. oe:language:: python

         .. oe:api:: python

            OEColorForceFieldLegendDisplayOptions(rows: int, cols: int) -> OEColorForceFieldLegendDisplayOptions

      Creates an :ref:`OEColorForceFieldLegendDisplayOptions <OEGrapheme_OEColorForceFieldLegendDisplayOptions>`
      object with the specified number of rows and columns..

      *rows*
        The number of rows in the legend.

      *cols*
         The number of columns in the legend.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorForceFieldLegendDisplayOptions(const OEColorForceFieldLegendDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEColorForceFieldLegendDisplayOptions(rhs: OEColorForceFieldLegendDisplayOptions) -> OEColorForceFieldLegendDisplayOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColorForceFieldLegendDisplayOptions &operator=(const OEColorForceFieldLegendDisplayOptions &rhs)

      Assignment operator.

   .. oe:method:: NumCols

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumCols() const

      .. oe:language:: python

         .. oe:api:: python

            NumCols() -> int

      Returns the number of columns of the legend.

   .. oe:method:: NumRows

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumRows() const

      .. oe:language:: python

         .. oe:api:: python

            NumRows() -> int

      Returns the number of rows of the legend.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEColorGradientDisplayOptions, ColorGradientDisplayOptions

.. _OEGrapheme_OEColorGradientDisplayOptions:

.. oe:class:: OEColorGradientDisplayOptions

   .. oe:api::

      class OEColorGradientDisplayOptions

   This class represents the :ref:`OEColorGradientDisplayOptions <OEGrapheme_OEColorGradientDisplayOptions>`
   class that holds properties that determine how a color gradient is rendered.

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawColorGradient` function

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorGradientDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEColorGradientDisplayOptions() -> OEColorGradientDisplayOptions

      Default constructor.

      .. _figure_OEColorGradientDisplayOptions_Default:

      .. figure:: graphemetk/images/OEColorGradientDisplayOptions_Default.*
         :align:  center

         **Example of drawing a color gradient with default options**

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorGradientDisplayOptions(const OEColorGradientDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEColorGradientDisplayOptions(rhs: OEColorGradientDisplayOptions) -> OEColorGradientDisplayOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColorGradientDisplayOptions &operator=(const OEColorGradientDisplayOptions &rhs)

      Assignment operator.

   .. oe:method:: AddLabel

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddLabel(const OEColorGradientLabel& label)

      .. oe:language:: python

         .. oe:api:: python

            AddLabel(label: OEColorGradientLabel) -> None

      Adds an additional label that will be rendered on the strip of the
      color gradient.

      *label*
         The :ref:`OEColorGradientLabel <OEGrapheme_OEColorGradientLabel>` object that
         defines the label and the position where the label
         is going to be rendered to the color gradient.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDLABEL

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`

      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDLABEL

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDLABEL

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDLABEL

      .. _figure_OEColorGradientDisplayOptions_AddLabel:

      .. figure:: graphemetk/images/OEColorGradientDisplayOptions_AddLabel.*
         :align:  center

         **Example of using the AddLabel method**

      .. seealso::

         * :ref:`OEColorGradientLabel <OEGrapheme_OEColorGradientLabel>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetLabels` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearLabels` method

   .. oe:method:: AddMarkedValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddMarkedValue(double value)

      .. oe:language:: python

         .. oe:api:: python

            AddMarkedValue(value: float) -> None

      Adds an additional value that will be marked on the strip of the color
      gradient along with the label of the value above the strip.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUE

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`

      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUE

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUE

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUE

      .. _figure_OEColorGradientDisplayOptions_AddMarkedValue:

      .. figure:: graphemetk/images/OEColorGradientDisplayOptions_AddMarkedValue.*
         :align:  center

         **Example of using the AddMarkedValue method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearMarkedValues` method

   .. oe:method:: AddMarkedValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddMarkedValues(const std::vector<double>& values)

      .. oe:language:: python

         .. oe:api:: python

            AddMarkedValues(values: OEDoubleVector) -> None

      Adds additional values that will be marked on the strip of the color gradient
      along with their labels above the strip.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUES

      ..    oe:language:: python

          :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`

      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUES

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUES

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUES

      .. _figure_OEColorGradientDisplayOptions_AddMarkedValues:

      .. figure:: graphemetk/images/OEColorGradientDisplayOptions_AddMarkedValues.*
         :align:  center

         **Example of using the AddMarkedValues method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValue` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValues` method

   .. oe:method:: ClearBoxRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearBoxRange()

      .. oe:language:: python

         .. oe:api:: python

            ClearBoxRange() -> None

      Removes the range previously set to be marked on the color gradient.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetBoxRangeMax` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetBoxRangeMin` method

   .. oe:method:: ClearLabels

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearLabels()

      .. oe:language:: python

         .. oe:api:: python

            ClearLabels() -> None

      Removes labels previously set by the
      :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddLabel` method
      to be marked on the color gradient.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddLabel` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetLabels` method

   .. oe:method:: ClearMarkedValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearMarkedValues()

      .. oe:language:: python

         .. oe:api:: python

            ClearMarkedValues() -> None

      Removes any values previously set to be marked on the color gradient.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValue` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValues` method

   .. oe:method:: GetBoxRangeMax

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBoxRangeMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoxRangeMax() -> float

      Returns the minimum value of the range being marked on the color gradient.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearBoxRange` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange` method

   .. oe:method:: GetBoxRangeMin

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBoxRangeMin() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoxRangeMin() -> float

      Returns the maximum value of the range being marked on the color gradient.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearBoxRange` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange` method

   .. oe:method:: GetBoxRangePen

      Returns the pen used to draw the box to mark the range set by the
      :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange` method.

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEDepict::OEPen& GetBoxRangePen() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoxRangePen() -> OEPen

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange`
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRangePen` method

   .. oe:method:: GetColorStopLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEDepict::OEFont& GetColorStopLabelFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorStopLabelFont() -> OEFont

      Returns the font that is used to render the color stops of the
      color gradient.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetColorStopLabelFont` method

   .. oe:method:: GetColorStopLabelFontScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetColorStopLabelFontScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorStopLabelFontScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the size of the color stop label fonts.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetColorStopLabelFontScale` method

   .. oe:method:: GetColorStopPrecision

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetColorStopPrecision() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorStopPrecision() -> int

      Returns the precision of the color stop labels *i.e.* the number of digits that is
      written to express the floating-point values.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetColorStopPrecision` method

   .. oe:method:: GetColorStopVisibility

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetColorStopVisibility() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorStopVisibility() -> bool

      Returns whether the color stop labels are rendered.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetColorStopVisibility` method

   .. oe:method:: GetLabels

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEColorGradientLabel>* GetLabels() const

      .. oe:language:: python

         .. oe:api:: python

            GetLabels() -> Iterable[OEColorGradientLabel]

      Returns an iterator over the labels that are being rendered onto
      the color gradient.

      .. seealso::

         * :ref:`OEColorGradientLabel <OEGrapheme_OEColorGradientLabel>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddLabel` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearLabels` method

   .. oe:method:: GetMarkedValuePen

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEDepict::OEPen& GetMarkedValuePen() const

      .. oe:language:: python

         .. oe:api:: python

            GetMarkedValuePen() -> OEPen

      Returns the pen that is used to draw the lines for the marked values.

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValuePen` method

   .. oe:method:: GetMarkedValuePrecision

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMarkedValuePrecision() const

      .. oe:language:: python

         .. oe:api:: python

            GetMarkedValuePrecision() -> int

      Returns the precision of the marked value labels *i.e.* the number
      of digits that is written to express the floating-point values.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValuePrecision` method

   .. oe:method:: GetMarkedValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<double>* GetMarkedValues() const

      .. oe:language:: python

         .. oe:api:: python

            GetMarkedValues() -> Iterable[float]

      Returns an iterator over the values that are being marked on the
      color gradient.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValue` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValues` method

   .. oe:method:: SetBoxRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBoxRange(double minvalue, double maxvalue)

      .. oe:language:: python

         .. oe:api:: python

            SetBoxRange(minvalue: float, maxvalue: float) -> None

      Sets the range being marked on the color gradient.

      *minvalue, maxvalue*
         The minimum and maximum value of the range.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGE

      :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`

      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGE

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGE

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGE

      .. _figure_OEColorGradientDisplayOptions_SetBoxRange:

      .. figure:: graphemetk/images/OEColorGradientDisplayOptions_SetBoxRange.*
         :align:  center

         **Example of using the SetBoxRange method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearBoxRange` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetBoxRangeMax` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetBoxRangeMin` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange` method

   .. oe:method:: SetBoxRangePen

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBoxRangePen(const OEDepict::OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            SetBoxRangePen(pen: OEPen) -> None

      Sets the pen used to mark a specified range on the color gradient.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGEPEN

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`

      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGEPEN

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGEPEN

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGEPEN

      .. _figure_OEColorGradientDisplayOptions_SetBoxRangePen:

      .. figure:: graphemetk/images/OEColorGradientDisplayOptions_SetBoxRangePen.*
         :align:  center

         **Example of using the SetBoxRangePen method**

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetBoxRangePen` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange` method

   .. oe:method:: SetColorStopLabelFont

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColorStopLabelFont(const OEDepict::OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetColorStopLabelFont(font: OEFont) -> None

      Sets the font that is used to render color stops of the color gradient.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONT

      :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`

      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONT

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONT

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONT

      .. _figure_OEColorGradientDisplayOptions_SetColorStopLabelFont:

      .. figure:: graphemetk/images/OEColorGradientDisplayOptions_SetColorStopLabelFont.*
         :align:  center

         **Example of using the SetColorStopLabelFont method**

      .. note::

         The size of font also depends on dimensions of the image
         into which the color gradient is rendered.
         See also :oe:func:`OEGrapheme::OEDrawColorGradient` function.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetColorStopLabelFont` method

   .. oe:method:: SetColorStopLabelFontScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColorStopLabelFontScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetColorStopLabelFontScale(scale: float) -> None

      Sets the multiplier that can be used increase or decrease the
      size of the fonts of the color stop labels.

      *scale*
         This value has to be in the range of ``[0.5, 3.0]``.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONTSCALE

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`

      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONTSCALE

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONTSCALE

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONTSCALE

      .. _figure_OEColorGradientDisplayOptions_SetColorStopLabelFontScale:

      .. figure:: graphemetk/images/OEColorGradientDisplayOptions_SetColorStopLabelFontScale.*
         :align:  center

         **Example of using the SetColorStopLabelFontScale method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetColorStopLabelFontScale` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetColorStopLabelFont` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetColorStopLabelFont` method

   .. oe:method:: SetColorStopPrecision

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColorStopPrecision(unsigned int precision)

      .. oe:language:: python

         .. oe:api:: python

            SetColorStopPrecision(precision: int) -> None

      Sets the precision of the color stop labels *i.e.* the number of digits that is
      written to express the floating-point values.

      *precision*
          The zero value means that the precision is determined by the lowest
          significant digits of the color stop values that is in the range of [1,4].

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPPRECISION

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`

      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPPRECISION

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPPRECISION

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPPRECISION

      .. _figure_OEColorGradientDisplayOptions_SetColorStopPrecision:

      .. figure:: graphemetk/images/OEColorGradientDisplayOptions_SetColorStopPrecision.*
         :align:  center

         **Example of using the SetColorStopPrecision method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetColorStopPrecision` method

   .. oe:method:: SetColorStopVisibility

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColorStopVisibility(bool visible)

      .. oe:language:: python

         .. oe:api:: python

            SetColorStopVisibility(visible: bool) -> None

      Sets whether the color stop labels are rendered.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPVISIBILITY

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`

      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPVISIBILITY

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPVISIBILITY

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPVISIBILITY

      .. _figure_OEColorGradientDisplayOptions_SetColorStopVisibility:

      .. figure:: graphemetk/images/OEColorGradientDisplayOptions_SetColorStopVisibility.*
         :align:  center

         **Example of using the SetColorStopVisibility method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetColorStopVisibility` method

   .. oe:method:: SetMarkedValuePen

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMarkedValuePen(const OEDepict::OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            SetMarkedValuePen(pen: OEPen) -> None

      Sets the pen that is used to draw the lines for the marked values.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPEN

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`

      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPEN

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPEN

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPEN

      .. _figure_OEColorGradientDisplayOptions_SetMarkedValuePen:

      .. figure:: graphemetk/images/OEColorGradientDisplayOptions_ SetMarkedValuePen.*
         :align:  center

         **Example of using the SetMarkedValuePen method**

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetMarkedValuePen` method

   .. oe:method:: SetMarkedValuePrecision

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMarkedValuePrecision(unsigned int precision)

      .. oe:language:: python

         .. oe:api:: python

            SetMarkedValuePrecision(precision: int) -> None

      Sets the precision of the marked value labels *i.e.* the number of digits that is
      written to express the floating-point values.
      Decreasing the precision can result in collapsing that labels of two or more
      distinct values into one label.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPRECISION

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`

      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPRECISION

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPRECISION

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPRECISION

      .. _figure_OEColorGradientDisplayOptions_SetMarkedValuePrecision:

      .. figure:: graphemetk/images/OEColorGradientDisplayOptions_SetMarkedValuePrecision.*
         :align:  center

         **Example of using the SetMarkedValuePrecision method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetMarkedValuePrecision` method

   .. oe:method:: SetMarkedValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMarkedValues(const std::vector<double>& values)

      .. oe:language:: python

         .. oe:api:: python

            SetMarkedValues(values: OEDoubleVector) -> None

      Initializes values that will be marked on the strip of the color gradient
      along with the value labels above the strip.
      :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValues` method
      discards the list of values set in prior calls.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-SETMARKEDVALUES

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`

      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-SETMARKEDVALUES

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-SETMARKEDVALUES

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-SETMARKEDVALUES

      .. _figure_OEColorGradientDisplayOptions_SetMarkedValues:

      .. figure:: graphemetk/images/OEColorGradientDisplayOptions_SetMarkedValues.*
         :align:  center

         **Example of using the SetMarkedValues method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValue` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearMarkedValues` method


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEColorGradientLabel, ColorGradientLabel

.. _OEGrapheme_OEColorGradientLabel:

.. oe:class:: OEColorGradientLabel

   .. oe:api::

      class OEColorGradientLabel

   The :ref:`OEColorGradientLabel <OEGrapheme_OEColorGradientLabel>` class stores a value
   (double) and label (string) pair that is used by the
   :ref:`OEColorGradientDisplayOptions <OEGrapheme_OEColorGradientDisplayOptions>` class to render
   user defined labels into the color gradients.

   .. _figure_ OEColorGradientLabel:

   .. figure:: graphemetk/images/OEColorGradientDisplayOptions_AddLabel.*
      :align:  center

      **Example of depicting labels above the color gradient**

   .. seealso::

      * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddLabel` method

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorGradientLabel(double value, const std::string& label)

      .. oe:language:: python

         .. oe:api:: python

            OEColorGradientLabel(value: float, label: str) -> OEColorGradientLabel

      *value*
        Defines the position of the string being rendered.

      *label*
        Defines the string being rendered.

      Constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorGradientLabel(const OEColorGradientLabel& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEColorGradientLabel(arg2: OEColorGradientLabel) -> OEColorGradientLabel

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColorGradientLabel &operator=(const OEColorGradientLabel &rhs)

      Assignment operator.

   .. oe:method:: GetLabel

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetLabel() const

      .. oe:language:: python

         .. oe:api:: python

            GetLabel() -> str

      Returns the string stored in the :ref:`OEColorGradientLabel <OEGrapheme_OEColorGradientLabel>`
      object that will be rendered into the color gradient.

   .. oe:method:: GetValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetValue() const

      .. oe:language:: python

         .. oe:api:: python

            GetValue() -> float

      Returns the value stored in the :ref:`OEColorGradientLabel <OEGrapheme_OEColorGradientLabel>`
      object that defined the position of the associated label
      on the color gradient.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEColorOverlapDisplayOptions, ColorOverlapDisplayOptions

.. _OEGrapheme_OEColorOverlapDisplayOptions:

.. oe:class:: OEColorOverlapDisplayOptions

   .. oe:api::

      class OEColorOverlapDisplayOptions : public OEDepict::OE2DMolDisplayOptions

   This class represents :ref:`OEColorOverlapDisplayOptions <OEGrapheme_OEColorOverlapDisplayOptions>`
   that encapsulates properties that determine how the color atom
   overlap between the reference and the fit molecule is depicted by the
   :oe:func:`OEGrapheme::OERenderColorOverlap` function.

   .. seealso::

      * :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` class
      * :oe:func:`OEGrapheme::OERenderColorOverlap` function

   .. admonition:: Code Example

      * `Visualizing Shape and Color Overlap`_ **OpenEye Python Cookbook** recipe

   The following methods are publicly inherited from :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`:
   
   ====================================================================================================== ====================================================================================================== ====================================================================================================== 
   :oe:meth:`operator=<OEDepict::OE2DMolDisplayOptions::operator=>`                                       :oe:meth:`GetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::GetHydrogenStyle>`                         :oe:meth:`SetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineAtomLabelGapScale>`
   :oe:meth:`GetAromaticStyle<OEDepict::OE2DMolDisplayOptions::GetAromaticStyle>`                         :oe:meth:`GetMargin<OEDepict::OE2DMolDisplayOptions::GetMargin>`                                       :oe:meth:`SetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineGapScale>`
   :oe:meth:`GetAtomColor<OEDepict::OE2DMolDisplayOptions::GetAtomColor>`                                 :oe:meth:`GetScale<OEDepict::OE2DMolDisplayOptions::GetScale>`                                         :oe:meth:`SetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont>`
   :oe:meth:`GetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle>`                       :oe:meth:`GetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetSuperAtomLabelFont>`               :oe:meth:`SetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale>`
   :oe:meth:`GetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFont>`                         :oe:meth:`GetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle>`                       :oe:meth:`SetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor>`
   :oe:meth:`GetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFontScale>`               :oe:meth:`GetTitleFont<OEDepict::OE2DMolDisplayOptions::GetTitleFont>`                                 :oe:meth:`SetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle>`
   :oe:meth:`GetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFont>`                 :oe:meth:`GetTitleFontScale<OEDepict::OE2DMolDisplayOptions::GetTitleFontScale>`                       :oe:meth:`SetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::SetBondWidthScaling>`
   :oe:meth:`GetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFontScale>`       :oe:meth:`GetTitleHeight<OEDepict::OE2DMolDisplayOptions::GetTitleHeight>`                             :oe:meth:`SetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen>`
   :oe:meth:`GetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetAtomPropertyFunctor>`             :oe:meth:`GetTitleLocation<OEDepict::OE2DMolDisplayOptions::GetTitleLocation>`                         :oe:meth:`SetDimensions<OEDepict::OE2DMolDisplayOptions::SetDimensions>`
   :oe:meth:`GetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::GetAtomStereoStyle>`                     :oe:meth:`GetWidth<OEDepict::OE2DMolDisplayOptions::GetWidth>`                                         :oe:meth:`SetHeight<OEDepict::OE2DMolDisplayOptions::SetHeight>`
   :oe:meth:`GetBackgroundColor<OEDepict::OE2DMolDisplayOptions::GetBackgroundColor>`                     :oe:meth:`SetAromaticStyle<OEDepict::OE2DMolDisplayOptions::SetAromaticStyle>`                         :oe:meth:`SetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle>`
   :oe:meth:`GetBondColorStyle<OEDepict::OE2DMolDisplayOptions::GetBondColorStyle>`                       :oe:meth:`SetAtomColor<OEDepict::OE2DMolDisplayOptions::SetAtomColor>`                                 :oe:meth:`SetMargin<OEDepict::OE2DMolDisplayOptions::SetMargin>`
   :oe:meth:`GetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineAtomLabelGapScale>` :oe:meth:`SetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle>`                       :oe:meth:`SetMargins<OEDepict::OE2DMolDisplayOptions::SetMargins>`
   :oe:meth:`GetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineGapScale>`                   :oe:meth:`SetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFont>`                         :oe:meth:`SetScale<OEDepict::OE2DMolDisplayOptions::SetScale>`
   :oe:meth:`GetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFont>`                 :oe:meth:`SetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale>`               :oe:meth:`SetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetSuperAtomLabelFont>`
   :oe:meth:`GetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFontScale>`       :oe:meth:`SetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont>`                 :oe:meth:`SetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle>`
   :oe:meth:`GetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetBondPropertyFunctor>`             :oe:meth:`SetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale>`       :oe:meth:`SetTitleFont<OEDepict::OE2DMolDisplayOptions::SetTitleFont>`
   :oe:meth:`GetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::GetBondStereoStyle>`                     :oe:meth:`SetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor>`             :oe:meth:`SetTitleFontScale<OEDepict::OE2DMolDisplayOptions::SetTitleFontScale>`
   :oe:meth:`GetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::GetBondWidthScaling>`                   :oe:meth:`SetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle>`                     :oe:meth:`SetTitleHeight<OEDepict::OE2DMolDisplayOptions::SetTitleHeight>`
   :oe:meth:`GetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::GetDefaultBondPen>`                       :oe:meth:`SetBackgroundColor<OEDepict::OE2DMolDisplayOptions::SetBackgroundColor>`                     :oe:meth:`SetTitleLocation<OEDepict::OE2DMolDisplayOptions::SetTitleLocation>`
   :oe:meth:`GetHeight<OEDepict::OE2DMolDisplayOptions::GetHeight>`                                       :oe:meth:`SetBondColorStyle<OEDepict::OE2DMolDisplayOptions::SetBondColorStyle>`                       :oe:meth:`SetWidth<OEDepict::OE2DMolDisplayOptions::SetWidth>`
   ====================================================================================================== ====================================================================================================== ====================================================================================================== 

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorOverlapDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEColorOverlapDisplayOptions() -> OEColorOverlapDisplayOptions

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorOverlapDisplayOptions(const OEColorOverlapDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEColorOverlapDisplayOptions(rhs: OEColorOverlapDisplayOptions) -> OEColorOverlapDisplayOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColorOverlapDisplayOptions &operator=(const OEColorOverlapDisplayOptions &rhs)

      Assignment operator.

   .. oe:method:: ClearQuerySurfaceArcFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearQuerySurfaceArcFxn()

      .. oe:language:: python

         .. oe:api:: python

            ClearQuerySurfaceArcFxn() -> None

      Removes the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule around the fit molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorOverlapDisplayOptions::GetQuerySurfaceArcFxn`
         * :oe:meth:`OEGrapheme::OEColorOverlapDisplayOptions::SetQuerySurfaceArcFxn`

   .. oe:method:: GetClearBackground

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetClearBackground() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearBackground() -> bool

      Returns whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to the rendering of the color overlap.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorOverlapDisplayOptions::SetClearBackground`

   .. oe:method:: GetQuerySurfaceArcFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESurfaceArcFxnBase* GetQuerySurfaceArcFxn() const

      .. oe:language:: python

         .. oe:api:: python

            GetQuerySurfaceArcFxn() -> OESurfaceArcFxnBase

      Returns the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule around the fit molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorOverlapDisplayOptions::ClearQuerySurfaceArcFxn`
         * :oe:meth:`OEGrapheme::OEColorOverlapDisplayOptions::SetQuerySurfaceArcFxn`

   .. oe:method:: SetClearBackground

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetClearBackground(bool clear)

      .. oe:language:: python

         .. oe:api:: python

            SetClearBackground(clear: bool) -> None

      Returns whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to the rendering of the color overlap.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorOverlapDisplayOptions::GetClearBackground`

   .. oe:method:: SetQuerySurfaceArcFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetQuerySurfaceArcFxn(const OESurfaceArcFxnBase& arcfxn)

      .. oe:language:: python

         .. oe:api:: python

            SetQuerySurfaceArcFxn(arcfxn: OESurfaceArcFxnBase) -> None

      Sets the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule around the fit molecule
      when calling the :oe:func:`OEGrapheme::OERenderColorOverlap` function
      to depict the atom color overlap.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorOverlapDisplayOptions::ClearQuerySurfaceArcFxn`
         * :oe:meth:`OEGrapheme::OEColorOverlapDisplayOptions::GetQuerySurfaceArcFxn`


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEComplexSurfaceArcFxnBase, ComplexSurfaceArcFxnBase

.. _OEGrapheme_OEComplexSurfaceArcFxnBase:

.. oe:class:: OEComplexSurfaceArcFxnBase

   .. oe:api::

      class OEComplexSurfaceArcFxnBase : public OESurfaceArcFxnBase

   This class represents :ref:`OEComplexSurfaceArcFxnBase <OEGrapheme_OEComplexSurfaceArcFxnBase>`
   which is an abstract class that defines the interface used for drawing
   molecule surfaces. 
   The :ref:`OEComplexSurfaceArcFxnBase <OEGrapheme_OEComplexSurfaceArcFxnBase>` class also stores
   a *depth* parameter that reflects the relative distance between the
   ligand and the receptor when drawing the complex surface.

   .. seealso::

      :ref:`chapter_complex_surface` chapter

   The following methods are publicly inherited from
   :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   The following classes derive from this class:
    * :ref:`OEDefaultCavityArcFxn <OEGrapheme_OEDefaultCavityArcFxn>`
    * :ref:`OEDefaultVoidArcFxn <OEGrapheme_OEDefaultVoidArcFxn>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEComplexSurfaceArcFxnBase()
            OEComplexSurfaceArcFxnBase(double depth)
            OEComplexSurfaceArcFxnBase(const OEComplexSurfaceArcFxnBase& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEComplexSurfaceArcFxnBase() -> OEComplexSurfaceArcFxnBase
            OEComplexSurfaceArcFxnBase(depth: float) -> OEComplexSurfaceArcFxnBase
            OEComplexSurfaceArcFxnBase(rhs: OEComplexSurfaceArcFxnBase) -> OEComplexSurfaceArcFxnBase

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEComplexSurfaceArcFxnBase &operator=(const OEComplexSurfaceArcFxnBase &rhs)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      It is a virtual const method that is implemented in the concrete 
      derived classes to draw surface arcs.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

   .. ################################################################
      # CreateComplexCopy
      ################################################################

   .. oe:method:: CreateComplexCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEComplexSurfaceArcFxnBase* CreateComplexCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateComplexCopy() -> OEComplexSurfaceArcFxnBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to the
      :ref:`OEComplexSurfaceArcFxnBase <OEGrapheme_OEComplexSurfaceArcFxnBase>` base class.

   .. ################################################################
      # CreateCopy
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEComplexSurfaceArcFxnBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to the
      :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>` base class.

   .. ################################################################
      # GetDepth
      ################################################################

   .. oe:method:: GetDepth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDepth() const

      .. oe:language:: python

         .. oe:api:: python

            GetDepth() -> float

      Returns the *depth* parameter of the surface arc.

   .. ################################################################
      # SetDepth
      ################################################################

   .. oe:method:: SetDepth

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDepth(double depth)

      .. oe:language:: python

         .. oe:api:: python

            SetDepth(depth: float) -> None

      Sets the *depth* parameter of the surface arc.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDefaultArcFxn, DefaultArcFxn

.. _OEGrapheme_OEDefaultArcFxn:

.. oe:class:: OEDefaultArcFxn

   .. oe:api::

      class OEDefaultArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OEDefaultArcFxn <OEGrapheme_OEDefaultArcFxn>`.
   See example in :ref:`Figure: Example of drawing molecule surface using OEDefaultArcFxn<figure_OEDefaultArcFxn>`.

   .. _figure_OEDefaultArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OEDefaultArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OEDefaultArcFxn**

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawDefaultSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDefaultArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OEDefaultArcFxn(pen: OEPen = OEBlackPen) -> OEDefaultArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Default` style.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDefaultArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEDefaultArcFxn <OEGrapheme_OEDefaultArcFxn>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDefaultBuriedArcFxn, DefaultBuriedArcFxn

.. _OEGrapheme_OEDefaultBuriedArcFxn:

.. oe:class:: OEDefaultBuriedArcFxn

   .. oe:api::

      class OEDefaultBuriedArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OEDefaultBuriedArcFxn <OEGrapheme_OEDefaultBuriedArcFxn>`
   functor that is used to draw the arc segment of the 2D molecule
   surface, where the ligand and the protein tightly fit in the 3D
   complex.
   See example in :ref:`Figure: Example of drawing an arc using OEDefaultBuriedArcFxn<figure_OEDefaultBuriedArcFxn>`.

   .. _figure_OEDefaultBuriedArcFxn:

   .. figure:: graphemetk/images/OEDefaultBuriedArcFxn.*
      :align:  center

      **Example of drawing an arc using OEDefaultBuriedArcFxn**

   .. seealso::

      * :ref:`chapter_complex_surface` chapter
      * :oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function
      * :ref:`OEDefaultBuriedArcFxn <OEGrapheme_OEDefaultBuriedArcFxn>` class
      * :ref:`OEDefaultCavityArcFxn <OEGrapheme_OEDefaultCavityArcFxn>` class
      * :ref:`OEDefaultSolventArcFxn <OEGrapheme_OEDefaultSolventArcFxn>` class

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDefaultBuriedArcFxn()

      .. oe:language:: python

         .. oe:api:: python

            OEDefaultBuriedArcFxn() -> OEDefaultBuriedArcFxn

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& a) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, a: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Default` style using a
      black pen.

      *image*
         The image on which the *buried* surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function
         * :oe:func:`OEGrapheme::OEDrawEyelashSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDefaultBuriedArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEDefaultBuriedArcFxn <OEGrapheme_OEDefaultBuriedArcFxn>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDefaultCavityArcFxn, DefaultCavityArcFxn

.. _OEGrapheme_OEDefaultCavityArcFxn:

.. oe:class:: OEDefaultCavityArcFxn

   .. oe:api::

      class OEDefaultCavityArcFxn : public OEComplexSurfaceArcFxnBase

   This class represents :ref:`OEDefaultCavityArcFxn <OEGrapheme_OEDefaultCavityArcFxn>`
   functor that is used to draw the arc segment of the 2D molecule
   surface, where there is a cavity detected between the ligand and
   the protein in the 3D complex.
   See example in :ref:`Figure: Example of drawing an arc using OEDefaultCavityArcFxn<figure_OEDefaultCavityArcFxn>`.

   .. _figure_OEDefaultCavityArcFxn:

   .. figure:: graphemetk/images/OEDefaultCavityArcFxn.*
      :align:  center

      **Example of drawing an arc using OEDefaultCavityArcFxn**

   .. seealso::

      * :ref:`chapter_complex_surface` chapter
      * :oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function
      * :ref:`OEDefaultBuriedArcFxn <OEGrapheme_OEDefaultBuriedArcFxn>` class
      * :ref:`OEDefaultSolventArcFxn <OEGrapheme_OEDefaultSolventArcFxn>` class
      * :ref:`OEDefaultVoidArcFxn <OEGrapheme_OEDefaultVoidArcFxn>` class

   The following methods are publicly inherited from :ref:`OEComplexSurfaceArcFxnBase <OEGrapheme_OEComplexSurfaceArcFxnBase>`:

   ====================================================================================== ======================================================================================= ======================================================================================
   :oe:meth:`operator=<OEGrapheme::OEComplexSurfaceArcFxnBase::operator=>`                :oe:meth:`CreateComplexCopy<OEGrapheme::OEComplexSurfaceArcFxnBase::CreateComplexCopy>` :oe:meth:`GetDepth<OEGrapheme::OEComplexSurfaceArcFxnBase::GetDepth>`                 
   :oe:meth:`operator()<OEGrapheme::OEComplexSurfaceArcFxnBase::operator()>`              :oe:meth:`CreateCopy<OEGrapheme::OEComplexSurfaceArcFxnBase::CreateCopy>`               :oe:meth:`SetDepth<OEGrapheme::OEComplexSurfaceArcFxnBase::SetDepth>`                 
   ====================================================================================== ======================================================================================= ======================================================================================

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDefaultCavityArcFxn()

      .. oe:language:: python

         .. oe:api:: python

            OEDefaultCavityArcFxn() -> OEDefaultCavityArcFxn

      Default constructors.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& a) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, a: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Cog` style using
      a black pen.

      *image*
         The image on which the *cavity* surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function
         * :oe:func:`OEGrapheme::OEDrawCogSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDefaultCavityArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEDefaultCavityArcFxn <OEGrapheme_OEDefaultCavityArcFxn>`
      object is dynamically allocated and owned by the caller.



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDefaultSolventArcFxn, DefaultSolventArcFxn

.. _OEGrapheme_OEDefaultSolventArcFxn:

.. oe:class:: OEDefaultSolventArcFxn

   .. oe:api::

      class OEDefaultSolventArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OEDefaultSolventArcFxn <OEGrapheme_OEDefaultSolventArcFxn>`
   functor that is used to draw the arc segment of the 2D molecule
   surface, where the ligand is exposed to the solvent in the 3D
   complex.
   See example in :ref:`Figure: Example of drawing an arc using OEDefaultSolventArcFxn<figure_OEDefaultSolventArcFxn>`.

   .. _figure_OEDefaultSolventArcFxn:

   .. figure:: graphemetk/images/OEDefaultSolventArcFxn.*
      :align:  center

      **Example of drawing an arc using OEDefaultSolventArcFxn**

   .. seealso::

      * :ref:`chapter_complex_surface` chapter
      * :oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function
      * :ref:`OEDefaultBuriedArcFxn <OEGrapheme_OEDefaultBuriedArcFxn>` class
      * :ref:`OEDefaultCavityArcFxn <OEGrapheme_OEDefaultCavityArcFxn>` class
      * :ref:`OEDefaultVoidArcFxn <OEGrapheme_OEDefaultVoidArcFxn>` class

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDefaultSolventArcFxn()

      .. oe:language:: python

         .. oe:api:: python

            OEDefaultSolventArcFxn() -> OEDefaultSolventArcFxn

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& a) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, a: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Default` style using a
      grey pen.

      *image*
         The image on which the *solvent* surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function
         * :oe:func:`OEGrapheme::OEDrawDefaultSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDefaultSolventArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEDefaultSolventArcFxn <OEGrapheme_OEDefaultSolventArcFxn>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDefaultVoidArcFxn, DefaultVoidArcFxn

.. _OEGrapheme_OEDefaultVoidArcFxn:

.. oe:class:: OEDefaultVoidArcFxn

   .. oe:api::

      class OEDefaultVoidArcFxn : public OEComplexSurfaceArcFxnBase

   This class represents :ref:`OEDefaultVoidArcFxn <OEGrapheme_OEDefaultVoidArcFxn>`
   functor that is used to draw the arc segment of the 2D molecule
   surface, where there is a small gap detected between the
   ligand and the protein in the 3D complex.
   See example in :ref:`Figure: Example of drawing an arc using OEDefaultVoidArcFxn<figure_OEDefaultVoidArcFxn>`.

   .. _figure_OEDefaultVoidArcFxn:

   .. figure:: graphemetk/images/OEDefaultVoidArcFxn.*
      :align:  center

      **Example of drawing an arc using OEDefaultVoidArcFxn**

   .. seealso::

      * :ref:`chapter_complex_surface` chapter
      * :oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function
      * :ref:`OEDefaultBuriedArcFxn <OEGrapheme_OEDefaultBuriedArcFxn>` class
      * :ref:`OEDefaultCavityArcFxn <OEGrapheme_OEDefaultCavityArcFxn>` class
      * :ref:`OEDefaultSolventArcFxn <OEGrapheme_OEDefaultSolventArcFxn>` class

   The following methods are publicly inherited from :ref:`OEComplexSurfaceArcFxnBase <OEGrapheme_OEComplexSurfaceArcFxnBase>`:

   ====================================================================================== ======================================================================================= ======================================================================================
   :oe:meth:`operator=<OEGrapheme::OEComplexSurfaceArcFxnBase::operator=>`                :oe:meth:`CreateComplexCopy<OEGrapheme::OEComplexSurfaceArcFxnBase::CreateComplexCopy>` :oe:meth:`GetDepth<OEGrapheme::OEComplexSurfaceArcFxnBase::GetDepth>`                 
   :oe:meth:`operator()<OEGrapheme::OEComplexSurfaceArcFxnBase::operator()>`              :oe:meth:`CreateCopy<OEGrapheme::OEComplexSurfaceArcFxnBase::CreateCopy>`               :oe:meth:`SetDepth<OEGrapheme::OEComplexSurfaceArcFxnBase::SetDepth>`                 
   ====================================================================================== ======================================================================================= ======================================================================================

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDefaultVoidArcFxn()

      .. oe:language:: python

         .. oe:api:: python

            OEDefaultVoidArcFxn() -> OEDefaultVoidArcFxn

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, a: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Eyelash` style using a
      black pen.

      *image*
         The image on which the *void* surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function
         * :oe:func:`OEGrapheme::OEDrawEyelashSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDefaultVoidArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEDefaultVoidArcFxn <OEGrapheme_OEDefaultVoidArcFxn>`
      object is dynamically allocated and owned by the caller.



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDepictionFrom3DOptions, DepictionFrom3DOptions

.. _OEGrapheme_OEDepictionFrom3DOptions:

.. oe:class:: OEDepictionFrom3DOptions

   .. oe:api::

      class OEDepictionFrom3DOptions

   This class represents :ref:`OEDepictionFrom3DOptions <OEGrapheme_OEDepictionFrom3DOptions>` that
   stores parameters that are used when generating 2D coordinates by
   calling the :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` function.

   .. list-table::
      :widths: 150 100 100
      :header-rows: 1

      * - Property
        - Get method
        - Set method

      * - inertial frame
        - :oe:meth:`GetCoordsToInertialFrame<OEGrapheme::OEDepictionFrom3DOptions::GetCoordsToInertialFrame>`
        - :oe:meth:`SetCoordsToInertialFrame<OEGrapheme::OEDepictionFrom3DOptions::SetCoordsToInertialFrame>`

      * - max number of bond rotations
        - :oe:meth:`GetMaxBondRotations<OEGrapheme::OEDepictionFrom3DOptions::GetMaxBondRotations>`
        - :oe:meth:`SetMaxBondRotations<OEGrapheme::OEDepictionFrom3DOptions::SetMaxBondRotations>`

      * - rotate to 2D reference
        - :oe:meth:`GetRotateTo2DReference<OEGrapheme::OEDepictionFrom3DOptions::GetRotateTo2DReference>`
        - :oe:meth:`SetRotateTo2DReference<OEGrapheme::OEDepictionFrom3DOptions::SetRotateTo2DReference>`

      * - suppressing hydrogens
        - :oe:meth:`GetSuppressHydrogens<OEGrapheme::OEDepictionFrom3DOptions::GetSuppressHydrogens>`
        - :oe:meth:`SetSuppressHydrogens<OEGrapheme::OEDepictionFrom3DOptions::SetSuppressHydrogens>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDepictionFrom3DOptions(bool suppressH = true)

      .. oe:language:: python

         .. oe:api:: python

            OEDepictionFrom3DOptions(suppressH: bool = True) -> OEDepictionFrom3DOptions

      Default constructor that initializes an :ref:`OEDepictionFrom3DOptions <OEGrapheme_OEDepictionFrom3DOptions>`
      object with the following properties:

      .. list-table::  **Default parameters of the OEDepictionFrom3DOptions class**
         :widths: 100 100
         :header-rows: 1

         * - Property
           - Default value

         * - inertial frame
           - false

         * - max number of bond rotations
           - :math:`2^{16} = 65536`

         * - rotate to 2D reference
           - false

         * - suppressing hydrogens
           - true

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDepictionFrom3DOptions(const OEDepictionFrom3DOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEDepictionFrom3DOptions(rhs: OEDepictionFrom3DOptions) -> OEDepictionFrom3DOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDepictionFrom3DOptions &operator=(const OEDepictionFrom3DOptions &rhs)

      Assignment operator.

   .. oe:method:: GetCoordsToInertialFrame

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCoordsToInertialFrame() const

      .. oe:language:: python

         .. oe:api:: python

            GetCoordsToInertialFrame() -> bool

      Returns whether the 3D molecule is moved to its inertial frame
      before generating the 2D coordinates.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEDepictionFrom3DOptions::SetCoordsToInertialFrame` method

   .. oe:method:: GetMaxBondRotations

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxBondRotations() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxBondRotations() -> int

      Returns the maximum number of bond rotations performed during the 
      2D coordinate generation process.

      The default value for maximum number of bond rotations is
      :math:`2^{16} = 65536`. This means that by default only the first
      16 single bonds of the molecule will be rotated to find the 'closest'
      2D layout to the original 3D conformation.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEDepictionFrom3DOptions::SetMaxBondRotations` method

   .. oe:method:: GetRotateTo2DReference

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRotateTo2DReference() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotateTo2DReference() -> bool

      Returns whether after the 2D coordinate generation a final rotation
      is performed to orient the 2D coordinates according
      to the 3D conformation.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEDepictionFrom3DOptions::SetRotateTo2DReference` method

   .. oe:method:: GetSuppressHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSuppressHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuppressHydrogens() -> bool

      Returns whether the explicit hydrogens are suppressed in the 
      molecule prior to generating the 2D coordinates.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEDepictionFrom3DOptions::SetSuppressHydrogens` method

   .. oe:method:: SetCoordsToInertialFrame

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCoordsToInertialFrame(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetCoordsToInertialFrame(arg2: bool) -> None

      Sets whether the 3D molecule is moved to its inertial frame
      before generating the 2D coordinates.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEDepictionFrom3DOptions::SetCoordsToInertialFrame` method

   .. oe:method:: SetMaxBondRotations

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxBondRotations(unsigned int maxrotations)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxBondRotations(arg2: int) -> None

      Sets the maximum number of bond rotations performed during the 
      2D coordinate generation process.

      *maxrotations*

         The zero value means that there is no limit. Upon reaching this limit, 
         the process terminates and returns the 2D coordinates that is the "closest"
         to the original 3D coordinates up to that point.

      .. hint::

         The default value for maximum number of bond rotations is
         :math:`2^{16} = 65536`. This means that by default only the first
         16 single bonds of the molecule will be rotated to find the
         2D layout that is the 'closest' to the original 3D conformation.

         It is recommended to use this parameter if the input 3D molecule has 
         a large number of rotatable bonds.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEDepictionFrom3DOptions::GetMaxBondRotations` method

   .. oe:method:: SetRotateTo2DReference

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRotateTo2DReference(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRotateTo2DReference(arg2: bool) -> None

      Sets whether after the 2D coordinate generation a final rotation
      is performed to orient the 2D coordinates according
      to the 3D conformation.
      This can be used to ensure that 2D molecules are oriented similarly
      when they 3D conformations were similar.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEDepictionFrom3DOptions::GetRotateTo2DReference` method

   .. oe:method:: SetSuppressHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSuppressHydrogens(bool suppressH)

      .. oe:language:: python

         .. oe:api:: python

            SetSuppressHydrogens(arg2: bool) -> None

      Sets whether the explicit hydrogens are suppressed in the
      molecule prior to generating the 2D coordinates.
      Only hydrogens that are necessary to faithfully represent tetrahedral
      stereochemistry will be kept.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEDepictionFrom3DOptions::GetSuppressHydrogens` method



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEEyelashArcFxn, EyelashArcFxn

.. _OEGrapheme_OEEyelashArcFxn:

.. oe:class:: OEEyelashArcFxn

   .. oe:api::

      class OEEyelashArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OEEyelashArcFxn <OEGrapheme_OEEyelashArcFxn>`.
   See example in :ref:`Example of drawing molecule surface using OEEyelashArcFxn<figure_OEEyelashArcFxn>`.

   .. _figure_OEEyelashArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OEEyelashArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OEEyelashArcFxn**  

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawEyelashSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEyelashArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OEEyelashArcFxn(pen: OEPen = OEBlackPen) -> OEEyelashArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Eyelash` style.

      See example in :ref:`Example of drawing molecule surface using OEEyelashArcFxn<figure_OEEyelashArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEEyelashArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEEyelashArcFxn <OEGrapheme_OEEyelashArcFxn>`
      object is dynamically allocated and owned by the caller.



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEFlowerArcFxn, FlowerArcFxn

.. _OEGrapheme_OEFlowerArcFxn:

.. oe:class:: OEFlowerArcFxn

   .. oe:api::

      class OEFlowerArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OEFlowerArcFxn <OEGrapheme_OEFlowerArcFxn>`.
   See example in :ref:`Example of drawing molecule surface using OEFlowerArcFxn<figure_OEFlowerArcFxn>`.

   .. _figure_OEFlowerArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OEFlowerArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OEFlowerArcFxn**  

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawFlowerSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFlowerArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OEFlowerArcFxn(pen: OEPen = OEBlackPen) -> OEFlowerArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Flower` style.

      See example in :ref:`Example of drawing molecule surface using OEFlowerArcFxn<figure_OEFlowerArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEFlowerArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEFlowerArcFxn <OEGrapheme_OEFlowerArcFxn>`
      object is dynamically allocated and owned by the caller.


.. _OEGraphemeClasses:

********************************
OEGrapheme Classes
********************************

.. oe:namespace:: OEGrapheme

.. toctree::

   OE2DActiveSiteDisplay
   OE2DActiveSiteDisplayOptions
   OE2DActiveSiteLegendDisplayOptions
   OE2DPropMap
   OEAlignedDepictionFrom3DOptions
   OEAtomGlyphBase
   OEAtomGlyphCircle
   OEBondGlyphArrow
   OEBondGlyphBase
   OEBondGlyphCircle
   OEBondGlyphCross
   OEBondGlyphCurvedArrow
   OEBondGlyphScissors
   OEBondGlyphStitch
   OEBondGlyphZigZag
   OEColorGradientDisplayOptions
   OEColorGradientLabel
   OEColorForceFieldDisplay
   OEColorForceFieldLegendDisplayOptions
   OEColorOverlapDisplayOptions
   OEDepictionFrom3DOptions
   OENearestResidue
   OEPeptideDisplayOptions
   OEPlotMarker
   OERamachandranPlot
   OEResidueSVGMarkupBase
   OEResidueSVGNoMarkup
   OEResidueSVGStandardMarkup
   OEShapeOverlapDisplay
   OEShapeOverlapDisplayOptions
   OEShapeQueryDisplay
   OEShapeQueryDisplayOptions
   OESurfaceArc


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OENearestResidue, NearestResidue

.. _OEGrapheme_OENearestResidue:

.. oe:class:: OENearestResidue

   .. oe:api::

      class OENearestResidue

   The :ref:`OENearestResidue <OEGrapheme_OENearestResidue>` class that is used by
   :oe:func:`OEGrapheme::OEGetNearestResidue` and
   :oe:func:`OEGrapheme::OEGetNearbyResidue` functions.
   It stores an atom pointer, an associated distance and the
   display position of the atom.

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENearestResidue(const OEChem::OEResidue& residue, double dist,
                             const OEDepict::OE2DPoint& pos)

      .. oe:language:: python

         .. oe:api:: python

            OENearestResidue(residue: OEResidue, dist: float, pos: OE2DPoint) -> OENearestResidue

      Constructor.

   .. ################################################################
      # GetDisplayPosition
      ################################################################

   .. oe:method:: GetDisplayPosition

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEDepict::OE2DPoint& GetDisplayPosition() const

      .. oe:language:: python

         .. oe:api:: python

            GetDisplayPosition() -> OE2DPoint

      Returns the display position of the nearest residue.

   .. ################################################################
      # GetDisplayPosition
      ################################################################

   .. oe:method:: GetDist

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDist() const

      .. oe:language:: python

         .. oe:api:: python

            GetDist() -> float

      Returns the distance associated with the residue.

   .. ################################################################
      # GetResidue
      ################################################################

   .. oe:method:: GetResidue

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEResidue& GetResidue() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidue() -> OEResidue

      Returns the residue stored in the
      :ref:`OENearestResidue <OEGrapheme_OENearestResidue>` object.

   .. ################################################################
      # IsValid
      ################################################################

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OENearestResidue <OEGrapheme_OENearestResidue>` object is
      initialized correctly.


****************************************************
OEGrapheme Basic Arc Drawing Classes
****************************************************

.. oe:namespace:: OEGrapheme

.. toctree::

   OEAlphaRainbowArcFxn
   OEBrickRoadArcFxn
   OECastleArcFxn
   OECogArcFxn
   OEComplexSurfaceArcFxnBase
   OEDefaultArcFxn
   OEDefaultBuriedArcFxn
   OEDefaultCavityArcFxn
   OEDefaultSolventArcFxn
   OEDefaultVoidArcFxn
   OEEyelashArcFxn
   OEFlowerArcFxn
   OENecklaceArcFxn
   OENullArcFxn
   OEOliveBranchArcFxn
   OEPearlsArcFxn
   OERaceTrackArcFxn
   OERailroadTrackArcFxn
   OESawArcFxn
   OESimpsonArcFxn
   OEStitchArcFxn
   OESunArcFxn
   OESurfaceArcFxnBase
   OEWreathArcFxn


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OENecklaceArcFxn, NecklaceArcFxn

.. _OEGrapheme_OENecklaceArcFxn:

.. oe:class:: OENecklaceArcFxn

   .. oe:api::

      class OENecklaceArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OENecklaceArcFxn <OEGrapheme_OENecklaceArcFxn>`.
   See example in :ref:`Example of drawing molecule surface using OENecklaceArcFxn<figure_OENecklaceArcFxn>`.

   .. _figure_OENecklaceArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OENecklaceArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OENecklaceArcFxn**  

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawNecklaceSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENecklaceArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OENecklaceArcFxn(pen: OEPen = OEBlackPen) -> OENecklaceArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Necklace` style.

      See example in :ref:`Example of drawing molecule surface using OENecklaceArcFxn<figure_OENecklaceArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OENecklaceArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OENecklaceArcFxn <OEGrapheme_OENecklaceArcFxn>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OENullArcFxn, NullArcFxn

.. _OEGrapheme_OENullArcFxn:

.. oe:class:: OENullArcFxn

   .. oe:api::

      class OENullArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OENullArcFxn <OEGrapheme_OENullArcFxn>`.

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase &, const OESurfaceArc &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: OEImageBase, arg3: OESurfaceArc) -> bool

      No-op *i.e.* no surface arc is drawn.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OENullArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OENullArcFxn <OEGrapheme_OENullArcFxn>`
      object is dynamically allocated and owned by the caller.




********************************
Preliminary OEGrapheme Classes
********************************

.. oe:namespace:: OEGrapheme

.. toctree::

   OEHighlightMonomerDisplayOptions
   OELigandAlignerBase
   OEMonomerColorBase
   OEMonomerColorDefault
   OEMonomerColorMonochrome
   OEMonomerGlyphStyleBase
   OEMonomerGlyphStyleDefault
   OEMonomerGraphDisplayOptions
   OENoOpLigandAligner


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. oe:class:: OEHighlightMonomerDisplayOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHighlightMonomerDisplayOptions : public OEDepict::OE2DMolDisplayOptions

   The :oe:cls:`OEGrapheme::OEHighlightMonomerDisplayOptions` class
   is used to customize molecule depiction when using  :oe:cls:`OEGrapheme::OEHighlightMonomers` function.

   .. figure:: graphemetk/images/HighlightMonomers.*
      :width: 450pt
      :align:  center

      **Example of using OEHighlightMonomers function**

   The following methods are publicly inherited from :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`:

   ====================================================================================================== ====================================================================================================== ======================================================================================================
   :oe:meth:`operator=<OEDepict::OE2DMolDisplayOptions::operator=>`                                       :oe:meth:`GetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::GetHydrogenStyle>`                         :oe:meth:`SetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineAtomLabelGapScale>`
   :oe:meth:`GetAromaticStyle<OEDepict::OE2DMolDisplayOptions::GetAromaticStyle>`                         :oe:meth:`GetMargin<OEDepict::OE2DMolDisplayOptions::GetMargin>`                                       :oe:meth:`SetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineGapScale>`
   :oe:meth:`GetAtomColor<OEDepict::OE2DMolDisplayOptions::GetAtomColor>`                                 :oe:meth:`GetScale<OEDepict::OE2DMolDisplayOptions::GetScale>`                                         :oe:meth:`SetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont>`
   :oe:meth:`GetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle>`                       :oe:meth:`GetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetSuperAtomLabelFont>`               :oe:meth:`SetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale>`
   :oe:meth:`GetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFont>`                         :oe:meth:`GetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle>`                       :oe:meth:`SetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor>`
   :oe:meth:`GetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFontScale>`               :oe:meth:`GetTitleFont<OEDepict::OE2DMolDisplayOptions::GetTitleFont>`                                 :oe:meth:`SetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle>`
   :oe:meth:`GetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFont>`                 :oe:meth:`GetTitleFontScale<OEDepict::OE2DMolDisplayOptions::GetTitleFontScale>`                       :oe:meth:`SetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::SetBondWidthScaling>`
   :oe:meth:`GetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFontScale>`       :oe:meth:`GetTitleHeight<OEDepict::OE2DMolDisplayOptions::GetTitleHeight>`                             :oe:meth:`SetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen>`
   :oe:meth:`GetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetAtomPropertyFunctor>`             :oe:meth:`GetTitleLocation<OEDepict::OE2DMolDisplayOptions::GetTitleLocation>`                         :oe:meth:`SetDimensions<OEDepict::OE2DMolDisplayOptions::SetDimensions>`
   :oe:meth:`GetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::GetAtomStereoStyle>`                     :oe:meth:`GetWidth<OEDepict::OE2DMolDisplayOptions::GetWidth>`                                         :oe:meth:`SetHeight<OEDepict::OE2DMolDisplayOptions::SetHeight>`
   :oe:meth:`GetBackgroundColor<OEDepict::OE2DMolDisplayOptions::GetBackgroundColor>`                     :oe:meth:`SetAromaticStyle<OEDepict::OE2DMolDisplayOptions::SetAromaticStyle>`                         :oe:meth:`SetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle>`
   :oe:meth:`GetBondColorStyle<OEDepict::OE2DMolDisplayOptions::GetBondColorStyle>`                       :oe:meth:`SetAtomColor<OEDepict::OE2DMolDisplayOptions::SetAtomColor>`                                 :oe:meth:`SetMargin<OEDepict::OE2DMolDisplayOptions::SetMargin>`
   :oe:meth:`GetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineAtomLabelGapScale>` :oe:meth:`SetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle>`                       :oe:meth:`SetMargins<OEDepict::OE2DMolDisplayOptions::SetMargins>`
   :oe:meth:`GetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineGapScale>`                   :oe:meth:`SetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFont>`                         :oe:meth:`SetScale<OEDepict::OE2DMolDisplayOptions::SetScale>`
   :oe:meth:`GetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFont>`                 :oe:meth:`SetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale>`               :oe:meth:`SetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetSuperAtomLabelFont>`
   :oe:meth:`GetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFontScale>`       :oe:meth:`SetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont>`                 :oe:meth:`SetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle>`
   :oe:meth:`GetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetBondPropertyFunctor>`             :oe:meth:`SetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale>`       :oe:meth:`SetTitleFont<OEDepict::OE2DMolDisplayOptions::SetTitleFont>`
   :oe:meth:`GetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::GetBondStereoStyle>`                     :oe:meth:`SetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor>`             :oe:meth:`SetTitleFontScale<OEDepict::OE2DMolDisplayOptions::SetTitleFontScale>`
   :oe:meth:`GetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::GetBondWidthScaling>`                   :oe:meth:`SetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle>`                     :oe:meth:`SetTitleHeight<OEDepict::OE2DMolDisplayOptions::SetTitleHeight>`
   :oe:meth:`GetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::GetDefaultBondPen>`                       :oe:meth:`SetBackgroundColor<OEDepict::OE2DMolDisplayOptions::SetBackgroundColor>`                     :oe:meth:`SetTitleLocation<OEDepict::OE2DMolDisplayOptions::SetTitleLocation>`
   :oe:meth:`GetHeight<OEDepict::OE2DMolDisplayOptions::GetHeight>`                                       :oe:meth:`SetBondColorStyle<OEDepict::OE2DMolDisplayOptions::SetBondColorStyle>`                       :oe:meth:`SetWidth<OEDepict::OE2DMolDisplayOptions::SetWidth>`
   ====================================================================================================== ====================================================================================================== ======================================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightMonomerDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightMonomerDisplayOptions() -> OEHighlightMonomerDisplayOptions

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightMonomerDisplayOptions(double width, double height,
                                             double scale)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightMonomerDisplayOptions(width: float, height: float,
                                             scale: float) -> OEHighlightMonomerDisplayOptions

      Constructor that sets the image dimensions and scale.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighlightMonomerDisplayOptions(const OEHighlightMonomerDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightMonomerDisplayOptions(rhs: OEHighlightMonomerDisplayOptions) -> OEHighlightMonomerDisplayOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHighlightMonomerDisplayOptions &operator=(const OEHighlightMonomerDisplayOptions &rhs)

      Assignment operator.

   .. oe:method:: GetMonomerHighlightColorFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMonomerColorBase& GetMonomerHighlightColorFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerHighlightColorFunctor() -> OEMonomerColorBase

      Returns the functor that is used to determine the color used
      to highlight the monomers. 
      By default, the :oe:cls:`OEGrapheme::OEMonomerColorDefault` functor is used.

   .. oe:method:: GetMonomerLabelColorFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMonomerColorBase& GetMonomerLabelColorFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerLabelColorFunctor() -> OEMonomerColorBase

      Returns the functor that is used to determine the color of the font
      use to draw the monomer code.

      By default, the :oe:cls:`OEGrapheme::OEMonomerColorMonochrome` functor is used
      to set all monomer code fonts to black.

   .. oe:method:: SetMonomerHighlightColorFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMonomerHighlightColorFunctor(const OEMonomerColorBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetMonomerHighlightColorFunctor(func: OEMonomerColorBase) -> None

      Sets the functor that is used to determine the color used
      to highlight the monomers.

   .. oe:method:: SetMonomerLabelColorFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMonomerLabelColorFunctor(const OEMonomerColorBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetMonomerLabelColorFunctor(func: OEMonomerColorBase) -> None

      Sets the functor that is used to determine the color of the font
      used to draw the monomer code.

   .. oe:method:: GetHighlightUnspecifiedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetHighlightUnspecifiedStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetHighlightUnspecifiedStereo() -> bool

      Returns whether monomers with unspecified stereo are highlighted.

   .. oe:method:: SetHighlightUnspecifiedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHighlightUnspecifiedStereo(bool highlight)

      .. oe:language:: python

         .. oe:api:: python

            SetHighlightUnspecifiedStereo(highlight: bool) -> None

      Sets whether monomers with unspecified stereo are highlighted.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. oe:class::  OELigandAlignerBase

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      OESystem::OEUnaryFunction<OEChem::OEMolBase, bool, false, true>  OELigandAlignerBase;

   :oe:cls:`OEGrapheme::OELigandAlignerBase` is an abstract class. Functors deriving from this
   class can be used to perform custom ligand alignment when generating images of ligand-protein
   interactions.

   The following classes derive from this abstract class:
   
   * :oe:cls:`OEGrapheme::OENoOpLigandAligner` class

   .. seealso::

      * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetLigandAlignerFunctor` method

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEChem::OEMolBase&) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg0: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This is a virtual const method that must be implemented in the concrete
      derived classes.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELigandAlignerBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OELigandAlignerBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. oe:class:: OEMonomerColorBase

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      OESystem::OEUnaryFunction<OEChem::OEMonomerData, OESystem::OEColor, true, true>  OEMonomerColorBase

   :oe:cls:`OEGrapheme::OEMonomerColorBase` is an abstract class that
   defines the API used to assign colors to monomers. 

   The following classes derive from this abstract class:
   
   * :oe:cls:`OEGrapheme::OEMonomerColorDefault` class
   * :oe:cls:`OEGrapheme::OEMonomerColorMonochrome` class

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEColor operator()(const OEChem::OEMonomerData&) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg0: OEMonomerData) -> OEColor

      This is a virtual const method that must be implemented in the concrete
      derived classes.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMonomerColorBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. oe:class:: OEMonomerColorDefault

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMonomerColorDefault : public OEMonomerColorBase

   The :oe:cls:`OEGrapheme::OEMonomerColorDefault` class is used 
   to assign colors to monomers for depiction.

   The following methods are publicly inherited from :oe:cls:`OEGrapheme::OEMonomerColorBase`:

   ================================================================== ======================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEMonomerColorBase::CreateCopy>`  :oe:meth:`operator()<OEGrapheme::OEMonomerColorBase::operator()>`
   ================================================================== ======================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomerColorDefault()

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerColorDefault() -> OEMonomerColorDefault

      Default constructor.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEColor operator()(const OEChem::OEMonomerData &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: OEMonomerData) -> OEColor

      Returns the color assigned to a specific monomer (:oe:cls:`OEChem::OEMonomerData`). 
      Standard amino acids are colored by their properties (containing sulphur, aliphatic, aromatic, acidic,  basic, hydroxylic, amidic).
      :oe:const:`OEBlack<OESystem::OESystem::OEBlack>` is returned for all other monomers.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMonomerColorBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :oe:cls:`OEGrapheme::OEMonomerColorDefault`
      object is dynamically allocated and owned by the caller.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. oe:class:: OEMonomerColorMonochrome

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::
      
      class OEMonomerColorMonochrome : public OEMonomerColorBase

   The :oe:cls:`OEGrapheme::OEMonomerColorMonochrome` class is used 
   to assign the same color to every monomer.

   The following methods are publicly inherited from :oe:cls:`OEGrapheme::OEMonomerColorBase`:

   ================================================================== ======================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEMonomerColorBase::CreateCopy>`  :oe:meth:`operator()<OEGrapheme::OEMonomerColorBase::operator()>`
   ================================================================== ======================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomerColorMonochrome()

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerColorMonochrome() -> OEMonomerColorMonochrome

      Default constructor that sets the color to :oe:const:`OEBlack<OESystem::OESystem::OEBlack>`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomerColorMonochrome(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerColorMonochrome(color: OEColor) -> OEMonomerColorMonochrome

      Constructor with the given color (:oe:cls:`OESystem::OEColor`).

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEColor operator()(const OEChem::OEMonomerData &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: OEMonomerData) -> OEColor

      Returns the color that the functor was initialized with for each monomer input.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMonomerColorBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :oe:cls:`OEGrapheme::OEMonomerColorMonochrome`
      object is dynamically allocated and owned by the caller.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. oe:class:: OEMonomerGlyphStyleBase

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      OESystem::OEUnaryFunction<OEChem::OEMonomerData, unsigned, true, true>  OEMonomerGlyphStyleBase;

   :oe:cls:`OEGrapheme::OEMonomerGlyphStyleBase` is an abstract class that
   assigns values from the :oe:constns:`OEGrapheme::OECircleStyle` namespace to monomers for depiction.

   The following classes derive from this abstract class:
   
   * :oe:cls:`OEGrapheme::OEMonomerGlyphStyleDefault` class

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned operator()(const OEChem::OEMonomerData&) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg0: OEMonomerData) -> int

      This is a virtual const method that must be implemented in the concrete
      derived classes.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMonomerGlyphStyleBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. oe:class:: OEMonomerGlyphStyleDefault

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMonomerGlyphStyleDefault: public OEMonomerGlyphStyleBase

   The :oe:cls:`OEGrapheme::OEMonomerGlyphStyleDefault` class is used 
   to assign values from the :oe:constns:`OEGrapheme::OECircleStyle` namespace to each monomers for depiction.

   The following methods are publicly inherited from :oe:cls:`OEGrapheme::OEMonomerGlyphStyleBase`:

   ======================================================================== =======================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEMonomerGlyphStyleBase::CreateCopy>`   :oe:meth:`operator()<OEGrapheme::OEMonomerGlyphStyleBase::operator()>`
   ======================================================================== =======================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomerGlyphStyleDefault()

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerGlyphStyleDefault() -> OEMonomerGlyphStyleDefault

      Default constructor.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned operator()(const OEChem::OEMonomerData &) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: OEMonomerData) -> int

      Returns :oe:const:`OEGrapheme::OECircleStyle::Default` if the monomer is a standard amino acid, and 
      :oe:const:`OEGrapheme::OECircleStyle::Simpson` otherwise.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMonomerGlyphStyleBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :oe:cls:`OEGrapheme::OEMonomerGlyphStyleDefault`
      object is dynamically allocated and owned by the caller.

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. oe:class:: OEMonomerGraphDisplayOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMonomerGraphDisplayOptions

   The :oe:cls:`OEGrapheme::OEMonomerGraphDisplayOptions` class
   is used to customize molecule depiction when using  :oe:cls:`OEGrapheme::OEDrawMonomerGraph` function.
   
   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover cursor over graph</b>
         </p>

         <p align="center">
         <object data="../../_images/DrawMonomerGraph.svg" type="image/svg+xml"  width = "500" ></object>
         <p>

         <p align="center">
         <b>Example of using the OEDrawMonomerGraph function</b>
         <p>

      .. image:: /_images/DrawMonomerGraph.svg
         :width: 1pt

   .. only:: oepdf

      .. figure:: graphemetk/images/DrawMonomerGraph.*
         :align:  center

         **Example of using the OEDrawMonomerGraph function**

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomerGraphDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerGraphDisplayOptions() -> OEMonomerGraphDisplayOptions

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomerGraphDisplayOptions(const OEMonomerGraphDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerGraphDisplayOptions(rhs: OEMonomerGraphDisplayOptions) -> OEMonomerGraphDisplayOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMonomerGraphDisplayOptions &operator=(const OEMonomerGraphDisplayOptions &rhs)

      Assignment operator.

   .. oe:method:: GetInteractiveEffect

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetInteractiveEffect() const

      .. oe:language:: python

         .. oe:api:: python

            GetInteractiveEffect() -> int

      Returns the interactive effect of the generated :file:`svg` image.

   .. oe:method:: GetMonomerColorFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMonomerColorBase& GetMonomerColorFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerColorFunctor() -> OEMonomerColorBase

      Returns the functor that is used to determine the color used to draw the glyph representing the monomer.
      By default, the :oe:cls:`OEGrapheme::OEMonomerColorDefault` functor is used.

   .. oe:method:: GetMonomerScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMonomerScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerScale() -> float

      Returns the scaling factor of monomer components in interactive mode.

   .. oe:method:: GetMonomerGlyphStyleFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMonomerGlyphStyleBase& GetMonomerGlyphStyleFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerGlyphStyleFunctor() -> OEMonomerGlyphStyleBase

      Returns the functor that is used to determine the circle style used to draw the glyph representing the monomer.
      By default, the :oe:cls:`OEGrapheme::OEMonomerGlyphStyleDefault` functor is used.

   .. oe:method:: GetMonomerLabelColorFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMonomerColorBase& GetMonomerLabelColorFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerLabelColorFunctor() -> OEMonomerColorBase

      Returns the functor that is used to determine the color of the font used to depict the monomer code.
      By default, the :oe:cls:`OEGrapheme::OEMonomerColorMonochrome` functor is used
      to set all monomer code fonts to black.

   .. oe:method:: SetInteractiveEffect

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetInteractiveEffect(const unsigned effect)

      .. oe:language:: python

         .. oe:api:: python

            SetInteractiveEffect(effect: int) -> None

      Sets the interactive effect of the generated :file:`svg` image.
      In interactive mode, the structures of the monomers that make up the molecule 
      are shown on mouse-over or mouse-click.

      .. seealso::

         * :oe:constns:`OEDepict::OEInteractiveEffect` namespace for available interactive effects.

   .. oe:method:: SetMonomerColorFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMonomerColorFunctor(const OEMonomerColorBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetMonomerColorFunctor(func: OEMonomerColorBase) -> None

      Sets the functor that is used to determine the color used to draw the glyph representing the monomer.

   .. oe:method:: SetMonomerScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMonomerScale(const double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetMonomerScale(scale: float) -> None

      Sets the scaling factor of monomer components in interactive mode.

      scale
         This value has to be in a range of [0.25, 0.75]. The default value is 0.50.

      .. note::

         This option has to be used along with the
         :oe:meth:`OEGrapheme::OEMonomerGraphDisplayOptions::SetInteractiveEffect` method

   .. oe:method:: SetMonomerGlyphStyleFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMonomerGlyphStyleFunctor(const OEMonomerGlyphStyleBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetMonomerGlyphStyleFunctor(func: OEMonomerGlyphStyleBase) -> None

      Sets the functor that is used to determine the circle style used to draw the glyph representing the monomer.

   .. oe:method:: SetMonomerLabelColorFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMonomerLabelColorFunctor(const OEMonomerColorBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetMonomerLabelColorFunctor(func: OEMonomerColorBase) -> None

      Sets the functor that is used to determine the color of the font used to depict the monomer code.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. oe:class:: OENoOpLigandAligner

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OENoOpLigandAligner : public OELigandAlignerBase

   The :oe:cls:`OEGrapheme::OENoOpLigandAligner` class is the default no-op 
   ligand aligner.
   This means that the 2D coordinates of the ligand are only determined by the 3D coordinates 
   of the bound ligand.

   The following methods are publicly inherited from :oe:cls:`OEGrapheme::OELigandAlignerBase`:

   ================================================================== ======================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OELigandAlignerBase::CreateCopy>`  :oe:meth:`operator()<OEGrapheme::OELigandAlignerBase::operator()>`
   ================================================================== ======================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENoOpLigandAligner()

      .. oe:language:: python

         .. oe:api:: python

            OENoOpLigandAligner() -> OENoOpLigandAligner

      Default constructor.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEChem::OEMolBase& ligand) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      No-op implementation always returns true.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OELigandAlignerBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :oe:cls:`OEGrapheme::OENoOpLigandAligner`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEOliveBranchArcFxn, OliveBranchArcFxn

.. _OEGrapheme_OEOliveBranchArcFxn:

.. oe:class:: OEOliveBranchArcFxn

   .. oe:api::

      class OEOliveBranchArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OEOliveBranchArcFxn <OEGrapheme_OEOliveBranchArcFxn>`.
   See example in :ref:`Example of drawing molecule surface using OEOliveBranchArcFxn<figure_OEOliveBranchArcFxn>`.

   .. _figure_OEOliveBranchArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OEOliveBranchArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OEOliveBranchArcFxn**

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawOliveBranchSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOliveBranchArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OEOliveBranchArcFxn(pen: OEPen = OEBlackPen) -> OEOliveBranchArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::OliveBranch` style.

      See example in :ref:`Example of drawing molecule surface using OEOliveBranchArcFxn<figure_OEOliveBranchArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEOliveBranchArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEOliveBranchArcFxn <OEGrapheme_OEOliveBranchArcFxn>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEPearlsArcFxn, PearlsArcFxn

.. _OEGrapheme_OEPearlsArcFxn:

.. oe:class:: OEPearlsArcFxn

   .. oe:api::

      class OEPearlsArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OEPearlsArcFxn <OEGrapheme_OEPearlsArcFxn>`.
   See example in :ref:`Example of drawing molecule surface using OEPearlsArcFxn<figure_OEPearlsArcFxn>`.

   .. _figure_OEPearlsArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OEPearlsArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OEPearlsArcFxn**

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawPearlsSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPearlsArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OEPearlsArcFxn(pen: OEPen = OEBlackPen) -> OEPearlsArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Pearls` style.

      See example in :ref:`Example of drawing molecule surface using OEPearlsArcFxn<figure_OEPearlsArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEPearlsArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEPearlsArcFxn <OEGrapheme_OEPearlsArcFxn>`
      object is dynamically allocated and owned by the caller.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. _OEGrapheme_OEPeptideDisplayOptions:

.. oe:class:: OEPeptideDisplayOptions

   .. oe:api::

      class OEPeptideDisplayOptions

   This class represents the :ref:`OEPeptideDisplayOptions <OEGrapheme_OEPeptideDisplayOptions>` class
   that encapsulates properties that determine how a peptide is depicted.

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawPeptide` function

   .. admonition:: Code Example

      * `Depict Peptide`_ **OpenEye Python Cookbook** recipe

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPeptideDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEPeptideDisplayOptions() -> OEPeptideDisplayOptions

      Default constructor.

      .. _figure_ OEPeptideDisplayOptions_Default:

      .. only:: oehtml

         .. figure:: /_images/OEPeptideDisplayOptions_Default.svg
            :align:  center
            :width:  600pt

            **Peptide depiction with default options**

      .. only:: oepdf

         .. figure:: graphemetk/images/OEPeptideDisplayOptions_Default.*
            :align:  center
            :width:  600pt

            **Peptide depiction with default options**

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPeptideDisplayOptions(const OEPeptideDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEPeptideDisplayOptions(style: int) -> OEPeptideDisplayOptions
            OEPeptideDisplayOptions(arg2: OEPeptideDisplayOptions) -> OEPeptideDisplayOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPeptideDisplayOptions &operator=(const OEPeptideDisplayOptions &rhs)

      Assignment operator.

   .. oe:method:: GetAminoAcidScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetAminoAcidScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetAminoAcidScale() -> float

      Returns the scaling factor of amino-acid components in interactive mode.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEPeptideDisplayOptions::SetAminoAcidScale` method

   .. oe:method:: GetInteractive

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetInteractive() const

      .. oe:language:: python

         .. oe:api:: python

            GetInteractive() -> bool

      Returns whether the generated :file:`svg` image will be interactive.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEPeptideDisplayOptions::SetInteractive` method

   .. oe:method:: GetLabelStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetLabelStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetLabelStyle() -> int

      .. warning::

         |DEPRECATED-API|

   .. oe:method:: SetAminoAcidScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAminoAcidScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetAminoAcidScale(scale: float) -> None

      Sets the scaling factor of amino-acid components in interactive mode.

      scale
         This value has to be in a range of [0.25, 0.75]. The default value is 0.50.

      .. note::

         This option has to be used along with the
         :oe:meth:`OEGrapheme::OEPeptideDisplayOptions::SetInteractive` method

      **Example:**

      .. oe:source:: OEPeptideDispOpts_SetOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEPEPTIDEDISPLAYOPTIONS-SETAMINOACIDSCALE

      .. oe:source:: OEPeptideDispOpts_SetOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEPEPTIDEDISPLAYOPTIONS-SETAMINOACIDSCALE

      .. oe:source:: OEPeptideDispOpts_SetOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEPEPTIDEDISPLAYOPTIONS-SETAMINOACIDSCALE

      .. oe:source:: OEPeptideDispOpts_SetOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEPEPTIDEDISPLAYOPTIONS-SETAMINOACIDSCALE

      .. _figure_OEPeptideDisplayOptions_SetAminoAcidScale:

      .. only:: oehtml

         .. raw:: html

            <p align="center">
            <object data="../../_images/OEPeptideDisplayOptions_SetAminoAcidScale.svg" type="image/svg+xml"  width = "600" ></object>
            <p>

         .. the below is necessary to copy over the image to the build subdirectory

         .. image:: /_images/OEPeptideDisplayOptions_SetAminoAcidScale.svg
            :width: 1pt

      .. only:: oepdf

         |NOPDFIMAGE|

      .. note::

         This functionality is **only available** for :file:`.svg`
         image format. In other image formats it has no effect.

   .. oe:method:: SetInteractive

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetInteractive(bool interactive)

      .. oe:language:: python

         .. oe:api:: python

            SetInteractive(interactive: bool) -> None

      Sets whether the generated :file:`svg` image will be interactive.
      In interactive mode the amino acid components of the compact peptide representation
      are depicted on mouse over.

      **Example:**

      .. oe:source:: OEPeptideDispOpts_SetOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEPEPTIDEDISPLAYOPTIONS-SETINTERACTIVE

      .. oe:source:: OEPeptideDispOpts_SetOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEPEPTIDEDISPLAYOPTIONS-SETINTERACTIVE

      .. oe:source:: OEPeptideDispOpts_SetOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEPEPTIDEDISPLAYOPTIONS-SETINTERACTIVE

      .. oe:source:: OEPeptideDispOpts_SetOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEPEPTIDEDISPLAYOPTIONS-SETINTERACTIVE

      .. _figure_OEPeptideDisplayOptions_SetInteractive:

      .. only:: oehtml

         .. raw:: html

            <p align="center">
            <object data="../../_images/OEPeptideDisplayOptions_SetInteractive.svg" type="image/svg+xml"  width = "600" ></object>
            <p>

         .. the below is necessary to copy over the image to the build subdirectory

         .. image:: /_images/OEPeptideDisplayOptions_SetInteractive.svg
            :width: 1pt

      .. only:: oepdf

         |NOPDFIMAGE|

      .. note::

         This functionality is **only available** for :file:`.svg`
         image format. In other image formats it has no effect.

   .. oe:method:: SetLabelStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLabelStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetLabelStyle(style: int) -> None

      .. warning::

         |DEPRECATED-API|

      *style*
         This value has to be from the :oe:constns:`OEGrapheme::OEPeptideLabelStyle`
         namespace.

      **Example:**

      .. oe:source:: OEPeptideDispOpts_SetOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEPEPTIDEDISPLAYOPTIONS-SETLABELSTYLE

      .. oe:source:: OEPeptideDispOpts_SetOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEPEPTIDEDISPLAYOPTIONS-SETLABELSTYLE

      .. oe:source:: OEPeptideDispOpts_SetOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEPEPTIDEDISPLAYOPTIONS-SETLABELSTYLE

      .. oe:source:: OEPeptideDispOpts_SetOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEPEPTIDEDISPLAYOPTIONS-SETLABELSTYLE

      .. _figure_OEPeptideDisplayOptions_SetLabelStyle:

      .. only:: oehtml

         .. figure:: /_images/OEPeptideDisplayOptions_SetLabelStyle.svg
            :align:  center
            :width:  600pt

            **Peptide depiction with single letter style**

      .. only:: oepdf

         .. figure:: graphemetk/images/OEPeptideDisplayOptions_SetLabelStyle.*
            :align:  center
            :width:  600pt

            **Peptide depiction with single letter style**

      .. seealso::

         * :oe:constns:`OEGrapheme::OEPeptideLabelStyle` namespace


.. oe:namespace:: OEGrapheme

.. _OEGrapheme_OEPlotMarker:

.. oe:class:: OEPlotMarker

   .. oe:api::

      class OEPlotMarker

   This class represents the :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` class
   that encapsulates properties that determine how a plot is depicted.

   .. seealso::

      * :ref:`OERamachandranPlot <OEGrapheme_OERamachandranPlot>` class

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPlotMarker(const OEDepict::OEPen& pen,
                         unsigned int style = OEPlotMarkerStyle::Circle,
                         double scale = 1.0)

      .. oe:language:: python

         .. oe:api:: python

            OEPlotMarker(pen: OEPen, style: int, scale: float = 1.0) -> OEPlotMarker

      Creates and initializes an :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` object
      with the given parameters.

      *pen*
         The :ref:`OEPen <OEDepict_OEPen>` object that is used to draw the plot marker.

      *style*
         The property that determine the style of the plot marker.
         This value has to be from the :oe:constns:`OEGrapheme::OEPlotMarkerStyle`
         namespace.

      *scale*
        The multiplier that can be used to increase or to decrease the
        size of the plot market.
        This value has to be in the range of ``[0.25, 4.0]``.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPlotMarker(const OEPlotMarker& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEPlotMarker(arg2: OEPlotMarker) -> OEPlotMarker

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPlotMarker &operator=(const OEPlotMarker &rhs)

      Assignment operator.

   .. ################################################################
      #
      ####################################x############################

   .. oe:method:: operator!=
      :language: c++

      .. oe:api::

         bool operator!=(const OEPlotMarker &) const

      Determines whether two :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` objects are
      different.
      Two :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` objects are considered different,
      if any of their properties (such as pen, style or scale) are different.

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEPlotMarker &) const

      Determines whether two :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` objects are
      equal.
      Two :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` objects are considered equivalent
      only if all of their properties (such as pen, style or scale) are identical.

   .. oe:method:: GetPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEDepict::OEPen& GetPen() const

      .. oe:language:: python

         .. oe:api:: python

            GetPen() -> OEPen

      Returns the pen of the plot marker.

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class

   .. oe:method:: GetScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetScale() -> float

      Returns the multiplier that is used to increase or to decrease size
      of the plot marker.

   .. oe:method:: GetStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetStyle() -> int

      Returns the style of the plot marker.
      The return value is taken from the :oe:constns:`OEGrapheme::OEPlotMarkerStyle`
      namespace.

      .. seealso::

         * :oe:constns:`OEGrapheme::OEPlotMarkerStyle` namespace


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OERaceTrackArcFxn, RaceTrackArcFxn

.. _OEGrapheme_OERaceTrackArcFxn:

.. oe:class:: OERaceTrackArcFxn

   .. oe:api::

      class OERaceTrackArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OERaceTrackArcFxn <OEGrapheme_OERaceTrackArcFxn>`.
   See example in :ref:`Example of drawing molecule surface using OERaceTrackArcFxn<figure_OERaceTrackArcFxn>`.

   .. _figure_OERaceTrackArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OERaceTrackArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OERaceTrackArcFxn**  

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawRaceTrackSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERaceTrackArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OERaceTrackArcFxn(pen: OEPen = OEBlackPen) -> OERaceTrackArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::RaceTrack` style.

      See example in :ref:`Example of drawing molecule surface using OERaceTrackArcFxn<figure_OERaceTrackArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OERaceTrackArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OERaceTrackArcFxn <OEGrapheme_OERaceTrackArcFxn>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OERailroadTrackArcFxn, RailroadTrackArcFxn

.. _OEGrapheme_OERailroadTrackArcFxn:

.. oe:class:: OERailroadTrackArcFxn

   .. oe:api::

      class OERailroadTrackArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OERailroadTrackArcFxn <OEGrapheme_OERailroadTrackArcFxn>`.
   See example in :ref:`Example of drawing molecule surface using OERailroadTrackArcFxn<figure_OERailroadTrackArcFxn>`.

   .. _figure_OERailroadTrackArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OERailroadTrackArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OERailroadTrackArcFxn**  

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawRailroadTrackSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERailroadTrackArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OERailroadTrackArcFxn(pen: OEPen = OEBlackPen) -> OERailroadTrackArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::RailroadTrack` style.

      See example in :ref:`Example of drawing molecule surface using OERailroadTrackArcFxn<figure_OERailroadTrackArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OERailroadTrackArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OERailroadTrackArcFxn <OEGrapheme_OERailroadTrackArcFxn>`
      object is dynamically allocated and owned by the caller.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. _OEGrapheme_OERamachandranPlot:

.. oe:class:: OERamachandranPlot

   .. oe:api::

      class OERamachandranPlot

   This class represents :ref:`OERamachandranPlot <OEGrapheme_OERamachandranPlot>` that stores
   data of a Ramachandran plot.

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <object data="../../_images/RenderRamachandranPlot.svg" type="image/svg+xml"  width = "400" ></object>
         <p>

         <p align="center">
         <b>Example of OERamachandranPlot depiction</b>
         <p>

      .. image:: /_images/RenderRamachandranPlot.svg
         :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. seealso::

      * :oe:func:`OEGrapheme::OERenderRamachandranPlot` function
      * :ref:`OERamachandranAnalysis <OEBio_OERamachandranAnalysis>` class in **OEChem TK** manual

   .. admonition:: Code Example

      * `Ramachandran Plot`_ **OpenEye Python Cookbook** recipe

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERamachandranPlot()

      .. oe:language:: python

         .. oe:api:: python

            OERamachandranPlot() -> OERamachandranPlot

      Default constructor that creates an empty :ref:`OERamachandranPlot <OEGrapheme_OERamachandranPlot>` object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERamachandranPlot(const OERamachandranPlot& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OERamachandranPlot(rhs: OERamachandranPlot) -> OERamachandranPlot

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERamachandranPlot &operator=(const OERamachandranPlot &rhs)

      Assignment operator.

   .. oe:method:: AddMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddMolecule(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            AddMolecule(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Adds the molecule to the plot with default style.

      *mol*
         The macro-peptide of which backbone dihedral phi (:math:`\phi`) and
         psi (:math:`\psi`) angle pairs are added to the plot.
         The residues of the molecule have to be perceived beforehand.

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddMolecule(const OEChem::OEMolBase& mol,
                             const OEPlotMarker& outmarker,
                             const OEPlotMarker& inmarker)

      .. oe:language:: python

         .. oe:api:: python

            AddMolecule(mol: Union[OEGraphMol,OEMol,OEQMol],
                        outmarker: OEPlotMarker, inmarker: OEPlotMarker) -> bool

      Adds the mol to the plot with the given style.

      *mol*
         The macro-peptide of which backbone dihedral phi (:math:`\phi`) and
         psi (:math:`\psi`) angle pairs are added to the plot.
         The residues of the molecule have to be perceived beforehand.

      *outmarker*
         The style that is used to render data points with
         :oe:const:`OEBio::OERamaCategory::Outlier` category.

      *inmarker*
         The style that is used to render data points with
         :oe:const:`OEBio::OERamaCategory::Favored` or
         :oe:const:`OEBio::OERamaCategory::Allowed` category.

   .. oe:method:: AddRamachandran

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddRamachandran(const OEBio::OERamachandranAnalysis& rama,
                                 const std::string& label,
                                 const OEPlotMarker& marker)

      .. oe:language:: python

         .. oe:api:: python

            AddRamachandran(rama: OERamachandranAnalysis, label: str,
                            marker: OEPlotMarker) -> bool

      Adds the data of the given :ref:`OERamachandranAnalysis <OEBio_OERamachandranAnalysis>` object
      to the plot with the given style and interactive label.

      *rama*
         The :ref:`OERamachandranAnalysis <OEBio_OERamachandranAnalysis>` object

      *label*
         The label that will be displayed in hover mode if the
         (:math:`\phi`, :math:`\psi`) value pair stored in the
         :ref:`OERamachandranAnalysis <OEBio_OERamachandranAnalysis>` object is an
         outlier.

      *marker*
         The style that is used to render the data point on the plot.

      .. seealso::

         * :ref:`OERamachandranAnalysis <OEBio_OERamachandranAnalysis>` class

   .. oe:method:: NumDataPoints

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumDataPoints(unsigned int ramatype,
                                       unsigned int category) const

      .. oe:language:: python

         .. oe:api:: python

            NumDataPoints(ramatype: int, category: int) -> int

      Returns the number of data points stored in the :ref:`OERamachandranPlot <OEGrapheme_OERamachandranPlot>`
      object with the given type and category.

      *ramatype*
         This value has to be from the :oe:constns:`OEBio::OERamaType`
         namespace.

      *category*
         This value has to be from the :oe:constns:`OEBio::OERamaCategory`
         namespace.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. _OEGrapheme_OEResidueSVGMarkupBase:

.. oe:class:: OEResidueSVGMarkupBase

   .. oe:api::

      class OEResidueSVGMarkupBase

   :ref:`OEResidueSVGMarkupBase <OEGrapheme_OEResidueSVGMarkupBase>` is an abstract base class.
   Concrete class derived from this base class defines the markup of
   the residues in :file:`.svg` images generated
   when calling the :ref:`OERenderActiveSite <OEGrapheme_OERenderActiveSite>` function.
   Drawing elements representing residues in :file:`.svg` image are grouped together
   in the following format in which the ``<group id>`` and ``<class name>``
   strings can be defined in the derived concrete classes.

   ::

      <g id='<group id>' class='<class name>'>
      ..
      list of drawing elements
      ..
      </g>

   The following classes derive from this class:

    * :ref:`OEResidueSVGNoMarkup <OEGrapheme_OEResidueSVGNoMarkup>`
    * :ref:`OEResidueSVGStandardMarkup <OEGrapheme_OEResidueSVGStandardMarkup>`

   .. seealso::

      * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetResidueSVGMarkupFunctor` method
      * :ref:`chapter_svg` chapter in **OEDepict TK** manual

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEResidueSVGMarkupBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEResidueSVGMarkupBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetClassName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetClassName(const OEChem::OEResidue &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg0: OEResidue) -> str

      Returns the ``<class name>`` associated with a specific residue group
      in the :file:`.svg` image.
      This is a virtual method that has to be implemented in the concrete
      derived classes.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetGroupId

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetGroupId(const OEChem::OEResidue &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(arg0: OEResidue) -> str

      Returns the ``<group id>`` associated with a specific residue group
      in the :file:`.svg` image.
      This is a virtual method that has to be implemented in the concrete
      derived classes.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. _OEGrapheme_OEResidueSVGNoMarkup:

.. oe:class:: OEResidueSVGNoMarkup

   .. oe:api::

      class OEResidueSVGNoMarkup : public OEResidueSVGMarkupBase

   This class represents :ref:`OEResidueSVGNoMarkup <OEGrapheme_OEResidueSVGNoMarkup>` residue
   SVG markup functor.
   If this functor is passed to the
   :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetResidueSVGMarkupFunctor`
   method, the residues will be not marked in the :file:`svg` image when
   calling the :ref:`OERenderActiveSite <OEGrapheme_OERenderActiveSite>` function.

   .. seealso::

      * :ref:`chapter_svg` chapter in **OEDepict TK** manual
      * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetResidueSVGMarkupFunctor` method
      * :ref:`OEResidueSVGStandardMarkup <OEGrapheme_OEResidueSVGStandardMarkup>` functor

   The following methods are publicly inherited from :ref:`OEResidueSVGMarkupBase <OEGrapheme_OEResidueSVGMarkupBase>`:

   ========================================================================= ========================================================================= =========================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEResidueSVGMarkupBase::CreateCopy>`     :oe:meth:`GetClassName<OEGrapheme::OEResidueSVGMarkupBase::GetClassName>` :oe:meth:`GetGroupId<OEGrapheme::OEResidueSVGMarkupBase::GetGroupId>`
   ========================================================================= ========================================================================= =========================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEResidueSVGNoMarkup()

      .. oe:language:: python

         .. oe:api:: python

            OEResidueSVGNoMarkup() -> OEResidueSVGNoMarkup

      Default constructor.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEResidueSVGMarkupBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEResidueSVGMarkupBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEResidueSVGNoMarkup <OEGrapheme_OEResidueSVGNoMarkup>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetClassName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetClassName(const OEChem::OEResidue& residue) const

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg2: OEResidue) -> str

      Returns an empty string.

   .. oe:method:: GetGroupId

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetGroupId(const OEChem::OEResidue& residue) const

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(arg2: OEResidue) -> str

      Returns an empty string.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. _OEGrapheme_OEResidueSVGStandardMarkup:

.. oe:class:: OEResidueSVGStandardMarkup

   .. oe:api::

      class OEResidueSVGStandardMarkup : public OEResidueSVGMarkupBase

   This class represents :ref:`OEResidueSVGStandardMarkup <OEGrapheme_OEResidueSVGStandardMarkup>` residue
   SVG markup functor.
   If this functor is passed to the
   :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetResidueSVGMarkupFunctor`
   method, the residues will be in :file:`svg` image
   when calling the :ref:`OERenderActiveSite <OEGrapheme_OERenderActiveSite>` function.

   .. seealso::

      * :ref:`chapter_svg` chapter in **OEDepict TK** manual
      * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetResidueSVGMarkupFunctor` method
      * :ref:`OEResidueSVGNoMarkup <OEGrapheme_OEResidueSVGNoMarkup>` functor

   The following methods are publicly inherited from :ref:`OEResidueSVGMarkupBase <OEGrapheme_OEResidueSVGMarkupBase>`:

   ========================================================================= ========================================================================= =========================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEResidueSVGMarkupBase::CreateCopy>`     :oe:meth:`GetClassName<OEGrapheme::OEResidueSVGMarkupBase::GetClassName>` :oe:meth:`GetGroupId<OEGrapheme::OEResidueSVGMarkupBase::GetGroupId>`
   ========================================================================= ========================================================================= =========================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEResidueSVGStandardMarkup(const std::string prefix = "",
                                       const std::string classname = "residue",
                                       const char separator = '-')

      .. oe:language:: python

         .. oe:api:: python

            OEResidueSVGStandardMarkup(prefix: str = "",
                                       classname: str = "residue",
                                       separator: str = '-') -> OEResidueSVGStandardMarkup

      Creates an :ref:`OEResidueSVGStandardMarkup <OEGrapheme_OEResidueSVGStandardMarkup>` object.

      prefix
        The string that will be added at the beginning of each residue
        :oe:cls:`group id <OEDepict::OESVGGroup>`.
        For information about valid ids see
        :oe:func:`OEDepict::OEIsValidSVGGroupId` function.
        By default, no prefix will be added.

      classname
        The :oe:cls:`class name <OEDepict::OESVGClass>` that is going to
        be used to mark residues.
        For information about valid names see
        :oe:func:`OEDepict::OEIsValidSVGClassName` function.

      separator
        The character used to separate the components
        (residue name, chain id, residue number)
        of the :oe:cls:`group id <OEDepict::OESVGGroup>`

      By default, the following will be showed in :file:`svg` image for
      marking a Leucine residue with chain id 'A' and residue number ``715``:

      ::

          <g id='LEU-A-715' class='residue'>
          ..
          list of drawing elements
          ..
          </g>

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEResidueSVGMarkupBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEResidueSVGMarkupBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEResidueSVGNoMarkup <OEGrapheme_OEResidueSVGNoMarkup>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetClassName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetClassName(const OEChem::OEResidue& residue) const

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg2: OEResidue) -> str

      Returns the string that specifies the :oe:cls:`group id <OEDepict::OESVGGroup>`
      of a residue in an :file:`svg` image.

   .. oe:method:: GetGroupId

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetGroupId(const OEChem::OEResidue& residue) const

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(arg2: OEResidue) -> str

      Returns the string that specifies the :oe:cls:`class name <OEDepict::OESVGClass>`
      of a residue in an :file:`svg` image.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OESawArcFxn, SawArcFxn

.. _OEGrapheme_OESawArcFxn:

.. oe:class:: OESawArcFxn

   .. oe:api::

      class OESawArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OESawArcFxn <OEGrapheme_OESawArcFxn>`.
   See example in :ref:`Example of drawing molecule surface using OESawArcFxn<figure_OESawArcFxn>`.

   .. _figure_OESawArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OESawArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OESawArcFxn**

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawSawSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESawArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OESawArcFxn(pen: OEPen = OEBlackPen) -> OESawArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Saw` style.

      See example in :ref:`Example of drawing molecule surface using OESawArcFxn<figure_OESawArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESawArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OESawArcFxn <OEGrapheme_OESawArcFxn>`
      object is dynamically allocated and owned by the caller.




.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. _OEGrapheme_OEShapeOverlapDisplay:

.. oe:class:: OEShapeOverlapDisplay

   .. oe:api::

      class OEShapeOverlapDisplay

   This class represents :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` that
   stores the depiction information of depicting the for molecule of 
   shape overlap.
   See example in :ref:`Table: Example of depicting the shape and the color overlap<table_OEShapeOverlapDisplay>`.

   .. seealso::

      * The Theory chapter of the **Shape TK** manual.
      * :oe:func:`OEGrapheme::OERenderColorOverlap` function
      * :oe:func:`OEGrapheme::OERenderShapeOverlap` function

   .. _table_OEShapeOverlapDisplay:

   .. list-table:: **Example of depicting the shape and the color overlap**
      :widths: 150 150 
      :header-rows: 0

      * - .. image:: ../images/RenderShapeOverlap.*
             :align:  center
        - .. image:: ../images/RenderColorOverlap.*
             :align:  center

   .. admonition:: Code Example

      * `Visualizing Shape and Color Overlap`_ **OpenEye Python Cookbook** recipe

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeOverlapDisplay(const OEShapeQueryDisplay& refdisp,
                                  const OEChem::OEMolBase& fitmol)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeOverlapDisplay(refdisp: OEShapeQueryDisplay,
                                  fitmol: Union[OEGraphMol,OEMol,OEQMol]) -> OEShapeOverlapDisplay

      Constructs an :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` object
      with default depiction options.

      *refdisp* 
        The :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object that
        stores the reference molecule of the shape overlap.

      *fitmol*
        The **3D** molecule that is overlaid to the reference molecule.

      .. warning::

         **No overlay is performed to maximize the shape and color overlap**
         between the reference and the fit molecule *i.e.*
         the *fitmol* has to be pre-aligned to the reference molecule
         stored in the :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>`
         object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeOverlapDisplay(const OEShapeQueryDisplay& refdisp,
                                  const OEChem::OEMolBase& fitmol,
                                  const OEColorOverlapDisplayOptions& copts)
            OEShapeOverlapDisplay(const OEShapeQueryDisplay& refdisp,
                                  const OEChem::OEMolBase& fitmol,
                                  const OEShapeOverlapDisplayOptions& sopts)
            OEShapeOverlapDisplay(const OEShapeQueryDisplay& refdisp,
                                  const OEChem::OEMolBase& fitmol,
                                  const OEShapeOverlapDisplayOptions& sopts,
                                  const OEColorOverlapDisplayOptions& copts)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeOverlapDisplay(refdisp: OEShapeQueryDisplay,
                                  fitmol: Union[OEGraphMol,OEMol,OEQMol],
                                  sopts: OEShapeOverlapDisplayOptions) -> OEShapeOverlapDisplay
            OEShapeOverlapDisplay(refdisp: OEShapeQueryDisplay,
                                  fitmol: Union[OEGraphMol,OEMol,OEQMol],
                                  copts: OEColorOverlapDisplayOptions) -> OEShapeOverlapDisplay
            OEShapeOverlapDisplay(refdisp: OEShapeQueryDisplay,
                                  fitmol: Union[OEGraphMol,OEMol,OEQMol],
                                  sopts: OEShapeOverlapDisplayOptions,
                                  copts: OEColorOverlapDisplayOptions) -> OEShapeOverlapDisplay

      Constructs an :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` object
      with given depiction options.

      *refdisp* 
        The :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object that
        stores the reference molecule of the shape overlap.

      *fitmol*
        The **3D** molecule that is overlaid to the reference molecule.

      *copts*
        The :ref:`OEColorOverlapDisplayOptions <OEGrapheme_OEColorOverlapDisplayOptions>` object
        that defines how the color atom overlap between the reference and the 
        fit molecule is depicted.

      *sopts*
        The :ref:`OEShapeOverlapDisplayOptions <OEGrapheme_OEShapeOverlapDisplayOptions>` object
        that defines how the shape overlap between the reference and the 
        fit molecule is depicted.

      .. warning::

         **No overlay is performed to maximize the shape and color overlap**
         between the reference and the fit molecule *i.e.*
         the *fitmol* has to be pre-aligned to the reference molecule
         stored in the :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>`
         object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeOverlapDisplay(const OEShapeOverlapDisplay& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeOverlapDisplay(rhs: OEShapeOverlapDisplay) -> OEShapeOverlapDisplay

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeOverlapDisplay &operator=(const OEShapeOverlapDisplay &rhs)

      Assignment operator.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Returns the title of the molecule the
      :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` object was initialized.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` object
      was initialized successfully.
      If initialization was attempted either with an invalid
      :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>`
      object, an empty fit molecule or a fit molecule without
      3D coordinates, then this method returns false.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEShapeOverlapDisplayOptions, ShapeOverlapDisplayOptions

.. _OEGrapheme_OEShapeOverlapDisplayOptions:

.. oe:class:: OEShapeOverlapDisplayOptions

   .. oe:api::

      class OEShapeOverlapDisplayOptions : public OEDepict::OE2DMolDisplayOptions

   This class represents :ref:`OEShapeOverlapDisplayOptions <OEGrapheme_OEShapeOverlapDisplayOptions>`
   that encapsulates properties that determine how the color atom
   overlap between the reference and the fit molecule is depicted by the
   :oe:func:`OEGrapheme::OERenderShapeOverlap` function.

   .. seealso::

      * :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` class
      * :oe:func:`OEGrapheme::OERenderShapeOverlap` function

   .. admonition:: Code Example

      * `Visualizing Shape and Color Overlap`_ **OpenEye Python Cookbook** recipe

   The following methods are publicly inherited from :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`:

   ====================================================================================================== ====================================================================================================== ======================================================================================================
   :oe:meth:`operator=<OEDepict::OE2DMolDisplayOptions::operator=>`                                       :oe:meth:`GetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::GetHydrogenStyle>`                         :oe:meth:`SetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineAtomLabelGapScale>`
   :oe:meth:`GetAromaticStyle<OEDepict::OE2DMolDisplayOptions::GetAromaticStyle>`                         :oe:meth:`GetMargin<OEDepict::OE2DMolDisplayOptions::GetMargin>`                                       :oe:meth:`SetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineGapScale>`
   :oe:meth:`GetAtomColor<OEDepict::OE2DMolDisplayOptions::GetAtomColor>`                                 :oe:meth:`GetScale<OEDepict::OE2DMolDisplayOptions::GetScale>`                                         :oe:meth:`SetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont>`
   :oe:meth:`GetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle>`                       :oe:meth:`GetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetSuperAtomLabelFont>`               :oe:meth:`SetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale>`
   :oe:meth:`GetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFont>`                         :oe:meth:`GetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle>`                       :oe:meth:`SetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor>`
   :oe:meth:`GetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFontScale>`               :oe:meth:`GetTitleFont<OEDepict::OE2DMolDisplayOptions::GetTitleFont>`                                 :oe:meth:`SetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle>`
   :oe:meth:`GetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFont>`                 :oe:meth:`GetTitleFontScale<OEDepict::OE2DMolDisplayOptions::GetTitleFontScale>`                       :oe:meth:`SetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::SetBondWidthScaling>`
   :oe:meth:`GetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFontScale>`       :oe:meth:`GetTitleHeight<OEDepict::OE2DMolDisplayOptions::GetTitleHeight>`                             :oe:meth:`SetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen>`
   :oe:meth:`GetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetAtomPropertyFunctor>`             :oe:meth:`GetTitleLocation<OEDepict::OE2DMolDisplayOptions::GetTitleLocation>`                         :oe:meth:`SetDimensions<OEDepict::OE2DMolDisplayOptions::SetDimensions>`
   :oe:meth:`GetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::GetAtomStereoStyle>`                     :oe:meth:`GetWidth<OEDepict::OE2DMolDisplayOptions::GetWidth>`                                         :oe:meth:`SetHeight<OEDepict::OE2DMolDisplayOptions::SetHeight>`
   :oe:meth:`GetBackgroundColor<OEDepict::OE2DMolDisplayOptions::GetBackgroundColor>`                     :oe:meth:`SetAromaticStyle<OEDepict::OE2DMolDisplayOptions::SetAromaticStyle>`                         :oe:meth:`SetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle>`
   :oe:meth:`GetBondColorStyle<OEDepict::OE2DMolDisplayOptions::GetBondColorStyle>`                       :oe:meth:`SetAtomColor<OEDepict::OE2DMolDisplayOptions::SetAtomColor>`                                 :oe:meth:`SetMargin<OEDepict::OE2DMolDisplayOptions::SetMargin>`
   :oe:meth:`GetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineAtomLabelGapScale>` :oe:meth:`SetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle>`                       :oe:meth:`SetMargins<OEDepict::OE2DMolDisplayOptions::SetMargins>`
   :oe:meth:`GetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineGapScale>`                   :oe:meth:`SetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFont>`                         :oe:meth:`SetScale<OEDepict::OE2DMolDisplayOptions::SetScale>`
   :oe:meth:`GetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFont>`                 :oe:meth:`SetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale>`               :oe:meth:`SetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetSuperAtomLabelFont>`
   :oe:meth:`GetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFontScale>`       :oe:meth:`SetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont>`                 :oe:meth:`SetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle>`
   :oe:meth:`GetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetBondPropertyFunctor>`             :oe:meth:`SetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale>`       :oe:meth:`SetTitleFont<OEDepict::OE2DMolDisplayOptions::SetTitleFont>`
   :oe:meth:`GetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::GetBondStereoStyle>`                     :oe:meth:`SetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor>`             :oe:meth:`SetTitleFontScale<OEDepict::OE2DMolDisplayOptions::SetTitleFontScale>`
   :oe:meth:`GetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::GetBondWidthScaling>`                   :oe:meth:`SetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle>`                     :oe:meth:`SetTitleHeight<OEDepict::OE2DMolDisplayOptions::SetTitleHeight>`
   :oe:meth:`GetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::GetDefaultBondPen>`                       :oe:meth:`SetBackgroundColor<OEDepict::OE2DMolDisplayOptions::SetBackgroundColor>`                     :oe:meth:`SetTitleLocation<OEDepict::OE2DMolDisplayOptions::SetTitleLocation>`
   :oe:meth:`GetHeight<OEDepict::OE2DMolDisplayOptions::GetHeight>`                                       :oe:meth:`SetBondColorStyle<OEDepict::OE2DMolDisplayOptions::SetBondColorStyle>`                       :oe:meth:`SetWidth<OEDepict::OE2DMolDisplayOptions::SetWidth>`
   ====================================================================================================== ====================================================================================================== ======================================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeOverlapDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEShapeOverlapDisplayOptions() -> OEShapeOverlapDisplayOptions

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeOverlapDisplayOptions(const OEShapeOverlapDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeOverlapDisplayOptions(rhs: OEShapeOverlapDisplayOptions) -> OEShapeOverlapDisplayOptions

      Copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeOverlapDisplayOptions &operator=(const OEShapeOverlapDisplayOptions &rhs)

      Assignment operator.

   .. oe:method:: ClearQuerySurfaceArcFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearQuerySurfaceArcFxn()

      .. oe:language:: python

         .. oe:api:: python

            ClearQuerySurfaceArcFxn() -> None

      Removes the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule around the fit molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::GetQuerySurfaceArcFxn` method
         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetQuerySurfaceArcFxn` method

   .. oe:method:: GetClearBackground

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetClearBackground() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearBackground() -> bool

      Returns whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to the rendering of the shape overlap.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetClearBackground` method

   .. oe:method:: GetOverlapColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEColor& GetOverlapColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlapColor() -> OEColor

      Returns the color of the property map that is used to visualize
      shape overlap between the reference and the fit molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetOverlapColor` method

   .. oe:method:: GetOverlapDisplayStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetOverlapDisplayStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlapDisplayStyle() -> int

      Returns the style that defines how shape overlay is depicted
      by the :oe:func:`OEGrapheme::OERenderShapeOverlap` function.
      The return value is taken from the
      :oe:constns:`OEGrapheme::OEShapeOverlapDisplayStyle` namespace.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetOverlapDisplayStyle` method
         * :oe:constns:`OEGrapheme::OEShapeOverlapDisplayStyle` namespace

   .. oe:method:: GetQuerySurfaceArcFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESurfaceArcFxnBase* GetQuerySurfaceArcFxn() const

      .. oe:language:: python

         .. oe:api:: python

            GetQuerySurfaceArcFxn() -> OESurfaceArcFxnBase

      Returns the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule around the fit molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::ClearQuerySurfaceArcFxn` method
         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetQuerySurfaceArcFxn` method

   .. oe:method:: SetClearBackground

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetClearBackground(bool clear)

      .. oe:language:: python

         .. oe:api:: python

            SetClearBackground(clear: bool) -> None

      Sets whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to the rendering of the shape overlap.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::GetClearBackground` method

   .. oe:method:: SetOverlapColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOverlapColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetOverlapColor(color: OEColor) -> None

      Sets the color of the property map that is used to visualize
      shape overlap between the reference and the fit molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::GetOverlapColor` method

   .. oe:method:: SetOverlapDisplayStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOverlapDisplayStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetOverlapDisplayStyle(style: int) -> None

      Sets the style that defines how shape overlay is depicted
      by the :oe:func:`OEGrapheme::OERenderShapeOverlap` function.

      *style*
         This value has to be from the :oe:constns:`OEGrapheme::OEShapeOverlapDisplayStyle`
         namespace.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::GetOverlapDisplayStyle` method
         * :oe:constns:`OEGrapheme::OEShapeOverlapDisplayStyle` namespace

   .. oe:method:: SetQuerySurfaceArcFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetQuerySurfaceArcFxn(const OESurfaceArcFxnBase& arcfxn)

      .. oe:language:: python

         .. oe:api:: python

            SetQuerySurfaceArcFxn(arcfxn: OESurfaceArcFxnBase) -> None

      Sets the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule around the fit molecule
      when calling the :oe:func:`OEGrapheme::OERenderShapeOverlap` function
      to depict the shape overlap.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::ClearQuerySurfaceArcFxn` method
         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::GetQuerySurfaceArcFxn` method




.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. _OEGrapheme_OEShapeQueryDisplay:

.. oe:class:: OEShapeQueryDisplay

   .. oe:api::

      class OEShapeQueryDisplay

   This class represents :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` that
   stores the depiction information of a shape query *i.e.* shape reference 
   molecule.
   See example in :ref:`Figure: Example of depicting a shape query<figure_OEShapeQueryDisplay>`.

   .. seealso::

      * The Theory chapter of the **Shape TK** manual.
      * :oe:func:`OEGrapheme::OERenderShapeQuery` function

   .. _figure_OEShapeQueryDisplay:

   .. figure:: graphemetk/images/RenderShapeQuery.*
      :align:  center

      **Example of depicting a shape query**

   .. admonition:: Code Example

      * `Visualizing Shape and Color Overlap`_ **OpenEye Python Cookbook** recipe

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeQueryDisplay(const OEChem::OEMolBase& refmol,
                                const OEShape::OEColorForceField& cff)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplay(refmol: Union[OEGraphMol,OEMol,OEQMol],
                                cff: OEColorForceField) -> OEShapeQueryDisplay

      Constructs an :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object
      with default depiction options.

      *refmol*
         The **3D** reference molecule of the shape overlap. 

      *cff*
         The :ref:`OEColorForceField <OEShape_OEColorForceField>` object that defines
         various chemical centers and their interactions. 

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeQueryDisplay(const OEChem::OEMolBase& refmol,
                                const OEShape::OEColorForceField& cff,
                                const OEShapeQueryDisplayOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplay(refmol: Union[OEGraphMol,OEMol,OEQMol],
                                cff: OEColorForceField,
                                opts: OEShapeQueryDisplayOptions) -> OEShapeQueryDisplay

      Constructs an :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object
      with given depiction options.

      *refmol*
         The **3D** reference molecule of the shape overlap. 

      *cff*
         The :ref:`OEColorForceField <OEShape_OEColorForceField>` object that defines
         various chemical centers and their interactions. 

      *opts*
        The :ref:`OEShapeQueryDisplayOptions <OEGrapheme_OEShapeQueryDisplayOptions>` object
        that defines how the shape query *i.e.* reference molecule 
        is depicted.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeQueryDisplay(const OEChem::OEMolBase& refmol,
                                const OEColorForceFieldDisplay& cffdisp)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplay(refmol: Union[OEGraphMol,OEMol,OEQMol],
                                cffdisp: OEColorForceFieldDisplay) -> OEShapeQueryDisplay

      Constructs an :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object
      with default depiction options.

      *refmol*
         The **3D** reference molecule of the shape overlap.

      *cffdisp*
         The :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>` object that
         stores the depiction information of an
         :ref:`OEColorForceField <OEShape_OEColorForceField>` object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeQueryDisplay(const OEChem::OEMolBase& refmol,
                                const OEColorForceFieldDisplay& cffdisp,
                                const OEShapeQueryDisplayOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplay(refmol: Union[OEGraphMol,OEMol,OEQMol],
                                cffdisp: OEColorForceFieldDisplay,
                                opts: OEShapeQueryDisplayOptions) -> OEShapeQueryDisplay

      Constructs an :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object
      with given depiction options.

      *refmol*
         The **3D** reference molecule of the shape overlap.

      *cffdisp*
         The :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>` object that
         stores the depiction information of an
         :ref:`OEColorForceField <OEShape_OEColorForceField>` object.

      *opts*
        The :ref:`OEShapeQueryDisplayOptions <OEGrapheme_OEShapeQueryDisplayOptions>` object
        that defines how the shape query *i.e.* reference molecule
        is depicted.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeQueryDisplay(const OEShapeQueryDisplay& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplay(rhs: OEShapeQueryDisplay) -> OEShapeQueryDisplay

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeQueryDisplay &operator=(const OEShapeQueryDisplay &rhs)

      Assignment operator.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Returns the title of the molecule the
      :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object was initialized.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object
      was initialized successfully.
      If initialization was attempted with either an empty molecule or a
      molecule without 3D coordinates, then this method returns false.



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEShapeQueryDisplayOptions, ShapeQueryDisplayOptions

.. _OEGrapheme_OEShapeQueryDisplayOptions:

.. oe:class:: OEShapeQueryDisplayOptions

   .. oe:api::

      class OEShapeQueryDisplayOptions : public OEDepict::OE2DMolDisplayOptions

   This class represents :ref:`OEShapeQueryDisplayOptions <OEGrapheme_OEShapeQueryDisplayOptions>`
   that encapsulates properties that determine how the reference molecule
   of a shape overlap is depicted by the :oe:func:`OEGrapheme::OERenderShapeQuery` function.

   .. seealso::

      * :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` class
      * :oe:func:`OEGrapheme::OERenderShapeQuery` function

   .. admonition:: Code Example

      * `Visualizing Shape and Color Overlap`_ **OpenEye Python Cookbook** recipe

   The following methods are publicly inherited from :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`:

   ====================================================================================================== ====================================================================================================== ======================================================================================================
   :oe:meth:`operator=<OEDepict::OE2DMolDisplayOptions::operator=>`                                       :oe:meth:`GetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::GetHydrogenStyle>`                         :oe:meth:`SetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineAtomLabelGapScale>`
   :oe:meth:`GetAromaticStyle<OEDepict::OE2DMolDisplayOptions::GetAromaticStyle>`                         :oe:meth:`GetMargin<OEDepict::OE2DMolDisplayOptions::GetMargin>`                                       :oe:meth:`SetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineGapScale>`
   :oe:meth:`GetAtomColor<OEDepict::OE2DMolDisplayOptions::GetAtomColor>`                                 :oe:meth:`GetScale<OEDepict::OE2DMolDisplayOptions::GetScale>`                                         :oe:meth:`SetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont>`
   :oe:meth:`GetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle>`                       :oe:meth:`GetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetSuperAtomLabelFont>`               :oe:meth:`SetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale>`
   :oe:meth:`GetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFont>`                         :oe:meth:`GetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle>`                       :oe:meth:`SetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor>`
   :oe:meth:`GetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFontScale>`               :oe:meth:`GetTitleFont<OEDepict::OE2DMolDisplayOptions::GetTitleFont>`                                 :oe:meth:`SetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle>`
   :oe:meth:`GetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFont>`                 :oe:meth:`GetTitleFontScale<OEDepict::OE2DMolDisplayOptions::GetTitleFontScale>`                       :oe:meth:`SetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::SetBondWidthScaling>`
   :oe:meth:`GetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFontScale>`       :oe:meth:`GetTitleHeight<OEDepict::OE2DMolDisplayOptions::GetTitleHeight>`                             :oe:meth:`SetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen>`
   :oe:meth:`GetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetAtomPropertyFunctor>`             :oe:meth:`GetTitleLocation<OEDepict::OE2DMolDisplayOptions::GetTitleLocation>`                         :oe:meth:`SetDimensions<OEDepict::OE2DMolDisplayOptions::SetDimensions>`
   :oe:meth:`GetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::GetAtomStereoStyle>`                     :oe:meth:`GetWidth<OEDepict::OE2DMolDisplayOptions::GetWidth>`                                         :oe:meth:`SetHeight<OEDepict::OE2DMolDisplayOptions::SetHeight>`
   :oe:meth:`GetBackgroundColor<OEDepict::OE2DMolDisplayOptions::GetBackgroundColor>`                     :oe:meth:`SetAromaticStyle<OEDepict::OE2DMolDisplayOptions::SetAromaticStyle>`                         :oe:meth:`SetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle>`
   :oe:meth:`GetBondColorStyle<OEDepict::OE2DMolDisplayOptions::GetBondColorStyle>`                       :oe:meth:`SetAtomColor<OEDepict::OE2DMolDisplayOptions::SetAtomColor>`                                 :oe:meth:`SetMargin<OEDepict::OE2DMolDisplayOptions::SetMargin>`
   :oe:meth:`GetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineAtomLabelGapScale>` :oe:meth:`SetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle>`                       :oe:meth:`SetMargins<OEDepict::OE2DMolDisplayOptions::SetMargins>`
   :oe:meth:`GetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineGapScale>`                   :oe:meth:`SetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFont>`                         :oe:meth:`SetScale<OEDepict::OE2DMolDisplayOptions::SetScale>`
   :oe:meth:`GetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFont>`                 :oe:meth:`SetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale>`               :oe:meth:`SetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetSuperAtomLabelFont>`
   :oe:meth:`GetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFontScale>`       :oe:meth:`SetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont>`                 :oe:meth:`SetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle>`
   :oe:meth:`GetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetBondPropertyFunctor>`             :oe:meth:`SetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale>`       :oe:meth:`SetTitleFont<OEDepict::OE2DMolDisplayOptions::SetTitleFont>`
   :oe:meth:`GetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::GetBondStereoStyle>`                     :oe:meth:`SetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor>`             :oe:meth:`SetTitleFontScale<OEDepict::OE2DMolDisplayOptions::SetTitleFontScale>`
   :oe:meth:`GetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::GetBondWidthScaling>`                   :oe:meth:`SetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle>`                     :oe:meth:`SetTitleHeight<OEDepict::OE2DMolDisplayOptions::SetTitleHeight>`
   :oe:meth:`GetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::GetDefaultBondPen>`                       :oe:meth:`SetBackgroundColor<OEDepict::OE2DMolDisplayOptions::SetBackgroundColor>`                     :oe:meth:`SetTitleLocation<OEDepict::OE2DMolDisplayOptions::SetTitleLocation>`
   :oe:meth:`GetHeight<OEDepict::OE2DMolDisplayOptions::GetHeight>`                                       :oe:meth:`SetBondColorStyle<OEDepict::OE2DMolDisplayOptions::SetBondColorStyle>`                       :oe:meth:`SetWidth<OEDepict::OE2DMolDisplayOptions::SetWidth>`
   ====================================================================================================== ====================================================================================================== ======================================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeQueryDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplayOptions() -> OEShapeQueryDisplayOptions

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeQueryDisplayOptions(const OEShapeQueryDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplayOptions(rhs: OEShapeQueryDisplayOptions) -> OEShapeQueryDisplayOptions

      Copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeQueryDisplayOptions &operator=(const OEShapeQueryDisplayOptions &rhs)

      Assignment operator.

   .. oe:method:: ClearSurfaceArcFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearSurfaceArcFxn()

      .. oe:language:: python

         .. oe:api:: python

            ClearSurfaceArcFxn() -> None

      Removes the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::GetSurfaceArcFxn`
         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::SetSurfaceArcFxn`

   .. oe:method:: GetClearBackground

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetClearBackground() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearBackground() -> bool

      Returns whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to the rendering of the shape query.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::SetClearBackground`

   .. oe:method:: GetColorAtomStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetColorAtomStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorAtomStyle() -> int

      Returns the style that is used to define how color atoms are depicted
      by the :oe:func:`OEGrapheme::OERenderShapeQuery` function.
      The return value is taken from the :oe:constns:`OEGrapheme::OEColorAtomStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::SetColorAtomStyle`
         * :oe:constns:`OEGrapheme::OEColorAtomStyle` namespace

   .. oe:method:: GetDepictOrientation

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetDepictOrientation() const

      .. oe:language:: python

         .. oe:api:: python

            GetDepictOrientation() -> int

      Returns the preferred orientation of 2D layout if the shape query.
      The return value is taken from the
      :oe:constns:`OEDepict::OEDepictOrientation` namespace.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::SetDepictOrientation` method

   .. oe:method:: GetSurfaceArcFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESurfaceArcFxnBase* GetSurfaceArcFxn() const

      .. oe:language:: python

         .. oe:api:: python

            GetSurfaceArcFxn() -> OESurfaceArcFxnBase

      Returns the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::ClearSurfaceArcFxn`
         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::SetSurfaceArcFxn`

   .. oe:method:: SetClearBackground

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetClearBackground(bool clear)

      .. oe:language:: python

         .. oe:api:: python

            SetClearBackground(clear: bool) -> None

      Sets whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to the rendering of the shape query.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::GetClearBackground`

   .. oe:method:: SetColorAtomStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColorAtomStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetColorAtomStyle(style: int) -> None

      Sets the style that defines how color atoms are
      depicted by the :oe:func:`OEGrapheme::OERenderShapeQuery` function.

      *style*
         This value has to be from the :oe:constns:`OEGrapheme::OEColorAtomStyle`
         namespace.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::GetColorAtomStyle`
         * :oe:constns:`OEGrapheme::OEColorAtomStyle` namespace

   .. oe:method:: SetDepictOrientation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDepictOrientation(unsigned int orientation)

      .. oe:language:: python

         .. oe:api:: python

            SetDepictOrientation(arg2: int) -> None

      Sets the preferred orientation of 2D layout of the shape query.

      *orientation*
         This value has to be from the :oe:constns:`OEDepict::OEDepictOrientation`
         namespace.

      .. note::

         Changing the orientation of the layout of the shape query consequently effects
         the orientation of the shape and color overlaps mapped to the given shape query.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::GetDepictOrientation` method
         * :oe:constns:`OEDepict::OEDepictOrientation` namespace

   .. oe:method:: SetSurfaceArcFxn

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSurfaceArcFxn(const OESurfaceArcFxnBase& arcfxn)

      .. oe:language:: python

         .. oe:api:: python

            SetSurfaceArcFxn(arcfxn: OESurfaceArcFxnBase) -> None

      Sets the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule when calling the
      :oe:func:`OEGrapheme::OERenderShapeQuery` function.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::ClearSurfaceArcFxn`
         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::GetSurfaceArcFxn`



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OESimpsonArcFxn, SimpsonArcFxn

.. _OEGrapheme_OESimpsonArcFxn:

.. oe:class:: OESimpsonArcFxn

   .. oe:api::

      class OESimpsonArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OESimpsonArcFxn <OEGrapheme_OESimpsonArcFxn>`.
   See example in :ref:`Example of drawing molecule surface using OESimpsonArcFxn<figure_OESimpsonArcFxn>`.

   .. _figure_OESimpsonArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OESimpsonArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OESimpsonArcFxn**

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawSimpsonSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESimpsonArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OESimpsonArcFxn(pen: OEPen = OEBlackPen) -> OESimpsonArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Simpson` style.

      See example in :ref:`Example of drawing molecule surface using OESimpsonArcFxn<figure_OESimpsonArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESimpsonArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OESimpsonArcFxn <OEGrapheme_OESimpsonArcFxn>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEStitchArcFxn, StitchArcFxn

.. _OEGrapheme_OEStitchArcFxn:

.. oe:class:: OEStitchArcFxn

   .. oe:api::

      class OEStitchArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OEStitchArcFxn <OEGrapheme_OEStitchArcFxn>`.
   See example in :ref:`Example of drawing molecule surface using OEStitchArcFxn<figure_OEStitchArcFxn>`.

   .. _figure_OEStitchArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OEStitchArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OEStitchArcFxn**

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawStitchSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEStitchArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OEStitchArcFxn(pen: OEPen = OEBlackPen) -> OEStitchArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Stitch` style.

      See example in :ref:`Example of drawing molecule surface using OEStitchArcFxn<figure_OEStitchArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEStitchArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEStitchArcFxn <OEGrapheme_OEStitchArcFxn>`
      object is dynamically allocated and owned by the caller.



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OESunArcFxn, SunArcFxn

.. _OEGrapheme_OESunArcFxn:

.. oe:class:: OESunArcFxn

   .. oe:api::

      class OESunArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OESunArcFxn <OEGrapheme_OESunArcFxn>`.
   See example in :ref:`Example of drawing molecule surface using OESunArcFxn<figure_OESunArcFxn>`.

   .. _figure_OESunArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OESunArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OESunArcFxn**

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawSunSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESunArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OESunArcFxn(pen: OEPen = OEBlackPen) -> OESunArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Sun` style.

      See example in :ref:`Example of drawing molecule surface using OESunArcFxn<figure_OESunArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESunArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OESunArcFxn <OEGrapheme_OESunArcFxn>`
      object is dynamically allocated and owned by the caller.



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OESurfaceArc, SurfaceArc

.. _OEGrapheme_OESurfaceArc:

.. oe:class:: OESurfaceArc

   .. oe:api::

      class OESurfaceArc

   This class represents :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` that stores
   data for drawing the arcs of molecule surface.
   See :ref:`Figure: Example of the data stored in the OESurfaceArc class<figure_OESurfaceArc>`.

   .. _figure_OESurfaceArc:

   .. figure:: graphemetk/images/OESurfaceArc.*
      :align:  center

      **Example of the data stored in the OESurfaceArc class**

   .. note::

      Angles are interpreted such that :math:`0.0^{\circ}` and
      :math:`360.0^{\circ}` degrees are at the *12 o'clock*
      position, :math:`90.0^{\circ}` degree corresponds
      to *3 o'clock*, etc.

   .. seealso::

      * :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>` class
      * :oe:func:`OEGrapheme::OEGet2DSurfaceArcs` function

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArc()

      .. oe:language:: python

         .. oe:api:: python

            OESurfaceArc() -> OESurfaceArc

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArc(const OEDepict::OE2DAtomDisplay* adisp,
                         const OEDepict::OE2DPoint& center, double bgnAngle,
                         double endAngle, double radius)

      .. oe:language:: python

         .. oe:api:: python

            OESurfaceArc(adisp: OE2DAtomDisplay, center: OE2DPoint,
                         bgnAngle: float, endAngle: float, radius: float) -> OESurfaceArc

      Creates an :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` object with the given parameters.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArc(const OESurfaceArc& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESurfaceArc(rhs: OESurfaceArc) -> OESurfaceArc

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESurfaceArc &operator=(const OESurfaceArc &rhs)

      Assignment operator.

   .. oe:method:: GetAtomDisplay

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEDepict::OE2DAtomDisplay* GetAtomDisplay() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomDisplay() -> OE2DAtomDisplay

      Returns the pointer of the :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>`
      object the given arc belongs to.

      .. seealso::

         * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` class in the **OEDepict TK** manual

   .. oe:method:: GetBgnAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBgnAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetBgnAngle() -> float

      Returns the angle (in degrees) where the arc of the surface starts.

   .. oe:method:: GetCenter

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEDepict::OE2DPoint& GetCenter() const

      .. oe:language:: python

         .. oe:api:: python

            GetCenter() -> OE2DPoint

      Returns the (x,y) coordinates of the center of the surface arc.

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class in the **OEDepict TK** manual

   .. oe:method:: GetEndAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEndAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetEndAngle() -> float

      Returns the angle (in degrees) where the arc of the surface ends.

   .. oe:method:: GetRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetRadius() -> float

      Returns the radius of the arc.

   .. oe:method:: SetAtomDisplay

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAtomDisplay(const OEDepict::OE2DAtomDisplay* adisp)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomDisplay(adisp: OE2DAtomDisplay) -> bool

      Sets the atom display to which the arc belongs.

      .. seealso::

         * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` class in the OEDepict manual

   .. oe:method:: SetBgnAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBgnAngle(double angle)

      .. oe:language:: python

         .. oe:api:: python

            SetBgnAngle(angle: float) -> bool

      Sets the angle where the arc of the surface begins.

      *angle*
         The angle has to in the range of :math:`[0.0^{\circ}, 360.0^{\circ}]`

   .. oe:method:: SetCenter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCenter(const OEDepict::OE2DPoint& center)

      .. oe:language:: python

         .. oe:api:: python

            SetCenter(center: OE2DPoint) -> bool

      Sets the (x,y) coordinates of the center of the surface arc.

   .. oe:method:: SetEndAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEndAngle(double angle)

      .. oe:language:: python

         .. oe:api:: python

            SetEndAngle(angle: float) -> bool

      Sets the angle where the arc of the surface ends.

      *angle*
         The angle has to in the range of :math:`[0.0^{\circ}, 360.0^{\circ}]`

   .. oe:method:: SetRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRadius(double radius)

      .. oe:language:: python

         .. oe:api:: python

            SetRadius(radius: float) -> bool

      Sets the radius of the arc.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OESurfaceArcFxnBase, SurfaceArcFxnBase

.. _OEGrapheme_OESurfaceArcFxnBase:

.. oe:class:: OESurfaceArcFxnBase

   .. oe:api::

      class OESurfaceArcFxnBase

   This class represents :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`
   which is an abstract class that defines the interface used for
   drawing molecule surfaces.

   The following classes derive from this class:
    * :ref:`OEAlphaRainbowArcFxn <OEGrapheme_OEAlphaRainbowArcFxn>`
    * :ref:`OEBrickRoadArcFxn <OEGrapheme_OEBrickRoadArcFxn>`
    * :ref:`OECastleArcFxn <OEGrapheme_OECastleArcFxn>`
    * :ref:`OECogArcFxn <OEGrapheme_OECogArcFxn>`
    * :ref:`OEDefaultArcFxn <OEGrapheme_OEDefaultArcFxn>`
    * :ref:`OEEyelashArcFxn <OEGrapheme_OEEyelashArcFxn>`
    * :ref:`OEFlowerArcFxn <OEGrapheme_OEFlowerArcFxn>`
    * :ref:`OENecklaceArcFxn <OEGrapheme_OENecklaceArcFxn>`
    * :ref:`OENullArcFxn <OEGrapheme_OENullArcFxn>`
    * :ref:`OEOliveBranchArcFxn <OEGrapheme_OEOliveBranchArcFxn>`
    * :ref:`OEPearlsArcFxn <OEGrapheme_OEPearlsArcFxn>`
    * :ref:`OERaceTrackArcFxn <OEGrapheme_OERaceTrackArcFxn>`
    * :ref:`OERailroadTrackArcFxn <OEGrapheme_OERailroadTrackArcFxn>`
    * :ref:`OESawArcFxn <OEGrapheme_OESawArcFxn>`
    * :ref:`OESimpsonArcFxn <OEGrapheme_OESimpsonArcFxn>`
    * :ref:`OEStitchArcFxn <OEGrapheme_OEStitchArcFxn>`
    * :ref:`OESunArcFxn <OEGrapheme_OESunArcFxn>`
    * :ref:`OEWreathArcFxn <OEGrapheme_OEWreathArcFxn>`

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg0: OEImageBase, arg1: OESurfaceArc) -> bool

      It is a virtual const method that is implemented in the concrete 
      derived classes to draw surface arcs.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESurfaceArcFxnBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEWreathArcFxn, WreathArcFxn

.. _OEGrapheme_OEWreathArcFxn:

.. oe:class:: OEWreathArcFxn

   .. oe:api::

      class OEWreathArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OEWreathArcFxn <OEGrapheme_OEWreathArcFxn>`.
   See example in :ref:`Example of drawing molecule surface using OEWreathArcFxn<figure_OEWreathArcFxn>`.

   .. _figure_OEWreathArcFxn:

   .. figure:: graphemetk/images/OESurfaceArc_OEWreathArcFxn.*
      :align:  center

      **Example of drawing molecule surface using OEWreathArcFxn**

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawWreathSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEWreathArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OEWreathArcFxn(pen: OEPen = OEBlackPen) -> OEWreathArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, arc: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Wreath` style.

      See example in :ref:`Example of drawing molecule surface using OEWreathArcFxn<figure_OEWreathArcFxn>`.

      *image*
         The image on which the surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEWreathArcFxn

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEWreathArcFxn <OEGrapheme_OEWreathArcFxn>`
      object is dynamically allocated and owned by the caller.


.. oe:namespace:: OEGrapheme

.. oe:constnamespace:: OE2DPropMapSetup

   This namespace encodes symbolic constants used as bit-masks to 
   indicate which property map parameters are being 
   created when invoking the  
   :oe:func:`OEGrapheme::OEConfigure2DPropMap` function.

   .. ################################################################
      #
      ################################################################
  
   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEGrapheme::OE2DPropMapSetup::Legend`
      * :oe:const:`OEGrapheme::OE2DPropMapSetup::MaxValue`
      * :oe:const:`OEGrapheme::OE2DPropMapSetup::MinValue`
      * :oe:const:`OEGrapheme::OE2DPropMapSetup::NegativeColor`
      * :oe:const:`OEGrapheme::OE2DPropMapSetup::PositiveColor`
      * :oe:const:`OEGrapheme::OE2DPropMapSetup::RadiusRatio`
      * :oe:const:`OEGrapheme::OE2DPropMapSetup::Resolution`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Legend

      Passing this constant to the  
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results
      in generating the following default interface to configure
      the location of the legend.

      ::

         Contents of parameter -legend
             Aliases : -l
             Type : string
             Allow list : false
             Default : Bottom
             Simple : true
             Required : false
             Legal values : Hidden Top Bottom Left Right
             Brief : Location of the legend
             Detail

      .. seealso::

         * :oe:constns:`OEGrapheme::OELegendLocation` namespace
         * :oe:meth:`OEGrapheme::OE2DPropMap::SetLegendLocation` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MaxValue

      Passing this constant to the  
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results 
      in generating the following default interface to configure
      the maximum value of the property map.

      ::

         Contents of parameter -maxvalue
             Aliases : -maxv
             Type : float
             Allow list : false
             Default : (parameter does not have a default)
             Simple : true
             Required : false
             Brief : Maximum property limit

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetMaxValue` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MinValue

      Passing this constant to the  
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results
      in generating the following default interface to configure
      the minimum value of the property map.

      ::

         Contents of parameter -minvalue
             Aliases : -minv
             Type : float
             Allow list : false
             Default : (parameter does not have a default)
             Simple : true
             Required : false
             Brief : Minimum property limit

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetMinValue` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NegativeColor

      Passing this constant to the
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results
      in generating the following default interface to configure
      the color used to represent negative values in the property map.

      ::

         Contents of parameter -negcolor
             Aliases : -negc
             Type : string
             Allow list : false
             Default : red
             Simple : true
             Required : false
             Legal values : black blue bluetint brown cyan darkblue darkbrown
             darkcyan darkgreen darkgrey darkmagenta darkorange darkpurple darkred
             darkrose darksalmon darkyellow gold green greenblue greentint grey
             hotpink lightblue lightbrown lightgreen lightgrey lightorange
             lightpurple lightsalmon limegreen magenta mediumblue mediumbrown
             mediumgreen mediumorange mediumpurple mediumsalmon mediumyellow
             olivebrown olivegreen olivegrey orange pink pinktint purple red
             redorange royalblue seagreen skyblue violet white yellow yellowtint
             Brief : Color of the negative values

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetNegativeColor` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PositiveColor

      Passing this constant to the  
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results
      in generating the following default interface to configure
      the color used to represent positive values in the property map.

      ::

         Contents of parameter -poscolor
             Aliases : -posc
             Type : string
             Allow list : false
             Default : blue
             Simple : true
             Required : false
             Legal values : black blue bluetint brown cyan darkblue darkbrown
             darkcyan darkgreen darkgrey darkmagenta darkorange darkpurple darkred
             darkrose darksalmon darkyellow gold green greenblue greentint grey
             hotpink lightblue lightbrown lightgreen lightgrey lightorange
             lightpurple lightsalmon limegreen magenta mediumblue mediumbrown
             mediumgreen mediumorange mediumpurple mediumsalmon mediumyellow
             olivebrown olivegreen olivegrey orange pink pinktint purple red
             redorange royalblue seagreen skyblue violet white yellow yellowtint
             Brief : Color of the positive values

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetPositiveColor` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: RadiusRatio

      Passing this constant to the
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results
      in generating the following default interface to configure
      the Gaussian radius of the property map.

      ::

         Contents of parameter -radiusratio
             Aliases : -rad
             Type : float
             Allow list : false
             Default : 1.0
             Simple : true
             Required : false
             Legal ranges :
                 2.0 to 0.5
             Brief : Ratio to scale the gaussian radius

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetRadiusRatio` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Resolution

      Passing this constant to the
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results
      in generating the following default interface to configure
      the resolution of the property map.

      ::

         Contents of parameter -resolution
             Aliases : -res
             Type : int
             Allow list : false
             Default : 2
             Simple : true
             Required : false
             Legal ranges :
                 20 to 2
             Brief : Resolution of the property map

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetResolution` method




.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. oe:constnamespace:: OEActiveSiteRenderStyle

   This namespace contains constants representing various
   active site representation styles.

   .. seealso::

      * :oe:func:`OEGrapheme::OERenderActiveSiteMaps` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The label style is 
      :oe:const:`OEGrapheme::OEActiveSiteRenderStyle::InteractionMap`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BFactorMap

   .. only:: oehtml

      .. raw:: html

         <p align="left">
         <b>hover mouse over any residue circles</b>
         </p>

         <p align="left">
         <object data="../../_images/RenderBFactorMap.svg" type="image/svg+xml"  width = "400" ></object>
         <p>

      .. image:: /_images/RenderBFactorMap.svg
         :width: 1pt

   .. only:: oepdf

      .. figure:: graphemetk/images/RenderBFactorMap.pdf
         :align:  center

   .. seealso::

      * :oe:func:`OEGrapheme::OERenderBFactorMap` function
      * :oe:func:`OEGrapheme::OEDrawBFactorMapLegend` function

   .. admonition:: Code Example

      * `Visualizing Protein-Ligand B-Factor Map`_ **OpenEye Python Cookbook** recipe

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ContactMap

   .. only:: oehtml

      .. raw:: html

         <p align="left">
         <b>click on any residue circles</b>
         </p>

         <p align="left">
         <object data="../../_images/RenderContactMap.svg" type="image/svg+xml"  width = "400" ></object>
         <p>

      .. image:: /_images/RenderContactMap.svg
         :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. seealso::

      * :oe:func:`OEGrapheme::OERenderContactMap` function

   .. admonition:: Code Example

      * `Visualizing Protein-Ligand Contacts`_ **OpenEye Python Cookbook** recipe

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: InteractionMap

   .. only:: oehtml

      .. raw:: html

         <p align="left">
         <object data="../../_images/OERenderActiveSite-image-adisp.svg" type="image/svg+xml"  width = "400" ></object>
         <p>

      .. image:: /_images/OERenderActiveSite-image-adisp.svg
         :width: 1pt

   .. only:: oepdf

      .. figure:: graphemetk/images/OERenderActiveSite-image-adisp.pdf
         :align:  center

   .. seealso::

      * :oe:func:`OEGrapheme::OERenderActiveSite` function
      * :oe:func:`OEGrapheme::OEDrawActiveSiteLegend` function
      * :ref:`section_examples_summary_complex2img` example

   .. admonition:: Code Example

      * `Visualizing Protein-Ligand Interactions`_  **OpenEye Python** Cookbook recipe

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: UnpairedMap

   .. only:: oehtml

      .. raw:: html

         <p align="left">
         <object data="../../_images/RenderUnpairedMap.svg" type="image/svg+xml"  width = "400" ></object>
         <p>

      .. image:: /_images/RenderUnpairedMap.svg
         :width: 1pt

   .. only:: oepdf

      .. figure:: graphemetk/images/RenderUnpairedMap.pdf
         :align:  center

   .. seealso::

      * :oe:func:`OEGrapheme::OERenderUnpairedInteractionMap` function
      * :oe:func:`OEGrapheme::OEDrawUnpairedInteractionMapLegend` function

   .. admonition:: Code Example

      * `Visualizing Protein-Ligand Unpaired Interactions`_ **OpenEye Python Cookbook** recipe


.. oe:namespace:: OEGrapheme

.. oe:constnamespace:: OECircleStyle

   This namespace contains constants representing various
   circle styles.

   .. seealso:: 

      * :oe:func:`OEGrapheme::OEDrawCircle` function

   The :oe:constns:`OEGrapheme::OECircleStyle` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AlphaRainbow

      See :ref:`Figure: Example of a circle drawn with the 'AlphaRainbow' style <figure_OECircleStyle_AlphaRainbow>`.

      .. _figure_OECircleStyle_AlphaRainbow:

      .. figure:: graphemetk/images/OECircleStyle_AlphaRainbow.*
         :align:  center

         **Example of a circle drawn with the 'AlphaRainbow' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawAlphaRainbowCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BrickRoad

      See :ref:`Figure: Example of a circle drawn with the 'BrickRoad' style <figure_OECircleStyle_BrickRoad>`.

      .. _figure_OECircleStyle_BrickRoad:

      .. figure:: graphemetk/images/OECircleStyle_BrickRoad.*
         :align:  center

         **Example of a circle drawn with the 'BrickRoad' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawBrickRoadCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Castle

      See :ref:`Figure: Example of a circle drawn with the 'Castle' style <figure_OECircleStyle_Castle>`.

      .. _figure_OECircleStyle_Castle:

      .. figure:: graphemetk/images/OECircleStyle_Castle.*
         :align:  center

         **Example of a circle drawn with the 'Castle' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawCastleCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Cog

      See :ref:`Figure: Example of a circle drawn with the 'Cog' style <figure_OECircleStyle_Cog>`.

      .. _figure_OECircleStyle_Cog:

      .. figure:: graphemetk/images/OECircleStyle_Cog.*
         :align:  center

         **Example of a circle drawn with the 'Cog' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawCogCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      See :ref:`Figure: Example of a circle drawn with the 'Default' style <figure_OECircleStyle_Default>`.

      .. _figure_OECircleStyle_Default:

      .. figure:: graphemetk/images/OECircleStyle_Default.*
         :align:  center

         **Example of a circle drawn with the 'Default' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawDefaultCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Eyelash

      See :ref:`Figure: Example of a circle drawn with the 'Eyelash' style <figure_OECircleStyle_Eyelash>`.

      .. _figure_OECircleStyle_Eyelash:

      .. figure:: graphemetk/images/OECircleStyle_Eyelash.*
         :align:  center

         **Example of a circle drawn with the 'Eyelash' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawEyelashCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Flower

      See :ref:`Figure: Example of a circle drawn with the 'Flower' style <figure_OECircleStyle_Flower>`.

      .. _figure_OECircleStyle_Flower:

      .. figure:: graphemetk/images/OECircleStyle_Flower.*
         :align:  center

         **Example of a circle drawn with the 'Flower' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawFlowerCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: GreekKey

      See :ref:`Figure: Example of a circle drawn with the 'GreekKey' style <figure_OECircleStyle_GreekKey>`.

      .. _figure_OECircleStyle_GreekKey:

      .. figure:: graphemetk/images/OECircleStyle_GreekKey.*
         :align:  center

         **Example of a circle drawn with the 'GreekKey' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawGreekKeyCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Necklace

      See :ref:`Figure: Example of a circle drawn with the 'Necklace' style <figure_OECircleStyle_Necklace>`.

      .. _figure_OECircleStyle_Necklace:

      .. figure:: graphemetk/images/OECircleStyle_Necklace.*
         :align:  center

         **Example of a circle drawn with the 'Necklace' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawNecklaceCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OliveBranch

      See :ref:`Figure: Example of a circle drawn with the 'OliveBranch' style <figure_OECircleStyle_OliveBranch>`.

      .. _figure_OECircleStyle_OliveBranch:

      .. figure:: graphemetk/images/OECircleStyle_OliveBranch.*
         :align:  center

         **Example of a circle drawn with the 'OliveBranch' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawOliveBranchCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Pearls

      See :ref:`Figure: Example of a circle drawn with the 'Pearls' style <figure_OECircleStyle_Pearls>`.

      .. _figure_OECircleStyle_Pearls:

      .. figure:: graphemetk/images/OECircleStyle_Pearls.*
         :align:  center

         **Example of a circle drawn with the 'Pearls' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawPearlsCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: RaceTrack

      See :ref:`Figure: Example of a circle drawn with the 'RaceTrack' style <figure_OECircleStyle_RaceTrack>`.

      .. _figure_OECircleStyle_RaceTrack:

      .. figure:: graphemetk/images/OECircleStyle_RaceTrack.*
         :align:  center

         **Example of a circle drawn with the 'RaceTrack' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawRaceTrackCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: RailroadTrack

      See :ref:`Figure: Example of a circle drawn with the 'RailroadTrack' style <figure_OECircleStyle_RailroadTrack>`.

      .. _figure_OECircleStyle_RailroadTrack:

      .. figure:: graphemetk/images/OECircleStyle_RailroadTrack.*
         :align:  center

         **Example of a circle drawn with the 'RailroadTrack' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawRailroadTrackCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Saw

      See :ref:`Figure: Example of a circle drawn with the 'Saw' style <figure_OECircleStyle_Saw>`.

      .. _figure_OECircleStyle_Saw:

      .. figure:: graphemetk/images/OECircleStyle_Saw.*
         :align:  center

         **Example of a circle drawn with the 'Saw' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawSawCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Simpson

      See :ref:`Figure: Example of a circle drawn with the 'Simpson' style <figure_OECircleStyle_Simpson>`.

      .. _figure_OECircleStyle_Simpson:

      .. figure:: graphemetk/images/OECircleStyle_Simpson.*
         :align:  center

         **Example of a circle drawn with the 'Simpson' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawSimpsonCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Stitch

      See :ref:`Figure: Example of a circle drawn with the 'Stitch' style <figure_OECircleStyle_Stitch>`.

      .. _figure_OECircleStyle_Stitch:

      .. figure:: graphemetk/images/OECircleStyle_Stitch.*
         :align:  center

         **Example of a circle drawn with the 'Stitch' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawStitchCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Sun

      See :ref:`Figure: Example of a circle drawn with the 'Sun' style <figure_OECircleStyle_Sun>`.

      .. _figure_OECircleStyle_Sun:

      .. figure:: graphemetk/images/OECircleStyle_Sun.*
         :align:  center

         **Example of a circle drawn with the 'Sun' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawSunCircle` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Wreath

      See :ref:`Figure: Example of a circle drawn with the 'Wreath' style <figure_OECircleStyle_Wreath>`.

      .. _figure_OECircleStyle_Wreath:

      .. figure:: graphemetk/images/OECircleStyle_Wreath.*
         :align:  center

         **Example of a circle drawn with the 'Wreath' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawWreathCircle` function


.. oe:namespace:: OEGrapheme

.. oe:constnamespace:: OEColorAtomStyle

   This namespace contains constants representing various styles color atoms
   can be depicted by the :oe:func:`OEGrapheme::OERenderShapeQuery` function.

   .. oe:constant:: Default

      The default color atom style is :oe:const:`OEGrapheme::OEColorAtomStyle::Circle`.

   .. oe:constant:: Hidden

      No color atoms are depicted.

   .. oe:constant:: Circle

      Each color atom is represented by a circle on the query (*i.e.* reference) molecule.
      If more than one color atom occupies the same space in 3D, the color atoms
      are represented by half, third, *etc* circles accordingly.
      See image in :ref:`Figure: Example of visualizing color atoms by circles<figure_OEColorAtomStyle_Circle>`.
      The color of each circle is defined by the :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>` object.

   .. _figure_OEColorAtomStyle_Circle:

   .. figure:: graphemetk/images/RenderShapeQuery.*
      :align:  center

      **Example of visualizing color atoms by circles**


.. _OEGraphemeConstants:

********************************
OEGrapheme Constants
********************************

.. oe:namespace:: OEGrapheme

.. toctree::

   OE2DPropMapSetup
   OEActiveSiteRenderStyle
   OECircleStyle
   OEColorAtomStyle
   OELegendLocation
   OEPatternDirection
   OEPeptideLabelStyle
   OEPlotMarkerStyle
   OEShapeOverlapDisplayStyle
   OESurfaceArcScale
   OESurfaceArcStyle


.. oe:namespace:: OEGrapheme

.. oe:constnamespace:: OELegendLocation

   This namespace contains constants representing the position of
   the legend displayed with the property map:

   .. seealso::

      * :oe:meth:`OEGrapheme::OE2DPropMap::GetLegendLocation` method
      * :oe:meth:`OEGrapheme::OE2DPropMap::SetLegendLocation` method

   The :oe:constns:`OEGrapheme::OELegendLocation` namespace contains the 
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default legend location is
      :oe:const:`OEGrapheme::OELegendLocation::Bottom`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bottom

      See example in :ref:`Figure: Example of property map with its legend located at the bottom<figure_OELegendLocation_Bottom>`.

      .. _figure_OELegendLocation_Bottom:

      .. figure:: graphemetk/images/OELegendLocation_Bottom.*
         :align:  center

         **Example of property map with the legend located at the bottom**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Hidden

      See example in :ref:`Figure: Example of property map with no legend<figure_OELegendLocation_Hidden>`.

      .. _figure_OELegendLocation_Hidden:

      .. figure:: graphemetk/images/OELegendLocation_Hidden.*
         :align:  center

         **Example of property map with no legend**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Left

      See example in :ref:`Figure: Example of property map with its legend located on the left<figure_OELegendLocation_Left>`.

      .. _figure_OELegendLocation_Left:

      .. figure:: graphemetk/images/OELegendLocation_Left.*
         :align:  center

         **Example of property map with the legend located on the left**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Right

      See example in :ref:`Figure: Example of property map with its legend located on the right<figure_OELegendLocation_Right>`.

      .. _figure_OELegendLocation_Right:

      .. figure:: graphemetk/images/OELegendLocation_Right.*
         :align:  center

         **Example of property map with the legend located on the right**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Top

      See example in :ref:`Figure: Example of property map with its legend located at the top<figure_OELegendLocation_Top>`

      .. _figure_OELegendLocation_Top:

      .. figure:: graphemetk/images/OELegendLocation_Top.*
         :align:  center

         **Example of property map with the legend located at the top**


.. oe:namespace:: OEGrapheme

.. oe:constnamespace:: OEPatternDirection

   The :oe:constns:`OEGrapheme::OEPatternDirection` namespace is used
   to customize various circle and arc drawing functions.

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawBrickRoadCircle` function
      * :oe:func:`OEGrapheme::OEDrawEyelashCircle` function
      * :oe:func:`OEGrapheme::OEDrawBrickRoadSurfaceArc` function
      * :oe:func:`OEGrapheme::OEDrawEyelashSurfaceArc` function

   The :oe:constns:`OEGrapheme::OEPatternDirection` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default pattern direction is
      :oe:const:`OEGrapheme::OEPatternDirection::Outside`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Inside

      See example in :ref:`Figure: Example of circle and arc drawing with patterns 'inside'<figure_OEPatternDirection_Inside>`.

      .. _figure_OEPatternDirection_Inside:

      .. figure:: graphemetk/images/OEPatternDirection_Inside.*
         :align:  center

         **Example of circle and arc drawing with patterns 'inside'**

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Outside

      See example in :ref:`Figure: Example of circle and arc drawing with patterns 'outside'<figure_OEPatternDirection_Outside>`.

      .. _figure_OEPatternDirection_Outside:

      .. figure:: graphemetk/images/OEPatternDirection_Outside.*
         :align:  center

         **Example of circle and arc drawing with patterns 'outside'**



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. oe:constnamespace:: OEPeptideLabelStyle

   .. warning::

      |DEPRECATED-API| 

   This namespace contains constants representing various label styles
   for peptide depiction.

   .. seealso::

      * :oe:meth:`OEGrapheme::OEPeptideDisplayOptions::GetLabelStyle` method
      * :oe:meth:`OEGrapheme::OEPeptideDisplayOptions::SetLabelStyle` method
      * :oe:func:`OEGrapheme::OEDrawPeptide` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SingleLetter

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ThreeLetters


.. oe:namespace:: OEGrapheme

.. oe:constnamespace:: OEPlotMarkerStyle

   This namespace contains constants representing various
   plot marker styles.

   .. seealso::

      * :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` class

   The :oe:constns:`OEGrapheme::OEPlotMarkerStyle` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   This namespace contains constants.

   .. oe:constant:: Default

      The default marker style is
      :oe:const:`OEGrapheme::OEPlotMarkerStyle::Circle`.

   .. oe:constant:: Circle

   .. oe:constant:: Square


.. oe:namespace:: OEGrapheme

.. oe:constnamespace:: OEShapeOverlapDisplayStyle

   This namespace contains constants representing various styles that
   can be used to depict shape overlays
   when calling the :oe:func:`OEGrapheme::OERenderShapeQuery` function.

   .. seealso::

      * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetOverlapDisplayStyle` method

   .. oe:constant:: Default

      The default shape overlap display style is
      :oe:const:`OEGrapheme::OEShapeOverlapDisplayStyle::PropertyMap`.

   .. oe:constant:: PropertyCloud

   .. _figure_OOEShapeOverlapDisplayStyle_PropertyCloud:

   .. figure:: graphemetk/images/OEShapeOverlapDisplayStyle_PropertyCloud.*
      :align:  center

      **Example of visualizing shape overlaps with PropertyCloud style**

   .. oe:constant:: PropertyMap

   .. _figure_OOEShapeOverlapDisplayStyle_PropertyMap:

   .. figure:: graphemetk/images/OEShapeOverlapDisplayStyle_PropertyMap.*
      :align:  center

      **Example of visualizing shape overlaps with PropertyMap style**


.. oe:namespace:: OEGrapheme

.. oe:constnamespace:: OESurfaceArcScale

   This namespace contains constants that determine the range of the
   radius scaling factor that can be used to generate the arcs
   of 2D molecule surfaces.

   .. _figure_OESurfaceArcScale:

   .. figure:: graphemetk/images/OEGet2DSurfaceArcs_OE2DAtomDisplay.*
      :align:  center

      **Example of various radius scales used to generate arcs**

   .. seealso::

      * :oe:func:`OEGrapheme::OEGet2DSurfaceArcs` function
      * :oe:func:`OEGrapheme::OEGetMoleculeSurfaceScale` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      Specifies the default radius scaling used to generate the arcs of
      the molecule surface when calling the
      :oe:func:`OEGrapheme::OEGet2DSurfaceArcs` function.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Maximum

      Specifies the maximum radius scaling that can be used to generate
      the arcs of the molecule surface of a specific atom when calling
      the :oe:func:`OEGrapheme::OEGet2DSurfaceArcs` function.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Minimum

      Specifies the minimum radius scaling that can be used to generate
      the arcs of the molecule surface of a specific atom when calling
      the :oe:func:`OEGrapheme::OEGet2DSurfaceArcs` function.



.. oe:namespace:: OEGrapheme

.. oe:constnamespace:: OESurfaceArcStyle

   This namespace contains constants representing various
   arc styles.

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawSurfaceArc` function

   The :oe:constns:`OEGrapheme::OESurfaceArcStyle` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AlphaRainbow

      See :ref:`Figure: Example of an arc drawn with the 'AlphaRainbow' style <figure_OESurfaceArcStyle_AlphaRainbow>`.

      .. _figure_OESurfaceArcStyle_AlphaRainbow:

      .. figure:: graphemetk/images/OESurfaceArcStyle_AlphaRainbow.*
         :align:  center

         **Example of an arc drawn with the 'AlphaRainbow' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawAlphaRainbowSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BrickRoad

      See :ref:`Figure: Example of an arc drawn with the 'BrickRoad' style <figure_OESurfaceArcStyle_BrickRoad>`.

      .. _figure_OESurfaceArcStyle_BrickRoad:

      .. figure:: graphemetk/images/OESurfaceArcStyle_BrickRoad.*
         :align:  center

         **Example of an arc drawn with the 'BrickRoad' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawBrickRoadSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Castle

      See :ref:`Figure: Example of an arc drawn with the 'Castle' style <figure_OESurfaceArcStyle_Castle>`.

      .. _figure_OESurfaceArcStyle_Castle:

      .. figure:: graphemetk/images/OESurfaceArcStyle_Castle.*
         :align:  center

         **Example of an arc drawn with the 'Castle' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawCastleSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Cog

      See :ref:`Figure: Example of an arc drawn with the 'Cog' style <figure_OESurfaceArcStyle_Cog>`.

      .. _figure_OESurfaceArcStyle_Cog:

      .. figure:: graphemetk/images/OESurfaceArcStyle_Cog.*
         :align:  center

         **Example of an arc drawn with the 'Cog' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawCogSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      See :ref:`Figure: Example of an arc drawn with the 'Default' style <figure_OESurfaceArcStyle_Default>`.

      .. _figure_OESurfaceArcStyle_Default:

      .. figure:: graphemetk/images/OESurfaceArcStyle_Default.*
         :align:  center

         **Example of an arc drawn with the 'Default' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawDefaultSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Eyelash

      See :ref:`Figure: Example of an arc drawn with the 'Eyelash' style <figure_OESurfaceArcStyle_Eyelash>`.

      .. _figure_OESurfaceArcStyle_Eyelash:

      .. figure:: graphemetk/images/OESurfaceArcStyle_Eyelash.*
         :align:  center

         **Example of an arc drawn with the 'Eyelash' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawEyelashSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Flower

      See :ref:`Figure: Example of an arc drawn with the 'Flower' style <figure_OESurfaceArcStyle_Flower>`.

      .. _figure_OESurfaceArcStyle_Flower:

      .. figure:: graphemetk/images/OESurfaceArcStyle_Flower.*
         :align:  center

         **Example of an arc drawn with the 'Flower' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawFlowerSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Necklace

      See :ref:`Figure: Example of an arc drawn with the 'Necklace' style <figure_OESurfaceArcStyle_Necklace>`.

      .. _figure_OESurfaceArcStyle_Necklace:

      .. figure:: graphemetk/images/OESurfaceArcStyle_Necklace.*
         :align:  center

         **Example of an arc drawn with the 'Necklace' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawNecklaceSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: OliveBranch

      See :ref:`Figure: Example of an arc drawn with the 'OliveBranch' style <figure_OESurfaceArcStyle_OliveBranch>`.

      .. _figure_OESurfaceArcStyle_OliveBranch:

      .. figure:: graphemetk/images/OESurfaceArcStyle_OliveBranch.*
         :align:  center

         **Example of an arc drawn with the 'OliveBranch' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawOliveBranchSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Pearls

      See :ref:`Figure: Example of an arc drawn with the 'Pearls' style <figure_OESurfaceArcStyle_Pearls>`.

      .. _figure_OESurfaceArcStyle_Pearls:

      .. figure:: graphemetk/images/OESurfaceArcStyle_Pearls.*
         :align:  center

         **Example of an arc drawn with the 'Pearls' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawPearlsSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: RaceTrack

      See :ref:`Figure: Example of an arc drawn with the 'RaceTrack' style <figure_OESurfaceArcStyle_RaceTrack>`.

      .. _figure_OESurfaceArcStyle_RaceTrack:

      .. figure:: graphemetk/images/OESurfaceArcStyle_RaceTrack.*
         :align:  center

         **Example of an arc drawn with the 'RaceTrack' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawRaceTrackSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: RailroadTrack

      See :ref:`Figure: Example of an arc drawn with the 'RailroadTrack' style <figure_OESurfaceArcStyle_RailroadTrack>`.

      .. _figure_OESurfaceArcStyle_RailroadTrack:

      .. figure:: graphemetk/images/OESurfaceArcStyle_RailroadTrack.*
         :align:  center

         **Example of an arc drawn with the 'RailroadTrack' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawRailroadTrackSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Saw

      See :ref:`Figure: Example of an arc drawn with the 'Saw' style <figure_OESurfaceArcStyle_Saw>`.

      .. _figure_OESurfaceArcStyle_Saw:

      .. figure:: graphemetk/images/OESurfaceArcStyle_Saw.*
         :align:  center

         **Example of an arc drawn with the 'Saw' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawSawSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Simpson

      See :ref:`Figure: Example of an arc drawn with the 'Simpson' style <figure_OESurfaceArcStyle_Simpson>`.

      .. _figure_OESurfaceArcStyle_Simpson:

      .. figure:: graphemetk/images/OESurfaceArcStyle_Simpson.*
         :align:  center

         **Example of an arc drawn with the 'Simpson' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawSimpsonSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Stitch

      See :ref:`Figure: Example of an arc drawn with the 'Stitch' style <figure_OESurfaceArcStyle_Stitch>`.

      .. _figure_OESurfaceArcStyle_Stitch:

      .. figure:: graphemetk/images/OESurfaceArcStyle_Stitch.*
         :align:  center

         **Example of an arc drawn with the 'Stitch' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawStitchSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Sun

      See :ref:`Figure: Example of an arc drawn with the 'Sun' style <figure_OESurfaceArcStyle_Sun>`.

      .. _figure_OESurfaceArcStyle_Sun:

      .. figure:: graphemetk/images/OESurfaceArcStyle_Sun.*
         :align:  center

         **Example of an arc drawn with the 'Sun' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawSunSurfaceArc` function

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Wreath

      See :ref:`Figure: Example of an arc drawn with the 'Wreath' style <figure_OESurfaceArcStyle_Wreath>`.

      .. _figure_OESurfaceArcStyle_Wreath:

      .. figure:: graphemetk/images/OESurfaceArcStyle_Wreath.*
         :align:  center

         **Example of an arc drawn with the 'Wreath' style**

      .. seealso::

         * :oe:func:`OEGrapheme::OEDrawWreathSurfaceArc` function



.. # split from OEGraphemeFunctions.rst:53

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEAddComplexSurfaceArcs

.. oe:function:: OEAddComplexSurfaceArcs

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddComplexSurfaceArcs(OEChem::OEMolBase& ligand,
                                      const OEChem::OEMolBase& protein,
                                      const OESurfaceArcFxnBase& solventExposedFxn = OEDefaultSolventArcFxn(),
                                      const OESurfaceArcFxnBase& buriedFxn = OEDefaultBuriedArcFxn(),
                                      const OEComplexSurfaceArcFxnBase& cavityFxn = OEDefaultCavityArcFxn(),
                                      const OEComplexSurfaceArcFxnBase& voidFxn = OEDefaultVoidArcFxn())

   .. oe:language:: python

      .. oe:api:: python

         OEAddComplexSurfaceArcs(ligand: Union[OEGraphMol,OEMol,OEQMol],
                                 protein: Union[OEGraphMol,OEMol,OEQMol],
                                 solventExposedFxn: OESurfaceArcFxnBase = OEDefaultSolventArcFxn(),
                                 buriedFxn: OESurfaceArcFxnBase = OEDefaultBuriedArcFxn(),
                                 cavityFxn: OEComplexSurfaceArcFxnBase = OEDefaultCavityArcFxn(),
                                 voidFxn: OEComplexSurfaceArcFxnBase = OEDefaultVoidArcFxn()) -> bool

   Takes a ligand-protein complex and generates the 2D molecule
   surface of the ligand, where the arcs of the surface are annotated
   based on the distance calculated between the accessible surface of
   the ligand and the protein.
   See :ref:`Figure: Example of surface drawing with the OEAddComplexSurfaceArcs function<figure_OEAddComplexSurfaceArcs>`.

   *ligand*
      The molecule for which the 2D surface is generated.
      Must have 3D coordinates and VDW radii assigned.

   *protein*
      The macromolecule whose contact with the ligand influences
      the surface drawing.
      Must have 3D coordinates and VDW radii assigned.

   *solventExposedFxn*
      This functor is used to draw those arc segments of the 2D
      molecule surface where the ligand is exposed to the solvent
      in the 3D complex.
      By default, the :ref:`OEDefaultSolventArcFxn <OEGrapheme_OEDefaultSolventArcFxn>`
      functor is used.

   *buriedFxn*
      This functor is used to draw those arc segments of the 2D
      molecule surface where the ligand and the protein tightly fit
      in the 3D complex.
      By default, the :ref:`OEDefaultBuriedArcFxn <OEGrapheme_OEDefaultBuriedArcFxn>`
      functor is used.

   *cavityFxn*
      This functor is used to draw those arc segments of the 2D
      molecule surface where there is a cavity detected between the
      ligand and the protein in the 3D complex.
      By default, the :ref:`OEDefaultCavityArcFxn <OEGrapheme_OEDefaultCavityArcFxn>`
      functor is used.

   *voidFxn*
      This functor is used to draw those arc segments of the 2D
      molecule surface where there is a small gap detected between
      the ligand and the protein in the 3D complex.
      By default, the :ref:`OEDefaultVoidArcFxn <OEGrapheme_OEDefaultVoidArcFxn>`
      functor is used.

   .. _figure_OEAddComplexSurfaceArcs:

   .. figure:: graphemetk/images/DrawComplexSurface.*
      :align:  center

      **Example of surface drawing with the OEAddComplexSurfaceArcs function**

   .. seealso::

      * :ref:`chapter_complex_surface` chapter



.. # split from OEGraphemeFunctions.rst:121

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEAddGlyph

.. oe:function:: OEAddGlyph

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddGlyph(OEDepict::OE2DMolDisplay& disp,
                         const OEAtomGlyphBase& atomglyph,
                         const OEChem::OEMatchBase& match)
         void OEAddGlyph(OEDepict::OE2DMolDisplay& disp,
                         const OEAtomGlyphBase& atomglyph,
                         const OEChem::OEAtomBondSet& abset)
         void OEAddGlyph(OEDepict::OE2DMolDisplay& disp,
                         const OEAtomGlyphBase& atomglyph,
                         const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred)

   .. oe:language:: python

      .. oe:api:: python

         OEAddGlyph(disp: OE2DMolDisplay, atomglyph: OEAtomGlyphBase,
                    match: OEMatchBase) -> None
         OEAddGlyph(disp: OE2DMolDisplay, atomglyph: OEAtomGlyphBase,
                    abset: OEAtomBondSet) -> None
         OEAddGlyph(disp: OE2DMolDisplay, atomglyph: OEAtomGlyphBase,
                    pred: OEUnaryAtomPred) -> None

   Annotates atoms with the style implemented in the given
   :ref:`OEAtomGlyphBase <OEGrapheme_OEAtomGlyphBase>` object.
   The atoms being annotated can be specified either by an
   :ref:`OEMatchBase <OEChem_OEMatchBase>` or an :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`
   object or by an atom predicate.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object whose atoms are being
      annotated.

   *atomglyph*
      Specifies the style of the annotation.
      Each atom is being annotated by calling the
      :oe:meth:`OEGrapheme::OEAtomGlyphBase::RenderGlyph` method.

   *match*
      :oe:func:`OEGrapheme::OEAddGlyph` function annotates the
      target atoms of the :ref:`OEMatchBase <OEChem_OEMatchBase>` object.

   *abset*
      :oe:func:`OEGrapheme::OEAddGlyph` function annotates the
      atoms returned by the :oe:cls:`OEChem::OEAtomBondSet::GetAtoms`
      method.

   *pred*
      :oe:func:`OEGrapheme::OEAddGlyph` function annotates
      only atoms for which the given atom predicate returns `true`.

   .. seealso::

      * :ref:`chapter_annotation` chapter
      * :ref:`OEAtomGlyphBase <OEGrapheme_OEAtomGlyphBase>` class
      * :ref:`OEAtomGlyphCircle <OEGrapheme_OEAtomGlyphCircle>` class

   .. ################################################################

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddGlyph(OEDepict::OE2DMolDisplay& disp,
                         const OEBondGlyphBase& bondglyph,
                         const OEChem::OEMatchBase& match)
         void OEAddGlyph(OEDepict::OE2DMolDisplay& disp,
                         const OEBondGlyphBase& bondglyph,
                         const OEChem::OEAtomBondSet& abset)
         void OEAddGlyph(OEDepict::OE2DMolDisplay& disp,
                         const OEBondGlyphBase& bondglyph,
                         const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& pred)

   .. oe:language:: python

      .. oe:api:: python

         OEAddGlyph(disp: OE2DMolDisplay, bondglyph: OEBondGlyphBase,
                    match: OEMatchBase) -> None
         OEAddGlyph(disp: OE2DMolDisplay, bondglyph: OEBondGlyphBase,
                    abset: OEAtomBondSet) -> None
         OEAddGlyph(disp: OE2DMolDisplay, bondglyph: OEBondGlyphBase,
                    pred: OEUnaryBondPred) -> None

   Annotates bonds with the style implemented in the given
   :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>` object.
   The bond being annotated can be specified either by an
   :ref:`OEMatchBase <OEChem_OEMatchBase>` or an :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`
   object or by a bond predicate.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object whose bonds are being
      annotated.

   *bondglyph*
      Specifies the style of the annotation.
      Each bond is being annotated by calling the
      :oe:meth:`OEGrapheme::OEBondGlyphBase::RenderGlyph` method.

   *match*
      :oe:func:`OEGrapheme::OEAddGlyph` function annotates the
      target bonds of the :ref:`OEMatchBase <OEChem_OEMatchBase>` object.

   *abset*
      :oe:func:`OEGrapheme::OEAddGlyph` function annotates the
      bonds returned by the :oe:cls:`OEChem::OEAtomBondSet::GetBonds`
      method.

   *pred*
      :oe:func:`OEGrapheme::OEAddGlyph` function annotates
      only bonds for which the given bond predicate returns `true`.

   .. seealso::

      * :ref:`chapter_annotation` chapter
      * :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>` class
      * :ref:`OEBondGlyphArrow <OEGrapheme_OEBondGlyphArrow>`
      * :ref:`OEBondGlyphCircle <OEGrapheme_OEBondGlyphCircle>`
      * :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>` class
      * :ref:`OEBondGlyphCurvedArrow <OEGrapheme_OEBondGlyphCurvedArrow>` class
      * :ref:`OEBondGlyphScissors <OEGrapheme_OEBondGlyphScissors>` class



.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEAddLigandHighlighting

.. oe:function:: OEAddLigandHighlighting

   Highlights atoms and/or bonds of the displayed ligand.

   .. list-table:: **The overloaded versions of the OEAddLigandHighlighting function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OEAddLigandHighlighting(disp, highlight, atompred)<api_OEAddLigandHighlighting_OE2DActiveSiteDisplay_AtomPred>`
        - highlights ligand atoms with :ref:`OEHighlightBase <OEDepict_OEHighlightBase>`
      * - :ref:`OEAddLigandHighlighting(adisp, highlight, bondpred)<api_OEAddLigandHighlighting_OE2DActiveSiteDisplay_BondPred>`
        - highlights ligand bonds  with :ref:`OEHighlightBase <OEDepict_OEHighlightBase>`
      * - :ref:`OEAddLigandHighlighting(adisp, highlight, atompred, bondpred)<api_OEAddLigandHighlighting_OE2DActiveSiteDisplay_AtomAndBondPred>`
        - highlights ligand atoms and bonds  with :ref:`OEHighlightBase <OEDepict_OEHighlightBase>`
      * - :ref:`OEAddLigandHighlighting(adisp, highlight, match)<api_OEAddLigandHighlighting_OE2DActiveSiteDisplay_OEMatchBase>`
        - highlights ligand atoms and bonds of a match  with :ref:`OEHighlightBase <OEDepict_OEHighlightBase>`
      * - :ref:`OEAddLigandHighlighting(adisp, highlight, abset)<api_OEAddLigandHighlighting_OE2DActiveSiteDisplay_OEAtomBondSet>`
        - highlights ligand atoms and bonds of a set with :ref:`OEHighlightBase <OEDepict_OEHighlightBase>`

   **Parameters :**

   *adisp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object of which ligand atoms
      add/or ligand bonds being highlighted.

   *highlight*
      The :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` object that specifies the style of the highlighting.

   *atompred*
      :oe:func:`OEGrapheme::OEAddLigandHighlighting` function highlights
      only ligand atoms for which the given atom predicate returns `true`.

   *bondpred*
      :oe:func:`OEGrapheme::OEAddLigandHighlighting` function highlights
      only ligand bonds for which the given bond predicate returns `true`.

   *match*
      :oe:func:`OEGrapheme::OEAddLigandHighlighting` function highlights the
      target atoms and bonds of the :ref:`OEMatchBase <OEChem_OEMatchBase>` object.

   *abset*
      Stores the ligand atoms and bonds being highlighted.

   .. seealso::

      * :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` class
      * :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` class
      * :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>` class
      * :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>` class
      * :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>` class

   #. Highlighting using **atom** and **bond predicates**:

      .. _api_OEAddLigandHighlighting_OE2DActiveSiteDisplay_AtomPred:

      .. oe:api::

         void OEAddLigandHighlighting(OE2DActiveSiteDisplay& adisp,
                                      const OEDepict::OEHighlightBase& highlight,
                                      const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& atompred)

      Highlights ligand atoms with the style implemented in the given :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` object.
      The atoms being highlighted are specified by given atom predicate.

      .. _api_OEAddLigandHighlighting_OE2DActiveSiteDisplay_BondPred:

      .. oe:api::

         void OEAddLigandHighlighting(OE2DActiveSiteDisplay& adisp,
                                      const OEDepict::OEHighlightBase& highlight,
                                      const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& bondpred)

      Highlights ligand bonds with the style implemented in the given :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` object.
      The bonds being highlighted are specified by given bond predicates.

      .. _api_OEAddLigandHighlighting_OE2DActiveSiteDisplay_AtomAndBondPred:

      .. oe:api::

         void OEAddLigandHighlighting(OE2DActiveSiteDisplay& adisp,
                                      const OEDepict::OEHighlightBase& highlight,
                                      const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& atompred,
                                      const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& bondpred)

      Highlights ligand atoms and bonds with the style implemented in the given :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` object.
      The atoms and bonds being highlighted are specified by given atom and bond predicates, respectively.

      **Example:** (See image generated in :ref:`figure_OEAddLigandHighlighting_Predicate` and
      :ref:`figure_OEAddLigandHighlighting_AtomAndBondPredicate` )

      .. oe:source:: ActiveSiteHighlight.py
         :language: python
         :noindent:
         :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-PREDICATE

      ..    oe:language:: python

            :ref:`Full listing. <listing-ActiveSiteHighlight.py>`

      .. oe:source:: ActiveSiteHighlight.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-PREDICATE

      .. oe:source:: ActiveSiteHighlight.java
         :language: java
         :noindent:
         :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-PREDICATE

      .. oe:source:: ActiveSiteHighlight.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-PREDICATE

   .. _figure_OEAddLigandHighlighting_Predicate:

   .. figure:: graphemetk/images/OEAddHighlighting-ActiveSite-Predicate.*
      :align:  center

      **Example of highlighting 6-membered rings of a ligand using 'ball and stick' style**

   .. _figure_OEAddLigandHighlighting_AtomAndBondPredicate:

   .. figure:: graphemetk/images/OEAddHighlighting-ActiveSite-AtomAndBondPredicate.*
      :align:  center

      **Example of highlighting 6-membered rings of a ligand using 'color' style**

   .. seealso::

      * :ref:`chapter_predicates` chapter in the *OEChem TK* manual

   #. Highlighting using an :ref:`OEMatchBase <OEChem_OEMatchBase>` object that is
      initialized by substructure search or maximum common substructure search:

      .. _api_OEAddLigandHighlighting_OE2DActiveSiteDisplay_OEMatchBase:

      .. oe:api::

         void OEAddLigandHighlighting(OE2DActiveSiteDisplay& adisp,
                                      const OEDepict::OEHighlightBase& highlight,
                                      const OEChem::OEMatchBase& match)

      **Example:** (See image generated in :ref:`figure_OEAddLigandHighlighting_OEMatch`)

      .. oe:source:: ActiveSiteHighlight.py
         :language: python
         :noindent:
         :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-OEMATCH

      ..    oe:language:: python

            :ref:`Full listing. <listing-ActiveSiteHighlight.py>`

      .. oe:source:: ActiveSiteHighlight.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-OEMATCH

      .. oe:source:: ActiveSiteHighlight.java
         :language: java
         :noindent:
         :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-OEMATCH

      .. oe:source:: ActiveSiteHighlight.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-OEMATCH

   .. _figure_OEAddLigandHighlighting_OEMatch:

   .. figure:: graphemetk/images/OEAddHighlighting-ActiveSite-OEMatch.*
      :align:  center

      **Example of highlighting 6-membered rings of a ligand using 'lasso' style**

   #. Highlighting using an :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object that stores
      the atoms and bonds being highlighted:

      .. _api_OEAddLigandHighlighting_OE2DActiveSiteDisplay_OEAtomBondSet:

      .. oe:api::

         void OEAddLigandHighlighting(OE2DActiveSiteDisplay& adisp,
                                      const OEDepict::OEHighlightBase& highlight,
                                      const OEChem::OEAtomBondSet& abset)

      **Example:** (See image generated in :ref:`figure_OEAddLigandHighlighting_OEAtomBondSet`)

      .. oe:source:: ActiveSiteHighlight.py
         :language: python
         :noindent:
         :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-OEATOMBONDSET

      :ref:`Full listing. <listing-ActiveSiteHighlight.py>`

      .. oe:source:: ActiveSiteHighlight.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-OEATOMBONDSET

      .. oe:source:: ActiveSiteHighlight.java
         :language: java
         :noindent:
         :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-OEATOMBONDSET

      .. oe:source:: ActiveSiteHighlight.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-OEATOMBONDSET

   .. _figure_OEAddLigandHighlighting_OEAtomBondSet:

   .. figure:: graphemetk/images/OEAddHighlighting-ActiveSite-OEAtomBondSet.*
      :align:  center

      **Example of highlighting 6-membered rings of a ligand using 'cogwheel' style**


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEAddResidueHighlighting

.. oe:function:: OEAddResidueHighlighting

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEAddResidueHighlighting(OE2DActiveSiteDisplay& adisp,
                                       const OEDepict::OEPen& pen,
                                       const OEChem::OEResidue& residue)

   .. oe:language:: python

      .. oe:api:: python

         OEAddResidueHighlighting(adisp: OE2DActiveSiteDisplay, pen: OEPen,
                                  residue: OEResidue) -> None

   Highlights the given residues in the active site display.

   *adisp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object of which residues
      being highlighted.
   *pen*
      The :ref:`OEPen <OEDepict_OEPen>` object that specifies the style of the highlighting.

   *residue*
      The residue being highlighted.

   **Example:** (See image generated in :ref:`figure_OEAddResidueHighlighting`)

   The :oe:func:`OESystem::OEGetLightColors` function in the below example returns
   eight colors that is used to highlight only the first eight residues in the generated
   image.

   .. oe:source:: ActiveSiteHighlight.py
      :language: python
      :noindent:
      :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-OERESIDUE

   .. oe:source:: ActiveSiteHighlight.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-OERESIDUE

   .. oe:source:: ActiveSiteHighlight.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-OERESIDUE

   .. oe:source:: ActiveSiteHighlight.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ACTIVESITE-OEADDHIGHLIGHTING-OERESIDUE

   .. _figure_OEAddResidueHighlighting:

   .. figure:: graphemetk/images/OEAddHighlighting-ActiveSite-OEResidue.*
      :align:  center

      **Example of highlighting residues**


.. # split from OEGraphemeFunctions.rst:230

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEClearSurfaceArcFxn

.. oe:function:: OEClearSurfaceArcFxn

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEClearSurfaceArcFxn(OEChem::OEAtomBase* atom)

   .. oe:language:: python

      .. oe:api:: python

         OEClearSurfaceArcFxn(atom: OEAtomBase) -> None

   Removes the surface drawing functor previously added to the atom.

   .. seealso::

      * :oe:func:`OEGrapheme::OEGet2DSurfaceArcs` function
      * :oe:func:`OEGrapheme::OEGetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEHasSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function



.. # split from OEGraphemeFunctions.rst:250

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEConfigure2DPropMap

.. oe:function:: OEConfigure2DPropMap

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigure2DPropMap(OESystem::OEInterface& itf,
                                   unsigned int config = OE2DPropMapSetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigure2DPropMap(itf: OEInterface, config: int) -> bool

   Configures the given interface to add property map style
   parameters.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface
      This value has to be from the
      :oe:constns:`OEGrapheme::OE2DPropMapSetup` namespace.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEGrapheme::OE2DPropMapSetup` namespace



.. # split from OEGraphemeFunctions.rst:279

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDraw2DSurface

.. oe:function:: OEDraw2DSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDraw2DSurface(OEDepict::OE2DMolDisplay& disp)

   .. oe:language:: python

      .. oe:api:: python

         OEDraw2DSurface(disp: OE2DMolDisplay) -> bool

   Calculates the arc segments of the molecule surface and
   draws the arcs into the molecule display using the functor
   previously added to the atoms
   (by calling :oe:func:`OEGrapheme::OESetSurfaceArcFxn`).
   See :ref:`Figure: Example of drawing a molecule surface using the OEDraw2DSurface function<figure_OEDraw2DSurface>`.

   *disp*
      The molecule display on which the 2D molecule surface is drawn.

   .. note::

      If no surface drawing functor is set to the atoms, then
      the :ref:`OEDefaultArcFxn <OEGrapheme_OEDefaultArcFxn>` functor will be used
      by default.

   .. _figure_OEDraw2DSurface:

   .. figure:: graphemetk/images/OEDraw2DSurface.*
      :align:  center

      **Example of drawing a molecule surface using the OEDraw2DSurface function**

   .. seealso::

      * :ref:`chapter_draw_surface` chapter
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn`

   .. ########################################################################

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDraw2DSurface(OEDepict::OE2DMolDisplay& disp,
                              const OEDepict::OE2DMolDisplay& refdisp)

   .. oe:language:: python

      .. oe:api:: python

         OEDraw2DSurface(disp: OE2DMolDisplay, refdisp: OE2DMolDisplay) -> bool

   Allows a molecule surface to be generated on one molecule display but drawn
   into another display.
   See :ref:`Figure: Example of using OEDraw2DSurface with reference molecule display<figure_OEDraw2DSurfaceReference>`.

   *disp*
     The molecule display on which the 2D molecule surface is drawn.

   *refdisp*
     The molecule display for which the 2D molecule surface is calculated.

   .. _figure_OEDraw2DSurfaceReference:

   .. figure:: graphemetk/images/OEDraw2DSurfaceReference.*
      :align:  center

      **Example of using OEDraw2DSurface with reference molecule display**

   .. seealso::

      * :ref:`chapter_draw_surface` chapter
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn`



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawActiveSiteLegend

.. _OEGrapheme_OEDrawActiveSiteLegend:

.. oe:function:: OEDrawActiveSiteLegend

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawActiveSiteLegend(OEDepict::OEImageBase& image,
                                     const OE2DActiveSiteDisplay& adisp,
                                     const OE2DActiveSiteLegendDisplayOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawActiveSiteLegend(image: OEImageBase,
                                adisp: OE2DActiveSiteDisplay,
                                opts: OE2DActiveSiteLegendDisplayOptions) -> None

   Draws legend for active site interaction map.

   *image*
      The image on which the color force field legend is drawn.

   *adisp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object that holds the data
      necessary to depict the interactions of an active site.

   *opts*
      The :ref:`OE2DActiveSiteLegendDisplayOptions <OEGrapheme_OE2DActiveSiteLegendDisplayOptions>` object that
      determines how the legend is depicted.

   The following code snippet shows how to use the :oe:func:`OEGrapheme::OEDrawActiveSiteLegend`
   function. The image created is shown in
   :ref:`Figure: Example of using the OEDrawActiveSiteLegend function<figure_draw_active_site_legend>`.

   .. oe:source:: DrawActiveSiteLegend.py
      :language: python
      :noindent:
      :frag:     SNIPPET-DRAW-ACTIVE-SITE-LEGEND

   ..    oe:language:: python

         :ref:`Full listing. <listing-DrawActiveSiteLegend.py>`

   .. oe:source:: DrawActiveSiteLegend.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-DRAW-ACTIVE-SITE-LEGEND

   .. oe:source:: DrawActiveSiteLegend.java
      :language: java
      :noindent:
      :frag:     SNIPPET-DRAW-ACTIVE-SITE-LEGEND

   .. oe:source:: DrawActiveSiteLegend.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-DRAW-ACTIVE-SITE-LEGEND

   .. _figure_draw_active_site_legend:

   .. figure:: graphemetk/images/DrawActiveSiteLegend.*
      :align:  center

      **Example of using the OEDrawActiveSiteLegend function**

   .. note::

      The :ref:`OEDrawActiveSiteLegend <OEGrapheme_OEDrawActiveSiteLegend>` function renders
      only those residue "glyphs" that are used to depict the interactions
      of the given active site when calling the :oe:func:`OEGrapheme::OERenderActiveSite`
      function.

   .. seealso::

      * :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` class
      * :ref:`OE2DActiveSiteLegendDisplayOptions <OEGrapheme_OE2DActiveSiteLegendDisplayOptions>` class

   .. admonition:: Code Example

      * `Visualizing Protein-Ligand Interactions`_ **OpenEye Python Cookbook** recipe
      * :ref:`section_examples_summary_complex2img` example



.. # split from OEGraphemeFunctions.rst:415

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawAlphaRainbowCircle

.. oe:function:: OEDrawAlphaRainbowCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawAlphaRainbowCircle(OEDepict::OEImageBase& image,
                                       const OEDepict::OE2DPoint& center,
                                       double radius,
                                       const OEDepict::OEPen& pen,
                                       unsigned int patternDirection = OEPatternDirection::Outside)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawAlphaRainbowCircle(image: OEImageBase, c: OE2DPoint,
                                  radius: float, pen: OEPen,
                                  patternDirection: int) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::AlphaRainbow` style.
   See :ref:`Figure: OEDrawAlphaRainbowCircle<figure_draw_circle_alpha_rainbow>`.

   .. _figure_draw_circle_alpha_rainbow:

   .. figure:: graphemetk/images/OEDrawAlphaRainbowCircle.*
      :align:  center

      **OEDrawAlphaRainbowCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See example (A) and (B) in :ref:`Figure: OEDrawAlphaRainbowCircle<figure_draw_circle_alpha_rainbow>`.

   *patternDirection*
     |circle_pattern_dir|
     This value has to be from the :oe:constns:`OEGrapheme::OEPatternDirection` namespace.

     See example (C) in :ref:`Figure: OEDrawAlphaRainbowCircle<figure_draw_circle_alpha_rainbow>`.



.. # split from OEGraphemeFunctions.rst:459

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawAlphaRainbowSurfaceArc

.. oe:function:: OEDrawAlphaRainbowSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawAlphaRainbowSurfaceArc(OEDepict::OEImageBase& image,
                                           const OEDepict::OE2DPoint& center,
                                           double bgnAngle, double endAngle,
                                           double radius,
                                           const OEDepict::OEPen& pen,
                                           double edgeAngle = 10.0,
                                           unsigned int patternDirection = OEPatternDirection::Outside)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawAlphaRainbowSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                      bgnAngle: float, endAngle: float,
                                      radius: float, pen: OEPen,
                                      edgeAngle: float = 10.0,
                                      patternDirection: int) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::AlphaRainbow` style.
   See :ref:`Figure: OEDrawAlphaRainbowSurfaceArc<figure_draw_surface_arc_alpha_rainbow>`.

   .. _figure_draw_surface_arc_alpha_rainbow:

   .. figure:: graphemetk/images/OEDrawAlphaRainbowSurfaceArc.*
      :align:  center

      **OEDrawAlphaRainbowSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawAlphaRainbowSurfaceArc<figure_draw_surface_arc_alpha_rainbow>`.

   *patternDirection*
     |arc_pattern_dir|
     This value has to be from the :oe:constns:`OEGrapheme::OEPatternDirection` namespace.

     See example (C) in :ref:`Figure: OEDrawAlphaRainbowSurfaceArc<figure_draw_surface_arc_alpha_rainbow>`.

   .. seealso::

      * :ref:`OEAlphaRainbowArcFxn <OEGrapheme_OEAlphaRainbowArcFxn>` class




.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. oe:function:: OEDrawBFactorMapLegend

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawBFactorMapLegend(OEDepict::OEImageBase& image,
                                     const OE2DActiveSiteDisplay& adisp)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawBFactorMapLegend(image: OEImageBase,
                                adisp: OE2DActiveSiteDisplay) -> bool

   Draws the color gradient that is used to visualize B-factor information of
   an active site by the :oe:func:`OEGrapheme::OERenderBFactorMap` function.

   *image*
      The image in which the color gradient is drawn.

   *adisp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object that holds the
      data necessary to depict the B-factor information of an active site.

   **Example:**

   .. oe:source:: RenderBFactorMap.py
      :language: python
      :noindent:
      :frag:     SNIPPET-DRAW-BFACTORMAP-LEGEND

   ..    oe:language:: python

         :ref:`Full listing. <listing-RenderBFactorMap.py>`

   .. oe:source:: RenderBFactorMap.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-DRAW-BFACTORMAP-LEGEND

   .. oe:source:: RenderBFactorMap.java
      :language: java
      :noindent:
      :frag:     SNIPPET-DRAW-BFACTORMAP-LEGEND

   .. oe:source:: RenderBFactorMap.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-DRAW-BFACTORMAP-LEGEND

   .. figure:: graphemetk/images/DrawBFactorMapLegend.*
      :align:  center
      :width: 300 pt

      **Example of using the OEDrawBFactorMapLegend function**

   .. seealso::

      * :oe:func:`OEGrapheme::OERenderBFactorMap` function
      * :oe:func:`OEGrapheme::OEDrawColorGradient` function

   .. admonition:: Code Example

      * `Visualizing Protein-Ligand B-Factor`_ **OpenEye Python Cookbook** recipe


.. # split from OEGraphemeFunctions.rst:515

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawBrickRoadCircle

.. oe:function:: OEDrawBrickRoadCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawBrickRoadCircle(OEDepict::OEImageBase& image,
                                    const OEDepict::OE2DPoint& center,
                                    double radius, const OEDepict::OEPen& pen,
                                    unsigned int patternDirection = OEPatternDirection::Outside,
                                    double patternAngle = 20.0,
                                    double patternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawBrickRoadCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                               pen: OEPen, patternDirection: int,
                               patternAngle: float = 20.0,
                               patternWidthRatio: float = 0.15) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::BrickRoad` style.
   See :ref:`Figure: OEDrawBrickRoadCircle<figure_draw_circle_brick_road>`.

   .. _figure_draw_circle_brick_road:

   .. figure:: graphemetk/images/OEDrawBrickRoadCircle.*
      :align:  center

      **OEDrawBrickRoadCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawBrickRoadCircle<figure_draw_circle_brick_road>`.

   *patternDirection*
     |circle_pattern_dir|
     This value has to be from the :oe:constns:`OEGrapheme::OEPatternDirection` namespace.

     See example (C) in :ref:`Figure: OEDrawBrickRoadCircle<figure_draw_circle_brick_road>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (D) in :ref:`Figure: OEDrawBrickRoadCircle<figure_draw_circle_brick_road>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (E) in :ref:`Figure: OEDrawBrickRoadCircle<figure_draw_circle_brick_road>`.



.. # split from OEGraphemeFunctions.rst:571

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawBrickRoadSurfaceArc

.. oe:function:: OEDrawBrickRoadSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawBrickRoadSurfaceArc(OEDepict::OEImageBase& image,
                                        const OEDepict::OE2DPoint& center,
                                        double bgnAngle, double endAngle,
                                        double radius,
                                        const OEDepict::OEPen& pen,
                                        double edgeAngle = 10.0,
                                        unsigned int patternDirection = OEPatternDirection::Outside,
                                        double patternAngle = 20.0,
                                        double minPatternWidthRatio = 0.15,
                                        double maxPatternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawBrickRoadSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                   bgnAngle: float, endAngle: float,
                                   radius: float, pen: OEPen,
                                   edgeAngle: float = 10.0,
                                   patternDirection: int,
                                   patternAngle: float = 20.0,
                                   minPatternWidthRatio: float = 0.15,
                                   maxPatternWidthRatio: float = 0.15) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::BrickRoad` style.

   .. _figure_draw_surface_arc_brick_road:

   .. figure:: graphemetk/images/OEDrawBrickRoadSurfaceArc.*
      :align:  center

      **OEDrawBrickRoadSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawBrickRoadSurfaceArc<figure_draw_surface_arc_brick_road>`.

   *patternDirection*
     |arc_pattern_dir|
     This value has to be from the :oe:constns:`OEGrapheme::OEPatternDirection` namespace.

     See example (C) in :ref:`Figure: OEDrawBrickRoadSurfaceArc<figure_draw_surface_arc_brick_road>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (D) in :ref:`Figure: OEDrawBrickRoadSurfaceArc<figure_draw_surface_arc_brick_road>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (E) and (F) in :ref:`Figure: OEDrawBrickRoadSurfaceArc<figure_draw_surface_arc_brick_road>`.

   .. seealso::

      * :ref:`OEBrickRoadArcFxn <OEGrapheme_OEBrickRoadArcFxn>` class



.. # split from OEGraphemeFunctions.rst:638

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawCastleCircle

.. oe:function:: OEDrawCastleCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawCastleCircle(OEDepict::OEImageBase& image,
                                 const OEDepict::OE2DPoint& center,
                                 double radius, const OEDepict::OEPen& pen,
                                 double patternAngle = 15.0,
                                 double patternWidthRatio = 0.20)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawCastleCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                            pen: OEPen, patternAngle: float = 15.0,
                            patternWidthRatio: float = 0.20) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Castle` style.

   .. _figure_draw_circle_castle:

   .. figure:: graphemetk/images/OEDrawCastleCircle.*
      :align:  center

      **OEDrawCastleCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawCastleCircle<figure_draw_circle_castle>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawCastleCircle<figure_draw_circle_castle>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (D) in :ref:`Figure: OEDrawCastleCircle<figure_draw_circle_castle>`.



.. # split from OEGraphemeFunctions.rst:685

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawCastleSurfaceArc

.. oe:function:: OEDrawCastleSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawCastleSurfaceArc(OEDepict::OEImageBase& image,
                                     const OEDepict::OE2DPoint& center,
                                     double bgnAngle, double endAngle,
                                     double radius, const OEDepict::OEPen& pen,
                                     double edgeAngle = 10.0,
                                     double patternAngle = 15.0,
                                     double minPatternWidthRatio = 0.20,
                                     double maxPatternWidthRatio = 0.20)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawCastleSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                bgnAngle: float, endAngle: float,
                                radius: float, pen: OEPen,
                                edgeAngle: float = 10.0,
                                patternAngle: float = 15.0,
                                minPatternWidthRatio: float = 0.20,
                                maxPatternWidthRatio: float = 0.20) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::Castle` style.

   .. _figure_draw_surface_arc_castle:

   .. figure:: graphemetk/images/OEDrawCastleSurfaceArc.*
      :align:  center

      **OEDrawCastleSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawCastleSurfaceArc<figure_draw_surface_arc_castle>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawCastleSurfaceArc<figure_draw_surface_arc_castle>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (D) and (E) in :ref:`Figure: OEDrawCastleSurfaceArc<figure_draw_surface_arc_castle>`.

   .. seealso::

      * :ref:`OECastleArcFxn <OEGrapheme_OECastleArcFxn>` class



.. # split from OEGraphemeFunctions.rst:745

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawCircle

.. oe:function:: OEDrawCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawCircle(OEDepict::OEImageBase& image, unsigned int style,
                           const OEDepict::OE2DPoint& center, double radius,
                           const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawCircle(image: OEImageBase, style: int, c: OE2DPoint,
                      radius: float, pen: OEPen = OEBlackPen) -> bool

   Draws a circle with the given style.

   *image*
     The image on which the circle is drawn.

   *style*
     Specifies the style of the circle.
     This value has to be from the :oe:constns:`OEGrapheme::OECircleStyle` namespace.

   *center*
     The center of the circle.

   *radius*
     The radius of the circle.

   *pen*
     The graphical properties of the circle.



.. # split from OEGraphemeFunctions.rst:777

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawCogCircle

.. oe:function:: OEDrawCogCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawCogCircle(OEDepict::OEImageBase& image,
                              const OEDepict::OE2DPoint& center, double radius,
                              const OEDepict::OEPen& pen,
                              double patternAngle = 15.0,
                              double patternWidthRatio = 0.20)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawCogCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                         pen: OEPen, patternAngle: float = 15.0,
                         patternWidthRatio: float = 0.20) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Cog` style.

   .. _figure_draw_circle_cog:

   .. figure:: graphemetk/images/OEDrawCogCircle.*
      :align:  center

      **OEDrawCogCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawCogCircle<figure_draw_circle_cog>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawCogCircle<figure_draw_circle_cog>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (D) in :ref:`Figure: OEDrawCogCircle<figure_draw_circle_cog>`.



.. # split from OEGraphemeFunctions.rst:824

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawCogSurfaceArc

.. oe:function:: OEDrawCogSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawCogSurfaceArc(OEDepict::OEImageBase& image,
                                  const OEDepict::OE2DPoint& center,
                                  double bgnAngle, double endAngle,
                                  double radius, const OEDepict::OEPen& pen,
                                  double edgeAngle = 10.0,
                                  double patternAngle = 15.0,
                                  double minPatternWidthRatio = 0.20,
                                  double maxPatternWidthRatio = 0.20)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawCogSurfaceArc(image: OEImageBase, c: OE2DPoint, bgnAngle: float,
                             endAngle: float, radius: float, pen: OEPen,
                             edgeAngle: float = 10.0,
                             patternAngle: float = 15.0,
                             minPatternWidthRatio: float = 0.20,
                             maxPatternWidthRatio: float = 0.20) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::Cog` style.

   .. _figure_draw_surface_arc_cog:

   .. figure:: graphemetk/images/OEDrawCogSurfaceArc.*
      :align:  center

      **OEDrawCogSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawCogSurfaceArc<figure_draw_surface_arc_cog>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawCogSurfaceArc<figure_draw_surface_arc_cog>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (D) and (E) in :ref:`Figure: OEDrawCogSurfaceArc<figure_draw_surface_arc_cog>`.

   .. seealso::

      * :ref:`OECogArcFxn <OEGrapheme_OECogArcFxn>` class



.. # split from OEGraphemeFunctions.rst:884

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawColorForceFieldLegend

.. oe:function:: OEDrawColorForceFieldLegend

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawColorForceFieldLegend(OEDepict::OEImageBase& image,
                                          const OEColorForceFieldDisplay& cffdisp,
                                          const OEColorForceFieldLegendDisplayOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawColorForceFieldLegend(image: OEImageBase,
                                     cffdisp: OEColorForceFieldDisplay,
                                     opts: OEColorForceFieldLegendDisplayOptions) -> None

   Draws a legend of the color force field.

   *image*
     The image on which the color force field legend is drawn.

   *cffdisp*
     The :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>` object
     that holds the data necessary to depict the color force field.

   *opts*
     The :ref:`OEColorForceFieldLegendDisplayOptions <OEGrapheme_OEColorForceFieldLegendDisplayOptions>` object
     that determine how the legend of color force field is depicted.

   The following code snippet shows how to use the :oe:func:`OEGrapheme::OEDrawColorForceFieldLegend`
   function. The image created is shown in
   :ref:`Figure: Example of using the OEDrawColorForceFieldLegend function<figure_draw_color_force_field_legend>`.

   .. oe:source:: DrawColorForceFieldLegend.py
      :language: python
      :noindent:
      :frag:     SNIPPET-DRAW-COLOR-FORCE-FIELD-LEGEND

   ..    oe:language:: python

         :ref:`Full listing. <listing-DrawColorForceFieldLegend.py>`

   .. oe:source:: DrawColorForceFieldLegend.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-DRAW-COLOR-FORCE-FIELD-LEGEND

   .. oe:source:: DrawColorForceFieldLegend.java
      :language: java
      :noindent:
      :frag:     SNIPPET-DRAW-COLOR-FORCE-FIELD-LEGEND

   .. oe:source:: DrawColorForceFieldLegend.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-DRAW-COLOR-FORCE-FIELD-LEGEND

   .. _figure_draw_color_force_field_legend:

   .. figure:: graphemetk/images/DrawColorForceFieldLegend.*
      :align:  center

      **Example of using the OEDrawColorForceFieldLegend function**

   .. seealso::

      * :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>` class
      * :ref:`OEColorForceFieldLegendDisplayOptions <OEGrapheme_OEColorForceFieldLegendDisplayOptions>` class



.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawColorGradient

.. oe:function:: OEDrawColorGradient

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawColorGradient(OEDepict::OEImageBase& image,
                                  const OESystem::OEColorGradientBase& colorg)
         void OEDrawColorGradient(OEDepict::OEImageBase& image,
                                  const OESystem::OEColorGradientBase& colorg,
                                  const OEColorGradientDisplayOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawColorGradient(image: OEImageBase, colorg: OEColorGradientBase) -> None
         OEDrawColorGradient(image: OEImageBase, colorg: OEColorGradientBase,
                             opts: OEColorGradientDisplayOptions) -> None

   Draws a color gradient.

   *image*
      The image on which the color gradient is drawn.

   *colorg*
      The color gradient being drawn.

   *opts*
      The :ref:`OEColorGradientDisplayOptions <OEGrapheme_OEColorGradientDisplayOptions>` object that
      stores the parameters that determine how the color gradient is drawn.

   The following code snippet shows how to use the :oe:func:`OEGrapheme::OEDrawColorGradient`
   function. The image created is shown in
   :ref:`Figure: Example of using the OEDrawColorGradient function<figure_draw_color_gradient>`.

   .. oe:source:: DrawColorGradient.py
      :language: python
      :noindent:
      :frag:     SNIPPET-DRAW-COLOR-GRADIENT

   .. oe:language:: python

      :ref:`Full listing. <listing-DrawColorGradient.py>`

   .. oe:source:: DrawColorGradient.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-DRAW-COLOR-GRADIENT

   .. oe:source:: DrawColorGradient.java
      :language: java
      :noindent:
      :frag:     SNIPPET-DRAW-COLOR-GRADIENT

   .. oe:source:: DrawColorGradient.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-DRAW-COLOR-GRADIENT

   .. _figure_draw_color_gradient:

   .. figure:: graphemetk/images/DrawColorGradient.*
      :align:  center

      **Example of using the OEDrawColorGradient function**

   The orientation (*i.e.*, whether the color gradient is rendered vertically or
   horizontally) depends on the width and height of the :ref:`OEImageBase <OEDepict_OEImageBase>` object.
   If the width is greater than the height, then the color gradient is drawn
   horizontally; otherwise it is rendered vertically .
   See examples in :ref:`Figure: Example of rendering the same color gradient into different dimensions<figure_draw_color_gradient_orientation>`.

   .. _figure_draw_color_gradient_orientation:

   .. figure:: graphemetk/images/OEDrawColorGradient_Orientation.*
      :align:  center

      **Example of rendering the same color gradient into different dimensions**

   The :oe:func:`OEGrapheme::OEDrawColorGradient` function can depict any color gradient
   derived from the :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>` base class.
   See examples in :ref:`Figure: Example of rendering various color gradients<figure_draw_color_gradient_non_linear>`.

   .. _figure_draw_color_gradient_non_linear:

   .. figure:: graphemetk/images/OEDrawColorGradient_NonLinear.*
      :align:  center

      **Example of rendering various color gradients**

   .. seealso::

      * :ref:`OEColorGradientDisplayOptions <OEGrapheme_OEColorGradientDisplayOptions>` class
      * :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>` base class
      * :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>`,
        :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>`,
        :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>`, and
        :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` concrete classes



.. # split from OEGraphemeFunctions.rst:1040

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawDefaultCircle

.. oe:function:: OEDrawDefaultCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawDefaultCircle(OEDepict::OEImageBase& image,
                                  const OEDepict::OE2DPoint& center,
                                  double radius, const OEDepict::OEPen& pen)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawDefaultCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                             pen: OEPen) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Default` style.

   .. _figure_draw_circle_default:

   .. figure:: graphemetk/images/OEDrawDefaultCircle.*
      :align:  center

      **OEDrawDefaultCircle**

   *image*
     The image on which the circle is drawn.

   *center*
     The center of the circle.

   *radius*
     The radius of the circle.

   *pen*
     The graphical properties of the circle.

     See examples in :ref:`Figure: OEDrawDefaultCircle<figure_draw_circle_default>`.



.. # split from OEGraphemeFunctions.rst:1076

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawDefaultSurfaceArc

.. oe:function:: OEDrawDefaultSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawDefaultSurfaceArc(OEDepict::OEImageBase& image,
                                      const OEDepict::OE2DPoint& center,
                                      double bgnAngle, double endAngle,
                                      double radius, const OEDepict::OEPen& pen)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawDefaultSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                 bgnAngle: float, endAngle: float,
                                 radius: float, pen: OEPen) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::Default` style.

   .. _figure_draw_surface_arc_default:

   .. figure:: graphemetk/images/OEDrawDefaultSurfaceArc.*
      :align:  center

      **OEDrawDefaultSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   .. seealso::

      * :ref:`OEDefaultArcFxn <OEGrapheme_OEDefaultArcFxn>` class


.. # split from OEGraphemeFunctions.rst:1118

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawEyelashCircle

.. oe:function:: OEDrawEyelashCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawEyelashCircle(OEDepict::OEImageBase& image,
                                  const OEDepict::OE2DPoint& center,
                                  double radius, const OEDepict::OEPen& pen,
                                  unsigned int patternDirection = OEPatternDirection::Outside,
                                  double patternAngle = 10.0,
                                  double patternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawEyelashCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                             pen: OEPen, patternDirection: int,
                             patternAngle: float = 10.0,
                             patternWidthRatio: float = 0.15) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Eyelash` style.

   .. _figure_draw_circle_eyelash:

   .. figure:: graphemetk/images/OEDrawEyelashCircle.*
      :align:  center

      **OEDrawEyelashCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawEyelashCircle<figure_draw_circle_eyelash>`.

   *patternDirection*
     |circle_pattern_dir|
     This value has to be from the :oe:constns:`OEGrapheme::OEPatternDirection` namespace.

     See example (C) in :ref:`Figure: OEDrawEyelashCircle<figure_draw_circle_eyelash>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (D) in :ref:`Figure: OEDrawEyelashCircle<figure_draw_circle_eyelash>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (E) in :ref:`Figure: OEDrawEyelashCircle<figure_draw_circle_eyelash>`.



.. # split from OEGraphemeFunctions.rst:1173

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawEyelashSurfaceArc

.. oe:function:: OEDrawEyelashSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawEyelashSurfaceArc(OEDepict::OEImageBase& image,
                                      const OEDepict::OE2DPoint& center,
                                      double bgnAngle, double endAngle,
                                      double radius,
                                      const OEDepict::OEPen& pen,
                                      double edgeAngle = 10.0,
                                      unsigned int patternDirection = OEPatternDirection::Outside,
                                      double patternAngle = 10.0,
                                      double minPatternWidthRatio = 0.15,
                                      double maxPatternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawEyelashSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                 bgnAngle: float, endAngle: float,
                                 radius: float, pen: OEPen,
                                 edgeAngle: float = 10.0,
                                 patternDirection: int,
                                 patternAngle: float = 10.0,
                                 minPatternWidthRatio: float = 0.15,
                                 maxPatternWidthRatio: float = 0.15) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::Eyelash` style.

   .. _figure_draw_surface_arc_eyelash:

   .. figure:: graphemetk/images/OEDrawEyelashSurfaceArc.*
      :align:  center

      **OEDrawEyelashSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawEyelashSurfaceArc<figure_draw_surface_arc_eyelash>`.

   *patternDirection*
     |arc_pattern_dir|
     This value has to be from the :oe:constns:`OEGrapheme::OEPatternDirection` namespace.

     See example (C) in :ref:`Figure: OEDrawEyelashSurfaceArc<figure_draw_surface_arc_eyelash>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (D) in :ref:`Figure: OEDrawEyelashSurfaceArc<figure_draw_surface_arc_eyelash>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (E) and (F) in :ref:`Figure: OEDrawEyelashSurfaceArc<figure_draw_surface_arc_eyelash>`.

   .. seealso::

      * :ref:`OEEyelashArcFxn <OEGrapheme_OEEyelashArcFxn>` class



.. # split from OEGraphemeFunctions.rst:1240

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawFlowerCircle

.. oe:function:: OEDrawFlowerCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawFlowerCircle(OEDepict::OEImageBase& image,
                                 const OEDepict::OE2DPoint& center,
                                 double radius, const OEDepict::OEPen& pen,
                                 double patternAngle = 30.0)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawFlowerCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                            pen: OEPen, patternAngle: float = 30.0) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Flower` style.

   .. _figure_draw_circle_flower:

   .. figure:: graphemetk/images/OEDrawFlowerCircle.*
      :align:  center

      **OEDrawFlowerCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawFlowerCircle<figure_draw_circle_flower>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawFlowerCircle<figure_draw_circle_flower>`.



.. # split from OEGraphemeFunctions.rst:1281

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawFlowerSurfaceArc

.. oe:function:: OEDrawFlowerSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawFlowerSurfaceArc(OEDepict::OEImageBase& image,
                                     const OEDepict::OE2DPoint& center,
                                     double bgnAngle, double endAngle,
                                     double radius, const OEDepict::OEPen& pen,
                                     double edgeAngle = 10.0,
                                     double patternAngle = 30.0,
                                     double minPatternWidthRatio = 0.20,
                                     double maxPatternWidthRatio = 0.20)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawFlowerSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                bgnAngle: float, endAngle: float,
                                radius: float, pen: OEPen,
                                edgeAngle: float = 10.0,
                                patternAngle: float = 30.0,
                                minPatternWidthRatio: float = 0.20,
                                maxPatternWidthRatio: float = 0.20) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::Flower` style.

   .. _figure_draw_surface_arc_flower:

   .. figure:: graphemetk/images/OEDrawFlowerSurfaceArc.*
      :align:  center

      **OEDrawFlowerSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawFlowerSurfaceArc<figure_draw_surface_arc_flower>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawFlowerSurfaceArc<figure_draw_surface_arc_flower>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (D) and (E) in :ref:`Figure: OEDrawFlowerSurfaceArc<figure_draw_surface_arc_flower>`.

   .. seealso::

      * :ref:`OEFlowerArcFxn <OEGrapheme_OEFlowerArcFxn>` class



.. # split from OEGraphemeFunctions.rst:1341

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawGreekKeyCircle

.. oe:function:: OEDrawGreekKeyCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawGreekKeyCircle(OEDepict::OEImageBase& image,
                                   const OEDepict::OE2DPoint& center,
                                   double radius, const OEDepict::OEPen& pen,
                                   double patternAngle = 15.0,
                                   double patternWidthRatio = 0.20)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawGreekKeyCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                              pen: OEPen, patternAngle: float = 15.0,
                              patternWidthRatio: float = 0.20) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::GreekKey` style.

   .. _figure_draw_circle_greek_key:

   .. figure:: graphemetk/images/OEDrawGreekKeyCircle.*
      :align:  center

      **OEDrawGreekKeyCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawGreekKeyCircle<figure_draw_circle_greek_key>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawGreekKeyCircle<figure_draw_circle_greek_key>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (D) in :ref:`Figure: OEDrawGreekKeyCircle<figure_draw_circle_greek_key>`.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. oe:function:: OEDrawIridiumData

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawIridiumData(OEDepict::OEImageBase& image,
                                const OEBio::OEDesignUnit& du)
         bool OEDrawIridiumData(OEDepict::OEImageBase& image,
                                const OEBio::OEIridiumData& iridium)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawIridiumData(image: OEImageBase, du: OEDesignUnit) -> bool
         OEDrawIridiumData(image: OEImageBase, iridium: OEIridiumData) -> bool

   Renders the Iridium data into an easily interpretable graph.

   *image*
     The image on which the Iridium data graph is drawn.

   *du*
     The :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object of which Iridium data is
     being rendered.

   *iridium*
     The :ref:`OEIridiumData <OEBio_OEIridiumData>` object that is being rendered.

   .. oe:language:: c++ python

      **Example:**

      The following code snippet shows how to use the :oe:func:`OEGrapheme::OEDrawIridiumData`
      function. The image created is shown in
      :ref:`Figure: Example of using the OEDrawIridiumData function<figure_draw_iridium>`.

      .. oe:source:: DrawIridiumData.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-DRAW-IRIDIUM-DATA

      .. oe:source:: DrawIridiumData.py
         :language: python
         :noindent:
         :frag:     SNIPPET-DRAW-IRIDIUM-DATA

   .. _figure_draw_iridium:

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover cursor over graph</b>
         </p>

         <p align="center">
         <object data="../../_images/DrawIridiumData.svg" type="image/svg+xml"  width = "300" ></object>
         <p>

         <p align="center">
         <b>Example of using the OEDrawIridiumData function</b>
         <p>

      .. image:: /_images/DrawIridiumData.svg
         :width: 1pt

   .. only:: oepdf

      .. figure:: graphemetk/images/DrawIridiumData.*
         :align:  center

         **Example of using the OEDrawIridiumData function**

   .. note::

      When generating :file:`.svg` image, the output will be interactive.
      With any other image file format it will be static.
      See also :ref:`chapter_svg` chapter in **OEDepict TK** manual.

   .. seealso::

      * :ref:`chapter_sprucetk_iridium` chapter in **OESpruce TK** manual
      * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class
      * :ref:`OEIridiumData <OEBio_OEIridiumData>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawMonomer

.. oe:function:: OEDrawMonomer

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawMonomer(OEDepict::OEImageBase& image,
                            const OEChem::OEMonomer& monomer)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawMonomer(image: OEImageBase, monomer: OEMonomer) -> bool

   Draws a monomer highlighting its attachment points.

   *image*
     The image on which the monomer is drawn (:oe:cls:`OEDepict::OEImage`).

   *monomer*
      The monomer being draw (:oe:cls:`OEChem::OEMonomer`).

   **Example:**

   .. oe:source:: DrawMonomer.py
      :language: python
      :noindent:
      :frag:     SNIPPET-DRAW-MONOMER

   .. oe:source:: DrawMonomer.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-DRAW-MONOMER

   .. _figure_OEDraw2Monomer:

   .. figure:: graphemetk/images/DrawMonomer.*
      :width: 300
      :align:  center

      **Example of using OEDrawMonomer function**

   .. admonition:: Code Example

      * `Depict Monomer`_ **OpenEye Python Cookbook** recipe



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawMonomerGraph

.. oe:function:: OEDrawMonomerGraph

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawMonomerGraph(OEDepict::OEImageBase& image,
                                 const OEChem::OEMolBase& mol)
         bool OEDrawMonomerGraph(OEDepict::OEImageBase& image,
                                 const OEChem::OEMolBase& mol,
                                 const OEMonomerGraphDisplayOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawMonomerGraph(image: OEImageBase,
                            mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
         OEDrawMonomerGraph(image: OEImageBase,
                            mol: Union[OEGraphMol,OEMol,OEQMol],
                            opts: OEMonomerGraphDisplayOptions) -> bool

   The :oe:func:`OEGrapheme::OEDrawMonomerGraph` function is designed to depict the monomer graph of
   a molecule initialized from a :term:`HELM` string.

   *image*
     The image on which the molecule is drawn.

   *mol*
      The molecule being depicted.

   *opts*
      The :oe:cls:`OEGrapheme::OEMonomerGraphDisplayOptions` object that stores
      properties that determine the styles of the molecule depiction.

   **Example:**

   .. oe:source:: DrawMonomerGraph.py
      :language: python
      :noindent:
      :frag:     SNIPPET-DRAW-MONOMER-GRAPH

   .. oe:source:: DrawMonomerGraph.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-DRAW-MONOMER-GRAPH

   .. _figure_draw_monomer_graph:

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover cursor over graph</b>
         </p>

         <p align="center">
         <object data="../../_images/DrawMonomerGraph.svg" type="image/svg+xml"  width = "500" ></object>
         <p>

         <p align="center">
         <b>Example of using the OEDrawMonomerGraph function</b>
         <p>

      .. image:: /_images/DrawMonomerGraph.svg
         :width: 1pt

   .. only:: oepdf

      .. figure:: graphemetk/images/DrawMonomerGraph.*
         :align:  center

         **Example of using the OEDrawMonomerGraph function**

   .. seealso::

      * :oe:func:`OEChem::OEHelmToMol` function
      * :oe:func:`OEGrapheme::OEHighlightMonomers` function to depict the molecules initialized from HELM
      * :oe:func:`OEGrapheme::OEDrawPeptide` function to depict a peptide with standard amino acids
      * :oe:func:`OEGrapheme::OEDrawResidues` function to depict residues of peptides

   .. admonition:: Code Example

      * `Depict Peptide`_ **OpenEye Python Cookbook** recipe



.. # split from OEGraphemeFunctions.rst:1388

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawNecklaceCircle

.. oe:function:: OEDrawNecklaceCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawNecklaceCircle(OEDepict::OEImageBase& image,
                                   const OEDepict::OE2DPoint& center,
                                   double radius, const OEDepict::OEPen& pen,
                                   double patternAngle = 20.0,
                                   double patternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawNecklaceCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                              pen: OEPen, patternAngle: float = 20.0,
                              patternWidthRatio: float = 0.15) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Necklace` style.

   .. _figure_draw_circle_necklace:

   .. figure:: graphemetk/images/OEDrawNecklaceCircle.*
      :align:  center

      **OEDrawNecklaceCircle**

   *image*
     The image on which the circle is drawn.

   *center*
     The center of the circle.

   *radius*
     The radius of the circle.

   *pen*
     The graphical properties of the circle.

     See examples (A) and (B) in :ref:`Figure: OEDrawNecklaceCircle<figure_draw_circle_necklace>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawNecklaceCircle<figure_draw_circle_necklace>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (D) in :ref:`Figure: OEDrawNecklaceCircle<figure_draw_circle_necklace>`.



.. # split from OEGraphemeFunctions.rst:1435

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawNecklaceSurfaceArc

.. oe:function:: OEDrawNecklaceSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawNecklaceSurfaceArc(OEDepict::OEImageBase& image,
                                       const OEDepict::OE2DPoint& center,
                                       double bgnAngle, double endAngle,
                                       double radius,
                                       const OEDepict::OEPen& pen,
                                       double edgeAngle = 10.0,
                                       double patternAngle = 20.0,
                                       double minPatternWidthRatio = 0.15,
                                       double maxPatternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawNecklaceSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                  bgnAngle: float, endAngle: float,
                                  radius: float, pen: OEPen,
                                  edgeAngle: float = 10.0,
                                  patternAngle: float = 20.0,
                                  minPatternWidthRatio: float = 0.15,
                                  maxPatternWidthRatio: float = 0.15) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::Necklace` style.

   .. _figure_draw_surface_arc_necklace:

   .. figure:: graphemetk/images/OEDrawNecklaceSurfaceArc.*
      :align:  center

      **OEDrawNecklaceSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawNecklaceSurfaceArc<figure_draw_surface_arc_necklace>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawNecklaceSurfaceArc<figure_draw_surface_arc_necklace>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (D) and (E) in :ref:`Figure: OEDrawNecklaceSurfaceArc<figure_draw_surface_arc_necklace>`.

   .. seealso::

      * :ref:`OENecklaceArcFxn <OEGrapheme_OENecklaceArcFxn>` class



.. # split from OEGraphemeFunctions.rst:1495

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawOliveBranchCircle

.. oe:function:: OEDrawOliveBranchCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawOliveBranchCircle(OEDepict::OEImageBase& image,
                                      const OEDepict::OE2DPoint& center,
                                      double radius,
                                      const OEDepict::OEPen& pen,
                                      double patternAngle = 15.0,
                                      double patternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawOliveBranchCircle(image: OEImageBase, c: OE2DPoint,
                                 radius: float, pen: OEPen,
                                 patternAngle: float = 15.0,
                                 patternWidthRatio: float = 0.15) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::OliveBranch` style.

   .. _figure_draw_circle_olive_branch:

   .. figure:: graphemetk/images/OEDrawOliveBranchCircle.*
      :align:  center

      **OEDrawOliveBranchCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawOliveBranchCircle<figure_draw_circle_olive_branch>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawOliveBranchCircle<figure_draw_circle_olive_branch>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (D) in :ref:`Figure: OEDrawOliveBranchCircle<figure_draw_circle_olive_branch>`.

   .. seealso::

      * :ref:`OEOliveBranchArcFxn <OEGrapheme_OEOliveBranchArcFxn>` class



.. # split from OEGraphemeFunctions.rst:1547

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawOliveBranchSurfaceArc

.. oe:function:: OEDrawOliveBranchSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawOliveBranchSurfaceArc(OEDepict::OEImageBase& image,
                                          const OEDepict::OE2DPoint& center,
                                          double bgnAngle, double endAngle,
                                          double radius,
                                          const OEDepict::OEPen& pen,
                                          double edgeAngle = 10.0,
                                          double patternAngle = 15.0,
                                          double minPatternWidthRatio = 0.15,
                                          double maxPatternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawOliveBranchSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                     bgnAngle: float, endAngle: float,
                                     radius: float, pen: OEPen,
                                     edgeAngle: float = 10.0,
                                     patternAngle: float = 15.0,
                                     minPatternWidthRatio: float = 0.15,
                                     maxPatternWidthRatio: float = 0.15) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::OliveBranch` style.

   .. _figure_draw_surface_arc_olive_branch:

   .. figure:: graphemetk/images/OEDrawOliveBranchSurfaceArc.*
      :align:  center

      **OEDrawOliveBranchSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawOliveBranchSurfaceArc<figure_draw_surface_arc_olive_branch>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawOliveBranchSurfaceArc<figure_draw_surface_arc_olive_branch>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (D) and (E) in :ref:`Figure: OEDrawOliveBranchSurfaceArc<figure_draw_surface_arc_olive_branch>`.



.. # split from OEGraphemeFunctions.rst:1603

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawPearlsCircle

.. oe:function:: OEDrawPearlsCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawPearlsCircle(OEDepict::OEImageBase& image,
                                 const OEDepict::OE2DPoint& center,
                                 double radius, const OEDepict::OEPen& pen,
                                 double patternAngle = 15.0)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawPearlsCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                            pen: OEPen, patternAngle: float = 15.0) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Pearls` style.

   .. _figure_draw_circle_pearls:

   .. figure:: graphemetk/images/OEDrawPearlsCircle.*
      :align:  center

      **OEDrawPearlsCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawPearlsCircle<figure_draw_circle_pearls>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawPearlsCircle<figure_draw_circle_pearls>`.



.. # split from OEGraphemeFunctions.rst:1644

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawPearlsSurfaceArc

.. oe:function:: OEDrawPearlsSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawPearlsSurfaceArc(OEDepict::OEImageBase& image,
                                     const OEDepict::OE2DPoint& center,
                                     double bgnAngle, double endAngle,
                                     double radius, const OEDepict::OEPen& pen,
                                     double edgeAngle = 10.0,
                                     double patternAngle = 25.0,
                                     double minPatternWidthRatio = 0.20,
                                     double maxPatternWidthRatio = 0.20)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawPearlsSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                bgnAngle: float, endAngle: float,
                                radius: float, pen: OEPen,
                                edgeAngle: float = 10.0,
                                patternAngle: float = 25.0,
                                minPatternWidthRatio: float = 0.20,
                                maxPatternWidthRatio: float = 0.20) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::Pearls` style.

   .. _figure_draw_surface_arc_pearls:

   .. figure:: graphemetk/images/OEDrawPearlsSurfaceArc.*
      :align:  center

      **OEDrawPearlsSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawPearlsSurfaceArc<figure_draw_surface_arc_pearls>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawPearlsSurfaceArc<figure_draw_surface_arc_pearls>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (D) and (E) in :ref:`Figure: OEDrawPearlsSurfaceArc<figure_draw_surface_arc_pearls>`.

   .. seealso::

      * :ref:`OEPearlsArcFxn <OEGrapheme_OEPearlsArcFxn>` class




.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawPeptide

.. oe:function:: OEDrawPeptide

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawPeptide(OEDepict::OEImageBase& image,
                            const OEChem::OEMolBase& mol)
         bool OEDrawPeptide(OEDepict::OEImageBase& image,
                            const OEChem::OEMolBase& mol,
                            const OEPeptideDisplayOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawPeptide(image: OEImageBase, mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
         OEDrawPeptide(image: OEImageBase, mol: Union[OEGraphMol,OEMol,OEQMol],
                       opts: OEPeptideDisplayOptions) -> bool

   Draws a molecule after performing substitutions in which standard
   amino acids components identified in the molecule are replaced by
   corresponding circular glyphs.

   *image*
     The image on which the molecule is drawn.

   *mol*
      The molecule being depicted.

   *opts*
      The :ref:`OEPeptideDisplayOptions <OEGrapheme_OEPeptideDisplayOptions>` object that stores
      properties that determine the styles of the peptide depiction.

   .. note::

      * The :oe:func:`OEGrapheme::OEDrawPeptide` implementation does not support
        visualizing large proteins. The number of heavy atoms is limited to 250.
      * The :oe:func:`OEGrapheme::OEDrawPeptide` only support standard  L-amino acids and there
        D-amino acid enantiomers.

   **Example:**

   The following code snippet shows how to use the :oe:func:`OEGrapheme::OEDrawPeptide`
   function to generate an interactive SVG image. The image created is shown in
   :ref:`Figure: Example of using the OEDrawPeptide function<figure_draw_peptide>`.

   .. oe:source:: DrawPeptide.py
      :language: python
      :noindent:
      :frag:     SNIPPET-DRAW-PEPTIDE

   ..    oe:language:: python

         :ref:`Full listing. <listing-DrawPeptide.py>`

   .. oe:source:: DrawPeptide.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-DRAW-PEPTIDE

   .. oe:source:: DrawPeptide.java
      :language: java
      :noindent:
      :frag:     SNIPPET-DRAW-PEPTIDE

   .. oe:source:: DrawPeptide.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-DRAW-PEPTIDE

   .. _figure_draw_peptide:

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover mouse over any amino acid circles</b>
         </p>

         <p align="center">
         <object data="../../_images/DrawPeptide.svg" type="image/svg+xml"  width = "500" ></object>
         <p>

         <p align="center">
         <b>Example of using the OEDrawPeptide function to generate an interactive SVG image</b>
         <p>

      .. image:: /_images/DrawPeptide.svg
         :width: 1pt

   .. only:: oepdf

      .. figure:: graphemetk/images/DrawPeptide.*
         :align:  center

         **Example of using the OEDrawPeptide function**

   .. note::

      This `interactive` functionality is **only available** for :file:`.svg`
      image format.

      The generated :file:`svg` image should be included into and
      HTML page with the SVG MIME type.

      .. code-block:: console

         <object data="<imagename>.svg" type="image/svg+xml"></object>

   .. seealso::

      * :ref:`OEPeptideDisplayOptions <OEGrapheme_OEPeptideDisplayOptions>` class
      * :oe:func:`OEGrapheme::OEDrawResidues` function to depict residues of peptides
      * :oe:func:`OEGrapheme::OEDrawMonomerGraph` and :oe:func:`OEGrapheme::OEHighlightMonomers` functions to depict molecules initialized from HELM
      * :ref:`chapter_svg` chapter in **OEDepict TK** manual



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawROCSScores

.. oe:function:: OEDrawROCSScores

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawROCSScores(OEDepict::OEImageBase& image,
                               const std::vector<double>& scores)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawROCSScores(image: OEImageBase, scores: OEDoubleVector) -> None

   Renders the scores into a radial graph.

   *image*
     The image on which the radial graph of the scores is drawn.

   *scores*
     The vector of scores. The scores will expected in the following order
     - shape overlap score
     - color overlap score
     - 2D similarity score (optional)

   .. note::

      All scores are expected to be in the range of :math:`[0.0, 1.0]`.
      This :math:`[0.0, 1.0]` range is transformed to :math:`[0.0^{\circ} - 360.0^{\circ}]`
      angles when representing the scores in the diagram.

   .. oe:source:: DrawROCSScores.py
      :language: python
      :noindent:
      :frag:     SNIPPET-DRAW-ROCS-SCORES

   .. oe:source:: DrawROCSScores.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-DRAW-ROCS-SCORES

   .. oe:source:: DrawROCSScores.java
      :language: java
      :noindent:
      :frag:     SNIPPET-DRAW-ROCS-SCORES

   .. oe:source:: DrawROCSScores.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-DRAW-ROCS-SCORES

   .. _figure_draw_rocs_scores:

   .. figure:: graphemetk/images/DrawROCSScores.*
      :align:  center

      **Example of using the OEDrawROCSScores function**

   .. admonition:: Code Example

      * :ref:`section_examples_summary_shapeoverlap2pdf` example
      * `Visualizing Shape and Color Overlap`_ **OpenEye Python Cookbook** recipe



.. # split from OEGraphemeFunctions.rst:1705

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawRaceTrackCircle

.. oe:function:: OEDrawRaceTrackCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawRaceTrackCircle(OEDepict::OEImageBase& image,
                                    const OEDepict::OE2DPoint& center,
                                    double radius, const OEDepict::OEPen& pen)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawRaceTrackCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                               pen: OEPen) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::RaceTrack` style.

   .. _figure_draw_circle_race_track:

   .. figure:: graphemetk/images/OEDrawRaceTrackCircle.*
      :align:  center

      **OEDrawRaceTrackCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawRaceTrackCircle<figure_draw_circle_race_track>`.



.. # split from OEGraphemeFunctions.rst:1741

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawRaceTrackSurfaceArc

.. oe:function:: OEDrawRaceTrackSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawRaceTrackSurfaceArc(OEDepict::OEImageBase& image,
                                        const OEDepict::OE2DPoint& center,
                                        double bgnAngle, double endAngle,
                                        double radius,
                                        const OEDepict::OEPen& pen,
                                        double edgeAngle = 10.0)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawRaceTrackSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                   bgnAngle: float, endAngle: float,
                                   radius: float, pen: OEPen,
                                   edgeAngle: float = 10.0) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::RaceTrack` style.

   .. _figure_draw_surface_arc_race_track:

   .. figure:: graphemetk/images/OEDrawRaceTrackSurfaceArc.*
      :align:  center

      **OEDrawRaceTrackSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawRaceTrackSurfaceArc<figure_draw_surface_arc_race_track>`.

   .. seealso::

      * :ref:`OERaceTrackArcFxn <OEGrapheme_OERaceTrackArcFxn>` class



.. # split from OEGraphemeFunctions.rst:1789

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawRailroadTrackCircle

.. oe:function:: OEDrawRailroadTrackCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawRailroadTrackCircle(OEDepict::OEImageBase& image,
                                        const OEDepict::OE2DPoint& center,
                                        double radius,
                                        const OEDepict::OEPen& pen,
                                        double patternAngle = 10.0,
                                        double patternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawRailroadTrackCircle(image: OEImageBase, c: OE2DPoint,
                                   radius: float, pen: OEPen,
                                   patternAngle: float = 10.0,
                                   patternWidthRatio: float = 0.15) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::RailroadTrack` style.

   .. _figure_draw_circle_railroad_track:

   .. figure:: graphemetk/images/OEDrawRailroadTrackCircle.*
      :align:  center

      **OEDrawRailroadTrackCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawRailroadTrackCircle<figure_draw_circle_railroad_track>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawRailroadTrackCircle<figure_draw_circle_railroad_track>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (D) in :ref:`Figure: OEDrawRailroadTrackCircle<figure_draw_circle_railroad_track>`.



.. # split from OEGraphemeFunctions.rst:1837

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawRailroadTrackSurfaceArc

.. oe:function:: OEDrawRailroadTrackSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawRailroadTrackSurfaceArc(OEDepict::OEImageBase& image,
                                            const OEDepict::OE2DPoint& center,
                                            double bgnAngle, double endAngle,
                                            double radius,
                                            const OEDepict::OEPen& pen,
                                            double edgeAngle = 10.0,
                                            double patternAngle = 10.0,
                                            double minPatternWidthRatio = 0.15,
                                            double maxPatternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawRailroadTrackSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                       bgnAngle: float, endAngle: float,
                                       radius: float, pen: OEPen,
                                       edgeAngle: float = 10.0,
                                       patternAngle: float = 10.0,
                                       minPatternWidthRatio: float = 0.15,
                                       maxPatternWidthRatio: float = 0.15) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::RailroadTrack` style.

   .. _figure_draw_surface_arc_railroad_track:

   .. figure:: graphemetk/images/OEDrawRailroadTrackSurfaceArc.*
      :align:  center

      **OEDrawRailroadTrackSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawRailroadTrackSurfaceArc<figure_draw_surface_arc_railroad_track>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawRailroadTrackSurfaceArc<figure_draw_surface_arc_railroad_track>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (D) and (E) in :ref:`Figure: OEDrawRailroadTrackSurfaceArc<figure_draw_surface_arc_railroad_track>`.

   .. seealso::

      * :ref:`OERailroadTrackArcFxn <OEGrapheme_OERailroadTrackArcFxn>` class




.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawResidues

.. _OEGrapheme_OEDrawResidues:

.. oe:function:: OEDrawResidues

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawResidues(OEDepict::OEImageBase& image,
                             const OEChem::OEMolBase& mol,
                             const bool interactive = false)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawResidues(image: OEImageBase,
                        mol: Union[OEGraphMol,OEMol,OEQMol],
                        interactive: bool = False) -> bool

   The :oe:func:`OEGrapheme::OEDrawResidues` function depicts the residue graph of a molecule
   with up to 300 heavy atoms.
   It is recommended to use when a molecule is imported from a :file:`PDB` file that automatically assigns
   residues (:oe:cls:`OEChem::OEResidue`) to each atom.

   *image*
     The image on which the molecule is drawn.

   *mol*
      The molecule being depicted.

   *interactive*
      The parameter that determines whether the generated image will be interactive
      (only available for :file:`SVG`` images) revealing the residue on mouse hover.

   .. note::

      The :oe:func:`OEGrapheme::OEDrawResidues` does not support
      visualizing large proteins. The number of heavy atoms is limited to 250.

   **Example:**

   The following code snippet shows how to use the :oe:func:`OEGrapheme::OEDrawResidues`
   function to generate an interactive SVG image. The image created is shown in
   :ref:`Figure: Example of using the OEDrawResidues function <figure_draw_residues>`.
   If the molecule has no residue information, if the :ref:`OEHasResidues <OEChem_OEHasResidues>`
   function returns ``false``, then a warning will be throw and no image will be generated.

   .. oe:source:: DrawResidues.py
      :language: python
      :noindent:
      :frag:     SNIPPET-DRAW-RESIDUES

   .. oe:source:: DrawResidues.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-DRAW-RESIDUES

   The :oe:func:`OEGrapheme::OEDrawResidues` function allows the visualization of nonstandard
   amino acids. Nonstandard amino acid residues are represented with a black jagged circle
   with the residue labels shown at the center.

   .. _figure_draw_residues:

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover mouse over any residue circles</b>
         </p>

         <p align="center">
         <object data="../../_images/DrawResidues.svg" type="image/svg+xml"  width = "500" ></object>
         <p>

         <p align="center">
         <b>Example of using the OEDrawResidues function to generate an interactive SVG image</b>
         <p>

      .. image:: /_images/DrawResidues.svg
         :width: 1pt

   .. only:: oepdf

      .. figure:: graphemetk/images/DrawResidues.*
         :align:  center

         **Example of using the OEDrawResidues function**

   .. note::

      This `interactive` functionality is **only available** for :file:`.svg`
      image format.

      The generated :file:`svg` image should be included into and
      HTML page with the SVG MIME type.

      .. code-block:: console

         <object data="<imagename>.svg" type="image/svg+xml"></object>

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawPeptide` function to depict a peptide with standard amino acids
      * :oe:func:`OEGrapheme::OEDrawMonomerGraph` and :oe:func:`OEGrapheme::OEHighlightMonomers` functions to depict molecules initialized from HELM
      * :ref:`chapter_svg` chapter in **OEDepict TK** manual


.. # split from OEGraphemeFunctions.rst:1898

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawSawCircle

.. oe:function:: OEDrawSawCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawSawCircle(OEDepict::OEImageBase& image,
                              const OEDepict::OE2DPoint& center, double radius,
                              const OEDepict::OEPen& pen,
                              unsigned int patternDirection = OEPatternDirection::Outside,
                              double patternAngle = 15.0,
                              double patternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawSawCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                         pen: OEPen, patternDirection: int,
                         patternAngle: float = 15.0,
                         patternWidthRatio: float = 0.15) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Saw` style.

   .. _figure_draw_circle_saw:

   .. figure:: graphemetk/images/OEDrawSawCircle.*
      :align:  center

      **OEDrawSawCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawSawCircle<figure_draw_circle_saw>`.

   *patternDirection*
     |circle_pattern_dir|
     This value has to be from the :oe:constns:`OEGrapheme::OEPatternDirection` namespace.

     See example (C) in :ref:`Figure: OEDrawSawCircle<figure_draw_circle_saw>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (D) in :ref:`Figure: OEDrawSawCircle<figure_draw_circle_saw>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (E) in :ref:`Figure: OEDrawSawCircle<figure_draw_circle_saw>`.



.. # split from OEGraphemeFunctions.rst:1952

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawSawSurfaceArc

.. oe:function:: OEDrawSawSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawSawSurfaceArc(OEDepict::OEImageBase& image,
                                  const OEDepict::OE2DPoint& center,
                                  double bgnAngle, double endAngle,
                                  double radius, const OEDepict::OEPen& pen,
                                  double edgeAngle = 10.0,
                                  unsigned int patternDirection = OEPatternDirection::Outside,
                                  double patternAngle = 15.0,
                                  double minPatternWidthRatio = 0.15,
                                  double maxPatternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawSawSurfaceArc(image: OEImageBase, c: OE2DPoint, bgnAngle: float,
                             endAngle: float, radius: float, pen: OEPen,
                             edgeAngle: float = 10.0, patternDirection: int,
                             patternAngle: float = 15.0,
                             minPatternWidthRatio: float = 0.15,
                             maxPatternWidthRatio: float = 0.15) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::Saw` style.

   .. _figure_draw_surface_arc_saw:

   .. figure:: graphemetk/images/OEDrawSawSurfaceArc.*
      :align:  center

      **OEDrawSawSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawSawSurfaceArc<figure_draw_surface_arc_saw>`.

   *patternDirection*
     |arc_pattern_dir|
     This value has to be from the :oe:constns:`OEGrapheme::OEPatternDirection` namespace.

     See example (C) in :ref:`Figure: OEDrawSawSurfaceArc<figure_draw_surface_arc_saw>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (D) in :ref:`Figure: OEDrawSawSurfaceArc<figure_draw_surface_arc_saw>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (E) and (F) in :ref:`Figure: OEDrawSawSurfaceArc<figure_draw_surface_arc_saw>`.

   .. seealso::

      * :ref:`OESawArcFxn <OEGrapheme_OESawArcFxn>` class



.. # split from OEGraphemeFunctions.rst:2019

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawSimpsonCircle

.. oe:function:: OEDrawSimpsonCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawSimpsonCircle(OEDepict::OEImageBase& image,
                                  const OEDepict::OE2DPoint& center,
                                  double radius, const OEDepict::OEPen& pen,
                                  double patternAngle = 10.0,
                                  double patternWidthRatio = 0.20)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawSimpsonCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                             pen: OEPen, patternAngle: float = 10.0,
                             patternWidthRatio: float = 0.20) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Simpson` style.

   .. _figure_draw_circle_simpson:

   .. figure:: graphemetk/images/OEDrawSimpsonCircle.*
      :align:  center

      **OEDrawSimpsonCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawSimpsonCircle<figure_draw_circle_simpson>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawSimpsonCircle<figure_draw_circle_simpson>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (D) in :ref:`Figure: OEDrawSimpsonCircle<figure_draw_circle_simpson>`.



.. # split from OEGraphemeFunctions.rst:2066

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawSimpsonSurfaceArc

.. oe:function:: OEDrawSimpsonSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawSimpsonSurfaceArc(OEDepict::OEImageBase& image,
                                      const OEDepict::OE2DPoint& center,
                                      double bgnAngle, double endAngle,
                                      double radius,
                                      const OEDepict::OEPen& pen,
                                      double edgeAngle = 10.0,
                                      double patternAngle = 15.0,
                                      double minPatternWidthRatio = 0.20,
                                      double maxPatternWidthRatio = 0.20)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawSimpsonSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                 bgnAngle: float, endAngle: float,
                                 radius: float, pen: OEPen,
                                 edgeAngle: float = 10.0,
                                 patternAngle: float = 15.0,
                                 minPatternWidthRatio: float = 0.20,
                                 maxPatternWidthRatio: float = 0.20) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::Simpson` style.

   .. _figure_draw_surface_arc_simpson:

   .. figure:: graphemetk/images/OEDrawSimpsonSurfaceArc.*
      :align:  center

      **OEDrawSimpsonSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawSimpsonSurfaceArc<figure_draw_surface_arc_simpson>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawSimpsonSurfaceArc<figure_draw_surface_arc_simpson>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (D) and (E) in :ref:`Figure: OEDrawSimpsonSurfaceArc<figure_draw_surface_arc_simpson>`.

   .. seealso::

      * :ref:`OESimpsonArcFxn <OEGrapheme_OESimpsonArcFxn>` class



.. # split from OEGraphemeFunctions.rst:2126

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawStitchCircle

.. oe:function:: OEDrawStitchCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawStitchCircle(OEDepict::OEImageBase& image,
                                 const OEDepict::OE2DPoint& center,
                                 double radius, const OEDepict::OEPen& pen,
                                 double patternAngle = 10.0,
                                 double patternWidthRatio = 0.20)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawStitchCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                            pen: OEPen, patternAngle: float = 10.0,
                            patternWidthRatio: float = 0.20) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Stitch` style.

   .. _figure_draw_circle_stitch:

   .. figure:: graphemetk/images/OEDrawStitchCircle.*
      :align:  center

      **OEDrawStitchCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawStitchCircle<figure_draw_circle_stitch>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawStitchCircle<figure_draw_circle_stitch>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (D) in :ref:`Figure: OEDrawStitchCircle<figure_draw_circle_stitch>`.



.. # split from OEGraphemeFunctions.rst:2173

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawStitchSurfaceArc

.. oe:function:: OEDrawStitchSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawStitchSurfaceArc(OEDepict::OEImageBase& image,
                                     const OEDepict::OE2DPoint& center,
                                     double bgnAngle, double endAngle,
                                     double radius, const OEDepict::OEPen& pen,
                                     double edgeAngle = 10.0,
                                     double patternAngle = 10.0,
                                     double minPatternWidthRatio = 0.20,
                                     double maxPatternWidthRatio = 0.20)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawStitchSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                bgnAngle: float, endAngle: float,
                                radius: float, pen: OEPen,
                                edgeAngle: float = 10.0,
                                patternAngle: float = 10.0,
                                minPatternWidthRatio: float = 0.20,
                                maxPatternWidthRatio: float = 0.20) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::Stitch` style.

   .. _figure_draw_surface_arc_stitch:

   .. figure:: graphemetk/images/OEDrawStitchSurfaceArc.*
      :align:  center

      **OEDrawStitchSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawStitchSurfaceArc<figure_draw_surface_arc_stitch>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawStitchSurfaceArc<figure_draw_surface_arc_stitch>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (D) and (E) in :ref:`Figure: OEDrawStitchSurfaceArc<figure_draw_surface_arc_stitch>`.

   .. seealso::

      * :ref:`OEStitchArcFxn <OEGrapheme_OEStitchArcFxn>` class



.. # split from OEGraphemeFunctions.rst:2233

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawSunCircle

.. oe:function:: OEDrawSunCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawSunCircle(OEDepict::OEImageBase& image,
                              const OEDepict::OE2DPoint& center, double radius,
                              const OEDepict::OEPen& pen,
                              unsigned int patternDirection = OEPatternDirection::Outside,
                              double patternAngle = 15.0,
                              double patternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawSunCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                         pen: OEPen, patternDirection: int,
                         patternAngle: float = 15.0,
                         patternWidthRatio: float = 0.15) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Sun` style.

   .. _figure_draw_circle_sun:

   .. figure:: graphemetk/images/OEDrawSunCircle.*
      :align:  center

      **OEDrawSunCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawSunCircle<figure_draw_circle_sun>`.

   *patternDirection*
     |circle_pattern_dir|
     This value has to be from the :oe:constns:`OEGrapheme::OEPatternDirection` namespace.

     See example (C) in :ref:`Figure: OEDrawSunCircle<figure_draw_circle_sun>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (D) in :ref:`Figure: OEDrawSunCircle<figure_draw_circle_sun>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (E) in :ref:`Figure: OEDrawSunCircle<figure_draw_circle_sun>`.



.. # split from OEGraphemeFunctions.rst:2287

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawSunSurfaceArc

.. oe:function:: OEDrawSunSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawSunSurfaceArc(OEDepict::OEImageBase& image,
                                  const OEDepict::OE2DPoint& center,
                                  double bgnAngle, double endAngle,
                                  double radius, const OEDepict::OEPen& pen,
                                  double edgeAngle = 10.0,
                                  unsigned int patternDirection = OEPatternDirection::Outside,
                                  double patternAngle = 15.0,
                                  double minPatternWidthRatio = 0.15,
                                  double maxPatternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawSunSurfaceArc(image: OEImageBase, c: OE2DPoint, bgnAngle: float,
                             endAngle: float, radius: float, pen: OEPen,
                             edgeAngle: float = 10.0, patternDirection: int,
                             patternAngle: float = 15.0,
                             minPatternWidthRatio: float = 0.15,
                             maxPatternWidthRatio: float = 0.15) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::Sun` style.

   .. _figure_draw_surface_arc_sun:

   .. figure:: graphemetk/images/OEDrawSunSurfaceArc.*
      :align:  center

      **OEDrawSunSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawSunSurfaceArc<figure_draw_surface_arc_sun>`.

   *patternDirection*
     |arc_pattern_dir|
     This value has to be from the :oe:constns:`OEGrapheme::OEPatternDirection` namespace.

     See example (C) in :ref:`Figure: OEDrawSunSurfaceArc<figure_draw_surface_arc_sun>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (D) in :ref:`Figure: OEDrawSunSurfaceArc<figure_draw_surface_arc_sun>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (E) and (F) in :ref:`Figure: OEDrawSunSurfaceArc<figure_draw_surface_arc_sun>`.

   .. seealso::

      * :ref:`OESunArcFxn <OEGrapheme_OESunArcFxn>` class



.. # split from OEGraphemeFunctions.rst:2354

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawSurfaceArc

.. oe:function:: OEDrawSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawSurfaceArc(OEDepict::OEImageBase& image,
                               unsigned int style,
                               const OEDepict::OE2DPoint& center,
                               double bgnAngle, double endAngle, double radius,
                               const OEDepict::OEPen& pen)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawSurfaceArc(image: OEImageBase, style: int, c: OE2DPoint,
                          bgnAngle: float, endAngle: float, radius: float,
                          pen: OEPen) -> bool

   Draws an arc with the given style.

   *image*
     |arc_image|

   *style*
     Specifies the style of the arc.
     This value has to be from the
     :oe:constns:`OEGrapheme::OESurfaceArcStyle` namespace.

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|




.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. oe:function:: OEDrawUnpairedInteractionMapLegend

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDrawUnpairedInteractionMapLegend(OEDepict::OEImageBase& image,
                                                 const OE2DActiveSiteDisplay& adisp,
                                                 const OE2DActiveSiteLegendDisplayOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawUnpairedInteractionMapLegend(image: OEImageBase,
                                            adisp: OE2DActiveSiteDisplay,
                                            opts: OE2DActiveSiteLegendDisplayOptions) -> None

   Draws legend for unpaired interaction map.

   *image*
      The image in which the color gradient is drawn.

   *adisp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object that holds the
      data necessary to depict the B-factor information of an active site.

   *opts*
      The :ref:`OE2DActiveSiteLegendDisplayOptions <OEGrapheme_OE2DActiveSiteLegendDisplayOptions>` object that
      determines how the legend is depicted.

   **Example:**

   .. oe:source:: RenderUnpairedMap.py
      :language: python
      :noindent:
      :frag:     SNIPPET-DRAW-UNPAIREDMAP-LEGEND

   .. oe:source:: RenderUnpairedMap.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-DRAW-UNPAIREDMAP-LEGEND

   .. oe:source:: RenderUnpairedMap.java
      :language: java
      :noindent:
      :frag:     SNIPPET-DRAW-UNPAIREDMAP-LEGEND

   .. oe:source:: RenderUnpairedMap.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-DRAW-UNPAIREDMAP-LEGEND

   .. figure:: graphemetk/images/DrawUnpairedMapLegend.*
      :align:  center

      **Example of using the OEDrawUnpairedInteractionMapLegend function**

   .. seealso::

      * :oe:func:`OEGrapheme::OERenderUnpairedInteractionMap` function

   .. admonition:: Code Example

      * `Visualizing Protein-Ligand Unpaired Interactions`_ **OpenEye Python Cookbook** recipe


.. # split from OEGraphemeFunctions.rst:2390

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawWreathCircle

.. oe:function:: OEDrawWreathCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawWreathCircle(OEDepict::OEImageBase& image,
                                 const OEDepict::OE2DPoint& center,
                                 double radius, const OEDepict::OEPen& pen,
                                 double patternAngle = 15.0,
                                 double patternWidthRatio = 0.20)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawWreathCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                            pen: OEPen, patternAngle: float = 15.0,
                            patternWidthRatio: float = 0.20) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Wreath` style.

   .. _figure_draw_circle_wreath:

   .. figure:: graphemetk/images/OEDrawWreathCircle.*
      :align:  center

      **OEDrawWreathCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawWreathCircle<figure_draw_circle_wreath>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawWreathCircle<figure_draw_circle_wreath>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (D) in :ref:`Figure: OEDrawWreathCircle<figure_draw_circle_wreath>`.


.. # split from OEGraphemeFunctions.rst:2437

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawWreathSurfaceArc

.. oe:function:: OEDrawWreathSurfaceArc

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawWreathSurfaceArc(OEDepict::OEImageBase& image,
                                     const OEDepict::OE2DPoint& center,
                                     double bgnAngle, double endAngle,
                                     double radius, const OEDepict::OEPen& pen,
                                     double edgeAngle = 10.0,
                                     double patternAngle = 20.0,
                                     double minPatternWidthRatio = 0.15,
                                     double maxPatternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawWreathSurfaceArc(image: OEImageBase, c: OE2DPoint,
                                bgnAngle: float, endAngle: float,
                                radius: float, pen: OEPen,
                                edgeAngle: float = 10.0,
                                patternAngle: float = 20.0,
                                minPatternWidthRatio: float = 0.15,
                                maxPatternWidthRatio: float = 0.15) -> bool

   Draws an arc with the :oe:const:`OEGrapheme::OESurfaceArcStyle::Wreath` style.

   .. _figure_draw_surface_arc_wreath:

   .. figure:: graphemetk/images/OEDrawWreathSurfaceArc.*
      :align:  center

      **OEDrawWreathSurfaceArc**

   *image*
     |arc_image|

   *center*
     |arc_center|

   *bgnAngle, endAngle*
     |arc_angles|

   *radius*
     |arc_radius|

   *pen*
     |arc_pen|

   *edgeAngle*
     |arc_edgeangle|

     See example (B) in :ref:`Figure: OEDrawWreathSurfaceArc<figure_draw_surface_arc_wreath>`.

   *patternAngle*
     |arc_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawWreathSurfaceArc<figure_draw_surface_arc_wreath>`.

   *minPatternWidthRatio, maxPatternWidthRatio*
     |arc_width_ratio|

     See examples (D) and (E) in :ref:`Figure: OEDrawWreathSurfaceArc<figure_draw_surface_arc_wreath>`.

   .. seealso::

      * :ref:`OEWreathArcFxn <OEGrapheme_OEWreathArcFxn>` class



.. # split from OEGraphemeFunctions.rst:2497

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGet2DSurfaceArcs

.. oe:function:: OEGet2DSurfaceArcs

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OESurfaceArc>* OEGet2DSurfaceArcs(const OEDepict::OE2DMolDisplay& disp,
                                                                double radiusScale = OESurfaceArcScale::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGet2DSurfaceArcs(disp: OE2DMolDisplay, radiusScale: double) -> Iterable[OESurfaceArc]

   Returns an iterator over the :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>`
   objects from which a continuous 2D molecule surface can be drawn.
   See :ref:`Figure: Example of the data stored in the OESurfaceArc
   class<figure_OEGet2DSurfaceArcs>`.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object for which the arcs
      of the 2D molecule surface are generated.

   *radiusScale*
      The multiplier used to modify the radius of the returned arcs.
      The scaling factor has to be in the range of
      [:oe:const:`OEGrapheme::OESurfaceArcScale::Minimum`,
      :oe:const:`OEGrapheme::OESurfaceArcScale::Maximum`].

   .. _figure_OEGet2DSurfaceArcs:

   .. figure:: graphemetk/images/OESurfaceArc.*
      :align:  center

      **Example of the data stored in the OESurfaceArc class**

   .. ################################################################

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OESurfaceArc>* OEGet2DSurfaceArcs(const OEDepict::OE2DMolDisplay& mdisp,
                                                                const OEDepict::OE2DAtomDisplay& adisp,
                                                                double radiusScale = OESurfaceArcScale::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGet2DSurfaceArcs(mdisp: OE2DMolDisplay, adisp: OE2DAtomDisplay,
                            radiusScale: double) -> Iterable[OESurfaceArc]

   Returns an iterator over the :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>`
   object(s) generated for the given atom display.
   See :ref:`Figure: Example of the arcs returned for an atom display
   with various radius scales <figure_OEGet2DSurfaceArcs>`.

   *mdisp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object to which the
      :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object belongs.

   *adisp*
      The :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object for which the arc(s)
      of the 2D molecule surface are generated.

   *radiusScale*
      The multiplier used to modify the radius of the returned arcs.
      The scaling factor has to be in the range of
      [:oe:const:`OEGrapheme::OESurfaceArcScale::Minimum`,
      :oe:const:`OEGrapheme::OESurfaceArcScale::Maximum`].

   .. ################################################################

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OESurfaceArc>* OEGet2DSurfaceArcs(const OEDepict::OE2DMolDisplay& disp,
                                                                const std::vector<double>& radiusScales)

   .. oe:language:: python

      .. oe:api:: python

         OEGet2DSurfaceArcs(disp: OE2DMolDisplay, radiusScales: OEDoubleVector) -> Iterable[OESurfaceArc]

   Returns an iterator over the :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>`
   objects from which a continuous 2D molecule surface can be drawn.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object for which the arcs
      of the 2D molecule surface are generated.

   *radiusScales*
      The multipliers used to modify the radius of the returned arcs.
      The vector has to be :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx`
      long.
      Each scaling factor has to be in the range of
      [:oe:const:`OEGrapheme::OESurfaceArcScale::Minimum`,
      :oe:const:`OEGrapheme::OESurfaceArcScale::Maximum`].

   .. seealso::

      * :ref:`chapter_draw_surface` chapter
      * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` classes
      * :oe:constns:`OEGrapheme::OESurfaceArcScale` namespace



.. # split from OEGraphemeFunctions.rst:2590

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGetMoleculeSurfaceScale

.. oe:function:: OEGetMoleculeSurfaceScale

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetMoleculeSurfaceScale(const OEChem::OEMolBase& mol,
                                          const OEDepict::OE2DMolDisplayOptions& opts,
                                          double maxRadiusScale = OESurfaceArcScale::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMoleculeSurfaceScale(mol: Union[OEGraphMol,OEMol,OEQMol],
                                   opts: OE2DMolDisplayOptions,
                                   maxRadiusScale: float) -> float

   Estimates the scaling factor of the molecule depiction considering
   the size of the molecule surface being drawn around the molecule
   diagram.
   See :ref:`Figure: Example of using the OEGetMoleculeSurfaceScale function <figure_OEGetMoleculeSurfaceScale>`.

   *mol*
     The molecule for which the scaling factor is determined.

   *opts*
     The :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object that stores
     the parameters which influence the calculated scaling factor
     (such as the width and the height of the image).

   *maxRadiusScale*
     The maximum radius multiplier used to generate the arcs of the
     2D molecule surface.

   .. _figure_OEGetMoleculeSurfaceScale:

   .. figure:: graphemetk/images/OEGetMoleculeSurfaceScale.*
      :align:  center

      **Example of using the OEGetMoleculeSurfaceScale function**

   .. seealso::

      * :oe:constns:`OEGrapheme::OESurfaceArcScale` namespace



.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGetNearbyAtom

.. oe:function:: OEGetNearbyAtom

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEDepict::OENearestAtom OEGetNearbyAtom(const OE2DActiveSiteDisplay& disp,
                                                 const OEDepict::OE2DPoint& point,
                                                 double radiusscale = 1.0)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearbyAtom(disp: OE2DActiveSiteDisplay, p: OE2DPoint,
                         radiusscale: float = 1.0) -> OENearestAtom

   Returns an :ref:`OENearestAtom <OEDepict_OENearestAtom>` object that stores a pointer
   of the atom which is depicted nearest to a given 2D display coordinates.
   By default, only atoms that not further than half bond away from the given
   point will be considered.

   *disp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object of which atoms are being
      considered.

   *point*
      Specifies the 2D display coordinates.

   *radiusscale*
       The multiplier that can be used to increase or to decrease the
       radius around the given point to be considered.
       This value has to be in a range of :math:`[0.25, 2.0]`.

   .. note::

      If there is no atom close to the given display coordinates,
      then the :oe:meth:`OEDepict::OENearestBond::IsValid` method returns
      `false`.

   .. seealso::

      * :ref:`OENearestAtom <OEDepict_OENearestAtom>` class
      * :oe:func:`OEGrapheme::OEGetNearestAtom` function


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGetNearbyBond

.. oe:function:: OEGetNearbyBond

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEDepict::OENearestBond OEGetNearbyBond(const OE2DActiveSiteDisplay& disp,
                                                 const OEDepict::OE2DPoint& point,
                                                 double radiusscale = 1.0)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearbyBond(disp: OE2DActiveSiteDisplay, p: OE2DPoint,
                         radiusscale: float = 1.0) -> OENearestBond

   Returns an :ref:`OENearestBond <OEDepict_OENearestBond>` object that stores a pointer
   of the bond which is depicted nearest to a given 2D display coordinates.
   By default, only atoms that not further than half bond away from the given
   point will be considered.

   *disp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object of which atoms are being
      considered.

   *point*
      Specifies the 2D display coordinates.

   *radiusscale*
       The multiplier that can be used to increase or to decrease the
       radius around the given point to be considered.
       This value has to be in a range of :math:`[0.25, 2.0]`.

   .. note::

      If there is no bond close to the given display coordinates,
      then the :oe:meth:`OEDepict::OENearestBond::IsValid` method returns
      `false`.

   .. seealso::

      * :ref:`OENearestBond <OEDepict_OENearestBond>` class
      * :oe:func:`OEGrapheme::OEGetNearestBond` function


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGetNearbyResidue

.. oe:function:: OEGetNearbyResidue

   .. oe:language:: c++ java csharp

      .. oe:api::

         OENearestResidue OEGetNearbyResidue(const OE2DActiveSiteDisplay& disp,
                                             const OEDepict::OE2DPoint& point,
                                             double radiusscale = 1.0)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearbyResidue(disp: OE2DActiveSiteDisplay, p: OE2DPoint,
                            radiusscale: float = 1.0) -> OENearestResidue

   Returns an :ref:`OENearestResidue <OEGrapheme_OENearestResidue>` object that stores
   the residue which is depicted nearest to a given 2D display coordinates.
   By default, only residues that not further than a radius distance from
   the given point will be considered.

   *disp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object of which atoms
      are being considered.

   *point*
      Specifies the 2D display coordinates.

   *radiusscale*
       The multiplier that can be used to increase or to decrease the
       radius around the given point to be considered.
       This value has to be in a range of :math:`[0.75, 3.0]`.

   .. note::

      If there is no residue close to the given display coordinates,
      then the :oe:meth:`OEGrapheme::OENearestResidue::IsValid` method returns
      `false`.

   .. seealso::

      * :ref:`OENearestResidue <OEGrapheme_OENearestResidue>` class
      * :oe:func:`OEGrapheme::OEGetNearestResidue` function


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGetNearestAtom

.. oe:function:: OEGetNearestAtom

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEDepict::OENearestAtom OEGetNearestAtom(const OE2DActiveSiteDisplay& disp,
                                                  const OEDepict::OE2DPoint& point)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearestAtom(disp: OE2DActiveSiteDisplay, p: OE2DPoint) -> OENearestAtom

   Returns an :ref:`OENearestAtom <OEDepict_OENearestAtom>` object that stores a pointer
   of the atom which is depicted nearest to a given 2D display coordinates.

   *disp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object of which atoms are being
      considered.

   *point*
      Specifies the 2D display coordinates.

   .. seealso::

      * :ref:`OENearestAtom <OEDepict_OENearestAtom>` class
      * :oe:func:`OEGrapheme::OEGetNearbyAtom` function


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGetNearestBond

.. oe:function:: OEGetNearestBond

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEDepict::OENearestBond OEGetNearestBond(const OE2DActiveSiteDisplay& disp,
                                                  const OEDepict::OE2DPoint& point)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearestBond(disp: OE2DActiveSiteDisplay, p: OE2DPoint) -> OENearestBond

   Returns an :ref:`OENearestBond <OEDepict_OENearestBond>` object that stores a pointer
   of the bond which is depicted nearest to a given 2D display coordinates.

   *disp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object of which bonds are being
      considered.

   *point*
      Specifies the 2D display coordinates.

   .. seealso::

      * :ref:`OENearestBond <OEDepict_OENearestBond>` class
      * :oe:func:`OEGrapheme::OEGetNearbyBond` function


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGetNearestResidue

.. oe:function:: OEGetNearestResidue

   .. oe:language:: c++ java csharp

      .. oe:api::

         OENearestResidue OEGetNearestResidue(const OE2DActiveSiteDisplay& disp,
                                              const OEDepict::OE2DPoint& point)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNearestResidue(disp: OE2DActiveSiteDisplay, p: OE2DPoint) -> OENearestResidue

   Returns an :ref:`OENearestResidue <OEGrapheme_OENearestResidue>` object that stores a residue which is depicted nearest to a given 2D display coordinates.

   *disp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object of which residues are being
      considered.

   *point*
      Specifies the 2D display coordinates.

   .. seealso::

      * :ref:`OENearestResidue <OEGrapheme_OENearestResidue>` class
      * :oe:func:`OEGrapheme::OEGetNearbyResidue` function


.. # split from OEGraphemeFunctions.rst:2632

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGetSurfaceArcFxn

.. oe:function:: OEGetSurfaceArcFxn

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OESurfaceArcFxnBase& OEGetSurfaceArcFxn(const OEChem::OEAtomBase* atom)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSurfaceArcFxn(atom: OEAtomBase) -> OESurfaceArcFxnBase

   Returns the surface drawing functor that is associated with the
   given atom, *i.e.*, when calling the
   :oe:func:`OEGrapheme::OEDraw2DSurface`
   function this return functor is used to draw the arc segment of the
   given atom.

   .. seealso::

      * :oe:func:`OEGrapheme::OEClearSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEGet2DSurfaceArcs` function
      * :oe:func:`OEGrapheme::OEHasSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function



.. # split from OEGraphemeFunctions.rst:2656

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGraphemeGetArch

.. oe:function:: OEGraphemeGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGraphemeGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEGraphemeGetArch() -> str



.. # split from OEGraphemeFunctions.rst:2667

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGraphemeGetLicensee

.. oe:function:: OEGraphemeGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGraphemeGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEGraphemeGetLicensee(licensee: str) -> bool



.. # split from OEGraphemeFunctions.rst:2678

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGraphemeGetPlatform

.. oe:function:: OEGraphemeGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGraphemeGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEGraphemeGetPlatform() -> str



.. # split from OEGraphemeFunctions.rst:2689

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGraphemeGetRelease

.. oe:function:: OEGraphemeGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGraphemeGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEGraphemeGetRelease() -> str



.. # split from OEGraphemeFunctions.rst:2700

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGraphemeGetSite

.. oe:function:: OEGraphemeGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGraphemeGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEGraphemeGetSite(site: str) -> bool


.. # split from OEGraphemeFunctions.rst:2711

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGraphemeGetVersion

.. oe:function:: OEGraphemeGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGraphemeGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEGraphemeGetVersion() -> int



.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGraphemeIsLicensed

.. oe:function:: OEGraphemeIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGraphemeIsLicensed(const char* feature = 0,
                                   unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEGraphemeIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **Grapheme TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **Grapheme TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **Grapheme TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function


.. # split from OEGraphemeFunctions.rst:2734

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEHasSurfaceArcFxn

.. oe:function:: OEHasSurfaceArcFxn

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasSurfaceArcFxn(const OEChem::OEAtomBase* atom)

   .. oe:language:: python

      .. oe:api:: python

         OEHasSurfaceArcFxn(atom: OEAtomBase) -> bool

   Returns whether or not a surface drawing functor is associated with
   the given atom.

   .. seealso::

      * :oe:func:`OEGrapheme::OEClearSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEGetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEHighlightMonomers

.. oe:function:: OEHighlightMonomers

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHighlightMonomers(OEDepict::OEImageBase& image,
                                  const OEChem::OEMolBase& mol)
         bool OEHighlightMonomers(OEDepict::OEImageBase& image,
                                  const OEChem::OEMolBase& mol,
                                  const OEHighlightMonomerDisplayOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEHighlightMonomers(image: OEImageBase,
                             mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
         OEHighlightMonomers(image: OEImageBase,
                             mol: Union[OEGraphMol,OEMol,OEQMol],
                             opts: OEHighlightMonomerDisplayOptions) -> bool

   The :oe:func:`OEGrapheme::OEHighlightMonomers` function is designed to depict a molecule
   initialized from a :term:`HELM` string and highlight its monomer components.

   *image*
     The image on which the molecule is drawn.

   *mol*
      The molecule being depicted.

   *opts*
      The :oe:cls:`OEGrapheme::OEHighlightMonomerDisplayOptions` object that stores
      properties that determine the styles of the molecule depiction.

   **Example:**

   .. oe:source:: HighlightMonomers.py
      :language: python
      :noindent:
      :frag:     SNIPPET-HIGHLIGHT-MONOMERS

   .. oe:source:: HighlightMonomers.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-HIGHLIGHT-MONOMERS

   .. figure:: graphemetk/images/HighlightMonomers.*
      :width: 450pt
      :align:  center

      **Example of using OEHighlightMonomers function**

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHighlightMonomers(OEDepict::OE2DMolDisplay& disp,
                                  const OEHighlightMonomerDisplayOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEHighlightMonomers(molDisplay: OE2DMolDisplay,
                             opts: OEHighlightMonomerDisplayOptions) -> bool

   This overload of the  :oe:func:`OEGrapheme::OEHighlightMonomers` function renders the
   molecule with the monomer highlighting to the display object.

   *disp*
      The display object for the molecule being depicted.

   *opts*
      The :oe:cls:`OEGrapheme::OEHighlightMonomerDisplayOptions` object that stores
      properties that determine the styles of the molecule depiction.

.. seealso::

   * :oe:func:`OEGrapheme::OEDrawMonomerGraph` function to depict the monomer graph of molecule initialized from HELM
   * :oe:func:`OEGrapheme::OEDrawPeptide` function to depict a peptide with standard amino acids
   * :oe:func:`OEGrapheme::OEDrawResidues` function to depict residues of a peptide

.. admonition:: Code Example

   * `Depict Peptide`_ **OpenEye Python Cookbook** recipe



.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEPrepareActiveSiteDepiction

.. oe:function:: OEPrepareActiveSiteDepiction

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPrepareActiveSiteDepiction(OEBio::OEInteractionHintContainer& asite)

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareActiveSiteDepiction(asite: OEInteractionHintContainer) -> bool

   Prepares an active site before depiction that involves suppressing
   hydrogens and calculate distances between the accessible surfaces of the
   ligand and the surrounding protein.

   .. seealso::

      * :ref:`section_examples_summary_complex2img` example


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEPrepareAlignedDepictionFrom3D

.. oe:function:: OEPrepareAlignedDepictionFrom3D

   .. list-table:: **The overloaded versions of the OEPrepareAlignedDepictionFrom3D function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OEPrepareAlignedDepictionFrom3D(fitmol2D,  fitmol3D, refmol2D, refmol3D)<api_OEPrepareAlignedDepictionFrom3D>`
        - 2D molecule alignment based on 3D

      * - :ref:`OEPrepareAlignedDepictionFrom3D(fitmol2D,  fitmol3D, refmol2D, refmol3D, opts)<api_OEPrepareAlignedDepictionFrom3D_Options>`
        - 2D molecule alignment based on 3D with options

      * - :ref:`OEPrepareAlignedDepictionFrom3D(fitmol2D,  fitmol3D, shapequery)<api_OEPrepareAlignedDepictionFrom3D_OEShapeQueryDisplay>`
        - 2D molecule alignment to 3D shape query

   .. #############################################################

   .. _api_OEPrepareAlignedDepictionFrom3D:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPrepareAlignedDepictionFrom3D(OEChem::OEMolBase& fitmol2D,
                                              const OEChem::OEMolBase& fitmol3D,
                                              const OEChem::OEMolBase& refmol2D,
                                              const OEChem::OEMolBase& refmol3D,
                                              bool clearCoords = true,
                                              bool suppressH = true)

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareAlignedDepictionFrom3D(fitmol2D: Union[OEGraphMol,OEMol,OEQMol],
                                         fitmol3D: Union[OEGraphMol,OEMol,OEQMol],
                                         refmol2D: Union[OEGraphMol,OEMol,OEQMol],
                                         refmol3D: Union[OEGraphMol,OEMol,OEQMol],
                                         clearFitCoords: bool = True,
                                         suppressFitH: bool = True) -> bool

   Generates the 2D coordinates of a molecule driven by the 3D overlay of the
   3D reference and the 3D fit molecules and the orientation of the 2D
   reference molecule.

   *fitmol2D*
      The molecule for which 2D coordinates are generated.

   *refmol2D*
      The 2D molecule whose orientation drives the 2D coordinate generation.

   *fitmol3D, refmol3D*
       The 3D molecule whose overlay drives the 2D coordinate generation.

   *clearCoords*
      If false and the *fitmol2D* has 2D coordinates, then these coordinates are
      used for the alignment.
      Otherwise the 2D coordinates of the fitted molecule are generated
      by calling the :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` function.

   *suppressH*
      If true, then explicit hydrogens are suppressed when generating the
      2D coordinates of the fitted molecule.
      Only hydrogens that are necessary to faithfully represent tetrahedral
      stereochemistry will be kept.

   .. #############################################################

   .. _api_OEPrepareAlignedDepictionFrom3D_Options:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPrepareAlignedDepictionFrom3D(OEChem::OEMolBase& fitmol2D,
                                              const OEChem::OEMolBase& fitmol3D,
                                              const OEChem::OEMolBase& refmol2D,
                                              const OEChem::OEMolBase& refmol3D,
                                              const OEAlignedDepictionFrom3DOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareAlignedDepictionFrom3D(fitmol2D: Union[OEGraphMol,OEMol,OEQMol],
                                         fitmol3D: Union[OEGraphMol,OEMol,OEQMol],
                                         refmol2D: Union[OEGraphMol,OEMol,OEQMol],
                                         refmol3D: Union[OEGraphMol,OEMol,OEQMol],
                                         opts: OEAlignedDepictionFrom3DOptions) -> bool

   Generates the 2D coordinates of a molecule driven by the 3D overlay of the
   3D reference and the 3D fit molecules and the orientation of the 2D
   reference molecule.

   *fitmol2D*
      The molecule for which 2D coordinates are generated.

   *refmol2D*
      The 2D molecule whose orientation drives the 2D coordinate generation.

   *fitmol3D, refmol3D*
       The 3D molecules whose overlay drives the 2D coordinate generation.

   *opts*
       The :ref:`OEAlignedDepictionFrom3DOptions <OEGrapheme_OEAlignedDepictionFrom3DOptions>` object that stores
       options controlling the generation of 2D coordinates.

   The following code snippet shows how to use the :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D`
   function.
   See generated images in :ref:`Table: 2D depiction based on 3D molecule overlay<table_OEPrepareAlignedDepictionFrom3D>`.

   .. oe:source:: PrepareAlignedDepictFrom3D.py
      :language: python
      :noindent:
      :frag:     SNIPPET-PREPARE-ALIGNED-DEPICTION-FROM-3D

   .. oe:source:: PrepareAlignedDepictFrom3D.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-PREPARE-ALIGNED-DEPICTION-FROM-3D

   .. oe:source:: PrepareAlignedDepictFrom3D.java
      :language: java
      :noindent:
      :frag:     SNIPPET-PREPARE-ALIGNED-DEPICTION-FROM-3D

   .. oe:language:: csharp

   .. oe:source:: PrepareAlignedDepictFrom3D.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-PREPARE-ALIGNED-DEPICTION-FROM-3D

   .. _table_OEPrepareAlignedDepictionFrom3D:

   .. list-table:: **2D depiction based on 3D molecule overlay**
      :widths: 150 150 150
      :header-rows: 0

      * - .. image:: ../images/OEPrepareAlignedDepictionFrom3D-ref-3D.png
             :align:  center
        - .. image:: ../images/OEPrepareAlignedDepictionFrom3D-overlap.png
             :align:  center
        - .. image:: ../images/OEPrepareAlignedDepictionFrom3D-fit-3D.png
             :align:  center
      * - 3D reference molecule
        - 3D molecule overlay
        - 3D fit molecule
      * - .. image:: ../images/OEPrepareAlignedDepictionFrom3D-ref-2D.*
             :align:  center
        -
        - .. image:: ../images/OEPrepareAlignedDepictionFrom3D-fit-2D.*
             :align:  center
      * - 2D reference molecule (generated by OEPrepareDepictionFrom3D)
        -
        - 2D fit molecule (**generated by OEPrepareAlignedDepictionFrom3D**)

   .. #############################################################

   .. _api_OEPrepareAlignedDepictionFrom3D_OEShapeQueryDisplay:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPrepareAlignedDepictionFrom3D(OEChem::OEMolBase& fitmol2D,
                                              const OEChem::OEMolBase& fitmol3D,
                                              const OEShapeQueryDisplay& qdisp)

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareAlignedDepictionFrom3D(fitmol2D: Union[OEGraphMol,OEMol,OEQMol],
                                         fitmol3D: Union[OEGraphMol,OEMol,OEQMol],
                                         qdisp: OEShapeQueryDisplay) -> bool

   Generates the 2D coordinates of a molecule driven by the 3D overlay of the
   shape query display object.

   *fitmol2D*
      The molecule for which 2D coordinates are generated.

   *refmol2D*
      The 2D molecule whose orientation drives the 2D coordinate generation.

   *qdisp*
       The :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object that drives
       the layout of the 2D coordinate generation.

   .. seealso::

      * :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` class


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEPrepareDepictionFrom3D

.. _OEGrapheme_OEPrepareDepictionFrom3D:

.. oe:function:: OEPrepareDepictionFrom3D

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPrepareDepictionFrom3D(OEChem::OEMolBase& mol,
                                       bool suppressH = true)

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareDepictionFrom3D(mol: Union[OEGraphMol,OEMol,OEQMol],
                                  suppressH: bool = True) -> bool

   Takes a 3D molecule and generates its 2D coordinates.
   The layout and orientation of the 2D coordinates are driven by the 3D
   coordinates. The molecule must have 3D coordinates assigned.

   *mol*
      The 3D molecule for which 2D coordinates are generated.

   *suppressH*
      If true, then explicit hydrogens are suppressed in the input molecule.
      Only hydrogens that are necessary to faithfully represent tetrahedral
      stereochemistry will be kept.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEPrepareDepictionFrom3D(OEChem::OEMolBase& mol,
                                       const OEDepictionFrom3DOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEPrepareDepictionFrom3D(mol: Union[OEGraphMol,OEMol,OEQMol],
                                  opts: OEDepictionFrom3DOptions) -> bool

   Takes a 3D molecule and generates its 2D coordinates using the
   given options.
   The layout and orientation of the 2D coordinates are driven by the 3D
   coordinates.

   *mol*
      The 3D molecule for which 2D coordinates are generated.

   *opts*
      The :ref:`OEDepictionFrom3DOptions <OEGrapheme_OEDepictionFrom3DOptions>` object that stores
      options controlling the generation of 2D coordinates.

   See the 2D molecule depictions in
   :ref:`Table: 2D representation of the 3D molecule<table_OEPrepareDepictionFrom3D>`
   and the corresponding 3D molecule in
   :ref:`Figure: Example of 3D molecule displayed in VIDA<figure_OEPrepareDepictionFrom3D>`.

   .. _figure_OEPrepareDepictionFrom3D:

   .. figure:: /_images/OEPrepareDepictionFrom3D-VIDA.png
      :align:  center

      **Example of 3D molecule displayed in VIDA**

   .. _table_OEPrepareDepictionFrom3D:

   .. list-table:: **2D representation of the 3D molecule**
      :widths: 150 150
      :header-rows: 0

      * -  **OEPrepareDepictionFrom3D**
        -  **OEPrepareDepiction**
      * - .. image:: ../images/DrawMoleculeFrom3D.*
             :align:  center
        - .. image:: ../images/DrawMoleculeFrom2D.*
             :align:  center


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OERenderActiveSite

.. _OEGrapheme_OERenderActiveSite:

.. oe:function:: OERenderActiveSite

   .. list-table:: **The overloaded versions of the OERenderActiveSite function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OERenderActiveSite(image, adisp)<api_OERenderActiveSite_OEImageBase>`
        - renders an active site into an image

      * - :ref:`OERenderActiveSite(filename, adisp)<api_OERenderActiveSite_filename>`
        - writes an active site display into a file

      * - :ref:`OERenderActiveSite(stream, ext, adisp)<api_OERenderActiveSite_oeostream>`
        - writes an active site display into an output stream

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawActiveSiteLegend` function
      * :oe:func:`OEGrapheme::OERenderActiveSiteMaps` function
      * :oe:func:`OEGrapheme::OERenderBFactorMap` function
      * :oe:func:`OEGrapheme::OERenderContactMap` function
      * :oe:func:`OEGrapheme::OERenderUnpairedInteractionMap` function

   .. admonition:: Code Example

      * :ref:`section_examples_summary_complex2img` example
      * `Visualizing Protein-Ligand Interactions`_  **OpenEye Python Cookbook** recipe

   .. _figure_OERenderActiveSite:

     .. only:: oehtml

      .. raw:: html

         <p align="center">
         <object data="../../_images/OERenderActiveSite-image-adisp.svg" type="image/svg+xml"  width = "600" ></object>
         <p>

         <p align="center">
         <b>Example of using the OERenderActiveSite function</b>
         <p>

      .. image:: /_images/OERenderActiveSite-image-adisp.svg
         :width: 1pt

   .. only:: oepdf

      .. figure:: graphemetk/images/OERenderActiveSite-image-adisp.pdf
         :align:  center

         **Example of using the OERenderActiveSite function**

   .. #############################################################

   .. _api_OERenderActiveSite_OEImageBase:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderActiveSite(OEDepict::OEImageBase& image,
                                 const OE2DActiveSiteDisplay& adisp)

   .. oe:language:: python

      .. oe:api:: python

         OERenderActiveSite(image: OEImageBase, adisp: OE2DActiveSiteDisplay) -> bool

   Renders the active site display into an image.

   *image*
      The image in which the active site is drawn.

   *adisp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object that holds the
      data necessary to depict the interactions of an active site.

   **Example:**

   .. oe:source:: OERenderActiveSite_image.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OERENDERACTIVESITE-IMAGE-ADISP

   .. oe:source:: OERenderActiveSite_image.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OERENDERACTIVESITE-IMAGE-ADISP

   .. oe:source:: OERenderActiveSite_image.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OERENDERACTIVESITE-IMAGE-ADISP

   .. oe:source:: OERenderActiveSite_image.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OERENDERACTIVESITE-IMAGE-ADISP

   .. seealso::

      * :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` class
      * :ref:`OE2DActiveSiteDisplayOptions <OEGrapheme_OE2DActiveSiteDisplayOptions>` class

   .. #############################################################

   .. _api_OERenderActiveSite_filename:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderActiveSite(const std::string& filename,
                                 const OE2DActiveSiteDisplay& adisp)

   .. oe:language:: python

      .. oe:api:: python

         OERenderActiveSite(filename: str, adisp: OE2DActiveSiteDisplay) -> bool

   Writes the active site display into a file.

   *filename*
      The name of the file into which the active site display is being
      written.
      The extension of the filename determine the type of the image.

   *adisp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object that holds the
      data necessary to depict the interactions of an active site.

   **Example:**

   .. oe:source:: OERenderActiveSite_fname.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OERENDERACTIVESITE-FNAME-ADISP

   .. oe:source:: OERenderActiveSite_fname.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OERENDERACTIVESITE-FNAME-ADISP

   .. oe:source:: OERenderActiveSite_fname.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OERENDERACTIVESITE-FNAME-ADISP

   .. oe:source:: OERenderActiveSite_fname.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OERENDERACTIVESITE-FNAME-ADISP

   .. seealso::

      * :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` class
      * :ref:`OE2DActiveSiteDisplayOptions <OEGrapheme_OE2DActiveSiteDisplayOptions>` class

   .. #############################################################

   .. _api_OERenderActiveSite_oeostream:

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderActiveSite(OEPlatform::oeostream& os,
                                 const std::string& extension,
                                 const OE2DActiveSiteDisplay& adisp)

   .. oe:language:: python

      .. oe:api:: python

         OERenderActiveSite(os: oeostream, extension: str,
                            adisp: OE2DActiveSiteDisplay) -> bool

   Writes the active site display into a stream.

   *os*
      The stream into which the active site is being written.

   *ext*
      The extension which determine the type of the image.

   *adisp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object that holds the
      data necessary to depict the interactions of an active site.

   **Example:**

   .. oe:source:: OERenderActiveSite_stream.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OERENDERACTIVESITE-STREAM-ADISP

   .. oe:source:: OERenderActiveSite_stream.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OERENDERACTIVESITE-STREAM-ADISP

   .. oe:source:: OERenderActiveSite_stream.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OERENDERACTIVESITE-STREAM-ADISP

   .. oe:source:: OERenderActiveSite_stream.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OERENDERACTIVESITE-STREAM-ADISP

   .. seealso::

      * :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` class
      * :ref:`OE2DActiveSiteDisplayOptions <OEGrapheme_OE2DActiveSiteDisplayOptions>` class


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. oe:function:: OERenderActiveSiteMaps

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderActiveSiteMaps(OEDepict::OEImageBase& image,
                                     const OEBio::OEInteractionHintContainer& asite)

   .. oe:language:: python

      .. oe:api:: python

         OERenderActiveSiteMaps(image: OEImageBase,
                                asite: OEInteractionHintContainer) -> bool

   Renders four protein-ligand maps (interaction, unpaired, b-factor and contact) into
   separate tabs of an image.

   *image*
      The image in which the active site is drawn.

   *asite*
      The :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object that holds the
      data for the active site.

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format.

   **Example:**

   .. oe:source:: RenderActiveSiteMaps.py
      :language: python
      :noindent:
      :frag:     SNIPPET-RENDER-ACTIVESITE-MAPS

   .. oe:source:: RenderActiveSiteMaps.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-RENDER-ACTIVESITE-MAPS

   .. oe:source:: RenderActiveSiteMaps.java
      :language: java
      :noindent:
      :frag:     SNIPPET-RENDER-ACTIVESITE-MAPS

   .. oe:source:: RenderActiveSiteMaps.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-RENDER-ACTIVESITE-MAPS

  .. _figure_RenderActiveSiteMaps:

     .. only:: oehtml

        .. raw:: html

           <p align="center">
           <object data="../../_images/RenderActiveSiteMaps.svg" type="image/svg+xml"  width = "600" ></object>
           <p>

           <p align="center">
           <b>Example of using the OERenderActiveSiteMaps function</b>
           <p>

        .. image:: /_images/RenderActiveSiteMaps.svg
           :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. seealso::

      * :oe:func:`OEGrapheme::OERenderActiveSite` function
      * :oe:func:`OEGrapheme::OERenderBFactorMap` function
      * :oe:func:`OEGrapheme::OERenderContactMap` function
      * :oe:func:`OEGrapheme::OERenderUnpairedInteractionMap` function

   .. admonition:: Code Example

      * `Visualizing Protein-Ligand Maps`_ **OpenEye Python Cookbook** recipe


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGrapheme

.. oe:function:: OERenderBFactorMap

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderBFactorMap(OEDepict::OEImageBase& image,
                                 const OE2DActiveSiteDisplay& adisp)

   .. oe:language:: python

      .. oe:api:: python

         OERenderBFactorMap(image: OEImageBase, adisp: OE2DActiveSiteDisplay) -> bool

   Renders the B-factor information of an active site display into an image.

   *image*
      The image in which the active site is drawn.

   *adisp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object that holds the
      data necessary to depict the B-Factor information of an active site.

   **Example:**

   .. oe:source:: RenderBFactorMap.py
      :language: python
      :noindent:
      :frag:     SNIPPET-RENDER-BFACTORMAP

   .. oe:source:: RenderBFactorMap.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-RENDER-BFACTORMAP

   .. oe:source:: RenderBFactorMap.java
      :language: java
      :noindent:
      :frag:     SNIPPET-RENDER-BFACTORMAP

   .. oe:source:: RenderBFactorMap.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-RENDER-BFACTORMAP

  .. _figure_RenderBFactorMap:

     .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover mouse over any residue circles</b>
         </p>

         <p align="center">
         <object data="../../_images/RenderBFactorMap.svg" type="image/svg+xml"  width = "600" ></object>
         <p>

         <p align="center">
         <b>Example of using the OERenderBfactorMap function</b>
         <p>

      .. image:: /_images/RenderBFactorMap.svg
         :width: 1pt

   .. only:: oepdf

      .. figure:: graphemetk/images/RenderBFactorMap.pdf
         :align:  center

         **Example of using the OERenderBfactorMap function**

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawBFactorMapLegend` function
      * :oe:func:`OEGrapheme::OERenderActiveSite` function
      * :oe:func:`OEGrapheme::OERenderActiveSiteMaps` function
      * :oe:func:`OEGrapheme::OERenderContactMap` function
      * :oe:func:`OEGrapheme::OERenderUnpairedInteractionMap` function

   .. admonition:: Code Example

      * `Visualizing Protein-Ligand B-Factor`_  **OpenEye Python Cookbook** example
      * `Visualizing Protein-Ligand B-Factor Map`_  **OpenEye Python Cookbook** example



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OERenderColorOverlap

.. oe:function:: OERenderColorOverlap

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OERenderColorOverlap(OEDepict::OEImageBase& image,
                                   const OEShapeOverlapDisplay& odisp)

   .. oe:language:: python

      .. oe:api:: python

         OERenderColorOverlap(image: OEImageBase, odisp: OEShapeOverlapDisplay) -> None

   Renders the color overlap between a reference and a fit molecule.

   *image*
     The image on which the fit molecule is rendered along with
     circles representing the satisfied and missed color atoms of
     the reference molecule.

   *odisp*
     The :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` object
     that holds the data necessary to depict the color overlap between
     the reference and the fit molecules.

   The following code snippet shows how to use the :oe:func:`OEGrapheme::OERenderColorOverlap`
   function. The image created is shown in
   :ref:`Table: Example of using the OERenderColorOverlap function<table_render_color_overlap>`.

   .. oe:source:: RenderColorOverlap.py
      :language: python
      :noindent:
      :frag:     SNIPPET-RENDER-COLOR-OVERLAP

   .. oe:source:: RenderColorOverlap.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-RENDER-COLOR-OVERLAP

   .. oe:source:: RenderColorOverlap.java
      :language: java
      :noindent:
      :frag:     SNIPPET-RENDER-COLOR-OVERLAP

   .. oe:source:: RenderColorOverlap.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-RENDER-COLOR-OVERLAP

   .. note::

      The color atom matches between the reference and the fit molecule are
      represented by circles (or half circles if two color atoms occupy
      the same space in 3D).
      Each circle corresponds to a color atom in the reference molecule.
      The color of the circle indicates the fitness of the color atom
      match in 3D.
      The lighter the color, the smaller the overlap between the reference
      and fit color atoms in 3D.
      Unfilled circles represent unmatched reference color atoms.
      If there is a good color atom match exist for a reference color atom
      in 3D, then the circle representing the color atom is
      positioned to the matching fit color atom in 2D.

   .. _table_render_color_overlap:

   .. list-table:: **Example of using the OERenderColorOverlap function**
      :widths: 150 150
      :header-rows: 0

      * - **(A)** reference molecule (shape query)
        - **(B)** fit molecule
      * - .. image:: ../images/RenderShapeQuery.*
             :align:  center
        - .. image:: ../images/RenderColorOverlap.*
             :align:  center
      * - shape query depicted by the **OERenderShapeQuery** function
        - color atom overlap depicted by the **OERenderColorOverlap** function

   .. warning::

      When calling the :oe:func:`OEGrapheme::OERenderColorOverlap` function
      **no overlay is performed to maximize the color overlap** between the
      reference and the fit molecule, *i.e.*, the function simply calculates
      the color overlap using the given 3D coordinates.

   .. seealso::

      * :ref:`OEColorOverlapDisplayOptions <OEGrapheme_OEColorOverlapDisplayOptions>` class
      * :oe:func:`OEGrapheme::OERenderShapeQuery` function
      * :oe:func:`OEGrapheme::OERenderShapeOverlap` function

   .. admonition:: Code Example

      * :ref:`section_examples_summary_shapeoverlap2pdf` example
      * `Visualizing Shape and Color Overlap`_ **OpenEye Python Cookbook** recipe


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OERenderContactMap

.. oe:function:: OERenderContactMap

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderContactMap(OEDepict::OEImageBase& image,
                                 const OE2DActiveSiteDisplay& adisp)

   .. oe:language:: python

      .. oe:api:: python

         OERenderContactMap(image: OEImageBase, adisp: OE2DActiveSiteDisplay) -> bool

   Renders the protein-ligand contact map with *residue* toggle buttons.
   Clicking on any residue will highlight those ligand atoms that
   interact with the residue.

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format. In all other image formats it only depicts
      the residue circles.

      The generated :file:`svg` image should be included into and
      HTML page with the SVG MIME type.

      .. code-block:: console

         <object data="<imagename>.svg" type="image/svg+xml"></object>

   *image*
     The image on which the contact map is rendered.

   *adisp*
     The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object that holds the
     data necessary to depict the interactions of an active site.

   The following code snippet shows how to use the :oe:func:`OEGrapheme::OERenderContactMap`
   function. The image created is shown in
   :ref:`Figure: Example of using the OERenderContactMap function<figure_RenderContactMap>`.

   **Example:**

   .. oe:source:: RenderContactMap.py
      :language: python
      :noindent:
      :frag:     SNIPPET-RENDER-CONTACTMAP

   .. oe:source:: RenderContactMap.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-RENDER-CONTACTMAP

   .. oe:source:: RenderContactMap.java
      :language: java
      :noindent:
      :frag:     SNIPPET-RENDER-CONTACTMAP

   .. oe:source:: RenderContactMap.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-RENDER-CONTACTMAP

   .. _figure_RenderContactMap:

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>click on any residue circles</b>
         </p>

         <p align="center">
         <object data="../../_images/RenderContactMap.svg" type="image/svg+xml"  width = "600" ></object>
         <p>

         <p align="center">
         <b>Example of using the OERenderContactMap function</b>
         <p>

      .. image:: /_images/RenderContactMap.svg
         :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. seealso::

      * :oe:func:`OEGrapheme::OERenderActiveSite` function
      * :oe:func:`OEGrapheme::OERenderActiveSiteMaps` function
      * :oe:func:`OEGrapheme::OERenderBFactorMap` function
      * :oe:func:`OEGrapheme::OERenderUnpairedInteractionMap` function

   .. admonition:: Code Example

      * `Visualizing Protein-Ligand Contacts`_ **OpenEye Python Cookbook** recipe



.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGrapheme

.. oe:function:: OERenderRamachandranPlot

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderRamachandranPlot(OEDepict::OEImageBase& image,
                                       const OERamachandranPlot& plot)

   .. oe:language:: python

      .. oe:api:: python

         OERenderRamachandranPlot(image: OEImageBase, plot: OERamachandranPlot) -> bool

   Renders the six Ramachandran plots into separate tabs of the given
   image.

   *image*
     The image on which the Ramachandran plots are rendered.

   *plot*
     The :ref:`OERamachandranPlot <OEGrapheme_OERamachandranPlot>` object that stores the
     data of a Ramachandran plot.

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format.

   **Example:**

   .. oe:source:: RenderRamachandranPlot.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA

   .. oe:source:: RenderRamachandranPlot.py
      :language: python
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA

   .. oe:source:: RenderRamachandranPlot.java
      :language: java
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA

   .. oe:source:: RenderRamachandranPlot.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA

  .. _figure_RenderRamachandranPlot:

  .. only:: oehtml

     .. raw:: html

        <p align="center">
        <object data="../../_images/RenderRamachandranPlot.svg" type="image/svg+xml"  width = "600" ></object>
        <p>

        <p align="center">
        <b>Example of using the OERenderRamachandranPlot function</b>
        <p>

     .. image:: /_images/RenderRamachandranPlot.svg
        :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. oe:api::

      bool OERenderRamachandranPlot(OEDepict::OEImageBase &image,
                                    const OERamachandranPlot &plot,
                                    unsigned int ramatype)

   Renders a specific Ramachandran plot into the given image.

   *image*
     The image on which the specific Ramachandran plot is rendered.

   *plot*
     The :ref:`OERamachandranPlot <OEGrapheme_OERamachandranPlot>` object that stores the
     data of a Ramachandran plot.

   *ramatype*
     The type of the Ramachandran plot being rendered.
     This value has to be from the :oe:constns:`OEBio::OERamaType`
     namespace.

   .. seealso::

      * :ref:`OERamachandranAnalysis <OEBio_OERamachandranAnalysis>` class in **OEChem TK** manual

   **Example:**

   .. oe:source:: RenderRamachandranPlot.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA-GENERAL

   .. oe:source:: RenderRamachandranPlot.py
      :language: python
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA-GENERAL

   .. oe:source:: RenderRamachandranPlot.java
      :language: java
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA-GENERAL

   .. oe:source:: RenderRamachandranPlot.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA-GENERAL

  .. _figure_RenderRamachandranPlot_General:

  .. only:: oehtml

     .. raw:: html

        <p align="center">
        <object data="../../_images/RenderRamachandranPlot-General.svg" type="image/svg+xml"  width = "600" ></object>
        <p>

        <p align="center">
        <b>Example of using the OERenderRamachandranPlot function</b>
        <p>

     .. image:: /_images/RenderRamachandranPlot-General.svg
        :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. admonition:: Code Example

      * `Ramachandran Plot`_ **OpenEye Python Cookbook** recipe



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OERenderShapeOverlap

.. oe:function:: OERenderShapeOverlap

   .. list-table:: **The overloaded versions of the OERenderShapeOverlap function**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`OERenderShapeOverlap(image, overlapdisp)<api_OERenderShapeOverlap_image_odisp>`
        - render shape overlap

      * - :ref:`OERenderShapeOverlap(molimage, overlapimage, overlapdisp)<api_OERenderShapeOverlap_image_image_odisp>`
        - render shape overlap into separate images

.. _api_OERenderShapeOverlap_image_odisp:

   .. oe:api::

      void OERenderShapeOverlap(OEDepict::OEImageBase& image,
                                const OEShapeOverlapDisplay& odisp)

   Renders the shape overlap between a reference and a fit molecule.

   *image*
     The image on which the fit molecule is rendered along with the
     property map and the molecule surface of the reference molecule
     representing the shape overlap.

   *odisp*
     The :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` object
     that holds the data necessary to depict the shape overlap between
     the reference and the fit molecules.

   The following code snippet shows how to use the :oe:func:`OEGrapheme::OERenderShapeOverlap`
   function. The image created is shown in
   :ref:`Table: Example of using the OERenderShapeOverlap function<table_OERenderShapeOverlap>`.

   .. oe:source:: RenderShapeOverlap.py
      :language: python
      :noindent:
      :frag:     SNIPPET-RENDER-SHAPE-OVERLAP

   .. oe:source:: RenderShapeOverlap.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-RENDER-SHAPE-OVERLAP

   .. oe:source:: RenderShapeOverlap.java
      :language: java
      :noindent:
      :frag:     SNIPPET-RENDER-SHAPE-OVERLAP

   .. oe:source:: RenderShapeOverlap.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-RENDER-SHAPE-OVERLAP

   .. note::

      The shape overlap between the reference and the fit molecule is visualized
      by using a property map (:ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>`), *i.e.*, a 2D grid,
      laid underneath the molecule structure, where the cells of the grid that
      are colored brown indicate good 3D shape overlap between the reference and
      the fit molecules.
      Additionally, clashes between the molecular graph of the fit molecule and
      2D molecule surface of the reference structure imply shape mismatch in 3D.

   .. _table_OERenderShapeOverlap:

   .. list-table:: **Example of using the OERenderShapeOverlap function**
      :widths: 150 150
      :header-rows: 0

      * - **(A)** reference molecule (shape query)
        - **(B)** fit molecule
      * - .. image:: ../images/RenderShapeQuery.*
             :align:  center
        - .. image:: ../images/RenderShapeOverlap.*
             :align:  center
      * - shape query depicted by the **OERenderShapeQuery** function
        - shape overlap depicted by the **OERenderShapeOverlap** function

   .. warning::

      When calling the :oe:func:`OEGrapheme::OERenderShapeOverlap` function
      **no overlay is performed to maximize the color overlap** between the
      reference and the fit molecule, *i.e.*, the function simply calculates
      the shape overlap using the given 3D coordinates.

.. _api_OERenderShapeOverlap_image_image_odisp:

   .. oe:api::

       void OERenderShapeOverlap(OEDepict::OEImageBase& molimage,
                                 OEDepict::OEImageBase& overlapimage,
                                 const OEShapeOverlapDisplay& odisp)

   Renders the shape overlap between a reference and a fit molecule into
   to separate images.

   *molimage*
     The image on which the fit molecule is rendered along with the
     surface of the reference molecule.

   *overlapimage*
     The image on which the property map is rendered representing
     the shape overlap.

   *odisp*
     The :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` object
     that holds the data necessary to depict the shape overlap between
     the reference and the fit molecules.

   .. note::

      The background of the molecule image is transparent. By superimposing
      the two images (molecule image on top), the result would be as visualizing
      the shape overlay in one image.

   .. seealso::

      * :ref:`OEShapeOverlapDisplayOptions <OEGrapheme_OEShapeOverlapDisplayOptions>` class
      * :oe:func:`OEGrapheme::OERenderShapeQuery` function
      * :oe:func:`OEGrapheme::OERenderColorOverlap` function

   .. admonition:: Code Example

      * :ref:`section_examples_summary_shapeoverlap2pdf` example
      * `Visualizing Shape and Color Overlap`_ **OpenEye Python Cookbook** recipe



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OERenderShapeQuery

.. oe:function:: OERenderShapeQuery

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OERenderShapeQuery(OEDepict::OEImageBase& image,
                                 const OEShapeQueryDisplay& disp)

   .. oe:language:: python

      .. oe:api:: python

         OERenderShapeQuery(image: OEImageBase, qdisp: OEShapeQueryDisplay) -> None

   Renders the reference molecule of the shape overlap.

   *image*
     The image on which the reference molecule is rendered.

   *disp*
     The :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object
     that holds the data necessary to depict the reference molecule
     of a shape overlap.

   The following code snippet shows how to use the :oe:func:`OEGrapheme::OERenderShapeQuery`
   function. The image created is shown in
   :ref:`Figure: Example of using the OERenderShapeQuery function<figure_OERenderShapeQuery>`.

   .. oe:source:: RenderShapeQuery.py
      :language: python
      :noindent:
      :frag:     SNIPPET-RENDER-SHAPE-QUERY

   .. oe:source:: RenderShapeQuery.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-RENDER-SHAPE-QUERY

   .. oe:source:: RenderShapeQuery.java
      :language: java
      :noindent:
      :frag:     SNIPPET-RENDER-SHAPE-QUERY

   .. oe:source:: RenderShapeQuery.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-RENDER-SHAPE-QUERY

   .. _figure_OERenderShapeQuery:

   .. figure:: graphemetk/images/RenderShapeQuery.*
      :align:  center

      **Example of using the OERenderShapeQuery function**

   .. seealso::

      * :ref:`OEShapeQueryDisplayOptions <OEGrapheme_OEShapeQueryDisplayOptions>` class
      * :oe:func:`OEGrapheme::OERenderColorOverlap` function
      * :oe:func:`OEGrapheme::OERenderShapeOverlap` function

   .. admonition:: Code Example

      * :ref:`section_examples_summary_shapeoverlap2pdf` example
      * `Visualizing Shape and Color Overlap`_ **OpenEye Python Cookbook** recipe



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. oe:function:: OERenderUnpairedInteractionMap

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderUnpairedInteractionMap(OEDepict::OEImageBase& image,
                                             const OE2DActiveSiteDisplay& adisp)

   .. oe:language:: python

      .. oe:api:: python

         OERenderUnpairedInteractionMap(image: OEImageBase,
                                        adisp: OE2DActiveSiteDisplay) -> bool

   Renders the protein-ligand map with clash and unpaired interactions.

   *image*
      The image in which the active site is drawn.

   *adisp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object that holds the
      data necessary to depict the interactions of an active site.

   The :oe:func:`OEGrapheme::OERenderUnpairedInteractionMap` function
   currently visualizes the following interactions:

   * Atom **clash** interaction (see :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>` class)
   * **Unpaired** and **clash** types of the **hydrogen bonding** interaction
     (see :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` class :oe:constns:`OEBio::OEHBondInteractionHintType` namespace)
   * **Unpaired** types of the **salt-bridge** interaction
     (see :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>` class and :oe:constns:`OEBio::OESaltBridgeInteractionHintType` namespace)

   The following code snippet shows how to use the :oe:func:`OEGrapheme::OERenderUnpairedInteractionMap`
   function. The image created is shown in
   :ref:`Figure: Example of using the OERenderUnpairedInteraction function<figure_RenderUnpairedMap>`.

   .. oe:source:: RenderUnpairedMap.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-RENDER-UNPAIREDMAP

   .. oe:source:: RenderUnpairedMap.py
      :language: python
      :noindent:
      :frag:     SNIPPET-RENDER-UNPAIREDMAP

   .. oe:source:: RenderUnpairedMap.java
      :language: java
      :noindent:
      :frag:     SNIPPET-RENDER-UNPAIREDMAP

   .. oe:source:: RenderUnpairedMap.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-RENDER-UNPAIREDMAP

   .. _figure_RenderUnpairedMap:

     .. only:: oehtml

      .. raw:: html

         <p align="center">
         <object data="../../_images/RenderUnpairedMap.svg" type="image/svg+xml"  width = "600" ></object>
         <p>

         <p align="center">
         <b>Example of using the OERenderUnpairedInteraction function</b>
         <p>

      .. image:: /_images/RenderUnpairedMap.svg
         :width: 1pt

   .. only:: oepdf

      .. figure:: graphemetk/images/RenderUnpairedMap.pdf
         :align: center

         **Example of using the OERenderUnpairedInteraction function**

   .. note::

       Please note that unpaired interactions have no direction in 3D,
       therefore the *linker* representing these unpaired interactions
       in 2D have no real spatial meaning either.  Ligand linkers are
       directed away from the ligand, while protein linkers are
       directed towards the ligand when rendered in 2D.

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawUnpairedInteractionMapLegend` function
      * :oe:func:`OEGrapheme::OERenderActiveSite` function
      * :oe:func:`OEGrapheme::OERenderActiveSiteMaps` function
      * :oe:func:`OEGrapheme::OERenderContactMap` function
      * :oe:func:`OEGrapheme::OERenderBFactorMap` function

   .. admonition:: Code Example

      * `Visualizing Protein-Ligand Unpaired Interactions`_ **OpenEye Python Cookbook** recipe


.. # split from OEGraphemeFunctions.rst:3343

.. |circle_image|       replace:: The image on which the circle is drawn.

.. |circle_center|      replace:: The center of the circle.

.. |circle_radius|      replace:: The radius of the circle.

.. |circle_pen|         replace:: The graphical properties of the circle.

.. |circle_pattern_dir| replace:: Specifies whether the pattern is drawn inside or outside of the circle.

.. |circle_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the circle. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |circle_width_ratio|   replace:: Specifies the width of the `pattern` of the circle relative to its radius. The ratio has to be in a range of :math:`[0.01 - 1.00]`.

.. |arc_image|       replace:: The image on which the arc is drawn.

.. |arc_center|      replace:: The center of the arc.

.. |arc_radius|      replace:: The radius of the arc.

.. |arc_pen|         replace:: The graphical properties of the arc.

.. |arc_pattern_dir| replace::  Specifies whether the pattern is drawn inside or outside of the arc.

.. |arc_pattern_angle| replace:: Specifies the angle (in degrees) between the `patterns` of the arc. The angle has to be in a range of :math:`[1.0^{\circ} - 90.0^{\circ}]`

.. |arc_angles|      replace::  The two endpoints of the arc. Both angles are in degrees and their values have to be in a range of :math:`[0.0^{\circ} - 360.0^{\circ}]`. Angles are interpreted such that :math:`0.0^{\circ}` and :math:`360.0^{\circ}` degrees are at the *12 o'clock*  position, :math:`90.0^{\circ}` degrees corresponds to *3 o'clock*, etc.

.. |arc_edgeangle|   replace:: The angle (in degrees) between the end points of the arc and the points where the `pattern` of the arc starts.

.. |arc_width_ratio| replace:: Specifies the width of the `pattern` of the arc relative to its radius. The *min* ratio is applied to the end of the arc while the *max* ratio specifies the width of the patterns at the middle of the arc. Both ratios have to be in a range of :math:`[0.01 - 1.00]`.


.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OESetSurfaceArcFxn

.. oe:function:: OESetSurfaceArcFxn

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetSurfaceArcFxn(OEChem::OEMolBase& mol,
                                 OEChem::OEAtomBase* atom,
                                 const OESurfaceArcFxnBase& func)

   .. oe:language:: python

      .. oe:api:: python

         OESetSurfaceArcFxn(mol: Union[OEGraphMol,OEMol,OEQMol],
                            atom: OEAtomBase, func: OESurfaceArcFxnBase) -> bool

   Attaches the arc drawing functor to the given atom.

   *mol*
      The molecule the atom belongs to.

   *atom*
      The atom to which the functor will be attached.

   *func*
      The functor that will be used to draw the arc segment(s) of
      the molecule surface that correspond(s) to the given atom
      when the :oe:func:`OEGrapheme::OEDraw2DSurface` function
      in invoked.

   .. seealso::

      * :oe:func:`OEGrapheme::OEClearSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEGetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEHasSurfaceArcFxn` function



.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OESetup2DPropMap, Setup2DPropMap

.. oe:function:: OESetup2DPropMap

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetup2DPropMap(OE2DPropMap& propmap,
                               const OESystem::OEInterface& itf)

   .. oe:language:: python

      .. oe:api:: python

         OESetup2DPropMap(propmap: OE2DPropMap, itf: OEInterface) -> bool

   Initializes an :ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>`
   object from the parameters of a given interface.



*******************************************************************************
OEGrapheme Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEAddComplexSurfaceArcs.rst
   OEAddGlyph.rst
   OEAddLigandHighlighting.rst
   OEAddResidueHighlighting.rst
   OEClearSurfaceArcFxn.rst
   OEConfigure2DPropMap.rst
   OEDraw2DSurface.rst
   OEDrawActiveSiteLegend.rst
   OEDrawBFactorMapLegend.rst
   OEDrawCircle.rst
   OEDrawColorForceFieldLegend.rst
   OEDrawColorGradient.rst
   OEDrawPeptide.rst
   OEDrawResidues.rst
   OEDrawROCSScores.rst
   OEDrawSurfaceArc.rst
   OEDrawUnpairedInteractionMapLegend.rst
   OEGet2DSurfaceArcs.rst
   OEGetMoleculeSurfaceScale.rst
   OEGetNearbyAtom
   OEGetNearbyBond
   OEGetNearbyResidue
   OEGetNearestAtom
   OEGetNearestBond
   OEGetNearestResidue
   OEGetSurfaceArcFxn.rst
   OEGraphemeGetArch.rst
   OEGraphemeGetLicensee.rst
   OEGraphemeGetPlatform.rst
   OEGraphemeGetRelease.rst
   OEGraphemeGetSite.rst
   OEGraphemeGetVersion.rst
   OEGraphemeIsLicensed.rst
   OEHasSurfaceArcFxn.rst
   OEPrepareActiveSiteDepiction.rst
   OEPrepareAlignedDepictionFrom3D.rst
   OEPrepareDepictionFrom3D.rst
   OERenderActiveSite.rst
   OERenderActiveSiteMaps.rst
   OERenderBFactorMap.rst
   OERenderContactMap.rst
   OERenderColorOverlap.rst
   OERenderRamachandranPlot.rst
   OERenderShapeOverlap.rst
   OERenderShapeQuery.rst
   OERenderUnpairedInteractionMap.rst
   OESetSurfaceArcFxn.rst
   OESetup2DPropMap.rst


*******************************************************************************
OEGrapheme Basic Circle and Arc Drawing Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEDrawAlphaRainbowCircle.rst
   OEDrawAlphaRainbowSurfaceArc.rst
   OEDrawBrickRoadCircle.rst
   OEDrawBrickRoadSurfaceArc.rst
   OEDrawCastleCircle.rst
   OEDrawCastleSurfaceArc.rst
   OEDrawCogCircle.rst
   OEDrawCogSurfaceArc.rst
   OEDrawDefaultCircle.rst
   OEDrawDefaultSurfaceArc.rst
   OEDrawEyelashCircle.rst
   OEDrawEyelashSurfaceArc.rst
   OEDrawFlowerCircle.rst
   OEDrawFlowerSurfaceArc.rst
   OEDrawGreekKeyCircle.rst
   OEDrawNecklaceCircle.rst
   OEDrawNecklaceSurfaceArc.rst
   OEDrawOliveBranchCircle.rst
   OEDrawOliveBranchSurfaceArc.rst
   OEDrawPearlsCircle.rst
   OEDrawPearlsSurfaceArc.rst
   OEDrawRaceTrackCircle.rst
   OEDrawRaceTrackSurfaceArc.rst
   OEDrawRailroadTrackCircle.rst
   OEDrawRailroadTrackSurfaceArc.rst
   OEDrawSawCircle.rst
   OEDrawSawSurfaceArc.rst
   OEDrawSimpsonCircle.rst
   OEDrawSimpsonSurfaceArc.rst
   OEDrawStitchCircle.rst
   OEDrawStitchSurfaceArc.rst
   OEDrawSunCircle.rst
   OEDrawSunSurfaceArc.rst
   OEDrawWreathCircle.rst
   OEDrawWreathSurfaceArc.rst


*******************************************************************************
Preliminary OEGrapheme Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEDrawIridiumData
   OEDrawMonomer
   OEDrawMonomerGraph
   OEHighlightMonomers


.. _chapter_annotation:

********************************************************************************
Annotating Atoms and Bonds
********************************************************************************

The **Grapheme TK** provides a framework to annotate atoms and bonds *i.e.*
mark them based on their properties.
The following :oe:src:`Listing 1<SNIPPET-ANNOTATE-ATOM-PROPERTY-AnnotateAtomPredicate>` example shows
how to mark :math:`sp^2` and :math:`sp^3` hybridized atoms of
depicted molecules.
After preparing the molecule for 2D depiction and calculating the
atom hybridizations, the molecule display object is created
(:ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`) that stores the depiction
information of a molecule
The :oe:func:`OEGrapheme::OEAddGlyph` function is then called to
add *glyph* to those atoms for which the given
:ref:`OEIsAtomHybridization <OEChem_OEIsAtomHybridization>` functor returns `true`.
In this example, the built-in :ref:`OEAtomGlyphCircle <OEGrapheme_OEAtomGlyphCircle>`
class is used to mark atoms by drawings a circle around them with a
specific style (:oe:constns:`OEGrapheme::OECircleStyle`).
Finally, the image is written out to a file by calling the
:oe:func:`OEDepict::OEWriteImage` function.
The image created by :oe:src:`Listing 1<SNIPPET-ANNOTATE-ATOM-PROPERTY-AnnotateAtomPredicate>` example
is shown in
:ref:`Figure: Example of atom annotation<figure_annotate_atom_predicate>`.

.. oe:source:: AnnotateAtomPredicate.py
   :language: python
   :refnum:   1
   :frag:     SNIPPET-ANNOTATE-ATOM-PROPERTY
   :caption:  Example of using a built-in atom annotation style

.. oe:source:: AnnotateAtomPredicate.cpp
   :language: c++
   :refnum:   1
   :frag:     SNIPPET-ANNOTATE-ATOM-PROPERTY
   :caption:  Example of using a built-in atom annotation style

.. oe:source:: AnnotateAtomPredicate.java
   :language: java
   :refnum:   1
   :frag:     SNIPPET-ANNOTATE-ATOM-PROPERTY
   :caption:  Example of using a built-in atom annotation style

.. oe:source:: AnnotateAtomPredicate.cs
   :language: csharp
   :refnum:   1
   :frag:     SNIPPET-ANNOTATE-ATOM-PROPERTY
   :caption:  Example of using a built-in atom annotation style

.. _figure_annotate_atom_predicate:

.. figure:: graphemetk/images/AnnotateAtomPredicate.*
   :align:  center

   **Example of atom annotation**

.. seealso::

   * :oe:func:`OEGrapheme::OEAddGlyph` function
   * :ref:`OEAtomGlyphCircle <OEGrapheme_OEAtomGlyphCircle>` class
   * :oe:constns:`OEGrapheme::OECircleStyle` namespace
   * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class and
     :oe:func:`OEDepict::OEWriteImage` function in the **OEDepict TK** manual

.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   %
   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Similarly, the following example shows how to annotate bonds.
The bonds being highlighted are specified by the bond predicate passed
to the :oe:func:`OEGrapheme::OEAddGlyph` function.
For each bond the predicate returns ``true``, *i.e.* if it is a
rotatable bond, the :oe:meth:`OEGrapheme::OEBondGlyphArrow::RenderGlyph`
method is invoked that draws an arrow across the middle of the specific bond.
The image created by :oe:src:`Listing 2<SNIPPET-ANNOTATE-BOND-PROPERTY-AnnotateBondPredicate>` is shown in
:ref:`Figure: Example of bond annotation<figure_annotate_bond_predicate>`.

.. oe:source:: AnnotateBondPredicate.py
   :language: python
   :refnum:   2
   :frag:     SNIPPET-ANNOTATE-BOND-PROPERTY
   :caption:  Example of using a built-in bond annotation style

.. oe:source:: AnnotateBondPredicate.cpp
   :language: c++
   :refnum:   2
   :frag:     SNIPPET-ANNOTATE-BOND-PROPERTY
   :caption:  Example of using a built-in bond annotation style

.. oe:source:: AnnotateBondPredicate.java
   :language: java
   :refnum:   2
   :frag:     SNIPPET-ANNOTATE-BOND-PROPERTY
   :caption:  Example of using a built-in bond annotation style

.. oe:source:: AnnotateBondPredicate.cs
   :language: csharp
   :refnum:   2
   :frag:     SNIPPET-ANNOTATE-BOND-PROPERTY
   :caption:  Example of using a built-in bond annotation style

.. _figure_annotate_bond_predicate:

.. figure:: graphemetk/images/AnnotateBondPredicate.*
   :align:  center

   **Example of bond annotation**

The following table lists the customizable bond glyphs that are currently
available in **Grapheme TK**.

.. list-table:: **Supported bond glyphs**
   :widths: 200 200 200 200
   :header-rows: 0

   * - .. image:: images/OEBondGlyphArrow_Default.*
          :align:  left
     - .. image:: images/OEBondGlyphCircle_Default.*
          :align:  left
     - .. image:: images/OEBondGlyphCross_Default.*
          :align:  left
     - .. image:: images/OEBondGlyphCurvedArrow_Default.*
          :align:  left

   * - :ref:`OEBondGlyphArrow <OEGrapheme_OEBondGlyphArrow>`
     - :ref:`OEBondGlyphCircle <OEGrapheme_OEBondGlyphCircle>`
     - :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>`
     - :ref:`OEBondGlyphCurvedArrow <OEGrapheme_OEBondGlyphCurvedArrow>`

   * - .. image:: images/OEBondGlyphScissors_Default.*
          :align:  left
     - .. image:: images/OEBondGlyphStitch_Default.*
          :align:  left
     - .. image:: images/OEBondGlyphZigZag_Default.*
          :align:  left
     -

   * - :ref:`OEBondGlyphScissors <OEGrapheme_OEBondGlyphScissors>`
     - :ref:`OEBondGlyphStitch <OEGrapheme_OEBondGlyphStitch>`
     - :ref:`OEBondGlyphZigZag <OEGrapheme_OEBondGlyphZigZag>`
     -

.. seealso::

   * :oe:func:`OEGrapheme::OEAddGlyph` function

.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   %
   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

The last example shows how to depict *non-boolean* properties by implementing
a user-defined annotation style.
User-defined atom and bond annotations can be implemented by deriving
from the :ref:`OEAtomGlyphBase <OEGrapheme_OEAtomGlyphBase>` and the
:ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>` abstract classes and implementing
the :oe:meth:`OEGrapheme::OEAtomGlyphBase::RenderGlyph` and the
:oe:meth:`OEGrapheme::OEBondGlyphBase::RenderGlyph` methods,
respectively.

In the :oe:src:`Listing 3<SNIPPET-ANNOTATE-PARTIAL-CHARGE-AnnotatePartialCharge>` example, after
calculating the MMFF charges, the atoms are annotated by their charge
using the :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class that
interpolates colors. Atoms with negative and positive charge are
highlighted by red and blue colors, respectively.
The image created by :oe:src:`Listing 3<SNIPPET-ANNOTATE-PARTIAL-CHARGE-AnnotatePartialCharge>` is shown in
:ref:`Figure: Example of user-defined annotation<figure_annotate_partial_charge>`.

.. oe:source:: AnnotatePartialCharge.py
   :language: python
   :refnum:   3
   :frag:     SNIPPET-ANNOTATE-PARTIAL-CHARGE
   :caption:  Example of user-defined annotation

.. oe:source:: AnnotatePartialCharge.cpp
   :language: c++
   :refnum:   3
   :frag:     SNIPPET-ANNOTATE-PARTIAL-CHARGE
   :caption:  Example of user-defined annotation

.. oe:source:: AnnotatePartialCharge.java
   :language: java
   :refnum:   3
   :frag:     SNIPPET-ANNOTATE-PARTIAL-CHARGE
   :caption:  Example of user-defined annotation

.. oe:source:: AnnotatePartialCharge.cs
   :language: csharp
   :refnum:   3
   :frag:     SNIPPET-ANNOTATE-PARTIAL-CHARGE
   :caption:  Example of user-defined annotation

.. _figure_annotate_partial_charge:

.. figure:: graphemetk/images/AnnotatePartialCharge.*
   :align:  center

   **Example of user-defined annotation**

.. seealso::

   * :ref:`OEAtomGlyphBase <OEGrapheme_OEAtomGlyphBase>` class
   * :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>` class
   * :oe:func:`OEGrapheme::OEAddGlyph` function
   * :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class



.. _oegrapheme_part_api:

********************************
API
********************************

.. toctree::
   :maxdepth: 2

   OEGraphemeClasses/OEGraphemeClasses
   OEGraphemeClasses/OEGraphemeClasses-basic-drawing
   OEGraphemeConstants/OEGraphemeConstants
   OEGraphemeFunctions/index
   OEGraphemeFunctions/index-basic-drawing

.. _oegrapheme_part_preliminary_api:

********************************
Preliminary API
********************************

.. toctree::
   :maxdepth: 1

   OEGraphemeClasses/OEGraphemeClasses-prelim
   OEGraphemeFunctions/index-prelim


.. _chapter_complex_surface:

********************************************************************************
Drawing a Ligand-Protein Complex Surface
********************************************************************************

The previous chapter demonstrates how to draw and customize 2D
molecule surfaces.
**Grapheme TK** also provides a method that depicts a ligand-protein
complex in which the arcs of the 2D surface of the molecule are
annotated based on the distance between the accessible
surfaces of the ligand and the surrounding protein
(:oe:func:`OESpicoli::OEMakeAccessibleSurface`).
Based on this calculation, the atoms of the ligand are
divided into four categories which are then inherited by the
corresponding arcs when the 2D molecule surface of the ligand is
drawn.
These four types are the following:

#. **Solvent** (:ref:`OEDefaultSolventArcFxn <OEGrapheme_OEDefaultSolventArcFxn>`)

   A surface arc is depicted using the *solvent* style if the
   corresponding atom is accessible to a solvent.
   (See :ref:`Figure: Example of the 'solvent' arc style<figure_complex_surface_solvent>`)

   .. _figure_complex_surface_solvent:

   .. figure:: graphemetk/images/OEDefaultSolventArcFxn.*
      :align:  center

      **Example of the 'solvent' arc style**

#. **Cavity** (:ref:`OEDefaultCavityArcFxn <OEGrapheme_OEDefaultCavityArcFxn>`)

   A surface arc is depicted using the *cavity* style if in the
   region of the corresponding atom, a cavity is detected between the
   ligand and the receptor molecule surfaces.
   The cavity is large enough to allow expanding the ligand in this
   region without bumping into the receptor.
   (See :ref:`Figure: Example of the cavity arc style<figure_complex_surface_cavity>`)

   .. _figure_complex_surface_cavity:

   .. figure:: graphemetk/images/OEDefaultCavityArcFxn.*
      :align:  center

      **Example of the 'cavity' arc style**

#. **Void**  (:ref:`OEDefaultVoidArcFxn <OEGrapheme_OEDefaultVoidArcFxn>`)

   A surface arc is depicted using the *void* style, if in the
   region of the corresponding atom a small interstice is detected
   between the ligand and the receptor molecule surfaces.
   (See :ref:`Figure: OEDefaultBuriedArcFxn<figure_complex_surface_void>`)

   .. _figure_complex_surface_void:

   .. figure:: graphemetk/images/OEDefaultVoidArcFxn.*
      :align:  center

      **Example of the 'void' arc style**

#. **Buried** (:ref:`OEDefaultBuriedArcFxn <OEGrapheme_OEDefaultBuriedArcFxn>`)

   A surface arc is depicted using the *buried* style, if in the
   region of the corresponding atom the ligand is tightly fit to the
   receptor.
   (See :ref:`Figure: Example of the buried arc style<figure_complex_surface_buried>`)

   .. _figure_complex_surface_buried:

   .. figure:: graphemetk/images/OEDefaultBuriedArcFxn.*
      :align:  center

      **Example of the 'buried' arc style**

.. note::

   Even though, **Spicoli TK** is used to generate the accessible surfaces of
   the ligand and the receptor, no **Spicoli TK** license is required to call
   the :oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function.

.. #########################################################################

The following :oe:src:`Listing 1<SNIPPET-DRAW-COMPLEX-SURFACE-DrawComplexSurface>` example show how
to display the surface of the ligand-protein complex.
After importing the ligand and the receptor structures, the
:oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function is called to
generate the accessible molecule surfaces (using **Spicoli TK**) and assign
the surface drawing styles (*solvent*, *buried*, *void*, or *cavity*)
for the atoms of the ligand.
These styles are the used to draw the arcs of the molecule surface
when the :oe:func:`OEGrapheme::OEDraw2DSurface` function is invoked.
The :oe:func:`OEGrapheme::OEGetMoleculeSurfaceScale` function is used
to reduce the scaling of the molecule in order to be able to fit
both the molecule diagram and the molecule surface into the image.

.. oe:source:: DrawComplexSurface.py
   :language: python
   :refnum:   1
   :frag:     SNIPPET-DRAW-COMPLEX-SURFACE
   :caption:  Example of complex surface drawing

.. oe:source:: DrawComplexSurface.cpp
   :language: c++
   :refnum:   1
   :frag:     SNIPPET-DRAW-COMPLEX-SURFACE
   :caption:  Example of complex surface drawing

.. oe:source:: DrawComplexSurface.java
   :language: java
   :refnum:   1
   :frag:     SNIPPET-DRAW-COMPLEX-SURFACE
   :caption:  Example of complex surface drawing

.. oe:source:: DrawComplexSurface.cs
   :language: csharp
   :refnum:   1
   :frag:     SNIPPET-DRAW-COMPLEX-SURFACE
   :caption:  Example of complex surface drawing

The following snapshot (:ref:`Figure: Dihydrofolate reductase<figure_draw_complex_surface_vida>`)
displays the ligand of the *2w3a* PDB complex in VIDA
with the accessible surface of the protein.
The image shown in the :ref:`Figure: The Grapheme representation of the 2w3a complex<figure_draw_complex_surface_grapheme>`
is created by :oe:src:`Listing 1<SNIPPET-DRAW-COMPLEX-SURFACE-DrawComplexSurface>` code for the same
ligand-protein complex.

.. _figure_draw_complex_surface_vida:

.. figure:: /_images/DrawComplexSurface-VIDA.png
   :align:  center

   **Dihydrofolate reductase complexed with trimethoprim in VIDA (PDB 2w3a)**

.. _figure_draw_complex_surface_grapheme:

.. figure:: graphemetk/images/DrawComplexSurface.*
   :align:  center

   **The Grapheme representation of the 2w3a complex**

User-defined *solvent* and *buried* surface drawing styles can be
implemented by deriving from the
:ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>` base class.
Similarly, user-defined *cavity* and *void* surface drawing styles can be
implemented by deriving from the
:ref:`OEComplexSurfaceArcFxnBase <OEGrapheme_OEComplexSurfaceArcFxnBase>` base class.
This later abstract class also stores the relative distance calculated
between the ligand and the receptor.
The following code snippet shows how to use this *depth* to emphasize 
the volume of the cavity by adjusting the size of the *spikes* when
drawing the surface arcs using the :oe:func:`OEGrapheme::OEDrawSunSurfaceArc`
function.

.. #########################################################################

.. oe:source:: DrawComplexSurfaceUserDef.py
   :language: python
   :noindent:
   :frag:     SNIPPET-COMPLEX-SURFACE-ARC-DEFINITIONS

.. oe:source:: DrawComplexSurfaceUserDef.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-COMPLEX-SURFACE-ARC-DEFINITIONS

.. oe:source:: DrawComplexSurfaceUserDef.java
   :language: java
   :noindent:
   :frag:     SNIPPET-COMPLEX-SURFACE-ARC-DEFINITIONS

.. oe:source:: DrawComplexSurfaceUserDef.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-COMPLEX-SURFACE-ARC-DEFINITIONS

These arc drawing predicates then can be used to draw the surface of
the ligand-protein complex when calling the
:oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function.
The image created is shown in
:ref:`Figure: Example of user-defined surface drawing<figure_draw_complex_surface_user_defined>`.

.. oe:source:: DrawComplexSurfaceUserDef.py
   :language: python
   :noindent:
   :frag:     SNIPPET-COMPLEX-SURFACE-ARC-USAGE

.. oe:source:: DrawComplexSurfaceUserDef.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-COMPLEX-SURFACE-ARC-USAGE

.. oe:source:: DrawComplexSurfaceUserDef.java
   :language: java
   :noindent:
   :frag:     SNIPPET-COMPLEX-SURFACE-ARC-USAGE

.. oe:source:: DrawComplexSurfaceUserDef.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-COMPLEX-SURFACE-ARC-USAGE
 

.. _figure_draw_complex_surface_user_defined:

.. figure:: graphemetk/images/DrawComplexSurfaceUserDefined.*
   :align:  center

   **Example of user-defined surface drawing**

.. seealso::

   * :ref:`spicoli_generation` chapter in the  **Spicoli TK** manual




.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. _oegrapheme_chapter_cookbook_examples:

********************************************************************************
Python Cookbook Examples
********************************************************************************

There are large number of code examples available in
`OpenEye Python Cookbook <http://docs.eyesopen.com/python_modules/cookbook/index.html>`_
that use **OpenEye Toolkits** to solve a wide range of cheminformatics and molecular
modeling problems.

* `2D Depiction <http://docs.eyesopen.com/python_modules/cookbook/depiction/depiction.html>`_ chapter
  contains examples that illustrate how the **OEDepict TK** and **Grapheme TK** can be
  utilized to depict molecules and visualize properties calculated with other OpenEye toolkits.

* `Visualizing 3D Information <http://docs.eyesopen.com/python_modules/cookbook/visualization/visualization.html>`_
  chapter contains examples that illustrate how the **Grapheme TK** can be utilized to project
  complex 3D information into the 2D molecular graph.

* `Cheminformatics <https://docs.eyesopen.com/python_modules/cookbook/cheminfo/cheminfo.html>`_
  chapter contains examples that solve various cheminformatics problems such as similarity search,
  ring perception and manipulating molecular graphs.

* `Peptide Informatics <https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptideinfo.html>`_
  chapter contains examples that solve various peptide informatics problems such as generating custom monomer sets,
  parsing and generating :term:`HELM` representations, and visualizing peptides.


.. admonition:: OpenEye Python Cookbook examples using OEGrapheme TK

   * `Visualizing Torsional Angle Distribution`_
   * `Visualizing Electron Density`_
   * `Visualizing Molecular Dipole Moment`_
   * `Depicting Molecular Properties`_
   * `Visualizing Shape and Color Overlap`_

   Protein-ligand visualization:

   * `Visualizing Protein-Ligand Interactions`_
   * `Visualizing Protein-Ligand Unpaired Interactions`_
   * `Visualizing Protein-Ligand B-Factor`_
   * `Visualizing Protein-Ligand B-Factor Map`_
   * `Visualizing Protein-Ligand Contacts`_
   * `Visualizing Protein-Ligand Maps`_
   * `Ramachandran Plot`_

   Peptide visualization:

   * `Depict Peptide`_
   * `Depict Monomer`_


.. _oegrapheme_part_examples:

********************************
Examples
********************************

.. toctree::
   :maxdepth: 2

   examples_summary
   cookbook-examples

.. _oegrapheme_chapter_examples:

*************************
Grapheme Examples
*************************

The following table lists the currently available **Grapheme TK** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`bfactor2img<section_examples_summary_bfactor2img>`
        - depicting BFactor

      * - :ref:`complex2img<section_examples_summary_complex2img>`
        - depicting active site interactions

      * - :ref:`shapeoverlap2pdf<section_examples_summary_shapeoverlap2pdf>`
        - depicting shape and color atom overlaps

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`bfactor2img<section_examples_summary_bfactor2img>`
        - depicting BFactor

      * - :ref:`complex2img<section_examples_summary_complex2img>`
        - depicting active site interactions

      * - :ref:`shapeoverlap2pdf<section_examples_summary_shapeoverlap2pdf>`
        - depicting shape and color atom overlaps

.. oe:language:: java

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`BFactor2Img<section_examples_summary_bfactor2img>`
        - depicting BFactor

      * - :ref:`Complex2Img<section_examples_summary_complex2img>`
        - depicting active site interactions

      * - :ref:`ShapeOverlap2PDF<section_examples_summary_shapeoverlap2pdf>`
        - depicting shape and color atom overlaps

.. oe:language:: csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`BFactor2Img<section_examples_summary_bfactor2img>`
        - depicting BFactor

      * - :ref:`Complex2Img<section_examples_summary_complex2img>`
        - depicting active site interactions

      * - :ref:`ShapeOverlap2PDF<section_examples_summary_shapeoverlap2pdf>`
        - depicting shape and color atom overlaps

**Examples:**

.. toctree::
   :maxdepth: 1

   examples_summary_bfactor2img
   examples_summary_complex2img
   examples_summary_shapeoverlap2pdf



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. _section_examples_summary_bfactor2img:

Depicting BFactor
================================================================================

A program that depicts the B-factor of a ligand and its environment.

.. seealso::

   * `Visualizing Protein-Ligand B-Factor`_  **OpenEye Python Cookbook** example
   * `Visualizing Protein-Ligand B-Factor Map`_  **OpenEye Python Cookbook** example

Command Line Interface
--------------------------------------------------------------------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> bfactor2img --help

.. oe:language:: python

   .. code-block:: console

      prompt> python bfactor2img.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java BFactor2Img --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> BFactor2Img --help

will generate the following output:

::

    [-complex] <input> [-out] <output pdf>

    Simple parameter list
        -height : Height of output image
        -width : Width of output image

        SplitMolComplex options :
          -ligandname : Ligand name

        input/output options
          -complex : Input filename of the protein complex
          -out : Output filename

        molecule display options
          -aromstyle : Aromatic ring display style

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`bfactor2img.py <../../../../wrappers/python/examples/grapheme/bfactor2img.py>`

      .. literalinclude:: ../../../wrappers/python/examples/grapheme/bfactor2img.py

   .. only:: oepdf

      .. oe:source:: bfactor2img.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`bfactor2img.cpp <../../../../sublibs/tklibs/grapheme/examples/bfactor2img.cpp>`
         and
         :download:`bfactor2img.txt <../../../../sublibs/tklibs/grapheme/examples/bfactor2img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: bfactor2img.cpp
         :language: c++

      With the bfactor2img.txt interface file

      .. oe:source:: bfactor2img.txt
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`BFactor2Img.java <../../../../wrappers/java/examples/openeye/examples/oegrapheme/BFactor2Img.java>`
         and
         :download:`BFactor2Img.txt <../../../../wrappers/java/examples/openeye/examples/oegrapheme/BFactor2Img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: BFactor2Img.java
         :language: java

      With the BFactor2Img.txt interface file

      .. oe:source:: BFactor2Img.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`BFactor2Img.cs <../../../../wrappers/csharp/Csharp-Examples/OEGrapheme/BFactor2Img.cs>`

   .. only:: oepdf

      .. oe:source:: BFactor2Img.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEBio::OESplitMolComplex` function in **OEChem TK**
   * :ref:`OENearestNbrs <OEChem_OENearestNbrs>` class in **OEChem TK**
   * :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` function
   * :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>` class and
     :oe:func:`OEGrapheme::OEDraw2DSurface` function
   * :ref:`OEAtomGlyphBase <OEGrapheme_OEAtomGlyphBase>` class and
     :oe:func:`OEGrapheme::OEAddGlyph` function

Examples
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> bfactor2img -complex 1MEH.pdb -ligandname MOA -out MOA.png

.. oe:language:: python

   .. code-block:: console

      prompt> python bfactor2img.py -complex 1MEH.pdb -ligandname MOA -out MOA.png

.. oe:language:: java

   .. code-block:: console

      prompt> java BFactor2Img -complex 1MEH.pdb -ligandname MOA -out MOA.png

.. oe:language:: csharp

   .. code-block:: console

      prompt> BFactor2Img -complex 1MEH.pdb -ligandname MOA -out MOA.png

will generate the following output:

::

    Average BFactor of the complex = +32.721
    Minimum BFactor of the ligand and its environment = +21.500
    Maximum BFactor of the ligand and its environment = +72.060

and the image shown in
:ref:`Figure: Example of depicting the BFactor of MOA and its environment<figure_bfactor2img_MOA>`.

.. _figure_bfactor2img_MOA:

.. figure:: graphemetk/images/bfactor2img_MOA.*
   :align:  center

   **Example of depicting the BFactor of MOA and its environment**

.. oe:language:: c++

   .. code-block:: console

      prompt> bfactor2img -complex 1LEE.pdb -ligandname R36 -out R36.png

.. oe:language:: python

   .. code-block:: console

      prompt> python bfactor2img.py -complex 1LEE.pdb -ligandname R36 -out R36.png

.. oe:language:: java

   .. code-block:: console

      prompt> java BFactor2Img -complex 1LEE.pdb -ligandname R36 -out R36.png

.. oe:language:: csharp

   .. code-block:: console

      prompt> BFactor2Img -complex 1LEE.pdb -ligandname R36 -out MOA.R36

will generate the following output:

::

    Average BFactor of the complex = +23.754
    Minimum BFactor of the ligand and its environment = +6.040
    Maximum BFactor of the ligand and its environment = +32.050

and the image shown in
:ref:`Figure: Example of depicting the BFactor of R36 and its environment<figure_bfactor2img_R36>`.

.. _figure_bfactor2img_R36:

.. figure:: graphemetk/images/bfactor2img_R36.*
   :align:  center

   **Example of depicting the BFactor of R36 and its environment**



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. _section_examples_summary_complex2img:

Depicting Active Site Interactions
===================================================================================

A program that depicts receptor-ligand interactions.

.. seealso::

   * `Visualizing Protein-Ligand Interactions`_ OpenEye Python Cookbook example

Command Line Interface
-----------------------------------------------------------------------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> complex2img --help

.. oe:language:: python

   .. code-block:: console

      prompt> python complex2img.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java Complex2Img --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> Complex2Img --help

will generate the following output:

.. code-block:: console

    [-complex] <input> [-out] <output image>

    Simple parameter list
        -height : Height of output image
        -width : Width of output image

        SplitMolComplex options :
          -ligandname : Ligand name

        input/output options
          -complex : Input filename of the protein complex
          -out : Output filename

        molecule display options
          -aromstyle : Aromatic ring display style

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`complex2img.py <../../../../wrappers/python/examples/grapheme/complex2img.py>`

      .. literalinclude:: ../../../wrappers/python/examples/grapheme/complex2img.py

   .. only:: oepdf

      .. oe:source:: complex2img.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`complex2img.cpp <../../../../sublibs/tklibs/grapheme/examples/complex2img.cpp>`
         and
         :download:`complex2img.txt <../../../../sublibs/tklibs/grapheme/examples/complex2img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: complex2img.cpp
         :language: c++

      With the complex2img.txt interface file

      .. oe:source:: complex2img.txt
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Complex2Img.java <../../../../wrappers/java/examples/openeye/examples/oegrapheme/Complex2Img.java>`
         and
         :download:`Complex2Img.txt <../../../../wrappers/java/examples/openeye/examples/oegrapheme/Complex2Img.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: Complex2Img.java
         :language: java

      With the Complex2Img.txt interface file

      .. oe:source:: Complex2Img.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Complex2Img.cs <../../../../wrappers/csharp/Csharp-Examples/OEGrapheme/Complex2Img.cs>`

   .. only:: oepdf

      .. oe:source:: Complex2Img.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEBio::OESplitMolComplex` function in **OEChem TK**
   * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class in **OEChem TK**
   * :oe:func:`OEBio::OEPerceiveInteractionHints` function in **OEChem TK**
   * :oe:func:`OEGrapheme::OEPrepareActiveSiteDepiction` function
   * :ref:`OE2DActiveSiteDisplayOptions <OEGrapheme_OE2DActiveSiteDisplayOptions>` class
   * :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` class and
     :oe:func:`OEGrapheme::OERenderActiveSite` function
   * :oe:func:`OEGrapheme::OEDrawActiveSiteLegend` function

Examples
-----------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> complex2img -complex pdb1br6.ent -out 1br6-PT1.png

.. oe:language:: python

   .. code-block:: console

      prompt> python complex2img.py -complex pdb1br6.ent -out 1br6-PT1.png

.. oe:language:: java

   .. code-block:: console

      prompt> java Complex2Img complex2img.py -complex pdb1br6.ent -out 1br6-PT1.png

.. oe:language:: csharp

   .. code-block:: console

      prompt> Complex2Img complex2img.py -complex pdb1br6.ent -out 1br6-PT1.png

will generate the image shown in
:ref:`Figure: Example of depicting the receptor-ligand interaction (PDB: 1br6)<figure_complex2img_1br6_PT1>`.

.. _figure_complex2img_1br6_PT1:

.. figure:: graphemetk/images/complex2img-1br6-PT1.*
   :align:  center

   **Example of depicting the receptor-ligand interactions (PDB: 1br6)**

.. #################################################################################################################

.. oe:language:: c++

   .. code-block:: console

      prompt> complex2img -complex pdb1eoc.ent -out 1eoc-4NC.png

.. oe:language:: python

   .. code-block:: console

      prompt> python complex2img.py -complex pdb1eoc.ent -out 1eoc-4NC.png

.. oe:language:: java

   .. code-block:: console

      prompt> java Complex2Img.py -complex pdb1eoc.ent -out 1eoc-4NC.png

.. oe:language:: csharp

   .. code-block:: console

      prompt> Complex2Img.py -complex pdb1eoc.ent -out 1eoc-4NC.png

will generate the image shown in
:ref:`Figure: Example of depicting the receptor-ligand interaction (PDB: 1eoc)<figure_complex2img_1eoc_4NC>`.

.. _figure_complex2img_1eoc_4NC:

.. figure:: graphemetk/images/complex2img-1eoc-4NC.*
   :align:  center

   **Example of depicting the receptor-ligand interactions (PDB: 1eoc)**



.. _section_examples_summary_shapeoverlap2pdf:

Depicting Shape and Color Atom Overlaps
===================================================================================

A program that depicts the shape and the color overlap between a 3D
reference structure and a sets of pre-aligned 3D fit molecules.
It is implemented to visualize the output of `ROCS <http://www.eyesopen.com/rocs>`_
but can be used to visualize the shape and color similarities of any
molecules that have been pre-aligned with other applications.

.. note::

   **OEShape TK** license is **not** required to run this example.

Command Line Interface
-----------------------------------------------------------------------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> shapeoverlap2pdf --help

.. oe:language:: python

   .. code-block:: console

      prompt> python shapeoverlap2pdf.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java ShapeOverlap2PDF --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> ShapeOverlap2PDF --help

will generate the following output:

::

   [-in] <input> [-out] <output pdf>

    Simple parameter list
        input/output options:
          -in : Input molecule filename
          -out : Output image filename

        general options:
          -maxhits : Maximum number of hits depicted

Code
-----------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`shapeoverlap2pdf.py <../../../../wrappers/python/examples/grapheme/shapeoverlap2pdf.py>`

      .. literalinclude:: ../../../wrappers/python/examples/grapheme/shapeoverlap2pdf.py

   .. only:: oepdf

      .. oe:source:: shapeoverlap2pdf.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`shapeoverlap2pdf.cpp <../../../../sublibs/tklibs/grapheme/examples/shapeoverlap2pdf.cpp>`
         and
         :download:`shapeoverlap2pdf.txt <../../../../sublibs/tklibs/grapheme/examples/shapeoverlap2pdf.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: shapeoverlap2pdf.cpp
         :language: c++

      With the shapeoverlap2pdf.txt interface file

      .. oe:source:: shapeoverlap2pdf.txt
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeOverlap2PDF.java <../../../../wrappers/java/examples/openeye/examples/oegrapheme/ShapeOverlap2PDF.java>`
         and
         :download:`ShapeOverlap2PDF.txt <../../../../wrappers/java/examples/openeye/examples/oegrapheme/ShapeOverlap2PDF.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: ShapeOverlap2PDF.java
         :language: java

      With the ShapeOverlap2PDF.txt interface file

      .. oe:source:: ShapeOverlap2PDF.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeOverlap2PDF.cs <../../../../wrappers/csharp/Csharp-Examples/OEGrapheme/ShapeOverlap2PDF.cs>`

   .. only:: oepdf

      .. oe:source:: ShapeOverlap2PDF.cs
         :language: csharp

.. seealso::

   * :ref:`OEColorForceField <OEShape_OEColorForceField>` class in the **OEShape TK**
   * :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` and
     :ref:`OEShapeQueryDisplayOptions <OEGrapheme_OEShapeQueryDisplayOptions>` classes
   * :oe:func:`OEGrapheme::OERenderShapeQuery` function
   * :oe:func:`OEGrapheme::OEShapeOverlapDisplay`,
     :ref:`OEShapeOverlapDisplayOptions <OEGrapheme_OEShapeOverlapDisplayOptions>`, and
     :ref:`OEColorOverlapDisplayOptions <OEGrapheme_OEColorOverlapDisplayOptions>` classes
   * :oe:func:`OEGrapheme::OERenderShapeOverlap` function
   * :oe:func:`OEGrapheme::OERenderColorOverlap` function
   * :oe:func:`OEGrapheme::OEDrawColorForceFieldLegend` function
   * :oe:func:`OEGrapheme::OEDrawROCSScores` function

Examples
-----------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> shapeoverlap2pdf -in  rocs.sdf -out overlaps.pdf

.. oe:language:: python

   .. code-block:: console

      prompt> python shapeoverlap2pdf.py -in rocs.sdf -out overlaps.pdf

.. oe:language:: java

   .. code-block:: console

      prompt> java ShapeOverlap2PDF -in rocs.sdf -out overlaps.pdf

.. oe:language:: csharp

   .. code-block:: console

      prompt> ShapeOverlap2PDF -in rocs.sdf -out overlaps.pdf

.. _table_depiction_shapeoverlap2pdf:

.. list-table::  **Example of depicting the shape and color atom overlaps** (The pages are reduced here for visualization convenience)
   :header-rows: 1
   :widths: 300 300 300

   * - page 1
     - page 2
     - page 3

   * -  .. image:: images/shapeoverlap2pdf-page-1.*
           :width: 400
     -  .. image:: images/shapeoverlap2pdf-page-2.*
           :width: 400
     -  .. image:: images/shapeoverlap2pdf-page-3.*
           :width: 400



.. _chapter_draw_prop_map:

********************************************************************************
Depicting Property Maps
********************************************************************************

The previous chapters give examples about how to depict atom
properties either by using glyphs (see :ref:`chapter_annotation`
chapter) or projecting them into a 2D molecule surface (see
:ref:`chapter_draw_surface` chapter).
**Grapheme TK** can also map atom properties into a 2D grid, called
a property map, using a Gaussian function.
After the grid is generated, colors are rendered to each cell using
the :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class that interpolates
colors between a specified range.

The following :oe:src:`Listing 1<SNIPPET-2DPROPMAP-PCHARGE-Draw2DPropMapPartialCharge>` example
demonstrates  how to depict partial charges using the property map.
After constructing the molecule and preparing it for depiction, the MMFF
partial charges are calculated. 
These partial charges are attached to the corresponding atom as
generic data with a specific *tagname*.
A :ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>` object is then generated by
specifying three colors:

* the background color of the property map
* one that represents negative values (in this case charges), and
* the color that represents positive values in the property map

When the :oe:meth:`OEGrapheme::OE2DPropMap::Render` method is called
with the *tagname*, the properties that were attached to the atoms as
generic data are retrieved and a 2D grid is generated along with an
:ref:`OELinearColorGradient <OESystem_OELinearColorGradient>`
object that is used to assign colors to the *cells* of the grid.
The colored grid is then rendered into the *below* layer of the
:ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object, *i.e.*, it appears underneath
the molecular diagram.
The image created by :oe:src:`Listing 1<SNIPPET-2DPROPMAP-PCHARGE-Draw2DPropMapPartialCharge>` is
shown in :ref:`Figure: Example of depicting a property map<figure_draw_propmap_partial_charge>`.

.. oe:source:: Draw2DPropMapPartialCharge.py
   :language: python
   :refnum:   1
   :frag:     SNIPPET-2DPROPMAP-PCHARGE
   :caption:  Depicting partial charges using property map

.. oe:source:: Draw2DPropMapPartialCharge.cpp
   :language: c++
   :refnum:   1
   :frag:     SNIPPET-2DPROPMAP-PCHARGE
   :caption:  Depicting partial charges using property map

.. oe:source:: Draw2DPropMapPartialCharge.java
   :language: java
   :refnum:   1
   :frag:     SNIPPET-2DPROPMAP-PCHARGE
   :caption:  Depicting partial charges using property map

.. oe:source:: Draw2DPropMapPartialCharge.cs
   :language: csharp
   :refnum:   1
   :frag:     SNIPPET-2DPROPMAP-PCHARGE
   :caption:  Depicting partial charges using property map

.. _figure_draw_propmap_partial_charge:

.. figure:: graphemetk/images/Draw2DPropMapPartialCharge.*
   :align:  center

   **Example of depicting a property map**

.. seealso::

   * `Generic Data` chapter in the **OEChem TK** manual.

When the :oe:meth:`OEGrapheme::OE2DPropMap::Render` method is called,
the color gradient is initialized by searching for the minimum and
maximum values by the given *tagname*.
This means that when more than one molecule is depicted,
each depiction will have its own independent value range.
(See :ref:`Figure: Example of depicting a property map<figure_draw_prop_map_multi_no_range>`).

.. _figure_draw_prop_map_multi_no_range:

.. figure:: graphemetk/images/Draw2DPropMapPartialChargeMulti-NoRange.*
   :align:  center

   **Example of depicting multiple property maps**

In the :oe:src:`Listing 2<SNIPPET-2DPROPMAP-PCHARGE-MULTI-Draw2DPropMapPChargeMulti>` example,
the value range of the property map is pre-set by identifying the minimum
and maximum atom partial charges for a whole molecule set.
See the result in 
:ref:`Figure: Example of depicting property maps in the same value range<figure_draw_prop_map_multi>`.
Each black box around the color gradient legend indicates the
range of the atom partial charges for the corresponding molecule.

.. oe:source:: Draw2DPropMapPChargeMulti.py
   :language: python
   :refnum:   2
   :frag:     SNIPPET-2DPROPMAP-PCHARGE-MULTI
   :caption:  Depicting multiple molecules using property map

.. oe:source:: Draw2DPropMapPChargeMulti.cpp
   :language: c++
   :refnum:   2
   :frag:     SNIPPET-2DPROPMAP-PCHARGE-MULTI
   :caption:  Depicting multiple molecules using property map

.. oe:source:: Draw2DPropMapPChargeMulti.cs
   :language: csharp
   :refnum:   2
   :frag:     SNIPPET-2DPROPMAP-PCHARGE-MULTI
   :caption:  Depicting multiple molecules using property map

.. oe:source:: Draw2DPropMapPChargeMulti.java
   :language: java
   :refnum:   2
   :frag:     SNIPPET-2DPROPMAP-PCHARGE-MULTI
   :caption:  Depicting multiple molecules using property map

.. _figure_draw_prop_map_multi:

.. figure:: graphemetk/images/Draw2DPropMapPartialChargeMulti.*
   :align:  center

   **Example of depicting a property maps in the same value range**

.. seealso::

   * :ref:`OEImageGrid <OEDepict_OEImageGrid>` class in the **OEDepict TK** manual

.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   %
   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

The above examples show how to project atom properties (such as partial charges)
into the property map.
However, the :ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>` class can also be used to visualize
bond properties by attaching a value to each bond as a generic data using a *tagname*.
When the :oe:meth:`OEGrapheme::OE2DPropMap::Render` method is called
with the same *tagname*, the property that was attached to a bond is retrieved and
projected at the middle of that bond before applying a Gaussian function to blur
out the 2D grid underneath the molecular graph.
The :ref:`Table: Depicting atom or/and bond properties<table_draw_prop_map_atom_bond>`
table shows the differences between visualizing atom or/and bond properties using the
:ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>` class.

.. _table_draw_prop_map_atom_bond:

.. list-table:: **Depicting atom or/and bond properties**
   :widths: 150 150 150
   :header-rows: 0

   * - .. image:: images/OE2DPropMap_AtomProperties.*
          :align:  center
     - .. image:: images/OE2DPropMap_AtomAndBondProperties.*
          :align:  center
     - .. image:: images/OE2DPropMap_BondProperties.*
          :align:  center

   * - only atom
     - both atom and bond
     - only bond


.. _oegrapheme_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version1_5_5
   version1_5_4
   version1_5_3
   version1_5_2
   version1_5_1
   version1_5_0
   version1_4_7
   version1_4_6
   version1_4_5
   version1_4_4
   version1_4_3
   version1_4_2
   version1_4_1
   version1_4_0
   version1_3_7
   version1_3_6
   version1_3_5
   version1_3_4
   version1_3_3
   version1_3_2
   version1_3_1
   version1_3_0
   version1_2_3
   version1_2_2
   version1_2_1
   version1_2_0
   version1_1_3
   version1_1_2
   version1_1_1
   version1_1_0
   version1_0_6
   version1_0_5
   version1_0_4
   version1_0_3
   version1_0_2
   version1_0_1
   version1_0_0


Grapheme\ :sup:`TM` TK 1.5.5
================================================================================

New Features
--------------------------------------------------------------------------------

* The following preliminary APIs have been added for monomer and peptide
  depiction support.

  **Classes:**

  * :oe:cls:`OEGrapheme::OEPeptideDisplayOptions` — options for peptide depiction.
  * :oe:cls:`OEGrapheme::OEHighlightMonomerDisplayOptions` — options for monomer highlight depiction.
  * :oe:cls:`OEGrapheme::OEMonomerColorDefault` — default monomer color functor.
  * :oe:cls:`OEGrapheme::OEMonomerColorMonochrome` — monochrome monomer color functor.
  * :oe:cls:`OEGrapheme::OEMonomerGlyphStyleBase` — base class for monomer glyph style functor.
  * :oe:cls:`OEGrapheme::OEMonomerGlyphStyleDefault` — default monomer glyph style functor.
  * :oe:cls:`OEGrapheme::OEMonomerGraphDisplayOptions` — options for monomer graph depiction.

  **Functions:**

  * :oe:func:`OEGrapheme::OEDrawMonomer` — draws a monomer image.
  * :oe:func:`OEGrapheme::OEDrawMonomerGraph` — draws a monomer graph of a peptide.
  * :oe:func:`OEGrapheme::OEHighlightMonomers` — highlights monomers in a peptide depiction.

* The :oe:func:`OEGrapheme::OERenderActiveSite` function now displays a counter on
  the top of the T- and pi-stacking interaction lines if multiple interactions
  exist between the aromatic ring of the ligand and the aromatic ring of a specific
  residue.

.. only:: oehtml

   .. figure:: /_images/stacking-count.svg
      :align: center
      :width: 400pt

      **Figure 1.** Example of visualizing multiple stacking interactions (PDB:4TX6).

* The following APIs have been added to allow customization of ligand alignment
  in protein–ligand interaction depictions:

  * :oe:cls:`OEGrapheme::OELigandAlignerBase`
  * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetLigandAlignerFunctor` method
  * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetOptimizeLigandOrientation` method

.. only:: oehtml

   .. list-table::

      * - default ligand orientation
        - ligand aligned to reference substructure

      * -  .. image:: ../../graphemetk/images/releasenotes-latest/complex2image-default.svg
              :width: 250pt
        -  .. image:: ../../graphemetk/images/releasenotes-latest/complex2image-aligned.svg
              :width: 250pt

Minor Bug Fixes
--------------------------------------------------------------------------------

* The :oe:func:`OEGrapheme::OEDrawResidues` function now depicts molecules
  with up to 300 heavy atoms.



Grapheme\ :sup:`TM` TK 1.5.4
================================================================================

Minor internal improvements have been made.



Grapheme TK 1.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* Providing a mechanism to annotate atoms and bonds in the depicted molecule
  (see also :ref:`Annotating Atoms and Bonds<chapter_annotation>` chapter)

* Implementing the :ref:`OEAtomGlyphCircle <OEGrapheme_OEAtomGlyphCircle>` atom
  annotation style and allowing user-defined styles that derive from the
  :ref:`OEAtomGlyphBase <OEGrapheme_OEAtomGlyphBase>` abstract class

* Implementing the :ref:`OEBondGlyphArrow <OEGrapheme_OEBondGlyphArrow>` and the
  :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>` bond annotation styles and
  allowing user-defined styles that derive from the:
  :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>` abstract class

* Adding 18 default circle drawing styles (:oe:constns:`OEGrapheme::OECircleStyle`)
  that can be customized (see for example the :oe:func:`OEGrapheme::OEDrawCastleCircle` function)

* Adding 17 default arc drawing styles (:oe:constns:`OEGrapheme::OESurfaceArcStyle`)
  that can be customized (see for example the :oe:func:`OEGrapheme::OEDrawCastleSurfaceArc` function)

* Adding the :ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>` class that generates a 2D grid of
  user-defined atom properties (see :ref:`Depicting Atom Property Map<chapter_draw_prop_map>` chapter).

* Adding functions that automatically generate standard interfaces for
  *Grapheme* applications  (see :oe:func:`OEGrapheme::OEConfigure2DPropMap` and
  :oe:func:`OEGrapheme::OESetup2DPropMap` functions)
 
* Adding the :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` and the
  :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D` functions in which the
  generation of the 2D coordinates of a molecule is driven by a
  given 3D reference molecule.

* Drawing molecule surfaces :oe:func:`OEGrapheme::OEDraw2DSurface`
  (see :ref:`Drawing Molecule Surface<chapter_draw_surface>` chapter)

* Providing 18 built-in surface drawing styles and allowing to
  the implementation of user-defined ones.

* Drawing complex molecule surfaces where the distance between the ligand and the receptor
  is projected into the 2D molecule surface (:oe:func:`OEGrapheme::OEAddComplexSurfaceArcs`)
  Implementing the four default styles for drawing complex surfaces 
  (:ref:`OEDefaultBuriedArcFxn <OEGrapheme_OEDefaultBuriedArcFxn>`, :ref:`OEDefaultCavityArcFxn <OEGrapheme_OEDefaultCavityArcFxn>`,
  :ref:`OEDefaultSolventArcFxn <OEGrapheme_OEDefaultSolventArcFxn>` and :ref:`OEDefaultVoidArcFxn <OEGrapheme_OEDefaultVoidArcFxn>`)
  and handling user-defined ones (see :ref:`Drawing Ligand-Protein Complex Surface<chapter_complex_surface>` chapter).



Grapheme TK 1.0.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Scaling the fonts of the legend of the :ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>` class
  based upon the scale of the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object.




Grapheme TK 1.0.2
================================================================================

Minor bug fix
--------------------------------------------------------------------------------

* Avoiding extraneous runtime warnings from
  :oe:func:`OEGrapheme::OEDrawPearlsCircle` and
  :oe:func:`OEGrapheme::OEDrawFlowerCircle` when the pen's fill is
  turned off.

Documentation changes
--------------------------------------------------------------------------------

* Some examples and images were updated in order to consistently use red and blue 
  color for representing negative and positive values respectively when using 
  the :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class.

* All images in this manual are now automatically generated as part of the release 
  process and tested against benchmark images on all supported platforms.




Grapheme TK 1.0.3
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OEBondGlyphCurvedArrow <OEGrapheme_OEBondGlyphCurvedArrow>` added as a new bond annotation style.

* :oe:meth:`OEGrapheme::OE2DPropMap::GetLegendFont` and
  :oe:meth:`OEGrapheme::OE2DPropMap::GetLegendFontScale` methods added in order to
  customize the legend font of the property map.

Minor bug fixes
--------------------------------------------------------------------------------

* :ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>` legend layout improved.

* :ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>` will now display at least one
  decimal number when rendering the value of the linear color gradient
  of the class.

* :ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>` will now set the line width of the
  box around the linear color gradient to the default bond line width
  of the molecule.

* Increased the line width of the following complex arc styles:
  :ref:`OEDefaultSolventArcFxn <OEGrapheme_OEDefaultSolventArcFxn>`,
  :ref:`OEDefaultCavityArcFxn <OEGrapheme_OEDefaultCavityArcFxn>`, and
  :ref:`OEDefaultVoidArcFxn <OEGrapheme_OEDefaultVoidArcFxn>`.

* Atoms that are not visible are now not considered for the minimum
  and maximum range of the linear color gradient.

* Fixed cases where the property value of adjacent atoms had opposite
  signs and the colors were not blurred smoothly by increasing the
  size of the box used to blur the values.

.. oe:language:: python
   
   * :oe:func:`OEGrapheme::OEDraw2DSurface` and
     :oe:func:`OEGrapheme::OEAddGlyph` will no longer crash due to the
     ``Swig::DirectorTypeMismatchException`` C++ exception being
     thrown. A Python ``RuntimeError`` exception will now be thrown
     instead indicating that the ``__call__`` methods of the class
     deriving from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`,
     :ref:`OEAtomGlyphBase <OEGrapheme_OEAtomGlyphBase>`, or
     :ref:`OEBondGlyphBase <OEGrapheme_OEBondGlyphBase>` needs to return a boolean
     value.

Documentation changes
--------------------------------------------------------------------------------

* All images were automatically regenerated to reflect the changes made
  since the previous release.



Grapheme TK 1.0.4
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEGrapheme::OEDrawColorGradient` function and
  :ref:`OEColorGradientDisplayOptions <OEGrapheme_OEColorGradientDisplayOptions>` class added to
  visualize color gradients.

Major bug fixes
-------------------------------------------------------------------------------

* :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D` improved to
  produce better alignments in many cases. 

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` improved to produce
  2D coordinates that align better with the input 3D coordinates. 

* :ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>` default background color changed
  from a very light grey to pure white.

  See the effect of this change in :ref:`Table: Example of depicting a property map
  <table_ExamplePropMap>`.

  .. _table_ExamplePropMap:

  .. list-table::  **Example of depicting a property map**

     * - **Grapheme TK 1.0.3**
       - **Grapheme TK 1.0.4**
     * - .. image:: ../../graphemetk/images/releasenotes-1.0.4/PropMap-toolkits2012_Jun.*
       - .. image:: ../../graphemetk/images/releasenotes-1.0.4/PropMap-toolkits2012_Oct.*

Documentation changes
--------------------------------------------------------------------------------

* All images were automatically regenerated to reflect the changes made
  since the previous release.



Grapheme TK 1.0.5
================================================================================

New features
--------------------------------------------------------------------------------

* Added the following methods to the :ref:`OEColorGradientDisplayOptions <OEGrapheme_OEColorGradientDisplayOptions>`
  class that allow the customization of the gradient visualization.

  * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange`
    and :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRangePen`

  * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValuePen`
    and :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValuePrecision`

  * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValues`
    and :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValues`

  * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetColorStopLabelFontScale`

* Added the :ref:`OEBondGlyphCross <OEGrapheme_OEBondGlyphCross>` and
  the :ref:`OEBondGlyphScissors <OEGrapheme_OEBondGlyphScissors>` bond glyphs.




Grapheme TK 1.0.6
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D` performance
  improvement of 10% on average.

* The :ref:`OE2DPropMap <OEGrapheme_OE2DPropMap>` class now allows rendering
  bond properties along with atom ones.
  See examples in the :ref:`Table: Depicting atom or/and bond properties<table_draw_prop_map_atom_bond>`.

.. oe:language:: c++

   * Implemented the :ref:`bfactor2img.cpp<section_examples_summary_bfactor2img>` C++ **Grapheme TK** example.

.. oe:language:: python

   * Implemented the :ref:`bfactor2img.py<section_examples_summary_bfactor2img>` Python **Grapheme TK** example.

.. oe:language:: java

   * Implemented the :ref:`Bfactor2Img.java<section_examples_summary_bfactor2img>` Java **Grapheme TK** example.

.. oe:language:: csharp

   * Implemented the :ref:`Bfactor2Img.cs<section_examples_summary_bfactor2img>` C# **Grapheme TK** example.

Major bug fixes
-------------------------------------------------------------------------------

* The :oe:func:`OEGrapheme::OEDrawColorGradient` functions now takes an
  :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>` object allowing to depict the
  following color gradients derived from the :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>`
  base class:

  * :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>`
  * :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>`
  * :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>`
  * :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>`

Minor bug fixes
--------------------------------------------------------------------------------

* Using a pen with miter line join in order to make the transition between
  grid cells smoother when rendering the property map by the
  :oe:meth:`OEGrapheme::OE2DPropMap::Render` method.

* The :oe:meth:`OEGrapheme::OE2DPropMap::SetResolution` lower limit has been
  reduced from `2` to `1`.
  Using resolution `1` will result in a very smooth property grid, however
  it significantly increase the size of vector images
  (such as :file:`.pdf` and  :file:`.ps`).

Documentation changes
--------------------------------------------------------------------------------

* Importing the following OESystem classes from the **OEChem TK** documentation.

  * :ref:`OEColor <OESystem_OEColor>`
  * :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>`
  * :ref:`OEColorStop <OESystem_OEColorStop>`
  * :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>`
  * :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>`
  * :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>`
  * :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>`

* All images were automatically regenerated to reflect the changes made
  since the previous release.




Grapheme TK 1.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* Added the following to visualize color forcefields:

  * :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>`
  * :ref:`OEColorForceFieldLegendDisplayOptions <OEGrapheme_OEColorForceFieldLegendDisplayOptions>`
  * :oe:func:`OEGrapheme::OEDrawColorForceFieldLegend`

* Added the following to visualize the reference molecule of a color
  and shape overlap:

  * :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>`
  * :ref:`OEShapeOverlapDisplayOptions <OEGrapheme_OEShapeOverlapDisplayOptions>`
  * :oe:func:`OEGrapheme::OERenderShapeQuery`

* Added the following to visualize shape and color overlaps:

  * :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>`
  * :ref:`OEShapeOverlapDisplayOptions <OEGrapheme_OEShapeOverlapDisplayOptions>`
  * :oe:func:`OEGrapheme::OERenderShapeOverlap`
  * :ref:`OEColorOverlapDisplayOptions <OEGrapheme_OEColorOverlapDisplayOptions>`
  * :oe:func:`OEGrapheme::OERenderColorOverlap`

.. note::

   A valid **shape** license is required to use any of these new shape
   or color APIs.

* Added the :ref:`OEDepictionFrom3DOptions <OEGrapheme_OEDepictionFrom3DOptions>` class that
  allows more advanced customization of the generation of 2D
  coordinates driven by the 3D conformation when calling the
  :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` function. By default,
  :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` is tuned for
  generating 2D coordinates for representing 3D overlays in 2D. This
  class allows the 2D coordinate generation to choose a set of 2D
  coordinates that are much closer to how the molecule would look in a
  3D viewer.

* Added the following to render user-defined labels when depicting
  color gradients:

  * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddLabel`
  * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearLabels`
  * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetLabels`

* Added :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearBoxRange` method
  to remove the box range previously set to a color gradient.

* Added :oe:func:`OEGrapheme::OEGet2DSurfaceArcs` function to return
  the arcs of the molecule surface of a specific atom with the given
  radius. Varying radii can be passed to generate multiple surfaces in
  the range specified by the
  :oe:constns:`OEGrapheme::OESurfaceArcScale`
  namespace. :oe:func:`OEGrapheme::OEGetMoleculeSurfaceScale` can be
  used to determine the appropriate scale for the molecule with the
  specified radius.

.. oe:language:: c++

   * Implemented the :ref:`shapeoverlap2pdf.cpp<section_examples_summary_shapeoverlap2pdf>`
     C++ **Grapheme TK** example.

.. oe:language:: python

   * Implemented the :ref:`shapeoverlap2pdf.py<section_examples_summary_shapeoverlap2pdf>`
     Python **Grapheme TK** example.

.. oe:language:: java

   * Implemented the :ref:`ShapeOverlap2PDF.java<section_examples_summary_shapeoverlap2pdf>`
     Java **Grapheme TK** example.

   * Rewriting the ViewShapeMatch.java Java **Grapheme TK** example
     using the new classes and functions designed to depict
     shape and color overlaps.

.. oe:language:: csharp

   * Implemented the :ref:`ShapeOverlap2PDF.cs<section_examples_summary_shapeoverlap2pdf>`
     C# **Grapheme TK** example.

Major bug fixes
-------------------------------------------------------------------------------

* Molecule surface arcs inside macrocycles are no longer returned. 
  See the effect of this change in :ref:`Table: Example of depicting molecule surface
  <table_ExampleMoleculeSurface>`.

  .. _table_ExampleMoleculeSurface:

  .. list-table::  **Example of depicting molecule surface**

     * - **Grapheme TK 1.0.6 (2013 Jun)**
       - **Grapheme TK 1.1.0 (2013 Oct)**
     * - .. image:: ../../graphemetk/images/releasenotes-1.1.0/Draw2DSurface_2013_Jun.*
       - .. image:: ../../graphemetk/images/releasenotes-1.1.0/Draw2DSurface_2013_Oct.*

Documentation changes
--------------------------------------------------------------------------------

* All images were automatically regenerated to reflect the changes made
  since the previous release.



Grapheme TK 1.1.1
================================================================================

New features
--------------------------------------------------------------------------------

* Added the following setter and getter methods that control whether a
  background color is cleared prior to rendering.
  This allows to generate an image with transparent background.

  * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::GetClearBackground` and
    :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::SetClearBackground`

  * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::GetClearBackground` and
    :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetClearBackground`

  * :oe:meth:`OEGrapheme::OEColorOverlapDisplayOptions::GetClearBackground` and
    :oe:meth:`OEGrapheme::OEColorOverlapDisplayOptions::SetClearBackground`

Minor bug fixes
-------------------------------------------------------------------------------

.. oe:language:: python

   * **OEDepict TK** symbols are no longer imported along with the
     ``oegrapheme`` module.

.. oe:language:: java

   * **API change:** The following APIs take a java.util.List<Double> parameter:

     * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValues`
     * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValues` 
     

* Added "BRIEF" line to interfaces of **Grapheme TK** examples.

Documentation changes
--------------------------------------------------------------------------------

* Added example of drawing multiple 2D surfaces in the
  :ref:`Drawing a Molecule Surface <chapter_draw_surface>` chapter.

* All images were automatically regenerated to reflect the changes made
  since the previous release.



Grapheme TK 1.1.2
================================================================================

New features
--------------------------------------------------------------------------------

* Added :ref:`OEBondGlyphZigZag <OEGrapheme_OEBondGlyphZigZag>` and :ref:`OEBondGlyphStitch <OEGrapheme_OEBondGlyphStitch>`
  bond annotation classes.

* Added the following methods to control the color of the property map
  generated by :oe:func:`OEGrapheme::OERenderShapeOverlap`:

  * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::GetOverlapColor`
  * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetOverlapColor`

* The maximum number of bond rotations performed by
  :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` when 2D depiction
  coordinates are generated based on 3D can be controlled by the
  following methods:

  * :oe:meth:`OEGrapheme::OEDepictionFrom3DOptions::GetMaxBondRotations`
  * :oe:meth:`OEGrapheme::OEDepictionFrom3DOptions::SetMaxBondRotations`

Major bug fixes
--------------------------------------------------------------------------------

* The following classes and functions were made thread safe:

  - :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>`
  - :oe:func:`OEGrapheme::OERenderShapeQuery`
  - :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>`
  - :oe:func:`OEGrapheme::OERenderShapeOverlap`
  - :oe:func:`OEGrapheme::OERenderColorOverlap`

  These functions were introduced in 2013.Oct and were not thread safe
  for the 2013.Oct and 2014.Feb releases.

.. oe:language:: java

   * The :ref:`OEColorGradientDisplayOptions <OEGrapheme_OEColorGradientDisplayOptions>` class is
     now usable in Java.

Documentation changes
--------------------------------------------------------------------------------

* All images were automatically regenerated to reflect the changes made
  since the previous release.

* Multiple examples migrated to the `OpenEye Python Cookbook
  <http://docs.eyesopen.com/toolkits/cookbook/python/>`_.




Grapheme TK 1.1.3
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEGrapheme::OEGet2DSurfaceArcs` now has a radius scale
  parameter that allows the radii of the arcs to be easily scaled to
  different sizes.

* :oe:func:`OEGrapheme::OEGet2DSurfaceArcs` now allows the generation
  of molecule surfaces with a different radius for every atom.  See
  :oe:src:`Listing 5<Draw2DSurfaceVariousRadii>` in
  :ref:`chapter_draw_surface` chapter.

* The following classes do not require a valid **Shape TK** license any longer.

  * :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>` class
  * :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` class
  * :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` class

Major bug fixes
--------------------------------------------------------------------------------

* When atom clashes are checked during the molecule alignment of the
  :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D` function,
  every atom is now considered not just the heavy atoms.

Minor bug fixes
--------------------------------------------------------------------------------

* :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>`,
  :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>`,
  :oe:func:`OEGrapheme::OERenderColorOverlap`,
  :oe:func:`OEGrapheme::OERenderShapeOverlap` will no longer crash when
  dealing with improperly initialized objects.

* :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` performance has been
  improved.

* :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` will now just alter
  coordinates in-place, and not invalidate all
  :ref:`OEAtomBase <OEChem_OEAtomBase>` and :ref:`OEBondBase <OEChem_OEBondBase>`
  pointers.

* Added parameter checks to the :oe:func:`OEGrapheme::OEAddComplexSurfaceArcs`
  function

Documentation changes
--------------------------------------------------------------------------------

* All images in this documentation were automatically regenerated to
  reflect the changes made since the previous release.



Grapheme TK 1.2.0
================================================================================

New features
--------------------------------------------------------------------------------

* The following classes and functions have been added for visualizing ligand-receptor interactions:

  * :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` class
  * :ref:`OE2DActiveSiteDisplayOptions <OEGrapheme_OE2DActiveSiteDisplayOptions>` class
  * :ref:`OE2DActiveSiteLegendDisplayOptions <OEGrapheme_OE2DActiveSiteLegendDisplayOptions>` class
  * :oe:func:`OEGrapheme::OEPrepareActiveSiteDepiction` function
  * :oe:func:`OEGrapheme::OERenderActiveSite` function
  * :oe:func:`OEGrapheme::OEDrawActiveSiteLegend` function

* A new **Grapheme TK** example that visualizes receptor-ligand interactions
  has been added.  For more details, see the 
  :ref:`section_examples_summary_complex2img` section.

Major bug fixes
--------------------------------------------------------------------------------

* When generating a 2D layout from a 3D conformation by using the
  :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` function, the
  configuration of the amide bonds are now always respected.

  .. _table_amide:

  .. list-table:: **Example of generating a 2D layout from a 3D conformation**
     :widths: 50 50 50

     * - **Grapheme TK version 1.1.3**
       -
       - **Grapheme TK version 1.2.0**

     * - .. image:: ../../graphemetk/images/releasenotes-1.2.0/amide-toolkit-2014-Oct.*
       - .. image:: ../../graphemetk/images/releasenotes-1.2.0/amide-VIDA-screenshot.png
            :width: 200 pt
       - .. image:: ../../graphemetk/images/releasenotes-1.2.0/amide-toolkit-2015-Feb.*

Minor bug fixes
--------------------------------------------------------------------------------

* The memory leak has been fixed and a check has been added to prevent 
  division-by-zero in the :oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function.

Documentation changes
--------------------------------------------------------------------------------

* All images in this documentation were automatically regenerated to
  reflect the changes made since the previous release.

* More C# examples have been added.



Grapheme TK 1.2.1
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` has been optimized
  to be twice as fast on average.

Documentation changes
--------------------------------------------------------------------------------

* The following examples have been updated to use
  :oe:func:`OEBio::OESplitMolComplex` for separating the ligand
  and protein:

  - :ref:`bfactor2img<section_examples_summary_bfactor2img>` example
  - :ref:`complex2img<section_examples_summary_complex2img>` example

* All images in this documentation were automatically regenerated to
  reflect the changes made since the previous release.



Grapheme TK 1.2.2
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEGrapheme::OEDrawROCSScores` function has been added
  to visualize scores.

  .. figure:: graphemetk/images/DrawROCSScores.*
     :align:  center

* :ref:`OEAlignedDepictionFrom3DOptions <OEGrapheme_OEAlignedDepictionFrom3DOptions>` has been added
  to allow more customization of the
  :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D` function.

* :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::GetDepictOrientation` and
  :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::SetDepictOrientation` methods
  have been added to allow the shape query to orient
  :oe:const:`horizontal<OEDepict::OEDepictOrientation::Horizontal>`,
  :oe:const:`vertical<OEDepict::OEDepictOrientation::Vertical>`, or
  :oe:const:`square<OEDepict::OEDepictOrientation::Square>`.

* :oe:meth:`OEGrapheme::OEShapeQueryDisplay::GetTitle` and
  :oe:meth:`OEGrapheme::OEShapeOverlapDisplay::GetTitle` methods were
  added to access the title of the objects.

* :oe:meth:`OEGrapheme::OEShapeQueryDisplay::IsValid` and
  :oe:meth:`OEGrapheme::OEShapeOverlapDisplay::IsValid` methods were added
  to determine whether the objects have been initialized correctly.

* :oe:func:`OEGrapheme::OERenderShapeOverlap` function has been overloaded to
  enable rendering of shape overlap into two images: one image containing the
  fit molecule with transparent background and the other image showing the
  property map of the shape overlap.
  By superimposing the two images (molecule image on top), the result would
  be similar to visualizing the shape overlay in one image.

* :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` class was rewritten to use the
  new implementation of the `OEBio::OEFragmentNetwork` class.

Major bug fixes
--------------------------------------------------------------------------------

* :ref:`OEPrepareDepictionFrom3D <OEGrapheme_OEPrepareDepictionFrom3D>` function has been improved
  to use a better scoring function in cases of atom clashes.

Minor bug fixes
--------------------------------------------------------------------------------

* The default parameter for the maximum number of bond rotations of the
  :ref:`OEDepictionFrom3DOptions <OEGrapheme_OEDepictionFrom3DOptions>` class is now :math:`2^{16} = 65536`.
  This means that by default only the first 16 single bonds of molecule
  will be rotated to find the "closest" 2D layout from the original 3D
  conformation when invoking the
  :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` function.

* :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` now limits the maximum number of
  bond rotations to :math:`2^{14} = 16384` when calling the
  :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D` function to generate
  2D coordinates aligned to the query molecule.
  This limit provides a reasonable trade-off between speed and the quality
  of the alignments.

* :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` and
  :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D` have been optimized
  to be 10% faster on average. The algorithms were also revised to
  reduce the accumulation of floating point errors.

* Constructing :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` and
  :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` objects is now significantly
  faster due to code optimization and constraining the 2D layout generations.

* :oe:func:`OEGrapheme::OERenderActiveSite` function was fixed to depict the
  :oe:const:`OEChem::OEResidueIndex::I` residue with the DNA/RNA style.

* :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` and
  :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` now can handle queries without
  any color atoms.

* :oe:func:`OEGrapheme::OERenderShapeQuery` and
  :oe:func:`OEGrapheme::OERenderColorOverlap` now scale the line
  width of the pens used to render the circles representing color atom matches.

* :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` can now handle
  molecules containing atoms with an unknown atomic number
  (PDB examples: 1S9R, 3KXA, 1I1W).

* :oe:func:`OEGrapheme::OEGetMoleculeSurfaceScale` has been improved to capitalize
  on the molecule layout enhancements done in **OEDepict TK** in this release.

* :oe:func:`OEGrapheme::OERenderColorOverlap` was fixed to render the molecule
  surface of the query molecule as :oe:func:`OEGrapheme::OERenderShapeOverlap`
  does.

Documentation changes
--------------------------------------------------------------------------------

* The :ref:`section_examples_summary_shapeoverlap2pdf` example has been
  updated to visualize shape and color atom scores.

* The :ref:`section_examples_summary_complex2img` and
  :ref:`section_examples_summary_bfactor2img` 
  examples have been
  updated to perceive residues in cases when it is not done by the
  molecule reader (for example, in the case of :file:`mol2`).

* All images in this documentation have been automatically regenerated to
  reflect the changes made since the previous release.



Grapheme TK 1.2.3
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Minor internal improvements have been made.

Documentation changes
--------------------------------------------------------------------------------

* The :ref:`section_examples_summary_bfactor2img` has been updated to perceive
  residues when necessary.


Grapheme TK 1.3.0
================================================================================

New features
--------------------------------------------------------------------------------

* Due to the deprecation of `OEFragmentNetwork` and related classes
  in **OEBio**, **Grapheme TK** has introduced the following overloads:

  * :oe:func:`OEGrapheme::OEPrepareActiveSiteDepiction` function has been overloaded.
    The new version takes an :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

  * :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` class now should be constructed
    with an :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

  All functions and methods using `OEFragmentNetwork` are deprecated in **Grapheme TK**
  and will throw a warning when called.
  Active site depictions generated with the deprecated API will have a "deprecated"
  watermark (see the example below).

  .. list-table::
     :header-rows: 1

     * - using the deprecated OEFragmentNetwork class
       - using the new OEInteractionHintContainer class

     * - .. image:: ../../graphemetk/images/releasenotes-1.3.0/pdb1avd-fragment-network.*
            :width: 400
       - .. image:: ../../graphemetk/images/releasenotes-1.3.0/pdb1avd-interaction-container.*
            :width: 400

  In order to avoid the "deprecated" watermark from appearing in the image, use

  .. oe:language:: c++

     .. code-block:: c++

        OEInteractionHintContainer asite(protein, ligand);

  .. oe:language:: python

     .. code-block:: python

         asite = OEInteractionHintContainer(protein, ligand)

  .. oe:language:: java csharp

     .. code-block:: java

        OEInteractionHintContainer asite = new OEInteractionHintContainer(protein, ligand);

  instead of

  .. oe:language:: c++

     .. code-block:: c++

        OEFragmentNetwork asite(protein, ligand);

  .. oe:language:: python

     .. code-block:: python

        asite = OEFragmentNetwork(protein, ligand)

  .. oe:language:: java csharp

     .. code-block:: java

        OEFragmentNetwork asite = new OEFragmentNetwork(protein, ligand);

  .. seealso::

     For more details about the deprecated classes and functions, see the
     :ref:`oebio_fragment_network_deprecation` section.

* :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` now can visualize salt-bridge and
  aromatic ring stacking interactions.

* The color scheme used to visualize different interaction types when depicting
  protein-ligand interaction has been changed to accommodate the
  new types (Pi- and T-stacking and salt-bridge).

  .. list-table::
     :header-rows: 1
     :widths: 200 240

     * - 2016.Feb color scheme
       - 2016.Jun color scheme

     * - .. image:: ../../graphemetk/images/releasenotes-1.3.0/DrawActiveSiteLegend_2016_Feb.*
            :width: 400
       - .. image:: ../../graphemetk/images/releasenotes-1.3.0/DrawActiveSiteLegend_2016_Jun.*
            :width: 500

* :oe:meth:`OEGrapheme::OE2DActiveSiteDisplay::GetDisplayedLigand` and
  :oe:meth:`OEGrapheme::OE2DActiveSiteDisplay::GetDisplayedResidues` methods have
  been added.

* :oe:func:`OEGrapheme::OEAddLigandHighlighting` and
  :oe:func:`OEGrapheme::OEAddResidueHighlighting` functions have been added to
  allow highlighting in active site depiction. See the example below.

  .. figure:: graphemetk/images/OEAddHighlighting-ActiveSite-OEMatch.*
     :width: 350

     **Example of ligand highlighting**

* :oe:const:`OEGrapheme::OEShapeOverlapDisplayStyle::PropertyCloud` style
  has been added to visualize shape overlays along with the following APIs:

  * :oe:constns:`OEGrapheme::OEShapeOverlapDisplayStyle` namespace
  * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetOverlapDisplayStyle` and
    :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetOverlapDisplayStyle` methods

  .. figure:: graphemetk/images/OEShapeOverlapDisplayStyle_PropertyCloud.*
     :width: 300

     **Example of visualizing shape overlaps with PropertyCloud style**

  Using this new style can result in a 10-times performance increase when generating
  shape overlay images; the generated images will also be significantly smaller
  (PNG 50%, SVG 60-times, PDF 9-times).

* The following APIs have been added to identify ligand atoms and bonds, along with
  residues of an :oe:meth:`OEGrapheme::OE2DActiveSiteDisplay` object that are
  close to a given 2D display coordinate:

  * :oe:func:`OEGrapheme::OEGetNearestAtom` and :oe:func:`OEGrapheme::OEGetNearbyAtom` functions
  * :oe:func:`OEGrapheme::OEGetNearestBond` and :oe:func:`OEGrapheme::OEGetNearbyBond` functions
  * :oe:func:`OEGrapheme::OEGetNearestResidue` and :oe:func:`OEGrapheme::OEGetNearbyResidue` functions
    along with the :ref:`OENearestResidue <OEGrapheme_OENearestResidue>` class

Documentation changes
--------------------------------------------------------------------------------

* All images in the **Grapheme TK** documentation were automatically regenerated to
  reflect the changes made since the previous release.

* The example in :ref:`section_examples_summary_complex2img` has
  been updated to use the new :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class
  instead of the deprecated `OEFragmentNetwork`.


Grapheme TK 1.3.1
================================================================================

New features
--------------------------------------------------------------------------------

* The algorithm that determines the position of residues around a ligand
  has been improved. Residues are no longer placed the same distance from the
  ligand but are positioned closer to the ligand atoms they interact with
  and farther away if they have ``only contact`` interactions with the ligand.

  .. list-table:: **Example of the placement of residues around a ligand**
     :header-rows: 1
     :widths: 200 200

     * - 2016.Jun
       - 2016.Oct

     * - .. image:: ../../graphemetk/images/releasenotes-1.3.1/ResiduePositioning_2016_Jun_pdb1c1b.*
            :width: 400
       - .. image:: ../../graphemetk/images/releasenotes-1.3.1/ResiduePositioning_2016_Oct_pdb1c1b.*
            :width: 400

* :oe:cls:`Clash<OEBio::OEClashInteractionHint>` interactions perceived by the
  :oe:func:`OEBio::OEPerceiveInteractionHints` function are now visualized when
  rendering protein-ligand interactions.

  .. figure:: graphemetk/images/releasenotes-1.3.1/pdb13gs.*
     :width: 500
     :align: center

     **Example of visualizing Clash interactions**

* The color scheme used to visualize interaction types when depicting
  protein-ligand interactions has been updated.

  * The ``acceptor | donor`` color style no longer exists since
    :oe:func:`OEBio::OEPerceiveInteractionHints` now perceives
    possible hydrogen bonding interactions between ligand and water.
    If no such interaction exists, the glyph representing a
    specific water residue will be left uncolored, indicating an
    ``only contact`` interaction.

  * :oe:cls:`Clash<OEBio::OEClashInteractionHint>` interactions are
    now colored dark red.

  .. list-table:: **Color schemes**
     :header-rows: 1
     :widths: 200 200

     * - 2016.Jun color scheme
       - 2016.Oct color scheme

     * - .. image:: ../../graphemetk/images/releasenotes-1.3.1/DrawActiveSiteLegend_2016_Jun.*
            :width: 400
       - .. image:: ../../graphemetk/images/releasenotes-1.3.1/DrawActiveSiteLegend_2016_Oct.*
            :width: 400

Minor bug fixes
--------------------------------------------------------------------------------

* A problem that caused the glyph that represents a residue in a
  receptor-ligand interaction plot to be incorrectly colored based on
  its interaction type has been fixed.

Documentation changes
--------------------------------------------------------------------------------

* All images in the **Grapheme TK** documentation have been regenerated to
  reflect the changes made since the previous release.


Grapheme\ :sup:`TM` TK 1.3.2
================================================================================

New features
--------------------------------------------------------------------------------

* A new function, :oe:func:`OEGrapheme::OEDrawPeptide`, has been added that
  identifies standard amino acid components in molecules and
  substitutes them with circular glyphs and corresponding labels.  The figure
  below illustrates this functionality for oxytocin.

  .. figure:: graphemetk/images/releasenotes-1.3.2/OEDrawPeptide-Oxytocin.*
     :width: 700
     :align: center

     **Example of visualizing oxytocin**

     *(left) depiction of oxytocin highlighting its amino acid fragments*

     *(right) depiction of oxytocin using the OEDrawPeptide function*

* :oe:func:`OEGrapheme::OERenderActiveSite` can now visualize halogen bond
  interactions (represented by a brown wavy arrow).

  .. figure:: graphemetk/images/releasenotes-1.3.2/pdb3eqb.*
     :width: 600
     :align: center

     Example of visualizing halogen bond interaction (``PDB 3EQB``)

* The legend of the protein-ligand depiction has been improved by
  separating and labeling residue styles and interaction styles (see
  image above).

Minor bug fixes
--------------------------------------------------------------------------------

* The label "only contact" has been changed to "contact only" in the legend of
  the protein-label depiction (see image above).


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



Grapheme\ :sup:`TM` TK 1.3.3
================================================================================

New features
--------------------------------------------------------------------------------

* A new function, :oe:func:`OEGrapheme::OERenderContactMap`, has been added
  that generates interactive SVG images. Clicking on any residue circle will
  highlight those ligand atoms that interact with the given residue.

.. only:: oehtml

   .. raw:: html

      <p align="center">
      <b>click on any residue</b>
      </p>

      <p align="center">
      <object data="../../_images/RenderContactMap-4HWR.svg" type="image/svg+xml"  width = "500" ></object>
      <p>

      <p align="center">
      <b>Example of interactive SVG image generated by OERenderContactMap (PDB: 4HWR)</b>
      <p>

   .. image:: /_images/RenderContactMap-4HWR.svg
      :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

Preliminary API
--------------------------------------------------------------------------------

* A new :term:`Preliminary API` has been added to mark up the
  residue circles in SVG images generated by the
  :oe:func:`OEGrapheme::OERenderActiveSite` function:

  * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetResidueSVGMarkupFunctor` and
    :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::GetResidueSVGMarkupFunctor` methods

  * :ref:`OEResidueSVGMarkupBase <OEGrapheme_OEResidueSVGMarkupBase>` base class and
    :ref:`OEResidueSVGNoMarkup <OEGrapheme_OEResidueSVGNoMarkup>` and
    :ref:`OEResidueSVGStandardMarkup <OEGrapheme_OEResidueSVGStandardMarkup>` concrete classes

Major bug fixes
--------------------------------------------------------------------------------

* Several problems in the :oe:func:`OEGrapheme::OERenderActiveSite` function
  have been fixed:

  * When depicting protein-ligand interactions, grey lines represent the shape
    of the binding pocket.  The absence of lines indicates solvent-accessible
    regions.  In order visualize the solvent-accessible areas more
    realistically, waters are now ignored when calculating the molecule
    surfaces that determine the 2D representation (compare images below).

  * The rare case where the ligand is completely surrounded by water is
    now handled correctly.

  * The following heuristics are now used to improve the positioning of
    residue glyphs around the ligand:

    * Waters are more likely to be positioned in solvent-exposed regions.
    * Other residues are only positioned in solvent-exposed regions if it
      results in a more visually pleasing layout.

  .. list-table:: **Example of visualizing solvent-accessible regions and water positioning (PDB: 3E3D)**
     :header-rows: 1
     :widths: 200 200

     * - 2017.Feb
       - 2017.Jun

     * - .. image:: ../../graphemetk/images/releasenotes-1.3.3/pocket-2017-Feb.*
            :width: 300
       - .. image:: ../../graphemetk/images/releasenotes-1.3.3/pocket-2017-Jun.*
            :width: 300

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEGrapheme::OEDrawPeptide` has been fixed and now allows
  only amide and disulfide bonds when identifying standard amino
  acids. No alpha-carbon substitutions are allowed.

  .. list-table:: **Example of visualizing peptides with OEDrawPeptide**
     :header-rows: 1
     :widths: 220 250

     * - 2017.Feb
       - 2017.Jun

     * - .. image:: ../../graphemetk/images/releasenotes-1.3.3/ceruletide-2017-Feb.*
       - .. image:: ../../graphemetk/images/releasenotes-1.3.3/ceruletide-2017-Jun.*

Documentation changes
--------------------------------------------------------------------------------

* A new :ref:`oegrapheme_chapter_cookbook_examples` section has been added.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



Grapheme\ :sup:`TM` TK 1.3.4
================================================================================

New features
--------------------------------------------------------------------------------

* The following new API has been added to customize peptide depiction:

  * :ref:`OEPeptideDisplayOptions <OEGrapheme_OEPeptideDisplayOptions>` class
  * :oe:constns:`OEGrapheme::OEPeptideLabelStyle` namespace
  * :oe:func:`OEGrapheme::OEDrawPeptide` function that takes an option class

  The main feature is that :oe:func:`OEGrapheme::OEDrawPeptide` now can
  generate interactive SVG images where the amino acid components of
  the compact peptide representation are depicted on mouse-over.

.. only:: oehtml

   .. raw:: html

      <p align="center">
      <b>Hover over any circle below</b>
      </p>

      <p align="center">
      <object data="../../_images/oxytocin-interactive.svg" type="image/svg+xml"  width = "500" ></object>
      <p>

      <p align="center">
      <b>Example of interactive SVG image generated by OEDrawPeptide</b>
      <p>

   .. image:: /_images/oxytocin-interactive.svg
      :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

* The following new API has been added to customize active site depiction:

   * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::GetSVGMagnifyResidueInHover`
   * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetSVGMagnifyResidueInHover`
   * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::GetRenderInteractiveLegend`
   * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetRenderInteractiveLegend`

   These new options allow users to generate interactive SVG images when calling
   the :oe:func:`OEGrapheme::OERenderActiveSite` function.

.. only:: oehtml

   .. raw:: html

      <p align="center">
      <b>Hover over the legend label or any circle representing a residue</b>
      </p>

      <p align="center">
      <object data="../../_images/activesite-interactive.svg" type="image/svg+xml"  width = "400" ></object>
      <p>

      <p align="center">
      <b>Example of interactive SVG image generated by OERenderActiveSite</b>
      <p>

   .. image:: /_images/activesite-interactive.svg
      :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

* The :oe:meth:`OEGrapheme::OEBondGlyphZigZag<OEGrapheme::OEBondGlyphZigZag::Constructors>`
  constructor now takes a parameter that allows drawing diagonal zig-zag lines across a bond.

  .. figure:: graphemetk/images/releasenotes-1.3.4/OEBondGlyphZigZag.*
     :align: center
     :width: 150

     **Example of using the OEBondGlyphZigZag class**

* **OEGrapheme TK** now uses the new thread-safe **OEShape TK** API to generate
  shape and color overlaps for :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` and
  :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` classes.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEGrapheme::OEResidueSVGStandardMarkup::GetGroupId` now returns
  ``group id`` for a residue that includes the insert code
  (see also :oe:meth:`OEChem::OEResidue::GetInsertCode`)


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



Grapheme\ :sup:`TM` TK 1.3.5
================================================================================

New features
--------------------------------------------------------------------------------

* A new function, :oe:func:`OEGrapheme::OERenderUnpairedInteractionMap`, has
  been added to visualize clash and unpaired interactions.

  .. list-table::  **Examples of visualizing clash and unpaired interactions**
     :header-rows: 1

     * - PDB: 1S2A
       - PDB: 3K6L

     * - .. image:: ../../graphemetk/images/releasenotes-1.3.5/pdb1s2a-unpaired.*
            :width: 500pt
       - .. image:: ../../graphemetk/images/releasenotes-1.3.5/pdb3k6l-unpaired.*
            :width: 500pt

* :oe:func:`OEGrapheme::OERenderActiveSite` now depicts covalent and cation-pi
  interactions.

  .. only:: oehtml

     .. list-table::  **Examples of depicting covalent and cation-pi interactions**
        :header-rows: 1
        :widths: 500 500

        * - PDB: 5WQX
          - PDB: 3ARW

        * - .. raw:: html

               <object data="../../_images/complex2img-pdb5wqx-optimized.svg" type="image/svg+xml"  width = "500" ></object>

            .. image:: /_images/complex2img-pdb5wqx-optimized.svg
               :width: 1pt

          - .. raw:: html

               <object data="../../_images/complex2img-pdb3arw-optimized.svg" type="image/svg+xml"  width = "500" ></object>

            .. image:: /_images/complex2img-pdb3arw-optimized.svg
               :width: 1pt

* The style for depicting stacking interactions has been simplified.

     .. list-table:: **Examples of stacking interaction depiction**
        :header-rows: 1
        :widths: 100 200 200

        * -
          - T-stacking
          - Pi-stacking

        * - 2017.Oct
          - .. image:: ../../graphemetk/images/releasenotes-1.3.5/complex2img-stacking-t-2017-Oct.png
               :width: 100pt
          - .. image:: ../../graphemetk/images/releasenotes-1.3.5/complex2img-stacking-pi-2017-Oct.png
               :width: 110pt

        * - 2018.Feb
          - .. image:: ../../graphemetk/images/releasenotes-1.3.5/complex2img-stacking-t-2018-Feb.png
               :width: 100pt
          - .. image:: ../../graphemetk/images/releasenotes-1.3.5/complex2img-stacking-pi-2018-Feb.png
               :width: 110pt

* The color scheme used to visualize interaction types when depicting
  protein-ligand interactions has been updated to accommodate the two new
  interaction types.

  .. figure:: /_images/DrawActiveSiteLegend_2018_Feb.png
     :align: center
     :width: 900

     **New interactions color scheme**

* A new method, :oe:meth:`OEGrapheme::OE2DActiveSiteDisplay::IsValid`, has
  been added that is checked by all **Grapheme TK** API points.

* The :ref:`OEResidueSVGStandardMarkup <OEGrapheme_OEResidueSVGStandardMarkup>` class now takes a
  separator option.

* The following API, introduced in the 2017.Jun release for marking up
  residue circles in SVG images generated by the
  :oe:func:`OEGrapheme::OERenderActiveSite` function, is no longer preliminary
  and is now also available in both Java and C#:

  * :ref:`OEResidueSVGMarkupBase <OEGrapheme_OEResidueSVGMarkupBase>` class
  * :ref:`OEResidueSVGNoMarkup <OEGrapheme_OEResidueSVGNoMarkup>` class
  * :ref:`OEResidueSVGStandardMarkup <OEGrapheme_OEResidueSVGStandardMarkup>` class

Minor bug fixes
--------------------------------------------------------------------------------

* The algorithm used by the :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>`
  function to scale and position residues around ligands has been improved.

* :oe:func:`OEGrapheme::OERenderActiveSite` is now able to generate images
  when some ligand atoms have identical 2D coordinates.

* :oe:func:`OEGrapheme::OERenderActiveSite` now throws a warning if an
  interaction cannot be rendered.

Java-specific changes
--------------------------------------------------------------------------------

* The API for marking up residues in SVG images is now fully supported in
  Java (see the list above).

C#-specific changes
--------------------------------------------------------------------------------

* The API for marking up residues in SVG images is now fully supported in
  C# (see the list above).


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



Grapheme\ :sup:`TM` TK 1.3.6
================================================================================

New features
--------------------------------------------------------------------------------

* New :oe:func:`OEGrapheme::OERenderBFactorMap` and
  :oe:func:`OEGrapheme::OEDrawBFactorMapLegend` functions have been added to visualize the
  B-factor of a ligand and its protein environment.

  .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover mouse over any residue circles</b>
         </p>

         <p align="center">
         <object data="../../_images/bfactor-map-1br6.svg" type="image/svg+xml"  width = "500" ></object>
         <p>

         <p align="center">
         <b>Example of depicting the B-factor map (PDB: 1br6)</b>
         <p>

      .. image:: /_images/bfactor-map-1br6.svg
         :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

* A new :oe:func:`OEGrapheme::OEDrawUnpairedInteractionMapLegend` function has been added to depict the
  legend of the interactions depicted in an unpaired map.
  (See also the :oe:func:`OEGrapheme::OERenderUnpairedInteractionMap` function).

  .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover mouse over the Legend button</b>
         </p>

         <p align="center">
         <object data="../../_images/unpaired-map-1br6.svg" type="image/svg+xml"  width = "500" ></object>
         <p>

         <p align="center">
         <b>Example of depicting the unpaired interaction map with interactive legend (PDB: 1br6)</b>
         <p>

      .. image:: /_images/unpaired-map-1br6.svg
         :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

* The :oe:meth:`OEGrapheme::OE2DActiveSiteDisplay::GetDisplayedResidues` function now takes
  a parameter from the new :oe:const:`OEGrapheme::OEActiveSiteRenderStyle`
  namespace.

* Two new methods, :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetColorStopVisibility` and
  :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetColorStopVisibility`, have been added to
  customize color gradient depiction.

New features (Preliminary API)
--------------------------------------------------------------------------------

* A new :oe:func:`OEGrapheme::OERenderActiveSiteMaps` function has been added that generates an
  interactive image of protein-ligand maps.

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <object data="../../_images/active-maps-1br6.svg" type="image/svg+xml"  width = "500" ></object>
         <p>

         <p align="center">
         <b>Example of visualizing protein-ligand maps (PDB: 1br6)</b>
         <p>

      .. image:: /_images/active-maps-1br6.svg
         :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

Major bug fixes
--------------------------------------------------------------------------------

* When rendering ligand-protein maps with **Grapheme TK**, molecule surfaces are generated
  to depict the overall shape of the pocket.  In the case of a large
  protein, this process can be both computationally expensive and can
  require a large amount of memory.  In order to avoid these issues,
  only protein atoms that are no more than 20Å away from any ligand
  atoms are now considered and the resolution of the surface is reduced.

* Rendering active site maps to an image with less than a ``200.0``
  width or height parameter is now disabled to avoid generating very tiny,
  incomprehensible images.

* When rendering ligand-protein maps (e.g., active site, unpaired),
  interactions between the ligand and more than 1 residue is now
  ignored and a warning is thrown.

* Scaling of legend labels for large images has been fixed.  All
  **Grapheme TK** legends of ligand-protein depictions now have a
  consistent style.

Minor bug fixes
--------------------------------------------------------------------------------

* A problem that occurred when coloring hexagon glyphs representing DNA/RNA
  residues with more than 1 interaction type has been fixed.

* An issue with depicting an interaction type in a legend when that
  interaction type is missing from the corresponding active site map
  has been fixed.

* A small improvement has been made to help to generate residue layouts that
  are platform-independent.

* A small improvement has been made to generate better residue layout:
  the space around the ligand for potential residue positions
  is now better sampled to allow positioning residues close to edge of
  the canvas.

* The text associated with the color stops when depicting color gradients vertically
  using the :oe:func:`OEGrapheme::OEDrawColorGradient` function is now right-adjusted.

Documentation changes
--------------------------------------------------------------------------------

* The :ref:`shapeoverlap2pdf.py <section_examples_summary_shapeoverlap2pdf>` example
  has been fixed.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



Grapheme\ :sup:`TM` TK 1.3.7
================================================================================

New features
--------------------------------------------------------------------------------

* The following APIs have been added to depict Ramachandran plots:

  * :ref:`OERamachandranPlot <OEGrapheme_OERamachandranPlot>` class
  * :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` class and  :oe:constns:`OEGrapheme::OEPlotMarkerStyle` namespace
  * :oe:func:`OEGrapheme::OERenderRamachandranPlot` function

  .. only:: oehtml

     .. raw:: html

        <p align="center">
        <object data="../../_images/RenderRamachandranPlot.svg" type="image/svg+xml"  width = "500" ></object>
        <p>

        <p align="center">
        <b>Example of visualizing the Ramachandran plots in Grapheme TK (PDB: 2ROX)</b>
        <p>

   .. only:: oepdf

      |NOPDFIMAGE|

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEGrapheme::OEResidueSVGStandardMarkup::GetGroupId` now replaces spaces
  with an underscore character to generate valid SVG group IDs.


Grapheme\ :sup:`TM` TK 1.4.0
================================================================================

New features
--------------------------------------------------------------------------------

* New :oe:func:`OEGrapheme::OEDrawIridiumData` functions have been added to visualize
  :ref:`OEIridiumData <OEBio_OEIridiumData>`.

  .. only:: oehtml

     .. raw:: html

        <p align="center">
        <b>hover cursor over graph</b>
        </p>

        <p align="center">
        <object data="../../_images/DrawIridiumData.svg" type="image/svg+xml"  width = "300" ></object>
        <p>

        <p align="center">
        <b>Example of visualizing Iridium data</b>
        <p>

  .. only:: oepdf

     .. figure:: graphemetk/images/DrawIridiumData.pdf
        :align:  center

        **Example of visualizing Iridium data**

*  A new function, :oe:func:`OEGrapheme::OERenderActiveSite`, has been added that depicts the new non-ideal hydrogen bonds.
   For more details about these interactions, see the :ref:`OEIsNonIdealHBondInteractionHint <OEBio_OEIsNonIdealHBondInteractionHint>` functor.

  .. only:: oehtml

     .. raw:: html

        <p align="center">
        <object data="../../_images/1LEE-non-ideal-hbond.svg" type="image/svg+xml"  width = "600" ></object>
        <p>

        <p align="center">
        <b>Example of visualizing non-ideal hydrogen bonds (PDB: 1LEE)</b>
        <p>

     .. image:: /_images/1LEE-non-ideal-hbond.svg
        :width: 1pt

  .. only:: oepdf

     .. figure:: graphemetk/images/releasenotes-1.4.0/1LEE-non-ideal-hbond.pdf
        :align:  center

        **Example of visualizing non-ideal hydrogen bond (PDB:1LEE)**

* A new overload of :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D` has
  been added that generates 2D coordinates of a molecule driven by the 3D overlay
  of the shape query display object.


Grapheme \ :sup:`TM` TK 1.4.1
================================================================================

* Minor internal improvements have been made.


Grapheme\ :sup:`TM` TK 1.4.2
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* A new function, :oe:func:`OEGrapheme::OEDrawResidues`, has been added that visualizes residue
  information for peptides.

  .. only:: oehtml

    .. raw:: html

        <p align="center">
        <b>hover mouse over any residue circles</b>
        </p>

        <p align="center">
        <object data="../../_images/DrawResidues.svg" type="image/svg+xml"  width = "500" ></object>
        <p>

        <p align="center">
        <b>Example of using the OEDrawResidues function to generate an interactive SVG image</b>
        <p>

  .. only:: oepdf

    .. figure:: graphemetk/images/DrawResidues.pdf
        :align:  center

        **Example of using the OEDrawResidues function**

Minor bug fixes
--------------------------------------------------------------------------------

* A bug related to drawing interaction hints spanning multiple residues has been fixed.


Grapheme\ :sup:`TM` TK 1.4.3
================================================================================

*July 2021*

New features
--------------------------------------------------------------------------------

* Rendering of protein-ligand binding sites has been improved to handle new intramolecule
  types in the :oe:func:`OEBio::OEPerceiveInteractionHints` function.


Grapheme\ :sup:`TM` TK 1.4.4
================================================================================

*Fall 2021*

* Minor internal improvements have been made.



Grapheme\ :sup:`TM` TK 1.4.5
================================================================================

* Minor internal improvements have been made.



Grapheme\ :sup:`TM` TK 1.4.6
================================================================================

Minor internal improvements have been made.




Grapheme\ :sup:`TM` TK 1.4.7
================================================================================

Minor internal improvements have been made.




Grapheme\ :sup:`TM` TK 1.5.0
================================================================================

Minor internal improvements have been made.



.. _section_graphemetk_releasenotes_1513:

Grapheme\ :sup:`TM` TK 1.5.1.3
================================================================================

* Following new methods have been added to :ref:`OEColorForceFieldDisplay<OEGrapheme_OEColorForceFieldDisplay>`
  to enable preserving user defined query colors.

  * :ref:`SetPreserveQueryColors<OEGrapheme_OEColorForceFieldDisplay_SetPreserveQueryColors>`
  * :ref:`GetPreserveQueryColors<OEGrapheme_OEColorForceFieldDisplay_GetPreserveQueryColors>`
  * :ref:`Constructors <OEGrapheme_OEColorForceFieldDisplay_Constructors>`

.. _section_graphemetk_releasenotes_1510:

Grapheme\ :sup:`TM` TK 1.5.1.0
================================================================================

Minor internal improvements have been made.



Grapheme\ :sup:`TM` TK 1.5.2
================================================================================

New features
--------------------------------------------------------------------------------

* An option has been added to the :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>` to preserve
  input query color atoms instead of applying them from the defined color force field.
  There are two new methods and one new constructor, taking that argument along with
  the color force field.
  
  * :ref:`SetPreserveQueryColors<OEGrapheme_OEColorForceFieldDisplay_SetPreserveQueryColors>`
  * :ref:`GetPreserveQueryColors<OEGrapheme_OEColorForceFieldDisplay_GetPreserveQueryColors>`
  * :ref:`Constructors <OEGrapheme_OEColorForceFieldDisplay_Constructors>`

Minor bug fixes
--------------------------------------------------------------------------------

* An issue has been fixed which incorrectly used the ligand density value for the
  active site density value when depicting the Iridium classification.



Grapheme\ :sup:`TM` TK 1.5.3
================================================================================

Minor internal improvements have been made.


###############################################
Appendix: Additional Examples in Python
###############################################

These are full listings of programming examples that are excerpted or offered for download, elsewhere in this book.
See :ref:`a full list of examples in this chapter. <oegrapheme_part_examples>`

..	_listing-ActiveSiteHighlight.py:

..  oe:source:: ActiveSiteHighlight.py
    :language: python
    :refnum:   1
    :caption: Full listing of ActiveSiteHighlight.py.

..	_listing-AnnotateAtomPredicate.py:

.. oe:source:: AnnotateAtomPredicate.py
   :language: python
   :refnum:   2
   :caption:  Example of using a built-in atom annotation style

..	_listing-AnnotateBondPredicate.py:

.. oe:source:: AnnotateBondPredicate.py
   :language: python
   :refnum:   3
   :caption:  Example of using a built-in bond annotation style

..	_listing-AnnotatePartialCharge.py:

.. oe:source:: AnnotatePartialCharge.py
   :language: python
   :refnum:   4
   :caption:  Example of user-defined annotation

..	_listing-bfactor2img.py:

..  oe:source:: bfactor2img.py
    :language: python
    :refnum:   5
    :caption: Full listing of bfactor2img.py.

..	_listing-complex2img.py:

..  oe:source:: complex2img.py
    :language: python
    :refnum:   6
    :caption: Full listing of complex2img.py.

..	_listing-Draw2DPropMapPartialCharge.py:

.. oe:source:: Draw2DPropMapPartialCharge.py
   :language: python
   :refnum:   7
   :caption:  Depicting partial charges using property map

..	_listing-Draw2DSurfaceUserDefined.py:

.. oe:source:: Draw2DSurfaceUserDefined.py
   :language: python
   :refnum:   8
   :caption:  Example of user-defined surface drawing

..	_listing-Draw2DSurfaceVariousRadii.py:

.. oe:source:: Draw2DSurfaceVariousRadii.py
   :language: python
   :refnum:   9
   :caption:  Example of drawing 2D surface with various radii

..	_listing-DrawActiveSiteLegend.py:

..  oe:source:: DrawActiveSiteLegend.py
    :language: python
    :refnum:   10
    :caption: Full listing of DrawActiveSiteLegend.py.

..	_listing-DrawColorForceFieldLegend.py:

..  oe:source:: DrawColorForceFieldLegend.py
    :language: python
    :refnum:   11
    :caption: Full listing of DrawColorForceFieldLegend.py.

..	_listing-DrawColorGradient.py:

..  oe:source:: DrawColorGradient.py
    :language: python
    :refnum:   12
    :caption: Full listing of DrawColorGradient.py.

..	_listing-DrawComplexSurface.py:

.. oe:source:: DrawComplexSurface.py
   :language: python
   :refnum:   13
   :caption:  Example of complex surface drawing

..	_listing-DrawComplexSurfaceUserDef.py:

.. oe:source:: DrawComplexSurfaceUserDef.py
   :language: python
   :noindent:
   :refnum:   14

..  _listing-DrawIridiumData.py:

..  oe:source:: DrawIridiumData.py
    :language: python
    :caption: Full listing of DrawIridium.py.
    :refnum:   15

..	_listing-DrawMultiple2DSurfaces.py:

.. oe:source:: DrawMultiple2DSurfaces.py
   :language: python
   :refnum:   16
   :caption:  Example of drawing multiple 2D surfaces

..	_listing-DrawPeptide.py:

..  oe:source:: DrawPeptide.py
    :language: python
    :refnum:   17
    :caption: Full listing of DrawPeptide.py.

..	_listing-DrawResidues.py:

..  oe:source:: DrawResidues.py
    :language: python
    :refnum:   18
    :caption: Full listing of DrawResidues.py. 

..	_listing-DrawROCSScores.py:

..  oe:source:: DrawROCSScores.py
    :language: python
    :refnum:   19
    :caption: Full listing of DrawROCSScores.py.

..	_listing-OE2DPropMap_SetProperties.py:

..  oe:source:: OE2DPropMap_SetProperties.py
    :language: python
    :caption: Full listing of OE2DPropMap_SetProperties.py.
    :refnum:   20

..	_listing-OEColorGradientDispOpts.py:

..  oe:source:: OEColorGradientDispOpts.py
    :language: python
    :caption: Full listing of OEColorGradientDispOpts.py.
    :refnum:   21

..	_listing-OEPeptideDispOpts_SetOpts.py:

..  oe:source:: OEPeptideDispOpts_SetOpts.py
    :language: python
    :caption: Full listing of OEPeptideDispOpts_SetOpts.py.
    :refnum:   22

..	_listing-RenderBFactorMap.py:

..  oe:source:: RenderBFactorMap.py
    :language: python
    :caption: Full listing of RenderBFactorMap.py.
    :refnum:   23

..	_listing-shapeoverlap2pdf.py:

..  oe:source:: shapeoverlap2pdf.py
    :language: python
    :caption: Full listing of shapeoverlap2pdf.py.
    :refnum:   24

..	_listing-SVGMarkResidues.py:

..  oe:source:: SVGMarkResidues.py
    :language: python
    :caption: Full listing of SVGMarkResidues.py.
    :refnum:   25



.. _chapter_draw_surface:

********************************************************************************
Drawing a Molecule Surface
********************************************************************************

The 2D representation of the molecule surface is calculated by first
drawing circles around each atom of the molecule and then identifying
the external arc segments that define a continuous surface around the
molecule.
This process is illustrated in the table
:ref:`Table: Calculation of the 2D representation of a molecule surface<table_draw_surface_calc>`

.. _table_draw_surface_calc:

.. list-table:: **Calculation of the 2D representation of a molecule surface**
   :widths: 150 150
   :header-rows: 0

   * - .. image:: images/Draw2DSurface-Step-01.*
          :align:  center
     - .. image:: images/Draw2DSurface-Step-02.*
          :align:  center
   * - .. image:: images/Draw2DSurface-Step-03.*
          :align:  center
     - .. image:: images/Draw2DSurface-Step-04.*
          :align:  center
   * - .. image:: images/Draw2DSurface-Step-05.*
          :align:  center
     - .. image:: images/Draw2DSurface-Step-06.*
          :align:  center

.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   %
   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

The following :oe:src:`Listing 1<SNIPPET-DRAW-2D-SURFACE-Draw2DSurface>` example shows how to
the display a molecule surface.
After creating an image object and preparing the molecule for 2D
depiction, an arc drawing functor is added to each atom of the
molecule by using the :oe:func:`OEGrapheme::OESetSurfaceArcFxn`
function.
The surface then can be drawn by calling the
:oe:func:`OEGrapheme::OEDraw2DSurface` function that calculates the
arc segments that form a continuous curve around the molecule.
The image created by :oe:src:`Listing 1<SNIPPET-DRAW-2D-SURFACE-Draw2DSurface>` is shown in
:ref:`Figure: Example of surface drawing<figure_draw_surface>`.

.. oe:source:: Draw2DSurface.py
   :language: python
   :refnum:   1
   :noindent:
   :frag:     SNIPPET-DRAW-2D-SURFACE
   :caption:  Example of surface drawing

.. oe:source:: Draw2DSurface.cpp
   :language: c++
   :refnum:   1
   :noindent:
   :frag:     SNIPPET-DRAW-2D-SURFACE
   :caption:  Example of surface drawing

.. oe:source:: Draw2DSurface.java
   :language: java
   :refnum:   1
   :noindent:
   :frag:     SNIPPET-DRAW-2D-SURFACE
   :caption:  Example of surface drawing

.. oe:source:: Draw2DSurface.cs
   :language: csharp
   :refnum:   1
   :noindent:
   :frag:     SNIPPET-DRAW-2D-SURFACE
   :caption:  Example of surface drawing

.. _figure_draw_surface:

.. figure:: graphemetk/images/Draw2DSurface.*
   :align:  center

   **Example of surface drawing**

.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   %
   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

The :oe:src:`Listing 1<SNIPPET-DRAW-2D-SURFACE-Draw2DSurface>` example uses the
:oe:const:`OEGrapheme::OESurfaceArcStyle::Eyelash` style to draw the
molecule surface.
The following table lists all surface drawing styles that are
available in **Grapheme TK**.

.. list-table:: **Supported surface drawing styles**
   :widths: 150 150 150 150
   :header-rows: 0

   * - .. image:: images/OESurfaceArc_Small_OEAlphaRainbowArcFxn.*
          :align:  left
     - .. image:: images/OESurfaceArc_Small_OEBrickRoadArcFxn.*
          :align:  left
     - .. image:: images/OESurfaceArc_Small_OECastleArcFxn.*
          :align:  left
     - .. image:: images/OESurfaceArc_Small_OECogArcFxn.*
          :align:  left

   * - :ref:`OEAlphaRainbowArcFxn <OEGrapheme_OEAlphaRainbowArcFxn>`
     - :ref:`OEBrickRoadArcFxn <OEGrapheme_OEBrickRoadArcFxn>`
     - :ref:`OECastleArcFxn <OEGrapheme_OECastleArcFxn>`
     - :ref:`OECogArcFxn <OEGrapheme_OECogArcFxn>`

   * - .. image:: images/OESurfaceArc_Small_OEDefaultArcFxn.*
          :align:  left
     - .. image:: images/OESurfaceArc_Small_OEEyelashArcFxn.*
          :align:  left
     - .. image:: images/OESurfaceArc_Small_OEFlowerArcFxn.*
          :align:  left
     - .. image:: images/OESurfaceArc_Small_OENecklaceArcFxn.*
          :align:  left

   * - :ref:`OEDefaultArcFxn <OEGrapheme_OEDefaultArcFxn>`
     - :ref:`OEEyelashArcFxn <OEGrapheme_OEEyelashArcFxn>`
     - :ref:`OEFlowerArcFxn <OEGrapheme_OEFlowerArcFxn>`
     - :ref:`OENecklaceArcFxn <OEGrapheme_OENecklaceArcFxn>`

   * - .. image:: images/OESurfaceArc_Small_OENullArcFxn.*
          :align:  left
     - .. image:: images/OESurfaceArc_Small_OEOliveBranchArcFxn.*
          :align:  left
     - .. image:: images/OESurfaceArc_Small_OEPearlsArcFxn.*
          :align:  left
     - .. image:: images/OESurfaceArc_Small_OERaceTrackArcFxn.*
          :align:  left

   * - :ref:`OENullArcFxn <OEGrapheme_OENullArcFxn>`
     - :ref:`OEOliveBranchArcFxn <OEGrapheme_OEOliveBranchArcFxn>`
     - :ref:`OEPearlsArcFxn <OEGrapheme_OEPearlsArcFxn>`
     - :ref:`OERaceTrackArcFxn <OEGrapheme_OERaceTrackArcFxn>`

   * - .. image:: images/OESurfaceArc_Small_OERailroadTrackArcFxn.*
          :align:  left
     - .. image:: images/OESurfaceArc_Small_OESawArcFxn.*
          :align:  left
     - .. image:: images/OESurfaceArc_Small_OESimpsonArcFxn.*
          :align:  left
     - .. image:: images/OESurfaceArc_Small_OEStitchArcFxn.*
          :align:  left

   * - :ref:`OEStitchArcFxn <OEGrapheme_OEStitchArcFxn>`
     - :ref:`OESunArcFxn <OEGrapheme_OESunArcFxn>`
     - :ref:`OEWreathArcFxn <OEGrapheme_OEWreathArcFxn>`
     - :ref:`OERailroadTrackArcFxn <OEGrapheme_OERailroadTrackArcFxn>`

   * -
     - .. image:: images/OESurfaceArc_Small_OESunArcFxn.*
          :align:  left
     - .. image:: images/OESurfaceArc_Small_OEWreathArcFxn.*
          :align:  left
     -

   * -
     - :ref:`OESawArcFxn <OEGrapheme_OESawArcFxn>`
     - :ref:`OESimpsonArcFxn <OEGrapheme_OESimpsonArcFxn>`
     -

.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   %
   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

User-defined surface drawing functors can be implemented by deriving
from the :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>` abstract base class.
In the :oe:src:`Listing 2<SNIPPET-DRAW-2D-SURFACE-USER-DEFINED-Draw2DSurfaceUserDefined>` example,
a user defined arc drawing functor is implemented that colors the
*eyelash* arcs according to the atom they belong to.
The image created by :oe:src:`Listing 2<SNIPPET-DRAW-2D-SURFACE-USER-DEFINED-Draw2DSurfaceUserDefined>` is shown in
:ref:`Figure: Example of user-defined surface drawing<figure_draw_surface_user_defined>`.

.. oe:source:: Draw2DSurfaceUserDefined.py
   :language: python
   :refnum:   2
   :frag:     SNIPPET-DRAW-2D-SURFACE-USER-DEFINED
   :caption:  Example of user-defined surface drawing

.. oe:source:: Draw2DSurfaceUserDefined.cpp
   :language: c++
   :refnum:   2
   :frag:     SNIPPET-DRAW-2D-SURFACE-USER-DEFINED
   :caption:  Example of user-defined surface drawing

.. oe:source:: Draw2DSurfaceUserDefined.java
   :language: java
   :refnum:   2
   :noindent:
   :frag:     SNIPPET-DRAW-2D-SURFACE-USER-DEFINED
   :caption:  Example of user-defined surface drawing

.. oe:source:: Draw2DSurfaceUserDefined.cs
   :language: csharp
   :refnum:   2
   :noindent:
   :frag:     SNIPPET-DRAW-2D-SURFACE-USER-DEFINED
   :caption:  Example of user-defined surface drawing

.. _figure_draw_surface_user_defined:

.. figure:: graphemetk/images/Draw2DSurfaceUserDefined.*
   :align:  center

   **Example of user-defined surface drawing**

.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   %
   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

The :oe:src:`Listing 3<SNIPPET-DRAW-2D-SURFACE-PARTIAL-CHARGE-Draw2DSurfacePartialCharge>` example shows
how to project atom properties, such as partial charges into the molecule
surface.
The image created by :oe:src:`Listing 3<SNIPPET-DRAW-2D-SURFACE-PARTIAL-CHARGE-Draw2DSurfacePartialCharge>` is shown in
:ref:`Figure: Example of depicting atom properties<figure_draw_surface_partial_charge>`.

.. oe:source:: Draw2DSurfacePartialCharge.py
   :language: python
   :refnum:   3
   :frag:     SNIPPET-DRAW-2D-SURFACE-PARTIAL-CHARGE
   :caption:  Example of depicting atom properties on the molecule surface

.. oe:source:: Draw2DSurfacePartialCharge.cpp
   :language: c++
   :refnum:   3
   :frag:     SNIPPET-DRAW-2D-SURFACE-PARTIAL-CHARGE
   :caption:  Example of depicting atom properties on the molecule surface

.. oe:source:: Draw2DSurfacePartialCharge.java
   :language: java
   :refnum:   3
   :noindent:
   :frag:     SNIPPET-DRAW-2D-SURFACE-PARTIAL-CHARGE
   :caption:  Example of depicting atom properties on the molecule surface

.. oe:source:: Draw2DSurfacePartialCharge.cs
   :language: csharp
   :refnum:   3
   :noindent:
   :frag:     SNIPPET-DRAW-2D-SURFACE-PARTIAL-CHARGE
   :caption:  Example of depicting atom properties on the molecule surface

.. _figure_draw_surface_partial_charge:

.. figure:: graphemetk/images/Draw2DSurfacePartialCharge.*
   :align:  center

   **Example of depicting atom properties**

.. seealso::

   * :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class in the **OEDepict TK** manual

.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   %
   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

It is also possible to draw multiple 2D surfaces arc-by-arc.
In the :oe:src:`Listing 4<SNIPPET-DRAW-MULTIPLE-2D-SURFACES-DrawMultiple2DSurfaces>` example below the
arcs returned by the :oe:func:`OEGrapheme::OEGet2DSurfaceArcs` function
for the given atom display and radius are directly rendered below
the molecule diagram.
In this case it is important to call the :oe:func:`OEGrapheme::OEGetMoleculeSurfaceScale`
function with the largest radius scale of the 2D surfaces drawn.
This reduces the scaling of the molecule in order to able to fit the
molecule diagram and all of the arcs of the 2D surfaces into the image.
The image created by :oe:src:`Listing 4<SNIPPET-DRAW-MULTIPLE-2D-SURFACES-DrawMultiple2DSurfaces>` is shown in
:ref:`Figure: Example of drawing multiple 2D surfaces<figure_draw_surface_multiple>`.

.. oe:source:: DrawMultiple2DSurfaces.py
   :language: python
   :refnum:   4
   :frag:     SNIPPET-DRAW-MULTIPLE-2D-SURFACES
   :caption:  Example of drawing multiple 2D surfaces

.. oe:source:: DrawMultiple2DSurfaces.cpp
   :language: c++
   :refnum:   4
   :frag:     SNIPPET-DRAW-MULTIPLE-2D-SURFACES
   :caption:  Example of drawing multiple 2D surfaces

.. oe:source:: DrawMultiple2DSurfaces.java
   :language: java
   :refnum:   4
   :noindent:
   :frag:     SNIPPET-DRAW-MULTIPLE-2D-SURFACES
   :caption:  Example of drawing multiple 2D surfaces

.. oe:source:: DrawMultiple2DSurfaces.cs
   :language: csharp
   :refnum:   4
   :noindent:
   :frag:     SNIPPET-DRAW-MULTIPLE-2D-SURFACES
   :caption:  Example of drawing multiple 2D surfaces

.. _figure_draw_surface_multiple:

.. figure:: graphemetk/images/DrawMultiple2DSurfaces.*
   :align:  center

   **Example of drawing multiple 2D surfaces**

.. seealso::

   :oe:constns:`OEGrapheme::OESurfaceArcScale` namespace

.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   %
   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

The last :oe:src:`Listing 5<SNIPPET-DRAW-2D-SURFACE-VARIOUS-RADII-Draw2DSurfaceVariousRadii>` example shows how to
draw a 2D surface with various radii.
It draws two surfaces one with a minimum radius scale and one with various radius
depending on the covalent radius of the atoms.
The :oe:func:`OEGrapheme::OEGetMoleculeSurfaceScale` function has to be called
in this example too with the largest radius scale in order to able to fit the molecule diagram
and all of the arcs of the 2D surfaces into the image.
The image created by :oe:src:`Listing 5<SNIPPET-DRAW-2D-SURFACE-VARIOUS-RADII-Draw2DSurfaceVariousRadii>` is shown in
:ref:`Figure: Example of drawing 2D surface with various radii<figure_draw_surface_various_radii>`.

.. oe:source:: Draw2DSurfaceVariousRadii.py
   :language: python
   :refnum:   5
   :frag:     SNIPPET-DRAW-2D-SURFACE-VARIOUS-RADII
   :caption:  Example of drawing 2D surface with various radii

.. oe:source:: Draw2DSurfaceVariousRadii.cpp
   :language: c++
   :refnum:   5
   :frag:     SNIPPET-DRAW-2D-SURFACE-VARIOUS-RADII
   :caption:  Example of drawing 2D surface with various radii

.. oe:source:: Draw2DSurfaceVariousRadii.java
   :language: java
   :refnum:   5
   :frag:     SNIPPET-DRAW-2D-SURFACE-VARIOUS-RADII
   :caption:  Example of drawing 2D surface with various radii

.. oe:language:: csharp

.. oe:source:: Draw2DSurfaceVariousRadii.cs
   :language: csharp
   :refnum:   5
   :frag:     SNIPPET-DRAW-2D-SURFACE-VARIOUS-RADII
   :caption:  Example of drawing 2D surface with various radii

.. _figure_draw_surface_various_radii:

.. figure:: graphemetk/images/Draw2DSurfaceVariousRadii.*
   :align:  center

   **Example of drawing 2D surface with various radii**

.. seealso::

   :oe:func:`OEChem::OEGetCovalentRadius` function in the **OEChem TK** manual



.. _oegrapheme_part_theory:

********************************
Theory
********************************

.. toctree::
   :maxdepth: 3

   annotation
   surface
   complexsurface
   propmap

.. graphsimtk toolkit documentation master file

###################################
GraphSim Toolkit |graphsim_version|
###################################

.. toctree::
   :maxdepth: 2

   introduction
   theory
   gpu
   examples
   api

..  oe:language:: python

    .. toctree::
       :maxdepth: 1

       selected_examples_python

.. toctree::
   :maxdepth: 2

   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt




.. _oegraphsim_chapter_intro:
.. _GraphSim:

********************************************************************************
Introduction
********************************************************************************

This manual is to familiarize the user with the **GraphSim TK**
functionalities. It does not provide explanations
of basic **OEChem TK** classes and functions. Therefore reading the
**OEChem TK** manual beforehand is highly recommended.

The **GraphSim TK** library provides a facility for encoding 2D molecular
graph information into fingerprints.
The following basic fingerprint functionalities are available:

* Generation (see :ref:`chapter_fingerprint` chapter)
* Storage (see :ref:`chapter_storage` chapter)
* Comparison (see :ref:`chapter_measure` chapter)

Emphasis has been placed on speed, with attention to rapid in-memory
fingerprint search (see :ref:`chapter_database` chapter).

.. The **GraphSim TK** package includes functionality for generating
   fingerprints that encode 2D graph information, calculating
   molecular similarity from fingerprints and provides facility to
   perform rapid in-memory fingerprint search.

.. _oegraphsim_section_visualizing_molecule_similarity:

Visualizing Molecule Similarity
================================================================================

All images in this manual are generated utilizing the
`OEDepict TK <http://www.eyesopen.com/oedepict-tk>`_
and `Grapheme TK <http://www.eyesopen.com/oegrapheme-tk>`_ .

Molecule similarity based on fingerprints is visualized by the
following method:
(See example in :ref:`Figure: Example of depiction of molecule similarity based on fingerprints<figure_MoleculeSimilarity>`)

* The :oe:func:`OEGraphSim::OEGetFPOverlap` function is utilized to return all
  common fragments found between two molecules based on a given fingerprint type.
  These common fragments reveal the similar parts of the two molecules being compared.
*  A “yellow to dark green” linear color gradient is then used to color the
   molecules by their similarity.
   Where there is similarity detected between the two molecules *i.e.* there are common fragments,
   the color green is used to highlight the bonds. The color gets darker with
   increasing similarity *i.e.* as more fragments are shared by the two molecules.
*  Color pink indicates parts of the molecules that are not
   sharing any common fragments *i.e.* they are 2D dissimilar based on the
   given fingerprint type.

.. _figure_MoleculeSimilarity:

.. figure:: graphsimtk/images/MoleculeSimilarity.*
   :align:  center

   **Example of depiction of molecule similarity based on fingerprints**

.. hint::

   Visualizing similarity of two molecules based on their fingerprints provides insight into
   molecule similarity beyond a single numerical score and reveals information about the underlying
   fingerprint methods.

.. seealso::

   The Python script that visualizes molecule similarity based on fingerprints
   can be downloaded from the
   `OpenEye Python Cookbook <https://docs.eyesopen.com/python_modules/cookbook/python/depiction/simcalc.html>`_



.. _oegraphsim_part_theory:

.. _oegraphsim_nogpu_part_theory:

********************************
Theory
********************************

.. toctree::
   :maxdepth: 3

   fingerprint
   fptype
   storage
   measure
   database
   userdefined
   coverage
   overlap
   patterns


.. _chapter_fingerprint:

********************************************************************************
Fingerprint Generation
********************************************************************************

The fingerprint types implemented in the **GraphSim TK** encode the 2D graph
features of molecules.
Fingerprints can be used in applications such as similarity searches,
molecular characterization, molecular diversity and chemical database
clustering.

The following five types of fingerprints are implemented:

#. :ref:`section_fingerprint_maccs` (:oe:const:`OEGraphSim::OEFPType::MACCS166`)

#. :ref:`section_fingerprint_lingo` (:oe:const:`OEGraphSim::OEFPType::Lingo`)

#. :ref:`section_fingerprint_circular`  (:oe:const:`OEGraphSim::OEFPType::Circular`)

#. :ref:`section_fingerprint_path`  (:oe:const:`OEGraphSim::OEFPType::Path`)

#. :ref:`section_fingerprint_tree`  (:oe:const:`OEGraphSim::OEFPType::Tree`)

.. _section_fingerprint_maccs:

MACCS
================================================================================

:term:`MACCS` keys are 166 bit :term:`structural key` descriptors in which each
bit is associated with a :term:`SMARTS` pattern.

The following code snippets demonstrate two **separate** ways to
create a MACCS keys fingerprint:

.. oe:source:: MakeMaccsFP.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MAKE-MACCS-1

.. oe:source:: MakeMaccsFP.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MAKE-MACCS-1

..    oe:language:: python

    :ref:`Full listing. <listing-MakeMaccsFP.py>`

.. oe:source:: MakeMaccsFP.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MAKE-MACCS-1

.. oe:source:: MakeMaccsFP.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MAKE-MACCS-1

.. oe:source:: MakeMaccsFP.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MAKE-MACCS-2

.. oe:source:: MakeMaccsFP.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MAKE-MACCS-2

..    oe:language:: python

    :ref:`Full listing. <listing-MakeMaccsFP.py>`

.. oe:source:: MakeMaccsFP.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MAKE-MACCS-2

.. oe:source:: MakeMaccsFP.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MAKE-MACCS-2

.. _section_fingerprint_lingo:

LINGO
================================================================================

The **GraphSim TK** provides fingerprint API for the :term:`LINGO`
similarity search method implemented in **OEChem TK**.

The following code snippets demonstrate two **separate** ways to
create a :term:`LINGO` fingerprint:

.. oe:source:: MakeLingoFP.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MAKE-LINGO-1

.. oe:source:: MakeLingoFP.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MAKE-LINGO-1

..    oe:language:: python

    :ref:`Full listing. <listing-MakeLingoFP.py>`

.. oe:source:: MakeLingoFP.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MAKE-LINGO-1

.. oe:source:: MakeLingoFP.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MAKE-LINGO-1

.. oe:source:: MakeLingoFP.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MAKE-LINGO-2

.. oe:source:: MakeLingoFP.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MAKE-LINGO-2

..    oe:language:: python

    :ref:`Full listing. <listing-MakeLingoFP.py>`

.. oe:source:: MakeLingoFP.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MAKE-LINGO-2

.. oe:source:: MakeLingoFP.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MAKE-LINGO-2

.. _section_fingerprint_circular:

Circular
================================================================================

A circular fingerprint is generated by **exhaustively** enumerating
**all** circular fragments grown radially from each heavy atom of the
molecule up to the given radius and then hashing these fragments into
a fixed-length bitvector.
See :ref:`Figure: Example of enumerating circular fragments with various radii<figure_fingerprint_circular>`.

.. _figure_fingerprint_circular:

.. figure:: graphsimtk/images/CircularEnumeration.*
   :scale:  100
   :align:  center

   **Example of enumerating circular fragments with various radii**

The following code snippets demonstrate two **separate** ways to create a
circular fingerprint with default parameters:

.. oe:source:: MakeCircularFP.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MAKE-CIRCULAR-1

..    oe:language:: python

    :ref:`Full listing. <listing-MakeCircularFP.py>`

.. oe:source:: MakeCircularFP.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MAKE-CIRCULAR-2

..    oe:language:: python

    :ref:`Full listing. <listing-MakeCircularFP.py>`

.. oe:source:: MakeCircularFP.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MAKE-CIRCULAR-1

.. oe:source:: MakeCircularFP.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MAKE-CIRCULAR-2

.. oe:source:: MakeCircularFP.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MAKE-CIRCULAR-1

.. oe:source:: MakeCircularFP.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MAKE-CIRCULAR-2

.. oe:source:: MakeCircularFP.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MAKE-CIRCULAR-1

.. oe:source:: MakeCircularFP.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MAKE-CIRCULAR-2

.. _section_fingerprint_path:

Path
================================================================================

A path fingerprint is generated by **exhaustively** enumerating
**all** linear fragments of a molecular graph up to a given size
and then hashing these fragments into a fixed-length bitvector.
See :ref:`Figure: Example of enumerating path fragments with various lengths<figure_fingerprint_path>`.

.. _figure_fingerprint_path:

.. figure:: graphsimtk/images/PathEnumeration.*
   :scale:  100
   :align:  center

   **Example of enumerating path fragments with various lengths**

The following code snippets demonstrate two **separate** ways to create a
path fingerprint with default parameters:

.. oe:source:: MakePathFP.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MAKE-PATH-1

.. oe:source:: MakePathFP.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MAKE-PATH-1

..    oe:language:: python

    :ref:`Full listing. <listing-MakePathFP.py>`

.. oe:source:: MakePathFP.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MAKE-PATH-1

.. oe:source:: MakePathFP.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MAKE-PATH-1

.. oe:source:: MakePathFP.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MAKE-PATH-2

.. oe:source:: MakePathFP.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MAKE-PATH-2

..    oe:language:: python

    :ref:`Full listing. <listing-MakePathFP.py>`

.. oe:source:: MakePathFP.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MAKE-PATH-2

.. oe:source:: MakePathFP.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MAKE-PATH-2

.. _section_fingerprint_tree:

Tree
================================================================================

A tree fingerprint is generated by **exhaustively** enumerating
**all**  tree fragments of a molecular graph up to a given size
and then hashing these fragments into a fixed-length bitvector.
See :ref:`Figure: Example of enumerating tree fragments with various lengths<figure_fingerprint_tree>`.

.. _figure_fingerprint_tree:

.. figure:: graphsimtk/images/TreeEnumeration.*
   :scale:  100
   :align:  center

   **Example of enumerating tree fragments with various lengths**

The following code snippets demonstrate two **separate** ways to create a
tree fingerprint with default parameters:

.. oe:source:: MakeTreeFP.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MAKE-TREE-1

..    oe:language:: python

    :ref:`Full listing. <listing-MakePathFP.py>`

.. oe:source:: MakeTreeFP.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MAKE-TREE-2

..    oe:language:: python

    :ref:`Full listing. <listing-MakePathFP.py>`

.. oe:source:: MakeTreeFP.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MAKE-TREE-1

.. oe:source:: MakeTreeFP.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MAKE-TREE-2

.. oe:source:: MakeTreeFP.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MAKE-TREE-1

.. oe:source:: MakeTreeFP.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MAKE-TREE-2

.. oe:source:: MakeTreeFP.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MAKE-TREE-1

.. oe:source:: MakeTreeFP.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MAKE-TREE-2

.. hint::

   **GraphSim TK** also provides the ability to parameterize the
   circular, path and tree fingerprint generation with arbitrary
   sets of properties.
   For more details see the :ref:`chapter_user_defined` chapter.



.. _chapter_fptype:

********************************************************************************
Fingerprint Types
********************************************************************************

A fingerprint is a bitvector.
To reflect this the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` class derives
from the :ref:`OEBitVector <OESystem_OEBitVector>` class.
The difference is that :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` has a type
that represents how the fingerprint is generated.
Fingerprints may only be compared if they are generated in the same way.
Therefore, the following restriction is introduced:

.. warning::

   When two fingerprints are subjected to similarity calculation their
   type has to be identical.

:oe:src:`Listing 1<SNIPPET-FPTYPE-FPType>` shows how to create different fingerprint
objects (:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`) and identify or
compare their types.

.. oe:source:: FPType.cpp
   :language: c++
   :refnum:   1
   :caption:  Fingerprint type
   :frag:     SNIPPET-FPTYPE

.. oe:source:: FPType.py
   :language: python 
   :refnum:   1
   :caption:  Fingerprint type
   :frag:     SNIPPET-FPTYPE

..    oe:language:: python

    :ref:`Full listing. <listing-FPType.py>`

.. oe:source:: FPType.java
   :language: java
   :refnum:   1
   :caption:  Fingerprint type
   :frag:     SNIPPET-FPTYPE

.. oe:source:: FPType.cs
   :language: csharp
   :refnum:   1
   :caption:  Fingerprint type
   :frag:     SNIPPET-FPTYPE

The output of :oe:src:`Listing 1<SNIPPET-FPTYPE-FPType>` is the following:

::

   uninitialized fingerprint
   Path
   different fingerprint types

Two fingerprints are considered to be equivalent only if they have 
the same fingerprint type (:ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`)
and have identical bit-vectors (:ref:`OEBitVector <OESystem_OEBitVector>`).
The following code snippet shows how to compare two 
:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects.

.. oe:source:: FPCompare.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-FP-COMPARE

.. oe:source:: FPCompare.py
   :language: python
   :noindent:
   :frag:     SNIPPET-FP-COMPARE

..    oe:language:: python

    :ref:`Full listing. <listing-FPCompare.py>`

.. oe:source:: FPCompare.java
   :language: java
   :noindent:
   :frag:     SNIPPET-FP-COMPARE

.. oe:source:: FPCompare.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-FP-COMPARE

The following code snippet shows how to initialize a
:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object by
using the type of another fingerprint. 
The type of a fingerprint is accessed by the
:oe:meth:`OEGraphSim::OEFingerPrint::GetFPTypeBase` method.

.. oe:source:: MakeFP.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MAKE-FP

.. oe:source:: MakeFP.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MAKE-FP

..    oe:language:: python

    :ref:`Full listing. <listing-FPCompare.py>`

.. oe:source:: MakeFP.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MAKE-FP

.. oe:source:: MakeFP.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MAKE-FP

.. _section_fptype_parameters:

Fingerprint parameters
================================================================================

The :ref:`chapter_user_defined` chapter gives examples of how user defined
fingerprints can be generated by defining, for example, the atom and
bond properties that will be encoded into the fingerprints.

In order to ensure that only equivalent fingerprints can be compared,
the fingerprint type stores the parameters being used in the
generation process.
The :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPTypeString` method returns
the string representation of the fingerprint type that includes
information about the parameters being used.

.. oe:source:: FPTypeString.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-FP-TYPE-STRING

.. oe:source:: FPTypeString.py
   :language: python
   :noindent:
   :frag:     SNIPPET-FP-TYPE-STRING

..    oe:language:: python

    :ref:`Full listing. <listing-FPTypeString.py>`

.. oe:source:: FPTypeString.java
   :language: java
   :noindent:
   :frag:     SNIPPET-FP-TYPE-STRING

.. oe:source:: FPTypeString.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-FP-TYPE-STRING

The output of the preceding snippet is the following:

::

   Path,ver=2.0.0,size=4096,bonds=0-5,atype=AtmNum|Arom|Chiral|FCharge|HvyDeg|Hyb|EqHalo,
   btype=Order|Chiral

.. note::

   The returned string does not include newline characters, the string was broken
   into two separate lines here only for better readability.

The following :oe:src:`Listing 2<SNIPPET-FPTYPE-PARAMS-FPTypeParams>` shows how to extract
the parameters of a fingerprint from a string representation by
using the :ref:`OEFPTypeParams <OEGraphSim_OEFPTypeParams>` class.

.. oe:source:: FPTypeParams.cpp
   :language: c++
   :refnum:   2
   :caption:  Fingerprint parameters
   :frag:     SNIPPET-FPTYPE-PARAMS

.. oe:source:: FPTypeParams.py
   :language: python 
   :refnum:   2
   :caption:  Fingerprint parameters
   :frag:     SNIPPET-FPTYPE-PARAMS

..    oe:language:: python

    :ref:`Full listing. <listing-FPTypeParams.py>`

.. oe:source:: FPTypeParams.java
   :language: java
   :refnum:   2
   :caption:  Fingerprint parameters
   :frag:     SNIPPET-FPTYPE-PARAMS

.. oe:source:: FPTypeParams.cs
   :language: csharp
   :refnum:   2
   :caption:  Fingerprint parameters
   :frag:     SNIPPET-FPTYPE-PARAMS

The output of :oe:src:`Listing 2<SNIPPET-FPTYPE-PARAMS-FPTypeParams>` is the following:

::

  version = 2.0.0
  number of bits = 4096
  min bonds = 0
  max bonds = 5
  atom types = AtmNum|Arom|Chiral|FCharge|HvyDeg|Hyb|EqHalo
  bond types = Order|Chiral

.. seealso::

   * :ref:`chapter_user_defined` chapter  
   * :oe:func:`OEGraphSim::OEIsValidFPTypeString` function 
   * :oe:func:`OEGraphSim::OEGetFPType` function 
   * :oe:constns:`OEGraphSim::OEFPAtomType` namespace  
   * :oe:func:`OEGraphSim::OEGetFPAtomType` function
   * :oe:constns:`OEGraphSim::OEFPBondType` namespace  
   * :oe:func:`OEGraphSim::OEGetFPBondType` function

.. _section_fptype_version_number:

Fingerprint version number
================================================================================

Each fingerprint type additionally has a version number. Version
numbers are introduced in order to keep track of changes in the
fingerprint generation algorithm itself.
The :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPVersionString` method
returns the string representation of the fingerprint version.

.. oe:source:: FPTypeString.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-FP-VERSION

.. oe:source:: FPTypeString.py
   :language: python
   :noindent:
   :frag:     SNIPPET-FP-VERSION

..    oe:language:: python

    :ref:`Full listing. <listing-FPTypeString.py>`

.. oe:source:: FPTypeString.java
   :language: java
   :noindent:
   :frag:     SNIPPET-FP-VERSION

.. oe:source:: FPTypeString.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-FP-VERSION

The output of  the preceding snippet is the following:

::

  2.0.0

.. warning::

   The version number of the fingerprints will not be changed with each
   release. It will be incremented only if modifications or bug fixes
   to the corresponding algorithm would result in generating a different
   bit-vector for the same molecules.

   Fingerprints with an old version number will be still readable and
   comparable with each other but not with fingerprints which have
   different version number.


.. oe:namespace:: OEGraphSim

.. _OEGraphSim_OECreateFastFPDatabaseOptions:

.. oe:class:: OECreateFastFPDatabaseOptions

   .. oe:api::

      class OECreateFastFPDatabaseOptions

   Encapsulates the options that control how the binary fingerprint database
   file is generated when calling the
   :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function.

   .. seealso::

      * :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function
      * Example code in :ref:`section_examples_summary_makefastfp` section

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECreateFastFPDatabaseOptions(const OEFPTypeBase* fptype)

      .. oe:language:: python

         .. oe:api:: python

            OECreateFastFPDatabaseOptions(fptype: OEFPTypeBase) -> OECreateFastFPDatabaseOptions

      Constructs an :ref:`OECreateFastFPDatabaseOptions <OEGraphSim_OECreateFastFPDatabaseOptions>`
      object with the given fingerprints type.

      .. seealso::

         * :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class

      .. note::

         **GraphSim TK** currently only supports the :term:`popcount` search method
         for fingerprints with the size of multiple of ``256``.
         This means that the :oe:const:`OEGraphSim::OEFPType::MACCS166`
         fingerprint type is currently not supported.
         When using other custom fingerprint types (see :ref:`chapter_user_defined` section)
         the size of the fingerprint must be a multiple of ``256`` in order to
         be able to search it with the :term:`popcount` method.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetFPType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFPTypeBase* GetFPType() const

      .. oe:language:: python

         .. oe:api:: python

            GetFPType() -> OEFPTypeBase

      Returns the fingerprint type in which the
      :ref:`OECreateFastFPDatabaseOptions <OEGraphSim_OECreateFastFPDatabaseOptions>` was constructed.

      .. seealso::

         * :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetNumProcessors

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumProcessors() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumProcessors() -> int

      Returns the number of threads that are used to generate
      fingerprints when calling the
      :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function.

      .. seealso::

         * :oe:meth:`OEGraphSim::OECreateFastFPDatabaseOptions::SetNumProcessors` method

   .. ################################################################
      #
      ################################################################

   .. oe:method: GetTracer DO NOT DOCUMENT

      .. oe:api::

         const OESystem::OEDots *GetTracer() const

   .. ################################################################
      #
      ################################################################

   .. oe:method:: SetNumProcessors

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNumProcessors(unsigned int nrps)

      .. oe:language:: python

         .. oe:api:: python

            SetNumProcessors(nrps: int) -> None

      Sets the number of threads that are used to generate
      fingerprints when calling the
      :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function.
      When set to ``0``, the number of processors used will be the number
      returned by the :oe:func:`OEPlatform::OEGetNumProcessors` function.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: SetTracer

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTracer(const OESystem::OEDots& dots)

      .. oe:language:: python

         .. oe:api:: python

            SetTracer(dots: OEDots) -> None

      Sets a tracer that can be used to show the progress of fingerprint
      generation.

      .. seealso::

         * :ref:`OEDots <OESystem_OEDots>` class in the **OEChem TK** manual


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEFPDatabase, FPDatabase

.. _OEGraphSim_OEFPDatabase:

.. oe:class:: OEFPDatabase

   .. oe:api::

      class OEFPDatabase

   The :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` class is designed to perform
   rapid in-memory fingerprint searches.
   Each :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object is associated with a
   fingerprint type (:ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`) that is
   specified when the database is constructed.
   An :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object can only store
   fingerprints (:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`) with this
   specified type.

   .. seealso::

      * :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFPDatabase(unsigned int fptype)

      .. oe:language:: python

         .. oe:api:: python

            OEFPDatabase(fptype: int) -> OEFPDatabase

      Creates an :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object that can
      store :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects with a given type.

      **fptype**
        The type of the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object stored in the
        :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>`.
        This value has to be from the :oe:constns:`OEGraphSim::OEFPType`
        namespace.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFPDatabase(const OEGraphSim::OEFPTypeBase *)

      .. oe:language:: python

         .. oe:api:: python

            OEFPDatabase(arg2: OEFPTypeBase) -> OEFPDatabase

      Creates an :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object that can
      store :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects with
      :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` type.

      .. note::

         By default, an :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object is constructed with:

         * no cutoff value
         * :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>` similarity measure
         * descending order to return scores when calling the
           :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` method

         These default values can be altered by the following methods:

         * :oe:meth:`OEGraphSim::OEFPDatabase::SetCutoff`
         * :oe:meth:`OEGraphSim::OEFPDatabase::SetSimFunc`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFPDatabase & operator=(const OEFPDatabase & rhs)

      Assignment operator.

   .. oe:method:: AddFP

      .. oe:api::

         unsigned int AddFP(const OEChem::OEMolBase &mol)

      Generates an :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object from the
      :ref:`OEMolBase <OEChem_OEMolBase>` molecule with the fingerprint type of
      the :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>`.
      The generated :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object is then
      inserted into the database returning its index.
      This method will return ``-1``, if the fingerprint generation
      was unsuccessful.

      .. oe:api::

         unsigned int AddFP(const OEGraphSim::OEFingerPrint &fp)

      Creates a copy of the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object,
      inserts it into the database, and then returns its index.
      If the type of the passed fingerprint was different from the
      type of the database, than the insertion is unsuccessful and
      this method will return ``-1``.

      .. note::

         The index returned by the
         :oe:meth:`OEGraphSim::OEFPDatabase::AddFP` method is a unique
         number starting from zero.
         This index can be used as a reference number to associate
         the fingerprint with the molecule from which is it generated.

   .. oe:method:: ClearCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearCutoff()

      .. oe:language:: python

         .. oe:api:: python

            ClearCutoff() -> None

      Removes the cutoff value previously set by the
      :oe:meth:`OEGraphSim::OEFPDatabase::SetCutoff` method.
      After clearing the cutoff value
      :oe:meth:`OEGraphSim::OEFPDatabase::HasCutoff` method
      will return ``false``.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabase::GetCutoff`
         * :oe:meth:`OEGraphSim::OEFPDatabase::HasCutoff`
         * :oe:meth:`OEGraphSim::OEFPDatabase::SetCutoff`

   .. oe:method:: GetCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetCutoff() -> float

      Returns the cutoff value previously set by the
      :oe:meth:`OEGraphSim::OEFPDatabase::SetCutoff` method.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabase::ClearCutoff`
         * :oe:meth:`OEGraphSim::OEFPDatabase::HasCutoff`
         * :oe:meth:`OEGraphSim::OEFPDatabase::SetCutoff`

   .. oe:method:: GetDescendingOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetDescendingOrder() const

      .. oe:language:: python

         .. oe:api:: python

            GetDescendingOrder() -> bool

      Returns the order in which the calculated scores are returned by
      the :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores`
      method.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabase::SetDescendingOrder`

   .. oe:method:: GetFPTypeBase

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEGraphSim::OEFPTypeBase* GetFPTypeBase() const

      .. oe:language:: python

         .. oe:api:: python

            GetFPTypeBase() -> OEFPTypeBase

      Returns the fingerprint type of the
      :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object.

   .. oe:method:: GetFingerPrints

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<const OEGraphSim::OEFingerPrint>* GetFingerPrints() const

      .. oe:language:: python

         .. oe:api:: python

            GetFingerPrints() -> Iterable[OEFingerPrint]

      Returns an iterator pointer over fingerprints
      (:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`) stored in the
      :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object.
      The returned :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects can only
      be accessed by `const` methods or functions, *i.e.*, they can
      not be modified.

   .. oe:method:: GetScores

   .. list-table:: **The overloaded versions of the GetScores method**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`GetScores(mol, bgn, end)<api_OEFPDatabase_GetScores>`
        - returns similarities for a molecule

      * - :ref:`GetScores(fp, bgn, end)<api_OEFPDatabase_GetScores>`
        - returns similarities for a fingerprint

      * - :ref:`GetScores(mol, opts)<api_OEFPDatabase_GetScores_OEFPDatabaseOptions>`
        - returns similarities for a molecule with the given options

      * - :ref:`GetScores(fp, opts)<api_OEFPDatabase_GetScores_OEFPDatabaseOptions>`
        - returns similarities for a fingerprint with the given options

   **Similarity calculation:**

   .. _api_OEFPDatabase_GetScores:

      .. oe:api::

         OESystem::OEIterBase<OEGraphSim::OESimScore> * GetScores(const OEChem::OEMolBase &mol,
                                                                  unsigned int bgn = 0,
                                                                  unsigned int end = 0) const

      .. oe:api::

         OESystem::OEIterBase<OEGraphSim::OESimScore> * GetScores(const OEGraphSim::OEFingerPrint &fp,
                                                                  unsigned int bgn = 0,
                                                                  unsigned int end = 0) const

      Performs similarity calculation between a given molecule or a
      fingerprint and the fingerprints stored in the
      :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object.
      It returns an iterator over the calculated similarity scores
      (:ref:`OESimScore <OEGraphSim_OESimScore>`).
      Each :ref:`OESimScore <OEGraphSim_OESimScore>` holds a similarity score
      and index of the corresponding fingerprint of the database.

      **mol**
         If the method is called with an :ref:`OEMolBase <OEChem_OEMolBase>`
         object, then a fingerprint is generated from this molecule
         before looping over the fingerprints of the database and
         calculating similarities.

      **fp**
         If the method is called with an :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`
         object, then its type has to  match with the type of the
         :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>`.

      **bgn**, **end**
         The ``bgn`` and ``end`` arguments define the segment of the
         database on which the similarity calculation will take place.
         If both of these parameters are omitted (or set to zero), then
         the similarity calculation is performed on the entire
         fingerprint database.

      .. note::

         * By default, the :oe:meth:`OEGraphSim::OEFPDatabase::GetScores`
           methods calculates :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>`
           similarity scores and will always return these scores in the
           order in which the corresponding :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`
           objects are added to the database.

         * By using the :oe:meth:`OEGraphSim::OEFPDatabase::SetSimFunc`
           method, similarity measures other than the default can be
           performed.

         * The behavior of :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` is
           also influenced by the cutoff value
           (:oe:meth:`OEGraphSim::OEFPDatabase::SetCutoff`) of the database
           and the order of the scores specified by the
           :oe:meth:`OEGraphSim::OEFPDatabase::SetSimFunc` method.
           If a cutoff value was set, then the
           :oe:meth:`OEGraphSim::OEFPDatabase::GetScores` method:

           * return scores that are equal to or larger than the specified
             cutoff value if the order is descending
           * return scores that are equal to or smaller than the
             specified cutoff value if the order is ascending

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabase::SetSimFunc` method
         * :oe:meth:`OEGraphSim::OEFPDatabase::SetCutoff` method

      **Examples:**

      * Calculates the :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>`
        similarity on the first 100 entries of the database and returns
        scores that are equal to or larger than ``0.1``.

        .. oe:source:: GetScores.cpp
           :language: c++
           :noindent:
           :frag:     SNIPPET-GET-SCORES-1

        .. oe:source:: GetScores.py
           :language: python
           :noindent:
           :frag:     SNIPPET-GET-SCORES-1

        ..  oe:language:: python

            :ref:`Full listing. <listing-GetScores.py>`

        .. oe:source:: GetScores.java
           :language: java
           :noindent:
           :frag:     SNIPPET-GET-SCORES-1

        .. oe:source:: GetScores.cs
           :language: csharp
           :noindent:
           :frag:     SNIPPET-GET-SCORES-1

      * Calculates the :oe:cls:`Tversky<OEGraphSim::OETverskySim>`
        similarity (with :math:`\alpha=0.9` and :math:`\beta=0.1`)
        on the entire database and returns all scores.

        .. oe:source:: GetScores.cpp
           :language: c++
           :noindent:
           :frag:     SNIPPET-GET-SCORES-2

        .. oe:source:: GetScores.py
           :language: python
           :noindent:
           :frag:     SNIPPET-GET-SCORES-2

        ..  oe:language:: python

            :ref:`Full listing. <listing-GetScores.py>`

        .. oe:source:: GetScores.java
           :language: java
           :noindent:
           :frag:     SNIPPET-GET-SCORES-2

        .. oe:source:: GetScores.cs
           :language: csharp
           :noindent:
           :frag:     SNIPPET-GET-SCORES-2

      * Calculates the :oe:const:`Dice<OEGraphSim::OESimMeasure::Dice>`
        similarity beginning at the 100th entry of the database and
        returns scores that are equal to or smaller than  ``0.5``.

        .. oe:source:: GetScores.cpp
           :language: c++
           :noindent:
           :frag:     SNIPPET-GET-SCORES-3

        .. oe:source:: GetScores.py
           :language: python
           :noindent:
           :frag:     SNIPPET-GET-SCORES-3

        ..  oe:language:: python

            :ref:`Full listing. <listing-GetScores.py>`

        .. oe:source:: GetScores.java
           :language: java
           :noindent:
           :frag:     SNIPPET-GET-SCORES-3

        .. oe:source:: GetScores.cs
           :language: csharp
           :noindent:
           :frag:     SNIPPET-GET-SCORES-3

   .. _api_OEFPDatabase_GetScores_OEFPDatabaseOptions:

   **Similarity calculation with an option class:**

      Performs similarity calculation between a given molecule or a
      fingerprint and the fingerprints stored in the
      :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object.
      It returns an iterator over the calculated similarity scores
      (:ref:`OESimScore <OEGraphSim_OESimScore>`).
      Each :ref:`OESimScore <OEGraphSim_OESimScore>` holds a similarity score
      and index of the corresponding fingerprint of the database.

      **mol**
         If the method is called with an :ref:`OEMolBase <OEChem_OEMolBase>`
         object, then a fingerprint is generated from this molecule
         before looping over the fingerprints of the database and
         calculating similarities.

      **fp**
         If the method is called with an :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`
         object, then its type has to  match with the type of the
         :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>`.

      **opts**
         The :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` object controls
         all the parameters that determine the sorted search.
         For example, similarity measure, score cutoff, descending or ascending order
         etc.

      .. seealso::

         * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class

      **Example:**

      * Calculates the :oe:const:`Cosine<OEGraphSim::OESimMeasure::Cosine>`
        similarity on the entire database and returns scores
        that are equal to or larger than `0.3`.

        .. oe:source:: GetScores.cpp
           :language: c++
           :noindent:
           :frag:     SNIPPET-GET-SCORES-OPTIONS

        .. oe:source:: GetScores.py
           :language: python
           :noindent:
           :frag:     SNIPPET-GET-SCORES-OPTIONS

        ..  oe:language:: python

            :ref:`Full listing. <listing-GetScores.py>`

        .. oe:source:: GetScores.java
           :language: java
           :noindent:
           :frag:     SNIPPET-GET-SCORES-OPTIONS

        .. oe:source:: GetScores.cs
           :language: csharp
           :noindent:
           :frag:     SNIPPET-GET-SCORES-OPTIONS

   .. oe:method:: GetSortedScores

   .. list-table:: **The overloaded versions of the GetSortedScores method**
      :widths: 100 200
      :header-rows: 1

      * - Link
        - Description

      * - :ref:`GetSortedScores(mol, limit, bgn, end)<api_OEFPDatabase_GetSortedScores>`
        - returns sorted similarities for a molecule

      * - :ref:`GetSortedScores(fp, limit, bgn, end)<api_OEFPDatabase_GetSortedScores>`
        - returns sorted similarities for a fingerprint

      * - :ref:`GetSortedScores(mol, opts)<api_OEFPDatabase_GetSortedScores_OEFPDatabaseOptions>`
        - returns sorted similarities for a molecule with the given options

      * - :ref:`GetSortedScores(fp, opts)<api_OEFPDatabase_GetSortedScores_OEFPDatabaseOptions>`
        - returns similarities for a fingerprint with the given options

   **Similarity calculation:**

   .. _api_OEFPDatabase_GetSortedScores:

      .. oe:api::

         OESystem::OEIterBase<OEGraphSim::OESimScore> * GetSortedScores(const OEChem::OEMolBase &mol,
                                                                        unsigned int limit = 0,
                                                                        unsigned int bgn = 0,
                                                                        unsigned int end = 0) const

      .. oe:api::

         OESystem::OEIterBase<OEGraphSim::OESimScore> * GetSortedScores(const OEGraphSim::OEFingerPrint &fp,
                                                                        unsigned int limit = 0,
                                                                        unsigned int bgn = 0,
                                                                        unsigned int end = 0) const

      Performs similarity calculations between a molecule or a
      fingerprint and the fingerprints stored in the
      :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object.
      It returns an iterator over the calculated similarity
      scores (:ref:`OESimScore <OEGraphSim_OESimScore>`) in sorted order.
      Each :ref:`OESimScore <OEGraphSim_OESimScore>` holds a similarity score
      and index of the corresponding fingerprint of the database.

      **mol**
         If the method is called with an :ref:`OEMolBase <OEChem_OEMolBase>`
         object, then a fingerprint is generated from this molecule
         before looping over the fingerprints of the database and
         calculating similarities.

      **fp**
         If the method is called with an :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`
         object, then its type has to  match with the type of the
         :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>`.

      **bgn**, **end**
         The ``bgn`` and ``end`` arguments define the segment of the
         database on which the similarity calculation will take place.
         If both of these parameters are omitted (or set to zero), then
         the similarity calculation is performed on the entire
         fingerprint  database.

      **limit**
         The value that defines the number of similarity scores
         returned by the
         :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` method.
         If it is omitted (or set to zero) then all of the similarity
         scores are returned.

      .. note::

         * By default, the :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores`
           method calculates :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>`
           similarity scores and returns them in descending order.

         * By using the :oe:meth:`OEGraphSim::OEFPDatabase::SetSimFunc`
           method, similarity measures other than the default can be
           performed.

         * The behavior of :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` is
           also influenced by the cutoff value
           (:oe:meth:`OEGraphSim::OEFPDatabase::SetCutoff`) of the database
           and the order of the scores specified by the
           :oe:meth:`OEGraphSim::OEFPDatabase::SetSimFunc` method.
           If a cutoff value was set, then the
           :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` method:

           * return scores that are equal to or larger than the specified
             cutoff  value if the order is descending
           * return scores that are equal to or smaller than the
             specified cutoff value if the order is ascending

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabase::SetSimFunc` method
         * :oe:meth:`OEGraphSim::OEFPDatabase::SetCutoff` method

      **Examples:**

      * Calculates the :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>`
        similarity on the entire database and returns the 10 best
        scores in descending order.

        .. oe:source:: GetScores.cpp
           :language: c++
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-1

        .. oe:source:: GetScores.py
           :language: python
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-1

        ..  oe:language:: python

            :ref:`Full listing. <listing-GetScores.py>`

        .. oe:source:: GetScores.java
           :language: java
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-1

        .. oe:source:: GetScores.cs
           :language: csharp
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-1

      * Calculates the :oe:const:`Dice<OEGraphSim::OESimMeasure::Dice>`
        similarity on the first 100 entries of the database and
        returns scores that are equal to or larger than ``0.5`` in
        descending order.

        .. oe:source:: GetScores.cpp
           :language: c++
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-2

        .. oe:source:: GetScores.py
           :language: python
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-2

        ..  oe:language:: python

            :ref:`Full listing. <listing-GetScores.py>`

        .. oe:source:: GetScores.java
           :language: java
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-2

        .. oe:source:: GetScores.cs
           :language: csharp
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-2

      * Calculates :oe:const:`Manhattan<OEGraphSim::OESimMeasure::Manhattan>`
        similarity beginning at the 100th entry of the database and
        returns the "worst" 5 scores that are equal to or smaller
        than ``0.3`` in ascending order.

        .. oe:source:: GetScores.cpp
           :language: c++
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-3

        .. oe:source:: GetScores.py
           :language: python
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-3

        ..  oe:language:: python

            :ref:`Full listing. <listing-GetScores.py>`

        .. oe:source:: GetScores.java
           :language: java
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-3

        .. oe:source:: GetScores.cs
           :language: csharp
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-3

   **Sorted similarity calculation with an option class:**

   .. _api_OEFPDatabase_GetSortedScores_OEFPDatabaseOptions:

      .. oe:api::

         OESystem::OEIterBase<OESimScore>* GetSortedScores(const OEChem::OEMolBase& mol,
                                                           const OEFPDatabaseOptions& opts) const GetSortedScores(const OEChem::OEMolBase &mol, const OEFPDatabaseOption &opts) const

      .. oe:api::

         OESystem::OEIterBase<OESimScore>* GetSortedScores(const OEFingerPrint& fp,
                                                           const OEFPDatabaseOptions& opts) const GetSortedScores(const OEGraphSim::OEFingerPrint &fp, const OEFPDatabaseOption &opts) const

      Performs similarity calculations between a molecule or a
      fingerprint and the fingerprints stored in the
      :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object.
      It returns an iterator over the calculated similarity
      scores (:ref:`OESimScore <OEGraphSim_OESimScore>`) in sorted order.
      Each :ref:`OESimScore <OEGraphSim_OESimScore>` holds a similarity score
      and index of the corresponding fingerprint of the database.

      **mol**
         If the method is called with an :ref:`OEMolBase <OEChem_OEMolBase>`
         object, then a fingerprint is generated from this molecule
         before looping over the fingerprints of the database and
         calculating similarities.

      **fp**
         If the method is called with an :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`
         object, then its type has to  match with the type of the
         :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>`.

      **opts**
         The :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` object controls
         all the parameters that determine the sorted search.
         For example, similarity measure, score cutoff, descending or ascending order
         etc.

      .. seealso::

         * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class

      **Example:**

      * Calculates :oe:const:`Tversky<OEGraphSim::OESimMeasure::Tversky>`
        similarity on the entire database and
        returns the best ``10`` scores that are equal to or larger than ``0.3`` in
        descending order.

        .. oe:source:: GetScores.cpp
           :language: c++
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-OPTIONS

        .. oe:source:: GetScores.py
           :language: python
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-OPTIONS

        ..  oe:language:: python

            :ref:`Full listing. <listing-GetScores.py>`

        .. oe:source:: GetScores.java
           :language: java
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-OPTIONS

        .. oe:source:: GetScores.cs
           :language: csharp
           :noindent:
           :frag:     SNIPPET-GET-SORTED-SCORES-OPTIONS

   .. oe:method:: HasCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            HasCutoff() -> bool

      Returns whether the cutoff value of the
      :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object has been set by the
      :oe:meth:`OEGraphSim::OEFPDatabase::SetCutoff` method.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabase::ClearCutoff`
         * :oe:meth:`OEGraphSim::OEFPDatabase::GetCutoff`
         * :oe:meth:`OEGraphSim::OEFPDatabase::SetCutoff`

   .. oe:method:: NumFingerPrints

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumFingerPrints() const

      .. oe:language:: python

         .. oe:api:: python

            NumFingerPrints() -> int

      Returns the number of :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects
      stored in the database.

   .. oe:method:: SetCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCutoff(float)

      .. oe:language:: python

         .. oe:api:: python

            SetCutoff(arg2: float) -> None

      Sets the cutoff value of the :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object.
      The cutoff value influences the behavior of both the
      :oe:meth:`OEGraphSim::OEFPDatabase::GetScores` and the
      :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` methods.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabase::ClearCutoff`
         * :oe:meth:`OEGraphSim::OEFPDatabase::HasCutoff`
         * :oe:meth:`OEGraphSim::OEFPDatabase::SetCutoff`

   .. oe:method:: SetDescendingOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDescendingOrder(bool descending)

      .. oe:language:: python

         .. oe:api:: python

            SetDescendingOrder(arg2: bool) -> None

      Sets the order in which the calculated scores are returned by
      the :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores`
      method.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabase::GetDescendingOrder`

   .. oe:method:: SetSimFunc

      Sets the method used to evaluate fingerprint similarity
      when calling either the :oe:meth:`OEGraphSim::OEFPDatabase::GetScores`
      or the :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` methods.

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSimFunc(unsigned int simtype, bool descending = true)

      .. oe:language:: python

         .. oe:api:: python

            SetSimFunc(simtype: int, descending: bool = True) -> None

      Sets the similarity calculation by specifying a similarity method
      with a constant from the :oe:constns:`OEGraphSim::OESimMeasure`
      namespace.
      The second argument defines the order in which the calculated
      scores are returned by the
      :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` method.

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSimFunc(const OEGraphSim::OESimFuncBase &,
                            bool descending = true)

      .. oe:language:: python

         .. oe:api:: python

            SetSimFunc(arg2: OESimFuncBase, descending: bool = True) -> None

      Creates a copy of the :ref:`OESimFuncBase <OEGraphSim_OESimFuncBase>` object
      and uses its :oe:meth:`OEGraphSim::OESimFuncBase::operator()`
      method to evaluate similarity between two :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`
      objects.
      The second argument defines the order in which the calculated
      scores are returned by the
      :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` method.

      .. note::

         By default, both the :oe:meth:`OEGraphSim::OEFPDatabase::GetScores`
         and the :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores`
         methods calculate :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>`
         similarity scores.
         While the :oe:meth:`OEGraphSim::OEFPDatabase::GetScores`
         always returns these scores in the order in which the corresponding
         :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects are added to the
         database, the latter method returns them in descending order,
         by default.

      .. seealso::

        * :ref:`section_database_simfunc` section
        * :ref:`section_measure_user_defined` section
        * :oe:constns:`OEGraphSim::OESimMeasure` namespace
        * :ref:`OETanimotoSim <OEGraphSim_OETanimotoSim>` class
        * :ref:`OETverskySim <OEGraphSim_OETverskySim>` class



.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEFPDatabaseOptions, FPDatabaseOptions

.. _OEGraphSim_OEFPDatabaseOptions:

.. oe:class:: OEFPDatabaseOptions

   .. oe:api::

      class OEFPDatabaseOptions

   The :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class  allows setting options on a per-search basis.
   This class is used to control the behavior of:

   * the following methods of the :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` class

     * :oe:meth:`OEGraphSim::OEFPDatabase::GetScores`
     * :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores`

   * the following methods of the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class

     * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetAllScores`
     * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetHistogram`
     * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetSortedScores`
     * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetRawScores`
     * :oe:meth:`OEGraphSim::OEFastFPDatabase::SortedSearch`

   .. seealso::

      * Example code in :ref:`Similarity calculation with an option class<api_OEFPDatabase_GetScores_OEFPDatabaseOptions>` section
      * Example code in :ref:`Sorted similarity calculation with an option class<api_OEFPDatabase_GetSortedScores_OEFPDatabaseOptions>` section
      * Example code in :ref:`section_examples_summary_searchfastfp` section

   The :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / type

      * - cutoff value
        - :oe:meth:`GetCutoff<OEGraphSim::OEFPDatabaseOptions::GetCutoff>`
        - :oe:meth:`SetCutoff<OEGraphSim::OEFPDatabaseOptions::SetCutoff>` /
          :oe:meth:`HasCutoff<OEGraphSim::OEFPDatabaseOptions::HasCutoff>`
        - floating point number

      * - order of sorting
        - :oe:meth:`GetDescendingOrder<OEGraphSim::OEFPDatabaseOptions::GetDescendingOrder>`
        - :oe:meth:`SetDescendingOrder<OEGraphSim::OEFPDatabaseOptions::SetDescendingOrder>`
        - boolean

      * - max number of scores
        - :oe:meth:`GetLimit<OEGraphSim::OEFPDatabaseOptions::GetLimit>`
        - :oe:meth:`SetLimit<OEGraphSim::OEFPDatabaseOptions::SetLimit>`
        - integer ``0`` means no limit

      * - similarity method
        - :oe:meth:`GetSimFunc<OEGraphSim::OEFPDatabaseOptions::GetSimFunc>`
        - :oe:meth:`SetSimFunc<OEGraphSim::OEFPDatabaseOptions::SetSimFunc>`
        - :oe:constns:`OEGraphSim::OESimMeasure`

      * - :math:`\alpha` and :math:`\beta` for :oe:cls:`Tversky<OEGraphSim::OETverskySim>`
        - :oe:meth:`GetTverskyAlpha<OEGraphSim::OEFPDatabaseOptions::GetTverskyAlpha>` /
          :oe:meth:`GetTverskyBeta<OEGraphSim::OEFPDatabaseOptions::GetTverskyBeta>`
        - :oe:meth:`SetTverskyCoeffs<OEGraphSim::OEFPDatabaseOptions::SetTverskyCoeffs>`
        - floating point number

      * - numper of processors
        - :oe:meth:`GetNumProcessors<OEGraphSim::OEFPDatabaseOptions::GetNumProcessors>`
        - :oe:meth:`SetNumProcessors<OEGraphSim::OEFPDatabaseOptions::SetNumProcessors>`
        - integer ``0`` means :oe:func:`OEPlatform::OEGetNumProcessors`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFPDatabaseOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEFPDatabaseOptions() -> OEFPDatabaseOptions

      Default constructor.

      .. list-table::  **Default parameters of OEFPDatabaseOptions**
         :widths: 100 100
         :header-rows: 1

         * - Property
           - Default value

         * - cutoff value
           - no cutoff set

         * - order of sorting
           - true (means descending order)

         * - max number of scores
           - 0 (means no limit)

         * - similarity method
           - :oe:const:`OEGraphSim::OESimMeasure::Tanimoto`

         * - :math:`\alpha` and :math:`\beta` for :oe:cls:`Tversky<OEGraphSim::OETverskySim>`
           - :math:`\alpha = 0.95,  \beta = 0.05`

         * - number of processors
           - 1

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFPDatabaseOptions(const unsigned limit,
                                const unsigned simfunc = OESimMeasure::Tanimoto)

      .. oe:language:: python

         .. oe:api:: python

            OEFPDatabaseOptions(limit: int, simfunc: int) -> OEFPDatabaseOptions

      Constructs an :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` object with
      a limit on the number of similarity scores returned and a similarity
      method from the :oe:constns:`OEGraphSim::OESimMeasure` namespace.
      The returned scores will be in descending order and applying no
      cutoff value.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFPDatabaseOptions(const OEFPDatabaseOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEFPDatabaseOptions(arg2: OEFPDatabaseOptions) -> OEFPDatabaseOptions

      Copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFPDatabaseOptions &operator=(const OEFPDatabaseOptions &rhs)

      Assignment operator.

   .. oe:method:: ClearCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearCutoff()

      .. oe:language:: python

         .. oe:api:: python

            ClearCutoff() -> None

      Removes the cutoff value previously set by the
      :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetCutoff` method.
      After clearing the cutoff value, :oe:meth:`OEGraphSim::OEFPDatabaseOptions::HasCutoff`
      method will return ``false``.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::HasCutoff` method
         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::GetCutoff` method
         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetCutoff` method

   .. oe:method:: GetCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetCutoff() -> float

      Returns the cutoff value previously set by the
      :oe:meth:`OEGraphSim::OEFPDatabase::SetCutoff` method.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::ClearCutoff` method
         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::HasCutoff` method
         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetCutoff` method

   .. oe:method:: GetDescendingOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetDescendingOrder() const

      .. oe:language:: python

         .. oe:api:: python

            GetDescendingOrder() -> bool

      Returns whether the similarity scores will be returned in descending
      or in ascending order.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetDescendingOrder` method

   .. oe:method:: GetLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetLimit() -> int

      Returns the maximum number of similarity scores returned.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetLimit` method

   .. oe:method:: GetSimFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetSimFunc() const

      .. oe:language:: python

         .. oe:api:: python

            GetSimFunc() -> int

      Returns the similarity measure used to evaluate fingerprint
      similarities.
      The return value is taken from the :oe:constns:`OEGraphSim::OESimMeasure`
      namespace.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetSimFunc` method

   .. oe:method:: GetNumProcessors

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetNumProcessors() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumProcessors() -> int

      Returns the number of threads that are used to search
      fingerprints when calling the
      :oe:meth:`OEGraphSim::OEFastFPDatabase::SortedSearch` method.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetNumProcessors` method

   .. oe:method:: GetTverskyAlpha

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTverskyAlpha() const

      .. oe:language:: python

         .. oe:api:: python

            GetTverskyAlpha() -> float

      Returns the :math:`\alpha` parameter of the
      :oe:cls:`Tversky<OEGraphSim::OETverskySim>` similarity.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetTverskyCoeffs` method
         * :ref:`OETverskySim <OEGraphSim_OETverskySim>` class

   .. oe:method:: GetTverskyBeta

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTverskyBeta() const

      .. oe:language:: python

         .. oe:api:: python

            GetTverskyBeta() -> float

      Returns the :math:`\beta` parameter of the
      :oe:cls:`Tversky<OEGraphSim::OETverskySim>` similarity.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetTverskyCoeffs` method
         * :ref:`OETverskySim <OEGraphSim_OETverskySim>` class

   .. oe:method:: HasCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            HasCutoff() -> bool

      Returns whether the cutoff value of the :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>`
      object has been set by the :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetCutoff` method.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::ClearCutoff` method
         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::GetCutoff` method
         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetCutoff` method

   .. oe:method:: SetCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCutoff(const float cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetCutoff(cutoff: float) -> None

      Sets the cutoff value of the :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>`
      object.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::ClearCutoff` method
         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::GetCutoff` method
         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::HasCutoff` method

   .. oe:method:: SetDescendingOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDescendingOrder(const bool descending = true)

      .. oe:language:: python

         .. oe:api:: python

            SetDescendingOrder(descending: bool = True) -> None

      Sets whether the similarity scores will be returned in descending
      or in ascending order.

      .. note::

         This method has no effect on the
         :oe:meth:`OEGraphSim::OEFPDatabase::GetScores` method.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::GetDescendingOrder` method

   .. oe:method:: SetLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLimit(const unsigned limit)

      .. oe:language:: python

         .. oe:api:: python

            SetLimit(limit: int) -> None

      Sets the maximum number of similarity scores returned.

      **limit**
         If it is set to zero, then all similarity scores are returned.

      .. note::

         This method has no effect on the
         :oe:meth:`OEGraphSim::OEFPDatabase::GetScores` method.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::GetLimit` method

   .. oe:method:: SetSimFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSimFunc(const unsigned simtype)

      .. oe:language:: python

         .. oe:api:: python

            SetSimFunc(simfunc: int) -> None

      Sets the similarity measure used to evaluate fingerprint
      similarities.

      **simtype**
         This value has to be from the :oe:constns:`OEGraphSim::OESimMeasure`
         namespace.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::GetSimFunc` method

   .. oe:method:: SetNumProcessors

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNumProcessors(const unsigned nrps)

      .. oe:language:: python

         .. oe:api:: python

            SetNumProcessors(nrps: int) -> None

      Sets the number of threads that are used to search
      fingerprints when calling the
      :oe:meth:`OEGraphSim::OEFastFPDatabase::SortedSearch` method.
      When set to ``0``, the number of processors used will be the number
      returned by the :oe:func:`OEPlatform::OEGetNumProcessors` function.

      Multi-threaded fingerprint search is currently only available in
      :oe:const:`OEGraphSim::OEFastFPDatabaseMemoryType::MemoryMapped` and
      :oe:const:`OEGraphSim::OEFastFPDatabaseMemoryType::InMemory` modes.

   .. oe:method:: SetTverskyCoeffs

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTverskyCoeffs(const float alpha = 0.95f,
                                  const float beta = 0.05f)

      .. oe:language:: python

         .. oe:api:: python

            SetTverskyCoeffs(alpha: float = 0.95, beta: float = 0.05) -> None

      Sets :math:`\alpha` and :math:`\beta` parameters for the
      :oe:cls:`Tversky<OEGraphSim::OETverskySim>` similarity.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::GetTverskyAlpha` method
         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::GetTverskyBeta` method
         * :ref:`OETverskySim <OEGraphSim_OETverskySim>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEFPHistogram, FPHistogram

.. _OEGraphSim_OEFPHistogram:

.. oe:class:: OEFPHistogram

   .. oe:api::

      class OEFPHistogram

   The :ref:`OEFPHistogram <OEGraphSim_OEFPHistogram>` class is used to hold a histogram
   of similarity scores.

   This class is an efficient way to obtain statistics on large
   databases which would be unfeasible to keep as full NxN similarity matrices.

   The following classes derive from this class:
    * :ref:`OEFPVariogram <OEGraphSim_OEFPVariogram>`

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetHistogram` method

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFPHistogram(const size_t numBins = 200u, const double min = 0.0,
                          const double max = 1.0);
            OEFPHistogram(const OEFPHistogram&)

      .. oe:language:: python

         .. oe:api:: python

            OEFPHistogram(numBins: int = 200, min: float = 0.0,
                          max: float = 1.0) -> OEFPHistogram
            OEFPHistogram(arg2: OEFPHistogram) -> OEFPHistogram

      Creates an :ref:`OEFPHistogram <OEGraphSim_OEFPHistogram>` object with given number of
      bins and range.

      **nrbins**
        Number of bins in the histogram. (default=200)

      **min**
        Minimum bound (inclusive) of the histogram range. (default = 0.0)

      **max**
        Maximum bound (inclusive) of the histogram range. (default = 1.0)

      .. note::

         The default range of [0,1] covers all built-in similarity measures.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFPHistogram & operator=(const OEFPHistogram &)

      Assignment operator.

   .. oe:method:: AddSample

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t AddSample(const float sample)
            size_t AddSample(const double sample)

      .. oe:language:: python

         .. oe:api:: python

            AddSample(sample: float) -> int

      Adds the sample into the histogram by incrementing the count in the
      relevant bin. Returns the bin index that the sample went into.

   .. oe:method:: GetBinBoundaries

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<double>* GetBinBoundaries() const

      .. oe:language:: python

         .. oe:api:: python

            GetBinBoundaries() -> Iterable[float]

      Returns an iterator over the boundaries for each bin.

      .. note::

         The number of elements in this iterator is equal to
         :oe:meth:`OEGraphSim::OEFPHistogram::NumBins` **+1**.

   .. oe:method:: GetBinCenters

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<double>* GetBinCenters() const

      .. oe:language:: python

         .. oe:api:: python

            GetBinCenters() -> Iterable[float]

      Returns an iterator over the center value for each bin.

      .. note::

         The number of elements in this iterator is equal to
         :oe:meth:`OEGraphSim::OEFPHistogram::NumBins`.

      .. hint::

         It is generally reasonable to plot the results of
         :oe:meth:`OEGraphSim::OEFPHistogram::GetCounts` or
         :oe:meth:`OEGraphSim::OEFPHistogram::GetDensity` against the bin centers
         returned by this method.

   .. oe:method:: GetBinIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t GetBinIdx(const float sample) const
            size_t GetBinIdx(const double sample) const

      .. oe:language:: python

         .. oe:api:: python

            GetBinIdx(sample: float) -> int

      Returns the bin index that the sample would go into without actually
      adding the sample into the bin.

   .. oe:method:: GetBinWidth

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBinWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetBinWidth() -> float

      Returns the width of bins in the histogram.

   .. oe:method:: GetCounts

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<unsigned int>* GetCounts() const

      .. oe:language:: python

         .. oe:api:: python

            GetCounts() -> Iterable[int]

      Returns an iterator over the bin counts.

      .. note::

         Even though counts are returned as unsigned integers, they are internally
         kept as size_t. If the counts are overflowing the unsigned int type of
         the system, it may be more appropriate to use the normalized
         :oe:meth:`OEGraphSim::OEFPHistogram::GetDensity` instead.

   .. oe:method:: GetDensity

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<double>* GetDensity() const

      .. oe:language:: python

         .. oe:api:: python

            GetDensity() -> Iterable[float]

      Returns an iterator over the probability density for each bin.

      .. note::

         Result is equivalent to :oe:meth:`OEGraphSim::OEFPHistogram::GetCounts`
         normalized by :oe:meth:`OEGraphSim::OEFPHistogram::NumSamples`.

   .. oe:method:: GetMax

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetMax() -> float

      Returns upper bound (inclusive) of the histogram range.

   .. oe:method:: GetMin

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMin() const

      .. oe:language:: python

         .. oe:api:: python

            GetMin() -> float

      Returns lower bound (inclusive) of the histogram range.

   .. oe:method:: Mean

      .. oe:language:: c++ java csharp

         .. oe:api::

            double Mean()

      .. oe:language:: python

         .. oe:api:: python

            Mean() -> float

      Approximates and returns the sample mean over the histogram.

      .. note::

         This approximation is affected by number of bins in the histogram.

   .. oe:method:: NumBins

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t NumBins() const

      .. oe:language:: python

         .. oe:api:: python

            NumBins() -> int

      Returns the number of bins in the histogram.

   .. oe:method:: NumSamples

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t NumSamples() const

      .. oe:language:: python

         .. oe:api:: python

            NumSamples() -> int

      Returns the total number of samples in the histogram.

   .. oe:method:: Std

      .. oe:language:: c++ java csharp

         .. oe:api::

            double Std()

      .. oe:language:: python

         .. oe:api:: python

            Std() -> float

      Approximates and returns the sample standard deviation over the histogram.

      .. note::

         This approximation is affected by number of bins in the histogram.


.. oe:namespace:: OEGraphSim

.. _OEGraphSim_OEFPPattern:

.. oe:class:: OEFPPattern

   .. oe:api::

      class OEFPPattern : public OEChem::OEAtomBondSet

   A container that stores patterns that are enumerated when fingerprints such as
   :oe:const:`OEGraphSim::OEFPType::Path`, :oe:const:`OEGraphSim::OEFPType::Circular`
   and :oe:const:`OEGraphSim::OEFPType::Tree` are generated.

   .. seealso::

      * :ref:`chapter_patterns` chapter
      * :oe:func:`OEGraphSim::OEGetFPPatterns` function

   The following methods are publicly inherited from :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`:

   ======================================================================== ======================================================================== ======================================================================== 
   :oe:meth:`operator=<OEChem::OEAtomBondSet::operator=>`                   :oe:meth:`ClearBonds<OEChem::OEAtomBondSet::ClearBonds>`                 :oe:meth:`Remove<OEChem::OEAtomBondSet::Remove>`
   :oe:meth:`Add<OEChem::OEAtomBondSet::Add>`                               :oe:meth:`CreateCopy<OEChem::OEAtomBondSet::CreateCopy>`                 :oe:meth:`RemoveAtom<OEChem::OEAtomBondSet::RemoveAtom>`
   :oe:meth:`AddAtom<OEChem::OEAtomBondSet::AddAtom>`                       :oe:meth:`GetAtoms<OEChem::OEAtomBondSet::GetAtoms>`                     :oe:meth:`RemoveAtoms<OEChem::OEAtomBondSet::RemoveAtoms>`
   :oe:meth:`AddAtoms<OEChem::OEAtomBondSet::AddAtoms>`                     :oe:meth:`GetBonds<OEChem::OEAtomBondSet::GetBonds>`                     :oe:meth:`RemoveBond<OEChem::OEAtomBondSet::RemoveBond>`
   :oe:meth:`AddBond<OEChem::OEAtomBondSet::AddBond>`                       :oe:meth:`HasAtom<OEChem::OEAtomBondSet::HasAtom>`                       :oe:meth:`RemoveBonds<OEChem::OEAtomBondSet::RemoveBonds>`
   :oe:meth:`AddBonds<OEChem::OEAtomBondSet::AddBonds>`                     :oe:meth:`HasBond<OEChem::OEAtomBondSet::HasBond>`                       :oe:meth:`Sweep<OEChem::OEAtomBondSet::Sweep>`
   :oe:meth:`Clear<OEChem::OEAtomBondSet::Clear>`                           :oe:meth:`IsEmpty<OEChem::OEAtomBondSet::IsEmpty>`                       :oe:meth:`Translate<OEChem::OEAtomBondSet::Translate>`
   :oe:meth:`ClearAtoms<OEChem::OEAtomBondSet::ClearAtoms>`                 :oe:meth:`NumAtoms<OEChem::OEAtomBondSet::NumAtoms>`
   :oe:meth:`ClearAtomsAndBonds<OEChem::OEAtomBondSet::ClearAtomsAndBonds>` :oe:meth:`NumBonds<OEChem::OEAtomBondSet::NumBonds>`
   ======================================================================== ======================================================================== ======================================================================== 
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFPPattern(OESystem::OEIter<OEChem::OEAtomBase>& atoms,
                        OESystem::OEIter<OEChem::OEBondBase>& bonds,
                        const std::string& smarts, unsigned int unhashed,
                        unsigned int setbit)

      .. oe:language:: python

         .. oe:api:: python

            OEFPPattern(atoms: OEAtomIter, bonds: OEBondIter, smarts: str,
                        unhashed: int, setbit: int) -> OEFPPattern

      Constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFPPattern &operator=(const OEFPPattern &rhs)

      Assignment operator.

   .. oe:method:: GetBit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetBit() const

      .. oe:language:: python

         .. oe:api:: python

            GetBit() -> int

      Returns the bit that is set when the given pattern is hashed into fixed-length
      bitvector.

   .. oe:method:: GetSmarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetSmarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetSmarts() -> str

      Returns the smarts representation of the given pattern.

   .. oe:method:: GetUnhashed

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetUnhashed() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnhashed() -> int

      Returns the unhashed unique integer representation of the given pattern.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEFPTypeBase, FPTypeBase

.. _OEGraphSim_OEFPTypeBase:

.. oe:class:: OEFPTypeBase

   .. oe:api::

      class OEFPTypeBase

   The :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class is the abstract
   interface for representing :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`
   types.

   .. note::

      When a :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object is initialized,
      its type is set to a type that is derived from this abstract
      base class.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:api::

         OEFPTypeBase(unsigned short v)

      Default constructor.

   .. ###############################################################################
      # OEFPTypeBase::GetFPType
      ###############################################################################

   .. oe:method:: GetFPType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFPType() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetFPType() -> int

      Returns the type of the :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` object
      from  the :oe:constns:`OEGraphSim::OEFPType` namespace.

   .. ###############################################################################
      # OEFPTypeBase::GetFPTypeString
      ###############################################################################

   .. oe:method:: GetFPTypeString

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetFPTypeString() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetFPTypeString() -> str

      Returns a string representation of
      :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`.
      This string representation encodes information about the
      fingerprinting method and the parameters being used to generate
      the fingerprint.

      .. note::

         The string returned by the :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPTypeString`
         method does not include new line characters. The strings presented here
         were broken into separate lines only for better readability.

      The string representation of the default
      :oe:const:`OEGraphSim::OEFPType::Circular` fingerprint is the
      following:

      ::

        Circular,ver=2.0.0,size=4096,radius=0-5,atype=AtmNum|Arom|Chiral|FCharge|HCount|EqHalo,
        btype=Order

      The string representation of the default
      :oe:const:`OEGraphSim::OEFPType::Lingo` fingerprint is the
      following:

      ::

        Lingo,ver=2.0.0

      The string representation of the default
      :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint is the
      following:

      ::

        MACCS166,ver=2.0.0

      The string representation of the default
      :oe:const:`OEGraphSim::OEFPType::Path` fingerprint is the
      following:

      ::

        Path,ver=2.0.0,size=4096,bonds=0-5,atype=AtmNum|Arom|Chiral|FCharge|HvyDeg|Hyb|EqHalo,
        btype=Order|Chiral

      The string representation of the default
      :oe:const:`OEGraphSim::OEFPType::Tree` fingerprint is the
      following:

      ::

        Tree,ver=2.0.0,size=4096,bonds=0-4,atype=AtmNum|Arom|Chiral|FCharge|HvyDeg|Hyb,
        btype=Order

      .. seealso::

         * :ref:`OEFPTypeParams <OEGraphSim_OEFPTypeParams>` class

   .. ###############################################################################
      # OEFPTypeBase::GetFPVersion
      ###############################################################################

   .. oe:method:: GetFPVersion

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned short GetFPVersion() const

      .. oe:language:: python

         .. oe:api:: python

            GetFPVersion() -> short

      Returns the version number of the fingerprint.

   .. ###############################################################################
      # OEFPTypeBase::GetFPVersion
      ###############################################################################

   .. oe:method:: GetFPVersionString

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetFPVersionString() const

      .. oe:language:: python

         .. oe:api:: python

            GetFPVersionString() -> str

      Returns the string format of the version of the fingerprint.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEFPTypeParams, FPTypeParams

.. _OEGraphSim_OEFPTypeParams:

.. oe:class:: OEFPTypeParams

   .. oe:api::

      class OEFPTypeParams

   This class represents :ref:`OEFPTypeParams <OEGraphSim_OEFPTypeParams>`.

   .. seealso::

      * :ref:`section_fptype_parameters` section

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFPTypeParams(const std::string& typestr)

      .. oe:language:: python

         .. oe:api:: python

            OEFPTypeParams(typestr: str) -> OEFPTypeParams

      Constructor that parses the given string as a
      representation of a fingerprint and extracts the parameters that
      are used to generate the fingerprint.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPTypeString` method

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFPTypeParams(const OEFPTypeBase* fptype)

      .. oe:language:: python

         .. oe:api:: python

            OEFPTypeParams(fptype: OEFPTypeBase) -> OEFPTypeParams

      Constructor that extracts the parameters that
      are used to generate the fingerprint type.

      .. seealso::

         * :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFPTypeParams & operator=(const OEFPTypeParams & rhs)

      Assignment operator.

   .. oe:method:: GetAtomTypes

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetAtomTypes() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomTypes() -> int

      Returns

      * the atom types extracted from the string for
        :oe:const:`OEGraphSim::OEFPType::Path`,
        :oe:const:`OEGraphSim::OEFPType::Circular` and
        :oe:const:`OEGraphSim::OEFPType::Tree` fingerprint types
      * zero for :oe:const:`OEGraphSim::OEFPType::Lingo` and
        :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint types

      The return value is taken from the :oe:constns:`OEGraphSim::OEFPAtomType`
      namespace.

      .. seealso::

         * :oe:func:`OEGraphSim::OEGetFPAtomType` function

   .. oe:method:: GetBondTypes

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetBondTypes() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondTypes() -> int

      Returns

      * the bond types extracted from the string for
        :oe:const:`OEGraphSim::OEFPType::Path`,
        :oe:const:`OEGraphSim::OEFPType::Circular` and
        :oe:const:`OEGraphSim::OEFPType::Tree` fingerprint types
      * zero for :oe:const:`OEGraphSim::OEFPType::Lingo` and
        :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint types

      The return value is taken from the :oe:constns:`OEGraphSim::OEFPBondType`
      namespace.

      .. seealso::

         * :oe:func:`OEGraphSim::OEGetFPBondType` function

   .. oe:method:: GetFPType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFPType() const

      .. oe:language:: python

         .. oe:api:: python

            GetFPType() -> int

      Returns the fingerprint type extracted from the string.
      The return value is taken from the :oe:constns:`OEGraphSim::OEFPType`
      namespace.

   .. oe:method:: GetMaxDistance

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxDistance() -> int

      Returns:

      * the size of the largest path fragments (in bonds),
        if the fingerprint type is :oe:const:`OEGraphSim::OEFPType::Path`
      * the size of the largest circular fragments (in radius),
        if the fingerprint type is :oe:const:`OEGraphSim::OEFPType::Circular`
      * the size of the largest tree fragments (in bonds),
        if the fingerprint type is :oe:const:`OEGraphSim::OEFPType::Tree`
      * zero for :oe:const:`OEGraphSim::OEFPType::Lingo` and
        :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint types

   .. oe:method:: GetMinDistance

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMinDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinDistance() -> int

      Returns:

      * the size of the smallest path fragments (in bonds),
        if the fingerprint type is :oe:const:`OEGraphSim::OEFPType::Path`
      * the size of the smallest circular fragments (in radius),
        if the fingerprint type is :oe:const:`OEGraphSim::OEFPType::Circular`
      * the size of the smallest tree fragments (in bonds),
        if the fingerprint type is :oe:const:`OEGraphSim::OEFPType::Tree`
      * zero for :oe:const:`OEGraphSim::OEFPType::Lingo` and
        :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint types

   .. oe:method:: GetNumBits

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumBits() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumBits() -> int

      Returns:

      * the size of the fingerprint in bits for
        :oe:const:`OEGraphSim::OEFPType::Path`,
        :oe:const:`OEGraphSim::OEFPType::Circular` and
        :oe:const:`OEGraphSim::OEFPType::Tree` fingerprint types
      * 166 for :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint type
      * zero for :oe:const:`OEGraphSim::OEFPType::Lingo` fingerprint type

   .. oe:method:: GetVersion

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned short GetVersion() const

      .. oe:language:: python

         .. oe:api:: python

            GetVersion() -> short

      Returns the version number.

      .. seealso::

         * :oe:func:`OEGraphSim::OEGetFingerPrintVersionString` function

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the string was valid from which the
      :ref:`OEFPTypeParams <OEGraphSim_OEFPTypeParams>` object was initialized.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEFPVariogram, FPVariogram

.. _OEGraphSim_OEFPVariogram:

.. oe:class:: OEFPVariogram

   .. oe:api::

      class OEFPVariogram : public OEFPHistogram

   :ref:`OEFPVariogram <OEGraphSim_OEFPVariogram>` class is used to generate a
   variogram of similarity scores and related empirical measurements.
   An :ref:`OEFPVariogram <OEGraphSim_OEFPVariogram>` object is a
   :ref:`OEFPHistogram <OEGraphSim_OEFPHistogram>` with additional variogram data
   regarding user provided measurements.

   The empirical variogram has the form :

   :math:`\hat{\gamma}(h)=\frac{1}{2|N(h)|}\sum\limits_{(i,j)\in N(h)} |z_i-z_j|^2`

   Where :math:`N(h)` is the set of pairs that have a **distance** close to :math:`h`
   and :math:`z_i` is the measurement provided for the :math:`i` th molecule.

   For all of our built-in similarity measures, except for Tversky, distance is
   calculated a :math:`1-similarity`. It is not possible to calculate an empirical
   variogram using Tversky similarity.

   The **measurement** in the context of a variogram can be any user provided
   value per fingerprint e.g. bioassay data or calculated properties.

   The following methods are publicly inherited from :ref:`OEFPHistogram <OEGraphSim_OEFPHistogram>`:

   ======================================================================== ======================================================================== ========================================================================
   :oe:meth:`AddSample<OEGraphSim::OEFPHistogram::AddSample>`               :oe:meth:`GetCounts<OEGraphSim::OEFPHistogram::GetCounts>`               :oe:meth:`NumBins<OEGraphSim::OEFPHistogram::NumBins>`
   :oe:meth:`GetBinBoundaries<OEGraphSim::OEFPHistogram::GetBinBoundaries>` :oe:meth:`GetDensity<OEGraphSim::OEFPHistogram::GetDensity>`             :oe:meth:`NumSamples<OEGraphSim::OEFPHistogram::NumSamples>`
   :oe:meth:`GetBinCenters<OEGraphSim::OEFPHistogram::GetBinCenters>`       :oe:meth:`GetMax<OEGraphSim::OEFPHistogram::GetMax>`                     :oe:meth:`Std<OEGraphSim::OEFPHistogram::Std>`
   :oe:meth:`GetBinIdx<OEGraphSim::OEFPHistogram::GetBinIdx>`               :oe:meth:`GetMin<OEGraphSim::OEFPHistogram::GetMin>`
   :oe:meth:`GetBinWidth<OEGraphSim::OEFPHistogram::GetBinWidth>`           :oe:meth:`Mean<OEGraphSim::OEFPHistogram::Mean>`
   ======================================================================== ======================================================================== ========================================================================

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetVariogram` method

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFPVariogram(size_t numBins = 200, double min = 0, double max = 1)
            OEFPVariogram(const OEFPVariogram&)

      .. oe:language:: python

         .. oe:api:: python

            OEFPVariogram(numBins: int = 200, min: float = 0.0,
                          max: float = 1.0) -> OEFPVariogram
            OEFPVariogram(arg2: OEFPVariogram) -> OEFPVariogram

      Creates an :ref:`OEFPVariogram <OEGraphSim_OEFPVariogram>` object with the
      given number of bins and similarity range.

      **numBins**
        Number of bins in the histogram. (default = 200)

      **min**
        Minimum bound (inclusive) of the similarity range. (default = 0.0)

      **max**
        Maximum bound (inclusive) of the similarity range. (default = 1.0)

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFPVariogram & operator=(const OEFPVariogram &)

      Assignment operator.

   .. oe:method:: AddSample

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t AddSample(const float sim, const float obs)

      .. oe:language:: python

         .. oe:api:: python

            AddSample(sim: float, obs: float) -> int

      Adds a sample representing a pair of molecules into the variogram

      **sim**
        Similarity between fingerprints i and j

      **obs**
        Measured difference between the relevant fingerprints :math:`z_i-z_j`

      .. note::

         Since we are dealing with :math:`|z_i-z_j|^2` this relationship is
         actually symmetrical.

   .. oe:method:: GetVariogram

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<double>* GetVariogram() const

      .. oe:language:: python

         .. oe:api:: python

            GetVariogram() -> Iterable[float]

      Returns an iterator over the empirical variogram.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEGraphSim

.. _OEGraphSim_OEFastFPDatabase:

.. oe:class:: OEFastFPDatabase

   .. oe:api::

      class OEFastFPDatabase

   The :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class is designed to perform
   rapid CUDA-accelerated, in-memory or memory-mapped fingerprint searches
   using the :term:`popcount` method.
   Each :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object is associated with a
   fingerprint type (:ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`) that is
   set when the database is initialized from a pre-generated binary
   fingerprint file.

   For CUDA-accelerated fingerprint searching please see the :ref:`prerequisites for OpenEye's GPU-accelerated software <graphsim_prereq_for_gpu>`.

   .. note::

      **GraphSim TK** currently only supports the :term:`popcount` search
      method for fingerprints with the size of multiple of ``256``.
      This means that the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class
      currently does not support:

      * :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint type
      * :oe:const:`OEGraphSim::OEFPType::Lingo` fingerprint type
      * other custom fingerprint types (see :ref:`chapter_user_defined` section)
        with size that is not a multiple of ``256``

      For the fingerprint types listed above, the original
      :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` class can be utilized.

   .. note::

      :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` gives identical results
      to :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>`.
      However, :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` calculates similarity
      scores in single precision (float) while
      :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` uses double precision.
      As a result, small similarity score differences can be observed.

   .. seealso::

      * :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` class

   .. admonition:: Code Example

      * Example code in the :ref:`section_examples_summary_makefastfp` section
      * Example code in the :ref:`section_examples_summary_searchfastfp` section

      * `Rapid Similarity Searching of Large Molecule File`_ **OpenEye Python Cookbook** recipe
      * `Depicting Molecule Similarity Based on Fingerprints`_ **OpenEye Python Cookbook** recipe

   .. figure:: graphsimtk/images/searchfastfp.*
      :align:  center
      :width:  400pt

      **Schematic representation of fast fingerprint search process**

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFastFPDatabase(const std::string& dbfile,
                             unsigned int memtype = OEFastFPDatabaseMemoryType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEFastFPDatabase(dbfile: str, memtype: int) -> OEFastFPDatabase

      Constructs an :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object.

      dbfile
        The name of the file which contains the fingerprint data.
        The file has to be generated with the
        :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function.

      memtype
        Defines whether the fingerprints are pre-loaded into GPU-memory,
        CPU-memory, or memory-mapped during the search process.
        This value has to be from the
        :oe:constns:`OEGraphSim::OEFastFPDatabaseMemoryType` namespace.

      .. note::

         If the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object can not be initialized
         with the :oe:const:`OEGraphSim::OEFastFPDatabaseMemoryType::CUDA` option,
         the following warning message will be throw:

         ::

            Warning: OEFastFPDatabase::OEFastFPDatabase() : no CUDA-enabled
            device available falling back to memory-mapped type!

         As a rule of thumb, 1 million finger prints requires 0.6GB of GPU memory.
         GPU memory can be queried using the ``nvidia-smi`` command from terminal.

      .. seealso::

         * :oe:constns:`OEGraphSim::OEFastFPDatabaseMemoryType` namespace.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetAllScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<float>* GetAllScores(const OEFPDatabaseOptions& opts) const

      .. oe:language:: python

         .. oe:api:: python

            GetAllScores(opts: OEFPDatabaseOptions) -> Iterable[float]

      Performs :math:`NxN` similarity calculations between all pairs of fingerprints
      stored in the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object.
      It returns an iterator over the calculated similarity scores.
      The scores are not sorted, but returned as a flattened square matrix.

      For all similarity measures other than :ref:`section_measure_tversky`,
      the returned 'matrix' will be symmetrical.

      opts
        The :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` object controls all the parameters
        that determine the search (i.e. similarity measure parameters).
        Cutoff and order parameters are ignored as the results are not filtered or sorted.

      .. note::

         This operation scales with :math:`n^2` in memory and can easily overwhelm
         the system memory for larger databases.
         Therefore, the :oe:meth:`OEGraphSim::OEFastFPDatabase::GetRawScores` method
         returns a single row of the similarity matrix and is the recommended usage
         for querying large databases.

      .. seealso::

         * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetFingerPrint

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFingerPrint(OEFingerPrint& fp, size_t idx) const

      .. oe:language:: python

         .. oe:api:: python

            GetFingerPrint(fp: OEFingerPrint, fpidx: int) -> bool

      Returns the :math:`idx^{th}` fingerprint of the database.

      .. warning::

         This function returns ``false`` if the fingerprint index is
         not identical to the corresponding molecule index.
         This can occur if the fingerprint binary file is generated in
         multi-thread process.
         If direct access to the fingerprint is required when using
         the :oe:meth:`OEGraphSim::OEFastFPDatabase::GetFingerPrint`
         method, the fingerprint file should be generated in a
         single-threaded mode.
         This can be done by setting
         :oe:meth:`SetNumProcessors(1) <OEGraphSim::OECreateFastFPDatabaseOptions::GetNumProcessors>`
         for the option class used for creating the binary file.

      .. seealso::

         * :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` class
         * :oe:meth:`OEGraphSim::OECreateFastFPDatabaseOptions::GetNumProcessors` method
         * :oe:meth:`OEGraphSim::OECreateFastFPDatabaseOptions::SetNumProcessors` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetFPTypeBase

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFPTypeBase* GetFPTypeBase() const

      .. oe:language:: python

         .. oe:api:: python

            GetFPTypeBase() -> OEFPTypeBase

      Returns the fingerprint type of the
      :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object.
      An :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object can only store
      fingerprints with identical types.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetHistogram

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFPHistogram GetHistogram(const OEFPDatabaseOptions& opts,
                                       const size_t nrbins = 200u) const

      .. oe:language:: python

         .. oe:api:: python

            GetHistogram(opts: OEFPDatabaseOptions, nrbins: int = 200) -> OEFPHistogram

      Performs similarity calculations between all pairs of fingerprints
      stored in the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object.
      It returns the histogram over the calculated similarity scores in a
      :ref:`OEFPHistogram <OEGraphSim_OEFPHistogram>` object.

      opts
        The :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` object contains the
        settings available to control the search (i.e. similarity measure,
        :math:`\alpha` and :math:`\beta` parameters for :ref:`section_measure_tversky`
        similarity).
        Cutoff and order parameters are ignored as the results are not filtered or sorted.

      nrbins
        Number of bins in the returned :ref:`OEFPHistogram <OEGraphSim_OEFPHistogram>` object.

      .. note::

         For all similarity measures other than :ref:`section_measure_tversky`,
         the histogram only contains the upper-triangular similarity scores
         (excluding the diagonal).
         In case of the asymmetric :ref:`section_measure_tversky` similarity measure,
         the histogram of the whole :math:`NxN` matrix is returned.

      .. note::

         When the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object is initialized
         with :oe:constns:`OEGraphSim::OEFastFPDatabaseMemoryType::CUDA`,
         ``nrbins`` is limited to at most 1024.

      .. hint::

         This method calculates similarities identically to
         :oe:meth:`OEGraphSim::OEFastFPDatabase::GetAllScores`
         but is not bound by the system memory. It can be used to quickly obtain
         statistics on larger databases.

      .. seealso::

         * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class
         * :ref:`OEFPHistogram <OEGraphSim_OEFPHistogram>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetMemoryType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMemoryType() const

      .. oe:language:: python

         .. oe:api:: python

            GetMemoryType() -> int

      Returns the memory type of the fingerprint database.
      The return value is taken from the :oe:constns:`OEGraphSim::OEFastFPDatabaseMemoryType`
      namespace.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetMemoryTypeString` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetMemoryTypeString

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetMemoryTypeString() const

      .. oe:language:: python

         .. oe:api:: python

            GetMemoryTypeString() -> str

      Returns the string representation if memory type of the fingerprint database.

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetMemoryType` method

   .. oe:method:: GetMoleculeIndex

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t GetMoleculeIndex(const size_t fpidx) const

      .. oe:language:: python

         .. oe:api:: python

            GetMoleculeIndex(fpidx: int) -> int

      Returns the molecule index that corresponds to the fingerprint index.

      .. note::

         When building fingerprint databases using
         :ref:`OECreateFastFPDatabaseOptions <OEGraphSim_OECreateFastFPDatabaseOptions>`, the molecule
         index is always the same as the fingerprint index. However, there
         are private database building APIs that allow to specify the molecule
         index associated with each fingerprint.
         This :oe:meth:`OEGraphSim::OEFastFPDatabase::GetMoleculeIndex`
         method allows to handle these private databases.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetRawScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<double>* GetRawScores(const size_t fpidx,
                                                       const OEFPDatabaseOptions& opts) const
            OESystem::OEIterBase<double>* GetRawScores(const OEFingerPrint& fp,
                                                       const OEFPDatabaseOptions& opts) const
            OESystem::OEIterBase<double>* GetRawScores(const OEChem::OEMolBase& mol,
                                                       const OEFPDatabaseOptions& opts) const

      .. oe:language:: python

         .. oe:api:: python

            GetRawScores(fpidx: int, opts: OEFPDatabaseOptions) -> Iterable[float]
            GetRawScores(fp: OEFingerPrint, opts: OEFPDatabaseOptions) -> Iterable[double]
            GetRawScores(mol: Union[OEGraphMol,OEMol,OEQMol],
                         opts: OEFPDatabaseOptions) -> Iterable[double]

      Performs similarity calculations between a molecule or a fingerprint and the
      fingerprints stored in the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object.
      It returns an iterator over the calculated similarity scores.
      The scores are not sorted, but returned in the same order as the database.
      The number of elements in the returned iterator is equal to the number
      of fingerprints in the database.

      fpidx
        If the method is called with an integer index, the query fingerprint is
        taken from the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object with the given index.

      mol
        If the method is called with an :ref:`OEMolBase <OEChem_OEMolBase>` object, a fingerprint
        is generated from this molecule before looping over the fingerprints of the
        database and calculating similarities.

      fp
        If the method is called with an :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object,
        its type has to match the type of the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>`.

      opts
        The :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` object contains the settings
        available to control the search (i.e. similarity measure parameters).
        Cutoff and order parameters are ignored as the results are not filtered or sorted.

      .. seealso::

         * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class
         * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetAllScores` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESimScore>* GetScores(const size_t idx,
                                                        const OEFPDatabaseOptions& opts) const
            OESystem::OEIterBase<OESimScore>* GetScores(const OEFingerPrint& fp,
                                                        const OEFPDatabaseOptions& opts) const
            OESystem::OEIterBase<OESimScore>* GetScores(const OEChem::OEMolBase& mol,
                                                        const OEFPDatabaseOptions& opts) const

      .. oe:language:: python

         .. oe:api:: python

            GetScores(idx: int, opts: OEFPDatabaseOptions) -> Iterable[OESimScore]
            GetScores(fp: OEFingerPrint, opts: OEFPDatabaseOptions) -> Iterable[OESimScore]
            GetScores(mol: Union[OEGraphMol,OEMol,OEQMol],
                      opts: OEFPDatabaseOptions) -> Iterable[OESimScore]

      Performs similarity calculations between a molecule or fingerprint and the
      fingerprints stored in the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object.
      It returns an iterator over the calculated similarity scores
      (:ref:`OESimScore <OEGraphSim_OESimScore>`).
      The results are filtered according to the cutoff and order parameters
      specified in ``opts``, but are not sorted.

      fpidx
        If the method is called with an integer index, the query fingerprint is
        taken from the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object with the given index.

      mol
        If the method is called with an :ref:`OEMolBase <OEChem_OEMolBase>` object, a fingerprint
        is generated from this molecule before looping over the fingerprints of the
        database and calculating similarities.

      fp
        If the method is called with an :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object,
        its type has to match the type of the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>`.

      opts
        The :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` object controls all the
        parameters that determine the search (i.e. similarity measure parameters,
        score cutoff and order).

      .. seealso::

         * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetSortedScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESimScore>* GetSortedScores(const size_t idx,
                                                              const OEFPDatabaseOptions& opts) const
            OESystem::OEIterBase<OESimScore>* GetSortedScores(const OEFingerPrint& fp,
                                                              const OEFPDatabaseOptions& opts) const
            OESystem::OEIterBase<OESimScore>* GetSortedScores(const OEChem::OEMolBase& mol,
                                                              const OEFPDatabaseOptions& opts) const

      .. oe:language:: python

         .. oe:api:: python

            GetSortedScores(idx: int, opts: OEFPDatabaseOptions) -> Iterable[OESimScore]
            GetSortedScores(fp: OEFingerPrint, opts: OEFPDatabaseOptions) -> Iterable[OESimScore]
            GetSortedScores(mol: Union[OEGraphMol,OEMol,OEQMol],
                            opts: OEFPDatabaseOptions) -> Iterable[OESimScore]

      Performs similarity calculations between a molecule or fingerprint and the
      fingerprints stored in the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object.
      It returns an iterator over the calculated similarity scores
      (:ref:`OESimScore <OEGraphSim_OESimScore>`) in sorted order.
      Each :ref:`OESimScore <OEGraphSim_OESimScore>` holds a similarity score and
      index of the corresponding fingerprint of the database.

      fpidx
        If the method is called with an integer index, the query fingerprint is
        taken from the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object with the given index.

      mol
        If the method is called with an :ref:`OEMolBase <OEChem_OEMolBase>` object, a fingerprint
        is generated from this molecule before looping over the fingerprints of the
        database and calculating similarities.

      fp
        If the method is called with an :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object,
        its type has to match the type of the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>`.

      opts
        The :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` object controls all the
        parameters that determine the search (i.e. similarity measure parameters,
        score cutoff, order and limit).

      .. seealso::

         * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetSparseMatrix

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESimScorePair>* GetSparseMatrix(const OEFPDatabaseOptions& opts) const

      .. oe:language:: python

         .. oe:api:: python

            GetSparseMatrix(opts: OEFPDatabaseOptions) -> Iterable[OESimScorePair]

      Performs :math:`NxN` similarity calculations between all pairs of fingerprints
      stored in the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object and returns either the top ``K``
      scores for each fingerprint or all scores above a cutoff for each fingerprint. The sparse
      matrix is returned as an iterator over :ref:`OESimScorePair <OEGraphSim_OESimScorePair>` objects. The
      limit of scores to return can be set using :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetLimit`
      and the cutoff of scores to return can be set using :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetCutoff`.
      If no limit is set, all scores will be returned above the cutoff value. If a limit is set, only
      :oe:meth:`OEGraphSim::OEFPDatabaseOptions::GetLimit` scores will be returned regardless of whether
      more scores fall within the cutoff range. A ``limit`` should be set for best performance.

      opts
        The :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` object controls all the parameters
        that determine the search (i.e. similarity measure parameters).

      .. hint::

         This operation scales with :math:`n^2` in memory when
         ``limit = 0`` (or when ``limit`` is not set), so it can easily overwhelm
         the system memory for larger databases. The best practice is to set a
         reasonable ``limit`` that will capture the scores of interest.

      .. seealso::

         * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class
         * :ref:`OESimScorePair <OEGraphSim_OESimScorePair>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetVariogram

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFPVariogram GetVariogram(const std::vector<float>& obsdata,
                                       const OEFPDatabaseOptions& opts,
                                       const size_t nrbins = 200u) const

      .. oe:language:: python

         .. oe:api:: python

            GetVariogram(obsdata: OEFloatVector, opts: OEFPDatabaseOptions,
                         nrbins: int = 200) -> OEFPVariogram

      Performs similarity calculations between all pairs of fingerprints
      stored in the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object.
      It returns the empirical variogram over the calculated similarity scores
      with respect to the measurements provided in the ``obsdata`` parameter in a
      :ref:`OEFPVariogram <OEGraphSim_OEFPVariogram>` object.

      obsdata
        User-provided empirical measurements for each fingerprint in the database.

      opts
        The :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` object controls all the
        parameters that determine the scoring (i.e. similarity measure parameters).
        Cutoff and order parameters are ignored as the results are not filtered or sorted.

      nrbins
        Number of bins in the returned :ref:`OEFPVariogram <OEGraphSim_OEFPVariogram>` object.

      .. note::

         The empirical variogram is defined over **distances rather than similarities**.
         It is therefore not possible to calculate a variogram using
         :ref:`section_measure_tversky` similarity.
         For all other similarity measures, empirical variogram is calculated
         using :math:`distance = 1-similarity`.

      .. hint::

         This method calculates similarities identically to
         :oe:meth:`OEGraphSim::OEFastFPDatabase::GetAllScores`
         but is not bound by the system memory. It can be used to quickly obtain
         statistics on larger databases.

      .. note::

         When the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object is initialized
         with :oe:constns:`OEGraphSim::OEFastFPDatabaseMemoryType::CUDA`,
         ``nrbins`` is limited to at most 1024.

      .. hint::

         The returned :ref:`OEFPVariogram <OEGraphSim_OEFPVariogram>` object
         also contains a histogram, but note that this histogram is over
         **distances** rather than similarities.

      .. seealso::

         * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class
         * :ref:`OEFPVariogram <OEGraphSim_OEFPVariogram>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the database was initialized correctly.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumFingerPrints

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t NumFingerPrints() const

      .. oe:language:: python

         .. oe:api:: python

            NumFingerPrints() -> int

      Returns the number of :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects
      stored in the database.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: SortedSearch

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned SortedSearch(OESimSearchResult& result,
                                  const OEChem::OEMolBase& mol,
                                  const OEFPDatabaseOptions& opts) const

      .. oe:language:: python

         .. oe:api:: python

            SortedSearch(result: OESimSearchResult,
                         mol: Union[OEGraphMol,OEMol,OEQMol],
                         opts: OEFPDatabaseOptions) -> int

      Performs **multi-threaded** similarity calculations between a molecule and the
      fingerprints stored in the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object.
      The method combines the functionality of the
      :oe:meth:`OEGraphSim::OEFastFPDatabase::GetSortedScores` and the
      :oe:meth:`OEGraphSim::OEFastFPDatabase::GetHistogram` methods.

      result
        The :ref:`OESimSearchResult <OEGraphSim_OESimSearchResult>` object that stores the result of the
        search along with the progress of the search and the histogram of all scores.

      mol
        If the method is called with an :ref:`OEMolBase <OEChem_OEMolBase>` object, a fingerprint
        is generated from this molecule before looping over the fingerprints of the
        database and calculating similarities.

      opts
        The :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` object controls all the parameters
        that determine the search (i.e. similarity measure parameters).
        The :oe:meth:`OEGraphSim::OEFastFPDatabase::SortedSearch` method can use
        multiple threads to accelerate the search process. The number of processors used
        can be controlled by the :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetNumProcessors`
        method.

      The :oe:meth:`OEGraphSim::OEFastFPDatabase::SortedSearch` method returns:

      * :oe:const:`OEGraphSim::OESimSearchStatus::Uninitialized` if the similarity
        search can not be executed
      * :oe:const:`OEGraphSim::OESimSearchStatus::Finished`, if the similarity
        search successfully finished

      .. note::

         This method is currently only available in
         :oe:const:`OEGraphSim::OEFastFPDatabaseMemoryType::MemoryMapped` and
         :oe:const:`OEGraphSim::OEFastFPDatabaseMemoryType::InMemory` modes.

      **Example:**

      .. oe:source:: SortedSearch.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET

      .. oe:source:: SortedSearch.py
         :language: python
         :noindent:
         :frag:     SNIPPET

      ..  oe:language:: python

            :ref:`Full listing. <listing-SortedSearch.py>`

      .. oe:source:: SortedSearch.java
         :language: java
         :noindent:
         :frag:     SNIPPET

      .. oe:source:: SortedSearch.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET

      The output of the code snippet above might look like this:

      .. code-block:: console

         Search status = Finished
         Number of searched = 1000
         0.950
         0.912
         0.901
         0.886
         0.859
         [0.000-0.200] = 428
         [0.200-0.400] = 312
         [0.400-0.600] = 225
         [0.600-0.800] = 25
         [0.800-1.000] = 10

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetSortedScores` method
         * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetHistogram` method
         * :oe:constns:`OEGraphSim::OESimSearchStatus` namespace


.. oe:namespace:: OEGraphSim

.. _OEGraphSim_OEFastFPDatabaseParams:

.. oe:class:: OEFastFPDatabaseParams

   .. oe:api::

      class OEFastFPDatabaseParams

   Stores parameters retrieved from a binary fingerprint database file
   generated with the :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function.

   .. seealso::

      * :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFastFPDatabaseParams(const std::string& fpdbfname)

      .. oe:language:: python

         .. oe:api:: python

            OEFastFPDatabaseParams() -> OEFastFPDatabaseParams
            OEFastFPDatabaseParams(fpdbfname: str) -> OEFastFPDatabaseParams

      Constructor that parses the header of the given fingerprint file.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetFPTypeBase

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFPTypeBase* GetFPTypeBase() const

      .. oe:language:: python

         .. oe:api:: python

            GetFPTypeBase() -> OEFPTypeBase

      Returns the type of fingerprints stored in the file.

      .. seealso::

         :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method: GetFileSize DO NOT DOCUMENT

      .. oe:api::

         size_t GetFileSize() const

   .. oe:method: GetFingerPrintSizeIn32 DO NOT DOCUMENT

      .. oe:api::

         size_t GetFingerPrintSizeIn32() const

   .. oe:method: GetFingerPrintSizeIn64 DO NOT DOCUMENT

      .. oe:api::

         size_t GetFingerPrintSizeIn64() const

   .. oe:method: GetFingerPrintSizeInBits DO NOT DOCUMENT

      .. oe:api::

         size_t GetFingerPrintSizeInBits() const

   .. oe:method: GetFingerPrintSizeInBytes DO NOT DOCUMENT

      .. oe:api::

         size_t GetFingerPrintSizeInBytes() const

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetMolDatabaseFilename

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetMolDatabaseFilename() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolDatabaseFilename() -> str

      Returns the name of the molecule file from which the fingerprint
      file has been generated.

   .. ################################################################
      #
      ################################################################

   .. oe:method: IsInLittleEndian DO NOT DOCUMENT

      .. oe:api::

         bool IsInLittleEndian() const

   .. ################################################################
      #
      ################################################################

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the header of the fingerprint file can be
      successfully parsed.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NumFingerPrints

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t NumFingerPrints() const

      .. oe:language:: python

         .. oe:api:: python

            NumFingerPrints() -> int

      Returns the number of fingerprints stored in the fingerprint
      file.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEFingerPrint, FingerPrint

.. _OEGraphSim_OEFingerPrint:

.. oe:class:: OEFingerPrint

   .. oe:api::

      class OEFingerPrint : public OESystem::OEBitVector

   :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` class is used to encode
   molecular properties.
   An :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object is a *typed* bitvector
   (:ref:`OEBitVector <OESystem_OEBitVector>`).
   The type of an :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object is set
   when it is initialized.

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFingerPrint::GetFPTypeBase`
      * :oe:meth:`OEGraphSim::OEFingerPrint::SetFPTypeBase`

   The following methods are publicly inherited from :ref:`OEBitVector <OESystem_OEBitVector>`:

   ============================================================= ============================================================== =============================================================
   :oe:meth:`operator\<<OESystem::OEBitVector::operator<>`       :oe:meth:`FirstBit<OESystem::OEBitVector::FirstBit>`           :oe:meth:`PrevBit<OESystem::OEBitVector::PrevBit>`           
   :oe:meth:`operator=<OESystem::OEBitVector::operator=>`        :oe:meth:`FromHexString<OESystem::OEBitVector::FromHexString>` :oe:meth:`SetBitOff<OESystem::OEBitVector::SetBitOff>`       
   :oe:meth:`operator-=<OESystem::OEBitVector::operator-=>`      :oe:meth:`GetData<OESystem::OEBitVector::GetData>`             :oe:meth:`SetBitOn<OESystem::OEBitVector::SetBitOn>`         
   :oe:meth:`operator[]<OESystem::OEBitVector::operator[]>`      :oe:meth:`GetSize<OESystem::OEBitVector::GetSize>`             :oe:meth:`SetData<OESystem::OEBitVector::SetData>`           
   :oe:meth:`operator^=<OESystem::OEBitVector::operator^=>`      :oe:meth:`IsBitOn<OESystem::OEBitVector::IsBitOn>`             :oe:meth:`SetRangeOff<OESystem::OEBitVector::SetRangeOff>`   
   :oe:meth:`operator|=<OESystem::OEBitVector::operator|=>`      :oe:meth:`IsEmpty<OESystem::OEBitVector::IsEmpty>`             :oe:meth:`SetRangeOn<OESystem::OEBitVector::SetRangeOn>`     
   :oe:meth:`operator &=<OESystem::OEBitVector::operator&=>`     :oe:meth:`LastBit<OESystem::OEBitVector::LastBit>`             :oe:meth:`SetSize<OESystem::OEBitVector::SetSize>`           
   :oe:meth:`ClearBits<OESystem::OEBitVector::ClearBits>`        :oe:meth:`NegateBits<OESystem::OEBitVector::NegateBits>`       :oe:meth:`ToHexString<OESystem::OEBitVector::ToHexString>`   
   :oe:meth:`CountBits<OESystem::OEBitVector::CountBits>`        :oe:meth:`NextBit<OESystem::OEBitVector::NextBit>`             :oe:meth:`ToggleBit<OESystem::OEBitVector::ToggleBit>`       
   ============================================================= ============================================================== =============================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFingerPrint()

      .. oe:language:: python

         .. oe:api:: python

            OEFingerPrint() -> OEFingerPrint

      Default constructor that creates an
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object with an uninitialized
      type, zero pointer (:ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`).

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFingerPrint(const OEFingerPrint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEFingerPrint(rhs: OEFingerPrint) -> OEFingerPrint

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFingerPrint &operator=(const OEFingerPrint &rhs)

      Assignment operator that copies the data of the ``rhs``
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object into the left-hand side
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object.

      Assignment operator.

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEFingerPrint& rhs) const

      Two :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects are considered
      to be equivalent only if they have the same fingerprint type
      (:ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`) and have identical bit-vectors
      (:ref:`OEBitVector <OESystem_OEBitVector>`).

   .. oe:method:: operator!=
      :language: c++

      .. oe:api::

         bool operator!=(const OEFingerPrint& rhs) const

      Two :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects are considered
      to be different if either they have different fingerprint types
      (:ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`) or they have different bit-vectors
      (:ref:`OEBitVector <OESystem_OEBitVector>`).

   .. oe:method:: operator bool

      .. oe:language:: c++

         .. oe:api:: c++

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      .. oe:language:: java

         .. oe:api:: java

            boolean IsValid()

      .. oe:language:: csharp

         .. oe:api:: csharp

            bool IsValid()

      Returns whether the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` has been
      initialized, *i.e.*, has a valid type.

   .. oe:method:: GetFPTypeBase

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFPTypeBase* GetFPTypeBase() const

      .. oe:language:: python

         .. oe:api:: python

            GetFPTypeBase() -> OEFPTypeBase

      Returns a *const* pointer to the fingerprint type
      (:ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`) of the
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object.
      This method will return ``0`` if the
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object has not been
      initialized. 

   .. oe:method:: SetFPTypeBase

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFPTypeBase(const OEFPTypeBase* t)

      .. oe:language:: python

         .. oe:api:: python

            SetFPTypeBase(t: OEFPTypeBase) -> None

      Sets the fingerprint type of a :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`
      object.

      The following functions set the type of the fingerprint when
      an :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object is initialized:

      * :oe:func:`OEGraphSim::OEMakeFP`
      * :oe:func:`OEGraphSim::OEMakeMACCS166FP`
      * :oe:func:`OEGraphSim::OEMakeLingoFP`
      * :oe:func:`OEGraphSim::OEMakePathFP`
      * :oe:func:`OEGraphSim::OEMakeCircularFP`
      * :oe:func:`OEGraphSim::OEMakeTreeFP`

      .. warning::

         Use this method with caution.

         The type of a :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object (that
         is an :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`) encodes how the
         fingerprint is generated. Changing this type can mean that
         the information represented by bitvector of the fingerprint
         will be misinterpreted.



.. _OEGraphSimClasses:

*******************
OEGraphSim Classes
*******************

.. oe:namespace:: OEGraphSim

.. toctree::

   OECreateFastFPDatabaseOptions
   OEFastFPDatabaseParams
   OEFastFPDatabase
   OEFingerPrint
   OEFPDatabase
   OEFPDatabaseOptions
   OEFPHistogram
   OEFPPattern
   OEFPTypeBase
   OEFPTypeParams
   OEFPVariogram
   OESimFuncBase
   OESimScore
   OESimScorePair
   OESimSearchResult
   OETanimotoSim
   OETverskySim


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OESimFuncBase, SimFuncBase

.. _OEGraphSim_OESimFuncBase:

.. oe:class:: OESimFuncBase

   .. oe:api::

      class OESimFuncBase

   :ref:`OESimFuncBase <OEGraphSim_OESimFuncBase>` is an abstract base class which
   defines the interface necessary to perform similarity calculations
   of :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects.

   .. seealso::

      * :ref:`section_measure_user_defined` section

   The following classes derive from this class:

    * :ref:`OETanimotoSim <OEGraphSim_OETanimotoSim>`
    * :ref:`OETverskySim <OEGraphSim_OETverskySim>`

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESimFuncBase()

      .. oe:language:: python

         .. oe:api:: python

            OESimFuncBase() -> OESimFuncBase

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            float operator()(const OEGraphSim::OEFingerPrint& fpA, const OEGraphSim::OEFingerPrint& fpB) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(fpA: OEFingerPrint, fpB: OEFingerPrint) -> float

   Virtual *const* operator that takes two
   :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects and returns their
   evaluated similarity value.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESimFuncBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESimFuncBase

   :oe:meth:`OEGraphSim::OESimFuncBase::CreateCopy` is a virtual
   constructor which allows copying of concrete derived objects using
   a reference to this base class.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetSimTypeString

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetSimTypeString() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetSimTypeString() -> str

   Returns a string representation of the concrete derived class.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OESimScore, SimScore

.. _OEGraphSim_OESimScore:

.. oe:class:: OESimScore

   .. oe:api::

      class OESimScore

   This class represents :ref:`OESimScore <OEGraphSim_OESimScore>` that holds a
   similarity value with an index that identifies the fingerprint in
   the :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object from which the score
   is calculated.

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFPDatabase::GetScores`
      * :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores`

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESimScore(size_t i, double s)

      .. oe:language:: python

         .. oe:api:: python

            OESimScore(i: int, s: float) -> OESimScore

      Initializes an :ref:`OESimScore <OEGraphSim_OESimScore>` from an index ``i``
      and a score ``s``.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t GetIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdx() -> int

      Returns the index of the fingerprint corresponding to the
      similarity score.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetScore() -> float

      Returns the similarity score of the fingerprint corresponding to the
      index.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OESimScorePair, SimScorePair

.. _OEGraphSim_OESimScorePair:

.. oe:class:: OESimScorePair

   .. oe:api::

      class OESimScorePair

   This class represents :ref:`OESimScorePair <OEGraphSim_OESimScorePair>` that holds a
   similarity scores with an index ``i`` and an index ``j`` that identifies
   the fingerprints in the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object from an
   :math:`NxN` similarity calculation with
   :oe:meth:`OEGraphSim::OEFastFPDatabase::GetSparseMatrix`.

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetSparseMatrix`

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESimScorePair(size_t i, size_t j, double s)

      .. oe:language:: python

         .. oe:api:: python

            OESimScorePair(i: int, j: int, s: float) -> OESimScorePair

      Initializes an :ref:`OESimScorePair <OEGraphSim_OESimScorePair>` from an
      index ``i``, an index ``j`` and a score ``s``.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetIdxA

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t GetIdxA() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdxA() -> int

      Returns the index ``i`` of the fingerprint corresponding to the
      similarity score.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetIdxB

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t GetIdxB() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdxB() -> int

      Returns the index ``j`` of the fingerprint corresponding to the
      similarity score.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetScore() -> float

      Returns the similarity score of the fingerprint corresponding to
      the index ``i`` and index ``j`` fingerprints.


.. oe:namespace:: OEGraphSim

.. _OEGraphSim_OESimSearchResult:

.. oe:class:: OESimSearchResult

   .. oe:api::

       class OESimSearchResult

   The :ref:`OESimSearchResult <OEGraphSim_OESimSearchResult>` class is used to store the results
   of a similarity search along with reporting the progress of the search and the
   histogram of the similarity scores.

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFastFPDatabase::SortedSearch` method

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::
            OESimSearchResult(const size_t nrbins = 50u,
                              const double min = 0.0, const double max = 1.0)

      .. oe:language:: python

         .. oe:api:: python

            OESimSearchResult(nrbins: int = 50, min: float = 0.0,
                              max: float = 1.0) -> OESimSearchResult

      Constructor an empty result object with parameters for the score histogram.

      nrbins
        Number of bins in the histogram (default = 50).

      minv
        Minimum bound (inclusive) of the histogram range (default = 0.0).

      maxv
        Maximum bound (inclusive) of the histogram range (default = 1.0).

   .. oe:method:: GetHistogram

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFPHistogram GetHistogram() const

      .. oe:language:: python

         .. oe:api:: python

            GetHistogram() -> OEFPHistogram

      Returns an :ref:`OEFPHistogram <OEGraphSim_OEFPHistogram>` object that stores the
      histogram of similarity scores.

   .. oe:method:: GetSearchStatus

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetSearchStatus() const

      .. oe:language:: python

         .. oe:api:: python

            GetSearchStatus() -> int

      Returns the status of the similarity search defined in
      the :oe:constns:`OEGraphSim::OESimSearchStatus` namespace.

   .. oe:method:: GetSortedScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESimScore>* GetSortedScores()

      .. oe:language:: python

         .. oe:api:: python

            GetSortedScores() -> Iterable[OESimScore]

      Returns an iterator over the calculated similarity scores
      (:ref:`OESimScore <OEGraphSim_OESimScore>`) in the sorted order.
      Each :ref:`OESimScore <OEGraphSim_OESimScore>` holds a similarity score and
      index of the corresponding fingerprint of the database.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OESimSearchResult <OEGraphSim_OESimSearchResult>` object is valid.

   .. oe:method:: NumSearched

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t NumSearched() const

      .. oe:language:: python

         .. oe:api:: python

            NumSearched() -> int

      Returns the number of fingerprints that have been already searched.
      This counter is continuously updated and provides the progress of the
      similarity search.

   .. oe:method:: NumTargets

      .. oe:language:: c++ java csharp

         .. oe:api::

            size_t NumTargets() const

      .. oe:language:: python

         .. oe:api:: python

            NumTargets() -> int

      Returns the number of targets (i.e. the number of fingerprints
      in the database).


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OETanimotoSim, TanimotoSim

.. _OEGraphSim_OETanimotoSim:

.. oe:class:: OETanimotoSim

   .. oe:api::

      class OETanimotoSim : public OEGraphSim::OESimFuncBase

   This class represents :ref:`OETanimotoSim <OEGraphSim_OETanimotoSim>` that
   calculates the :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>`
   similarity score.

   **Formula:**

     :math:`Sim_{Tanimoto}(A,B) = \frac{bothAB}{|A| + |B| - bothAB} = \frac{bothAB}{onlyA + onlyB + bothAB}`

   .. seealso::

      * :ref:`section_measure_tanimoto` section
      * :oe:func:`OEGraphSim::OETanimoto` function

   The following methods are publicly inherited from :ref:`OESimFuncBase <OEGraphSim_OESimFuncBase>`:

   ======================================================================= ======================================================================= ========================================================================
   :oe:meth:`operator()<OEGraphSim::OESimFuncBase::operator()>`            :oe:meth:`CreateCopy<OEGraphSim::OESimFuncBase::CreateCopy>`            :oe:meth:`GetSimTypeString<OEGraphSim::OESimFuncBase::GetSimTypeString>`
   ======================================================================= ======================================================================= ========================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETanimotoSim()

      .. oe:language:: python

         .. oe:api:: python

            OETanimotoSim() -> OETanimotoSim

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            float operator()(const OEGraphSim::OEFingerPrint& fpA, const OEGraphSim::OEFingerPrint& fpB) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(fpA: OEFingerPrint, fpB: OEFingerPrint) -> float

      Returns the :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>`
      similarity coefficient of the two given
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEGraphSim::OESimFuncBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OETanimotoSim

      Deep copy constructor that returns a copy of the object. The memory
      for the returned :ref:`OETanimotoSim <OEGraphSim_OETanimotoSim>` object is
      dynamically allocated and owned by the caller.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetSimTypeString

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetSimTypeString() const

      .. oe:language:: python

         .. oe:api:: python

            GetSimTypeString() -> str

      Returns a string representation of the
      :ref:`OETanimotoSim <OEGraphSim_OETanimotoSim>` class.



.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OETverskySim, TverskySim

.. _OEGraphSim_OETverskySim:

.. oe:class:: OETverskySim

   .. oe:api::

      class OETverskySim : public OEGraphSim::OESimFuncBase

   This class represents :ref:`OETverskySim <OEGraphSim_OETverskySim>` that
   calculates the :oe:const:`Tversky<OEGraphSim::OESimMeasure::Tversky>`
   similarity score.

   **Formula:**

      :math:`Sim_{Tversky}(A,B) = \frac{bothAB}{\alpha * onlyA + \beta * onlyB + bothAB}`

   .. seealso::

      * :ref:`section_measure_tversky` section
      * :oe:func:`OEGraphSim::OETversky` function

   The following methods are publicly inherited from :ref:`OESimFuncBase <OEGraphSim_OESimFuncBase>`:

   ======================================================================= ======================================================================= ========================================================================
   :oe:meth:`operator()<OEGraphSim::OESimFuncBase::operator()>`            :oe:meth:`CreateCopy<OEGraphSim::OESimFuncBase::CreateCopy>`            :oe:meth:`GetSimTypeString<OEGraphSim::OESimFuncBase::GetSimTypeString>`
   ======================================================================= ======================================================================= ========================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETverskySim(float a = 0.95f)

      .. oe:language:: python

         .. oe:api:: python

            OETverskySim(a: float = 0.95) -> OETverskySim

      Default constructor (:math:`\alpha = 0.95`, :math:`\beta = 1.0 - \alpha = 0.05`)

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETverskySim(float a, float b)

      .. oe:language:: python

         .. oe:api:: python

            OETverskySim(a: float, b: float) -> OETverskySim

      Constructor with arbitrary :math:`\alpha` and :math:`\beta` parameters.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            float operator()(const OEGraphSim::OEFingerPrint& fpA, const OEGraphSim::OEFingerPrint& fpB) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(fpA: OEFingerPrint, fpB: OEFingerPrint) -> float

      Returns the :oe:const:`Tversky<OEGraphSim::OESimMeasure::Tversky>`
      similarity coefficient of the two given
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEGraphSim::OESimFuncBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OETverskySim

      Deep copy constructor that returns a copy of the object. The memory
      for the returned :ref:`OETverskySim <OEGraphSim_OETverskySim>` object is
      dynamically allocated and owned by the caller.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetAlpha

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetAlpha() const

      .. oe:language:: python

         .. oe:api:: python

            GetAlpha() -> float

      Returns the :math:`\alpha` parameter of the
      :oe:const:`Tversky<OEGraphSim::OESimMeasure::Tversky>` similarity
      calculation.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetBeta

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBeta() const

      .. oe:language:: python

         .. oe:api:: python

            GetBeta() -> float

      Returns the :math:`\beta` parameter of the
      :oe:const:`Tversky<OEGraphSim::OESimMeasure::Tversky>` similarity
      calculation.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetSimTypeString

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetSimTypeString() const

      .. oe:language:: python

         .. oe:api:: python

            GetSimTypeString() -> str

      Returns a string representation of the
      :ref:`OETverskySim <OEGraphSim_OETverskySim>` class.


.. oe:namespace:: OEGraphSim

..  _OEGraphSim_OEFPAtomType:

.. oe:constnamespace:: OEFPAtomType

   This namespace contains atom typing options that can be used when
   generating
   :ref:`section_fingerprint_circular`,
   :ref:`section_fingerprint_path` or
   :ref:`section_fingerprint_tree` fingerprints.
   Atom type options control how the atoms of the enumerated circular,
   path or tree fragments are encoded during the fingerprint
   generation.

   The :oe:constns:`OEGraphSim::OEFPAtomType` namespace contains the following constants:

   .. list-table::
      :widths: 80 140
      :header-rows: 1

      * - Constant name
        - Combination of

      * - :oe:const:`OEGraphSim::OEFPAtomType::Aromaticity`
        -

      * - :oe:const:`OEGraphSim::OEFPAtomType::AtomicNumber`
        -

      * - :oe:const:`OEGraphSim::OEFPAtomType::Chiral`
        -

      * - :oe:const:`OEGraphSim::OEFPAtomType::DefaultAtom`
        - :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>` | :oe:const:`Aromaticity<OEGraphSim::OEFPAtomType::Aromaticity>` | :oe:const:`Chiral<OEGraphSim::OEFPAtomType::Chiral>` | :oe:const:`FormalCharge<OEGraphSim::OEFPAtomType::FormalCharge>` | :oe:const:`HvyDegree<OEGraphSim::OEFPAtomType::HvyDegree>` | :oe:const:`Hybridization<OEGraphSim::OEFPAtomType::Hybridization>` | :oe:const:`EqHalogen<OEGraphSim::OEFPAtomType::EqHalogen>`

      * - :oe:const:`OEGraphSim::OEFPAtomType::DefaultCircularAtom`
        - :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>` | :oe:const:`Aromaticity<OEGraphSim::OEFPAtomType::Aromaticity>` | :oe:const:`Chiral<OEGraphSim::OEFPAtomType::Chiral>` | :oe:const:`FormalCharge<OEGraphSim::OEFPAtomType::FormalCharge>` | :oe:const:`HCount<OEGraphSim::OEFPAtomType::HCount>`  | :oe:const:`EqHalogen<OEGraphSim::OEFPAtomType::EqHalogen>`

      * - :oe:const:`OEGraphSim::OEFPAtomType::DefaultCircularVSAtom`
        - :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>` | :oe:const:`Aromaticity<OEGraphSim::OEFPAtomType::Aromaticity>` | :oe:const:`Chiral<OEGraphSim::OEFPAtomType::Chiral>` | :oe:const:`EqHalogen<OEGraphSim::OEFPAtomType::EqHalogen>`

      * - :oe:const:`OEGraphSim::OEFPAtomType::DefaultCircularVSAtom1`
        - :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>` | :oe:const:`Aromaticity<OEGraphSim::OEFPAtomType::Aromaticity>` | :oe:const:`Chiral<OEGraphSim::OEFPAtomType::Chiral>` | :oe:const:`HCount<OEGraphSim::OEFPAtomType::HCount>`  | :oe:const:`EqHalogen<OEGraphSim::OEFPAtomType::EqHalogen>`

      * - :oe:const:`OEGraphSim::OEFPAtomType::DefaultCircularVSAtom2`
        - :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>` | :oe:const:`Aromaticity<OEGraphSim::OEFPAtomType::Aromaticity>` | :oe:const:`Chiral<OEGraphSim::OEFPAtomType::Chiral>` | :oe:const:`EqHalogen<OEGraphSim::OEFPAtomType::EqHalogen>`

      * - :oe:const:`OEGraphSim::OEFPAtomType::DefaultPathAtom`
        - :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>` | :oe:const:`Aromaticity<OEGraphSim::OEFPAtomType::Aromaticity>` | :oe:const:`Chiral<OEGraphSim::OEFPAtomType::Chiral>` | :oe:const:`FormalCharge<OEGraphSim::OEFPAtomType::FormalCharge>` | :oe:const:`HvyDegree<OEGraphSim::OEFPAtomType::HvyDegree>` | :oe:const:`Hybridization<OEGraphSim::OEFPAtomType::Hybridization>` | :oe:const:`EqHalogen<OEGraphSim::OEFPAtomType::EqHalogen>`

      * - :oe:const:`OEGraphSim::OEFPAtomType::DefaultPathVSAtom`
        - :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>` | :oe:const:`Aromaticity<OEGraphSim::OEFPAtomType::Aromaticity>` | :oe:const:`Chiral<OEGraphSim::OEFPAtomType::Chiral>` | :oe:const:`HvyDegree<OEGraphSim::OEFPAtomType::HvyDegree>` | :oe:const:`EqHalogen<OEGraphSim::OEFPAtomType::EqHalogen>`

      * - :oe:const:`OEGraphSim::OEFPAtomType::DefaultTreeAtom`
        - :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>` | :oe:const:`Aromaticity<OEGraphSim::OEFPAtomType::Aromaticity>` | :oe:const:`Chiral<OEGraphSim::OEFPAtomType::Chiral>` | :oe:const:`FormalCharge<OEGraphSim::OEFPAtomType::FormalCharge>` | :oe:const:`HvyDegree<OEGraphSim::OEFPAtomType::HvyDegree>` | :oe:const:`Hybridization<OEGraphSim::OEFPAtomType::Hybridization>`

      * - :oe:const:`OEGraphSim::OEFPAtomType::DefaultTreeVSAtom`
        - :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>` | :oe:const:`Aromaticity<OEGraphSim::OEFPAtomType::Aromaticity>` | :oe:const:`Chiral<OEGraphSim::OEFPAtomType::Chiral>` |  :oe:const:`HvyDegree<OEGraphSim::OEFPAtomType::HvyDegree>`

      * - :oe:const:`OEGraphSim::OEFPAtomType::EqAromatic`
        -

      * - :oe:const:`OEGraphSim::OEFPAtomType::EqHalogen`
        -

      * - :oe:const:`OEGraphSim::OEFPAtomType::EqHBondAcceptor`
        -

      * - :oe:const:`OEGraphSim::OEFPAtomType::EqHBondDonor`
        -

      * - :oe:const:`OEGraphSim::OEFPAtomType::FormalCharge`
        -

      * - :oe:const:`OEGraphSim::OEFPAtomType::HCount`
        -

      * - :oe:const:`OEGraphSim::OEFPAtomType::HvyDegree`
        -

      * - :oe:const:`OEGraphSim::OEFPAtomType::Hybridization`
        -

      * - :oe:const:`OEGraphSim::OEFPAtomType::InRing`
        -

      * - :oe:const:`OEGraphSim::OEFPAtomType::None`
        -

   .. hint::

      The virtual screening variant (``VS``) version of the default atom types,
      treats certain functional group identically regardless of their pKa state
      e.g. protonated and unprotonated carboxylic acids.

   .. note::

      The constants of the :oe:constns:`OEGraphSim::OEFPAtomType`
      namespace can be **combined** using the bitwise ``OR``
      operation.

   .. note::

      The images in this sections visualize the effect of the
      various atom typing options.

      See also: :ref:`oegraphsim_section_visualizing_molecule_similarity` section

   .. seealso::

      * :oe:constns:`OEGraphSim::OEFPBondType` namespace
      * :oe:func:`OEGraphSim::OEMakeCircularFP` function
      * :oe:func:`OEGraphSim::OEMakePathFP` function
      * :oe:func:`OEGraphSim::OEMakeTreeFP` function
      * :ref:`section_user_defined_atom_bond_typing` section

   .. note::

      **All** explicit hydrogens are suppressed of the molecule
      before generating any fingerprints.
      (See example in :ref:`figure_OEFPAtomType_hydrogen`).

   .. _figure_OEFPAtomType_hydrogen:

   .. figure:: graphsimtk/images/OEFPAtomTypeHydrogenHandling.*
      :align:  center

      **Example of molecules that are considered to be equivalent due to suppressing their explicit hydrogens**

   .. ###############################################################################

   .. oe:constant:: AtomicNumber

      This flag indicates that atomic number (the value returned
      by the :oe:meth:`OEChem::OEAtomBase::GetAtomicNum` method) is encoded
      into the generated fingerprint, *i.e.*, if two fragments (either
      circular, paths or tree) are composed of atoms with different
      atomic numbers, then the two fragments will be mapped to different
      bits of the fingerprint.
      :ref:`Table: Example of using the AtomicNumber option<table_OEFPAtomType_AtomicNumber>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPAtomType::AtomicNumber` flag.

      .. _table_OEFPAtomType_AtomicNumber:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPAtomType::AtomicNumber` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096, bonds=0-5,
                      bond typing = :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`).

         * - .. image:: ../images/OEFPAtomTypeNotAtomicNumber.*
           - .. image:: ../images/OEFPAtomTypeAtomicNumber.*

   .. ###############################################################################

   .. oe:constant:: Aromaticity

      This flag indicates that aromaticity (the value returned by the
      :oe:meth:`OEChem::OEAtomBase::IsAromatic` method) is
      encoded into the generated fingerprint, *i.e.*, an aromatic
      and an aliphatic fragment will be mapped to different bits of the
      fingerprint.
      :ref:`Table: Example of using the Aromatic option<table_OEFPAtomType_Aromaticity>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPAtomType::Aromaticity` flag.

      .. _table_OEFPAtomType_Aromaticity:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPAtomType::Aromaticity` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096, bonds=0-5,
                      bond typing = :oe:const:`InRing<OEGraphSim::OEFPBondType::InRing>`).

         * - .. image:: ../images/OEFPAtomTypeNotAromaticity.*
           - .. image:: ../images/OEFPAtomTypeAromaticity.*

      .. note::

         Prior to generating a fingerprint, the aromaticity of the
         molecule is re-perceived using the :oe:const:`OEChem::OEAroModel::OpenEye`
         aromaticity model.

   .. ###############################################################################

   .. oe:constant:: Chiral

      This flag indicates that chiral and non-chiral atoms (the value
      returned by the :oe:meth:`OEChem::OEAtomBase::IsChiral` method) are
      distinguished during the fingerprint generation.
      :ref:`Table: Example of using the Chiral option<table_OEFPAtomType_Chiral>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPAtomType::Chiral` flag.

      .. _table_OEFPAtomType_Chiral:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPAtomType::Chiral` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096, bonds=0-5,
                      bond typing = :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`).

         * - .. image:: ../images/OEFPAtomTypeNotChiral.*
           - .. image:: ../images/OEFPAtomTypeChiral.*

      .. note::

         Different stereoisomers of molecules can not be distinguished
         when the :oe:const:`OEGraphSim::OEFPAtomType::Chiral` flag is set.
         (See example in :ref:`Figure: Example of molecule similarity of stereoisomers <figure_OEFPAtomType_stereo>`).

      .. _figure_OEFPAtomType_stereo:

      .. figure:: graphsimtk/images/OEFPAtomTypeAtomStereoHandling.*
         :align:  center

         **Example of molecule similarity of stereoisomers**

   .. ###############################################################################

   .. _OEFPAtomType_FormalCharge:

   .. oe:constant:: FormalCharge

      This flag indicates that formal charge (the value returned by the
      :oe:meth:`OEChem::OEAtomBase::GetFormalCharge` method) is encoded into the
      generated fingerprint.
      :ref:`Table: Example of using the FormalCharge option<table_OEFPAtomType_FormalCharge>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPAtomType::FormalCharge` flag.

      .. _table_OEFPAtomType_FormalCharge:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPAtomType::FormalCharge` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096, bonds=0-5,
                      bond typing = :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`).

         * - .. image:: ../images/OEFPAtomTypeNotFormalCharge.*
           - .. image:: ../images/OEFPAtomTypeFormalCharge.*

   .. ###############################################################################

   .. oe:constant:: HvyDegree

      This flag indicates that heavy degree information (the value
      returned by the :oe:meth:`OEChem::OEAtomBase::GetHvyDegree`
      method) is encoded into the generated fingerprint.
      :ref:`Table: Example of using the HvyDegree option<table_OEFPAtomType_HvyDegree>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPAtomType::HvyDegree` flag.

      .. _table_OEFPAtomType_HvyDegree:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPAtomType::FormalCharge` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096, bonds=0-5,
                      bond typing = :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`).

         * - .. image:: ../images/OEFPAtomTypeNotHvyDegree.*
           - .. image:: ../images/OEFPAtomTypeHvyDegree.*

   .. ###############################################################################

   .. oe:constant:: HCount

      This flag indicates that number of hydrogens (the value
      returned by the :oe:meth:`OEChem::OEAtomBase::GetTotalHCount` method)
      is encoded into the generated fingerprint.
      :ref:`Table: Example of using the HCount option<table_OEFPAtomType_HCount>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPAtomType::HCount` flag.

      .. _table_OEFPAtomType_HCount:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPAtomType::HCount` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096, bonds=0-5,
                      bond typing = :oe:const:`InRing<OEGraphSim::OEFPBondType::InRing>`).

         * - .. image:: ../images/OEFPAtomTypeNotHCount.*
           - .. image:: ../images/OEFPAtomTypeHCount.*

   .. ###############################################################################

   .. _OEFPAtomType_Hybridization:

   .. oe:constant:: Hybridization

      This flag indicates that hybridization (the value returned by the
      :oe:meth:`OEChem::OEAtomBase::GetHyb` method) is encoded into the
      generated fingerprint.
      :ref:`Table: Example of using the Hybridization option<table_OEFPAtomType_Hybridization>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPAtomType::Hybridization` flag.

      .. _table_OEFPAtomType_Hybridization:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPAtomType::Hybridization` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096, bonds=0-5,
                      bond typing = :oe:const:`InRing<OEGraphSim::OEFPBondType::InRing>`).

         * - .. image:: ../images/OEFPAtomTypeNotHybridization.*
           - .. image:: ../images/OEFPAtomTypeHybridization.*

   .. ###############################################################################

   .. oe:constant:: InRing

      This flag indicates that atom topology (the value returned by the
      :oe:meth:`OEChem::OEAtomBase::IsInRing` method) is encoded into the generated fingerprint,
      *i.e.*, if two fragments (either circular, path or tree) are composed of atoms
      with different atom topology, then the two fragments will be mapped to
      different bits of the fingerprint.
      :ref:`Table: Example of using the InRing option<table_OEFPAtomType_InRing>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPAtomType::InRing` flag.

      .. _table_OEFPAtomType_InRing:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPAtomType::InRing` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096, bonds=0-5,
                      bond typing = :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`).

         * - .. image:: ../images/OEFPAtomTypeNotInRing.*
           - .. image:: ../images/OEFPAtomTypeInRing.*

   .. ###############################################################################

   .. oe:constant:: EqAromatic

      This flag modifies the meaning of the
      :oe:const:`OEGraphSim::OEFPAtomType::AtomicNumber` flag.
      If the :oe:const:`OEGraphSim::OEFPAtomType::EqAromatic` flag is
      set then  aromatic atoms are considered equivalent during the fingerprint
      generation.
      :ref:`Table: Example of using the EqAromatic option<table_OEFPAtomType_EqAromatic>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPAtomType::EqAromatic` flag.

      .. _table_OEFPAtomType_EqAromatic:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPAtomType::EqAromatic` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096,  bonds=0-5,
                      bond typing = :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`).

         * - .. image:: ../images/OEFPAtomTypeNotEqAromatic.*
           - .. image:: ../images/OEFPAtomTypeEqAromatic.*

   .. ###############################################################################

   .. oe:constant:: EqHalogen

      This flag modifies the meaning of
      :oe:const:`OEGraphSim::OEFPAtomType::AtomicNumber` flag.
      If the :oe:const:`OEGraphSim::OEFPAtomType::EqHalogen` flag is
      set then halide atoms (:oe:const:`OEChem::OEElemNo::F`,
      :oe:const:`OEChem::OEElemNo::Cl`, :oe:const:`OEChem::OEElemNo::Br`, and
      :oe:const:`OEChem::OEElemNo::I`) are considered equivalent during
      the fingerprint generation.
      :ref:`Table: Example of using the EqHalogen option<table_OEFPAtomType_EqHalogen>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPAtomType::EqHalogen` flag.

      .. _table_OEFPAtomType_EqHalogen:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPAtomType::EqHalogen` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096,  bonds=0-5,
                      bond typing = :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`).

         * - .. image:: ../images/OEFPAtomTypeNotEqHalogen.*
           - .. image:: ../images/OEFPAtomTypeEqHalogen.*

   .. ###############################################################################

   .. oe:constant:: EqHBondAcceptor

      This flag modifies the meaning of the
      :oe:const:`OEGraphSim::OEFPAtomType::AtomicNumber` flag.
      If the :oe:const:`OEGraphSim::OEFPAtomType::EqHBondAcceptor` flag
      is set then atoms that are perceived as hydrogen bonding
      acceptors are considered equivalent during the fingerprint
      generation.
      The **GraphSim TK** uses the same definition as the `MolProp TK <http://www.eyesopen.com/molprop-tk>`_
      to identify hydrogen bond acceptors.
      See examples in :ref:`Figure: Molecules with hydrogen bond acceptor annotation<figure_OEFPAtomType_AnnotateHBAcceptor>`.
      :ref:`Table: Example of using the EqHBondAcceptor option<table_OEFPAtomType_EqHBondAcceptor>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPAtomType::EqHBondAcceptor` flag.

      .. _figure_OEFPAtomType_AnnotateHBAcceptor:

      .. figure:: graphsimtk/images/OEFPAtomTypeAnnotateHBAcceptors.*
          :align: center

          **Example of molecules with hydrogen bond acceptor annotation**

      .. _table_OEFPAtomType_EqHBondAcceptor:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPAtomType::EqHBondAcceptor` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096,  bonds=0-5,
                      bond typing = :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`).

         * - .. image:: ../images/OEFPAtomTypeNotEqHBondAcceptor.*
           - .. image:: ../images/OEFPAtomTypeEqHBondAcceptor.*

   .. ###############################################################################

   .. oe:constant:: EqHBondDonor

      This flag modifies the meaning of the
      :oe:const:`OEGraphSim::OEFPAtomType::AtomicNumber` flag.
      If the :oe:const:`OEGraphSim::OEFPAtomType::EqHBondDonor` flag is
      set then atoms that are perceived as hydrogen bonding donors
      are considered equivalent during the fingerprint generation.
      The **GraphSim TK** uses the same definition as the `MolProp TK <http://www.eyesopen.com/molprop-tk>`_
      to identify hydrogen bond donors.
      See examples in :ref:`Figure: Molecules with hydrogen bond donor annotation<figure_OEFPAtomType_AnnotateHBDonor>`.
      :ref:`Table: Example of using the EqHBondDonor option<table_OEFPAtomType_EqHBondDonor>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPAtomType::EqHBondDonor` flag.

      .. _figure_OEFPAtomType_AnnotateHBDonor:

      .. figure:: graphsimtk/images/OEFPAtomTypeAnnotateHBDonor.*
         :align:  center

         **Molecules with hydrogen bond donor annotation**

      .. _table_OEFPAtomType_EqHBondDonor:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPAtomType::EqHBondDonor` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096,  bonds=0-5,
                      bond typing = :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`).

         * - .. image:: ../images/OEFPAtomTypeNotEqHBondDonor.*
           - .. image:: ../images/OEFPAtomTypeEqHBondDonor.*

   .. ###############################################################################

   .. oe:constant:: DefaultAtom

      Same as :ref:`DefaultPathAtom <OEGraphSim_DefaultPathAtom>` constant.

   .. ###############################################################################

   ..   _OEGraphSim_DefaultCircularAtom:

   .. oe:constant:: DefaultCircularAtom

      The bitwise OR'd value of the following atom typing options:

      * :oe:const:`OEGraphSim::OEFPAtomType::AtomicNumber`
      * :oe:const:`OEGraphSim::OEFPAtomType::Aromaticity`
      * :oe:const:`OEGraphSim::OEFPAtomType::Chiral`
      * :oe:const:`OEGraphSim::OEFPAtomType::FormalCharge`
      * :oe:const:`OEGraphSim::OEFPAtomType::HCount`
      * :oe:const:`OEGraphSim::OEFPAtomType::EqHalogen`

      See example in :ref:`Figure: Circular fingerprint similarity with default circular atom and bond typing<figure_OEFPAtomType_DefaultCircular>`.
      This constant is used as atom typing parameter when a default
      :oe:const:`Circular<OEGraphSim::OEFPType::Circular>` fingerprint is
      generated by the following functions:

      * :oe:func:`OEGraphSim::OEMakeFP` (:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` &,
        const :ref:`OEMolBase <OEChem_OEMolBase>` &, :oe:const:`OEGraphSim::OEFPType::Circular`)
      * :oe:func:`OEGraphSim::OEMakeCircularFP` (:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` &,
        const :ref:`OEMolBase <OEChem_OEMolBase>` &)

      .. seealso::

          * :oe:const:`OEGraphSim::OEFPBondType::DefaultCircularBond` constant

      .. _figure_OEFPAtomType_DefaultCircular:

      .. figure:: graphsimtk/images/DefaultCircular.*
         :align:  center

         **Circular fingerprint similarity with default circular atom and bond typing**

   .. oe:constant:: DefaultCircularVSAtom

      The default atom typing for the circular fingerprint that is designed for virtual
      screening. It is the same as :ref:`DefaultCircularAtom <OEGraphSim_DefaultCircularAtom>`
      without :oe:const:`OEGraphSim::OEFPAtomType::FormalCharge` and
      :oe:const:`OEGraphSim::OEFPAtomType::HCount`

   .. oe:constant:: DefaultCircularVSAtom1

      It is the same as :ref:`DefaultCircularAtom <OEGraphSim_DefaultCircularAtom>`
      without :oe:const:`OEGraphSim::OEFPAtomType::FormalCharge`

   .. oe:constant:: DefaultCircularVSAtom2

      Same as :oe:const:`OEGraphSim::OEFPAtomType::DefaultCircularVSAtom` constant.

   .. ###############################################################################

   ..   _OEGraphSim_DefaultPathAtom:

   .. oe:constant:: DefaultPathAtom

      The bitwise OR'd value of the following atom typing options:

      * :oe:const:`OEGraphSim::OEFPAtomType::AtomicNumber`
      * :oe:const:`OEGraphSim::OEFPAtomType::Aromaticity`
      * :oe:const:`OEGraphSim::OEFPAtomType::Chiral`
      * :oe:const:`OEGraphSim::OEFPAtomType::FormalCharge`
      * :oe:const:`OEGraphSim::OEFPAtomType::HvyDegree`
      * :oe:const:`OEGraphSim::OEFPAtomType::Hybridization`
      * :oe:const:`OEGraphSim::OEFPAtomType::EqHalogen`

      See example in :ref:`Figure: Path fingerprint similarity with default path atom and bond typing<figure_OEFPAtomType_DefaultPath>`.
      This constant is used as atom typing parameter when a default
      :oe:const:`Path<OEGraphSim::OEFPType::Path>` fingerprint is
      generated by the following functions:

      * :oe:func:`OEGraphSim::OEMakeFP` (:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` &,
        const :ref:`OEMolBase <OEChem_OEMolBase>` &, :oe:const:`OEGraphSim::OEFPType::Path`)
      * :oe:func:`OEGraphSim::OEMakePathFP`  (:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` &,
        const :ref:`OEMolBase <OEChem_OEMolBase>` &)

      .. seealso::

          * :oe:const:`OEGraphSim::OEFPBondType::DefaultPathBond` constant

      .. _figure_OEFPAtomType_DefaultPath:

      .. figure:: graphsimtk/images/DefaultPath.*
         :align:  center

         **Path fingerprint similarity with default path atom and bond typing**

   .. oe:constant:: DefaultPathVSAtom

      The default atom typing for the path fingerprint that is designed for virtual
      screening. It is the same as :ref:`DefaultPathAtom <OEGraphSim_DefaultPathAtom>`
      without :oe:const:`OEGraphSim::OEFPAtomType::FormalCharge` and
      :oe:const:`OEGraphSim::OEFPAtomType::Hybridization`.

   .. ###############################################################################

   ..   _OEGraphSim_DefaultTreeAtom:

   .. oe:constant:: DefaultTreeAtom

      The bitwise OR'd value of the following atom typing options:

      * :oe:const:`OEGraphSim::OEFPAtomType::AtomicNumber`
      * :oe:const:`OEGraphSim::OEFPAtomType::Aromaticity`
      * :oe:const:`OEGraphSim::OEFPAtomType::Chiral`
      * :oe:const:`OEGraphSim::OEFPAtomType::FormalCharge`
      * :oe:const:`OEGraphSim::OEFPAtomType::HvyDegree`
      * :oe:const:`OEGraphSim::OEFPAtomType::Hybridization`

      See example in :ref:`Figure: Tree fingerprint similarity with default tree atom and bond typing<figure_OEFPAtomType_DefaultTree>`.
      This constant is used as atom typing parameter when a default
      :oe:const:`Tree<OEGraphSim::OEFPType::Tree>` fingerprint is
      generated by the following functions:

      * :oe:func:`OEGraphSim::OEMakeFP` (:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` &,
        const :ref:`OEMolBase <OEChem_OEMolBase>` &, :oe:const:`OEGraphSim::OEFPType::Tree`)
      * :oe:func:`OEGraphSim::OEMakeTreeFP` (:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` &,
        const :ref:`OEMolBase <OEChem_OEMolBase>` &)

      .. seealso::

          * :oe:const:`OEGraphSim::OEFPBondType::DefaultTreeBond` constant

      .. _figure_OEFPAtomType_DefaultTree:

      .. figure:: graphsimtk/images/DefaultTree.*
         :align:  center

         **Tree fingerprint similarity with default tree atom and bond typing**

   .. oe:constant:: DefaultTreeVSAtom

      The default atom typing for the tree fingerprint that is designed for virtual
      screening. It is the same as :ref:`DefaultTreeAtom <OEGraphSim_DefaultTreeAtom>`
      without :oe:const:`OEGraphSim::OEFPAtomType::FormalCharge` and
      :oe:const:`OEGraphSim::OEFPAtomType::Hybridization`.

   .. ###############################################################################

   .. oe:constant:: None

      No atom properties are encoded when generating a fingerprint.


.. oe:namespace:: OEGraphSim

.. oe:constnamespace:: OEFPBondType

   This namespace contains bond typing options that can be used when
   generating
   :ref:`section_fingerprint_circular`,
   :ref:`section_fingerprint_path` or
   :ref:`section_fingerprint_tree` fingerprints.
   Bond type options control how the bonds of the enumerated circular,
   path or tree fragments are encoded during the fingerprint
   generation.

   The :oe:constns:`OEGraphSim::OEFPBondType` namespace  contains the following constants:

   .. list-table::
      :widths: 80 120
      :header-rows: 1

      * - Constant name
        - Combination of

      * - :oe:const:`OEGraphSim::OEFPBondType::BondOrder`
        -

      * - :oe:const:`OEGraphSim::OEFPBondType::Chiral`
        -

      * - :oe:const:`OEGraphSim::OEFPBondType::DefaultBond`
        - :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>` | :oe:const:`Chiral<OEGraphSim::OEFPBondType::Chiral>`

      * - :oe:const:`OEGraphSim::OEFPBondType::DefaultCircularBond`
        - :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`

      * - :oe:const:`OEGraphSim::OEFPBondType::DefaultCircularVSBond`
        - :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`

      * - :oe:const:`OEGraphSim::OEFPBondType::DefaultCircularVSBond1`
        - :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`

      * - :oe:const:`OEGraphSim::OEFPBondType::DefaultCircularVSBond2`
        - :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`

      * - :oe:const:`OEGraphSim::OEFPBondType::DefaultPathBond`
        - :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>` | :oe:const:`Chiral<OEGraphSim::OEFPBondType::Chiral>`

      * - :oe:const:`OEGraphSim::OEFPBondType::DefaultPathVSBond`
        - :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>` | :oe:const:`Chiral<OEGraphSim::OEFPBondType::Chiral>`

      * - :oe:const:`OEGraphSim::OEFPBondType::DefaultTreeBond`
        - :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`

      * - :oe:const:`OEGraphSim::OEFPBondType::DefaultTreeVSBond`
        - :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`

      * - :oe:const:`OEGraphSim::OEFPBondType::InRing`
        -

      * - :oe:const:`OEGraphSim::OEFPBondType::None`
        -

   .. note::

      The constants of the :oe:constns:`OEGraphSim::OEFPBondType`
      namespace can be **combined** using the bitwise ``OR``
      operation.

   .. note::

      The images in this sections visualize the effect of the
      various bond typing options.

      See also: :ref:`oegraphsim_section_visualizing_molecule_similarity` section

   .. seealso::

      * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
      * :oe:func:`OEGraphSim::OEMakeCircularFP` function
      * :oe:func:`OEGraphSim::OEMakePathFP` function
      * :oe:func:`OEGraphSim::OEMakeTreeFP` function
      * :ref:`section_user_defined_atom_bond_typing` section

   .. ###############################################################################

   .. oe:constant:: BondOrder

      This flag indicates that bond order information is encoded into
      the generated fingerprint, *i.e.*, if two fragments (either
      circular, path or tree) are composed of bonds with different bond
      orders (the value returned by the :oe:cls:`OEChem::OEBondBase::GetOrder`
      method) then the two fragments will be mapped to different bits
      of the fingerprint.
      :ref:`Table: Example of using the BondOrder option<table_OEFPBondType_BondOrder>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPBondType::BondOrder` flag.

      .. _table_OEFPBondType_BondOrder:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPBondType::BondOrder` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096, bonds=0-5,
                      atom typing = :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>`).

         * - .. image:: ../images/OEFPBondTypeNotBondOrder.*
           - .. image:: ../images/OEFPBondTypeBondOrder.*

   .. ###############################################################################

   .. oe:constant:: Chiral

      This flag indicates that chiral and non-chiral bonds (the value
      returned by the :oe:meth:`OEChem::OEBondBase::IsChiral` method) are
      distinguished during the circular, path, the tree fingerprint
      generation.
      :ref:`Table: Example of using the Chiral option<table_OEFPBondType_Chiral>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPBondType::Chiral` flag.

      .. _table_OEFPBondType_Chiral:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPBondType::Chiral` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096, bonds=0-5,
                      atom typing = :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>`).

         * - .. image:: ../images/OEFPBondTypeNotChiral.*
           - .. image:: ../images/OEFPBondTypeChiral.*

      .. note::

         *Cis* and *trans* chiral bonds can not be distinguished when the
         :oe:const:`OEGraphSim::OEFPBondType::Chiral` flag is set.
         Fingerprints generated for molecules ``C\C=C/C`` and ``C/C=C/C``
         will always be identical.
         (See example in :ref:`Figure: Example of molecule similarity of stereoisomers <figure_OEFPBondType_stereo>`).

      .. _figure_OEFPBondType_stereo:

      .. figure:: graphsimtk/images/OEFPBondTypeBondStereoHandling.*
         :align:  center

         **Example of molecule similarity of cis-trans stereoisomers**

   .. ###############################################################################

   .. oe:constant:: InRing

      This flag indicates that bond topology information is encoded into
      the generated fingerprint, *i.e.*, if two fragments (either
      circular, path or tree) are composed of bonds with different bond
      topology (the value returned by the
      :oe:meth:`OEChem::OEBondBase::IsInRing` method) then the two
      fragments will be mapped to different bits of the fingerprint.

      :ref:`Table: Example of using the InRing option<table_OEFPBondType_InRing>`
      demonstrates the effect of using the :oe:const:`OEGraphSim::OEFPBondType::InRing` flag.

      .. _table_OEFPBondType_InRing:

      .. list-table:: **Example of using the** :oe:const:`OEGraphSim::OEFPBondType::InRing` **option**
                      (:oe:const:`Path<OEGraphSim::OEFPType::Path>`, numbits=4096, bonds=0-5,
                      atom typing = :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>`).

         * - .. image:: ../images/OEFPBondTypeNotInRing.*
           - .. image:: ../images/OEFPBondTypeInRing.*

   .. ###############################################################################

   .. oe:constant:: DefaultBond

      Same as :oe:const:`OEGraphSim::OEFPBondType::DefaultPathBond` constant.

   .. ###############################################################################

   .. oe:constant:: DefaultCircularBond

      Same as the :oe:const:`OEGraphSim::OEFPBondType::BondOrder` constant.

      See example in :ref:`Figure: Circular fingerprint similarity with default circular atom and bond typing<figure_OEFPBondType_DefaultCircular>`.
      This constant is used as bond typing parameter when a default
      :oe:const:`Circular<OEGraphSim::OEFPType::Circular>` fingerprint is
      generated by the following functions:

      * :oe:func:`OEGraphSim::OEMakeFP` (:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` &,
        const :ref:`OEMolBase <OEChem_OEMolBase>` &, :oe:const:`OEGraphSim::OEFPType::Circular`)
      * :oe:func:`OEGraphSim::OEMakeCircularFP`

      .. seealso::

          * :oe:const:`OEGraphSim::OEFPAtomType::DefaultCircularAtom` constant

      .. _figure_OEFPBondType_DefaultCircular:

      .. figure:: graphsimtk/images/DefaultCircular.*
         :align:  center

   .. oe:constant:: DefaultCircularVSBond

      The default bond typing for the circular fingerprint that is designed for virtual
      screening. Currently it's the same as :oe:const:`OEGraphSim::OEFPBondType::DefaultCircularBond`.

   .. oe:constant:: DefaultCircularVSBond1

      Same as :oe:const:`OEGraphSim::OEFPBondType::DefaultCircularBond` constant.

   .. oe:constant:: DefaultCircularVSBond2

      Same as :oe:const:`OEGraphSim::OEFPBondType::DefaultCircularBond` constant.

   .. ###############################################################################

   .. oe:constant:: DefaultPathBond

      The bitwise OR'd value of the following bond typing options:

      * :oe:const:`OEGraphSim::OEFPBondType::BondOrder`
      * :oe:const:`OEGraphSim::OEFPBondType::Chiral`

      See example in :ref:`Figure: Path fingerprint similarity with default path atom and bond typing<figure_OEFPBondType_DefaultPath>`.
      This constant is used as bond typing parameter when a default
      :oe:const:`Path<OEGraphSim::OEFPType::Path>` fingerprint is
      generated by the following functions:

      * :oe:func:`OEGraphSim::OEMakeFP` (:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` &,
        const :ref:`OEMolBase <OEChem_OEMolBase>` &, :oe:const:`OEGraphSim::OEFPType::Path`)
      * :oe:func:`OEGraphSim::OEMakePathFP`

      .. seealso::

          * :oe:const:`OEGraphSim::OEFPAtomType::DefaultPathAtom` constant

      .. _figure_OEFPBondType_DefaultPath:

      .. figure:: graphsimtk/images/DefaultPath.*
         :align:  center

         **Path fingerprint similarity with default tree atom and bond typing**

   .. oe:constant:: DefaultPathVSBond

      The default bond typing for the tree fingerprint that is designed for virtual
      screening. Currently it's the same as :oe:const:`OEGraphSim::OEFPBondType::DefaultPathBond`.

   .. ###############################################################################

   .. oe:constant:: DefaultTreeBond

      Same as the :oe:const:`OEGraphSim::OEFPBondType::BondOrder` constant.

      See example in :ref:`Figure: Tree fingerprint similarity with default tree atom and bond typing<figure_OEFPBondType_DefaultTree>`.
      This constant is used as bond typing parameter when a default
      :oe:const:`Tree<OEGraphSim::OEFPType::Tree>` fingerprint is
      generated by the following functions:

      * :oe:func:`OEGraphSim::OEMakeFP` (:ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` &,
        const :ref:`OEMolBase <OEChem_OEMolBase>` &, :oe:const:`OEGraphSim::OEFPType::Tree`)
      * :oe:func:`OEGraphSim::OEMakeTreeFP`

      .. seealso::

          * :oe:const:`OEGraphSim::OEFPAtomType::DefaultTreeAtom` constant

      .. _figure_OEFPBondType_DefaultTree:

      .. figure:: graphsimtk/images/DefaultTree.*
         :align:  center

         **Tree fingerprint similarity with default tree atom and bond typing**

   .. oe:constant:: DefaultTreeVSBond

      The default bond typing for the tree fingerprint that is designed for virtual
      screening. Currently it's the same as :oe:const:`OEGraphSim::OEFPBondType::DefaultTreeBond`.

   .. ###############################################################################

   .. oe:constant:: None

      No bond properties are encoded when generating a fingerprint.



.. oe:namespace:: OEGraphSim

.. oe:constnamespace:: OEFPDatabaseOptionsSetup

   This namespace encodes symbolic constants used as bit-masks to
   indicate which highlighting interface parameters are being created
   when invoking the :oe:func:`OEGraphSim::OEConfigureFPDatabaseOptions`
   function.

   The :oe:constns:`OEGraphSim::OEFPDatabaseOptionsSetup` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEGraphSim::OEFPDatabaseOptionsSetup::Cutoff`
      * :oe:const:`OEGraphSim::OEFPDatabaseOptionsSetup::DescendingOrder`
      * :oe:const:`OEGraphSim::OEFPDatabaseOptionsSetup::Limit`
      * :oe:const:`OEGraphSim::OEFPDatabaseOptionsSetup::SimFunc`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Cutoff

      Passing this constant to the :oe:func:`OEGraphSim::OEConfigureFPDatabaseOptions` function
      result in generating the following default interface.

      ::

           Contents of parameter -cutoff
              Aliases : -c
              Type : float
              Allow list : false
              Default : (parameter does not have a default)
              Simple : true
              Required : false
              Brief : Similarity cutoff value
              Detail

                 API : OEFPDatabaseOptions::SetCutoff method
                 By default there is no similarity cutoff

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetCutoff` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DescendingOrder

      Passing this constant to the :oe:func:`OEGraphSim::OEConfigureFPDatabaseOptions` function
      result in generating the following default interface.

      ::

           Contents of parameter -descending
              Aliases : -d
              Type : bool
              Allow list : false
              Default : true
              Simple : true
              Required : false
              Brief : Order of similarity scores
              Detail

                 API : OEFPDatabaseOptions::SetDescendingOrder method
                 If true scores are returned in descending order otherwise in ascending order

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetDescendingOrder` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Limit

      Passing this constant to the :oe:func:`OEGraphSim::OEConfigureFPDatabaseOptions` function
      result in generating the following default interface.

      ::

           Contents of parameter -limit
              Aliases : -l
              Type : int
              Allow list : false
              Default : 10
              Simple : true
              Required : false
              Legal ranges :
                 100000 to 0
              Brief : Maximum number of similarity scores
              Detail

                 API : OEFPDatabaseOptions::SetLimit method
                 If set to zero, then all of the similarity scores are returned

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetLimit` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SimFunc

      Passing this constant to the :oe:func:`OEGraphSim::OEConfigureFPDatabaseOptions` function
      result in generating the following default interface.

      ::

           Contents of parameter -simfunc
              Aliases : -s
              Type : string
              Allow list : false
              Default : Tanimoto
              Simple : true
              Required : false
              Legal values : Tanimoto Cosine Dice Euclid Tversky Manhattan
              Brief : Similarity measure
              Detail

                 API : OEFPDatabaseOptions::SetSimFunc method and OESimMeasure namespace

      .. seealso::

         * :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetSimFunc` method


.. oe:namespace:: OEGraphSim

.. oe:constnamespace:: OEFPType

   This namespace contains constants representing various
   :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` types available in the **GraphSim TK**.

   .. seealso::

      * :oe:func:`OEGraphSim::OEMakeFP`

   .. oe:constant:: Circular

      This constant represents the circular fingerprint type.

      Circular fingerprints are generated by **exhaustively**
      enumerating **all** circular fragments grown radially from each
      heavy atom of the molecule up to the given radius and then
      hashing these fragments into a fixed-length bitvector.

   .. seealso::

      * :ref:`section_fingerprint_circular` section

   .. oe:constant:: Lingo

      This constant represents the LINGO fingerprint type.

   .. seealso::

      * :ref:`section_fingerprint_lingo` section
      * :term:`LINGO`

   .. oe:constant:: MACCS166

      This constant represents the MACCS key fingerprint type.

   .. seealso::

      * :ref:`section_fingerprint_maccs` section

   .. oe:constant:: Path

      This constant represents the path fingerprint type.

      Path fingerprints are generated by **exhaustively** enumerating
      **all** linear paths of a molecular graph up to a given size
      and then hashing these fragments into a fixed-length bitvector.

   .. seealso::

      * :ref:`section_fingerprint_path` section

   .. oe:constant:: Tree

      This constant represents the tree fingerprint type.

      A tree fingerprint is generated by **exhaustively** enumerating
      **all**  trees of a molecular graph up to a given size
      and then hashing these fragments into a fixed-length bitvector.

   .. seealso::

      * :ref:`section_fingerprint_tree` section


.. oe:namespace:: OEGraphSim

.. oe:constnamespace:: OEFastFPDatabaseMemoryType

   This namespace contains memory type constants representing how
   fingerprints are stored and searched for in an
   :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object.

   .. seealso::

      * :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class

   .. oe:constant:: Default

      The default memory type is
      :oe:const:`OEGraphSim::OEFastFPDatabaseMemoryType::MemoryMapped`.

   .. oe:constant:: CUDA

      If a CUDA-enabled GPU is available, :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>`
      can take advantage of the device for similarity calculations.
      When an :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` is initialized with the
      :oe:const:`OEGraphSim::OEFastFPDatabaseMemoryType::CUDA` type,
      similarity calculations are performed on the device. Initialization incurs a one-time load
      penalty, similar to :oe:const:`OEGraphSim::OEFastFPDatabaseMemoryType::InMemory`.

      **Requirements:**

      * :ref:`Prerequisites for OpenEye's GPU-accelerated software <graphsim_prereq_for_gpu>`
      * Fingerprint sizes of multiples of 1024 bits.

      .. note::

         At present, multi-GPU support is not available. If there are multiple CUDA 
         devices on the system, the first compatible device detected will be used.
         To enforce the use of a particular device, set the environment
         variable ``CUDA_VISIBLE_DEVICES``.

      .. note::

         If device memory limits are exceeded or a CUDA-enabled device is not detected this 
         implementation falls back to :oe:const:`OEGraphSim::OEFastFPDatabaseMemoryType::MemoryMapped`

   .. oe:constant:: InMemory

      When an :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` is initialized with
      :oe:const:`OEGraphSim::OEFastFPDatabaseMemoryType::InMemory` type
      the fingerprints are pre-loaded into memory and the similarity
      search performed in-memory when calling the
      :oe:meth:`OEGraphSim::OEFastFPDatabase::GetSortedScores` method.

      .. hint::

         :oe:const:`OEGraphSim::OEFastFPDatabaseMemoryType::InMemory` presents
         the fastest search at the expense of load time and the search is limited by
         the size of the memory.

   .. oe:constant:: MemoryMapped

      When an :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` is initialized with
      :oe:const:`OEGraphSim::OEFastFPDatabaseMemoryType::MemoryMapped`
      type there is no load time penalty or memory limitation but the
      search itself is slower.

   .. seealso::

      * Example code in :ref:`section_examples_summary_searchfastfp` section


.. _OEGraphSimConstants:

************************
OEGraphSim Constants
************************

.. oe:namespace:: OEGraphSim

.. toctree::

   OEFastFPDatabaseMemoryType
   OEFPAtomType
   OEFPBondType
   OEFPDatabaseOptionsSetup
   OEFPType
   OEPopCountMethod
   OESimMeasure
   OESimSearchStatus


.. oe:namespace:: OEGraphSim

.. oe:constnamespace:: OEPopCountMethod

   This namespace contains constants representing possible
   :term:`popcount` methods available in **GraphSim TK**.

   .. seealso::

      * :oe:func:`OEGraphSim::OEGetPopCountMethod` function
      * :oe:func:`OEGraphSim::OEIsFastFPDatabaseReady` function

   .. oe:constant:: BitCount

      The hardware does not support the :term:`popcount` method but only
      a slower bitcount method.

   .. oe:constant:: NoSupport

      No support available.

   .. oe:constant:: PopCount

      The fast :term:`popcount` method is available.


.. oe:namespace:: OEGraphSim

.. oe:constnamespace:: OESimMeasure

   This namespace contains constants representing the built-in
   similarity indices of the **GraphSim TK**.

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFPDatabase::SetSimFunc` method
      * :ref:`section_database_simfunc` section

   .. oe:constant:: Cosine

      This constant represents Cosine similarity index.

   .. seealso::

      * :ref:`section_measure_cosine` section
      * :oe:func:`OEGraphSim::OECosine` function

   .. oe:constant:: Dice

      This constant represents Dice similarity index.

   .. seealso::

      * :ref:`section_measure_dice` section
      * :oe:func:`OEGraphSim::OEDice` function

   .. oe:constant:: Euclid

      This constant represents the Euclidean similarity index.

   .. seealso::

      * :ref:`section_measure_euclid` section
      * :oe:func:`OEGraphSim::OEEuclid` function

   .. oe:constant:: Manhattan

      This constant represents the Manhattan similarity index.

   .. seealso::

      * :ref:`section_measure_manhattan` section
      * :oe:func:`OEGraphSim::OEManhattan` function

   .. oe:constant:: Tanimoto

      This constant represents the Tanimoto similarity index.

   .. seealso::

      * :ref:`section_measure_tanimoto` section
      * :oe:func:`OEGraphSim::OETanimoto` function
      * :ref:`OETanimotoSim <OEGraphSim_OETanimotoSim>` class

   .. oe:constant:: Tversky

      This constant represents the Tversky similarity index.

   .. seealso::

      * :ref:`section_measure_tversky` section
      * :oe:func:`OEGraphSim::OETversky` function
      * :ref:`OETverskySim <OEGraphSim_OETverskySim>` class


.. oe:namespace:: OEGraphSim

.. oe:constnamespace:: OESimSearchStatus

   This namespace contains constants representing the various status of the
   similarity search (:oe:meth:`OEChem::OESubSearchResult::GetSearchStatus`).

   .. oe:constant:: Finished

      This constant indicates that the similarity search finished successfully.

   .. oe:constant:: InProgress

      This constant indicates that the similarity search is in progress.

   .. oe:constant:: Uninitialized

      This constant indicates that the similarity search can not be
      initialized (for example, attempting a search on an invalid
      :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object).

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFastFPDatabase::SortedSearch` method
      * :oe:func:`OEGraphSim::OESimSearchStatusToName` function


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEAreCompatibleDatabases

.. oe:function:: OEAreCompatibleDatabases

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAreCompatibleDatabases(const OEChem::OEMolDatabase& moldb,
                                       const OEFastFPDatabase& fpdb)

   .. oe:language:: python

      .. oe:api:: python

         OEAreCompatibleDatabases(arg1: OEMolDatabase, arg2: OEFastFPDatabase) -> bool

   Returns whether a molecule database and a fingerprint database
   are constructed from the same molecule file.

   moldb
      The :ref:`OEMolDatabase <OEChem_OEMolDatabase>` object.

   fpdb
      The :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object.

   .. seealso::

      * :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function
      * :ref:`OEFastFPDatabaseParams <OEGraphSim_OEFastFPDatabaseParams>` class
      * Example code in :ref:`section_examples_summary_searchfastfp` section


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. oe:function:: OEConfigureFPDatabaseMemoryType

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureFPDatabaseMemoryType(OESystem::OEInterface& itf,
                                              unsigned int defvalue = OEFastFPDatabaseMemoryType::Default,
                                              std::string name = "-memorytype",
                                              std::string alias = "-m")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureFPDatabaseMemoryType(itf: OEInterface, defvalue: int,
                                         name: str = "-memorytype",
                                         alias: str = "-m") -> bool

   Adds a fingerprint database memory type parameter to the given interface.

   itf
     The interface being configured.

   *defvalue*
     Default parameter value.

   *name*
     The name of the parameter.

   *alias*
     The alternative *i.e.* alias name of the parameter.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEGraphSim::OEFastFPDatabaseMemoryType` namespace
      * :oe:func:`OEGraphSim::OEGetFPDatabaseMemoryType` function
      * Example code in :ref:`section_examples_summary_searchfastfp` section


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords:  OEConfigureFPDatabaseOptions

.. oe:function::  OEConfigureFPDatabaseOptions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureFPDatabaseOptions(OESystem::OEInterface& itf,
                                           const OEFPDatabaseOptions& defopts)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureFPDatabaseOptions(itf: OEInterface,
                                      defopts: OEFPDatabaseOptions) -> bool

   Configures the given interface to add parameters for fingerprint
   database search options.

   *itf*
      The interface being configured.

   *defopts*
      The default fingerprint database search options.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureFPDatabaseOptions(OESystem::OEInterface& itf,
                                           unsigned int config = OEFPDatabaseOptionsSetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureFPDatabaseOptions(itf: OEInterface, config: int) -> bool

   Configures the given interface to add parameters for default fingerprint
   database search options.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface.  This value has to be from the
      :oe:constns:`OEGraphSim::OEFPDatabaseOptionsSetup` namespace.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class
      * :oe:func:`OEGraphSim::OESetupFPDatabaseOptions` function
      * Example code in :ref:`section_examples_summary_searchfp` section
      * Example code in :ref:`section_examples_summary_searchfastfp` section


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEConfigureFingerPrint

.. oe:function:: OEConfigureFingerPrint

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureFingerPrint(OESystem::OEInterface& itf,
                                     const OEFPTypeBase* deffptype)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureFingerPrint(itf: OEInterface, deffptype: OEFPTypeBase) -> bool

   Configures the given interface to add the following parameters for user-defined
   fingerprint type:

   ::

     fingerprint options
      -atomtype : Fingerprint atom type
      -bondtype : Fingerprint bond type
      -fptype : Fingerprint type
      -maxdistance : Maximum number of bonds/radius in path/circular/tree
                     fingerprint
      -mindistance : Minimum number of bonds/radius in path/circular/tree
                     fingerprint
      -numbits : Size of bitvector

   *itf*
      The interface being configured.

   *deffptype*
      The default fingerprint type.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class
      * :oe:func:`OEGraphSim::OESetupFingerPrint` function
      * Example code in :ref:`section_examples_summary_makefastfp` section
      * Example code in :ref:`section_examples_summary_searchfp` section


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OECosine

.. oe:function:: OECosine

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OECosine(const OEFingerPrint& fpA, const OEFingerPrint& fpB)

   .. oe:language:: python

      .. oe:api:: python

         OECosine(fpA: OEFingerPrint, fpB: OEFingerPrint) -> float

   Calculates the Cosine similarity value of two
   :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects.

   **Formula:**
     :math:`Sim_{Cosine}(A,B) = \frac{bothAB}{\sqrt{(onlyA + bothAB) * (onlyB + bothAB)}}`

   .. seealso::

      * :ref:`section_measure_cosine` section



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OECreateFastFPDatabaseFile

.. oe:function:: OECreateFastFPDatabaseFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECreateFastFPDatabaseFile(const std::string& fpdbfname,
                                         const std::string& molfname,
                                         const OEFPTypeBase* fptype)
         bool OECreateFastFPDatabaseFile(const std::string& fpdbfname,
                                         const std::string& molfname,
                                         const OECreateFastFPDatabaseOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OECreateFastFPDatabaseFile(fpdbfname: str, molfname: str,
                                    fptype: OEFPTypeBase) -> bool
         OECreateFastFPDatabaseFile(fpdbfname: str, molfname: str,
                                    opts: OECreateFastFPDatabaseOptions) -> bool

   Generates a binary fingerprint file for the given molecule file.

   fpdbfname
     The name of the fingerprint file. The file name has to have a ``.fpbin``
     extension.

   molfname
     The name of the molecule file.

   fptype
     The type of the fingerprint that will be generated to each molecule.

   opts
     The :ref:`OECreateFastFPDatabaseOptions <OEGraphSim_OECreateFastFPDatabaseOptions>` object that
     encapsulates properties that determine how fingerprints are generated.

   .. note::

      **GraphSim TK** currently only supports the :term:`popcount`
      search method for fingerprints with the size of multiple of ``256``.
      This means that the :oe:const:`OEGraphSim::OEFPType::MACCS166`
      fingerprint type is currently not supported.
      When using other custom fingerprint types (see
      :ref:`chapter_user_defined` section)
      the size of the fingerprint must be a multiple of ``256`` in order to
      be able to search it with the :term:`popcount` method.

   .. figure:: graphsimtk/images/makefastfp.*
      :align:  center
      :width:  300pt

      **Schematic representation of fast fingerprint generation process**

   .. seealso::

      * :ref:`OEFastFPDatabaseParams <OEGraphSim_OEFastFPDatabaseParams>` class
      * Example code in :ref:`section_examples_summary_makefastfp` section


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEDice

.. oe:function:: OEDice

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEDice(const OEFingerPrint& fpA, const OEFingerPrint& fpB)

   .. oe:language:: python

      .. oe:api:: python

         OEDice(fpA: OEFingerPrint, fpB: OEFingerPrint) -> float

   Calculates the Dice similarity value of two
   :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects.

   **Formula:**
     :math:`Sim_{Dice}(A,B) = \frac{2 *bothAB}{onlyA + onlyB + 2 * bothAB}`

   .. seealso::

      * :ref:`section_measure_dice` section



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEEuclid

.. oe:function:: OEEuclid

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEEuclid(const OEFingerPrint& fpA, const OEFingerPrint& fpB)

   .. oe:language:: python

      .. oe:api:: python

         OEEuclid(fpA: OEFingerPrint, fpB: OEFingerPrint) -> float

   Calculates the Euclidean similarity value of two
   :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects.

   **Formula:**
     :math:`Sim_{Euclid}(A,B) = \sqrt{\frac{bothAB + neitherAB}{onlyA + onlyB + bothAB + neitherAB}}`

   .. seealso::

      * :ref:`section_measure_euclid` section


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEFPToNumpyArray

..  _OEGraphSim_OEFPToNumpyArray:

.. oe:function:: OEFPToNumpyArray

   .. attention::

      |PYTHONONLY|

   .. oe:api::

      def OEFPToNumpyArray(fp, numpyCheck: bool = True) -> "NumpyArray"
      def OEFPToNumpyArrayCpp(fp, numpyCheck: bool = True) -> "NumpyArray"

   Creates a NumPy array from the bits stored in an :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`.
   `OEFPToNumpyArray`` is completely done through Python, while `OEFPToNumpyArrayCpp` creates the
   array in C++ and converts it into a NumPy array. The user is required to have NumPy installed in
   their Python environment.

.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetBitCounts

.. oe:function:: OEGetBitCounts

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGetBitCounts(const OEFingerPrint& fpA,
                             const OEFingerPrint& fpB, unsigned int* onlyA,
                             unsigned int* onlyB, unsigned int* bothAB,
                             unsigned int* neitherAB)
   .. oe:language:: python

      .. oe:api::

         OEGetBitCounts(OEFingerPrint fpA, OEFingerPrint fpB) -> (onlyA, onlyB, bothAB, neitherAB)

   *fpA*, *pfB*
      The two :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects being compared.

   *onlyA*
      The number of bits set "on" in fingerprint *fpA* but not in *fpB*.

   *onlyB*
      The number of bits set "on" in fingerprint *fpB* but not in *fpA*.

   *bothAB*
      The number of bits set "on" in both :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects.

   *neitherAB*
      The number of bits unset in both :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects.

   .. seealso::

      * :ref:`section_measure_user_defined` section



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetCircularFPType

.. oe:function:: OEGetCircularFPType

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OEFPTypeBase* OEGetCircularFPType(unsigned int numbits,
                                                 unsigned int minradius,
                                                 unsigned int maxradius,
                                                 unsigned int atype,
                                                 unsigned int btype)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCircularFPType(numbits: int, minradius: int, maxradius: int,
                             atype: int, btype: int) -> OEFPTypeBase

   Returns an :oe:const:`OEGraphSim::OEFPType::Circular`
   fingerprint type generated with the given parameters.

   *numbits*
      |makefpnumbits|

   *minradius*, *maxradius*
      The smallest and largest circular fragments (in radius) that are
      enumerated during the fingerprint generation.
      All enumerated circular fragments are hashed into the
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object.

   *atype*
      |makefpatomtype|

   *btype*
      |makefpbondtype|

   .. seealso::

      * :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetFPAtomType

.. oe:function:: OEGetFPAtomType

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetFPAtomType(unsigned int value)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFPAtomType(value: int) -> str

   Returns the string representation of a value that is from the
   :oe:constns:`OEGraphSim::OEFPAtomType` namespace.
   For example, the string representation of
   :oe:const:`OEGraphSim::OEFPAtomType::AtomicNumber` |
   :oe:const:`OEGraphSim::OEFPAtomType::Aromaticity` value is the
   ``"AtmNum|Arom"`` string.

   .. table:: **The string representation of various fingerprint atom types**

      ===================================================== =======================
      Atom type                                             String representation  
      ===================================================== =======================
      :oe:const:`OEGraphSim::OEFPAtomType::AtomicNumber`    "AtmNum"               
      :oe:const:`OEGraphSim::OEFPAtomType::Aromaticity`     "Arom"                 
      :oe:const:`OEGraphSim::OEFPAtomType::Chiral`          "Chiral"               
      :oe:const:`OEGraphSim::OEFPAtomType::FormalCharge`    "FCharge"              
      :oe:const:`OEGraphSim::OEFPAtomType::HvyDegree`       "HvyDeg"               
      :oe:const:`OEGraphSim::OEFPAtomType::Hybridization`   "Hyb"                  
      :oe:const:`OEGraphSim::OEFPAtomType::InRing`          "InRing"               
      :oe:const:`OEGraphSim::OEFPAtomType::HCount`          "HCount"               
      :oe:const:`OEGraphSim::OEFPAtomType::EqAromatic`      "EqArom"               
      :oe:const:`OEGraphSim::OEFPAtomType::EqHalogen`       "EqHalo"               
      :oe:const:`OEGraphSim::OEFPAtomType::EqHBondAcceptor` "EqHBAcc"              
      :oe:const:`OEGraphSim::OEFPAtomType::EqHBondDonor`    "EqHBDon"              
      ===================================================== =======================

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetFPAtomType(const std::string& expression)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFPAtomType(expression: str) -> int

   This function is the inverse of the previous
   :oe:func:`OEGraphSim::OEGetFPAtomType` function *i.e.* it converts
   the string representation into a value from the
   :oe:constns:`OEGraphSim::OEFPAtomType` namespace.



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetFPBondType

.. oe:function:: OEGetFPBondType

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetFPBondType(unsigned int value)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFPBondType(value: int) -> str

   Returns the string representation of a value  that is from the
   :oe:constns:`OEGraphSim::OEFPBondType` namespace.
   For example, the string representation of
   :oe:const:`OEGraphSim::OEFPBondType::BondOrder` |
   :oe:const:`OEGraphSim::OEFPBondType::Chiral` value is the:
   ``"Order|Chiral"`` string.

   .. table:: **The string representation of various fingerprint bond types**

      =============================================== =======================
      Bond type                                       String representation  
      =============================================== =======================
      :oe:const:`OEGraphSim::OEFPBondType::BondOrder` "Order"                
      :oe:const:`OEGraphSim::OEFPBondType::Chiral`    "Chiral"               
      :oe:const:`OEGraphSim::OEFPBondType::InRing`    "InRing"               
      =============================================== =======================

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetFPBondType(const std::string& expression)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFPBondType(expression: str) -> int

   This function is the inverse of the previous
   :oe:func:`OEGraphSim::OEGetFPBondType` function *i.e.* it converts
   the string representation into a value from the
   :oe:constns:`OEGraphSim::OEFPBondType` namespace.



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetFPCoverage

.. oe:function:: OEGetFPCoverage

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEAtomBondSet>* OEGetFPCoverage(const OEChem::OEMolBase& mol,
                                                                      const OEFPTypeBase* fptype,
                                                                      bool unique = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFPCoverage(mol: Union[OEGraphMol,OEMol,OEQMol],
                         fptype: OEFPTypeBase, unique: bool = False) -> OEAtomBondSetIter

   Returns an iterator over the fragments that are generated when a
   fingerprint is constructed.

   *mol*
      The :ref:`OEMolBase <OEChem_OEMolBase>` objects from which the fingerprint
      fragments are generated.

   *fptype*
      The type of the fingerprint that also stores the parameters that
      are used when the fingerprint is generated.

   *unique*
      If true, then the :oe:func:`OEGraphSim::OEGetFPCoverage`
      function returns only unique fragments. A fragment (i.e. a subgraph)
      is considered unique if it differs from all other subgraphs
      identified previously by at least one atom or bond.

   .. note::

      The :oe:func:`OEGraphSim::OEGetFPCoverage` function is not
      available for the :oe:const:`OEGraphSim::OEFPType::Lingo`
      fingerprint type.

   .. seealso::

      * :ref:`chapter_coverage` chapter
      * :oe:func:`OEGraphSim::OEGetFPOverlap` function
      * :oe:func:`OEGraphSim::OEGetFPPatterns` function


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. oe:function:: OEGetFPDatabaseMemoryType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetFPDatabaseMemoryType(OESystem::OEInterface& itf,
                                                const std::string name = "-memorytype")

   .. oe:language:: python

      .. oe:api:: python

         OEGetFPDatabaseMemoryType(itf: OEInterface, name: str = "-memorytype") -> int

   Returns the fingerprint database memory type initialized in the given interface.

   *itf*
     The interface in which the parameter is configured.

   *name*
     The name of the parameter.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEGraphSim::OEFastFPDatabaseMemoryType` namespace
      * :oe:func:`OEGraphSim::OEConfigureFPDatabaseMemoryType` function
      * Example code in :ref:`section_examples_summary_searchfastfp` section



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetFPOverlap

.. oe:function:: OEGetFPOverlap

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEMatchBase>* OEGetFPOverlap(const OEChem::OEMolBase& qmol,
                                                                   const OEChem::OEMolBase& tmol,
                                                                   const OEFPTypeBase* fptype)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFPOverlap(qmol: Union[OEGraphMol,OEMol,OEQMol],
                        tmol: Union[OEGraphMol,OEMol,OEQMol],
                        fptype: OEFPTypeBase) -> Iterable[OEMatchBase]

   Returns an iterator over all **unique** matches (common fragments) found
   between two molecules based on the given fingerprint type.
   This means that these common molecular fragments are mapped into
   the same bit when fingerprints are generated with the given type.

   *qmol, tmol*
      The two :ref:`OEMolBase <OEChem_OEMolBase>` objects from which the fingerprint
      overlap is 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::OEGetFPOverlap` function is not
      available for the :oe:const:`OEGraphSim::OEFPType::Lingo`
      fingerprint type.

   .. note::

      Two matches are considered to be equivalent only if they store the same
      sets of target and pattern atoms and bonds. The correspondence
      between the pattern and target atoms and bonds are not considered.

   .. seealso::

      * :ref:`chapter_overlap` chapter
      * :oe:func:`OEGraphSim::OEGetFPCoverage` function
      * :oe:func:`OEGraphSim::OEGetFPPatterns` function


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. 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


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetFPType

.. oe:function:: OEGetFPType

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OEFPTypeBase* OEGetFPType(const unsigned int fptype,
                                         const bool vs = false,
                                         const unsigned vsversion = 1u)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFPType(fptype: int, vs: bool = False, vsVersion: int = 1) -> OEFPTypeBase

   Returns a *const* pointer of a default fingerprint type.

   *fptype*
      The type of the fingerprint. This value has to be from the
      :oe:constns:`OEGraphSim::OEFPType` namespace.

   *vs*
      If ``true`` and the fingerprint type is either :ref:`section_fingerprint_path`,
      :ref:`section_fingerprint_tree` or :ref:`section_fingerprint_circular`, then the
      atom and bond typings designed for virtual screening will be used.
      Any other cases this parameter will be ignored.

   *vsversion*
      The version for the virtual screening fingerprint. Passing a value of ``0u`` requests the
      latest version of the fingerprint from the current toolkit.  Supported values are
      ``1u`` (pre-2025.1 toolkits), and ``0u`` or  ``2u`` (post-2025.1 toolkits).

      .. note::

         The boolean argument signature for this function to request virtual screening
         fingerprints will be deprecated in favor of the explicit API
         function :oe:func:`OEGraphSim::OEGetVSFPType` in future toolkit releases.

      .. seealso::

         * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
         * :oe:constns:`OEGraphSim::OEFPBondType` namespace
         * :oe:func:`OEGraphSim::OEGetVSFPType`

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OEFPTypeBase* OEGetFPType(const std::string& fptypestring)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFPType(fptypestring: str) -> OEFPTypeBase

   Returns a *const* pointer of a fingerprint type of the given valid
   string representation.
   If the string representation is not valid, it will return a NULL
   pointer.

   .. seealso::

      * :oe:func:`OEGraphSim::OEIsValidFPTypeString` function
      * :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPTypeString` method
      * :ref:`OEFPTypeParams <OEGraphSim_OEFPTypeParams>` class
      * :oe:func:`OEGraphSim::OEGetCircularFPType` function
      * :oe:func:`OEGraphSim::OEGetPathFPType` function
      * :oe:func:`OEGraphSim::OEGetTreeFPType` function


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetFingerPrintVersion

.. oe:function:: OEGetFingerPrintVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned short OEGetFingerPrintVersion(unsigned int fptype)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFingerPrintVersion(fptype: int) -> short

   Returns the hashed number representation of the version number of
   a built-in fingerprint type.
   Please use the :oe:func:`OEGraphSim::OEGetFingerPrintVersionString`
   function to convert the returned number into human-readable
   representation.

   The :oe:func:`OEGraphSim::OEGetFingerPrintVersion` function returns
   zero and throws a warning for unknown fingerprint type.

   *fptype*
      The type of the fingerprint. This value has to be from the
      :oe:constns:`OEGraphSim::OEFPType` namespace.

   .. seealso::

      * :oe:func:`OEGraphSim::OEGetFingerPrintVersionString` function
      * :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPVersion` method
      * :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPVersionString` method


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetFingerPrintVersionString

.. oe:function:: OEGetFingerPrintVersionString

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetFingerPrintVersionString(unsigned short version)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFingerPrintVersionString(version: short) -> str

   Returns the string representation of a fingerprint version number
   returned by either  :oe:func:`OEGraphSim::OEGetFingerPrintVersion` function
   or :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPVersion` method.

   .. seealso::

      * :oe:func:`OEGraphSim::OEGetFingerPrintVersion` function
      * :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPVersion` method
      * :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPVersionString` method


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetPathFPType

.. oe:function:: OEGetPathFPType

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OEFPTypeBase* OEGetPathFPType(unsigned int numbits,
                                             unsigned int minbonds,
                                             unsigned int maxbonds,
                                             unsigned int atype,
                                             unsigned int btype)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPathFPType(numbits: int, minbonds: int, maxbonds: int,
                         atype: int, btype: int) -> OEFPTypeBase

   Returns an :oe:const:`OEGraphSim::OEFPType::Path`
   fingerprint type generated with the given parameters.

   *numbits*
      |makefpnumbits|

   *minbonds*, *maxbonds*
      The smallest and largest paths (in bonds) that are enumerated
      during the fingerprint generation.
      All enumerated paths are hashed into the
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object.

   *atype*
      |makefpatomtype|

   *btype*
      |makefpbondtype|

   .. seealso::

      * :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetPopCountMethod

.. oe:function:: OEGetPopCountMethod

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetPopCountMethod()

   .. oe:language:: python

      .. oe:api:: python

         OEGetPopCountMethod() -> int

   Returns whether :term:`popcount` method is supported on the hardware.
   The return value is taken from the :oe:constns:`OEGraphSim::OEPopCountMethod`
   namespace.

   .. seealso::

      * :oe:constns:`OEGraphSim::OEPopCountMethod` namespace
      * :oe:func:`OEGraphSim::OEIsFastFPDatabaseReady` function


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. oe:function:: OEGetSimilarityMeasureName

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetSimilarityMeasureName(unsigned int simtype)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSimilarityMeasureName(simtype: int) -> str

   Returns the string representation of a built-in similarity measure.

   **simtype**
     This value has to be from the :oe:constns:`OEGraphSim::OESimMeasure`
     namespace.


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetTreeFPType

.. oe:function:: OEGetTreeFPType

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OEFPTypeBase* OEGetTreeFPType(unsigned int numbits,
                                             unsigned int minbonds,
                                             unsigned int maxbonds,
                                             unsigned int atype,
                                             unsigned int btype)

   .. oe:language:: python

      .. oe:api:: python

         OEGetTreeFPType(numbits: int, minbonds: int, maxbonds: int,
                         atype: int, btype: int) -> OEFPTypeBase

   Returns an :oe:const:`OEGraphSim::OEFPType::Tree`
   fingerprint type generated with the given parameters.

   *numbits*
      |makefpnumbits|

   *minbonds*, *maxbonds*
      The smallest and largest tree fragments (in bonds) that are
      enumerated during the fingerprint generation.
      All enumerated tree fragments are hashed into the
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object.

   *atype*
      |makefpatomtype|

   *btype*
      |makefpbondtype|

   .. seealso::

      * :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetVSFPType

..  _oegraphsim_oegetvsfptype:

.. oe:function:: OEGetVSFPType

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OEFPTypeBase* OEGetVSFPType(const unsigned int fptype,
                                           const unsigned vsversion = 0u)

   .. oe:language:: python

      .. oe:api:: python

         OEGetVSFPType(fptype: int, vsVersion: int = 0) -> OEFPTypeBase

   This function returns a *const* pointer of a default virtual screening fingerprint type.

   *fptype*
      The type of the fingerprint. This value has to be from the
      :oe:constns:`OEGraphSim::OEFPType` namespace.
      If the fingerprint type is either :ref:`section_fingerprint_path`,
      :ref:`section_fingerprint_tree`, or :ref:`section_fingerprint_circular`, then the
      atom and bond typings designed for virtual screening will be used.
      Any other fingerprint types that have no virtual screening equivalent
      will emit an error and return null.

   *vsversion*
      The version for the virtual screening fingerprint. Passing a value of ``0u`` requests the
      latest version of the fingerprint from the current toolkit.  Supported values are
      ``1u`` (pre-2025.2 toolkits), and ``0u`` or  ``2u`` (2025.2 toolkits onwards).

      .. seealso::

         * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
         * :oe:constns:`OEGraphSim::OEFPBondType` namespace
         * :oe:func:`OEGraphSim::OEGetFPType`
         * :ref:`OEMakeVSFP <OEGraphSim_OEMakeVSFP>`



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGraphSimGetArch

.. oe:function:: OEGraphSimGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGraphSimGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEGraphSimGetArch() -> str



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGraphSimGetLicensee

.. oe:function:: OEGraphSimGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGraphSimGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEGraphSimGetLicensee(licensee: str) -> bool



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGraphSimGetPlatform

.. oe:function:: OEGraphSimGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGraphSimGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEGraphSimGetPlatform() -> str

   Returns the internal build string used by OpenEye, Cadence Molecular Sciences
   to identify a platform.  The format of these strings may change over
   time, and future distributions may contain different values even when
   using the same operating system, compiler and processor.  For example,
   on an ``x86_64`` Red Hat Enterprise Linux box this would return
   ``redhat-RHEL5-g++4.1-x64``.



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGraphSimGetRelease

.. oe:function:: OEGraphSimGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGraphSimGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEGraphSimGetRelease() -> str

   Returns the release name of the **GraphSim TK** library being used.  This
   returns a value similar to ``1.0`` for production versions of the
   library, and ``1.0 debug`` for the checking version of the library.


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGraphSimGetSite

.. oe:function:: OEGraphSimGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGraphSimGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEGraphSimGetSite(site: str) -> bool



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGraphSimGetVersion

.. oe:function:: OEGraphSimGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGraphSimGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEGraphSimGetVersion() -> int


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGraphSimIsLicensed

.. oe:function:: OEGraphSimIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGraphSimIsLicensed(const char* feature = 0,
                                   unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEGraphSimIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **GraphSim TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **GraphSim TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **GraphSim TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGraphsimIsGPUReady

..  _OEGraphSim_OEGraphsimIsGPUReady:

.. oe:function:: OEGraphsimIsGPUReady

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGraphsimIsGPUReady()

   .. oe:language:: python

      .. oe:api:: python

         OEGraphsimIsGPUReady() -> bool

   Determines whether a GPU is present and available for use on the current system.

   .. seealso::

      :ref:`graphsim_prereq_for_gpu` section in the *OEGraphSim TK* manual.


.. oe:namespace:: OEDataFlow

.. meta::
   :keywords: OEInitFPFieldHandler

.. oe:function:: OEInitFPFieldHandler

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEDataFlow::OEFieldTypeHandler* OEInitFPFieldHandler()

   .. oe:language:: python

      .. oe:api:: python

         OEInitFPFieldHandler() -> OEFieldTypeHandler

   Creates and returns the field type handler that enables
   :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects to be stored
   and retrieved as typed fields on record objects.
   Call this function once at startup to register fingerprint support
   for use with the **Platform TK** data record system.

   The caller takes ownership of the returned handler.

   .. seealso::

      * :oe:func:`OEDataFlow::OEInitFPVecFieldHandler` function


.. oe:namespace:: OEDataFlow

.. meta::
   :keywords: OEInitFPVecFieldHandler

.. oe:function:: OEInitFPVecFieldHandler

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEDataFlow::OEFieldTypeHandler* OEInitFPVecFieldHandler()

   .. oe:language:: python

      .. oe:api:: python

         OEInitFPVecFieldHandler() -> OEFieldTypeHandler

   Creates and returns the field type handler that enables vectors of
   :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects to be stored
   and retrieved as typed fields on record objects.
   Call this function once at startup to register fingerprint vector support
   for use with the **Platform TK** data record system.

   The caller takes ownership of the returned handler.

   .. seealso::

      * :oe:func:`OEDataFlow::OEInitFPFieldHandler` function


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEIsFPType

.. oe:function:: OEIsFPType

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsFPType(const OEFingerPrint& fp, unsigned int fptype)

   .. oe:language:: python

      .. oe:api:: python

         OEIsFPType(fp: OEFingerPrint, fptype: int) -> bool

   Returns true if the given :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`
   object's fingerprint type is identical to ``fptype``.
   ``fptype`` has to be a value from the
   :oe:constns:`OEGraphSim::OEFPType` namespace.

   .. seealso::

      * :oe:func:`OEGraphSim::OEIsSameFPType` function



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEIsFastFPDatabaseReady

.. oe:function:: OEIsFastFPDatabaseReady

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsFastFPDatabaseReady()

   .. oe:language:: python

      .. oe:api:: python

         OEIsFastFPDatabaseReady() -> bool

   Returns whether any fast fingerprint (pop count) method supported on
   the hardware.

   .. seealso::

      * :oe:func:`OEGraphSim::OEGetPopCountMethod` function


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEIsSameFPType

.. oe:function:: OEIsSameFPType

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsSameFPType(const OEFingerPrint& fpA, const OEFingerPrint& fpB)

   .. oe:language:: python

      .. oe:api:: python

         OEIsSameFPType(fpA: OEFingerPrint, fpB: OEFingerPrint) -> bool

   Returns whether or not the types (:ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`)
   of the two :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects are the same.

   .. note::

      Two user-defined path fingerprints have the same type only
      if they have been generated with the same parameters (*i.e.* number
      of bits, minimum and maximum path size and atom and bond typing
      options) and have the same version number.

   .. warning::

      Similarity measure functions (such as :oe:func:`OEGraphSim::OETanimoto`)
      only work on fingerprints with identical type
      (:ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`).



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEIsValidFPTypeString

.. oe:function:: OEIsValidFPTypeString

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsValidFPTypeString(const std::string& fptypestring)

   .. oe:language:: python

      .. oe:api:: python

         OEIsValidFPTypeString(fptypestring: str) -> bool

   Returns true if the given string is a valid representation of
   any available fingerprint types.

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPTypeString` method



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEMakeCircularFP

.. oe:function:: OEMakeCircularFP

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeCircularFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeCircularFP(fp: OEFingerPrint,
                          mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Generates the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object as a
   :ref:`section_fingerprint_circular` fingerprint using default
   parameters.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   The following code snippet shows how to print out the string representation of
   a :oe:const:`OEGraphSim::OEFPType::Circular` fingerprint.
   This string encodes information about default parameters used to generate
   a :oe:const:`OEGraphSim::OEFPType::Circular` fingerprint.

   .. oe:source:: CircularFPDefaultParams.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-CIRCULAR-DEFAULT-PARAMS

   .. oe:source:: CircularFPDefaultParams.py
      :language: python
      :noindent:
      :frag:     SNIPPET-CIRCULAR-DEFAULT-PARAMS

   ..  oe:language:: python

        :ref:`Full listing. <listing-CircularFPDefaultParams.py>`

   .. oe:source:: CircularFPDefaultParams.java
      :language: java
      :noindent:
      :frag:     SNIPPET-CIRCULAR-DEFAULT-PARAMS

   .. oe:source:: CircularFPDefaultParams.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-CIRCULAR-DEFAULT-PARAMS

   The output of the above code snippet is:

   .. code-block:: console

      Circular,ver=2.0.0,size=4096,radius=0-5,atype=AtmNum|Arom|Chiral|FCharge|HCount|EqHalo,btype=Order

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPTypeString` method

   .. ############################################################################

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeCircularFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol,
                               unsigned int numbits, unsigned int minradius,
                               unsigned int maxradius, unsigned int atype,
                               unsigned int btype)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeCircularFP(fp: OEFingerPrint,
                          mol: Union[OEGraphMol,OEMol,OEQMol], numbits: int,
                          minradius: int, maxradius: int, atype: int,
                          btype: int) -> bool

   Generates the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object as a
   :ref:`section_fingerprint_circular` fingerprint using the given
   parameters.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   *numbits*
      |makefpnumbits|

   *minradius*, *maxradius*
      The smallest and largest circular fragments (in radius) that are
      enumerated during the fingerprint generation.
      All enumerated circular fragments are hashed into the
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object.

   *atype*
      |makefpatomtype|

   *btype*
      |makefpbondtype|

   .. note::

      For an empty molecule, both :oe:func:`OEGraphSim::OEMakeCircularFP`
      function will return ``false`` and the type of the fingerprint
      will be set to ``0``
      (:oe:meth:`OEGraphSim::OEFingerPrint::GetFPTypeBase`).

   .. seealso::

      * :ref:`chapter_user_defined` chapter
      * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
      * :oe:constns:`OEGraphSim::OEFPBondType` namespace



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEMakeFP

.. oe:function:: OEMakeFP

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol,
                       const unsigned fptype, const bool vs = false)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeFP(fp: OEFingerPrint, mol: Union[OEGraphMol,OEMol,OEQMol],
                  fptype: int, vs: bool = False) -> bool

   Generates a fingerprint from the given molecule.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   *fptype*
      The type of the fingerprint. This value has to be from the
      :oe:constns:`OEGraphSim::OEFPType` namespace.

   *vs*
      If ``true`` and the fingerprint type is either :ref:`section_fingerprint_path`,
      :ref:`section_fingerprint_tree` or :ref:`section_fingerprint_circular`, then the
      atom and bond typings designed for virtual screening will be used.
      Any other cases this parameter will be ignored.

      .. note::

         The boolean argument signature for this function to request virtual screening
         fingerprints will be deprecated in favor of the explicit API
         function :oe:func:`OEGraphSim::OEMakeVSFP` in future toolkit releases.

      .. seealso::

         * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
         * :oe:constns:`OEGraphSim::OEFPBondType` namespace
         * :oe:func:`OEGraphSim::OEMakeVSFP`

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol,
                       const OEFPTypeBase* fptype)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeFP(fp: OEFingerPrint, mol: Union[OEGraphMol,OEMol,OEQMol],
                  fptype: OEFPTypeBase) -> bool

   Generates a fingerprint from the given molecule.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   *fptype*
      The type of the fingerprint specified by an
      :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` pointer.

   .. note::

      For an empty molecule, both :oe:func:`OEGraphSim::OEMakeFP`
      function will return ``false`` and the type of the fingerprint
      will be set to ``0``
      (:oe:meth:`OEGraphSim::OEFingerPrint::GetFPTypeBase`).



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEMakeLingoFP

.. oe:function:: OEMakeLingoFP

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeLingoFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeLingoFP(fp: OEFingerPrint, mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Generates the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object as a
   :ref:`section_fingerprint_lingo` fingerprint.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   .. note::

      For an empty molecule, the :oe:func:`OEGraphSim::OEMakeLingoFP`
      function will return ``false`` and the type of the fingerprint
      will be set to ``0``
      (:oe:meth:`OEGraphSim::OEFingerPrint::GetFPTypeBase`).

   .. seealso::

      * :ref:`section_fingerprint_lingo` section


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEMakeMACCS166FP

.. oe:function:: OEMakeMACCS166FP

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeMACCS166FP(OEFingerPrint& fp, const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeMACCS166FP(fp: OEFingerPrint,
                          mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Generates the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object as a
   :ref:`section_fingerprint_maccs` fingerprint.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   .. note::

      For an empty molecule, the :oe:func:`OEGraphSim::OEMakeMACCS166FP`
      function will return ``false`` and the type of the fingerprint
      will be set to ``0``
      (:oe:meth:`OEGraphSim::OEFingerPrint::GetFPTypeBase`).

   .. seealso::

      * :ref:`section_fingerprint_maccs` section


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEMakePathFP

.. oe:function:: OEMakePathFP

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakePathFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMakePathFP(fp: OEFingerPrint, mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Generates the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object as a
   :ref:`section_fingerprint_path` fingerprint using default
   parameters.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   The following code snippet shows how to print out the string representation of
   a :oe:const:`OEGraphSim::OEFPType::Path` fingerprint.
   This string encodes information about default parameters used to generate
   a :oe:const:`OEGraphSim::OEFPType::Path` fingerprint.

   .. oe:source:: PathFPDefaultParams.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-PATH-DEFAULT-PARAMS

   .. oe:source:: PathFPDefaultParams.py
      :language: python
      :noindent:
      :frag:     SNIPPET-PATH-DEFAULT-PARAMS

   ..  oe:language:: python

        :ref:`Full listing. <listing-PathFPDefaultParams.py>`

   .. oe:source:: PathFPDefaultParams.java
      :language: java
      :noindent:
      :frag:     SNIPPET-PATH-DEFAULT-PARAMS

   .. oe:source:: PathFPDefaultParams.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-PATH-DEFAULT-PARAMS

   The output of the above code snippet is:

   .. code-block:: console

      Path,ver=2.0.0,size=4096,bonds=0-5,atype=AtmNum|Arom|Chiral|FCharge|HvyDeg|Hyb|EqHalo,btype=Order|Chiral

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPTypeString` method

   .. ############################################################################

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakePathFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol,
                           unsigned int numbits, unsigned int minbonds,
                           unsigned int maxbonds, unsigned int atype,
                           unsigned int btype)

   .. oe:language:: python

      .. oe:api:: python

         OEMakePathFP(fp: OEFingerPrint, mol: Union[OEGraphMol,OEMol,OEQMol],
                      numbits: int, minbonds: int, maxbonds: int, atype: int,
                      btype: int) -> bool

   Generates the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object as a
   :ref:`section_fingerprint_path` fingerprint using the given
   parameters.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   *numbits*
      |makefpnumbits|

   *minbonds*, *maxbonds*
      The smallest and largest paths (in bonds) that are enumerated
      during the fingerprint generation.
      All enumerated paths are hashed into the
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object.

   *atype*
      |makefpatomtype|

   *btype*
      |makefpbondtype|

   .. note::

      For an empty molecule, both :oe:func:`OEGraphSim::OEMakePathFP`
      function will return ``false`` and the type of the fingerprint
      will be set to ``0``
      (:oe:meth:`OEGraphSim::OEFingerPrint::GetFPTypeBase`).

   .. seealso::

      * :ref:`chapter_user_defined` chapter
      * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
      * :oe:constns:`OEGraphSim::OEFPBondType` namespace



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEMakeTreeFP

.. oe:function:: OEMakeTreeFP

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeTreeFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeTreeFP(fp: OEFingerPrint, mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Generates the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object as a
   :ref:`section_fingerprint_tree` fingerprint using default
   parameters.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   The following code snippet shows how to print out the string representation of
   a :oe:const:`OEGraphSim::OEFPType::Tree` fingerprint.
   This string encodes information about default parameters used to generate
   a :oe:const:`OEGraphSim::OEFPType::Tree` fingerprint.

   .. oe:source:: TreeFPDefaultParams.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-TREE-DEFAULT-PARAMS

   .. oe:source:: TreeFPDefaultParams.py
      :language: python
      :noindent:
      :frag:     SNIPPET-TREE-DEFAULT-PARAMS

   ..  oe:language:: python

        :ref:`Full listing. <listing-TreeFPDefaultParams.py>`

   .. oe:source:: TreeFPDefaultParams.java
      :language: java
      :noindent:
      :frag:     SNIPPET-TREE-DEFAULT-PARAMS

   .. oe:source:: TreeFPDefaultParams.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-TREE-DEFAULT-PARAMS

   The output of the above code snippet is:

   .. code-block:: console

      Tree,ver=2.0.0,size=4096,bonds=0-4,atype=AtmNum|Arom|Chiral|FCharge|HvyDeg|Hyb,btype=Order

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPTypeString` method

   .. ############################################################################

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeTreeFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol,
                           unsigned int numbits, unsigned int minbonds,
                           unsigned int maxbonds, unsigned int atype,
                           unsigned int btype)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeTreeFP(fp: OEFingerPrint, mol: Union[OEGraphMol,OEMol,OEQMol],
                      numbits: int, minbonds: int, maxbonds: int, atype: int,
                      btype: int) -> bool

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   *numbits*
      |makefpnumbits|

   *minbonds*, *maxbonds*
      The smallest and largest tree fragments (in bonds) that are
      enumerated during the fingerprint generation.
      All enumerated tree fragments are hashed into the
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object.

   *atype*
      |makefpatomtype|

   *btype*
      |makefpbondtype|

   .. note::

      For an empty molecule, both :oe:func:`OEGraphSim::OEMakeTreeFP`
      function will return ``false`` and the type of the fingerprint
      will be set to ``0``
      (:oe:meth:`OEGraphSim::OEFingerPrint::GetFPTypeBase`).

   .. seealso::

      * :ref:`chapter_user_defined` chapter
      * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
      * :oe:constns:`OEGraphSim::OEFPBondType` namespace



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEMakeVSFP

..  _OEGraphSim_OEMakeVSFP:

.. oe:function:: OEMakeVSFP

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeVSFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol,
                         const unsigned fptype, const unsigned vsversion = 0u)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeVSFP(fp: OEFingerPrint, mol: Union[OEGraphMol,OEMol,OEQMol],
                    fptype: int, vsVersion: int = 0) -> bool

   This function generates a virtual screening fingerprint from the given molecule for the requested fingerprint type.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   *fptype*
      The type of the fingerprint. This value has to be from the
      :oe:constns:`OEGraphSim::OEFPType` namespace.
      If the fingerprint type is either :ref:`section_fingerprint_path`,
      :ref:`section_fingerprint_tree`, or :ref:`section_fingerprint_circular`, then the
      atom and bond typings designed for virtual screening will be used.
      Any other fingerprint types that have no virtual screening equivalent simply return
      the requested non-VS fingerprint.

   *vsversion*
      The version for the virtual screening fingerprint. Passing a value of ``0u`` requests the
      latest version of the fingerprint from the current toolkit.  Supported values are
      ``1u`` (pre-2025.2 toolkits), and ``0u`` or  ``2u`` (2025.2 toolkits onwards).

      .. seealso::

         * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
         * :oe:constns:`OEGraphSim::OEFPBondType` namespace
         * :oe:func:`OEGraphSim::OEMakeFP`
         * :ref:`OEGetVSFPType <OEGraphSim_OEGetVSFPType>`



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEManhattan

.. oe:function:: OEManhattan

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEManhattan(const OEFingerPrint& fpA, const OEFingerPrint& fpB)

   .. oe:language:: python

      .. oe:api:: python

         OEManhattan(fpA: OEFingerPrint, fpB: OEFingerPrint) -> float

   Calculates the Manhattan similarity value of two
   :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects.

   **Formula:**
     :math:`Sim_{Manhattan}(A,B) = \frac{onlyA + onlyB}{onlyA + onlyB + bothAB + neitherAB}`

   .. seealso::

      * :ref:`section_measure_manhattan` section



.. oe:namespace:: OEDataFlow

.. meta::
   :keywords: OESetFingerPrintValue

.. oe:function:: OESetFingerPrintValue

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetFingerPrintValue(OERecord& rec,
                                    const OEField<OEGraphSim::OEFingerPrint>& field,
                                    const OEGraphSim::OEFingerPrint& fp)

   .. oe:language:: python

      .. oe:api:: python

         OESetFingerPrintValue(rec: OERecord, field: OEFingerPrintField,
                               fp: OEFingerPrint) -> bool

   Sets a fingerprint value on a record.

   *rec*
      The record on which the fingerprint value is set.

   *field*
      The field descriptor that identifies the fingerprint field on the record.

   *fp*
      The fingerprint to store.

   Returns ``true`` if the value was successfully stored.


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OESetupFPDatabaseOptions

.. oe:function:: OESetupFPDatabaseOptions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupFPDatabaseOptions(OEFPDatabaseOptions& opts,
                                       const OESystem::OEInterface& itf)

   .. oe:language:: python

      .. oe:api:: python

         OESetupFPDatabaseOptions(opts: OEFPDatabaseOptions, itf: OEInterface) -> bool

   Initializes an :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>`
   object from the parameters of a given interface.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class
      * :oe:func:`OEGraphSim::OEConfigureFPDatabaseOptions` function
      * Example code in :ref:`section_examples_summary_searchfp` section
      * Example code in :ref:`section_examples_summary_searchfastfp` section


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OESetupFingerPrint

.. oe:function:: OESetupFingerPrint

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OEFPTypeBase* OESetupFingerPrint(const OESystem::OEInterface& itf)

   .. oe:language:: python

      .. oe:api:: python

         OESetupFingerPrint(itf: OEInterface) -> OEFPTypeBase

   Initializes an :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`
   object from the parameters of a given interface.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class
      * :oe:func:`OEGraphSim::OEConfigureFingerPrint` function
      * Example code in :ref:`section_examples_summary_makefastfp` section
      * Example code in :ref:`section_examples_summary_searchfp` section


.. oe:namespace:: OEGraphSim

.. oe:function:: OESimSearchStatusToName

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OESimSearchStatusToName(const unsigned status)

   .. oe:language:: python

      .. oe:api:: python

         OESimSearchStatusToName(status: int) -> str

   Returns the string representation of the constants in the
   :oe:constns:`OEGraphSim::OESimSearchStatus` namespace.

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFastFPDatabase::SortedSearch` method


.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OETanimoto

.. oe:function:: OETanimoto

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OETanimoto(const OEFingerPrint& fpA, const OEFingerPrint& fpB)

   .. oe:language:: python

      .. oe:api:: python

         OETanimoto(fpA: OEFingerPrint, fpB: OEFingerPrint) -> float

   Calculates the :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>`
   similarity value of two :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects.

   **Formula:**
     :math:`Sim_{Tanimoto}(A,B) = \frac{bothAB}{|A| + |B| - bothAB} = \frac{bothAB}{onlyA + onlyB + bothAB}`

   .. seealso::

      * :ref:`section_measure_tanimoto` section



.. |product|  replace:: GraphSim TK

.. |makefp| replace::  The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object that is being initialized.

.. |makefpmol| replace::  The :ref:`OEMolBase <OEChem_OEMolBase>` object from which the fingerprint is generated. Aromaticity must be perceived before calling this function (e.g. via :oe:func:`OEChem::OEAssignAromaticFlags`).

.. |makefpnumbits| replace::  The size of the fingerprint in bits. This number has to be larger than or equal to :math:`2^4` and smaller than :math:`2^{16}`.

.. |makefpatomtype| replace::  Defines which atom properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPAtomType` namespace.

.. |makefpbondtype| replace::  Defines which bond properties are encoded during the fingerprint generation. This value has to be either a value or a set of bitwise OR'd values from the :oe:constns:`OEGraphSim::OEFPBondType` namespace.


.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OETversky

.. oe:function:: OETversky

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OETversky(const OEFingerPrint& fpA, const OEFingerPrint& fpB,
                         float a, float b)

   .. oe:language:: python

      .. oe:api:: python

         OETversky(fpA: OEFingerPrint, fpB: OEFingerPrint, a: float, b: float) -> float

   Calculates the :oe:const:`Tversky<OEGraphSim::OESimMeasure::Tversky>`
   similarity value of two :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` objects.

   **Formula:**
     :math:`Sim_{Tversky}(A,B) = \frac{bothAB}{\alpha * onlyA + \beta * onlyB + bothAB}`

   .. seealso::

      * :ref:`section_measure_tversky` section



*******************************************************************************
OEGraphSim Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEAreCompatibleDatabases.rst
   OEConfigureFPDatabaseMemoryType.rst
   OEConfigureFPDatabaseOptions.rst
   OEConfigureFingerPrint.rst
   OECosine.rst
   OECreateFastFPDatabaseFile.rst
   OEDice.rst
   OEEuclid.rst
   OEGetBitCounts.rst
   OEGetCircularFPType.rst
   OEGetFPAtomType.rst
   OEGetFPBondType.rst
   OEGetFPCoverage.rst
   OEGetFPDatabaseMemoryType.rst
   OEGetFPOverlap.rst
   OEGetFPPatterns.rst
   OEGetFPType.rst
   OEGetFingerPrintVersion.rst
   OEGetFingerPrintVersionString.rst
   OEGetPathFPType.rst
   OEGetPopCountMethod.rst
   OEGetSimilarityMeasureName.rst
   OEGetTreeFPType.rst
   OEGetVSFPType.rst
   OEGraphSimGetArch.rst
   OEGraphSimGetLicensee.rst
   OEGraphSimGetPlatform.rst
   OEGraphSimGetRelease.rst
   OEGraphSimGetSite.rst
   OEGraphSimGetVersion.rst
   OEGraphSimIsLicensed.rst
   OEGraphsimIsGPUReady.rst
   OEInitFPFieldHandler.rst
   OEInitFPVecFieldHandler.rst
   OEIsFPType.rst
   OEIsFastFPDatabaseReady.rst
   OEIsSameFPType.rst
   OEIsValidFPTypeString.rst
   OEMakeCircularFP.rst
   OEMakeFP.rst
   OEMakeLingoFP.rst
   OEMakeMACCS166FP.rst
   OEMakePathFP.rst
   OEMakeTreeFP.rst
   OEMakeVSFP.rst
   OEManhattan.rst
   OESetFingerPrintValue.rst
   OESetupFPDatabaseOptions.rst
   OESetupFingerPrint.rst
   OESimSearchStatusToName.rst
   OETanimoto.rst
   OETversky.rst
   OEFPToNumpyArray.rst


.. _oegraphsim_part_api:

********************************
API
********************************

.. toctree::
   :maxdepth: 2

   OEGraphSimClasses/OEGraphSimClasses
   OEGraphSimConstants/OEGraphSimConstants
   OEGraphSimFunctions/index




.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. _oegraphsim_chapter_cookbook_examples:

********************************************************************************
Python Cookbook Examples
********************************************************************************

There are large number of code examples available in
`OpenEye Python Cookbook <http://docs.eyesopen.com/python_modules/cookbook/index.html>`_
that use **OpenEye Toolkits** to solve a wide range of cheminformatics and molecular
modeling problems.

* `2D Depiction <http://docs.eyesopen.com/python_modules/cookbook/depiction/depiction.html>`_ chapter
  contains examples that illustrate how the **OEDepict TK** and **Grapheme TK** can be
  utilized to depict molecules and visualize properties calculated with other OpenEye toolkits.

* `Visualizing 3D Information <http://docs.eyesopen.com/python_modules/cookbook/visualization/visualization.html>`_
  chapter contains examples that illustrate how the **Grapheme TK** can be utilized to project
  complex 3D information into the 2D molecular graph.

* `Cheminformatics <https://docs.eyesopen.com/python_modules/cookbook/cheminfo/cheminfo.html>`_
  chapter contains examples that solve various cheminformatics problems such as similarity search,
  ring perception and manipulating molecular graphs.

* `Peptide Informatics <https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptideinfo.html>`_
  chapter contains examples that solve various peptide informatics problems such as generating custom monomer sets,
  parsing and generating :term:`HELM` representations, and visualizing peptides.


.. admonition:: OpenEye Python Cookbook examples using OEGraphSim TK

   * `Similarity Searching of Large Molecule Files`_
   * `Rapid Similarity Searching of Large Molecule File`_
   * `Finding Core Fragment of a Molecule Series`_
   * `Depicting Molecule Similarity Based on Fingerprints`_
   * `Drawing Fingerprint Score Histogram`_


.. _chapter_coverage:

********************************************************************************
Fingerprint Coverage
********************************************************************************

Fingerprints are usually generated by enumerating various fragments (patterns)
of a molecule and then hashing them into a fixed-length bitvector.
The :oe:func:`OEGraphSim::OEGetFPCoverage` function provides access to these
fragments by returning an iterator over :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` objects,
each of which storing the atoms and bonds of a specific fragment.

.. seealso::

   * :ref:`chapter_patterns` chapter that shows how to access more information about
     the fragments enumerated during the fingerprint generation

The following example shows how the retrieve the unique fragments that
are enumerated when generating a path fingerprint.
The obtained fragments are depicted in
:ref:`Table: Example of path fragments<table_coverage_path_unique>`

..  oe:source:: FPCoverage.py
    :language: python
    :refnum:   17
    :caption:  Example of accessing patterns encoded into a fingerprint
    :frag:     SNIPPET-COVERAGE

..  oe:language:: python

    :ref:`Full listing. <listing-FPCoverage.py>`

.. oe:source:: FPCoverage.cpp
   :language: c++
   :refnum:   17
   :caption:  Example of accessing patterns encoded into a fingerprint
   :frag:     SNIPPET-COVERAGE

.. oe:source:: FPCoverage.java
   :language: java
   :refnum:   17
   :caption:  Example of accessing patterns encoded into a fingerprint
   :frag:     SNIPPET-COVERAGE

.. oe:source:: FPCoverage.cs
   :language: csharp
   :refnum:   17
   :caption:  Example of accessing patterns encoded into a fingerprint
   :frag:     SNIPPET-COVERAGE

The output of :oe:src:`Listing 17<SNIPPET-COVERAGE-FPCoverage>` is the following:

::

   1  0 C
   2  0 C  1 C
   3  0 C  1 C  2 N
   4  0 C  1 C  2 N  3 C
   5  0 C  1 C  2 N  3 C  4 C
   6  1 C
   7  1 C  2 N
   8  1 C  2 N  3 C
   9  1 C  2 N  3 C  4 C
  10  2 N

.. _table_coverage_path_unique:

.. list-table:: **Example of unique path fragments.** The numbers displayed next to atoms are the atom indices.
   :widths: 150 150 150
   :header-rows: 0

   * - .. image:: images/FPCoverage-01.*
          :align:  center
     - .. image:: images/FPCoverage-02.*
          :align:  center
     - .. image:: images/FPCoverage-03.*
          :align:  center
   * - .. image:: images/FPCoverage-04.*
          :align:  center
     - .. image:: images/FPCoverage-05.*
          :align:  center
     - .. image:: images/FPCoverage-06.*
          :align:  center
   * - .. image:: images/FPCoverage-07.*
          :align:  center
     - .. image:: images/FPCoverage-08.*
          :align:  center
     - .. image:: images/FPCoverage-09.*
          :align:  center
   * - .. image:: images/FPCoverage-10.*
          :align:  center
     -
     -

The :oe:func:`OEGraphSim::OEGetFPCoverage` function in the
:oe:src:`Listing 17<SNIPPET-COVERAGE-FPCoverage>` example is called with a unique options.
This means that it returns only unique fragments, where a fragment
(*i.e.* subgraph) is considered unique, if it differs from all other
subgraphs identified previously by at least one atom or bond.
For example, executing the same code with a non-unique option would
generate five additional paths depicted in
:ref:`Table:  Example of additional non-unique path fragments<table_coverage_path_non_unique>`

.. _table_coverage_path_non_unique:

.. list-table:: **Example of additional non-unique path fragments.** The numbers displayed next to atoms are the atom indices.
   :widths: 150 150 150
   :header-rows: 0

   * - .. image:: images/FPCoverage-NonUnique-11.*
          :align:  center
     - .. image:: images/FPCoverage-NonUnique-12.*
          :align:  center
     - .. image:: images/FPCoverage-NonUnique-13.*
          :align:  center
   * - .. image:: images/FPCoverage-NonUnique-14.*
          :align:  center
     - .. image:: images/FPCoverage-NonUnique-15.*
          :align:  center
     -

.. seealso::

   * :oe:func:`OEGraphSim::OEGetFPOverlap` function
   * :ref:`chapter_overlap` chapter


.. _chapter_database:

********************************************************************************
Fingerprint Database
********************************************************************************

The following four examples perform the same task, detailed below:

#. reading a query structure
#. printing out the similarity score between the fingerprint
   of this query and the fingerprint generated for each molecule read
   from a database file.

In :oe:src:`Listing 9<SNIPPET-CALC-FROM-FILE-SimCalcFromFile>`, after importing the query
structure and generating its path fingerprint, the program loops over
the database file creating a path fingerprint for each structure.
Then the program calculates the Tanimoto similarity between the
fingerprint of the query and the database entry by calling the
:oe:func:`OEGraphSim::OETanimoto` function.

.. oe:source:: SimCalcFromFile.cpp
   :language: c++
   :refnum:   9
   :caption:  Similarity calculation from file
   :frag:     SNIPPET-CALC-FROM-FILE

.. oe:source:: SimCalcFromFile.py
   :refnum:   9
   :caption:  Similarity calculation from file
   :frag:     SNIPPET-CALC-FROM-FILE

..    oe:language:: python

    :ref:`Full listing. <listing-SimCalcFromFile.py>`

.. oe:source:: SimCalcFromFile.java
   :language: java
   :refnum:   9
   :caption:  Similarity calculation from file
   :frag:     SNIPPET-CALC-FROM-FILE

.. oe:source:: SimCalcFromFile.cs
   :language: csharp
   :refnum:   9
   :caption:  Similarity calculation from file
   :frag:     SNIPPET-CALC-FROM-FILE

In :oe:src:`Listing 10<SNIPPET-SIM-CALC-FROM-OEB-SimCalcFromOEB>` only the code block that is
different from :oe:src:`Listing 9<SNIPPET-CALC-FROM-FILE-SimCalcFromFile>` is shown.

In this example, it is assumed that the fingerprints are
pre-calculated and stored in an :file:`OEB` binary file as generic data
attached to the corresponding molecules.  The program loops over the
file and accesses the pre-generated fingerprints or calculates them if
they are not available.

The obvious advantage of this process is that the fingerprints one have to
be generated once when the binary file is created.  This can be
significantly faster, than generating the fingerprints on-the-fly
every time the program is executed.

.. seealso::

   The :ref:`chapter_storage` section shows an example of how to
   generate an :file:`OEB` binary file which stores molecule along
   with their corresponding fingerprints.

.. oe:source:: SimCalcFromOEB.cpp
   :language: c++
   :refnum:   10
   :caption:  Similarity calculation from OEB file
   :frag:     SNIPPET-SIM-CALC-FROM-OEB

.. oe:source:: SimCalcFromOEB.py
   :refnum:   10
   :caption:  Similarity calculation from OEB file
   :frag:     SNIPPET-SIM-CALC-FROM-OEB

..    oe:language:: python

    :ref:`Full listing. <listing-SimCalcFromOEB.py>`

.. oe:source:: SimCalcFromOEB.java
   :language: java
   :refnum:   10
   :caption:  Similarity calculation from OEB file
   :frag:     SNIPPET-SIM-CALC-FROM-OEB

.. oe:source:: SimCalcFromOEB.cs
   :language: csharp
   :refnum:   10
   :caption:  Similarity calculation from OEB file
   :frag:     SNIPPET-SIM-CALC-FROM-OEB

:oe:src:`Listing 11<SNIPPET-DB-SIM-CALC-FROM-FILE-DBSimCalcFromFile>` differs from
:oe:src:`Listing 9<SNIPPET-CALC-FROM-FILE-SimCalcFromFile>` in that
it uses an :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object to store the
generated fingerprints.
The :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` class is designed to perform
in-memory fingerprint searches.

.. oe:source:: DBSimCalcFromFile.cpp
   :language: c++
   :refnum:   11
   :caption:  Similarity calculation  with fingerprint database from file
   :frag:     SNIPPET-DB-SIM-CALC-FROM-FILE

.. oe:source:: DBSimCalcFromFile.py
   :language: python
   :refnum:   11
   :caption:  Similarity calculation  with fingerprint database from file
   :frag:     SNIPPET-DB-SIM-CALC-FROM-FILE

..    oe:language:: python

    :ref:`Full listing. <listing-DBSimCalcFromFile.py>`

.. oe:source:: DBSimCalcFromFile.java
   :language: java
   :refnum:   11
   :caption:  Similarity calculation  with fingerprint database from file
   :frag:     SNIPPET-DB-SIM-CALC-FROM-FILE

.. oe:source:: DBSimCalcFromFile.cs
   :language: csharp
   :refnum:   11
   :caption:  Similarity calculation  with fingerprint database from file
   :frag:     SNIPPET-DB-SIM-CALC-FROM-FILE

After building the fingerprint database, the scores can be accessed by
the :oe:meth:`OEGraphSim::OEFPDatabase::GetScores` method.
This will return an iterator over the similarity scores calculated.

.. note::

   The :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` only stores
   fingerprints and not the molecules from which they are generated.
   A correspondence between a molecule and its fingerprint stored in
   the database can be established by using the index returned by the
   :oe:meth:`OEGraphSim::OEFPDatabase::AddFP` method.

.. seealso::

   :oe:src:`Listing 13<SNIPPET-MEM-SIM-SEARCH-MemSimSearch>` shows how to keep
   track of the correspondence between a fingerprint added to a
   :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object and a molecule from which
   it is calculated.

In the last example (:oe:src:`Listing 12<SNIPPET-DB-SIM-CALC-FROM-OEB-DBSimCalcFromOEB>`),
:ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` is used again
to store the fingerprints. If the fingerprint is read from the
:file:`OEB` input binary file, then it is directly added to the
database, otherwise the fingerprint is generated on-the-fly when
passing the :ref:`OEMolBase <OEChem_OEMolBase>` molecule itself to the
:oe:meth:`OEGraphSim::OEFPDatabase::AddFP` method.

.. oe:source:: DBSimCalcFromOEB.cpp
   :language: c++
   :refnum:   12
   :caption:  Similarity calculation  with fingerprint database from OEB
   :frag:     SNIPPET-DB-SIM-CALC-FROM-OEB

.. oe:source:: DBSimCalcFromOEB.py
   :language: python
   :refnum:   12
   :caption:  Similarity calculation  with fingerprint database from OEB
   :frag:     SNIPPET-DB-SIM-CALC-FROM-OEB

..    oe:language:: python

    :ref:`Full listing. <listing-DBSimCalcFromOEB.py>`

.. oe:source:: DBSimCalcFromOEB.java
   :language: java
   :refnum:   12
   :caption:  Similarity calculation  with fingerprint database from OEB
   :frag:     SNIPPET-DB-SIM-CALC-FROM-OEB

.. oe:source:: DBSimCalcFromOEB.cs
   :language: csharp
   :refnum:   12
   :caption:  Similarity calculation  with fingerprint database from OEB
   :frag:     SNIPPET-DB-SIM-CALC-FROM-OEB

.. _section_database_search:

Sorted Search
================================================================================

Similarity searching based on a 2D representation of molecular structure
(such as fingerprints) is one of the most common approaches for
virtual screening.
A molecule that is structurally similar to an active molecule is more
likely to be active.

A virtual screening strategy involves going through a molecule database
and calculating the similarity between a reference structure and each
of the molecules, followed by ranking the similarity scores in
descending order to identify molecules that are the most similar to
the reference structure.

:oe:src:`Listing 13<SNIPPET-MEM-SIM-SEARCH-MemSimSearch>` shows how to search a molecule
database using the :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores`
method to identify analogs based on their fingerprint similarity.
First the molecules are imported using an :ref:`OEMolDatabase <OEChem_OEMolDatabase>` object.
Then a :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object is created that will
store the corresponding fingerprints.
Iterating over the molecules a fingerprints are added to the database by calling
the :oe:meth:`OEGraphSim::OEFPDatabase::AddFP` method.
In case when a molecule can not be accessed from the :ref:`OEMolDatabase <OEChem_OEMolDatabase>`
object, an empty fingerprint is added to the :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>`
object. This ensures that the indices of the two databases are synchronized.
After generating the fingerprints, the program reads
reference molecules (in the :term:`SMILES` format) from standard input.
Then the input :term:`SMILES` string is parsed and the fingerprint database is
searched to identify structures with the highest similarity scores.
Finally, the :term:`SMILES` string of the best hits are written to
standard output.

.. oe:source:: MemSimSearch.cpp
   :language: c++
   :refnum:   13
   :caption:  Similarity search in memory
   :frag:     SNIPPET-MEM-SIM-SEARCH

.. oe:source:: MemSimSearch.py
   :language: python
   :refnum:   13
   :caption:  Similarity search in memory
   :frag:     SNIPPET-MEM-SIM-SEARCH

..    oe:language:: python

    :ref:`Full listing. <listing-MemSimSearch.py>`

.. oe:source:: MemSimSearch.java
   :language: java
   :refnum:   13
   :caption:  Similarity search in memory
   :frag:     SNIPPET-MEM-SIM-SEARCH

.. oe:source:: MemSimSearch.cs
   :language: csharp
   :refnum:   13
   :caption:  Similarity search in memory
   :frag:     SNIPPET-MEM-SIM-SEARCH

As mentioned before, :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` is a
fingerprint container and does not store the corresponding
molecule. Therefore the molecules have to be stored in a separate container
in this case in an :ref:`OEMolDatabase <OEChem_OEMolDatabase>` object.
When the :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` returns
the iterator over the best similarity scores, the associated index can
be utilized to access the corresponding structure in the
:ref:`OEMolDatabase <OEChem_OEMolDatabase>` object.

In the above example, the entire database was searched to identify
structurally similar molecules.
However, the user can also specify a segment of the database to be
searched by providing a begin and end index.

.. seealso::

  * :ref:`OEMolDatabase <OEChem_OEMolDatabase>` class in the **OEChem TK** manual

  * Examples of fingerprint searches in the API section:

    * :oe:meth:`OEGraphSim::OEFPDatabase::GetScores` method
    * :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` method

.. _section_database_simfunc:

Searching with User-defined Similarity Measures
================================================================================

By default, the :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>`
similarity is used  when calling either the
:oe:meth:`OEGraphSim::OEFPDatabase::GetScores` method or the
:oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` method.
The user can set other types of similarity measures to be applied by
calling the :oe:meth:`OEGraphSim::OEFPDatabase::SetSimFunc` method with
a value from the :oe:constns:`OEGraphSim::OESimMeasure` namespace.
Each of the constants from this namespace corresponds to one of the
built-in similarity calculation methods.

There is also a facility to use user-defined similarity
measures when searching a fingerprint database.
The following example shows how a similarity calculation can
be implemented by deriving from the :ref:`OESimFuncBase <OEGraphSim_OESimFuncBase>`
class.

Formula:  :math:`Sim_{Simpson}(A,B) = \sqrt{\frac{bothAB}{min(onlyA+ bothAB),(onlyB+ bothAB))}}`

.. oe:source:: SimFunc.cpp
   :language: c++
   :frag:     SNIPPET-SIM-FUNC-1

.. oe:source:: SimFunc.py
   :language: python
   :frag:     SNIPPET-SIM-FUNC-1

..    oe:language:: python

    :ref:`Full listing. <listing-SimFunc.py>`

.. oe:source:: SimFunc.java
   :language: java
   :frag:     SNIPPET-SIM-FUNC-1

.. oe:source:: SimFunc.cs
   :language: csharp
   :frag:     SNIPPET-SIM-FUNC-1

After implementing the similarity calculation, it can be added to an
:ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` object, henceforth this new
similarity calculation will be used.

.. oe:source:: SimFunc.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SIM-FUNC-2

.. oe:source:: SimFunc.py
   :language: python
   :noindent:
   :frag:     SNIPPET-SIM-FUNC-2

..    oe:language:: python

    :ref:`Full listing. <listing-SimFunc.py>`

.. oe:source:: SimFunc.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SIM-FUNC-2

.. oe:source:: SimFunc.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SIM-FUNC-2

.. seealso::

   * The :ref:`section_measure_user_defined` section


.. _oegraphsim_part_examples:

*********************************
Examples
*********************************

.. toctree::
   :maxdepth: 2

   examples_summary
   cookbook-examples


.. _oegraphsim_chapter_examples:

*************************
GraphSim TK Examples
*************************

The following table lists the currently available **GraphSim TK** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`searchfp<section_examples_summary_searchfp>`
        - building and searching fingerprint database
      * - :ref:`makefastfp<section_examples_summary_makefastfp>`
        - generating fingerprint file for fast fingerprint search
      * - :ref:`searchfastfp<section_examples_summary_searchfastfp>`
        - searching fast fingerprint database

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`searchfp.py<section_examples_summary_searchfp>`
        - building and searching fingerprint database
      * - :ref:`makefastfp.py<section_examples_summary_makefastfp>`
        - generating fingerprint file for fast fingerprint search
      * - :ref:`searchfastfp.py<section_examples_summary_searchfastfp>`
        - searching fast fingerprint database

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`SearchFP<section_examples_summary_searchfp>`
        - building and searching fingerprint database
      * - :ref:`MakeFastFP<section_examples_summary_makefastfp>`
        - generating fingerprint file for fast fingerprint search
      * - :ref:`SearchFastFP<section_examples_summary_searchfastfp>`
        - searching fast fingerprint database

**Examples:**

.. toctree::
   :maxdepth: 1

   examples_summary_searchfp
   examples_summary_makefastfp
   examples_summary_searchfastfp


.. _section_examples_summary_searchfp:

Building and searching fingerprint database
=========================================================

A program that builds a fingerprint database on-the-fly and
then performs fingerprint search to identify molecules which
are similar to a given query molecule

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> searchfp --help

.. oe:language:: python

   .. code-block:: console

      prompt> python searchfp.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java SearchFP --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> SearchFP --help

will generate the following output:

.. code-block:: console

   Simple parameter list

    fingerprint database search options
      -cutoff : Similarity cutoff value
      -descending : Order of similarity scores
      -limit : Maximum number of similarity scores
      -simfunc : Similarity measure

    fingerprint options
      -atomtype : Fingerprint atom type
      -bondtype : Fingerprint bond type
      -fptype : Fingerprint type
      -maxdistance : Maximum number of bonds/radius in path/circular/tree
      -mindistance : Minimum number of bonds/radius in path/circular/tree
      -numbits : Size of bitvector

    input/output options
      -molfname : Input molecule filename
      -out : Output molecule filename
      -query : Input query filename

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`searchfp.py <../../../../wrappers/python/examples/graphsim/searchfp.py>`

   .. :ref:`Full listing. <listing-searchfp.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/graphsim/searchfp.py

   .. only:: oepdf

      .. oe:source:: searchfp.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`searchfp.cpp <../../../../sublibs/tklibs/graphsim/examples/searchfp.cpp>`
         and
         :download:`searchfp.txt <../../../../sublibs/tklibs/graphsim/examples/searchfp.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: searchfp.cpp
         :language: c++

      with interface file

      .. oe:source:: searchfp.txt
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SearchFP.java <../../../../wrappers/java/examples/openeye/examples/oegraphsim/SearchFP.java>`
         and
         :download:`SearchFP.txt <../../../../wrappers/java/examples/openeye/examples/oegraphsim/SearchFP.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: SearchFP.java
         :language: java

      with interface file

      .. oe:source:: SearchFP.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SearchFP.cs <../../../../wrappers/csharp/Csharp-Examples/OEGraphSim/SearchFP.cs>`

   .. only:: oepdf

      .. oe:source:: SearchFP.cs
         :language: csharp

.. seealso::

   * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class
   * :oe:func:`OEGraphSim::OEConfigureFPDatabaseOptions` and
     :oe:func:`OEGraphSim::OESetupFPDatabaseOptions` functions
   * :oe:func:`OEGraphSim::OEConfigureFingerPrint` and
     :oe:func:`OEGraphSim::OESetupFingerPrint` functions
   * :ref:`OEMolDatabase <OEChem_OEMolDatabase>` class in **OEChem TK** manual
   * :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` class




.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. _section_examples_summary_makefastfp:

Generating fingerprint file for fast fingerprint search
=========================================================

A program that generates a binary fingerprint file for fast
fingerprint search.

.. figure:: graphsimtk/images/makefastfp.*
   :align:  center
   :width:  300pt

   **Schematic representation of fast fingerprint generation process**

.. seealso::

   * Example code in the :ref:`section_examples_summary_searchfastfp` section
   * `Rapid Similarity Searching of Large Molecule File`_ OpenEye Python Cookbook example

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> makefastfp --help

.. oe:language:: python

   .. code-block:: console

      prompt> python makefastfp.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java MakeFastFP --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> MakeFastFP --help

will generate the following output:

.. code-block:: console

   Simple parameter list

    fingerprint options
      -atomtype : Fingerprint atom type
      -bondtype : Fingerprint bond type
      -fptype : Fingerprint type
      -maxdistance : Maximum number of bonds/radius in path/circular/tree
      -mindistance : Minimum number of bonds/radius in path/circular/tree
      -numbits : Size of bitvector

    input/output options
      -fpdbfname : Output fingerprint database filename
      -in : Input molecule filename

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`makefastfp.py <../../../../wrappers/python/examples/graphsim/makefastfp.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/graphsim/makefastfp.py

   .. only:: oepdf

      .. oe:source:: makefastfp.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`makefastfp.cpp <../../../../sublibs/tklibs/graphsim/examples/makefastfp.cpp>`
         and
         :download:`makefastfp.txt <../../../../sublibs/tklibs/graphsim/examples/makefastfp.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: makefastfp.cpp
         :language: c++

      with interface file

      .. oe:source:: makefastfp.txt
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeFastFP.java <../../../../wrappers/java/examples/openeye/examples/oegraphsim/MakeFastFP.java>`
         and
         :download:`MakeFastFP.txt <../../../../wrappers/java/examples/openeye/examples/oegraphsim/MakeFastFP.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: MakeFastFP.java
         :language: java

      with interface file

      .. oe:source:: MakeFastFP.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeFastFP.cs <../../../../wrappers/csharp/Csharp-Examples/OEGraphSim/MakeFastFP.cs>`

   .. only:: oepdf

      .. oe:source:: MakeFastFP.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEGraphSim::OEConfigureFingerPrint` and
     :oe:func:`OEGraphSim::OESetupFingerPrint` functions
   * :oe:func:`OEChem::OEGetMolDatabaseIdxFileName` and
     :oe:func:`OEChem::OECreateMolDatabaseIdx` functions in **OEChem TK** manual
   * :ref:`OEMolDatabase <OEChem_OEMolDatabase>` class in **OEChem TK** manual
   * :ref:`OECreateFastFPDatabaseOptions <OEGraphSim_OECreateFastFPDatabaseOptions>` class
   * :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. _section_examples_summary_searchfastfp:

Searching fast fingerprint database
=========================================================

A program that initializes a fast fingerprint database with
the fingerprint file generated from the previous example and
then performs a fingerprint search to identify molecules which
are similar to a given query molecule.

.. figure:: graphsimtk/images/searchfastfp.*
   :align:  center
   :width:  400pt

   **Schematic representation of fast fingerprint search process**

.. seealso::

   * Example code in the :ref:`section_examples_summary_makefastfp` section
   * `Rapid Similarity Searching of Large Molecule File`_ OpenEye Python Cookbook example

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> searchfastfp --help

.. oe:language:: python

   .. code-block:: console

      prompt> python searchfastfp.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java SearchFastFP --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> SearchFastFP --help

will generate the following output:

.. code-block:: console

   Simple parameter list

    fingerprint database options
      -memorytype : Fingerprint database memory type

    fingerprint database search options
      -cutoff : Similarity cutoff value
      -descending : Order of similarity scores
      -limit : Maximum number of similarity scores
      -simfunc : Similarity measure

    input/output options
      -fpdbfname : Input fast fingerprint database filename
      -molfname : Input molecule filename
      -out : Output molecule filename
      -query : Input query filename

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`searchfastfp.py <../../../../wrappers/python/examples/graphsim/searchfastfp.py>`

   .. :ref:`Full listing. <listing-searchfastfp.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/graphsim/searchfastfp.py

   .. only:: oepdf

      .. oe:source:: searchfastfp.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`searchfastfp.cpp <../../../../sublibs/tklibs/graphsim/examples/searchfastfp.cpp>`
         and
         :download:`searchfastfp.txt <../../../../sublibs/tklibs/graphsim/examples/searchfastfp.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: searchfastfp.cpp
         :language: c++

      with interface file

      .. oe:source:: searchfastfp.txt
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SearchFastFP.java <../../../../wrappers/java/examples/openeye/examples/oegraphsim/SearchFastFP.java>`
         and
         :download:`SearchFastFP.txt <../../../../wrappers/java/examples/openeye/examples/oegraphsim/SearchFastFP.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: SearchFastFP.java
         :language: java

      with interface file

      .. oe:source:: SearchFastFP.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SearchFastFP.cs <../../../../wrappers/csharp/Csharp-Examples/OEGraphSim/SearchFastFP.cs>`

   .. only:: oepdf

      .. oe:source:: SearchFastFP.cs
         :language: csharp

.. seealso::

   * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class
   * :oe:func:`OEGraphSim::OEConfigureFPDatabaseOptions` and
     :oe:func:`OEGraphSim::OESetupFPDatabaseOptions` functions
   * :oe:func:`OEGraphSim::OEConfigureFPDatabaseMemoryType` and
     :oe:func:`OEGraphSim::OEGetFPDatabaseMemoryType` function
   * :ref:`OEMolDatabase <OEChem_OEMolDatabase>` class in **OEChem TK** manual
   * :oe:constns:`OEGraphSim::OEFastFPDatabaseMemoryType` namespace
   * :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class
   * :oe:func:`OEGraphSim::OEAreCompatibleDatabases` function


*********************************
GPU Fast Fingerprints
*********************************

.. toctree::
  :maxdepth: 2

  gpu_prereq



.. _oegraphsim_chapter_gpu_prereq:

********************************************************************************
Prerequisites
********************************************************************************

Fast fingerprint searching in **Graphsim TK** is GPU-enabled. In order to run
searches on a GPU please refer to the guidelines below:

..  _graphsim_prereq_for_gpu:


GPU-Related Requirements
========================

The following features are required in order to use GPU-accelerated OpenEye toolkits and applications.


Supported Platforms
-------------------

CUDA-enabled OpenEye software is only available on supported Linux platforms.
For supported Linux platforms see the `Platform Support Page <https://www.eyesopen.com/supported-platforms>`_.


Supported GPUs
-------------------

An NVIDIA `Tesla <http://www.nvidia.com/object/tesla-supercomputing-solutions.html>`_,
`Quadro <http://www.nvidia.com/object/workstation-solutions.html>`_, or
`GeForce <http://www.nvidia.com/object/geforce_family.html>`_ GPU with a **compute capability of 3.5
or higher** is required on your system. For a comprehensive table of compute capability
categories for each GPU, please refer to the `CUDA <https://en.wikipedia.org/wiki/CUDA>`_ Wikipedia page.


NVIDIA Drivers
-------------------

* **Minimum NVIDIA Driver version: 450.x**.

* CUDA is **not** required to be installed.

We recommend driver `450.80.02 <https://www.nvidia.com/Download/driverResults.aspx/165294/en-us>`_, and
we strongly advise manually downloading and installing the appropriate NVIDIA driver
for your system as opposed to using a package manager.

To install, root privilege is required. Follow these steps:

  #. Download the driver to the machine you are installing it on.
  #. ``chmod +x`` the driver package to make it executable.
  #. Ensure you have disabled X-server by killing any running sessions.
     Reboot may be required if X-server is still running after this step.
     
     .. warning::

        Disabling X-server requires different processes to be killed depending on your Linux
        distribution.
        See the `NVIDIA installation guide
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_ for more details.

     .. warning::

        The NVIDIA kernel module can often conflict with the open source
        Nouveau display drivers, depending on your specific Linux
        distribution. The NVIDIA documentation is a much more complete
        and up-to-date source for information on how to work around this issue.
        See `Disabling Nouveau
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile-nouveau>`_ on the NVIDIA website.

  #. Install the driver by ``sudo ./NVIDIA-Linux-x86_64-450.80.02.run`` and follow the step-by-step installation instructions.

  For more details on driver installations, see the `CUDA Installation Guide
  <https://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_

.. note::

  The output of the ``nvidia-smi`` command is extremely useful when
  debugging GPU issues. Please include the output from
  ``nvidia-smi`` in any request to support@eyesopen.com.


Performance Tuning
-------------------

To get the most performance out of an NVIDIA graphics card, use the persistence daemon to switch persistence mode
across all cards on the system (root privilege required)::

  sudo nvidia-persistenced --user foo

This will automatically enable persistence mode after reboot.

For full instructions on the persistence daemon, see the `Persistence daemon section
<https://docs.nvidia.com/deploy/driver-persistence/index.html#persistence-daemon>`_ of the NVIDIA docs.

********************************************************************************
Usage
********************************************************************************

An example of how to perform fast fingerprint searches can be found at :ref:`section_examples_summary_searchfastfp`.
To run using a GPU the :oe:constns:`OEGraphSim::OEFastFPDatabaseMemoryType::CUDA` constant
is used to construct the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` object.
If using the example script aforementioned, simply run the script with ``-memorytype CUDA``.

.. seealso::

   * :oe:constns:`OEGraphSim::OEFastFPDatabaseMemoryType` namespace
   * :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class
   * :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class


.. graphsimtk toolkit documentation master file

###################################
GraphSim Toolkit |graphsim_version|
###################################

.. toctree::
   :maxdepth: 3

   introduction
   theory
   examples
   api
   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt



.. only:: oehtml

   ******************
   Index
   ******************

   * :ref:`genindex`


.. _oegraphsim_part_releasenotes:

.. _oegraphsim_nogpu_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version2_7_1
   version2_7_0
   version2_6_2
   version2_6_1
   version2_6_0
   version2_5_7
   version2_5_6
   version2_5_5
   version2_5_4
   version2_5_3
   version2_5_2
   version2_5_1
   version2_5_0
   version2_4_3
   version2_4_2
   version2_4_1
   version2_4_0
   version2_3_1
   version2_3_0
   version2_2_6
   version2_2_5
   version2_2_4
   version2_2_3
   version2_2_2
   version2_2_1
   version2_2_0
   version2_1_1
   version2_1_0
   version2_0_7
   version2_0_6
   version2_0_5
   version2_0_4
   version2_0_3
   version2_0_2
   version2_0_1
   version2_0_0
   version1_0_1
   version1_0_0



GraphSim TK 2.7.1
================================================================================

Minor Bug Fixes
--------------------------------------------------------------------------------

* The hydrogen counts of neighbor atoms when R-groups are removed prior to fingerprint
  generation have been adjusted.


GraphSim TK 1.0.0
================================================================================

* Provides the following features: 

  * Generate three basic fingerprint types (MACCS key, LINGO
    and path-based)

  * Parameterize the path-based fingerprint generation

    * allowing various atom/bond typing
    * specifying the minimum and maximum length of the enumerated paths 
    * setting the size of fingerprint 

  * Store and retrieve fingerprints as generic data

  * Save/import fingerprints to/from OEB binary file format

* Implementation of  six common similarity indices (Cosine, Dice, Euclidean,
  Manhattan, Tanimoto, Tversky)

* Implementation of fingerprint database that provides the following
  methods for rapid fingerprint-based similarity search:

  * apply user-defined similarity measures
  * set similarity cutoff value
  * access similarity in sorted order


GraphSim TK 1.0.1
================================================================================

Documentation changes
--------------------------------------------------------------------------------

* Adding an example to the :ref:`chapter_storage` section that demonstrate how 
  to generate a bitstring from an :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object.


GraphSim TK 2.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* Adding two new fingerprint types: 

  * The :oe:const:`OEGraphSim::OEFPType::Circular` fingerprint is
    generated by exhaustively enumerating all circular fragments grown
    radially from each heavy atom of the input molecule up to the
    given radius.
    (See more details in :ref:`Circular Fingerprint<section_fingerprint_circular>` section and
    :oe:func:`OEGraphSim::OEMakeCircularFP` function)

  * The :oe:const:`OEGraphSim::OEFPType::Tree` fingerprint is
    generated by exhaustively enumerating all unique trees of a
    molecular graph.
    (See more details in :ref:`Tree Fingerprint<section_fingerprint_tree>` section and
    :oe:func:`OEGraphSim::OEMakeTreeFP` function)

* Adding the :oe:func:`OEGraphSim::OEGetFPCoverage` function that
  allows access to the patterns that are encoded into a fingerprint.
  (See example in :ref:`Fingerprint Coverage<chapter_coverage>` chapter)

* Adding the :oe:func:`OEGraphSim::OEGetFPOverlap` function that returns the
  common patterns of two molecules based on their fingerprint.
  (See example in :ref:`Fingerprint Overlap<chapter_overlap>` chapter)

* Adding version numbers for fingerprints that prevents the comparison of
  fingerprints that are generated by different versions of the algorithm.
  (See more details in :ref:`Fingerprint version number<section_fptype_version_number>` section and 
  :oe:func:`OEGraphSim::OEGetFingerPrintVersion` and  
  :oe:func:`OEGraphSim::OEGetFingerPrintVersionString` functions)

* Adding three more atom typing options that can be used when
  generating path, circular or tree fingerprints:

  * :oe:const:`OEGraphSim::OEFPAtomType::HCount`
  * :oe:const:`OEGraphSim::OEFPAtomType::EqHBondAcceptor`
  * :oe:const:`OEGraphSim::OEFPAtomType::EqHBondDonor`

* Adding the :oe:func:`OEGraphSim::OEGetFPType` function that generates
  a fingerprint type from a valid string representation.

* Adding the :ref:`OEFPTypeParams <OEGraphSim_OEFPTypeParams>` that allow to extract
  the parameters of the fingerprint types from their string representation:

* Adding 9 code examples in four different languages (C++, Python,
  Java, C#) that demonstrate the usage of fingerprints and
  functionalities.

Documentation changes
--------------------------------------------------------------------------------

* Adding figures to the :ref:`Fingerprint <chapter_fingerprint>` chapter that demonstrate
  how the :oe:const:`OEGraphSim::OEFPType::Circular`,
  :oe:const:`OEGraphSim::OEFPType::Path` and :oe:const:`OEGraphSim::OEFPType::Tree`
  fingerprints are generated.

* Adding a new chapter :ref:`Fingerprint Types<chapter_fptype>`, that gives more details
  about fingerprint types.

* Adding two new examples to the :ref:`Storage and Retrieval<chapter_storage>` chapter that
  demonstrate how to store and retrieve fingerprints in SDF files.

* Rewriting part of the :ref:`User-defined Fingerprint <chapter_user_defined>` chapter, since the
  two new fingerprint types can also be customized.

* Adding two new chapters:

  * :ref:`Fingerprint Coverage<chapter_coverage>` chapter
  * :ref:`Fingerprint Overlap<chapter_overlap>` chapter



GraphSim TK 2.0.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* If a molecule being fingerprinted has only hydrogen atom(s), for example 
  molecule ``[H]``, then an empty fingerprint is generated, that is, all bits of the 
  fingerprint are set to zero.
  All hydrogens of the molecule (polar, stereo, isotope, charge) are suppressed 
  before generating its fingerprint.

* If the shell of the circular fingerprint can not be extended, for example, all atoms
  of the molecule are already being considered, then the search is terminated.
  This modification does not effect the generated circular fingerprints, it 
  only makes the generation process faster. 

* Some of the algorithms generating fingerprints can return the same
  fragment of a molecule more than once.
  For example the path fingerprint enumerates both ``OC`` and ``CO``.
  These duplicates are now filtered out when calling the 
  :oe:func:`OEGraphSim::OEGetFPOverlap` function.
  Two overlaps are considered equivalent only if they store the same
  target and pattern atoms and bonds, not considering the
  correspondence between the pattern and target atoms and bonds.





.. _section_oegraphsim_releasenotes_202:

GraphSim TK 2.0.2
================================================================================

* Internal build system improvements.




.. _section_oegraphsim_releasenotes_203:

GraphSim TK 2.0.3
================================================================================

* Internal build system improvements.




.. _section_oegraphsim_releasenotes_204:

GraphSim TK 2.0.4
================================================================================

* Minor internal improvements. 



.. _section_oegraphsim_releasenotes_205:

GraphSim TK 2.0.5
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* The performance of the :oe:func:`OEGraphSim::OEGetFPOverlap` function improved
  on average for drug-like structures:

   * 15% for :oe:const:`OEGraphSim::OEFPType::Path`
   * 30% for :oe:const:`OEGraphSim::OEFPType::Tree`
   * 10% for :oe:const:`OEGraphSim::OEFPType::Circular`

  The improvement is significantly more for very complex molecules such as
  buckyball structures.



.. _section_oegraphsim_releasenotes_206:

GraphSim TK 2.0.6
================================================================================

.. oe:language:: c++ java csharp

   * Minor internal improvements. 

.. oe:language:: python
   
   * :oe:meth:`OEGraphSim::OEFPDatabase::AddFP` in Python will now properly throw an
     exception on failure on 32-bit machines.

Documentation changes
--------------------------------------------------------------------------------

Adding new images to the:

* :ref:`Fingerprint Generation <chapter_fingerprint>` chapter to illustrate 
  the enumeration of fragments of various fingerprints
* :ref:`Similarity Measures <chapter_measure>` chapter to show the basic 
  bit count terms of similarity calculation
* :ref:`User-defined Fingerprint <chapter_user_defined>` chapter and 
  :oe:constns:`OEGraphSim::OEFPAtomType` namespace to visualize the effect of 
  various atom and bond typings



.. _section_oegraphsim_releasenotes_207:

GraphSim TK 2.0.7
================================================================================

Documentation changes
--------------------------------------------------------------------------------

* Added a section about :ref:`Visualizing Molecule Similarity<oegraphsim_section_visualizing_molecule_similarity>`.

* Added note to the :oe:const:`OEGraphSim::OEFPAtomType::Aromaticity` constant.

* Added new images to the:

  * :oe:constns:`OEGraphSim::OEFPAtomType` namespace to visualize the effect of 
    atom typings.

  * :oe:constns:`OEGraphSim::OEFPBondType` namespace to visualize the effect of 
    bond typings.




.. _section_oegraphsim_releasenotes_210:

GraphSim TK 2.1.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Removed unbounded stack allocations.

Documentation fixes
--------------------------------------------------------------------------------

* The :oe:src:`MemSimSearch<MemSimSearch>` documentation example
  demonstrates how to use a :ref:`OEMolDatabase <OEChem_OEMolDatabase>` to minimize
  memory usage. See the :ref:`Sorted Search
  section<section_database_search>` for a description of how this is done.

.. oe:language:: java

   * A Java example for **GraphSim TK** added.

.. oe:language:: csharp

   * A C# example for **GraphSim TK** added.



.. _section_oegraphsim_releasenotes_211:

GraphSim TK 2.1.1
================================================================================

Documentation fixes
--------------------------------------------------------------------------------

* Explaining the hexadecimal string representation of fingerprints generated 
  by the :oe:meth:`OESystem::OEBitVector::ToHexString` method.



.. _section_oegraphsim_releasenotes_220:

GraphSim TK 2.2.0
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprints bit "91" and
  bit "92" have been fixed to behave properly. The previous behavior
  was the following:

  - Bit 91 could have been turned on by either ``[#8]~[#6](~[#7])~[#6]`` or ``[#6H3]~[!#6;!#1]``.
  - Bit 92 was never turned on.

  The behavior has been fixed to do the following:

  - Bit 91 is now only turned on by ``[#8]~[#6](~[#7])~[#6]``. 
  - Bit 92 is now turned on by ``[#6H3]~[!#6;!#1]``.

  .. warning::

     This change was required to revise the version of the :oe:const:`OEGraphSim::OEFPType::MACCS166`
     fingerprints from ``2.0.0`` to ``2.2.0``.

     For more information about version numbers, see the :ref:`section_fptype_version_number` section.

* The customizable fingerprints (:oe:const:`OEGraphSim::OEFPType::Path`,
  :oe:const:`OEGraphSim::OEFPType::Tree`, and  :oe:const:`OEGraphSim::OEFPType::Circular`)
  can now be generated without encoding any atom or bond properties by using the
  :oe:const:`OEGraphSim::OEFPAtomType::None` or :oe:const:`OEGraphSim::OEFPBondType::None`
  constants, respectively.
  However, a warning will be thrown if using :oe:const:`OEGraphSim::OEFPAtomType::None` and
  :oe:const:`OEGraphSim::OEFPBondType::None` constants together.

Documentation fixes
--------------------------------------------------------------------------------

* Code snippets have been added to the following functions that print the string
  representation of generated fingerprints:

  - :oe:func:`OEGraphSim::OEMakeCircularFP` function
  - :oe:func:`OEGraphSim::OEMakePathFP` function
  - :oe:func:`OEGraphSim::OEMakeTreeFP` function

  .. hint::

     The string representation reveals information about the fingerprinting method
     and the parameters being used to generate the fingerprint.


GraphSim TK 2.2.1
================================================================================

* Minor internal improvements have been made.

.. note::

   A mistake was made in the 2015.Feb release such that the
   :oe:func:`OEGraphSim::OEGraphSimGetRelease` function returns ``2.1.2``
   rather than ``2.2.0``.



GraphSim TK 2.2.2
================================================================================

* Minor internal improvements have been made.



GraphSim TK 2.2.3
================================================================================

* Minor internal improvements have been made.

Documentation changes
--------------------------------------------------------------------------------

* The documentation for :oe:func:`OEGraphSim::OETversky` function has been
  restored.


GraphSim TK 2.2.4
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class has been added to allow
  simultaneous fingerprint database searches.

* :oe:meth:`OEGraphSim::OEFPDatabase::GetScores` and
  :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` methods have been
  overloaded.
  The new versions take an :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>`
  search parameter.

* :oe:meth:`OEGraphSim::OEFPDatabase::SetDescendingOrder` and
  :oe:meth:`OEGraphSim::OEFPDatabase::GetDescendingOrder` methods have been
  added to allow setting the order in which the fingerprint scores are
  returned by the :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` method
  to be set.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEGraphSim::OEFPDatabase::GetScores` and
  :oe:meth:`OEGraphSim::OEFPDatabase::GetSortedScores` now throw warnings
  instead of error messages in the case of fingerprint type mismatches before returning
  an empty iterator.


GraphSim TK 2.2.5
================================================================================

* Minor internal improvements have been made.


GraphSim TK 2.2.6
================================================================================

New features
--------------------------------------------------------------------------------

* Three new functions, :oe:func:`OEGraphSim::OEGetCircularFPType`,
  :oe:func:`OEGraphSim::OEGetPathFPType`, and
  :oe:func:`OEGraphSim::OEGetTreeFPType`, have been added to enable
  generating fingerprint types with user-defined parameters.

* A new constructor,
  :oe:meth:`OEFPTypeParams<OEGraphSim::OEFPTypeParams::Constructors>`,
  has been added that takes a fingerprint
  type (:ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`).

* Four functions that automatically generate standard interfaces for
  **GraphSim TK** applications have been added:

  - :oe:func:`OEGraphSim::OEConfigureFingerPrint`
  - :oe:func:`OEGraphSim::OESetupFingerPrint`
  - :oe:func:`OEGraphSim::OEConfigureFPDatabaseOptions`
  - :oe:func:`OEGraphSim::OESetupFPDatabaseOptions`

* A new constructor,
  :oe:meth:`OEFPDatabaseOption<OEGraphSim::OEFPDatabaseOptions::Constructors>`,
  has been added that takes a similarity method from the
  :oe:constns:`OEGraphSim::OESimMeasure` namespace and a limit on the number
  of similarity scores returned from a query.


GraphSim TK 2.3.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new API has been added to perform rapid searching
  of fingerprints using the :term:`popcount` method:

  * :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function and
    :ref:`OECreateFastFPDatabaseOptions <OEGraphSim_OECreateFastFPDatabaseOptions>` class to generate
    binary fingerprint files
  * :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class and
    :oe:constns:`OEGraphSim::OEFastFPDatabaseMemoryType` namespace
    to perform rapid in-memory or memory-mapped fingerprint searches
    using the :term:`popcount` method
  * :ref:`OEFastFPDatabaseParams <OEGraphSim_OEFastFPDatabaseParams>` utility class
    and :oe:func:`OEGraphSim::OEAreCompatibleDatabases` utility function
  * :oe:func:`OEGraphSim::OEIsFastFPDatabaseReady` and
    :oe:func:`OEGraphSim::OEGetPopCountMethod` functions and
    :oe:constns:`OEGraphSim::OEPopCountMethod` namespace to check whether
    the :term:`popcount` method is supported on the current hardware

  .. note::

     **GraphSim TK** currently only supports the :term:`popcount`
     search method for fingerprints where the size is multiple of ``256``.
     This means that the :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint
     type is currently not supported.  See the :ref:`chapter_user_defined`
     section.

  .. note::

      :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` gives identical results
      to :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>`.
      However :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` calculates similarity
      scores in single precision (float) while
      :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` uses double precision.
      As a result small similarity score differences can be observed.

API Change
--------------------------------------------------------------------------------

* The :ref:`OESimScore <OEGraphSim_OESimScore>` class, which is utilized by both
  the :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` class and the new
  :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class, stores a similarity
  value with a corresponding molecule index.  This pair is now stored as
  "double" and "size_t" rather than "float" and "unsigned int".  This
  **non-breaking** API change allows **GraphSim TK** to support molecular
  files that contain more than :math:`2^{32}` entries and supports double
  precision similarity scores calculated using the new
  :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class.

C++-specific changes
--------------------------------------------------------------------------------

* The above-mentioned :ref:`OESimScore <OEGraphSim_OESimScore>` class API change
  means that the following warning messages could be encountered
  when compiling old code with the new **GraphSim TK**:

  * ``implicit conversion loses floating point precision: 'double' to 'float'``

    .. code-block:: c++

       for (OEIter<OESimScore> si = fpdb.GetScores(mol); si; ++si)
         float score = si->GetScore(); // GetScore() now returns double

  * ``implicit conversion loses integer precision : 'size_t' to 'unsigned int'``

    .. code-block:: c++

        for (OEIter<OESimScore> si = fpdb.GetScores(mol); si; ++si)
          unsigned int molidx = si->GetIdx(); // GetIdx() now returns size_t

Java-specific changes
--------------------------------------------------------------------------------

* The above-mentioned :ref:`OESimScore <OEGraphSim_OESimScore>` class API change
  means that a similarity value with a corresponding molecule index is now
  expected to be "double" and "long", respectively.

Documentation changes
--------------------------------------------------------------------------------

* A new section, :ref:`section_examples_summary_searchfp`, has been added.

* New :ref:`section_examples_summary_makefastfp` and
  :ref:`section_examples_summary_searchfastfp` sections have been added
  with examples showing generation and searching of fingerprints
  using the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class.


GraphSim TK 2.3.1
================================================================================

New features
--------------------------------------------------------------------------------

* The following API has been added to provide access to underlying data
  generated for :oe:const:`OEGraphSim::OEFPType::Path`,
  :oe:const:`OEGraphSim::OEFPType::Tree`, and
  :oe:const:`OEGraphSim::OEFPType::Circular` fingerprint types:

  * :ref:`OEFPPattern <OEGraphSim_OEFPPattern>`
  * :oe:func:`OEGraphSim::OEGetFPPatterns`

* The performance of the :oe:func:`OEGraphSim::OEGetFPCoverage` function
  has been improved.

* The following functions have been added to help generate consistent
  command line interfaces for 2D molecule similarity examples and utilities:

  * :oe:func:`OEGraphSim::OEConfigureFingerPrint` and the corresponding
    :oe:func:`OEGraphSim::OESetupFingerPrint`
  * :oe:func:`OEGraphSim::OEConfigureFPDatabaseOptions` and the corresponding
    :oe:func:`OEGraphSim::OESetupFPDatabaseOptions`

  Generated interfaces include correspondence between each command line
  option and its related entry point in **OEGraphSim TK**.

Documentation changes
--------------------------------------------------------------------------------

* A new :ref:`chapter_patterns` chapter has been added.


GraphSim TK 2.4.0
================================================================================

New features
--------------------------------------------------------------------------------

* **GraphSim TK** now has limited GPU support for fast fingerprints.
  :oe:const:`CUDA<OEGraphSim::OEFastFPDatabaseMemoryType::CUDA>` has been
  added to the :oe:constns:`OEGraphSim::OEFastFPDatabaseMemoryType`
  namespace for executing large 2D searches and to have GPU devices
  at their disposal. This new feature comes with the following additional
  API points:

  * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetRawScores`
  * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetAllScores`
  * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetHistogram` and
    :ref:`OEFPHistogram <OEGraphSim_OEFPHistogram>`  (preliminary)
  * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetVariogram` and
    :ref:`OEFPVariogram <OEGraphSim_OEFPVariogram>` (preliminary)
  * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetMemoryType`
  * :oe:meth:`OEGraphSim::OEFastFPDatabase::GetMemoryTypeString`

  For more information, see the documentation
  for :oe:const:`OEGraphSim::OEFastFPDatabaseMemoryType::CUDA`.

* The following API has been added to help generate consistent
  command line interfaces for 2D molecule similarity examples and utilities:

  * :oe:constns:`OEGraphSim::OEFPDatabaseOptionsSetup`
  * :oe:func:`OEGraphSim::OEConfigureFPDatabaseOptions`
  * :oe:func:`OEGraphSim::OEConfigureFPDatabaseMemoryType`
  * :oe:func:`OEGraphSim::OEGetFPDatabaseMemoryType`


GraphSim TK 2.4.1
================================================================================

New features
--------------------------------------------------------------------------------

* A new :oe:meth:`OEGraphSim::OEFastFPDatabase::GetFingerPrint` method
  has been added to allow retrieving fingerprints stored in fast
  fingerprint databases that are generated in a single-threaded mode.

* New :oe:constns:`OEGraphSim::OEFPDatabaseOptionsSetup::Cutoff` and
  :oe:constns:`OEGraphSim::OEFPDatabaseOptionsSetup::DescendingOrder`
  methods have been added to help generate consistent command line
  interfaces.

* A new :oe:meth:`OEGraphSim::OEFastFPDatabase::GetSparseMatrix`
  method has been added to allow retrieving a sparse matrix of
  similarity scores to facilitate clustering. The method will retrieve
  ``limit`` scores per fingerprint or all scores above a desired
  ``cutoff`` value. The method is available in all memory modes,
  including
  :oe:const:`CUDA<OEGraphSim::OEFastFPDatabaseMemoryType::CUDA>`.

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:func:`OEGraphSim::OEGetFingerPrintVersion` function no
  longer throws an error for an invalid fingerprint type. It now
  throws a warning and returns zero.


GraphSim TK 2.4.2
================================================================================

* Minor internal improvements have been made.


GraphSim TK 2.4.3
================================================================================

New features
--------------------------------------------------------------------------------

* A new method, :oe:meth:`OEGraphSim::OEFastFPDatabase::GetMoleculeIndex`, has been added.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEGraphSim::OEIsValidFPTypeString` no longer throws an error and
  always return ``false`` if the given string cannot be interpreted.



GraphSim TK 2.5.0
================================================================================

New features
--------------------------------------------------------------------------------

* The following new APIs have been added that enable multi-threaded similarity
  search and access to a histogram of the similarity score distributions:

  * :oe:meth:`OEGraphSim::OEFastFPDatabase::SortedSearch` method
  * :ref:`OESimSearchResult <OEGraphSim_OESimSearchResult>` method
  * :oe:constns:`OEGraphSim::OESimSearchStatus` namespace
  * :oe:constns:`OEGraphSim::OESimSearchStatusToName` function

* Two new methods, :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetNumProcessors` and
  :oe:meth:`OEGraphSim::OEFPDatabaseOptions::GetNumProcessors`, have been
  added that control the number of threads used to search fingerprints when using
  :oe:meth:`OEGraphSim::OEFastFPDatabase::SortedSearch`.

* New atom and bond typing combinations have been added to generate
  :oe:const:`tree<OEGraphSim::OEFPType::Tree>`,
  :oe:const:`path<OEGraphSim::OEFPType::Path>`, and
  :oe:const:`circular<OEGraphSim::OEFPType::Circular>`
  fingerprints that are optimized for virtual screening.
  The :oe:func:`OEGraphSim::OEMakeFP` and :oe:func:`OEGraphSim::OEGetFPType`
  methods can now generate these new types.
  See also the :oe:constns:`OEGraphSim::OEFPAtomType`
  and :oe:constns:`OEGraphSim::OEFPBondType` namespaces.

* Small optimization has been achieved by reducing cache misses during
  the fingerprint search when using the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>`
  class.

* New overloads of the :oe:meth:`OEGraphSim::OEFPHistogram::GetBinIdx` and
  :oe:meth:`OEGraphSim::OEFPHistogram::AddSample` methods have been
  added that take a ``double`` parameter.

Major bug fixes
--------------------------------------------------------------------------------

* The binary fingerprint database writer had been accidentally broken in the Oct.2019 release.
  This has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* The default limit of the :ref:`OEFPDatabaseOptions <OEGraphSim_OEFPDatabaseOptions>` class has been
  changed from 0 (meaning no limit) to 1000.
  See also the :oe:meth:`OEGraphSim::OEFPDatabaseOptions::SetLimit` method.

General Notices
--------------------------------------------------------------------------------

* In the C++ **GraphSim TK**, **Fast fingerprints** with the CUDA memory type is not available on RHEL8 or Ubuntu18.




GraphSim TK 2.5.1
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------
* GPU-accelerated :oe:meth:`OEGraphSim::OEFastFPDatabase` searches now require a
  minimum NVIDIA Driver version of 450.x and a minimum GPU compute capability of 3.5.
  See :ref:`section_supported_gpus_drivers` and :ref:`section_supported_gpus` for more details.




GraphSim TK 2.5.2
================================================================================

*July 2021*

Minor internal improvements have been made.


GraphSim TK 2.5.3
================================================================================

*Fall 2021*

* Minor internal improvements have been made.




GraphSim TK 2.5.4
================================================================================

* Minor internal improvements have been made.





GraphSim TK 2.5.5
================================================================================

Minor internal improvements have been made.





GraphSim TK 2.5.6
================================================================================

Minor internal improvements have been made.



GraphSim TK 2.5.7
================================================================================

Minor internal improvements have been made.





GraphSim TK 2.6.0
================================================================================

Minor internal improvements have been made.





GraphSim TK 2.6.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The function :ref:`OEGraphsimIsGPUReady <OEGraphsim_OEGraphsimIsGPUReady>` has been safeguarded from a rare crash.



GraphSim TK 2.6.2
================================================================================

Minor internal improvements have been made.



GraphSim TK 2.7.0
================================================================================

New Features
--------------------------------------------------------------------------------

* New API functions have been added to explicitly provide access to virtual screening
  fingerprints which were previously generated with a subtle boolean function argument.
  See :ref:`OEMakeVSFP <OEGraphSim_OEMakeVSFP>` and :ref:`OEGetVSFPType <OEGraphSim_OEGetVSFPType>`.

* New Python function has been added to create a NumPy Array from the bits stored in an
  :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`. See :ref:`OEFPToNumpyArray <OEGraphSim_OEFPToNumpyArray>`.

Minor Bug Fixes
--------------------------------------------------------------------------------

* A minor tuning of :oe:const:`OEGraphSim::OEFPAtomType::DefaultCircularVSAtom` for virtual
  screening of :oe:const:`OEGraphSim::OEFPType::Circular` fingerprints improved the
  consistency of virtual screening scores when comparing :oe:const:`OEGraphSim::OEFPType::Tree`,
  :oe:const:`OEGraphSim::OEFPType::Circular`, and :oe:const:`OEGraphSim::OEFPType::Path` for
  VS fingerprints.


.. _chapter_measure:

********************************************************************************
Similarity Measures
********************************************************************************

The basic idea underlying similarity-based measures is that molecules
that are structurally similar are likely to have similar properties.
In a fingerprint the presence or absence of a structural fragment is
represented by the presence or absence of a set bit.
This means that two molecules are judged as being similar if they have
a large number of bits in common.

Measuring molecular similarity or dissimilarity has two basic components:
the representation of molecular characteristics (such as fingerprints)
and the similarity coefficient that is used to quantify the degree of
resemblance between two such representations.

Built-in Similarity Measures
================================================================================

Since different similarity coefficients quantify different types of
structural resemblance, several built-in similarity measures are available
in the **GraphSim TK**
(see :ref:`Table: Basic bit count terms of similarity calculation<table_measure_basic_terms>`)
The table below defines the four basic bit count terms that are used in
fingerprint-based similarity calculations:

.. _table_measure_basic_terms:

.. list-table:: **Basic bit count terms of similarity calculation**
   :widths: 40 160 160
   :header-rows: 1

   * - Symbol
     - Description
     -

   * - :math:`onlyA`
     - number of bits set "on" in fingerprint A but not in B
     - .. image:: images/Fingerprints-OnlyA.*

   * - :math:`onlyB`
     - number of bits set "on" in fingerprint B but not in A
     - .. image:: images/Fingerprints-OnlyB.*

   * - :math:`bothAB`
     - number of bits set "on" in both fingerprints
     - .. image:: images/Fingerprints-BothAB.*

   * - :math:`neitherAB`
     - number of bits set "off" in both fingerprints
     - .. image:: images/Fingerprints-NeitherAB.*

   * - :math:`|A|`
     - number of bits set "on" in fingerprint A
     -

   * - :math:`|B|`
     - number of bits set "on" in fingerprint B
     -

   * - :math:`fpsize`
     - length of fingerprint in bits
     -

.. _section_measure_cosine:

Cosine
--------------------------------------------------------------------------------
.. index::
   pair: Cosine; similarity measure

**Formula:**

  :math:`Sim_{Cosine}(A,B) = \frac{bothAB}{\sqrt{|A|*|B|}} = \frac{bothAB}{\sqrt{(onlyA + bothAB) * (onlyB + bothAB)}}`

**Range:**

 :math:`[0.0, 1.0]`

**Example:**

================================== =======================================================================================================================
.. image:: graphsimtk/images/Fingerprints.*   :math:`\frac{bothAB}{\sqrt{(onlyA+bothAB)*(onlyB+bothAB)}} = \frac{3}{\sqrt{(1+3)*(2+3)}} = \frac{3}{\sqrt{20}} = 0.67`
================================== =======================================================================================================================

Calculates the ratio of the bits in common to the geometric mean of
the number of "on" bits in the two fingerprints.

.. _section_measure_dice:

Dice
--------------------------------------------------------------------------------

.. index::
   pair: Dice; similarity measure

**Formula:**

  :math:`Sim_{Dice}(A,B) = \frac{2*bothAB}{|A|+|B|} = \frac{2 *bothAB}{onlyA + onlyB + 2 * bothAB}`

**Range:**

 :math:`[0.0, 1.0]`

**Example:**

================================== ======================================================================================
.. image:: graphsimtk/images/Fingerprints.*   :math:`\frac{2*bothAB}{onlyA+onlyB+2*bothAB}=\frac{2*3}{1+2+2*3}=\frac{6}{9} = 0.666`
================================== ======================================================================================

Calculates the ratio of the bits in common to the arithmetic mean of
the number of "on" bits in the two fingerprints.

.. _section_measure_euclid:

Euclidean
--------------------------------------------------------------------------------

.. index::
   pair: Euclidean; similarity measure

**Formula:**

  :math:`Sim_{Euclid}(A,B) = \sqrt{\frac{bothAB + neitherAB}{fpsize}} = \sqrt{\frac{bothAB + neitherAB}{onlyA + onlyB + bothAB + neitherAB}}`

**Range:**

  :math:`[0.0, 1.0]`

**Example:**

================================== ===========================================================================================================================
.. image:: graphsimtk/images/Fingerprints.*   :math:`\sqrt{\frac{bothAB+neitherAB}{onlyA+onlyB+bothAB+neitherAB}}=\sqrt{\frac{3+2}{1+2+3+2}} = \sqrt{\frac{5}{8}}=0.791`
================================== ===========================================================================================================================

.. _section_measure_manhattan:

Manhattan
--------------------------------------------------------------------------------

.. index::
   pair: Manhattan; similarity measure

**Formula:**

  :math:`Sim_{Manhattan}(A,B) = \frac{onlyA +onlyB}{fpsize} = \frac{onlyA + onlyB}{onlyA + onlyB + bothAB + neitherAB}`

**Range:**

  :math:`[0.0, 1.0]`

**Example:**

================================== ====================================================================================================================
.. image:: graphsimtk/images/Fingerprints.*   :math:`\frac{onlyA + onlyB}{onlyA + onlyB + bothAB + neitherAB} = \frac{1 + 2}{1 + 2 + 3 + 2} = \frac{3}{8} = 0.375`
================================== ====================================================================================================================

.. note::

  Although :math:`Sim_{Manhattan}` shares the same range with other
  similarity measures, it acts more like a **distance** measure,
  scoring more similar fingerprints lower. Identical fingerprints have
  :math:`Sim_{Manhattan}` of 0.0 (as opposed to 1.0 in any other measure).

.. _section_measure_tanimoto:

Tanimoto
--------------------------------------------------------------------------------

.. index::
   pair: Tanimoto; similarity measure

**Formula:**

  :math:`Sim_{Tanimoto}(A,B) = \frac{bothAB}{|A| + |B| - bothAB} = \frac{bothAB}{onlyA + onlyB + bothAB}`

**Range:**

  :math:`[0.0, 1.0]`

**Example:**

================================== ===========================================================================
.. image:: graphsimtk/images/Fingerprints.*   :math:`\frac{bothAB}{onlyA+onlyB+bothAB}=\frac{3}{1+2+3}=\frac{3}{6} = 0.5`
================================== ===========================================================================

.. note::

   The calculation of the :oe:const:`OEGraphSim::OEFPType::Lingo`
   fingerprint is based on fragmenting canonical isomeric
   :term:`SMILES` into overlapping four character long substrings.
   If any of the two :term:`SMILES` being compared is shorter than four characters,
   then their Tanimoto score will be:

   * `1.0`, if the two :term:`SMILES` are identical
   * `0.0`, otherwise.

.. _section_measure_tversky:

Tversky
--------------------------------------------------------------------------------

.. index::
   pair: Tversky; similarity measure

**Formula:**

  :math:`Sim_{Tversky}(A,B) = \frac{bothAB}{\alpha * onlyA + \beta * onlyB + bothAB}`

The Tversky similarity measure is asymmetric.
Setting the parameters :math:`\alpha = \beta = 1.0` is identical to
using the :ref:`section_measure_tanimoto` measure.

The factor :math:`\alpha` weights the contribution of the first
'reference' molecule. The larger :math:`\alpha` becomes, the more
weight is put on the bit setting of the reference molecule.

**Range:**

  :math:`[0.0, 1.0]`

**Example:**

================================== =========================================================================================================================
.. image:: graphsimtk/images/Fingerprints.*   :math:`\frac{bothAB}{\alpha*onlyA+\beta*onlyB+bothAB} (\alpha=2.0,\beta=1.0)=\frac{3}{2.0*1+1.0*2+3}=\frac{3}{7} = 0.429`
================================== =========================================================================================================================

.. note::
  Although :math:`Sim_{Tversky}` shares the same range with other
  similarity measures, its scaling can vary by orders of magnitude
  depending on the choice of :math:`\alpha` and :math:`\beta` parameters.

Similarity Calculation
================================================================================

The following example demonstrates how to calculate
:oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>` similarity
scores for the molecules depicted in
:ref:`Figure: Example molecules<figure_measure_fptanimoto>`.

.. _figure_measure_fptanimoto:

.. figure:: graphsimtk/images/FingerPrintTanimotoMolecules.*
   :scale:  100
   :align:  center

   **Example molecules**

.. oe:source:: FPTanimoto.cpp
   :language: c++
   :refnum:   8
   :caption:  Calculating Tanimoto index
   :frag:     SNIPPET-FP-TANIMOTO

..  oe:source:: FPTanimoto.py
    :language: python
    :refnum:   8
    :caption:  Calculating Tanimoto index
    :frag:     SNIPPET-FP-TANIMOTO

..    oe:language:: python

      :ref:`Full listing. <listing-FPTanimoto.py>`

.. oe:source:: FPTanimoto.java
   :language: java
   :refnum:   8
   :caption:  Calculating Tanimoto index
   :frag:     SNIPPET-FP-TANIMOTO

..  oe:source:: FPTanimoto.cs
   :language: csharp
   :refnum:   8
   :caption:  Calculating Tanimoto index
   :frag:     SNIPPET-FP-TANIMOTO

Molecules B and C (shown in :ref:`Figure: Example Molecules<figure_measure_fptanimoto>`)
have the largest Tanimoto value since they share the largest number of
common structural features.

For these example molecule the output of :oe:src:`Listing 8<SNIPPET-FP-TANIMOTO-FPTanimoto>` is the following:

::

   Tanimoto(A,B) = 0.618
   Tanimoto(A,C) = 0.709
   Tanimoto(B,C) = 0.889

.. _section_measure_user_defined:

User-defined Similarity Measures
================================================================================

The following code snippet demonstrates how implement the Yule
similarity measure with the following formula:

:math:`Sim_{Yule}(A,B) = \sqrt{\frac{(bothAB * neitherAB) - (onlyA * onlyB)}{(bothAB * neitherAB) + (onlyA * onlyB)}}`

.. oe:source:: FPYule.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-FP-YULE-1

.. oe:source:: FPYule.py
   :language: python
   :noindent:
   :frag:     SNIPPET-FP-YULE-1

..    oe:language:: python

    :ref:`Full listing. <listing-FPYule.py>`

.. oe:source:: FPYule.java
   :language: java
   :frag:     SNIPPET-FP-YULE-1

.. oe:source:: FPYule.cs
   :language: csharp
   :frag:     SNIPPET-FP-YULE-1

The :oe:func:`OEGraphSim::OEGetBitCounts` function returns the four basic
values (namely :math:`onlyA`, :math:`onlyB`, :math:`bothAB` and
:math:`neitherAB`) from which any similarity measures can be calculated.
For the definition of these values see
:ref:`Table: Basic bit count terms<table_measure_basic_terms>`

.. oe:source:: FPYule.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-FP-YULE-2

.. oe:source:: FPYule.py
   :language: python
   :noindent:
   :frag:     SNIPPET-FP-YULE-2

..    oe:language:: python

    :ref:`Full listing. <listing-FPYule.py>`

.. oe:source:: FPYule.java
   :language: java
   :noindent:
   :frag:     SNIPPET-FP-YULE-2

.. oe:source:: FPYule.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-FP-YULE-2

.. warning::

   User-defined similarity measures can only be used with circular,
   path, tree, and  MACCS key fingerprints but **not** with LINGO
   (:oe:const:`OEGraphSim::OEFPType::Lingo`).


.. _chapter_overlap:

********************************************************************************
Fingerprint Overlap
********************************************************************************

The :oe:func:`OEGraphSim::OEGetFPOverlap` function provides access to the
fragments of two molecules that are considered equivalent based on a specific
fingerprint type.
This means that the returned fragment-pairs set the same bit "on" when
fingerprints are generated.
The following example shows how to retrieve the common five bond-length
patterns of two molecules.

.. oe:source:: FPOverlap.py
   :language: python
   :refnum:   18
   :caption:  Example of accessing common patterns based on a fingerprint
   :frag:     SNIPPET-FPOVERLAP

..    oe:language:: python

    :ref:`Full listing. <listing-FPOverlap.py>`

.. oe:source:: FPOverlap.cpp
   :language: c++
   :refnum:   18
   :caption:  Example of accessing common patterns based on a fingerprint
   :frag:     SNIPPET-FPOVERLAP

.. oe:source:: FPOverlap.java
   :language: java
   :refnum:   18
   :caption:  Example of accessing common patterns based on a fingerprint
   :frag:     SNIPPET-FPOVERLAP

.. oe:source:: FPOverlap.cs
   :language: csharp
   :refnum:   18
   :caption:  Example of accessing common patterns based on a fingerprint
   :frag:     SNIPPET-FPOVERLAP

The first three matches returned by the :oe:src:`Listing 18<SNIPPET-FPOVERLAP-FPOverlap>` are
depicted in the next table.
The output of code  is the following:

::

   match  1: 3C-2C  9C-11C  4C-3C  8C-10C  7C-7C  11C-8C
   match  2: 3C-2C  4C-3C  5C-4C  6C-6C  7C-7C  8C-8C
   match  3: 3C-2C  4C-3C  5C-4C  6C-6C  7C-7C  8C-10C
   match  4: 3C-2C  4C-3C  5C-4C  6C-6C  7C-7C  11C-8C
   match  5: 3C-2C  4C-3C  5C-4C  6C-6C  7C-7C  11C-10C
   match  6: 3C-2C  9C-11C  4C-3C  6C-6C  7C-7C  11C-8C

   ... truncated  ...

.. list-table:: **Example of matches returned by the OEGetFPOverlap function.** The numbers depicted next to the atoms are the atom indices.
   :widths: 300
   :header-rows: 0

   * - .. image:: images/FPOverlap-01.*
          :scale:  100
          :align:  center
   * - .. image:: images/FPOverlap-02.*
          :scale:  100
          :align:  center
   * - .. image:: images/FPOverlap-03.*
          :scale:  100
          :align:  center

.. warning::

   Even though the :oe:func:`OEGraphSim::OEGetFPOverlap` function returns
   an iterator of :ref:`OEMatchBase <OEChem_OEMatchBase>` objects, they are not
   matches in the traditional sense, i.e. the atom-pair and bond-pair
   correspondences between the pattern and the target atoms and
   bonds are not guaranteed. See example depicted below.

.. figure:: graphsimtk/images/FPOverlap-NonPair-01.*
   :align:  center

   **The two highlighted patterns set the same bit when fingerprints
   are generated, but the returned match is not pairwise**.
   The numbers depicted next to the atoms are the atom indices.

.. seealso::

   * :oe:func:`OEGraphSim::OEGetFPCoverage` function
   * :ref:`chapter_coverage` chapter

.. hint::

   The :oe:func:`OEGraphSim::OEGetFPOverlap` can be used to visualize molecule similarity based on
   a given fingerprint type. See more details in:

   * :ref:`oegraphsim_section_visualizing_molecule_similarity` section
   * `Depicting Molecule Similarity section in
     OpenEye Python Cookbook <http://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html>`_


.. _chapter_patterns:

********************************************************************************
Fingerprint Patterns
********************************************************************************

Fingerprints are usually generated by enumerating various fragments (patterns)
of a molecule and then hashing them into a fixed-length bitvector.
The :oe:func:`OEGraphSim::OEGetFPPatterns` function provides access to these
patterns by returning an iterator over :ref:`OEFPPattern <OEGraphSim_OEFPPattern>` objects,
each of which has the atoms and bonds of a specific fragment along with the
following information:

* the bit that is set when the pattern is hashed into a  fixed-length bitvector
* the unhashed unique integer encoding of the pattern
* the SMARTS representation of the pattern that encodes the atom and bond properties
  that are specified in the given fingerprint type (:ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`)

The following example shows how the retrieve the patterns that are enumerated 
when generating a tree fingerprint.

..  oe:source:: FPPattern.py
    :language: python
    :refnum:   19
    :caption:  Example of accessing patterns encoded into a fingerprint
    :frag:     SNIPPET-FPPATTERN

..    oe:language:: python

    :ref:`Full listing. <listing-FPPattern.py>`

.. oe:source:: FPPattern.cpp
   :language: c++
   :refnum:   19
   :caption:  Example of accessing patterns encoded into a fingerprint
   :frag:     SNIPPET-FPPATTERN

.. oe:source:: FPPattern.java
   :language: java
   :refnum:   19
   :caption:  Example of accessing patterns encoded into a fingerprint
   :frag:     SNIPPET-FPPATTERN

.. oe:source:: FPPattern.cs
   :language: csharp
   :refnum:   19
   :caption:  Example of accessing patterns encoded into a fingerprint
   :frag:     SNIPPET-FPPATTERN

The output of :oe:src:`Listing 19 <SNIPPET-FPPATTERN-FPPattern>` is the following:

::
 
    1   849                                             [N;D1]  0 N
    2  1611                                             [C;D2]  1 C
    3   740                                             [C;D3]  2 C
    4  2841                                             [O;D1]  3 O
    5  1589                                            [O-;D1]  4 O
    6  2326                                      [N;D1]-[C;D2]  0 N  1 C
    7  3764                             [C;D2](-[C;D3])-[N;D1]  0 N  1 C  2 C
    8  2727                      [C;D2](-[C;D3]=[O;D1])-[N;D1]  0 N  1 C  2 C  3 O
    9   859            [C;D2](-[C;D3](-[O-;D1])=[O;D1])-[N;D1]  0 N  1 C  2 C  3 O  4 O
   10  3537                     [C;D2](-[C;D3]-[O-;D1])-[N;D1]  0 N  1 C  2 C  4 O
   11  3083                                      [C;D3]-[C;D2]  1 C  2 C
   12   793                               [C;D2]-[C;D3]=[O;D1]  1 C  2 C  3 O
   13  1574                     [C;D2]-[C;D3](-[O-;D1])=[O;D1]  1 C  2 C  3 O  4 O
   14  3538                              [C;D2]-[C;D3]-[O-;D1]  1 C  2 C  4 O
   15  1707                                      [O;D1]=[C;D3]  2 C  3 O
   16  1472                            [C;D3](-[O-;D1])=[O;D1]  2 C  3 O  4 O
   17  1397                                     [O-;D1]-[C;D3]  2 C  4 O

.. seealso::

   * :ref:`OEFPPattern <OEGraphSim_OEFPPattern>` class
   * :oe:func:`OEGraphSim::OEGetFPPatterns` function
   * :oe:func:`OEGraphSim::OEGetFPType` function
   * :ref:`chapter_coverage` chapter
   * :ref:`chapter_overlap` chapter


###############################################
Appendix: Selected Examples in Python
###############################################

These are full listings of programming examples that are excerpted or offered for download, elsewhere in this chapter.
See :ref:`a full list of examples in the Graphsim chapter. <oegraphsim_chapter_examples>`

..	_listing-DBSimCalcFromFile.py:

..  oe:source:: DBSimCalcFromFile.py
    :language: python
    :caption: Full listing of DBSimCalcFromFile.py.
    :refnum: 1

..	_listing-DBSimCalcFromOEB.py:

..  oe:source:: DBSimCalcFromOEB.py
    :language: python
    :caption: Full listing of DBSimCalcFromOEB.py.
    :refnum: 2

..	_listing-FP2OEB.py:

..  oe:source:: FP2OEB.py
    :language: python
    :caption: Full listing of FP2OEB.py.
    :refnum: 3

..	_listing-FP2SDF.py:

..  oe:source:: FP2SDF.py
    :language: python
    :caption: Full listing of FP2SDF.py.
    :refnum: 4

..	_listing-FPAtomTyping.py:

..  oe:source:: FPAtomTyping.py
    :language: python
    :caption: Full listing of FPAtomTyping.py.
    :refnum: 5

..	_listing-FPBitString.py:

..  oe:source:: FPBitString.py
    :language: python
    :caption: Full listing of FPBitString.py.
    :refnum: 6

..  _listing-FPCoverage.py:

..	oe:source:: FPCoverage.py
    :language: python
    :caption: Full listing of FPCoverage.py.
    :refnum: 7

..	_listing-FPData.py:

..  oe:source:: FPData.py
    :language: python
    :caption: Full listing of FPData.py.
    :refnum: 8

..	_listing-FPOverlap.py:

..  oe:source:: FPOverlap.py
    :language: python
    :caption: Full listing of FPOverlap.py.
    :refnum: 9

..  _listing-FPPathLength.py:

..	oe:source:: FPPathLength.py
    :language: python
    :caption: Full listing of FPPathLength.py.
    :refnum: 10

..	_listing-FPPattern.py:

..  oe:source:: FPPattern.py
    :language: python
    :caption: Full listing of FPPattern.py.
    :refnum: 11

..	_listing-FPTanimoto.py:

..  oe:source:: FPTanimoto.py
    :language: python
    :caption: Calculate Tanimoto similarity scores.
    :refnum: 12

..	_listing-MemSimSearch.py:

..  oe:source:: MemSimSearch.py
    :language: python
    :caption: Full listing of MemSimSearch.py.
    :refnum: 13

..	_listing-PathFPType.py:

..  oe:source:: PathFPType.py
    :language: python
    :caption: Full listing of PathFPType.py.
    :refnum: 14

..	_listing-SDF2FP.py:

..  oe:source:: SDF2FP.py
    :language: python
    :caption: Full listing of SDF2FP.py.
    :refnum: 15

..  _listing-SimCalcFromFile.py:

..	oe:source:: SimCalcFromFile.py
    :language: python
    :caption: Full listing of SimCalcFromFile.py.
    :refnum: 16

..	_listing-SimCalcFromOEB.py:

..  oe:source:: SimCalcFromOEB.py
    :language: python
    :caption: Full listing of SimCalcFromOEB.py.
    :refnum: 17

..	_listing-makefastfp.py:

..  oe:source:: makefastfp.py
    :language: python
    :caption: Generating fingerprint file for fast fingerprint search.
    :refnum: 18

..	_listing-searchfastfp.py:

..  oe:source:: searchfastfp.py
    :language: python
    :caption: Searching fast fingerprint database.
    :refnum: 19

..	_listing-searchfp.py:

..  oe:source:: searchfp.py
    :language: python
    :caption: Building and searching fingerprint database.
    :refnum: 20

..	_listing-getscores.py:

..  oe:source:: GetScores.py
    :language: python
    :caption: Calculate similarity scores.
    :refnum: 21

..	_listing-sortedsearch.py:

..  oe:source:: SortedSearch.py
    :language: python
    :caption: Perform multithreaded similarity calculation.
    :refnum: 22

..	_listing-circularfpdefaultparams.py:

..  oe:source:: CircularFPDefaultParams.py
    :language: python
    :caption: Print out string representation of a circular fingerprint.
    :refnum: 23

..	_listing-pathfpdefaultparams.py:

..  oe:source:: PathFPDefaultParams.py
    :language: python
    :caption: Print out string representation of a path fingerprint.
    :refnum: 24

..	_listing-treefpdefaultparams.py:

..  oe:source:: TreeFPDefaultParams.py
    :language: python
    :caption: Print out string representation of a tree fingerprint.
    :refnum: 25

..	_listing-simfunc.py:

..  oe:source:: SimFunc.py
    :language: python
    :caption: simfunc.py full listing.
    :refnum: 26

..	_listing-makemaccsfp.py:

..  oe:source:: MakeMaccsFP.py
    :language: python
    :caption: makemaccsfp.py full listing.
    :refnum: 27

..	_listing-makelingofp.py:

..  oe:source:: MakeLingoFP.py
    :language: python
    :caption: makelingofp.py full listing.
    :refnum: 28

..	_listing-makecircularfp.py:

..  oe:source:: MakeCircularFP.py
    :language: python
    :caption: MakeCircularFP.py full listing.
    :refnum: 29

..	_listing-makepathfp.py:

..  oe:source:: MakePathFP.py
    :language: python
    :caption: Make a path fingerprint.
    :refnum: 30

..	_listing-fptype.py:

..  oe:source:: FPType.py
    :language: python
    :caption: Fingerprint types.
    :refnum: 31

..	_listing-fpcompare.py:

..  oe:source:: FPCompare.py
    :language: python
    :caption: Compare fingerprint objects.
    :refnum: 32

..	_listing-fptypestring.py:

..  oe:source:: FPTypeString.py
    :language: python
    :caption: Return string representation of fingerprint type.
    :refnum: 33

..	_listing-fpyule.py:

..  oe:source:: FPYule.py
    :language: python
    :caption: Yule similarity measures.
    :refnum: 34

..	_listing-FPTypeParams.py:

.. oe:source:: FPTypeParams.py
   :language: python
   :refnum:   35
   :caption:  Fingerprint parameters.



.. _chapter_storage:

********************************************************************************
Storage and Retrieval
********************************************************************************

The :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` does not store any reference to
the molecule from which it was generated.
The user has to keep track of which fingerprint corresponds to which
molecule.
One way to do this is to attach the fingerprint, as generic data, to
the molecule.
:oe:src:`Listing 3<SNIPPET-FPDATA-FPData>` shows how store and retrieve  fingerprints
as generic data.

.. oe:source:: FPData.cpp
   :language: c++
   :refnum:   3
   :caption:  Storing and retrieving fingerprint as generic data
   :frag:     SNIPPET-FPDATA

.. oe:source:: FPData.py
   :language: python
   :refnum:   3
   :caption:  Storing and retrieving fingerprint as generic data
   :frag:     SNIPPET-FPDATA

.. oe:language:: python

   :ref:`Full listing. <listing-FPData.py>`

.. oe:source:: FPData.java
   :language: java
   :refnum:   3
   :caption:  Storing and retrieving fingerprint as generic data
   :frag:     SNIPPET-FPDATA

.. oe:source:: FPData.cs
   :language: csharp
   :refnum:   3
   :caption:  Storing and retrieving fingerprint as generic data
   :frag:     SNIPPET-FPDATA

.. oe:language:: python java csharp

   It is good practice to check the validity of the fingerprint after
   retrieving it.
   The :oe:meth:`OEGraphSim::OEFingerPrint::IsValid<OEGraphSim::OEFingerPrint::operator bool>`
   method returns true if the fingerprint was successfully initialized.

.. If no :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object was attached to the ``obj``
   object with the ``tag`` identifier, then
   :oe:func:`OEGraphSim::OEGetFP` function will return a default
   :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` instance.

.. oe:language:: c++

   It is good practice to check the validity of the fingerprint after
   retrieving it.
   The :oe:meth:`OEGraphSim::OEFingerPrint::operator bool`
   method returns true if the fingerprint was successfully initialized.

:oe:src:`Listing 4<SNIPPET-FP2OEB-FP2OEB>` demonstrates how to create an
:file:`OEB` binary  file that stores molecules along with their fingerprints.
When reading the :file:`OEB` file that was generated by this program, the
pre-calculated fingerprints can be accessed rapidly with the ``PATH_FP``
tag.
This eliminates the `on-the-fly` generation of the fingerprints.

.. seealso::

  Additional examples in :oe:src:`Listing 10<SNIPPET-SIM-CALC-FROM-OEB-SimCalcFromOEB>` and
  :oe:src:`Listing 12<SNIPPET-DB-SIM-CALC-FROM-OEB-DBSimCalcFromOEB>` of the :ref:`chapter_database`
  chapter.

.. oe:source:: FP2OEB.cpp
   :language: c++
   :refnum:   4
   :caption:  Fingerprint generation and storage in OEB
   :frag:     SNIPPET-FP2OEB

.. oe:source:: FP2OEB.py
   :language: python
   :refnum:   4
   :caption:  Fingerprint generation and storage in OEB
   :frag:     SNIPPET-FP2OEB

.. oe:language:: python

      :ref:`Full listing. <listing-FP2OEB.py>`

.. oe:source:: FP2OEB.java
   :language: java
   :refnum:   4
   :caption:  Fingerprint generation and storage in OEB
   :frag:     SNIPPET-FP2OEB

.. oe:source:: FP2OEB.cs
   :language: csharp
   :refnum:   4
   :caption:  Fingerprint generation and storage in OEB
   :frag:     SNIPPET-FP2OEB

The following code snippets shows how to generate
a bitstring from an :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object.

.. oe:source:: FPBitString.cpp
   :language: c++
   :refnum:   5
   :caption:  Accessing a fingerprint as a bitstring
   :frag:     SNIPPET-BIT-STRING

.. oe:source:: FPBitString.py
   :language: python
   :refnum:   5
   :caption:  Accessing a fingerprint as a bitstring
   :frag:     SNIPPET-BIT-STRING

.. oe:language:: python

      :ref:`Full listing. <listing-FPBitString.py>`

.. oe:source:: FPBitString.java
   :language: java
   :refnum:   5
   :caption:  Accessing a fingerprint as a bitstring
   :frag:     SNIPPET-BIT-STRING

.. oe:source:: FPBitString.cs
   :language: csharp
   :refnum:   5
   :caption:  Accessing a fingerprint as a bitstring
   :frag:     SNIPPET-BIT-STRING

.. seealso::

   * :ref:`OEBitVector <OESystem_OEBitVector>` class

.. warning::

   Even though the **GraphSim TK** library provides a fingerprint API for the
   :term:`LINGO` similarity search method, it is not implemented as a *real*
   :term:`fingerprint`, so bitstrings that are generated from
   LINGO fingerprints are meaningless.

Fingerprints can also be stored in :file:`SDF` files.
The :oe:src:`Listing 6<SNIPPET-FP2SDF-FP2SDF>` demonstrates how to create an
:file:`SDF` and store fingerprints as hexadecimal strings.

After the fingerprint is generated, it is attached to the molecule
as an SD data tag. The identifier of the fingerprint in the :file:`SDF`
file will be the string representation of the fingerprint type.
The bitvector of the fingerprint is converted to a hexadecimal
string with the :oe:meth:`OESystem::OEBitVector::ToHexString`
method.

.. oe:source:: FP2SDF.py
   :language: python
   :refnum:   6
   :caption:  Storing fingerprint in SDF
   :frag:     SNIPPET-FP2SDF

.. oe:language:: python

      :ref:`Full listing. <listing-FP2SDF.py>`

.. oe:source:: FP2SDF.cpp
   :language: c++
   :refnum:   6
   :caption:  Storing fingerprint in SDF
   :frag:     SNIPPET-FP2SDF

.. oe:source:: FP2SDF.java
   :language: java
   :refnum:   6
   :caption:  Storing fingerprint in SDF
   :frag:     SNIPPET-FP2SDF

.. oe:source:: FP2SDF.cs
   :language: csharp
   :refnum:   6
   :caption:  Storing fingerprint in SDF
   :frag:     SNIPPET-FP2SDF

The following example (:oe:src:`Listing 7<SNIPPET-SDF2FP-SDF2FP>`) shows how to
retrieve fingerprints from an :file:`SDF` file.
When looping over the SD data the :oe:func:`OEGraphSim::OEIsValidFPTypeString`
functions can be used to identify SD data that stores
a fingerprint.
The tag of the data is the string representation of the fingerprint type.
This string representation can be used to generate the
corresponding :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` object by using
the :oe:func:`OEGraphSim::OEGetFPType` function.
The type of the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object then has to
be set by the :oe:meth:`OEGraphSim::OEFingerPrint::SetFPTypeBase`
method.
Finally, the bitvector of the fingerprint then can be initialized from the
hexadecimal string by using the
:oe:meth:`OESystem::OEBitVector::FromHexString` method.

.. oe:source:: SDF2FP.py
   :language: python
   :refnum:   7
   :caption:  Retrieving fingerprint from SDF
   :frag:     SNIPPET-SDF2FP

.. oe:language:: python

      :ref:`Full listing. <listing-SDF2FP.py>`

.. oe:source:: SDF2FP.cpp
   :language: c++
   :refnum:   7
   :caption:  Retrieving fingerprint from SDF
   :frag:     SNIPPET-SDF2FP

.. oe:source:: SDF2FP.java
   :language: java
   :refnum:   7
   :caption:  Retrieving fingerprint from SDF
   :frag:     SNIPPET-SDF2FP

.. oe:source:: SDF2FP.cs
   :language: csharp
   :refnum:   7
   :caption:  Retrieving fingerprint from SDF
   :frag:     SNIPPET-SDF2FP

.. seealso::

   * :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPTypeString` method
   * :ref:`OEBitVector <OESystem_OEBitVector>` class
   * **SD Tagged Data Manipulation** chapter in the **OEChem TK** manual


.. _chapter_user_defined:

********************************************************************************
User-defined Fingerprint
********************************************************************************

The previous :ref:`chapter_fingerprint` chapter showed how to create
circular, path and tree fingerprints with default parameters.
These default parameters are calibrated on the Briem-Lessel
[Briem-Lessel-2000]_, Hert-Willett [Hert-Willett-2004]_ and Grant
[Grant-2006]_ benchmarks.

However, the **GraphSim TK** also provides facilities to construct
user-defined fingerprints.
When constructing a user-defined fingerprint, the following
parameters have to be considered:

#. Atom and bond typing that define which atom and bond properties are
   encoded into the fingerprints
   (see the :ref:`section_user_defined_atom_bond_typing` section)

#. Size of the fragments that are exhaustively enumerated during the
   fingerprint generation
   (see the :ref:`section_user_defined_length` section)

#. Size of the generated fingerprint (in bits)
   (see the :ref:`section_user_defined_bitsize` section)

The following code snippet shows how to generate a ``1024`` bit long
fingerprint that encodes paths from ``0`` up to ``5`` bonds in length
with default atom and bond properties defined by the
:oe:const:`OEGraphSim::OEFPAtomType::DefaultAtom` and
:oe:const:`OEGraphSim::OEFPBondType::DefaultBond` constants,
respectively.

.. oe:source:: MakePathFP.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-MAKE-PATH-3

.. oe:source:: MakePathFP.py
   :language: python
   :noindent:
   :frag:     SNIPPET-MAKE-PATH-3

.. oe:language:: python

      :ref:`Full listing. <listing-MakePathFP.py>`

.. oe:source:: MakePathFP.java
   :language: java
   :noindent:
   :frag:     SNIPPET-MAKE-PATH-3

.. oe:source:: MakePathFP.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-MAKE-PATH-3

.. warning::

   Two fingerprints which are generated with different parameters
   will have different fingerprint types!

In :oe:src:`Listing 14<SNIPPET-PATH-FP-TYPE-PathFPType>`, two fingerprints are generated with
different parameters, namely they have a different number of bits.
This means that they also have different types, therefore,
no similarity value can be calculated between them.

.. oe:source:: PathFPType.cpp
   :language: c++
   :refnum:   14
   :caption:  Example of different path fingerprint types
   :frag:     SNIPPET-PATH-FP-TYPE

.. oe:source:: PathFPType.py
   :language: python
   :refnum:   14
   :caption:  Example of different path fingerprint types
   :frag:     SNIPPET-PATH-FP-TYPE

.. oe:language:: python

      :ref:`Full listing. <listing-PathFPType.py>`

.. oe:source:: PathFPType.java
   :language: java
   :refnum:   14
   :caption:  Example of different path fingerprint types
   :frag:     SNIPPET-PATH-FP-TYPE

.. oe:source:: PathFPType.cs
   :language: csharp
   :refnum:   14
   :caption:  Example of different path fingerprint types
   :frag:     SNIPPET-PATH-FP-TYPE

The output of :oe:src:`Listing 14<SNIPPET-PATH-FP-TYPE-PathFPType>` is the following:

::

   same fingerprint types = False
   Fatal: fingerprint type mismatch!

.. _section_user_defined_atom_bond_typing:

Atom and Bond Typing
================================================================================

:oe:src:`Listing 15<SNIPPET-ATOMTYPING-FPAtomTyping>` shows how to generate fingerprints for
two molecules with various atom and bond types
(depicted in :ref:`Example molecules<figure_path_atom_bond_typing>`).
Reducing the number of atom and bond properties increases the similarity
between the two molecules (*i.e.* their
:oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>` similarity).
At the end, when only the topology of two molecules is considered,
*i.e.*, whether or not their atoms and bonds belong to any ring system,
the fingerprints of the two molecules become identical.

These effects are illustrated in
:ref:`Table: Examples of depiction molecule similarity based on fingerprints<table_atom_typing_examples>`.

.. seealso::

   * :ref:`oegraphsim_section_visualizing_molecule_similarity` section

.. oe:source:: FPAtomTyping.cpp
   :language: c++
   :refnum:   15
   :caption:  Similarity calculation with various atom/bond typing
   :frag:     SNIPPET-ATOMTYPING

.. oe:source:: FPAtomTyping.py
   :language: python
   :refnum:   15
   :caption:  Similarity calculation with various atom/bond typing
   :frag:     SNIPPET-ATOMTYPING

.. oe:language:: python

      :ref:`Full listing. <listing-FPAtomTyping.py>`

.. oe:source:: FPAtomTyping.java
   :language: java
   :refnum:   15
   :caption:  Similarity calculation with various atom/bond typing
   :frag:     SNIPPET-ATOMTYPING

.. oe:source:: FPAtomTyping.cs
   :language: csharp
   :refnum:   15
   :caption:  Similarity calculation with various atom/bond typing
   :frag:     SNIPPET-ATOMTYPING

.. _figure_path_atom_bond_typing:

.. figure:: graphsimtk/images/FingerPrintAtomTypingMolecules.*
   :scale:  100
   :align:  center

   **Example molecules**

The output of :oe:src:`Listing 15<SNIPPET-ATOMTYPING-FPAtomTyping>` is the following:

::

   Tanimoto(A,B) = 0.166
   Tanimoto(A,B) = 0.241
   Tanimoto(A,B) = 0.592
   Tanimoto(A,B) = 1.000

.. _table_atom_typing_examples:

.. list-table:: **Examples of depiction molecule similarity based on fingerprints**

   * - .. image:: images/FingerPrintAtomTypingExampleA.*
     - .. image:: images/FingerPrintAtomTypingExampleB.*

   * - .. image:: images/FingerPrintAtomTypingExampleC.*
     - .. image:: images/FingerPrintAtomTypingExampleD.*

:ref:`Table: Atom typing options<table_user_defined_atom_typing>`
and
:ref:`Table: Bond typing options<table_user_defined_bond_typing>`
list the currently available typing options.

.. _table_user_defined_atom_typing:

.. list-table:: Atom typing options
  :widths: 100 100
  :header-rows: 1

  * - atom typing constant
    - encoded atom property

  * - :oe:const:`OEGraphSim::OEFPAtomType::Aromaticity`
    - :oe:meth:`OEChem::OEAtomBase::IsAromatic`

  * - :oe:const:`OEGraphSim::OEFPAtomType::AtomicNumber`
    - :oe:meth:`OEChem::OEAtomBase::GetAtomicNum`

  * - :oe:const:`OEGraphSim::OEFPAtomType::Chiral`
    - :oe:meth:`OEChem::OEAtomBase::IsChiral`

  * - :oe:const:`OEGraphSim::OEFPAtomType::FormalCharge`
    - :oe:meth:`OEChem::OEAtomBase::GetFormalCharge`

  * - :oe:const:`OEGraphSim::OEFPAtomType::HCount`
    - :oe:meth:`OEChem::OEAtomBase::GetTotalHCount`

  * - :oe:const:`OEGraphSim::OEFPAtomType::HvyDegree`
    - :oe:meth:`OEChem::OEAtomBase::GetHvyDegree`

  * - :oe:const:`OEGraphSim::OEFPAtomType::Hybridization`
    - :oe:meth:`OEChem::OEAtomBase::GetHyb`

  * - :oe:const:`OEGraphSim::OEFPAtomType::InRing`
    - :oe:meth:`OEChem::OEAtomBase::IsInRing`

.. _table_user_defined_atomic_modifiers:

.. list-table:: Atomic number modifiers
  :widths: 100 100
  :header-rows: 1

  * - :oe:const:`OEGraphSim::OEFPAtomType::EqAromatic`
    -

  * - :oe:const:`OEGraphSim::OEFPAtomType::EqHalogen`
    -

  * - :oe:const:`OEGraphSim::OEFPAtomType::EqHBondAcceptor`
    -

  * - :oe:const:`OEGraphSim::OEFPAtomType::EqHBondDonor`
    -

.. _table_user_defined_bond_typing:

.. list-table:: Bond typing options
  :widths: 100 100
  :header-rows: 1

  * - bond typing constant
    - encoded bond property

  * - :oe:const:`OEGraphSim::OEFPBondType::BondOrder`
    - :oe:cls:`OEChem::OEBondBase::GetOrder`

  * - :oe:const:`OEGraphSim::OEFPBondType::Chiral`
    - :oe:meth:`OEChem::OEBondBase::IsChiral`

  * - :oe:const:`OEGraphSim::OEFPBondType::InRing`
    - :oe:meth:`OEChem::OEBondBase::IsInRing`

.. seealso::

   * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
   * :oe:constns:`OEGraphSim::OEFPBondType` namespace

.. _section_user_defined_length:

Fragment Size
================================================================================

Circular, path and tree-based fingerprint generation involves molecular
graph traversal to identify all unique radial, linear or branched fragments,
respectively.
When a path or tree fingerprint is initialized, the minimum and maximum
number of bonds of the fragments that are encoded into the fingerprint
can be specified.
See :ref:`Figure: Example of enumerated path fragments with increasing number of bonds<figure_path_enumeration_length>` and
:ref:`Figure: Example of enumerated tree fragments with increasing number of bonds<figure_tree_enumeration_length>`.

.. _figure_path_enumeration_length:

.. figure:: graphsimtk/images/PathEnumerationLengths.*
   :scale:  100
   :align:  center

   **Example of enumerated path fragments with increasing number of bonds**

.. _figure_tree_enumeration_length:

.. figure:: graphsimtk/images/TreeEnumerationLengths.*
   :scale:  100
   :align:  center

   **Example of enumerated tree fragments with increasing number of bonds**

In case of a circular fingerprint, the minimum and maximum radius of the
enumerated fragments can be specified.
See :ref:`Figure: Example of enumerated circular fragments with increasing radius<figure_circular_enumeration_length>`

.. _figure_circular_enumeration_length:

.. figure:: graphsimtk/images/CircularEnumerationLengths.*
   :scale:  100
   :align:  center

   **Example of enumerated circular fragments with increasing radius**

For example, when generating a fingerprint of the molecule shown in
:ref:`Figure: Example Molecule<figure_path_path_length_example>`
with minimum and maximum length set to ``0`` and ``3``, respectively,
only paths listed in the first four rows in :ref:`Table: Enumerated
Paths<table_path_enumeration>`, are encoded into the fingerprint.

.. _figure_path_path_length_example:

.. figure:: graphsimtk/images/PathLengthExampleMolecule.*
   :scale:  100
   :align:  center

   **Example molecule**

.. _table_path_enumeration:

.. list-table:: Enumerated paths
   :widths: 15 35
   :header-rows: 1

   * - Path length (in bonds)
     - Generated Unique Paths
   * - 0
     - ``C``, ``N``, ``O``
   * - 1
     -  ``C-C``, ``C-N``, ``C-O``
   * - 2
     - ``C-C-C``, ``C-C-N``, ``C-C-O``, ``C-N-C``, ``N-C-O``
   * - 3
     -  ``C-C-C-C``, ``C-C-C-N``, ``C-C-C-O``, ``C-C-N-C``, ``C-N-C-O``,
   * - 4
     - ``C-C-C-C-C``, ``C-C-C-C-N``, ``C-C-C-C-O``, ``C-C-C-N-C``, ``C-C-N-C-C``, ``O-C-N-C-C``
   * - 5
     -  ``C-C-C-C-C-N``, ``C-C-C-C-C-O``, ``C-C-C-C-N-C``, ``C-C-C-N-C-C``, ``C-C-C-N-C-O``

:ref:`Figure: Example of enumerated paths<figure_path_path_length_enumeration>`
depicts the six unique paths of length four that are generated for the example
molecule. Each unique path is encoded only once without considering its frequency.

.. _figure_path_path_length_enumeration:

.. figure:: graphsimtk/images/PathLengthExnumerationExample.*
   :scale:  100
   :align:  center

   **Example of enumerated paths**

In the example shown in :oe:src:`Listing 16<SNIPPET-FPPATHLENGTH-FPPathLength>`, fingerprints
with various minimum and maximum path length are generated for pyrrole
and pyridine.
When enumerating only paths that are shorter than four bonds,
the fingerprints generated for the two molecules are identical.
Since the four bond-length pattern ``ccccc`` is present in pyridine
but not in pyrrole, the fingerprints become different, resulting in
a smaller Tanimoto similarity score.

.. oe:source:: FPPathLength.cpp
   :language: c++
   :refnum:   16
   :caption:  Similarity calculation with various path lengths
   :frag:     SNIPPET-FPPATHLENGTH

.. oe:source:: FPPathLength.py
   :language: python
   :refnum:   16
   :caption:  Similarity calculation with various path lengths
   :frag:     SNIPPET-FPPATHLENGTH

.. oe:language:: python

      :ref:`Full listing. <listing-FPPathLength.py>`

.. oe:source:: FPPathLength.java
   :language: java
   :refnum:   16
   :caption:  Similarity calculation with various path lengths
   :frag:     SNIPPET-FPPATHLENGTH

.. oe:source:: FPPathLength.cs
   :language: csharp
   :refnum:   16
   :caption:  Similarity calculation with various path lengths
   :frag:     SNIPPET-FPPATHLENGTH

The output of :oe:src:`Listing 16<SNIPPET-FPPATHLENGTH-FPPathLength>` is the following:

::

   Tanimoto(A,B) = 1.000
   Tanimoto(A,B) = 1.000
   Tanimoto(A,B) = 0.950
   Tanimoto(A,B) = 0.731

.. _section_user_defined_bitsize:

Fingerprint Size
================================================================================

The previous sections explain how the atom and bond typing and encoded fragment
size can effect the similarity scores.
Selecting an adequate fingerprint size is also very crucial.
The number of unique circular, path or tree fragments present in molecular
structures can be extremely large, therefore the generated fragments have to
be hashed into the fixed-length fingerprint.
This means that a bit in a fingerprint does not correspond to
a unique pattern exclusively (as it does in :term:`structural key`).
Also a bit has no particular structural meaning, *i.e.*, each bit
represents the presence of a number of structural patterns.

The smaller the size of the fingerprints, the more dense they become,
raising the probability of collisions.
A collision occurs when different fragments are mapped to the same bit.
This will inherently result in information loss and weaken
the power to discriminate between structurally similar and dissimilar
molecules.
On the other hand, when the size of the fingerprints is too large
they become very sparse, which will reduce information loss.
However, the time spent to calculate similarity scores will increase.

The following table shows the number of unique paths generated for
benzylpenicillin
(depicted in :ref:`Figure: Benzylpenicillin<figure_path_benzylpenicillin>`).

.. note::

   The more atom and bond properties that are taken into account and the
   larger the size of paths to enumerate, the larger the size of the
   fingerprint has to be in order to encode the enumerated fragments
   without a significant number of bit collisions.

.. _figure_path_benzylpenicillin:

.. figure:: graphsimtk/images/Benzylpenicillin.*
   :scale:  100
   :align:  center

   **Benzylpenicillin**

.. list-table:: Number of unique paths generated for Benzylpenicillin
   :widths: 90 15 15 15
   :header-rows: 1

   * - Atom/Bond typing
     - path 0-3
     - path 0-5
     - path 0-7
   * - :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>`, :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`
     -  56
     - 149
     - 297
   * - :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>` | :oe:const:`HvyDegree<OEGraphSim::OEFPAtomType::HvyDegree>`, :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>`
     - 111
     - 265
     - 453
   * - :oe:const:`AtomicNumber<OEGraphSim::OEFPAtomType::AtomicNumber>` | :oe:const:`HvyDegree<OEGraphSim::OEFPAtomType::HvyDegree>` | :oe:const:`Aromaticity<OEGraphSim::OEFPAtomType::Aromaticity>`, :oe:const:`BondOrder<OEGraphSim::OEFPBondType::BondOrder>` | :oe:const:`InRing<OEGraphSim::OEFPBondType::InRing>`
     - 126
     - 297
     - 499
   * - :oe:const:`DefaultAtom<OEGraphSim::OEFPAtomType::DefaultAtom>`, :oe:const:`DefaultBond<OEGraphSim::OEFPBondType::DefaultBond>`
     - 147
     - 362
     - 617



###################################
Lexichem Toolkit |lexichem_version|
###################################

.. toctree::
   :maxdepth: 3

   theory
   examples
   api
   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt






.. _lexichem_part_theory:

********************************
Theory
********************************

.. toctree::
   :maxdepth: 3

   introduction


Input Name Representation
================================================================================

The *oeiupac* library currently processes NULL (zero) terminated ASCII
character strings; therefore Greek characters, symbols, fonts and
superscripts must be transliterated into the printable subset of
ASCII. When parsing compound names, the *oeiupac* library considers both
spaces and tab characters as interchangeable, and any number of
consecutive 'whitespace' characters are treated as a single space.

Currently, the name parsing is case insensitive, allowing arbitrary
mixing of upper and lower case characters, *e.g.* initial letter
capitalization.

Greek characters are understood in a number of different
representations.

+-----------------+---------------+--------------+----------+---------+-----------+-----+-------+---------+
| Character       | Friendly Code | Decimal Code | Hex Code | Unicode | Addl1     |Addl2| Addl3 | Addl4   |
+=================+===============+==============+==========+=========+===========+=====+=======+=========+
| :math:`\alpha`  | &alpha;       | &#945;       | &#x3B1;  | \\U03B1 | .alpha.   | $a  | ${a}  | alpha   |
+-----------------+---------------+--------------+----------+---------+-----------+-----+-------+---------+
| :math:`\beta`   | &beta;        | &#946;       | &#x3B2;  | \\U03B2 | .beta.    | $b  | ${b}  | beta    |
+-----------------+---------------+--------------+----------+---------+-----------+-----+-------+---------+
| :math:`\gamma`  | &gamma;       | &#947;       | &#x3B3;  | \\U03B3 | .gamma.   | $g  | ${g}  | gamma   |
+-----------------+---------------+--------------+----------+---------+-----------+-----+-------+---------+
| :math:`\delta`  | &delta;       | &#948;       | &#x3B4;  | \\U03B4 | .delta.   | $d  | ${d}  | delta   |
+-----------------+---------------+--------------+----------+---------+-----------+-----+-------+---------+
| :math:`\epsilon`| &epsilon;     | &#949;       | &#x3B5;  | \\U03B5 | .epsilon. |     |       | epsilon |
+-----------------+---------------+--------------+----------+---------+-----------+-----+-------+---------+
| :math:`\lambda` | &lambda;      | &#955;       | &#x3BB;  | \\U03BB | .lambda.  | $l  | ${l}  | lambda  |
+-----------------+---------------+--------------+----------+---------+-----------+-----+-------+---------+
| +/-             | &PLUSMN       | &#177        | &#x0B1   | \\U00B1 |           |     |       |         |
+-----------------+---------------+--------------+----------+---------+-----------+-----+-------+---------+

Note: Addl[1-4] are  additional identifiers.

For example, the strings '$a', '${a}', 'alpha', '.alpha.',
'&alpha;', '&#945;' and '&#x3B1;' are all understood to represent the
Greek character *alpha*, (:math:`\alpha`).

Output Name Representation
===============================================================================

Unrecognized functional groups, linkers or ring systems are denoted in
the generated name as the string **'BLAH'**. As much of the name as
possible is generated resulting in compound names such as
'dichloroBLAHcarboxylic acid'. Generated compound names are entirely
lower case, with no initial capitalization. Upper case characters are
generated for locants and, as described above, for BLAH.

Names are generated using a set of markup tokens which can be further
processed for output to the desired format.

   Greek characters are indicated with the dollar character followed
   by a single letter. In this formalism, '$a' represents the Greek
   character alpha, :math:`\alpha`, '$b' the Greek character
   beta, :math:`\beta`, etc.

   Superscripts are indicated by surrounding the superscripted text
   with caret and curly braces.  Hence '$l^{5}' represents the
   Greek character lambda followed by a superscript five, *i.e.*
   :math:`\lambda^5`.
   Similarly, 'pentacyclo[4.2.0.0^{2,5}.0^{3,8}.0^{4,7}]octane' would be
   the von Baeyer system name for cubane.

   Subscripts are are indicated by surrounding the superscripted text
   with underscore and curly braces.  Hence 'C_{60} Fullerene' is a
   generated name for Buckminsterfullerene.

   Italics, used for stereochemistry and locants, are indicated with
   a tilde and curly braces.  An example is: '(2~{R})-butan-2-ol'.

The markup tokens are converted into appropriate markup for a particular
use during the conversion of the raw name to the desired final character set.

Translation of names to alternate languages may result in characters outside
of the default ASCII character set being used.  In this case, the characters
are encoded as escaped unicode, eg: **'\uXXXX'**.  The actual output
characters are generated in the final character set conversion.

Multiple components in a disconnected molecule, apart from common salts and
counter ions, are separated from each other by a semicolon followed by a space.
Mixtures containing salts are written ordering the cations before the
compound name, followed by anions, followed by any common neutral
molecules (*e.g.* hydrate or hydrochloride).

Enhanced Stereochemistry
------------------------

.. _figure_Enhanced_Stereochemistry:

.. figure:: /_images/EnhancedStereoExamples.png
   :align:  center

   **Enhanced Stereochemistry**

.. note:: 

   Enhanced stereochemistry is only supported in for molecules which
   are represented using `MDL V3000 Format <http://accelrys.com/products/collaborative-science/biovia-draw/ctfile-no-fee.html>`_.

Naming recognizes enhanced stereochemical features as embodied in the
V3000 file format.  V3000 allows the specification of **AND** and **OR**
stereochemical atom groupings.  An **AND** grouping corresponds to a mixture
of structures with the center(s) as indicated and their inverse configuration.
An **OR** grouping corresponds to either the isomer as indicated or its
inverse configuration.  Absolute, unspecified, **AND**, and **OR**
stereocenters can all be present in single molecule.

:ref:`Figure: Enhanced Stereochemistry <figure_Enhanced_stereochemistry>`
illustrates enhanced stereochemical names generated using the Lexichem TK.
Centers in an **AND** grouping are designated with "RS" or "SR".  Centers
in an **OR** grouping are designated with "R*" or "S*".

For chemical structures with multiple chiral centers where only some
are designated as **AND** (see top left image), the descriptors "RS" and "SR"
are used to denote **AND** centers.

For a structure where all of the stereocenters are designated as **AND**,
the structure represents a molecule and its enantiomer.  In that case
(even though the V3000 format does not explicitly define the ratio of
enantiomers), the molecule is named as a racemate, with a "rac" prefix
(see bottom left image).

For chemical structures with multiple chiral centers where only some
are designated as **OR** (see top right image), the descriptors "R*" and "S*"
are used to denote the **OR** centers.

For a structure where all of the stereocenters are designated as **OR**,
the structure represents a molecule or its relative inverse configuration.
In that case the molecule is named with a "rel" prefix. (see bottom right
image).

The IUPAC standard recommends naming structures so the first **AND**
indicator and the first **OR** indicator in the name are "R", "RS", 
or "R*" as appropriate.  When generating a name from a structure, this
is easily accomplished by inverting the stereo designation on every center
in the stereo grouping.  For example, the
names "rac-(2R,4R)-4-aminopentan-2-ol" and "rac-(2S,4S)-4-aminopentan-2-ol"
are equivalent since they both mean: "a mixture of the (2R,4R) and (2S,4S)
isomers".  In this case IUPAC conventions recommend using the "rac-(2R,4R)"
name.

This choice of recommended name may be a cause for confusion since the
atom/bond block of the V3000 molfile indicates a particular configuration
and it is possible that the generated name will not appear to correspond to
the configuration as found in the atom/bond block.  To mitigate the potential
for confusion, only the IUPAC and Systematic style of output names perform
the inversion.  This allows the user to control whether or not the inversion
occurs.  Comparing the IUPAC and OpenEye style names will give an
indication whether or not the inversion is occurring.

For more details please refer to section P-92.1.2 and P-92.1.3 of the 
Nomenclature of Organic Chemistry [IUPAC-2014]_.

.. note:: 

   IUPAC nomenclature currently only allows for a single **AND** group and
   a single **OR** group on a molecule.  The V3000 format allows for multiple
   independent **AND** and **OR** groups.  Names are generated as if all the
   **AND** centers are in a single **AND** group and all the **OR** centers are
   in a single **OR** group.  This will be remedied when IUPAC defines a
   naming convention for these more complex cases.

Isotopes
--------

.. _figure_Isotopes:

.. figure:: lexichemtk/images/IsotopeExamples.*
   :align:  center

   **Isotopes**

     An isotopically substituted compound has a composition such that 
     essentially all the molecules of the compound have only the indicated
     nuclide at each designated position. For all other positions, the 
     absence of nuclide indication means that the nuclide composition is 
     the natural one [IUPAC-2014]_.

To name isotopically substituted compounds:

   The name of an isotopically substituted compound is formed by inserting
   in parentheses the nuclide symbol(s), preceded by any necessary locant(s),
   letters and/or numerals, before the name or preferably before the 
   denomination of that part of the compound that is isotopically substituted.
   Immediately after the parentheses there is neither space nor hyphen, except
   that when the name, or a part of a name, includes a preceding locant, a 
   hyphen is inserted. When polysubstitution is possible, the number of atoms
   substituted is always specified as a right subscript to the atomic symbol(s),
   even in case of monosubstitution [IUPAC-2014]_.

For names composed of two or more words:
    
   the isotopic descriptor is placed before the appropriate word or part of the 
   word that includes the nuclide(s), unless unambiguous locants are available
   or are unnecessary [IUPAC-2014]_.

For more details, please refer to chapter 8 of the IUPAC Nomenclature of
Organic Compounds Draft 2004 [IUPAC-2014]_.

Output Name Styles
===============================================================================

Naming functionality supports the generation of several *styles* of
compound names. The currently predefined name styles are *OpenEye*
(the default), IUPAC, CAS, Traditional and Systematic. *OpenEye* names
loosely correspond to the kinds of names familiar to a medicinal chemist.
These names are intended to be a subset of the IUPAC 2005 standard's
acceptable names, but not necessarily the PIN (Preferred IUPAC Name).
These correspond to the types of names found in a Sigma-Aldrich catalog or
a Journal of Medicinal Chemistry article, for example.

IUPAC names are intended to follow the IUPAC 2005 recommendations for
the Preferred IUPAC Name (PIN). Future releases may further refine this
definition to provide IUPAC2005, IUPAC93 and IUPAC79 name styles that
reflect the corresponding standard's preferred name.

The CAS name style is intended to follow the Chemical Abstracts Service's
naming conventions, where they differ from IUPAC's.

The Traditional name style corresponds to forms of compound naming
that are now no longer acceptable to the IUPAC rules. The boundary
between whether a trivial/common name is considered *OpenEye* or
Traditional when it is acceptable to IUPAC but not preferred is blurred,
with *OpenEye* attempting to follow the more prevalent usage.

Finally, Systematic names correspond to the fully systematic IUPAC
names that the IUPAC preferred names are slowly converging towards.

Examples of Name Style Differences
===============================================================================

Some of the concepts explained in the previous section are probably
best clarified through some real examples.

Example OpenEye vs. IUPAC vs. Systematic Differences
------------------------------------------------------------------------------

* The SMILES string ``O`` is called 'water' by the *OpenEye* name style,
  but 'oxidane' by the IUPAC and Systematic name styles.

* The SMILES ``C#C`` is called 'acetylene' by the *OpenEye* and IUPAC
  name styles, but 'ethyne' by the Systematic name style.

* The SMILES prefix ``*Nc1ccccc1`` is called 'anilino' by the *OpenEye* and
  IUPAC name styles, but 'phenylamino' by the Systematic name style.

* The SMILES prefix ``*O[N+]#[C-]`` is called 'fulminato' by the *OpenEye*
  name style, but 'isocyanooxy' by the IUPAC and Systematic name styles.

* The SMILES prefix ``*C(=O)C`` is called 'acetyl' in the *OpenEye* and
  IUPAC name styles, but 'ethanoyl' in the Systematic name style.

* The SMILES string ``CC(=O)C`` is called 'acetone'' in the *OpenEye*
  name style, but 'propan-2-one' in the IUPAC and Systematic name styles.

* The SMILES string ``C(=O)O`` is called 'formic acid' in the *OpenEye*
  and IUPAC name styles, but 'methanoic acid' in the Systematic name style.

Example OpenEye/IUPAC vs. CAS Differences
------------------------------------------------------------------------------

* The SMILES string ``c1ccccc1CCCCCCC`` is named as '1-phenylheptane' by
  the *OpenEye* and IUPAC name styles, but as 'heptylbenzene' by the CAS
  name style.

* The SMILES prefix ``*[BH2]`` is called 'boranyl' by the *OpenEye* and
  IUPAC name styles, but as 'boryl' by the CAS name style.

Example OpenEye/IUPAC vs. Traditional Differences
------------------------------------------------------------------------------

* The SMILES prefix ``*S`` is called 'sulfanyl' by the *OpenEye* and IUPAC
  name styles, but as 'mercapto' by the Traditional name style.

* The SMILES string ``CCCCCCCCC(=O)O`` is called 'nonanoic acid' by
  the *OpenEye* and IUPAC name styles, but as 'pelargonic acid' by the
  Traditional name style.


.. _lexichem_part_examples:

========
Examples
========

.. toctree::
   :maxdepth: 3

   examples_summary


.. _lexichem_chapter_examples:

*************************
Lexichem TK Examples
*************************

The following table lists the currently available **Lexichem TK** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`mol2nam_example<lexichem_section_examples_mol2nam>`
        - convert molecules to names
      * - :ref:`nam2mol_example<lexichem_section_examples_nam2mol>`
        - convert names to molecules
      * - :ref:`translate_example<lexichem_section_examples_translate>`
        - translate names between languages
      * - :ref:`CipStereo_example<lexichem_section_examples_cipstereo>`
        - perceives the CIP (Cahn-Ingold-Prelog) stereo information for molecules

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`mol2nam_example.py<lexichem_section_examples_mol2nam>`
        - convert molecules to names
      * - :ref:`nam2mol_example.py<lexichem_section_examples_nam2mol>`
        - convert names to molecules
      * - :ref:`translate_example.py<lexichem_section_examples_translate>`
        - translate names between languages

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`Mol2Nam_example<lexichem_section_examples_mol2nam>`
        - convert molecules to names
      * - :ref:`Nam2Mol_example<lexichem_section_examples_nam2mol>`
        - convert names to molecules
      * - :ref:`Translate_example<lexichem_section_examples_translate>`
        - translate names between languages

**Examples:**

.. oe:language:: c++

    .. toctree::
       :maxdepth: 1

       examples_cipstereo
       examples_mol2nam
       examples_nam2mol
       examples_translate

.. oe:language:: python java csharp

    .. toctree::
       :maxdepth: 1

       examples_mol2nam
       examples_nam2mol
       examples_translate



.. _lexichem_section_examples_mol2nam:

Converting Molecules to Names
=============================

Converts a file of chemical structures (specified by *-in* option) into
chemical names (*-out* option), in a choice of language (*-language* option),
encodings (*-encoding* option) and styles (*-style* option).

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> mol2nam_example --help

.. oe:language:: python

   .. code-block:: console

      prompt> python mol2nam_example.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java Mol2Nam_example --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> Mol2Nam_example --help

will generate the following output:

.. code-block:: console

   Simple parameter list

     mol2nam
       I/O
         -in : Input filename
         -out : Output filename

       Lexichem
         -language : Language for output names.
         -style : Style of output names
         -capitalize : Capitalize output names.
         -tag : Set name as SD data with tag
         -delim : Append name to title using "delim"
         -charset : Choose charset/encoding for output names.

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mol2nam_example.py <../../../../wrappers/python/examples/iupac/mol2nam_example.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/iupac/mol2nam_example.py

   .. only:: oepdf

      .. oe:source:: mol2nam_example.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`mol2nam_example.cpp <../../../../sublibs/tklibs/iupac/examples/mol2nam_example.cpp>`
         and
         :download:`mol2nam_example.txt <../../../../sublibs/tklibs/iupac/examples/mol2nam_example.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: mol2nam_example.cpp
         :language: c++

      with interface file

      .. oe:source:: mol2nam_example.txt
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Mol2Nam_example.java <../../../../wrappers/java/examples/openeye/examples/oeiupac/Mol2Nam_example.java>`
         and
         :download:`Mol2Nam_example.txt <../../../../wrappers/java/examples/openeye/examples/oeiupac/Mol2Nam_example.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: Mol2Nam_example.java
         :language: java

      with interface file

      .. oe:source:: Mol2Nam_example.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Mol2Nam_example.cs <../../../../wrappers/csharp/Csharp-Examples/OEIUPAC/Mol2Nam_example.cs>`

   .. only:: oepdf

      .. oe:source:: Mol2Nam_example.cs
         :language: csharp


.. _lexichem_section_examples_nam2mol:

Converting Names to Molecules
=============================

Converts a file of chemical names (specified by the *-in* option) of a
specific language (*-language* option) into a file of chemical structures
(specified by the *-out* option).

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> nam2mol_example --help

.. oe:language:: python

   .. code-block:: console

      prompt> python nam2mol_example.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java Nam2Mol_example --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> Nam2Mol_example --help

will generate the following output:

.. code-block:: console

   Simple parameter list

     nam2mol
       I/O
         -in : Input filename
         -out : Output filename

       Lexichem
         -language : Language for input names.
         -tag : Set name as SD data with tag
         -empty : Output an empty molecule for unparseable names
         -charset : Choose charset/encoding for input names.

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`nam2mol_example.py <../../../../wrappers/python/examples/iupac/nam2mol_example.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/iupac/nam2mol_example.py

   .. only:: oepdf

      .. oe:source:: nam2mol_example.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`nam2mol_example.cpp <../../../../sublibs/tklibs/iupac/examples/nam2mol_example.cpp>`
         and
         :download:`nam2mol_example.txt <../../../../sublibs/tklibs/iupac/examples/nam2mol_example.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: nam2mol_example.cpp
         :language: c++

      with interface file

      .. oe:source:: nam2mol_example.txt
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Nam2Mol_example.java <../../../../wrappers/java/examples/openeye/examples/oeiupac/Nam2Mol_example.java>`
         and
         :download:`Nam2Mol_example.txt <../../../../wrappers/java/examples/openeye/examples/oeiupac/Nam2Mol_example.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: Nam2Mol_example.java
         :language: java

      with interface file

      .. oe:source:: Nam2Mol_example.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Nam2Mol_example.cs <../../../../wrappers/csharp/Csharp-Examples/OEIUPAC/Nam2Mol_example.cs>`

   .. only:: oepdf

      .. oe:source:: Nam2Mol_example.cs
         :language: csharp


.. _lexichem_section_examples_translate:

Translating Names Between Languages
===================================

Translates a file of chemical names (specified by the *-in* option) in a
specific language (*-from* option) into a file of names (specified by
the *-out* option) in another language (*-to* option).

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> translate_example --help

.. oe:language:: python

   .. code-block:: console

      prompt> python translate_example.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java Translate_example --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> Translate_example --help

will generate the following output:

.. code-block:: console

   Simple parameter list

     translate
       -nobanner : Suppress the program banner.
       -in : Input filename
       -out : Output filename
       -from : Language for input names.
       -to : Language for input names.
       -from_charset : Choose charset/encoding for input names.
       -to_charset : Choose charset/encoding for output names.

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`translate_example.py <../../../../wrappers/python/examples/iupac/translate_example.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/iupac/translate_example.py

   .. only:: oepdf

      .. oe:source:: translate_example.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`translate_example.cpp <../../../../sublibs/tklibs/iupac/examples/translate_example.cpp>`
         and
         :download:`translate_example.txt <../../../../sublibs/tklibs/iupac/examples/translate_example.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: translate_example.cpp
         :language: c++

      with interface file

      .. oe:source:: translate_example.txt
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Translate_example.java <../../../../wrappers/java/examples/openeye/examples/oeiupac/Translate_example.java>`
         and
         :download:`Translate_example.txt <../../../../wrappers/java/examples/openeye/examples/oeiupac/Translate_example.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: Translate_example.java
         :language: java

      with interface file

      .. oe:source:: Translate_example.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Translate_example.cs <../../../../wrappers/csharp/Csharp-Examples/OEIUPAC/Translate_example.cs>`

   .. only:: oepdf

      .. oe:source:: Translate_example.cs
         :language: csharp



.. _lexichem_part_api:

********************************
API
********************************

.. toctree::
   :maxdepth: 2

   OEIUPACConstants/OEIUPACConstants
   OEIUPACFunctions/index



.. _OEIUPACConstants:

*******************
OEIUPAC Constants
*******************

.. oe:namespace:: OEIUPAC

.. toctree::

   OECharSet
   OEIUPAC
   OELanguage


.. oe:namespace:: OEIUPAC

.. oe:constnamespace:: OECharSet

   This namespace contains constants for defining the character
   set for character conversion.

   .. oe:constant:: DEFAULT

      No character conversion.

   .. oe:constant:: ASCII

      See :oe:func:`OEIUPAC::OEToASCII` for format details.

   .. oe:constant:: HTML

      See :oe:func:`OEIUPAC::OEToHTML` for format details.

   .. oe:language:: c++ csharp

      .. oe:constant:: LATIN1

         See :oe:func:`OEIUPAC::OEToLatin1` for format details.

   .. oe:constant:: UTF8

      See :oe:func:`OEIUPAC::OEToUTF8` for format details.

   .. oe:constant:: SJIS

      See :oe:func:`OEIUPAC::OEToSJIS` for format details.

   .. oe:constant:: EUCJP

      See :oe:func:`OEIUPAC::OEToEUCJP` for format details.


.. oe:namespace:: OEIUPAC

.. oe:constnamespace:: OEIUPAC

   This namespace contains constants.

   .. oe:constant:: OENamStyleOpenEye

      This constant is used to specify the (default) predefined OpenEye
      name style to the :oe:func:`OEIUPAC::OECreateIUPACName` function.

   .. oe:constant:: OENamStyleTraditional

      This constant is used to specify the predefined traditional name
      style to the :oe:func:`OEIUPAC::OECreateIUPACName` function.

   .. oe:constant:: OENamStyleSystematic

      This constant is used to specify the predefined systematic name
      style to the :oe:func:`OEIUPAC::OECreateIUPACName` function.

   .. oe:constant:: OENamStyleIUPAC

      This constant is used to specify the predefined IUPAC 2005 name
      style to the :oe:func:`OEIUPAC::OECreateIUPACName` function.

   .. oe:constant:: OENamStyleCAS

      This constant is used to specify the predefined Chemical Abstracts
      Service (CAS) name style to the :oe:func:`OEIUPAC::OECreateIUPACName` function.

   .. oe:constant:: OENamStyleCASIndex

      This constant is used to specify the predefined Chemical Abstracts
      Service (CAS) permuted index name style to the :oe:func:`OEIUPAC::OECreateIUPACName`
      function.

   .. oe:constant:: OENamStyleAutoNom

      This constant is used to specify the predefined MDL/Beilstein AutoNom
      name style to the :oe:func:`OEIUPAC::OECreateIUPACName` function.

   .. oe:constant:: OENamStyleIUPAC79
   
      This constant is used to specify the predefined IUPAC 1979 name
      style to the :oe:func:`OEIUPAC::OECreateIUPACName` function.

   .. oe:constant:: OENamStyleIUPAC93

      This constant is used to specify the predefined IUPAC 1993 name
      style to the :oe:func:`OEIUPAC::OECreateIUPACName` function.

   .. oe:constant:: OENamStyleACDName

      This constant is used to specify the predefined ACD name style
      to the :oe:func:`OEIUPAC::OECreateIUPACName` function.


.. oe:namespace:: OEIUPAC

.. oe:constnamespace:: OELanguage

   This namespace contains constants for defining which language to 
   translate to/from using :oe:func:`OEIUPAC::OEFromLanguage` and 
   :oe:func:`OEIUPAC::OEToLanguage`.

   Depending on the language, the translation functions may expect ``\u``
   escaped Unicode characters.  In general the translations only use
   characters in the Basic Multilingual Plane (BMP).  Each language below
   indicates the range of Unicode characters which are handled.  Character
   set conversion should take into account the range of Unicode expected.

   .. oe:constant:: ENGLISH

      This constant is used to specify the American dialect of English.
      This is currently a synonym of the constant 
      :oe:const:`OEIUPAC::OELanguage::AMERICAN`.  Uses only ASCII
      characters.

   .. oe:constant:: AMERICAN

      This constant is used to specify the American dialect of English to
      This is currently a synonym of the constant
      :oe:const:`OEIUPAC::OELanguage::ENGLISH`.  Uses only ASCII
      characters.

   .. oe:constant:: BRITISH

      This constant is used to specify the traditional British dialect
      of English.  Uses only ASCII characters.

   .. oe:constant:: INTERNATIONAL
 
      This constant is used to specify the international dialect of English.
      Uses only ASCII characters.

   .. oe:constant:: CHINESE

      This constant is used to specify the Chinese language.
      Uses CJK characters in the Unicode BMP.

   .. oe:constant:: DANISH

      This constant is used to specify the Danish language.  Uses ASCII and
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range.

   .. oe:constant:: DUTCH

      This constant is used to specify the Dutch language.  Uses ASCII and
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range.

   .. oe:constant:: FRENCH

      This constant is used to specify the French language.  Uses ASCII and
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range.

   .. oe:constant:: GERMAN

      This constant is used to specify the German language.  Uses ASCII and
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range.

   .. oe:constant:: GREEK

      This constant is used to specify the Greek language. Uses ASCII and
      Greek Unicode characters in the ``\u0370`` to ``\u03ff`` range.

   .. oe:constant:: HUNGARIAN

      This constant is used to specify the Hungarian language. Uses ASCII,
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range and
      Latin Extended-A Unicode characters in the ``\u0100`` to ``\u017f``
      range.

   .. oe:constant:: IRISH

      This constant is used to specify the Irish language. Uses ASCII and
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range.

   .. oe:constant:: ITALIAN

      This constant is used to specify the Italian language. Uses ASCII and
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range.

   .. oe:constant:: JAPANESE

      This constant is used to specify the Japanese language.
      Uses CJK characters in the Unicode BMP.

   .. oe:constant:: POLISH

      This constant is used to specify the Polish language. Uses ASCII,
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range and
      Latin Extended-A Unicode characters in the ``\u0100`` to ``\u017f``
      range.

   .. oe:constant:: PORTUGUESE

      This constant is used to specify the Portuguese language. Uses ASCII and
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range.

   .. oe:constant:: ROMANIAN

      This constant is used to specify the Romanian language. Uses ASCII,
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range and
      Latin Extended-A Unicode characters in the ``\u0100`` to ``\u017f``
      range.

   .. oe:constant:: RUSSIAN

      This constant is used to specify the Russian language.  Uses ASCII and
      Cyrillic Unicode characters in the ``\u0400`` to ``\u04ff`` range.

   .. oe:constant:: SLOVAK

      This constant is used to specify the Slovak language. Uses ASCII,
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range and
      Latin Extended-A Unicode characters in the ``\u0100`` to ``\u017f``
      range.

   .. oe:constant:: SPANISH

      This constant is used to specify the Spanish language. Uses ASCII and
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range.

   .. oe:constant:: SWEDISH

      This constant is used to specify the Swedish language. Uses ASCII and
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range.

   .. oe:constant:: WELSH

      This constant is used to specify the Welsh language. Uses ASCII,
      Latin-1 Unicode characters in the ``\u00a0`` to ``\u00ff`` range and
      Latin Extended-A Unicode characters in the ``\u0100`` to ``\u017f``
      range.


*******************************************************************************
OEIUPAC Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OECapitalizeName.rst
   OECreateIUPACName.rst
   OEFromBritish.rst
   OEFromChinese.rst
   OEFromDanish.rst
   OEFromDutch.rst
   OEFromFrench.rst
   OEFromGerman.rst
   OEFromGreek.rst
   OEFromHTML.rst
   OEFromHungarian.rst
   OEFromIrish.rst
   OEFromItalian.rst
   OEFromJapanese.rst
   OEFromKOI8R.rst
   OEFromLanguage.rst
   OEFromLatin1.rst
   OEFromPolish.rst
   OEFromPortuguese.rst
   OEFromRomanian.rst
   OEFromRussian.rst
   OEFromSlovak.rst
   OEFromSpanish.rst
   OEFromSwedish.rst
   OEFromUTF8.rst
   OEFromWelsh.rst
   OEGetCIPStereo.rst
   OEGetIUPACCharSet.rst
   OEGetIUPACLanguage.rst
   OEGetIUPACNamStyle.rst
   OEIUPACGetArch.rst
   OEIUPACGetLicensee.rst
   OEIUPACGetPlatform.rst
   OEIUPACGetRelease.rst
   OEIUPACGetSite.rst
   OEIUPACGetVersion.rst
   OEIUPACIsLicensed.rst
   OELowerCaseName.rst
   OENameLocant.rst
   OEParseIUPACName.rst
   OEReorderIndexName.rst
   OESetCIPStereo.rst
   OEToASCII.rst
   OEToBritish.rst
   OEToChinese.rst
   OEToDanish.rst
   OEToDutch.rst
   OEToEUCJP.rst
   OEToFrench.rst
   OEToGerman.rst
   OEToGreek.rst
   OEToHTML.rst
   OEToHungarian.rst
   OEToIrish.rst
   OEToItalian.rst
   OEToJapanese.rst
   OEToLanguage.rst
   OEToLatin1.rst
   OEToPolish.rst
   OEToPortuguese.rst
   OEToRomanian.rst
   OEToRussian.rst
   OEToSJIS.rst
   OEToSlovak.rst
   OEToSpanish.rst
   OEToSwedish.rst
   OEToUTF8.rst
   OEToWelsh.rst


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OECapitalizeName

.. oe:function:: OECapitalizeName

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OECapitalizeName(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OECapitalizeName(ptr: str) -> str

   Capitalize the appropriate first letter of a name generated by
   :oe:func:`OEIUPAC::OECreateIUPACName`. This function should be
   called after translating the name to a foreign language, but before
   converting the character set encoding.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OECreateIUPACName

.. oe:function:: OECreateIUPACName

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OECreateIUPACName(const OEChem::OEMolBase& mol,
                                       const unsigned char* style = OENamStyleOpenEye,
                                       const bool warn = true)

   .. oe:language:: python

      .. oe:api:: python

         OECreateIUPACName(mol: Union[OEGraphMol,OEMol,OEQMol],
                           style: str = OENamStyleOpenEye, warn: bool = True) -> str

   This function attempts to generate a 'reasonable' IUPAC name for the
   given molecule, mol, and return the result in a string. These
   'reasonable' names attempts to be one of the recommended IUPAC names
   for a compound, however occasionally this function may fall back to
   using IUPAC 'systematic' naming for parts of a molecule. Any parts
   of a molecule that cannot be named result in the substring ``BLAH``
   appearing in the returned string.

   The optional style argument can be used to control and customize
   the style of the names generated by this function. The nine
   currently predefined name styles are  

   * :oe:const:`OEIUPAC::OEIUPAC::OENamStyleOpenEye` (the default), 
   * :oe:const:`OEIUPAC::OEIUPAC::OENamStyleIUPAC`,
   * :oe:const:`OEIUPAC::OEIUPAC::OENamStyleIUPAC79`,
   * :oe:const:`OEIUPAC::OEIUPAC::OENamStyleIUPAC93`,
   * :oe:const:`OEIUPAC::OEIUPAC::OENamStyleTraditional`,
   * :oe:const:`OEIUPAC::OEIUPAC::OENamStyleAutoNom`, 
   * :oe:const:`OEIUPAC::OEIUPAC::OENamStyleCAS`,
   * :oe:const:`OEIUPAC::OEIUPAC::OENamStyleCASIndex` and 
   * :oe:const:`OEIUPAC::OEIUPAC::OENamStyleSystematic`.

   After the name has been generated it may be translated into one of
   several languages, for example using the
   :oe:func:`OEIUPAC::OEToGerman` or :oe:func:`OEIUPAC::OEToJapanese`
   functions, then optionally capitalized
   using :oe:func:`OEIUPAC::OECapitalizeName`, and
   finally converted into a final character encoding, for example
   using :oe:func:`OEIUPAC::OEToUTF8` or :oe:func:`OEIUPAC::OEToHTML`.

   *warn*
      If ``false``, suppresses warning messages when a name cannot be generated.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromBritish

.. oe:function:: OEFromBritish

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromBritish(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromBritish(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from British English
   to American English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromChinese

.. oe:function:: OEFromChinese

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromChinese(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromChinese(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from simplified or
   traditional Chinese to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromDanish

.. oe:function:: OEFromDanish

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromDanish(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromDanish(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Danish to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromDutch

.. oe:function:: OEFromDutch

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromDutch(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromDutch(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Dutch to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromFrench

.. oe:function:: OEFromFrench

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromFrench(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromFrench(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from French to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromGerman

.. oe:function:: OEFromGerman

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromGerman(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromGerman(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from German to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromGreek

.. oe:function:: OEFromGreek

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromGreek(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromGreek(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Greek to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromHTML

.. oe:function:: OEFromHTML

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromHTML(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromHTML(ptr: str) -> str

   Convert the string 'ptr' from the HTML character encoding to *Lexichem*'s
   internal encoding, which uses ``\u`` escapes to represent non-ASCII
   characters.  Handles conversion of HTML markup to the to internal
   markup representation.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromHungarian

.. oe:function:: OEFromHungarian

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromHungarian(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromHungarian(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Hungarian to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromIrish

.. oe:function:: OEFromIrish

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromIrish(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromIrish(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Irish to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromItalian

.. oe:function:: OEFromItalian

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromItalian(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromItalian(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Italian to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromJapanese

.. oe:function:: OEFromJapanese

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromJapanese(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromJapanese(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Japanese to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromKOI8R

.. oe:function:: OEFromKOI8R

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromKOI8R(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromKOI8R(ptr: str) -> str

   Convert the string 'ptr' from the Russian KOI-8 character encoding to
   the internal string encoding using ``\u`` escapes to represent
   non-ASCII unicode characters.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromLanguage

.. oe:function:: OEFromLanguage

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromLanguage(const char* ptr, unsigned int lang)

   .. oe:language:: python

      .. oe:api:: python

         OEFromLanguage(ptr: str, lang: int) -> str

   This is a helper wrapper function that can be used to convert the
   chemical name specified by 'ptr' from the language specified by 'lang' to
   English. The languages are specified by the constants in the
   :oe:constns:`OEIUPAC::OELanguage` namespace.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromLatin1

.. oe:function:: OEFromLatin1

   .. oe:api::

      std::string OEFromLatin1(const char* ptr)

   Convert the string 'ptr' from the Latin1 character encoding to *Lexichem*'s
   internal encoding, which uses ``\u`` escapes to represent non-ASCII
   characters.

   .. note::

      This function is not available in Java or Python as those language
      environments use other character sets.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromPolish

.. oe:function:: OEFromPolish

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromPolish(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromPolish(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Polish to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromPortuguese

.. oe:function:: OEFromPortuguese

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromPortuguese(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromPortuguese(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Portuguese to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromRomanian

.. oe:function:: OEFromRomanian

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromRomanian(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromRomanian(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Romanian to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromRussian

.. oe:function:: OEFromRussian

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromRussian(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromRussian(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Russian to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromSlovak

.. oe:function:: OEFromSlovak

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromSlovak(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromSlovak(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Slovak to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromSpanish

.. oe:function:: OEFromSpanish

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromSpanish(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromSpanish(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Spanish to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromSwedish

.. oe:function:: OEFromSwedish

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromSwedish(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromSwedish(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from Swedish to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromUTF8

.. oe:function:: OEFromUTF8

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromUTF8(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromUTF8(ptr: str) -> str

   Convert the string 'ptr' from the UTF-8 character encoding to *Lexichem*'s
   internal encoding, which uses ``\u`` escapes to represent non-ASCII
   characters.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEFromWelsh

.. oe:function:: OEFromWelsh

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFromWelsh(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEFromWelsh(ptr: str) -> str

   Convert the chemical name specified by 'ptr' from simplified or
   traditional Welsh to English.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEGetCIPStereo

.. oe:function:: OEGetCIPStereo

   .. oe:language:: c++ java csharp

      .. oe:api::

         char OEGetCIPStereo(const OEChem::OEMolBase& mol,
                             const OEChem::OEAtomBase* atm)
         char OEGetCIPStereo(const OEChem::OEMolBase& mol,
                             const OEChem::OEBondBase* bnd)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCIPStereo(mol: Union[OEGraphMol,OEMol,OEQMol], atm: OEAtomBase) -> str
         OEGetCIPStereo(mol: Union[OEGraphMol,OEMol,OEQMol], bnd: OEBondBase) -> str

   These functions return the Cahn-Ingold-Prelog descriptor for the given
   atom or bond stereo center, from the stereochemistry set on the
   :ref:`OEMolBase <OEChem_OEMolBase>`. For chiral atom centers,
   the :ref:`OEAtomBase <OEChem_OEAtomBase>` form of this function returns
   either 'R' or 'S' for specified CIP stereo centers,
   'N' for CIP stereo centers that don't have stereo specified
   (*i.e.* :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified`
   returns ``false``), and 'X' for atoms that are not CIP stereo centers.
   For double bonds, the :ref:`OEBondBase <OEChem_OEBondBase>` form
   of this function returns either 'E' or 'Z' specified CIP stereo
   centers, 'N' for CIP stereo centers that don't have stereo specified
   (*i.e.* :oe:meth:`OEChem::OEBondBase::HasStereoSpecified`
   returns ``false``), and 'X' for bonds that are not CIP stereo centers.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEGetIUPACCharSet

.. oe:function:: OEGetIUPACCharSet

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetIUPACCharSet(const std::string& charset)

   .. oe:language:: python

      .. oe:api:: python

         OEGetIUPACCharSet(charset: str) -> int

   Returns a constant in the :oe:constns:`OEIUPAC::OECharSet` namespace
   based on the value of the name.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEGetIUPACLanguage

.. oe:function:: OEGetIUPACLanguage

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetIUPACLanguage(const std::string& langStr)

   .. oe:language:: python

      .. oe:api:: python

         OEGetIUPACLanguage(langStr: str) -> int

   Returns a constant in the :oe:constns:`OEIUPAC::OELanguage` namespace
   based on the value of the name.  Name can be a language name
   or two-letter country code.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEGetIUPACNamStyle

.. oe:function:: OEGetIUPACNamStyle

   .. oe:language:: c++ java csharp

      .. oe:api::

         const unsigned char* OEGetIUPACNamStyle(const std::string& style)

   .. oe:language:: python

      .. oe:api:: python

         OEGetIUPACNamStyle(style: str) -> str

   Returns a pointer to the style (:oe:constns:`OEIUPAC::OEIUPAC`) associated with
   the given name.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEIUPACGetArch

.. oe:function:: OEIUPACGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEIUPACGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEIUPACGetArch() -> str

   Returns the system architecture.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEIUPACGetLicensee

.. oe:function:: OEIUPACGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIUPACGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEIUPACGetLicensee(licensee: str) -> bool

   Determines the valid licensee.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEIUPACGetPlatform

.. oe:function:: OEIUPACGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEIUPACGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEIUPACGetPlatform() -> str

   Returns the system platform.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEIUPACGetRelease

.. oe:function:: OEIUPACGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEIUPACGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEIUPACGetRelease() -> str

   Returns the *Lexichem* toolkit release number.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEIUPACGetSite

.. oe:function:: OEIUPACGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIUPACGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEIUPACGetSite(site: str) -> bool

   Determines whether a valid site is present.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEIUPACGetVersion

.. oe:function:: OEIUPACGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEIUPACGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEIUPACGetVersion() -> int

   Returns *Lexichem* toolkit build date.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEIUPACIsLicensed

.. oe:function:: OEIUPACIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIUPACIsLicensed(const char* feature = 0,
                                unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEIUPACIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **Lexichem TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **Lexichem TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **Lexichem TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OELowerCaseName

.. oe:function:: OELowerCaseName

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OELowerCaseName(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OELowerCaseName(ptr: str) -> str

   Convert the specified compound name to lower-case. This function
   understands chemical nomenclature and foreign alphabets. This function
   should be called prior to translating a name from a foreign language,
   as the language translation routines assume that the name is
   lower-case.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OENameLocant

.. oe:function:: OENameLocant

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OENameLocant(unsigned int loc, bool iupac = false)

   .. oe:language:: python

      .. oe:api:: python

         OENameLocant(loc: int, iupac: bool = False) -> str

   Generate the lexical form of a *Lexichem* locant index. The
   molecules created by the function
   :oe:func:`OEIUPAC::OEParseIUPACName` are annotated with locant
   information in each atom's integer atom type field. These locant
   indices may be retrieved using *OEChem*'s
   :oe:func:`OEChem::OEAtomBase::GetIntType` method.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEParseIUPACName

.. oe:function:: OEParseIUPACName

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEParseIUPACName(OEChem::OEMolBase& mol, const char* name)

   .. oe:language:: python

      .. oe:api:: python

         OEParseIUPACName(mol: Union[OEGraphMol,OEMol,OEQMol], name: str) -> bool

   This function parses the compound name (not necessarily a systematic
   or preferred IUPAC name) from the NULL-terminated string given by name,
   and places the processed molecule in mol. This function returns ``true``
   if the name could be parsed without problems and false otherwise. 
   If the function returns ``false``, the mol will contain as much of the
   name as could be processed.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEReorderIndexName

.. oe:function:: OEReorderIndexName

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEReorderIndexName(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEReorderIndexName(ptr: str) -> str

   Attempt to reorder the specified permuted index name. This permute
   strings such as "benzene, chloro-" into the form "chloro-benzene"
   which can then be processed by the :oe:func:`OEIUPAC::OEParseIUPACName`
   function.

   This function returns an empty string (or the original input string)
   if its argument is not recognized as a permuted index name.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OESetCIPStereo

.. oe:function:: OESetCIPStereo

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetCIPStereo(OEChem::OEMolBase& mol, OEChem::OEAtomBase* atm,
                             char s)
         bool OESetCIPStereo(OEChem::OEMolBase& mol, OEChem::OEBondBase* bnd,
                             char s)

   .. oe:language:: python

      .. oe:api:: python

         OESetCIPStereo(mol: Union[OEGraphMol,OEMol,OEQMol], atm: OEAtomBase,
                        s: str) -> bool
         OESetCIPStereo(mol: Union[OEGraphMol,OEMol,OEQMol], bnd: OEBondBase,
                        s: str) -> bool

   Set the internal *OEChem* stereochemistry from the given CIP stereo
   descriptor. For :ref:`OEAtomBase <OEChem_OEAtomBase>` the descriptor must be
   either 'R' or 'S', and for :ref:`OEBondBase <OEChem_OEBondBase>`  the descriptor
   must be either 'E' or 'Z'. Returns ``true`` if the stereochemistry was
   successfully set, and ``false`` otherwise: *i.e.* the descriptor was
   invalid or the specified atom or bond was not a CIP stereo center. 


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToASCII

.. oe:function:: OEToASCII

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToASCII(const char* ptr, const bool remove_markup = true)

   .. oe:language:: python

      .. oe:api:: python

         OEToASCII(ptr: str, remove_markup: bool = True) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName` optionally post-processed by a
   language translation function, from the internal encoding, which
   uses ``\u`` escapes to represent non-ASCII characters, into a reduced
   7-bit ASCII representation by mapping accented 8-bit characters into their
   ASCII counterparts.

   The 'remove_markup' flag controls the disposition of italics,
   superscript, and subscript markup. If the value is ``true`` (the default),
   the markup is removed.  If ``false``, the markup is left in the output
   string, which should be post-processed.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToBritish

.. oe:function:: OEToBritish

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToBritish(const char* ptr, bool sulph)

   .. oe:language:: python

      .. oe:api:: python

         OEToBritish(ptr: str, sulph: bool) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from the default American
   output, to either British spelling (when 'sulph' is ``true``) or
   IUPAC international spelling (when 'sulph' is ``false``).

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToChinese

.. oe:function:: OEToChinese

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToChinese(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToChinese(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to simplified Chinese.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToDanish

.. oe:function:: OEToDanish

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToDanish(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToDanish(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Danish.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToDutch

.. oe:function:: OEToDutch

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToDutch(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToDutch(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Dutch.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToEUCJP

.. oe:function:: OEToEUCJP

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToEUCJP(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToEUCJP(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName` post-processed by a call to 
   :oe:func:`OEIUPAC::OEToJapanese`, from the
   default encoding which uses ``\u`` escapes to represent unicode
   characters to instead use the EUC-JP character encoding for Japanese
   characters.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToFrench

.. oe:function:: OEToFrench

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToFrench(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToFrench(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to French.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToGerman

.. oe:function:: OEToGerman

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToGerman(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToGerman(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to German.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToGreek

.. oe:function:: OEToGreek

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToGreek(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToGreek(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Greek.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToHTML

.. oe:function:: OEToHTML

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToHTML(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToHTML(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName` optionally post-processed by a
   language translation function, from the default internal encoding, which
   uses ``\u`` escapes to represent non-ASCII characters, to use HTML
   mark-up to represent Latin1 characters, unicode characters,
   italics, superscripts, and subscripts.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToHungarian

.. oe:function:: OEToHungarian

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToHungarian(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToHungarian(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Hungarian.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToIrish

.. oe:function:: OEToIrish

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToIrish(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToIrish(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Irish.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToItalian

.. oe:function:: OEToItalian

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToItalian(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToItalian(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Italian.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToJapanese

.. oe:function:: OEToJapanese

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToJapanese(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToJapanese(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Japanese.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToLanguage

.. oe:function:: OEToLanguage

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToLanguage(const char* ptr, unsigned int lang)

   .. oe:language:: python

      .. oe:api:: python

         OEToLanguage(ptr: str, lang: int) -> str

   This is a helper wrapper function that can be used to convert the
   chemical name specified by 'ptr' from English to the language specified
   by 'lang'. The languages are specified by the constants in the
   :oe:constns:`OEIUPAC::OELanguage` namespace.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToLatin1

.. oe:function:: OEToLatin1

   .. oe:api::

      std::string OEToLatin1(const char* ptr, const bool remove_markup = true)

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName` optionally post-processed by a
   language translation function, from the internal encoding, which
   uses ``\u`` escapes to represent non-ASCII characters, to Latin1 character
   encoding.

   the 'remove_markup' flag controls the disposition of italics,
   superscript, and subscript markup. If the value is 'true' (the default),
   the markup is removed.  If 'false', the markup is left in the output string,
   which should be post-processed.

   .. note::

      This function is not available in Java or Python as those language
      environments use other character sets.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToPolish

.. oe:function:: OEToPolish

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToPolish(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToPolish(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Polish.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToPortuguese

.. oe:function:: OEToPortuguese

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToPortuguese(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToPortuguese(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Portuguese.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToRomanian

.. oe:function:: OEToRomanian

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToRomanian(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToRomanian(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Romanian.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToRussian

.. oe:function:: OEToRussian

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToRussian(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToRussian(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Russian.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToSJIS

.. oe:function:: OEToSJIS

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToSJIS(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToSJIS(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName` post-processed by a call to 
   :oe:func:`OEIUPAC::OEToJapanese`, from the
   default encoding which uses ``\u`` escapes to represent unicode
   characters to instead use the Shift-JIS character encoding for
   Japanese characters.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToSlovak

.. oe:function:: OEToSlovak

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToSlovak(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToSlovak(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Slovak.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToSpanish

.. oe:function:: OEToSpanish

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToSpanish(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToSpanish(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Spanish.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToSwedish

.. oe:function:: OEToSwedish

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToSwedish(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToSwedish(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Swedish.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToUTF8

.. oe:function:: OEToUTF8

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToUTF8(const char* ptr, const bool remove_markup = true)

   .. oe:language:: python

      .. oe:api:: python

         OEToUTF8(ptr: str, remove_markup: bool = True) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName` optionally post-processed by a
   language translation function, from the internal encoding, which
   uses ``\u`` escapes to represent non-ASCII characters, to UTF-8 character
   encoding.

   The 'remove_markup' flag controls the disposition of italics,
   superscript, and subscript markup. If the value is 'true' (the default),
   the markup is removed.  If 'false', the markup is left in the output string,
   which should be post-processed.


.. oe:namespace:: OEIUPAC

.. meta::
   :keywords: OEToWelsh

.. oe:function:: OEToWelsh

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEToWelsh(const char* ptr)

   .. oe:language:: python

      .. oe:api:: python

         OEToWelsh(ptr: str) -> str

   Convert the string 'ptr', typically the output of the function
   :oe:func:`OEIUPAC::OECreateIUPACName`, from English to Welsh.

   See :oe:constns:`OEIUPAC::OELanguage` for character set information.


.. _lexichem_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version2_9_5
   version2_9_4
   version2_9_3
   version2_9_2
   version2_9_1
   version2_9_0
   version2_8_1
   version2_8_0
   version2_7_5
   version2_7_4
   version2_7_3
   version2_7_2
   version2_7_1
   version2_7_0
   version2_6_7
   version2_6_6
   version2_6_5
   version2_6_4
   version2_6_3
   version2_6_2
   version2_6_1
   version2_6_0
   version2_5_2
   version2_5_1
   version2_5_0
   version2_4_2
   version2_4_1
   version2_4_0
   version2_3_2
   version2_3_0
   version2_2_3
   version2_2_2
   version2_2_0
   version2_1_2
   version2_1_1
   version2_1_0
   version2_0_2
   version2_0_0
   version1_9_0
   version1_8_0
   version1_7_0
   version1_6_0
   version1_5_0 
   version1_4_0 
   version1_3_0 
   version1_2_0 
   version1_1_0 
   version1_0_0 



Lexichem TK 2.9.5
================================================================================

Minor internal improvements have been made.



Lexichem TK  1.0
================================================================================

On a benchmark of 250251 compounds in the NCI00 database, ``mol2nam``
is able to convert 220922 structures (88.28%) to names without BLAH.
Of these 220922 names, ``nam2mol`` is able to convert 177032 (80.13%)
back into structures.

OEParseIUPACName Improvements
--------------------------------------------------------------------------------

In addition to a great many other improvements to the name parsing code,
the *Lexichem* parser now contains an internal dictionary allowing the
recognition of common non-systematic names, such as 'ranitidine'
and 'zantac'.

OECreateIUPACName Improvements
--------------------------------------------------------------------------------

In addition to a great many improvements to the name generation code,
the *Lexichem* naming functionality now allows the specification of a
naming style, allowing the compound to be named in either a
traditional, OpenEye, IUPAC, CAS or systematic naming style.



Lexichem TK  1.1 
================================================================================

* On a benchmark of 250251 compounds in the NCI00 database, ``mol2nam``
  is able to convert 220924 structures (88.28%) to names without BLAH.
  Of these 220924 names, ``nam2mol`` is able to convert 177145 (80.18%)
  back into structures.

* A new :oe:func:`OEIUPAC::OEIUPACIsLicensed` API has been added so allow applications
  to check whether *Lexichem*'s parsing and naming functionality can safely
  be used.

OEParseIUPACName Improvements
--------------------------------------------------------------------------------

The *Lexichem* name parsing routines now handle a small number of structural
abbreviations when parsing names.  For example, it can now handle names
like '``3-CF3-5-NO2-benzoic acid``'.  The usual improvements in name
parsing, including more entries for common names in the Lexichem dictionary.
Support for names containing multiple explicit hydrogen locants, such as
'``pyrimidine-2,4(1H,3H)-dione``' and
'``2,4(1H,3H)-pyrimidinedione``'.

OECreateIUPACName Improvements
--------------------------------------------------------------------------------

A serious bug that could cause a core dump when naming thioperoxoic acids
has been fixed.  The performance of compound naming has been improved.  The
usual improvements in the names generated (following the IUPAC standards
more closely).



Lexichem TK  1.2 
================================================================================

On a benchmark of 250251 compounds in the NCI00 database, ``mol2nam``
is able to convert 220949 structures (88.29%) to names without BLAH.
Of these 220949 names, ``nam2mol`` is able to convert 182438 (82.57%)
back into structures.



Lexichem TK  1.3 
================================================================================

* On a benchmark of 250251 compounds in the NCI00 database, ``mol2nam``
  is able to convert 221205 structures (88.39%) to names without BLAH.
  Of these 221205 names, ``nam2mol`` is able to convert 183444 (82.93%)
  back into structures.

* The major announcement of this release is the support for stereochemistry
  in compound naming.  The CIP rules for assigning R/S descriptors to
  tetrahedral chiral centers, and E/Z descriptors to double bonds are
  used during name generation.



Lexichem TK  1.4 
================================================================================

* On a benchmark of 250251 compounds in the NCI00 database, ``mol2nam``
  is able to convert 221254 structures (88.41%) to names without BLAH.
  Of these 221254 names, ``nam2mol`` is able to convert 192345 (86.93%)
  back into structures.

* *Lexichem* v1.4 is predominantly a maintenance to provide a version of the
  *oeiupac* library that is compatible with *OEChem* v1.4.  However,
  there have been a number of significant improvements to name parsing,
  and minor improvements to name generation since last month's v1.3 release.

* This release also includes the ability to generate compound names in 
  several languages.  In addition, to British spellings, *Lexichem* can now
  generate German, Italian, French, Spanish, Swedish, Dutch and Polish
  names.  Whilst the translations for German, Italian, Swedish and Polish are
  quite comprehensive, those for French, Spanish and Dutch are less complete.

* A potential ambiguity with the ring names '``oxazole``' and
  '``thiazole``' has also been resolved.  The IUPAC documentation states
  that it is permissible to omit locants from Hantzsch-Widman names when
  the locants are consecutive, *i.e.* '``1,2,3,4-tetrazole``' may be
  written as '``tetrazole``', and '``1,2-oxazirene``' is preferred as
  '``oxazirene``'.  Unfortunately, this conflicts with the traditional
  interpretations of '``oxazole``' as meaning '``1,3-oxazole``' and
  '``thiazole``' as '``1,3-thiazole``'.  Instead the traditional names
  '``isoxazole``' and '``isothiazole``' denote the '``1,2-``' forms.
  This ambiguity, that affected IUPAC-style (but not OpenEye-style) names,
  has been resolved by preserving the locants, so that the IUPAC names
  '``1,2-oxazole``', '``1,3-oxazole``', '``1,2-thiazole``' and
  '``1,3-thiazole``' are now generated for '``isoxazole``', '``oxazole``',
  '``isothiazole``' and '``thiazole``' respectively.



Lexichem TK  1.5 
================================================================================

* On a benchmark of 250251 compounds in the NCI00 database, ``mol2nam``
  is able to convert 223066 structures (89.14%) to names without BLAH.
  Of these 223066 names, ``nam2mol`` is able to convert 192487 (86.29%)
  back into structures.

* This release includes a significant number of improvements to both
  name generation and name parsing.  For example, ``nam2mol`` now supports
  more numbered locants, such as '``N1-methylaniline``' and for
  'Maybridge-style' locant names such as ``N'1`` (interpreted as
  the more common ``N1'``).  These and similar changes have 
  increased the conversion rate for the 71367 compound names in the
  2003 Maybridge catalog, from 69.51% in v1.4 to 80.80% in v1.5.

* This release includes the ability to generate compound names in Japanese,
  and much improved Spanish and Polish naming support.  In order to better
  support internationalization, APIs are now available to map from the
  default ISO-8859-1 output to either 7-bit ASCII, UTF-8, HTML and for
  Japanese locales, Shift-JIS or EUC-JP.

* Although impossible in the general case, several improvements have 
  been made to *Lexichem*'s compound naming such that the assigned names
  are now more stable under arbitrary input ordering of atoms and bonds.



Lexichem TK  1.6
================================================================================

* On a benchmark of 250251 compounds in the NCI00 database, ``mol2nam``
  is able to convert 233010 structures (93.11%) to names without BLAH.
  Of these 233010 names, ``nam2mol`` is able to convert 221331 (94.99%)
  back into structures.

* This release includes a significant number of improvements to both
  name generation and name parsing.  For example, both name generation and
  parsing now do a much better job on ring fusion nomenclature, for names
  like '``5,6,7,8-tetrahydro[1,2,4]triazolo[4,3-a]pyridine``'.  There's
  also much improved handling of charged ring systems.  The name parsing
  conversion rate for the 71367 compound names in the 2003 Maybridge
  catalog is now 93.25% in v1.6, up from 80.80% in v1.5.

* In name generation, new naming styles have been added for MDL/Beilstein
  AutoNom style names, for CAS permuted index style names (and there are
  new placeholder styles for IUPAC79 and IUPAC93 naming).  A large
  number of improvements have been made to names generated using the
  'traditional' naming style.  A new :oe:func:`OEIUPAC::OECapitalizeName`
  API function is available to capitalizing the appropriate first letter
  of a generated name, such as '``p-tert-Butylbenzoic acid``'.

* Several bug fixes have been made to the Cahn-Ingold-Prelog (CIP)
  chirality perception implementation.

* The :oe:func:`OEIUPAC::OEParseIUPACName` function is now able return supplementary
  locant annotations for each atom.  This function now stores an integer
  locant code/identifier in the integer atom type field of each atom, which
  may be retrieved using the :oe:meth:`OEChem::OEAtomBase::GetIntType` method
  and converted into a readable/displayable string using the recently
  exposed :oe:func:`OEIUPAC::OENameLocant` function.  This functionality is
  a recent addition (obviously), and most but not all supported ring systems
  and parents have locant annotations in this initial release.

* Finally, for the adventurous, new APIs for translating compound names
  from foreign languages into English are available as the experimental
  :oe:func:`OEIUPAC::OEFromJapanese`, :oe:func:`OEIUPAC::OEFromSwedish` and 
  :oe:func:`OEIUPAC::OEFromSpanish`  functions.  
  Additionally, a :oe:func:`OEIUPAC::OEFromUTF8` function is available for
  converting UTF-8 encoded strings into the escaped sequences expected by
  these functions (effectively the inverse of :oe:func:`OEIUPAC::OEToUTF8`).



Lexichem TK  1.7 
================================================================================

* On a benchmark of 250251 compounds in the NCI00 database, ``mol2nam``
  is able to convert 234155 structures (93.57%) to names without BLAH.
  Of these 234155 names, ``nam2mol`` is able to convert 223246 (95.34%)
  back into structures.

* This release includes a significant number of improvements to both
  name generation and name parsing.  Several bugs have also been fixed.
  The name parsing conversion rate for the 71367 compound names in the
  2003 Maybridge catalog is now up to 93.81%.

* A new :oe:func:`OEIUPAC::OELowerCaseName` function has been added to the *Lexichem*
  toolkit API.  This function converts the input chemical name to
  lower-case, whilst preserving the case sensitive aspects of IUPAC
  names.  This functionality allows uppercase and mixed case names to
  be translated into English, as the ``OEFrom<Foo>`` functions
  assume their input is lowercase.  For example, this feature allows
  ``AGUA`` to be recognized via :oe:func:`OEIUPAC::OEFromSpanish`.

* A new :oe:func:`OEIUPAC::OEReorderIndexName` function has been added to the
  *Lexichem* toolkit API.  This function attempts to reorder the
  given permuted index name into a form that can be handled by the
  :oe:func:`OEIUPAC::OEParseIUPACName` function.  For example, this will convert
  the string '``benzene, chloro-``' into '``chloro-benzene``'.

* A number of improvements and bug fixes have been made to *Lexichem*'s
  naming styles.  For example, AutoNom and CAS permuted index styles
  are now far more AutoNom-like and CAS-like respectively.  Naming
  of metallocenes and fullerenes is much improved.

* Some dramatic improvements have been made with foreign language
  support.  On the 250251 compounds in the NCI00 database mentioned
  above, we now round-trip 100% to German and back without any
  differences.  Japanese, Spanish and Swedish rates are all currently
  above 99%.  Support for Hungarian and Polish has been dramatically
  improved.



Lexichem TK  1.8 
================================================================================

* On a benchmark of 250251 compounds in the NCI00 database, ``mol2nam``
  is able to convert 234296 structures (93.62%) to names without BLAH.
  Of these 234296 names, ``nam2mol`` is able to convert 228102 (97.36%)
  back into structures.

* This release includes a significant number of improvements to both
  name generation and name parsing.  Several bugs have also been fixed.  
  The name parsing conversion rate for the 71367 compound names in the
  2003 Maybridge catalog is now up to 95.12%.

* One of the major parsing improvements in this release is the much
  improved support for handling von Baeyer ring nomenclature.
  We can now parse names such as:

  * '``1,4-dithioniabicyclo[2.2.2]octane``',
  * '``bicyclo[4.2.0]octa-1(6),2,4-triene``' and
  * '``2,4-diazaspiro[4.4]nonane-1,3-dione``'.



Lexichem TK  1.9 
================================================================================

* On a benchmark of 250251 compounds in the NCI00 database, ``mol2nam``
  is able to convert 234297 structures (93.62%) to names without BLAH.
  Of these 234297 names, ``nam2mol`` is able to convert 231566 (98.83%)
  back into structures.

* This release includes a significant number of improvements to both
  name generation and name parsing.  Several bugs have also been fixed.
  The name parsing conversion rate for the 71367 compound names in the
  2003 Maybridge catalog is now up to 95.24%.

* Several improvements have been made to the specification of CIP
  stereochemistry during name generation.  For example, previously linking
  groups such as ``amidino``, ``carbamimidoyl`` and ``diazenyl``
  would forget to specify E/Z descriptors if they contained a chiral double
  bond with specified stereochemistry.  We would also fail to place some
  chiral prefixes such as ``(E)-styrl`` and ``(Z)-cinnamyl`` in
  brackets which can lead to ambiguity when interpreting the generated name.



Lexichem TK  2.0.0 
================================================================================

* The applications have a new, standardized command line interface. Please
  have a look at the updated documentation for *mol2nam*, *nam2mol* and 
  *translate*.

* This release includes the ability to parse stereo on input names. Previously 
  it was read and ignored.

* Fixed a bug where, in rare cases, the output name depended on input atom
  ordering.

* Fixed a crash in determining CIP stereo for very large, pathological 
  molecules. 



Lexichem TK  2.0.2
================================================================================

* Updated ring numbering templates that
  catch a significant fraction of ring naming failures in the
  NCBI's PubChem database.

* Updated the rules we use for naming
  the prefix "2-carboxyethyl" and friends, which we'd previously
  name "3-hydroxy-3-oxopropyl" (or similar).

* Added parsing support for the traditional prefix "phenethoxy".

* Removed the insertion of a single explicit
  space after a semi-colon.  We now prefer to preserve the original
  input string, rather than beautify it.  This also plays nicer
  with HTML style input, where "&lambda;" really doesn't need an
  explicit space character after it.

* Added several minor tweaks to AutoNom-style naming, such as 
  "isophthalic acid" and "benzene-1,2-carbaldehyde".

* Updated some erroneous SMILES in the dictionary including
  sulfamethoxazole and tinidazole.



Lexichem TK 2.1.0
================================================================================

* Performance benchmark results: conversion of canonical isomeric
  smiles to names and back to the same canonical isomeric smiles. Size
  of the databases are given in brackets after the name.

+------------------+---------------+----------------+
|                  | v2.0.2        | v2.1.0         |
+==================+===============+================+
| Database         | Round Tripping| Round Tripping |
+------------------+---------------+----------------+
| Maybridge (63872)|    88.94%     |    98.69%      |
+------------------+---------------+----------------+
| MDDR (111171)    |    48.69%     |    88.54%      |
+------------------+---------------+----------------+
| NCI (250251)     |    84.54%     |    92.32%      |
+------------------+---------------+----------------+
| Wombat (53214)   |    52.80%     |    89.54%      |
+------------------+---------------+----------------+

New features
--------------------------------------------------------------------------------

* Added support for converting von Baeyer names to structures e.g. tricyclo[5.2.2.0^{3,5}]undecane is converted to :C1CC2CCC1CC3CC3C2.

* Added basic support for a number of steroid, alkaloid and terpene parent structures.

* Added support for L/D-amino acids.

* Added support for R-groups for name to structure conversion.

* Added support for both linear and branched polyspiro alicyclic hydrocarbons.

* Activated stereochemistry support for name to structure.

* Added a number of dictionary entries.

* Added a number of ring templates.

* Added partial support for von Baeyer name generation from structures.

Bug fixes
--------------------------------------------------------------------------------

* Added support for names: 2H-imidazol-4-thiol and 1,2-dihydroimidazole-5-imine.

* Added support for barium(2+), sodium(1+).

* *LEXICHEM* now understands trifluoroneodymium.

* Added support for dihydrides e.g. calcium dihydride, magnesium dihydride.

* *LEXICHEM* now supports multi-ammonium salts and multi-derivative ethynyl pyridines.

* Added support for oxoarsinite based compounds.

* Added support for a number of additional metal linking groups e.g. Mg, K, La, Dy, Er, V, Ni etc.

* Fixed a bug in the name: 3-acetyl-8-bromo-1,2,3,6-tetrahydro-azepino[4,5-b]indole-2,5-dicarboxylic acid diethyl ester.

* Corrected unicode conversion for: acetate, glycinate, nitrite and iodide.


Lexichem TK  2.1.1
================================================================================
Bug fixes
--------------------------------------------------------------------------------
* Fixed a bug with structure generation for tetramethylammonium pyrrolidine-2-carboxylate trihydrate.

* Components of salts are now separated by semi-colons.

* Added numerous dictionary entries. 

* Added additional ring templates.

* Fixed a bug with names including benzene) or benzene}, the appropriate substitution should have been phenyl.

* Fixed an issue when incorrect von Baeyer names are parsed to Lexichem, Lexichem now fails silently.

* Fixed dictionary lookup algorithm.

* Fixed a crash in Mol2Nam when a H-atom was part of the main ring system in simple spiro compounds.

* Fixed a bug in names like sulfuric acid mono(x) ester.


Lexichem TK  2.1.2
================================================================================

Bug fixes
--------------------------------------------------------------------------------

* 4-methylimidazole now explicitly adds a hydrogen atom to the nitrogen atom in position 1.

* Added imidazole ring template.

* Added explicit hydrogen to 6 dictionary entries: arestin, klinomycin, minocin, parsalmide, tetrodotoxin and vectrin.

* Fixed crash with name bis(methacryloyloxymethyl)tricyclo[5.2,1,0^{2,6}.

* Fixed crash in name tetraethyn.

* Added ring template: iindeno[7,1-de:1',7'-fg][1,3,2]dioxaphosphocine.

* Corrected dictionary entry: O-orsellinic acid, o-phenanthroline and syrosingopine. 


Lexichem TK  2.2.0
================================================================================

Feature Requests
--------------------------------------------------------------------------------

* Added an OEThrow.Warning, warning that names generated with BLAH are incorrect.

* Added support for the token BOC (tert-Butyloxycarbonyl).

* 'OEIUPAC::OEMatchDictionaryNames' added to extract names from Lexichem's 
  dictionary.

Bug fixes
--------------------------------------------------------------------------------

* Fixed a number of name failures concerning acenaphthoquinone derivatives.

* Added a number of ring templates and fixed an issue regarding loss
  of stereochemistry for the name
  N-[(E)-(1,3-dimethyl-4-piperidylidene)amino]-1,3-dimethyl-piperidin-4-imine
  on round-tripping.

* Added support for the name 7-chloro-1,3-dihydro-1-methyl-5-phenyl-1,4-benzodiazepin-2(3H)-one.

* Fixed a problem with locant numbering of bicyclic ring systems of the form bicyclo[3.1.0]hexane.

* Fixed rendering of cisplatin.

* Fixed a number of hydrazone entries.

* Removed all duplicates in dictionary.

* Fixed an issue with the name dicyclopentynyl acrylate.

* Fixed crashes on a number of malformed von Baeyer names.

* Fixed bug with sunitinib and triprolidine dictionary entries.

* Fixed 12H-benzo[g]pyrido[2,1-b]quinazoline ring system.


Lexichem TK  2.2.2
================================================================================

Bug fixes
--------------------------------------------------------------------------------

* Fixed a number of dictionary entries: arestin, klinomycin, minocin, tetrodotoxin and vectrin.

* Added ring template. For a tetracyclic triaza ring system.

* Added support for automatically determining R/S stereo center position for molecules
  with 1 stereo center e.g. (R)-2-(1H-indol-1-yl)propanoic acid would set the R on position 2.

* Added the ability to parse names with benzylamide in.




.. _section_lexichem_releasenotes_223:

Lexichem TK 2.2.3
================================================================================

New features
--------------------------------------------------------------------------------

* Added support for relative configuration (P-92.1.2 of IUPAC Nomenclature of Organic Compounds, Draft 2004). The stereodescriptors 
  "rel", "R*" and "S*". 

Minor bug fixes
--------------------------------------------------------------------------------

* The synonym "english" now returns OELanguage::AMERICAN.



Lexichem TK 2.3.0
================================================================================

New features
--------------------------------------------------------------------------------

* Name generation for racemic structures when the 'MDL AND' group is present in the MDL V3000 format. Stereodescriptors 'rac', 'RS' and 'SR'.
  (Section P-92.1.3 of the IUPAC Nomenclature of Organic Compounds, Draft 2004 - Racemates and meso compounds).
  Racemic stereogenic centers are labeled with 'RS' if the CIP stereo descriptor is 'R' and has the MDL AND group present,
  else 'SR' if the stereogenic center has the CIP stereo descriptor 'S' and an MDL AND group present. The prefix 'rac' is
  used in front of a set of descriptors or locants, if all stereogenic centers in the molecule are racemic.

.. _figure_Isotopes_23:

.. figure:: /_images/IsotopeExamples.png
   :align:  center

   **Isotope Example Depictions**

* Support has been added for name generation for isotopic carbon atoms in chains (e.g. the SMILES: ``C[15CH2]C[13CH2]C[15CH2]CCC`` will generate the name ``(4^{13}C,2,6-^{15}C_{2})nonane``), simple rings and simple suffixes (e.g. the SMILES: ``[13NH2]C(=[15O])C1=C[14CH]=CC=C1`` will generate the name
  ``(3^{14}C)cyclohexatriene(^{13}N,^{15}O)carboxamide``). The chemical structures generated from parsing the example SMILES strings into a molecule object are depicted in :ref:`Figure: Isotope Example Depictions <figure_Isotopes_23>`.

* Support for simple rings and simple suffixes in isotopic name generation
  e.g. the SMILES: ``[13NH2]C(=[15O])C1=C[14CH]=CC=C1`` will generate the name
  ``(3^{14}C)cyclohexatriene(^{13}N,^{15}O)carboxamide``

Minor bug fixes
--------------------------------------------------------------------------------

* Fixed Lexichem's thread safety. A global variable in Lexichem that has persisted since its first release in 2005, has been removed. This global variable affected the function :oe:func:`OEIUPAC::OEParseIUPACName`, used in name to structure conversion. Two thread safety issues used in structure to name conversion, namely: double bond (E/Z) CIP stereo (thread safety broken in the June 2012TK release) and enhanced relative stereochemistry (thread safety broken in the June 2013TK release), that affected the function :oe:func:`OEIUPAC::OECreateIUPACName`, have been resolved.

* :oe:func:`OEIUPAC::OEParseIUPACName` will no longer access invalid memory for names of the form '(di/tri/tetra)BLAH (ester/hydrazone/oxime/selenoxime/telluroxime/thioxime)'.



.. _section_lexichem_releasenotes_232:

Lexichem TK 2.3.2
================================================================================

New features
--------------------------------------------------------------------------------

* Added phosphorous oxychloride, and gleevec to the dictionary.

* Added a number of additional ring templates.

* Added support for isotopes in naming metal linking groups.

* Added structure to name support for deuterated water and phosphoryl trichloride.

.. oe:language:: python

   * :oe:func:`OEIUPAC::OEParseIUPACName` and
     :oe:func:`OEIUPAC::OECreateIUPACName` will now release the Python global
     interpreter lock while running.

Major bug fixes
--------------------------------------------------------------------------------

* Fixed a memory leak in structure to name generation for simple tricyclic fused ring systems.

Minor bug fixes
--------------------------------------------------------------------------------

* Reverted a regression in names like (R)-2-(1H-indol-1-yl)propanoic
  acid, where the locant position for the CIP stereo center was
  previously automatically determined.

* Updated the dictionary entry for lipitor to have two atorvastatin
  molecules and the water of crystallization.

* Updated anthramycin's representation to be canonical and isomeric.

* Tweaked the parser to correctly parse cyclosporin A without a warning.




.. _section_lexichem_releasenotes_240:

Lexichem TK 2.4.0
================================================================================

New features
--------------------------------------------------------------------------------

* Support for racemates and enhanced stereochemical name parsing.

Minor bug fixes
--------------------------------------------------------------------------------

* Removed unbounded stack allocations.

* Corrected the form of metformin in the dictionary.

* Fixed an issue with names like p/m/o-bis(trifluoromethyl)benzene
  that were defaulting to the ortho form.

* Fixed parsing of (R,S)-3-ethyl 5-methyl
  2-[(2-aminoethoxy)methyl]-4-(2-chlorophenyl)-6-methyl-1,4-dihydropyridine-3,5-dicarboxylate.

* Fixed an issue with an unnecessary isotopic prefix in the suffix for
  peroxycarboxylic acid esters.

* Added a number of ring templates.

* Fixed English to French translations that move the suffixes acetate,
  chloride, sulfate, and trisulfate to be prefixes connected with the
  "de" particle.



.. _section_lexichem_releasenotes_241:

Lexichem TK 2.4.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Tramadol removed from the dictionary since it is actually a racemic
  structure that was previously being returned as an absolute enantiomer.



.. _section_lexichem_releasenotes_242:

Lexichem TK 2.4.2
================================================================================

Important note
--------------------------------------------------------------------------------

* Custom dictionary entry points added in version 2.4.0
  (but not documented) have been removed pending redesign/reimplementation.

New features
--------------------------------------------------------------------------------

* New translate examples have been added for all languages (C++, C#, Java,
  Python).

Minor bug fixes
--------------------------------------------------------------------------------

* A memory leak that occurred when naming certain structures with
  Von Baeyer rings has been fixed.

* String length overflows in language translation code have been fixed.
  These overflows were functionally benign but did show up with certain
  sanitizing compilers.

* The internal name dictionary has been cleaned up:

  * The dictionary lookup for names for which one entry is a strict
    substring of another(eg: AZT and AZTREONAM) has been fixed.
  * All nitro groups are now charge-separated (4-valent).
  * Dash vs. space separators are now handled gracefully.  Dictionary entries
    with spaces now also match input names containing dashes.

* Warnings for name conversion failures have been modified.  When a name cannot
  be converted, the warning is now "Failed to parse name: BADNAME".
  Additional developer-oriented messages about "unexpected tokens" are now
  debug-level messages and are not seen by default.

Documentation fixes
--------------------------------------------------------------------------------

* PDF documentation will no longer throw a warning about "Arial-Bold
  bad BBox" in some PDF readers.


Lexichem TK 2.5.0
================================================================================

New features
--------------------------------------------------------------------------------

* Support for text markup (italics, superscripts, subscripts, special
  characters) has been improved and unified.

  * :oe:func:`OEIUPAC::OECreateIUPACName` function now generates
    names with the appropriate new text markup tokens (inspired by LaTeX):

    * Italics as: ~{}
    * Subscript as: _{}
    * Superscript as: ^{}

  * :oe:func:`OEIUPAC::OEToHTML` and :oe:func:`OEIUPAC::OEToUTF8`
    functions now properly handle the new markup tokens.
    :oe:func:`OEIUPAC::OEToUTF8` function has a new optional Boolean
    parameter that controls
    markup annotations. Set the new parameter to ``false`` in order to
    get the old behavior.

  * :oe:func:`OEIUPAC::OEFromHTML` function has been created to properly convert
    the markup to HTML tags.

Bug fixes
--------------------------------------------------------------------------------

* The handling of molecules with relative stereochemistry has been
  improved. Relative stereochemistry is a feature of the V3000 file
  format encapsulated in the **OEChem TK**.
  See the :ref:`OEGroupBase <OEChem_OEGroupBase>` class.

* Name generation for molecules with stereochemistry is better due to
  improvements to the Cahn-Ingold-Prelog stereochemistry perception in
  **OEChem TK**.



Lexichem TK 2.5.1
================================================================================

New features
--------------------------------------------------------------------------------

* Approximately 150 additional dictionary entries, including 2014 FDA
  small-molecule NDA approvals and some isotopic fragments for name suffixes,
  have been added.

Major bug fixes
--------------------------------------------------------------------------------

* The naming of Von Baeyer ring systems has been reworked to fix the numbering
  assignment. Previously, the substituent ordering was sometimes incorrectly perceived,
  resulting in names with non-preferred numberings of substituents on rings.

* The naming of Von Baeyer polycyclic systems has been improved.

Minor bug fixes
--------------------------------------------------------------------------------

* The handling of vowel elision for certain complex ring systems has been fixed.

* The naming of sulfur stereochemistry has been improved. Instances in which the sulfur
  stereo is in the suffix of the name (*e.g.*, "methyl (S)-methansulfinate") are
  now correctly handled.

Documentation changes
--------------------------------------------------------------------------------

* All examples have been rewritten (see the :ref:`lexichem_part_examples` chapter).

* The :ref:`translate<lexichem_section_examples_translate>` examples have
  been restructured to better handle the input and output character sets.

* Missing documentation for functions
  :oe:func:`OEIUPAC::OEGetIUPACCharSet`,
  :oe:func:`OEIUPAC::OEGetIUPACLanguage`,
  :oe:func:`OEIUPAC::OEGetIUPACNamStyle`,
  and constants :oe:constns:`OEIUPAC::OECharSet` has been added.
  Documentation for other constants has been reworked.


Lexichem TK 2.5.2
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* The perception of certain complex ring systems has been changed.  Ring
  systems with three separate fused components are now named using VonBaeyer
  nomenclature rather than fusion nomenclature.  In all but a few cases,
  these are more closely aligned with the IUPAC preferred names, and the
  resulting names round trip correctly.

Minor bug fixes
--------------------------------------------------------------------------------

* A bug affecting several specific VonBaeyer ring system numberings has
  been fixed.


Lexichem TK 2.6.0
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEIUPAC::OEFromBritish` function has been added for completeness.
  The name perception code already handled British-style input names
  without this conversion function; however, it is useful to have the
  function available for use by higher-level APIs that dispatch based
  on input language.

Major bug fixes
--------------------------------------------------------------------------------

* Handling of character sets for non-English language names has been improved.
  The internal string representation of all non-ASCII characters is now
  their ``\u`` escaped Unicode codepoints.  Previously, Latin-1 characters
  (e.g., the output of the :oe:func:`OEIUPAC::OEToFrench`) were encoded
  as their Latin-1 bytes (0x80 - 0xff).  Now they are encoded as
  escaped unicode.  This eliminates character encoding problems for the Java
  and Python language wrappers that occurred when intermediate
  name strings were being processed.  Now, only the following final character set encoding/decoding
  functions need to handle non-ASCII bytes:
  :oe:func:`OEIUPAC::OEFromHTML`,
  :oe:func:`OEIUPAC::OEFromKOI8R`,
  :oe:func:`OEIUPAC::OEFromLatin1`,
  :oe:func:`OEIUPAC::OEFromUTF8`,
  :oe:func:`OEIUPAC::OEToEUCJP`,
  :oe:func:`OEIUPAC::OEToHTML`,
  :oe:func:`OEIUPAC::OEToSJIS`,
  :oe:func:`OEIUPAC::OEToLatin1`, and
  :oe:func:`OEIUPAC::OEToUTF8`.

Minor bug fixes
--------------------------------------------------------------------------------

* Name-to-structure conversions for certain uncommon functional groups
  (nitramide, nitrile oxide, oxycyano) previously resulted in structures with 5-valent
  nitrogen.  These now result in charge-separated N(III) structures, consistent
  with other nitrogen functional groups.

Documentation changes
--------------------------------------------------------------------------------

* The documentation has been updated to indicate the range of Unicode
  codepoints that are handled for each of the language translation
  functions.  This allows users to determine the appropriate output
  character set conversion.
  For example, the Chinese language translation results in CJK characters
  in the Unicode Basic Multilingual Plane (BMP). Therefore, it is only
  appropriate to convert Chinese language names to UTF8 or HTML, which
  can handle the full Unicode BMP. Since the French language translation results
  in ASCII and Latin-1 characters, it is reasonable to use Latin1, UTF8, or
  HTML as the output character set.

* The example programs have been updated to better illustrate character set
  conversions.


Lexichem TK 2.6.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* A number of new high-frequency von Baeyer ring templates have been added.


Lexichem TK 2.6.2
================================================================================

New features
--------------------------------------------------------------------------------

* The template-based Von Baeyer ring-naming scheme has been replaced with
  an algorithmic approach.  This significantly improves the naming of
  complex ring systems.


Lexichem TK 2.6.3
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Previously, redundant cis-trans stereochemistry for certain multi-ring
  aromatic systems was not suppressed, resulting in names with erroneous E-Z
  specifications.  The stereo perception for these systems has been fixed.


Lexichem TK 2.6.4
================================================================================

* Minor internal improvements have been made.


Lexichem TK 2.6.5
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The name-to-structure conversion for amino acids has been improved.

* Recognition of several additional unnatural amino acids has been added.

* Problems with stereo handling and substituent numbering of some unnatural
  amino acids have been corrected.

Documentation changes
--------------------------------------------------------------------------------

* Example documentation has been updated and a ``-debug`` flag has been added
  to the ``mol2nam`` and ``nam2mol`` examples.



Lexichem TK 2.6.6
================================================================================

* Minor internal improvements have been made.


Lexichem TK 2.6.7
================================================================================

* Minor internal improvements have been made.


Lexichem TK 2.7.0
================================================================================

* Minor internal improvements have been made.




Lexichem TK 2.7.1
================================================================================

* Minor internal improvements have been made.



Lexichem TK 2.7.2
================================================================================

*Fall 2020*

Minor bug fixes
--------------------------------------------------------------------------------

* An issue that caused the function  :oe:func:`OEIUPAC::OEParseIUPACName` to incorrectly
  interpret elemental halogens as aromatic molecules due to their suffix “ine” has been fixed.
  Previously, the function failed to kekulize the halogens and therefore failed to parse them.

* An issue that caused the function :oe:func:`OEIUPAC::OEParseIUPACName` to fail to parse non-IUPAC
  names of carboxamide derivatives, such as benzimidazole-5-carboxylic acid, due to a failure to kekulize
  the benzimidazole rings has been fixed. 1H hydrogen is now added by default to benzimidazole
  if a prefix is not included to specify hydrogen locations.

* An issue that caused the function :oe:func:`OEIUPAC::OEParseIUPACName` to fail to parse names,
  such as carboxylic acid methyl amide, where methyl amide is used as a suffix has been fixed.



Lexichem TK 2.7.3
================================================================================

*July 2021*

New features
--------------------------------------------------------------------------------

* Support for input of many common drug names has been added.

* Support for SMILES input of disubstituted alkenes when unknown subsituents are marked as * has been added.
  For example,
  SMILES input of `*CCC*` is now parsed and named as 1,3-disubstitutedpropylene.

Major bug fixes
--------------------------------------------------------------------------------

* An issue with naming of highly branched carbons structures has been fixed.



Lexichem TK 2.7.4
================================================================================

*Fall 2021*

New features
--------------------------------------------------------------------------------

* Support for common alkaloid name conversion to ``SMILES`` was added.

Major bug fixes
--------------------------------------------------------------------------------

* A bug where isotopes were not labeled on certain ring substituents when naming
  molecules or ``SMILES`` has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* A bug where pyrazole ring substituents were not numbered correctly has been fixed.

* A bug where reaction input was incorrectly parsed into a single molecule has been
  fixed so that reaction input is now rejected as invalid in the name to molecule
  workflow.

* A bug where primary amines with non-IUPAC names, such as methylethylamine, were
  incorrectly parsed into ``SMILES`` has been fixed.




Lexichem TK 2.7.5
================================================================================

New features
--------------------------------------------------------------------------------
* Some new antiviral drug names are now supported in the name to molecule workflow.

Minor bug fixes
--------------------------------------------------------------------------------
* A bug with IUPAC naming of pyridine ring substitution has been fixed.





Lexichem TK 2.8.0
================================================================================

New features
--------------------------------------------------------------------------------
* Many conventional names for inorganic salts have been added to the name parser.

* Parsing for some non-IUPAC names, including DMF and beta-alanine, have been added.

Major bug fixes
--------------------------------------------------------------------------------
* Parsing of many common conventional inorganic salt names, such as calcium chloride, was corrected to
  include the correct number of anions in the resulting salt.

* Simple salt names no longer include a semicolon between parts of the name.

Minor bug fixes
--------------------------------------------------------------------------------
* An issue with ketone oxime stereochemistry naming has been fixed.

* An issue in cycloalkane stereochemistry naming has been fixed.

* An issue in parsing of carbonate salt names has been fixed.





Lexichem TK 2.8.1
================================================================================

Minor internal improvements have been made.





Lexichem TK 2.9.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Custom polymer naming was added in the molecule-to-name workflow to avoid memory overflow when reading in large polymers.
* Kekulization was added in the molecule-to-name workflow to ensure that the same aromatic structures produce the same
  names.
* Support was added for some cases of complex (bis-, tris-, tetrakis-, etc.) multipliers in the molecule-to-name and
  name-to-molecule workflows.





Lexichem TK 2.9.1
================================================================================

Minor internal improvements have been made.





Lexichem TK 2.9.2
================================================================================

Minor internal improvements have been made.



Lexichem TK 2.9.3
================================================================================

Minor internal improvements have been made.




Lexichem TK 2.9.4
================================================================================

Minor Bug Fixes
--------------------------------------------------------------------------------

* An issue has been fixed relating to IUPAC name generation where the term ``substituted`` was incorrectly
  inserted in certain cases.

* A round-trip conversion issue between SMILES and IUPAC names has been resolved for 
  cases where a SMILES string contained a single asterisk.


.. medchemtk toolkit documentation master file

###################################
OEMedChem Toolkit |medchem_version|
###################################

.. toctree::
   :maxdepth: 2

   introduction
   theory
   examples
   api

..  oe:language:: python

    .. toctree::
       :maxdepth: 1

       selected_examples_python

.. toctree::
   :maxdepth: 2

   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _chapter_oemedchem_intro:

********************************************************************************
Introduction
********************************************************************************

This manual is to familiarize the user with **OEMedChem TK**
functionality.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. role:: raw-html(raw)
   :format: html

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEBemisMurckoOptions, BemisMurckoOptions

.. _OEMedChem_OEBemisMurckoOptions:

.. oe:class:: OEBemisMurckoOptions

  .. oe:api::

    class OEBemisMurckoOptions : public OESystem::OEOptions

  The functions :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments` and
  :oe:func:`OEMedChem::OEGetBemisMurcko` both return sets of Bemis-Murcko fragments.
  The :ref:`OEBemisMurckoOptions <OEMedChem_OEBemisMurckoOptions>` class can be used to
  specify both the :oe:constns:`OEMedChem::OERegionType` of these fragments 
  and to add sidechains that match user-specified criteria to the main
  Bemis-Murcko framework.

  .. seealso::

     * :oe:func:`OEMedChem::OEGetBemisMurcko` function
     * :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments` function

  .. oe:method:: Constructors

    .. oe:language:: c++ java csharp

       .. oe:api::

          OEBemisMurckoOptions()

    .. oe:language:: python

       .. oe:api:: python

          OEBemisMurckoOptions() -> OEBemisMurckoOptions
          OEBemisMurckoOptions(arg2: OEBemisMurckoOptions) -> OEBemisMurckoOptions

    Default constructor, which sets the perceived fragment type to All, as defined in the
    :ref:`OERegionType <OEMedChem_OERegionType>` namespace. No additional SMARTS substituents are set.
  
   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBemisMurckoOptions & operator=(const OEBemisMurckoOptions &)

      Assignment operator.

  .. ################################################################
     # CreateCopy 
     ################################################################

  .. oe:method:: CreateCopy 

    .. oe:language:: c++ java csharp

       .. oe:api::

          OEBemisMurckoOptions* CreateCopy() const

    .. oe:language:: python

       .. oe:api:: python

          CreateCopy() -> OEBemisMurckoOptions

    Returns a pointer to a copy of the options object. 
  
  .. ################################################################
     # GetRegionType
     ################################################################

  .. oe:method:: GetRegionType

    .. oe:language:: c++ java csharp

       .. oe:api::

          std::string GetRegionType() const

    .. oe:language:: python

       .. oe:api:: python

          GetRegionType() -> str

    Returns the name of the :oe:constns:`OEMedChem::OERegionType` set in the options class. 
  
  .. ###############################################################
     # GetSubstituentSearch
     ################################################################

  .. oe:method:: GetSubstituentSearch

    .. oe:language:: c++ java csharp

       .. oe:api::

          OEChem::OESubSearch GetSubstituentSearch() const

    .. oe:language:: python

       .. oe:api:: python

          GetSubstituentSearch() -> OESubSearch

    Returns the subsearch used to add custom substituents to the Bemis-Murcko framework.  

  .. ################################################################
     # GetUnsaturatedHeteroBonds
     ################################################################

  .. oe:method:: GetUnsaturatedHeteroBonds

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool GetUnsaturatedHeteroBonds() const

    .. oe:language:: python

       .. oe:api:: python

          GetUnsaturatedHeteroBonds() -> bool

    Gets the boolean indicating whether sidechains beginning with unsaturated bonds to hetero atoms will
    be included in the main Bemis-Murcko framework.   
  
  .. ################################################################
     # SetRegionType
     ################################################################

  .. oe:method:: SetRegionType

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool SetRegionType(std::string regionType)

    .. oe:language:: python

       .. oe:api:: python

          SetRegionType(value: str) -> bool

    Sets the name of the :oe:constns:`OEMedChem::OERegionType` for fragments perceived. 
  
  .. ###############################################################
     # SetSubstituentSearch
     ################################################################

  .. oe:method:: SetSubstituentSearch

     .. oe:language:: c++ java csharp

        .. oe:api::

           bool SetSubstituentSearch(const OEChem::OESubSearch value)

     .. oe:language:: python

        .. oe:api:: python

           SetSubstituentSearch(value: OESubSearch) -> bool

    Sets an :ref:`OESubSearch <OEChem_OESubSearch>` for custom substituents to be added to the
    Bemis-Murcko framework. 

  .. ################################################################
     # SetUnsaturatedHeteroBonds
     ################################################################

  .. oe:method:: SetUnsaturatedHeteroBonds

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool SetUnsaturatedHeteroBonds(bool includeUnsaturatedHeteroBonds)

    .. oe:language:: python

       .. oe:api:: python

          SetUnsaturatedHeteroBonds(value: bool) -> bool

    Sets whether sidechains beginning with unsaturated bonds to hetero atoms will
    be included in the main Bemis-Murcko framework. To be included in the main
    framework when this option is true, the beginning atom of the sidechain 
    must satisfy the :ref:`OEIsHetero <OEChem_OEIsHetero>` predicate and the bond from
    the framework to this sidechain must have order greater than one. 
   
  .. ################################################################
     # Validate 
     ################################################################

  .. oe:method:: Validate 

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool Validate() const

    .. oe:language:: python

       .. oe:api:: python

          Validate() -> bool

    Returns true is the current settings in the options class are valid.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. role:: raw-html(raw)
   :format: html

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OECreateMMPIndexOptions, CreateMMPIndexOptions

.. _OEMedChem_OECreateMMPIndexOptions:

.. oe:class:: OECreateMMPIndexOptions

   .. oe:api::

      class OECreateMMPIndexOptions

   Encapsulates the properties that control a matched pair indexing analysis.

   .. seealso::

      * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` class
      * :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` class

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECreateMMPIndexOptions()
            OECreateMMPIndexOptions(const OEMatchedPairAnalyzerOptions& mmpopts)

      .. oe:language:: python

         .. oe:api:: python

            OECreateMMPIndexOptions(mmpopts: OEMatchedPairAnalyzerOptions) -> OECreateMMPIndexOptions

      Constructors that initialize an :ref:`OECreateMMPIndexOptions <OEMedChem_OECreateMMPIndexOptions>`
      object.  The default constructor provides the following properties:

      .. list-table::  **Default parameters of OEMatchedPairAnalyzerOptions**
         :widths: 50 50
         :header-rows: 1

         * - Property
           - Default value

         * - processor type
           - :oe:const:`OEMedChem::OEMatchedPairProcessor::Default`

         * - options
           - :oe:const:`OEMedChem::OEMatchedPairOptions::Default`

         * - bond fragmentation limit
           - 20

         * - heavy atom filter
           - 100

         * - indexable fragment filter based on :raw-html:`<br />`
             min,max heavy atom percentage of the :raw-html:`<br />`
             input structure
           - 85-100%

   .. ################################################################
      # GetMaxRecord
      ################################################################

   .. oe:method:: GetMaxRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxRecord() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxRecord() -> int

      Return the maximum number of records to index from the input structure file or
      ``0`` to indicate all structures should be indexed.

   .. ################################################################
      # GetMMPOptions
      ################################################################

   .. oe:method:: GetMMPOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMatchedPairAnalyzerOptions& GetMMPOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetMMPOptions() -> OEMatchedPairAnalyzerOptions

      Returns the options controlling the Matched Pair indexing information.

   .. ################################################################
      # GetNumThreads
      ################################################################

   .. oe:method:: GetNumThreads

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumThreads() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumThreads() -> int

      Returns the number of threads to use during the indexing phase.
      If the number of threads specified is ``0``, :oe:func:`OEPlatform::OEGetNumProcessors`
      will be used to interrogate the maximum threads allowed.

   .. ################################################################
      # GetTracer
      ################################################################

   .. oe:method: GetTracer DO NOT DOCUMENT

      .. oe:api::

         const OESystem::OEDots *GetTracer() const

   .. ################################################################
      # GetVerbose
      ################################################################

   .. oe:method:: GetVerbose

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetVerbose() const

      .. oe:language:: python

         .. oe:api:: python

            GetVerbose() -> int

      Return the level of output verbosity during the indexing activity.

   .. ################################################################
      # SetMaxRecord
      ################################################################

   .. oe:method:: SetMaxRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxRecord(unsigned int maxrec)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxRecord(maxrec: int) -> None

      Sets the maximum number of records to index from the input structure file.
      ``0`` indicates all structures should be indexed.

   .. ################################################################
      # SetNumThreads
      ################################################################

   .. oe:method:: SetNumThreads

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNumThreads(unsigned int nthreads)

      .. oe:language:: python

         .. oe:api:: python

            SetNumThreads(nthreads: int) -> None

      Sets the maximum number of threads to use during the indexing phase.
      If ``nthreads`` is set to ``0``, :oe:func:`OEPlatform::OEGetNumProcessors`
      will be used to interrogate the maximum threads allowed.

   .. ################################################################
      # SetTracer
      ################################################################

   .. oe:method:: SetTracer

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTracer(const OESystem::OEDots& dots)

      .. oe:language:: python

         .. oe:api:: python

            SetTracer(dots: OEDots) -> None

      Sets a tracer that can be used to show the progress of indexing.

      .. seealso::

         * :ref:`OEDots <OESystem_OEDots>` class in the **OEChem TK** manual

   .. ################################################################
      # SetVerbose
      ################################################################

   .. oe:method:: SetVerbose

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetVerbose(unsigned int verbose)

      .. oe:language:: python

         .. oe:api:: python

            SetVerbose(verbose: int) -> None

      Sets the level of output verbosity during the indexing activity.
      ``0 (off)``, ``1 (verbose)``, or ``2 (very verbose)`` are sufficient values for output verbosity.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OECreateMMPIndexStatus, CreateMMPIndexStatus

.. _OEMedChem_OECreateMMPIndexStatus:

.. oe:class:: OECreateMMPIndexStatus

   .. oe:api::

      class OECreateMMPIndexStatus

   Encapsulates the status information returned from a matched pair indexing analysis.

   .. seealso::

      * :oe:func:`OEMedChem::OECreateMMPIndexFile` function

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECreateMMPIndexStatus(bool valid = true)
            OECreateMMPIndexStatus(const OECreateMMPIndexStatus& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OECreateMMPIndexStatus(valid: bool = True) -> OECreateMMPIndexStatus
            OECreateMMPIndexStatus(rhs: OECreateMMPIndexStatus) -> OECreateMMPIndexStatus

   .. oe:method:: operator+
      :language: c++

      .. oe:api::

        OECreateMMPIndexStatus& operator+=(const OECreateMMPIndexStatus &addstatus)

      Summation operator that increments the current instance based on data from the 'addstatus' :ref:`OECreateMMPIndexStatus <OEMedChem_OECreateMMPIndexStatus>` object.

   .. ################################################################
      # AddIndexedMol
      ################################################################

   .. oe:method:: AddIndexedMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int AddIndexedMol()

      .. oe:language:: python

         .. oe:api:: python

            AddIndexedMol() -> int

      Increment the internal count of indexed molecule records by one.

   .. ################################################################
      # AddUnindexedMol
      ################################################################

   .. oe:method:: AddUnindexedMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int AddUnindexedMol()

      .. oe:language:: python

         .. oe:api:: python

            AddUnindexedMol() -> int

      Increment the internal count of unindexed molecule records by one.

   .. ################################################################
      # GetNumMatchedPairs
      ################################################################

   .. oe:method:: GetNumMatchedPairs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumMatchedPairs() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumMatchedPairs() -> int

      Return the number of Matched Pairs generated from indexing.

   .. ################################################################
      # GetNumMols
      ################################################################

   .. oe:method:: GetNumMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumMols() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumMols() -> int

      Return the internal count of indexed molecule records.

   .. ################################################################
      # GetTotalMols
      ################################################################

   .. oe:method:: GetTotalMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetTotalMols() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalMols() -> int

      Return the internal count of indexed plus unindexed molecule, (i.e., total) records.

   .. ################################################################
      # GetUnindexedMols
      ################################################################

   .. oe:method:: GetUnindexedMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetUnindexedMols() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnindexedMols() -> int

      Return the internal count of unindexed molecule records.

   .. ################################################################
      # SetNumMatchedPairs
      ################################################################

   .. oe:method:: SetNumMatchedPairs

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNumMatchedPairs(unsigned int mmps)

      .. oe:language:: python

         .. oe:api:: python

            SetNumMatchedPairs(nummmps: int) -> None

      Sets the internal count for the number of Matched Pairs generated from indexing.

   .. ################################################################
      # SetNumMols
      ################################################################

   .. oe:method:: SetNumMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNumMols(unsigned int indexed)

      .. oe:language:: python

         .. oe:api:: python

            SetNumMols(nummols: int) -> None

      Sets the internal count of indexed molecule records to the specified value.

   .. oe:method:: SetUnindexedMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetUnindexedMols(unsigned int unindexed)

      .. oe:language:: python

         .. oe:api:: python

            SetUnindexedMols(unindexed: int) -> None

      Sets the internal count of unindexed molecule records to the specified value.

   .. ################################################################
      # SetValid
      ################################################################

   .. oe:method:: SetValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetValid(bool valid)

      .. oe:language:: python

         .. oe:api:: python

            SetValid(valid: bool) -> None

      Sets the boolean validity of this status class.



.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMCSFragDatabase, MCSFragDatabase

.. _OEMedChem_OEMCSFragDatabase:

.. oe:class:: OEMCSFragDatabase

   .. oe:api::

      class OEMCSFragDatabase

   Performs a fragmentation indexing on an input set of structures to enable
   MCS-based similarity searching for compounds with common cores.

   .. seealso::

      * :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSFragDatabase(const OEMCSFragDatabaseOptions& opts = OEMCSFragDatabaseOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEMCSFragDatabase(opts: OEMCSFragDatabaseOptions = OEMCSFragDatabaseOptions()) -> OEMCSFragDatabase

      Default constructor that initializes the fragment database with the default options defined by
      :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSFragDatabase(const OEMCSFragDatabaseOptions& opts = OEMCSFragDatabaseOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEMCSFragDatabase(opts: OEMCSFragDatabaseOptions = OEMCSFragDatabaseOptions()) -> OEMCSFragDatabase

      Constructor that initializes the fragment database with the options defined by
      the :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>` argument.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMCSFragDatabase & operator=(const OEMCSFragDatabase & rhs)

      Assignment operator.

   .. oe:method:: AddConstMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            int AddConstMol(const OEChem::OEMolBase& inmol, int recordID = (-1))

      .. oe:language:: python

         .. oe:api:: python

            AddConstMol(inmol: Union[OEGraphMol,OEMol,OEQMol], recID: int = -1) -> int

      Adds the molecule to the index and returns the 0-based recordID
      if the structure was successfully added, or a negative index if the structure
      was unable to be indexed. Negative values can be used to retrieve
      status information for indexing failures. The optional user-defined
      recordID is provided to allow indexed fragments to be referenced
      to externally maintained data structures.  If the provided recordID is
      less than zero, an autogenerated index is returned which is
      an index greater than all ids seen so far.

   .. seealso::

      * :oe:constns:`OEMedChem::OEMatchedPairIndexStatus`
      * :oe:func:`OEMedChem::OEMatchedPairIndexStatusName`

   .. oe:method:: AddMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            int AddMol(OEChem::OEMolBase& inmol, int recordID = (-1))

      .. oe:language:: python

         .. oe:api:: python

            AddMol(inmol: Union[OEGraphMol,OEMol,OEQMol], recID: int = -1) -> int

      A high performance version of :oe:meth:`OEMedChem::OEMCSFragDatabase::AddConstMol`
      that eliminates molecule copy activities and modifies the passed molecule directly.
      The state of the returned structure after indexing activities is *undefined* and
      should generally be discarded or reinstantiated from the original source for
      any subsequent activities.

   .. oe:method:: ClearIndexedMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearIndexedMols()

      .. oe:language:: python

         .. oe:api:: python

            ClearIndexedMols() -> None

      This method discards the current index contents and frees internal memory in
      preparation for subsequent reindexing.

   .. oe:method:: CoreToMolecules

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<unsigned int>*CoreToMolecules(const std::string& core) const

      .. oe:language:: python

         .. oe:api:: python

            CoreToMolecules(core: str) -> Iterable[int]

      Given a fragmentation core, return the molecule ids that have this core from the index.

   .. oe:method:: CoreToMoleculeCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int CoreToMoleculeCount(const std::string& core) const

      .. oe:language:: python

         .. oe:api:: python

            CoreToMoleculeCount(core: str) -> int

      Given a fragmentation core, return a count of the number of molecules that have this core in the index.

   .. oe:method:: GetMaxCoreMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetMaxCoreMolecule(const char delim = '.') const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxCoreMolecule(delim: str = '.') -> str

      Return the most common core fragment(s) recorded in the index.  If there are multiple cores with the same occurrence count,
      the specified ``delim`` character is used to delimit the strings.

   .. oe:method:: GetMaxCoreMoleculeCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxCoreMoleculeCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxCoreMoleculeCount() -> int

      Return the maximum core occurrence count recorded in the index.

   .. oe:method:: GetMaxMolIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxMolIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMolIdx() -> int

      Returns the highest molecule id currently present in the index.

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMCSFragDatabaseOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEMCSFragDatabaseOptions

      Returns the currently active options for the instance.  Options
      cannot be changed, and require the desired options to be provided
      when the index is instantiated.

   .. oe:method:: GetScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMedChem::OEMCSMolSimScore>* GetScores(const OEChem::OEMolBase& query,
                                                                         unsigned int bgn = 0,
                                                                         unsigned int end = 0,
                                                                         unsigned int scorecounts = OEMCSScoreType::Default,
                                                                         const OEMCSSimFuncBase& scorefunc = OEMCSTanimotoSim()) const

      .. oe:language:: python

         .. oe:api:: python

            GetScores(query: Union[OEGraphMol,OEMol,OEQMol], bgn: int = 0,
                      end: int = 0, scorecounts: int,
                      scorefn: OEMCSSimFuncBase = OEMCSTanimotoSim()) -> Iterable[OEMCSMolSimScore]

      Performs similarity calculations between a query molecule
      and the fragment cores stored in the
      :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` object.
      It returns an iterator over the calculated similarity
      scores (:ref:`OEMCSMolSimScore <OEMedChem_OEMCSMolSimScore>`).
      Each :ref:`OEMCSMolSimScore <OEMedChem_OEMCSMolSimScore>` object holds a similarity score,
      an index of database molecule and the fragment core in common between the hit and the query.

      **bgn**, **end**
         The ``bgn`` and ``end`` arguments define the segment of the
         database on which the similarity calculation will take place.
         If both of these parameters are omitted (or set to zero), then
         the similarity calculation is performed on the entire
         fragment database.

      **scorecounts**
         The value that defines the type of similarity scores (atom or bond) returned by the
         :oe:meth:`OEMedChem::OEMCSFragDatabase::GetScores` method.
         The default type is :oe:const:`OEMedChem::OEMCSScoreType::AtomCount`.

      **scorefunc**
         A class that computes the similarity score.  By default this is
         :ref:`OEMCSTanimotoSim <OEMedChem_OEMCSTanimotoSim>` but an implementation of
         :ref:`OEMCSTverskySim <OEMedChem_OEMCSTverskySim>`  is also provided.
         By providing a class derived from :ref:`OEMCSSimFuncBase <OEMedChem_OEMCSSimFuncBase>`
         user-defined similarity measures other than the provided versions can be generated.

      .. note::

         * By default, the :oe:meth:`OEMedChem::OEMCSFragDatabase::GetScores`
           method calculates :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>`
           atom similarity scores.

   .. oe:method:: GetSortedScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMedChem::OEMCSMolSimScore>* GetSortedScores(const OEChem::OEMolBase& query,
                                                                               unsigned int limit = 0,
                                                                               unsigned int bgn = 0,
                                                                               unsigned int end = 0,
                                                                               bool descending = true,
                                                                               unsigned int scorecounts = OEMCSScoreType::Default,
                                                                               const OEMCSSimFuncBase& scorefunc = OEMCSTanimotoSim()) const

      .. oe:language:: python

         .. oe:api:: python

            GetSortedScores(query: Union[OEGraphMol,OEMol,OEQMol],
                            limit: int = 0, bgn: int = 0, end: int = 0,
                            descending: bool = True, scorecounts: int,
                            scorefn: OEMCSSimFuncBase = OEMCSTanimotoSim()) -> Iterable[OEMCSMolSimScore]

      Performs similarity calculations between a query molecule
      and the fragment cores stored in the
      :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` object.
      It returns an iterator over the calculated similarity
      scores (:ref:`OEMCSMolSimScore <OEMedChem_OEMCSMolSimScore>`) in sorted order.
      Each :ref:`OEMCSMolSimScore <OEMedChem_OEMCSMolSimScore>` object holds a similarity score
      an index of database molecule and the fragment core in common between the hit and query.

      **limit**
         The value that defines the number of similarity scores
         returned by the
         :oe:meth:`OEMedChem::OEMCSFragDatabase::GetSortedScores` method.
         If it is omitted (or set to zero) then all of the similarity
         scores are returned.

      **bgn**, **end**
         The ``bgn`` and ``end`` arguments define the segment of the
         database on which the similarity calculation will take place.
         If both of these parameters are omitted (or set to zero), then
         the similarity calculation is performed on the entire
         fragment database.

      **descending**
         A boolean value that indicates the direction of the sort values where
         ``true`` requests a descending sort and ``false`` requests ascending.

      **scorecounts**
         The value that defines the type of similarity scores (atom or bond) returned by the
         :oe:meth:`OEMedChem::OEMCSFragDatabase::GetSortedScores` method.
         The default type is :oe:const:`OEMedChem::OEMCSScoreType::AtomCount`.

      **scorefunc**
         A class that computes the similarity score.  By default this is
         :ref:`OEMCSTanimotoSim <OEMedChem_OEMCSTanimotoSim>` but an implementation of
         :ref:`OEMCSTverskySim <OEMedChem_OEMCSTverskySim>`  is also provided.
         By providing a class derived from :ref:`OEMCSSimFuncBase <OEMedChem_OEMCSSimFuncBase>`
         user-defined similarity measures other than the provided versions can be used.

      .. note::

         * By default, the :oe:meth:`OEMedChem::OEMCSFragDatabase::GetSortedScores`
           method calculates :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>`
           atom similarity scores and returns the highest scores first.

   .. oe:method:: IsIndexed

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsIndexed(unsigned int recordID) const

      .. oe:language:: python

         .. oe:api:: python

            IsIndexed(recID: int) -> bool

      Returns whether this record id is in the index.

   .. oe:method:: MoleculeToCores

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<const std::string>*MoleculeToCores(const OEChem::OEMolBase& mol,
                                                                    bool permuteFragments = true)

      .. oe:language:: python

         .. oe:api:: python

            MoleculeToCores(mol: Union[OEGraphMol,OEMol,OEQMol],
                            permuteFragments: bool = True) -> Iterable[str ]

      Given a molecule, return the fragmentation cores using either the
      provided fragmentation options, or using the fragmentation options from
      the :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` instance.  If the
      ``permuteFragments`` argument is ``true``, all combinations
      of the generated fragmentation cores are generated, otherwise a unique set
      of multi-fragment cores is returned representing all combinations
      of bond fragmentations between the min and max cut limits.

      Shown below are versions for two type of examples - one that uses an
      :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` instance so the database index options
      are used to control the fragmentation behavior and the other uses the free function
      and custom options.

      .. oe:source:: MoleculeToCoreExample.cpp
         :language: c++
         :frag:     SNIPPET-MOLECULETOCORE-DB-EXAMPLE

      .. oe:source:: MoleculeToCoreExample.py
         :language: python
         :frag:     SNIPPET-MOLECULETOCORE-DB-EXAMPLE

      .. oe:source:: MoleculeToCoreExample.java
         :language: java
         :frag:     SNIPPET-MOLECULETOCORE-DB-EXAMPLE

      .. oe:source:: MoleculeToCoreExample.cs
         :language: csharp
         :frag:     SNIPPET-MOLECULETOCORE-DB-EXAMPLE

      .. oe:source:: MoleculeToCoreExample.cpp
         :language: c++
         :frag:     SNIPPET-MOLECULETOCORE-OPTS-EXAMPLE

      .. oe:source:: MoleculeToCoreExample.py
         :language: python
         :frag:     SNIPPET-MOLECULETOCORE-OPTS-EXAMPLE

      .. oe:source:: MoleculeToCoreExample.java
         :language: java
         :frag:     SNIPPET-MOLECULETOCORE-OPTS-EXAMPLE

      .. oe:source:: MoleculeToCoreExample.cs
         :language: csharp
         :frag:     SNIPPET-MOLECULETOCORE-OPTS-EXAMPLE

   .. seealso::

      * :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>` class
      * :oe:func:`OEMedChem::OEMoleculeToCores` function

   .. oe:method:: NumFragments

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumFragments() const

      .. oe:language:: python

         .. oe:api:: python

            NumFragments() -> int

      Returns the total number of fragment cores present in the index.

   .. oe:method:: NumMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumMols() const

      .. oe:language:: python

         .. oe:api:: python

            NumMols() -> int

      Returns the total number of indexed molecules present in the index.

   .. oe:method:: ProcessMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            int ProcessMol(OEChem::OEMolBase& inmol)

      .. oe:language:: python

         .. oe:api:: python

            ProcessMol(inmol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Since the fragmentation engine used internally to generate the index *modifies*
      the input structures (eg discarding all but the largest fragment of the input), this
      method is provided to force the application of the indexing modifications on the input structure.
      This is generally useful for depiction or reporting of the returned similarity results.


.. role:: raw-html(raw)
   :format: html

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMCSFragDatabaseOptions, MCSFragDatabaseOptions

.. _OEMedChem_OEMCSFragDatabaseOptions:

.. oe:class:: OEMCSFragDatabaseOptions

   .. oe:api::

      class OEMCSFragDatabaseOptions

   Encapsulates the properties that control MCS fragmentation indexing.

   .. seealso::

      * :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` class

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSFragDatabaseOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEMCSFragDatabaseOptions() -> OEMCSFragDatabaseOptions

      Default constructor that initializes an :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>`
      object with the following properties:

      .. list-table::  **Default parameters of OEMCSFragDatabaseOptions**
         :widths: 50 50
         :header-rows: 1

         * - Property
           - Default value

         * - options
           - :oe:const:`OEMedChem::OEMatchedPairOptions::DefaultFragIndex`

         * - maximum allowed fragmentation bonds for indexed molecules
           - 20

         * - maximum allowed heavy atoms for indexed molecules
           - 100

         * - indexable fragment filter based on :raw-html:`<br />`
             min,max heavy atom percentage of the :raw-html:`<br />`
             input structure
           - 85-100%

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSFragDatabaseOptions(const OEMCSFragDatabaseOptions& options)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSFragDatabaseOptions(arg2: OEMCSFragDatabaseOptions) -> OEMCSFragDatabaseOptions

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMCSFragDatabaseOptions &operator=(const OEMCSFragDatabaseOptions &rhs)

      Assignment operator.

   .. ################################################################
      # operator==
      ################################################################

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEMCSFragDatabaseOptions &rhs)

      Equality operator.

   .. ################################################################
      # ClearIndexableFragmentRange
      ################################################################

   .. oe:method:: ClearIndexableFragmentRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearIndexableFragmentRange()

      .. oe:language:: python

         .. oe:api:: python

            ClearIndexableFragmentRange() -> None

      Clears the min-max range, which removes the fragment range filter
      and results in indexing fragments of all sizes.

   .. ################################################################
      # GetFragmentationLimit
      ################################################################

   .. oe:method:: GetFragmentationLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFragmentationLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragmentationLimit() -> int

      Return the bond fragmentation limit value.

   .. ################################################################
      # GetIndexableFragmentRangeMax
      ################################################################

   .. oe:method:: GetIndexableFragmentRangeMax

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetIndexableFragmentRangeMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetIndexableFragmentRangeMax() -> float

      Return the maximum range of the indexable fragment filter.

   .. ################################################################
      # GetIndexableFragmentRangeMin
      ################################################################

   .. oe:method:: GetIndexableFragmentRangeMin

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetIndexableFragmentRangeMin() const

      .. oe:language:: python

         .. oe:api:: python

            GetIndexableFragmentRangeMin() -> float

      Return the minimum range of the indexable fragment filter.

   .. ################################################################
      # GetMaxAtomFilter
      ################################################################

   .. oe:method:: GetMaxAtomFilter

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxAtomFilter() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxAtomFilter() -> int

      Return the maximum heavy atom filter value.  Input structures
      with more than this number of heavy atoms will be rejected.

   .. ################################################################
      # GetMaxFragLimit
      ################################################################

   .. oe:method:: GetMaxFragLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxFragLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxFragLimit() -> int

      Return the maximum number of fragmentation bonds that are
      allowed to be cut. Structures with more than this limit
      are not fragmented.

   .. ################################################################
      # GetMinFragLimit
      ################################################################

   .. oe:method:: GetMinFragLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMinFragLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinFragLimit() -> int

      Return the minimum number of fragmentation bonds that are
      allowed to be cut. Structures with less than this limit
      are not fragmented.

   .. ################################################################
      # GetOptions
      ################################################################

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> int

      Return the options setting value.  The default is
      :oe:const:`OEMedChem::OEMatchedPairOptions::DefaultFragIndex`.

   .. ################################################################
      # GetRingFragLimit
      ################################################################

   .. oe:method:: GetRingFragLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRingFragLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetRingFragLimit() -> int

      Return the maximum number of ring fragmentation bonds that are
      allowed to be cut. Structures with more possible ring bonds
      than this limit will not have ring bonds fragmented.

   .. ################################################################
      # HasIndexableFragmentHeavyAtomRange
      ################################################################

   .. oe:method:: HasIndexableFragmentHeavyAtomRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasIndexableFragmentHeavyAtomRange() const

      .. oe:language:: python

         .. oe:api:: python

            HasIndexableFragmentHeavyAtomRange() -> bool

      Returns whether a min-max range has been specified.

   .. ################################################################
      # SetFragLimits
      ################################################################

   .. oe:method:: SetFragLimits

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFragLimits(unsigned int minval, unsigned int maxval)

      .. oe:language:: python

         .. oe:api:: python

            SetFragLimits(minval: int, maxval: int) -> bool

      Sets the min and max range of fragmentation bond cuts.

      .. warning::

         Very high limits for the allowed number of fragmentation bonds
         will have severe performance implications for indexing due to
         the combinatorial explosion in the number of fragmentation
         cores generated.

   .. ################################################################
      # SetFragmentationLimit
      ################################################################

   .. oe:method:: SetFragmentationLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFragmentationLimit(unsigned int limit)

      .. oe:language:: python

         .. oe:api:: python

            SetFragmentationLimit(limit: int) -> bool

      Set the bond fragmentation limit. Any structures that generate
      more fragmentation bonds than this limit are rejected.

   .. ################################################################
      # SetIndexableFragmentRange
      ################################################################

   .. oe:method:: SetIndexableFragmentRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIndexableFragmentRange(float minHeavyAtomPercent,
                                           float maxHeavyAtomPercent)

      .. oe:language:: python

         .. oe:api:: python

            SetIndexableFragmentRange(minHeavyAtomPercent: float,
                                      maxHeavyAtomPercent: float) -> bool

      Sets the min-max heavy atom percentage range to request which
      fragment sizes should be indexed.  The default is 85-100% of the
      input structures.

   .. ################################################################
      # SetMaxAtomFilter
      ################################################################

   .. oe:method:: SetMaxAtomFilter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxAtomFilter(unsigned int numAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxAtomFilter(numAtoms: int) -> bool

      Sets the maximum heavy atom filter value.  Input structures with
      more than this number of heavy atoms will be rejected for
      indexing.

   .. ################################################################
      # SetOptions
      ################################################################

   .. oe:method:: SetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptions(unsigned int opts)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(opts: int) -> bool

      Set the options value.  The default is
      :oe:const:`OEMedChem::OEMatchedPairOptions::DefaultFragIndex`.

   .. ################################################################
      # SetRingFragLimit
      ################################################################

   .. oe:method:: SetRingFragLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRingFragLimit(unsigned int maxringcuts)

      .. oe:language:: python

         .. oe:api:: python

            SetRingFragLimit(val: int) -> bool

      Sets maximum number of ring cuts allowed.
      Structures with more possible ring bonds
      than this limit will not have ring bonds fragmented.

      .. warning::

         Very high limits for the allowed number of ring fragmentation bonds
         will have severe performance implications for indexing due to
         the combinatorial explosion in the number of fragmentation
         cores generated.


.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMCSMolSimScore, MCSMolSimScore

.. _OEMedChem_OEMCSMolSimScore:

.. oe:class:: OEMCSMolSimScore

   .. oe:api::

      class OEMCSMolSimScore

   This class represents :ref:`OEMCSMolSimScore <OEMedChem_OEMCSMolSimScore>` that holds a
   similarity value, an index and a fragment core that identifies the molecule in
   the :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` index from which the score
   is calculated.

   .. seealso::

      * :oe:meth:`OEMedChem::OEMCSFragDatabase::GetScores`
      * :oe:meth:`OEMedChem::OEMCSFragDatabase::GetSortedScores`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSMolSimScore()
            OEMCSMolSimScore(const OEMCSMolSimScore& ref)
            OEMCSMolSimScore(unsigned int i, double s,
                             const std::string& coresmi)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSMolSimScore() -> OEMCSMolSimScore
            OEMCSMolSimScore(i: int, s: float, sc: str) -> OEMCSMolSimScore
            OEMCSMolSimScore(ref: OEMCSMolSimScore) -> OEMCSMolSimScore

      Initializes an :ref:`OEMCSMolSimScore <OEMedChem_OEMCSMolSimScore>` from an index ``i``
      and a score ``s`` and a core ``coresmi``, or from another
      :ref:`OEMCSMolSimScore <OEMedChem_OEMCSMolSimScore>` instance, or with default (null)
      values.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMCSMolSimScore &operator=(const OEMCSMolSimScore &ref)

      Assignment operator.

   .. oe:method:: GetIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdx() -> int

      Returns the index of the indexed molecule corresponding to the
      similarity score.

   .. oe:method:: GetMCSCore

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetMCSCore() const

      .. oe:language:: python

         .. oe:api:: python

            GetMCSCore() -> str

      Returns the SMILES core relating the query and the indexed molecule
      corresponding to the similarity score.

   .. oe:method:: GetScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetScore() -> float

      Returns the score that relates the query and the indexed molecule.

   .. oe:method:: Set

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Set(unsigned int i, double s, const std::string& coresmi)

      .. oe:language:: python

         .. oe:api:: python

            Set(i: int, s: float, core: str) -> None

      Initializes an :ref:`OEMCSMolSimScore <OEMedChem_OEMCSMolSimScore>` from an index ``i``
      and a score ``s`` and a core ``coresmi``.


.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMCSSimFuncBase, MCSSimFuncBase

.. _OEMedChem_OEMCSSimFuncBase:

.. oe:class:: OEMCSSimFuncBase

   .. oe:api::

      class OEMCSSimFuncBase

   :ref:`OEMCSSimFuncBase <OEMedChem_OEMCSSimFuncBase>` is an abstract base class which
   defines the interface necessary to perform similarity calculations
   that populate :ref:`OEMCSMolSimScore <OEMedChem_OEMCSMolSimScore>` objects.

   The following classes derive from this class:
    * :ref:`OEMCSTanimotoSim <OEMedChem_OEMCSTanimotoSim>`
    * :ref:`OEMCSTverskySim <OEMedChem_OEMCSTverskySim>`

   .. seealso::

      * :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` class
      * :oe:meth:`OEMedChem::OEMCSFragDatabase::GetScores` class
      * :oe:meth:`OEMedChem::OEMCSFragDatabase::GetSortedScores` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSSimFuncBase()

      .. oe:language:: python

         .. oe:api:: python

            OEMCSSimFuncBase() -> OEMCSSimFuncBase

   Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator() (unsigned int commonAB, unsigned int totalA, unsigned int totalB) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(commonAB: int, totalA: int, totalB: int) -> float

   Virtual *const* operator that takes three count values and computes
   the similarity value.  Depending on the method, the counts
   provided may be either the atom or bond counts for the MCS core,
   query molecule and indexed molecule.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSSimFuncBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMCSSimFuncBase

   :oe:meth:`OEMedChem::OEMCSSimFuncBase::CreateCopy` is a virtual
   constructor which allows copying of concrete derived objects using
   a reference to this base class.

   .. oe:method:: GetMCSSimTypeString

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetMCSSimTypeString() const

      .. oe:language:: python

         .. oe:api:: python

            GetMCSSimTypeString() -> str

   Returns a string representation of the concrete derived class.


.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMCSTanimotoSim, MCSTanimotoSim

.. _OEMedChem_OEMCSTanimotoSim:

.. oe:class:: OEMCSTanimotoSim

   .. oe:api::

      class OEMCSTanimotoSim : public OEMedChem::OEMCSSimFuncBase

   This class represents :ref:`OEMCSTanimotoSim <OEMedChem_OEMCSTanimotoSim>` that
   calculates the :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>`
   similarity score.

   **Formula:**

     :math:`Sim_{Tanimoto}(A,B) = \frac{bothAB}{|A| + |B| - bothAB} = \frac{bothAB}{onlyA + onlyB + bothAB}`

   The following methods are publicly inherited from :ref:`OEMCSSimFuncBase <OEMedChem_OEMCSSimFuncBase>`:

   ================================================================================ ================================================================================ ================================================================================
   :oe:meth:`operator()<OEMedChem::OEMCSSimFuncBase::operator()>`                   :oe:meth:`CreateCopy<OEMedChem::OEMCSSimFuncBase::CreateCopy>`                   :oe:meth:`GetMCSSimTypeString<OEMedChem::OEMCSSimFuncBase::GetMCSSimTypeString>`
   ================================================================================ ================================================================================ ================================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSTanimotoSim()

      .. oe:language:: python

         .. oe:api:: python

            OEMCSTanimotoSim() -> OEMCSTanimotoSim

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator() (unsigned int commonAB, unsigned int totalA,  unsigned totalB) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(commonAB: int, totalA: int, totalB: int) -> float

      Returns the :oe:const:`Tanimoto<OEGraphSim::OESimMeasure::Tanimoto>`
      similarity coefficient based on the fragment core counts for the
      fragment core, query molecule and indexed molecule.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMedChem::OEMCSSimFuncBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMCSTanimotoSim

      Deep copy constructor that returns a copy of the object. The memory
      for the returned :ref:`OEMCSTanimotoSim <OEMedChem_OEMCSTanimotoSim>` object is
      dynamically allocated and owned by the caller.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetMCSSimTypeString

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetMCSSimTypeString() const

      .. oe:language:: python

         .. oe:api:: python

            GetMCSSimTypeString() -> str

      Returns a string representation of the
      :ref:`OEMCSTanimotoSim <OEMedChem_OEMCSTanimotoSim>` class.



.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMCSTverskySim, MCSTverskySim

.. _OEMedChem_OEMCSTverskySim:

.. oe:class:: OEMCSTverskySim

   .. oe:api::

      class OEMCSTverskySim : public OEMedChem::OEMCSSimFuncBase

   This class represents :ref:`OEMCSTverskySim <OEMedChem_OEMCSTverskySim>` that
   calculates the :oe:const:`Tversky<OEGraphSim::OESimMeasure::Tversky>`
   similarity score.

   **Formula:**

     :math:`Sim_{Tversky}(A,B) = \frac{bothAB}{\alpha * onlyA + \beta * onlyB + bothAB}`

   The following methods are publicly inherited from :ref:`OEMCSSimFuncBase <OEMedChem_OEMCSSimFuncBase>`:

   ================================================================================ ================================================================================ ================================================================================
   :oe:meth:`operator()<OEMedChem::OEMCSSimFuncBase::operator()>`                   :oe:meth:`CreateCopy<OEMedChem::OEMCSSimFuncBase::CreateCopy>`                   :oe:meth:`GetMCSSimTypeString<OEMedChem::OEMCSSimFuncBase::GetMCSSimTypeString>`
   ================================================================================ ================================================================================ ================================================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSTverskySim()
            OEMCSTverskySim(const OEMCSTverskySim& ref)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSTverskySim(ref: OEMCSTverskySim) -> OEMCSTverskySim

      Default constructor (:math:`\alpha = 0.95`, :math:`\beta = 0.05`)

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMCSTverskySim(double tvAlpha = 0.95, double tvBeta = 0.05)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSTverskySim(tvAlpha: float = 0.95, tvBeta: float = 0.05) -> OEMCSTverskySim

      Constructor with arbitrary :math:`\alpha` and :math:`\beta` parameters.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator() (unsigned int commonAB, unsigned int totalA,  unsigned totalB) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(commonAB: int, totalA: int, totalB: int) -> float

      Returns the :oe:const:`Tversky<OEGraphSim::OESimMeasure::Tversky>`
      similarity coefficient based on the fragment core counts for the
      fragment core, query molecule and indexed molecule.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMedChem::OEMCSSimFuncBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMCSTverskySim

      Deep copy constructor that returns a copy of the object. The memory
      for the returned :ref:`OEMCSTverskySim <OEMedChem_OEMCSTverskySim>` object is
      dynamically allocated and owned by the caller.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetAlpha

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetAlpha() const

      .. oe:language:: python

         .. oe:api:: python

            GetAlpha() -> float

      Returns the :math:`\alpha` parameter from the
      :ref:`OEMCSTverskySim <OEMedChem_OEMCSTverskySim>` class.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetBeta

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBeta() const

      .. oe:language:: python

         .. oe:api:: python

            GetBeta() -> float

      Returns the :math:`\beta` parameter from the
      :ref:`OEMCSTverskySim <OEMedChem_OEMCSTverskySim>` class.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetMCSSimTypeString

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetMCSSimTypeString() const

      .. oe:language:: python

         .. oe:api:: python

            GetMCSSimTypeString() -> str

      Returns a string representation of the
      :ref:`OEMCSTverskySim <OEMedChem_OEMCSTverskySim>` class.



.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPair, MatchedPair

.. _OEMedChem_OEMatchedPair:

.. oe:class:: OEMatchedPair

   .. oe:api::

      class OEMatchedPair

   This class identifies a specific matched molecular pair.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatchedPair(const OEMatchedPair& rhs)
            OEMatchedPair(unsigned int fromIndex = 0u,
                          unsigned int toIndex = 0u,
                          const char* fromSmiles = 0, const char* toSmiles = 0)

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPair(rhs: OEMatchedPair) -> OEMatchedPair
            OEMatchedPair(fromIndex: int = 0, toIndex: int = 0,
                          fromSmiles: str = None, toSmiles: str = None) -> OEMatchedPair

      Constructs an object from the passed arguments.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMatchedPair &operator=(const OEMatchedPair &rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OEMatchedPair <OEMedChem_OEMatchedPair>` object.

      Assignment operator.

   .. oe:method:: AddSDData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddSDData(const std::string& tag,
                           const std::string& fromValue,
                           const std::string& toValue)

      .. oe:language:: python

         .. oe:api:: python

            AddSDData(tag: str, fromValue: str, toValue: str) -> bool

      Add SD data information to the matched pair.  The tag is the field name of the SD data
      and the from and to arguments indicate the respective data for the molecular pair.

   .. oe:method:: ClearSDData

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearSDData()

      .. oe:language:: python

         .. oe:api:: python

            ClearSDData() -> None

      Deletes all SD data recorded for the molecular pair.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatchedPair* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMatchedPair

   .. oe:method:: FromIndex

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int FromIndex() const

      .. oe:language:: python

         .. oe:api:: python

            FromIndex() -> int

      This is the from index of the matched molecular pair.

   .. oe:method:: FromSmiles

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& FromSmiles() const

      .. oe:language:: python

         .. oe:api:: python

            FromSmiles() -> str

      This is the from SMILES string of the matched molecular pair.

   .. oe:method:: GetDataTags

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<const std::string>* GetDataTags() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataTags() -> Iterable[str]

      This method returns an iterator of over the SD data field tags recorded for the matched molecular pair.

   .. oe:method:: GetFromSDData

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetFromSDData(const std::string& tag) const

      .. oe:language:: python

         .. oe:api:: python

            GetFromSDData(tag: str) -> str

      This method returns SD data with the specified 'tag' for the from structure of the matched molecular pair.

   .. oe:method:: GetSDData
      :language: c++ java csharp

      .. oe:api::

         bool GetSDData(const std::string &tag, std::string &fromValue,
                        std::string &toValue) const

      This method returns SD data for the specific data field requested for the matched molecular pair.
      If either of the from or to structures have no data present, an empty string is returned.

   .. oe:method:: GetToSDData

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetToSDData(const std::string& tag) const

      .. oe:language:: python

         .. oe:api:: python

            GetToSDData(tag: str) -> str

      This method returns SD data with the specified 'tag' for the to structure of the matched molecular pair.

   .. oe:method:: HasSDData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasSDData(const std::string& tag) const

      .. oe:language:: python

         .. oe:api:: python

            HasSDData(tag: str) -> bool

      This method returns a boolean indicating whether SD data of field name 'tag' is present for either of the from or to structures.

   .. oe:method:: NumDataTags

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumDataTags() const

      .. oe:language:: python

         .. oe:api:: python

            NumDataTags() -> int

      This method returns the number of SD data tags present for the molecular pair.

   .. oe:method:: ToIndex

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int ToIndex() const

      .. oe:language:: python

         .. oe:api:: python

            ToIndex() -> int

      This is the to index of the matched molecular pair.

   .. oe:method:: ToSmiles

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& ToSmiles() const

      .. oe:language:: python

         .. oe:api:: python

            ToSmiles() -> str

      This is the to SMILES string of the matched molecular pair.


.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairAnalyzer, MatchedPairAnalyzer

.. _OEMedChem_OEMatchedPairAnalyzer:

.. oe:class:: OEMatchedPairAnalyzer

   .. oe:api::

      class OEMatchedPairAnalyzer

   Performs a matched pair indexing analysis on an input set of structures.

   .. seealso::

      * :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatchedPairAnalyzer(const OEMatchedPairAnalyzerOptions& opts = OEMatchedPairAnalyzerOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPairAnalyzer(opts: OEMatchedPairAnalyzerOptions = OEMatchedPairAnalyzerOptions()) -> OEMatchedPairAnalyzer

      Default constructor that initializes the analysis engine with the default options defined by
      :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatchedPairAnalyzer(const OEMatchedPairAnalyzerOptions& opts = OEMatchedPairAnalyzerOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPairAnalyzer(opts: OEMatchedPairAnalyzerOptions = OEMatchedPairAnalyzerOptions()) -> OEMatchedPairAnalyzer

      Constructor that initializes the analysis engine with the options defined by
      the :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` argument.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMatchedPairAnalyzer & operator=(const OEMatchedPairAnalyzer & rhs)

      Assignment operator.

   .. oe:method:: AddMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            int AddMol(const OEChem::OEMolBase& inmol, int recordID = (-1))

      .. oe:language:: python

         .. oe:api:: python

            AddMol(inmol: Union[OEGraphMol,OEMol,OEQMol], recID: int = -1) -> int

      Add the molecule to the index and return the 0-based recordID
      if the structure was successfully added, or a negative index if the structure
      was unable to be indexed. Negative values can be used to retrieve
      status information detail for indexing failures. The optional user-defined
      recordID is provided to allow indexed matched pairs to be referenced
      to externally maintained data structures.  If the provided recordID is
      less than zero, an autogenerated index is returned which is
      an index greater than all ids seen so far.

   .. seealso::

      * :oe:constns:`OEMedChem::OEMatchedPairIndexStatus`
      * :oe:func:`OEMedChem::OEMatchedPairIndexStatusName`

   .. oe:method:: GetMaxMolIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxMolIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMolIdx() -> int

      Returns one more than the maximum molecule index this Matched Pair index
      currently contains.

   .. oe:method:: GetMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMolecule(OEChem::OEMolBase& mol, unsigned int molID,
                             bool includeData = true) const

      .. oe:language:: python

         .. oe:api:: python

            GetMolecule(mol: Union[OEGraphMol,OEMol,OEQMol], recID: int,
                        includeData: bool = True) -> bool

      Returns the molecule referenced by ``molID`` in the index.  An optional `includeData` argument controls whether
      generic data present on the molecule at index time is also returned.

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMatchedPairAnalyzerOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEMatchedPairAnalyzerOptions

   .. seealso::

      * :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` class

   .. oe:method:: GetProcessorID

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetProcessorID() const

      .. oe:language:: python

         .. oe:api:: python

            GetProcessorID() -> str

      Returns a character string name of the processor type.

   .. seealso::

      * :oe:func:`OEMedChem::OEMatchedPairProcessorName` class

   .. oe:method:: GetProcessorType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetProcessorType() const

      .. oe:language:: python

         .. oe:api:: python

            GetProcessorType() -> int

      Returns a constant representing the processor type in use.

   .. seealso::

      * :oe:constns:`OEMedChem::OEMatchedPairProcessor`

   .. oe:method:: IsIndexed

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsIndexed(unsigned int recordID) const

      .. oe:language:: python

         .. oe:api:: python

            IsIndexed(recID: int) -> bool

      Returns whether the specified record id has been indexed.

   .. oe:method:: NumIndexNodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumIndexNodes() const

      .. oe:language:: python

         .. oe:api:: python

            NumIndexNodes() -> int

      Return a count of the number of index nodes
      currently present in the index.

   .. oe:method:: NumMatchedPairs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumMatchedPairs() const

      .. oe:language:: python

         .. oe:api:: python

            NumMatchedPairs() -> int

      Return a count of the number of matched molecular pairs
      currently present in the index.

   .. oe:method:: NumMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumMols() const

      .. oe:language:: python

         .. oe:api:: python

            NumMols() -> int

      Return a count of the number of molecules that have currently
      been added to the index.

   .. oe:method:: ModifyOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ModifyOptions(unsigned int addopts, unsigned int delopts)

      .. oe:language:: python

         .. oe:api:: python

            ModifyOptions(addopts: int, delopts: int) -> bool

      An active analyzer has a limited set of options that can be
      altered once it has been instantiated as many of the options
      affect the internal indexing contents.  This method can be used
      to alter any options that do not affect the internal index state.

   .. seealso::

      * :oe:constns:`OEMedChem::OEMatchedPairOptions`


.. role:: raw-html(raw)
   :format: html

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairAnalyzerOptions, MatchedPairAnalyzerOptions

.. _OEMedChem_OEMatchedPairAnalyzerOptions:

.. oe:class:: OEMatchedPairAnalyzerOptions

   .. oe:api::

      class OEMatchedPairAnalyzerOptions

   Encapsulates the properties that control a matched pair analysis.

   .. seealso::

      * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` class

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatchedPairAnalyzerOptions(unsigned int processorType = OEMatchedPairProcessor::Default)
            OEMatchedPairAnalyzerOptions(const OEMatchedPairAnalyzerOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPairAnalyzerOptions(processorType: int) -> OEMatchedPairAnalyzerOptions

      Default constructor that initializes an :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>`
      object with the following properties:

      .. list-table::  **Default parameters of OEMatchedPairAnalyzerOptions**
         :widths: 50 50
         :header-rows: 1

         * - Property
           - Default value

         * - processor type
           - :oe:const:`OEMedChem::OEMatchedPairProcessor::Default`

         * - options
           - :oe:const:`OEMedChem::OEMatchedPairOptions::Default`

         * - bond fragmentation limit
           - 20

         * - heavy atom filter
           - 100

         * - indexable fragment filter based on :raw-html:`<br />`
             min,max heavy atom percentage of the :raw-html:`<br />`
             input structure
           - 85-100%

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatchedPairAnalyzerOptions(const OEMatchedPairAnalyzerOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPairAnalyzerOptions(rhs: OEMatchedPairAnalyzerOptions) -> OEMatchedPairAnalyzerOptions

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMatchedPairAnalyzerOptions &operator=(const OEMatchedPairAnalyzerOptions &rhs)

      Assignment operator.

   .. ################################################################
      # ClearIndexableFragmentRange
      ################################################################

   .. oe:method:: ClearIndexableFragmentRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearIndexableFragmentRange()

      .. oe:language:: python

         .. oe:api:: python

            ClearIndexableFragmentRange() -> None

      Clears the min-max range, which removes the fragment range filter
      and results in indexing fragments of all sizes.

   .. ################################################################
      # GetFragmentationLimit
      ################################################################

   .. oe:method:: GetFragmentationLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFragmentationLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragmentationLimit() -> int

      Return the bond fragmentation limit value.

   .. ################################################################
      # GetIndexableFragmentRangeMax
      ################################################################

   .. oe:method:: GetIndexableFragmentRangeMax

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetIndexableFragmentRangeMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetIndexableFragmentRangeMax() -> float

      Return the maximum range of the indexable fragment filter.

   .. ################################################################
      # GetIndexableFragmentRangeMin
      ################################################################

   .. oe:method:: GetIndexableFragmentRangeMin

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetIndexableFragmentRangeMin() const

      .. oe:language:: python

         .. oe:api:: python

            GetIndexableFragmentRangeMin() -> float

      Return the minimum range of the indexable fragment filter.

   .. ################################################################
      # GetMaxAtomFilter
      ################################################################

   .. oe:method:: GetMaxAtomFilter

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxAtomFilter() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxAtomFilter() -> int

      Return the maximum heavy atom filter value.  Input structures
      with more than this number of heavy atoms will be rejected.

   .. ################################################################
      # GetOptions
      ################################################################

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> int

      Return the options setting value.  The default is
      :oe:const:`OEMedChem::OEMatchedPairOptions::Default`.

   .. ################################################################
      # GetProcessorType
      ################################################################

   .. oe:method:: GetProcessorType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetProcessorType() const

      .. oe:language:: python

         .. oe:api:: python

            GetProcessorType() -> int

      Return the processor type.  The type using the
      default constructor is
      :oe:const:`OEMedChem::OEMatchedPairProcessor::Default`

   .. ################################################################
      # HasIndexableFragmentHeavyAtomRange
      ################################################################

   .. oe:method:: HasIndexableFragmentHeavyAtomRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasIndexableFragmentHeavyAtomRange() const

      .. oe:language:: python

         .. oe:api:: python

            HasIndexableFragmentHeavyAtomRange() -> bool

      Returns whether a min-max range has been specified.

   .. ################################################################
      # ModifyOptions
      ################################################################

   .. oe:method:: ModifyOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ModifyOptions(unsigned int addopts, unsigned int delopts)

      .. oe:language:: python

         .. oe:api:: python

            ModifyOptions(addopts: int, delopts: int) -> bool

      An active analyzer has a limited set of options that can be
      altered once it has been instantiated as many of the options
      affect the internal indexing contents.  This method can be used
      to alter any options that do not affect the internal index state.

   .. ################################################################
      # SetFragmentationLimit
      ################################################################

   .. oe:method:: SetFragmentationLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFragmentationLimit(unsigned int limit)

      .. oe:language:: python

         .. oe:api:: python

            SetFragmentationLimit(limit: int) -> bool

      Set the bond fragmentation limit. Any structures that generate
      more fragmentation bonds than this limit are rejected.

   .. ################################################################
      # SetIndexableFragmentRange
      ################################################################

   .. oe:method:: SetIndexableFragmentRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIndexableFragmentRange(float minHeavyAtomPercent,
                                           float maxHeavyAtomPercent)

      .. oe:language:: python

         .. oe:api:: python

            SetIndexableFragmentRange(minHeavyAtomPercent: float,
                                      maxHeavyAtomPercent: float) -> bool

      Sets the min-max heavy atom percentage range to request which
      fragment sizes should be indexed.  The default is 85-100% of the
      input structures.

   .. ################################################################
      # SetMaxAtomFilter
      ################################################################

   .. oe:method:: SetMaxAtomFilter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxAtomFilter(unsigned int numAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxAtomFilter(numAtoms: int) -> bool

      Sets the maximum heavy atom filter value.  Input structures with
      more than this number of heavy atoms will be rejected for
      indexing.

   .. ################################################################
      # SetOptions
      ################################################################

   .. oe:method:: SetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptions(unsigned int opts)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(opts: int) -> bool

      Set the options value.  The default is
      :oe:const:`OEMedChem::OEMatchedPairOptions::Default`.

   .. ################################################################
      # SetProcessorType
      ################################################################

   .. oe:method:: SetProcessorType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetProcessorType(unsigned int processorType = OEMatchedPairProcessor::Default)

      .. oe:language:: python

         .. oe:api:: python

            SetProcessorType(processorType: int) -> bool

      Sets the index processor type to the requested value.

      .. seealso::

         * :oe:constns:`OEMedChem::OEMatchedPairProcessor` constants


.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairTransform, MatchedPairTransform

.. _OEMedChem_OEMatchedPairTransform:

.. oe:class:: OEMatchedPairTransform

   .. oe:api::

      class OEMatchedPairTransform

   This class embodies a unique transformation that relates one or more matched molecular pairs.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatchedPairTransform()
            OEMatchedPairTransform(const OEMatchedPairTransform& rhs)
            OEMatchedPairTransform(const std::string& xformString,
                                   int context = OEMatchedPairContext::Default)
            OEMatchedPairTransform(const std::string& ForwardXForm,
                                   const std::string& ReverseXForm,
                                   int context = OEMatchedPairContext::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPairTransform() -> OEMatchedPairTransform
            OEMatchedPairTransform(xformstr: str, context: int) -> OEMatchedPairTransform
            OEMatchedPairTransform(ForwardXForm: str, ReverseXForm: str,
                                   context: int) -> OEMatchedPairTransform
            OEMatchedPairTransform(rhs: OEMatchedPairTransform) -> OEMatchedPairTransform

      Constructs an object from the passed arguments.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMatchedPairTransform &operator=(const OEMatchedPairTransform &rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OEMatchedPairTransform <OEMedChem_OEMatchedPairTransform>` object.

      Assignment operator.

   .. oe:method:: AddMatchedPair

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddMatchedPair(const OEMatchedPair& mmp)
            bool AddMatchedPair(unsigned int fromIndex,
                                const std::string& fromSmiles,
                                unsigned int toIndex,
                                const std::string& toSmiles)

      .. oe:language:: python

         .. oe:api:: python

            AddMatchedPair(molpair: OEMatchedPair) -> bool
            AddMatchedPair(fromIndex: int, fromSmiles: str, toIndex: int,
                           toSmiles: str) -> bool

      This method links a specific from and to structure to the transform.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatchedPairTransform* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMatchedPairTransform

   .. oe:method:: GetMatchedPairContext

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetMatchedPairContext() const

      .. oe:language:: python

         .. oe:api:: python

            GetMatchedPairContext() -> int

      Returns the chemistry context type for the transformation.

      .. seealso::

         * :oe:constns:`OEMedChem::OEMatchedPairContext`

   .. oe:method:: GetMatchedPairs

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMatchedPair>* GetMatchedPairs() const
            OESystem::OEIterBase<OEMatchedPair>* GetMatchedPairs(unsigned int fromORtoIndex) const
            OESystem::OEIterBase<OEMatchedPair>* GetMatchedPairs(unsigned int fromIndex,
                                                                 unsigned int toIndex) const

      .. oe:language:: python

         .. oe:api:: python

            GetMatchedPairs() -> Iterable[OEMatchedPair]
            GetMatchedPairs(FromOrToIndex: int) -> Iterable[OEMatchedPair]
            GetMatchedPairs(fromIndex: int, toIndex: int) -> Iterable[OEMatchedPair]

      Returns an iterator of the all the matched pairs associated with this transformation, or restricts the returned
      matched pairs that meeting the from or to index constraint.

      .. seealso::

         * :ref:`OEMatchedPair <OEMedChem_OEMatchedPair>`

   .. oe:method:: GetMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMolecule(unsigned int index, std::string& molsmi) const
            std::string GetMolecule(unsigned int index) const

      .. oe:language:: python

         .. oe:api:: python

            GetMolecule(molindex: int) -> str

      This method retrieves the molecule of the specified molecule id from the transform.

   .. oe:method:: GetMoleculeTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMoleculeTitle(unsigned int molindex, std::string& name) const
            std::string GetMoleculeTitle(unsigned int molindex) const

      .. oe:language:: python

         .. oe:api:: python

            GetMoleculeTitle(molindex: int) -> str

      This method returns a molecule title for the passed molecule index.

   .. oe:method:: GetTransform

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetTransform() const

      .. oe:language:: python

         .. oe:api:: python

            GetTransform() -> str

      Returns the reaction transformation string that can be used to instantiate a OEUniMolecularRxn object.

   .. oe:method:: HasMatchedPair

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasMatchedPair(unsigned int FromOrToIndex) const
            bool HasMatchedPair(unsigned int fromIndex, unsigned int toIndex) const

      .. oe:language:: python

         .. oe:api:: python

            HasMatchedPair(FromOrToIndex: int) -> bool
            HasMatchedPair(fromIndex: int, toIndex: int) -> bool

      Returns a boolean to indicate if the specific molecule pair is registered with this transformation.

   .. oe:method:: Invert

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Invert()

      .. oe:language:: python

         .. oe:api:: python

            Invert() -> bool

      Reverses the direction of the transform and the matched pair information for the transformation.

      .. warning::

         If the transform was extracted with SMART query qualifiers for use in molecule transformation activities,
         the inversion of the transform will result in the query features moved to the product side of the reaction.
         Inverting transformations is only meaningful when using the :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::NoSMARTS`
         extraction option.

   .. oe:method:: NumMatchedPairs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumMatchedPairs() const

      .. oe:language:: python

         .. oe:api:: python

            NumMatchedPairs() -> int

      Returns a count of the number of matched molecular pairs registered with this transformation.

   .. oe:method:: SetMoleculeTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMoleculeTitle(unsigned int index, const std::string& name)

      .. oe:language:: python

         .. oe:api:: python

            SetMoleculeTitle(molindex: int, name: str) -> bool

      This method set the molecule title for the passed molecule index.

   .. oe:method:: SetTransform

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTransform(const std::string& xform,
                              int context = OEMatchedPairContext::Default)
            bool SetTransform(const std::string& ForwardXForm,
                              const std::string& ReverseXForm,
                              int context = OEMatchedPairContext::Default)

      .. oe:language:: python

         .. oe:api:: python

            SetTransform(xform: str, context: int) -> bool
            SetTransform(ForwardXForm: str, ReverseXForm: str, context: int) -> bool

      Sets the internal reaction transformation string.



.. role:: raw-html(raw)
   :format: html

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairTransformExtractOptions, MatchedPairTransformExtractOptions

.. _OEMedChem_OEMatchedPairTransformExtractOptions:

.. oe:class:: OEMatchedPairTransformExtractOptions

   .. oe:api::

      class OEMatchedPairTransformExtractOptions

   Encapsulates the properties that control extraction of matched molecular pair transformations.

   .. seealso::

      * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` class
      * :oe:func:`OEMedChem::OEMatchedPairGetTransforms` function

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatchedPairTransformExtractOptions(int context = OEMatchedPairContext::Default,
                                                 unsigned int options = OEMatchedPairTransformExtractMode::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPairTransformExtractOptions(context: int, options: int) -> OEMatchedPairTransformExtractOptions

      Default constructor that initializes an :ref:`OEMatchedPairTransformExtractOptions <OEMedChem_OEMatchedPairTransformExtractOptions>`
      object with the following properties:

      .. list-table::  **Default parameters of OEMatchedPairTransformExtractOptions**
         :widths: 50 50
         :header-rows: 1

         * - Property
           - Default value

         * - transformation context
           - :oe:const:`OEMedChem::OEMatchedPairContext::Default`

         * - extraction options
           - :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Default`

         * - maximum matched pair core structure substituents
           - 200

         * - skip maximum matched pair core index nodes exceeding substituent limit
           - false

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMatchedPairTransformExtractOptions(const OEMatchedPairTransformExtractOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPairTransformExtractOptions(rhs: OEMatchedPairTransformExtractOptions) -> OEMatchedPairTransformExtractOptions

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMatchedPairTransformExtractOptions &operator=(const OEMatchedPairTransformExtractOptions &rhs)

      Assignment operator.

   .. ################################################################
      # GetAttachmentPoints
      ################################################################

   .. oe:method:: GetAttachmentPoints

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAttachmentPoints() const

      .. oe:language:: python

         .. oe:api:: python

            GetAttachmentPoints() -> bool

      Returns the setting that requests the addition of attachment
      points on the matched pair transformation.

   .. ################################################################
      # GetContext
      ################################################################

   .. oe:method:: GetContext

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetContext() const

      .. oe:language:: python

         .. oe:api:: python

            GetContext() -> int

      Returns the setting that controls the amount
      of core chemistry adjacent to the substituent attachment site
      for the matched pairs.

      .. seealso::

         * :oe:const:`OEMedChem::OEMatchedPairContext::Default`

   .. ################################################################
      # GetDirection
      ################################################################

   .. oe:method:: GetDirection

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetDirection() const

      .. oe:language:: python

         .. oe:api:: python

            GetDirection() -> int

      Returns the setting that controls the direction
      for the returned matched pair transformation.
      One of :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Forward`,
      :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Backward`,
      ( :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Forward` |
      :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Backward` )`` (both)
      or :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Sorted`
      are supported.
      For :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Sorted`,
      the transformation is lexically sorted based on
      the reactants and products and may need to be inverted to have
      the transformation represent driving an arbitrary data property
      associated with the matched pair in a desired direction.

      .. seealso::

         * :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Default`
         * :oe:meth:`OEMedChem::OEMatchedPairTransform::Invert`

   .. ################################################################
      # GetIsotopes
      ################################################################

   .. oe:method:: GetIsotopes

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetIsotopes() const

      .. oe:language:: python

         .. oe:api:: python

            GetIsotopes() -> bool

      Returns the setting that controls the generalization of the
      returned transformations for isotopic substitutions.

   .. ################################################################
      # GetMCSCorrespondence
      ################################################################

   .. oe:method:: GetMCSCorrespondence

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMCSCorrespondence() const

      .. oe:language:: python

         .. oe:api:: python

            GetMCSCorrespondence() -> bool

      Returns the setting that requests the addition of atom-atom
      mapping correspondence to the core of the matched pair transformation.

   .. ################################################################
      # GetMatchedPairData
      ################################################################

   .. oe:method:: GetMatchedPairData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMatchedPairData() const

      .. oe:language:: python

         .. oe:api:: python

            GetMatchedPairData() -> bool

      Returns whether the matched pair data is included in the
      matched pair transformation.  If only the transformation
      itself is required, there may not be a need for extraction
      of related matched pair indexed data.

   .. ################################################################
      # GetMatchedPairs
      ################################################################

   .. oe:method:: GetMatchedPairs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMatchedPairs() const

      .. oe:language:: python

         .. oe:api:: python

            GetMatchedPairs() -> bool

      Returns whether the matched pair data ids are returned for the
      matched pair transformation.  If only the transformation
      itself is required, there may not be a need for extraction
      of related matched pair indices.

   .. ################################################################
      # GetMaxMMPLimit
      ################################################################

   .. oe:method:: GetMaxMMPLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxMMPLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMMPLimit() -> int

      Returns the requested upper limit of matched pairs for the extracted
      transformations.

   .. ################################################################
      # GetMaxSubstituentLimit
      ################################################################

   .. oe:method:: GetMaxSubstituentLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxSubstituentLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSubstituentLimit() -> int

      Returns the setting for the maximum number of indexed
      core substituents that should be processed into matched pair
      transformations.

      .. warning::

         Setting this limit to ``0`` will suppress any core structure
         truncation or skipping activities, but may result in
         extremely poor transformation extraction performance owing to the
         combinatorial explosion of generating all ``NxM`` combinations of matched pairs.

   .. ################################################################
      # GetMaxSubstituentLimitSkip
      ################################################################

   .. oe:method:: GetMaxSubstituentLimitSkip

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMaxSubstituentLimitSkip() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSubstituentLimitSkip() -> bool

      Returns whether the matched pair core structures in the
      index that have more than the :oe:meth:`OEMedChem::OEMatchedPairTransformExtractOptions::GetMaxSubstituentLimit`
      number of substituents are processed into matched pair
      transformation entries.  If the setting is ``true``, cores
      that exceed the limit are skipped, and if ``false``, the
      substituent list is truncated to the first :oe:meth:`OEMedChem::OEMatchedPairTransformExtractOptions::GetMaxSubstituentLimit`
      substituents, if non-zero.

   .. ################################################################
      # GetMinMMPLimit
      ################################################################

   .. oe:method:: GetMinMMPLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMinMMPLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinMMPLimit() -> int

      Returns the requested lower limit of matched pairs for the extracted
      transformations.

   .. ################################################################
      # GetMinSubstituentLimit
      ################################################################

   .. oe:method:: GetMinSubstituentLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMinSubstituentLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinSubstituentLimit() -> int

      Returns the setting for the minimum number of
      core structure substituents for index nodes that should be processed
      into matched pair transformations.

   .. ################################################################
      # GetOptions
      ################################################################

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> int

      Returns the bit option settings for the extraction options.

      .. seealso::

         * :oe:constns:`OEMedChem::OEMatchedPairTransformExtractMode`

   .. ################################################################
      # GetSMARTS
      ################################################################

   .. oe:method:: GetSMARTS

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSMARTS() const

      .. oe:language:: python

         .. oe:api:: python

            GetSMARTS() -> bool

      Returns whether the matched pair transformations are annotated
      with additional SMARTS qualifiers to make the transformations more
      chemically relevant when used for generating chemical transformations
      from extracted matched pairs.

   .. ################################################################
      # SetAttachmentPoints
      ################################################################

   .. oe:method:: SetAttachmentPoints

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAttachmentPoints(bool val)

      .. oe:language:: python

         .. oe:api:: python

            SetAttachmentPoints(val: bool) -> bool

      Set the option that controls the addition of attachment points on the
      matched pair transformation.

   .. ################################################################
      # SetContext
      ################################################################

   .. oe:method:: SetContext

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetContext(int context)

      .. oe:language:: python

         .. oe:api:: python

            SetContext(context: int) -> bool

      Sets the option that that controls the amount
      of core chemistry adjacent to the substituent attachment site
      in then matched pair transformation.

      .. seealso::

         * :oe:const:`OEMedChem::OEMatchedPairContext::Default`

   .. ################################################################
      # SetDirection
      ################################################################

   .. oe:method:: SetDirection

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDirection(unsigned int direction)

      .. oe:language:: python

         .. oe:api:: python

            SetDirection(direction: int) -> bool

      Sets the specified transformation direction for the returned matched
      pair transformation.  One of ``Forward``,
      ``Backward``, ``(Forward | Backward)`` (both) or ``Sorted`` are supported.
      For ``Sorted``, the transformation is lexically sorted based on
      the reactants and products and may need to be inverted to have
      the transformation represent driving an arbitrary data property
      associated with the matched pair in a desired direction.

      .. seealso::

         * :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Default`
         * :oe:meth:`OEMedChem::OEMatchedPairTransform::Invert`

   .. ################################################################
      # SetIsotopes
      ################################################################

   .. oe:method:: SetIsotopes

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIsotopes(bool require)

      .. oe:language:: python

         .. oe:api:: python

            SetIsotopes(val: bool) -> bool

      Sets the option that controls whether the transformation
      is allowed to be generalized for isotopic substitutions.  If
      ``true``, isotopic information will be included in the transformations
      for the chemical modifications.

   .. ################################################################
      # SetMCSCorrespondence
      ################################################################

   .. oe:method:: SetMCSCorrespondence

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMCSCorrespondence(bool add)

      .. oe:language:: python

         .. oe:api:: python

            SetMCSCorrespondence(val: bool) -> bool

      Sets the option that requests the addition of atom-atom
      mapping correspondence to the core of the matched pair transformation.

   .. ################################################################
      # SetMatchedPairData
      ################################################################

   .. oe:method:: SetMatchedPairData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMatchedPairData(bool enable)

      .. oe:language:: python

         .. oe:api:: python

            SetMatchedPairData(val: bool) -> bool

      Sets the option that requests matched pair data be
      included in the matched pair transformation.  If only the transformation
      itself is required, there may not be a need for extraction
      of related matched pair indexed data, so the data extraction can be disabled.

   .. ################################################################
      # SetMatchedPairs
      ################################################################

   .. oe:method:: SetMatchedPairs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMatchedPairs(bool enable)

      .. oe:language:: python

         .. oe:api:: python

            SetMatchedPairs(val: bool) -> bool

      Sets the option that requests that matched pair structure ids are returned for the
      matched pair transformation.  If only the transformation
      itself is required, there may not be a need for extraction
      of related matched pair structure indices.

   .. ################################################################
      # SetMaxSubstituentLimitSkip
      ################################################################

   .. oe:method:: SetMaxSubstituentLimitSkip

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxSubstituentLimitSkip(bool skip)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxSubstituentLimitSkip(val: bool) -> bool

      Sets the option that controls whether the matched pair core structures in the
      index that have more than the :oe:meth:`OEMedChem::OEMatchedPairTransformExtractOptions::GetMaxSubstituentLimit`
      number of substituents are processed into matched pair
      transformation entries.  If the setting is ``true``, cores
      that exceed the limit are skipped, and if ``false``, the
      substituent list is truncated to the first :oe:meth:`OEMedChem::OEMatchedPairTransformExtractOptions::GetMaxSubstituentLimit`
      substituents, if non-zero.

   .. ################################################################
      # SetMMPLimit
      ################################################################

   .. oe:method:: SetMMPLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMMPLimit(unsigned int atLeast, unsigned int atMost = 0u)

      .. oe:language:: python

         .. oe:api:: python

            SetMMPLimit(atLeast: int, atMost: int = 0) -> bool

      Sets the requested range limits for the number matched pairs in the extracted
      transformations.

   .. ################################################################
      # SetSubstituentLimit
      ################################################################

   .. oe:method:: SetSubstituentLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSubstituentLimit(unsigned int atLeast,
                                     unsigned int atMost = 0u)

      .. oe:language:: python

         .. oe:api:: python

            SetSubstituentLimit(atLeast: int, atMost: int = 0) -> bool

      Sets the requested range limits for the core structure index nodes to constrain
      processing to core index nodes matching the specified range.

      .. warning::

         Setting the maximum limit to ``0`` will suppress any core structure
         truncation or skipping activities, but may result in
         extremely poor transformation extraction performance owing to the
         combinatorial explosion of generating all ``NxM`` combinations of matched pairs
         and their associated transformations and data.

   .. ################################################################
      # SetOptions
      ################################################################

   .. oe:method:: SetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptions(unsigned int options)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(opts: int) -> bool

      Sets the bit option settings that control the transformation extraction activities.

      .. seealso::

         * :oe:constns:`OEMedChem::OEMatchedPairTransformExtractMode`

   .. ################################################################
      # SetSMARTS
      ################################################################

   .. oe:method:: SetSMARTS

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSMARTS(bool enable)

      .. oe:language:: python

         .. oe:api:: python

            SetSMARTS(val: bool) -> bool

      Sets the option that indicates that matched pair transformations should be annotated
      with additional SMARTS qualifiers to make the transformations more
      chemically relevant when used for generating chemical transformations
      from extracted matched pairs.


.. _chapter_oemedchemclasses:

.. _OEMedChemClasses:

*******************
OEMedChem Classes
*******************

.. oe:namespace:: OEMedChem

.. toctree::

   OEBemisMurckoOptions
   OECreateMMPIndexOptions
   OECreateMMPIndexStatus
   OEMCSFragDatabase
   OEMCSFragDatabaseOptions
   OEMCSMolSimScore
   OEMCSSimFuncBase
   OEMCSTanimotoSim
   OEMCSTverskySim
   OEMatchedPairAnalyzer
   OEMatchedPairAnalyzerOptions
   OEMatchedPair
   OEMatchedPairTransform
   OEMatchedPairTransformExtractOptions


.. oe:namespace:: OEMedChem

.. oe:constnamespace:: OEMCSFragDatabaseSetup

   This namespace encodes symbolic constants used as bit-masks to
   indicate which MCS fragmentation indexing parameters are being
   created when invoking the
   :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function.

   .. seealso::

      * :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>` class

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::AllFrags`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::BondFragLimit`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::FragCutsRange`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::FragMinMaxRange`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::FragmentationCuts`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::HeavyAtomLimit`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::IndexHydrogenSites`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::RingCuts`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AllFrags

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      all fragment indexing.

      ::

         Contents of parameter -allfrags
             Aliases : -all
             Type : bool
             Allow list : false
             Default : false
             Simple : true
             Required : false
             Brief : Index all fragment sizes, ignore fragment heavy atom percentage

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::HasIndexableFragmentHeavyAtomRange` method
         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::ClearIndexableFragmentRange` method
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BondFragLimit

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      maximum number of fragmentation bonds allowed.

      ::

         Contents of parameter -bondfraglimit
             Aliases : -blim
             Type : int
             Allow list : false
             Default : 20
             Simple : true
             Required : false
             Brief : Bond fragmentation limit

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetFragmentationLimit` method
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FragCutsRange

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      the minimum and maximum fragmentation bond cuts allowed.

      ::

         Contents of parameter -minfragcuts
             Aliases : -mincuts
             Type : int
             Allow list : false
             Default : 1
             Simple : true
             Required : false
             Legal ranges :
                 1 to 100
             Brief : Minimum number of fragmentation cuts allowed

         Contents of parameter -maxfragcuts
             Aliases : -maxcuts
             Type : int
             Allow list : false
             Default : 3
             Simple : true
             Required : false
             Legal ranges :
                 1 to 100
             Brief : Maximum number of fragmentation cuts allowed

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetFragLimits` method
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FragMinMaxRange

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      the min and max allowed fragment sizes to be indexed.

      ::

         Contents of parameter -fragGe
             Aliases : -ge
             Type : float
             Allow list : false
             Default : 85.0
             Simple : true
             Required : false
             Legal ranges :
                 0.0 to 100.0
             Brief : fragments greater than or equal to this heavy atom percentage

         Contents of parameter -fragLe
             Aliases : -le
             Type : float
             Allow list : false
             Default : 100.0
             Simple : true
             Required : false
             Legal ranges :
                 0.0 to 100.0
             Brief : fragments less than or equal to this heavy atom percentage

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetIndexableFragmentRange` method
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FragmentationCuts

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      the fragmentation bond cut combinations to be performed.

      ::

         Contents of parameter -fragcuts
             Aliases : -cuts
             Type : string
             Allow list : true
             Default : All
             Simple : true
             Required : false
             Legal values : Single Double Triple All
             Brief : Fragmentation bond combinations
             Detail

      .. seealso::

         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`
         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetOptions` method
         * :oe:const:`OEMedChem::OEMatchedPairOptions::SingleCuts` constant
         * :oe:const:`OEMedChem::OEMatchedPairOptions::DoubleCuts` constant
         * :oe:const:`OEMedChem::OEMatchedPairOptions::TripleCuts` constant
         * :oe:const:`OEMedChem::OEMatchedPairOptions::AllCuts` constant

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: HeavyAtomLimit

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      the limit for the maximum number of heavy atoms allowed for an indexed molecule.

      ::

         Contents of parameter -atomlimit
             Aliases : -alim
             Type : int
             Allow list : false
             Default : 100
             Simple : true
             Required : false
             Brief : Heavy atom limit

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetMaxAtomFilter` method
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: IndexHydrogenSites

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      whether matched pairs that differ simply by hydrogen
      substitution is allowed.

      ::

         Contents of parameter -indexhydsites
             Aliases : -indexh
             Type : bool
             Allow list : false
             Default : true
             Simple : true
             Required : false
             Brief : Index hydrogen sites

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetOptions` method
         * :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` constant
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: RingCuts

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      the maximum number of ring cuts allowed.

      ::

         Contents of parameter -ringcuts
             Aliases : -ring
             Type : int
             Allow list : false
             Default : 0
             Simple : true
             Required : false
             Brief : Maximum number of ring fragmentation cuts allowed (0: disabled)

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetRingFragLimit` method
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`



.. oe:namespace:: OEMedChem

.. oe:constnamespace:: OEMCSScoreType

   This namespace contains constants representing various supported
   similarity computations.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Undefined

      This constant represents an undefined or illegal context state.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AtomCount

      This constant represents a request for atom counts that
      relate the fragment core, query and indexed molecule.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BondCount

      This constant represents a request for bond counts that
      relate the fragment core, query and indexed molecule.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      This constant represents the default score type
      setting of :oe:const:`OEMedChem::OEMCSScoreType::AtomCount`.



.. oe:namespace:: OEMedChem

.. oe:constnamespace:: OEMatchedPairAnalyzerFileType

   This namespace contains constants representing supported
   matched pair analysis serialization export types.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MMPIndex

      This constant identifies the only currently supported serialization type
      for an :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` object.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MCSFrags

      This constant identifies the only currently supported serialization type
      for an :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` object.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: UNDEFINED

      This constant represents any unknown file type for index serialization.


.. oe:namespace:: OEMedChem

.. oe:constnamespace:: OEMatchedPairContext

   This namespace contains constants representing various supported
   context requests for matched pair transformations.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Undefined

      This constant represents an undefined or illegal context state.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AllBonds

      This constant represents a request for the most explicit
      chemistry context for the transformation information.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bond0

      This constant represents a request for 0-bonds of chemistry
      context in the returned transformation information.
      This constant represents a request for the most general
      context for the transformation information.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bond1

      This constant represents a request for 1-bond of chemistry
      context in the returned transformation information.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bond2

      This constant represents a request for 2-bonds of chemistry
      context in the returned transformation information.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Bond3

      This constant represents a request for 3-bonds of chemistry
      context in the returned transformation information.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      This constant represents the default transformation context
      setting of :oe:const:`OEMedChem::OEMatchedPairContext::Bond1`.



.. oe:namespace:: OEMedChem

.. oe:constnamespace:: OEMatchedPairIndexSetup

   This namespace encodes symbolic constants used as bit-masks to
   indicate which matched pair indexing parameters are being
   created when invoking the
   :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions` function.

   .. seealso::

      * :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` class

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEMedChem::OEMatchedPairIndexSetup::BondFragLimit`
      * :oe:const:`OEMedChem::OEMatchedPairIndexSetup::FragMinMaxRange`
      * :oe:const:`OEMedChem::OEMatchedPairIndexSetup::FragmentationCuts`
      * :oe:const:`OEMedChem::OEMatchedPairIndexSetup::HeavyAtomLimit`
      * :oe:const:`OEMedChem::OEMatchedPairIndexSetup::IndexHydrogenSites`
      * :oe:const:`OEMedChem::OEMatchedPairIndexSetup::ProcessorType`
      * :oe:const:`OEMedChem::OEMatchedPairIndexSetup::UniquesOnly`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BondFragLimit

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions` function results
      in generating the following default interface to configure
      maximum number of fragmentation bonds allowed.

      ::

         Contents of parameter -bondfraglimit
             Aliases : -blim
             Type : int
             Allow list : false
             Default : 20
             Simple : true
             Required : false
             Brief : Bond fragmentation limit

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetFragmentationLimit` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FragMinMaxRange

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions` function results
      in generating the following default interface to configure
      the min and max allowed fragment sizes to be indexed.

      ::

         Contents of parameter -fragGe
             Aliases : -ge
             Type : float
             Allow list : false
             Default : 85.0
             Simple : true
             Required : false
             Legal ranges :
                 0.0 to 100.0
             Brief : fragments greater than or equal to this heavy atom percentage

         Contents of parameter -fragLe
             Aliases : -le
             Type : float
             Allow list : false
             Default : 100.0
             Simple : true
             Required : false
             Legal ranges :
                 0.0 to 100.0
             Brief : fragments less than or equal to this heavy atom percentage

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetIndexableFragmentRange` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FragmentationCuts

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions` function results
      in generating the following default interface to configure
      the fragmentation bond cut combinations to be performed.

      ::

         Contents of parameter -fragcuts
             Aliases : -cuts
             Type : string
             Allow list : true
             Default : All
             Simple : true
             Required : false
             Legal values : Single Double Triple All
             Brief : Fragmentation bond combinations
             Detail

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetOptions` method
         * :oe:const:`OEMedChem::OEMatchedPairOptions::SingleCuts` constant
         * :oe:const:`OEMedChem::OEMatchedPairOptions::DoubleCuts` constant
         * :oe:const:`OEMedChem::OEMatchedPairOptions::TripleCuts` constant
         * :oe:const:`OEMedChem::OEMatchedPairOptions::AllCuts` constant

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: HeavyAtomLimit

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions` function results
      in generating the following default interface to configure
      the limit for the maximum number of heavy atoms allowed for an indexed molecule.

      ::

         Contents of parameter -atomlimit
             Aliases : -alim
             Type : int
             Allow list : false
             Default : 100
             Simple : true
             Required : false
             Brief : Heavy atom limit

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetMaxAtomFilter` method

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: IndexHydrogenSingleCuts

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions` function results
      in generating the following default interface to configure
      whether matched pairs that differ simply by hydrogen
      substitution specifically at single cuts sites only.

      ::

         Contents of parameter -indexhyd1cuts
            Aliases : -indexh1cuts
            Type : bool
            Allow list : false
            Default : false
            Simple : true
            Required : false
            Brief : Index hydrogen members for single cuts only

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetOptions` method
         * :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSingleCuts` constant

   .. oe:constant:: IndexHydrogenSites

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions` function results
      in generating the following default interface to configure
      whether matched pairs that differ simply by hydrogen
      substitution is allowed for all fragmentation cut types.

      ::

         Contents of parameter -indexhydsites
             Aliases : -indexh
             Type : bool
             Allow list : false
             Default : true
             Simple : true
             Required : false
             Brief : Index hydrogen sites

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetOptions` method
         * :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` constant

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ProcessorType

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions` function results
      in generating the following default interface to select
      the type of fragmentation processor to be used during indexing.

      ::

         Contents of parameter -processortype
             Aliases : -ptype
             Type : string
             Allow list : false
             Default : Default
             Simple : true
             Required : false
             Legal values : Undefined Default HussainRea BemisMurcko HR BM
             Brief : Processor type
             Detail

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetProcessorType` method
         * :oe:constns:`OEMedChem::OEMatchedPairProcessor` namespace

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: UniquesOnly

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions` function results
      in generating the following default interface to configure
      whether duplicate structures are allowed to be indexed.

      ::

         Contents of parameter -unique
             Aliases : -u
             Type : bool
             Allow list : false
             Default : true
             Simple : true
             Required : false
             Brief : Unique molecules only

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetOptions` method
         * :oe:const:`OEMedChem::OEMatchedPairOptions::UniquesOnly` constant



.. oe:namespace:: OEMedChem

.. oe:constnamespace:: OEMatchedPairIndexStatus

   This namespace contains constants representing status information
   returned from matched pair indexing.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BinaryIOError

      This value indicates a serialization or deserialization
      issue during molecule fragmentation import or export.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: CopyMolError

      This value indicates that an internal error was encountered when
      attempting to copy the input structure for indexing manipulations.

   .. ################################################################
      #
      ################################################################

   .. oe:constant: DataFilter  # NOT_YET

      This value indicates that the structure was not added to the
      index as a result not satisfying the input SD data requirements.

   .. ################################################################
      #
      ################################################################

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Deactivated

      This value indicates that an index loaded from serialization
      output encountered an internal loading failure and cannot be
      used as an active index.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DuplicateRecordID

      This value indicates that the record id provided for the structure
      is already in use.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DuplicateStructure

      This value indicates that the structure is already present in
      the index.

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetOptions`
         * :oe:const:`OEMedChem::OEMatchedPairOptions::UniquesOnly`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FragmentRangeFilter

      This value indicates that the structure was not added to the
      index as a result of exceeding the allowed range of the indexable
      fragment filter.

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetIndexableFragmentRange`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FragmentationLimitFilter

      This value indicates that the structure was not added to the
      index as a result of exceeding the number of allowed fragmentation bonds.

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetFragmentationLimit`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: HeavyAtomFilter

      This value indicates that the structure was not added to the
      index due to exceeding the heavy atom limit.

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetMaxAtomFilter`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: IncompatibleOptions

      This value indicates that an internal mismatch in fragmentation arguments and those
      for the target :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance was identified.
      Contact support@eyesopen.com with details.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NoError

      This value indicates a successful indexing status.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NoFragmentationBonds

      This value indicates the structure contains no fragmentation
      bonds.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NoStructure

      This value indicates that the structure is empty, or contains
      no heavy atoms.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ProcessorError

      This value indicates that the internal processing engine has rejected
      the structure for unspecified reasons.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ProcessorFilter

      This value indicates that the internal processing engine has rejected
      the structure based on the filter steps prior to indexing.  One possible
      reason for the rejection is the presence of one or more unspecified
      atom types in the structure being indexed.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Unspecified

      This value indicates an abnormal indexing status return of an
      unspecified nature.


.. oe:namespace:: OEMedChem

.. oe:constnamespace:: OEMatchedPairOptions

   This namespace contains constants representing various supported
   options to control a matched pair analysis.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AllCuts

      This constant requests analysis of all
      fragmentation cuts from the processor-specific fragmentation
      strategy.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ComboCuts

      This constant requests analysis of all single, double, triple
      combination fragmentation cuts from the processor-specific fragmentation
      strategy.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      This constant represents the default options setting for
      matched pair analysis which is
      :oe:const:`OEMedChem::OEMatchedPairOptions::AllCuts`,
      :oe:const:`OEMedChem::OEMatchedPairOptions::UniquesOnly`,
      :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` and
      :oe:const:`OEMedChem::OEMatchedPairOptions::ExportHKeys`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DefaultFragIndex

      This constant represents the default options setting
      for MCS fragment database indexing, which is
      :oe:const:`OEMedChem::OEMatchedPairOptions::AllCuts` and
      :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DoubleCuts

      This constant requests analysis of only double
      fragmentation cuts from the processor-specific fragmentation
      strategy.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ExportCompression

      This constant affects the serialization of information from
      a :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance.
      If enabled, singleton index nodes are *not* exported, thereby dramatically
      reducing the size of the serialized information.  This option should *only* be used
      to export information from a static index since reading of this
      compressed index information and indexing of additional input structures
      miss valid matched molecular pairs.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ExportHKeys

      This constant affects the serialization of information from
      a :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance.
      If enabled, extra index information that supports
      the :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` capability
      is serialized to the output file to increase index loading performance.
      If this information is suppressed, the serialized file size will be
      10-20% smaller and this information will be regenerated as needed.
      If :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` is not
      enabled, this option has no effect on serialization or deserialization.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: IndexHSingleCuts

      This constant activates additional indexing activity in order
      to capture matched pairs that differ by hydrogen presence
      at one or more of the substitution sites for SingleCuts only.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: IndexHSites

      This constant activates additional indexing activity in order
      to capture matched pairs that differ by hydrogen presence
      at one or more of the substitution sites for all fragmentation
      cut types.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SingleCuts

      This constant requests analysis of only single
      fragmentation cuts from the processor-specific fragmentation
      strategy.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: TripleCuts

      This constant requests analysis of only triple
      fragmentation cuts from the processor-specific fragmentation
      strategy.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: UniquesOnly

      This constant requests uniqueness checking using canonical
      SMILES of the input structures to avoid duplicated indexed
      fragments.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ValidAlterOpts

      This constant is a bit mask of all the options that can be
      changed on an active :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ValidFragIndexOpts

      This constant is a bit mask of all the valid read-only option values
      for an active :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` instance.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ValidIndexOpts

      This constant is a bit mask of all the valid read-only option values
      for an active :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ValidOptions

      This constant is a bit mask of all the valid option values and
      is a union of :oe:const:`OEMedChem::OEMatchedPairOptions::ValidAlterOpts`
      and :oe:const:`OEMedChem::OEMatchedPairOptions::ValidIndexOpts`



.. oe:namespace:: OEMedChem

.. oe:constnamespace:: OEMatchedPairProcessor

   This namespace contains constants representing various supported
   processor strategies for a matched pair analysis.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Undefined

      This constant represents an undefined or illegal context state.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      This constant represents a request for the default processor type
      which is currently specified to be 
      :oe:const:`OEMedChem::OEMatchedPairProcessor::HussainRea`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: HussainRea

      This constant represents a request for a [Hussain-2010]_
      processor type.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BemisMurcko

      This constant represents a request for a [Bemis-1996]_
      processor type.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Custom

      This constant identifies a custom type of processor engine that
      may be available in future versions.


.. oe:namespace:: OEMedChem

.. oe:constnamespace:: OEMatchedPairTransformExtractMode

   This namespace contains constants that control transform generation during retrieval from the matched pair index.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Unspecified

   This value indicates an unspecified or null mode value.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

   This mode represents the default extraction mode of
   :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Forward`
   and :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::Backward`.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AddAttachmentPts

   This extraction mode requests that attachment point information be added
   to the returned transforms to indicate the number of neighbor atoms
   adjacent to the desired context atoms.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AddMCSCorrespondence

   This extraction mode returns correspondence information for the
   matched pairs by annotating the maximum common substructure with
   atom mapping information to indicate the MCS core.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Backward

   This mode requests that only backward direction transforms be returned where 'backward' indicates the direction of
   later indexed structures over earlier indexed structures.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Forward

   This mode requests that only forward direction transforms be returned where 'forward' indicates the direction of
   earlier indexed structures over later indexed structures.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NoIsotopes

   This mode suppresses isotopic information in the transformation to allow more general use of the transformation
   with mixed isotopic input structures.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NoMatchedPairData

   This extraction mode suppress populating the delta data for the matched pairs in
   the returned transforms, for example if the transformation and the matched pair ids
   are all that is required.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NoMatchedPairs

   This extraction mode suppress populating the transformations with matched pair id
   information, for example, if the transformation itself is the only information of interest.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NoSMARTS

   This mode suppresses the addition of SMARTS qualifiers to the transformation which is present to ensure more accurate application
   of the transformation.  If the transform is being used for purposes other than performing transformations, the
   suppression of SMARTS qualifiers may provide simplification for downstream use of the transformation information.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Sorted

   Since the direction of the transformations returned is dependent on input order of the indexed structures, this mode
   attempts to perform a simple sorting of the right hand and left hand sides of the transformation to collapse
   forward and backward transformations to a more deterministic form.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SubstLimitSkip

   This extraction mode option indicates that any indexed core
   structures that exceed the maximum substituent limit are to be
   entirely skipped during the extraction process.  By default, any
   MMP cores with large numbers of substituents are truncated to the
   maximum value to avoid the combinatorics of generating huge
   numbers of matched molecular pair transformations.

   .. seealso::

      :ref:`OEMatchedPairTransformExtractOptions <OEMedChem_OEMatchedPairTransformExtractOptions>`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: SuppressNodeSort

   This extraction mode option suppresses an internal sort which
   is used to return the largest MCS cores from the matched pairs.
   This is largely a debugging and analysis tool to allow examination
   of all matched pair cores.



.. _OEMedChemConstants:

*******************
OEMedChem Constants
*******************

.. oe:namespace:: OEMedChem

.. toctree::

   OEMCSFragDatabaseSetup
   OEMCSScoreType
   OEMatchedPairAnalyzerFileType
   OEMatchedPairContext
   OEMatchedPairIndexSetup
   OEMatchedPairIndexStatus
   OEMatchedPairOptions
   OEMatchedPairProcessor
   OEMatchedPairTransformExtractMode
   OERegionType


.. oe:namespace:: OEMedChem

..  _OEMedChem_OERegionType:

.. oe:constnamespace:: OERegionType

   This namespace contains constants representing various supported
   regions types for the :oe:func:`OEMedChem::OEGetBemisMurcko` function.

   .. seealso::

      [Bemis-1996]_

   .. oe:constant:: Ring

   This constant identifies a ring region from the perception.

   .. oe:constant:: Linker

   This constant identifies linker regions from the perception.

   .. oe:constant:: Framework

   This constant identifies the framework region from the perception.

   .. oe:constant:: Sidechain

   This constant identifies sidechain regions from the perception.

   .. oe:constant:: All

   This constant requests that all regions be returned from the perception


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEApplyChEMBL18SolubilityTransforms ApplyChEMBL18SolubilityTransforms

.. oe:function:: OEApplyChEMBL18SolubilityTransforms

   .. warning::

      |DEPRECATED-API|

      This version is based on older [ChEMBL18-2014]_ data and will be deprecated in a future
      version of **OEMedChem TK**, please use :oe:func:`OEMedChem::OEApplyChEMBL24SolubilityTransforms` instead.

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEMolBase>* OEApplyChEMBL18SolubilityTransforms(OEChem::OEMolBase& input,
                                                                                      int context = OEMatchedPairContext::Bond2,
                                                                                      unsigned int requireNumPairs = 5u)

   .. oe:language:: python

      .. oe:api:: python

         OEApplyChEMBL18SolubilityTransforms(input: Union[OEGraphMol,OEMol,OEQMol],
                                             context: int,
                                             requireNumPairs: int = 5) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

   Given an input molecule, apply transformations derived from solubility data obtained from the
   [ChEMBL18-2014]_ database. The context argument controls the amount of chemistry information
   that should be included for the transformation reaction, see :oe:constns:`OEMedChem::OEMatchedPairContext`.
   This function supports only the :oe:const:`OEMedChem::OEMatchedPairContext::Bond0` or
   :oe:const:`OEMedChem::OEMatchedPairContext::Bond2` context values.  The ``minMMPThreshold`` argument will only
   apply transformations that meet or exceed the specified number of matched pairs.  Use a ``minMMPThreshold``
   value of ``0`` to apply all transformations regardless of the number of matched pairs associated with them.

   .. note::

      This function does not perform any validation or filtering on the input molecule to be transformed.
      The caller is expected to perform validity and/or size checking to ensure sensible inputs are provided.

   .. seealso::

      * :oe:func:`OEMedChem::OEApplyChEMBL24SolubilityTransforms` function



.. # split from OEMedChemFunctions.rst:90

.. ################################################################
   #
   ################################################################

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEApplyChEMBL24SolubilityTransforms ApplyChEMBL24SolubilityTransforms

.. oe:function:: OEApplyChEMBL24SolubilityTransforms

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEMolBase>* OEApplyChEMBL24SolubilityTransforms(OEChem::OEMolBase& input,
                                                                                      int context = OEMatchedPairContext::Bond2,
                                                                                      unsigned int requireNumPairs = 5u)

   .. oe:language:: python

      .. oe:api:: python

         OEApplyChEMBL24SolubilityTransforms(input: Union[OEGraphMol,OEMol,OEQMol],
                                             context: int,
                                             requireNumPairs: int = 5) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

   Given an input molecule, apply transformations derived from solubility data obtained from the
   [ChEMBL24-2018]_ database. The context argument controls the amount of chemistry information
   that should be included for the transformation reaction, see :oe:constns:`OEMedChem::OEMatchedPairContext`.
   This function supports only the :oe:const:`OEMedChem::OEMatchedPairContext::Bond0` or
   :oe:const:`OEMedChem::OEMatchedPairContext::Bond2` context values.  The ``minMMPThreshold`` argument will only
   apply transformations that meet or exceed the specified number of matched pairs.  Use a ``minMMPThreshold``
   value of ``0`` to apply all transformations regardless of the number of matched pairs associated with them.

   .. note::

      This function does not perform any validation or filtering on the input molecule to be transformed.
      The caller is expected to perform validity and/or size checking to ensure sensible inputs are provided.

   In the examples below, the input structures are transformed by the ChEMBL solubility transforms and exported
   to a file format that supports SD data.  Each transformed structure will contain information about the
   solubility transform (as SMIRKS) that generated it, and the matched pair information associated with each
   transform (ChEMBL identifiers and solubility data).  The added annotation data will contain the data fields,
   ``OEMMP_normalized_value (uM)``, ``OEMMP_published_value``, ``OEMMP_examples (SMILES)``, and ``OEMMP_transform (SMILES)``
   for subsequent analysis.

   .. oe:source:: ChEMBLSolubilityUsage.cpp
      :language: c++
      :frag:     SNIPPET-OEAPPLYCHEMBLSOLUBILITY-EXAMPLE

   .. oe:source:: ChEMBLSolubilityUsage.py
      :language: python
      :frag:     SNIPPET-OEAPPLYCHEMBLSOLUBILITY-EXAMPLE

   .. oe:source:: ChEMBLSolubilityUsage.java
      :language: java
      :frag:     SNIPPET-OEAPPLYCHEMBLSOLUBILITY-EXAMPLE

   .. oe:source:: ChEMBLSolubilityUsage.cs
      :language: csharp
      :frag:     SNIPPET-OEAPPLYCHEMBLSOLUBILITY-EXAMPLE



.. # split from OEMedChemFunctions.rst:107

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OECalculateComboBelief

.. oe:function:: OECalculateComboBelief

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OECalculateComboBelief(float tanimotoCombo)

   .. oe:language:: python

      .. oe:api:: python

         OECalculateComboBelief(combo: float) -> float

   .. note::

      See documentation for this function in the context of other belief function api points at
      :oe:func:`OEMedChem::OECalculateETComboBelief`


.. # split from OEMedChemFunctions.rst:109

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OECalculateETComboBelief

.. oe:function:: OECalculateETComboBelief

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OECalculateComboBelief(float tanimotoCombo)
         float OECalculateETComboBelief(float etCombo)

   .. oe:language:: python

      .. oe:api:: python

         OECalculateETComboBelief(etcombo: float) -> float

   This pair of functions is based on [Muchmore-2008]_. In that paper, the scores assessed for ROCS
   were the historic 'color score', in which the color was not normalized by self score, resulting
   in bias toward highly colored molecules.  All recent versions of OEShape and ROCS use Tanimoto
   combo for ranking which is the sum of a shape Tanimoto and a color Tanimoto.  The belief curve in
   :oe:func:`OEMedChem::OECalculateComboBelief` is based on fitting of the data described in
   [Muchmore-2008]_ to ROCS Tanimoto combo scores [Brown-Muchmore-2008]_.  EON results are ranked on the ET
   combo score, which is a sum of a shape Tanimoto and an electrostatic Tanimoto.  The belief curve in
   :oe:func:`OEMedChem::OECalculateETComboBelief` is based on fitting of the data described in
   [Muchmore-2008]_ to ET combo scores [Brown-Muchmore-2008]_.

   .. warning::
      For use with other OpenEye toolkits, the full scores with range (0,2) should be passed into these functions.

.. ################################################################
   #
   ################################################################



.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEConfigureMCSFragDatabaseOptions

.. oe:function:: OEConfigureMCSFragDatabaseOptions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureMCSFragDatabaseOptions(OESystem::OEInterface& itf,
                                                unsigned int config = OEMCSFragDatabaseSetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureMCSFragDatabaseOptions(itf: OEInterface, config: int = All) -> bool

   Configures the given interface to add MCS fragment database indexing parameters.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface
      This value has to be from the
      :oe:constns:`OEMedChem::OEMCSFragDatabaseSetup` namespace.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEMedChem::OEMCSFragDatabaseSetup` namespace
      * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions` function


.. # new api point for 2015.Oct

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEConfigureMatchedPairIndexOptions

.. oe:function:: OEConfigureMatchedPairIndexOptions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureMatchedPairIndexOptions(OESystem::OEInterface& itf,
                                                 unsigned int config = OEMatchedPairIndexSetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureMatchedPairIndexOptions(itf: OEInterface, config: int) -> bool

   Configures the given interface to add matched pair indexing parameters.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface
      This value has to be from the
      :oe:constns:`OEMedChem::OEMatchedPairIndexSetup` namespace.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEMedChem::OEMatchedPairIndexSetup` namespace
      * :oe:func:`OEMedChem::OESetupMatchedPairIndexOptions` function


.. # split from OEMedChemFunctions.rst:133

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OECreateIDString

.. oe:function:: OECreateIDString

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OECreateIDString(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OECreateIDString(m: Union[OEGraphMol,OEMol,OEQMol]) -> str

   .. note::

      See documentation for this function in the context of other graph-edit similarity function api points at
      :oe:func:`OEMedChem::OECreateIDStrings`


.. # split from OEMedChemFunctions.rst:135

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OECreateIDStrings

.. _OEMedChem_OECreateIDStrings:

.. oe:function:: OECreateIDStrings

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<const std::string> * OECreateIDStrings(const OEChem::OEMolBase& mol,
                                                                     const std::string& atomTag = "")

   .. oe:language:: python

      .. oe:api:: python

         OECreateIDStrings(mol: Union[OEGraphMol,OEMol,OEQMol], arg2: str) -> Iterable[str]

   This pair of functions exposes the graph-edit similarity used in clustering BROOD hitlists.
   Because this is a naturally O(N^2), the API is designed for efficiency using an asymmetric
   approach.  For any 'accepted' molecule, the :oe:func:`OEMedChem::OECreateIDStrings` function is used to generate
   a set of all the canonical SMILES of fragments which would be considered similar to the input
   molecule (this can be stored for fast lookup).  If one wants to determine if a new molecule is
   similar to the original molecule, :oe:func:`OEMedChem::OECreateIDString` is called, and the single string
   generated is compared to all the strings previously created.  If the new string is an exact
   match to any of the multiple strings created from the prior molecule, then the two molecules
   are deemed similar.

   The optional ``atomTag`` in the :oe:func:`OEMedChem::OECreateIDStrings` function enables working
   with a subset of atoms in the molecule. This is useful in reducing the scope of the function when
   clustering BROOD hitlists for multi-query replacements.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMedChem

.. oe:function:: OECreateMMPIndexFile

   .. oe:language:: c++ java csharp

      .. oe:api::

         OECreateMMPIndexStatus OECreateMMPIndexFile(const std::string& mmpdbfname,
                                                     const std::string& molfname,
                                                     const OECreateMMPIndexOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OECreateMMPIndexFile(mmpdbfname: str, molfname: str,
                              opts: OECreateMMPIndexOptions) -> OECreateMMPIndexStatus

   This function reads the input structures from the provided ``molfname`` filename and generates an :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` index
   from those structures which is saved to the provided ``mmpdbfname`` output file. Options for indexing are provided in the :ref:`OECreateMMPIndexOptions <OEMedChem_OECreateMMPIndexOptions>` argument.

   In general, the provided input structures should have been thoroughly normalized, deduplicated or have data merged onto unique input structures for duplicate structures.
   There are no options for structure normalization or cleanup activities as part of this automatic indexing.

   .. seealso::

      * :ref:`OECreateMMPIndexStatus <OEMedChem_OECreateMMPIndexStatus>`
      * :ref:`OECreateMMPIndexOptions <OEMedChem_OECreateMMPIndexOptions>`


.. # split from OEMedChemFunctions.rst:156

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEDetermineConnectiveComplexity

.. oe:function:: OEDetermineConnectiveComplexity

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEDetermineConnectiveComplexity(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEDetermineConnectiveComplexity(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

   .. note::

      See documentation for this function in the context of other complexity api points at
      :oe:func:`OEMedChem::OEDetermineMolecularComplexity`



.. # split from OEMedChemFunctions.rst:158

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEDetermineElementalComplexity

.. oe:function:: OEDetermineElementalComplexity

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEDetermineElementalComplexity(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEDetermineElementalComplexity(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

   .. note::

      See documentation for this function in the context of other complexity api points at
      :oe:func:`OEMedChem::OEDetermineMolecularComplexity`


.. # split from OEMedChemFunctions.rst:160

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEDetermineMolecularComplexity

.. oe:function:: OEDetermineMolecularComplexity

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEDetermineMolecularComplexity(const OEChem::OEMolBase& mol)
         float OEDetermineConnectiveComplexity(const OEChem::OEMolBase& mol)
         float OEDetermineElementalComplexity(const OEChem::OEMolBase& mol)
         float OEDetermineSymmetryComplexity(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEDetermineMolecularComplexity(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

   .. note::

      The molecule arguments are ``const``, so the
      :oe:func:`OEChem::OEPerceiveChiral` perception activity must be
      performed prior to calling these functions.

   From [Bertz-1981]_.  Includes connectivity and elemental complexity.  Though
   aromaticity is not addressed in the brief literature note, aromatic bonds are not counted as
   double bonds for the entropy calculation in this implementation.  The three additional api points return the
   three individual terms that make up the Molecular Complexity as defined by Bertz.

   .. seealso::

      * :oe:func:`OEMedChem::OEDetermineRingComplexity`
      * :oe:func:`OEMedChem::OENormalMolecularComplexity`



.. # split from OEMedChemFunctions.rst:191

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEDetermineRingComplexity

.. oe:function:: OEDetermineRingComplexity

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEDetermineRingComplexity(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEDetermineRingComplexity(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

   .. note::

      The molecule argument is ``const``, so this function requires that the
      :oe:func:`OEChem::OEFindRingAtomsAndBonds` perception activity has been
      performed prior to calling this function.

   This is a non-SSSR adaptation of the ring complexity algorithm of [Gasteiger-1979]_.  The values
   of this complexity are generally somewhat lower, but are well-correlated and follow the
   spirit of the SSSR method.

   .. seealso::

      * :oe:func:`OEMedChem::OEDetermineMolecularComplexity`



.. # split from OEMedChemFunctions.rst:211

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEDetermineStereoComplexity

.. oe:function:: OEDetermineStereoComplexity

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEDetermineStereoComplexity(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEDetermineStereoComplexity(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

   .. note::

      The molecule argument is ``const``, so the
      :oe:func:`OEChem::OEPerceiveChiral` perception activity must be
      performed prior to calling this function.

   In [Boda-2007]_ a term was added for tetrahedral stereo complexity to the [Bertz-1981]_ approach.
   The function here reproduces that function with the addition of chiral bond stereo to the
   tetrahedral atom stereo.

   .. seealso::

      * :oe:func:`OEMedChem::OENormalStereoComplexity`



.. # split from OEMedChemFunctions.rst:162

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEDetermineSymmetryComplexity

.. oe:function:: OEDetermineSymmetryComplexity

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEDetermineSymmetryComplexity(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEDetermineSymmetryComplexity(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

   .. note::

      See documentation for this function in the context of other complexity api points at
      :oe:func:`OEMedChem::OEDetermineMolecularComplexity`



.. # split from OEMedChemFunctions.rst:235

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEGetBemisMurcko

.. oe:function:: OEGetBemisMurcko

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEAtomBondSet>* OEGetBemisMurcko(OEChem::OEMolBase& mol,
                                                                       const OEBemisMurckoOptions& options = OEBemisMurckoOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEGetBemisMurcko(mol: Union[OEGraphMol,OEMol,OEQMol],
                          options: OEBemisMurckoOptions = OEBemisMurckoOptions()) -> OEAtomBondSetIter

   .. warning::

      The following function is deprecated. Please use the more generic function above.
      
   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEAtomBondSet>* OEGetBemisMurcko(OEChem::OEMolBase& mol,
                                                                       unsigned perceivetype)

   .. oe:language:: python

      .. oe:api:: python

         OEGetBemisMurcko(mol: Union[OEGraphMol,OEMol,OEQMol],
                          perceivetype: int) -> OEAtomBondSetIter

   The :oe:func:`OEMedChem::OEGetBemisMurcko` function partitions the
   given molecule into ring, linker and side chain fragments as
   defined in [Bemis-1996]_ .  It returns an iterator over
   :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` objects where each
   :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` container stores the atoms and the
   bonds of an identified region.  Each
   :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` returned is tagged with a role that
   identifies which group the set identifies.

   The :ref:`OEBemisMurckoOptions <OEMedChem_OEBemisMurckoOptions>` class can be used to
   specify both the :oe:constns:`OEMedChem::OERegionType` and also add additional
   functional groups to fragments. The `perceiveType` parameter only allows modification 
   of the :oe:constns:`OEMedChem::OERegionType` of the fragments returned.

   .. seealso::

      * :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` and :ref:`OEMolBase <OEChem_OEMolBase>` classes in the *OEChem TK* manual
      * :ref:`OERole <OESystem_OERole>` in the *OEChem TK* manual
      * :ref:`OEBemisMurckoOptions <OEMedChem_OEBemisMurckoOptions>`
      * :oe:constns:`OEMedChem::OERegionType`
      * :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments`
      * :ref:`chapter_fragmentation` chapter



.. # split from OEMedChemFunctions.rst:264

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEGetFuncGroupFragments

.. oe:function:: OEGetFuncGroupFragments

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEAtomBondSet>* OEGetFuncGroupFragments(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFuncGroupFragments(mol: Union[OEGraphMol,OEMol,OEQMol]) -> OEAtomBondSetIter

   The :oe:func:`OEMedChem::OEGetFuncGroupFragments` function partitions
   the given molecule into functional groups and returns an iterator
   over :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` objects.
   Each :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` container stores the atoms and the
   bonds of an identified fragment.
   See example in :ref:`Figure: Example of fragments returned by the
   OEGetFuncGroupFragments function<figure_OEGetFuncGroupFragments>` where
   each fragment returned by the :oe:func:`OEMedChem::OEGetFuncGroupFragments`
   function is highlighted with a different color.

   The :oe:func:`OEMedChem::OEGetFuncGroupFragments` function uses the following
   heuristics to fragment a molecule:

   * rings are left intact *i.e.* considered as a unit
   * exo-ring double bonds are not cleaved from adjacent rings
   * hetero atoms next to each other are kept together
   * sp and sp2 atoms next to each other are kept together
   * in order to avoid generating one atom fragments isolated atoms are
     attached to the smallest neighbor fragment

   .. note::

      The molecule argument is ``const``, so this function requires that the
      :oe:func:`OEChem::OEFindRingAtomsAndBonds` perception activity has been
      performed prior to calling this function.

   .. _figure_OEGetFuncGroupFragments:

   .. figure:: medchemtk/images/OEGetFuncGroupFragments.*
      :align:  center

      **Example of fragments returned by the OEGetFuncGroupFragments function**

   .. seealso::

      * :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` and :ref:`OEMolBase <OEChem_OEMolBase>` classes in the *OEChem TK* manual
      * :ref:`chapter_fragmentation` chapter



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEGetMatchedMolecularPairs GetMatchedMolecularPairs

.. oe:function:: OEGetMatchedMolecularPairs

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEMedChem::OEMatchedPair> *
      OESystem::OEIterBase<OEMedChem::OEMatchedPair>* OEGetMatchedMolecularPairs(const OEMedChem::OEMatchedPairAnalyzer &mmpindex, unsigned int molID, const OEMedChem::OEMatchedPairTransformExtractOptions &extractOpts=OEMedChem::OEMatchedPairTransformExtractOptions())
         OESystem::OEIterBase<OEMedChem::OEMatchedPair> *
      OESystem::OEIterBase<OEMedChem::OEMatchedPair>* OEGetMatchedMolecularPairs(const OEMedChem::OEMatchedPairAnalyzer &mmpindex, const OEChem::OEMolBase &probe, const OEChem::OEAtomBondSet &probeAttachSites, const OEMedChem::OEMatchedPairTransformExtractOptions &extractOpts=OEMedChem::OEMatchedPairTransformExtractOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEGetMatchedMolecularPairs(mmpindex: OEMatchedPairAnalyzer,
                                    molID: int,
                                    extractOpts: OEMatchedPairTransformExtractOptions = OEMatchedPairTransformExtractOptions()) -> Iterable[OEMatchedPair]
         OEGetMatchedMolecularPairs(mmpindex: OEMatchedPairAnalyzer,
                                    probe: Union[OEGraphMol,OEMol,OEQMol],
                                    probeAttachSites: OEAtomBondSet,
                                    extractOpts: OEMatchedPairTransformExtractOptions = OEMatchedPairTransformExtractOptions()) -> Iterable[OEMatchedPair]

   The first function returns the matched pairs associated with a specific molecule ID in the :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` index.

   The second overloaded function returns matched molecular pairs related to changes at specific substitution point(s) on the provided probe structure.
   Additionally, any \*atoms (atomic number 0) on the probe structure can be used to indicate the site(s) that are open valences and which can be arbitrarily substituted.

   .. seealso::

      * :oe:func:`OEMedChem::OEMatchedPairGetTransforms` function
      * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` class
      * :ref:`OEMatchedPairTransformExtractOptions <OEMedChem_OEMatchedPairTransformExtractOptions>` class
      * :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` class


.. ################################################################
   # version0_9_6
   ################################################################

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEGetMatchedPairAnalyzerFileType

.. oe:function:: OEGetMatchedPairAnalyzerFileType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetMatchedPairAnalyzerFileType(const char* ext)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMatchedPairAnalyzerFileType(extn: str) -> int

   Returns a symbolic constant from the :oe:constns:`OEMedChem::OEMatchedPairAnalyzerFileType`
   namespace for the file extension 'ext'.



.. # split from OEMedChemFunctions.rst:314

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEGetRegionType

.. oe:function:: OEGetRegionType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetRegionType (const std::string& regionName)

   .. oe:language:: python

      .. oe:api:: python

         OEGetRegionType(regionName: str) -> int

   Given the region name, return the :oe:constns:`OEMedChem::OERegionType` value.

   .. seealso::

      * :oe:constns:`OEMedChem::OERegionType`



.. # split from OEMedChemFunctions.rst:330

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEGetRegionTypeName

.. oe:function:: OEGetRegionTypeName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetRegionTypeName (unsigned int regionType)

   .. oe:language:: python

      .. oe:api:: python

         OEGetRegionTypeName(regionType: int) -> str

   Given the :oe:constns:`OEMedChem::OERegionType` value, return a string representation of the region name.

   .. seealso::

      * :oe:constns:`OEMedChem::OERegionType`



.. # split from OEMedChemFunctions.rst:346

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEGetRingChainFragments

.. oe:function:: OEGetRingChainFragments

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEAtomBondSet>* OEGetRingChainFragments(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetRingChainFragments(mol: Union[OEGraphMol,OEMol,OEQMol]) -> OEAtomBondSetIter

   The :oe:func:`OEMedChem::OEGetRingChainFragments` function partitions
   the given molecule into ring and chain fragments and returns an iterator
   over :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` objects.
   Each :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` container stores the atoms and the
   bonds of an identified fragment.
   See example in :ref:`Figure: Example of fragments returned by the
   OEGetRingChainFragments function<figure_OEGetRingChainFragments>` where
   each fragment returned by the :oe:func:`OEMedChem::OEGetRingChainFragments`
   function is highlighted with a different color.

   The perceived regions are based upon the heavy atoms in the molecule.
   If the molecule contains explicit hydrogen atoms, those explicit hydrogens
   will be returned in the same perception set(s) as their alpha heavy atom neighbor.
   If the perception set(s) returned are used to subset or fragment the molecule, a mixture
   of implicit and explicit hydrogens may result, so care should be taken to normalize
   the structure for subsequent use.

   .. note::

      The molecule argument is ``const``, so this function requires that the
      :oe:func:`OEChem::OEFindRingAtomsAndBonds` perception activity has been
      performed prior to calling this function.

   .. _figure_OEGetRingChainFragments:

   .. figure:: medchemtk/images/OEGetRingChainFragments.*
      :align:  center

      **Example of fragments returned by the OEGetRingChainFragments function**

   .. seealso::

      * :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` and :ref:`OEMolBase <OEChem_OEMolBase>` classes in the *OEChem TK* manual
      * :ref:`chapter_fragmentation` chapter



.. # split from OEMedChemFunctions.rst:393

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEGetRingLinkerSideChainFragments

.. oe:function:: OEGetRingLinkerSideChainFragments

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEAtomBondSet>* OEGetRingLinkerSideChainFragments(const OEChem::OEMolBase& mol,
                                                                                        const OEBemisMurckoOptions& options = OEBemisMurckoOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEGetRingLinkerSideChainFragments(mol: Union[OEGraphMol,OEMol,OEQMol],
                                           options: OEBemisMurckoOptions = OEBemisMurckoOptions()) -> OEAtomBondSetIter

   .. warning::

      The following function is deprecated. Please use the more generic function above.
   
   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEAtomBondSet>* OEGetRingLinkerSideChainFragments(const OEChem::OEMolBase& mol,
                                                                                        unsigned perceiveType)

   .. oe:language:: python

      .. oe:api:: python

         OEGetRingLinkerSideChainFragments(mol: Union[OEGraphMol,OEMol,OEQMol],
                                           perceiveType: int) -> OEAtomBondSetIter

   The :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments` function partitions
   the given molecule into ring, linker and side chain fragments as defined
   in [Bemis-1996]_ .

   The :ref:`OEBemisMurckoOptions <OEMedChem_OEBemisMurckoOptions>` class can be used to
   specify both the :oe:constns:`OEMedChem::OERegionType` and also add additional
   functional groups to fragments. The `perceiveType` parameter only allows modification 
   of the :oe:constns:`OEMedChem::OERegionType` of the fragments returned.

   It returns an iterator over :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` objects where
   each :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` container stores the atoms and the bonds
   of an identified fragment.
   See example in :ref:`Figure: Example of fragments returned by the
   OEGetRingLinkerSideChainFragments function<figure_OEGetRingLinkerSideChainFragments>`
   where each fragment returned by the :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments`
   function is highlighted with a different color.

   The perceived regions are based upon the heavy atoms in the molecule.
   If the molecule contains explicit hydrogen atoms, those explicit hydrogens
   will be returned in the same perception set(s) as their alpha heavy atom neighbor.
   If the perception set(s) returned are used to subset or fragment the molecule, a mixture
   of implicit and explicit hydrogens may result, so care should be taken to normalize
   the structure for subsequent use.

   Definitions from  [Bemis-1996]_:

   **ring systems**
     Cycles within the graph representation of molecules and cycles sharing an
     edge (a connection between two atoms or a bond).

   **linker atoms**
     Atoms that are on the direct path connecting two ring systems are defined as linker atoms.

   **side chain atoms**
     Any nonring, nonlinker atoms are defined as side chain atoms.

   .. note::

      The molecule argument is ``const``, so this function requires that the
      :oe:func:`OEChem::OEFindRingAtomsAndBonds` perception activity has been
      performed prior to calling this function.

   .. _figure_OEGetRingLinkerSideChainFragments:

   .. figure:: medchemtk/images/OEGetRingLinkerSideChainFragments.*
      :align:  center

      **Example of fragments returned by the OEGetRingLinkerSideChainFragments function**

   .. seealso::

      * :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` and :ref:`OEMolBase <OEChem_OEMolBase>` classes in the *OEChem TK* manual
      * :ref:`chapter_fragmentation` chapter



.. # split from OEMedChemFunctions.rst:452

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEGetRingValue

.. oe:function:: OEGetRingValue

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEGetRingValue(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetRingValue(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

   This is a function that assigns a value to a molecule or fragment based on the number
   and type of ring systems it contains.  Ring systems that are favored by small-molecule
   medicinal chemistry receive higher scores.  No preference is given between aromatic and
   aliphatic rings.  Ring fusions are favored over spiro ring systems and common ring sizes (5,6)
   are favored over unusual ring sizes.  This value is not recommended for filtering or cutoffs,
   yet can be useful for ordering compounds from a set of potential candidates.



.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEIsMCSFragDatabaseFiletype OEIsMCSFragDatabaseFileType IsMCSFragDatabaseFiletype IsMCSFragDatabaseFileType

.. oe:function:: OEIsMCSFragDatabaseFileType

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsMCSFragDatabaseFileType(unsigned int type)
         bool OEIsMCSFragDatabaseFileType(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEIsMCSFragDatabaseFileType(type: int) -> bool
         OEIsMCSFragDatabaseFileType(filename: str) -> bool

   This function returns a boolean indicating whether the provided :oe:constns:`OEMedChem::OEMatchedPairAnalyzerFileType` value
   or filename is a serialized fragment index type, i.e., has a file extension of ``.mcsfrag``.


.. ################################################################
   # version1_0_1
   ################################################################

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEIsMatchedPairAnalyzerFileType

.. oe:function:: OEIsMatchedPairAnalyzerFileType

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsMatchedPairAnalyzerFileType(unsigned int type)
         bool OEIsMatchedPairAnalyzerFileType(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEIsMatchedPairAnalyzerFileType(type: int) -> bool
         OEIsMatchedPairAnalyzerFileType(filename: str) -> bool

   This function returns a boolean indicating whether the provided :oe:constns:`OEMedChem::OEMatchedPairAnalyzerFileType` value
   or filename is a serialized index type, i.e., has a file extension of ``.mmpidx``.


.. ################################################################
   # version0_9_6
   ################################################################

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEIsReadableMatchedPairAnalyzer

.. oe:function:: OEIsReadableMatchedPairAnalyzer

   .. warning::

      The following functions are deprecated. Please use the more generic
      :oe:func:`OEMedChem::OEIsMatchedPairAnalyzerFileType` to test
      for the appropriate file extension for a serialized index.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsReadableMatchedPairAnalyzer(unsigned int type)
         bool OEIsReadableMatchedPairAnalyzer(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEIsReadableMatchedPairAnalyzer(type: int) -> bool
         OEIsReadableMatchedPairAnalyzer(filename: str) -> bool

   This function returns a boolean indicating whether the provided :oe:constns:`OEMedChem::OEMatchedPairAnalyzerFileType` value
   or filename is a readable serialized index.

   .. warning::

      This function is deprecated as of 2017.Feb and will be removed in a future
      version of **OEMedChem TK**, please use
      :oe:func:`OEMedChem::OEIsMatchedPairAnalyzerFileType` instead.


.. ################################################################
   # version0_9_6
   ################################################################

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEIsWriteableMatchedPairAnalyzer

.. oe:function:: OEIsWriteableMatchedPairAnalyzer

   .. warning::

      The following functions are deprecated. Please use the more generic
      :oe:func:`OEMedChem::OEIsMatchedPairAnalyzerFileType` to test
      for the appropriate file extension for a serialized index.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsWriteableMatchedPairAnalyzer(unsigned int type)
         bool OEIsWriteableMatchedPairAnalyzer(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEIsWriteableMatchedPairAnalyzer(type: int) -> bool
         OEIsWriteableMatchedPairAnalyzer(filename: str) -> bool

   This function returns a boolean indicating whether the provided :oe:constns:`OEMedChem::OEMatchedPairAnalyzerFileType` value
   or filename is a writeable serialized index.

   .. warning::

      This function is deprecated as of 2017.Feb and will be removed in a future
      version of **OEMedChem TK**, please use
      :oe:func:`OEMedChem::OEIsMatchedPairAnalyzerFileType` instead.


.. oe:namespace:: OEMedChem

.. oe:function:: OEMCSFragDatabaseCoreQuery

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMCSFragDatabaseCoreQuery(const std::string& MCScoreSMI,
                                         std::string& MCScoreSMARTS)

   .. oe:language:: python

      .. oe:api:: python

         OEMCSFragDatabaseCoreQuery(smiles: bytes) -> bytes

   This function can be used to convert the MCS SMILES core string
   into a more restrictive SMARTS query for use in highlighting
   or mapping activities that use the MCS core and the query or target structures.

   .. seealso::

      * :ref:`OEMCSMolSimScore <OEMedChem_OEMCSMolSimScore>` class
      * :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` class
      * :oe:meth:`OEMedChem::OEMCSFragDatabase::GetScores` method
      * :oe:meth:`OEMedChem::OEMCSFragDatabase::GetSortedScores` method


.. # split from OEMedChemFunctions.rst:469

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairApplyTransforms

.. oe:function:: OEMatchedPairApplyTransforms

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEMolBase> *
         OESystem::OEIterBase<OEChem::OEMolBase>* OEMatchedPairApplyTransforms(const OEChem::OEMolBase& mol,
                                                                               OEMatchedPairAnalyzer& mmp,
                                                                               int context = OEMatchedPairContext::Default,
                                                                               unsigned int requireNumPairs = 0u)

   .. oe:language:: python

      .. oe:api:: python

         OEMatchedPairApplyTransforms(mol: Union[OEGraphMol,OEMol,OEQMol],
                                      mmp: OEMatchedPairAnalyzer, context: int,
                                      requireNumPairs: int = 0) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

   The :oe:func:`OEMedChem::OEMatchedPairApplyTransforms` function will take the matched pair
   analysis provided by the :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` engine to generate
   a set of transformations to apply to the input molecule.  The output molecule(s)
   will be annotated with SD data that identifies the original pair of molecules from the matched pair indexing,
   any data associated with those original molecules, and the transformation that resulted in the output molecule.
   The context argument controls the amount of chemistry information that should be used in constructing
   the transformation reaction, see :oe:constns:`OEMedChem::OEMatchedPairContext`.  The ``minMMPThreshold`` argument will only
   apply transformations that meet or exceed the specified number of matched pairs.  A ``minMMPThreshold``
   value of ``0`` will apply transformations regardless of the number of matched pairs associated with them.



.. # split from OEMedChemFunctions.rst:489

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairContextName

.. oe:function:: OEMatchedPairContextName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEMatchedPairContextName(int context)

   .. oe:language:: python

      .. oe:api:: python

         OEMatchedPairContextName(context: int) -> str

   Given a :oe:constns:`OEMedChem::OEMatchedPairContext` value, return a string representation of the context.



.. # split from OEMedChemFunctions.rst:501

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairContextType

.. oe:function:: OEMatchedPairContextType

   .. oe:language:: c++ java csharp

      .. oe:api::

         int OEMatchedPairContextType(const std::string& scontext)

   .. oe:language:: python

      .. oe:api:: python

         OEMatchedPairContextType(sContextname: str) -> int

   Given the context name, return the :oe:constns:`OEMedChem::OEMatchedPairContext` value.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. 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>`


.. # split from OEMedChemFunctions.rst:549

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairIndexStatusName

.. oe:function:: OEMatchedPairIndexStatusName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEMatchedPairIndexStatusName(int status)

   .. oe:language:: python

      .. oe:api:: python

         OEMatchedPairIndexStatusName(status: int) -> str

   Given a :oe:constns:`OEMedChem::OEMatchedPairIndexStatus` value,
   return a string representation of the status.



.. # split from OEMedChemFunctions.rst:562

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairIndexStatusType

.. oe:function:: OEMatchedPairIndexStatusType

   .. oe:language:: c++ java csharp

      .. oe:api::

         int OEMatchedPairIndexStatusType(const std::string& scontext)

   .. oe:language:: python

      .. oe:api:: python

         OEMatchedPairIndexStatusType(sinput: str) -> int

   Given a status name, return the :oe:constns:`OEMedChem::OEMatchedPairIndexStatus` value.



.. # split from OEMedChemFunctions.rst:574

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairOptionsName

.. oe:function:: OEMatchedPairOptionsName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEMatchedPairOptionsName(unsigned int option)

   .. oe:language:: python

      .. oe:api:: python

         OEMatchedPairOptionsName(option: int) -> str

   Given a :oe:constns:`OEMedChem::OEMatchedPairOptions` value, return a string representation of the option.



.. # split from OEMedChemFunctions.rst:586

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairOptionsType

.. oe:function:: OEMatchedPairOptionsType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEMatchedPairOptionsType(const std::string& sOption)

   .. oe:language:: python

      .. oe:api:: python

         OEMatchedPairOptionsType(sOption: str) -> int

   Given the option name, return the :oe:constns:`OEMedChem::OEMatchedPairOptions` type.



.. # split from OEMedChemFunctions.rst:598

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairProcessorName

.. oe:function:: OEMatchedPairProcessorName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEMatchedPairProcessorName(unsigned int type)

   .. oe:language:: python

      .. oe:api:: python

         OEMatchedPairProcessorName(proctype: int) -> str

   Given a :oe:constns:`OEMedChem::OEMatchedPairProcessor` type, return a string representation of the processor type.



.. # split from OEMedChemFunctions.rst:610

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairProcessorType

.. oe:function:: OEMatchedPairProcessorType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEMatchedPairProcessorType(const std::string& sname)

   .. oe:language:: python

      .. oe:api:: python

         OEMatchedPairProcessorType(sProctype: str) -> int

   Given the processor name, return the :oe:constns:`OEMedChem::OEMatchedPairProcessor` type.



*******************************************************************************
OEMedChem Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEApplyChEMBL18SolubilityTransforms.rst
   OEApplyChEMBL24SolubilityTransforms.rst
   OECalculateComboBelief.rst
   OECalculateETComboBelief.rst
   OEConfigureMatchedPairIndexOptions.rst
   OEConfigureMCSFragDatabaseOptions.rst
   OECreateIDString.rst
   OECreateIDStrings.rst
   OECreateMMPIndexFile.rst
   OEDetermineConnectiveComplexity.rst
   OEDetermineElementalComplexity.rst
   OEDetermineMolecularComplexity.rst
   OEDetermineRingComplexity.rst
   OEDetermineStereoComplexity.rst
   OEDetermineSymmetryComplexity.rst
   OEGetBemisMurcko.rst
   OEGetFuncGroupFragments.rst
   OEGetMatchedMolecularPairs.rst
   OEGetMatchedPairAnalyzerFileType.rst
   OEGetRegionType.rst
   OEGetRegionTypeName.rst
   OEGetRingChainFragments.rst
   OEGetRingLinkerSideChainFragments.rst
   OEGetRingValue.rst
   OEIsMatchedPairAnalyzerFileType.rst
   OEIsMCSFragDatabaseFileType.rst
   OEIsReadableMatchedPairAnalyzer.rst
   OEIsWriteableMatchedPairAnalyzer.rst
   OEMatchedPairApplyTransforms.rst
   OEMatchedPairContextName.rst
   OEMatchedPairContextType.rst
   OEMatchedPairGetTransforms.rst
   OEMatchedPairIndexStatusName.rst
   OEMatchedPairIndexStatusType.rst
   OEMatchedPairOptionsName.rst
   OEMatchedPairOptionsType.rst
   OEMatchedPairProcessorName.rst
   OEMatchedPairProcessorType.rst
   OEMCSFragDatabaseCoreQuery.rst
   OEMedChemGetArch.rst
   OEMedChemGetLicensee.rst
   OEMedChemGetPlatform.rst
   OEMedChemGetRelease.rst
   OEMedChemGetSite.rst
   OEMedChemGetVersion.rst
   OEMedChemIsLicensed.rst
   OEMoleculeToCores.rst
   OENormalMolecularComplexity.rst
   OENormalStereoComplexity.rst
   OEReadMatchedPairAnalyzer.rst
   OEReadMCSFragDatabase.rst
   OEReadMMPIndexMolecules.rst
   OESetupMatchedPairIndexOptions.rst
   OESetupMCSFragDatabaseOptions.rst
   OETotalMolecularComplexity.rst
   OEWriteMatchedPairAnalyzer.rst
   OEWriteMCSFragDatabase.rst
   OEWriteMMPIndexMolecules.rst


.. # split from OEMedChemFunctions.rst:8

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMedChemGetArch

.. oe:function:: OEMedChemGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEMedChemGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEMedChemGetArch() -> str

   Returns the internal build string used by OpenEye, Cadence Molecular Sciences
   to identify the hardware architecture.  The format of these strings may
   change over time.



.. # split from OEMedChemFunctions.rst:18

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMedChemGetLicensee

.. oe:function:: OEMedChemGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEMedChemGetLicensee()
         bool OEMedChemGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEMedChemGetLicensee() -> str
         OEMedChemGetLicensee(licensee: str) -> bool

   Returns the licensee name from the license file.



.. # split from OEMedChemFunctions.rst:27

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMedChemGetPlatform

.. oe:function:: OEMedChemGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEMedChemGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEMedChemGetPlatform() -> str

   Returns the internal build string used by OpenEye, Cadence Molecular Sciences
   to identify a platform.  The format of these strings may change over
   time, and future distributions may contain different values even when
   using the same operating system, compiler and processor.  For example,
   on a ``x86_64`` Red Hat Enterprise Linux box this would return
   ``redhat-RHEL5-g++4.1-x64``.



.. # split from OEMedChemFunctions.rst:40

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMedChemGetRelease

.. oe:function:: OEMedChemGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEMedChemGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEMedChemGetRelease() -> str

   Returns the release name of the *OEMedChem* library being used.  This
   returns a value similar to ``0.10.0`` for production versions of the
   library, and ``0.10.0 debug`` for the checking version of the library.



.. # split from OEMedChemFunctions.rst:50

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMedChemGetSite

.. oe:function:: OEMedChemGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEMedChemGetSite()
         bool OEMedChemGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEMedChemGetSite() -> str
         OEMedChemGetSite(site: str) -> bool

   Returns the physical site location of the licensee as registered in the license file.



.. # split from OEMedChemFunctions.rst:59

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMedChemGetVersion

.. oe:function:: OEMedChemGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEMedChemGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEMedChemGetVersion() -> int

   Returns the version number of the library being used.  This is an
   unsigned integer value indicating the date on which the library was
   built, for example ``20141001``, for the 1st of October 2014.  This
   value should be used when reporting problems, and unlike the release
   string, may be used in comparisons if needed.



.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMedChemIsLicensed

.. oe:function:: OEMedChemIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMedChemIsLicensed(const char* feature = 0,
                                  unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEMedChemIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **OEMedChem TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **OEMedChem TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **OEMedChem TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function



.. oe:namespace:: OEMedChem

.. oe:function:: OEMoleculeToCores

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<const std::string>* OEMoleculeToCores(const OEChem::OEMolBase& mol,
                                                                    const OEMCSFragDatabaseOptions& opts,
                                                                    bool permuteFragments = true)

   .. oe:language:: python

      .. oe:api:: python

         OEMoleculeToCores(mol: Union[OEGraphMol,OEMol,OEQMol],
                           fragopts: OEMCSFragDatabaseOptions,
                           permuteFragments: bool = True) -> Iterable[str ]

   Given a molecule, return the fragmentation cores using the provided fragmentation options. If the
   ``permuteFragments`` argument is ``true``, all combinations of the generated fragmentation
   cores are generated, otherwise a unique set of multi-fragment cores is returned representing
   all combinations of bond fragmentations between the min and max cut limits.

   Shown below is a version that uses the free function and custom options setup from command line arguments:

   .. oe:source:: MoleculeToCoreExample.cpp
      :language: c++
      :frag:     SNIPPET-MOLECULETOCORE-OPTS-EXAMPLE

   .. oe:source:: MoleculeToCoreExample.py
      :language: python
      :frag:     SNIPPET-MOLECULETOCORE-OPTS-EXAMPLE

   .. oe:source:: MoleculeToCoreExample.java
      :language: java
      :frag:     SNIPPET-MOLECULETOCORE-OPTS-EXAMPLE

   .. oe:source:: MoleculeToCoreExample.cs
      :language: csharp
      :frag:     SNIPPET-MOLECULETOCORE-OPTS-EXAMPLE

   .. seealso::

      * :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` class
      * :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>` class


.. # split from OEMedChemFunctions.rst:618

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OENormalMolecularComplexity

.. oe:function:: OENormalMolecularComplexity

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OENormalMolecularComplexity(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OENormalMolecularComplexity(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

   .. note::

      The molecule argument is ``const``, so the
      :oe:func:`OEChem::OEPerceiveChiral` perception activity must be
      performed prior to calling this function.

   This function is a convenience that scales the value from :oe:func:`OEMedChem::OEDetermineMolecularComplexity` 
   to [0-1] assuming the underlying complexity is [0-1000] which is the case from most small molecules.



.. # split from OEMedChemFunctions.rst:633

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OENormalStereoComplexity

.. oe:function:: OENormalStereoComplexity

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OENormalStereoComplexity(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OENormalStereoComplexity(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

   .. note::

      The molecule argument is ``const``, so the
      :oe:func:`OEChem::OEPerceiveChiral` perception activity must be
      performed prior to calling this function.

   This function is a convenience that scales the value from :oe:func:`OEMedChem::OEDetermineStereoComplexity` to a range of
   approximately [0-1] assuming a non-normalized complexity range of [0-4.3] which corresponds
   to between 0 and 20 stereo centers.



.. oe:namespace:: OEMedChem

.. oe:function:: OEReadMCSFragDatabase

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMCSFragDatabase(const std::string& fname,
                                    OEMCSFragDatabase& mcsfragdb,
                                    bool enableMerge = false)
         bool OEReadMCSFragDatabase(OEPlatform::oeistream& ifs,
                                    OEMCSFragDatabase& mcsfragdb,
                                    bool enableMerge = false)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMCSFragDatabase(fname: str, mcsfragdb: OEMCSFragDatabase,
                               enableMerge: bool = False) -> bool
         OEReadMCSFragDatabase(ifs: oeistream, mcsfragdb: OEMCSFragDatabase,
                               enableMerge: bool = False) -> bool

   This function reads the serialized contents of an MCS fragment index and populates the :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` instance.
   An ``enableMerge`` argument of ``false`` is used to indicate that the :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` instance should be cleared
   before the read, or ``true`` to indicate that the read index information should add (and update) existing data.

   .. seealso::

      * :oe:func:`OEMedChem::OEIsMCSFragDatabaseFileType`
      * :oe:func:`OEMedChem::OEWriteMCSFragDatabase`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEReadMMPIndexMolecules ReadMMPIndexMolecules

.. oe:function:: OEReadMMPIndexMolecules

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMMPIndexMolecules(OEPlatform::oeistream& ifs,
                                      OEMatchedPairAnalyzer& mmpindex,
                                      bool regenHKeys = false)
         bool OEReadMMPIndexMolecules(const std::string& fragbytes,
                                      OEMatchedPairAnalyzer& mmpindex,
                                      bool regenHKeys = false)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMMPIndexMolecules(ifs: oeistream,
                                 mmpindex: OEMatchedPairAnalyzer,
                                 regenHKeys: bool = False) -> bool
         OEReadMMPIndexMolecules(fragbytes: str,
                                 mmpindex: OEMatchedPairAnalyzer,
                                 regenHKeys: bool = False) -> bool

   This function deserializes Matched Pair fragmentation information from the passed string or :ref:`oeistream <OEPlatform_oeistream>` and adds the information to the :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` provided.

   The goal of this function is to stream the precomputed fragmentation information directly into the Matched Molecular Pair index with maximum efficiency.

   .. seealso::

      * :oe:func:`OEMedChem::OEWriteMMPIndexMolecules`


.. ################################################################
   # version0_9_6
   ################################################################

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEReadMatchedPairAnalyzer ReadMatchedPairAnalyzer deserialize

.. oe:function:: OEReadMatchedPairAnalyzer

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadMatchedPairAnalyzer(const std::string& fname,
                                        OEMatchedPairAnalyzer& mmpindex,
                                        bool enableMerge = false,
                                        bool regenHMemberKeys = false)
         bool OEReadMatchedPairAnalyzer(OEPlatform::oeistream& ifs,
                                        OEMatchedPairAnalyzer& mmpindex,
                                        bool enableMerge = false,
                                        bool regenHMemberKeys = false)

   .. oe:language:: python

      .. oe:api:: python

         OEReadMatchedPairAnalyzer(fname: str, mmpindex: OEMatchedPairAnalyzer,
                                   enableMerge: bool = False,
                                   regenHKeys: bool = False) -> bool
         OEReadMatchedPairAnalyzer(ifs: oeistream,
                                   mmpindex: OEMatchedPairAnalyzer,
                                   enableMerge: bool = False,
                                   regenHKeys: bool = False) -> bool

   This function reads the serialized contents of a matched pair index and populates the :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance
   as below.  An ``enableMerge`` argument of ``false`` is used to indicate that the :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance should be cleared
   before the read, or ``true`` to indicate that the read index information should add (and update) existing data. If the ``regenHMemberKeys`` argument
   is ``true`` and the index includes extra H-member indexing information, the serialized H-member information will be ignored and regenerated during the read.

   .. oe:source:: SerializeIndex.cpp
      :language: c++
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-DESERIALIZE-INDEX

   .. oe:source:: SerializeIndex.py
      :language: python
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-DESERIALIZE-INDEX

   .. oe:source:: SerializeIndex.java
      :language: java
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-DESERIALIZE-INDEX

   .. oe:source:: SerializeIndex.cs
      :language: csharp
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-DESERIALIZE-INDEX

   .. seealso::

      * :oe:func:`OEMedChem::OEIsReadableMatchedPairAnalyzer`
      * :oe:func:`OEMedChem::OEWriteMatchedPairAnalyzer`



.. oe:namespace:: OEMedChem

.. oe:function:: OESetupMCSFragDatabaseOptions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupMCSFragDatabaseOptions(OEMCSFragDatabaseOptions& opts,
                                            const OESystem::OEInterface& itf)

   .. oe:language:: python

      .. oe:api:: python

         OESetupMCSFragDatabaseOptions(arg1: OEMCSFragDatabaseOptions,
                                       itf: OEInterface) -> bool

   Initializes an :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>`
   object from the parameters of a given interface.

   .. seealso::

      * :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>` class
      * :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function



.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OESetupMatchedPairIndexOptions

.. oe:function:: OESetupMatchedPairIndexOptions

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupMatchedPairIndexOptions(OEMatchedPairAnalyzerOptions& opts,
                                             const OESystem::OEInterface& itf)

   .. oe:language:: python

      .. oe:api:: python

         OESetupMatchedPairIndexOptions(arg1: OEMatchedPairAnalyzerOptions,
                                        itf: OEInterface) -> bool

   Initializes an :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>`
   object from the parameters of a given interface.

   .. seealso::

      * :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` class
      * :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions` function



.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OETotalMolecularComplexity

.. oe:function:: OETotalMolecularComplexity

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OETotalMolecularComplexity(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OETotalMolecularComplexity(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

   .. note::

      The molecule argument is ``const``, so the
      :oe:func:`OEChem::OEPerceiveChiral` perception activity must be
      performed prior to calling this function.

   This is the final function to use for assessing molecular complexity.
   :oe:func:`OEMedChem::OETotalMolecularComplexity` = :oe:func:`OEMedChem::OENormalMolecularComplexity` + :oe:func:`OEMedChem::OENormalStereoComplexity`.
   In turn, :oe:func:`OEMedChem::OENormalMolecularComplexity` = :oe:func:`OEMedChem::OEDetermineConnectiveComplexity` + :oe:func:`OEMedChem::OEDetermineElementalComplexity`.
   Ring complexity is not included because it did not contribute significantly to reproduction of chemists' notion of synthetic accessibility.
   Ring complexity is available in :oe:func:`OEMedChem::OEDetermineRingComplexity`.

   .. seealso::

      * :oe:func:`OEMedChem::OEDetermineConnectiveComplexity`
      * :oe:func:`OEMedChem::OEDetermineElementalComplexity`
      * :oe:func:`OEMedChem::OEDetermineMolecularComplexity`
      * :oe:func:`OEMedChem::OEDetermineRingComplexity`
      * :oe:func:`OEMedChem::OEDetermineSymmetryComplexity`
      * :oe:func:`OEMedChem::OENormalMolecularComplexity`
      * :oe:func:`OEMedChem::OENormalStereoComplexity`



.. oe:namespace:: OEMedChem

.. oe:function:: OEWriteMCSFragDatabase

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteMCSFragDatabase(const std::string& fname,
                                     const OEMCSFragDatabase& mcsfragdb)
         bool OEWriteMCSFragDatabase(OEPlatform::oeostream& ofs,
                                     const OEMCSFragDatabase& mcsfragdb)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteMCSFragDatabase(fname: str, mcsfragdb: OEMCSFragDatabase) -> bool
         OEWriteMCSFragDatabase(ofs: oeostream, mcsfragdb: OEMCSFragDatabase) -> bool

   This function serializes the state of the :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` instance argument
   to a file or stream.

   .. seealso::

      * :oe:func:`OEMedChem::OEIsMCSFragDatabaseFileType`
      * :oe:func:`OEMedChem::OEReadMCSFragDatabase`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEWriteMMPIndexMolecules WriteMMPIndexMolecules

.. oe:function:: OEWriteMMPIndexMolecules

   .. oe:language:: c++ java csharp

      .. oe:api::

         int OEWriteMMPIndexMolecules(OEPlatform::oeostream& ofs,
                                      unsigned int recID,
                                      const OEChem::OEMolBase& inmol,
                                      const OEMatchedPairAnalyzer& mmpindex,
                                      bool initStream = false)
         int OEWriteMMPIndexMolecules(std::string& fragbytes,
                                      unsigned int recID,
                                      const OEChem::OEMolBase& inmol,
                                      const OEMatchedPairAnalyzer& mmpindex,
                                      bool writeHeader = false);

   .. oe:language:: python

      .. oe:api:: python

         OEWriteMMPIndexMolecules(ofs: oeostream, recID: int,
                                  inmol: Union[OEGraphMol,OEMol,OEQMol],
                                  mmpindex: OEMatchedPairAnalyzer,
                                  initStream: bool = False) -> int
         OEWriteMMPIndexMolecules(fragbytes: str, recID: int,
                                  inmol: Union[OEGraphMol,OEMol,OEQMol],
                                  mmpindex: OEMatchedPairAnalyzer,
                                  writeHeader: bool = False) -> int

   This function serializes Matched Pair fragmentation information from the passed molecule based on the indexing setting provided in the :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` argument.

   The goal of this function is to precompute all the fragmentation information needed to allow the provided input molecule to be recorded in the Matched Molecular Pair index with maximum efficiency.
   For multi-threaded or multi-processing index creation, moving most of the fragmentation processing activity outside of the index creation activity results in better indexing throughput overall.

   .. seealso::

      * :oe:func:`OEMedChem::OEReadMMPIndexMolecules`


.. ################################################################
   # version0_9_6
   ################################################################

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEWriteMatchedPairAnalyzer WriteMatchedPairAnalyzer serialize

.. oe:function:: OEWriteMatchedPairAnalyzer

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteMatchedPairAnalyzer(const std::string& fname,
                                         const OEMatchedPairAnalyzer& mmpindex)
         bool OEWriteMatchedPairAnalyzer(OEPlatform::oeostream& ofs,
                                         const OEMatchedPairAnalyzer& mmpindex)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteMatchedPairAnalyzer(fname: str, mmpindex: OEMatchedPairAnalyzer) -> bool
         OEWriteMatchedPairAnalyzer(ofs: oeostream,
                                    mmpindex: OEMatchedPairAnalyzer) -> bool

   This function serializes the state of the :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance argument
   to a file or stream as below:

   .. oe:source:: SerializeIndex.cpp
      :language: c++
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-SERIALIZE-INDEX

   .. oe:source:: SerializeIndex.py
      :language: python
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-SERIALIZE-INDEX

   .. oe:source:: SerializeIndex.java
      :language: java
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-SERIALIZE-INDEX

   .. oe:source:: SerializeIndex.cs
      :language: csharp
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-SERIALIZE-INDEX

   If the matched pair index information being exported is complete in the sense that additional structures are *not*
   intended to be added to the index upon a subsequent deserialization, significant savings in output file size is
   possible by suppressing the export of singleton nodes - those index nodes which do not contain any matched pairs.
   Conversely, if the exported index must be able to support adding additional structures to the index after
   deserialization, export compression should be avoided, otherwise significant matched pairs may be missed.
   To *enable* export compression (by default, *disabled*), see the following:

   .. oe:source:: SerializeIndex.cpp
      :language: c++
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-EXPORT-COMPRESS-MMP

   .. oe:source:: SerializeIndex.cpp
      :language: c++
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-EXPORT-COMPRESS-OPTS

   .. oe:source:: SerializeIndex.py
      :language: python
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-EXPORT-COMPRESS-MMP

   .. oe:source:: SerializeIndex.py
      :language: python
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-EXPORT-COMPRESS-OPTS

   .. oe:source:: SerializeIndex.java
      :language: java
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-EXPORT-COMPRESS-MMP

   .. oe:source:: SerializeIndex.java
      :language: java
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-EXPORT-COMPRESS-OPTS

   .. oe:source:: SerializeIndex.cs
      :language: csharp
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-EXPORT-COMPRESS-MMP

   .. oe:source:: SerializeIndex.cs
      :language: csharp
      :frag:     SNIPPET-MATCHEDPAIRANALYZER-EXPORT-COMPRESS-OPTS

   .. seealso::

      * :oe:func:`OEMedChem::OEIsWriteableMatchedPairAnalyzer`
      * :oe:func:`OEMedChem::OEReadMatchedPairAnalyzer`



===
API
===

.. _oemedchem_part_api:

********************************
OEMedChem API
********************************

.. toctree::
   :maxdepth: 2

   OEMedChemClasses/OEMedChemClasses
   OEMedChemConstants/OEMedChemConstants
   OEMedChemFunctions/OEMedChemFunctions



.. _oemedchem_part_examples:

********************************
Examples
********************************

.. toctree::
   :maxdepth: 2

   examples_summary



.. _oemedchem_chapter_examples:

*************************
OEMedChem TK Examples
*************************

The following table lists the currently available **OEMedChem TK** examples:

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`OEMedChemInfo<oemedchem_examples_oemedcheminfo>`
        - Print library version information
      * - :ref:`BemisMurckoPerception<oemedchem_examples_bemismurckoperception>`
        - Bemis-Murcko region perception
      * - :ref:`ChEMBLsolubility<oemedchem_examples_chemblsolubility>`
        - Apply solubility transformations found from ChEMBL structures
      * - :ref:`CreateMMPIndex<oemedchem_examples_createmmpindex>`
        - Generation of an MMP index from a Matched Pair analysis
      * - :ref:`CreateMMPIndexParallel<oemedchem_examples_createmmpindexparallel>`
        - Multi-process generation of an MMP index from a Matched Pair analysis
      * - :ref:`CreateMMPIndexThreaded<oemedchem_examples_createmmpindexthreaded>`
        - Multi-threaded generation of an MMP index from a Matched Pair analysis
      * - :ref:`MatchedPairTransform<oemedchem_examples_matchedpairtransform>`
        - Load a Matched Pair index and apply transformations
      * - :ref:`MatchedPairTransformList<oemedchem_examples_matchedpairtransformlist>`
        - Load a Matched Pair index and list of transformations
      * - :ref:`MatchedPairTransformProbe<oemedchem_examples_matchedpairtransformprobe>`
        - Load a Matched Pair index and list of transformations related to a probe structure
      * - :ref:`CreateMCSFragDatabase<oemedchem_examples_createmcsfragdatabase>`
        - Generation of an MCS fragment index from an MCS fragmentation analysis
      * - :ref:`MCSFragDatabase<oemedchem_examples_mcsfragdatabase>`
        - Load an MCS fragment index and report similarity scores for probe structures
      * - :ref:`MCSFragOccurrence<oemedchem_examples_mcsfragoccurrence>`
        - Load an MCS fragment index and report occurrence counts for common fragments

.. oe:language:: c++ java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`OEMedChemInfo<oemedchem_examples_oemedcheminfo>`
        - Print library version information
      * - :ref:`BemisMurckoPerception<oemedchem_examples_bemismurckoperception>`
        - Bemis-Murcko region perception
      * - :ref:`ChEMBLsolubility<oemedchem_examples_chemblsolubility>`
        - Apply solubility transformations found from ChEMBL structures
      * - :ref:`CreateMMPIndex<oemedchem_examples_createmmpindex>`
        - Generation of an MMP index from a Matched Pair analysis
      * - :ref:`CreateMMPIndexThreaded<oemedchem_examples_createmmpindexthreaded>`
        - Multi-threaded generation of an MMP index from a Matched Pair analysis
      * - :ref:`MatchedPairTransform<oemedchem_examples_matchedpairtransform>`
        - Load a Matched Pair index and apply transformations
      * - :ref:`MatchedPairTransformList<oemedchem_examples_matchedpairtransformlist>`
        - Load a Matched Pair index and list of transformations
      * - :ref:`MatchedPairTransformProbe<oemedchem_examples_matchedpairtransformprobe>`
        - Load a Matched Pair index and list of transformations related to a probe structure
      * - :ref:`CreateMCSFragDatabase<oemedchem_examples_createmcsfragdatabase>`
        - Generation of an MCS fragment index from an MCS fragmentation analysis
      * - :ref:`MCSFragDatabase<oemedchem_examples_mcsfragdatabase>`
        - Load an MCS fragment index and report similarity scores for probe structures
      * - :ref:`MCSFragOccurrence<oemedchem_examples_mcsfragoccurrence>`
        - Load an MCS fragment index and report occurrence counts for common fragments

**Examples:**

.. toctree::
   :maxdepth: 1

   examples_bemismurckoperception
   examples_chemblsolubility
   examples_createmmpindex
   examples_createmmpindexparallel
   examples_createmmpindexthreaded
   examples_matchedpairtransform
   examples_matchedpairtransformlist
   examples_matchedpairtransformprobe
   examples_createmcsfragdatabase
   examples_mcsfragdatabase
   examples_mcsfragoccurrence
   examples_oemedcheminfo


.. _oemedchem_examples_bemismurckoperception:

Bemis Murcko perception
================================================================================
A program that perceives the [Bemis-1996]_ regions of the input structures
and outputs role information and annotations as SD data in the output.
Uncoloring of the fragment regions to remove atom types and properties
can optionally be requested for the output SMILES string annotations.

.. seealso::

   * :oe:func:`OEMedChem::OEGetBemisMurcko` function

Command Line Interface
----------------------

.. code-block:: console

   Usage: ./BemisMurckoPerception input.sdf output.sdf [ -uncolor ] [-unsaturatedHeteroBonds] [ -smartsSubstituents substituentsString ]
   [-regionType regionTypeString]

Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`BemisMurckoPerception.cpp <../../../../sublibs/tklibs/medchem/examples/BemisMurckoPerception.cpp>`

   .. only:: oepdf

      .. oe:source:: BemisMurckoPerception.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`BemisMurckoPerception.py <../../../../wrappers/python/examples/medchem/BemisMurckoPerception.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/medchem/BemisMurckoPerception.py

   .. only:: oepdf

      .. oe:source:: BemisMurckoPerception.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`BemisMurckoPerception.java <../../../../wrappers/java/examples/openeye/examples/oemedchem/BemisMurckoPerception.java>`

   .. only:: oepdf

      .. oe:source:: BemisMurckoPerception.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`BemisMurckoPerception.cs <../../../../wrappers/csharp/Csharp-Examples/OEMedChem/BemisMurckoPerception.cs>`

   .. only:: oepdf

      .. oe:source:: BemisMurckoPerception.cs
         :language: csharp



.. _oemedchem_examples_chemblsolubility:

Apply ChEMBL solubility transformations
================================================================================
A utility that reads an input set of structures and outputs
transformed structures along with annotations containing of the original data
based on the matched pairs discovered from indexing solubility data from the
[ChEMBL24-2018]_ data set.

.. seealso::

   * :oe:func:`OEMedChem::OEApplyChEMBL24SolubilityTransforms` function

Command Line Interface
----------------------
.. oe:language:: c++

   .. code-block:: console

      prompt> ChEMBLsolubility input.sdf output.sdf

.. oe:language:: python

   .. code-block:: console

      prompt> ChEMBLsolubility.py input.sdf output.sdf

.. oe:language:: java

   .. code-block:: console

      prompt> ChEMBLsolubility input.sdf output.sdf

.. oe:language:: csharp

   .. code-block:: console

      prompt> ChEMBLsolubility input.sdf output.sdf

Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ChEMBLsolubility.cpp <../../../../sublibs/tklibs/medchem/examples/ChEMBLsolubility.cpp>`

   .. only:: oepdf

      .. oe:source:: ChEMBLsolubility.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ChEMBLsolubility.py <../../../../wrappers/python/examples/medchem/ChEMBLsolubility.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/medchem/ChEMBLsolubility.py

   .. only:: oepdf

      .. oe:source:: ChEMBLsolubility.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ChEMBLsolubility.java <../../../../wrappers/java/examples/openeye/examples/oemedchem/ChEMBLsolubility.java>`

   .. only:: oepdf

      .. oe:source:: ChEMBLsolubility.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ChEMBLsolubility.cs <../../../../wrappers/csharp/Csharp-Examples/OEMedChem/ChEMBLsolubility.cs>`

   .. only:: oepdf

      .. oe:source:: ChEMBLsolubility.cs
         :language: csharp



.. _oemedchem_examples_createmmpindex:

Matched Pair analysis generation of a MMP index
================================================================================

A program that performs a matched pair analysis of a set of structures for
indexing and saves the generated index file for subsequent loading and querying.

.. figure:: medchemtk/images/searchmmp.*
   :align:  center
   :width:  400pt

   **Schematic representation of the Matched Pair Analysis process**

.. seealso::

   * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` class
   * :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` class
   * :oe:func:`OEMedChem::OEMatchedPairApplyTransforms` function

Command Line Interface
----------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> CreateMMPIndex index.sdf output.mmpidx

.. oe:language:: python

   .. code-block:: console

      prompt> CreateMMPIndex.py index.sdf output.mmpidx

.. oe:language:: java

   .. code-block:: console

      prompt> CreateMMPIndex index.sdf output.mmpidx

.. oe:language:: csharp

   .. code-block:: console

      prompt> CreateMMPIndex index.sdf output.mmpidx

Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateMMPIndex.cpp <../../../../sublibs/tklibs/medchem/examples/CreateMMPIndex.cpp>`

   .. only:: oepdf

      .. oe:source:: CreateMMPIndex.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateMMPIndex.py <../../../../wrappers/python/examples/medchem/CreateMMPIndex.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/medchem/CreateMMPIndex.py

   .. only:: oepdf

      .. oe:source:: CreateMMPIndex.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateMMPIndex.java <../../../../wrappers/java/examples/openeye/examples/oemedchem/CreateMMPIndex.java>`

   .. only:: oepdf

      .. oe:source:: CreateMMPIndex.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateMMPIndex.cs <../../../../wrappers/csharp/Csharp-Examples/OEMedChem/CreateMMPIndex.cs>`

   .. only:: oepdf

      .. oe:source:: CreateMMPIndex.cs
         :language: csharp


.. _oemedchem_examples_createmmpindexparallel:

Matched Pair analysis using a multi-process generation of an MMP index
================================================================================

.. oe:language:: c++

   A program that performs a multi-process matched pair analysis of a set of structures for
   indexing is available as a python-only utility.

.. oe:language:: java

   A program that performs a multi-process matched pair analysis of a set of structures for
   indexing is available as a python-only utility.

.. oe:language:: csharp

   A program that performs a multi-process matched pair analysis of a set of structures for
   indexing is available as a python-only utility.

.. oe:language:: python

   A program that performs a multi-process matched pair analysis of a set of structures for
   indexing and saves the generated index file for subsequent loading and querying.
   This example uses the python `multiprocessing <https://docs.python.org/3/library/multiprocessing.html>`_ module.

   .. figure:: medchemtk/images/searchmmp.*
      :align:  center
      :width:  400pt

      **Schematic representation of the Matched Pair Analysis process**

   .. seealso::

      * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` class
      * :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` class
      * :oe:func:`OEMedChem::OEMatchedPairApplyTransforms` function

Command Line Interface
----------------------

..  code-block:: console

    prompt> CreateMMPIndexParallel.py [ -pool num_processes ] index.sdf output.mmpidx

Code
----

..  oe:language:: python

    .. only:: oehtml

    ..  admonition:: Download code

        :download:`CreateMMPIndexParallel.py <../../../../wrappers/python/examples/medchem/CreateMMPIndexParallel.py>`

    ..  literalinclude:: ../../../wrappers/python/examples/medchem/CreateMMPIndexParallel.py

..  only:: oepdf

    ..  oe:source:: CreateMMPIndexParallel.py
        :language: python



.. _oemedchem_examples_createmcsfragdatabase:

MCS Fragment database generation
================================================================================

A program that performs an MCS fragmentation analysis of a set of structures
and saves the generated index file for subsequent loading and querying.

.. figure:: medchemtk/images/searchmcsfrag.*
   :align:  center
   :width:  400pt

   **Schematic representation of the MCS fragment search process**

.. seealso::

   * :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` class
   * :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>` class

Command Line Interface
----------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> CreateMCSFragDatabase index.sdf output.mcsfrag

.. oe:language:: python

   .. code-block:: console

      prompt> CreateMCSFragDatabase.py index.sdf output.mcsfrag

.. oe:language:: java

   .. code-block:: console

      prompt> CreateMCSFragDatabase index.sdf output.mcsfrag

.. oe:language:: csharp

   .. code-block:: console

      prompt> CreateMCSFragDatabase index.sdf output.mcsfrag

Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateMCSFragDatabase.cpp <../../../../sublibs/tklibs/medchem/examples/CreateMCSFragDatabase.cpp>`

   .. only:: oepdf

      .. oe:source:: CreateMCSFragDatabase.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateMCSFragDatabase.py <../../../../wrappers/python/examples/medchem/CreateMCSFragDatabase.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/medchem/CreateMCSFragDatabase.py

   .. only:: oepdf

      .. oe:source:: CreateMCSFragDatabase.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateMCSFragDatabase.java <../../../../wrappers/java/examples/openeye/examples/oemedchem/CreateMCSFragDatabase.java>`

   .. only:: oepdf

      .. oe:source:: CreateMCSFragDatabase.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateMCSFragDatabase.cs <../../../../wrappers/csharp/Csharp-Examples/OEMedChem/CreateMCSFragDatabase.cs>`

   .. only:: oepdf

      .. oe:source:: CreateMCSFragDatabase.cs
         :language: csharp


.. _oemedchem_examples_createmmpindexthreaded:

Matched Pair analysis using a multi-threaded generation of a MMP index
================================================================================

A program that performs a multi-threaded matched pair analysis of a set of structures for
indexing and saves the generated index file for subsequent loading and querying.

.. figure:: medchemtk/images/searchmmp.*
   :align:  center
   :width:  400pt

   **Schematic representation of the Matched Pair Analysis process**

.. seealso::

   * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` class
   * :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` class
   * :oe:func:`OEMedChem::OEMatchedPairApplyTransforms` function

Command Line Interface
----------------------
.. oe:language:: c++

   .. code-block:: console

      prompt> CreateMMPIndexThreaded [ -threads num_threads ] index.sdf output.mmpidx

.. oe:language:: python

   .. code-block:: console

      prompt> CreateMMPIndexThreaded.py [ -threads num_threads ] index.sdf output.mmpidx

.. oe:language:: java

   .. code-block:: console

      prompt> CreateMMPIndexThreaded [ -threads num_threads ] index.sdf output.mmpidx

.. oe:language:: csharp

   .. code-block:: console

      prompt> CreateMMPIndexThreaded [ -threads num_threads ] index.sdf output.mmpidx

Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateMMPIndexThreaded.cpp <../../../../sublibs/tklibs/medchem/examples/CreateMMPIndexThreaded.cpp>`

   .. only:: oepdf

      .. oe:source:: CreateMMPIndexThreaded.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateMMPIndexThreaded.py <../../../../wrappers/python/examples/medchem/CreateMMPIndexThreaded.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/medchem/CreateMMPIndexThreaded.py

   .. only:: oepdf

      .. oe:source:: CreateMMPIndexThreaded.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateMMPIndexThreaded.java <../../../../wrappers/java/examples/openeye/examples/oemedchem/CreateMMPIndexThreaded.java>`

   .. only:: oepdf

      .. oe:source:: CreateMMPIndexThreaded.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateMMPIndexThreaded.cs <../../../../wrappers/csharp/Csharp-Examples/OEMedChem/CreateMMPIndexThreaded.cs>`

   .. only:: oepdf

      .. oe:source:: CreateMMPIndexThreaded.cs
         :language: csharp


.. _oemedchem_examples_matchedpairtransform:

Matched Pair analysis and transformations
================================================================================

A program that loads a previously generated Matched Pair index, then reads
an input set of structures and outputs transformed structures based on the matched pairs discovered during indexing.

.. figure:: medchemtk/images/searchmmp.*
   :align:  center
   :width:  400pt

   **Schematic representation of the Matched Pair Analysis process**

.. seealso::

   * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` class
   * :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` class
   * :oe:func:`OEMedChem::OEMatchedPairApplyTransforms` function

Command Line Interface
----------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> MatchedPairTransform -mmpidx index.mmpidx -input input.sdf -output output.sdf

.. oe:language:: python

   .. code-block:: console

      prompt> MatchedPairTransform.py -mmpidx index.mmpidx -input input.sdf -output output.sdf

.. oe:language:: java

   .. code-block:: console

      prompt> MatchedPairTransform -mmpidx index.mmpidx -input input.sdf -output output.sdf

.. oe:language:: csharp

   .. code-block:: console

      prompt> MatchedPairTransform -mmpidx index.mmpidx -input input.sdf -output output.sdf

Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MatchedPairTransform.cpp <../../../../sublibs/tklibs/medchem/examples/MatchedPairTransform.cpp>`

   .. only:: oepdf

      .. oe:source:: MatchedPairTransform.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MatchedPairTransform.py <../../../../wrappers/python/examples/medchem/MatchedPairTransform.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/medchem/MatchedPairTransform.py

   .. only:: oepdf

      .. oe:source:: MatchedPairTransform.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MatchedPairTransform.java <../../../../wrappers/java/examples/openeye/examples/oemedchem/MatchedPairTransform.java>`

   .. only:: oepdf

      .. oe:source:: MatchedPairTransform.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MatchedPairTransform.cs <../../../../wrappers/csharp/Csharp-Examples/OEMedChem/MatchedPairTransform.cs>`

   .. only:: oepdf

      .. oe:source:: MatchedPairTransform.cs
         :language: csharp


.. _oemedchem_examples_matchedpairtransformlist:

Matched Pair analysis and listing of transformations
================================================================================

A program that loads a previously generated Matched Pair index, then
prints the transformations and matched pairs found from the analysis.
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> MatchedPairTransformList -mmpindex index.mmpidx [ -datafield sdDataField ]

.. oe:language:: python

   .. code-block:: console

      prompt> MatchedPairTransformList.py -mmpindex index.mmpidx [ -datafield sdDataField ]

.. oe:language:: java

   .. code-block:: console

      prompt> MatchedPairTransformList -mmpindex index.mmpidx [ -datafield sdDataField ]

.. oe:language:: csharp

   .. code-block:: console

      prompt> MatchedPairTransformList -mmpindex index.mmpidx [ -datafield sdDataField ]

Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MatchedPairTransformList.cpp <../../../../sublibs/tklibs/medchem/examples/MatchedPairTransformList.cpp>`

   .. only:: oepdf

      .. oe:source:: MatchedPairTransformList.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MatchedPairTransformList.py <../../../../wrappers/python/examples/medchem/MatchedPairTransformList.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/medchem/MatchedPairTransformList.py

   .. only:: oepdf

      .. oe:source:: MatchedPairTransformList.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MatchedPairTransformList.java <../../../../wrappers/java/examples/openeye/examples/oemedchem/MatchedPairTransformList.java>`

   .. only:: oepdf

      .. oe:source:: MatchedPairTransformList.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MatchedPairTransformList.cs <../../../../wrappers/csharp/Csharp-Examples/OEMedChem/MatchedPairTransformList.cs>`

   .. only:: oepdf

      .. oe:source:: MatchedPairTransformList.cs
         :language: csharp



.. _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



.. _oemedchem_examples_mcsfragdatabase:

MCS Similarity score reporting
================================================================================

A program that loads a previously generated MCS fragment database, then returns the highest
Maximum Common Substructure (Tanimoto) scores from the provided input query structures.

.. figure:: medchemtk/images/searchmcsfrag.*
   :align:  center
   :width:  400pt

   **Schematic representation of the MCS fragment index and search process**

.. seealso::

   * :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` class
   * :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>` class

Command Line Interface
----------------------
.. oe:language:: c++

   .. code-block:: console

      prompt> MCSFragDatabase -indb index.mcsfrag -query queries.sdf

.. oe:language:: python

   .. code-block:: console

      prompt> MCSFragDatabase.py -indb index.mcsfrag -query queries.sdf

.. oe:language:: java

   .. code-block:: console

      prompt> MCSFragDatabase -indb index.mcsfrag -query queries.sdf

.. oe:language:: csharp

   .. code-block:: console

      prompt> MCSFragDatabase -indb index.mcsfrag -query queries.sdf

Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MCSFragDatabase.cpp <../../../../sublibs/tklibs/medchem/examples/MCSFragDatabase.cpp>`

   .. only:: oepdf

      .. oe:source:: MCSFragDatabase.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MCSFragDatabase.py <../../../../wrappers/python/examples/medchem/MCSFragDatabase.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/medchem/MCSFragDatabase.py

   .. only:: oepdf

      .. oe:source:: MCSFragDatabase.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MCSFragDatabase.java <../../../../wrappers/java/examples/openeye/examples/oemedchem/MCSFragDatabase.java>`

   .. only:: oepdf

      .. oe:source:: MCSFragDatabase.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MCSFragDatabase.cs <../../../../wrappers/csharp/Csharp-Examples/OEMedChem/MCSFragDatabase.cs>`

   .. only:: oepdf

      .. oe:source:: MCSFragDatabase.cs
         :language: csharp



.. _oemedchem_examples_mcsfragoccurrence:

MCS Fragmentation API
================================================================================

A program that loads a previously generated MCS fragment database, then reports the
most common fragments identified by fragmentation from the input structure(s).

.. seealso::

   * :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` class
   * :oe:meth:`OEMedChem::OEMCSFragDatabase::MoleculeToCores`
   * :oe:meth:`OEMedChem::OEMCSFragDatabase::CoreToMolecules`
   * :oe:meth:`OEMedChem::OEMCSFragDatabase::CoreToMoleculeCount`
   * :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>` class

Command Line Interface
----------------------
.. oe:language:: c++

   .. code-block:: console

      prompt> MCSFragOccurrence -indb index.mcsfrag -query queries.sdf

.. oe:language:: python

   .. code-block:: console

      prompt> MCSFragOccurrence.py -indb index.mcsfrag -query queries.sdf

.. oe:language:: java

   .. code-block:: console

      prompt> MCSFragOccurrence -indb index.mcsfrag -query queries.sdf

.. oe:language:: csharp

   .. code-block:: console

      prompt> MCSFragOccurrence -indb index.mcsfrag -query queries.sdf

Code
----------------------

..
   .. oe:language:: c++

      .. only:: oehtml

   .. admonition:: Download code

      :download:`MCSFragOccurrence.cpp <../../../../sublibs/tklibs/medchem/examples/MCSFragOccurrence.cpp>`

      .. only:: oepdf

   .. oe:source:: MCSFragOccurrence.cpp
      :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MCSFragOccurrence.py <../../../../wrappers/python/examples/medchem/MCSFragOccurrence.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/medchem/MCSFragOccurrence.py

   .. only:: oepdf

      .. oe:source:: MCSFragOccurrence.py
         :language: python

..
   .. oe:language:: java

      .. only:: oehtml

    .. admonition:: Download code

       :download:`MCSFragOccurrence.java <../../../../wrappers/java/examples/openeye/examples/oemedchem/MCSFragOccurrence.java>`

      .. only:: oepdf

      .. oe:source:: MCSFragOccurrence.java
         :language: java

..
   .. oe:language:: csharp

      .. only:: oehtml

      .. admonition:: Download code

         :download:`MCSFragOccurrence.cs <../../../../wrappers/csharp/Csharp-Examples/OEMedChem/MCSFragOccurrence.cs>`

      .. only:: oepdf

     .. oe:source:: MCSFragOccurrence.cs
        :language: csharp


.. _oemedchem_examples_oemedcheminfo:

Print OEMedChem version information
================================================================================

A utility to print library version information

.. seealso::

   * :oe:func:`OEMedChem::OEMedChemGetRelease` function
   * :oe:func:`OEMedChem::OEMedChemGetVersion` function
   * :oe:func:`OEMedChem::OEMedChemGetArch` function
   * :oe:func:`OEMedChem::OEMedChemGetPlatform` function

Command Line Interface
----------------------

This simple example reports library version information

.. oe:language:: c++

   .. code-block:: console

      prompt> OEMedChemInfo

.. oe:language:: python

   .. code-block:: console

      prompt> OEMedChemInfo.py

.. oe:language:: java

   .. code-block:: console

      prompt> OEMedChemInfo

.. oe:language:: csharp

   .. code-block:: console

      prompt> OEMedChemInfo

Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`OEMedChemInfo.cpp <../../../../sublibs/tklibs/medchem/examples/OEMedChemInfo.cpp>`

   .. only:: oepdf

      .. oe:source:: OEMedChemInfo.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`OEMedChemInfo.py <../../../../wrappers/python/examples/medchem/OEMedChemInfo.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/medchem/OEMedChemInfo.py

   .. only:: oepdf

      .. oe:source:: OEMedChemInfo.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`OEMedChemInfo.java <../../../../wrappers/java/examples/openeye/examples/oemedchem/OEMedChemInfo.java>`

   .. only:: oepdf

      .. oe:source:: OEMedChemInfo.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`OEMedChemInfo.cs <../../../../wrappers/csharp/Csharp-Examples/OEMedChem/OEMedChemInfo.cs>`

   .. only:: oepdf

      .. oe:source:: OEMedChemInfo.cs
         :language: csharp



.. _chapter_fragmentation:

********************************************************************************
Molecule Fragmentation
********************************************************************************

The *OEMedChem TK* currently provides four ways to partition a molecule
into fragments:

* :oe:func:`OEMedChem::OEGetRingChainFragments` -
  fragments a molecule into ring and chain components.

* :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments` -
  fragments a molecule into ring, linker and side-chain components as defined
  in [Bemis-1996]_ .

* :oe:func:`OEMedChem::OEGetFuncGroupFragments` - fragments a molecule into ring
  and functional group components.

* :oe:func:`OEMedChem::OEGetBemisMurcko` - fragments a molecule into ring, linker,
  framework and functional group components as in [Bemis-1996]_ .

These functions return an iterator over :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` objects
that store the atoms and the bonds of the fragments.

.. _section_example_fragringchain:

The following examples (:oe:src:`Listing 1<FragRingChain>`, :oe:src:`Listing 2<OEGetBemisMurcko>`) show how to
fragment a molecule into ring and chain components.
The code loops over the :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` objects
returned by the :oe:func:`OEMedChem::OEGetRingChainFragments`.
Each :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` object is used to initialize an atom
and a bond predicates. These predicates specify which atoms and bonds have to be
considered when creating a subset of the molecule, *i.e* the fragment, when
calling the :oe:func:`OEChem::OESubsetMol` function.
See the depiction of the input molecule and the generated fragments
in :ref:`Figure: Example of fragmentation <figure_Fragmentation>`.

.. oe:source:: FragRingChain.py
   :language: python
   :refnum:   1
   :caption:  Example of molecule fragmentation.
   :frag:     SNIPPET

..	oe:language: python

	:ref:`Full listing. <listing-FragRingChain.py>'

.. oe:source:: FragRingChain.cpp
   :language: c++
   :refnum:   1
   :caption:  Example of molecule fragmentation
   :frag:     SNIPPET

.. oe:source:: FragRingChain.java
   :language: java
   :refnum:   1
   :caption:  Example of molecule fragmentation
   :frag:     SNIPPET

.. oe:source:: FragRingChain.cs
   :language: csharp
   :refnum:   1
   :caption:  Example of molecule fragmentation
   :frag:     SNIPPET

The output of :oe:src:`Listing 1<FragRingChain>` is the following:

::

   CO
   c1ccccc1
   CC(=O)N

.. _figure_Fragmentation:

.. figure:: medchemtk/images/Fragmentation.*
   :align:  center

   **Example of fragmentation** (A) input molecule
   (B) fragments returned by the OEGetRingChainFragments function

.. seealso::

   * :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` class and :oe:func:`OEChem::OESubsetMol` function in the *OEChem TK* manual
   * :ref:`chapter_predicates` chapter in the *OEChem TK* manual.

.. _section_example_oegetbemismurcko:

The following example (:oe:src:`Listing 2<OEGetBemisMurcko>`) shows how to
fragment a molecule into ring and chain components with annotations.
See the depiction of the input molecule and the generated fragments
in :ref:`Figure: Example of Bemis Murcko fragmentation <figure_OEGetBemisMurcko>`.

.. oe:source:: OEGetBemisMurcko.py
   :language: python
   :refnum:   2
   :caption:  Example of molecule fragmentation with annotations.
   :frag:     SNIPPET

..	oe:language: python

	:ref:`Full listing. <listing-OEGetBemisMurcko.py>'

.. oe:source:: OEGetBemisMurcko.cpp
   :language: c++
   :refnum:   2
   :caption:  Example of molecule fragmentation with annotations
   :frag:     SNIPPET

.. oe:source:: OEGetBemisMurcko.java
   :language: java
   :refnum:   2
   :caption:  Example of molecule fragmentation with annotations
   :frag:     SNIPPET

.. oe:source:: OEGetBemisMurcko.cs
   :language: csharp
   :refnum:   2
   :caption:  Example of molecule fragmentation with annotations
   :frag:     SNIPPET

The output of :oe:src:`Listing 2<OEGetBemisMurcko>` is the following:

::

   Framework c1ccc(cc1)CCc2ccccc2
   Ring c1ccccc1.c1ccccc1
   Linker CC
   Sidechain CCO.CC(=O)N.CO

.. _figure_OEGetBemisMurcko:

.. figure:: medchemtk/images/OEGetBemisMurcko.*
   :align:  center

   **Example of Bemis Murcko fragmentation**

.. _section_example_oegetbemismurckounsatheterobonds:

The following example (:oe:src:`Listing 3<OEGetBemisMurckoUnsatHeteroBonds>`) shows how to
fragment a molecule and include unsaturated hetero bonds on the main framework.
See the depiction of the input molecule and the generated fragments
in :ref:`Figure: Example of custom Bemis Murcko fragmentation including heteroatoms <figure_OEGetBemisMurckoUnsatHeteroBonds>`.

.. oe:source:: OEGetBemisMurckoUnsatHeteroBonds.py
   :language: python
   :refnum:   3
   :caption:  Example of custom molecule fragmentation.
   :frag:     SNIPPET

..	oe:language: python

	:ref:`Full listing. <listing-OEGetBemisMurckoUnsatHeteroBonds.py>'

.. oe:source:: OEGetBemisMurckoUnsatHeteroBonds.cpp
   :language: c++
   :refnum:   3
   :caption:  Example of custom molecule fragmentation.
   :frag:     SNIPPET

.. oe:source:: OEGetBemisMurckoUnsatHeteroBonds.java
   :language: java
   :refnum:   3
   :caption:  Example of custom molecule fragmentation
   :frag:     SNIPPET

.. oe:source:: OEGetBemisMurckoUnsatHeteroBonds.cs
   :language: csharp
   :refnum:   3
   :caption:  Example of custom molecule fragmentation
   :frag:     SNIPPET

The output of :oe:src:`Listing 3<OEGetBemisMurckoUnsatHeteroBonds>` is the following:

::

   Framework c1ccc(cc1)S(=O)(=O)NC(=O)Nc2ncncn2
   Ring c1ccccc1.c1ncncn1
   Linker C(=O)(N)NS(=O)=O
   Sidechain CC.CO.CO

.. _figure_OEGetBemisMurckoUnsatHeteroBonds:

.. figure:: medchemtk/images/OEGetBemisMurckoUnsatHetero.*
   :align:  center

   **Example of Bemis Murcko fragmentation including unsaturated hetero bonds on main framework.**

.. _section_example_oegetbemismurckocustomsubstituents:

The following example (:oe:src:`Listing 4<OEGetBemisMurckoCustomSubstituents>`) shows how to
fragment a molecule and include custom sidechains on the main framework.
See the depiction of the input molecule and the generated fragments
in :ref:`Figure: Example of custom Bemis Murcko fragmentation including custom substituents <figure_OEGetBemisMurckoCustomSubstituents>`.

.. oe:source:: OEGetBemisMurckoCustomSubstituents.py
   :language: python
   :refnum:   4
   :caption:  Example of custom molecule fragmentation 
   :frag:     SNIPPET

..	oe:language: python

	:ref:`Full listing. <listing-OEGetBemisMurckoCustomSubstituents.py>'

.. oe:source:: OEGetBemisMurckoCustomSubstituents.cpp
   :language: c++
   :refnum:   4
   :caption:  Example of custom molecule fragmentation
   :frag:     SNIPPET

.. oe:source:: OEGetBemisMurckoCustomSubstituents.java
   :language: java
   :refnum:   4
   :caption:  Example of custom molecule fragmentation
   :frag:     SNIPPET

.. oe:source:: OEGetBemisMurckoCustomSubstituents.cs
   :language: csharp
   :refnum:   4
   :caption:  Example of custom molecule fragmentation
   :frag:     SNIPPET

The output of :oe:src:`Listing 4<OEGetBemisMurckoCustomSubstituents>` is the following:

::

   Framework c1ccc(c(c1)CC(=O)N)[SH4]NC(CC(=O)N)Nc2ncncn2
   Ring c1ccc(cc1)CC(=O)N.c1ncncn1
   Linker C(C(N)N[SH5])C(=O)N
   Sidechain CC.CO.O.O

.. _figure_OEGetBemisMurckoCustomSubstituents:

.. figure:: medchemtk/images/OEGetBemisMurckoCustomSubsearch.*
   :align:  center

   **Example of Bemis Murcko fragmentation including custom substituents on framework**



.. _chapter_matchedpairanalysis:

********************************************************************************
Matched Molecule Pair Analysis
********************************************************************************

This overview is intended for users which have a working knowledge of
matched pair analysis in the context of medicinal chemistry workflows.
If the concept of matched pair analysis is unfamiliar, the
following references are highly recommended as background to this
powerful strategy ([Griffen-2011]_, [Kramer-2014]_,
[Papadatos-2010]_, [Warner-2010]_).

The *OEMedChem TK* provides the ability to index a set of input
structures and identify matched molecular pairs.  Matched Molecular
Pair Analysis (MMPA) is becoming recognized as a powerful tool for the
extraction of the effects of chemical changes on properties of
interest in large data sets.  One of the powers of the MMPA approach
stems from the assumption that it is easier to predict differences in
an activity or a property than to predict an actual value.  A matched
molecular pair is considered to be a pair of compounds that differ by
a small localized change in a chemical substituent.  The magnitude of
the localized change that is considered acceptable is highly specific
to the chemist or analyst.  For a given matched molecular pair, one
can consider the chemical difference between two compounds
to embody a virtual chemical transformation with an accompanying
change in a property of interest.  For a homologous series of input
structures, a set of matched molecular pairs for each transformation
can be identified and analyzed for statistical relevance, sorting
and/or ranking.  Similarly, large input data sets can be mined for
interesting or desired property changes as a function of structure.

A common method of identifying matched molecular pairs is an ``NxM``
pairwise maximum common subgraph (MCS) analysis of an input data set.
Owing to the complexity and performance of MCS algorithms generally,
*OpenEye* instead chose to use a molecular fragmentation approach
(cf [Hussain-2010]_) to identify matched molecular pairs and to deliver robust
performance characteristics over a wider variety of input data set
sizes.  Additionally, this approach is entirely data-driven and does
not require *a priori* defined cores.  A small set of fragmentation
strategies are currently provided, and future releases will expose
additional fragmentation types and capabilities.  MMPA as a technique
is relatively new and there have been spirited discussions about the
applicability of the method when applied to various measured
properties.  *OpenEye* encourages users to critically examine the
results available from such an analysis and to evaluate the
applicability or non-applicability of property predictions with
sound statistical analyses.

The general steps involved in an MMP analysis are,

* Prepare the input structures
* Prune input structure data to the property or properties of interest
* Select indexing filters to identify the desired "localized change" in structures
* Index the input structures
* Extract transformations and/or matched molecular pairs and data
* Optionally save the index for subsequent analyses

The internal index captures the common cores for the identified
matched molecular pairs and the set of substituent changes associated
with each core.  Once the index has been generated, it can be used to,

* Extract the virtual chemical transformations and set of delta properties for the MMPs
* Extract the MCS cores of MMPs for clique or binning analysis
* Extract statistics for property changes from a series of substituents on a common core
* Identify or remove singletons or unrelated chemical frameworks from the input structures

Matched molecular pair transformations inherently have the concept of
a chemical context for any given set of matched pairs.  At the site
(or sites) of the substituent differences in the two compounds one
can consider the accompanying effects of the adjacent common core
environment for the pair.  To this end, the extraction of the matched
pair transformations supports the ability to tune the amount of the
adjacent common core to be included as part of the transformation.  As
more chemical context is included, more differentiation among the set
of transformations occurs, generally resulting in fewer numbers of
matched molecular pairs associated with each transformation.  Thus,
requesting a :oe:const:`OEMedChem::OEMatchedPairContext::Bond0`
context when extracting transformations from an index is likely to
produce the largest set of matched pairs associated with each
transform, but at the expense of coalescing possibly unrelated
chemical environments into the same transformation bin.  That is, a
``Cl>>Br`` transformation on a ring or aromatic ring is likely quite
different compared to the same transformation in a non-ring portion of
the structure with regards to the properties of interest for an MMP
analysis.

The :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` is the utility class
the provides the bulk of the Matched Pair Analysis capabilities
in *OEMedChem TK*, see docs for additional details.

Introductory Usage of Matched Molecular Pair Analysis
================================================================================

As a trivial example, suppose a chemist is interested in extracting
all the "simple" substituent changes in a large input set.  One
possible way to accomplish this is to define some limits to what
constitutes a "simple" substituent change and run an MMP analysis of
the input structures.  Here we define a "simple" substituent change to
be singly attached groups only, and where the size of the group cannot
exceed 20% of the input structure heavy atom count.

   .. oe:source:: FindSimpleMatchedPairs.cpp
      :language: c++
      :frag:     SNIPPET-FINDSIMPLEMATCHEDPAIRS-EXAMPLE

   .. oe:source:: FindSimpleMatchedPairs.py
      :language: python
      :frag:     SNIPPET-FINDSIMPLEMATCHEDPAIRS-EXAMPLE

   ..	oe:language: python

        :ref:`Full listing. <listing-FindSimpleMatchedPairs.py>'

   .. oe:source:: FindSimpleMatchedPairs.java
      :language: java
      :frag:     SNIPPET-FINDSIMPLEMATCHEDPAIRS-EXAMPLE

   .. oe:source:: FindSimpleMatchedPairs.cs
      :language: csharp
      :frag:     SNIPPET-FINDSIMPLEMATCHEDPAIRS-EXAMPLE

Sample output of the example above is the following:

::

   Index complete, matched pairs = 146
    1 [c:1]Br>>[c:1]F
     matched pair molecule indices=(4793,1225)
     matched pair molecule indices=(1304,9796)
     matched pair molecule indices=(9515,6129)
     matched pair molecule indices=(4201,2611)
    2 [c:1]Br>>[c:1]OCC
     matched pair molecule indices=(7846,9727)
     matched pair molecule indices=(1547,2939)
     matched pair molecule indices=(5128,8928)
    3 [c:1]Cl>>[c:1]F
     matched pair molecule indices=(8116,7661)
     matched pair molecule indices=(239,6631)
     matched pair molecule indices=(9225,8434)
    4 [c:1]F>>[c:1]OC
     matched pair molecule indices=(3862,8684)
     matched pair molecule indices=(1349,1434)
     matched pair molecule indices=(416,3900)
    5 [c:1]Br>>[c:1]SC
     matched pair molecule indices=(6364,8527)
     matched pair molecule indices=(1999,6845)
    6 [c:1]C#N>>[c:1]F
     matched pair molecule indices=(2760,5231)
     matched pair molecule indices=(6677,241)
    7 [c:1]C>>[c:1]Cl
     matched pair molecule indices=(1191,1605)
     matched pair molecule indices=(9591,4139)
    8 [c:1]F>>[c:1]N(C)C
     matched pair molecule indices=(4012,853)
     matched pair molecule indices=(1779,1233)
    9 [C:1]C>>[C:1]O
     matched pair molecule indices=(2072,3429)
   10 [C:1]C>>[C:1]OCC
     matched pair molecule indices=(9803,9538)
   ...


.. _oemedchem_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version1_2_6
   version1_2_5
   version1_2_4
   version1_2_3
   version1_2_2
   version1_2_1
   version1_2_0
   version1_1_7
   version1_1_6
   version1_1_5
   version1_1_4
   version1_1_3
   version1_1_2
   version1_1_1
   version1_1_0
   version1_0_7
   version1_0_6
   version1_0_5
   version1_0_4
   version1_0_3
   version1_0_2
   version1_0_1
   version1_0_0
   version0_9_6
   version0_9_5
   version0_9_4
   version0_9_3
   version0_9_2
   version0_9_1
   version0_9_0



OEMedChem TK 1.2.6
================================================================================

New Features
--------------------------------------------------------------------------------

* A new overload of the :ref:`OECreateIDStrings<OEMedChem_OECreateIDStrings>` function
  has been added to enable speeding up **BROOD** hit list clustering when working
  with multiquery replacements.



.. _section_oemedchem_releasenotes_090:

OEMedChem TK 0.9.0
================================================================================

New features
--------------------------------------------------------------------------------

Providing the following fragmentation functions:

* :oe:func:`OEMedChem::OEGetRingChainFragments`
* :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments`
* :oe:func:`OEMedChem::OEGetFuncGroupFragments`



.. _section_oemedchem_releasenotes_091:

OEMedChem TK 0.9.1
================================================================================

New features
--------------------------------------------------------------------------------

* Several new experimental APIs added. These APIs are not officially
  supported yet and they will likely change in a future revision.



.. _section_oemedchem_releasenotes_092:

OEMedChem TK 0.9.2
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEMedChem::OEGetRingChainFragments`,
  :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments`,
  :oe:func:`OEMedChem::OEGetFuncGroupFragments` will now
  ``OEThrow.Error`` whenever the molecule passed in does not have
  ``RingAtomsAndBonds`` perceived.



.. _section_oemedchem_releasenotes_093:

OEMedChem TK 0.9.3
================================================================================

New features
--------------------------------------------------------------------------------

* New experimental classes and a new function for Matched Molecular
  Pair analysis were added. These APIs are experimental and they will
  likely change in future versions.

  - :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>`
  - :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>`
  - :oe:func:`OEMedChem::OEMatchedPairApplyTransforms`

* New functions were added to return type to name conversions for new parameterized constants.

  - :oe:func:`OEMedChem::OEMatchedPairContextName`
  - :oe:func:`OEMedChem::OEMatchedPairContextType`
  - :oe:func:`OEMedChem::OEMatchedPairProcessorName`
  - :oe:func:`OEMedChem::OEMatchedPairProcessorType`
  - :oe:func:`OEMedChem::OEMatchedPairOptionsName`
  - :oe:func:`OEMedChem::OEMatchedPairOptionsType`

* New functions were added to return information for belief theory usage based on [Muchmore-2008]_.

  - :oe:func:`OEMedChem::OECalculateComboBelief`
  - :oe:func:`OEMedChem::OECalculateETComboBelief`

* New functions were added based on the implementation in
  :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments` to return
  annotated Bemis Murcko regions and types from the perception as defined in [Bemis-1996]_ .

  - :oe:func:`OEMedChem::OEGetBemisMurcko`
  - :oe:func:`OEMedChem::OEGetRegionType`
  - :oe:func:`OEMedChem::OEGetRegionTypeName`

* New functions were added to return the graph-edit similarity used in clustering BROOD hitlists.

  - :oe:func:`OEMedChem::OECreateIDString`
  - :oe:func:`OEMedChem::OECreateIDStrings`

* New functions were added which return individual terms that make up the Molecular Complexity as defined by [Bertz-1981]_.

  - :oe:func:`OEMedChem::OEDetermineConnectiveComplexity`
  - :oe:func:`OEMedChem::OEDetermineElementalComplexity`
  - :oe:func:`OEMedChem::OEDetermineMolecularComplexity`
  - :oe:func:`OEMedChem::OEDetermineSymmetryComplexity`
  - :oe:func:`OEMedChem::OENormalMolecularComplexity`

* New functions were added for a ring complexity measure similar to that defined by [Gasteiger-1979]_.

  - :oe:func:`OEMedChem::OEDetermineRingComplexity`
  - :oe:func:`OEMedChem::OEGetRingValue`

* New functions were added which return a measure of stereo complexity as defined by [Boda-2007]_.

  - :oe:func:`OEMedChem::OEDetermineStereoComplexity`
  - :oe:func:`OEMedChem::OENormalStereoComplexity`

* A new function was added to return a measure of the total molecular complexity which is a sum of individual complexity measures above.

  - :oe:func:`OEMedChem::OETotalMolecularComplexity`

Known bugs
--------------------------------------------------------------------------------

* The beta Matched Pair analyzer api internally removes stereochemistry
  from the internally indexed structures. It should more properly treat the presence of
  stereochemistry for duplicate checking and indexing equivalently.  This issue
  will be repaired in the next release.

  - :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>`

Documentation fixes
--------------------------------------------------------------------------------

* Added documentation for

  - :oe:func:`OEMedChem::OEMedChemGetArch`
  - :oe:func:`OEMedChem::OEMedChemGetLicensee`
  - :oe:func:`OEMedChem::OEMedChemGetPlatform`
  - :oe:func:`OEMedChem::OEMedChemGetRelease`
  - :oe:func:`OEMedChem::OEMedChemGetSite`
  - :oe:func:`OEMedChem::OEMedChemGetVersion`
  - :oe:func:`OEMedChem::OEMedChemIsLicensed`



.. _section_oemedchem_releasenotes_094:

OEMedChem TK 0.9.4
================================================================================

Beta-API changes
--------------------------------------------------------------------------------
* The :oe:meth:`OEMedChem::OEMatchedPairAnalyzer::AddMol` return value
  has been changed. Negative return values no longer indicate a duplicate record ID
  in the index, but instead return various status values to indicate
  specific details of an indexing failure.

  .. note:: The interpretation of return values from this method in user-coded scripts may need to be altered.

New features
--------------------------------------------------------------------------------

* The indexing of structures now supports the specification
  of a zero or positive integer record ID to be used for referencing the input
  structures. This simplifies cross-referencing to externally maintained
  or managed data structures. For example, see changes to following:

  - :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>`
  - :oe:meth:`OEMedChem::OEMatchedPairAnalyzer::AddMol`
  - :oe:meth:`OEMedChem::OEMatchedPairAnalyzer::IsIndexed`
  - :oe:constns:`OEMedChem::OEMatchedPairIndexStatus`
  - :oe:func:`OEMedChem::OEMatchedPairIndexStatusName`
  - :oe:func:`OEMedChem::OEMatchedPairIndexStatusType`

* Prioritization of matched pair index nodes is now performed based on the
  size of the MCS for the indexed pair(s).  This results in a significant reduction
  of redundant and less interesting transformations extracted from the index.
  The ChEMBL solubility data was reanalyzed with this optimization and results in
  approximately 1/3 fewer (redundant) transformations to be applied via
  :oe:func:`OEMedChem::OEApplyChEMBL18SolubilityTransforms`.

* A function has been provided to allow extraction and inspection
  of transformations based on the matched molecular pairs found during
  indexing as well as the specific matched pairs and data associated with those
  transformations.  For example, see changes to the following:

  - :oe:func:`OEMedChem::OEMatchedPairGetTransforms`
  - :ref:`OEMatchedPairTransform <OEMedChem_OEMatchedPairTransform>`
  - :ref:`OEMatchedPair <OEMedChem_OEMatchedPair>`

* A new overload of :oe:func:`OEMedChem::OEMatchedPairGetTransforms` now provides the ability
  to retrieve related transformations and matched molecular pairs based on a
  probe molecule.  The probe molecule is fragmented based on the analyzer
  indexing strategy; matched pair index nodes that have common cores to
  the provided probe are used to retrieve related matched pair transformations.

Major bug fixes
--------------------------------------------------------------------------------

* Stereoisomers are now indexed properly by :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>`.
  Previously, stereoisomers were incorrectly considered duplicates and were rejected during indexing.

* The perceived regions from
  :oe:func:`OEMedChem::OEGetRingChainFragments` and
  :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments`
  are based on the heavy atoms in the molecule. If the molecule contains explicit
  hydrogen atoms, those atoms will be returned in the same perception set(s)
  as their alpha-heavy atom neighbors.  The documentation for these functions has been
  altered to reflect the new behavior as well as noting the requirement of
  the :oe:func:`OEChem::OEFindRingAtomsAndBonds` perception activity prior to use of these functions.

* A crash in :oe:func:`OEMedChem::OETotalMolecularComplexity` for highly bridged ring systems
  has been fixed. An issue that caused :oe:func:`OEMedChem::OEDetermineSymmetryComplexity` to
  crash when the required call to :oe:func:`OEChem::OEPerceiveChiral` had not
  been performed on the input molecule has also been fixed.

* The complexity computation functions have been altered to verify that the required perceptions
  have been performed.  Due to the ``const`` arguments to these functions, the perceptions cannot
  be performed internally and will now throw an error if the perception state is out of date
  for the provided input molecule. The functions affected are:

  * :oe:func:`OEMedChem::OEDetermineRingComplexity`
  * :oe:func:`OEMedChem::OEDetermineSymmetryComplexity`
  * :oe:func:`OEMedChem::OEDetermineStereoComplexity`
  * :oe:func:`OEMedChem::OENormalStereoComplexity`
  * :oe:func:`OEMedChem::OETotalMolecularComplexity`

Documentation fixes
--------------------------------------------------------------------------------

* New examples have been added to demonstrate the new API functions.

* New examples have been added for C++, Python, Java, and C#.

* Minor naming changes to constants for the beta matched pair API were made for consistency.

* Minor fixes have been made to the complexity function documentation to reflect the correct API points.



OEMedChem TK 0.9.5
================================================================================

New features
--------------------------------------------------------------------------------

* The matched pair analyzer now supports the identification of matched
  molecular pairs that differ by heavy-atom and hydrogen-atom substitutions.
  This additional indexing activity returns significantly more matched molecular
  pairs than the previous version.  The hydrogen-atom indexing activity has been enabled by default.
  To perform heavy-atom indexing only, remove the
  :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` option from
  :oe:const:`OEMedChem::OEMatchedPairOptions::Default` and set the desired
  option(s) explicitly via :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetOptions`.

* The matched pair analyzer now supports single bond insertion differences
  between matched molecular pairs.  Previously, a minimum change of 1-atom was
  identified in the substituent change between the matched pairs.

Beta-API changes
--------------------------------------------------------------------------------

* :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` is a new option that
  enables hydrogen-atom indexing support to the default indexing activities.

* :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::SuppressNodeSort`
  is a new option that suppresses the internal sorting of index nodes prior
  to extraction of transformations and matched pairs for debugging and
  analysis of indexing problems.

* :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::AddMCSCorrespondence` is a
  new extraction option that returns the maximum common substructure correspondence
  between the matched molecular pairs in the form of atom-mapping information applied
  to the MCS cores.

* :oe:const:`OEMedChem::OEMatchedPairTransformExtractMode::AddAttachmentPts` is a
  new extraction option that requests the addition of Rgroup attachment points
  on the returned matched molecular pair transforms.

Major bug fixes
--------------------------------------------------------------------------------

* A number of bugs related to the identification of the maximum common substructure
  for matched molecular pairs have been corrected.

* The `ChEMBL <https://www.ebi.ac.uk/chembl>`_ solubility data has been re-indexed to capture indexing fixes, potentially
  impacting the results returned from :oe:func:`OEMedChem::OEApplyChEMBL18SolubilityTransforms`.

* An internal index node sort now includes the number of fragmentation cuts in the
  sort criterion to preferentially return single > double > triple cuts for the
  largest maximum common substructures.

* A significant refactoring of internal activities has been performed to prepare for
  additional public API exposure in future versions.




OEMedChem TK 0.9.6
================================================================================

Beta-API changes
--------------------------------------------------------------------------------

* New functions have been added to support matched pair index serialization (see
  :oe:func:`OEMedChem::OEGetMatchedPairAnalyzerFileType`,
  :oe:func:`OEMedChem::OEIsReadableMatchedPairAnalyzer`,
  :oe:func:`OEMedChem::OEIsWriteableMatchedPairAnalyzer`,
  :oe:func:`OEMedChem::OEReadMatchedPairAnalyzer`,
  :oe:func:`OEMedChem::OEWriteMatchedPairAnalyzer`).

* A new option to remove unnecessary index node information during the
  index export activity is now available (see
  :oe:const:`OEMedChem::OEMatchedPairOptions::ExportCompression`).

* New methods have been added to the analyzer and option classes to allow
  altering options that do not invalidate an active index (see
  :oe:const:`OEMedChem::OEMatchedPairOptions::ValidAlterOpts`,
  :oe:const:`OEMedChem::OEMatchedPairOptions::ValidIndexOpts`,
  :oe:meth:`OEMedChem::OEMatchedPairAnalyzer::ModifyOptions`,
  :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::ModifyOptions`).

* A new method has been added to the analyzer options class to support
  command-line specification of options (see
  :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetProcessorType`).

* A new argument has been added to the functions that apply matched pair
  transformations that limits application of transformations only to those that
  meet or exceed the specified number of matched pairs (see
  :oe:func:`OEMedChem::OEApplyChEMBL18SolubilityTransforms` and
  :oe:func:`OEMedChem::OEMatchedPairApplyTransforms`).

New features
--------------------------------------------------------------------------------

* The matched pair analyzer now supports the ability to be saved and restored
  to disk or stream. This allows checkpoint backups during a long analysis run
  or a long analysis run to be restored from disk for subsequent use without
  the need to re-run the analysis (see :oe:func:`OEMedChem::OEReadMatchedPairAnalyzer`
  and :oe:func:`OEMedChem::OEWriteMatchedPairAnalyzer`).

* The ChEMBL18 solubility data has been re-indexed with the latest version of the
  matched pair analyzer to include hydrogen-member transformations. The result is
  a larger number of transformations and potentially a larger number of transformed
  and annotated structures returned from :oe:func:`OEMedChem::OEApplyChEMBL18SolubilityTransforms`.
  For a 10K test set of structures, using :oe:const:`OEMedChem::OEMatchedPairContext::Bond0`
  resulted in an average of three times more output structures and
  :oe:const:`OEMedChem::OEMatchedPairContext::Bond2` produced an average of 4.5 times the
  number of output structures as the previous release when applying all transformations
  by overriding the default value of ``minMMPThreshold`` parameter with ``0``.
  Using the default value (5) for the ``minMMPThreshold`` parameter, the number of annotated
  structures from the 10K test set compared to the previous version is approximately the same
  for the :oe:const:`OEMedChem::OEMatchedPairContext::Bond0` context and approximately 25% less
  structures for the :oe:const:`OEMedChem::OEMatchedPairContext::Bond2` context.  The number of
  structures produced is input dataset-dependent, so tuning of the ``minMMPThreshold``
  parameter is highly encouraged.

* New functions to configure matched pair indexing options and
  to set indexing options from the command line have been added
  (see :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions` and
  :oe:func:`OEMedChem::OESetupMatchedPairIndexOptions`).  Example scripts have
  been updated to demonstrate the use of these new functions.

* A new method has been added to return a count of the number of active index nodes (see
  :oe:meth:`OEMedChem::OEMatchedPairAnalyzer::NumIndexNodes`).

Minor bug fixes
--------------------------------------------------------------------------------

* Structures returned from the application of matched pair transformations will now have
  their coordinates cleared. Previously, newly added atoms were simply placed at the
  origin, possibly affecting stereochemistry and generating odd depiction output.

Documentation fixes
--------------------------------------------------------------------------------

* Documentation of the new serialization support is now available for
  :oe:func:`OEMedChem::OEGetMatchedPairAnalyzerFileType`,
  :oe:func:`OEMedChem::OEIsReadableMatchedPairAnalyzer`,
  :oe:func:`OEMedChem::OEIsWriteableMatchedPairAnalyzer`,
  :oe:func:`OEMedChem::OEReadMatchedPairAnalyzer`,
  :oe:func:`OEMedChem::OEWriteMatchedPairAnalyzer`,
  :oe:meth:`OEMedChem::OEMatchedPairAnalyzer::ModifyOptions`,
  :oe:const:`OEMedChem::OEMatchedPairOptions::ExportCompression`,
  :oe:const:`OEMedChem::OEMatchedPairAnalyzerFileType`,
  :oe:const:`OEMedChem::OEMatchedPairOptions::ValidAlterOpts` and
  :oe:const:`OEMedChem::OEMatchedPairOptions::ValidIndexOpts`.

* Documentation of the new command-line configuration support is now available for
  :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions` and
  :oe:func:`OEMedChem::OESetupMatchedPairIndexOptions`.


OEMedChem TK 1.0.0
================================================================================

Licensing changes
--------------------------------------------------------------------------------

* In preparation for new licensing requirements for **OEMedChem TK**, license
  checks have been added to :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` constructor.
  Visit https://www.eyesopen.com/contact if you need a license for matched pair activities.

.. _section_releasenotes_OEMedChem_100:

OEMedChem functionalities
--------------------------------------------------------------------------------

This is the first official release of **OEMedChem** functionalities, previously
released in beta form.
An overview of its capabilities is provided below.

Matched molecular pair analysis
--------------------------------------------------------------------------------

A powerful analysis engine and functions support the identification
of matched molecular pairs that differ by both heavy-atom and hydrogen-atom substitutions.
Additionally, the analyzer supports the ability to be saved and
restored to disk or stream.
The analyzer includes the following functions:

- :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>`
- :oe:func:`OEMedChem::OEMatchedPairApplyTransforms`
- :oe:func:`OEMedChem::OEReadMatchedPairAnalyzer`
- :oe:func:`OEMedChem::OEWriteMatchedPairAnalyzer`

- :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>`
- :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions`
- :oe:func:`OEMedChem::OESetupMatchedPairIndexOptions`

Functions and classes are provided to allow extraction and inspection of transformations based on
matched molecular pairs found during structure indexing as well as the specific matched pairs
and data associated with those transformations:

- :ref:`OEMatchedPair <OEMedChem_OEMatchedPair>`
- :ref:`OEMatchedPairTransform <OEMedChem_OEMatchedPairTransform>`
- :oe:func:`OEMedChem::OEMatchedPairGetTransforms`

ChEMBL18 solubility data has been indexed with the matched pair analyzer to modify
input structures according to the solubility transforms and to annotate modified structures
with the net change in solubility data from ChEMBL:

- :oe:func:`OEMedChem::OEApplyChEMBL18SolubilityTransforms`

Fragmentation and perception capabilities
--------------------------------------------------------------------------------

The following functions are provided to return perceived regions for fragmentation strategies:

- :oe:func:`OEMedChem::OEGetBemisMurcko`
- :oe:func:`OEMedChem::OEGetFuncGroupFragments`
- :oe:func:`OEMedChem::OEGetRegionTypeName`
- :oe:func:`OEMedChem::OEGetRegionType`
- :oe:func:`OEMedChem::OEGetRingChainFragments`
- :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments`

Belief theory
--------------------------------------------------------------------------------

Functions are provided to return information for belief theory usage based on [Muchmore-2008]_:

- :oe:func:`OEMedChem::OECalculateComboBelief`
- :oe:func:`OEMedChem::OECalculateETComboBelief`

Similarity
--------------------------------------------------------------------------------

Functions are provided to return the graph-edit similarity used in clustering BROOD hitlists:

- :oe:func:`OEMedChem::OECreateIDString`
- :oe:func:`OEMedChem::OECreateIDStrings`

Complexity measures
--------------------------------------------------------------------------------

Functions are provided to return individual terms that make up the molecular complexity as defined by [Bertz-1981]_:

- :oe:func:`OEMedChem::OEDetermineConnectiveComplexity`
- :oe:func:`OEMedChem::OEDetermineElementalComplexity`
- :oe:func:`OEMedChem::OEDetermineMolecularComplexity`
- :oe:func:`OEMedChem::OEDetermineSymmetryComplexity`
- :oe:func:`OEMedChem::OENormalMolecularComplexity`

Functions are provided to return a ring complexity measure similar to that defined by [Gasteiger-1979]_:

- :oe:func:`OEMedChem::OEDetermineRingComplexity`
- :oe:func:`OEMedChem::OEGetRingValue`

Functions are provided to return a measure of stereo complexity as defined by [Boda-2007]_:

- :oe:func:`OEMedChem::OEDetermineStereoComplexity`
- :oe:func:`OEMedChem::OENormalStereoComplexity`

A function is provided to return a measure of the total molecular complexity, which is a
sum of the provided individual complexity measures:

- :oe:func:`OEMedChem::OETotalMolecularComplexity`

Minor bug fixes
--------------------------------------------------------------------------------

* As a result of a minor bug fix in **OEChem TK**,
  :oe:func:`OEMedChem::OEDetermineStereoComplexity`,
  :oe:func:`OEMedChem::OENormalStereoComplexity`, and
  :oe:func:`OEMedChem::OENormalStereoComplexity` functions might return slightly different
  values for molecules containing transition metals, lanthanides, or actinides.

Documentation changes
--------------------------------------------------------------------------------

* New documentation code snippets for C++, Java, and C# have been added to demonstrate
  matched pair index creation, serialization, and deserialization.

* Examples have been updated to allow explicit specification of the ``mmpMinPairThreshold``
  arguments for :oe:func:`OEMedChem::OEMatchedPairApplyTransforms` and
  :oe:func:`OEMedChem::OEApplyChEMBL18SolubilityTransforms`.

* Several molecular complexity functions that were inadvertently removed
  from the documentation have been re-added.

* The :ref:`oemedchem_examples_matchedpairtransform` example has been modified
  to reduce the amount of output that is typical for a general indexing
  activity.


OEMedChem TK 1.0.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:func:`OEMedChem::OECreateIDStrings` function
  has been repaired and will no longer crash.


OEMedChem TK 1.0.2
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* An issue that could lead to corrupted stereochemistry alpha to
  fragmentation bonds during Matched Pair analysis has been repaired.

* Minor internal improvements have been made.


OEMedChem TK 1.0.3
================================================================================

New features
--------------------------------------------------------------------------------

* A new class, :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>`, has been implemented
  that supports an MCS fragmentation approach for returning Tanimoto and
  Tversky MCS similarity scores from a query against an indexed set of input
  structures.
  This approach is similar to the :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>`
  and the API is functionally equivalent to the
  :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` API for ease of use. Because the indexing
  phase of the input structures can be time-consuming, new functions
  to capture and reload the MCS fragmentation index are provided as
  :oe:func:`OEMedChem::OEReadMCSFragDatabase` and
  :oe:func:`OEMedChem::OEWriteMCSFragDatabase`.

* A new options class, :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>`,
  has been added to control the indexing phase of
  :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` usage.

* A new constant,
  :oe:const:`MCSFrags<OEMedChem::OEMatchedPairAnalyzerFileType::MCSFrags>`,
  has been added to support :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>`
  serialization and may be returned by
  :oe:func:`OEMedChem::OEGetMatchedPairAnalyzerFileType`.

* Two new functions,
  :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` and
  :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`, have been added
  to allow configuration of indexing parameters from the command line for
  :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>`.

* A new function, :oe:func:`OEMedChem::OEMCSFragDatabaseCoreQuery`, has been
  added to annotate MCS fragment SMILES cores returned from
  :oe:meth:`OEMedChem::OEMCSFragDatabase::GetSortedScores` and
  :ref:`OEMCSMolSimScore <OEMedChem_OEMCSMolSimScore>` with SMARTS qualifiers.
  This allows more restrictive and meaningful mapping highlights to be applied
  for depicting similarity hit results.

* The :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` class now supports
  user-customization
  of the similarity score returned by implementing a class derived from
  :ref:`OEMCSSimFuncBase <OEMedChem_OEMCSSimFuncBase>`.  Two concrete implementations of
  scoring functions, :ref:`OEMCSTanimotoSim <OEMedChem_OEMCSTanimotoSim>` and
  :ref:`OEMCSTverskySim <OEMedChem_OEMCSTverskySim>`, have been added.

* The indexing performance of :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>`
  has been significantly improved.  While this is highly
  dependent on the input structures and the requested indexing parameters,
  the provided default indexing settings with a drug-like
  set of structures show an indexing improvement of ~25%.

* A new overloaded function,
  :oe:func:`OEMedChem::OEIsMatchedPairAnalyzerFileType`, has been added to
  simplify the validation of matched pair index files.  The now unnecessary
  :oe:func:`OEMedChem::OEIsReadableMatchedPairAnalyzer` and
  :oe:func:`OEMedChem::OEIsWriteableMatchedPairAnalyzer` functions have
  been deprecated.

Documentation changes
--------------------------------------------------------------------------------

* New documentation has been added for the
  :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` API
  and the ancillary support functions, classes, and constants.


OEMedChem TK 1.0.4
================================================================================

New features
--------------------------------------------------------------------------------

* A major overhaul of the fragmentation internals of
  :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` now allows an arbitrary number of
  fragmentation cuts.   Additionally, an experimental capability for
  performing limited ring bond fragmentation cuts has been provided.
  Because of the combinatorial explosion of fragments generated with
  increased fragmentation cuts, care should be used when determining
  fragmentation cut limits.  The enhanced ability to do arbitrary N-cut
  fragmentation makes the MCS results from the fragmentation approach much
  closer to an :ref:`OEMCSSearch <OEChem_OEMCSSearch>` mapping result, with better
  overall performance than a mapping approach. To specify the fragmentation
  cut limits, see
  :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetFragLimits`,
  :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::GetMinFragLimit`,
  :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::GetMaxFragLimit`,
  :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetRingFragLimit`, and
  :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::GetRingFragLimit`.

* A new method, :oe:meth:`OEMedChem::OEMCSFragDatabase::IsIndexed`, has been
  added to determine whether a particular molecule index has been
  registered in the database.  Depending on the indexing option settings, a
  particular molecule may be rejected from indexing.  This method
  allows that condition to be interrogated.

* A new method, :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::HasIndexableFragmentHeavyAtomRange`, has
  been added to allow an options object to indicate that a ``min-max``
  range has been specified via
  :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetIndexableFragmentRange`.

* The :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` options class
  now supports the ``operator==`` comparison to more easily determine the
  equality of two options objects.

* :oe:func:`OEMedChem::OEConfigureMatchedPairIndexOptions` and
  :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` now support
  an ``-allfrags`` option to clear the ``min-max`` indexing constraint and to
  allow the indexing of all fragments.  Indexing all fragments has
  indexing size and indexing performance implications
  for :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>`
  and :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` objects.

* The :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function now
  supports the newly added ``-minfragcuts``, ``-maxfragcuts``, and
  ``-ringcuts`` options.

* :oe:func:`OEMedChem::OEReadMatchedPairAnalyzer` now
  supports the ability to merge indices generated from segments of a large
  set of input structures.  This capability can be used in a
  parallel processing approach to increase the throughput of the
  time-consuming structure indexing phase.

Preliminary Fragmentation API
--------------------------------------------------------------------------------

* New :term:`Preliminary API` methods have been added to allow the
  interrogation of intermediate fragmentation output and internal index
  information from the :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` object.
  See :oe:meth:`OEMedChem::OEMCSFragDatabase::MoleculeToCores`,
  :oe:meth:`OEMedChem::OEMCSFragDatabase::CoreToMolecules`,
  :oe:meth:`OEMedChem::OEMCSFragDatabase::CoreToMoleculeCount`,
  :oe:meth:`OEMedChem::OEMCSFragDatabase::GetMaxCoreMolecule`, and
  :oe:meth:`OEMedChem::OEMCSFragDatabase::GetMaxCoreMoleculeCount`.

* A new example has been provided to demonstrate using the new
  experimental fragment API of :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>`.
  See ``MCSFragOccurrence.py``.

Minor bug fixes
--------------------------------------------------------------------------------

* A bug that resulted in the return of ``[R1][R2]`` fragments in the
  Matched Molecular Pair transforms returned by
  :oe:func:`OEMedChem::OEMatchedPairGetTransforms` has been fixed.

* The :oe:meth:`OEMedChem::OEMCSFragDatabase::GetScores` has been changed
  to make the API more consistent with :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>`.
  The ``end`` range argument is now exclusive instead of inclusive when a
  non-zero value is specified.

* The :oe:meth:`OEMedChem::OEMCSFragDatabase::GetScores` and
  :oe:meth:`OEMedChem::OEMCSFragDatabase::GetSortedScores` methods
  previously returned an arbitrary :ref:`OEMCSMolSimScore <OEMedChem_OEMCSMolSimScore>`
  when different identified cores had the same score (in particular for
  :oe:const:`OEMedChem::OEMCSScoreType::AtomCount` scoring).
  This has been fixed.

* The undocumented internal debugging method
  ``OEMedChem::OEMCSFragDatabase::Dump`` has been removed from the public API.

Python-specific changes
--------------------------------------------------------------------------------

* Minor changes to some examples were made to synchronize
  the behavior and output with other wrapped language examples.

Java-specific changes
--------------------------------------------------------------------------------

* Minor changes to some examples were made to synchronize the
  behavior and output with other wrapped language examples.

C#-specific changes
--------------------------------------------------------------------------------

* Minor changes to some examples were made to synchronize the
  behavior and output with other wrapped language examples.

Documentation changes
--------------------------------------------------------------------------------

* New methods have been documented in their respective classes.


OEMedChem TK 1.0.5
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEMedChem::OEWriteMatchedPairAnalyzer` now supports a new option,
  :oe:const:`OEMedChem::OEMatchedPairOptions::ExportHKeys`, which will serialize
  additional information to reduce the loading time from a
  :oe:func:`OEMedChem::OEReadMatchedPairAnalyzer` call.  The saved information
  results in slightly larger index files (+10-20%) but substantially reduced
  load times (>10x). :oe:const:`OEMedChem::OEMatchedPairOptions::ExportHKeys`
  is enabled by default.

.. warning::

   The change in the serialized data format requires that any existing saved
   matched pair analyzer index files be regenerated if they were created
   using a previous **OpenEye Toolkit** version. Indices serialized from this
   version cannot be read by older versions.

* :oe:func:`OEMedChem::OEReadMatchedPairAnalyzer` now supports a new Boolean
  argument that controls the regeneration of index information during the
  read.  By default, the regeneration is suppressed and index data read from
  the file is used.

* A new :ref:`OEMatchedPairTransformExtractOptions <OEMedChem_OEMatchedPairTransformExtractOptions>` option
  class has been added to control the transformations returned from the
  :oe:func:`OEMedChem::OEMatchedPairGetTransforms` functions.  Several new
  function overloads have been provided that use this new option class.

Minor bug fixes
--------------------------------------------------------------------------------

* Output to ``stdout`` from within :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>`
  has been removed.

* Several tetrahedral stereo issues in the transformations extracted by
  :oe:func:`OEMedChem::OEMatchedPairGetTransforms` have been fixed.

* Erroneous warnings had been thrown about duplicate structures when appending
  matched pair indices if duplicate structures are allowed.  This has been
  fixed.

* An issue with exported matched pair transformations that occurred when search
  qualifiers were requested and matched pair core atoms contained charged
  atoms has been fixed.  The search qualifiers erroneously duplicated charge
  information in the output string, causing transformation mappings to fail.

Documentation changes
--------------------------------------------------------------------------------

* Examples have been updated to use
  :oe:func:`OEChem::OEDeleteEverythingExceptTheFirstLargestComponent`
  rather than the deprecated function
  :oe:func:`OEChem::OETheFunctionFormerlyKnownAsStripSalts`.


OEMedChem TK 1.0.6
================================================================================

New features
--------------------------------------------------------------------------------

* A new status return has been added to indicate when a molecule submitted for
  indexing by :ref:`OEMCSFragDatabase <OEMedChem_OEMCSFragDatabase>` has no fragmentation
  bonds (e.g., is a complete ring system without non-ring substituents).
  The new constant returned is
  :oe:const:`OEMedChem::OEMatchedPairIndexStatus::NoFragmentationBonds`.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue with hydrogen atoms on input molecules used with
  :oe:func:`OEMedChem::OEApplyChEMBL18SolubilityTransforms` has been fixed.
  This function is now tolerant of explicit hydrogen atoms on the
  input molecule.


OEMedChem TK 1.0.7
================================================================================

New features
--------------------------------------------------------------------------------

* The performance of appending segments of matched pair indices together
  has been significantly improved over previous versions. This activity is
  a common use-case with parallel index creation approaches.

* A new :oe:meth:`OEMedChem::OEMatchedPairAnalyzer::GetMaxMolIdx` method has
  been added to make identifying the largest
  molecule index registered to a matched pair index more convenient.

* A new :oe:meth:`OEMedChem::OEMatchedPairAnalyzer::GetMolecule` method has
  been added to make retrieving a molecule from the
  MMP index more convenient and to eliminate the need to maintain a separate
  :ref:`OEMolDatabase <OEChem_OEMolDatabase>` for this activity.

* A new :oe:func:`OEMedChem::OEApplyChEMBL24SolubilityTransforms`
  function has been added to return modified structures using
  `ChEMBL24 <https://www.ebi.ac.uk/chembl>`_ solubility data. The
  existing :oe:func:`OEMedChem::OEApplyChEMBL18SolubilityTransforms`
  API will be deprecated in future versions.

* A new indexing option,
  :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSingleCuts`, has
  been added to limit the H-member matched pair index information to
  single-cut transformations only.  The current
  :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` option will
  continue to provide H-member index information for all of single-,
  double-, or triple-cut transformations.
  :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSingleCuts` takes
  precedence over
  :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` if both
  options are provided.

New features (Preliminary API)
--------------------------------------------------------------------------------

* The following preliminary APIs have been added to provide fast multithreaded
  generation of matched pair indices:

  * :oe:func:`OEMedChem::OECreateMMPIndexFile` function
  * :ref:`OECreateMMPIndexOptions <OEMedChem_OECreateMMPIndexOptions>` option class
  * :ref:`OECreateMMPIndexStatus <OEMedChem_OECreateMMPIndexStatus>` class

* New :oe:func:`OEMedChem::OEReadMMPIndexMolecules` and
  :oe:func:`OEMedChem::OEWriteMMPIndexMolecules` functions have been
  implemented as preliminary APIs to support multithreaded and parallel
  matched pair index creation activities.

* New function overloads to
  :oe:func:`OEMedChem::OEMatchedPairGetTransforms` have been added to
  allow extracting transforms and related matched molecular pairs using 1 or
  more identified site(s) of substitution on a probe structure.

* New free functions and overloads,
  :oe:func:`OEMedChem::OEGetMatchedMolecularPairs`, have been added to
  allow extracting related matched molecular pairs using either a molecule ID or
  a probe structure with one or more identified site(s) of substitution.

API changes
--------------------------------------------------------------------------------

* A public class, :ref:`OEMatchedPairTransform <OEMedChem_OEMatchedPairTransform>`, has
  been altered to remove unnecessary implementation details.  Several
  of the methods exposed were previously inaccessible or unnecessary
  for wrapped language use.  The simplified API retains the common
  methods for interrogating the transforms and matched pairs returned
  from :oe:func:`OEMedChem::OEMatchedPairGetTransforms`. This is
  potentially a breaking API change.  For custom code using the
  removed methods, please contact support@eyesopen.com for details on
  migration activity that might be required.

* The ``OEMedChem::OEIsMCSFragDatabaseFiletype`` function has been
  renamed :oe:func:`OEMedChem::OEIsMCSFragDatabaseFileType` to
  follow **OpenEye Toolkit**'s naming scheme.

* The :oe:meth:`OEMedChem::OEMCSFragDatabase::CoreToMolecules`,
  :oe:meth:`OEMedChem::OEMCSFragDatabase::CoreToMoleculeCount`,
  :oe:meth:`OEMedChem::OEMCSFragDatabase::GetMaxCoreMolecule`,
  :oe:meth:`OEMedChem::OEMCSFragDatabase::GetMaxCoreMoleculeCount`,
  and :oe:meth:`OEMedChem::OEMCSFragDatabase::MoleculeToCores` methods and
  the :oe:func:`OEMedChem::OEMoleculeToCores` function have graduated
  from preliminary API to stable API status for the 2018.Oct release.

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:func:`OEMedChem::OEGetBemisMurcko` function has been
  corrected so that chain bonds between rings are no longer returned
  in the :oe:const:`OEMedChem::OERegionType::Ring` role sets.

* :oe:func:`OEMedChem::OEMatchedPairGetTransforms` has been fixed and
  no longer returns unusual matched pair transforms related to
  group bond-insertion changes.

* A bug that seemed to allow reactions to be added to a matched pair
  index has been fixed so that reaction input is now explicitly
  rejected.  Attempting to add a reaction to the index will now return
  a status of
  :oe:const:`OEMedChem::OEMatchedPairIndexStatus::NoStructure`.

* New options were added to :oe:constns:`OEMedChem::OEMatchedPairIndexStatus`
  to return additional indexing failure conditions.

* :oe:const:`OEMedChem::OEMatchedPairIndexStatus::NoFragmentationBonds`
  may now be returned from
  :oe:meth:`OEMedChem::OEMatchedPairAnalyzer::AddMol` when the input
  structure has no fragmentation bonds, depending on the H-member
  indexing option in use.

Python-specific changes
--------------------------------------------------------------------------------

* A new match pair index example has been added to demonstrate the
  creation of an MMP index via parallel processing using the Python
  `multiprocessing
  <https://docs.python.org/3/library/multiprocessing.html>`_ module.

Documentation changes
--------------------------------------------------------------------------------

* The MCS fragment database examples and match pair index examples
  have been modified to separate the index creation step from
  database query activities. See the list of currently available
  examples in the :ref:`oemedchem_chapter_examples` section.


OEMedChem TK 1.1.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* An issue with Matched Pair index generation that occurred when input
  structures contained reaction mapping information has been fixed.

* Several issues in the probesite-based preliminary API
  function :oe:func:`OEMedChem::OEGetMatchedMolecularPairs` have been fixed.


OEMedChem TK 1.1.1
================================================================================

New features
--------------------------------------------------------------------------------

* The following APIs for fast multithreaded generation of matched pair indices,
  introduced in the 2018.Oct release, have graduated from preliminary API
  to stable API status:

  * :oe:func:`OEMedChem::OECreateMMPIndexFile` function

  * :ref:`OECreateMMPIndexStatus <OEMedChem_OECreateMMPIndexStatus>` class

  * :ref:`OECreateMMPIndexOptions <OEMedChem_OECreateMMPIndexOptions>` class

  They are now also available in Python, Java, and C#.

Documentation changes
--------------------------------------------------------------------------------

* The following examples that create a Matched Molecule Pair index were modified
  to fix an issue with the SD data handling (options ``-keepSD``, ``-clearSD``,
  ``-allSD``):

  * :ref:`oemedchem_examples_createmmpindex`

  * :ref:`oemedchem_examples_createmmpindexparallel`




OEMedChem TK 1.1.2
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------
* An internal issue in :oe:func:`OEMedChem::OECreateIDStrings` that resulted in hanging processes or
  crashes for some simple structures has been fixed.

* A minor issue that occurred when using a combination of
  :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSingleCuts`
  and :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` has been fixed.
  The :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSingleCuts` option now takes precedence.




OEMedChem TK 1.1.3
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* The preliminary API points, :oe:func:`OEMedChem::OEReadMMPIndexMolecules` and
  :oe:func:`OEMedChem::OEWriteMMPIndexMolecules` are now fully supported.

* Bemis-Murcko fragmentation has been extended to allow inclusion of custom
  substituents on the framework, using either a custom subsearch or a flag to
  include unsaturated bonds to hetero atoms on the framework. The class
  :ref:`OEBemisMurckoOptions <OEMedChem_OEBemisMurckoOptions>` allows specification of these options. The APIs
  for the functions :oe:func:`OEMedChem::OEGetBemisMurcko` and
  :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments` have changed to include an options
  argument.

* The versions of functions :oe:func:`OEMedChem::OEGetBemisMurcko`  and
  :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments` that take a single integer argument to
  specify fragmentation region are now deprecated.

Documentation changes
--------------------------------------------------------------------------------

* Examples of custom Bemis-Murcko fragmentation have been added to the fragmentation documentation
  in the  :ref:`chapter_fragmentation` chapter.

* The :ref:`BemisMurckoPerception<oemedchem_examples_bemismurckoperception>`
  example script has been modified to include examples of custom Bemis-Murcko fragmentation,
  using the flag ``-unsatHetero`` to include unsaturated bonds to hetero atoms on the framework
  and the flag ``-smartsSubstituents`` to include substituents specified by given SMARTS patterns.




OEMedChem TK 1.1.4
================================================================================

*July 2021*

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:const:`OEMedChem::OEMatchedPairOptions::ComboCuts` has been added by default to all cut options.




OEMedChem TK 1.1.5
================================================================================

*Fall 2021*

* Minor internal improvements have been made.





OEMedChem TK 1.1.6
================================================================================

* Minor internal improvements have been made.




OEMedChem TK 1.1.7
================================================================================

Minor internal improvements have been made.




OEMedChem TK 1.2.0
================================================================================

Internal changes
--------------------------------------------------------------------------------
* Internal functions used to constrain Matched Molecular
  Pair transforms by applying SMARTS constraints have been replaced with calls
  to the new preliminary API functions in OEChem.
  See :oe:func:`OEChem::OECreateAtomSmartsString`, :oe:func:`OEChem::OECreateBondSmartsString`,
  and :oe:func:`OEChem::OECreateSmartsString`.




OEMedChem TK 1.2.1
================================================================================

Minor internal improvements have been made.





OEMedChem TK 1.2.2
================================================================================

Minor internal improvements have been made.





OEMedChem TK 1.2.3
================================================================================

Minor internal improvements have been made.



OEMedChem TK 1.2.4
================================================================================

Minor Bug Fixes
--------------------------------------------------------------------------------

* A bug causing a crash on Windows builds has been fixed.




OEMedChem TK 1.2.5
================================================================================

Minor internal improvements have been made.


###############################################
Appendix: Additional Examples in Python
###############################################

These are full listings of programming examples that are excerpted or offered for download, elsewhere in this chapter.
For a full list of examples, see
:ref:`the list in this chapter <oemedchem_part_examples>`.

..  _listing-FragRingChain.py:

.. oe:source:: FragRingChain.py
   :language: python
   :refnum:   1
   :caption:  Example of molecule fragmentation.

..  _listing-OEGetBemisMurcko.py:

.. oe:source:: OEGetBemisMurcko.py
   :language: python
   :refnum:   2
   :caption:  Example of molecule fragmentation with annotations.

..  _listing-OEGetBemisMurckoCustomSubstituents.py:

.. oe:source:: OEGetBemisMurckoCustomSubstituents.py
   :language: python
   :refnum:   3
   :caption:  Example of custom molecule fragmentation.

..  _listing-OEGetBemisMurckoUnsatHeteroBonds.py:

.. oe:source:: OEGetBemisMurckoUnsatHeteroBonds.py
   :language: python
   :refnum:   4
   :caption:  Example of custom molecule fragmentation.

..  _listing-FindSimpleMatchedPairs.py:

.. oe:source:: FindSimpleMatchedPairs.py
   :language: python
   :refnum:   5
   :caption:  Introductory usage of matched molecular pair analysis.



.. _oemedchem_part_theory:

********************************
Theory
********************************

.. toctree::
   :maxdepth: 2

   fragmentation
   matchedpairanalysis


.. molproptk toolkit documentation master file

#################################
MolProp Toolkit |molprop_version|
#################################

.. toctree::
   :maxdepth: 3

   theory/theory
   examples
   selected_examples_python
   api

.. toctree::
   :maxdepth: 2

   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _molprop_part_theory:

******************
Theory
******************

.. toctree::
   :maxdepth: 2

   filter_theory
   filter_process
   molprops
   filter_files_stub


.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. _filter_theory:

###################
Filtering Theory
###################

.. _section_filter_theory:

****************
Introduction
****************

Filtering attempts to eliminate inappropriate or undesirable compounds
from a large set before beginning to use them in modeling studies.
The goal is to remove all of the compounds that should not be
suggested to a medicinal chemist as a potential hit. This exercise is
obviously case dependent, depending on ease of the assay, intended
target, needs of the user, and so on.

To match this need, the default filter encapsulates many of the
standard filtering principles, such as removal of unstable, reactive,
and toxic moieties. In addition, |product| allows the customization of
the filtering criteria to fit specific needs.

The criteria for passing or failing a given molecule fall into three categories.

.. _filter_theory_physical_properties:

* Physical properties

    - Molecular weight

    - Topological polar surface area (TPSA)

    - logP

    - Bioavailability


* Atomic and functional group content

    - Absolute and relative content of heteroatoms

    - Limits on a very wide variety of functional groups

* Molecular graph topology

    - Number and size of ring systems

    - Flexibility of the molecule

    - Size and shape of non-ring chains

All of the data generated in filtering molecules can be written to a
tab-separated file for easy import into a spreadsheet. This functionality
allows for combining the values dynamically for a variety of purposes,
including, but not limited to, determining which filter values best fit
each project's needs.

History
=========

When OpenEye's work on filtering technology began in 2000, it was
designed simply to remove compounds with reactive or otherwise
undesirable functional groups. Over the years, the understanding of
lead-like and drug-like compound selection has advanced. In addition,
with the publication of Lipinski's "Rule of 5" [Lipinski-1997]_, more
and more pharmacokinetic properties have appeared earlier in the
virtual screening process.

In addition to providing basic functional group selection, the
technology is a one-stop database preparation tool aimed at generating
databases suitable for high-throughput virtual screening. The following are some components of this tool.

* Cheminformatics quality control

  - Valence-state validation

  - Aromaticity perception

  - Implicit hydrogen perception

  - Bond-order perception

* Database preparation

  - Setting pKa states

  - Applying normalizations (tautomers and dative or hypervalent states)

* Compound selection

  - Physical properties (see :ref:`above <filter_theory_physical_properties>`)

  - Assay counter-indicators (aggregators and dyes)

  - Promiscuous actives [Baell-2010]_

  - PK ([Martin-2005]_, [Veber-2002]_, [Egan-2000]_, [Lipinski-1997]_)


Finally, it should be pointed out that in the virtual screening world,
time is of the essence. Algorithms for preliminary database
preparation should not take large amounts of time. Because of this,
all the calculations included are 2D or graph-based algorithms. While
this does occasionally limit the technology, it allows for the delivery
of a product that is appropriate for the task of virtual-screening
database preparation.

.. _filter_theory_rant:

A Detailed Examination of False Positives and False Negatives
===============================================================

Nearly every computational tool used in early drug discovery yields
statistically predictive, rather than absolutely definitive results.
In nearly every case, prudence demands that one consider the causes of
false positives and false negatives and make an attempt to optimize
the area under the receiver-operator curve (ROC) for the computational
tool.  However, there are well-known methods for improving statistical
predictions of this nature that are independent of the absolute
false-positive and false-negative rates.  These methods include
filtering the population to which a test will be applied.  By applying
a test to smaller populations that only contain molecules appropriate
for the specific application at hand, the negative impact of the
false-positive rate on the predictive results can be dramatically
improved.

A familiar example from the medical world will serve to illustrate
this principle.  Assume we have a test for the presence of the new
*foo virus* which has an exceptional ROC curve with false-positive
and false-negative values (1/1,000 and 1/1,000 respectively).  Let us
assume that the *foo syndrome*, caused by the *foo virus*, affects 1
person in 20,000.  If we gave this test to 100,000 people from the
general population, we would expect 5 to actually have the *foo
syndrome*.  With this test, there is only a 0.05% percent chance that
any of them would not be detected (that is, be a false negative).
However, we would expect there to be 100 false-positive test results.
Thus of the 105 total positive test results, only 4.8% would actually
have the *foo syndrome* (positive predictive value = 4.8%).

.. list-table:: Confusion table for the **unfiltered** *foo virus* test (prevalence 1 in 20,000)
   :widths: 9 13 13 20
   :header-rows: 1
   :stub-columns: 1

   * -
     - Actual Positive
     - Actual Negative
     -
   * - Predicted Positive
     - True Positives = 5
     - False Positives = 100
     - Positive Predictive Value = 4.8%
   * - Predicted Negative
     - False Negatives = 0
     - True Negatives = 99,895
     -

Alternatively, we could start by using very simple screening before
applying the test.  We first eliminate people who do not have any risk
factors for contracting the *foo virus*.  Next, we may eliminate people
whose blood is incompatible with the test for the *foo virus*.  Further,
we may want to eliminate people who acknowledge that they will refuse
treatment for the *foo virus* even if we determine that they do have it.
By these admittedly simple screens, we apply the test for the *foo
virus* to a much smaller group with a decidedly higher prevalence of
the virus.  For instance, after the filtering, we may be left with a
group of only 1,000 people who have a 1 in 200 chance of having the
syndrome.  Now, we still have the same five people who actually have
the disease, but we only expect one false-positive test.  Now
there are six total positive tests, and 83% of them actually have the
syndrome!  This is reflected in a much more reasonable (83%) positive
predictive value.

.. list-table:: Confusion table for the **filtered** *foo virus* test (prevalence 1 in 200)
   :widths: 9 13 13 20
   :header-rows: 1
   :stub-columns: 1

   * -
     - Actual Positive
     - Actual Negative
     -
   * - Predicted Positive
     - True Positives = 5
     - False Positives = 1
     - Positive Predictive Value = 83%
   * - Predicted Negative
     - False Negatives = 0
     - True Negatives = 994
     -

Returning to drug design, in a
ligand-based design tool such as **ROCS**, we can posit that the
receiver-operator curve may have a false positive rate as low as 1
in 10,000.  For this exercise, assume no false negatives.  When
using that to identify 50 inhibitors from a database of 2.5 million
available compounds, we would identify 300 potential inhibitors, and 5 out
of every 6 of these would be a false positive (positive predictive
value of 17%). However, running ``filter`` first would eliminate 65% of the 2.5
million compounds, leaving 875,000 compounds to run
through **ROCS**.  There will be approximately 88 false positives along with the
50 true positives increasing the positive predictive value more than
two-fold with relatively little work.

.. list-table:: Confusion table for the **unfiltered** ROCS virtual screen
   :widths: 9 13 13 20
   :header-rows: 1
   :stub-columns: 1

   * -
     - Actual Positive
     - Actual Negative
     -
   * - Predicted Positive
     - True Positives = 50
     - False Positives = 250
     - Positive Predictive Value = 17%
   * - Predicted Negative
     - False Negatives = 0
     - True Negatives = 2,499,700
     -

.. list-table:: Confusion table for the **filtered** ROCS virtual screen
   :widths: 9 13 13 20
   :header-rows: 1
   :stub-columns: 1

   * -
     - Actual Positive
     - Actual Negative
     -
   * - Predicted Positive
     - True Positives = 50
     - False Positives = 88
     - Positive Predictive Value = 36%
   * - Predicted Negative
     - False Negatives = 0
     - True Negatives = 874,862
     -


Filtering Principles
==============================================

The same principle of increasing the positive predictive value by removing
obvious true negatives applies to screening for lead candidates,
regardless of whether it is virtual screening or high-throughput
screening (HTS).  While both are reasonable screens, each can be plagued by
very low positive predictive values (despite low false-positive
rates), particularly when applied to all available compounds or large
virtual libraries.  Simple filtering techniques focus the set of
compounds passed on to more computationally intensive screening
methods.

The first approach is to filter based on :ref:`functional
groups <molprops_functional_groups>`. Generally speaking, there are
toxic and reactive functional groups that should be removed from consideration,
such as alkyl bromides or metals. There are also functional
groups that are not strictly forbidden, but are undesirable in large
quantities. For instance, parafluorobenzene or trifluoromethyl have
specific purposes, but heavily fluorinated molecules can be
eliminated.

Beyond simple functional group filtering, both simple
and complex physical properties can be used to characterize the
kinds of compounds to keep or to
eliminate. These properties attempt to consider drug-like qualities, such
as bioavailability, solubility, toxicity, and synthetic accessibility,
even before the primary high-throughput or virtual screening, which
are primarily geared toward detecting potency alone. The best known
physical property filters is :ref:`Lipinski's "rule-of-five"
<molprops_lipinski>`, which focuses on bioavailability
[Lipinski-1997]_. However, many other physical properties, such
as :ref:`solubility <molprops_logs>`, :ref:`atomic content
<filter_process_metal_removal>`, :ref:`ring structures
<molprops_structural_and_chemical_features>`, and :ref:`surface area
ratios <molprops_polar_surface_area>` can also be
considered. |product| provides algorithms for calculating many of
these properties and applying them with filters based on literature
studies.

Finally, types of compounds that can be
troublesome at later stages should be eliminated. For instance,
Shoichet's :ref:`aggregating compounds <molprops_aggregators>` often
produce false positives that can waste enormous resources if they are
identified by virtual or HTS ([McGovern-2003]_;
[Seidler-2003]_). Similarly, :ref:`dyes <molprops_dyes>` can appear to
be inhibitors by interfering with colorimetric or fluorometric assays
or by nonspecific binding to the target protein.

.. _filter_theory_variations_of_filters:

Variations of Filters
==============================================

Different types of filters are appropriate under different
circumstances.  Very early in a project, when little or no information
on the structure-activity relationship (SAR) is
available, very strict drug-like filters can be applied.  This
avoids spending chemistry resources to pursue
difficult compounds that may not be modifiable for
appropriate properties. However, when considering compounds to
purchase for HTS, different filters can be applied. Oprea et al.
pointed out that the best molecules for initial HTS are smaller and have
less functionality than drugs but show some activity
[Oprea-2000]_. Therefore, strict lead-like filters can be applied to
ensure that hits identified from HTS can be investigated for potential
leads, especially those that may be larger or more highly functionalized.
However, when SAR suggests that particular compounds or series
may yield valuable information, filtering criteria can be loosened,
because secondary screens can be effective in detecting useful
compounds. Circling back to the medical analogy, this is a case
where an improved primary screen with a dramatically improved
false-positive rate (e.g., 1 in 100,000) can be applied to a
larger population without detrimental effects on the positive-predictive
value.

|product| provides the following filters:

* **BlockBuster**: The BlockBuster filter is based on 141 best-selling, non-antibiotic
  prescription drugs. We designed the physical property portion of the filter
  so that it passes all of the compounds. The physical property values in this
  filter are quite good. However, the functional group filters in this
  filter may be too restrictive because 141 compounds will not span all acceptable functionality.
* Drug: The original drug filter
  is provided as well [Oprea-2000]_, but has been shown to be very restrictive.
  The BlockBuster filter was developed as an alternative.
* Fragment: The fragment filter is designed specifically to filter molecules with attachment points. This filter
  is used inside **CHOMP** to restrict the fragments generated for the **BROOD** database.
* Lead: The Lead filter corresponds to the Oprea
  lead-like filters that are useful for preparing HTS screening databases.
* PAINS: The PAINS filter is based on work by Baell which describes identification
  and filtering of promiscuous (nonspecific) actives across a number of screening
  types and targets [Baell-2010]_.  Unlike the other filter types, the PAINS filter
  consists of only functional group filters; no physical property filters are
  included.  In practice, combination of the PAINS filter with
  a user-defined set of physical property filters may be desirable.

.. hint::

   We recommend the default BlockBuster filter for most
   purposes. If you have specific filtering needs or are unsatisfied with the
   results, please see the :ref:`filter file<filter_files>`.

   If you modify the :ref:`filter file<filter_files>`, the
   depictions found in the :ref:`functional_group_rules` section can be
   particularly helpful in determining which functional groups are
   indicated by each name in the file.

Accumulation of Rules
======================

**FILTER** contains rules to judge the quality of molecules on various properties.
Individually, each of these rules
seems quite reasonable and even profitable. However, when each
molecule is tested against hundreds of individual filters, the
fraction of molecules that pass all the filters can be surprisingly
small. Sometimes less than 50% of vendor databases pass the
filters. If this is unacceptable, we recommend you examine the
predicted aggregator, solubility, and Veber filters. In our
experience, these are the most common failures. The best method of
investigating failures is looking at the filter log.

The BlockBuster filter addresses these challenges. Sometimes the range needs to be expanded
in order to allow more compounds to pass.
For each value, its properties extend from the 2.5th percentile to the 97.5th percentile. The differences
between the original BlockBuster filter and the adjusted filter are both
in reasonable ranges. For instance, the full range of molecular weights for
the BlockBuster filter spans 130 to 781, while the 2.5th percentile is 145
and the 97.5th percentile is 570. Surprisingly, when the
reduced filter is used, only 75 of the 141 original molecules pass the filter!
This demonstrates how slight changes to many filters can lead to a
significant reduction in the number of compounds that pass all filters.

The opposite approach of allowing everything to pass can be
equally challenging. For example, a filter was designed around the
"small molecule drug" file available from the DrugBank `website
<http://redpoll.pharmacy.ualberta.ca/drugbank>`_. In order to pass
all of these molecules, including some that would no longer be
acceptable, many of the individual filters
must be set to unreasonable values, such as a molecular weight
range from 30 to 1500 and a heteroatom count range from 1 to 60.

.. hint::

   Because every project is different, we recommend that you
   inspect each :ref:`filter file<filter_files>`. The depictions found in the
   :ref:`functional_group_rules` section can be particularly helpful
   in discerning what functional groups are desirable and undesirable.



.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry

.. _filter_process:

*********************
Filter Preprocessing
*********************

Before the application of any :ref:`molecular property filters
<molprops>`, a preprocessing step may be used to alter the molecule
significantly to fit the criteria needed for most modeling
applications. This filter preprocessing step is applied to each molecule
in a series of stages in the following order:

#. :ref:`filter_process_metal_removal`
#. :ref:`filter_process_salt_removal`
#. :ref:`filter_process_canonicalization`
#. :ref:`filter_process_pka_normalization`
#. :ref:`filter_process_normalization`
#. :ref:`filter_process_reagent_selection`
#. :ref:`filter_process_type_checking`
#. :ref:`filter_process_mmff_checking`

.. _filter_process_metal_removal:

Metal Removal
==============

Metal removal is the first stage of element-based filtering. This
stage removes specified metal complexes from the molecule.
It will not reject a molecule with a metal complex. This allows
the filter to treat atoms in the counterion portion of a molecule
separately from the atoms in the primary portion of the molecular
record.

For instance, organic molecules that are complexed with
silver can be eliminated based on their metal chelate even though they
themselves are acceptable, while at the same time eliminating a
sulfate counterion from another molecule before it leads to
elimination of the acceptable cationic molecule.

.. seealso:: 

   :ref:`filter_files_elemental_filters`

.. _filter_process_salt_removal:

Salt Removal
=============

This step deletes all atoms that are not part of the largest connected
component of a compound. This effectively eliminates all
non-covalently bound portions of the compound.


.. _filter_process_canonicalization:

Canonicalization
================

This step canonicalizes the atom and bond order of the portion of the
molecule that remains after the previous removal steps. This is
necessary to avoid different atom orderings producing slightly
different normalizations in the following normalization
steps. 

.. _filter_process_pka_normalization:

pKa Normalization
==================

pKa normalization uses a rule-based system to set the ionization state of input
molecules. If pKa normalization is turned on, the molecule is set to
its most energetically favorable ionization state for pH=7.4. The
rule-based nature of this calculation allows it to be very
fast. Furthermore, despite being rule-based, this approach takes into
account many secondary charge interactions.

While more advanced levels of theory can be found for predicting
ionization states, this method is very well suited to
virtual-screening database preparation. However, this may not be
appropriate for hit-to-lead or lead optimization.


.. _filter_process_normalization:

Normalization
=============

In addition to :ref:`pKa normalization<filter_process_pka_normalization>`, |product|
allows any number of additional molecular normalizations. Since
normalizations are usually specific to a particular company or
site, |product| provides the ability for users to input
normalizations, such as the nitro tautomer state, but does not provide
default implementations.


.. _filter_process_reagent_selection:

Reagent Selection
=================

Reagent selection for small linear library synthesis or large
combinatorial library synthesis is usually a necessary task. A user hoping to identify a
set of acyl-halide reagents could specify a selection parameter to
require each compound to have exactly one acyl-halide. In addition,
the filter could be modified to exclude functional groups
(such as primary amines) that may be acceptable for typical lead-like
molecules, but are not acceptable for the specific reagent the user has
in mind.

Therefore, the selection parameter is the reverse of a filtering
parameter. The molecule *must include* the given substructure in order
to pass the filter.

.. seealso::
   
   The :ref:`select parameter<filter_files_selection>` in filter files. 


.. _filter_process_type_checking:

Type Checking
==============

This checks the valence state and formal charge of the entire
molecule. The check identifies molecules that are poorly specified, or
represent nonsensical chemical states, often from corrupt input data.
For example, an oxygen with eight hydrogens attached or a carbon with
a +9 formal charge would be rejected.

.. _filter_process_mmff_checking:

MMFF94 Atom Type Checking
==========================

This checks that all atoms in the molecule have valid MMFF94 atom type
assignments.  The check identifies molecules that will fail downstream
processing that depends on MMFF94 atom types (e.g., **Omega**).




.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry

.. _molprops:

*************************************
Molecular Properties and Predictors
*************************************

|product| provides a range of properties to predictors to be used as
molecular filters. Molecular properties are distinct physical
properties that can be measured, including the following:

* :ref:`molprops_structural_and_chemical_features`
* :ref:`molprops_functional_groups`

There have been several attempts to develop fast-approximate QSAR
models for bioavailability. The first of these
was :ref:`Lipinski's work <molprops_lipinski>` [Lipinski-1997]_,
followed by work at Pharmacopia [Egan-2000]_, Abbott
[Martin-2005]_, and GSK [Veber-2002]_. The simplest and probably most
trusted work includes studies of
:ref:`LogP <molprops_logp>` and :ref:`PSA <molprops_polar_surface_area>` used
by Egan. Martin's Abbott
Bioavailability Score (ABS) appears to be a refinement of the first
generation models and is designed specifically to categorize a
molecule's probability of having a bioavailability >10% in rats.

.. seealso::

   The :ref:`filter_files_pharmacokinetic_predictors` section in the Filter
   Files chapter.

.. _molprops_structural_and_chemical_features:

Structural and Chemical Features
================================

A number of important structural and chemical features of
molecules should be limited for virtual screening. The following
simple measures are provided as filterable properties:

* Molecular weight
* Ring count
* Ring-system size
* Size of non-ring structures
* Length of unbranched chains
* Heteroatom fraction
* Halide fraction
* Formal charges
* Rotatable bonds

MolProp TK also includes slightly more complex algorithms for hydrogen bond donors and
acceptors as well as chiral centers.

.. seealso::

   The :ref:`filter_files_basic_properties` section in the Filter Files chapter.


.. _molprops_functional_groups:

Functional Groups
==================

Functional group removal remains at the heart of the **FILTER** algorithm.
Functional groups fall into several categories, including:

* Reactive or labile groups
* Undesirable groups
* Generally acceptable groups
* Protecting groups
* User-derived groups

Reasonable defaults are provided for each functional group in
the above categories, with the filter files being designed as basic guides.
They can be tailored for each user's particular needs.
Examining the filter file can provide useful information.
Developing a custom filter for a specific task is
strongly encouraged.

.. seealso::

   The filter files contain only functional group names. For
   clarification of the definitions, please refer to
   the :ref:`functional_group_rules` section for complete descriptions.

.. _molprops_dyes:

Dyes
==================

In the past, colored
molecules interfered with many high-throughput assays.
While assay technology continues to advance and this problem has decreased,
most dyes are not commonly carried forward in
lead development projects. Therefore, a pattern-based filter for dye
molecules is included. While these patterns occasionally identify molecules
that are considered acceptable by some users, in general, they identify
molecules that the majority of chemists would rather not see at the top
of their virtual screening hit lists.

.. _molprops_logp:

LogP
==================

The XLOGP algorithm ([Wang-R-1997]_) is provided because its atom type
contribution allows calculation of the XLogP contribution of any
fragment in a molecule and allows minimal corrections in a simple
additive form to calculate the LogP of any molecule made from
combinations of fragments. Further, although the method contains
many free parameters, its simple linear form allows for ready
interpretation of the model, and most of the parameters in the model
make rational sense.

Unfortunately, the original algorithm is difficult to implement as
published. First, the internal hydrogen bond term was calculated using
a single 3D conformation, which was found to be both arbitrary
and unnecessary. This arbitrary 3D calculation has been replaced with
a 2D approach to recognize common internal hydrogen bonds. In tests,
the 2D method worked comparably to the published 3D algorithm. Next,
the training set had a few subtle atom-type inconsistencies.

Both of these problems were corrected and refit to the original XLOGP
training data. This implementation gives results that are quite
similar to the original XLOGP algorithm, so it is called OEXLogP to
distinguish it from the original method.

.. seealso::

   * The :ref:`XLogP parameter<filter_files_xlogp>` in the Filter Files chapter.

.. _molprops_logs:

LogS
==================

The work of Samuel Yalkowsky [Yalkowsky-1980]_ at the University of Arizona has resulted in what is now
called the "generalized solvation equation." It states that the
solubility of a compound can be broken into two steps, first the
melting from the pure solid to pure liquid, and second, the phase
transfer from pure liquid into water. For many small organic
molecules, this second step is somewhat related to LogP.

Because of this relationship, we explored the use of the XLogP
atom types in solubility prediction, with the goal of providing an approximate though robust and fast method for
calculating solubility. We fit the XLogP atom types to a training set
of nearly 1000 public solubility values, then derived a linear
model for solubility. The model is extremely fast and can
classify compounds as insoluble, poorly soluble, slightly soluble,
moderately, soluble, or very soluble. However, it has
difficulty in predicting the solubility of compounds with ionizable
groups. Furthermore, it is not suitable for the PK predictions that come
late in a project. Nevertheless, it can be utilized to eliminate compounds
with severe solubility problems early in the virtual screening
process.

.. seealso::

   The :ref:`solubility parameter<filter_files_solubility>` in the Filter Files chapter.

.. _molprops_polar_surface_area:

Polar Surface Area
==================

Topological polar surface area (TPSA) is based on the algorithm
developed by Ertl et al [Ertl-2000]_. In Ertl's publication, use of
TPSA both with and without accounting for phosphorus and sulfur
surface area is reported. However, evidence shows that in most PK
applications, it is better to avoid counting the contributions of
phosphorus and sulfur atoms toward the total TPSA for a molecule. This
implementation of TPSA allows either inclusion or exclusion of
phosphorus and sulfur surface area, with the default being to exclude it.

.. seealso::

   Including phosphorus and sulfur surface area:

   * The ``PSA_USE_SandP`` parameter in the :ref:`filter file
     <filter_files_PSA>`.

.. warning::

   TPSA values are mildly sensitive to the protonation state of a
   molecule. If the pKaNorm parameter is false, the TPSA value is
   calculated using the input structure, and if pKaNorm is true, the
   TPSA is calculated using the pKa normalized molecular structure.

   .. seealso::

      * The :ref:`pKa normalization<filter_process_pka_normalization>`
        section of the Filter Preprocessing chapter.

.. _molprops_lipinski:

Lipinski and Hydrogen Bonds
===========================

The work of Lipinski [Lipinski-1997]_ introduced the application of
simple filter-like rules to roughly predict late-stage PK properties,
in particular oral bioavailability. Unfortunately, Lipinski's
rule of five has come into the common vernacular to such a large
degree that some of the specific details are often lost. There are two critical examples of this. First, Lipinski
used "violation of two rules" to categorize compounds. In the subsequent
analysis, a significant difference in the two populations of molecules
was detected, however, little analysis of the importance of a single
violation was done. However, many now consider a single violation to
be bad and two violations to be worse. Second, Lipinski used well-codified
and well-understood yet imprecise definitions of "hydrogen bond
donors" and "hydrogen bond acceptors" in his classification model.
While this makes the algorithm quite understandable and easy to
implement, it sometimes causes confusion with those who prefer more
refined definitions of hydrogen bond donors and acceptors.

To address the first problem, users are allowed to set the number of
Lipinski failures required to reject a molecule. In keeping with the
original publication, the default value is 2. To address the second
problem, two kinds of hydrogen bond donors and
acceptors are calculated. In the Lipinski calculation, the published
definitions are used (donor count is the number of nitrogen or oxygen atoms
with at least one hydrogen attached and acceptors are the number of nitrogens
and oxygens). For calculation of the number of donors and acceptors in the
molecule for the sake of chemical properties, a more complex
algorithmic approach is taken. This approach identifies the donors and
acceptors outlined in the work of Mills and Dean [Mills-Dean-1996]_
and also in the book by Jeffrey [Jeffrey-1997]_.

.. seealso::

   The :ref:`Lipinski violations<filter_files_lipinski>`
   and :ref:`hydrogen-bond acceptors<filter_files_hbond_acceptor>` sections
   in the Filter Files chapter.

.. _molprops_aggregators:

Aggregators
==================

The Shoichet lab ([McGovern-2003]_; [Seidler-2003]_)
has demonstrated the importance of small-molecule aggregation in
medium and high-throughput assays. Because these small-molecule
aggregates can sequester some proteins, they give the appearance of
being active inhibitors. There are now several hundred published
aggregators, in addition to a published QSAR model for predicting
aggregation propensity. The user can eliminate any of
the known aggregators and also eliminate compounds
that are predicted to be aggregators using the QSAR model. The published QSAR model for predicting aggregators may be
considered quite aggressive, as it occasionally identifies compounds that are known
to be genuine small-molecule inhibitors of a specific protein. While
in most cases this model can be useful, it is important to gain experience with the model and
judge the performance for specific needs.

In some cases, aggregation
properties are specific to specific experimental conditions, thus
caution should be exercised in the interpretation of these
predictions. Nevertheless, aggregation remains an important issue in
HTS hit follow-up and, short of experimental validation, this flag may
be the best available.

.. seealso::

   The :ref:`aggregators parameter<filter_files_aggregators>` in
   the Filter Files chapter.

.. _PAINS_theory:

PAINS
==================

Pan-assay interference compounds (PAINS) filters are a set of functional group filters
created to identify and filter promiscuous (nonspecific) actives across
a number of screening types and targets [Baell-2010]_.  The original PAINS paper includes
a set of functional group prefilters, created via two iterations of
their work, and three sets of structure class filters, called filter sets
A, B, and C, which were used to identify and remove promiscuous actives.
The OpenEye PAINS filter set is a combination of all four filter sets
(the functional group prefilter set plus the three structural class sets)
into a single filter set.

There are two distinct use cases for the PAINS filters.  The first is the
typical prefiltering of structures prior to screening or compound selection
to remove undesirable molecules.  One can simply eliminate any molecules
which fail the PAINS filtering.

The second use case, which may ultimately be more interesting, is to use the
PAINS filters retrospectively on a set of data which has been filtered (and
tested) using another methodology.  In this scenario, the PAINS filters can be
used to identify potentially problematic reactive functionality in otherwise
reasonable, drug-like structures.  By using the table output mode and 
identifying matches for the A, B, and C filter sets, one can identify fairly
specific chemical functionalities that have been known to result in
nonspecific activity.  This can be useful information for either prioritizing
further lead development or for modifying lead structures to mitigate adverse
reactivity.

There are approximately 650 SMARTS rules which have been converted from the
SLN query strings provided in the supplemental information of the
original paper.  For the functional group filters, the authors do not provide
identifying names for each individual filter, so our PAINS rules are named
based on the comments used to describe each functional group class, prefixed
with the string ``pains_fg_[classname]``.  For the structural class filters,
the authors provided unique RegID values for each filter.  For those cases,
our rules are named based on the PAINS group and RegID
as ``pains_[group]_[RegID]``.

Note that in certain cases, the SLN
queries cannot be represented with a single SMARTS, so in those cases the
rules have been split out into multiple SMARTS patterns and are named
``pains_[group]_[RegID]1``, ``pains_[group]_[RegID]2``, etc.

.. hint:: 

   Unlike the other filter types, the PAINS filter consists only of
   functional group filters; no physical property filters are included.
   It may be desirable to combine the PAINS filter with a separate
   user-defined set of physical property filters.  The
   :ref:`filter file<filter_files>` section describes the creation of additional filter rules.



.. _filter_files:

********************
Filter Files
********************

A user can provide two parameter files if they would like
to override or augment the default parameter sets. The first is
a *filter file*. It provides acceptable limits for all of the physical
properties and functional groups in the default filter. The second is
a ``NEWRULE`` file, which allows you to
augment a filter with a set of additional rules.

There are four types of statements that can occur in a filter file:

* Physical property limits
* Rules
* New rules
* Selections

The statements should occur one per line in the filter file.

.. note::

   If the appropriate line is not in the filter file, or the value is
   false, the respective measure will not be used in filtering and
   its value will not be included in any table-based output.


Physical Property Limits
========================

There are a large number of physical property limits. They occur as
three fields on a line. For example:

::

   MIN_HETEROATOMS 2 "Minimum number of heteroatoms"

The first field is the property keyword, the second field is the value
assigned to that keyword, and the third field is a brief informational
message. There are a fixed number of physical property keywords. No
additional physical property keywords can be added by the user. The
current keywords and brief definitions of each are listed below.

.. hint::

   The values listed below are those found in the default *BlockBuster*
   filter.

.. _filter_files_basic_properties:

Basic Properties
-----------------------

Molecular Weight
^^^^^^^^^^^^^^^^^^^^^^^

Isotopic molecular weight.

::

   MIN_MOLWT 130 "Minimum molecular weight"
   MAX_MOLWT 781 "Maximum molecular weight"


Heavy Atom Count
^^^^^^^^^^^^^^^^^^^^^^^

Number of non-hydrogen atoms.

::

   MIN_NUM_HVY 9 "Minimum number of heavy atoms"
   MAX_NUM_HVY 55 "Maximum number of heavy atoms"

Carbon Count
^^^^^^^^^^^^^^^^^^^^^^^

Number of carbons.

::

   MIN_CARBONS 3 "Minimum number of carbons"
   MAX_CARBONS 41 "Maximum number of carbons"

Hetero Count
^^^^^^^^^^^^^^^^^^^^^^^

Number of non-carbon and non-hydrogen atoms.

::

   MIN_HETEROATOMS 1 "Minimum number of heteroatoms"
   MAX_HETEROATOMS 14 "Maximum number of heteroatoms"


Heteroatom to Carbon Ratio
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Hetero count/carbon count.

::

   MIN_Het_C_Ratio 0.04 "Minimum heteroatom to carbon ratio"
   MAX_Het_C_Ratio 4.0 "Maximum heteroatom to carbon ratio"

Chiral Count
^^^^^^^^^^^^^^^^^^^^^^^

Number of chiral atoms.

::

   MIN_CHIRAL_CENTERS 0 "Minimum chiral centers"
   MAX_CHIRAL_CENTERS 21 "Maximum chiral centers"

.. _filter_files_hbond_acceptor:
.. _filter_files_hydrogen_bonds:

Hydrogen Bond Acceptors
^^^^^^^^^^^^^^^^^^^^^^^

.. Depiction here would be helpful

Number of atoms which match any of the following:

* Degree 2, aromatic, nonpositive nitrogens. An example is shown below.

.. figure:: /_images/acceptorDef1.png
   :align:  center
   :width:  60%

* Electron rich (negative), valence less than 4, nonaromatic nitrogens.
  An example is shown below.

.. figure:: /_images/acceptorDef2.png
   :align:  center
   :width:  60%

* Negatively charged (does not withdraw electrons), neutral, nonaromatic oxygens.
  An example is shown below.

.. figure:: /_images/acceptorDef3.png
   :align:  center
   :width:  60%

* Degree 1, double bonded, electron rich, nonaromatic sulfur. An example
  is shown below.

.. figure:: /_images/acceptorDef4.png
   :align:  center
   :width:  60%

This definition is from the work of Mills and Dean [Mills-Dean-1996]_
and also by Jeffrey [Jeffrey-1997]_.

::

   MIN_HBOND_ACCEPTORS 0 "Minimum number of hydrogen-bond acceptors"
   MAX_HBOND_ACCEPTORS 13 "Maximum number of hydrogen-bond acceptors"

.. seealso::

   * :ref:`OEGetHBondAcceptorCount <OEMolProp_OEGetHBondAcceptorCount>` function
   * :ref:`molprops_lipinski` section

.. _filter_files_hbond_donor:

Hydrogen Bond Donors
^^^^^^^^^^^^^^^^^^^^^^^

Number of hydrogen atoms on nitrogen, oxygen, or sulfur atoms. This
definition is from the work of Mills and Dean ([Mills-Dean-1996]_)
and also the book by Jeffrey ([Jeffrey-1997]_).

::

   MIN_HBOND_DONORS 0 "Minimum number of hydrogen-bond donors"
   MAX_HBOND_DONORS 9 "Maximum number of hydrogen-bond donors"

.. seealso::

   * :ref:`OEGetHBondDonorCount <OEMolProp_OEGetHBondDonorCount>` function
   * :ref:`molprops_lipinski` section

.. _filter_files_lipinski_acceptor:

Lipinski Acceptors
^^^^^^^^^^^^^^^^^^^^^^^

Number of nitrogens or oxygens. This definition is from
the work of Lipinski [Lipinski-1997]_.

::

   MIN_LIPINSKI_ACCEPTORS 1 "Minimum number of oxygen & nitrogen atoms"
   MAX_LIPINSKI_ACCEPTORS 14 "Maximum number of oxygen & nitrogen atoms"

.. seealso::

   * :ref:`OEGetLipinskiAcceptorCount <OEMolProp_OEGetLipinskiAcceptorCount>` function
   * :ref:`molprops_lipinski` section

.. _filter_files_lipinski_donor:

Lipinski Donors
^^^^^^^^^^^^^^^^^^^^^^^

Number of nitrogens and oxygens with at least one hydrogen attached.
This definition is from the work of Lipinski [Lipinski-1997]_.

::

   MIN_LIPINSKI_DONORS 0 "Minimum number O & N atoms with hydrogens"
   MAX_LIPINSKI_DONORS 6 "Maximum number O & N atoms with hydrogens"

.. seealso::

   * :ref:`OEGetLipinskiDonorCount <OEMolProp_OEGetLipinskiDonorCount>` function
   * :ref:`molprops_lipinski` section

.. _filter_files_halide_fraction:

Halide Fraction
^^^^^^^^^^^^^^^^^^^^^^^

Percent of molecular weight from halides.

::

   MIN_HALIDE_FRACTION 0.0 "Minimum Halide Fraction"
   MAX_HALIDE_FRACTION 0.66 "Maximum Halide Fraction"

.. seealso::

   * :ref:`OEGetHalideFraction <OEMolProp_OEGetHalideFraction>` function

Formal Count
^^^^^^^^^^^^^^^^^^^^^^^

Number of atoms with a formal charge (excludes dative).

::

   MIN_COUNT_FORMAL_CRG 0 "Minimum number formal charges"
   MAX_COUNT_FORMAL_CRG 4 "Maximum number of formal charges"

Formal Sum
^^^^^^^^^^^^^^^^^^^^^^^

Total formal charge.

::

   MIN_SUM_FORMAL_CRG -2 "Minimum sum of formal charges"
   MAX_SUM_FORMAL_CRG 2 "Maximum sum of formal charges"

Connected Non-Ring
^^^^^^^^^^^^^^^^^^^^^^^

.. Need a depiction to explain this

Considers sets of contiguous (bonded) non-ring atoms.

::

   MIN_CON_NON_RING 0 "Minimum number of connected non-ring atoms"
   MAX_CON_NON_RING 19 "Maximum number of connected non-ring atoms"

.. _filter_files_unbranched_chains:

Unbranched Chains
^^^^^^^^^^^^^^^^^^^^^^^

The size of the longest chain of either heavy atoms or of all carbons.
An unbranched atom is an atom with at most two connections to other heavy
atoms and is not in a ring.  A set of unbranched atoms which are
connected together form a chain.  A molecule may contain multiple chains
which are isolated from each other by non-chain atoms (e.g., ring or
branched atoms).  The longest chain of heavy atoms and the longest
chain of carbons are identified, and the MIN and MAX parameter filters
are applied.

::

   MIN_UNBRANCHED 1 "Minimum number of connected unbranched non-ring atoms"
   MAX_UNBRANCHED 13 "Maximum number of connected unbranched non-ring atoms"
   MIN_UNBRANCHED_C 0 "Minimum number of connected unbranched non-ring carbon"
   MAX_UNBRANCHED_C 6 "Maximum number of connected unbranched non-ring carbon"

.. seealso::

   * :ref:`OEGetLongestUnbranchedHeavyAtomsChain <OEMolProp_OEGetLongestUnbranchedHeavyAtomsChain>` function
   * :ref:`OEGetLongestUnbranchedCarbonsChain <OEMolProp_OEGetLongestUnbranchedCarbonsChain>` function

Total Functional Group Count
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Total number of functional groups. Does not count any ring systems as
functional groups. Degree 1 heteroatoms, particularly those with
double bonds or dative bonds are considered part of ring systems and
do not count as functional groups.

::

   MIN_FCNGRP 0 "Minimum number of functional groups"
   MAX_FCNGRP 7 "Maximum number of functional groups"

.. (not just those recognized by filter patterns)

.. note::

   This is different than the functional group rules.

Ring Systems
^^^^^^^^^^^^^^^^^^^^^^^

.. Depiction here would be helpful

Number of ring systems (contiguous systems of ring atoms and bonds).

::

   MIN_RING_SYS 0 "Minimum number of ring systems"
   MAX_RING_SYS 5 "Maximum number of ring systems"

Ring Size
^^^^^^^^^^^^^^^^^^^^^^^

Maximum size of any single ring system.

::

   MIN_RING_SIZE 0 "Minimum atoms in any ring system"
   MAX_RING_SIZE 20 "Maximum atoms in any ring system"

.. _filter_files_rotor_count:

Rotor Count
^^^^^^^^^^^^^^^^^^^^^^^

Number of rotatable bonds. Allows optional adjustment for aliphatic
rings following the method of Oprea [Oprea-2000]_.

::

   MIN_ROT_BONDS 0 "Minimum number of rotatable bonds"
   MAX_ROT_BONDS 16 "Maximum number of rotatable bonds"
   ADJUST_ROT_FOR_RING true "BOOLEAN for whether to estimate degrees of freedom in rings"

.. seealso::

   * :ref:`OEGetRotatableBondCount <OEMolProp_OEGetRotatableBondCount>` function

Rigid Count
^^^^^^^^^^^^^^^^^^^^^^^

Number of rigid bonds (non-rotatable bonds).

::

   MIN_RIGID_BONDS 4 "Minimum number of rigid bonds"
   MAX_RIGID_BONDS 55 "Maximum number of rigid bonds"

.. _filter_files_unspecified_atom_stereos:

Unspecified Atom Stereo
^^^^^^^^^^^^^^^^^^^^^^^

Number of unspecified atom stereos

::

   MIN_UNSPECIFIED_ATOM_STEREOS 0 "Minimum number of unspecified atom stereos"
   MAX_UNSPECIFIED_ATOM_STEREOS 2 "Maximum number of unspecified atom stereos"

.. note::

   ``MIN_UNSPECIFIED_ATOM_STEREOS`` and ``MAX_UNSPECIFIED_ATOM_STEREOS`` are not 
   used for filtering in the default filters.

.. seealso::

   * :ref:`OEGetNumUnspecifiedAtomStereos <OEMolProp_OEGetNumUnspecifiedAtomStereos>` function
   * :term:`stereo atom`
   * :ref:`chapter_stereochemistry` chapter
   * :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified`

.. _filter_files_unspecified_bond_stereos:

Unspecified Bond Stereo
^^^^^^^^^^^^^^^^^^^^^^^

Number of unspecified bond stereos

::

   MIN_UNSPECIFIED_BOND_STEREOS 0 "Minimum number of unspecified bond stereos"
   MAX_UNSPECIFIED_BOND_STEREOS 2 "Maximum number of unspecified bond stereos"

.. note::

   ``MIN_UNSPECIFIED_BOND_STEREOS`` and ``MAX_UNSPECIFIED_BOND_STEREOS`` are not
   used for filtering in the default filters.

.. seealso::

   * :ref:`OEGetNumUnspecifiedBondStereos <OEMolProp_OEGetNumUnspecifiedBondStereos>` function
   * :term:`stereo bond`
   * :ref:`chapter_stereochemistry` chapter
   * :oe:meth:`OEChem::OEBondBase::HasStereoSpecified`

.. _filter_files_typecheck:

Atom Type Checks
^^^^^^^^^^^^^^^^^^^^^^^

Checks the validity of atom charges, valences or MMFF atom types for
the entire molecule.

::

   TYPECHECK     false "Screen for unusual valences or charges"
   MMFFTYPECHECK false "Screen for atoms with unknown MMFF atom types"

.. seealso::

   * :ref:`filter_process_type_checking`
   * :ref:`SetTypeCheck <OEMolProp_OEFilter_SetTypeCheck>`
   * :ref:`filter_process_mmff_checking`
   * :ref:`SetMMFFTypeCheck <OEMolProp_OEFilter_SetMMFFTypeCheck>`

.. _filter_files_xlogp:

LogP
-----------------------

The logP calculation is a derivative of the published XLOGP algorithm
[Wang-R-1997]_ but is reparameterized without the dependence on 3D
coordinates or the SYBYL/Mol2 aromaticity model.

XLogP
^^^^^^^^^^^^^^^^^^^^^^^

Calculated LogP.

::

   MIN_XLOGP -3.0 "Minimum XLogP"
   MAX_XLOGP 6.85 "Maximum XLogP"

.. _filter_files_solubility:

Solubility
-----------------------

The solubility predictions are based on the atom types from the
XLOGP algorithm (see [Wang-R-1997]_) and on reparameterized atom types based on
available solubility data. Rather than a quantitative cutoff, the
solubility uses six allowable categories:

1. Insoluble
2. Poorly
3. Moderately
4. Soluble
5. Very
6. Highly

These categories are keywords used in the following filter files.

Solubility
^^^^^^^^^^^^^^^^^^^^^^^

Calculated solubility class.

::

   MIN_SOLUBILITY insoluble "Minimum solubility"

.. _filter_files_pharmacokinetic_predictors:

Pharmacokinetic Predictors
--------------------------

Several secondary filters that are built upon published combinations
of simpler properties are available.

.. note::

   All of these properties are used for filtering in the default
   filters.

.. _filter_files_anionic_carbon:

Anionic Carbon Count
--------------------------

Number of anionic carbons

::

   MIN_ANION_C 0 "Minimum number of anionic carbons"
   MAX_ANION_C 2 "Maximum number of anionic carbons"

.. note::

   ``MIN_ANION_C`` and ``MAX_ANION_C`` are not used for filtering in the default
   filters.

.. seealso::

   * :ref:`OEGetAnionicCarbonCount <OEMolProp_OEGetAnionicCarbonCount>` function

.. _filter_files_lipinski:

Lipinski Violations
^^^^^^^^^^^^^^^^^^^^^^^

Number of allowable Lipinski violations. A single Lipinski violation
is considered acceptable. The published work allows
compounds to pass with a single violation but not multiple violations [Lipinski-1997]_.

::

   MAX_LIPINSKI 3 "Maximum number of Lipinski violations"

.. seealso::

   The :ref:`Lipinski theory<molprops_lipinski>` section in the Molecular Properties
   and Predictors chapter.

.. _filter_files_PSA:

PSA
^^^^^^^^^^^^^^^^^^^^^^^

Peter Ertl's topological polar surface area (phosphorus
and sulfur areas are optional) [Ertl-2000]_.

::

   PSA_USE_SandP false "Count S and P as polar atoms"
   MIN_2D_PSA 0.0 "Minimum 2-Dimensional (SMILES) Polar Surface Area"
   MAX_2D_PSA 205.0 "Maximum 2-Dimensional (SMILES) Polar Surface Area"

.. seealso::

   The :ref:`PSA theory<molprops_polar_surface_area>` section in the Molecular
   Properties and Predictors chapter.


GSK/Veber
^^^^^^^^^^^^^^^^^^^^^^^

Veber's measure of bioavailability (PSA > 140 or Rotatable bonds >10)
[Veber-2002]_.

::

   GSK_VEBER false "PSA>140 or >10 rot bonds"


Abbott/Martin
^^^^^^^^^^^^^^^^^^^^^^^

Yvonne Martin's Abbott Bioavailability Score [Martin-2005]_. This is reported as a
probability that ``F>10%`` in rats.

::

   MIN_ABS 0.11 "Minimum probability F>10% in rats"

Pharmacopia/Egan
^^^^^^^^^^^^^^^^^^^^^^^

"Egan egg" measure of bioavailability (LogP >5.88 or PSA >
131.6) [Egan-2000]_.

::

   PHARMACOPIA false "LogP > 5.88 or PSA > 131.6"

.. _filter_files_aggregators:

Aggregators
-----------------------

Aggregators are small molecules that can interfere with assay results
by sequestering proteins in an aggregation of small molecules in
solution. They appear to have activity in many assays, but in fact are
usually not specific inhibitors of the protein in question. This includes
two measures of whether a molecule is one of the aggregators defined
by Shoichet et al. ([McGovern-2003]_; [Seidler-2003]_). The first
measure, ``AGGREGATORS``, states whether the molecule is an exact match to
one of the approximately 400 published aggregators. The second
measure, ``PRED_AGG``, states whether the molecule is included in Shoichet's QSAR
model for predicting aggregators.

Aggregators
^^^^^^^^^^^^^^^^^^^^^^^

Whether a compound is known or predicted to aggregate in
concentrations common in virtual screening.

::

   AGGREGATORS true "Eliminate known aggregators"
   PRED_AGG false "Eliminate predicted aggregators"

.. _filter_files_elemental_filters:

Elemental Filters
----------------------

The elemental filters are applied in this order:

1. Test for the existence of any of the metals in the ``ELIMINATE_METALS`` filter in the molecule.
2. Remove salts by stripping away all the disconnected components except for the largest.
3. Test to make sure only atoms specified in ``ALLOWED_ELEMENTS`` filter are in the molecule.

.. seealso::

   * :ref:`filter_process_metal_removal`
   * :ref:`filter_process_salt_removal`

The format of the two elemental filter fields is the keyword followed
by a comma-delimited list of atomic symbols.

..  _ELIMINATE_METALS:


Eliminate Metals
^^^^^^^^^^^^^^^^^^^^^^^

Any molecule with the atoms indicated in ``ELIMINATE_METALS`` fail to
pass the filter.

::

   ELIMINATE_METALS Sc,Ti,V,Cr,Mn,Fe,Co,Ni,Cu,Zn,Y,Zr,Nb,Mo,Tc,Ru,Rh,Pd,Ag,Cd

..  _ALLOWED_ELEMENTS:

Allowed Elements
^^^^^^^^^^^^^^^^^^^^^^^

Molecules with atoms other than those specified by
``ALLOWED_ELEMENTS`` fail to pass the filter.

::

   ALLOWED_ELEMENTS H,C,N,O,F,P,S,Cl,Br,I

Aromatic Ring Count
^^^^^^^^^^^^^^^^^^^^

Uses the result of the function OEGetAromaticRingCount (see toolkit docs) to filter molecules
based on their number of aromatic rings.

::

   MIN_AROMATIC_RING_COUNT 1 "Minimum aromatic ring count"
   MAX_AROMATIC_RING_COUNT 6 "Maximum aromatic ring count"

CSP3 Carbon Fraction
^^^^^^^^^^^^^^^^^^^^

Uses the result of the :ref:`OEGetFractionCsp3 <OEMolProp_OEGetFractionCsp3>` function from MolProp TK to filter molecules based
on their CSP3 carbon fraction.

::

   MIN_FRACTION_CSP3 0.1 "Minimum fraction CSP3 carbons"
   MAX_FRACTION_CSP3 0.5 "Maximum fraction CSP3 carbons"


.. _functional_group_rules:

Functional Group Rules
===============================================================================


Rules statements set the limits for the maximum number of the
specified type of functional group that may be allowed in the
molecule.

The first field of a rule statement is the word RULE in all capital
letters. The second field is a number indicating the maximum number of
the group allowed in a molecule. The third field is the functional
group keyword. Functional group keywords are case sensitive.

::

   RULE 0 acid_halide

The following is a list of functional groups which the filter recognizes
by default. Three example matches are provided with the atoms that
correspond to each other highlighted.

.. note::

   Due to the highly complex nature of the patterns, in particular
   recursive SMARTS, it is not possible to fully highlight every atom
   that was included as part of the match.


acetal
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/acetal-001.png
     - .. image:: ../../../common/images/molprop/acetal-002.png
     - .. image:: ../../../common/images/molprop/acetal-003.png

acid
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/acid-001.png
     - .. image:: ../../../common/images/molprop/acid-002.png
     - .. image:: ../../../common/images/molprop/acid-003.png

acid_chloride
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/acid_chloride-001.png
     - .. image:: ../../../common/images/molprop/acid_chloride-002.png
     - .. image:: ../../../common/images/molprop/acid_chloride-003.png

acid_halide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/acid_halide-001.png
     - .. image:: ../../../common/images/molprop/acid_halide-002.png
     - .. image:: ../../../common/images/molprop/acid_halide-003.png

acyclic_NCN
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/acyclic_NCN-001.png
     - .. image:: ../../../common/images/molprop/acyclic_NCN-002.png
     - .. image:: ../../../common/images/molprop/acyclic_NCN-003.png

acyclic_NS
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/acyclic_NS-001.png
     - .. image:: ../../../common/images/molprop/acyclic_NS-002.png
     - .. image:: ../../../common/images/molprop/acyclic_NS-003.png

acyl_cyanides
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/acyl_cyanides-001.png
     - .. image:: ../../../common/images/molprop/acyl_cyanides-002.png
     - .. image:: ../../../common/images/molprop/acyl_cyanides-003.png

acylhydrazide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0


   * - .. image:: ../../../common/images/molprop/acylhydrazide-001.png
     - .. image:: ../../../common/images/molprop/acylhydrazide-002.png
     - .. image:: ../../../common/images/molprop/acylhydrazide-003.png

alcohol
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/alcohol-001.png
     - .. image:: ../../../common/images/molprop/alcohol-002.png
     - .. image:: ../../../common/images/molprop/alcohol-003.png

aldehyde
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/aldehyde-001.png
     - .. image:: ../../../common/images/molprop/aldehyde-002.png
     - .. image:: ../../../common/images/molprop/aldehyde-003.png

alkene
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/alkene-001.png
     - .. image:: ../../../common/images/molprop/alkene-002.png
     - .. image:: ../../../common/images/molprop/alkene-003.png

alkyl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/alkyl-001.png
     - .. image:: ../../../common/images/molprop/alkyl-002.png
     - .. image:: ../../../common/images/molprop/alkyl-003.png

alkyl_halide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/alkyl_halide-001.png
     - .. image:: ../../../common/images/molprop/alkyl_halide-002.png
     - .. image:: ../../../common/images/molprop/alkyl_halide-003.png

alkyl_phosphate
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/alkyl_phosphate-001.png
     - .. image:: ../../../common/images/molprop/alkyl_phosphate-002.png
     - .. image:: ../../../common/images/molprop/alkyl_phosphate-003.png

alkylaniline
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/alkylaniline-001.png
     - .. image:: ../../../common/images/molprop/alkylaniline-002.png
     - .. image:: ../../../common/images/molprop/alkylaniline-003.png

alkylating_agent
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/alkylating_agent-001.png
     - .. image:: ../../../common/images/molprop/alkylating_agent-002.png
     - .. image:: ../../../common/images/molprop/alkylating_agent-003.png

alkyne
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/alkyne-001.png
     - .. image:: ../../../common/images/molprop/alkyne-002.png
     - .. image:: ../../../common/images/molprop/alkyne-003.png

alphahalo_amine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/alphahalo_amine-001.png
     - .. image:: ../../../common/images/molprop/alphahalo_amine-002.png
     - .. image:: ../../../common/images/molprop/alphahalo_amine-003.png

alphahalo_ketone
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/alphahalo_ketone-001.png
     - .. image:: ../../../common/images/molprop/alphahalo_ketone-002.png
     - .. image:: ../../../common/images/molprop/alphahalo_ketone-003.png

amide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/amide-001.png
     - .. image:: ../../../common/images/molprop/amide-002.png
     - .. image:: ../../../common/images/molprop/amide-003.png

aminal
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/aminal-001.png
     - .. image:: ../../../common/images/molprop/aminal-002.png
     - .. image:: ../../../common/images/molprop/aminal-003.png

amine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/amine-001.png
     - .. image:: ../../../common/images/molprop/amine-002.png
     - .. image:: ../../../common/images/molprop/amine-003.png

amino_acid
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/amino_acid-001.png
     - .. image:: ../../../common/images/molprop/amino_acid-002.png
     - .. image:: ../../../common/images/molprop/amino_acid-003.png

anhydride
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/anhydride-001.png
     - .. image:: ../../../common/images/molprop/anhydride-002.png
     - .. image:: ../../../common/images/molprop/anhydride-003.png

aniline
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/aniline-001.png
     - .. image:: ../../../common/images/molprop/aniline-002.png
     - .. image:: ../../../common/images/molprop/aniline-003.png

aniline_unsubstituted
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/aniline_unsubstituted-001.png
     - .. image:: ../../../common/images/molprop/aniline_unsubstituted-002.png
     - .. image:: ../../../common/images/molprop/aniline_unsubstituted-003.png

arene
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/arene-001.png
     - .. image:: ../../../common/images/molprop/arene-002.png
     - .. image:: ../../../common/images/molprop/arene-003.png

arenesulfonyl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/arenesulfonyl-001.png
     - .. image:: ../../../common/images/molprop/arenesulfonyl-002.png
     - .. image:: ../../../common/images/molprop/arenesulfonyl-003.png

aryl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/aryl-001.png
     - .. image:: ../../../common/images/molprop/aryl-002.png
     - .. image:: ../../../common/images/molprop/aryl-003.png

aryl_halide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/aryl_halide-001.png
     - .. image:: ../../../common/images/molprop/aryl_halide-002.png
     - .. image:: ../../../common/images/molprop/aryl_halide-003.png

aryl_mono_BrI
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/aryl_mono_BrI-001.png
     - .. image:: ../../../common/images/molprop/aryl_mono_BrI-002.png
     - .. image:: ../../../common/images/molprop/aryl_mono_BrI-003.png

azide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/azide-001.png
     - .. image:: ../../../common/images/molprop/azide-002.png
     - .. image:: ../../../common/images/molprop/azide-003.png

aziridine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/aziridine-001.png
     - .. image:: ../../../common/images/molprop/aziridine-002.png
     - .. image:: ../../../common/images/molprop/aziridine-003.png

azo
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/azo-001.png
     - .. image:: ../../../common/images/molprop/azo-002.png
     - .. image:: ../../../common/images/molprop/azo-003.png

azocyanamides
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/azocyanamides-001.png
     - .. image:: ../../../common/images/molprop/azocyanamides-002.png
     - .. image:: ../../../common/images/molprop/azocyanamides-003.png

base
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/base-001.png
     - .. image:: ../../../common/images/molprop/base-002.png
     - .. image:: ../../../common/images/molprop/base-003.png

benzyl_ether
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/benzyl_ether-001.png
     - .. image:: ../../../common/images/molprop/benzyl_ether-002.png
     - .. image:: ../../../common/images/molprop/benzyl_ether-003.png

benzyloxycarbonyl_CBZ
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/benzyloxycarbonyl_CBZ-001.png
     - .. image:: ../../../common/images/molprop/benzyloxycarbonyl_CBZ-002.png
     - .. image:: ../../../common/images/molprop/benzyloxycarbonyl_CBZ-003.png

beta_azo_carbonyl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/beta_azo_carbonyl-001.png
     - .. image:: ../../../common/images/molprop/beta_azo_carbonyl-002.png
     - .. image:: ../../../common/images/molprop/beta_azo_carbonyl-003.png

beta_carbonyl_quat_nitrogen
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/beta_carbonyl_quat_nitrogen-001.png
     - .. image:: ../../../common/images/molprop/beta_carbonyl_quat_nitrogen-002.png
     - .. image:: ../../../common/images/molprop/beta_carbonyl_quat_nitrogen-003.png

beta_halo_carbonyl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/beta_halo_carbonyl-001.png
     - .. image:: ../../../common/images/molprop/beta_halo_carbonyl-002.png
     - .. image:: ../../../common/images/molprop/beta_halo_carbonyl-003.png


carbamate
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/carbamate-001.png
     - .. image:: ../../../common/images/molprop/carbamate-002.png
     - .. image:: ../../../common/images/molprop/carbamate-003.png

carbamic_acid
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/carbamic_acid-001.png
     - .. image:: ../../../common/images/molprop/carbamic_acid-002.png
     - .. image:: ../../../common/images/molprop/carbamic_acid-003.png

carbodiimide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/carbodiimide-001.png
     - .. image:: ../../../common/images/molprop/carbodiimide-002.png
     - .. image:: ../../../common/images/molprop/carbodiimide-003.png

carbonate
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/carbonate-001.png
     - .. image:: ../../../common/images/molprop/carbonate-002.png
     - .. image:: ../../../common/images/molprop/carbonate-003.png

carbonyl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/carbonyl-001.png
     - .. image:: ../../../common/images/molprop/carbonyl-002.png
     - .. image:: ../../../common/images/molprop/carbonyl-003.png

carboxylic_acid
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/carboxylic_acid-001.png
     - .. image:: ../../../common/images/molprop/carboxylic_acid-002.png
     - .. image:: ../../../common/images/molprop/carboxylic_acid-003.png

cation_C_Cl_I_P_or_S
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/cation_C_Cl_I_P_or_S-001.png
     - .. image:: ../../../common/images/molprop/cation_C_Cl_I_P_or_S-002.png
     - .. image:: ../../../common/images/molprop/cation_C_Cl_I_P_or_S-003.png

charge
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/charge-001.png
     - .. image:: ../../../common/images/molprop/charge-002.png
     - .. image:: ../../../common/images/molprop/charge-003.png

cyanohydrins
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/cyanohydrins-001.png
     - .. image:: ../../../common/images/molprop/cyanohydrins-002.png
     - .. image:: ../../../common/images/molprop/cyanohydrins-003.png

cycloheximide_derivatives
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/cycloheximide_derivatives-001.png
     - .. image:: ../../../common/images/molprop/cycloheximide_derivatives-002.png
     - .. image:: ../../../common/images/molprop/cycloheximide_derivatives-003.png

cyclopropyl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/cyclopropyl-001.png
     - .. image:: ../../../common/images/molprop/cyclopropyl-002.png
     - .. image:: ../../../common/images/molprop/cyclopropyl-003.png

cytochalasin_derivatives
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/cytochalasin_derivatives-001.png
     - .. image:: ../../../common/images/molprop/cytochalasin_derivatives-002.png
     - .. image:: ../../../common/images/molprop/cytochalasin_derivatives-003.png

di_peptide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/di_peptide-001.png
     - .. image:: ../../../common/images/molprop/di_peptide-002.png
     - .. image:: ../../../common/images/molprop/di_peptide-003.png

dioxane_6MR
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/dioxane_6MR-001.png
     - .. image:: ../../../common/images/molprop/dioxane_6MR-002.png
     - .. image:: ../../../common/images/molprop/dioxane_6MR-003.png

dioxolane_5MR
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/dioxolane_5MR-001.png
     - .. image:: ../../../common/images/molprop/dioxolane_5MR-002.png
     - .. image:: ../../../common/images/molprop/dioxolane_5MR-003.png

disulfide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/disulfide-001.png
     - .. image:: ../../../common/images/molprop/disulfide-002.png
     - .. image:: ../../../common/images/molprop/disulfide-003.png

dithioacetal
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/dithioacetal-001.png
     - .. image:: ../../../common/images/molprop/dithioacetal-002.png
     - .. image:: ../../../common/images/molprop/dithioacetal-003.png

dye
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/dye-001.png
     - .. image:: ../../../common/images/molprop/dye-002.png
     - .. image:: ../../../common/images/molprop/dye-003.png

enamine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/enamine-001.png
     - .. image:: ../../../common/images/molprop/enamine-002.png
     - .. image:: ../../../common/images/molprop/enamine-003.png

enol_ether
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/enol_ether-001.png
     - .. image:: ../../../common/images/molprop/enol_ether-002.png
     - .. image:: ../../../common/images/molprop/enol_ether-003.png

epoxide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/epoxide-001.png
     - .. image:: ../../../common/images/molprop/epoxide-002.png
     - .. image:: ../../../common/images/molprop/epoxide-003.png

ester
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/ester-001.png
     - .. image:: ../../../common/images/molprop/ester-002.png
     - .. image:: ../../../common/images/molprop/ester-003.png

ether
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/ether-001.png
     - .. image:: ../../../common/images/molprop/ether-002.png
     - .. image:: ../../../common/images/molprop/ether-003.png

fluorenylmethoxycarbonyl_Fmoc
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/fluorenylmethoxycarbonyl_Fmoc-001.png
     -
     -

guanidine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/guanidine-001.png
     - .. image:: ../../../common/images/molprop/guanidine-002.png
     - .. image:: ../../../common/images/molprop/guanidine-003.png

halide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/halide-001.png
     - .. image:: ../../../common/images/molprop/halide-002.png
     - .. image:: ../../../common/images/molprop/halide-003.png

halo_alkene
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/halo_alkene-001.png
     - .. image:: ../../../common/images/molprop/halo_alkene-002.png
     - .. image:: ../../../common/images/molprop/halo_alkene-003.png


.. _functional_group_rules_halo_amine:

halo_amine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/halo_amine-001.png
     - .. image:: ../../../common/images/molprop/halo_amine-002.png
     - .. image:: ../../../common/images/molprop/halo_amine-003.png

halopyrimidine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/halopyrimidine-001.png
     - .. image:: ../../../common/images/molprop/halopyrimidine-002.png
     - .. image:: ../../../common/images/molprop/halopyrimidine-003.png

hemiacetal
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/hemiacetal-001.png
     - .. image:: ../../../common/images/molprop/hemiacetal-002.png
     - .. image:: ../../../common/images/molprop/hemiacetal-003.png

hemiaminal
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/hemiaminal-001.png
     - .. image:: ../../../common/images/molprop/hemiaminal-002.png
     - .. image:: ../../../common/images/molprop/hemiaminal-003.png

hemiketal
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/hemiketal-001.png
     - .. image:: ../../../common/images/molprop/hemiketal-002.png
     - .. image:: ../../../common/images/molprop/hemiketal-003.png

hetatm
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/hetatm-001.png
     - .. image:: ../../../common/images/molprop/hetatm-002.png
     - .. image:: ../../../common/images/molprop/hetatm-003.png

hetero_hetero
-------------------------------------------------------------------------------

.. list-table: IGNORING DUE TO NO EXAMPLE FOUND IN EMOLECULES
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/hetero_hetero-001.png
     - .. image:: ../../../common/images/molprop/hetero_hetero-002.png
     - .. image:: ../../../common/images/molprop/hetero_hetero-003.png

HOBT_esters
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/HOBT_esters-001.png
     - .. image:: ../../../common/images/molprop/HOBT_esters-002.png
     -

hydrazine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/hydrazine-001.png
     - .. image:: ../../../common/images/molprop/hydrazine-002.png
     - .. image:: ../../../common/images/molprop/hydrazine-003.png

hydrazone
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/hydrazone-001.png
     - .. image:: ../../../common/images/molprop/hydrazone-002.png
     - .. image:: ../../../common/images/molprop/hydrazone-003.png

hydroxamic_acid
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/hydroxamic_acid-001.png
     - .. image:: ../../../common/images/molprop/hydroxamic_acid-002.png
     - .. image:: ../../../common/images/molprop/hydroxamic_acid-003.png

hydroxyl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/hydroxyl-001.png
     - .. image:: ../../../common/images/molprop/hydroxyl-002.png
     - .. image:: ../../../common/images/molprop/hydroxyl-003.png

hydroxylamine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/hydroxylamine-001.png
     - .. image:: ../../../common/images/molprop/hydroxylamine-002.png
     - .. image:: ../../../common/images/molprop/hydroxylamine-003.png

imidoyl_chlorides
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/imidoyl_chlorides-001.png
     - .. image:: ../../../common/images/molprop/imidoyl_chlorides-002.png
     - .. image:: ../../../common/images/molprop/imidoyl_chlorides-003.png

imine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/imine-001.png
     - .. image:: ../../../common/images/molprop/imine-002.png
     - .. image:: ../../../common/images/molprop/imine-003.png

imino
------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/imino-001.png
     - .. image:: ../../../common/images/molprop/imino-002.png
     - .. image:: ../../../common/images/molprop/imino-003.png

iodine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/iodine-001.png
     - .. image:: ../../../common/images/molprop/iodine-002.png
     - .. image:: ../../../common/images/molprop/iodine-003.png

iodoso
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/iodoso-001.png
     - .. image:: ../../../common/images/molprop/iodoso-002.png
     - .. image:: ../../../common/images/molprop/iodoso-003.png

iodoxy
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/iodoxy-001.png
     - .. image:: ../../../common/images/molprop/iodoxy-002.png
     - .. image:: ../../../common/images/molprop/iodoxy-003.png

isocyanate
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/isocyanate-001.png
     - .. image:: ../../../common/images/molprop/isocyanate-002.png
     - .. image:: ../../../common/images/molprop/isocyanate-003.png

isonitrile
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/isonitrile-001.png
     - .. image:: ../../../common/images/molprop/isonitrile-002.png
     - .. image:: ../../../common/images/molprop/isonitrile-003.png

isothiocyanate
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/isothiocyanate-001.png
     - .. image:: ../../../common/images/molprop/isothiocyanate-002.png
     - .. image:: ../../../common/images/molprop/isothiocyanate-003.png

ketal
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/ketal-001.png
     - .. image:: ../../../common/images/molprop/ketal-002.png
     - .. image:: ../../../common/images/molprop/ketal-003.png

ketone
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/ketone-001.png
     - .. image:: ../../../common/images/molprop/ketone-002.png
     - .. image:: ../../../common/images/molprop/ketone-003.png

lactam
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/lactam-001.png
     - .. image:: ../../../common/images/molprop/lactam-002.png
     - .. image:: ../../../common/images/molprop/lactam-003.png

lactone
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/lactone-001.png
     - .. image:: ../../../common/images/molprop/lactone-002.png
     - .. image:: ../../../common/images/molprop/lactone-003.png

lawesson_s_reagent
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/lawesson_s_reagent-001.png
     - .. image:: ../../../common/images/molprop/lawesson_s_reagent-002.png
     - .. image:: ../../../common/images/molprop/lawesson_s_reagent-003.png

long_aliphatic_chain
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/long_aliphatic_chain-001.png
     - .. image:: ../../../common/images/molprop/long_aliphatic_chain-002.png
     - .. image:: ../../../common/images/molprop/long_aliphatic_chain-003.png

malonic
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/malonic-001.png
     - .. image:: ../../../common/images/molprop/malonic-002.png
     - .. image:: ../../../common/images/molprop/malonic-003.png

mercapto
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/mercapto-001.png
     - .. image:: ../../../common/images/molprop/mercapto-002.png
     - .. image:: ../../../common/images/molprop/mercapto-003.png

methoxyethoxymethyl_MEM
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/methoxyethoxymethyl_MEM-001.png
     - .. image:: ../../../common/images/molprop/methoxyethoxymethyl_MEM-002.png
     - .. image:: ../../../common/images/molprop/methoxyethoxymethyl_MEM-003.png

methyl_ketone
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/methyl_ketone-001.png
     - .. image:: ../../../common/images/molprop/methyl_ketone-002.png
     - .. image:: ../../../common/images/molprop/methyl_ketone-003.png

michael_acceptor
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/michael_acceptor-001.png
     - .. image:: ../../../common/images/molprop/michael_acceptor-002.png
     - .. image:: ../../../common/images/molprop/michael_acceptor-003.png

monensin_derivatives
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/monensin_derivatives-001.png
     -
     -

mono_alkene
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/mono_alkene-001.png
     - .. image:: ../../../common/images/molprop/mono_alkene-002.png
     - .. image:: ../../../common/images/molprop/mono_alkene-003.png

mono_alkyne
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/mono_alkyne-001.png
     - .. image:: ../../../common/images/molprop/mono_alkyne-002.png
     - .. image:: ../../../common/images/molprop/mono_alkyne-003.png

nitrile
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/nitrile-001.png
     - .. image:: ../../../common/images/molprop/nitrile-002.png
     - .. image:: ../../../common/images/molprop/nitrile-003.png

nitro
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/nitro-001.png
     - .. image:: ../../../common/images/molprop/nitro-002.png
     - .. image:: ../../../common/images/molprop/nitro-003.png

nitroso
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/nitroso-001.png
     - .. image:: ../../../common/images/molprop/nitroso-002.png
     - .. image:: ../../../common/images/molprop/nitroso-003.png


N_methoyl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/N_methoyl-001.png
     - .. image:: ../../../common/images/molprop/N_methoyl-002.png
     - .. image:: ../../../common/images/molprop/N_methoyl-003.png

nonacylhydrazone
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/nonacylhydrazone-001.png
     - .. image:: ../../../common/images/molprop/nonacylhydrazone-002.png
     - .. image:: ../../../common/images/molprop/nonacylhydrazone-003.png

noxide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/noxide-001.png
     - .. image:: ../../../common/images/molprop/noxide-002.png
     - .. image:: ../../../common/images/molprop/noxide-003.png

N_P_S_Halides
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/N_P_S_Halides-001.png
     - .. image:: ../../../common/images/molprop/N_P_S_Halides-002.png
     - .. image:: ../../../common/images/molprop/N_P_S_Halides-003.png

NS_beta_halothyl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/NS_beta_halothyl-001.png
     - .. image:: ../../../common/images/molprop/NS_beta_halothyl-002.png
     - .. image:: ../../../common/images/molprop/NS_beta_halothyl-003.png

nucleophile
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/nucleophile-001.png
     - .. image:: ../../../common/images/molprop/nucleophile-002.png
     - .. image:: ../../../common/images/molprop/nucleophile-003.png

organometallic
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/organometallic-001.png
     - .. image:: ../../../common/images/molprop/organometallic-002.png
     - .. image:: ../../../common/images/molprop/organometallic-003.png

oxalyl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/oxalyl-001.png
     - .. image:: ../../../common/images/molprop/oxalyl-002.png
     - .. image:: ../../../common/images/molprop/oxalyl-003.png

oxaziridine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/oxaziridine-001.png
     - .. image:: ../../../common/images/molprop/oxaziridine-002.png
     - .. image:: ../../../common/images/molprop/oxaziridine-003.png

oxime
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/oxime-001.png
     - .. image:: ../../../common/images/molprop/oxime-002.png
     - .. image:: ../../../common/images/molprop/oxime-003.png

oxygen_cation
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/oxygen_cation-001.png
     - .. image:: ../../../common/images/molprop/oxygen_cation-002.png
     - .. image:: ../../../common/images/molprop/oxygen_cation-003.png

paranitrophenyl_esters
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/paranitrophenyl_esters-001.png
     - .. image:: ../../../common/images/molprop/paranitrophenyl_esters-002.png
     - .. image:: ../../../common/images/molprop/paranitrophenyl_esters-003.png

pentafluorophenyl_esters
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/pentafluorophenyl_esters-001.png
     - .. image:: ../../../common/images/molprop/pentafluorophenyl_esters-002.png
     - .. image:: ../../../common/images/molprop/pentafluorophenyl_esters-003.png

perhalo_ketone
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/perhalo_ketone-001.png
     - .. image:: ../../../common/images/molprop/perhalo_ketone-002.png
     - .. image:: ../../../common/images/molprop/perhalo_ketone-003.png

peroxide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/peroxide-001.png
     - .. image:: ../../../common/images/molprop/peroxide-002.png
     - .. image:: ../../../common/images/molprop/peroxide-003.png

phenol
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/phenol-001.png
     - .. image:: ../../../common/images/molprop/phenol-002.png
     - .. image:: ../../../common/images/molprop/phenol-003.png

phosphanes
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/phosphanes-001.png
     - .. image:: ../../../common/images/molprop/phosphanes-002.png
     - .. image:: ../../../common/images/molprop/phosphanes-003.png

phosphinic_acid
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/phosphinic_acid-001.png
     - .. image:: ../../../common/images/molprop/phosphinic_acid-002.png
     - .. image:: ../../../common/images/molprop/phosphinic_acid-003.png

phosphonamide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/phosphonamide-001.png
     - .. image:: ../../../common/images/molprop/phosphonamide-002.png
     - .. image:: ../../../common/images/molprop/phosphonamide-003.png

phosphonic_acid
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/phosphonic_acid-001.png
     - .. image:: ../../../common/images/molprop/phosphonic_acid-002.png
     - .. image:: ../../../common/images/molprop/phosphonic_acid-003.png

phosphonic_ester
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/phosphonic_ester-001.png
     - .. image:: ../../../common/images/molprop/phosphonic_ester-002.png
     - .. image:: ../../../common/images/molprop/phosphonic_ester-003.png

phosphonylnitrile
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/phosphonylnitrile-001.png
     -
     -

phosphoramides
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/phosphoramides-001.png
     - .. image:: ../../../common/images/molprop/phosphoramides-002.png
     - .. image:: ../../../common/images/molprop/phosphoramides-003.png

phosphoranes
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/phosphoranes-001.png
     - .. image:: ../../../common/images/molprop/phosphoranes-002.png
     - .. image:: ../../../common/images/molprop/phosphoranes-003.png

phosphoric_acid
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/phosphoric_acid-001.png
     - .. image:: ../../../common/images/molprop/phosphoric_acid-002.png
     - .. image:: ../../../common/images/molprop/phosphoric_acid-003.png

phosphoric_ester
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/phosphoric_ester-001.png
     - .. image:: ../../../common/images/molprop/phosphoric_ester-002.png
     - .. image:: ../../../common/images/molprop/phosphoric_ester-003.png

phosphoryl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/phosphoryl-001.png
     - .. image:: ../../../common/images/molprop/phosphoryl-002.png
     - .. image:: ../../../common/images/molprop/phosphoryl-003.png

phthalimides_PHT
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/phthalimides_PHT-001.png
     - .. image:: ../../../common/images/molprop/phthalimides_PHT-002.png
     - .. image:: ../../../common/images/molprop/phthalimides_PHT-003.png

polyenes
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/polyenes-001.png
     - .. image:: ../../../common/images/molprop/polyenes-002.png
     - .. image:: ../../../common/images/molprop/polyenes-003.png

primary_amine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/primary_amine-001.png
     - .. image:: ../../../common/images/molprop/primary_amine-002.png
     - .. image:: ../../../common/images/molprop/primary_amine-003.png

propiolactones
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/propiolactones-001.png
     - .. image:: ../../../common/images/molprop/propiolactones-002.png
     - .. image:: ../../../common/images/molprop/propiolactones-003.png

pseudo_amine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/pseudo_amine-001.png
     - .. image:: ../../../common/images/molprop/pseudo_amine-002.png
     - .. image:: ../../../common/images/molprop/pseudo_amine-003.png

quinone
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/quinone-001.png
     - .. image:: ../../../common/images/molprop/quinone-002.png
     - .. image:: ../../../common/images/molprop/quinone-003.png

ring
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/ring-001.png
     - .. image:: ../../../common/images/molprop/ring-002.png
     - .. image:: ../../../common/images/molprop/ring-003.png

saponin_derivatives
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/saponin_derivatives-001.png
     -
     -

SCN2
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/SCN2-001.png
     - .. image:: ../../../common/images/molprop/SCN2-002.png
     - .. image:: ../../../common/images/molprop/SCN2-003.png

secondary_amine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/secondary_amine-001.png
     - .. image:: ../../../common/images/molprop/secondary_amine-002.png
     - .. image:: ../../../common/images/molprop/secondary_amine-003.png

squalestatin_derivatives
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/squalestatin_derivatives-001.png
     -
     -

sulfide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/sulfide-001.png
     - .. image:: ../../../common/images/molprop/sulfide-002.png
     - .. image:: ../../../common/images/molprop/sulfide-003.png

sulfinimine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/sulfinimine-001.png
     - .. image:: ../../../common/images/molprop/sulfinimine-002.png
     - .. image:: ../../../common/images/molprop/sulfinimine-003.png

sulfinylthio
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/sulfinylthio-001.png
     - .. image:: ../../../common/images/molprop/sulfinylthio-002.png
     - .. image:: ../../../common/images/molprop/sulfinylthio-003.png

sulfonamide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/sulfonamide-001.png
     - .. image:: ../../../common/images/molprop/sulfonamide-002.png
     - .. image:: ../../../common/images/molprop/sulfonamide-003.png

sulfone
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/sulfone-001.png
     - .. image:: ../../../common/images/molprop/sulfone-002.png
     - .. image:: ../../../common/images/molprop/sulfone-003.png

sulfonic_acid
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/sulfonic_acid-001.png
     - .. image:: ../../../common/images/molprop/sulfonic_acid-002.png
     - .. image:: ../../../common/images/molprop/sulfonic_acid-003.png

sulfonic_ester
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/sulfonic_ester-001.png
     - .. image:: ../../../common/images/molprop/sulfonic_ester-002.png
     - .. image:: ../../../common/images/molprop/sulfonic_ester-003.png

sulfonimine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/sulfonimine-001.png
     - .. image:: ../../../common/images/molprop/sulfonimine-002.png
     - .. image:: ../../../common/images/molprop/sulfonimine-003.png

sulfonyl_halide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/sulfonyl_halide-001.png
     - .. image:: ../../../common/images/molprop/sulfonyl_halide-002.png
     - .. image:: ../../../common/images/molprop/sulfonyl_halide-003.png

sulfonylnitrile
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/sulfonylnitrile-001.png
     - .. image:: ../../../common/images/molprop/sulfonylnitrile-002.png
     - .. image:: ../../../common/images/molprop/sulfonylnitrile-003.png

sulfonylurea
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/sulfonylurea-001.png
     - .. image:: ../../../common/images/molprop/sulfonylurea-002.png
     - .. image:: ../../../common/images/molprop/sulfonylurea-003.png

sulfoxide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/sulfoxide-001.png
     - .. image:: ../../../common/images/molprop/sulfoxide-002.png
     - .. image:: ../../../common/images/molprop/sulfoxide-003.png

t_butyldimethylsilyl_TBDMS
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/t_butyldimethylsilyl_TBDMS-001.png
     - .. image:: ../../../common/images/molprop/t_butyldimethylsilyl_TBDMS-002.png
     - .. image:: ../../../common/images/molprop/t_butyldimethylsilyl_TBDMS-003.png

t_butyldiphenylsilyl_TBDPS
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/t_butyldiphenylsilyl_TBDPS-001.png
     - .. image:: ../../../common/images/molprop/t_butyldiphenylsilyl_TBDPS-002.png
     -

t_butyl_ether
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/t_butyl_ether-001.png
     - .. image:: ../../../common/images/molprop/t_butyl_ether-002.png
     - .. image:: ../../../common/images/molprop/t_butyl_ether-003.png

t_butoxycarbonyl_tBOC
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/t_butoxycarbonyl_tBOC-001.png
     - .. image:: ../../../common/images/molprop/t_butoxycarbonyl_tBOC-002.png
     - .. image:: ../../../common/images/molprop/t_butoxycarbonyl_tBOC-003.png

terminal_vinyl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/terminal_vinyl-001.png
     - .. image:: ../../../common/images/molprop/terminal_vinyl-002.png
     - .. image:: ../../../common/images/molprop/terminal_vinyl-003.png

tertiary_amine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/tertiary_amine-001.png
     - .. image:: ../../../common/images/molprop/tertiary_amine-002.png
     - .. image:: ../../../common/images/molprop/tertiary_amine-003.png

tetrahydropyran_THP
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/tetrahydropyran_THP-001.png
     - .. image:: ../../../common/images/molprop/tetrahydropyran_THP-002.png
     - .. image:: ../../../common/images/molprop/tetrahydropyran_THP-003.png

thioamide
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/thioamide-001.png
     - .. image:: ../../../common/images/molprop/thioamide-002.png
     - .. image:: ../../../common/images/molprop/thioamide-003.png

thiocarbamate
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/thiocarbamate-001.png
     - .. image:: ../../../common/images/molprop/thiocarbamate-002.png
     - .. image:: ../../../common/images/molprop/thiocarbamate-003.png

thiocarbonyl
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/thiocarbonyl-001.png
     - .. image:: ../../../common/images/molprop/thiocarbonyl-002.png
     - .. image:: ../../../common/images/molprop/thiocarbonyl-003.png

thioester
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/thioester-001.png
     - .. image:: ../../../common/images/molprop/thioester-002.png
     - .. image:: ../../../common/images/molprop/thioester-003.png

thiol
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/thiol-001.png
     - .. image:: ../../../common/images/molprop/thiol-002.png
     - .. image:: ../../../common/images/molprop/thiol-003.png

thiourea
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/thiourea-001.png
     - .. image:: ../../../common/images/molprop/thiourea-002.png
     - .. image:: ../../../common/images/molprop/thiourea-003.png

triacyloxime
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/triacyloxime-001.png
     - .. image:: ../../../common/images/molprop/triacyloxime-002.png
     - .. image:: ../../../common/images/molprop/triacyloxime-003.png


triazine
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/triazine-001.png
     - .. image:: ../../../common/images/molprop/triazine-002.png
     - .. image:: ../../../common/images/molprop/triazine-003.png

tricarbo_phosphene
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/tricarbo_phosphene-001.png
     - .. image:: ../../../common/images/molprop/tricarbo_phosphene-002.png
     - .. image:: ../../../common/images/molprop/tricarbo_phosphene-003.png


triflates
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/triflates-001.png
     - .. image:: ../../../common/images/molprop/triflates-002.png
     - .. image:: ../../../common/images/molprop/triflates-003.png

triisopropylsilyl_TIPS
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/triisopropylsilyl_TIPS-001.png
     - .. image:: ../../../common/images/molprop/triisopropylsilyl_TIPS-002.png
     - .. image:: ../../../common/images/molprop/triisopropylsilyl_TIPS-003.png

trimethylsilyl_TMS
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/trimethylsilyl_TMS-001.png
     - .. image:: ../../../common/images/molprop/trimethylsilyl_TMS-002.png
     - .. image:: ../../../common/images/molprop/trimethylsilyl_TMS-003.png

unbranched_chain
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/unbranched_chain-001.png
     - .. image:: ../../../common/images/molprop/unbranched_chain-002.png
     - .. image:: ../../../common/images/molprop/unbranched_chain-003.png

urea
-------------------------------------------------------------------------------

.. list-table::
   :widths: 35 35 35
   :header-rows: 0

   * - .. image:: ../../../common/images/molprop/urea-001.png
     - .. image:: ../../../common/images/molprop/urea-002.png
     - .. image:: ../../../common/images/molprop/urea-003.png

.. _filter_files_newrules:

New Rules
========================

New rules specify additional functional groups or substructures that
may be used. They must specify a substructure definition in the form
of a SMARTS pattern, in addition to the substructure name and maximum
limit. For example:

::

   NEWRULE norbornane 1 C1CC2CCC1C2

The first field is the ``NEWRULE`` keyword. The second field defines
the name associated with the substructure (primarily for logging
purposes). The third field indicates the maximum number of the
substructure that can be allowed. The fourth field is the SMARTS
string for the substructure, norbornane in this case. This example rule
indicates that molecules with a single norbornane substructure
would be allowable, but those with two or more norbornanes would be
eliminated.

New rules that have a name that is identical with one of the original
rules take precedence over the original rule.

.. _filter_files_selection:

Selection Statements
========================

The selection statement allows a filter file to specify the required
number of substructures in order to be able to pass the filter. These
statements are similar to new rules except that they list a required
range for passing the filter rather than the range for failing to pass
the filter. For example:

::

   SELECT amine 1 1 [N;!$(*-*[!#6;!#1]);!$(*-a);!$(*=,#*)]

The first field is the ``SELECT`` keyword. The second field indicates
the name for the selection (again for logging purposes). The third
field is the minimum number of substructures required to be in the
molecule. The fourth field is the maximum number of substructures
allowed in the molecule. The fifth field is the substructure defined
by a SMARTS pattern. The example requires that molecules contain
exactly one amine. Only a single ``SELECT`` statement is
allowed in the filter file. Any complex boolean substructure
statements can be incorporated directly into the SMARTS. If multiple
``SELECT`` statements occur in a filter file, only the final one will
be applied.



.. _molprop_part_examples:

********
Examples
********

.. toctree::
   :maxdepth: 2

   examples_summary
   cookbook-examples


.. _molprop_chapter_examples:

*************************
MolProp TK Examples
*************************

The following table lists the currently available **MolProp TK** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`molfilter<molprop_examples_molfilter>`
        - basic filtering for a molecule file
      * - :ref:`quietfilter<molprop_examples_quietfilter>`
        - silencing OEFilter logging messages
      * - :ref:`molproptable<molprop_examples_molproptable>`
        - generating tabular output of all molecular properties
      * - :ref:`specificmolprop<molprop_examples_specificmolprop>`
        - extract specific property (Lipinski violations) from table output
      * - :ref:`molpropsddata<molprop_examples_molpropsddata>`
        - attach molecular properties as SD data
      * - :ref:`molpropcsv<molprop_examples_molpropcsv>`
        - write molecular properties to a CSV file

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`molfilter.py<molprop_examples_molfilter>`
        - basic filtering for a molecule file
      * - :ref:`quietfilter.py<molprop_examples_quietfilter>`
        - silencing OEFilter logging messages
      * - :ref:`molproptable.py<molprop_examples_molproptable>`
        - generating tabular output of all molecular properties
      * - :ref:`specificmolprop.py<molprop_examples_specificmolprop>`
        - extract specific property (Lipinski violations) from table output
      * - :ref:`molpropsddata.py<molprop_examples_molpropsddata>`
        - attach molecular properties as SD data
      * - :ref:`molpropcsv.py<molprop_examples_molpropcsv>`
        - write molecular properties to a CSV file

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`MolFilter<molprop_examples_molfilter>`
        - basic filtering for a molecule file
      * - :ref:`QuietFilter<molprop_examples_quietfilter>`
        - silencing OEFilter logging messages
      * - :ref:`MolPropTable<molprop_examples_molproptable>`
        - generating tabular output of all molecular properties
      * - :ref:`SpecificMolProp<molprop_examples_specificmolprop>`
        - extract specific property (Lipinski violations) from table output
      * - :ref:`MolPropSDData<molprop_examples_molpropsddata>`
        - attach molecular properties as SD data
      * - :ref:`MolPropCSV<molprop_examples_molpropcsv>`
        - Write molecular properties to a CSV file

**Examples:**

.. toctree::
   :maxdepth: 1

   examples_molfilter
   examples_quietfilter
   examples_molproptable
   examples_specificmolprop
   examples_molpropsddata
   examples_molpropcsv


.. _molprop_examples_molfilter:

Basic Filtering for a Molecule File
======================================

All filtering operations are controlled via the
:ref:`OEFilter <OEMolProp_OEFilter>` object.  The :ref:`OEFilter <OEMolProp_OEFilter>`
object is typically configured with a specified filter and then
applied iteratively over a molecule file.  This example
demonstrates configuring the :ref:`OEFilter <OEMolProp_OEFilter>` object with
the :ref:`lead-like filter<filter_theory_variations_of_filters>`
and then writes out the molecules that pass the filter. The
:oe:meth:`OEMolProp::OEFilter::operator()` method is used to
test whether the molecule passes the filter.

.. note::

   The molecule will also be altered by all the specified
   :ref:`filter_process` steps.

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> molfilter --help

.. oe:language:: python

   .. code-block:: console

      prompt> python molfilter.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java MolFilter --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolFilter --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    filter options :
      -filtertype : filter type

    input/output options :
      -in : Input filename
      -out : Output filename

.. code-block:: console

   Usage: ./molfilter <input> <output>

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molfilter.py <../../../../wrappers/python/examples/molprop/molfilter.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/molprop/molfilter.py

   .. only:: oepdf

      .. oe:source:: molfilter.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molfilter.cpp <../../../../sublibs/tklibs/molprop/examples/molfilter.cpp>`

   .. only:: oepdf

      .. oe:source:: molfilter.cpp
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolFilter.java <../../../../wrappers/java/examples/openeye/examples/oemolprop/MolFilter.java>`

   .. only:: oepdf

      .. oe:source:: MolFilter.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolFilter.cs <../../../../wrappers/csharp/Csharp-Examples/OEMolProp/MolFilter.cs>`

   .. only:: oepdf

      .. oe:source:: MolFilter.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEMolProp::OEFilter` class
   * :oe:func:`OEMolProp::OEConfigureFilterParams` and :oe:func:`OEMolProp::OEConfigureFilterType` functions
   * :oe:func:`OEMolProp::OEGetFilterType` function

.. _molprop_examples_molfilter_output:

Examples
----------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> molfilter -in mcss.smi.gz -out .smi -filtertype Lead

.. oe:language:: python

   .. code-block:: console

      prompt> python molfilter.py -in mcss.smi.gz -out .smi -filtertype Lead

.. oe:language:: java

   .. code-block:: console

      prompt> java MolFilter -in mcss.smi.gz -out .smi -filtertype Lead

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolFilter -in mcss.smi.gz -out .smi -filtertype Lead

The following is an example of the output:

::

   CC1=CC(=O)C=CC1=O    NSC 1,Minimum atom count(10) not reached: 9
   c1ccc2c(c1)nc(s2)SSc3nc4ccccc4s3    NSC 2,Maximum disulfide(0) exceeded: 1
   c1c(cc(c(c1[N+](=O)[O-])[O-])Cl)[N+](=O)[O-]    NSC 3,Maximum heteroatom to carbon ratio(1.10) exceeded: 1.33
   c1c(sc(n1)N)[N+](=O)[O-]    NSC 4,Minimum atom count(10) not reached: 9
   c1ccc2c(c1)C(=O)c3ccc(cc3C2=O)N     NSC 5,Maximum dye(0) exceeded: 2
   c1ccc(c(c1)c2c3ccc(c(c3oc-4c(c(=O)ccc24)Br)Br)O)C(=O)[O-]    NSC 6,Maximum atom count(25) exceeded: 27
   C[NH+](C)C1=C(C(=O)c2ccccc2C1=O)Cl    NSC 7,Maximum alkyl_halide(0) exceeded: 1
   Cc1ccc2c(c1[N+](=O)[O-])C(=O)c3ccccc3C2=O    NSC 8,Maximum nitro(0) exceeded: 1
   CC(C)(C)c1cc(c(cc1O)C(C)(C)C)O    NSC 11,Pass
   CC1=NN(C(=O)C1)c2ccccc2 NSC    12,Pass

By default the :oe:meth:`OEMolProp::OEFilter::operator()` method will emit
information to :oe:constns:`OESystem::OEThrow` about every molecule passed to it. This example
prints that to the screen.  The next example,
:ref:`quietfilter<molprop_examples_quietfilter>`, shows how to suppress
that output.  Only the molecules that pass the filter will be written to
the output file.  The following is the format for what is emitted:

::

   [Isomeric SMILES]\t[Title],[Pass|Reason for failure]



.. _molprop_examples_quietfilter:

Quiet Filtering
===============

Log output can be superfluous when using the :ref:`OEFilter <OEMolProp_OEFilter>`
object in a more complex program. Since all the log output is written to
the :oe:constns:`OESystem::OEThrow` object, the verbosity level can be lowered
by using the :oe:meth:`OEThrow.SetLevel<OESystem::OEErrorHandler::SetLevel>`
method.  This example demonstrates setting the :oe:constns:`OESystem::OEThrow`
error level to :oe:const:`OESystem::OEErrorLevel::Warning`. This will only allow
messages at the level of ``Warning`` or above to be emitted, thereby
silencing the :ref:`OEFilter <OEMolProp_OEFilter>` object's logging output. The
``-verbose`` option can be used to change the :oe:constns:`OESystem::OEThrow`
error level.

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> quietfilter --help

.. oe:language:: python

   .. code-block:: console

      prompt> python quietfilter.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java QuietFilter --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> QuietFilter --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    filter options :
      -filtertype : filter type

    input/output options :
      -in : Input filename
      -out : Output filename

    other options :
      -verbose : Error level of messages

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`quietfilter.py <../../../../wrappers/python/examples/molprop/quietfilter.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/molprop/quietfilter.py

   .. only:: oepdf

      .. oe:source:: quietfilter.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`quietfilter.cpp <../../../../sublibs/tklibs/molprop/examples/quietfilter.cpp>`

   .. only:: oepdf

      .. oe:source:: quietfilter.cpp
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`QuietFilter.java <../../../../wrappers/java/examples/openeye/examples/oemolprop/QuietFilter.java>`

   .. only:: oepdf

      .. oe:source:: QuietFilter.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`QuietFilter.cs <../../../../wrappers/csharp/Csharp-Examples/OEMolProp/QuietFilter.cs>`

   .. only:: oepdf

      .. oe:source:: QuietFilter.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEMolProp::OEFilter` class
   * :oe:func:`OEMolProp::OEConfigureFilterParams` and :oe:func:`OEMolProp::OEConfigureFilterType` functions
   * :oe:func:`OEMolProp::OEGetFilterType` function
   * :ref:`OEErrorHandler <OESystem_OEErrorHandler>` class

Examples
----------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> quietfilter -in mcss.smi.gz -out .smi -filtertype Lead

.. oe:language:: python

   .. code-block:: console

      prompt> python quietfilter.py -in mcss.smi.gz -out .smi -filtertype Lead

.. oe:language:: java

   .. code-block:: console

      prompt> java QuietFilter -in mcss.smi.gz -out .smi -filtertype Lead

.. oe:language:: csharp

   .. code-block:: console

      prompt> QuietFilter -in mcss.smi.gz -out .smi -filtertype Lead


.. _molprop_examples_molproptable:

Molecular Property Table
========================

The :ref:`OEFilter <OEMolProp_OEFilter>` object allows for the calculation of
all the molecular properties it uses during the filtering process
without actually applying the filter. This may be useful for
caching the :ref:`OEFilter <OEMolProp_OEFilter>` object results into a
database. The :oe:meth:`OEMolProp::OEFilter::SetTable` method can be
used to specify where to write a tab-delimited table of every property
in the associated :ref:`filter file <filter_files>`.  This example
demonstrates how to write the tabular output to standard out.

.. note:: 

   A tab-delimited file format was chosen to integrate better with
   Unix commandline utilities. For example, this allows for quick and
   easy filter experimentation with the `awk
   <http://en.wikipedia.org/wiki/AWK>`_ command line utility. The
   following snippet will print the number of molecules (plus one for
   the header) with a molecular weight greater than 200.
   
   .. oe:language:: c++

      .. code-block:: console

         > molproptable -in drugs.sdf -filtertype Lead > drugs.txt
         > cat drugs.txt | awk -F\t '{if ($12 > 200) { print $12 }}' | wc -l

   .. oe:language:: python

      .. code-block:: console

         > python molproptable.py -in drugs.sdf -filtertype Lead > drugs.txt
         > cat drugs.txt | awk -F\t '{if ($12 > 200) { print $12 }}' | wc -l

   .. oe:language:: java

      .. code-block:: console

         > java MolPropTable -in drugs.sdf -filtertype Lead > drugs.txt
         > cat drugs.txt | awk -F\t '{if ($12 > 200) { print $12 }}' | wc -l

   .. oe:language:: csharp

      .. code-block:: console

         > MolPropTable -in drugs.sdf -filtertype Lead > drugs.txt
         > cat drugs.txt | awk -F\t '{if ($12 > 200) { print $12 }}' | wc -l

   Furthermore, all database programs have utilities for importing
   tab-delimited files. Loading the filter results into a third-party
   database would provide very speedy filter experimentation since the
   properties would only have to be calculated once and then cached in
   the database.

..   [[ We would be the coolest company ever if we provided the SQL
..   schema to associate with the tabular output. ]]

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> molproptable --help

.. oe:language:: python

   .. code-block:: console

      prompt> python molproptable.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java MolPropTable --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolPropTable --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    filter options :
      -filtertype : filter type

    input/output options :
      -in : Input filename

    other options :
      -verbose : Error level of messages

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molproptable.py <../../../../wrappers/python/examples/molprop/molproptable.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/molprop/molproptable.py

   .. only:: oepdf

      .. oe:source:: molproptable.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molproptable.cpp <../../../../sublibs/tklibs/molprop/examples/molproptable.cpp>`

   .. only:: oepdf

      .. oe:source:: molproptable.cpp
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolPropTable.java <../../../../wrappers/java/examples/openeye/examples/oemolprop/MolPropTable.java>`

   .. only:: oepdf

      .. oe:source:: MolPropTable.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolPropTable.cs <../../../../wrappers/csharp/Csharp-Examples/OEMolProp/MolPropTable.cs>`

   .. only:: oepdf

      .. oe:source:: MolPropTable.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEMolProp::OEFilter` class
   * :oe:func:`OEMolProp::OEConfigureFilterParams` and :oe:func:`OEMolProp::OEConfigureFilterType` functions
   * :oe:func:`OEMolProp::OEGetFilterType` function

Examples
----------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> molpropsdtable -in drugs.sdf -filtertype Lead

.. oe:language:: python

   .. code-block:: console

      prompt> python molpropsdtable.py -in drugs.sdf -filtertype Lead

.. oe:language:: java

   .. code-block:: console

      prompt> java MolPropTable -in drugs.sdf -filtertype Lead

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolPropTable -in drugs.sdf -filtertype Lead


.. _molprop_examples_specificmolprop:

Specific Molecular Properties
=============================

The :ref:`OEFilter <OEMolProp_OEFilter>` object table can also be used to
retrieve specific molecular properties or filtering terms for which a
free function does not exist. The number of molecular properties is
large.  In addition, some properties are more experimental than others.
For these reasons :ref:`free functions <molprop_functions>` are not provided
for everything that can be calculated.  This example demonstrates how to
extract a property, the number of Lipinski violations, from the
:ref:`OEFilter <OEMolProp_OEFilter>` object molecular property table by
writing the table to a :ref:`oeosstream <OEPlatform_oeosstream>`.

.. warning::

   The exact number of fields the :ref:`OEFilter <OEMolProp_OEFilter>` object
   outputs depends on the :ref:`filter file <filter_files>` being
   used. The field will only be output if the filter rule is turned
   on. That is why this example will search the header line for the
   position of the "Lipinski violations" field. This key-value lookup
   is recommended for extracting specific fields from the filter table.

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> specificmolprop --help

.. oe:language:: python

   .. code-block:: console

      prompt> python specificmolprop.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java SpecificMolProp --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> SpecificMolProp --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    filter options :
      -filtertype : filter type

    input/output options :
      -in : Input filename
      -out : Output filename

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`specificmolprop.py <../../../../wrappers/python/examples/molprop/specificmolprop.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/molprop/specificmolprop.py

   .. only:: oepdf

      .. oe:source:: specificmolprop.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`specificmolprop.cpp <../../../../sublibs/tklibs/molprop/examples/specificmolprop.cpp>`

   .. only:: oepdf

      .. oe:source:: specificmolprop.cpp
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SpecificMolProp.java <../../../../wrappers/java/examples/openeye/examples/oemolprop/SpecificMolProp.java>`

   .. only:: oepdf

      .. oe:source:: SpecificMolProp.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SpecificMolProp.cs <../../../../wrappers/csharp/Csharp-Examples/OEMolProp/SpecificMolProp.cs>`

   .. only:: oepdf

      .. oe:source:: SpecificMolProp.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEMolProp::OEFilter` class
   * :oe:func:`OEMolProp::OEConfigureFilterParams` and :oe:func:`OEMolProp::OEConfigureFilterType` functions
   * :oe:func:`OEMolProp::OEGetFilterType` function

Examples
----------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> specificmolprop -in mcss.smi.gz -filtertype Lead

.. oe:language:: python

   .. code-block:: console

      prompt> python specificmolprop.py -in mcss.smi.gz -filtertype Lead

.. oe:language:: java

   .. code-block:: console

      prompt> java SpecificMolProp -in mcss.smi.gz -filtertype Lead

.. oe:language:: csharp

   .. code-block:: console

      prompt> SpecificMolProp -in mcss.smi.gz -filtertype Lead


.. _molprop_examples_molpropsddata:

Attach Molecular Properties as SD Data
======================================

The molecular properties calculated by :ref:`OEFilter <OEMolProp_OEFilter>` can be
attached as SD data to the molecule.  The 
:oe:meth:`OEMolProp::OEFilter::SetSDTag` method is used to attach the
calculated molecular properties to molecules passed to the filter object.

SD tag data corresponds to the
:ref:`tabular data <molprop_examples_molproptable>` functionality.
The SD data tag names are exactly the same as the names found in the table
header. The SD data values are exactly what is output in the data
table. The only exceptions are the "SMILES", "Name", and "Filter"
columns since this information can be obtained other ways. 

This example demonstrates how to set the table output to the ``oenul``
output stream to allow all properties to be attached as SD data, and  write
the tabular data to an output in the :oe:const:`OEChem::OEFormat::SDF`,
:oe:const:`OEChem::OEFormat::OEB`, or the :oe:const:`OEChem::OEFormat::CSV`
format. To specifically write to the :oe:const:`OEChem::OEFormat::CSV` 
format, also see the :ref:`MolPropCSV<molprop_examples_molpropcsv>` example.

.. warning:: 
   
   By default, only the properties up to the failing property will be attached
   to each molecule.  Use :oe:meth:`OEMolProp::OEFilter::SetTable` to force
   every property to be attached as SD data. The same rule applies to
   SD data as :ref:`tabular output data <molprop_examples_molproptable>`,
   only the properties specified in the :ref:`filter file<filter_files>` will
   be attached as SD data. 

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> molpropsddata --help

.. oe:language:: python

   .. code-block:: console

      prompt> python molpropsddata.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java MolPropSDData --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolPropSDData --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    filter options :
      -filtertype : filter type

    input/output options :
      -in : Input filename
      -out : Output filename

    other options :
      -verbose : Error level of messages

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molpropsddata.py <../../../../wrappers/python/examples/molprop/molpropsddata.py>`

      .. admonition:: Download code

         :download:`molpropsddata.py <../../../../wrappers/python/examples/molprop/molpropsddata.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/molprop/molpropsddata.py

   .. only:: oepdf

      .. oe:source:: molpropsddata.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molpropsddata.cpp <../../../../sublibs/tklibs/molprop/examples/molpropsddata.cpp>`

   .. only:: oepdf

      .. oe:source:: molpropsddata.cpp
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolPropSDData.java <../../../../wrappers/java/examples/openeye/examples/oemolprop/MolPropSDData.java>`

   .. only:: oepdf

      .. oe:source:: MolPropSDData.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolPropSDData.cs <../../../../wrappers/csharp/Csharp-Examples/OEMolProp/MolPropSDData.cs>`

   .. only:: oepdf

      .. oe:source:: MolPropSDData.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEMolProp::OEFilter` class
   * :oe:func:`OEMolProp::OEConfigureFilterParams` and :oe:func:`OEMolProp::OEConfigureFilterType` functions
   * :oe:func:`OEMolProp::OEGetFilterType` function

Examples
----------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> molpropsddata -in drugs.sdf -out out_mpsd.sdf -filtertype Lead

.. oe:language:: python

   .. code-block:: console

      prompt> python molpropsddata.py -in drugs.sdf -out out_mpsd.sdf -filtertype Lead

.. oe:language:: java

   .. code-block:: console

      prompt> java MolPropSDData -in drugs.sdf -out out_mpsd.sdf -filtertype Lead

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolPropSDData -in drugs.sdf -out out_mpsd.sdf -filtertype Lead


.. _molprop_examples_molpropcsv:

Write molecular properties to a CSV file
========================================

The molecular properties calculated by :ref:`OEFilter <OEMolProp_OEFilter>` can be
written to a file in the :oe:const:`OEChem::OEFormat::CSV` format as described
in the :ref:`section_moltaggeddata_CSV` section. Every property specified in
the :ref:`filter file<filter_files>` will be writtern in the tabular file.

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> molpropcsv --help

.. oe:language:: python

   .. code-block:: console

      prompt> python molpropcsv.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java MolPropCSV --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolPropCSV --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    filter options :
      -filtertype : filter type

    input/output options :
      -in : Input filename
      -out : Output filename

    other options :
      -verbose : Error level of messages

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molpropcsv.py <../../../../wrappers/python/examples/molprop/molpropcsv.py>`

      ..    literalinclude:: ../../../wrappers/python/examples/molprop/molpropcsv.py

   .. only:: oepdf

      .. oe:source:: molpropcsv.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molpropcsv.cpp <../../../../sublibs/tklibs/molprop/examples/molpropcsv.cpp>`

   .. only:: oepdf

      .. oe:source:: molpropcsv.cpp
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolPropCSV.java <../../../../wrappers/java/examples/openeye/examples/oemolprop/MolPropCSV.java>`

   .. only:: oepdf

      .. oe:source:: MolPropCSV.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolPropCSV.cs <../../../../wrappers/csharp/Csharp-Examples/OEMolProp/MolPropCSV.cs>`

   .. only:: oepdf

      .. oe:source:: MolPropCSV.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEMolProp::OEFilter` class
   * :oe:func:`OEMolProp::OEConfigureFilterParams` and :oe:func:`OEMolProp::OEConfigureFilterType` functions
   * :oe:func:`OEMolProp::OEWritePropertyDataToCSV` function

Examples
----------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> molpropcsv -in drugs.sdf -out out_drugs.csv -filtertype Lead

.. oe:language:: python

   .. code-block:: console

      prompt> python molpropcsv.py -in drugs.sdf -out out_drugs.csv -filtertype Lead

.. oe:language:: java

   .. code-block:: console

      prompt> java MolPropCSV -in drugs.sdf -out out_drugs.csv -filtertype Lead

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolPropCSV -in drugs.sdf -out out_drugs.csv -filtertype Lead



.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. _oemolprop_chapter_cookbook_examples:

********************************************************************************
Python Cookbook Examples
********************************************************************************

There are large number of code examples available in
`OpenEye Python Cookbook <http://docs.eyesopen.com/python_modules/cookbook/index.html>`_
that use **OpenEye Toolkits** to solve a wide range of cheminformatics and molecular
modeling problems.

* `2D Depiction <http://docs.eyesopen.com/python_modules/cookbook/depiction/depiction.html>`_ chapter
  contains examples that illustrate how the **OEDepict TK** and **Grapheme TK** can be
  utilized to depict molecules and visualize properties calculated with other OpenEye toolkits.

* `Visualizing 3D Information <http://docs.eyesopen.com/python_modules/cookbook/visualization/visualization.html>`_
  chapter contains examples that illustrate how the **Grapheme TK** can be utilized to project
  complex 3D information into the 2D molecular graph.

* `Cheminformatics <https://docs.eyesopen.com/python_modules/cookbook/cheminfo/cheminfo.html>`_
  chapter contains examples that solve various cheminformatics problems such as similarity search,
  ring perception and manipulating molecular graphs.

* `Peptide Informatics <https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptideinfo.html>`_
  chapter contains examples that solve various peptide informatics problems such as generating custom monomer sets,
  parsing and generating :term:`HELM` representations, and visualizing peptides.


.. admonition:: OpenEye Python Cookbook examples using MolProp TK

   * `Depicting Atom Contributions of XLogP`_
   * `Depicting Fragment Contributions of XLogP`_
   * `Depicting Topological Polar Surface Area`_
   * `Depicting Molecular Properties`_


###############################################
Appendix: Additional Examples in Python
###############################################

These are full listings of programming examples that are excerpted or offered for download, elsewhere in this chapter.
For a full list of examples, see
:ref:`the list in this chapter <molprop_part_examples>`.

..  _listing-PSAAtomContributions.py:

..  oe:source:: PSAAtomContributions.py
    :language: python
    :caption:  Example of retrieving individual atom contributions to PSA.
    :refnum:   1

..  _listing-XLogPAtomContributions.py:

..  oe:source:: XLogPAtomContributions.py
    :language: python
    :caption: Example of retrieving individual atom contributions to XLogP
    :refnum: 2



.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEFilter, Filter

.. _OEMolProp_OEFilter:

.. oe:class:: OEFilter

   .. oe:api::

      class OEFilter

   This class represents a set of filters as initialized from a
   :ref:`filter file <filter_files>`. The primary use of this class
   is :oe:meth:`OEMolProp::OEFilter::operator()` method which will
   return whether the molecule passes or fails the filter.

   .. _OEMolProp_OEFilter_Constructors:

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFilter(unsigned int type = OEFilterType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEFilter(type: int) -> OEFilter

      The :ref:`OEFilter <OEMolProp_OEFilter>` object is usually constructed
      from an ``unsigned integer`` from the
      :oe:constns:`OEMolProp::OEFilterType` constant namespace. The
      default constructor will initialize the object to the
      :oe:const:`OEMolProp::OEFilterType::Default` filter. The default
      filter is an alias for
      the :oe:const:`OEMolProp::OEFilterType::BlockBuster` filter.

      .. seealso::

         The :ref:`filter_theory_variations_of_filters` section.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFilter(OEPlatform::oeistream& filterstr)

      .. oe:language:: python

         .. oe:api:: python

            OEFilter(filterstr: oeistream) -> OEFilter

      Fine grained filter control is provided by allowing a custom
      filter file to be passed to the :ref:`OEFilter <OEMolProp_OEFilter>`
      object as the ``filterstr`` argument.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFilter(const OEFilter& filter)

      .. oe:language:: python

         .. oe:api:: python

            OEFilter(filter: OEFilter) -> OEFilter

      The :ref:`OEFilter <OEMolProp_OEFilter>` object can be copy constructed
      from another :ref:`OEFilter <OEMolProp_OEFilter>` object.

   .. _OEMolProp_OEFilter_operator_assign:

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFilter &operator=(const OEFilter &filter)

      Assignment operator to allow copying a
      :ref:`OEFilter <OEMolProp_OEFilter>` object.

      Assignment operator.

   .. _OEMolProp_OEFilter_operator_call:

   .. oe:method:: operator()

      .. oe:language:: c++

         .. oe:api:: c++

            bool operator()(OEChem::OEMolBase& mol)
            bool operator()(OEChem::OEMCMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: Union[OEGraphMol,OEQMol]) -> bool
            __call__(arg2: OEMol) -> bool

      .. oe:language:: java

         .. oe:api:: java

            boolean call(OEMolBase mol)

      Returns whether the molecule ``mol`` passes the
      :ref:`OEFilter <OEMolProp_OEFilter>` object's set of filter
      rules. This function has been optimized by applying the filter
      rules in order of how expensive they are to calculate. For
      example, molecular weight is much easier to calculate than any
      of the functional group rules.

      However, if an output stream has been specified using the
      :oe:meth:`OEMolProp::OEFilter::SetTable` method all the filter
      rules will be checked. This is the only way to ensure that all
      the fields are filled in the tabular data output to the stream
      specified in :oe:meth:`SetTable<OEMolProp::OEFilter::SetTable>`
      method.

      .. note::

         The molecule may be altered by the steps described in the
         :ref:`filter_process` chapter.

      .. seealso::

         This method will write logging data to
         :oe:constns:`OESystem::OEThrow` as described in this
         :ref:`example <molprop_examples_molfilter>`.

   .. _OEMolProp_OEFilter_operator_bool:

   .. oe:method:: operator bool

      .. oe:language:: c++

         .. oe:api:: c++

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      .. oe:language:: java

         .. oe:api:: java

            boolean IsValid()

      Returns whether the :ref:`OEFilter <OEMolProp_OEFilter>` object is in a
      valid state ready to accept molecules to its
      :oe:meth:`OEMolProp::OEFilter::operator()` method.

      .. note::

         It is nearly impossible for an end user to create an invalid
         filter. This method is here for future API design to allow
         for greater programmatic control of the
         :ref:`OEFilter <OEMolProp_OEFilter>` object.

   .. _OEMolProp_OEFilter_AddNormalizationRule:

   .. oe:method:: AddNormalizationRule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddNormalizationRule(const OEChem::OEUniMolecularRxn& rxn)

      .. oe:language:: python

         .. oe:api:: python

            AddNormalizationRule(rxn: OEUniMolecularRxn) -> bool

      Add a :ref:`OEUniMolecularRxn <OEChem_OEUniMolecularRxn>` to apply to the
      molecule. Special note should be taken about what preprocessing
      has already occurred on the molecule before generic
      normalizations are applied as described by the
      :ref:`filter_process` chapter.

      .. seealso::

         The *OEChem* manual has a chapter devoted to reactions.

   .. _OEMolProp_OEFilter_ClearNormalizationRules:

   .. oe:method:: ClearNormalizationRules

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearNormalizationRules()

      .. oe:language:: python

         .. oe:api:: python

            ClearNormalizationRules() -> None

      Remove all normalizations previously added with
      :oe:meth:`OEMolProp::OEFilter::AddNormalizationRule`.

   .. _OEMolProp_OEFilter_GetCanonOrder:

   .. oe:method:: GetCanonOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCanonOrder() const

      .. oe:language:: python

         .. oe:api:: python

            GetCanonOrder() -> bool

      Returns whether to canonicalize the atom and bond order after
      salt removal but before the molecule is altered into a neutral pH model.

      .. seealso::

         :oe:meth:`OEMolProp::OEFilter::SetCanonOrder`

   .. _OEMolProp_OEFilter_GetFilterType:

   .. oe:method:: GetFilterType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFilterType() const

      .. oe:language:: python

         .. oe:api:: python

            GetFilterType() -> int

      Return the ``unsigned integer`` constant from the
      :oe:constns:`OEMolProp::OEFilterType` namespace corresponding to
      the type of filter used to construct this object.

   .. _OEMolProp_OEFilter_GetFlagTableFailures:

   .. oe:method:: GetFlagTableFailures

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFlagTableFailures() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlagTableFailures() -> bool

      Return whether values in tabular data output are flagged with an
      asterisk marking them as outside the valid range for that filter
      rule. This is useful for figuring out why particular molecules
      have failed a given filter.

      .. seealso::

         * :ref:`molprop_examples_molproptable`
         * :oe:meth:`OEMolProp::OEFilter::SetFlagTableFailures`

   .. _OEMolProp_OEFilter_GetMessage:

   .. _OEMolProp_GetMessage:

   .. oe:method:: GetMessage

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetMessage(OEChem::OEMolBase &)
            std::string GetMessage(OEChem::OEMCMolBase &)

      .. oe:language:: python

         .. oe:api:: python

            GetMessage(arg2: Union[OEGraphMol,OEQMol]) -> str
            GetMessage(arg2: OEMol) -> str

      Return a message that is "Pass" if the molecule passes the filter, and
      a reason for failure if it does not.

   .. _OEMolProp_OEFilter_GetMMFFTypeCheck:

   .. oe:method:: GetMMFFTypeCheck

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMMFFTypeCheck() const

      .. oe:language:: python

         .. oe:api:: python

            GetMMFFTypeCheck() -> bool

      Return whether molecules sent to
      :oe:meth:`OEMolProp::OEFilter::operator()` will be
      :ref:`MMFF atom type checked <filter_process_mmff_checking>` before any
      other filtering criteria are applied. The default is ``false``.

      .. seealso::

         * :ref:`filter_process_mmff_checking`
         * :oe:meth:`OEMolProp::OEFilter::SetMMFFTypeCheck`

   .. _OEMolProp_OEFilter_GetSDTag:

   .. oe:method:: GetSDTag

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSDTag() const

      .. oe:language:: python

         .. oe:api:: python

            GetSDTag() -> bool

      Return whether to attach every molecular property checked by the
      filter as SD data to the molecule passed to the
      :oe:meth:`OEMolProp::OEFilter::operator()` method. By default the
      the :ref:`OEFilter <OEMolProp_OEFilter>` object will not attach SD data.

      .. seealso::

         :oe:meth:`OEMolProp::OEFilter::SetSDTag`

   .. _OEMolProp_OEFilter_GetTable:

   .. oe:method:: GetTable

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPlatform::oeostream* GetTable() const

      .. oe:language:: python

         .. oe:api:: python

            GetTable() -> oeostream

      Return the :ref:`oeostream <OEPlatform_oeostream>` object that tabular
      data is sent to. Will return a zero-pointer, the default, if no
      output stream has been specified.

      .. seealso::

         * :ref:`molprop_examples_molproptable`
         * :oe:meth:`OEMolProp::OEFilter::SetTable`

   .. _OEMolProp_OEFilter_GetTypeCheck:

   .. oe:method:: GetTypeCheck

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetTypeCheck() const

      .. oe:language:: python

         .. oe:api:: python

            GetTypeCheck() -> bool

      Return whether molecules sent to
      :oe:meth:`OEMolProp::OEFilter::operator()` will be
      :ref:`type checked <filter_process_type_checking>` before any
      other filtering criteria are applied. The default is ``false``.

      .. seealso::

         * :ref:`filter_process_type_checking`
         * :oe:meth:`OEMolProp::OEFilter::SetTypeCheck`

   .. _OEMolProp_OEFilter_GetpKaNormalize:

   .. oe:method:: GetpKaNormalize

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetpKaNormalize() const

      .. oe:language:: python

         .. oe:api:: python

            GetpKaNormalize() -> bool

      Return whether the pKa state of molecules sent to
      :oe:meth:`OEMolProp::OEFilter::operator()` will be normalized to
      a neutral pH. The default is ``false``.

      .. seealso::

         * :ref:`filter_process_pka_normalization`
         * :oe:meth:`OEMolProp::OEFilter::SetpKaNormalize`

   .. _OEMolProp_OEFilter_ParseNewRules:

   .. oe:method:: ParseNewRules

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ParseNewRules(OEPlatform::oeistream& rulefile)

      .. oe:language:: python

         .. oe:api:: python

            ParseNewRules(rulefile: oeistream) -> bool

      Parse the data from the ``rulefile``
      :ref:`oeistream <OEPlatform_oeistream>` as a ``NEWRULE`` file. These
      rules will override any rules specified by the :ref:`filter file
      <filter_files>` given to the :oe:meth:`OEFilter constructors
      <OEMolProp::OEFilter::Constructors>`.

      .. seealso::

         :ref:`filter_files_newrules`

   .. _OEMolProp_OEFilter_PrintConfig:

   .. oe:method:: PrintConfig

      .. oe:language:: c++ java csharp

         .. oe:api::

            void PrintConfig(OEPlatform::oeostream& log)

      .. oe:language:: python

         .. oe:api:: python

            PrintConfig(log: oeostream) -> None

      Print a human readable configuration of the object to the
      :ref:`oeostream <OEPlatform_oeostream>` ``log``.

   .. _OEMolProp_OEFilter_SetCanonOrder:

   .. oe:method:: SetCanonOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCanonOrder(bool b)

      .. oe:language:: python

         .. oe:api:: python

            SetCanonOrder(b: bool) -> None

      Specify whether the molecule atom and bond order should be
      canonicalized after salt removal but before the molecule is
      altered into a neutral pH model.

      .. seealso::

         :oe:meth:`OEMolProp::OEFilter::GetCanonOrder`

   .. _OEMolProp_OEFilter_SetErrorLevel:

   .. _OEMolProp_SetErrorLevel:

   .. oe:method:: SetErrorLevel

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetErrorLevel(unsigned int level)

      .. oe:language:: python

         .. oe:api:: python

            SetErrorLevel(level: int) -> None

      Sets the verbosity of warnings, using a level in the
      :oe:constns:`OESystem::OEErrorLevel` namespace, that
      are output when calling the operator
      :oe:meth:`OEMolProp::OEFilter::operator()` or the function
      :ref:`GetMessage <OEMolProp_GetMessage>` on the filter object.

   .. _OEMolProp_OEFilter_SetFlagTableFailures:

   .. oe:method:: SetFlagTableFailures

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFlagTableFailures(bool b)

      .. oe:language:: python

         .. oe:api:: python

            SetFlagTableFailures(b: bool) -> None

      Specify whether tabular output data  should be marked with an
      asterisk if that value exceeds the limits specified by the filter.

      .. seealso::

         * :ref:`molprop_examples_molproptable`
         * :oe:meth:`OEMolProp::OEFilter::GetFlagTableFailures`

   .. _OEMolProp_OEFilter_SetMMFFTypeCheck:

   .. oe:method:: SetMMFFTypeCheck

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMMFFTypeCheck(bool b)

      .. oe:language:: python

         .. oe:api:: python

            SetMMFFTypeCheck(b: bool) -> None

      Specify whether molecules sent to
      :oe:meth:`OEMolProp::OEFilter::operator()` will be
      :ref:`MMFF atom type checked <filter_process_mmff_checking>` before any
      other filtering criteria are applied.

      .. seealso::

         * :ref:`filter_process_mmff_checking`
         * :ref:`filter_files_typecheck` subsection describing filter files
         * :oe:meth:`OEMolProp::OEFilter::GetMMFFTypeCheck`

   .. _OEMolProp_OEFilter_SetSDTag:

   .. oe:method:: SetSDTag

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSDTag(bool b)

      .. oe:language:: python

         .. oe:api:: python

            SetSDTag(b: bool) -> None

      Specify whether to attach every molecular property checked by the
      filter as SD data to the molecule passed to the
      :oe:meth:`OEMolProp::OEFilter::operator()` method.

      .. warning::

         Only the properties up to the failing property will be
         attached by default. Use
         :oe:meth:`OEMolProp::OEFilter::SetTable` to force every
         property to be attached as SD data. The same rule applies to
         SD data as tabular output data, only the properties specified
         in the :ref:`filter file <filter_files>` will be attached as
         SD data.

      .. seealso::

         * :ref:`molprop_examples_molpropsddata`
         * :oe:meth:`OEMolProp::OEFilter::GetSDTag`

   .. _OEMolProp_OEFilter_SetTable:

   .. oe:method:: SetTable

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTable(OEPlatform::oeostream* table, bool owned)

      .. oe:language:: python

         .. oe:api:: python

            SetTable(table: oeostream, owned: bool) -> None

      Specify the :ref:`oeostream <OEPlatform_oeostream>` object that tabular
      data is sent to. The ``owned`` parameter specifies whether the
      :ref:`OEFilter <OEMolProp_OEFilter>` object should take ownership of the
      ``table`` pointer. If ``owned`` is ``true`` the
      :ref:`OEFilter <OEMolProp_OEFilter>` destructor will ``delete`` the
      ``table`` pointer, otherwise, it is the user's responsibility.

      Specifying a zero-pointer will effectively turn off
      tabular output data.

      .. oe:language:: python java

         .. note::

            The ``owned`` parameter must always be ``false`` for
            extension languages.

      .. seealso::

         * :ref:`molprop_examples_molproptable`
         * :oe:meth:`OEMolProp::OEFilter::GetTable`

   .. _OEMolProp_OEFilter_SetTypeCheck:

   .. oe:method:: SetTypeCheck

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTypeCheck(bool b)

      .. oe:language:: python

         .. oe:api:: python

            SetTypeCheck(b: bool) -> None

      Specify whether molecules sent to
      :oe:meth:`OEMolProp::OEFilter::operator()` will be
      :ref:`type checked <filter_process_type_checking>` before any
      other filtering criteria are applied.

      .. seealso::

         * :ref:`filter_process_type_checking`
         * :ref:`filter_files_typecheck` subsection describing filter files
         * :oe:meth:`OEMolProp::OEFilter::GetTypeCheck`

   .. _OEMolProp_OEFilter_SetpKaNormalize:

   .. oe:method:: SetpKaNormalize

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetpKaNormalize(bool b)

      .. oe:language:: python

         .. oe:api:: python

            SetpKaNormalize(b: bool) -> None

      Specify whether the pKa state of molecules sent to
      :oe:meth:`OEMolProp::OEFilter::operator()` will be normalized to
      a neutral pH.

      .. seealso::

         * :ref:`filter_process_pka_normalization`
         * :oe:meth:`OEMolProp::OEFilter::GetpKaNormalize`



.. _OEMolPropClasses:

*******************
OEMolProp Classes
*******************

.. oe:namespace:: OEMolProp

.. toctree::

   OEFilter
   OEXLogPResult


.. oe:namespace:: OEMolProp

.. _OEMolProp_OEXLogPResult:

.. oe:class:: OEXLogPResult

   .. oe:api::

      class OEXLogPResult

   Used by :oe:func:`OEMolProp::OEGetXLogPResult` function to return
   the computed XLogP and result status.

   .. _OEMolProp_OEXLogPResult_Constructors:

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEXLogPResult(bool valid, float value)

      .. oe:language:: python

         .. oe:api:: python

            OEXLogPResult(valid: bool, value: float) -> OEXLogPResult
            OEXLogPResult(rhs: OEXLogPResult) -> OEXLogPResult

      Constructor.  Since this class is mainly used to return values and
      status from the :oe:func:`OEMolProp::OEGetXLogPResult` function, this
      is generally not used.

   .. _OEMolProp_OEXLogPResult_operator_assign:

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEXLogPResult & operator=(const OEXLogPResult &)

      Assignment operator.

   .. _OEMolProp_OEXLogPResult_IsValid:

   .. oe:method:: IsValid()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the computed value is valid for the molecule.
      The main reason that the computation fails is that the molecule
      has one or more atoms that are not parameterized.

   .. _OEMolProp_OEXLogPResult_GetValue:

   .. oe:method:: GetValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetValue() const

      .. oe:language:: python

         .. oe:api:: python

            GetValue() -> float

      Returns the computed XLogP value.


.. oe:namespace:: OEMolProp

.. oe:constnamespace:: OEFilterParamName

   This namespace contains the default parameter names used when the
   interface generated by invoking the
   :oe:func:`OEMolProp::OEConfigureFilterParams` function.

   .. seealso::

      * :oe:constns:`OEMolProp::OEFilterParamSetup` namespace.

   The :oe:constns:`OEMolProp::OEFilterParamName` namespace contains the
   following constant:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Type

      The default name of filter type parameter is **"-filtertype"**.

      .. seealso::

         * :oe:const:`OEMolProp::OEFilterParamSetup::Type` constant
         * :oe:func:`OEMolProp::OEConfigureFilterType` function
         * :oe:func:`OEMolProp::OEGetFilterType` function



.. oe:namespace:: OEMolProp

.. oe:constnamespace:: OEFilterParamSetup

   This namespace encodes symbolic constants used as bit-masks to
   indicate which filter interface parameters are being
   created when invoking the
   :oe:func:`OEMolProp::OEConfigureFilterParams` function.

   .. seealso::

      * :oe:constns:`OEMolProp::OEFilterParamName` namespace

   The :oe:constns:`OEMolProp::OEFilterParamSetup` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of following constant:

      * :oe:const:`OEMolProp::OEFilterParamSetup::Type`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Type

      Passing this constant to the
      :oe:func:`OEMolProp::OEConfigureFilterParams` function result
      in generating the following default interface to configure
      the filter type by invoking
      the :oe:func:`OEMolProp::OEConfigureFilterType` function.

      ::

         Contents of parameter -filtertype
             Aliases : -ftype
             Type : string
             Allow list : false
             Default : BlockBuster
             Simple : true
             Required : false
             Legal values : Lead Drug BlockBuster Fragment PAINS Custom Max
             Brief : filter type

      .. seealso::

         * :oe:const:`OEMolProp::OEFilterParamName::Type` constant
         * :oe:func:`OEMolProp::OEConfigureFilterType` function
         * :oe:func:`OEMolProp::OEGetFilterType` function



.. oe:namespace:: OEMolProp

..  _OEMolProp_OEFilterType:

.. oe:constnamespace:: OEFilterType

   This namespace contains built-in filters that can be
   passed to the :oe:meth:`OEFilter constructor
   <OEMolProp::OEFilter::Constructors>`.

   .. warning::

      Go look at the :ref:`filter_files` before using any of the
      following default filters.

   .. seealso::

      :ref:`filter_theory_variations_of_filters`

   .. oe:constant:: BlockBuster

      This is the recommended default filter. We encourage you to use
      it unless you are familiar with filtering or not satisfied with
      your initial results.

      .. seealso::

         The development of this filter is described in the
         :ref:`filter_theory_variations_of_filters` section.

      .. only:: oehtml

         .. admonition:: Download filter

            :download:`filter_blockbuster.txt <../../../../../sublibs/tklibs/molprop/filter_blockbuster.txt>`

   .. oe:constant:: Default

      An alias for the current default value of
      :oe:const:`OEMolProp::OEFilterType::BlockBuster`.

   .. oe:constant:: Drug

      Corresponds to the [Oprea-2000]_ drug-like filters useful for
      later stage drug development. This is provided as a backwards
      compatible option. Experience has shown it to be too
      restrictive, the :oe:const:`OEMolProp::OEFilterType::BlockBuster`
      filter is recommended.

      .. only:: oehtml

         .. admonition:: Download filter

            :download:`filter_drug.txt <../../../../../sublibs/tklibs/molprop/filter_drug.txt>`

..  _OEMolProp_OEFilterType_Fragment:

   .. oe:constant:: Fragment

      Filter for extracting small molecules from a database.

      .. only:: oehtml

         .. admonition:: Download filter

            :download:`filter_frag.txt <../../../../../sublibs/tklibs/molprop/filter_frag.txt>`

   .. oe:constant:: Lead

      Corresponds to the [Oprea-2000]_ lead-like filters useful for
      preparing HTS databases.

      .. only:: oehtml

         .. admonition:: Download filter

            :download:`filter_lead.txt <../../../../../sublibs/tklibs/molprop/filter_lead.txt>`

   .. oe:constant:: PAINS

      Corresponds to the [Baell-2010]_ filter useful for removing
      common substructures that interfere with bioassays.

      .. seealso::

         :ref:`PAINS_theory` section

      .. only:: oehtml

         .. admonition:: Download filter

            :download:`filter_pains.txt <../../../../../sublibs/tklibs/molprop/filter_pains.txt>`

   .. oe:constant:: BlockBusterPAINS

      Combines the filtering criteria of BlockBuster and PAINS.

   .. oe:constant:: Max

      Current maximum number of provided built-in filter types.

   .. oe:constant: Unknown # IGNORING DOCUMENTATON

      Currently unused for anything.



.. _OEMolPropConstants:

*******************
OEMolProp Constants
*******************

.. oe:namespace:: OEMolProp

.. toctree::

   OEFilterType
   OEFilterParamName
   OEFilterParamSetup


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OECheckXLogXType

..  _OEMolProp_OECheckXLogXType:

.. oe:function:: OECheckXLogXType

   .. oe:language:: c++

      .. oe:api:: c++

         bool OECheckXLogXType(const OEChem::OEAtomBase* atom)

   .. oe:language:: python

      .. oe:api:: python

         OECheckXLogXType(atom: OEAtomBase) -> bool

   .. oe:language:: java

      .. oe:api:: java

        bool OECheckXLogXType(OEAtomBase atom)

   Returns true if a given atom or has a valid XLogP type as referenced in the
   :ref:`molprops_logp` section, or if the atom is a hydrogen.

   .. seealso::

      :oe:func:`OEMolProp::OEGetXLogP` function
      :oe:func:`OEMolProp::OECheckXLogXTypes` function
      :ref:`molprops_logp` section


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OECheckXLogXTypes

.. _OEMolProp_OECheckXLogXTypes:

.. oe:function:: OECheckXLogXTypes

   .. oe:language:: c++

      .. oe:api:: c++

         bool OECheckXLogXTypes(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OECheckXLogXTypes(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   .. oe:language:: java

      .. oe:api:: java

        bool OECheckXLogXTypes(OEMolBase mol)

   Returns true if each atom excluding hydrogens in the given molecule has a valid XLogP type as referenced in the
   :ref:`molprops_logp` section. Invalid types for hydrogens are ignored.

   .. seealso::

      :oe:func:`OEMolProp::OEGetXLogP` function
      :oe:func:`OEMolProp::OECheckXLogXType` function
      :ref:`molprops_logp` section


.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEConfigureFilterParams

.. _OEMolProp_OEConfigureFilterParams:

.. oe:function:: OEConfigureFilterParams

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureFilterParams(OESystem::OEInterface& itf,
                                      unsigned int config = OEFilterParamSetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureFilterParams(itf: OEInterface, config: int) -> bool

   Configures the given interface to add filter parameters.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface.
      This value has to be from the
      :oe:constns:`OEMolProp::OEFilterParamSetup` namespace.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEMolProp::OEFilterParamSetup` namespace
      * :oe:func:`OEMolProp::OEGetFilterType` function


.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEConfigureHighlightStyle

.. _OEMolProp_OEConfigureFilterType:

.. oe:function:: OEConfigureFilterType

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureFilterType(OESystem::OEInterface& itf,
                                    std::string name = OEFilterParamName::Type,
                                    std::string alias = "-ftype")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureFilterType(itf: OEInterface, name: str,
                               alias: str = "-ftype") -> bool

   Configures the given interface to add filter type parameter.

   *itf*
      The interface being configured.

   *name*
      The name of the filter type parameter.

   *alias*
      The alternative *i.e.* alias name of the parameter.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:func:`OEMolProp::OEGetFilterType` function
      * :oe:constns:`OEMolProp::OEFilterParamSetup` namespace
      * :oe:constns:`OEMolProp::OEFilterParamName` namespace
      * :oe:constns:`OEMolProp::OEFilterType` namespace


.. # split from OEMolPropFunctions.rst:12

.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGet2dPSA

.. _OEMolProp_OEGet2dPSA:

.. oe:function:: OEGet2dPSA

   .. oe:language:: c++

      .. oe:api:: c++

         bool OEGet2dPSA(const OEChem::OEMolBase& mol, float& psa,
                         float* atomPSA = 0, bool SandP = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGet2dPSA(mol: Union[OEGraphMol,OEMol,OEQMol],
                    atomPSA: OEFloatArray = None, SandP: bool = False) -> bool

   .. oe:language:: java

      .. oe:api:: java

         float OEGet2dPSA(OEMolBase mol, OEFloatArray atomPSA, boolean SandP)
         float OEGet2dPSA(OEMolBase mol, OEFloatArray atomPSA)
         float OEGet2dPSA(OEMolBase mol)

   Returns the topological polar surface area for a given molecule as
   described in the :ref:`molprops_polar_surface_area` section. The
   ``SandP`` parameter controls whether sulfur and phosphorus should be
   counted towards the total surface area.
   See example in :ref:`Figure: Example of depicting the atom contributions of
   the polar surface area <figure_OEGet2dPSA>`.

   .. note::

      TPSA values are mildly sensitive to the protonation state of a
      molecule.

   The ``atomPSA`` parameter can be used to retrieve the contribution
   of each atom to the total polar surface area as shown in
   :oe:src:`Listing 1<PSAAtomContributions>`.

   .. oe:source:: PSAAtomContributions.cpp
      :language: c++
      :frag:     SNIPPET-ATOMS
      :caption: Example of retrieving individual atom contributions to PSA
      :refnum: 1

   .. oe:source:: PSAAtomContributions.py
      :language: python
      :frag:     SNIPPET-ATOMS
      :caption:  Example of retrieving individual atom contributions to PSA.
      :refnum:   1

   ..   oe:language:: python

        :ref:`Full listing. <listing-PSAAtomContributions.py>`

   .. oe:source:: PSAAtomContributions.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ATOMS
      :caption:  Example of retrieving individual atom contributions to PSA
      :refnum:   1

   .. oe:source:: PSAAtomContributions.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ATOMS
      :caption:  Example of retrieving individual atom contributions to PSA
      :refnum:   1

   .. _figure_OEGet2dPSA:

   .. figure:: ../common/images/molprop/OEGet2dPSA.*
      :align:  center

      **Example of depicting the atom contributions of the polar surface area (ignoring S and P atoms)**

      (Darker colors and longer spikes indicate larger PSA atom contributions)

   .. _figure_OEGet2dPSA_SAndP:

   .. figure:: ../common/images/molprop/OEGet2dPSA-SAndP.*
      :align:  center

      **Example of depicting the atom contributions of the polar surface area (considering S and P atoms)**

      (Darker colors and longer spikes indicate larger PSA atom contributions)

   .. seealso::

      * :ref:`molprops_polar_surface_area` section
      * `OpenEye Python Cookbook — PSA depiction <http://docs.eyesopen.com/toolkits/cookbook/python/depiction/psa.html>`__



.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetAnionicCarbonCount

.. _OEMolProp_OEGetAnionicCarbonCount:

.. oe:function:: OEGetAnionicCarbonCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetAnionicCarbonCount(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAnionicCarbonCount(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Returns the number of anionic carbons in a molecule. Anionic carbon is
   defined as an aromatic carbon that has negative 'formal charge'.

   .. seealso::

      * :ref:`filter_files_anionic_carbon` subsection describing
        filter files
      * :oe:meth:`OEChem::OEAtomBase::IsAromatic` and :oe:meth:`OEChem::OEAtomBase::GetFormalCharge` methods
        in the **OEChem TK** manual


.. # split from OEMolPropFunctions.rst:115

.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetAromaticRingCount

.. _OEMolProp_OEGetAromaticRingCount:

.. oe:function:: OEGetAromaticRingCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEGetAromaticRingCount(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAromaticRingCount(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Returns the number of aromatic rings in a molecule as defined in
   [Ritchie-2009]_. The article describes the method as the following:

   ::

      The terminology 'number of aromatic rings' (or aromatic ring
      count) is used generically and encompasses both benzenoid
      aromatic rings and heteroaromatics (including, e.g. pyridine and
      imidazole). ... Each ring in a fused system is counted
      individually; thus, indole and naphthalene are each defined as
      having two aromatic rings.

.. some depictions would really help clear up some corner cases. check
.. out FogBugz case 6768



.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetFilterType

.. _OEMolProp_OEGetFilterType:

.. oe:function:: OEGetFilterType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetFilterType(const OESystem::OEInterface& itf,
                                      std::string name = OEFilterParamName::Type)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFilterType(itf: OEInterface, name: str) -> int

   Returns the filter type initialized in the given interface.
   The return value is taken from the :oe:constns:`OEMolProp::OEFilterType`
   namespace.

   *itf*
      The interface in which the parameter is configured.

   *name*
      The name of the parameter.

   .. seealso::

      * :oe:func:`OEMolProp::OEConfigureFilterParams` function
      * :oe:func:`OEMolProp::OEConfigureFilterType` function
      * :oe:constns:`OEMolProp::OEFilterType` namespace


.. # split from OEMolPropFunctions.rst:136

.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetFractionCsp3

.. _OEGetFractionCsp3:

.. _OEMolProp_OEGetFractionCsp3:

.. oe:function:: OEGetFractionCsp3

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEGetFractionCsp3(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFractionCsp3(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

   Returns the number of :math:`sp^3` carbons divided by the total
   number of carbons as described by Lovering and coworkers [Lovering-2009]_.

.. ################################################################
   #
   ################################################################



.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetHBondAcceptorCount

.. _OEMolProp_OEGetHBondAcceptorCount:

.. oe:function:: OEGetHBondAcceptorCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetHBondAcceptorCount(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetHBondAcceptorCount(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Returns the number of hydrogen-bond acceptors in a molecule based on
   the definition in the work of Mills and Dean ([Mills-Dean-1996]_)
   and also in the book by Jeffrey ([Jeffrey-1997]_). It is defined
   to be the number of atoms which match any of the following:

   * degree 2, aromatic, non-positive nitrogens. An example is shown below.

   .. figure:: ../common/images/molprop/acceptorDef1.*
      :width:  200pt
      :align:  center

   * electron rich or negative, valence less than 4, non-aromatic nitrogens.
     An example is shown below.

   .. figure:: ../common/images/molprop/acceptorDef2.*
      :width:  200pt
      :align:  center

   * negatively charged or not electron withdrawn, neutral, non-aromatic oxygens.
     An example is shown below.

   .. figure:: ../common/images/molprop/acceptorDef3.*
      :width:  200pt
      :align:  center

   * degree 1, double bonded, electron rich, non-aromatic sulfur. An example
     is shown below.

   .. figure:: ../common/images/molprop/acceptorDef4.*
      :width:  200pt
      :align:  center

   .. seealso::

      * :oe:func:`OEMolProp::OEGetHBondDonorCount` function
      * :oe:func:`OEMolProp::OEGetLipinskiAcceptorCount` function
      * :ref:`molprops_lipinski` section
      * :ref:`filter_files_hbond_acceptor` subsection describing filter files

   **Example**

   The :oe:func:`OEMolProp::OEGetHBondAcceptorCount` function returns ``3`` for the molecule below.

   .. figure:: ../common/images/molprop/HBAcceptor.*
      :width:  300pt
      :align:  center



.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetHBondDonorCount

.. _OEMolProp_OEGetHBondDonorCount:

.. oe:function:: OEGetHBondDonorCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetHBondDonorCount(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetHBondDonorCount(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Returns the number of hydrogen-bond donors in a molecule based on
   the definition in the work of Mills and Dean ([Mills-Dean-1996]_)
   and also in the book by Jeffrey ([Jeffrey-1997]_). It is defined
   to be the number of hydrogen atoms on nitrogen, oxygen, or sulfur atoms.

   .. seealso::

      * :oe:func:`OEMolProp::OEGetHBondAcceptorCount` function
      * :oe:func:`OEMolProp::OEGetLipinskiDonorCount` function
      * :ref:`molprops_lipinski` section
      * :ref:`filter_files_hbond_donor` subsection describing filter files

   **Example**

   The :oe:func:`OEMolProp::OEGetHBondDonorCount` function returns ``2`` for the molecule below.

   .. figure:: ../common/images/molprop/HBLDonor.*
      :width:  300pt
      :align:  center



.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetHalideFraction

.. _OEMolProp_OEGetHalideFraction:

.. oe:function:: OEGetHalideFraction

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEGetHalideFraction(const OEChem::OEMolBase& mol,
                                    bool isotopic = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetHalideFraction(mol: Union[OEGraphMol,OEMol,OEQMol],
                             isotopic: bool = False) -> float

   Returns the percent of molecular weight from halides.

   *isotopic*
      This parameter determines whether the isotopic information is taken
      into account when calculating the molecule weight.

   .. seealso::

      * :oe:func:`OEChem::OECalculateMolecularWeight` function in the **OEChem TK** manual
      * :ref:`filter_files_halide_fraction` subsection describing filter files


.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetLipinskiAcceptorCount

.. _OEMolProp_OEGetLipinskiAcceptorCount:

.. oe:function:: OEGetLipinskiAcceptorCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetLipinskiAcceptorCount(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetLipinskiAcceptorCount(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Returns the number of acceptors in a molecule based on the definition
   from the work of Lipinski ([Lipinski-1997]_). It is defined
   to be the number of nitrogens or oxygens.

   .. seealso::

      * :oe:func:`OEMolProp::OEGetLipinskiDonorCount` function
      * :oe:func:`OEMolProp::OEGetHBondAcceptorCount` function
      * :ref:`molprops_lipinski` section
      * :ref:`filter_files_lipinski_acceptor` subsection describing filter files

   **Example**

   The :oe:func:`OEMolProp::OEGetLipinskiAcceptorCount` function returns ``5`` for the molecule below.

   .. figure:: ../common/images/molprop/LAcceptor.*
      :width:  300pt
      :align:  center


.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetLipinskiDonorCount

.. _OEMolProp_OEGetLipinskiDonorCount:

.. oe:function:: OEGetLipinskiDonorCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetLipinskiDonorCount(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetLipinskiDonorCount(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Returns the number of donors in a molecule based on the definition
   from the work of Lipinski ([Lipinski-1997]_). It is defined
   to be the number of nitrogens and oxygens with at least one hydrogen attached.

   .. seealso::

      * :oe:func:`OEMolProp::OEGetLipinskiAcceptorCount` function
      * :oe:func:`OEMolProp::OEGetHBondDonorCount` function
      * :ref:`molprops_lipinski` section
      * :ref:`filter_files_lipinski_donor` subsection describing filter files

   **Example**

   The :oe:func:`OEMolProp::OEGetLipinskiDonorCount` function returns ``2`` for the molecule below.

   .. figure:: ../common/images/molprop/HBLDonor.*
      :width:  300pt
      :align:  center


.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetLongestUnbranchedCarbonsChain

.. _OEMolProp_OEGetLongestUnbranchedCarbonsChain:

.. oe:function:: OEGetLongestUnbranchedCarbonsChain

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetLongestUnbranchedCarbonsChain(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetLongestUnbranchedCarbonsChain(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Returns the size of the longest chain of all carbons in a molecule. An 
   unbranched atom is a chain atom with maximum two connections to other 
   heavy chain atoms. A set of unbranched atoms which are connected
   together form a chain.  A molecule may contain multiple chains which are isolated
   from each other by non-chain atoms (e.g. ring or branched atoms).

   .. seealso::

      * :oe:func:`OEMolProp::OEGetLongestUnbranchedHeavyAtomsChain` function
      * :ref:`filter_files_unbranched_chains` subsection describing filter files

   **Examples**

   The :oe:func:`OEMolProp::OEGetLongestUnbranchedCarbonsChain` function returns ``4`` for the molecule below.

   .. figure:: ../common/images/molprop/uchain_AllC.*
      :width:  250pt
      :align:  center

   The :oe:func:`OEMolProp::OEGetLongestUnbranchedCarbonsChain` function returns ``0`` for the molecule below.
   It is because the unbranched chain does not contain all carbons.

   .. figure:: ../common/images/molprop/uchain_carbons_NotAllC.*
      :width:  250pt
      :align:  center



.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetLongestUnbranchedHeavyAtomsChain

.. _OEMolProp_OEGetLongestUnbranchedHeavyAtomsChain:

.. oe:function:: OEGetLongestUnbranchedHeavyAtomsChain

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetLongestUnbranchedHeavyAtomsChain(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetLongestUnbranchedHeavyAtomsChain(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Returns the size of the longest chain of heavy atoms in a molecule. This is defined
   to be the maximum number of connected, unbranched, and non-ring heavy atoms.
   An unbranched atom is a chain atom with maximum two connections to other heavy 
   chain atoms. A set of unbranched atoms which are connected together form a chain. 
   A molecule may contain multiple chains which are isolated from each other by 
   non-chain atoms (e.g. ring or branched atoms).

   .. seealso::

      * :oe:func:`OEMolProp::OEGetLongestUnbranchedCarbonsChain` function
      * :ref:`filter_files_unbranched_chains` subsection describing filter files

   **Examples**

   The :oe:func:`OEMolProp::OEGetLongestUnbranchedHeavyAtomsChain` function returns ``4`` for the molecule below.

   .. figure:: ../common/images/molprop/uchain_AllC.*
      :width:  250pt
      :align:  center

   The :oe:func:`OEMolProp::OEGetLongestUnbranchedHeavyAtomsChain` function returns ``4`` for the molecule below.

   .. figure:: ../common/images/molprop/uchain_heavy_NotAllC.*
      :width:  250pt
      :align:  center



.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetNumUnspecifiedAtomStereos

.. _OEMolProp_OEGetNumUnspecifiedAtomStereos:

.. oe:function:: OEGetNumUnspecifiedAtomStereos

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetNumUnspecifiedAtomStereos(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNumUnspecifiedAtomStereos(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Returns the number of unspecified :term:`stereo atoms<stereo atom>` in a molecule. The
   :oe:func:`OEChem::OEPerceiveChiral` function will be called to perceive chiral atoms
   in the molecule.

   .. seealso::

      * :ref:`filter_files_unspecified_atom_stereos` subsection describing filter files
      * :ref:`chapter_stereochemistry` chapter in the **OEChem TK** manual
      * :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` method in the **OEChem TK** manual
      * :oe:func:`OEMolProp::OEGetNumUnspecifiedBondStereos` function



.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetNumUnspecifiedBondStereos

.. _OEMolProp_OEGetNumUnspecifiedBondStereos:

.. oe:function:: OEGetNumUnspecifiedBondStereos

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetNumUnspecifiedBondStereos(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetNumUnspecifiedBondStereos(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Returns the number of unspecified :term:`stereo bonds<stereo bond>` in a molecule. The
   :oe:func:`OEChem::OEPerceiveChiral` function will be called to perceive chiral bonds
   in the molecule.

   .. seealso::

      * :ref:`filter_files_unspecified_bond_stereos` subsection describing
        filter files
      * :ref:`chapter_stereochemistry` chapter in the **OEChem TK** manual
      * :oe:meth:`OEChem::OEBondBase::HasStereoSpecified` method in the **OEChem TK** manual
      * :oe:func:`OEMolProp::OEGetNumUnspecifiedAtomStereos` function



.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetRotatableBondCount

..  _OEMolProp_OEGetRotatableBondCount:

.. _OEMolProp_OEGetRotatableBondCount:

.. oe:function:: OEGetRotatableBondCount

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetRotatableBondCount(const OEChem::OEMolBase& mol,
                                              bool adjust = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetRotatableBondCount(mol: Union[OEGraphMol,OEMol,OEQMol],
                                 adjust: bool = False) -> int

   Returns the number of rotatable bond counts in a molecule. :term:`Rotatable<rotatable bond>`
   bond is defined as any single non-ring bond, bounded to nonterminal heavy (i.e., non-hydrogen) atom.
   In addition, It considers the carbon-carbon triple bond in acetylene rotatable. The function
   excludes single bonds observed in a certain groups, such as sulfonamides, esters, and amidine.

   **adjust**
      This parameter allows optional adjustment for aliphatic rings following the method of
      [Oprea-2000]_. In this case, it also estimates the number of
      flexible bonds in aliphatics rings.

   .. note::

      The Oprea's method is individual ring based. Since *Smallest set of smallest rings*
      perception is not available in **OEChem TK**
      (see section :ref:`section_sssr` for more details), we modified
      Oprea's method to be ring system based
      (:ref:`section_ring_system_identification`), and implemented the
      function relatively closed to Oprea's definition. The function
      works for various complex fused ring-systems and simple bridge
      ring-systems.

   **Examples**

   The number of rotatable bonds calculated for the molecule below is ``0``.
   When considering the flexibility of the aliphatic ring
   (setting the **adjust** parameter to ``true``), the
   :oe:func:`OEMolProp::OEGetRotatableBondCount` function returns `3`,
   based on Oprea's method that considers the amide bonds as non-rotatable.

   .. figure:: ../common/images/molprop/rtb-001.*
      :align:  center

      **Example of aliphatic ring**

   The number of rotatable bonds calculated for the molecule below is ``7``.
   When considering the flexibility of the aliphatic ring
   (setting the **adjust** parameter to ``true``), the
   :oe:func:`OEMolProp::OEGetRotatableBondCount` function returns ``11``,
   adjusting the rotatable bond count by ``2`` from each of the two aliphatic
   rings.

   .. figure:: ../common/images/molprop/rtb-002.*
      :align:  center

      **Example of rotatable bond count adjustment for aliphatic rings**

   .. seealso::

      * :ref:`filter_files_rotor_count` subsection describing filter files
      * :term:`rotatable bond` definition in **OEChem TK**
      * :ref:`OEIsRotor <OEChem_OEIsRotor>` functor in **OEChem TK**
      * :ref:`section_sssr` and :ref:`section_ring_system_identification` sections in  **OEChem TK**


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetXLogP

.. _OEMolProp_OEGetXLogP:

.. oe:function:: OEGetXLogP

   .. oe:language:: c++

      .. oe:api:: c++

         bool OEGetXLogP(const OEChem::OEMolBase& mol, float& xlogp,
                         float* atomxlogps = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEGetXLogP(mol: Union[OEGraphMol,OEMol,OEQMol],
                    atomxlogps: OEFloatArray = None) -> bool

   .. oe:language:: java

      .. oe:api:: java

         float OEGetXLogP(OEMolBase mol, OEFloatArray atomxlogps)
         float OEGetXLogP(OEMolBase mol)

   Returns the XLogP for a given molecule as described in the
   :ref:`molprops_logp` section. The returned value will be equal to
   the sum on the individual atom contributions plus the linear
   regression constant ``-0.127``.

   .. oe:language:: python java csharp

      .. note::

         The C++ version of this function uses a pointer-to-argument to indicate
         the success or failure of the computation. This idiom doesn't map
         directly to the wrapped languages, so the wrapped versions of
         :oe:func:`OEMolProp::OEGetXLogP`
         use exceptions to signal failure.  This is not optimal. Hence, for the
         wrapped languages, the **preferred method for computing XLogP** is
         :oe:func:`OEMolProp::OEGetXLogPResult`.
         It does not use exceptions and is much cleaner to use in the wrapped languages.

   .. oe:language:: c++

      The ``atomxlogps`` parameter can be used to retrieve the contribution
      of each atom to the total XLogP as shown in
      :oe:src:`Listing 2<XLogPAtomContributions>`.
      See example in :ref:`Figure: Example of depicting the atom contributions
      of the XLogP<figure_OEGetXLogP>`.

      .. oe:source:: XLogPAtomContributions.cpp
         :language: c++
         :frag:     SNIPPET-ATOMS
         :caption: Example of retrieving individual atom contributions to XLogP
         :refnum: 2

      .. _figure_OEGetXLogP:

      .. figure:: ../common/images/molprop/OEGetXLogP.*
         :align:  center

         **Example of depicting the atom contributions of the XLogP**

   .. note::

      XLogP should be calculated on the neutral form of the molecule.
      Therefore, calling the :oe:func:`OEProton::OERemoveFormalCharge` function
      of **Quacpac TK** is highly recommended prior to the XLogP calculation.

   .. seealso::

      * :oe:func:`OEMolProp::OEGetXLogPResult` function
      * :ref:`molprops_logp` section


.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. OECHEM TK

.. _Manipulating Large Molecule Files:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb.html
.. _Enumerating Fragment Combinations:                https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumfrags.html
.. _Ring Perception:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/ringperception.html
.. _Enumerating Atom Substitutions:                   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/enumsubs.html
.. _Reordering CSV File:                              https://docs.eyesopen.com/python_modules/cookbook/misc/reordercsv.html

.. PEPTIDE INFORMATICS TK

.. _Generating Custom Monomer Set:      https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/aminoacids2monomerset.html
.. _Convert HELM to SMILES:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helm2smiles.html
.. _Convert HELM File to Molecule File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/helms2mols.html
.. _Convert SMILES to HELM:             https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/smiles2helm.html
.. _Convert Molecule File to HELM File: https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mols2helms.html
.. _Generate Random Peptides:           https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/random_peptides.html
.. _Mutate Peptide:                     https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/mutate_peptide.html

.. OEBIO TK

.. _Accessing Interaction Hint Information:                                  https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions.html
.. _Print Protein-Ligand Interactions to Console:                            https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2console.html
.. _Print the Summary of Protein-Ligand Interactions for a Set of Molecules: https://docs.eyesopen.com/python_modules/cookbook/cheminfo/interactions2summary.html

.. OEDEPICT TK

.. _Generating Transparent PNG:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/transparent.html

.. _Depicting Reaction Components:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/reaction.html
.. _Depicting Multiple Matches:                       https://docs.eyesopen.com/python_modules/cookbook/depiction/multi-matches.html
.. _Highlighting Fragments:                           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Library Generation:                     https://docs.eyesopen.com/python_modules/cookbook/depiction/libgen.html
.. _Depicting Molecular Graph Symmetry:               https://docs.eyesopen.com/python_modules/cookbook/depiction/symmetry.html

.. GRAPHEME TK
 
.. _Visualizing Protein-Ligand Contacts:              https://docs.eyesopen.com/python_modules/cookbook/visualization/contactmap.html
.. _Visualizing Protein-Ligand Interactions:          https://docs.eyesopen.com/python_modules/cookbook/visualization/complex.html
.. _Visualizing Protein-Ligand Unpaired Interactions: https://docs.eyesopen.com/python_modules/cookbook/visualization/unpairedmap.html
.. _Visualizing Protein-Ligand B-Factor:              https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactor.html
.. _Visualizing Protein-Ligand B-Factor Map:          https://docs.eyesopen.com/python_modules/cookbook/visualization/bfactormap.html
.. _Visualizing Protein-Ligand Maps:                  https://docs.eyesopen.com/python_modules/cookbook/visualization/activesitemaps.html
.. _Visualizing Torsional Angle Distribution:         https://docs.eyesopen.com/python_modules/cookbook/visualization/dihedral.html
.. _Visualizing Electron Density:                     https://docs.eyesopen.com/python_modules/cookbook/visualization/electron-density.html
.. _Visualizing Molecular Dipole Moment:              https://docs.eyesopen.com/python_modules/cookbook/visualization/dipole.html
.. _Visualizing Shape and Color Overlap:              https://docs.eyesopen.com/python_modules/cookbook/visualization/shapeoverlap.html
.. _Ramachandran Plot:                                https://docs.eyesopen.com/python_modules/cookbook/visualization/rama.html
.. _Depicting Molecular Properties:                   https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html
.. _Depict Peptide:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptide2img.html
.. _Depict Monomer:                                   https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/monomer2img.html

.. GRAPHSIM TK

.. _Drawing Fingerprint Score Histogram:                 https://docs.eyesopen.com/python_modules/cookbook/plotting/fphist.html
.. _Similarity Searching of Large Molecule Files:        https://docs.eyesopen.com/python_modules/cookbook/cheminfo/moldb-fpdb.html
.. _Rapid Similarity Searching of Large Molecule File:   https://docs.eyesopen.com/python_modules/cookbook/cheminfo/fastfpdb.html
.. _Finding Core Fragment of a Molecule Series:          https://docs.eyesopen.com/python_modules/cookbook/cheminfo/core.html
.. _Depicting Molecule Similarity Based on Fingerprints: https://docs.eyesopen.com/python_modules/cookbook/depiction/simcalc.html

.. MOLPROP TK

.. _Depicting Atom Contributions of XLogP:               https://docs.eyesopen.com/python_modules/cookbook/depiction/xlogp.html
.. _Depicting Fragment Contributions of XLogP:           https://docs.eyesopen.com/python_modules/cookbook/depiction/fragxlogp.html
.. _Depicting Topological Polar Surface Area:            https://docs.eyesopen.com/python_modules/cookbook/depiction/psa.html
.. _Depicting Molecular Properties:                      https://docs.eyesopen.com/python_modules/cookbook/depiction/properties.html

.. MEDCHEM TK

.. _Highlighting Fragments:                             https://docs.eyesopen.com/python_modules/cookbook/depiction/fragments.html
.. _Depicting Fragment Combinations:                    https://docs.eyesopen.com/python_modules/cookbook/depiction/enumfrags.html


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetXLogPResult

.. _OEMolProp_OEGetXLogPResult:

.. oe:function:: OEGetXLogPResult

   .. oe:language:: c++

      .. oe:api:: c++

         OEXLogPResult OEGetXLogPResult(const OEChem::OEMolBase& mol,
                                        float* atomxlogps = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEGetXLogPResult(mol: Union[OEGraphMol,OEMol,OEQMol],
                          atomxlogps: OEFloatArray = None) -> OEXLogPResult

   .. oe:language:: java

      .. oe:api:: java

         OEXLogPResult OEGetXLogPResult(OEMolBase mol, OEFloatArray atomxlogps)
         OEXLogPResult OEGetXLogPResult(OEMolBase mol)

   Returns an :ref:`OEXLogPResult <OEMolProp_OEXLogPResult>` object. The object contains
   the XLogP for the given molecule as described in the :ref:`molprops_logp`
   section and a boolean flag indicating whether or not the computation is
   valid.  The main reason the computation may fail is if one or more atoms
   are not parameterized.  The returned value will be equal to the sum on the
   individual atom contributions plus the linear regression
   constant ``-0.127``.

   .. hint::

      XLogP should be calculated on the neutral form of the molecule.
      Therefore, calling the :oe:func:`OEProton::OERemoveFormalCharge` function
      of **Quacpac TK** is highly recommended prior to the XLogP calculation.

   .. oe:language:: python java csharp

      The ``atomxlogps`` parameter can be used to retrieve the contribution
      of each atom to the total XLogP as shown in
      :oe:src:`Listing 2<XLogPAtomContributions>`.
      See example in :ref:`Figure: Example of depicting the atom contributions
      of the XLogP<figure_OEGetXLogP>`.

      This function exists to make the calling by wrapped languages more
      convenient.  This function should be **preferred over** the original
      :oe:func:`OEMolProp::OEGetXLogP` function for wrapped languages.

      .. oe:source:: XLogPAtomContributions.py
         :language: python
         :frag:     SNIPPET-ATOMS
         :caption: Example of retrieving individual atom contributions to XLogP
         :refnum: 2

      ..    oe:language:: python

            :ref:`Full listing. <listing-XLogPAtomContributions.py>`

      .. oe:source:: XLogPAtomContributions.java
         :language: java
         :noindent:
         :frag:     SNIPPET-ATOMS
         :caption: Example of retrieving individual atom contributions to XLogP
         :refnum: 2

      .. oe:source:: XLogPAtomContributions.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-ATOMS
         :caption: Example of retrieving individual atom contributions to XLogP
         :refnum: 2

      .. _figure_OEGetXLogP:

      .. figure:: ../common/images/molprop/OEGetXLogP.*
         :align:  center

         **Example of depicting the atom contributions of the XLogP**

   .. seealso::

      :ref:`OEXLogPResult <OEMolProp_OEXLogPResult>` class
      :ref:`molprops_logp` section

   .. admonition:: Code Example

      * `Depicting Atom Contributions of XLogP`_ **OpenEye Python Cookbook** recipe
      * `Depicting Fragment Contributions of XLogP`_ **OpenEye Python Cookbook** recipe


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEGetXLogPVersion

.. _OEMolProp_OEGetXLogPVersion:

.. oe:function:: OEGetXLogPVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetXLogPVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEGetXLogPVersion() -> str

   Returns the version number for the current XLogP computation as
   a string.


.. # split from OEMolPropFunctions.rst:230

.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEMolPropGetArch

.. _OEMolProp_OEMolPropGetArch:

.. oe:function:: OEMolPropGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEMolPropGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEMolPropGetArch() -> str



.. # split from OEMolPropFunctions.rst:237

.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEMolPropGetLicensee

.. _OEMolProp_OEMolPropGetLicensee:

.. oe:function:: OEMolPropGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMolPropGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEMolPropGetLicensee(licensee: str) -> bool



.. # split from OEMolPropFunctions.rst:244

.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEMolPropGetPlatform

.. _OEMolProp_OEMolPropGetPlatform:

.. oe:function:: OEMolPropGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEMolPropGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEMolPropGetPlatform() -> str



.. # split from OEMolPropFunctions.rst:251

.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEMolPropGetRelease

.. _OEMolProp_OEMolPropGetRelease:

.. oe:function:: OEMolPropGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEMolPropGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEMolPropGetRelease() -> str



.. # split from OEMolPropFunctions.rst:258

.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEMolPropGetSite

.. _OEMolProp_OEMolPropGetSite:

.. oe:function:: OEMolPropGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMolPropGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEMolPropGetSite(site: str) -> bool



.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEMolPropGetVersion

.. _OEMolProp_OEMolPropGetVersion:

.. oe:function:: OEMolPropGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEMolPropGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEMolPropGetVersion() -> int


.. meta::
   :keywords: OEMolPropIsLicensed

.. oe:namespace:: OEMolProp

.. _OEMolProp_OEMolPropIsLicensed:

.. oe:function:: OEMolPropIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMolPropIsLicensed(const char* feature = 0,
                                  unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEMolPropIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **MolProp TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **MolProp TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **MolProp TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function


.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. oe:namespace:: OEMolProp

.. meta::
   :keywords: OEWritePropertyDataToCSV

.. _OEMolProp_OEWritePropertyDataToCSV:

.. oe:function:: OEWritePropertyDataToCSV

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWritePropertyDataToCSV(const std::string& fname,
                                       OEChem::oemolistream& ifs,
                                       OEMolProp::OEFilter& filter)
         bool OEWritePropertyDataToCSV(OEChem::oemolostream& ofs,
                                       OEChem::oemolistream& ifs,
                                       OEMolProp::OEFilter& filter)

   .. oe:language:: python

      .. oe:api:: python

         OEWritePropertyDataToCSV(fname: str, ifs: oemolistream,
                                  filter: OEFilter) -> bool
         OEWritePropertyDataToCSV(ofs: oemolostream, ifs: oemolistream,
                                  filter: OEFilter) -> bool

   Write the molecular properties calculated by :ref:`OEFilter <OEMolProp_OEFilter>` to the output file ``fname``
   or to the stream ``ofs`` in the :oe:const:`OEChem::OEFormat::CSV` format. Returns ``true`` if the output 
   CSV file was successfully written, ``false`` otherwise.

   Molecules are read in from the input stream ``ifs``. The output CSV file can be read by the 
   :oe:func:`OEChem::OEReadCSVFile` function.

   .. seealso::

      * :ref:`section_moltaggeddata_CSV` section

   .. admonition:: Code Example

      * :ref:`molprop_examples_molpropcsv` example


*******************************************************************************
OEMolProp Functions
*******************************************************************************

.. _molprop_functions:

.. toctree::
   :maxdepth: 1

   OECheckXLogXType.rst
   OECheckXLogXTypes.rst
   OEConfigureFilterParams.rst
   OEConfigureFilterType.rst
   OEGet2dPSA.rst
   OEGetAnionicCarbonCount.rst
   OEGetAromaticRingCount.rst
   OEGetFilterType.rst
   OEGetFractionCsp3.rst
   OEGetHalideFraction.rst
   OEGetHBondAcceptorCount.rst
   OEGetHBondDonorCount.rst
   OEGetLipinskiAcceptorCount.rst
   OEGetLipinskiDonorCount.rst
   OEGetLongestUnbranchedHeavyAtomsChain.rst
   OEGetLongestUnbranchedCarbonsChain.rst
   OEGetNumUnspecifiedAtomStereos.rst
   OEGetNumUnspecifiedBondStereos.rst
   OEGetRotatableBondCount.rst
   OEGetXLogP.rst
   OEGetXLogPResult.rst
   OEGetXLogPVersion.rst
   OEMolPropGetArch.rst
   OEMolPropGetLicensee.rst
   OEMolPropGetPlatform.rst
   OEMolPropGetRelease.rst
   OEMolPropGetSite.rst
   OEMolPropGetVersion.rst
   OEMolPropIsLicensed.rst
   OEWritePropertyDataToCSV.rst


.. _molprop_part_api:

*****
API
*****

.. toctree::
   :maxdepth: 2

   OEMolPropClasses/OEMolPropClasses
   OEMolPropConstants/OEMolPropConstants
   OEMolPropFunctions/index



.. _molprop_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version2_7_0
   version2_6_7
   version2_6_6
   version2_6_5
   version2_6_4
   version2_6_3
   version2_6_2
   version2_6_1
   version2_6_0
   version2_5_7
   version2_5_6
   version2_5_5
   version2_5_4
   version2_5_3
   version2_5_2
   version2_5_1
   version2_5_0
   version2_4_7
   version2_4_6
   version2_4_5
   version2_4_4
   version2_4_3
   version2_4_2 
   version2_4_1
   version2_4_0
   version2_3_0
   version2_2_2
   version2_2_1
   version2_2_0
   version2_1_7
   version2_1_6
   version2_1_5
   version2_1_4
   version2_1_3
   version2_1_2
   version2_1_1
   version2_1_0



MolProp TK 2.7.0
================================================================================

Minor Bug Fixes
--------------------------------------------------------------------------------

* The SMARTS pattern of the :ref:`functional_group_rules_halo_amine` functional group has been fixed.



MolProp TK 2.1.0
================================================================================

This is the first release of the OEMolProp toolkit. 
Its version number corresponds to version number of the Filter application.




MolProp TK 2.1.1
================================================================================

New features
--------------------------------------------------------------------------------

* Added several halide that are more strict to the fragment filter.

* Added several rules to remove bad ring systems to the fragment
  filter.

.. oe:project:: toolkits
   
   * Added :oe:func:`OEMolProp::OEGetFractionCsp3`, a function for the
     fraction of carbons that are sp3. 

   * Added :oe:func:`OEMolProp::OEGetAromaticRingCount`, a function for
     Frere-Jacques count on aromatic systems. 

.. oe:project:: toolkits

   * The OEFilter constructor will now ``OEThrow.Error`` if a duplicate
     ``RULE`` line is found in the filter file definition. 

.. oe:project:: filter

   * FILTER will now throw an error if duplicate ``RULE`` lines are
     found in the filter file. 

.. note:: 

   The proper way to override a ``RULE`` line is to use a ``NEWRULE`` line.

Minor bug fixes
--------------------------------------------------------------------------------

* Removing duplicate nitroso and phosphoryl filter file RULES from the
  default filters. 



MolProp TK 2.1.2
================================================================================

* Minor documentation fixes. 


.. _section_molprop_releasenotes_213:

MolProp TK 2.1.3
================================================================================

New features
--------------------------------------------------------------------------------

* Adding pictures to describe :oe:func:`OEMolProp::OEGetXLogP` and
  :oe:func:`OEMolProp::OEGet2dPSA` in documentation.

* :ref:`OEFilter <OEMolProp_OEFilter>` through its dependence on Neutral pH model
  (:oe:func:`OEProton::OESetNeutralpHModel`) has been refined to reflect 
  feedback from collaborators.  In particular isoxazoles and oxadiazoles were 
  added while pyrazoles and aryl sulfonamides were refined.  Aryl sulfonamide 
  refinement also incorporated changes based on newly obtained experimental data.

Minor bug fixes
--------------------------------------------------------------------------------

* Through its dependence on :oe:func:`OEProton::OESetNeutralpHModel` 
  :ref:`OEFilter <OEMolProp_OEFilter>` now correctly addresses beta di-amino groups
  so that if all other considerations are equivalent, secondary amines are 
  treated as most basic, followed by primary amines, with tertiary amine being
  treated as least basic.




.. _section_molprop_releasenotes_214:

MolProp TK 2.1.4
================================================================================

* The :ref:`OEFilter <OEMolProp_OEFilter>` object will now canonicalize atom and bond
  order by default. This avoids the problem of the normalization and
  duplicate removal steps being dependent on input atom order.




.. _section_molprop_releasenotes_215:

MolProp TK 2.1.5
================================================================================

* Minor internal improvements. 




.. _section_molprop_releasenotes_216:

MolProp TK 2.1.6
================================================================================

Bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEMolProp::OEFilter::operator()` will now call
  :oe:func:`OEChem::OEPrepareSearch` on the molecule to ensure the
  molecule has all the proper properties initialized for
  :ref:`OEFilter <OEMolProp_OEFilter>` SMARTS matches.




.. _section_molprop_releasenotes_217:

MolProp TK 2.1.7
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

- "MIN_*" and "MAX_*" properties filter rules file no longer have to
  both be specified to work. Previously, if a property filter was
  specified with "MAX_*", then the corresponding "MIN_*" filter rule
  had to also be set for the rule to properly function. Now, "MIN_*"
  and "MAX*" filter rules operate independent of the other.



.. _section_molprop_releasenotes_220:

MolProp TK 2.2.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

.. oe:language:: java

   * :oe:meth:`OEMolProp::OEFilter::SetTable` no longer takes two arguments.
     The boolean denoting ownership of the oeostream was removed.  Setting the 
     ownership argument to true causes a race condition with the garbage collector
     and therefore crashes.

* Based on new, more reliable pKa data, the "malonic" keyword was refined to identify 
  malonic acid specifically (pKa 2.9, 5.7) rather than generic di-carbonyl carbon 
  acids, which typically have pKa values in the 8.9-11.5 range.  This improves the 
  reliability of the "acid" pattern as well, which is dependent on the "malonic" keyword.

Documentation changes
--------------------------------------------------------------------------------

* Lipinski H-Bond donor is now properly described in the
  documentation. The implementation was already correct.




.. _section_molprop_releasenotes_221:

MolProp TK 2.2.1
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEMolProp::OEGetXLogP` is now thread safe. 

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEMolProp::OEGetXLogP` will no longer return garbage data
  in the per atom data array whenever molecules with deleted atoms are
  passed to the function.

* :ref:`OEFilter <OEMolProp_OEFilter>` carboxylic acid pattern will now match
  formic acid, formic esters, and formic thioesters with implicit
  hydrogens. Previously, explicit hydrogens were required on the
  molecule.

Minor bug fixes
--------------------------------------------------------------------------------

* Removed unbounded stack allocations. 



.. _section_molprop_releasenotes_222:

MolProp TK 2.2.2
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Typecheck functionality, :oe:meth:`OEMolProp::OEFilter::SetTypeCheck`,
  has been changed such that hexavalent sulfur (matching SMARTS
  [Sv6D6]) will now be an acceptable atom type.

Documentation fixes
--------------------------------------------------------------------------------

* The linear regression constant used by
  :oe:func:`OEMolProp::OEGetXLogP` is now documented.

* PDF documentation should no longer throw warnings about "bad /BBox"
  in some PDF readers.



.. |product| replace:: MolProp TK
.. |JMC| replace:: Journal of Medicinal Chemistry


.. _section_molprop_releasenotes_230:

MolProp TK 2.3.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new :oe:meth:`OEMolProp::OEFilter::GetFilterType` method has been added for
  retrieving the filter used to construct the :ref:`OEFilter <OEMolProp_OEFilter>` object.

Documentation fixes
--------------------------------------------------------------------------------

* The :ref:`Functional Group Rules <functional_group_rules>` section
  has been updated with much better **OEDepict TK 2.x**-generated images
  of functional groups. The section should be significantly
  easier to read with the updated style.

* The example program :ref:`molprop_examples_molpropsddata` will now allow
  output to the ``.csv`` file format.


.. _section_molprop_releasenotes_240:

.. |JMC| replace:: *Journal of Medicinal Chemistry*

MolProp TK 2.4.0
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:const:`OEMolProp::OEFilterType::PAINS` is a new filter
  for removing substructures that commonly cause problems in bioassays. The
  SMARTS patterns used in this filter have been adapted from the SLN patterns
  in the original paper:

     | Baell, J.B. and Holloway G.A.,
     | New Substructure Filters for Removal of Pan Assay Interference Compounds (PAINS) from Screening Libraries and for Their Exclusion in Bioassays,
     | |JMC|, Vol 53, pp. 2719-2740, 2010

  .. seealso::

     The :ref:`PAINS_theory` section.

Bug fixes
--------------------------------------------------------------------------------

* The displayed precision of the numerical values output in log messages are
  more realistic and now match the table output precision.

* :oe:meth:`OEMolProp::OEFilter::operator()` method now skips the
  calculation of certain physical properties if the filter being used does
  not require them and a table is not being generated.  This quiets erroneous
  warnings for molecules that could be generated by those property
  calculations.



MolProp TK 2.4.1
================================================================================

New features
--------------------------------------------------------------------------------

* A new built-in filter for MMFF atom types has been added that can identify
  and eliminate molecules that have one or more unknown MMFF atom type
  assignments.  The ``MMFFTYPECHECK`` directive in rule files controls the
  behavior.  The :oe:meth:`OEMolProp::OEFilter::SetMMFFTypeCheck` and
  :oe:meth:`OEMolProp::OEFilter::GetMMFFTypeCheck` methods control the
  behavior when using an :ref:`OEFilter <OEMolProp_OEFilter>` object.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEMolProp::OEFilter::operator()` now handles multi-conformer
  molecules.

Minor bug fixes
--------------------------------------------------------------------------------

* The pattern for ``beta_carbonyl_quat_nitrogen`` had previously incorrectly matched
  tertiary amines as well as quaternary amines. This has been fixed.


MolProp TK 2.4.2
================================================================================

* Minor internal improvements have been made.


MolProp TK 2.4.3
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* An issue that affected XLogP values depending on the aromaticity model
  perception has been repaired.
  :oe:func:`OEMolProp::OEGetXLogP` function now re-perceives the **OpenEye**
  aromaticity model when necessary before calculating XLogP values.

* A filter with a non-zero MIN_UNBRANCHED_C had previously failed
  and now is properly calculated.


MolProp TK 2.4.4
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The definition for the SMARTS for the CBoring (straight-chain alkane)
  fragment in the filter fragment set has been changed from
  ``[CR0H2][CH2][CH2][CH2,H3]`` to ``[CR0H2][CH2][CH2][CH2,CH3]``.
  Previously, it could erroneously match a heteroatom at the last position.

Documentation changes
--------------------------------------------------------------------------------

* Minor corrections to the bibliography have been made.


MolProp TK 2.4.5
================================================================================

* Minor internal improvements have been made.


MolProp TK 2.4.6
================================================================================

* Minor internal improvements have been made.


MolProp TK 2.4.7
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The ``pains_pre_aminal1`` rule has been removed from the PAINS filter.  The
  SMARTS for the rule was incorrectly defined and was overly general.  The
  rules ``pains_basic_amine1``, ``pains_basic_amine2``, and
  ``pains_basic_amine3`` cover the same general structural classes in a more
  precise manner.  A SMARTS issue with the ``pains_basic_amine3``, uncovered
  after removing the ``pains_pre_aminal1`` rule, has also been corrected.


MolProp TK 2.5.0
================================================================================

Bug fixes
--------------------------------------------------------------------------------

* The ``aminal`` and ``hemiaminal`` SMARTS rules have been modified to be
  slightly more general.  Both rules now match 1,1-diamines as well
  as hydroxyl amines.


MolProp TK 2.5.1
================================================================================

* Minor internal improvements have been made.


MolProp TK 2.5.2
================================================================================

New features
--------------------------------------------------------------------------------

* A new :oe:func:`OEMolProp::OEGetRotatableBondCount` function has been added that
  can calculate either the number of rotatable bonds in the molecule or the
  molecule flexibility, taking into consideration the flexibility of aliphatic rings.

* New :oe:func:`OEMolProp::OEConfigureFilterParams` and
  :oe:func:`OEMolProp::OEConfigureFilterType` functions have been added to
  configure the given interface.

* A new :oe:func:`OEMolProp::OEGetFilterType` function has been added to
  retrieve the filter type initialized in the given interface.

* New :oe:constns:`OEMolProp::OEFilterParamSetup`,
  :oe:constns:`OEMolProp::OEFilterParamName`, and
  :oe:constns:`OEMolProp::OEFilterType` namespaces have been added to
  provide options for the choice of filter interface parameters, filter
  parameter names, and filter types, respectively.

Documentation changes
--------------------------------------------------------------------------------

* The following five example programs have been updated to allow switching filter types
  through the command line option:

  * :ref:`molprop_examples_molfilter`
  * :ref:`molprop_examples_quietfilter`
  * :ref:`molprop_examples_molproptable`
  * :ref:`molprop_examples_specificmolprop`
  * :ref:`molprop_examples_molpropsddata`


MolProp TK 2.5.3
================================================================================

New features
--------------------------------------------------------------------------------

* Two new functions, :oe:func:`OEMolProp::OEGetHBondDonorCount` and
  :oe:func:`OEMolProp::OEGetHBondAcceptorCount`, have been added that
  count the number of hydrogen-bond donors and acceptors in a molecule.

* Two new functions, :oe:func:`OEMolProp::OEGetLipinskiDonorCount` and
  :oe:func:`OEMolProp::OEGetLipinskiAcceptorCount`, have been added that
  determine the number of donors and acceptors in a molecule based on the definition
  from the work of Lipinski ([Lipinski-1997]_).

* A new function, :oe:func:`OEMolProp::OEGetLongestUnbranchedHeavyAtomsChain`,
  has been added that determines the size of the longest chain of heavy atoms in a
  molecule.

* A new function, :oe:func:`OEMolProp::OEGetLongestUnbranchedCarbonsChain`,
  has been added that determines the size of the longest chain of all carbons in a
  molecule.

* A new function, :oe:func:`OEMolProp::OEGetHalideFraction`, has been added
  that determines the percentage of molecular weight from halides.

* A new function, :oe:func:`OEMolProp::OEGetAnionicCarbonCount`, has been added
  that determines the number of anionic carbons in a molecule. New filter options,
  ``MIN_ANION_C`` and ``MAX_ANION_C``, have also been added that filter out
  anionic carbons.

* A new function, :oe:func:`OEMolProp::OEWritePropertyDataToCSV`, has been added
  that writes molecular properties to the output in the
  :oe:const:`OEChem::OEFormat::CSV` format.

* Two new functions, :oe:func:`OEMolProp::OEGetNumUnspecifiedAtomStereos` and
  :oe:func:`OEMolProp::OEGetNumUnspecifiedBondStereos`, have been added that filter out molecules with unspecified atom and bond stereos.
  New filter options, ``MIN_UNSPECIFIED_ATOM_STEREOS``, ``MAX_UNSPECIFIED_ATOM_STEREOS``,
  ``MIN_UNSPECIFIED_BOND_STEREOS``, and ``MAX_UNSPECIFIED_BOND_STEREOS``, have
  also been added.

Minor bug fixes
--------------------------------------------------------------------------------

* The XLogP calculation by the :oe:func:`OEMolProp::OEGetXLogPResult`
  function for molecules with explicit hydrogens has been fixed.

Documentation changes
--------------------------------------------------------------------------------

* A new program, :ref:`molprop_examples_molpropcsv`, has been added that
  demonstrates writing molecular properties to an output file in the :oe:const:`OEChem::OEFormat::CSV` format.




MolProp TK 2.5.4
================================================================================

* Minor internal improvements have been made.



MolProp TK 2.5.5
================================================================================

*Fall 2020*

* Minor internal improvements have been made.



MolProp TK 2.5.6
================================================================================

*July 2021*

Minor bug fixes
--------------------------------------------------------------------------------

* An issue with :ref:`OEGetRotatableBondCount <OEMolProp_OEGetRotatableBondCount>` counting carbamates
  and ureas as rotatable has been fixed.




MolProp TK 2.5.7
================================================================================

*Fall 2021*

New Features
---------------------------------------------------------------------------------

* A method, :ref:`GetMessage <OEMolProp_GetMessage>`, was added to the :ref:`OEFilter <OEMolProp_OEFilter>` class
  to be able to retrieve
  information on whether the filter passed a molecule, or why it failed
  a specific molecule.

* A method, :ref:`SetErrorLevel <OEMolProp_SetErrorLevel>`, was added to
  the :ref:`OEFilter <OEMolProp_OEFilter>` class
  to add explicit control of
  warnings output by the filter class and the filter application.

* A BlockBusterPAINS filter was added in the :ref:`OEFilterType <OEMolProp_OEFilterType>` namespace,
  which   combines filtering criteria   for the BlockBuster and   PAINS filters .

* Excess warning output that was causing large log files is now suppressed by default,
  and can be switched on using the new :ref:`SetErrorLevel <OEMolProp_SetErrorLevel>` method.
  See :ref:`OEFilterType <OEMolProp_OEFilterType>`.





MolProp TK 2.6.0
================================================================================

New features
--------------------------------------------------------------------------------

* The ability to filter based on aromatic ring count and fraction of CSP3 carbons has been added.




MolProp TK 2.6.1
================================================================================

New features
--------------------------------------------------------------------------------

* A new free function, :ref:`OECheckXLogXType <OEMolProp_OECheckXLogXType>`, that returns ``true`` if an atom has a
  valid XLogPType has been added.

* A new free function, :ref:`OECheckXLogXTypes <OEMolProp_OECheckXLogXTypes>`, that returns ``true`` if all atoms excluding
  hydrogen in a molecule have valid XLogP types has been added.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue with filter output failure reporting, where failure due to the rules :ref:`ALLOWED_ELEMENTS <ALLOWED_ELEMENTS>` 
  and :ref:`ELIMINATE_METALS <ELIMINATE_METALS>` was not
  included in the output table, has been fixed.





MolProp TK 2.6.2
================================================================================

Minor internal improvements have been made.




MolProp TK 2.6.3
================================================================================

Minor internal improvements have been made.





MolProp TK 2.6.4
================================================================================

Minor internal improvements have been made.





MolProp TK 2.6.5
================================================================================

Minor internal improvements have been made.



MolProp TK 2.6.6
================================================================================

Minor internal improvements have been made.




MolProp TK 2.6.7
================================================================================

Minor internal improvements have been made.


.. omegatk toolkit documentation master file for gpu systems (c++, java, & python)

..  _chapter_omega_tk:

#############################
Omega Toolkit |omega_version|
#############################

..  oe:language:: python

    .. toctree::
       :maxdepth: 3

       omegatheory
       omegagpuomega
       omegaexamples
       selected_examples_python
       api
       releasenotes/index

..  oe:language:: c++ java csharp

    .. toctree::
       :maxdepth: 3

       omegatheory
       omegagpuomega
       omegaexamples
       api
       releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _omega_part_theory:

*********
Theory
*********

.. _chapter_omegatheory:


Torsion Driving (TD) in OMEGA
-----------------------------

The torsion driving (TD) algorithm of **OMEGA** is composed of two main
components; building the molecular scaffold (model) from non-rotor fragments and
sampling the torsional degrees of freedom.
Model generation may be bypassed by importing fragment structures from
external sources ([Hawkins-2010]_; [Hawkins-2012]_).

**OMEGA** builds initial structures for the molecule by assembling fragment
templates along sigma bonds.  Input molecules' graphs are fragmented at
exocyclic sigma, and carbon to heteroatom acyclic (but not exocyclic)
sigma bonds.  Conformations for the fragments are either retrieved
from pregenerated libraries built with :ref:`MakeFraglib <chapter_makefraglib>` or
constructed on-the-fly using the same approach
that :ref:`MakeFraglib <chapter_makefraglib>` uses.  Molecule
assembly is accomplished by simple vector alignment since all
interfragment joints are along sigma bonds.

Once an initial structure is constructed or given as
input, **OMEGA** generates additional ones enumerating ring
conformations and invertible nitrogen atoms.  Ring conformations are
taken from the same fragment library used to build the initial model.
**OMEGA** detaches all exocyclic substituents from a ring system, then aligns
and attaches them relative to the new ring conformation.  **OMEGA**
attempts to generate every possible combination of ring conformations
possible for a given structure.  

The next step in model generation is to detect and enumerate
invertible nitrogens.  Nitrogens that have pyramidal geometry, no specified
stereochemistry, no more than one hydrogen, are three
valent, and have no more than three ring bonds are considered by **OMEGA**
to be invertible.  Invertible in this context simply means that at
room temperature a pyramidal nitrogen is likely to be able to rapidly
(on an NMR timescale) interconvert between two puckered forms.  All
multiconformer ring models are further expanded by enumerating all
possible nitrogen puckers.  The resulting model set is the starting
point for conformer search by torsion driving.

**OMEGA** begins the torsion search process by examining the molecular
graph and determining the bonds that may freely rotate.  By default, **OMEGA**
selects acyclic sigma bonds that have at least one non-hydrogen atom
attached to each end of the bond.  By default, hydrogen rotors (e.g., hydroxyl
groups) are not altered during the torsion search; however, this can be enabled.
The final ensemble selection is based on
RMS distance of heavy atoms and sampled hydrogen atoms; unsampled hydrogen atoms
do not affect this RMS distance. A list of
possible dihedral angles are then assigned to each rotatable bond.
The current mechanism for assignment is based on SMARTS matching,
although alternate strategies for assigning angles based on
experimental (i.e., X-ray) or theoretical (i.e., fragment optimization
studies) are possible.  The molecular graph is then subjected to
pattern and geometric symmetry detection.  Common patterns such as
para-disubstituted benzene are used to reduce the number of symmetry
equivalent dihedral angles that need to be searched.  All torsions are
altered by 120 and 180 degrees, and an RMS calculation is performed,
taking into account symmetry-equivalent atoms in order to detect two-
and three-fold symmetries. Once a set of nonredundant dihedral angles is
assigned to each rotatable bond, **OMEGA** samples the torsion space through
a systematic enumeration of combinations of these angles. Depending on the
flexibility of the molecule, the maximum number of conformers to be
generated, and the mode in which **OMEGA** is run, the algorithm to sample
the torsion space is decided. By default, Thompson sampling, a Bayesian reinforcement
learning algorithm, is used.
The best conformers identified in the torsion search
are rank-ordered by energy. A
final ensemble is selected by sequentially testing the conformers
using the RMS distance cutoff. To be accepted into the final
ensemble, a conformer must have an RMS distance to every other member
of the ensemble that exceeds the user-defined cutoff value.  The final
ensemble is populated up to the user-defined maximum ensemble size
limit, or until the list of low energy conformers is exhausted.

.. figure:: /_images/steps_in_tordrive.png
   :align: center
   :alt: Three-step TD workflow: generate initial models, sample conformer space using rotatable bond torsions, then prune and keep low-energy diverse conformers.

   **Figure 1.** Illustration of steps in torsion driving **OMEGA**.

Thompson Sampling in OMEGA
--------------------------
The torsion library provides a set of likely dihedral angles for each rotatable bond.
In Thompson sampling for torsion driving, we use these angles from the torsion rules as
priors for a Bayesian process. Instead of enumerating every possible
combination of angles and searching the combinatorially expanding space of conformers,
conformers are instead generated based on these priors.
For every angle for a given rotatable bond, a distribution of beliefs is maintained
for modeling the likelihood of that angle to be part of a new low strain conformer. We sample these
distributions to pick an angle for a given rotor. This process is repeated for every
rotatable bond to pick a combination of angles that defines a conformer.
After a conformer is generated, its energy is evaluated and the beliefs are updated
based on the result. As we generate more conformers while continuously updating the beliefs,
the sampling process is steered toward the low-strain structures of interest.

.. figure:: /_images/TSinOMEGA_cartoon.png
   :align: center
   :alt: Conceptual loop diagram of iterative torsion sampling, conformer scoring, and probability updates that favor unique, low-strain structures.

   **Figure 2.** Illustration of Thompson sampling algorithm in torsion driving **OMEGA**.

.. note::

   Conformers generated from **OMEGA** with default options do not maintain
   input relative stereochemistry, that is, cis/trans configurations for cyclohexane or other
   cyclic molecules.



.. _section_macrocycle:


Macrocycle Conformations
------------------------

Torsion driving conformational sampling methods such as described in the
:ref:`chapter_omegatheory` section often perform poorly
for macrocyclic molecules due to the problem of ring closure after the torsion driving step. 
Conformational sampling of macrocycles therefore requires a different approach;
we address this issue with **OMEGA** using distance geometry (DG) [Hawkins-2020]_. Other methods have been applied to this
problem, such as distance geometry (DG) [Crippen-1988]_, molecular dynamics (MD/LLMOD) [Watts-2014]_,
MD with perturbation along low energy eigenvectors [Labute-2010]_, and inverse kinematics
[Coutsias-2016]_. It is important to note that **OMEGA** DG also works well for very flexible linear molecules which have
such a large conformational space that torsion driving may not be able to adequately sample it.

**OMEGA**'s method of conformational sampling of macrocycles is an adaptation of the distance geometry method 
of Spellmeyer et al. [Spellmeyer-1997]_. In this method, a traditional embedding DG algorithm is replaced
with a direct error function minimization of the random atomic coordinates, followed by force field 
refinement. Each initial Cartesian atomic coordinate *x* is assigned by choosing a random number *r* 
between *-1* and *1*, multiplied by a factor :math:`f\sqrt{N}` which determines the box of maximum extent 
for a molecule with *N* atoms:

.. math:: x = f\sqrt{N}r
   :label: eqtnext

Alternatively, instead of randomly placing atoms in Cartesian space, the method allows for random
placement of rigid fragments such as aromatic rings, nitro groups, and so on. After randomly
placing molecules, atoms, or rigid fragments, an error function of the form:

.. math:: F = \sum_{i,j} (d_{ij}-c_{i,j})^2 + \sum_k V_k
   :label: eqtnerror

is optimized. In the above equation, the first sum runs over all pairs of atoms in the molecule,
where :math:`d_{ij}` are the interatomic distances and :math:`c_{ij}` are elements of the constraint matrix;
they are obtained from the MMFF94 force field parameters. When atoms *(i,j)* are
bonded or are the first and last atoms in a bond angle, the upper and lower bounds
are the same and are taken as the corresponding equilibrium force field distances. When
atoms *(i,j)* are the first and last atoms of a torsion angle, the lower bound corresponds to the cis configuration and
the upper bound to the trans configuration of those atoms. Finally, when atoms *(i,j)* are separated
by more than three bonds, the lower bound is taken as the sum of the vdW radii and the upper
bound as the sum of bond lengths which separate the pair. The second summation in
equation :eq:`eqtnerror` is over the tetrahedral constraints which result from:


1. planarity

2. chirality

3. cis-trans isomerism

Optimization of the error function :eq:`eqtnerror` leads to a rough conformation. No hydrogen atoms
except those which are bonded to chiral atoms are included in the error function minimization.
Each rough conformation is checked for chirality correctness before refinement. 
If the rough conformation passes the chirality checks, it is refined against a forcefield, MMFF94
([Halgren-I-1996]_, [Halgren-II-1996]_, [Halgren-III-1996]_, [Halgren-IV-1996]_, [Halgren-V-1996]_).
Solvent forces can be included in the refinement step using a simple continuum
solvation model (the Sheffield model [Grant-2007]_). When the sequence of random
placement followed by error function minimization and force field refinement is repeated for a large enough
number of times for a given macrocycle, its conformational space is reasonably well covered.

Special measures are taken for zwitterionic molecules (containing both positively and negatively
charged groups, such as :math:`CO_2^-` and :math:`NH_3^+`). In order to prevent possible Coulombic collapse
in the absence of a stabilizing receptor, zwitterionic molecules are neutralized before performing 
the distance geometry calculation and the refined structures are recharged before writing them out. 
This approach meaningfully improves **OMEGA**’s ability to reproduce solid-state conformations of
zwitterionic ligands.

This method of conformation sampling is completely general and can be used to generate conformations
for any molecule, whether or not it contains a large ring. However the ``macrocycle`` mode in **OMEGA** has
been specifically developed and parameterized to perform well on macrocycles, therefore its performance
on linear and small ring molecules is worse than with ``classic`` **OMEGA**.




.. _chapter_omegagpuomega:

.. _omega_part_gpuomega:

********************************************************************************
GPU-Omega
********************************************************************************

**GPU-Omega** refers to the CUDA-enabled GPU implementation of **Omega TK**. **GPU-Omega** takes
advantage of a GPU during torsion driving for accelerated conformer generation. To
make use of **GPU-Omega** conformer generation, please follow the guidelines below.

.. attention::

   **GPU-Omega** is not available in the C# version of the toolkit.


GPU-Related Requirements
========================

The following features are required in order to use GPU-accelerated OpenEye toolkits and applications.


Supported Platforms
-------------------

CUDA-enabled OpenEye software is only available on supported Linux platforms.
For supported Linux platforms see the `Platform Support Page <https://www.eyesopen.com/supported-platforms>`_.


Supported GPUs
-------------------

An NVIDIA `Tesla <http://www.nvidia.com/object/tesla-supercomputing-solutions.html>`_,
`Quadro <http://www.nvidia.com/object/workstation-solutions.html>`_, or
`GeForce <http://www.nvidia.com/object/geforce_family.html>`_ GPU with a **compute capability of 3.5
or higher** is required on your system. For a comprehensive table of compute capability
categories for each GPU, please refer to the `CUDA <https://en.wikipedia.org/wiki/CUDA>`_ Wikipedia page.


NVIDIA Drivers
-------------------

* **Minimum NVIDIA Driver version: 450.x**.

* CUDA is **not** required to be installed.

We recommend driver `450.80.02 <https://www.nvidia.com/Download/driverResults.aspx/165294/en-us>`_, and
we strongly advise manually downloading and installing the appropriate NVIDIA driver
for your system as opposed to using a package manager.

To install, root privilege is required. Follow these steps:

  #. Download the driver to the machine you are installing it on.
  #. ``chmod +x`` the driver package to make it executable.
  #. Ensure you have disabled X-server by killing any running sessions.
     Reboot may be required if X-server is still running after this step.
     
     .. warning::

        Disabling X-server requires different processes to be killed depending on your Linux
        distribution.
        See the `NVIDIA installation guide
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_ for more details.

     .. warning::

        The NVIDIA kernel module can often conflict with the open source
        Nouveau display drivers, depending on your specific Linux
        distribution. The NVIDIA documentation is a much more complete
        and up-to-date source for information on how to work around this issue.
        See `Disabling Nouveau
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile-nouveau>`_ on the NVIDIA website.

  #. Install the driver by ``sudo ./NVIDIA-Linux-x86_64-450.80.02.run`` and follow the step-by-step installation instructions.

  For more details on driver installations, see the `CUDA Installation Guide
  <https://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_

.. note::

  The output of the ``nvidia-smi`` command is extremely useful when
  debugging GPU issues. Please include the output from
  ``nvidia-smi`` in any request to support@eyesopen.com.


Performance Tuning
-------------------

To get the most performance out of an NVIDIA graphics card, use the persistence daemon to switch persistence mode
across all cards on the system (root privilege required)::

  sudo nvidia-persistenced --user foo

This will automatically enable persistence mode after reboot.

For full instructions on the persistence daemon, see the `Persistence daemon section
<https://docs.nvidia.com/deploy/driver-persistence/index.html#persistence-daemon>`_ of the NVIDIA docs.

.. _section_gpuomega_usage:

Usage
=====

* **GPU-Omega** accelerates the torsion driving component of conformer generation in **Omega TK** and is
  available through the :ref:`OEOmega <OEConfGen_OEOmega>` and :ref:`OETorDriver <OEConfGen_OETorDriver>` classes.

* For all torsion driving sampling modes except ``dense`` modes,
  if a GPU is detected at runtime, torsion driving will be carried
  out on the GPU by default. To turn this feature off, use
  :oe:meth:`OEConfGen::OETorDriveOptions::SetUseGPU`.

* The following code shows how to turn off **GPU-Omega** prior to conformer generation using the
  ``sparse`` mode.

    .. oe:source:: GPUOmega.cpp
       :language: c++
       :noindent:
       :frag:     SNIPPET-GPUOmega-sparse
       :caption:  Example of turning off GPU-Omega

    .. oe:source:: GPUOmega.py
       :language: python
       :noindent:
       :frag:     SNIPPET-GPUOmega-sparse
       :caption:  Example of turning off GPU-Omega

    ..  oe:language:: python

        :ref:`Full listing. <listing-GPUOmega.py>`

    .. oe:source:: GPUOmega.java
       :language: java
       :noindent:
       :frag:     SNIPPET-GPUOmega-sparse
       :caption:  Example of turning off GPU-Omega

* **GPU-Omega** uses the default :oe:constns:`OEFF::OEMMFFSheffieldFFType::MMFF94Smod_NOESTAT`
  force field. If attempting to use an alternative force field, conformer generation will
  fall back to the CPU. **GPU-Omega** is also incompatible with ``hydrogen sampling``, which is
  turned off in the default sampling mode. As a result, **GPU-Omega** is not compatible
  with the default settings of :oe:const:`OEConfGen::OEOmegaSampling::Dense` sampling mode. To take
  advantage of a GPU with ``dense`` sampling mode, set :oe:meth:`OEConfGen::OETorDriveOptions::SetForceField`
  to :oe:constns:`OEFF::OEMMFFSheffieldFFType::MMFF94Smod_NOESTAT`, and set 
  :oe:meth:`OEConfGen::OEMolBuilderOptions::SetSampleHydrogens` to *false*.

* The :oe:func:`OEConfGen::OEOmegaIsGPUReady` utility function is provided for detecting available GPUs
  on a system.

* The following code demonstrates how to query the system for an available GPU and then set the
  force field to default in order to use the GPU for ``dense`` mode conformer generation.

      .. oe:source:: GPUOmega.cpp
         :language: c++
         :noindent:
         :frag:      SNIPPET-GPUOmega-dense
         :caption:   Example of detecting a GPU and changing the force field for dense mode conformer generation

      .. oe:source:: GPUOmega.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GPUOmega-dense
         :caption:  Example of detecting a GPU and changing the force field for dense mode conformer generation

      .. oe:source:: GPUOmega.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GPUOmega-dense
         :caption:  Example of detecting a GPU and changing the force field for dense mode conformer generation

* **GPU-Omega** does **not** support the distance geometry method of torsion driving, and therefore
  is incompatible with :oe:const:`OEConfGen::OEMacrocycleOmega`.

.. caution::

  To use **GPU-Omega** with child processes, a new :ref:`OEOmega <OEConfGen_OEOmega>` object must be created for each child.
  If attempting to use the same instance of an :ref:`OEOmega <OEConfGen_OEOmega>` object in child processes, conformer
  generation will fall back to the CPU.


..  _chapter_omega_examples:

**************
OMEGA Examples
**************

The following table lists the currently available **Omega TK** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`simple_omega<section_examples_simple_omega>`
        - Generating conformers

      * - :ref:`single_conformer<section_examples_single_conformer>`
        - Generating a single conformer

      * - :ref:`dens_omega<section_examples_dens_omega>`
        - Generating densely sampled conformers

      * - :ref:`stereo_and_torsion<section_examples_stereo_and_torsion>`
        - Generating stereoisomers

      * - :ref:`torsion_drive<section_examples_torsion_drive>`
        - Generating conformer ensembles using torsion driving

      * - :ref:`make_fraglib<section_examples_make_fraglib>`
        - Making fragment library

      * - :ref:`macrocycle<section_examples_macrocycle>`
        - Generating macrocycle conformers

      * - :ref:`single_conf_macrocycle<section_examples_single_conf_macrocycle>`
        - Generating single macrocycle conformer

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`simple_omega.py<section_examples_simple_omega>`
        - Generating conformers

      * - :ref:`single_conformer.py<section_examples_single_conformer>`
        - Generating a single conformer

      * - :ref:`dens_omega.py<section_examples_dens_omega>`
        - Generating densely sampled conformers

      * - :ref:`stereo_and_torsion.py<section_examples_stereo_and_torsion>`
        - Generating stereoisomers

      * - :ref:`torsion_drive.py<section_examples_torsion_drive>`
        - Generating conformer ensembles using torsion driving

      * - :ref:`make_fraglib.py<section_examples_make_fraglib>`
        - Making fragment library

      * - :ref:`macrocycle.py<section_examples_macrocycle>`
        - Generating macrocycle conformers

      * - :ref:`single_conf_macrocycle.py<section_examples_single_conf_macrocycle>`
        - Generating single macrocycle conformer

.. oe:language:: java

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`SimpleOmega<section_examples_simple_omega>`
        - Generating conformers

      * - :ref:`SingleConformer<section_examples_single_conformer>`
        - Generating a single conformer

      * - :ref:`DensOmega<section_examples_dens_omega>`
        - Generating densely sampled conformers

      * - :ref:`StereoAndTorsion<section_examples_stereo_and_torsion>`
        - Generating stereoisomers

      * - :ref:`TorsionDrive <section_examples_torsion_drive>`
        - Generating conformer ensembles using torsion driving

      * - :ref:`MakeFraglib <section_examples_make_fraglib>`
        - Making fragment library

      * - :ref:`Macrocycle <section_examples_macrocycle>`
        - Generating macrocycle conformers

      * - :ref:`SingleConformerMacrocycle <section_examples_single_conf_macrocycle>`
        - Generating single macrocycle conformer

.. oe:language:: csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`SimpleOmega<section_examples_simple_omega>`
        - Generating conformers

      * - :ref:`SingleConformer<section_examples_single_conformer>`
        - Generating a single conformer

      * - :ref:`DensOmega<section_examples_dens_omega>`
        - Generating densely sampled conformers

      * - :ref:`StereoAndTorsion<section_examples_stereo_and_torsion>`
        - Generating stereoisomers

      * - :ref:`TorsionDrive<section_examples_torsion_drive>`
        - Generating conformer ensembles using torsion driving

      * - :ref:`MakeFraglib <section_examples_make_fraglib>`
        - Making fragment library

      * - :ref:`Macrocycle<section_examples_macrocycle>`
        - Generating macrocycle conformers

      * - :ref:`SingleConformerMacrocycle<section_examples_single_conf_macrocycle>`
        - Generating single macrocycle conformer

.. note::

      If the input molecule has SD tag data, the data will be copied to every conformer in the results molecule.

Classic OEOmega Examples
========================

.. _section_examples_simple_omega:

Generating Conformers
---------------------

The following code example is a simple illustration of how to generate conformers
using the :ref:`OEOmega <OEConfGen_OEOmega>` object.

.. seealso::

   * :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` class
   * :ref:`OEOmega <OEConfGen_OEOmega>` class
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: simple_omega.cpp
   :language: c++
   :caption:  Generating Conformers
   :refnum:   1

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_omega.cpp <../../../../sublibs/tklibs/omega2/examples/simple_omega.cpp>`

.. oe:source:: simple_omega.py
   :language: python
   :caption:  Generating Conformers
   :refnum:   1

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_omega.py <../../../../wrappers/python/examples/omega/simple_omega.py>`

.. oe:source:: SimpleOmega.java
   :language: java
   :caption:  Generating Conformers
   :refnum:   1

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleOmega.java <../../../../wrappers/java/examples/openeye/examples/oeomega/SimpleOmega.java>`

.. oe:source:: SimpleOmega.cs
   :language: csharp
   :caption:  Generating Conformers
   :refnum:   1

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleOmega.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/SimpleOmega.cs>`

.. _section_examples_single_conformer:

Generating a Single Conformer
-----------------------------

The following code example is a simple illustration of how to generate a
single conformer.

.. seealso::

   * :ref:`OEConformerBuilder <OEConfGen_OEConformerBuilder>` class

.. oe:source:: single_conformer.cpp
   :language: c++
   :caption:  Generating a Single Conformer
   :refnum:   2

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`single_conformer.cpp <../../../../sublibs/tklibs/omega2/examples/single_conformer.cpp>`

.. oe:source:: single_conformer.py
   :language: python
   :caption:  Generating a Single Conformer
   :refnum:   2

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`single_conformer.py <../../../../wrappers/python/examples/omega/single_conformer.py>`

.. oe:source:: SingleConformer.java
   :language: java
   :caption:  Generating a Single Conformer
   :refnum:   2

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SingleConformer.java <../../../../wrappers/java/examples/openeye/examples/oeomega/SingleConformer.java>`

.. oe:source:: SingleConformer.cs
   :language: csharp
   :caption:  Generating a Single Conformer
   :refnum:   2

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SingleConformer.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/SingleConformer.cs>`

.. _section_examples_dens_omega:

Generating Densely Sampled Conformers
-------------------------------------

The following code example is a simple illustration of how to generate densely sampled
conformers, as used in :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` calculations, using the
:ref:`OEOmega <OEConfGen_OEOmega>` object.

.. seealso::

   * :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` class
   * :ref:`OEOmega <OEConfGen_OEOmega>` class
   * :oe:constns:`OEConfGen::OEOmegaSampling` namespace
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: dense_omega.cpp
   :language: c++
   :caption:  Generating Densely Sampled Conformers
   :refnum:   3

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`dense_omega.cpp <../../../../sublibs/tklibs/omega2/examples/dense_omega.cpp>`

.. oe:source:: dense_omega.py
   :language: python
   :caption:  Generating Densely Sampled Conformers
   :refnum:   3

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`dense_omega.py <../../../../wrappers/python/examples/omega/dense_omega.py>`

.. oe:source:: DenseOmega.java
   :language: java
   :caption:  Generating Densely Sampled Conformers
   :refnum:   3

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`DenseOmega.java <../../../../wrappers/java/examples/openeye/examples/oeomega/DenseOmega.java>`

.. oe:source:: DenseOmega.cs
   :language: csharp
   :caption:  Generating Densely Sampled Conformers
   :refnum:   3

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`DenseOmega.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/DenseOmega.cs>`

Flipper Examples
================================================================================

.. _section_examples_stereo_and_torsion:

Generating Stereoisomers
------------------------

The following code example is a simple illustration of how to use the
:ref:`OEFlipper <OEConfGen_OEFlipper>` function to generate stereoisomers. The
code example also demonstrates that stereoisomers should be generated
before generating conformers.

.. seealso::

   * :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` class
   * :ref:`OEOmega <OEConfGen_OEOmega>` class
   * :ref:`OEFlipper <OEConfGen_OEFlipper>` function
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: stereo_and_torsion.cpp
   :language: c++
   :caption:  Generating Stereoisomers
   :refnum:   4

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`stereo_and_torsion.cpp <../../../../sublibs/tklibs/omega2/examples/stereo_and_torsion.cpp>`

.. oe:source:: stereo_and_torsion.py
   :language: python
   :caption:  Generating Stereoisomers
   :refnum:   4

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`stereo_and_torsion.py <../../../../wrappers/python/examples/omega/stereo_and_torsion.py>`

.. oe:source:: StereoAndTorsion.java
   :language: java
   :caption:  Generating Stereoisomers
   :refnum:   4

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`StereoAndTorsion.java <../../../../wrappers/java/examples/openeye/examples/oeomega/StereoAndTorsion.java>`

.. oe:source:: StereoAndTorsion.cs
   :language: csharp
   :caption:  Generating Stereoisomers
   :refnum:   4

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`StereoAndTorsion.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/StereoAndTorsion.cs>`

.. _section_examples_torsion:

Generating Torsion Driven Conformation Examples
===============================================

.. _section_examples_torsion_drive:

Generating Conformer Ensembles Using Torsion Driving
-----------------------------------------------------

The following code example is a simple illustration of how torsion
driving from a given 3D structure can be used to generate a conformer ensemble.

.. seealso::

   * :ref:`OETorDriveOptions <OEConfGen_OETorDriveOptions>` class
   * :ref:`OETorDriver <OEConfGen_OETorDriver>` class
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: torsion_drive.cpp
   :language: c++
   :caption:  Generating Conformer Ensembles Using Torsion Driving
   :refnum:   5

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`torsion_drive.cpp <../../../../sublibs/tklibs/omega2/examples/torsion_drive.cpp>`

.. oe:source:: torsion_drive.py
   :language: python
   :caption:  Generating Conformer Ensembles Using Torsion Driving
   :refnum:   5

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`torsion_drive.py <../../../../wrappers/python/examples/omega/torsion_drive.py>`

.. oe:source:: TorsionDrive.java
   :language: java
   :caption:  Generating Conformer Ensembles Using Torsion Driving
   :refnum:   5

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`TorsionDrive.java <../../../../wrappers/java/examples/openeye/examples/oeomega/TorsionDrive.java>`

.. oe:source:: TorsionDrive.cs
   :language: csharp
   :caption:  Generating Conformer Ensembles Using Torsion Driving
   :refnum:   5

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`TorsionDrive.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/TorsionDrive.cs>`

.. _section_examples_fraglib:

Fragment Library Generation Examples
====================================

.. _section_examples_make_fraglib:

Making a Fragment Library
--------------------------

The following code example is a simple illustration of how to generate
a fragment library.

.. seealso::

   * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class
   * :ref:`OEMakeFragLib <OEConfGen_OEMakeFragLib>` class
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: make_fraglib.cpp
   :language: c++
   :caption:  Making a Fragment Library
   :refnum:   6

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`make_fraglib.cpp <../../../../sublibs/tklibs/omega2/examples/make_fraglib.cpp>`

.. oe:source:: make_fraglib.py
   :language: python
   :caption:  Making a Fragment Library
   :refnum:   6

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`make_fraglib.py <../../../../wrappers/python/examples/omega/make_fraglib.py>`

.. oe:source:: MakeFraglib.java
   :language: java
   :caption:  Making a Fragment Library
   :refnum:   6

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeFraglib.java <../../../../wrappers/java/examples/openeye/examples/oeomega/MakeFraglib.java>`

.. oe:source:: MakeFraglib.cs
   :language: csharp
   :caption:  Making a Fragment Library
   :refnum:   6

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeFraglib.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/MakeFraglib.cs>`

.. _section_examples_macrocycles:

Macrocycle Examples
===================

.. _section_examples_macrocycle:

Generating Macrocycle Conformers
--------------------------------

The following code example is a simple illustration of how to generate conformers
using the OEMacrocycleOmega object.

.. seealso::

   * :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>` class
   * :ref:`OEMacrocycleOmega <OEConfGen_OEMacrocycleOmega>` class
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: macrocycle.cpp
   :language: c++
   :caption:  Generating Macrocycle Conformers
   :refnum:   7

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`macrocycle.cpp <../../../../sublibs/tklibs/omega2/examples/macrocycle.cpp>`

.. oe:source:: macrocycle.py
   :language: python
   :caption:  Generating Macrocycle Conformers
   :refnum:   7

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`macrocycle.py <../../../../wrappers/python/examples/omega/macrocycle.py>`

.. oe:source:: Macrocycle.java
   :language: java
   :caption:  Generating Macrocycle Conformers
   :refnum:   7

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Macrocycle.java <../../../../wrappers/java/examples/openeye/examples/oeomega/Macrocycle.java>`

.. oe:source:: Macrocycle.cs
   :language: csharp
   :caption:  Generating Macrocycle Conformers
   :refnum:   7

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Macrocycle.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/Macrocycle.cs>`

.. _section_examples_single_conf_macrocycle:

Generating a Single Macrocycle Conformer
----------------------------------------

The following code example is a simple illustration of how to generate a
single macrocycle conformer using the OEMacrocycleBuilder object.

.. seealso::

   * :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>` class
   * :ref:`OEMacrocycleBuilder <OEConfGen_OEMacrocycleBuilder>` class
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: single_conf_macrocycle.cpp
   :language: c++
   :caption:  Generating a Single Macrocycle Conformer
   :refnum:   8

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`single_conf_macrocycle.cpp <../../../../sublibs/tklibs/omega2/examples/single_conf_macrocycle.cpp>`

.. oe:source:: single_conf_macrocycle.py
   :language: python
   :caption:  Generating a Single Macrocycle Conformer
   :refnum:   8

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`single_conf_macrocycle.py <../../../../wrappers/python/examples/omega/single_conf_macrocycle.py>`

.. oe:source:: SingleConformerMacrocycle.java
   :language: java
   :caption:  Generating a Single Macrocycle Conformer
   :refnum:   8

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SingleConformerMacrocycle.java <../../../../wrappers/java/examples/openeye/examples/oeomega/SingleConformerMacrocycle.java>`

.. oe:source:: SingleConformerMacrocycle.cs
   :language: csharp
   :caption:  Generating a Single Macrocycle Conformer
   :refnum:   8

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SingleConformerMacrocycle.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/SingleConformerMacrocycle.cs>`




.. _omega_part_api:

********************
API
********************

.. toctree::
   :maxdepth: 2

   OEConfGenClasses/OEConfGenClasses
   OEConfGenConstants/OEConfGenConstants
   OEConfGenFunctions/index


.. _OEConfGenClasses:

OEConfGen Classes
=================

.. oe:namespace:: OEConfGen

.. toctree::

   OEBuilderBase
   OEConfFixOptions
   OEConformerBuilder
   OEConfSlicer
   OEFlipperClassicOptions
   OEFlipperOptions
   OEFragBuilder
   OEFragBuilderOptions
   OEFragOptions
   OEMacrocycleBuilder
   OEMacrocycleBuilderOptions
   OEMacrocycleOmega
   OEMacrocycleOmegaOptions
   OEMakeFragLib
   OEMolBuilder
   OEMolBuilderOptions
   OEOmega
   OEOmegaOptions
   OERingFragOptions
   OESliceEnsembleOptions
   OETorDriveOptions
   OETorDriver
   OETorLib
   OETorLibParameter


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEBuilderBase, BuilderBase

.. _OEConfGen_OEBuilderBase:

.. oe:class:: OEBuilderBase

   .. oe:api::

      class OEBuilderBase

   This is an abstract base class for structure builder classes that use a
   fragment library. 

   The :ref:`OEBuilderBase <OEConfGen_OEBuilderBase>` class defines the following public methods:
    * :oe:meth:`AddFragLib<OEConfGen::OEBuilderBase::AddFragLib>`
    * :oe:meth:`ClearFragLibs<OEConfGen::OEBuilderBase::ClearFragLibs>`

   The following classes derive from this class:
    * :ref:`OEMakeFragLib <OEConfGen_OEMakeFragLib>`
    * :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBuilderBase & operator=(const OEBuilderBase & rhs)

      Assignment operator.

   .. oe:method:: AddFragLib

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddFragLib()
            bool AddFragLib(const std::string &)
            bool AddFragLib(OEPlatform::oeistream &)

      .. oe:language:: python

         .. oe:api:: python

            AddFragLib() -> bool
            AddFragLib(arg2: str) -> bool
            AddFragLib(arg2: oeistream) -> bool

      Adds a **fragment library** to be used for pregenerated
      fragment coordinates.
      When the :oe:meth:`OEConfGen::OEBuilderBase::AddFragLib` is called
      without a parameter, the *built-in* fragment library is loaded immediately.
      By default, the *built-in* fragment library does not load until it is
      required in use for the first time.

      The ``string`` and :ref:`oeistream <OEPlatform_oeistream>` versions of
      :oe:meth:`OEConfGen::OEBuilderBase::AddFragLib` can be
      used to add external fragments libraries.
      These external libraries are used in addition to the built-in one.
      Returns *true* if the fragment library is added successfully.

      .. seealso::

         * :oe:meth:`OEConfGen::OEBuilderBase::ClearFragLibs` method

   .. _OEConfGen_ClearFragLibs:

   .. oe:method:: ClearFragLibs

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearFragLibs()

      .. oe:language:: python

         .. oe:api:: python

            ClearFragLibs() -> None

      Clears all fragment libraries from the builder.

      .. seealso::

         * :oe:meth:`OEConfGen::OEBuilderBase::AddFragLib` method


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEConfFixOptions, ConfFixOptions

.. _OEConfGen_OEConfFixOptions:

.. oe:class:: OEConfFixOptions

   .. oe:api::

      class OEConfFixOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for constraining
   a fragment of the molecule during conformational search.

   There are multiple ways to define the substructure for defining the constraints.

     * The first is to provide a substructure query using the command
       :oe:meth:`SetFixSubSearch<OEConfGen::OEConfFixOptions::SetFixSubSearch>`.
       If the input query pattern is in 3D, the corresponding substructure of the target
       is fixed to the query coordinates.  For a non-3D query, the mapped substructure 
       of an input 3D target is fixed, provided that 
       :oe:meth:`SetIncludeInput<OEConfGen::OEOmegaOptions::SetIncludeInput>`
       is set to *true*.

     * The second method is to pass in a 3D structure using the command 
       :oe:meth:`SetFixMol<OEConfGen::OEConfFixOptions::SetFixMol>`. The 
       :oe:meth:`SetFixDeleteH<OEConfGen::OEConfFixOptions::SetFixDeleteH>` 
       command can be used to control whether hydrogens should be retained or 
       discarded from the `FixMol`. The corresponding substructure of the target has the 
       atom coordinates fixed to those from the `FixMol`.

     * The third method is to provide a SMARTS pattern using the command 
       :oe:meth:`SetFixSmarts<OEConfGen::OEConfFixOptions::SetFixSmarts>`.
       The SMARTS pattern is matched against the input molecule to identify a substructure, 
       provided that the input molecule is in 3D and that
       :oe:meth:`SetIncludeInput<OEConfGen::OEOmegaOptions::SetIncludeInput>` 
       is set to *true*. The corresponding substructure of the target is fixed
       during the conformer generation.

     * The fourth method is to provide both a `FixMol` using the command
       :oe:meth:`SetFixMol<OEConfGen::OEConfFixOptions::SetFixMol>`, and a SMARTS string 
       using the command :oe:meth:`SetFixSmarts<OEConfGen::OEConfFixOptions::SetFixSmarts>`. 
       In this case, the SMARTS pattern is matched against the `FixMol` structure 
       to identify a substructure of the `FixMol`. The corresponding substructure of 
       the target is fixed to the coordinates of the `FixMol` substructure 
       during conformer generation.

     * The fifth method is to provide both a `FixMol` using the command
       :oe:meth:`SetFixMol<OEConfGen::OEConfFixOptions::SetFixMol>` and to turn on
       MCS-based fix using the command :oe:meth:`SetFixMCS<OEConfGen::OEConfFixOptions::SetFixMCS>`.
       In this case, the maximum common substructure is matched against the `FixMol` structure
       to identify a substructure of the `FixMol`. The corresponding substructure of 
       the target is fixed to the coordinates of the `FixMol` substructure 
       during conformer generation.

     * The final method is to provide an atom predicate using the command 
       :oe:meth:`SetFixPredicate<OEConfGen::OEConfFixOptions::SetFixPredicate>`, which
       is used to identify target atoms to be fixed.

   For all of the above methods, the initialization of the substructure,
   when applicable, can be controlled using 
   :oe:meth:`SetAtomExpr<OEConfGen::OEConfFixOptions::SetAtomExpr>` and
   :oe:meth:`SetBondExpr<OEConfGen::OEConfFixOptions::SetBondExpr>`.

   The `unique match` flag defined using 
   :oe:meth:`SetFixUniqueMatch<OEConfGen::OEConfFixOptions::SetFixUniqueMatch>` 
   applies to all substructure matches performed, either during creation of
   molecule fragments or when applying the actual constraints.

   The `MaxMatch` defines how many of the matches found during constraint application
   should be applied and can be set using the command
   :oe:meth:`SetFixMaxMatch<OEConfGen::OEConfFixOptions::SetFixMaxMatch>`. If the
   constraining fragment substructure appears twice in the target molecule and
   the `MaxMatch` is set to two or more, the molecule would be constrained to the
   substructure coordinates twice for each of the generated conformers and could
   result in twice the number of conformers compared to setting this value to 1.

   In all cases, the constraints are evaluated by the proximity between the initial
   generated structure of the molecule and the coordinates of the constraining
   substructure. The precision of the proximity evaluation can be controlled by an 
   `RMS` value set using :oe:meth:`SetFixRMS<OEConfGen::OEConfFixOptions::SetFixRMS>`.

   .. seealso::

      * :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` class
      * :ref:`OETorDriver <OEConfGen_OETorDriver>` class

   The :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>` class defines the following public methods:
    * :oe:meth:`GetAtomExpr<OEConfGen::OEConfFixOptions::GetAtomExpr>` and
      :oe:meth:`SetAtomExpr<OEConfGen::OEConfFixOptions::SetAtomExpr>`
    * :oe:meth:`GetBondExpr<OEConfGen::OEConfFixOptions::GetBondExpr>` and
      :oe:meth:`SetBondExpr<OEConfGen::OEConfFixOptions::SetBondExpr>`
    * :oe:meth:`GetFixDeleteH<OEConfGen::OEConfFixOptions::GetFixDeleteH>` and
      :oe:meth:`SetFixDeleteH<OEConfGen::OEConfFixOptions::SetFixDeleteH>`
    * :oe:meth:`GetFixMaxMatch<OEConfGen::OEConfFixOptions::GetFixMaxMatch>` and
      :oe:meth:`SetFixMaxMatch<OEConfGen::OEConfFixOptions::SetFixMaxMatch>`
    * :oe:meth:`GetFixMCS<OEConfGen::OEConfFixOptions::GetFixMCS>` and
      :oe:meth:`SetFixMCS<OEConfGen::OEConfFixOptions::SetFixMCS>`
    * :oe:meth:`GetFixMol<OEConfGen::OEConfFixOptions::GetFixMol>` and
      :oe:meth:`SetFixMol<OEConfGen::OEConfFixOptions::SetFixMol>`
    * :oe:meth:`GetFixPredicate<OEConfGen::OEConfFixOptions::GetFixPredicate>` and
      :oe:meth:`SetFixPredicate<OEConfGen::OEConfFixOptions::SetFixPredicate>`
    * :oe:meth:`GetFixRMS<OEConfGen::OEConfFixOptions::GetFixRMS>` and
      :oe:meth:`SetFixRMS<OEConfGen::OEConfFixOptions::SetFixRMS>`
    * :oe:meth:`GetFixSmarts<OEConfGen::OEConfFixOptions::GetFixSmarts>` and
      :oe:meth:`SetFixSmarts<OEConfGen::OEConfFixOptions::SetFixSmarts>`
    * :oe:meth:`GetFixSubSearch<OEConfGen::OEConfFixOptions::GetFixSubSearch>` and
      :oe:meth:`SetFixSubSearch<OEConfGen::OEConfFixOptions::SetFixSubSearch>`
    * :oe:meth:`GetFixUniqueMatch<OEConfGen::OEConfFixOptions::GetFixUniqueMatch>` and
      :oe:meth:`SetFixUniqueMatch<OEConfGen::OEConfFixOptions::SetFixUniqueMatch>`
    * :oe:meth:`HasFixPattern<OEConfGen::OEConfFixOptions::HasFixPattern>`
    * :oe:meth:`GetMCSMinAtoms<OEConfGen::OEConfFixOptions::GetMCSMinAtoms>` and
      :oe:meth:`SetMCSMinAtoms<OEConfGen::OEConfFixOptions::SetMCSMinAtoms>`
    * :oe:meth:`GetMCSFunc<OEConfGen::OEConfFixOptions::GetMCSFunc>` and
      :oe:meth:`SetMCSFunc<OEConfGen::OEConfFixOptions::SetMCSFunc>`
    * :oe:meth:`GetMCSType<OEConfGen::OEConfFixOptions::GetMCSType>` and
      :oe:meth:`SetMCSType<OEConfGen::OEConfFixOptions::SetMCSType>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfFixOptions()
            OEConfFixOptions(const OEConfFixOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEConfFixOptions() -> OEConfFixOptions
            OEConfFixOptions(arg2: OEConfFixOptions) -> OEConfFixOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEConfFixOptions &operator=(const OEConfFixOptions &)

      Assignment operator.

   .. _OEConfGen_OEConfFixOptions_GetAtomExpr:

   .. oe:method:: GetAtomExpr

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomExpr() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomExpr() -> int

      See the :oe:meth:`SetAtomExpr<OEConfGen::OEConfFixOptions::SetAtomExpr>` method.

   .. _OEConfGen_OEConfFixOptions_GetBondExpr:

   .. oe:method:: GetBondExpr

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetBondExpr() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondExpr() -> int

      See the :oe:meth:`SetBondExpr<OEConfGen::OEConfFixOptions::SetBondExpr>` method.

   .. _OEConfGen_OEConfFixOptions_GetFixDeleteH:

   .. oe:method:: GetFixDeleteH

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFixDeleteH() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixDeleteH() -> bool

      See the :oe:meth:`SetFixDeleteH<OEConfGen::OEConfFixOptions::SetFixDeleteH>` method.

   .. _OEConfGen_OEConfFixOptions_GetFixMaxMatch:

   .. oe:method:: GetFixMaxMatch

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFixMaxMatch() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixMaxMatch() -> int

      See the :oe:meth:`SetFixMaxMatch<OEConfGen::OEConfFixOptions::SetFixMaxMatch>` method.

   .. _OEConfGen_OEConfFixOptions_GetFixMCS:

   .. oe:method:: GetFixMCS

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFixMCS() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixMCS() -> bool

      See the :oe:meth:`SetFixMCS<OEConfGen::OEConfFixOptions::SetFixMCS>` method.

   .. _OEConfGen_OEConfFixOptions_GetFixMol:

   .. oe:method:: GetFixMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase& GetFixMol() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixMol() -> OEGraphMol

      See the :oe:meth:`SetFixMol<OEConfGen::OEConfFixOptions::SetFixMol>` method.

   .. _OEConfGen_OEConfFixOptions_GetFixPredicate:

   .. oe:method:: GetFixPredicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* GetFixPredicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixPredicate() -> OEUnaryAtomPred

      See the :oe:meth:`SetFixPredicate<OEConfGen::OEConfFixOptions::SetFixPredicate>` method.

   .. _OEConfGen_OEConfFixOptions_GetFixRMS:

   .. oe:method:: GetFixRMS

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetFixRMS() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixRMS() -> float

      See the :oe:meth:`SetFixRMS<OEConfGen::OEConfFixOptions::SetFixRMS>` method.

   .. _OEConfGen_OEConfFixOptions_GetFixSmarts:

   .. oe:method:: GetFixSmarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetFixSmarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixSmarts() -> str

      See the :oe:meth:`SetFixSmarts<OEConfGen::OEConfFixOptions::SetFixSmarts>` method.

   .. _OEConfGen_OEConfFixOptions_GetFixSubSearch:

   .. oe:method:: GetFixSubSearch

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEChem::OESubSearch GetFixSubSearch() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixSubSearch() -> OESubSearch

      Returns the substructure search (:ref:`OESubSearch <OEChem_OESubSearch>`)
      for fixed fragments.

   .. _OEConfGen_OEConfFixOptions_GetFixUniqueMatch:

   .. oe:method:: GetFixUniqueMatch

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFixUniqueMatch() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixUniqueMatch() -> bool

      See the :oe:meth:`SetFixUniqueMatch<OEConfGen::OEConfFixOptions::SetFixUniqueMatch>` method.

   .. _OEConfGen_OEConfFixOptions_GetMCSMinAtoms:

   .. oe:method:: GetMCSMinAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMCSMinAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMCSMinAtoms() -> int

      See the :oe:meth:`SetMCSMinAtoms<OEConfGen::OEConfFixOptions::SetMCSMinAtoms>` method.

   .. _OEConfGen_OEConfFixOptions_GetMCSFunc:

   .. oe:method:: GetMCSFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMCSFunc* GetMCSFunc() const

      .. oe:language:: python

         .. oe:api:: python

            GetMCSFunc() -> OEMCSFunc

      See the :oe:meth:`SetMCSFunc<OEConfGen::OEConfFixOptions::SetMCSFunc>` method.

   .. _OEConfGen_OEConfFixOptions_GetMCSType:

   .. oe:method:: GetMCSType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMCSType() const

      .. oe:language:: python

         .. oe:api:: python

            GetMCSType() -> int

      See the :oe:meth:`SetMCSType<OEConfGen::OEConfFixOptions::SetMCSType>` method.

   .. _OEConfGen_OEConfFixOptions_HasFixPattern:

   .. oe:method:: HasFixPattern

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasFixPattern() const

      .. oe:language:: python

         .. oe:api:: python

            HasFixPattern() -> bool

      Method checks if a criterion for fixing a portion of the molecule
      during conformation search is currently set.

   .. _OEConfGen_OEConfFixOptions_SetAtomExpr:

   .. oe:method:: SetAtomExpr

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAtomExpr(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomExpr(value: int) -> bool

      Sets the **atom expression** to be used for substructure initialization
      from a molecule fragment.
      Default: :oe:const:`OEChem::OEExprOpts::DefaultAtoms`

      .. seealso::

         * :oe:constns:`OEChem::OEExprOpts` namespace

   .. _OEConfGen_OEConfFixOptions_SetBondExpr:

   .. oe:method:: SetBondExpr

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBondExpr(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetBondExpr(value: int) -> bool

      Sets the **bond expression** to be used for substructure initialization
      from a molecule fragment.
      Default: :oe:const:`OEChem::OEExprOpts::DefaultBonds`

      .. seealso::

         * :oe:constns:`OEChem::OEExprOpts` namespace

   .. _OEConfGen_OEConfFixOptions_SetFixDeleteH:

   .. oe:method:: SetFixDeleteH

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixDeleteH(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetFixDeleteH(value: bool) -> bool

      Sets whether **hydrogens should be stripped** from the fix
      molecule before it is used to match structures.
      Default: True

   .. _OEConfGen_OEConfFixOptions_SetFixMaxMatch:

   .. oe:method:: SetFixMaxMatch

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixMaxMatch(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetFixMaxMatch(value: int) -> bool

      Sets the **maximum number of substructure search matches** to be used
      for constraining molecule fragments.
      Default: 1

   .. _OEConfGen_OEConfFixOptions_SetFixMol:

   .. oe:method:: SetFixMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixMol(const OEChem::OEMolBase&)
            bool SetFixMol(OEChem::oemolistream& fstream)

      .. oe:language:: python

         .. oe:api:: python

            SetFixMol(value: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            SetFixMol(fstream: oemolistream) -> bool

      Uses the 3D coordinates of the provided molecule to 
      fix the corresponding substructure in the target molecule during conformer
      generation. For the second overload, only the first molecule from the input 
      :ref:`oemolistream <OEChem_oemolistream>` is used.

   .. _OEConfGen_OEConfFixOptions_SetFixMCS:

   .. oe:method:: SetFixMCS

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixMCS(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetFixMCS(value: bool) -> bool

      Sets flag to use **MCS** to fix a portion of the molecule during conformation search.
      If set to *true*, the maximum common substructure against the `FixMol` is used to
      define the portion of the molecule to be kept fixed. Default: False

   .. _OEConfGen_OEConfFixOptions_SetFixPredicate:

   .. oe:method:: SetFixPredicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixPredicate(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>&)

      .. oe:language:: python

         .. oe:api:: python

            SetFixPredicate(value: OEUnaryAtomPred) -> bool

      Uses the **atom predicate** to define which atoms should be kept fixed
      during conformation search.

   .. _OEConfGen_OEConfFixOptions_SetFixRMS:

   .. oe:method:: SetFixRMS

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixRMS(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetFixRMS(value: float) -> bool

      Sets the **RMS distance** (Root Mean Square (RMS) Cartesian)
      below which two atom positions are treated as identical.
      Default: 0.15

   .. _OEConfGen_OEConfFixOptions_SetFixSmarts:

   .. oe:method:: SetFixSmarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFixSmarts(const std::string&)

      .. oe:language:: python

         .. oe:api:: python

            SetFixSmarts(value: str) -> bool

      Uses the SMARTS pattern to define which portion of the molecule
      should be kept fixed during conformational search.

   .. _OEConfGen_OEConfFixOptions_SetFixSubSearch:

   .. oe:method:: SetFixSubSearch

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixSubSearch(const OEChem::OESubSearch value)

      .. oe:language:: python

         .. oe:api:: python

            SetFixSubSearch(value: OESubSearch) -> bool

      Uses the substructure search (:ref:`OESubSearch <OEChem_OESubSearch>`) to define which
      portion of the molecule should be kept fixed during conformation search.

   .. _OEConfGen_OEConfFixOptions_SetFixUniqueMatch:

   .. oe:method:: SetFixUniqueMatch

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixUniqueMatch(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetFixUniqueMatch(value: bool) -> bool

      Sets whether only the **unique** substructure matches should be used
      for coordinate replacement.
      Default: True

   .. _OEConfGen_OEConfFixOptions_SetMCSMinAtoms:

   .. oe:method:: SetMCSMinAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMCSMinAtoms(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMCSMinAtoms(value: int) -> bool

      Sets the **minimum number of atoms** required of a subgraph match to 
      be used for MCS-based fixes.
      Default: 1

   .. _OEConfGen_OEConfFixOptions_SetMCSFunc:

   .. oe:method:: SetMCSFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMCSFunc(const OEChem::OEMCSFunc&)

      .. oe:language:: python

         .. oe:api:: python

            SetMCSFunc(value: OEMCSFunc) -> bool

      Sets the **scoring function** to be used for subgraph matching for MCS-based fixes.
      Default: :oe:const:`OEChem::OEMCSMaxBondsCompleteCycles`

   .. _OEConfGen_OEConfFixOptions_SetMCSType:

   .. oe:method:: SetMCSType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMCSType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMCSType(value: int) -> bool

      Sets the **MCS search type** to be used for subgraph matching for MCS-based fixes,
      defined in the :oe:const:`OEChem::OEMCSType` namespace.
      Default: :oe:const:`OEChem::OEMCSType::Exhaustive`



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEConformerBuilder, ConformerBuilder

.. _OEConfGen_OEConformerBuilder:

.. oe:class:: OEConformerBuilder

   .. oe:api::

      class OEConformerBuilder

   This class defines an interface for generating 3D structures of small
   molecules. This class differs from :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` in that
   it makes an effort to ensure that the generated conformer is clash free.
   However, this is faster than :ref:`OEOmega <OEConfGen_OEOmega>` for generating a
   single conformer, as this method does not search for the lowest energy conformer.

   .. admonition:: Code Examples

      * :ref:`section_examples_single_conformer` example

   The :ref:`OEConformerBuilder <OEConfGen_OEConformerBuilder>` class defines the following public methods:
    * :oe:meth:`Build<OEConfGen::OEConformerBuilder::Build>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConformerBuilder()
            OEConformerBuilder(const OEConformerBuilder&)

      .. oe:language:: python

         .. oe:api:: python

            OEConformerBuilder() -> OEConformerBuilder
            OEConformerBuilder(arg2: OEConformerBuilder) -> OEConformerBuilder

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEConformerBuilder &operator=(const OEConformerBuilder&)

      Assignment operator.

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Build(OEChem::OEMolBase&) const
            unsigned Build(OEChem::OEMCMolBase&) const

      .. oe:language:: python

         .. oe:api:: python

            Build(mol: Union[OEGraphMol,OEQMol]) -> int
            Build(mol: OEMol) -> int

      Generates a 3D structure of a small molecule. Returns 
      :oe:const:`OEConfGen::OEOmegaReturnCode::Success` if 
      the process succeeds, otherwise returns an error code from the
      :oe:constns:`OEConfGen::OEOmegaReturnCode` namespace.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEConfSlicer, OEConfSlicer

.. _OEConfGen_OEConfSlicer:

.. oe:class:: OEConfSlicer

   .. oe:api::

      class OEConfSlicer

   This class defines an interface for reducing the number of conformers
   in a molecule by detecting duplicates.  This allows for
   :ref:`OEOmega <OEConfGen_OEOmega>` to generate a very large ensemble with
   much looser deduplication parameters and then to "slice" that
   ensemble of conformations by various different parameters after the
   fact. 

   .. seealso::

      * :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` class
      * :oe:meth:`OEConfGen::OESliceEnsemble` method

   The :ref:`OEConfSlicer <OEConfGen_OEConfSlicer>` class defines the following public methods:
    * :oe:meth:`Slice<OEConfGen::OEConfSlicer::Slice>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfSlicer(const OESliceEnsembleOptions& opts = OESliceEnsembleOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEConfSlicer(opts: OESliceEnsembleOptions = OESliceEnsembleOptions()) -> OEConfSlicer

      Constructor.

   .. oe:method:: Slice

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Slice(OEChem::OEMCMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            Slice(mol: OEMol) -> bool

      Slices the input molecule to remove duplicates.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEFlipperClassicOptions, OmegaOptions

.. _OEConfGen_OEFlipperClassicOptions:

.. oe:class:: OEFlipperClassicOptions

   .. oe:api::

      class OEFlipperClassicOptions : public OEFlipperOptions

   .. caution::

     |DEPRECATED-API|

     This class was introduced to allow validation of previous **Flipper** results against the preferred
     updated flag options. It will be removed in a subsequent release.

   .. seealso::

      * :ref:`OEFlipperOptions <OEConfGen_OEFlipperOptions>` class
      * :ref:`OEFlipper <OEConfGen_OEFlipper>` function

   The :ref:`OEFlipperClassicOptions <OEConfGen_OEFlipperClassicOptions>` class defines the following public methods:
    * :oe:meth:`GetAtomPredicate<OEConfGen::OEFlipperClassicOptions::GetAtomPredicate>` and
      :oe:meth:`SetAtomPredicate<OEConfGen::OEFlipperClassicOptions::SetAtomPredicate>`
    * :oe:meth:`GetBondPredicate<OEConfGen::OEFlipperClassicOptions::GetBondPredicate>` and
      :oe:meth:`SetBondPredicate<OEConfGen::OEFlipperClassicOptions::SetBondPredicate>`
    * :oe:meth:`GetEnhancedStereo<OEConfGen::OEFlipperClassicOptions::GetEnhancedStereo>` and
      :oe:meth:`SetEnhancedStereo<OEConfGen::OEFlipperClassicOptions::SetEnhancedStereo>`
    * :oe:meth:`GetEnumBridgehead<OEConfGen::OEFlipperClassicOptions::GetEnumBridgehead>` and
      :oe:meth:`SetEnumBridgehead<OEConfGen::OEFlipperClassicOptions::SetEnumBridgehead>`
    * :oe:meth:`GetEnumEZ<OEConfGen::OEFlipperClassicOptions::GetEnumEZ>` and
      :oe:meth:`SetEnumEZ<OEConfGen::OEFlipperClassicOptions::SetEnumEZ>`
    * :oe:meth:`GetEnumNitrogen<OEConfGen::OEFlipperClassicOptions::GetEnumNitrogen>` and
      :oe:meth:`SetEnumNitrogen<OEConfGen::OEFlipperClassicOptions::SetEnumNitrogen>`
    * :oe:meth:`GetEnumRS<OEConfGen::OEFlipperClassicOptions::GetEnumRS>` and
      :oe:meth:`SetEnumRS<OEConfGen::OEFlipperClassicOptions::SetEnumRS>`
    * :oe:meth:`GetEnumSpecifiedStereo<OEConfGen::OEFlipperClassicOptions::GetEnumSpecifiedStereo>` and
      :oe:meth:`SetEnumSpecifiedStereo<OEConfGen::OEFlipperClassicOptions::SetEnumSpecifiedStereo>`
    * :oe:meth:`GetMaxCenters<OEConfGen::OEFlipperClassicOptions::GetMaxCenters>` and
      :oe:meth:`SetMaxCenters<OEConfGen::OEFlipperClassicOptions::SetMaxCenters>`
    * :oe:meth:`GetWarts<OEConfGen::OEFlipperClassicOptions::GetWarts>` and
      :oe:meth:`SetWarts<OEConfGen::OEFlipperClassicOptions::SetWarts>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFlipperClassicOptions()
            OEFlipperClassicOptions(const OEFlipperClassicOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEFlipperClassicOptions() -> OEFlipperClassicOptions
            OEFlipperClassicOptions(arg2: OEFlipperClassicOptions) -> OEFlipperClassicOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFlipperClassicOptions &operator=(const OEFlipperClassicOptions &)

      Assignment operator.

   .. oe:method:: GetAtomPredicate

      .. oe:api::

         const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* GetAtomPredicate() const

      See the :oe:meth:`SetAtomPredicate<OEConfGen::OEFlipperClassicOptions::SetAtomPredicate>` method.

   .. oe:method:: GetBondPredicate

      .. oe:api::

         const OESystem::OEUnaryPredicate<OEChem::OEBondBase>* GetBondPredicate() const

      See the :oe:meth:`SetBondPredicate<OEConfGen::OEFlipperClassicOptions::SetBondPredicate>` method.

   .. oe:method:: GetEnhancedStereo

      .. oe:api::

         bool GetEnhancedStereo() const

      See the :oe:meth:`SetEnhancedStereo<OEConfGen::OEFlipperClassicOptions::SetEnhancedStereo>` method.

   .. oe:method:: GetEnumBridgehead

      .. oe:api::

         bool GetEnumBridgehead() const

      See the :oe:meth:`SetEnumBridgehead<OEConfGen::OEFlipperClassicOptions::SetEnumBridgehead>` method.

   .. oe:method:: GetEnumEZ

      .. oe:api::

         bool GetEnumEZ() const

      See the :oe:meth:`SetEnumEZ<OEConfGen::OEFlipperClassicOptions::SetEnumEZ>` method.

   .. oe:method:: GetEnumNitrogen

      .. oe:api::

         bool GetEnumNitrogen() const

      See the :oe:meth:`SetEnumNitrogen<OEConfGen::OEFlipperClassicOptions::SetEnumNitrogen>` method.

   .. oe:method:: GetEnumRS

      .. oe:api::

         bool GetEnumRS() const

      See the :oe:meth:`SetEnumRS<OEConfGen::OEFlipperClassicOptions::SetEnumRS>` method.

   .. oe:method:: GetEnumSpecifiedStereo

      .. oe:api::

         bool GetEnumSpecifiedStereo() const

      See the :oe:meth:`SetEnumSpecifiedStereo<OEConfGen::OEFlipperClassicOptions::SetEnumSpecifiedStereo>` method.

   .. oe:method:: GetMaxCenters

      .. oe:api::

         unsigned GetMaxCenters() const

      See the :oe:meth:`SetMaxCenters<OEConfGen::OEFlipperClassicOptions::SetMaxCenters>` method.

   .. oe:method:: GetWarts

      .. oe:api::

         bool GetWarts() const

      See the :oe:meth:`SetWarts<OEConfGen::OEFlipperClassicOptions::SetWarts>` method.

   .. oe:method:: SetAtomPredicate

      .. oe:api::

         bool SetAtomPredicate(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>&)

      Provides an input atom predicate to define the selection of the atom stereocenters which should be enumerated.
      For explicit user predicates, the bond predicate must also be provided explicitly.
      See the :oe:meth:`SetBondPredicate<OEConfGen::OEFlipperClassicOptions::SetBondPredicate>` method.

   .. oe:method:: SetBondPredicate

      .. oe:api::

         bool SetBondPredicate(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>&)

      Provides an input bond predicate to define the selection of the bond stereocenters which should be enumerated.
      For explicit user predicates, the atom predicate must also be provided explicitly.
      See the :oe:meth:`SetAtomPredicate<OEConfGen::OEFlipperClassicOptions::SetAtomPredicate>` method.

   .. oe:method:: SetEnhancedStereo

      .. oe:api::

         bool SetEnhancedStereo(const bool)

      Sets whether to consider explicit MDL enhanced stereogroups during flipping or not.
      Enhanced stereogroups generally contain a collection of stereocenters which should be considered
      as a collective unit, where a "flip" implies that all centers in the group should be flipped,
      thus retaining the relative stereo parity between the grouped stereocenters.  With this flag enabled,
      far fewer enantiomers will be generated than for individual stereocenter flipping activities,
      and relative stereo configurations will be retained.  When enabled, explicitly marked absolute
      stereocenters are excluded from the flipping activities.
      Default: False

      .. note::

         The membership and type of existing enhanced stereogroups are not modified as a result of the flipping operation.
         That is, the explicit stereogroups of ``and`` and ``or`` are not promoted to ``abs`` groups as a result of stereocenter parity flips.
         This retains the source of original stereogroup(s) in the generated isomer(s) for post-flipping validations and processing.
         This behavior is true regardless of the setting of :oe:meth:`GetEnhancedStereo<OEConfGen::OEFlipperOptions::GetEnhancedStereo>`.
         Stereocenters can be explicitly promoted to ``abs`` centers by deletion of all stereogroups, or by deleting all stereogroups and
         adding marked stereocenters to a single new ``abs`` stereogroup.

      .. seealso::

         * :oe:meth:`GetGroups<OEChem::OEMolBase::GetGroups>` method
         * :oe:cls:`OEIsMDLStereoGroup<OEChem::OEIsMDLStereoGroup>` class

   .. oe:method:: SetEnumBridgehead

      .. oe:api::

         bool SetEnumBridgehead(const bool)

      Sets whether to enumerate bridgehead stereocenters or not.
      Default: False

   .. oe:method:: SetEnumEZ

      .. oe:api::

         bool SetEnumEZ(const bool)

      Sets whether to enumerate *only* E/Z stereocenters or not. If *true*, no atoms are enumerated.
      Default: False

   .. oe:method:: SetEnumNitrogen

      .. oe:api::

         bool SetEnumNitrogen(const bool)

      Controls the behavior with respect to enumeration of nonterminal nitrogens. Any nitrogen with pyramidal geometry in the initial model of
      the input molecule, and having no more than two ring bonds is considered to be *invertible*. This will enumerate all possible puckers if set to *true*.
      Default: False

   .. oe:method:: SetEnumRS

      .. oe:api::

         bool SetEnumRS(const bool)

      Sets whether to enumerate *only* R/S stereocenters or not. If *true*, no bonds are enumerated.
      Default: False

   .. oe:method:: SetEnumSpecifiedStereo

      .. oe:api::

         bool SetEnumSpecifiedStereo(const bool)

      Sets whether to force the modification of all stereocenters in a molecule. If *false*,
      it will only enumerate stereocenters which do not already have a specified stereochemistry.
      Default: False

   .. oe:method:: SetMaxCenters

      .. oe:api::

         bool SetMaxCenters(const unsigned)

      Sets the maximum number of stereocenters or groups of stereocenters which will be fully enumerated.
      Default: 12

   .. oe:method:: SetWarts

      .. oe:api::

         bool SetWarts(const bool)

      Sets whether to generate unique titles for molecules.
      Default: False


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEFlipperOptions, OmegaOptions

.. _OEConfGen_OEFlipperOptions:

.. oe:class:: OEFlipperOptions

   .. oe:api::

      class OEFlipperOptions : public OESystem::OEOptions

   .. seealso::

      * :ref:`OEFlipper <OEConfGen_OEFlipper>` function

   .. admonition:: Code Examples

      * :ref:`section_examples_stereo_and_torsion` example

   The :ref:`OEFlipperOptions <OEConfGen_OEFlipperOptions>` class defines the following public methods:
    * :oe:meth:`GetAtomPredicate<OEConfGen::OEFlipperOptions::GetAtomPredicate>` and
      :oe:meth:`SetAtomPredicate<OEConfGen::OEFlipperOptions::SetAtomPredicate>`
    * :oe:meth:`GetBondPredicate<OEConfGen::OEFlipperOptions::GetBondPredicate>` and
      :oe:meth:`SetBondPredicate<OEConfGen::OEFlipperOptions::SetBondPredicate>`
    * :oe:meth:`GetEnhancedStereo<OEConfGen::OEFlipperOptions::GetEnhancedStereo>` and
      :oe:meth:`SetEnhancedStereo<OEConfGen::OEFlipperOptions::SetEnhancedStereo>`
    * :oe:meth:`GetEnumAtoms<OEConfGen::OEFlipperOptions::GetEnumAtoms>` and
      :oe:meth:`SetEnumAtoms<OEConfGen::OEFlipperOptions::SetEnumAtoms>`
    * :oe:meth:`GetEnumAtomSpecifiedStereo<OEConfGen::OEFlipperOptions::GetEnumAtomSpecifiedStereo>` and
      :oe:meth:`SetEnumAtomSpecifiedStereo<OEConfGen::OEFlipperOptions::SetEnumAtomSpecifiedStereo>`
    * :oe:meth:`GetEnumBonds<OEConfGen::OEFlipperOptions::GetEnumBonds>` and
      :oe:meth:`SetEnumBonds<OEConfGen::OEFlipperOptions::SetEnumBonds>`
    * :oe:meth:`GetEnumBondSpecifiedStereo<OEConfGen::OEFlipperOptions::GetEnumBondSpecifiedStereo>` and
      :oe:meth:`SetEnumBondSpecifiedStereo<OEConfGen::OEFlipperOptions::SetEnumBondSpecifiedStereo>`
    * :oe:meth:`GetEnumBridgehead<OEConfGen::OEFlipperOptions::GetEnumBridgehead>` and
      :oe:meth:`SetEnumBridgehead<OEConfGen::OEFlipperOptions::SetEnumBridgehead>`
    * :oe:meth:`GetEnumEZ<OEConfGen::OEFlipperOptions::GetEnumEZ>` and
      :oe:meth:`SetEnumEZ<OEConfGen::OEFlipperOptions::SetEnumEZ>`
    * :oe:meth:`GetEnumNitrogen<OEConfGen::OEFlipperOptions::GetEnumNitrogen>` and
      :oe:meth:`SetEnumNitrogen<OEConfGen::OEFlipperOptions::SetEnumNitrogen>`
    * :oe:meth:`GetEnumRS<OEConfGen::OEFlipperOptions::GetEnumRS>` and
      :oe:meth:`SetEnumRS<OEConfGen::OEFlipperOptions::SetEnumRS>`
    * :oe:meth:`GetEnumSpecifiedStereo<OEConfGen::OEFlipperOptions::GetEnumSpecifiedStereo>` and
      :oe:meth:`SetEnumSpecifiedStereo<OEConfGen::OEFlipperOptions::SetEnumSpecifiedStereo>`
    * :oe:meth:`GetEnumRelativeAtomStereo<OEConfGen::OEFlipperOptions::GetEnumRelativeAtomStereo>` and
      :oe:meth:`SetEnumRelativeAtomStereo<OEConfGen::OEFlipperOptions::SetEnumRelativeAtomStereo>`
    * :oe:meth:`GetMaxCenters<OEConfGen::OEFlipperOptions::GetMaxCenters>` and
      :oe:meth:`SetMaxCenters<OEConfGen::OEFlipperOptions::SetMaxCenters>`
    * :oe:meth:`GetWarts<OEConfGen::OEFlipperOptions::GetWarts>` and
      :oe:meth:`SetWarts<OEConfGen::OEFlipperOptions::SetWarts>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFlipperOptions()
            OEFlipperOptions(const OEFlipperOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEFlipperOptions() -> OEFlipperOptions
            OEFlipperOptions(arg2: OEFlipperOptions) -> OEFlipperOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFlipperOptions &operator=(const OEFlipperOptions &)

      Assignment operator.

   .. _OEConfGen_OEFlipperOptions_GetAtomPredicate:

   .. oe:method:: GetAtomPredicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* GetAtomPredicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomPredicate() -> OEUnaryAtomPred

      See the :oe:meth:`SetAtomPredicate<OEConfGen::OEFlipperOptions::SetAtomPredicate>` method.

   .. _OEConfGen_OEFlipperOptions_GetBondPredicate:

   .. oe:method:: GetBondPredicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEBondBase>* GetBondPredicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondPredicate() -> OEUnaryBondPred

      See the :oe:meth:`SetBondPredicate<OEConfGen::OEFlipperOptions::SetBondPredicate>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnhancedStereo:

   .. oe:method:: GetEnhancedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEnhancedStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnhancedStereo() -> bool

      See the :oe:meth:`SetEnhancedStereo<OEConfGen::OEFlipperOptions::SetEnhancedStereo>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumAtoms:

   .. oe:method:: GetEnumAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEnumAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumAtoms() -> bool

      See the :oe:meth:`SetEnumAtoms<OEConfGen::OEFlipperOptions::SetEnumAtoms>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumAtomSpecifiedStereo:

   .. oe:method:: GetEnumAtomSpecifiedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEnumAtomSpecifiedStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumAtomSpecifiedStereo() -> bool

      See the :oe:meth:`SetEnumAtomSpecifiedStereo<OEConfGen::OEFlipperOptions::SetEnumAtomSpecifiedStereo>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumBonds:

   .. oe:method:: GetEnumBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEnumBonds() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumBonds() -> bool

      See the :oe:meth:`SetEnumBonds<OEConfGen::OEFlipperOptions::SetEnumBonds>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumBondSpecifiedStereo:

   .. oe:method:: GetEnumBondSpecifiedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEnumBondSpecifiedStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumBondSpecifiedStereo() -> bool

      See the :oe:meth:`SetEnumBondSpecifiedStereo<OEConfGen::OEFlipperOptions::SetEnumBondSpecifiedStereo>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumBridgehead:

   .. oe:method:: GetEnumBridgehead

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEnumBridgehead() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumBridgehead() -> bool

      See the :oe:meth:`SetEnumBridgehead<OEConfGen::OEFlipperOptions::SetEnumBridgehead>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumEZ:

   .. oe:method:: GetEnumEZ

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEnumEZ() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumEZ() -> bool

      See the :oe:meth:`SetEnumEZ<OEConfGen::OEFlipperOptions::SetEnumEZ>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumNitrogen:

   .. oe:method:: GetEnumNitrogen

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEnumNitrogen() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumNitrogen() -> bool

      See the :oe:meth:`SetEnumNitrogen<OEConfGen::OEFlipperOptions::SetEnumNitrogen>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumRS:

   .. oe:method:: GetEnumRS

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEnumRS() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumRS() -> bool

      See the :oe:meth:`SetEnumRS<OEConfGen::OEFlipperOptions::SetEnumRS>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumRelativeAtomStereo:

   .. oe:method:: GetEnumRelativeAtomStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEnumRelativeAtomStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumRelativeAtomStereo() -> bool

      See the :oe:meth:`SetEnumRelativeAtomStereo<OEConfGen::OEFlipperOptions::SetEnumRelativeAtomStereo>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumSpecifiedStereo:

   .. oe:method:: GetEnumSpecifiedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEnumSpecifiedStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumSpecifiedStereo() -> bool

      See the :oe:meth:`SetEnumSpecifiedStereo<OEConfGen::OEFlipperOptions::SetEnumSpecifiedStereo>` method.

   .. _OEConfGen_OEFlipperOptions_GetMaxCenters:

   .. oe:method:: GetMaxCenters

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxCenters() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxCenters() -> int

      See the :oe:meth:`SetMaxCenters<OEConfGen::OEFlipperOptions::SetMaxCenters>` method.

   .. _OEConfGen_OEFlipperOptions_GetWarts:

   .. oe:method:: GetWarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetWarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetWarts() -> bool

      See the :oe:meth:`SetWarts<OEConfGen::OEFlipperOptions::SetWarts>` method.

   .. _OEConfGen_OEFlipperOptions_SetAtomPredicate:

   .. oe:method:: SetAtomPredicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAtomPredicate(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>&)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomPredicate(value: OEUnaryAtomPred) -> bool

      Provides an input atom predicate to define the selection of the atom stereocenters which should be enumerated.

   .. _OEConfGen_OEFlipperOptions_SetBondPredicate:

   .. oe:method:: SetBondPredicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBondPredicate(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>&)

      .. oe:language:: python

         .. oe:api:: python

            SetBondPredicate(value: OEUnaryBondPred) -> bool

      Provides an input bond predicate to define the selection of the bond stereocenters which should be enumerated.

   .. _OEConfGen_OEFlipperOptions_SetEnhancedStereo:

   .. oe:method:: SetEnhancedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnhancedStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnhancedStereo(value: bool) -> bool

      Sets whether to consider explicit MDL enhanced stereogroups during flipping.
      Enhanced stereogroups generally contain a collection of stereocenters which should be considered
      as a collective unit, where a "flip" implies that all centers in the group should be flipped,
      thus retaining the relative stereo parity between the grouped stereocenters.  With this flag enabled,
      far fewer enantiomers will be generated than for individual stereocenter flipping activities,
      and relative stereo configurations will be retained.  When enabled, explicitly marked absolute
      stereocenters are excluded from the flipping activities.  Care should be taken to ensure that any
      custom atom predicate returns all atoms involved in enhanced stereogroups.
      Default: False

      .. note::

         The membership and type of existing enhanced stereogroups are not modified as a result of the flipping operation.
         That is, the explicit stereogroups of ``and`` and ``or`` are not promoted to ``abs`` groups as a result of stereocenter parity flips.
         This retains the source of original stereogroup(s) in the generated isomer(s) for post-flipping validations and processing.
         This behavior is *true* regardless of the setting of :oe:meth:`GetEnhancedStereo<OEConfGen::OEFlipperOptions::GetEnhancedStereo>`.
         Stereocenters can be explicitly promoted to ``abs`` centers by deletion of all stereogroups, or by deleting all stereogroups and
         adding marked stereocenters to a single new ``abs`` stereogroup.

      .. seealso::

         * :oe:meth:`GetGroups<OEChem::OEMolBase::GetGroups>` method
         * :oe:cls:`OEIsMDLStereoGroup<OEChem::OEIsMDLStereoGroup>` class

   .. _OEConfGen_OEFlipperOptions_SetEnumAtoms:

   .. oe:method:: SetEnumAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnumAtoms(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumAtoms(value: bool) -> bool

      Sets whether to include R/S stereocenters in the enumeration or not. If *false*,
      disregards atom enumerations.
      Default: True

   .. _OEConfGen_OEFlipperOptions_SetEnumAtomSpecifiedStereo:

   .. oe:method:: SetEnumAtomSpecifiedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnumAtomSpecifiedStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumAtomSpecifiedStereo(value: bool) -> bool

      Sets whether to force the modification of all R/S stereocenters in a molecule. If *false*, it
      will only enumerate stereocenters which do not already have a specified stereochemistry.
      Default: False

   .. _OEConfGen_OEFlipperOptions_SetEnumBonds:

   .. oe:method:: SetEnumBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnumBonds(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumBonds(value: bool) -> bool

      Sets whether to include E/Z bonds in the enumeration. If *false*,
      disregards bond enumerations.
      Default: True

   .. _OEConfGen_OEFlipperOptions_SetEnumBondSpecifiedStereo:

   .. oe:method:: SetEnumBondSpecifiedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnumBondSpecifiedStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumBondSpecifiedStereo(value: bool) -> bool

      Sets whether to force the modification of all E/Z stereocenters in a molecule. If *false*, it
      will only enumerate bonds which do not already have a specified stereochemistry.
      Default: False

   .. _OEConfGen_OEFlipperOptions_SetEnumBridgehead:

   .. oe:method:: SetEnumBridgehead

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnumBridgehead(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumBridgehead(value: bool) -> bool

      Sets whether to enumerate bridgehead stereocenters.
      Default: False

   .. _OEConfGen_OEFlipperOptions_SetEnumEZ:

   .. oe:method:: SetEnumEZ

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnumEZ(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumEZ(value: bool) -> bool

      Sets whether to enumerate E/Z stereocenters.
      Default: True

   .. _OEConfGen_OEFlipperOptions_SetEnumNitrogen:

   .. oe:method:: SetEnumNitrogen

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnumNitrogen(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumNitrogen(value: bool) -> bool

      Controls the behavior with respect to the enumeration of nonterminal nitrogens. Any nitrogen with pyramidal geometry in the initial model of
      the input molecule, and having no more than two ring bonds, is considered to be *invertible*. This will enumerate all possible puckers if set to *true*.
      Default: False

   .. _OEConfGen_OEFlipperOptions_SetEnumRS:

   .. oe:method:: SetEnumRS

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnumRS(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumRS(value: bool) -> bool

      Sets whether to enumerate R/S stereocenters.
      Default: True

   .. _OEConfGen_OEFlipperOptions_SetEnumRelativeAtomStereo:

   .. oe:method:: SetEnumRelativeAtomStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnumRelativeAtomStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumRelativeAtomStereo(value: bool) -> bool

      Sets whether to include enumeration of internally perceived relative atom stereocenters (e.g., 1,4-disubstituted cyclohexanes) in a molecule.
      If *true*, consider relative stereocenters during stereo enumeration.
      Default: False

   .. _OEConfGen_OEFlipperOptions_SetEnumSpecifiedStereo:

   .. oe:method:: SetEnumSpecifiedStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnumSpecifiedStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumSpecifiedStereo(value: bool) -> bool

      Sets whether to force the modification of all of the atom and bond stereocenters in a molecule. If *false*, it
      will only enumerate stereocenters which do not already have a specified stereochemistry.
      Default: False

   .. _OEConfGen_OEFlipperOptions_SetMaxCenters:

   .. oe:method:: SetMaxCenters

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxCenters(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxCenters(value: int) -> bool

      Sets the maximum number of stereocenters or groups of stereocenters which will be fully enumerated.
      Default: 12

   .. _OEConfGen_OEFlipperOptions_SetWarts:

   .. oe:method:: SetWarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetWarts(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetWarts(value: bool) -> bool

      Sets whether to generate unique titles for molecules.
      Default: False


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEFragBuilder, FragBuilder

.. _OEConfGen_OEFragBuilder:

.. oe:class:: OEFragBuilder

   .. oe:api::

      class OEFragBuilder

   This class defines an interface for generating 3D structures
   of molecule fragments using a distance geometry based algorithm.
   A fragment is a building block that is used for initial
   3D structure generation of molecules.

   .. seealso::

      * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class

   The :ref:`OEFragBuilder <OEConfGen_OEFragBuilder>` class defines the following public methods:
    * :oe:meth:`Build<OEConfGen::OEFragBuilder::Build>`
    * :oe:meth:`GetOptions<OEConfGen::OEFragBuilder::GetOptions>` and
      :oe:meth:`SetOptions<OEConfGen::OEFragBuilder::SetOptions>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFragBuilder(const OEFragBuilderOptions& argOpts = OEFragBuilderOptions())
            OEFragBuilder(const OEFragBuilder&)

      .. oe:language:: python

         .. oe:api:: python

            OEFragBuilder(argOpts: OEFragBuilderOptions = OEFragBuilderOptions()) -> OEFragBuilder
            OEFragBuilder(arg2: OEFragBuilder) -> OEFragBuilder

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFragBuilder &operator=(const OEFragBuilder&)

      Assignment operator.

   .. _OEConfGen_OEFragBuilder_Build:

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Build(OEChem::OEMCMolBase&) const

      .. oe:language:: python

         .. oe:api:: python

            Build(mol: OEMol) -> int

      Generates 3D structures for a molecule fragment. Returns 
      :oe:const:`OEConfGen::OEOmegaReturnCode::Success` if 
      the process succeeds, otherwise returns an error code from the
      :oe:constns:`OEConfGen::OEOmegaReturnCode` namespace.

   .. _OEConfGen_OEFragBuilder_GetOptions:

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFragBuilderOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEFragBuilderOptions

      See the :oe:meth:`SetOptions<OEConfGen::OEFragBuilder::SetOptions>` method.

   .. _OEConfGen_OEFragBuilder_SetOptions:

   .. oe:method:: SetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOptions(OEFragBuilderOptions& argOpts)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(argOpts: OEFragBuilderOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OEFragBuilderOptions>` for building
      the fragment structures.
      Default: :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` with
      :oe:const:`OEConfGen::OEFragBuilderMode::Default` mode.

      .. seealso::

         * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEFragBuilderOptions, FragBuilderOptions

.. _OEConfGen_OEFragBuilderOptions:

.. oe:class:: OEFragBuilderOptions

   .. oe:api::

      class OEFragBuilderOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for generating
   fragment coordinates for different types of fragments.
   A fragment is a building block that is used for initial
   3D structure generation of molecules.

   .. seealso::

      * :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>` class
      * :ref:`OEFragOptions <OEConfGen_OEFragOptions>` class
      * :ref:`OERingFragOptions <OEConfGen_OERingFragOptions>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_make_fraglib` example

   The :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class defines the following public methods:
    * :oe:meth:`GetForceField<OEConfGen::OETorDriveOptions::GetForceField>` and
      :oe:meth:`SetForceField<OEConfGen::OETorDriveOptions::SetForceField>`
    * :oe:meth:`GetMacroCycOptions<OEConfGen::OEFragBuilderOptions::GetMacroCycOptions>` and
      :oe:meth:`SetMacroCycOptions<OEConfGen::OEFragBuilderOptions::SetMacroCycOptions>`
    * :oe:meth:`GetNonRingOptions<OEConfGen::OEFragBuilderOptions::GetNonRingOptions>` and
      :oe:meth:`SetNonRingOptions<OEConfGen::OEFragBuilderOptions::SetNonRingOptions>`
    * :oe:meth:`GetRingOptions<OEConfGen::OEFragBuilderOptions::GetRingOptions>` and
      :oe:meth:`SetRingOptions<OEConfGen::OEFragBuilderOptions::SetRingOptions>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFragBuilderOptions(const unsigned int mode = OEFragBuilderMode::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEFragBuilderOptions(argMode: int) -> OEFragBuilderOptions

      The `mode` parameter defines the fragment build modes from the
      :oe:constns:`OEConfGen::OEFragBuilderMode` namespace.
      Default: :oe:const:`OEConfGen::OEFragBuilderMode::Default`

      .. seealso::

         * :oe:constns:`OEConfGen::OEFragBuilderMode` namespace

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFragBuilderOptions(const OEFragBuilderOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEFragBuilderOptions(arg2: OEFragBuilderOptions) -> OEFragBuilderOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFragBuilderOptions &operator=(const OEFragBuilderOptions &)

      Assignment operator.

   .. _OEConfGen_OEFragBuilderOptions_GetForceField:

   .. oe:method:: GetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEForceField

      See the :oe:meth:`SetForceField<OEConfGen::OETorDriveOptions::SetForceField>` method.

   .. _OEConfGen_OEFragBuilderOptions_GetMacroCycOptions:

   .. oe:method:: GetMacroCycOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFragOptions& GetMacroCycOptions()
            const OEFragOptions& GetMacroCycOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetMacroCycOptions() -> OEFragOptions

      See the :oe:meth:`SetMacroCycOptions<OEConfGen::OEFragBuilderOptions::SetMacroCycOptions>` method.

   .. _OEConfGen_OEFragBuilderOptions_GetNonRingOptions:

   .. oe:method:: GetNonRingOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFragOptions& GetNonRingOptions()
            const OEFragOptions& GetNonRingOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetNonRingOptions() -> OEFragOptions

      See the :oe:meth:`SetNonRingOptions<OEConfGen::OEFragBuilderOptions::SetNonRingOptions>` method.

   .. _OEConfGen_OEFragBuilderOptions_GetRingOptions:

   .. oe:method:: GetRingOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERingFragOptions& GetRingOptions()
            const OERingFragOptions& GetRingOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetRingOptions() -> OERingFragOptions

      See the :oe:meth:`SetRingOptions<OEConfGen::OEFragBuilderOptions::SetRingOptions>` method.

   .. _OEConfGen_OEFragBuilderOptions_SetForceField:

   .. oe:method:: SetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceField(const unsigned)
            bool SetForceField(const std::string&)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: int) -> bool
            SetForceField(value: str) -> bool
            SetForceField(value: oeistream) -> bool
            SetForceField(value: OEForceField) -> bool

      Sets the **force field** used for torsion driving. The first overload takes an *unsigned*
      from the :oe:constns:`OEFF::OEMMFFSheffieldFFType` namespace, and the second overload
      takes corresponding string values. Method returns *false* when the invalid selection
      is chosen, *true* otherwise.
      Default: :oe:const:`OEFF::OEMMFFSheffieldFFType::MMFF_NOESTAT`

   .. _OEConfGen_OEFragBuilderOptions_SetMacroCycOptions:

   .. oe:method:: SetMacroCycOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMacroCycOptions(const OEFragOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetMacroCycOptions(opts: OEFragOptions) -> None

      Sets :oe:cls:`options <OEConfGen::OEFragOptions>` related to building macrocycle fragments.

      .. seealso::

         * :ref:`OEFragOptions <OEConfGen_OEFragOptions>` class

   .. _OEConfGen_OEFragBuilderOptions_SetNonRingOptions:

   .. oe:method:: SetNonRingOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNonRingOptions(const OEFragOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetNonRingOptions(opts: OEFragOptions) -> None

      Sets :oe:cls:`options <OEConfGen::OEFragOptions>` related to building general fragments
      that are not rings.

      .. seealso::

         * :ref:`OEFragOptions <OEConfGen_OEFragOptions>` class

   .. oe:method:: SetRingOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRingOptions(const OERingFragOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetRingOptions(opts: OERingFragOptions) -> None

      Sets :oe:cls:`options <OEConfGen::OERingFragOptions>` related to building ring fragments.

      .. seealso::

         * :ref:`OERingFragOptions <OEConfGen_OERingFragOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEFragOptions, FragOptions

.. _OEConfGen_OEFragOptions:

.. oe:class:: OEFragOptions

   .. oe:api::

      class OEFragOptions

   This class provides an interface to setup options required for generating 
   fragment coordinates for a specific type of fragment.
   A fragment is a building block that is used for initial
   3D structure generation of molecules.

   .. seealso::

      * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class

   The :ref:`OEFragOptions <OEConfGen_OEFragOptions>` class defines the following public methods:
    * :oe:meth:`GetEnergyWindow<OEConfGen::OEFragOptions::GetEnergyWindow>` and
      :oe:meth:`SetEnergyWindow<OEConfGen::OEFragOptions::SetEnergyWindow>`
    * :oe:meth:`GetFragGen<OEConfGen::OEFragOptions::GetFragGen>` and
      :oe:meth:`SetFragGen<OEConfGen::OEFragOptions::SetFragGen>`
    * :oe:meth:`GetFragKeep<OEConfGen::OEFragOptions::GetFragKeep>` and
      :oe:meth:`SetFragKeep<OEConfGen::OEFragOptions::SetFragKeep>`
    * :oe:meth:`GetRMS<OEConfGen::OEFragOptions::GetRMS>` and
      :oe:meth:`SetRMS<OEConfGen::OEFragOptions::SetRMS>`
    * :oe:meth:`GetTimeLimit<OEConfGen::OEFragOptions::GetTimeLimit>` and
      :oe:meth:`SetTimeLimit<OEConfGen::OEFragOptions::SetTimeLimit>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFragOptions()
            OEFragOptions(const OEFragOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEFragOptions() -> OEFragOptions
            OEFragOptions(arg2: OEFragOptions) -> OEFragOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFragOptions &operator=(const OEFragOptions &)

      Assignment operator.

   .. _OEConfGen_OEFragOptions_GetEnergyWindow:

   .. oe:method:: GetEnergyWindow

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEnergyWindow() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnergyWindow() -> float

      See the :oe:meth:`SetEnergyWindow<OEConfGen::OEFragOptions::SetEnergyWindow>` method.

   .. _OEConfGen_OEFragOptions_GetFragGen:

   .. oe:method:: GetFragGen

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFragGen() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragGen() -> int

      See the :oe:meth:`SetFragGen<OEConfGen::OEFragOptions::SetFragGen>` method.

   .. _OEConfGen_OEFragOptions_GetFragKeep:

   .. oe:method:: GetFragKeep

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFragKeep() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragKeep() -> int

      See the :oe:meth:`SetFragKeep<OEConfGen::OEFragOptions::SetFragKeep>` method.

   .. _OEConfGen_OEFragOptions_GetRMS:

   .. oe:method:: GetRMS

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRMS() const

      .. oe:language:: python

         .. oe:api:: python

            GetRMS() -> float

      See the :oe:meth:`SetRMS<OEConfGen::OEFragOptions::SetRMS>` method.

   .. _OEConfGen_OEFragOptions_GetTimeLimit:

   .. oe:method:: GetTimeLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTimeLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetTimeLimit() -> float

      See the :oe:meth:`SetTimeLimit<OEConfGen::OEFragOptions::SetTimeLimit>` method.

   .. _OEConfGen_OEFragOptions_SetEnergyWindow:

   .. oe:method:: SetEnergyWindow

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnergyWindow(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetEnergyWindow(value: float) -> bool

      Sets the **maximum allowable energy difference** between the
      lowest and the highest energy fragment conformers, in units of kcal/mol. 
      Default: 8.0 kcal/mol

   .. _OEConfGen_OEFragOptions_SetFragGen:

   .. oe:method:: SetFragGen

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFragGen(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetFragGen(value: int) -> bool

      Sets the **maximum number of fragment conformers** to generate in
      obtaining the ensemble of fragment conformers. 
      Default: 40

   .. _OEConfGen_OEFragOptions_SetFragKeep:

   .. oe:method:: SetFragKeep

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFragKeep(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetFragKeep(value: int) -> bool

      Sets the **maximum number of fragments** to keep from the
      generated ensemble. Default: 1

   .. _OEConfGen_OEFragOptions_SetRMS:

   .. oe:method:: SetRMS

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRMS(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetRMS(value: float) -> bool

      Sets the **RMS distance** (Root Mean Square Cartesian distance) 
      below which two conformers are treated as duplicates.
      Default: 0.1

  .. _OEConfGen_OEFragOptions_SetTimeLimit:

   .. oe:method:: SetTimeLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTimeLimit(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetTimeLimit(value: float) -> bool

      Sets the **maximum allowable time** for generating conformers
      of a fragment, in units of seconds. Default: 300.0 s


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEMacrocycleBuilder, MacrocycleBuilder

.. _OEConfGen_OEMacrocycleBuilder:

.. oe:class:: OEMacrocycleBuilder

   .. oe:api::

      class OEMacrocycleBuilder

   This class defines an interface for generating 3D structures
   of macrocyclic molecules.  Macrocycle structures are generated
   by first creating an initial structure using distance geometry, followed by
   a force field based refinement of the structure.

   .. seealso::

      * :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_single_conf_macrocycle` example

   The :ref:`OEMacrocycleBuilder <OEConfGen_OEMacrocycleBuilder>` class defines the following public methods:
    * :oe:meth:`Build<OEConfGen::OEMacrocycleBuilder::Build>`
    * :oe:meth:`GetOptions<OEConfGen::OEMacrocycleBuilder::GetOptions>` and
      :oe:meth:`SetOptions<OEConfGen::OEMacrocycleBuilder::SetOptions>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMacrocycleBuilder(const OEMacrocycleBuilderOptions& argOpts = OEMacrocycleBuilderOptions())
            OEMacrocycleBuilder(const OEMacrocycleBuilder&)

      .. oe:language:: python

         .. oe:api:: python

            OEMacrocycleBuilder(argOpts: OEMacrocycleBuilderOptions = OEMacrocycleBuilderOptions()) -> OEMacrocycleBuilder
            OEMacrocycleBuilder(arg2: OEMacrocycleBuilder) -> OEMacrocycleBuilder

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMacrocycleBuilder &operator=(const OEMacrocycleBuilder&)

      Assignment operator.

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Build(OEChem::OEMolBase&) const
            unsigned Build(OEChem::OEMCMolBase&) const

      .. oe:language:: python

         .. oe:api:: python

            Build(mol: Union[OEGraphMol,OEQMol]) -> int
            Build(mol: OEMol) -> int

      Generates a 3D structure for a macrocycle molecule. Returns
      :oe:const:`OEConfGen::OEOmegaReturnCode::Success` if 
      the process succeeds, otherwise returns an error code from the
      :oe:constns:`OEConfGen::OEOmegaReturnCode` namespace. 

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMacrocycleBuilderOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEMacrocycleBuilderOptions

      See the :oe:meth:`SetOptions<OEConfGen::OEMacrocycleBuilder::SetOptions>` method.

   .. oe:method:: SetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOptions(OEMacrocycleBuilderOptions& argOpts)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(argOpts: OEMacrocycleBuilderOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OEMacrocycleBuilderOptions>` for building the molecule 3D structures.

   .. seealso::

      * :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEMacrocycleBuilderOptions, MacrocycleBuilderOptions

.. _OEConfGen_OEMacrocycleBuilderOptions:

.. oe:class:: OEMacrocycleBuilderOptions

   .. oe:api::

      class OEMacrocycleBuilderOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for generating
   3D structures of macrocycle molecules.

   .. seealso::

      * :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>` class
      * :ref:`OEMacrocycleBuilder <OEConfGen_OEMacrocycleBuilder>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_single_conf_macrocycle` example

   The :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>` class defines the following public methods:
    * :oe:meth:`GetDielectricConst<OEConfGen::OEMacrocycleBuilderOptions::GetDielectricConst>` and
      :oe:meth:`SetDielectricConst<OEConfGen::OEMacrocycleBuilderOptions::SetDielectricConst>`
    * :oe:meth:`GetRandomSeed<OEConfGen::OEMacrocycleBuilderOptions::GetRandomSeed>` and
      :oe:meth:`SetRandomSeed<OEConfGen::OEMacrocycleBuilderOptions::SetRandomSeed>`
    * :oe:meth:`GetRefTolerance<OEConfGen::OEMacrocycleBuilderOptions::GetRefTolerance>` and
      :oe:meth:`SetRefTolerance<OEConfGen::OEMacrocycleBuilderOptions::SetRefTolerance>`
    * :oe:meth:`GetSkipRefinement<OEConfGen::OEMacrocycleBuilderOptions::GetSkipRefinement>` and
      :oe:meth:`SetSkipRefinement<OEConfGen::OEMacrocycleBuilderOptions::SetSkipRefinement>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMacrocycleBuilderOptions()
            OEMacrocycleBuilderOptions(const OEMacrocycleBuilderOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEMacrocycleBuilderOptions() -> OEMacrocycleBuilderOptions
            OEMacrocycleBuilderOptions(arg2: OEMacrocycleBuilderOptions) -> OEMacrocycleBuilderOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMacrocycleBuilderOptions &operator=(const OEMacrocycleBuilderOptions &)

      Assignment operator.

   .. oe:method:: GetDielectricConst

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDielectricConst() const

      .. oe:language:: python

         .. oe:api:: python

            GetDielectricConst() -> float

      See the :oe:meth:`SetDielectricConst<OEConfGen::OEMacrocycleBuilderOptions::SetDielectricConst>` method.

   .. oe:method:: GetRandomSeed

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetRandomSeed() const

      .. oe:language:: python

         .. oe:api:: python

            GetRandomSeed() -> int

      See the :oe:meth:`SetRandomSeed<OEConfGen::OEMacrocycleBuilderOptions::SetRandomSeed>` method.

   .. oe:method:: GetRefTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRefTolerance() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefTolerance() -> float

      See the :oe:meth:`SetRefTolerance<OEConfGen::OEMacrocycleBuilderOptions::SetRefTolerance>` method.

   .. oe:method:: GetSkipRefinement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSkipRefinement() const

      .. oe:language:: python

         .. oe:api:: python

            GetSkipRefinement() -> bool

      See the :oe:meth:`SetSkipRefinement<OEConfGen::OEMacrocycleBuilderOptions::SetSkipRefinement>` method.

   .. oe:method:: SetDielectricConst

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDielectricConst(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetDielectricConst(value: float) -> bool

      Sets the **dielectric constant of the solvent** to be used
      in the refinement stage.
      Default: 80.0

   .. oe:method:: SetRandomSeed

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRandomSeed(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetRandomSeed(value: int) -> bool

      Sets the **random seed** for initial structure generation.
      Default: 0

   .. oe:method:: SetRefTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRefTolerance(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetRefTolerance(value: float) -> bool

      Sets the **tolerance criteria** for the optimizer during refinement.
      Default: 0.001

   .. oe:method:: SetSkipRefinement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSkipRefinement(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetSkipRefinement(value: bool) -> bool

      Sets whether **refinement** of the generated initial structure
      should be **performed or skipped**. If true, refinement is skipped.
      Default: False


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEMacrocycleOmega, MacrocycleOmega

.. _OEConfGen_OEMacrocycleOmega:

.. oe:class:: OEMacrocycleOmega

   .. oe:api::

      class OEMacrocycleOmega

   This class defines an interface for generating ensembles of conformers
   of macrocycle molecules.

   .. seealso::

      * :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>` class
      * :ref:`OEMacrocycleBuilder <OEConfGen_OEMacrocycleBuilder>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_macrocycle` example

   The :ref:`OEMacrocycleOmega <OEConfGen_OEMacrocycleOmega>` class defines the following public methods:
    * :oe:meth:`Build<OEConfGen::OEMacrocycleOmega::Build>`
    * :oe:meth:`GetOptions<OEConfGen::OEMacrocycleOmega::GetOptions>` and
      :oe:meth:`SetOptions<OEConfGen::OEMacrocycleOmega::SetOptions>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMacrocycleOmega(const OEMacrocycleOmegaOptions& argOpts = OEMacrocycleOmegaOptions())
            OEMacrocycleOmega(const OEMacrocycleOmega&)

      .. oe:language:: python

         .. oe:api:: python

            OEMacrocycleOmega(argOpts: OEMacrocycleOmegaOptions = OEMacrocycleOmegaOptions()) -> OEMacrocycleOmega
            OEMacrocycleOmega(arg2: OEMacrocycleOmega) -> OEMacrocycleOmega

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMacrocycleOmega &operator=(const OEMacrocycleOmega&)

      Assignment operator.

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Build(OEChem::OEMCMolBase&) const

      .. oe:language:: python

         .. oe:api:: python

            Build(mol: OEMol) -> int

      Generates conformer ensemble for a macrocyclic molecule. Returns
      :oe:const:`OEConfGen::OEOmegaReturnCode::Success` if 
      the process succeeds, otherwise returns an error code from the
      :oe:constns:`OEConfGen::OEOmegaReturnCode` namespace.

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMacrocycleOmegaOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEMacrocycleOmegaOptions

      See the :oe:meth:`SetOptions<OEConfGen::OEMacrocycleOmega::SetOptions>` method.

   .. oe:method:: SetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOptions(OEMacrocycleOmegaOptions& argOpts)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(argOpts: OEMacrocycleOmegaOptions) -> None

      Sets the :oe:cls:`options<OEConfGen::OEMacrocycleOmegaOptions>` for generating a conformer ensemble.

      .. seealso::

          * :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEMacrocycleOmegaOptions, MacrocycleOmegaOptions

.. _OEConfGen_OEMacrocycleOmegaOptions:

.. oe:class:: OEMacrocycleOmegaOptions

   .. oe:api::

      class OEMacrocycleOmegaOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for generating an
   ensemble of macrocycle molecule conformers.

   .. seealso::

      * :ref:`OEMacrocycleOmega <OEConfGen_OEMacrocycleOmega>` class
      * :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` class
      * :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_macrocycle` example

   The :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>` class defines the following public methods:
    * :oe:meth:`GetEnergyWindow<OEConfGen::OEMacrocycleOmegaOptions::GetEnergyWindow>` and
      :oe:meth:`SetEnergyWindow<OEConfGen::OEMacrocycleOmegaOptions::SetEnergyWindow>`
    * :oe:meth:`GetIterCycleSize<OEConfGen::OEMacrocycleOmegaOptions::GetIterCycleSize>` and
      :oe:meth:`SetIterCycleSize<OEConfGen::OEMacrocycleOmegaOptions::SetIterCycleSize>`
    * :oe:meth:`GetMacrocycleBuilderOptions<OEConfGen::OEMacrocycleOmegaOptions::GetMacrocycleBuilderOptions>` and
      :oe:meth:`SetMacrocycleBuilderOptions<OEConfGen::OEMacrocycleOmegaOptions::SetMacrocycleBuilderOptions>`
    * :oe:meth:`GetMaxConfs<OEConfGen::OEMacrocycleOmegaOptions::GetMaxConfs>` and
      :oe:meth:`SetMaxConfs<OEConfGen::OEMacrocycleOmegaOptions::SetMaxConfs>`
    * :oe:meth:`GetMaxIter<OEConfGen::OEMacrocycleOmegaOptions::GetMaxIter>` and
      :oe:meth:`SetMaxIter<OEConfGen::OEMacrocycleOmegaOptions::SetMaxIter>`
    * :oe:meth:`GetSliceEnsembleOptions<OEConfGen::OEMacrocycleOmegaOptions::GetSliceEnsembleOptions>` and
      :oe:meth:`SetSliceEnsembleOptions<OEConfGen::OEMacrocycleOmegaOptions::SetSliceEnsembleOptions>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMacrocycleOmegaOptions()
            OEMacrocycleOmegaOptions(const OEMacrocycleOmegaOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEMacrocycleOmegaOptions() -> OEMacrocycleOmegaOptions
            OEMacrocycleOmegaOptions(arg2: OEMacrocycleOmegaOptions) -> OEMacrocycleOmegaOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMacrocycleOmegaOptions &operator=(const OEMacrocycleOmegaOptions &)

      Assignment operator.

   .. oe:method:: GetEnergyWindow

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEnergyWindow() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnergyWindow() -> float

      See the :oe:meth:`SetEnergyWindow<OEConfGen::OEMacrocycleOmegaOptions::SetEnergyWindow>` method.

   .. oe:method:: GetIterCycleSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetIterCycleSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetIterCycleSize() -> int

      See the :oe:meth:`SetIterCycleSize<OEConfGen::OEMacrocycleOmegaOptions::SetIterCycleSize>` method.

   .. oe:method:: GetMacrocycleBuilderOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMacrocycleBuilderOptions& GetMacrocycleBuilderOptions()
            const OEMacrocycleBuilderOptions& GetMacrocycleBuilderOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetMacrocycleBuilderOptions() -> OEMacrocycleBuilderOptions

      See the :oe:meth:`SetMacrocycleBuilderOptions<OEConfGen::OEMacrocycleOmegaOptions::SetMacrocycleBuilderOptions>` method.

   .. oe:method:: GetMaxConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxConfs() -> int

      See the :oe:meth:`SetMaxConfs<OEConfGen::OEMacrocycleOmegaOptions::SetMaxConfs>` method.

   .. oe:method:: GetMaxIter

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxIter() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxIter() -> int

      See the :oe:meth:`SetMaxIter<OEConfGen::OEMacrocycleOmegaOptions::SetMaxIter>` method.

   .. oe:method:: GetSliceEnsembleOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESliceEnsembleOptions& GetSliceEnsembleOptions()
            const OESliceEnsembleOptions& GetSliceEnsembleOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSliceEnsembleOptions() -> OESliceEnsembleOptions

      See :oe:meth:`SetSliceEnsembleOptions<OEConfGen::OEMacrocycleOmegaOptions::SetSliceEnsembleOptions>` method.

   .. oe:method:: SetEnergyWindow

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnergyWindow(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetEnergyWindow(value: float) -> bool

      See the :oe:meth:`SetEnergyWindow<OEConfGen::OESliceEnsembleOptions::SetEnergyWindow>` method.
      Default: 20

   .. oe:method:: SetIterCycleSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIterCycleSize(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetIterCycleSize(value: int) -> bool

      Sets the **number of new conformers** that are to be attempted
      before checking if a new minimum was found. Conformer generation finishes
      if no new minimum is found during an iteration cycle.
      Default: 100

   .. oe:method:: SetMacrocycleBuilderOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMacrocycleBuilderOptions(const OEMacrocycleBuilderOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetMacrocycleBuilderOptions(opts: OEMacrocycleBuilderOptions) -> None

      Sets the :oe:cls:`options<OEConfGen::OEMacrocycleBuilderOptions>`
      that are to be used for generating new conformers.

      .. seealso::

          * :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>` class

   ..   _OEConfGen_SetMaxConfs:

   .. oe:method:: SetMaxConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxConfs(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxConfs(value: int) -> bool

      See the :oe:meth:`SetMaxConfs<OEConfGen::OESliceEnsembleOptions::SetMaxConfs>` method.
      Default: 400

   .. oe:method:: SetMaxIter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxIter(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxIter(value: int) -> bool

      Sets the **maximum number of iteration cycles** are to be attempted.
      If the desired number of unique conformers are already generated in the ensemble,
      conformer generation will terminate before reaching this number.
      Default: 2000

   .. oe:method:: SetSliceEnsembleOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSliceEnsembleOptions(const OESliceEnsembleOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetSliceEnsembleOptions(opts: OESliceEnsembleOptions) -> None

      Sets the :oe:cls:`options<OEConfGen::OESliceEnsembleOptions>` that are to be used for removing duplicate
      conformers during macrocycle conformer ensemble generation.

      .. seealso::

         * :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEMakeFragLib, MakeFragLib

.. _OEConfGen_OEMakeFragLib:

.. oe:class:: OEMakeFragLib

   .. oe:api::

      class OEMakeFragLib : public OEBuilderBase

   This class defines an interface for generating a fragment library.
   The builder allows building either a partial or a complete
   fragment library by controlling the content of the fragment library currently
   loaded in the builder.

   .. admonition:: Code Examples

      * :ref:`section_examples_make_fraglib` example

   The following methods are publicly inherited from :ref:`OEBuilderBase <OEConfGen_OEBuilderBase>`:
    * :oe:meth:`AddFragLib<OEConfGen::OEBuilderBase::AddFragLib>`
    * :oe:meth:`ClearFragLibs<OEConfGen::OEBuilderBase::ClearFragLibs>`

   The :ref:`OEMakeFragLib <OEConfGen_OEMakeFragLib>` class defines the following public methods:
    * :oe:meth:`AddFrag<OEConfGen::OEMakeFragLib::AddFrag>`
    * :oe:meth:`GenerateMissingFrags<OEConfGen::OEMakeFragLib::GenerateMissingFrags>`
    * :oe:meth:`GetMissingFrags<OEConfGen::OEMakeFragLib::GetMissingFrags>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMakeFragLib(const OEFragBuilderOptions& argOpts = OEFragBuilderOptions(OEFragBuilderMode::Strict))
            OEMakeFragLib(const OEMakeFragLib&)

      .. oe:language:: python

         .. oe:api:: python

            OEMakeFragLib(argOpts: OEFragBuilderOptions = OEFragBuilderOptions(OEFragBuilderMode_Strict)) -> OEMakeFragLib
            OEMakeFragLib(arg2: OEMakeFragLib) -> OEMakeFragLib

      Default and copy constructors. The default constructor instantiates the
      class with :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` with the
      :oe:const:`OEConfGen::OEFragBuilderMode::Strict` mode.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMakeFragLib &operator=(const OEMakeFragLib&)

      Assignment operator.

   .. _OEConfGen_OEMakeFragLib_AddFrag:

   .. oe:method:: AddFrag

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddFrag(const OEChem::OEMCMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            AddFrag(arg2: OEMol) -> None

      Adds the specified **fragment** to the currently loaded fragment library.

      .. seealso::

         * :oe:meth:`AddFragLib<OEConfGen::OEBuilderBase::AddFragLib>` method.

   .. _OEConfGen_OEMakeFragLib_GenerateMissingFrags:

   .. oe:method:: GenerateMissingFrags

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GenerateMissingFrags(OEChem::oemolistream& ,
                                      OEChem::oemolostream&) const
            void GenerateMissingFrags(const OEChem::OEMolBase&,
                                      OEChem::oemolostream&) const

      .. oe:language:: python

         .. oe:api:: python

            GenerateMissingFrags(infile: oemolistream, outfile: oemolostream) -> None
            GenerateMissingFrags(mol: Union[OEGraphMol,OEMol,OEQMol],
                                 outfile: oemolostream) -> None

      Finds the missing fragments corresponding to the given input file stream or
      molecule, generates 3D structures of the fragments, and adds those to the output
      file stream.

   .. _OEConfGen_OEMakeFragLib_GetMissingFrags:

   .. oe:method:: GetMissingFrags

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEMCMolBase>* GetMissingFrags(OEChem::oemolistream&) const
            OESystem::OEIterBase<OEChem::OEMCMolBase>* GetMissingFrags(const OEChem::OEMolBase&) const

      .. oe:language:: python

         .. oe:api:: python

            GetMissingFrags(infile: oemolistream) -> Iterable[OEMol]
            GetMissingFrags(mol: Union[OEGraphMol,OEMol,OEQMol]) -> Iterable[OEMol]

      Finds the missing fragments corresponding to the given input file stream or
      molecule and returns a collection of the fragments.
      This method does not generate 3D structures of the fragments.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEMolBuilder, MolBuilder

.. _OEConfGen_OEMolBuilder:

.. oe:class:: OEMolBuilder

   .. oe:api::

      class OEMolBuilder : public OEBuilderBase

   This class defines an interface for generating an initial 3D structure
   of a molecule by connecting pregenerated fragment coordinates that
   constitute the molecule.  Building the 3D structure of a molecule with this
   builder is fast when all the fragments constituting a molecule
   are available in the fragment library associated with the builder. This builder makes
   no effort to obtain a low energy conformer of the molecule.

   .. seealso::

      * :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>` class
      * :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>` class

   The following methods are publicly inherited from :ref:`OEBuilderBase <OEConfGen_OEBuilderBase>`:
    * :oe:meth:`AddFragLib<OEConfGen::OEBuilderBase::AddFragLib>`
    * :oe:meth:`ClearFragLibs<OEConfGen::OEBuilderBase::ClearFragLibs>`
   
   The :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` class defines the following public methods:
    * :oe:meth:`Build<OEConfGen::OEMolBuilder::Build>`
    * :oe:meth:`GetOptions<OEConfGen::OEMolBuilder::GetOptions>` and
      :oe:meth:`SetOptions<OEConfGen::OEMolBuilder::SetOptions>`
    * :oe:meth:`Prep<OEConfGen::OEMolBuilder::Prep>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolBuilder(const OEMolBuilderOptions& argOpts = OEMolBuilderOptions())
            OEMolBuilder(const OEMolBuilder&)

      .. oe:language:: python

         .. oe:api:: python

            OEMolBuilder(argOpts: OEMolBuilderOptions = OEMolBuilderOptions()) -> OEMolBuilder
            OEMolBuilder(arg2: OEMolBuilder) -> OEMolBuilder

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolBuilder &operator=(const OEMolBuilder&)

      Assignment operator.

   .. _OEConfGen_OEMolBuilder_Build:

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Build(OEChem::OEMCMolBase&,
                           const OEConfFixOptions& fixOpts = OEConfFixOptions()) const

      .. oe:language:: python

         .. oe:api:: python

            Build(mol: OEMol, fixOpts: OEConfFixOptions = OEConfFixOptions()) -> int

      Generates a 3D structure for a molecule. Returns 
      :oe:const:`OEConfGen::OEOmegaReturnCode::Success` if 
      the process succeeds, otherwise returns an error code from the
      :oe:constns:`OEConfGen::OEOmegaReturnCode` namespace. The second argument 
      provided with appropriate options can be
      used to fix part of a molecule structure to predefined coordinates.

      .. seealso::

         * :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>` class

   .. _OEConfGen_OEMolBuilder_GetOptions:

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMolBuilderOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEMolBuilderOptions

      See the :oe:meth:`SetOptions<OEConfGen::OEMolBuilder::SetOptions>` method.

   .. _OEConfGen_OEMolBuilder_Prep:

   .. oe:method:: Prep

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Prep(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            Prep(mol: OEMol) -> int

      Prepares molecules for 3D structure generation. Returns
      :oe:const:`OEConfGen::OEOmegaReturnCode::Success` if 
      the process succeeds, otherwise returns an error code from the
      :oe:constns:`OEConfGen::OEOmegaReturnCode` namespace. 

      A call to the :oe:meth:`OEConfGen::OEMolBuilder::Prep` is not required
      before calling :oe:meth:`OEConfGen::OEMolBuilder::Build`; however, it is useful
      in determining if some of the pre-conditions are met for building.

   .. _OEConfGen_OEMolBuilder_SetOptions:

   .. oe:method:: SetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOptions(const OEMolBuilderOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(argOpts: OEMolBuilderOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OEMolBuilderOptions>` for building the molecule's 3D structures.

   .. seealso::

      * :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEMolBuilderOptions, MolBuilderOptions

.. _OEConfGen_OEMolBuilderOptions:

.. oe:class:: OEMolBuilderOptions

   .. oe:api::

      class OEMolBuilderOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for generating
   an initial 3D structure of a molecule by connecting pregenerated fragment
   coordinates that constitute the molecule.

   .. seealso::

      * :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` class
      * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class

   The :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>` class defines the following public methods:
    * :oe:meth:`GetCanonOrder<OEConfGen::OEMolBuilderOptions::GetCanonOrder>` and
      :oe:meth:`SetCanonOrder<OEConfGen::OEMolBuilderOptions::SetCanonOrder>`
    * :oe:meth:`GetEnumNitrogen<OEConfGen::OEMolBuilderOptions::GetEnumNitrogen>` and
      :oe:meth:`SetEnumNitrogen<OEConfGen::OEMolBuilderOptions::SetEnumNitrogen>`
    * :oe:meth:`GetEnumRing<OEConfGen::OEMolBuilderOptions::GetEnumRing>` and
      :oe:meth:`SetEnumRing<OEConfGen::OEMolBuilderOptions::SetEnumRing>`
    * :oe:meth:`SetFragBuilderMode<OEConfGen::OEMolBuilderOptions::SetFragBuilderMode>`
    * :oe:meth:`GetFragBuilderOptions<OEConfGen::OEMolBuilderOptions::GetFragBuilderOptions>` and
      :oe:meth:`SetFragBuilderOptions<OEConfGen::OEMolBuilderOptions::SetFragBuilderOptions>`
    * :oe:meth:`GetFromCT<OEConfGen::OEMolBuilderOptions::GetFromCT>` and
      :oe:meth:`SetFromCT<OEConfGen::OEMolBuilderOptions::SetFromCT>`
    * :oe:meth:`GetIgnoreStereo<OEConfGen::OEMolBuilderOptions::GetIgnoreStereo>` and
      :oe:meth:`SetIgnoreStereo<OEConfGen::OEMolBuilderOptions::SetIgnoreStereo>`
    * :oe:meth:`GetMaxEnumConfs<OEConfGen::OEMolBuilderOptions::GetMaxEnumConfs>` and
      :oe:meth:`SetMaxEnumConfs<OEConfGen::OEMolBuilderOptions::SetMaxEnumConfs>`
    * :oe:meth:`GetSampleHydrogens<OEConfGen::OEMolBuilderOptions::GetSampleHydrogens>` and
      :oe:meth:`SetSampleHydrogens<OEConfGen::OEMolBuilderOptions::SetSampleHydrogens>`
    * :oe:meth:`GetStrictAtomTypes<OEConfGen::OEMolBuilderOptions::GetStrictAtomTypes>` and
      :oe:meth:`SetStrictAtomTypes<OEConfGen::OEMolBuilderOptions::SetStrictAtomTypes>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolBuilderOptions()
            OEMolBuilderOptions(const OEMolBuilderOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEMolBuilderOptions() -> OEMolBuilderOptions
            OEMolBuilderOptions(arg2: OEMolBuilderOptions) -> OEMolBuilderOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolBuilderOptions &operator=(const OEMolBuilderOptions &)

      Assignment operator.

   .. _OEConfGen_OEMolBuilderOptions_GetCanonOrder:

   .. oe:method:: GetCanonOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCanonOrder() const

      .. oe:language:: python

         .. oe:api:: python

            GetCanonOrder() -> bool

      See the :oe:meth:`SetCanonOrder<OEConfGen::OEMolBuilderOptions::SetCanonOrder>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetEnumNitrogen:

   .. oe:method:: GetEnumNitrogen

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetEnumNitrogen() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumNitrogen() -> int

      See the :oe:meth:`SetEnumNitrogen<OEConfGen::OEMolBuilderOptions::SetEnumNitrogen>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetEnumRing:

   .. oe:method:: GetEnumRing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEnumRing() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumRing() -> bool

      See the :oe:meth:`SetEnumRing<OEConfGen::OEMolBuilderOptions::SetEnumRing>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetFragBuilderOptions:

   .. oe:method:: GetFragBuilderOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFragBuilderOptions& GetFragBuilderOptions()
            const OEFragBuilderOptions& GetFragBuilderOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragBuilderOptions() -> OEFragBuilderOptions

      See the :oe:meth:`SetFragBuilderOptions<OEConfGen::OEMolBuilderOptions::SetFragBuilderOptions>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetFromCT:

   .. oe:method:: GetFromCT

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFromCT() const

      .. oe:language:: python

         .. oe:api:: python

            GetFromCT() -> bool

      See the :oe:meth:`SetFromCT<OEConfGen::OEMolBuilderOptions::SetFromCT>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetIgnoreStereo:

   .. oe:method:: GetIgnoreStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetIgnoreStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetIgnoreStereo() -> bool

      See the :oe:meth:`SetIgnoreStereo<OEConfGen::OEMolBuilderOptions::SetIgnoreStereo>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetMaxEnumConfs:

   .. oe:method:: GetMaxEnumConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxEnumConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxEnumConfs() -> int

      See the :oe:meth:`SetMaxEnumConfs<OEConfGen::OEMolBuilderOptions::SetMaxEnumConfs>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetSampleHydrogens:

   .. oe:method:: GetSampleHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSampleHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetSampleHydrogens() -> bool

      See the :oe:meth:`SetSampleHydrogens<OEConfGen::OEMolBuilderOptions::SetSampleHydrogens>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetStrictAtomTypes:

   .. oe:method:: GetStrictAtomTypes

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStrictAtomTypes() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrictAtomTypes() -> bool

      See the :oe:meth:`SetStrictAtomTypes<OEConfGen::OEMolBuilderOptions::SetStrictAtomTypes>` method.

   .. _OEConfGen_OEMolBuilderOptions_SetCanonOrder:

   .. oe:method:: SetCanonOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCanonOrder(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetCanonOrder(value: bool) -> bool

      This method can be used to enable/disable the
      automatic reordering of input molecules to a canonical atom and bond
      order.  In order to obtain consistent results from different file
      formats and different connection table orders, **OMEGA** reorders the
      input connection table.
      If *true*, the atoms of the molecule are indexed in canonical order before
      building the molecule structure.
      Default: True

   .. _OEConfGen_OEMolBuilderOptions_SetEnumNitrogen:

   .. oe:method:: SetEnumNitrogen

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnumNitrogen(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumNitrogen(value: int) -> bool

      Sets whether the generated initial conformation should be **enumerated for invertible nitrogens**.
      Default: :oe:const:`OEConfGen::OENitrogenEnumeration::Unspecified`

      .. seealso::

         * :oe:constns:`OEConfGen::OENitrogenEnumeration` namespace

   .. _OEConfGen_OEMolBuilderOptions_SetEnumRing:

   .. oe:method:: SetEnumRing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnumRing(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumRing(value: bool) -> bool

      Sets whether the generated initial conformation should be **enumerated for ring stereo**. If *true*, the
      builder will enumerate
      alternate ring conformations and generate multiple conformations, if available.
      Default: True

      .. _OEConfGen_OEMolBuilderOptions_SetFragBuilderMode:

   .. oe:method:: SetFragBuilderMode

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFragBuilderMode(const unsigned mode)

      .. oe:language:: python

         .. oe:api:: python

            SetFragBuilderMode(mode: int) -> bool

      Sets the :oe:cls:`OEFragBuilderOptions<OEConfGen::OEFragBuilderOptions>` parameter defaults corresponding to the specified ``mode``.

   .. _OEConfGen_OEMolBuilderOptions_SetFragBuilderOptions:

   .. oe:method:: SetFragBuilderOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFragBuilderOptions(const OEFragBuilderOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetFragBuilderOptions(opts: OEFragBuilderOptions) -> None

      Sets :oe:cls:`OEFragBuilderOptions<OEConfGen::OEFragBuilderOptions>` related to building fragment coordinates.

      .. seealso::

         * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class

   .. _OEConfGen_OEMolBuilderOptions_SetFromCT:

   .. oe:method:: SetFromCT

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFromCT(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetFromCT(value: bool) -> bool

      Sets whether the initial 3D coordinates should be generated from the
      **connection table of the input molecule**. If *true*, the initial 3D coordinates are
      generated from the connection table.
      Default: True

   .. _OEConfGen_OEMolBuilderOptions_SetIgnoreStereo:

   .. oe:method:: SetIgnoreStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIgnoreStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetIgnoreStereo(value: bool) -> bool

      Sets whether **conformer generation should continue** even when specified stereo 
      signatures in a molecule could not be honored.
      Default: False

   .. _OEConfGen_OEMolBuilderOptions_SetMaxEnumConfs:

   .. oe:method:: SetMaxEnumConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxEnumConfs(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxEnumConfs(value: int) -> bool

      Sets the **maximum number of conformers** to be generated
      during enumeration.
      Default: 1024

   ..   _OEConfGen_SetSampleHydrogens:

   .. oe:method:: SetSampleHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSampleHydrogens(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetSampleHydrogens(value: bool) -> bool

      Sets whether **hydrogen sampling** should be performed on
      generated structures. If *true*, hydrogen sampling is performed.
      Default: False

   .. _OEConfGen_OEMolBuilderOptions_SetStrictAtomTypes:

   .. oe:method:: SetStrictAtomTypes

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStrictAtomTypes(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetStrictAtomTypes(value: bool) -> bool

      Sets whether **strict definition of atom typing** should be used.
      If *true*, a molecule will fail if any atom does not have a valid atom type.
      Calling this method with *false* will allow the atom typer to look for a
      different atom type of the same element and replace the failing
      atom type with a valid one that is "close enough."
      Default: True


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmega, Omega

.. _OEConfGen_OEOmega:

.. oe:class:: OEOmega

   .. oe:api::

      class OEOmega

   This class defines an interface for generating ensembles of conformers
   of small molecules.

   .. seealso::

      * :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_simple_omega` example
      * :ref:`section_examples_dens_omega` example
      * :ref:`section_examples_stereo_and_torsion` example

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOmega( OEPlatform::oeistream* torlib = 0 );
            OEOmega(const OEOmegaOptions&)
            OEOmega(const OEOmega&)

      .. oe:language:: python

         .. oe:api:: python

            OEOmega(torlib: oeistream = None) -> OEOmega
            OEOmega(argOpts: OEOmegaOptions) -> OEOmega
            OEOmega(arg2: OEOmega) -> OEOmega

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOmega &operator=(const OEOmega&)

      Assignment operator.

   .. _OEConfGen_OEOmega_AddFragLib:

   .. oe:method:: AddFragLib

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddFragLib()
            void AddFragLib(const std::string &)
            void AddFragLib(OEPlatform::oeistream &)

      .. oe:language:: python

         .. oe:api:: python

            AddFragLib() -> None
            AddFragLib(arg2: str) -> None
            AddFragLib(arg2: oeistream) -> None

      The parameterless version will load the built-in fragment library immediately.
      By default, the built-in fragment library does not load until
      :oe:meth:`OEConfGen::OEOmega::Build` is called for the first time.

      The `string` and `oeistream` versions will add an external fragment library.
      This will be used in addition to the
      built-in fragment library. To use only this fragment library, call
      :oe:meth:`OEConfGen::OEOmega::ClearFragLibs` first.

      .. note::

         An enhanced fragment library, ``omega_fragment_lib_2020.oeb.gz``,
         that improves the performance of conformer
         generation is available on request from the `database downloads page
         <https://www.eyesopen.com/database-downloads>`_.

   .. _OEConfGen_OEOmega_Build:

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Build(OEChem::OEMCMolBase&) const

      .. oe:language:: python

         .. oe:api:: python

            Build(mol: OEMol) -> int

      Generates conformers for a molecule. Returns
      :oe:const:`OEConfGen::OEOmegaReturnCode::Success` if
      the process succeeds, otherwise returns an error code from the
      :oe:constns:`OEConfGen::OEOmegaReturnCode` namespace.

   .. _OEConfGen_OEOmega_ClearFragLibs:

   .. oe:method:: ClearFragLibs

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearFragLibs()

      .. oe:language:: python

         .. oe:api:: python

            ClearFragLibs() -> None

      Clears all fragment libraries from the :ref:`OEOmega <OEConfGen_OEOmega>` object.

   .. _OEConfGen_OEOmega_GetOptions:

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEOmegaOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEOmegaOptions

      Retrieves a constant reference to the :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>`
      instance as currently set.

   .. _OEConfGen_OEOmega_SetOptions:

   .. oe:method:: SetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOptions(const OEOmegaOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(argOpts: OEOmegaOptions) -> None

      Sets the structure generation options by passing in an
      :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` instance.


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmegaOptions, OmegaOptions

.. _OEConfGen_OEOmegaOptions:

.. oe:class:: OEOmegaOptions

   .. oe:api::

      class OEOmegaOptions : public OESystem::OEOptions

   .. seealso::

      * :ref:`OEOmega <OEConfGen_OEOmega>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_simple_omega` example
      * :ref:`section_examples_dens_omega` example
      * :ref:`section_examples_stereo_and_torsion` example

   There is a :ref:`list of suboption default values <OEConfGen_OEOmegaOptions_Defaults>` later in this section.

   The :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` class defines the following public methods:

    * :oe:meth:`GetConfFixOptions<OEConfGen::OEOmegaOptions::GetConfFixOptions>` and
      :oe:meth:`SetConfFixOptions<OEConfGen::OEOmegaOptions::SetConfFixOptions>`
    * :oe:meth:`GetEnergyWindow<OEConfGen::OEOmegaOptions::GetEnergyWindow>` and
      :oe:meth:`SetEnergyWindow<OEConfGen::OEOmegaOptions::SetEnergyWindow>`
    * :oe:meth:`GetIncludeInput<OEConfGen::OEOmegaOptions::GetIncludeInput>` and
      :oe:meth:`SetIncludeInput<OEConfGen::OEOmegaOptions::SetIncludeInput>`
    * :oe:meth:`GetMaxConfs<OEConfGen::OEOmegaOptions::GetMaxConfs>` and
      :oe:meth:`SetMaxConfs<OEConfGen::OEOmegaOptions::SetMaxConfs>`
    * :oe:meth:`GetMolBuilderOptions<OEConfGen::OEOmegaOptions::GetMolBuilderOptions>` and
      :oe:meth:`SetMolBuilderOptions<OEConfGen::OEOmegaOptions::SetMolBuilderOptions>`
    * :oe:meth:`GetSliceEnsembleOptions<OEConfGen::OEOmegaOptions::GetSliceEnsembleOptions>` and
      :oe:meth:`SetSliceEnsembleOptions<OEConfGen::OEOmegaOptions::SetSliceEnsembleOptions>`
    * :oe:meth:`GetStrictStereo<OEConfGen::OEOmegaOptions::GetStrictStereo>` and
      :oe:meth:`SetStrictStereo<OEConfGen::OEOmegaOptions::SetStrictStereo>`
    * :oe:meth:`GetTorDriveOptions<OEConfGen::OEOmegaOptions::GetTorDriveOptions>` and
      :oe:meth:`SetTorDriveOptions<OEConfGen::OEOmegaOptions::SetTorDriveOptions>`
    * :oe:meth:`GetTorsionDrive<OEConfGen::OEOmegaOptions::GetTorsionDrive>` and
      :oe:meth:`SetTorsionDrive<OEConfGen::OEOmegaOptions::SetTorsionDrive>`
    * :oe:meth:`GetWarts<OEConfGen::OEOmegaOptions::GetWarts>` and
      :oe:meth:`SetWarts<OEConfGen::OEOmegaOptions::SetWarts>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOmegaOptions(const unsigned int sampling = OEOmegaSampling::Classic)
            OEOmegaOptions(const OEOmegaOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEOmegaOptions(type: int) -> OEOmegaOptions
            OEOmegaOptions(arg2: OEOmegaOptions) -> OEOmegaOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOmegaOptions &operator=(const OEOmegaOptions &)

      Assignment operator.

   .. oe:method:: GetConfFixOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConfFixOptions& GetConfFixOptions()
            const OEConfFixOptions& GetConfFixOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfFixOptions() -> OEConfFixOptions

      See the :oe:meth:`SetConfFixOptions<OEConfGen::OEOmegaOptions::SetConfFixOptions>` method.

   .. oe:method:: GetEnergyWindow

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEnergyWindow() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnergyWindow() -> float

      See the :oe:meth:`SetEnergyWindow<OEConfGen::OEOmegaOptions::SetEnergyWindow>` method.

   .. oe:method:: GetIncludeInput

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetIncludeInput() const

      .. oe:language:: python

         .. oe:api:: python

            GetIncludeInput() -> bool

      See the :oe:meth:`SetIncludeInput<OEConfGen::OEOmegaOptions::SetIncludeInput>` method.

   .. oe:method:: GetMaxConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxConfs() -> int

      See the :oe:meth:`SetMaxConfs<OEConfGen::OEOmegaOptions::SetMaxConfs>` method.

   .. oe:method:: GetMolBuilderOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolBuilderOptions& GetMolBuilderOptions()
            const OEMolBuilderOptions& GetMolBuilderOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolBuilderOptions() -> OEMolBuilderOptions

      See the :oe:meth:`SetMolBuilderOptions<OEConfGen::OEOmegaOptions::SetMolBuilderOptions>` method.

   .. oe:method:: GetSliceEnsembleOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESliceEnsembleOptions& GetSliceEnsembleOptions()
            const OESliceEnsembleOptions& GetSliceEnsembleOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSliceEnsembleOptions() -> OESliceEnsembleOptions

      See the :oe:meth:`SetSliceEnsembleOptions<OEConfGen::OEOmegaOptions::SetSliceEnsembleOptions>` method.

   .. oe:method:: GetStrictStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStrictStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrictStereo() -> bool

      See the :oe:meth:`SetStrictStereo<OEConfGen::OEOmegaOptions::SetStrictStereo>` method.

   .. oe:method:: GetTorDriveOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorDriveOptions& GetTorDriveOptions()
            const OETorDriveOptions& GetTorDriveOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetTorDriveOptions() -> OETorDriveOptions

      See the :oe:meth:`SetTorDriveOptions<OEConfGen::OEOmegaOptions::SetTorDriveOptions>` method.

   .. oe:method:: GetTorsionDrive

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetTorsionDrive() const

      .. oe:language:: python

         .. oe:api:: python

            GetTorsionDrive() -> bool

      See the :oe:meth:`SetTorsionDrive<OEConfGen::OEOmegaOptions::SetTorsionDrive>` method.

   .. oe:method:: GetWarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetWarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetWarts() -> bool

      See the :oe:meth:`SetWarts<OEConfGen::OEOmegaOptions::SetWarts>` method.

   .. oe:method:: SetConfFixOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetConfFixOptions(const OEConfFixOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetConfFixOptions(opts: OEConfFixOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OEConfFixOptions>` related to partially fixing conformers.

      .. seealso::

         * :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>` class

   .. oe:method:: SetEnergyWindow

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnergyWindow(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetEnergyWindow(value: float) -> bool

      See the :oe:meth:`SetEnergyWindow<OEConfGen::OESliceEnsembleOptions::SetEnergyWindow>` method.
      Default: 10

   .. oe:method:: SetIncludeInput

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIncludeInput(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetIncludeInput(value: bool) -> bool

      Sets whether to pass the unmodified input structure into output conformer ensembles.
      If *true*, the input conformers are appended at the beginning of the generated conformer ensemble.
      Default: False

   .. oe:method:: SetMaxConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxConfs(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxConfs(value: int) -> bool

      See the :oe:meth:`SetMaxConfs<OEConfGen::OESliceEnsembleOptions::SetMaxConfs>` method.
      Default: 200

   .. oe:method:: SetMolBuilderOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMolBuilderOptions(const OEMolBuilderOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetMolBuilderOptions(opts: OEMolBuilderOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OEMolBuilderOptions>` related to generating initial conformers.

      .. seealso::

         * :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>` class

   .. oe:method:: SetSliceEnsembleOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSliceEnsembleOptions(const OESliceEnsembleOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetSliceEnsembleOptions(opts: OESliceEnsembleOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OESliceEnsembleOptions>` related to deduplicating generated ensembles.

      .. seealso::

         * :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` class

   .. oe:method:: SetStrictStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStrictStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetStrictStereo(value: bool) -> bool

      Sets whether conformer generation should fail if **stereo is not specified** on the input molecules.
      Default: True

   .. oe:method:: SetTorDriveOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTorDriveOptions(const OETorDriveOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetTorDriveOptions(opts: OETorDriveOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OETorDriveOptions>` related to torsion driving for conformer generation.

      .. seealso::

         * :ref:`OETorDriveOptions <OEConfGen_OETorDriveOptions>` class

   .. oe:method:: SetTorsionDrive

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTorsionDrive(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetTorsionDrive(value: bool) -> bool

      Sets whether to perform torsion driving. Default: True

   .. oe:method:: SetWarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetWarts(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetWarts(value: bool) -> bool

      Sets whether to generate unique titles for conformers. Default: False

.. _OEConfGen_OEOmegaOptions_Defaults:

..  oe:class:: Suboption Parameter Defaults

     Default values of the parameters from the suboption classes are compiled below.

     =======================================================================================   =============================================================
     parameter                                                                                 Default
     ---------------------------------------------------------------------------------------   -------------------------------------------------------------
     :oe:meth:`CanonOrder<OEConfGen::OEMolBuilderOptions::SetCanonOrder>`                      True

     :oe:meth:`EnumNitrogen<OEConfGen::OEMolBuilderOptions::SetEnumNitrogen>`                  :oe:const:`OEConfGen::OENitrogenEnumeration::Unspecified`

     :oe:meth:`EnumRing<OEConfGen::OEMolBuilderOptions::SetEnumRing>`                          True

     :oe:meth:`FromCT<OEConfGen::OEMolBuilderOptions::SetFromCT>`                              True

     :oe:meth:`IgnoreStereo<OEConfGen::OEMolBuilderOptions::SetIgnoreStereo>`                  False

     :oe:meth:`MaxEnumConfs<OEConfGen::OEMolBuilderOptions::SetMaxEnumConfs>`                  1024

     :oe:meth:`SampleHydrogens<OEConfGen::OEMolBuilderOptions::SetSampleHydrogens>`            False

     :oe:meth:`StrictAtomTypes<OEConfGen::OEMolBuilderOptions::SetStrictAtomTypes>`            True

     :oe:meth:`MaxTerminalHeavy<OEConfGen::OESliceEnsembleOptions::SetMaxTerminalHeavy>`       0

     :oe:meth:`RangeIncrement<OEConfGen::OESliceEnsembleOptions::SetRangeIncrement>`           5

     :oe:meth:`RMSThreshold<OEConfGen::OESliceEnsembleOptions::SetRMSThreshold>`               0.5

     :oe:meth:`CommentEnergy<OEConfGen::OETorDriveOptions::SetCommentEnergy>`                  False

     :oe:meth:`ForceField<OEConfGen::OETorDriveOptions::SetForceField>`                        :oe:const:`OEFF::OEMMFFSheffieldFFType::MMFF94Smod_NOESTAT`

     :oe:meth:`MaxRotors<OEConfGen::OETorDriveOptions::SetMaxRotors>`                          9999

     :oe:meth:`MaxSearchTime<OEConfGen::OETorDriveOptions::SetMaxSearchTime>`                  120.0 sec

     :oe:meth:`RotorOffset<OEConfGen::OETorDriveOptions::SetRotorOffset>`                      False

     :oe:meth:`SDEnergy<OEConfGen::OETorDriveOptions::SetSDEnergy>`                            False

     :oe:meth:`UseGPU<OEConfGen::OETorDriveOptions::SetUseGPU>`                                True
     =======================================================================================   =============================================================


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OERingFragOptions, RingFragOptions

.. _OEConfGen_OERingFragOptions:

.. oe:class:: OERingFragOptions

   .. oe:api::

      class OERingFragOptions : public OEFragOptions

   This class provides an interface to set up options required for generating
   coordinates for ring fragments.
   A fragment is a building block that is used for initial
   3D structure generation of molecules.

   .. seealso::

      * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class
   
   The following methods are publicly inherited from :ref:`OEFragOptions <OEConfGen_OEFragOptions>`:
    * :oe:meth:`GetEnergyWindow<OEConfGen::OEFragOptions::GetEnergyWindow>` and
      :oe:meth:`SetEnergyWindow<OEConfGen::OEFragOptions::SetEnergyWindow>`
    * :oe:meth:`GetFragGen<OEConfGen::OEFragOptions::GetFragGen>` and
      :oe:meth:`SetFragGen<OEConfGen::OEFragOptions::SetFragGen>`
    * :oe:meth:`GetFragKeep<OEConfGen::OEFragOptions::GetFragKeep>` and
      :oe:meth:`SetFragKeep<OEConfGen::OEFragOptions::SetFragKeep>`
    * :oe:meth:`GetRMS<OEConfGen::OEFragOptions::GetRMS>` and
      :oe:meth:`SetRMS<OEConfGen::OEFragOptions::SetRMS>`
    * :oe:meth:`GetTimeLimit<OEConfGen::OEFragOptions::GetTimeLimit>` and
      :oe:meth:`SetTimeLimit<OEConfGen::OEFragOptions::SetTimeLimit>`

   The :ref:`OERingFragOptions <OEConfGen_OERingFragOptions>` class defines the following public methods:
    * :oe:meth:`GetStartFactor<OEConfGen::OERingFragOptions::GetStartFactor>` and
      :oe:meth:`SetStartFactor<OEConfGen::OERingFragOptions::SetStartFactor>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERingFragOptions()
            OERingFragOptions(const OERingFragOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OERingFragOptions() -> OERingFragOptions
            OERingFragOptions(arg2: OERingFragOptions) -> OERingFragOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERingFragOptions &operator=(const OERingFragOptions &)

      Assignment operator.

   .. _OEConfGen_OERingFragOptions_GetStartFactor:

   .. oe:method:: GetStartFactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetStartFactor() const

      .. oe:language:: python

         .. oe:api:: python

            GetStartFactor() -> int

      See the :oe:meth:`SetStartFactor<OEConfGen::OERingFragOptions::SetStartFactor>` method.

   .. _OEConfGen_OERingFragOptions_SetStartFactor:

   .. oe:method:: SetStartFactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStartFactor(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetStartFactor(value: int) -> bool

      Sets a **multiplicative factor** that determines how many starts 
      are to be used for generating ring fragment coordinates.
      Default: 2


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OESliceEnsembleOptions, SliceEnsembleOptions

.. _OEConfGen_OESliceEnsembleOptions:

.. oe:class:: OESliceEnsembleOptions

   .. oe:api::

      class OESliceEnsembleOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for reducing a
   molecule conformer ensemble by removing duplicates and high energy conformers.

   The :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` allows multiple ways to set up
   the desired settings for each parameter for slicing an ensemble. There are
   three main control parameters: `EnergyWindow`, `RMSThreshold`, and `MaxConfs`.  The
   default usage is to use the same control settings for slicing all molecule ensembles.  
   However, for each of the three parameters, the parameter
   settings can be made a variable based on the number of rotatable bonds in the molecule.
   The variable settings can be applied by using the `range` based API points.

   This describes how to use the range based settings for `MaxConfs`, however, the
   same applies to `EnergyWindow` and `RMSThreshold`. A `MaxConfs` setting of
   *100,200,300* for :ref:`SetMaxConfRange<OEConfGen_OESliceEnsembleOptions_SetMaxConfRange>`
   along with a value of *5* for the `RangeIncrement` set with
   :ref:`SetRangeIncrement<OEConfGen_OESliceEnsembleOptions_SetRangeIncrement>` would
   use a `MaxConfs` value of *100* for a molecule with a number of rotatable bonds between 0 and 4,
   that of *200* for a molecule with a number of rotatable bonds between 5 and 9, and *300* for a molecule
   with a number of rotatable bonds of 10 or higher.

   .. seealso::

      * :ref:`OETorDriver <OEConfGen_OETorDriver>` class

   The :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` class defines the following public methods:
    * :oe:meth:`GetEnergyWindow<OEConfGen::OESliceEnsembleOptions::GetEnergyWindow>` and
      :oe:meth:`SetEnergyWindow<OEConfGen::OESliceEnsembleOptions::SetEnergyWindow>`
    * :oe:meth:`GetEnergyRange<OEConfGen::OESliceEnsembleOptions::GetEnergyRange>` and
      :oe:meth:`SetEnergyRange<OEConfGen::OESliceEnsembleOptions::SetEnergyRange>`
    * :oe:meth:`GetMaxConfs<OEConfGen::OESliceEnsembleOptions::GetMaxConfs>` and
      :oe:meth:`SetMaxConfs<OEConfGen::OESliceEnsembleOptions::SetMaxConfs>`
    * :oe:meth:`GetMaxConfRange<OEConfGen::OESliceEnsembleOptions::GetMaxConfRange>` and
      :oe:meth:`SetMaxConfRange<OEConfGen::OESliceEnsembleOptions::SetMaxConfRange>`
    * :oe:meth:`GetMaxTerminalHeavy<OEConfGen::OESliceEnsembleOptions::GetMaxTerminalHeavy>` and
      :oe:meth:`SetMaxTerminalHeavy<OEConfGen::OESliceEnsembleOptions::SetMaxTerminalHeavy>`
    * :oe:meth:`GetOverlayRMS<OEConfGen::OESliceEnsembleOptions::GetOverlayRMS>` and
      :oe:meth:`SetOverlayRMS<OEConfGen::OESliceEnsembleOptions::SetOverlayRMS>`
    * :oe:meth:`GetRangeIncrement<OEConfGen::OESliceEnsembleOptions::GetRangeIncrement>` and
      :oe:meth:`SetRangeIncrement<OEConfGen::OESliceEnsembleOptions::SetRangeIncrement>`
    * :oe:meth:`GetRMSThreshold<OEConfGen::OESliceEnsembleOptions::GetRMSThreshold>` and
      :oe:meth:`SetRMSThreshold<OEConfGen::OESliceEnsembleOptions::SetRMSThreshold>`
    * :oe:meth:`GetRMSRange<OEConfGen::OESliceEnsembleOptions::GetRMSRange>` and
      :oe:meth:`SetRMSRange<OEConfGen::OESliceEnsembleOptions::SetRMSRange>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESliceEnsembleOptions()
            OESliceEnsembleOptions(const OESliceEnsembleOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESliceEnsembleOptions() -> OESliceEnsembleOptions
            OESliceEnsembleOptions(arg2: OESliceEnsembleOptions) -> OESliceEnsembleOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESliceEnsembleOptions &operator=(const OESliceEnsembleOptions &)

      Assignment operator.

   .. _OEConfGen_OESliceEnsembleOptions_GetEnergyWindow:

   .. oe:method:: GetEnergyWindow

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEnergyWindow() const
            double GetEneWindow(const unsigned numRotors) const

      .. oe:language:: python

         .. oe:api:: python

            GetEnergyWindow() -> float

      See the :oe:meth:`SetEnergyWindow<OEConfGen::OESliceEnsembleOptions::SetEnergyWindow>` method.
      The second variation of the method returns the
      value of the energy window that is in effect for a given molecule with a specified
      number of rotors.

   .. _OEConfGen_OESliceEnsembleOptions_GetEnergyRange:

   .. oe:method:: GetEnergyRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<double> GetEnergyRange() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnergyRange() -> OEDoubleVector

      See the :oe:meth:`SetEnergyRange<OEConfGen::OESliceEnsembleOptions::SetEnergyRange>` method.

   .. _OEConfGen_OESliceEnsembleOptions_GetMaxConfs:

   .. oe:method:: GetMaxConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxConfs() const
            unsigned GetMaxConfs(const unsigned numRotors) const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxConfs() -> int
            GetMaxConfs(argNumRotors: int) -> int

      See the :oe:meth:`SetMaxConfs<OEConfGen::OESliceEnsembleOptions::SetMaxConfs>` method.
      The second variation of the method returns the
      value of the maximum conformers that is in effect for a given molecule with a specified
      number of rotors.

   .. _OEConfGen_OESliceEnsembleOptions_GetMaxConfRange:

   .. oe:method:: GetMaxConfRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<unsigned int> GetMaxConfRange() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxConfRange() -> OEUIntVector

      See the :oe:meth:`SetMaxConfRange<OEConfGen::OESliceEnsembleOptions::SetMaxConfRange>` method.

   .. _OEConfGen_OESliceEnsembleOptions_GetMaxTerminalHeavy:

   .. oe:method:: GetMaxTerminalHeavy

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxTerminalHeavy() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxTerminalHeavy() -> int

      See the :oe:meth:`SetMaxConfRange<OEConfGen::OESliceEnsembleOptions::SetMaxTerminalHeavy>` method.

   .. _OEConfGen_OESliceEnsembleOptions_GetOverlayRMS:

   .. oe:method:: GetOverlayRMS

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetOverlayRMS() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlayRMS() -> bool

      See the :oe:meth:`SetOverlayRMS<OEConfGen::OESliceEnsembleOptions::SetOverlayRMS>` method.

   .. _OEConfGen_OESliceEnsembleOptions_GetRangeIncrement:

   .. oe:method:: GetRangeIncrement

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRangeIncrement() const

      .. oe:language:: python

         .. oe:api:: python

            GetRangeIncrement() -> int

      See the :oe:meth:`SetRangeIncrement<OEConfGen::OESliceEnsembleOptions::SetRangeIncrement>` method.

   .. _OEConfGen_OESliceEnsembleOptions_GetRMSThreshold:

   .. oe:method:: GetRMSThreshold

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRMSThreshold() const
            double GetRMSCutoff(const unsigned numRotors) const

      .. oe:language:: python

         .. oe:api:: python

            GetRMSThreshold() -> float

      See the :oe:meth:`SetRMSThreshold<OEConfGen::OESliceEnsembleOptions::SetRMSThreshold>` method.
      The second variation of the method returns the
      value of RMS threshold that is in effect for a given molecule with the specified
      number of rotors.

   .. _OEConfGen_OESliceEnsembleOptions_GetRMSRange:

   .. oe:method:: GetRMSRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<double> GetRMSRange() const

      .. oe:language:: python

         .. oe:api:: python

            GetRMSRange() -> OEDoubleVector

      See the :oe:meth:`SetRMSRange<OEConfGen::OESliceEnsembleOptions::SetRMSRange>` method.

   .. _OEConfGen_OESliceEnsembleOptions_SetEnergyWindow:

   .. oe:method:: SetEnergyWindow

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetEnergyWindow(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetEnergyWindow(value: float) -> bool

      Sets the **maximum allowable energy** difference between the
      lowest and the highest energy conformers, in units of kcal/mol.
      Default: 10.0 kcal/mol

   .. _OEConfGen_OESliceEnsembleOptions_SetEnergyRange:

   .. oe:method:: SetEnergyRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnergyRange(const std::vector<double>&)
            bool SetEnergyRange(const std::string&)

      .. oe:language:: python

         .. oe:api:: python

            SetEnergyRange(value: OEDoubleVector) -> bool
            SetEnergyRange(value: str) -> bool

      Sets the **energy range** defines a varying
      :oe:meth:`EnergyWindow<OEConfGen::OESliceEnsembleOptions::SetEnergyWindow>` energy window in
      conjunction with the :oe:meth:`RangeIncrement<OEConfGen::OESliceEnsembleOptions::SetRangeIncrement>`.
      Defining the range overrides the singly defined energy window value. The string version of the 
      overload expects a comma-separated string.

   .. _OEConfGen_OESliceEnsembleOptions_SetMaxConfs:

   .. oe:method:: SetMaxConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxConfs(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxConfs(value: int) -> bool

      Sets the **maximum number of conformers** to be included in the output ensemble for each
      molecule. For molecules with few conformational degrees of freedom, the number of output conformers might
      be lower than the value set for this flag but will never exceed it.
      Default: 200

   .. _OEConfGen_OESliceEnsembleOptions_SetMaxConfRange:

   .. oe:method:: SetMaxConfRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxConfRange(const std::vector<unsigned>&)
            bool SetMaxConfRange(const std::string&)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxConfRange(value: OEUIntVector) -> bool
            SetMaxConfRange(value: str) -> bool

      Sets the **maximum number of conformers range** that defines a varying number of
      :oe:meth:`MaxConfs<OEConfGen::OESliceEnsembleOptions::SetMaxConfs>` in conjunction
      with the :oe:meth:`RangeIncrement<OEConfGen::OESliceEnsembleOptions::SetRangeIncrement>`.
      Defining the range overrides the singly defined `MaxConfs` value. The string version of the
      overload expects a comma-separated string.

   .. _OEConfGen_OESliceEnsembleOptions_SetMaxTerminalHeavy:

   .. oe:method:: SetMaxTerminalHeavy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxTerminalHeavy(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxTerminalHeavy(value: int) -> bool

      Sets the **maximum number of terminal heavy atoms** that should be allowed in 
      calculating *RMSD* between conformers.  If the number of terminal heavy atoms 
      in the molecule exceeds the specified limit, all terminal heavy atoms are ignored
      in the *RMSD* calculation.  If the number is set to *0*, this value is treated as not set.
      Default: 0

   .. _OEConfGen_OESliceEnsembleOptions_SetOverlayRMS:

   .. oe:method:: SetOverlayRMS

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOverlayRMS(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetOverlayRMS(value: bool) -> bool

      Sets flag indicating if **overlay should be performed for RMSD calculation** between conformers. 
      Default: True

   .. _OEConfGen_OESliceEnsembleOptions_SetRangeIncrement:

   .. oe:method:: SetRangeIncrement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRangeIncrement(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetRangeIncrement(value: int) -> bool

      Sets the **number of rotatable bonds range** to be
      used when the
      :oe:meth:`OEConfGen::OESliceEnsembleOptions::SetEnergyRange`,
      :oe:meth:`OEConfGen::OESliceEnsembleOptions::SetRMSRange`,
      and :oe:meth:`OEConfGen::OESliceEnsembleOptions::SetMaxConfRange` are defined in terms of
      ranges. Default: 5

   .. _OEConfGen_OESliceEnsembleOptions_SetRMSRange:

   .. oe:method:: SetRMSRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRMSRange(const std::vector<double>&)
            bool SetRMSRange(const std::string&)

      .. oe:language:: python

         .. oe:api:: python

            SetRMSRange(value: OEDoubleVector) -> bool
            SetRMSRange(value: str) -> bool

      Sets the **RMS range** that allows to define a varying
      :ref:`RMSThreshold<OEConfGen_OESliceEnsembleOptions_SetRMSThreshold>` in conjunction
      with the :ref:`RangeIncrement<OEConfGen_OESliceEnsembleOptions_SetRangeIncrement>`.
      Defining the range overrides the singly defined RMS threshold value. The string version of the
      overload expects a comma-separated string.

   .. _OEConfGen_OESliceEnsembleOptions_SetRMSThreshold:

   .. oe:method:: SetRMSThreshold

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRMSThreshold(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetRMSThreshold(value: float) -> bool

      Sets the **RMS threshold** (Root Mean Square Cartesian distance)
      below which two conformers are treated as duplicates.
      Default: 0.5


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OETorDriveOptions, TorDriveOptions

.. _OEConfGen_OETorDriveOptions:

.. oe:class:: OETorDriveOptions

   .. oe:api::

      class OETorDriveOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for generating an
   ensemble of molecule conformers by torsion driving from
   an initial 3D structure of a molecule.

   .. seealso::

      * :ref:`OETorDriver <OEConfGen_OETorDriver>` class
      * :ref:`OETorLib <OEConfGen_OETorLib>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_torsion_drive` example

   The :ref:`OETorDriveOptions <OEConfGen_OETorDriveOptions>` class defines the following public methods:

    * :ref:`ExceedsMaxRotors<OEConfGen_OETorDriveOptions_ExceedsMaxRotors>`
    * :ref:`GetCommentEnergy<OEConfGen_OETorDriveOptions_GetCommentEnergy>` and
      :ref:`SetCommentEnergy<OEConfGen_OETorDriveOptions_SetCommentEnergy>`
    * :ref:`GetForceField<OEConfGen_OETorDriveOptions_GetForceField>` and
      :ref:`SetForceField<OEConfGen_OETorDriveOptions_SetForceField>`
    * :ref:`GetMaxRotors<OEConfGen_OETorDriveOptions_GetMaxRotors>` and
      :ref:`SetMaxRotors<OEConfGen_OETorDriveOptions_SetMaxRotors>`
    * :ref:`GetMaxSearchTime<OEConfGen_OETorDriveOptions_GetMaxSearchTime>` and
      :ref:`SetMaxSearchTime<OEConfGen_OETorDriveOptions_SetMaxSearchTime>`
    * :ref:`GetRotorOffset<OEConfGen_OETorDriveOptions_GetRotorOffset>` and
      :ref:`SetRotorOffset<OEConfGen_OETorDriveOptions_SetRotorOffset>`
    * :ref:`GetRotorPredicate<OEConfGen_OETorDriveOptions_GetRotorPredicate>` and
      :ref:`SetRotorPredicate<OEConfGen_OETorDriveOptions_SetRotorPredicate>`
    * :ref:`GetSDEnergy<OEConfGen_OETorDriveOptions_GetSDEnergy>` and
      :ref:`SetSDEnergy<OEConfGen_OETorDriveOptions_SetSDEnergy>`
    * :ref:`GetThompsonOptions<OEConfGen_OETorDriveOptions_GetThompsonOptions>` and
      :ref:`SetThompsonOptions<OEConfGen_OETorDriveOptions_SetThompsonOptions>`
    * :ref:`GetTorLib<OEConfGen_OETorDriveOptions_GetTorLib>` and
      :ref:`SetTorLib<OEConfGen_OETorDriveOptions_SetTorLib>`
    * :ref:`GetUseGPU<OEConfGen_OETorDriveOptions_GetUseGPU>` and
      :ref:`SetUseGPU<OEConfGen_OETorDriveOptions_SetUseGPU>`
    * :ref:`GetUseThompson<OEConfGen_OETorDriveOptions_GetUseThompson>` and
      :ref:`SetUseThompson<OEConfGen_OETorDriveOptions_SetUseThompson>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorDriveOptions()
            OETorDriveOptions(const OETorDriveOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OETorDriveOptions() -> OETorDriveOptions
            OETorDriveOptions(arg2: OETorDriveOptions) -> OETorDriveOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETorDriveOptions &operator=(const OETorDriveOptions &)
         Assignment operator.

   .. _OEConfGen_OETorDriveOptions_ExceedsMaxRotors:

   .. oe:method:: ExceedsMaxRotors

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ExceedsMaxRotors(const OEChem::OEMolBase&) const

      .. oe:language:: python

         .. oe:api:: python

            ExceedsMaxRotors(argMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This method checks if the number of rotors in the molecule is within the
      currently specified limit. 
      See the :ref:`SetMaxRotors<OEConfGen_OETorDriveOptions_SetMaxRotors>` method.

   .. _OEConfGen_OETorDriveOptions_GetCommentEnergy:

   .. oe:method:: GetCommentEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCommentEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetCommentEnergy() -> bool

      See the :ref:`SetCommentEnergy<OEConfGen_OETorDriveOptions_SetCommentEnergy>` method.

   .. _OEConfGen_OETorDriveOptions_GetForceField:

   .. oe:method:: GetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEForceField

      See the :ref:`SetForceField<OEConfGen_OETorDriveOptions_SetForceField>` method.

   .. _OEConfGen_OETorDriveOptions_GetMaxRotors:

   .. oe:method:: GetMaxRotors

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxRotors() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxRotors() -> int

      See the :ref:`SetMaxRotors<OEConfGen_OETorDriveOptions_SetMaxRotors>` method.

   .. _OEConfGen_OETorDriveOptions_GetMaxSearchTime:

   .. oe:method:: GetMaxSearchTime

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMaxSearchTime() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSearchTime() -> float

      See the :ref:`SetMaxSearchTime<OEConfGen_OETorDriveOptions_SetMaxSearchTime>` method.

   .. _OEConfGen_OETorDriveOptions_GetRotorOffset:

   .. oe:method:: GetRotorOffset

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRotorOffset() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotorOffset() -> bool

      See the :ref:`SetRotorOffset<OEConfGen_OETorDriveOptions_SetRotorOffset>` method.

   .. _OEConfGen_OETorDriveOptions_GetRotorPredicate:

   .. oe:method:: GetRotorPredicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEBondBase>* GetRotorPredicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotorPredicate() -> OEUnaryBondPred

      See the :ref:`SetRotorPredicate<OEConfGen_OETorDriveOptions_SetRotorPredicate>` method.

   .. _OEConfGen_OETorDriveOptions_GetSDEnergy:

   .. oe:method:: GetSDEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSDEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetSDEnergy() -> bool

      See the :ref:`SetSDEnergy<OEConfGen_OETorDriveOptions_SetSDEnergy>` method.

   .. _OEConfGen_OETorDriveOptions_GetTorLib:

   .. oe:method:: GetTorLib

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OETorLib* GetTorLib() const

      .. oe:language:: python

         .. oe:api:: python

            GetTorLib() -> OETorLib

      See the :ref:`SetTorLib<OEConfGen_oetordriveoptions_SetTorLib>` method.

   .. _OEConfGen_OETorDriveOptions_GetUseGPU:

   .. oe:method:: GetUseGPU

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseGPU() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseGPU() -> bool

      See the :ref:`SetUseGPU<OEConfGen_oetordriveoptions_SetUseGPU>` method.

   .. _OEConfGen_OETorDriveOptions_GetUseThompson:

   .. oe:method:: GetUseThompson

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseThompson() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseThompson() -> bool

      See the :ref:`SetUseThompson<OEConfGen_oetordriveoptions_SetUseThompson>` method.

   .. _OEConfGen_OETorDriveOptions_SetCommentEnergy:

   .. oe:method:: SetCommentEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCommentEnergy(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetCommentEnergy(value: bool) -> bool

      Sets whether to add **conformer energy** in kcal/mol into the comments
      that appear if the output is written to a MOL2 file.
      If *true*, the comment energy is written.
      Default: False

   .. _OEConfGen_OETorDriveOptions_SetForceField:

   .. oe:method:: SetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceField(const unsigned)
            bool SetForceField(const std::string&)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: int) -> bool
            SetForceField(value: str) -> bool
            SetForceField(value: oeistream) -> bool
            SetForceField(value: OEForceField) -> bool

      Sets the **force field** used for torsion driving. The first overload takes an `unsigned` 
      from the :ref:`OEMMFFSheffieldFFType <OEFF_OEMMFFSheffieldFFType>` constant namespace, and the second overload
      takes corresponding string values. The method returns *false* when the invalid selection
      is chosen and *true* otherwise.
      Default: :ref:`MMFF94Smod_NOESTAT <OEFF_OEMMFFSheffieldFFType_MMFF94Smod_NOESTAT>`

   .. _OEConfGen_OETorDriveOptions_SetMaxRotors:

   .. oe:method:: SetMaxRotors

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxRotors(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxRotors(value: int) -> bool

      Sets the **limit of molecules with maximum number of rotors**
      that would be handled by torsion driving. If a value of 9999 or higher is
      defined, this limit is ignored.
      Default: 9999

   .. _OEConfGen_OETorDriveOptions_SetMaxSearchTime:

   .. oe:method:: SetMaxSearchTime

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxSearchTime(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxSearchTime(value: float) -> bool

      Sets the **maximum time** that should be spent for the torsion
      driving of a molecule, in units of seconds.
      Default: 120.0 sec

   .. _OEConfGen_OETorDriveOptions_SetRotorOffset:
   
   .. oe:method:: SetRotorOffset

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRotorOffset(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRotorOffset(value: bool) -> bool

      Sets whether the **rotor offset compression** should be turned on.
      Turning on the rotor offset compression reduces the space required when
      saved in an OEB file.
      Default: False

   .. _OEConfGen_OETorDriveOptions_SetRotorPredicate:

   .. oe:method:: SetRotorPredicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRotorPredicate(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>&)

      .. oe:language:: python

         .. oe:api:: python

            SetRotorPredicate(value: OEUnaryBondPred) -> bool

      Sets the **predicate** that is used to decide whether a bond is
      *rotatable*.

   .. _OEConfGen_OETorDriveOptions_SetSDEnergy:

   .. oe:method:: SetSDEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSDEnergy(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetSDEnergy(value: bool) -> bool

      Sets whether the **conformer energy** in kcal/mol should be stored as SD data.
      Default: False

   .. _OEConfGen_OETorDriveOptions_SetTorLib:

   .. oe:method:: SetTorLib

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTorLib(const unsigned)
            bool SetTorLib(const std::string&)
            bool SetTorLib(const OETorLib&)

      .. oe:language:: python

         .. oe:api:: python

            SetTorLib(value: int) -> bool
            SetTorLib(value: str) -> bool
            SetTorLib(value: oeistream) -> bool
            SetTorLib(value: OETorLib) -> bool

      Sets the **torsion library** that is used for torsion driving.  The first overload
      takes an `unsigned` from the :ref:`OETorLibType <OEConfGen_OETorLibType>` constant namespace, and
      the second overload takes the corresponding string values.
      Default: :ref:`Original <OEConfGen_OETorLibType_Original>`

      .. seealso::

         * :ref:`OETorLib <OEConfGen_OETorLib>` class.
         * :ref:`OETorLibType <OEConfGen_OETorLibType>` constant namespace.

   .. _OEConfGen_OETorDriveOptions_SetUseGPU:

   .. oe:method:: SetUseGPU

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseGPU(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseGPU(value: bool) -> bool

      Sets whether to use the GPU implementation for torsion driving (**GPU-Omega**).
      The default is *true*, however, if no GPU is detected on your system, **Omega** will fall
      back to the CPU implementation. **GPU-Omega** is only available with the default
      force field :ref:`MMFF94Smod_NOESTAT <OEFF_OEMMFFSheffieldFFType_MMFF94Smod_NOESTAT>`.

   .. _OEConfGen_OETorDriveOptions_SetUseThompson:

   .. oe:method:: SetUseThompson

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseThompson(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseThompson(value: bool) -> bool

      Sets whether to use Thompson sampling for exploring the conformer space.
      The default is *false*, that is, **Omega** will use exhaustive sampling by default.
      If switched Thompson sampling is used, the parameters can be controlled by the
      :ref:`Thompson Options <OEConfGen_OEThompsonOptions>` class.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OETorDriver, TorDriver

.. _OEConfGen_OETorDriver:

.. oe:class:: OETorDriver

   .. oe:api::

      class OETorDriver

   This class defines an interface for generating conformer ensembles
   of molecules by torsion driving on the provided 3D structures of the
   molecules.

   .. seealso::

      * :ref:`OETorDriveOptions <OEConfGen_OETorDriveOptions>` class
      * :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` class
      * :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_torsion_drive` example

   The :ref:`OETorDriver <OEConfGen_OETorDriver>` class defines the following public methods:
    * :oe:meth:`GenerateConfs<OEConfGen::OETorDriver::GenerateConfs>`
    * :oe:meth:`GetForceField<OEConfGen::OETorDriver::GetForceField>` and
      :oe:meth:`SetForceField<OEConfGen::OETorDriver::SetForceField>`
    * :oe:meth:`GetSliceEnsembleOptions<OEConfGen::OETorDriver::GetSliceEnsembleOptions>` and
      :oe:meth:`SetSliceEnsembleOptions<OEConfGen::OETorDriver::SetSliceEnsembleOptions>`
    * :oe:meth:`GetTorDriveOptions<OEConfGen::OETorDriver::GetTorDriveOptions>` and
      :oe:meth:`SetTorDriveOptions<OEConfGen::OETorDriver::SetTorDriveOptions>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorDriver(const OETorDriveOptions& argTorOpts = OETorDriveOptions(),
                        const OESliceEnsembleOptions& argSlicerOpts = OESliceEnsembleOptions())
            OETorDriver(const OETorDriver&)

      .. oe:language:: python

         .. oe:api:: python

            OETorDriver(argTorOpts: OETorDriveOptions = OETorDriveOptions(),
                        argSlicerOpts: OESliceEnsembleOptions = OESliceEnsembleOptions()) -> OETorDriver
            OETorDriver(rhs: OETorDriver) -> OETorDriver

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETorDriver &operator=(const OETorDriver&)

      Assignment operator.

   .. oe:method:: GenerateConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GenerateConfs(OEChem::OEMCMolBase&,
                                   const OEConfFixOptions& = OEConfFixOptions()) const

      .. oe:language:: python

         .. oe:api:: python

            GenerateConfs(argMol: OEMol,
                          argOpts: OEConfFixOptions = OEConfFixOptions()) -> int

      Generates a conformer ensemble for a molecule. Returns
      :oe:const:`OEConfGen::OEOmegaReturnCode::Success` if 
      the process succeeds, otherwise returns an error code from the
      :oe:constns:`OEConfGen::OEOmegaReturnCode` namespace. The second 
      argument provided with appropriate options can be
      used to fix part of a molecule structure to predefined coordinates.

      .. seealso::

         * :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>` class

   .. oe:method:: GetForceField

      .. oe:api::

         const OEMolPotential::OEForceField& GetForceField() const

      See the :oe:meth:`SetForceField<OEConfGen::OETorDriver::SetForceField>` method.

   .. oe:method:: GetSliceEnsembleOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESliceEnsembleOptions& GetSliceEnsembleOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSliceEnsembleOptions() -> OESliceEnsembleOptions

      See the :oe:meth:`SetSliceEnsembleOptions<OEConfGen::OETorDriver::SetSliceEnsembleOptions>` method.

   .. oe:method:: GetTorDriveOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OETorDriveOptions& GetTorDriveOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetTorDriveOptions() -> OETorDriveOptions

      See the :oe:meth:`SetTorDriveOptions<OEConfGen::OETorDriver::SetTorDriveOptions>`.

   .. oe:method:: SetForceField

      .. oe:api::

         void SetForceField(OEMolPotential::OEForceField&)

      Sets the **force field** for torsion driving.
      Default: :ref:`OEMMFFSheffield <OEFF_OEMMFFSheffield>` with
      :oe:const:`OEFF::OEMMFFSheffieldFFType::MMFF94Smod_NOESTAT`

      .. seealso::

         * :ref:`OEForceField <OEMolPotential_OEForceField>` class
         * :ref:`OEMMFFSheffield <OEFF_OEMMFFSheffield>`

   .. oe:method:: SetSliceEnsembleOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSliceEnsembleOptions(const OESliceEnsembleOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetSliceEnsembleOptions(argOpts: OESliceEnsembleOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OESliceEnsembleOptions>` for slicing
      ensemble to remove duplicates.

      .. seealso::

         * :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` class

   .. oe:method:: SetTorDriveOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTorDriveOptions(const OETorDriveOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetTorDriveOptions(argOpts: OETorDriveOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OETorDriveOptions>` for torsion driving.

      .. seealso::

         * :ref:`OETorDriveOptions <OEConfGen_OETorDriveOptions>` class


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OETorLib, TorLib

.. _OEConfGen_OETorLib:

.. oe:class:: OETorLib

   .. oe:api::

      class OETorLib

   Stores and manages torsion libraries used during conformer generation.
   Torsion rules can be loaded from files or added as SMARTS-based rule strings,
   and are consulted by :ref:`OETorDriver <OEConfGen_OETorDriver>` when sampling
   rotatable-bond dihedral angles.

   .. seealso::

      * :ref:`OETorDriveOptions <OEConfGen_OETorDriveOptions>` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorLib(const unsigned type = OETorLibType::Default)

      .. oe:language:: python

         .. oe:api:: python

            OETorLib(type: int) -> OETorLib
            OETorLib(arg2: OETorLib) -> OETorLib

      Default and copy constructors.  The constructor with the type
      parameter allows the user to set the torsion library type from values
      in the :oe:constns:`OEConfGen::OETorLibType` namespace.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETorLib & operator=(const OETorLib &)

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns *false* if the :ref:`OETorLib <OEConfGen_OETorLib>` object is empty,
      otherwise returns *true*.

   .. _OEConfGen_OETorLib_AddTorsionLibrary:

   .. oe:method:: AddTorsionLibrary

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddTorsionLibrary(const std::string &)
            bool AddTorsionLibrary(OEPlatform::oeistream &)

      .. oe:language:: python

         .. oe:api:: python

            AddTorsionLibrary(arg2: str) -> bool
            AddTorsionLibrary(arg2: oeistream) -> bool

      Takes a ``string`` or an :ref:`oeistream <OEPlatform_oeistream>` object to add a torsion
      library.  This will put the new torsion library above the
      current torsion library, which means that they will be checked
      first for a match.  To replace the torsion library, call
      :oe:meth:`OEConfGen::OETorLib::SetTorsionLibrary`. The method returns
      *true* if the library is added successfully.

   .. _OEConfGen_AddTorsionRule:

   .. oe:method:: AddTorsionRule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddTorsionRule(const std::string &)

      .. oe:language:: python

         .. oe:api:: python

            AddTorsionRule(arg2: str) -> bool

      Adds a single torsion rule as a string. The format for
      rules is a SMARTS pattern followed by the torsion angles. The method returns
      *true* if the rule is added successfully. The
      following is an example of a general rule::

         [*:1][CH2:2][a:3][a:4] 0 180 90 -90 45 -45 135 -135

      The following code demonstrates how to add a new torsion
      rule to an existing :ref:`OEOmega <OEConfGen_OEOmega>` object named ``omega``.

      .. oe:source:: AddTorsionRule.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-AddTorsionRule-string
         :caption:  Example of adding a new torsion rule

      .. oe:source:: AddTorsionRule.py
         :language: python
         :noindent:
         :frag:     SNIPPET-AddTorsionRule-string
         :caption:  Example of adding a new torsion rule.

      .. oe:language:: python

      :ref:`See the appendix for a full listing. <listing-AddTorsionRule.py>`

      .. oe:source:: AddTorsionRule.java
         :language: java
         :noindent:
         :frag:     SNIPPET-AddTorsionRule-string
         :caption:  Example of adding a new torsion rule

      .. oe:source:: AddTorsionRule.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-AddTorsionRule-string
         :caption:  Example of adding a new torsion rule

      The new rule will take precedence over all rules previously
      added to this object either from a file or from calling this method.

         .. oe:api::

            bool AddTorsionRule(OEChem::OEQMolBase &qmol,
                                std::vector<int> &degrees)

      The next signature of ``AddTorsionRule`` takes a generic
      :ref:`OEQMolBase <OEChem_OEQMolBase>` with a corresponding
      ``std::vector<int>`` containing the angles. The pattern
      represented by :ref:`OEQMolBase <OEChem_OEQMolBase>` should have map
      indices set on the atoms considered in the torsion. In
      :term:`SMARTS`, this means the atoms should have map indices
      numbered from 1 to 4. This can theoretically allow torsion rules to
      be written in other query file formats provided there is a
      method for setting the appropriate map indices. The following
      code demonstrates how to initialize an
      :ref:`OEQMolBase <OEChem_OEQMolBase>` and use it to define a new torsion rule.

      .. oe:source:: AddTorsionRule.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-AddTorsionRule-OEQMol
         :caption:  Example of adding a new torsion rule from a query molecule

      .. oe:source:: AddTorsionRule.py
         :language: python
         :noindent:
         :frag:     SNIPPET-AddTorsionRule-OEQMol
         :caption:  Example of adding a new torsion rule from a query molecule

      .. oe:language:: python

      :ref:`See the appendix for a full listing. <listing-AddTorsionRule.py>`

      .. oe:source:: AddTorsionRule.java
         :language: java
         :noindent:
         :frag:     SNIPPET-AddTorsionRule-OEQMol
         :caption:  Example of adding a new torsion rule from a query molecule

      .. oe:source:: AddTorsionRule.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-AddTorsionRule-OEQMol
         :caption:  Example of adding a new torsion rule from a query molecule

   .. _OEConfGen_OETorLib_ClearTorsionLibrary:

   .. oe:method:: ClearTorsionLibrary

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearTorsionLibrary()

      .. oe:language:: python

         .. oe:api:: python

            ClearTorsionLibrary() -> None

      Clears the current torsion library.  **Omega** cannot operate with
      an empty torsion library, so a new torsion library must be set
      before running **Omega**.

   .. _OEConfGen_OETorLib_GetTorRule:

   .. oe:method:: GetTorRule

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OESubSearch* GetTorRule(const OEChem::OEMolBase&,
                                                  const OEChem::OEBondBase&) const

      .. oe:language:: python

         .. oe:api:: python

            GetTorRule(mol: Union[OEGraphMol,OEMol,OEQMol], bond: OEBondBase) -> OESubSearch

      Returns the torsion rule associated with the specified bond of
      the specified molecule. The method returns a null pointer if a
      torsion rule is not found.
      The rules are stored as :ref:`OESubSearch <OEChem_OESubSearch>` objects.

   .. seealso::

         * :oe:func:`OEConfGen::OEGetTorValues` function.

   .. _OEConfGen_OETorLib_GetTorRules:

   .. oe:method:: GetTorRules

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OESubSearch>* GetTorRules()

      .. oe:language:: python

         .. oe:api:: python

            GetTorRules() -> Iterable[OESubSearch]

      Returns an iterator over the torsion rules.
      The rules are stored as :ref:`OESubSearch <OEChem_OESubSearch>` objects.

   .. _OEConfGen_OETorLib_HasTorRule:

   .. oe:method:: HasTorRule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasTorRule(const OEChem::OEMolBase&, const OEChem::OEBondBase&) const

      .. oe:language:: python

         .. oe:api:: python

            HasTorRule(mol: Union[OEGraphMol,OEMol,OEQMol], bond: OEBondBase) -> bool

      Checks if a torsion rule exists with the specified bond of
      the specified molecule. Returns *true* if a rule exists.

   .. _OEConfGen_OETorLib_ResetTorsionLibrary:

   .. oe:method:: ResetTorsionLibrary

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ResetTorsionLibrary()

      .. oe:language:: python

         .. oe:api:: python

            ResetTorsionLibrary() -> bool

      Resets the torsion library stored internally by **Omega**. The method returns
      *true* if the library is reset successfully.

   .. _OEConfGen_OETorLib_SetTorsionLibrary:

   .. oe:method:: SetTorsionLibrary

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTorsionLibrary(const std::string &)
            bool SetTorsionLibrary(OEPlatform::oeistream &)
            bool SetTorsionLibrary(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetTorsionLibrary(type: int) -> bool
            SetTorsionLibrary(arg2: str) -> bool
            SetTorsionLibrary(arg2: oeistream) -> bool

      Replaces the current torsion library with the one passed in as an
      argument.  If the argument is a type, it is expected to be a value
      in the :oe:constns:`OEConfGen::OETorLibType` namespace. The method returns
      *true* if the library is set successfully.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OETorLibParameter, TorLibParameter

.. _OEConfGen_OETorLibParameter:

.. oe:class:: OETorLibParameter

   .. oe:api::

      class OETorLibParameter : public OESystem::OEMultiParameter<OEConfGen::OETorLib>

   The :ref:`OETorLibParameter <OEConfGen_OETorLibParameter>` represents a parameter that has a value of type
   :ref:`OETorLib <OEConfGen_OETorLib>`.

   The following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   The following methods are publicly inherited from :ref:`OEMultiParameter <OESystem_OEMultiParameter>`:
    * :oe:meth:`AddLegalEntry<OESystem::OEMultiParameter::AddLegalEntry>` 
    * :oe:meth:`GetDefault<OESystem::OEMultiParameter::GetDefault>` and
      :oe:meth:`SetDefault<OESystem::OEMultiParameter::SetDefault>` 
    * :oe:meth:`GetSetting<OESystem::OEMultiParameter::GetSetting>`
    * :oe:meth:`GetValue<OESystem::OEMultiParameter::GetValue>` and
      :oe:meth:`SetValue<OESystem::OEMultiParameter::SetValue>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorLibParameter()
            OETorLibParameter(const OETorLibParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OETorLibParameter() -> OETorLibParameter
            OETorLibParameter(arg2: OETorLibParameter) -> OETorLibParameter

      Default and copy constructors.

      Constructs an :ref:`OETorLibParameter <OEConfGen_OETorLibParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETorLibParameter &operator=(const OETorLibParameter &)

      The assignment operator.

      Assignment operator.



.. _OEConfGenConstants:

OEConfGen Constants
===================

.. oe:namespace:: OEConfGen

.. toctree::

   OEFragBuilderMode
   OENitrogenEnumeration
   OEOmegaForceFieldType
   OEOmegaReturnCode
   OEOmegaSampling
   OESliceEnsembleDefaults
   OETorLibType


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

.. oe:constnamespace:: OEFragBuilderMode

   This namespace contains constants that are used with
   :oe:meth:`OEConfGen::OEFragBuilderOptions` to control the
   defaults to be set for fragment building options. Different sets of default options
   prepare the FragBuilder to generate structures that are suitable for different
   uses.

   .. oe:constant:: Default

      Same as :oe:const:`OEConfGen::OEFragBuilderMode::Fast`.

   .. oe:constant:: Dense

      Options suitable for building fragments with the
      :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` in the :oe:const:`OEConfGen::OEOmegaSampling::Dense`
      mode.

      ====================================================================  ========  ====  ==========
      Option                                                                Non-Ring  Ring  Macrocycle
      --------------------------------------------------------------------  --------  ----  ----------
      :oe:meth:`EnergyWindow<OEConfGen::OEFragOptions::SetEnergyWindow>`    15.0      15.0  25.0

      :oe:meth:`FragGen<OEConfGen::OEFragOptions::SetFragGen>`              40        1024  2000

      :oe:meth:`FragKeep<OEConfGen::OEFragOptions::SetFragKeep>`            1         1024  1024

      :oe:meth:`RMS<OEConfGen::OEFragOptions::SetRMS>`                      0.05      0.05  0.1

      :oe:meth:`TimeLimit<OEConfGen::OEFragOptions::SetTimeLimit>`          3600      3600  1800

      :oe:meth:`StartFactor<OEConfGen::OERingFragOptions::SetStartFactor>`  X         100   X
      ====================================================================  ========  ====  ==========

   .. oe:constant:: Fast
   
      Options suitable for fast, on-the-fly building of fragments during molecule building 
      with the :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>`.

      ====================================================================  ========  ====  ==========
      Option                                                                Non-Ring  Ring  Macrocycle
      --------------------------------------------------------------------  --------  ----  ----------
      :oe:meth:`EnergyWindow<OEConfGen::OEFragOptions::SetEnergyWindow>`    8.0       8.0   25.0

      :oe:meth:`FragGen<OEConfGen::OEFragOptions::SetFragGen>`              40        1024  2000

      :oe:meth:`FragKeep<OEConfGen::OEFragOptions::SetFragKeep>`            1         1024  1024

      :oe:meth:`RMS<OEConfGen::OEFragOptions::SetRMS>`                      0.1       0.1   0.1

      :oe:meth:`TimeLimit<OEConfGen::OEFragOptions::SetTimeLimit>`          400       400   1800

      :oe:meth:`StartFactor<OEConfGen::OERingFragOptions::SetStartFactor>`  X         2     X
      ====================================================================  ========  ====  ========== 

   .. oe:constant:: Strict
   
      Options suitable for rigorous fragment structure generation, suitable for building a
      fragment library with the :ref:`OEMakeFragLib <OEConfGen_OEMakeFragLib>`.

      ====================================================================  ========  =====  ==========
      Option                                                                Non-Ring  Ring   Macrocycle
      --------------------------------------------------------------------  --------  -----  ----------
      :oe:meth:`EnergyWindow<OEConfGen::OEFragOptions::SetEnergyWindow>`    4.0       4.0    25.0

      :oe:meth:`FragGen<OEConfGen::OEFragOptions::SetFragGen>`              40        50000  2000

      :oe:meth:`FragKeep<OEConfGen::OEFragOptions::SetFragKeep>`            1         1024   1024

      :oe:meth:`RMS<OEConfGen::OEFragOptions::SetRMS>`                      0.1       0.1    0.1

      :oe:meth:`TimeLimit<OEConfGen::OEFragOptions::SetTimeLimit>`          400       400    1800

      :oe:meth:`StartFactor<OEConfGen::OERingFragOptions::SetStartFactor>`  X         20     X
      ====================================================================  ========  =====  ========== 


.. oe:namespace:: OEConfGen

.. oe:constnamespace:: OENitrogenEnumeration

   This namespace contains constants that are used with
   :oe:meth:`OEConfGen::OEMolBuilderOptions::SetEnumNitrogen` to control the
   behavior of :ref:`OEOmega <OEConfGen_OEOmega>` with respect to enumeration
   of nonterminal nitrogens. Any nitrogen with pyramidal geometry in
   the initial model of the input molecule, and having no more than
   two ring bonds, is considered by :ref:`OEOmega <OEConfGen_OEOmega>` to be
   *invertible*.

   .. oe:constant:: Default

      Equivalent to :oe:const:`OEConfGen::OENitrogenEnumeration::Unspecified`.

   .. oe:constant:: Off

      Nitrogens are not enumerated.

   .. oe:constant:: All

      All invertible nitrogens will be enumerated.

   .. oe:constant:: Unspecified

      Only invertible nitrogens with unspecified stereochemistry will be
      enumerated.



.. oe:namespace:: OEConfGen

.. oe:constnamespace:: OEOmegaForceFieldType

   This namespace contains constants that refer to force fields that are
   available in :ref:`OEOmega <OEConfGen_OEOmega>`.

   ..  _OEConfGen_OEOmegaForceFieldType_SAGE:

   .. oe:constant:: SAGE

      The Sage force field from the Open Force Field Initiative. Name: sage

   ..  _OEConfGen_OEOmegaForceFieldType_SAGE_NOESTAT:

   .. oe:constant:: SAGE_NOESTAT

      The Sage force field without electrostatics. Name: sage_NoEstat

   ..  _OEConfGen_OEOmegaForceFieldType_SAGE_SHEFF:

   .. oe:constant:: SAGE_SHEFF

      The Sage force field with Sheffield solvation. Name: sage_Sheff

   ..  _OEConfGen_OEOmegaForceFieldType_MMFF:

   .. oe:constant:: MMFF
   
      The Merck Molecular Force Field (MMFF). Name: mmff

   ..  _OEConfGen_OEOmegaForceFieldType_MMFF_NOESTAT:

   .. oe:constant:: MMFF_NOESTAT

      The MMFF force field without electrostatics. Name: mmff_NoEstat

   ..  _OEConfGen_OEOmegaForceFieldType_MMFF_TRUNC:

   .. oe:constant:: MMFF_TRUNC

      The MMFF force field truncated at potential minimum. Name: mmff_Trunc

   ..  _OEConfGen_OEOmegaForceFieldType_MMFF_SHEFF:

   .. oe:constant:: MMFF_SHEFF

      The MMFF force field with Sheffield solvation. Name: mmff_Sheff

   ..  _OEConfGen_OEOmegaForceFieldType_MMFF94S:

   .. oe:constant:: MMFF94S
   
      The 94s variation of the Merck molecular force field (MMFF). Name: mmff94s

   ..  _OEConfGen_OEOmegaForceFieldType_MMFF94S_NOESTAT:

   .. oe:constant:: MMFF94S_NOESTAT

      The MMFF94S force field without electrostatics. Name: mmff94s_NoEstat

   ..  _OEConfGen_OEOmegaForceFieldType_MMFF94S_TRUNC:

   .. oe:constant:: MMFF94S_TRUNC

      The MMFF94S force field truncated at potential minimum. Name: mmff94s_Trunc

   ..  _OEConfGen_OEOmegaForceFieldType_MMFF94S_SHEFF:

   .. oe:constant:: MMFF94S_SHEFF

      The MMFF94S force field with Sheffield solvation. Name: mmff94s_Sheff

   ..  _OEConfGen_OEOmegaForceFieldType_MMFF94Smod:

   .. oe:constant:: MMFF94Smod
   
      The modified 94s variation of the Merck molecular force field (MMFF). Name: mmff94smod

   ..  _OEConfGen_OEOmegaForceFieldType_MMFF94Smod_NOESTAT:

   .. oe:constant:: MMFF94Smod_NOESTAT

      The modified MMFF94S force field without electrostatics. Name: mmff94smod_NoEstat

   ..  _OEConfGen_OEOmegaForceFieldType_MMFF94Smod_TRUNC:

   .. oe:constant:: MMFF94Smod_TRUNC

      The modified MMFF94S force field truncated at potential minimum. Name: mmff94smod_Trunc

   ..  _OEConfGen_OEOmegaForceFieldType_MMFF94Smod_SHEFF:

   .. oe:constant:: MMFF94Smod_SHEFF

      The modified MMFF94S force field with Sheffield solvation. Name: mmff94smod_Sheff

   ..  _OEConfGen_OEOmegaForceFieldType_Invalid:

   .. oe:constant:: Invalid
   
      Invalid force field type.

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConfGen

..  _OEConfGen_OEOmegaReturnCode:

.. oe:constnamespace:: OEOmegaReturnCode

   This namespace contains constants that are returned by various
   methods in **Omega TK** to indicate the outcome.

   ..  _OEConfGen_OEOmegaReturnCode_Success:

   .. oe:constant:: Success

      Method returned successfully.

   ..  _OEConfGen_OEOmegaReturnCode_MissingFFParams:

   .. oe:constant:: MissingFFParams

      Force field setup failed due to missing parameters.

   ..  _OEConfGen_OEOmegaReturnCode_ExplicitHydrogens:

   .. oe:constant:: ExplicitHydrogens

      Failed to add explicit hydrogens.

   ..  _OEConfGen_OEOmegaReturnCode_InvalidOptions:

   .. oe:constant:: InvalidOptions

      Failed due to invalid options.

   ..  _OEConfGen_OEOmegaReturnCode_No3DFromCT:

   .. oe:constant:: No3DFromCT

      Molecule must be three-dimensional when fromCT is set to *false*.

   ..  _OEConfGen_OEOmegaReturnCode_TooManyRotors:

   .. oe:constant:: TooManyRotors

      Maximum number of rotors exceeded.

   ..  _OEConfGen_OEOmegaReturnCode_UnspecifiedStereo:

   .. oe:constant:: UnspecifiedStereo

      Failed due to unspecified stereochemistry.

   ..  _OEConfGen_OEOmegaReturnCode_FailedCTBuild:

   .. oe:constant:: FailedCTBuild

      Failed to build structure from connection table (CT).

   ..  _OEConfGen_OEOmegaReturnCode_FailedTorDrive:

   .. oe:constant:: FailedTorDrive

      Failed to complete torsion driving.

   ..  _OEConfGen_OEOmegaReturnCode_ExceedsAtomDegree4:

   .. oe:constant:: ExceedsAtomDegree4

      Contains atom with degree greater than 4.

   ..  _OEConfGen_OEOmegaReturnCode_FailedDupSetup:

   .. oe:constant:: FailedDupSetup

      Duplicate removal setup failed.

   ..  _OEConfGen_OEOmegaReturnCode_FailedDGConfGen:

   .. oe:constant:: FailedDGConfGen

      Unable to generate 3D conformer.

   ..  _OEConfGen_OEOmegaReturnCode_FailedTorAssign:

   .. oe:constant:: FailedTorAssign

      Torsion assignment failed.

   ..  _OEConfGen_OEOmegaReturnCode_FailedSmartMatch:

   .. oe:constant:: FailedSmartMatch

      Unable to match SMARTS.

   ..  _OEConfGen_OEOmegaReturnCode_FailedFixMatch:

   .. oe:constant:: FailedFixMatch

      Fixfile match failed.

   ..  _OEConfGen_OEOmegaReturnCode_NoFixedFragment:

   .. oe:constant:: NoFixedFragment

      No fixed fragment found.

   ..  _OEConfGen_OEOmegaReturnCode_NoValidConfs:

   .. oe:constant:: NoValidConfs

      No valid conformers generated.

   ..  _OEConfGen_OEOmegaReturnCode_No3DTorDrive:

   .. oe:constant:: No3DTorDrive

      Input must be three-dimensional for torsion driving.

   ..  _OEConfGen_OEOmegaReturnCode_FailedCharges:

   .. oe:constant:: FailedCharges

      Failed to assign partial charges.

   ..  _OEConfGen_OEOmegaReturnCode_Failed:

   .. oe:constant:: Failed

      Method failed.


.. oe:namespace:: OEConfGen

..  _OEConfGen_OEOmegaSampling:

.. oe:constnamespace:: OEOmegaSampling

   This namespace contains constants that are used with
   :oe:meth:`OEConfGen::OEOmegaOptions` to control the
   defaults to be set for **Omega** options. Different sets of default options
   prepare **Omega** to generate structures that are optimal for different
   uses.

   .. admonition:: Code Examples

      * :ref:`section_examples_dens_omega` example

   ..  _OEConfGen_OEOmegaSampling_Classic:

   .. oe:constant:: Classic

      Options to generate a set of conformers representing a gas phase ensemble.

   ..  _OEConfGen_OEOmegaSampling_Dense:

   .. oe:constant:: Dense

      Options to generate a dense set of conformers optimal for FreeFormConf usage.

   .. caution::

      **GPU-Omega** is not compatible with the dense mode default force field. To
      enable **GPU-Omega** and utilize a GPU, set :oe:meth:`OEConfGen::OETorDriveOptions::SetForceField` to
      :oe:constns:`OEFF::OEMMFFSheffieldFFType::MMFF94Smod_NOESTAT`.

   ..  _OEConfGen_OEOmegaSampling_Pose:

   .. oe:constant:: Pose

      Options to generate a set of conformers suitable for molecular alignment
      and pose prediction by docking.

   ..  _OEConfGen_OEOmegaSampling_ROCS:

   .. oe:constant:: ROCS

      Options to generate a set of conformers suitable for **ROCS** usage.

   ..  _OEConfGen_OEOmegaSampling_FastROCS:

   .. oe:constant:: FastROCS

      Options to generate a sparse set of conformers suitable for **FastROCS** usage.

   The following options are overridden by various modes from the default
   :oe:const:`OEConfGen::OEOmegaSampling::Classic` mode.

      ==================  =================================  ==========================  =========================  ====================  ====================
      Option              Classic                            Dense                        Pose                       ROCS                  FastROCS
      ------------------  ---------------------------------  --------------------------  -------------------------  --------------------  --------------------
      RangeIncrement      4                                                               4

      MaxConfs            200                                20000                        200, 800                   50                    10

      UseThompson         True                               False                        True                       True                  True

      StrictStereo        True                               False

      MaxSearchTime       120.0                              3600.0

      EnergyWindow        [10.0, 15.0, 15.0, 20.0]           15.0                         [10.0, 15.0, 25.0, 30.0]   10                     10

      RMSThreshold        0.5                                0.3

      EnumNitrogen        OENitrogenEnumeration_Unspecified  OENitrogenEnumeration_All

      SampleHydrogens     False                              True

      SearchForceField    mmff94smod_NoEstat                 mmff94s_Sheff

      FragBuilderOptions  Fast                               Dense

      ==================  =================================  ==========================  =========================  ====================  ====================


.. oe:namespace:: OEConfGen

..  _OEConfGen_OESliceEnsembleDefaults:

.. oe:constnamespace:: OESliceEnsembleDefaults

   This namespace contains constants that are used for defaults of
   :oe:func:`OEConfGen::OESliceEnsemble`.

   ..  _OEConfGen_OESliceEnsembleDefaults_RMS:

   .. oe:constant:: RMS
   
      RMS value for duplicate removal.  Set to 0.5.

   ..  _OEConfGen_OESliceEnsembleDefaults_MaxConfs:

   .. oe:constant:: MaxConfs

      Maximum number of conformers in the ensemble.  Set to 200.

   ..  _OEConfGen_OESliceEnsembleDefaults_EnergyRange:

   .. oe:constant:: EnergyRange

      Energy windows range is set to [10.0, 15.0, 15.0, 20.0].
      With the default range increment of 4, this means that the energy window is
      10.0 for the molecules with 0–3 rotors, 15 for ones with 4–11 rotors and 20 for 12 or more rotors.

   ..  _OEConfGen_OESliceEnsembleDefaults_RangeIncrement:

   .. oe:constant:: RangeIncrement

      RangeIncrement is set to 4.


.. oe:namespace:: OEConfGen

..  _OEConfGen_OETorLibType:

.. oe:constnamespace:: OETorLibType

   This namespace contains constants that are used to construct an
   :ref:`OETorLib <OEConfGen_OETorLib>` object.

   .. seealso::
   
      * :oe:meth:`OEConfGen::OETorDriveOptions::SetTorLib` method to control 
        the torsion library used for conformation generation.

   ..  _OEConfGen_OETorLibType_Default:

   .. oe:constant:: Default

      The default torsion library is
      :oe:const:`OEConfGen::OETorLibType::Original`.

   ..  _OEConfGen_OETorLibType_Original:

   .. oe:constant:: Original

      The default **Omega TK** torsion library.

   ..  _OEConfGen_OETorLibTypeGubaV21:

   .. oe:constant:: GubaV21

      Torsion library (version 2.1) based on the work of Wolfgang Guba.

      .. seealso::

        * [Guba-2016]_




OEConfGen Functions
===================

.. toctree::
   :maxdepth: 1

   OEAddGlobalFragLib.rst
   OEClearGlobalFragLib.rst
   OEGetOmegaError.rst
   OEGetTorValues.rst
   OEIsMacrocycle.rst
   OEFlipper.rst
   OEFlipperStereoCenters.rst
   OEOmegaGetArch.rst
   OEOmegaGetLibraryRelease.rst
   OEOmegaGetLibraryVersion.rst
   OEOmegaGetLicensee.rst
   OEOmegaGetPlatform.rst
   OEOmegaGetRelease.rst
   OEOmegaGetSite.rst
   OEOmegaGetVersion.rst
   OEOmegaIsGPUReady.rst
   OEOmegaIsLicensed.rst
   OEOmegaSystemHasGPU.rst
   OESliceEnsemble.rst


.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEAddGlobalFragLib

.. oe:function:: OEAddGlobalFragLib

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddGlobalFragLib(const std::string& fraglib_filename,
                                 bool replace = true)

   .. oe:language:: python

      .. oe:api:: python

         OEAddGlobalFragLib(fraglib_filename: str, replace: bool = True) -> bool

   Adds a fragment library located at *fraglib_filename* to **Omega**'s
   global fragment library.  If *replace* is true, previously
   existing fragments in the current global fragment library are replaced
   with the ones from *fraglib_filename*.

   Unlike the fragment libraries loaded by
   :oe:meth:`OEConfGen::OEOmega::AddFragLib`, the global fragment
   library is accessible to all **Omega** instances.  It is most useful in
   the Java programming language to minimize memory usage when
   running multiple :ref:`OEOmega <OEConfGen_OEOmega>` instances in threads.
   Other languages have the default fragment library preloaded.

   If you use :oe:func:`OEConfGen::OEAddGlobalFragLib`
   to load your fragment library,
   do not use :oe:meth:`OEConfGen::OEOmega::AddFragLib`, as this
   will load the fragment library only into that particular
   :ref:`OEOmega <OEConfGen_OEOmega>` instance.

   .. note::

      This function is not thread-safe and must be called before
      starting any threads.

   .. seealso::

      * :oe:func:`OEConfGen::OEClearGlobalFragLib` function


.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEClearGlobalFragLib

.. oe:function:: OEClearGlobalFragLib

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEClearGlobalFragLib()

   .. oe:language:: python

      .. oe:api:: python

         OEClearGlobalFragLib() -> None

   Clears the global fragment library.  This function can be used
   to remove the default fragment library in order to load a new
   one or to ensure that any force field parameter change will
   be used during the subsequent runs in favor of the preloaded
   default fragment library.

   .. note::

      This function is not thread-safe and must be called before
      starting any threads.

   .. seealso::

      * :oe:func:`OEConfGen::OEAddGlobalFragLib` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. meta::
   :keywords: OEGetOmegaError

.. oe:namespace:: OEConfGen

.. oe:function:: OEGetOmegaError

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetOmegaError(const unsigned)

   .. oe:language:: python

      .. oe:api:: python

         OEGetOmegaError(code: int) -> str

   Returns error messages corresponding to return codes defined in the
   :oe:constns:`OEConfGen::OEOmegaReturnCode` namespace.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. meta::
   :keywords: OEGetTorValues

.. oe:namespace:: OEConfGen

.. oe:function:: OEGetTorValues

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGetTorValues(const OEChem::OESubSearch& torrule,
                             std::vector<double>& values)

   .. oe:language:: python

      .. oe:api:: python

         OEGetTorValues(torrule: OESubSearch, values: OEDoubleVector) -> bool

   Provides the torsion values corresponding to the specified torsion rule.  The method returns
   *false* if the specified :ref:`OESubSearch <OEChem_OESubSearch>` object does not contain torsion
   rules.

   .. seealso::

         * :oe:meth:`OEConfGen::OETorLib::GetTorRule` method.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. meta::
   :keywords: OEIsMacrocycle

.. oe:namespace:: OEConfGen

.. oe:function:: OEIsMacrocycle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsMacrocycle(const OEChem::OEMolBase& mol,
                             const unsigned int minSize = 10)

   .. oe:language:: python

      .. oe:api:: python

         OEIsMacrocycle(mol: Union[OEGraphMol,OEMol,OEQMol], minSize: int = 10) -> bool

   Checks if the specified molecule is a macrocycle.  The second argument
   refers to the minimum number of atoms required to be in a ring for the
   molecule to be treated as a macrocycle molecule. By default, a molecule is defined as macrocycle when it contains a
   10-membered or larger ring, regardless of aromaticity and heteroatom content. For example, large cyclic alkanes,
   annulenes, crown ethers, and porphyrins are all macrocycles.

   .. seealso::

      * :ref:`OEMacrocycleOmega <OEConfGen_OEMacrocycleOmega>` class
      * :ref:`OEMacrocycleBuilder <OEConfGen_OEMacrocycleBuilder>` class


.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEFlipper

.. _oeconfgen_OEFlipper:

.. oe:function:: OEFlipper

  .. oe:language:: c++ java csharp

     .. oe:api::

        OESystem::OEIterBase<OEChem::OEMolBase>* OEFlipper(const OEChem::OEMolBase& mol,
                                                           const OEFlipperOptions& options)
        OESystem::OEIterBase<OEChem::OEMolBase>* OEFlipper(const OEChem::OEMCMolBase& mol,
                                                           const OEFlipperOptions& options)

  .. oe:language:: python

     .. oe:api:: python

        OEFlipper(mol: OEMol, options: OEFlipperOptions) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]
        OEFlipper(mol: Union[OEGraphMol,OEQMol], options: OEFlipperOptions) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

  Enumerates the stereocenters of ``mol`` and returns them as a
  series of new molecules.

  **Parameters:**

  *mol*
     The molecule to enumerate. The input molecule will always be
     returned even if there are no stereocenters to enumerate.
  *options*
     The :oe:cls:`options<OEConfGen::OEFlipperOptions>` for enumerating stereocenters of molecules.

  **Deprecated**

  .. oe:language:: c++ java csharp

     .. oe:api::

        OESystem::OEIterBase<OEChem::OEMolBase>* OEFlipper(const OEChem::OEMolBase& mol,
                                                           unsigned int maxcenters = 12,
                                                           bool forceFlip = false,
                                                           bool enumNitrogen = false,
                                                           bool warts = false)
        OESystem::OEIterBase<OEChem::OEMolBase>* OEFlipper(const OEChem::OEMCMolBase& mol,
                                                           unsigned int maxcenters = 12,
                                                           bool forceFlip = false,
                                                           bool enumNitrogen = false,
                                                           bool warts = false)

  .. oe:language:: python

     .. oe:api:: python

        OEFlipper(mol: OEMol, maxcenters: int = 12, forceFlip: bool = False,
                  enumNitrogen: bool = False, warts: bool = False) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]
        OEFlipper(mol: Union[OEGraphMol,OEQMol], maxcenters: int = 12,
                  forceFlip: bool = False, enumNitrogen: bool = False,
                  warts: bool = False) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

  Enumerates the stereocenters of ``mol`` and returns them as a
  series of new molecules.

  **Parameters:**

  *mol*
     The molecule to enumerate. The input molecule will always be
     returned even if there are no stereocenters to enumerate.
  *maxcenters*
     The number of molecules generated by
     enumerating the stereocenters is :math:`2^N`, where `N` is the number of
     stereocenters.  In some instances, this may be larger than is desired.  This
     parameter indicates the maximum number of stereocenters
     which will be fully enumerated.  If a molecule has more than
     ``maxcenters`` stereocenters, this function will randomly enumerate
     :math:`2^{maxcenters}` instances from the full set of potential isomers.

  *forceFlip*
     This parameter forces the modification of all of the
     stereocenters in a molecule.  If *false* (the default), it will
     only enumerate stereocenters which do not already have a
     specified stereochemistry.
  *enumNitrogen*
     Controls the behavior with respect to the
     enumeration of nonterminal nitrogens.  Any nitrogen with
     pyramidal geometry in the initial model of the input molecule,
     and having no more than two ring bonds is considered to
     be *invertible*.  It will enumerate all possible puckers if
     set to *true*.
  *warts*
     Adds wart to the title of each stereoisomer. A "wart" is a systematic
     naming scheme for the output titles.

  .. caution::

     This function will remove the molecule coordinates.

  .. admonition:: Code Examples

     * :ref:`section_examples_stereo_and_torsion` example

.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEFlipperStereoCenters

..  _OEConfGen_OEFlipperStereoCenters:

.. oe:function:: OEFlipperStereoCenters

  .. oe:language:: c++ java csharp

     .. oe:api::

        unsigned OEFlipperStereoCenters(const OEChem::OEMolBase& mol,
                                        const OEFlipperOptions& options)

  .. oe:language:: python

     .. oe:api:: python

        OEFlipperStereoCenters(mol: Union[OEGraphMol,OEMol,OEQMol],
                               options: OEFlipperOptions) -> int

  Computes the number of the stereocenters of ``mol``.

  **Parameters:**

  *mol*
     The input molecule.
  *options*
     The :oe:cls:`options<OEConfGen::OEFlipperOptions>` for enumerating the stereocenters of a molecule.



.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmegaGetArch

.. oe:function:: OEOmegaGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEOmegaGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEOmegaGetArch() -> str

   Returns the internal build string used by OpenEye, Cadence Molecular Sciences
   to identify the hardware architecture.  The format of these strings may
   change over time.



.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmegaGetLibraryRelease

.. oe:function:: OEOmegaGetLibraryRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEOmegaGetLibraryRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEOmegaGetLibraryRelease() -> str

   .. caution::

      Deprecated, please use :oe:func:`OEConfGen::OEOmegaGetRelease` instead.


.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmegaGetLibraryVersion

.. oe:function:: OEOmegaGetLibraryVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEOmegaGetLibraryVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEOmegaGetLibraryVersion() -> int

   .. caution::

      Deprecated, please use :oe:func:`OEConfGen::OEOmegaGetVersion` instead.


.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmegaGetLicensee

.. oe:function:: OEOmegaGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEOmegaGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEOmegaGetLicensee(licensee: str) -> bool

   Returns the licensee name from the license file.


.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmegaGetPlatform

.. oe:function:: OEOmegaGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEOmegaGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEOmegaGetPlatform() -> str

   Returns the internal build string used by OpenEye, Cadence Molecular Sciences
   to identify a platform.  The format of these strings may change over
   time, and future distributions may contain different values even when
   using the same operating system, compiler, and processor.  For example,
   on a ``x86_64`` Red Hat Enterprise Linux box, this would return
   ``redhat-RHEL5-g++4.1-x64``.



.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmegaGetRelease

.. oe:function:: OEOmegaGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEOmegaGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEOmegaGetRelease() -> str

   Returns the release name of the **Omega TK** library being used.  This
   returns a value similar to *0.10.0* for production versions of the
   library, and *0.10.0 debug* for the checking version of the library.


.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmegaGetSite

.. oe:function:: OEOmegaGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEOmegaGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEOmegaGetSite(site: str) -> bool

   Returns the physical site location of the licensee as registered in the license file.


.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmegaGetVersion

.. oe:function:: OEOmegaGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEOmegaGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEOmegaGetVersion() -> int

   Returns the version number of the library being used.  This is an
   unsigned integer value indicating the date on which the library was
   built, for example, *20141001* refers to October 1, 2014.  This
   value should be used when reporting problems; unlike the release
   string, it may be used in comparisons if needed.


.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmegaIsGPUReady

..  _OEConfGen_OEOmegaIsGPUReady:

.. oe:function:: OEOmegaIsGPUReady

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEOmegaIsGPUReady()

   .. oe:language:: python

      .. oe:api:: python

         OEOmegaIsGPUReady() -> bool

   Determines whether a GPU is present and available for use on the current system.

   This can be used to determine if conformer generation using the torsion driving
   method will be accelerated by a GPU.

  .. caution::
    This function causes GPU context creation and so is only safe to use from within
    a process when using a multithreaded environment such as Python's multiprocessing.

   .. seealso::

      * :ref:`chapter_omegagpuomega` chapter in the *OEOmega TK* documentation.



.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmegaIsLicensed

.. oe:function:: OEOmegaIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEOmegaIsLicensed(const char* feature = 0,
                                unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEOmegaIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **Omega TK** functionality.

   The feature argument can be used to check for a valid license to
   **Omega TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The expdate argument can be used to obtain the expiration date of
   the current **Omega TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function


.. |product|        replace:: Omega TK


.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmegaSystemHasGPU

..  _OEConfGen_OEOmegaSystemHasGPU:

.. oe:function:: OEOmegaSystemHasGPU

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEOmegaSystemHasGPU()

   .. oe:language:: python

      .. oe:api:: python

         OEOmegaSystemHasGPU() -> bool

   Determines whether a GPU is present on the current system. This will check that the
   system is a Linux platform and the `/dev/nvidiaN` file exits, where N can be between 0 and 100.
   It will not try to create a context on the GPU, so there is still the possibility that the GPU will not
   be available, either due to the driver being uninstalled or the GPU being used by another
   system user.

.. meta::
   :keywords: OESliceEnsemble

.. oe:namespace:: OEConfGen

.. _OEConfGen_OESliceEnsemble:

.. oe:function:: OESliceEnsemble

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESliceEnsemble(OEChem::OEMCMolBase& mol,
                              double rms = OESliceEnsembleDefaults::RMS,
                              double ewindow = OESliceEnsembleDefaults::EWindow,
                              unsigned maxconfs = OESliceEnsembleDefaults::MaxConfs)
         bool OESliceEnsemble(OEChem::OEMCMolBase& mol,
                              const OESliceEnsembleOptions& options)

   .. oe:language:: python

      .. oe:api:: python

         OESliceEnsemble(argMol: OEMol, argRms: float, argEWindow: float,
                         argMaxConfs: int) -> bool
         OESliceEnsemble(argMol: OEMol, argSlicerOpts: OESliceEnsembleOptions) -> bool

   Reduces the number of conformers in the input ``mol`` using the
   **OMEGA** deduplication algorithm. This allows for
   :ref:`OEOmega <OEConfGen_OEOmega>` to generate a very large ensemble with
   much looser deduplication parameters and then to "slice" that
   ensemble of conformations by various different parameters after the
   fact. 

   The default values for the first overload of the function are picked from the
   :oe:constns:`OEConfGen::OESliceEnsembleDefaults` namespace. 

   Conformer slicing proceeds in the following order: 

   #. Slice by energy window. Decreasing this value will result in
      fewer conformers. For slicing by energy, the algorithm assumes
      that the energy for each conformer has been precalculated and
      set as the energy property of the conformer using the
      :oe:meth:`OEChem::OEMolBase::SetEnergy` method.  Conformer
      generation using :ref:`OEOmega <OEConfGen_OEOmega>`, sets this property
      by default.
   #. Slice by RMS. Increasing this value will result in fewer
      conformers.
   #. Slice by maximum number of conformers. Decreasing this value
      will result in fewer conformers.

   .. note:: 

      If the same energy window and RMS values are being chosen as the
      defaults being used in the previous :ref:`OEOmega <OEConfGen_OEOmega>`
      calculation, it will be faster to delete conformers
      directly with :oe:meth:`OEChem::OEMCMolBase::DeleteConf`. This
      function is really intended to be run whenever the RMS has
      changed, or when the conformer geometries themselves have changed.


.. _omega_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version7_0_0
   version6_1_1
   version6_1_0
   version6_0_0
   version5_1_0
   version5_0_0
   version4_2_2
   version4_2_1
   version4_2_0
   version4_1_2
   version4_1_1
   version4_1_0
   version4_0_0
   version2_9_1
   version2_9_0
   version2_8_0
   version2_7_0
   version2_6_7
   version2_6_6
   version2_6_5
   version2_6_4
   version2_6_3
   version2_6_2
   version2_6_1
   version2_6_0
   version2_5_7
   version2_5_6
   version2_5_5
   version2_5_4
   version2_5_3
   version2_5_2
   version2_5_1
   version2_5_0
   version2_4_6
   version2_4_5
   version2_4_4
   version2_4_1
   version2_4_0
   version2_3_3
   version2_3_2
   version2_3_1
   version2_3_0
   version2_2_2
   version2_2_1



Omega TK 7.0.0
================================================================================

New Features
--------------------------------------------------------------------------------

* The following changes have been made to extend Thompson sampling usage for torsion driving
  in :ref:`OEOmega<OEConfGen_OEOmega>`:

  * The :ref:`Thompson sampling<OEConfGen_OETorDriveOptions_SetUseThompson>` algorithm
    for torsion driving has been improved for robustness and speed.
  * The default value for :ref:`SetUseThompson<OEConfGen_OETorDriveOptions_SetUseThompson>`
    in :ref:`OETorDriveOptions<OEConfGen_OETorDriveOptions>` has been changed to ``True``.
  * The :ref:`SetUseThompson<OEConfGen_OETorDriveOptions_SetUseThompson>` is honored even when
    :ref:`SetUseGPU<OEConfGen_OETorDriveOptions_SetUseGPU>` is set to ``True``.
  * The preliminary API class ``OEThompsonOptions`` has been removed, as it is no longer relevant.

* The default energy window for torsion driving in :ref:`Classic <OEConfGen_OEOmegaSampling_Classic>`
  mode has been changed to a range-based value to better suit **OMEGA** with Thompson sampling.
  Similarly, the energy range for the :ref:`Pose <OEConfGen_OEOmegaSampling_Pose>` mode has also been
  adjusted.

Minor Bug Fixes
--------------------------------------------------------------------------------

* :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` now respects the
  :ref:`MaxEnumConfs <OEConfGen_OEMolBuilderOptions_SetMaxEnumConfs>` provided in 
  the :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>`
  even when an input molecule has more conformers than specified.
  
* Certain edge cases where the torsion driving algorithm would fail with a
  FailedTorDrive error message have been addressed. 


.. _section_omega_releasenotes_221:

Omega TK 2.2.1
================================================================================

Bug fixes
--------------------------------------------------------------------------------

*  The new build algorithm introduced in v2.2.0 could, on rare
   occasions, generate a structure with heavy atom clashes. This
   release is mainly a bug fix for this problem.


.. _section_omega_releasenotes_222:

Omega TK 2.2.2
================================================================================

Bug fixes
--------------------------------------------------------------------------------

*  Fixed a major bug that would cause highly-symmetric,
   highly-fluorinated compounds to crash the program or hang a slave
   in PVM mode.

*  Fixed a bug in atom typing when building fragments from scratch
   that, in some rare cases, could result in differing fragment
   geometries depending on the order of input of the molecules.

*  Added more places that check for time exceeding max time. This is more
   just to prevent overly large molecules from appearing to hang. 

*  If OMEGA is called with a fixed predicate, this now implies that
   FromCT is false. In other words, if you want to use a predicate to
   fix atoms, you need to use a 3D structure as input.


.. _section_omega_releasenotes_230:

Omega TK 2.3.0
================================================================================

New features
--------------------------------------------------------------------------------

*  The distribution and installation of OMEGA has been modified.  The
   Windows distribution is now a standard .exe installer, and the OS X
   distribution is a dmg containing a standard pkg installer.  The
   executables are now scripts that chose the correct version of the
   program at runtime.  Please see the Installation and Platform Notes
   for details.

*  The defaults for MaxConfs and RMSThreshold are changed in this
   version.  The default for MaxConfs is reduced from 400 to 200,
   while the value for RMSThreshold goes from 0.8 down to 0.5. These
   changes are based on maintaining good reproduction of the crystal
   structure test set, virtual screening tests with ROCS and FRED, and
   pose prediction tests with FRED.

*  The method ``OEConfGen::OEOmega::ClearFixFile`` is added to
   the OMEGA library.  This allows an ``OEConfGen::OEOmega``
   instance to be reused for an unrestrained search after it has
   previously been used for a fixed search.

*  Untitled molecules are given unique titles of omega_1, omega_2, and
   so on.  Titles allow molecules to be located in the log files.

Bug fixes
--------------------------------------------------------------------------------

*  Fixed a major bug where molecules that have missing torsion rules
   caused OMEGA to crash.  Molecules with missing torsion rules are
   now sent to the *omega2.fail* file and are not processed.  Missing
   torsion rules are typically caused by highly unusual molecules for
   which OEChem cannot properly assign valence to all atoms.

*  Fixed a bug in duplicate conformer removal that caused some
   conformers that should have been removed to pass through as unique.
   This bug also caused occurrences where a reduction in maxconfs led
   to an increase in the number of conformers returned.

*  Fixed a bug that caused SD data on single conformer molecules to be removed.

*  Fixed a bug in the *flipper* library that left 3D coordinates intact,
   which caused stereo chemistry to be ambiguous.  The *flipper* library
   now replaces 3D coordinates with zeros.

*  Fixed a bug where the ``SyM`` tag from previous OMEGA
   calculations caused problems when those molecules where passed back
   in.  Also, the ``O2MolId`` tag is now removed from molecules
   before they are sent to the output.

*  When the number of stereo centers exceeds the number of -maxcenters
   M, *flipper* now generates :math:`2^{M}` random non-repeating flips.
   Previous versions generated :math:`2^{M}` random flips, leading to
   molecules with the same stereochemistry being returned multiple
   times.


.. _section_omega_releasenotes_231:

Omega TK 2.3.1
================================================================================

New features
--------------------------------------------------------------------------------

*  The OMEGA application now includes a utility named oeb2sdconf that
   allows OMEGA generated conformers to be used with the MOE program.
   Please contact Chemical Computing Group support if you require
   assistance with this utility.

Bug fixes
--------------------------------------------------------------------------------

*  Fixed a bug where the omega2 PVM features would not work on some platforms.

*  Fixed a bug where the omega2 script would not function properly with filenames that had spaces in them.


.. _section_omega_releasenotes_232:

Omega TK 2.3.2
================================================================================

Bug fixes
--------------------------------------------------------------------------------

*  Fixed a bug where molecules containing boron or selenium could
   cause a crash.  These molecules now are written to the *'.fail'* file
   due to missing force field parameters and the program will proceed
   to the next molecule.


.. _section_omega_releasenotes_233:

Omega TK 2.3.3
================================================================================

New features
--------------------------------------------------------------------------------
*  New API points have been added:
   :oe:meth:`OEConfGen::OETorLib::ResetTorsionLibrary`,
   :oe:meth:`OEConfGen::OETorLib::ClearTorsionLibrary`, and
   :oe:meth:`OEConfGen::OETorLib::AddTorsionRule`.  The torsion rules
   may be created by passing in a ``OEQMolBase`` and ``vector<int>`` of
   angles, or by passing in a string with the standard rule format.

*  The corresponding atom symbols, bond symbols, and torsion angles
   are now printed on a line under the matching smarts pattern.

Bug fixes
--------------------------------------------------------------------------------

*  Rotor offset compression is now set to ``false`` by default.
   Coordinate changes made in the toolkits after an Omega calculation
   are lost if rotor offset compression is set to ``true``.  If
   molecules are sent to ``OEWriteMolecule`` directly after an Omega
   run then rotor offset compression may safely be set to ``true``,
   which will significantly reduce the filesize of the output.

*  The energy window set by
   `SetEnergyRange` and
   `SetRangeIncrement` is now used
   consistently.  Previous versions of Omega did not use this value
   properly for all aspects of an Omega calculation.


.. _section_omega_releasenotes_240:

Omega TK 2.4.0
================================================================================

New features
--------------------------------------------------------------------------------

*  The MaxConfGen and MaxPoolSize variables are now set internally and adjusted automatically subject to the user
   defined variable of MaxConfs.  Additionally, hard limits have been removed from
   these variables and they are now only limited by available memory.  The following
   methods are deprecated: `SetMaxConfGen`,
   `GetMaxConfGen`, `SetMaxPoolSize`, 
   `GetMaxPoolSize`.

*  The method `SetMaxConfs` has been changed from `void` to `bool`.  The method will return 
   ``true`` if the parameter has been set properly and will return ``false`` if the number is too high and would cause the 
   memory required for duplicate removal to exceed the maximum theoretical memory for the platform.

*  The method `SetFixSmarts` has been created to allow a smarts pattern to be used to fix
   a portion of the molecule.  This requires 3D coordinates to be available from either a 3D input file with  
   `SetFromCT` set to ``false`` or from a molecule set using `SetFixMol`.

*  Fragment generation for :ref:`OEOmega <OEConfGen_OEOmega>` is now the same as the :ref:`MakeFraglib <chapter_makefraglib>` application.
   Previous versions used a faster but more approximate version of fragment generation.

*  The :ref:`OEOmega <OEConfGen_OEOmega>` default has been changed to no longer use "close enough" atom typing.
   If a proper MMFF atom type cannot be found for an atom then the molecule will fail.  Previous versions 
   would use a different atom type of the same element if it was available.  The previous behavior of atom 
   type substitution can be enabled by calling `SetStrictAtomTypes` with the argument ``false``.

*  The error level for most messages coming from the Omega library has been lowered to `Verbose`.  The library 
   can be run in a much quieter manner if the error level is set to `Info` by the user.

Bug fixes
--------------------------------------------------------------------------------

*  Crashes have been fixed that could occur when the FixFile could not find a valid match or did not have 
   enough atoms to match against in a ring system.

*  Program no longer crash if there is not enough memory for duplicate removal.  If there is not enough 
   memory available for allocation then duplicate removal will be skipped for the molecule and operator()
   will return ``true``.


.. _section_omega_releasenotes_241:

Omega TK 2.4.1
================================================================================

New features
--------------------------------------------------------------------------------

*  OMEGA and :ref:`MakeFraglib <chapter_makefraglib>` may now be run with MPI using the `oempirun` script.  (May not available on all platforms)

*  The default for OMEGA has been changed to require all stereocenters to be specified.  Molecules with any unspecified 
   stereo will fail.  The previous
   behavior was for OMEGA to choose a random stereoisomer.  This default can be changed back to the previous behavior 
   by setting `-strictstereo` to ``false``.

*  The default for OMEGA has been changed to no longer use 'close enough' atom typing.  If a proper MMFF atom type 
   cannot be found for 
   an atom then the molecule will fail.  Previous versions would use a different atom type of the same element if it 
   was available.  
   The previous behavior for atom type substitution can be enabled by setting `-strictatomtyping` to ``false``.

*  OMEGA now has the option to require on-the-fly generation of fragments to be the same as the :ref:`MakeFraglib <chapter_makefraglib>` utility
   by setting `-strictfrags` to ``true``. 
   This fragment generation is more rigorous but also more time consuming.

*  The convenience flag `-strict` has been added to turn on or off all of the strict options.  These include 
   `-strictstereo`, `-strictatomtyping` and `-strictfrags`.

*  On-screen progress has been enabled for OMEGA and :ref:`MakeFraglib <chapter_makefraglib>` using the `-progress` flag.
   The options are `none`, `dots`, `log`, and `percent`.

*  The `-maxconfgen` and `-maxpoolsize` flags have been removed.  These options are set internally and adjusted automatically 
   subject to the user
   defined variable of `-maxconfs`.  Additionally, hard limits have been removed from
   these variables and they are now only limited by available memory. 

*  The flag `-fixsmarts` has been created to allow a smarts pattern to be used to fix
   a portion of the molecule.  This requires 3D coordinates to be available from either 
   a 3D input file with `-fromCT` set to ``false`` or from a molecule set using `-fixfile`.

Bug fixes
--------------------------------------------------------------------------------

*  Crashes have been fixed that could occur when the `-fixfile` could not find a valid match or did not have 
   enough atoms to match against in a ring system.

*  Program no longer crashes if there is not enough memory for duplicate removal.  If there is not enough memory 
   available for allocation then the application will exit immediately.


.. _section_omega_releasenotes_244:

Omega TK 2.4.4
================================================================================

Bug fixes
--------------------------------------------------------------------------------

*  Fixed a bug where OMEGA wasn't checking if 3D construction of fragment generation was successful.

*  Fixed a bug where output from flipper could still fail in OMEGA for missing stereo chemistry.  Now the rules for required stereo chemistry are consistent.

*  Fixed a bug where setting stereo chemistry in too small of a ring could cause a crash.  Now only rings greater than 7 members and only one double bond will be set with flipper.



.. _section_omega_releasenotes_245:

Omega TK 2.4.5
================================================================================

New features
--------------------------------------------------------------------------------
*  Now uses an extension of the MMFF94 force field for tricoordinate boron compounds. 
   Most compounds containing B-X bonds where X=C,N,O,S,
   and H are covered with the following exceptions: X=N(imine),N(sulfonamide),
   N(pyridinium) and N(quaternary). Also not supported are compounds in which
   boron is bonded to X=F,Cl,Br,I,B and Si, or makes a bond angle BYX.
   Compounds in which boron is a part of four-membered rings of B1CCC1 type are also
   not available in the current parameterization because their existence is questionable:
   Ab initio calculations at the MP2/6-31G** level failed to identify stable structures
   for them (highly polar structures in which boron is four-coordinated are formed).




.. _section_omega_releasenotes_246:

Omega TK 2.4.6
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The treatment of single-atom systems has been changed to explicitly
  set the dimension to 3D so that they are not labeled 2D when writing
  to SDF format.




.. _section_omega_releasenotes_250:

Omega TK 2.5.0
================================================================================

New features
--------------------------------------------------------------------------------

* The *Omega TK* library is now thread safe. Note, different
  :ref:`OEOmega <OEConfGen_OEOmega>` objects are still required per thread.

Major bug fixes
--------------------------------------------------------------------------------

* :ref:`OEOmega <OEConfGen_OEOmega>` class would cause a crash on destruction
  whenever a copy was made. This has been fixed by specifying a proper
  copy constructor.

Minor bug fixes
--------------------------------------------------------------------------------

*  Tags for rotor compression are no longer attached to the output molecules when rotoroffsetcompress is false.  
   It was discovered that these tags confuse VIDA when they are attached but not used.

*  The torsion library has been updated with better angles for a biphenyl torsion. 
   The entry for 90 degrees has been removed and +/-30 degrees has been added.




.. _section_omega_releasenotes_251:

Omega TK 2.5.1
================================================================================

New features
--------------------------------------------------------------------------------

* An option has been added to allow hydrogen atoms in -OH, -SH, and amines to take part in conformational sampling.  New
  methods have been added for accessing this option: `GetSampleHydrogens`
  and `SetSampleHydrogens`.  By default, hydrogen atoms are not sampled.

* A warts option has been added to :ref:`OEFlipper <OEConfGen_OEFlipper>`.  Enabling this
  option will number the output molecules with an `@` symbol.

* The parameterless version of :oe:meth:`OEConfGen::OEOmega::AddFragLib` will now load the built-in fraglib immediately.  By
  default, the built-in fraglib does not load until operator() is called for the first time.

Major bug fixes
--------------------------------------------------------------------------------

* Now using `SetFixSmarts` without `SetFixMol` will
  rematch for every input structure.  Previously, this would only match the first input structure and reuse
  that match for the rest of the calculation.  Using both `SetFixSmarts` and 
  `SetFixMol` will continue to match against the fixmol and use that match for the
  entire calculation.

* Partial ring matching with `SetFixSmarts` or `SetFixMol` could
  cause a crash.  Now only full ring systems may be specified and any attempt at matching a partial ring system will fail
  gracefully.

* The default value for max matches with `SetFixSmarts` or `SetFixMol` has
  been changed from 10 to 1.  This value can be adjusted with `SetFixMaxMatch`.

* A bug has been fixed where multiple threads using OEOmega could cause a license failure.

* Planar molecules could have problems sprouting hydrogens when disabling `SetFromCT`
  because OMEGA was treating them as 2D.  Now OMEGA will assume that planar molecules are properly 
  defined 3D coordinates in this situation.

* Stereochemistry at the attachment points of rings with four or less atoms could be lost.  Now stereochemistry
  is saved for rings of all sizes.

* A bug has been fixed where exceptionally long torsion rules could get cutoff early.

Minor bug fixes
--------------------------------------------------------------------------------

* Only 3D coordinates were being cleared in FLIPPER.  Now 2D coordinates are cleared as well.

* Fragment generation during an OMEGA calculation with `SetStrictFrags` 
  enabled could yield slightly different fragments than the MakeFraglib app.  This has been corrected
  for consistency.

Documentation fixes
--------------------------------------------------------------------------------

* The *Omega TK* documentation was showing the incorrect version number. 




.. _section_omega_releasenotes_252:

Omega TK 2.5.2
================================================================================

New features
--------------------------------------------------------------------------------

* The fragment library is now shared across multiple
  instances of the :ref:`OEOmega <OEConfGen_OEOmega>` objects in a
  thread-safe manner. This can greatly reduce the amount of memory
  needed to run a multi-threaded version of Omega TK. For example, the
  memory consumption of Omega TK running across 8-cores dropped from
  715MB to 258MB for 14,000 lead-like compounds from MDDR. This can
  also lead to a performance improvement since expensive fragment
  generation can sometimes be avoided if it has already been completed
  by another thread.

.. oe:language:: java

   .. note:: 
      
      For Java, the internal fraglib is not shared because the fraglib
      is not shipped as part of the omega2 library binary, but as a
      separate standalone file to allow multiple JAR files to be
      combined together and not duplicate the fragment library across
      them. Fragments generated on the fly will be shared across
      :ref:`OEOmega <OEConfGen_OEOmega>` objects, just not the builtin
      fragments.

.. oe:language:: c++

   * A multi-threaded Omega TK example has been added ``omega_omp`` to
     demonstrate how to use Omega TK with OpenMP.

   * The internal fragment library for the Omega TK static library is
     now stored in a more space and time efficient manner. Binaries
     linked to the Omega TK library should now be smaller, for
     example, the RHEL6 ``simple_omega`` example is now 53MB instead
     of 77MB. The library load time has also been improved. For
     example, running the RHEL6 ``simple_omega`` example on a single
     benzene will now take 0.20 seconds instead of 0.78 seconds. Your
     mileage may vary depending upon operating system and hardware.

.. oe:language:: python
   
   * The internal fragment library for the Omega TK shared library is
     now stored in a more space and time efficient manner. Creating an
     :ref:`OEOmega <OEConfGen_OEOmega>` object and running it on a single
     molecule should now be faster. For example, running the
     ``simple_omega.py`` example on a single benzene now takes 0.25
     seconds instead of 0.83 seconds. Your mileage may vary depending
     upon operating system and hardware.

   * The python global interpreter lock will now be released when entering OMEGA toolkit calls. 

Minor bug fixes
--------------------------------------------------------------------------------

* Now operator() will fail nicely and return false for non-3D input if `SetFromCT`
  is set to false.

* All ring bonds will be left unset by :ref:`OEFlipper <OEConfGen_OEFlipper>` unless forceFlip=true.




.. _section_omega_releasenotes_253:

Omega TK 2.5.3
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEConfGen::OEAddGlobalFragLib` added to allow a given
  fragment library to be preloaded into the global fragment library
  where it can be shared among all :ref:`OEOmega <OEConfGen_OEOmega>` instances.

.. oe:language:: java

   .. note::

      This allows *JAVA* to use less memory when running OMEGA in
      multiple threads.

Minor bug fixes
--------------------------------------------------------------------------------

*  The wart symbol has been changed from `@` to `_` in order to help with 
   parsing SMILES formatting.

*  Bond stereochemistry is now properly perceived when strictstereo is set to 
   `false`.  Previously, there could be an `OESubSearch` warning due to 
   unperceived bond stereochemistry.
  
*  The :oe:constns:`OEConfGen::OENitrogenEnumeration` namespace has been created. 
   The namespace constants should be used in place of magic numbers.




.. _section_omega_releasenotes_254:

Omega TK 2.5.4
================================================================================

New features
--------------------------------------------------------------------------------

* The namespace :oe:constns:`OEConfGen::OESliceEnsembleDefaults` has been created
  with defaults for :oe:func:`OEConfGen::OESliceEnsemble`.  These defaults have been
  updated in order to match the defaults that OMEGA uses during conformer generation.

Major bug fixes
--------------------------------------------------------------------------------

* Fixed possible crash caused when reading empty lines in torsion library files. 

* Fixed a bug where :oe:const:`OEConfGen::OENitrogenEnumeration::All` was equivalent to 
  :oe:const:`OEConfGen::OENitrogenEnumeration::Unspecified`.  Now 
  :oe:const:`OEConfGen::OENitrogenEnumeration::All` will properly enumerate nitrogen atoms
  with specified stereochemistry.

.. oe:language:: java

   * The Java Omega toolkit will now load the fragment library once
     and share it between all :ref:`OEOmega <OEConfGen_OEOmega>` objects. The
     old behavior was to load the fragment library once per
     :ref:`OEOmega <OEConfGen_OEOmega>` object creating a lot more memory
     overhead.

   * The following methods now usable from Java and utilize java.util.List:

     - `OEConfGen::OEOmega::GetEnergyRange`  returns java.util.List<Double>
     - `OEConfGen::OEOmega::SetEnergyRange` takes java.util.List<Double> argument
     - `OEConfGen::OEOmega::GetRMSRange` returns java.util.List<Double>
     - `OEConfGen::OEOmega::SetRMSRange` takes java.util.List<Double> argument
     - `OEConfGen::OEOmega::GetMaxConfRange` returns java.util.List<Integer>
     - `OEConfGen::OEOmega::SetMaxConfRange` takes java.util.List<Integer> argument

Minor bug fixes
--------------------------------------------------------------------------------

* A bug has been fixed where OESubSearch warnings could appear due to unset bond
  stereochemistry.  Bond stereochemistry is now always set properly.



.. _section_omega_releasenotes_255:

Omega TK 2.5.5
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Removed unbounded stack allocations. 

Documentation fixes
--------------------------------------------------------------------------------

* **Omega TK** examples for Java, C#, and Python will now check to see whether
  :ref:`OEOmega <OEConfGen_OEOmega>` failed and not write the molecule in
  those cases.

* **Omega TK** examples for Java, C# and Python were renamed to more accurately 
  reflect their function.

* :oe:meth:`OEConfGen::OETorLib::AddTorsionRule` more thoroughly documented.



.. _section_omega_releasenotes_256:

Omega TK 2.5.6
================================================================================

New features
--------------------------------------------------------------------------------

* **Omega TK** conformers can be produced in ``double`` precision and
  round-tripped through rotor-offset-compress OEB files. 

Minor bug fixes
--------------------------------------------------------------------------------

* Rare possible race condition prevented. 

Documentation fixes
--------------------------------------------------------------------------------

* Examples will now check the return value of the omega process before
  writing out the molecule.

.. oe:language:: c++

   * Added the following example code to the C++ distribution:

     - AddTorsionRule.cpp
     - simple_omega.cpp
     - single_conformer.cpp
     - stereo_and_torsion.cpp



.. _section_omega_releasenotes_257:

Omega TK 2.5.7
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

- The :ref:`OEOmega <OEConfGen_OEOmega>` constructor will now initialize all
  data members appropriately to avoid subtle unreproducible errors
  based on random values in memory.

- Calling `SetWarts` with true had been broken until the 2014.Oct
  release. The output conformers would have the numeric index(wart) in the 
  ``.oeb`` format but not the ``.sdf`` format. This is now fixed.  The default
  behavior of OETautomerOptions has been changed from ``true`` to ``false`` 
  when applying a numeric index(wart) to titles.

C#-specific changes
--------------------------------------------------------------------------------

- :oe:meth:`OEConfGen::OETorLib::AddTorsionRule` is now usable from C#. 



Omega TK 2.6.0
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* :ref:`OEOmega <OEConfGen_OEOmega>` will no
  longer cause non-deterministic amounts of superfluous messages to be
  thrown to :oe:constns:`OESystem::OEThrow` when running in multiple
  threads. This had been happening because :ref:`OEOmega <OEConfGen_OEOmega>` calls
  :oe:meth:`OESystem::OEErrorHandler::SetLevel` to selectively silence
  warning messages it knows to be benign. This was fixed by
  only allowing the :oe:meth:`OESystem::OEErrorHandler::SetLevel`
  method to change the error level for the current thread, using an
  :ref:`OEThreadLocal <OEPlatform_OEThreadLocal>` object to control message
  visibility.

  .. seealso::

     The **OpenEye** GitHub account contains an example of a
     `multi-threaded OMEGA implementation
     <https://github.com/oess/OEChemMP/blob/master/confgen.cpp>`_.

Documentation changes
--------------------------------------------------------------------------------

* :oe:func:`OEConfGen::OEOmegaGetLibraryRelease` and
  :oe:func:`OEConfGen::OEOmegaGetLibraryVersion` have been marked
  deprecated and will be removed in a future release. Please use
  :oe:func:`OEConfGen::OEOmegaGetRelease` and
  :oe:func:`OEConfGen::OEOmegaGetVersion` instead.



Omega TK 2.6.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEConfGen::OEOmegaGetLibraryRelease` and
  :oe:func:`OEConfGen::OEOmegaGetLibraryVersion` will now throw
  deprecation warnings and will be removed in a future release.
  We recommend using  :oe:func:`OEConfGen::OEOmegaGetRelease` and
  :oe:func:`OEConfGen::OEOmegaGetVersion` instead.


Omega TK 2.6.2
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* `SetSearchForceField` and
  `SetBuildForceField`
  no longer accept illegal inputs and throw a warning for incorrect
  force field types.

Documentation changes
--------------------------------------------------------------------------------

* `SetSearchForceField` and
  `SetBuildForceField`
  are now documented in more detail.


Omega TK 2.6.3
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* The problem of stripping off all SD data from a multi-conformer molecule
  has been fixed by introducing an overloaded version of the
  :oe:meth:`OEConfGen::OEFlipper` function that takes an
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>` object.

Minor bug fixes
--------------------------------------------------------------------------------

* operator() no longer returns ``true`` when
  it fails due to a timeout.

Documentation changes
--------------------------------------------------------------------------------

* Method operator() is now documented.


Omega TK 2.6.4
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Memory allocation for limited stack memory usage has been improved.


Omega TK 2.6.5
================================================================================

New features
--------------------------------------------------------------------------------

* New functionality has been added for generating a densely
  sampled set of conformers, as required during conformer free energy
  calculations using :ref:`OEFreeFormConf <OESz_OEFreeFormConf>`.

* Omega has used random coordinate embedding with distance-geometry refinement
  to generate initial 3D fragment and ring conformers for more than a decade.
  The pseudo-random number generator used has been upgraded to an
  implementation of the Mersenne Twister adapted from the work of Kohei Takeda.

* Omega now recognizes and adjusts ring sampling for macrocycles.  This
  improves reproduction of small and medium-sized macrocycle structures without
  increasing maximum ensemble sizes.

* A new class, :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>`, has been added that sets
  all options
  of the :ref:`OEOmega <OEConfGen_OEOmega>` object during its construction.  All the
  :ref:`OEOmega <OEConfGen_OEOmega>` methods with the same name as their
  :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` counterparts are now deprecated except
  for the options for ``fraglib``, which are still
  maintained through the :ref:`OEOmega <OEConfGen_OEOmega>` interface.

  The following table shows the older, deprecated functions and their
  new option replacements:

  =========================================================   ======================================================================== 
  Deprecated Method                                           New option Method
  ---------------------------------------------------------   ------------------------------------------------------------------------ 
  ``OEConfGen::OEOmega::SetCommentEnergy``                    ``OEConfGen::OEOmegaOptions::SetCommentEnergy``
  ``OEConfGen::OEOmega::GetCommentEnergy``                    ``OEConfGen::OEOmegaOptions::GetCommentEnergy``

  ``OEConfGen::OEOmega::SetIncludeInput``                     ``OEConfGen::OEOmegaOptions::SetIncludeInput``
  ``OEConfGen::OEOmega::GetIncludeInput``                     ``OEConfGen::OEOmegaOptions::GetIncludeInput``

  ``OEConfGen::OEOmega::SetRotorOffset``                      ``OEConfGen::OEOmegaOptions::SetRotorOffset``
  ``OEConfGen::OEOmega::GetRotorOffset``                      ``OEConfGen::OEOmegaOptions::GetRotorOffset``

  ``OEConfGen::OEOmega::SetSDEnergy``                         ``OEConfGen::OEOmegaOptions::SetSDEnergy``
  ``OEConfGen::OEOmega::GetSDEnergy``                         ``OEConfGen::OEOmegaOptions::GetSDEnergy``

  ``OEConfGen::OEOmega::SetWarts``                            ``OEConfGen::OEOmegaOptions::SetWarts``
  ``OEConfGen::OEOmega::GetWarts``                            ``OEConfGen::OEOmegaOptions::GetWarts``

  ``OEConfGen::OEOmega::SetBuildForceField``                  ``OEConfGen::OEOmegaOptions::SetBuildForceField``
  ``OEConfGen::OEOmega::GetBuildForceField``                  ``OEConfGen::OEOmegaOptions::GetBuildForceField``

  ``OEConfGen::OEOmega::SetCanonOrder``                       ``OEConfGen::OEOmegaOptions::SetCanonOrder``
  ``OEConfGen::OEOmega::GetCanonOrder``                       ``OEConfGen::OEOmegaOptions::GetCanonOrder``

  ``OEConfGen::OEOmega::SetFromCT``                           ``OEConfGen::OEOmegaOptions::SetFromCT``
  ``OEConfGen::OEOmega::GetFromCT``                           ``OEConfGen::OEOmegaOptions::GetFromCT``

  ``OEConfGen::OEOmega::SetFixRMS``                           ``OEConfGen::OEOmegaOptions::SetFixRMS``
  ``OEConfGen::OEOmega::GetFixRMS``                           ``OEConfGen::OEOmegaOptions::GetFixRMS``

  ``OEConfGen::OEOmega::SetFixDeleteH``                       ``OEConfGen::OEOmegaOptions::SetFixDeleteH``
  ``OEConfGen::OEOmega::GetFixDeleteH``                       ``OEConfGen::OEOmegaOptions::GetFixDeleteH``

  ``OEConfGen::OEOmega::SetFixUniqueMatch``                   ``OEConfGen::OEOmegaOptions::SetFixUniqueMatch``
  ``OEConfGen::OEOmega::GetFixUniqueMatch``                   ``OEConfGen::OEOmegaOptions::GetFixUniqueMatch``

  ``OEConfGen::OEOmega::SetFixMaxMatch``                      ``OEConfGen::OEOmegaOptions::SetFixMaxMatch``
  ``OEConfGen::OEOmega::GetFixMaxMatch``                      ``OEConfGen::OEOmegaOptions::GetFixMaxMatch``

  ``OEConfGen::OEOmega::SetStrictAtomTypes``                  ``OEConfGen::OEOmegaOptions::SetStrictAtomTypes``
  ``OEConfGen::OEOmega::GetStrictAtomTypes``                  ``OEConfGen::OEOmegaOptions::GetStrictAtomTypes``

  ``OEConfGen::OEOmega::SetStrictStereo``                     ``OEConfGen::OEOmegaOptions::SetStrictStereo``
  ``OEConfGen::OEOmega::GetStrictStereo``                     ``OEConfGen::OEOmegaOptions::GetStrictStereo``

  ``OEConfGen::OEOmega::SetEnumNitrogen``                     ``OEConfGen::OEOmegaOptions::SetEnumNitrogen``
  ``OEConfGen::OEOmega::GetEnumNitrogen``                     ``OEConfGen::OEOmegaOptions::GetEnumNitrogen``

  ``OEConfGen::OEOmega::SetEnumRing``                         ``OEConfGen::OEOmegaOptions::SetEnumRing``
  ``OEConfGen::OEOmega::GetEnumRing``                         ``OEConfGen::OEOmegaOptions::GetEnumRing``

  ``OEConfGen::OEOmega::SetSampleHydrogens``                  ``OEConfGen::OEOmegaOptions::SetSampleHydrogens``
  ``OEConfGen::OEOmega::GetSampleHydrogens``                  ``OEConfGen::OEOmegaOptions::GetSampleHydrogens``

  ``OEConfGen::OEOmega::SetEnergyWindow``                     ``OEConfGen::OEOmegaOptions::SetEnergyWindow``
  ``OEConfGen::OEOmega::GetEnergyWindow``                     ``OEConfGen::OEOmegaOptions::GetEnergyWindow``

  ``OEConfGen::OEOmega::SetEnergyRange``                      ``OEConfGen::OEOmegaOptions::SetEnergyRange``
  ``OEConfGen::OEOmega::GetEnergyRange``                      ``OEConfGen::OEOmegaOptions::GetEnergyRange``

  ``OEConfGen::OEOmega::SetMaxConfs``                         ``OEConfGen::OEOmegaOptions::SetMaxConfs``
  ``OEConfGen::OEOmega::GetMaxConfs``                         ``OEConfGen::OEOmegaOptions::GetMaxConfs``

  ``OEConfGen::OEOmega::SetMaxConfRange``                     ``OEConfGen::OEOmegaOptions::SetMaxConfRange``
  ``OEConfGen::OEOmega::GetMaxConfRange``                     ``OEConfGen::OEOmegaOptions::GetMaxConfRange``

  ``OEConfGen::OEOmega::SetMaxRotors``                        ``OEConfGen::OEOmegaOptions::SetMaxRotors``
  ``OEConfGen::OEOmega::GetMaxRotors``                        ``OEConfGen::OEOmegaOptions::GetMaxRotors``

  ``OEConfGen::OEOmega::SetMaxSearchTime``                    ``OEConfGen::OEOmegaOptions::SetMaxSearchTime``
  ``OEConfGen::OEOmega::GetMaxSearchTime``                    ``OEConfGen::OEOmegaOptions::GetMaxSearchTime``

  ``OEConfGen::OEOmega::SetRangeIncrement``                   ``OEConfGen::OEOmegaOptions::SetRangeIncrement``
  ``OEConfGen::OEOmega::GetRangeIncrement``                   ``OEConfGen::OEOmegaOptions::GetRangeIncrement``

  ``OEConfGen::OEOmega::SetRMSRange``                         ``OEConfGen::OEOmegaOptions::SetRMSRange``
  ``OEConfGen::OEOmega::GetRMSRange``                         ``OEConfGen::OEOmegaOptions::GetRMSRange``

  ``OEConfGen::OEOmega::SetRMSThreshold``                     ``OEConfGen::OEOmegaOptions::SetRMSThreshold``
  ``OEConfGen::OEOmega::GetRMSThreshold``                     ``OEConfGen::OEOmegaOptions::GetRMSThreshold``

  ``OEConfGen::OEOmega::SetSearchForceField``                 ``OEConfGen::OEOmegaOptions::SetSearchForceField``
  ``OEConfGen::OEOmega::GetSearchForceField``                 ``OEConfGen::OEOmegaOptions::GetSearchForceField``

  ``OEConfGen::OEOmega::SetTorsionDrive``                     ``OEConfGen::OEOmegaOptions::SetTorsionDrive``
  ``OEConfGen::OEOmega::GetTorsionDrive``                     ``OEConfGen::OEOmegaOptions::GetTorsionDrive``

  ``OEConfGen::OEOmega::SetDielectric``                       ``OEConfGen::OEOmegaOptions::SetDielectric``
  ``OEConfGen::OEOmega::GetDielectric``                       ``OEConfGen::OEOmegaOptions::GetDielectric``

  ``OEConfGen::OEOmega::SetExponent``                         ``OEConfGen::OEOmegaOptions::SetExponent``
  ``OEConfGen::OEOmega::GetExponent``                         ``OEConfGen::OEOmegaOptions::GetExponent``

  ``OEConfGen::OEOmega::SetFixMol``                           ``OEConfGen::OEOmegaOptions::SetFixMol``
  ``OEConfGen::OEOmega::GetFixMol``                           ``OEConfGen::OEOmegaOptions::GetFixMol``
  
  ``OEConfGen::OEOmega::SetFixFile``                          ``OEConfGen::OEOmegaOptions::SetFixFile``
  ``OEConfGen::OEOmega::ClearFixFile``                        ``OEConfGen::OEOmegaOptions::ClearFixFile``
  
  ``OEConfGen::OEOmega::SetFixQuery``                         ``OEConfGen::OEOmegaOptions::SetFixQuery``
  ``OEConfGen::OEOmega::SetFixSmarts``                        ``OEConfGen::OEOmegaOptions::SetFixSmarts``
  ``OEConfGen::OEOmega::GetFixSubSearch``                     ``OEConfGen::OEOmegaOptions::GetFixSubSearch``

  ``OEConfGen::OEOmega::SetTorLib``                           ``OEConfGen::OEOmegaOptions::SetTorLib``
  ``OEConfGen::OEOmega::GetTorLib``                           ``OEConfGen::OEOmegaOptions::GetTorLib``
  
  =========================================================   ======================================================================== 


Omega TK 2.6.6
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* The :ref:`OEFlipper <OEConfGen_OEFlipper>` function with ``forceFlip=false`` no
  longer flips 3D molecules if stereo is defined.

Minor bug fixes
--------------------------------------------------------------------------------

* Molecule titles have been added to some emitted warnings to aid in
  identifying problematic molecules.


Omega TK 2.6.7
================================================================================

.. |JCIM| replace:: *Journal of Chemical Information and Modeling*

New features
--------------------------------------------------------------------------------

* A new torsion library, based on the work of Guba et al. [Guba-2016]_, has
  been added.
  The :ref:`OETorLib <OEConfGen_OETorLib>` constructor now includes an optional
  parameter in the :oe:constns:`OEConfGen::OETorLibType` namespace to select
  either the original or new :oe:const:`OEConfGen::OETorLibType::GubaV21`
  torsion library. A new overload of the OEConfGen_SetTorsionLibrary method can also be used to
  change the torsion library.

Documentation changes
--------------------------------------------------------------------------------

* The function :ref:`OEFlipper <OEConfGen_OEFlipper>` now removes molecule coordinates
  during its processing. This behavior change was introduced in
  the 2017.Feb release.


Omega TK 2.7.0
================================================================================

* Minor internal improvements have been made.


Omega TK 2.8.0
================================================================================

New features (Preliminary API)
--------------------------------------------------------------------------------

The following new preliminary APIs have been added for macrocycle functionality in
the **Omega TK**:

* :ref:`OEMacrocycleOmega <OEConfGen_OEMacrocycleOmega>` and :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>`
  classes to generate a macrocycle molecule conformer ensemble

* :ref:`OEMacrocycleBuilder <OEConfGen_OEMacrocycleBuilder>` and :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>`
  classes to generate a single conformer structure of a macrocycle molecule

* ``OEConfGen::OEDuplicateScanner`` and ``OEConfGen::OEDuplicateScanOptions``
  classes to enable fast scanning and removal of duplicate conformers from a conformer ensemble

* :oe:func:`OEConfGen::OEIsMacrocycle` function to detect if a molecule contains a macrocycle

The following new preliminary APIs have been added to enhance small molecule conformer
generation functionality in the **Omega TK**:

* :ref:`OEMakeFragLib <OEConfGen_OEMakeFragLib>` class to generate a fragment library

* :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` and :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>` classes
  to generate small molecule conformers using a fragment library

* :ref:`OEConformerBuilder <OEConfGen_OEConformerBuilder>` class to generate a single conformer structure
  of a small molecule

* :ref:`OEFragBuilder <OEConfGen_OEFragBuilder>` and :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>`
  classes to generate fragment conformers using distance geometry.
  The :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class combines multiple
  options related to building a fragment library for both
  :ref:`OEMakeFragLib <OEConfGen_OEMakeFragLib>` and :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>`.

* :ref:`OETorDriver <OEConfGen_OETorDriver>` and :ref:`OETorDriveOptions <OEConfGen_OETorDriveOptions>` classes to
  generate small molecule conformer ensembles from torsion driving

* :ref:`OEFragOptions <OEConfGen_OEFragOptions>` class to store options related to generating
  a single fragment structure

* :ref:`OERingFragOptions <OEConfGen_OERingFragOptions>` class to store options related to generating
  a single ring fragment structure

* :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>` class to store options related to fixing part
  of the structure of small molecules during a conformational search

* :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` class to store options for ensemble pruning during
  a small molecule conformational search

* :oe:constns:`OEConfGen::OEFragBuilderMode` namespace to set up
  :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` for specific uses

New features
--------------------------------------------------------------------------------

New additions and modifications have been made to existing APIs to enhance small molecule
conformer generation functionality in **Omega TK**:

* Three new modes, :oe:const:`OEConfGen::OEOmegaSampling::Pose`,
  :oe:const:`OEConfGen::OEOmegaSampling::ROCS`, and
  :oe:const:`OEConfGen::OEOmegaSampling::FastROCS`, have been added to the
  :oe:constns:`OEConfGen::OEOmegaSampling` namespace.

* A new torsion library based on the work of Wolfgang Guba has been added.
  A new namespace, :oe:constns:`OEConfGen::OETorLibType`, has been introduced
  to provide options for the choice of torsion library. Additionally, the
  :ref:`OETorLib <OEConfGen_OETorLib>` constructor now takes a torsion type value
  from the :oe:constns:`OEConfGen::OETorLibType` namespace. Also, a new overload of the
  :oe:meth:`OEConfGen::OETorLib::SetTorsionLibrary` method has been added
  to allow setting the desired torsion library from the
  above-mentioned namespace.

* The :oe:constns:`OEConfGen::OEOmegaForceFieldType` namespace has been
  replaced by the :oe:constns:`OEFF::OEMMFFSheffieldFFType` namespace.
  The new namespace adds 4 new options for the
  force field used in the :ref:`OEOmega <OEConfGen_OEOmega>` class. These
  new options are based on a modified variation of the
  :ref:`OEMMFF94sParams <OEMolMMFF_OEMMFF94sParams>` parameters that prefers the
  appropriate axial/equatorial conformers for many molecules in
  :ref:`OEOmega <OEConfGen_OEOmega>`.

Major bug fixes
--------------------------------------------------------------------------------

* The SMILES string hash in the internal fragment library in the :ref:`OEOmega <OEConfGen_OEOmega>`
  class has been updated to reflect the proper canonicalization of the fragments.  This
  ensures that :ref:`OEOmega <OEConfGen_OEOmega>` will always find the fragment in the
  library if it exists.

* The default search force field in the :ref:`OEOmega <OEConfGen_OEOmega>` class has been changed to
  the newly introduced :oe:const:`OEFF::OEMMFFSheffieldFFType::MMFF94Smod_NOESTAT`
  type to generate more appropriate axial/equatorial conformers.

* An issue that caused the :ref:`OEOmega <OEConfGen_OEOmega>` class to not honor the parity bits
  on relative stereo marked rings has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue that caused the :ref:`OEOmega <OEConfGen_OEOmega>` class to report the same warning about
  atoms multiple times has been fixed.

Documentation changes
--------------------------------------------------------------------------------

The following C++ and Python examples have been added to demonstrate using the
new preliminary APIs:

* New examples have been added to the :ref:`section_examples_macrocycles` section
  that generate a macrocycle conformer ensemble or a single macrocycle conformer.

* A new example has been added to the :ref:`section_examples_fraglib` section
  that generates fragment libraries.

* A new example has been added to the :ref:`section_examples_torsion` section
  that generates a conformer ensemble by torsion driving from a given 3D structure.


Omega TK 2.9.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new method, :oe:meth:`OEConfGen::OEOmega::Build`, has been introduced that provides a
  proper return code on failure, unlike the operator().  Operator() was then deprecated.

* A new namespace, :oe:constns:`OEConfGen::OEOmegaReturnCode`, has been introduced that defines
  return codes for various API methods.

* A new function, :oe:func:`OEConfGen::OEGetOmegaError`, has been introduced that returns
  error descriptions corresponding to various **Omega** return codes.

* A new method, :oe:meth:`OEConfGen::OETorLib::GetTorRule`, has been introduced that returns
  the torsion rule corresponding to a rotatable bond.

* A new method, :oe:meth:`OEConfGen::OETorLib::HasTorRule`, has been introduced that determines
  whether a torsion rule is defined for a rotatable bond.

* A new function, :oe:func:`OEConfGen::OEGetTorValues`, has been introduced that provides
  torsion values from a torsion rule-defined :ref:`OESubSearch <OEChem_OESubSearch>` object.

* The following preliminary APIs, which were introduced in **Omega TK 2.8.0**, have been
  modified to return an ``unsigned`` return code instead of a ``bool``:

  * :oe:meth:`OEConfGen::OEConformerBuilder::Build`
  * :oe:meth:`OEConfGen::OEFragBuilder::Build`
  * :oe:meth:`OEConfGen::OEMacrocycleBuilder::Build`
  * :oe:meth:`OEConfGen::OEMacrocycleOmega::Build`
  * :oe:meth:`OEConfGen::OEMolBuilder::Build`
  * :oe:meth:`OEConfGen::OETorDriver::GenerateConfs`

  .. note::

     The change in the preliminary APIs mentioned above is a breaking change and needs to
     be addressed properly by scripts and code that use these APIs.  Since ``bool`` and ``unsigned``
     are mutually compatible, any scripts or code using these API methods may continue to function
     without a proper fix and may not give any runtime or compile-time error. However, the end results
     obtained from such scripts or codes could be incorrect.

* The following APIs have been modified to be ``const`` and some of their arguments
  have been modified to be ``const``:

  * :oe:meth:`OEConfGen::OEConformerBuilder::Build`
  * :oe:meth:`OEConfGen::OEFragBuilder::Build`
  * :oe:meth:`OEConfGen::OEMacrocycleBuilder::Build`
  * :oe:meth:`OEConfGen::OEMacrocycleOmega::Build`
  * :oe:meth:`OEConfGen::OEMakeFragLib::GenerateMissingFrags`
  * :oe:meth:`OEConfGen::OEMakeFragLib::GetMissingFrags`
  * :oe:meth:`OEConfGen::OEMolBuilder::Build`
  * operator()
  * :oe:func:`OEConfGen::OEIsMacrocycle`
  * :oe:meth:`OEConfGen::OETorDriveOptions::ExceedsMaxRotors`
  * :oe:meth:`OEConfGen::OETorDriver::GenerateConfs`

* The following APIs have been modified to return a ``bool`` instead of a ``void``:

  * :oe:meth:`OEConfGen::OEBuilderBase::AddFragLib`
  * :oe:meth:`OEConfGen::OETorLib::AddTorsionLibrary`
  * :oe:meth:`OEConfGen::OETorLib::SetTorsionLibrary`
  * :oe:meth:`OEConfGen::OETorLib::ResetTorsionLibrary`

Major bug fixes
--------------------------------------------------------------------------------

* An issue that caused an occasional Coulombic collapse for conformations of
  zwitterionic molecules generated with the :ref:`Macrocycle algorithm <section_macrocycle>`
  has been fixed.

* An issue that caused *Omega** to fail to produce conformations for molecules containing
  chiral nitrogen atom using macrocycle mode has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEConfGen::OEConformerBuilder::Build` no longer fails due to
  unspecified stereo in the input molecule.

* :oe:meth:`OEConfGen::OEConformerBuilder::Build` no longer generates more than
  one conformer in the output molecule.

* :oe:meth:`OEConfGen::OEConformerBuilder::Build` no longer writes anything in
  standard output.

* The default for :oe:meth:`EnumNitrogen<OEConfGen::OEMolBuilderOptions::GetEnumNitrogen>`
  in :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>` has
  been changed from :oe:const:`OEConfGen::OENitrogenEnumeration::All`
  to :oe:const:`OEConfGen::OENitrogenEnumeration::Unspecified` so
  that any user-specified stereo information is not lost by default.

* :oe:meth:`OEConfGen::OEMacrocycleOmega::Build` has been fixed to generate conformers in
  cases when a ``MaxConfs`` of 1 is requested.

* operator() now generates a title in the output
  even when the input molecule has no :ref:`OEMCMolBase <OEChem_OEMCMolBase>` title.

* operator() now produces a title in output
  conformers when :oe:meth:`OEConfGen::OEOmegaOptions::GetWarts` is ``false``.

* operator() now produces correct conformer coordinates
  when both :oe:meth:`OEConfGen::OEOmegaOptions::SetIncludeInput` and
  :oe:meth:`OEConfGen::OEMolBuilderOptions::SetCanonOrder` are set to be ``true``.

* **Omega** calculations no longer repeat an error message.

* :oe:meth:`OEConfGen::OEMakeFragLib::GenerateMissingFrags` no longer crashes
  with extreme energy window value.

* The torsion rule for ``[CH3:1][CX4H:2]([CH3])[CX4H2:3][!#1:4]`` in the ``default`` 
  torsion library has been improved.


Omega TK 2.9.1
================================================================================

New features
--------------------------------------------------------------------------------

* The following new methods have been added to the
  :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` class to make it more efficient
  with large macrocycles and energy-optimized structures:

  * SetEnergyThreshold
  * GetEnergyThreshold
  * :oe:meth:`OEConfGen::OESliceEnsembleOptions::SetMaxTerminalHeavy`
  * :oe:meth:`OEConfGen::OESliceEnsembleOptions::GetMaxTerminalHeavy`
  * SetSliceByEnergy
  * GetSliceByEnergy

* A new class, :ref:`OEConfSlicer <OEConfGen_OEConfSlicer>`, has been added that complements the
  :oe:meth:`OEConfGen::OESliceEnsemble` method. In addition, a new overload has
  been added to :oe:meth:`OEConfGen::OESliceEnsemble` that provides broader functionality by working
  with an :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` object.

* Deduplication of conformer ensembles in :ref:`OEMacrocycleOmega <OEConfGen_OEMacrocycleOmega>`
  has been improved by replacing two preliminary API methods,
  ``OEConfGen::OEMacrocycleOmegaOptions::SetDeduplicateScanOptions`` and
  ``OEConfGen::OEMacrocycleOmegaOptions::GetDeduplicateScanOptions``, with
  :oe:meth:`OEConfGen::OEMacrocycleOmegaOptions::SetSliceEnsembleOptions` and
  :oe:meth:`OEConfGen::OEMacrocycleOmegaOptions::GetSliceEnsembleOptions`, respectively.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEConfGen::OEMacrocycleOmega::Build` now generates conformer ensembles
  that are centered and aligned to each other, and with better deduplication.

* An issue that occasionally caused knotted conformations of
  some complex molecules generated with :oe:meth:`OEConfGen::OEOmega::Build`
  has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEConfGen::OEOmega::Build` now properly adds hydrogens to single
  heavy atom molecules.

* Two preliminary API classes, ``OEConfGen::OEDuplicateScanner`` and
  ``OEConfGen::OEDuplicateScanOptions``, have been removed.

* Two preliminary API methods, ``OEConfGen::OETorDriveOptions::SetIncludeInput`` and
  ``OEConfGen::OETorDriveOptions::GetIncludeInput``, have been removed.

* Defaults for :oe:meth:`OEConfGen::OEMolBuilderOptions::SetEnumNitrogen` and
  :ref:`SetSampleHydrogens <OEConfGen_SetSampleHydrogens>` in the
  :oe:const:`OEConfGen::OEOmegaSampling::Dense` mode have been changed
  from :oe:const:`OEConfGen::OENitrogenEnumeration::Unspecified` and ``false`` to
  :oe:const:`OEConfGen::OENitrogenEnumeration::All` and ``true``, respectively.

* An issue regarding the :oe:meth:`OEConfGen::OEOmegaOptions::SetEnergyWindow`
  not being properly honored for some molecules with :oe:meth:`OEConfGen::OEOmega::Build`
  has been fixed.

* Fragment conformations for ``CCN`` and ``CN`` have been updated in the built-in
  fragments library to properly reflect the tetrahedral geometry.

* Occasional failure to generate conformations for molecules containing chiral N=N
  or C=N bonds has been fixed.




.. _section_omega_releasenotes_4006:

Omega TK 4.0.0.6
================================================================================

* :oe:meth:`OEConfGen::OEMolBuilder::Build` no longer enumerates specified nitrogen
  when :oe:meth:`OEConfGen::OEMolBuilderOptions::GetEnumNitrogen` is
  :oe:const:`OEConfGen::OENitrogenEnumeration::Unspecified`.

.. _section_omega_releasenotes_400:

Omega TK 4.0.0
================================================================================

As part of the integration of **OEToolkits** and **OEApplications** into a single
release, the version number of **Omega TK** has been upgraded to 4.0.0
to make it consistent with that of the **OMEGA** application.

New features
--------------------------------------------------------------------------------

* **GPU-Omega**, a GPU-accelerated implementation of the torsion driving algorithm,
  is now available. This will make use of any suitable Nvidia GPU on
  supported Linux platforms by default for ``classic`` mode runs. It is advised to read the
  :ref:`GPU-Omega <chapter_omegagpuomega>` section of the documentation to ensure that
  your system meets all the prerequisites and that availability is understood for the
  different sampling modes. On systems that do not meet the requirements,
  **GPU-Omega** will be disabled and fall back to the CPU.

  **GPU-Omega** introduces the following new APIs:

  * :oe:meth:`OEConfGen::OETorDriveOptions::GetUseGPU`
  * :oe:meth:`OEConfGen::OETorDriveOptions::SetUseGPU`
  * :oe:func:`OEConfGen::OEOmegaIsGPUReady`

* The following APIs have been promoted from preliminary API to stable API status:

  * :ref:`OEMacrocycleOmega <OEConfGen_OEMacrocycleOmega>`
  * :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>`
  * :ref:`OEMacrocycleBuilder <OEConfGen_OEMacrocycleBuilder>`
  * :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>`
  * :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>`
  * :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>`
  * :ref:`OEConformerBuilder <OEConfGen_OEConformerBuilder>`
  * :ref:`OEFragBuilder <OEConfGen_OEFragBuilder>`
  * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>`
  * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>`
  * :ref:`OETorDriver <OEConfGen_OETorDriver>`
  * :ref:`OETorDriveOptions <OEConfGen_OETorDriveOptions>`
  * :ref:`OEFragOptions <OEConfGen_OEFragOptions>`
  * :ref:`OERingFragOptions <OEConfGen_OERingFragOptions>`
  * :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>`
  * :ref:`OEConfSlicer <OEConfGen_OEConfSlicer>`
  * :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>`
  * :oe:constns:`OEConfGen::OEFragBuilderMode`
  * :oe:constns:`OEConfGen::OEOmegaReturnCode`
  * :oe:func:`OEConfGen::OEGetOmegaError`
  * :oe:func:`OEConfGen::OEIsMacrocycle`

* The :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` class has been simplified and now
  consists of multiple sub-options: :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>`,
  :ref:`OETorDriveOptions <OEConfGen_OETorDriveOptions>`, :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>`,
  and :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>`.  The specific methods to set or
  get option values are now provided through these sub-option classes.

* A new abstract base class, :ref:`OEBuilderBase <OEConfGen_OEBuilderBase>`, has been added that
  contains the basic functionality of the builders that use a fragment library.

* The following new methods have been added to :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>`:

  * :oe:meth:`OEConfGen::OEConfFixOptions::GetAtomExpr`
  * :oe:meth:`OEConfGen::OEConfFixOptions::SetAtomExpr`
  * :oe:meth:`OEConfGen::OEConfFixOptions::GetBondExpr`
  * :oe:meth:`OEConfGen::OEConfFixOptions::SetBondExpr`

* Two new methods, :oe:meth:`OEConfGen::OEFragBuilderOptions::SetForceField` and
  :oe:meth:`OEConfGen::OEFragBuilderOptions::GetForceField`, have been added
  to the :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class.

* Two new methods, :oe:meth:`OEConfGen::OEMacrocycleBuilderOptions::SetRandomSeed` and
  :oe:meth:`OEConfGen::OEMacrocycleBuilderOptions::GetRandomSeed`, have been added
  to the :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>` class.

* The following new methods have been added to :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>`:

  * :oe:meth:`OEConfGen::OEMacrocycleOmegaOptions::GetEnergyWindow`
  * :oe:meth:`OEConfGen::OEMacrocycleOmegaOptions::SetEnergyWindow`
  * :oe:meth:`OEConfGen::OEMacrocycleOmegaOptions::GetMaxConfs`
  * :oe:meth:`OEConfGen::OEMacrocycleOmegaOptions::SetMaxConfs`

* A new method, :oe:meth:`OEConfGen::OEMolBuilder::Prep`, has been added to the
  :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` class to prepare molecules
  for building.

Minor bug fixes
--------------------------------------------------------------------------------

* The following methods now return ``bool``, instead of a ``void``:

  * :oe:meth:`OEConfGen::OEConfFixOptions::SetFixDeleteH`
  * :oe:meth:`OEConfGen::OEConfFixOptions::SetFixMaxMatch`
  * :oe:meth:`OEConfGen::OEConfFixOptions::SetFixMol`
  * :oe:meth:`OEConfGen::OEConfFixOptions::SetFixPredicate`
  * :oe:meth:`OEConfGen::OEConfFixOptions::SetFixRMS`
  * :oe:meth:`OEConfGen::OEConfFixOptions::SetFixSmarts`
  * :oe:meth:`OEConfGen::OEConfFixOptions::SetFixSubSearch`
  * :oe:meth:`OEConfGen::OEConfFixOptions::SetFixUniqueMatch`
  * :oe:meth:`OEConfGen::OEFragOptions::SetEnergyWindow`
  * :oe:meth:`OEConfGen::OEFragOptions::SetFragGen`
  * :oe:meth:`OEConfGen::OEFragOptions::SetFragKeep`
  * :oe:meth:`OEConfGen::OEFragOptions::SetRMS`
  * :oe:meth:`OEConfGen::OEFragOptions::SetTimeLimit`
  * :oe:meth:`OEConfGen::OEMacrocycleBuilderOptions::SetDielectricConst`
  * :oe:meth:`OEConfGen::OEMacrocycleBuilderOptions::SetRefTolerance`
  * :oe:meth:`OEConfGen::OEMacrocycleBuilderOptions::SetSkipRefinement`
  * :oe:meth:`OEConfGen::OEMacrocycleOmegaOptions::SetIterCycleSize`
  * :oe:meth:`OEConfGen::OEMacrocycleOmegaOptions::SetMaxIter`
  * :oe:meth:`OEConfGen::OEMolBuilderOptions::SetCanonOrder`
  * :oe:meth:`OEConfGen::OEMolBuilderOptions::SetEnumNitrogen`
  * :oe:meth:`OEConfGen::OEMolBuilderOptions::SetEnumRing`
  * :oe:meth:`OEConfGen::OEMolBuilderOptions::SetFromCT`
  * :oe:meth:`OEConfGen::OEMolBuilderOptions::SetSampleHydrogens`
  * :oe:meth:`OEConfGen::OEMolBuilderOptions::SetStrictAtomTypes`
  * :oe:meth:`OEConfGen::OERingFragOptions::SetStartFactor`
  * :oe:meth:`OEConfGen::OESliceEnsembleOptions::SetEnergyWindow`
  * :oe:meth:`OEConfGen::OESliceEnsembleOptions::SetEnergyRange`
  * :oe:meth:`OEConfGen::OESliceEnsembleOptions::SetMaxConfs`
  * :oe:meth:`OEConfGen::OESliceEnsembleOptions::SetMaxConfRange`
  * :oe:meth:`OEConfGen::OESliceEnsembleOptions::SetMaxTerminalHeavy`
  * :oe:meth:`OEConfGen::OESliceEnsembleOptions::SetRangeIncrement`
  * :oe:meth:`OEConfGen::OESliceEnsembleOptions::SetRMSThreshold`
  * :oe:meth:`OEConfGen::OESliceEnsembleOptions::SetRMSRange`
  * :oe:meth:`OEConfGen::OETorDriveOptions::SetCommentEnergy`
  * :oe:meth:`OEConfGen::OETorDriveOptions::SetMaxRotors`
  * :oe:meth:`OEConfGen::OETorDriveOptions::SetMaxSearchTime`
  * :oe:meth:`OEConfGen::OETorDriveOptions::SetRotorOffset`
  * :oe:meth:`OEConfGen::OETorDriveOptions::SetRotorPredicate`
  * :oe:meth:`OEConfGen::OETorDriveOptions::SetSDEnergy`
  * :oe:meth:`OEConfGen::OETorDriveOptions::SetTorLib`

* New arguments have been added to the :oe:meth:`OEConfGen::OEMacrocycleBuilder::Build` method
  for consistency with the other classes in **OMEGA**.

* The following preliminary APIs have been removed from the
  :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>`
  class:

  * ``OESliceEnsembleOptions::SetEnergyThreshold``
  * ``OESliceEnsembleOptions::GetEnergyThreshold``
  * ``OESliceEnsembleOptions::SetSliceByEnergy``
  * ``OESliceEnsembleOptions::GetSliceByEnergy``

* Two methods, ``OETorDriver::SetForceField`` and ``OETorDriver::GetForceField``, that were
  preliminary APIs, have been removed from the :ref:`OETorDriver <OEConfGen_OETorDriver>` class.

* Two methods, ``OEMolBuilder::SetForceField`` and ``OEMolBuilder::GetForceField``, that were
  preliminary APIs, have been removed from the :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` class.

* Two methods, ``OEFragBuilder::SetForceField`` and ``OEFragBuilder::GetForceField``, that were
  preliminary APIs, have been removed from the :ref:`OEFragBuilder <OEConfGen_OEFragBuilder>` class.

* Two methods, ``OEMakeFragLib::SetForceField`` and ``OEMakeFragLib::GetForceField``, that were
  preliminary APIs, have been removed from the :ref:`OEMakeFragLib <OEConfGen_OEMakeFragLib>` class.

* Two methods, ``OEConfFixOptions::ClearFixFile`` and ``OEConfFixOptions::SetFixFile``, that were
  preliminary APIs, have been removed from the :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>` class.
  Accordingly, :oe:meth:`OEConfGen::OEConfFixOptions::SetFixMol` has an overload that
  takes a molecule file as input.

* :oe:meth:`OEConfGen::OETorDriver::GenerateConfs` now errors out properly if the
  input molecule is not 3D.

* :oe:meth:`OEConfGen::OEOmega::Build` now properly de-duplicates the generated
  conformers in the case when :oe:meth:`MaxConfs<OEConfGen::OEOmegaOptions::SetMaxConfs>`
  is set to 0.

* :oe:meth:`OEConfGen::OEOmega::Build` no longer copies the molecule title to
  every conformer.

* :oe:func:`OEConfGen::OEGetOmegaError` now returns a value for each entry in the
  :oe:constns:`OEConfGen::OEOmegaReturnCode` namespace.

* :oe:meth:`OEConfGen::OEMakeFragLib::GenerateMissingFrags`
  and :oe:meth:`OEConfGen::OEFragBuilder::Build` now perform a de-duplication on the
  generated fragment conformers.

* :oe:meth:`OEConfGen::OEFragBuilder::Build` now returns an appropriate failure code
  if it fails due to lack of atom types.

* :oe:meth:`SampleHydrogens<OEConfGen::OEMolBuilderOptions::SetSampleHydrogens>` is now
  robust when the potential number of conformers is too high due to hydrogen sampling.

* Default values for the parameters in :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>`
  are now consistent with their respective counterparts in the **OMEGA** command line
  application.

* :oe:func:`OEConfGen::OEIsMacrocycle` has been improved to better identify macrocycles
  when hetero atoms are involved.

Documentation changes
--------------------------------------------------------------------------------

* A :ref:`GPU-Omega <chapter_omegagpuomega>` chapter has been added to the documentation.

* **OMEGA** examples have been updated to reflect the latest changes for all supported
  languages.

General Notices
--------------------------------------------------------------------------------

* In the C++ toolkit, **GPU-Omega** is not available on RHEL8 or Ubuntu18 in this release.



Omega TK 4.1.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------
* **GPU-Omega** now requires a minimum NVIDIA Driver version of 450.x and a
  minimum GPU compute capability of 3.5. See :ref:`section_supported_gpus_drivers`
  and :ref:`section_supported_gpus` for more details.
* Conformer generation using ``dense`` mode now defaults to running on the
  CPU instead of the GPU. The other torsion-driving sampling modes (``sparse``,
  ``rocs``, ``fastrocs``, and ``pose``) will still run on a GPU by default if one
  is available on a Linux platform. For details on how to run with ``dense``
  mode sampling on a GPU, see the :ref:`Usage<section_gpuomega_usage>` section
  of the **GPU-Omega** docs.

* A new class, :ref:`OEFlipperOptions <OEConfGen_OEFlipperOptions>`, has been added that defines parameters
  for specifying stereo centers and other options.

* :ref:`OEFlipper <OEConfGen_OEFlipper>` has been updated to take a molecule and an
  :ref:`OEFlipperOptions <OEConfGen_OEFlipperOptions>` value.
  The old version of :ref:`OEFlipper <OEConfGen_OEFlipper>`
  that takes five parameters has been deprecated.

* A new function, :ref:`OEFlipperStereoCenters <OEConfGen_OEFlipperStereoCenters>`, has been added that returns a number of
  undefined stereo centers in a molecule as interpreted by :ref:`OEFlipper <OEConfGen_OEFlipper>`.

Major bug fixes
--------------------------------------------------------------------------------
* A memory leak in **GPU-Omega** has been fixed.

* An issue with generating conformers on the CPU using child processes with the same
  :ref:`OEOmega <OEConfGen_OEOmega>` object has been fixed.

* **GPU-Omega** no longer throws an error when attempting to generate conformers with the same
  :ref:`OEOmega <OEConfGen_OEOmega>` object in child processes. Instead, it falls back to the CPU.
  To use **GPU-Omega** with child processes, each child must construct a new :ref:`OEOmega <OEConfGen_OEOmega>` object.

Minor bug fixes
--------------------------------------------------------------------------------
* :ref:`OEConfGen <OEConfGen_ClearFragLibs>` now clears **all** fragment
  libraries. Previous releases did not clear the internal shared fragment library
  (a shared memory library of fragments accrued while generating conformers with the same OEOmega object).

Documentation changes
--------------------------------------------------------------------------------

* :ref:`OEOmegaReturnCode <OEConfGen_OEOmegaReturnCode>` has been updated to reflect the current possible values.




Omega TK 4.1.1
================================================================================

*July 2021*

New features
-------------------------------------------------------------------------------

* Function :ref:`OEOmegaSystemHasGPU <OEConfGen_OEOmegaSystemHasGPU>` has been added to test
  for availability of a GPU.
  
Major bug fixes
--------------------------------------------------------------------------------
* A bug that caused a segmentation fault when zero was passed to the
  :ref:`SetMaxConfs <OEConfGen_SetMaxConfs>` method has been
  fixed. 

* And issue that prevented oeomega from using the GPU in child threads when
  :ref:`OEOmegaIsGPUReady <OEConfGen_OEOmegaIsGPUReady>` was called from the main thread has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue with stereo specificity of the imino group (=NH) not being retained in
  a macrocycle has been fixed.

* An issue with loss of relative stereo marked atoms in macrocycle mode has been fixed.




Omega TK 4.1.2
================================================================================

*Fall 2021*

Minor bug fixes
--------------------------------------------------------------------------------

* An issue with overwriting partial charges of atoms in input molecules has been fixed.  

* The :ref:`section_examples_stereo_and_torsion` example has been modified to use 
  :ref:`OEFlipperOptions <OEConfGen_OEFlipperOptions>`.

* An issue running :ref:`OEOmega <OEConfGen_OEOmega>` when both
  SetUseGPU  and
  :ref:`SetSampleHydrogens <OEConfGen_SetSampleHydrogens>` are set to `True`
  was fixed by disabling SetUseGPU
  in these cases.




Omega TK 4.2.0
================================================================================

New features
--------------------------------------------------------------------------------

* Support for consideration of MDL enhanced stereo collection
  information during isomer generation has been added.  :ref:`The OEFlipperOptions class <OEConfGen_OEFlipperOptions>` adds a
  new ``SetEnhancedStereo`` option
  to control consideration of explicit enhanced stereo groups defined by :ref:`OEGroupBase <OEChem_OEGroupBase>` information
  that may have been read from ``V3000`` the :ref:`OEFormat <oechem_OEFormat>` values indicating ``SDF`` structures or ``CXSMILES`` files.

* A new method, :ref:`SetFragBuilderMode <OEConfGen_OEMolBuilderOptions_SetFragBuilderMode>`, has been added
  that allows setting fragment building mode in the corresponding :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>`.

Minor bug fixes
--------------------------------------------------------------------------------

* Internal generic data tags applied to the ``flip-ee`` used for performance
  during the flipping activity are now stripped from the structures
  returned by :ref:`OEFlipper <OEConfGen_OEFlipper>` as this information is no longer relevant.




Omega TK 4.2.1
================================================================================

New features
--------------------------------------------------------------------------------

* The ability to fix a part of a molecule during conformer generation
  based on maximum common substructure (MCS) has been added. The following new methods
  have been added to the :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>`
  to enable this functionality:

    * :ref:`SetFixMCS <OEConfGen_OEConfFixOptions_SetFixMCS>`
    * :ref:`GetFixMCS <OEConfGen_OEConfFixOptions_GetFixMCS>`
    * :ref:`SetMCSFunc <OEConfGen_OEConfFixOptions_SetMCSFunc>`
    * :ref:`GetMCSFunc <OEConfGen_OEConfFixOptions_GetMCSFunc>`
    * :ref:`SetMCSType <OEConfGen_OEConfFixOptions_SetMCSType>`
    * :ref:`GetMCSType <OEConfGen_OEConfFixOptions_GetMCSType>`
    * :ref:`SetMCSMinAtoms <OEConfGen_OEConfFixOptions_SetMCSMinAtoms>`
    * :ref:`GetMCSMinAtoms <OEConfGen_OEConfFixOptions_GetMCSMinAtoms>`

* New methods :ref:`SetIgnoreStereo <OEConfGen_OEMolBuilderOptions_SetIgnoreStereo>`
  and :ref:`GetIgnoreStereo <OEConfGen_OEMolBuilderOptions_GetIgnoreStereo>` have been
  added to :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>` to allow
  continuation of conformer generation when specified stereo signatures in a molecule
  could not be honored.

* New methods :ref:`SetMaxEnumConfs <OEConfGen_OEMolBuilderOptions_SetMaxEnumConfs>`
  and :ref:`GetMaxEnumConfs <OEConfGen_OEMolBuilderOptions_GetMaxEnumConfs>` have been
  added to :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>` to allow
  specifying the  maximum number of conformers to be generated from ring enumeration,
  nitrogen enumeration, and/or hydrogen sampling.

* Verbose mode logging now reports torsion angles sampled, along with the rules,
  during torsion driving.

Minor bug fixes
--------------------------------------------------------------------------------

* Conformer generation with :ref:`OEOmega.Build <OEConfGen_OEOmega_Build>`
  or :ref:`OEMolBuilder.Build <OEConfGen_OEMolBuilder_Build>` now fails correctly
  when specified stereo signatures on a molecule cannot be honored. The existing 
  behavior, to carry on even if stereo signatures could not be honored, can be
  obtained by setting :ref:`IgnoreStereo <OEConfGen_OEMolBuilderOptions_SetIgnoreStereo>`
  to ``true``.

* Ring fragment building during :ref:`OEOmega.Build <OEConfGen_OEOmega_Build>`,
  :ref:`OEFragBuilder.Build <OEConfGen_OEFragBuilder_Build>`,
  :ref:`OEMolBuilder.Build <OEConfGen_OEMolBuilder_Build>`, or
  :ref:`GenerateMissingFrags <OEConfGen_OEMakeFragLib_GenerateMissingFrags>`
  now properly honors the :ref:`SetFragKeep <OEConfGen_OEFragOptions_SetFragKeep>`
  parameter regarding the maximum number of generated fragment conformers to be kept.





Omega TK 4.2.2
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The OEOmega method :ref:`Build <OEConfGen_OEOmega_Build>`
  will now fail when ``MCS matching`` is requested but a corresponding ``FixMol``
  has not been set. 




Omega TK 5.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* The default fragment library for  :ref:`OEOmega<OEConfGen_OEOmega>`
  and :ref:`OEMolBuilder<OEConfGen_OEMolBuilder>` has been updated. The new
  fragment library consists of over 580 K fragments, replacing the previous
  library with ~80 K fragments.

* Three new force fields have been added and can be used with
  :ref:`OEMolBuilder<OEConfGen_OEMolBuilder>` and :ref:`OETorDriver<OEConfGen_OETorDriver>`
  in :ref:`OEOmega<OEConfGen_OEOmega>`:

    * :ref:`SAGE <OEConfGen_OEOmegaForceFieldType_SAGE>`
    * :ref:`SAGE_NOESTAT <OEConfGen_OEOmegaForceFieldType_SAGE_NOESTAT>`
    * :ref:`SAGE_SHEFF <OEConfGen_OEOmegaForceFieldType_SAGE_SHEFF>`

* The behavior of :ref:`OEFlipperOptions <OEConfGen_OEFlipperOptions>` has changed.
  New flags have been added
  to :ref:`OEFlipperOptions <OEConfGen_OEFlipperOptions>`,
  facilitating more complete decoupling of individual flags and
  more selective enumeration of specific stereocenter classes and environments
  than was previously possible.

* A new option class,
  :ref:`OEFlipperClassicOptions <OEConfGen_OEFlipperClassicOptions>`,
  has been added to allow a detailed
  comparison of the new flag behaviors with the previous OEFlipper enumeration behavior.
  This class will be deprecated in a future toolkit release.

* The internal algorithm for storage and usage of torsion rules in
  :ref:`OETorLib<OEConfGen_OETorLib>` has been modified to improve performance
  when working with a library containing a large set of rules.

* A new return code :ref:`FailedCharges <OEConfGen_OEOmegaReturnCode_FailedCharges>` has been
  added to :ref:`OEOmegaReturnCode <OEConfGen_OEOmegaReturnCode>` to indicate failures due to partial charge assignment.

Minor bug fixes
--------------------------------------------------------------------------------

* The order of torsion rules in the default
  :ref:`OETorLib<OEConfGen_OETorLib>` has been changed to ensure that a
  specific rule is not ignored due to the presence of a more generic rule.




Omega TK 5.1.0
================================================================================

New features
--------------------------------------------------------------------------------
* A new **Flipper** option has been added to enumerate internally perceived 
  relative stereocenters (e.g., 1,4-disubstituted cyclohexanes).
  See :ref:`SetEnumRelativeAtomStereo<OEConfGen_OEFlipperOptions_SetEnumRelativeAtomStereo>`.

Minor bug fixes
--------------------------------------------------------------------------------
* Stereochemistry of input molecules is now respected more consistently
  in :ref:`OEMacrocycleBuilder <OEConfGen_OEMacrocycleBuilder>`.

* For :ref:`SetMacroCycOptions<OEConfGen_OEFragBuilderOptions_SetMacroCycOptions>`
  in :ref:`OEFragBuilderOptions<OEConfGen_OEFragBuilderOptions>`, defaults for :ref:`SetFragGen <OEConfGen_OEFragOptions_SetFragGen>`,
  :ref:`SetFragKeep <OEConfGen_OEFragOptions_SetFragKeep>`, and
  :ref:`SetStartFactor <OEConfGen_OERingFragOptions_SetStartFactor>`  have been
  changed to more appropriate values of 50000, 1024, and 20, respectively.

* An issue with the order of loading rules to an existing torsion
  library with :ref:`AddTorsionLibrary<OEConfGen_OETorLib_AddTorsionLibrary>`
  has been fixed.

* A duplicate entry from the ``GUBA`` torsion library has been removed.





Omega TK 6.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* The following new methods have been added to :ref:`OETorDriveOptions <OEConfGen_OETorDriveOptions>`
  to enable use of Thompson sampling, instead of exhaustive sampling, of torsion angles during
  torsion driving. Use of Thompson sampling is especially useful, being significantly faster
  without losing quality, in generating smaller ensembles as obtained with the
  :ref:`FastROCS <OEConfGen_OEOmegaSampling_FastROCS>` or :ref:`ROCS <OEConfGen_OEOmegaSampling_ROCS>`
  modes.

  * :ref:`GetUseThompson<OEConfGen_OETorDriveOptions_GetUseThompson>`
  * :ref:`SetUseThompson<OEConfGen_OETorDriveOptions_SetUseThompson>`
  * :ref:`GetThompsonOptions<OEConfGen_OETorDriveOptions_GetThompsonOptions>`
  * :ref:`SetThompsonOptions<OEConfGen_OETorDriveOptions_SetThompsonOptions>`

* A new class, :ref:`OEThompsonOptions<OEConfGen_OEThompsonOptions>`, has been added that
  enables controlling Thompson sampling during torsion driving.

* Generation of a single conformer with :ref:`OEConformerBuilder<OEConfGen_OEConformerBuilder>`
  has been modified to use Thompson sampling.

Minor bug fixes
--------------------------------------------------------------------------------
* User-defined values passed through :ref:`SetEnergyWindow<OEConfGen_OESliceEnsembleOptions_SetEnergyWindow>`,
  :ref:`SetMaxConfs<OEConfGen_OESliceEnsembleOptions_SetMaxConfs>`, and
  :ref:`SetRMSThreshold<OEConfGen_OESliceEnsembleOptions_SetRMSThreshold>`
  are now properly accounted for, even when the corresponding defaults are range-based.

* Molecule titles are retained when :ref:`Build<OEConfGen_OEOmega_Build>` fails in
  :ref:`OEOmega<OEConfGen_OEOmega>` with ``fails to build structure from CT``.

* A verbose log is provided for fragments that fail when :ref:`Build<OEConfGen_OEOmega_Build>` fails in
  :ref:`OEOmega<OEConfGen_OEOmega>` with ``fails to build structure from CT``.

* The :ref:`OEOmegaIsGPUReady <OEConfGen_OEOmegaIsGPUReady>` function has been safeguarded from a rare crash.
  The function has also been updated to check not only for device 0,
  but for devices from 0 to 100.



Omega TK 6.1.0
================================================================================

New Features
--------------------------------------------------------------------------------

* The new methods :ref:`SetOverlayRMS<OEConfGen_OESliceEnsembleOptions_SetOverlayRMS>` and
  :ref:`GetOverlayRMS<OEConfGen_OESliceEnsembleOptions_GetOverlayRMS>` have been added to 
  :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>`, enabling conformer slicing
  with in-place RMSD calculation between conformers, with :ref:`OEConfSlicer <OEConfGen_OEConfSlicer>`
  and :ref:`OESliceEnsemble <OEConfGen_OESliceEnsemble>`.

Minor Bug Fixes
--------------------------------------------------------------------------------

* :ref:`OEOmega <OEConfGen_OEOmega>` now properly places carboxylic acids in cis
  configuration when hydrogen sampling is not performed.

* All conformers generated with :ref:`OEMacrocycleOmega<OEConfGen_OEMacrocycleOmega>`
  now properly set the dimensionality of the conformers to 3.




Omega TK 6.1.1
================================================================================

Minor Bug Fixes
--------------------------------------------------------------------------------

* The default value and the lower range for :ref:`MaxTrials<OEConfGen_OEThompsonOptions_SetMaxTrials>`
  in :ref:`OEThompsonOptions<OEConfGen_OEThompsonOptions>` have been changed from
  ``0`` to ``1``.


.. quacpactk toolkit documentation master file

#################################
Quacpac Toolkit |quacpac_version|
#################################

..  oe:language:: python

    .. toctree::
       :maxdepth: 3

       theory
       examples
       selected_examples_python
       api
       releasenotes/index

..  oe:language:: c++ csharp java

    .. toctree::
       :maxdepth: 3

       theory
       examples
       api
       releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _quacpac_part_theory:

*******************
Theory
*******************

.. toctree::
   :maxdepth: 3

   quacpactheory
   tautomerstheory
   pkatypertheory
   molchargetheory
   bondordertheory


.. |product|   replace:: Quacpac TK


.. _chapter_quacpactheory:

********************************************************************************
Introduction to |product|
********************************************************************************

The chemistry of molecular interactions is a matter of shape and
electrostatics, but doing electrostatics poorly is worse than doing none at
all; accurate charges are required. Even the best charge models are useless
if  protonation states are wrong. |product| attempts to offer everything
necessary to do charges correctly. It includes pKa and tautomer enumeration
in order to get correct protonation states, partial charges using multiple
models that cover a range of speed and accuracy, and electrostatic potential
map construction and storage. 


.. _chapter_tautomerstheory:

********************************************************************************
`tautomers` 
********************************************************************************

When dealing with tautomers there are four primary tasks to be addressed. These
include: 

- Generating a single representative tautomer suitable for molecular visualization

- Generating a list of tautomers expected to be present in aqueous phase

- Generating a unique (canonical) representation for a set of tautomers 

- Generating a substantial list of most possible tautomers suitable for input
  to further calculations.

Each of these four tasks is covered in a section below. In every case, the
tautomerization can be handled alone, but it is generally more useful to handle
tautomerization in conjunction with ionization. Each function includes the
potential for pKa normalization alongside the tautomer normalization or
enumeration.

.. _section_tautomer_visualization:

Visualization
================================================================================

While the unique or canonical tautomer generated above is useful for storage in
a database, they do not necessarily represent a low-energy tautomer suitable
for visualization by modelers and chemists.  In order to generate a structure
suitable for visualization, we recommend you use the function
:oe:func:`OEProton::OEGetReasonableProtomer`.  This function sets the molecule
into a low-energy, neutral-pH, aqueous-phase tautomeric state that should be
pleasing for visualization in a scientific setting.

.. _section_reasonable_tautomer_ensemble:

Reasonable Tautomer Ensemble
================================================================================

In the course of molecular modeling, it is often desirable to generate a small
ensemble of low-energy, neutralpH, aqueous-phase tautomers.  The function
:oe:func:`OEProton::OEGetReasonableTautomers` returns such an ensemble. In
order to generate low-energy tautomers reliably, the function works with a form
of the molecule that has formal charges removed. By default, each tautomer's
ionization state is set to a neutral pH form, but ionization states are not
enumerated.

The following depictions show some examples of tautomers that are favored as
"reasonable":

- Conversion of carboxylates to diols and nitros to di-hydroxy
  amines is very unfavorable. 

  .. image:: quacpactk/images/canonical-tautomer-01.*
     :width: 600pt

- Generation of unnecessary, non-dative, formal charges is
  unfavorable.

  .. image:: quacpactk/images/canonical-tautomer-02.*
     :width: 600pt

  .. image:: quacpactk/images/canonical-tautomer-03.*
     :width: 600pt

- Exocyclic bonds adjacent to aromatic rings are accounted for.

  .. image:: quacpactk/images/canonical-tautomer-04.*
     :width: 600pt

- Priority is given to aliphatic double bond positions.

  .. image:: quacpactk/images/canonical-tautomer-05.*
     :width: 600pt

  .. _section_canonicalization:

Canonicalization
================================================================================

The :oe:func:`OEProton::OEGetUniqueProtomer` function is used for
canonicalizing the tautomeric forms of a small molecule.  Canonicalization
converts any of the tautomeric forms of a given molecule into a single unique
representation and removes all formal charges that can be appropriately
neutralized. This is useful for database registration where alternate
representations of tautomeric compounds often leads to duplicate entries in a
database.

It is important to remember that a time limit cannot be used to control a 
canonical process as it might lead to hardware dependent behavior. Thus the
identification of a unique protomer can take significant time when the 
size of the largest contiguous tautomeric atoms approaches or exceeds 30 atoms.

The tautomer returned by :oe:func:`OEProton::OEGetUniqueProtomer`
as the "canonical" representation often is not the
physiologically preferred form. If a representative form is necessary, please use the 
functions referred to in the :ref:`section_tautomer_visualization` section above. If an ensemble
of biologically relevant tautomers are necessary, please see the functions
in the :ref:`section_reasonable_tautomer_ensemble` section above.

:oe:func:`OEProton::OEGetUniqueProtomer` is not a conformer generation
function and will not create coordinates for molecules that are read
in with no coordinates. When used on molecules with three-dimensional
coordinates, :oe:func:`OEProton::OEGetUniqueProtomer` attempts to
place hydrogens in a reasonable manner. However,
:oe:func:`OEProton::OEGetUniqueProtomer` does not modify the
heavy-atom coordinates of the molecule. In cases where the change in
tautomer-state dictates a change in conformation, one will need to use
a conformer-generation tool (such as OMEGA) to generate reasonable
conformations for the output from `tautomers`. We recommend that in
the preparation of small-molecules for study, charge-state and
tautomer enumeration be performed before conformer generation.

Complete Enumeration
================================================================================

The :oe:func:`OEProton::OEEnumerateTautomers` function is the core algorithm
used to implement all functions listed above. It is useful for
enumerating the tautomeric forms of a small molecule. Using the parameters in
:ref:`OETautomerOptions <OEProton_OETautomerOptions>` a user can control the behavior of the
:oe:func:`OEProton::OEEnumerateTautomers` to yield the behavior for their particular
application.

It is recommended that before passing a molecule to :oe:func:`OEProton::OEEnumerateTautomers`
that first any dative bonds are normalized to the hypervalent form using
:oe:func:`OEProton::OEHypervalentNormalization` and second, formal charges are
removed using :oe:func:`OEProton::OERemoveFormalCharge`. These two steps improve
the tautomers that are returned. 

Tautomer generation is a combinatorial process and the time and memory requirements
can grow quite rapidly. There are two mechanisms to help a use control
this growth. First, the number of tautomers generated and the number of tautomers
returned can be controlled with the :oe:meth:`OEProton::OETautomerOptions::SetMaxTautomersGenerated`
and :oe:meth:`OEProton::OETautomerOptions::SetMaxTautomersToReturn` respectively. Please be
aware that if you require that few tautomers be generated, it is possible that no low
energy tautomers will be generated.  Second, one can limit the time the algorithm 
spends generating tautomers for each molecule using :oe:meth:`OEProton::OETautomerOptions::SetMaxSearchTime`.

:oe:func:`OEProton::OEEnumerateTautomers` is not a conformer generation
function and will not create coordinates for molecules that are read
in with no coordinates. When used on molecules with three-dimensional
coordinates, :oe:func:`OEProton::OEEnumerateTautomers` attempts to
place hydrogens in a reasonable manner. However,
:oe:func:`OEProton::OEEnumerateTautomers` does not modify the
heavy-atom coordinates of the molecule. In cases where the change in
tautomer-state dictates a change in conformation, one will need to use
a conformer-generation tool (such as OMEGA) to generate reasonable
conformations for the output from `tautomers`. We recommend that in
the preparation of small-molecules for study, charge-state and
tautomer enumeration be performed before conformer generation.



.. _chapter_pkatypertheory:

********************************************************************************
`pkatyper` - Ligand pKa
********************************************************************************

Introduction
================================================================================

Assessment of ligand pKas can be broken into two phases. The first phase is
enumeration of the protonation states of interest, and the second phase is
assigning a pKa value to each of these states. An intermediate phase of
assigning microscopic pKas to each of the atomic-deprotonations may also be
considered.

It  is common in the course of modeling small-molecules to explore the
conformational ensemble of the small molecule. Often structures as high as
5-8 kcal/mol above the aqueous ground-state can be important to biological
processes. It is also appropriate to enumerate a protonation-state ensemble
of the small molecule.

Similar to :ref:`chapter_tautomerstheory`, OpenEye has a solution for enumerating reasonable
protonation states, but not for assessing the energetics of the state (e.g.
assigning a pKa value). OpenEye's solution for pKa enumeration seeks to
enumerate all of the pKa states that fall roughly in the pH range of 2-14 in
aqueous  solvent.  This range of pKa values generates an ensemble that
includes the ground-state plus all charge states within 8 kcals/mol :math:`\Delta G`.
This value was chosen to correspond to the similar range that is often used
for generating conformational ensembles of small molecules. 

Theory
================================================================================

`pkatyper` enumerates charge states based on primary, secondary and tertiary
atom types of each atom in a molecule. The primary atom type is based on the
atom's group and its valence. The primary atom-type defines the atom's basic
propensity to support a formal charge. The secondary atom-type is defined by
the atom-type of the neighbors for each atom. These secondary atom-types,
such as aromaticity, alpha-beta unsaturation, or electronegative-groups,
modulate  each  atom's basic propensity to support formal charges. The
tertiary atom-types assess the effects of nearby formal charges on a given
atom's formal charge. The combination of the primary, secondary and tertiary
atom-types determine which formal charge states are allowed for each atom in
a molecule. The primary and secondary atom-types are determined once, while
the tertiary atom-types are determined as part of the enumeration process.

`pkatyper` is a rudimentary approach to pKa prediction. While pkatyper is not
suited for prediction of absolute pKas, it is quite amenable to enumeration
of all reasonable charge states of a very wide variety of small-molecule
chemistries.

`pkatyper`  is  not  a  conformer generation program and will not create
coordinates for molecules that are read in without coordinates. When used on
molecules with three-dimensional coordinates, `pkatyper` attempts to place new
hydrogens in a reasonable manner. However, `pkatyper` does not modify the
heavy-atom  coordinates  of the molecule. In cases where the change in
protonation-state dictates a change in conformation, one will need to use a
conformer-generation  tool  (such  as  OMEGA)  to  generate reasonable
conformations  for  the  output  from  `pkatyper`. We recommend that in
preparation  of  small-molecules  for study, charge-state and tautomer
enumeration be performed before conformer generation.

In the future, OpenEye will release a product which assigns a pKa value to
each of the enumerated states.


.. _OEMolAM1BCCCConstants:

*******************
OEMolAM1 Constants
*******************

.. oe:namespace:: OEAM1BCC

.. toctree::

   OEBCCType


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEAM1BCC

.. oe:constnamespace:: OEBCCType

   This namespace contains constants which define the type of bond charge 
   correction models that can be used for :oe:func:`OEAM1BCC::OEBCCPartialCharges` 
   calculation.

   .. oe:constant:: AM1
   
      AM1 semi-empirical method. 

   .. oe:constant:: PM3
   
      PM3 semi-empirical method.




.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEAM1BCC

.. meta::
   :keywords: OEBCCPartialCharges

..  _OEAM1BCC_OEBCCPartialCharges:

.. oe:function:: OEBCCPartialCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBCCPartialCharges(OEChem::OEMolBase& mol,
                                  unsigned int BCCModel = OEBCCType::AM1,
                                  bool permissive = false, bool verbose = false)

   .. oe:language:: python

      .. oe:api:: python

         OEBCCPartialCharges(mol: Union[OEGraphMol,OEMol,OEQMol],
                             BCCModel: int, permissive: bool = False,
                             verbose: bool = False) -> bool

   This function calculates the bond correction partial charges on the 
   specified molecule. Calculated charges are set as the partial charges
   of the molecule.

   *mol*
      Molecule to calculate BCC partial charges.

   *BCCModel*
      Bond charge correction semi-empirical model defined in  
      :oe:constns:`OEAM1BCC::OEBCCType` namespace

   *permissive*
   	  TODO - Need help.

   *verbose*
   	  Flag if verbose information should be provided



.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEAM1BCC

.. meta::
   :keywords: OESymmetrizePartialCharges

..  _OEAM1BCC_OESymmetrizePartialCharges:

.. oe:function:: OESymmetrizePartialCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESymmetrizePartialCharges(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OESymmetrizePartialCharges(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   This function makes the partial charges on the molecule symmetric
   based on molecule topology.



*******************************************************************************
OEAM1BCC Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEBCCPartialCharges
   OESymmetrizePartialCharges


.. oe:namespace:: OEMolAM1

.. meta::
   :keywords: OEAM1, AM1

.. _OEMolAM1_OEAM1:

.. oe:class:: OEAM1

   .. oe:api::

      class OEAM1 : public OEMolPotential::OEMolFunc1

   .. note::

      This is a low level api class that allows access to advanced 
      functionality from semi-empirical method calculations. It is recommended
      that you use the high level api method 
      :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>` 
      with :ref:`OEAM1Charges <OEProton_OEAM1Charges>` options to assign AM1 charges
      on a molecule.

   The :ref:`OEAM1 <OEMolAM1_OEAM1>` class calculates Mulliken-type partial
   charges and other relevant quantities in a molecule using AM1 type
   semi-empirical quantum mechanical methods.

   The input must be a 3D molecule, and the AM1 parameters must be 
   available for each atom type in the molecule.

   .. seealso:
      :ref:`chapter_molchargetheory` for a description of AM1

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`  
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The :ref:`OEAM1 <OEMolAM1_OEAM1>` class defines the following public methods:
    * :oe:meth:`CalcAM1<OEMolAM1::OEAM1::CalcAM1>`
    * :oe:meth:`GetOptions<OEMolAM1::OEAM1::GetOptions>`
    * :oe:meth:`GetResults<OEMolAM1::OEAM1::GetResults>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAM1(const OEAM1Options& argOptions = OEAM1Options())
            OEAM1(const OEAM1&)

      .. oe:language:: python

         .. oe:api:: python

            OEAM1(argOptions: OEAM1Options = OEMolAM1_OEAM1Options()) -> OEAM1
            OEAM1(arg2: OEAM1) -> OEAM1

      Default and copy constructors.

      Constructs an :ref:`OEAM1 <OEMolAM1_OEAM1>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAM1 &operator=(const OEAM1 &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: CalcAM1

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CalcAM1(OEAM1Results&, const OEMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            CalcAM1(argResults: OEAM1Results,
                    argMolecule: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Performs AM1 calculation on the specified molecule and fills up 
      the specified :ref:`OEAM1Results <OEMolAM1_OEAM1Results>` with calculated results.
      Returns ``false`` if calculation was not successful.

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEAM1Options& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEAM1Options

      Returns a reference to the :ref:`OEAM1Options <OEMolAM1_OEAM1Options>`
      instance as currently set for this :ref:`OEAM1 <OEMolAM1_OEAM1>`.

   .. oe:method:: GetResults

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetResults(OEAM1Results&) const

      .. oe:language:: python

         .. oe:api:: python

            GetResults(argResults: OEAM1Results) -> bool

      Fills up the specified :ref:`OEAM1Results <OEMolAM1_OEAM1Results>` with results
      from the last calculation. Returns ``false`` if a valid set of results
      does not exist.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolAM1

.. meta::
   :keywords: OEAM1Options, AM1Options

.. _OEMolAM1_OEAM1Options:

.. oe:class:: OEAM1Options

   .. oe:api::

      class OEAM1Options : public OESystem::OEOptions

   This class provides an interface to setup options required for 
   :ref:`OEAM1 <OEMolAM1_OEAM1>` calculations.
   
   The :ref:`OEAM1Options <OEMolAM1_OEAM1Options>` class defines the following public methods:
    * :oe:meth:`GetMaxScfIter<OEMolAM1::OEAM1Options::GetMaxScfIter>`
    * :oe:meth:`GetNumericGradDelta<OEMolAM1::OEAM1Options::GetNumericGradDelta>` 
    * :oe:meth:`GetSCFTolerance<OEMolAM1::OEAM1Options::GetSCFTolerance>`
    * :oe:meth:`GetSemiMethod<OEMolAM1::OEAM1Options::GetSemiMethod>`
    * :oe:meth:`SetMaxScfIter<OEMolAM1::OEAM1Options::SetMaxScfIter>`
    * :oe:meth:`SetNumericGradDelta<OEMolAM1::OEAM1Options::SetNumericGradDelta>` 
    * :oe:meth:`SetSCFTolerance<OEMolAM1::OEAM1Options::SetSCFTolerance>`
    * :oe:meth:`SetSemiMethod<OEMolAM1::OEAM1Options::SetSemiMethod>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAM1Options()
            OEAM1Options(const OEAM1Options&)

      .. oe:language:: python

         .. oe:api:: python

            OEAM1Options() -> OEAM1Options
            OEAM1Options(arg2: OEAM1Options) -> OEAM1Options

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAM1Options &operator=(const OEAM1Options &)

      Assignment operator.

   .. oe:method:: GetMaxScfIter

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxScfIter() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxScfIter() -> int

      Gets the maximum number of self-consistent field iterations to be used.

   .. oe:method:: GetNumericGradDelta

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetNumericGradDelta() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumericGradDelta() -> float

      Gets the current value of the numerical gradients delta to be
      used for gradients calculation.

   .. oe:method:: GetSCFTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSCFTolerance() const

      .. oe:language:: python

         .. oe:api:: python

            GetSCFTolerance() -> float

      Gets the current value of the self-consistent field calculation tolerance.

   .. oe:method:: GetSemiMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSemiMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetSemiMethod() -> int

      Gets the current value of the semi-empirical method to be used.

   .. oe:method:: SetMaxScfIter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxScfIter(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxScfIter(value: int) -> bool

      Sets the maximum number of self-consistent field iterations to be used.

   .. oe:method:: SetNumericGradDelta

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNumericGradDelta(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetNumericGradDelta(value: float) -> bool

      Sets the value of the numerical gradients delta to be
      used for gradients calculation.

   .. oe:method:: SetSCFTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSCFTolerance(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetSCFTolerance(value: float) -> bool

      Sets the value of the self-consistent field calculation tolerance.

   .. oe:method:: SetSemiMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSemiMethod(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetSemiMethod(value: int) -> bool

      Sets the semi-empirical method to be used for the calculations. 
      The default is :oe:const:`OEMolAM1::OEMethodType::AM1`. Alternatives are
      defined in the :oe:constns:`OEMolAM1::OEMethodType` namespace.



.. oe:namespace:: OEMolAM1

.. meta::
   :keywords: OEAM1Results, AM1Results

.. _OEMolAM1_OEAM1Results:

.. oe:class:: OEAM1Results

   .. oe:api::

      class OEAM1Results

   This class represents :ref:`OEAM1 <OEMolAM1_OEAM1>` calculation results.

   The :ref:`OEAM1Results <OEMolAM1_OEAM1Results>` class defines the following public methods:
    * :oe:meth:`GetAtomicBondOrder<OEMolAM1::OEAM1Results::GetAtomicBondOrder>`
    * :oe:meth:`GetBondOrder<OEMolAM1::OEAM1Results::GetBondOrder>`
    * :oe:meth:`GetBondOrders<OEMolAM1::OEAM1Results::GetBondOrders>`
    * :oe:meth:`GetCharges<OEMolAM1::OEAM1Results::GetCharges>` 
    * :oe:meth:`GetEnergy<OEMolAM1::OEAM1Results::GetEnergy>`
    * :oe:meth:`GetNumSCFCycles<OEMolAM1::OEAM1Results::GetNumSCFCycles>`
    * :oe:meth:`IsConverged<OEMolAM1::OEAM1Results::IsConverged>` 

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAM1Results()
            OEAM1Results(const OEAM1Results&)

      .. oe:language:: python

         .. oe:api:: python

            OEAM1Results() -> OEAM1Results
            OEAM1Results(arg2: OEAM1Results) -> OEAM1Results

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAM1Results &operator=(const OEAM1Results &)

      Assignment operator.

   .. oe:method:: GetAtomicBondOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetAtomicBondOrder(const unsigned int index) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomicBondOrder(argAtom: int) -> float

      Returns the atomic bond order of the atom with specified index.

   .. oe:method:: GetBondOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBondOrder(const unsigned int index1,
                                const unsigned int index2) const

      .. oe:language:: python

         .. oe:api:: python

            GetBondOrder(argAtom1: int, argAtom2: int) -> float

      Returns the bond order between the two atoms with specified indices.

      .. seealso::

         * :ref:`chapter_bondordertheory` chapter

   .. oe:method:: GetBondOrders

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<double> GetBondOrders() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondOrders() -> OEDoubleVector

      Returns the bond orders on all bondss. Bond orders are stored in the vector
      according to the bond indices.

      .. seealso::

         * :ref:`chapter_bondordertheory` chapter

   .. oe:method:: GetCharges

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<double> GetCharges() const

      .. oe:language:: python

         .. oe:api:: python

            GetCharges() -> OEDoubleVector

      Returns the AM1 charges on all atoms. Charges are stored in the vector
      according to the atom indices.

   .. oe:method:: GetEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnergy() -> float

      Returns the AM1 calculated energy of the molecule.

   .. oe:method:: GetNumSCFCycles

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumSCFCycles() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumSCFCycles() -> int

      Returns the number of self-consistent field cycles used during calculation.

   .. oe:method:: IsConverged

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsConverged() const

      .. oe:language:: python

         .. oe:api:: python

            IsConverged() -> bool

      Returns if the :ref:`OEAM1 <OEMolAM1_OEAM1>` self-consistent field calculation
      converged.


.. _OEMolAM1Classes:

*******************
OEMolAM1 Classes
*******************

.. oe:namespace:: OEMolAM1

.. toctree::

   OEAM1
   OEAM1Options
   OEAM1Results
   OEOptimizedAM1


.. oe:namespace:: OEMolAM1

.. meta::
   :keywords: OEOptimizedAM1, OptimizedAM1

.. _OEMolAM1_OEOptimizedAM1:

.. oe:class:: OEOptimizedAM1

   .. oe:api::

      class OEOptimizedAM1

   .. note::

      This is a low level api class that allows access to advanced 
      functionality from semi-empirical method calculations. It is recommended
      that you use the high level api method 
      :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>` 
      with :ref:`OEAM1Charges <OEProton_OEAM1Charges>` options to assign AM1 charges
      on a molecule.

   The :ref:`OEOptimizedAM1 <OEMolAM1_OEOptimizedAM1>` class optimizes :ref:`OEAM1 <OEMolAM1_OEAM1>`
   followed by calculation of Mulliken-type partial charges and other relevant quantities.

   The input must be a 3D molecule, and the AM1 parameters must be 
   available for each atom type in the molecule.

   .. seealso:
      :ref:`chapter_molchargetheory` for a description of AM1

   The :ref:`OEOptimizedAM1 <OEMolAM1_OEOptimizedAM1>` class defines the following public methods:
    * :oe:meth:`CalcAM1<OEMolAM1::OEOptimizedAM1::CalcAM1>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOptimizedAM1(unsigned int wvnFnType = OEMethodType::AM1)
            OEOptimizedAM1(const OEOptimizedAM1&)

      .. oe:language:: python

         .. oe:api:: python

            OEOptimizedAM1(wvnFnType: int = OEMethodType_AM1) -> OEOptimizedAM1
            OEOptimizedAM1(arg2: OEOptimizedAM1) -> OEOptimizedAM1

      Default and copy constructors.

      The wave functype could be any value defined in :oe:constns:`OEMolAM1::OEMethodType` namespace.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOptimizedAM1 &operator=(const OEOptimizedAM1 &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: CalcAM1

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CalcAM1(OEAM1Results& results, const OEChem::OEMolBase& mol)
            bool CalcAM1(OEAM1Results& results, const OEChem::OEMCMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            CalcAM1(results: OEAM1Results, mol: Union[OEGraphMol,OEQMol]) -> bool
            CalcAM1(results: OEAM1Results, mol: OEMol) -> bool

      Optimizes and performs AM1 calculation on the specified molecule and fills up 
      the specified :ref:`OEAM1Results <OEMolAM1_OEAM1Results>` with calculated results.
      Returns ``false`` if calculation was not successful.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolAM1

.. oe:constnamespace:: OEMethodType

   This namespace contains constants which define the type of semi-empirical 
   methods that can be used for :ref:`OEAM1 <OEMolAM1_OEAM1>` calculation.

   .. oe:constant:: AM1
   
      AM1 semi-empirical method. 

   .. oe:constant:: PM3
   
      PM3 semi-empirical method.



.. _OEMolAM1Constants:

*******************
OEMolAM1 Constants
*******************

.. oe:namespace:: OEMolAM1

.. toctree::

   OEMethodType


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEAM1BCCCharges, AM1BCCCharges, ChargeEngine

.. _OEProton_OEAM1BCCCharges:

.. oe:class:: OEAM1BCCCharges

   .. oe:api::

      class OEAM1BCCCharges : public OEChargeEngineBase

   Charge engine input to :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
   to assign AM1 Mulliken-type partial charges with bond-charge corrections.

   The input must be a 3D molecule with a number of atoms no larger than a
   defined maximum. The default is 300 atoms,
   see :oe:meth:`constructors<OEProton::OEAM1BCCCharges::Constructors>`.
   Parameters must be available for each atom and bond type.
   If permissive BCCs are requested, no correction is applied when a BCC
   is missing.

   .. seealso:
      :ref:`chapter_molchargetheory` for an description of AM1BCC

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAM1BCCCharges(bool optimize = true, bool symmetrize = true,
                            bool permissiveBCCs = false,
                            unsigned maxAtoms = 300)

      .. oe:language:: python

         .. oe:api:: python

            OEAM1BCCCharges(optimize: bool = True, symmetrize: bool = True,
                            permissiveBCCs: bool = False, maxAtoms: int = 300) -> OEAM1BCCCharges

      Constructor. Parameters also have getter and setter methods.

      .. seealso:
         * :oe:meth:`SetOptimize<OEProton::OEAM1BCCCharges::SetOptimize>`
         * :oe:meth:`SetSymmetrize<OEProton::OEAM1BCCCharges::SetSymmetrize>`
         * :oe:meth:`SetPermissiveBCCs<OEProton::OEAM1BCCCharges::SetPermissiveBCCs>`
         * :oe:meth:`SetSizeLimit<OEProton::OEAM1BCCCharges::SetSizeLimit>`

   .. oe:method:: GetOptimize

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetOptimize() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimize() -> bool

      Returns ``true`` if the geometry of the input molecule will be optimized
      during charge assignment.

      .. seealso:
         :oe:meth:`SetOptimize<OEProton::OEAM1BCCCharges::SetOptimize>`

   .. oe:method:: GetPermissiveBCCs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPermissiveBCCs() const

      .. oe:language:: python

         .. oe:api:: python

            GetPermissiveBCCs() -> bool

      Returns ``true`` if a missing BCC will be treated as a correction of zero
      rather than an error.

      .. seealso:
         :oe:meth:`SetPermissiveBCCs<OEProton::OEAM1BCCCharges::SetPermissiveBCCs>`

   .. oe:method:: GetSizeLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetSizeLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetSizeLimit() -> int

      Returns the maximum number of atoms permitted.

      .. seealso:
         :oe:meth:`SetSizeLimit<OEProton::OEAM1BCCCharges::SetSizeLimit>`

   .. oe:method:: GetSymmetrize

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSymmetrize() const

      .. oe:language:: python

         .. oe:api:: python

            GetSymmetrize() -> bool

      Returns ``true`` if charges will be symmetrized with respect to
      bond-topologically equivalent atoms.

      .. seealso:
         :oe:meth:`SetSymmetrize<OEProton::OEAM1BCCCharges::SetSymmetrize>`

   .. oe:method:: SetOptimize

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOptimize(bool optimize = true)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimize(optimize: bool = True) -> None

      Defines whether the geometry of the input molecule will be optimized
      during charge assignment. Optimization is lightly restrained to
      starting coordinates.

   .. oe:method:: SetPermissiveBCCs

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPermissiveBCCs(bool permissive = true)

      .. oe:language:: python

         .. oe:api:: python

            SetPermissiveBCCs(permissive: bool = True) -> None

      Defines whether a missing BCC will be treated as a correction of zero
      or as an error.

   .. oe:method:: SetSizeLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSizeLimit(unsigned maxAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetSizeLimit(maxAtoms: int) -> None

      Defines the maximum number of atoms permitted in the input molecule.

   .. oe:method:: SetSymmetrize

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSymmetrize(bool symmetrize = true)

      .. oe:language:: python

         .. oe:api:: python

            SetSymmetrize(symmetrize: bool = True) -> None

      Defines whether charges on the molecule are symmetrized with respect to
      bond-topologically equivalent atoms.


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEAM1BCCELF10Charges, AM1BCCELF10Charges, ELF, ChargeEngine

.. _OEProton_OEAM1BCCELF10Charges:

.. oe:class:: OEAM1BCCELF10Charges

   .. oe:api::

      class OEAM1BCCELF10Charges : public OEELFCharges

   Charge engine input to :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
   to assign AM1 Mulliken-type partial charges with bond-charge corrections
   using the electrostatically least-interacting functional group (ELF) technique.

   The input must be a 3D multi-conformer molecule with
   a number of atoms no larger than the default AM1BCC maximum.
   AM1BCC parameters must be available for each atom and bond type.

   .. oe:language:: c++

      Equivalent to:

      .. code-block:: c++

         OEELFCharges(OEAM1BCCCharges(), 10u)

   .. oe:language:: python

      Equivalent to:

      .. code-block:: python

         OEELFCharges(OEAM1BCCCharges(), 10)

   .. oe:language:: java

      Equivalent to:

      .. code-block:: java

         new OEELFCharges(new OEAM1BCCCharges(), 10)

   .. oe:language:: csharp

      Equivalent to:

      .. code-block:: csharp

         new OEELFCharges(new OEAM1BCCCharges(), 10)

   .. seealso:
      * :ref:`OEELFCharges <OEProton_OEELFCharges>` class
      * :ref:`chapter_molchargetheory` for an description of AM1 and ELF

   The following methods are publicly inherited from :ref:`OEELFCharges <OEProton_OEELFCharges>`:

   ================================================================================= ================================================================================= =================================================================================
   :oe:meth:`GetLimit<OEProton::OEELFCharges::GetLimit>`                             :oe:meth:`GetPercentage<OEProton::OEELFCharges::GetPercentage>`                   :oe:meth:`SetPercentage<OEProton::OEELFCharges::SetPercentage>`
   :oe:meth:`SetLimit<OEProton::OEELFCharges::SetLimit>`                             :oe:meth:`GetReturnSelectedConfs<OEProton::OEELFCharges::GetReturnSelectedConfs>` :oe:meth:`SetReturnSelectedConfs<OEProton::OEELFCharges::SetReturnSelectedConfs>`
   ================================================================================= ================================================================================= =================================================================================

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAM1BCCELF10Charges()
            OEAM1BCCELF10Charges(const OEAM1BCCELF10Charges& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEAM1BCCELF10Charges() -> OEAM1BCCELF10Charges
            OEAM1BCCELF10Charges(rhs: OEAM1BCCELF10Charges) -> OEAM1BCCELF10Charges

      Constructor. There are no options for this charge engine.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAM1BCCELF10Charges & operator=(const OEAM1BCCELF10Charges & rhs)

      Assignment operator.



.. oe:namespace:: OEProton

.. meta::
   :keywords: OEAM1Charges, AM1Charges, ChargeEngine

.. _OEProton_OEAM1Charges:

.. oe:class:: OEAM1Charges

   .. oe:api::

      class OEAM1Charges : public OEChargeEngineBase

   Charge engine input to :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
   to assign AM1 Mulliken-type partial charges.

   The input must be a 3D molecule with a number of atoms no larger than a
   defined maximum. The default is 300 atoms,
   see :oe:meth:`constructors<OEProton::OEAM1Charges::Constructors>`.
   AM1 parameters must be available for each atom type.

   .. seealso:
      :ref:`chapter_molchargetheory` for an description of AM1

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAM1Charges(bool optimize = true, bool symmetrize = false,
                         unsigned maxAtoms = 300)

      .. oe:language:: python

         .. oe:api:: python

            OEAM1Charges(optimize: bool = True, symmetrize: bool = False,
                         maxAtoms: int = 300) -> OEAM1Charges

      Constructor. Parameters also have getter and setter methods.

      .. seealso:
         * :oe:meth:`SetOptimize<OEProton::OEAM1Charges::SetOptimize>`
         * :oe:meth:`SetSymmetrize<OEProton::OEAM1Charges::SetSymmetrize>`
         * :oe:meth:`SetSizeLimit<OEProton::OEAM1Charges::SetSizeLimit>`

   .. oe:method:: GetOptimize

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetOptimize() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimize() -> bool

      Returns ``true`` if the geometry of the input molecule will be optimized
      during charge assignment.

      .. seealso:
         :oe:meth:`SetOptimize<OEProton::OEAM1Charges::SetOptimize>`

   .. oe:method:: GetSizeLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetSizeLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetSizeLimit() -> int

      Returns the maximum number of atoms permitted.

      .. seealso:
         :oe:meth:`SetSizeLimit<OEProton::OEAM1Charges::SetSizeLimit>`

   .. oe:method:: GetSymmetrize

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSymmetrize() const

      .. oe:language:: python

         .. oe:api:: python

            GetSymmetrize() -> bool

      Returns ``true`` if charges will be symmetrized with respect to
      bond-topologically equivalent atoms.

      .. seealso:
         :oe:meth:`SetSymmetrize<OEProton::OEAM1Charges::SetSymmetrize>`

   .. oe:method:: SetOptimize

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOptimize(bool optimize = true)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimize(optimize: bool = True) -> None

      Defines whether the geometry of the input molecule will be optimized
      during charge assignment. Optimization is lightly restrained to
      starting coordinates.

   .. oe:method:: SetSizeLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSizeLimit(unsigned maxAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetSizeLimit(maxAtoms: int) -> None

      Defines the maximum number of atoms permitted in the input molecule.

   .. oe:method:: SetSymmetrize

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSymmetrize(bool symmetrize = true)

      .. oe:language:: python

         .. oe:api:: python

            SetSymmetrize(symmetrize: bool = True) -> None

      Defines whether charges on the molecule are symmetrized with respect to
      bond-topologically equivalent atoms.


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEAmberFF94Charges, AmberFF94Charges, ChargeEngine

.. _OEProton_OEAmberFF94Charges:

.. oe:class:: OEAmberFF94Charges

   .. oe:api::

      class OEAmberFF94Charges : public OEChargeEngineBase

   Charge engine input to :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
   to assign Amber force field 94 atomic partial charges to standard amino acids.

   The input molecule must have explicit hydrogens and consist of only standard
   Amber amino acids. Residues must be perceived or repairs permitted. The
   amino acid name may be altered to match the Amber naming scheme, such as
   ``HIP`` for a protonated histidine.
   Currently OpenEye supports the following Amber amino acids:
   ``ACE``, ``ALA``, ``ARG``, ``ASH``, ``ASN``, ``ASP``,
   ``CIM``, ``CIP``, ``CYM``, ``CYS``, ``CYX``,
   ``GLH``, ``GLN``, ``GLU``, ``GLY``,
   ``HID``, ``HIE``, ``HIP``, ``HIS``,
   ``HOH``, ``ILE``, ``LEU``, ``LYN``, ``LYS``,
   ``MET``, ``NHE``, ``NME``, ``PHE``, ``PRO``,
   ``SER``, ``THR``, ``TRP``, ``TYR``, ``VAL``.
   Amber charges are graph-based and do not
   require 3D coordinates.

   .. seealso:
      :ref:`chapter_molchargetheory` for an description of Amber charges

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAmberFF94Charges()

      .. oe:language:: python

         .. oe:api:: python

            OEAmberFF94Charges() -> OEAmberFF94Charges

      Constructor. There are no options for this charge engine.


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEChargeEngineBase, ChargeEngineBase, ChargeEngine

.. _OEProton_OEChargeEngineBase:

.. oe:class:: OEChargeEngineBase

   .. oe:api::

      class OEChargeEngineBase

   This is the abstract base class for all charge engines, containing methods
   used by the function :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`.

   The following charge engine classes derive from this base class:

    * :ref:`OEAM1BCCCharges <OEProton_OEAM1BCCCharges>`
    * :ref:`OEAM1BCCELF10Charges <OEProton_OEAM1BCCELF10Charges>`
    * :ref:`OEAM1Charges <OEProton_OEAM1Charges>`
    * :ref:`OEAmberFF94Charges <OEProton_OEAmberFF94Charges>`
    * :ref:`OEChargeEngineNoOp <OEProton_OEChargeEngineNoOp>`
    * :ref:`OEClearCharges <OEProton_OEClearCharges>`
    * :ref:`OECombineChargeEngines <OEProton_OECombineChargeEngines>`
    * :ref:`OEDesignUnitCharges <OEProton_OEDesignUnitCharges>`
    * :ref:`OEELFCharges <OEProton_OEELFCharges>`
    * :ref:`OEFormalToPartialCharges <OEProton_OEFormalToPartialCharges>`
    * :ref:`OEGasteigerCharges <OEProton_OEGasteigerCharges>`
    * :ref:`OEInitialCharges <OEProton_OEInitialCharges>`
    * :ref:`OEMMFF94Charges <OEProton_OEMMFF94Charges>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEChargeEngineBase & operator=(const OEChargeEngineBase & rhs)

      Assignment operator.

   .. oe:method:: operator!=
      :language: c++

      .. oe:api::

         bool operator!=(const OEChargeEngineBase& rhs) const

      Returns ``true`` if the charge engines are `not` equivalent.

   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEChargeEngineBase& rhs) const

      Returns ``true`` if the charge engines are equivalent (the same
      class with the same parameters).

   .. oe:method:: ApplyCharges

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ApplyCharges(OEChem::OEMolBase& mol) const
            bool ApplyCharges(OEChem::OEMCMolBase& mcMol) const
            bool ApplyCharges(OEBio::OEDesignUnit& du) const

      .. oe:language:: python

         .. oe:api:: python

            ApplyCharges(du: OEDesignUnit) -> bool

      Assigns partial charges to the atoms of the molecule. The ``OEMCMolBase``
      overload assigns charges using all conformers where applicable. The
      ``OEDesignUnit`` overload charges the small-molecule component of the
      design unit.

   .. oe:method:: CheckCharges

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CheckCharges(const OEChem::OEMolBase& mol) const
            bool CheckCharges(const OEChem::OEMCMolBase& mcMol) const
            bool CheckCharges(const OEBio::OEDesignUnit& du) const

      .. oe:language:: python

         .. oe:api:: python

            CheckCharges(mol: Union[OEGraphMol,OEQMol]) -> bool
            CheckCharges(mcMol: OEMol) -> bool
            CheckCharges(du: OEDesignUnit) -> bool

      Used by :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>` to
      determine if the charges on the molecule are as expected.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEChargeEngineBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEChargeEngineBase

      Deep copy of the charge engine.

   .. oe:method:: GetExpectValidMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetExpectValidMol() const

      .. oe:language:: python

         .. oe:api:: python

            GetExpectValidMol() -> bool

      Returns ``true`` if an input molecule must be valid before
      :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>` attempts to
      assign charges.

      .. seealso:
         :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the name of the charge engine.

   .. oe:method:: GetRepairRequestedHint

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRepairRequestedHint() const

      .. oe:language:: python

         .. oe:api:: python

            GetRepairRequestedHint() -> bool

      Returns ``true`` if :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
      is requested to repair the input molecule before assigning charges.
      Examples of repairing a molecule include adding explicit hydrogens and
      perceiving residues.

      .. seealso:
         :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`

   .. oe:method:: GetRequirements

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetRequirements() const

      .. oe:language:: python

         .. oe:api:: python

            GetRequirements() -> int

      Returns a bit mask used by :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
      describing aspects of the input molecule required for this charging method.
      Examples include 3D coordinates, explicit hydrogens, and PDB order.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid(OEChem::OEMolBase& mol) const
            bool IsValid(OEChem::OEMCMolBase& mcMol) const
            bool IsValid(OEBio::OEDesignUnit& du) const
            bool IsValid(const OEChem::OEMolBase& mol) const = 0
            bool IsValid(const OEChem::OEMCMolBase& mcMol) const
            bool IsValid(const OEBio::OEDesignUnit& du) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(mol: Union[OEGraphMol,OEQMol]) -> bool
            IsValid(mcMol: OEMol) -> bool
            IsValid(du: OEDesignUnit) -> bool

      Returns ``true`` if the input molecule appears to be valid for use with
      this method.

   .. oe:method:: SetExpectValidMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetExpectValidMol(bool expect = true)

      .. oe:language:: python

         .. oe:api:: python

            SetExpectValidMol(expect: bool = True) -> None

      Defines whether an input molecule must be valid before
      :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>` attempts to
      assign charges. If set to ``false`` and the molecule is not valid,
      then :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
      attempt to charge the molecule anyway.

      .. seealso:
         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`

   .. oe:method:: SetRepairRequestedHint

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRepairRequestedHint(bool repair = true)

      .. oe:language:: python

         .. oe:api:: python

            SetRepairRequestedHint(repair: bool = True) -> None

      Define whether :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
      is requested to repair the input molecule before assigning charges.
      Examples of repairing a molecule include adding explicit hydrogens and
      perceiving residues. If set to ``false`` and the molecule requires
      repairs, then :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
      will fail and return ``false``.

   .. oe:method:: TransferCharge

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool TransferCharge(OEChem::OEAtomBase* dstAtom,
                                const OEChem::OEAtomBase* srcAtom) const

      .. oe:language:: python

         .. oe:api:: python

            TransferCharge(dstAtom: OEAtomBase, srcAtom: OEAtomBase) -> bool

      If :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>` must make
      a copy of the input molecule before charges can be applied, this
      method is used to transfer charges back to the input molecule.


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEChargeEngineNoOp, ChargeEngineNoOp, NoOp, ChargeEngine

.. _OEProton_OEChargeEngineNoOp:

.. oe:class:: OEChargeEngineNoOp

   .. oe:api::

      class OEChargeEngineNoOp : public OEChargeEngineBase

   Charge engine input to :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
   that does nothing to the input molecule, any existing charges are left untouched.

   This charge engine can be used with any type of molecule.

   Can be used as a pre-charging method for :ref:`OECombineChargeEngines <OEProton_OECombineChargeEngines>`.

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEChargeEngineNoOp()

      .. oe:language:: python

         .. oe:api:: python

            OEChargeEngineNoOp() -> OEChargeEngineNoOp

      Constructor. There are no options for this charge engine.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. meta::
   :keywords: OEChargeParameter, ChargeParameter

.. _OEProton_OEChargeParameter:

.. oe:class:: OEChargeParameter

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEChargeParameter : public OESystem::OEMultiParameter<OEProton::OEChargeEngineBase>

   The :ref:`OEChargeParameter <OEProton_OEChargeParameter>` represents parameter that has a value of type
   :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OEMultiParameter <OESystem_OEMultiParameter>`:
    * :oe:meth:`AddLegalEntry<OESystem::OEMultiParameter::AddLegalEntry>` 
    * :oe:meth:`GetDefault<OESystem::OEMultiParameter::GetDefault>` and
      :oe:meth:`SetDefault<OESystem::OEMultiParameter::SetDefault>` 
    * :oe:meth:`GetSetting<OESystem::OEMultiParameter::GetSetting>`
    * :oe:meth:`GetValue<OESystem::OEMultiParameter::GetValue>` and
      :oe:meth:`SetValue<OESystem::OEMultiParameter::SetValue>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEChargeParameter()
            OEChargeParameter(const std::string& name)
            OEChargeParameter(const OEChargeParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEChargeParameter(name: str) -> OEChargeParameter
            OEChargeParameter() -> OEChargeParameter
            OEChargeParameter(arg2: OEChargeParameter) -> OEChargeParameter

      Default and copy constructors.

      Constructs an :ref:`OEChargeParameter <OEProton_OEChargeParameter>` instance using the specified set of parameters.
      The second argument in the second constructor represents if a custom forcefield can be used.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEChargeParameter &operator=(const OEChargeParameter &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OEProton

.. meta::
   :keywords: OEClearCharges, ClearCharges, ChargeEngine

.. _OEProton_OEClearCharges:

.. oe:class:: OEClearCharges

   .. oe:api::

      class OEClearCharges : public OEChargeEngineBase

   Charge engine input to :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
   to set partial charges on all atoms to zero. This charge engine is
   graph-based and does not require 3D coordinates.

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEClearCharges()

      .. oe:language:: python

         .. oe:api:: python

            OEClearCharges() -> OEClearCharges

      Constructor. There are no options for this charge engine.


.. oe:namespace:: OEProton

.. meta::
   :keywords: OECombineChargeEngines, CombineChargeEngines, ChargeEngine

.. _OEProton_OECombineChargeEngines:

.. oe:class:: OECombineChargeEngines

   .. oe:api::

      class OECombineChargeEngines : public OEChargeEngineBase

   Charge engine input to :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
   that combines two user-specified charge engines into one. This is useful
   when the first charge engine is used to pre-charge a molecule and the second
   to adjust the charges. This allows more complicated charging schemes
   to be easily constructed.

   The input molecule must conform to the requirements of the specified
   charge engines.

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECombineChargeEngines(const OECombineChargeEngines& rhs)
            OECombineChargeEngines(const OEChargeEngineBase& preChargeEngine,
                                   const OEChargeEngineBase& adjustmentEngine)

      .. oe:language:: python

         .. oe:api:: python

            OECombineChargeEngines(preChargeEngine: OEChargeEngineBase,
                                   adjustmentEngine: OEChargeEngineBase) -> OECombineChargeEngines
            OECombineChargeEngines(rhs: OECombineChargeEngines) -> OECombineChargeEngines

      Constructors. The ``preChargeEngine`` is expected to set initial charges
      while the ``adjustmentEngine`` is expected to modify those charges.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECombineChargeEngines & operator=(const OECombineChargeEngines & rhs)

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. _OEProton_OEDesignUnitCharges:

.. oe:class:: OEDesignUnitCharges

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEDesignUnitCharges : public OEChargeEngineBase

   This charge engine charges each component in the :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.
   The various components can be charged with different charging engines, and the default behavior is
   to do exactly that.
   The default behavior is for the protein engine to use :ref:`OEAmberFF94Charges <OEProton_OEAmberFF94Charges>`
   for the standard protein residues. It uses :ref:`OEAM1BCCCharges <OEProton_OEAM1BCCCharges>` for nonstandard
   residues. The nucleic acid component uses the :ref:`OEMMFF94Charges <OEProton_OEMMFF94Charges>` charges.
   The ligand and or any other heterogen in the system (e.g cofactors), are charged using
   :ref:`OEAM1BCCCharges <OEProton_OEAM1BCCCharges>`.
   The solvent uses :ref:`OEAmberFF94Charges <OEProton_OEAmberFF94Charges>`, but by default uses
   the SZMAP water model, in which case it assigns the charges to match those described in
   :ref:`chapter_water_model`. This is an option that can be turned off.
   Excipients are by default charged using the :ref:`OEMMFF94Charges <OEProton_OEMMFF94Charges>` engine.
   The radii assigned are :oe:const:`OEChem::OERadiiType::BondiVdw`, except in cases where
   AM1 charges have been used, in which case the radii is of the :oe:const:`OEChem::OERadiiType::Zap9`
   type.
   Metals in the system (often in cofactors or otherCofactors) are initially charged with the
   :ref:`OEFormalToPartialCharges <OEProton_OEFormalToPartialCharges>` engine, and in the last step of the calculation,
   the metal charges are spread in the system using the :ref:`OESpreadMetalCharges <OEProton_OESpreadMetalCharges>` as part
   of the finalization stage. Counter ions are charged with the same metal charge engine, but are not subsequently spread.
   The fall back engine is the same for all components; in case an engine fails, the method will try to
   charge a component with the fall back engine, which by default is :ref:`OEMMFF94Charges <OEProton_OEMMFF94Charges>`.

   .. note::

      Currently, there is a hard limit of 100 atoms for molecules being charged with the :ref:`OEAM1BCCCharges <OEProton_OEAM1BCCCharges>` charging engine.

   .. warning::

      It is currently not possible to use :ref:`OEAM1BCCELF10Charges <OEProton_OEAM1BCCELF10Charges>` for the ligand, cofactors, or other
      components. The method requires passing a conformer ensemble of the molecule to charge, which is currently not
      possible with an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.
      If a user tries to use this type of charging engine, it will be downgraded to AM1BCC with a warning.
      Since the :ref:`OEAM1BCCELF10Charges <OEProton_OEAM1BCCELF10Charges>` is recommended for the molecular dynamics type of simulations,
      we recommend charging the ligand independently and updating it in the DesignUnit using
      :oe:func:`OEBio::OEUpdateDesignUnit`.

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDesignUnitCharges()
            OEDesignUnitCharges(const OEDesignUnitCharges& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEDesignUnitCharges() -> OEDesignUnitCharges
            OEDesignUnitCharges(rhs: OEDesignUnitCharges) -> OEDesignUnitCharges

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDesignUnitCharges &operator=(const OEDesignUnitCharges &rhs)

      Assignment operator.

   .. oe:method:: ApplyCharges

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ApplyCharges(OEBio::OEDesignUnit& du) const

      .. oe:language:: python

         .. oe:api:: python

            ApplyCharges(du: OEDesignUnit) -> bool

      Returns the boolean whether or not charges are able to be applied to the input
      :ref:`OEDesignUnit <OEBio_OEDesignUnit>` argument (`du`).

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEChargeEngineBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEChargeEngineBase

      Creates a copy of the charge engine class. This class does not own the returned memory.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid(const OEChem::OEMolBase& mol) const
            bool IsValid(const OEBio::OEDesignUnit& du) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            IsValid(du: OEDesignUnit) -> bool

      Returns the boolean whether or not the input :ref:`OEMolBase <OEChem_OEMolBase>` or :ref:`OEDesignUnit <OEBio_OEDesignUnit>` can be assigned partial charges from the charging engine.

   .. oe:method:: SetCoFactorChargeEngine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCoFactorChargeEngine(const OEChargeEngineBase& chargeEngine)

      .. oe:language:: python

         .. oe:api:: python

            SetCoFactorChargeEngine(chargeEngine: OEChargeEngineBase) -> None

      Sets the charge engine for the :oe:constns:`OEBio::OEDesignUnitComponents::Cofactors` molecular component.

   .. oe:method:: SetFallbackChargeEngine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFallbackChargeEngine(const OEChargeEngineBase& chargeEngine)

      .. oe:language:: python

         .. oe:api:: python

            SetFallbackChargeEngine(chargeEngine: OEChargeEngineBase) -> None

      Sets a backup charge engine for any molecular component where the charge engine cannot be applied.

   .. oe:method:: SetFinalizationChargeEngine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFinalizationChargeEngine(const OEChargeEngineBase& chargeEngine)

      .. oe:language:: python

         .. oe:api:: python

            SetFinalizationChargeEngine(chargeEngine: OEChargeEngineBase) -> None

   .. oe:method:: SetLigandChargeEngine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLigandChargeEngine(const OEChargeEngineBase& chargeEngine)

      .. oe:language:: python

         .. oe:api:: python

            SetLigandChargeEngine(chargeEngine: OEChargeEngineBase) -> None

      Sets the charge engine for the :oe:constns:`OEBio::OEDesignUnitComponents::Ligand` molecular component.

   .. oe:method:: SetMetalChargeEngine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMetalChargeEngine(const OEChargeEngineBase& chargeEngine)

      .. oe:language:: python

         .. oe:api:: python

            SetMetalChargeEngine(chargeEngine: OEChargeEngineBase) -> None

      Sets the charge engine for both the :oe:constns:`OEBio::OEDesignUnitComponents::Metals` and
      :oe:constns:`OEBio::OEDesignUnitComponents::CounterIons` molecular components.

   .. oe:method:: SetNucleicChargeEngine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNucleicChargeEngine(const OEChargeEngineBase& chargeEngine)

      .. oe:language:: python

         .. oe:api:: python

            SetNucleicChargeEngine(chargeEngine: OEChargeEngineBase) -> None

      Sets the charge engine for the :oe:constns:`OEBio::OEDesignUnitComponents::Nucleic` molecular component.

   .. oe:method:: SetOtherChargeEngine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOtherChargeEngine(const OEChargeEngineBase& chargeEngine)

      .. oe:language:: python

         .. oe:api:: python

            SetOtherChargeEngine(chargeEngine: OEChargeEngineBase) -> None

   .. oe:method:: SetProteinChargeEngine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetProteinChargeEngine(const OEChargeEngineBase& chargeEngine)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinChargeEngine(chargeEngine: OEChargeEngineBase) -> None

      Sets the charge engine for the :oe:constns:`OEBio::OEDesignUnitComponents::Protein` molecular component.

   .. oe:method:: SetProteinNonStandardChargeEngine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetProteinNonStandardChargeEngine(const OEChargeEngineBase& chargeEngine)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinNonStandardChargeEngine(chargeEngine: OEChargeEngineBase) -> None

      Sets the charge engine for any nonstandard amino acids in the :oe:constns:`OEBio::OEDesignUnitComponents::Protein` molecular component.

   .. oe:method:: SetSolventChargeEngine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSolventChargeEngine(const OEChargeEngineBase& chargeEngine)

      .. oe:language:: python

         .. oe:api:: python

            SetSolventChargeEngine(chargeEngine: OEChargeEngineBase) -> None

      Sets the charge engine for any solvent molecules in the :oe:constns:`OEBio::OEDesignUnitComponents::Solvent` molecular component.

   .. oe:method:: TransferCharge

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool TransferCharge(OEChem::OEAtomBase* dstAtom,
                                const OEChem::OEAtomBase* srcAtom) const

      .. oe:language:: python

         .. oe:api:: python

            TransferCharge(dstAtom: OEAtomBase, srcAtom: OEAtomBase) -> bool

      Returns the boolean whether or not the transfer of charges from the source atom (`srcAtom`) to the destination atom (`dstAtom`) was successful.

   .. oe:method:: UseSZMAPWaterModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            void UseSZMAPWaterModel(const bool value)

      .. oe:language:: python

         .. oe:api:: python

            UseSZMAPWaterModel(value: bool) -> None

      Sets the boolean of whether or not to use the Szmap water model within the context of charging the system (see :ref:`chapter_szmap_intro` for more information about the water model itself).


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEELF, ELF

.. _OEProton_OEELF:

.. oe:class:: OEELF

   .. oe:api::

      class OEELF

   This class defines an interface to select conformers from a given ensemble,
   using the electrostatically least-interacting functional group (ELF) technique.

   The :ref:`OEELF <OEProton_OEELF>` class defines the following public methods:
    * :oe:meth:`Select<OEProton::OEELF::Select>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEELF(const OEELFOptions& opts = OEELFOptions())
            OEELF(const OEELF&)

      .. oe:language:: python

         .. oe:api:: python

            OEELF(opts: OEELFOptions = OEELFOptions()) -> OEELF
            OEELF(arg2: OEELF) -> OEELF

      Default and copy constructors.

      .. oe:method:: operator=
         :language: c++

      .. oe:api::

         OEELF &operator=(const OEELF &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: Select

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Select(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            Select(mol: OEMol) -> bool

      Selects the desired ELF population.  Method discards the unwanted conformers
      in the input molecule.


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEELFCharges, OEELFCharges, ELF, ChargeEngine

.. _OEProton_OEELFCharges:

.. oe:class:: OEELFCharges

   .. oe:api::

      class OEELFCharges : public OEChargeEngineBase

   Charge engine input to :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
   to assign charges with the user-specified charge engine
   using the electrostatically least-interacting functional group (ELF) technique.

   The input must be a 3D multi-conformer molecule and conform to the
   requirements of the specified charge engine. Graph-based charge engines
   are not appropriate for use with ELF because they do not take 3D conformation
   into account.

   .. seealso:
      :ref:`chapter_molchargetheory` for an explanation of ELF

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   ======================================================================================= ======================================================================================= =======================================================================================

   The following classes derive from this class:
    * :ref:`OEAM1BCCELF10Charges <OEProton_OEAM1BCCELF10Charges>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEELFCharges(const OEELFCharges& rhs)
            OEELFCharges(const OEChargeEngineBase& chargeEngine,
                         unsigned limit = 10, double percentage = 2.0,
                         bool selectedConfs = false)

      .. oe:language:: python

         .. oe:api:: python

            OEELFCharges(chargeEngine: OEChargeEngineBase, limit: int = 10,
                         percentage: float = 2.0, selectedConfs: bool = False) -> OEELFCharges
            OEELFCharges(rhs: OEELFCharges) -> OEELFCharges

      Constructor. Parameters also have getter and setter methods.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEELFCharges & operator=(const OEELFCharges & rhs)

      Assignment operator.

   .. oe:method:: GetLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetLimit() -> int

      Returns the number of diverse conformers to select from the
      least interacting conformers set.

      .. seealso:
         :oe:meth:`SetLimit<OEProton::OEELFCharges::SetLimit>`

   .. oe:method:: GetPercentage

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPercentage() const

      .. oe:language:: python

         .. oe:api:: python

            GetPercentage() -> float

      Returns the percentage of input conformers to select as the
      electrostatically least-interacting set.

      .. seealso:
         :oe:meth:`SetPercentage<OEProton::OEELFCharges::SetPercentage>`

   .. oe:method:: GetReturnSelectedConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetReturnSelectedConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetReturnSelectedConfs() -> bool

      Returns ``true`` if just the selected diverse conformers will be returned.
      Otherwise all the original conformers are returned.

      .. seealso:
         :oe:meth:`SetReturnSelectedConfs<OEProton::OEELFCharges::SetReturnSelectedConfs>`

   .. oe:method:: SetLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLimit(unsigned limit)

      .. oe:language:: python

         .. oe:api:: python

            SetLimit(limit: int) -> None

      Sets the number of diverse conformers to select from the
      least interacting conformers set in the second step of the ELF algorithm.

   .. oe:method:: SetPercentage

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPercentage(double pct)

      .. oe:language:: python

         .. oe:api:: python

            SetPercentage(pct: float) -> None

      Sets the percentage of input conformers to select as the
      electrostatically least-interacting set in the first step of the ELF
      algorithm.

   .. oe:method:: SetReturnSelectedConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetReturnSelectedConfs(bool selected = true)

      .. oe:language:: python

         .. oe:api:: python

            SetReturnSelectedConfs(selected: bool = True) -> None

      Determines whether only the selected diverse conformers will be returned.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. meta::
   :keywords: OEELFOptions, ELFOptions

.. _OEProton_OEELFOptions:

.. oe:class:: OEELFOptions

   .. oe:api::

      class OEELFOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for 
   :ref:`OEELF <OEProton_OEELF>` calculations.
   
   The :ref:`OEELFOptions <OEProton_OEELFOptions>` class defines the following public methods:
    * :oe:meth:`GetElfLimit<OEProton::OEELFOptions::GetElfLimit>` and 
      :oe:meth:`SetElfLimit<OEProton::OEELFOptions::SetElfLimit>`
    * :oe:meth:`GetPercent<OEProton::OEELFOptions::GetPercent>` and
      :oe:meth:`SetPercent<OEProton::OEELFOptions::SetPercent>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEELFOptions()
            OEELFOptions(const OEELFOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEELFOptions() -> OEELFOptions
            OEELFOptions(arg2: OEELFOptions) -> OEELFOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEELFOptions &operator=(const OEELFOptions &)

      Assignment operator.

   .. oe:method:: GetElfLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetElfLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetElfLimit() -> int

      See :oe:meth:`SetElfLimit<OEProton::OEELFOptions::SetElfLimit>` method.

   .. oe:method:: GetPercent

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPercent() const

      .. oe:language:: python

         .. oe:api:: python

            GetPercent() -> float

      See :oe:meth:`SetPercent<OEProton::OEELFOptions::SetPercent>` method.

   .. oe:method:: SetElfLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetElfLimit(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetElfLimit(value: int) -> bool

      Sets the **number of diverse conformers to select** from the
      least interacting conformers set.
      **Default: 10**

   .. oe:method:: SetPercent

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPercent(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetPercent(value: float) -> bool

      Sets the **percentage of input conformers to select** as the
      electrostatically least-interacting set.
      **Default: 2.0**


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEFormalChargeOptions, FormalChargeOptions, ChargeEngine

.. _OEProton_OEFormalChargeOptions:

.. oe:class:: OEFormalChargeOptions

   .. oe:api::

      class OEFormalChargeOptions

   This class is used for setting options during tautomer enumeration
   with :oe:func:`OEProton::OEEnumerateFormalCharges`.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFormalChargeOptions(const OEFormalChargeOptions& rhs)
            OEFormalChargeOptions(unsigned int maxCount = 0u,
                                  bool verbose = false, bool warts = true)

      .. oe:language:: python

         .. oe:api:: python

            OEFormalChargeOptions(maxCount: int = 0, verbose: bool = False,
                                  warts: bool = True) -> OEFormalChargeOptions
            OEFormalChargeOptions(rhs: OEFormalChargeOptions) -> OEFormalChargeOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFormalChargeOptions &operator=(const OEFormalChargeOptions &rhs)

      Assignment operator.

   .. oe:method:: GetMaxCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxCount() -> int

      Get the maximum number of charge states to be enumerated.

   .. oe:method:: GetVerbose

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetVerbose() const

      .. oe:language:: python

         .. oe:api:: python

            GetVerbose() -> bool

      Get whether detailed info will be printed during charge enumeration.

   .. oe:method:: GetWarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetWarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetWarts() -> bool

      Get whether to add ``wart`` to the title of each charge state.

   .. oe:method:: SetMaxCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxCount(unsigned int max)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxCount(max: int) -> None

      Set the maximum number of charge states to be enumerated.

   .. oe:method:: SetVerbose

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetVerbose(bool verbose)

      .. oe:language:: python

         .. oe:api:: python

            SetVerbose(verbose: bool) -> None

      Set whether detailed info is to be printed during charge enumeration.
      The default is ``false``.

   .. oe:method:: SetWarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetWarts(bool warts)

      .. oe:language:: python

         .. oe:api:: python

            SetWarts(warts: bool) -> None

      Set whether to add ``wart`` to the title of each charge state.
      The default is ``true``.


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEFormalToPartialCharges, FormalToPartialCharges, ChargeEngine

.. _OEProton_OEFormalToPartialCharges:

.. oe:class:: OEFormalToPartialCharges

   .. oe:api::

      class OEFormalToPartialCharges : public OEChargeEngineBase

   Charge engine input to :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
   to assign atomic partial charges equal to the atomic formal charges.

   The input molecule must have explicit hydrogens. These charges are
   graph based and do not require 3D coordinates.

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFormalToPartialCharges()

      .. oe:language:: python

         .. oe:api:: python

            OEFormalToPartialCharges() -> OEFormalToPartialCharges

      Constructor. There are no options for this charge engine.


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEGasteigerCharges, GasteigerCharges, ChargeEngine

.. _OEProton_OEGasteigerCharges:

.. oe:class:: OEGasteigerCharges

   .. oe:api::

      class OEGasteigerCharges : public OEChargeEngineBase

   Charge engine input to :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
   to assign Marsili-Gasteiger atomic partial charges.

   The input molecule must have explicit hydrogens. Gasteiger charges are
   graph based and do not require 3D coordinates.

   .. seealso:
      :ref:`chapter_molchargetheory` for an description of Marsili-Gasteiger charges

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEGasteigerCharges()

      .. oe:language:: python

         .. oe:api:: python

            OEGasteigerCharges() -> OEGasteigerCharges

      Constructor. There are no options for this charge engine.


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEInitialCharges, InitialCharges, ChargeEngine

.. _OEProton_OEInitialCharges:

.. oe:class:: OEInitialCharges

   .. oe:api::

      class OEInitialCharges : public OEChargeEngineBase

   Charge engine input to :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
   to assign atomic partial charges by smearing formal charges onto resonance
   shared atoms.

   The input molecule must have explicit hydrogens. Initial charges are
   graph based and do not require 3D coordinates.

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInitialCharges()

      .. oe:language:: python

         .. oe:api:: python

            OEInitialCharges() -> OEInitialCharges

      Constructor. There are no options for this charge engine.


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEMMFF94Charges, MMFF94Charges, ChargeEngine

.. _OEProton_OEMMFF94Charges:

.. oe:class:: OEMMFF94Charges

   .. oe:api::

      class OEMMFF94Charges : public OEChargeEngineBase

   Charge engine input to :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
   to assign MMFF94 atomic partial charges.

   The input molecule must have explicit hydrogens and MMFF94 parameters must be
   available for each atom. MMFF charges are graph based and do not require
   3D coordinates.

   .. seealso:
      :ref:`chapter_molchargetheory` for an description of MMFF charges

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFF94Charges()

      .. oe:language:: python

         .. oe:api:: python

            OEMMFF94Charges() -> OEMMFF94Charges

      Constructor. There are no options for this charge engine.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. meta::
  :keywords: OEMultistatepKaModel, OEMultistatepKaModelOptions, pKaModel

.. _OEProton_OEMultistatepKaModel:

.. oe:class:: OEMultistatepKaModel

  .. attention::

    |PRELIMINARY-API|
  
  .. oe:api::

     class OEMultistatepKaModel

  This class provides functionality to assess the atomic pKa of a given molecule and enumerate ionization states at neutral pH.
  The options required for this class can be set using the :ref:`OEMultistatepKaModelOptions <OEProton_OEMultistatepKaModelOptions>` class.

  .. seealso::

     * :ref:`OEMultistatepKaModelOptions <OEProton_OEMultistatepKaModelOptions>` class

    The :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>` class defines the following public methods:
      
      * :oe:meth:`Init<OEProton::OEMultistatepKaModel::Init>`
      * :oe:meth:`CalculateNumOfMicrostates<OEProton::OEMultistatepKaModel::CalculateNumOfMicrostates>`
      * :oe:meth:`SetAllAtomspKaData<OEProton::OEMultistatepKaModel::SetAllAtomspKaData>`
      * :oe:meth:`GetModelMolecule<OEProton::OEMultistatepKaModel::GetModelMolecule>`
      * :oe:meth:`GetAtompKaRange<OEProton::OEMultistatepKaModel::GetAtompKaRange>`
      * :oe:meth:`GenerateMicrostates<OEProton::OEMultistatepKaModel::GenerateMicrostates>`
      * :oe:meth:`GetMicrostates<OEProton::OEMultistatepKaModel::GetMicrostates>`

      * :oe:meth:`HasAdjTypeAtNeutralpH<OEProton::OEMultistatepKaModel::HasAdjTypeAtNeutralpH>`
      * :oe:meth:`HaspKaRange<OEProton::OEMultistatepKaModel::HaspKaRange>`

  .. oe:method:: Constructors

    Constructors.

    .. oe:language:: c++ java csharp

       .. oe:api::

          OEMultistatepKaModel()
          OEMultistatepKaModel(const OEMultistatepKaModelOptions& opts)
          OEMultistatepKaModel(OEChem::OEMolBase& mol,
                               const OEMultistatepKaModelOptions& opts = OEMultistatepKaModelOptions())

    .. oe:language:: python

       .. oe:api:: python

          OEMultistatepKaModel() -> OEMultistatepKaModel
          OEMultistatepKaModel(opts: OEMultistatepKaModelOptions) -> OEMultistatepKaModel
          OEMultistatepKaModel(mol: Union[OEGraphMol,OEMol,OEQMol],
                               opts: OEMultistatepKaModelOptions = OEMultistatepKaModelOptions()) -> OEMultistatepKaModel

    Copy constructor.

    .. oe:language:: c++ java csharp

       .. oe:api::

          OEMultistatepKaModel(const OEMultistatepKaModel& rhs)

    .. oe:language:: python

       .. oe:api:: python

          OEMultistatepKaModel(rhs: OEMultistatepKaModel) -> OEMultistatepKaModel

    Copy assignment constructor.

  .. oe:method:: operator=
     :language: c++

    .. oe:api::

        OEMultistatepKaModel& operator=(const OEMultistatepKaModel &rhs)
        Assignment operator.

  .. oe:method:: Init

    .. oe:language:: c++ java csharp

       .. oe:api::

          void Init(OEChem::OEMolBase& mol)
          void Init(OEChem::OEMolBase& mol, OEMultistatepKaModelOptions& opts)

    .. oe:language:: python

       .. oe:api:: python

          Init(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None
          Init(mol: Union[OEGraphMol,OEMol,OEQMol],
               opts: OEMultistatepKaModelOptions) -> None

    If a user has initialized the OEMultistatepKaModel instance with default constructor
    (without molecule and options object), they can add a molecule and
    :ref:`OEMultistatepKaModelOptions <OEProton_OEMultistatepKaModelOptions>` instance later by the Init method.

  .. oe:method:: CalculateNumOfMicrostates

    .. oe:language:: c++ java csharp

       .. oe:api::

          int CalculateNumOfMicrostates()

    .. oe:language:: python

       .. oe:api:: python

          CalculateNumOfMicrostates() -> int

    This method calculates the number of microstates possible for given molecule. It uses
    the information (generic pKa data) assessed and set by the method SetAllAtomspKaData. It returns -1 if either
    OEMultistatepKaModel failed to assess all atomic pKa on the molecule (probably due to unknown atoms present), or
    it halted assessing pKa data because the projected number of microstates exceeded the provided limit of microstates to be generated.

  .. oe:method:: GetModelMolecule

    .. oe:language:: c++ java csharp

       .. oe:api::

          const OEChem::OEMolBase& GetModelMolecule()

    .. oe:language:: python

       .. oe:api:: python

          GetModelMolecule() -> OEGraphMol

    This method returns the copy of the internal molecule object from the :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>` class
    on which all atomic pKa data are assessed and set as generic data.

  .. oe:method:: GetAtompKaRange

    .. oe:language:: c++ java csharp

       .. oe:api::

          unsigned int GetAtompKaRange(const OEChem::OEAtomBase* atom)

    .. oe:language:: python

       .. oe:api:: python

          GetAtompKaRange(atom: OEAtomBase) -> int

    This method allows a user to assess and get the pKa range (
    :oe:const:`OEProton::OEpKaRange::Acidic`, 
    :oe:const:`OEProton::OEpKaRange::Neutral`, 
    :oe:const:`OEProton::OEpKaRange::Basic` or 
    :oe:const:`OEProton::OEpKaRange::Unidentified`) 
    for an individual atom.

  .. oe:method:: GetAtomAdjTypeAtNeutralpH

    .. oe:language:: c++ java csharp

       .. oe:api::

          unsigned int GetAtomAdjTypeAtNeutralpH(const OEChem::OEAtomBase* atom)

    .. oe:language:: python

       .. oe:api:: python

          GetAtomAdjTypeAtNeutralpH(atom: OEAtomBase) -> int

    This method allows a user to assess and get the adjustment type to be done at
    neutral pH (
    :oe:const:`OEProton::OEAdjTypeAtNeutralpH::NoChange`, 
    :oe:const:`OEProton::OEAdjTypeAtNeutralpH::Protonation`, 
    :oe:const:`OEProton::OEAdjTypeAtNeutralpH::Deprotonation`, 
    :oe:const:`OEProton::OEAdjTypeAtNeutralpH::NoChangeAndProtonation`, 
    :oe:const:`OEProton::OEAdjTypeAtNeutralpH::NoChangeAndDeprotonation` 
    ) for an individual atom.

  .. oe:method:: GenerateMicrostates

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool GenerateMicrostates()

    .. oe:language:: python

       .. oe:api:: python

          GenerateMicrostates() -> bool

    This method generates all possible microstates (up to the limit specified by the options class).
    These generated microstates can be accessed by the method
    :oe:meth:`GetMicrostates<OEProton::OEMultistatepKaModel::GetMicrostates>`.
 
  .. oe:method:: GetMicrostates

    .. oe:language:: c++ java csharp

       .. oe:api::

          OESystem::OEIterBase<OEChem::OEMolBase>* GetMicrostates()

    .. oe:language:: python

       .. oe:api:: python

          GetMicrostates() -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

    Microstates generated by the method :oe:meth:`GenerateMicrostates<OEProton::OEMultistatepKaModel::GenerateMicrostates>`
    can be accessed by this method. It returns an iterator over the generated microstates molecule objects.

  .. oe:method:: HasAdjTypeAtNeutralpH

    .. oe:api::

         HasAdjTypeAtNeutralpH(unsigned AdjTypeAtNeutralpHID)

    This is a predicate functor, which allows a user to filter atoms with the
    desired :oe:constns:`OEProton::OEAdjTypeAtNeutralpH` generic data attached.

  .. oe:method:: HaspKaRange

    .. oe:api::

         HaspKaRange(unsigned pkarangeID)

    This is a predicate functor, which allows a user to filter atoms with the
    desired :oe:constns:`OEProton::OEpKaRange` generic data attached.

  .. oe:method:: SetAllAtomspKaData

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool SetAllAtomspKaData()

    .. oe:language:: python

       .. oe:api:: python

          SetAllAtomspKaData() -> bool

    This method assesses the atomic pKa for all heavy/hetero atoms and sets generic pKa data for these atoms.
    If an OEMultistatepKaModelOptions class object is specified with the parameter processcarbons = true, it
    assesses all heavy atoms. If an OEMultistatepKaModelOptions class object is specified
    with the parameter processcarbons = false, then only hetero atoms are assessed.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. meta::
  :keywords: OEMultistatepKaModelOptions, OEMultistatepKaModel, pKaModel

.. _OEProton_OEMultistatepKaModelOptions:

.. oe:class:: OEMultistatepKaModelOptions

  .. attention::

    |PRELIMINARY-API|

  .. oe:api::

     class OEMultistatepKaModelOptions

  This class provides an interface to set up options required for
  :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>`.
  

  The :ref:`OEMultistatepKaModelOptions <OEProton_OEMultistatepKaModelOptions>` class defines the following public methods:

    * :oe:meth:`GetpH<OEProton::OEMultistatepKaModelOptions::GetpH>` and 
      :oe:meth:`SetpH<OEProton::OEMultistatepKaModelOptions::SetpH>`
    * :oe:meth:`GetProcessCarbons<OEProton::OEMultistatepKaModelOptions::GetProcessCarbons>` and
      :oe:meth:`SetProcessCarbons<OEProton::OEMultistatepKaModelOptions::SetProcessCarbons>`
    * :oe:meth:`GetMaxNumMicrostates<OEProton::OEMultistatepKaModelOptions::GetMaxNumMicrostates>` and
      :oe:meth:`SetMaxNumMicrostates<OEProton::OEMultistatepKaModelOptions::SetMaxNumMicrostates>`

   
  .. oe:method:: Constructors

    .. oe:language:: c++ java csharp

       .. oe:api::

          OEMultistatepKaModelOptions()
          OEMultistatepKaModelOptions(unsigned int maxnummicrostates,
                                      bool processcarbons)

    .. oe:language:: python

       .. oe:api:: python

          OEMultistatepKaModelOptions() -> OEMultistatepKaModelOptions
          OEMultistatepKaModelOptions(maxmicrostates: int, pc: bool) -> OEMultistatepKaModelOptions

    Copy constructor.

    .. oe:language:: c++ java csharp

       .. oe:api::

          OEMultistatepKaModelOptions(const OEMultistatepKaModelOptions&)

    .. oe:language:: python

       .. oe:api:: python

          OEMultistatepKaModelOptions(rhs: OEMultistatepKaModelOptions) -> OEMultistatepKaModelOptions

    Copy assignment constructor.

    .. oe:language:: c++ java csharp

       .. oe:api::

          OEMultistatepKaModelOptions& operator=(const OEMultistatepKaModelOptions& rhs)

    .. oe:language:: python

       .. oe:api:: python

          OEMultistatepKaModelOptions(rhs: OEMultistatepKaModelOptions) -> OEMultistatepKaModelOptions

  .. oe:method:: GetpH

    .. oe:language:: c++ java csharp

       .. oe:api::

          unsigned int GetpH()

    .. oe:language:: python

       .. oe:api:: python

          GetpH() -> int

    Gets the value of the pH parameters at which a user wants to assess ionization states of the molecule.
    Only a neutral pH can be set.
    This option is defined in anticipation of a wider pKa model at different pH environments.

  .. oe:method:: SetpH

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool SetpH(unsigned ph)

    .. oe:language:: python

       .. oe:api:: python

          SetpH(ph: int) -> bool

    Sets the pH to be used to assess the ionization states of the molecule. Only a neutral pH can be set.
    This option is defined in anticipation of a wider pKa model at different pH environments.

  .. oe:method:: GetProcessCarbons

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool GetProcessCarbons()

    .. oe:language:: python

       .. oe:api:: python

          GetProcessCarbons() -> bool

    Returns the parameter setting requesting the pKa assessment of carbon atoms.
    Default is true.

  .. oe:method:: SetProcessCarbons

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool SetProcessCarbons(bool pc)

    .. oe:language:: python

       .. oe:api:: python

          SetProcessCarbons(pc: bool) -> bool

    Sets whether a user wants to assess the pKa of carbon atoms, true or false.

  .. oe:method:: GetMaxNumMicrostates

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxNumMicrostates()

      .. oe:language:: python

         .. oe:api:: python

            GetMaxNumMicrostates() -> int

      Gets the value of maximum number of microstates to generate; the parameter is set by default or by the method
      :oe:meth:`SetMaxNumMicrostates<OEProton::OEMultistatepKaModelOptions::SetMaxNumMicrostates>`. 

  .. oe:method:: SetMaxNumMicrostates

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxNumMicrostates(unsigned int maxnummicrostates)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxNumMicrostates(maxnummicrostates: int) -> bool

      Sets the maximum number of microstates to generate. If the projected number of
      microstates is more than the maximum limit set by this function, the model will not generate any microstates.


.. _OEProtonClasses:

*******************
OEProton Classes
*******************

.. oe:namespace:: OEProton

.. toctree::

   OEAM1BCCCharges
   OEAM1BCCELF10Charges
   OEAM1Charges
   OEAmberFF94Charges
   OEChargeEngineBase
   OEChargeEngineNoOp
   OEClearCharges
   OECombineChargeEngines
   OEDesignUnitCharges
   OEELF
   OEELFCharges
   OEELFOptions
   OEFormalChargeOptions
   OEFormalToPartialCharges
   OEGasteigerCharges
   OEInitialCharges
   OEMMFF94Charges
   OESpreadMetalCharges
   OETautomerOptions
   OETautomerMolFunction
   OETyperMolFunction


.. oe:namespace:: OEProton

.. meta::
   :keywords: ChargeEngine

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _OEProton_OESpreadMetalCharges:

.. oe:class:: OESpreadMetalCharges

   .. oe:api::

      class OESpreadMetalCharges : public OEChargeEngineBase

   Charge engine derived from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`
   that spreads partial charges from a metal to its chelation bonding parters.

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESpreadMetalCharges(double chargeAliquot = 0.25,
                                 double radiusMargin = 0.25,
                                 double maxNbrDist = 6.0)

      .. oe:language:: python

         .. oe:api:: python

            OESpreadMetalCharges(chargeAliquot: float = 0.25,
                                 radiusMargin: float = 0.25,
                                 maxNbrDist: float = 6.0) -> OESpreadMetalCharges

      Constructor with input arguments of the incremental amount of charge that should be spread from the metal to each chelating atom (`chargeAliquot`), the distance beyond the radial-radial distance from which the nearest neighbors cutoff is defined (`radiusMargin`), and the maximum distance separating the metal and the chelating atoms (`maxNbrDist`). Parameters also have getter and setter methods.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEChargeEngineBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEChargeEngineBase

      Creates a copy of the charge engine class. This class does not own the returned memory.

   .. oe:method:: GetChargeAliquot

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetChargeAliquot() const

      .. oe:language:: python

         .. oe:api:: python

            GetChargeAliquot() -> float

      Returns the amount of the charge that will be removed from the metal per chelating atom.

   .. oe:method:: GetMaxNbrDist

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMaxNbrDist() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxNbrDist() -> float

      Returns the maximum nearest neighbors distance (minus the `radiusMargin`) from the metal to the chelating atoms.

   .. oe:method:: GetRadiusMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRadiusMargin() const

      .. oe:language:: python

         .. oe:api:: python

            GetRadiusMargin() -> float

      Returns the extra marginal amount of distance such that two atoms can be considered chelators of each other.

   .. oe:method:: SetChargeAliquot

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetChargeAliquot(double aliquot)

      .. oe:language:: python

         .. oe:api:: python

            SetChargeAliquot(aliquot: float) -> None

      Sets the amount of charge that should be spread from the metal to each  chelating atom.

   .. oe:method:: SetMaxNbrDist

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxNbrDist(double distance)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxNbrDist(distance: float) -> None

      Sets the maximum nearest neighbors distance (minus the `radiusMargin`) from the metal to the chelating atoms.

   .. oe:method:: SetRadiusMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRadiusMargin(double distance)

      .. oe:language:: python

         .. oe:api:: python

            SetRadiusMargin(distance: float) -> None

      Sets the extra marginal amount of distance that two atoms can be considered chelators of each other.


.. oe:namespace:: OEProton

.. meta::
   :keywords: OETautomerOptions, TautomerOptions

.. _OEProton_OETautomerOptions:

.. oe:class:: OETautomerOptions

   .. oe:api::

      class OETautomerOptions

   This class is used for setting options during tautomer enumeration
   with :oe:func:`OEProton::OEEnumerateTautomers`.

   By default, :oe:func:`OEProton::OEEnumerateTautomers` will return
   the "canonical" tautomer, regardless of the tautomer submitted to
   the function. This "canonical" tautomer is extremely useful for
   efficient and reliable tautomer cheminformatics, such as database
   searching. The
   :oe:meth:`OEProton::OETautomerOptions::SetRankTautomers` method can
   be used to make :oe:func:`OEProton::OEEnumerateTautomers` generate a
   tautomer more "reasonable" for depiction for chemists.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETautomerOptions(unsigned int maxGenerated = 4096,
                              bool rank = true, bool warts = false,
                              unsigned int level = 0, bool carbonHybrid = true,
                              bool saveStereo = false,
                              unsigned int maxZoneSize = 35,
                              unsigned int maxTautomericAtoms = 70,
                              float maxTime = 120, bool kekule = false,
                              bool clearCoords = false,
                              unsigned int hybridLevel = OEHybridizationLevel::EnolEnamine,
                              unsigned int maxToReturn = 256,
                              unsigned int racemicType = OERacemicType::LocalSampled)

      .. oe:language:: python

         .. oe:api:: python

            OETautomerOptions(maxGenerated: int = 4096, rank: bool = True,
                              warts: bool = False, level: int = 0,
                              carbonHybrid: bool = True,
                              saveStereo: bool = False, maxZoneSize: int = 35,
                              maxTautomericAtoms: int = 70,
                              maxTime: float = 120, kekule: bool = False,
                              clearCoords: bool = False, hybridLevel: int,
                              maxToReturn: int = 256, racemicType: int) -> OETautomerOptions

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETautomerOptions(const OETautomerOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OETautomerOptions(rhs: OETautomerOptions) -> OETautomerOptions

      Copy constructor.

   .. oe:method:: GetApplyWarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetApplyWarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetApplyWarts() -> bool

      Returns setting for warts application of {title}_1, {title}_2, etc., on tautomers.

   .. oe:method:: GetCarbonHybridization

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCarbonHybridization() const

      .. oe:language:: python

         .. oe:api:: python

            GetCarbonHybridization() -> bool

      Returns setting for whether or not carbon hybridization changes
      are allowed.  Allowing sp2-sp3 changes of carbon atoms can
      significantly increase computation time.

   .. oe:method:: GetClearCoordinates

      .. oe:api::

         bool GetClearCoordinates() const

      Returns whether input coordinates are cleared.
      The default value is ``false``.

   .. oe:method:: GetHybridizationLevel

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetHybridizationLevel() const

      .. oe:language:: python

         .. oe:api:: python

            GetHybridizationLevel() -> int

      Returns setting for the level of hybridization changes
      allowed when carbon hybridization is allowed.  Allowing carbon hybridization
      significantly increase computation time.
      The returned value is from the :oe:constns:`OEProton::OEHybridizationLevel`
      namespace.

      .. seealso::

         * :oe:constns:`OEProton::OEHybridizationLevel` namespace

   .. oe:method:: GetKekule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetKekule() const

      .. oe:language:: python

         .. oe:api:: python

            GetKekule() -> bool

      Returns setting for whether or not generated tautomers are kekule or have aromaticity perceived.

   .. oe:method:: GetLevel

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetLevel() const

      .. oe:language:: python

         .. oe:api:: python

            GetLevel() -> int

      Returns level for tautomerization.  Higher levels allow less
      likely atomic transitions to occur.

   .. oe:method:: GetMaxSearchTime

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetMaxSearchTime() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSearchTime() -> float

      Returns the maximum search time in seconds allowed for a molecule.

   .. oe:method:: GetMaxTautomericAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxTautomericAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxTautomericAtoms() -> int

      Returns the maximum number of tautomeric atoms allowed in a molecule.
      The default value is 70.

   .. oe:method:: GetMaxTautomersGenerated

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxTautomersGenerated() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxTautomersGenerated() -> int

      Returns setting for maximum number of tautomers that may be
      generated for each input molecule.

      .. seealso::

         * :oe:meth:`OEProton::OETautomerOptions::GetMaxTautomersToReturn` method

   .. oe:method:: GetMaxTautomersToReturn

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxTautomersToReturn() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxTautomersToReturn() -> int

      Returns setting for maximum number of tautomers that may be
      returned for each input molecule.

      .. seealso::

         * :oe:meth:`OEProton::OETautomerOptions::GetMaxTautomersGenerated` method

   .. oe:method:: GetMaxZoneSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxZoneSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxZoneSize() -> int

      Returns setting for maximum number of atoms allowed in a continuous tautomerization zone.
      The default zone size is 35.

   .. oe:method:: GetRacemicType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRacemicType() const

      .. oe:language:: python

         .. oe:api:: python

            GetRacemicType() -> int

      Returns setting for the way to handle loss of stereocenters, if the
      :oe:meth:`OEProton::OETautomerOptions::GetSaveStereo` method returns ``false``.
      If the :oe:meth:`OEProton::OETautomerOptions::GetSaveStereo` method returns ``true``,
      this option is irrelevant.
      The returned value is from the :oe:constns:`OEProton::OERacemicType`
      namespace.
      The default value is :oe:const:`OEProton::OERacemicType::LocalSampled`.

      .. seealso::

         * :oe:meth:`OEProton::OETautomerOptions::GetSaveStereo` method
         * :oe:constns:`OEProton::OERacemicType` namespace

   .. oe:method:: GetRankTautomers

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRankTautomers() const

      .. oe:language:: python

         .. oe:api:: python

            GetRankTautomers() -> bool

      Returns setting for whether or not tautomers are ranked and
      ordered before being returned. By default, this is ``false``,
      i.e., the canonical tautomer is returned as the first molecule
      in the iterator. As opposed to the most "reasonable" tautomer
      being returned first.

   .. oe:method:: GetSaveStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSaveStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetSaveStereo() -> bool

      Returns setting for whether atoms and bonds with labeled
      stereochemistry are fixed or allowed to participate in
      tautomerization.

      .. seealso::

         * :oe:meth:`OEProton::OETautomerOptions::GetRacemicType` method

.. _OEProton_OETautomerOptions_SetApplyWarts:

   .. oe:method:: SetApplyWarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetApplyWarts(bool warts)

      .. oe:language:: python

         .. oe:api:: python

            SetApplyWarts(warts: bool) -> None

      Sets whether warts of {title}_1, {title}_2, etc., are added to tautomers.

.. _OEProton_OETautomerOptions_SetCarbonHybridization:

   .. oe:method:: SetCarbonHybridization

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCarbonHybridization(bool carbonHybrid)

      .. oe:language:: python

         .. oe:api:: python

            SetCarbonHybridization(carbonHybrid: bool) -> None

      Sets whether carbon hybridization changes are allowed.  Allowing
      sp2-sp3 changes of carbon atoms can significantly increase
      computation time.

      .. seealso::

         * :oe:meth:`OEProton::OETautomerOptions::SetHybridizationLevel` method

   .. oe:method:: SetClearCoordinates

      .. oe:api::

         bool SetClearCoordinates(bool clear_coordinates)

      Sets whether input coordinates are cleared from generated tautomers.

   .. oe:method:: SetHybridizationLevel

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHybridizationLevel(unsigned int level)

      .. oe:language:: python

         .. oe:api:: python

            SetHybridizationLevel(level: int) -> None

      Sets level of hybridization changes allowed for carbon atoms
      if the :oe:meth:`OEProton::OETautomerOptions::GetCarbonHybridization` method returns ``true``.
      If the :oe:meth:`OEProton::OETautomerOptions::GetCarbonHybridization` method returns ``false``,
      this option is irrelevant.

      **level**
         This value has to be from the :oe:constns:`OEProton::OEHybridizationLevel`
         namespace.

      .. note::

         The level of hybridization can have significantly impact on the
         computation time.

      .. seealso::

         * :oe:meth:`OEProton::OETautomerOptions::SetCarbonHybridization` method
         * :oe:constns:`OEProton::OEHybridizationLevel` namespace

   .. oe:method:: SetKekule

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetKekule(bool kekule)

      .. oe:language:: python

         .. oe:api:: python

            SetKekule(kekule: bool) -> None

      Sets whether tautomers are returned in kekule format or have aromaticity perceived.

   .. oe:method:: SetLevel

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLevel(unsigned int level)

      .. oe:language:: python

         .. oe:api:: python

            SetLevel(level: int) -> None

      Sets level for tautomerization. Higher levels allow less likely
      atomic transitions to occur.

.. _OEProton_OETautomerOptions_SetMaxSearchTime:

   .. oe:method:: SetMaxSearchTime

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxSearchTime(float maxSearchTime)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxSearchTime(maxTime: float) -> None

      Sets the maximum search time in seconds allowed for a molecule.

.. _OEProton_OETautomerOptions_SetMaxTautomericAtoms:

   .. oe:method:: SetMaxTautomericAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxTautomericAtoms(unsigned int maxTautomerAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxTautomericAtoms(maxTautomericAtoms: int) -> None

      Sets the maximum number of tautomeric atoms allowed in a molecule.

.. _OEProton_OETautomerOptions_SetMaxTautomersGenerated:

   .. oe:method:: SetMaxTautomersGenerated

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxTautomersGenerated(unsigned int max)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxTautomersGenerated(max: int) -> None

      Sets the maximum number of tautomers that may be generated per input molecule.

      .. seealso::

         * :oe:meth:`OEProton::OETautomerOptions::SetMaxTautomersToReturn` method

.. _OEProton_OETautomerOptions_SetMaxTautomersToReturn:

   .. oe:method:: SetMaxTautomersToReturn

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxTautomersToReturn(unsigned int max)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxTautomersToReturn(max: int) -> None

      Sets the maximum number of tautomers that may be returned per input molecule.

      .. seealso::

         * :oe:meth:`OEProton::OETautomerOptions::SetMaxTautomersGenerated` method

.. _OEProton_OETautomerOptions_SetMaxZoneSize:

   .. oe:method:: SetMaxZoneSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxZoneSize(unsigned int maxZoneSize)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxZoneSize(maxZoneSize: int) -> None

      Sets the maximum number of atoms allowed in a continuous tautomerization zone.

.. _OEProton_OETautomerOptions_SetRacemicType:

   .. oe:method:: SetRacemicType

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRacemicType(unsigned int racemicType)

      .. oe:language:: python

         .. oe:api:: python

            SetRacemicType(raceType: int) -> None

      Sets the racemic type for loss of stereocenters if the
      :oe:meth:`OEProton::OETautomerOptions::GetSaveStereo` method returns ``false``.
      If the :oe:meth:`OEProton::OETautomerOptions::GetSaveStereo` method returns ``true``,
      this option is irrelevant.

      **racemicType**
         This value has to be from the :oe:constns:`OEProton::OERacemicType`
         namespace.

      .. seealso::

         * :oe:meth:`OEProton::OETautomerOptions::SetSaveStereo` method
         * :oe:constns:`OEProton::OERacemicType` namespace

   .. oe:method:: SetRankTautomers

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRankTautomers(bool rank)

      .. oe:language:: python

         .. oe:api:: python

            SetRankTautomers(rank: bool) -> None

      Sets whether or not tautomers are ranked and ordered before
      being returned. Setting this argument to ``true`` will cause the
      most "reasonable" tautomer to be returned as the first tautomer,
      opposed to the "canonical" tautomer being returned first.

      The "canonical" tautomer may or may not be a suitable
      representative tautomer for depiction. To fill this role, the
      :oe:meth:`SetRankTautomers(true) <OEProton::OETautomerOptions::SetRankTautomers>`
      provides "reasonable" tautomer forms for any input molecule.

.. _OEProton_OETautomerOptions_SetSaveStereo:

   .. oe:method:: SetSaveStereo

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSaveStereo(bool saveStereo)

      .. oe:language:: python

         .. oe:api:: python

            SetSaveStereo(saveStereo: bool) -> None

      Sets whether atoms and bonds with labeled stereochemistry are fixed or
      allowed to participate in tautomerization.

      .. seealso::

         * :oe:meth:`OEProton::OETautomerOptions::SetRacemicType` method


*******************************************************************************
Preliminary OEProton Class
*******************************************************************************

.. oe:namespace:: OEProton

.. toctree::

   OEChargeParameter
   OEMultistatepKaModel
   OEMultistatepKaModelOptions


.. oe:namespace:: OEProton

.. meta::
   :keywords: OETautomerMolFunction, TautomerMolFunction

.. _OEProton_OETautomerMolFunction:

.. oe:class:: OETautomerMolFunction

   .. oe:api::

      class OETautomerMolFunction : public OEMolFunctionBase

   .. warning::
      This class is deprecated.  Use :ref:`OETautomerOptions <OEProton_OETautomerOptions>` instead.

   Currently
   ``OETautomerMolFunction`` and :ref:`OETyperMolFunction <OEProton_OETyperMolFunction>`
   are similar, however it is expected that they will diverge more
   over time.  They share the same first four arguments.  The first
   argument is the oemolstream where the enumerated molecules will be
   placed.  The second argument is a boolean indicating whether
   aromaticity should be calculated for the enumerated structure.  The
   third argument is a boolean indicating whether the enumerated
   states should only be counted (rather than actually listed).  The
   fourth argument is an unsigned int indicating the maximum number of
   states that should be enumerated for any single input molecule.
   The fifth argument for ``OETautomerMolFunction`` states whether
   a 'reasonable' type calculation is being setup and only the most
   aromatic tautomer should be stored.  After the calculation, the
   most aromatic tautomer can be retrieved using
   :oe:meth:`OEProton::OETautomerMolFunction::GetMolecule`.  The sixth argument
   will label the output tautomer titles with @`number` appended.  When using
   the same ``OETautomerMolFunction`` instance for multiple tautomer
   runs, remember to call
   :oe:meth:`OEProton::OETautomerMolFunction::Reset` in between each
   run.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETautomerMolFunction(OEChem::oemolostream& ofp, bool arom,
                                  bool ct = false, unsigned int max = 0,
                                  bool mostAro = false, bool warts = true)

      .. oe:language:: python

         .. oe:api:: python

            OETautomerMolFunction(ofp: oemolostream, arom: bool,
                                  ct: bool = False, max: int = 0,
                                  mostAro: bool = False, warts: bool = True) -> OETautomerMolFunction

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETautomerMolFunction & operator=(const OETautomerMolFunction &)

      Assignment operator.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEChem::OEMolBase& inmol)

      .. oe:language:: python

         .. oe:api:: python

            __call__(inmol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMolFunctionBase

   .. oe:method:: GetCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetCount() -> int

   Returns the number of tautomers generated. Calling
   :oe:meth:`OEProton::OETautomerMolFunction::Reset` will reset this
   number to zero.

   .. oe:method:: GetMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase& GetMolecule() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolecule() -> OEGraphMol

   This method is used in conjunction with the mostAro flag to retrieve
   a reasonable looking tautomer.

   .. oe:method:: Reset

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Reset()

      .. oe:language:: python

         .. oe:api:: python

            Reset() -> None

   This method resets the count to zero and clears the stored molecule
   that :oe:meth:`OEProton::OETautomerMolFunction::GetMolecule` has
   access to.



.. oe:namespace:: OEProton

.. meta::
   :keywords: OETyperMolFunction, TyperMolFunction

.. _OEProton_OETyperMolFunction:

.. oe:class:: OETyperMolFunction

   .. oe:api::

      class OETyperMolFunction : public OEMolFunctionBase

   Currently
   ``OETyperMolFunction`` and :ref:`OETautomerMolFunction <OEProton_OETautomerMolFunction>`
   are similar, however it is expected that they will diverge more
   over time.  They share the same first four arguments.  The first
   argument is the oemolstream where the enumerated molecules will be
   placed.  The second argument is a boolean indicating whether
   aromaticity should be calculated for the enumerated structure.  The
   third argument is a boolean indicating whether the enumerated
   states should only be counted (rather than actually listed).  The
   fourth argument is an unsigned int indicating the maximum number of
   states that should be enumerated for any single input molecule.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETyperMolFunction(OEChem::oemolostream& ofp, bool arom,
                               bool ct = false, unsigned int max = 0)

      .. oe:language:: python

         .. oe:api:: python

            OETyperMolFunction(ofp: oemolostream, arom: bool, ct: bool = False,
                               max: int = 0) -> OETyperMolFunction

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETyperMolFunction & operator=(const OETyperMolFunction &)

      Assignment operator.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEChem::OEMolBase& inmol)

      .. oe:language:: python

         .. oe:api:: python

            __call__(inmol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMolFunctionBase

   .. oe:method:: Reset

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Reset()

      .. oe:language:: python

         .. oe:api:: python

            Reset() -> None

   This method will reset the internal counter and should be called
   before reusing an :ref:`OETyperMolFunction <OEProton_OETyperMolFunction>` instance.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. oe:constnamespace:: OEAdjTypeAtNeutralpH

   .. attention::

      |PRELIMINARY-API|

   This namespace contains constants used by the class 
   :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>` to define what
   adjustment is to apply to the atom according to the multistate model.

   .. seealso::

      * :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>` class
      * :oe:constns:`OEProton::OEpKaRange` constants namespace
      * :oe:constns:`OEProton::OEMultistatepKaModelpH` constants namespace
      * :oe:func:`OEProton::OEGetAtomAdjTypeAtNeutralpHName` function
      * :oe:func:`OEProton::OEGetAtomAdjTypeAtNeutralpHType` function

   .. oe:constant:: Deprotonation

      The atom with this tag will be deprotonated to generate a favored ionization state.
      
   .. oe:constant:: NoChange

      The atom with this tag will not be modified in generated ionization state.

   .. oe:constant:: NoChangeAndDeprotonation

      Two different ionization states will be generated for the atom with this tag. In one
      of them atom will not be changed and in another state the atom will be deprotonated.

   .. oe:constant:: NoChangeAndProtonation

      Two different ionization states will be generated for the atom with this tag. In one
      of them atom will not be changed and in another state the atom will be protonated.

   .. oe:constant:: Protonation

      The atom with this tag will be protonated to generate a favored ionization state.

   .. oe:constant:: Unknown

      This constant represents an undefined or illegal context state.


.. oe:namespace:: OEProton

.. oe:constnamespace:: OECharges

   This namespace contains constants used by the deprecated function
   :oe:func:`OEAssignPartialCharges<OEProton::OEAssignPartialCharges>` to
   define which charge model to apply. This function is being replaced by
   :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>` which uses an
   object that defines the charge model and any required pre-processing.

   .. seealso:

         * :oe:func:`OEProton::OEAssignCharges` function
         * :oe:func:`OEProton::OEAssignPartialCharges` function
         * :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>` abstract base class

   .. _OEProton_OECharges_AM1:

   .. oe:constant:: AM1

      AM1 Mulliken-type charges. A full AM1 geometry optimization is done.

   .. _OEProton_OECharges_AM1BCC:

   .. oe:constant:: AM1BCC

      AM1 Mulliken-type charges with bond-charge corrections.
      The AM1 optimization is lightly restrained to starting coordinates but no
      partial charge symmetrization is done (same as :oe:const:`OEProton::OECharges::AM1BCCNoSym`).

      .. note::

         Note that this differs from the "standard" *AM1BCC* charging scheme as published,
         where symmetrization is done (same as :oe:const:`OEProton::OECharges::AM1BCCSym`).

   .. _OEProton_OECharges_AM1BCCNoSym:

   .. oe:constant:: AM1BCCNoSym

      AM1 Mulliken-type charges with bond-charge corrections.
      The AM1 optimization is lightly restrained to starting coordinates but no
      partial charge symmetrization is done.

   .. _OEProton_OECharges_AM1BCCNoSymSPt:

   .. oe:constant:: AM1BCCNoSymSPt

      AM1 Mulliken-type charges with bond-charge corrections. Neither AM1 geometry optimization
      nor partial charge symmetrization is done.

   .. _OEProton_OECharges_AM1BCCSPt:

   .. oe:constant:: AM1BCCSPt

      AM1 Mulliken-type charges with bond-charge corrections. Neither AM1 geometry optimization
      nor partial charge symmetrization is done.
      (same as :oe:const:`OEProton::OECharges::AM1BCCNoSymSPt`).

   .. _OEProton_OECharges_AM1BCCSym:

   .. oe:constant:: AM1BCCSym

      AM1 Mulliken-type charges with bond-charge corrections.
      The AM1 optimization is lightly restrained to starting coordinates and
      partial charges are symmetrized with respect to bond-topologically equivalent atoms.

   .. _OEProton_OECharges_AM1BCCSymSPt:

   .. oe:constant:: AM1BCCSymSPt

      AM1 Mulliken-type charges with bond-charge corrections; no AM1 geometry optimization is done.
      Partial charges are symmetrized with respect to bond-topologically equivalent atoms.

   .. _OEProton_OECharges_AM1SPt:

   .. oe:constant:: AM1SPt

      AM1 Mulliken-type charges; no AM1 geometry optimization is done.

   .. _OEProton_OECharges_AmberFF94:

   .. oe:constant:: AmberFF94

      Amber force field 94 charges for standard amino acids.

   .. _OEProton_OECharges_AmberFF99:

   .. oe:constant:: AmberFF99

      Amber force field 99 charges
      (same charges as :oe:const:`OEProton::OECharges::AmberFF94`).

   .. _OEProton_OECharges_AmberFF99SB:

   .. oe:constant:: AmberFF99SB

      Amber force field 99SB charges
      (same charges as :oe:const:`OEProton::OECharges::AmberFF94`).

   .. _OEProton_OECharges_AmberFF99bsc0:

   .. oe:constant:: AmberFF99bsc0

      Amber force field 99bc0 charges
      (same charges as :oe:const:`OEProton::OECharges::AmberFF94`).

   .. _OEProton_OECharges_Default:

   .. oe:constant:: Default

      The current default charges, which are :oe:const:`OEProton::OECharges::MMFF94`.

   .. _OEProton_OECharges_Formal:

   .. oe:constant:: Formal

      Copies the formal charge field of atoms into the partial charge
      field.

   .. _OEProton_OECharges_Gasteiger:

   .. oe:constant:: Gasteiger

      Assigns Gasteiger partial charges.

   .. _OEProton_OECharges_Initial:

   .. oe:constant:: Initial

      Smears unit charges in the partial charge
      field onto resonance shared atoms.

   .. _OEProton_OECharges_MMFF94:

   .. oe:constant:: MMFF94

      Assigns MMFF94 partial charges.

   .. _OEProton_OECharges_Max:

   .. oe:constant:: Max

      Number of charge type constants.

   .. _OEProton_OECharges_NoOp:

   .. oe:constant:: NoOp

      No operation is performed.  This setting is useful for indicating that
      charges originated elsewhere, such as user input, and have not been
      changed.

   .. _OEProton_OECharges_None:

   .. oe:constant:: None

      Remove all partial charges.

   .. _OEProton_OECharges_OPLS:

   .. oe:constant:: OPLS

      OPLS protein dictionary charges.

      .. warning::

         This charging model is deprecated.
         The :oe:func:`OEProton::OEAssignPartialCharges` function will throw a deprecated
         warning message when calling it with this charging model.


.. oe:namespace:: OEProton

.. oe:constnamespace:: OEChargingRequirement

   This namespace contains constants that describe requirements of
   charge model objects derived from the :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`
   abstract base class.

   .. oe:constant:: AltersResidueName

   .. oe:constant:: BondedResidues

   .. oe:constant:: Compact

   .. oe:constant:: Coords3D

   .. oe:constant:: ExplicitHydrogens

   .. oe:constant:: MolComplexPrep

   .. oe:constant:: MultiConfOnly

   .. oe:constant:: Nothing

   .. oe:constant:: PDBOrder

   .. oe:constant:: Parameters

   .. oe:constant:: Precharged

   .. oe:constant:: ResPerceived

   .. oe:constant:: ReturnSelectedConfs

   .. oe:constant:: SetsAromaticity

   .. oe:constant:: SetsType

   .. oe:constant:: SizeWithinLimits

   .. oe:constant:: StandardResidues


.. oe:namespace:: OEProton

.. oe:constnamespace:: OEHybridizationLevel

   This namespace contains constants used by the class
   :ref:`OETautomerOptions <OEProton_OETautomerOptions>` to store the level of carbon
   hybridization.

   .. seealso::

      * :ref:`OETautomerOptions <OEProton_OETautomerOptions>` class
      * :oe:meth:`OEProton::OETautomerOptions::GetHybridizationLevel` method
      * :oe:meth:`OEProton::OETautomerOptions::SetHybridizationLevel` method

   .. oe:constant:: Default

      The default value is :oe:const:`OEProton::OEHybridizationLevel::EnolEnamine`.

   .. oe:constant:: Original

      If carbon hybridization is set, then extensive carbon hybridization will take place.

   .. oe:constant:: DoubleBondNbr

      If carbon hybridization is set, then only localized carbon hybridzation will take place,
      allowing generation of keto-enol tautomers without generating as many extreme tautomers
      as the default parameter.

   .. oe:constant:: EnolEnamine

      If carbon hybridization is set, then local hybridization will take place to allow
      keto-enol and enol-enamine tautomerization while generating fewer tautomers than other
      options above.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. oe:constnamespace:: OEMultistatepKaModelpH

   .. attention::

      |PRELIMINARY-API|

   This namespace contains constants used by the class 
   :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>` and
   :ref:`OEMultistatepKaModelOptions <OEProton_OEMultistatepKaModelOptions>` to define the pH
   at which the multistate model assesses the pKa.

   .. seealso::

      * :ref:`OEMultistatepKaModelOptions <OEProton_OEMultistatepKaModelOptions>` class
      * :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>` class
      * :oe:constns:`OEProton::OEAdjTypeAtNeutralpH` constants namespace
      * :oe:constns:`OEProton::OEMultistatepKaModelpH` constants namespace
      * :oe:func:`OEProton::OEGetMultistatepKaModelpHName` function
      * :oe:func:`OEProton::OEGetMultistatepKaModelpHType` function

   .. oe:constant:: Neutral

      MultistatepKaModel assesses the pKa at Neutral pH (physiological pH i.e. 7.4).

   .. oe:constant:: Unknown

      This constant represents an undefined or illegal context state.


.. _OEProtonConstants:

*******************
OEProton Constants
*******************

.. oe:namespace:: OEProton

.. toctree::

   OECharges
   OEChargingRequirement
   OEHybridizationLevel
   OERacemicType



.. oe:namespace:: OEProton

.. oe:constnamespace:: OERacemicType

   This namespace contains constants used by the class
   :ref:`OETautomerOptions <OEProton_OETautomerOptions>` that stores the stereo
   loss behavior when the :oe:meth:`OEProton::OETautomerOptions::GetSaveStereo` method returns
   ``false``.

   .. note::

      If the :oe:meth:`OEProton::OETautomerOptions::GetSaveStereo` method returns ``true``,
      this flag is irrelevant.

   .. seealso::

      * :ref:`OETautomerOptions <OEProton_OETautomerOptions>` class
      * :oe:meth:`OEProton::OETautomerOptions::GetSaveStereo` method
      * :oe:meth:`OEProton::OETautomerOptions::SetSaveStereo` method

   .. oe:constant:: Default

      The default value is :oe:const:`OEProton::OERacemicType::LocalSampled`.

   .. oe:constant:: None

      This option indicates that no racemic type will be set.

   .. oe:constant:: LocalSampled

      This option indicates that individual tautomers that have double
      bonds to tetrahedral stereocenters will have the stereo removed.

   .. oe:constant:: EverSampled

      This option indicates that if an atom which are tetrahedral
      stereocenters has a double bonds in any of the tautomers returned by the function, then those
      tetrahedral stereocenters will have the stereo removed in ALL of the returned tautomers.


.. _preliminary_OEProtonConstants:

******************************
Preliminary OEProton Constants
******************************

.. oe:namespace:: OEProton

.. toctree::

   OEAdjTypeAtNeutralpH
   OEMultistatepKaModelpH
   OEpKaRange


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. oe:constnamespace:: OEpKaRange

   .. attention::

      |PRELIMINARY-API|

   This namespace contains constants used by the class 
   :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>` to define what is
   the assessed atomic pKa range of the atom according to the multistate model.

   .. seealso::

      * :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>` class
      * :oe:constns:`OEProton::OEAdjTypeAtNeutralpH` constants namespace
      * :oe:constns:`OEProton::OEMultistatepKaModelpH` constants namespace
      * :oe:func:`OEProton::OEGetAtompKaRangeName` function
      * :oe:func:`OEProton::OEGetAtompKaRangeType` function

   .. oe:constant:: Acidic

      The atom has Acidic pka range (<6.4).

   .. oe:constant:: Basic

      The atom has Basic pka range (>8.4).

   .. oe:constant:: Neutral

      The atom has Neutral pka range (between 6.4 and 8.4).

   .. oe:constant:: Unidentified

      The atom's pKa range is unidentified by the multistate pka model.

   .. oe:constant:: Unknown

      This constant represents an undefined or illegal context state.



.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEAssignCharges, AssignCharges

.. _OEProton_OEAssignCharges:

.. oe:function:: OEAssignCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAssignCharges(OEChem::OEMolBase& mol,
                              const OEChargeEngineBase& chargeEngine)
         bool OEAssignCharges(OEChem::OEMCMolBase& mcMol,
                              const OEChargeEngineBase& chargeEngine)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignCharges(mol: Union[OEGraphMol,OEQMol],
                         chargeEngine: OEChargeEngineBase) -> bool
         OEAssignCharges(mcMol: OEMol, chargeEngine: OEChargeEngineBase) -> bool

   .. note::

      This function is designed to replace the legacy function
      :oe:func:`OEAssignPartialCharges<OEProton::OEAssignPartialCharges>`.

   This function sets the charge of each atom in the
   molecule ``mol`` based on the specific nature of the
   :oe:cls:`chargeEngine<OEProton::OEChargeEngineBase>` object
   passed as the second argument. In general, charge engine implementations place
   scalar partial charges on atoms, but could be implemented to perform
   other roles such as assign multi-pole charges.

   .. oe:source:: AssignChargesDoc.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-ASSIGN-CHARGES-MMFF
      :refnum:   1
      :caption:  Assigning MMFF Partial Charges to a Molecule

   .. oe:source:: AssignChargesDoc.py
      :language: python
      :noindent:
      :frag:     SNIPPET-ASSIGN-CHARGES-MMFF
      :refnum:   1
      :caption:  Assigning MMFF Partial Charges to a Molecule

   .. oe:source:: AssignChargesDoc.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ASSIGN-CHARGES-MMFF
      :refnum:   1
      :caption:  Assigning MMFF Partial Charges to a Molecule

   .. oe:source:: AssignChargesDoc.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ASSIGN-CHARGES-MMFF
      :refnum:   1
      :caption:  Assigning MMFF Partial Charges to a Molecule

   Another example:

   .. oe:source:: AssignChargesDoc.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-ASSIGN-CHARGES-OPTIONS-PARAM
      :refnum:   2
      :caption:  Assigning Unoptimized AM1 Partial Charges

   .. oe:source:: AssignChargesDoc.py
      :language: python
      :noindent:
      :frag:     SNIPPET-ASSIGN-CHARGES-OPTIONS-PARAM
      :refnum:   2
      :caption:  Assigning Unoptimized AM1 Partial Charges

   .. oe:source:: AssignChargesDoc.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ASSIGN-CHARGES-OPTIONS-PARAM
      :refnum:   2
      :caption:  Assigning Unoptimized AM1 Partial Charges

   .. oe:source:: AssignChargesDoc.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ASSIGN-CHARGES-OPTIONS-PARAM
      :refnum:   2
      :caption:  Assigning Unoptimized AM1 Partial Charges

   The objects used by this function, derived from the abstract base class
   :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`, can be thought of as "options objects"
   which describe the details of a specific charge model.
   :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>` analyzes these options
   and may need to add explicit hydrogens or perceive residues before assigning
   charges.

   .. oe:source:: AssignChargesDoc.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-ASSIGN-CHARGES-OPTIONS-METHOD
      :refnum:   3
      :caption:  Assigning Non-symmetrized AM1BCC Partial Charges

   .. oe:source:: AssignChargesDoc.py
      :language: python
      :noindent:
      :frag:     SNIPPET-ASSIGN-CHARGES-OPTIONS-METHOD
      :refnum:   3
      :caption:  Assigning Non-symmetrized AM1BCC Partial Charges

   .. oe:source:: AssignChargesDoc.java
      :language: java
      :noindent:
      :frag:     SNIPPET-ASSIGN-CHARGES-OPTIONS-METHOD
      :refnum:   3
      :caption:  Assigning Non-symmetrized AM1BCC Partial Charges

   .. oe:source:: AssignChargesDoc.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-ASSIGN-CHARGES-OPTIONS-METHOD
      :refnum:   3
      :caption:  Assigning Non-symmetrized AM1BCC Partial Charges

   Some prerequisites, such as setting the aromaticity model,
   would alter the input molecule in ways that are incidental to the calculation.
   In this case, a copy of the input molecule is made before the alterations are
   made and the charges are transferred back to the input molecule after the
   calculation. This ensures that only charges, explicit hydrogens,
   residue perception, residue names, and the number of conformations returned
   can change on the input molecule.

   This function returns ``false`` if does not succeed.

   .. seealso::

      * :oe:func:`OEProton::OEAssignPartialCharges` function
      * :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>` abstract base class
      * :ref:`section_examples_summary_assigncharges` code example



.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEAssignPartialCharges, AssignPartialCharges

.. oe:function:: OEAssignPartialCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAssignPartialCharges(OEChem::OEMolBase& mol,
                                     unsigned int method = OECharges::Default,
                                     bool noHydrogen = false,
                                     bool debug = false, bool epsilon2 = false)
         bool OEAssignPartialCharges(OEChem::OEMCMolBase& mol,
                                     unsigned int method = OECharges::Default,
                                     bool noHydrogen = false,
                                     bool debug = false, bool epsilon2 = false)

   .. oe:language:: python

      .. oe:api:: python

         OEAssignPartialCharges(mol: Union[OEGraphMol,OEQMol], method: int,
                                noHydrogen: bool = False, debug: bool = False,
                                epsilon2: bool = False) -> bool
         OEAssignPartialCharges(mol: OEMol, method: int,
                                noHydrogen: bool = False, debug: bool = False,
                                epsilon2: bool = False) -> bool

   .. note::

      This deprecated function will not be developed further. It is being replaced by
      :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>` which provides
      more control and greater expandability.

   This function sets the partial charge value of each atom in a
   molecule.  The molecule to be charged is passed as the first
   argument.  The second argument is the charge model to be used.
   These values should be selected from the
   :oe:constns:`OEProton::OECharges` namespace.  The third argument is
   a boolean for whether the final molecule should have explicit
   hydrogens.  If ``noHydrogen`` is set to true, all hydrogens will be
   made implicit, and the charge on each heavy atom with attached
   hydrogens will be adjusted to be the sum of its original partial
   charge and all of the attached hydrogen partial charges.  The
   ``debug`` flag controls the volume of debug information written to
   standard error.  This function returns a boolean value evaluating
   the success of the calculation.

   This function is overloaded to accept an ``OEMolBase`` or an
   ``OEMCMolBase``.  Currently, only ``AM1`` and ``AM1BCC`` charges
   have specialized multiconformer implementations in the
   ``OEMCMolBase`` overload.  For all other charges, the
   ``OEMCMolBase`` and ``OEMolBase`` implementations are identical.
   The ``epsilon2`` flag selects an alternative parameterization of the
   AM1-BCC charge model when set to ``true``. [default = false]

   .. seealso::

      * :oe:func:`OEProton::OEAssignCharges` function



.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEEnumerateFormalCharges

.. oe:function:: OEEnumerateFormalCharges

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEMolBase>* OEEnumerateFormalCharges(const OEChem::OEMolBase& mol,
                                                                           const OEFormalChargeOptions& formalChargeOptions = OEFormalChargeOptions())
         OESystem::OEIterBase<OEChem::OEMolBase>* OEEnumerateFormalCharges(const OEChem::OEMCMolBase& mol,
                                                                           const OEFormalChargeOptions& formalChargeOptions = OEFormalChargeOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEEnumerateFormalCharges(mol: OEMol,
                                  formalChargeOptions: OEFormalChargeOptions = OEFormalChargeOptions()) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]
         OEEnumerateFormalCharges(mol: Union[OEGraphMol,OEQMol],
                                  formalChargeOptions: OEFormalChargeOptions = OEFormalChargeOptions()) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

   This function takes a const input molecule and variants of that molecule different
   formal charges are
   returned as an ``OESystem::OEIterBase<OEChem::OEMolBase> *``.  Options are set with an
   :ref:`OEFormalChargeOptions <OEProton_OEFormalChargeOptions>`, a parameter that is not required.
   See the corresponding documentation for descriptions of options.

   .. warning::
      The following version of OEEnumerateFormalCharges is deprecated.
      Use the above :ref:`OEFormalChargeOptions <OEProton_OEFormalChargeOptions>` version instead.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEEnumerateFormalCharges(OEChem::OEMolBase& mol,
                                               OEMolFunctionBase& mfb,
                                               bool verbose = false)

   .. oe:language:: python

      .. oe:api:: python

         OEEnumerateFormalCharges(mol: Union[OEGraphMol,OEMol,OEQMol],
                                  mfb: OEMolFunctionBase, verbose: bool = False) -> int

   This function has three arguments.  The first is the non-const
   molecule whose formal charges are to be enumerated.  For details of
   the enumeration process, please see :ref:`chapter_pkatypertheory`.
   The second argument is a functor call-back.  The functor's
   ``operator()`` is called with each new protonation state
   enumerated.  The enumeration will continue until the functor
   returns false or until the enumeration is complete.  The third
   argument determines if verbose atom-type information should be
   written to standard out.  The function will return the total number
   of states which were enumerated.



.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEEnumerateTautomers

.. oe:function:: OEEnumerateTautomers

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEMolBase>* OEEnumerateTautomers(const OEChem::OEMolBase& mol,
                                                                       const OETautomerOptions& tautomerOptions)
         OESystem::OEIterBase<OEChem::OEMCMolBase>* OEEnumerateTautomers(const OEChem::OEMCMolBase& mol,
                                                                         const OETautomerOptions& tautomerOptions)

   .. oe:language:: python

      .. oe:api:: python

         OEEnumerateTautomers(mol: OEMol, tautomerOptions: OETautomerOptions) -> Iterable[OEMol]
         OEEnumerateTautomers(mol: Union[OEGraphMol,OEQMol],
                              tautomerOptions: OETautomerOptions) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

   This function takes a const input molecule that is to be tautomerized and the tautomers are
   returned as an ``OESystem::OEIterBase<OEChem::OEMolBase> *``.  Options are set with an
   :ref:`OETautomerOptions <OEProton_OETautomerOptions>`.  See the corresponding documentation for
   descriptions of options.  Aromaticity must be perceived on the input molecule before calling
   this function.

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEEnumerateTautomers(OEChem::OEMolBase& mol,
                                           OEMolFunctionBase& mfb,
                                           unsigned int allflag = 0,
                                           bool ch3flag = false,
                                           bool saveStereo = false,
                                           float maxTime = 120)

   .. oe:language:: python

      .. oe:api:: python

         OEEnumerateTautomers(mol: Union[OEGraphMol,OEMol,OEQMol],
                              mfb: OEMolFunctionBase, allflag: int = 0,
                              ch3flag: bool = False, saveStereo: bool = False,
                              maxTime: float = 120) -> int

   .. warning::

      This version of :oe:func:`OEProton::OEEnumerateTautomers` is
      deprecated.
      Use the above :ref:`OETautomerOptions <OEProton_OETautomerOptions>` version above instead.

   This function has four arguments.  The first argument in a
   non-const molecule that will be the basis for the tautomer
   enumeration.  For details of the enumeration process, please see
   :ref:`chapter_tautomerstheory`.  The second argument is a functor
   call-back.  The functor's ``operator()`` is called with each new
   tautomer state enumerated.  The enumeration will continue until the
   functor returns false or until the enumeration is complete.  The
   third argument is an ``unsigned int`` which indicates the maximum
   acceptable energetic category of enumerated tautomers.  The
   function will return all categories of tautomers from the lowest
   available up to this cutoff.  If the only available level is higher
   than the cutoff, that single level of tautomers will be enumerated.
   This control is in addition to the call-back control.  Finally, the
   ``bool ch3flag`` argument controls whether tautomer enumeration
   should include tautomerization of methyl and methylene groups
   adjacent to a conjugated system.  This allows
   cyclohexa-2,4-dien-1-one, ``O=C1CC=CC=C1``, to be canonicalized
   as a tautomer of phenol, ``Oc1ccccc1``.  Unfortunately, the
   combinatorial explosion from tautomerizing across the alpha carbon
   of amino acids means that this option should not be used when
   enumerating the tautomers of proteins and large peptides.  This
   function returns the total number of tautomers enumerated.

   A setting of ``saveStereo=true`` will prevent associated atoms or bonds
   from taking part in tautomerization if they have stereochemistry set.
   Stereochemistry can naturally be lost with the creation and removal of double bonds.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. meta::
   :keywords: OEGetAtomAdjTypeAtNeutralpHName

.. oe:function:: OEGetAtomAdjTypeAtNeutralpHName

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetAtomAdjTypeAtNeutralpHName(const unsigned int adjTypeID)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAtomAdjTypeAtNeutralpHName(adjTypeID: int) -> str

   This function returns a corresponding name for the
   given `adjTypeID` value from the :oe:constns:`OEProton::OEAdjTypeAtNeutralpH` namespace.

   .. seealso::

      * :oe:func:`OEProton::OEGetAtomAdjTypeAtNeutralpHType` function



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. meta::
   :keywords: OEGetAtomAdjTypeAtNeutralpHType

.. oe:function:: OEGetAtomAdjTypeAtNeutralpHType

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetAtomAdjTypeAtNeutralpHType(const std::string& adjTypeName)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAtomAdjTypeAtNeutralpHType(adjTypeName: str) -> int

   This function returns the constant from the
   :oe:constns:`OEProton::OEAdjTypeAtNeutralpH` namespace for the provided `adjTypeName`.

   .. seealso::

      * :oe:func:`OEProton::OEGetAtomAdjTypeAtNeutralpHName` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. meta::
   :keywords: OEGetAtompKaRangeName

.. oe:function:: OEGetAtompKaRangeName

  .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetAtompKaRangeName(const unsigned int pKaRangeID)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAtompKaRangeName(pKaRangeID: int) -> str

   This function returns a corresponding name for the
   given `pKaRangeID` value from the :oe:constns:`OEProton::OEpKaRange` namespace.

   .. seealso::

      * :oe:func:`OEProton::OEGetAtompKaRangeType` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. meta::
   :keywords: OEGetAtompKaRangeType

.. oe:function:: OEGetAtompKaRangeType

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetAtompKaRangeType(const std::string& pKaRangeName)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAtompKaRangeType(pKaRangeName: str) -> int

   This function returns the constant from the
   :oe:constns:`OEProton::OEpKaRange` namespace for the provided `pKaRangeName`.

   .. seealso::

      * :oe:func:`OEProton::OEGetAtompKaRangeName` function



.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEGetChargeTypeName

.. oe:function:: OEGetChargeTypeName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetChargeTypeName(unsigned int chargeType)

   .. oe:language:: python

      .. oe:api:: python

         OEGetChargeTypeName(chargeType: int) -> str

   This function returns the corresponding :oe:constns:`OEProton::OECharges`
   name for the `unsigned int chargeType` method.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. meta::
   :keywords: OEGetMultistatepKaModelpHName

.. oe:function:: OEGetMultistatepKaModelpHName

  .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetMultistatepKaModelpHName(const unsigned int pHType)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMultistatepKaModelpHName(pHType: int) -> str

   This function returns a corresponding name for the
   given `pHType` value from the :oe:constns:`OEProton::OEMultistatepKaModelpH` namespace.

   .. seealso::

      * :oe:func:`OEProton::OEGetMultistatepKaModelpHType` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEProton

.. meta::
   :keywords: OEGetMultistatepKaModelpHType

.. oe:function:: OEGetMultistatepKaModelpHType

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetMultistatepKaModelpHType(const std::string& pHName)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMultistatepKaModelpHType(pHName: str) -> int

   This function returns the constant from the
   :oe:constns:`OEProton::OEMultistatepKaModelpH` namespace for the provided `pHName`.

   .. seealso::

      * :oe:func:`OEProton::OEGetMultistatepKaModelpHName` function


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEGetReasonableProtomer

.. oe:function:: OEGetReasonableProtomer

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGetReasonableProtomer(OEChem::OEMolBase& mol)
         bool OEGetReasonableProtomer(OEChem::OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetReasonableProtomer(mol: Union[OEGraphMol,OEQMol]) -> bool
         OEGetReasonableProtomer(mol: OEMol) -> bool

   This function will attempt to produce a single protomer that will be a suitable
   representation of the molecule in a biological system.  This state is defined as
   an aqueous environment with pH~7.4 and a tautomer from among the predominate
   tautomers that is favored by medicinal chemists.  This function is intended to be
   suitable for preparing molecules to display to chemists.  The molecules are
   quite consistent, but should not be considered a canonical form in this version.

   .. seealso::

      * :oe:func:`OEProton::OEGetReasonableProtomers` function


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEGetReasonableProtomers

.. oe:function:: OEGetReasonableProtomers

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEMolBase>* OEGetReasonableProtomers(const OEChem::OEMolBase& mol)
         OESystem::OEIterBase<OEChem::OEMCMolBase>* OEGetReasonableProtomers(const OEChem::OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetReasonableProtomers(mol: Union[OEGraphMol,OEQMol]) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]
         OEGetReasonableProtomers(mol: OEMol) -> Iterable[OEMol]

   This function will attempt to produce a series of protomers that will be a suitable
   ensemble of the molecule in a biological system.  This state is defined as
   an aqueous environment with pH~7.4. The tautomers of the molecule are enumerated.  For each
   enumerated tautomer a single charge state representing the predominate ionization at pH 7.4 is
   chosen.  Ionization states of each charge state are NOT enumerated in this version.

   .. seealso::

      * :oe:func:`OEProton::OEGetReasonableProtomer` function
      * :oe:func:`OEProton::OEGetReasonableTautomers` function


.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEGetReasonableTautomers

.. _OEProton_OEGetReasonableTautomers:

.. oe:function:: OEGetReasonableTautomers

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEMolBase>* OEGetReasonableTautomers(const OEChem::OEMolBase& mol,
                                                                           const OETautomerOptions& opts = OETautomerOptions(),
                                                                           bool pKaNorm = true)
         OESystem::OEIterBase<OEChem::OEMCMolBase>* OEGetReasonableTautomers(const OEChem::OEMCMolBase& mol,
                                                                             const OETautomerOptions& opts = OETautomerOptions(),
                                                                             bool pKaNorm = true)

   .. oe:language:: python

      .. oe:api:: python

         OEGetReasonableTautomers(mol: Union[OEGraphMol,OEQMol],
                                  opts: OETautomerOptions = OETautomerOptions(),
                                  pKaNorm: bool = True) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]
         OEGetReasonableTautomers(mol: OEMol,
                                  opts: OETautomerOptions = OETautomerOptions(),
                                  pKaNorm: bool = True) -> Iterable[OEMol]

   This function takes a const input molecule that is to be tautomerized and the tautomers are
   returned as an iterator over molecules. The function is overloaded to handle both
   single (:ref:`OEMolBase <OEChem_OEMolBase>`) and multi-conformer (:ref:`OEMCMolBase <OEChem_OEMCMolBase>`)
   molecules. Aromaticity must be perceived on the input molecule before calling this function.

   *mol*
      The molecule being tautomerized.

   *opts*
      The :ref:`OETautomerOptions <OEProton_OETautomerOptions>` object that stores
      properties that influence tautomerization process.

   *pKaNorm*
     This parameter determines whether to apply pKa normalization.
     If ``true`` the ionization state of each tautomer will be assigned to a predominate state at pH~7.4.

   .. oe:source:: EnumerateTautomersWithOptions.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-EnumerateTautomersWithOptions
      :caption:  Example of tautomerizing a molecule

   .. oe:source:: EnumerateTautomersWithOptions.py
      :language: python
      :noindent:
      :frag:     SNIPPET-EnumerateTautomersWithOptions
      :caption:  Example of tautomerizing a molecule

   .. oe:source:: EnumerateTautomersWithOptions.java
      :language: java
      :noindent:
      :frag:     SNIPPET-EnumerateTautomersWithOptions
      :caption:  Example of tautomerizing a molecule

   .. oe:source:: EnumerateTautomersWithOptions.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-EnumerateTautomersWithOptions
      :caption:  Example of tautomerizing a molecule

   .. seealso::

      * :oe:func:`OEProton::OEEnumerateTautomers` function
      * :oe:func:`OEProton::OEGetReasonableProtomer` function
      * :oe:func:`OEProton::OEGetReasonableProtomers` function
      * :ref:`section_examples_summary_enumeratetautomers` code example



.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEGetUniqueProtomer

.. oe:function:: OEGetUniqueProtomer

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGetUniqueProtomer(OEChem::OEMolBase& dst,
                                  const OEChem::OEMolBase& mol)
         bool OEGetUniqueProtomer(OEChem::OEMCMolBase& dst,
                                  const OEChem::OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetUniqueProtomer(dst: Union[OEGraphMol,OEMol,OEQMol],
                             mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
         OEGetUniqueProtomer(dst: OEMol, mol: OEMol) -> bool

   This function will attempt to produce a single protomer that can be used to generate
   a canonical representation of all tautomers of this molecule. All charge states or tautomer
   representations of a molecule should generate the same unique tautomer.

   .. note::

      The unique protomer is NOT necessarily the low energy tautomer, or a scientifically reasonable
      tautomer.  It is a tautomer useful for generating canonical hash strings. The unique protomer
      can be used to generate single or multiple protomers suitable for visualization by passing then
      through the :oe:func:`OEProton::OEGetReasonableTautomers` functions.

   .. seealso::

      * :oe:func:`OEProton::OEGetReasonableTautomers` function


.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEGetEnumerateTautomers

.. oe:function:: OEHypervalentNormalization

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEHypervalentNormalization(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHypervalentNormalization(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   This function should be used in conjunction with :oe:func:`OEProton::OERemoveFormalCharge` to prepare a 
   molecule to be passed to the :oe:func:`OEProton::OEEnumerateTautomers` function.  These two normalization
   help the tautomer enumeration yield a higher proportion of lower-energy tautomers.

   .. seealso::

      * :oe:func:`OEProton::OEEnumerateTautomers`
      * :oe:func:`OEProton::OERemoveFormalCharge`



*******************************************************************************
Preliminary OEProton Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEGetAtomAdjTypeAtNeutralpHName.rst
   OEGetAtomAdjTypeAtNeutralpHType.rst
   OEGetAtompKaRangeName.rst
   OEGetAtompKaRangeType.rst
   OEGetMultistatepKaModelpHName.rst
   OEGetMultistatepKaModelpHType.rst


.. # split from OEProtonFunctions.rst:179

.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEQuacPacGetArch

.. oe:function:: OEQuacPacGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEQuacPacGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEQuacPacGetArch() -> str

   Returns the architecture on which the release was built



.. # split from OEProtonFunctions.rst:187

.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEQuacPacGetLicensee

.. oe:function:: OEQuacPacGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEQuacPacGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEQuacPacGetLicensee(licensee: str) -> bool

   Fills the parameter ``string &licensee`` with the licensee of the license file being used
   



.. # split from OEProtonFunctions.rst:196

.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEQuacPacGetPlatform

.. oe:function:: OEQuacPacGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEQuacPacGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEQuacPacGetPlatform() -> str

   Returns the platform on which the release of built



.. # split from OEProtonFunctions.rst:205

.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEQuacPacGetRelease

.. oe:function:: OEQuacPacGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEQuacPacGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEQuacPacGetRelease() -> str

   Returns the version number as a ``const char*`` in major.minor.bugfix form



.. # split from OEProtonFunctions.rst:214

.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEQuacPacGetSite

.. oe:function:: OEQuacPacGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEQuacPacGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEQuacPacGetSite(site: str) -> bool

   Fills the parameter ``string &licensee`` with the site on the license file being used



.. # split from OEProtonFunctions.rst:223

.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEQuacPacGetVersion

.. oe:function:: OEQuacPacGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEQuacPacGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEQuacPacGetVersion() -> int

   Returns the build date of the release.



.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OEQuacPacIsLicensed

.. oe:function:: OEQuacPacIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEQuacPacIsLicensed(const char* feature = 0,
                                  unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEQuacPacIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **Quacpac TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **Quacpac TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **Quacpac TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function



.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OERemoveFormalCharge

.. _OEProton_OERemoveFormalCharge:

.. oe:function:: OERemoveFormalCharge

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERemoveFormalCharge(OEChem::OEMolBase& mol)
         bool OERemoveFormalCharge(OEChem::OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OERemoveFormalCharge(mol: Union[OEGraphMol,OEQMol]) -> bool
         OERemoveFormalCharge(mol: OEMol) -> bool

   This function will attempt to remove all formal charges from ``mol`` in
   a manner that is consistent with adding and removing implicit or explicit
   protons.  This method will not create radicals and will not attach more
   protons to an atom than is acceptable in that atom's standard valence form.
   The formal charge of quaternary amines is not removed because removing it
   would create a hypervalent nitrogen.



.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OESetNeutralpHModel

.. _OEProton_OESetNeutralpHModel:

.. oe:function:: OESetNeutralpHModel

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetNeutralpHModel(OEChem::OEMolBase& mol)
         bool OESetNeutralpHModel(OEChem::OEMCMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OESetNeutralpHModel(mol: Union[OEGraphMol,OEQMol]) -> bool
         OESetNeutralpHModel(mol: OEMol) -> bool

   This function will attempt to set ``mol`` to the most energetically
   favorable ionization state for pH=7.4 using a rule-based system.  This
   function does not enumerate multiple states for any molecule.  In cases
   where the ionization is near 7.4 and could be represented by a mixture of
   states, the state that is likely to be most populated is chosen.

   .. seealso::

      * :ref:`section_examples_summary_neutralionization` code example


.. # split from OEProtonFunctions.rst:163

.. |product|   replace:: Quacpac TK


.. oe:namespace:: OEProton

.. meta::
   :keywords: OETautomersLargestZoneSize

.. oe:function:: OETautomersLargestZoneSize

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OETautomersLargestZoneSize(const OEChem::OEMolBase& mol,
                                                 const OETautomerOptions& tautomerOptions)
         unsigned int OETautomersLargestZoneSize(const OEChem::OEMolBase& mol,
                                                 unsigned maxZone = 0)

   .. oe:language:: python

      .. oe:api:: python

         OETautomersLargestZoneSize(mol: Union[OEGraphMol,OEMol,OEQMol],
                                    tautomerOptions: OETautomerOptions) -> int
         OETautomersLargestZoneSize(inmol: Union[OEGraphMol,OEMol,OEQMol],
                                    maxZone: int = 0) -> int

   This function returns the largest number of atoms in a continuous
   tautomerization zone for the molecule and
   :ref:`OETautomerOptions <OEProton_OETautomerOptions>` instance passed in as
   arguments.  The later function provides a convenient function that relies on the default tautomer options
   other than potentially the maxZone size.  The return value of this function plays a significant role in 
   determining the upper bounds of the runtime for tautomer calculations on the molecule.



*******************************************************************************
OEProton Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEAssignCharges.rst
   OEAssignPartialCharges.rst
   OEEnumerateFormalCharges.rst
   OEEnumerateTautomers.rst
   OEGetChargeTypeName.rst
   OEGetReasonableProtomer.rst
   OEGetReasonableProtomers.rst
   OEGetReasonableTautomers.rst
   OEGetUniqueProtomer.rst
   OEHypervalent.rst
   OEQuacPacGetArch.rst
   OEQuacPacGetLicensee.rst
   OEQuacPacGetPlatform.rst
   OEQuacPacGetRelease.rst
   OEQuacPacGetSite.rst
   OEQuacPacGetVersion.rst
   OEQuacPacIsLicensed.rst
   OERemoveFormalCharge.rst
   OESetNeutralpHModel.rst
   OETautomersLargestZoneSize.rst


.. _quacpac_part_api:

********************************
API
********************************

.. toctree::
   :maxdepth: 2

   OEProtonClasses/OEProtonClasses
   OEProtonConstants/OEProtonConstants
   OEProtonFunctions/index
   OEMolAM1Classes/OEMolAM1Classes
   OEMolAM1Constants/OEMolAM1Constants
   OEAM1BCCConstants/OEAM1BCCConstants
   OEAM1BCCFunctions/index

********************************
Preliminary API
********************************

.. toctree::
   :maxdepth: 2

   OEProtonClasses/OEProtonClasses-preliminary.rst
   OEProtonConstants/OEProtonConstants-preliminary.rst
   OEProtonFunctions/OEProtonFunctions-preliminary.rst



.. _chapter_bondordertheory:

********************************************************************************
Wiberg bond orders
********************************************************************************

Theory
================================================================================

The concept of bond order has been proposed by Wiberg \ [Wiberg-1966]_ \ as a
calculated bond property using orthonormalized atomic orbitals which are a
basis set for semi-empirical molecular orbitals. Originally it was formulated
for the CNDO basis set, but it might be extended to AM1 or PM3 methods.
Wiberg bond order is a measure of electron population overlap between
two atoms:

   :math:`W_{AB} = \sum\limits_{\mu \in  A} \sum\limits_{\nu \in B} P_{\mu\nu}^2`

where summation is over atomic orbitals :math:`\mu` on atom A and atomic
orbitals :math:`\nu` on atom B, and :math:`P_{\mu\nu}` is the corresponding
density matrix element. For non-bonded pairs of atoms in a molecule,
:math:`W_{AB}` is very low but always nonzero.

.. seealso::

   *  :oe:meth:`OEMolAM1::OEAM1Results::GetBondOrder` method


.. _quacpac_part_examples:

********************************
Examples
********************************

.. toctree::
   :maxdepth: 2

   quacpacexamples


.. _chapter_quacpacexamples:

********************************************************************************
Quacpac TK Examples
********************************************************************************

The following table lists the currently available **Quacpac TK** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`assigncharges<section_examples_summary_assigncharges>`
        - assigning charges
      * - :ref:`neutralionization<section_examples_summary_neutralionization>`
        - setting a neutral ionization state
      * - :ref:`enumeratetautomers<section_examples_summary_enumeratetautomers>`
        - enumerating tautomers
      * - :ref:`setreasonablechargestate<section_examples_summary_setreasonablechargestate>`
        - setting a reasonable charge state
      * - :ref:`wibergbondorders<section_examples_summary_wibergbondorders>`
        - obtaining Wiberg bond orders
      * - :ref:`applychargesoedu<section_examples_summary_applychargesoedu>`
        - Apply Charges to OEDesignUnit
      * - :ref:`enumerateionizationstatesatneutralph<section_examples_summary_enumerateionizationstatesatneutralph>`
        - Enumerate ionization states at neutral pH using OEMultistatepKaModel and OEMultistatepKaModelOptions

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`assigncharges<section_examples_summary_assigncharges>`
        - assigning charges
      * - :ref:`neutralionization<section_examples_summary_neutralionization>`
        - setting a neutral ionization state
      * - :ref:`enumeratetautomers<section_examples_summary_enumeratetautomers>`
        - enumerating tautomers
      * - :ref:`setreasonablechargestate<section_examples_summary_setreasonablechargestate>`
        - setting a reasonable charge state
      * - :ref:`wibergbondorders<section_examples_summary_wibergbondorders>`
        - obtaining Wiberg bond orders
      * - :ref:`applychargesoedu<section_examples_summary_applychargesoedu>`
        - Apply Charges to OEDesignUnit
      * - :ref:`enumerateionizationstatesatneutralph<section_examples_summary_enumerateionizationstatesatneutralph>`
        - Enumerate ionization states at neutral pH using OEMultistatepKaModel and OEMultistatepKaModelOptions

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`assigncharges<section_examples_summary_assigncharges>`
        - assigning charges
      * - :ref:`neutralionization<section_examples_summary_neutralionization>`
        - setting a neutral ionization state
      * - :ref:`enumeratetautomers<section_examples_summary_enumeratetautomers>`
        - enumerating tautomers
      * - :ref:`setreasonablechargestate<section_examples_summary_setreasonablechargestate>`
        - setting a reasonable charge state
      * - :ref:`wibergbondorders<section_examples_summary_wibergbondorders>`
        - obtaining Wiberg bond orders

**Examples:**

.. toctree::
   :maxdepth: 1

   examples_summary_assigncharges
   examples_summary_neutralionization
   examples_summary_getreasonabletautomers
   examples_summary_setreasonablechargestate
   examples_summary_wibergbondorders
   examples_summary_applychargesoedu
   examples_summary_enumerateionizationstatesatneutralph



.. _section_examples_summary_assigncharges:

Assigning Charges
=========================================================

The following code example shows how to assign partial charges.
The program reads all of the molecules in the input file, assigns partial
charges to each based on the selected method (the default is ``-method mmff94``),
and writes each charged molecule to the output file.

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> assigncharges --help

.. oe:language:: python

   .. code-block:: console

      prompt> python assigncharges.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java AssignCharges --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> AssignCharges --help

will generate the following output:

.. code-block:: console

   Simple parameter list

    Charging options
      -method : which set of charges to apply

    input/output options
      -in : Input molecule
      -out : Output molecule (usually an oeb)

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`assigncharges.py <../../../../wrappers/python/examples/quacpac/assigncharges.py>`

      .. literalinclude:: ../../../wrappers/python/examples/quacpac/assigncharges.py

   .. only:: oepdf

      .. oe:source:: assigncharges.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`assigncharges.cpp <../../../../sublibs/tklibs/quacpac/examples/assigncharges.cpp>`
         and
         :download:`assigncharges.txt <../../../../sublibs/tklibs/quacpac/examples/assigncharges.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: assigncharges.cpp
         :language: c++

      with interface file

      .. oe:source:: assigncharges.txt
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`AssignCharges.java <../../../../wrappers/java/examples/openeye/examples/oequacpac/AssignCharges.java>`
         and
         :download:`AssignCharges.txt <../../../../wrappers/java/examples/openeye/examples/oequacpac/AssignCharges.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: AssignCharges.java
         :language: java

      with interface file

      .. oe:source:: AssignCharges.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`AssignCharges.cs <../../../../wrappers/csharp/Csharp-Examples/OEQuacPac/AssignCharges.cs>`

   .. only:: oepdf

      .. oe:source:: AssignCharges.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEProton::OEAssignCharges` function



.. _section_examples_summary_neutralionization:

Setting a Neutral Ionization State
=========================================================

This following example shows how to set a single dominant ionization state
of a molecule at pH 7.4.

Command Line Interface
----------------------

A description of the command line interface is shown as follows:

.. oe:language:: c++

   .. code-block:: console

      prompt> neutralionization <mol-infile> <mol-outfile>

.. oe:language:: python

   .. code-block:: console

      prompt> python neutralionization.py <mol-infile> <mol-outfile>

.. oe:language:: java

   .. code-block:: console

      prompt> java NeutralIonization <mol-infile> <mol-outfile>

.. oe:language:: csharp

   .. code-block:: console

      prompt> NeutralIonization <mol-infile> <mol-outfile>

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`neutralionization.py <../../../../wrappers/python/examples/quacpac/neutralionization.py>`

      .. literalinclude:: ../../../wrappers/python/examples/quacpac/neutralionization.py

   .. only:: oepdf

      .. oe:source:: neutralionization.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`neutralionization.cpp <../../../../sublibs/tklibs/quacpac/examples/neutralionization.cpp>`

   .. only:: oepdf

      .. oe:source:: neutralionization.cpp
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`NeutralIonization.java <../../../../wrappers/java/examples/openeye/examples/oequacpac/NeutralIonization.java>`

   .. only:: oepdf

      .. oe:source:: NeutralIonization.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`NeutralIonization.cs <../../../../wrappers/csharp/Csharp-Examples/OEQuacPac/NeutralIonization.cs>`

   .. only:: oepdf

      .. oe:source:: NeutralIonization.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEProton::OESetNeutralpHModel` function


.. _section_examples_summary_enumeratetautomers:

Enumerating Tautomers
=========================================================

This following example shows a fast informatics technique using tautomer
enumeration which is capped at 200 states per molecule. Formal
charge of each input molecule is removed first, and then tautomers are
enumerated. The tautomers are saved to the output file after setting a favorable
ionization state at neutral pH.

Command Line Interface
----------------------

A description of the command line interface is shown as follows:

.. oe:language:: c++

   .. code-block:: console

      prompt> enumeratetautomers <mol-infile> <mol-outfile>

.. oe:language:: python

   .. code-block:: console

      prompt> python getreasonabletautomers.py <mol-infile> <mol-outfile>

.. oe:language:: java

   .. code-block:: console

      prompt> java EnumerateTautomers <mol-infile> <mol-outfile>

.. oe:language:: csharp

   .. code-block:: console

      prompt> EnumerateTautomers <mol-infile> <mol-outfile>

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`getreasonabletautomers.py <../../../../wrappers/python/examples/quacpac/getreasonabletautomers.py>`

      .. literalinclude:: ../../../wrappers/python/examples/quacpac/getreasonabletautomers.py

   .. only:: oepdf

      .. oe:source:: getreasonabletautomers.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`getreasonabletautomers.cpp <../../../../sublibs/tklibs/quacpac/examples/getreasonabletautomers.cpp>`

   .. only:: oepdf

      .. oe:source:: getreasonabletautomers.cpp
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`GetReasonableTautomers.java <../../../../wrappers/java/examples/openeye/examples/oequacpac/GetReasonableTautomers.java>`

   .. only:: oepdf

      .. oe:source:: GetReasonableTautomers.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`GetReasonableTautomers.cs <../../../../wrappers/csharp/Csharp-Examples/OEQuacPac/GetReasonableTautomers.cs>`

   .. only:: oepdf

      .. oe:source:: GetReasonableTautomers.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEProton::OEGetReasonableTautomers` function


.. _section_examples_summary_setreasonablechargestate:

Setting  a Reasonable Charge State
=========================================================

The following example shows how to use :oe:func:`OEProton::OEGetReasonableProtomer`
to set a favorable ionization state assuming pH=7.4.

Command Line Interface
----------------------

A description of the command line interface is shown as follows:

.. oe:language:: c++

   .. code-block:: console

      prompt> setreasonablechargestate <mol-infile> <mol-outfile>

.. oe:language:: python

   .. code-block:: console

      prompt> python setreasonablechargestate.py <mol-infile> <mol-outfile>

.. oe:language:: java

   .. code-block:: console

      prompt> java SetReasonableChargeState <mol-infile> <mol-outfile>

.. oe:language:: csharp

   .. code-block:: console

      prompt> SetReasonableChargeState <mol-infile> <mol-outfile>

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`setreasonablechargestate.py <../../../../wrappers/python/examples/quacpac/setreasonablechargestate.py>`

      .. literalinclude:: ../../../wrappers/python/examples/quacpac/setreasonablechargestate.py

   .. only:: oepdf

      .. oe:source:: setreasonablechargestate.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`setreasonablechargestate.cpp <../../../../sublibs/tklibs/quacpac/examples/setreasonablechargestate.cpp>`

   .. only:: oepdf

      .. oe:source:: setreasonablechargestate.cpp
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SetReasonableChargeState.java <../../../../wrappers/java/examples/openeye/examples/oequacpac/SetReasonableChargeState.java>`

   .. only:: oepdf

      .. oe:source:: SetReasonableChargeState.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SetReasonableChargeState.cs <../../../../wrappers/csharp/Csharp-Examples/OEQuacPac/SetReasonableChargeState.cs>`

   .. only:: oepdf

      .. oe:source:: SetReasonableChargeState.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEProton::OEGetReasonableProtomer` function


.. _section_examples_summary_wibergbondorders:

Obtaining Wiberg bond orders
=========================================================

The following example shows how to obtain the Wiberg bond orders
from an AM1 calculation.

Command Line Interface
----------------------

A description of the command line interface is shown as follows:

.. oe:language:: c++

   .. code-block:: console

      prompt> wibergbondorders <mol-infile>

.. oe:language:: python

   .. code-block:: console

      prompt> python wibergbondorders.py <mol-infile>

.. oe:language:: java

   .. code-block:: console

      prompt> java WibergBondOrders <mol-infile>

.. oe:language:: csharp

   .. code-block:: console

      prompt> WibergBondOrders <mol-infile>

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`wibergbondorders.py <../../../../wrappers/python/examples/quacpac/wibergbondorders.py>`

      .. literalinclude:: ../../../wrappers/python/examples/quacpac/wibergbondorders.py

   .. only:: oepdf

      .. oe:source:: wibergbondorders.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`wibergbondorders.cpp <../../../../sublibs/tklibs/quacpac/examples/wibergbondorders.cpp>`

   .. only:: oepdf

      .. oe:source:: wibergbondorders.cpp
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`WibergBondOrders.java <../../../../wrappers/java/examples/openeye/examples/oequacpac/WibergBondOrders.java>`

   .. only:: oepdf

      .. oe:source:: WibergBondOrders.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`WibergBondOrders.cs <../../../../wrappers/csharp/Csharp-Examples/OEQuacPac/WibergBondOrders.cs>`

   .. only:: oepdf

      .. oe:source:: WibergBondOrders.cs
         :language: csharp

.. seealso::

   *  :oe:meth:`OEMolAM1::OEAM1Results::GetBondOrder` method


.. _section_examples_summary_applychargesoedu:

Applying Charges to OEDesignUnit
=========================================================

The following code example shows how to apply charges to an OEDesignUnit.
The program reads an OEDesignUnit as the input file, applies charges
to it, and writes new OEDesignUnit to the specified output file.

Command Line Interface
----------------------

A description of the command line interface is as follows.

.. oe:language:: c++

   .. code-block:: console

      prompt> applycharges_oedu [<oedu infile>] [<oedu outfile>]

.. oe:language:: python

   .. code-block:: console

      prompt> python applycharges_oedu.py [<oedu infile>] [<oedu outfile>]

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`applycharges_oedu.py <../../../../wrappers/python/examples/quacpac/applycharges_oedu.py>`

      .. literalinclude:: ../../../wrappers/python/examples/quacpac/applycharges_oedu.py

   .. only:: oepdf

      .. oe:source:: applycharges_oedu.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`applycharges_oedu.cpp <../../../../sublibs/tklibs/quacpac/examples/applycharges_oedu.cpp>`

   .. only:: oepdf

      .. oe:source:: applycharges_oedu.cpp
         :language: c++

.. seealso::

   * :ref:`OEDesignUnitCharges <OEProton_OEDesignUnitCharges>` class
   * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class



.. _section_examples_summary_enumerateionizationstatesatneutralph:

Enumerate ionization states at neutral pH using OEMultistatepKaModel and OEMultistatepKaModelOptions
======================================================================================================

The following code example shows how to use OEMultistatepKaModel and 
OEMultistatepKaModelOptions classes to enumerate ionization states at neutral pH.
The program reads an input molecules file, create an instance of OEMultistatepKaModelOptions 
class. Use it in OEMultistatepKaModel class object and writes generated 
ionization states at neutral pH to specified output file.

Command Line Interface
----------------------

A description of the command line interface is as following.

.. oe:language:: c++

   .. code-block:: console

      prompt> enumerateionizationstatesatneutralph [<oedu infile>] [<oedu outfile>]

.. oe:language:: python

   .. code-block:: console

      prompt> python enumerateionizationstatesatneutralph.py [<oedu infile>] [<oedu outfile>]

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`enumerateionizationstatesatneutralph.py <../../../../wrappers/python/examples/quacpac/enumerateionizationstatesatneutralph.py>`

      .. literalinclude:: ../../../wrappers/python/examples/quacpac/enumerateionizationstatesatneutralph.py

   .. only:: oepdf

      .. oe:source:: enumerateionizationstatesatneutralph.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`enumerateionizationstatesatneutralph.cpp <../../../../sublibs/tklibs/quacpac/examples/enumerateionizationstatesatneutralph.cpp>`

   .. only:: oepdf

      .. oe:source:: enumerateionizationstatesatneutralph.cpp
         :language: c++

.. seealso::

   * :ref:`OEMultistatepKaModelOptions <OEProton_OEMultistatepKaModelOptions>` class
   * :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>` class


.. _chapter_molchargetheory:

********************************************************************************
`molcharge` - Partial Charges
********************************************************************************

Introduction
================================================================================

The assignment of appropriate atomic partial charges, both to small molecule
ligands and to biopolymers (such as proteins and nucleic acids) is essential
to getting meaningful results from any electrostatics calculation.

A molecule may be considered a collection of atomic nuclei and the electrons
that surround them. The number of protons in each nucleus defines its atomic
number/element. If the number of electrons exactly matches the number of
protons in these nuclei, the molecule is neutral and has no net charge. If
there are more electrons than protons, the molecule has a net negative
charge, and if there are less, the molecule has a net positive charge.

It is both the atomic nuclei and the net charge that define the identity of
a molecule. Indeed, this is a representation common to quantum chemistry.
Adding or removing electrons (or atoms) from a molecule produces a different
molecule.

In the discrete world of cheminformatics, valence bond theory allows the
electrons present in a system to be represented in terms of bonds with
formal bond orders, and formal charges assigned to particular atoms. The sum
of the formal charges is equal to the net charge on the molecule, but which
atoms are assigned which formal charges can be to some extent arbitrary due
to resonance delocalization. In such cases
the same molecule may be represented by similar connection tables, but with
formal charges assigned to different sets of atoms.

For example, guanidinium may be expressed as either N[C+](N)N with the
formal charge assigned to the carbon, or as [NH2+]=C(N)N with the formal
charge  assigned  arbitrarily to one of the otherwise equivalent
nitrogens.  A similar example is a thiocarboxylate group, where either
C(=O)[S-] or C(=S)[O-] are both equally appropriate representations of the
same chemical functionality.

A zwitterion is an electrically neutral molecule that is represented as
containing atoms with positive formal charge as well as atoms with negative
formal charge.

Perhaps  the most important fact to appreciate when considering formal
charges on atoms is that they are all artificial constructs by chemists
to accommodate a particular chemical model. A figment of a chemist's fevered
imagination. Like valence bond theory, they are an exceptionally useful and powerful
discretized model of the universe. But as with any model of reality, it has
its limitations. Formal charges, for all their numerous benefits to mankind,
unfortunately, are not localized on an atom.

The limitations of describing formal charges with valence bond theory is
apparent even within cheminformatics. Sydnones, for example, are a class of
heterocyclic compound that cannot be written using normal covalent bonds
without introducing and arbitrarily assigning both positive and negative
charges.  Similarly,  in inorganic chemistry, the ditechnetium cation,
:math:`\mbox{Te}_{2}^{+5}`, causes similar problems where the +5 formal charge
cannot be assigned to both technetium atoms without breaking symmetry.

A  better model, or approximation, of the wave function describing the
distribution of electron density around a molecule is the use of atomic
partial charges. A partial charge is a floating-point value assigned to each
atomic  center  intended to model the distribution of electrons over a
molecule.

Atomic partial charges are yet another approximation, much like the formal
charges described above. However, partial charges provide a much better
model to describe the electric field, dipole moment and other observable
properties of a molecule.

A common limitation of the use of partial charges is the assumption that
they are conformationally invariant. Unfortunately, the distribution of
electrons around a molecule depends upon the spatial configuration of its
nuclei. Some partial charge assignment algorithms, such as the method of
Goddard and Rappé, consider these conformational effects, whilst others that
are based on quantum mechanics, such as the RESP and AM1BCC methods of Bayly
et  al.,  go to great lengths to eliminate conformational effects, for
example, by restraining and symmetrizing symmetric atom positions. This is
necessary in order to be able to properly handle multiple conformations and changes
in geometry (e.g. geometry optimization) with a single set of atomic charges.

Theory
================================================================================

Marsili-Gasteiger Partial Charges
--------------------------------------------------------------------------------

Marsili-Gasteiger partial charges are assigned using a two stage algorithm.
In the first stage, seed charges are assigned to each atom in the molecule.
For example, carboxylate oxygens are each assigned the value -0.5. During
the second stage, these initial charges are then shared across bonds, moving
a certain amount of charge from one atom to another. The partial charge
moved and its direction is determined by difference in electronegativities
of the atoms on each end of the bond. The relaxation algorithm is then
iterated several times (by default eight passes), attenuating the charge
moved with each iteration. OpenEye does not recommend use of this charge
model for intermolecular interactions; it was never intended for this purpose.
The author of the method (Johann Gasteiger) developed it to compare
relative reactivity of related organic chemical functional groups within
different molecular contexts. Here it is included for comparison purposes.

MMFF94 Partial Charges
--------------------------------------------------------------------------------

The partial charges used by the MMFF94 and MMFF94s force fields are assigned
using a four stage algorithm. In the first stage, each atom of the molecule
is  assigned an MMFF94 atom type. In the second stage, an initial seed
partial charge is assigned to each atom based upon its atom type. For a few
atom  types,  the  initial  partial charge also depends upon the local
environment. In the third stage, the initial charges assigned to aromatic
rings are shared between all atoms of the aromatic ring. Finally, in the
fourth  stage, a table of bond charge increments (BCI) is used to move
charges across bonds based upon the bond type of the bond (single, double,
triple) and the atom types of the atoms at each end. Developed for the
electrostatic interactions within the above-mentioned force fields, they
are the appropriate charges to use with these force fields most notably for
intramolecular interactions of pharmaceutical and bio-organic small molecules.
They are less well-suited (but still passable) for intermolecular interactions
using the common two-body additive Coulomb interactions as used in Amber,
Charmm, Gromacs. For these better choices would be amber99sb charges on
proteins and peptides, and am1bccsym charges on the ligand.

AM1 Charges
--------------------------------------------------------------------------------

AM1 charges are a set of Mulliken-type charges derived from a semi-empirical
quantum-mechanical calculation. For further discussion of this method,
please see [Dewar-1985]_.  These should not be used for intermolecular
interactions of force fields.

AM1BCC Charges
--------------------------------------------------------------------------------

AM1BCC  charges  start  with  Mulliken-type partial  charges  derived  from  the AM1
semi-empirical quantum mechanical (QM) wave-function.
In a second stage, bond-charge corrections (BCCs) are applied
to the partial charges on each atom to generate new partial charges. Many
different variants of AM1BCC charges are offered within our API because of
the significant influences of several different factors on these
QM-derived charges. Specifically, these factors are

* Optimization: whether or not the input geometry is optimized. QM
  wavefunctions in general are quite sensitive to geometry, especially bond
  lengths and bond angles, so this can markedly affect the partial charges.
  In general, optimizing the geometry is recommended. To avoid a collapse
  of the conformation due to strong intramolecular electrostatic interactions,
  light restraints to the starting geometry are applied.

* Symmetrization: whether or not topologically similar atoms (for example
  the two oxygens on a carboxylate) are constrained to have identical
  values. The true QM wavefunction is usually asymmetric around topologically
  similar atoms, leading to asymmetric partial charges. However, if the same
  partial charges are to be used on different conformers (as with general
  fixed-charge force fields) it is important that these charges be symmetrized
  or else interconverting between formally degenerate conformers (e.g. 180
  degree rotation of the carboxylate) will have non-degenerate electrostatic
  energies.  In general, if the partial charges are to be applied to more
  than the single conformer used to generate them, symmetrization is strongly
  recommended.

Another important issue with AM1BCC charges is if highly conformer-specific
charges are generated which are unsuitable for other conformers, leading to
undesirable perturbed electrostatic energies for those other conformers. To
address this problem, we strongly recommend the ELF conformer selection protocol
described below.

"Standard" AM1BCC includes both optimization and symmetrization.

OpenEye  considers  AM1BCC charges to be the best partial charge model
currently available.  For further discussion, please see the work of
Christopher I. Bayly.

ELF Conformer Selection
--------------------------------------------------------------------------------

ELF conformer selection is a method to select one or more conformers having
Electrostatically Least-interacting Functional groups (ELF) from a
large conformer database. The purpose of this method is to resolve
important issues with QM-derived charges in general, including AM1BCC charges.
The issue is that strong short-range intramolecular polarizations
specific to a certain conformation, as with an intramolecular hydrogen bond
or salt bridge, usually leads to strongly perturbed partial charges for the atoms
involved. These charges can be very different from those found for other
conformers which do not have that intramolecular polar interaction. If such
partial charges are applied to all conformers, some of those other conformers
are very likely to have wrongly over-stabilized solvation energies.

A second problem arising from this issue is the precision or sensitivity of
the electrostatic energies resulting from QM-derived charges. By this we mean the variance
in electrostatic relative energies between different conformers depending on what
conformer is used for the QM-derived charges. Imagine two different sets of
QM-derived partial charges for a molecule, each coming from
a conformer having different strong intramolecular hydrogen bonds. Each set of
partial charges will have strongly perturbed partial charges for the internally
hydrogen bonded atoms, but they will be different. The relative energies
between conformers will be different depending which partial charge set is used.

For these reasons it is important to avoid generating QM-derived partial charges from
a conformer having electrostatically strongly interacting functional groups.
This is what ELF conformer selection does.

ELF needs to start with enough conformers so that it can find
a population of conformers that do not have strongly-interacting functional groups.
In the first stage, the Coulomb electrostatic energy is calculated
for every conformer using the absolute value of the MMFF94
partial charges (original negative charges are replaced with
their absolute values). The electrostatic energies with such charges
destabilize all strong polar interactions, and thus the lowest electrostatic
energies correspond to the Electrostatically Least-interacting Functional
groups. The lowest-energy 2% of conformers is selected as the 2% ELF population.
We find that averaging 10 diverse
conformers from the 2% ELF population is sufficient to provide
a well-behaved set of QM-derived partial charges even for highly polar
and charged molecules.

Amber ff94, ff96, ff99, ff99sb, and ff99sbc0 Partial Charges
--------------------------------------------------------------------------------

The partial charges used by the AmberFF94 force field are based on fitting
quantum mechanical electrostatic potentials (esp). They were developed to address
two key issues with earlier esp-fit charge sets: unrealistically high charges on charge
centers and the variation of atomic charges with conformation. While the latter
should have some basis in electronic structure, numerical instability in the
charge fitting process was the source of both these pathologies. AmberFF94 charge
sets use restrained esp-fitting (RESP) to control the numerical instabilities
and simultaneous multi-conformer fitting to lead to conformation-independent charges
that are restricted to individual residues. Particular attention was given to
ensure that backbone amides have consistent charges. The Amber force fields
ff94, ff96, ff99, ff99sb, and ff99sbc0 all use the same set of RESP charges, they
differ in other terms (mostly torsional).



.. _quacpac_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version2_3_0
   version2_2_7
   version2_2_6
   version2_2_5
   version2_2_4
   version2_2_3
   version2_2_2
   version2_2_1
   version2_2_0
   version2_1_4
   version2_1_3
   version2_1_2
   version2_1_1
   version2_1_0
   version2_0_2
   version2_0_1
   version2_0_0
   version1_9_3
   version1_9_2
   version1_9_1
   version1_9_0
   version1_8_6
   version1_8_5
   version1_8_4
   version1_8_3
   version1_8_2
   version1_8_1
   version1_8_0
   version1_7_2
   version1_7_1
   version1_7_0
   version1_6_4
   version1_6_2
   version1_6_1
   version1_6_0
   version1_5_2
   version1_5_1
   version1_5_0
   version1_4_1
   version1_4_0
   version1_3_1
   version1_3_0
   version1_1_0



Quacpac TK 2.3.0
================================================================================

Minor internal improvements have been made.



Quacpac TK 1.1.0
================================================================================

*  Special Note: Version 1.4 of Molcharge and version 1.2b of the library have
   been released and inserted into version 1.1 of Quacpac.  Both of these have
   removed support for the VC2003 partial charging method.

*  Version 1.1 is the first full stable release of Quacpac.  Quacpac remains a
   heterogeneous release including five primary applications and a programming
   library with a C++ api.

*  Tautomers is in version 2.0.  It provides enumeration of energetically
   reasonable tautomers of input molecules.

*  pKaTyper is in version 1.1.  pKaTyper provides enumeration of protonation
   states (pKa ~2-~14).

*  Molcharge is in version 1.3.  Molcharge provides MMFF, AM1, AM1BCC, VC2003
   and other partial charges on small molecules.

*  Protein_pka is in version 1.3.  Protein pKa carries out PB calculations
   to assess the shifts in protein residue pKa's.

*  This release includes the oeproton library.  The oeproton library exposes
   the features of pKaTyper, tautomers and molcharge in three high level C++
   api points. The version of the library in this release is 1.1b.  However,
   the beta moniker signifies only that at this time, OpenEye reserves the
   right to modify this api.  We believe the quality of the code in this
   library is very solid and the beta designation does not reflect its
   quality.



Quacpac TK 1.3.0
================================================================================

This release represents the first major reworking of the **Quacpac TK** and
applications in several years.  Any users of prior versions of Quacpac will
quickly notice several significant changes.  First, this version of Quacpac
does not contain a new release of protein pKa program.  We are in the midst of
a major rewrite of the protein pKa program.  We hope that this work will bring
major improvements in the usability, science and analysis of the protein pKa
program, yet we do not want to delay the release of the entire Quacpac package
waiting for the protein pKa program.  The current Quacpac release does not
contain protein pKa, but it will be included in a future release when the
rewrite is complete.  In the interim, we hope you find the bug fixes and new
features included in this release useful.

The preps and qpd programs will no longer be supported future versions of
Quacpac.

New features
--------------------------------------------------------------------------------
*  A reasonable looking tautomer may be calculated by setting the
   ``mostAro`` boolean to ``true`` in :ref:`OETautomerMolFunction <OEProton_OETautomerMolFunction>`.
   After the ``max`` number of tautomers have been attempted, the
   most aromatic looking molecule may be retrieved using the
   :oe:meth:`OEProton::OETautomerMolFunction::GetMolecule` method.
   
*  An ``OEMCMolBase`` version of :oe:func:`OEProton::OEAssignPartialCharges`
   has been added for calculating multiconformer AM1BCC charges

Bug fixes
--------------------------------------------------------------------------------

*  Library has changed names from liboeproton to liboequacpac

*  Memory leak related to :ref:`OETyperMolFunction <OEProton_OETyperMolFunction>` and
   :ref:`OETautomerMolFunction <OEProton_OETautomerMolFunction>` is fixed.

*  SMILES map indexes and names are no longer lost when outputting molecules.



Quacpac TK 1.3.1
================================================================================

New features
--------------------------------------------------------------------------------
*  The distribution and installation of Quacpac has been modified.
   The Windows distribution is now a standard EXE installer, and the
   OS X distribution is a dmg containing a standard pkg installer.
   The executables are now scripts that chose the correct version of
   the program at runtime.  Please see the Application Installation
   section for details.

Bug fixes
--------------------------------------------------------------------------------
*  The previous version had a license failure when AM1 charges were calculated.  This bug has been fixed.



Quacpac TK 1.4.0
================================================================================

New features
--------------------------------------------------------------------------------

*  :oe:func:`OEProton::OESetNeutralpHModel` has been added.  This
   function may be used to set a molecule to an energetically
   favorable ionization state for pH=7.4. This is the same pH model
   that was available in the Filter application.  Additionally, the
   perception of acceptable valence states has been improved to
   include phosphorus as well as aromatic oxygen and sulfur with +1
   formal charge.

*  :oe:func:`OEProton::OEEnumerateFormalCharges` now implicitly uses
   the ``mostAro=true`` parameter on the
   :ref:`OETautomerMolFunction <OEProton_OETautomerMolFunction>` it uses when choosing a
   tautomer. This provides a better reference tautomer when
   enumerating pKa states.

*  Aromaticity settings on molecules are now unchanged when
   :oe:func:`OEProton::OEAssignPartialCharges` is called.  Aromaticity
   may be temporarily changed inside the function while charges are
   being calculated, but the molecule will have the same aromaticity
   after the function as before.  



Quacpac TK 1.4.1
================================================================================

Bug Fixes
--------------------------------------------------------------------------------

*  :oe:func:`OEProton::OESetNeutralpHModel` has been added to the Java and Python
   wrappers.

*  Bug has been fixed in :oe:func:`OEProton::OEAssignPartialCharges` where it
   sometimes did not return false after a failure to assign charges.  Now this
   function should always return false if charges are not set.

*  Fixed tetronic acid rule in :oe:func:`OEProton::OESetNeutralpHModel` to allow
   matching of aromatic bonds.



Quacpac TK 1.5.0
================================================================================

New Features
--------------------------------------------------------------------------------

*  Major improvement for carbon hybridization.  Now carbon atoms with bonds to one, two, or three heavy atoms are able to change hybridization state.  
   However, only carbons close to an appropriate heteroatom are allowed to change hybridization state.  Additionally, unreasonable charge states of carbon have been removed.
   Now the enabling the `ch3flag` option will only generate tautomers appropriate for the given level.

*  Improvement of the `mostAro` option, particularly involving exocyclic heteroatoms.

*  Added stereo preservation flag to :oe:func:`OEProton::OEEnumerateTautomers` with a default of `false`.  Stereo chemistry can be lost during creation and removal of double bonds, but if the user
   desires a certain stereo setting to be preserved this flag will prevent the associated atoms and bonds from taking part in tautomerization.

*  Improvements to pka states.

*  AmberFF94 charges can now be applied to standard protein residues.

.. oe:language:: python

   * The *Quacpac TK* versioning APIs
     (:oe:func:`OEProton::OEQuacPacGetRelease`,
     :oe:func:`OEProton::OEQuacPacIsLicensed`, etc) are now properly
     wrapped in Python.


Quacpac TK 1.5.1
================================================================================

Bug Fixes
--------------------------------------------------------------------------------

*  A bug has been fixed where tautomers were not guaranteed to be in a canonical form during output.  In rare circumstances this could lead to tautomers with the same
   unique tautomer to print it in different non-canonical forms.  



Quacpac TK 1.5.2
================================================================================

New features
--------------------------------------------------------------------------------

* Refined Neutral pH model (:oe:func:`OEProton::OESetNeutralpHModel`) to reflect 
  feedback from collaborators.  In particular isoxazoles and oxadiazoles were 
  added while pyrazoles and aryl sulfonamides were refined.  Aryl sulfonamide 
  refinement also incorporated changes based on newly obtained experimental data.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEProton::OESetNeutralpHModel` now correctly addresses beta di-amino groups
  so that if all other considerations are equivalent, secondary amines are 
  treated as most basic, followed by primary amines, with tertiary amine being
  treated as least basic.

* :oe:meth:`OEProton::OETautomerMolFunction::GetMolecule` has been
  fixed so that 3D molecules have 3D hydrogens instead of implicit
  hydrogens.

* :oe:func:`OEProton::OEAssignPartialCharges` no longer inadvertently
  converts reduced cysteine residues (CYS) to the oxidized form (CYX)
  when :oe:constns:`OEProton::OECharges::AmberFF94` is used to assign
  Amber partial charges to protein residues.



Quacpac TK 1.6.0
================================================================================

New features
--------------------------------------------------------------------------------

* The default AM1BCC charge model :oe:constns:`OEProton::OECharges::AM1BCC`
  now lightly restrains the AM1 geometry
  optimization to the starting coordinates. This allows the important relaxation
  of bond and angle degrees of freedom while greatly reducing the potential to
  alter the molecule's conformation away from its starting coordinates. AM1
  geometry optimization can be suppressed with
  :oe:constns:`OEProton::OECharges::AM1BCCSPt`
  or :oe:constns:`OEProton::OECharges::AM1BCCNoSymSPt`.

Bug fixes
--------------------------------------------------------------------------------

* The AM1BCC charge models :oe:constns:`OEProton::OECharges::AM1BCCSym` and
  :oe:constns:`OEProton::OECharges::AM1BCCSPt`
  now symmetrize the partial charges
  over bond-topologically equivalent atoms, e.g. methyl hydrogens, in keeping
  with the original model. This is especially important with conformationally
  flexible molecules.  This behavior can be suppressed by using the default
  :oe:constns:`OEProton::OECharges::AM1BCC` or the non-default models
  :oe:constns:`OEProton::OECharges::AM1BCCNoSym` or
  :oe:constns:`OEProton::OECharges::AM1BCCNoSymSPt`.


Quacpac TK 1.6.1
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEProton::OEEnumerateTautomers` will now allow interconversion of 
  [NH2+]= and [NH3+]-.

* :ref:`OETautomerMolFunction <OEProton_OETautomerMolFunction>` now has a warts option.  Enabling this
  options will number the output molecules with an `@` symbol.

Major bug fixes
--------------------------------------------------------------------------------

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEProton::OEEnumerateTautomers` will now properly set stereochemistry 
  on planar carbon to `OEAtomStereo::Undefined`.  Previously, planar carbon could
  inherit stereochemistry from an input molecule with stereochemistry set on a 
  tetrahedral carbon.

* A few bugs have been fixed in :oe:func:`OEProton::OESetNeutralpHModel` involving
  quaternary nitrogen and protonated aromatic nitrogens.



Quacpac TK 1.6.2
================================================================================

Major bug fixes
-------------------------------------------------------------------------------

* :oe:func:`OEProton::OEEnumerateTautomers` was removing stereochemistry from all atoms that did not have 
  a valence of 4.  This has been fixed so that other types of atoms with legitimate stereochemistry, 
  such as nitrogen and hypervalent atoms, no longer lose their stereochemistry information.

* :oe:func:`OEProton::OEEnumerateFormalCharges` has been fixed to properly handle 3D input.  Previously, 3D
  input would cause an incorrect number of hydrogen atoms and an incorrect valence state on adjusted heavy atoms.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEProton::OESetNeutralpHModel` will no longer ionize
  difluoro, dichloro, and N-methyl acetamide.

* :oe:func:`OEProton::OESetNeutralpHModel` will now use the molecule title when available 
  instead of a smiles string for warning messages.

* :oe:func:`OEProton::OESetNeutralpHModel` warning messages for bad valence have been clarified.

* :oe:func:`OEProton::OEAssignPartialCharges` will no longer exit when using :oe:const:`OEProton::OECharges::AM1BCCNoSym` 
  with multiconformer molecules.



Quacpac TK 1.6.4
================================================================================

New features
--------------------------------------------------------------------------------

*  The new function :oe:func:`OEProton::OERemoveFormalCharge` has been added.  
   This function sets the formal charges on a molecule to zero while 
   maintaining a standard valence state.

*  The new function :oe:func:`OEProton::OEGetChargeTypeName` has been added.
   This function returns the corresponding :oe:constns:`OEProton::OECharges` 
   name for the `unsigned int` passed in.

Minor bug fixes
--------------------------------------------------------------------------------

* The wart symbol has been changed from `@` to `_` in order to help with parsing SMILES formatting.



Quacpac TK 1.7.0
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OETautomerMolFunction <OEProton_OETautomerMolFunction>` has been deprecated and
  :ref:`OETautomerOptions <OEProton_OETautomerOptions>` is now the preferred way to set
  options for the :oe:func:`OEProton::OEEnumerateTautomers`
  function. :oe:func:`OEProton::OEEnumerateTautomers` will now return
  an iterator of molecules optionally ordered by favorableness of the
  tautomer. Therefore, the first tautomer in the iterator is the same
  as what was previously returned by
  :oe:meth:`OEProton::OETautomerMolFunction::GetMolecule`.
 
* A hard limit on the total number of atoms participating in tautomerization is now adjustable
  in :ref:`OETautomerOptions <OEProton_OETautomerOptions>`.  Additionally, an adjustable parameter
  ``maxZoneSize`` has been added for setting the maximum number of atoms that are allowed 
  in a continuous tautomerization zone.  Any molecule that exceeds either of these limits will 
  cause :oe:func:`OEProton::OEEnumerateTautomers` to return the input tautomer.

* :oe:func:`OEProton::OETautomersLargestZoneSize` function added to
  return the largest number of atoms in a continuous tautomerization
  zone for a particular molecule.



Quacpac TK 1.7.1
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OETyperMolFunction <OEProton_OETyperMolFunction>` and
  :ref:`OEFormalChargeOptions <OEProton_OEFormalChargeOptions>` is now the preferred way to set
  options for the :oe:func:`OEProton::OEEnumerateFormalCharges`
  function. The new form of :oe:func:`OEProton::OEEnumerateFormalCharges`
  returns an iterator of molecules.
 
Minor bug fixes
--------------------------------------------------------------------------------

* Removed unbounded stack allocations. 

Documentation fixes
--------------------------------------------------------------------------------

* **Quacpac TK** examples have been renamed to more accurately reflect
  their function.

* Documented the Amber force field constants :oe:const:`OEProton::OECharges::AmberFF94`,
  :oe:const:`OEProton::OECharges::AmberFF99`,
  :oe:const:`OEProton::OECharges::AmberFF99SB`, and :oe:const:`OEProton::OECharges::AmberFF99bsc0`.

* Documented the AM1BCC constant :oe:const:`OEProton::OECharges::AM1BCCSymSPt` and fixed
  a mistake in the description of the constant :oe:const:`OEProton::OECharges::AM1BCCSPt`.


Quacpac TK 1.7.2
================================================================================

New features
--------------------------------------------------------------------------------

Minor bug fixes
--------------------------------------------------------------------------------

* Calling :oe:func:`OEProton::OEGetChargeTypeName`
  with the constant :oe:const:`OEProton::OECharges::Default`,
  now returns the name of the default charge method,
  :oe:const:`OEProton::OECharges::MMFF94`.
 
Documentation fixes
--------------------------------------------------------------------------------



Quacpac TK 1.8.0
================================================================================

New features
--------------------------------------------------------------------------------

* Passing ``true`` to :oe:meth:`OEProton::OETautomerOptions::SetRankTautomers`
  was dramatically improved to provide a low-energy,
  medicinally-relevant "reasonable" tautomeric form that is suitable
  for depiction for chemists. Significant improvements were made to
  the "reasonable" tautomer algorithm that effect the aliphatic and
  non-aromatic resonance portions of tautomers.

  - Made conversion of carboxylates to diols and nitros to di-hydroxy
    amines very unfavorable. 

    .. image:: quacpactk/images/canonical-tautomer-01.*

  - Made generation of unnecessary, non-dative, formal charges
    unfavorable.

    .. image:: quacpactk/images/canonical-tautomer-02.*

    .. image:: quacpactk/images/canonical-tautomer-03.*

  - Improved accounting for exocyclic bonds adjacent to aromatic
    rings.

    .. image:: quacpactk/images/canonical-tautomer-04.*

  - Set priority for aliphatic double bond position that could be
    arbitrary in prior versions.

    .. image:: quacpactk/images/canonical-tautomer-05.*

* :oe:func:`OEProton::OEGetReasonableProtomer` added to provide a
  convenient "best practices" function to generate a most chemically
  reasonable tautomerization and ionization state for a molecule. The
  function yields a low-energy medicinally relevant protomer suitable
  for depiction for chemists.

.. oe:language:: c++

   * The C++ **Quacpac TK** library, ``oequacpac``, now links against the
     ``oeamber`` library. Please update build scripts accordingly to
     account for the new dependency.

* :oe:func:`OEProton::OETautomersLargestZoneSize` now overloaded with a
  more convenient function that does not require constructing a
  :ref:`OETautomerOptions <OEProton_OETautomerOptions>` object to explore the maximum
  zone size considered for tautomerization of a molecule.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEProton::OESetNeutralpHModel` consistency has been
  improved by forcing the molecule to use the OpenEye aromaticity
  model before applying pH rules (pattern matching) to molecules from
  heterogeneous source or file formats.

* :oe:const:`OEProton::OECharges::Default` constant is now the exact
  same value as :oe:const:`OEProton::OECharges::MMFF94`. Previously,
  it was a different numerical value, making comparison un-necessarily
  difficult. Note, the default charging model is still the same. 

Known bugs
--------------------------------------------------------------------------------

* :oe:func:`OEProton::OEGetReasonableProtomer` title warting is not
  working correctly. All titles will be output "_1". This will be
  fixed for the next release, 2015.Feb.

Documentation fixes
--------------------------------------------------------------------------------

* The :ref:`tautomers <chapter_tautomerstheory>` theory chapter has been
  made more specific to the toolkit. 


Quacpac TK 1.8.1
================================================================================

New features
--------------------------------------------------------------------------------

- TIP3P water charges are now assigned when using Amber charge sets on molecules
  containing waters.
  The application of :oe:func:`OEProton::OEAssignPartialCharges`
  using :oe:const:`OEProton::OECharges::AmberFF94` or any of the other
  Amber charge sets to waters with explicit hydrogens
  will produce oxygen charges of -0.834 and hydrogen charges of +0.417.

Minor bug fixes
--------------------------------------------------------------------------------

* The default behavior of :oe:func:`OEProton::OETautomerOptions` has been changed from
  ``true`` to ``false`` when applying warts to titles.

Documentation fixes
--------------------------------------------------------------------------------

- :oe:func:`OEProton::OEEnumerateTautomers` now includes a snippet of
  code in the documentation to make using the function easier. 


Quacpac TK 1.8.2
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEProton::OESetNeutralpHModel` and
  :oe:func:`OEProton::OERemoveFormalCharge` will now produce a planar
  geometry when deprotonating an N-protonated amide. Previously, this
  was incorrectly producing a pyrimidal geometry.

* :oe:const:`OEProton::OECharges::AmberFF94` will no longer identify a 
  CYS residue as anionic when it is bonded by a sulfur to something other 
  than another CYS residue.

* :oe:func:`OEProton::OEGetReasonableProtomer` will now preserve molecule
  title, SD data, and atom coordinates.

Quacpac TK 1.8.3
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEProton::OEGetReasonableProtomer` and
  :oe:func:`OEProton::OEEnumerateTautomers` with :ref:`OETautomerOptions <OEProton_OETautomerOptions>`
  with the :oe:meth:`OEProton::OETautomerOptions::SetRankTautomers` set to ``true`` have
  improved handling of diols and nitro groups in recognition of the most reasonable
  tautomers.

* :oe:func:`OEProton::OEGetReasonableProtomer` and
  :oe:func:`OEProton::OEEnumerateTautomers` with :ref:`OETautomerOptions <OEProton_OETautomerOptions>`
  with the :oe:meth:`OEProton::OETautomerOptions::SetRankTautomers` set to ``true`` now
  employ a second-stage approach in cases where the first set of generated tautomers
  produces no desirable tautomeric states.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEProton::OEGetReasonableProtomer` will no longer have the side-effect
  of resetting the atomic coordinates to the origin.


Quacpac TK 1.8.4
================================================================================

New features
--------------------------------------------------------------------------------

* The number of :oe:constns:`methods<OEProton::OECharges>` available for use with
  :oe:func:`OEProton::OEAssignPartialCharges` is now defined as 
  :oe:const:`OEProton::OECharges::Max`.

* A timer has been added to tautomer enumeration.
  :oe:meth:`OEProton::OETautomerOptions::SetMaxSearchTime`
  and :oe:meth:`OEProton::OETautomerOptions::GetMaxSearchTime` can be used to set
  and get a time limit for searching tautomers, respectively.

Major bug fixes
--------------------------------------------------------------------------------

* Calling :oe:func:`OEProton::OEAssignPartialCharges` on a molecule with no formal
  charges with the method :oe:const:`OEProton::OECharges::Initial` no longer
  returns ``false``.

Deprecated functionality
--------------------------------------------------------------------------------

* :oe:const:`OEProton::OECharges::OPLS` charging model is no longer supported
  with :oe:func:`OEProton::OEAssignPartialCharges` function.


Quacpac TK 1.8.5
================================================================================

* Minor internal improvements have been made.


Quacpac TK 1.8.6
================================================================================

* Minor internal improvements have been made.


Quacpac TK 1.9.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new charging function,
  :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`,
  has been developed to replace the more limited legacy function
  :oe:func:`OEAssignPartialCharges<OEProton::OEAssignPartialCharges>`.
  This new function uses :oe:cls:`charge engines<OEProton::OEChargeEngineBase>`,
  an open-ended options class, to define the charging method.
  Charge engines can be configured as required and new charge engines can
  be developed independently. Charge engines have been written for every
  supported charging method, as well as for the new method
  :ref:`OEAM1BCCELF10Charges <OEProton_OEAM1BCCELF10Charges>`.

Minor bug fixes
--------------------------------------------------------------------------------

* Warning messages from AM1BCC charging functions have been made more informative.

Documentation changes
--------------------------------------------------------------------------------

* The documentation has been updated to describe the new
  :oe:cls:`charge engine<OEProton::OEChargeEngineBase>` approach to charging
  and to show examples of its use.


Quacpac TK 1.9.1
================================================================================

Documentation changes
--------------------------------------------------------------------------------

* The behavior of the
  :oe:meth:`OEProton::OEChargeEngineBase::SetExpectValidMol`
  method is now documented correctly.
* Code examples in the :ref:`chapter_quacpacexamples` chapter have been revised.


Quacpac TK 1.9.2
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEProton::OEAssignPartialCharges`, deprecated since the 2017.Feb
  release, now throws a deprecated warning.

* :oe:func:`OEProton::OEEnumerateTautomers` now obeys the maximum tautomers
  option set in the :ref:`OETautomerOptions <OEProton_OETautomerOptions>` class.

Documentation changes
--------------------------------------------------------------------------------

* The functions :oe:func:`OEProton::OEEnumerateTautomers` and
  :oe:func:`OEProton::OEGetReasonableProtomer` remove molecule coordinates
  during their processing since changing the tautomer state may invalidate the
  3D structure.  This behavior change was introduced in the 2017.Feb release.


Quacpac TK 1.9.3
================================================================================

New features
--------------------------------------------------------------------------------

* A new class, :ref:`OEAM1 <OEMolAM1_OEAM1>`, has been added
  to provide AM1-like semi-empirical method functionality.

* A new class, :ref:`OEAM1Options <OEMolAM1_OEAM1Options>`, has been added
  to set up :ref:`OEAM1 <OEMolAM1_OEAM1>` calculation options.

* A new class, :ref:`OEAM1Results <OEMolAM1_OEAM1Results>`, has been added
  to obtain :ref:`OEAM1 <OEMolAM1_OEAM1>` calculation results.

* The class :ref:`OETautomerOptions <OEProton_OETautomerOptions>` now exposes settings
  to allow control of Kekule results, clearing of coordinates, and the
  degree of carbon hybridization.

Documentation changes
--------------------------------------------------------------------------------

* An example that displays obtaining Wiberg bond orders from an AM1
  calculation has been added.


.. _section_quacpac_releasenotes_200:

Quacpac TK 2.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new :oe:func:`OEProton::OEGetReasonableTautomers` function has been added that
  generates an ensemble of biologically relevant tautomers.

* A new :oe:func:`OEProton::OEGetUniqueProtomer` function has been added that
  generates a canonical representation of a molecule.

* A new :oe:func:`OEProton::OEGetReasonableProtomers` function has been added that
  generates an ensemble of reasonable protomers.

* The handling of keto-enol tautomerization by default has been
  improved. The improvement extends to include imine-enamine
  tautomerization and related analogs. The keto and imine forms are
  favored except in the case of 1,3 diketones, where the internal
  hydrogen bond can be formed.

* Controlling the interaction between tautomerization and tetrahedral
  stereochemistry has been improved. The method
  :oe:meth:`OEProton::OETautomerOptions::SetSaveStereo` can still be
  set to ``true`` in order to prevent any stereo atom from ever
  becoming an sp2 center. However, the behavior when the vale is set
  to ``false`` can now be controlled by passing a constant from the
  new :oe:const:`OEProton::OERacemicType` namespace to the method
  :oe:meth:`OEProton::OETautomerOptions::SetRacemicType`. This
  functionality allows users to control which stereochemistry will be
  cleared on each generated tautomer.

* Reasonable tautomers for many simple and complex pyridone analogs, pyrrole
  analogs, and pyridine analogs have been improved.

* A new :oe:func:`OEProton::OEHypervalentNormalization` function has been added to
  prepare molecules for tautomer enumeration
  (:oe:func:`OEProton::OEEnumerateTautomers`).

* The user control of the algorithms memory and CPU usage by separately
  exposing the number of tautomers generated and the number of tautomers returned
  by the methods :oe:meth:`OEProton::OETautomerOptions::SetMaxTautomersGenerated`
  and :oe:meth:`OEProton::OETautomerOptions::SetMaxTautomersToReturn`,
  respectively, has been improved.

* The default parameters of the :ref:`OETautomerOptions <OEProton_OETautomerOptions>` class have
  been updated to reflect the underlying improved tautomer generation
  algorithm.

Major bug fixes
--------------------------------------------------------------------------------

* Several issues that caused double bonds and hydrogens to be allowed to move too far
  through a series of sp3 centers have been fixed.

* The default behavior of peptide tautomers and peptide stereochemistry
  has been improved.

* Keto-enol tautomerization by default has been added to improve the canonical grouping
  of unique molecules by their representative tautomers.

Minor bug fixes
--------------------------------------------------------------------------------

* Aromatic bond count has been added to scoring to improve the
  handling of fused pyrrole and pyrazine chemistries when estimating low-energy
  tautomers.

Documentation changes
--------------------------------------------------------------------------------

* The :ref:`tautomers <chapter_tautomerstheory>` theory chapter has been rewritten
  to reflect common usages of the tautomer library.


Quacpac TK 2.0.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The definition of :oe:const:`OEProton::OEHybridizationLevel::Default` has
  been changed from :oe:const:`OEProton::OEHybridizationLevel::Original`
  to :oe:const:`OEProton::OEHybridizationLevel::EnolEnamine` for consistency
  with the behavior of the default :ref:`OETautomerOptions <OEProton_OETautomerOptions>`
  class constructor.

* :oe:func:`OEProton::OEAssignCharges` no longer requires a ``case`` license
  when used with :oe:const:`OEProton::OEELFCharges`.

* :oe:func:`OEProton::OEEnumerateTautomers` has been fixed to output multiple tautomers
  when :oe:meth:`OEProton::OETautomerOptions::SetRankTautomers` is ``false``.

* :oe:func:`OEProton::OEAssignCharges` no longer crashes for molecules where
  the distance between atoms is less than 0.5 Angstrom.


Quacpac TK 2.0.2
================================================================================

New features (Preliminary)
--------------------------------------------------------------------------------

* A new preliminary class, :ref:`OEDesignUnitCharges <OEProton_OEDesignUnitCharges>`, has been added
  that charges an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.

New features
--------------------------------------------------------------------------------

* A new optional argument, ``warts``, has been added to the
  :ref:`OEFormalChargeOptions <OEProton_OEFormalChargeOptions>` constructor. Two new methods,
  :oe:meth:`OEProton::OEFormalChargeOptions::GetWarts` and
  :oe:meth:`OEProton::OEFormalChargeOptions::SetWarts`, have also been added that
  control whether to add ``wart`` to the title of each charge state.




Quacpac TK 2.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* The :oe:constns:`OEBio::OEDesignUnitComponents::CounterIons`
  molecule components are now charged with the metal charge engine for design unit charges.

* A new class, :ref:`OEOptimizedAM1 <OEMolAM1_OEOptimizedAM1>`, has been added that
  obtains optimized :ref:`OEAM1 <OEMolAM1_OEAM1>` Mulliken-type partial charges.

* Two new classes, :ref:`OEELF <OEProton_OEELF>` and :ref:`OEELFOptions <OEProton_OEELFOptions>`,
  have been added
  that allow selecting conformers from a given ensemble
  using the electrostatically least-interacting functional group (ELF) technique.

* A new method, :oe:func:`OEAM1BCC::OEBCCPartialCharges`, has been added that calculates
  bond correction partial charges.

* A new method, :oe:func:`OEAM1BCC::OESymmetrizePartialCharges`, has been added that makes
  partial charges symmetric based on molecule topology.

* A new method, :oe:meth:`OEMolAM1::OEAM1Results::GetBondOrders`, has been added to
  :ref:`OEAM1Results <OEMolAM1_OEAM1Results>` that provides access to all the bond orders
  in a list.

Minor bug fixes
--------------------------------------------------------------------------------

* The following methods now return ``bool`` instead of a ``void``:

  * :oe:meth:`OEMolAM1::OEAM1Options::SetMaxScfIter`
  * :oe:meth:`OEMolAM1::OEAM1Options::SetNumericGradDelta`
  * :oe:meth:`OEMolAM1::OEAM1Options::SetSCFTolerance`
  * :oe:meth:`OEMolAM1::OEAM1Options::SetSemiMethod`

* :oe:func:`OEProton::OEAssignCharges` with :ref:`OEELFCharges <OEProton_OEELFCharges>` now
  outputs the correct set of conformers selected using the ELF technique.

* The number of diverse conformers needed to select and use for charge calculation is
  now automatically adjusted when the desired :oe:meth:`OEProton::OEELFOptions::SetElfLimit`
  is higher than the number of initial conformers selected based on
  :oe:meth:`OEProton::OEELFOptions::SetPercent` and the input number of conformers in
  the molecule.

* :oe:func:`OEProton::OEEnumerateTautomers` no longer throws a fatal error when
  when no tautomers are found.




.. _section_quacpac_releasenotes_2112:

Quacpac TK 2.1.1.2
================================================================================

*March 2021*

* :ref:`OEOptimizedAM1 <OEMolAM1_OEOptimizedAM1>` no longer requires a special ``am1bcc`` license.

* The function :ref:`OEBCCPartialCharges <OEAM1BCC_OEBCCPartialCharges>` no longer requires a special ``am1bcc`` license.

.. _section_quacpac_releasenotes_211:

Quacpac TK 2.1.1
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* A new preliminary class, :ref:`OEChargeParameter <OEProton_OEChargeParameter>`, has been added as
  part of the extended set of :ref:`OEParameter <OESystem_OEParameter>` classes. The new parameter
  class works with predefined charge engines using :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`
  object.




Quacpac TK 2.1.2
================================================================================

*July 2021*

Minor internal improvements have been made.




Quacpac TK 2.1.3
================================================================================

*Fall 2021*

New features
--------------------------------------------------------------------------------

* :ref:`OEChargeParameter <OEProton_OEChargeParameter>` now accepts case-insensitive
  string input values.




Quacpac TK 2.1.4
================================================================================

New features
--------------------------------------------------------------------------------

* [QUACPAC-599] New preliminary classes, :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>` and
  :ref:`OEMultistatepKaModelOptions <OEProton_OEMultistatepKaModelOptions>`, have been added to asses atomic pKa ranges
  for atoms of given molecule and enumerate all possible ionization states of input molecule 
  at neutral/physiological pH (7.4) based on a heuristic pKa model.

Major bug fixes
--------------------------------------------------------------------------------

Minor bug fixes
--------------------------------------------------------------------------------

Python-specific changes
--------------------------------------------------------------------------------

Java-specific changes
--------------------------------------------------------------------------------

C#-specific changes
--------------------------------------------------------------------------------

Documentation changes
--------------------------------------------------------------------------------





Quacpac TK 2.2.0
================================================================================

New features
--------------------------------------------------------------------------------

* New preliminary API classes, :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>` and
  :ref:`OEMultistatepKaModelOptions <OEProton_OEMultistatepKaModelOptions>`, have been added to assess atomic pKa ranges
  for atoms of a given molecule, and to enumerate all possible ionization states of input molecules
  at neutral/physiological pH (7.4) based on a multistate heuristic pKa model.



Quacpac TK 2.2.1
===================

Minor internal improvements have been made.





Quacpac TK 2.2.2
================================================================================

Minor internal improvements have been made.



Quacpac TK 2.2.3
================================================================================

Minor internal improvements have been made.





Quacpac TK 2.2.4
================================================================================

Minor internal improvements have been made.




Quacpac TK 2.2.5
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Some issues with primary amines processing in :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>`
  have been fixed.



Quacpac TK 2.2.6
================================================================================

Minor internal improvements have been made.





Quacpac TK 2.2.7
================================================================================

Minor Bug Fixes
--------------------------------------------------------------------------------

* An issue that retained MDL-enhanced stereogroup information on stereocenters that
  are destroyed by protonation or bond order changes has been repaired.


###############################################
Appendix: Additional Examples in Python
###############################################

These are full listings of programming examples that are excerpted or offered for download, elsewhere in this chapter.
For a guide to programming examples, see :ref:`the list elsewhere in this chapter <quacpac_part_examples>`.

.. 	_listing-assigncharges.py:

..  oe:source:: assigncharges.py
    :language: python
    :caption:  Assigning partial charges.
    :refnum:   1

.. 	_listing-applycharges_oedu.py:

..  oe:source:: applycharges_oedu.py
    :language: python
    :caption:  Applying charges to an OpenEye design unit.
    :refnum:   2

.. 	_listing-enumerateionizationstatesatneutralph.py:

..  oe:source:: enumerateionizationstatesatneutralph.py
    :language: python
    :caption:  Applying charges to an OpenEye design unit.
    :refnum:   3

.. 	_listing-getreasonabletautomers.py:

..  oe:source:: getreasonabletautomers.py
    :language: python
    :caption:  A fast informatics technique using tautomer enumeration.
    :refnum:   4

.. 	_listing-neutralionization.py:

..  oe:source:: neutralionization.py
    :language: python
    :caption:  Set a single dominant ionization state of a molecule at pH 7.4.
    :refnum:   5

.. 	_listing-setreasonablechargestate.py:

..  oe:source:: setreasonablechargestate.py
    :language: python
    :caption:  Set a favorable ionization state assuming pH 7.4.
    :refnum:   6

.. 	_listing-wibergbondorders.py:

..  oe:source:: wibergbondorders.py
    :language: python
    :caption:  Obtain the Wiberg bond orders from an AM1 calculation.
    :refnum:   7


.. shapetk toolkit documentation master file

#############################
Shape Toolkit |shape_version|
#############################

.. toctree::
   :maxdepth: 3

   theory
   examples
   api
   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _shape_part_theory:

******************************
Theory
******************************

.. toctree::

   shape_theory


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _shapetk_theory:

********
Theory
********

.. _molecular_shape_section:

================
Molecular Shape
================

What do we mean by shape? The word is often used without consideration
of precise meaning but in this document we shall be very clear as to
the definition of shape. Two entities will have the same shape if
their volumes exactly correspond. The more the volumes differ, the
more the shapes will differ. We will give a precise mathematical
exposition below, but it is worth noting even at this most basic level
shape is defined as a relative quantity, depending on references to
other shapes. In this we differ from approaches that attempt to
provide absolute, canonical, *shapes* by which to categorize
molecules.

What do we mean by *volume*? A volume is any scalar field. This means a
function that has a single number, or *scalar*, value at each point in
space.  The *special case* for the common understanding of volume is a
specific scalar field that has a value of one inside an object and zero
outside. The volume of a scalar field is:

.. math::

   V \mbox{(volume)} = \int f(x,y,z) dv

The volume function, **f**, is also referred to as the *characteristic*
function.  When the characteristic function corresponds to the common
definition of a volume field this integral corresponds to what is commonly
expected by volume.  However, we are not restricted to such simple functions
and can still calculate a **V**. In general the volume of a scalar field is a
*contraction* of the information represented by that characteristic
function.  It is more precisely referred to as the zeroth-order contraction,
or *moment*.  We will discuss other moments and their uses later, but one
immediate observation is that two objects can not have the same shape if their
volumes are not the same. The converse is obviously not true. Rather, two
objects can have the same volume and not have the same shape. Volume is
typical, therefore, of most contractions of information.

We can now write down a precise definition of shape similarity. Consider the
integral:

.. math::

   S_1 = \int |f(x,y,z) - g(x,y,z)| dV

where **f** and **g** are different characteristic functions. If this
integral is zero then **f** and **g** are actually the same function and
therefore correspond to the same shape. The larger the integral, the
more different the shapes defined by **f** and **g**. It defines a metric
quantity between the two fields **f** and **g**. The word *metric* is
used loosely to mean *shape*, but here we mean the precise mathematical
definition: *i.e.* a distance that is 1) always positive, 2) zero if
and only if two entities are identical and 3) that obeys the triangle
inequality. The triangle inequality states that if entity A is
distance x from entity B and B is distance y from entity C then the
distance between A and C is bounded by **|x-y|** and **|x+y|**. The type
of comparison shown in S\ :sub:`1` is referred to as an L\ :sub:`1`
metric. Another metric is the S\ :sub:`2` metric:

.. math::

   S_2=\sqrt{\int [f(x,y,z)-g(x,y,z)]^2 dV}

Multiplying the terms in the integral out gives:

.. math::

   S_2^2 = \int f(x,y,z)^2dV + \int g(x,y,z)^2dV - 2\int f(x,y,z)g(x,y,z)dV

This is the fundamental equation for shape comparison. We rewrite it as:

.. math::

   S_{f,g} = I_f + I_g - 2O_{f,g}

The *I* terms are the self-volume overlaps of each entity (for our purposes -
molecule), while the *O* term is the overlap between the two functions. They
constitute the three terms we need to compare the shapes of two
fields. The *I* terms are independent of orientation but not *O*. Finding the
orientation that maximizes *O*, and hence minimizes *S_{f,g}*, is equivalent to
finding the best overlay between the two objects (a quantity that has its own,
distinct metric properties). We also note here that the quantity referred to
as a Tanimoto coefficient may be derived by recombining *I*'s and *O* so:

.. math::

   Tanimoto_{f,g} = \frac{O_{f,g}}{I_f+I_g-O_{f,g}} \label{Tanimoto}

Tanimoto coefficients will be familiar to those who use them for bitvector
fingerprint comparison.  An alternative measure is the Tversky coefficient,
also mostly used for similarity between bitvector fingerprints. Similarly to
the Tanimoto coefficient above, we can define a shape Tversky measure. The
base equation for the Tversky coefficient is:

.. math::

   Tversky_{f,g} = \frac{O_{f,g}}{\alpha I_f+\beta I_g} \label{tversky}

Normally, *alpha + beta = 1*, and for our current use, *alpha* is chosen to
be 0.95. Since this introduces an asymmetry, the Tversky calculation depends
on which molecule's self-overlap has the *alpha* pre-factor.
ROCS calculates two Tversky values, one with the query
molecule with *alpha* as the pre-factor and a second with the database
molecule with *alpha* as the pre-factor.  Also, note that since shape is
a field property, instead of a simple scalar like a bitvector, shape Tversky
can be larger than 1.0 since the overlap *O_{f,g}* can be larger than
a molecule's self-overlap, *I_f*.

The OpenEye Shape Toolkit is a set of calculational objects designed to
facilitate the calculation of these field-metric quantities. ROCS is an
application built on top of the Shape toolkit.

.. _gaussians_and_shape:

===============================================
Shape Characteristics and the Use of Gaussians
===============================================

Molecules are traditionally viewed as a set of fused spheres, sometimes
referred to as the CPK model. The common view of molecular volume is then of a
characteristic function that is one (1) inside at least one sphere and zero
(0) outside. How do we calculate the volume of such a seemingly simple
function?  The volume of a single sphere is *(4pi r^3)/3* but the complication
for two fused spheres is that we have to account for the shared
volume and not count it twice. For more than two atoms, there are triple
intersections that must be added back in if we have removed the three
pairs of intersections.  The general formula for N spheres that explicitly
calculates the volume of every level of overlap and its correct contribution
is:

.. math::

   V = 1 - \int \prod_i^N (1 - f_i)dv

This is easy to write, not so easy to solve because the analytic formulae for
overlaps of increasing order are highly non-trivial (although they have been
derived to arbitrary order). It is fair to say that this has hindered the
development of shape comparison in many ways. Attempts to use analytic
formulae led to very slow programs and approximate methods, for instance using
grids of points that are turned *in* or *out* by each sphere, do not give
smooth gradients required for minimization. Brian Masek (AstraZeneca) was the
first to attempt to optimize overlaps of molecules using the analytic
approach [Masek-1993]. His program would take several minutes per minimization. In addition
it would often suffer from a common problem when using functions that vary
sharply (such as solid spheres): it would often get stuck in local
minima. Nevertheless, Brian did have encouraging success using this method to
find similarities not obvious from chemical structure.

The conceptual breakthrough in shape comparison came in 1995 in a paper by
Andrew Grant (AstraZeneca) and Barry Pickup (University of Sheffield)
(\ [Grant-1995]_\ , [Grant-1996]_\ , [Grant-1997]_\ ). They showed that if one let
go of the concept of the characteristic function being
binary, and instead use a sum of continuous functions, *i.e.*
a Gaussian, that the solid-sphere volume, could be recovered to high
accuracy (typically ~0.1%). A sphere has one defining parameter,
its radius, whereas a Gaussian has two defining parameters, its prefactor,
*p*, and its width, *w*:

.. math::

   pe^{-wx^2}

Grant and Pickup found that by fixing *p* to 2.7 and setting *w* for
each atom such that the volume integral for each atom agreed with its
solid-sphere volume, they achieved remarkable precision. In addition,
the overlap terms between any two atoms, and hence any higher-order
overlaps, are all Gaussian functions themselves because of the
Gaussian Contraction formula (shown here for one spatial variable):

.. math::

   \int e^{a(x-x_i)^2}e^{b(x-x_i)^2} = \int e^{(a+b)(x-x_i)^2}

*i.e.* two atomic-Gaussians overlap to produce another Gaussian.
Likewise, a three atomic-Gaussian overlap is that of an
overlap-Gaussian with an atomic-Gaussian, hence another Gaussian. The
simplicity of these formulae and the formula for the volume of each
individual Gaussian leads to very efficient algorithms for the
calculation of the volume of a molecule so represented (the OpenEye
method calculates several thousand volumes per second while
calculating intersections up to sixth order).

In addition to simple calculation of molecular volume, which is the
zeroth-order moment of the characteristic function, the ease of
evaluation of intersections allows for accurate calculation of
high-order moments: called the *steric multipoles*. For
instance, if the product formulae for atomic and intersection
Gaussians yields *n* Gaussians, the first order moments are:

.. math::

   M_{1,x} =  \sum_{i=1}^n \int xe^{a_i|(x-x_i)^2+(y-y_i)^2+(z-z_i)^2|}

   M_{1,y} =  \sum_{i=1}^n \int ye^{a_i|(x-x_i)^2+(y-y_i)^2+(z-z_i)^2|}

   M_{1,z} =  \sum_{i=1}^n \int ze^{a_i|(x-x_i)^2+(y-y_i)^2+(z-z_i)^2|}

These integrals are easy to solve and their sum can be set to zero by an
appropriate choice of origin: the center of *mass* for the sum of Gaussians.
Second-order moments are found from integrals of the type:

.. math::

   M_{2,PQ} = \sum_{i=1}^n \int PQe^{a_i|(x-x_i)^2+(y-y_i)^2+(z-z_i)^2|}

where P and Q are chosen from (x,y,z), *e.g.* x\ :sup:`2`, xy etc.

These moments can be thought of as a symmetric 3*3 matrix which we
refer to as the *mass matrix*.  Rotating or translating the molecule
will change the moments and the transform that sets the first-order
moments to zero and diagonalizes the mass-matrix puts the molecule
into its *inertial frame*. By convention we assign the x-axis to the
largest eigenvector of the mass matrix, y-axis to the median
eigenvector, z-axis to the smallest. Note that this orientation is
still not uniquely defined: 180 degree rotations around any axis also
diagonalize the mass-matrix.  The eight (2\ :sup:`3`) possible transforms
that can be generated by combinations of such rotations actually lead
to four unique inertial orientations.

If a molecule is aligned to its inertial frame, all higher-order
steric multipoles become invariant, ignoring certain sign-changes from
the four-fold degeneracy of the inertial frame. As such they, as well
as the second-order moments, are shape *descriptors*. They are still
contractions of the information contained in the characteristic field,
*i.e.* two molecules can have the same steric moments and yet have
different shapes. (Moments are *complete* in that if we calculate
them to infinite order they do exactly define volume but this is
seldom a practical approach!) Nevertheless, they do contain useful
information and can be used as a rapid, approximate, filter for shape
similarity.

The same advantages that allow for the calculation of molecular volume
carry over to the calculation of molecular volume overlap. The overlap
of volumes are Gaussian contractions, easily tabulated and efficiently
retrieved. Andy re-wrote Brian's program and obtained an
order-of-magnitude improvement in performance as well as another
remarkable observation: if the starting orientation of each molecule
is that given from the inertial frame then very few "false" minima are
produced. The smoothness of the Gaussian characteristic function is
enough to overcome the problems with convergence in Brian's program.
The four possible "inertial" starting points were enough to find the
best, global, overlay between two molecules. This observation and the
Gaussian approach are the basis of the OpenEye Shape Toolkit and ROCS
program for rapid shape overlay.

But note, despite the algorithmic advantages, a correlation with
common perception has been lost. Because the pre-factor of each atomic
Gaussian is not unity, the characteristic function does not correspond
to the inside/outside description with which we are most
comfortable. In the Gaussian model all points in space are to some
degree inside and to some degree outside. That is, the Gaussian model
typically shows about 0.1% error with respect to the solid sphere
model due to the fact that is includes a portion of all points in
space inside the volume.

.. _shapetk_hermite_section:

==================================
Shape from Hermite Representation
==================================

So far, discussion has focused on a multi-center expansion of molecular
shape based on a Gaussian representation of atoms.  An interesting
alternative is a single-center expansion of the shape into a complete set of
functions.  One possibility is to use a product of three Hermite functions,
one per space dimension and expand the shape into the resulting complete set
of functions. Expansion of an electron-density map into the three-dimensional basis of Hermite polynomials has been previously considered in Ref. [Derevyanko-2014]_.

Hermites are a class of functions known as "special" functions. They are
special because linear combinations of these functions can reproduce any
other reasonably behaved function. Just as the Discrete Fourier Transform
shows that any periodic function can be represented by a sum of the
trigonometric functions {:math:`sin(n\varphi), cos(n\varphi)`}, Hermite
functions can be used to represent any localized, non-periodic function
such as molecular shape.  The "special" in special functions refers to the
fact that each function in
one of these classes is orthogonal to every other function. This means that
the integral of the product of any two such functions is 1 if they are the
same function, or zero if they are not. This makes much of the mathematics of
finding the coefficients of the representational linear sum much simpler:
a coefficient is then just the integral of the product of each particular
special function with the function being represented.

There are many well-known special functions such as sine and cosine, Hermite
polynomials, Legendre polynomials, and Laguerre polynomials. So why work with
Hermite functions? The art of special functions is to choose one that fits
the purpose. For instance, for a periodic function, sine and cosine make
sense.  Hermites make sense for shape because of their form.
The **Hermite function** of order n (any non-negative integer) is defined
as follows:

.. math::

   {\text{H}}_{n}(x) = H_{n}(x) e^{-x^2/2}

The **Hermite polynomial** is defined as:

.. math::

   H_{n}(x) = (-1)^n e^{x^2}\left(\frac{d}{dx}\right)^n e^{-x^2}.

The first few Hermite polynomials are:

.. math::

   H_{0}(x)=1, \quad  H_{1}(x)=2x, \quad H_{2}(x) = 4x^2-2, \quad H_{3}(x)=8x^3-12x.

Hermite functions can be thought of as generalizations of Gaussian
function to a complete set: this is why we like them as candidates for
representing molecular shape! Since its formation, OpenEye has worked with
molecular shape as a sum Gaussian (\ [Grant-1995]_\ , [Grant-1996]_\ ,
[Grant-1997]_\ )
and Hermites represent an extension of that work. The difference is that
Hermites are all centered at the origin, while the "classical" OpenEye
representation of molecular shape is to place a Gaussian at
each non-hydrogen atom.

So, are there any advantages to using a single-centered Hermite
representation rather than a multi-centered set of Gaussians? This is a
similar question to the one we first posed at the beginning of OpenEye:
Does representing shape by Gaussians give us any advantages over the
canonical "sum of spheres" representation? We felt that it did. Shape became
a smooth function that seemed more physical than sharp spherical functions,
and they allowed a more efficient molecular overlay of shapes. We postulated
that this might make a better dielectric function for Poisson-Boltzmann,
which has been largely verified in **ZAP TK** ([Grant-2001]_). The concept
seemed very general, so we embedded it into an OpenEye toolkit, **Shape TK**,
so that we and our customers could explore different uses. This led
to applications in crystallography (**AFITT**), bioisostere replacement
(**BROOD**), docking (**FRED**), pose prediction using ligand
information (**POSIT**), and shape-based alignment (**ROCS**).

So what advantages might Hermites represent? For one, they are very compact
(i.e., they have few coefficients). Second, the more coefficients we
include (i.e., higher order functions), the more exact the match to a sum of
atom-centered Gaussians; conversely, the fewer functions, the more "coarse"
the representation becomes, while retaining the smooth properties we like
about Gaussians in the first place. Third, the Fourier Transform of a
Hermite function is the same function! If we imagine wanting to generate
Fourier representations of shape, Hermites make it easy. Fourth, the overlap
of two shapes represented by Hermite functions is just the sum of the
product of the coefficients: it's that easy! It is not difficult to imagine
ways in which we could apply Hermites to the same problems we currently
tackle with atom-centered Gaussians. 

The first application that has already intrigued us is the representation
of protein shapes.  Consider that an arbitrary molecular shape can be
expanded into the following combination of Hermite functions:

.. math::

   f(x,y,z) = \sum_{\ell,m,n}^{\infty}\,f_{\ell mn}\,{\text{H}}_\ell(\lambda_x x)\, {\text{H}}_{m}(\lambda_y y)\, {\text{H}}_n(\lambda_z z).

The (infinite) set of coefficients for :math:`f_{\ell mn}` forms the Hermite
representation. Due to reflection properties of Hermite polynomials,
we can assume without loss of generality that the coefficients
:math:`\lambda_x, \lambda_y, \lambda_z` are all positive.  In practice we
take a finite sum in the above equation by truncating it with the following
condition on :math:`\ell, m, n`:

.. math::

      \ell+m+n\le {\text{NPolyMax}},

where NPolyMax is a resolution parameter, and can be varied from
0 (very inaccurate expansion) to infinity (exact Hermite expansion). The
recommended value varies depending on the size of the molecule.

Below is an example of the Hermite representation of the protein DHFR.

.. _hermite_figure:

.. figure:: /_images/hermite-figure.png
   :width: 650pt
   :align: center
   :alt: Hard and soft shape gaussians
   
   **Exact shape versus Hermite Representation**
   
The left figure represents the VIDA view of the exact shape of the protein.
The middle figure shows the Hermite representation with NPolyMax = 5.
The right figure shows the Hermite representation with NPolyMax = 30. 
Remarkably, we can encode the main features of the protein shape using
Hermite representation with only 56 floating point numbers (middle figure).

The advantages of representing proteins by Hermites include: 

* smooth representations that capture any level of detail, from the
  atomistic (many coefficients, as in the picture on the right) to the very
  coarse (few coefficients, as in the middle picture),
* the ability to store these representations in a compact manner,
* the ability to transform these representations easily,
* very fast overlap calculations between proteins. 

Of course, the mathematics of Hermites is more complex than that of a set
of atom-centered Gaussians. We have to know how to make, rotate, translate,
and scale such representations. Therefore, we are releasing this toolkit
with no immediate application or goal - rather, in the spirit of OpenEye,
to make potentially useful tools for our customers.

.. seealso::

   * :ref:`OEHermite <OEShape_OEHermite>` class
   * :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` class
   * :ref:`chapter_hermite_shape_examples` examples

.. _color_features_section:

.. _shapetk_color_features:

==================
Color Features
==================

In addition to shape-alignments **Shape TK**, optionally, considers chemistry
alignment, known as ‘color’.  User-specified definitions of chemistry
can be included in the superposition and similarity analysis process to
facilitate the identification of those compounds that are similar both
in shape and chemistry.

Color atoms are described as Gaussians and usually displayed as
colored spheres in visualizations.  The Gaussian for a color atom is
relatively hard with a steep gradient.  :ref:`Figure: Hard vs. Soft
Gaussians<gaussians_figure>` illustrates hard vs fuzzy Gaussians.
Both Gaussians in the figure represent the same volume as the sphere.
However, the hard Gaussian, with the steep gradient, reaches a
probability of zero (0) within the radius of the sphere.  The color
features are either matched, if they fall within the sphere radius, or
not matched.  In the case of the fuzzy Gaussian there are areas
outside the volume of the sphere (the area under the curve indicated
by the two arrows) where the Gaussian probability is greater than
zero.  This would allow color features to match even when they align
well outside the sphere representing the color atom.  That situation
would lead to less precise alignments and, for that reason, the ‘hard’
Gaussian is employed.

.. _gaussians_figure:

.. figure:: /_images/gaussians.png
   :scale: 75
   :align: center
   :alt: Hard and soft shape gaussians

   **Hard vs. Soft Gaussians**

   A sphere described by two different Gaussian functions.  The ‘hard’
   Gaussian (dashed) is the one employed by **Shape TK** to approximate a
   color atom sphere.

**Shape TK** comes pre-loaded with two color force fields, Implicit Mills
Dean (default) and Explicit Mills Dean.  These are described in
associated color force field files (\*.cff).  The desired force field
file can be supplied to the
:oe:meth:`OEShape::OEColorForceField::Init` method.  Further
information on editing color force field files is given in the below
section :ref:`color_file_format`.

The color force field is used to measure chemical similarity between
the query and the database molecule and to refine shape-based
overlays.  The color force field file describes:

* Color atom types
* The functional groups to which the color atoms should be applied.
   **Shape TK** uses only the heavy atoms of molecules; hydrogens are ignored.
* Whether the interaction between color atoms is attractive or repulsive.
  Interactions between color atoms of the same type are always
  attractive.  The weight term describes the strength of the interaction
  relative to the shape gradients and the range term affects
  the range of the interaction.

The color features described in the Implicit and Explicit Mills Dean
color force field files include:

:Donor: Functional groups that can act as H-bond donors e.g. acid-OH
:Acceptor:	Functional groups that can act as H-bond acceptors e.g. carboxylate
:Anion: Functional groups with either localized or delocalized negative charge e.g. tetrazole
:Cation: Functional groups with either localized or delocalized positive charge e.g. guanidinium
:Hydrophobe: Terminal or non-terminal aromatic or aliphatic groups e.g.  phenyl
:Rings: Rings of defined size e.g. 4-7 atoms

A custom force field file can include other features that you define
e.g. positive, negative, carbonyl_linker, metal_binder.  For each
color atom type a set of SMARTS is used to define the specific
functional groups to which the color atom will be applied.  The
Implicit and Explicit Mills Dean force fields differ in these
functional group definitions.  For example, the Explicit Mills Dean
force field allows a primary amine to be an acceptor as well as a
donor whereas it is a donor only in the Implicit Mills Dean force
field.

The color force field can also be used for post-shape scoring either
alone, e.g. ColorTanimoto and Color Tversky, or in combination with
shape scores, e.g. TanimotoCombo and TverskyCombo.

.. _color_file_format:

Color File Format
-----------------

As an alternative to the built-in force fields, the user can define a new
color force field using the format described in this section.
The following is a simplified example of a color force field specification.

::
	
	DEFINE hetero [#7,#8,#15,#16]
	DEFINE notNearHetero [!#1;!$($hetero);!$(\*[$hetero])]
	#
	#
	TYPE donor
	TYPE acceptor
	TYPE rings
	TYPE positive
	TYPE negative
	TYPE structural
	#
	#
	PATTERN donor [$hetero;H]
	PATTERN acceptor [#8&!$(\*~N~[OD1]),#7&H0;!$([D4]);!$([D3]-\*=,:[$hetero])]
	PATTERN rings [R]~1~[R]~[R]~[R]1
	PATTERN rings [R]~1~[R]~[R]~[R]~[R]1
	PATTERN rings [R]~1~[R]~[R]~[R]~[R]~[R]1
	PATTERN rings [R]~1~[R]~[R]~[R]~[R]~[R]~[R]1
	PATTERN positive [+,$([N;!$(\*-\*=O)])]
	PATTERN negative [-]
	PATTERN negative [OD1+0]-[!#7D3]~[OD1+0]
	PATTERN negative [OD1+0]-[!#7D4](~[OD1+0])~[OD1+0]
	PATTERN structural [$notNearHetero]
	#
	#
	INTERACTION donor donor attractive gaussian weight=1.0 radius=1.0
	INTERACTION acceptor acceptor attractive gaussian weight=1.0 radius=1.0
	INTERACTION rings rings attractive gaussian weight=1.0 radius=1.0
	INTERACTION positive positive attractive gaussian weight=1.0 radius=1.0
	INTERACTION negative negative attractive gaussian weight=1.0 radius=1.0
	INTERACTION structural structural attractive gaussian weight=1.0 radius=1.0

There are four basic keywords in a cff file: DEFINE, TYPE, PATTERN, and
INTERACTION. The TYPE field can be any user-defined term. TYPES can be
any user-specified string such as “donor”, “acceptor”, “lipophilic anion”
etc. The PATTERN keyword is used to associate SMARTS patterns with these
types. There is no restriction on the number of patterns that can be
associated with a user defined type. The position in Cartesian space
of the PATTERN is taken as the average of the coordinates of the atoms
that match the SMARTS pattern. If the desired location of the PATTERN
is on a single atom of a larger SMARTS pattern recursive SMARTS
(written as ‘[$(SMARTS)]’ can be used to this effect. Only the first atom
in a recursive SMARTS pattern ‘matches’ the molecule, and the rest of the
SMARTS pattern defines an environment. By writing a SMARTS pattern in
recursive notation the location of the PATTERN will be taken as the
atomic position of the first matching atom in the pattern. In order to
simplify both reading and writing SMARTS, intermediate SMARTS can be
associated with words using the DEFINE keyword. Once defined, these words
can then be used as atom primitives in subsequent SMARTS patterns with the
$ prefix (see “DEFINE hetero” and “PATTERN donor” above).

Interactions between types are associated with the INTERACTION keyword.
Two user-defined types must be listed, and whether their interaction is
attractive or repulsive. The height and radius can be modified by keywords
WEIGHT and RADIUS. At present, the only alternative to a Gaussian decay is
invoked by the DISCRETE keyword. A discrete interaction contributes all of
WEIGHT if the inter-type distance is less than RADIUS, or zero. Since it
is not differentiable it makes no contribution to optimization (i.e. because
the gradient of a DISCRETE function is 0 or infinite).

.. _color_file_builtin:

Built-in Color Force Fields
---------------------------------

Two color force fields, ImplicitMillsDean and ExplicitMillsDean, are
built into the Shape toolkit. Both of these force fields define similar 6 TYPE
color force-fields. The types are hydrogen-bond donors, hydrogen-bond
acceptors, hydrophobes, anions, cations, and rings. The
ImplicitMillsDean force field is recommended.

ImplicitMillsDean includes a simple pKa model that assumes pH=7. It
defines cations, anions, donors and acceptors in such a way that they
will be assigned the appropriate value independent of the protonation
state in the reference or fit molecule. For example, if a molecule
contains a carboxylate, ImplicitMillsDean will consider it an anionic
center independent of whether it is protonated or deprotonated. This
is convenient for searching databases which have not had careful
curation of their protonation states. The ExplicitMillsDean file has a
similar overall interaction model, however, it does not include a pKa
model. It interprets the protonation and charge state of each molecule
exactly. Thus, if a sulfate is protonated and neutral, it will not
be considered an anion.

The hydrogen-bond models in both ImplicitMillsDean and
ExplicitMillsDean are extensions of the original model presented by
Mills and Dean [Mills-Dean-1996]_. They both have donors and acceptors
segregated into strong, moderate and weak categories.


.. _shape_similarity_section:

.. _shape_similarity:

======================
Similarity Measures
======================

Measuring molecular similarity or dissimilarity has two basic components:
the representation of molecular characteristics (such as shape and color)
and the similarity coefficient that is used to quantify the degree of
resemblance between two such representations. Different similarity coefficients 
quantify different types of structural resemblance. 

The table below defines the basic terms that are used in
shape-based similarity calculations.

.. _table_shape_basic_terms:

.. list-table:: **Basic components of similarity calculation**
   :widths: 40 160
   :header-rows: 1

   * - Symbol
     - Description

   * - :math:`selfA`
     - Self-overlap or self-color score for molecule A

   * - :math:`selfB`
     - Self-overlap or self-color score for molecule B

   * - :math:`overlapAB`
     - Overlap or color score between molecules A and B

.. _shape_tanimoto:

Tanimoto
----------------------------------------------------------------

**Formula:**

  :math:`Tanimoto_{A,B} = \frac{overlapAB}{selfA + selfB - overlapAB}`

The Tanimoto similarity measure is symmetric and always has a value between
0.0 and 1.0 for both shape and color.

.. _shape_tversky:

Tversky
----------------------------------------------------------------

**Formula:**

  :math:`Tversky_{A,B} = \frac{overlapAB}{\alpha * selfA + \beta * selfB}`

The Tversky similarity measure is asymmetric.
Setting the parameters :math:`\alpha = \beta = 0.5` makes it symmetric and 
somewhat identical to using the :ref:`shape_tanimoto` measure.

The factor :math:`\alpha` weights the contribution of the first
`reference` molecule. The larger :math:`\alpha` becomes, the more
weight is put on the self-overlap of the reference molecule.

Unlike Tanimoto similarity, Tversky similarity may not always have a
value between 0.0 and 1.0.  This is true for both shape and color.
Depending on the number of atoms between molecules A and B,
it is possible to have :math:`|overlapAB| > |selfA|`, and that along with
certain values of :math:`\alpha` can sometimes lead to :math:`Tversky_{A,B} > 1.0`.

.. Note::

    The default settings for ``RefTversky`` use :math:`\alpha = 0.95` and
    :math:`\beta = 0.05`, and the default settings for ``FitTversky`` use
    :math:`\alpha = 0.05` and :math:`\beta = 0.95`.


.. _shapetk_details_section:

=================================
Implementation Details and Usage
=================================

.. _shapetk_details_funcs:

Overlap Functions 
------------------

The overlap functions extend the molecule objective function 
(:ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>`) interfaces, define in **OEFF TK**,
with overlap interactions, through :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`.
Similar to the force fields, a shape or a color is also defined as a collection 
of pairwise interactions.  Implementation of overlaps as extension of the 
molecule objective functions allows for use of the standard 
optimizers (:ref:`OEOptimizer1 <OEOpt_OEOptimizer1>` and/or :ref:`OEOptimizer2 <OEOpt_OEOptimizer2>`)
for minimization of overlaps and corresponding quantities. Implementation of 
overlaps as extension of the molecule objective functions also allows for 
combining the overlap functions with other molecule objective functions, such 
as the force fields, for system optimization.  An overlap function in **Shape TK** 
can consist of just shape or color, or a combination of both.

The overlap functions are the simplest objects in **Shape TK**, and can 
is used to calculate simple, static, overlap between two objects (molecules,
grids or shape queries). Note that static means that the two input species (ref and
fit) are not moved at all.  These objects simply calculate the static overlap,
gradients and other corresponding quantities, given the input positions.

.. _shapetk_details_methods:

Overlap Methods
----------------

Three different algorithms are implemented to calculate the overlap and the 
corresponding gradients, between two gaussians, that provides a balance between 
accuracy and speed. 

The *Exact* option considers all pairs of atoms in the system, and
the Gaussian overlaps are calculated exactly. 

The *Analytic* option provides multiple options to approximate the calculations.
The first option corresponds to using a pre-calculated table for estimating the
exponentials vs. doing exact calculation of the exponentials. The second option
allows to use a proximity grid to only consider those atom pairs that are
within a certain threshold distance (by default 3.0 |A|). The average error introduced 
by either of these approximations is in the order of one part in a thousand.
The speed gain from the proximity grid increases with size of the molecules, as well
as with the number of overlap calculations performed. The later is related to the
increased setup time for the proximity grid for the reference molecule.  If both the
tabulated exponentials and the proximity grid is turned off, the *Analytic* option
simply folds back to the *Exact* option.

The final option, *Grid*, uses a grid
representation of the volume of the target molecule.  It requires
significant set-up time relative to the cost of a single overlap
calculation (~0.01s compared to ~0.0001s) but is significantly faster
than other methods for the evaluation of each overlap once set. *Grid*
suffers a few caveats and drawbacks. First is that, currently,
for shape overlap calculation, all atoms are
treated as if they have the same radius (that assigned to carbon). The second
is that the approximation is slightly worse, typically a few parts in
a thousand, at typical grid resolutions. 

Both *Analytic* and
*Grid* improve performance when the fit molecule is large (>20
atoms) because, if there are **n** atoms in the fit and **m** in the
reference, the work per atom in the fit is proportional to a constant
not **n**.

Besides the Gaussian based calculations, a fourth option, *Hermite* is 
available for shape overlap calculation, based on Hermite representation 
of shape as described above earlier.

.. _shapetk_details_radii:

Radii approximations
--------------------

Since we are considering molecular volume overlap as a measure of shape, the
radii used for each atom is important. There are essentially two
settings. A radii approximation of :oe:const:`OEShape::OEOverlapRadii::All`
means each atom will be treated with the radius as passed
in. Alternatively, one can treat all heavy atoms as similar and apply
the :oe:const:`OEShape::OEOverlapRadii::Carbon` radius approximation.  With
this, all heavy atoms will be assigned the same radius, regardless of
the value attached to each atom. As noted above, if the
*Grid* method is used for overlap calculation, only the
:oe:const:`OEShape::OEOverlapRadii::Carbon` radius approximation can be used.

.. _shapetk_details_opt:

Overlap Optimization and Overlay
---------------------------------

Two high level objects, :ref:`OEROCS <OEShape_OEROCS>` and
:ref:`OEOverlay <OEShape_OEOverlay>` are provided for optimizing a
:ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`, to maximize shape (and color) overlap
between two objects and obtain the best overlay. Both the :ref:`OEROCS <OEShape_OEROCS>`
and :ref:`OEOverlay <OEShape_OEOverlay>` optimizes the overlap
between the reference and fit object, but provides different level of usability.

.. _starts_for_optimization:

Starting positions for optimization
------------------------------------

The starting points are important for any optimization. Various options
to start an overlap optimization is provided through the :ref:`OEStarts <OEShape_OEStarts>`
interface. The reference structure is always aligned by its principal moments 
of inertia, and the initial alignments of fit structure is determined by the
specified options. 

In the *Inertial* start, in general, the fit object is aligned in 4 positions 
with the primary and secondary moments of inertia in both directions. In order 
to deal with structures with symmetrical moments of inertia, additional starting 
points are generated. For a reference or fit where the 2 major
moments of inertia are equal (to a user-defined percent, nominally
15%), 4 extra starting positions are generated. In the rare case of a
molecule with all 3 moments of inertia essentially equal, 20 random
starting translations and rotations are chosen as starting positions.
For virtual screening uses, where the reference and fit molecule are similar
in size, the inertial starts provide an excellent
choice for starting positions that balances quality results with speed.

There are times when there is a large difference in size and a more elaborate
search is needed. For these, there are a couple of built-in searches as well a 
user-defined search. To increase searching, instead of doing the inertial 
frame rotations with to 2 molecule centers-of-mass (COM) aligned, we 
can do a set of inertial rotations at many more locations. 

The *AtAtom* starts will translate the COM of the fit molecule to the specified atom 
center (usually the heavy atoms) locations
of the reference molecule.  At each of these translations, it will perform the 4
basic inertial transforms.  Note that this means that instead of 4 (or 8)
starting positions, there will be 4 x number of reference molecule heavy atoms
(or what other atom centers specified) starts, resulting in 20-30 more starting 
positions compared to the *Inertial* starts. Obviously this will slow the overall 
calculation so this is not recommended for high-volume virtual screening, but is 
very useful for low-volume fragment searching. A slightly less aggressive set of 
starting positions can be to use the color atom centers instead of the heavy atoms
of the reference molecule. For an average reference molecule with ~10 color atoms, 
this will be faster than using all heavy atom positions, but not as elaborate of 
a search.

The *Subrocs* starts automatically performs *AtAtom* starts on each heavy atom
of the larger molecule, regardless of which molecule is set as the reference.

With the *Cartesian* starts, the user can specify the points at which to translate
the fit molecule before doing the 4 basic inertial transforms.  This provides more
flexibility in terms of how to starts to do for any optimization.

The *Random* starts, will generate **N** random starting positions
where **N** is user-defined, as well as the maximum translation allowed
between random starts.  The fit molecule will be translated to these random
starting positions, and the basic inertial transforms will be applied.

The *AsIs* starts gives the option to the user to start the optimization from a
single, pre-aligned position.

And finally, the *Quat* starts takes the user specified quaternions as the 
transformations to be applied to the fit molecule before performing optimizations. 

Thus, for any given optimization, there are multiple results returned,
usually only one of which is useful. 

.. _shapetk_details_prep:

Preparing Molecules
---------------------

Tools for preparing molecules are provided separately so users can prepare their
molecules once and reuse those molecules for many calculations. However, the high level
:ref:`OEROCS <OEShape_OEROCS>` object for overlay optimization also provides a convenient option to
automatically prepare molecules, if desired.

There are essentially three components to preparing molecules.

The first is to choose either to have hydrogens explicitly or not, and add
or remove the hydrogens in the molecules. Shape is a heavy atom property and most 
OpenEye uses (as well as the default option in :ref:`OEOverlapPrep <OEShape_OEOverlapPrep>`) is to
ignore the hydrogens.

The second is to assign Bondi radii on the atoms, if desired.  This is required if
a radii approximation of :oe:const:`OEShape::OEOverlapRadii::All` is to be used for
shape overlap calculations.

The third is to choose to have color atoms or not. Even if color is used for the calculations,
it is possible to have user defined color atoms on the molecules and direct :ref:`OEOverlapPrep <OEShape_OEOverlapPrep>`
to not make modifications to them (see :oe:meth:`OEShape::OEOverlapPrep::SetAssignColor`).




.. _shape_part_examples:

******************************
Examples
******************************

.. toctree::
   :maxdepth: 3

   shape_examples


.. _chapter_shape_examples:

Calculating Overlap
====================

Overlap calculation is the simplest functionality offered through the
**Shape TK**.  These examples show how to calculate static overlap
between two objects (molecules, grids or shape query). Note that static means
that the two input species (ref and fit) are not moved at all.  These examples
simply calculate the overlap and/or other related quantities, given the input
positions. Examples for performing calculations that actually optimize the
alignment/overlap are considered in a separate section.

Simple Overlap
----------------

This example reads in a reference molecule and a few fit
molecules and prints out the *Exact* overlap calculated.

..  oe:language:: c++

    .. oe:source:: simpleoverlap.cpp
       :language: c++
       :caption:  Simple overlap using Exact Overlap
       :refnum:   1

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`simpleoverlap.cpp <../../../../sublibs/tklibs/shape/examples/simpleoverlap.cpp>`

..  oe:language:: java

    .. oe:source:: SimpleOverlap.java
       :language: java
       :caption: Simple overlap using Exact Overlap
       :refnum: 1

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`SimpleOverlap.java <../../../../wrappers/java/examples/openeye/examples/oeshape/SimpleOverlap.java>`

..  oe:language:: python

    .. oe:source:: simpleoverlap.py
       :language: python
       :caption: Simple overlap using Exact Overlap
       :refnum: 1

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`simpleoverlap.py <../../../../wrappers/python/examples/shape/simpleoverlap.py>`

..  oe:language:: csharp

    .. oe:source:: SimpleOverlap.cs
       :language: csharp
       :caption: Simple overlap using Exact Overlap
       :refnum: 1

    .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleOverlap.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/SimpleOverlap.cs>`

Adding overlap to molecules
----------------------------

This next example program uses the *Analytic* overlap method and also uses a
little extra OEChem to attach the overlap scores to each molecule as
SD data. This can be used to rescore a set of ROCS hits or to measure
the overlap of ROCS alignments against an exclusion region in the
binding site.

..  oe:language:: c++

    .. oe:source:: rescore.cpp
       :language: c++
       :caption: Rescoring pre-aligned structures
       :refnum: 2

    .. only:: oehtml

      .. admonition:: Download code

         :download:`rescore.cpp <../../../../sublibs/tklibs/shape/examples/rescore.cpp>`

..  oe:language:: java

    .. oe:source:: Rescore.java
       :language: java
       :caption: Rescoring pre-aligned structures
       :refnum: 2

    .. only:: oehtml

      .. admonition:: Download code

         :download:`Rescore.java <../../../../wrappers/java/examples/openeye/examples/oeshape/Rescore.java>`

..  oe:language:: python

    .. oe:source:: rescore.py
       :language: python
       :caption: Rescoring pre-aligned structures
       :refnum: 2

    .. only:: oehtml

      .. admonition:: Download code

         :download:`rescore.py <../../../../wrappers/python/examples/shape/rescore.py>`

..  oe:language:: csharp

    .. oe:source:: Rescore.cs
       :language: csharp
       :caption: Rescoring pre-aligned structures
       :refnum: 2

    .. only:: oehtml

      .. admonition:: Download code

         :download:`Rescore.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/Rescore.cs>`

Color Overlap
--------------

This example reads in a reference molecule and a few fit
molecules and prints out the *Exact* color score calculated.
By default all color calculations are performed using the
ImplicitMillsDean force field.

..  oe:language:: c++

    .. oe:source:: coloroverlap.cpp
       :language: c++
       :caption: Calculating color score
       :refnum: 3

    .. only:: oehtml

      .. admonition:: Download code

         :download:`coloroverlap.cpp <../../../../sublibs/tklibs/shape/examples/coloroverlap.cpp>`

..  oe:language:: java

    .. oe:source:: ColorOverlap.java
       :language: java
       :caption: Calculating color score
       :refnum: 3

    .. only:: oehtml

      .. admonition:: Download code

         :download:`ColorOverlap.java <../../../../wrappers/java/examples/openeye/examples/oeshape/ColorOverlap.java>`

..  oe:language:: python

    .. oe:source:: coloroverlap.py
       :language: python
       :caption: Calculating color score
       :refnum: 3

    .. only:: oehtml

      .. admonition:: Download code

         :download:`coloroverlap.py <../../../../wrappers/python/examples/shape/coloroverlap.py>`

..  oe:language:: csharp

    .. oe:source:: ColorOverlap.cs
       :language: csharp
       :caption: Calculating color score
       :refnum: 3

    .. only:: oehtml

      .. admonition:: Download code

         :download:`ColorOverlap.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/ColorOverlap.cs>`

Adding color score to molecules
--------------------------------

This next example uses the ImplicitMillsDean force field and the *Analytic*
color to rescore a set of ROCS hits and add the color scores to SD tags.

..  oe:language:: c++

    .. oe:source:: colorscore.cpp
       :language: c++
       :caption: Using color to add scores to pre-aligned molecules.
       :refnum: 4

    .. only:: oehtml

      .. admonition:: Download code

         :download:`colorscore.cpp <../../../../sublibs/tklibs/shape/examples/colorscore.cpp>`

..  oe:language:: java

    .. oe:source:: ColorScore.java
       :language: java
       :caption: Using color to add scores to pre-aligned molecules.
       :refnum: 4

    .. only:: oehtml

      .. admonition:: Download code

         :download:`ColorScore.java <../../../../wrappers/java/examples/openeye/examples/oeshape/ColorScore.java>`

..  oe:language:: python

    .. oe:source:: colorscore.py
       :language: python
       :caption: Using color to add scores to pre-aligned molecules.
       :refnum: 4

    .. only:: oehtml

      .. admonition:: Download code

         :download:`colorscore.py <../../../../wrappers/python/examples/shape/colorscore.py>`

..  oe:language:: csharp

    .. oe:source:: ColorScore.cs
       :language: csharp
       :caption: Using color to add scores to pre-aligned molecules.
       :refnum: 4

    .. only:: oehtml

      .. admonition:: Download code

         :download:`ColorScore.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/ColorScore.cs>`

User Defined Color
-------------------

As a step toward writing a complete color force field, it is possible
to combine built-in rules for color atom assignment with user defined
interactions.  A new :ref:`OEColorForceField <OEShape_OEColorForceField>` object can be
created using one of the built-in types, then the interactions can be
cleared using :oe:meth:`OEShape::OEColorForceField::ClearInteractions` and subsequent user
interactions added with :oe:meth:`OEShape::OEColorForceField::AddInteraction`.

For example, to use the ImplicitMillsDean atom typing rules, but to
only consider donor-donor and acceptor-acceptor interactions, one can
use the following:

..  oe:language:: c++

    .. oe:source:: usercolor.cpp
       :language: c++
       :caption: Using ImplicitMillsDean with user interactions.
       :refnum: 5

    .. only:: oehtml

      .. admonition:: Download code

         :download:`usercolor.cpp <../../../../sublibs/tklibs/shape/examples/usercolor.cpp>`

..  oe:language:: java

    .. oe:source:: UserColor.java
       :language: java
       :caption: Using ImplicitMillsDean with user interactions.
       :refnum: 5

    .. only:: oehtml

      .. admonition:: Download code

         :download:`UserColor.java <../../../../wrappers/java/examples/openeye/examples/oeshape/UserColor.java>`

..  oe:language:: python

    .. oe:source:: usercolor.py
       :language: python
       :caption: Using ImplicitMillsDean with user interactions.
       :refnum: 5

    .. only:: oehtml

      .. admonition:: Download code

         :download:`/usercolor.py <../../../../wrappers/python/examples/shape/usercolor.py>`

..  oe:language:: csharp

    .. oe:source:: UserColor.cs
       :language: csharp
       :caption: Using ImplicitMillsDean with user interactions.
       :refnum: 5

    .. only:: oehtml

      .. admonition:: Download code

         :download:`UserColor.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/UserColor.cs>`

Shape and Color Overlap
------------------------

This example reads in a reference molecule and a few fit
molecules and prints out both the shape overlap and the color score
calculated. By default the OEOverlapFunc uses the *Grid* shape and
*Exact* color.

..  oe:language:: c++

    .. oe:source:: overlapcolor.cpp
       :language: c++
       :caption: Calculating both shape and color overlap
       :refnum: 5

    .. only:: oehtml

      .. admonition:: Download code

         :download:`overlapcolor.cpp <../../../../sublibs/tklibs/shape/examples/overlapcolor.cpp>`

..  oe:language:: java

    .. oe:source:: OverlapColor.java
       :language: java
       :caption: Calculating both shape and color overlap
       :refnum: 6

    .. only:: oehtml

      .. admonition:: Download code

         :download:`OverlapColor.java <../../../../wrappers/java/examples/openeye/examples/oeshape/OverlapColor.java>`

..  oe:language:: python

    .. oe:source:: overlapcolor.py
       :language: python
       :caption: Calculating both shape and color overlap
       :refnum: 6

    .. only:: oehtml

      .. admonition:: Download code

         :download:`overlapcolor.py  <../../../../wrappers/python/examples/shape/overlapcolor.py>`

..  oe:language:: csharp

    .. oe:source:: OverlapColor.cs
       :language: csharp
       :caption: Calculating both shape and color overlap
       :refnum: 6

    .. only:: oehtml

      .. admonition:: Download code

         :download:`OverlapColor.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/OverlapColor.cs>`

ROCS
=====

The high-level :ref:`OEROCS <OEShape_OEROCS>` provides the simplest way to
maximize shape and/or color between two objects. OEROCS uses the same
shape and color functions as used for static overlap calculation, but
optimizes the overlap between the reference and the fit objects.  By
default both shape and color optimization is performed, with shape
estimated with the *Grid* method and color estimated with the *Exact* method.

The fit object is not moved during the optimization. Part of the results
returned from the calculation are the transform required to move the
fit object into the final orientation.  The results also contain a
copy of the fit molecule conformer(s) in its final orientation.

A helper function OEROCSOverlay is created for the most simple usage of
the functionality that performs optimizations between a set of conformers
and returns the best hit.

Best Hit
---------

This example reads in a reference molecule and a fit
molecule, performs overlay optimization, finds the best hit
conformer and prints it out in final orientation.

..  oe:language:: c++

    .. oe:source:: besthit.cpp
       :language: c++
       :caption: Finding best hit conformer pair
       :refnum: 7

    .. only:: oehtml

      .. admonition:: Download code

         :download:`besthit.cpp <../../../../sublibs/tklibs/shape/examples/besthit.cpp>`

..  oe:language:: java

    .. oe:source:: BestHit.java
       :language: java
       :caption: Finding best hit conformer pair
       :refnum: 7

    .. only:: oehtml

      .. admonition:: Download code

         :download:`BestHit.java <../../../../wrappers/java/examples/openeye/examples/oeshape/BestHit.java>`

..  oe:language:: python

    .. oe:source:: besthit.py
       :language: python
       :caption: Finding best hit conformer pair
       :refnum: 7

    .. only:: oehtml

      .. admonition:: Download code

         :download:`besthit.py <../../../../wrappers/python/examples/shape/besthit.py>`

..  oe:language:: csharp

    .. oe:source:: BestHit.cs
       :language: csharp
       :caption: Finding best hit conformer pair
       :refnum: 7

    .. only:: oehtml

      .. admonition:: Download code

         :download:`BestHit.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/BestHit.cs>`

Top Hits
---------

This example reads in a reference molecule and a few fit
molecules, performs overlay optimization, finds the few top hits,
and prints them out in final orientation.

..  oe:language:: c++

    .. oe:source:: tophits.cpp
       :language: c++
       :caption: Finding top ROCS hits
       :refnum: 8

    .. only:: oehtml

      .. admonition:: Download code

         :download:`tophits.cpp <../../../../sublibs/tklibs/shape/examples/tophits.cpp>`

..  oe:language:: java

    .. oe:source:: TopHits.java
       :language: java
       :caption: Finding top ROCS hits
       :refnum: 8

    .. only:: oehtml

      .. admonition:: Download code

         :download:`TopHits.java <../../../../wrappers/java/examples/openeye/examples/oeshape/TopHits.java>`

..  oe:language:: python

    .. oe:source:: tophits.py
       :language: python
       :caption: Finding top ROCS hits
       :refnum: 8

    .. only:: oehtml

      .. admonition:: Download code

         :download:`tophits.py <../../../../wrappers/python/examples/shape/tophits.py>`

..  oe:language:: csharp

    .. oe:source:: TopHits.cs
       :language: csharp
       :caption: Finding top ROCS hits
       :refnum: 8

    .. only:: oehtml

      .. admonition:: Download code

         :download:`TopHits.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/TopHits.cs>`

Top Hits with Multiple Conformers
----------------------------------

This example repeats the Top Hits example above but fixes the number
of hits to 3 and asks for multiple best conformers for each hit reported.

..  oe:language:: c++

    .. oe:source:: tophitsconf.cpp
       :language: c++
       :caption: Finding top ROCS hits with multiple conformers
       :refnum: 9

    .. only:: oehtml

      .. admonition:: Download code

         :download:`tophitsconf.cpp <../../../../sublibs/tklibs/shape/examples/tophitsconf.cpp>`

..  oe:language:: java

    .. oe:source:: TopHitsConf.java
       :language: java
       :caption: Finding top ROCS hits with multiple conformers
       :refnum: 9

    .. only:: oehtml

      .. admonition:: Download code

         :download:`TopHitsConf.java <../../../../wrappers/java/examples/openeye/examples/oeshape/TopHitsConf.java>`

..  oe:language:: python

    .. oe:source:: tophitsconf.py
       :language: python
       :caption: Finding top ROCS hits with multiple conformers
       :refnum: 9

    .. only:: oehtml

      .. admonition:: Download code

         :download:`tophitsconf.py <../../../../wrappers/python/examples/shape/tophitsconf.py>`

..  oe:language:: csharp

    .. oe:source:: TopHitsConf.cs
       :language: csharp
       :caption: Finding top ROCS hits with multiple conformers
       :refnum: 9

    .. only:: oehtml

      .. admonition:: Download code

         :download:`TopHitsConf.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/TopHitsConf.cs>`

Overlay Optimization
=====================

The methods :ref:`OEOverlay <OEShape_OEOverlay>` and :ref:`OEMultiRefOverlay <OEShape_OEMultiRefOverlay>`,
compared to :ref:`OEROCS <OEShape_OEROCS>`, allow setting up a reference system
and process overlay optimization of multiple fit molecules. Another difference
is that both :ref:`OEOverlay <OEShape_OEOverlay>` and :ref:`OEMultiRefOverlay <OEShape_OEMultiRefOverlay>`,
in addition to providing the best overlay score, also give access to all the
results obtained during an overlay optimization. Methods
:ref:`OEOverlay <OEShape_OEOverlay>` and
:ref:`OEMultiRefOverlay <OEShape_OEMultiRefOverlay>`, which
provide all results, should  be used only when such a rigorous amount
of resulting data is desired.

.. _section_best_optimization_example:

Best Optimization Result
-------------------------

This example reads in a reference molecule and a few fit
molecules, performs overlay optimization, and returns only the best
result per reference to fit molecule overlay optimization.

..  oe:language:: c++

    .. oe:source:: overlaybestres.cpp
       :language: c++
       :caption: Getting the best scores from OEMultiRefOverlay.
       :refnum: 10

    .. only:: oehtml

      .. admonition:: Download code

         :download:`overlaybestres.cpp <../../../../sublibs/tklibs/shape/examples/overlaybestres.cpp>`

..  oe:language:: java

    .. oe:source:: OverlayBestRes.java
       :language: java
       :caption: Getting the best scores from OEMultiRefOverlay.
       :refnum: 10

    .. only:: oehtml

      .. admonition:: Download code

         :download:`OverlayBestRes.java <../../../../wrappers/java/examples/openeye/examples/oeshape/OverlayBestRes.java>`

..  oe:language:: python

    .. oe:source:: overlaybestres.py
       :language: python
       :caption: Getting the best scores from OEMultiRefOverlay.
       :refnum: 10

    .. only:: oehtml

      .. admonition:: Download code

         :download:`overlaybestres.py <../../../../wrappers/python/examples/shape/overlaybestres.py>`

    .. oe:source:: multicorebestoverlay.py
       :language: python
       :caption: Getting the best scores from OEMultiRefOverlay (multi-threaded version)
       :refnum: 10b

    .. only:: oehtml

      .. admonition:: Download code

         :download:`multicorebestoverlay.py <../../../../wrappers/python/examples/shape/multicorebestoverlay.py>`

..  oe:language:: csharp

    .. oe:source:: OverlayBestRes.cs
       :language: csharp
       :caption: Getting the best scores from OEMultiRefOverlay.
       :refnum: 10

    .. only:: oehtml

      .. admonition:: Download code

         :download:`OverlayBestRes.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/OverlayBestRes.cs>`

All Optimization Results
-------------------------

This example repeats the above, but uses
:oe:meth:`OEMultiRefOverlay::Overlay<OEShape::OEMultiRefOverlay::Overlay>`
to obtain all the results.

A single Overlay calculation will return N results, where N is the number of
ref conformers times the number of fit conformers times the number of starting
positions for each pair. So comparing 2 molecules with 10 conformers each could
return 400 or more results.

There are two helper classes designed solely to contain these results
and to make it easy to extract all or just the desired
subset. :ref:`OEBestOverlayResults <OEShape_OEBestOverlayResults>` holds the results of a
single pair of conformers. It contains a set of
:ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` objects, one for each starting
position.

This example uses 2 iterators to show all the results.

..  oe:language:: c++

    .. oe:source:: overlayallres.cpp
       :language: c++
       :caption: Getting all the scores from OEMultiRefOverlay.
       :refnum: 11

    .. only:: oehtml

      .. admonition:: Download code

         :download:`overlayallres.cpp <../../../../sublibs/tklibs/shape/examples/overlayallres.cpp>`

..  oe:language:: java

    .. oe:source:: OverlayAllRes.java
       :language: java
       :caption: Getting all the scores from OEMultiRefOverlay.
       :refnum: 11

    .. only:: oehtml

      .. admonition:: Download code

         :download:`OverlayAllRes.java <../../../../wrappers/java/examples/openeye/examples/oeshape/OverlayAllRes.java>`

..  oe:language:: python

    .. oe:source:: overlayallres.py
       :language: python
       :caption: Getting all the scores from OEMultiRefOverlay.
       :refnum: 11

    .. only:: oehtml

      .. admonition:: Download code

         :download:`overlayallres.py <../../../../wrappers/python/examples/shape/overlayallres.py>`

..  oe:language:: csharp

    .. oe:source:: OverlayAllRes.cs
       :language: csharp
       :caption: Getting all the scores from OEMultiRefOverlay.
       :refnum: 11

    .. only:: oehtml

      .. admonition:: Download code

         :download:`OverlayAllRes.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/OverlayAllRes.cs>`

Manipulating all results
-------------------------

This example repeats the above to access all overlay results, and
shows how to navigate through the results to extract a specific set.
Here, the :oe:func:`OEShape::OESortOverlayScores` function is used to turn the
double iterator as shown in the example above into a single iterator
of :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>`. Note that the third argument
is a functor used to sort the list, such that in this next example, we
get one :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` for each pair of
conformers, and they are returned in Tanimoto order.

OEOverlay or OEMultiRefOverlay does not actually move the fit molecule. Part of
OEBestOverlayScore is the rotation matrix and translation matrix
necessary to move the fit molecule into the final overlap
position. (Note well: the rotation matrix is left-multiplied so can be
regarded as left-handed.)  This example also shows how to apply these
transformations. The OpenEye standard is rotation then translation,
but as a convenience, OEBestOverlayScore has
:oe:meth:`OEShape::OEBestOverlayScore::Transform` method that will
apply the transforms in the proper order.

This example keeps the user specified number of scores, aligns each fit conformer
to the ref conformer it was overlaid on, and then write the pair to an output
file. If SD or OEB is used as the output file type, then scores will
also be stored in SD tags.

..  oe:language:: c++

    .. oe:source:: overlaystruct.cpp
       :language: c++
       :caption: Writing few aligned structures from OEMultiRefOverlay.
       :refnum: 12

    .. only:: oehtml

      .. admonition:: Download code

         :download:`overlaystruct.cpp <../../../../sublibs/tklibs/shape/examples/overlaystruct.cpp>`

..  oe:language:: java

    .. oe:source:: OverlayStruct.java
       :language: java
       :caption: Writing few aligned structures from OEMultiRefOverlay.
       :refnum: 12

    .. only:: oehtml

      .. admonition:: Download code

         :download:`OverlayStruct.java <../../../../wrappers/java/examples/openeye/examples/oeshape/OverlayStruct.java>`

..  oe:language:: python

    .. oe:source:: overlaystruct.py
       :language: python
       :caption: Writing few aligned structures from OEMultiRefOverlay.
       :refnum: 12

    .. only:: oehtml

      .. admonition:: Download code

         :download:`overlaystruct.py <../../../../wrappers/python/examples/shape/overlaystruct.py>`

..  oe:language:: csharp

    .. oe:source:: OverlayStruct.cs
       :language: csharp
       :caption: Writing few aligned structures from OEMultiRefOverlay.
       :refnum: 12

    .. only:: oehtml

      .. admonition:: Download code

         :download:`OverlayStruct.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/OverlayStruct.cs>`

Working with Shape Query
============================

This section of examples shows the use of a :ref:`OEShapeQuery <OEShape_OEShapeQuery>`,
and performs calculations where a shape query is used as the reference system
instead of a molecule as the reference.

Creating a shape query
-----------------------

This examples shows how to create a simple shape query that combines a molecule
with gaussians.  In this example, the molecule is added in the query to define
shape, and color is added separately in terms to gaussians. The created query is
then saved in a file.

..  oe:language:: c++

    .. oe:source:: createquery.cpp
       :language: c++
       :caption: Creating a shape query.
       :refnum: 13

    .. only:: oehtml

      .. admonition:: Download code

         :download:`createquery.cpp <../../../../sublibs/tklibs/shape/examples/createquery.cpp>`

.. oe:language:: java

    .. oe:source:: CreateQuery.java
       :language: java
       :caption: Creating a shape query.
       :refnum: 13

    .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateQuery.java <../../../../wrappers/java/examples/openeye/examples/oeshape/CreateQuery.java>`

..  oe:language:: python

    .. oe:source:: createquery.py
       :language: python
       :caption: Creating a shape query.
       :refnum: 13

    .. only:: oehtml

      .. admonition:: Download code

         :download:`createquery.py <../../../../wrappers/python/examples/shape/createquery.py>`

..  oe:language:: csharp

    .. oe:source:: CreateQuery.cs
       :language: csharp
       :caption: Creating a shape query.
       :refnum: 13

    .. only:: oehtml

      .. admonition:: Download code

         :download:`CreateQuery.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/CreateQuery.cs>`

Overlap with shape query
-------------------------

This example reads in a reference shape query and a few fit
molecules and prints out both the shape overlap and the color score
calculated. By default the OEOverlapFunc uses the *Grid* shape and
*Exact* color.

..  oe:language:: c++

    .. oe:source:: overlapquery.cpp
       :language: c++
       :caption: Overlap with a shape query
       :refnum: 14

    .. only:: oehtml

      .. admonition:: Download code

         :download:`overlapquery.cpp <../../../../sublibs/tklibs/shape/examples/overlapquery.cpp>`

..  oe:language:: java

    .. oe:source:: OverlapQuery.java
       :language: java
       :caption: Overlap with a shape query
       :refnum: 14

    .. only:: oehtml

      .. admonition:: Download code

         :download:`OverlapQuery.java <../../../../wrappers/java/examples/openeye/examples/oeshape/OverlapQuery.java>`

..  oe:language:: python

    .. oe:source:: overlapquery.py
       :language: python
       :caption: Overlap with a shape query
       :refnum: 14

    .. only:: oehtml

      .. admonition:: Download code

         :download:`overlapquery.py <../../../../wrappers/python/examples/shape/overlapquery.py>`

..  oe:language:: csharp

    .. oe:source:: OverlapQuery.cs
       :language: csharp
       :caption: Overlap with a shape query
       :refnum: 14

    .. only:: oehtml

      .. admonition:: Download code

         :download:`OverlapQuery.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/OverlapQuery.cs>`

Top hit against shape query
-----------------------------
This example reads in a reference query and a few fit
molecules, performs overlay optimization, finds the few top hits,
and prints them out in final orientation.

..  oe:language:: c++

    .. oe:source:: tophitsquery.cpp
       :language: c++
       :caption: Finding top ROCS hits against a query
       :refnum: 15

    .. only:: oehtml

      .. admonition:: Download code

         :download:`tophitsquery.cpp <../../../../sublibs/tklibs/shape/examples/tophitsquery.cpp>`

..  oe:language:: java

    .. oe:source:: TopHitsQuery.java
       :language: java
       :caption: Finding top ROCS hits against a query
       :refnum: 15

    .. only:: oehtml

      .. admonition:: Download code

         :download:`TopHitsQuery.java <../../../../wrappers/java/examples/openeye/examples/oeshape/TopHitsQuery.java>`

..  oe:language:: python

    .. oe:source:: tophitsquery.py
       :language: python
       :caption: Finding top ROCS hits against a query
       :refnum: 15

    .. only:: oehtml

      .. admonition:: Download code

         :download:`tophitsquery.py <../../../../wrappers/python/examples/shape/tophitsquery.py>`

..  oe:language:: csharp

    .. oe:source:: TopHitsQuery.cs
       :language: csharp
       :caption: Finding top ROCS hits against a query
       :refnum: 15

    .. only:: oehtml

      .. admonition:: Download code

         :download:`TopHitsQuery.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/TopHitsQuery.cs>`

Grid-To-Gaussians Fit
---------------------

In this example, an input molecule is converted to a molecular grid. Next the resulting grid is fitted to
shape Gaussians.

..  oe:language:: python

    .. oe:source:: grid_to_gaussians_fit.py
       :language: python
       :caption: Grid to gaussians fit
       :refnum: 19

    .. only:: oehtml

      .. admonition:: Download code

         :download:`grid_to_gaussians_fit.py <../../../../wrappers/python/examples/shape/grid_to_gaussians_fit.py>`

.. _chapter_hermite_shape_examples:

Shape from Hermite expansion
============================

Using Hermite expansion we can obtain two functionalities: expand a molecule
into Hermite representation and compare two molecules that are in the Hermite
representation by computing their shape-Tanimoto coefficient. We illustrate
both functionalities below with two examples.

Hermite expansion
-----------------

In this example we input a molecule, set the level of Hermite expansion using NPolyMax variable,
determine the optimal parameters for :math:`\lambda_x, \lambda_y, \lambda_z`, and perform the
computation of the Hermite expansion. At the end we output the resulting Hermite representation of the
molecule as a grid, using CreateGrid method of the :ref:`OEHermite class <OEShape_OEHermite>`.
The user can vary NPolyMax from
low numbers, like 4 or 5, to higher numbers like 10–30 and observe convergence of the shape. Which value
to use in practice depends on the size of the input molecule. Input molecule can be drug-like as well as a
protein.

..  oe:language:: c++

    .. oe:source:: hermite-expansion.cpp
       :language: c++
       :caption: Expanding a molecular shape into Hermite polynomials
       :refnum: 16

    .. only:: oehtml

      .. admonition:: Download code

         :download:`hermite-expansion.cpp <../../../../sublibs/tklibs/shape/examples/hermite-expansion.cpp>`

..  oe:language:: python

    .. oe:source:: hermite-expansion.py
       :language: python
       :caption: Expanding a molecular shape into Hermite polynomials
       :refnum: 16

    .. only:: oehtml

      .. admonition:: Download code

         :download:`hermite-expansion.py <../../../../wrappers/python/examples/shape/hermite-expansion.py>`

..  oe:language:: java

    .. oe:source:: HermiteExpansion.java
       :language: java
       :caption: Expanding a molecular shape into Hermite polynomials
       :refnum: 16

    .. only:: oehtml

      .. admonition:: Download code

         :download:`HermiteExpansion.java <../../../../wrappers/java/examples/openeye/examples/oeshape/HermiteExpansion.java>`

..  oe:language:: csharp

    .. oe:source:: HermiteExpansion.cs
       :language: csharp
       :caption: Expanding a molecular shape into Hermite polynomials
       :refnum: 16

    .. only:: oehtml

      .. admonition:: Download code

         :download:`HermiteExpansion.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/HermiteExpansion.cs>`

Hermite Tanimoto comparison of shape
------------------------------------

In the second example below, we set up two molecules and compute the
Tanimoto shape similarity coefficient, using Hermite expansion. The Hermite
prep parameter NPolyMax is used to 
compute the shape-Tanimoto coefficient. First molecule in the reference
input file is used versus all molecules in the fit input file. Results are
attached as SD data to the moved fit molecule, as dictated by Hermite overlay,
and sent to the output file. One can observe convergence of the
Hermite Tanimoto coefficients as the level of expansion becomes more accurate.

..  oe:language:: c++

    .. oe:source:: hermite-tanimoto.cpp
       :language: c++
       :caption: Calculating shape Tanimoto using Hermite expansion
       :refnum: 17

    .. only:: oehtml

      .. admonition:: Download code

         :download:`hermite-tanimoto.cpp <../../../../sublibs/tklibs/shape/examples/hermite-tanimoto.cpp>`

..  oe:language:: python

    .. oe:source:: hermite-tanimoto.py
       :language: python
       :caption: Calculating shape Tanimoto using Hermite expansion
       :refnum: 17

    .. only:: oehtml

      .. admonition:: Download code

         :download:`hermite-tanimoto.py <../../../../wrappers/python/examples/shape/hermite-tanimoto.py>`

..  oe:language:: java

    .. oe:source:: HermiteTanimoto.java
       :language: java
       :caption: Calculating shape Tanimoto using Hermite expansion
       :refnum: 17

    .. only:: oehtml

      .. admonition:: Download code

         :download:`HermiteTanimoto.java <../../../../wrappers/java/examples/openeye/examples/oeshape/HermiteTanimoto.java>`

..  oe:language:: csharp

    .. oe:source:: HermiteTanimoto.cs
       :language: csharp
       :caption: Calculating shape Tanimoto using Hermite expansion
       :refnum: 17

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`HermiteTanimoto.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/HermiteTanimoto.cs>`

Hermite Grid Overlay
------------------------------------

In this example, we perform grid-to-grid overlay optimization and compute the
Tanimoto coefficient between them using Hermite expansion. Hermite overlays 
between grids and molecules can also be evaluated in a similar way.

..  oe:language:: c++

    .. oe:source:: hermite-grid-overlay.cpp
       :language: c++
       :caption: Grid overlay using Hermite expansion
       :refnum: 22

    .. only:: oehtml

      .. admonition:: Download code

         :download:`hermite-grid-overlay.cpp <../../../../sublibs/tklibs/shape/examples/hermite-grid-overlay.cpp>`

..  oe:language:: python

    .. oe:source:: hermite-grid-overlay.py
       :language: python
       :caption: Grid overlay using Hermite expansion
       :refnum: 22

    .. only:: oehtml

      .. admonition:: Download code

         :download:`hermite-grid-overlay.py <../../../../wrappers/python/examples/shape/hermite-grid-overlay.py>`

.. _chapter_flexi_overlay_examples:

Flexible Overlay with Shape, Color, and Forcefield
======================================================

By incorporating Forcefield into the overlay optimization alongside Shape and Color, 
molecular flexibility can be introduced to the input fit molecule conformers. 
The flexible overlay optimization approach maintains rigidity in the reference molecule 
conformer while allowing for flexibility in the fit molecules. 
To illustrate the functionality of flexible overlay, we provide two examples. 
Note that, the default settings for the :ref:`OEFlexiOverlay<OEShape_OEFlexiOverlay>`  
perform optimization on both *Shape* and *Color* overlap while also considering 
*intra-molecular forcefield*. 

It is important to note that when running flexible overlay optimization of a molecule 
against itself, the user should not expect to obtain a tanimotocombo value of 2.0. 
This is because the fit molecules undergo flexible optimization, which includes 
intra-molecular force field, and thus may result in some deviation from 2.0.

Flexible Overlay
-----------------

In this example, Flexible overlay optimization of the fit molecules is performed against
a single reference molecule conformer.  Results of flexible overlay of all of the fit molecule
conformers are reported and saved.  

..  oe:language:: c++

    .. oe:source:: flexi_overlay.cpp
       :language: c++
       :caption: Flexible overlay optimization
       :refnum: 18

    .. only:: oehtml

      .. admonition:: Download code

         :download:`flexi_overlay.cpp <../../../../sublibs/tklibs/shape/examples/flexi_overlay.cpp>`

..  oe:language:: python

    .. oe:source:: flexi_overlay.py
       :language: python
       :caption: Flexible overlay optimization
       :refnum: 18

    .. only:: oehtml

      .. admonition:: Download code

         :download:`flexi_overlay.py <../../../../wrappers/python/examples/shape/flexi_overlay.py>`

Flexible Best Overlay
----------------------

In this example, Flexible overlay optimization of the fit molecules is performed against
a single reference molecule conformer.  The best overlaid conformers and the corresponding
results are reported and saved.

..  oe:language:: c++

    .. oe:source:: flexi_best_overlay.cpp
       :language: c++
       :caption: Flexible best overlay
       :refnum: 19

    .. only:: oehtml

      .. admonition:: Download code

         :download:`flexi_best_overlay.cpp <../../../../sublibs/tklibs/shape/examples/flexi_best_overlay.cpp>`

..  oe:language:: python

    .. oe:source:: flexi_best_overlay.py
       :language: python
       :caption: Flexible best overlay
       :refnum: 19

    .. only:: oehtml

      .. admonition:: Download code

         :download:`flexi_best_overlay.py <../../../../wrappers/python/examples/shape/flexi_best_overlay.py>`

Advanced Examples
===================

.. _section_nxnshape_example:

Calculating NxN scores
-----------------------

There are times when you want to have all the pairwise scores among a set of
molecules. Maintaining this 2D matrix of scores is more complicated than the
single set of scores from the *ref vs. set of fit molecules* examples shown
above.

This example takes a set of molecules and performs all the pairwise shape
optimizations with OEBestOverlay. It outputs a *spreadsheet* of the scores.

..  oe:language:: c++

    .. oe:source:: nxnshape.cpp
       :language: c++
       :caption: Calculating NxN scores.
       :refnum: 20

    .. only:: oehtml

      .. admonition:: Download code

         :download:`nxnshape.cpp <../../../../sublibs/tklibs/shape/examples/nxnshape.cpp>`

..  oe:language:: java

    .. oe:source:: NxNShape.java
       :language: java
       :caption: Calculating NxN scores.
       :refnum: 20

    .. only:: oehtml

      .. admonition:: Download code

         :download:`NxNShape.java <../../../../wrappers/java/examples/openeye/examples/oeshape/NxNShape.java>`

..  oe:language:: python

    .. oe:source:: nxnshape.py
       :language: python
       :caption: Calculating NxN scores.
       :refnum: 20

    .. only:: oehtml

      .. admonition:: Download code

         :download:`nxnshape.py <../../../../wrappers/python/examples/shape/nxnshape.py>`

..  oe:language:: csharp

    .. oe:source:: NxNShape.cs
       :language: csharp
       :caption: Calculating NxN scores.
       :refnum: 20

    .. only:: oehtml

      .. admonition:: Download code

         :download:`NxNShape.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/NxNShape.cs>`

Calculating shape characteristics
----------------------------------

While most functionality in the Shape Toolkit involves comparison of
pairs of molecules, there are a few fundamental properties that can be
calculated for a single molecule. All of these calculations are done
using the same basic Gaussian description of a molecule as described
above.

The simplest property to calculate is volume, using :oe:func:`OEShape::OECalcVolume`.

In addition to simple volume calculations, the steric multipoles of a
molecule can also be calculated. See section :oe:func:`OEShape::OECalcShapeMultipoles`.

This next example demonstrates the calculation of volume and shape multipoles.

..  oe:language:: c++

    .. oe:source:: shapeprops.cpp
       :language: c++
       :caption: Calculating shape properties.
       :refnum: 21

    .. only:: oehtml

      .. admonition:: Download code

         :download:`shapeprops.cpp <../../../../sublibs/tklibs/shape/examples/shapeprops.cpp>`

..  oe:language:: java

    .. oe:source:: ShapeProps.java
       :language: java
       :caption: Calculating shape properties.
       :refnum: 21

    .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeProps.java <../../../../wrappers/java/examples/openeye/examples/oeshape/ShapeProps.java>`

..  oe:language:: python

    .. oe:source:: shapeprops.py
       :language: python
       :caption: Calculating shape properties.
       :refnum: 21

    .. only:: oehtml

      .. admonition:: Download code

         :download:`shapeprops.py <../../../../wrappers/python/examples/shape/shapeprops.py>`

..  oe:language:: csharp

    .. oe:source:: ShapeProps.cs
       :language: csharp
       :caption: Calculating shape properties.
       :refnum: 21

    .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeProps.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/ShapeProps.cs>`

Calculating excluded volume
----------------------------

This code demonstrates how to use the Shape toolkit to do an overlay
to a crystallographic ligand, then calculate the overlap of the database
molecule to the cognate protein. The output includes a new score **Rescore**
which is the **ShapeTanimotoCombo** penalized by the fraction overlap.

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> excludevolume --help

.. oe:language:: python

   .. code-block:: console

      prompt> python excludevolume.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java ExcludeVolume --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> ExcludeVolume --help

will generate the following output:

.. code-block:: console

      -q : Query file name
      -e : Protein to use as exclusion volume
      -d : Database file name
      -o : Output file name

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`excludevolume.cpp <../../../../sublibs/tklibs/shape/examples/excludevolume.cpp>`
         and
         :download:`excludevolume.txt <../../../../sublibs/tklibs/shape/examples/excludevolume.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: excludevolume.cpp
         :language: c++

      with interface file

      .. oe:source:: excludevolume.txt
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`excludevolume.py <../../../../wrappers/python/examples/shape/excludevolume.py>`

   .. only:: oepdf

      .. oe:source:: excludevolume.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ExcludeVolume.java <../../../../wrappers/java/examples/openeye/examples/oeshape/ExcludedVolume.java>`
         and
         :download:`ExcludeVolume.txt <../../../../wrappers/java/examples/openeye/examples/oeshape/ExcludedVolume.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: ExcludedVolume.java
         :language: java

      with interface file

      .. oe:source:: ExcludedVolume.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ExcludeVolume.cs <../../../../wrappers/csharp/Csharp-Examples/OEShape/ExcludeVolume.cs>`

   .. only:: oepdf

      .. oe:source:: ExcludeVolume.cs
         :language: csharp



.. _shape_part_api:

******************************
API
******************************

.. toctree::
   :maxdepth: 2

   OEShapeClasses/OEShapeClasses
   OEShapeConstants/OEShapeConstants
   OEShapeFunctions/index

********************************
Preliminary API
********************************

.. toctree::
   :maxdepth: 2

   OEShapeClasses/OEShapeClasses-preliminary.rst
   OEShapeConstants/OEShapeConstants-preliminary.rst

********************************
Deprecated API
********************************

.. toctree::
   :maxdepth: 2

   OEShapeClasses/OEShapeClassesDpcr
   OEShapeConstants/OEShapeConstantsDpcr


.. _OEShapeClasses:

*******************
OEShape Classes
*******************

.. oe:namespace:: OEShape

.. toctree::

   OEAnalyticColorFunc
   OEAnalyticOptions
   OEAnalyticShapeFunc
   OEAsIsStarts
   OEAtAtomStarts
   OEBestOverlayResults
   OEBestOverlayScore
   OECartesianStarts
   OEColorFFParameter
   OEColorForceField
   OEColorFunc
   OEColorOptions
   OEColorTanimotoCutoff
   OEExactColorFunc
   OEExactShapeFunc
   OEFitColorTverskyCutoff
   OEFitTverskyComboCutoff
   OEFitTverskyCutoff
   OEFlexiOverlapFunc
   OEFlexiOverlapOptions
   OEFlexiOverlapResults
   OEFlexiOverlay
   OEFlexiOverlayOptions
   OEGridColorFunc
   OEGridShapeFunc
   OEHermite
   OEHermiteOptions
   OEHermiteShapeFunc
   OEHighestColorTanimoto
   OEHighestFitColorTversky
   OEHighestFitTversky
   OEHighestFitTverskyCombo
   OEHighestOverlap
   OEHighestRefColorTversky
   OEHighestRefTversky
   OEHighestRefTverskyCombo
   OEHighestScaledColor
   OEHighestTanimoto
   OEHighestTanimotoCombo
   OEHighestTverskyCombo
   OEInertialStarts
   OEIsColorAtomPred
   OEMultiRefOverlay
   OEOverlapCutoff
   OEOverlapFunc
   OEOverlapFuncBase
   OEOverlapPrep
   OEOverlapPrepOptions
   OEOverlapResults
   OEOverlay
   OEOverlayOptions
   OEOverlayScoreCutoff
   OEQuatStarts
   OERefColorTverskyCutoff
   OERefTverskyComboCutoff
   OERefTverskyCutoff
   OERandomStarts
   OEROCS
   OEROCSOptions
   OEROCSResult
   OEShapeFunc
   OEShapeGridOptions
   OEShapeOptions
   OEStarts
   OEShapeQuery
   OEShapeQueryBase
   OESubrocsStarts
   OETanimotoComboCutoff
   OETanimotoCutoff


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEAnalyticColorFunc, AnalyticColorFunc

.. _OEShape_OEAnalyticColorFunc:

.. oe:class:: OEAnalyticColorFunc

   .. oe:api::

      class OEAnalyticColorFunc : public OEShapeFunc

   The :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>` class defines color overlap between a reference
   object and a fit molecule, using the *Analytic* method.

   .. _figure_OEAnalyticColorFunc_Hierarchy:

   .. figure:: shapetk/images/OEAnalyticColorFunc.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`  
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>`
    * :oe:meth:`SetupFlex<OEShape::OEOverlapFuncBase::SetupFlex>`
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The following methods are publicly inherited from :ref:`OEColorFunc <OEShape_OEColorFunc>`:
    * :oe:meth:`GetColorOptions<OEShape::OEColorFunc::GetColorOptions>`

   The :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>` class defines the following public methods:
    * :oe:meth:`GetAnalyticOptions<OEShape::OEAnalyticColorFunc::GetAnalyticOptions>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAnalyticColorFunc(const OEColorOptions& argOptions = OEColorOptions())
            OEAnalyticColorFunc(const OEAnalyticOptions&)
            OEAnalyticColorFunc(const OEColorOptions& argColor,
                                const OEAnalyticOptions& argAnalytic)
            OEAnalyticColorFunc(const OEAnalyticColorFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEAnalyticColorFunc(argOptions: OEColorOptions = OEColorOptions()) -> OEAnalyticColorFunc
            OEAnalyticColorFunc(argOptions: OEAnalyticOptions) -> OEAnalyticColorFunc
            OEAnalyticColorFunc(argColor: OEColorOptions,
                                argAnalytic: OEAnalyticOptions) -> OEAnalyticColorFunc
            OEAnalyticColorFunc(argFunc: OEAnalyticColorFunc) -> OEAnalyticColorFunc

      Default and copy constructors.

      Constructs an :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAnalyticColorFunc &operator=(const OEAnalyticColorFunc &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetAnalyticOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEAnalyticOptions& GetAnalyticOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetAnalyticOptions() -> OEAnalyticOptions

      Returns a reference to the :ref:`OEAnalyticOptions <OEShape_OEAnalyticOptions>`
      instance as currently set for this :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEAnalyticOptions, AnalyticOptions

.. _OEShape_OEAnalyticOptions:

.. oe:class:: OEAnalyticOptions

   .. oe:api::

      class OEAnalyticOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for calculations
   with the *Analytic* method.
   
   The :ref:`OEAnalyticOptions <OEShape_OEAnalyticOptions>` class defines the following public methods:
    * :oe:meth:`GetExpType<OEShape::OEAnalyticOptions::GetExpType>`
    * :oe:meth:`GetProxyGridCutoff<OEShape::OEAnalyticOptions::GetProxyGridCutoff>` 
    * :oe:meth:`GetUseProxyGrid<OEShape::OEAnalyticOptions::GetUseProxyGrid>`
    * :oe:meth:`SetExpType<OEShape::OEAnalyticOptions::SetExpType>`
    * :oe:meth:`SetProxyGridCutoff<OEShape::OEAnalyticOptions::SetProxyGridCutoff>` 
    * :oe:meth:`SetUseProxyGrid<OEShape::OEAnalyticOptions::SetUseProxyGrid>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAnalyticOptions()
            OEAnalyticOptions(const OEAnalyticOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEAnalyticOptions() -> OEAnalyticOptions
            OEAnalyticOptions(arg2: OEAnalyticOptions) -> OEAnalyticOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAnalyticOptions &operator=(const OEAnalyticOptions &)

      Assignment operator.

   .. oe:method:: GetExpType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetExpType() const

      .. oe:language:: python

         .. oe:api:: python

            GetExpType() -> int

      Gets the current value of the exponential type used by the function.

   .. oe:method:: GetProxyGridCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetProxyGridCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetProxyGridCutoff() -> float

      Gets the proxy grid cutoff currently set.

   .. oe:method:: GetUseProxyGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseProxyGrid() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseProxyGrid() -> bool

      Returns the state of the use proxy grid flag. If true, proxy grid would be 
      used to decide if an atom pair should be included in calculations.

   .. oe:method:: SetExpType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetExpType(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetExpType(value: int) -> bool

      Set the exponential type to be used for calculation. The default is
      :oe:const:`OEShape::OEExponentialType::Standard`. Alternatives are
      defined in the :oe:constns:`OEShape::OEExponentialType` namespace.

   .. oe:method:: SetProxyGridCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetProxyGridCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetProxyGridCutoff(value: float) -> bool

      Set the radius to use when using proxy grid is turned on. 
      By default this is set to 3.0 |A|.

   .. oe:method:: SetUseProxyGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseProxyGrid(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseProxyGrid(value: bool) -> bool

      Sets the state of the use proxy grid flag. If true, proxy grid would be 
      used to decide if an atom pair should be included in calculations.

   



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEAnalyticShapeFunc, AnalyticShapeFunc

.. _OEShape_OEAnalyticShapeFunc:

.. oe:class:: OEAnalyticShapeFunc

   .. oe:api::

      class OEAnalyticShapeFunc : public OEShapeFunc

   The :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>` class defines shape overlap between a reference
   object and a fit molecule, using the *Analytic* method.

   .. _figure_OEAnalyticShapeFunc_Hierarchy:

   .. figure:: shapetk/images/OEAnalyticShapeFunc.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`   
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>` 
    * :oe:meth:`SetupFlex<OEShape::OEOverlapFuncBase::SetupFlex>`
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The following methods are publicly inherited from :ref:`OEShapeFunc <OEShape_OEShapeFunc>`:
    * :oe:meth:`GetShapeOptions<OEShape::OEShapeFunc::GetShapeOptions>`

   The :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>` class defines the following public methods:
    * :oe:meth:`GetAnalyticOptions<OEShape::OEAnalyticShapeFunc::GetAnalyticOptions>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAnalyticShapeFunc(const OEShapeOptions& argOptions = OEShapeOptions())
            OEAnalyticShapeFunc(const OEAnalyticOptions&)
            OEAnalyticShapeFunc(const OEShapeOptions& argShape,
                                const OEAnalyticOptions& argAnalytic)
            OEAnalyticShapeFunc(const OEAnalyticShapeFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEAnalyticShapeFunc(argOptions: OEShapeOptions = OEShapeOptions()) -> OEAnalyticShapeFunc
            OEAnalyticShapeFunc(argOptions: OEAnalyticOptions) -> OEAnalyticShapeFunc
            OEAnalyticShapeFunc(argShape: OEShapeOptions,
                                argAnalytic: OEAnalyticOptions) -> OEAnalyticShapeFunc
            OEAnalyticShapeFunc(argFunc: OEAnalyticShapeFunc) -> OEAnalyticShapeFunc

      Default and copy constructors.

      Constructs an :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAnalyticShapeFunc &operator=(const OEAnalyticShapeFunc &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetAnalyticOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEAnalyticOptions& GetAnalyticOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetAnalyticOptions() -> OEAnalyticOptions

      Returns a reference to the :ref:`OEAnalyticOptions <OEShape_OEAnalyticOptions>`
      instance as currently set for this :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>`.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEAsIsStarts, AsIsStarts

.. _OEShape_OEAsIsStarts:

.. oe:class:: OEAsIsStarts

   .. oe:api::

      class OEAsIsStarts : public OEStarts

   The :ref:`OEAsIsStarts <OEShape_OEAsIsStarts>` represents the AsIs start for
   overlay optimization.  The :ref:`OEAsIsStarts <OEShape_OEAsIsStarts>` takes the
   fit conformer as-is, without any rotation or translation.

   The following methods are publicly inherited from :ref:`OEStarts <OEShape_OEStarts>`:
    * :oe:meth:`CreateCopy<OEShape::OEStarts::CreateCopy>`  
    * :oe:meth:`GetNumOfStarts<OEShape::OEStarts::GetNumOfStarts>` 
    * :oe:meth:`GetStarts<OEShape::OEStarts::GetStarts>`
    * :oe:meth:`Setup<OEShape::OEStarts::Setup>` 
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupFrame>`
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupRef>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAsIsStarts()
            OEAsIsStarts(const OEAsIsStarts&)

      .. oe:language:: python

         .. oe:api:: python

            OEAsIsStarts() -> OEAsIsStarts
            OEAsIsStarts(arg2: OEAsIsStarts) -> OEAsIsStarts

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAsIsStarts &operator=(const OEAsIsStarts &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEAtAtomStarts, AtAtomStarts

.. _OEShape_OEAtAtomStarts:

.. oe:class:: OEAtAtomStarts

   .. oe:api::

      class OEAtAtomStarts : public OEInertialStarts

   The :ref:`OEAtAtomStarts <OEShape_OEAtAtomStarts>` represents the AtAtom starts for
   overlay optimization.  The :ref:`OEAtAtomStarts <OEShape_OEAtAtomStarts>` translates
   the fit molecule to the specified atom center of the reference molecule,
   followed by the inertial rotations to generate starts.

   The following methods are publicly inherited from :ref:`OEStarts <OEShape_OEStarts>`:
    * :oe:meth:`CreateCopy<OEShape::OEStarts::CreateCopy>`  
    * :oe:meth:`GetNumOfStarts<OEShape::OEStarts::GetNumOfStarts>` 
    * :oe:meth:`GetStarts<OEShape::OEStarts::GetStarts>`
    * :oe:meth:`Setup<OEShape::OEStarts::Setup>` 
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupFrame>`
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupRef>`

   The following methods are publicly inherited from :ref:`OEInertialStarts <OEShape_OEInertialStarts>`:
    * :oe:meth:`GetSymmetryThreshold<OEShape::OEInertialStarts::GetSymmetryThreshold>`  
    * :oe:meth:`SetSymmetryThreshold<OEShape::OEInertialStarts::SetSymmetryThreshold>` 

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtAtomStarts(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& argPredicate = OEChem::OEIsHeavy())
            OEAtAtomStarts(const OEAtAtomStarts&)

      .. oe:language:: python

         .. oe:api:: python

            OEAtAtomStarts(argPredicate: OEUnaryAtomPred = OEIsHeavy()) -> OEAtAtomStarts
            OEAtAtomStarts(argStarts: OEAtAtomStarts) -> OEAtAtomStarts

      Default and copy constructors. Use the second constructor to specify the
      at center to be picked for AtAtom starts.  By default the heavy atoms of
      reference molecule are picked.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAtAtomStarts &operator=(const OEAtAtomStarts &)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEBestOverlay, BestOverlay

.. _OEShape_OEBestOverlay:

.. oe:class:: OEBestOverlay

   .. oe:api::

      class OEBestOverlay

   .. note::

      This deprecated class will not be developed further. It is being replaced by
      :ref:`OEOverlay <OEShape_OEOverlay>` and :ref:`OEROCS <OEShape_OEROCS>` which provides
      more control and greater expandability.

   This class is used to optimize the overlap between 2
   molecules. Both molecules can contain one or more conformers. The
   reference molecule is held rigid and the fit molecule orientation
   is calculated to maximize overlap.  Each conformer of the fit
   molecule is optimized against each conformer of the reference
   molecule, resulting in a large number of results that can be
   returned. The :ref:`OEBestOverlayResults <OEShape_OEBestOverlayResults>` and
   :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` classes are used to make handling this
   large amount of results easier.

   Additionally, the reference or fit shape can be a grid instead of a molecule.

   Since an OEBestOverlay optimization can result in numerous final
   results, one for each starting position, the
   :ref:`OEBestOverlayResults <OEShape_OEBestOverlayResults>` class is a container to hold
   all the results for a fit conformer against a reference
   conformer. This class is essentially a container for one or more
   :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` instances.  The actual number
   of scores depends on the :oe:constns:`OEShape::OEBOOrientation` used
   in the OEBestOverlay.

   For :oe:const:`OEShape::OEBOOrientation::Inertial`, there will be 4,
   8 or 20 scores per ref-fit conformer pair, depending on the
   symmetry of each conformer.  For
   :oe:const:`OEShape::OEBOOrientation::AsIs`, there will be just 1
   :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` inside each
   :ref:`OEBestOverlayResults <OEShape_OEBestOverlayResults>` instance. And for
   :oe:const:`OEShape::OEBOOrientation::Random`, then there will be 1 OEBestOverlayScore for
   each of the **N** random starts. 

   When dealing with the results from OEBestOverlay, the user can
   either use a double loop, *i.e.* loop over all the
   OEBestOverlayResults instances for each ref-fit conformer pair then
   loop over each OEBestOverlayScore inside each OEBestOverlayResults
   instance. In this case, the results also come out in conformer
   order.

   .. oe:language:: c++

      .. code-block:: c++

         OEIter<OEBestOverlayResults> resiter = best.Overlay(fitmol);
         for (;resiter;++resiter)
         {
             OEIter<OEBestOverlayScore> scoreiter = resiter->GetScores();
             for (;scoreiter;++scoreiter)
             {
                 // do something with score
             }
         }

   .. oe:language:: python

      .. code-block:: python

         for res in best.Overlay(fitmol):
             for score in res.GetScores():
                 # do something with score 

   .. oe:language:: java

      .. code-block:: java

         OEBestOverlayResultsIter resiter = best.Overlay(fitmol);
         for (OEBestOverlayResults res : best.Overlay(fitmol)) {
             for (OEBestOverlayScore score : res.GetScores()) {
                 // do something with score
             }
         }

   Or, there is a free function
   :oe:func:`OEShape::OESortOverlayScores`, that takes an iterator of
   OEBestOverlayResults and returns a single, sorted iterator of
   OEBestOverlayScores that can be used in a single loop.

   .. oe:language:: c++

      .. code-block:: c++

         OEIter<OEBestOverlayResults> resiter = best.Overlay(fitmol);
         OEIter<OEBestOverlayScore> scoreiter;
         OESortOverlayScores(scoreiter, resiter, OEHighestTanimotoCombo());
         for (;scoreiter;++scoreiter)
         {
             // do something with score
         }

   .. oe:language:: python

      .. code-block:: python

         scoreiter = OEBestOverlayScoreIter()
         OESortOverlayScores(scoreiter, best.Overlay(fitmol), OEHighestTanimotoCombo())
         for score in scoreiter:
              # do something with score 

   .. oe:language:: java

      .. code-block:: java

         OEBestOverlayResultsIter resiter = best.Overlay(fitmol);
         OEBestOverlayScoreIter scoreiter = new OEBestOverlayScoreIter();
         oeshape.OESortOverlayScores(scoreiter, resiter, new OEHighestTanimotoCombo());
         for (OEBestOverlayScore score : scoreiter) {
             // do something with score
         }

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBestOverlay()
            OEBestOverlay(const OEBestOverlay &)
            OEBestOverlay(const OEChem::OEMCMolBase& refmol)
            OEBestOverlay(const OESystem::OEScalarGrid& refgrid,
                          float interpolate = 0.5f)

      .. oe:language:: python

         .. oe:api:: python

            OEBestOverlay() -> OEBestOverlay
            OEBestOverlay(refmol: OEMol) -> OEBestOverlay
            OEBestOverlay(refgrid: OEScalarGrid, interpolate: float = 0.5) -> OEBestOverlay
            OEBestOverlay(arg2: OEBestOverlay) -> OEBestOverlay

      An empty OEBestOverlay class instance can be created, or a new
      instance can take the reference molecule or grid as an
      argument. Note that by default, grids that have a resolution
      larger that 0.5 |A| will be interpolated to that resolution.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBestOverlay &operator=(const OEBestOverlay &)

      The assignment operator.

      Assignment operator.

      
   .. oe:method:: ClearColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearColorForceField()

      .. oe:language:: python

         .. oe:api:: python

            ClearColorForceField() -> None

      Clear out any color force field. No color scores will be calculated.

   .. oe:method:: ClearUserStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearUserStarts()

      .. oe:language:: python

         .. oe:api:: python

            ClearUserStarts() -> None

      Set the number of User Starts back to zero. 

   .. oe:method:: GetCarbonRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetCarbonRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetCarbonRadius() -> float

      Return the current value for the carbon radius approximation.

   .. oe:method:: GetInitialOrientation

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetInitialOrientation() const

      .. oe:language:: python

         .. oe:api:: python

            GetInitialOrientation() -> int

      Get the current value for initial orientation. Possible values are from the
      :oe:constns:`OEShape::OEBOOrientation` namespace.

   .. oe:method:: GetMaxRandomTranslation

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetMaxRandomTranslation() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxRandomTranslation() -> float

      Get the value in |A| of maximum random translation. 

   .. oe:method:: GetMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetMethod() -> int

      Return the current value of overlap method.

   .. oe:method:: GetMinimizeType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMinimizeType() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinimizeType() -> int

      Get the current value for minimize type. Possible values are from the
      :oe:constns:`OEShape::OEBOMinType` namespace.

   .. oe:method:: GetNumRandomStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumRandomStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumRandomStarts() -> int

      Get the current number of random starts. 
     
   .. oe:method:: GetNumUserStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumUserStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumUserStarts() -> int

      Get the number of user starts currently set. Note that these are not actually
      used unless :oe:const:`OEShape::OEBOOrientation::UserInertialStarts` is also set.

   .. oe:method:: GetRadiiApproximation

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRadiiApproximation() const

      .. oe:language:: python

         .. oe:api:: python

            GetRadiiApproximation() -> int

      Return the current value of the radii approximation.

   .. oe:method:: GetRandomSeed

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRandomSeed() const

      .. oe:language:: python

         .. oe:api:: python

            GetRandomSeed() -> int

      Get the current value of the random seed.

   .. oe:method:: GetRefGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEScalarGrid* GetRefGrid() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefGrid() -> OEScalarGrid

   .. oe:method:: GetRefMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMCMolBase* GetRefMol() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefMol() -> OEMol

   .. oe:method:: GetRefSelfColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetRefSelfColor()

      .. oe:language:: python

         .. oe:api:: python

            GetRefSelfColor() -> float

      Return the self color score of the reference molecule.

   .. oe:method:: GetRefSymmetry

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRefSymmetry(unsigned int confIdx) const

      .. oe:language:: python

         .. oe:api:: python

            GetRefSymmetry(confIdx: int) -> int

      Return the current representation level.

   .. oe:method:: GetSymmetryThreshold

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSymmetryThreshold() const

      .. oe:language:: python

         .. oe:api:: python

            GetSymmetryThreshold() -> float

   .. oe:method:: GetUseHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseHydrogens() -> bool

      Return the status of hydrogen use in OEBestOverlay.
      
   .. oe:method:: GetUserStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUserStarts(float* xyz) const

      .. oe:language:: python

         .. oe:api:: python

            GetUserStarts(xyz: OEFloatArray) -> bool

      Extract the coordinates of the user starts. ``xyz`` should be sized to
      3 * GetNumUserStarts().

   .. oe:method:: Overlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBestOverlayResults>* Overlay(const OEChem::OEMCMolBase& fitmol)

      .. oe:language:: python

         .. oe:api:: python

            Overlay(fitmol: OEMol) -> Iterable[OEBestOverlayResults]

      Perform the calculation and return the an iterator of the results. 

   .. oe:method:: SetCarbonRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCarbonRadius(float cradius)

      .. oe:language:: python

         .. oe:api:: python

            SetCarbonRadius(cradius: float) -> None

      Set the radius to use when using
      :oe:const:`OEShape::OEOverlapRadii::Carbon`. By default this is
      set to 1.7 |A|.

   .. oe:method:: SetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorForceField(unsigned int type)
            bool SetColorForceField(OEPlatform::oeistream& is)
            bool SetColorForceField(const std::string& filename)
            bool SetColorForceField(const OEColorForceField& cff)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceField(type: int) -> bool
            SetColorForceField(ifs: oeistream) -> bool
            SetColorForceField(filename: str) -> bool
            SetColorForceField(cff: OEColorForceField) -> bool

      Set the color force field to be used. Once set, color scores
      will be calculated and included in the results. Color gradients
      will not be included in the optimization unless specifically set
      using SetColorOptimize(true).

   .. oe:method:: SetColorOptimize

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColorOptimize(bool state)

      .. oe:language:: python

         .. oe:api:: python

            SetColorOptimize(state: bool) -> None

      Add color gradients to shape gradients in the optimization. Has no effect unless
      a color force field is also set via :oe:meth:`OEShape::OEBestOverlay::SetColorForceField`.

   .. oe:method:: SetInitialOrientation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetInitialOrientation(unsigned int orient)

      .. oe:language:: python

         .. oe:api:: python

            SetInitialOrientation(orient: int) -> None

      Determines the initial orientation (starting position) for each
      optimization.  The default is
      :oe:const:`OEShape::OEBOOrientation::Inertial`. Alternatives are defined
      in the :oe:constns:`OEShape::OEBOOrientation` namespace.

   .. oe:method:: SetMaxRandomTranslation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxRandomTranslation(float trans)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxRandomTranslation(trans: float) -> None

      If using random starts, this set the maximum distance (in |A|)
      that the center of mass of the fit molecule will be moved away
      from the center calculated for inertial frame alignment.

   .. oe:method:: SetMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMethod(unsigned int method)

      .. oe:language:: python

         .. oe:api:: python

            SetMethod(method: int) -> None

      Set the method used to calculate overlap. The default for
      OEBestOverlay is :oe:const:`OEShape::OEOverlapMethod::Grid`. Alternatives are defined
      in the :oe:constns:`OEShape::OEOverlapMethod` namespace.

   .. oe:method:: SetMinimizeType

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMinimizeType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetMinimizeType(type: int) -> None

      Set the score to use in the optimization. Options are in the
      :oe:constns:`OEShape::OEBOMinType` namespace.

   .. oe:method:: SetNumRandomStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetNumRandomStarts(unsigned int n)

      .. oe:language:: python

         .. oe:api:: python

            SetNumRandomStarts(n: int) -> None

      If SetInitialOrientation is set to
      :oe:const:`OEShape::OEBOOrientation::Random`, this method sets
      the number of random starting positions that will be used.

   .. oe:method:: SetRadiiApproximation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRadiiApproximation(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetRadiiApproximation(type: int) -> None

      Set the radius approximation used to calculate overlap. The
      default for OEBestOverlay is
      :oe:const:`OEShape::OEOverlapRadii::Carbon`. Alternatives are
      defined in the :oe:constns:`OEShape::OEOverlapRadii` namespace.

   .. oe:method:: SetRandomSeed

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRandomSeed(unsigned int seed)

      .. oe:language:: python

         .. oe:api:: python

            SetRandomSeed(seed: int) -> None

      Set a random seed value to allow reproducible random searches.

   .. oe:method:: SetRefGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRefGrid(const OESystem::OEScalarGrid& refgrid,
                            float interpolate = 0.5f)

      .. oe:language:: python

         .. oe:api:: python

            SetRefGrid(refgrid: OEScalarGrid, interpolate: float = 0.5) -> bool

      Set a reference grid for the calculation. OEBestOverlay makes an
      internal copy. Pre-existing reference molecules or grids are replaced.

   .. oe:method:: SetRefMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRefMol(const OEChem::OEMCMolBase& refmol)

      .. oe:language:: python

         .. oe:api:: python

            SetRefMol(refmol: OEMol) -> bool

      Set a reference molecule for the calculation. OEBestOverlay makes an
      internal copy. Pre-existing reference molecules or grids are replaced.

   .. oe:method:: SetSymmetryThreshold

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSymmetryThreshold(float threshold)

      .. oe:language:: python

         .. oe:api:: python

            SetSymmetryThreshold(threshold: float) -> None

   .. oe:method:: SetUseHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetUseHydrogens(bool state)

      .. oe:language:: python

         .. oe:api:: python

            SetUseHydrogens(state: bool) -> None

      Boolean to determine whether hydrogens are included in the shape calculation.
      By default this is false and hydrogens are ignored.

   .. oe:method:: SetUserStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetUserStarts(const float* xyz, unsigned int nstarts)

      .. oe:language:: python

         .. oe:api:: python

            SetUserStarts(xyz: OEFloatArray, nstarts: int) -> None

      Set a set of 3D coordinates for doing separate inertial
      starts. ``xyz`` should be 3 * nstarts. These are not used unless
      :oe:const:`OEShape::OEBOOrientation::UserInertialStarts` is also set.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEBestOverlayResults, BestOverlayResults

.. _OEShape_OEBestOverlayResults:

.. oe:class:: OEBestOverlayResults

   .. oe:api::

      class OEBestOverlayResults

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBestOverlayResults()
            OEBestOverlayResults(const OEBestOverlayResults& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEBestOverlayResults() -> OEBestOverlayResults
            OEBestOverlayResults(rhs: OEBestOverlayResults) -> OEBestOverlayResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBestOverlayResults &operator=(const OEBestOverlayResults &rhs)

      Assignment operator.

   .. oe:method:: AddScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddScore(const OEBestOverlayScore& sc)

      .. oe:language:: python

         .. oe:api:: python

            AddScore(sc: OEBestOverlayScore) -> bool

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> bool

   .. oe:method:: GetScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBestOverlayScore>* GetScores()
            OESystem::OEIterBase<OEBestOverlayScore>* GetScores(const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& sorter,
                                                                int nbest = 1)

      .. oe:language:: python

         .. oe:api:: python

            GetScores() -> Iterable[OEBestOverlayScore]
            GetScores(sorter: OEBestOverlayScoreSorterPred, nbest: int = 1) -> Iterable[OEBestOverlayScore]



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEBestOverlayScore, BestOverlayScore

.. _OEShape_OEBestOverlayScore:

.. oe:class:: OEBestOverlayScore

   .. oe:api::

      class OEBestOverlayScore : public OEOverlapResults

   This class extends the :ref:`OEOverlapResults <OEShape_OEOverlapResults>` to represent the results of
   a single overlay optimization between a reference and a fit object.

   The following methods are publicly inherited from :ref:`OEOverlapResults <OEShape_OEOverlapResults>`:
    * :oe:meth:`GetColorScore<OEShape::OEOverlapResults::GetColorScore>`
    * :oe:meth:`GetColorTanimoto<OEShape::OEOverlapResults::GetColorTanimoto>` 
    * :oe:meth:`GetColorTversky<OEShape::OEOverlapResults::GetColorTversky>`
    * :oe:meth:`GetFitColorTversky<OEShape::OEOverlapResults::GetFitColorTversky>` 
    * :oe:meth:`GetFitSelfColor<OEShape::OEOverlapResults::GetFitSelfColor>`
    * :oe:meth:`GetFitSelfOverlap<OEShape::OEOverlapResults::GetFitSelfOverlap>`
    * :oe:meth:`GetFitTversky<OEShape::OEOverlapResults::GetFitTversky>` 
    * :oe:meth:`GetFitTverskyCombo<OEShape::OEOverlapResults::GetFitTverskyCombo>`
    * :oe:meth:`GetOverlap<OEShape::OEOverlapResults::GetOverlap>`
    * :oe:meth:`GetRefColorTversky<OEShape::OEOverlapResults::GetRefColorTversky>` 
    * :oe:meth:`GetRefSelfColor<OEShape::OEOverlapResults::GetRefSelfColor>`
    * :oe:meth:`GetRefSelfOverlap<OEShape::OEOverlapResults::GetRefSelfOverlap>`
    * :oe:meth:`GetRefTversky<OEShape::OEOverlapResults::GetRefTversky>` 
    * :oe:meth:`GetRefTverskyCombo<OEShape::OEOverlapResults::GetRefTverskyCombo>`
    * :oe:meth:`GetTanimoto<OEShape::OEOverlapResults::GetTanimoto>`
    * :oe:meth:`GetTanimotoCombo<OEShape::OEOverlapResults::GetTanimotoCombo>` 
    * :oe:meth:`GetTversky<OEShape::OEOverlapResults::GetTversky>`

   The :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` class defines the following public methods:
    * :oe:meth:`GetFitConfIdx<OEShape::OEBestOverlayScore::GetFitConfIdx>`
    * :oe:meth:`GetRefConfIdx<OEShape::OEBestOverlayScore::GetRefConfIdx>` 
    * :oe:meth:`GetRotMatrix<OEShape::OEBestOverlayScore::GetRotMatrix>`
    * :oe:meth:`GetTranslation<OEShape::OEBestOverlayScore::GetTranslation>` 
    * :oe:meth:`Transform<OEShape::OEBestOverlayScore::Transform>`
    
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBestOverlayScore()
            OEBestOverlayScore(const OEBestOverlayScore&)

      .. oe:language:: python

         .. oe:api:: python

            OEBestOverlayScore() -> OEBestOverlayScore
            OEBestOverlayScore(rhs: OEBestOverlayScore) -> OEBestOverlayScore

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBestOverlayScore &operator=(const OEBestOverlayScore&)

      Assignment operator.

   .. oe:method:: GetFitConfIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetFitConfIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitConfIdx() -> int

      Returns the conformer index of the fit conformer.

   .. oe:method:: GetRefConfIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRefConfIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefConfIdx() -> int

      Returns the conformer index of the reference conformer.

   .. oe:method:: GetRotMatrix

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetRotMatrix(float*) const

      .. oe:language:: python

         .. oe:api:: python

            GetRotMatrix(rmat: OEFloatArray) -> None

      Returns the rotation matrix to be applied on the fit conformer to obtain the optimized overlay.
      Using the OpenEye convention, rotation should be applied before the translation.

   .. oe:method:: GetTranslation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetTranslation(float*) const

      .. oe:language:: python

         .. oe:api:: python

            GetTranslation(trans: OEFloatArray) -> None

      Returns the translation vector to be applied on the fit conformer to obtain the optimized overlay.
      Using the OpenEye convention, rotation should be applied before the translation.

   .. _OEShape_OEBestOverlayScore_Transform:

   .. oe:method:: Transform

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Transform(OEChem::OEMolBase& mol) const
            bool Transform(OEChem::OEConfBase& conf) const
            bool Transform(OESystem::OEScalarGrid& grid) const

      .. oe:language:: python

         .. oe:api:: python

            Transform(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            Transform(mol: OEConfBase) -> bool
            Transform(grid: OEScalarGrid) -> bool

      Transforms the molecule to the optimized overlay position.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OECartesianStarts, CartesianStarts

.. _OEShape_OECartesianStarts:

.. oe:class:: OECartesianStarts

   .. oe:api::

      class OECartesianStarts : public OEInertialStarts

   The :ref:`OECartesianStarts <OEShape_OECartesianStarts>` represents the user defined
   cartesian starts for overlay optimization.  The :ref:`OECartesianStarts <OEShape_OECartesianStarts>`
   translates the fit molecule to the specified starting points,
   followed by the inertial rotations to generate starts.

   The following methods are publicly inherited from :ref:`OEStarts <OEShape_OEStarts>`:
    * :oe:meth:`CreateCopy<OEShape::OEStarts::CreateCopy>`  
    * :oe:meth:`GetNumOfStarts<OEShape::OEStarts::GetNumOfStarts>` 
    * :oe:meth:`GetStarts<OEShape::OEStarts::GetStarts>`
    * :oe:meth:`Setup<OEShape::OEStarts::Setup>` 
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupFrame>`
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupRef>`

   The following methods are publicly inherited from :ref:`OEInertialStarts <OEShape_OEInertialStarts>`:
    * :oe:meth:`GetSymmetryThreshold<OEShape::OEInertialStarts::GetSymmetryThreshold>`  
    * :oe:meth:`SetSymmetryThreshold<OEShape::OEInertialStarts::SetSymmetryThreshold>`

   The :ref:`OECartesianStarts <OEShape_OECartesianStarts>` class defines the following public methods:
    * :oe:meth:`ClearStartPoints<OEShape::OECartesianStarts::ClearStartPoints>` 
    * :oe:meth:`GetNumStartPoints<OEShape::OECartesianStarts::GetNumStartPoints>`
    * :oe:meth:`GetStartPoints<OEShape::OECartesianStarts::GetStartPoints>`
    * :oe:meth:`SetStartPoints<OEShape::OECartesianStarts::SetStartPoints>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECartesianStarts()
            OECartesianStarts(const OECartesianStarts&)

      .. oe:language:: python

         .. oe:api:: python

            OECartesianStarts() -> OECartesianStarts
            OECartesianStarts(arg2: OECartesianStarts) -> OECartesianStarts

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECartesianStarts &operator=(const OECartesianStarts &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: ClearStartPoints

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearStartPoints()

      .. oe:language:: python

         .. oe:api:: python

            ClearStartPoints() -> None

      Clears the currently specified cartesian start points.

   .. oe:method:: GetNumStartPoints

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumStartPoints() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumStartPoints() -> int

      Get the number of specified cartesian start points.

   .. oe:method:: GetStartPoints

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStartPoints(double* argPoints) const

      .. oe:language:: python

         .. oe:api:: python

            GetStartPoints(argPoints: OEDoubleArray) -> bool

      Get the specified cartesian start points. Method expects an array of size
      3*NumPoints for the argument, where ``NumPoints`` can be obtained by calling
      :oe:meth:`GetNumStartPoints<OEShape::OECartesianStarts::GetNumStartPoints>`.

   .. oe:method:: SetStartPoints

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStartPoints(const double* Points, unsigned int NumPoints)

      .. oe:language:: python

         .. oe:api:: python

            SetStartPoints(argPoints: OEDoubleArray, argNumPoints: int) -> None

      Sets the cartesian starting points. Method expects an array of size
      3*NumPoints for the first argument.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEColorFFParameter, ColorFFParameter

.. _OEShape_OEColorFFParameter:

.. oe:class:: OEColorFFParameter

   .. oe:api::

      class OEColorFFParameter : public OESystem::OEMultiParameter<OEShape::OEColorForceField>

   The :ref:`OEColorFFParameter <OEShape_OEColorFFParameter>` represents parameter that has a value of type
   :ref:`OEColorForceField <OEShape_OEColorForceField>`.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OEMultiParameter <OESystem_OEMultiParameter>`:
    * :oe:meth:`AddLegalEntry<OESystem::OEMultiParameter::AddLegalEntry>` 
    * :oe:meth:`GetDefault<OESystem::OEMultiParameter::GetDefault>` and
      :oe:meth:`SetDefault<OESystem::OEMultiParameter::SetDefault>` 
    * :oe:meth:`GetSetting<OESystem::OEMultiParameter::GetSetting>`
    * :oe:meth:`GetValue<OESystem::OEMultiParameter::GetValue>` and
      :oe:meth:`SetValue<OESystem::OEMultiParameter::SetValue>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorFFParameter(const std::string& name, const bool load = true)
            OEColorFFParameter()
            OEColorFFParameter(const OEColorFFParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEColorFFParameter(name: str, load: bool = True) -> OEColorFFParameter
            OEColorFFParameter() -> OEColorFFParameter
            OEColorFFParameter(arg2: OEColorFFParameter) -> OEColorFFParameter

      Default and copy constructors.

      Constructs an :ref:`OEColorFFParameter <OEShape_OEColorFFParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColorFFParameter &operator=(const OEColorFFParameter &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEColorForceField, ColorForceField

.. _OEShape_OEColorForceField:

.. oe:class:: OEColorForceField

   .. oe:api::

      class OEColorForceField

   Defines chemical feature types and their interaction rules for color overlap calculations.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorForceField()
            OEColorForceField(const OEColorForceField& rhs)
            OEColorForceField(const OEColorForceFieldImpl* impl)

      .. oe:language:: python

         .. oe:api:: python

            OEColorForceField() -> OEColorForceField
            OEColorForceField(rhs: OEColorForceField) -> OEColorForceField
            OEColorForceField(impl: OEColorForceFieldImpl) -> OEColorForceField

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColorForceField &operator=(const OEColorForceField &rhs)

      Assignment operator.

   .. oe:method:: AddColorer

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddColorer(unsigned int type, const char* smarts)
            bool AddColorer(unsigned int type, const std::string& smarts)

      .. oe:language:: python

         .. oe:api:: python

            AddColorer(type: int, smarts: str) -> bool

   .. oe:method:: AddInteraction

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddInteraction(unsigned int type1, unsigned int type2,
                                const std::string& interaction_type,
                                float weight, float range)

      .. oe:language:: python

         .. oe:api:: python

            AddInteraction(type1: int, type2: int, interaction_type: str,
                           weight: float, range: float) -> bool

   .. oe:method:: AddType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int AddType(const char* name)
            unsigned int AddType(const std::string& name)

      .. oe:language:: python

         .. oe:api:: python

            AddType(name: str) -> int

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

   .. oe:method:: ClearInteractions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearInteractions()

      .. oe:language:: python

         .. oe:api:: python

            ClearInteractions() -> None

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

   .. oe:method:: GetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetType(std::string k) const

      .. oe:language:: python

         .. oe:api:: python

            GetType(k: str) -> int

   .. oe:method:: GetTypeName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetTypeName(unsigned int type) const

      .. oe:language:: python

         .. oe:api:: python

            GetTypeName(type: int) -> str

   .. oe:method:: GetTypes

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<unsigned int>* GetTypes() const

      .. oe:language:: python

         .. oe:api:: python

            GetTypes() -> Iterable[int]

   
   .. _OEShape_OEColorForceField_Init:

   .. oe:method:: Init

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(unsigned int cffType)
            bool Init(OEPlatform::oeistream& is, bool verbose = false)
            bool Init(const std::string& filename, bool verbose = false)

      .. oe:language:: python

         .. oe:api:: python

            Init(cffType: int) -> bool
            Init(ifs: oeistream, verbose: bool = False) -> bool
            Init(filename: str, verbose: bool = False) -> bool

   .. oe:method:: Ready

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Ready() const

      .. oe:language:: python

         .. oe:api:: python

            Ready() -> bool

   .. oe:method:: SetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTitle(const char* title)

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(title: str) -> bool

   .. oe:method:: Write

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Write(OEPlatform::oeostream& os)

      .. oe:language:: python

         .. oe:api:: python

            Write(os: oeostream) -> bool



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEColorFunc, ShapeFunc

.. _OEShape_OEColorFunc:

.. oe:class:: OEColorFunc

   .. oe:api::

      class OEColorFunc : public OEOverlapFuncBase

   The :ref:`OEColorFunc <OEShape_OEColorFunc>` is an abstract base class. This class defines
   an interface for color overlap calculation between a reference object and a fit molecule. 
   The :ref:`OEColorFunc <OEShape_OEColorFunc>` is a specialization of The :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
   for color only overlap.

   .. _figure_OEColorFunc_Hierarchy:

   .. figure:: shapetk/images/OEColorFunc.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>` 
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>` 
    * :oe:meth:`SetupFlex<OEShape::OEOverlapFuncBase::SetupFlex>`
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The :ref:`OEColorFunc <OEShape_OEColorFunc>` class defines the following public methods:
    * :oe:meth:`GetColorOptions<OEShape::OEColorFunc::GetColorOptions>`

   The following classes derive from this class:
    * :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>`
    * :ref:`OEExactColorFunc <OEShape_OEExactColorFunc>`
    * :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColorFunc & operator=(const OEColorFunc & argFunc)

      Assignment operator.

   .. oe:method:: GetColorOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEColorOptions& GetColorOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorOptions() -> OEColorOptions

      Returns a reference to the :ref:`OEColorOptions <OEShape_OEColorOptions>`
      instance as currently set for this :ref:`OEColorFunc <OEShape_OEColorFunc>`.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEColorOptions, ColorOptions

.. _OEShape_OEColorOptions:

.. oe:class:: OEColorOptions

   .. oe:api::

      class OEColorOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for :ref:`OEColorFunc <OEShape_OEColorFunc>`
   calculations.
   
   The :ref:`OEColorOptions <OEShape_OEColorOptions>` class defines the following public methods:
    * :oe:meth:`GetColorForceField<OEShape::OEColorOptions::GetColorForceField>` and
      :oe:meth:`SetColorForceField<OEShape::OEColorOptions::SetColorForceField>`
    * :oe:meth:`GetMultiplier<OEShape::OEColorOptions::GetMultiplier>` and
      :oe:meth:`SetMultiplier<OEShape::OEColorOptions::SetMultiplier>`
    * :oe:meth:`GetScoreType<OEShape::OEColorOptions::GetScoreType>` and
      :oe:meth:`SetScoreType<OEShape::OEColorOptions::SetScoreType>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorOptions(const bool loadColorFF = true)
            OEColorOptions(const OEColorOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEColorOptions(loadColorFF: bool = True) -> OEColorOptions
            OEColorOptions(argOpts: OEColorOptions) -> OEColorOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColorOptions &operator=(const OEColorOptions &)

      Assignment operator.

   .. oe:method:: GetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEColorForceField* GetColorForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceField() -> OEColorForceField

      See :oe:meth:`SetColorForceField<OEShape::OEColorOptions::SetColorForceField>` method.

   .. oe:method:: GetMultiplier

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMultiplier() const

      .. oe:language:: python

         .. oe:api:: python

            GetMultiplier() -> float

      See :oe:meth:`SetMultiplier<OEShape::OEColorOptions::SetMultiplier>` method.

   .. oe:method:: GetScoreType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetScoreType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreType() -> int

      See :oe:meth:`SetScoreType<OEShape::OEColorOptions::SetScoreType>` method.

   .. oe:method:: SetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorForceField(unsigned int type)
            bool SetColorForceField(OEPlatform::oeistream& is)
            bool SetColorForceField(const std::string& filename)
            bool SetColorForceField(const OEColorForceField& cff)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceField(value: int) -> bool
            SetColorForceField(value: oeistream) -> bool
            SetColorForceField(value: str) -> bool
            SetColorForceField(value: OEColorForceField) -> bool

      Sets the color force field to be used. By default the ImplicitMillsDean
      color force field is used.

   .. oe:method:: SetMultiplier

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMultiplier(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMultiplier(value: float) -> bool

      Sets the **multiplier** to the color score. THe multiplier only effects 
      the *color score* and has no effect on the *color tanimoto*.
      **Default: 1.0**

   .. oe:method:: SetScoreType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetScoreType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreType(value: int) -> bool

      Sets the **score type** to be reported by this function. Possible 
      values are defined in the :oe:constns:`OEShape::OEScoreType` namespace.
      **Default:** :oe:const:`OEShape::OEScoreType::Overlap`



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEColorOverlap, ColorOverlap

.. _OEShape_OEColorOverlap:

.. oe:class:: OEColorOverlap

   .. oe:api::

      class OEColorOverlap

   .. note::

      This deprecated class will not be developed further. It is being replaced by
      derivatives of :ref:`OEColorFunc <OEShape_OEColorFunc>` which provides
      more control and greater expandability.

   Calculates chemical feature color overlap between a reference and a fit molecule.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorOverlap()
            OEColorOverlap(const OEColorOverlap& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEColorOverlap() -> OEColorOverlap
            OEColorOverlap(rhs: OEColorOverlap) -> OEColorOverlap

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColorOverlap &operator=(const OEColorOverlap &rhs)

      Assignment operator.

   .. oe:method:: ColorScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ColorScore(OEColorResults& res)
            bool ColorScore(const OEChem::OEMolBase& fitmol,
                            OEColorResults& res)

      .. oe:language:: python

         .. oe:api:: python

            ColorScore(res: OEColorResults) -> bool
            ColorScore(fitmol: Union[OEGraphMol,OEMol,OEQMol],
                       res: OEColorResults) -> bool

   .. oe:method:: GetAllColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAllColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetAllColor() -> bool

   .. oe:method:: GetSelfColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSelfColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetSelfColor() -> float

   .. oe:method:: SetAllColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAllColor(bool state)

      .. oe:language:: python

         .. oe:api:: python

            SetAllColor(arg2: bool) -> None

   .. oe:method:: SetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorForceField(unsigned int cffType)
            bool SetColorForceField(OEPlatform::oeistream& is)
            bool SetColorForceField(const std::string& filename)
            bool SetColorForceField(const OEColorForceField& cff)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceField(cffType: int) -> bool
            SetColorForceField(ifs: oeistream) -> bool
            SetColorForceField(filename: str) -> bool
            SetColorForceField(cff: OEColorForceField) -> bool

   .. oe:method:: SetFitMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFitMol(const OEChem::OEMolBase& fitmol)

      .. oe:language:: python

         .. oe:api:: python

            SetFitMol(fitmol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   .. oe:method:: SetRefMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRefMol(const OEChem::OEMolBase& refmol)

      .. oe:language:: python

         .. oe:api:: python

            SetRefMol(refmol: Union[OEGraphMol,OEMol,OEQMol]) -> bool



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEColorResults, ColorResults

.. _OEShape_OEColorResults:

.. oe:class:: OEColorResults

   .. oe:api::

      struct OEColorResults

   .. note::

      This deprecated class will not be developed further. It is being replaced by
      :ref:`OEOverlapResults <OEShape_OEOverlapResults>` which provides
      more control and greater expandability.

   Stores the result of a color overlap calculation.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorResults()

      .. oe:language:: python

         .. oe:api:: python

            OEColorResults() -> OEColorResults

      Default and copy constructors.

   .. oe:method:: GetFitTversky

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetFitTversky() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitTversky() -> float

   .. oe:method:: GetRefTversky

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetRefTversky() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefTversky() -> float

   .. oe:method:: GetTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimoto() -> float

   .. oe:method:: GetTversky

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTversky(float alpha, float beta) const

      .. oe:language:: python

         .. oe:api:: python

            GetTversky(alpha: float, beta: float) -> float



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEColorTanimotoCutoff, ColorTanimotoCutoff

.. _OEShape_OEColorTanimotoCutoff:

.. oe:class:: OEColorTanimotoCutoff

   .. oe:api::

      class OEColorTanimotoCutoff : public OEOverlayScoreCutoff

   The :ref:`OEColorTanimotoCutoff <OEShape_OEColorTanimotoCutoff>` defines cutoff based on the
   color tanimoto.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:
    * :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`

   The following methods are publicly inherited from :ref:`OEOverlayScoreCutoff <OEShape_OEOverlayScoreCutoff>`:
    * :oe:meth:`operator()<OEShape::OEOverlayScoreCutoff::operator()>`  
    * :oe:meth:`CreateCopy<OEShape::OEOverlayScoreCutoff::CreateCopy>`
  

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorTanimotoCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            OEColorTanimotoCutoff(argCutoff: float) -> OEColorTanimotoCutoff

      Default and copy constructors. The argument expects the desired cutoff.  



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEExactColorFunc, ExactShapeFunc

.. _OEShape_OEExactColorFunc:

.. oe:class:: OEExactColorFunc

   .. oe:api::

      class OEExactColorFunc : public OEShapeFunc

   The :ref:`OEExactColorFunc <OEShape_OEExactColorFunc>` class defines shape overlap between a reference
   object and a fit molecule, using the *Exact* method.

   .. _figure_OEExactColorFunc_Hierarchy:

   .. figure:: shapetk/images/OEExactColorFunc.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>` 
    * :oe:meth:`SetupFlex<OEShape::OEOverlapFuncBase::SetupFlex>`
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The following methods are publicly inherited from :ref:`OEColorFunc <OEShape_OEColorFunc>`:
    * :oe:meth:`GetColorOptions<OEShape::OEColorFunc::GetColorOptions>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExactColorFunc(const OEColorOptions& argOpts = OEColorOptions())
            OEExactColorFunc(const OEExactColorFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEExactColorFunc(argOpts: OEColorOptions = OEColorOptions()) -> OEExactColorFunc
            OEExactColorFunc(arg2: OEExactColorFunc) -> OEExactColorFunc

      Default and copy constructors.

      Constructs an :ref:`OEExactColorFunc <OEShape_OEExactColorFunc>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEExactColorFunc &operator=(const OEExactColorFunc &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEExactShapeFunc, ExactShapeFunc

.. _OEShape_OEExactShapeFunc:

.. oe:class:: OEExactShapeFunc

   .. oe:api::

      class OEExactShapeFunc : public OEShapeFunc

   The :ref:`OEExactShapeFunc <OEShape_OEExactShapeFunc>` class defines shape overlap between a reference
   object and a fit molecule, using the *Exact* method.

   .. _figure_OEExactShapeFunc_Hierarchy:

   .. figure:: shapetk/images/OEExactShapeFunc.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>` 
    * :oe:meth:`SetupFlex<OEShape::OEOverlapFuncBase::SetupFlex>`
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The following methods are publicly inherited from :ref:`OEShapeFunc <OEShape_OEShapeFunc>`:
    * :oe:meth:`GetShapeOptions<OEShape::OEShapeFunc::GetShapeOptions>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExactShapeFunc(const OEShapeOptions& argOptions = OEShapeOptions())
            OEExactShapeFunc(const OEExactShapeFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEExactShapeFunc(argOptions: OEShapeOptions = OEShapeOptions()) -> OEExactShapeFunc
            OEExactShapeFunc(arg2: OEExactShapeFunc) -> OEExactShapeFunc

      Default and copy constructors.

      Constructs an :ref:`OEExactShapeFunc <OEShape_OEExactShapeFunc>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEExactShapeFunc &operator=(const OEExactShapeFunc &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEFitColorTverskyCutoff, FitColorTverskyCutoff

.. _OEShape_OEFitColorTverskyCutoff:

.. oe:class:: OEFitColorTverskyCutoff

   .. oe:api::

      class OEFitColorTverskyCutoff : public OEOverlayScoreCutoff

   The :ref:`OEFitColorTverskyCutoff <OEShape_OEFitColorTverskyCutoff>` defines cutoff based on the
   fit molecule color tversky.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:
    * :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`

   The following methods are publicly inherited from :ref:`OEOverlayScoreCutoff <OEShape_OEOverlayScoreCutoff>`:
    * :oe:meth:`operator()<OEShape::OEOverlayScoreCutoff::operator()>`  
    * :oe:meth:`CreateCopy<OEShape::OEOverlayScoreCutoff::CreateCopy>`
  

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFitColorTverskyCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            OEFitColorTverskyCutoff(argCutoff: float) -> OEFitColorTverskyCutoff

      Default and copy constructors. The argument expects the desired cutoff.  



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEFitTverskyComboCutoff, FitTverskyComboCutoff

.. _OEShape_OEFitTverskyComboCutoff:

.. oe:class:: OEFitTverskyComboCutoff

   .. oe:api::

      class OEFitTverskyComboCutoff : public OEOverlayScoreCutoff

   The :ref:`OEFitTverskyComboCutoff <OEShape_OEFitTverskyComboCutoff>` defines cutoff based on the
   fit molecule combined shape and color tversky.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:
    * :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`

   The following methods are publicly inherited from :ref:`OEOverlayScoreCutoff <OEShape_OEOverlayScoreCutoff>`:
    * :oe:meth:`operator()<OEShape::OEOverlayScoreCutoff::operator()>`  
    * :oe:meth:`CreateCopy<OEShape::OEOverlayScoreCutoff::CreateCopy>`
  

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFitTverskyComboCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            OEFitTverskyComboCutoff(argCutoff: float) -> OEFitTverskyComboCutoff

      Default and copy constructors. The argument expects the desired cutoff.  



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEFitTverskyCutoff, FitTverskyCutoff

.. _OEShape_OEFitTverskyCutoff:

.. oe:class:: OEFitTverskyCutoff

   .. oe:api::

      class OEFitTverskyCutoff : public OEOverlayScoreCutoff

   The :ref:`OEFitTverskyCutoff <OEShape_OEFitTverskyCutoff>` defines cutoff based on the
   fit molecule shape tversky.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:
    * :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`

   The following methods are publicly inherited from :ref:`OEOverlayScoreCutoff <OEShape_OEOverlayScoreCutoff>`:
    * :oe:meth:`operator()<OEShape::OEOverlayScoreCutoff::operator()>`  
    * :oe:meth:`CreateCopy<OEShape::OEOverlayScoreCutoff::CreateCopy>`
  

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFitTverskyCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            OEFitTverskyCutoff(argCutoff: float) -> OEFitTverskyCutoff

      Default and copy constructors. The argument expects the desired cutoff.  



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEFlexiOverlapFunc, FlexiOverlapFunc

.. _OEShape_OEFlexiOverlapFunc:

.. oe:class:: OEFlexiOverlapFunc

   .. oe:api::

      class OEFlexiOverlapFunc : public OEMolPotential::OEMolFunc1

   The :ref:`OEFlexiOverlapFunc <OEShape_OEFlexiOverlapFunc>` class defines
   an interface for static overlap calculation between a reference and a fit molecule. 
   The :ref:`OEFlexiOverlapFunc <OEShape_OEFlexiOverlapFunc>` extends the :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>`
   class to allow setting up a reference molecule 
   and the underlying functions defining interactions based on shape and color overlaps along with 
   intra-molecular force field of the fit molecule.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The :ref:`OEFlexiOverlapFunc <OEShape_OEFlexiOverlapFunc>` class defines the following public methods:
    * :oe:meth:`Overlap<OEShape::OEFlexiOverlapFunc::Overlap>` 
    * :oe:meth:`SetupRef<OEShape::OEFlexiOverlapFunc::SetupRef>`
    * :oe:meth:`UpdateColorCoords<OEShape::OEFlexiOverlapFunc::UpdateColorCoords>`

.. _OEShape_OEFlexiOverlapFunc_Overlap:

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFlexiOverlapFunc & operator=(const OEFlexiOverlapFunc & func)

      Assignment operator.

   .. oe:method:: Overlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Overlap(const double*, OEFlexiOverlapResults&)
            bool Overlap(const OEChem::OEMolBase& fitMol,
                         OEFlexiOverlapResults& results)

      .. oe:language:: python

         .. oe:api:: python

            Overlap(coords: OEDoubleArray, results: OEFlexiOverlapResults) -> bool
            Overlap(fitMol: Union[OEGraphMol,OEMol,OEQMol],
                    results: OEFlexiOverlapResults) -> bool

      These methods calculate the staitc overlap between the reference and
      the fit molecule using shape, color, and force field.  The reference object must be set using the
      :oe:meth:`SetupRef<OEShape::OEFlexiOverlapFunc::SetupRef>` method. The
      first overload assumes that the fit molecule has been set using the
      :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` method and uses
      the specified coordinates for the fit molecule. The second overlap
      takes the specified fit molecule and its current coordinates.

.. _OEShape_OEFlexiOverlapFunc_SetupRef:

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEChem::OEMolBase&)
            bool SetupRef(const OEShape::OEShapeQueryBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(refMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            SetupRef(refSQ: OEShapeQueryBase) -> bool

      This method defines the interface for setting up the reference system for the
      :ref:`OEFlexiOverlapFunc <OEShape_OEFlexiOverlapFunc>` instance with a 
      molecule or a shape query.

.. _OEShape_OEFlexiOverlapFunc_UpdateColorCoords:

   .. oe:method:: UpdateColorCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool UpdateColorCoords(const double* coords,
                                   std::vector<double>& updatedCoord)

      .. oe:language:: python

         .. oe:api:: python

            UpdateColorCoords(coords: OEDoubleArray,
                              updatedCoord: OEDoubleVector) -> bool

      This method takes the coordinate of fit molecule and updates the coordinate of color atoms based on the
      modified coordinate of their parent atoms. The fit molecule must be set using the
      :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` method which assigns color atoms to the passed moleucle.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEFlexiOverlapOptions, FlexiOverlapOptions

.. _OEShape_OEFlexiOverlapOptions:

.. oe:class:: OEFlexiOverlapOptions

   .. oe:api::

      class OEFlexiOverlapOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for
   :ref:`OEFlexiOverlapFunc <OEShape_OEFlexiOverlapFunc>`.

   The :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` class defines the following public methods:
    * :oe:meth:`Validate<OEShape::OEFlexiOverlapOptions::Validate>`
    * :oe:meth:`GetShapeFuncType<OEShape::OEFlexiOverlapOptions::GetShapeFuncType>` and
      :oe:meth:`SetShapeFuncType<OEShape::OEFlexiOverlapOptions::SetShapeFuncType>`
    * :oe:meth:`GetColorFuncType<OEShape::OEFlexiOverlapOptions::GetColorFuncType>` and
      :oe:meth:`SetColorFuncType<OEShape::OEFlexiOverlapOptions::SetColorFuncType>`
    * :oe:meth:`GetForceField<OEShape::OEFlexiOverlapOptions::GetForceField>` and
      :oe:meth:`SetForceField<OEShape::OEFlexiOverlapOptions::SetForceField>`
    * :oe:meth:`GetHarmonic<OEShape::OEFlexiOverlapOptions::GetHarmonic>` and
      :oe:meth:`SetHarmonic<OEShape::OEFlexiOverlapOptions::SetHarmonic>`
    * :oe:meth:`GetShapeOptions<OEShape::OEFlexiOverlapOptions::GetShapeOptions>` and
      :oe:meth:`SetShapeOptions<OEShape::OEFlexiOverlapOptions::SetShapeOptions>`
    * :oe:meth:`GetColorOptions<OEShape::OEFlexiOverlapOptions::GetColorOptions>` and
      :oe:meth:`SetColorOptions<OEShape::OEFlexiOverlapOptions::SetColorOptions>`
    * :oe:meth:`GetOverlapFunc<OEShape::OEFlexiOverlapOptions::GetOverlapFunc>` and
      :oe:meth:`SetOverlapFunc<OEShape::OEFlexiOverlapOptions::SetOverlapFunc>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFlexiOverlapOptions()
            OEFlexiOverlapOptions(const OEFlexiOverlapOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEFlexiOverlapOptions() -> OEFlexiOverlapOptions
            OEFlexiOverlapOptions(arg2: OEFlexiOverlapOptions) -> OEFlexiOverlapOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFlexiOverlapOptions &operator=(const OEFlexiOverlapOptions&)

.. _OEShape_OEFlexiOverlapOptions_Validate:

      Assignment operator.

   .. oe:method:: Validate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Validate() const

      .. oe:language:: python

         .. oe:api:: python

            Validate() -> bool

      Returns **True** if the provided options corresponding to :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>`
      are valid.

.. _OEShape_OEFlexiOverlapOptions_GetShapeFuncType:

   .. oe:method:: GetShapeFuncType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetShapeFuncType() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeFuncType() -> int

      Gets the current type of :ref:`OEShapeFunc <OEShape_OEShapeFunc>` used for shape overlap calculations.
      See also :oe:meth:`SetShapeFuncType<OEShape::OEFlexiOverlapOptions::SetShapeFuncType>` method. 

.. _OEShape_OEFlexiOverlapOptions_GetColorFuncType:

   .. oe:method:: GetColorFuncType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetColorFuncType() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorFuncType() -> int

      Gets the current type of  :ref:`OEColorFunc <OEShape_OEColorFunc>` used for color overlap calculations.
      See also :oe:meth:`SetColorFuncType<OEShape::OEFlexiOverlapOptions::SetColorFuncType>` method. 

.. _OEShape_OEFlexiOverlapOptions_GetForceField:

   .. oe:method:: GetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMolPotential::OEForceField* GetForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEForceField

      Gets the current type of ligand force field used.
      See also :oe:meth:`SetForceField<OEShape::OEFlexiOverlapOptions::SetForceField>` method. 

.. _OEShape_OEFlexiOverlapOptions_GetHarmonic:

   .. oe:method:: GetHarmonic

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetHarmonic() const

      .. oe:language:: python

         .. oe:api:: python

            GetHarmonic() -> bool

      Returns True if the harmonic constraints are added to the force field for the flexible overlap 
      optimizations.    

.. _OEShape_OEFlexiOverlapOptions_GetShapeOptions:

   .. oe:method:: GetShapeOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeOptions& GetShapeOptions()
            const OEShapeOptions& GetShapeOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeOptions() -> OEShapeOptions

      Returns a reference to the :ref:`OEShapeOptions <OEShape_OEShapeOptions>` instance as currently set.
      These options are used in flexible overlap optimization of conformers.
      See also :oe:meth:`SetShapeOptions<OEShape::OEFlexiOverlapOptions::SetShapeOptions>` method.

.. _OEShape_OEFlexiOverlapOptions_GetColorOptions:

   .. oe:method:: GetColorOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorOptions& GetColorOptions()
            const OEColorOptions& GetColorOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorOptions() -> OEColorOptions

      Returns a reference to the :ref:`OEColorOptions <OEShape_OEColorOptions>` instance as currently set.
      These options are used in flexible overlap optimization of conformers.
      See also :oe:meth:`SetColorOptions<OEShape::OEFlexiOverlapOptions::SetColorOptions>` method.

.. _OEShape_OEFlexiOverlapOptions_GetOverlapFuncs:

   .. oe:method:: GetOverlapFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEOverlapFuncBase& GetOverlapFunc() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlapFunc() -> OEOverlapFuncBase

      Returns a reference to the :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
      instance as currently set. This defines the shape/color interactions to be optimized
      for overlay.

.. _OEShape_OEFlexiOverlapOptions_SetShapeFuncType:

   .. oe:method:: SetShapeFuncType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetShapeFuncType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeFuncType(value: int) -> bool

      Sets the type of `OEShape::OEShapeFunc` to be used for shape overlap calculations. 
      The default is
      :oe:const:`OEShape::OEShapeType::Grid`. Alternatives are defined in the
      :oe:constns:`OEShape::OEShapeType` namespace.  

.. _OEShape_OEFlexiOverlapOptions_SetColorFuncType:

   .. oe:method:: SetColorFuncType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorFuncType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetColorFuncType(value: int) -> bool

      Sets the type of `OEShape::OEColorFunc` to be used for color overlap calculations. 
      The default is
      :oe:const:`OEShape::OEColorType::Exact`. Alternatives are defined in the
      :oe:constns:`OEShape::OEColorType` namespace.  

.. _OEShape_OEFlexiOverlapOptions_SetForceField:

   .. oe:method:: SetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceField(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: int) -> bool
            SetForceField(value: str) -> bool
            SetForceField(value: oeistream) -> bool
            SetForceField(value: OEForceField) -> bool

      Sets the type of ligand intra-molecular force field to be used for flxible optimizations. 
      The default is
      :oe:const:`OEFF::OELigandFFType::SAGE`. Alternatives are defined in the
      :oe:constns:`OEFF::OELigandFFType` namespace.

.. _OEShape_OEFlexiOverlapOptions_SetHarmonic:

   .. oe:method:: SetHarmonic

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetHarmonic(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetHarmonic(value: bool) -> bool

      This flag defines if the harmonic constraints should be added to the force field for the flexible overlap 
      optimizations. Default `False`.

.. _OEShape_OEFlexiOverlapOptions_SetShapeOptions:

   .. oe:method:: SetShapeOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetShapeOptions(const OEShapeOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeOptions(opts: OEShapeOptions) -> None

      Sets the options related to :ref:`OEShapeFunc <OEShape_OEShapeFunc>` calculations used in flexible overlap optimization
      by passing in :ref:`OEShapeOptions <OEShape_OEShapeOptions>` instance.

.. _OEShape_OEFlexiOverlapOptions_SetColorOptions:

   .. oe:method:: SetColorOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColorOptions(const OEColorOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetColorOptions(opts: OEColorOptions) -> None

      Sets the options related to :ref:`OEColorFunc <OEShape_OEColorFunc>` calculations used in flexible overlap optimization
      by passing in :ref:`OEColorOptions <OEShape_OEColorOptions>` instance.

.. _OEShape_OEFlexiOverlapOptions_SetOverlapFunc:

   .. oe:method:: SetOverlapFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOverlapFunc(const OEOverlapFuncBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetOverlapFunc(func: OEOverlapFuncBase) -> bool

      Sets the overlap function by passing in an :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
      instance. This defines the shape/color interactions to be optimized
      for overlay.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEFlexiOverlapResults, FlexiOverlapResults

.. _OEShape_OEFlexiOverlapResults:

.. oe:class:: OEFlexiOverlapResults

   .. oe:api::

      class OEFlexiOverlapResults : public OEShape::OEOverlapResults

   This class extends the :ref:`OEOverlapResults <OEShape_OEOverlapResults>` to represent the results of
   :ref:`OEFlexiOverlapFunc <OEShape_OEFlexiOverlapFunc>` calculation.

   .. seealso::

      * :ref:`OEOverlapResults <OEShape_OEOverlapResults>` class

   The following methods are publicly inherited from :ref:`OEOverlapResults <OEShape_OEOverlapResults>`:
    * :oe:meth:`GetColorScore<OEShape::OEOverlapResults::GetColorScore>`
    * :oe:meth:`GetColorTanimoto<OEShape::OEOverlapResults::GetColorTanimoto>` 
    * :oe:meth:`GetColorTversky<OEShape::OEOverlapResults::GetColorTversky>`
    * :oe:meth:`GetFitColorTversky<OEShape::OEOverlapResults::GetFitColorTversky>` 
    * :oe:meth:`GetFitSelfColor<OEShape::OEOverlapResults::GetFitSelfColor>`
    * :oe:meth:`GetFitSelfOverlap<OEShape::OEOverlapResults::GetFitSelfOverlap>`
    * :oe:meth:`GetFitTversky<OEShape::OEOverlapResults::GetFitTversky>` 
    * :oe:meth:`GetFitTverskyCombo<OEShape::OEOverlapResults::GetFitTverskyCombo>`
    * :oe:meth:`GetOverlap<OEShape::OEOverlapResults::GetOverlap>`
    * :oe:meth:`GetRefColorTversky<OEShape::OEOverlapResults::GetRefColorTversky>` 
    * :oe:meth:`GetRefSelfColor<OEShape::OEOverlapResults::GetRefSelfColor>`
    * :oe:meth:`GetRefSelfOverlap<OEShape::OEOverlapResults::GetRefSelfOverlap>`
    * :oe:meth:`GetRefTversky<OEShape::OEOverlapResults::GetRefTversky>` 
    * :oe:meth:`GetRefTverskyCombo<OEShape::OEOverlapResults::GetRefTverskyCombo>`
    * :oe:meth:`GetTanimoto<OEShape::OEOverlapResults::GetTanimoto>`
    * :oe:meth:`GetTanimotoCombo<OEShape::OEOverlapResults::GetTanimotoCombo>` 
    * :oe:meth:`GetTversky<OEShape::OEOverlapResults::GetTversky>`

   The :ref:`OEFlexiOverlapResults <OEShape_OEFlexiOverlapResults>` class defines the following public method:
    * :oe:meth:`GetInternalEnergy<OEShape::OEFlexiOverlapResults::GetInternalEnergy>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFlexiOverlapResults()
            OEFlexiOverlapResults(const OEFlexiOverlapResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEFlexiOverlapResults() -> OEFlexiOverlapResults
            OEFlexiOverlapResults(rhs: OEFlexiOverlapResults) -> OEFlexiOverlapResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFlexiOverlapResults &operator=(const OEFlexiOverlapResults&)

      Assignment operator.

   .. oe:method:: GetInternalEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetInternalEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetInternalEnergy() -> float

      Returns the computed **internal energy** of the conformer.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEFlexiOverlay, FlexiOverlay

.. _OEShape_OEFlexiOverlay:

.. oe:class:: OEFlexiOverlay

   .. oe:api::

      class OEFlexiOverlay
   
   The :ref:`OEFlexiOverlay <OEShape_OEFlexiOverlay>` class provides an interface for flexible overlay optimization
   between the reference molecule and a fit molecule conformers.

   The :ref:`OEFlexiOverlay <OEShape_OEFlexiOverlay>` class defines the following public methods:
    * :oe:meth:`SetupRef<OEShape::OEFlexiOverlay::SetupRef>`
    * :oe:meth:`Overlay<OEShape::OEFlexiOverlay::Overlay>`
    * :oe:meth:`SortedOverlay<OEShape::OEFlexiOverlay::SortedOverlay>`
    * :oe:meth:`BestOverlay<OEShape::OEFlexiOverlay::BestOverlay>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFlexiOverlay(const OEFlexiOverlayOptions& options = OEFlexiOverlayOptions())
            OEFlexiOverlay(const OEFlexiOverlay& func)

      .. oe:language:: python

         .. oe:api:: python

            OEFlexiOverlay(options: OEFlexiOverlayOptions = OEFlexiOverlayOptions()) -> OEFlexiOverlay
            OEFlexiOverlay(func: OEFlexiOverlay) -> OEFlexiOverlay

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFlexiOverlay &operator=(const OEFlexiOverlay&)

.. _OEShape_OEFlexiOverlay_SetupRef:

      Assignment operator.

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEChem::OEMolBase&)
            bool SetupRef(const OEShape::OEShapeQueryBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(refmol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            SetupRef(refSQ: OEShapeQueryBase) -> bool

      This method defines the interface for setting up the reference system for the 
      :ref:`OEFlexiOverlay <OEShape_OEFlexiOverlay>` using a molecule or a shape query 
      for flexible overlay optimization process. 

.. _OEShape_OEFlexiOverlay_Overlay:

   .. oe:method:: Overlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEFlexiOverlapResults>* Overlay(OEChem::OEMCMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            Overlay(fitmol: OEMol) -> Iterable[OEFlexiOverlapResults]

      This method optimizes the shape and chemical similarity between the fit molecule conformers
      and a reference molecule, along with intra-molecular forcefield energies 
      of the fit molecule. The reference molecule must be set using 
      :oe:meth:`SetupRef<OEShape::OEFlexiOverlay::SetupRef>` method.

.. _OEShape_OEFlexiOverlay_SortedOverlay:

   .. oe:method:: SortedOverlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEFlexiOverlapResults>* SortedOverlay(OEChem::OEMCMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            SortedOverlay(fitmol: OEMol) -> Iterable[OEFlexiOverlapResults]

      This method optimizes the shape and chemical similarity between the fit molecule conformers
      and a reference molecule, along with intra-molecular forcefield energies 
      of the fit molecule. The reference molecule must be set using 
      :oe:meth:`SetupRef<OEShape::OEFlexiOverlay::SetupRef>` method. This method returns an 
      iterator over :ref:`OEFlexiOverlapResults <OEShape_OEFlexiOverlapResults>` which are sorted based on the
      TanimotoCombo similarity of that conformer and the reference molecule. 

.. _OEShape_OEFlexiOverlay_BestOverlay:

   .. oe:method:: BestOverlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool BestOverlay(OEFlexiOverlapResults&, OEChem::OEMCMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            BestOverlay(result: OEFlexiOverlapResults, fitMol: OEMol) -> bool

      This method optimizes the shape and chemical similarity between the fit molecule conformers
      and a reference molecule, along with intra-molecular forcefield energies 
      of the fit molecule. This method returns the best result only 
      which is the conformer with the highest TanimotoCombo similarity to the reference molecule.
      The reference molecule must be set using 
      :oe:meth:`SetupRef<OEShape::OEFlexiOverlay::SetupRef>` method.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEFlexiOverlayOptions, FlexiOverlayOptions

.. _OEShape_OEFlexiOverlayOptions:

.. oe:class:: OEFlexiOverlayOptions

   .. oe:api::

      class OEFlexiOverlayOptions : public OESystem::OEOptions

   This class provides an interface to setup options required to perform
   **flexible fitting** between the fit molecule conformers and a reference molecule 
   using :ref:`OEFlexiOverlay <OEShape_OEFlexiOverlay>`.

   .. seealso::

      * :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` class

   The :ref:`OEFlexiOverlayOptions <OEShape_OEFlexiOverlayOptions>` class defines the following public methods:
    * :oe:meth:`GetMaxOptSteps<OEShape::OEFlexiOverlayOptions::GetMaxOptSteps>` and
      :oe:meth:`SetMaxOptSteps<OEShape::OEFlexiOverlayOptions::SetMaxOptSteps>`
    * :oe:meth:`GetRigidOverlay<OEShape::OEFlexiOverlayOptions::GetRigidOverlay>` and
      :oe:meth:`SetRigidOverlay<OEShape::OEFlexiOverlayOptions::SetRigidOverlay>`
    * :oe:meth:`GetFlexiOverlapOptions<OEShape::OEFlexiOverlayOptions::GetFlexiOverlapOptions>` and
      :oe:meth:`SetFlexiOverlapOptions<OEShape::OEFlexiOverlayOptions::SetFlexiOverlapOptions>`
    * :oe:meth:`GetRigidOverlayOptions<OEShape::OEFlexiOverlayOptions::GetRigidOverlayOptions>` and
      :oe:meth:`SetRigidOverlayOptions<OEShape::OEFlexiOverlayOptions::SetRigidOverlayOptions>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFlexiOverlayOptions()
            OEFlexiOverlayOptions(const OEFlexiOverlayOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEFlexiOverlayOptions() -> OEFlexiOverlayOptions
            OEFlexiOverlayOptions(arg2: OEFlexiOverlayOptions) -> OEFlexiOverlayOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFlexiOverlayOptions &operator=(const OEFlexiOverlayOptions&)

.. _OEShape_OEFlexiOverlayOptions_GetMaxOptSteps:

      Assignment operator.

   .. oe:method:: GetMaxOptSteps

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxOptSteps() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxOptSteps() -> int

      See :oe:meth:`SetMaxOptSteps<OEShape::OEFlexiOverlayOptions::SetMaxOptSteps>` method.

.. _OEShape_OEFlexiOverlayOptions_GetRigidOverlay:

   .. oe:method:: GetRigidOverlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRigidOverlay() const

      .. oe:language:: python

         .. oe:api:: python

            GetRigidOverlay() -> bool

      See :oe:meth:`SetRigidOverlay<OEShape::OEFlexiOverlayOptions::SetRigidOverlay>` method.

.. _OEShape_OEFlexiOverlayOptions_GetFlexiOverlapOptions:

   .. oe:method:: GetFlexiOverlapOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFlexiOverlapOptions& GetFlexiOverlapOptions()
            const OEFlexiOverlapOptions& GetFlexiOverlapOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlexiOverlapOptions() -> OEFlexiOverlapOptions

      Returns a reference to the :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` instance as currently set.
      These are options related to flexible overlap optimization using shape, color, and force field.
      See also :oe:meth:`SetFlexiOverlapOptions<OEShape::OEFlexiOverlayOptions::SetFlexiOverlapOptions>` method.

.. _OEShape_OEFlexiOverlayOptions_GetRigidOverlayOptions:

   .. oe:method:: GetRigidOverlayOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOverlayOptions& GetRigidOverlayOptions()
            const OEOverlayOptions& GetRigidOverlayOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetRigidOverlayOptions() -> OEOverlayOptions

      Returns a reference to the :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>` instance as currently set.
      These are options related to rigid overlay optimization using shape and color.
      See also :oe:meth:`SetRigidOverlayOptions<OEShape::OEFlexiOverlayOptions::SetRigidOverlayOptions>` method.

.. _OEShape_OEFlexiOverlayOptions_SetMaxOptSteps:

   .. oe:method:: SetMaxOptSteps

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxOptSteps(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxOptSteps(value: int) -> bool

      Sets the maximum number of optimization iteration steps in flexible overlay optimization.
      Default: `2000` steps.

.. _OEShape_OEFlexiOverlayOptions_SetRigidOverlay:

   .. oe:method:: SetRigidOverlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRigidOverlay(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRigidOverlay(value: bool) -> bool

      This control flag determines whether an initial rigid overlay optimization between 
      the fit molecule conformers and the reference system should be performed prior to 
      flexible optimization.
      Default: `True`.

.. _OEShape_OEFlexiOverlayOptions_SetFlexiOverlapOptions:

   .. oe:method:: SetFlexiOverlapOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetFlexiOverlapOptions(const OEFlexiOverlapOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetFlexiOverlapOptions(opts: OEFlexiOverlapOptions) -> None

      Sets the options related to flexible overlap calculations by passing in :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` instance.

.. _OEShape_OEFlexiOverlayOptions_SetRigidOverlayOptions:

   .. oe:method:: SetRigidOverlayOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRigidOverlayOptions(const OEOverlayOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetRigidOverlayOptions(opts: OEOverlayOptions) -> None

      Sets the options related to overlay optimization using shape and color by passing in :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` instance.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEGridColorFunc, GridColorFunc

.. _OEShape_OEGridColorFunc:

.. oe:class:: OEGridColorFunc

   .. oe:api::

      class OEGridColorFunc : public OEShapeFunc

   The :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>` class defines color overlap between a reference
   object and a fit molecule, using the *Grid* method.

   .. _figure_OEGridColorFunc_Hierarchy:

   .. figure:: shapetk/images/OEGridColorFunc.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`  
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>` 
    * :oe:meth:`SetupFlex<OEShape::OEOverlapFuncBase::SetupFlex>`
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The following methods are publicly inherited from :ref:`OEColorFunc <OEShape_OEColorFunc>`:
    * :oe:meth:`GetColorOptions<OEShape::OEColorFunc::GetColorOptions>`

   The :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>` class defines the following public methods:
    * :oe:meth:`GetGridOptions<OEShape::OEGridColorFunc::GetGridOptions>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEGridColorFunc(const OEColorOptions& argOptions = OEColorOptions())
            OEGridColorFunc(const OEShapeGridOptions&)
            OEGridColorFunc(const OEColorOptions& argColor,
                            const OEShapeGridOptions& argGrid)
            OEGridColorFunc(const OEGridColorFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEGridColorFunc(argOptions: OEColorOptions = OEColorOptions()) -> OEGridColorFunc
            OEGridColorFunc(argOptions: OEShapeGridOptions) -> OEGridColorFunc
            OEGridColorFunc(argColor: OEColorOptions,
                            argGrid: OEShapeGridOptions) -> OEGridColorFunc
            OEGridColorFunc(argFunc: OEGridColorFunc) -> OEGridColorFunc

      Default and copy constructors.

      Constructs an :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEGridColorFunc &operator=(const OEGridColorFunc &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetGridOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEShapeGridOptions& GetGridOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridOptions() -> OEShapeGridOptions

      Returns a reference to the :ref:`OEShapeGridOptions <OEShape_OEShapeGridOptions>`
      instance as currently set for this :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>`.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEGridShapeFunc, GridShapeFunc

.. _OEShape_OEGridShapeFunc:

.. oe:class:: OEGridShapeFunc

   .. oe:api::

      class OEGridShapeFunc : public OEShapeFunc

   The :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>` class defines shape overlap between a reference
   object and a fit molecule, using the *Grid* method.

   .. _figure_OEGridShapeFunc_Hierarchy:

   .. figure:: shapetk/images/OEGridShapeFunc.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>` 
    * :oe:meth:`SetupFlex<OEShape::OEOverlapFuncBase::SetupFlex>`
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The following methods are publicly inherited from :ref:`OEShapeFunc <OEShape_OEShapeFunc>`:
    * :oe:meth:`GetShapeOptions<OEShape::OEShapeFunc::GetShapeOptions>`

   The :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>` class defines the following public methods:
    * :oe:meth:`GetGridOptions<OEShape::OEGridShapeFunc::GetGridOptions>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEGridShapeFunc(const OEShapeOptions& argOptions = OEShapeOptions())
            OEGridShapeFunc(const OEShapeGridOptions&)
            OEGridShapeFunc(const OEShapeOptions& argShape,
                            const OEShapeGridOptions& argGrid)
            OEGridShapeFunc(const OEGridShapeFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEGridShapeFunc(argOptions: OEShapeOptions = OEShapeOptions()) -> OEGridShapeFunc
            OEGridShapeFunc(argOptions: OEShapeGridOptions) -> OEGridShapeFunc
            OEGridShapeFunc(argShape: OEShapeOptions,
                            argGrid: OEShapeGridOptions) -> OEGridShapeFunc
            OEGridShapeFunc(argFunc: OEGridShapeFunc) -> OEGridShapeFunc

      Default and copy constructors.

      Constructs an :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEGridShapeFunc &operator=(const OEGridShapeFunc &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetGridOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEShapeGridOptions& GetGridOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridOptions() -> OEShapeGridOptions

      Returns a reference to the :ref:`OEShapeGridOptions <OEShape_OEShapeGridOptions>`
      instance as currently set for this :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. _OEShape_OEHermite:

.. oe:class:: OEHermite

   .. oe:api::

      class OEHermite

   This class performs Hermite expansion for a given molecule or a grid
   representation of a molecule, then returns the coefficients of expansion
   and creates a grid representation of Hermite shape.

   .. seealso::

      * :ref:`shapetk_hermite_section` section
      * :ref:`chapter_hermite_shape_examples` examples

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHermite(const OEHermite &)
            OEHermite(const OEHermiteOptions& hermOpts = OEHermiteOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEHermite(hermOpts: OEHermiteOptions = OEHermiteOptions()) -> OEHermite
            OEHermite(arg2: OEHermite) -> OEHermite

      This class has three constructors. The first two are default and copy constructors. The third one is a constructor that takes an option class :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>`.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHermite &operator=(const OEHermite &)

      The assignment operator acts in the context of the equation A = B, where A and B are two object instances of the class :ref:`OEHermite <OEShape_OEHermite>`;
      as such, it copies the contents of object B into object A.

   .. _OEShape_OEHermite_CreateGrid:

      Assignment operator.

   .. oe:method:: CreateGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            void CreateGrid(OESystem::OEScalarGrid&, const float spacing)
            void CreateGrid(OESystem::OEScalarGrid&, const float spacing,
                            const OEChem::OETrans)

      .. oe:language:: python

         .. oe:api:: python

            CreateGrid(grid: OEScalarGrid, spacing: float) -> None
            CreateGrid(grid: OEScalarGrid, spacing: float, trans: OETrans) -> None

      This method creates a grid representation of the obtained Hermite
      expansion. Depending on the grid ``spacing`` parameter, the number
      of grid points to cover the entire molecule will be calculated. If
      this number exceeds 500 points per space dimension, the user will be
      warned that the maximum allowed value of 500 will be used instead.
      The second overload uses the transform that is applied to transform
      the generated grid.

   .. _OEShape_OEHermite_GetCoefficients:

   .. oe:method:: GetCoefficients

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCoefficients(std::vector <double>& coeffs) const
            const std::vector<double>& GetCoefficients() const

      .. oe:language:: python

         .. oe:api:: python

            GetCoefficients(coeffs: OEDoubleVector) -> bool
            GetCoefficients() -> OEDoubleVector

      Returns the values of Hermite expansion coefficients in the form of an
      STL vector. These are precisely the coefficients :math:`f_{\ell mn}`
      introduced in the :ref:`shapetk_hermite_section`, in the
      following order: :math:`\,N = 0\dots \text{NPolyMax},\, \ell = 0\dots \text{N}, \,m = 0\dots \text{N}-\ell, \,n = \text{N}-\ell-m`.

   .. _OEShape_OEHermite_GetOptions:

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEHermiteOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEHermiteOptions

      Returns the option class :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` that the :ref:`OEHermite <OEShape_OEHermite>` class is currently using.

   .. _OEShape_OEHermite_GetSolventOverlap:

   .. oe:method:: GetSelfOverlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSelfOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetSelfOverlap() -> float

      Returns the self-overlap of the molecule corresponding to Hermite
      expansion.

   .. _OEShape_OEHermite_NumCoefficients:
   
   .. oe:method:: NumCoefficients

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumCoefficients() const

      .. oe:language:: python

         .. oe:api:: python

            NumCoefficients() -> int

      Returns the size of the Hermite expansion representation. This number is given by :math:`\,(\text{NPolyMax}+1)(\text{NPolyMax}+2)(\text{NPolyMax}+3)/6`, which is the number of possible sets :math:`(\ell, m, n)` such that :math:`\ell + m + n \leq NPolyMax`.

   .. _OEShape_OEHermite_Setup:

   .. oe:method:: Setup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Setup(const OEShapeQuery& argQuery)
            bool Setup(const OEChem::OEMolBase& mol)
            bool Setup(const OESystem::OEScalarGrid& grid)

      .. oe:language:: python

         .. oe:api:: python

            Setup(argQuery: OEShapeQuery) -> bool
            Setup(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            Setup(grid: OEScalarGrid) -> bool

      This overloaded method allows a user to input into the :ref:`OEHermite <OEShape_OEHermite>`
      class a molecule as a shape query object or a molecule object, or by using a grid representation.
      The method returns `True` if the setup was successful and `False` otherwise.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. _OEShape_OEHermiteOptions:

.. oe:class:: OEHermiteOptions

   .. oe:api::

      class OEHermiteOptions

   This is an option class for the :ref:`OEHermite <OEShape_OEHermite>` class. It
   allows the user to input the level of the :ref:`Hermite expansion <shapetk_hermite_section>` 
   NPolyMax, the parameters :math:`\lambda_x, \lambda_y, \lambda_z`, and whether or not the
   parameters need to be optimized inside the :ref:`OEHermite <OEShape_OEHermite>` class.

   .. seealso::

      * :ref:`shapetk_hermite_section` section
      * :ref:`chapter_hermite_shape_examples` examples

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHermiteOptions()
            OEHermiteOptions(const OEHermiteOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEHermiteOptions() -> OEHermiteOptions
            OEHermiteOptions(arg2: OEHermiteOptions) -> OEHermiteOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHermiteOptions &operator=(const OEHermiteOptions &)

.. _OEShape_OEHermiteOptions_GetLambdaX:

      Assignment operator.

   .. oe:method:: GetLambdaX

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLambdaX() const

      .. oe:language:: python

         .. oe:api:: python

            GetLambdaX() -> float

      Returns the value of the :math:`\lambda_x` parameter.

.. _OEShape_OEHermiteOptions_GetLambdaY:

   .. oe:method:: GetLambdaY

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLambdaY() const

      .. oe:language:: python

         .. oe:api:: python

            GetLambdaY() -> float

      Returns the value of the :math:`\lambda_y` parameter.

.. _OEShape_OEHermiteOptions_GetLambdaZ:

   .. oe:method:: GetLambdaZ

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLambdaZ() const

      .. oe:language:: python

         .. oe:api:: python

            GetLambdaZ() -> float

      Returns the value of the :math:`\lambda_z` parameter.

.. _OEShape_OEHermiteOptions_GetNPolyMax:

   .. oe:method:: GetNPolyMax

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNPolyMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetNPolyMax() -> int

      Returns the value of the NPolyMax parameter, which controls the level of
      Hermite expansion. In particular, the lowest value `0` corresponds to a
      very inaccurate expansion, approximating the entire molecule by a
      single Gaussian. In the limit NPolyMax :math:`\rightarrow \infty`,
      we obtain exact equivalence of the Hermite expansion to the original
      representation of the molecule.

.. _OEShape_OEHermiteOptions_GetUseOptimalLambdas:

   .. oe:method:: GetUseOptimalLambdas

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseOptimalLambdas() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseOptimalLambdas() -> bool

      When `UseOptimalLambdas` is `True`, the parameters :math:`\lambda_x, \lambda_y, \lambda_z`
      of the Hermite expansion will be chosen automatically based on the molecule input and 
      resolution of expansion. Alternatively, when `UseOptimalLambdas` is `False`, the 
      current values of the :math:`\,\lambda_{x,y,z}\,` parameters will be used instead. 
      Note that the Hermite expansion will converge regardless of the choice of 
      :math:`\,\lambda_{x,y,z}\,` as long as NPolyMax is high enough, 
      but in practice, at a given low resolution of Hermite expansion, it is useful
      to use optimal :math:`\,\lambda_{x,y,z}\,` parameters for faster convergence.

.. _OEShape_OEHermiteOptions_SetLambdaX:

   .. oe:method:: SetLambdaX

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLambdaX(double)

      .. oe:language:: python

         .. oe:api:: python

            SetLambdaX(value: float) -> bool

      Sets the value of the :math:`\lambda_x` parameter. Default: `0.5`.

.. _OEShape_OEHermiteOptions_SetLambdaY:

   .. oe:method:: SetLambdaY

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLambdaY(double)

      .. oe:language:: python

         .. oe:api:: python

            SetLambdaY(value: float) -> bool

      Sets the value of the :math:`\lambda_y` parameter. Default: `0.5`.

.. _OEShape_OEHermiteOptions_SetLambdaZ:

   .. oe:method:: SetLambdaZ

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLambdaZ(double)

      .. oe:language:: python

         .. oe:api:: python

            SetLambdaZ(value: float) -> bool

      Sets the value of the :math:`\lambda_z` parameter. Default: `0.5`.

.. _OEShape_OEHermiteOptions_SetNPolyMax:

   .. oe:method:: SetNPolyMax

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNPolyMax(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetNPolyMax(value: int) -> bool

      Sets the value of the NPolyMax parameter. Default: `4`.

.. _OEShape_OEHermiteOptions_SetUseOptimalLambdas:

   .. oe:method:: SetUseOptimalLambdas

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseOptimalLambdas(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseOptimalLambdas(value: bool) -> bool

      Sets the value of the `UseOptimalLambdas` parameter. Default: `True`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHermiteOverlay, HermiteOverlay

.. _OEShape_OEHermiteOverlay:

.. oe:class:: OEHermiteOverlay
   
   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHermiteOverlay

   The :ref:`OEHermiteOverlay <OEShape_OEHermiteOverlay>` defines an interface for overlap optimization
   between a reference object (a molecule, grid, shape query, or Hermite) and a fit object (molecule
   conformers, grid, or Hermite).

   .. note::

      Currently :ref:`OEHermiteOverlay <OEShape_OEHermiteOverlay>` optimizes shape only.

   The :ref:`OEHermiteOverlay <OEShape_OEHermiteOverlay>` class defines the following public methods:
    * :oe:meth:`BestOverlay<OEShape::OEHermiteOverlay::BestOverlay>`
    * :oe:meth:`SetupRef<OEShape::OEHermiteOverlay::SetupRef>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHermiteOverlay(const OEHermiteOverlayOptions& hermOverlayOpts = OEHermiteOverlayOptions())
            OEHermiteOverlay(const OEHermiteOverlay&)

      .. oe:language:: python

         .. oe:api:: python

            OEHermiteOverlay(hermOverlayOpts: OEHermiteOverlayOptions = OEHermiteOverlayOptions()) -> OEHermiteOverlay
            OEHermiteOverlay(arg2: OEHermiteOverlay) -> OEHermiteOverlay

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHermiteOverlay &operator=(const OEHermiteOverlay &)

.. _OEShape_OEHermiteOverlay_BestOverlay:

      Assignment operator.

   .. oe:method:: BestOverlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool BestOverlay(OEBestOverlayScore& score,
                             const OEHermite& fitherm,
                             const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& sorter = OEHighestTanimoto())
            bool BestOverlay(OEBestOverlayScore& score,
                             const OEChem::OEMCMolBase& fitmol,
                             const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& sorter = OEHighestTanimoto())
            bool BestOverlay(OEBestOverlayScore& score,
                             const OESystem::OEScalarGrid& fitgrid,
                             const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& sorter = OEHighestTanimoto())

      .. oe:language:: python

         .. oe:api:: python

            BestOverlay(score: OEBestOverlayScore, fitherm: OEHermite,
                        sorter: OEBestOverlayScoreSorterPred = OEHighestTanimoto()) -> bool
            BestOverlay(score: OEBestOverlayScore, fitmol: OEMol,
                        sorter: OEBestOverlayScoreSorterPred = OEHighestTanimoto()) -> bool
            BestOverlay(score: OEBestOverlayScore, fitgrid: OEScalarGrid,
                        sorter: OEBestOverlayScoreSorterPred = OEHighestTanimoto()) -> bool

      This method optimizes the overlay between the reference object and the fit object (molecule conformers,
      grid, or Hermite), and returns the best result, sorted based on the binary predicate ``sorter``.
      The predicate has a default setting of :ref:`OEHighestTanimoto <OEShape_OEHighestTanimoto>`. 
      The reference object must be set using the :oe:meth:`SetupRef<OEShape::OEHermiteOverlay::SetupRef>` method prior to calling this method.

.. _OEShape_OEHermiteOverlay_SetupRef:

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEHermite& refherm)
            bool SetupRef(const OEChem::OEMolBase& refmol)
            bool SetupRef(const OESystem::OEScalarGrid& refgrid)
            bool SetupRef(const OEShapeQuery& query)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(refherm: OEHermite) -> bool
            SetupRef(refmol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            SetupRef(refgrid: OEScalarGrid) -> bool
            SetupRef(query: OEShapeQuery) -> bool

      This method defines the interface for setting up the reference system for the 
      :ref:`OEHermiteOverlay <OEShape_OEHermiteOverlay>` instance with a molecule, grid, shape query,
      or Hermite object.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHermiteOverlayOptions, HermiteOverlayOptions

.. _OEShape_OEHermiteOverlayOptions:

.. oe:class:: OEHermiteOverlayOptions
   
   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHermiteOverlayOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for :ref:`OEHermiteOverlay <OEShape_OEHermiteOverlay>`.

   The :ref:`OEHermiteOverlayOptions <OEShape_OEHermiteOverlayOptions>` class defines the following public methods:
    * :oe:meth:`GetHermiteOptions<OEShape::OEHermiteOverlayOptions::GetHermiteOptions>` and
      :oe:meth:`SetHermiteOptions<OEShape::OEHermiteOverlayOptions::SetHermiteOptions>`
    * :oe:meth:`GetMaxOptSteps<OEShape::OEHermiteOverlayOptions::GetMaxOptSteps>` and
      :oe:meth:`SetMaxOptSteps<OEShape::OEHermiteOverlayOptions::SetMaxOptSteps>`
    * :oe:meth:`GetStarts<OEShape::OEHermiteOverlayOptions::GetStarts>` and 
      :oe:meth:`SetStarts<OEShape::OEHermiteOverlayOptions::SetStarts>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHermiteOverlayOptions()
            OEHermiteOverlayOptions(const OEHermiteOverlayOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEHermiteOverlayOptions() -> OEHermiteOverlayOptions
            OEHermiteOverlayOptions(arg2: OEHermiteOverlayOptions) -> OEHermiteOverlayOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHermiteOverlayOptions &operator=(const OEHermiteOverlayOptions &)

.. _OEShape_OEHermiteOverlayOptions_GetHermiteOptions:

      Assignment operator.

   .. oe:method:: GetHermiteOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHermiteOptions& GetHermiteOptions()
            const OEHermiteOptions& GetHermiteOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetHermiteOptions() -> OEHermiteOptions

      See the :oe:meth:`SetHermiteOptions<OEShape::OEHermiteOverlayOptions::SetHermiteOptions>` method.

.. _OEShape_OEHermiteOverlayOptions_GetMaxOptSteps:

   .. oe:method:: GetMaxOptSteps

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxOptSteps() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxOptSteps() -> int

      See the :oe:meth:`SetMaxOptSteps<OEShape::OEHermiteOverlayOptions::SetMaxOptSteps>` method.

.. _OEShape_OEHermiteOverlayOptions_GetStarts:

   .. oe:method:: GetStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEStarts& GetStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetStarts() -> OEStarts

      See the :oe:meth:`SetStarts<OEShape::OEHermiteOverlayOptions::SetStarts>` method.

.. _OEShape_OEHermiteOverlayOptions_SetHermiteOptions:

   .. oe:method:: SetHermiteOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHermiteOptions(const OEHermiteOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetHermiteOptions(opts: OEHermiteOptions) -> None

      Sets the Hermite parameters that control the :ref:`Hermite expansion <shapetk_hermite_section>` of reference and fit objects via the :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` class.

.. _OEShape_OEHermiteOverlayOptions_SetMaxOptSteps:

   .. oe:method:: SetMaxOptSteps

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxOptSteps(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxOptSteps(value: int) -> bool

      Sets the maximum number of optimization iteration steps.
      Default: `200`.

.. _OEShape_OEHermiteOverlayOptions_SetStarts:

   .. oe:method:: SetStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStarts(const OEStarts&)

      .. oe:language:: python

         .. oe:api:: python

            SetStarts(argStarts: OEStarts) -> None

      Set the starts by passing in an :ref:`OEStarts <OEShape_OEStarts>`
      instance. This defines the starts to be used for optimization.



.. oe:namespace:: OEShape

.. _OEShape_OEHermiteShapeFunc:

.. oe:class:: OEHermiteShapeFunc

   .. oe:api::

      class OEHermiteShapeFunc : public OEShapeFunc

   This class is derived from :ref:`OEShapeFunc <OEShape_OEShapeFunc>` and is used to approximate
   Tanimoto shape-similarity coefficient based on Hermite representation of molecules.

   .. _figure_OEHermiteShapeFunc_Hierarchy:

   .. figure:: shapetk/images/OEHermiteShapeFunc.*
      :align:  center

   .. seealso::

      * :ref:`shapetk_hermite_section` section
      * :ref:`OEHermite <OEShape_OEHermite>` class
      * :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` class
      * :ref:`chapter_hermite_shape_examples` examples

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>` 
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The following methods are publicly inherited from :ref:`OEShapeFunc <OEShape_OEShapeFunc>`:
    * :oe:meth:`GetShapeOptions<OEShape::OEShapeFunc::GetShapeOptions>`

   The :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>` class defines the following public methods:
    * :oe:meth:`GetFitHermiteOptions<OEShape::OEHermiteShapeFunc::GetFitHermiteOptions>`
    * :oe:meth:`GetRefHermiteOptions<OEShape::OEHermiteShapeFunc::GetRefHermiteOptions>`

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHermiteShapeFunc(const OEHermiteShapeFunc &)
            OEHermiteShapeFunc(const OEShapeOptions& argOptions = OEShapeOptions())
            OEHermiteShapeFunc(const OEHermiteOptions& HermOptRef,
                               const OEHermiteOptions& HermOptFit)
            OEHermiteShapeFunc(const OEShapeOptions& argOptions,
                               const OEHermiteOptions& HermOptRef,
                               const OEHermiteOptions& HermOptFit)

      .. oe:language:: python

         .. oe:api:: python

            OEHermiteShapeFunc(argOptions: OEShapeOptions = OEShapeOptions()) -> OEHermiteShapeFunc
            OEHermiteShapeFunc(HermOptRef: OEHermiteOptions,
                               HermOptFit: OEHermiteOptions) -> OEHermiteShapeFunc
            OEHermiteShapeFunc(argOptions: OEShapeOptions,
                               HermOptRef: OEHermiteOptions,
                               HermOptFit: OEHermiteOptions) -> OEHermiteShapeFunc
            OEHermiteShapeFunc(arg2: OEHermiteShapeFunc) -> OEHermiteShapeFunc

      The four constructors are in the respective order: a standard
      copy constructor, a constructor that inputs a
      :ref:`OEShapeOptions <OEShape_OEShapeOptions>` object, a constructor that
      inputs two :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` objects, one for
      reference and one for fit molecules, and finally a constructor
      that inputs :ref:`OEShapeOptions <OEShape_OEShapeOptions>` object along with
      two :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` objects, one for
      reference and one for fit molecules.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHermiteShapeFunc &operator=(const OEHermiteShapeFunc &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetFitHermiteOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEHermiteOptions& GetFitHermiteOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitHermiteOptions() -> OEHermiteOptions

      This method returns :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` class currently being used for the fit molecule.

   .. oe:method:: GetRefHermiteOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEHermiteOptions& GetRefHermiteOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefHermiteOptions() -> OEHermiteOptions

      This method returns :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` class currently being used for the reference molecule.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHighestColorTanimoto, HighestColorTanimoto

.. _OEShape_OEHighestColorTanimoto:

.. oe:class:: OEHighestColorTanimoto

   .. oe:api::

      struct OEHighestColorTanimoto : public OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>

   Predicate to compare :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on color Tanimoto.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBestOverlayScoreSorterFunc



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHighestComboScore, HighestComboScore

.. _OEShape_OEHighestComboScore:

.. oe:class:: OEHighestComboScore

   .. oe:api::

      struct OEHighestComboScore : public OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>

   .. note::

      This deprecated class will not be developed further, as it was developed based on a nonstandard score.

   Predicate to compare :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on a combination of shape Tanimoto and color score.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBestOverlayScoreSorterFunc



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHighestFitColorTversky, HighestFitColorTversky

.. _OEShape_OEHighestFitColorTversky:

.. oe:class:: OEHighestFitColorTversky

   .. oe:api::

      struct OEHighestFitColorTversky : public OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>

   Predicate to compare :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on the Tversky color score of the fit molecule.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBestOverlayScoreSorterFunc



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHighestFitTversky, HighestFitTversky

.. _OEShape_OEHighestFitTversky:

.. oe:class:: OEHighestFitTversky

   .. oe:api::

      struct OEHighestFitTversky : public OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>

   Predicate to compare :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on fit molecule shape Tversky.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBestOverlayScoreSorterFunc



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHighestFitTverskyCombo, HighestFitTverskyCombo

.. _OEShape_OEHighestFitTverskyCombo:

.. oe:class:: OEHighestFitTverskyCombo

   .. oe:api::

      struct OEHighestFitTverskyCombo : public OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>

   Predicate to compare :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on fit molecule shape plus color Tversky.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBestOverlayScoreSorterFunc



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHighestOverlap, HighestOverlap

.. _OEShape_OEHighestOverlap:

.. oe:class:: OEHighestOverlap

   .. oe:api::

      struct OEHighestOverlap : public OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>

   Predicate to compare :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on shape overlap.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBestOverlayScoreSorterFunc



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHighestRefColorTversky, HighestRefColorTversky

.. _OEShape_OEHighestRefColorTversky:

.. oe:class:: OEHighestRefColorTversky

   .. oe:api::

      struct OEHighestRefColorTversky : public OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>

   Predicate to compare :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on reference molecule color Tversky.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBestOverlayScoreSorterFunc



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHighestRefTversky, HighestRefTversky

.. _OEShape_OEHighestRefTversky:

.. oe:class:: OEHighestRefTversky

   .. oe:api::

      struct OEHighestRefTversky : public OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>

   Predicate to compare :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on reference molecule shape Tversky.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBestOverlayScoreSorterFunc



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHighestRefTverskyCombo, HighestRefTverskyCombo

.. _OEShape_OEHighestRefTverskyCombo:

.. oe:class:: OEHighestRefTverskyCombo

   .. oe:api::

      struct OEHighestRefTverskyCombo : public OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>

   Predicate to compare :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on reference molecule shape plus color Tversky.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBestOverlayScoreSorterFunc



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHighestScaledColor, HighestScaledColor

.. _OEShape_OEHighestScaledColor:

.. oe:class:: OEHighestScaledColor

   .. oe:api::

      struct OEHighestScaledColor : public OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>

   Predicate to compare :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on scaled color.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBestOverlayScoreSorterFunc



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHighestTanimoto, HighestTanimoto

.. _OEShape_OEHighestTanimoto:

.. oe:class:: OEHighestTanimoto

   .. oe:api::

      struct OEHighestTanimoto : public OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>

   Predicate to compare :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on shape Tanimoto.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBestOverlayScoreSorterFunc



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHighestTanimotoCombo, HighestTanimotoCombo

.. _OEShape_OEHighestTanimotoCombo:

.. oe:class:: OEHighestTanimotoCombo

   .. oe:api::

      struct OEHighestTanimotoCombo : public OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>

   Predicate to compare :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on shape plus color Tanimoto.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBestOverlayScoreSorterFunc



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHighestTverskyCombo, HighestTverskyCombo

.. _OEShape_OEHighestTverskyCombo:

.. oe:class:: OEHighestTverskyCombo

   .. oe:api::

      class OEHighestTverskyCombo : public OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>

   Predicate to compare :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on shape plus color Tversky.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHighestTverskyCombo(const float alpha)

      .. oe:language:: python

         .. oe:api:: python

            OEHighestTverskyCombo(alpha: float) -> OEHighestTverskyCombo

      Default constructor.  The argument requires the desired alpha value for 
      Tversky calculation.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBestOverlayScoreSorterFunc



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEInertialStarts, InertialStarts

.. _OEShape_OEInertialStarts:

.. oe:class:: OEInertialStarts

   .. oe:api::

      class OEInertialStarts : public OEStarts

   The :ref:`OEInertialStarts <OEShape_OEInertialStarts>` represents the inertial starts for
   overlay optimization.

   .. _figure_OEInertialStarts_Hierarchy:

   .. figure:: shapetk/images/OEInertialStarts.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEStarts <OEShape_OEStarts>`:
    * :oe:meth:`CreateCopy<OEShape::OEStarts::CreateCopy>`  
    * :oe:meth:`GetNumOfStarts<OEShape::OEStarts::GetNumOfStarts>` 
    * :oe:meth:`GetStarts<OEShape::OEStarts::GetStarts>`
    * :oe:meth:`Setup<OEShape::OEStarts::Setup>` 
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupFrame>`
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupRef>`

   The :ref:`OEInertialStarts <OEShape_OEInertialStarts>` class defines the following public methods:
    * :oe:meth:`GetSymmetryThreshold<OEShape::OEInertialStarts::GetSymmetryThreshold>`  
    * :oe:meth:`SetSymmetryThreshold<OEShape::OEInertialStarts::SetSymmetryThreshold>` 

   The following classes derive from this class:
    * :ref:`OEAtAtomStarts <OEShape_OEAtAtomStarts>`
    * :ref:`OECartesianStarts <OEShape_OECartesianStarts>`
    * :ref:`OEQuatStarts <OEShape_OEQuatStarts>`
    * :ref:`OERandomStarts <OEShape_OERandomStarts>`
    * :ref:`OESubrocsStarts <OEShape_OESubrocsStarts>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInertialStarts()
            OEInertialStarts(const OEInertialStarts&)

      .. oe:language:: python

         .. oe:api:: python

            OEInertialStarts() -> OEInertialStarts
            OEInertialStarts(arg2: OEInertialStarts) -> OEInertialStarts

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEInertialStarts &operator=(const OEInertialStarts &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetSymmetryThreshold

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSymmetryThreshold() const

      .. oe:language:: python

         .. oe:api:: python

            GetSymmetryThreshold() -> float

      Returns the symmetry threshold value currently set.

   .. oe:method:: SetSymmetryThreshold

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSymmetryThreshold(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetSymmetryThreshold(argThreshold: float) -> None

      Sets the symmetry threshold value to be used to determine symmetry of objects.
      Default: 0.15.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEIsColorAtomPred, IsColorAtomPred

.. _OEShape_OEIsColorAtomPred:

.. oe:class:: OEIsColorAtomPred

   .. oe:api::

      class OEIsColorAtomPred : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   Unary predicate that returns true if an atom is a color atom.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsColorAtomPred()

      .. oe:language:: python

         .. oe:api:: python

            OEIsColorAtomPred() -> OEIsColorAtomPred

      Default and copy constructors.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsColorAtomPred



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEMultiRefOverlay, MultiRefOverlay

.. _OEShape_OEMultiRefOverlay:

.. oe:class:: OEMultiRefOverlay

   .. oe:api::

      class OEMultiRefOverlay

   .. note::

      With the default settings, the :ref:`OEMultiRefOverlay <OEShape_OEMultiRefOverlay>` optimizes
      both shape and color.

   The :ref:`OEMultiRefOverlay <OEShape_OEMultiRefOverlay>` provides an extension to :ref:`OEOverlay <OEShape_OEOverlay>` to enable setting up a multi-conformer molecule
   as the reference system for overlay optimization between a reference and a fit 
   molecule conformers.

   The :ref:`OEMultiRefOverlay <OEShape_OEMultiRefOverlay>` class defines the following public methods:
    * :oe:meth:`BestOverlay<OEShape::OEMultiRefOverlay::BestOverlay>`
    * :oe:meth:`GetOverlayOptions<OEShape::OEMultiRefOverlay::GetOverlayOptions>`
    * :oe:meth:`Overlay<OEShape::OEMultiRefOverlay::Overlay>`
    * :oe:meth:`SetupRef<OEShape::OEMultiRefOverlay::SetupRef>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMultiRefOverlay(const OEOverlayOptions& argOptions = OEOverlayOptions())
            OEMultiRefOverlay(const OEMultiRefOverlay&)

      .. oe:language:: python

         .. oe:api:: python

            OEMultiRefOverlay(argOptions: OEOverlayOptions = OEOverlayOptions()) -> OEMultiRefOverlay
            OEMultiRefOverlay(argOverlay: OEMultiRefOverlay) -> OEMultiRefOverlay

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMultiRefOverlay &operator=(const OEMultiRefOverlay &)

      Assignment operator.

   .. oe:method:: BestOverlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool BestOverlay(OEBestOverlayScore& argScore, const OEChem::OEMCMolBase& argFitMol,
            const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& argPred = OEHighestTanimotoCombo())

      .. oe:language:: python

         .. oe:api:: python

            BestOverlay(argScore: OEBestOverlayScore, argFitMol: OEMol,
                        argPred: OEBestOverlayScoreSorterPred = OEHighestTanimotoCombo()) -> bool

      Method optimizes the overlay between the reference object and the fit
      molecule conformers, and returns the best result.  The reference object must be set using the
      :oe:meth:`SetupRef<OEShape::OEMultiRefOverlay::SetupRef>` method.

   .. oe:method:: GetOverlayOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEOverlayOptions& GetOverlayOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlayOptions() -> OEOverlayOptions

      Returns a reference to the :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>`
      instance as currently set. This defines options to calculate Overlay.

   .. oe:method:: Overlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBestOverlayResults>* Overlay(const OEChem::OEMCMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            Overlay(argFitMol: OEMol) -> Iterable[OEBestOverlayResults]

      Method optimizes the Overlay between the reference molecule and the fit
      molecule conformers.  The reference molecule must be set using the
      :oe:meth:`SetupRef<OEShape::OEMultiRefOverlay::SetupRef>` method.

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEChem::OEMCMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(argRefMol: OEMol) -> bool

      Method defines the interface for setting up the reference system for the :ref:`OEMultiRefOverlay <OEShape_OEMultiRefOverlay>` instance with a multi-conformer molecule.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlap, Overlap

.. _OEShape_OEOverlap:

.. oe:class:: OEOverlap

   .. oe:api::

      class OEOverlap

   .. note::

      This deprecated class will not be developed further. It is being replaced by
      derivatives of :ref:`OEShapeFunc <OEShape_OEShapeFunc>` which provides
      more control and greater expandability.

   OEOverlap calculates the static shape overlap between a reference
   molecule or grid and a fit molecule or grid. Note that this does not
   move the fit molecule(grid) nor does it optimize the overlap. It
   simply calculates the score for the provided orientation.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOverlap()
            OEOverlap(const OEOverlap& rhs)
            OEOverlap(const OEChem::OEMolBase& refmol)
            OEOverlap(const OESystem::OEScalarGrid& refmol)

      .. oe:language:: python

         .. oe:api:: python

            OEOverlap() -> OEOverlap
            OEOverlap(refmol: OEScalarGrid) -> OEOverlap
            OEOverlap(rhs: OEOverlap) -> OEOverlap
            OEOverlap(refmol: Union[OEGraphMol,OEMol,OEQMol]) -> OEOverlap

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOverlap & operator=(const OEOverlap & rhs)

      Assignment operator.

   .. oe:method:: GetCarbonRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetCarbonRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetCarbonRadius() -> float

      Return the current value for the carbon radius approximation.

   .. oe:method:: GetGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetGridSpacing() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridSpacing() -> float

      Return the current value for the grid spacing to use for the
      :oe:const:`OEShape::OEOverlapMethod::Grid` method of calculating
      overlaps. Is not used by any other overlap method. Defaults to
      ``0.25``.

   .. oe:method:: GetMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetMethod() -> int

      Return the current value of overlap method.

   .. oe:method:: GetRadiiApproximation

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRadiiApproximation() const

      .. oe:language:: python

         .. oe:api:: python

            GetRadiiApproximation() -> int

      Return the current value of the radii approximation.

   .. oe:method:: GetUseHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseHydrogens() -> bool

      Return the status of hydrogen use in OEOverlap.

   .. oe:method:: Overlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Overlap(OEOverlapResults& res, float* atomOverlaps = 0)
            bool Overlap(const OEChem::OEMolBase& fitmol,
                         OEOverlapResults& res, float* atomOverlaps = 0)

      .. oe:language:: python

         .. oe:api:: python

            Overlap(res: OEOverlapResults, atomOverlaps: OEFloatArray = None) -> bool
            Overlap(fitmol: Union[OEGraphMol,OEMol,OEQMol],
                    res: OEOverlapResults, atomOverlaps: OEFloatArray = None) -> bool

      Calculate the overlap of the passed in fit molecule or fit grid
      and place the results into the passed instance of
      :ref:`OEOverlapResults <OEShape_OEOverlapResults>`.

   .. oe:method:: SetCarbonRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCarbonRadius(float cradius)

      .. oe:language:: python

         .. oe:api:: python

            SetCarbonRadius(cradius: float) -> bool

      Set the radius to use when using
      :oe:const:`OEShape::OEOverlapRadii::Carbon`. By default this is
      set to 1.7 Angstroms. See
      :oe:meth:`OEShape::OEBestOverlay::GetCarbonRadius`.

   .. oe:method:: SetFitMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFitMol(const OEChem::OEMolBase& fitmol)

      .. oe:language:: python

         .. oe:api:: python

            SetFitMol(fitmol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Set molecule to be used as fit object.

   .. oe:method:: SetGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetGridSpacing(float spacing)

      .. oe:language:: python

         .. oe:api:: python

            SetGridSpacing(spacing: float) -> bool

      Set the grid spacing to use for the
      :oe:const:`OEShape::OEOverlapMethod::Grid` method of calculating
      overlaps. Smaller values typically lead to more accurate results
      when considering large numbers of compounds, though not
      necessarily more accurate results in individual cases. This
      method will only accept values between 0.125 and 1.0
      inclusive. The default is 0.25 angstroms for a balance of
      performance and reproducibility. Larger values may lead to
      better performance on some platforms.

   .. oe:method:: SetMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMethod(unsigned int m)

      .. oe:language:: python

         .. oe:api:: python

            SetMethod(m: int) -> bool

      Set the method used to calculate overlap. The default for OEOverlap is
      :oe:const:`OEShape::OEOverlapMethod::Exact`. Alternatives are defined in the
      :oe:constns:`OEShape::OEOverlapMethod` namespace. 

   .. oe:method:: SetRadiiApproximation

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRadiiApproximation(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetRadiiApproximation(type: int) -> bool

      Set the radius approximation used to calculate overlap. The
      default for OEOverlap is :oe:const:`OEShape::OEOverlapRadii::Carbon`. 
      Alternatives are defined in the :oe:constns:`OEShape::OEOverlapRadii` namespace.

   .. oe:method:: SetRefGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRefGrid(const OESystem::OEScalarGrid& refgrid)

      .. oe:language:: python

         .. oe:api:: python

            SetRefGrid(refgrid: OEScalarGrid) -> bool

      Set a reference grid for the calculation. An internal copy is made. Any 
      previous reference molecule or grid is cleared.

   .. oe:method:: SetRefMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRefMol(const OEChem::OEMolBase& refmol)

      .. oe:language:: python

         .. oe:api:: python

            SetRefMol(refmol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Set a reference molecule for the calculation. An internal copy
      is made. Any previous reference molecule or grid is cleared.

   .. oe:method:: SetUseHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseHydrogens(bool state)

      .. oe:language:: python

         .. oe:api:: python

            SetUseHydrogens(state: bool) -> bool

      Boolean to determine whether hydrogens are included in the shape
      calculation.  By default this is false and hydrogens are
      ignored.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlapCutoff, OverlapCutoff

.. _OEShape_OEOverlapCutoff:

.. oe:class:: OEOverlapCutoff

   .. oe:api::

      class OEOverlapCutoff : public OEOverlayScoreCutoff

   The :ref:`OEOverlapCutoff <OEShape_OEOverlapCutoff>` defines cutoff based on the
   shape overlap.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:
    * :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`

   The following methods are publicly inherited from :ref:`OEOverlayScoreCutoff <OEShape_OEOverlayScoreCutoff>`:
    * :oe:meth:`operator()<OEShape::OEOverlayScoreCutoff::operator()>`  
    * :oe:meth:`CreateCopy<OEShape::OEOverlayScoreCutoff::CreateCopy>`
  

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOverlapCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            OEOverlapCutoff(argCutoff: float) -> OEOverlapCutoff

      Default and copy constructors. The argument expects the desired cutoff.  



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlapFunc, ShapeFunc

.. _OEShape_OEOverlapFunc:

.. oe:class:: OEOverlapFunc

   .. oe:api::

      class OEOverlapFunc : public OEOverlapFuncBase

   The :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>` class defines an interface for combined shape and color
   overlap calculation between a reference object and a fit molecule. 
   The :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>` is a specialization of The :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
   for combined shape and color overlap.

   .. _figure_OEOverlapFunc_Hierarchy:

   .. figure:: shapetk/images/OEOverlapFunc.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>` 
    * :oe:meth:`SetupFlex<OEShape::OEOverlapFuncBase::SetupFlex>`
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>` class defines the following public methods:
    * :oe:meth:`GetColorFunc<OEShape::OEOverlapFunc::GetColorFunc>`
    * :oe:meth:`GetShapeFunc<OEShape::OEOverlapFunc::GetShapeFunc>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOverlapFunc(const OEShapeFunc& argShape = OEGridShapeFunc(),
                          const OEColorFunc& argColor = OEExactColorFunc())
            OEOverlapFunc(const OEColorFunc&)
            OEOverlapFunc(const OEOverlapFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEOverlapFunc(argShape: OEShapeFunc = OEGridShapeFunc(),
                          argColor: OEColorFunc = OEExactColorFunc()) -> OEOverlapFunc
            OEOverlapFunc(argFunc: OEColorFunc) -> OEOverlapFunc
            OEOverlapFunc(argFunc: OEOverlapFunc) -> OEOverlapFunc

      Default and copy constructors.

      Constructs an :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOverlapFunc &operator=(const OEOverlapFunc &)

      The assignment operator.

.. _OEShape_OEOverlapFunc_GetColorFunc:

      Assignment operator.

   .. oe:method:: GetColorFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEColorFunc& GetColorFunc() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorFunc() -> OEColorFunc

      Returns a reference to the :ref:`OEColorFunc <OEShape_OEColorFunc>`
      instance as currently set for this :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>`.

.. _OEShape_OEOverlapFunc_GetColorFunc_GetShapeFunc:

   .. oe:method:: GetShapeFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEShapeFunc& GetShapeFunc() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeFunc() -> OEShapeFunc

      Returns a reference to the :ref:`OEShapeFunc <OEShape_OEShapeFunc>`
      instance as currently set for this :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>`.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlapFuncBase, OverlapFuncBase

.. _OEShape_OEOverlapFuncBase:

.. oe:class:: OEOverlapFuncBase

   .. oe:api::

      class OEOverlapFuncBase : public OEMolPotential::OEMolFunc1

   The :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>` is an abstract base class. This class defines
   an interface for static overlap calculation between a reference object and a fit molecule. 
   The :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>` extends the :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>`
   class to allow setting up a reference object (which could be a molecule, grid or a shape query) 
   and the underlying functions defining interactions based on shape or color overlaps.

   .. _figure_OEOverlapFuncBase_Hierarchy:

   .. figure:: shapetk/images/OEOverlapFuncBase.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>` class defines the following public methods:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>` 
    * :oe:meth:`SetupFlex<OEShape::OEOverlapFuncBase::SetupFlex>`
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The following classes derive from this class:
    * :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>`
    * :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>`
    * :ref:`OEColorFunc <OEShape_OEColorFunc>`
    * :ref:`OEExactColorFunc <OEShape_OEExactColorFunc>`
    * :ref:`OEExactShapeFunc <OEShape_OEExactShapeFunc>`
    * :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>`
    * :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>`
    * :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>`
    * :ref:`OEShapeFunc <OEShape_OEShapeFunc>`

.. _OEShape_OEOverlapFuncBase_Overlap:

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOverlapFuncBase & operator=(const OEOverlapFuncBase &)

      Assignment operator.

   .. oe:method:: Overlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Overlap(const double* argCoords, OEOverlapResults &)
            bool Overlap(const OEChem::OEMolBase& argFitMol, OEOverlapResults &)

      .. oe:language:: python

         .. oe:api:: python

            Overlap(argCoords: OEDoubleArray, argResults: OEOverlapResults) -> bool
            Overlap(argFitMol: Union[OEGraphMol,OEMol,OEQMol],
                    argResults: OEOverlapResults) -> bool

      These methods calculate the overlap between the reference object and
      the fit molecule.  The reference object must be set using the
      :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>` method. The
      first overload assumes that the fit molecule has been set using the
      :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` method and uses
      the specified coordinates for the fit molecule. The second overlap
      takes the specified fit molecule and its current coordinates.

.. _OEShape_OEOverlapFuncBase_SetupFlex:

   .. oe:method:: SetupFlex

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupFlex(const OEChem::OEMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetupFlex(fitMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This method is a substitute for the :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`
      method to setup the fit molecule. This method should be called instead of the
      :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`, when the fit molecule is expected
      to be flexible and that the shape of the molecule is expected to change.

.. _OEShape_OEOverlapFuncBase_SetupRef:

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEChem::OEMolBase&)
            bool SetupRef(const OESystem::OEScalarGrid&)
            bool SetupRef(const OEShapeQuery&)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(argRefMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            SetupRef(argRefGrid: OEScalarGrid) -> bool
            SetupRef(argQuery: OEShapeQuery) -> bool

      These method defines the interface for setting up the reference system for the
      :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>` derived instance with a molecule, grid or a shape query.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlapPrep, OverlapPrep

.. _OEShape_OEOverlapPrep:

.. oe:class:: OEOverlapPrep

   .. oe:api::

      class OEOverlapPrep

   This class provides facilities to prepare molecules for overlap calculations. Preparing
   a molecule for overlap calculation consists of any or all of the following: adding or removing explicit
   hydrogens; adding color atoms; and assigning Bondi radii to all the atoms.
   When color atoms are added to molecules for overlap calculations, it is often required
   to remove them before further modeling work involving those molecules. Color atoms
   from molecules can be removed using the :oe:func:`OEShape::OERemoveColorAtoms` function.
   
   The :ref:`OEOverlapPrep <OEShape_OEOverlapPrep>` class defines the following public methods:
    * :oe:meth:`GetAssignBondiRadii<OEShape::OEOverlapPrep::GetAssignBondiRadii>`
    * :oe:meth:`GetAssignColor<OEShape::OEOverlapPrep::GetAssignColor>`
    * :oe:meth:`GetColorForceField<OEShape::OEOverlapPrep::GetColorForceField>`
    * :oe:meth:`GetUseHydrogens<OEShape::OEOverlapPrep::GetUseHydrogens>` 
    * :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`
    * :oe:meth:`SetAssignBondiRadii<OEShape::OEOverlapPrep::SetAssignBondiRadii>`
    * :oe:meth:`SetAssignColor<OEShape::OEOverlapPrep::SetAssignColor>`
    * :oe:meth:`SetColorForceField<OEShape::OEOverlapPrep::SetColorForceField>`
    * :oe:meth:`SetUseHydrogens<OEShape::OEOverlapPrep::SetUseHydrogens>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOverlapPrep(const OEOverlapPrepOptions& opts = OEOverlapPrepOptions())
            OEOverlapPrep(const OEOverlapPrep&)

      .. oe:language:: python

         .. oe:api:: python

            OEOverlapPrep(opts: OEOverlapPrepOptions = OEOverlapPrepOptions()) -> OEOverlapPrep
            OEOverlapPrep(arg2: OEOverlapPrep) -> OEOverlapPrep

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOverlapPrep &operator=(const OEOverlapPrep &)

   .. _OEShape_OEOverlapPrep_GetAssignBondRadii:

      Assignment operator.

   .. oe:method:: GetAssignBondiRadii

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAssignBondiRadii() const

      .. oe:language:: python

         .. oe:api:: python

            GetAssignBondiRadii() -> bool

      Returns the state of the assign Bondi radii flag. If true, Bondi radii 
      would be assigned to all atoms during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`.

   .. _OEShape_OEOverlapPrep_GetAssignColor:

   .. oe:method:: GetAssignColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAssignColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetAssignColor() -> bool

      Returns the state of the assign color flag. If true, color atoms would be 
      assigned during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`.

   .. _OEShape_OEOverlapPrep_GetColorForceField:

   .. oe:method:: GetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEColorForceField& GetColorForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceField() -> OEColorForceField

      Gets the instance of :ref:`OEColorForceField <OEShape_OEColorForceField>` currently associated
      with the :ref:`OEOverlapPrep <OEShape_OEOverlapPrep>`.

   .. _OEShape_OEOverlapPrep_GetUseHydrogens:

   .. oe:method:: GetUseHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseHydrogens() -> bool

      Returns the state of the use hydrogens flag. If true, explicit hydrogen atoms would be
      created during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`. If false, all hydrogen
      atoms would be removed.

   .. _OEShape_OEOverlapPrep_Prep:

   .. oe:method:: Prep

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Prep(OEChem::OEMCMolBase&)
            bool Prep(OEChem::OEMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            Prep(argMol: OEMol) -> bool
            Prep(argMol: Union[OEGraphMol,OEQMol]) -> bool

      Prepares the specified molecule for overlap calculation based on the current set of
      options set on :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`.

   .. _OEShape_OEOverlapPrep_SetAssignBondiRadii:

   .. oe:method:: SetAssignBondiRadii

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAssignBondiRadii(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAssignBondiRadii(argValue: bool) -> None

      Sets the state of the assign Bondi radii flag. If true, Bondi radii 
      would be assigned to all atoms during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`.

   .. _OEShape_OEOverlapPrep_SetAssignColor:

   .. oe:method:: SetAssignColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAssignColor(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAssignColor(argValue: bool) -> None

      Sets the state of the assign color flag. If true, color atoms would be 
      assigned during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`.
      Color atoms from molecules can be removed using the 
      :oe:func:`OEShape::OERemoveColorAtoms` function for further modeling
      work involving a molecule.

   .. _OEShape_OEOverlapPrep_SetColorForceField:

   .. oe:method:: SetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorForceField(const OEColorForceField& cff)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceField(argCff: OEColorForceField) -> bool

      Sets the color force field to be used. By default, the ImplicitMillsDean
      color force field is used.

   .. _OEShape_OEOverlapPrep_SetUseHydrogens:

   .. oe:method:: SetUseHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetUseHydrogens(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseHydrogens(argValue: bool) -> None

      Sets the state of the use hydrogens flag. If true, explicit hydrogen atoms would be
      created during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`. If false, all hydrogen
      atoms would be removed.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlapPrepOptions, OverlapPrepOptions

.. _OEShape_OEOverlapPrepOptions:

.. oe:class:: OEOverlapPrepOptions

   .. oe:api::

      class OEOverlapPrepOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for
   :ref:`OEOverlapPrep <OEShape_OEOverlapPrep>`. 
   In addition to preparing options available in :ref:`OEOverlapPrep <OEShape_OEOverlapPrep>`,
   this option class provides two more additional options to control the :ref:`Prep <OEShape_OEOverlapPrep_Prep>`
   process regarding the removal of color atoms which are closer than a threshold distance.

   The :ref:`OEOverlapPrepOptions <OEShape_OEOverlapPrepOptions>` class defines the following public methods:

   * :oe:meth:`GetAssignBondiRadii<OEShape::OEOverlapPrepOptions::GetAssignBondiRadii>` and
     :oe:meth:`SetAssignBondiRadii<OEShape::OEOverlapPrepOptions::SetAssignBondiRadii>`
   * :oe:meth:`GetAssignColor<OEShape::OEOverlapPrepOptions::GetAssignColor>` and
     :oe:meth:`SetAssignColor<OEShape::OEOverlapPrepOptions::SetAssignColor>`
   * :oe:meth:`GetDuplicateDistance<OEShape::OEOverlapPrepOptions::GetDuplicateDistance>` and
     :oe:meth:`SetDuplicateDistance<OEShape::OEOverlapPrepOptions::SetDuplicateDistance>`
   * :oe:meth:`AddDuplicateSmarts<OEShape::OEOverlapPrepOptions::AddDuplicateSmarts>`,
     :oe:meth:`GetDuplicateSmarts<OEShape::OEOverlapPrepOptions::GetDuplicateSmarts>`, and
     :oe:meth:`ClearDuplicateSmarts<OEShape::OEOverlapPrepOptions::ClearDuplicateSmarts>`
   * :oe:meth:`GetRemoveColor<OEShape::OEOverlapPrepOptions::GetRemoveColor>` and
     :oe:meth:`SetRemoveColor<OEShape::OEOverlapPrepOptions::SetRemoveColor>`
   * :oe:meth:`GetRemoveDuplicate<OEShape::OEOverlapPrepOptions::GetRemoveDuplicate>` and
     :oe:meth:`SetRemoveDuplicate<OEShape::OEOverlapPrepOptions::SetRemoveDuplicate>`
   * :oe:meth:`GetUseHydrogens<OEShape::OEOverlapPrepOptions::GetUseHydrogens>` and
     :oe:meth:`SetUseHydrogens<OEShape::OEOverlapPrepOptions::SetUseHydrogens>`
   * :oe:meth:`GetColorForceField<OEShape::OEOverlapPrepOptions::GetColorForceField>` and
     :oe:meth:`SetColorForceField<OEShape::OEOverlapPrepOptions::SetColorForceField>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOverlapPrepOptions(const bool loadColorFF = true)
            OEOverlapPrepOptions(const OEOverlapPrepOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEOverlapPrepOptions(loadColorFF: bool = True) -> OEOverlapPrepOptions
            OEOverlapPrepOptions(argOpts: OEOverlapPrepOptions) -> OEOverlapPrepOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOverlapPrepOptions &operator=(const OEOverlapPrepOptions&)

   .. _OEShape_OEOverlapPrepOptions_GetAssignBondiRadii:

      Assignment operator.

   .. oe:method:: GetAssignBondiRadii

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAssignBondiRadii() const

      .. oe:language:: python

         .. oe:api:: python

            GetAssignBondiRadii() -> bool

      See :oe:meth:`SetAssignBondiRadii<OEShape::OEOverlapPrepOptions::SetAssignBondiRadii>` method.

   .. _OEShape_OEOverlapPrepOptions_GetAssignColor:

   .. oe:method:: GetAssignColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAssignColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetAssignColor() -> bool

      See :oe:meth:`SetAssignColor<OEShape::OEOverlapPrepOptions::SetAssignColor>` method.

   .. _OEShape_OEOverlapPrepOptions_GetRemoveColor:

   .. oe:method:: GetRemoveColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRemoveColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetRemoveColor() -> bool

      See :oe:meth:`SetRemoveColor<OEShape::OEOverlapPrepOptions::SetRemoveColor>` method.

   .. _OEShape_OEOverlapPrepOptions_GetDuplicateDistance:

   .. oe:method:: GetDuplicateDistance

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetDuplicateDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetDuplicateDistance() -> float

      See :oe:meth:`SetDuplicateDistance<OEShape::OEOverlapPrepOptions::SetDuplicateDistance>` method.

   .. _OEShape_OEOverlapPrepOptions_GetRemoveDuplicate:

   .. oe:method:: GetRemoveDuplicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRemoveDuplicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetRemoveDuplicate() -> bool

      See :oe:meth:`SetRemoveDuplicate<OEShape::OEOverlapPrepOptions::SetRemoveDuplicate>` method.

   .. _OEShape_OEOverlapPrepOptions_GetUseHydrogens:

   .. oe:method:: GetUseHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseHydrogens() -> bool

      See :oe:meth:`SetUseHydrogens<OEShape::OEOverlapPrepOptions::SetUseHydrogens>` method.

   .. _OEShape_OEOverlapPrepOptions_GetColorForceField:

   .. oe:method:: GetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEColorForceField& GetColorForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceField() -> OEColorForceField

      See :oe:meth:`SetColorForceField<OEShape::OEOverlapPrepOptions::SetColorForceField>` method.

   .. _OEShape_OEOverlapPrepOptions_SetAssignBondiRadii:

   .. oe:method:: SetAssignBondiRadii

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAssignBondiRadii(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAssignBondiRadii(value: bool) -> bool

      Sets if **Bondi Radii** should be assigned. If true, Bondi radii 
      would be assigned to all atoms during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`. 
      Default: `False`.

   .. _OEShape_OEOverlapPrepOptions_SetAssignColor:

   .. oe:method:: SetAssignColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAssignColor(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAssignColor(value: bool) -> bool

      Sets if **color atoms** should be assigned. If true, color atoms would be 
      assigned during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`.
      Color atoms are only assigned to molecules that currently do not have any color atoms.
      To re-assign color atoms to all molecules, use :oe:meth:`SetRemoveColor<OEShape::OEOverlapPrepOptions::SetRemoveColor>` 
      to `True`. Default: `True`.

   .. _OEShape_OEOverlapPrepOptions_SetRemoveColor:

   .. oe:method:: SetRemoveColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRemoveColor(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRemoveColor(value: bool) -> bool

      Sets if existing color atoms should be removed. If true, existing color atoms
      are removed during :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`. Default: `False`.

   .. _OEShape_OEOverlapPrepOptions_SetDuplicateDistance:

   .. oe:method:: SetDuplicateDistance

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDuplicateDistance(const float)

      .. oe:language:: python

         .. oe:api:: python

            SetDuplicateDistance(value: float) -> bool

      Sets the threshold distance for duplicate removal of color atoms. The acceptable 
      range is between `0.0` and `1.0`. Default `0.0`.

   .. _OEShape_OEOverlapPrepOptions_SetRemoveDuplicate:

   .. oe:method:: SetRemoveDuplicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRemoveDuplicate(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRemoveDuplicate(value: bool) -> bool

      Sets if duplicate color atoms should be removed. Default `True`.

   .. _OEShape_OEOverlapPrepOptions_SetUseHydrogens:

   .. oe:method:: SetUseHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseHydrogens(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseHydrogens(value: bool) -> bool

      Sets if explicit hydrogen atoms should be used. If true, explicit hydrogen atoms would be
      created during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`. If false, all hydrogen
      atoms would be removed. Default `False`.

   .. _OEShape_OEOverlapPrepOptions_ColorForceField:

   .. oe:method:: SetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorForceField(const OEColorForceField&)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceField(value: OEColorForceField) -> bool

      Sets the color force field to be used. By default, the `ImplicitMillsDean`
      color force field is used.

   .. _OEShape_OEOverlapPrepOptions_AddDuplicateSmarts:

   .. oe:method:: AddDuplicateSmarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddDuplicateSmarts(const std::string& smarts)

      .. oe:language:: python

         .. oe:api:: python

            AddDuplicateSmarts(smarts: str) -> bool

      Adds a SMARTS pattern used to identify duplicate color atoms.
      Returns `false` if the SMARTS pattern already exists in the list, `true` otherwise.
      By default, SMARTS patterns for Cubane and Adamantane are included.

   .. _OEShape_OEOverlapPrepOptions_GetDuplicateSmarts:

   .. oe:method:: GetDuplicateSmarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<std::string>& GetDuplicateSmarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetDuplicateSmarts() -> OEStringVector

      Returns the list of SMARTS patterns used for identifying duplicate color atoms.
      See :oe:meth:`AddDuplicateSmarts<OEShape::OEOverlapPrepOptions::AddDuplicateSmarts>` method.

   .. _OEShape_OEOverlapPrepOptions_ClearDuplicateSmarts:

   .. oe:method:: ClearDuplicateSmarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ClearDuplicateSmarts()

      .. oe:language:: python

         .. oe:api:: python

            ClearDuplicateSmarts() -> bool

      Removes all SMARTS patterns from the duplicate detection list.
      See :oe:meth:`AddDuplicateSmarts<OEShape::OEOverlapPrepOptions::AddDuplicateSmarts>` method.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlapResults, OverlapResults

.. _OEShape_OEOverlapResults:

.. oe:class:: OEOverlapResults

   .. oe:api::

      struct OEOverlapResults

   This class represents overlap calculation results between a reference and a fit object.

   The :ref:`OEOverlapResults <OEShape_OEOverlapResults>` class defines the following public methods:
    * :oe:meth:`GetColorScore<OEShape::OEOverlapResults::GetColorScore>`
    * :oe:meth:`GetColorTanimoto<OEShape::OEOverlapResults::GetColorTanimoto>` 
    * :oe:meth:`GetColorTversky<OEShape::OEOverlapResults::GetColorTversky>`
    * :oe:meth:`GetFitColorTversky<OEShape::OEOverlapResults::GetFitColorTversky>` 
    * :oe:meth:`GetFitSelfColor<OEShape::OEOverlapResults::GetFitSelfColor>`
    * :oe:meth:`GetFitSelfOverlap<OEShape::OEOverlapResults::GetFitSelfOverlap>`
    * :oe:meth:`GetFitTversky<OEShape::OEOverlapResults::GetFitTversky>` 
    * :oe:meth:`GetFitTverskyCombo<OEShape::OEOverlapResults::GetFitTverskyCombo>`
    * :oe:meth:`GetOverlap<OEShape::OEOverlapResults::GetOverlap>`
    * :oe:meth:`GetRefColorTversky<OEShape::OEOverlapResults::GetRefColorTversky>` 
    * :oe:meth:`GetRefSelfColor<OEShape::OEOverlapResults::GetRefSelfColor>`
    * :oe:meth:`GetRefSelfOverlap<OEShape::OEOverlapResults::GetRefSelfOverlap>`
    * :oe:meth:`GetRefTversky<OEShape::OEOverlapResults::GetRefTversky>` 
    * :oe:meth:`GetRefTverskyCombo<OEShape::OEOverlapResults::GetRefTverskyCombo>`
    * :oe:meth:`GetTanimoto<OEShape::OEOverlapResults::GetTanimoto>`
    * :oe:meth:`GetTanimotoCombo<OEShape::OEOverlapResults::GetTanimotoCombo>` 
    * :oe:meth:`GetTversky<OEShape::OEOverlapResults::GetTversky>`

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOverlapResults()
            OEOverlapResults(const OEOverlapResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEOverlapResults() -> OEOverlapResults
            OEOverlapResults(rhs: OEOverlapResults) -> OEOverlapResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOverlapResults &operator=(const OEOverlapResults &)

      Assignment operator.

   .. oe:method:: GetColorScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetColorScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorScore() -> float

      Returns the color score (overlap) between the reference and the fit.

   .. oe:method:: GetColorTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetColorTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorTanimoto() -> float

      Returns the color tanimoto.

   .. oe:method:: GetColorTversky

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetColorTversky(float alpha = 0.95f, float beta = 0.05f) const

      .. oe:language:: python

         .. oe:api:: python

            GetColorTversky(alpha: float = 0.95, beta: float = 0.05) -> float

      Returns the color tversky with the specified alpha and beta.

   .. oe:method:: GetFitColorTversky

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetFitColorTversky() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitColorTversky() -> float

      Returns the color tversky with beta = 0.95.

   .. oe:method:: GetFitSelfColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetFitSelfColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitSelfColor() -> float

      Returns the self color score for the fit molecule.

   .. oe:method:: GetFitSelfOverlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetFitSelfOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitSelfOverlap() -> float

      Returns the self shape overlap for the fit molecule.

   .. oe:method:: GetFitTversky

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetFitTversky() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitTversky() -> float

      Returns the shape tversky with beta = 0.95.

   .. oe:method:: GetFitTverskyCombo

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetFitTverskyCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitTverskyCombo() -> float

      Returns the sum of shape tversky with beta = 0.95, and the color tversky with beta = 0.95.

   .. oe:method:: GetOverlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlap() -> float

      Returns the shape overlap between the reference and the fit.

   .. oe:method:: GetRefColorTversky

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetRefColorTversky() const
            Returns the color tversky with alpha = 0.95.

      .. oe:language:: python

         .. oe:api:: python

            GetRefColorTversky() -> float

   .. oe:method:: GetRefSelfColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetRefSelfColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefSelfColor() -> float

      Returns the self color score for the reference object.

   .. oe:method:: GetRefSelfOverlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetRefSelfOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefSelfOverlap() -> float

      Returns the self shape overlap for the reference object.

   .. oe:method:: GetRefTversky

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetRefTversky() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefTversky() -> float

      Returns the shape tversky with alpha = 0.95.

   .. oe:method:: GetRefTverskyCombo

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetRefTverskyCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefTverskyCombo() -> float

      Returns the sum of shape tversky with alpha = 0.95, and color tversky with alpha = 0.95.

   .. oe:method:: GetTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimoto() -> float

      Returns the shape tanimoto.

   .. oe:method:: GetTanimotoCombo

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTanimotoCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimotoCombo() -> float

      Returns the sum of shape tanimoto and color tanimoto.

   .. oe:method:: GetTversky

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTversky(float alpha = 0.95f, float beta = 0.05f) const

      .. oe:language:: python

         .. oe:api:: python

            GetTversky(alpha: float = 0.95, beta: float = 0.05) -> float

      Returns the shape tversky with the specified alpha and beta.



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlay, Overlay

.. _OEShape_OEOverlay:

.. oe:class:: OEOverlay

   .. oe:api::

      class OEOverlay

   .. note::

      With the default settings, the :ref:`OEOverlay <OEShape_OEOverlay>` optimizes
      both shape and color.

   The :ref:`OEOverlay <OEShape_OEOverlay>` defined an interface for overlap optimization
   between a reference object (a molecule, grid or a shape query) and a fit molecule 
   conformers.

   The :ref:`OEOverlay <OEShape_OEOverlay>` class defines the following public methods:
    * :oe:meth:`BestOverlay<OEShape::OEOverlay::BestOverlay>`
    * :oe:meth:`GetOverlayOptions<OEShape::OEOverlay::GetOverlayOptions>`
    * :oe:meth:`Overlay<OEShape::OEOverlay::Overlay>`
    * :oe:meth:`SetupRef<OEShape::OEOverlay::SetupRef>`
    * :oe:meth:`SortedOverlay<OEShape::OEOverlay::SortedOverlay>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOverlay(const OEOverlayOptions& opts = OEOverlayOptions())
            OEOverlay(const OEOverlay&)

      .. oe:language:: python

         .. oe:api:: python

            OEOverlay(opts: OEOverlayOptions = OEOverlayOptions()) -> OEOverlay
            OEOverlay(arg2: OEOverlay) -> OEOverlay

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOverlay &operator=(const OEOverlay &)

.. _OEShape_OEOverlay_BestOverlay:

      Assignment operator.

   .. oe:method:: BestOverlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool BestOverlay(OEBestOverlayScore& score, const OEChem::OEMCMolBase& fitmol,
            const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& pred = OEHighestTanimotoCombo())

      .. oe:language:: python

         .. oe:api:: python

            BestOverlay(score: OEBestOverlayScore, fitMol: OEMol,
                        pred: OEBestOverlayScoreSorterPred = OEHighestTanimotoCombo()) -> bool

      Method optimizes the overlay between the reference object and the fit
      molecule conformers, and returns the best result, sorted based on the binary predicate ``pred``.  
      The predicate has a default setting of
      :ref:`OEHighestTanimotoCombo <OEShape_OEHighestTanimotoCombo>`. The reference object must 
      be set using the :oe:meth:`SetupRef<OEShape::OEOverlay::SetupRef>` method, prior 
      to calling this method.

.. _OEShape_OEOverlay_GetOverlayOptions:

   .. oe:method:: GetOverlayOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEOverlayOptions& GetOverlayOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlayOptions() -> OEOverlayOptions

      Returns a reference to the :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>`
      instance as currently set. This defines options to calculate overlay.

.. _OEShape_OEOverlay_Overlay:

   .. oe:method:: Overlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBestOverlayResults>* Overlay(const OEChem::OEMCMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            Overlay(fitMol: OEMol) -> Iterable[OEBestOverlayResults]

      Method optimizes the overlay between the reference object and the fit
      molecule conformers.  The reference object must be set using the
      :oe:meth:`SetupRef<OEShape::OEOverlay::SetupRef>` method, prior 
      to calling this method.

      .. seealso::

        * :oe:meth:`BestOverlay<OEShape::OEOverlay::BestOverlay>`
        * :oe:meth:`SortedOverlay<OEShape::OEOverlay::SortedOverlay>`

.. _OEShape_OEOverlay_SetupRef:

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEChem::OEMolBase&)
            bool SetupRef(const OESystem::OEScalarGrid&)
            bool SetupRef(const OEShapeQuery&)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(argRefMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            SetupRef(argRefGrid: OEScalarGrid) -> bool
            SetupRef(argQuery: OEShapeQuery) -> bool

      These method defines the interface for setting up the reference system for the 
      :ref:`OEOverlay <OEShape_OEOverlay>` instance with a molecule, grid or a shape query.

.. _OEShape_OEOverlay_SortedOverlay:

   .. oe:method:: SortedOverlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEBestOverlayScore>* SortedOverlay(const OEChem::OEMCMolBase& fitmol,
                                                                    const unsigned maxHits,
                                                                    const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& pred = OEHighestTanimotoCombo())

      .. oe:language:: python

         .. oe:api:: python

            SortedOverlay(fitmol: OEMol, maxHits: int,
                          pred: OEBestOverlayScoreSorterPred = OEHighestTanimotoCombo()) -> Iterable[OEBestOverlayScore]

      Method optimizes the overlay between the reference object and the fit
      molecule conformers, and returns the desired number of top hits defined by ``maxHits``,
      sorted based on the binary predicate ``pred``. The predicate has a default setting of
      :ref:`OEHighestTanimotoCombo <OEShape_OEHighestTanimotoCombo>`. The reference object must 
      be set using the :oe:meth:`SetupRef<OEShape::OEOverlay::SetupRef>` method, prior 
      to calling this method.

      This method is specifically preferred over the :oe:meth:`Overlay<OEShape::OEOverlay::Overlay>`
      method when working with molecules containing a large number of conformers, as the
      burden to store all the results associated with all the conformers can stress the memory
      limits of a machine.



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlayOptions, OverlayOptions

.. _OEShape_OEOverlayOptions:

.. oe:class:: OEOverlayOptions

   .. oe:api::

      class OEOverlayOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for :ref:`OEOverlay <OEShape_OEOverlay>`.
   
   The :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>` class defines the following public methods:
    * :oe:meth:`GetColorFuncType<OEShape::OEOverlayOptions::GetColorFuncType>` and
      :oe:meth:`SetColorFuncType<OEShape::OEOverlayOptions::SetColorFuncType>`
    * :oe:meth:`GetColorOptions<OEShape::OEOverlayOptions::GetColorOptions>` and
      :oe:meth:`SetColorOptions<OEShape::OEOverlayOptions::SetColorOptions>`
    * :oe:meth:`GetMaxOptSteps<OEShape::OEOverlayOptions::GetMaxOptSteps>` and
      :oe:meth:`SetMaxOptSteps<OEShape::OEOverlayOptions::SetMaxOptSteps>`
    * :oe:meth:`GetOverlapFunc<OEShape::OEOverlayOptions::GetOverlapFunc>` and
      :oe:meth:`SetOverlapFunc<OEShape::OEOverlayOptions::SetOverlapFunc>`
    * :oe:meth:`GetShapeFuncType<OEShape::OEOverlayOptions::GetShapeFuncType>` and
      :oe:meth:`SetShapeFuncType<OEShape::OEOverlayOptions::SetShapeFuncType>`
    * :oe:meth:`GetShapeOptions<OEShape::OEOverlayOptions::GetShapeOptions>` and
      :oe:meth:`SetShapeOptions<OEShape::OEOverlayOptions::SetShapeOptions>`
    * :oe:meth:`GetStarts<OEShape::OEOverlayOptions::GetStarts>` and 
      :oe:meth:`SetStarts<OEShape::OEOverlayOptions::SetStarts>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOverlayOptions(const bool loadColorFF = true)
            OEOverlayOptions(const OEOverlayOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEOverlayOptions(loadColorFF: bool = True) -> OEOverlayOptions
            OEOverlayOptions(argOptions: OEOverlayOptions) -> OEOverlayOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOverlayOptions &operator=(const OEOverlayOptions &)

.. _OEShape_OEOverlayOptions_GetColorFuncType:

      Assignment operator.

   .. oe:method:: GetColorFuncType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetColorFuncType() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorFuncType() -> int

      See :oe:meth:`SetColorFuncType<OEShape::OEOverlayOptions::SetColorFuncType>` method.

.. _OEShape_OEOverlayOptions_GetColorOptions:

   .. oe:method:: GetColorOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorOptions& GetColorOptions()
            const OEColorOptions& GetColorOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorOptions() -> OEColorOptions

      See :oe:meth:`SetColorOptions<OEShape::OEOverlayOptions::SetColorOptions>` method.

.. _OEShape_OEOverlayOptions_GetMaxOptSteps:

   .. oe:method:: GetMaxOptSteps

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxOptSteps() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxOptSteps() -> int

      See :oe:meth:`SetMaxOptSteps<OEShape::OEOverlayOptions::SetMaxOptSteps>` method.

.. _OEShape_OEOverlayOptions_GetOverlapFunc:

   .. oe:method:: GetOverlapFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEOverlapFuncBase& GetOverlapFunc() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlapFunc() -> OEOverlapFuncBase

      See :oe:meth:`SetOverlapFunc<OEShape::OEOverlayOptions::SetOverlapFunc>` method.

.. _OEShape_OEOverlayOptions_GetShapeFuncType:

   .. oe:method:: GetShapeFuncType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetShapeFuncType() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeFuncType() -> int

      See :oe:meth:`SetShapeFuncType<OEShape::OEOverlayOptions::SetShapeFuncType>` method.

.. _OEShape_OEOverlayOptions_GetShapeOptions:

   .. oe:method:: GetShapeOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeOptions& GetShapeOptions()
            const OEShapeOptions& GetShapeOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeOptions() -> OEShapeOptions

      See :oe:meth:`SetShapeOptions<OEShape::OEOverlayOptions::SetShapeOptions>` method.

.. _OEShape_OEOverlayOptions_GetStarts:

   .. oe:method:: GetStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEStarts& GetStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetStarts() -> OEStarts

      See :oe:meth:`SetStarts<OEShape::OEOverlayOptions::SetStarts>` method.

.. _OEShape_OEOverlayOptions_SetColorFuncType:

   .. oe:method:: SetColorFuncType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorFuncType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetColorFuncType(value: int) -> bool

      Set the **type of color func** to be used for estimating color scores, as
      defined in the :oe:constns:`OEShape::OEColorType` namespace.
      **Default:** :oe:const:`OEShape::OEColorType::Exact`.

.. _OEShape_OEOverlayOptions_SetColorOptions:

   .. oe:method:: SetColorOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColorOptions(const OEColorOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetColorOptions(opts: OEColorOptions) -> None

      Sets :oe:cls:`options<OEShape::OEColorOptions>` related to color functions used.

.. _OEShape_OEOverlayOptions_SetMaxOptSteps:

   .. oe:method:: SetMaxOptSteps

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxOptSteps(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxOptSteps(value: int) -> bool

      Set the **maximum number of optimization** iteration steps.
      **Default: 200**

.. _OEShape_OEOverlayOptions_SetOverlapFunc:

   .. oe:method:: SetOverlapFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOverlapFunc(const OEOverlapFuncBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetOverlapFunc(func: OEOverlapFuncBase) -> bool

      Set the overlap function by by passing in an :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
      instance. This defines the shape/color interactions to be optimized
      for overlay.

.. _OEShape_OEOverlayOptions_SetShapeFuncType:

   .. oe:method:: SetShapeFuncType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetShapeFuncType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeFuncType(value: int) -> bool

      Set the **type of shape func** to be used for estimating shape overlap, as
      defined in the :oe:constns:`OEShape::OEShapeType` namespace.
      **Default:** :oe:const:`OEShape::OEShapeType::Grid`.

.. _OEShape_OEOverlayOptions_SetShapeOptions:

   .. oe:method:: SetShapeOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetShapeOptions(const OEShapeOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeOptions(opts: OEShapeOptions) -> None

      Sets :oe:cls:`options<OEShape::OEShapeOptions>` related to shape functions used.

.. _OEShape_OEOverlayOptions_Starts:

   .. oe:method:: SetStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStarts(const OEStarts&)

      .. oe:language:: python

         .. oe:api:: python

            SetStarts(argStarts: OEStarts) -> None

      Set the starts by by passing in an :ref:`OEStarts <OEShape_OEStarts>`
      instance. This defines the starts to be used for optimization.

   



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlayScoreCutoff, OverlayScoreCutoff

.. _OEShape_OEOverlayScoreCutoff:

.. oe:class:: OEOverlayScoreCutoff

   .. oe:api::

      class OEOverlayScoreCutoff : public OESystem::OEUnaryPredicate<OEBestOverlayScore>

   The :ref:`OEOverlayScoreCutoff <OEShape_OEOverlayScoreCutoff>` is an abstract base class. This class defines
   an interface specifying cutoff criteria for finding :ref:`OEROCS <OEShape_OEROCS>` hits.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:
    * :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`

   The :ref:`OEOverlayScoreCutoff <OEShape_OEOverlayScoreCutoff>` class defines the following public methods:
    * :oe:meth:`operator()<OEShape::OEOverlayScoreCutoff::operator()>`  
    * :oe:meth:`CreateCopy<OEShape::OEOverlayScoreCutoff::CreateCopy>`
  

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore&) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(score: OEBestOverlayScore) -> bool

      Method returns `True` if the specified score satisfies the cutoff criteria.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEBestOverlayScore, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEOverlayScoreCutoff

      Returns a new copied instance of this unary function.



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEQuatStarts, QuatStarts

.. _OEShape_OEQuatStarts:

.. oe:class:: OEQuatStarts

   .. oe:api::

      class OEQuatStarts : public OEInertialStarts

   The :ref:`OEQuatStarts <OEShape_OEQuatStarts>` represents the user defined
   quaternion starts for overlay optimization.  The :ref:`OEQuatStarts <OEShape_OEQuatStarts>`
   takes the user defined quaternions as the starts, with reference to the inertial 
   frame of the reference system.

   The following methods are publicly inherited from :ref:`OEStarts <OEShape_OEStarts>`:
    * :oe:meth:`CreateCopy<OEShape::OEStarts::CreateCopy>`  
    * :oe:meth:`GetNumOfStarts<OEShape::OEStarts::GetNumOfStarts>` 
    * :oe:meth:`GetStarts<OEShape::OEStarts::GetStarts>`
    * :oe:meth:`Setup<OEShape::OEStarts::Setup>`
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupFrame>` 
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupRef>`

   The following methods are publicly inherited from :ref:`OEInertialStarts <OEShape_OEInertialStarts>`:
    * :oe:meth:`GetSymmetryThreshold<OEShape::OEInertialStarts::GetSymmetryThreshold>`  
    * :oe:meth:`SetSymmetryThreshold<OEShape::OEInertialStarts::SetSymmetryThreshold>`

   The :ref:`OEQuatStarts <OEShape_OEQuatStarts>` class defines the following public methods:
    * :oe:meth:`ClearStarts<OEShape::OEQuatStarts::ClearStarts>`  
    * :oe:meth:`SetStarts<OEShape::OEQuatStarts::SetStarts>`  

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEQuatStarts()
            OEQuatStarts(const OEQuatStarts&)

      .. oe:language:: python

         .. oe:api:: python

            OEQuatStarts() -> OEQuatStarts
            OEQuatStarts(arg2: OEQuatStarts) -> OEQuatStarts

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEQuatStarts &operator=(const OEQuatStarts &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: ClearStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearStarts()

      .. oe:language:: python

         .. oe:api:: python

            ClearStarts() -> None

      Clears the currently specified starts.

   .. oe:method:: SetStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStarts(const double* Quats, unsigned int NumQuats)

      .. oe:language:: python

         .. oe:api:: python

            SetStarts(argQuats: OEDoubleArray, argNumStarts: int) -> None

      Sets the starting quaternions. Method expects an array of size
      7*NumQuats for the first argument.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEROCS, ROCS

.. _OEShape_OEROCS:

.. oe:class:: OEROCS

   .. oe:api::

      class OEROCS

   The :ref:`OEROCS <OEShape_OEROCS>` defines an interface for finding ROCS hits
   from a search database, by overlaying a reference object (a molecule, grid or a shape query) .

   The :ref:`OEROCS <OEShape_OEROCS>` class defines the following public methods:
    * :oe:meth:`AddMolecule<OEShape::OEROCS::AddMolecule>`
    * :oe:meth:`ClearMolecules<OEShape::OEROCS::ClearMolecules>` 
    * :oe:meth:`GetROCSOptions<OEShape::OEROCS::GetROCSOptions>`
    * :oe:meth:`SetDatabase<OEShape::OEROCS::SetDatabase>`
    * :oe:meth:`Overlay<OEShape::OEROCS::Overlay>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEROCS(const OEROCSOptions& argOptions = OEROCSOptions())
            OEROCS(const OEROCS&)

      .. oe:language:: python

         .. oe:api:: python

            OEROCS(argOptions: OEROCSOptions = OEROCSOptions()) -> OEROCS

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEROCS &operator=(const OEROCS &)

      Assignment operator.

   .. oe:method:: AddMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int AddMolecule(const OEChem::OEMCMolBase& argMol)

      .. oe:language:: python

         .. oe:api:: python

            AddMolecule(argMol: OEMol) -> int

      Adds a copy of the specified molecule to the search database.  Returns the index of the
      molecule in the search database.

   .. oe:method:: ClearMolecules

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearMolecules()

      .. oe:language:: python

         .. oe:api:: python

            ClearMolecules() -> None

      Remove all molecules and clear the search database.

   .. oe:method:: GetROCSOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEROCSOptions& GetROCSOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetROCSOptions() -> OEROCSOptions

      Returns a reference to the :ref:`OEROCSOptions <OEShape_OEROCSOptions>`
      instance as currently set. This defines options to perform
      :ref:`OEROCS <OEShape_OEROCS>` calculations.

   .. oe:method:: SetDatabase

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDatabase(const OEChem::OEMolDatabase&)
            bool SetDatabase(OEChem::oemolistream&)

      .. oe:language:: python

         .. oe:api:: python

            SetDatabase(argDatabase: OEMolDatabase) -> bool
            SetDatabase(argStream: oemolistream) -> bool

      Sets the search database with molecules from specified database or file stream.  
      These methods cleans up any previous existing content of the search database.

   .. oe:method:: Overlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEROCSResult>* Overlay(const OEChem::OEMolBase&)
            OESystem::OEIterBase<OEROCSResult>* Overlay(const OEChem::OEMCMolBase&)
            OESystem::OEIterBase<OEROCSResult>* Overlay(const OESystem::OEScalarGrid&)
            OESystem::OEIterBase<OEROCSResult>* Overlay(const OEShapeQuery&)

      .. oe:language:: python

         .. oe:api:: python

            Overlay(argRefMol: Union[OEGraphMol,OEQMol]) -> Iterable[OEROCSResult]
            Overlay(argRefMol: OEMol) -> Iterable[OEROCSResult]
            Overlay(arg1: OEScalarGrid) -> Iterable[OEROCSResult]
            Overlay(argQuery: OEShapeQuery) -> Iterable[OEROCSResult]

      Method optimizes the overlay between the reference object and the molecule conformers
      in the search database.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEROCSOptions, ROCSOptions

.. _OEShape_OEROCSOptions:

.. oe:class:: OEROCSOptions

   .. oe:api::

      class OEROCSOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for :ref:`OEROCS <OEShape_OEROCS>`.
   
   The :ref:`OEROCSOptions <OEShape_OEROCSOptions>` class defines the following public methods:
    * :oe:meth:`AddCutoff<OEShape::OEROCSOptions::AddCutoff>`
    * :oe:meth:`ClearCutoffs<OEShape::OEROCSOptions::ClearCutoffs>`
    * :oe:meth:`GetConfsPerHit<OEShape::OEROCSOptions::GetConfsPerHit>`
    * :oe:meth:`GetMaxHits<OEShape::OEROCSOptions::GetMaxHits>`
    * :oe:meth:`GetNumBestHits<OEShape::OEROCSOptions::GetNumBestHits>`
    * :oe:meth:`GetOverlayOptions<OEShape::OEROCSOptions::GetOverlayOptions>`
    * :oe:meth:`GetPerformPrep<OEShape::OEROCSOptions::GetPerformPrep>`
    * :oe:meth:`GetRankPredicate<OEShape::OEROCSOptions::GetRankPredicate>`
    * :oe:meth:`GetUseMaxHits<OEShape::OEROCSOptions::GetUseMaxHits>`
    * :oe:meth:`HasCutoff<OEShape::OEROCSOptions::HasCutoff>`
    * :oe:meth:`MeetsCutoff<OEShape::OEROCSOptions::MeetsCutoff>`
    * :oe:meth:`SetConfsPerHit<OEShape::OEROCSOptions::SetConfsPerHit>`
    * :oe:meth:`SetMaxHits<OEShape::OEROCSOptions::SetMaxHits>`
    * :oe:meth:`SetNumBestHits<OEShape::OEROCSOptions::SetNumBestHits>`
    * :oe:meth:`SetOverlayOptions<OEShape::OEROCSOptions::SetOverlayOptions>`
    * :oe:meth:`SetPerformPrep<OEShape::OEROCSOptions::SetPerformPrep>`
    * :oe:meth:`SetRankPredicate<OEShape::OEROCSOptions::SetRankPredicate>`
    * :oe:meth:`SetUseMaxHits<OEShape::OEROCSOptions::SetUseMaxHits>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEROCSOptions()
            OEROCSOptions(const OEROCSOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEROCSOptions() -> OEROCSOptions
            OEROCSOptions(argRocs: OEROCSOptions) -> OEROCSOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEROCSOptions &operator=(const OEROCSOptions &)

      Assignment operator.

   .. oe:method:: AddCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddCutoff(const OESystem::OEUnaryPredicate<OEBestOverlayScore>&)

      .. oe:language:: python

         .. oe:api:: python

            AddCutoff(argPred: OEOverlayScoreCutoffPred) -> None

      Add a new cutoff criteria for scanning if a hit is acceptable. Multiple
      cutoff criteria can used for a single :ref:`OEROCS <OEShape_OEROCS>` calculation.

   .. oe:method:: ClearCutoffs

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearCutoffs()

      .. oe:language:: python

         .. oe:api:: python

            ClearCutoffs() -> None

      Remove all currently defined cutoffs.

   .. oe:method:: GetConfsPerHit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetConfsPerHit() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfsPerHit() -> int

      Returns the current value for the desired number of conformers to be kept
      per hit in the :ref:`OEROCSResult <OEShape_OEROCSResult>` in a :ref:`OEROCS <OEShape_OEROCS>`
      calculation.

   .. oe:method:: GetMaxHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHits() -> int

      Returns the current value of the maximum number of hits to be looked for 
      in a :ref:`OEROCS <OEShape_OEROCS>` calculation, based on cutoffs.

   .. oe:method:: GetNumBestHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumBestHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumBestHits() -> int

      Returns the current value of the maximum number of best hit results to be 
      returned from a :ref:`OEROCS <OEShape_OEROCS>` calculation.

   .. oe:method:: GetOverlayOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEOverlayOptions& GetOverlayOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlayOptions() -> OEOverlayOptions

      Returns an instance of the :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>` as currently set
      for overlay optimization. These options are used in overlay optimization of conformers.

   .. oe:method:: GetPerformPrep

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerformPrep() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerformPrep() -> bool

      Returns the current state of the perform prep flag.  This flag defines if the reference
      and fit molecules should be prepared (or used as is), before :ref:`OEROCS <OEShape_OEROCS>`
      calculations.

   .. oe:method:: GetRankPredicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& GetRankPredicate()

      .. oe:language:: python

         .. oe:api:: python

            GetRankPredicate() -> OEBestOverlayScoreSorterPred

      Returns an instance of the binary predicate as currently set
      for ranking the obtained hits.

   .. oe:method:: GetUseMaxHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseMaxHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseMaxHits() -> bool

      Returns the current state of the use max hits flag.  This flag defines if a
      :ref:`OEROCS <OEShape_OEROCS>` calculation should be terminated when the defined maximum hits
      is reached.

   .. oe:method:: HasCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            HasCutoff() -> bool

      Returns `True` if any cutoffs are currently set, `False` otherwise.

   .. oe:method:: MeetsCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool MeetsCutoff(const OEBestOverlayScore&) const

      .. oe:language:: python

         .. oe:api:: python

            MeetsCutoff(argScore: OEBestOverlayScore) -> bool

      Returns `True` if the specified score meets the cutoffs criterion
      currently set, `False` otherwise.

   .. oe:method:: SetConfsPerHit

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetConfsPerHit(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetConfsPerHit(value: int) -> bool

      Sets the value for the desired number of conformers to be kept
      per hit in the :ref:`OEROCSResult <OEShape_OEROCSResult>` in a :ref:`OEROCS <OEShape_OEROCS>`
      calculation. Default: 1.
   
   .. oe:method:: SetMaxHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxHits(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHits(value: int) -> bool

      Sets the value of the maximum number of hits to be looked for 
      in a :ref:`OEROCS <OEShape_OEROCS>` calculation, based on cutoffs. Default: 500.

   .. oe:method:: SetNumBestHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNumBestHits(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetNumBestHits(value: int) -> bool

      Sets the value of the maximum number of best hit results to be 
      returned from a :ref:`OEROCS <OEShape_OEROCS>` calculation. Default: 500.

   .. oe:method:: SetOverlayOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOverlayOptions(const OEOverlayOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetOverlayOptions(opts: OEOverlayOptions) -> None

      Sets the :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>` for overlay optimization.
      These options are used in overlay optimization of conformers.

   .. oe:method:: SetPerformPrep

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerformPrep(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerformPrep(value: bool) -> bool

      Sets the state of the perform prep flag.  This flag defines if the reference
      and fit molecules should be prepared (or used as is), before :ref:`OEROCS <OEShape_OEROCS>`
      calculations. Default: `True`.

   .. oe:method:: SetRankPredicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRankPredicate(const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>&)

      .. oe:language:: python

         .. oe:api:: python

            SetRankPredicate(argPred: OEBestOverlayScoreSorterPred) -> None

      Sets the binary predicate to be used for ranking the obtained hits.

   .. oe:method:: SetUseMaxHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseMaxHits(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseMaxHits(value: bool) -> bool

      Sets the state of the use max hits flag.  This flag defines if a
      :ref:`OEROCS <OEShape_OEROCS>` calculation should be terminated when the defined maximum hits
      is reached. Default: `False`.



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEROCSResult, ROCSResult

.. _OEShape_OEROCSResult:

.. oe:class:: OEROCSResult

   .. oe:api::

      class OEROCSResult : public OEOverlapResults

   This class extends the :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` to represent the results of
   a single :ref:`OEROCS <OEShape_OEROCS>` calculation.

   The following methods are publicly inherited from :ref:`OEOverlapResults <OEShape_OEOverlapResults>`:
    * :oe:meth:`GetColorScore<OEShape::OEOverlapResults::GetColorScore>`
    * :oe:meth:`GetColorTanimoto<OEShape::OEOverlapResults::GetColorTanimoto>` 
    * :oe:meth:`GetColorTversky<OEShape::OEOverlapResults::GetColorTversky>`
    * :oe:meth:`GetFitColorTversky<OEShape::OEOverlapResults::GetFitColorTversky>` 
    * :oe:meth:`GetFitSelfColor<OEShape::OEOverlapResults::GetFitSelfColor>`
    * :oe:meth:`GetFitSelfOverlap<OEShape::OEOverlapResults::GetFitSelfOverlap>`
    * :oe:meth:`GetFitTversky<OEShape::OEOverlapResults::GetFitTversky>` 
    * :oe:meth:`GetFitTverskyCombo<OEShape::OEOverlapResults::GetFitTverskyCombo>`
    * :oe:meth:`GetOverlap<OEShape::OEOverlapResults::GetOverlap>`
    * :oe:meth:`GetRefColorTversky<OEShape::OEOverlapResults::GetRefColorTversky>` 
    * :oe:meth:`GetRefSelfColor<OEShape::OEOverlapResults::GetRefSelfColor>`
    * :oe:meth:`GetRefSelfOverlap<OEShape::OEOverlapResults::GetRefSelfOverlap>`
    * :oe:meth:`GetRefTversky<OEShape::OEOverlapResults::GetRefTversky>` 
    * :oe:meth:`GetRefTverskyCombo<OEShape::OEOverlapResults::GetRefTverskyCombo>`
    * :oe:meth:`GetTanimoto<OEShape::OEOverlapResults::GetTanimoto>`
    * :oe:meth:`GetTanimotoCombo<OEShape::OEOverlapResults::GetTanimotoCombo>` 
    * :oe:meth:`GetTversky<OEShape::OEOverlapResults::GetTversky>`

   The following methods are publicly inherited from :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>`:
    * :oe:meth:`GetFitConfIdx<OEShape::OEBestOverlayScore::GetFitConfIdx>`
    * :oe:meth:`GetRefConfIdx<OEShape::OEBestOverlayScore::GetRefConfIdx>` 
    * :oe:meth:`GetRotMatrix<OEShape::OEBestOverlayScore::GetRotMatrix>`
    * :oe:meth:`GetTranslation<OEShape::OEBestOverlayScore::GetTranslation>` 
    * :oe:meth:`Transform<OEShape::OEBestOverlayScore::Transform>`

   The :ref:`OEROCSResult <OEShape_OEROCSResult>` class defines the following public methods:
    * :oe:meth:`AddScore<OEShape::OEROCSResult::AddScore>`
    * :oe:meth:`GetOverlayConf<OEShape::OEROCSResult::GetOverlayConf>` 
    * :oe:meth:`GetOverlayConfs<OEShape::OEROCSResult::GetOverlayConfs>`
    
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEROCSResult()
            OEROCSResult(const OEBestOverlayScore&, const OEChem::OEMCMolBase&)
            OEROCSResult(const OEROCSResult&)

      .. oe:language:: python

         .. oe:api:: python

            OEROCSResult() -> OEROCSResult
            OEROCSResult(argScore: OEBestOverlayScore, argFitMol: OEMol) -> OEROCSResult
            OEROCSResult(argResult: OEROCSResult) -> OEROCSResult

      Default and copy constructors. The second constructor takes in an instance of a
      :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` and the corresponding fit molecule.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEROCSResult &operator=(const OEROCSResult&)

      Assignment operator.

   .. oe:method:: AddScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddScore(const OEBestOverlayScore&, const OEChem::OEMCMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            AddScore(argScore: OEBestOverlayScore, argFitMol: OEMol) -> None

      Add a new conformer to the score.  This method is useful for generating a
      multi-conformer :ref:`OEROCSResult <OEShape_OEROCSResult>`.

   .. oe:method:: GetOverlayConf

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase& GetOverlayConf() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlayConf() -> OEGraphMol

      Returns the best hit conformer in the overlaid state.

   .. oe:method:: GetOverlayConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMCMolBase& GetOverlayConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlayConfs() -> OEMol

      Returns the best hit conformers in the overlaid state, for a multi-conformer result.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OERandomStarts, RandomStarts

.. _OEShape_OERandomStarts:

.. oe:class:: OERandomStarts

   .. oe:api::

      class OERandomStarts : public OEInertialStarts

   The :ref:`OERandomStarts <OEShape_OERandomStarts>` represents the random starts for
   overlay optimization.  The :ref:`OERandomStarts <OEShape_OERandomStarts>` translates
   the fit molecule to specified number of random starting points,
   followed by the inertial rotations to generate starts.

   The following methods are publicly inherited from :ref:`OEStarts <OEShape_OEStarts>`:
    * :oe:meth:`CreateCopy<OEShape::OEStarts::CreateCopy>`  
    * :oe:meth:`GetNumOfStarts<OEShape::OEStarts::GetNumOfStarts>` 
    * :oe:meth:`GetStarts<OEShape::OEStarts::GetStarts>`
    * :oe:meth:`Setup<OEShape::OEStarts::Setup>` 
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupFrame>`
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupRef>`

   The following methods are publicly inherited from :ref:`OEInertialStarts <OEShape_OEInertialStarts>`:
    * :oe:meth:`GetSymmetryThreshold<OEShape::OEInertialStarts::GetSymmetryThreshold>`  
    * :oe:meth:`SetSymmetryThreshold<OEShape::OEInertialStarts::SetSymmetryThreshold>`

   The :ref:`OERandomStarts <OEShape_OERandomStarts>` class defines the following public methods:
    * :oe:meth:`GetMaxRandomTranslation<OEShape::OERandomStarts::GetMaxRandomTranslation>`  
    * :oe:meth:`GetNumRandomStarts<OEShape::OERandomStarts::GetNumRandomStarts>` 
    * :oe:meth:`GetRandomSeed<OEShape::OERandomStarts::GetRandomSeed>`
    * :oe:meth:`SetMaxRandomTranslation<OEShape::OERandomStarts::SetMaxRandomTranslation>`  
    * :oe:meth:`SetNumRandomStarts<OEShape::OERandomStarts::SetNumRandomStarts>` 
    * :oe:meth:`SetRandomSeed<OEShape::OERandomStarts::SetRandomSeed>` 

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERandomStarts()
            OERandomStarts(const OERandomStarts&)

      .. oe:language:: python

         .. oe:api:: python

            OERandomStarts() -> OERandomStarts
            OERandomStarts(arg2: OERandomStarts) -> OERandomStarts

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERandomStarts &operator=(const OERandomStarts &)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetMaxRandomTranslation

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMaxRandomTranslation() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxRandomTranslation() -> float

      Returns the maximum allowed translation value currently set.

   .. oe:method:: GetNumRandomStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumRandomStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumRandomStarts() -> int

      Returns the current value of the number of random starting points.

   .. oe:method:: GetRandomSeed

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRandomSeed() const

      .. oe:language:: python

         .. oe:api:: python

            GetRandomSeed() -> int

      Returns the current value of the seed for random number generation.

   .. oe:method:: SetMaxRandomTranslation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxRandomTranslation(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxRandomTranslation(argTrans: float) -> None

      Sets the maximum allowed translation for generating the starting points.
      Default: 2.0.

   .. oe:method:: SetNumRandomStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumRandomStarts() const

      .. oe:language:: python

         .. oe:api:: python

            SetNumRandomStarts(argNumStarts: int)

      Sets the number of random starting points to be generated. Default: 4.

   .. oe:method:: SetRandomSeed

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRandomSeed(const unsigned int argSeed)

      .. oe:language:: python

         .. oe:api:: python

            SetRandomSeed(argSeed: int) -> None

      Sets the seed for random number generation. Default: 0.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OERefColorTverskyCutoff, RefColorTverskyCutoff

.. _OEShape_OERefColorTverskyCutoff:

.. oe:class:: OERefColorTverskyCutoff

   .. oe:api::

      class OERefColorTverskyCutoff : public OEOverlayScoreCutoff

   The :ref:`OERefColorTverskyCutoff <OEShape_OERefColorTverskyCutoff>` defines cutoff based on the
   reference system color tversky.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:
    * :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`

   The following methods are publicly inherited from :ref:`OEOverlayScoreCutoff <OEShape_OEOverlayScoreCutoff>`:
    * :oe:meth:`operator()<OEShape::OEOverlayScoreCutoff::operator()>`  
    * :oe:meth:`CreateCopy<OEShape::OEOverlayScoreCutoff::CreateCopy>`
  

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERefColorTverskyCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            OERefColorTverskyCutoff(argCutoff: float) -> OERefColorTverskyCutoff

      Default and copy constructors. The argument expects the desired cutoff.  



.. oe:namespace:: OEShape

.. meta::
   :keywords: OERefTverskyComboCutoff, RefTverskyComboCutoff

.. _OEShape_OERefTverskyComboCutoff:

.. oe:class:: OERefTverskyComboCutoff

   .. oe:api::

      class OERefTverskyComboCutoff : public OEOverlayScoreCutoff

   The :ref:`OERefTverskyComboCutoff <OEShape_OERefTverskyComboCutoff>` defines cutoff based on the
   reference system combined shape and color tversky.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:
    * :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`

   The following methods are publicly inherited from :ref:`OEOverlayScoreCutoff <OEShape_OEOverlayScoreCutoff>`:
    * :oe:meth:`operator()<OEShape::OEOverlayScoreCutoff::operator()>`  
    * :oe:meth:`CreateCopy<OEShape::OEOverlayScoreCutoff::CreateCopy>`
  

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERefTverskyComboCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            OERefTverskyComboCutoff(argCutoff: float) -> OERefTverskyComboCutoff

      Default and copy constructors. The argument expects the desired cutoff.  



.. oe:namespace:: OEShape

.. meta::
   :keywords: OERefTverskyCutoff, RefTverskyCutoff

.. _OEShape_OERefTverskyCutoff:

.. oe:class:: OERefTverskyCutoff

   .. oe:api::

      class OERefTverskyCutoff : public OEOverlayScoreCutoff

   The :ref:`OERefTverskyCutoff <OEShape_OERefTverskyCutoff>` defines cutoff based on the
   reference system shape tversky.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:
    * :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`

   The following methods are publicly inherited from :ref:`OEOverlayScoreCutoff <OEShape_OEOverlayScoreCutoff>`:
    * :oe:meth:`operator()<OEShape::OEOverlayScoreCutoff::operator()>`  
    * :oe:meth:`CreateCopy<OEShape::OEOverlayScoreCutoff::CreateCopy>`
  

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERefTverskyCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            OERefTverskyCutoff(argCutoff: float) -> OERefTverskyCutoff

      Default and copy constructors. The argument expects the desired cutoff.  



*******************************************************************************
Preliminary OEShape Classes
*******************************************************************************

.. oe:namespace:: OEShape

.. toctree::

   OEShapeQueryOptions
   OEHermiteOverlayOptions
   OEHermiteOverlay


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeQueryOptions, ShapeQueryOptions

.. _OEShape_OEShapeQueryOptions:

.. oe:class:: OEShapeQueryOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEShapeQueryOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for :ref:`OEShapeQuery <OEShape_OEShapeQuery>` class.
   
   The :ref:`OEShapeQueryOptions <OEShape_OEShapeQueryOptions>` class defines the following public methods:
    * :ref:`GetRelativeGridContourVal<OEShape_OEShapeQueryOptions_GetRelativeGridContourVal>`
    * :ref:`GetShapeGaussianRadius<OEShape_OEShapeQueryOptions_GetShapeGaussianRadius>`
    * :ref:`GetColorGaussianRadius<OEShape_OEShapeQueryOptions_GetColorGaussianRadius>`
    * :ref:`GetScoreType<OEShape_OEShapeQueryOptions_GetScoreType>`
    * :ref:`SetRelativeGridContourVal<OEShape_OEShapeQueryOptions_SetRelativeGridContourVal>`
    * :ref:`SetShapeGaussianRadius<OEShape_OEShapeQueryOptions_SetShapeGaussianRadius>`
    * :ref:`SetColorGaussianRadius<OEShape_OEShapeQueryOptions_SetColorGaussianRadius>`
    * :ref:`SetScoreType<OEShape_OEShapeQueryOptions_SetScoreType>`

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeQueryOptions()
            OEShapeQueryOptions(const OEShapeQueryOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryOptions() -> OEShapeQueryOptions
            OEShapeQueryOptions(arg2: OEShapeQueryOptions) -> OEShapeQueryOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeQueryOptions &operator=(const OEShapeQueryOptions &)

      The assignment operator.

   .. _OEShape_OEShapeQueryOptions_GetRelativeGridContourVal:

      Assignment operator.

   .. oe:method:: GetRelativeGridContourVal

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRelativeGridContourVal() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelativeGridContourVal() -> float

      Returns the maximum relative (to maximum grid value of the input grid) grid contour value allowed for the Gaussians in the final result.

   .. _OEShape_OEShapeQueryOptions_GetShapeGaussianRadius:

   .. oe:method:: GetShapeGaussianRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetShapeGaussianRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeGaussianRadius() -> float

      Returns the radius of shape Gaussians used in the grid-to-Gaussians fit. The number 1.70 is the default for the carbon radius.

   .. _OEShape_OEShapeQueryOptions_GetColorGaussianRadius:

   .. oe:method:: GetColorGaussianRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetColorGaussianRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorGaussianRadius() -> float

      Returns the radius of color Gaussians used in the grid-to-Gaussians fit. The number 1.08 corresponds to the color Gaussian radius and is the default.

   .. _OEShape_OEShapeQueryOptions_GetScoreType:

   .. oe:method:: GetScoreType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetScoreType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreType() -> int

      Returns the grid score type via the namespace :oe:const:`OEShape::OEGridScoreType`, with possible values :oe:const:`OEShape::OEGridScoreType::CosAngle` and :oe:const:`OEShape::OEGridScoreType::Tanimoto`.

   .. _OEShape_OEShapeQueryOptions_SetRelativeGridContourVal:

   .. oe:method:: SetRelativeGridContourVal

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRelativeGridContourVal(double)

      .. oe:language:: python

         .. oe:api:: python

            SetRelativeGridContourVal(value: float) -> bool

      Sets the maximum relative (to maximum grid value of the input grid) grid contour value allowed for the Gaussians in the final result.

   .. _OEShape_OEShapeQueryOptions_SetShapeGaussianRadius:

   .. oe:method:: SetShapeGaussianRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetShapeGaussianRadius(double)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeGaussianRadius(value: float) -> bool

      Sets the radius of shape Gaussians used in the grid-to-Gaussians fit.

   .. _OEShape_OEShapeQueryOptions_SetColorGaussianRadius:

   .. oe:method:: SetColorGaussianRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorGaussianRadius(double)

      .. oe:language:: python

         .. oe:api:: python

            SetColorGaussianRadius(value: float) -> bool

      Sets the radius of color Gaussians used in the grid-to-Gaussians fit.

   .. _OEShape_OEShapeQueryOptions_SetScoreType:

   .. oe:method:: SetScoreType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetScoreType(unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreType(value: int) -> bool

      Sets the grid score type via the namespace :oe:const:`OEShape::OEGridScoreType`, with possible values :oe:const:`OEShape::OEGridScoreType::CosAngle` and :oe:const:`OEShape::OEGridScoreType::Tanimoto`.

   


.. _OEShapeClassesDpcr:

Deprecated OEShape Classes
**************************

.. oe:namespace:: OEShape

.. toctree::
   :maxdepth: 2

   OEBestOverlay
   OEColorOverlap
   OEColorResults
   OEHighestComboScore
   OEOverlap
   OEShapeQueryPublic


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeQueryPublic, ShapeQueryPublic

.. _OEShape_OEShapeQueryPublic:

.. oe:class:: OEShapeQueryPublic

   .. oe:api::

      class OEShapeQueryPublic

   Initial public implementation of a shape query with limited functionality.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeQueryPublic()
            OEShapeQueryPublic(const OEShapeQueryPublic &)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryPublic() -> OEShapeQueryPublic
            OEShapeQueryPublic(arg2: OEShapeQueryPublic) -> OEShapeQueryPublic

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeQueryPublic &operator=(const OEShapeQueryPublic &)

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns `true` if the instance is valid.  Otherwise returns false.

   .. oe:method:: GetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEColorForceField* GetColorForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceField() -> OEColorForceField

      Returns a pointer to its :ref:`OEColorForceField <OEShape_OEColorForceField>`

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Returns the title.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeFunc, ShapeFunc

.. _OEShape_OEShapeFunc:

.. oe:class:: OEShapeFunc

   .. oe:api::

      class OEShapeFunc : public OEOverlapFuncBase

   The :ref:`OEShapeFunc <OEShape_OEShapeFunc>` is an abstract base class. This class defines
   an interface for shape overlap calculation between a reference object and a fit molecule. 
   The :ref:`OEShapeFunc <OEShape_OEShapeFunc>` is a specialization of The :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
   for shape only overlap.

   .. _figure_OEShapeFunc_Hierarchy:

   .. figure:: shapetk/images/OEShapeFunc.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`  
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>` 
    * :oe:meth:`SetupFlex<OEShape::OEOverlapFuncBase::SetupFlex>`
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The :ref:`OEShapeFunc <OEShape_OEShapeFunc>` class defines the following public methods:
    * :oe:meth:`GetShapeOptions<OEShape::OEShapeFunc::GetShapeOptions>`

   The following classes derive from this class:
    * :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>`
    * :ref:`OEExactShapeFunc <OEShape_OEExactShapeFunc>`
    * :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeFunc & operator=(const OEShapeFunc & argFunc)

      Assignment operator.

   .. oe:method:: GetShapeOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEShapeOptions& GetShapeOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeOptions() -> OEShapeOptions

      Returns a reference to the :ref:`OEShapeOptions <OEShape_OEShapeOptions>`
      instance as currently set for this :ref:`OEShapeFunc <OEShape_OEShapeFunc>`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeGridOptions, ShapeGridOptions

.. _OEShape_OEShapeGridOptions:

.. oe:class:: OEShapeGridOptions

   .. oe:api::

      class OEShapeGridOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for calculations
   using the *Grid* method.
   
   The :ref:`OEShapeGridOptions <OEShape_OEShapeGridOptions>` class defines the following public methods:
    * :oe:meth:`GetDerivativeType<OEShape::OEShapeGridOptions::GetDerivativeType>`
    * :oe:meth:`GetGridSpacing<OEShape::OEShapeGridOptions::GetGridSpacing>`
    * :oe:meth:`SetDerivativeType<OEShape::OEShapeGridOptions::SetDerivativeType>`
    * :oe:meth:`SetGridSpacing<OEShape::OEShapeGridOptions::SetGridSpacing>` 
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeGridOptions()
            OEShapeGridOptions(const OEShapeGridOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeGridOptions() -> OEShapeGridOptions
            OEShapeGridOptions(arg2: OEShapeGridOptions) -> OEShapeGridOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeGridOptions &operator=(const OEShapeGridOptions &)

      Assignment operator.

   .. oe:method:: GetDerivativeType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetDerivativeType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDerivativeType() -> int

      Gets the current value of the derivative type to be used on *Grid* method.

   .. oe:method:: GetGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetGridSpacing() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridSpacing() -> float

      Gets the grid spacing to be used on *Grid* method.

   .. oe:method:: SetDerivativeType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDerivativeType(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetDerivativeType(value: int) -> bool

      Set the derivative type to be used on *Grid* method. The default is
      :oe:const:`OEShape::OEDerivativeType::NearestValue` for shape overlap
      and :oe:const:`OEShape::OEDerivativeType::Interpolated` for color overlap. 
      Alternatives are defined in the :oe:constns:`OEShape::OEDerivativeType` namespace.

   .. oe:method:: SetGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetGridSpacing(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetGridSpacing(value: float) -> bool

      Set the grid spacing to be used on *Grid* method. 
      By default this is set to 0.25 |A|.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeOptions, ShapeOptions

.. _OEShape_OEShapeOptions:

.. oe:class:: OEShapeOptions

   .. oe:api::

      class OEShapeOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for :ref:`OEShapeFunc <OEShape_OEShapeFunc>`
   calculations.
   
   The :ref:`OEShapeOptions <OEShape_OEShapeOptions>` class defines the following public methods:
    * :oe:meth:`GetCarbonRadius<OEShape::OEShapeOptions::GetCarbonRadius>`
    * :oe:meth:`GetRadiiApproximation<OEShape::OEShapeOptions::GetRadiiApproximation>` 
    * :oe:meth:`GetScoreType<OEShape::OEShapeOptions::GetScoreType>`
    * :oe:meth:`SetCarbonRadius<OEShape::OEShapeOptions::SetCarbonRadius>`
    * :oe:meth:`SetRadiiApproximation<OEShape::OEShapeOptions::SetRadiiApproximation>` 
    * :oe:meth:`SetScoreType<OEShape::OEShapeOptions::SetScoreType>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeOptions()
            OEShapeOptions(const OEShapeOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeOptions() -> OEShapeOptions
            OEShapeOptions(arg2: OEShapeOptions) -> OEShapeOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeOptions &operator=(const OEShapeOptions &)

      Assignment operator.

   .. oe:method:: GetCarbonRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCarbonRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetCarbonRadius() -> float

      Gets the radius value for the carbon radius approximation, associated with :oe:const:`OEShape::OEOverlapRadii::Carbon`.

   .. oe:method:: GetRadiiApproximation

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRadiiApproximation() const

      .. oe:language:: python

         .. oe:api:: python

            GetRadiiApproximation() -> int

      Gets the current value of the radii approximation.

   .. oe:method:: GetScoreType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetScoreType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreType() -> int

      Gets the current value of the score type of the function.

   .. oe:method:: SetCarbonRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCarbonRadius(double cradius)

      .. oe:language:: python

         .. oe:api:: python

            SetCarbonRadius(radius: float) -> bool

      Set the radius to use when using :oe:const:`OEShape::OEOverlapRadii::Carbon`. 
      By default this is set to 1.7 |A|.

   .. oe:method:: SetRadiiApproximation

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRadiiApproximation(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetRadiiApproximation(value: int) -> bool

      Set the radius approximation used to calculate overlap. The default is
      :oe:const:`OEShape::OEOverlapRadii::Carbon`. Alternatives are
      defined in the :oe:const:`OEShape::OEOverlapRadii` namespace.

   .. oe:method:: SetScoreType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetScoreType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreType(value: int) -> bool

      Set the score type to be reported by this function. The default is
      :oe:const:`OEShape::OEScoreType::Tanimoto`. Alternatives are
      defined in the :oe:constns:`OEShape::OEScoreType` namespace.



.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeQuery, ShapeQuery

.. _OEShape_OEShapeQuery:

.. oe:class:: OEShapeQuery

   .. oe:api::

      class OEShapeQuery : public OEShapeQueryBase

   The :ref:`OEShapeQuery <OEShape_OEShapeQuery>` class defines
   an interface for creating a shape query, which is useful for defining a reference system
   for shape and color overlap calculations.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:
    * :oe:meth:`operator=<OESystem::OEBase::operator=>` 
    * :oe:meth:`operator+=<OESystem::OEBase::operator+=>`  
    * :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>` 
    * :oe:meth:`AddData<OESystem::OEBase::AddData>` 
    * :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>` 
    * :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>` 
    * :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>` 
    * :oe:meth:`GetData<OESystem::OEBase::GetData>`
    * :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`
    * :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>` 
    * :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>`
    * :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>` 
    * :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>` 
    * :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` 
    * :oe:meth:`HasData<OESystem::OEBase::HasData>`          
    * :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
    * :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`          
    * :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
    * :oe:meth:`SetData<OESystem::OEBase::SetData>`               
    * :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
    * :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
    * :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`              
    * :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`

   The following methods are publicly inherited from :ref:`OEShapeQueryBase <OEShape_OEShapeQueryBase>`:
    * :oe:meth:`GetAtomStrength<OEShape::OEShapeQueryBase::GetAtomStrength>`
    * :oe:meth:`GetColorForceField<OEShape::OEShapeQueryBase::GetColorForceField>`
    * :oe:meth:`GetColorGaussians<OEShape::OEShapeQueryBase::GetColorGaussians>`
    * :oe:meth:`GetCompositeMolecule<OEShape::OEShapeQueryBase::GetCompositeMolecule>`
    * :oe:meth:`GetMolecule<OEShape::OEShapeQueryBase::GetMolecule>`
    * :oe:meth:`GetShapeGaussians<OEShape::OEShapeQueryBase::GetShapeGaussians>` 
    * :oe:meth:`GetShapeGrid<OEShape::OEShapeQueryBase::GetShapeGrid>`
    * :oe:meth:`GetTitle<OEShape::OEShapeQueryBase::GetTitle>`
    * :oe:meth:`HasColor<OEShape::OEShapeQueryBase::HasColor>`
    * :oe:meth:`HasMolecule<OEShape::OEShapeQueryBase::HasMolecule>`
    * :oe:meth:`HasShape<OEShape::OEShapeQueryBase::HasShape>` 
    * :oe:meth:`HasShapeGrid<OEShape::OEShapeQueryBase::HasShapeGrid>`
    * :oe:meth:`IsEmpty<OEShape::OEShapeQueryBase::IsEmpty>`
    * :oe:meth:`SetTitle<OEShape::OEShapeQueryBase::SetTitle>`

   The :ref:`OEShapeQuery <OEShape_OEShapeQuery>` class defines the following public methods:
    * :oe:meth:`AddColorGaussian<OEShape::OEShapeQuery::AddColorGaussian>`
    * :oe:meth:`AddColorGaussians<OEShape::OEShapeQuery::AddColorGaussians>`
    * :oe:meth:`AddShapeGaussian<OEShape::OEShapeQuery::AddShapeGaussian>`
    * :oe:meth:`AddShapeGaussians<OEShape::OEShapeQuery::AddShapeGaussians>`
    * :oe:meth:`Clear<OEShape::OEShapeQuery::Clear>`
    * :oe:meth:`ClearColorGaussians<OEShape::OEShapeQuery::ClearColorGaussians>`
    * :oe:meth:`ClearMolecule<OEShape::OEShapeQuery::ClearMolecule>`
    * :oe:meth:`ClearShapeGaussians<OEShape::OEShapeQuery::ClearShapeGaussians>`
    * :oe:meth:`ClearShapeGrid<OEShape::OEShapeQuery::ClearShapeGrid>`
    * :oe:meth:`DeleteColorGaussian<OEShape::OEShapeQuery::DeleteColorGaussian>`
    * :oe:meth:`DeleteShapeGaussian<OEShape::OEShapeQuery::DeleteShapeGaussian>`
    * :oe:meth:`SetAtomStrength<OEShape::OEShapeQuery::SetAtomStrength>`
    * :oe:meth:`SetMolecule<OEShape::OEShapeQuery::SetMolecule>`
    * :oe:meth:`SetShapeGrid<OEShape::OEShapeQuery::SetShapeGrid>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeQuery(const OEShapeQueryOptions& argOptions = OEShapeQueryOptions())
            OEShapeQuery(const OEShapeQuery&)
            OEShapeQuery(const OEShapeQueryBase&);

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQuery(argOptions: OEShapeQueryOptions = OEShapeQueryOptions()) -> OEShapeQuery
            OEShapeQuery(arg2: OEShapeQuery) -> OEShapeQuery
            OEShapeQuery(arg2: OEShapeQueryBase) -> OEShapeQuery

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeQuery &operator=(const OEShapeQuery &)

      The assignment operator.

   .. _OEShape_OEShapeQuery_AddColorGaussian:

      Assignment operator.

   .. oe:method:: AddColorGaussian

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddColorGaussian(const OESystem::OEGaussianBase&)

      .. oe:language:: python

         .. oe:api:: python

            AddColorGaussian(c: OEGaussianBase) -> None

      Adds the specified color Gaussian to the query.

   .. _OEShape_OEShapeQuery_AddColorGaussians:

   .. oe:method:: AddColorGaussians

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned AddColorGaussians(const OESystem::OEScalarGrid& grid,
                                       const unsigned colorType)
            unsigned AddColorGaussians(const OESystem::OEScalarGrid& grid,
                                       const unsigned colorType,
                                       const double relGridContour)

      .. oe:language:: python

         .. oe:api:: python

            AddColorGaussians(grid: OEScalarGrid, colorType: int) -> int
            AddColorGaussians(grid: OEScalarGrid, colorType: int,
                              relativeGridContourVal: float) -> int

      Adds Gaussians of the specified color type to the query, based on the input grid. Gaussians are placed to
      reproduce the shape of the input grid. The optional argument ``relGridContour`` refers to the grid values
      relative to the maximum, below which a Gaussian should not be placed.

   .. _OEShape_OEShapeQuery_AddShapeGaussian:

   .. oe:method:: AddShapeGaussian

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddShapeGaussian(const OESystem::OEGaussianBase&)

      .. oe:language:: python

         .. oe:api:: python

            AddShapeGaussian(gauss: OEGaussianBase) -> None

      Adds the specified shape Gaussian to the query.

   .. _OEShape_OEShapeQuery_AddShapeGaussians:

   .. oe:method:: AddShapeGaussians

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned AddShapeGaussians(const OESystem::OEScalarGrid& grid)

      .. oe:language:: python

         .. oe:api:: python

            AddShapeGaussians(grid: OEScalarGrid) -> int

      Adds shape Gaussians to the query, based on the input grid. Gaussians are placed to
      reproduce the shape of the input grid. The optional argument ``options`` refers to the options class that controls the grid
      to Gaussian algorithm.

   .. _OEShape_OEShapeQuery_Clear:

   .. oe:method:: Clear

      .. oe:api::

         void Clear()

      Removes all the current contents from the query.

   .. _OEShape_OEShapeQuery_ClearColorGaussians:

   .. oe:method:: ClearColorGaussians

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearColorGaussians()

      .. oe:language:: python

         .. oe:api:: python

            ClearColorGaussians() -> None

      Removes all the color Gaussians from the query.

   .. _OEShape_OEShapeQuery_ClearMolecule:

   .. oe:method:: ClearMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearMolecule()

      .. oe:language:: python

         .. oe:api:: python

            ClearMolecule() -> None

      Removes the molecule from the query.

   .. _OEShape_OEShapeQuery_ClearShapeGaussians:

   .. oe:method:: ClearShapeGaussians

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearShapeGaussians()

      .. oe:language:: python

         .. oe:api:: python

            ClearShapeGaussians() -> None

      Removes all the shape Gaussians from the query.

   .. _OEShape_OEShapeQuery_ClearShapeGrid:

   .. oe:method:: ClearShapeGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearShapeGrid()

      .. oe:language:: python

         .. oe:api:: python

            ClearShapeGrid() -> None

      Removes the shape grid from the query.

   .. _OEShape_OEShapeQuery_DeleteColorGaussian:

   .. oe:method:: DeleteColorGaussian

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteColorGaussian(OESystem::OEGaussianBase*)

      .. oe:language:: python

         .. oe:api:: python

            DeleteColorGaussian(c: OEGaussianBase) -> bool

      Removes the specified color Gaussian from the query.

   .. _OEShape_OEShapeQuery_DeleteShapeGaussian:

   .. oe:method:: DeleteShapeGaussian

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool DeleteShapeGaussian(OESystem::OEGaussianBase*)

      .. oe:language:: python

         .. oe:api:: python

            DeleteShapeGaussian(gauss: OEGaussianBase) -> bool

      Removes the specified shape Gaussian from the query.

   .. _OEShape_OEShapeQuery_SetAtomStrength:

   .. oe:method:: SetAtomStrength

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAtomStrength(OEChem::OEAtomBase& atom,
                                 const unsigned strength)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomStrength(atom: OEAtomBase, strength: int) -> bool

      Sets the strength of the specified atom.  A strength of larger than 1 means
      that the atom should be represented by multiple atoms at the same location.
      The atom must be a part of the molecule contained in the query and may not
      be a color atom. The method returns ``False`` if the strength cannot be set.

   .. _OEShape_OEShapeQuery_SetMolecule:

   .. oe:method:: SetMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMolecule( const OEChem::OEMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetMolecule(arg2: Union[OEGraphMol,OEMol,OEQMol]) -> None

      Adds the specified molecule to the query.

   .. _OEShape_OEShapeQuery_SetShapeGrid:

   .. oe:method:: SetShapeGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetShapeGrid(const OESystem::OEScalarGrid&)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeGrid(g: OEScalarGrid) -> None

      Adds the specified shape grid to the query.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeQueryBase, ShapeQueryBase

.. _OEShape_OEShapeQueryBase:

.. oe:class:: OEShapeQueryBase

   .. oe:api::

      class OEShapeQueryBase : public OEBase

   The :ref:`OEShapeQueryBase <OEShape_OEShapeQueryBase>` is an abstract base class. This
   class defines an interface for creating a shape query, useful for defining
   a reference system for shape/color overlap calculations.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:
    * :oe:meth:`operator=<OESystem::OEBase::operator=>` 
    * :oe:meth:`operator+=<OESystem::OEBase::operator+=>`  
    * :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>` 
    * :oe:meth:`AddData<OESystem::OEBase::AddData>` 
    * :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>` 
    * :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>` 
    * :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>` 
    * :oe:meth:`GetData<OESystem::OEBase::GetData>`
    * :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`
    * :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>` 
    * :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>`
    * :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>` 
    * :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>` 
    * :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` 
    * :oe:meth:`HasData<OESystem::OEBase::HasData>`          
    * :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
    * :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`          
    * :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
    * :oe:meth:`SetData<OESystem::OEBase::SetData>`               
    * :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
    * :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
    * :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`              
    * :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`

   The :ref:`OEShapeQueryBase <OEShape_OEShapeQueryBase>` class defines the following public methods:
    * :oe:meth:`GetAtomStrength<OEShape::OEShapeQueryBase::GetAtomStrength>`
    * :oe:meth:`GetColorForceField<OEShape::OEShapeQueryBase::GetColorForceField>`
    * :oe:meth:`GetColorGaussians<OEShape::OEShapeQueryBase::GetColorGaussians>`
    * :oe:meth:`GetCompositeMolecule<OEShape::OEShapeQueryBase::GetCompositeMolecule>`
    * :oe:meth:`GetMolecule<OEShape::OEShapeQueryBase::GetMolecule>`
    * :oe:meth:`GetShapeGaussians<OEShape::OEShapeQueryBase::GetShapeGaussians>` 
    * :oe:meth:`GetShapeGrid<OEShape::OEShapeQueryBase::GetShapeGrid>`
    * :oe:meth:`GetTitle<OEShape::OEShapeQueryBase::GetTitle>`
    * :oe:meth:`HasColor<OEShape::OEShapeQueryBase::HasColor>`
    * :oe:meth:`HasMolecule<OEShape::OEShapeQueryBase::HasMolecule>`
    * :oe:meth:`HasShape<OEShape::OEShapeQueryBase::HasShape>` 
    * :oe:meth:`HasShapeGrid<OEShape::OEShapeQueryBase::HasShapeGrid>`
    * :oe:meth:`IsEmpty<OEShape::OEShapeQueryBase::IsEmpty>`
    * :oe:meth:`SetTitle<OEShape::OEShapeQueryBase::SetTitle>`

   The following classes derive from this class:
    * :ref:`OEShapeQuery <OEShape_OEShapeQuery>`

   .. _OEShape_OEShapeQueryBase_GetAtomStrength:

   .. oe:method:: GetAtomStrength

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomStrength(const OEChem::OEAtomBase&) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomStrength(arg2: OEAtomBase) -> int

      Returns the strength of the specified atom. The default strength of any
      atom that is part of the molecule within the query is 1.

   .. oe:method:: GetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEColorForceField* GetColorForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceField() -> OEColorForceField

      Returns a pointer to the color force field associated with this query.

   .. oe:method:: GetColorGaussians

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<const OESystem::OEGaussianBase>* GetColorGaussians() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorGaussians() -> Iterable[OEGaussianBase]

      Returns an iterator over the color gaussians currently contained in this query.

   .. oe:method:: GetCompositeMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCompositeMolecule(OEChem::OEMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            GetCompositeMolecule(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This method is useful in extracting the molecule contained in the query with
      atom strengths explicitly taken care of. Atoms with strength larger than 1 are
      explicitly represented by multiple atoms in the composite molecule.

   .. oe:method:: GetMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase& GetMolecule() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolecule() -> OEGraphMol

      Returns the molecule currently contained in this query. In contrast to the
      :oe:meth:`GetCompositeMolecule<OEShape::OEShapeQueryBase::GetCompositeMolecule>` method,
      this method returns the molecule as is.

   .. oe:method:: GetShapeGaussians

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<const OESystem::OEGaussianBase>* GetShapeGaussians() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeGaussians() -> Iterable[OEGaussianBase]

      Returns an iterator over the shape gaussians currently contained in this query.

   .. oe:method:: GetShapeGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEScalarGrid& GetShapeGrid() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeGrid() -> OEScalarGrid

      Returns the shape grid currently contained in this query.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Returns the title of the query.

   .. oe:method:: HasColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasColor() const

      .. oe:language:: python

         .. oe:api:: python

            HasColor() -> bool

      Returns `True` if the query currently contains any color atoms or color gaussians.

   .. oe:method:: HasMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasMolecule() const

      .. oe:language:: python

         .. oe:api:: python

            HasMolecule() -> bool

      Returns `True` if the query currently contains any molecule.

   .. oe:method:: HasShape

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasShape() const

      .. oe:language:: python

         .. oe:api:: python

            HasShape() -> bool

      Returns `True` if the query currently contains any molecule, shape grid, or shape gaussians.

   .. oe:method:: HasShapeGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasShapeGrid() const

      .. oe:language:: python

         .. oe:api:: python

            HasShapeGrid() -> bool

      Returns `True` if the query currently contains any shape grid.

   .. oe:method:: IsEmpty

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsEmpty() const

      .. oe:language:: python

         .. oe:api:: python

            IsEmpty() -> bool

      Returns `True` if the query currently contains no shape or color.

   .. oe:method:: SetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTitle(const char *)
            bool SetTitle(const std::string&)

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(argTitle: str) -> bool

      Sets the title of the query.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEStarts, Starts

.. _OEShape_OEStarts:

.. oe:class:: OEStarts

   .. oe:api::

      class OEStarts

   The :ref:`OEStarts <OEShape_OEStarts>` is an abstract base class. This class defines
   an interface for providing various kinds of starts for overlay optimization
   calculations.  Most methods in this interface are useful for advanced users
   who want to create their own optimization workflow using these starts. To
   specify starts for :ref:`OEOverlay <OEShape_OEOverlay>` or :ref:`OEROCS <OEShape_OEROCS>`
   calculations, a user merely needs to instantiate the appropriate
   :ref:`OEStarts <OEShape_OEStarts>`.

   .. _figure_OEStarts_Hierarchy:

   .. figure:: shapetk/images/OEStarts.*
      :align:  center

   The :ref:`OEStarts <OEShape_OEStarts>` class defines the following public methods:
    * :oe:meth:`CreateCopy<OEShape::OEStarts::CreateCopy>`  
    * :oe:meth:`GetNumOfStarts<OEShape::OEStarts::GetNumOfStarts>` 
    * :oe:meth:`GetStarts<OEShape::OEStarts::GetStarts>`
    * :oe:meth:`Setup<OEShape::OEStarts::Setup>` 
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupFrame>`
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupRef>`

   The following classes derive from this class:
    * :ref:`OEAsIsStarts <OEShape_OEAsIsStarts>`
    * :ref:`OEAtAtomStarts <OEShape_OEAtAtomStarts>`
    * :ref:`OECartesianStarts <OEShape_OECartesianStarts>`
    * :ref:`OEInertialStarts <OEShape_OEInertialStarts>`
    * :ref:`OEQuatStarts <OEShape_OEQuatStarts>`
    * :ref:`OERandomStarts <OEShape_OERandomStarts>`
    * :ref:`OESubrocsStarts <OEShape_OESubrocsStarts>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEStarts & operator=(const OEStarts &)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEStarts* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEStarts

      Returns a new instance of an :ref:`OEStarts <OEShape_OEStarts>` with the same parameters
      as the inherent starts.

   .. oe:method:: GetNumOfStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumOfStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumOfStarts() -> int

      Returns the number of starts currently set. In most cases, the number of starts 
      depends on the reference and the fit object to be used for optimization.  Both
      :oe:meth:`SetupRef<OEShape::OEStarts::SetupRef>` and :oe:meth:`Setup<OEShape::OEStarts::Setup>` should be called to set up the reference and fit information prior to accessing
      the number of starts for any specific optimization.

   .. oe:method:: GetStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStarts(double* argQuats) const

      .. oe:language:: python

         .. oe:api:: python

            GetStarts(argQuats: OEDoubleArray) -> bool

      Returns the starting quaternions currently set. In most cases, the number of starts 
      depends on the reference and the fit object to be used for optimization.  Both
      :oe:meth:`SetupRef<OEShape::OEStarts::SetupRef>` and :oe:meth:`Setup<OEShape::OEStarts::Setup>` should be called to set up the reference and fit information prior to accessing
      the number of starts for any specific optimization.

      The array passed in for obtaining the starting quaternions must have a length of at least
      7*(NumStarts).

    .. _OEShape_OEStarts_Setup:
    
   .. oe:method:: Setup

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int Setup(const OEChem::OEMolBase& argFitMol,
                               OEChem::OETrans& argTrans)
            bool Setup(const unsigned int argFitSymmetry)

      .. oe:language:: python

         .. oe:api:: python

            Setup(argFitMol: Union[OEGraphMol,OEMol,OEQMol], argTrans: OETrans) -> int
            Setup(argFitSymmetry: int) -> bool

      The first `Setup` defines the interface for setting up the fit system for the 
      :ref:`OEStarts <OEShape_OEStarts>` derived instance with a molecule.  The second argument
      returns the transformation required to be applied on the fit molecule prior to
      starting any optimization. The return value of the method corresponds to the
      calculated symmetry type of the fit molecule. The second `Setup` can be used for 
      setting up the fit system when the symmetry type is already known. The reference system 
      information must be set by calling :oe:meth:`SetupRef<OEShape::OEStarts::SetupRef>` prior
      to calling `Setup`.

    .. _OEShape_OEStarts_SetupFrame:
    .. oe:method:: SetupFrame

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupFrame(OEChem::OEMolBase& mol)
            bool SetupFrame(OESystem::OEScalarGrid& grid)
            bool SetupFrame(OEShapeQuery& query)

      .. oe:language:: python

         .. oe:api:: python

            SetupFrame(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            SetupFrame(grid: OEScalarGrid) -> bool
            SetupFrame(query: OEShapeQuery) -> bool

      These methods define the interface for setting up the reference system for the :ref:`OEStarts <OEShape_OEStarts>`
      derived instance.  These methods provide simpler interface to setting up the reference system, over the 
      :oe:meth:`SetupRef<OEShape::OEStarts::SetupRef>` methods.

    .. _OEShape_OEStarts_SetupRef:
    .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const unsigned int symmetry)
            bool SetupRef(const OEChem::OEMolBase& argRefMol,
                          const unsigned int symmetry)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(argSymmetry: int) -> bool
            SetupRef(mol: Union[OEGraphMol,OEMol,OEQMol], symmetry: int) -> bool

      These methods define the interface for setting up the reference system for the :ref:`OEStarts <OEShape_OEStarts>`
      derived instance.  The knowledge of the reference molecule is required for some variants of the :ref:`OEStarts <OEShape_OEStarts>`,
      whereas the others simply require the ``symmetry`` information for the reference system.  The corresponding ``symmetry``
      values are defined in the :oe:constns:`OEShape::OEMomentSymmetry` namespace and can be calculated using the
      :oe:meth:`OEShape::OEOrientByMomentsOfInertia` method.

      .. seealso::

         * :oe:meth:`SetupFrame<OEShape::OEStarts::SetupFrame>` method


.. oe:namespace:: OEShape

.. meta::
   :keywords: OESubrocsStarts, SubrocsStarts

.. _OEShape_OESubrocsStarts:

.. oe:class:: OESubrocsStarts

   .. oe:api::

      class OESubrocsStarts : public OEInertialStarts

   The :ref:`OESubrocsStarts <OEShape_OESubrocsStarts>` represents the Subrocs starts for
   overlay optimization.

   The following methods are publicly inherited from :ref:`OEStarts <OEShape_OEStarts>`:
    * :oe:meth:`CreateCopy<OEShape::OEStarts::CreateCopy>`  
    * :oe:meth:`GetNumOfStarts<OEShape::OEStarts::GetNumOfStarts>` 
    * :oe:meth:`GetStarts<OEShape::OEStarts::GetStarts>`
    * :oe:meth:`Setup<OEShape::OEStarts::Setup>` 
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupFrame>`
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupRef>`

   The following methods are publicly inherited from :ref:`OEInertialStarts <OEShape_OEInertialStarts>`:
    * :oe:meth:`GetSymmetryThreshold<OEShape::OEInertialStarts::GetSymmetryThreshold>`  
    * :oe:meth:`SetSymmetryThreshold<OEShape::OEInertialStarts::SetSymmetryThreshold>` 

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESubrocsStarts()
            OESubrocsStarts(const OESubrocsStarts&)

      .. oe:language:: python

         .. oe:api:: python

            OESubrocsStarts() -> OESubrocsStarts
            OESubrocsStarts(arg2: OESubrocsStarts) -> OESubrocsStarts

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESubrocsStarts &operator=(const OESubrocsStarts &)

      The assignment operator.

      Assignment operator.



.. oe:namespace:: OEShape

.. meta::
   :keywords: OETanimotoComboCutoff, TanimotoComboCutoff

.. _OEShape_OETanimotoComboCutoff:

.. oe:class:: OETanimotoComboCutoff

   .. oe:api::

      class OETanimotoComboCutoff : public OEOverlayScoreCutoff

   The :ref:`OETanimotoComboCutoff <OEShape_OETanimotoComboCutoff>` defines cutoff based on the combined
   shape and color tanimoto.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:
    * :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`

   The following methods are publicly inherited from :ref:`OEOverlayScoreCutoff <OEShape_OEOverlayScoreCutoff>`:
    * :oe:meth:`operator()<OEShape::OEOverlayScoreCutoff::operator()>`  
    * :oe:meth:`CreateCopy<OEShape::OEOverlayScoreCutoff::CreateCopy>`
  

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETanimotoComboCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            OETanimotoComboCutoff(argCutoff: float) -> OETanimotoComboCutoff

      Default and copy constructors. The argument expects the desired cutoff.  



.. oe:namespace:: OEShape

.. meta::
   :keywords: OETanimotoCutoff, TanimotoCutoff

.. _OEShape_OETanimotoCutoff:

.. oe:class:: OETanimotoCutoff

   .. oe:api::

      class OETanimotoCutoff : public OEOverlayScoreCutoff

   The :ref:`OETanimotoCutoff <OEShape_OETanimotoCutoff>` defines cutoff based on the
   shape tanimoto.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:
    * :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`

   The following methods are publicly inherited from :ref:`OEOverlayScoreCutoff <OEShape_OEOverlayScoreCutoff>`:
    * :oe:meth:`operator()<OEShape::OEOverlayScoreCutoff::operator()>`  
    * :oe:meth:`CreateCopy<OEShape::OEOverlayScoreCutoff::CreateCopy>`
  

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETanimotoCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            OETanimotoCutoff(argCutoff: float) -> OETanimotoCutoff

      Default and copy constructors. The argument expects the desired cutoff.  



.. _OEShapeConstants:

*******************
OEShape Constants
*******************

.. oe:namespace:: OEShape

.. toctree::

   OEColorFFType
   OEDerivativeType
   OEExponentialType
   OEMomentSymmetry
   OEOverlapRadii
   OEScoreType
   OEShapeType
   OEColorType


.. oe:namespace:: OEShape

..  _OEShape_OEColorFFType:

.. oe:constnamespace:: OEColorFFType

   This namespace contains constants defining color force fields.

   .. oe:constant:: Undefined

   .. oe:constant:: OEDefault

      The default approximation is ImplicitMillsDean

..  _OEShape_OEColorFFType_ImplicitMillsDean:

   .. oe:constant:: ImplicitMillsDean

      The ``ImplicitMillsDean`` color forcefield.

..  _OEShape_OEColorFFType_ExplicitMillsDean:

   .. oe:constant:: ExplicitMillsDean

      The ``ExplicitMillsDean`` color forcefield.

..  _OEShape_OEColorFFType_ImplicitMillsDeanNoRings:

   .. oe:constant:: ImplicitMillsDeanNoRings

      The ``ImplicitMillsDean`` color forcefield without rings.

..  _OEShape_OEColorFFType_ExplicitMillsDeanNoRings:

   .. oe:constant:: ExplicitMillsDeanNoRings

      The ``ExplicitMillsDean`` color forcefield without rings.

..  _OEShape_OEColorFFType_Custom:

   .. oe:constant:: Custom

      Custom color forcefield.

..  _OEShape_OEColorFFType_Max:

   .. oe:constant:: Max

      The largest numerical value that can be contained in this
      namespace. Useful for being able to iterate over all the
      constants in this namespace.


.. oe:namespace:: OEShape

.. oe:constnamespace:: OEBOMinType

   .. note::

      This is a deprecated namespace.

   This namespace contains constants.

   .. oe:constant:: Tanimoto
   

   .. oe:constant:: Overlap
   

   .. oe:constant:: Autoscale
   

   .. oe:constant:: Default
   



.. oe:namespace:: OEShape

.. oe:constnamespace:: OEBOOrientation

   .. note::

      This is a deprecated namespace.

   This namespace contains constants.

   .. oe:constant:: Inertial
   

   .. oe:constant:: AsIs
   

   .. oe:constant:: Random
   

   .. oe:constant:: InertialAtHeavyAtoms
   

   .. oe:constant:: InertialAtColorAtoms
   

   .. oe:constant:: UserInertialStarts

   .. oe:constant:: Subrocs
   

   .. oe:constant:: Default
   



.. oe:namespace:: OEShape

.. oe:constnamespace:: OEColorType

   This namespace contains constants that defines color type
   appropriate for color scores calculations.

   .. oe:constant:: Grid

      Calculates color scores using :ref:`OEGridColorFunc<OEShape_OEGridColorFunc>`
   
   .. oe:constant:: Exact

      Calculates color scores using :ref:`OEExactColorFunc<OEShape_OEExactColorFunc>`
   
   .. oe:constant:: Analytic

      Calculates color scores using :ref:`OEAnalyticColorFunc<OEShape_OEAnalyticColorFunc>`

   .. oe:constant:: None

      Ignore color scores calculation


.. oe:namespace:: OEShape

.. oe:constnamespace:: OEDerivativeType

   This namespace controls how to extract derivatives from a shape grid,
   associated with the *Grid* based overlap calculation.

   .. oe:constant:: Interpolated
 
      Derivatives obtained from interpolation.

   .. oe:constant:: NearestValue
 
      Derivatives of the nearest grid point are picked.


.. oe:namespace:: OEShape

.. oe:constnamespace:: OEExponentialType

   This namespace controls how to obtain exponentials during calculation
   of Gaussian overlaps and their derivatives.

   .. oe:constant:: Standard
   
      Evaluate the exponentials with standard methods every time. 

   .. oe:constant:: Tabulated
   
      Interpolate from tabulated values.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEShape

..  _OEShape_OEGridScoreType:

.. oe:constnamespace:: OEGridScoreType

.. attention::

   |PRELIMINARY-API|

This namespace controls the type of score to be used in the fit and returned by the :ref:`AddShapeGaussians<OEShape_OEShapeQuery_AddShapeGaussians>` and :ref:`AddColorGaussians<OEShape_OEShapeQuery_AddColorGaussians>` methods of :ref:`OEShapeQuery <OEShape_OEShapeQuery>`. This is processed via the options class :ref:`OEShapeQueryOptions <OEShape_OEShapeQueryOptions>`.

..  _OEShape_OEGridScoreType_CosAngle:

   .. oe:constant:: CosAngle
   
      Maximizes the cosine angle between two vectorized grids: the first from the input grid and the second from the one that follows from fitted Gaussians.
      This measure is insensitive to overall normalization of the input grid.

..  _OEShape_OEGridScoreType_Tanimoto:

   .. oe:constant:: Tanimoto
   
      Maximizes the Tanimoto between the input grid and the grid that follows from fitted Gaussians. This measure depends on self-overlaps of the input grid
      and the grid that follows from fitted Gaussians. Consequently, it is sensitive to the overall coefficient of the input grid.


.. oe:namespace:: OEShape

.. oe:constnamespace:: OEMomentSymmetry

   This namespace defines constants corresponding to various possible
   Moments symmetry.

   .. oe:constant:: NoSymmetry
   
      No symmetry around any of the inertials axes 

   .. oe:constant:: Oblate
   
      Oblate symmetry.

   .. oe:constant:: Prolate
   
      Prolate symmetry.

   .. oe:constant:: Spherical
   
      Spherical symmetry.

   .. oe:constant:: Unknown
   
      Unknown symmetry.


.. oe:namespace:: OEShape

.. oe:constnamespace:: OEOverlapMethod

   .. note::

      This is a deprecated namespace.
      
   This namespace contains constants.

   .. oe:constant:: Grid
   

   .. oe:constant:: Analytic
   

   .. oe:constant:: Analytic2
   

   .. oe:constant:: Exact
   

   .. oe:constant:: Max
   



.. oe:namespace:: OEShape

.. oe:constnamespace:: OEOverlapRadii

   This namespace controls how radii of atoms should be handled by the
   **Shape TK** when doing calculations. The default value of using
   the carbon radii approximation,
   :oe:const:`OEShape::OEOverlapRadii::Carbon`, was found to have the
   best performance in virtual screening experiments.

   .. oe:constant:: Carbon
   
      Treat all atoms, as carbon, with the same radius.

   .. oe:constant:: All
   
      Use the radius of the atom as returned by
      :oe:meth:`OEChem::OEAtomBase::GetRadius`.

   .. oe:constant:: Default
   
      The default approximation is
      :oe:const:`OEShape::OEOverlapRadii::Carbon`, to treat all atoms
      as carbon.

   .. oe:constant:: Max
   
      The largest numerical value that can be contained in this
      namespace. Useful for being able to iterate over all the
      constants in this namespace.


.. oe:namespace:: OEShape

.. oe:constnamespace:: OEOverlapRepresentation

   .. note::

      This is a deprecated namespace.
      
   This namespace contains constants.

   .. oe:constant:: Atomic
   

   .. oe:constant:: Atoms
   

   .. oe:constant:: Bonding
   

   .. oe:constant:: Bonds
   

   .. oe:constant:: Full
   

   .. oe:constant:: All
   

   .. oe:constant:: Gaussian
   

   .. oe:constant:: Default
   

   .. oe:constant:: Max
   



.. oe:namespace:: OEShape

..  _OEShape_OEScoreType:

.. oe:constnamespace:: OEScoreType

   This namespace controls the type of score to be returned by
   the operator() methods of a :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
   derived instance.

..  _OEShape_OEScoreType_Overlap:

   .. oe:constant:: Overlap
   
      Calculate overlap

..  _OEShape_OEScoreType_Tanimoto:

   .. oe:constant:: Tanimoto
   
      Calculate tanimoto


.. _preliminary_OEShapeConstants:

*****************************
Preliminary OEShape Constants
*****************************

.. oe:namespace:: OEShape

.. toctree::

   OEGridScoreType

.. _OEShapeConstantsDpcr:

Deprecated OEShape Constants
****************************

.. oe:namespace:: OEShape

.. toctree::

   OEBOMinType
   OEBOOrientation
   OEOverlapMethod
   OEOverlapRepresentation


.. oe:namespace:: OEShape

.. oe:constnamespace:: OEShapeType

   This namespace contains constants that defines shape type
   appropriate for overlap calculations.

   .. oe:constant:: Grid

      Calculates shape overlap using :ref:`OEGridShapeFunc<OEShape_OEGridShapeFunc>`
   
   .. oe:constant:: Exact

      Calculates shape overlap using :ref:`OEExactShapeFunc<OEShape_OEExactShapeFunc>`
   
   .. oe:constant:: Analytic

      Calculates shape overlap using :ref:`OEAnalyticShapeFunc<OEShape_OEAnalyticShapeFunc>`

   .. oe:constant:: Hermite

      Calculates shape overlap using :ref:`OEHermiteShapeFunc<OEShape_OEHermiteShapeFunc>`

   .. oe:constant:: None

      Ignore shape overlap calculation


*******************************************************************************
OEShape Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEAddColorAtom.rst
   OEAddColorAtoms.rst
   OEAddCoordsToColorAtom.rst
   OECalcShapeMultipoles.rst
   OECalcVolume.rst
   OEClearCachedSelfColor.rst
   OEClearCachedSelfShape.rst
   OECompressColorAtoms.rst
   OECountColorAtoms.rst
   OEDeleteCompressedColorAtoms.rst
   OEGetCachedSelfColor.rst
   OEGetCachedSelfShape.rst
   OEGetCenterAndExtents.rst
   OEGetColorAtoms.rst
   OEGetColorParents.rst
   OEGetColorType.rst
   OEGetMomentsOfInertiaTransform.rst
   OEHasCachedSelfColor.rst
   OEHasCachedSelfShape.rst
   OEHasColorAtoms.rst
   OEHasCompressedColorAtoms.rst
   OEHasPerceivedColorAtoms.rst
   OEIsColorAtom.rst
   OEIsFastROCSShapeQuery.rst
   OEMol2Query.rst
   OEOrientByMomentsOfInertia.rst
   OEReadShapeQuery.rst
   OERemoveColorAtoms.rst
   OEROCSOverlay.rst
   OESelfColor.rst
   OESelfShape.rst
   OESetCachedSelfColor.rst
   OESetCachedSelfShape.rst
   OESetColorParents.rst
   OESetColorType.rst
   OESetCoordsFromColorParents.rst
   OEShapeGetArch.rst
   OEShapeGetLicensee.rst
   OEShapeGetPlatform.rst
   OEShapeGetRelease.rst
   OEShapeGetSite.rst
   OEShapeGetVersion.rst
   OEShapeIsLicensed.rst
   OESortOverlayScores.rst
   OEUncompressColorAtoms.rst
   OEWriteShapeQuery.rst


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEAddColorAtom

.. oe:function:: OEAddColorAtom

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEChem::OEAtomBase* OEAddColorAtom(OEChem::OEMolBase& mol,
                                            const float* coords, unsigned type,
                                            const std::string& typeName,
                                            const std::string& parentName = std::string())
         OEChem::OEAtomBase* OEAddColorAtom(OEChem::OEMolBase& mol,
                                            const OEChem::OEAtomBase** parents,
                                            unsigned num, unsigned type,
                                            const std::string& typeName)
         OEChem::OEAtomBase* OEAddColorAtom(OEChem::OEMCMolBase& mol,
                                            const OEChem::OEAtomBase** parents,
                                            unsigned num, unsigned type,
                                            const std::string& typeName)

   .. oe:language:: python

      .. oe:api:: python

         OEAddColorAtom(mol: Union[OEGraphMol,OEMol,OEQMol],
                        coords: OEFloatArray, type: int, typeName: str,
                        parentName: str = str()) -> OEAtomBase
         OEAddColorAtom(mol: Union[OEGraphMol,OEQMol], parents: OEAtomBase,
                        num: int, type: int, typeName: str) -> OEAtomBase
         OEAddColorAtom(mol: OEMol, parents: OEAtomBase, num: int, type: int,
                        typeName: str) -> OEAtomBase

   These functions allow adding color atoms manually, as opposed to
   being assigned via SMARTS matches from a color force field.  Note
   that the color atom will either be placed at the coordinates
   supplied in the first version, or at the center of mass of the
   *parents* atoms. ``num`` is the number of atoms in the parent
   array.

   .. oe:api:

      OEChem::OEAtomBase *OEAddColorAtom(OEChem::OEMolBase &mol, unsigned type,
                                         const std::string &typeName,
                                         const std::string &parentName)
      OEChem::OEAtomBase *OEAddColorAtom(OEChem::OEMCMolBase &mol, unsigned type,
                                         const std::string &typeName,
                                         const std::string &parentName)


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEAddColorAtoms

.. oe:function:: OEAddColorAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEAddColorAtoms(OEChem::OEMolBase& mol,
                                      const OEColorForceField& cff,
                                      bool setCachedSelfColor = false)
         unsigned int OEAddColorAtoms(OEChem::OEMCMolBase& mol,
                                      const OEColorForceField& cff,
                                      bool setCachedSelfColor = false)

   .. oe:language:: python

      .. oe:api:: python

         OEAddColorAtoms(mol: Union[OEGraphMol,OEQMol], cff: OEColorForceField,
                         setCachedSelfColor: bool = False) -> int
         OEAddColorAtoms(mol: OEMol, cff: OEColorForceField,
                         setCachedSelfColor: bool = False) -> int

   Add color atoms to the passed in molecule. Note that this is not
   normally required as both OEColorOverlap and OEBestOverlay make
   internal copies of molecules and add color atoms automatically, but if
   you continually re-use the same molecule, this can be an optimization.
   Additionally, setting *setCachedSelfColor* to true will pre-calculate
   and cache the self color on the molecule. This cached value will then
   be used by OEColorOverlap and OEBestOverlay. The value can be
   accessed via :oe:func:`OEShape::OEGetCachedSelfColor`.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEAddCoordsToColorAtom

.. oe:function:: OEAddCoordsToColorAtom

   .. oe:api::

      bool OEAddCoordsToColorAtom(OEChem::OEMolBase& mol,
                                  OEChem::OEAtomBase* coloratom, float* coords)

   Set the 3D coordinates of the given color atom.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OECalcShapeMultipoles

.. oe:function:: OECalcShapeMultipoles

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECalcShapeMultipoles(const OEChem::OEMolBase& mol, float* smult,
                                    unsigned int type = OEOverlapRepresentation::Atoms,
                                    bool useHydrogens = false)

   .. oe:language:: python

      .. oe:api:: python

         OECalcShapeMultipoles(mol: Union[OEGraphMol,OEMol,OEQMol],
                               type: int = OEOverlapRepresentation_Atoms,
                               useH: bool = False) -> List[float]

   Calculate the shape (steric) multipoles of a molecule.

   The molecule must have valid 3D coordinates assigned. Multipole coefficients
   are written to the caller-supplied array *smult*. The required array size
   depends on the *type* parameter: for
   :oe:const:`OEShape::OEOverlapRepresentation::Atoms` the array must be large
   enough to hold one entry per atom.

   *mol*

      The molecule to calculate multipoles for.

   *smult*

      Output array that receives the computed multipole coefficients.

   *type*

      The overlap representation to use, chosen from the
      :oe:constns:`OEShape::OEOverlapRepresentation` namespace.

   *useHydrogens*

      If true, hydrogen atoms are included. The default is false.

   Returns true on success.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OECalcVolume

.. oe:function:: OECalcVolume

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OECalcVolume(const OEChem::OEMolBase& mol,
                            bool useHydrogens = true)

   .. oe:language:: python

      .. oe:api:: python

         OECalcVolume(mol: Union[OEGraphMol,OEMol,OEQMol],
                      useHydrogens: bool = True) -> float

   Calculate the Gaussian shape volume of a molecule.

   The volume is computed as the first-order Gaussian overlap integral over all
   atoms in the molecule. The molecule must have valid 3D coordinates assigned.

   *mol*

      The molecule to calculate the volume for.

   *useHydrogens*

      If true (the default), hydrogen atoms are included in the volume
      calculation. If false, only heavy atoms contribute.

   Returns the Gaussian shape volume in cubic angstroms.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEClearCachedSelfColor

.. oe:function:: OEClearCachedSelfColor

    .. oe:language:: c++ java csharp

       .. oe:api::

          void OEClearCachedSelfColor(OEChem::OEMCMolBase& mol)
          void OEClearCachedSelfColor(OEChem::OEMolBase& mol)

    .. oe:language:: python

       .. oe:api:: python

          OEClearCachedSelfColor(mol: OEMol) -> None
          OEClearCachedSelfColor(mol: Union[OEGraphMol,OEQMol]) -> None

    Clear cached self color from molecule. See :oe:func:`OEShape::OESetCachedSelfColor`
    for more info.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEClearCachedSelfShape

.. oe:function:: OEClearCachedSelfShape

    .. oe:language:: c++ java csharp

       .. oe:api::

          void OEClearCachedSelfShape(OEChem::OEMCMolBase& mol)
          void OEClearCachedSelfShape(OEChem::OEMolBase& mol)

    .. oe:language:: python

       .. oe:api:: python

          OEClearCachedSelfShape(mcmol: OEMol) -> None
          OEClearCachedSelfShape(mcmol: Union[OEGraphMol,OEQMol]) -> None

    Clear cached self shape from molecule. See :oe:func:`OEShape::OESetCachedSelfShape`
    for more info.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OECompressColorAtoms

.. oe:function:: OECompressColorAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OECompressColorAtoms(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OECompressColorAtoms(mol: Union[OEGraphMol,OEQMol]) -> int

   Convert the color atoms on a molecule to an internal compressed
   form. Useful for saving space when storing pre-colored
   molecules. Use :oe:func:`OEShape::OEUncompressColorAtoms` to restore
   the actual color atoms.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OECountColorAtoms

.. oe:function:: OECountColorAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OECountColorAtoms(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OECountColorAtoms(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

   Return the number of color atoms attached to a molecule.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEDeleteCompressedColorAtoms

.. oe:function:: OEDeleteCompressedColorAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEDeleteCompressedColorAtoms(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEDeleteCompressedColorAtoms(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

   Removes information created from the
   :oe:func:`OEShape::OECompressColorAtoms` function.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEGetCachedSelfColor

.. oe:function:: OEGetCachedSelfColor

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEGetCachedSelfColor(const OEChem::OEConfBase& mol,
                                    bool allcolor = false)
         float OEGetCachedSelfColor(const OEChem::OEMolBase& mol,
                                    bool allcolor = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCachedSelfColor(mol: OEConfBase, allcolor: bool = False) -> float
         OEGetCachedSelfColor(mol: Union[OEGraphMol,OEMol,OEQMol],
                              allcolor: bool = False) -> float

   Return the value of cached self color on the molecule or conformer. This
   function doesn't work for OEMCMolBase directly, so call it on each
   individual conformer.  Returns 0.0 if there is no cached value. Use
   :oe:func:`OEShape::OEHasCachedSelfColor` to determine if a real value
   is attached.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEGetCachedSelfShape

.. oe:function:: OEGetCachedSelfShape

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OEGetCachedSelfShape(const OEChem::OEConfBase& conf,
                                    unsigned int radiiApprox = OEOverlapRadii::Carbon,
                                    float cradius = 1.7f)
         float OEGetCachedSelfShape(const OEChem::OEMolBase& mol,
                                    unsigned int radiiApprox = OEOverlapRadii::Carbon,
                                    float cradius = 1.7f)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCachedSelfShape(conf: OEConfBase, radiiApprox: int,
                              cradius: float = 1.7) -> float
         OEGetCachedSelfShape(mol: Union[OEGraphMol,OEMol,OEQMol],
                              radiiApprox: int, cradius: float = 1.7) -> float

   Return the value of cached self shape on the molecule or conformer. The
   value for radii approximation and cradius need to match those used to set
   this value initially. This function doesn't work for OEMCMolBase directly,
   so call it on each individual conformer.  Returns 0.0 if there is no cached
   value. Use :oe:func:`OEShape::OEHasCachedSelfShape` to determine if a real
   value is attached.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEGetCenterAndExtents

.. oe:function:: OEGetCenterAndExtents

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEGetCenterAndExtents(const OEShapeQueryPublic& sq, float* ctr,
                                    float* ext)

   .. oe:language:: python

      .. oe:api:: python

         OEGetCenterAndExtents(sq: OEShapeQueryBase, ctr: OEFloatArray,
                               ext: OEFloatArray) -> None
         OEGetCenterAndExtents(sq: OEShapeQueryPublic, ctr: OEFloatArray,
                               ext: OEFloatArray) -> None

   Fills the first three values of `ctr` with the location of the center
   of `sq` and fills the first three values of `ext` with the extents.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEGetColorAtoms

.. oe:function:: OEGetColorAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEAtomBase>* OEGetColorAtoms(OEChem::OEMolBase& mol)
         OESystem::OEIterBase<const OEChem::OEAtomBase>* OEGetColorAtoms(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetColorAtoms(mol: Union[OEGraphMol,OEMol,OEQMol]) -> OEAtomIter

   Return an iterator of all the color atoms attached to a molecule.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEGetColorParents

.. oe:function:: OEGetColorParents

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEAtomBase>* OEGetColorParents(OEChem::OEAtomBase* atom)
         OESystem::OEIterBase<const OEChem::OEAtomBase>* OEGetColorParents(const OEChem::OEAtomBase* atom)

   .. oe:language:: python

      .. oe:api:: python

         OEGetColorParents(atom: OEAtomBase) -> OEAtomIter

   Color atoms set via a SMARTS match store the matching atoms as *parents*.
   This method returns the parent atoms of a given color atom.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEGetColorType

.. oe:function:: OEGetColorType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetColorType(const OEChem::OEAtomBase* coloratom)

   .. oe:language:: python

      .. oe:api:: python

         OEGetColorType(coloratom: OEAtomBase) -> int

   Returns the type of a color atom as an unsigned int.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEGetMomentsOfInertiaTransform

.. oe:function:: OEGetMomentsOfInertiaTransform

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetMomentsOfInertiaTransform(OEChem::OETrans& argTransform,
                                                     const OEChem::OEMolBase & argMol,
                                                     const double argThreshold = 0.15)
         unsigned int OEGetMomentsOfInertiaTransform(OEChem::OETrans& argTransform,
                                                     const OESystem::OEScalarGrid& argGrid,
                                                     const double argThreshold = 0.15)
         unsigned int OEGetMomentsOfInertiaTransform(OEChem::OETrans& argTransform,
                                                     const OEShapeQuery& argQuery,
                                                     const double argThreshold = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMomentsOfInertiaTransform(argTransform: OETrans,
                                        argMol: Union[OEGraphMol,OEMol,OEQMol],
                                        argThreshold: float = 0.15) -> int
         OEGetMomentsOfInertiaTransform(argTransform: OETrans,
                                        argGrid: OEScalarGrid,
                                        argThreshold: float = 0.15) -> int
         OEGetMomentsOfInertiaTransform(argTransform: OETrans,
                                        argQuery: OEShapeQuery,
                                        argThreshold: float = 0.15) -> int

   Calculate the transform required to move the object (the specified
   molecule, grid or the shape query) to the center of its inertial frame.
   Method returns the moments symmetry of the object defined in the
   :oe:constns:`OEShape::OEMomentSymmetry` namespace.  The
   required transform is returned in the first argument.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHasCachedSelfColor

.. oe:function:: OEHasCachedSelfColor

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasCachedSelfColor(const OEChem::OEMCMolBase& mol)
         bool OEHasCachedSelfColor(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasCachedSelfColor(mol: OEMol) -> bool
         OEHasCachedSelfColor(mol: Union[OEGraphMol,OEQMol]) -> bool

   Returns true if the molecule has cached self color.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHasCachedSelfShape

.. oe:function:: OEHasCachedSelfShape

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasCachedSelfShape(const OEChem::OEMCMolBase& mcmol,
                                   unsigned int radiiApprox = OEOverlapRadii::Carbon,
                                   float cradius = 1.7f)
         bool OEHasCachedSelfShape(const OEChem::OEMolBase& mol,
                                   unsigned int radiiApprox = OEOverlapRadii::Carbon,
                                   float cradius = 1.7f)

   .. oe:language:: python

      .. oe:api:: python

         OEHasCachedSelfShape(mcmol: OEMol, radiiApprox: int,
                              cradius: float = 1.7) -> bool
         OEHasCachedSelfShape(mcmol: Union[OEGraphMol,OEQMol],
                              radiiApprox: int, cradius: float = 1.7) -> bool

   Returns true if the molecule has cached self shape. The
   value for radii approximation and cradius need to match those used to set
   this value initially.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHasColorAtoms

.. oe:function:: OEHasColorAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasColorAtoms(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasColorAtoms(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns ``true`` if the molecule has any color atoms
   attached. Note, :oe:func:`OEShape::OEHasColorAtoms` only checks for
   the existence of color atoms on the molecule, even if
   :oe:func:`OEShape::OEAddColorAtoms` did not match any substructures
   to create color atoms. Use
   :oe:func:`OEShape::OEHasPerceivedColorAtoms` if trying to determine
   whether :oe:func:`OEShape::OEAddColorAtoms` still needs to be
   called on the molecule.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHasCompressedColorAtoms

.. oe:function:: OEHasCompressedColorAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasCompressedColorAtoms(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasCompressedColorAtoms(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns ``true`` if the molecule contains compressed color atom
   information created from the
   :oe:func:`OEShape::OECompressColorAtoms` function.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHasPerceivedColorAtoms

.. oe:function:: OEHasPerceivedColorAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasPerceivedColorAtoms(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEHasPerceivedColorAtoms(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Returns ``true`` if :oe:func:`OEShape::OEAddColorAtoms` has already
   been called on ``mol``. Note, :oe:func:`OEShape::OEHasColorAtoms`
   only checks for the existence of color atoms on the molecule, even
   if :oe:func:`OEShape::OEAddColorAtoms` did not match any
   substructures to create color atoms.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEIsColorAtom

.. oe:function:: OEIsColorAtom

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsColorAtom(const OEChem::OEAtomBase* atom)

   .. oe:language:: python

      .. oe:api:: python

         OEIsColorAtom(atom: OEAtomBase) -> bool

   Returns ``true`` if the given atom is a color atom.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEIsFastROCSShapeQuery

..  _OEShape_OEIsFastROCSShapeQuery:

.. oe:function:: OEIsFastROCSShapeQuery

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsFastROCSShapeQuery(const OEShapeQueryPublic& query)
         bool OEIsFastROCSShapeQuery(const OEShapeQuery& query)

   .. oe:language:: python

      .. oe:api:: python

         OEIsFastROCSShapeQuery(query: OEShapeQueryPublic) -> bool
         OEIsFastROCSShapeQuery(query: OEShapeQuery) -> bool

   Determines if a shape query object is compatible with the :ref:`OEShapeQuery <OEShape_OEShapeQuery>` or a
   :ref:`OEShapeQueryPublic <OEShape_OEShapeQueryPublic>` overload of the :oe:meth:`OEFastROCS::OEShapeDatabase::GetScores`
   and :oe:meth:`OEFastROCS::OEShapeDatabase::GetSortedScores` in **FastROCS TK**.

.. oe:namespace:: OEShape

.. meta::
   :keywords: OEMol2Query

..  _OEShape_OEMol2Query:

.. oe:function:: OEMol2Query

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMol2Query(OEShape::OEShapeQuery& query,
                          const OEChem::OEMolBase& mol,
                          const OEShape::OEColorForceField& cff)

   .. oe:language:: python

      .. oe:api:: python

         OEMol2Query(query: OEShapeQuery, mol: Union[OEGraphMol,OEMol,OEQMol],
                     cff: OEColorForceField) -> bool

   Creates a :ref:`OEShapeQuery <OEShape_OEShapeQuery>` from the input
   :ref:`OEMolBase <OEChem_OEMolBase>`. The molecule must have valid 3D
   coordinates assigned. The specified
   :ref:`OEColorForceField <OEShape_OEColorForceField>` is used to generate
   color atoms during the query generation process.

   Returns true on successful query generation.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOrientByMomentsOfInertia

.. oe:function:: OEOrientByMomentsOfInertia

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEOrientByMomentsOfInertia(OEChem::OEMolBase & argMol,
                                                 OEChem::OETrans& argTransform,
                                                 const double argThreshold = 0.15)
         unsigned int OEOrientByMomentsOfInertia(OESystem::OEScalarGrid& argGrid,
                                                 OEChem::OETrans& argTransform,
                                                 const double argThreshold = 0.15)
         unsigned int OEOrientByMomentsOfInertia(OEShapeQuery& argQuery,
                                                 OEChem::OETrans& argTransform,
                                                 const double argThreshold = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEOrientByMomentsOfInertia(argMol: Union[OEGraphMol,OEMol,OEQMol],
                                    argTransform: OETrans,
                                    argThreshold: float = 0.15) -> int
         OEOrientByMomentsOfInertia(argGrid: OEScalarGrid,
                                    argTransform: OETrans,
                                    argThreshold: float = 0.15) -> int
         OEOrientByMomentsOfInertia(argQuery: OEShapeQuery,
                                    argTransform: OETrans,
                                    argThreshold: float = 0.15) -> int

   Calculate the transform required to move the object (the specified
   molecule, grid or the shape query) to the center of its inertial frame,
   and apply the transform to move the object to the inertial frame. Method
   returns the moments symmetry of the object defined in the
   :oe:constns:`OEShape::OEMomentSymmetry` namespace.
   The transform required to get the object back into the original frame
   is returned in the second argument of the method.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEROCSOverlay

.. oe:function:: OEROCSOverlay

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEROCSOverlay(OEROCSResult& argResult,
                            const OEChem::OEMCMolBase& argQuery,
                            const OEChem::OEMCMolBase& argFitMol,
                            const OEROCSOptions& argOptions = OEROCSOptions())
         bool OEROCSOverlay(OEROCSResult& argResult,
                            const OEChem::OEMolBase& argQuery,
                            const OEChem::OEMCMolBase& argFitMol,
                            const OEROCSOptions& argOptions = OEROCSOptions())
         bool OEROCSOverlay(OEROCSResult& argResult,
                            const OEChem::OEMolBase& argQuery,
                            const OEChem::OEMolBase& argFitMol,
                            const OEROCSOptions& argOptions = OEROCSOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEROCSOverlay(argResult: OEROCSResult, argQuery: OEMol,
                       argFitMol: OEMol,
                       argOptions: OEROCSOptions = OEROCSOptions()) -> bool
         OEROCSOverlay(argResult: OEROCSResult,
                       argQuery: Union[OEGraphMol,OEQMol], argFitMol: OEMol,
                       argOptions: OEROCSOptions = OEROCSOptions()) -> bool
         OEROCSOverlay(argResult: OEROCSResult,
                       argQuery: Union[OEGraphMol,OEMol,OEQMol],
                       argFitMol: Union[OEGraphMol,OEQMol],
                       argOptions: OEROCSOptions = OEROCSOptions()) -> bool
         OEROCSOverlay(argResult: OEROCSResult,
                       argQuery: Union[OEGraphMol,OEMol,OEQMol],
                       argFitMol: Union[OEGraphMol,OEMol,OEQMol],
                       argOptions: OEROCSOptions = OEROCSOptions()) -> bool

   Calculate the overlay between the query and the fit molecule.  Returns `True` if
   calculation completed successfully.  The first argument returns the results of the
   single best hit.

   .. note::

      This function sets up the reference system in :ref:`OEROCS <OEShape_OEROCS>`
      every time it is called, even if it is called with the same reference object. 
      This can have unexpected performance issues if the function is used in a loop.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEReadShapeQuery

.. oe:function:: OEReadShapeQuery

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadShapeQuery(const char* filename, OEShapeQuery& query)
         bool OEReadShapeQuery(const char* filename, OEShapeQueryPublic& query)
         bool OEReadShapeQuery(OEPlatform::oeistream& ifs, OEShapeQuery& query)
         bool OEReadShapeQuery(OEPlatform::oeistream& ifs,
                               OEShapeQueryPublic& query)

   .. oe:language:: python

      .. oe:api:: python

         OEReadShapeQuery(filename: str, query: OEShapeQueryPublic) -> bool
         OEReadShapeQuery(filename: str, query: OEShapeQuery) -> bool
         OEReadShapeQuery(ifs: oeistream, query: OEShapeQueryPublic) -> bool
         OEReadShapeQuery(ifs: oeistream, query: OEShapeQuery) -> bool

   The first two overloads reads from a file given in the first parameter
   into the shape query given in the second parameter. The later two
   overloads will read from the stream given in the first parameter
   into the shape query given in the second parameter.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OERemoveColorAtoms

.. oe:function:: OERemoveColorAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OERemoveColorAtoms(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OERemoveColorAtoms(mol: Union[OEGraphMol,OEQMol]) -> None

   Remove all color atoms from the molecule.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OESelfColor

.. oe:function:: OESelfColor

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OESelfColor(const OEChem::OEMolBase& mol,
                           const OEColorForceField& cff, bool allcolor = false)

   .. oe:language:: python

      .. oe:api:: python

         OESelfColor(mol: Union[OEGraphMol,OEMol,OEQMol],
                     cff: OEColorForceField, allcolor: bool = False) -> float

   Calculate the self color score for the given molecule, using the
   passed in color force field.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OESelfShape

..  _OEShape_OESelfShape:

.. oe:function:: OESelfShape

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OESelfShape(const OEChem::OEMolBase& mol,
                           unsigned int radiiApprox = OEOverlapRadii::Carbon,
                           float cradius = 1.7f)

   .. oe:language:: python

      .. oe:api:: python

         OESelfShape(mol: Union[OEGraphMol,OEMol,OEQMol], radiiApprox: int,
                     cradius: float = 1.7) -> float

   Return the self-volume term that can be used in molecular
   similarity measures. The volume is calculated as the
   first-order-gaussian overlap of all the atoms in the molecule to
   itself.

   *mol*

      The molecule to calculate the self-volume for. This molecule is
      expected to have valid 3D coordinates.

   *radiiApprox*

      The approximation to use when calculating the volume. The
      constant should be pulled from the
      :oe:constns:`OEShape::OEOverlapRadii` namespace. The default is
      to approximate all atom types as carbon with the same radius. If
      :oe:const:`OEShape::OEOverlapRadii::All` is given, the radius of
      the atom as returned by :oe:meth:`OEChem::OEAtomBase::GetRadius`
      will be used.

   *cradius*

      The radius to use when the carbon radii approximation is being
      used. The default of 1.7 is based upon the original
      [Grant-1995]_ paper to reproduce hard sphere volumes.

   .. seealso::

      * :ref:`molecular_shape_section`


.. oe:namespace:: OEShape

.. meta::
   :keywords: OESetCachedSelfColor

.. oe:function:: OESetCachedSelfColor

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetCachedSelfColor(OEChem::OEMCMolBase& mol,
                                   const OEColorForceField& cff)
         bool OESetCachedSelfColor(OEChem::OEMolBase& mol,
                                   const OEColorForceField& cff)

   .. oe:language:: python

      .. oe:api:: python

         OESetCachedSelfColor(mol: OEMol, cff: OEColorForceField) -> bool
         OESetCachedSelfColor(mol: Union[OEGraphMol,OEQMol],
                              cff: OEColorForceField) -> bool

   Using the passed-in OEColorForceField, calculate and store the self color
   on each molecule. For the OEMCMolBase, each conformer gets its own
   stored value.  To retrieve the value, use :oe:func:`OEShape::OEGetCachedSelfColor`.
   OEColorOverlap and OEBestOverlay will use the cached value instead of re-calculating
   the self terms.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OESetCachedSelfShape

.. oe:function:: OESetCachedSelfShape

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetCachedSelfShape(OEChem::OEMCMolBase& mcmol,
                                   unsigned int radiiApprox = OEOverlapRadii::Carbon,
                                   float cradius = 1.7f)
         bool OESetCachedSelfShape(OEChem::OEMolBase& mol,
                                   unsigned int radiiApprox = OEOverlapRadii::Carbon,
                                   float cradius = 1.7f)

   .. oe:language:: python

      .. oe:api:: python

         OESetCachedSelfShape(mcmol: OEMol, radiiApprox: int,
                              cradius: float = 1.7) -> bool
         OESetCachedSelfShape(mcmol: Union[OEGraphMol,OEQMol],
                              radiiApprox: int, cradius: float = 1.7) -> bool

   Store the self shape term on the molecule. For the OEMCMolBase, each
   conformer stores its own value. To retrieve the value,
   use :oe:func:`OEShape::OEGetCachedSelfShape`.  OEOverlap and OEBestOverlay
   will use the cached value instead of re-calculating the self terms.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OESetColorParents

..  _OEShape_OESetColorParents:

.. oe:function:: OESetColorParents

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetColorParents(OEChem::OEAtomBase* atom,
                                const OEChem::OEAtomBase** parents,
                                unsigned num)

   .. oe:language:: python

      .. oe:api:: python

         OESetColorParents(atom: OEAtomBase, parents: OEAtomBase, num: int) -> bool

   Set the parent atoms of a given color atom. Not normally used as
   parents are set for color atoms added via a SMARTS match in the
   color force field. But if you are manually creating color atoms,
   this is a way to set its parents.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OESetColorType

.. oe:function:: OESetColorType

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetColorType(OEChem::OEAtomBase* coloratom, unsigned type,
                             const std::string& typeName)
         Set/changes the type of a given color atom.

   .. oe:language:: python

      .. oe:api:: python

         OESetColorType(coloratom: OEAtomBase, type: int, typeName: str) -> bool


.. oe:namespace:: OEShape

.. meta::
   :keywords: OESetCoordsFromColorParents

.. oe:function:: OESetCoordsFromColorParents

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetCoordsFromColorParents(OEChem::OEMCMolBase& mol)
         bool OESetCoordsFromColorParents(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OESetCoordsFromColorParents(mol: OEMol) -> bool
         OESetCoordsFromColorParents(mol: Union[OEGraphMol,OEQMol]) -> bool

   Generates 3D coordinates for the given color atom based on the
   center of mass of that color atom's parents.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeGetArch

.. oe:function:: OEShapeGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEShapeGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEShapeGetArch() -> str

   Returns the architecture of the current version of the Shape
   toolkit. Examples include:

   * microsoft-win32-x86

   * redhat-RHEL5-x86_64


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeGetLicensee

.. oe:function:: OEShapeGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEShapeGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEShapeGetLicensee(licensee: str) -> bool

   Returns the LICENSEE from the current valid Shape TK license.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeGetPlatform

.. oe:function:: OEShapeGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEShapeGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEShapeGetPlatform() -> str

   Returns the platform, including compiler version, of the current
   version of the Shape toolkit. Examples include:

   * microsoft-win32-msvc9-MD-x86

   * redhat-RHEL5-g++4.1-x86_64


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeGetRelease

.. oe:function:: OEShapeGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEShapeGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEShapeGetRelease() -> str

   Returns the version of this toolkit release. For example: ``1.6.1``.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeGetSite

.. oe:function:: OEShapeGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEShapeGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEShapeGetSite(site: str) -> bool

   Returns the SITE from the current valid Shape TK license.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeGetVersion

.. oe:function:: OEShapeGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEShapeGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEShapeGetVersion() -> int

   Returns the build date of the toolkit as an unsigned int. For example: ``20090227``.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeIsLicensed

.. oe:function:: OEShapeIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEShapeIsLicensed(const char* feature = 0,
                                unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEShapeIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **Shape TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **Shape TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **Shape TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function


.. oe:namespace:: OEShape

.. meta::
   :keywords: OESortOverlayScores

.. oe:function:: OESortOverlayScores

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OESortOverlayScores(OESystem::OEIter<OEBestOverlayScore>& dst,
                                  OESystem::OEIter<OEBestOverlayResults>& scores,
                                  const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& sorter,
                                  unsigned nbest = 1, bool conforder = false)

   .. oe:language:: python

      .. oe:api:: python

         OESortOverlayScores(dst: OEBestOverlayScoreIter,
                             scores: OEBestOverlayResultsIter,
                             sorter: OEBestOverlayScoreSorterPred,
                             nbest: int = 1, conforder: bool = False) -> None

   Sort the scores from multiple sets of
   :ref:`OEBestOverlayResults <OEShape_OEBestOverlayResults>` into a single iterator of
   :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>`. The sorting function can be
   one of the pre-defined functors or a user-defined version.

   The ``nbest`` default value of **1** implies that on the best
   overlay for each ref-fit conformer pair is returned. A value
   greater than one will mean multiple overlays for each ref-fit
   conformer pair will be kept.

   Setting ``conforder`` to **true** forces the results to come out
   in conformer index order.  If ``nbest`` is greater than **1** and
   ``conforder`` is **true**, then for each ref-fit conformer pair,
   the scores will be sorted by the sorting function, but each set of
   ref-fit results will come out together.

   Several of the OEBestOverlay examples show variations of these
   values. Perhaps the easiest way to understand them is to modify one
   of the examples and observe the change in the number and order of
   the scores.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEUncompressColorAtoms

.. oe:function:: OEUncompressColorAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEUncompressColorAtoms(OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEUncompressColorAtoms(mol: Union[OEGraphMol,OEQMol]) -> int

   Convert the internal compressed color atoms to actual color
   atoms. Has no effect unless the color atoms were previously
   compressed by :oe:func:`OEShape::OECompressColorAtoms`

   .. note::

      This function was formerly named OEStringToColorAtoms.


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEWriteShapeQuery

.. oe:function:: OEWriteShapeQuery

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteShapeQuery(const char* filename,
                                const OEShapeQueryBase& query)
         bool OEWriteShapeQuery(OEPlatform::oeostream& ofs,
                                const OEShapeQueryBase& query)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteShapeQuery(filename: str, query: OEShapeQueryPublic) -> bool
         OEWriteShapeQuery(filename: str, query: OEShapeQueryBase) -> bool
         OEWriteShapeQuery(ofs: oeostream, query: OEShapeQueryBase) -> bool

   Writes a query given in the second parameter. The first overload writes the query in
   the specified file and the second overload writes it to a :ref:`oeostream <OEPlatform_oeostream>`.
   Method returns ``True`` if write is successful.


.. _shape_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version3_10_0
   version3_9_0
   version3_8_0
   version3_7_0
   version3_6_2
   version3_6_1
   version3_6_0
   version3_5_1
   version3_5_0
   version3_4_3
   version3_4_2
   version3_4_1
   version3_4_0
   version2_0_4
   version2_0_3
   version2_0_2
   version2_0_1
   version2_0_0
   version1_11_0
   version1_10_4
   version1_10_3
   version1_10_2
   version1_10_1
   version1_10_0
   version1_9_7
   version1_9_6
   version1_9_5
   version1_9_4
   version1_9_3
   version1_9_2
   version1_9_1
   version1_9_0
   version1_8_3
   version1_8_2
   version1_8_1
   version1_8_0
   version1_7_2
   version1_7_1
   version1_7_0
   version1_6_2
   version1_6_1
   version1_6
   version1_5



Shape TK 3.10.0
================================================================================

New Features
--------------------------------------------------------------------------------

* When using the :ref:`Overlay<OEShape_OEOverlay_Overlay>`
  method in :ref:`OEOverlay<OEShape_OEOverlay>` for overlay optimization, any of the inertial start
  methods now automatically trigger an additional :ref:`as-is<OEShape_OEAsIsStarts>` start
  if the optimization results in similarity measures less than the original similarity.
  This improves the default behavior of :ref:`Overlay<OEShape_OEOverlay_Overlay>` for
  some calculations.

* The following modifications have been made to :ref:`OEOverlapPrepOptions<OEShape_OEOverlapPrepOptions>`
  to provide more flexibility in assigning color atoms during the :ref:`Prep<OEShape_OEOverlapPrep_Prep>` process
  in :ref:`OEOverlapPrep<OEShape_OEOverlapPrep>`:

    * Two new methods, :ref:`SetRemoveColor<OEShape_OEOverlapPrepOptions_SetRemoveColor>`
      and :ref:`GetRemoveColor<OEShape_OEOverlapPrepOptions_GetRemoveColor>`, have been added
      to enable removal or reassignment of color atoms.
    * The new methods :ref:`AddDuplicateSmarts<OEShape_OEOverlapPrepOptions_AddDuplicateSmarts>`,
      :ref:`GetDuplicateSmarts<OEShape_OEOverlapPrepOptions_GetDuplicateSmarts>`, and
      :ref:`ClearDuplicateSmarts<OEShape_OEOverlapPrepOptions_ClearDuplicateSmarts>` have been added
      to enable duplicate color atom removal based on provided SMARTS patterns.
    * Duplicate color atom removal is now more robust in keeping the central atoms instead 
      of the first atom that it encounters and in placing the remaining atoms appropriately 
      (at the center of corresponding clusters).
    * Defaults for :ref:`SetRemoveDuplicate<OEShape_OEOverlapPrepOptions_SetRemoveDuplicate>`
      and :ref:`SetDuplicateDistance<OEShape_OEOverlapPrepOptions_SetDuplicateDistance>`
      have been changed from ``False`` and `0.001` to ``True`` and `0.0`, respectively. This improves
      robustness but keeps the default behavior unchanged.

* A new method, :ref:`SetupFrame<OEShape_OEStarts_SetupFrame>`, has been added to :ref:`OEStarts<OEShape_OEStarts>`
  that simplifies setting up a reference frame for calculating the starts.

Minor Bug Fixes
--------------------------------------------------------------------------------

* The overlay optimization in :ref:`OEHermiteOverlay<OEShape_OEHermiteOverlay>`
  with the :ref:`OEAsIsStarts<OEShape_OEAsIsStarts>` start option has been updated to use Hermite
  expansions around the center of mass to prevent inconsistent overlaps when objects are
  far from the origin.

* Overlay optimization with the :ref:`Overlay<OEShape_OEOverlay_Overlay>`
  method in :ref:`OEOverlay<OEShape_OEOverlay>` now captures the fit conformer
  self-overlap and color scores more accurately during the optimization.



Shape TK 1.10.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------
* A crash that occurred when attempting to use the Subrocs initial orientation
  method with an :ref:`OEBestOverlay <OEShape_OEBestOverlay>` object to overlay molecules
  onto a reference grid has been fixed. A warning is now issued stating that
  Subrocs matching against grids is not implemented, and that inertial frame 
  alignment will be used instead.


Shape TK 1.10.1
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEShape::OESelfShape` is now nearly two times faster for the
  default case of the carbon radii approximation with the
  :oe:const:`OEShape::OEOverlapRadii::Carbon` constant.

* :oe:func:`OEShape::OEUncompressColorAtoms` performance has been
  improved.

Documentation fixes
--------------------------------------------------------------------------------

* A correction has been made to the Tversky equation in 
  the :ref:`Molecular Shape<shapetk_theory>` section.



Shape TK 1.10.2
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* ``OEShape::OEBestOverlay::SetAllColor(true)`` with custom color atoms will no
  longer result in Tanimoto values larger than 1.0 when custom color
  atoms are placed on the molecule. The bug was located in
  :oe:func:`OEShape::OESelfColor` function when the ``allColor``
  parameter was set to ``true`` and caused the function to
  arbitrarily remove the custom color atoms placed on the molecule and
  recalculate a new set of color atoms based on the color force field
  set. This meant :ref:`OEBestOverlay <OEShape_OEBestOverlay>` was calculating the
  self term and the overlap terms with an entirely different set of
  color atoms. :oe:func:`OEShape::OESelfColor` will now only incur a
  molecule copy and :oe:func:`OEShape::OEAddColorAtoms` when
  :oe:func:`OEShape::OEHasColorAtoms` is ``false``.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OEShape::OEBestOverlay::SetColorForceField` will now throw a warning
  and return ``false`` if :ref:`OEColorForceField <OEShape_OEColorForceField>`
  is not valid, as determined by
  :oe:meth:`OEShape::OEColorForceField::Ready` method.


Shape TK 1.10.3
================================================================================

Python-specific changes
--------------------------------------------------------------------------------

* The :oe:func:`OEShape::OESortOverlayScores` function now accepts a
  custom scoring function derived from the ``OEBestOverlayScoreSorterPred``
  Python class.

Java-specific changes
--------------------------------------------------------------------------------

* The :oe:func:`OEShape::OESortOverlayScores` function now accepts a custom
  scoring function derived from the ``OEBestOverlayScoreSorterPred`` Java class.


Shape TK 1.10.4
================================================================================

* Minor internal improvements have been made.


Shape TK 1.11.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new API has been added to perform Hermite expansion and store the
  approximate shape of drug-size molecules and proteins.

  * The class :ref:`OEHermite <OEShape_OEHermite>` and associated options class
    :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` allows the user to perform
    Hermite expansion of a molecule and output the results to a grid.

  * The class :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>` can be used to obtain a
    best shape overlap of two molecules by approximating each molecule with
    its Hermite representation.

Documentation changes
--------------------------------------------------------------------------------

* An overview of using Hermite expansion for molecular shape can be
  found here :ref:`shapetk_hermite_section`.
 
* A new example section, :ref:`chapter_hermite_shape_examples`, has been
  added to illustrate the capabilities of the new API for Hermite expansion.


.. _section_shapetk_releasenotes_15:

Shape TK 1.5
================================================================================

New features
--------------------------------------------------------------------------------

*  First release in C++, Java and Python.



.. _section_shapetk_releasenotes_16:

Shape TK 1.6
================================================================================

New features
--------------------------------------------------------------------------------

*  Added new functions to calculate steric volume (:oe:func:`OEShape::OECalcVolume`) and steric
   multipoles (:oe:func:`OEShape::OECalcShapeMultipoles`).

Bug fixes
--------------------------------------------------------------------------------

*  Fixed a bug where :oe:func:`OEShape::OEAddColorAtoms` would not
   correctly add color atoms to a molecule that had the IntType field
   on atoms filled from a previous calculation. IntType is scratch
   space on atoms, so :oe:func:`OEShape::OEAddColorAtoms` now clears
   the IntType before adding color atoms to a molecule.

*  Changed one of the cation definitions in ImplicitMillsDean force field
   from the too general ("n:1anaa1") to the more specific ("n:1cncc1").

*  Fixed a bug that caused :oe:const:`OEShape::OEBOOrientation::AsIs`
   to not always start from the passed in positions.



.. _section_shapetk_releasenotes_161:

Shape TK 1.6.1
================================================================================

This is the first release as part of the consolidated toolkits release. 

New features
--------------------------------------------------------------------------------

*  Added functions to retrieve the version and build date of the library.

Bug fixes
--------------------------------------------------------------------------------

*  Changed to a stable sort inside
   :oe:func:`OEShape::OESortOverlayScores` to prevent crashes with a very
   large number of results.

*  Fixes to :ref:`OEOverlap <OEShape_OEOverlap>` that in some cases could result in slow behavior
   when internal grids were rebuilt instead of being cached.

*  Fix a subtle bug that could result in erroneous behavior if reusing
   the same :oe:func:`OEShape::OEOverlap` object while changing the fit
   object from a grid to a molecule or from a molecule to a grid.



.. _section_shapetk_releasenotes_162:

Shape TK 1.6.2
================================================================================

New features
--------------------------------------------------------------------------------

*  Added the ability to get the expiration date from
   :oe:func:`OEShape::OEShapeIsLicensed` function.

Bug fixes
--------------------------------------------------------------------------------

*  Fixed a memory leak in the calculation of self color in OEColorFunc.

*  Fixed a bug that prevented pre-colored molecules from being
   used in OEColorFunc.

*  Replace old error messages that just went to stderr and routed
   all errors and warnings via OEThrow.


.. _section_shapetk_releasenotes_170:

Shape TK 1.7.0
================================================================================

New features
--------------------------------------------------------------------------------

*  Color Tanimoto is calculated just like Shape Tanimoto by using the self color
   scores of each molecule combined with the actual color score. The end result is
   to better match molecules of the same color, penalizing a molecule for having 
   too much as well as too little color. Color Tversky scores can be calculated
   as well. We now calculate these extra color scores in :ref:`OEColorOverlap <OEShape_OEColorOverlap>` and
   :ref:`OEBestOverlay <OEShape_OEBestOverlay>`.

*  :ref:`OEColorResults <OEShape_OEColorResults>` now has Tanimoto, Tversky, RefTversky and FitTversky.

*  :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` now has ColorTanimoto,
   ColorTversky, RefColorTversky, FitColorTversky and adds three new
   combo scores based on these:
  
   * TanimotoCombo - the sum of Shape Tanimoto and Color Tanimoto
   * RefTverskyCombo - the sum of Ref Shape Tversky and Ref Color Tversky
   * FitTverskyCombo - the sum of Fit Shape Tversky and Fit Color Tversky

*  :ref:`OEOverlapResults <OEShape_OEOverlapResults>` now has Tversky, RefTversky and FitTversky.

Bug fixes
--------------------------------------------------------------------------------

*  Fixed an internal memory leak in OEColorOverlap/OEBestOverlap color objects.

*  Fixed a bug where in some cases the user-supplied value for carbon radius
   in OEOverlap was ignored.


.. _section_shapetk_releasenotes_171:

Shape TK 1.7.1
================================================================================

New features
--------------------------------------------------------------------------------

* Added new types in :oe:constns:`OEShape::OEBOOrientation`.  All of
  these are designed to provide a more deterministic search over the
  reference molecule for those case where the size of the fit
  molecule is much smaller than the reference, for example, when trying to
  match a fragment into part of a reference molecule.

  * :oe:const:`OEShape::OEBOOrientation::InertialAtHeavyAtoms` moves
    the center of mass of the fit molecule to each reference molecule
    heavy atom and performs 4 inertial starts at the position. This
    results in many more starting positions, but provides a more
    direct way to search over an entire reference molecule, without
    resorting to random starts.

  * :oe:const:`OEShape::OEBOOrientation::InertialAtColorAtoms`
    performs a similar search as above, but just moves to the
    location of each reference molecule color atom.

  * :oe:const:`OEShape::OEBOOrientation::UserInertialStarts`, used in
    conjunction with :oe:meth:`OEShape::OEBestOverlay::SetUserStarts`
    allows the user to pick specific points in space to perform the 4
    inertial starts.

*  Fixed a bug when calculating Tanimoto while using a grid as the reference
   object.

* Added more functions to manipulate the color atoms on a
  molecule. These include the ability to add color atoms one at a
  time (:oe:func:`OEShape::OEAddColorAtom`) and the ability to get an
  iterator of color atoms from a molecule
  (:oe:func:`OEShape::OEGetColorAtoms`).

* Added a pair of functions (``OEShape::OEColorAtomsToString`` and 
  ``OEShape::OEStringToColorAtoms``) that allow converting the color
  atoms of a molecule into a compressed string representation (that is 
  attached to the molecule) and then to restore the actual color atoms from
  that string. 

Bug fixes
--------------------------------------------------------------------------------

* Fixed a bug that could cause a crash when passing an empty molecule
  into :oe:func:`OEShape::OECalcVolume` or
  :oe:func:`OEShape::OECalcShapeMultipoles`.

* Fixed a bug that could cause a crash when passing large molecules
  to :oe:func:`OEShape::OECalcVolume`.


.. _section_shapetk_releasenotes_172:

Shape TK 1.7.2
================================================================================

New features
--------------------------------------------------------------------------------

* OEAddColorAtoms now has an optional third argument to cause precalculation
  and caching of the self color. When re-using molecules in multiple 
  comparisons (for example NxN studies), use OEAddColorAtoms once and then
  OEBestOverlay and OEColorOverlap will use the pre-stored color atoms and
  self color to speed up the calculations.

* Added a set of functions to manipulate cached self color.

  * :oe:func:`OEShape::OESetCachedSelfColor`
  * :oe:func:`OEShape::OEHasCachedSelfColor`
  * :oe:func:`OEShape::OEGetCachedSelfColor`
  * :oe:func:`OEShape::OEClearCachedSelfColor`

* The pair of functions (``OEColorAtomsToString`` and
  ``OEStringToColorAtoms``) added in v1.7.1 have been
  renamed to more appropriate names. The new functions are
  :oe:func:`OEShape::OECompressColorAtoms` and
  :oe:func:`OEShape::OEUncompressColorAtoms`.

Bug fixes
--------------------------------------------------------------------------------

* Fixed a bug where dummy atoms could cause an erroneous result for 
  OECalcVolume.
  



.. _section_shapetk_releasenotes_180:

Shape TK 1.8.0
================================================================================

New features
--------------------------------------------------------------------------------

* Added new functions that will cache the self shape score on a molecule. 
  Analogous to the caching of self color, introduced in 1.7.2, this can speed
  up repeat shape calculations on the same molecule by not recalculating the 
  self terms.

  * :oe:func:`OEShape::OESetCachedSelfShape`
  * :oe:func:`OEShape::OEHasCachedSelfShape`
  * :oe:func:`OEShape::OEGetCachedSelfShape`
  * :oe:func:`OEShape::OEClearCachedSelfShape`

* Updated the functions that cache self color to store work with multi-conformer
  molecules, storing a self color for each conformer.

* Added two new color force fields, ImplicitMillsDeanNoRings and 
  ExplicitMillsDeanNoRings. These are identical to the existing similarly named
  force fields, but with no "rings" atom types or interactions.

* Added Has and Delete functions to the API for dealing with 
  compressed color atoms.

* Several of the examples have been updated to count the output better and 
  to use a better sort functor when color is included.

* Add new methods to :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` to allow access to the transform.

  * :oe:meth:`OEShape::OEBestOverlayScore::GetRotMatrix`
  * :oe:meth:`OEShape::OEBestOverlayScore::GetTranslation`

Bug fixes
--------------------------------------------------------------------------------

* Added OEGetColorAtoms and OEGetColorParents to Python, Java and C#. 
  
* Fixed a bug where non-deterministic results could sometime occur when
  using OEBestOverlay and a highly symmetric molecule. 

* Fixed calculation of multipoles. Previous versions used a 
  non-irreducible representation of multipoles that is nonstandard. This
  method now calculates standard multipoles and allow better comparison
  between the values of two molecules. 

* Fixed a missing type in ImplicitMillsDean to match an aldehyde 
  acceptor with or without the explicit proton.

* Fixed a bug where OECalcVolume could crash using a molecule with 
  deleted atoms.


.. _section_shapetk_releasenotes_181:

Shape TK 1.8.1
================================================================================

Bug fixes
--------------------------------------------------------------------------------

* Fixing a crash in :oe:func:`OEShape::OECalcVolume` when dealing with
  Zinc and dummy atoms. 

* :oe:func:`OEShape::OECalcVolume` will now default to using
  appropriate Bondi VdW radii when no radii are set on the
  molecule. This effectively changes the value returned this function
  most molecules. 




.. _section_shapetk_releasenotes_182:

Shape TK 1.8.2
================================================================================

* Internal build system improvements. 




.. _section_shapetk_releasenotes_183:

Shape TK 1.8.3
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:meth:`OEShape::OEColorForceField::GetTypes` method added to
  return an iterator of the integer color forcefield types.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEShape::OEAddColorAtoms` was setting an internal flag incorrectly such that :oe:func:`OEShape::OEHasColorAtoms` would return ``true`` even if no color atoms were added. This has been fixed.

* :oe:func:`OEShape::OEAddColorAtom` corrected to also set internal flags regarding presence of color atoms.

* :oe:const:`OEShape::OEBOOrientation::InertialAtHeavyAtoms` will now use the center-of-mass as a startpoint in addition to all heavy atoms.  The constant is an option
  for :oe:meth:`OEShape::OEBestOverlay::SetInitialOrientation`.

* :oe:const:`OEShape::OEBOOrientation::UserInertialStarts` will now work with the reference being a grid.



.. _section_shapetk_releasenotes_190:

Shape TK 1.9.0
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:const:`OEShape::OEBOOrientation::Subrocs` has been added as a new starting
  position method.  This method is very similar to :oe:const:`OEShape::OEBOOrientation::InertialAtHeavyAtoms`,
  except that it automatically uses the heavy atoms and center-of-mass
  of the larger molecule when determining starting positions.

* :ref:`OEShapeQueryPublic <OEShape_OEShapeQueryPublic>` has been added for reading shape queries.  This is an
  initial public implementation with limited functionality.

Major bug fixes
--------------------------------------------------------------------------------

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:const:`OEShape::OEBOOrientation::Subrocs` will now be used for
  highly symmetric molecules instead of random starts.

* :oe:const:`OEShape::OEBOOrientation::Subrocs` and :oe:const:`OEShape::OEBOOrientation::InertialAtHeavyAtoms`
  use the center-of-mass in addition to the heavy atoms when determining starting positions.  




.. _section_shapetk_releasenotes_191:

Shape TK 1.9.1
================================================================================

Bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEShape::OEUncompressColorAtoms` no longer throws
  a warning when no color atoms are present.




.. _section_shapetk_releasenotes_192:

Shape TK 1.9.2
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* A bug has been fixed where :oe:const:`OEShape::OEBOOrientation::Subrocs` was 
  not properly setting starting positions when the database molecule was larger
  than the query molecule. 

* Fixed a rare invalid memory access from the
  :oe:const:`OEShape::OEOverlapMethod::Analytic2` method. 




.. _section_shapetk_releasenotes_193:

Shape TK 1.9.3
================================================================================

* Minor internal improvements. 



.. _section_shapetk_releasenotes_194:

Shape TK 1.9.4
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OEShape::OECalcVolume` will no longer allocate excessive
  amounts of memory and usually crash for molecules without coordinates. 

Minor bug fixes
--------------------------------------------------------------------------------

* Removed unbounded stack allocations. 



.. _section_shapetk_releasenotes_195:

Shape TK 1.9.5
================================================================================

New features
--------------------------------------------------------------------------------

.. oe:language:: c++

  * The C++ **Shape TK** now depends on the ``oeopt`` and ``oemolpotential``
    libraries. Please update build scripts accordingly to account for the
    new dependency.

Major bug fixes
--------------------------------------------------------------------------------

* :ref:`OEBestOverlay <OEShape_OEBestOverlay>` constructor that takes a molecule
  will not terminate the process when given a molecule with only hydrogen atoms. 



.. _section_shapetk_releasenotes_196:

Shape TK 1.9.6
================================================================================

New features
--------------------------------------------------------------------------------

* A new :oe:func:`OEShape::OEHasPerceivedColorAtoms` function has been added for
  determining whether :oe:func:`OEShape::OEAddColorAtoms` has already
  been called on a molecule.

Major bug fixes
--------------------------------------------------------------------------------

* :ref:`OEBestOverlay <OEShape_OEBestOverlay>` will no longer cause undefined
  behavior and frequent crashes, particularly in Java, when more than
  one :ref:`OEBestOverlay <OEShape_OEBestOverlay>` object is created and
  destroyed.

* Dummy atoms (atoms with an atomic number of 0) with non-zero radius
  will no longer cause shape Tanimoto values to exceed
  1.0. These dummy atoms are now properly ignored for shape Tanimoto
  calculations.

* Undefined behavior can now be avoided when handling 32 different types
  of color atoms.

* Internal refactoring has been performed to improve stability. 

Minor bug fixes
--------------------------------------------------------------------------------
Examples of using exclusion volumes in a ROCS search were added for C++, Java, and C#.


Shape TK 1.9.7
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OEShape::OEReadShapeQuery` overload has been added to work on
  :ref:`oeistream <OEPlatform_oeistream>` objects instead of a direct file name.

* :oe:meth:`OEShape::OEOverlap::SetGridSpacing` has been added to allow
  adjusting the grid spacing used by the
  :oe:const:`OEShape::OEOverlapMethod::Grid` shape overlap
  method. Lower values typically yield overlaps that agree more
  closely with the :oe:const:`OEShape::OEOverlapMethod::Exact` method,
  while higher values can sometimes be faster and will diverge more.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:const:`OEShape::OEBOOrientation::Subrocs` will sometimes crash
  when given a grid as the reference. Some of these crashes have been
  fixed, but others are more difficult to pin down and will persist
  till the next release.

Minor bug fixes
--------------------------------------------------------------------------------

* ``OEShape::OEBestOverlayScore::GetTversky`` can now accept alpha
  and beta of ``0.0`` provided both parameters are not ``0.0``.

* :oe:func:`OEShape::OEHasCompressedColorAtoms` return type has changed
  from ``unsigned int`` to ``bool`` as the return value was always
  Boolean.

Documentation changes
--------------------------------------------------------------------------------

* :oe:func:`OEShape::OEHasCompressedColorAtoms` and
  :oe:func:`OEShape::OEDeleteCompressedColorAtoms` have been
  documented and are now fully supported.



Shape TK 2.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* The **Shape TK** has been completely redesigned to make the library
  thread-safe, to make the library more flexible to use, and to allow the API
  to be easily extended with additional functionality.

* Three new classes, :ref:`OEExactShapeFunc <OEShape_OEExactShapeFunc>`,
  :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>`, and
  :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>`, have been added to provide
  static shape overlap calculation based on Exact, Grid, and Analytic
  methods.

* Three new classes, :ref:`OEExactColorFunc <OEShape_OEExactColorFunc>`,
  :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>`, and
  :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>`, have been added to provide
  static color score calculation based on Exact, Grid, and Analytic
  methods.

* A new class, :ref:`OEShapeOptions <OEShape_OEShapeOptions>`, has been added to define
  options related to all :ref:`OEShapeFunc <OEShape_OEShapeFunc>` evaluations.

* A new class, :ref:`OEColorOptions <OEShape_OEColorOptions>`, has been added to define
  options related to all :ref:`OEColorFunc <OEShape_OEColorFunc>` evaluations.

* A new class, :ref:`OEShapeGridOptions <OEShape_OEShapeGridOptions>`, has been added to define
  options related to grid-based method evaluations.

* A new class, :ref:`OEAnalyticOptions <OEShape_OEAnalyticOptions>`, has been added to define
  options related to analytic method evaluations.

* A new class, :ref:`OEOverlapPrep <OEShape_OEOverlapPrep>`, has been added that
  can be used to prepare molecules for shape and/or color calculations.

* A new class, :ref:`OEOverlay <OEShape_OEOverlay>`, has been added that
  can be used to overlay conformers of an :ref:`OEMol <OEChem_OEMol>` on
  a reference system that can be a molecule, grid, or shape query.

* A new class, :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>`, has been added that
  sets all options for overlay optimization using :ref:`OEOverlay <OEShape_OEOverlay>`.
  :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>` provides flexibility to optimize
  based on shape or color or both, to choose any method for shape or
  color calculation, and to optimize overlap or Tanimoto individually for shape
  and color.

* A new class, :ref:`OEROCS <OEShape_OEROCS>`, has been added that
  can be used to generate hits from a database on
  a reference system that can be a molecule, grid, or shape query.
  :ref:`OEROCS <OEShape_OEROCS>` provides top hits based on flexible
  scoring criterion.

* A new class, :ref:`OEROCSOptions <OEShape_OEROCSOptions>`, has been added to define
  options for generating hits using :ref:`OEROCS <OEShape_OEROCS>`.

* A new class, :ref:`OEROCSResult <OEShape_OEROCSResult>`, has been added that
  extends the :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` with overlaid
  conformer structures.

* Three overloads of a new function, :oe:meth:`OEShape::OEROCSOverlay`,
  have been added to provide the best hit between a pair of molecules.

* New unary predicates have been added to terminate a hit search
  calculation using :ref:`OEROCS <OEShape_OEROCS>`:

  * :ref:`OEColorTanimotoCutoff <OEShape_OEColorTanimotoCutoff>`
  * :ref:`OEFitColorTverskyCutoff <OEShape_OEFitColorTverskyCutoff>`
  * :ref:`OEFitTverskyComboCutoff <OEShape_OEFitTverskyComboCutoff>`
  * :ref:`OEFitTverskyCutoff <OEShape_OEFitTverskyCutoff>`
  * :ref:`OEOverlapCutoff <OEShape_OEOverlapCutoff>`
  * :ref:`OERefColorTverskyCutoff <OEShape_OERefColorTverskyCutoff>`
  * :ref:`OERefTverskyComboCutoff <OEShape_OERefTverskyComboCutoff>`
  * :ref:`OERefTverskyCutoff <OEShape_OERefTverskyCutoff>`

* The :ref:`OEShapeQueryPublic <OEShape_OEShapeQueryPublic>` class has been replaced by
  :ref:`OEShapeQuery <OEShape_OEShapeQuery>` and is complete with functionality to
  create and edit a shape query with combinations of molecules, grids,
  and Gaussians.

* With the introduction of the new API classes in **Shape TK**, several
  previously existing classes have been deprecated.  The following table
  shows the deprecated classes and their replacements:

  ===============================   ======================================
  Deprecated Class                  New Class
  -------------------------------   --------------------------------------
  ``OEShape::OEOverlap``            :ref:`OEExactShapeFunc <OEShape_OEExactShapeFunc>`
                                    :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>`
                                    :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>`

  ``OEShape::OEColorOverlap``       :ref:`OEExactColorFunc <OEShape_OEExactColorFunc>`
                                    :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>`
                                    :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>`

  ``OEShape::OEBestOverlay``        :ref:`OEOverlay <OEShape_OEOverlay>`
                                    :ref:`OEROCS <OEShape_OEROCS>`

  ``OEShape::OEColorResults``       :ref:`OEOverlapResults <OEShape_OEOverlapResults>`

  ``OEShape::OEShapeQueryPublic``   :ref:`OEShapeQuery <OEShape_OEShapeQuery>`
  ===============================   ======================================

* With the introduction of the new API, several obsolete functionalities
  have been removed.  These functionalities were added in
  the early development days of **Shape TK** and are no longer deemed useful.
  Methods related to such functionality, contained within the deprecated
  classes, are now ignored. The list of methods that fall into this category,
  with their current behavior, is as follows:

  * ``OEShape::OEOverlap::Overlap(const OESystem::OEScalarGrid&, OEOverlapResults&)``: The method does nothing and returns ``false``.
  * ``OEShape::OEOverlap::SetFitGrid(const OESystem::OEScalarGrid&)``: The method does nothing and returns ``false``.
  * ``OEShape::OEOverlap::SetRepresentationLevel(unsigned int)``: The method does nothing and returns ``false``.  The default representation level is ``OEShape::OEOverlapRepresentation::Atomic``.
  * ``OEShape::OEColorOverlap::SetAllColor(bool)``: The method does nothing and returns ``false``. The default ``AllColor`` state is ``true``.
  * ``OEShape::OEBestOverlay::SetAllColor(bool)``: The method does nothing and returns ``false``. The default ``AllColor`` state is ``true``.
  * ``OEShape::OEBestOverlay::SetInertialAxialDivisions(unsigned int)``: The method does nothing and returns ``false``.
  * ``OEShape::OEBestOverlay::SetRepresentationLevel(unsigned int)``: The method does nothing and returns ``false``.  The default representation level is ``OEShape::OEOverlapRepresentation::Atomic``.
  * ``OEShape::OEBestOverlay::Overlay(const OESystem::OEScalarGrid&)``: The method does nothing and returns an empty iterator.

Minor Bug Fixes
--------------------------------------------------------------------------------

* The Hermite grid generated by :ref:`OEHermite <OEShape_OEHermite>` was previously
  offset from the original frame of the molecule being expanded.  This has
  been corrected.

* Previously, using a molecule without 3D coordinates as a reference for an
  overlay had caused a crash.  This has been fixed.

Documentation changes
--------------------------------------------------------------------------------

* The **ShapeTK** examples have been rewritten to illustrate the use of
  the new API.  The various ``bestOverlay`` examples now have
  more descriptive names.


Shape TK 2.0.1
================================================================================

New features
--------------------------------------------------------------------------------

* A new class, :ref:`OEMultiRefOverlay <OEShape_OEMultiRefOverlay>`, has been added to
  provide overlay optimization with a multi-conformer molecule as the
  reference.

* A new method, :oe:meth:`OEShape::OEOverlay::BestOverlay`, has been added to
  provide the single best :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` as output from
  an overlay optimization calculation.

* Two new methods, :oe:meth:`OEShape::OEColorOptions::SetScoreType` and
  :oe:meth:`OEShape::OEColorOptions::GetScoreType`, have been added to
  control color optimization options.

* A new class, :ref:`OEHighestTverskyCombo <OEShape_OEHighestTverskyCombo>`, has been added to
  sort :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` based on TverskyCombo.

* Instantiation of the old API classes :ref:`OEBestOverlay <OEShape_OEBestOverlay>`,
  :ref:`OEOverlap <OEShape_OEOverlap>`, and :ref:`OEColorOverlap <OEShape_OEColorOverlap>` now
  produces a warning message stating that the class is deprecated.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue related to **Shape TK** requiring a case license has been fixed.

* An issue related to overlay optimization when an
  :ref:`OEShapeQuery <OEShape_OEShapeQuery>` class with only Gaussians as the reference
  has been fixed.

* An unnecessary warning that occurred when an
  :ref:`OEColorForceField <OEShape_OEColorForceField>` was initialized with
  :oe:const:`OEShape::OEColorFFType::Custom` has been removed.

* A SMARTS definition in ``ImplicitMillsDean`` that incorrectly defined an
  anion on the central carbon of a malate-like molecule with no hydrogen
  has been fixed.

Documentation changes
--------------------------------------------------------------------------------

* The ``hermite-tanimoto`` example in both C++ and Python has been modified to
  move the fit molecule to the overlaid position.

* A Python example for performing best overlay calculations using 
  multithreading has been added.


Shape TK 2.0.2
================================================================================

New features
--------------------------------------------------------------------------------

* Hermite classes :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>`, :ref:`OEHermite <OEShape_OEHermite>`,
  and :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>` have graduated from preliminary API
  to stable API status for the 2018.Oct release.

* The :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>` class now derives
  from :ref:`OEShapeFunc <OEShape_OEShapeFunc>`.
  As a result, Hermite overlay can be done more efficiently
  using the :ref:`OEOverlay <OEShape_OEOverlay>` class.

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:meth:`OEShape::OEHermite::Setup` method now takes an :ref:`OEMolBase <OEChem_OEMolBase>`
  rather than a :ref:`OEMCMolBase <OEChem_OEMCMolBase>` parameter.

* The ``OEShape::OEColorFunc::operator=`` method has been fixed.

Java-specific changes
--------------------------------------------------------------------------------

* :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>`, :ref:`OEHermite <OEShape_OEHermite>`,
  and :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>` are now available in Java.

C#-specific changes
--------------------------------------------------------------------------------

* :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>`, :ref:`OEHermite <OEShape_OEHermite>`,
  and :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>` are now available in C#.

Documentation changes
--------------------------------------------------------------------------------

* Java and C# examples have been added to the :ref:`chapter_hermite_shape_examples`
  examples.


Shape TK 2.0.3
================================================================================

New features
--------------------------------------------------------------------------------

* A new overload of :oe:func:`OEShape::OEWriteShapeQuery` has been added
  that writes queries to an :ref:`oeostream <OEPlatform_oeostream>` object.

Minor bug fixes
--------------------------------------------------------------------------------

* :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>` and
  :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>` now produce
  a value of ``1.0`` for self-shape Tanimoto. 

* :ref:`OEOverlay <OEShape_OEOverlay>` now properly handles empty query objects and
  queries consisting of only color atoms.

* :ref:`OEOverlay <OEShape_OEOverlay>` now properly handles molecules without
  coordinates.

* The :ref:`OEColorFunc <OEShape_OEColorFunc>` assignment operator has been fixed.

Documentation changes
--------------------------------------------------------------------------------

* Code examples in the :ref:`shape_part_examples` section have been revised.


Shape TK 2.0.4
================================================================================

New features
--------------------------------------------------------------------------------

* Two new methods, :oe:meth:`SetMultiplier<OEShape::OEColorOptions::SetMultiplier>`
  and :oe:meth:`GetMultiplier<OEShape::OEColorOptions::GetMultiplier>`, have been
  added to the :ref:`OEColorOptions <OEShape_OEColorOptions>` class that enable use of a multiplier
  to the calculated color scores.

Minor bug fixes
--------------------------------------------------------------------------------

* The Python example in the section, :ref:`section_nxnshape_example`, has been fixed.

* The multithread version of the Python example in
  :ref:`section_best_optimization_example` has been fixed.




Shape TK 3.4.0
================================================================================

As part of the integration of **OEToolkits** and **OEApplications** into a single
release, the version number of **Shape TK** has been upgraded to 3.4.0 to make it consistent
with that of the **ROCS** application.

Minor bug fixes
--------------------------------------------------------------------------------

* The following methods now return ``bool`` instead of a ``void``:

  * :oe:meth:`OEShape::OEShapeOptions::SetCarbonRadius`
  * :oe:meth:`OEShape::OEShapeOptions::SetRadiiApproximation`
  * :oe:meth:`OEShape::OEShapeOptions::SetScoreType`
  * :oe:meth:`OEShape::OEColorOptions::SetMultiplier`
  * :oe:meth:`OEShape::OEColorOptions::SetScoreType`
  * :oe:meth:`OEShape::OEAnalyticOptions::SetExpType`
  * :oe:meth:`OEShape::OEAnalyticOptions::SetProxyGridCutoff`
  * :oe:meth:`OEShape::OEAnalyticOptions::SetUseProxyGrid`
  * :oe:meth:`OEShape::OEShapeGridOptions::SetDerivativeType`
  * :oe:meth:`OEShape::OEShapeGridOptions::SetGridSpacing`
  * :oe:meth:`OEShape::OEOverlayOptions::SetMaxOptSteps`
  * :oe:meth:`OEShape::OEROCSOptions::SetConfsPerHit`
  * :oe:meth:`OEShape::OEROCSOptions::SetMaxHits`
  * :oe:meth:`OEShape::OEROCSOptions::SetNumBestHits`
  * :oe:meth:`OEShape::OEROCSOptions::SetPerformPrep`
  * :oe:meth:`OEShape::OEROCSOptions::SetUseMaxHits`

.. ExplicitMillsDeanNoRings not defined elsewhere in docs

* The explicit Mills-Dean color force fields, :ref:`ExplicitMillsDean <OEShape_OEColorFFType_ExplicitMillsDean>`
  and :ref:`ExplicitMillsDean <OEShape_OEColorFFType_ExplicitMillsDeanNoRings>`,
  now accurately treat a tertiary amine as a donor and not an acceptor.

* The :oe:meth:`OEShape::OEColorForceField::AddColorer` method now checks to ensure that
  the SMARTS patterns added as color do not have a mix of explicit and implicit hydrogen
  expressions.

* The :oe:meth:`OEShape::OEOverlapPrep::Prep` and :oe:func:`OEShape::OEAddColorAtoms` methods now
  properly handle color atom assignments for molecules with explicit hydrogens and color SMARTS
  patterns containing hybridization.




Shape TK 3.4.1
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------
* A new function, :ref:`OEIsFastROCSShapeQuery <OEShape_OEIsFastROCSShapeQuery>`, has been added that determines if
  an :ref:`OEShapeQuery <OEShape_OEShapeQuery>` object is compatible with **FastROCS TK**.

Major bug fixes
--------------------------------------------------------------------------------
* An issue that caused performance slowdown in :ref:`OESelfShape <OEShape_OESelfShape>` has been fixed.

* An issue that caused :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>` to give incorrect results when used with
  a custom color force field containing a range value other than 1.0 has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* The UserColor example has been updated to more robustly check return statuses.
  See :ref:`chapter_shape_examples`.




Shape TK 3.4.2
================================================================================

*July 2021*

Major bug fixes
--------------------------------------------------------------------------------

* A bug that caused some molecules to get a perfect Shape Tanimoto score of 1.0,
  even though their overlap was not optimal, has been fixed.




Shape TK 3.4.3
================================================================================

*Fall 2021*

New features
--------------------------------------------------------------------------------

* A new method, :ref:`OEMol2Query <OEShape_OEMol2Query>`, has been added that creates an
  :ref:`OEShapeQuery <OEShape_OEShapeQuery>` from an input :ref:`OEMolBase <OEChem_OEMolBase>`.

* A new preliminary API class, :ref:`OEColorFFParameter <OEShape_OEColorFFParameter>`,
  has been added as part of the extended set of :ref:`OEParameter <OESystem_OEParameter>` classes.
  The new parameter class works with predefined color force fields using an 
  :ref:`OEColorForceField <OEShape_OEColorForceField>` object.

Minor bug fixes
--------------------------------------------------------------------------------

* :ref:`OESetColorParents <OEShape_OESetColorParents>` now errors out properly if the color atom
  and the parent atoms specified do not have the same parent molecule.





Shape TK 3.5.0
================================================================================

New features
--------------------------------------------------------------------------------

* The new preliminary API classes,
  
  * :ref:`OEFlexiOverlapFunc <OEShape_OEFlexiOverlapFunc>`
  * :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>`
  * :ref:`OEFlexiOverlapResults <OEShape_OEFlexiOverlapResults>`

  have been added which provide an
  interface for overlap calculation between a reference molecule and a fit 
  molecule using Shape and Color similarity along with intra-molecular force 
  field of a fit molecule.
  
* The new preliminary API classes,

  * :ref:`OEFlexiOverlay <OEShape_OEFlexiOverlay>`
  * :ref:`OEFlexiOverlayOptions <OEShape_OEFlexiOverlayOptions>`

have been added which provide an interface for flexible overlay optimization 
between a reference molecule and a fit molecule conformers using Shape and 
Color similarity along with intra-molecular force field of a fit molecule. 

Minor bug fixes
--------------------------------------------------------------------------------

* Swig wrapping issue for
  :oe:meth:`GetShapeGaussians<OEShape::OEShapeQueryBase::GetShapeGaussians>`
  and :oe:meth:`GetColorGaussians<OEShape::OEShapeQueryBase::GetColorGaussians>`
  have been fixed.




Shape TK 3.5.1
================

New features
--------------------------------------------------------------------------------
* The following new methods have been added to  
  :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>`
  to improve flexibility in defining parameters:

    * :ref:`SetShapeFuncType <OEShape_OEOverlayOptions_SetShapeFuncType>`
    * :ref:`GetShapeFuncType <OEShape_OEOverlayOptions_GetShapeFuncType>`
    * :ref:`SetColorFuncType <OEShape_OEOverlayOptions_SetColorFuncType>`
    * :ref:`GetColorFuncType <OEShape_OEOverlayOptions_GetColorFuncType>`
    * :ref:`SetShapeOptions <OEShape_OEOverlayOptions_SetShapeOptions>`
    * :ref:`GetShapeOptions <OEShape_OEOverlayOptions_GetShapeOptions>`
    * :ref:`SetColorOptions <OEShape_OEOverlayOptions_SetColorOptions>`
    * :ref:`GetColorOptions <OEShape_OEOverlayOptions_GetColorOptions>`

* A new overload for the method :ref:`CreateGrid <OEShape_OEHermite_CreateGrid>` has been
  added that takes a transform object as an additional argument that
  is applied after the grid is generated.

Major bug fixes
--------------------------------------------------------------------------------
* Default forcefields in :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>`
  now ignore electrostatic interactions, as electrostatics appear to have
  negligible effects on optimized overlaid structures.  Ignoring the electrostatic
  interactions also improves efficiency of optimization for the corresponding
  :ref:`OEFlexiOverlapFunc <OEShape_OEFlexiOverlapFunc>`.

* The default for :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>` in
  :ref:`OEFlexiOverlayOptions <OEShape_OEFlexiOverlayOptions>` now consists of
  ``Shape`` only and no ``Color``.  The default ``Shape score`` used
  is :ref:`Overlap <OEShape_OEScoreType_Overlap>`.

Minor bug fixes
--------------------------------------------------------------------------------
* A mismatch between the Hermite grid and the input molecule has been fixed.

* The maximum value on the Hermite resolution parameter has been increased from 30 to 100.

Documentation changes
--------------------------------------------------------------------------------
The following C++ and Python examples have been added to demonstrate how to use
new preliminary APIs:

* Two new C++ and Python examples have been added to the
  :ref:`chapter_flexi_overlay_examples` 
  section that show flexible overlay optimization of the fit molecules
  against a single reference molecule conformer. 
  
* When using
  :ref:`BestOverlay<OEShape_OEFlexiOverlay_BestOverlay>`, only one
  conformer that has the highest Tanimoto-combo similarity to the reference
  molecule is returned. 




Shape TK 3.6.0
================================================================================

New features
--------------------------------------------------------------------------------
* :ref:`OEFlexiOverlapFunc <OEShape_OEFlexiOverlapFunc>` and 
  :ref:`OEFlexiOverlay <OEShape_OEFlexiOverlay>` have been updated to 
  allow users to use a 
  Shape Query as the reference system.  This allows
  :ref:`OEFlexiOverlapFunc SetupRef <OEShape_OEFlexiOverlapFunc_SetupRef>` and
  :ref:`OEFlexiOverlay SetupRef <OEShape_OEFlexiOverlay_SetupRef>` to
  accept a Shape Query.

* A new method, :ref:`SetupFlex <OEShape_OEOverlapFuncBase_SetupFlex>`,
  has been added.  This method can be used to set up overlap calculation functions when
  molecules are expected to be flexible and their self overlaps 
  are not fixed to the initial value.

* A new method, :ref:`SortedOverlay <OEShape_OEOverlay_SortedOverlay>`,
  has been added as an alternative to :ref:`Overlay <OEShape_OEOverlay_Overlay>`.
  This method provides a desired number of top hit results instead of all
  of the hits and is especially suitable when working with molecules
  with excessive numbers of conformers.

* Two additional control flags, :ref:`GetRigidOverlay <OEShape_OEFlexiOverlayOptions_GetRigidOverlay>` and
  :ref:`SetRigidOverlay <OEShape_OEFlexiOverlayOptions_SetRigidOverlay>`, have been added to
  the :ref:`OEFlexiOverlayOptions <OEShape_OEFlexiOverlayOptions>` class. 
  These flags indicate if rigid overlay optimization between the fit molecule 
  conformers and the reference system should be performed prior to the flexible 
  optimization.

Major bug fixes
--------------------------------------------------------------------------------
* An issue in :ref:`OEFlexiOverlay <OEShape_OEFlexiOverlay>` 
  that caused a TanimotoCombo value greater than 2.0 when a molecule was 
  flexibly fitted against itself has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------
* The default value for the ``color`` function in 
  :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` during
  :ref:`OEFlexiOverlay <OEShape_OEFlexiOverlay>` has been changed from
  ``none`` to ``exact``.  This ensures that color overlaps are reported
  when flexible optimization is performed with default parameters.

* An issue has been fixed with :ref:`OEFlexiOverlay <OEShape_OEFlexiOverlay>`
  that was causing shape Tanimoto to be occasionally reported as larger than 1.0
  after a flexible optimization.

* The legal range of values for the color score multiplier 
  has been added to the 
  :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` and 
  :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>` option classes.

* :ref:`OEColorFFParameter <OEShape_OEColorFFParameter>` 
  now allows users to select `explicitmillsdeannorings` properly
  as the color force field.

* The acceptable ranges for the number of optimization iteration 
  steps have been defined for 
  :ref:`OEFlexiOverlayOptions <OEShape_OEFlexiOverlayOptions>` and 
  :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>`.

* Newer implementation of Hermite code had limits on lambda
  parameters of the expansion. In rare cases, these were affecting the lambda parameter
  search (Newton optimization stepping outside the limits). Removing the limits fixed the previous problems with
  finding lambda parameters.

.. WIP * Default contour values
  for shape representation have been adjusted for visual representation of large
  proteins.




Shape TK 3.6.1
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* Memory consumption when initiating an
  :ref:`OEColorForceField <OEShape_OEColorForceField>` has been reduced
  by moving instantiation of internal :ref:`OESubSearch <OEChem_OESubSearch>`-based
  `colorer` objects to a lazy instantiation mode.





Shape TK 3.6.2
================================================================================

New features
--------------------------------------------------------------------------------

* The following preliminary API classes have been made permanent.

  * :ref:`OEColorFFParameter<OEShape_OEColorFFParameter>`
  * :ref:`OEFlexiOverlapFunc<OEShape_OEFlexiOverlapFunc>`
  * :ref:`OEFlexiOverlapOptions<OEShape_OEFlexiOverlapOptions>`
  * :ref:`OEFlexiOverlapResults<OEShape_OEFlexiOverlapResults>`
  * :ref:`OEFlexiOverlay<OEShape_OEFlexiOverlay>`
  * :ref:`OEFlexiOverlayOptions<OEShape_OEFlexiOverlayOptions>`

* New methods, :ref:`SetAtomStrength<OEShape_OEShapeQuery_SetAtomStrength>`
  and :ref:`GetAtomStrength<OEShape_OEShapeQueryBase_GetAtomStrength>`, have been
  added that allow multiplying the contribution of shape overlap for any atoms,
  without adding an additional atom or Gaussian.





Shape TK 3.7.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new method, :ref:`AddColorGaussians <OEShape_OEShapeQuery_AddColorGaussians>`,
  has been added that allows adding color Gaussians to the
  :ref:`OEShapeQuery <OEShape_OEShapeQuery>` based on intensity of values
  on a grid.

* A new class, :ref:`OEOverlapPrepOptions <OEShape_OEOverlapPrepOptions>`,
  has been added that allows modifying options that would be
  used during the :ref:`Prep <OEShape_OEOverlapPrep_Prep>`. Subsequently,
  a new constructor for :ref:`OEOverlapPrep<OEShape_OEOverlapPrep>`
  has been added that takes the :ref:`OEOverlapPrepOptions <OEShape_OEOverlapPrepOptions>`
  as an argument.

Minor bug fixes
--------------------------------------------------------------------------------

* Color force field names in :ref:`OEColorFFParameter <OEShape_OEColorFFParameter>`
  are now treated as case-insensitive.



Shape TK 3.8.0
================================================================================

New Features
--------------------------------------------------------------------------------
* A new method, :ref:`AddShapeGaussians <OEShape_OEShapeQuery_AddShapeGaussians>`,
  has been added that allows adding shape Gaussians to the
  :ref:`OEShapeQuery <OEShape_OEShapeQuery>` based on the intensity of values
  on a grid.

* A new class, :ref:`OEShapeQueryOptions <OEShape_OEShapeQueryOptions>`,
  has been added that allows modifying options that would be
  used in adding Gaussians using the :ref:`AddColorGaussians <OEShape_OEShapeQuery_AddColorGaussians>` 
  and :ref:`AddShapeGaussians <OEShape_OEShapeQuery_AddShapeGaussians>`. Subsequently,
  a new constructor for :ref:`OEShapeQuery<OEShape_OEShapeQuery>`
  has been added that takes the :ref:`OEShapeQueryOptions <OEShape_OEShapeQueryOptions>`
  as an argument.





Shape TK 3.9.0
================================================================================

New Features
--------------------------------------------------------------------------------

* The :ref:`SetupRef<OEShape_OEOverlay_SetupRef>` method in 
  :ref:`OEOverlay<OEShape_OEOverlay>` now accepts molecules containing only color
  atoms. Accordingly, any molecule containing only color atoms or an
  :ref:`OEShapeQuery<OEShape_OEShapeQuery>` containing only color Gaussians
  can now be used as a reference for overlay optimization.

* The :ref:`SetupRef<OEShape_OEOverlapFuncBase_SetupRef>` method in 
  :ref:`OEOverlapFunc<OEShape_OEOverlapFunc>` now accepts molecules and
  :ref:`OEShapeQuery<OEShape_OEShapeQuery>` containing just color components.

* A new class, :ref:`OEHermiteOverlay <OEShape_OEHermiteOverlay>`, and a corresponding options class,
  :ref:`OEHermiteOverlayOptions <OEShape_OEHermiteOverlayOptions>`, are introduced, enabling
  overlays using the Hermite expansion approach. Three types of reference and database molecule
  representations are supported: Hermite vector, molecule, and scalar grid. Consequently, grid/grid
  overlays are enabled by using these classes.

* The grid-to-Gaussians fit algorithm, to add Gaussians in an :ref:`OEShapeQuery<OEShape_OEShapeQuery>`
  using :ref:`AddShapeGaussians<OEShape_OEShapeQuery_AddShapeGaussians>` and 
  :ref:`AddColorGaussians<OEShape_OEShapeQuery_AddColorGaussians>`,
  has been improved for better representation of the grid by the generated Gaussians.
  With the introduction of the modified algorithm, some of the associated options in
  :ref:`OEShapeQueryOptions <OEShape_OEShapeQueryOptions>` are no longer relevant and have been
  removed from the class API. The following functions have been removed:

  * ``GetDuplicateDistance`` and ``SetDuplicateDistance``
  * ``GetMaxNumGaussians`` and ``SetMaxNumGaussians``

* A new overload has been added for :ref:`Transform <OEShape_OEBestOverlayScore_Transform>` that enables
  transformation of a scalar grid by the rigid transformation in 
  :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>`.

* A new overload has been added for :ref:`Setup<OEShape_OEStarts_Setup>` that enables
  setting up :ref:`OEStarts<OEShape_OEStarts>` with known fit symmetry.

* The following new methods have been added to :ref:`OEHermite <OEShape_OEHermite>` to
  enhance usability:

  * :ref:`NumCoefficients<OEShape_OEHermite_NumCoefficients>`
  * A new overload for :ref:`GetCoefficients<OEShape_OEHermite_GetCoefficients>`

Minor Bug Fixes
--------------------------------------------------------------------------------

* An issue related to :ref:`Init <OEShape_OEColorForceField_Init>`
  was causing intermittent slowdown in some API calls, especially in CUDA-enabled builds. This has been fixed.



.. spicolitk toolkit documentation master file

#################################
Spicoli Toolkit |spicoli_version|
#################################

..  oe:language:: python

    .. toctree::
       :maxdepth: 3

       theory
       selected_examples_python
       api
       releasenotes/index

..  oe:language:: c++ csharp java

    .. toctree::
       :maxdepth: 3

       theory
       api
       releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _spicoli_part_theory:

**************
Theory
**************

The Spicoli toolkit provides broad functionality for creating, manipulating,
and analyzing surfaces of many types. Surfaces can be created from molecules,
grids, or other surfaces, and can be cropped, colored, and modified to enable
visual and analytical analyses. The Spicoli library also provides support for
saving and reading surface files.

.. toctree::
   :maxdepth: 2

   surfaces
   generation
   splitting
   manipulation
   storage


.. _surfaces:

################
Surfaces
################

In Spicoli, the surface is presented as a first-class object, i.e., an
object in its own right, named :ref:`OESurface <OESpicoli_OESurface>`. This
presentation requires a minimalist definition similar to the way
*OEChem* represents molecules as a collection of atoms and
bonds. Basically, both :oe:cls:`OESurfaces <OESpicoli::OESurface>` and
:oe:cls:`OEMolBases <OEChem::OEMolBase>` represent a graph in computer
memory.

An :ref:`OESurface <OESpicoli_OESurface>` provides two ways of retrieving
data. The first is a set of methods that will return a copy of the
entire underlying data array,
e.g. :oe:meth:`GetVertices<OESpicoli::OESurface::GetVertices>`. The
second is a set of methods that allow random access directly into the
array of data,
e.g. :oe:meth:`GetVertex<OESpicoli::OESurface::GetVertex>`. Basic usage
of both will be shown for vertices and triangles.

.. _surfaces_vertices:

********
Vertices
********

The simplest datum in a surface is the vertex: a set of ``(x, y, z)``
coordinates. Vertices are stored internally as an array of large
enough to hold ``GetNumVertices() * 3`` floats. :ref:`Figure 1
<figure_vertices_array>` shows how equivalent dimensions are stored at
every third place in the array:

.. _figure_vertices_array:

.. figure:: /_images/VerticesArray.png
   :align: center

   **Figure 1**

   Arrangement of coordinates in the vertices array

A copy of this array can be obtained using the code fragment in
:oe:src:`Listing 1<SNIPPET-GetVertices-SurfaceDataAccess>`, where surf
is a :ref:`OESurface <OESpicoli_OESurface>` object.

.. oe:source:: SurfaceDataAccess.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-GetVertices
   :caption: Example of retrieving the coordinates of all the vertices
   :refnum: 1

.. oe:source:: SurfaceDataAccess.py
   :language: python
   :frag:     SNIPPET-GetVertices
   :caption: Example of retrieving the coordinates of all the vertices
   :refnum: 1

..  oe:language:: python

   :ref:`Full listing. <listing-SurfaceDataAccess.py>`

.. oe:source:: SurfaceDataAccess.java
   :language: java
   :noindent:
   :frag:     SNIPPET-GetVertices
   :caption: Example of retrieving the coordinates of all the vertices
   :refnum: 1

.. oe:source:: SurfaceDataAccess.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-GetVertices
   :caption: Example of retrieving the coordinates of all the vertices
   :refnum: 1

For direct access to the vertex array use
:oe:meth:`OESpicoli::OESurface::GetVertex`. :oe:src:`Listing
2<SNIPPET-GetVertex-SurfaceDataAccess>` is a code fragment
that shows how to iterate over all the vertex coordinates of a
surface.

.. oe:source:: SurfaceDataAccess.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-GetVertex
   :caption: Example of iterating over all vertices
   :refnum: 2

.. oe:source:: SurfaceDataAccess.py
   :language: python
   :frag:     SNIPPET-GetVertex
   :caption: Example of iterating over all vertices
   :refnum: 2

..  oe:language:: python

   :ref:`Full listing. <listing-SurfaceDataAccess.py>`

.. oe:source:: SurfaceDataAccess.java
   :language: java
   :noindent:
   :frag:     SNIPPET-GetVertex
   :caption: Example of iterating over all vertices
   :refnum: 2

.. oe:source:: SurfaceDataAccess.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-GetVertex
   :caption: Example of iterating over all vertices
   :refnum: 2

.. _surfaces_triangles:

*********
Triangles
*********

A triangle in Spicoli is a set of three vertices. However, it is
important that the order of these vertices be locally consistent. To
maintain this consistency vertices of the triangles are defined in a
clockwise fashion.

Consider the two triangles in :ref:`figure_TwoTriangles` defined by
the vertices ``A, B, C, D``. The triangle on the left is defined by
the set ``(A, B, C)``. The triangle on the right is defined by the set
``(D, B, A)``. Also notice how the edge ``AB`` is defined in both
triangles but in opposite order. This reversal of order in the two
definitions is a direct consequence of the clockwise ordering rule.

.. _figure_TwoTriangles:

.. figure:: /_images/TwoTriangles.png
   :align:  center

   **Figure 2** 

   Two adjacent triangles in a surface

All the methods of construction described in this document obey this
rule. A surface that does not follow this rule can still be operated
on by Spicoli, but it is not considered a canonical surface and some
results may be incorrect or ambiguous.

Spicoli stores triangle vertices as an integer array large enough to
hold ``GetNumTriangles() * 3`` unsigned integers. Each integer is an
index into the vertex array explained in
:ref:`surfaces_vertices`. :oe:src:`Listing
3<SNIPPET-GetTriangles-SurfaceDataAccess>` is a code fragment that
will retrieve a copy of the entire triangles array.

.. oe:source:: SurfaceDataAccess.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-GetTriangles
   :caption: Example of retrieving the indices of all the triangles
   :refnum: 3

.. oe:source:: SurfaceDataAccess.py
   :language: python
   :frag:     SNIPPET-GetTriangles
   :caption: Example of retrieving the indices of all the triangles
   :refnum: 3

..  oe:language:: python

   :ref:`Full listing. <listing-SurfaceDataAccess.py>`

.. oe:source:: SurfaceDataAccess.java
   :language: java
   :noindent:
   :frag:     SNIPPET-GetTriangles
   :caption: Example of retrieving the indices of all the triangles
   :refnum: 3

.. oe:source:: SurfaceDataAccess.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-GetTriangles
   :caption: Example of retrieving the indices of all the triangles
   :refnum: 3

For direct access to the triangles array use
:oe:meth:`OESpicoli::OESurface::GetTriangle`. :oe:src:`Listing
4<SNIPPET-GetTriangle-SurfaceDataAccess>` is a code fragment
that shows how to iterate over all the triangles of a surface.

.. oe:source:: SurfaceDataAccess.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-GetTriangle
   :caption: Example of iterating over all triangles
   :refnum: 4

.. oe:source:: SurfaceDataAccess.py
   :language: python
   :frag:     SNIPPET-GetTriangle
   :caption: Example of iterating over all triangles
   :refnum: 4

..  oe:language:: python

   :ref:`Full listing. <listing-SurfaceDataAccess.py>`

.. oe:source:: SurfaceDataAccess.java
   :language: java
   :noindent:
   :frag:     SNIPPET-GetTriangle
   :caption: Example of iterating over all triangles
   :refnum: 4

.. oe:source:: SurfaceDataAccess.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-GetTriangle
   :caption: Example of iterating over all triangles
   :refnum: 4

.. _surfaces_normal_vectors:

**************
Normal Vectors
**************

The emphasis on triangle vertex ordering is to support the notion of
the triangle's front and back. The front of the triangle is the side
that the vertices appear ordered in a clockwise fashion. Surface
normals can then be calculated to point out from the front of the
triangle (and conversely from the back of the triangle).

The :ref:`OESurface <OESpicoli_OESurface>` also supports vertex normals since
vertices are often easier to work with analytically. Vertex normals
are calculated by averaging all of the face normals of triangles of
which the vertex is a part. The following figures contrasts the
differences between face and vertex normals respectively.

.. list-table:: 

   * - .. image:: images/FaceNormals.png

     - .. image:: images/VertexNormals.png

   * - **Figure 3**

     - **Figure 4**
     
   * - Face normals point out of perpendicular to the triangle

     - Vertex normals are the average of the vertices face normals 
     
Vectors in Spicoli are represented by three floating point
values. Normal vectors are always of unit length. They can be
calculated and stored on a :ref:`OESurface <OESpicoli_OESurface>` object by
invoking the free functions :oe:meth:`OESpicoli::OECalculateNormals`
and :oe:meth:`OESpicoli::OECalculateFaceNormals` for vertex and face
normals, respectively.

It is important to remember that the size of a normal array is
determined by whether it is a face or vertex normal. For example the
size of the vertex normal array is ``GetNumVertices() * 3``
floats. While the size of the face normal array is
``GetNumTriangles() * 3`` floats.

.. _surfaces_specific_data:

*************
Specific Data
*************

Specific data is any information that can be derived from the surface
alone but not from any one triangle or vertex. Currently these
properties include the following:

Curvature
    (``float``) Solvent accessibility of the vertex 
Distance
    (``float``) The Euclidean distance to the vertex from another portion of the surface 

Curvature follows a pragmatic computational chemistry definition. It
is a property of solvent molecules, represented as spheres, packed
onto the surface. :ref:`Figures 5, 6, and 7 <figure_curvature>`
demonstrate the two dimensional case of how solvent molecules are
packed onto a surface. The first sphere is mapped adjacent to the
vertex using the vertex's normal. Two more spheres are then packed
adjacent to the surface and the starting sphere. The angle between
these two spheres is used to calculate the accessibility to solvent of
the initial sphere using the following formula:

.. math::

   100 * \frac{\theta - \pi}{\pi}

Where :math:`\theta` is in radians. For this simple case the angle is
also a measure of the surface curvature, hence the name. In three
dimensions steradians are required to accomplish the same functional
form:

.. math::

   100 * \frac{\theta - 2\pi}{2\pi}

Where :math:`\theta` is in steradians. Therefore, a vertex's
"curvature" falls into a range with the following bounds:

:-100.0:
    Solvent that is completely secluded within the surface 
:0.0:
    Flat portion of the surface 
:100.0:
    Solvent that is completely detached from the surface 

.. _figure_curvature:

.. list-table:: 

   * - .. image:: images/Concave.png

     - .. image:: images/Flat.png

     - .. image:: images/Convex.png

   * - **Figure 5**

     - **Figure 6**
     
     - **Figure 7**

   * - Concave

     - Flat
     
     - Convex

Distance is listed as specific data because it can be derived as the
distance between different portions of the surface. This can be useful
for measuring the thickness of a volume that is enclosed by a
surface. Distances can also be measured to other arbitrary objects as
well, such as molecules and other surfaces.

.. _surfaces_associative_data:

****************
Associative Data
****************

Associative data is not inherent from the first-class object
definition of a surface. Instead, they are properties mapped onto the
surface. Spicoli provides the following associative data arrays:

Atoms
    (``unsigned int``) Atom index for the vertex 
Color
    (4 ``floats`` or 4 ``unsigned chars``) Color of the vertex 
Potential
    (``float``) Electrostatic potential at the vertex 

To map chemical properties onto a surface it is useful to know which
atoms are responsible for portions of the surface. When a surface is
constructed from a molecule, a data array containing the corresponding
atom index for each vertex is created. An atom's index can be obtained
from the :oe:meth:`OEChem::OEAtomBase::GetIdx` method and is unique
over the molecule. Refer to the *OEChem* manual for more information
about atom indices.

To display chemical properties it is often useful to render them as
either discrete colors or a spectrum of colors. The color data array
allows the user to set a color for every vertex in the surface. When
the surface is then read into a visualizer, such as Vida, the
properties can easily be interpreted. Every vertex has the associated
values: red, green, blue, and alpha. Alpha is the transparency of the
vertex. If any value is retrieved as a ``float``, then that value will
range from 0 to 1 inclusive. If retrieved as an ``unsigned char``, the
value will range from 0 to 255 inclusive.

Electrostatic potentials can be calculated and displayed on a
surface. This can be done with current *OpenEye* tools such as *Zap*.

The potentials array is essentially an array of floats the user can
use to record analytical data for each vertex.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _spicoli_generation:

##################
Surface Generation
##################

Spicoli can generate surfaces from the following other types of objects:

* :ref:`Molecules <generation_molecules>`
* :ref:`Grids <generation_grids>`
* :ref:`Other Surfaces <generation_surfaces>`
* :ref:`Geometric Primitives <generation_geometric>`

.. _generation_molecules:

**********************************
Molecules: Accessible vs Molecular
**********************************

OESpicoli provides two functions for generating surfaces directly from
molecules: :oe:func:`OESpicoli::OEMakeAccessibleSurface` and
:oe:func:`OESpicoli::OEMakeMolecularSurface`. Both functions require
the definition of a solvent molecule's probe radius. The default
solvent is water with a probe radius of 1.4 |Angstroms| .

The accessible surface is created by representing each atom as a hard
sphere [Lee-1971]_. The radius of each sphere is the radius
of the atom plus the probe radius. Figures 1 and 2 demonstrate how the
spheres are packed together to form the surface. In the figures,
portions of the surface are colored based upon each atom's
contribution to the final accessible surface.

.. list-table::

   * - .. image:: images/AccessibleSpheres.png
          :width: 500

     - .. image:: images/AccessibleSurfaces.png
          :width: 500

   * - **Figure 1**

     - **Figure 2**

   * - Accessible Spheres

     - Accessible Surface

The molecular surface is composed of atom centered spheres plus
reentrants [Connolly-1983]_. Each sphere's radius is the atomic radii
of the atom it is associated with. The defining characteristic of the
molecular surface is the reentrant as shown in Figures 3 and 4. The
reentrant models the portion of the molecule inaccessible to solvent.
For this reason the volume enclosed by the molecular surface is
sometimes referred to as the "solvent-excluded" volume.

.. list-table::

   * - .. image:: images/MolecularSpheres.png
          :width: 500

     - .. image:: images/MolecularSurfaces.png
          :width: 500

   * - **Figure 3**
         
     - **Figure 4**

   * - Molecular Spheres
         
     - Molecular Surface

.. note:: 

   The atoms associated with every surface vertex can be obtained by
   using the :oe:meth:`OESpicoli::OESurface::GetAtoms`
   and :oe:meth:`OESpicoli::OESurface::GetAtomsElement` methods. For an
   accessible surface this is simple to define, it is the atom closest to
   the vertex. However, for the molecular surface it is not so clear
   because of the re-entrants. Typically, it is the closest atom to
   the vertex, but that is not guaranteed. If this guarantee is
   required you should call
   the :oe:func:`OESpicoli::OESurfaceToMoleculeDistance` function on the
   molecule and surface.

.. _generation_grids:

*********
Grids
*********

In Spicoli the construction of surfaces from a molecule proceeds
through a grid intermediate. The space between grid points determines
the resolution of the surface, i.e., how many triangles there are and
the size of each triangle. Grids usually consist of equidistant points
aligned along orthogonal axes, but this need not always be the case
(for instance, electron density grids from crystallography).

Scalar values are placed at every grid point. Surfaces are constructed
by tracing out a contour through the grid points. A contour is a
separator of points based on whether they are greater than or less
than a given value. The separator is a line in two dimensions and a
surface in three dimensions. This is similar to how topographic maps
use lines to convey elevation.

When dealing with surfaces the points on the grid with a value less
than the chosen contour value are inside the surface and vice versa.
:oe:func:`OESpicoli::OEMakeSurfaceFromGrid` will generate a surface
from a grid using a variation of the :term:`marching cubes` algorithm.

Figure 5 is an example of a two dimensional molecular Gaussian grid
for a simple molecule arbitrarily oriented in the grid. Figure 6 shows
a contour at 1.0 of that same molecular Gaussian grid.

.. list-table::

   * - .. image:: images/MolecularGaussianGrid.png
          :width: 500

     - .. image:: images/MolecularGaussianGridContour.png
          :width: 500

   * - **Figure 5**

     - **Figure 6**

   * - Molecular Gaussian Grid

     - Molecular Gaussian Grid Contour

.. note::

   Grids and surfaces are fairly interchangeable. A grid can be
   constructed from a surface using
   the :oe:func:`OESpicoli::OEMakeGridFromSurface` function. Then that
   grid can be used to recreate the original surface by using
   the :oe:func:`OESpicoli::OEMakeSurfaceFromGrid` function.

.. _generation_surfaces:

***************
Surface Subsets
***************

Surface subsetting is done through the use of :ref:`manipulation_cliques`. The
triangle, not the vertex, is the most physically relevant intrinsic
property of the surface. To maintain a constant surface area for the
sum of all partitions Spicoli will not duplicate triangles across
surface partitions. However, this does not restrict the duplication of
vertices across partitions.

Therefore, the sum of the surface area of every partition will equal
the surface area of the whole surface. The sum
of :oe:meth:`OESpicoli::OESurface::GetNumTriangles` over every
partition will equal the total number of triangles in the whole
surface. However, the sum
of :oe:meth:`OESpicoli::OESurface::GetNumVertices` over every partition
will not equal the total number of vertices in the whole surface.

.. seealso:: 

   * :oe:func:`OESpicoli::OESurfaceCropToClique`
   * :oe:func:`OESpicoli::OEMakeCliqueSurface`

.. _generation_geometric:

********************
Geometric Primitives
********************

Spicoli provides the following free functions to construct surfaces
from primitive geometric shapes:

:Boxes: :oe:func:`OESpicoli::OEMakeBoxSurface`
:Spheres: :oe:func:`OESpicoli::OEMakeSphericalSurface`
:Ellipsoids: :oe:func:`OESpicoli::OEMakeEllipsoidSurface`


.. _splitting:

#######################################
Atom Association and Surface Splitting
#######################################

Molecular and accessible surfaces are created with an atom associated to each
vertex.  These atom indices can be obtained using the 
:oe:meth:`OESpicoli::OESurface::GetAtoms` and 
:oe:meth:`OESpicoli::OESurface::GetAtomsElement` methods, but the default
assignments are not very accurate.  Using the 
:oe:func:`OESpicoli::OESurfaceToMoleculeDistance` function will ensure that each
vertex's atom assignment is to the atom whose van der Waals surface is closest 
to that vertex.  While the associations provide an accurate mapping of 
individual vertices to atoms, *triangles* on the surface may have vertices 
belonging to different atoms.  This can make make mapping of atom-based
properties onto the surface problematic.

Surface splitting, using the :oe:func:`OESpicoli::OESplitSurfaceByAtoms`
function, will divide a surface such that the boundaries between atoms are
distinct, with no triangles being shared by multiple atoms.  Surfaces are
split through a process of moving vertices and subdividing triangles until no
triangle edges cross the analytical boundaries between atoms.  A comparison of
the atom associations of unsplit and split surfaces is shown in
:ref:`Table: Atom Associations<figure_surface_splitting>`.

.. _figure_surface_splitting:

.. rubric:: Atom Associations

+---------------------------------------+---------------------------------------------------------------------------------------------+
| .. image:: images/benzene_raw.png     |  Molecular surface of benzene, colored by atom indices assigned during surface construction |
+---------------------------------------+---------------------------------------------------------------------------------------------+
| .. image:: images/benzene_assigned.png|  Same surface after atom indices are reassigned using OESurfaceToMoleculeDistance           |
+---------------------------------------+---------------------------------------------------------------------------------------------+
| .. image:: images/benzene_split.png   |  Same surface after splitting with OESplitSurfaceByAtoms                                    |
+---------------------------------------+---------------------------------------------------------------------------------------------+

Splitting a surface has some consequences that you should be aware of. A split
surface will have significantly more vertices and triangles than the surface it
was created from. In addition, it will contain numerous duplicate vertices,
having the same coordinates and normals but with different atom associations.
Finally, it will contain "zero-area" triangles, generated between duplicated
vertices to preserve the connectivity of vertices within the surface.



.. _manipulation:

####################
Surface Manipulation
####################

Spicoli manipulates surfaces through the following two primary
mechanisms:

* :ref:`Cliques <manipulation_cliques>`
* :ref:`Grids <manipulation_grids>`

.. _manipulation_cliques:

********
Cliques
********

A clique is an integral value associated with portions of the surface.
They can be arbitrarily assigned in order to create groupings of
vertices. Cliques in Spicoli are unsigned ints that can be associated
with every vertex of the surface. Spicoli treats the zero clique as a
special ``NULL`` clique. Therefore, the user should not use zero for
performing any clique operations on the surface.

Cliques in Spicoli are collections of vertices. However, an ambiguity
occurs when performing triangle-based operations on these cliques.
Spicoli will automatically resolve vertex cliques into triangle
cliques using the following rule: if two or more vertices in the
triangle have the same clique value, the triangle is assigned that
clique value; otherwise, if every vertex of the triangle has a
different clique value then the triangle is arbitrarily assigned the
lowest clique value of the three vertices.

.. seealso:: 

   * :oe:func:`OESpicoli::OESurfaceCropToClique`
   * :oe:func:`OESpicoli::OEMakeCliqueSurface`
   * :oe:func:`OESpicoli::OEMakeConnectedSurfaceCliques`
   * :oe:func:`OESpicoli::OESurfaceCliqueArea`
   * :oe:func:`OESpicoli::OESurfaceCliqueVolume`

.. _manipulation_grids:

*********
Grids
*********

Spicoli can construct grids from surfaces. Grid values are assigned
using the distance to the nearest surface vertex to the grid point.
This makes grid construction very expensive because every grid point
must be compared to every surface vertex.
The :oe:constns:`OESpicoli::OEVoxelizeMethod` namespace describes the
available methods.

.. seealso::

   * :oe:func:`OESpicoli::OEMakeGridFromSurface`
   * :oe:func:`OESpicoli::OEMakeSurfaceFromGrid`


.. _OESpicoliClasses:

###################
OESpicoli Classes
###################

.. oe:namespace:: OESpicoli

.. toctree::

   OESurface


.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESurface, Surface

.. _OESpicoli_OESurface:

.. oe:class:: OESurface

   .. oe:api::

      class OESurface : public OESystem::OEBase

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESurface()
            OESurface(const OESurface& rhs)
            OESurface(const OESurfaceImpl& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESurface() -> OESurface
            OESurface(rhs: OESurface) -> OESurface
            OESurface(rhs: OESurfaceImpl) -> OESurface

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESurface &operator=(const OESurface &rhs)
         OESurface &operator=(const OESurfaceImpl &rhs)

      Assignment operator for a surface. Will copy all data from rhs to the
      surface.

      Assignment operator.

   .. oe:method:: operator+=
      :language: c++

      .. oe:api::

         OESurface &operator+=(const OESurface &rhs)
         OESurface &operator+=(const OESurfaceImpl &rhs)

      In-place addition of one surface to another. The titles are
      concatenated together with an underscore. The vertex indices in
      the triangles array of rhs are increased by
      :oe:meth:`OESpicoli::OESurface::GetNumVertices`. All other data
      is copied from ``rhs`` as well. In the case where one of the
      surfaces does not have data (Potentials, Atoms, etc) and the
      other does, the data array for the surface that does not will be
      zeroed out.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Whether the surface contains any data (vertices).

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Delete and deallocate all data associated with this
      surface. This includes all :ref:`OEBase <OESystem_OEBase>` data as
      well.

   .. oe:method:: ClearVertexClique

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ClearVertexClique()

      .. oe:language:: python

         .. oe:api:: python

            ClearVertexClique() -> bool

      Sets every vertex clique value to zero. Afterwards,
      :oe:meth:`OESpicoli::OESurface::IsVertexCliqueSet` will return
      ``false``. This will prevent vertex clique values from being
      output by :oe:func:`OESpicoli::OEWriteSurface`.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

 
   .. oe:method:: GetAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAtoms(unsigned int* atoms) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms(atoms: int) -> bool

      Fills the memory pointed to by ``atoms`` with the atom index
      associated with every vertex of the surface. The array passed in
      should be large enough to hold ``GetNumVertices()`` unsigned ints. 

   .. oe:method:: GetAtomsElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetAtomsElement(unsigned int n) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomsElement(n: int) -> int

      Retrieves an element from the internal atoms array. The index
      ``n`` should be less than ``GetNumVertices()``.

   .. oe:method:: GetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetColor(float* color) const
            bool GetColor(unsigned char* color) const

      .. oe:language:: python

         .. oe:api:: python

            GetColor(color: OEFloatArray) -> bool
            GetColor(color: str) -> bool

      Fills the memory pointed to by ``color`` with the color associated
      with every vertex of the surface. The array passed in should be
      large enough to hold ``GetNumVertices() * 4`` floats or
      ``GetNumVertices() * 4`` unsigned chars, depending on which
      overload is used.

   .. oe:method:: GetColorElement

      .. oe:language:: c++ java

         .. oe:api:: 

            void GetColorElement(unsigned int n, float& r, float& g, float& b,
                                 float& a) const
            void GetColorElement(unsigned int n, unsigned char& r,
                                 unsigned char& g, unsigned char& b,
                                 unsigned char& a) const

      .. oe:language:: python

         .. oe:api:: python

            GetColorElement(n: int) -> (r: float, g: float, b: float, a: float)

      Retrieves an element from the internal color array. The index
      ``n`` should be less than ``GetNumVertices()``.

   .. oe:method:: GetCurvature

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCurvature(float* curvature) const

      .. oe:language:: python

         .. oe:api:: python

            GetCurvature(curvature: OEFloatArray) -> bool

      Fills the memory pointed to by ``curvature`` with the curvature
      associated with every vertex of the surface. The array passed in
      should be large enough to hold ``GetNumVertices()`` floats.

   .. oe:method:: GetCurvatureElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetCurvatureElement(unsigned int n) const

      .. oe:language:: python

         .. oe:api:: python

            GetCurvatureElement(n: int) -> float

      Retrieves an element from the internal curvature array. The
      index ``n`` should be less than ``GetNumVertices()``.

   .. oe:method:: GetDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

   .. oe:method:: GetDistance

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetDistance(float* distance) const

      .. oe:language:: python

         .. oe:api:: python

            GetDistance(distance: OEFloatArray) -> bool

      Fills the memory pointed to by ``distance`` with the distance each
      vertex is from another object. The array passed in should be
      large enough to hold ``GetNumVertices()`` floats.

   .. oe:method:: GetDistanceElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetDistanceElement(unsigned int n) const

      .. oe:language:: python

         .. oe:api:: python

            GetDistanceElement(n: int) -> float

      Retrieves an element from the internal distance array. The index
      ``n`` should be less than ``GetNumVertices()``.

   .. oe:method:: GetFaceNormals

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFaceNormals(float* faceNormals) const

      .. oe:language:: python

         .. oe:api:: python

            GetFaceNormals(faceNormals: OEFloatArray) -> bool

      Fills the memory pointed to by ``faceNormals`` with a normal
      vector associated with every triangle of the surface. The array
      passed in should be large enough to hold ``GetNumTriangles() *
      3`` floats.

   .. oe:method:: GetFaceNormal

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFaceNormal(unsigned int n, float* normal) const

      .. oe:language:: python

         .. oe:api:: python

            GetFaceNormal(n: int, normal: OEFloatArray) -> bool

      Retrieves a 3-component face normal vector for the specified triangle
      and stores it in the ``normal`` array.
      The index ``n`` must be less than ``GetNumTriangles()``. 
      Returns ``true`` upon success.

   .. oe:method:: GetFaceNormalsElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetFaceNormalsElement(unsigned int n) const

      .. oe:language:: python

         .. oe:api:: python

            GetFaceNormalsElement(n: int) -> float

      This method has been deprecated.  Use 
      :oe:meth:`OESpicoli::OESurface::GetFaceNormal` instead.

   .. oe:method:: GetNormals

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetNormals(float* normals) const

      .. oe:language:: python

         .. oe:api:: python

            GetNormals(normals: OEFloatArray) -> bool

      Fills the memory pointed to by ``normals`` with a normal vector
      associated with every vertex of the surface. The array passed in
      should be large enough to hold ``GetNumVertices() * 3``
      floats. A vertex normal is calculated by averaging the face
      normals of all the triangles in which the vertex resides.

   .. oe:method:: GetNormal

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetNormal(unsigned int n, float* normal) const

      .. oe:language:: python

         .. oe:api:: python

            GetNormal(n: int, normal: OEFloatArray) -> bool

      Retrieves an 3-component vertex normal for the specified vertex and
      stores it in the ``normal`` array.  The index ``n`` must be less 
      than ``GetNumVertices()``. This method returns ``true`` upon success.

   .. oe:method:: GetNormalsElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetNormalsElement(unsigned int n) const

      .. oe:language:: python

         .. oe:api:: python

            GetNormalsElement(n: int) -> float

      This method has been deprecated.  Use
      :oe:meth:`OESpicoli::OESurface::GetNormal` instead.

   .. oe:method:: GetNumTriangles

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumTriangles() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumTriangles() -> int

      Returns the number of triangles in the surface. 

   .. oe:method:: GetNumVertices

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumVertices() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumVertices() -> int

      Returns the number of vertices in the surface. 

   .. oe:method:: GetPotential

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPotential(float* potential) const

      .. oe:language:: python

         .. oe:api:: python

            GetPotential(potential: OEFloatArray) -> bool

      Fills the memory pointed to by ``potential`` with the potential
      associated with every vertex of the surface. The array passed in
      should be large enough to hold ``GetNumVertices()`` floats.

   .. oe:method:: GetPotentialElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetPotentialElement(unsigned int n) const

      .. oe:language:: python

         .. oe:api:: python

            GetPotentialElement(n: int) -> float

      Retrieves an element from the internal potentials array. The index ``n``
      should be less than ``GetNumVertices()``.

   .. oe:method:: GetPotentialName

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetPotentialName() const

      .. oe:language:: python

         .. oe:api:: python

            GetPotentialName() -> str

      Returns name of the potentials stored in the surface's potential
      array.

   .. oe:method:: GetProbeRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetProbeRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetProbeRadius() -> float

      Returns the probe radius used in the construction of the surface.

   .. oe:method:: GetResolution

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetResolution() const

      .. oe:language:: python

         .. oe:api:: python

            GetResolution() -> float

      Returns the grid spacing used in the surface construction.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Returns the title of the surface.

   .. oe:method:: GetTriangles

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetTriangles(unsigned int* triangles) const

      .. oe:language:: python

         .. oe:api:: python

            GetTriangles(triangles: int) -> bool

      Fills the memory pointed to by ``triangles`` with the vertex indices
      that compose every triangle in the surface. The vertex indices
      will obey the clockwise ordering rule described in the
      :ref:`surfaces_triangles` section. The array passed in should be
      large enough to hold ``GetNumTriangles() * 3`` unsigned ints.

   .. oe:method:: GetTriangle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetTriangle(unsigned int n, unsigned int* triangle) const

      .. oe:language:: python

         .. oe:api:: python

            GetTriangle(n: int, triangle: int) -> bool

      Retrieves the three vertex indices for the specified triangle and 
      stores them in the ``triangle`` array.
      The triangle index ``n`` must be less than ``GetNumTriangles()``.

   .. oe:method:: GetTrianglesElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetTrianglesElement(unsigned int n) const

      .. oe:language:: python

         .. oe:api:: python

            GetTrianglesElement(n: int) -> int

      This method has been deprecated.  Use
      :oe:meth:`OESpicoli::OESurface::GetTriangle` instead.

   .. oe:method:: GetVertex

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetVertex(unsigned int n, float* vertex) const

      .. oe:language:: python

         .. oe:api:: python

            GetVertex(n: int, vertex: OEFloatArray) -> bool

      Retrieves coordinates for the specified vertex and stores them in the
      ``vertex`` array. The vertex index ``n`` must be less than 
      ``GetNumVertices()``.

   .. oe:method:: GetVertexClique

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetVertexClique(unsigned int* vertexClique) const

      .. oe:language:: python

         .. oe:api:: python

            GetVertexClique(vertexClique: int) -> bool

      Fills the memory pointed to by ``vertexClique`` with the clique
      values associated with every vertex of the surface. The array
      passed in should be large enough to hold ``GetNumVertices()``
      unsigned ints.

   .. oe:method:: GetVertexCliqueElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetVertexCliqueElement(unsigned int n) const

      .. oe:language:: python

         .. oe:api:: python

            GetVertexCliqueElement(n: int) -> int

      Retrieves an element from the internal cliques array. The index
      ``n`` should be less than ``GetNumVertices()``.

   .. oe:method:: GetVertices

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetVertices(float* vertices) const

      .. oe:language:: python

         .. oe:api:: python

            GetVertices(vertices: OEFloatArray) -> bool

      Fills the memory pointed to by ``vertices`` with the vertex
      coordinates of the surface. Vertices are aligned every three
      places in the array as described in the :ref:`surfaces_vertices`
      section. The array passed in should be large enough to hold
      ``GetNumVertices() * 3`` floats.

   .. oe:method:: GetVerticesElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetVerticesElement(unsigned int n) const

      .. oe:language:: python

         .. oe:api:: python

            GetVerticesElement(n: int) -> float

      This method has been deprecated.  Use
      :oe:meth:`OESpicoli::OESurface::GetVertex` instead.

   .. oe:method:: IsAtomsSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsAtomsSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsAtomsSet() -> bool

      Determine whether the surface has atom indices associated with each
      vertex. Surfaces generated from
      :oe:func:`OESpicoli::OEMakeAccessibleSurface` and
      :oe:func:`OESpicoli::OEMakeAccessibleSurface`
      automatically set this data.

   .. oe:method:: IsColorSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsColorSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsColorSet() -> bool

      Determine whether the surface has color values associated with each
      vertex.

   .. oe:method:: IsCurvatureSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsCurvatureSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsCurvatureSet() -> bool

      Determine whether the surface has curvature value calculated for each
      vertex.

   .. oe:method:: IsDataType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDataType(const void* type) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(type: void) -> bool

   .. oe:method:: IsDistanceSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsDistanceSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsDistanceSet() -> bool

      Determine whether the surface has a distance value associated with
      each vertex.

   .. oe:method:: IsFaceNormalsSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsFaceNormalsSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsFaceNormalsSet() -> bool

      Determine whether the surface has face normals calculated for each
      triangle.

   .. oe:method:: IsNormalsSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsNormalsSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsNormalsSet() -> bool

      Determine whether the surface has vertex normals calculated for
      each vertex. Surfaces generated from
      :oe:func:`OESpicoli::OEMakeAccessibleSurface` and
      :oe:func:`OESpicoli::OEMakeAccessibleSurface` automatically set this
      data.

   .. oe:method:: IsPotentialSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsPotentialSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsPotentialSet() -> bool

      Determine whether the surface has a potential value associated with
      each vertex.

   .. oe:method:: IsVertexCliqueSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsVertexCliqueSet() const

      .. oe:language:: python

         .. oe:api:: python

            IsVertexCliqueSet() -> bool

      Determine whether the surface has a clique value associated with
      each vertex.

   .. oe:method:: SetAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAtoms(const unsigned int* atoms)

      .. oe:language:: python

         .. oe:api:: python

            SetAtoms(atoms: int) -> bool

      Sets the internal atoms array data to the values pointed to by
      ``atoms``. This should be a pointer to an array of unsigned ints
      of length ``GetNumVertices()``. Returns ``true`` upon success.

   .. oe:method:: SetAtomsElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAtomsElement(unsigned int n, unsigned int value)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomsElement(n: int, value: int) -> bool

      Sets an element in the internal atoms array. The index ``n`` should be
      less than ``GetNumVertices()``. Returns ``true`` upon success.

   .. oe:method:: SetColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColor(const float* color)
            bool SetColor(const unsigned char* color)

      .. oe:language:: python

         .. oe:api:: python

            SetColor(color: OEFloatArray) -> bool
            SetColor(color: str) -> bool

      Sets the internal color array data to the values pointed to by
      ``color``. This should be a pointer to an array of floats or
      unsigned chars of length ``GetNumVertices() * 4`` or
      ``GetNumVertices() * 4`` respectively. Returns ``true`` upon
      success.

   .. oe:method:: SetColorElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorElement(unsigned int n, float r, float g, float b,
                                 float a = 1.0f)
            bool SetColorElement(unsigned int n, unsigned char r,
                                 unsigned char g, unsigned char b,
                                 unsigned char a = 255)

      .. oe:language:: python

         .. oe:api:: python

            SetColorElement(n: int, r: float, g: float, b: float,
                            a: float = 1.0) -> bool
            SetColorElement(n: int, r: str, g: str, b: str, a: str = 255) -> bool

      Sets an element in the internal color array. The index ``n``
      should be less than ``GetNumVertices()``. The alpha value,
      ``a``, defaults to be opaque. Returns ``true`` upon success.

   .. oe:method:: SetCurvature

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCurvature(const float* curvature)

      .. oe:language:: python

         .. oe:api:: python

            SetCurvature(curvature: OEFloatArray) -> bool

      Sets the internal curvature array data to the values pointed to by
      ``curvature``. This should be a pointer to an array of floats of length
      ``GetNumVertices()``. Returns ``true`` upon success.

   .. oe:method:: SetCurvatureElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCurvatureElement(unsigned int n, float value)

      .. oe:language:: python

         .. oe:api:: python

            SetCurvatureElement(n: int, value: float) -> bool

      Sets an element in the internal curvature array. The index ``n`` should be
      less than ``GetNumVertices()``. Returns ``true`` upon success.

   .. oe:method:: SetDistance

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDistance(const float* distance)

      .. oe:language:: python

         .. oe:api:: python

            SetDistance(distance: OEFloatArray) -> bool

      Sets the internal distance array data to the values pointed to
      by ``distance``. This should be a pointer to an array of floats
      of length ``GetNumVertices()``. Returns ``true`` upon success.

   .. oe:method:: SetDistanceElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDistanceElement(unsigned int n, float value)

      .. oe:language:: python

         .. oe:api:: python

            SetDistanceElement(n: int, value: float) -> bool

      Sets an element in the internal distance array. The index ``n`` should be
      less than ``GetNumVertices``. Returns ``true`` upon success.

   .. oe:method:: SetFaceNormal

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFaceNormal(unsigned int n, const float* normal)

      .. oe:language:: python

         .. oe:api:: python

            SetFaceNormal(n: int, normal: OEFloatArray) -> bool

      Sets the face normal for the specified triangle index.  The triangle
      index ``n`` must be less than ``GetNumTriangles()``, and ``normal``
      must contain three elements. Returns ``true`` upon success.

   .. oe:method:: SetFaceNormals

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFaceNormals(const float* faceNormals)

      .. oe:language:: python

         .. oe:api:: python

            SetFaceNormals(faceNormals: OEFloatArray) -> bool

      Sets the internal face normals array data to the values pointed
      to by ``faceNormals``. This should be a pointer to an array of
      floats of length ``GetNumTriangles() * 3``. Face normals are
      associated with triangles by their location in the
      array. Returns ``true`` upon success.

   .. oe:method:: SetFaceNormalsElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFaceNormalsElement(unsigned int n, float value)

      .. oe:language:: python

         .. oe:api:: python

            SetFaceNormalsElement(n: int, value: float) -> bool

      This method has been deprecated.  Use
      :oe:meth:`OESpicoli::OESurface::SetFaceNormal` instead.

   .. oe:method:: SetNormal

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNormal(unsigned int n, const float* normal)

      .. oe:language:: python

         .. oe:api:: python

            SetNormal(n: int, normal: OEFloatArray) -> bool

      Sets the vertex normal for the specified vertex.  The vertex
      index ``n`` must be less than ``GetNumVertices()``, and
      ``normal`` must contain three elements. Returns ``true``
      upon success.

   .. oe:method:: SetNormals

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNormals(const float* normals)

      .. oe:language:: python

         .. oe:api:: python

            SetNormals(normals: OEFloatArray) -> bool

      Sets the internal vertex normals array data to the values
      pointed to by ``normals``. This should be a pointer to an array
      of floats of length ``GetNumVertices() * 3``. Vertex normals are
      associated with vertices by their location in the array. Returns
      ``true`` upon success.

   .. oe:method:: SetNormalsElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNormalsElement(unsigned int n, float value)

      .. oe:language:: python

         .. oe:api:: python

            SetNormalsElement(n: int, value: float) -> bool

      This method has been deprecated.  Use
      :oe:meth:`OESpicoli::OESurface::SetNormal` instead.

   .. oe:method:: SetNumTriangles

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNumTriangles(unsigned int n)

      .. oe:language:: python

         .. oe:api:: python

            SetNumTriangles(n: int) -> bool

      .. warning:: 

         Expert use only.

      Set the number of triangles in this surface. Setting this to a
      value lower than :oe:meth:`OESpicoli::OESurface::GetNumTriangles`
      effectively erases triangles from the surface. The memory for
      the ``OESurface`` is not freed immediately, but cached for
      reuse. The Clear method should be used if deallocation is
      desired. Deallocation is also handled automatically by the
      class destructor.

      If the user wants to add more triangles to the surface,
      SetNumTriangles should be called first to resize the internal
      triangles array. Note that the methods for accessing
      individual triangles should not be
      used after a call to SetNumTriangles. Any data reliant on the
      number of triangles should first be set using the array based
      methods. This includes 
      :oe:meth:`OESpicoli::OESurface::SetTriangles` and
      :oe:meth:`OESpicoli::OESurface::SetFaceNormals`.

   .. oe:method:: SetNumVertices

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNumVertices(unsigned int n)

      .. oe:language:: python

         .. oe:api:: python

            SetNumVertices(n: int) -> bool

      .. warning::

          Expert use only.

      Set the number of vertices in this surface. Setting this to a
      value lower than ``GetNumVertices`` effectively erases vertices
      from the surface. The memory for the ``OESurface`` is not freed
      immediately, but cached for reuse. The
      :oe:meth:`OESpicoli::OESurface::Clear` method should be used if
      deallocation is desired. Deallocation is also handled
      automatically by the class destructor.

      If the user wants to add more vertices to the surface,
      :oe:meth:`OESpicoli::OESurface::SetNumVertices` should be called first
      to resize the internal vertices array. Note that the methods for 
      accessing individual vertices should not be used after a call to 
      SetNumVertices. Any data
      reliant on the number of vertices should first be set using the
      array based methods. These include the following:

      * :oe:meth:`OESpicoli::OESurface::SetVertices`
      * :oe:meth:`OESpicoli::OESurface::SetNormals`
      * :oe:meth:`OESpicoli::OESurface::SetCurvature`
      * :oe:meth:`OESpicoli::OESurface::SetDistance`
      * :oe:meth:`OESpicoli::OESurface::SetAtoms`
      * :oe:meth:`OESpicoli::OESurface::SetColor`
      * :oe:meth:`OESpicoli::OESurface::SetPotential`
      * :oe:meth:`OESpicoli::OESurface::SetVertexClique`

   .. oe:method:: SetPotential

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPotential(const float* potential)

      .. oe:language:: python

         .. oe:api:: python

            SetPotential(potential: OEFloatArray) -> bool

      Sets the internal potential array data to the values pointed to by
      ``potential``. This should be a pointer to an array of floats of length
      ``GetNumVertices() * sizeof(float)``. Returns true upon success.

   .. oe:method:: SetPotentialElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPotentialElement(unsigned int n, float value)

      .. oe:language:: python

         .. oe:api:: python

            SetPotentialElement(n: int, value: float) -> bool

      Sets an element in the internal potential array. The index ``n`` should be
      less than ``GetNumVertices()``. Returns true upon success.

   .. oe:method:: SetPotentialName

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPotentialName(const char* name)

      .. oe:language:: python

         .. oe:api:: python

            SetPotentialName(name: str) -> None

      Set the name of the potentials that are set on the surface. 

   .. oe:method:: SetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTitle(const char* title)
            bool SetTitle(const std::string& title)

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(title: str) -> bool

      Set the title of the surface.
  
   .. oe:method:: SetTriangle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTriangle(unsigned int n, const unsigned int* triangle)

      .. oe:language:: python

         .. oe:api:: python

            SetTriangle(n: int, triangle: int) -> bool

      Sets the vertex indices for the specified triangle. The triangle index 
      ``n`` must be less than ``GetNumTriangles()``, and ``triangle`` must
      contain three elements. Returns ``true`` upon success.

   .. oe:method:: SetTriangles

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTriangles(const unsigned int* triangles)

      .. oe:language:: python

         .. oe:api:: python

            SetTriangles(triangles: int) -> bool

      Sets the internal triangles array data to the values pointed to
      by ``triangles``. This should be a pointer to an array of unsigned
      ints of length ``GetNumTriangles() * 3``. Returns ``true`` upon
      success.

   .. oe:method:: SetTrianglesElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTrianglesElement(unsigned int n, unsigned int value)

      .. oe:language:: python

         .. oe:api:: python

            SetTrianglesElement(n: int, value: int) -> bool

      This method is deprecated.  Use
      :oe:meth:`OESpicoli::OESurface::SetTriangle` instead.

   .. oe:method:: SetVertex

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetVertex(unsigned int n, const float* vertex)

      .. oe:language:: python

         .. oe:api:: python

            SetVertex(n: int, vertex: OEFloatArray) -> bool

      Sets the coordinates for the specified vertex.  The vertex index 
      ``n`` must be less than ``GetNumVertices()``, and ``vertex`` must 
      contain three elements. Returns ``true`` upon success.

   .. oe:method:: SetVertexClique

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetVertexClique(const unsigned int* vertexClique)

      .. oe:language:: python

         .. oe:api:: python

            SetVertexClique(vertexClique: int) -> bool

      Sets the internal vertex clique array data to the values pointed
      to by ``vertexClique``. This should be a pointer to an array of
      unsigned ints of length ``GetNumVertices()``. Returns ``true``
      upon success.

   .. oe:method:: SetVertexCliqueElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetVertexCliqueElement(unsigned int n, unsigned int value)

      .. oe:language:: python

         .. oe:api:: python

            SetVertexCliqueElement(n: int, value: int) -> bool

      Sets an element in the internal vertex clique array. The index ``n`` should be
      less than ``GetNumVertices()``. Returns ``true`` upon success.

   .. oe:method:: SetVertices

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetVertices(const float* vertices)

      .. oe:language:: python

         .. oe:api:: python

            SetVertices(vertices: OEFloatArray) -> bool

      Sets the internal vertices array data to the values pointed to
      by ``vertices``. This should be a pointer to an array of floats of
      length ``GetNumVertices() * 3``. Returns ``true`` upon success.

   .. oe:method:: SetVerticesElement

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetVerticesElement(unsigned int n, float value)

      .. oe:language:: python

         .. oe:api:: python

            SetVerticesElement(n: int, value: float) -> bool

      This method is deprecated.  Use
      :oe:meth:`OESpicoli::OESurface::SetVertex` instead.



.. oe:namespace:: OESpicoli

.. oe:constnamespace:: OEEdgeReductionType

   This namespace contains constants used by the 
   :oe:func:`OESpicoli::OEReduceSurface` function. 

   .. oe:constant:: MinimumDistance
   
      Specifies a surface edge reduction algorithm which decreases the
      number of triangles and vertices in a surface by iteratively removing
      triangles with the shortest edges.


.. oe:namespace:: OESpicoli

.. oe:constnamespace:: OEPolygonizeMethod

   The ``OEPolygonizeMethod`` namespace is used to specify to the
   :oe:func:`OESpicoli::OEMakeMolecularSurface` and 
   :oe:func:`OESpicoli::OEMakeAccessibleSurface` functions the method to be
   used for polygonizing the surface.

   .. seealso:: 

      * The :oe:func:`OESpicoli::OEMakeMolecularSurface` and 
        :oe:func:`OESpicoli::OEMakeAccessibleSurface` functions for how to
        pass this constant into the functions. 

   .. oe:constant:: Grasp
   
      This polygonization method uses a :term:`marching cubes` type of 
      algorithm to generate surface triangles.

   .. oe:constant:: Compact
   
      This polygonization method uses a variation on the :term:`marching cubes`
      method in which grid vertex warping is used to generate a more "compact"
      surface.  This method results
      in a surface which has approximately 30% fewer triangles and vertices
      than those generated using the 
      :oe:const:`OESpicoli::OEPolygonizeMethod::Grasp` method, with no
      discernible loss of quality.

   .. oe:constant:: Default
   
      The default polygonization method is
      :oe:const:`OESpicoli::OEPolygonizeMethod::Grasp`.


.. oe:namespace:: OESpicoli

.. oe:constnamespace:: OERibbonType

   The :oe:constns:`OESpicoli::OERibbonType` namespace is used to tell the
   :oe:func:`OESpicoli::OEMakeProteinRibbonSurface` function what style of
   ribbon to create.

   .. seealso:: 

      * :oe:func:`OESpicoli::OEMakeProteinRibbonSurface`

   .. oe:constant:: CAlpha
   
      The ribbon is created to follow the protein backbone alpha carbons,
      and its helix and sheet regions will have elliptical cross-sections.

   .. oe:constant:: Pretty
   
      The ribbon is created to follow the protein backbone peptide bonds, and 
      its helix and sheet regions will have rectangular cross-sections. Ribbons
      created with this type tend to have a smoother, less wavy appearance.

   The default ribbon type is :oe:const:`OESpicoli::OERibbonType::CAlpha`.


.. _OESpicoliConstants:

###################
OESpicoli Constants
###################

.. oe:namespace:: OESpicoli

.. toctree::

   OEEdgeReductionType
   OEPolygonizeMethod
   OESurfaceFileType
   OEVoxelizeMethod
   OERibbonType


.. oe:namespace:: OESpicoli

.. oe:constnamespace:: OESurfaceFileType

   This namespace contains constants for passing to the
   :oe:func:`OESpicoli::OEWriteSurface` function. 

   .. seealso::

      * :ref:`storage`

   .. oe:constant:: UNDEFINED
   
      Used to indicate errors. 

   .. oe:constant:: Grasp
   
      The legacy :term:`GRASP` file format. Will not store all data
      present on the :oe:meth:`OESpicoli::OESurface` object. 

   .. oe:constant:: OESurface
   
      Binary Surface format developed by OpenEye. It will store all
      :ref:`OESurface <OESpicoli_OESurface>` data.


.. oe:namespace:: OESpicoli

.. oe:constnamespace:: OEVoxelizeMethod

   The ``OEVoxelizeMethod`` namespace is used to instruct the
   :oe:func:`OESpicoli::OEMakeGridFromSurface` function how to voxelize
   the surface onto the grid. A voxel is the three dimensional equivalent
   of a pixel. 

   .. seealso:: 

      * The :oe:func:`OESpicoli::OEMakeGridFromSurface` function for how to
        pass this constant into the function. 

   .. oe:constant:: Distance
   
      Each grid point is filled with the minimum distance squared from
      the surface. The distance is negative if the grid point is
      inside the surface. 

      .. note:: 

         The distance is squared to avoid calling the costly square
         root function.

   .. oe:constant:: Gaussian
   
      Same as distance, but the value placed in the grid is plotted as
      a Gaussian function. This means each gridpoint is set to
      :math:`e^{-0.33*d^2}`, where :math:`d` is the minimum distance
      to the surface. Note, where :math:`d` can still be negative
      inside the surface. Therefore, the grid values have the
      following correlation to the volume enclosed by the surface:

      Inside the Surface 
         Values are greater than 1.0

      At the Surface
         Values are 1.0

      Outside the Surface 
         Values are less than 1.0 and greater than 0.0

   .. oe:constant:: Blank
   
      Same as distance, but grid points inside the surface are set to 1.

   .. oe:constant:: Blur
   
      Discern the shape of the volume enclosed by the surface. This is
      done by mapping a Gaussian for every grid point inside the
      volume. This smears out the surface boundary a bit and allowing
      a smooth drop off from the surface.

   .. oe:constant:: Default
   
      The default voxelization method is
      :oe:const:`OESpicoli::OEVoxelizeMethod::Distance`.


.. # split from OESpicoliFunctions.rst:10

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEAddSurfaces

.. oe:function:: OEAddSurfaces

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEAddSurfaces(OESurface& surf1, const OESurface& surf2)

   .. oe:language:: python

      .. oe:api:: python

         OEAddSurfaces(surf1: OESurface, surf2: OESurface) -> bool

   Adds surf2 to surf1 using
   :oe:meth:`OESpicoli::OESurface::operator+=`. Always returns true.



.. # split from OESpicoliFunctions.rst:20

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OECalculateFaceNormals

.. oe:function:: OECalculateFaceNormals

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECalculateFaceNormals(OESurface& surf)

   .. oe:language:: python

      .. oe:api:: python

         OECalculateFaceNormals(surf: OESurface) -> bool

   Will calculate a normal vector for every triangle of the surface
   and store them on the surf. To retrieve the vectors after
   calculation, use the :oe:meth:`OESpicoli::OESurface::GetFaceNormals` 
   or :oe:meth:`OESpicoli::OESurface::GetFaceNormal`
   methods. 

   .. seealso::

      * :ref:`surfaces_normal_vectors`



.. # split from OESpicoliFunctions.rst:36

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OECalculateNormals

.. oe:function:: OECalculateNormals

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECalculateNormals(OESurface& surf)

   .. oe:language:: python

      .. oe:api:: python

         OECalculateNormals(surf: OESurface) -> bool

   Will calculate a normal vector for every vertex of the surface and
   store them on the surf. To retrieve the vectors after calculation,
   use the :oe:meth:`OESpicoli::OESurface::GetNormals` or
   :oe:meth:`OESpicoli::OESurface::GetNormal` methods. 

   .. seealso::

      * :ref:`surfaces_normal_vectors`



.. # split from OESpicoliFunctions.rst:51

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OECalculateSurfaceCurvature

.. oe:function:: OECalculateSurfaceCurvature

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECalculateSurfaceCurvature(OESurface& surf,
                                          const OEChem::OEMolBase& mol,
                                          float probeRadius = 1.4f)

   .. oe:language:: python

      .. oe:api:: python

         OECalculateSurfaceCurvature(surf: OESurface,
                                     mol: Union[OEGraphMol,OEMol,OEQMol],
                                     probeRadius: float = 1.4) -> bool

   Will calculate the surface curvature at every vertex according to
   the definition given in the :ref:`surfaces_specific_data`
   section. The data can then be retrieved using the
   :oe:meth:`OESpicoli::OESurface::GetCurvature` or
   :oe:meth:`OESpicoli::OESurface::GetCurvatureElement` methods.

   The molecule passed in as ``mol`` is used to construct a grid
   marking which regions of space are inaccessible to solvent
   molecules. This must be the same molecule that was used to construct
   the surface. The molecule must have valid 3D coordinates assigned.



.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OECalculateSurfacePotentials

..  _OESpicoli_OECalculateSurfacePotentials:

.. oe:function:: OECalculateSurfacePotentials

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECalculateSurfacePotentials(OESurface& surface,
                                           const OEChem::OEMolBase& target,
                                           const bool grasp = false)

   .. oe:language:: python

      .. oe:api:: python

         OECalculateSurfacePotentials(surface: OESurface,
                                      target: Union[OEGraphMol,OEMol,OEQMol],
                                      grasp: bool = False) -> bool

   Will calculate atomic potentials and assign those potentials to surface
   vertices on the supplied surface. The optional parameter `grasp` set to true
   will calculate the potentials based on the GRASP method, which is a coarser perspective
   of the potential using formal charges. 

   .. seealso::
      
      * :ref:`section-atom-potentials`
      * :ref:`surfaces_associative_data`
      * :ref:`OEColorSurfaceByPotential <OESpicoli_OEColorSurfaceByPotential>`


.. # split from OESpicoliFunctions.rst:69

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OECalculateTriangleAreas

.. oe:function:: OECalculateTriangleAreas

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECalculateTriangleAreas(const OESurface& surf, float* areas)

   .. oe:language:: python

      .. oe:api:: python

         OECalculateTriangleAreas(surf: OESurface, areas: OEFloatArray) -> bool

   Will calculate the area of every triangle of ``surf`` and store the
   result in the array ``areas`` of that should be large enough to
   hold ``GetNumTriangles()`` floats. The array is indexed by the
   triangle indices.

   :oe:src:`Listing 1<SNIPPET-AtomAreas-CalculateTriangleAreas>`
   demonstrates how to calculate the surface area contribution from
   each atom. It is assumed ``surf`` is an
   :ref:`OESurface <OESpicoli_OESurface>` created from the molecule ``mol``.

   .. oe:source:: CalculateTriangleAreas.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-AtomAreas
      :caption: Calculates the surface area contribution from each atom
      :refnum: 1

   .. oe:source:: CalculateTriangleAreas.py
      :language: python
      :frag:     SNIPPET-AtomAreas
      :caption: Calculates the surface area contribution from each atom
      :refnum: 1

..  oe:language:: python

    :ref:`Full listing. <listing-CalculateTriangleAreas.py>`

   .. oe:source:: CalculateTriangleAreas.java
      :language: java
      :noindent:
      :frag:     SNIPPET-AtomAreas
      :caption: Calculates the surface area contribution from each atom
      :refnum: 1

   .. oe:source:: CalculateTriangleAreas.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-AtomAreas
      :caption: Calculates the surface area contribution from each atom
      :refnum: 1



.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEColorSurfaceByPotential

..  _OESpicoli_OEColorSurfaceByPotential:

.. oe:function:: OEColorSurfaceByPotential

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEColorSurfaceByPotential(OESurface& surf,
                                        OESystem::OEColorGradientBase& grad,
                                        const unsigned alpha = 255)

   .. oe:language:: python

      .. oe:api:: python

         OEColorSurfaceByPotential(surf: OESurface, grad: OEColorGradientBase,
                                   alpha: int = 255) -> None

   Method to color a surface using a defined gradient based on the stored potentials on the 
   surface vertices.

   .. seealso::

      * :ref:`surfaces_associative_data`
      * :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>`


.. # split from OESpicoliFunctions.rst:113

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEGetCenterAndExtents

.. oe:function:: OEGetCenterAndExtents

   .. oe:api::

      void OEGetCenterAndExtents(const OESurface& surf, float* center,
                                 float* extents)

   Iterates through all the vertices in ``surf`` to find the center
   and extents of the surface in Cartesian coordinates. The center
   will be placed in the memory pointed to by ``center`` that should
   be large enough to hold 3 floats. The extents will be placed in the
   memory pointed to by ``extents`` that should be large enough to
   hold 3 floats. The extents are the difference between the maximum
   of the surface along any dimension and the minimum along that same
   dimension.

   .. seealso::

      * :oe:func:`OESystem::OEMakeGridFromCenterAndExtents`



.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEGetSurface

.. oe:function:: OEGetSurface

   .. oe:language:: python

      .. oe:api:: python

         OEGetSurface(obj, tag) -> OESurface

   .. oe:language:: java csharp

      .. oe:api:: java csharp

         OESurface OEGetSurface(OEBase obj, String tag)

   .. oe:language:: python java csharp

      Retrieves an :ref:`OESurface <OESpicoli_OESurface>` that has been stored
      as generic data on an OEBase object, using the specified tag.

      .. seealso::

         * :oe:func:`OESpicoli::OESetSurface` function

   .. oe:language:: c++

      This function is provided in CSharp, Java and Python wrappers and
      is not needed in C++.  Use the templated
      :oe:meth:`OESystem::OEBaseDataT::GetData` method instead.


.. # split from OESpicoliFunctions.rst:155

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEGetSurfaceFileType

.. oe:function:: OEGetSurfaceFileType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetSurfaceFileType(const char* ext)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSurfaceFileType(ext: str) -> int

   Returns a constant from the :oe:constns:`OESpicoli::OESurfaceFileType` 
   namespace for the file extension ext.



.. # split from OESpicoliFunctions.rst:164

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEGetSurfaceFormatExtension

.. oe:function:: OEGetSurfaceFormatExtension

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetSurfaceFormatExtension(unsigned int tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSurfaceFormatExtension(tag: int) -> str

   Returns a comma-separated list of possible file extensions
   corresponding to the specified parameter. The parameter, ``tag``,
   should be drawn from the :oe:constns:`OESpicoli::OESurfaceFileType`
   namespace.



.. # split from OESpicoliFunctions.rst:175

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEGetSurfaceFormatString

.. oe:function:: OEGetSurfaceFormatString

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetSurfaceFormatString(unsigned int tag)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSurfaceFormatString(tag: int) -> str

   Returns the name of the file format associated with the symbolic
   constant ``tag`` from the :oe:constns:`OESpicoli::OESurfaceFileType`
   namespace.



.. # split from OESpicoliFunctions.rst:185

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEInitSurfaceHandlers

.. oe:function:: OEInitSurfaceHandlers

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OEInitSurfaceHandlers(OEChem::oemolstreambase& fs)
         bool OEInitSurfaceHandlers(OESystem::OEBinaryIOHandlerBase& b)

   .. oe:language:: python

      .. oe:api:: python

         OEInitSurfaceHandlers(fs: oemolstreambase) -> None
         OEInitSurfaceHandlers(b: OEBinaryIOHandlerBase) -> bool

   Needs to be called in order for the OEBinary writer to be able to
   write surfaces as generic data tagged to a molecule or any OEBase
   object.

   .. warning::

      Deprecated as of Spicoli 1.0.2. No longer needs to be called. 

   .. seealso:: 

      * :ref:`storage_molecules`



.. # split from OESpicoliFunctions.rst:204

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEInvertSurface

.. oe:function:: OEInvertSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEInvertSurface(OESurface& surf)

   .. oe:language:: python

      .. oe:api:: python

         OEInvertSurface(surf: OESurface) -> bool

   Reverses all the triangle orderings and normal vectors in the
   surface. This essentially turns the surface inside-out because all
   the normals facing out are turned in and vice versa.

   .. note::

      Water pockets inside of protein structures have their normals
      facing into the protein. This can be used to make the
      disconnected surface a surface enclosing the occluded water.



.. # split from OESpicoliFunctions.rst:220

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEIsReadableSurface

.. oe:function:: OEIsReadableSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsReadableSurface(unsigned int type)
         bool OEIsReadableSurface(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEIsReadableSurface(type: int) -> bool
         OEIsReadableSurface(filename: str) -> bool

   Returns ``true`` if the supplied file format is readable by
   Spicoli. The ``filename`` can be a file name or a file extension. The
   ``unsigned int`` parameter value should be drawn from the
   :oe:constns:`OESpicoli::OESurfaceFileType` namespace.



.. # split from OESpicoliFunctions.rst:232

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEIsWriteableSurface

.. oe:function:: OEIsWriteableSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsWriteableSurface(unsigned int type)
         bool OEIsWriteableSurface(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEIsWriteableSurface(type: int) -> bool
         OEIsWriteableSurface(filename: str) -> bool

   Returns ``true`` if the supplied file format is writable by
   Spicoli. The ``filename`` can be a file name or a file
   extension. The ``unsigned int`` parameter value should be drawn
   from the :oe:constns:`OESpicoli::OESurfaceFileType` namespace.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeAccessibleSurface

.. oe:function:: OEMakeAccessibleSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeAccessibleSurface(OESurface& surf,
                                      const OEChem::OEMolBase& mol,
                                      float resolution = 0.5f,
                                      float probeRadius = 1.4f,
                                      unsigned int polygonizeMethod = OEPolygonizeMethod::Default)
         bool OEMakeAccessibleSurface(OESurface& surf, const float* coords,
                                      const float* radii, int natoms,
                                      float resolution = 0.5f,
                                      float probeRadius = 1.4f,
                                      unsigned int polygonizeMethod = OEPolygonizeMethod::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeAccessibleSurface(surf: OESurface,
                                 mol: Union[OEGraphMol,OEMol,OEQMol],
                                 resolution: float = 0.5,
                                 probeRadius: float = 1.4,
                                 polygonizeMethod: int) -> bool
         OEMakeAccessibleSurface(surf: OESurface, coords: OEFloatArray,
                                 radii: OEFloatArray, natoms: int,
                                 resolution: float = 0.5,
                                 probeRadius: float = 1.4,
                                 polygonizeMethod: int) -> bool

   Fill the surface surf with the accessible surface for the molecule
   mol. See the :ref:`generation_molecules` section for a full
   description of the accessible surface. The molecule must have valid
   3D coordinates assigned. The atomic radius of each atom in the
   molecule should already be set before calling this function. The
   suggested radii can be set with
   :oe:func:`OEChem::OEAssignBondiVdWRadii`.

   The resolution is the grid spacing to use during surface
   construction. This is typically scaled with the size of the
   molecule. For most molecules, 0.5 is good.

   The default probeRadius is 1.4 |A|, the radius of water approximated as
   a sphere.

   The ``polygonizeMethod`` argument specifies the method to be used when generating
   the triangles for the surface.  Allowed values are from the 
   :oe:constns:`OESpicoli::OEPolygonizeMethod` namespace.

   The overloaded version of the function takes coordinate and radii
   arrays, ``coords`` and ``radii`` respectively, of length ``natoms``
   to create the accessible surface.

   This function will set the vertex normals and atoms arrays on the
   surface.
   
   .. seealso::

      * :ref:`generation_molecules`
      * The :oe:constns:`OESpicoli::OEPolygonizeMethod` namespace



.. # split from OESpicoliFunctions.rst:287

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeBitGridFromSurface

.. oe:function:: OEMakeBitGridFromSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeBitGridFromSurface(OESystem::OEScalarGrid& grid,
                                       const OESurface& surf)
         bool OEMakeBitGridFromSurface(OESystem::OEScalarGrid& grid,
                                       const OESurface& surf, float spacing,
                                       float buffer)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeBitGridFromSurface(grid: OEScalarGrid, surf: OESurface) -> bool
         OEMakeBitGridFromSurface(grid: OEScalarGrid, surf: OESurface,
                                  spacing: float, buffer: float) -> bool

   Fill ``grid`` with either ``0.0`` or ``1.0`` marking whether that
   grid points lies inside or outside the volume enclosed by the
   surface. ``0.0`` indicates the point is outside the
   surface. ``1.0`` indicates the point is inside the surface.   



.. # split from OESpicoliFunctions.rst:301

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeBoxSurface

.. oe:function:: OEMakeBoxSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeBoxSurface(OESurface& surf, const float* center,
                               const float* extents)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeBoxSurface(surf: OESurface, center: OEFloatArray,
                          extents: OEFloatArray) -> bool

   Creates a box in surf located at ``center`` and extending
   ``extents`` in each dimension. Each of the six faces of the box
   will be composed of two triangles.



.. # split from OESpicoliFunctions.rst:312

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeCavitySurfaces

.. oe:function:: OEMakeCavitySurfaces

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeCavitySurfaces(const OEChem::OEMolBase& mol,
                                   OESurface& surf, float resolution = 0.5f,
                                   float probeRadius = 1.4f)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeCavitySurfaces(mol: Union[OEGraphMol,OEMol,OEQMol],
                              surf: OESurface, resolution: float = 0.5,
                              probeRadius: float = 1.4) -> bool

   Create a surface, ``surf``, from the macromolecule, ``mol``,
   representing where solvent can be occluded inside the
   molecule. The molecule must have valid 3D coordinates assigned. Therefore, this will not give cavities contiguous with
   the outside of the molecule. The ``resolution`` is the grid spacing
   to use during surface construction.  The ``probeRadius`` is the size of the
   solvent probe to use, in Angstroms.



.. # split from OESpicoliFunctions.rst:327

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeCliqueSurface

.. oe:function:: OEMakeCliqueSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeCliqueSurface(OESurface& newsurf, const OESurface& surf,
                                  unsigned int clique)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeCliqueSurface(newsurf: OESurface, surf: OESurface, clique: int) -> bool

   Creates a new surface in ``newsurf`` from the triangles in ``surf``
   marked with the vertex clique value clique. Zero is not a valid
   clique. See the :ref:`manipulation_cliques` section on how vertex
   cliques are assigned to triangles. See the
   :ref:`generation_surfaces` section for an explanation of how
   Spicoli handles subset boundaries. Returns ``true`` if successful.



.. # split from OESpicoliFunctions.rst:341

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeComplexCavities

.. oe:function:: OEMakeComplexCavities

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeComplexCavities(const OEChem::OEMolBase& mol1,
                                    const OEChem::OEMolBase& mol2,
                                    OESurface& surf, float resolution = 0.5f,
                                    float probeRadius = 1.4f)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeComplexCavities(ligand: Union[OEGraphMol,OEMol,OEQMol],
                               protein: Union[OEGraphMol,OEMol,OEQMol],
                               surf: OESurface, resolution: float = 0.5,
                               probeRad: float = 1.4) -> bool

   Constructs a surface representing the volume between a
   ligand (``mol1``) and a macromolecule (``mol2``) that can accommodate a
   spherical probe with radius of ``probeRadius``. Both molecules must
   have valid 3D coordinates assigned.  The resolution of the grid
   used to construct the surface is specified by ``resolution``.  The surface 
   is restricted to a 6 Angstrom envelope around ``mol1``.



.. # split from OESpicoliFunctions.rst:358

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeConnectedSurfaceCliques

.. oe:function:: OEMakeConnectedSurfaceCliques

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEMakeConnectedSurfaceCliques(OESurface& surf)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeConnectedSurfaceCliques(surf: OESurface) -> int

..  _make-connected-surface-cliques-example:

   Assigns a different clique value, starting at 1, to each connected
   component of the surface. The number of connected components is
   returned. :oe:src:`Listing
   2<SNIPPET-MaxClique-MakeConnectedSurfaceCliques>` demonstrates
   cropping a surface to its largest component.
  
   .. oe:source:: MakeConnectedSurfaceCliques.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-MaxClique
      :caption: Extracting the largest portion of the surface
      :refnum: 2

   .. oe:source:: MakeConnectedSurfaceCliques.py
      :language: python
      :frag:     SNIPPET-MaxClique
      :caption: Extracting the largest portion of the surface
      :refnum: 2

   ..  oe:language:: python

       :ref:`Full listing. <listing-MakeConnectedSurfaceCliques.py>`

   .. oe:source:: MakeConnectedSurfaceCliques.java
      :language: java
      :noindent:
      :frag:     SNIPPET-MaxClique
      :caption: Extracting the largest portion of the surface
      :refnum: 2   

   .. oe:source:: MakeConnectedSurfaceCliques.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-MaxClique
      :caption: Extracting the largest portion of the surface
      :refnum: 2   



.. # split from OESpicoliFunctions.rst:398

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeEllipsoidSurface

.. oe:function:: OEMakeEllipsoidSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeEllipsoidSurface(OESurface& surf, float* center, float a,
                                     float b, float c, float* dir1,
                                     float* dir2, float* dir3, int level = 4)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeEllipsoidSurface(surf: OESurface, center: OEFloatArray,
                                a: float, b: float, c: float,
                                dir1: OEFloatArray, dir2: OEFloatArray,
                                dir3: OEFloatArray, level: int = 4) -> bool



.. # split from OESpicoliFunctions.rst:407

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeGridFromSurface

.. oe:function:: OEMakeGridFromSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeGridFromSurface(OESystem::OEScalarGrid& grid,
                                    const OESurface& surf,
                                    unsigned int method = OEVoxelizeMethod::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeGridFromSurface(grid: OEScalarGrid, surf: OESurface, method: int) -> bool

   Fill ``grid`` with a voxelized representation of the surface by the
   method passed as the ``method`` parameter. The constants for
   ``method`` parameter are defined by the
   :oe:constns:`OESpicoli::OEVoxelizeMethod` namespace.

   .. seealso::

      * The :oe:constns:`OESpicoli::OEVoxelizeMethod` namespace.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeMolecularSurface

.. oe:function:: OEMakeMolecularSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeMolecularSurface(OESurface& surf,
                                     const OEChem::OEMolBase& mol,
                                     float resolution = 0.5f,
                                     float probeRadius = 1.4f,
                                     unsigned int polygonizeMethod = OEPolygonizeMethod::Default)
         bool OEMakeMolecularSurface(OESurface& surf, const float* coords,
                                     const float* radii, int natoms,
                                     float resolution = 0.5f,
                                     float probeRadius = 1.4f,
                                     unsigned int polygonizeMethod = OEPolygonizeMethod::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeMolecularSurface(surf: OESurface,
                                mol: Union[OEGraphMol,OEMol,OEQMol],
                                resolution: float = 0.5,
                                probeRadius: float = 1.4, polygonizeMethod: int) -> bool
         OEMakeMolecularSurface(surf: OESurface, coords: OEFloatArray,
                                radii: OEFloatArray, natoms: int,
                                resolution: float = 0.5,
                                probeRadius: float = 1.4, polygonizeMethod: int) -> bool

   Fill the surface surf with the molecular surface for the molecule
   mol. See :ref:`generation_molecules` section for a full description
   of the molecular surface. The molecule must have valid 3D coordinates
   assigned. The atomic radius of each atom in the molecule should
   already be set before calling this function. The suggested radii can
   be set with :oe:func:`OEChem::OEAssignBondiVdWRadii`.

   The ``resolution`` is the grid spacing to use during surface
   construction. This is typically scaled with the size of the
   molecule. For most molecules 0.5 is good.

   The default probeRadius is 1.4 |A|, the radius of water approximated
   as a sphere.

   The ``polygonizeMethod`` specifies the method to be used when generating
   the triangles for the surface.  Allowed values are from the 
   :oe:constns:`OESpicoli::OEPolygonizeMethod` namespace.

   The overloaded version of the function takes a coordinate and radii
   array, ``coords`` and ``radii`` respectively, of length ``natoms``
   to create the accessible surface.

   This function will set the array of vertex normals and array of
   atom indices on the surface.

   .. seealso::

      * :ref:`generation_molecules`
      * The :oe:constns:`OESpicoli::OEPolygonizeMethod` namespace



.. # split from OESpicoliFunctions.rst:466

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeProteinRibbonSurface

.. oe:function:: OEMakeProteinRibbonSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeProteinRibbonSurface(OESurface& surf,
                                         const OEChem::OEMolBase& mol,
                                         unsigned int type = OERibbonType::CAlpha)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeProteinRibbonSurface(surf: OESurface,
                                    mol: Union[OEGraphMol,OEMol,OEQMol],
                                    type: int) -> bool

   This function fills the surface surf with a ribbon surface for the molecule.

   It will set the vertex normals, colors, and atom indices on the surface.

   The ``type`` argument specifies the type of ribbon to be created,
   from the :oe:constns:`OESpicoli::OERibbonType` namespace. 
   



.. # split from OESpicoliFunctions.rst:477

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeSphericalSurface

.. oe:function:: OEMakeSphericalSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeSphericalSurface(OESurface& surf, float* center,
                                     float radius, unsigned int level = 4)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeSphericalSurface(surf: OESurface, center: OEFloatArray,
                                radius: float, level: int = 4) -> bool

   Creates a spherical surface in ``surf`` with the center located at
   ``center`` (an array of three floats) with the radius
   ``radius``. The ``level`` argument determines the number of
   triangles used to approximate the sphere. The number of triangles
   is equal to ``level(level + 1) * 8``. For example the default level of
   4 generates 160 triangles which is generally considered to be a
   good sphere to the human eye.



.. # split from OESpicoliFunctions.rst:492

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeSurfaceFromGrid

.. oe:function:: OEMakeSurfaceFromGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeSurfaceFromGrid(OESurface& surf,
                                    const OESystem::OESkewGrid& grid,
                                    float contour)
         bool OEMakeSurfaceFromGrid(OESurface& surf,
                                    const OESystem::OEFixedGrid<float>& grid,
                                    float contour)
         bool OEMakeSurfaceFromGrid(OESurface& surf,
                                    const OESystem::OEFixedGrid<float>& grid,
                                    float contour, float resolution)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeSurfaceFromGrid(surf: OESurface, grid: OESkewGrid,
                               contour: float) -> bool
         OEMakeSurfaceFromGrid(surf: OESurface, grid: OEFixedFloatGrid,
                               contour: float) -> bool
         OEMakeSurfaceFromGrid(surf: OESurface, grid: OEFixedFloatGrid,
                               contour: float, resolution: float) -> bool

   An implementation of the :term:`marching cubes` algorithm to create
   a surface, ``surf``, through the values in the grid, ``grid``. Grid
   points with values less than contour are inside the surface and the
   converse is true for grid points outside the surface. 

   .. seealso::
   
      * The :ref:`generation_grids` section for more information on
        converting grids to surfaces.



.. # split from OESpicoliFunctions.rst:515

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEMakeVoidVolume

.. oe:function:: OEMakeVoidVolume

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeVoidVolume(const OEChem::OEMolBase& mol1,
                               const OEChem::OEMolBase& mol2,
                               OESystem::OEScalarGrid& grid, float resolution,
                               float probeRadius = 1.4f)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeVoidVolume(mol1: Union[OEGraphMol,OEMol,OEQMol],
                          mol2: Union[OEGraphMol,OEMol,OEQMol],
                          grid: OEScalarGrid, resolution: float,
                          probeRad: float = 1.4) -> bool

   Constructs a grid representing the void, or unoccupied, volume between a 
   ligand (``mol1``) and a macromolecule (``mol2``) that can accommodate a
   spherical probe with radius less than ``probeRadius``.  The resolution of the grid
   is specified by ``resolution``.  The grid ``grid`` is resized to fit a
   5 Angstrom envelope around ``mol1``, and its values are set to 1.0 inside
   the void volume and 0.0 outside.



.. # split from OESpicoliFunctions.rst:532

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEReadSurface

.. oe:function:: OEReadSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReadSurface(const std::string& fname, OESurface& surf)
         bool OEReadSurface(OEPlatform::oeistream& ifs, OESurface& surf,
                            unsigned int type)

   .. oe:language:: python

      .. oe:api:: python

         OEReadSurface(fname: str, surf: OESurface) -> bool
         OEReadSurface(ifs: oeistream, surf: OESurface, type: int) -> bool

   Read the contents of the file named ``fname`` into the surface
   ``surf``. Returns ``false`` if ``fname`` is not a valid surface
   file name.

   An overload is provided to take any arbitrary
   :ref:`oeistream <OEPlatform_oeistream>`.



.. # split from OESpicoliFunctions.rst:547

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OEReduceSurface

.. oe:function:: OEReduceSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEReduceSurface(OESurface& reducedSurface,
                              const OESurface& original,
                              unsigned int targetNumberOfVertices,
                              unsigned int type = OEEdgeReductionType::MinimumDistance)

   .. oe:language:: python

      .. oe:api:: python

         OEReduceSurface(reducedSurface: OESurface, original: OESurface,
                         targetNumberOfVertices: int, type: int) -> bool

   Takes a surface and creates a new surface from it, with the new surface
   having a reduced number of vertices and triangles. The 
   ``targetNumberOfVertices`` argument supplies a value for the desired number
   of vertices for the returned surface.  The overall quality of the new
   surface will depend on this value, with smaller values giving lower quality
   surfaces. Currently only one edge reduction method is supported
   (:oe:const:`OESpicoli::OEEdgeReductionType::MinimumDistance`).  Returns 
   true if the returned surface contains the requested number of vertices.



.. # split from OESpicoliFunctions.rst:565

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OERotateSurface

.. oe:function:: OERotateSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OERotateSurface(OESurface& surf, float* rmat)

   .. oe:language:: python

      .. oe:api:: python

         OERotateSurface(surf: OESurface, rmat: OEFloatArray) -> None

   Rotates the surface by the supplied 3x3 matrix ``rmat``, specified as a
   9-element array in row-major order.

   .. seealso::

      * :oe:func:`OESpicoli::OETranslateSurface`
      * :oe:func:`OESpicoli::OETransformSurface`



.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESetSurface

.. oe:function:: OESetSurface

   .. oe:language:: python

      .. oe:api:: python

         OESetSurface(obj, tag, surface) -> bool

   .. oe:language:: java csharp

      .. oe:api:: java csharp

         boolean OESetSurface(OEBase obj, String tag, OESurface surface)

   .. oe:language:: python java csharp

      Sets an :ref:`OESurface <OESpicoli_OESurface>` as generic data on an
      OEBase object, using the specified tag.

      .. seealso::

         * :oe:func:`OESpicoli::OEGetSurface` function

   .. oe:language:: c++

      This function is provided in CSharp, Java and Python wrappers and
      is not needed in C++.  Use the templated
      :oe:meth:`OESystem::OEBaseDataT::SetData` method instead.


.. # split from OESpicoliFunctions.rst:602

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESetSurfaceColor

.. oe:function:: OESetSurfaceColor

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetSurfaceColor(OESurface& surf, float r, float g, float b,
                                float a = 1.0f)
         bool OESetSurfaceColor(OESurface& surf, unsigned char r,
                                unsigned char g, unsigned char b,
                                unsigned char a = 255)

   .. oe:language:: python

      .. oe:api:: python

         OESetSurfaceColor(surf: OESurface, r: float, g: float, b: float,
                           a: float = 1.0) -> bool
         OESetSurfaceColor(surf: OESurface, r: str, g: str, b: str,
                           a: str = 255) -> bool

   Sets the color of the entire surface to the specified color. 



.. # split from OESpicoliFunctions.rst:613

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESetSurfacePotentials

.. oe:function:: OESetSurfacePotentials

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetSurfacePotentials(OESurface& surf,
                                     const OESystem::OEScalarGrid& grid)

   .. oe:language:: python

      .. oe:api:: python

         OESetSurfacePotentials(surf: OESurface, grid: OEScalarGrid) -> bool

   Linearly interpolates the values in the
   :ref:`OEScalarGrid <OESystem_OEScalarGrid>` ``grid`` onto the surface
   ``surf``. The scalar value associated with each vertex can then be
   accessed using the :oe:meth:`OESpicoli::OESurface::GetPotential` and
   :oe:meth:`OESpicoli::OESurface::GetPotentialElement` methods.




.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESmoothSurfaceEdges

.. oe:function:: OESmoothSurfaceEdges

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESmoothSurfaceEdges(OESurface& surf)

   .. oe:language:: python

      .. oe:api:: python

         OESmoothSurfaceEdges(surf: OESurface) -> bool

   Smooth the edges of an open surface by adjusting edge vertices. This is
   designed mostly for cleaner visual representation in 3D.

.. _figure_smooth_surface:

.. figure:: /_images/smoothsurface.png
   :align: center

   Left picture is a standard, cropped subsurface. Right is the same surface
   after smoothing.


.. # split from OESpicoliFunctions.rst:626

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESpicoliGetArch

.. oe:function:: OESpicoliGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESpicoliGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OESpicoliGetArch() -> str



.. # split from OESpicoliFunctions.rst:633

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESpicoliGetLicensee

.. oe:function:: OESpicoliGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESpicoliGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OESpicoliGetLicensee(licensee: str) -> bool



.. # split from OESpicoliFunctions.rst:640

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESpicoliGetPlatform

.. oe:function:: OESpicoliGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESpicoliGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OESpicoliGetPlatform() -> str

   Return the internal build string used by OpenEye Scientific
   Software to identify a platform. The format of these strings may
   change over time, and future distributions may contain different
   values even when using the same operating system, compiler and
   processor. For example, on a x86_64 Red Hat Enterprise Linux box
   this would return ``redhat-RHEL5-g++4.1-x64``.



.. # split from OESpicoliFunctions.rst:654

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESpicoliGetRelease

.. oe:function:: OESpicoliGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESpicoliGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OESpicoliGetRelease() -> str

   Return the release name of the ``OESpicoli`` library being used. This
   returns a value similar to ``1.0`` for production versions of the
   library, and ``1.0 debug`` for the checking version of the
   library.



.. # split from OESpicoliFunctions.rst:668

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESpicoliGetSite

.. oe:function:: OESpicoliGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESpicoliGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OESpicoliGetSite(site: str) -> bool



.. # split from OESpicoliFunctions.rst:675

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESpicoliGetVersion

.. oe:function:: OESpicoliGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OESpicoliGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OESpicoliGetVersion() -> int

   Return the version number of the library being used. This is an
   unsigned integer value indicating the date on which the library was
   built, for example 20020903, for the 3rd of September 2002. This
   value should be used when reporting problems, and unlike the
   release string, may be used in comparisons if needed.



.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESpicoliIsLicensed

.. oe:function:: OESpicoliIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESpicoliIsLicensed(const char* feature = 0,
                                  unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OESpicoliIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **Spicoli TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **Spicoli TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **Spicoli TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function


.. # split from OESpicoliFunctions.rst:722

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESplitSurfaceByAtoms

.. oe:function:: OESplitSurfaceByAtoms

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESplitSurfaceByAtoms(OESurface& newsurf, const OESurface& surf,
                                    const OEChem::OEMolBase& mol,
                                    double maxDist = 4.0)
         bool OESplitSurfaceByAtoms(OESurface& surf,
                                    const OEChem::OEMolBase& mol,
                                    double maxDist = 4.0)

   .. oe:language:: python

      .. oe:api:: python

         OESplitSurfaceByAtoms(newsurf: OESurface, surf: OESurface,
                               mol: Union[OEGraphMol,OEMol,OEQMol],
                               maxDist: float = 4.0) -> bool
         OESplitSurfaceByAtoms(surf: OESurface,
                               mol: Union[OEGraphMol,OEMol,OEQMol],
                               maxDist: float = 4.0) -> bool

   Given an OESurface (``surf``) and the molecule it was constructed 
   from (``mol``), this function will create a new version of the surface
   with triangles cleanly partitioned by atom boundaries.  The vertices,
   triangles, and atom associations in the surface are all adjusted from the
   original surface to create the partitioning.  With the first form of this
   function, the split surface will be returned in the ``newsurf`` surface
   object.  With the second form, the input surface is modified in-place.
   The ``maxDist`` parameter specifies an upper limit for the expected 
   distance from any vertex in the surface to its assigned atom.  The 
   default value is adequate for normal molecular and solvent-accessible 
   surfaces.  Using too small of a value will result in decreased performance.

   .. seealso::
  
      * :ref:`splitting`



.. # split from OESpicoliFunctions.rst:750

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESurfaceArea

.. oe:function:: OESurfaceArea

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OESurfaceArea(const OESurface& surf)

   .. oe:language:: python

      .. oe:api:: python

         OESurfaceArea(surf: OESurface) -> float

   Returns the total surface area of ``surf``.



.. # split from OESpicoliFunctions.rst:758

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESurfaceCliqueArea

.. oe:function:: OESurfaceCliqueArea

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OESurfaceCliqueArea(const OESurface& surf, unsigned int clique)

   .. oe:language:: python

      .. oe:api:: python

         OESurfaceCliqueArea(surf: OESurface, clique: int) -> float

   Return the surface area for a specified clique. Zero is not a valid clique. See
   Section 2.3.1 on how vertex cliques are assigned to triangles.



.. # split from OESpicoliFunctions.rst:767

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESurfaceCliqueCentroid

.. oe:function:: OESurfaceCliqueCentroid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESurfaceCliqueCentroid(const OESurface& surf,
                                      unsigned int clique, float* centroid)

   .. oe:language:: python

      .. oe:api:: python

         OESurfaceCliqueCentroid(surf: OESurface, clique: int,
                                 centroid: OEFloatArray) -> bool

   Return the centroid coordinates $(x,y,z)$ in centroid for
   clique. Zero is not a valid clique. 

   .. seealso::
   
      * The :ref:`manipulation_cliques` section on how vertex cliques
        are assigned to triangles.



.. # split from OESpicoliFunctions.rst:782

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESurfaceCliqueVolume

.. oe:function:: OESurfaceCliqueVolume

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OESurfaceCliqueVolume(const OESurface& surf, unsigned int clique)

   .. oe:language:: python

      .. oe:api:: python

         OESurfaceCliqueVolume(surf: OESurface, clique: int) -> float

   Return the volume for a specified clique. Zero is not a valid clique. 

   .. seealso::
   
      * The :ref:`manipulation_cliques` section on how vertex cliques
        are assigned to triangles.

   .. note::

      The volume may be negative if the clique is an open
      surface. However, the sum of all surface partitions will equal
      the total volume of the enclosed surface.



.. # split from OESpicoliFunctions.rst:801

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESurfaceCropToClique

.. oe:function:: OESurfaceCropToClique

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESurfaceCropToClique(OESurface& surf, unsigned int clique)

   .. oe:language:: python

      .. oe:api:: python

         OESurfaceCropToClique(surf: OESurface, clique: int) -> bool

   Trim surf of the triangles not marked with the vertex clique value
   clique. Zero is not a valid clique. See Section 2.3.1 on how vertex
   cliques are assigned to triangles. Returns true
   if successful.

   .. seealso::
   
      * The :ref:`manipulation_cliques` section on how vertex cliques
        are assigned to triangles.
      * The :ref:`generation_surfaces` section for an explanation of
        how Spicoli handles subset boundaries.



.. # split from OESpicoliFunctions.rst:819

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESurfaceIsOpen

.. oe:function:: OESurfaceIsOpen

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESurfaceIsOpen(const OESurface& surf)

   .. oe:language:: python

      .. oe:api:: python

         OESurfaceIsOpen(surf: OESurface) -> bool

   Returns whether the surface is open. A surface is open if any triangle
   does not border exactly three other triangles.



.. # split from OESpicoliFunctions.rst:828

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESurfaceToMoleculeDistance

.. oe:function:: OESurfaceToMoleculeDistance

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESurfaceToMoleculeDistance(OESurface& surf,
                                          const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OESurfaceToMoleculeDistance(surf: OESurface,
                                     mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Will calculate the minimum distance between every vertex in the
   surface (surf) and every atom in the molecule (mol). The molecule
   must have valid 3D coordinates assigned. The minimum
   distance for each vertex is then stored on the surface to be
   accessed via the :oe:meth:`OESpicoli::OESurface::GetDistance` and
   :oe:meth:`OESpicoli::OESurface::GetDistanceElement`
   methods. Distances are calculated as the euclidean distance between
   the vertex and atom center minus the atomic radii. Note that this
   can result in distances that are negative to denote that they are
   ``inside`` the molecule. If atomic radii are not specified on the
   molecule BondiVdWRadii will be used.

   This function will also reassign the atom indices associated with
   every vertex of the surface. To access these changes use the
   :oe:meth:`OESpicoli::OESurface::GetAtoms` and
   :oe:meth:`OESpicoli::OESurface::GetAtomsElement` methods.



.. # split from OESpicoliFunctions.rst:850

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OESurfaceVolume

.. oe:function:: OESurfaceVolume

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OESurfaceVolume(const OESurface& surf)

   .. oe:language:: python

      .. oe:api:: python

         OESurfaceVolume(surf: OESurface) -> float

   Returns the volume enclosed by the surface. 



.. # split from OESpicoliFunctions.rst:858

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OETransformSurface

.. oe:function:: OETransformSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OETransformSurface(OESurface& surf, const OEChem::OETrans& trans)

   .. oe:language:: python

      .. oe:api:: python

         OETransformSurface(surf: OESurface, trans: OETrans) -> None

   Transforms a surface using a supplied :ref:`OETrans <OEChem_OETrans>` object.

   .. seealso::

      * :oe:func:`OESpicoli::OERotateSurface`
      * :oe:func:`OESpicoli::OETranslateSurface`
      * :ref:`OETrans <OEChem_OETrans>`



.. # split from OESpicoliFunctions.rst:872

.. oe:namespace:: OESpicoli

.. meta::
   :keywords: OETranslateSurface

.. oe:function:: OETranslateSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OETranslateSurface(OESurface& surf, float* trans)

   .. oe:language:: python

      .. oe:api:: python

         OETranslateSurface(surf: OESurface, trans: OEFloatArray) -> None

   Translates the surface using the supplied 3-element translation vector.

   .. seealso::

      * :oe:func:`OESpicoli::OERotateSurface`
      * :oe:func:`OESpicoli::OETransformSurface`



.. meta::
   :keywords: OEWriteSurface

.. oe:namespace:: OESpicoli

.. oe:function:: OEWriteSurface

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEWriteSurface(const std::string& fname, const OESurface& surf)
         bool OEWriteSurface(OEPlatform::oeostream& ofs, const OESurface& surf,
                             unsigned int type)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteSurface(fname: str, surf: OESurface) -> bool
         OEWriteSurface(ofs: oeostream, surf: OESurface, type: int) -> bool

   Write surf to the surface file ``fname``. Returns ``false`` if
   ``fname`` is not a valid surface file name. This will overwrite the
   previous file if it existed.

   The overload that takes an :oe:func:`OEPlatform::oeostream` can be
   used to write multiple surfaces to the same destination. Note that
   the format must be specified by a constant from the
   :oe:constns:`OESpicoli::OESurfaceFileType` namespace as the type
   argument. The :oe:const:`OESpicoli::OESurfaceFileType::Grasp` format
   does not support this kind of use. Returns ``true`` if written
   successfully.



*******************************************************************************
OESpicoli Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEAddSurfaces.rst
   OECalculateFaceNormals.rst
   OECalculateNormals.rst
   OECalculateSurfaceCurvature.rst
   OECalculateSurfacePotentials.rst
   OECalculateTriangleAreas.rst
   OEColorSurfaceByPotential.rst
   OEGetCenterAndExtents.rst
   OEGetSurface.rst
   OEGetSurfaceFileType.rst
   OEGetSurfaceFormatExtension.rst
   OEGetSurfaceFormatString.rst
   OEInitSurfaceHandlers.rst
   OEInvertSurface.rst
   OEIsReadableSurface.rst
   OEIsWriteableSurface.rst
   OEMakeAccessibleSurface.rst
   OEMakeBitGridFromSurface.rst
   OEMakeBoxSurface.rst
   OEMakeCavitySurfaces.rst
   OEMakeCliqueSurface.rst
   OEMakeComplexCavities.rst
   OEMakeConnectedSurfaceCliques.rst
   OEMakeEllipsoidSurface.rst
   OEMakeGridFromSurface.rst
   OEMakeMolecularSurface.rst
   OEMakeProteinRibbonSurface.rst
   OEMakeSphericalSurface.rst
   OEMakeSurfaceFromGrid.rst
   OEMakeVoidVolume.rst
   OEReadSurface.rst
   OEReduceSurface.rst
   OERotateSurface.rst
   OESetSurface.rst
   OESetSurfaceColor.rst
   OESetSurfacePotentials.rst
   OESmoothSurfaceEdges.rst
   OESpicoliGetArch.rst
   OESpicoliGetLicensee.rst
   OESpicoliGetPlatform.rst
   OESpicoliGetRelease.rst
   OESpicoliGetSite.rst
   OESpicoliGetVersion.rst
   OESpicoliIsLicensed.rst
   OESplitSurfaceByAtoms.rst
   OESurfaceArea.rst
   OESurfaceCliqueArea.rst
   OESurfaceCliqueCentroid.rst
   OESurfaceCliqueVolume.rst
   OESurfaceCropToClique.rst
   OESurfaceIsOpen.rst
   OESurfaceToMoleculeDistance.rst
   OESurfaceVolume.rst
   OETransformSurface.rst
   OETranslateSurface.rst
   OEWriteSurface.rst



.. _spicoli_part_api:

********************************
API
********************************

.. toctree::
   :maxdepth: 2

   OESpicoliClasses/OESpicoliClasses
   OESpicoliConstants/OESpicoliConstants
   OESpicoliFunctions/index


.. _spicoli_part_releasenotes:

*****************************
Release History
*****************************

.. _chapter_releasenotes:

.. toctree::
   :maxdepth: 1

   version1_6_4
   version1_6_3
   version1_6_2
   version1_6_1
   version1_6_0
   version1_5_7
   version1_5_6
   version1_5_5
   version1_5_4
   version1_5_3
   version1_5_2
   version1_5_1
   version1_5_0
   version1_4_7
   version1_4_6
   version1_4_5
   version1_4_4
   version1_4_3
   version1_4_2
   version1_4_1
   version1_4_0
   version1_3_7
   version1_3_6
   version1_3_5
   version1_3_4
   version1_3_3
   version1_3_2
   version1_3_1
   version1_3_0
   version1_2_2
   version1_2_1
   version1_2_0
   version1_1_3
   version1_1_2
   version1_1_1
   version1_1_0
   version1_0_2
   version1_0_1



Spicoli TK 1.6.4
================================================================================

Minor internal improvements have been made.


.. _section_spicoli_releasenotes_101:

Spicoli TK 1.0.1
================================================================================

Bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OESpicoli::OEInvertSurface` properly inverts all surface normals.

* :oe:func:`OESpicoli::OEMakeCavitySurfaces` was totally busted
  before. Added a default resolution of 0.5.

* Added a default resolution of 0.5 to
  :oe:func:`OESpicoli::OEMakeComplexCavities`.

* :oe:func:`OESpicoli::OEMakeBoxSurface` now takes a ``const float *``
  as it should.



.. _section_spicoli_releasenotes_102:

Spicoli TK 1.0.2
================================================================================

New features
--------------------------------------------------------------------------------

* The user is no longer required to call
  :oe:func:`OESpicoli::OEInitSurfaceHandlers` in order to attach
  surfaces to molecules and then write them out to OEB. This occurs at
  library link time now.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OESpicoli::OESurface::operator=` now copies
  the :ref:`OEBase <OESystem_OEBase>` data.

* :oe:func:`OESpicoli::OEMakeCliqueSurface` and
  :oe:func:`OESpicoli::OESurfaceCropToClique` now preserve
  :ref:`OEBase <OESystem_OEBase>` data.


.. _section_spicoli_releasenotes_110:

Spicoli TK 1.1.0
================================================================================

New Features
---------------------

* Added the :oe:func:`OESpicoli::OEMakeBitGridFromSurface`
  function. This is a lot faster than using
  :oe:func:`OESpicoli::OEMakeGridFromSurface` to generate a lookup grid
  for whether a point is inside or outside a surface. 

.. oe:language:: java

   * Added :oe:func:`OESpicoli::OESetSurface` and
     :oe:func:`OESpicoli::OEGetSurface` to the Java wrappers. 

   .. seealso::

      * :ref:`Attached to Molecules <storage_molecules>`

Bug fixes
--------------------------------------------------------------------------------

* The previous release (1.0.2) introduced the feature that didn't
  require the user to call
  :oe:func:`OESpicoli::OEInitSurfaceHandlers`. This didn't work
  sometimes when statically linking an executable. This was because
  the library initialization code that needed to get run was getting
  discarded by the linker because none of the functions in that
  translation unit were being called. The library initialization code
  has been migrated to the same translation unit as the
  :ref:`OESurface <OESpicoli_OESurface>` since these functions always have to be called
  to attach a molecule as generic data. 

  .. note:: 
     
     This only affected C++ users. 


.. _section_spicoli_releasenotes_111:

Spicoli TK 1.1.1
================================================================================

Bug fixes
--------------------------------------------------------------------------------

* Minor documentation fixes. 

* :oe:func:`OESpicoli::OEMakeComplexCavities` example program now
  properly suppresses hydrogen and passes the protein and ligand to
  the function in the proper order.

.. oe:language:: java

   * :oe:func:`OESpicoli::OEMakeVoidVolume` is now usable in Java, the
     signature used to use an incorrect grid type. 

   * Surface IO APIs now properly wrapped in Java. 



.. _section_spicoli_releasenotes_112:

Spicoli TK 1.1.2
================================================================================

* Internal build system improvements.




.. _section_spicoli_releasenotes_113:

Spicoli TK 1.1.3
================================================================================

.. oe:language:: python

   * Added two examples of extracting the surface of the protein around a binding site. 

.. oe:language:: c++

   * The C++ polar surface area example had a line of code accidentally commented out that was causing it not to work. 

.. oe:language:: csharp java
   
   * Internal build system improvements. 



.. _section_spicoli_releasenotes_120:

Spicoli TK 1.2.0
================================================================================

* A number of :ref:`OESurface <OESpicoli_OESurface>` methods for accessing
  triangles, vertices, and normals have been deprecated and replaced
  with more convenient methods.  The old methods required three calls
  to get all three components of a vector or triangle, while the new
  methods only require one.

  ========================= ======================
  Deprecated Methods        Replacement Methods   
  ========================= ======================
  GetVerticesElement        GetVertex             
  SetVerticesElement        SetVertex             
  GetTrianglesElement       GetTriangle           
  SetTrianglesElement       SetTriangle           
  GetNormalsElement         GetNormal             
  SetNormalsElement         SetNormal             
  GetFaceNormalsElement     GetFaceNormal         
  SetFaceNormalsElement     SetFaceNormal         
  ========================= ======================

* A new polygonization method has been made available to the
  :oe:func:`OESpicoli::OEMakeMolecularSurface` and
  :oe:func:`OESpicoli::OEMakeAccessibleSurface` functions. An optional
  argument to these functions can specify
  :oe:const:`OESpicoli::OEPolygonizeMethod::Grasp` (the original method) or
  :oe:const:`OESpicoli::OEPolygonizeMethod::Compact` (the newer method).  The newer
  method produces surfaces with around 30% fewer triangles and
  vertices, and a more uniform spacing of vertices.  The argument
  defaults to the original method, so existing code won't be affected.

* :oe:func:`OESpicoli::OEReduceSurface` added that
  allows the reduction of the number of vertices in a surface to a 
  user-specified number.

* New functions have been provided for transforming 
  :ref:`OESurface <OESpicoli_OESurface>` coordinates and normals: :oe:func:`OESpicoli::OERotateSurface`, :oe:func:`OESpicoli::OETranslateSurface`, and
  :oe:func:`OESpicoli::OETransformSurface`.




.. _section_spicoli_releasenotes_121:

Spicoli TK 1.2.1
================================================================================

* Minor internal improvements. 



.. _section_spicoli_releasenotes_122:

Spicoli TK 1.2.2
================================================================================

- Minor internal improvements. 



.. _section_spicoli_releasenotes_130:

Spicoli TK 1.3.0
================================================================================

New features
--------------------------------------------------------------------------------

* The internals of the Spicoli toolkit have been migrated from C to
  pure C++ to ensure better interoperability with C++, especially in
  terms of object lifetime and management.

.. oe:language:: java

   For Java, this means explicitly calling the `OESurface::delete()`
   method should no longer be required to avoid a race condition with
   the Java finalizer thread. This should make working with
   `OESurface` objects feel much more natural in Java.

* A new function, OESplitSurfaceByAtoms, will divide an OESurface and cleanly
  partition the triangles along atom boundaries.  The result is a surface that
  can be nicely divided and colored by its underlying atoms.

* The OESurface class has a new method, GetProbeRadius, which returns the 
  probe radius value used to create the surface.

* The functions OEMakeCavitySurfaces and OEMakeVoidVolume now accept an optional
  probe radius parameter to be used for the surface construction.  The default
  value of this parameter is 1.4 Angstroms.
  
Minor bug fixes
--------------------------------------------------------------------------------
* Generic data stored on an OESurface is now saved when the surface is written
  to .oeb or .oesrf files.




.. _section_spicoli_releasenotes_131:

Spicoli TK 1.3.1
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OESpicoli::OEMakeComplexCavities` added a "probe radius"
  argument.  Previously, the probe radius used in the calculation was
  always set to 1.4 Angstroms.
  
* :oe:func:`OESpicoli::OEMakeProteinRibbonSurface` added to generate a
  protein ribbon as an :ref:`OESurface <OESpicoli_OESurface>` object.

Documentation fixes
--------------------------------------------------------------------------------

* :oe:func:`OESpicoli::OEMakeVoidVolume` documentation corrected to
  clarify the meaning of the probe radius argument.

.. oe:language:: python

   * Python examples have been added to demonstrate additional
     functionality.

.. oe:language:: java

   * Java examples have been added to demonstrate additional
     functionality.

.. oe:language:: csharp

   * C# examples have been added to demonstrate additional
     functionality.




.. _section_spicoli_releasenotes_132:

Spicoli TK 1.3.2
================================================================================

* :oe:func:`OESpicoli::OEMakeCliqueSurface` and
  :oe:func:`OESpicoli::OESurfaceCropToClique` will no longer leave the
  :ref:`OESurface <OESpicoli_OESurface>` consuming more memory than necessary.

.. oe:language:: java

   * The following examples have been added to the Java distribution:

     - PsaSurface.java
     - Cavities.java
     - ComplexCavities.java
     - BindingSite2.java
     - BindingSite1.java


.. _section_spicoli_releasenotes_133:

Spicoli TK 1.3.3
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Internal refactoring has been performed to improve stability. 

Documentation fixes
--------------------------------------------------------------------------------

.. oe:language:: python java csharp

   * :oe:func:`OESpicoli::OESetSurface` and
     :oe:func:`OESpicoli::OEGetSurface` documentation have been added for Python,
     Java, and C#.

* The :oe:constns:`OESpicoli::OEEdgeReductionType` namespace is now documented. 

* The missing Java example Volume.java has been added.



Spicoli TK 1.3.4
================================================================================

* Minor internal cleanup has been performed.



Spicoli TK 1.3.5
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* Surface readers have been made more robust to junk data being passed
  to them. They should no longer crash for any random data input.

Documentation changes
--------------------------------------------------------------------------------

* The ``anisotropy`` example has been
  updated to perceive residues in cases when it is not done by the
  molecule reader (for example, in the case of :file:`mol2`).


Spicoli TK 1.3.6
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OESpicoli::OESmoothSurfaceEdges` function has been added
  for cleaner visual representation in 3D.

Major bug fixes
--------------------------------------------------------------------------------

* A crash in :oe:func:`OESpicoli::OEMakeGridFromSurface` has been fixed. The
  crash occurred when the function was passed a grid that wasn't large enough
  to enclose the entire surface.


Spicoli TK 1.3.7
================================================================================

* Minor internal improvements have been made.



Spicoli TK 1.4.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* A crash in the :oe:func:`OESpicoli::OEMakeProteinRibbonSurface` function
  that occurred when adding a ribbon to proteins with C-alpha atoms and
  alternate locations has been fixed.


Spicoli TK 1.4.1
================================================================================

* Minor internal improvements have been made.


Spicoli TK 1.4.2
================================================================================

New features
--------------------------------------------------------------------------------

* A new style of protein ribbons has been added and is accessible through the
  function :oe:func:`OESpicoli::OEMakeProteinRibbonSurface`. A third
  argument, a constant from the :oe:constns:`OESpicoli::OERibbonType` namespace,
  has been added to this function to specify the ribbon type. The new
  ribbon style :oe:const:`OESpicoli::OERibbonType::Pretty` creates ribbons
  that have a smoother appearance than the older, default style.

Major bug fixes
--------------------------------------------------------------------------------

* A crash that occurred with calling one variant of
  :oe:func:`OESpicoli::OEMakeBitGridFromSurface` has been fixed.


Spicoli TK 1.4.3
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* A bug that caused protein ribbons created with the type
  :oe:const:`OESpicoli::OERibbonType::Pretty` to be truncated
  by one residue at the C-terminus has been fixed.


Spicoli TK 1.4.4
================================================================================

* Minor internal improvements have been made.


Spicoli TK 1.4.5
================================================================================

New features
--------------------------------------------------------------------------------

* DNA/RNA ribbons are now available through the
  :oe:func:`OESpicoli::OEMakeProteinRibbonSurface` function. When molecules containing
  DNA or RNA residues are passed to this function with a ribbon style of
  :oe:const:`OESpicoli::OERibbonType::Pretty`, the resulting surface now
  contains ribbons for both protein and nucleic acid residues.

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OESpicoli::OEMakeAccessibleSurface` no longer crashes when passed
  extremely large molecules (many hundreds of Angstroms across). The function
  now reduces the resolution of the surface, if necessary, to allow the surface
  to fit in the available memory.


Spicoli TK 1.4.6
================================================================================

* Minor internal improvements have been made.


Spicoli TK 1.4.7
================================================================================

* Minor internal improvements have been made.




Spicoli TK 1.5.0
================================================================================

* Minor internal improvements have been made.




Spicoli TK 1.5.1
================================================================================

*Fall 2020*

* Minor internal improvements have been made.



Spicoli TK 1.5.2
================================================================================

*July 2021*

Minor internal improvements have been made.





Spicoli TK 1.5.3
================================================================================

*Fall 2021*

* Minor internal improvements have been made.





Spicoli TK 1.5.4
================================================================================

* Minor internal improvements have been made.




Spicoli TK 1.5.5
================================================================================

Minor internal improvements have been made.





Spicoli TK 1.5.6
================================================================================

Minor internal improvements have been made.




Spicoli TK 1.5.7
================================================================================

New features
--------------------------------------------------------------------------------

* A function was added to assign surface potentials based on a molecule's :ref:`OECalculateSurfacePotentials <OESpicoli_OECalculateSurfacePotentials>`,
  using either atomic potentials or a potential based on formal charges of protein residues at the protein
  surface (GRASP) using Zap (license required).

* A function was added to color a surface based on its stored potential :ref:`OEColorSurfaceByPotential <OESpicoli_OEColorSurfaceByPotential>`.




Spicoli TK 1.6.0
================================================================================

Minor internal improvements have been made.





Spicoli TK 1.6.1
================================================================================

Minor internal improvements have been made.



Spicoli TK 1.6.2
================================================================================

Minor internal improvements have been made.




Spicoli TK 1.6.3
================================================================================

Minor internal improvements have been made.


###############################################
Appendix: Additional Examples in Python
###############################################

These are full listings of programming examples that are excerpted or offered for download, elsewhere in this chapter.

..  _listing-CalculateTriangleAreas.py:

..  oe:source:: CalculateTriangleAreas.py
    :language: python
    :noindent:
    :caption: CalculateTriangleAreas.py full listing.
    :refnum: 1

..  _listing-MakeConnectedSurfaceCliques.py:

..  oe:source:: MakeConnectedSurfaceCliques.py
    :language: python
    :noindent:
    :caption: MakeConnectedSurfaceCliques.py full listing.
    :refnum: 2

..  _listing-AttachSurface.py:

..  oe:source:: AttachSurface.py
    :language: python
    :noindent:
    :caption: AttachSurface.py full listing.
    :refnum: 3

..  _listing-SurfaceDataAccess.py:

..  oe:source:: SurfaceDataAccess.py
    :language: python
    :noindent:
    :caption: SurfaceDataAccess.py full listing.
    :refnum: 4



.. _storage:

####################
Surface Storage
####################

.. _storage_file_formats:

*************
File Formats
*************

Spicoli supports the following storage formats:

:.srf:
    Old GRASP format 
:.oesrf:
    OpenEye format based upon tagged binary files 

The :term:`GRASP` format is provided for backwards compatibility with
older visualization programs. There were byte ordering issues with the
format so OpenEye developed a more flexible format based upon the
tagged binary IO available in OESystem.

.. seealso:: 

   * :oe:func:`OESpicoli::OEWriteSurface`
   * :oe:constns:`OESpicoli::OESurfaceFileType`

.. _storage_molecules:

*********************
Attached to Molecules
*********************

The OpenEye format allows surfaces to be attached to molecules and
then written out to OEBinary (.oeb) files. A visualizer can then read
in the molecule and surface without any other means of making the
association. :oe:src:`Listing 1<SNIPPET-SetData-AttachSurface>`
demonstrates how to properly attach surfaces to molecules.

.. oe:source:: AttachSurface.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-SetData
   :caption: Attaching a surface as generic data to be written to OEB
   :refnum: 1

.. oe:source:: AttachSurface.py
   :language: python
   :frag:     SNIPPET-SetData
   :caption: Attaching a surface as generic data to be written to OEB
   :refnum: 1

..  oe:language:: python

   :ref:`Full listing. <listing-AttachSurface.py>`

.. oe:source:: AttachSurface.java
   :language: java
   :noindent:
   :frag:     SNIPPET-SetData
   :caption: Attaching a surface as generic data to be written to OEB
   :refnum: 1

.. oe:source:: AttachSurface.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-SetData
   :caption: Attaching a surface as generic data to be written to OEB
   :refnum: 1

:oe:src:`Listing 2<SNIPPET-GetData-AttachSurface>` demonstrates how to
then read that surface back out of the OEB file.

.. oe:source:: AttachSurface.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-GetData
   :caption: Retrieving a surface attached as generic data from an OEB file
   :refnum: 2

.. oe:source:: AttachSurface.py
   :language: python
   :frag:     SNIPPET-GetData
   :caption: Retrieving a surface attached as generic data from an OEB file
   :refnum: 2

..  oe:language:: python

   :ref:`Full listing. <listing-AttachSurface.py>`

.. oe:source:: AttachSurface.java
   :language: java
   :noindent:
   :frag:     SNIPPET-GetData
   :caption: Retrieving a surface attached as generic data from an OEB file
   :refnum: 2

.. oe:source:: AttachSurface.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-GetData
   :caption: Retrieving a surface attached as generic data from an OEB file
   :refnum: 2

.. seealso::
   
   * :oe:meth:`OESystem::OEBase::SetData`
   * :oe:meth:`OESystem::OEBase::GetData`

.. note:: 

   Versions of Spicoli prior to 1.0.2 required
   calling :oe:func:`OESpicoli::OEInitSurfaceHandlers` in order to have
   surfaces attached to molecules be read and written to and from OEB.



.. szmaptk toolkit documentation master file

#############################
Szmap Toolkit |szmap_version|
#############################

..  oe:language:: python

    .. toctree::
       :maxdepth: 3

       introduction
       theory
       examples
       selected_examples_python
       api
       releasenotes/index

..  oe:language:: c++ csharp java

    .. toctree::
       :maxdepth: 3

       introduction
       theory
       examples
       api
       releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _chapter_szmap_intro:

********************************************************************************
Introduction
********************************************************************************

The *Szmap TK* provides simple access to *SZMAP* functionality
for calculating solvent thermodynamic properties near molecular surfaces.

.. _section_licenses:

Licenses
================================================================================

To perform calculations with *Szmap TK* you will need to
obtain a license file for ``szmaptk`` and ``oechem``
from OpenEye, Cadence Molecular Sciences (https://www.eyesopen.com/contact).
If you wish to incorporate additional OpenEye functionality
into software you develop, other licenses may also be
required.

The license file
should be in a file pointed to by
the :envvar:`OE_LICENSE` environment variable.
On Windows, the environment variables can be set under the system
Control Panel.

This manual is to familiarize the user with *Szmap TK*
functionality. It does not provide an explanation
of basic *OEChem* classes and functions. Therefore reading the
*OEChem TK* manual beforehand is highly recommended.

Another source of information is the "OpenEye SZMAP" manual,
which describes the ``szmap`` and ``gameplan`` applications
and associated utilities, along with the theory behind *SZMAP*.

Finally, the "OpenEye Zap" manual is a good source of information
on the theory and practice of Poisson-Boltzmann calculations.

.. oe:language:: c++

   .. seealso::

      * :ref:`C++ Quick Start Manual <section_cpp_getting_started>` for
        installation instructions.
      * :ref:`section_cpp_tk_import` section

.. oe:language:: python

   .. seealso::

      * :ref:`Python Quick Start Manual <section_python_getting_started>` for
        installation instructions.
      * :ref:`section_python_tk_import` section

.. oe:language:: java

   .. seealso::

      * :ref:`Java Quick Start Manual <section_cpp_getting_started>` for
        installation instructions.
      * :ref:`section_java_tk_import` section

.. oe:language:: csharp

   .. seealso::

      * :ref:`C# Quick Start Manual <section_csharp_getting_started>` for
        installation instructions.
      * :ref:`section_csharp_tk_import` section


.. _szmap_part_theory:

********************************
Theory
********************************

.. toctree::
   :maxdepth: 2

   semicontinuum
   workingwithszmap
   water-model



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _chapter_semicontinuum:

********************************************************************************
Semi-continuum Solvation with SZMAP
********************************************************************************

.. _figure_water_cluster:

.. figure:: /_images/szmaptk-water-cluster.png
   :scale:  75
   :align:  center

   **Water Probe Orientations**

*SZMAP* is a
technology---based on semi-continuum Poisson-Boltzmann theory---for
analyzing proteins and/or ligands using an
explicit probe water molecule to estimate various thermodynamic properties.

The Poisson-Boltzmann (PB) continuum model of water
[Grant-2001]_, [Gilson-1988]_, and [Sharp-1990]_
is simple, effective, and with OpenEye's *OEZap*, fast. But,
near strong charges or in regions of constrained geometry
PB can be *too* good at solvating a surface,
leading to over-estimates of solvation free energies [Sharp-1991]_.
PB also fails to model hydrogen bonds, "structured waters",
and other geometric considerations important to drug design.

One common approach to capturing these geometric aspects of solvation
is to use all-atom simulations such as molecular dynamics
with explicit solvent. For some molecular properties this
may be a good way to go. But the very heavy sampling cost
is often not repaid in improved results
[Nicholls-2008]_, [Nicholls-2009]_.

For solvation, a more efficient approach is to probe
the region of interest with a single explicit all-atom
solvent molecule, embedded in and interacting with continuum
solvent and with the molecular surface.

*SZMAP* is just such a *semi-continuum* solvation model.
It uses *OEZap* to perform the PB calculations.
Because the continuum solvent responds to
the charges and geometry of the solvent probe
water-water interactions are captured.
Because the probe is constrained by its physical
size and shape, structural details of solvent to
solute interactions are captured.

Energy Calculations
--------------------------------------------------------------------------------

By sampling a full range of orientations for the probe at
any position, thermodynamic properties are calculated
using statistical mechanics.

For the purposes of discussion, we'll assume the solute
being analyzed is a protein.
The energy for each
probe water orientation *j* is the sum of
the *ZAP*  protein:water Coulombic
interaction energy, the protein and water
desolvation penalties and the van der Waals
energy. For speed, the protein desolvation term
is not computed for each orientation,
but is instead computed once per point
using a spherical united-atom representation
of the probe water.

.. math::

   E_j = ZAP_{int}(P:W) + P_{desolv}^* + W_{desolv} + VDW \,\,\, \{ j = 1 \cdots N_{orient} \}

The partition function *Q* is the usual sum:

.. math::

   \displaystyle Q = \sum_{j=1}^{N_{orient}} e^{-\frac{E_j}{kT}}

The probability of each orientation is then:

.. math::

   \displaystyle prob_j = \frac{e^{-\frac{E_j}{kT}}}{Q}

The probe water orientation entropy difference from continuum water is:

.. math::

   \displaystyle T \Delta S = ( -kT \sum_{j=1}^{N_{orient}} prob_j \ln prob_j ) - kT \ln N_{orient}

Likewise, the probe water free energy difference from continuum water is:

.. math::

   \Delta G = - ( kT \ln Q - kT \ln N_{orient})

And of course, the enthalpy difference is the sum:

.. math::

   \Delta H = \Delta G + T \Delta S

Uncharged Water and Difference Energies
--------------------------------------------------------------------------------

The values *Szmap TK* calculates
for :math:`\Delta G`, :math:`\Delta H` and :math:`T \Delta S`
represent differences between the explicit probe water and the continuum water. In
other words, a positive :math:`\Delta G` indicates that the continuum model over-estimates
the cost of displacing water at that position. When trying to decide which modifications
are most likely to increase binding affinity, we would prefer to compare
the water probe to the ligand atom that displaces it, or at least a proxy for the ligand atom.
In *SZMAP*, this proxy is the water probe without
any of the energy terms that involve a charge
on the water (leaving only :math:`P_{desolv} + VDW`). Because these energy terms have
already been determined, calculating the properties
for this "uncharged" or "neutral" water requires
no additional time, it's free. The difference in free energy between standard and uncharged
water is negative where standard water is more favored and positive where the uncharged water,
our hydrophobic group proxy, is more favored.

This :oe:const:`OESzmap::OEEnsemble::NeutralDiffDeltaG` energy and
the :oe:const:`OESzmap::OEEnsemble::VDW` energy (which is subtracted out
of the difference calculation above) are the primary *SZMAP* terms
relevant to drug design.

*Szmap TK* can also calculate the difference
between our probe and a vacuum bubble of the
same size (defined as just the :math:`P_{desolv}` term). Because protein desolvation
is treated as constant over all probe orientations only the vacuum free energy and 
enthalpy differences are calculated, not the entropy differences.

Regions are said to *clash* if the sum of the van der Waals
and interaction energies is greater than a cutoff (by default
:math:`0 \, kcal \, mol^{-1}`). Calculated ensemble energies
in clashing regions are usually not very meaningful.

When interpreting these difference energies,
it should be beneficial for a hydrophobic ligand atom to overlap a region where the
neutral free energy difference is positive because this involves displacing water that is less
favorable than the neutral probe. Overlapping a region where the neutral free energy
difference is negative, on the other hand, requires the overlapping
group to be at least as polar as water and making a similar level of interactions.

Stabilization
--------------------------------------------------------------------------------

It is possible to use *Szmap TK* to calculate *stabilization* energies
as a reaction energy

.. math::

   (holo\mbox{-}complex + bulk\mbox{-}solvent) - (apo\mbox{-}pocket + free\mbox{-}ligand)

where *bulk-solvent* is defined as :math:`0 \, kcal \, mol^{-1}`, by subtracting
neutral difference free energies
from a point near the protein/ligand complex, the protein alone, and the ligand alone.

Negative stabilization free energy values indicate
water is stabilized at that location in the complex,
over and above the same location in the ligand
and the *apo* pocket. Positive values are found where
the water is destabilized in the complex.
The stabilization or destabilization says nothing about
the actual level of stability, so these
energies need to be compared to others such as the
*apo* or complex neutral difference free energy.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _working_with_szmap:

********************************************************************************
Working with Szmap TK
********************************************************************************

The *Szmap TK* has a simple API,
consisting of a few basic :ref:`szmap_part_api`
and a couple of objects to configure
the calculations
(:ref:`OESzmapEngine <OESzmap_OESzmapEngine>` and
:ref:`OESzmapEngineOptions <OESzmap_OESzmapEngineOptions>`)
and hold calculated results
(:ref:`OESzmapResults <OESzmap_OESzmapResults>`).

Preparing Protein and Ligand Molecules
======================================

To perform the necessary electrostatics calculations,
a protein or any other molecular context
being analyzed with *SZMAP* must already
have all hydrogens explicitly represented as well as have charges and radii assigned 
before it can be used. This is done automatically as part of protein preparation 
with **Spruce TK** (see :oe:func:`OESpruce::OEMakeDesignUnits`).
Charges can also be assigned using **Quacpac TK** (see :oe:func:`OEProton::OEAssignCharges`).

Calculating Energies
====================

To calculate probe energies, we initialize
a :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` with a molecular
context, test if the point of interest is clashing,
and if not, calculate the energies. In the example below,
the energies at each ligand atom coordinate
are returned in a :ref:`OESzmapResults <OESzmap_OESzmapResults>`
object, which is accessed for specific values.
Alternatively, :oe:func:`OESzmap::OECalcSzmapValue` could
be used to get a single :oe:constns:`OESzmap::OEEnsemble`
value directly.

.. oe:source:: SzmapCalcs.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-GET-SZMAP-ENERGIES

.. oe:source:: SzmapCalcs.py
   :language: python
   :noindent:
   :frag:     SNIPPET-GET-SZMAP-ENERGIES

.. :oe:language:: python

    :ref:`Full listing. <listing-SzmapCalcs.py>`

..  oe:language:: python

    :ref:`Full listing. <listing-SzmapCalcs.py>`

.. oe:source:: SzmapCalcs.java
   :language: java
   :noindent:
   :frag:     SNIPPET-GET-SZMAP-ENERGIES

.. oe:source:: SzmapCalcs.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-GET-SZMAP-ENERGIES

The five :oe:constns:`OESzmap::OEEnsemble` values
in the example above are the primary ones
for understanding solvent/ligand competition.

.. seealso::

   * :ref:`GetSzmapEnergies<szmap_examples_szmapenergies>` example

Generating Probe Orientations
=============================

In addition to energy calculations, the *Szmap TK*
can be used to generate 3D conformations of probe
molecules at calculated points, annotated
with :oe:constns:`OESzmap::OEComponent`
energies for each conformation. In the example below,
individual atoms are also generated at calculation
points, each annotated with :oe:constns:`OESzmap::OEEnsemble`
values.

.. oe:source:: SzmapCalcs.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-GENERATE-SZMAP-PROBES

.. oe:source:: SzmapCalcs.py
   :language: python
   :noindent:
   :frag:     SNIPPET-GENERATE-SZMAP-PROBES

.. :oe:language:: python

    :ref:`Full listing. <listing-SzmapCalcs.py>`

.. oe:source:: SzmapCalcs.java
   :language: java
   :noindent:
   :frag:     SNIPPET-GENERATE-SZMAP-PROBES

.. oe:source:: SzmapCalcs.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-GENERATE-SZMAP-PROBES

.. _figure_orientations_and_points:

.. figure:: /_images/szmaptk-labeled-orientations.png
   :scale:  75
   :align:  center

   **High Probability Probe Orientations and Points with Generic Data Annotation**

.. seealso::

   * :ref:`SzmapBestOrientations<szmap_examples_szmapbestorientations>` example

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _chapter_water_model:

********************************************************************************
The Szmap TK Standard Water Model
********************************************************************************

A *standard SZMAP water* has "TIP" geometry:
:math:`r(OH) = 0.9572` |A| and :math:`HOH \, angle = 104.52^{\circ}`.
Point charges for hydrogen and oxygen are +0.327 and -0.654, respectively,
scaled from AM1BCC charges to reproduce the vacuum dipole of water.
And we use Bondi radii (H: 1.20 |A| and O: 1.52 |A|).
See the *Theory* section of the "OpenEye SZMAP" application manual
for more information of how these values were derived.


.. _szmap_part_examples:

********************************
Examples
********************************

.. toctree::
   :maxdepth: 2

   examples_summary


.. _szmap_chapter_examples:

*************************
Szmap TK Examples
*************************

The following table lists the currently available **Szmap TK** examples:

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`GetSzmapEnergies.py<szmap_examples_szmapenergies>`
        - Analyze binding site energies
      * - :ref:`SzmapBestOrientations.py<szmap_examples_szmapbestorientations>`
        - Generate Szmap points and probe orientations at ligand atoms

.. oe:language:: c++ java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`GetSzmapEnergies<szmap_examples_szmapenergies>`
        - Analyze binding site energies
      * - :ref:`SzmapBestOrientations<szmap_examples_szmapbestorientations>`
        - Generate Szmap points and probe orientations at ligand atoms

**Examples:**

.. toctree::
   :maxdepth: 1

   examples_szmapenergies
   examples_szmapbestorientations


.. _szmap_examples_szmapenergies:

Analyze binding site energies
================================================================================

A program that calculates energies at each ligand atom coordinate.

.. seealso::

   * :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` class
   * :ref:`OESzmapResults <OESzmap_OESzmapResults>` class
   * :oe:func:`OESzmap::OECalcSzmapValue` function
   * :oe:func:`OESzmap::OEIsClashing` function
   * :oe:constns:`OESzmap::OEEnsemble` namespace

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      SzmapEnergies --help

.. oe:language:: python

   .. code-block:: console

      prompt> python SzmapEnergies.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java SzmapEnergies --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> SzmapEnergies --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    -high_res : If true, increase the number of orientations to 360
    -l : Input ligand coordinates for calculations
    -p : Input protein (or other) context mol

Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapEnergies.cpp <../../../../sublibs/tklibs/szmap/examples/SzmapEnergies.cpp>`

   .. only:: oepdf

      .. oe:source:: SzmapEnergies.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapEnergies.py <../../../../wrappers/python/examples/szmap/SzmapEnergies.py>`

   .. :ref:`Full listing. <listing-SzmapEnergies.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/szmap/SzmapEnergies.py

   .. only:: oepdf

      .. oe:source:: SzmapEnergies.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapEnergies.java <../../../../wrappers/java/examples/openeye/examples/oeszmap/SzmapEnergies.java>`

   .. only:: oepdf

      .. oe:source:: SzmapEnergies.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapEnergies.cs <../../../../wrappers/csharp/Csharp-Examples/OESzmap/SzmapEnergies.cs>`

   .. only:: oepdf

      .. oe:source:: SzmapEnergies.cs
         :language: csharp

Examples
----------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> SzmapEnergies -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> python SzmapEnergies.py -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> java SzmapEnergies -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> SzmapEnergies -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz


.. _szmap_examples_szmapbestorientations:

Generate Szmap points and probe orientations at ligand atoms
================================================================================

A program that generates 3D conformations of probe molecules
and Szmap points at each ligand atom coordinate.

.. seealso::

   * :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` class
   * :ref:`OESzmapResults <OESzmap_OESzmapResults>` class
   * :oe:func:`OESzmap::OECalcSzmapValue` function
   * :oe:func:`OESzmap::OEIsClashing` function
   * :oe:constns:`OESzmap::OEEnsemble` namespace
   * :oe:constns:`OESzmap::OEComponent` namespace

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      SzmapBestOrientations --help

.. oe:language:: python

   .. code-block:: console

      python SzmapBestOrientations.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java SzmapBestOrientations --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> SzmapBestOrientations --help

will generate the following output:

.. code-block:: console

   Simple parameter list
    -l : Input ligand coordinates for calculations
    -o : Output file for points and probes molecules
    -p : Input protein (or other) context mol
    -prob : Cutoff for cumulative probability of probes

Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapBestOrientations.cpp <../../../../sublibs/tklibs/szmap/examples/SzmapBestOrientations.cpp>`

   .. only:: oepdf

      .. oe:source:: SzmapBestOrientations.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapBestOrientations.py <../../../../wrappers/python/examples/szmap/SzmapBestOrientations.py>`

   .. :ref:`Full listing. <listing-SzmapBestOrientations.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/szmap/SzmapBestOrientations.py

   .. only:: oepdf

      .. oe:source:: SzmapBestOrientations.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapBestOrientations.java <../../../../wrappers/java/examples/openeye/examples/oeszmap/SzmapBestOrientations.java>`

   .. only:: oepdf

      .. oe:source:: SzmapBestOrientations.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapBestOrientations.cs <../../../../wrappers/csharp/Csharp-Examples/OESzmap/SzmapBestOrientations.cs>`

   .. only:: oepdf

      .. oe:source:: SzmapBestOrientations.cs
         :language: csharp

Examples
----------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> SzmapBestOrientations -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz -o SzmapBestOrientations.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> python SzmapBestOrientations.py -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz -o SzmapBestOrientations.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> java SzmapBestOrientations -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz -o SzmapBestOrientations.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> SzmapBestOrientations -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz -o SzmapBestOrientations.oeb.gz


.. _szmap_part_api:

********************************
API
********************************

.. toctree::
   :maxdepth: 2

   OESzmapClasses/OESzmapClasses
   OESzmapConstants/OESzmapConstants
   OESzmapFunctions/index


.. _OESzmapClasses:

*******************
OESzmap Classes
*******************

.. oe:namespace:: OESzmap

.. toctree::

   OESzmapEngine
   OESzmapEngineOptions
   OESzmapResults


.. oe:namespace:: OESzmap

.. meta::
   :keywords: OESzmapEngine, SzmapEngine

.. _OESzmap_OESzmapEngine:

.. oe:class:: OESzmapEngine

   .. oe:api::

      class OESzmapEngine

   It stores the context molecule, the configuration options (including the probe molecule),
   and an ``OEZap`` object used to perform the Poisson-Boltzmann electrostatics calculations
   by :oe:func:`OESzmap::OECalcSzmapResults`, :oe:func:`OESzmap::OECalcSzmapValue`, and
   :oe:func:`OESzmap::OEIsClashing`. A :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` may cache the results
   of a calculation at a given 3D point to improve efficiency.

   .. seealso::

      * :ref:`GetSzmapEnergies<szmap_examples_szmapenergies>` example
      * :ref:`SzmapBestOrientations<szmap_examples_szmapbestorientations>` example

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzmapEngine(const OESzmapEngine& rhs)
            OESzmapEngine(const OESzmapEngineOptions& opt = OESzmapEngineOptions())
            OESzmapEngine(const OEChem::OEMolBase& context,
                          const OESzmapEngineOptions& opt = OESzmapEngineOptions())

      .. oe:language:: python

         .. oe:api:: python

            OESzmapEngine(opt: OESzmapEngineOptions = OESzmapEngineOptions()) -> OESzmapEngine
            OESzmapEngine(rhs: OESzmapEngine) -> OESzmapEngine
            OESzmapEngine(context: Union[OEGraphMol,OEMol,OEQMol],
                          opt: OESzmapEngineOptions = OESzmapEngineOptions()) -> OESzmapEngine

      Default and copy constructors, along with constructors that take
      a context molecule (typically a properly prepared protein,
      see :oe:meth:`OESzmap::OESzmapEngine::SetContext`) and/or
      a :ref:`OESzmapEngineOptions <OESzmap_OESzmapEngineOptions>` object.

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPENGINE-OBJECT

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPENGINE-OBJECT

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPENGINE-OBJECT

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPENGINE-OBJECT

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESzmapEngine &operator=(const OESzmapEngine &rhs)

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns *true* if this object is valid for use in OESzmap calculations.
      A context molecule---either at construction or through a call to
      :oe:meth:`OESzmap::OESzmapEngine::SetContext`---
      must be provided to establish validity.

   .. oe:method:: CheckAtomTypes

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CheckAtomTypes() const

      .. oe:language:: python

         .. oe:api:: python

            CheckAtomTypes() -> bool

      Returns *true* if atom types could be applied to
      the molecular context and probe molecules.

   .. oe:method:: GetContext

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase& GetContext() const

      .. oe:language:: python

         .. oe:api:: python

            GetContext() -> OEGraphMol

      Returns a reference to the molecular context for OESzmap
      calculations (see :oe:meth:`OESzmap::OESzmapEngine::SetContext`).

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GET-CONTEXT

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GET-CONTEXT

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GET-CONTEXT

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GET-CONTEXT

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESzmapEngineOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OESzmapEngineOptions

      Returns a reference to the :ref:`OESzmapEngineOptions <OESzmap_OESzmapEngineOptions>`
      used to construct this :ref:`OESzmapEngine <OESzmap_OESzmapEngine>`.
      It can be used to construct another :ref:`OESzmapEngine <OESzmap_OESzmapEngine>`
      object and to access details of the probe and other settings.

   .. oe:method:: SetContext

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetContext(const OEChem::OEMolBase& context)

      .. oe:language:: python

         .. oe:api:: python

            SetContext(context: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Updates the molecular context used for any OESzmap calculations
      based on this object
      (see :oe:meth:`OESzmap::OESzmapEngine::SetContext`
      and :oe:meth:`OESzmap::OESzmapEngine::operator bool`).
      The context molecule must have 3D coordinates assigned and partial
      charges associated with each atom. Atomic radii are also necessary,
      but will be generated if not supplied.

      Returns *true* if the context molecule is acceptable,
      with 3D coordinates and partial charges.


.. oe:namespace:: OESzmap

.. meta::
   :keywords: OESzmapEngineOptions, SzmapEngineOptions

.. _OESzmap_OESzmapEngineOptions:

.. oe:class:: OESzmapEngineOptions

   .. oe:api::

      class OESzmapEngineOptions

   An object used to set
   one or more options when constructing an :ref:`OESzmapEngine <OESzmap_OESzmapEngine>`.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-COMBINE-OPTIONS

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-COMBINE-OPTIONS

   .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-COMBINE-OPTIONS

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-COMBINE-OPTIONS

   When returned by :oe:meth:`OESzmap::OESzmapEngine::GetOptions`, can be used
   to determine the settings used for a given set of calculations.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-GET-OPTIONS

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-GET-OPTIONS

   .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-GET-OPTIONS

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-GET-OPTIONS

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzmapEngineOptions()
            OESzmapEngineOptions(const OESzmapEngineOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESzmapEngineOptions() -> OESzmapEngineOptions
            OESzmapEngineOptions(rhs: OESzmapEngineOptions) -> OESzmapEngineOptions

      Default and copy constructors. The default :ref:`OESzmapEngineOptions <OESzmap_OESzmapEngineOptions>`
      object defines the probe to be a standard *SZMAP* water with 60 orientations.

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPENGINEOPTIONS-OBJECT

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPENGINEOPTIONS-OBJECT

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPENGINEOPTIONS-OBJECT

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPENGINEOPTIONS-OBJECT

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESzmapEngineOptions &operator=(const OESzmapEngineOptions &rhs)

      Assignment operator.

   .. oe:method:: GetMaskCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMaskCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaskCutoff() -> float

      Returns the energy cutoff (in kcal/mol) defining a *clash*
      (by default, 0.0; see :oe:func:`OESzmap::OEIsClashing`
      and :oe:meth:`OESzmap::OESzmapEngineOptions::SetMaskCutoff`).
      A *clash* means
      every orientation of the probe had a combined
      :oe:const:`OESzmap::OEComponent::Interaction`
      + :oe:const:`OESzmap::OEComponent::VDW`
      energy total greater than the cutoff.

   .. oe:method:: GetProbe

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMCMolBase& GetProbe() const

      .. oe:language:: python

         .. oe:api:: python

            GetProbe() -> OEMol

      Returns a reference to the current multi-conformer probe molecule
      (see :oe:meth:`OESzmap::OESzmapEngineOptions::SetProbe`).

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GET-PROBE

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GET-PROBE

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GET-PROBE

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GET-PROBE

   .. oe:method:: GetProbeMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetProbeMol(OEChem::OEMolBase& outputMol,
                             unsigned int orientation = 0u) const

      .. oe:language:: python

         .. oe:api:: python

            GetProbeMol(outputMol: Union[OEGraphMol,OEMol,OEQMol],
                        orientation: int = 0) -> None

      Updates ``outputMol`` to contain a specific orientation of
      the current multi-conformer probe
      (see :oe:meth:`OESzmap::OESzmapEngineOptions::SetProbe`).
      By default, the first orientation is returned.

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GETPROBEMOL

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GETPROBEMOL

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GETPROBEMOL

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GETPROBEMOL

   .. oe:method:: GetProbeName

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetProbeName() const

      .. oe:language:: python

         .. oe:api:: python

            GetProbeName() -> str

      Returns the standard name of the current probe type (e.g. ``"water"``).

   .. oe:method:: NumOrientations

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumOrientations() const

      .. oe:language:: python

         .. oe:api:: python

            NumOrientations() -> int

      Returns the number of orientations for the current probe
      (see :oe:meth:`OESzmap::OESzmapEngineOptions::SetProbe`).

   .. oe:method:: SetMaskCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzmapEngineOptions& SetMaskCutoff(double cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetMaskCutoff(cutoff: float) -> OESzmapEngineOptions

      Set the energy cutoff (in kcal/mol) defining a *clash*
      (by default, 0.0; see :oe:func:`OESzmap::OEIsClashing`
      and :oe:meth:`OESzmap::OESzmapEngineOptions::GetMaskCutoff`).
      A *clash* means
      every orientation of the probe had a combined
      :oe:const:`OESzmap::OEComponent::Interaction`
      + :oe:const:`OESzmap::OEComponent::VDW`
      energy total greater than the cutoff.

   .. oe:method:: SetProbe

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzmapEngineOptions& SetProbe(unsigned int numOrientations)

      .. oe:language:: python

         .. oe:api:: python

            SetProbe(numOrientations: int) -> OESzmapEngineOptions

      Define the current multi-conformation probe molecule to be
      a standard *SZMAP* water molecule with the specified number
      of orientations (see :ref:`chapter_water_model`
      for more information on the geometry and charges used).

      If ``numOrientations`` is set to 24, 60, 216, 360, or 648
      then the set of orientations will be symmetric. Otherwise,
      it will include random orientations
      and may have lopsided gaps in coverage. For most purposes, 60 is the
      minimum required for reliable energy calculations and 360 generates
      higher-precision results, although with a speed penalty due
      to the additional *Zap* calculations.

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-SETPROBE

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-SETPROBE

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-SETPROBE

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-SETPROBE

      The default :ref:`OESzmapEngineOptions <OESzmap_OESzmapEngineOptions>`
      standard *SZMAP* water has 60 orientations.



.. oe:namespace:: OESzmap

.. meta::
   :keywords: OESzmapResults, SzmapResults

.. _OESzmap_OESzmapResults:

.. oe:class:: OESzmapResults

   .. oe:api::

      class OESzmapResults

   A container for the
   results of OESzmap calculations with the
   function :oe:func:`OESzmap::OECalcSzmapResults`.

   .. seealso::

      * :ref:`GetSzmapEnergies<szmap_examples_szmapenergies>` example
      * :ref:`SzmapBestOrientations<szmap_examples_szmapbestorientations>` example

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzmapResults()
            OESzmapResults(const OESzmapResults& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESzmapResults() -> OESzmapResults
            OESzmapResults(rhs: OESzmapResults) -> OESzmapResults

      Default and copy constructors.
      Typically an empty, default :ref:`OESzmapResults <OESzmap_OESzmapResults>`
      is passed to :oe:func:`OESzmap::OECalcSzmapResults`
      where it is filled with the calculated results.

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPRESULTS-OBJECT

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPRESULTS-OBJECT

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPRESULTS-OBJECT

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPRESULTS-OBJECT

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESzmapResults &operator=(const OESzmapResults &rhs)

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      *True* indicates that :oe:func:`OESzmap::OECalcSzmapResults` was called
      with a valid :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` when this object was created.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Resets this object to an uninitialized, empty state.

   .. oe:method:: GetComponent

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetComponent(double* compArray, unsigned int componentType) const
            OESystem::OEIterBase<double>* GetComponent(unsigned int componentType) const

      .. oe:language:: python

         .. oe:api:: python

            GetComponent(compArray: OEDoubleArray, componentType: int) -> bool
            GetComponent(componentType: int) -> Iterable[float]

      Returns the calculated values of a particular :oe:constns:`OESzmap::OEComponent`,
      specified by ``componentType``,
      for the 3D point provided to :oe:func:`OESzmap::OECalcSzmapResults`.
      *Component values* for each probe orientation are the low-level data
      used to compose :oe:constns:`OESzmap::OEEnsemble` values
      (see :oe:meth:`OESzmap::OESzmapResults::GetEnsembleValue`).
      The number of values in the output ``compArray`` or the iterator is
      :oe:meth:`OESzmap::OESzmapResults::NumOrientations` and values are returned
      in the same order as the probe orientations.

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GET-COMPONENT

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GET-COMPONENT

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GET-COMPONENT

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GET-COMPONENT

      Returns *false* or an empty iterator if the :oe:constns:`OESzmap::OEComponent`
      type is not recognized.

   .. oe:method:: GetCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCoords(float* xyz) const
            bool GetCoords(double* xyz) const

      .. oe:language:: python

         .. oe:api:: python

            GetCoords(xyz: OEFloatArray) -> bool
            GetCoords(xyz: OEDoubleArray) -> bool

      Returns the coordinates of the 3D point where calculations were performed by
      :oe:func:`OESzmap::OECalcSzmapResults` to create this object.

      The point is passed back in a float or double array of size three
      with coordinates in {x,y,z} order.

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GET-COORDS

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GET-COORDS

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GET-COORDS

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GET-COORDS

      Returns *false* if this :ref:`OESzmapResults <OESzmap_OESzmapResults>` is uninitialized.

   .. oe:method:: GetEnsembleValue

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEnsembleValue(unsigned int ensembleType) const

      .. oe:language:: python

         .. oe:api:: python

            GetEnsembleValue(ensembleType: int) -> float

      Returns the calculated value of a particular :oe:constns:`OESzmap::OEEnsemble`,
      specified by ``ensembleType``,
      for the 3D point provided to :oe:func:`OESzmap::OECalcSzmapResults`.
      *Ensemble values*  are the results of calculations
      over all orientations of the probe.
      In general, these are built by Boltzmann summation of
      various combinations of :oe:constns:`OESzmap::OEComponent` values
      (see :oe:meth:`OESzmap::OESzmapResults::GetComponent`).

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GET-ENSEMBLE-VALUE

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GET-ENSEMBLE-VALUE

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GET-ENSEMBLE-VALUE

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GET-ENSEMBLE-VALUE

      Returns 0.0 if the :oe:constns:`OESzmap::OEEnsemble`
      type is not recognized or this :ref:`OESzmapResults <OESzmap_OESzmapResults>` is uninitialized.

   .. oe:method:: GetProbabilities

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetProbabilities(double* probArray) const
            OESystem::OEIterBase<double>* GetProbabilities() const

      .. oe:language:: python

         .. oe:api:: python

            GetProbabilities(probArray: OEDoubleArray) -> bool
            GetProbabilities() -> Iterable[double]

      Returns the statistical mechanical probabilities for each probe orientation
      at the 3D point provided to :oe:func:`OESzmap::OECalcSzmapResults`.
      Probability values can be used to Boltzmann weight
      :oe:constns:`OESzmap::OEComponent` values and are used to select which
      probe orientations are returned by :oe:meth:`OESzmap::OESzmapResults::PlaceProbeSet`.
      The number of values in the output ``probArray`` or the iterator is
      :oe:meth:`OESzmap::OESzmapResults::NumOrientations` and values are returned
      in the same order as the probe orientations.

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GET-PROBABILITIES

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GET-PROBABILITIES

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GET-PROBABILITIES

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GET-PROBABILITIES

      Returns *false* or an empty iterator if this
      :ref:`OESzmapResults <OESzmap_OESzmapResults>` is uninitialized.

   .. oe:method:: GetProbabilityOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetProbabilityOrder(unsigned int* orderArray) const
            OESystem::OEIterBase<unsigned int>* GetProbabilityOrder() const

      .. oe:language:: python

         .. oe:api:: python

            GetProbabilityOrder(orderArray: int) -> bool
            GetProbabilityOrder() -> Iterable[int]

      Returns an array or iterator of indices referring to probe orientations or
      associated :oe:constns:`OESzmap::OEComponent` and probability values,
      sorted in the order of increasing probability
      (see :oe:meth:`OESzmap::OESzmapResults::GetProbabilities`).
      Hence, the first (``orderArray[0]``)
      is the index of the orientation with the greatest probability
      (``probArray[orderArray[0]]``).
      The number of values in the output ``orderArray`` or the iterator is
      :oe:meth:`OESzmap::OESzmapResults::NumOrientations`.

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GET-ORDER

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GET-ORDER

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GET-ORDER

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GET-ORDER

      Returns *false* or an empty iterator if this
      :ref:`OESzmapResults <OESzmap_OESzmapResults>` is uninitialized.

   .. oe:method:: NumOrientations

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumOrientations() const

      .. oe:language:: python

         .. oe:api:: python

            NumOrientations() -> int

      Returns the number of orientations for the probe molecule used in the calculation.
      Equals the number of values returned by calls to
      :oe:meth:`OESzmap::OESzmapResults::GetComponent`,
      :oe:meth:`OESzmap::OESzmapResults::GetProbabilities`, or
      :oe:meth:`OESzmap::OESzmapResults::GetProbabilityOrder`.

   .. oe:method:: PlaceNewAtom

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEChem::OEAtomBase* PlaceNewAtom(OEChem::OEMolBase& mol,
                                             unsigned int element = OEChem::OEElemNo::O) const

      .. oe:language:: python

         .. oe:api:: python

            PlaceNewAtom(mol: Union[OEGraphMol,OEMol,OEQMol], element: int) -> OEAtomBase

      Adds a new atom to the input molecule with atomic coordinates
      of the 3D point provided to :oe:func:`OESzmap::OECalcSzmapResults`
      when the object was created.

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-PLACE-NEW-ATOM

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-PLACE-NEW-ATOM

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-PLACE-NEW-ATOM

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-PLACE-NEW-ATOM

      The new atom has been annotated with ensemble values for this point as generic data.
      String versions of the data have been formatted to two decimal places
      for convenient display.

      =========================== ====== ============================================
      Generic Data Tag            Type   Value (energies in kcal/mol)
      =========================== ====== ============================================
      szmap_neut_diff_free_energy double Probe - neutral probe free energy difference
      --------------------------- ------ --------------------------------------------
      szmap_order                 double Fractional entropy loss from electrostatics
      --------------------------- ------ --------------------------------------------
      szmap_vdw                   double Van der Waals energy
      --------------------------- ------ --------------------------------------------
      free-energy                 string Formatted szmap_neut_diff_free_energy
      --------------------------- ------ --------------------------------------------
      order-param                 string Formatted szmap_order
      --------------------------- ------ --------------------------------------------
      vdw                         string Formatted szmap_vdw
      =========================== ====== ============================================

      The atom type can be controlled through the optional ``element`` parameter,
      which defaults to *oxygen.*

      .. _figure_new_atoms:

      .. figure:: /_images/szmaptk-colors-and-energies-on-points.png
         :scale:  75
         :align:  center

         **Atoms Placed at Calculation Points with Generic Data Annotation**

      Returns a pointer to the newly created atom to facilitate further customization.

   .. oe:method:: PlaceProbeMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool PlaceProbeMol(OEChem::OEMolBase& outputMol,
                               unsigned int orientation = 0u,
                               bool annotate = true) const

      .. oe:language:: python

         .. oe:api:: python

            PlaceProbeMol(outputMol: Union[OEGraphMol,OEMol,OEQMol],
                          orientation: int = 0, annotate: bool = True) -> bool

      Modifies the ``outputMol`` to be a copy of one probe orientation,
      placed at the 3D point provided to
      :oe:func:`OESzmap::OECalcSzmapResults` when the object was created.
      The probe orientation can be controlled through
      the optional ``orientation`` parameter (the default value of 0 refers to
      the first probe conformation).

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-PLACE-PROBE-MOL

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-PLACE-PROBE-MOL

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-PLACE-PROBE-MOL

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-PLACE-PROBE-MOL

      If the optional parameter ``annotate`` is *true* (the default),
      the molecule will be annotated with :oe:constns:`OESzmap::OEComponent`
      data for that orientation. See :oe:meth:`OESzmap::OESzmapResults::PlaceProbeSet`
      for more information on this annotation.

      Returns *false* if this :ref:`OESzmapResults <OESzmap_OESzmapResults>` is uninitialized.

   .. oe:method:: PlaceProbeSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            double PlaceProbeSet(OEChem::OEMCMolBase& probeSet,
                                 double probCutoff, bool clear = true) const
            double PlaceProbeSet(OEChem::OEMCMolBase& probeSet,
                                 unsigned int maxConfs = 0u, bool clear = true) const

      .. oe:language:: python

         .. oe:api:: python

            PlaceProbeSet(probeSet: OEMol, probCutoff: float,
                          clear: bool = True) -> float
            PlaceProbeSet(probeSet: OEMol, maxConfs: int = 0,
                          clear: bool = True) -> float

      Modifies the multi-conformer ``probeSet`` to contain one or more orientations of
      the probe, each placed at the 3D point provided
      to :oe:func:`OESzmap::OECalcSzmapResults` when the object was created.
      The probe set is returned in probability order
      (see :oe:meth:`OESzmap::OESzmapResults::GetProbabilityOrder`).

      There are three ways to select which probe orientations are placed in the ``probeSet``:

      * If just the ``probeSet`` parameter is provided, without other options,
        all probe orientations will be returned.

        .. oe:source:: SzmapCalcs.cpp
           :language: c++
           :noindent:
           :frag:     SNIPPET-PLACE-PROBE-SET-ALL

        .. oe:source:: SzmapCalcs.py
           :language: python
           :noindent:
           :frag:     SNIPPET-PLACE-PROBE-SET-ALL

        .. :oe:language:: python

            :ref:`Full listing. <listing-SzmapCalcs.py>`

        .. oe:source:: SzmapCalcs.java
           :language: java
           :noindent:
           :frag:     SNIPPET-PLACE-PROBE-SET-ALL

        .. oe:source:: SzmapCalcs.cs
           :language: csharp
           :noindent:
           :frag:     SNIPPET-PLACE-PROBE-SET-ALL

      * If the real number parameter ``probCutoff`` is used,
        probe orientations will be added until
        the total cumulative probability is at least that amount.
        Cumulative probabilities are > 0.0 and <= 1.0.

        .. oe:source:: SzmapCalcs.cpp
           :language: c++
           :noindent:
           :frag:     SNIPPET-PLACE-PROBE-SET-PROB

        .. oe:source:: SzmapCalcs.py
           :language: python
           :noindent:
           :frag:     SNIPPET-PLACE-PROBE-SET-PROB

        .. :oe:language:: python

            :ref:`Full listing. <listing-SzmapCalcs.py>`

        .. oe:source:: SzmapCalcs.java
           :language: java
           :noindent:
           :frag:     SNIPPET-PLACE-PROBE-SET-PROB

        .. oe:source:: SzmapCalcs.cs
           :language: csharp
           :noindent:
           :frag:     SNIPPET-PLACE-PROBE-SET-PROB

      * Finally, if the integer parameter ``maxConfs`` is used,
        no more than number of probe orientations will be returned. A value of
        ``0`` is a special signal to return all orientations.

        .. oe:source:: SzmapCalcs.cpp
           :language: c++
           :noindent:
           :frag:     SNIPPET-PLACE-PROBE-SET-COUNT

        .. oe:source:: SzmapCalcs.py
           :language: python
           :noindent:
           :frag:     SNIPPET-PLACE-PROBE-SET-COUNT

        .. :oe:language:: python

            :ref:`Full listing. <listing-SzmapCalcs.py>`

        .. oe:source:: SzmapCalcs.java
           :language: java
           :noindent:
           :frag:     SNIPPET-PLACE-PROBE-SET-COUNT

        .. oe:source:: SzmapCalcs.cs
           :language: csharp
           :noindent:
           :frag:     SNIPPET-PLACE-PROBE-SET-COUNT

      If the optional parameter ``clear`` is set to *false*, any previous orientations
      in the ``probeSet`` will not be cleared, allowing conformers for multiple 3D points
      as well as multiple orientations to be stored in the ``probeSet``. By default, previous
      orientations *are* cleared away before the new orientations are added.

      Each orientation has been annotated with :oe:constns:`OESzmap::OEComponent`
      data for that orientation.
      In addition, the total *interaction + psolv + wsolv + vdw* energy of each
      is recorded as the energy of the conformation
      (accessible using the ``GetEnergy()`` method of the conformer).
      String versions of the data
      have been formatted to two decimal places for convenient display.
      String data is also
      stored as SD data, so they are included in *VIDA's* spreadsheet
      and can be saved to ``.sd`` files.

      =================== ====== ====== ============================================
      Generic/SD Data Tag Type   SD     Value (energies in kcal/mol)
      =================== ====== ====== ============================================
      szmap_interaction   double *no*   Poisson-Boltzmann probe|context interaction
      ------------------- ------ ------ --------------------------------------------
      szmap_psolv         double *no*   (Protein) context desolvation penalty
      ------------------- ------ ------ --------------------------------------------
      szmap_wsolv         double *no*   (Water) probe desolvation penalty
      ------------------- ------ ------ --------------------------------------------
      szmap_vdw           double *no*   Van der Waals energy
      ------------------- ------ ------ --------------------------------------------
      szmap_probability   double *no*   Boltzmann probability
      ------------------- ------ ------ --------------------------------------------
      total-energy        string *yes*  szmap_interaction + psolv + wsolv + vdw
      ------------------- ------ ------ --------------------------------------------
      interaction         string *yes*  Formatted szmap_interaction
      ------------------- ------ ------ --------------------------------------------
      psolv               string *yes*  Formatted szmap_psolv
      ------------------- ------ ------ --------------------------------------------
      wsolv               string *yes*  Formatted szmap_wsolv
      ------------------- ------ ------ --------------------------------------------
      vdw                 string *yes*  Formatted szmap_vdw
      ------------------- ------ ------ --------------------------------------------
      prob                string *yes*  Formatted szmap_probability
      =================== ====== ====== ============================================

      Returns the cumulative probability of all the orientations returned,
      or 0.0 if this :ref:`OESzmapResults <OESzmap_OESzmapResults>` is uninitialized.

      .. _figure_spreadsheet:

      .. figure:: /_images/szmaptk-spreadsheet-selection.png
         :scale:  75
         :align:  center

         **SD Annotation in the VIDA Spreadsheet**



.. _OESzmapConstants:

*******************
OESzmap Constants
*******************

.. oe:namespace:: OESzmap

.. toctree::

   OEComponent
   OEEnsemble


.. oe:namespace:: OESzmap

.. oe:constnamespace:: OEComponent

   The :oe:constns:`OESzmap::OEComponent` namespace encodes symbolic constants
   representing various types of OESzmap calculation *component values*
   (the results of calculations on individual orientations of the probe).
   These components are used to determine :oe:constns:`OESzmap::OEEnsemble` values.

   .. seealso::

      * :ref:`SzmapBestOrientations<szmap_examples_szmapbestorientations>` example

   .. oe:constant:: Interaction

   Poisson-Boltzmann electrostatic probe|context interaction energy (kcal/mol).

   .. oe:constant:: PSolv

   (Protein) context desolvation penalty (kcal/mol).

   .. oe:constant:: WSolv

   (Water) probe desolvation penalty (kcal/mol).

   .. oe:constant:: VDW

   Van der Waals energy (kcal/mol, MMFF94).

   .. oe:constant:: ProbeBurial

   Fractional probe burial. Value ranges from 0.0 (exposed) to 1.0 (completely buried).

   .. oe:constant:: NumTypes

   Number of :oe:constns:`OESzmap::OEComponent` types.



.. oe:namespace:: OESzmap

.. oe:constnamespace:: OEEnsemble

   The :oe:constns:`OESzmap::OEEnsemble` namespace encodes symbolic constants
   representing various types of OESzmap calculation *ensemble values*
   (the results of calculations over all orientations of the probe).
   In general, these are built by Boltzmann summation of
   :oe:constns:`OESzmap::OEComponent` values.

   .. seealso::

      * :ref:`GetSzmapEnergies<szmap_examples_szmapenergies>` example
      * :ref:`SzmapBestOrientations<szmap_examples_szmapbestorientations>` example

   .. oe:constant:: Interaction

   Poisson-Boltzmann electrostatic probe|context interaction energy (kcal/mol).

   .. oe:constant:: PSolv

   (Protein) context desolvation penalty (kcal/mol).

   .. oe:constant:: WSolv

   (Water) probe desolvation penalty (kcal/mol).

   .. oe:constant:: VDW

   Van der Waals energy (kcal/mol, MMFF94).

   .. oe:constant:: ProbeBurial

   Fractional probe burial.
   Value ranges from 0.0 (exposed) to 1.0 (completely buried).

   .. oe:constant:: InteractionPlusVDW

   Minimum value of the sum of the interaction energy
   and the van der Waals energy (kcal/mol). This value is used to
   determine if a point is clashing.

   .. oe:constant:: OrderParam

   Fractional entropy loss from electrostatics.
   Value ranges from 0.0 (unconstrained, all orientations equivalent)
   to 1.0 (completely fixed, single orientation dominates).

   .. oe:constant:: CalcPoint

   Calculations performed: 1.0; no calculation: 0.0.

   .. oe:constant:: Mask

   Clash: 0.0; not a clash: 1.0.

   .. oe:constant:: NeutralDiffDeltaH

   Charged probe - neutral probe enthalpy difference (kcal/mol).

   .. oe:constant:: NeutralDiffTDeltaS

   Charged probe - neutral probe entropy difference (kcal/mol).

   .. oe:constant:: NeutralDiffDeltaG

   Charged probe - neutral probe free energy difference (kcal/mol).

   .. oe:constant:: NeutralDeltaH

   Enthalpy of neutral probe vs continuum (kcal/mol).

   .. oe:constant:: NeutralTDeltaS

   Entropy of neutral probe vs continuum (kcal/mol).

   .. oe:constant:: NeutralDeltaG

   Free energy of neutral probe vs continuum (kcal/mol).

   .. oe:constant:: VacuumDiffDeltaH

   Probe - vacuum probe enthalpy difference (kcal/mol).

   .. oe:constant:: VacuumDiffDeltaG

   Probe - vacuum probe free energy difference (kcal/mol).

   .. oe:constant:: DeltaH

   Enthalpy of probe vs continuum (kcal/mol).

   .. oe:constant:: TDeltaS

   Entropy of probe vs continuum (kcal/mol).

   .. oe:constant:: DeltaG

   Free energy of probe vs continuum (kcal/mol).

   .. oe:constant:: NumTypes

   Number of :oe:constns:`OESzmap::OEEnsemble` types.

   .. oe:constant:: Default

   Default type. Same as :oe:const:`OESzmap::OEEnsemble::NeutralDiffDeltaG`.



*******************************************************************************
OESzmap Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OECalcSzmapResults.rst
   OECalcSzmapValue.rst
   OEGetComponentName.rst
   OEGetEnsembleName.rst
   OEIsClashing.rst
   OESzmapGetArch.rst
   OESzmapGetLicensee.rst
   OESzmapGetPlatform.rst
   OESzmapGetRelease.rst
   OESzmapGetSite.rst
   OESzmapGetVersion.rst
   OESzmapIsLicensed.rst


.. oe:namespace:: OESzmap

.. meta::
   :keywords: OECalcSzmapResults

.. oe:function:: OECalcSzmapResults

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECalcSzmapResults(OESzmap::OESzmapResults& results,
                                 OESzmap::OESzmapEngine& szmap,
                                 const float* xyz)
         bool OECalcSzmapResults(OESzmap::OESzmapResults& results,
                                 OESzmap::OESzmapEngine& szmap,
                                 const double* xyz)

   .. oe:language:: python

      .. oe:api:: python

         OECalcSzmapResults(results: OESzmapResults, szmap: OESzmapEngine,
                            xyz: OEFloatArray) -> bool
         OECalcSzmapResults(results: OESzmapResults, szmap: OESzmapEngine,
                            xyz: OEDoubleArray) -> bool

   Update a :ref:`OESzmapResults <OESzmap_OESzmapResults>` object by performing *SZMAP* calculations
   at the specified 3D point, using the :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` provided. The
   :ref:`OESzmapResults <OESzmap_OESzmapResults>` provides access to all of the
   :oe:constns:`OESzmap::OEEnsemble`
   and :oe:constns:`OESzmap::OEComponent` values as well as orientation probabilities
   and geometry.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-CLASH-RSLTS-EVAL

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-CLASH-RSLTS-EVAL

   .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-CLASH-RSLTS-EVAL

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-CLASH-RSLTS-EVAL

   Returns *false* if calculations were not performed because
   the :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` was not initialized.

   The 3D point is a float or double array of size three with coordinates in {x,y,z} order.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-CREATE-COORDSARRAY-OBJECT

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-CREATE-COORDSARRAY-OBJECT

   .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-CREATE-COORDSARRAY-OBJECT

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-CREATE-COORDSARRAY-OBJECT



.. oe:namespace:: OESzmap

.. meta::
   :keywords: OECalcSzmapValue

.. oe:function:: OECalcSzmapValue

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OECalcSzmapValue(OESzmap::OESzmapEngine& szmap,
                                 const float* xyz,
                                 unsigned int ensembleType = OESzmap::OEEnsemble::Default)
         double OECalcSzmapValue(OESzmap::OESzmapEngine& szmap,
                                 const double* xyz,
                                 unsigned int ensembleType = OESzmap::OEEnsemble::Default)

   .. oe:language:: python

      .. oe:api:: python

         OECalcSzmapValue(szmap: OESzmapEngine, xyz: OEFloatArray,
                          ensembleType: int = OEEnsemble_Default) -> float
         OECalcSzmapValue(szmap: OESzmapEngine, xyz: OEDoubleArray,
                          ensembleType: int = OEEnsemble_Default) -> float

   Returns one of the :oe:constns:`OESzmap::OEEnsemble` values at the specified 3D point,
   using the :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` provided. See
   :oe:const:`OESzmap::OEEnsemble::Default`
   for a description of the default energy value.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-VALUE

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-VALUE

   .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-VALUE

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-VALUE

   The 3D point is a float or double array of size three with coordinates in {x,y,z} order.

   .. seealso::

      * :ref:`GetSzmapEnergies<szmap_examples_szmapenergies>` example
      * :ref:`SzmapBestOrientations<szmap_examples_szmapbestorientations>` example


.. oe:namespace:: OESzmap

.. meta::
   :keywords: OEGetComponentName

.. oe:function:: OEGetComponentName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetComponentName(unsigned int componentType)

   .. oe:language:: python

      .. oe:api:: python

         OEGetComponentName(componentType: int) -> str

   Returns a character string of the standard name for the specified
   :oe:constns:`OESzmap::OEComponent` type.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-GET-COMPONENT-NAME

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-GET-COMPONENT-NAME

   .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-GET-COMPONENT-NAME

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-GET-COMPONENT-NAME



.. oe:namespace:: OESzmap

.. meta::
   :keywords: OEGetEnsembleName

.. oe:function:: OEGetEnsembleName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetEnsembleName(unsigned int ensembleType,
                                       bool longName = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetEnsembleName(ensembleType: int, longName: bool = False) -> str

   Returns a character string of the standard name for the specified
   :oe:constns:`OESzmap::OEEnsemble` type.

   By default, a short form of the name, suitable for column headings, is provided.
   If the optional ``longName`` argument is set to *true*, a more readable
   name is provided.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-GET-LONG-ENSEMBLE-NAME

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-GET-LONG-ENSEMBLE-NAME

   .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-GET-LONG-ENSEMBLE-NAME

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-GET-LONG-ENSEMBLE-NAME



.. oe:namespace:: OESzmap

.. meta::
   :keywords: OEIsClashing

.. oe:function:: OEIsClashing

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsClashing(OESzmap::OESzmapEngine& szmap, const float* xyz)
         bool OEIsClashing(OESzmap::OESzmapEngine& szmap, const double* xyz)

   .. oe:language:: python

      .. oe:api:: python

         OEIsClashing(szmap: OESzmapEngine, xyz: OEFloatArray) -> bool
         OEIsClashing(szmap: OESzmapEngine, xyz: OEDoubleArray) -> bool

   Determines whether the probe associated with the :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` provided
   *clashes* with the context molecule at the specified 3D point. A *clash* means
   every orientation of the probe had a combined
   :oe:const:`OESzmap::OEComponent::Interaction` + :oe:const:`OESzmap::OEComponent::VDW`
   energy total greater than the cutoff defined in the
   :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` at the specified point.
   See :oe:meth:`OESzmap::OESzmapEngineOptions::GetMaskCutoff` and
   :oe:meth:`OESzmap::OESzmapEngineOptions::SetMaskCutoff`.

   The 3D point is a float or double array of size three with coordinates in {x,y,z} order.

   It is recommended you call this function before calling
   :oe:func:`OESzmap::OECalcSzmapValue` or :oe:func:`OESzmap::OECalcSzmapResults`,
   as data for clashing points is generally meaningless.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-RESULTS

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-RESULTS

   .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-RESULTS

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-RESULTS

   .. seealso::

      * :ref:`GetSzmapEnergies<szmap_examples_szmapenergies>` example
      * :ref:`SzmapBestOrientations<szmap_examples_szmapbestorientations>` example



.. oe:namespace:: OESzmap

.. meta::
   :keywords: OESzmapGetArch

.. oe:function:: OESzmapGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESzmapGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OESzmapGetArch() -> str

   Returns a character string describing the operating system
   and hardware.



.. oe:namespace:: OESzmap

.. meta::
   :keywords: OESzmapGetLicensee

.. oe:function:: OESzmapGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OESzmapGetLicensee()
         bool OESzmapGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OESzmapGetLicensee() -> str
         OESzmapGetLicensee(licensee: str) -> bool

   Returns the name of the licensee from the active user license.



.. oe:namespace:: OESzmap

.. meta::
   :keywords: OESzmapGetPlatform

.. oe:function:: OESzmapGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESzmapGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OESzmapGetPlatform() -> str

   Returns a character string describing the
   operating system, hardware and the compiler
   used to build this version of OESzmap.



.. oe:namespace:: OESzmap

.. meta::
   :keywords: OESzmapGetRelease

.. oe:function:: OESzmapGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESzmapGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OESzmapGetRelease() -> str

   Returns the release number string for this
   version of OESzmap.



.. oe:namespace:: OESzmap

.. meta::
   :keywords: OESzmapGetSite

.. oe:function:: OESzmapGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OESzmapGetSite()
         bool OESzmapGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OESzmapGetSite() -> str
         OESzmapGetSite(site: str) -> bool

   Returns the name of the site from the active user license.



.. oe:namespace:: OESzmap

.. meta::
   :keywords: OESzmapGetVersion

.. oe:function:: OESzmapGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OESzmapGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OESzmapGetVersion() -> int

   Returns the release date of this version of OESzmap
   as an integer in YYYYMMDD format.



.. meta::
   :keywords: OESzmapIsLicensed

.. oe:namespace:: OESzmap

.. oe:function:: OESzmapIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESzmapIsLicensed(const char* feature = 0,
                                unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OESzmapIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **Szmap TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **Szmap TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **Szmap TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function



.. _szmap_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version1_7_4
   version1_7_3
   version1_7_2
   version1_7_1
   version1_7_0
   version1_6_7
   version1_6_6
   version1_6_5
   version1_6_4
   version1_6_3
   version1_6_2
   version1_6_1
   version1_6_0
   version1_4_6
   version1_4_5
   version1_4_4
   version1_4_3
   version1_4_2
   version1_4_1
   version1_4_0
   version1_3_7
   version1_3_6
   version1_3_5
   version1_3_4
   version1_3_3
   version1_3_2
   version1_3_1
   version1_3_0



Szmap TK 1.7.4
================================================================================

Minor internal improvements have been made.



Szmap TK 1.3.0
================================================================================

- First release of *Szmap* toolkit.

Features
------------

* Calculates solvent energies and probabilities at arbitrary points in space.

* Provides access to probe geometry for output and display.


Szmap TK 1.3.1
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* Fixed a critical problem that was causing crashes when duplicating
  :ref:`OESzmapResults <OESzmap_OESzmapResults>` objects using the
  copy constructor or assignment operator.

* Molecules returned from :oe:meth:`OESzmap::OESzmapEngineOptions::GetProbe`,
  :oe:meth:`OESzmap::OESzmapEngineOptions::GetProbeMol`
  :oe:meth:`OESzmap::OESzmapResults::PlaceProbeSet`,
  :oe:meth:`OESzmap::OESzmapResults::PlaceProbeMol`,
  and :oe:meth:`OESzmap::OESzmapResults::PlaceNewAtom`, 
  are now all explicitly marked as three-dimensional.
  This allows the coordinates to be written properly in ``.sdf`` format.

Documentation fixes
--------------------------------------------------------------------------------

* Fixed minor typos in the examples.


Szmap TK 1.3.2
================================================================================

* Minor internal improvements

.. oe:language:: c++

   * The C++ **Szmap TK** library, ``oeszmap``, now links against the
     ``oeieff`` library. Please update build scripts accordingly to
     account for the new dependency.



Szmap TK 1.3.3
================================================================================

* Minor internal cleanup has been performed.



Szmap TK 1.3.4
================================================================================

Minor internal improvements have been made.


Szmap TK 1.3.5
================================================================================

* Minor internal improvements have been made.


Szmap TK 1.3.6
================================================================================

* Minor internal improvements have been made.


Szmap TK 1.3.7
================================================================================

* Minor internal improvements have been made.


Szmap TK 1.4.0
================================================================================

* Minor internal improvements have been made.


Szmap TK 1.4.1
================================================================================

* Minor internal improvements have been made.


Szmap TK 1.4.2
================================================================================

* Minor internal improvements have been made.


Szmap TK 1.4.3
================================================================================

* Minor internal improvements have been made.


Szmap TK 1.4.4
================================================================================

* Minor internal improvements have been made.


Szmap TK 1.4.5
================================================================================

* Minor internal improvements have been made.


Szmap TK 1.4.6
================================================================================

* Minor internal improvements have been made.




Szmap TK 1.6.0
================================================================================

As part of the integration of **OEToolkits** and **OEApplications** into a single
release, the version number of **Szmap TK** has been upgraded to 1.6.0 to make
it consistent with that of the **SZMAP** application.




Szmap TK 1.6.1
================================================================================

*Fall 2020*

* Minor internal improvements have been made.




Szmap TK 1.6.2
================================================================================

*July 2021*

Minor internal improvements have been made.




Szmap TK 1.6.3
================================================================================

*Fall 2021*

* Minor internal improvements have been made.





Szmap TK 1.6.4
================================================================================

* Minor internal improvements have been made.


==================
Szmap TK 1.6.5
==================

Minor internal improvements have been made.





Szmap TK 1.6.6
================================================================================

Minor internal improvements have been made.



Szmap TK 1.6.7
================================================================================

Minor internal improvements have been made.





Szmap TK 1.7.0
================================================================================

Documentation changes
--------------------------------------------------------------------------------

* Examples have been updated to use design units as inputs.





Szmap TK 1.7.1
================================================================================

Minor internal improvements have been made.



Szmap TK 1.7.2
================================================================================

Minor internal improvements have been made.




Szmap TK 1.7.3
================================================================================

Minor internal improvements have been made.


.. szybkitk toolkit documentation master file

###############################
Szybki Toolkit |szybki_version|
###############################

..  oe:language:: python

    .. toctree::
       :maxdepth: 3

       introduction
       theory/theory
       api
       examples
       selected_examples_python
       releasenotes/index

..  oe:language:: c++ csharp java

    .. toctree::
       :maxdepth: 3

       introduction
       theory/theory
       api
       examples
       releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _szybki_chapter_intro:

********************************************************************************
Introduction
********************************************************************************

The *Szybki Toolkit* library provides a facility for force field based
optimization and thermodynamic property estimations of small molecule ligands or
protein-ligand complexes with small molecule ligands.

The following basic functionalities are available:

* Entropy Evaluation (see :ref:`section_entropy` chapter)
* Conformer free Energies ( see :ref:`section_conformerDG` chapter)
* Solvation free Energies (see :ref:`section_solvationFe` chapter)

.. note::

 Units of energy in various **Szybki TK** outputs are in kcal/mol.

The aim of this manual is to familiarize the user with the *Szybki Toolkit*
functionalities, however, it does not provide explanations
of basic *OEChem* classes and functions. Therefore reading the
*OEChem* manual beforehand is highly recommended.

.. oe:language:: c++

   .. seealso::

      * :ref:`C++ Quick Start Manual <section_cpp_getting_started>` for
        installation instructions.
      * :ref:`Importing C++ Toolkits <section_cpp_tk_import>` section

.. oe:language:: python

   .. seealso::

      * :ref:`Python Quick Start Manual <section_python_getting_started>` for
        installation instructions.
      * :ref:`Importing Python Toolkits <section_python_tk_import>` section

.. oe:language:: java

   .. seealso::

      * :ref:`Java Quick Start Manual <section_java_getting_started>` for
        installation instructions.
      * :ref:`Importing Java Toolkits <section_java_tk_import>` section

.. oe:language:: csharp

   .. seealso::

      * :ref:`C# Quick Start Manual <section_csharp_getting_started>` for
        installation instructions.
      * :ref:`Importing C# Toolkits <section_csharp_tk_import` section


.. oe:namespace:: OESz

.. meta::
   :keywords: OEBoundEntropyOptions, BoundEntropyOptions

.. _OESz_OEBoundEntropyOptions:

.. oe:class:: OEBoundEntropyOptions: public OELigandChargeOptions

   .. oe:api::

      class OEBoundEntropyOptions : public OESystem::OEOptions

   Configuration options for :oe:func:`OESz::OEBoundLigandEntropy`
   bound-ligand entropy calculations.

   .. seealso::

      * :ref:`OEEntropyResults <OESz_OEEntropyResults>` class
      * :oe:func:`OESz::OEBoundLigandEntropy` function

   The following methods are publicly inherited from :ref:`OELigandChargeOptions <OESz_OELigandChargeOptions>`:
    * :oe:meth:`GetGenerateElfConfs<OESz::OELigandChargeOptions::GetGenerateElfConfs>` and
      :oe:meth:`SetGenerateElfConfs<OESz::OELigandChargeOptions::SetGenerateElfConfs>`
    * :oe:meth:`GetLigandCharge<OESz::OELigandChargeOptions::GetLigandCharge>`,
      :oe:meth:`GetLigandChargeType<OESz::OELigandChargeOptions::GetLigandChargeType>`, and
      :oe:meth:`SetLigandCharge<OESz::OELigandChargeOptions::SetLigandCharge>`

   The :ref:`OEBoundEntropyOptions <OESz_OEBoundEntropyOptions>` class defines the following public methods:
    * :ref:`GetForceField<OESz_OEBoundEntropyOptions_GetForceField>`,
      :ref:`GetForceFieldType<OESz_OEBoundEntropyOptions_GetForceFieldType>` and
      :ref:`SetForceField<OESz_OEBoundEntropyOptions_SetForceField>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBoundEntropyOptions()
            OEBoundEntropyOptions(const OEBoundEntropyOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEBoundEntropyOptions() -> OEBoundEntropyOptions
            OEBoundEntropyOptions(arg2: OEBoundEntropyOptions) -> OEBoundEntropyOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBoundEntropyOptions &operator=(const OEBoundEntropyOptions &)

      Assignment operator.

   .. _OESz_OEBoundEntropyOptions_GetForceField:

   .. oe:method:: GetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFF::OEComplexFF* GetForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEComplexFF

      See :oe:meth:`SetForceField<OESz::OEProteinLigandOptOptions::SetForceField>` method.

   .. _OESz_OEBoundEntropyOptions_GetForceFieldType:

   .. oe:method:: GetForceFieldType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceFieldType() -> int

      See :oe:meth:`SetForceField<OESz::OEProteinLigandOptOptions::SetForceField>` method.

   .. _OESz_OEBoundEntropyOptions_SetForceField:
   
   .. oe:method:: SetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceField(const unsigned)
            bool SetForceField(const std::string&)
            bool SetForceField(const OEFF::OEComplexFF&)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: int) -> bool
            SetForceField(value: str) -> bool
            SetForceField(value: oeistream) -> bool
            SetForceField(value: OEComplexFF) -> bool

      Sets the **force field** for optimization.  The first overload takes an `unsigned` 
      from the :oe:constns:`OESz::OEComplexFFType` namespace, and the second overload
      takes corresponding string values. The final overload allows the use of a user-defined
      :ref:`OEComplexFF <OEFF_OEComplexFF>`. Method returns ``false`` when the invalid selection
      is chosen, ``true`` otherwise.
      **Default:** :oe:const:`OESz::OEComplexFFType::FF14SB_SAGE`


.. oe:namespace:: OESz

.. meta::
   :keywords: OEEntropyResults, EntropyResults

.. _OESz_OEEntropyResults:

.. oe:class:: OEEntropyResults

   .. oe:api::

      class OEEntropyResults

   Container for entropy estimation results returned by
   :oe:func:`OESz::OELigandEntropy` and :oe:func:`OESz::OEBoundLigandEntropy`.

   .. seealso::

      * :ref:`OEBoundEntropyOptions <OESz_OEBoundEntropyOptions>` class
      * :ref:`OELigandEntropyOptions <OESz_OELigandEntropyOptions>` class 
      * :oe:func:`OESz::OEBoundLigandEntropy` function
      * :oe:func:`OESz::OELigandEntropy` function
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEntropyResults()
            OEEntropyResults(const OEEntropyResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEEntropyResults() -> OEEntropyResults
            OEEntropyResults(arg2: OEEntropyResults) -> OEEntropyResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEEntropyResults& operator=(const OEEntropyResults&)

      Assignment operator.

   .. oe:method:: GetTotalEntropy in J/(mol K).
    
      .. oe:api::

         double GetTotalEntropy() const

      Returns the value of total ligand entropy. 

   .. oe:method:: GetConfigurationalEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetConfigurationalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfigurationalEntropy() -> float

      Returns the value of configurational entropy in J/(mol K).

   .. oe:method:: GetTranslationalEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTranslationalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetTranslationalEntropy() -> float

      Returns the value of translational entropy in J/(mol K).

   .. oe:method:: GetVibrationalRotationalEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetVibrationalRotationalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetVibrationalRotationalEntropy() -> float

      Returns a sum of vibrational and rotational entropy in J/(mol K).

   .. oe:method:: GetSolvationEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSolvationEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolvationEntropy() -> float

      Returns the value of solvation entropy in J/(mol K).

   .. oe:method:: SetResults

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetResults(const double data[], unsigned int nterms = 4)

      .. oe:language:: python

         .. oe:api:: python

            SetResults([]: float, nterms: int = 4) -> None

      Allows to set the `OEEntropyResults <OESz_OEEntropyResults>` object with numeric
      values of entropy components by passing a pointer to the array of doubles in the
      following order: data[0]: total entropy, data[1] = translational entropy,
      data[2] = rotvib entropy and data[3]: solvation entropy
      


.. oe:namespace:: OESz

.. meta::
   :keywords: OEFixedProteinLigandOptimizer, FixedProteinLigandOptimizer

.. _OESz_OEFixedProteinLigandOptimizer:

.. oe:class:: OEFixedProteinLigandOptimizer

   .. oe:api::

      class OEFixedProteinLigandOptimizer

   This class provides an interface to optimize a ligand in a protein active site, where the
   protein is kept fixed during the optimization. The protein active site can be defined
   either by using a :ref:`OEDesignUnit <OEBio_OEDesignUnit>` or by simple passing in a protein
   molecule.

   The :ref:`OEFixedProteinLigandOptimizer <OESz_OEFixedProteinLigandOptimizer>` class defines the following public methods:
    * :oe:meth:`Energy<OESz::OEFixedProteinLigandOptimizer::Energy>`
    * :oe:meth:`Optimize<OESz::OEFixedProteinLigandOptimizer::Optimize>`
    * :oe:meth:`SetProtein<OESz::OEFixedProteinLigandOptimizer::SetProtein>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFixedProteinLigandOptimizer(const OEProteinLigandOptOptions& opts = OEProteinLigandOptOptions())
            OEFixedProteinLigandOptimizer(const OEFixedProteinLigandOptimizer &)

      .. oe:language:: python

         .. oe:api:: python

            OEFixedProteinLigandOptimizer(opts: OEProteinLigandOptOptions = OEProteinLigandOptOptions()) -> OEFixedProteinLigandOptimizer
            OEFixedProteinLigandOptimizer(arg2: OEFixedProteinLigandOptimizer) -> OEFixedProteinLigandOptimizer

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFixedProteinLigandOptimizer &operator=(const OEFixedProteinLigandOptimizer &)

.. _OESz_OEFixedProteinLigandOptimizer_Energy:

      Assignment operator.

   .. oe:method:: Energy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEFF::OEComplexEnergies>* Energy(const OEChem::OEMCMolBase& ligand) const
            unsigned Energy(OEFF::OEComplexEnergies& res,
                            const OEChem::OEMolBase& ligand) const

      .. oe:language:: python

         .. oe:api:: python

            Energy(mol: OEMol) -> Iterable[OEComplexEnergies]
            Energy(res: OEComplexEnergies, mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Calculate the single point energy of the ligand interacting with the protein.  The intra-molecular protein
      energy components are ignored by this method.  The second overload returns a value from
      the :oe:constns:`OESz::OESzybkiReturnCode` namespace reporting the success or failure of the 
      calculation.

.. _OESz_OEFixedProteinLigandOptimizer_Optimize:

   .. oe:method:: Optimize

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESz::OEProteinLigandOptResults>* Optimize(OEChem::OEMCMolBase& ligand) const
            unsigned Optimize(OESz::OEProteinLigandOptResults& res,
                              OEChem::OEMolBase& ligand) const

      .. oe:language:: python

         .. oe:api:: python

            Optimize(mol: OEMol) -> Iterable[OEProteinLigandOptResults]
            Optimize(res: OEProteinLigandOptResults,
                     mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Optimize the ligand in the protein active site.  The intra-molecular protein
      energy components are ignored by this method.  The second overload returns a value from
      the :oe:constns:`OESz::OESzybkiReturnCode` namespace reporting the success or failure of the 
      optimization.  The return code for each conformer in the first overload can be obtained
      from the corresponding results object.

.. _OESz_OEFixedProteinLigandOptimizer_SetProtein:

   .. oe:method:: SetProtein

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned SetProtein(const OEBio::OEDesignUnit& du,
                                const unsigned proteinMask,
                                const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& proteinPred = OEChem::OEIsTrueAtom())
            unsigned SetProtein(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            SetProtein(du: OEDesignUnit, proteinMask: int,
                       proteinPred: OEUnaryAtomPred = OEIsTrueAtom()) -> int
            SetProtein(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Set the protein molecule for the calculation.  In the first two overload, the ``proteinMask``
      define the portion of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` that should be used as the target
      protein active site. An optional ``proteinPred`` can be also provided along with the mask,
      to define additional residue components to be part of the target. Method returns a value from
      the :oe:constns:`OESz::OESzybkiReturnCode` namespace reporting the success or failure.


.. oe:namespace:: OESz

.. meta::
   :keywords: OEFlexProteinLigandOptimizer, FlexProteinLigandOptimizer

.. _OESz_OEFlexProteinLigandOptimizer:

.. oe:class:: OEFlexProteinLigandOptimizer

   .. oe:api::

      class OEFlexProteinLigandOptimizer

   This class provides an interface to optimize a ligand in a protein active site, where the
   protein can be treated a partially flexible. The protein active site can be defined
   either by using a :ref:`OEDesignUnit <OEBio_OEDesignUnit>` or by simple passing in a protein
   molecule.

   The :ref:`OEFlexProteinLigandOptimizer <OESz_OEFlexProteinLigandOptimizer>` class defines the following public methods:
    * :oe:meth:`Energy<OESz::OEFlexProteinLigandOptimizer::Energy>`
    * :oe:meth:`Optimize<OESz::OEFlexProteinLigandOptimizer::Optimize>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFlexProteinLigandOptimizer(const OEProteinLigandOptOptions& opts = OEProteinLigandOptOptions())
            OEFlexProteinLigandOptimizer(const OEFlexProteinLigandOptimizer &)

      .. oe:language:: python

         .. oe:api:: python

            OEFlexProteinLigandOptimizer(opts: OEProteinLigandOptOptions = OEProteinLigandOptOptions()) -> OEFlexProteinLigandOptimizer
            OEFlexProteinLigandOptimizer(arg2: OEFlexProteinLigandOptimizer) -> OEFlexProteinLigandOptimizer

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFlexProteinLigandOptimizer &operator=(const OEFlexProteinLigandOptimizer &)

.. _OESz_OEFlexProteinLigandOptimizer_Energy:

      Assignment operator.

   .. oe:method:: Energy

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Energy(OEFF::OEComplexEnergies& res,
                            const OEBio::OEDesignUnit& du,
                            const unsigned proteinMask,
                            const unsigned ligandMask,
                            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& protFlexPred,
                            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& proteinPred = OEChem::OEIsTrueAtom()) const
            unsigned Energy(OEFF::OEComplexEnergies& res,
                            const OEBio::OEDesignUnit& du,
                            const unsigned proteinMask,
                            const unsigned ligandMask,
                            const OEProteinFlexOptions& flexOpts,
                            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& proteinPred = OEChem::OEIsTrueAtom()) const
            unsigned Energy(OEFF::OEComplexEnergies& res,
                            const OEChem::OEMolBase& protein,
                            const OEChem::OEMolBase& ligand,
                            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& protFlexPred) const
            unsigned Energy(OEFF::OEComplexEnergies& res,
                            const OEChem::OEMolBase& protein,
                            const OEChem::OEMolBase& ligand,
                            const OEProteinFlexOptions& flexOpts) const

      .. oe:language:: python

         .. oe:api:: python

            Energy(res: OEComplexEnergies, du: OEDesignUnit, proteinMask: int,
                   ligandMask: int, protFlexPred: OEUnaryAtomPred,
                   proteinPred: OEUnaryAtomPred = OEIsTrueAtom()) -> int
            Energy(res: OEComplexEnergies, du: OEDesignUnit, proteinMask: int,
                   ligandMask: int, flexOpts: OEProteinFlexOptions,
                   proteinPred: OEUnaryAtomPred = OEIsTrueAtom()) -> int
            Energy(res: OEComplexEnergies,
                   protein: Union[OEGraphMol,OEMol,OEQMol],
                   ligand: Union[OEGraphMol,OEMol,OEQMol],
                   protFlexPred: OEUnaryAtomPred) -> int
            Energy(res: OEComplexEnergies,
                   protein: Union[OEGraphMol,OEMol,OEQMol],
                   ligand: Union[OEGraphMol,OEMol,OEQMol],
                   flexOpts: OEProteinFlexOptions) -> int

      Calculate the single point energy of the protein ligand complex.  Only the flexible portion
      of the intra-molecular protein energy components are considered by this method.  In the first 
      four overloads, the ``proteinMask`` define the portion of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` 
      that should be used as the target protein active site. An optional ``proteinPred`` can be also 
      provided along with the mask, to define additional residue components to be part of the target.
      The methods return a value from the :oe:constns:`OESz::OESzybkiReturnCode` namespace reporting the 
      success or failure of the calculation.

.. _OESz_OEFlexProteinLigandOptimizer_Optimize:

   .. oe:method:: Optimize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Optimize(OESz::OEProteinLigandOptResults& res,
                              OEBio::OEDesignUnit& du,
                              const unsigned proteinMask,
                              const unsigned ligandMask,
                              const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& protFlexPred,
                              const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& proteinPred = OEChem::OEIsTrueAtom()) const
            unsigned Optimize(OESz::OEProteinLigandOptResults& res,
                              OEBio::OEDesignUnit& du,
                              const unsigned proteinMask,
                              const unsigned ligandMask,
                              const OEProteinFlexOptions& flexOpts,
                              const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& proteinPred = OEChem::OEIsTrueAtom()) const
            unsigned Optimize(OESz::OEProteinLigandOptResults& res,
                              OEChem::OEMolBase& protein,
                              OEChem::OEMolBase& ligand,
                              const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& protFlexPred) const
            unsigned Optimize(OESz::OEProteinLigandOptResults& res,
                              OEChem::OEMolBase& protein,
                              OEChem::OEMolBase& ligand,
                              const OEProteinFlexOptions& flexOpts) const

      .. oe:language:: python

         .. oe:api:: python

            Optimize(res: OEProteinLigandOptResults, du: OEDesignUnit,
                     proteinMask: int, ligandMask: int,
                     protFlexPred: OEUnaryAtomPred,
                     proteinPred: OEUnaryAtomPred = OEIsTrueAtom()) -> int
            Optimize(res: OEProteinLigandOptResults, du: OEDesignUnit,
                     proteinMask: int, ligandMask: int,
                     flexOpts: OEProteinFlexOptions,
                     proteinPred: OEUnaryAtomPred = OEIsTrueAtom()) -> int
            Optimize(res: OEProteinLigandOptResults,
                     protein: Union[OEGraphMol,OEMol,OEQMol],
                     ligand: Union[OEGraphMol,OEMol,OEQMol],
                     protFlexPred: OEUnaryAtomPred) -> int
            Optimize(res: OEProteinLigandOptResults,
                     protein: Union[OEGraphMol,OEMol,OEQMol],
                     ligand: Union[OEGraphMol,OEMol,OEQMol],
                     flexOpts: OEProteinFlexOptions) -> int

      Optimize the protein ligand complex.  Only the flexible portion
      of the intra-molecular protein energy components are considered by this method.  In the first 
      four overloads, the ``proteinMask`` define the portion of the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` 
      that should be used as the target protein active site. An optional ``proteinPred`` can be also 
      provided along with the mask, to define additional residue components to be part of the target.
      The methods return a value from the :oe:constns:`OESz::OESzybkiReturnCode` namespace reporting 
      the success or failure of the calculation.


.. oe:namespace:: OESz

.. meta::
   :keywords: OEFreeFormConf, FreeFormConf

.. _OESz_OEFreeFormConf:

.. oe:class:: OEFreeFormConf

   .. oe:api::

      class OEFreeFormConf

   The :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` class defines high level interface for conformer
   Free Energies calculation. An advanced interface for conformer Free Energies is provided 
   through the derived class :ref:`OEFreeFormConfAdvanced <OESz_OEFreeFormConfAdvanced>`. All the methods of
   :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` are also available through the :ref:`OEFreeFormConfAdvanced <OESz_OEFreeFormConfAdvanced>`
   class interface.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFreeFormConf(const OEFreeFormConfOptions& opts = OEFreeFormConfOptions())
            OEFreeFormConf(const OEFreeFormConf&)

      .. oe:language:: python

         .. oe:api:: python

            OEFreeFormConf(opts: OEFreeFormConfOptions = OEFreeFormConfOptions()) -> OEFreeFormConf
            OEFreeFormConf(arg2: OEFreeFormConf) -> OEFreeFormConf

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFreeFormConf& operator=(const OEFreeFormConf&)

      Assignment operator.

   .. oe:method:: EstimateFreeEnergies

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int EstimateFreeEnergies(OEChem::OEMCMolBase& mol) const
            unsigned int EstimateFreeEnergies(OEChem::OEMCMolBase& mol,
                                              OEChem::OEMCMolBase& restrictedMol) const

      .. oe:language:: python

         .. oe:api:: python

            EstimateFreeEnergies(argMol: OEMol) -> int
            EstimateFreeEnergies(argMol: OEMol, argRctMol: OEMol) -> int

      Estimates the Gibbs free energy to convert an ensemble of solution conformations into a state where only a 
      single specific conformation is present. Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.

      *mol*
         Represents the input molecule to estimate the conformer free energies, and on return it is 
         modified to represent the corresponding ensemble of solution conformers.  The return ensemble also 
         contains the estimated free energy components.

      *restrictedMol*
         The restricted conformers of the molecule for which to estimate the restriction energies.  The
         estimated restriction energies are tagged on conformers on return. 

   .. oe:method:: FindSimilarConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int FindSimilarConfs(OEChem::OEMCMolBase& mol,
                                          const OEChem::OEMCMolBase& ensemble,
                                          const OEChem::OEConfBase& conf,
                                          const OESystem::OEBinaryPredicate<OEChem::OEConfBase, OEChem::OEConfBase>& condition) const

      .. oe:language:: python

         .. oe:api:: python

            FindSimilarConfs(argMol: OEMol, argEnsemble: OEMol,
                             argRefConf: OEConfBase,
                             argCondition: OEBinaryConfPred) -> int

      Find similar conformers to the specified one from the given ensemble of conformers, based
      on `condition` provided. Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace. A failure is returned when no
      matches are found.

      *mol*
         Contains the conformers that are found on return.  The found conformers are added to 
         any existing conformers.

      *ensemble*
         Ensemble of conformers to search from.

      *conf*
         Reference conformer used for searching.

      *condition*
         Functor defining the similarity condition.
         


.. oe:namespace:: OESz

.. meta::
   :keywords: OEFreeFormConfAdvanced, FreeFormConfAdvanced

.. _OESz_OEFreeFormConfAdvanced:

.. oe:class:: OEFreeFormConfAdvanced

   .. oe:api::

      class OEFreeFormConfAdvanced

   Advanced interface for conformer free-energy calculations, extending
   :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` with additional controls.

   The following methods are publicly inherited from :ref:`OEFreeFormConf <OESz_OEFreeFormConf>`:

   * :oe:meth:`EstimateFreeEnergies<OESz::OEFreeFormConf::EstimateFreeEnergies>`
   * :oe:meth:`FindSimilarConfs<OESz::OEFreeFormConf::FindSimilarConfs>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFreeFormConfAdvanced(const OEFreeFormConfOptions& opts = OEFreeFormConfOptions())
            OEFreeFormConfAdvanced(const OEFreeFormConfAdvanced&)

      .. oe:language:: python

         .. oe:api:: python

            OEFreeFormConfAdvanced(opts: OEFreeFormConfOptions = OEFreeFormConfOptions()) -> OEFreeFormConfAdvanced
            OEFreeFormConfAdvanced(arg2: OEFreeFormConfAdvanced) -> OEFreeFormConfAdvanced

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFreeFormConfAdvanced& operator=(const OEFreeFormConfAdvanced&)

      Assignment operator.

   .. oe:method:: EstimateEnergies

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int EstimateEnergies(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            EstimateEnergies(argMol: OEMol) -> int

      Estimates the Gibbs free energy to convert an ensemble of solution conformations into a state where only a 
      single specific conformation is present. This method assumes that a duplicate free solution ensemble is
      provided as input. Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace. The molecule conformers
      contain the estimated free energy components on return.

   .. oe:method:: EstimateRestrictionEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int EstimateRestrictionEnergy(OEChem::OEMCMolBase& freeMol,
                                                   const OEChem::OEMCMolBase& restrictedMol) const

      .. oe:language:: python

         .. oe:api:: python

            EstimateRestrictionEnergy(argFreeMol: OEMol, argRstrMol: OEMol) -> int

      Estimates the restriction energies on the restricted conformers.
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.  

      *freeMol*
         Molecule with unrestricted conformers identified from the set of solution ensemble, corresponding 
         to the restricted conformers.  The estimated restriction energies are tagged on conformers on return.

      *restrictedMol*
         Molecule with the restricted conformers for which to estimate the restriction energies.

   .. oe:method:: IdentifyConformer

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int IdentifyConformer(OEChem::OEMCMolBase& mol,
                                           const OEChem::OEMCMolBase& ensemble) const

      .. oe:language:: python

         .. oe:api:: python

            IdentifyConformer(argMol: OEMol, argEnsemble: OEMol) -> int

      Identifies the given conformers from the solution ensemble.
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.  

      *mol*
         Molecule with conformers to be identified from the set of solution ensemble.  
         Conformer free energies from identified conformers are tagged on these conformers on return.

      *ensemble*
         Molecule with the solution ensemble with corresponding conformer free energies.

   .. oe:method:: Optimize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int Optimize(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            Optimize(argMol: OEMol) -> int

      Optimize the molecule conformers using the optimization options. 
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.  The molecule
      conformers contain optimized geometry and are tagged with estimated energies on return.

   .. oe:method:: OptimizeRestraint

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int OptimizeRestraint(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            OptimizeRestraint(argMol: OEMol) -> int

      Perform restraint optimization of the molecule conformers using the optimization options.
      A harmonic restraint is applied to retain the shape of the given conformers. 
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.  The molecule
      conformers contain optimized geometry and are tagged with estimated energies on return.

   .. oe:method:: PreOptimizeEnsemble

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int PreOptimizeEnsemble(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            PreOptimizeEnsemble(argMol: OEMol) -> int

      Optimize the molecule conformers using the pre-optimization options. 
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.  The molecule
      conformers contain optimized geometry and are tagged with estimated energies on return.

   .. oe:method:: PrepareEnsemble

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int PrepareEnsemble(OEChem::OEMCMolBase& mol) const
            unsigned int PrepareEnsemble(OEChem::OEMCMolBase& mol,
                                         OEChem::OEMCMolBase& restrictionMol,
                                         OEChem::OEMCMolBase& freeMol) const

      .. oe:language:: python

         .. oe:api:: python

            PrepareEnsemble(argMol: OEMol) -> int
            PrepareEnsemble(argMol: OEMol, argRstrMol: OEMol, argFreeMol: OEMol) -> int

      
      Generates a comprehensive set of conformer ensemble when desired, using OEOmega. 
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.  The input molecule
      is filled with the generated ensemble on return.

      Prepares the conformer ensemble for subsequent FreeForm calculations, this includes generation
      of a comprehensive set of conformers using OEOmega as desired, validation
      of the structures and charge assignment.  The second overload is provided for preparing an
      ensemble that would include un-restricted (free) conformers corresponding to a set of given 
      restriction ensemble of conformers. Charges are also assigned on the given restriction ensemble
      of conformers.
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.

      *mol*
         Molecule with the solution ensemble prepared for FreeFormConf calculations.

      *restrictionMol*
         Molecule with the restricted conformers.

      *freeMol*
         Molecule with the un-restricted conformers, corresponding to the restricted conformers.

   .. oe:method:: RemoveDuplicates

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int RemoveDuplicates(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            RemoveDuplicates(argMol: OEMol) -> int

      Removes duplicates from the given ensemble of molecule conformers. 
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.



.. oe:namespace:: OESz

.. meta::
   :keywords: OEFreeFormConfOptions, FreeFormConfOptions

.. _OESz_OEFreeFormConfOptions:

.. oe:class:: OEFreeFormConfOptions

   .. oe:api::

      class OEFreeFormConfOptions : public OESystem::OEOptions

   This class represents options for setting up FreeFormConf calculations. 
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFreeFormConfOptions()
            OEFreeFormConfOptions(const OEFreeFormConfOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEFreeFormConfOptions() -> OEFreeFormConfOptions
            OEFreeFormConfOptions(arg2: OEFreeFormConfOptions) -> OEFreeFormConfOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFreeFormConfOptions& operator=(const OEFreeFormConfOptions&)

      Assignment operator.

   .. oe:method:: GetCorrSolventOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiSolventOptions& GetCorrSolventOptions()
            const OESzybkiSolventOptions& GetCorrSolventOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetCorrSolventOptions() -> OESzybkiSolventOptions

      Returns a reference to the :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>`
      instance as currently set for solvent correction. When desired, these
      options are used in applying energetic corrections to the free
      energy calculations.

   .. oe:method:: GetIonicState

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetIonicState() const

      .. oe:language:: python

         .. oe:api:: python

            GetIonicState() -> int

      Returns the ionic state to be used for OEFreeFormConf calculations, as
      `unsigned int` from the :oe:constns:`OESz::OEFreeFormIonicState`
      namespace.

   .. oe:method:: GetOmegaOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOmegaOptions& GetOmegaOptions()
            const OEOmegaOptions& GetOmegaOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOmegaOptions() -> OEOmegaOptions

      Returns a reference to the :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>`
      instance as currently set for ensemble generation. When desired,
      these options are used in generating the initial ensemble of conformers.

   .. oe:method:: GetOptimizeOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiOptOptions& GetOptimizeOptions()
            const OESzybkiOptOptions& GetOptimizeOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizeOptions() -> OESzybkiOptOptions

      Returns a reference to the :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>`
      instance as currently set for tight optimization. These options are
      used in tight optimization of conformers.

   .. oe:method:: GetPreOptimizeOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiOptOptions& GetPreOptimizeOptions()
            const OESzybkiOptOptions& GetPreOptimizeOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetPreOptimizeOptions() -> OESzybkiOptOptions

      Returns a reference to the :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>`
      instance as currently set for pre-optimization. These options are used in 
      loose pre-optimization of conformers to pre-screen and reduce the size of
      conformers ensemble.

   .. oe:method:: GetSolventOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiSolventOptions& GetSolventOptions()
            const OESzybkiSolventOptions& GetSolventOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolventOptions() -> OESzybkiSolventOptions

      Returns a reference to the :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>`
      instance as currently set for solvent. These options are used in
      defining the solvent for conformers minimization and subsequent entropy
      calculation.

   .. oe:method:: GetSzybkiGeneralOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiGeneralOptions& GetSzybkiGeneralOptions()
            const OESzybkiGeneralOptions& GetSzybkiGeneralOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSzybkiGeneralOptions() -> OESzybkiGeneralOptions

      Returns a reference to the :ref:`OESzybkiGeneralOptions <OESz_OESzybkiGeneralOptions>`
      instance as currently set. These options are used in defining general
      environment for all szybki calculations performed from FreeFormConf.

   .. oe:method:: GetUseInputEnsemble

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseInputEnsemble() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseInputEnsemble() -> bool

      Returns the current state of the use input ensemble flag. If true, the
      input set of ensemble is used as the initial conformers ensemble and no
      new conformers are generated during FreeFormConf calculations.

   .. oe:method:: GetUseSolventCorr

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseSolventCorr() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseSolventCorr() -> bool

      Returns the current state of the use solvent correction flag. If true,
      energetic correction due to solvent interactions is applied after
      entropy calculation.

.. oe:method:: SetCorrSolventOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCorrSolventOptions(const OESzybkiSolventOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetCorrSolventOptions(opts: OESzybkiSolventOptions) -> None

      Sets the correction solvent options by passing in an 
      :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>` instance. When desired, these
      options are used in applying energetic corrections to the free energy
      calculations.
      Default solvent model: :oe:const:`OESz::OESolventModel::PB`,
      default atomic radii type: :oe:const:`OESz::OEAtomicRadii::ZAP9`,
      default charge model: :ref:`OEChargeEngineNoOp <OEProton_OEChargeEngineNoOp>`.

   .. oe:method:: SetIonicState

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIonicState(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetIonicState(value: int) -> bool

      Sets the ionic state to be used for OEFreeFormConf calculations, as
      `unsigned int` from the :oe:constns:`OESz::OEFreeFormIonicState`
      namespace.  The method returns ``false`` when the invalid selection
      is chosen, ``true`` otherwise.
      Default: :oe:const:`OESz::OEFreeFormIonicState::PH74`.

   .. oe:method:: SetOmegaOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOmegaOptions(const OEOmegaOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetOmegaOptions(opts: OEOmegaOptions) -> None

      Sets the omega options by passing in an
      :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` instance. When desired, these
      options are used in generating the initial ensemble of conformers.
      Default search force field:
      :oe:const:`OEFF::OEMMFFSheffieldFFType::MMFF94S_SHEFF`,
      default EnergyWindow: 10.0, default IncludeInput: ``false``,
      default MaxRotors: 20.

   .. oe:method:: SetOptimizeOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOptimizeOptions(const OESzybkiOptOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizeOptions(opts: OESzybkiOptOptions) -> None

      Sets the optimization options by passing in an
      :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>`
      instance. These options are used in tight optimization of conformers.
      Default optimizer type: :oe:const:`OESz::OEOptType::NEWTON`,
      default MaxIter: 1000.

   .. oe:method:: SetPreOptimizeOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPreOptimizeOptions(const OESzybkiOptOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetPreOptimizeOptions(opts: OESzybkiOptOptions) -> None

      Sets the pre-optimization options by passing in an 
      :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>` instance. These options are
      used in loose pre-optimization of conformers to pre-screen 
      and reduce the size of conformers ensemble.
      Default optimizer type: :oe:const:`OESz::OEOptType::BFGS`,
      default MaxIter: 1000, default GradTolerance: 0.005.

   .. oe:method:: SetSolventOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSolventOptions(const OESzybkiSolventOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetSolventOptions(opts: OESzybkiSolventOptions) -> None

      Sets the solvent options by passing in an
      :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>`
      instance. These options are used in defining the
      solvent for conformers minimization and subsequent entropy calculation.
      Default solvent model: :oe:const:`OESz::OESolventModel::Sheffield`,
      default atomic radii type: :oe:const:`OESz::OEAtomicRadii::ZAP9`,
      default charge model: :ref:`OEAM1BCCELF10Charges <OEProton_OEAM1BCCELF10Charges>`.

   .. oe:method:: SetSzybkiGeneralOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSzybkiGeneralOptions(const OESzybkiGeneralOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetSzybkiGeneralOptions(opts: OESzybkiGeneralOptions) -> None

      Sets the general szybki options by passing in an
      :ref:`OESzybkiGeneralOptions <OESz_OESzybkiGeneralOptions>` instance. These options
      are used in defining the general environment for all szybki calculations 
      performed from FreeFormConf. Default force field:
      :oe:const:`OESz::OEForceFieldType::MMFF94S`, 
      default temperature: 298.15K.

   .. oe:method:: SetUseInputEnsemble

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseInputEnsemble(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseInputEnsemble(value: bool) -> bool

      Sets the current state of the use input ensemble flag. If true, the
      input set of ensemble is used as the initial conformers ensemble and no
      new conformers are generated during FreeFormConf calculations.
      Default: ``false``.

   .. oe:method:: SetUseSolventCorr

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseSolventCorr(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseSolventCorr(value: bool) -> bool

      Sets the current state of the use solvent correction flag. If true,
      energetic correction due to solvent interactions is applied after
      entropy calculation. Default: ``false``.


.. oe:namespace:: OESz

.. meta::
   :keywords: OEFreeFormConfResults, FreeFormConfResults

.. _OESz_OEFreeFormConfResults:

.. oe:class:: OEFreeFormConfResults

   .. oe:api::

      class OEFreeFormConfResults

   Container for conformer free-energy calculation results produced by
   :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` and
   :ref:`OEFreeFormConfAdvanced <OESz_OEFreeFormConfAdvanced>`.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFreeFormConfResults(const OEChem::OEMCMolBase&)
            OEFreeFormConfResults(const OEFreeFormConfResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEFreeFormConfResults() -> OEFreeFormConfResults
            OEFreeFormConfResults(argMol: OEMol) -> OEFreeFormConfResults
            OEFreeFormConfResults(argRes: OEFreeFormConfResults) -> OEFreeFormConfResults

      Default and copy constructors.  The first variation of the constructor populates
      the object by extracting the corresponding tagged values from the molecule.  

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFreeFormConfResults& operator=(const OEFreeFormConfResults&)

      Assignment operator.

   .. oe:method:: GetConfResult

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESingleConfResult GetConfResult(const unsigned int) const

      .. oe:language:: python

         .. oe:api:: python

            GetConfResult(argConf: int) -> OESingleConfResult

      Returns the :ref:`OESingleConfResult <OESz_OESingleConfResult>` object corresponding to
      the specified conformer index.

   .. oe:method:: GetLowestdGConfIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetLowestdGConfIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetLowestdGConfIdx() -> int

      Returns the conformer index corresponding to the lowest dG.

   .. oe:method:: GetLowestRelEneConfIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetLowestRelEneConfIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetLowestRelEneConfIdx() -> int

      Returns the conformer index corresponding to the lowest relative energy.

   .. oe:method:: GetNumUniqueConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumUniqueConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumUniqueConfs() -> int

      Returns the number of the unique conformations in the ensemble.

   .. oe:method:: PrintTxt

      .. oe:language:: c++ java csharp

         .. oe:api::

            void PrintTxt(OEPlatform::oeostream& fileStream,
                          const std::string& molName) const

      .. oe:language:: python

         .. oe:api:: python

            PrintTxt(argStream: oeostream, argMolName: str) -> None

      Prints the results in plain text format in the provided output filestream.

   .. oe:method:: PrintCsv

      .. oe:language:: c++ java csharp

         .. oe:api::

            void PrintCsv(OEPlatform::oeostream& fileStream,
                          const std::string& molName) const

      .. oe:language:: python

         .. oe:api:: python

            PrintCsv(argStream: oeostream, argMolName: str) -> None

      Prints the results in comma separated values (CSV) format in the provided output filestream.

   .. oe:method:: GetResultsForConformations

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESingleConfResult>* GetResultsForConformations() const

      .. oe:language:: python

         .. oe:api:: python

            GetResultsForConformations() -> Iterable[OESingleConfResult]

      Returns the iterator whose elements are :ref:`OESingleConfResult <OESz_OESingleConfResult>` objects for
      the ensemble of unique conformations. 
      
   .. oe:method:: GetTemperature

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTemperature() const

      .. oe:language:: python

         .. oe:api:: python

            GetTemperature() -> float

      Returns temperature for which calculations have been performed.
      
   .. oe:method:: GetTotalEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTotalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalEntropy() -> float

      Returns estimated molar solution entropy for the input compound.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

.. meta::
   :keywords: OEFreeFormSolvOptions, FreeFormSolvOptions

.. _OESz_OEFreeFormSolvOptions:

.. oe:class:: OEFreeFormSolvOptions

   .. oe:api::

      class OEFreeFormSolvOptions : public OESystem::OEOptions

   Configuration options for :oe:func:`OESz::OEEstimateSolvFreeEnergy` solvation
   free-energy calculations.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFreeFormSolvOptions()
            OEFreeFormSolvOptions(const OEFreeFormSolvOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEFreeFormSolvOptions() -> OEFreeFormSolvOptions
            OEFreeFormSolvOptions(arg2: OEFreeFormSolvOptions) -> OEFreeFormSolvOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFreeFormSolvOptions& operator=(const OEFreeFormSolvOptions&)

      Assignment operator.

   .. oe:method:: GetAtomicRadiiType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomicRadiiType() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomicRadiiType() -> int

      Returns the type of atomic radii used for PB calculations. Possible values passed to the method are
      defined in :oe:constns:`OESz::OEAtomicRadii` namespace.

   .. oe:method:: GetChargeType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetChargeType() const

      .. oe:language:: python

         .. oe:api:: python

            GetChargeType() -> int

      Returns the type of partial charges used for Sheffield and PB calculations.

   .. oe:method:: GetConfGenRMS

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetConfGenRMS() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfGenRMS() -> float

      Returns the value of RMSD used by the conformation generator for conformation deduplication.
      The default values are 0.6 |A| for solvation free energy estimation and
      0.3 |A| for conformation free energy estimation.

   .. oe:method:: GetIonicState

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetIonicState() const

      .. oe:language:: python

         .. oe:api:: python

            GetIonicState() -> int

      Returns the type of charge state. Possible values are defined in the
      :oe:constns:`OESz::OEFreeFormIonicState` namespace. The default value is
      :oe:constns:`OESz::OEFreeFormIonicState::PH74`.

   .. oe:method:: GetMaxConfGen

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxConfGen() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxConfGen() -> int

      Returns the maximum conformations number used by the conformation generator.
   
   .. oe:method:: GetUseInput3D

     .. oe:language:: c++ java csharp

        .. oe:api::

           bool GetUseInput3D() const
           Determines if the calculations are set to use 3D coordinates of the input molecule.

     .. oe:language:: python

        .. oe:api:: python

           GetUseInput3D() -> bool

   .. oe:method:: GetUseInputEnsemble

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseInputEnsemble() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseInputEnsemble() -> bool

      Determines if the calculations are set to use the input ensemble of conformations
      rather than generate the ensemble internally.

   .. oe:method:: SetAtomicRadiiType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAtomicRadiiType(unsigned radii_type)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomicRadiiType(value: int) -> bool

      Sets the atomic radii type for all PB calculations. Possible values passed to the method are
      defined in :oe:constns:`OESz::OEAtomicRadii` namespace.

   .. oe:method:: SetChargeType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetChargeType(unsigned charge_type)

      .. oe:language:: python

         .. oe:api:: python

            SetChargeType(value: int) -> bool

      Sets the partial charges type. Possible values to pass to the method are defined in a subset
      of `the `OEProton::OECharges`` namespace (please look at the documentation of The **Quacpac TK**.)
      The allowed types are: :oe:constns:`OEProton::OECharges::NoOp` (to use existing partial charges),
      :oe:constns:`OEProton::OECharges::AM1BCCSym`, :oe:constns:`OEProton::OECharges::AM1BCCNoSym`,
      :oe:constns:`OEProton::OECharges::AM1BCCSymSPt`, :oe:constns:`OEProton::OECharges::AM1BCCNoSymSPt`
      and :oe:constns:`OEProton::OECharges::MMFF94`. The default values are
      :oe:constns:`OEProton::OECharges::AM1BCCNoSymSPt` and :oe:constns:`OEProton::OECharges::AM1BCCSym`
      for solvation free energy estimation and conformation free energy estimation respectively. 
   
   .. oe:method:: SetConfGenRMS

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetConfGenRMS(double rms)

      .. oe:language:: python

         .. oe:api:: python

            SetConfGenRMS(value: float) -> bool

      Sets the value of RMSD used by the conformation generator for conformation deduplication.
      The default values are 0.6 |A| for solvation free energy 
      estimation and 0.3 |A| for conformation free energy estimation.

   .. oe:method:: SetIonicState

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIonicState(unsigned ionic_state)

      .. oe:language:: python

         .. oe:api:: python

            SetIonicState(value: int) -> bool

      Sets the charge state of the molecule. Possible values are defined in the
      :oe:constns:`OESz::OEFreeFormIonicState` namespace. The default value is
      :oe:constns:`OESz::OEFreeFormIonicState::PH74`.

   .. oe:method:: SetMaxConfGen

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxConfGen(unsigned nmax)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxConfGen(value: int) -> bool

      Sets the maximum number of conformations generated by the conformation generator.
      The default values are 200 for solvation free energy estimation and 20000 for
      conformation free energy estimation.

   .. oe:method:: SetUseInput3D

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseInput3D(bool use3D)

      .. oe:language:: python

         .. oe:api:: python

            SetUseInput3D(value: bool) -> bool

      When parameter ``use3D`` is set to ``true``, solvation free energy is calculated just
      for the input structure representing specific conformation. This option allows to
      find what is the difference in solvation energy between different conformations.

   .. oe:method:: SetUseInputEnsemble

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseInputEnsemble(bool use_ensemble)

      .. oe:language:: python

         .. oe:api:: python

            SetUseInputEnsemble(value: bool) -> bool

      Sets the usage of the input ensemble rather than generating it internally when the
      parameter ``use_ensemble`` is set to ``true``.

.. note::

   The value set by the :oe:meth:`OESz::OEFreeFormSolvOptions::SetUseInput3D` method takes precedence
   over :oe:meth:`OESz::OEFreeFormSolvOptions::SetUseInputEnsemble`. In other words when the first
   of those methods passes boolean value ``true``, solvation code is looking for a single 3D
   structure (conformation) provided by the user and determines its solvation free energy.
   When the value passed by this method is ``false`` or when it is not used, solvation code is
   selecting the lowest force field energy conformation either from the user ensemble (when 
   medthod :oe:meth:`OESz::OEFreeFormSolvOptions::SetUseInputEnsemble` passes boolean ``true``)
   or from the ensemble generated internally and determines its solvation free energy.   
     


.. oe:namespace:: OESz

.. meta::
   :keywords: OEFreeFormSolvResults, FreeFormSolvResults

.. _OESz_OEFreeFormSolvResults:

.. oe:class:: OEFreeFormSolvResults

   .. oe:api::

      class OEFreeFormSolvResults

   Container for solvation free-energy results returned by
   :oe:func:`OESz::OEEstimateSolvFreeEnergy`.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFreeFormSolvResults()
            OEFreeFormSolvResults(const OEFreeFormSolvResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEFreeFormSolvResults() -> OEFreeFormSolvResults
            OEFreeFormSolvResults(ffr: OEFreeFormSolvResults) -> OEFreeFormSolvResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFreeFormSolvResults& operator=(const OEFreeFormSolvResults&)

      Assignment operator.

   .. oe:method:: GetAtomicPotentials

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetAtomicPotentials(std::vector<double>& apot) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomicPotentials(apot: OEDoubleVector) -> None

      Fills the vector passed as an arguments with calculated atomic potentials.
      Each calculated atomic potential is a sum of electrostatic and hydrophobic contributions.

   .. oe:method:: GetElectrostaticSolvationFreeEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetElectrostaticSolvationFreeEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetElectrostaticSolvationFreeEnergy() -> float

      Returns electrostatic part of solvation free energy after calling  
      :oe:func:`OESz::OEEstimateSolvFreeEnergy` function.
      
   .. oe:method:: GetHydrophobicSolvationFreeEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHydrophobicSolvationFreeEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetHydrophobicSolvationFreeEnergy() -> float

      Returns hydrophobic part of solvation free energy after calling 
      :oe:func:`OESz::OEEstimateSolvFreeEnergy` function.

   .. oe:method:: GetReturnCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetReturnCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetReturnCode() -> int

   Returns one of the values defined in the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.
   
   .. oe:method:: GetSolvationFreeEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSolvationFreeEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolvationFreeEnergy() -> float

      Returns total Gibbs free energy of hydration for the input compound after calling
      :oe:func:`OESz::OEEstimateSolvFreeEnergy` function.

   .. oe:method:: GetWarnings

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetWarnings(std::vector<unsigned int>& warnings) const

      .. oe:language:: python

         .. oe:api:: python

            GetWarnings(warnings: OEUIntVector) -> None

   Fills the vector passed as an argument with warning codes relevant to the calculation
   performed. When no warnings are generated the returned vector is empty.


.. oe:namespace:: OESz

.. meta::
   :keywords: OELigandChargeOptions, OELigandChargeOptions

.. _OESz_OELigandChargeOptions:

.. oe:class:: OELigandChargeOptions

   .. oe:api::

      class OELigandChargeOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for assigning ligand charges.

   The :ref:`OELigandChargeOptions <OESz_OELigandChargeOptions>` class defines the following public methods:
    * :oe:meth:`GetGenerateElfConfs<OESz::OELigandChargeOptions::GetGenerateElfConfs>` and
      :oe:meth:`SetGenerateElfConfs<OESz::OELigandChargeOptions::SetGenerateElfConfs>`
    * :oe:meth:`GetLigandCharge<OESz::OELigandChargeOptions::GetLigandCharge>`,
      :oe:meth:`GetLigandChargeType<OESz::OELigandChargeOptions::GetLigandChargeType>`, and
      :oe:meth:`SetLigandCharge<OESz::OELigandChargeOptions::SetLigandCharge>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELigandChargeOptions()
            OELigandChargeOptions(const OELigandChargeOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OELigandChargeOptions() -> OELigandChargeOptions
            OELigandChargeOptions(arg2: OELigandChargeOptions) -> OELigandChargeOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELigandChargeOptions &operator=(const OELigandChargeOptions &)

   ..   _OESz_OELigandChargeOptions_GetGenerateElfConfs:

      Assignment operator.

   .. oe:method:: GetGenerateElfConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetGenerateElfConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetGenerateElfConfs() -> bool

      See :oe:meth:`SetGenerateElfConfs<OESz::OELigandChargeOptions::SetGenerateElfConfs>` method.

   ..   _OESz_OELigandChargeOptions_GetLigandCharge:

   .. oe:method:: GetLigandCharge

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEProton::OEChargeEngineBase* GetLigandCharge() const
            const OEProton::OEChargeEngineBase* GetLigandCharge() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandCharge() -> OEChargeEngineBase

      See :oe:meth:`SetLigandCharge<OESz::OELigandChargeOptions::SetLigandCharge>` method.

   ..   _OESz_OELigandChargeOptions_GetLigandChargeType:

   .. oe:method:: GetLigandChargeType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetLigandChargeType() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandChargeType() -> int

      See :oe:meth:`SetLigandCharge<OESz::OELigandChargeOptions::SetLigandCharge>` method.

   ..   _OESz_OELigandChargeOptions_SetGenerateElfConfs:

   .. oe:method:: SetGenerateElfConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetGenerateElfConfs(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetGenerateElfConfs(value: bool) -> bool

      Sets flag if **conformers should be generated** for ELF10 conformer selection. 
      **Default: False.**

   ..   _OESz_OELigandChargeOptions_SetLigandCharge:

   .. oe:method:: SetLigandCharge

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLigandCharge(const unsigned)
            bool SetLigandCharge(const std::string&)
            bool SetLigandCharge(const OEProton::OEChargeEngineBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetLigandCharge(value: int) -> bool
            SetLigandCharge(value: str) -> bool
            SetLigandCharge(value: oeistream) -> bool
            SetLigandCharge(value: OEChargeEngineBase) -> bool

      Sets the **charging method** for the ligand. The first overload takes an `unsigned` 
      from the :oe:constns:`OESz::OELigandChargeType` namespace, and the second overload
      takes corresponding string values. The final overload allows the use of a user-defined
      :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`. Method returns ``false`` when 
      the invalid selection is chosen, ``true`` otherwise.
      **Default:** :oe:const:`OESz::OELigandChargeType::CURRENT`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

.. meta::
   :keywords: OELigandEnergy

.. _OESz_OELigandEnergy:

.. oe:class:: OELigandEnergy

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OELigandEnergy

   This class provides a container for the total energy and
   energy components resulting from a FF energy calculation on a ligand.

   .. seealso::

      * :ref:`OELigandOptResults <OESz_OELigandOptResults>` class

   The :ref:`OELigandEnergy <OESz_OELigandEnergy>` class defines the following public methods:

    * :oe:meth:`GetBondEne<OESz::OELigandEnergy::GetBondEne>`
    * :oe:meth:`GetBendEne<OESz::OELigandEnergy::GetBendEne>`
    * :oe:meth:`GetTorsionEne<OESz::OELigandEnergy::GetTorsionEne>`
    * :oe:meth:`GetImproperEne<OESz::OELigandEnergy::GetImproperEne>`
    * :oe:meth:`GetVdWEne<OESz::OELigandEnergy::GetVdWEne>`
    * :oe:meth:`GetCoulombEne<OESz::OELigandEnergy::GetCoulombEne>`
    * :oe:meth:`GetIntraEne<OESz::OELigandEnergy::GetIntraEne>`
    * :oe:meth:`GetSolvationEne<OESz::OELigandEnergy::GetSolvationEne>`
    * :oe:meth:`GetTotalEne<OESz::OELigandEnergy::GetTotalEne>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELigandEnergy()
            OELigandEnergy(const OELigandEnergy&)

      .. oe:language:: python

         .. oe:api:: python

            OELigandEnergy() -> OELigandEnergy
            OELigandEnergy(arg2: OELigandEnergy) -> OELigandEnergy

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELigandEnergy& operator=(const OELigandEnergy&)

   .. _OESz_OELigandEnergy_GetBondEne:

      Assignment operator.

   .. oe:method:: GetBondEne

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBondEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondEne() -> float

      Returns the bond energy component of the total energy

   .. _OESz_OELigandEnergy_GetBendEne:

   .. oe:method:: GetBendEne

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBendEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetBendEne() -> float

      Returns the angle bending energy component of the total energy

   .. _OESz_OELigandEnergy_GetTorsionEne:

   .. oe:method:: GetTorsionEne

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTorsionEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetTorsionEne() -> float

      Returns the proper torsional energy component of the total energy

   .. _OESz_OELigandEnergy_GetImproperEne:

   .. oe:method:: GetImproperEne

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetImproperEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetImproperEne() -> float

      Returns the improper torsional energy component of the total energy

   .. _OESz_OELigandEnergy_GetVdWEne:

   .. oe:method:: GetVdWEne

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetVdWEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetVdWEne() -> float

      Returns the van der Walls interaction energy component of the total energy

   .. _OESz_OELigandEnergy_GetCoulombEne:

   .. oe:method:: GetCoulombEne

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCoulombEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetCoulombEne() -> float

      Returns the coulomb energy component of the total energy

   .. _OESz_OELigandEnergy_GetIntraEne:

   .. oe:method:: GetIntraEne

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetIntraEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetIntraEne() -> float

      Returns the intra energy component of the total energy

   .. _OESz_OELigandEnergy_GetSolvationEne:

   .. oe:method:: GetSolvationEne

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSolvationEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolvationEne() -> float

      Returns the solvation energy component of the total energy

   .. _OESz_OELigandEnergy_GetTotalEne:

   .. oe:method:: GetTotalEne

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTotalEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalEne() -> float

      Returns the total energy



.. oe:namespace:: OESz

.. meta::
   :keywords: OELiganEntropyOptions, LiganEntropyOptions

.. _OESz_OELigandEntropyOptions:

.. oe:class:: OELigandEntropyOptions: public OELigandChargeOptions

   .. oe:api::

      class OELigandEntropyOptions : public OESystem::OEOptions

   Used for entropy estimation of free ligands in solution or in vacuum.

   .. seealso::

      * :ref:`OEEntropyResults <OESz_OEEntropyResults>` class
      * :oe:func:`OESz::OELigandEntropy` function

   The following methods are publicly inherited from :ref:`OELigandChargeOptions <OESz_OELigandChargeOptions>`:

    * :oe:meth:`GetGenerateElfConfs<OESz::OELigandChargeOptions::GetGenerateElfConfs>` and
      :oe:meth:`SetGenerateElfConfs<OESz::OELigandChargeOptions::SetGenerateElfConfs>`
    * :oe:meth:`GetLigandCharge<OESz::OELigandChargeOptions::GetLigandCharge>`,
      :oe:meth:`GetLigandChargeType<OESz::OELigandChargeOptions::GetLigandChargeType>`, and
      :oe:meth:`SetLigandCharge<OESz::OELigandChargeOptions::SetLigandCharge>`

   The :ref:`OELigandEntropyOptions <OESz_OELigandEntropyOptions>` class defines the following public methods:

    * :ref:`GetEnvironment<OESz_OELigandEntropyOptions_GetEnvironment>` and
      :ref:`SetEnvironment<OESz_OELigandEntropyOptions_SetEnvironment>`
    * :ref:`GetForceField<OESz_OELigandEntropyOptions_GetForceField>`,
      :ref:`GetForceFieldType<OESz_OELigandEntropyOptions_GetForceFieldType>` and
      :ref:`SetForceField<OESz_OELigandEntropyOptions_SetForceField>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELigandEntropyOptions()
            OELigandEntropyOptions(const OELigandEntropyOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OELigandEntropyOptions() -> OELigandEntropyOptions
            OELigandEntropyOptions(arg2: OELigandEntropyOptions) -> OELigandEntropyOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELigandEntropyOptions &operator=(const OELigandEntropyOptions &)

      Assignment operator.

   .. _OESz_OELigandEntropyOptions_GetEnvironment:

   .. oe:method:: GetEnvironment

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetEnvironment() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnvironment() -> int

      Returns one of 2 types of environement
      :ref:`Gas <OESz_OEEnvType_Gas>`,
      :ref:`Solution <OESz_OEEnvType_Solution>`

   
   .. _OESz_OELigandEntropyOptions_GetForceField:

   .. oe:method:: GetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMolPotential::OEForceField* GetForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEForceField

      See :ref:`SetForceField<OESz_OELigandEntropyOptions_SetForceField>` method.

   ..   _OESz_OELigandEntropyOptions_GetForceFieldType:

   .. oe:method:: GetForceFieldType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceFieldType() -> int

      See :ref:`SetForceField<OESz_OELigandEntropyOptions_SetForceField>` method.

   .. _OESz_OELigandEntropyOptions_SetEnvironment:

   .. oe:method:: SetEnvironment

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnvironment(unsigned int etype)

      .. oe:language:: python

         .. oe:api:: python

            SetEnvironment(value: int) -> bool

      Selects solution (etype = :oe:constns:`OESz::OEEnvType::Solution`) or gas
      (etype = :oe:constns:`OESz::OEEnvType::Gas`) state.   
      
           
   .. _OESz_OELigandEntropyOptions_SetForceField:

   .. oe:method:: SetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceField(const unsigned)
            bool SetForceField(const std::string&)
            bool SetForceField(const OEMolPotential::OEForceField&)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: int) -> bool
            SetForceField(value: str) -> bool
            SetForceField(value: oeistream) -> bool
            SetForceField(value: OEForceField) -> bool

      Sets the **force field** for optimization.  The first overload takes an `unsigned` 
      from the :ref:`OESz_OEForceFieldType <OESz_OEForceFieldType>` constant namespace, and the second overload
      takes corresponding string values. The final overload allows the use of a user-defined
      :ref:`OEForceField <OEMolPotential_OEForceField>`. Method returns ``false`` when the invalid selection
      is chosen, ``true`` otherwise.
      **Default:** :oe:const:`OESz::OEForceFieldType::SAGE_OPENFF`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

.. meta::
   :keywords: OELigandOptOptions

.. _OESz_OELigandOptOptions:

.. oe:class:: OELigandOptOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OELigandOptOptions

   This class provides an interface to modify the options for FF optimization of a ligand molecule.

   .. seealso::

      * :ref:`OELigandOptResults <OESz_OELigandOptResults>` class

   The :ref:`OELigandOptOptions <OESz_OELigandOptOptions>` class defines the following public methods:
    * :oe:meth:`GetForceField<OESz::OELigandOptOptions::GetForceField>`
    * :oe:meth:`GetForceFieldType<OESz::OELigandOptOptions::GetForceFieldType>`
    * :oe:meth:`GetLigandCharge<OESz::OELigandOptOptions::GetLigandCharge>`
    * :oe:meth:`GetLigandChargeType<OESz::OELigandOptOptions::GetLigandChargeType>`
    * :oe:meth:`GetNonBondCutoff<OESz::OELigandOptOptions::GetNonBondCutoff>`
    * :oe:meth:`GetGradTolerance<OESz::OELigandOptOptions::GetGradTolerance>`
    * :oe:meth:`GetMaxIter<OESz::OELigandOptOptions::GetMaxIter>`
    * :oe:meth:`GetSolventModel<OESz::OELigandOptOptions::GetSolventModel>`
    * :oe:meth:`SetForceField<OESz::OELigandOptOptions::SetForceField>`
    * :oe:meth:`SetLigandCharge<OESz::OELigandOptOptions::SetLigandCharge>`
    * :oe:meth:`SetNonBondCutoff<OESz::OELigandOptOptions::SetNonBondCutoff>`
    * :oe:meth:`SetGradTolerance<OESz::OELigandOptOptions::SetGradTolerance>`
    * :oe:meth:`SetMaxIter<OESz::OELigandOptOptions::SetMaxIter>`
    * :oe:meth:`SetSolventModel<OESz::OELigandOptOptions::SetSolventModel>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELigandOptOptions()
            OELigandOptOptions(const OELigandOptOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OELigandOptOptions() -> OELigandOptOptions
            OELigandOptOptions(arg2: OELigandOptOptions) -> OELigandOptOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELigandOptOptions& operator=(const OELigandOptOptions&)

.. _OESz_OELigandOptOptions_GetForceField:

      Assignment operator.

   .. oe:method:: GetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMolPotential::OEForceField* GetForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEForceField

      Returns pointer to the force field used in the optimization. ** Default ** :ref:`SAGE_OPENFF <OESz_OEForceFieldType_SAGE_OPENFF>`.

.. _OESz_OELigandOptOptions_GetForceFieldType:

   .. oe:method:: GetForceFieldType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceFieldType() -> int

      Returns the force field type used for the calculations, as `unsigned int`
      from the :oe:constns:`OESz::OEForceFieldType` namespace.  ** Default ** :ref:`SAGE_OPENFF <OESz_OEForceFieldType_SAGE_OPENFF>`.

.. _OESz_OELigandOptOptions_GetLigandCharge:

   .. oe:method:: GetLigandCharge

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEProton::OEChargeEngineBase* GetLigandCharge() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandCharge() -> OEChargeEngineBase

      Returns the charge engine used for the calculations. See :oe:meth:`SetLigandCharge<OESz::OELigandOptOptions::SetLigandCharge>` method.
      ** Default ** :ref:`OEChargeEngineNoOp <OEProton_OEChargeEngineNoOp>`.

.. _OESz_OELigandOptOptions_GetLigandChargeType:

   .. oe:method:: GetLigandChargeType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetLigandChargeType() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandChargeType() -> int

      Returns the charge type to be used for the calculations, as `unsigned int` from
      the :oe:const:`OESz::OELigandChargeType`. **Default:** :oe:const:`OESz::OELigandChargeType::CURRENT`

.. _OESz_OELigandOptOptions_GetNonBondCutoff:

   .. oe:method:: GetNonBondCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetNonBondCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetNonBondCutoff() -> float

      See :oe:meth:`SetNonBondCutoff<OESz::OELigandOptOptions::SetNonBondCutoff>` method

.. _OESz_OELigandOptOptions_GetGradTolerance:

   .. oe:method:: GetGradTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetGradTolerance() const

      .. oe:language:: python

         .. oe:api:: python

            GetGradTolerance() -> float

      See :oe:meth:`SetGradTolerance<OESz::OELigandOptOptions::SetGradTolerance>` method

.. _OESz_OELigandOptOptions_GetMaxIter:

   .. oe:method:: GetMaxIter

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxIter() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxIter() -> int

      See :oe:meth:`SetMaxIter<OESz::OELigandOptOptions::SetMaxIter>` method

.. _OESz_OELigandOptOptions_GetSolventModel:

   .. oe:method:: GetSolventModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetSolventModel() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolventModel() -> int

      See :oe:meth:`SetSolventModel<OESz::OELigandOptOptions::SetSolventModel>` method

.. _OESz_OELigandOptOptions_SetForceField:

   .. oe:method:: SetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceField(const unsigned)
            bool SetForceField(const std::string&)
            bool SetForceField(const OEMolPotential::OEForceField&)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: int) -> bool
            SetForceField(value: str) -> bool
            SetForceField(value: oeistream) -> bool
            SetForceField(value: OEForceField) -> bool

      Sets force field to be used. Method takes either an `unsigned`
      from the  :oe:constns:`OESz::OEForceFieldType` namespace, or the takes corresponding
      string value, or a custom forcefield. Available predefined values are:
      :ref:`MMFF94 <OESz_OEForceFieldType_MMFF94>`, :ref:`MMFF94S <OESz_OEForceFieldType_MMFF94S>`,
      :ref:`PARSLEY_OPENFF <OESz_OEForceFieldType_PARSLEY_OPENFF>`, and :ref:`SAGE_OPENFF <OESz_OEForceFieldType_SAGE_OPENFF>`.
      Default: `sage`

.. _OESz_OELigandOptOptions_SetLigandCharge:

   .. oe:method:: SetLigandCharge

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLigandCharge(const unsigned)
            bool SetLigandCharge(const std::string&)
            bool SetLigandCharge(const OEProton::OEChargeEngineBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetLigandCharge(value: int) -> bool
            SetLigandCharge(value: str) -> bool
            SetLigandCharge(value: oeistream) -> bool
            SetLigandCharge(value: OEChargeEngineBase) -> bool

      Selects the method for ligand partial charges assigment. Method takes either an `unsigned`
      from the :oe:constns:`OESz::OELigandChargeType` namespace, or the takes corresponding string value,
      or a user-defined instance of :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`.
      It returns ``false`` when the invalid selection is chosen, ``true`` otherwise.
      The default engine :ref:`OEChargeEngineNoOp <OEProton_OEChargeEngineNoOp>` will use the pre-existing charges.

.. _OESz_OELigandOptOptions_SetNonBondCutoff:

   .. oe:method:: SetNonBondCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNonBondCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetNonBondCutoff(value: float) -> bool

      Sets the **Non-bonded interactions cutoff** for optimization.
      Setting a value of ``0.0`` or less assumes that all interactions should be
      included without any cutoff.
      Default: 0.0.

.. _OESz_OELigandOptOptions_SetGradTolerance:

   .. oe:method:: SetGradTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetGradTolerance(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetGradTolerance(value: float) -> bool

      Sets the **gradient tolerance** for optimization. Default: 1.e-4.

.. _OESz_OELigandOptOptions_SetMaxIter:

   .. oe:method:: SetMaxIter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxIter(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxIter(value: int) -> bool

      Sets the number of maximum iterations for optimization Default: 400

.. _OESz_OELigandOptOptions_SetSolventModel:

   .. oe:method:: SetSolventModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSolventModel(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetSolventModel(value: int) -> bool

      Sets the type of solvent model used for the calculations of
      solution ligands, as an `unsigned int`
      from the :oe:constns:`OESz::OESolventModel` namespace.
      Method returns ``false`` when the invalid selection is chosen, ``true``
      otherwise.
      Default is :oe:const:`OESz::OESolventModel::NoSolv`



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

.. meta::
   :keywords: OELigandOptResults

.. _OESz_OELigandOptResults:

.. oe:class:: OELigandOptResults

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OELigandOptResults

   This class provides a container for the results of a FF optimization of a ligand molecule.

   .. seealso::

      * :ref:`OELigandEnergy <OESz_OELigandEnergy>` class

   The :ref:`OELigandOptResults <OESz_OELigandOptResults>` class defines the following public methods:
    * :oe:meth:`GetInitialEnergies<OESz::OELigandOptResults::GetInitialEnergies>`
    * :oe:meth:`GetFinalEnergies<OESz::OELigandOptResults::GetFinalEnergies>`
    * :oe:meth:`GetRMSD<OESz::OELigandOptResults::GetRMSD>`
    * :oe:meth:`GetReturnCode<OESz::OELigandOptResults::GetReturnCode>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELigandOptResults()
            OELigandOptResults(const OELigandOptResults&)

      .. oe:language:: python

         .. oe:api:: python

            OELigandOptResults() -> OELigandOptResults
            OELigandOptResults(arg2: OELigandOptResults) -> OELigandOptResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELigandOptResults& operator=(const OELigandOptResults&)

   .. _OESz_OELigandOptResults_GetInitialEnergies:

      Assignment operator.

   .. oe:method:: GetInitialEnergies

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELigandEnergy GetInitialEnergies() const

      .. oe:language:: python

         .. oe:api:: python

            GetInitialEnergies() -> OELigandEnergy

      Returns an object of the :ref:`OELigandEnergy <OESz_OELigandEnergy>` class
      corresponding to the FF energy at the initial (input) geometry.

   .. _OESz_OELigandOptResults_GetFinalEnergies:

   .. oe:method:: GetFinalEnergies

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELigandEnergy GetFinalEnergies() const

      .. oe:language:: python

         .. oe:api:: python

            GetFinalEnergies() -> OELigandEnergy

      Returns an object of the :ref:`OELigandEnergy <OESz_OELigandEnergy>` class
      corresponding to the FF energy at the final (optimized) geometry.

   .. _OESz_OELigandOptResults_GetRMSD:

   .. oe:method:: GetRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetRMSD() -> float

      Returns the RMSD between the initial and final (input and optimized) geometries

   .. _OESz_OELigandOptResults_GetReturnCode:

   .. oe:method:: GetReturnCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetReturnCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetReturnCode() -> int

      Returns one of the values defined in the :oe:constns:`OESz::OESzybkiReturnCode` namespace.



.. oe:namespace:: OESz

.. meta::
   :keywords: OEProteinFlexOptions, ProteinFlexOptions

.. _OESz_OEProteinFlexOptions:

.. oe:class:: OEProteinFlexOptions

   .. oe:api::

      class OEProteinFlexOptions : public OESystem::OEOptions

   This class provides an interface to setup protein flexibility for flexible
   protein optimization, as used in *OEFlexProteinLigandOptimizer*.

   The :ref:`OEProteinFlexOptions <OESz_OEProteinFlexOptions>` class defines the following public methods:
    * :oe:meth:`GetFlexRange<OESz::OEProteinFlexOptions::GetFlexRange>` and
      :oe:meth:`SetFlexRange<OESz::OEProteinFlexOptions::SetFlexRange>`
    * :oe:meth:`GetResidueID<OESz::OEProteinFlexOptions::GetResidueID>` and
      :oe:meth:`SetResidueID<OESz::OEProteinFlexOptions::SetResidueID>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEProteinFlexOptions()
            OEProteinFlexOptions(const OEProteinFlexOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEProteinFlexOptions() -> OEProteinFlexOptions
            OEProteinFlexOptions(arg2: OEProteinFlexOptions) -> OEProteinFlexOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEProteinFlexOptions &operator=(const OEProteinFlexOptions &)

      Assignment operator.

   .. oe:method:: GetFlexRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetFlexRange() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlexRange() -> float

      See :oe:meth:`SetFlexRange<OESz::OEProteinFlexOptions::SetFlexRange>` method.

   .. oe:method:: GetResidueID

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetResidueID() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidueID() -> str

      See :oe:meth:`SetResidueID<OESz::OEProteinFlexOptions::SetResidueID>` method.

   .. oe:method:: SetFlexRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFlexRange(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetFlexRange(value: float) -> bool

      Sets the **flexibility range** for protein flexibility. All the complete residues
      of the protein within the specified range (distance) from the ligand are considered
      flexible. Default: 2.0.

   .. oe:method:: SetResidueID

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetResidueID(const std::string value)

      .. oe:language:: python

         .. oe:api:: python

            SetResidueID(value: str) -> bool

      Sets the **residue ID** of the residues to be treated as flexible, using regular
      expressions. If this is specified, the :oe:meth:`FlexRange<OESz::OEProteinFlexOptions::SetFlexRange>` 
      is ignored. Default: None.


.. oe:namespace:: OESz

.. meta::
   :keywords: OEProteinLigandOptOptions, ProteinLigandOptOptions

.. _OESz_OEProteinLigandOptOptions:

.. oe:class:: OEProteinLigandOptOptions

   .. oe:api::

      class OEProteinLigandOptOptions : public OELigandChargeOptions

   This class provides an interface to setup options required for optimization with 
   :ref:`OEFixedProteinLigandOptimizer <OESz_OEFixedProteinLigandOptimizer>` and :ref:`OEFlexProteinLigandOptimizer <OESz_OEFlexProteinLigandOptimizer>`.

   The following methods are publicly inherited from :ref:`OELigandChargeOptions <OESz_OELigandChargeOptions>`:
    * :oe:meth:`GetGenerateElfConfs<OESz::OELigandChargeOptions::GetGenerateElfConfs>` and
      :oe:meth:`SetGenerateElfConfs<OESz::OELigandChargeOptions::SetGenerateElfConfs>`
    * :oe:meth:`GetLigandCharge<OESz::OELigandChargeOptions::GetLigandCharge>`,
      :oe:meth:`GetLigandChargeType<OESz::OELigandChargeOptions::GetLigandChargeType>`, and
      :oe:meth:`SetLigandCharge<OESz::OELigandChargeOptions::SetLigandCharge>`

   The :ref:`OEProteinLigandOptOptions <OESz_OEProteinLigandOptOptions>` class defines the following public methods:
    * :oe:meth:`GetGradTolerance<OESz::OEProteinLigandOptOptions::GetGradTolerance>` and
      :oe:meth:`SetGradTolerance<OESz::OEProteinLigandOptOptions::SetGradTolerance>`
    * :oe:meth:`GetForceField<OESz::OEProteinLigandOptOptions::GetForceField>` and
      :oe:meth:`SetForceField<OESz::OEProteinLigandOptOptions::SetForceField>`
    * :oe:meth:`GetMaxIter<OESz::OEProteinLigandOptOptions::GetMaxIter>` and
      :oe:meth:`SetMaxIter<OESz::OEProteinLigandOptOptions::SetMaxIter>`
    * :oe:meth:`GetNonBondCutoff<OESz::OEProteinLigandOptOptions::GetNonBondCutoff>` and
      :oe:meth:`SetNonBondCutoff<OESz::OEProteinLigandOptOptions::SetNonBondCutoff>`
    * :oe:meth:`GetOptimizationType<OESz::OEProteinLigandOptOptions::GetOptimizationType>` and
      :oe:meth:`SetOptimizationType<OESz::OEProteinLigandOptOptions::SetOptimizationType>`
    * :oe:meth:`GetSolventModel<OESz::OEProteinLigandOptOptions::GetSolventModel>` and
      :oe:meth:`SetSolventModel<OESz::OEProteinLigandOptOptions::SetSolventModel>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEProteinLigandOptOptions()
            OEProteinLigandOptOptions(const OEProteinLigandOptOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEProteinLigandOptOptions() -> OEProteinLigandOptOptions
            OEProteinLigandOptOptions(arg2: OEProteinLigandOptOptions) -> OEProteinLigandOptOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEProteinLigandOptOptions &operator=(const OEProteinLigandOptOptions &)

   ..   _OESz_OEProteinLigandOptOptions_GetGradTolerance:

      Assignment operator.

   .. oe:method:: GetGradTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetGradTolerance() const

      .. oe:language:: python

         .. oe:api:: python

            GetGradTolerance() -> float

      See :oe:meth:`SetGradTolerance<OESz::OEProteinLigandOptOptions::SetGradTolerance>` method.

   ..   _OESz_OEProteinLigandOptOptions_GetForceField:

   .. oe:method:: GetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFF::OEComplexFF* GetForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEComplexFF

      See :oe:meth:`SetForceField<OESz::OEProteinLigandOptOptions::SetForceField>` method.

   ..   _OESz_OEProteinLigandOptOptions_GetMaxIter:

   .. oe:method:: GetMaxIter

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxIter() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxIter() -> int

      See :oe:meth:`SetMaxIter<OESz::OEProteinLigandOptOptions::SetMaxIter>` method.

   ..   _OESz_OEProteinLigandOptOptions_GetNonBondCutoff:

   .. oe:method:: GetNonBondCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetNonBondCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetNonBondCutoff() -> float

      See :oe:meth:`SetNonBondCutoff<OESz::OEProteinLigandOptOptions::SetNonBondCutoff>` method.

   ..   _OESz_OEProteinLigandOptOptions_GetOptimizationType:

   .. oe:method:: GetOptimizationType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetOptimizationType() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationType() -> int

      See :oe:meth:`SetOptimizationType<OESz::OEProteinLigandOptOptions::SetOptimizationType>` method.

   ..   _OESz_OEProteinLigandOptOptions_GetSolventModel:

   .. oe:method:: GetSolventModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetSolventModel() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolventModel() -> int

      See :ref:`SetSolventModel <OESz_OEProteinLigandOptOptions_SetSolventModel>` method.

   ..   _OESz_OEProteinLigandOptOptions_SetGradTolerance:

   .. oe:method:: SetGradTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetGradTolerance(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetGradTolerance(value: float) -> bool

      Sets the **gradient tolerance** for optimization. Default: 1.e-6.

   ..   _OESz_OEProteinLigandOptOptions_SetForceField:

   .. oe:method:: SetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceField(const unsigned)
            bool SetForceField(const std::string&)
            bool SetForceField(const OEFF::OEComplexFF&)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: int) -> bool
            SetForceField(value: str) -> bool
            SetForceField(value: oeistream) -> bool
            SetForceField(value: OEComplexFF) -> bool

      Sets the **force field** for optimization.  The first overload takes an `unsigned` 
      from the :oe:constns:`OESz::OEComplexFFType` namespace, and the second overload
      takes corresponding string values. The final overload allows the use of a user-defined
      :ref:`OEComplexFF <OEFF_OEComplexFF>`. Method returns ``false`` when the invalid selection
      is chosen, ``true`` otherwise.
      **Default:** :oe:const:`OESz::OEComplexFFType::FF14SB_SAGE`

   ..   _OESz_OEProteinLigandOptOptions_SetMaxIter:

   .. oe:method:: SetMaxIter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxIter(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxIter(value: int) -> bool

      Sets the **maximum iterations** for optimization. Default: 1000.

   ..   _OESz_OEProteinLigandOptOptions_SetNonBondCutoff:

   .. oe:method:: SetNonBondCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNonBondCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetNonBondCutoff(value: float) -> bool

      Sets the **Non-bonded interactions cutoff** for optimization.
      Setting a value of ``0.0`` or less assumes that all interactions should be
      included without any cutoff.
      Default: 0.0.

   ..   _OESz_OEProteinLigandOptOptions_SetOptimizationType:

   .. oe:method:: SetOptimizationType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptimizationType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationType(value: int) -> bool

      Sets the **type** for optimization. Allowed methods are defined in the
      :oe:constns:`OESz::OEOptimizationType` namespace.
      Default is :oe:const:`OESz::OEOptimizationType::PoseCartesian`.

   ..   _OESz_OEProteinLigandOptOptions_SetSolventModel:

   .. oe:method:: SetSolventModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSolventModel(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetSolventModel(value: int) -> bool

      Sets the **solvent model to be used** during optimization. Allowed methods are 
      :oe:const:`OESz::OESolventModel::NoSolv` and :oe:const:`OESz::OESolventModel::Sheffield`, 
      as defined in the :oe:constns:`OESz::OESolventModel` namespace.
      Default is :oe:const:`OESz::OESolventModel::NoSolv`.



.. oe:namespace:: OESz

.. meta::
   :keywords: OEProteinLigandOptResults, ProteinLigandOptResults

.. _OESz_OEProteinLigandOptResults:

.. oe:class:: OEProteinLigandOptResults

   .. oe:api::

      class OEProteinLigandOptResults

   This class provides results of optimization of a single conformer of a molecule, obtained 
   from :ref:`OEFixedProteinLigandOptimizer <OESz_OEFixedProteinLigandOptimizer>` and :ref:`OEFlexProteinLigandOptimizer <OESz_OEFlexProteinLigandOptimizer>` calculations.

   The :ref:`OEProteinLigandOptResults <OESz_OEProteinLigandOptResults>` class defines the following public methods:
    * :oe:meth:`GetReturnCode<OESz::OEProteinLigandOptResults::GetReturnCode>`
    * :oe:meth:`GetInitialEnergies<OESz::OEProteinLigandOptResults::GetInitialEnergies>`
    * :oe:meth:`GetFinalEnergies<OESz::OEProteinLigandOptResults::GetFinalEnergies>`
    * :oe:meth:`GetLigandRMSD<OESz::OEProteinLigandOptResults::GetLigandRMSD>`
    * :oe:meth:`GetProteinRMSD<OESz::OEProteinLigandOptResults::GetProteinRMSD>`
    * :oe:meth:`GetTotalRMSD<OESz::OEProteinLigandOptResults::GetTotalRMSD>`

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEProteinLigandOptResults()
            OEProteinLigandOptResults(const OEProteinLigandOptResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEProteinLigandOptResults() -> OEProteinLigandOptResults
            OEProteinLigandOptResults(arg2: OEProteinLigandOptResults) -> OEProteinLigandOptResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEProteinLigandOptResults &operator=(const OEProteinLigandOptResults &)

      Assignment operator.

   .. oe:method:: GetReturnCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetReturnCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetReturnCode() -> int

      Returns the calculation return code, defined in :oe:constns:`OESz::OESzybkiReturnCode` namespace.

   .. oe:method:: GetInitialEnergies

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFF::OEComplexEnergies& GetInitialEnergies() const

      .. oe:language:: python

         .. oe:api:: python

            GetInitialEnergies() -> OEComplexEnergies

      Returns initial energies of the protein-ligand system, before optimization.

   .. oe:method:: GetFinalEnergies

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEFF::OEComplexEnergies& GetFinalEnergies() const

      .. oe:language:: python

         .. oe:api:: python

            GetFinalEnergies() -> OEComplexEnergies

      Returns final energies of the protein-ligand system, after optimization.

   .. oe:method:: GetLigandRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLigandRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandRMSD() -> float

      Returns the RMSD between the initial and final conformations of the ligand.

   .. oe:method:: GetProteinRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetProteinRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinRMSD() -> float

      Returns the RMSD between the initial and final conformations of the protein.

   .. oe:method:: GetTotalRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTotalRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalRMSD() -> float

      Returns the RMSD between the initial and final conformations of the protein-ligand complex.


.. oe:namespace:: OESz

.. meta::
   :keywords: OERestrictionEnergyResult, RestrictionEnergyResult

.. _OESz_OERestrictionEnergyResult:

.. oe:class:: OERestrictionEnergyResult

   .. oe:api::

      class OERestrictionEnergyResult

   Container for restriction energy results for a single conformer.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERestrictionEnergyResult()
            OERestrictionEnergyResult(const OEChem::OEMolBase& argConf)
            OERestrictionEnergyResult(const OERestrictionEnergyResult&)

      .. oe:language:: python

         .. oe:api:: python

            OERestrictionEnergyResult() -> OERestrictionEnergyResult
            OERestrictionEnergyResult(argRes: OERestrictionEnergyResult) -> OERestrictionEnergyResult
            OERestrictionEnergyResult(argConf: Union[OEGraphMol,OEMol,OEQMol]) -> OERestrictionEnergyResult

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERestrictionEnergyResult& operator=(const OERestrictionEnergyResult&)

      Assignment operator.

   .. oe:method:: GetGlobalStrain

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetGlobalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetGlobalStrain() -> float

      Returns the global strain (in kcal/mol) associated with this conformer, due to being restricted.
       
   .. oe:method:: GetLocalStrain

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLocalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetLocalStrain() -> float

      Returns the local strain (in kcal/mol) associated with this conformer, due to being restricted.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

.. meta::
   :keywords: OESingleConfResult, SingleConfResult

.. _OESz_OESingleConfResult:

.. oe:class:: OESingleConfResult

   .. oe:api::

      class OESingleConfResult

   Provides per-conformer access when iterating a
   :ref:`OEFreeFormConfResults <OESz_OEFreeFormConfResults>` object.
   Each item gives properties for the conformer identified by
   :oe:meth:`OESz::OESingleConfResult::GetConfIdx`.

   The :ref:`OESingleConfResult <OESz_OESingleConfResult>` class defines the following public methods:
    * :oe:meth:`GetConfIdx<OESz::OESingleConfResult::GetConfIdx>`
    * :oe:meth:`GetDeltaE<OESz::OESingleConfResult::GetDeltaE>`
    * :oe:meth:`GetDeltaG<OESz::OESingleConfResult::GetDeltaG>`
    * :oe:meth:`GetLnQrotational<OESz::OESingleConfResult::GetLnQrotational>`
    * :oe:meth:`GetLnQvibrational<OESz::OESingleConfResult::GetLnQvibrational>`
    * :oe:meth:`GetMMFFEnergy<OESz::OESingleConfResult::GetMMFFEnergy>`
    * :oe:meth:`GetProbability<OESz::OESingleConfResult::GetProbability>`
    * :oe:meth:`GetRelativeEnergy<OESz::OESingleConfResult::GetRelativeEnergy>`
    * :oe:meth:`GetRelLnQ<OESz::OESingleConfResult::GetRelLnQ>`
    * :oe:meth:`GetRotationalEntropy<OESz::OESingleConfResult::GetRotationalEntropy>`
    * :oe:meth:`GetSolvEnergy<OESz::OESingleConfResult::GetSolvEnergy>`
    * :oe:meth:`GetTotalEnergy<OESz::OESingleConfResult::GetTotalEnergy>`
    * :oe:meth:`GetVibrationalEnergy<OESz::OESingleConfResult::GetVibrationalEnergy>`
    * :oe:meth:`GetVibrationalEntropy<OESz::OESingleConfResult::GetVibrationalEntropy>`

   The :ref:`OESingleConfResult <OESz_OESingleConfResult>` class deprecated public methods:
    * :oe:meth:`GetRMSD<OESz::OESingleConfResult::GetRMSD>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESingleConfResult()
            OESingleConfResult(const OEChem::OEConfBase&)
            OESingleConfResult(const OESingleConfResult&)

      .. oe:language:: python

         .. oe:api:: python

            OESingleConfResult() -> OESingleConfResult
            OESingleConfResult(argConf: OEConfBase) -> OESingleConfResult
            OESingleConfResult(argRes: OESingleConfResult) -> OESingleConfResult

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESingleConfResult& operator=(const OESingleConfResult&)

      Assignment operator.

   .. oe:method:: GetConfIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetConfIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfIdx() -> int

      Returns the conformation id for that conformation.

   .. oe:method:: GetDeltaE

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDeltaE() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeltaE() -> float

      Returns the relative intramolecular energy for that conformation, with respect to 
      the lowest intramolecular energy conformer of the whole ensemble.

   .. oe:method:: GetDeltaG

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDeltaG() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeltaG() -> float

      Returns the free energy of selecting that conformation from the ensemble.
       
   .. oe:method:: GetLnQrotational

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLnQrotational() const

      .. oe:language:: python

         .. oe:api:: python

            GetLnQrotational() -> float

      Returns the natural logarithm of the rotational partition function for that conformation.

   .. oe:method:: GetLnQvibrational

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLnQvibrational() const

      .. oe:language:: python

         .. oe:api:: python

            GetLnQvibrational() -> float

      Returns the natural logarithm of the vibrational partition function for that conformation.

   .. oe:method:: GetMMFFEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMMFFEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetMMFFEnergy() -> float

      Returns the total intermolecular energy of that conformation.

   .. oe:method:: GetProbability

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetProbability() const

      .. oe:language:: python

         .. oe:api:: python

            GetProbability() -> float

      Returns the probability of state associated with this conformation.

   .. oe:method:: GetRelativeEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRelativeEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelativeEnergy() -> float

      Returns the total relative energy (intramolecular + solvation energy ) for that conformation
      with respect to the lowest energy conformer of the whole ensemble.

   .. oe:method:: GetRelLnQ

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRelLnQ() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelLnQ() -> float

      Returns the natural logarithm of the relative vibrational-rotational partition function
      with respect to the lowest free energy conformer: :math:`\ln q_{rel,i} = \ln q_i - \ln q_{ref}`.
      In that formula the reference conformation is the one with the lowest value returned by
      the :oe:meth:`OESz::OESingleConfResult::GetDeltaG` method. This quantity allows us to
      calculate conformer relative free energies analogously to conventional relative energies.

   .. oe:method:: GetRotationalEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRotationalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotationalEntropy() -> float

      Returns the rotational entropy (in J/(mol K)) for that conformation.

   .. oe:method:: GetSolvEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSolvEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolvEnergy() -> float

      Returns the solvation energy for that conformation.

   .. oe:method:: GetTotalEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTotalEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalEnergy() -> float

      Returns the total energy (intramolecular + solvation) for that conformation.

   .. oe:method:: GetVibrationalEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetVibrationalEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetVibrationalEnergy() -> float

      Returns the relative vibrational energy for that conformation, with respect to 
      the lowest vibrational energy conformer of the whole ensemble.

   .. oe:method:: GetVibrationalEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetVibrationalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetVibrationalEntropy() -> float

      Returns the vibrational entropy (in J/(mol K)) for that conformation.

   .. oe:method:: GetRMSD

      .. attention::

        |DEPRECATED-API|

        .. oe:api::

            double GetRMSD() const

      Returns 0.0.  This method has been deprecated since RMSD is not a meaningful 
      quantity for a conformer in an ensemble.



.. _OESzClasses:

*******************
OESz Classes
*******************

.. oe:namespace:: OESz

.. toctree::

   OEBoundEntropyOptions
   OEEntropyResults
   OEFixedProteinLigandOptimizer
   OEFlexProteinLigandOptimizer
   OEFreeFormConf
   OEFreeFormConfAdvanced
   OEFreeFormConfOptions
   OEFreeFormConfResults
   OEFreeFormSolvOptions
   OEFreeFormSolvResults
   OELigandChargeOptions
   OELigandEntropyOptions
   OEProteinFlexOptions
   OEProteinLigandOptOptions
   OEProteinLigandOptResults
   OERestrictionEnergyResult
   OESingleConfResult
   OESzybki
   OESzybkiEnsembleResults
   OESzybkiGeneralOptions
   OESzybkiOptions
   OESzybkiOptOptions
   OESzybkiProteinOptions
   OESzybkiResults
   OESzybkiSolventOptions   
   OETorsionScanOptions
   OETorsionScanResult
   OETorsionScanner


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybki, Szybki

.. _OESz_OESzybki:

.. oe:class:: OESzybki

   .. oe:api::

      class OESzybki

   The primary interface for molecular force field optimization. Supports
   Cartesian, torsional, and solid-body optimization modes with optional
   protein-ligand constraints, solvation models, and entropy calculations.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybki(unsigned int force_field = OEForceFieldType::MMFF94)
            OESzybki(const OESzybkiOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            OESzybki(force_field: int) -> OESzybki
            OESzybki(opts: OESzybkiOptions) -> OESzybki

      The default constructor builds :ref:`OESzybki <OESz_OESzybki>` with the MMFF force field.
      The :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` can be provided as argument with specifying
      many other parameters, including other force fields supported.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESzybki & operator=(const OESzybki &)

      Assignment operator.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESz::OESzybkiResults>* operator()(OEChem::OEMCMolBase& m)
            bool operator()(OEChem::OEMolBase& m, OESz::OESzybkiResults& res)

      .. oe:language:: python

         .. oe:api:: python

            __call__(m: OEMol) -> Iterable[OESzybkiResults]
            __call__(m: Union[OEGraphMol,OEMol,OEQMol], res: OESzybkiResults) -> bool

      The first operator performs geometry optimization on all
      conformers in the passed molecule ``m`` and updates it with
      optimized coordinates. It returns an iterator whose elements are
      :ref:`OESzybkiResults <OESz_OESzybkiResults>` objects. :ref:`OESzybkiResults <OESz_OESzybkiResults>` contains the energy
      values of the relevant potential terms, total energies and
      gradients. The description of the  :ref:`OESzybkiResults <OESz_OESzybkiResults>` structure is given
      below. The second operator performs the same task on a molecule
      in a single conformation. A reference to an instance of
      OESzybkiResults structure has to be passed. If the calculation
      fails the operator returns ``false``.

   .. oe:method:: ClearFixAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearFixAtoms()

      .. oe:language:: python

         .. oe:api:: python

            ClearFixAtoms() -> None

      Removes the ``fix`` constraint on any fixed atoms. After the use of this function, positions of all
      atoms could change upon optimization.

   .. oe:method:: ClearHarmonicConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ClearHarmonicConstraints()

      .. oe:language:: python

         .. oe:api:: python

            ClearHarmonicConstraints() -> bool

      Removes harmonic constraints. Returns ``true`` if constraints were removed and ``false`` when the action
      was not necessary because a constraining potential was not present.

   .. oe:method:: ClearTorsionConstraint

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ClearTorsionConstraint()

      .. oe:language:: python

         .. oe:api:: python

            ClearTorsionConstraint() -> bool

      Removes torsion constraint. Returns ``true`` if constraint is removed and ``false`` when the action was not
      necessary because a constraining potential was not present.

   .. oe:method:: FixAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool FixAtoms(std::string smarts_pattern)
            bool FixAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &)

      .. oe:language:: python

         .. oe:api:: python

            FixAtoms(smarts_pattern: str) -> bool
            FixAtoms(arg2: OEUnaryAtomPred) -> bool

      Fixes a set of atoms at their initial positions in space. The first function fixes
      a set of atoms which belong to a SMARTS pattern determined by the parameter
      ``smarts_pattern``. It returns ``true`` if the SMARTS string passed is valid, ``false``
      otherwise. The second function fixes only those atoms for which the predicate passed
      is ``true``, and returns ``true`` if the predicate is valid.

   .. oe:method:: GetEntropy(const OEChem::OEMCMolBase&, unsigned int, unsigned int)

      .. oe:api::

         double GetEntropy(const OEChem::OEMCMolBase &m,
                           unsigned int method = OEEntropyMethod::QNewton,
                           unsigned int env = OEEnvType::SolutionSPT)

      Estimates and returns the entropy of a compound in different environments for an ensemble of
      conformations given in the input molecule ``m``. The method does not alter the input set of
      conformations. The default parameter ``method`` specifies that the method of entropy evaluation
      is quasi-Newton. The alternative value for this parameter is
      :oe:const:`OESz::OEEntropyMethod::Analytic`. The last parameter in both methods specifies ligand
      environment. Its default value refers to the ligand in solution where solvation entropy is
      handled by scaled-particle theory (SPT). The remaining possible values of the parameter ``env``
      are: :oe:const:`OESz::OEEnvType::Gas`, :oe:const:`OESz::OEEnvType::Protein` and
      :oe:const:`OESz::OEEnvType::SolutionSA` which specify gas-phase, protein-bound and solution ligand,
      respectively. In the case of :oe:const:`OESz::OEEnvType::SolutionSA` the solvation entropy is
      evaluated with the "Surface Area" model, however we recommend the default which uses SPT.

      .. deprecated:: 1.8.2
         Use overloaded :oe:meth:`OESz::OESzybki::GetEntropy` instead.

   .. oe:method:: GetEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEntropy(OEChem::OEMCMolBase& m,
                              OESzybkiEnsembleResults& r,
                              unsigned int method = OEEntropyMethod::QNewton,
                              unsigned int env = OEEnvType::SolutionSPT)

      .. oe:language:: python

         .. oe:api:: python

            GetEntropy(m: OEMol, r: OESzybkiEnsembleResults, method: int,
                       env: int) -> float

      Estimates and returns the entropy of a compound in different environments for an ensemble of
      conformations given in the input molecule ``m``. The set of optimized unique conformations is
      returned in the first parameter ``m``.  The method takes the reference of the
      :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` object ``r`` which carries the entropy results for the
      ensemble. The default parameter ``method`` specifies that the method of vibrational entropy
      evaluation is based on second derivatives matrix (Hessian) which is taken from the final
      step of quasi-Newton optimization. The alternative value for this parameter is
      :oe:const:`OESz::OEEntropyMethod::Analytic`. When the latter is selected, Hessian matrix is
      calculated analytically. The last parameter specifies ligand environment. Its default value
      refers to the ligand in solution where solvation entropy is handled by scaled-particle theory
      (SPT). The remaining possible values of the parameter ``env`` are:
      :oe:const:`OESz::OEEnvType::Gas`, :oe:const:`OESz::OEEnvType::Protein` and
      :oe:const:`OESz::OEEnvType::SolutionSA` which specify gas-phase, protein-bound and solution
      ligand respectively. In the case of :oe:const:`OESz::OEEnvType::SolutionSA` the solvation
      entropy is evaluated with the "Surface Area" model, however we recommend the default which
      uses SPT.

   .. oe:method:: GetFixPattern

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetFixPattern() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixPattern() -> str

      Returns the SMARTS string used for fixing atoms.

   .. oe:method:: GetFixPredicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* GetFixPredicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixPredicate() -> OEUnaryAtomPred

      Returns a pointer to the predicate used to determine which atoms are fixed.

   .. oe:method:: GetHarmonicConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> *
            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* GetHarmonicConstraints(double& kc,
                                                                                         double& kd) const

      .. oe:language:: python

         .. oe:api:: python

            GetHarmonicConstraints() -> (kc: float, kd: float, pred: OEUnaryAtomPred)

      Provides a method to query for the harmonic constraint used, the force constant ``kc``,
      and distance ``kd``. The function returns a pointer to a predicate which determines which
      atoms are constrained.  If the returned pointer is 0, then no harmonic constraints are used.

   .. oe:method:: GetProtein

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetProtein(OEChem::OEMolBase& p) const

      .. oe:language:: python

         .. oe:api:: python

            GetProtein(p: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Copies the current protein molecule to the passed molecule object ``p``. If the :ref:`OESzybki <OESz_OESzybki>`
      object does not hold a protein molecule, the function will return ``false``.

   .. oe:method:: GetSheffieldParameters

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetSheffieldParameters(double& a, double& b, double& dc) const

      .. oe:language:: python

         .. oe:api:: python

            GetSheffieldParameters() -> (a: float, b: float, dc: float)

      Returns the Sheffield solvation model parameters which are currently used.

   .. oe:method:: LoadPotentialGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            void LoadPotentialGrid(const std::string& fname)

      .. oe:language:: python

         .. oe:api:: python

            LoadPotentialGrid(fname: str) -> None

      Reads a pre-calculated potential grid from the file name ``fname``. For a large number of ligands to be
      optimized inside a single protein with the use of the electrostatic model
      :oe:const:`OESz::OEProteinElectrostatics::GridPB` or
      :oe:const:`OESz::OEProteinElectrostatics::GridCoulomb`
      (see function :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinElectrostaticModel`),
      this function offers a significant saving in CPU time.

   .. oe:method:: SavePotentialGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SavePotentialGrid(const std::string& fname)

      .. oe:language:: python

         .. oe:api:: python

            SavePotentialGrid(fname: str) -> None

      Saves potential grid in the file named ``fname``. The potential grid will be generated in protein-ligand
      calculations in which electrostatic model used is :oe:const:`OESz::OEProteinElectrostatics::GridPB` or
      :oe:const:`OESz::OEProteinElectrostatics::GridCoulomb` set with the function
      :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinElectrostaticModel`.

   .. oe:method:: SetHarmonicConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetHarmonicConstraints(double kc, double kd = 0.0,
                                        const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred = OEChem::OEIsHeavy())

      .. oe:language:: python

         .. oe:api:: python

            SetHarmonicConstraints(kc: float, kd: float = 0.0,
                                   pred: OEUnaryAtomPred = OEIsHeavy()) -> bool

      Adds potential term :math:`V=k_c(r - k_d)^2` for every atom for which the passed
      predicate operator returns ``true``. Default predicate imposes
      harmonic potential on
      every heavy atom. Parameter ``kc`` is the force constant :math:`k_c` (in :math:`kcal/(mol |A|^2)`
      and ``kd`` is the constraining
      distance :math:`k_d` in |A|. By default ``kd`` is set to 0. Function returns ``true`` if
      harmonic potential added.

   .. oe:method:: SetProtein

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetProtein(const OEChem::OEMolBase& protein)

      .. oe:language:: python

         .. oe:api:: python

            SetProtein(protein: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets the protein molecule for subsequent szybki calculations. The protein
      molecule may be modified by this operation, if needed.  It returns ``false`` if the operation fails, otherwise ``true``.

   .. note::

      To specify charging options for protein-ligand coulombic interactions, use the :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine` method under the :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>` class. To work with the pre-existing charges, use the :ref:`OEChargeEngineNoOp <OEProton_OEChargeEngineNoOp>` as the charging engine.

   .. oe:method:: SetSheffieldParameters

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSheffieldParameters(double a, double b, double dc = 1.0)

      .. oe:language:: python

         .. oe:api:: python

            SetSheffieldParameters(a: float, b: float, indi: float = 1.0) -> None

      Sheffield solvation energy requires two parameters :math:`a` and :math:`b`:
      :math:`E_{solv} = -\frac{f_\epsilon}{8\pi \epsilon_0}\sum_{i,j}\frac{q_iq_j}{\sqrt{(aR_iR_j + br_{ij}^2)}}`
      where :math:`q_i` and :math:`q_j` are atomic charges, :math:`R_i` and
      :math:`R_j` are vdW radii for atoms :math:`i` and :math:`j`, and :math:`r_{ij}` is the
      interatomic distance. Parameter :math:`f_\epsilon` depends on dielectric constants of the solute
      (:math:`\epsilon`) and the solvent (:math:`\epsilon_{solv}`):
      :math:`f_\epsilon = 1/\epsilon - 1/\epsilon_{solv})`. This function sets both parameters :math:`a` and
      :math:`b` to the required values, as well as the solute dielectric constant (which may not exceed 10).
      If the function not used, the solute dielectric constant is set to 1.0, and the default values
      of :math:`a = 1.553149` and :math:`b = 0.735694` are adopted ([Grant-2007]_).

.. _OESz_OESzybki_SetTorsionConstraint:

   .. oe:method:: SetTorsionConstraint

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTorsionConstraint(const std::string& tor_pattern, double k,
                                      double phi0)
            bool SetTorsionConstraint(const OEChem::OETorsion& tor, double k)

      .. oe:language:: python

         .. oe:api:: python

            SetTorsionConstraint(tor_pattern: str, k: float, phi0: float) -> bool
            SetTorsionConstraint(tor: OETorsion, k: float) -> bool

      The method adds a potential term :math:`V=k_c(cos(phi) -
      cos(phi0))^2` for a torsion. The first method specifies the torsion
      with a SMARTS pattern passed as a string ``tor pattern``. This must be
      in the indexed form which show which atoms forms the torsion. For
      example a valid pattern is ``[C:1][N:2][c:3][s:4]``. ``k`` is the user
      specified force field in kcal/mol, and ``phi0`` is the torsion
      reference dihedral angle in radians. The function returns ``true`` if
      a torsion constraint is added successfully.

      The second method takes an instance of an
      :ref:`OETorsion <OEChem_OETorsion>` object, ``tor``, which defines a single
      torsion to be constrained. ``k`` is the user specified force field in
      kcal/mol. The function returns ``true`` if a constrained torsion is
      added successfully.

   .. oe:method:: UnsetProtein

      .. oe:language:: c++ java csharp

         .. oe:api::

            void UnsetProtein() const

      .. oe:language:: python

         .. oe:api:: python

            UnsetProtein() -> None

      Removes protein context from the :ref:`OESzybki <OESz_OESzybki>` object.



.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiEnsembleResults, SzybkiEnsembleResults

.. _OESz_OESzybkiEnsembleResults:

.. oe:class:: OESzybkiEnsembleResults

   .. oe:api::

      class OESzybkiEnsembleResults

   Container for ensemble geometry optimization results.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiEnsembleResults()
            OESzybkiEnsembleResults(const OESzybkiEnsembleResults &)

      .. oe:language:: python

         .. oe:api:: python

            OESzybkiEnsembleResults() -> OESzybkiEnsembleResults
            OESzybkiEnsembleResults(arg2: OESzybkiEnsembleResults) -> OESzybkiEnsembleResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESzybkiEnsembleResults &operator=(const OESzybkiEnsembleResults &)

      Assignment operator.

   .. oe:method:: NumConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumConfs() const

      .. oe:language:: python

         .. oe:api:: python

            NumConfs() -> int

      Returns the number of unique conformations in the ensemble.

   .. oe:method:: GetTemperature

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTemperature() const

      .. oe:language:: python

         .. oe:api:: python

            GetTemperature() -> float

      Returns the temperature in K. This is a convenience method returning the
      same information as the method of the same name in the OESzybki class.

   .. oe:method:: GetTotalEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTotalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalEntropy() -> float

      Returns the total entropy of the ligand in J/(mol K).   

   .. oe:method:: GetEntropicEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEntropicEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetEntropicEnergy() -> float

      Returns the product of total entropy and temperature, :math:`ST` in kcal/mol.

   .. oe:method:: GetChargeType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetChargeType() const

      .. oe:language:: python

         .. oe:api:: python

            GetChargeType() -> int

      Returns the type of atomic partial charges used in entropy estimation.
      The returned type are is either :oe:const:`OEProton::OECharges::AM1BCCNoSymSPt`
      or :oe:const:`OEProton::OECharges::NoOp`.

   .. oe:method:: GetConfigurationalEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetConfigurationalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfigurationalEntropy() -> float

      Returns the ensemble configurational entropy. For gas-phase ligands that value is 
      the same as the value returned by :oe:meth:`OESz::OESzybkiEnsembleResults::GetTotalEntropy`. 
      For solution ligands the configurational entropy made by translational-vibrational-rotational 
      entropy, and for protein-bound ligands it represents vibrational entropy.

   .. oe:method:: GetEnsembleLigSolvEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEnsembleLigSolvEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnsembleLigSolvEntropy() -> float

      Returns the value of the ensemble solvation entropy for a ligand in solution. The method
      returns zero for gas-phase and protein-bound ligands.

   .. oe:method:: GetEnsembleLigPartialSolvEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEnsembleLigPartialSolvEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnsembleLigPartialSolvEntropy() -> float

      Returns the value of solvation entropy for the protein-bound ligand partially exposed to solvent.

   .. oe:method:: GetEnsembleProtDesolvEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEnsembleProtDesolvEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnsembleProtDesolvEntropy() -> float

      Returns the value of protein desolvation entropy upon ligand binding.

   .. oe:method:: GetResultsForConformations

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESzybkiResults>* GetResultsForConformations() const

      .. oe:language:: python

         .. oe:api:: python

            GetResultsForConformations() -> Iterable[OESzybkiResults]

      Returns the iterator whose elements are :ref:`OESzybkiResults <OESz_OESzybkiResults>` objects for
      the ensemble of conformation members optimized during the entropy estimation. Data only for
      unique conformations are represented in the returned set.   

   .. oe:method:: HasEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            HasEntropy() -> bool

      Returns ``true`` if the :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` object contains calculated
      entropy, ``false`` is returned otherwise. 


.. _preliminary_OESzClasses:

*************************
Preliminary OESz Classes
*************************

.. oe:namespace:: OESz

.. toctree::

   OELigandEnergy
   OELigandOptOptions
   OELigandOptResults
   OETorConstraintOptOptions
   OETorConstraintOptimizer


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

.. meta::
   :keywords: OETorConstraintOptOptions

.. _OESz_OETorConstraintOptOptions:

.. oe:class:: OETorConstraintOptOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OETorConstraintOptOptions

   This class provides an interface to modify the options for an all-torsion-constrained optimization of a ligand molecule.

   .. seealso::

      * :ref:`OELigandOptOptions <OESz_OELigandOptOptions>` class

   The :ref:`OETorConstraintOptOptions <OESz_OETorConstraintOptOptions>` class inherits the following methods from the :ref:`OELigandOptOptions <OESz_OELigandOptOptions>` class.
    * :oe:meth:`GetForceField<OESz::OELigandOptOptions::GetForceField>`
    * :oe:meth:`GetForceFieldType<OESz::OELigandOptOptions::GetForceFieldType>`
    * :oe:meth:`GetLigandCharge<OESz::OELigandOptOptions::GetLigandCharge>`
    * :oe:meth:`GetLigandChargeType<OESz::OELigandOptOptions::GetLigandChargeType>`
    * :oe:meth:`GetNonBondCutoff<OESz::OELigandOptOptions::GetNonBondCutoff>`
    * :oe:meth:`GetGradTolerance<OESz::OELigandOptOptions::GetGradTolerance>`
    * :oe:meth:`GetMaxIter<OESz::OELigandOptOptions::GetMaxIter>`
    * :oe:meth:`GetSolventModel<OESz::OELigandOptOptions::GetSolventModel>`
    * :oe:meth:`SetForceField<OESz::OELigandOptOptions::SetForceField>`
    * :oe:meth:`SetLigandCharge<OESz::OELigandOptOptions::SetLigandCharge>`
    * :oe:meth:`SetNonBondCutoff<OESz::OELigandOptOptions::SetNonBondCutoff>`
    * :oe:meth:`SetGradTolerance<OESz::OELigandOptOptions::SetGradTolerance>`
    * :oe:meth:`SetMaxIter<OESz::OELigandOptOptions::SetMaxIter>`
    * :oe:meth:`SetSolventModel<OESz::OELigandOptOptions::SetSolventModel>`

   The :ref:`OETorConstraintOptOptions <OESz_OETorConstraintOptOptions>` class defines the following public methods:
    * :oe:meth:`GetPenaltyForceConstant<OESz::OETorConstraintOptOptions::GetPenaltyForceConstant>`
    * :oe:meth:`GetUseInternalCoord<OESz::OETorConstraintOptOptions::GetUseInternalCoord>`
    * :oe:meth:`SetPenaltyForceConstant<OESz::OETorConstraintOptOptions::SetPenaltyForceConstant>`
    * :oe:meth:`SetUseInternalCoord<OESz::OETorConstraintOptOptions::SetUseInternalCoord>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorConstraintOptOptions()
            OETorConstraintOptOptions(const OETorConstraintOptOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OETorConstraintOptOptions() -> OETorConstraintOptOptions
            OETorConstraintOptOptions(arg2: OETorConstraintOptOptions) -> OETorConstraintOptOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETorConstraintOptOptions& operator=(const OETorConstraintOptOptions&)

.. _OESz_OETorConstraintOptOptions_GetPenaltyForceConstant:

      Assignment operator.

   .. oe:method:: GetPenaltyForceConstant

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPenaltyForceConstant() const

      .. oe:language:: python

         .. oe:api:: python

            GetPenaltyForceConstant() -> float

      See :ref:`SetPenaltyForceConstant <OESz_OETorConstraintOptOptions_SetPenaltyForceConstant>` method.

.. _OESz_OETorConstraintOptOptions_GetUseInternalCoord:

   .. oe:method:: GetUseInternalCoord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseInternalCoord() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseInternalCoord() -> bool

      See :ref:`SetUseInternalCoord <OESz_OETorConstraintOptOptions_SetUseInternalCoord>` method.

.. _OESz_OETorConstraintOptOptions_SetPenaltyForceConstant:

   .. oe:method:: SetPenaltyForceConstant

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPenaltyForceConstant(double pfc)

      .. oe:language:: python

         .. oe:api:: python

            SetPenaltyForceConstant(value: float) -> bool

      Overwrites the default value (``1e4``) for force constant in dihedral angle constraint
      used for optimization.  Method returns ``false`` if invalid value of force
      constant is passed.

.. _OESz_OETorConstraintOptOptions_SetUseInternalCoord:

   .. oe:method:: SetUseInternalCoord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseInternalCoord(bool useInt)

      .. oe:language:: python

         .. oe:api:: python

            SetUseInternalCoord(value: bool) -> bool

      When the parameter ``useInt`` is set to ``true``, optimization is performed in internal coordinates.
      Overwrites a default method for torsion constraint, which  applies a large enough penalty force
      to keep the value of the dihedral angle constant during optimization.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

.. meta::
   :keywords: OETorConstraintOptimizer

.. _OESz_OETorConstraintOptimizer:

.. oe:class:: OETorConstraintOptimizer

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OETorConstraintOptimizer

   This class provides an interface to perform an all-torsion-constrained optimization of a ligand molecule.

   .. seealso::

      * :ref:`OELigandOptResults <OESz_OELigandOptResults>` class

   The :ref:`OETorConstraintOptimizer <OESz_OETorConstraintOptimizer>` class defines the following public methods:
    * :oe:meth:`Setup<OESz::OETorConstraintOptimizer::Setup>`
    * :oe:meth:`Optimize<OESz::OETorConstraintOptimizer::Optimize>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorConstraintOptimizer(const OETorConstraintOptOptions& opts = OETorConstraintOptOptions())
            OETorConstraintOptimizer(const OETorConstraintOptimizer&)

      .. oe:language:: python

         .. oe:api:: python

            OETorConstraintOptimizer(opts: OETorConstraintOptOptions = OETorConstraintOptOptions()) -> OETorConstraintOptimizer
            OETorConstraintOptimizer(arg2: OETorConstraintOptimizer) -> OETorConstraintOptimizer

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETorConstraintOptimizer& operator=(const OETorConstraintOptimizer&)

.. _OESz_OETorConstraintOptimizer_Setup:

      Assignment operator.

   .. oe:method:: Setup

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Setup(OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Setup(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Method to setup molecule for an all-torsions-constrained optimization

.. _OESz_OETorConstraintOptimizer_Optimize:

   .. oe:method:: Optimize

      .. oe:language:: c++ java csharp

         .. oe:api::

            double Optimize(OEChem::OEMolBase& mol,
                            const OEChem::OETorsion& torsion) const
            double Optimize(OEChem::OEMolBase& mol) const
            unsigned Optimize(OELigandOptResults& res, OEChem::OEMolBase& mol,
                              const OEChem::OETorsion& torsion)
            unsigned Optimize(OELigandOptResults& res, OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Optimize(mol: Union[OEGraphMol,OEMol,OEQMol], torsion: OETorsion) -> float
            Optimize(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float
            Optimize(res: OELigandOptResults,
                     mol: Union[OEGraphMol,OEMol,OEQMol], torsion: OETorsion) -> int
            Optimize(res: OELigandOptResults,
                     mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Optimize the ligand. If an instance ref:`OELigandOptResults <OESz_OELigandOptResults` class is passed, it is populated
      with the results and a value from the :oe:constns:`OESz::OESzybkiReturnCode` namespace reporting the success or
      failure of the calculation is returned. Is not, the final optimized energy is returned.



.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiGeneralOptions, SzybkiGeneralOptions

.. _OESz_OESzybkiGeneralOptions:

.. oe:class:: OESzybkiGeneralOptions

   .. oe:api::

      class OESzybkiGeneralOptions : public OESystem::OEOptions

   This class represents general options for szybki.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiGeneralOptions()
            OESzybkiGeneralOptions(const OESzybkiGeneralOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESzybkiGeneralOptions() -> OESzybkiGeneralOptions
            OESzybkiGeneralOptions(arg2: OESzybkiGeneralOptions) -> OESzybkiGeneralOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESzybkiGeneralOptions &operator=(const OESzybkiGeneralOptions &)

      Assignment operator.

   .. oe:method:: GetCalculateGradients

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCalculateGradients() const

      .. oe:language:: python

         .. oe:api:: python

            GetCalculateGradients() -> bool

      Returns the state of the calculate gradients flag. If true, OESzybki will calculate and
      report gradients.

   .. oe:method:: GetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMolPotential::OEForceField* GetForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEForceField

      Returns the pointer to the :ref:`OEForceField <OEMolPotential_OEForceField>` object which was used in the
      method :oe:meth:`OESz::OESzybkiGeneralOptions::SetForceField`. 

   .. oe:method:: GetForceFieldType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceFieldType() -> int

      Returns the force field type to be used for OESzybki calculations, as `unsigned int` 
      from the :oe:constns:`OESz::OEForceFieldType` namespace.

   .. oe:method:: GetIEFFCluster

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetIEFFCluster() const

      .. oe:language:: python

         .. oe:api:: python

            GetIEFFCluster() -> bool

      Returns the state of the IEFF cluster flag. If true, OESzybki will optimize a cluster
      of molecules with the MMFF94-IEFF or MMFF94S-IEFF force field.

   .. oe:method:: GetIntramolecularVdWCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetIntramolecularVdWCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetIntramolecularVdWCutoff() -> float

      Returns the value of the intramolecular vdW interactions cutoff. The intramolecular VdW interactions
      are considered to be zero between atoms that are separated by distances larger than the cutoff.

   .. oe:method:: GetLigandRMSDHeavy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetLigandRMSDHeavy() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandRMSDHeavy() -> bool

      Returns the state of the Ligand RMSD heavy flag. If true, OESzybki reports RMSD for the
      optimized molecular systems based on heavy atoms only.

   .. oe:method:: GetRemoveAttractiveVdWForces

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRemoveAttractiveVdWForces() const

      .. oe:language:: python

         .. oe:api:: python

            GetRemoveAttractiveVdWForces() -> bool

      Returns the state of the Remove Attractive VdW Forces terms flag. If true, OESzybki removes the 
      attractive part of the VdW interaction terms from the force field for calculations.

   .. oe:method:: GetRemoveCoulombTerms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRemoveCoulombTerms() const

      .. oe:language:: python

         .. oe:api:: python

            GetRemoveCoulombTerms() -> bool

      Returns the state of the Remove Coloumb terms flag. If true, OESzybki removes the Coulomb terms 
      from the force field for calculations.

   .. oe:method:: GetSoluteDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSoluteDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetSoluteDielectric() -> float

      Returns the value of ligand dielectric constant used for the optimization of ligand in
      solution.

   .. oe:method:: GetTemperature

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTemperature() const

      .. oe:language:: python

         .. oe:api:: python

            GetTemperature() -> float

      Returns the value of temperature to be used for entropy calculation, in units of kelvins.

   .. oe:method:: GetVerbose

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetVerbose() const

      .. oe:language:: python

         .. oe:api:: python

            GetVerbose() -> bool

      Returns the state of the verbose flag. If true, OESzybki is set for reporting optimization 
      progress.

   .. oe:method:: SetCalculateGradients

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCalculateGradients(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetCalculateGradients(value: bool) -> bool

      Sets the state of the calculate gradients flag. If ``true`` is passed, OESzybki will calculate and
      report gradients. 

   .. oe:method:: SetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceField(const OEMolPotential::OEForceField& value)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: OEForceField) -> bool

      Sets the force field to be used for OESzybki calculations, using an instance of 
      :ref:`OEForceField<OEMolPotential_OEForceField>`. This method provids an alternative
      to setting force field by a predefined type with 
      :oe:meth:`OESz::OESzybkiGeneralOptions::SetForceFieldType`.
      Method returns ``true`` when the setting is successful, ``false`` otherwise.
      
   .. oe:method:: SetForceFieldType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceFieldType(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetForceFieldType(value: int) -> bool

      Sets the force field to be used for OESzybki calculations, using constants 
      defined in the :oe:constns:`OESz::OEForceFieldType` namespace. This method 
      provids an alternative to setting force field by a force field instance with 
      :oe:meth:`OESz::OESzybkiGeneralOptions::SetForceField`.
      Method returns ``true`` when the setting is successful, ``false`` otherwise.

   .. oe:method:: SetIEFFCluster

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIEFFCluster(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetIEFFCluster(value: bool) -> bool

      Sets the state of the IEFF cluster flag. If ``true`` is passed, OESzybki will optimize a cluster
      of molecules with the MMFF94-IEFF or MMFF94S-IEFF force field. 

   .. oe:method:: SetIntramolecularVdWCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIntramolecularVdWCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetIntramolecularVdWCutoff(value: float) -> bool

      Sets the value of the intramolecular vdW interactions. The intramolecular VdW interactions
      are considered to be zero between atoms that are separated by distances larger than the cutoff.
      By default no cutoff is used.

   .. oe:method:: SetLigandRMSDHeavy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLigandRMSDHeavy(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetLigandRMSDHeavy(value: bool) -> bool

      Sets the state of the Ligand RMSD heavy flag. If ``true`` is passed, OESzybki reports RMSD for the
      optimized molecular systems based on heavy atoms only.  By default, RMSD is calculated based
      on all atoms.

   .. oe:method:: SetRemoveAttractiveVdWForces

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRemoveAttractiveVdWForces(const bool value)

      .. oe:language:: python

         .. oe:api:: python

            SetRemoveAttractiveVdWForces(value: bool) -> bool

      Sets the state of the Remove Attractive VdW Forces terms flag. If true, OESzybki removes the 
      attractive part of the VdW interaction terms from the force field for calculations.

   .. oe:method:: SetRemoveCoulombTerms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRemoveCoulombTerms(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRemoveCoulombTerms(value: bool) -> bool

      Sets the state of the Remove Coloumb terms flag. If ``true`` is passed, OESzybki removes the Coulomb 
      terms from the force field for calculations.

   .. oe:method:: SetSoluteDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSoluteDielectric(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetSoluteDielectric(value: float) -> bool

      Sets the value of ligand dielectric constant used for the optimization of ligand in
      solution.

   .. oe:method:: SetTemperature

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTemperature(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetTemperature(value: float) -> bool

      Returns the value of temperature to be used for entropy calculation, in units of kelvins.
      The default temperature is set to 298.15K.

   .. oe:method:: SetVerbose

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetVerbose(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetVerbose(value: bool) -> bool

      Sets the state of the verbose flag. If ``true`` is passed, OESzybki is set for reporting optimization 
      progress.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiOptOptions, SzybkiOptOptions

.. _OESz_OESzybkiOptOptions:

.. oe:class:: OESzybkiOptOptions

   .. oe:api::

      class OESzybkiOptOptions : public OESystem::OEOptions

   This class represents optimization related options for szybki.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiOptOptions()
            OESzybkiOptOptions(const OESzybkiOptOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESzybkiOptOptions() -> OESzybkiOptOptions
            OESzybkiOptOptions(arg2: OESzybkiOptOptions) -> OESzybkiOptOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESzybkiOptOptions &operator=(const OESzybkiOptOptions &)

      Assignment operator.

   .. oe:method:: GetCalculateFrozenTerms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCalculateFrozenTerms() const

      .. oe:language:: python

         .. oe:api:: python

            GetCalculateFrozenTerms() -> bool

      Returns the state of the calculate frozen terms flag. If true, OESzybki will include the 
      constant energy terms in the final optimized energy.

   .. oe:method:: GetGradTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetGradTolerance() const

      .. oe:language:: python

         .. oe:api:: python

            GetGradTolerance() -> float

      Returns the optimizer gradient convergence criterion defined as RMS gradient in kcal/(mol |A|).

   .. oe:method:: GetMaxIter

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxIter() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxIter() -> int

      Returns the value of maximum number of optimizer iterations.

   .. oe:method:: GetOptimizerType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetOptimizerType() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizerType() -> int

      Returns the optimizer type to be used, as as `unsigned int` 
      from the :oe:constns:`OESz::OEOptType` namespace.

   .. oe:method:: SetCalculateFrozenTerms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCalculateFrozenTerms(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetCalculateFrozenTerms(value: bool) -> bool

      Allows the omission of the energy calculation of the fixed terms at the end of the optimization.
      This situation occurs when adaptors are used. By default constant energy terms are calculated
      for the optimized structure and added to the total energy.

   .. oe:method:: SetGradTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetGradTolerance(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetGradTolerance(value: float) -> bool

      Sets the optimizer gradient convergence criterion defined as RMS gradient in kcal/(mol |A|). 
      If not set by the user a 0.1 value threshold for gradient
      norm :math:`\sqrt{\sum_i {g_ig_i} }`, will be used as termination criteria for all
      optimization types but Newton-Raphson. In the case of the latter the default gradient tolerance
      is RMS gradient of 1e-5 kcal/(mol |A|).

   .. oe:method:: SetMaxIter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxIter(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxIter(value: int) -> bool

      Sets the value of maximum number of optimizer iterations. The default value is set to 1000.

   .. oe:method:: SetOptimizerType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptimizerType(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizerType(value: int) -> bool

      Selects the type of the optimization which will be used for optimization. The available
      values are defined in  the :oe:constns:`OESz::OEOptType` namespace.
      Method returns ``false`` when the invalid selection is chosen, ``true`` otherwise.



.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiOptions, SzybkiOptions

.. _OESz_OESzybkiOptions:

.. oe:class:: OESzybkiOptions

   .. oe:api::

      class OESzybkiOptions : public OESystem::OEOptions

   Configuration options for :ref:`OESzybki <OESz_OESzybki>` optimizations,
   including force field selection, run type, optimizer algorithm, solvation
   model, and entropy method.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiOptions()
            OESzybkiOptions(const OESzybkiOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESzybkiOptions() -> OESzybkiOptions
            OESzybkiOptions(arg2: OESzybkiOptions) -> OESzybkiOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESzybkiOptions &operator=(const OESzybkiOptions &)

      Assignment operator.

   .. oe:method:: GetGeneralOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiGeneralOptions& GetGeneralOptions()
            const OESzybkiGeneralOptions& GetGeneralOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetGeneralOptions() -> OESzybkiGeneralOptions

      Returns a reference to the :ref:`OESzybkiGeneralOptions <OESz_OESzybkiGeneralOptions>`
      instance as currently set. These options are used in defining general
      environment for all szybki calculations.

   .. oe:method:: GetOptOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiOptOptions& GetOptOptions()
            const OESzybkiOptOptions& GetOptOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptOptions() -> OESzybkiOptOptions

      Returns a reference to the :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>`
      instance as currently set. These are options related to
      optimization in OESzybki.

   .. oe:method:: GetProteinOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiProteinOptions& GetProteinOptions()
            const OESzybkiProteinOptions& GetProteinOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinOptions() -> OESzybkiProteinOptions

      Returns a reference to the :ref:`OESzybkiProteinOptions <OESz_OESzybkiProteinOptions>`
      instance as currently set. These are options related to
      proteins in OESzybki.

   .. oe:method:: GetRunType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRunType() const

      .. oe:language:: python

         .. oe:api:: python

            GetRunType() -> int

      Returns Szybki run type declared in the :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` object.

   .. oe:method:: GetSolventOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiSolventOptions& GetSolventOptions()
            const OESzybkiSolventOptions& GetSolventOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolventOptions() -> OESzybkiSolventOptions

      Returns a reference to the :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>`
      instance as currently set. These are options related to
      solvents in OESzybki.

   .. oe:method:: SetGeneralOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetGeneralOptions(const OESzybkiGeneralOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetGeneralOptions(opts: OESzybkiGeneralOptions) -> None

      Sets the general szybki options by passing in an :ref:`OESzybkiGeneralOptions <OESz_OESzybkiGeneralOptions>`
      instance. These options are used in defining general environment for all szybki calculations.

   .. oe:method:: SetOptOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOptOptions(const OESzybkiOptOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetOptOptions(opts: OESzybkiOptOptions) -> None

      Sets the optimization options by passing in :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>`
      instance. These are options related to optimization in OESzybki.

   .. oe:method:: SetProteinOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetProteinOptions(const OESzybkiProteinOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinOptions(opts: OESzybkiProteinOptions) -> None

      Sets the protein options by passing in :ref:`OESzybkiProteinOptions <OESz_OESzybkiProteinOptions>`
      instance. These are options related to
      proteins in OESzybki.

   .. oe:method:: SetRunType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRunType(unsigned int run_type)

      .. oe:language:: python

         .. oe:api:: python

            SetRunType(value: int) -> bool

      Sets requested run ``type``. Returns ``true`` if run was successfully set. Possible input 
      choices are given in the namespace :oe:constns:`OESz::OERunType`.
      Warning: Setting ``run_type`` with :oe:constns:`OESz::OERunType::SolidBodyOpt` implies 
      optimization of a ligand inside rigid protein receptor. An attempt of solid-body
      optimization inside flexible protein receptor 
      (see method :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinFlexibilityType`) will result in a message:
      ``Fatal: Solid-body optimization allowed only for ligand in fixed protein``. 

   .. oe:method:: SetSolventOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSolventOptions(const OESzybkiSolventOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetSolventOptions(opts: OESzybkiSolventOptions) -> None

      Sets the solvent options by passing in :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>`
      instance. These are options related to
      solvents in OESzybki.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiProteinOptions, SzybkiProteinOptions

.. _OESz_OESzybkiProteinOptions:

.. oe:class:: OESzybkiProteinOptions

   .. oe:api::

      class OESzybkiProteinOptions : public OESystem::OEOptions

   This class represents options related to proteins in szybki.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiProteinOptions()
            OESzybkiProteinOptions(const OESzybkiProteinOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESzybkiProteinOptions() -> OESzybkiProteinOptions
            OESzybkiProteinOptions(argOpts: OESzybkiProteinOptions) -> OESzybkiProteinOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESzybkiProteinOptions &operator=(const OESzybkiProteinOptions &)

      Assignment operator.

   .. oe:method:: AddFlexibleResidue

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddFlexibleResidue(const OEChem::OEResidue&)

      .. oe:language:: python

         .. oe:api:: python

            AddFlexibleResidue(argRes: OEResidue) -> bool

      Adds a single residue to the list of residues which will be optimized together with the ligand.
      Has to be called multiple times in order to make more than one residue flexible.

      .. seealso::

         * Example in :ref:`Partially flexible protein optimization<section_flexible_residue_example>`

   .. oe:method:: ClearFlexibleResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearFlexibleResidues()

      .. oe:language:: python

         .. oe:api:: python

            ClearFlexibleResidues() -> None

      Clears all of the currently set flexible residues.

   .. oe:method:: GetExactVdWProteinLigand

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetExactVdWProteinLigand() const

      .. oe:language:: python

         .. oe:api:: python

            GetExactVdWProteinLigand() -> bool

      Returns the state of the exact VdW protein-ligand flag. If true, OESzybki will be
      using analytical vdW protein-ligand interaction.

   .. oe:method:: GetIntermolecularVdWCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetIntermolecularVdWCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetIntermolecularVdWCutoff() -> float

      Returns the value of the intermolecular vdW interactions cutoff in |A|. The intermolecular VdW interactions
      are considered to be zero between atoms that are separated by distances larger than the cutoff.

   .. oe:method:: GetProteinDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetProteinDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinDielectric() -> float

      Returns the value of protein dielectric constant.

   .. oe:method:: GetProteinElectrostaticModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetProteinElectrostaticModel() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinElectrostaticModel() -> int

      Returns the protein electrostatics model to be used for OESzybki calculations, as `unsigned int`
      from the :oe:constns:`OESz::OEProteinElectrostatics` namespace.

   .. oe:method:: GetProteinFlexibilityRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetProteinFlexibilityRange() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinFlexibilityRange() -> float

      Returns the value of partial protein flexibility distance from the ligand.

   .. oe:method:: GetProteinFlexibilityType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetProteinFlexibilityType() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinFlexibilityType() -> int

      Returns the type of partial protein flexibility to be used for OESzybki calculations, as `unsigned int`
      from the :oe:constns:`OESz::OEProtFlex` namespace.

   .. oe:method:: HasFlexibleResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasFlexibleResidues() const

      .. oe:language:: python

         .. oe:api:: python

            HasFlexibleResidues() -> bool

      Returns the state of flexible residues. If true, some flexible residues are currently set.

   .. oe:method:: SetExactVdWProteinLigand

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetExactVdWProteinLigand(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetExactVdWProteinLigand(value: bool) -> bool

      Sets the state of the exact VdW protein-ligand flag. If ``true`` is passed, OESzybki will be
      using analytical vdW protein-ligand interaction.

   .. oe:method:: SetIntermolecularVdWCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIntermolecularVdWCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetIntermolecularVdWCutoff(value: float) -> bool

      Sets the value of the intermolecular vdW interactions cutoff in |A|. The intermolecular VdW interactions
      are considered to be zero between atoms that are separated by distances larger than the cutoff.
      The default value is 18 |A|, however when Newton-Raphson optimization is used (see method
      :oe:meth:`OESz::OESzybkiOptOptions::SetOptimizerType`) the default cutoff of 50 |A| is used.

   .. oe:method:: SetProteinDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetProteinDielectric(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinDielectric(value: float) -> bool

      Sets the value of protein dielectric constant for the calculation of protein-ligand interaction.
      The default value of the protein dielectric constant is 1.0.

   .. oe:method:: SetProteinElectrostaticModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetProteinElectrostaticModel(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinElectrostaticModel(value: int) -> bool

      Sets the protein electrostatics model to be used for OESzybki calculations, as `unsigned int`
      from the :oe:constns:`OESz::OEProteinElectrostatics` namespace.
      Method returns ``false`` when the invalid selection is chosen, ``true`` otherwise.

   .. oe:method:: SetProteinFlexibilityRange

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetProteinFlexibilityRange(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinFlexibilityRange(value: float) -> bool

      Sets the value of partial protein flexibility distance from the ligand.

   .. oe:method:: SetProteinFlexibilityType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetProteinFlexibilityType(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinFlexibilityType(value: int) -> bool

      Sets the type of partial protein flexibility to be used for OESzybki calculations, as `unsigned int`
      from the :oe:constns:`OESz::OEProtFlex` namespace.
      Method returns ``false`` when the invalid selection is chosen, ``true`` otherwise.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiResults, SzybkiResults

.. _OESz_OESzybkiResults:

.. oe:class:: OESzybkiResults

   .. oe:api::

      class OESzybkiResults

   Container for geometry optimization results, including final energies,
   individual force field component contributions, RMSD from starting
   geometry, and convergence status.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiResults()
            OESzybkiResults(const OESzybkiResults &)

      .. oe:language:: python

         .. oe:api:: python

            OESzybkiResults() -> OESzybkiResults
            OESzybkiResults(arg2: OESzybkiResults) -> OESzybkiResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESzybkiResults &operator=(const OESzybkiResults &)

      Assignment operator.

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Removes all data from the :ref:`OESzybkiResults <OESz_OESzybkiResults>` object.

   .. oe:method:: GetCPUTime

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetCPUTime() const

      .. oe:language:: python

         .. oe:api:: python

            GetCPUTime() -> float

      Returns CPU time in seconds for the optimization.

   .. oe:method:: GetConfIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetConfIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfIdx() -> int

      Returns conformer id number.

   .. oe:method:: GetEnergyTerm

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEnergyTerm(unsigned int) const

      .. oe:language:: python

         .. oe:api:: python

            GetEnergyTerm(arg2: int) -> float

      Returns the current energy value for a specified potential term. The integer values which 
      determine potential terms are defined in the namespace :oe:constns:`OESz::OEPotentialTerms`   

   .. oe:method:: GetFinalRMSGradient

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetFinalRMSGradient() const

      .. oe:language:: python

         .. oe:api:: python

            GetFinalRMSGradient() -> float

      Returns final RMS of forces, :math:`\sqrt\frac{\bf{g} \cdot \bf{g}}{n_v}`, where :math:`\bf{g}` 
      is the gradient vector and :math:`n_v` the number of variables.

   .. oe:method:: GetGradients

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetGradients(double* gradients, const OEChem::OEAtomBase* atom) const

      .. oe:language:: python

         .. oe:api:: python

            GetGradients(gradients: OEDoubleArray, atom: OEAtomBase) -> bool

      Fills the passed double array with gradients for the atom passed as a second argument. 
      Returns ``true`` if the gradients are successfully exported, ``false`` otherwise.
      Export of gradients is available only when the method :oe:meth:`OESz::OESzybkiGeneralOptions::SetCalculateGradients`
      is called prior to the calculation performed with one of the 
      :oe:meth:`OESz::OESzybki::operator()` operators. Currently calculation of gradients is available
      only for single-point runs. 

   .. oe:method:: GetFinalTotalPotential

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetFinalTotalPotential() const

      .. oe:language:: python

         .. oe:api:: python

            GetFinalTotalPotential() -> float

      Returns the value of the optimized potential for the molecular system.

   .. oe:method:: GetIntramolecularLigandEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetIntramolecularLigandEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetIntramolecularLigandEnergy() -> float

      Returns the value of the value of intramolecular MMFF energy.

   .. oe:method:: GetInitialRMSGradient

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetInitialRMSGradient() const

      .. oe:language:: python

         .. oe:api:: python

            GetInitialRMSGradient() -> float

      Returns the initial RMS of forces, :math:`\sqrt\frac{\bf{g} \cdot \bf{g}}{n_v}`, 
      where :math:`\bf{g}` is the gradient vector and :math:`n_v` the number of variables.

   .. oe:method:: GetInitialTotalPotential

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetInitialTotalPotential() const

      .. oe:language:: python

         .. oe:api:: python

            GetInitialTotalPotential() -> float

      Returns the value of the initial potential for the molecular system to be optimized.

   .. oe:method:: GetInterEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetInterEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetInterEnergy() -> float

      Returns the interaction energy between protein (or DNA) and the ligand optimized inside the 
      macromolecule. For ligands optimized in vacuum or in solution, this function returns 0.

   .. oe:method:: GetMaxDisplacement

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMaxDisplacement() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxDisplacement() -> float

      Returns the maximum atomic displacement for a single atom in |A| during optimization.

   .. oe:method:: GetNumCycles

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumCycles() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumCycles() -> int

      Returns the number of cycles performed by the optimizer.

   .. oe:method:: GetNumFixAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumFixAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumFixAtoms() -> int

      Returns the number of atoms which will be fixed during optimization.

   .. oe:method:: GetNumRotors

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNumRotors() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumRotors() -> int

      Returns the number of rotatable bonds in the molecule.

   .. oe:method:: GetProteinRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetProteinRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinRMSD() -> float

      In the case of a partially optimized protein (residues, side chains, polar hydrogens
      in proximity to the ligand) the function returns the RMS displacement of a protein from its 
      initial structure.

   .. oe:method:: GetRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetRMSD() -> float

      Returns the RMS displacement of the optimized structure with respect to the initial structure.

   .. oe:method:: GetTotalEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTotalEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalEnergy() -> float

      Returns the total energy of the optimized system. That includes all intra and inter molecular 
      MMFF terms, solvation energy (Sheffield or PB, if present) and protein-ligand interaction energy 
      if a ligand is optimized inside the protein. Harmonic energy constraint energy is excluded. 

   .. oe:method:: GetTotalEnergyWithHarmConstraint

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTotalEnergyWithHarmConstraint() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalEnergyWithHarmConstraint() -> float

      Returns total energy of the optimized system plus harmonic energy constraint.

   .. oe:method:: IsActiveTerm

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsActiveTerm(unsigned int term) const

      .. oe:language:: python

         .. oe:api:: python

            IsActiveTerm(arg2: int) -> bool

      Returns ``true`` if the potential term specified by the parameter term is included in the potential 
      function of the system. Possible parameters values are defined in the namespace 
      :oe:constns:`OESz::OEPotentialTerms`.

   .. oe:method:: GetConfFreeEnergyFromEnsemble

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetConfFreeEnergyFromEnsemble() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfFreeEnergyFromEnsemble() -> float

      Returns the free energy of selecting a conformation out of the ensemble calculated as:
      :math:`-RTln(q/Q)`, where :math:`q` is the partition function of a ligand conformer and
      :math:`Q` is the partition function for the entire ensemble. The method will throw an error
      unless it is run following the call to :oe:meth:`OESz::OESzybki::GetEntropy` method which takes 
      the :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` instance as a second parameter, followed by
      the call to :oe:meth:`OESz::OESzybkiEnsembleResults::GetResultsForConformations` on the
      returned :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` object.

   .. oe:method:: GetVibEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetVibEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetVibEntropy() -> float

      Returns the vibrational entropy of a conformation in e.u. (cal/(mol K)) when entropy has been 
      calculated with one of the :oe:meth:`OESz::OESzybki::GetEntropy` methods.

   .. oe:method:: GetRotEntropy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRotEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotEntropy() -> float

      Returns the rotational entropy of a conformation in e.u. (cal/(mol K)) when entropy has been calculated
      with one of the :oe:meth:`OESz::OESzybki::GetEntropy` methods.

   .. oe:method:: GetLnQvib

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLnQvib() const

      .. oe:language:: python

         .. oe:api:: python

            GetLnQvib() -> float

      Returns the natural logarithm of a vibrational partition function when entropy has been 
      calculated with one of the :oe:meth:`OESz::OESzybki::GetEntropy` methods.

   .. oe:method:: GetLnQrot

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLnQrot() const

      .. oe:language:: python

         .. oe:api:: python

            GetLnQrot() -> float

      Returns the natural logarithm of a rotational partition function when entropy has been 
      calculated with one of the :oe:meth:`OESz::OESzybki::GetEntropy` methods. 

   .. oe:method:: IsUnique

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsUnique() const

      .. oe:language:: python

         .. oe:api:: python

            IsUnique() -> bool

      Returns ``true`` if the conformation is unique in terms of the structure. Although the
      method :oe:meth:`OESz::OESzybki::GetEntropy` which takes a non-const 
      :ref:`OEMCMolBase <OEChem_OEMCMolBase>` object is guaranteed to return an ensemble of unique
      conformations, the other methods in oeszybki library do not. The method might be 
      therefore useful to make sure if the current conformation is unique or not.   

   .. oe:method:: Print

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Print(OEPlatform::oeostream &) const
            void Print(OESystem::OEErrorHandler &) const

      .. oe:language:: python

         .. oe:api:: python

            Print(arg2: oeostream) -> None
            Print(arg2: OEErrorHandler) -> None

      Both functions allow the generation of log information on the optimized system. The following 
      information is reported:

      *  Conformer id 
      *  Number of fixed atoms (if any)
      *  Number of torsions (if any and if optimization in torsion space is true) 
      *  Initial energy  
      *  Initial rms gradient
      *  Final energy
      *  Final rms gradient 
      *  RMS displacement upon optimization 
      *  Maximum displacement during optimization 
      *  Values of potential terms at final geometry 



.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiSolventOptions, SzybkiSolventOptions

.. _OESz_OESzybkiSolventOptions:

.. oe:class:: OESzybkiSolventOptions

   .. oe:api::

      class OESzybkiSolventOptions : public OESystem::OEOptions

   This class represents options related to solvent modeling in szybki.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESzybkiSolventOptions()
            OESzybkiSolventOptions(const OESzybkiSolventOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESzybkiSolventOptions() -> OESzybkiSolventOptions
            OESzybkiSolventOptions(argOpts: OESzybkiSolventOptions) -> OESzybkiSolventOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESzybkiSolventOptions &operator=(const OESzybkiSolventOptions &)

   .. _OESz_OESzybkiSolventOptions_GetAtomicRadiiType:

      Assignment operator.

   .. oe:method:: GetAtomicRadiiType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetAtomicRadiiType() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomicRadiiType() -> int

      Returns the type of atomic radii used for PB calculations, as
      an `unsigned int` from the :oe:constns:`OESz::OEAtomicRadii` namespace.

   .. _OESz_OESzybkiSolventOptions_GetCavitySolventParameter:

   .. oe:method:: GetCavitySolventParameter

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCavitySolventParameter() const

      .. oe:language:: python

         .. oe:api:: python

            GetCavitySolventParameter() -> float

      Returns the microscopic surface tension coefficient (in kcal/(mol A**2))
      used in hydrophobic ligand solvation model.

   .. _OESz_OESzybkiSolventOptions_GetSaltConcentration:

   .. oe:method:: GetSaltConcentration

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSaltConcentration() const

      .. oe:language:: python

         .. oe:api:: python

            GetSaltConcentration() -> float

      Returns the value of salt concentration in moles/liter (M).

   .. _OESz_OESzybkiSolventOptions_GetSolventDielectric:

   .. oe:method:: GetSolventDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSolventDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolventDielectric() -> float

      Returns the value of solvent dielectric constant for the protein-ligand
      system.

   .. _OESz_OESzybkiSolventOptions_GetSolventModel:

   .. oe:method:: GetSolventModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSolventModel() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolventModel() -> int

      Returns the type of solvent model used for the calculations
      of solution ligands, as an `unsigned int` from the
      :oe:constns:`OESz::OESolventModel` namespace.

   .. _OESz_OESzybkiSolventOptions_SetAtomicRadiiType:

   .. oe:method:: SetAtomicRadiiType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAtomicRadiiType(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomicRadiiType(value: int) -> bool

      Sets the type of atomic radii to be used for PB calculations, as
      an `unsigned int` from the :oe:constns:`OESz::OEAtomicRadii` namespace.

   .. _OESz_OESzybkiSolventOptions_SetCavitySolventParameter:

   .. oe:method:: SetCavitySolventParameter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCavitySolventParameter(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetCavitySolventParameter(value: float) -> bool

      Sets the microscopic surface tension coefficient (in kcal/(mol A**2))
      used in hydrophobic ligand solvation model. The default value is set
      to be 0.025 kcal/(mol A**2).  Smaller values usually in the range 0-10
      kcal/(mol A**2) usually reflects a combined hydrophobic
      solvation effect of cavitation and solute-solvent vdW interactions.

   .. _OESz_OESzybkiSolventOptions_SetSaltConcentration:

   .. oe:method:: SetSaltConcentration

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSaltConcentration(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetSaltConcentration(value: float) -> bool

      Sets the value of salt concentration in moles/liter (M). By default
      a zero salt concentration is assumed. Values higher than 0.08 should
      not be used and are not supported.

   .. _OESz_OESzybkiSolventOptions_SetSolventDielectric:

   .. oe:method:: SetSolventDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSolventDielectric(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetSolventDielectric(value: float) -> bool

      Sets the value of solvent dielectric constant for the protein-ligand
      systems in PB calculations.  The default value of solvent dielectric
      constant is set to 80.0.

   .. _OESz_OESzybkiSolventOptions_SetSolventModel:

   .. oe:method:: SetSolventModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSolventModel(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetSolventModel(value: int) -> bool

      Sets the type of solvent model used for the calculations of
      solution ligands, as an `unsigned int`
      from the :oe:constns:`OESz::OESolventModel` namespace.
      Method returns ``false`` when the invalid selection is chosen, ``true``
      otherwise.

   .. _OESz_OESzybkiSolventOptions_SetChargeEngine:

   .. oe:method:: SetChargeEngine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetChargeEngine(const OEProton::OEChargeEngineBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetChargeEngine(argChargeEngine: OEChargeEngineBase) -> None

      Sets the charging engine to obtain partial charges used for solvation
      calculation by passing in an
      :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>` instance.

   .. _OESz_OESzybkiSolventOptions_SetUseCurrentCharges:

   .. oe:method:: SetUseCurrentCharges

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetUseCurrentCharges()

      .. oe:language:: python

         .. oe:api:: python

            SetUseCurrentCharges() -> None

      Sets the charging engine to work with the existing charges. This
      command is equivalent to using the
      :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine` method with an
      :ref:`OEChargeEngineNoOp <OEProton_OEChargeEngineNoOp>` instance as input.


.. oe:namespace:: OESz

.. meta::
   :keywords: OETorsionScanOptions, TorsionScanOptions

.. _OESz_OETorsionScanOptions:

.. oe:class:: OETorsionScanOptions

   .. oe:api::

      class OETorsionScanOptions : public OELigandChargeOptions

   Configuration options for :oe:func:`OESz::OETorsionScan` torsion-energy scans.

   .. seealso::

      * :ref:`OETorsionScanResult <OESz_OETorsionScanResult>` class
      * :oe:func:`OESz::OETorsionScan` function

   The following methods are publicly inherited from :ref:`OELigandChargeOptions <OESz_OELigandChargeOptions>`:
    * :oe:meth:`GetGenerateElfConfs<OESz::OELigandChargeOptions::GetGenerateElfConfs>` and
      :oe:meth:`SetGenerateElfConfs<OESz::OELigandChargeOptions::SetGenerateElfConfs>`
    * :oe:meth:`GetLigandCharge<OESz::OELigandChargeOptions::GetLigandCharge>`,
      :oe:meth:`GetLigandChargeType<OESz::OELigandChargeOptions::GetLigandChargeType>`, and
      :oe:meth:`SetLigandCharge<OESz::OELigandChargeOptions::SetLigandCharge>`

   The :ref:`OETorsionScanOptions <OESz_OETorsionScanOptions>` class defines the following public methods:
    * :oe:meth:`GetDelta<OESz::OETorsionScanOptions::GetDelta>` and
      :oe:meth:`SetDelta<OESz::OETorsionScanOptions::SetDelta>`
    * :oe:meth:`GetForceField<OESz::OETorsionScanOptions::GetForceField>`,
      :oe:meth:`GetForceFieldType<OESz::OETorsionScanOptions::GetForceFieldType>` and
      :oe:meth:`SetForceField<OESz::OETorsionScanOptions::SetForceField>`
    * :oe:meth:`GetMaxIter<OESz::OETorsionScanOptions::GetMaxIter>` and
      :oe:meth:`SetMaxIter<OESz::OETorsionScanOptions::SetMaxIter>`
    * :oe:meth:`GetPenaltyForceConstant<OESz::OETorsionScanOptions::GetPenaltyForceConstant>` and
      :oe:meth:`SetPenaltyForceConstant<OESz::OETorsionScanOptions::SetPenaltyForceConstant>`
    * :oe:meth:`GetSolvationType<OESz::OETorsionScanOptions::GetSolvationType>` and
      :oe:meth:`SetSolvationType<OESz::OETorsionScanOptions::SetSolvationType>`
    * :oe:meth:`GetTolerance<OESz::OETorsionScanOptions::GetTolerance>` and
      :oe:meth:`SetTolerance<OESz::OETorsionScanOptions::SetTolerance>`
    * :oe:meth:`GetUseInternalCoord<OESz::OETorsionScanOptions::GetUseInternalCoord>` and
      :oe:meth:`SetUseInternalCoord<OESz::OETorsionScanOptions::SetUseInternalCoord>`
    * :oe:meth:`GetUserDefinedAngles<OESz::OETorsionScanOptions::GetUserDefinedAngles>` and
      :oe:meth:`SetUserDefinedAngles<OESz::OETorsionScanOptions::SetUserDefinedAngles>`
    * :oe:meth:`GetUseSinglePointPB<OESz::OETorsionScanOptions::GetUseSinglePointPB>` and
      :oe:meth:`SetUseSinglePointPB<OESz::OETorsionScanOptions::SetUseSinglePointPB>`
    * :oe:meth:`GetNumStarts<OESz::OETorsionScanOptions::GetNumStarts>` and
      :oe:meth:`SetNumStarts<OESz::OETorsionScanOptions::SetNumStarts>`
    * :oe:meth:`GetOverlapDiv<OESz::OETorsionScanOptions::GetOverlapDiv>` and
      :oe:meth:`SetOverlapDiv<OESz::OETorsionScanOptions::SetOverlapDiv>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorsionScanOptions()
            OETorsionScanOptions(const OETorsionScanOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OETorsionScanOptions() -> OETorsionScanOptions
            OETorsionScanOptions(arg2: OETorsionScanOptions) -> OETorsionScanOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETorsionScanOptions &operator=(const OETorsionScanOptions &)

      Assignment operator.

   .. _OESz_OETorsionScanOptions_GetDelta:

   .. oe:method:: GetDelta

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDelta() const

      .. oe:language:: python

         .. oe:api:: python

            GetDelta() -> float

      Returns the value of dihedral angle increase (in degrees).

   .. _OESz_OETorsionScanOptions_GetForceField:

   .. oe:method:: GetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMolPotential::OEForceField* GetForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEForceField

      Returns pointer to the user defined force field.

   .. _OESz_OETorsionScanOptions_GetForceFieldType:

   .. oe:method:: GetForceFieldType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceFieldType() -> int

      Returns the type of force field defined.

   .. _OESz_OETorsionScanOptions_GetMaxIter:

   .. oe:method:: GetMaxIter

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxIter() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxIter() -> int

      Returns the number of maximum iterations during optimization.

   .. _OESz_OETorsionScanOptions_GetPenaltyForceConstant:

   .. oe:method:: GetPenaltyForceConstant

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPenaltyForceConstant() const

      .. oe:language:: python

         .. oe:api:: python

            GetPenaltyForceConstant() -> float

      Returns force constant for the dihedral angle constraint used for torsion scan.

   .. _OESz_OETorsionScanOptions_GetSolvationType:

   .. oe:method:: GetSolvationType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSolvationType() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolvationType() -> int

      Returns the type of solvation model used for torsion scan, see :oe:meth:`OESz::OETorsionScanOptions::SetSolvationType`
      for more details.

   .. _OESz_OETorsionScanOptions_GetTolerance:

   .. oe:method:: GetTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTolerance() const

      .. oe:language:: python

         .. oe:api:: python

            GetTolerance() -> float

      Returns the tolerance during optimization.

   .. _OESz_OETorsionScanOptions_GetUseInternalCoord:

   .. oe:method:: GetUseInternalCoord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseInternalCoord() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseInternalCoord() -> bool

      Returns ``true`` if :ref:`SetUseInternalCoord <OESz_OETorsionScanOptions_SetUseInternalCoord>`
      is set to using internal coordinates for optimization while the torsion selected for scanning
      is fixed.

   
   .. _OESz_OETorsionScanOptions_GetUserDefinedAngles:

   .. oe:method:: GetUserDefinedAngles

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<double> GetUserDefinedAngles() const

      .. oe:language:: python

         .. oe:api:: python

            GetUserDefinedAngles() -> OEDoubleVector

      Returns vector of user defined dihedral angles for which torsion scan will be done.

.. _OESz_OETorsionScanOptions_GetUseSinglePointPB:

   .. oe:method:: GetUseSinglePointPB

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseSinglePointPB() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseSinglePointPB() -> bool

      Returns ``true`` if the :oe:meth:`OESz::OETorsionScanOptions::SetUseSinglePointPB` is set to correcting the
      torsion scan with a PB solvation energy.

.. _OESz_OETorsionScanOptions_GetNumStarts:

   .. oe:method:: GetNumStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetNumStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumStarts() -> int

      Returns the number of starts for the torsion scan. See :oe:meth:`OESz::OETorsionScanOptions::SetNumStarts` for
      more details

.. _OESz_OETorsionScanOptions_GetOverlapDiv:

   .. oe:method:: GetOverlapDiv

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetOverlapDiv() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlapDiv() -> int

      Returns the divisor used for determining the size of the overlaps between starts. 
      See :oe:meth:`OESz::OETorsionScanOptions::SetOverlapDiv` for more details.

.. _OESz_OETorsionScanOptions_SetDelta:

   .. oe:method:: SetDelta

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDelta(double delta)

      .. oe:language:: python

         .. oe:api:: python

            SetDelta(value: float) -> bool

      Determines the number of points in that is :math:`(360.0/delta+1)`  in the
      :math:`[0.0^{\circ}, 360.0^{\circ}]` range for the scan.
      Minimum and maximum values are ``0.1`` and ``60.0`` degrees respectively. The default value
      is ``5.0`` degrees. When the given value of ``delta`` is outside the range, ``false`` is returned.

.. _OESz_OETorsionScanOptions_SetForceField:

   .. oe:method:: SetForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceField(const OEMolPotential::OEForceField& value)
            bool SetForceField(const std::string& value)
            bool SetForceField(OEPlatform::oeistream& value)
            bool SetForceField(const unsigned value)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: OEForceField) -> bool
            SetForceField(value: int) -> bool
            SetForceField(value: str) -> bool
            SetForceField(value: oeistream) -> bool

      Sets user defined force field which will be used for torsion scan.

   
.. _OESz_OETorsionScanOptions_SetForceFieldType:

   .. oe:method:: SetForceFieldType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceFieldType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetForceFieldType(ff: int) -> bool

      Selects the force field for the scan. The allowed values for parameter ``type`` are
      :oe:constns:`OESz::OEForceFieldType::MMFF94S` (default), 
      :oe:constns:`OESz::OEForceFieldType::MMFF94`,
      :oe:constns:`OESz::OEForceFieldType::SMIRNOFF99FROSST`, 
      :oe:constns:`OESz::OEForceFieldType::PARSLEY_OPENFF100`,
      :oe:constns:`OESz::OEForceFieldType::PARSLEY_OPENFF111`,
      :oe:constns:`OESz::OEForceFieldType::PARSLEY_OPENFF121`,
      :oe:constns:`OESz::OEForceFieldType::PARSLEY_OPENFF131`,
      :oe:constns:`OESz::OEForceFieldType::SAGE_OPENFF200`, and
      :oe:constns:`OESz::OEForceFieldType::SAGE_OPENFF210`
      Method returns ``false`` if other than the above values are passed.

.. _OESz_OETorsionScanOptions_SetMaxIter:

   .. oe:method:: SetMaxIter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxIter(const unsigned value)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxIter(value: int) -> bool

      Sets the number of maximum iterations for optimization.

.. _OESz_OETorsionScanOptions_SetSolvationType:

   .. oe:method:: SetSolvationType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSolvationType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetSolvationType(value: int) -> bool

      Selects the solvation model used for the scan. The allowed values of ``type`` are:
      :oe:constns:`OESz::OESolventModel::NoSolv` (vacuum) and
      :oe:constns:`OESz::OESolventModel::Sheffield` (aqueous solution, default).
      Method returns ``false`` if invalid solvation model is passed.

.. _OESz_OETorsionScanOptions_SetPenaltyForceConstant:

   .. oe:method:: SetPenaltyForceConstant

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPenaltyForceConstant(double pfc)

      .. oe:language:: python

         .. oe:api:: python

            SetPenaltyForceConstant(value: float) -> bool

      Overwrites a default value (``1e4``) for force constant in dihedral angle constraint 
      used for torsion scan. Although for most molecules a default value works fine, in some
      cases a molecular torsion might be  overconstrained or  underconstrained. This method 
      allows to avoid those two extremes. Method returns ``false`` if invalid value of force
      constant is passed.

.. _OESz_OETorsionScanOptions_SetTolerance:

   .. oe:method:: SetTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTolerance(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetTolerance(value: float) -> bool

      Sets the tolerance limit for optimization.

.. _OESz_OETorsionScanOptions_SetUseInternalCoord:   

   .. oe:method:: SetUseInternalCoord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseInternalCoord(bool useInt)

      .. oe:language:: python

         .. oe:api:: python

            SetUseInternalCoord(value: bool) -> bool

      Overwrites a default method for torsion scan, which  applies a large enough penalty force
      to keep the value of the dihedral angle constant during optimization. When the parameter
      ``useInt`` is set to ``true``, optimization is performed in 3N-5 internal coordinates while
      the selected torsion for which a scan is done is kept frozen.

   
.. _OESz_OETorsionScanOptions_SetUserDefinedAngles:

   .. oe:method:: SetUserDefinedAngles

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUserDefinedAngles(const std::vector<double>& angles)

      .. oe:language:: python

         .. oe:api:: python

            SetUserDefinedAngles(value: OEDoubleVector) -> bool

      Takes a vector of user selected dihedral angles (in deg) for which torsion scan will be
      done. Vector passed as argument should contain at least 2 values, otherwise ``false``
      is returned.

   
.. _OESz_OETorsionScanOptions_SetUseSinglePointPB:

   .. oe:method:: SetUseSinglePointPB

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseSinglePointPB(bool usePB)

      .. oe:language:: python

         .. oe:api:: python

            SetUseSinglePointPB(value: bool) -> bool

      Corrects the final scan values with a PB solvation energy, when the solvation model
      is set to :oe:constns:`OESz::OESolventModel::Sheffield`
      (see :oe:meth:`OESz::OETorsionScanOptions::SetSolvationType`). Method returns
      ``false`` if the solvation model is not correctly set.

.. _OESz_OETorsionScanOptions_SetNumStarts:

   .. oe:method:: SetNumStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNumStarts(unsigned starts)

      .. oe:language:: python

         .. oe:api:: python

            SetNumStarts(value: int) -> bool

      Sets the number of starts for the torsion scan. The default value is ``2``, meaning scans will start
      at 0 and 180 degrees. The scans are performed both forwards and backwards.
      This setting is not compatible with setting :oe:meth:`OESz::OETorsionScanOptions::SetUserDefinedAngles`,
      and will be ignored in case user defined angles are supplied.

   
.. _OESz_OETorsionScanOptions_SetOverlapDiv:

   .. oe:method:: SetOverlapDiv

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOverlapDiv(unsigned overlapDiv)

      .. oe:language:: python

         .. oe:api:: python

            SetOverlapDiv(value: int) -> bool

      Sets the divisor used for determining the size of the overlaps between starts. If set to zero or one, 
      will perform full 360 forwards and backwards scans for each start, meaning the number of starts will increase
      the computational cost linearly. To prevent the linear increase in cost for additional starts, the overlap
      divisor in combination with a number of starts ``> 1``, will first divide the angle space by the number of starts,
      then to ensure some overlap between the scanned angles will take the remaining space and divide by this 
      value (default value is ``4``). For example with the default values of 2 starts, scans would be performed 
      from ``0->180``, ``0->-180``, ``180->360``, and ``180->0``. The ``180`` degree remainder (if a full scan would 
      have been done) is instead divided by ``4``, which equals ``45`` degrees, which is then added to each 
      scan to ensure overlaps of the curves. The resulting scan will look like ``0->225``, ``0->-225``, 
      ``180->45`` (through ``360``), and ``180->-45``. The larger the overlap divisor the smaller 
      the overlaps between curves.
      This setting is not compatible with setting :oe:meth:`OESz::OETorsionScanOptions::SetUserDefinedAngles`,
      and will be ignored in case user defined angles are supplied.


.. oe:namespace:: OESz

.. meta::
   :keywords: OETorsionScanResult, TorsionScanResult

.. _OESz_OETorsionScanResult:

.. oe:class:: OETorsionScanResult

   .. oe:api::

      class OETorsionScanResult

   A single data point from a torsion scan, storing a torsion angle (in degrees)
   and its corresponding force field energy (in kcal/mol).

   .. seealso::

      * :ref:`OETorsionScanOptions <OESz_OETorsionScanOptions>` class
      * :oe:func:`OESz::OETorsionScan` function
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorsionScanResult(double dihedral_angle, double energy)
            OETorsionScanResult(const OETorsionScanResult &)

      .. oe:language:: python

         .. oe:api:: python

            OETorsionScanResult(dihedral_angle: float, ener: float) -> OETorsionScanResult
            OETorsionScanResult(arg2: OETorsionScanResult) -> OETorsionScanResult

      Default and copy constructors. Default constructor takes values of torsion
      angle (in degrees) and corresponding energy (in kcal/mol).

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETorsionScanResult& operator=(const OETorsionScanResult&)

      Assignment operator.

   .. oe:method:: GetAngle
    
      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetAngle() -> float

      Returns the value of dihedral angle (in degrees) for a torsion scan point. 

   .. oe:method:: GetEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnergy() -> float

      Returns the value of relative energy (in kcal/mol) for a torsion scan point.


.. oe:namespace:: OESz

.. meta::
   :keywords: OETorsionScanner, TorsionScanner

.. _OESz_OETorsionScanner:

.. oe:class:: OETorsionScanner

   .. oe:api::

      class OETorsionScanner

   This class provides an interface to perform potential energy scanning for a 
   selected torsion in the input molecule. Torsion scan is preformed by a series of 
   constrained optimizations in which all internal degrees of freedom but selected 
   torsion, are optimized.

   .. seealso::

      * :ref:`OETorsionScan <OESz_OETorsionScan>` method
      * :ref:`OETorsionScanOptions <OESz_OETorsionScanOptions>` class
      * :ref:`OETorsionScanResult <OESz_OETorsionScanResult>` class

   The :ref:`OETorsionScanner <OESz_OETorsionScanner>` class defines the following public methods:
    * :oe:meth:`GetLowestEnergyConfs<OESz::OETorsionScanner::GetLowestEnergyConfs>`
    * :oe:meth:`GetLowestEneResults<OESz::OETorsionScanner::GetLowestEneResults>`
    * :oe:meth:`GetScannedAngles<OESz::OETorsionScanner::GetScannedAngles>`
    * :oe:meth:`GetSinglePointConfs<OESz::OETorsionScanner::GetSinglePointConfs>`
    * :oe:meth:`Scan<OESz::OETorsionScanner::Scan>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorsionScanner(const OETorsionScanOptions& opts = OETorsionScanOptions())
            OETorsionScanner(const OETorsionScanner&)

      .. oe:language:: python

         .. oe:api:: python

            OETorsionScanner(opts: OETorsionScanOptions = OETorsionScanOptions()) -> OETorsionScanner
            OETorsionScanner(arg2: OETorsionScanner) -> OETorsionScanner

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETorsionScanner &operator=(const OETorsionScanner&)

.. _OESz_OETorsionScanner_GetLowestEnergyConfs:

      Assignment operator.

   .. oe:method:: GetLowestEnergyConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetLowestEnergyConfs(OEChem::OEMCMolBase& dst) const

      .. oe:language:: python

         .. oe:api:: python

            GetLowestEnergyConfs(dst: OEMol) -> bool

      Returns the optimized lowest energy conformers corresponding to each of the angles that scanning was performed.
      The :oe:meth:`Scan<OESz::OETorsionScanner::Scan>` must be performed before calling this method.

.. _OESz_OETorsionScanner_GetLowestEneResults:

   .. oe:method:: GetLowestEneResults

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OETorsionScanResult>* GetLowestEneResults() const

      .. oe:language:: python

         .. oe:api:: python

            GetLowestEneResults() -> Iterable[OETorsionScanResult]

      Returns the lowest energy scan results corresponding to each of the angles that scanning was performed.
      The :oe:meth:`Scan<OESz::OETorsionScanner::Scan>` must be performed before calling this method.

.. _OESz_OETorsionScanner_GetScannedAngles:

   .. oe:method:: GetScannedAngles

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<double> GetScannedAngles() const

      .. oe:language:: python

         .. oe:api:: python

            GetScannedAngles() -> OEDoubleVector

      Returns all the angles at which scanning was performed.
      The :oe:meth:`Scan<OESz::OETorsionScanner::Scan>` must be performed before calling this method.

.. _OESz_OETorsionScanner_GetSinglePointConfs:

   .. oe:method:: GetSinglePointConfs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSinglePointConfs(OEChem::OEMCMolBase& mol,
                                     const double angle) const

      .. oe:language:: python

         .. oe:api:: python

            GetSinglePointConfs(dst: OEMol, angle: float) -> bool

      Returns all the optimized conformers corresponding to the specified angle.
      The :oe:meth:`Scan<OESz::OETorsionScanner::Scan>` must be performed before calling this method.

.. _OESz_OETorsionScanner_Scan:

   .. oe:method:: Scan

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Scan(const OEChem::OEMCMolBase&, const OEChem::OETorsion&)

      .. oe:language:: python

         .. oe:api:: python

            Scan(src: OEMol, torsion: OETorsion) -> int

      Perform torsion scanning for the specified torsion on the input molecule.


.. oe:namespace:: OESz

.. oe:constnamespace:: OEAtomicRadii

   This namespace contains constants describing atomic radii used for PB calculations

   .. oe:constant:: Bondi
   
      Default set.

   .. oe:constant:: ZAP9
   
      Special set of atomic radii described in (\ [Nicholls-2010]_\).

   .. oe:constant:: ZAP7
   
      Special set of atomic radii described in (\ [Nicholls-2010]_\).


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

.. oe:constnamespace:: OEComplexFFType

   .. attention::

      |PRELIMINARY-API|

   This namespace contains constants describing the force field type

   .. oe:constant:: MMFF94
   
      Standard MMFF94 force field.  Corresponding string value: mmff94

   .. oe:constant:: MMFF94S
   
      A version of MMFF94 with modified out-of-plane and torsional parameters.
      This force-field describes time-averaged structures mainly for trigonal nitrogen centers.
      Corresponding string value: mmff94s

   .. oe:constant:: MMFF_AMBER

      A force field that combines MMFF and Amber force fields. In this potential both the protein 
      and ligand internal degrees of freedom are handled by the MMFF94 force field, while protein-ligand 
      interactions are described by Amber force field.
      Corresponding string value: mmff_amber

   .. oe:constant:: MMFFS_AMBER

      As above, but with MMFF94S forcefield applied for intramolecular interactions.
      Corresponding string value: mmffs_amber

   .. oe:constant:: FF14SB_PARSLEY

      A force field that combines FF14SB and Parsley force fields. In this potential protein 
      internal degrees of freedom are handled by the FF14SB force field and ligand internal degrees of freedom are 
      handled by the Parsley force field. The inter-molecular protein-ligand interactions are described 
      by use of appropriate mixing rules for the individual atom interaction potentials.
      Corresponding string value: ff14sb_parsley

   .. oe:constant:: FF14SB_SAGE

      A force field that combines FF14SB and Sage force fields. In this potential protein
      internal degrees of freedom are handled by the FF14SB force field and ligand internal degrees of freedom are
      handled by the Sage force field. The inter-molecular protein-ligand interactions are described
      by use of appropriate mixing rules for the individual atom interaction potentials.
      Corresponding string value: ff14sb_sage


.. oe:namespace:: OESz

.. oe:constnamespace:: OEEntropyMethod

   This namespace contains constants describing the type of Hessian used for vibrational entropy 
   calculations.

   .. oe:constant:: QNewton
   
      Hessian matrix is obtained from Quasi-Newton optimization.

   .. oe:constant:: Analytic
   
      Hessian matrix is calculated analytically.

   .. oe:constant:: ExternalHessian

      Hessian matrix is imported instead of being calculated. 


.. oe:namespace:: OESz

..  _OESz_OEEnvType:

.. oe:constnamespace:: OEEnvType

   This namespace contains constants describing the type of environment for entropy calculations 
   to be used.

..  _OESz_OEEnvType_Gas:

   .. oe:constant:: Gas
   
      Gas-phase molecule.

..  _OESz_OEEnvType_SolutionSPT:

   .. oe:constant:: SolutionSPT
   
      Molecule in solution for which hydrophobic solvation is described with the Scaled Particle
      Theory (SPT).

..  _OESz_OEEnvType_SolutionSA:

   .. oe:constant:: SolutionSA

      Molecule in solution for which hydrophobic solvation is described with the Surface Area (SA)
      model

..  _OESz_OEEnvType_Protein:

   .. oe:constant:: Protein
   
      Molecule in the protein binding-site.

..  _OESz_OEEnvType_Solution:

   .. oe:constant:: Solution

      Same as `oe:constant::SolutionSPT`
      


.. oe:namespace:: OESz

..  _OESz_OEForceFieldType:

.. oe:constnamespace:: OEForceFieldType

   This namespace contains constants describing the force field type

   ..  _OESz_OEForceFieldType_MMFF94:

   .. oe:constant:: MMFF94
   
      Standard MMFF94 force field. (String value: mmff94)

   ..  _OESz_OEForceFieldType_MMFF94S:

   .. oe:constant:: MMFF94S
   
      A version of MMFF94 with modified out-of-plane and torsional parameters.
      This force-field describes time-averaged structures mainly for trigonal nitrogen centers. (String value: mmff94s)

   ..  _OESz_OEForceFieldType_MMFF_AMBER:

   .. oe:constant:: MMFF_AMBER

      A combined force field which can be used for the optimization of the ligand in the rigid
      protein only. Can't be applied for free ligand. In this potential ligand internal degrees 
      of freedom are handled by the MMFF94 force field, while protein-ligand interactions (vdW
      and Coulomb) are described by Amber force field.

   ..  _OESz_OEForceFieldType_MMFFS_AMBER:

   .. oe:constant:: MMFFS_AMBER

      As above, but with MMFF94S forcefield applied for ligand intramolecular interactions.

   ..  _OESz_OEForceFieldType_MMFF_IEFF:

   .. oe:constant:: MMFF_IEFF

      A combined force field which can be used for the optimization of the ligand inside 
      a protein receptor or for the optimization of a cluster of molecules. In this force field 
      ligand internal molecular degrees of freedom are handled by the MMFF94, while 
      all intermolecular interactions are calculated with the IEFF potential described in
      [Hamaguchi-2012]_.

   ..  _OESz_OEForceFieldType_MMFFS_IEFF:

   .. oe:constant:: MMFFS_IEFF

      As above, but with the MMFF94S forcefield applied for all intramolecular interactions.

   ..  _OESz_OEForceFieldType_SMIRNOFF99FROSST:

   .. oe:constant:: SMIRNOFF99FROSST

      SMIRNOFF99FROSST force field.

   ..  _OESz_OEForceFieldType_PARSLEY_OPENFF100:

   .. oe:constant:: PARSLEY_OPENFF100

      Parsley OpenFF1.0.0 force field.

   .. _OESz_OEForceFieldType_PARSLEY_OPENFF111:

   .. oe:constant:: PARSLEY_OPENFF111

      Parsley OpenFF1.1.1 force field.

   .. _OESz_OEForceFieldType_PARSLEY_OPENFF121:

   .. oe:constant:: PARSLEY_OPENFF121

      Parsley OpenFF1.2.1 force field.

   .. _OESz_OEForceFieldType_PARSLEY_OPENFF131:

   .. oe:constant:: PARSLEY_OPENFF131

      Parsley OpenFF1.3.1 force field.

   .. _OESz_OEForceFieldType_PARSLEY_OPENFF:

   .. oe:constant:: PARSLEY_OPENFF

      The latest version of Parsley OpenFF force field (String value: parsley)

   .. _OESz_OEForceFieldType_SAGE_OPENFF200:

   .. oe:constant:: SAGE_OPENFF200

      Sage OpenFF2.0.0 force field.

   .. _OESz_OEForceFieldType_SAGE_OPENFF210:

   .. oe:constant:: SAGE_OPENFF210

      Sage OpenFF2.1.0 force field.

   .. _OESz_OEForceFieldType_SAGE_OPENFF:

   .. oe:constant:: SAGE_OPENFF

      The latest version of Sage OpenFF force field (String value: sage)

   .. _OESz_OEForceFieldType_FF14SB_SMIRNOFF:

   .. oe:constant:: FF14SB_SMIRNOFF

      Combined Amber/ff14SB - PARSLEY_OPENFF or (Amber/ff14SB - SAGE_OPENFF) force field which might be used to 
      optimize a part of protein including cofactor. Protein part will be described with Amber/ff14SB parameters
      while cofactor with PARSLEY_OPENFF131 or SAGE_OPENFF200.

   .. note::
 
      Using SMIRNOFF99FROSST,  PARSLEY_OPENFF100, PARSLEY_OPENFF111, PARSLEY_OPENFF121, 
      PARSLEY_OPENFF131, SAGE_OPENFF200 and FF14SB_SMIRNOFF force fields requires that the input 
      molecule(s) have assigned atomic partial charges. For small molecules we recommend using AMABCC-ELF10 partial 
      charges while for proteins we suggest using AMBER partial charges. 
    


.. oe:namespace:: OESz

.. oe:constnamespace:: OEFreeFormReturnCode

   This namespace contains constants describing the status of the FreeForm runs.

   .. oe:constant:: Success
   
      Normal execution.

   .. oe:constant:: AtomTypeFailure
   
      Failed to assign MMFF94 atom types.   

   .. oe:constant:: ImplicitHydrogens
   
      Input molecule contains implicit hydrogens. 

   .. oe:constant:: InputGeometry
   
      3D structure of the input molecule is badly defined.

   .. oe:constant:: No3DCoordinates

      Input molecule has no 3D coordinates.

   .. oe:constant:: ConfGenFailure

      Failed to generate conformations.

   .. oe:constant:: TooManyRotors

      Input molecule contains too many rotors.

   .. oe:constant:: ChargeMismatch

      Total formal charge of the molecule is different than the sum of partial charges.

   .. oe:constant:: NotSupportedCharges

      Attempt to use not supported by FreeForm partial charges type.

   .. oe:constant:: UnrecognizedChargeState

      Wrong charge state of the molecule.

   .. oe:constant:: UnsupportedRadiiType

      Radii type not supported by FreeForm. 

   .. oe:constant:: ChargeAssignFailure

      Failed to assign atomic partial charges.

   .. oe:constant:: GraphMismatch
   
      Cannot use molecules with dissimilar graphs.

   .. oe:constant:: UnequalNumConfs
   
      Number of conformers in two MCMols are different.

   .. oe:constant:: PartnerConfNotFound
   
      A corresponding conformer does not exist.

   .. oe:constant:: MissingPartnerConf
   
      Partner conformer information does not exist.

   .. oe:constant:: MissingFFConfEne
   
      FreeFormConf free energies do not exist.



.. oe:namespace:: OESz

.. oe:constnamespace:: OEFreeFormWarning

   This namespace contains constants describing warnings produced by FreeForm runs.

   .. oe:constant:: UnspecifiedStereo
   
      Input molecule contains chiral atoms with unspecified stereo configuration.

   .. oe:constant:: NotRemovableCharge
   
      Input molecule can't be neutralized.   

   .. oe:constant:: HSamplingSkipped
   
      Hydrogen atom sampling during conformation generation was not performed.

   .. oe:constant:: Missing3DCoordinates
   
      Input ensemble can't be used because input molecular file has no 3D coordinates.

   .. oe:constant:: ZeroPartialCharges
   
      Input molecule does not contain any partial charges.



.. oe:namespace:: OESz

.. oe:constnamespace:: OEFreeFormIonicState

   This namespace contains constants describing the charge state of a molecule for solvation
   free energy estimation or conformations free energies in solution.

   .. oe:constant:: Uncharged
   
      Neutral molecule. 

   .. oe:constant:: PH74
   
      Charge state corresponding to physiological pH = 7.4.   

   .. oe:constant:: Input
   
      Charge state is determined in the molecular input file.

   .. oe:constant:: Default 
   
      Same as PH74 above.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

.. oe:constnamespace:: OELigandChargeType

   .. attention::

      |PRELIMINARY-API|

   This namespace contains constants describing the ligand charge types associated with the
   :oe:meth:`OESz::OELigandChargeOptions::SetLigandCharge` method.

   .. oe:constant:: CURRENT
   
      Use the currently existing charges on the ligand.
      Corresponding string value: current

   .. oe:constant:: AM1BCC
   
      Use the :oe:meth:`OEProton::OEAM1BCCCharges` charges. 
      Corresponding string value: am1bcc

   .. oe:constant:: AM1BCCELF10

      Use the :oe:meth:`OEProton::OEAM1BCCELF10Charges` charges.
      Corresponding string value: am1bccelf10

   .. oe:constant:: MMFF

      Use the :oe:meth:`OEProton::OEMMFF94Charges` charges.
      Corresponding string value: mmff


.. oe:namespace:: OESz

..  _OEOptType:

.. oe:constnamespace:: OEOptType

   This namespace contains constants describing the type of optimization method to be used.

   .. _OEOptType_BFGS:

   .. oe:constant:: BFGS
   
      This flag sets the Broyden–Fletcher–Goldfarb–Shanno (BFGS) optimizer.
      It is the default optimizer in Szybki.

   .. _OEOptType_CG:

   .. oe:constant:: CG
   
      This flag selects the conjugate gradient optimizer instead of
      the default :oe:const:`OESz::OEOptType::BFGS`.

   .. _OEOptType_SD:

   .. oe:constant:: SD

      This flag selects the steepest descent optimizer.

   .. _OEOptType_SD_BFGS:

   .. oe:constant:: SD_BFGS

      This flag selects 5 steps of :oe:const:`OESz::OEOptType::SD` pre-optimization
      followed by complete BFGS optimization.

   .. _OEOptType_SD_CG:

   .. oe:constant:: SD_CG

      This flag selects 5 steps of :oe:const:`OESz::OEOptType::SD` pre-optimization
      followed by complete CG optimization.

   .. _OEOptType_NEWTON:

   .. oe:constant:: NEWTON

      This flag selects Newton optimizer.
      It includes 1-20 steps of :oe:const:`OESz::OEOptType::SD` preconditioning depending
      on initial gradients and the size of the input molecule. 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

..  _OESz_OEOptimizationType:

.. oe:constnamespace:: OEOptimizationType

   .. attention::

      |PRELIMINARY-API|

   This namespace contains constants describing the force field type

   ..  _OESz_OEOptimizationType_Cartesian:

   .. oe:constant:: Cartesian
   
      Optimization in atomic Cartesian coordinates

   ..  _OESz_OEOptimizationType_PoseCartesian:

   .. oe:constant:: PoseCartesian
   
      Constrained, to preserve the pose, optimization in atomic Cartesian coordinates.
      Optimization is performed in multiple steps, with additional harmonic constraint
      potentials added to restrict the motion of the heavy atoms of the ligand in the 
      preliminary steps of optimization, followed by regular atomic cartesian coordinates 
      optimization.


.. oe:namespace:: OESz

.. oe:constnamespace:: OEPotentialTerms

   This namespace contains constants describing potential terms which might be calculated
   in different Szybki runs. Entries: :oe:const:`OESz::OEPotentialTerms::VdW`, 
   :oe:const:`OESz::OEPotentialTerms::Coulomb`, :oe:const:`OESz::OEPotentialTerms::Bond`,
   :oe:const:`OESz::OEPotentialTerms::Bend`, :oe:const:`OESz::OEPotentialTerms::StretchBend`,
   :oe:const:`OESz::OEPotentialTerms::Torsion` and 
   :oe:const:`OESz::OEPotentialTerms::ImproperTorsion` 
   correspond to the total MMFF94 or Smirnoff potential terms.
   In the case of partial optimization of the protein, entries with a prefix ``Ligand`` refer to
   the force field terms of the ligand (for example :oe:const:`OESz::OEPotentialTerms::LigandVdW`),
   while entries with a prefix ``Protein`` (for example :oe:const:`OESz::OEPotentialTerms::ProteinVdW`)
   are for the MMFF94 or Smirnoff terms of the flexible part of the protein.
   Force field terms describing VdW and Coulomb interactions between the ligand and the flexible part of 
   the protein are defined with the constants :oe:const:`OESz::OEPotentialTerms::ProteinLigandVdW` 
   and :oe:const:`OESz::OEPotentialTerms::ProteinLigandCoulomb` respectively.
   Term :oe:const:`OESz::OEPotentialTerms::ProteinLigandInteraction` describes complete ligand-protein 
   interaction according to the protein electrostatic model chosen. 
   Values defined by :oe:const:`OESz::OEPotentialTerms::SheffieldSolvation`, 
   :oe:const:`OESz::OEPotentialTerms::PBSolvation` and :oe:const:`OESz::OEPotentialTerms::CavitySolvation`
   refer to solvation energies used to optimize a ligand in solution, while the term
   :oe:const:`OESz::OEPotentialTerms::HarmonicConstraint` determines the he value of the imposed harmonic 
   constraint. Entries: :oe:const:`OESz::OEPotentialTerms::VdWProteinLigand`, 
   :oe:const:`OESz::OEPotentialTerms::CoulombProteinLigand`, 
   :oe:const:`OESz::OEPotentialTerms::ProteinDesolvation`, 
   :oe:const:`OESz::OEPotentialTerms::LigandDesolvation`, :oe:const:`OESz::OEPotentialTerms::SolventScreening`,
   :oe:const:`OESz::OEPotentialTerms::GridCoulomb` and :oe:const:`OESz::OEPotentialTerms::ExactCoulomb` are
   used to break down the total protein-ligand interaction energy into components.
   Value of the :oe:const:`OESz::OEPotentialTerms::ProteinPseudoLigandInteraction` represents 
   the interaction of the flexible part of of the optimized protein-ligand system (ligand + flexible part 
   of the protein) with the rest of the protein and as such is not an observable quantity.
   When Amber force field is applied for protein-ligand interaction, values of 
   :oe:const:`OESz::OEPotentialTerms::ProteinLigandAmberVdW` and 
   :oe:const:`OESz::OEPotentialTerms::ProteinLigandAmberCoulomb` are used for the corresponding vdW and
   Coulomb protein-ligand energies. Term :oe:const:`OESz::OEPotentialTerms::TorsionHarmonicConstraint` 
   is the value of the constraint torsion harmonic potential. Two terms: 
   :oe:const:`OESz::OEPotentialTerms::IEFFInteraction` and :oe:const:`OESz::OEPotentialTerms::InterLigandIEFF`
   are IEFF energies, total and interligand respectively. The latter has nonzero value when more than one 
   ligand are present in the active site of the protein.

   .. oe:constant:: VdW
   
      Value of vdW energy

   .. oe:constant:: Coulomb
   
      Value of Coulomb energy

   .. oe:constant:: Bond
   
      Value of bond stretch energy

   .. oe:constant:: Bend
   
      Value of angle bend energy

   .. oe:constant:: StretchBend
   
      Value of stretch-bend energy. This potential term appears only when MMFF force field is used 

   .. oe:constant:: Torsion
   
      Value of torsion energy

   .. oe:constant:: ImproperTorsion
   
      Value of improper torsion energy

   .. oe:constant:: LigandVdW
   
      Value of ligand vdW energy

   .. oe:constant:: LigandCoulomb
   
      Value of ligand Coulomb energy

   .. oe:constant:: LigandBond
   
      Value of ligand bond energy

   .. oe:constant:: LigandBend
   
      Value of ligand angle bend energy

   .. oe:constant:: LigandStretchBend
   
      Value of ligand stretch-bend energy. This potential term appears only when MMFF force field is used

   .. oe:constant:: LigandTorsion
   
      Value of ligand torsion energy

   .. oe:constant:: LigandImproperTorsion
   
      Value of ligand improper torsion energy

   .. oe:constant:: ProteinVdW
   
      Value of protein vdW energy

   .. oe:constant:: ProteinCoulomb
   
      Value of protein Coulomb energy

   .. oe:constant:: ProteinBond
   
      Value of protein bond energy

   .. oe:constant:: ProteinBend
   
      Value of protein angle bend energy

   .. oe:constant:: ProteinStretchBend
   
      Value of protein stretch-bend energy. This potential term appears only when MMFF force field is used

   .. oe:constant:: ProteinTorsion
   
      Value of protein torsion energy

   .. oe:constant:: ProteinImproperTorsion
   
      Value of protein improper torsion energy

   .. oe:constant:: ProteinLigandVdW
   
      Value of protein-ligand vdW energy

   .. oe:constant:: ProteinLigandCoulomb
   
      Value of protein-ligand Coulomb energy

   .. oe:constant:: ProteinLigandInteraction
   
      Value of total protein-ligand interaction

   .. oe:constant:: SheffieldSolvation
   
      Value of Sheffield solvation energy

   .. oe:constant:: HarmonicConstraint
   
      Value of atom harmonic constraint energy

   .. oe:constant:: PBSolvation
   
      Value of PB solvation energy

   .. oe:constant:: CavitySolvation
   
      Value of cavity solvation energy

   .. oe:constant:: VdWProteinLigand
   
      Value of protein-ligand vdW interaction energy

   .. oe:constant:: CoulombProteinLigand
   
      Value of protein-ligand Coulomb interaction energy

   .. oe:constant:: ProteinDesolvation
   
      Value of protein desolvation energy

   .. oe:constant:: LigandDesolvation
   
      Value of ligand desolvation energy

   .. oe:constant:: SolventScreening
   
      Value of PB solvent screening energy

   .. oe:constant:: GridCoulomb
   
      Value of protein-ligand Coulomb energy on grid

   .. oe:constant:: ExactCoulomb
   
      Value of exact protein-ligand Coulomb energy

   .. oe:constant:: ProteinPseudoLigandInteraction
   
      Value of ligand and flexible protein (pseudoligand) interaction with the rest of the protein energy

   .. oe:constant:: ProteinLigandAmberVdW

      Value of Amber protein-ligand vdW energy

   .. oe:constant:: ProteinLigandAmberCoulomb

      Value of Amber protein-ligand Coulomb energy

   .. oe:constant:: TorsionHarmonicConstraint
   
      Value of torsion harmonic constraint energy

   .. oe:constant:: IEFFInteraction

      Value of total IEFF intermolecular energy

   .. oe:constant:: InterLigandIEFF

      Value of interligand IEFF energy 

   .. oe:constant:: Max
   
      Number of potential terms


.. oe:namespace:: OESz

.. oe:constnamespace:: OEProtFlex

   This namespace contains constants describing partial flexibility of protein receptor which
   are included during bound ligand optimization.

   .. oe:constant:: NoFlex
   
      No protein-flexibility. 

   .. oe:constant:: PolarH
   
      Polar hydrogens (for example hydroxyl hydrogens in serine) within specified distance from
      a ligand will be optimized.   

   .. oe:constant:: SideChains
   
      Residue side chains within specified distance from a bound ligand will be optimized.

   .. oe:constant:: Residues
   
      Complete residues within specified distance from a bound ligand will be optimized.

   .. oe:constant:: ResidueList

      Complete residues specified by the user will be optimized.

   .. oe:constant:: SideChainsList

      Residue side chains specified by the user will be optimized.

   .. oe:constant:: PolarHResList

      Polar hydrogens of residues specified by the user will be optimized.


.. oe:namespace:: OESz

.. oe:constnamespace:: OEProteinElectrostatics

   This namespace contains constants describing handling of protein-ligand electrostatics.

   .. oe:constant:: NoElectrostatics
   
      No protein-ligand electrostatic interaction included. 

   .. oe:constant:: GridPB
   
      Protein electrostatic potential as a solution of PB equation is stored on a grid and used
      to calculate its electrostatic interaction with any ligand placed inside the protein.  

   .. oe:constant:: GridCoulomb
   
      Protein Coulomb electrostatic potential is stored on a grid and used to calculate 
      its electrostatic interaction with any ligand placed inside the protein.

   .. oe:constant:: ExactCoulomb
   
      Exact Coulombic potential used to calculate protein-ligand electrostatic interaction.

   .. oe:constant:: SolventPBForces
   
      Complete PB protein-ligand interaction in solvent is used. Electrostatic protein-ligand interaction
      is a sum of Coulomb, solvent screening, protein desolvation and ligand desolvation terms.   


.. oe:namespace:: OESz

.. oe:constnamespace:: OERunType

   This namespace contains constants describing the type of optimization run.

   .. oe:constant:: SinglePoint

      Indicates a single-point geometry run. 

   .. oe:constant:: TorsionsOpt
 
      Optimization in torsional coordinates. In the case of a ligand in the protein active   
      site, translational and rotational degrees of freedom are included in the optimization.
      Terms ``torsional coordinates`` defines a set of rotors in the molecules. Numerical 
      values of ``torsional coordinates`` are dihedral angles defined by Cartesian coordinates
      of 4 bonded atoms ``a-b-c-d`` where the middle bond between atoms b and c is a
      rotatable bond. Please look at the OEChem documentation for the definition of
      ``rotatable bond``. Bonds a-b and c-d are selected arbitrarily but uniquely, so a single  
      dihedral angle is assigned to each torsional coordinate. ``Torsional coordinates`` are
      a subset of ``torsional space``, however usually  the latter term is used  
      synonymously with the former.

   .. oe:constant:: CartesiansOpt
   
      Optimization in atomic Cartesian coordinates.

   .. oe:constant:: SolidBodyOpt
   
      This flag applies only for the optimization of a ligand inside the protein. Both
      translational and rotational degrees of freedom are optimized. Term ``solid body
      optimization`` means that only 6 degrees of freedom are allowed to change during
      optimization. Those are 3 translational and 3 rotational degrees of freedom.
      In our implementation 3 rotational degrees of freedom are described by 4 quaternions.
      Please consult any molecular physics or mechanics textbook for the definition of 
      terms ``translational-rotational degrees of freedom`` and ``quaternions``.



.. oe:namespace:: OESz

..  _OESz_OESolventModel:

.. oe:constnamespace:: OESolventModel

   This namespace contains constants describing solvation model of a molecule in solution

   ..  _OESz_OESolventModel_NoSolv:

   .. oe:constant:: NoSolv
   
      No solvation. Gas-phase molecule.

   ..  _OESz_OESolventModel_Sheffield:

   .. oe:constant:: Sheffield
   
      Simplified analytical electrostatic solvation model used.

   ..  _OESz_OESolventModel_PB:

   .. oe:constant:: PB
   
      Poisson–Boltzmann electrostatic solvation model used.

   ..  _OESz_OESolventModel_Cavity:

   .. oe:constant:: Cavity
   
      Surface Area hydrophobic solvation model used. It might be used in combination with
      electrostatic PB or Sheffield solvation models.        



.. _OESzConstants:

*******************
OESz Constants
*******************

.. oe:namespace:: OESz

.. toctree::

   OEEntropyMethod
   OEEnvType
   OEForceFieldType
   OEOptType
   OEPotentialTerms
   OEProteinElectrostatics
   OERunType
   OESolventModel
   OEAtomicRadii
   OEProtFlex
   OEIonicState
   OEFreeFormReturnCode
   OEFreeFormWarning


.. _preliminary_OESzConstants:

***************************
Preliminary OESz Constants
***************************

.. oe:namespace:: OESz

.. toctree::

   OEComplexFFType
   OELigandChargeType
   OEOptimizationType
   OESzybkiReturnCode


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESz

..  _OESz_OESzybkiReturnCode:

.. oe:constnamespace:: OESzybkiReturnCode

   .. attention::

      |PRELIMINARY-API|

   This namespace contains constants describing the force field type

..  _OESz_OESzybkiReturnCode_Success:

   .. oe:constant:: Success
   
      Success.

..  _OESz_OESzybkiReturnCode_ExcessiveOverlap:

   .. oe:constant:: ExcessiveOverlap
   
      Failed due to excessive overlap. 

..  _OESz_OESzybkiReturnCode_AromaticRingDev:

   .. oe:constant:: AromaticRingDev
   
      Failed due to excessive deviation from planarity for aromatic rings. Excessive
      deviation is defined if average deviation exceeds 5 degrees or if certain torsion 
      exceeds a maximum of 10 degrees

..  _OESz_OESzybkiReturnCode_IncompleteOpt:

   .. oe:constant:: IncompleteOpt

      Optimization did not reach desired gradient tolerance, and finished due to exceeding maximum iterations.

..  _OESz_OESzybkiReturnCode_OptimizerFailed:

   .. oe:constant:: OptimizerFailed

      Optimizer failed to find solution.

..  _OESz_OESzybkiReturnCode_FFNeedHessiens:

   .. oe:constant:: FFNeedHessiens

      Requires a forcefield with second derivative implementation.

..  _OESz_OESzybkiReturnCode_InvalidOptions:

   .. oe:constant:: InvalidOptions

      Invalid Options.

..  _OESz_OESzybkiReturnCode_ContainsImplicitH:

   .. oe:constant:: ContainsImplicitH

      Contains Implicit Hydrogens.

..  _OESz_OESzybkiReturnCode_ProteinFailedFF:

   .. oe:constant:: ProteinFailedFF

      Failed due to inability to assign protein force field.

..  _OESz_OESzybkiReturnCode_ProteinMissing3D:

   .. oe:constant:: ProteinMissing3D

      Failed due to input protein not having 3D coordinates.

..  _OESz_OESzybkiReturnCode_ProteinMissingCharge:

   .. oe:constant:: ProteinMissingCharge

      Failed due to input protein not having charges assigned.

..  _OESz_OESzybkiReturnCode_ProteinNotSet:

   .. oe:constant:: ProteinNotSet

      Failed due to input protein missing.

..  _OESz_OESzybkiReturnCode_LigandFailedFF:

   .. oe:constant:: LigandFailedFF

      Failed due to inability to assign ligand force field.

..  _OESz_OESzybkiReturnCode_LigandMissing3D:

   .. oe:constant:: LigandMissing3D

      Failed due to input ligand not having 3D coordinates.

..  _OESz_OESzybkiReturnCode_LigandMissingCharge:

   .. oe:constant:: LigandMissingCharge

      Failed due to input ligand not having charges assigned.

..  _OESz_OESzybkiReturnCode_LigandFailedCharge:

   .. oe:constant:: LigandFailedCharge

      Failed due to inability to assign ligand charges.

..  _OESz_OESzybkiReturnCode_Failed:

   .. oe:constant:: Failed

      Failed.


.. oe:namespace:: OESz

.. meta::
   :keywords: OEEntropy

.. _OESz_OEBoundLigandEntropy:

.. oe:function:: OEBoundLigandEntropy

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEBoundLigandEntropy(OEEntropyResults& res,
                                       const OEChem::OEMolBase& protein,
                                       const OEChem::OEMCMolBase& poses,
                                       const OEBoundEntropyOptions& opts = OEBoundEntropyOptions())
         unsigned OEBoundLigandEntropy(OEEntropyResults& res,
                                       const OEBio::OEDesignUnit& du,
                                       const unsigned int proteinMask,
                                       const OEChem::OEMCMolBase& poses,
                                       const OEBoundEntropyOptions& opts = OEBoundEntropyOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEBoundLigandEntropy(res: OEEntropyResults,
                              protein: Union[OEGraphMol,OEMol,OEQMol],
                              poses: OEMol,
                              opts: OEBoundEntropyOptions = OEBoundEntropyOptions()) -> int
         OEBoundLigandEntropy(res: OEEntropyResults, du: OEDesignUnit,
                              proteinMask: int, poses: OEMol,
                              opts: OEBoundEntropyOptions = OEBoundEntropyOptions()) -> int

   Estimates entropy of a ligand bound in the rigid protein receptor.
   Returns error messages corresponding to the return codes defined in
   :oe:constns:`OESz::OESzybkiReturnCode` namespace.

   *res*
     Instance or the results class from which numerical entropy values can be retrieved.
     :ref:`OEEntropyResults <OESz_OEEntropyResults>`.

   *protein*
     Protein receptor object.

   *du*
     In the second overloaded function, instead of a protein molecule, a design unit object is used.
     The advantage of this alternative method is a possibility of including cofactors, solvent and
     other molecules which are present in the 

   *poses*
     Ensemble of poses for which ligand bound entropy will be estimated.

   *opts*
     The option that stores parameters for entropy estimation, in particular force field and charging
     method used to assigned partial charges to a ligand.
     :ref:`OEBoundEntropyOptions <OESz_OEBoundEntropyOptions>`.

.. _OESz_OELigandEntropy:
  
.. oe:function:: OELigandEntropy

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OELigandEntropy(OEEntropyResults& res,
                                  const OEChem::OEMCMolBase& ensemble,
                                  const OELigandEntropyOptions& opts = OELigandEntropyOptions())

   .. oe:language:: python

      .. oe:api:: python

         OELigandEntropy(res: OEEntropyResults, ensemble: OEMol,
                         opts: OELigandEntropyOptions = OELigandEntropyOptions()) -> int

   Estimates entropy of a free ligand in solution or in vacuum.
   Returns error messages corresponding to the return codes defined in
   :oe:constns:`OESz::OESzybkiReturnCode` namespace.

   *res*
     Instance or the results class from which numerical entropy values can be retrieved.
     :ref:`OEEntropyResults <OESz_OEEntropyResults>`.

   *ensemble*
     Ensemble of conformations for which free ligand entropy will be estimated

   *opts*
     The option that stores parameters for entropy estimation, in particular force field and charging
     method used to assigned partial charges to a ligand.
     :ref:`OELigandEntropyOptions <OESz_OELigandEntropyOptions>`.
                               
   .. seealso::

      * :ref:`OEEntropyResults <OESz_OEEntropyResults>` class
      * :ref:`OEBoundEntropyOptions <OESz_OEBoundEntropyOptions>` class
      * :ref:`OELigandEntropyOptions <OESz_OELigandEntropyOptions>` class



.. # split from OESzFunctions.rst:7

.. oe:namespace:: OESz

.. meta::
   :keywords: OEEstimateConfFreeEnergies

.. oe:function:: OEEstimateConfFreeEnergies

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEEstimateConfFreeEnergies(OEFreeFormConfResults& results,
                                         OEChem::OEMCMolBase& moldst,
                                         const OEChem::OEMCMolBase& molsrc,
                                         const OEFreeFormConfOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEEstimateConfFreeEnergies(res: OEFreeFormConfResults, dst: OEMol,
                                    src: OEMol, opts: OEFreeFormConfOptions) -> bool

   .. warning::

      This function should not be used on 32-bit platforms because
      the memory requirements are too high.
                                     
   Estimates the Gibbs free energy to convert an ensemble of solution
   conformations into a state where only a single specific conformation
   is present as described in the theory section.
   Function returns ``true`` if the calculation was successful, ``false`` 
   otherwise. Results are accessible from the ``results`` object 
   (see :ref:`OEFreeFormConfResults <OESz_OEFreeFormConfResults>`). The ensemble of unique
   conformations is returned as a multiconformer molecule
   ``moldst``. The third argument represents the input molecule, and
   the last one contains user selected options (see
   :ref:`OEFreeFormConfOptions <OESz_OEFreeFormConfOptions>`).



.. # split from OESzFunctions.rst:32

.. oe:namespace:: OESz

.. meta::
   :keywords: OEEstimateSolvFreeEnergy

.. oe:function:: OEEstimateSolvFreeEnergy

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEEstimateSolvFreeEnergy(OEFreeFormSolvResults& results,
                                       OEChem::OEMolBase& dst,
                                       const OEChem::OEMCMolBase& src,
                                       const OEFreeFormSolvOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEEstimateSolvFreeEnergy(res: OEFreeFormSolvResults,
                                  dst: Union[OEGraphMol,OEMol,OEQMol],
                                  src: OEMol, opts: OEFreeFormSolvOptions) -> bool

   Estimates the Gibbs energy of solvation, according to the algorithm
   described in the theory section. Function returns ``true`` if the
   calculation was successful, ``false`` otherwise. Results are
   accessible from the ``results`` object (see
   :ref:`OEFreeFormSolvResults <OESz_OEFreeFormSolvResults>`). The second parameter returns
   the molecule representing the structure selected by the algorithm for
   solvation calculation. Third and fourth arguments are the input
   molecule and an object containing user options (see
   :ref:`OEFreeFormSolvOptions <OESz_OEFreeFormSolvOptions>`) respectively.



.. # split from OESzFunctions.rst:51

.. oe:namespace:: OESz

.. meta::
   :keywords: OEGetEnergyTermName

.. oe:function:: OEGetEnergyTermName

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEGetEnergyTermName(unsigned int)

   .. oe:language:: python

      .. oe:api:: python

         OEGetEnergyTermName(arg1: int) -> str



.. oe:namespace:: OESz

.. meta::
   :keywords: OEGetFreeFormError

.. oe:function:: OEGetFreeFormError

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetFreeFormError(const unsigned int)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFreeFormError(argErrorCode: int) -> str

   Returns error messages corresponding to return codes defined in
   :oe:constns:`OESz::OEFreeFormReturnCode` namespace.



.. meta::
   :keywords: OEGetSzybkiError

.. oe:namespace:: OESz

..  _OESz_OEGetSzybkiError:

.. oe:function:: OEGetSzybkiError

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetSzybkiError(const unsigned)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSzybkiError(code: int) -> str

   Returns error messages corresponding to return codes defined in
   :oe:constns:`OESz::OESzybkiReturnCode` namespace.


.. # split from OESzFunctions.rst:58

.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiGetArch

.. oe:function:: OESzybkiGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESzybkiGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OESzybkiGetArch() -> str



.. # split from OESzFunctions.rst:65

.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiGetLicensee

.. oe:function:: OESzybkiGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESzybkiGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OESzybkiGetLicensee(licensee: str) -> bool



.. # split from OESzFunctions.rst:72

.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiGetPlatform

.. oe:function:: OESzybkiGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESzybkiGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OESzybkiGetPlatform() -> str



.. # split from OESzFunctions.rst:79

.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiGetRelease

.. oe:function:: OESzybkiGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESzybkiGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OESzybkiGetRelease() -> str



.. # split from OESzFunctions.rst:86

.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiGetSite

.. oe:function:: OESzybkiGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESzybkiGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OESzybkiGetSite(site: str) -> bool



.. # split from OESzFunctions.rst:93

.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiGetVersion

.. oe:function:: OESzybkiGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OESzybkiGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OESzybkiGetVersion() -> int



.. oe:namespace:: OESz

.. meta::
   :keywords: OETorsionScan

..  _OESz_OETorsionScan:

.. oe:function:: OETorsionScan

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OETorsionScanResult>* OETorsionScan(OEChem::OEMCMolBase& dst,
                                                                  const OEChem::OEMCMolBase& src,
                                                                  const OEChem::OETorsion& torsion,
                                                                  const OETorsionScanOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OETorsionScan(dst: OEMol, src: OEMol, torsion: OETorsion,
                       opts: OETorsionScanOptions) -> Iterable[OETorsionScanResult]

   Performs potential energy scan for a selected torsion in the input molecule.
   Torsion scan is preformed by a series of constrained Newton optimizations in which
   all internal degrees of freedom but selected torsion, are optimized.
   Returns an iterator to the :ref:`OETorsionScanResult <OESz_OETorsionScanResult>` objects from which the
   user can obtain actual values of the torsion angle within :math:`[0.0^{\circ}, 360.0^{\circ}]` 
   range and the corresponding relative energies.

   *dst*
     The output multi-conformation molecule that stores conformations corresponding to the
     points on the scan.

   *src*
     The input molecule of which torsion is scanned.

   *torsion*
     The torsion of the input molecule that is being scanned.

   *opts*
     The option that stores parameters for the scan such as force field, environment (vacuum or solution),
     and resolution (:ref:`OETorsionScanOptions <OESz_OETorsionScanOptions>`).
  
   .. note::

      Using multiple conformations for the input molecule (`src`)
      is not a requirement as the function will work for a single conformation.
      However using as many as possible conformations is recommended because it increases
      the probability of finding the minimum energy path for a given torsion.
      The indication that the torsion profile is not the minimum energy path is
      the occurrence of sharp drop(s) of potential energy, or/and different energy values
      obtained for 0.0 and 360.0 degrees. Increasing the number of the input geometries in such a
      situation might remove those symptoms.   

   .. note::

      As the function is identifying the minimum energy path the output conformations can come
      from different input conformations this means the SD data from the input conformations
      is not passed through to the output molecule.

   .. seealso::

      * :ref:`OETorsionScanOptions <OESz_OETorsionScanOptions>` class
      * :ref:`OETorsionScanResult <OESz_OETorsionScanResult>` class

   **Example to scan all torsions of a molecule:**

   .. oe:source:: TorsionScan.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OETORSIONSCAN

   .. oe:source:: TorsionScan.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OETORSIONSCAN

   .. oe:source:: TorsionScan.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OETORSIONSCAN

   .. oe:source:: TorsionScan.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OETORSIONSCAN


*******************************************************************************
OESz Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEEstimateConfFreeEnergies.rst
   OEEstimateSolvFreeEnergy.rst
   OEGetEnergyTermName.rst
   OEGetFreeFormError.rst
   OEGetSzybkiError.rst
   OESzybkiGetArch.rst
   OESzybkiGetLicensee.rst
   OESzybkiGetPlatform.rst
   OESzybkiGetRelease.rst
   OESzybkiGetSite.rst
   OESzybkiGetVersion.rst
   OETorsionScan.rst
   OEEntropy.rst


.. _szybki_part_basic_api:

********************************
API
********************************

.. toctree::
   :maxdepth: 2

   OESzClasses/OESzClasses
   OESzConstants/OESzConstants
   OESzFunctions/index

********************************
Preliminary API
********************************

.. toctree::
   :maxdepth: 2

   OESzClasses/OESzClasses-preliminary
   OESzConstants/OESzConstants-preliminary



.. _szybki_part_examples:
.. _chapter_szybki_examples:

********************************************************************************
Examples: Working with Szybki TK
********************************************************************************

The basic *Szybki TK* API is provided to the users in the :ref:`OESzybki <OESz_OESzybki>`,
:ref:`OESzybkiOptions <OESz_OESzybkiOptions>`, :ref:`OESzybkiResults <OESz_OESzybkiResults>` and
:ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` classes. In addition, when the purpose is to
calculate compound properties, such as solvation free energy or free energy of
selecting specific conformations out of the ensemble, the higher level API are defined in
the free functions, :oe:func:`OESz::OEEstimateSolvFreeEnergy` and
:oe:func:`OESz::OEEstimateConfFreeEnergies`.

Ligand Energetics and Optimization
==================================

.. _section_simple_vacuum_example:

Single ligand in vacuum
-----------------------
The following example illustrates how to optimize a single ligand in vacuum. As one
can see assuming a molecule is successfully read, only two objects are needed to
perform the optimization: :ref:`OESzybki <OESz_OESzybki>` and :ref:`OESzybkiResults <OESz_OESzybkiResults>`.
The latter is passed as the second parameter to the parenthesis operator
:oe:meth:`OESz::OESzybki::operator()`. Molecule with the optimized coordinates is
returned as a first parameter. Optimization is done using the default MMFF94. Final
energy results are available as SD tags in the returned molecule and optionally with
a call of a method :oe:meth:`OESz::OESzybkiResults::Print`.

.. oe:source:: simple_vacuum.cpp
   :language: c++
   :caption:  Simple Ligand in a Vacuum
   :refnum:   1

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_vacuum.cpp <../../../../sublibs/tklibs/szybki/examples/simple_vacuum.cpp>`

.. oe:source:: simple_vacuum.py
   :language: python
   :caption:  Simple Ligand in a Vacuum
   :refnum:   1

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_vacuum.py <../../../../wrappers/python/examples/szybki/simple_vacuum.py>`

.. oe:source:: SimpleVacuum.java
   :language: java
   :caption:  Simple Ligand in a Vacuum
   :refnum:   1

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleVacuum.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/SimpleVacuum.java>`

.. oe:source:: SimpleVacuum.cs
   :language: csharp
   :caption:  Simple Ligand in a Vacuum
   :refnum:   1

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleVacuum.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/SimpleVacuum.cs>`

.. _section_simple_vacuum_smirnoff_example:

Single ligand in vacuum using SMIRNOFF
----------------------------------------

The following example illustrates how to optimize a single ligand in vacuum using
SMIRNOFF (see :ref:`section_smirnoff`). Only two objects are needed to perform
the optimization: :ref:`OESzybki <OESz_OESzybki>` and :ref:`OESzybkiResults <OESz_OESzybkiResults>`.
The latter is passed as the second parameter to the parenthesis operator
:oe:meth:`OESz::OESzybki::operator()`. Partial charges have to be preassigned to the
input molecule. Molecule with the optimized coordinates is returned as a first parameter.
Final energy results are available as SD tags in the returned molecule and optionally
with a call of a method :oe:meth:`OESz::OESzybkiResults::Print`.

.. oe:source:: simple_smirnoff.cpp
   :language: c++
   :caption:  Simple Ligand in a Vacuum Using SMIRNOFF
   :refnum:   2

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_vacuum.cpp <../../../../sublibs/tklibs/szybki/examples/simple_vacuum.cpp>`

.. oe:source:: simple_smirnoff.py
   :language: python
   :caption:  Simple Ligand in a Vacuum Using SMIRNOFF
   :refnum:   2

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_smirnoff.py <../../../../wrappers/python/examples/szybki/simple_smirnoff.py>`

.. oe:source:: SimpleSmirnoff.java
   :language: java
   :caption:  Simple Ligand in a Vacuum Using SMIRNOFF
   :refnum:   2

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleSmirnoff.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/SimpleSmirnoff.java>`

.. oe:source:: SimpleSmirnoff.cs
   :language: csharp
   :caption:  Simple Ligand in a Vacuum Using SMIRNOFF
   :refnum:   2

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleSmirnoff.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/SimpleSmirnoff.cs>`

.. _section_ligand_multiple_options_example:

Optimization of a set of ligands
--------------------------------

The next example illustrates the usage of Szybki TK to optimize a set of compounds with
the MMFF94 force field in vacuum or in solution using Sheffield solvation model.
Optionally attractive VdW can be removed. The optimization is done by default in full
Cartesian coordinates, however torsion space optimization or single point calculation
could be done too. A group of atoms which belong to specified SMARTS pattern might be
excluded from optimization so their positions will be fixed at their initial coordinates.
Note that the :ref:`OESzybki <OESz_OESzybki>` object is made with a constructor which takes
the instance of the :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` class.

.. oe:source:: ligand_multiple_options.cpp
   :language: c++
   :caption:  Optimization of a Set of Ligands
   :refnum:   3

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ligand_multiple_options.cpp <../../../../sublibs/tklibs/szybki/examples/ligand_multiple_options.cpp>`

.. oe:source:: ligand_multiple_options.py
   :language: python
   :caption:  Optimization of a Set of Ligands
   :refnum:   3

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ligand_multiple_options.py <../../../../wrappers/python/examples/szybki/ligand_multiple_options.py>`

.. oe:source:: LigandMultipleOptions.java
   :language: java
   :caption:  Optimization of a Set of Ligands
   :refnum:   3

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`LigandMultipleOptions.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/LigandMultipleOptions.java>`

.. oe:source:: LigandMultipleOptions.cs
   :language: csharp
   :caption:  Optimization of a Set of Ligands
   :refnum:   3

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`LigandMultipleOptions.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/LigandMultipleOptions.cs>`

.. _section_simple_newton_example:

Optimization of a single ligand with the Newton-Raphson method
--------------------------------------------------------------

The next example in this section shows how to use Newton-Raphson optimization
method, rather than the default BFGS:

.. oe:source:: simple_newton.cpp
   :language: c++
   :caption:  Optimization of a Single Ligand with the Newton-Raphson Method
   :refnum:   4

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_newton.cpp <../../../../sublibs/tklibs/szybki/examples/simple_newton.cpp>`

.. oe:source:: simple_newton.py
   :language: python
   :caption:  Optimization of a Single Ligand with the Newton-Raphson Method
   :refnum:   4

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_newton.py <../../../../wrappers/python/examples/szybki/simple_newton.py>`

.. oe:source:: SimpleNewton.java
   :language: java
   :caption:  Optimization of a Single Ligand with the Newton-Raphson Method
   :refnum:   4

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleNewton.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/SimpleNewton.java>`

.. oe:source:: SimpleNewton.cs
   :language: csharp
   :caption:  Optimization of a Single Ligand with the Newton-Raphson Method
   :refnum:   4

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleNewton.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/SimpleNewton.cs>`

.. _section_simple_conformer_example:

Optimization of all conformers of a ligand
--------------------------------------------------------------

Finally, the last example in this section shows how to use Newton-Raphson optimization
method on all conformers of a ligand. The current charges of the ligand are used and will
not be changed during the optimization.

.. oe:source:: simple_conformer.cpp
   :language: c++
   :caption:  Optimization of All Conformers of a Ligand
   :refnum:   5

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_conformer.cpp <../../../../sublibs/tklibs/szybki/examples/simple_conformer.cpp>`

.. oe:source:: simple_conformer.py
   :language: python
   :caption:  Optimization of All Conformers of a Ligand
   :refnum:   5

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_conformer.py <../../../../wrappers/python/examples/szybki/simple_conformer.py>`

.. oe:source:: SimpleConformer.java
   :language: java
   :caption:  Optimization of All Conformers of a Ligand
   :refnum:   5

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleConformer.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/SimpleConformer.java>`

.. oe:source:: SimpleConformer.cs
   :language: csharp
   :caption:  Optimization of All Conformers of a Ligand
   :refnum:   5

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleConformer.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/SimpleConformer.cs>`

.. _section_simple_protein_example:

Optimization of a single bound ligand
-------------------------------------

The simplest case is illustrated below.
Notice the usage of the method :oe:meth:`OESz::OESzybki::SetProtein` which tells Szybki
that the ligand is placed inside the protein. Since no protein-ligand electrostatics have been
specified, neither the coordinates types which should be used by the optimizer, the code below
performs the optimization for a rigid ligand using 6 translational-rotational coordinates in
the MMFF94 VdW potential field.

.. oe:source:: simple_protein.cpp
   :language: c++
   :caption:  Optimization of a Single Bound Ligand
   :refnum:   5

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_protein.cpp <../../../../sublibs/tklibs/szybki/examples/simple_protein.cpp>`

.. oe:source:: simple_protein.py
   :language: python
   :caption:  Optimization of a Single Bound Ligand
   :refnum:   5

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_protein.py <../../../../wrappers/python/examples/szybki/simple_protein.py>`

.. oe:source:: SimpleProtein.java
   :language: java
   :caption:  Optimization of a Single Bound Ligand
   :refnum:   5

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleProtein.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/SimpleProtein.java>`

.. oe:source:: SimpleProtein.cs
   :language: csharp
   :caption:  Optimization of a Single Bound Ligand
   :refnum:   5

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleProtein.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/SimpleProtein.cs>`

Protein-Ligand Energetics and Optimization
==========================================

Examples in this section show how to optimize a bound ligand.

.. _section_protein_multiple_options_example:

Optimization of a set of bound ligands in a rigid receptor
----------------------------------------------------------
The next example illustrates the usage of Szybki TK to optimize a set of ligands with MMFF94 force
field inside a protein receptor. By default only VdW protein-ligand interaction is used.
Optionally exact or grid Coulomb potential as well as PB solvent screening potentials could be added.
When grid potential is selected (either Coulomb or PB) optionally it could be saved or read in when
the corresponding grid file is present in the specified directory. Notice that when the exact
Coulomb electrostatics is chosen, also the exact VdW potential is chosen (method
:oe:meth:`OESz::OESzybkiProteinOptions::SetExactVdWProteinLigand`) which allows for tight gradients
convergence (methods :oe:meth:`OESz::OESzybkiOptOptions::SetMaxIter` and :oe:meth:`OESz::OESzybkiOptOptions::SetGradTolerance`). By default ligand is treated as
a solid body, that is only its translational and rotational degrees of freedom are optimized. Optionally
also torsional degrees could be optimized. In this example protein receptor is rigid. Molecular input
file should contain initial 3D coordinates of molecules in any format supported by OEChem TK. Output
file is specified with the -out flag. In addition a log file containing energy data terms values is
written to stdout or a file specified by -log.

.. oe:source:: protein_multiple_options.cpp
   :language: c++
   :caption:  Optimization of a Set of Bound Ligands in a Rigid Receptor
   :refnum:   7

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`protein_multiple_options.cpp <../../../../sublibs/tklibs/szybki/examples/protein_multiple_options.cpp>`

.. oe:source:: protein_multiple_options.py
   :language: python
   :caption:  Optimization of a Set of Bound Ligands in a Rigid Receptor
   :refnum:   7

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`protein_multiple_options.py <../../../../wrappers/python/examples/szybki/protein_multiple_options.py>`

.. oe:source:: ProteinMultipleOptions.java
   :language: java
   :caption:  Optimization of a Set of Bound Ligands in a Rigid Receptor
   :refnum:   7

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ProteinMultipleOptions.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/ProteinMultipleOptions.java>`

.. oe:source:: ProteinMultipleOptions.cs
   :language: csharp
   :caption:  Optimization of a Set of Bound Ligands in a Rigid Receptor
   :refnum:   7

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ProteinMultipleOptions.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/ProteinMultipleOptions.cs>`

.. _section_flexible_protein_example:

Optimization of a set of bound ligands in a partially flexible receptor
------------------------------------------------------------------------
The next example is very similar with respect to the previous one, but the side chains of the
protein which are within the specified range from the ligand, are made flexible during optimization
(methods :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinFlexibilityType` and
:oe:meth:`OESz::OESzybkiProteinOptions::SetProteinFlexibilityRange`). Optionally, partially optimized
structure can be saved to a file.

.. oe:source:: flexible_protein.cpp
   :language: c++
   :caption:  Optimization of a Set of Bound Ligands in a Partially Flexible Receptor
   :refnum:   8

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`flexible_protein.cpp <../../../../sublibs/tklibs/szybki/examples/flexible_protein.cpp>`

.. oe:source:: flexible_protein.py
   :language: python
   :caption:  Optimization of a Set of Bound Ligands in a Partially Flexible Receptor
   :refnum:   8

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`flexible_protein.py <../../../../wrappers/python/examples/szybki/flexible_protein.py>`

.. oe:source:: FlexibleProtein.java
   :language: java
   :caption:  Optimization of a Set of Bound Ligands in a Partially Flexible Receptor
   :refnum:   8

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FlexibleProtein.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/FlexibleProtein.java>`

.. oe:source:: FlexibleProtein.cs
   :language: csharp
   :caption:  Optimization of a Set of Bound Ligands in a Partially Flexible Receptor
   :refnum:   8

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FlexibleProtein.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/FlexibleProtein.cs>`

.. _section_flexible_residue_example:

Optimization of a bound ligand in a partially flexible receptor
------------------------------------------------------------------------

The next example is very similar with respect to the previous one, but the list of
residue numbers of the protein that are made flexible during optimization is specified
by the ``-residues`` flag (see method :oe:meth:`OESz::OESzybkiProteinOptions::AddFlexibleResidue`).
Partially optimized ligand and protein structures are saved to files specified by the
``-outl`` and ``-outp`` flags, respectively.

.. oe:source:: flex_residues.cpp
   :language: c++
   :caption:  Optimization of a Bound Ligand in a Partially Flexible Feceptor
   :refnum:   9

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`flex_residues.cpp <../../../../sublibs/tklibs/szybki/examples/flex_residues.cpp>`

.. oe:source:: flex_residues.py
   :language: python
   :caption:  Optimization of a Bound Ligand in a Partially Flexible Receptor
   :refnum:   9

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`flex_residues.py <../../../../wrappers/python/examples/szybki/flex_residues.py>`

.. oe:source:: FlexResidues.java
   :language: java
   :caption:  Optimization of a Bound Ligand in a Partially Flexible Feceptor
   :refnum:   9

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FlexResidues.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/FlexResidues.java>`

.. oe:source:: FlexResidues.cs
   :language: csharp
   :caption:  Optimization of a Bound Ligand in a Partially Flexible Feceptor
   :refnum:   9

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FlexResidues.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/FlexResidues.cs>`

.. _section_protein_ligand_PB_example:

Estimation of PB binding for a set of ligands
--------------------------------------------------

This example shows how to fast estimate binding for a set of ligands using PB electrostatics.
Two :ref:`OESzybki <OESz_OESzybki>` objects are instantiated: one for the optimization of bound ligands
in VdW-Coulomb potential, and the second one which performs single-point PB calculations.
Final results are attached as SD tags to the output molecules.

.. oe:source:: protein_ligand_PB.cpp
   :language: c++
   :caption:  Estimation of PB Binding for a Set of Ligands
   :refnum:   10

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`protein_ligand_PB.cpp <../../../../sublibs/tklibs/szybki/examples/protein_ligand_PB.cpp>`

.. oe:source:: protein_ligand_PB.py
   :language: python
   :caption:  Estimation of PB Binding for a Set of Ligands
   :refnum:   10

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`protein_ligand_PB.py <../../../../wrappers/python/examples/szybki/protein_ligand_PB.py>`

.. oe:source:: ProteinLigandPB.java
   :language: java
   :caption:  Estimation of PB Binding for a Set of Ligands
   :refnum:   10

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ProteinLigandPB.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/ProteinLigandPB.java>`

.. oe:source:: ProteinLigandPB.cs
   :language: csharp
   :caption:  Estimation of PB Binding for a Set of Ligands
   :refnum:   10

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ProteinLigandPB.cs <../../../../wrappers/java/examples/openeye/examples/oeszybki/ProteinLigandPB.java>`

.. _section_ligand_flexprotein_newton_example:

Optimization of a bound ligand using Newton-Raphson method
------------------------------------------------------------------------

The last example in this section illustrates how to use SzybkiTK to optimize a ligand in
partially flexible protein with Newton-Raphson optimization method.

.. oe:source:: ligand_flexprotein_newton.cpp
   :language: c++
   :caption:  Optimization of a Bound Ligand Using Newton-Raphson Method
   :refnum:   11

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ligand_flexprotein_newton.cpp <../../../../sublibs/tklibs/szybki/examples/ligand_flexprotein_newton.cpp>`

.. oe:source:: ligand_flexprotein_newton.py
   :language: python
   :caption:  Optimization of a Bound Ligand Using Newton-Raphson Method
   :refnum:   11

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ligand_flexprotein_newton.py <../../../../wrappers/python/examples/szybki/ligand_flexprotein_newton.py>`

.. oe:source:: LigandFlexProteinNewton.java
   :language: java
   :caption:  Optimization of a Bound Ligand Using Newton-Raphson Method
   :refnum:   11

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`LigandFlexProteinNewton.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/LigandFlexProteinNewton.java>`

.. oe:source:: LigandFlexProteinNewton.cs
   :language: csharp
   :caption:  Optimization of a Bound Ligand Using Newton-Raphson Method
   :refnum:   11

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`LigandFlexProteinNewton.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/LigandFlexProteinNewton.cs>`

DU Protein-Ligand Optimization with FF14SB-Parsley
===================================================

Examples in this section show how to optimize a ligand in the protein 
active site using the :ref:`OEFixedProteinLigandOptimizer <OESz_OEFixedProteinLigandOptimizer>` and
the :ref:`OEFlexProteinLigandOptimizer <OESz_OEFlexProteinLigandOptimizer>` classes. Both of these
classes allow use of the FF14SB-Parsley forcefield, along with the MMFF and
the MMFF-AMBER forcefields. These examples also demonstrate how to use
design units as a source for the protein or the ligand. The first example
optimizes an external ligand in a protein active site from a design unit,
and the second example uses both the ligand and the protein from the same
design unit.

Optimization of ligand in a rigid active site
--------------------------------------------------

This examples shows how to optimize a series of ligands in a rigid active site.
The active site input is taken from a OEDesignUnit.

.. oe:source:: OptimizeLigandInDU.py
   :language: python
   :caption:  Optimization of Ligand in a Rigid Active Site
   :refnum:   12

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`OptimizeLigandInDU.py <../../../../wrappers/python/examples/szybki/OptimizeLigandInDU.py>`

Optimization of ligand in a partially flexible active site
------------------------------------------------------------

This examples shows how to optimize a ligand in a partially flexible active site.
In this example, both the ligand and the active site is taken from a single OEDesignUnit.

.. oe:source:: OptimizeDU.py
   :language: python
   :caption:  Optimization of Ligand in a Partially Flexible Active Site
   :refnum:   13

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`OptimizeDU.py <../../../../wrappers/python/examples/szybki/OptimizeDU.py>`

Entropy estimation
======================================

.. _section_ligand_entropy_example:

Estimation of solution ligand entropy
-------------------------------------
The following code illustrates how to estimate compound entropy in solution with Szybki TK.

.. oe:source:: ligand_entropy.cpp
   :language: c++
   :caption:  Ligand Entropy
   :refnum:   14

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ligand_entropy.cpp <../../../../sublibs/tklibs/szybki/examples/ligand_entropy.cpp>`

.. oe:source:: ligand_entropy.py
   :language: python
   :caption:  Ligand Entropy
   :refnum:   14

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ligand_entropy.py <../../../../wrappers/python/examples/szybki/ligand_entropy.py>`

.. oe:source:: LigandEntropy.java
   :language: java
   :caption:  Ligand Entropy
   :refnum:   14

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`LigandEntropy.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/LigandEntropy.java>`

.. oe:source:: LigandEntropy.cs
   :language: csharp
   :caption:  Ligand Entropy
   :refnum:   14

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`LigandEntropy.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/LigandEntropy.cs>`

.. _section_bound_entropy_example:

Estimation of bound ligand entropy
----------------------------------

The next example below shows how to calculate entropy of a bound ligand.

.. oe:source:: bound_entropy.cpp
   :language: c++
   :caption:  Estimation of Bound Ligand Entropy
   :refnum:   15

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`bound_entropy.cpp <../../../../sublibs/tklibs/szybki/examples/bound_entropy.cpp>`

.. oe:source:: bound_entropy.py
   :language: python
   :caption:  Estimation of Bound Ligand Entropy
   :refnum:   15

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`bound_entropy.py <../../../../wrappers/python/examples/szybki/bound_entropy.py>`

.. oe:source:: BoundEntropy.java
   :language: java
   :caption:  Estimation of Bound Ligand Entropy
   :refnum:   15

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`BoundEntropy.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/BoundEntropy.java>`

.. oe:source:: BoundEntropy.cs
   :language: csharp
   :caption:  Estimation of Bound Ligand Entropy
   :refnum:   15

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`BoundEntropy.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/BoundEntropy.cs>`

.. _section_freeformsolv_example:

Solvation free energy estimation
======================================

.. oe:source:: freeformsolv.cpp
   :language: c++
   :caption:  Solvation Free Energy Estimation
   :refnum:   16

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`freeformsolv.cpp <../../../../sublibs/tklibs/szybki/examples/freeformsolv.cpp>`

.. oe:source:: freeformsolv.py
   :language: python
   :caption:  Solvation Free Energy Estimation
   :refnum:   16

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`freeformsolv.py <../../../../wrappers/python/examples/szybki/freeformsolv.py>`

.. oe:source:: FreeFormSolv.java
   :language: java
   :caption:  Solvation Free Energy Estimation
   :refnum:   16

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FreeFormSolv.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/FreeFormSolv.java>`

.. oe:source:: FreeFormSolv.cs
   :language: csharp
   :caption:  Solvation Free Energy Estimation
   :refnum:   16

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FreeFormSolv.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/FreeFormSolv.cs>`

.. _section_freeformconf_example:

Conformations free energy estimation
======================================

   .. warning::

      This capability should not be used on 32-bit platforms because
      the memory requirements are too high.

Simple free energy estimation
------------------------------

The following code illustrates how to use the high level commands from :ref:`OEFreeFormConf <OESz_OEFreeFormConf>`
to estimate conformer free energies in solution with Szybki TK.

.. oe:source:: freeformconf.cpp
   :language: c++
   :caption:  Simple Free Energy Estimation
   :refnum:   17

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`freeformconf.cpp <../../../../sublibs/tklibs/szybki/examples/freeformconf.cpp>`

.. oe:source:: freeformconf.py
   :language: python
   :caption:  Simple Free Energy Estimation
   :refnum:   17

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`freeformconf.py <../../../../wrappers/python/examples/szybki/freeformconf.py>`

.. oe:source:: FreeFormConf.java
   :language: java
   :caption:  Simple Free Energy Estimation
   :refnum:   17

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FreeFormConf.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/FreeFormConf.java>`

.. oe:source:: FreeFormConf.cs
   :language: csharp
   :caption:  Simple Free Energy Estimation
   :refnum:   17

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FreeFormConf.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/FreeFormConf.cs>`

Simple restriction energy estimation
-------------------------------------

The following code illustrates how to use the high level commands from :ref:`OEFreeFormConf <OESz_OEFreeFormConf>`
to estimate restriction energies on conformers, along with conformer free energies in solution, with Szybki TK.

.. oe:source:: freeformconfrstr.cpp
   :language: c++
   :caption:  Simple Restriction Energy Estimation
   :refnum:   18

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`freeformconfrstr.cpp <../../../../sublibs/tklibs/szybki/examples/freeformconfrstr.cpp>`

.. oe:source:: freeformconfrstr.py
   :language: python
   :caption:  Simple Restriction Energy Estimation
   :refnum:   18

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`freeformconfrstr.py <../../../../wrappers/python/examples/szybki/freeformconfrstr.py>`

.. oe:source:: FreeFormConfRstr.java
   :language: java
   :caption:  Simple Restriction Energy Estimation
   :refnum:   18

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FreeFormConfRstr.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/FreeFormConfRstr.java>`

.. oe:source:: FreeFormConfRstr.cs
   :language: csharp
   :caption:  Simple Restriction Energy Estimation
   :refnum:   18

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FreeFormConfRstr.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/FreeFormConfRstr.cs>`

Advanced free energy estimation
------------------------------------

The following code illustrates how to use the low level commands from :ref:`OEFreeFormConfAdvanced <OESz_OEFreeFormConfAdvanced>`
to estimate the conformer free energies in solution with Szybki TK.
These low level methods of estimation gives an advantage over the high level methods of :ref:`OEFreeFormConf <OESz_OEFreeFormConf>`
in that these gives the user control over better managing certain expensive parts of the calculation.

.. oe:source:: freeformconfadvanced.cpp
   :language: c++
   :caption:  Advanced Free Energy Estimation
   :refnum:   19

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`freeformconfadvanced.cpp <../../../../sublibs/tklibs/szybki/examples/freeformconfadvanced.cpp>`

.. oe:source:: freeformconfadvanced.py
   :language: python
   :caption:  Advanced Free Energy Estimation
   :refnum:   19

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`freeformconfadvanced.py <../../../../wrappers/python/examples/szybki/freeformconfadvanced.py>`

.. oe:source:: FreeFormConfAdvanced.java
   :language: java
   :caption:  Advanced Free Energy Estimation
   :refnum:   19

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FreeFormConfAdvanced.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/FreeFormConfAdvanced.java>`

.. oe:source:: FreeFormConfAdvanced.cs
   :language: csharp
   :caption:  Advanced Free Energy Estimation
   :refnum:   19

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FreeFormConfAdvanced.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/FreeFormConfAdvanced.cs>`

Advanced restriction energy estimation
-----------------------------------------

The following code illustrates how to use the low level commands from :ref:`OEFreeFormConfAdvanced <OESz_OEFreeFormConfAdvanced>`
to estimate the restriction energies of conformers, along with conformer free energies in solution, with Szybki TK.
These low level methods of estimation gives an advantage over the high level methods of :ref:`OEFreeFormConf <OESz_OEFreeFormConf>`
in that these gives the user control over better managing certain expensive parts of the calculation.

.. oe:source:: freeformconfadvrstr.cpp
   :language: c++
   :caption:  Advanced Restriction Energy Estimation
   :refnum:   20

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`freeformconfadvrstr.cpp <../../../../sublibs/tklibs/szybki/examples/freeformconfadvrstr.cpp>`

.. oe:source:: freeformconfadvrstr.py
   :language: python
   :caption:  Advanced Restriction Energy Estimation
   :refnum:   20

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`freeformconfadvrstr.py <../../../../wrappers/python/examples/szybki/freeformconfadvrstr.py>`

.. oe:source:: FreeFormConfAdvRstr.java
   :language: java
   :caption:  Advanced Restriction Energy Estimation
   :refnum:   20

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FreeFormConfAdvRstr.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/FreeFormConfAdvRstr.java>`

.. oe:source:: FreeFormConfAdvRstr.cs
   :language: csharp
   :caption:  Advanced Restriction Energy Estimation
   :refnum:   20

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FreeFormConfAdvRstr.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/FreeFormConfAdvRstr.cs>`

Finding similar conformers
---------------------------

The following code illustrates how to find similar conformers to the ones at hand,
from a pool of minimum energy conformers.

.. oe:source:: findsimilarconfs.cpp
   :language: c++
   :caption:  Finding Similar Conformers
   :refnum:   21

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`findsimilarconfs.cpp <../../../../sublibs/tklibs/szybki/examples/findsimilarconfs.cpp>`

.. oe:source:: findsimilarconfs.py
   :language: python
   :caption:  Finding Similar Conformers
   :refnum:   21

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`findsimilarconfs.py <../../../../wrappers/python/examples/szybki/findsimilarconfs.py>`

.. oe:source:: FindSimilarConfs.java
   :language: java
   :caption:  Finding Similar Conformers
   :refnum:   21

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FindSimilarConfs.java <../../../../wrappers/java/examples/openeye/examples/oeszybki/FindSimilarConfs.java>`

.. oe:source:: FindSimilarConfs.cs
   :language: csharp
   :caption:  Finding Similar Conformers
   :refnum:   21

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FindSimilarConfs.cs <../../../../wrappers/csharp/Csharp-Examples/OESzybki/FindSimilarConfs.cs>`

Torsion scan
------------

The following code shows how to scan all torsions in the input molecule

.. oe:source:: TorsionScan.py
   :language: python
   :caption:  Perform torsion scan for all torsions in the input molecule
   :refnum:   22

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`TorsionScan.py <../../../../wrappers/python/examples/szybki/TorsionScan.py>`



.. _szybki_part_releasenotes:

********************************
Release History
********************************

.. toctree::
   :maxdepth: 1

   version2_9_2
   version2_9_1
   version2_9_0
   version2_8_0
   version2_7_1
   version2_7_0
   version2_6_0
   version2_5_1
   version2_5_0
   version2_4_0
   version2_3_1
   version2_3_0
   version2_2_0
   version2_1_0
   version2_0_4
   version2_0_3
   version2_0_2
   version2_0_1
   version2_0_0
   version1_9_2
   version1_9_1
   version1_9_0
   version1_8_7
   version1_8_6
   version1_8_5
   version1_8_4
   version1_8_3
   version1_8_2
   version1_8_1
   version1_7_5
   version1_7_4
   version1_7_3
   version1_7_2
   version1_7_1
   version1_7_0
   version1_6_0
   version1_5_0
   version1_4_0
   version1_3_4



Szybki TK 2.9.2
================================================================================

Minor internal improvements have been made.



.. _section_szybki_releasenotes_134:

Szybki TK 1.3.4
================================================================================

New features
--------------------------------------------------------------------------------
*  Calculation of the constant potential terms at the end of adapted
   optimization can be optionally eliminated, by the usage of the
   function ``void SetCalculateFrozenTerms(bool)``.  This feature
   reduces memory and cpu usage in the case of partial optimization of
   large molecules.

Bug fixes
--------------------------------------------------------------------------------
*  Member function ``ClearFixAtoms()`` did not clear properly previously
   fixed atoms.  As a result, in spite of its use some atoms were
   still fixed. This bug has been fixed.

*  A bug which occasionally caused errors in fixing a subset of atoms was fixed.


.. _section_szybki_releasenotes_140:

Szybki TK 1.4.0
================================================================================

New features
--------------------------------------------------------------------------------
*  Starting from the current release, certain classes of divalent selenium 
   compounds can be handled by SZYBKI. Currently only some compounds in which 
   selenium is bonded to the hydrogen or carbon atoms can be processed. Those 
   compounds include selenols (RSeH) and selenides (RSeR1) in which Se is bonded 
   to alkyl or aromatic carbon atoms, with the following exceptions:
   
   - Se makes a bond with alkyl C which belongs to the 3- or 4-membered ring
   
   - Se makes a bond with aromatic C which belongs to 5-membered ring
   
   In the restriction above the MMFF94 aromaticity model is adopted, so for example
   a pyridine derivative, pyridine-3-selenol can be processed, but a pyran
   derivative 2H-pyran-3-selenol cannot.      
   
*  Previous SZYBKI releases attempted to assign the "closest" MMFF94 atom type
   to those atoms for which a unique MMFF94 type could not be found. Starting 
   from the 1.3.5 SZYBKI Application release this feature is removed, so consequently the input
   molecules containing such atoms will not be processed.

*  Ligand RMSD which might be extracted from OESzybkiResults object,
   can optionally refer to heavy atoms only. A new public function:
   
   ``void SetLigandRMSDHeavy(bool)`` 
   
   in OESzybki class has been added for that purpose.    

Bug fixes
--------------------------------------------------------------------------------
*  A bug causing memory corruption when the function ``SetSideChainsFlexibility()``
   was called after ``SetProten()`` was fixed.

*  Memory leak in ligand torsion optimization inside the partially flexible
   protein receptor was removed. 


.. _section_szybki_releasenotes_150:

Szybki TK 1.5.0
================================================================================

New features
--------------------------------------------------------------------------------
*  Entropy calculations of a ligand in different environments can be performed
   based on the methods described in the recent paper of Wlodek *et. al.* (\ [Wlodek-2010]_\). 

   New methods added to the public API are:

   - :oe:meth:`OESz::OESzybki::GetEntropy`
   - `GetSolutionEntropy`
   - `GetProteinBoundLigandEntropy`
   
*  Default VdW protein-ligand potential used for the optimization of a ligand inside the
   protein binding site is precalculated in the form of a lookup table. This is done
   for the purpose of speed. The exact VdW protein-ligand potential can be used with
   the new method:
   
   - `SetExactVdWProteinLigand`

   when boolean parameter passed is ``true``. Passing ``false`` causes switching to the default form
   of the protein-ligand VdW. The function:

   - `GetExactVdWProteinLigand`

   allows the querying of which form of the VdW potential is used.
   
*  Two functions have been added to the public API in szybki.h. The first new function allows the use of 
   conformation-dependent AM1BCC charges for every conformation in the calculation of PB and Sheffield 
   solvation energies, for protein-ligand Coulomb interactions, and in entropy calculations.
   
   - `SetEveryConfAM1BCCCharges`
      
   The second function returns ``true`` if AM1BCC are being calculated for every conformation, 
   ``false`` otherwise.

   - `GetEveryConfAM1BCCCharges`
   
Bug fixes
-----------------------------------------------------------------------------------------------------
*  In a special situation of ligand optimization in the protein binding site with the 
   use of the electrostatics model determined by the :oe:const:`OESz::OEProteinElectrostatics::ExactCoulomb`,
   constant, when the optimization was preceded by the Zap binding calculations with the same 
   protein and the same ligand, Coulombic interaction resulted in zero value. This bug has been fixed.  


.. _section_szybki_releasenotes_160:

Szybki TK 1.6.0
================================================================================

New features
--------------------------------------------------------------------------------
*  The algorithm for entropy estimation has been improved, specifically the calculation
   of vibrational entropy. It can now handle molecules with up to 2000 atoms.
   The previous limit was about 200 atoms.

*  Entropy calculation of protein-bound ligands has been modified. This change refers
   to the partial desolvation entropy of the protein receptor. In the previous version,
   eq. 26 in *Wlodek-2010* had been used to evaluate the fraction of
   ligand exposed to the solvent. Recent unpublished data has shown that a much more accurate 
   estimation can be achieved by using the direct surface calculation with 
   Spicoli TK. This change was shown to be better at reproducing
   binding entropies.

*  Method `SetSolventModel` now takes a dielectric constant as a
   second argument. Its default value is 80. In the previous versions dielectric constant 
   was assumed to be 80 and the user could not change its value.

*  Badly defined input molecules with very small distances between atoms (< 1e-3 A) that could
   generate infinite initial forces are now detected and no attempt is made to optimize
   such molecules. A warning "Geometry of the input protein or conformation is badly defined!"
   is issued so the user is forced to correct the geometry of the input molecules.

*  A capability of calculating solution entropy for monoatomic ions like Na::math`^+` or
   F::math`^-` and noble gases is added.  

*  Documentation for three libraries: opt, mmff and molpotential, which in the past were 
   called CASE, was added.  
   
Bug fixes
-----------------------------------------------------------------------------------------------------
*  Estimation of entropy with the quasi-Newton method returned differing results
   (up to 6%) on different platforms. The problem was due to numerical-instability
   in the calculation of second derivatives. This problem has been eliminated in the current
   release with the use of a more stable method for line minimization (a backtrack line
   search). 


.. _section_szybki_releasenotes_170:

Szybki TK 1.7.0
================================================================================

New features
--------------------------------------------------------------------------------
*  An extension of the MMFF94 force field for tricoordinate boron compounds
   is offered in this release. Most compounds containing B-X bonds where X=C,N,O,S,
   and H are covered with the following exceptions: X=N(imine),N(sulfonamide),
   N(pyridinium) and N(quaternary). Also not supported are compounds in which
   boron is bonded to X=F,Cl,Br,I,B and Si, or makes a bond angle BYX. 
   Compounds in which boron is a part of four-membered rings of B1CCC1 type are also 
   not available in the current parameterization because their existence is questionable: 
   Ab initio calculations at the MP2/6-31G** level failed to identify stable structures 
   for them (highly polar structures in which boron is four-coordinated are formed). 

*  NOTE WELL: Because of the partial parameterization for boron-containing compounds,
   users of the :ref:`OEMMFF <OEMolMMFF_OEMMFF>` class (derived from
   :ref:`OEGenericFF <OEMolPotential_OEGenericFF>`) need to pay attention to the return value of the
   ``OEMolPotential::OEGenericFF::Setup`` method: In the case where the parameters 
   for a specific boron molecule are not available, this function returns ``false``.
   Checking the return value of ``OEMolPotential::OEGenericFF::PrepMol`` is
   not enough, because it does not catch the case of missing force field parameters 
   for a specific compound.

*  Two new API methods have been added which control the salt concentration for all PB
   calculations with Szybki TK. These are: `SetSaltConcentration`
   and `GetSaltConcentration`. The first method takes salt concentration
   in M as a float number. The valid range is 0 - 0.08M; this method should not be used for
   higher salt concentrations. The second method returns the current salt concentration as
   a float. Default value is zero. Previous versions of Szybki TK assumed zero salt concentration.

*  All PB calculations carried out with the previous Szybki TK versions used Bondi atomic
   radii. The current release offers two additional sets of atomic radii, called ZAP7 and 
   ZAP9 as alternatives. They are described by Nicholls et. al.
   The new method: `SetAtomicRadii` allows the use of one of these two sets.
   The new method `GetAtomicRadiiType` returns the type of current atomic
   radii set.

*  Better control of dielectric constants is provided. This includes a new method:
   `SetSolventDielectric` which allows change from the default
   value of 80. Method `GetSolventDielectric` returns the current
   value of the solvent dielectric constant. Method: `SetSolventModel`
   which determines the solvation model for a free ligand in solution, now takes an
   additional default parameter which sets the intrinsic dielectric constant of the ligand. 

*  A method which obtains gradients from the single point calculations is added.
   Specifically, a new method :oe:meth:`OESz::OESzybkiResults::GetGradients` is added to the
   szybki_results.h header, and two new methods to the szybki.h header file. There are:
   `SetCalculateGradients` and `GetCalculateGradients`. 

*  Enforcement of proper behavior by the :oe:meth:`OESz::OESzybki::operator()` for molecules
   without 3D coordinates. Such molecules are not processed and a warning is issued.

Bug fixes
-----------------------------------------------------------------------------------------------------
*  Method `GetProteinBoundLigandEntropy` is protected from selection of
   an inappropriate protein-ligand electrostatic model (entropy calculations for protein-bound
   ligands are done with the :oe:const:`OESz::OEProteinElectrostatics::ExactCoulomb` model). 

*  Calling  `SetRunType` with an argument :oe:constns:`OESz::OERunType::CartesiansOpt`
   immediately after a call to same method but with an argument :oe:constns:`OESz::OERunType::TorsionsOpt`
   caused missing potential values for bonds and bond angles. The problem is fixed.

*  Method :oe:meth:`OESz::OESzybkiResults::Print` was not reporting MMFF terms in the case when
   :oe:meth:`OESz::OESzybki::SetProtein` was used. The bug is fixed. Also, some minor improvements to this
   method is made, so it is clear which terms contribute to the total protein-ligand interactions
   and which are reported only for comparison. For example the usage of 
   :oe:constns:`OESz::OEProteinElectrostatics` results in reporting the exact and approximated Coulomb 
   terms, however only the latter is used in the reported protein-ligand interaction.

*  Fixed a minor bug where unnecessary warnings regarding missing protein parameters were issued
   in an entropy calculation where the protein is held rigid. This happens when mistakes or inaccuracies
   in the input protein structures lead to undefined force field parameters.

*  Previously, processed molecules were output with aromaticity specified according to the MMFF94
   aromaticity model. Now, output molecule are converted to the OE aromaticity model. 

*  Entropy calculations using the quasi-Newton method now give significantly more accurate answers in
   the two extreme cases where the input ligand structure is a) already optimized, or b) has a very
   high-energy (i.e. poor) structure.



.. _section_szybki_releasenotes_171:

Szybki TK 1.7.1
================================================================================

New features
--------------------------------------------------------------------------------
*  :oe:meth:`OESz::OESzybki::GetEntropy` added which takes a non-const multiconformer
   molecule and a reference to a new object :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>`.
   The method evaluates ligand entropy in different environments as other existing
   methods, however in addition provides essential data on the ensemble of ligand conformations.
   Specifically, it returns the optimized ensemble of unique ligand conformations in its first
   parameter, and populates the :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` objects with entropy
   components data for the ensemble. The :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` also provides
   the data for individual unique optimized conformations in the ensemble; in particular
   the free energy of isolating a specific conformation from the entire ensemble. An example
   code explaining the usage of the new :oe:meth:`OESz::OESzybki::GetEntropy` method and the
   :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` class has been added.

*  :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` class added that is mentioned above has been added.

*  Two new API methods have been added which control the temperature in the entropy estimation.
   These are: `SetTemperature` and `GetTemperature`. 
   The default temperature is 298K.

Bug fixes
-----------------------------------------------------------------------------------------------------
*  :oe:meth:`OESz::OESzybki::SetHarmonicConstraints` did not impose harmonic constraints on 
   flexible part of the protein. The problem has been fixed.

*  Trying to reuse an :ref:`OESzybki <OESz_OESzybki>` instance after an entropy calculation sometimes
   (depending on the subsequent methods call order) caused a crash. To work around that problem 
   it was necessary to use a new instance of the :ref:`OESzybki <OESz_OESzybki>` class.
   This bug has been fixed.

*  Method :oe:meth:`OESz::OESzybki::ClearFixAtoms` did not clear the unnecessary evaluation of the complete 
   ligand energy at the very end of optimization with a subset of atoms frozen. The problem has been
   fixed. 

*  Protection against exhausting memory upon the usage of too many Coulomb atom pairs (for example
   in the attempt to optimize a large protein) has been added. Also, a confusing message upon 
   exhausting the memory with too many vdW interactions has been removed.

*  A warning is now issued in the case where one of the three methods setting the protein flexibility
   is used (`SetSideChainsFlexibility`, `SetPolarHFlexibility` or `SetResidueFlexibility`)
   when protein is not set. Also, a request of single point calculation (using 
   `SetRunType`) properly clears any previous settings of partial 
   protein flexibility.

*  In the default optimization of a ligand inside the protein receptor the convergence criteria
   set by the method `SetOptimizerType` were not consistent with the 
   intrinsic criteria of one the optimizers used. This inconsistency has been fixed.

*  Using conjugate gradient optimizer (set with the `SetOptimizerType`) in
   combination with the method `SetExactVdWProteinLigand` did not report
   the number of cycles made by the optimizer. This problem has been fixed.



.. _section_szybki_releasenotes_172:

Szybki TK 1.7.2
================================================================================

New features
--------------------------------------------------------------------------------
* Two new API methods added: `SetIntramolecularVdWCutoff` and
  `GetIntramolecularVdWCutoff`

* Methods ``OESz::OESzybki::SetProteinVdWCutoff`` and 
  ``OESz::OESzybki::GetProteinVdWCutoff`` have become deprecated. They have
  been replaced by ``OESz::OESzybki::SetIntermolecularVdWCutoff`` and 
  ``OESz::OESzybki::GetIntermolecularVdWCutoff`` respectively.

* Steepest descent (:oe:const:`OESz::OEOptType::SD`) method added as an
  optional optimizer instead of BFGS.

Major bug fixes
--------------------------------------------------------------------------------

.. oe:language:: python

   * :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` now accessible from Python.

.. oe:language:: java

   * :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` now accessible from Java.

.. oe:language:: csharp

   * :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` now accessible from C#.

Minor bug fixes
--------------------------------------------------------------------------------

* Reusing the :ref:`OESzybki <OESz_OESzybki>` object after ligand entropy estimation in the protein
  environment, for other, non-entropy runs of a ligand inside the same protein, required an 
  extra call to :oe:meth:`OESz::OESzybki::SetProtein` in order to set correctly the new 
  protein-electrostatic model correctly. This is not needed anymore.

* In the rare case when ligand is moved out from the protein binding site during entropy 
  estimation the run is terminated with the proper warning. Previously, in such a case the 
  attempts were done to reoptimize the ligand and rebuild the Hessian. Such a strategy was wrong 
  because even if formally successful, it would lead to physically meaningless results.
  The situation described here can happen when the ligand is poorly docked, or if the X-ray structure
  used as input is very inaccurate.

* When the method ``OESz::OESzybki::SetUseCurrentCharges`` was used which causes
  the use of input charges for PB or Sheffield calculations, the molecule which was processed
  with the :oe:meth:`OESz::OESzybki::operator()` methods, on exit received the mmff94 charges.
  That behavior has been replaced by retaining the initial charges, and zeroing the molecule's 
  partial charges when the input molecule had none.

* Error message for the case when the input structure generates infinite initial gradients is
  more informative. 



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


.. _section_szybki_releasenotes_173:

Szybki TK 1.7.3
================================================================================

New features
--------------------------------------------------------------------------------
* A new forcefield for protein-ligand interactions has been added. It is a combination
  of MMFF94S (or MMFF94) with Amber. In this combined force field, MMFF94S is used 
  to describe the intramolecular interactions of the ligand and the Amber force
  field is used for the VdW and Coulomb interactions between ligand and protein.
  Currently, this force field can be used only for ligands inside rigid proteins.

* Two new methods were added to the API: :oe:meth:`OESz::OESzybki::SetTorsionConstraint` 
  and :oe:meth:`OESz::OESzybki::ClearTorsionConstraint`.  The first one adds a
  single-minimum harmonic torsional constraint for a torsion which is defined by
  a SMARTS pattern. It uses the functional form:
  :math:`V=k_c(cos(phi) - cos(phi0))^2`, where :math:`k_c` is the user specified force
  constant and :math:`phi0` is the reference torsion dihedral angle. The second method
  removes the torsional constraint if it exists.

* Estimation of ligand entropy using analytical MMFF Hessian is extended for 
  ligands bound in a rigid protein. Previously the entropy of only free ligands in
  vacuum or in solution could be estimated with analytical second derivatives. 

Major bug fixes
--------------------------------------------------------------------------------
* A few numerical errors in the calculation of analytical second derivatives
  (Hessian matrix) in MMFF torsion and out-of plane terms have been fixed.

Minor bug fixes
--------------------------------------------------------------------------------
* Constraint energy was reported twice by the method :oe:meth:`OESz::OESzybkiResults::Print`.
  The problem is fixed.

* The method ``OESz::OESzybki::GetExactVdWProteinLigand`` was misspelled
  (``GetExactVdEProteinLigand`` instead of ``GetExactVdWProteinLigand``). 

* When preoptimized ligands are used for entropy estimation it is necessary to gently 
  move the ligand out of the minimum. The gradient normal below which such a perturbation was 
  done was raised from 1 kcal/(mol |A|:math:`\AA`) to 10 kcal/(mol |A|:math:`\AA`). 
  Research showed that for some conformations the above limit was too low which resulted 
  in overestimation of its vibrational entropy.



.. _section_szybki_releasenotes_174:

Szybki TK 1.7.4
================================================================================

Bug fixes
--------------------------------------------------------------------------------

.. oe:language:: python java csharp

   * :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` is now usable with
     :oe:meth:`OESz::OESzybki::GetEntropy` from Python, Java, and C#

* ``OEOpt::OEMaxStepLineMinimize::SetMaxStep`` had its
  arguments in the incorrect order for inheriting from :ref:`OELineMinimize <OEOpt_OELineMinimize>`.

* :ref:`OEBFGSOpt <OEOpt_OEBFGSOpt>` now properly handles gradients approaching zero.



.. _section_szybki_releasenotes_175:

Szybki TK 1.7.5
================================================================================

New features
--------------------------------------------------------------------------------

* User partial charges can be used in the combined AMBER-MMFF force field introduced
  in the version 1.7.3. This is done with the method 
  ``OESz::OESzybki::SetUseCurrentCharges`` which until now could be applied
  only to MMFF94 force field for solvation and protein-ligand interaction.

* :oe:const:`OESz::OEOptType::SD_BFGS` and
  :oe:const:`OESz::OEOptType::SD_CG` can now be passed to
  ``OESz::OESzybki::SetOptimizerType`` to perform
  pre-optimization with 5 steps of steepest descent before either BFGS
  or CG optimization.

* :oe:meth:`OESz::OESzybkiEnsembleResults::GetChargeType` added to
  return what type of partial charges were used for entropy
  estimation.

* :oe:meth:`OESz::OESzybkiResults::GetTotalEnergy` no longer includes
  the harmonic constraint energy.
  :oe:meth:`OESz::OESzybkiResults::GetTotalEnergyWithHarmConstraint`
  has been added to return the total energy with the harmonic
  constraint energy included.

Minor bug fixes
--------------------------------------------------------------------------------

* ``OESz::OESzybki::SetEveryConfAM1BCCCharges`` will now
  preserve the existing partial charges from the input molecule when
  using AM1BCC charges for PB, Sheffield and Coulomb protein-ligand
  interactions. In previous versions MMFF94 charges were attached to
  the output molecule.

* When calculating ligand entropy, analytical calculation of second
  order derivatives in solution no longer misses the Hessian components coming
  from solvent forces. 

* :oe:meth:`OESz::OESzybki::GetEntropy` will no longer crash whenever a
  protein was set with :oe:meth:`OESz::OESzybki::SetProtein` and the
  environment was not :oe:const:`OESz::OEEnvType::Protein`. 

* Method ``OESz::OESzybki::SetUseCurrentCharges`` was ignored in Sheffield
  solvent second derivatives (default MMFF94 partial charges were used). This
  issue has been fixed. 



.. _section_szybki_releasenotes_181:

Szybki TK 1.8.1
================================================================================

New features
--------------------------------------------------------------------------------

* :ref:`OENewtonOpt <OEOpt_OENewtonOpt>` added for Newton-Raphson optimization.

* :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` class added for setting all options
  of the :ref:`OESzybki <OESz_OESzybki>` object during construction.  All new
  functionality, starting from the mentioned above Newton-Raphson
  optimization, will only be available through the
  :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` class. All the
  :ref:`OESzybki <OESz_OESzybki>` methods with the same name as their
  :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` counterpart are deprecated and will
  be removed in Szybki TK.

* :ref:`OEOptimizer2 <OEOpt_OEOptimizer2>` abstract base class added to allow
  optimizers that use analytical second derivatives.

* Newton-Raphson optimization method added as an option for minimization.
  For this release it is restricted however to the MMFF94/MMFF94S force field and 
  Sheffield solvation model. It is available only for optimization in Cartesian 
  coordinates. 

* The string representation of the gradient norm by the
  :ref:`OECheckpoint1 <OEOpt_OECheckpoint1>` object and by the
  :oe:meth:`OESz::OESzybkiResults::Print` method will be in scientific
  notation to provide better precision.

* The following methods have been added to :ref:`OESzybkiResults <OESz_OESzybkiResults>`:

  - :oe:meth:`OESz::OESzybkiResults::GetVibEntropy`
  - :oe:meth:`OESz::OESzybkiResults::GetRotEntropy`
  - :oe:meth:`OESz::OESzybkiResults::GetLnQvib`
  - :oe:meth:`OESz::OESzybkiResults::GetLnQrot`

* Efficiency of diagonalization of Hessian matrix is improved.   

* Added two new example programs showing how to use Newton-Raphson
  optimization.

.. oe:language:: c++

   * The C++ Szybki toolkit now links against the new ``oemath`` library.

   * All C++ examples have been renamed to better represent their utility. 

Major bug fixes
--------------------------------------------------------------------------------

* Calculation of PB solvent forces will no longer run out of memory
  and crash due to violent moves of the optimizer.

* :oe:meth:`OESz::OESzybki::LoadPotentialGrid` and
  :oe:meth:`OESz::OESzybki::SavePotentialGrid` will no longer crash due to
  the length of the file name passed.

* :ref:`OESzybki <OESz_OESzybki>` will no longer allow a solid-body
  optimization in partially flexible protein as this was never an
  intended feature.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OESz::OESzybki::SetProtein` will now fail and throw a
  warning if all the protein coordinates are zero.

* :oe:meth:`OESz::OESzybkiResults::Print` output will now include MMFF terms
  for a protein-ligand complex single-point calculation when
  :oe:meth:`OESz::OESzybki::SetProtein` was called before
  ``OESz::OESzybki::SetRunType``.

Documentation fixes
--------------------------------------------------------------------------------

* :oe:meth:`OESz::OESzybkiEnsembleResults::GetChargeType` return type is now
  properly documented.




.. _section_szybki_releasenotes_182:

Szybki TK 1.8.2
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:func:`OESz::OEEstimateSolvFreeEnergy` and
  :oe:func:`OESz::OEEstimateConfFreeEnergies` added to perform FreeForm
  calculations. Their usage requires passing instances of the
  following classes:

  - :ref:`OEFreeFormSolvOptions <OESz_OEFreeFormSolvOptions>`
  - :ref:`OEFreeFormConfOptions <OESz_OEFreeFormConfOptions>`
  - :ref:`OEFreeFormSolvResults <OESz_OEFreeFormSolvResults>`
  - :ref:`OEFreeFormConfResults <OESz_OEFreeFormConfResults>`

* ``OEOpt::OEFunc1::CheckVariablesValidity`` added for checking
  the validity of arguments for the function to be optimized.  The
  users of the all classes derived from :ref:`OEFunc1 <OEOpt_OEFunc1>` can
  implement it according to specific features of their objective
  functions.

* ``OESz::OESzybki::GetSolutionEntropy`` and
  ``OESz::OESzybki::GetProteinBoundLigandEntropy`` have been
  officially deprecated. :oe:meth:`OESz::OESzybki::GetEntropy` that
  returns ``double`` values by reference has also been
  deprecated. Users should switch to using the
  :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` object instead.

Major bug fixes
--------------------------------------------------------------------------------

* Dangling pointer in the implementation of the :oe:meth:`OESz::OESzybki::UnsetProtein`
  has been found and fixed. 

* Setting up a Newton-Raphson optimization on large systems can easily
  exhaust the amount of memory needed because of the O(n^2) Hessian
  matrix. If memory exhaustion is detected, the calculation will now
  error out instead of crashing.

* An exception has been added to catch the memory exhaustion upon Hessian allocation
  used for Newton-Raphson optimization of large systems. That could happen on some
  platforms with limited memory (for example Win32).

.. oe:language:: python java csharp
   
   * :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` can now be passed to the
     :ref:`OESzybki <OESz_OESzybki>` constructor.

   * :oe:constns:`OESz::OEProtFlex` namespace constants are now
     available in Python, Java, and C#. 

Minor bug fixes
--------------------------------------------------------------------------------

* Removed unbounded stack allocations.

* Verbose mode of some protein-ligand optimization could not report the number of
  cycles at the very end of optimization.

* Warning is issued upon the attempt to remove Coulomb terms from the
  combined force field Amber-MMFF (and Amber-MMFFS) with methods
  ``OESz::OESzybki::SetRemoveCoulombTerms`` and
  ``OESz::OESzybkiOptions::SetRemoveCoulombTerms``.

* Unnecessary and confusing warning ``Warning: Solid-body optimization
  allowed only for ligand in fixed protein`` is eliminated when
  :oe:meth:`OESz::OESzybkiOptions::SetRunType` is used with the
  :oe:const:`OESz::OERunType::SolidBodyOpt` argument.

Documentation fixes
--------------------------------------------------------------------------------

* Examples added to demonstrate how to do an entropy estimation. 

* Examples have been updated to use non-deprecated APIs. 

.. oe:language:: python
   
   * Python examples have been renamed to more accurately reflect
     their function. Some examples added to demonstrate additional
     functionality.



.. _section_szybki_releasenotes_183:

Szybki TK 1.8.3
================================================================================

New features
--------------------------------------------------------------------------------

.. oe:language:: c++

   * The C++ **Szybki TK** library, ``oeszybki``, now links against the
     ``oeieff`` library. Please update build scripts accordingly to
     account for the new dependency.

* New forcefield for ligand-ligand and protein-ligand interactions has been added. 
  It is a combination of MMFF94S (or MMFF94) with intermolecular potential called
  IEFF developed at OpenEye. In this combined force field, MMFF94S is used
  to describe the intramolecular interactions while IEFF which has 3 components
  (vdW, Coulomb and Fermi repulsion) handles intermolecular interactions.
  Coulomb terms in IEFF require precalculated and assigned atomic multipoles
  to ligand and protein molecules. This task can be achieved with two OpenEye codes 
  called MOLQM and PROTQM. IEFF has been described in the following publication::

     N. Hamaguchi, L. Fusti-Molnar and S. Wlodek
     Force-field and quantum-mechanical binding study of selected SAMPL3 host-guest complexes
     J. Comput. Aided Mol. Des. Vol. 26, pp. 577-582, 2012

  Please contact support@eyesopen.com if you are interested in testing
  this new forcefield.

* New overloaded method :oe:meth:`OESz::OESzybki::SetTorsionConstraint` has been
  added to the public API. It allows selectively constraining a specific 
  torsion in the optimized molecule.

* A set of flexible residues in ligand optimization with partially flexible protein
  is no longer restricted to the specified distance from the ligand. This goal has
  been achieved by the expansion of the :oe:const:`OESz::OEProtFlex` namespace for 
  new constants which might be passed to the 
  ``OESz::OESzybkiOptions::SetProteinFlexibilityType`` method, and the addition
  of the new method ``OESz::OESzybkiOptions::AddFlexibleResidue`` which can
  be used multiple times to make a set of residues flexible.

* Added new virtual method ``OEOpt::OEFunc1::IsRedundant``. It allows
  to check if two formally numerically different sets of coordinates indeed
  represent two different points in the coordinate space. This method has
  no trivial implementation in :oe:meth:`OEMolPotential::OEQuatAdaptor::IsRedundant`.    

* MMFF calculations now allow for a "DUMMY" atom type,
  :oe:const:`OEChem::OEMMFFType::DUMMY` to specify that an atom should
  be avoided during an MMFF energy calculation.

* Added a DUMMY atom type to the AMBER force field to specify that an
  atom should be avoided during an AMBER energy calculation.

Major bug fixes
--------------------------------------------------------------------------------

* Fixed a rare crash when using the AMBER force field on some platforms.

* A combination of Newton optimization with the use of the following two methods:
  ``OESz::OESzybkiOptions::SetProteinElectrostaticModel`` and
  ``OESz::OESzybkiOptions::SetExactVdWProteinLigand`` with parameters 
  :oe:const:`OESz::OEProteinElectrostatics::ExactCoulomb` and ``true`` respectively
  caused that Coulomb potential was missing from the intermolecular interaction.
  That bug has been fixed.

* :oe:meth:`OESz::OESzybkiResults::GetLnQvib` and
  :oe:meth:`OESz::OESingleConfResult::GetLnQvibrational` will no
  longer return negative infinity on Windows for large ligands. 

Minor bug fixes
--------------------------------------------------------------------------------

* Fixed the name of the saved electrostatic grid file when the name of the molecule
  is used as part of the file name, by replacing all non alpha-numeric characters with 
  an underscore character.

* An attempt to use Newton optimization with a potential for which second derivatives
  are not implemented is terminated with a proper error message.

* When AM1BCC charges are selected in Sheffield or PB solvation models for
  multiply charged species, SCF procedure in AM1 might not converge within 
  20 cycles (this has been observed for methotrexate only so far). To make 
  sure that the electron density is converged, and calculated atomic 
  charges stable, we allow up to 1000 SCF iterations for multiply charged
  molecules.

* Return value of the method :oe:meth:`OESz::OESzybkiResults::GetTotalEnergy`
  for protein-ligand system with partially flexible protein does not contain
  intrinsic MMFF energy of the protein. 

* An attempt to use protein flexibility type which is not a member of the
  :oe:const:`OESz::OEProtFlex` namespace in the method 
  ``OESz::OESzybkiOptions::SetProteinFlexibilityType` issues an
  error message ``Unrecognized protein flexibility``.

* An error message generated upon the attempt of using partially flexible protein
  in solid body optimization type is generated instead of warning. 

* A more informative error message is generated upon the attempt of free ligand
  entropy estimation in the situation when protein environment is set.

* An error message is generated when trying to use Newton optimization for
  protein-ligand systems with protein electrostatic models different than
  :oe:const:`OESz::OEProteinElectrostatics::NoElectrostatics` or
  :oe:const:`OESz::OEProteinElectrostatics::ExactCoulomb`

* Flexible polar hydrogens are printed when residue polar hydrogens are asked to be
  optimized along with the ligand.
  
Documentation fixes
--------------------------------------------------------------------------------

* Documentation for the ``OEMolMMFF::OEMMFFSubsetVdw`` class has been removed. 




.. _section_szybki_releasenotes_184:

Szybki TK 1.8.4
================================================================================

New features
--------------------------------------------------------------------------------

* A new :oe:meth:`OESz::OESingleConfResult::GetRelLnQ` method has been added for retrieving 
  the logarithm of the relative vibrational-rotational partition function with 
  respect to the minimum free-energy conformation. 

Major bug fixes
--------------------------------------------------------------------------------

* Previously, when protein-ligand systems where ligands were made of two or more molecules
  (for example, an inhibitor + water molecule), interligand IEFF interaction 
  energy was not correctly calculated in two cases: (1) for single point
  calculations and (2) for solid-body ligand pose optimization. In both cases,
  the total protein-ligand interaction energy was not affected. In the second
  case, optimization itself was not affected.  This issue has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* Internal refactoring has been performed to improve stability.

* Memory leaks related to protein-ligand 
  interaction and handling protein flexibility have been fixed.  

API Changes
--------------------------------------------------------------------------------

* The unused ``OEMMFFSubsetVdw`` class has been removed. 

Documentation fixes
--------------------------------------------------------------------------------

* Cross-references have been fixed in several sections. 

Java- and C#-specific changes
--------------------------------------------------------------------------------

* The following examples were added for Java and C#:

  - :ref:`Ligand in vacuum optimization<section_simple_vacuum_example>`
  - :ref:`Optimize multiple ligands in Sheffield solvation model<section_ligand_multiple_options_example>`
  - :ref:`Partially flexible protein optimization<section_flexible_protein_example>`
  - :ref:`Partially flexible protein with Newton-Raphson optimization<section_ligand_flexprotein_newton_example>`
  - :ref:`FreeForm Solvation<section_freeformsolv_example>`
  - :ref:`FreeForm Conformer<section_freeformconf_example>`
  - :ref:`Entropy of a bound ligand<section_bound_entropy_example>`
  - :ref:`Bound ligand optimization<section_simple_protein_example>`
  - :ref:`Rigid receptor optimization<section_protein_multiple_options_example>`
  - :ref:`Newton-Raphson optimization<section_simple_newton_example>`
  - :ref:`Bound and solution entropy<section_ligand_entropy_example>`
  - :ref:`PB Protein-ligand binding<section_protein_ligand_PB_example>`



Szybki TK 1.8.5
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:const:`OESz::OEForceFieldType::MMFF_IEFF` and
  :oe:const:`OESz::OEForceFieldType::MMFFS_IEFF` protein-ligand
  potentials can be now combined with the PB solvent energetics and forces
  calculated with ESP partial charges that are read from the same
  molecular input as atomic multipoles.

* The upper limit of the ligand size that might be charged with the AM1BCC
  partial charges when protein-ligand potential is set using
  :oe:const:`OESz::OEForceFieldType::MMFF_AMBER` or
  :oe:const:`OESz::OEForceFieldType::MMFFS_AMBER` types has increased from 100 to
  150 heavy atoms.

* :oe:func:`OEFF::OESetForceFieldDummyAtom` can be used to ignore dummy atoms in 
  forcefield calculations if only van der Waals and Coulombic components are included.
  Dummy atoms are ignored in MMFF force fields and cannot be used in intramolecular components.

* :oe:meth:`OESz::OESzybkiResults::Clear` has been added to reset
  the state of the :ref:`OESzybkiResults <OESz_OESzybkiResults>` object.

Major bug fixes
--------------------------------------------------------------------------------

* :ref:`OESzybki <OESz_OESzybki>` will no longer crash when
  ``OESz::OESzybkiOptions::SetForceFieldType`` is called with the argument
  :oe:const:`OESz::OEForceFieldType::MMFFS_AMBER` and then followed by
  a call of ``OESz::OESzybkiOptions::SetUseCurrentCharges`` with ``true``.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OESz::OESzybki::operator()` will no longer lose SD data
  when operating on a single conformer :ref:`OEMolBase <OEChem_OEMolBase>`.

* :ref:`OESzybkiResults <OESz_OESzybkiResults>` is now cleared from whenever
  :oe:meth:`OESz::OESzybki::operator()` fails.  Clearing is done by
  the new method :oe:meth:`OESz::OESzybkiResults::Clear`.  A cleared
  :ref:`OESzybkiResults <OESz_OESzybkiResults>` will make
  :oe:meth:`OESz::OESzybkiResults::Print` output: ``OESzybkiResults
  object does not have data to report``.

* ``OESz::OESzybki::GetForceFieldType`` now properly
  returns :oe:const:`OESz::OEForceFieldType::MMFF_AMBER` or
  :oe:const:`OESz::OEForceFieldType::MMFF_IEFF`. 
  Previously, they could only be returned after a calculation was performed with the
  :ref:`OESzybki <OESz_OESzybki>` object.

* A CYS residue bonded by the sulfur to something other than another CYS residue
  is no longer treated as anionic by the AMBER charging system.

* Final geometry of a ligand optimized with the MMFF_IEFF or MMFFS_IEFF potential
  has been updated with the transformed multipoles attached to atoms as generic data.

* A potential memory leak when performing repeated protein-ligand minimizations
  has been fixed.

Documentation fixes
--------------------------------------------------------------------------------

* :oe:const:`OEMolPotential::OEFuncType` has been documented.

* The :ref:`Optimization of all conformers of a ligand <section_simple_conformer_example>` section
  has a new example that demonstrates how to minimize all conformers in a ligand.



Szybki TK 1.8.6
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* A memory issue that caused periodic crash of JVM in a situation
  when torsion optimization was performed and Coulomb terms were removed from the
  MMFF94 or MMFF94S force field in Java-wrapped code has been fixed.

* Possible memory corruption in the IEFF force field has been fixed.

* Previously, making the protein partially flexible and selecting a run type of either
  :oe:const:`OESz::OERunType::SinglePoint` or :oe:const:`OESz::OERunType::TorsionsOpt`
  had been causing crashes. These bugs have both been fixed.

* The order of the residue names generated in the logging output for
  flexible polar hydrogens for the Protein-Ligand IEFF-MMFF
  calculation will now be consistent between runs. Previously, the
  order of the residue names could change in subsequent runs. 

* A discontinuity in the flat-bottom harmonic potential has been fixed.
  The potential function generated by the method
  :oe:meth:`OESz::OESzybki::SetHarmonicConstraints` had a discontinuity
  in the primary function and its first derivative that caused the optimizer to
  over-constrain optimizations with harmonic constraints with flat-bottom.
  The class :ref:`OEHarmonicPotential <OEConstr_OEHarmonicPotential>` has been reimplemented.

Minor bug fixes
--------------------------------------------------------------------------------

* Language in the warning regarding the input of atoms with unspecified chirality
  is improved. It now reads: ``Input molecule contains chiral atoms with unspecified
  chirality``. This warning may be generated when using the FreeForm part of the
  **Szybki TK**.

* :oe:func:`OESz::OEEstimateConfFreeEnergies` now accepts an input ensemble containing a 
  molecule with 20 or more rotatable bonds.
  Previously, encountering such a molecule resulted in a warning and then that
  molecule was skipped.

Documentation fixes
--------------------------------------------------------------------------------

* Documentation for constants describing optimization in torsional coordinates
  and translational-rotational coordinates (:oe:const:`OESz::OERunType::TorsionsOpt`
  and :oe:const:`OESz::OERunType::SolidBodyOpt` has been expanded. Specifically, short
  descriptions of the terms ``torsional coordinates``, and ``solid-body optimization``
  have been added.

* Missing documentation for the :oe:const:`OESz::OEOptType::NEWTON` constant, which
  sets Newton type optimization, has been added.


Szybki TK 1.8.7
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:meth:`OESz::OESzybkiEnsembleResults::HasEntropy` has been added.
  This new method returns ``false`` whenever a requested entropy calculation fails.

* The default behavior of protein-ligand systems handled with MMFF or MMFF_AMBER 
  force fields has changed from :oe:const:`OESz::OEProteinElectrostatics::NoElectrostatics`
  to :oe:const:`OESz::OEProteinElectrostatics::ExactCoulomb`. In other words, 
  Coulomb protein-ligand interactions are included by default. 
  Beginning with this release, removing Coulomb terms from the protein-ligand 
  interactions requires using the ``OESz::OESzybkiOptions::SetProteinElectrostaticModel`` 
  method with the :oe:const:`OESz::OEProteinElectrostatics::NoElectrostatics` argument.

* Previously, the combination of IEFF force field and PB desolvation was restricted to
  using ESP charges calculated along with atomic multipoles. This restriction has been
  removed and IEFF for protein-ligand interaction can now be used together with the method
  ``OESz::OESzybkiOptions::SetUseCurrentCharges``. 

Major bug fixes
--------------------------------------------------------------------------------

* Return values of the methods ``OESz::OESzybkiOptions::SetExactVdWProteinLigand``
  and ``OESz::OESzybkiOptions::SetProteinFlexibilityRange`` have been changed
  from ``void`` to ``bool``. This change allows for verifying whether the options
  have been successfully set.

* When IEFF force field is selected, implying that molecular input files with 
  pre-calculated atomic multipoles have been used, the addition of explicit hydrogens is now disabled.
  In very rare cases (for example, tetracyanoquinodimethane ligand), perception of bonding might not
  correspond to the actual ab-initio pre-calculated structure, causing the IEFF 
  calculated energies to be incorrect. 

* Using external charges (see method ``OESz::OESzybkiOptions::SetUseCurrentCharges``)
  in the :oe:const:`OESz::OEForceFieldType::MMFF_AMBER` force field for protein-ligand Coulomb 
  interactions was failing unless the protein was eligible for correct AMBER charging. 
  This unnecessary condition has been removed: any atomic preassigned atomic charges 
  can now be used in combination with AMBER vdW protein-ligand interactions.

* Entropy calculation at very low temperatures is now handled properly:
  at 0 Kelvin, a value of zero is always returned.
  At temperatures close to 0 Kelvin, calculation is attempted and a warning is issued 
  if the calculation fails. 
  :oe:meth:`OESz::OESzybkiEnsembleResults::HasEntropy` (see above) might be used
  to query if the :ref:`OESzybkiResults <OESz_OESzybkiResults>` object contains valid
  calculated entropy.

* Using IEFF/PB potential for bound ligand optimization in torsion space when
  the ligand receptor is partially flexible did not always work.
  This issue has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* When attempting to use Newton optimization and IEFF force field results, an
  error is now thrown with the  message "Second derivatives not available for IEFF ff".


Szybki TK 1.9.0
================================================================================

New features
--------------------------------------------------------------------------------

* Analytical second order derivatives in AMBER intermolecular interactions have
  been added. This new feature allows fast Newton optimization when
  :oe:const:`OESz::OEForceFieldType::MMFF_AMBER` or
  :oe:const:`OESz::OEForceFieldType::MMFFS_AMBER` force field is selected with
  method ``OESz::OESzybkiOptions::SetForceFieldType`` and a variable
  :oe:const:`OESz::OEOptType::NEWTON` is passed to
  ``OESz::OESzybkiOptions::SetOptimizerType`` method.

* APIs for torsion scanning is available, including free function
  :oe:func:`OESz::OETorsionScan` and classes :ref:`OETorsionScanOptions <OESz_OETorsionScanOptions>`
  and :ref:`OETorsionScanResult <OESz_OETorsionScanResult>`.

Minor bug fixes
--------------------------------------------------------------------------------

* API for method ``OESz::OESzybkiOptions::SetIEFFCluster`` has been
  changed. Previously, the method had returned ``void``; it now  returns ``bool``.


Szybki TK 1.9.1
================================================================================

New features
--------------------------------------------------------------------------------

* Zero point energy is now included in the free energy estimation of
  conformations.

* The accuracy of the solvation energy calculated in low dielectric solvents
  (< 20) has been increased by doubling the size of the ZAP grid used in the
  calculation (from 4 to 8 Angstroms).

Minor bug fixes
--------------------------------------------------------------------------------

* The API for the method ``OESz::OESzybkiOptions::SetForceFieldType``
  has been changed. Previously, the method returned ``void``. Now it
  validates the input parameter and returns ``true`` if the force field
  selection is valid and ``false`` otherwise.

* When performing a constrained minimization using the
  :oe:const:`OESz::OEProteinElectrostatics::SolventPBForces` electrostatic
  model, a clash between a protein and a ligand where the square distance
  exceeds 0.1\ :sup:`2` Angstrom\ :sup:`2` will be detected and a warning
  will be issued.

Documentation fixes
--------------------------------------------------------------------------------

* Units of the returned values for the methods
  :oe:meth:`OESz::OESzybkiResults::GetVibEntropy` and
  :oe:meth:`OESz::OESzybkiResults::GetRotEntropy` had been incorrectly
  described as J/(mol K).  In fact, both methods return entropy in cal/(mol K).
  This error has been fixed.


Szybki TK 1.9.2
================================================================================

New features
--------------------------------------------------------------------------------

* Two new classes, :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` and
  :ref:`OEFreeFormConfAdvanced <OESz_OEFreeFormConfAdvanced>`, have been added to provide
  conformer free energy functionality.  The methods in
  :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` provide high-level functionality; those
  in :ref:`OEFreeFormConfAdvanced <OESz_OEFreeFormConfAdvanced>` provide finer
  control of the functionality.

  In general, the new conformer free energy functionality provides 2 new
  capabilities: (1) methods to estimate restriction free energy and
  (2) methods to find conformers similar to the one specified from a pool of
  minimum energy conformers.

* The :ref:`OEFreeFormConfOptions <OESz_OEFreeFormConfOptions>` API methods have been modified and
  enhanced with :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` and various
  :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` sub-options.  The enhanced API allows
  greater control over the details of free energy calculation.

* The :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` class has been simplified and now
  consists of various sub-options: :ref:`OESzybkiGeneralOptions <OESz_OESzybkiGeneralOptions>`,
  :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>`, :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>`,
  and :ref:`OESzybkiProteinOptions <OESz_OESzybkiProteinOptions>`.  The specific methods to set or
  get option values are now provided through these sub-option classes.

  The following table shows the older, deprecated option functions and their
  new sub-option replacements:

  =========================================================   ========================================================================
  Deprecated Option Method                                    New Sub-option Method
  ---------------------------------------------------------   ------------------------------------------------------------------------
  ``OESz::OESzybki::SetIEFFCluster``                          :oe:meth:`OESz::OESzybkiGeneralOptions::SetIEFFCluster`
  ``OESz::OESzybkiOptions::SetIEFFCluster``                   :oe:meth:`OESz::OESzybkiGeneralOptions::SetIEFFCluster`

  ``OESz::OESzybki::GetIEFFCluster``                          :oe:meth:`OESz::OESzybkiGeneralOptions::GetIEFFCluster`
  ``OESz::OESzybkiOptions::GetIEFFCluster``                   :oe:meth:`OESz::OESzybkiGeneralOptions::GetIEFFCluster`

  ``OESz::OESzybki::SetRemoveCoulombTerms``                   :oe:meth:`OESz::OESzybkiGeneralOptions::SetRemoveCoulombTerms`
  ``OESz::OESzybkiOptions::SetRemoveCoulombTerms``            :oe:meth:`OESz::OESzybkiGeneralOptions::SetRemoveCoulombTerms`

  ``OESz::OESzybki::GetRemoveCoulombTerms``                   :oe:meth:`OESz::OESzybkiGeneralOptions::GetRemoveCoulombTerms`
  ``OESz::OESzybkiOptions::GetRemoveCoulombTerms``            :oe:meth:`OESz::OESzybkiGeneralOptions::GetRemoveCoulombTerms`

  ``OESz::OESzybki::SetRemoveAttractiveVdWForces``            :oe:meth:`OESz::OESzybkiGeneralOptions::SetRemoveAttractiveVdWForces`
  ``OESz::OESzybkiOptions::SetRemoveAttractiveVdWForces``     :oe:meth:`OESz::OESzybkiGeneralOptions::SetRemoveAttractiveVdWForces`

  ``OESz::OESzybki::GetRemoveAttractiveVdWForces``            :oe:meth:`OESz::OESzybkiGeneralOptions::GetRemoveAttractiveVdWForces`
  ``OESz::OESzybkiOptions::GetRemoveAttractiveVdWForces``     :oe:meth:`OESz::OESzybkiGeneralOptions::GetRemoveAttractiveVdWForces`

  ``OESz::OESzybki::SetLigandRMSDHeavy``                      :oe:meth:`OESz::OESzybkiGeneralOptions::SetLigandRMSDHeavy`
  ``OESz::OESzybkiOptions::SetLigandRMSDHeavy``               :oe:meth:`OESz::OESzybkiGeneralOptions::SetLigandRMSDHeavy`

  ``OESz::OESzybki::GetLigandRMSDHeavy``                      :oe:meth:`OESz::OESzybkiGeneralOptions::GetLigandRMSDHeavy`
  ``OESz::OESzybkiOptions::GetLigandRMSDHeavy``               :oe:meth:`OESz::OESzybkiGeneralOptions::GetLigandRMSDHeavy`

  ``OESz::OESzybki::SetCalculateGradients``                   :oe:meth:`OESz::OESzybkiGeneralOptions::SetCalculateGradients`
  ``OESz::OESzybkiOptions::SetCalculateGradients``            :oe:meth:`OESz::OESzybkiGeneralOptions::SetCalculateGradients`

  ``OESz::OESzybki::GetCalculateGradients``                   :oe:meth:`OESz::OESzybkiGeneralOptions::GetCalculateGradients`
  ``OESz::OESzybkiOptions::GetCalculateGradients``            :oe:meth:`OESz::OESzybkiGeneralOptions::GetCalculateGradients`

  ``OESz::OESzybki::SetVerbose``                              :oe:meth:`OESz::OESzybkiGeneralOptions::SetVerbose`
  ``OESz::OESzybkiOptions::SetVerbose``                       :oe:meth:`OESz::OESzybkiGeneralOptions::SetVerbose`

  ``OESz::OESzybki::GetVerbose``                              :oe:meth:`OESz::OESzybkiGeneralOptions::GetVerbose`
  ``OESz::OESzybkiOptions::GetVerbose``                       :oe:meth:`OESz::OESzybkiGeneralOptions::GetVerbose`

  ``OESz::OESzybki::SetIntramolecularVdWCutoff``              :oe:meth:`OESz::OESzybkiGeneralOptions::SetIntramolecularVdWCutoff`
  ``OESz::OESzybkiOptions::SetIntramolecularVdWCutoff``       :oe:meth:`OESz::OESzybkiGeneralOptions::SetIntramolecularVdWCutoff`

  ``OESz::OESzybki::GetIntramolecularVdWCutoff``              :oe:meth:`OESz::OESzybkiGeneralOptions::GetIntramolecularVdWCutoff`
  ``OESz::OESzybkiOptions::GetIntramolecularVdWCutoff``       :oe:meth:`OESz::OESzybkiGeneralOptions::GetIntramolecularVdWCutoff`

  ``OESz::OESzybki::SetTemperature``                          :oe:meth:`OESz::OESzybkiGeneralOptions::SetTemperature`
  ``OESz::OESzybkiOptions::SetTemperature``                   :oe:meth:`OESz::OESzybkiGeneralOptions::SetTemperature`

  ``OESz::OESzybki::GetTemperature``                          :oe:meth:`OESz::OESzybkiGeneralOptions::GetTemperature`
  ``OESz::OESzybkiOptions::GetTemperature``                   :oe:meth:`OESz::OESzybkiGeneralOptions::GetTemperature`

  ``OESz::OESzybki::SetSoluteDielectric``                     :oe:meth:`OESz::OESzybkiGeneralOptions::SetSoluteDielectric`
  ``OESz::OESzybkiOptions::SetSoluteDielectric``              :oe:meth:`OESz::OESzybkiGeneralOptions::SetSoluteDielectric`

  ``OESz::OESzybki::GetSoluteDielectric``                     :oe:meth:`OESz::OESzybkiGeneralOptions::GetSoluteDielectric`
  ``OESz::OESzybkiOptions::GetSoluteDielectric``              :oe:meth:`OESz::OESzybkiGeneralOptions::GetSoluteDielectric`

  ``OESz::OESzybki::SetForceFieldType``                       :oe:meth:`OESz::OESzybkiGeneralOptions::SetForceFieldType`
  ``OESz::OESzybkiOptions::SetForceFieldType``                :oe:meth:`OESz::OESzybkiGeneralOptions::SetForceFieldType`

  ``OESz::OESzybki::GetForceFieldType``                       :oe:meth:`OESz::OESzybkiGeneralOptions::GetForceFieldType`
  ``OESz::OESzybkiOptions::GetForceFieldType``                :oe:meth:`OESz::OESzybkiGeneralOptions::GetForceFieldType`

  ``OESz::OESzybki::SetCalculateFrozenTerms``                 :oe:meth:`OESz::OESzybkiOptOptions::SetCalculateFrozenTerms`
  ``OESz::OESzybkiOptions::SetCalculateFrozenTerms``          :oe:meth:`OESz::OESzybkiOptOptions::SetCalculateFrozenTerms`

  ``OESz::OESzybki::GetCalculateFrozenTerms``                 :oe:meth:`OESz::OESzybkiOptOptions::GetCalculateFrozenTerms`
  ``OESz::OESzybkiOptions::GetCalculateFrozenTerms``          :oe:meth:`OESz::OESzybkiOptOptions::GetCalculateFrozenTerms`

  ``OESz::OESzybki::SetGradTolerance``                        :oe:meth:`OESz::OESzybkiOptOptions::SetGradTolerance`
  ``OESz::OESzybkiOptions::SetGradTolerance``                 :oe:meth:`OESz::OESzybkiOptOptions::SetGradTolerance`

  ``OESz::OESzybki::GetGradTolerance``                        :oe:meth:`OESz::OESzybkiOptOptions::GetGradTolerance`
  ``OESz::OESzybkiOptions::GetGradTolerance``                 :oe:meth:`OESz::OESzybkiOptOptions::GetGradTolerance`

  ``OESz::OESzybki::SetOptimizerType``                        :oe:meth:`OESz::OESzybkiOptOptions::SetOptimizerType`
  ``OESz::OESzybkiOptions::SetOptimizerType``                 :oe:meth:`OESz::OESzybkiOptOptions::SetOptimizerType`

  ``OESz::OESzybki::GetOptimizerType``                        :oe:meth:`OESz::OESzybkiOptOptions::GetOptimizerType`
  ``OESz::OESzybkiOptions::GetOptimizerType``                 :oe:meth:`OESz::OESzybkiOptOptions::GetOptimizerType`

  ``OESz::OESzybki::SetMaxIter``                              :oe:meth:`OESz::OESzybkiOptOptions::SetMaxIter`
  ``OESz::OESzybkiOptions::SetMaxIter``                       :oe:meth:`OESz::OESzybkiOptOptions::SetMaxIter`

  ``OESz::OESzybki::GetMaxIter``                              :oe:meth:`OESz::OESzybkiOptOptions::GetMaxIter`
  ``OESz::OESzybkiOptions::GetMaxIter``                       :oe:meth:`OESz::OESzybkiOptOptions::GetMaxIter`

  ``OESz::OESzybki::SetSolventDielectric``                    :oe:meth:`OESz::OESzybkiSolventOptions::SetSolventDielectric`
  ``OESz::OESzybkiOptions::SetSolventDielectric``             :oe:meth:`OESz::OESzybkiSolventOptions::SetSolventDielectric`

  ``OESz::OESzybki::GetSolventDielectric``                    :oe:meth:`OESz::OESzybkiSolventOptions::GetSolventDielectric`
  ``OESz::OESzybkiOptions::GetSolventDielectric``             :oe:meth:`OESz::OESzybkiSolventOptions::GetSolventDielectric`

  ``OESz::OESzybki::SetSaltConcentration``                    :oe:meth:`OESz::OESzybkiSolventOptions::SetSaltConcentration`
  ``OESz::OESzybkiOptions::SetSaltConcentration``             :oe:meth:`OESz::OESzybkiSolventOptions::SetSaltConcentration`

  ``OESz::OESzybki::GetSaltConcentration``                    :oe:meth:`OESz::OESzybkiSolventOptions::GetSaltConcentration`
  ``OESz::OESzybkiOptions::GetSaltConcentration``             :oe:meth:`OESz::OESzybkiSolventOptions::GetSaltConcentration`

  ``OESz::OESzybki::SetCavitySolventParameter``               :oe:meth:`OESz::OESzybkiSolventOptions::SetCavitySolventParameter`
  ``OESz::OESzybkiOptions::SetCavitySolventParameter``        :oe:meth:`OESz::OESzybkiSolventOptions::SetCavitySolventParameter`

  ``OESz::OESzybki::GetCavitySolventParameter``               :oe:meth:`OESz::OESzybkiSolventOptions::GetCavitySolventParameter`
  ``OESz::OESzybkiOptions::GetCavitySolventParameter``        :oe:meth:`OESz::OESzybkiSolventOptions::GetCavitySolventParameter`

  ``OESz::OESzybki::SetSolventModel``                         :oe:meth:`OESz::OESzybkiSolventOptions::SetSolventModel`
  ``OESz::OESzybkiOptions::SetSolventModel``                  :oe:meth:`OESz::OESzybkiSolventOptions::SetSolventModel`

  ``OESz::OESzybki::GetSolventModel``                         :oe:meth:`OESz::OESzybkiSolventOptions::GetSolventModel`
  ``OESz::OESzybkiOptions::GetSolventModel``                  :oe:meth:`OESz::OESzybkiSolventOptions::GetSolventModel`

  ``OESz::OESzybki::SetAtomicRadii``                          :oe:meth:`OESz::OESzybkiSolventOptions::SetAtomicRadiiType`
  ``OESz::OESzybkiOptions::SetAtomicRadii``                   :oe:meth:`OESz::OESzybkiSolventOptions::SetAtomicRadiiType`

  ``OESz::OESzybki::GetAtomicRadiiType``                      :oe:meth:`OESz::OESzybkiSolventOptions::GetAtomicRadiiType`
  ``OESz::OESzybkiOptions::GetAtomicRadiiType``               :oe:meth:`OESz::OESzybkiSolventOptions::GetAtomicRadiiType`

  ``OESz::OESzybki::SetUseCurrentCharges``                    :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybkiOptions::SetUseCurrentCharges``             :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybki::GetUseCurrentCharges``                    :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybkiOptions::GetUseCurrentCharges``             :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybki::SetEveryConfAM1BCCCharges``               :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybkiOptions::SetEveryConfAM1BCCCharges``        :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybki::GetEveryConfAM1BCCCharges``               :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybkiOptions::GetEveryConfAM1BCCCharges``        :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`

  ``OESz::OESzybki::SetExactVdWProteinLigand``                :oe:meth:`OESz::OESzybkiProteinOptions::SetExactVdWProteinLigand`
  ``OESz::OESzybkiOptions::SetExactVdWProteinLigand``         :oe:meth:`OESz::OESzybkiProteinOptions::SetExactVdWProteinLigand`

  ``OESz::OESzybki::GetExactVdWProteinLigand``                :oe:meth:`OESz::OESzybkiProteinOptions::GetExactVdWProteinLigand`
  ``OESz::OESzybkiOptions::GetExactVdWProteinLigand``         :oe:meth:`OESz::OESzybkiProteinOptions::GetExactVdWProteinLigand`

  ``OESz::OESzybki::SetProteinDielectric``                    :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinDielectric`
  ``OESz::OESzybkiOptions::SetProteinDielectric``             :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinDielectric`

  ``OESz::OESzybki::GetProteinDielectric``                    :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinDielectric`
  ``OESz::OESzybkiOptions::GetProteinDielectric``             :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinDielectric`

  ``OESz::OESzybki::SetProteinFlexibilityRange``              :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinFlexibilityRange`
  ``OESz::OESzybkiOptions::SetProteinFlexibilityRange``       :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinFlexibilityRange`

  ``OESz::OESzybki::GetProteinFlexibilityRange``              :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinFlexibilityRange`
  ``OESz::OESzybkiOptions::GetProteinFlexibilityRange``       :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinFlexibilityRange`

  ``OESz::OESzybki::SetIntermolecularVdWCutoff``              :oe:meth:`OESz::OESzybkiProteinOptions::SetIntermolecularVdWCutoff`
  ``OESz::OESzybkiOptions::SetIntermolecularVdWCutoff``       :oe:meth:`OESz::OESzybkiProteinOptions::SetIntermolecularVdWCutoff`

  ``OESz::OESzybki::GetIntermolecularVdWCutoff``              :oe:meth:`OESz::OESzybkiProteinOptions::GetIntermolecularVdWCutoff`
  ``OESz::OESzybkiOptions::GetIntermolecularVdWCutoff``       :oe:meth:`OESz::OESzybkiProteinOptions::GetIntermolecularVdWCutoff`

  ``OESz::OESzybki::SetProteinElectrostaticModel``            :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinElectrostaticModel`
  ``OESz::OESzybkiOptions::SetProteinElectrostaticModel``     :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinElectrostaticModel`

  ``OESz::OESzybki::GetProteinElectrostaticModel``            :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinElectrostaticModel`
  ``OESz::OESzybkiOptions::GetProteinElectrostaticModel``     :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinElectrostaticModel`

  ``OESz::OESzybki::SetProteinFlexibilityType``               :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinFlexibilityType`
  ``OESz::OESzybkiOptions::SetProteinFlexibilityType``        :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinFlexibilityType`

  ``OESz::OESzybki::GetProteinFlexibilityType``               :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinFlexibilityType`
  ``OESz::OESzybkiOptions::GetProteinFlexibilityType``        :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinFlexibilityType`
  =========================================================   ========================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* User-defined partial charges set for the MMFFS_AMBER or
  MMFF_AMBER force field calculations had previously not been preserved.
  They are now passed to the optimized molecule.

* Changing the protein flexibility type from range-defined to a list of
  residues for an :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` object previously required
  creating a copy of the object. This issue has been fixed.

* Atomic radii for IEFF/PB calculations were previously restricted to
  the Bondi type.  Although the default is still Bondi, ZAP7 and ZAP9 radii are
  now available.


Szybki TK 2.0.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:meth:`OESz::OESzybki::GetEntropy` method now checks for consistency
  between the input argument for environment type and the already defined
  solvent method in :ref:`OESzybkiOptions <OESz_OESzybkiOptions>`. This check ensures that
  the wrong entropy calculation is not silently performed.

Documentation changes
--------------------------------------------------------------------------------

* The Advanced API section has been removed.  The low-level functionality
  offered through the advanced API has been improved and is now offered
  as a new toolkit named **OEFF TK**. The documentation is available
  at :ref:`OEFF toolkits<oeff_part>`.


Szybki TK 2.0.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* A crash that occurred when adding harmonic constraint with MMFF_IEFF has
  been fixed.

* A problem where the :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  option was not obeyed if using :oe:meth:`OESz::OESzybki::SetProtein` has
  been fixed.


Szybki TK 2.0.2
================================================================================

New features
--------------------------------------------------------------------------------

* A new method, :oe:meth:`OESz::OESzybkiSolventOptions::SetUseCurrentCharges`,
  has been added as a convenience function.

* Entropy calculation of a bound ligand can now be computed when an IEFF
  force field is selected (:oe:const:`OESz::OEForceFieldType::MMFF_IEFF` or
  :oe:const:`OESz::OEForceFieldType::MMFFS_IEFF`). It uses an accurate
  numerical Hessian.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue related to **Szybki TK** losing information about already perceived
  protein residues has been fixed.

* Previously, highly clashed protein-ligand systems that were often a result
  of docking were not automatically relaxed when using the default
  :oe:const:`OESz::OEOptType::BFGS` optimization method.
  Users had to explicitly use the :oe:const:`OESz::OEOptType::SD_BFGS`
  method.  Now, a clash that exceeds 1e6 (kcal/mol)/A on a gradient norm is
  detected and 5 steps of steepest descent optimization are automatically
  applied before the BFGS optimizer is run.


Szybki TK 2.0.3
================================================================================

New features
--------------------------------------------------------------------------------

* New :oe:meth:`OESz::OETorsionScanOptions::SetPenaltyForceConstant` and
  :oe:meth:`OESz::OETorsionScanOptions::GetPenaltyForceConstant` methods
  have been added.

Documentation changes
--------------------------------------------------------------------------------

* The example code in the :ref:`section_ligand_entropy_example` section has been adjusted for
  solution environment by using the :oe:const:`OESz::OESolventModel::Sheffield`
  constant.


Szybki TK 2.0.4
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OESz::OEEstimateSolvFreeEnergy` has been fixed to properly
  calculate solvation energy when used with input molecule charges.
  
Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OESz::OETorsionScan` no longer requires an ``am1bcc`` license
  when :oe:meth:`OESz::OETorsionScanOptions::SetUseSinglePointPB` is set
  to ``true``.


Szybki TK 2.1.0
================================================================================

New features
--------------------------------------------------------------------------------
* :oe:meth:`OESz::OESzybki::SetProtein` has been updated to return a Boolean, allowing
  failures to be handled in code.

* **Szybki** can now perform energy optimization using a SMIRNOFF
  force field (https://openforcefield.org/).

Minor bug fixes
--------------------------------------------------------------------------------

* The default ``EnergyWindow`` for conformer generation in :ref:`OEFreeFormConfOptions <OESz_OEFreeFormConfOptions>`
  is now consistent with that in :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` in the
  :oe:const:`OEConfGen::OEOmegaSampling::Dense` mode.

* Two methods in :ref:`OEFreeFormConfResults <OESz_OEFreeFormConfResults>`,
  :oe:meth:`PrintTxt<OESz::OEFreeFormConfResults::PrintTxt>` and
  :oe:meth:`PrintCsv<OESz::OEFreeFormConfResults::PrintCsv>`, have been modified to
  widen the scope of the associated streams.

Documentation changes
--------------------------------------------------------------------------------

* A new example program, :ref:`section_flexible_residue_example`, has been added.

* A new example program, :ref:`section_simple_vacuum_smirnoff_example`, has been added.



Szybki TK 2.2.0
================================================================================

New features
--------------------------------------------------------------------------------

* Two new methods, :oe:meth:`OESz::OESzybkiGeneralOptions::SetForceField` and
  :oe:meth:`OESz::OESzybkiGeneralOptions::GetForceField`, have been added that
  provide support for custom force fields in  **Szybki TK**.  These methods
  provide users with the ability to use SMIRNOFF
  force fields that are not built into **Szybki TK**.

* Two new SMIRNOFF force fields from the Open Force Field Initiative, namely
  ``Parsley (OpenFF-1.0.0)`` and ``Parsley (OpenFF-1.1.1)``, have been added as built-in
  force fields. They are defined as :oe:const:`OESz::OEForceFieldType::PARSLEY_OPENFF100`
  and :oe:const:`OESz::OEForceFieldType::PARSLEY_OPENFF111`, respectively.

* Potential energy terms in the namespace :oe:const:`OESz::OEPotentialTerms` are
  now independent of the force field names. Exceptions are combined force fields in
  which intramolecular terms are taken from MMFF94 as well as intermolecular terms
  from either AMBER or OEFF.

Major bug fixes
--------------------------------------------------------------------------------

* A bug in the entropy calculation for a ligand inside a receptor
  binding site has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* Conformer free energy calculation using :oe:meth:`OESz::OEFreeFormConf::EstimateFreeEnergies`
  now produces results identical to performing the calculation in steps using the
  methods from :ref:`OEFreeFormConfAdvanced <OESz_OEFreeFormConfAdvanced>`.

* The following methods now return ``bool``, instead of a ``void``:

  * :oe:meth:`OESz::OESzybkiGeneralOptions::SetCalculateGradients`
  * :oe:meth:`OESz::OESzybkiGeneralOptions::SetIEFFCluster`
  * :oe:meth:`OESz::OESzybkiGeneralOptions::SetIntramolecularVdWCutoff`
  * :oe:meth:`OESz::OESzybkiGeneralOptions::SetLigandRMSDHeavy`
  * :oe:meth:`OESz::OESzybkiGeneralOptions::SetRemoveAttractiveVdWForces`
  * :oe:meth:`OESz::OESzybkiGeneralOptions::SetRemoveCoulombTerms`
  * :oe:meth:`OESz::OESzybkiGeneralOptions::SetSoluteDielectric`
  * :oe:meth:`OESz::OESzybkiGeneralOptions::SetTemperature`
  * :oe:meth:`OESz::OESzybkiGeneralOptions::SetVerbose`
  * :oe:meth:`OESz::OESzybkiOptOptions::SetCalculateFrozenTerms`
  * :oe:meth:`OESz::OESzybkiOptOptions::SetGradTolerance`
  * :oe:meth:`OESz::OESzybkiOptOptions::SetMaxIter`
  * :oe:meth:`OESz::OESzybkiSolventOptions::SetAtomicRadiiType`
  * :oe:meth:`OESz::OESzybkiSolventOptions::SetCavitySolventParameter`
  * :oe:meth:`OESz::OESzybkiSolventOptions::SetSaltConcentration`
  * :oe:meth:`OESz::OESzybkiSolventOptions::SetSolventDielectric`
  * :oe:meth:`OESz::OESzybkiProteinOptions::SetExactVdWProteinLigand`
  * :oe:meth:`OESz::OESzybkiProteinOptions::SetIntermolecularVdWCutoff`
  * :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinDielectric`
  * :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinFlexibilityRange`
  * :oe:meth:`OESz::OEFreeFormConfOptions::SetUseInputEnsemble`
  * :oe:meth:`OESz::OEFreeFormConfOptions::SetUseSolventCorr`
  * :oe:meth:`OESz::OEFreeFormSolvOptions::SetAtomicRadiiType`
  * :oe:meth:`OESz::OEFreeFormSolvOptions::SetChargeType`
  * :oe:meth:`OESz::OEFreeFormSolvOptions::SetConfGenRMS`
  * :oe:meth:`OESz::OEFreeFormSolvOptions::SetIonicState`
  * :oe:meth:`OESz::OEFreeFormSolvOptions::SetMaxConfGen`
  * :oe:meth:`OESz::OEFreeFormSolvOptions::SetUseInput3D`
  * :oe:meth:`OESz::OEFreeFormSolvOptions::SetUseInputEnsemble`

* ``OEForceFieldType::SMIRNOFF`` has been renamed
  :oe:const:`OESz::OEForceFieldType::SMIRNOFF99FROSST` for clarity.

* Perceiving residues in the input proteins are now done only when the input protein does not have them.

* **Szybki TK** now properly handles a hard clash between ligand and protein atoms when a SMIRNOFF force
  field is used to optimize a ligand inside a receptor (with a gradient norm larger than 1e15).




Szybki TK 2.3.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------
* A new SMIRNOFF force field from the `Open Force Field Initiative <https://openforcefield.org/>`_,
  Parsley 1.2.1, has been added as a built-in force field. It is
  defined as :ref:`PARSLEY_OPENFF121 <OESz_OEForceFieldType_PARSLEY_OPENFF121>`.

* A protein or part of a protein can now be optimized with the FF14SB force field.
  Cofactors with the exception if HEME are handled by the OpenFF/Parsley force field
  (for example Parsley 1.2.1), while parameters for HEME are taken from `Bryce Group <http://research.bmh.manchester.ac.uk/bryce/amber/>`_.

* The following preliminary classes have been added that enable optimizing protein-ligand complexes,
  with or without partial flexibility of the proteins, using the new :ref:`OEFF14SBParsleyComplex <OEFF_OEFF14SBParsleyComplex>` force fields,
  among others:

  * :ref:`OEFixedProteinLigandOptimizer <OESz_OEFixedProteinLigandOptimizer>`
  * :ref:`OEFlexProteinLigandOptimizer <OESz_OEFlexProteinLigandOptimizer>`

* A new preliminary class, :ref:`OEProteinLigandOptResults <OESz_OEProteinLigandOptResults>`, has been added
  that represents results of a protein-ligand complex optimization.

* Two new preliminary classes, :ref:`OEProteinLigandOptOptions <OESz_OEProteinLigandOptOptions>` and
  :ref:`OEProteinFlexOptions <OESz_OEProteinFlexOptions>`, have been added that provide choices for
  protein-ligand optimization and protein flexibility.

* A new namespace, :ref:`OESzybkiReturnCode <OESz_OESzybkiReturnCode>`, and a corresponding function,
  :ref:`OEGetSzybkiError <OESz_OEGetSzybkiError>`, have been added that correspond to return codes
  from the new optimizer classes.

Minor bug fixes
--------------------------------------------------------------------------------
*  Protein-ligand optimization with OpenFF/Parsley force fields using :ref:`OESzybki <OESz_OESzybki>` no
   longer fails, even when the initial gradient norm is 1e^15 kcal/(mol A) or larger.



Szybki TK 2.3.1
================================================================================

*July 2021*

New features
--------------------------------------------------------------------------------

* The latest version of the
  `Open Force Field Initiative <https://openforcefield.org/community/news/general/new-releases-oct2020>`_,
  Parsley 1.3.1, has been added to the :ref:`OEForceFieldType <OESz_OEForceFieldType>` namespace as built-in force field
  :ref:`PARSLEY_OPENFF131 <OESz_OEForceFieldType_PARSLEY_OPENFF131>`.

* Support for user-defined force fields has been added to the :ref:`OETorsionScan <OESz_OETorsionScan>` function.
  Two new API points, :ref:`SetForceField <OESz_OETorsionScanOptions_SetForceField>` and :ref:`GetForceField <OESz_OETorsionScanOptions_GetForceField>`,
  have been added for setting and getting this value.

* Support for user defined dihedral angles has been added to :ref:`OETorsionScan <OESz_OETorsionScan>`.
  Two new API points, :ref:`SetUserDefinedAngles <OESz_OETorsionScanOptions_SetUserDefinedAngles>` and
  :ref:`GetUserDefinedAngles <OESz_OETorsionScanOptions_GetUserDefinedAngles>`, have been added for setting and getting this value.



Szybki TK 2.4.0
================================================================================

*Fall 2021*

New features
--------------------------------------------------------------------------------

* A new function, :oe:func:`OESz::OEGetFreeFormError`, is provided
  that returns error messages corresponding to return codes defined in 
  :oe:constns:`OESz::OEFreeFormReturnCode` namespace.

* The latest version of the
  `Open Force Field Initiative <https://openforcefield.org/community/news/general/sage2.0.0-release/>`_,
  Sage 2.0.0, has been added to :oe:const:`OESz::OEForceFieldType` as built-in force field
  :oe:const:`OESz::OEForceFieldType::SAGE_OPENFF200`.

* Freeform for estimating free energy of conformations in the ensemble, :ref:`OEFreeFormConf <OESz_OEFreeFormConf>`,
  now defaults to using the most recent version of the Open Force Field (:ref:`OESage <OEMolSmirnoff_OESage>`).
  Previously it was using `MMFF94S` by default.

* Protein-ligand optimization classes :ref:`OEFixedProteinLigandOptimizer <OESz_OEFixedProteinLigandOptimizer>`
  and :ref:`OEFlexProteinLigandOptimizer <OESz_OEFlexProteinLigandOptimizer>` now defaults to using the
  :ref:`OEFF14SBSageComplex <OEFF_OEFF14SBSageComplex>` force field.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:meth:`OESz::OETorsionScanOptions::SetForceField` now 
  properly defaults to :oe:constns:`OESz::OEForceFieldType::MMFF94S`.





Szybki TK 2.5.0
================================================================================

New Features
--------------------------------------------------------------------------------
* The ability to use the Sheffield Solvation Model has been added to :ref:`OEFlexProteinLigandOptimizer <OESz_OEFlexProteinLigandOptimizer>` and
  :ref:`OEFixedProteinLigandOptimizer <OESz_OEFixedProteinLigandOptimizer>`.

* Two additional methods have been added to the
  :ref:`OEProteinLigandOptOptions <OESz_OEProteinLigandOptOptions>`
  class:

    * :ref:`GetSolventModel <OESz_OEProteinLigandOptOptions_GetSolventModel>`
    * :ref:`SetSolventModel <OESz_OEProteinLigandOptOptions_SetSolventModel>`




Szybki TK 2.5.1.2
================================================================================

* Possible crashes in :ref:`OEFixedProteinLigandOptimizer_Optimize <OESz_OEFixedProteinLigandOptimizer_Optimize>` and
  :ref:`OEFlexProteinLigandOptimizer_Optimize <OESz_OEFlexProteinLigandOptimizer_Optimize>`
  methods have been fixed.

Szybki TK 2.5.1.1
================================================================================

New features
--------------------------------------------------------------------------------
* Optimization of bound ligands with ff14SB/Sage and ff14SB/Parsley force fields
  with PB solvation forces in rigid and partially flexible receptors is now available.

* Setting the force field to :ref:`PARSLEY_OPENFF131 <OESz_OEForceFieldType_PARSLEY_OPENFF131>` or
  :ref:`SAGE_OPENFF200 <OESz_OEForceFieldType_SAGE_OPENFF200>` now references the most recent official
  versions of those two parameterizations which are OpenFF_1.3.1 and OpenFF_2.0.0
  respectively. Older versions are still available from the
  :ref:`OEForceFieldType <OESz_OEForceFieldType>` namespace.

* Final ligand geometry is now checked when large initial clashes occur while using 
  :ref:`OEFixedProteinLigandOptimizer <OESz_OEFixedProteinLigandOptimizer>` and :ref:`OESz_OEFlexProteinLigandOptimizer <OESz_OEFlexProteinLigandOptimizer>`
  for optimization of a ligand inside a protein
  receptor. In most cases, clashes are successfully relaxed; however, in some cases
  they can lead to a nonphysical minimum which is characterized with distorted geometry.
  Such results can now be detected by checking the return values of methods
  :ref:`OEFixedProteinLigandOptimizer_Optimize <OESz_OEFixedProteinLigandOptimizer_Optimize>` and
  :ref:`OEFlexProteinLigandOptimizer_Optimize <OESz_OEFlexProteinLigandOptimizer_Optimize>`.

Major bug fixes
--------------------------------------------------------------------------------
* An issue with torsion scan for alkanes using MMFF has been fixed.

* :ref:`OEFixedProteinLigandOptimizer_Optimize <OESz_OEFixedProteinLigandOptimizer_Optimize>` and
  :ref:`OEFlexProteinLigandOptimizer_Optimize <OESz_OEFlexProteinLigandOptimizer_Optimize>`
  now fails properly when optimization leads to a nonphysical state of a molecule,
  characterized with distorted geometry. Such nonphysical optimization can sometimes
  happen when the starting configuration of a protein-ligand complex contains high overlaps.

Minor bug fixes
--------------------------------------------------------------------------------
* A warning regarding 'invalidation of receptor' upon optimization using the
  :ref:`OEFlexProteinLigandOptimizer <OESz_OEFlexProteinLigandOptimizer>` class has been removed.




.. _section_szybki_releasenotes_2601:

Szybki TK 2.6.0.1
================================================================================

* New constant :ref:`SAGE_OPENFF210 <OESz_OEForceFieldType_SAGE_OPENFF210>` has been
  introduced that refers to the Sage 2.1.0 force field. The constant 
  :ref:`SAGE_OPENFF <OESz_OEForceFieldType_SAGE_OPENFF>` now refers to
  this latest version of Sage force field.

Szybki TK 2.6.0.0
================================================================================

New features
--------------------------------------------------------------------------------
* Three classes have been added to facilitate using ff14SB/OpenFF 
  potential for bound ligands and to bypass using OESzybki:

  * :ref:`OEBoundEntropyOptions <OESz_OEBoundEntropyOptions>`
  * :ref:`OELigandEntropyOptions <OESz_OELigandEntropyOptions>`
  * :ref:`OEEntropyResults <OESz_OEEntropyResults>`

* A new function, :ref:`OEBoundLigandEntropy <OESz_OEBoundLigandEntropy>`, has been added
  to calculate the entropy of a bound ligand.

* A new function, :ref:`OELigandEntropy <OESz_OELigandEntropy>`, has been added to calculate the 
  entropy of a free ligand.

* A new pair of options has been added to the :ref:`OETorsionScanOptions <OESz_OETorsionScanOptions>`
  to address hysteresis in torsion scanning. These provide the ability to increase the number of starts
  (:ref:`SetNumStarts <OESz_OETorsionScanOptions_SetNumStarts>`) and address the
  overlaps between scans (:ref:`SetOverlapDiv <OESz_OETorsionScanOptions_SetOverlapDiv>`) to avoid
  doing full 360-degree scans for many starts unless desired.

Major bug fixes
--------------------------------------------------------------------------------
* An issue with the torsion scan (:ref:`OETorsionScan <OESz_OETorsionScan>`) in
  solution with PB solvation has been fixed. It no longer incorrectly uses the
  MMFF94S potential even when
  scanning is done with the OpenFF force field.

* An issue with hysteresis that in certain cases caused asymmetric torsion scans 
  has been addressed by resetting to the starting angle before starting reverse scans.

Minor bug fixes
--------------------------------------------------------------------------------
* Better diagnostics have been added to :ref:`OEFixedProteinLigandOptimizer <OESz_OEFixedProteinLigandOptimizer>`
  when the optimization of a ligand in a fixed protein receptor fails due to an initial clash.
  An appropriate error code is now returned for such cases.
  
* :ref:`OEFlexProteinLigandOptimizer <OESz_OEFlexProteinLigandOptimizer>`
  now provides an appropriate error code when asked to optimize a design unit
  that does not contain a ligand.




Szybki TK 2.7.0
================================================================================

New features
--------------------------------------------------------------------------------
* The ability has been added to perform optimization in internal coordinates, with fixed torsions, during a torsion scan.
  Accordingly, the following additional commands
  have been added to :ref:`OETorsionScanOptions <OESz_OETorsionScanOptions>`:

    * :ref:`SetUseInternalCoord <OESz_OETorsionScanOptions_SetUseInternalCoord>`
    * :ref:`GetUseInternalCoord <OESz_OETorsionScanOptions_GetUseInternalCoord>`
    * :ref:`SetTolerance <OESz_OETorsionScanOptions_SetTolerance>`
    * :ref:`GetTolerance <OESz_OETorsionScanOptions_GetTolerance>`
    * :ref:`SetMaxIter <OESz_OETorsionScanOptions_SetMaxIter>`
    * :ref:`GetMaxIter <OESz_OETorsionScanOptions_GetMaxIter>`

* The ability to apply a nonbonded interactions cutoff in
  :ref:`OEProteinLigandOptOptions<OESz_OEProteinLigandOptOptions>` has
  been added. The following two methods are also available in
  the class:

    * :ref:`SetNonBondCutoff <OESz_OEProteinLigandOptOptions_SetNonBondCutoff>`
    * :ref:`GetNonBondCutoff <OESz_OEProteinLigandOptOptions_GetNonBondCutoff>`

* Both :ref:`OEFixedProteinLigandOptimizer<OESz_OEFixedProteinLigandOptimizer>`
  and :ref:`OEFlexProteinLigandOptimizer<OESz_OEFlexProteinLigandOptimizer>`
  now apply a nonbonded interactions cutoff of `40.0` by default.

* A new class, :ref:`OETorsionScanner<OESz_OETorsionScanner>`,
  has been added to provide greater flexibility over the existing
  function :ref:`OETorsionScan<OESz_OETorsionScan>` in extracting
  intermediate results from the scanning.

Major bug fixes
--------------------------------------------------------------------------------
* An issue where the overloaded method :ref:`SetTorsionConstraint <OESz_OESzybki_SetTorsionConstraint>`
  would occasionally fail has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------
* Validation of user-selected torsion in torsion scan has been added. If a torsion passed
  to function :ref:`OETorsionScan <OESz_OETorsionScan>` or method
  :ref:`Scan <OESz_OETorsionScanner_Scan>` does not exist, the torsion scan code stops
  with a message that the torsion does not exist in the input molecule.




.. _section_szybkitk_releasenotes_2713:

Szybki TK 2.7.1.3
================================================================================

 * The constant :ref:`OESz_OEForceFieldType_SAGE_OPENFF <OESz_OEForceFieldType_SAGE_OPENFF>` refers to the
   2.2.0 version of the Sage-OpenFF force field.

.. _section_szybkitk_releasenotes_2710:

Szybki TK 2.7.1.0
================================================================================

* :ref:`OEFixedProteinLigandOptimizer<OESz_OEFixedProteinLigandOptimizer>`
  and :ref:`OEFlexProteinLigandOptimizer<OESz_OEFlexProteinLigandOptimizer>` now
  propagate error better when optimization fails.





Szybki TK 2.8.0
================================================================================

New features
--------------------------------------------------------------------------------

* The constant :ref:`SAGE_OPENFF <OESz_OEForceFieldType_SAGE_OPENFF>` refers to the
  latest version of the Sage OpenFF force field.



Szybki TK 2.9.0
================================================================================

New Features
--------------------------------------------------------------------------------

* A new class, :ref:`OEOELigandChargeOptions<OESz_OELigandChargeOptions>`,
  has been added that provides options related to ligand charge assignment. The following classes
  now derive from :ref:`OEOELigandChargeOptions<OESz_OELigandChargeOptions>`,
  enabling greater flexibility in ligand charge assignment:

  * :ref:`OEProteinLigandOptOptions<OESz_OEProteinLigandOptOptions>`
  * :ref:`OETorsionScanOptions<OESz_OETorsionScanOptions>`
  * :ref:`OEBoundEntropyOptions<OESz_OEBoundEntropyOptions>`
  * :ref:`OELigandEntropyOptions<OESz_OELigandEntropyOptions>`

* The default optimization type has been changed to :ref:`PoseCartesian <OESz_OEOptimizationType_PoseCartesian>`
  in both :ref:`OEFixedProteinLigandOptimizer<OESz_OEFixedProteinLigandOptimizer>` and 
  :ref:`OEFlexProteinLigandOptimizer<OESz_OEFlexProteinLigandOptimizer>`.

* The following two new constants have been added to the :ref:`OESzybkiReturnCode <OESz_OESzybkiReturnCode>` namespace:
  
  * :ref:`AromaticRingDev<OESz_OESzybkiReturnCode_AromaticRingDev>`: refers to failure due to excessive aromatic distortion.
  * :ref:`OptimizerFailed<OESz_OESzybkiReturnCode_OptimizerFailed>`: refers to the optimizer failing to find a solution.

* The following class methods now take an optional predicate describing residues that
  should be considered as part of the protein target during optimization:

  * :ref:`SetProtein<OESz_OEFixedProteinLigandOptimizer_SetProtein>` in :ref:`OEFixedProteinLigandOptimizer<OESz_OEFixedProteinLigandOptimizer>`
  * :ref:`Optimize<OESz_OEFlexProteinLigandOptimizer_Optimize>` in :ref:`OEFlexProteinLigandOptimizer<OESz_OEFlexProteinLigandOptimizer>`
  * :ref:`Energy<OESz_OEFlexProteinLigandOptimizer_Energy>` in :ref:`OEFlexProteinLigandOptimizer<OESz_OEFlexProteinLigandOptimizer>`

* The following new preliminary API classes have been added, enabling optimization
  of a ligand with torsion constraints:

  * :ref:`OELigandEnergy <OESz_OELigandEnergy>`
  * :ref:`OELigandOptOptions <OESz_OELigandOptOptions>`
  * :ref:`OELigandOptResults <OESz_OELigandOptResults>`
  * :ref:`OETorConstraintOptimizer <OESz_OETorConstraintOptimizer>`
  * :ref:`OETorConstraintOptOptions <OESz_OETorConstraintOptOptions>`

Major Bug Fixes
--------------------------------------------------------------------------------

* :ref:`OEFixedProteinLigandOptimizer<OESz_OEFixedProteinLigandOptimizer>` and 
  :ref:`OEFlexProteinLigandOptimizer<OESz_OEFlexProteinLigandOptimizer>` no longer fail
  to optimize with the :ref:`ExcessiveOverlap<OESz_OESzybkiReturnCode_ExcessiveOverlap>` error code
  prematurely.

Minor Bug Fixes
--------------------------------------------------------------------------------

* :ref:`OEFreeFormConfOptions<OESz_OEFreeFormConfOptions>` now sets the
  :ref:`latest Sage force field<OESz_OEForceFieldType_SAGE_OPENFF>` as the default.

* An issue has been fixed in :ref:`OETorsionScan <OESz_OETorsionScan>` where scanning using the option
  :ref:`SetUseInternalCoord <OESz_OETorsionScanOptions_SetUseInternalCoord>` set to ``true`` would occasionally produce 
  large unphysical energies at certain angles.




Szybki TK 2.9.1
================================================================================

Minor internal improvements have been made.


###############################################
Appendix: Additional Examples in Python
###############################################

These are full listings of programming examples that are excerpted or offered for download, elsewhere in this chapter.
For a guide to programming examples, :ref:`see the list earlier in this chapter <szybki_part_examples>`.

.. _listing-simple_vacuum.py:

.. oe:source:: simple_vacuum.py
   :language: python
   :caption:  Simple Ligand in a Vacuum.
   :refnum:   1

.. _listing-simple_smirnoff.py:

.. oe:source:: simple_smirnoff.py
   :language: python
   :caption:  Simple Ligand in a Vacuum Using SMIRNOFF.
   :refnum:   2

.. _listing-ligand_multiple_options.py:

.. oe:source:: ligand_multiple_options.py
   :language: python
   :caption:  Optimization of a Set of Ligands.
   :refnum:   3

.. _listing-simple_newton.py:

.. oe:source:: simple_newton.py
   :language: python
   :caption:  Optimization of a Single Ligand with the Newton-Raphson Method.
   :refnum:   4

.. _listing-simple_conformer.py:

.. oe:source:: simple_conformer.py
   :language: python
   :caption:  Optimization of All Conformers of a Ligand.
   :refnum:   5

.. _listing-simple_protein.py:

.. oe:source:: simple_protein.py
   :language: python
   :caption:  Optimization of a Single Bound Ligand.
   :refnum:   6

.. _listing-protein_multiple_options.py:

.. oe:source:: protein_multiple_options.py
   :language: python
   :caption:  Optimization of a Set of Bound Ligands in a Rigid Receptor.
   :refnum:   7

.. _listing-flexible_protein.py:

.. oe:source:: flexible_protein.py
   :language: python
   :caption:  Optimization of a Set of Bound Ligands in a Partially Flexible Receptor.
   :refnum:   8

.. _listing-flex_residues.py:

.. oe:source:: flex_residues.py
   :language: python
   :caption:  Optimization of a Bound Ligand in a Partially Flexible Receptor.
   :refnum:   9

.. _listing-protein_ligand_PB.py:

.. oe:source:: protein_ligand_PB.py
   :language: python
   :caption:  Estimation of PB Binding for a Set of Ligands.
   :refnum:   10

.. _listing-ligand_flexprotein_newton.py:

.. oe:source:: ligand_flexprotein_newton.py
   :language: python
   :caption:  Optimization of a Bound Ligand Using Newton-Raphson Method.
   :refnum:   11

.. _listing-OptimizeLigandInDU.py:

.. oe:source:: OptimizeLigandInDU.py
   :language: python
   :caption:  Optimization of Ligand in a Rigid Active Site.
   :refnum:   12

.. _listing-OptimizeDU.py:

.. oe:source:: OptimizeDU.py
   :language: python
   :caption:  Optimization of Ligand in a Partially Flexible Active Site.
   :refnum:   13

.. _listing-ligand_entropy.py:

.. oe:source:: ligand_entropy.py
   :language: python
   :caption:  Ligand Entropy.
   :refnum:   14

.. _listing-bound_entropy.py:

.. oe:source:: bound_entropy.py
   :language: python
   :caption:  Estimation of Bound Ligand Entropy
   :refnum:   15

.. _listing-freeformsolv.py:

.. oe:source:: freeformsolv.py
   :language: python
   :caption:  Solvation Free Energy Estimation
   :refnum:   16

.. _listing-freeformconf.py:

.. oe:source:: freeformconf.py
   :language: python
   :caption:  Simple Free Energy Estimation
   :refnum:   17

.. _listing-freeformconfrstr.py:

.. oe:source:: freeformconfrstr.py
   :language: python
   :caption:  Simple Restriction Energy Estimation
   :refnum:   18

.. _listing-freeformconfadvanced.py:

.. oe:source:: freeformconfadvanced.py
   :language: python
   :caption:  Advanced Free Energy Estimation
   :refnum:   19

.. _listing-freeformconfadvrstr.py:

.. oe:source:: freeformconfadvrstr.py
   :language: python
   :caption:  Advanced Restriction Energy Estimation
   :refnum:   20

.. _listing-findsimilarconfs.py:

.. oe:source:: findsimilarconfs.py
   :language: python
   :caption:  Finding Similar Conformers
   :refnum:   21

.. _listing-TorsionScan.py:

.. oe:source:: TorsionScan.py
   :language: python
   :caption:  Perform torsion scan for all torsions in the input molecule
   :refnum:   22



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!




.. _chapter_aromatic_rings:

********************************************************************************
Nonplanar Aromatic Rings in Protein-Bound Ligands
********************************************************************************

Optimization of a ligand in a protein active site, especially if the protein conformation
is held fixed during optimization, can often lead to distortions of the aromatic ring structures.
Aromatic rings in optimized ligands are more prone to distortions when the initial pose structures
are the output of docking, since tools such as **OEDocking** or **POSIT** try to accommodate a
ligand into a rigid receptor pocket. Optimization of a ligand in the protein pocket helps relieve
both intramolecular close contacts within the ligand and intermolecular clashes between
the ligand and the protein.  However, such relaxation of the van der Waals clashes can
sometimes come at the expense of nonplanarity in the aromatic ring structures.

Ligand force fields used in optimization, such as ``Sage``, ``Parsley``, and ``MMFF``, put a
low energy constant in defining the out-of-plane potential of aromatic rings.  The low energy
penalty for aromatic rings to deviate from planarity in the force fields is also supported by quantum mechanical
calculations which estimate only a 0.5 kcal/mol penalty for ~5 degrees of deviation for a benzene
ring. The out-of-plane potential being the lowest vibrational motion during optimization means it
can easily be bent by a few degrees during optimization.



.. |A|         replace:: Å

.. _chapter_freeform:

********************************************************************************
*freeform* Theory
********************************************************************************

*freeform* has two distinct functions:

"freeform -calc conf...": Evaluation of the conformer free energy in solution,
meaning the free energy required to select a particular conformer out of the whole
conformational ensemble in solution.

"freeform -calc solv...": Fast estimation of the small molecule solvation free energy
and the XLogP calculated partition coefficient
(with graphical representation of fragment-based contributions to these physical
quantities).

.. _section_conformerDG:

Conformer Free Energies
================================================================================

Calculating the partition function
----------------------------------
The method is based upon combining ligand conformational search, energy minimization,
and entropy estimation in the workflow shown in
:ref:`Figure: Stages and workflow in the conformer free energy calculation<figure_confstages>`
below.

.. _figure_confstages:

.. figure:: /_images/freeform_conf_stages.png
   :scale: 80
   :align: center
   :alt: Stages and workflow in the conformer free energy calculation

   **Stages and workflow in the conformer free energy calculation**

The conformational search is done at a very high resolution
using the conformation generator OMEGA \ [Hawkins-2010]_\ .
The energy minimization uses Halgren's MMFF94s force field \ [Halgren-VI-1999]_\ and
consists of several stages, all aimed at arriving at the most thorough sampling of the
accessible conformational space of the ligand. Duplicate conformers are removed from
the final minimized set, leaving an ensemble of :math:`n_c` unique conformers which we use
to create an approximation to the partition function of the unbound ligand.
This is illustrated conceptually in
:ref:`Figure: Concept of ligand entropy as a sum-over-states of conformers<figure_EntropyWells>`.

.. _figure_EntropyWells:

.. figure:: /_images/EntropyWells.png
   :scale: 80
   :align: center
   :alt: Concept of ligand entropy as a sum-over-states of conformers

   **Concept of ligand entropy as a sum-over-states of conformer entropies**

To the molecule's gas-phase potential based on the MMFF94 force field (shown by the red line),
Sheffield solvation energies are added to give a solvation-corrected potential
(shown by the blue line) for which the minima are identified.
The analytic second derivative of each minimum is then used to
calculate the entropy contribution of each energy well according to \ [Wlodek-2010]_\.
An energy minimum with a wider than average energy well will have a higher entropy,
which will decrease the conformer free energy to select that conformer,
while the converse will be true for a narrower than average energy well.

With this, the contribution
:math:`Q_i` of each energy minimum to the overall partition function :math:`Q` can be calculated:

.. math::

   Q_i = q_t q_{ir} q_{iv} e^{-\epsilon_i /RT}

.. math::

   Q = \sum_{i=1}^{n_c} Q_i

Here :math:`\epsilon_i` is the relative internal energy (including solvation energy)
of the conformer relative to the global minimum conformation.
:math:`q_t`, :math:`q_ir` and :math:`q_iv` are the translational,
rotational and vibrational partition functions respectively, describing the
entropic contributions from that conformation.
:math:`n_c` is the number of unique conformations in the ensemble.
More details on these terms are given in the theory section of the szybki documentation.

Computing the conformer free energies
-------------------------------------
Based upon this approximation to the partition function, we calculate conformer free
energies: the free energy required to select a particular conformation from the unbound
ensemble of all conformers equilibrating in aqueous solution. Strictly speaking,
this is a Helmholtz free energy, not a Gibb's free energy, because we are neglecting
the differential PV (Pressure*Volume) contribution between conformers, but this
should be negligible. Based on the above conformer and ensemble partition functions, the
conformer free energy for any conformer is calculated straightforwardly as:

.. math::

   \Delta A_i = -RT ( \ln Q_i - \ln Q )

In addition to the graphic output file which shows a plot of the calculated free energies of
conformations vs. their relative intrinsic energies, numerical results are stored in the
log and csv files. For each conformation the following data are reported: rotational
and vibrational entropies, total force field energy, solvation energy, the sum of solvation
energy and force field energy, relative energy, free energy, and heavy atoms RMSD displacement
from the input 3D structure (the latter only when the ``-useInput3D`` option is used).

Ligand strain in the input 3D structure
---------------------------------------
When conformer free energies are calculated with the ``-useInput3D`` flag, *freeform*
pays attention to the 3-D structure in the input file and keeps track of it,
writing out the conformer free energy quantities associated with it. The idea is
that the user can input a bioactive confirmation from an x-ray crystal structure,
or a hypothetical model-built structure of interest, and get a direct readout of the energy
required to select that particular conformation out of the aqueous ensemble. A key issue,
however, is that the input 3D coordinates may be of artificially high energy,
usually due to small deviations of bond lengths and bond angles from optimum;
this is often true particularly of ligands from Xray structures. For this reason
a "cleanup" pre-optimization is done using harmonic constraints to the input
coordinates, thus retaining the shape of the ligand but resolving the artificially
high energy. This "cleanup"
energy is discarded. Since conformer free energies are calculated from energy
minima in order to characterize the entropy, an unconstrained minimization is
now required to find the closest energy minimum to the cleaned-up structure,
which we refer to as the input 3D minimum.  This minimization allows the torsions
in the input structure to relax away from where they may have been distorted from
the nearby local minimum, for example in order to fit into the active site.
*freeform* keeps track of this "distortion" strain energy as Estrain.
From this point, *freeform* simply includes the relaxed input 3D minimum as just
another energy minimum in the aqueous ensemble and calculates its conformer
free energy, which is specifically reported in the pdf and log output (see examples).
Keep in mind that the free energy required to adopt the input 3D minimum
may be significant and probably should be considered a component of the
strain energy also. Thus, within *freeform*, the overall strain energy for the
input 3D structure would be considered to consists of a) the conformer free energy
required to adopt the input 3D minimum (i.e. the closest local minimum to the input
structure), and b) the additional energy ``Estrain``
required to distort the torsions of that minimum so the ligand can adopt the
shape of the actual input 3D structure.

.. _section_solvationFe:

Solvation energy estimation
================================================================================

How it is calculated
--------------------
The term "Solvation energy" is defined here as the standard free energy of transferring
a compound from the gaseous phase into dilute aqueous solution, :math:`\Delta G_{solv}^{0}`.

Solvation energy is a crucial component of the solubility energetics,
and is directly related to hydrophilicity/hydrophobicity of a compound, therefore one can
expect it is correlated with another measure of hydrophobicity logP, as illustrated on the diagram
below (:ref:`Figure: Solvation, solubility and hydrophobicity<figure_solv_solu_hydro>`).
Such a correlation, particularly when functional groups contribution is
considered might not exist. *freeform* shows side-by-side the graphical group
contributions to solvation free energy and XLogP.

.. _figure_solv_solu_hydro:

.. figure:: /_images/solvation-solubility.png
   :scale: 100
   :align: center

   **Solvation, solubility and hydrophobicity**

The method is based on the continuum solvent model in which a PB solver ZAP
\ [Grant-2001]_\  is used. The calculation is performed on the lowest energy gas-phase
conformation found with the MMFF94 force field from the optimized set of conformations
generated by the conformation generator OMEGA \ [Hawkins-2010]_\ .
A set of atomic radii ZAP9 and AM1BCC partial charges as described in \ [Nicholls-2010]_\
is applied for all PB calculations. Atomic and group contributions to the free energy of
solvation for the input compound are calculated from atomic electrostatic potentials and
atomic area terms representing hydrophobic part of solvation. Assuming that a functional
group has :math:`n` atoms, its calculated solvation free energy :math:`\Delta G_s` is:

.. math::

   \Delta G_s = \sum_{i}^{n}[(V_{i,s}-V_{i,v})q_i+S_i]

where :math:`V_{i,s}` and  :math:`V_{i,v}` are calculated electrostatic potentials
on atom :math:`i` in solution and in vacuum respectively, :math:`q_i` is atom partial
charge and :math:`S_i` is atomic contribution to hydrophobic part of solvation
evaluated from a simple surface area model assuming 6.3 cal/(mol |A|:math:`\AA`) as a value for
microscopic surface tension coefficient. Graphical representation of group (or atomic)
contributions to the free energy of solvation is performed with the OE toolkits OEDepict and
Grapheme.

Counterintuitive group contributions to solvation energies
----------------------------------------------------------
Solvation free energy for molecular ions might not be trivial to interpret
because of very strong intrinsic electrostatic interactions. One can most
easily begin to understand these effects by considering zwitterions.  A common
zwitterion will contain both a group with a positive formal charge and a group
with a negative formal charge.  It is well known that zwitterions, though still
having high solvation energies, have significantly smaller solvation energies
than compounds with two formal charges of the same sign.  In fact, zwitterion
solvation energies are typically smaller than the solvation energy of the
analog molecule with a single charge.  For instance, as the following figures show
:ref:`Figure: Solvation energy of phenylalanine<figure_phenylalanine>`,
:ref:`Figure: Solvation energy of amide analog of phenylalanine<figure_phenylalanine1>` and
:ref:`Figure: Solvation energy of methoxy analog of phenylalanine<figure_phenylalanine2>`
the solvation energy of zwitterionic phenylalanine is -32.8 kcal/mol, while the solvation energy
of the formamide analog and the methyl ester analog are -73.4 and -63.4 kcal/mol respectively.

.. _figure_phenylalanine:

.. figure:: /_images/ph1.png
   :scale: 100
   :align: center

   **Solvation energy of phenylalanine**

.. _figure_phenylalanine1:

.. figure:: /_images/ph2.png
   :scale: 100
   :align: center

   **Solvation energy of amide analog of phenylalanine**

.. _figure_phenylalanine2:

.. figure:: /_images/ph3.png
   :scale: 100
   :align: center

   **Solvation energy of methoxy analog of phenylalanine**

One can consider then, that adding a charge that is the opposite
charge of the current molecular ion contributes a positive 30 to 40 kcal/mol
to the solvation energy.
A similar situation, perhaps even more dramatic, occurs in the case of intramolecular
salt bridges, where positively and negatively charged groups are positioned in
a very short distance (that kind of interaction not only exists in macromolecules:
NMR and hydrogen exchange rate experiments have confirmed the presence of salt
bridges between arginine or lysine and aspartate or glutamate side chains also
in short peptides \ [Otter-1989]_, [Mayne-1998]_\).
Making positive contributions to the solvation energy is generally considered a
hydrophobic effect, yet here the contribution is made by a charged species --
something that is somewhat counterintuitive at first.  Nevertheless, in this
context, one can understand how, under the right conditions, a normally
hydrophilic functional group can make a significant positive contribution to
the solvation energy.
The more confusing circumstance is when, rather than a simple zwitterion, we
see a similar effect in a molecule with either multiple charges of one type
(either positive or negative) and a single charge of the opposite sign.
Consider a molecule with 2 negative ions, one positive ion and a total charge
of -1, like the one shown on
:ref:`Figure: Example of counterintuitive group contributions to solvation<figure_counterint>`
below.

.. _figure_counterint:

.. figure:: /_images/counterintuitive.png
   :scale: 80
   :align: center
   :alt: Example of counterintuitive group contributions to solvation

   **Counterintuitive group contributions to solvation**

In this case, the positive ion will be changing the formal charge from
-2 to -1.  This will make the total solvation energy significantly less
negative (a positive contribution to the solvation energy).  The positive ionic
functional group in this case will have a large positive solvation energy.
While a charged group is indeed not hydrophobic, in this instance, one can
understand that it makes the solvation energy less negative in a manner similar
to the way a hydrophobic group might, but to a larger degree.
In more subtle cases, one can observe a similar though less dramatic hydrophobicity
in a molecule with a single charge, either positive or negative and another fragment
that makes a large neutralizing contribution to the partial charge of the
molecule.

In order to alert the user, species which contain strong intramolecular
electrostatic interactions of the nature described above are depicted on a
light pink background.  This should act as a reminder to users to consider the
net charge of the molecule in interpreting the relative contribution of each
fragment to the solvation energy.



.. |A|         replace:: Å

.. _chapter_szybkitheory:

********************************************************************************
SZYBKI Theory
********************************************************************************

.. _section_forcefield:

Force Field
================================================================================

Theory documentation for forcefields is available from :ref:`OEFF theory<section_oeff_forceefield>`.

.. _section_entropy:

Entropy evaluation
================================================================================

Ligand entropy is evaluated as a sum of configurational entropy (:math:`S_c`) and
solvation entropy (:math:`\Delta S_s`):

.. math::

   S = S_c + \Delta S_s

Configurational entropy
--------------------------------------------------------------------------------
Configurational entropy is calculated as:

.. math::

   S_c = kN \Bigg[ 1 + \ln \Bigg(\frac{q}{N} \Bigg) + \frac{T}{q} \frac{\partial q}{\partial T} \Bigg]

where q is the conformation dependent partition function:

.. math::

   q = q_t \sum_{i=1}^{n_c} e^{-\frac{\epsilon_i}{kT}} q_{iv} q_{ir}

Here :math:`q_t`, :math:`q_{ir}` and :math:`q_{iv}` are the translational, rotational and vibrational
partition functions respectively, :math:`n_c` is the number of unique conformations in the ensemble.
All 3 partition functions are calculated from the classical statistical mechanics expressions
which could be found in \ [McQuarrie-1976]_\. Vibrational frequencies for each 
conformation, needed for evaluation of :math:`q_{ir}` are derived from diagonalization of a 
Hessian matrix obtained from Quasi-Newton optimization when convergence is achieved. Eigenvalues
:math:`\lambda_i` of the mass-weighted Hessian:

.. math::
   
   \mathbf{H}^{m} = \mathbf{M^{-1/2}HM^{-1/2}}

are converted into wavenumbers :math:`\tilde{\nu}_i` according to:

.. math::

   \tilde{\nu}_i = \frac{1}{2\pi c} \sqrt{\lambda_i}

Solvation entropy
--------------------------------------------------------------------------------
Solvation entropy is split into electrostatic and hydrophobic parts:

.. math::

   \Delta S_s = \Delta S_{s,elec} + \Delta S_{s,hyd}

The electrostatic part of solvation entropy is divided in to the bulk component and tight electrostatic 
polar solute - water interactions (hydrogen bonds). The bulk contribution is estimated from the temperature
dependence of the solvent dielectric constant as:

.. math::

   \Delta S_{s,elec\_bulk} = -\bigg(\frac{\partial \Delta G_s}{\partial \epsilon_{solv}}\bigg) \bigg(\frac{\partial \epsilon_{solv}}{\partial T}\bigg)

The second term of the electrostatic solvation entropy is estimated as a constant of 28 J/(mol K).
 
The hydrophobic term, :math:`\Delta S_{s,hyd}`, is evaluated as:

.. math::
   
   \Delta S_{s,hyd} = -\bigg(\frac{\partial \Delta G_{s,hyd}}{\partial T}\bigg)

where :math:`\Delta G_{s,hyd}` consists of 3 components:

.. math::
   
   \Delta G_{s,hyd} = \Delta G_{cav} + \Delta G_{VdW} + \Delta G_{Ind}

describing the free energy of cavitation, solute-solvent van der Waals and inductive terms respectively.
The cavity formation term is calculated from Scaled Particle Theory \ [Pierotti-1976]_\.
Analytical expressions for :math:`\Delta G_{VdW}` and :math:`\Delta G_{Ind}` terms are also taken from 
the 1976 Pierotti review.

Protein-bound ligand entropy
--------------------------------------------------------------------------------
Configurational entropy of a protein bound ligand is calculated totally as vibrational entropy 
for 3N modes, assuming that 3 rotational and 3 translational degrees of freedom of a solution
ligand are transformed into low-vibrational degrees of freedom for the bound ligand.

Solvation entropy for a ligand in the active site is assumed to be a sum of its fractional value 
in solution determined by the percentage of the ligand surface exposed to the solvent, :math:`f\Delta S_s`,
and a partial desolvation entropy of the protein active site, :math:`\Delta S_{des}`

.. math::
   S_{protein} = S_v + f\Delta S_s + \Delta S_{des}

where f is the fraction of ligand surface exposed to the solvent. It is important to notice that
:math:`S_{protein}` is not an experimentally measurable value, and that only the difference between
:math:`S_{protein}` and :math:`S = S_c + \Delta S_s` might be compared with experimental binding
entropy.



.. _szybki_part_theory:

**********************************
Theory
**********************************

.. toctree::
   :maxdepth: 3

   szybkitheory
   aromatic_rings
   freeformtheory

.. note::

   Units of all energies reported from **SzybkiTK** are in ``kcal/mol``.
 

.. zaptk toolkit documentation master file

#########################
Zap TK |zap_version|
#########################
               
.. toctree::
   :maxdepth: 3

   theory
   selected_examples_python
   api
   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _zap_part_theory:

********************************
Theory and Examples
********************************

.. toctree::

   thewhatofzap
   thewhyofzap
   thewayofzap

.. note::

   Units of all energies reported from **ZapTK** are in ``kcal/mol``.


.. _chapter_thewhatofzap:

********************************************************************************
The What of Zap
********************************************************************************

"A Smooth Permittivity Function for Poisson-Boltzmann Solvation Methods,"
J. Andrew Grant, Barry T. Pickup and Anthony Nicholls, J. Comp. Chem, Vol
22, No.6, pgs 608-640, April 2001.

ZAP is, at its heart, a Poisson-Boltzmann (PB) solver. The Poisson equation
describes how electrostatic fields change in a medium of varying dielectric,
such as an organic molecule in water. The Boltzmann bit adds in the effect
of mobile charge, e.g. salt. PB is an effective way to simulate the effects
of water in biological systems. It relies on a charge description of a
molecule, the designation of low (molecular) and high (solvent) dielectric
regions and a description of an ion-accessible volume and produces a grid of
electrostatic potentials. From this, transfer energies between different
solvents, binding energies, pKa shifts, pI's, solvent forces, electrostatic
descriptors, solvent dipole moments, surface potentials and dielectric
focusing  can  all be calculated. As electrostatics is one of the two
principal components of molecular interaction (the other, of course, being
shape), ZAP is OpenEye's attempt to get it right.


.. oe:namespace:: OEPB

.. meta::
   :keywords: OEArea, Area

.. _OEPB_OEArea:

.. oe:class:: OEArea

   .. oe:api::

      class OEArea

   Calculates surface area using the same grid-based Gaussians that
   Zap uses. Mostly used for calculating the area term
   in solvation calculations or the buried area term in bind
   calculations.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEArea()
            OEArea(const OEArea &)

      .. oe:language:: python

         .. oe:api:: python

            OEArea() -> OEArea
            OEArea(arg2: OEArea) -> OEArea

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEArea &operator=(const OEArea &)

      Assignment operator.

.. _OEPB_OEArea_GetArea:

   .. oe:method:: GetArea

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetArea(const OEChem::OEMolBase& mol)
            bool GetArea(const OEChem::OEMolBase& mol, float* atomArea)
            float GetArea(const OEChem::OEMolBase& mol,
                          const OEChem::OEResidue& res)
            float GetArea(const OEChem::OEMolBase& mol, const float* atomArea,
                          const OEChem::OEResidue& res)

      .. oe:language:: python

         .. oe:api:: python

            GetArea(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float
            GetArea(mol: Union[OEGraphMol,OEMol,OEQMol], atomArea: OEFloatArray) -> bool
            GetArea(mol: Union[OEGraphMol,OEMol,OEQMol], res: OEResidue) -> float
            GetArea(mol: Union[OEGraphMol,OEMol,OEQMol],
                    atom_area: OEFloatArray, res: OEResidue) -> float

      Calculate the surface area of the passed-in molecule. The first
      version calculates the surface area of the entire molecule. The
      second version takes an array sized by ``OEMolBase::GetMaxAtomIdx`` to return the contribution of each
      atom to the total surface area. The third and fourth versions calculates and returns the surface area of the residue passed into the function. 
      The fourth version differs from the third version by taking a already calculated atom area array, which avoids calculating atom area repeatedly.

      Note that whether or not hydrogens are included in these calculations is 
      controlled by :oe:meth:`OEPB::OEArea::SetUseHydrogens` which is set to ``false`` by default.

      The following demonstrates how to calculate
      the area of a molecule:

      .. oe:source:: OEArea_GetArea.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GetArea-Molecule
         :caption:  Example of calculating the surface area of a molecule

      .. oe:source:: OEArea_GetArea.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GetArea-Molecule
         :caption:  Example of calculating the surface area of a molecule

      .. oe:language:: python

        :ref:`Full listing. <listing-OEArea_GetArea.py>`

      .. oe:source:: OEArea_GetArea.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GetArea-Molecule
         :caption:  Example of calculating the surface area of a molecule

      .. oe:source:: OEArea_GetArea.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GetArea-Molecule
         :caption:  Example of calculating the surface area of a molecule

      The following demonstrates how to retrieve the individual atom
      contributions to the surface area:

      .. oe:source:: OEArea_GetArea.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GetArea-Atoms
         :caption:  Example of calculating the surface area contribution of individual atoms

      .. oe:source:: OEArea_GetArea.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GetArea-Atoms
         :caption:  Example of calculating the surface area contribution of individual atoms

      .. oe:language:: python

        :ref:`Full listing. <listing-OEArea_GetArea.py>`

      .. oe:source:: OEArea_GetArea.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GetArea-Atoms
         :caption:  Example of calculating the surface area contribution of individual atoms

      .. oe:source:: OEArea_GetArea.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GetArea-Atoms
         :caption:  Example of calculating the surface area contribution of individual atoms

      The following demonstrates how to retrieve the per residue contributions to the surface area:

      .. oe:source:: OEArea_GetArea.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GetArea-Residues
         :caption:  Example of calculating the surface area contribution of indivdual residues

      .. oe:source:: OEArea_GetArea.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GetArea-Residues
         :caption:  Example of calculating the surface area contribution of indivdual residues

      .. oe:language:: python

        :ref:`Full listing. <listing-OEArea_GetArea.py>`

      .. oe:source:: OEArea_GetArea.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GetArea-Residues
         :caption:  Example of calculating the surface area contribution of indivdual residues

      .. oe:source:: OEArea_GetArea.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GetArea-Residues
         :caption:  Example of calculating the surface area contribution of indivdual residues

      The following demonstrates how to retrieve the per residue contributions to the surface area,
      in an optimized way where the per atom contributions are pre-calculated and used for the residue
      based calculation. This is particularly important if this calculation is done on a large set of residues:

      .. oe:source:: OEArea_GetArea.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GetArea-Residues-Optimized
         :caption:  Example of calculating the surface area contribution of indivdual residues

      .. oe:source:: OEArea_GetArea.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GetArea-Residues-Optimized
         :caption:  Example of calculating the surface area contribution of indivdual residues

      .. oe:language:: python

        :ref:`Full listing. <listing-OEArea_GetArea.py>`

      .. oe:source:: OEArea_GetArea.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GetArea-Residues-Optimized
         :caption:  Example of calculating the surface area contribution of indivdual residues

      .. oe:source:: OEArea_GetArea.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GetArea-Residues-Optimized
         :caption:  Example of calculating the surface area contribution of indivdual residues

.. _OEPB_OEArea_GetMethod:

   .. oe:method:: GetMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetMethod() -> int

      Returns an ``int`` indicating the method that is used to model
      the area of the molecule.  The two possible return values are
      :oe:const:`OEPB::OEAreaMethod::Gaussian` and :oe:const:`OEPB::OEAreaMethod::Discrete`.

.. _OEPB_OEArea_GetUseHydrogens:

   .. oe:method:: GetUseHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseHydrogens() -> bool

      Returns a ``bool`` where ``true`` means explicit hydrogens are
      turned on and ``false`` means they are turned off for the area
      calculation.

.. _OEPB_OEArea_SetMethod:

   .. oe:method:: SetMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMethod(const unsigned int method)

      .. oe:language:: python

         .. oe:api:: python

            SetMethod(method: int) -> bool

      Takes an ``int`` with the value of
      :oe:const:`OEPB::OEAreaMethod::Gaussian` of
      :oe:const:`OEPB::OEAreaMethod::Discrete`

.. _OEPB_OEArea_SetUseHydrogens:

   .. oe:method:: SetUseHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseHydrogens(bool state)

      .. oe:language:: python

         .. oe:api:: python

            SetUseHydrogens(state: bool) -> bool

      This method takes a ``bool`` where ``true`` turns on explicit
      hydrogens for calculating area and ``false`` turn them off.


.. oe:namespace:: OEPB

.. meta::
   :keywords: OEBind, Bind

.. _OEPB_OEBind:

.. oe:class:: OEBind

   .. oe:api::

      class OEBind

   Calculates protein-ligand binding properties.  The protein may either be
   passed in as an argument during construction or set with
   :oe:meth:`OEPB::OEBind::SetProtein`.  The ligand is passed in as an
   argument to :oe:meth:`OEPB::OEBind::Bind` as well as an
   :ref:`OEBindResults <OEPB_OEBindResults>` instance.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBind()
            OEBind(const OEBind& rhs)
            OEBind(const OEChem::OEMolBase& protein)

      .. oe:language:: python

         .. oe:api:: python

            OEBind() -> OEBind
            OEBind(rhs: OEBind) -> OEBind
            OEBind(protein: Union[OEGraphMol,OEMol,OEQMol]) -> OEBind

      Default and copy constructors.  Besides the default and copy
      constructors, OEBind includes a constructor that takes the protein
      to be used in binding calculations. Constructing an OEBind object
      with the protein is identical to using the default constructor and
      then calling :oe:meth:`OEPB::OEBind::SetProtein`.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBind &operator=(const OEBind &rhs)

      Assignment operator. 

   .. oe:method:: Bind

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Bind(const OEChem::OEMolBase& ligand, OEBindResults& results)
            OESystem::OEIterBase<OEBindResults>* Bind(const OEChem::OEMCMolBase& ligand)

      .. oe:language:: python

         .. oe:api:: python

            Bind(ligand: Union[OEGraphMol,OEMol,OEQMol], results: OEBindResults) -> bool
            Bind(ligand: OEMol) -> OEBindResultsIter

      Calculate full binding results, including Coulombic terms. For a
      single molecule, pass in the molecule and the :ref:`OEBindResults <OEPB_OEBindResults>` class
      will be filled in.  The following is a simple example of how `Bind`
      is used.

      .. oe:source:: OEBind.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEBind
         :caption:  Example of using the OEBind object

      .. oe:source:: OEBind.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEBind
         :caption:  Example of using the OEBind object

      .. oe:language:: python

        :ref:`Full listing. <listing-OEBind.py>`

      .. oe:source:: OEBind.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEBind
         :caption:  Example of using the OEBind object

      .. oe:source:: OEBind.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEBind
         :caption:  Example of using the OEBind object

   .. oe:method:: GetZap

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEZap& GetZap()
            const OEZap& GetZap() const

      .. oe:language:: python

         .. oe:api:: python

            GetZap() -> OEZap

      Get a reference to the internal :ref:`OEZap <OEPB_OEZap>` object
      contained in an OEBind instance.  With the non-const version, you
      can adjust :ref:`OEZap <OEPB_OEZap>` parameters that affect the
      :ref:`OEBind <OEPB_OEBind>` calculation. For example, to use an
      :ref:`OEBind <OEPB_OEBind>` instance with a specific grid spacing:

      .. oe:source:: OEBind.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEBind-SetGridSpacing
         :caption:  Example of setting the grid spacing of a OEBind object

      .. oe:source:: OEBind.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEBind-SetGridSpacing
         :caption:  Example of setting the grid spacing of a OEBind object

      .. oe:language:: python

        :ref:`Full listing. <listing-OEBind.py>`

      .. oe:source:: OEBind.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEBind-SetGridSpacing
         :caption:  Example of setting the grid spacing of a OEBind object

      .. oe:source:: OEBind.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEBind-SetGridSpacing
         :caption:  Example of setting the grid spacing of a OEBind object

      Note that some properties of the :ref:`OEZap <OEPB_OEZap>` object are
      not controllable via this mechanism.

   .. oe:method:: SetProtein

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetProtein(const OEChem::OEMolBase& protein)

      .. oe:language:: python

         .. oe:api:: python

            SetProtein(protein: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Set the protein molecule to be used by the :ref:`OEBind <OEPB_OEBind>` object. Note that the protein
      should have radii and partial charges pre-calculated before passing to 
      :oe:meth:`OEPB::OEBind::SetProtein`.

   .. oe:method:: SetZap

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetZap(const OEZap& zap)

      .. oe:language:: python

         .. oe:api:: python

            SetZap(zap: OEZap) -> bool

      Update the internal OEZap object.  Note that some properties of the OEZap 
      object are not controllable via this mechanism.

   .. oe:method:: SimpleBind

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SimpleBind(const OEChem::OEMolBase& ligand,
                            OESimpleBindResults& results)
            OESystem::OEIterBase<OESimpleBindResults>* SimpleBind(const OEChem::OEMCMolBase& ligand)

      .. oe:language:: python

         .. oe:api:: python

            SimpleBind(ligand: Union[OEGraphMol,OEMol,OEQMol],
                       results: OESimpleBindResults) -> bool
            SimpleBind(ligand: OEMol) -> OESimpleBindResultsIter

      Calculate simple binding results, without the Coulombic terms.
      See the discussion in :ref:`section_bindingenergies` about the differences
      between :oe:meth:`OEPB::OEBind::Bind` and :oe:meth:`OEPB::OEBind::SimpleBind`.  See
      :ref:`OESimpleBindResults <OEPB_OESimpleBindResults>` to see all the values available.

      Additionally, both the `SimpleBind` and :oe:meth:`OEPB::OEBind::Bind` methods
      calculate area contributions.


.. oe:namespace:: OEPB

.. meta::
   :keywords: OEBindResults, BindResults

.. _OEPB_OEBindResults:

.. oe:class:: OEBindResults

   .. oe:api::

      class OEBindResults : public OESimpleBindResults

   All energy results are in units of kT.

   The following methods are publicly inherited from :ref:`OESimpleBindResults <OEPB_OESimpleBindResults>`:

   ============================================================================================= ============================================================================================= ==============================================================================================
   :oe:meth:`operator=<OEPB::OESimpleBindResults::operator=>`                                    :oe:meth:`GetBuriedArea<OEPB::OESimpleBindResults::GetBuriedArea>`                            :oe:meth:`GetUnboundLigandZapEnergy<OEPB::OESimpleBindResults::GetUnboundLigandZapEnergy>`    
   :oe:meth:`GetBindingEnergy<OEPB::OESimpleBindResults::GetBindingEnergy>`                      :oe:meth:`GetBuriedAreaEnergy<OEPB::OESimpleBindResults::GetBuriedAreaEnergy>`                :oe:meth:`GetUnboundProteinArea<OEPB::OESimpleBindResults::GetUnboundProteinArea>`            
   :oe:meth:`GetBoundLigandArea<OEPB::OESimpleBindResults::GetBoundLigandArea>`                  :oe:meth:`GetComplexArea<OEPB::OESimpleBindResults::GetComplexArea>`                          :oe:meth:`GetUnboundProteinAreaEnergy<OEPB::OESimpleBindResults::GetUnboundProteinAreaEnergy>`
   :oe:meth:`GetBoundLigandAreaEnergy<OEPB::OESimpleBindResults::GetBoundLigandAreaEnergy>`      :oe:meth:`GetComplexAreaEnergy<OEPB::OESimpleBindResults::GetComplexAreaEnergy>`              :oe:meth:`GetUnboundProteinZapEnergy<OEPB::OESimpleBindResults::GetUnboundProteinZapEnergy>`  
   :oe:meth:`GetBoundLigandZapEnergy<OEPB::OESimpleBindResults::GetBoundLigandZapEnergy>`        :oe:meth:`GetComplexZapEnergy<OEPB::OESimpleBindResults::GetComplexZapEnergy>`                :oe:meth:`GetZapEnergy<OEPB::OESimpleBindResults::GetZapEnergy>`                              
   :oe:meth:`GetBoundProteinArea<OEPB::OESimpleBindResults::GetBoundProteinArea>`                :oe:meth:`GetConf<OEPB::OESimpleBindResults::GetConf>`                                        :oe:meth:`Print<OEPB::OESimpleBindResults::Print>`                                            
   :oe:meth:`GetBoundProteinAreaEnergy<OEPB::OESimpleBindResults::GetBoundProteinAreaEnergy>`    :oe:meth:`GetUnboundLigandArea<OEPB::OESimpleBindResults::GetUnboundLigandArea>`                                                                                                            
   :oe:meth:`GetBoundProteinZapEnergy<OEPB::OESimpleBindResults::GetBoundProteinZapEnergy>`      :oe:meth:`GetUnboundLigandAreaEnergy<OEPB::OESimpleBindResults::GetUnboundLigandAreaEnergy>`                                                                                                
   ============================================================================================= ============================================================================================= ==============================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBindResults()
            OEBindResults(const OEBindResults &)

      .. oe:language:: python

         .. oe:api:: python

            OEBindResults() -> OEBindResults
            OEBindResults(arg2: OEBindResults) -> OEBindResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBindResults &operator=(const OEBindResults &)

      Assignment operator.

   .. oe:method:: GetAnalyticCoulombicBindingEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetAnalyticCoulombicBindingEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetAnalyticCoulombicBindingEnergy() -> float

      This returns the value of the analytic binding energy for the
      ligand and protein that have been set to the OEBind object.
      This is equivalent to calling
      :oe:func:`OEPB::OECalculateCoulombicBinding` where
      the same ligand and protein and inner dielectric are the
      arguments.

   .. oe:method:: GetBoundLigandCoulombEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBoundLigandCoulombEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundLigandCoulombEnergy() -> float

      Returns the grid-based coulomb energy for the ligand in the
      bound state, including self-interaction.  Specially, it returns
      the ``boundLigandCoulombEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::Bind` API section.

   .. oe:method:: GetBoundProteinCoulombEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBoundProteinCoulombEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundProteinCoulombEnergy() -> float

      Returns the grid-based coulomb energy for the protein in the
      bound state, including self-interaction.  Specially, it returns
      the ``boundProteinCoulombEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::Bind` API section.

   .. oe:method:: GetComplexCoulombEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetComplexCoulombEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexCoulombEnergy() -> float

      Returns the grid-based coulomb energy for the complex, including
      self-interaction.  Specially, it returns the
      ``complexCoulombEnergy`` variable shown in the :oe:meth:`OEPB::OEBind::Bind`
      API section.  This is equivalent to the sum of the results
      returned by :oe:meth:`OEPB::OEBindResults::GetBoundLigandCoulombEnergy` and
      :oe:meth:`OEPB::OEBindResults::GetBoundProteinCoulombEnergy`.

   .. oe:method:: GetCoulombEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetCoulombEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetCoulombEnergy() -> float

      Returns the difference in Coulomb energy between the complex and
      the unbound ligand and protein.  This is equivalent to
      :oe:meth:`OEPB::OEBindResults::GetComplexCoulombEnergy` -
      :oe:meth:`OEPB::OEBindResults::GetUnboundProteinCoulombEnergy` -
      :oe:meth:`OEPB::OEBindResults::GetUnboundLigandCoulombEnergy`.

   .. oe:method:: GetDesolvationEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetDesolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetDesolvationEnergy() -> float

      This is equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetZapEnergy` -
      :oe:meth:`OEPB::OEBindResults::GetCoulombEnergy`.

   .. oe:method:: GetLigandDesolvationEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetLigandDesolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandDesolvationEnergy() -> float

      This is equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetBoundLigandZapEnergy` -
      :oe:meth:`OEPB::OEBindResults::GetBoundLigandCoulombEnergy` -
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundLigandZapEnergy` +
      :oe:meth:`OEPB::OEBindResults::GetUnboundLigandCoulombEnergy`.

   .. oe:method:: GetProteinDesolvationEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetProteinDesolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinDesolvationEnergy() -> float

      This is equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetBoundProteinZapEnergy` -
      :oe:meth:`OEPB::OEBindResults::GetBoundProteinCoulombEnergy`
      -
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundProteinZapEnergy`
      +
      :oe:meth:`OEPB::OEBindResults::GetUnboundProteinCoulombEnergy`.

   .. oe:method:: GetUnboundLigandCoulombEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetUnboundLigandCoulombEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundLigandCoulombEnergy() -> float

      Returns the grid-based coulomb energy for the ligand in the
      unbound state, including self-interaction.  Specially, it
      returns the ``unboundLigandCoulombEnergy`` variable shown in
      the :oe:meth:`OEPB::OEBind::Bind` API section.

   .. oe:method:: GetUnboundProteinCoulombEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetUnboundProteinCoulombEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundProteinCoulombEnergy() -> float

      Returns the grid-based coulomb energy for the protein in the
      unbound state, including self-interaction.  Specially, it
      returns the ``unboundProteinCoulombEnergy`` variable shown in
      the :oe:meth:`OEPB::OEBind::Bind` API section.

   .. oe:method:: Print

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Print(OEPlatform::oeostream& ofs) const
            void Print(OESystem::OEErrorHandler& log) const

      .. oe:language:: python

         .. oe:api:: python

            Print(ofs: oeostream) -> None
            Print(log: OEErrorHandler) -> None

      Prints out all of the available data to the oeostream of the
      OEErrorHandle passed in.


.. oe:namespace:: OEPB

.. meta::
   :keywords: OEET, ET

.. _OEPB_OEET:

.. oe:class:: OEET

   .. oe:api::

      class OEET

   Used to calculate electrostatic similarity between molecules using
   Poisson-Boltzmann electrostatic potentials.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEET(const OEET& rhs)
            OEET(float dielectric = 80.0f)

      .. oe:language:: python

         .. oe:api:: python

            OEET(dielectric: float = 80.0) -> OEET
            OEET(rhs: OEET) -> OEET

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEET &operator=(const OEET &rhs)

      Assignment operator

      Assignment operator.

   .. oe:method:: GetDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetDielectric() -> float

      Returns the setting for the outer dielectric constant.

   .. oe:method:: GetGridBuffer

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetGridBuffer() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridBuffer() -> float

      Returns the setting for the amount of space between the molecule and the edge of the grid.

   .. oe:method:: GetGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetGridSpacing() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridSpacing() -> float

      Returns the setting for the grid spacing.

   .. oe:method:: GetInnerDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetInnerDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetInnerDielectric() -> float

      Returns the value for the inner dielectric.

   .. oe:method:: GetInnerMask

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetInnerMask() const

      .. oe:language:: python

         .. oe:api:: python

            GetInnerMask() -> float

      Returns the value for the inner mask.

   .. oe:method:: GetJoin

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetJoin() const

      .. oe:language:: python

         .. oe:api:: python

            GetJoin() -> bool

      Returns the setting for whether or not to join the molecules for masking.

   .. oe:method:: GetOuterMask

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetOuterMask() const

      .. oe:language:: python

         .. oe:api:: python

            GetOuterMask() -> float

      Returns the value for the outer mask.

   .. oe:method:: GetSaltConcentration

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSaltConcentration() const
            Returns the setting for the salt concentration

      .. oe:language:: python

         .. oe:api:: python

            GetSaltConcentration() -> float

   .. oe:method:: SetDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDielectric(float d)

      .. oe:language:: python

         .. oe:api:: python

            SetDielectric(d: float) -> None

      Sets the outer dielectric constant

   .. oe:method:: SetGridBuffer

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetGridBuffer(float f)

      .. oe:language:: python

         .. oe:api:: python

            SetGridBuffer(f: float) -> None

      Sets the grid buffer, or boundary spacing, which is the amount
      of distance between the molecule and the edge of the grid.  The
      default value is 6.0.

   .. oe:method:: SetGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetGridSpacing(float f)

      .. oe:language:: python

         .. oe:api:: python

            SetGridSpacing(f: float) -> None

      Sets the grid spacing.  The default value is 0.75.

   .. oe:method:: SetInnerDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetInnerDielectric(float d)

      .. oe:language:: python

         .. oe:api:: python

            SetInnerDielectric(d: float) -> None

      Sets the inner dielectric constant

   .. oe:method:: SetInnerMask

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetInnerMask(float f)

      .. oe:language:: python

         .. oe:api:: python

            SetInnerMask(f: float) -> None

      Sets the inner mask for electrostatic comparison.  The default
      value is set to 0.05.  The inner mask is used to mask out the
      inner part of a molecule.  The inner part of the molecule is
      masked out so that the important regions surrounding the
      molecule dominate the electrostatic comparison.

   .. oe:method:: SetJoin

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetJoin(bool j)

      .. oe:language:: python

         .. oe:api:: python

            SetJoin(j: bool) -> None

      Turns molecular joining on(``true``) or off(``false``).  The
      default value is ``true``, which uses the combine reference
      molecule and trial molecule when applying the inner and outer
      mask.

   .. oe:method:: SetOuterMask

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOuterMask(float f)

      .. oe:language:: python

         .. oe:api:: python

            SetOuterMask(f: float) -> None

      Sets the outer mask for electrostatic comparison.  The default
      value is set to 0.0005.  The outer mask is used to mask out
      regions far from the molecule.

   .. oe:method:: SetRefMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRefMol(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            SetRefMol(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets the reference molecule.  

   .. oe:method:: SetSaltConcentration

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSaltConcentration(float conc)

      .. oe:language:: python

         .. oe:api:: python

            SetSaltConcentration(conc: float) -> None

      Sets the salt concentration.  The default value is 0.04.

   .. oe:method:: Tanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            float Tanimoto(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Tanimoto(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

      Returns the electrostatic Tanimoto between the reference
      molecule that has been set and the trial molecule that is passed
      in as an argument.


.. _OEPBClasses:

*******************
OEPB Classes
*******************

.. oe:namespace:: OEPB

.. toctree::

   OEArea
   OEBind
   OEBindResults
   OEET
   OESimpleBindResults
   OEZap


.. oe:namespace:: OEPB

.. meta::
   :keywords: OESimpleBindResults, SimpleBindResults

.. _OEPB_OESimpleBindResults:

.. oe:class:: OESimpleBindResults

   .. oe:api::

      class OESimpleBindResults

   This class represents  `OESimpleBindResults`.  The Zap calculations
   used for  the SimpleBindResults are  performed with the  2 separate
   dielectric  constants,  the  internal  for  the  molecule  and  the
   external for the solvent. All energy results are in units of kT.

   The following classes derive from this class:
    * :ref:`OEBindResults <OEPB_OEBindResults>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESimpleBindResults()
            OESimpleBindResults(const OESimpleBindResults &)

      .. oe:language:: python

         .. oe:api:: python

            OESimpleBindResults() -> OESimpleBindResults
            OESimpleBindResults(arg2: OESimpleBindResults) -> OESimpleBindResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESimpleBindResults &operator=(const OESimpleBindResults &)

      Assignment operator

      Assignment operator.

   .. oe:method:: GetBindingEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBindingEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBindingEnergy() -> float

      Returns the binding energy of the ligand and protein.
      Equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetBuriedAreaEnergy` +
      :oe:meth:`OEPB::OESimpleBindResults::GetZapEnergy`.

   .. oe:method:: GetBoundLigandArea

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBoundLigandArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundLigandArea() -> float

      Returns the ``boundLigandArea`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  The bound ligand area is the
      area of the ligand exposed to the solvent while in the bound
      state.

   .. oe:method:: GetBoundLigandAreaEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBoundLigandAreaEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundLigandAreaEnergy() -> float

      Returns the ``boundLigandAreaEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the energy associated
      with the bound ligand area.

   .. oe:method:: GetBoundLigandZapEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBoundLigandZapEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundLigandZapEnergy() -> float

      Returns the ``boundLigandZapEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the ligand grid energy
      obtained from a Zap calculation of the complex.

   .. oe:method:: GetBoundProteinArea

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBoundProteinArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundProteinArea() -> float

      Returns the ``boundProteinArea`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the area of the protein
      exposed to the solvent while in the bound state.

   .. oe:method:: GetBoundProteinAreaEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBoundProteinAreaEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundProteinAreaEnergy() -> float

      Returns the ``boundProteinAreaEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the energy associated
      with the bound protein area.

   .. oe:method:: GetBoundProteinZapEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBoundProteinZapEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundProteinZapEnergy() -> float

      Returns the ``boundProteinZapEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the protein grid energy
      obtained from a Zap calculation of the complex.

   .. oe:method:: GetBuriedArea

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBuriedArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuriedArea() -> float

      Returns the amount of area that has become buried as a result of
      binding.  Equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundProteinArea` +
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundLigandArea` -
      :oe:meth:`OEPB::OESimpleBindResults::GetComplexArea`.

   .. oe:method:: GetBuriedAreaEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBuriedAreaEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuriedAreaEnergy() -> float

      Returns the energy penalty associated with the buried area of
      the complex.  Equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetComplexAreaEnergy` -
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundProteinAreaEnergy`
      -
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundLigandAreaEnergy`.

   .. oe:method:: GetComplexArea

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetComplexArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexArea() -> float

      Returns the ``complexArea`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the solvent accessible
      surface area of the complex.

   .. oe:method:: GetComplexAreaEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetComplexAreaEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexAreaEnergy() -> float

      Returns the ``complexAreaEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the energy of the
      solvent accessible surface area of the complex.
     
   .. oe:method:: GetComplexZapEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetComplexZapEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexZapEnergy() -> float

      Returns the grid energy of the complex.  This is equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetBoundProteinZapEnergy` +
      :oe:meth:`OEPB::OESimpleBindResults::GetBoundLigandZapEnergy`.

   .. oe:method:: GetConf

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEChem::OEConfBase* GetConf()
            const OEChem::OEConfBase* GetConf() const

      .. oe:language:: python

         .. oe:api:: python

            GetConf() -> OEConfBase

      Returns a pointer to the active conformer.

   .. oe:method:: GetUnboundLigandArea

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetUnboundLigandArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundLigandArea() -> float

      Returns the ``unboundLigandArea`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the solvent accessible
      surface area of the unbound ligand.

   .. oe:method:: GetUnboundLigandAreaEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetUnboundLigandAreaEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundLigandAreaEnergy() -> float

      Returns the ``unboundLigandAreaEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the energy of the
      solvent accessible surface area of the unbound ligand.

   .. oe:method:: GetUnboundLigandZapEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetUnboundLigandZapEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundLigandZapEnergy() -> float

      Returns the ``unboundLigandZapEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the grid energy of the
      unbound ligand obtained from a Zap calculation.

   .. oe:method:: GetUnboundProteinArea

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetUnboundProteinArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundProteinArea() -> float

      Returns the ``unboundProteinArea`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the solvent accessible
      surface area of the unbound protein.

   .. oe:method:: GetUnboundProteinAreaEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetUnboundProteinAreaEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundProteinAreaEnergy() -> float

      Returns the ``unboundProteinAreaEnergy`` variable shown in
      the :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the energy of the
      solvent accessible surface area of the unbound protein.

   .. oe:method:: GetUnboundProteinZapEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetUnboundProteinZapEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundProteinZapEnergy() -> float

      Returns the ``unboundProteinZapEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the grid energy of the
      unbound protein obtained from a Zap calculation.

   .. oe:method:: GetZapEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetZapEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetZapEnergy() -> float

      Returns the difference in grid energy between the complex and
      the unbound ligand and protein.  This is equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetComplexZapEnergy` -
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundProteinZapEnergy`
      -
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundLigandZapEnergy`.

   .. oe:method:: Print

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Print(OEPlatform::oeostream& ofs) const
            void Print(OESystem::OEErrorHandler& log) const

      .. oe:language:: python

         .. oe:api:: python

            Print(ofs: oeostream) -> None
            Print(log: OEErrorHandler) -> None

      Prints out all of the available data to the oeostream of the OEErrorHandle passed in.


.. oe:namespace:: OEPB

.. meta::
   :keywords: OEZap, Zap

.. _OEPB_OEZap:

.. oe:class:: OEZap

   .. oe:api::

      class OEZap

   The principal interface for Poisson-Boltzmann electrostatics calculations.
   Stores a molecule and computes solvation energies, potential grids, and
   atomic potentials using an implicit solvent model. See
   :oe:meth:`OEPB::OEZap::SetMolecule` for molecule preparation requirements.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEZap()
            OEZap(const OEZap& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEZap() -> OEZap
            OEZap(rhs: OEZap) -> OEZap

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEZap &operator=(const OEZap &rhs)

      Assignment operator.

   .. oe:method:: CalcAtomPotentials

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CalcAtomPotentials(float* pot, bool no_grid = false)

      .. oe:language:: python

         .. oe:api:: python

            CalcAtomPotentials(pot: OEFloatArray, no_grid: bool = False) -> bool

      Calculates the atom potentials and fills the ``float`` array
      with their values.  The ``float`` array should be of length
      ``N``, where ``N`` is the number of atoms.

   .. oe:method:: CalcForces

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CalcForces(float* forces)

      .. oe:language:: python

         .. oe:api:: python

            CalcForces(forces: OEFloatArray) -> bool

      Calculates the forces on the atoms and fills the ``float``
      array with the values of their x, y, and z components.  The
      ``float`` array should be of length ``3N``, where ``N``
      is the number of atoms.

   .. oe:method:: CalcPotentialGrid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool CalcPotentialGrid(OESystem::OEScalarGrid& grid)

      .. oe:language:: python

         .. oe:api:: python

            CalcPotentialGrid(grid: OEScalarGrid) -> bool

      Calculates the potential grid and updates the ``OEScalarGrid``
      with the values. The calculated electrostatic potential is
      a dimensionless value defined as eV/kT where eV is the electric work,
      in kcal/mol, of bringing an electron charge to the point with
      potential V, and kT = 0.59 kcal/mol (value of kT at room temperature).

   .. oe:method:: CalcSolvationEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            float CalcSolvationEnergy()

      .. oe:language:: python

         .. oe:api:: python

            CalcSolvationEnergy() -> float

      Returns the solvation energy in kT of the molecule that has been set.
      This result does not include an area term.

   .. oe:method:: ClearFocusTarget

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearFocusTarget()

      .. oe:language:: python

         .. oe:api:: python

            ClearFocusTarget() -> None

      Clears the target setting for focusing.

   .. oe:method:: GetBoundarySpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetBoundarySpacing() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundarySpacing() -> float

      Returns the boundary spacing setting, which is the amount of
      distance between the molecule and the edge of the grid.  The
      default setting is 4.0.

   .. oe:method:: GetDielectricModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetDielectricModel() const

      .. oe:language:: python

         .. oe:api:: python

            GetDielectricModel() -> int

      Returns an ``int`` representing the dielectric model being
      used.  The two available models are
      :oe:const:`OEPB::OEZapDielectricModel::Gaussian` and
      :oe:const:`OEPB::OEZapDielectricModel::Molecular`.

   .. oe:method:: GetError

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetError() const

      .. oe:language:: python

         .. oe:api:: python

            GetError() -> float

      Returns the error setting.  See :oe:meth:`OEPB::OEZap::SetError`.

   .. oe:method:: GetFocusTarget

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase* GetFocusTarget() const

      .. oe:language:: python

         .. oe:api:: python

            GetFocusTarget() -> OEGraphMol

      Returns a pointer to the molecule that has been set as the focus target.

   .. oe:method:: GetGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetGridSpacing() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridSpacing() -> float

      Returns the setting for the grid spacing.  The default value is 0.5.

   .. oe:method:: GetInnerDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetInnerDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetInnerDielectric() -> float

      Returns the setting for the internal dielectric constant.  The default value is 1.0.

   .. oe:method:: GetIterations

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetIterations() const

      .. oe:language:: python

         .. oe:api:: python

            GetIterations() -> int

      Returns the maximum number of iterations allowed for the zap
      calculation. The default value is 10.

   .. oe:method:: GetMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMolBase* GetMolecule() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolecule() -> OEGraphMol

      Returns a pointer to the molecule that has been set to Zap.

   .. oe:method:: GetOuterDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetOuterDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetOuterDielectric() -> float

      Returns the setting for the outer dielectric constant.  The default value is 80.0.

   .. oe:method:: GetProbeRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetProbeRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetProbeRadius() -> float

      Returns the setting for the probe radius.  The default value is 1.4.

   .. oe:method:: GetVerbose

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetVerbose() const

      .. oe:language:: python

         .. oe:api:: python

            GetVerbose() -> bool

      Returns the setting for very low-level verbosity.  The default value is false.

   .. oe:method:: GetSaltConcentration

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSaltConcentration() const

      .. oe:language:: python

         .. oe:api:: python

            GetSaltConcentration() -> float

      Returns the setting for the salt concentration.  The default value is 0.0.

   .. oe:method:: IsFocusTargetSet

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsFocusTargetSet()

      .. oe:language:: python

         .. oe:api:: python

            IsFocusTargetSet() -> bool

      Returns a ``bool`` for whether the focus target is currently
      set.  See the section of focusing for more information.

   .. oe:method:: SetBoundarySpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBoundarySpacing(float spacing)

      .. oe:language:: python

         .. oe:api:: python

            SetBoundarySpacing(spacing: float) -> bool

      Sets the boundary spacing, which is the amount of distance
      between the molecule and the edge of the grid.  The default
      setting is 4.0.

   .. oe:method:: SetDielectricModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDielectricModel(unsigned int model)

      .. oe:language:: python

         .. oe:api:: python

            SetDielectricModel(model: int) -> bool

      Sets the dielectric model.  The two available models are
      :oe:const:`OEPB::OEZapDielectricModel::Gaussian` and
      :oe:const:`OEPB::OEZapDielectricModel::Molecular`.  The default is the
      Gaussian model.

   .. oe:method:: SetError

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetError(float zaperr)

      .. oe:language:: python

         .. oe:api:: python

            SetError(zaperr: float) -> bool

      Rather than setting the grid spacing, the acceptable error may
      be set instead using this method.  The default value is set to
      0.0, which means that the grid spacing is set explicitly.

   .. oe:method:: SetFocusTarget

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFocusTarget(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            SetFocusTarget(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets the focus target.  See the section of :ref:`section_focusing` for more information.

   .. oe:method:: SetGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetGridSpacing(float spacing)

      .. oe:language:: python

         .. oe:api:: python

            SetGridSpacing(spacing: float) -> bool

      Sets the grid spacing.  The default value is 0.5.

   .. oe:method:: SetInnerDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetInnerDielectric(float epsin)

      .. oe:language:: python

         .. oe:api:: python

            SetInnerDielectric(epsin: float) -> bool

      Sets the internal dielectric constant.  The default value is 1.0.

   .. oe:method:: SetIterations

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIterations(unsigned int iters)

      .. oe:language:: python

         .. oe:api:: python

            SetIterations(iters: int) -> bool

      Sets the maximum number of iterations allowed for the zap
      calculation.  The default value is 10

   .. oe:method:: SetMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMolecule(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            SetMolecule(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets the molecule to Zap.  Partial charges, 3-D coordinates, and
      radii need to be set to the molecule before the molecule is set
      to Zap.

   .. oe:method:: SetOuterDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOuterDielectric(float epsout)

      .. oe:language:: python

         .. oe:api:: python

            SetOuterDielectric(epsout: float) -> bool

      Sets the external dielectric constant.  The default value is 80.0.

   .. oe:method:: SetProbeRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetProbeRadius(float radius)

      .. oe:language:: python

         .. oe:api:: python

            SetProbeRadius(radius: float) -> bool

      Sets the probe radius, the default value is 1.4.

   .. oe:method:: SetSaltConcentration

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSaltConcentration(float conc)

      .. oe:language:: python

         .. oe:api:: python

            SetSaltConcentration(conc: float) -> bool

      Sets the salt concentration.  The default value is 0.0.

   .. oe:method:: SetVerbose

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetVerbose(bool verbose)

      .. oe:language:: python

         .. oe:api:: python

            SetVerbose(verbose: bool)

      Sets very low-level verbosity.  The default value is false.



.. oe:namespace:: OEPB

.. oe:constnamespace:: OEAreaMethod

   This namespace contains constants.

   .. oe:constant:: Undefined
   
   This value represents an unset OEAreaMethod.

   .. oe:constant:: Gaussian
   
   This method uses Gaussians to compute area and is faster and less sensitive to rotation and translation on the grid.

   .. oe:constant:: Discrete
   
   This method uses a hard sphere model to compute area.

   .. oe:constant:: Default
   
   The default is set to Gaussian.



.. _OEPBConstants:

*******************
OEPB Constants
*******************

.. oe:namespace:: OEPB

.. toctree::

   OEAreaMethod
   OEZapDielectricModel


.. oe:namespace:: OEPB

.. oe:constnamespace:: OEZapDielectricModel

   This namespace contains constants.

   .. oe:constant:: Gaussian
   
   This model uses Gaussians to represent atoms and is faster and less sensitive to rotation and translation on the grid.

   .. oe:constant:: Molecular
   
   This model uses hard spheres to represent atoms.

   .. oe:constant:: Default
   
   The default model is Gaussian.


.. # split from OEPBFunctions.rst:7

.. |product|        replace:: Zap TK


.. oe:namespace:: OEPB

.. meta::
   :keywords: OECalculateCoulombicBinding

.. oe:function:: OECalculateCoulombicBinding

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OECalculateCoulombicBinding(const OEChem::OEMolBase& protein,
                                           const OEChem::OEMolBase& ligand,
                                           float dielectric)

   .. oe:language:: python

      .. oe:api:: python

         OECalculateCoulombicBinding(protein: Union[OEGraphMol,OEMol,OEQMol],
                                     ligand: Union[OEGraphMol,OEMol,OEQMol],
                                     dielectric: float) -> float

   Returns the analytic binding energy in kT for the ligand and protein in
   the specified dielectric using Coulomb's Law.
   Both ``protein`` and ``ligand`` must have 3D coordinates and
   partial charges assigned.



.. # split from OEPBFunctions.rst:18

.. |product|        replace:: Zap TK


.. oe:namespace:: OEPB

.. meta::
   :keywords: OECoulombicAtomPotentials

.. oe:function:: OECoulombicAtomPotentials

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECoulombicAtomPotentials(const OEChem::OEMolBase& mol, float D,
                                        float* apot)

   .. oe:language:: python

      .. oe:api:: python

         OECoulombicAtomPotentials(mol: Union[OEGraphMol,OEMol,OEQMol],
                                   D: float, apot: OEFloatArray) -> bool

   Calculates the Coulombic atom potentials with the dielectric
   constant ``D`` and fills the float array ``apot`` with the
   values.  ``apot`` should be of length ``N``, where ``N``
   is the number of atoms.
   The molecule must have 3D coordinates and partial charges assigned.



.. # split from OEPBFunctions.rst:30

.. |product|        replace:: Zap TK


.. oe:namespace:: OEPB

.. meta::
   :keywords: OECoulombicSelfEnergy

.. oe:function:: OECoulombicSelfEnergy

   .. oe:language:: c++ java csharp

      .. oe:api::

         float OECoulombicSelfEnergy(const OEChem::OEMolBase& mol, float D)

   .. oe:language:: python

      .. oe:api:: python

         OECoulombicSelfEnergy(mol: Union[OEGraphMol,OEMol,OEQMol], D: float) -> float

   Returns the integral energy in kT of a molecule from its partial charges
   in universal dielectric ``D`` using Coulomb's Law.
   The molecule must have partial charges assigned.



.. # split from OEPBFunctions.rst:39

.. |product|        replace:: Zap TK


.. oe:namespace:: OEPB

.. meta::
   :keywords: OEMakeETGrid

.. oe:function:: OEMakeETGrid

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeETGrid(OESystem::OEScalarGrid& grid,
                           const OEChem::OEMolBase& mol, const OEET& et)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeETGrid(grid: OEScalarGrid, mol: Union[OEGraphMol,OEMol,OEQMol],
                      et: OEET) -> bool

   Calculates the electrostatic Tanimoto grid for the ``mol``
   passed in and the reference molecule that needs to be already set
   to the :ref:`OEET <OEPB_OEET>` instance.
   Both ``mol`` and the reference molecule set via
   :oe:meth:`OEPB::OEET::SetRefMol` must have 3D coordinates and
   partial charges assigned.



.. # split from OEPBFunctions.rst:50

.. |product|        replace:: Zap TK


.. oe:namespace:: OEPB

.. meta::
   :keywords: OEZapBind

.. oe:function:: OEZapBind

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEZapBind(const OEChem::OEMolBase& protein,
                        const OEChem::OEMolBase& ligand, OEBindResults& results)
         bool OEZapBind(const OEChem::OEMolBase& protein,
                        const OEChem::OEMolBase& ligand,
                        OESimpleBindResults& results)

   .. oe:language:: python

      .. oe:api:: python

         OEZapBind(protein: Union[OEGraphMol,OEMol,OEQMol],
                   ligand: Union[OEGraphMol,OEMol,OEQMol],
                   results: OESimpleBindResults) -> bool
         OEZapBind(protein: Union[OEGraphMol,OEMol,OEQMol],
                   ligand: Union[OEGraphMol,OEMol,OEQMol],
                   results: OEBindResults) -> bool

   Convenience functions for obtaining :ref:`OEBindResults <OEPB_OEBindResults>` or
   :ref:`OESimpleBindResults <OEPB_OESimpleBindResults>` of a ``ligand`` and ``protein``.
   Both ``protein`` and ``ligand`` must have 3D coordinates, partial
   charges, and VDW radii assigned.



.. # split from OEPBFunctions.rst:62

.. |product|        replace:: Zap TK


.. oe:namespace:: OEPB

.. meta::
   :keywords: OEZapGetArch

.. oe:function:: OEZapGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEZapGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEZapGetArch() -> str

   Returns the architecture on which the release was built



.. # split from OEPBFunctions.rst:70

.. |product|        replace:: Zap TK


.. oe:namespace:: OEPB

.. meta::
   :keywords: OEZapGetLicensee

.. oe:function:: OEZapGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEZapGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEZapGetLicensee(licensee: str) -> bool

   Fills the parameter ``string &licensee`` with the licensee of the license file being used



.. # split from OEPBFunctions.rst:78

.. |product|        replace:: Zap TK


.. oe:namespace:: OEPB

.. meta::
   :keywords: OEZapGetPlatform

.. oe:function:: OEZapGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEZapGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEZapGetPlatform() -> str

   Returns the platform on which the release was built



.. # split from OEPBFunctions.rst:86

.. |product|        replace:: Zap TK


.. oe:namespace:: OEPB

.. meta::
   :keywords: OEZapGetRelease

.. oe:function:: OEZapGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEZapGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEZapGetRelease() -> str

   Returns the version number as a ``const char*`` in major.minor.bugfix form



.. # split from OEPBFunctions.rst:94

.. |product|        replace:: Zap TK


.. oe:namespace:: OEPB

.. meta::
   :keywords: OEZapGetSite

.. oe:function:: OEZapGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEZapGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEZapGetSite(site: str) -> bool

   Fills the parameter ``string &licensee`` with the site on the license file being used



.. # split from OEPBFunctions.rst:102

.. |product|        replace:: Zap TK


.. oe:namespace:: OEPB

.. meta::
   :keywords: OEZapGetVersion

.. oe:function:: OEZapGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEZapGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEZapGetVersion() -> int

   Returns the build date of the release



*******************************************************************************
OEPB Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OECalculateCoulombicBinding.rst
   OECoulombicAtomPotentials.rst
   OECoulombicSelfEnergy.rst
   OEMakeETGrid.rst
   OEZapBind.rst
   OEZapGetArch.rst
   OEZapGetLicensee.rst
   OEZapGetPlatform.rst
   OEZapGetRelease.rst
   OEZapGetSite.rst
   OEZapGetVersion.rst



.. _zap_part_api:

********************************
API
********************************

.. toctree::
   :maxdepth: 2

   OEPBClasses/OEPBClasses
   OEPBConstants/OEPBConstants
   OEPBFunctions/index



.. _zap_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version2_5_3
   version2_5_2
   version2_5_1
   version2_5_0
   version2_4_7
   version2_4_6
   version2_4_5
   version2_4_4
   version2_4_3
   version2_4_2
   version2_4_1
   version2_4_0
   version2_3_7
   version2_3_6
   version2_3_5
   version2_3_4
   version2_3_3
   version2_3_2
   version2_3_1
   version2_3_0
   version2_2_7
   version2_2_6
   version2_2_5
   version2_2_4
   version2_2_3
   version2_2_2
   version2_2_1
   version2_2_0
   version2_1_7
   version2_1_6
   version2_1_5
   version2_1_4
   version2_1_3
   version2_1_2
   version2_1_1
   version2_1_0
   version2_0_0



Zap TK 2.5.3
================================================================================

Major Bug Fixes
--------------------------------------------------------------------------------

* Salt concentration implementation in **Zap TK** has been corrected and made robust
  at higher salt concentrations.

* As a result of the salt concentration improvement, the rotational
  variation of Zap solvation energy at high salt concentrations has been
  substantially reduced.



.. _section_zap_releasenotes_200:

Zap TK 2.0.0
================================================================================

New features
--------------------------------------------------------------------------------

*  This is the first official release of the C++ version of Zap TK. Note
   that this is a significant change in the API as we migrate from the
   C API to the new C++ API built on top of OEChem.




.. _section_zap_releasenotes_210:

Zap TK 2.1.0
================================================================================

New features
-------------------------------------------------------------------------------

*  Internal defaults have been changed for the :ref:`OEZap <OEPB_OEZap>` object.
   The internal dielectric now has a default of 1.0, the boundary
   spacing now has a default of 4.0, and the default number of
   iterations has been set to 10.  The change from 2.0 to 1.0 for the
   internal dielectric led to dramatically improved results when we
   performed tests with the Rizzo set, with the RMS error for
   vacuum-water transfer energy decreasing by more than half.  

*  Large manual update with complete examples and API documentation.

*  :oe:meth:`OEPB::OEZap::IsFocusTargetSet` has been added, which returns a
   ``bool`` which indicates whether the focus target has been set.

*  New examples for focusing and forces have been added

*  All examples have been ported across all three languages (C++,
   Java, Python) 

*  Examples assign MMFF94 charges by default

Bug fixes
--------------------------------------------------------------------------------

*  Internal and external dielectrics are now properly reset each time the :ref:`OEBind <OEPB_OEBind>` instance is used.

*  Internal error checking has been added so that no internal
   calculations will be attempted if :oe:meth:`OEPB::OEZap::SetMolecule`
   fails.  (:oe:meth:`OEPB::OEZap::SetMolecule` most often fails
   because all charges are equal to zero.)  Calls to methods that
   would attempt to run internal calculations
   (e.g. :oe:meth:`OEPB::OEZap::CalcSolvationEnergy`) will return zero or false.  

*  Internal summations in :ref:`OEBind <OEPB_OEBind>` use doubles now instead of
   floats for appropriate precision 

*  Charges are properly assigned to both the refmol and fitmol in the calc_et.cpp example.

*  Examples perform error checking when opening files




.. _section_zap_releasenotes_211:

Zap TK 2.1.1
================================================================================

Bug fixes
--------------------------------------------------------------------------------

*  :oe:meth:`OEPB::OEZap::GetMolecule` and
   :oe:meth:`OEPB::OEZap::GetFocusTarget` now return a pointer instead
   of a reference.  This is a breaking change and any code that calls
   these methods will have to be updated.  These methods will return a
   null pointer if an acceptable molecule has not been set for them.

*  A warning has been added for molecules passed into Zap TK that do
   not return ``3`` when ``GetDimension`` is called.  The dimension
   must be 3 for all molecules passed into Zap TK.  The dimension is
   set automatically when using ``OEReadMolecule`` but a warning will
   be thrown and the molecule will not be accepted by Zap TK if the
   molecule has been made from scratch in the toolkits and
   ``SetDimension(3)`` has not been called on it.

Minor bug fixes
--------------------------------------------------------------------------------

*  Fixed a memory bug related to extremely large files on Windows.




.. _section_zap_releasenotes_212:

Zap TK 2.1.2
================================================================================

New features
--------------------------------------------------------------------------------

*  Added new methods :oe:meth:`OEPB::OEZap::GetVerbose` and :oe:meth:`OEPB::OEZap::SetVerbose` to enable Zap to print out an abundance of low-level information.

Bug fixes
--------------------------------------------------------------------------------

*  Fixed memory leak that occurred with multiple calls to :oe:meth:`OEPB::OEArea::GetArea` 

.. oe:language:: python
   
   * :oe:func:`OEPB::OEMakeETGrid` now properly wrapped in Python. 

.. oe:language:: java
   
   * :oe:func:`OEPB::OEMakeETGrid` now properly wrapped in Java. 



.. _section_zap_releasenotes_213:

Zap TK 2.1.3
================================================================================

* Internal build system improvements. 




.. _section_zap_releasenotes_214:

Zap TK 2.1.4
================================================================================

* Internal build system improvements. 




.. _section_zap_releasenotes_215:

Zap TK 2.1.5
================================================================================

Documentation fixes
--------------------------------------------------------------------------------

* The documentation has been updated to clarify that energies are reported in units of kT unless otherwise specified.

* A documentation mistake in :oe:meth:`OEPB::OESimpleBindResults::GetUnboundLigandZapEnergy` has been fixed.




.. _section_zap_releasenotes_216:

Zap TK 2.1.6
================================================================================

New features
--------------------------------------------------------------------------------

* :oe:meth:`OEPB::OEET::GetInnerDielectric` and :oe:meth:`OEPB::OEET::SetInnerDielectric`
  have been added to allow custom inner dielectric settings.

Minor bug fixes
--------------------------------------------------------------------------------

* Warnings for missing coordinates and missing charges has been separated for better warning messages.

Documentation fixes
--------------------------------------------------------------------------------

* Documentation has been updated to specify units of kT.




.. _section_zap_releasenotes_217:

Zap TK 2.1.7
================================================================================

* Minor internal improvements.



.. _section_zap_releasenotes_220:

Zap TK 2.2.0
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Removed unbounded stack allocations. 

* :oe:meth:`OEPB::OEZap::SetIterations` and
  :oe:meth:`OEPB::OEZap::GetIterations` now deal with ``unsigned int``
  instead of ``int``.




.. _section_zap_releasenotes_221:

Zap TK 2.2.1
================================================================================

Major Bug Fixes
--------------------------------------------------------------------------------

* Potential buffer overrun that could cause crashes fixed. 

Documentation fixes
--------------------------------------------------------------------------------

.. oe:language:: c++

   * C++ code snippets previously only available in the documentation
     are now provided in the distribution directory
     openeye/toolkits/examples/zap-docs.

.. oe:language:: python

   * The Python documentation no longer contains C++ code
     snippets. Those snippets have been ported to Python and included
     in the distribution.

.. oe:language:: java
   
   * The Java documentation no longer contains C++ code.

.. oe:language:: csharp
   
   * The C# documentation no longer contains C++ code. 




.. _section_zap_releasenotes_222:

Zap TK 2.2.2
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* Internal refactoring has been performed to improve stability. 

Documentation fixes
--------------------------------------------------------------------------------

* Cross-references have been fixed. 


Zap TK 2.2.3
================================================================================

Documentation fixes
--------------------------------------------------------------------------------

* New Java and C# snippets have been added to the documentation.




Zap TK 2.2.4
================================================================================

* Minor internal improvements have been made.


Zap TK 2.2.5
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* A serious memory leak in **Zap TK** was discovered and has been fixed.
  The leak was introduced in the 2015.Jun toolkit release and affected **Zap TK** 
  and its dependent toolkits (e.g., **Szmap TK**).


Zap TK 2.2.6
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* A single atom identified as 3D but centered at the origin previously
  returned an incorrect warning about 3D coordinates being required. The internal
  coordinate checking has been overhauled to validate the input coordinates more
  systematically.  Accordingly, the dimensionality of the input molecule
  must now be explicitly set to 3D.

Documentation changes
--------------------------------------------------------------------------------

* The example :ref:`Calculating potential grid with optional parameters<calculating_grid_with_params_3>`
  is now  synchronized for all supported languages.


Zap TK 2.2.7
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* A bug that resulted in a crash when attempting to use the 
  :oe:const:`OEPB::OEZapDielectricModel::Molecular` model on Windows
  has been fixed.


Zap TK 2.3.0
================================================================================

* Minor internal improvements have been made.


Zap TK 2.3.1
================================================================================

* Minor internal improvements have been made.


Zap TK 2.3.2
================================================================================

* Minor internal improvements have been made.


Zap TK 2.3.3
================================================================================

* Minor internal improvements have been made.


Zap TK 2.3.4
================================================================================

* Minor internal improvements have been made.


Zap TK 2.3.5
================================================================================

* Minor internal improvements have been made.


Zap TK 2.3.6
================================================================================

Python-specific changes
--------------------------------------------------------------------------------

* The runtime error that occurred when using :oe:meth:`OEPB::OEMakeETGrid`
  in Python has been fixed.




Zap TK 2.3.7
================================================================================

* Minor internal improvements have been made.





Zap TK 2.4.0
================================================================================

* Minor internal improvements have been made.



Zap TK 2.4.1
================================================================================

*July 2021*

Minor internal improvements have been made.


Zap TK 2.4.2
================================================================================

*Fall 2021*

* Minor internal improvements have been made.





Zap TK 2.4.3
================================================================================

* Minor internal improvements have been made.



===============
Zap TK 2.4.4
===============

Minor internal improvements have been made.





Zap TK 2.4.5
================================================================================

Minor internal improvements have been made.




Zap TK 2.4.6
================================================================================

New features
--------------------------------------------------------------------------------

* New overloads of :ref:`GetArea <OEPB_OEArea_GetArea>` have been added that return solvent
  accessible surface areas for specific residues.





Zap TK 2.4.7
================================================================================

Minor internal improvements have been made.

.. Author: Kristi Carlson <kcarlson@eyesopen.com>
.. ================================================================================
.. commit 114f4499f82210c5adcf642dad8522e7f803faf3
.. Author: Kristi Carlson <kcarlson@eyesopen.com>
.. Date:   Tue Feb 20 09:12:45 2024 -0700
.. 
..     Setting the version number to 2.4.7.a.1
.. 
.. CMakeLists.txt





Zap TK 2.5.0
================================================================================

Minor internal improvements have been made.



Zap TK 2.5.1
================================================================================

Minor internal improvements have been made.




Zap TK 2.5.2
================================================================================

Minor internal improvements have been made.


###############################################
Appendix: Additional Examples in Python
###############################################

Zap programming examples are dispersed among the descriptions
of parts of the toolkits and in the overall chapter :ref:`The Way of Zap <chapter_thewayofzap>`.  Full listings are
provided here for examples that are presented as incomplete snippets in the Zap chapter.

..  _listing-OEBind.py:

..  oe:source:: OEBind.py
    :language: python
    :caption:  OEBind.py full listing.
    :refnum: 1

..  _listing-OEArea_GetArea.py:

..  oe:source:: OEArea_GetArea.py
    :language: python
    :caption:  OEArea_GetArea.py full listing.
    :refnum: 2

..  _listing-DelPhiFlavor.py:

.. oe:source:: DelPhiFlavor.py
   :language: python
   :caption:  DelPhiFlavor.py full listing.
   :refnum: 3



.. _chapter_thewayofzap:

*****************************
The Way of Zap
*****************************

There  follow a dozen or so examples of using ZAP. The list is always
growing  because  the toolkit philosophy really does work. Most of the
examples  use  OEInterface to provide consistent command-line argument
handling.

.. _section_partialchargesandatomicaradii:

Partial Charges and Atomic Radii
============================================================================

There are three essential quantities for any PB calculation: coordinates,
dielectric model (including radii), and charge. Coordinates will come from
the atomic coordinates of the input molecule, but partial charges and the
dielectric model deserve some extra attention.

Charges and radii can be calculated at run-time using functions provided by
OEChem or other OpenEye toolkits (AM1-BCC charges from **Quacpac TK** for example).
The dielectric model consists of both the value of the inner and outer
dielectric, as well as how the dielectric adjusts from one to the other. ZAP
uses atomic radii as the basis for its dielectric algorithm. By default, we
recommend using Bondi VdW radii which can be set on a molecule using the
function  OEAssignBondiVdWRadii   Or  you can set specific radii on an
atom-by-atom basis using the OEAtomBase::SetRadius function.

The current recommended value for the inner and outer dielectrics for a
molecule in an aqueous solution are 1.0 and 80.0. Therefore, these are the
default values for the OEZap and OEBind implementations. The historic value
for  the  inner dielectric is 2.0, and this value may be set using the
SetInnerDielectric method. Additionally, the default value for the inner
dielectric of the OEET implementation remains at 2.0 for the time being.

Accurate PB calculations also depend on quality atomic charges. In OEChem,
we provide MMFF94 partial charges as the lowest level of charges that we
consider usable in PB. The examples that follow will use these charges, so
that  they don't depend on any toolkits beside ZAP and OEChem. But for
production use, we recommend AM1-BCC charges

If your input file format can store partial charges and/or radii, you can
use those values instead of calculating them at run time. OEB files can
store radii and partial charges, so they serve as a useful intermediate file
between many OpenEye programs. Note that charges and radii will only be
written to an OEB file if they are present on the molecule when written.

Atomic charges can come in a PDB file, along with atomic radii, in the form
of the extra fields added after the coordinates. This style originated with
DelPhi. Note that to get OEChem to read charges and radii from these fields
in a PDB file, you need to set a specific flavor on the input oemolistream
before reading any molecules from the stream.

.. oe:source:: DelPhiFlavor.cpp
   :language: c++
   :noindent:
   :frag:     SNIPPET-DelPhiFlavor
   :caption:  Example of using OEChem to read charges and radii from PDB

.. oe:source:: DelPhiFlavor.py
   :language: python
   :noindent:
   :frag:     SNIPPET-DelPhiFlavor
   :caption:  Example of using OEChem to read charges and radii from PDB

.. oe:language:: python

    :ref:`Full listing. <listing-OEBind.py>`

.. oe:source:: DelPhiFlavor.java
   :language: java
   :noindent:
   :frag:     SNIPPET-DelPhiFlavor
   :caption:  Example of using OEChem to read charges and radii from PDB

.. oe:source:: DelPhiFlavor.cs
   :language: csharp
   :noindent:
   :frag:     SNIPPET-DelPhiFlavor
   :caption:  Example of using OEChem to read charges and radii from PDB

.. _section_getagrid:

Grids
============================================================================

ZAP uses regular cubic lattices, or grids, to solve the PB
equation. The examples here illustrate how to retrieve such from the
calculation and to manipulate and store the information held by
each. Typically, grids are not used per se but information is
extracted, such as the potential at particular points in space, as is
illustrated in the next section. However, some programs, such as VIDA,
can read grids and display their properties.  Also, having direct
access to grids allows for manipulations of the potential map that may
not have been anticipated.

This first example shows the simplest method of generating a grid of
potentials using ZAP. We save the grid in OpenEye GRD (\*.grd) format
which is a compact, binary format that can be visualized in
VIDA. Alternatively, the grid can be written into GRASP format
(\*.phi), which means that the grid stored will be 65 cubed
regardless of the size of the grid used in the calculation. A
:math:`65^3` grid is obtained by interpolation to a grid with that
many points that fits over the largest dimension of the grid
calculated.

.. oe:source:: zap_grid1.cpp
   :language: c++
   :caption:  Calculating a potential grid
   :refnum:   1

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_grid1.cpp <../../../../sublibs/tklibs/zap/examples/zap_grid1.cpp>`

.. oe:source:: zap_grid1.py
   :language: python
   :caption:  Calculating a potential grid
   :refnum:   1

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_grid1.py <../../../../wrappers/python/examples/zap/zap_grid1.py>`

.. oe:source:: ZapGrid1.java
   :language: java 
   :caption:  Calculating a potential grid
   :refnum:   1

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapGrid1.java <../../../../wrappers/java/examples/openeye/examples/oezap/ZapGrid1.java>`

.. oe:source:: ZapGrid1.cs
   :language: csharp
   :caption:  Calculating a potential grid
   :refnum:   1

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapGrid1.cs <../../../../wrappers/csharp/Csharp-Examples/OEZap/ZapGrid1.cs>`

The next example is an elaboration of the previous simple version where we
add in control of the parameters of the calculation. Options are provided to
set the internal and external (solute and solvent) dielectric constants, the
distance between the molecule and the edges of the grid (boundary spacing or
buffer) and the grid spacing. A smaller grid spacing implies a more dense
and accurate grid, but it does come with a larger memory footprint.

.. oe:source:: zap_grid2.cpp
   :language: c++
   :caption:  Calculating potential grid with optional parameters
   :refnum:   2

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_grid2.cpp <../../../../sublibs/tklibs/zap/examples/zap_grid2.cpp>`

.. oe:source:: zap_grid2.py
   :language: python
   :caption:  Calculating potential grid with optional parameters
   :refnum:   2

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_grid2.py <../../../../wrappers/python/examples/zap/zap_grid2.py>`

.. oe:source:: ZapGrid2.java
   :language: java 
   :caption:  Calculating potential grid with optional parameters
   :refnum:   2

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapGrid2.java <../../../../wrappers/java/examples/openeye/examples/oezap/ZapGrid2.java>`

.. oe:source:: ZapGrid2.cs
   :language: csharp
   :caption:  Calculating potential grid with optional parameters
   :refnum:   2

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapGrid2.cs <../../../../wrappers/csharp/Csharp-Examples/OEZap/ZapGrid2.cs>`

Here we show how to calculate a difference-map, that is to say the potential
difference between a standard, two dielectric, calculation and a single
dielectric calculation (approximating pure Coulombic potentials). These
difference potentials represent the electrostatic response of the solvent to
the charges within the solute molecule. If we mask away everything outside
the molecule, we can see the contributions from the charges inside the
molecule.

.. _calculating_grid_with_params_3:

.. oe:source:: zap_grid3.cpp
   :language: c++
   :caption:  Calculating potential grid with optional parameters
   :refnum:   3

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_grid3.cpp <../../../../sublibs/tklibs/zap/examples/zap_grid3.cpp>`

.. oe:source:: zap_grid3.py
   :language: python
   :caption:  Calculating potential grid with optional parameters
   :refnum:   3

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_grid3.py <../../../../wrappers/python/examples/zap/zap_grid3.py>`

.. oe:source:: ZapGrid3.java
   :language: java 
   :caption:  Calculating potential grid with optional parameters
   :refnum:   3

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_grid3.java <../../../../wrappers/java/examples/openeye/examples/oezap/ZapGrid3.java>`

.. oe:source:: ZapGrid3.cs
   :language: csharp
   :caption:  Calculating potential grid with optional parameters
   :refnum:   3

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_grid3.cs <../../../../wrappers/csharp/Csharp-Examples/OEZap/ZapGrid3.cs>`

.. _section-atom-potentials:

Atom Potentials
================================================================================

The potentials at any charge, as calculated by PB, can be decomposed into
three forms

#. Induced solvent potential: the potential produced by the polarization
   of the solvent.
#. Inter-charge Coulombic energy: the potential that would be produced
   if the solvent had the same dielectric as the solute molecule from
   all other charges.
#. Self potential: the potential produced by a charge at itself. Of
   course, as mentioned above, this is infinite analytically, but PB
   will produce an "approximation" to this infinity because the grid
   spacing is finite.

This example program shows how to calculate each of these quantities. In
addition to command line flags to control dielectric, grid spacing, etc.,
there are three flags that affect the type of potentials calculated:

*  -calc_type solvent_only
*  -calc_type remove_self
*  -calc_type coulombic

With  none  of these flags, the code executes a single PB calculation,
interpolates the potentials from the grid produced, reports the sum of these
potentials multiplied by the charge on the respective atoms and outputs
these potentials and charges in a table. This potential corresponds to
(a)+(b)+(b) above.

Using the -calc_type solvent_only option executes two PB calculations, the
standard calculation plus a second calculation where the external dielectric
has been set to the solute dielectric. The atom potentials are then formed
from  the difference of these two calculations such that the remaining
potential is that produced by the solvent alone. The sum of this set of
atomic potentials multiplied by atomic charges all multiplied by 0.5 is the
electrostatic component of transferring from a media of the same dielectric
as the solute to water. These potentials correspond to (a) above.

The -calc_type remove_self flag for the example program below executes an
internal algorithm in the ZAP toolkit that extracts from each atom potential
that potential produced by that atom, if it is charged. This it removes the
artifactual energy from the grid, i.e. energy that is not actually physical
but  a  manifestation  of the finite resolution of the grids used. The
remaining potential is then that from the solvent and that from all the
other charges, that is (a)+(b) above.

The -calc_type coulombic flag actually prevents any PB calculation. It
merely uses Coulomb's Law to calculate the potential (b), the inner-atomic
Coulombic potential.

.. oe:source:: zap_atompot.cpp
   :language: c++
   :caption:  Calculating atom potentials
   :refnum:   4

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_atompot.cpp <../../../../sublibs/tklibs/zap/examples/zap_atompot.cpp>`

.. oe:source:: zap_atompot.py
   :language: python
   :caption:  Calculating atom potentials
   :refnum:   4

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_atompot.py <../../../../wrappers/python/examples/zap/zap_atompot.py>`

.. oe:source:: ZapAtoms1.java
   :language: java 
   :caption:  Calculating atom potentials
   :refnum:   4

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapAtoms1.java <../../../../wrappers/java/examples/openeye/examples/oezap/ZapAtoms1.java>`

.. oe:source:: ZapAtoms1.cs
   :language: csharp
   :caption:  Calculating atom potentials
   :refnum:   4

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapAtoms1.cs <../../../../wrappers/csharp/Csharp-Examples/OEZap/ZapAtoms1.cs>`

.. _section_solvation-energies:

Solvation Energies: PBSA
================================================================================

A principle use of PB is to calculate the energy stored in the exterior
dielectric,  for  example the partial alignment of water dipoles. This
corresponds to the difference between a calculation with uniform dielectric
and one with a different external dielectric. In the examples for atom
potentials this would be the sum of the solvent potentials at each atom,
multiplied by the charges on that atom all multiplied by 0.5.

However, we know water also has an energy component due to hydrophobicity,
which is typically estimated as a constant (approximately 10-25 calories per
square Angstrom) multiplied by the accessible area of the molecule. This
value is an open scientific question. We recommend using 10 for vacuum-water
transfer energies and 25 for protein calculations, but ultimately your own
scientific  judgment  should  be used. These examples include an area
calculation.  Taken together these numbers are an approximation of the
transfer  energy from a low dielectric medium (alkane solvent, protein
interior) into water.

The following examples use the OEArea object to calculate the accessible
surface area of the molecule. The area is calculated using the same grid
based Gaussians that ZAP uses. Therefore, it will not give the same results
as triangle summation methods for calculating surface area, which are used
in OESpicoli.

.. oe:source:: zap_solv1.cpp
   :language: c++
   :caption:  Calculating solvation energies
   :refnum:   5

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_solv1.cpp <../../../../sublibs/tklibs/zap/examples/zap_solv1.cpp>`

.. oe:source:: zap_solv1.py
   :language: python
   :caption:  Calculating solvation energies
   :refnum:   5

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_solv1.py <../../../../wrappers/python/examples/zap/zap_solv1.py>`

.. oe:source:: ZapSolv1.java
   :language: java 
   :caption:  Calculating solvation energies
   :refnum:   5

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapSolv1.java <../../../../wrappers/java/examples/openeye/examples/oezap/ZapSolv1.java>`

.. oe:source:: ZapSolv1.cs
   :language: csharp
   :caption:  Calculating solvation energies
   :refnum:   5

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapSolv1.cs <../../../../wrappers/csharp/Csharp-Examples/OEZap/ZapSolv1.cs>`

This next solvation example calculates the transfer energy from vacuum to
water.

.. oe:source:: transfer.cpp
   :language: c++
   :caption:  Calculating vacuum-water transfer energies
   :refnum:   6

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`transfer.cpp <../../../../sublibs/tklibs/zap/examples/transfer.cpp>`

.. oe:source:: transfer.py
   :language: python
   :caption:  Calculating vacuum-water transfer energies
   :refnum:   6

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`transfer.py <../../../../wrappers/python/examples/zap/transfer.py>`

.. oe:source:: ZapTransfer.java
   :language: java
   :caption:  Calculating vacuum-water transfer energies
   :refnum:   6

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapTransfer.java <../../../../wrappers/java/examples/openeye/examples/oezap/ZapTransfer.java>`

.. oe:source:: ZapTransfer.cs
   :language: csharp
   :caption:  Calculating vacuum-water transfer energies
   :refnum:   6

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapTransfer.cs <../../../../wrappers/csharp/Csharp-Examples/OEZap/ZapTransfer.cs>`

.. _section_bindingenergies:

Binding Energies
================================================================================

Binding energies and other binding related properties can be
calculated using the :ref:`OEBind <OEPB_OEBind>` class. The OEBind
class serves two primary purposes: 1) to have a class in place for
users to easily calculate binding related data, and 2) to show how
binding related data may be calculated. OEBind is not particularly
well-suited for extremely efficient calculations required by
simulations. This is because some of the data available from OEBind
may be considered uninteresting for the project and there is no need
to spend time calculating it, or because OEBind calculates the unbound
protein and ligand properties every time, which is unnecessary if the
same protein and ligand appear in multiple calculations. The API
section for OEBind is detailed with regard to implementation, so the
user can see how to create their own class or set of function calls if
needed.

There are two classes that store the results of a binding calculation,
:ref:`OEBindResults <OEPB_OEBindResults>` and :ref:`OESimpleBindResults <OEPB_OESimpleBindResults>`. OEBindResults is a superset of
OESimpleBindResults. For an in-depth understanding of what is
calculated, the electrostatics portion of the algorithm for the
SimpleBind function is shown in the API section.

The following is a sample program for using the OEBind class that is
provided in the distribution.

.. oe:source:: bind.cpp
   :language: c++
   :caption:  Bind example
   :refnum:   7

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`bind.cpp <../../../../sublibs/tklibs/zap/examples/bind.cpp>`

.. oe:source:: bind.py
   :language: python
   :caption:  Bind example
   :refnum:   7

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`bind.py <../../../../wrappers/python/examples/zap/bind.py>`

.. oe:source:: ZapBind.java
   :language: java
   :caption:  Bind example
   :refnum:   7

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapBind.java <../../../../wrappers/java/examples/openeye/examples/oezap/ZapBind.java>`

.. oe:source:: ZapBind.cs
   :language: csharp
   :caption:  Bind example
   :refnum:   7

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapBind.java <../../../../wrappers/java/examples/openeye/examples/oezap/ZapBind.java>`

.. _section_focusing:

Focusing
================================================================================
Focusing is a way to achieve the desired precision around a target (such as
a  ligand) while maintaining reasonable time and memory limits for the
calculation. The target for focusing is set using the :oe:meth:`OEPB::OEZap::SetFocusTarget`
method.

For a typical ZAP electrostatics calculation, a consistent grid spacing is
used for the entire system, where the default value is 0.5 Angstroms but it
may be set to a custom value using :oe:meth:`OEPB::OEZap::SetGridSpacing`. This method is entirely
appropriate for certain calculations, such as solvation energy calculations
for small molecules. For other types of calculations, such as a binding
energy calculation for a protein and ligand, a consistent grid spacing may
cause the calculation to be either prohibitively expensive or insufficiently
precise around the binding area.

Focusing  alleviates this problem by using a fine grid for the target
volume, and coarser grids away from the target. The grid spacing setting for
ZAP is applied to the target volume, and the grid spacing is doubled for
each addition coarse grid surrounding the target. A quadratic interpolation
is used for the grid intersections. The implementation of the bind uses the
SetFocusTarget() method to set the ligand as the target for focusing.

The following example program computes the binding energy of a protein and
ligand  twice,  once without focusing and once with the ligand as the
focusing target. The values of the binding energy and the time it took to
calculate them are displayed. For a focused atom potential calculation, the
full electrostatics for the protein and complex would each be computed with
multiple electrostatics calculations. The first calculation would create the
potential grid for the target volume with a grid spacing of 0.5 (assuming
the default spacing is being used). An additional calculation with a grid
spacing of 1.0 would be done on a larger volume volume, and then additional
calculations with grid spacings of 2.0, 4.0, and so on would be done until
the grid is large enough to contain the entire volume of the system.

.. oe:source:: zap_focussing.cpp
   :language: c++
   :caption:  Focusing example
   :refnum:   8

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_focussing.cpp <../../../../sublibs/tklibs/zap/examples/zap_focussing.cpp>`

.. oe:source:: zap_focussing.py
   :language: python
   :caption:  Focusing example
   :refnum:   8

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_focussing.py <../../../../wrappers/python/examples/zap/zap_focussing.py>`

.. oe:source:: ZapFocussing.java
   :language: java
   :caption:  Focusing example
   :refnum:   8

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapFocussing.java <../../../../wrappers/java/examples/openeye/examples/oezap/ZapFocussing.java>`

.. oe:source:: ZapFocussing.cs
   :language: csharp
   :caption:  Focusing example
   :refnum:   8

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapFocussing.cs <../../../../wrappers/csharp/Csharp-Examples/OEZap/ZapFocussing.cs>`

.. _section-zap-gradients-forces:

Gradients/Forces
================================================================================
The solvent forces acting on the atoms in a molecule may be calculated using
the :oe:meth:`OEPB::OEZap::CalcForces` method. The components of the forces are set to a float array
of length 3N, where N is the number of atoms. The components of the gradient
are equal in magnitude to the force, but have the opposite sign.

.. oe:source:: zap_forces.cpp
   :language: c++
   :caption:  Calculating solvation forces
   :refnum:   9

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_forces.cpp <../../../../sublibs/tklibs/zap/examples/zap_forces.cpp>`

.. oe:source:: zap_forces.py
   :language: python
   :caption:  Calculating solvation forces
   :refnum:   9

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`zap_forces.py <../../../../wrappers/python/examples/zap/zap_forces.py>`

.. oe:source:: ZapForces.java
   :language: java
   :caption:  Calculating solvation forces
   :refnum:   9

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapForces.java <../../../../wrappers/java/examples/openeye/examples/oezap/ZapForces.java>`

.. oe:source:: ZapForces.cs
   :language: csharp
   :caption:  Calculating solvation forces
   :refnum:   9

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ZapForces.cs <../../../../wrappers/csharp/Csharp-Examples/OEZap/ZapForces.cs>`

.. _section-electrostatic-similarity:

Electrostatic Similarity
================================================================================

Electrostatic  similarity  may be calculated using the :ref:`OEET <OEPB_OEET>` class. The
following example program shows how to obtain the electrostatic Tanimoto
between  a  reference molecule and a trial molecule. The electrostatic
Tanimoto is affected by the partial charges of the molecules as well as
the three-dimensional structure, including the tautomer state, spacial
orientation, and conformation. In the example program shown below, MMFF
charges are assigned to the molecules, but it is assumed that they have
already been spatially aligned.

.. oe:source:: calc_et.cpp
   :language: c++
   :caption:  Calculating electrostatic tanimoto
   :refnum:   10

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`calc_et.cpp <../../../../sublibs/tklibs/zap/examples/calc_et.cpp>`

.. oe:source:: calc_et.py
   :language: python
   :caption:  Calculating electrostatic tanimoto
   :refnum:   10

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`calc_et.py <../../../../wrappers/python/examples/zap/calc_et.py>`

.. oe:source:: CalcET.java
   :language: java
   :caption:  Calculating electrostatic tanimoto
   :refnum:   10

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CalcET.java <../../../../wrappers/java/examples/openeye/examples/oezap/CalcET.java>`

.. oe:source:: CalcET.cs
   :language: csharp
   :caption:  Calculating electrostatic tanimoto
   :refnum:   10

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`CalcET.cs <../../../../wrappers/csharp/Csharp-Examples/OEZap/CalcET.cs>`



.. _chapter_thewhyofzap:

********************************************************************************
The Why of Zap
********************************************************************************

ZAP happened by surprise. It had always been at the back of my mind that
Something Should Be Done About DelPhi, the program written at Columbia
University in the lab of Barry Honig by Barry, Kim Sharp, Mike Gilson,
Shridhara Shridharan and me. While a very useful program, it was getting
harder and harder to develop, partly because it was written in FORTRAN (not
that there's anything wrong with that), partly because that's just the way
academic code is. We don't know how to program but we want answers and we
want them now.

ZAP really came about because of Andrew Grant. Andy was in the Scheraga lab
struggling, as most of us do, with the nonlinear PB equation. He left to
join AstraZeneca in 1993 but we kept in contact. In '95, he and Barry Pickup
at  the University of Sheffield published a remarkable paper (J. Comp.
Chem.).  They  reported  the hard-sphere volume of a molecule could be
calculated  to  0.1%  accuracy  by  using atom-centered Gaussians. The
correspondence between a discrete and a smooth, continuous function was
nothing  short  of  remarkable. Since the dielectric approach of PB is
essentially volumetric because molecules are low-dielectric and solvent
high, it occurred to us that this was the bedrock on which to build a new PB
approach. That approach became ZAP.

There were several reasons to be excited about the Gaussian based approach.
A smooth-function dielectric mapped onto a grid has few of the numerical
problems plaguing DelPhi - instability with respect to grid placement,
sensitivity to grid spacing. Also it is an interesting alternative physical
model  to  most  PB  implementations. Typically it is assumed that the
dielectric changes from molecular to solvent "discretely," or infinitely
fast. Why? As there was no experimental information on the variation of
dielectric  it  was  the  simplest assumption and also the simplest to
implement. As is often the way with a successful scientific approach, these
early decisions become ossified over time.

Another ossification is the choice of molecular surface as the dielectric
threshold, as first proposed by BH (J. Phys. Chem). It is not a bad choice.
If a water molecule is excluded from some crevice of a molecule that ought
to  be  reflected  in  a  lower dielectric in the crevice: a molecular
surface-delimited volume reflects this where an atomic surface does not.
There was also a numerical issue. When Mike Gilson first applied DelPhi to
proteins (PROTEINS: Vol 17..), the atomic approach would place grid points
randomly in tiny solvent crevices. Moving the protein relative to the grid
shuffled the grid representation of the protein interior leading to large,
unphysical changes in energy. The molecular surface removed these crevices
unless they were large enough to fit a whole water molecule, in which case a
high dielectric assignment was not unreasonable.

In retrospect, however, the molecular surface is a terrible choice! It's
difficult to calculate and unstable with respect to small displacements of
atoms  or to the choice of a radius for water. And there is always the
question of what dielectric should be assigned to the volume that lies
between the molecular and the atomic surfaces.

The Gaussian approach answers several of the physical objections. First and
foremost, the dielectric varies smoothly from interior to exterior. Although
we made no attempt to correlate this variation with empirical evidence,
choosing instead to match our method to DelPhi energies, the variation of
polarizability over a span of about one Angstrom is physically appealing.
Secondly,  we achieve much of the crevice exclusion that the molecular
surface produces. Because the Gaussian functions spread out beyond the hard
sphere radius of each atom, a crevice receives density contributions from
all neighboring atoms, lowering its dielectric to molecular levels. Thirdly,
we do not see water "pops", those large changes in dielectric from small
atomic displacements (or, worse, small changes of the protein placement on
the grid) that occur in active sites. The Gaussian effectively interpolates
between water absence and presence.

An  advantage  to  this  approach  that  we did not anticipate was its
correspondence to DelPhi when applied to proteins. We parameterized the
dielectric  variation  in  ZAP so that it agrees with DelPhi for small
molecules ("we" meaning Christine Kitchen's heroic work for her Ph.D.
thesis).  Given  that the difference between the molecular surface and
Gaussian model will be much larger for proteins with concavities, crevices
and internal water pockets, we wondered how well the two would agree. The
remarkable finding was that ZAP applied to proteins looks like DelPhi with
twice the polarizability: ZAP with internal dielectric set to 2.0 looks like
DelPhi set to 4.0. Why is this useful? Because there is circumstantial and
theoretical evidence that 4.0 is a good dielectric to use with DelPhi for
proteins, but that always left a loose thread in applying the method to
protein-drug interactions - small molecules should have a dielectric of 2.0,
proteins 4.0, but DelPhi only allows you to choose one internal dielectric.
With ZAP it appears you get the best of both worlds. Protein and drug are
set to internal dielectrics of 2.0 and because the protein is a little more
"hydrated" in ZAP, it acts like the dielectric is set to 4.0. Please note
that while 2.0 is the historic value for the inner dielectric, the current
recommended value for the inner dielectric while using ZAP is 1.0.

On the numerical side, every advantage we had hoped for in ZAP came to pass.
As mentioned in the previous section, we saw faster convergence, remarkable
stability  with respect to grid placement and much improved asymptotic
behavior with decreasing grid spacing. We also, for the first time, had
gradients that could be applied in dynamics or minimization.


####################################
OpenEye Glossary of Terms
####################################

.. for documentation of the glossary directive, see https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#glossary

..  glossary::

    AMI
        An Amazon Machine Image (AMI) is a supported and maintained image provided by AWS that provides the information
        required to launch an instance.

    API
    APIs
        An Application Programming Interface (API) is a process that enables two software applications to communicate with
        each other to exchange data or functionality, using a set of protocols. It functions like an intermediary between
        two applications, much like a waiter is an intermediary between a customer and the restaurant kitchen.

    apo protein
    apo proteins
        An apo protein is just the structure of the protein with no ligand bound. "Apo" simply means the protein
        structure without any ligand and "Holo" stands for the protein-ligand complex.

    asymmetric unit
        The contents of a PDB or mmCIF file from an X-ray contain an
        asymmetric unit (ASU) as the output of the experiment. This is sometimes
        equivalent to the biological unit (BU), but often requires manipulation to create a correct BU.

    AUC
        The area under the curve (AUC) of :term:`ROC curve` is an aggregate measure of
        performance across all possible classification thresholds.
        The AUC value varies between :math:`[0.0 - 1.0]`.
        The model with perfect predictions has an AUC of 1.0 while a model that always gets
        the predictions wrong has an AUC value of 0.0.
        The value 0.5 represents random prediction.
        The AUC number can be interpreted as the probability that the model ranks a random
        positive example more highly than a random negative example. See also
        `Area under the curve <https://en.wikipedia.org/wiki/Receiver_operating_characteristic#Area_under_the_curve>`_
        in Wikipedia and :term:`ROC curve`.

    B-factor
        B-factor (temperature factor) describes the displacement of the atomic
        positions from an average value.
        The more flexible an atom is the larger the displacement
        from the mean position will be (mean-squares displacement).
        The values of the B-factors are normally between 15 to 30 (sq. Ångströms),
        but can be much higher for more flexible regions.
        B-factors can indicate the mobility of atoms and they can also
        indicate where there are errors in model building.

    biological unit
        In short, the biological unit (BU) is an object that contains the biologically relevant parts of an
        ASU, which have not been split into various molecular components and are not yet prepped for modeling. For a more
        detailed explanation of BUs, refer to `Introduction to Biological Assemblies and the PDB Archive <https://pdb101.rcsb.org/learn/guide-to-understanding-pdb-data/biological-assemblies>`_ hosted at the RCSB.

    bug-fix release
        Toolkit and Applications bug-fix releases happen between feature releases, if necessary.
        These releases provide crucial bug fixes but no new features or platform
        updates.

    canonical SMILES
        In OpenEye documentation, the term canonical SMILES is used for a unique SMILES string
        that encodes the connection table of a molecule, but no chiral or
        isotopic information.
        Consequently, two stereoisomers always share the same canonical SMILES, since
        their stereo information are ignored during the canonicalization process.
        For generating a canonical SMILES, use the
        :ref:`OECreateCanSmiString <OECreateCanSmiString>` function. OpenEye's canonical
        SMILES term corresponds to *Daylight*'s  *unique* SMILES definition.

    canonical isomeric SMILES
        In OpenEye documentation, the name :term:`canonical isomeric SMILES` is used for a unique SMILES
        string that also encodes isotopic and stereo information.
        Due to the unambiguity of canonical isomeric SMILES, they can be used as a
        universal identifier for a specific chemical structure.
        For generating a canonical isomeric SMILES, use the
        :ref:`OECreateIsoSmiString <OECreateIsoSmiString>` or the **preferred** high-level
        :ref:`OEMolToSmiles <OEMolToSmiles>` function. OpenEye's canonical isomeric SMILES terminology corresponds to *Daylight*'s
        *absolute* SMILES definition.

    chiral atom
        In OpenEye terminology, an atom is considered chiral if it is connected to four different
        substituent groups, that is, its mirror image is not superimposable.In **OEChem TK**, an easily invertible nitrogen, that is,  a nonplanar nitrogen with one attached
        hydrogen, is not considered to be chiral. This is due to the fact that trivalent
        nitrogen compound undergo rapid inversion that interconvert enantiomers. See also the
        :term:`stereo atom` definition, the SetChiral and IsChiral methods of
        :ref:`OEAtomBase <OEChem_OEAtomBase>`, and the
        :ref:`Atom Chirality <section_stereochemistry_atom>` section.

    chiral bond
        In **OEChem TK**, a double bond is considered chiral if the cis and
        trans forms of this bond represent two distinct isomers.
        A chiral bond can be either a chain bond or a ring bond that does
        not belong to any ring smaller than 8-membered. See also the
        :term:`stereo atom` definition, the SetChiral and IsChiral methods of
        :ref:`OEAtomBase <OEChem_OEAtomBase>`, and the
        :ref:`Atom Chirality <section_stereochemistry_atom>` section.


    CIP
        The CIP (Cahn-Ingold-Prelog) system is rule-based method used in
        organic chemistry to name the stereoisomers of a molecule.
        The CIP system assigns an R or S descriptor to each stereocenter
        and an E or Z descriptor to each double bond so that the
        configuration of the entire molecule can be specified uniquely.

    conformer
    conformers
        Conformation isomers are commonly called conformers. Conformational isomers
        are stereoisomers that differ from one another by rotation around a single bond.
        Conformational isomers can be converted from one to another by rotations about formally single bonds
        without making or breaking any covalent bonds.

    CPK
        CPK (Corey,Pauling,Koltun) is a popular color convention for
        distinguishing atoms of different chemical elements in molecular
        models. See also the :ref:`chapter_element_color` chapter and the
        :ref:`OEAtomColorStyle <OEDepict_OEAtomColorStyle>` namespace.


    CSV
        Comma-separated-values file format.  See also the CSV standard
        at `RFC 4180 <http://tools.ietf.org/html/rfc4180>`_ and the
        :ref:`CSV File Format <section_moltaggeddata_CSV>` section.

    cube
    cubes
        Basic computational components used to construct a
        programmed workflow for execution in Orion.  Cubes communicate
        with one another via messages and transmit data using defined input and output ports.
        Cubes can be written
        in Python, from scratch, using OpenEye APIs. These APIs,
        as well as ready-made cubes for
        general computation tasks, are provided as part of the
        :ref:`Orion Platform package <orion-platform-intro>`.
        Ready-made cubes for scientific computations are available
        in the :ref:`OpenEye Snowball package <snowball-documentation-index>`.

    CUDA
        GPU-enabled calculation.
        CUDA mode involves preloading all fingerprints into GPU memory prior to performing
        similarity calculations. While this represents the fastest way to perform similarity
        searches once the fingerprints are loaded, searches are limited by GPU memory availability
        and will fall back to the :term:`memory-mapped` CPU mode if the entire set of fingerprints
        cannot be preloaded into the GPU memory.

    CXSMILES
        The Chemaxon Extended SMILES format which adds an additional (and optional) appendix to the SMILES string to encode
        a wide variety of additional features that are not part of the SMILES representation proper.
        Only the :term:`canonical SMILES` portion of the CXSMILES information is canonically ordered.   There
        is no specification in the CXSMILES format that any ordering of information within the
        appendix is either expected or required. However, a deterministic sort order is applied to the appendix
        entries to facilitate the potential use of the CXSMILES string for structure duplicate checking
        which would consider different groupings of enhanced stereo groups as structure differentiating. See also
        `CXSMILES documentation <https://docs.chemaxon.com/display/docs/chemaxon-extended-smiles-and-smarts-cxsmiles-and-cxsmarts.md>`_


    design unit
        The design unit (DU) is an object that contains the extracted and prepared parts of a
        single :term:`biological unit` (BU), ready for modeling. The parts include

            #.  protein;
            #.  ligand (not always: an
                apo DU will not contain a ligand);
            #.  site residues;
            #.  packing residues (if any exist near the site); and
            #.  excipients (if any exist near the site).

        One can interact with each part of the DU through APIs. The APIs are listed here :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.

    dock
    docking
        Docking is a molecular modeling technique used to predict the optimal binding of a protein and a ligand. In the drug
        discovery process, structure-based methods such as docking—the lock-and-key concept where the protein is the lock
        and the ligand is the key—use the structure of a target protein to discover hits and optimize leads. Docking is used to identify
        possible active molecules in a large molecule database, by examining their shapes and chemical complementarity to
        the active site.

    excipient
        An  excipient is an inert substance that is formulated with an active drug to produce its
        pharmaceutical dosage form. Excipients serve various roles, such as long-term stabilization, aiding the manufacturing
        process, and enhancing the therapeutic properties of the active drug in its dosage form, such as facilitating
        drug absorption or enhancing solubility.

    FASTA
        In bioinformatics and biochemistry, the FASTA format is a text-based format
        for representing either nucleotide sequences or amino acid (protein) sequences,
        in which nucleotides or amino acids are represented using single-letter codes.


    feature release
        Toolkit and Application feature releases take place in spring and fall.
        These releases  provide support for new platforms and major and minor
        code fixes as well as new features.

    fingerprint
        Fingerprints do not use a predefined pattern dictionary; the encoded
        fragments are enumerated exhaustively.
        Since the number of possible patterns present in molecular structures
        is extremely large, it is impractical to assign a particular bit to
        each unique pattern, as in the case of the :term:`structural key` method.
        Instead, each pattern is subjected to a hashing function that
        logically ORs into the fingerprint.
        The use of hashing inherently results in overlap of some structural
        patterns.

    floe
    floes
        Programmed workflows for execution by the web-based Orion workflow engine.
        Many
        ready-made floes are developed and delivered by OpenEye, for
        execution in the Orion environment.  For documentation of
        ready-made floes and their use, see :ref:`the Orion Suites and Modules Guide <orion-floe-guide-index>`.
        Floes can be developed using
        Orion programming interfaces (APIs) and can use either ready-made
        cubes delivered with OpenEye software or cubes of your own, developed
        with the guidance of :ref:`the Orion Programming Guide <orion_documentation_python>`.

    GRASP
        GRASP is a molecular visualization and analysis program. It is
        particularly useful for the display and manipulation of the
        surfaces of molecules and their electrostatic properties.
        (online:fx.php/Software:GRASP)

    HELM
        The Hierarchical Editing Language for Macromolecules (HELM) notation, a text-based format
        for describing complex biomolecules like peptides, oligonucleotides, and their modifications,
        using simple monomers and operators.
        See also: [Zhang-2012]_

    InChI
        From `About the InChi Standard <http://www.inchi-trust.org/about-the-inchi-standard/>`_,
        Originally developed by the International Union of Pure and Applied Chemistry (IUPAC), the
        IUPAC International Chemical Identifier (:term:`InChI`) is a character string generated by computer algorithm.
        It is a tool to be used in software applications designed and developed by those who choose to use it.
        The InChI algorithm turns chemical structures into machine-readable strings of information.
        InChIs are unique to the compound they describe and can encode absolute stereochemistry making
        chemicals and chemistry machine-readable and discoverable.
        The :term:`InChI` format and algorithm are non-proprietary and the software is open source, with ongoing
        development done by the community. A number of IUPAC working groups is currently creating standard
        for those areas of chemistry that are not yet handled by the InChI algorithm.

    InChIKey
        From `About the InChi Standard <http://www.inchi-trust.org/about-the-inchi-standard/>`_,
        The :term:`InChIKey` has been designed so that Internet search engines can search and
        find the links to a given :term:`InChI`.
        To make the ``InChIKey`` the :term:`InChI` string is subjected to a compression algorithm to create a fixed-length
        string of upper-case characters. While the ``InChI`` to ``InChIKey`` hash compression is irreversible,
        there are a number of ``InChI`` resolvers available to look up an :term:`InChI` given an :term:`InChIKey`.

    in-memory
        The in-memory mode involves preloading all fingerprints into memory
        and performing the search in the memory.
        While this represents the fastest way to perform similarity searches once
        the fingerprints are loaded, searches are limited by memory availability.

    Iridium
        Iridium [Warren-2012] is a metric used to estimate the model
        quality of a structure resulting from an X-ray crystallography experiment.
        For more information about Iridium see :ref:`the discussion in the
        product documentation <chapter_sprucetk_iridium>`.

    JSON
        Sort for JavaScript Object Notation, this is a language-independent data format that works with most common languages, such as Python,
        Java, and others in the C-family of languages.

    LINGO
        LINGO is a very fast text-based molecular similarity search method.
        It is based on fragmentation of :term:`canonical isomeric SMILES` strings into overlapping
        substrings. See also :ref:`the discussion in the OEChem documentation <OEChem_OELingoSim>`.


    MACCS
        MACCS is a 166 bit-long :term:`structural key` descriptor in which each
        bit is associated with a specific structural pattern.

    marching cubes
        (online: `Marching cubes <http://en.wikipedia.org/wiki/Marching_cubes>`_)

    MDL
        MDL refers to the original "Molecular Design Limited Information Systems" company, which developed the :term:`MOL`
        format. Later, "Molecular Design Limited" was dropped in favor of the MDL acronym. For more
        information, see https://en.wikipedia.org/wiki/MDL_Information_Systems.

    memory-mapped
        The memory-mapped mode has no load time penalty or memory limitation, but the
        search itself takes more time.

    module
    modules
        In Python, *modules* are files with the file type ``.py``.  A Python module can, and
        usually does, define multiple Python classes, methods, and other objects. For more information,
        see the official Python documentation, such as https://docs.python.org/3/tutorial/modules.html.

    MOL
        A MOL type file uses a format originally defined by Molecular Design Limited
        that encodes information about the atoms, bonds, connectivity, and coordinates
        of a molecule, in plain text. For more information, see
        the `Wikipedia definition <https://en.wikipedia.org/wiki/Chemical_table_file#:~:text=Molfile,-ctab&text=An%20MDL%20Molfile%20is%20a,sections%20for%20more%20complex%20information.>`_


    Monte Carlo
        Monte Carlo simulations rely on repeated random sampling to model the probability of possible
        outcomes in a process that cannot easily be predicted. Thus it is used to estimate model uncertainty.
        In machine learning, Monte Carlo dropout refers to the process of randomly removing nodes from a neural network
        during training to regularize learning and avoid overfitting.


    nonterminal atom
        An atom is considered nonterminal if it is connected to two or more
        nonhydrogen atoms, that is, the method ``GetHvyDegree()`` of
        :ref:`OEAtomBase <OEChem_OEAtomBase>` returns
        a value greater than or equal to 2.

    OEB
        This is a binary OpenEye format used as a compact way to represent molecules with
        multiple :term:`conformers`.

    Orion back end
        The Orion back end is the set of programs and services that make up the
        "server" part of the client/server Orion product.

    Orion Platform
        The Orion Platform is the set of OpenEye-supported interfaces
        to the Orion back end.  Some interfaces are meant to be called by Python
        programs and some are command-line programs.

    package
    packages
        In Python, *packages* are sets of Python scripts (programs) organized in a directories
        that also includes an __init__.py script. The __init__.py script runs when the directory
        is opened; it may import  objects used by scripts in the package and perform
        other useful initial tasks for the packages' scripts.  Floe packages for
        use in Orion are specific examples of Python packages.

    popcount
        Popcount refers to the procedure of counting the number of 1s set in
        a bit string.  It is available as a hardware instruction on many modern
        processors and can be used, as an alternative to software-based counting
        methods, to speed up fingerprint operations.

    preliminary API
        APIs that are still under development might be delivered and marked as
        preliminary. Providing early access means that the APIs can be improved
        based on user feedback before committing to a final API design.
        Preliminary APIs will sometimes be made available for a limited set of
        platforms and languages, usually Python and C++.

    project
        In **Orion**, a project is a *container for data* related to the pursuit of an objective.
        A project serves as a location to store data and allows for efficient sharing and collaboration.
        Each project has its own :ref:`Project Summary <project-summary>` page.

    raster image
        Raster graphics represent images as an array of pixels or
        points of color.

    receptor
    receptors
        Receptors are a class of proteins that selectively bind to specific ligand molecules to change the behavior of a cell.
        This binding may activate or inactivate a receptor. A receptor is an integral part of a Design Unit and contains
        information about the location and characteristics of the binding pocket.

    ROC curve
        The receiver operating characteristic (ROC) curve is a two-dimensional graph
        in which the false positive rate is plotted on
        the X-axis and the true positive rate is plotted on the Y-axis.
        The ROC curves are useful to visualize and compare the performance of
        classifier methods. See also
        `Receiver operating characteristic (ROC) <http://en.wikipedia.org/wiki/Receiver_operating_characteristic>`_ in Wikipedia,
        `An introduction to ROC analysis <http://dx.doi.org/10.1016/j.patrec.2005.10.010>`_ by Tom Fawcett, and
        the definition of :term:`AUC`.

    rotatable bond
        In OpenEye documentation, a bond is considered rotatable only if it is a single nonring bond
        between two :term:`nonterminal <nonterminal atom>`, non-triple-bonded atoms.
        For example, the following structures have no rotatable bonds: ``CCC``, ``CC#CC``, and ``C1CCCCC1``.
        Note: Since the  "rotatable" property  depends on the 'in ring' property.
        the :ref:`OEFindRingAtomsAndBonds <OEFindRingAtomsAndBonds>` function must be called
        before accessing the :term:`rotatable bond` property via the
        ``IsRotor`` method of :ref:`OEQBondBase <OEQBondBase>`.

    script
    scripts
        Python programs are often called *scripts* because they are
        usually interpreted and not precompiled.  For most purposes, *script* and *program*
        are the same in Python, and this documentation may use either term to refer to
        a file of Python source code.

    SDF
        A Structural Data File (SDF) encodes information about chemical compounds
        in plain text. It is based on the :term:`MOL` format developed originally by Molecular
        Design Limited (MDL).  An SDF file can encode multiple molecules in a single
        file. The internet has considerable practical information
        on the format, such as https://lifechemicals.com/order-and-supply/how-to-work-with-sd-files.

    shard
        Shards are thin wrappers around files (not related to Orion Files). Each shard can store up to
        5 GB of arbitrary binary data as well as
        256 kB of user defined metadata in the form of `JSON <https://en.wikipedia.org/wiki/JSON>`_.

    SMARTS
        SMILES Arbitrary Target Specification (SMARTS)

        SMARTS is a language that allows specifying substructures by providing
        a number of primitive symbols describing atomic and bond properties.
        Atom and bond primitive specifications may be combined to form
        expressions by using logical operators.
        An introduction to SMARTS syntax is provided in :ref:`chapter_SMARTS`.
        For more information go to `the documentation of SMARTS on the Daylight Chemical Information Systems site <http://www.daylight.com/dayhtml/doc/theory/theory.smarts.html>`_

    SMILES
        Simplified Molecular Input Line Entry System (SMILES)

        A SMILES string represents a molecule by describing only its
        molecular graph (*i.e.* atoms and bonds in the connection table, but no chiral or
        isotopic information).
        There are usually a large number of valid SMILES which represent a
        given structure.
        For example, CCO, OCC and C(O)C all specify the structure of ethanol.
        For generating an arbitrary SMILES string, use the
        :ref:`OECreateAbsSmiString <OECreateAbsSmiString>` function.
        An introduction to SMILES syntax is provided in chapter :ref:`chapter_SMILES`.
        For more information go to `the documentation of SMILES on the Daylight Chemical Information Systems site <http://www.daylight.com/dayhtml/doc/theory/theory.smiles.html>`_

    SMIRKS
        SMILES Reaction Kernel Specification (SMIRKS)

        SMIRKS is a reaction transform language.
        A reaction considered valid according to the strict SMIRKS semantics if 1) all mapped product atoms have
        corresponding mapped reactant atoms,
        and 2) all atom maps must be pairwise (*i.e.*, every map class has exactly
        one reactant and one product atom)
        The strict semantics also requires that unmapped reactant atoms are
        destroyed in the reaction.
        The *strict* semantics means full compliance with SMIRKS defined by its originator, Daylight Inc.
        An introduction to SMIRKS syntax is provided in :ref:`chapter_reactions`.
        For more information go to `the documentation of SMIRKS on the Daylight Chemical Information Systems site <http://www.daylight.com/dayhtml/doc/theory/theory.smirks.html>`_
        Additional information on the semantics of SMIRKS language can be found at
        `SMIRKS Tutorial on the Daylight Chemical Information Systems site <http://www.daylight.com/dayhtml_tutorials/languages/smirks/index.html>`_.

    stable API
        Toolkits that have been fully developed, documented, and tested are
        considered stable.  The API definitions for these toolkits will be
        consistent across languages and platforms and will not change between
        toolkit releases.
        Code written with earlier versions of the toolkit will compile and
        run with newer versions. This allows users to easily upgrade
        to newer versions without worrying about breaking legacy code.


    stereo atom
        In **OEChem TK** the atom stereo information is stored as relative
        positions of neighboring atoms around a tetrahedral center.
        If an atom has specified stereochemistry, then the
        :ref:`HasStereoSpecified <OEChem_OEAtomBase_HasStereoSpecified>` method of
        :ref:`OEAtomBase <OEChem_OEAtomBase>` returns True.
        In **OEChem TK**, atom stereochemistry is internally represented by the two properties
        :term:`stereo atom` and :term:`chiral atom`.
        These properties are completely independent and allow
        **OEChem TK** to retain configuration information about atoms that are not
        chiral atoms, or to identify chiral atoms whose configuration is not
        specified. In the current version of **OEChem TK**, the only class of
        stereochemistry supported for atoms is
        :ref:`Tetrahedral <OEChem_OEAtomStereo>`, which corresponds
        to :math:`sp3` tetrahedral chirality. Valid return values for
        the :ref:`OEAtomStereo <OEChem_OEAtomStereo>` Tetrahedral stereochemistry
        class are ``Left`` and
        ``Right``.  See also the :term:`chiral atom` definition, the
        :ref:`OEBondBase <OEBondBase>` ``SetStereo`` method, the
        :ref:`OEBondBase <OEBondBase>` ``GetStereo`` method, the
        :ref:`OEBondBase <OEBondBase>` ``HasStereoSpecified`` method, and the
        :ref:`Bond Stereochemistry <section_stereochemistry_bond>` section

    stereo bond
        In **OEChem TK** the bond stereo information is stored as relative
        positions of neighboring atoms around a bond.
        If a bond has specified stereochemistry, then the
        :ref:`HasStereoSpecified <OEChem_OEAtomBase_HasStereoSpecified>` method
        of :ref:`OEAtomBase <OEChem_OEAtomBase>` returns
        True.
        In **OEChem TK**, atom stereochemistry is internally represented by the two properties
        :term:`stereo atom` and :term:`chiral atom`.
        These properties are completely independent and allow
        **OEChem TK** to retain configuration information about atoms that are not
        chiral atoms, or to identify chiral atoms whose configuration is not
        specified. In the current version of **OEChem TK**, the only class of
        stereochemistry supported for atoms is
        :ref:`Tetrahedral <OEChem_OEAtomStereo>`, which corresponds
        to :math:`sp3` tetrahedral chirality. Valid return values for
        the :ref:`OEAtomStereo <OEChem_OEAtomStereo>` Tetrahedral stereochemistry
        class are ``Left`` and
        ``Right``.  See also the :term:`chiral atom` definition, the
        :ref:`OEBondBase <OEBondBase>` ``SetStereo`` method, the
        :ref:`OEBondBase <OEBondBase>` ``GetStereo`` method, the
        :ref:`OEBondBase <OEBondBase>` ``HasStereoSpecified`` method, and the
        :ref:`Bond Stereochemistry <section_stereochemistry_bond>` section


    structural key
        A structural key is a fixed-length bitstring in which each bit is
        associated with a specific molecular pattern.
        When a structural key is generated for a molecule, the bitstring
        encodes whether or not these specific molecular patterns are
        present or absent in the molecule.
        The performance of such keys depends on the choice of the
        fragments used for constructing the keys and the probability of
        their presence in the searched molecule databases.


    SVG
        Scalable Vector Graphics (SVG) is a family of specifications of
        an XML-based file format for describing two-dimensional vector
        graphics.


    Tanimoto
        The Tanimoto coefficient (T) is a similarity measure for comparing chemical structures
        by means of molecular fingerprints. It is the ratio of the number of features common to both
        compounds to the total number of features. Two structures are generally considered similar
        if T > 0.85.


    vector image
        Vector graphics represent images using geometrical primitives
        such as points, lines, curves, and shapes or polygon(s), which
        are all based on mathematical equations.

    zwitterion
    zwitterionic
        A zwitterion contains an equal number of positively and negatively charged
        functional groups.  For more information, see `the Wikipedia definition <https://en.wikipedia.org/wiki/Zwitterion>`_.



.. global bibliography for toolkits

.. _toolkit-bibliography:

.. only:: oehtml

   *************
   Bibliography
   *************

.. |JCOMPCHEM| replace:: *Journal of Computational Chemistry*

.. |JCC| replace:: *Journal of Computational Chemistry*

.. |BIOP|      replace:: *Biopolymers*

.. |JCHEMPHYS| replace:: *Journal of Chemical Physics*

.. |NAT|       replace:: *Nature*

.. |SCI|       replace:: *Science*

.. |BCHM|      replace:: *Biochemistry*

.. |PROT|      replace:: *Proteins*

.. |MLIQ|      replace:: *Molecular Liquids*

.. |ARBC|      replace:: *Annual Review of Biophysics & Biophysical Chemistry*

.. |CHEMREV| replace:: *Chemical Reviews*

.. |DRUGDISC| replace:: *Drug Discovery Today*

.. |JPS|      replace:: *Journal of Pharmaceutical Sciences*

.. |ADDR|     replace:: *Advanced Drug Delivery Reviews*

.. |DDT|      replace:: *Drug Discovery Today*

.. |CCHTS|    replace:: *Combinatorial Chemistry & High Throughput Screening*

.. |JAC|      replace:: *Journal of Applied Crystallography*

.. |JACS|     replace:: *Journal of the American Chemical Society*

.. |JCAMD|    replace:: *Journal of Computer-Aided Molecular Design*

.. |JCD|      replace:: *Journal of Chemical Documentation*

.. |JCICS|    replace:: *Journal of Chemical Information and Computer Science*

.. |JCIM|     replace:: *Journal of Chemical Information and Modeling*

.. |JMB|      replace:: *Journal of Molecular Biology*

.. |JMGM|     replace:: *Journal of Molecular Graphics and Modeling*

.. |JMC|      replace:: *Journal of Medicinal Chemistry*

.. |JPC|      replace:: *Journal of Physical Chemistry*

.. |JPCB|      replace:: *Journal of Physical Chemistry B*

.. |NAR|     replace:: *Nucleic Acids Research*

.. |PAC|      replace:: *Pure and Applied Chemistry*

.. |SCIENCE|  replace:: *Science*

.. |PNAS|     replace:: *Proceedings of the National Academy of Science, USA*

.. |PROTEINS| replace:: *Proteins*

.. |PROTSCI|  replace:: *Protein Science*

.. |BIOPOL|   replace:: *Biopolymers*

.. |ACTACRYST| replace:: *Acta Crystallographica Section A: Foundations and Advances*

.. |ACTDCRYST| replace:: *Acta Crystallographica Section D: Structural Biology*

.. |BIOPHYS| replace:: *Biophysical Journal*

.. [Baber-1992]
   | Baber, J.C.; Hodgkin, E.E.
   | Automatic Assignment of Chemical Connectivity to Organic Molecules in the Cambridge Structural Database.
   | *J. Chem. Inf. Comput. Sci.* **1992**, *32* (5), 401–406.
   | DOI: 10.1021/ci00009a001

.. [Baell-2010]
   | Baell, J.; Holloway, G.A.
   | New Substructure Filters for Removal of Pan Assay Interference Compounds (PAINS) from Screening Libraries and for Their Exclusion in Bioassays.
   | *J. Med. Chem.* **2010**, *53* (7), 2719–2740.
   | DOI: 10.1021/jm901137j

.. [Balducci-1994]
   | Balducci, R.; Pearlman, R.S.
   | Efficient Exact Solution of the Ring Perception Problem.
   | *J. Chem. Inf. Comput. Sci.* **1994**, *34* (4), 822–831.
   | DOI: 10.1021/ci00020a016

.. [Baumer-1991]
   | Baumer, L.; Sala, G.; Sello, G.
   | Ring Perception in Organic Structures: A New Algorithm for Finding SSSR.
   | *Comput. Chem. (Oxford, UK)* **1991**, *15* (4), 293–299.
   | DOI: 10.1016/0097-8485(91)80046-o

.. [Bemis-1996]
   | Bemis, G.W.; Murcko, M.A.
   | The Properties of Known Drugs. 1. Molecular Frameworks.
   | *J. Med. Chem.* **1996**, *39* (15), 2887–2893.
   | DOI: 10.1021/jm9602928

.. [Bertz-1981]
   | Bertz, S.H.
   | The First General Index of Molecular Complexity.
   | *J. Am. Chem. Soc.* **1981**, *103* (12), 3599–3601.
   | DOI: 10.1021/ja00402a071

.. [Bertz-1982]
   | Bertz, S.H.
   | Convergence, Molecular Complexity, and Synthetic Analysis.
   | *J. Am. Chem. Soc.* **1982**, *104* (21), 5801–5803.
   | DOI: 10.1021/ja00385a049

.. [Bissantz-2010]
   | Bissantz, C.; Kuhn, B.; Stahl, M.
   | A Medicinal Chemist's Guide to Molecular Interactions.
   | *J. Med. Chem.* **2010**, *53* (14), 5061–5084.
   | DOI: 10.1021/jm100112j

.. [Blow-2002]
   | Blow, D.M.
   | Rearrangement of Cruickshank's Formulae for the Diffraction-Component Precision Index.
   | *Acta Crystallogr., Sect. D: Struct. Biol.* **2002**, *58* (5), 792–797.
   | DOI: 10.1107/s0907444902003931

.. [Boda-2007]
   | Boda, K.; Seidel, T.; Gasteiger, J.
   | Structure and Reaction Based Evaluation of Synthetic Accessibility.
   | *J. Comput.-Aided Mol. Des.* **2007**, *21* (6), 311–325.
   | DOI: 10.1007/s10822-006-9099-2

.. [Bondi-1964]
   | Bondi, A.
   | van der Waals Volumes and Radii.
   | *J. Phys.Chem.* **1964**, *68* (3), 441–451.
   | DOI: 10.1021/j100785a001

.. [Boström-2013]
   | Boström, J.; Grant, A.; Fjellström, O.; Thelin, A.; Gustaffson, D.;
   | Potent Fibrinolysis Inhibitor Discovered by Shape and Electrostatic Complementarity to the Drug Tranexamic Acid.
   | *J. Med Chem.* **2013**, *56*, 3273-3280.
   | DOI: 10.1021/jm301818g

.. [Brecher-2008]
   | Brecher, J.
   | Graphical Representation Standards for Chemical Structure Diagrams (IUPAC Recommendations 2008).
   | *Pure Appl. Chem.* **2008**, *80* (2), 277–410.
   | DOI: 10.1351/pac200880020277

.. [Briem-Lessel-2000]
   | Briem, H,; Lessel, U.F.
   | In Vitro and in Silico Affinity Fingerprints: Finding Similarities Beyond Structural Classes.
   | *Perspect. Drug Discovery Des.* **2000**, *20* (1), 231–244.
   | DOI: 10.1023/a:1008793325522

.. [Brown-Muchmore-2008]
   | Brown, S.; Muchmore, S.W., Pharmaceutical Discovery Division, Abbott Laboratories, Abbott Park, IL.
   | Belief Curves for Tanimoto Combo and Electrostatic Tanimoto Combo.
   | *Personal Communication*, 2008.

.. [Bunke-2002]
   | Bunke, H.; Foggia, P.; Guidobaldi, C.; Sansone, C.; Vento, M.
   | A Comparison of Algorithms for Maximum Common Subgraph on Randomly Connected Graphs.
   | Proceedings of the Joint IAPR International Workshop on Structural,
   | Syntactic and Statistical Pattern Recognition.
   | *Lecture Notes In Computer Science (LNCS)* **2002** *2396*, 123–132.
   | DOI: 10.1007/3-540-70659-3_12 (OEChem's MCSS is based upon the ''space state search'' method.)

.. [Cavallo-2016]
   | Cavallo, G.; Metrangolo, P.; Milani, R.; Pilati, T.; Priimagi, A.; Resnati, G.; Terraneo, G.
   | The Halogen Bond.
   | *Chem.Rev.* **2016**, *116* (4), 2478–2601.
   | DOI: 10.1021/acs.chemrev.5b00484

.. [ChEMBL18-2014]
   | Version ChEMBL_18 from http://www.ebi.ac.uk/chembl (accessed 2014).
   | Primary citation: Gaulton, A.; Bellis, L.J.; Bento, A.P.; Chambers, J.; Davies, M.; Hersey, A.; Light, Y.; McGlinchey, S.; Michalovich, D.; Al-Lazikani, B.; et al.
   | ChEMBL: A Large-Scale Bioactivity Database for Drug Discovery.
   | *Nucleic Acids Res.* **2012**, *40* (D1), D1100–D1107.
   | DOI: 10.1093/nar/gkr777
   | PMID: 21948594 (both numbers can be used for structure search within ChEMBL)

.. [ChEMBL24-2018]
   | Version ChEMBL_24 from http://www.ebi.ac.uk/chembl (accessed 2018).
   | Primary citation: Gaulton, A.; Hersey, A.; Nowotka, M.; Bento, A.P.; Chambers, J.; Mendez, D.; Mutowo, P.; Atkinson, F.; Bellis, L.J.; Cibrian-Uhalte, E.; et al.
   | The ChEMBL database in 2017.
   | *Nucleic Acids Res.* **2107**, *45* (D1), D945–D954.
   | DOI: 10.1093/nar/gkw1074
   | PMCID: PMC5210557 (both numbers can be used for structure search within ChEMBL)

.. [Chen-2003]
   | Chen, X.; Wang, W.
   | The Use of Bioisosteric Groups in Lead Optimization.
   | In *Annu. Rep. Med. Chem.*, Vol. 38; Elsevier, Inc., 2003; pp. 333–346.
   | DOI: 10.1016/S0065-7743(03)38033-9

.. [Chen-2010]
   | Chen, V.B.; Arendall, W.B., III; Headd, J.J.; Keedy, D.A.; Immormino, R.M.; Kapral, G.J.; Murray, L.W.; Richardson, J.S.; Richardson, D.C.
   | *MolProbity*: All-Atom Structure Validation for Macromolecular Crystallography.
   | *Acta Crystallogr., Sect. D: Struct. Biol.* **2010**, *D66* (1), 12–21.
   | DOI: 10.1107/s0907444909042073

.. [Connolly-1983]
   | Connolly, M.L.
   | Analytical Molecular Surface Calculation.
   | *J. Appl. Crystallogr.* **1983**, *16* (5), 548–558.
   | DOI: 10.1107/S0021889883010985

.. [Coutsias-2016]
   | Coutsias, E.A.; Lexa, K.W.; Wester, M.J.; Pollock, S.N.; Jacobson, M.P.
   | Exhaustive Conformational Sampling of Complex Fused Ring Macrocycles Using Inverse Kinematics.
   | *J. Chem. Theory Comput.* **2016**, *12* (9), 4674–4687.
   | DOI: 10.1021/acs.jctc.6b00250

.. [Crippen-1988]
   | Crippen, G.M.; Havel, T.F.
   | *Distance Geometry and Molecular Conformation*;
   | Chemometric Series, Vol. 15; Research Studies Press: Taunton, UK, 1988.
   | ISBN: 0471920614, 9780471920618

.. [Cruickshank-1999]
   | Cruickshank, D.W.J.
   | Remarks about Protein Structure Precision.
   | *Acta Crystallogr., Sect. D: Biol. Crystallogr.* **1999**, *55* (3), 583–601.
   | DOI: 10.1107/s0907444998012645

.. [Dayhoff-1978]
   | Dayhoff, M.O.; Schwartz, R.M.; Orcott, B.C.
   | A Model of Evolutionary Change in Proteins.
   | In *Atlas of Protein Sequence and Structure*; Dayhoff, M.O., Ed.; Dayhoff, M.O.. Series Ed.;
   | National Biomedical Research Foundation: Washington, D.C., 1978; Vol. 5, pp 345–352.

.. [Derevyanko-2014]
   | Derevyanko, G.; Grudinin, S.
   | HermiteFit: Fast-Fitting Atomic Structures into a Low-Resolution Density Map using Three-Dimensional Orthogonal Hermite Functions.
   | *Acta Crystallogr., Sect. D: Biol. Crystallogr.* **2014**, *D70* (8), 2069–2084.
   | DOI: 10.1107/s1399004714011493

.. [Dewar-1985]
   | Dewar, M.J.S.; Zoebisch, E.G.; Healy, E.F.; Stewart, J.J.P.
   | Development and Use of Quantum Mechanical Molecular Models. 76. AM1: A New General Purpose Quantum Mechanical Molecular Model.
   | *J. Am. Chem. Soc.* **1985**, *107* (13), 3902–3909.
   | DOI: 10.1021/ja00299a024

.. [Downs-1989]
   | Downs, G.M.; Gillet, V.J.; Holliday, J.D.; Lynch, M.F.
   | Review of Ring Perception Algorithms for Chemical Graphs.
   | *J. Chem. Inf. Comput. Sci.* **1989**, *29* (3), 172–187.
   | DOI: 10.1021/ci00063a007

.. [Dunbrack-1997]
   | Dunbrack, R.L., Jr.; Cohen, F.E.
   | Bayesian Statistical Analysis of Protein Side-Chain Rotamer Preferences.
   | *Protein Sci.* **1997**, *6* (8), 1661–1681.
   | DOI: 10.1002/pro.5560060807

.. [Durant-2002]
   | Durant, J.L.; Leland, B.A.; Henry, D.R.; Nourse, J.G.
   | Reoptimization of MDL Keys for Use in Drug Discovery.
   | *J. Chem. Inf. Comput. Sci.* **2002**, *42* (6), 1273–1280.
   | DOI: 10.1021/ci010132r

.. [Egan-2000]
   | Egan, W.J.; Merz, K.M.; Baldwin, J.J.
   | Prediction of Drug Absorption Using Multivariate Statistics.
   | *J. Med. Chem.* **2000**, *43* (21), 3867–3877.
   | DOI: 10.1021/jm000292e

.. [Eldridge-1997]
   | Eldridge, M.D.; Murray, C.W.; Auton, T.R.; Paolini, G.V.; Mee, R.P.
   | Empirical Scoring Functions: I. The Development of a Fast Empirical Scoring Function to Estimate the Binding Affinity of Ligands in Receptor Complexes.
   | *J. Comput.-Aided Mol. Des.* **1997**, *11* (5), 425–445.
   | DOI: 10.1023/a:1007996124545

.. [Erickson-2004]
   | Erickson, J.A.; Jalaie, M.; Robertson, D.H.; Lewis, R.A.; Vieth, M.
   | Lessons in Molecular Recognition: The Effects of Ligand and Protein Flexibility on Molecular Docking Accuracy.
   | *J. Med. Chem.* **2004**, *47* (1), 45–55.
   | DOI: 10.1021/jm030209y

.. [Ertl-2000]
   | Ertl, P.; Rohde, B.; Selzer, P.
   | Fast Calculation of Molecular Polar Surface Area as a Sum of Fragment-Based Contributions and its Application to the Prediction of Drug Transport Properties.
   | *J. Med Chem.* **2000**, *43* (20), 3714–3717.
   | DOI: 10.1021/jm000942e

.. [Figueras-1972]
   | Figueras, J.
   | Substructure Search by Set Reduction.
   | *J. Chem. Doc.* **1972**, *12* (4), 237–244.
   | DOI: 10.1021/c160047a010

.. [Figueras-1996]
   | Figueras, J.
   | Ring Perception Using Breadth-First Search.
   | *J. Chem. Inf. Comput. Sci.* **1996**, *36*, 986–991.
   | DOI: 10.1021/ci960013p

.. [Friedrich-2017]
   | Friedrich, N.-O.; Meyder, A.; de Bruyn Kops, C.; Sommer, K.; Flachsenberg, F.; Rarey, M.; Kirchmair, J.
   | High-Quality Dataset of Protein-Bound Ligand Conformations and Its Application to Benchmarking Conformer Ensemble Generators.
   | *J. Chem. Inf. Model.* **2017** *57*, (3), 529–539.
   | DOI: 10.1021/acs.jcim.6b00613

.. [Fujita-1988]
   | Fujita, S.
   | A New Algorithm for Selection of Synthetically Important Rings. The Essential Set of Essential Rings for Organic Structures.
   | *J. Chem. Inf. Comput. Sci.* **1988**, *28* (2), 78–82.
   | DOI: 10.1021/ci00058a007

.. [Gamo-2010]
   | Gamo, F.-J.; Sanz, L.M.; Vidal, J.; de Cozar, C.; Alvarez, E.; Lavandera, J.-L.; Vanderwall, D.E.;
   | Green, D.V.S.; Kumar, V.; Hasan, S.; et al.
   | Thousands of Chemical Starting Points for Antimalarial Lead Identification.
   | *Nature* **2010**, *465* (7296), 305–310.
   | DOI: 10.1038/nature09107

.. [Gasteiger-1978]
   | Gasteiger, J.; Marsili, M.
   | A New Model for Calculating Atomic Charges in Molecules.
   | *Tetrahedron Lett.* **1978**, *19* (34), 3181–3184.
   | DOI: 10.1016/s0040-4039(01)94977-9

.. [Gasteiger-1979]
   | Gasteiger, J.; Jochum, C.
   | An Algorithm for the Perception of Synthetically Important Rings.
   | *J. Chem. Inf. Comput. Sci.* **1979**, *19* (1), 43–48.
   | DOI: 10.1021/ci60017a011

.. [Gasteiger-1980]
   | Gasteiger, J.; Marsili, M.
   | Iterative Partial Equalization of Orbital Electronegativity—A Rapid Access to Atomic Charges.
   | *Tetrahedron* **1980**, *36* (22), 3219–3228.
   | DOI: 10.1016/0040-4020(80)80168-2

.. [Gehlhaar-2022]
   | Gehlhaar, D.K.; Luty, B.A.; Cheung, P.P.; Litman, A.H.; Owen, R.M.; Rose, P.W.
   | The Pfizer Crystal Structure Database: An Essential Tool for Structure-Based Design at Pfizer
   | *J. Comput. Chem.* **2022**, *43* (15), 1053–1062.
   | DOI: 10.1002/jcc.26862

.. [Gilson-1988]
   | Gilson, M.K.; Sharp, K.A.; Honig, B.H.
   | Calculating the electrostatic potential of molecules in solution: Method and error assessment.
   | *J. Comput. Chem.* **1988**, *9* (4), 327–335.
   | DOI: 10.1002/jcc.540090407

.. [Ghiandoni-2026]
   | Ghiandoni, G.M.; Noisier, A.F.M.; Bolt, H.; Pinto-Gil, K.
   | NON-NATURAL AMINO ACID NOMENCLATURE FOR HELM MONOMER REGISTRATION
   | PRE-PRINT
   | https://chemrxiv.org/doi/full/10.26434/chemrxiv.10001730/v1

.. [Gonnet-1992]
   | Gonnet, G.H.; Cohen, M.A.; Benner, S.A.
   | Exhaustive Matching of the Entire Protein Sequence Database.
   | *Science* **1992**, *256* (5062), 1443–1445.
   | DOI: 10.1126/science.1604319

.. [Grant-1995]
   | Grant, J.A.; Pickup,B.T.
   | A Gaussian Description of Molecular Shape.
   | *J. Phys.Chem.* **1995**, *99* (11), 3503–3510.
   | DOI: 10.1021/j100011a016

.. [Grant-1996]
   | Grant, J.A.; Gallardo, M.A.; Pickup, B.T.
   | A Fast Method of Molecular Shape Comparison. A Simple Application of a Gaussian Description of Molecular Shape.
   | *J. Comput. Chem.* **1996**, *17* (14), 1653–1666.
   | DOI: 10.1002/(SICI)1096-987X(19961115)17:14<1653::AID-JCC7>3.0.CO;2-K

.. [Grant-1997]
   | Grant, J.A.; Pickup, B.T.
   | Gaussian Shape Methods. In: *Computer Simulations of Biomolecular Systems,* Vol 3;
   | van Gunsteren, W.F., Weiner, P.K., Wilkinson, A.J., Eds.; Springer, 1997; pp. 150–176.
   | DOI: 10.1007/978-94-017-1120-3_5

.. [Grant-2001]
   | Grant, J.A.; Pickup, B.T.; Nicholls, A.
   | A Smooth Permittivity Function for Poisson–Boltzmann Solvation Methods.
   | *J. Comput. Chem.* **2001**, *22* (6), 608–640.
   | DOI: 10.1002/jcc.1032

.. [Grant-2006]
   | Grant, J.A.; Haigh, J.A.; Pickup, B.T.; Nicholls, A.; Sayle, R.A.
   | Lingos, Finite State Machines, and Fast Similarity Searching.
   | *J. Chem. Inf. Model.* **2006**, *45* (5), 1912–1918.
   | DOI: 10.1021/ci6002152

.. [Grant-2007]
   | Grant, J.A.; Pickup, B.T.; Sykes, M.J.; Kitchen, C.A.; Nicholls, A.
   | A Simple Formula for Dielectric Polarization Energies: The Sheffield Solvation Model.
   | *Chem. Phys. Lett.* **2007**, *441* (1–3), 163–166.
   | DOI: 10.1016/j.cplett.2007.05.008

.. [Green-Armytage-2010]
   | Green-Armytage, P.
   | A Colour Alphabet and the Limits of Colour Coding.
   | *Colour: Design & Creativity* **2010**, *5* (10), 1–23.
   | Corpus ID: 119668103

.. [Griffen-2011]
   | Griffen, E.; Leach, A.G.; Robb, G.R.; Warner, D.J.
   | Matched Molecular Pairs as a Medicinal Chemistry Tool.
   | *J. Med. Chem.* **2011**, *54* (22), 7739–7750.
   | DOI: 10.1021/jm200452d

.. [Grosse-Kunstleve-2002]
   | Grosse-Kunstleve, R.W.; Sauter, N.K.; Moriarty, N.W.; Adams, P.D.
   | The Computational Crystallography Toolbox: Crystallographic Algorithms in a Reusable Software Framework.
   | *J. Appl. Cryst.* **2002**, *35* (1), 126–136.
   | DOI: 10.1107/s0021889801017824

.. [Guba-2016]
   | Guba, W.; Meyder, A.; Rarey, M.; Hert, J.
   | Torsion Library Reloaded: A New Version of Expert-Derived SMARTS Rules for Assessing Conformations of Small Molecules.
   | *J. Chem. Inf. Model.* **2016**, *56* (1), 1–5.
   | DOI: 10.1021/acs.jcim.5b00522

.. [Hajduk-2007]
   | Hajduk, P.J.; Greer, J.
   | A Decade of Fragment-Based Drug Design: Strategic Advances and Lessons Learned.
   | *Nat. Rev. Drug Discovery* **2007**, *6* (3), 211–219.
   | DOI: 10.1038/nrd2220

.. [Halgren-I-1996]
   | Halgren, T.A.
   | Merck Molecular Force Field. I. Basis, Form, Scope, Parameterization, and Performance of MMFF94.
   | *J. Comput. Chem.* **1996**, *17* (5–6), 490–519.
   | DOI: 10.1002/(SICI)1096-987X(199604)17:5/6<490::AID-JCC1>3.0.CO;2-P

.. [Halgren-II-1996]
   | Halgren, T.A.
   | Merck Molecular Force Field. II. MMFF94 van der Waals and Electrostatic Parameters for Intermolecular Interactions.
   | *J. Comput. Chem.* **1996**, *17* (5–6), 520–552.
   | DOI: 10.1002/(SICI)1096-987X(199604)17:5/6<520::AID-JCC2>3.0.CO;2-W

.. [Halgren-III-1996]
   | Halgren, T.A.
   | Merck Molecular Force Field: III. Molecular Geometries and Vibrational Frequencies for MMFF94.
   | *J. Comput. Chem.* **1996**, *17* (5–6), 553–586.
   | DOI: 10.1002/(SICI)1096-987X(199604)17:5/6<553::AID-JCC3>3.0.CO;2-T

.. [Halgren-IV-1996]
   | Halgren, T.A.; Nachbar, R.B.
   | Merck Molecular Force Field. IV. Conformational Energies and Geometries for MMFF94.
   | *J. Comput. Chem.* **1996**, *17* (5–6), 587–615.
   | DOI: 10.1002/(SICI)1096-987X(199604)17:5/6<587::AID-JCC4>3.0.CO;2-Q

.. [Halgren-V-1996]
   | Halgren, T.A.
   | Merck Molecular Force Field. V. Extension of MMFF94 using Experimental Data, Additional Computational Data, and Empirical Rules.
   | *J. Comput. Chem.* **1996**, *17* (5–6), 616–641.
   | DOI: 10.1002/(SICI)1096-987X(199604)17:5/6<616::AID-JCC5>3.0.CO;2-X

.. [Halgren-VI-1999]
   | Halgren, T.A.
   | MMFF VI. MMFF94s Option for Energy Minimization Studies.
   | *J. Comput. Chem.* **1999**, *20* (7), 720–729.
   | DOI: 10.1002/(SICI)1096-987X(199905)20:7<720::AID-JCC7>3.0.CO;2-X

.. [Halgren-VII-1999]
   | Halgren, T.A.
   | MMFF VII. Characterization of MMFF94, MMFF94s, and Other Widely Available Force Fields for Conformational Energies and for Intermolecular-Interaction Energies and Geometries.
   | *J. Comput. Chem.* **1999**, *20* (7), 730–748.
   | DOI: 10.1002/(SICI)1096-987X(199905)20:7<730::AID-JCC8>3.0.CO;2-T

.. [Hamaguchi-2012]
   | Hamaguchi, N.; Fusti-Molnar, L.; Wlodek, S.
   | Force-Field and Quantum-Mechanical Binding Study of Selected SAMPL3 Host-Guest Complexes.
   | *J. Comput.-Aided Mol. Des.* **2012**, *26* (5), 577–582.
   | DOI: 10.1007/s10822-012-9553-2

.. [Hanser-1996]
   | Hanser, T.; Jauffret, P.; Kaufmann, G.
   | A New Algorithm for Exhaustive Ring Perception in a Molecular Graph.
   | *J. Chem. Inf. Comput. Sci.* **1996**, *36*, 1146–1152.
   | DOI: 10.1021/ci960322f

.. [Hare-2004]
   | Hare, B.J.; Walters, W.P.; Caron, P.R.; Bemis, G.W.
   | CORES: An Automated Method for Generating Three-Dimensional Models of Protein/Ligand Complexes.
   | *J. Med. Chem.* **2004**, *47* (19), 4731–4740.
   | DOI: 10.1021/jm0499054

.. [Hawkins-2007]
   | Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A.
   | Comparison of Shape-Matching and Docking as Virtual Screening Tools.
   | *J. Med. Chem.* **2007**, *50* (1), 74-82.
   | DOI: 10.1021/jm0603365

.. [Hawkins-2010]
   | Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T.
   | Conformer Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the Protein Databank and Cambridge Structural Database.
   | *J. Chem. Inf. Model.* **2010**, *50* (4), 572–584.
   | DOI: 10.1021/ci100031x

.. [Hawkins-2012]
   | Hawkins, P.C.D; Nicholls, A.
   | Conformer Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
   | *J. Chem. Inf. Model.* **2012**, *52*, (11), 2919–2936.
   | DOI: 10.1021/ci300314k

.. [Hawkins-2020]
   | Hawkins, P.C.D.; Wlodek, S.J.
   | Decisions With Confidence: Application to the Conformation Sampling of Molecules in the Solid State.
   | *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
   | DOI: 10.1021/acs.jcim.0c00358

.. [Hendlich-1997]
   | Hendlich, M.; Rippmann F.; Barnickel, G.
   | BALI: Automatic Assignment of Bond and Atom Types for Protein Ligands in the Brookhaven Protein Databank.
   | *J. Chem. Inf. Comput. Sci.* **1997**, *37* (4), 774–778.
   | DOI: 10.1021/ci9603487

.. [Henikoff-1992]
   | Henikoff, S.; Henikoff, J.G.
   | Amino Acid Substitution Matrices from Protein Blocks.
   | *Proc. Natl. Acad. Sci. U. S. A.* **1992**, *89* (22), 10915–10919.
   | DOI: 10.1073/pnas.89.22.10915

.. [Hert-Willett-2004]
   | Hert, J.; Willett, P.; Wilton, DJ.; Acklin, P.; Azzaoui, K.; Jacoby, E.; Schuffenhauer, A.
   | Comparison of Fingerprint-Based Methods for Virtual Screening Using Multiple Bioactive Reference Structures.
   | *J. Chem. Inf. Comput. Sci.* **2004**, *44* (3), 1177–1185.
   | DOI: 10.1021/ci034231b

.. [Hintze-2016]
   | Hintze, B.J.; Lewis, S.M.; Richardson, J.S.; Richardson, D.C.
   | Molprobity's Ultimate Rotamer-Library Distributions for Model Validation.
   | *Proteins: Struct., Funct., Bioinf.* **2016**, *84* (9), 1177–1189.
   | DOI: 10.1002/prot.25039

.. [Hussain-2010]
   | Hussain, J.; Rea, C.
   | Computationally Efficient Algorithm to Identify Matched Molecular Pairs (MMPs) in Large Data Sets.
   | *J. Chem. Inf. Model.* **2010**, *50* (3), 339–348.
   | DOI: 10.1021/ci900450m

.. [InChI-2013]
   | *InChI Trust*. http://www.inchi-trust.org/ (accessed 2013).

.. [IUPAC-2014]
   | *Nomenclature of Organic Chemistry: IUPAC Recommendations and Preferred Names 2013, IUPAC Blue Book*.
   | Prepared for publication by H.A. Favre and W.H. Powell.
   | RSC Publishing, 2014.
   | ISBN 978-0-85404-182-4
   | DOI: 10.1039/9781849733069

.. [Jeffrey-1997]
   | Jeffrey, G.A.
   | *An Introduction to Hydrogen Bonding*;
   | Oxford University Press, 1997.
   | ISBN: 9780195095494

.. [Kabsch-1983]
   | Kabsch, W.; Sander, C.
   | Dictionary of Protein Secondary Structure: Pattern Recognition of Hydrogen-Bonded and Geometrical Features.
   | *Biopolymers* **1983**, *22* (12), 2577–2637.
   | DOI: 10.1002/bip.360221211

.. [Kearsley-1993]
   | Kearsley, S.K.
   | A Quick Robust Method for Assigning a Kekulé Structure.
   | *Comput. Chem. (Oxford, U. K.)* **1993**, *17* (1), 1–10.
   | DOI: 10.1016/0097-8485(93)80022-6

.. [Kelley-2015]
   | Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W.
   | POSIT: Flexible Shape-Guided Docking For Pose Prediction.
   | *J. Chem. Inf. Model.* **2015**, *55* (8), 1771–1780.
   | DOI: 10.1021/acs.jcim.5b00142

.. [Kelly-1965]
   | Kelly, K.
   | Twenty-Two Colors of Maximum Contrast.
   | *Color Eng.* **1965**, *3,* (6), 26–27.

.. [Kramer-2014]
   | Kramer, C.; Fuchs, J.E.; Whitebread, S.; Gedeck, P.; Liedl, K.R.
   | Matched Molecular Pair Analysis: Significance and the Impact of Experimental Uncertainty.
   | *J. Med. Chem.* **2014**, *57* (9), 3786–3802.
   | DOI: 10.1021/jm500317a

.. [Kumar-2002]
   | Kumar, S.; Nussinov, R.
   | Relationship between Ion Pair Geometries and Electrostatic Strengths in Proteins.
   | *Biophys. J.* **2002**, *83* (3), 1595–1612.
   | DOI: S0006-3495(02)73929-5

.. [Labute-1996]
   | Labute, P.
   | Automatic Assignment of Bond Order.
   | *Journal of the Chemical Computing Group*. Online, May, **1996**.

.. [Labute-2010]
   | Labute, P.
   | LowModeMD—Implicit Low-Mode Velocity Filtering Applied to Conformational Search of Macrocycles and Protein Loops.
   | *J. Chem. Inf. Model.* **2010**, *50* (5), 792–800.
   | DOI: 10.1021/ci900508k

.. [Lauri-1994]
   | Lauri, G.; Bartlett, P.A.
   | CAVEAT: A Program to Facilitate the Design of Organic Molecules.
   | *J. Comput.-Aided Mol. Des.* **1994** *8* (1), 51–66.
   | DOI: 10.1007/bf00124349

.. [Lee-1971]
   | Lee, B.; Richards, F.M.
   | The Interpretation of Protein Structures: Estimation of Static Accessibility.
   | *J. Mol. Biol.* **1971**, *55* (3), 379–400.
   | DOI: 10.1016/0022-2836(71)90324-X

.. [Lewell-1998]
   | Lewell, X.Q.; Judd, D.B.; Watson, S,P; Hann, M.M.
   | RECAP—Retrosynthetic Combinatorial Analysis Procedure: A Powerful New Technique for Identifying Privileged Molecular Fragments With Useful Applications in Combinatorial Chemistry.
   | *J. Chem. Inf. Comput. Sci.* **1998**, *38* (3), 511–522.
   | DOI: 10.1021/ci970429i

.. [Lipinski-1997]
   | Lipinski, C.A.; Lombardo, F.; Dominy, B.W; Feeney, P.J.
   | Experimental and Computational Approaches to Estimate Solubility and Permeability in Drug Discovery and Development Settings.
   | *Adv. Drug Delivery Rev.* **1997**, *23* (1–3), 3–25.
   | DOI: 10.1016/s0169-409x(96)00423-1

.. [Lovell-2000]
   | Lovell, S.C.; Word, J.M.; Richardson, J.S.; Richardson, D.C.
   | The Penultimate Rotamer Library.
   | *Proteins: Struct., Funct., Genet.* **2000**, *40* (3), 389–408.
   | DOI: 10.1002/1097-0134(20000815)40:3<389::aid-prot50>3.0.co;2-2

.. [Lovell-2003]
   | Lovell, S.C.; Davis, I.W.; Arendall, W.B., III; de Bakker, P.I.W.; Word, J.M.; Prisant, M.G.; Richardson, J.S.; Richardson, D.C.
   | Structure Validation by :math:`C\alpha` Geometry: :math:`\phi`, :math:`\psi` and :math:`C\beta` Deviation.
   | *Proteins: Struct., Funct., Bioinf.* **2003**, *50* (3), 437–450.
   | DOI: 10.1002/prot.10286

.. [Lovering-2009]
   | Lovering, F.; Bikker, J.; Humblet, C.
   | Escape from Flatland: Increasing Saturation as an Approach to Improving Clinical Success.
   | *J. Med. Chem.* **2009**, *52* (21), 6752–6756.
   | DOI: 10.1021/jm901241e

.. [Lloyd-1996]
   | Lloyd, D.
   | What Is Aromaticity?
   | *J. Chem. Inf. Comput. Sci.* **1996**, *36* (3), 442–447.
   | DOI: 10.1021/ci950158g

.. [Maier-2015]
   | Maier, J.A.; Martinez, C.; Kasavajhala, K.; Wickstrom, L.; Hauser, K.E.; Simmerling, C.
   | ff14SB: Improving the Accuracy of Protein Side Chain and Backbone Parameters from ff99SB.
   | *J. Chem. Theory Comput.* **2015**, *11* (8), 3696–3713.
   | DOI: 10.1021/acs.jctc.5b00255

.. [Marcou-2007]
   | Marcou, G.; Rognan, D.
   | Optimizing Fragment and Scaffold Docking by Use of Molecular Interaction Fingerprints.
   | *J. Chem. Inf. Model.* **2007**, *47* (1), 195–207.
   | DOI: 10.1021/ci600342e

.. [Markley-1998]
   | Markley, J.L.; Bax, A.; Arata, Y.; Hilbers, C.W.; Kaptein, R.; Sykes, B.D.;  Wright, P.E.; Wüthrich, K.
   | Recommendations for the Presentation of NMR Structures of Proteins and Nucleic Acids (IUPAC Recommendations 1998).
   | *Pure Appl. Chem.* **1998**, *70* (1), 117–142.
   | DOI: 10.1351/pac199870010117

.. [Martin-2005]
   | Martin, Y.C.
   | A Bioavailability Score.
   | *J. Med. Chem.* **2005**, *48* (9), 3164–3170.
   | DOI: 10.1021/jm0492002

..
   .. [Masek-1993]
      | Masek, B.B.; Merchant, A.; Matthew, J.B.
      | Molecular Shape Comparison of Angiotensin II Receptor Antagonists.
      | *J. Med. Chem.* **1993**, *36* (9), 1230–1238.
      | DOI: 10.1021/jm00061a014

.. [Mayne-1998]
   | Mayne, L.; Englander, S.W.; Qiu, R.; Yang, J.; Gong, Y.; Spek, E.J.; Kallenbach, N.R.
   | Stabilizing Effect of a Multiple Salt Bridge in a Prenucleated Peptide.
   | *J. Am. Chem. Soc.* **1998**, *120* (41), 10643–10645.
   | DOI: 10.1021/ja981592c

.. [McGann-2003]
   | McGann, M.; Almond, H.R.; Nicholls, A.; Grant, J.A.; Brown, F.K.
   | Gaussian Docking Functions.
   | *Biopolymers* **2003**, *68* (1), 76–90.
   | DOI: 10.1002/bip.10207

.. [McGovern-2003]
   | McGovern, S.L.; Helfand, B.T.; Feng, B.; Shoichet, B.K.
   | A Specific Mechanism of Nonspecific Inhibition.
   | *J. Med. Chem.* **2003**, *46* (20), 4265–4272.
   | DOI: 10.1021/jm030266r

.. [McGregor-1982]
   | McGregor, J.J.
   | Backtrack Search Algorithms and the Maximal Common Subgraph Problem.
   | *Softw. Pract. Exp.* **1982**, *12* (1), 23–34.
   | DOI: 10.1002/spe.4380120103

.. [McQuarrie-1976]
   | McQuarrie, D.A.
   | *Statistical Mechanics*;
   | Harper & Row, 1976.

.. [Meng-1991]
   | Meng, E.C.; Lewis, R.A.
   | Determination of Molecular Topology and Atomic Hybridization States from Heavy Atom Coordinates.
   | *J. Comput. Chem.* **1991**, *12* (7), 891–898.
   | DOI: 10.1002/jcc.540120716

.. [Mills-Dean-1996]
   | Mills, J.E.J.; Dean, P.M.
   | Three-Dimensional Hydrogen-Bond Geometry and Probability Information from a Crystal Survey.
   | *J. Comput.-Aided Mol. Des.* **1996**, *10* (6), 607–622.
   | DOI: 10.1007/bf00134183

.. [Mobley-2018]
   | Mobley, D.L.; Bannan, C.C.; Rizzi, A.; Bayly, C.I.; Chodera, J.D.; Lim, V.T.; Lim, N.M.; Beauchamp, K.A.; Slochower, D.R.; Shirts, M.R.; et al.
   | Escaping Atom Types in Force Fields Using Direct Chemical Perception.
   | *J. Chem. Theory Comput.* **2018**, *14* (11), 6076–6092.
   | DOI: 10.1021/acs.jctc.8b00640

.. [Muchmore-2006]
   | Muchmore, S.; Souers, A. J.; Akritopoulou-Zanze, I.
   | The use of three-dimensional shape and electrostatic similarity searching in the identification of a melanin-concentrating hormone receptor 1 antagonist.
   | *Chem. Biol. Drug Des.* **2006**, *67*, 174.
   | DOI: 10.1111/j.1747-0285.2006.00341.x

.. [Muchmore-2008]
   | Muchmore, S.W.; Debe, D.A.; Metz, J.T.; Brown, S.P.; Martin, Y.C.; Hajduk, P.J.
   | Application of Belief Theory to Similarity Data Fusion for Use in Analog Searching and Lead Hopping.
   | *J. Chem.Inf. Model.* **2008**, *48* (5), 941–948.
   | DOI: 10.1021/ci7004498

.. [Mysinger-2012]
   | Mysinger, M.M.; Carchia, M.; Irwin, J.J.; Shoichet, B.K.
   | Directory of Useful Decoys, Enhanced (DUD-E): Better Ligands and Decoys for Better Benchmarking.
   | *J. Med. Chem.* **2012**, *55* (14), 6582–6594.
   | DOI: 10.1021/jm300687e

.. [Naylor-2009]
   | Naylor, E.; Arredouani, A.; Vasudevan, S.R.; Lewis, A.M.; Parkesh, R.; Mizote, A.; Rosen, D.; Thomas, J.M.; Izumi, M.; Ganesan, A.; Galione, A.; Churchill, G.C.
   | Identification of a chemical probe for NAADP by virtual screening.
   | *Nature Chemical Biology.* **2009**, *5*, 280-292.
   | DOI: 10.1038/nchembio.150

.. [Ndubaku-2009]
   | Ndubaku, C.; Varfolomeev, E.; Wang, L.; Zobel, K.; Lau, K.; Elliot, L.O.; Maurer, B.; Fedorova, A.V.; Dynek, J.N.; Koehler, M.; et al.
   | Antagonism of c-IAP and XIAP Proteins Is Required for Efficient Induction of Cell Death by Small-Molecule IAP Antagonists.
   | *ACS Chem. Biol.* **2009**, *4* (7), 557–566.
   | DOI: 10.1021/cb900083m

.. [Nicholls-2008]
   | Nicholls, A.; Mobley, D.L.; Guthrie, J.P.; Chodera, J.D.; Bayly, C.I.; Cooper, M.D.; Pande, V.S.
   | Predicting Small-Molecule Solvation Free Energies: An Informal Blind Test for Computational Chemistry.
   | *J. Med. Chem.* **2008**, *51* (4), 769–779.
   | DOI: 10.1021/jm070549+

.. [Nicholls-2009]
   | Nicholls, A.; Wlodek, S.; Grant, J.A.
   | The SAMP1 Solvation Challenge: Further Lessons Regarding the Pitfalls of Parametrization.
   | *J. Phys. Chem. B* **2009**, *113* (14), 4521–4532.
   | DOI: 10.1021/jp806855q

.. [Nicholls-2010]
   | Nicholls, A.; Wlodek S.; Grant, J.A.
   | SAMPL2 and Continuum Modeling.
   | *J. Comput.-Aided Mol. Des.* **2010**, *24* (4), 293–306.
   | DOI: 10.1007/s10822-010-9334-8

.. [Oprea-2000]
   | Oprea, T.
   | Property Distribution of Drug-Related Chemical Databases.
   | *J. Comput.-Aided Mol. Des.* **2000**, *14* (3), 251–264.
   | DOI: 10.1023/a:1008130001697

.. [Otter-1989]
   | Otter, A.; Scott, P.G.; Liu, X.H.; Kotovych, G.
   | A 1H and 13C NMR Study on the Role of Salt-Bridges in the Formation of a Type I ß-Turn in N-Acetyl-L-Asp-L-Glu-L-Lys-L-Ser-NH2.
   | *J. Biomol. Struct. Dyn.* **1989**, *7* (3), 455–476.
   | DOI: 10.1080/07391102.1989.10508504

.. [Papadatos-2010]
   | Papadatos, G.; Alkarouri, M.; Gillet, V.J.; Willett, P.; Kadirkamanathan, V.; Luscombe, C.N.; Bravi, G.; Richmond, N.J.; Pickett, S.D.; Hussain, J.; et al.
   | Lead Optimization Using Matched Molecular Pairs: Inclusion of Contextual Information for Enhanced Prediction of hERG Inhibition, Solubility, and Lipophilicity.
   | *J. Chem. Inf. Model.* **2010**, *50* (10), 1872–1886.
   | DOI: 10.1021/ci100258p

.. [Pauling-1960]
   | Pauling, L.
   | **The Nature of the Chemical Bond and the Structure of Molecules and Crystals; An Introduction to Modern Structural Chemistry**,
   | *Cornell University Press; 3rd edition (1960)*.
   | ISBN-13: 978-0801403330

.. [Pierotti-1976]
   | Pierotti, R.A.
   | A Scaled Particle Theory of Aqueous and Nonaqueous Solutions.
   | *Chem. Rev.* **1976**, *76* (6), 717–726.
   | DOI: 10.1021/cr60304a002

.. [Plotkin-1971]
   | Plotkin, M.J.
   | Mathematical Basis of Ring-Finding Algorithms in CIDS.
   | *J. Chem. Doc.* **1971**, *11* (1), 60–63.
   | DOI: 10.1021/c160040a013

..
   .. [Proteopedia-2024]
      | Martz, E.
      | Biological Unit.
      | *Proteopedia, life in 3D.* https://proteopedia.org/wiki/index.php?title=Biological_Unit&oldid=4211835#Literature_Citations (accessed 202410/31)

.. [Qian-1990]
   | Qian, C.; Fisanick, W.; Hartzler, D.E.; Chapman, S.W.
   | Enhanced Algorithm for Finding the Smallest Set of Smallest Rings.
   | *J. Chem. Inf. Comput. Sci.* **1990**, *30* (2), 105–110.
   | DOI: 10.1021/ci00066a002

.. [Ramachandran-1963]
   | Ramachandran, G.N.; Ramakrishnan, C.; Sasisekharan, V.
   | Stereochemistry of Polypeptide Chain Configurations.
   | *J. Mol. Bio.* **1963**, *7* (1), 95–99.
   | DOI: 10.1016/s0022-2836(63)80023-6

.. [Rashin-1985]
   | Rashin, A.A.; Honig, B.
   | Reevaluation of the Born Model of Ion Hydration.
   | |JPC| **1985**, *89* (26), 5588–5593.
   | DOI: 10.1021/j100272a006

.. [Raymond-2002]
   | Raymond, J.W.; Gardiner, E.J.; Willett, P.
   | RASCAL: Calculation of Graph Similarity Using Maximum Common Edge Subgraphs.
   | *The Computer Journal* **2002**, *45* (6), 631–644.
   | DOI: 10.1093/comjnl/45.6.631

.. [Ritchie-2009]
   | Ritchie, T.J.; Macdonald, S.J.F.
   | The Impact of Aromatic Ring Count on Compound Developability - Are Too Many Aromatic Rings a Liability in Drug Design?
   | *Drug Discovery Today* **2009**, *14* (21-22), 1011–1020.
   | DOI: 10.1016/j.drudis.2009.07.014

.. [Roos-Kozel-1981]
   | Roos-Kozel, B.L.; Jorgensen, W.L.
   | Computer-Aided Mechanistic Evaluation of Organic Reactions. 2. Perception of Rings, Aromaticity, and Tautomers.
   | *J. Chem. Inf. Comput. Sci.* **1981**, *21* (2), 101–111.
   | DOI: 10.1021/ci00030a010

.. [Rossi-2007]
   | Rossi, K.A.; Weigelt, C.A.; Nayeem, A.; Krystek, S.R., Jr.
   | Loopholes and Missing Links in Protein Modeling.
   | *Protein Sci.* **2007**, *16* (9), 1999–2012.
   | DOI: 10.1110/ps.072887807

.. [Rush-2005]
   | Rush, T.S.; Grant, J.A.; Mosyak, L.; Nicholls, A.
   | A Shape-Based 3-D Scaffold Hopping Method and Its Application to a Bacterial Protein–Protein Interaction.
   | *J. Med. Chem.* **2005**, *48* (5), 1489–1495.
   | DOI: 10.1021/jm040163o

.. [Seidler-2003]
   | Seidler, J.; McGovern, S.L.; Doman, T.N.; Shoichet, B.K.
   | Identification and Prediction of Promiscuous Aggregating Inhibitors among Known Drugs.
   | *J. Med. Chem.* **2003**, *46* (21), 4477–4486.
   | DOI: 10.1021/jm030191r

.. [Shannon-1949]
   | Shannon, C.E.; Weaver, W.
   | *The Mathematical Theory of Communication*; University of Illinois Press, 1949.
   | ISBN 0252725484

.. [Sharp-1990]
   | Sharp, K.A.; Honig, B.
   | Electrostatic Interactions in Macromolecules: Theory and Applications.
   | *Annu. Rev. Biophys. Biophys. Chem.* **1990**, *19* (1), 301–332.
   | DOI: 10.1146/annurev.bb.19.060190.001505

.. [Sharp-1991]
   | Sharp, K.A.; Nicholls, A.; Fine, R.F.; Honig, B.
   | Reconciling the Magnitude of the Microscopic and Macroscopic Hydrophobic Effects.
   | *Science* **1991**, *252* (5002), 106–109.
   | DOI: 10.1126/science.2011744

.. [Sheridan-2002]
   | Sheridan, R.P.
   | The Most Common Chemical Replacements in Drug-Like Compounds.
   | *J. Chem. Inf. Comput. Sci.* **2002**, *42* (1), 103–108.
   | DOI: 10.1021/ci0100806

.. [Sheridan-2008]
   | Sheridan, R.P.; McGaughey, G.B.; Cornell, W.D.
   | Multiple Protein Structures and Multiple Ligands: Effects on the Apparent Goodness of Virtual Screening Results.
   | *J. Comput.-Aided Mol. Des.* **2008**, *22* (3–4), 257–265.
   | DOI: 10.1007/s10822-008-9168-9

.. [Spellmeyer-1997]
   | Spellmeyer, D.C.; Wong, A.K.; Bower, M.J.; Blaney, J.M.
   | Conformational Analysis using Distance Geometry Methods.
   | *J. Mol. Graphics Modell.* **1997**, *15* (1), 18–36.
   | DOI: 10.1016/s1093-3263(97)00014-4

.. .. [Stahl-2001]
   | Stahl, M.T.
   | *You Want Conformers?  I'll Give You Conformers!*
   | 2nd Annual OpenEye Customers, Users, and Programmers Meeting, Santa Fe, NM, 2001.

.. .. [Stahl-2002]
   | Stahl, M.T.
   | *Omega, AESOP, and Other Cautionary Tales of Naming Programs.*
   | 3rd Annual OpenEye Customers, Users, and Programmers Meeting, Santa Fe, NM, 2002.

.. [Sutherland-2007]
   | Sutherland, J.J.; Nandigam, R.K.; Erickson, J.A.; Vieth, M.
   | Lessons in Molecular Recognition. 2. Assessing and Improving Cross-Docking Accuracy.
   | *J. Chem., Inf. Model.* **2007**, *47* (6), 2293–2302.
   | DOI: 10.1021/ci700253h

.. [Sutton-1958]
   | Sutton, L.E.; Bowen, H.J.M.
   | *Tables of Interatomic Distances and Configuration in Molecules and Ions*.
   | Compiled by H.J.M. Bowen et al. Scientific Editor: L.E. Sutton; assistant scientific editor D.G. Jenkin; general editors A.D. Mitchell and L.C. Cross.
   | Issue 11 of Special Publication, Chemical Society London **1958**.
   | ISSN 0577-618X

.. [Takahashi-1994]
   | Takahashi, Y.
   | Automatic Extraction of Ring Substructures from a Chemical Structure.
   | *J. Chem. Inf. Comput. Sci.* **1994**, *34* (1), 167–170.
   | DOI: 10.1021/ci00017a021

.. .. [Thompson-1933]
   | Thompson, W.R.
   | On the Likelihood That One Unknown Probability Exceeds Another in View of the Evidence of Two Samples.
   | *Biometrika* **1933**, *25* (3–4), 285–294.
   | DOI: 10.2307/2332286

.. [Tu-2012]
   | Tu, M.; Rai, B.; Mathiowetz, A.; Didiuk, M.; Pfefferkorn, J.; Guzman-Perez, A.; Benbow, J.; Guimarães, C.; Mente, S.; Hayward, M.; Liras, S.
   | Exploring Aromatic Chemical Space with NEAT: Novel and Electronically Equivalent Aromatic Template.
   | *J. Chem. Inf. Model.* **2012**, *52* (5), 1114–1123.
   | DOI: 10.1021/ci300031s

.. [Tuccinardi-2010]
   | Tuccinardi, T.; Botta, M.; Giordano, A.; Martinelli, A.
   | Protein Kinases: Docking and Homology Modeling Reliability.
   | *J. Chem. Inf. Model.* **2010**, *50* (8), 1432–1441.
   | DOI: 10.1021/ci100161z

.. [Ujváry-2003]
   | Ujváry, I.; Györffy, W; Lopata, A.
   | Fragment-Based Drug Design using Stereoisomers. A Case Study of Analogues of the Phenol Group in the Bioster Database.
   | *Acta Pharm. Hung.* **2003**, *73* (3), 163–169.
   | PMID: 15112439

.. [Ullman-1976]
   | Ullman, J.R.
   | An Algorithm for Subgraph Isomorphism.
   | *J. Assoc. Comput. Mach.* **1976**, *23* (1), 31–42.
   | DOI: 10.1145/321921.321925

.. [Veber-2002]
   | Veber, D.F.; Johnson, S.R.; Cheng, H.-Y.; Smith, B.R.; Ward, K.W.; Kopple, K.D.
   | Molecular Properties that Influence the Oral Bioavailability of Drug Candidates.
   | *J. Med. Chem.* **2002**, *45* (12), 2615–2623.
   | DOI: 10.1021/jm020017n

.. [Venhorst-2008]
   | Venhorst, J.; Núñez, S.; Terpstra, J.W.; Kruse, C.G.
   | Assessment of Scaffold Hopping Efficiency by Use of Molecular Interaction Fingerprints.
   | *J. Med. Chem.* **2008**, *51* (11), 3222–3229.
   | DOI: 10.1021/jm8001058

.. [Verkhivker-2000]
   | Verkhivker, G.M.; Bouzida, D.; Gehlhaar, D.K.; Rejto, P.A.; Arthurs, S.; Colson, A.B.; Freer, S.T.; Larson, V.; Luty, B.A.; Marrone, T.; et al.
   | Deciphering Common Failures in Molecular Docking of Ligand-Protein Complexes.
   | *J. Comput.-Aided Mol. Des.* **2000**, *14* (8), 731–751.
   | DOI: 10.1023/a:1008158231558

.. [Verloop-1987]
   | Verloop, A.
   | The STERIMOL Approach to Drug Design, Marcel Dekker, New York, 1987.

.. [Vidal-2005]
   | Vidal, D.; Thormann, M.; Pons, M.
   | LINGO, an Efficient Holographic Text Based Method To Calculate Biophysical Properties and Intermolecular Similarities.
   | *J. Chem. Inf. Model.* **2005**, *45* (2), 386–393.
   | DOI: 10.1021/ci0496797

.. [Vidal-2006]
   | Vidal, D.; Thormann, M.; Pons, M.
   | A Novel Search Engine for Virtual Screening of Very Large Databases.
   | *J. Chem. Inf. Model.* **2006**, *46* (2), 836–843.
   | DOI: 10.1021/ci050458q

.. [Wang-J-2000]
   | Wang, J.; Cieplak, P.; Kollman, P.A.
   | How Well Does a Restrained Electrostatic Potential (RESP) Model Perform in Calculating Conformational Energies of Organic and Biological Molecules?
   | *J. Comput. Chem.* **2000**, *21* (12), 1049–1074.
   | DOI: 10.1002/1096-987x(200009)21:12<1049::aid-jcc3>3.0.co;2-f

.. [Wang-R-1997]
   | Wang, R.; Ying, F.; Lai, L.
   | A New Atom-Additive Method for Calculating Partition Coefficients.
   | *J. Chem. Inf. Comput. Sci.* **1997**, *37* (3), 615–621.
   | DOI: 10.1021/ci960169p

.. [Wang-T-1997]
   | Wang, T.; Zhou, J.
   | EMCSS: A New Method for Maximal Common Substructure Search.
   | *J. Chem. Inf. Comput. Sci.* **1997**, *37* (5), 828–834.
   | DOI: 10.1021/ci9601675

.. [Warner-2010]
   | Warner, D.J.; Griffen, E.J.; St-Gallay, S.A.
   | WizePairZ: A Novel Algorithm to Identify, Encode and Exploit Matched Molecular Pairs with Unspecified Cores in Medicinal Chemistry.
   | *J. Chem. Inf. Model.* **2010**, *50* (8), 1350–1357.
   | DOI: 10.1021/ci100084s

.. [Warren-2012]
   | Warren, G.L.; Do, T.D.; Kelley, B.P.; Nicholls, A.; Warren, S.D.
   | Essential Considerations for Using Protein–Ligand Structures in Drug Discovery.
   | *Drug Discov. Today* **2012**, *17* (23–24), 1270–1281.
   | DOI: 10.1016/j.drudis.2012.06.011

.. [Watson-2001]
   | Watson, P.; Willett, P.; Gillet, V.J.; Verdonk, M.L.
   | Calculating the Knowledge-Based Similarity of Functional Groups Using Crystallographic Data.
   | *J. Comput.-Aided Mol. Des.* **2001**, *15*, 835–857.
   | DOI: 10.1023/a:1013115500749

.. [Watts-2014]
   | Watts, K.S.; Dalal, P.; Tebben, A.J.; Cheney, D.L.; Shelley, J.C.
   | Macrocycle Conformational Sampling with MacroModel.
   | *J. Chem. Inf. Model.* **2014**, *54* (10), 2680–2696.
   | DOI: 10.1021/ci5001696

.. [Weininger-1988]
   | Weininger, D.
   | SMILES: A Chemical Language and Information System: 1. Introduction to Methodology and Encoding Rules.
   | *J. Chem. Inf. Comput. Sci.* **1988**, *28* (1), 31–36.
   | DOI: 10.1021/ci00057a005

.. [Weininger-1989]
   | Weininger, D.; Weininger, A.; Weininger, J.L.
   | SMILES 2: Algorithm for Generation of Unique SMILES Notation.
   | *J. Chem. Inf. Comput. Sci.* **1989**, *29* (2), 97–101.
   | DOI: 10.1021/ci00062a008

.. [Wiberg-1966]
   | Wiberg, K.B.
   | Application of the Pople-Santry-Segal CNDO Method to the Cyclopropylcarbinyl and Cyclobutyl Cation and to Bicyclobutane.
   | *Tetrahedron* **1966**, *24* (3), 1083–1096.
   | DOI: 10.1016/0040-4020(68)88057-3

.. .. [Wlodek-2006]
   | Wlodek, S.; Skillman, A.G.; Nicholls, A.
   | Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
   | *Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
   | DOI: 10.1107/s0907444906016076

.. [Wlodek-2010]
   | Wlodek, S.; Skillman, A.G.; Nicholls, A.
   | Ligand Entropy in Gas-Phase, Upon Solvation and Protein Complexation. Fast Estimation with Quasi-Newton Hessian.
   | *J. Chem. Theory Comput.* **2010**, *6* (7), 2140–2152.
   | DOI: 10.1021/ct100095p

.. [Yalkowsky-1980]
   | Yalkowsky, S.H.; Valvani, S.C.
   | Solubility and Partitioning I: Solubility of Nonelectrolytes in Water.
   | *J. Pharm. Sci.* **1980**, *69* (8), 912–922.
   | DOI: 10.1002/jps.2600690814

.. [Zamora-1976]
   | Zamora, A.
   | An Algorithm for Finding the Smallest Set of Smallest Rings.
   | *J. Chem. Inf. Comput. Sci.* **1976**, *16* (1), 40–43.
   | DOI: 10.1021/ci60005a013

.. [Zardecki-2022]
   | Zardecki, C.; Dutta, S.; Goodsell, D.S.; Lowe, R.; Voigt, M.; Burley, S.K.
   | PDB-101: Educational resources supporting molecular explorations through biology and medicine.
   | *Protein Sci.* **2022**, *31* (1), 129-140.
   | DOI: 10.1002/pro.4200

.. [Zhang-2012]
   | Tianhong Zhang; Hongli Li; Hualin Xi; Robert V. Stanton; Sergio H. Rotstein
   | HELM: A Hierarchical Notation Language for Complex Biomolecule Structure Representation
   | *J. Chem. Inf. Model.* **2012**, *52* (10), 2796−2806.
   | DOI: https://pubs.acs.org/doi/10.1021/ci3001925

.. alpha end



.. _OEBioisostereClasses:

**********************************
Preliminary OEBioisostere Classes
**********************************

.. oe:namespace:: OEBioisostere

.. toctree::

   OEBroodBuildOptions
   OEBroodBuildResult
   OEBroodCluster
   OEBroodClusterBuilder
   OEBroodComboBuilder
   OEBroodDBFilter
   OEBroodDBPacket
   OEBroodFragPrep
   OEBroodGeneralOptions
   OEBroodHit
   OEBroodHitlist
   OEBroodHitlistOptions
   OEBroodMolBuilder
   OEBroodOverlay
   OEBroodOverlayBase
   OEBroodQuery
   OEBroodScore
   OEScoreHitlist
   OEBroodScoreOptions
   OECPDDatabase
   OEDBBuffer
   OEDBBuilder
   OEDBReader
   OEDBScreenOptions
   OEDBWriter
   OEExtrinsicPropOptions
   OEFragConfReader
   OEFragmentOptions
   OEFragOverlay
   OEHitlistBase
   OEHitlistBuilder
   OEHitlistBuilderOptions
   OEIntrinsicPropOptions
   OEMolCTBuilder
   OEMolPropertyOptions
   OESimilarity


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodBuildOptions, BroodBuildOptions

.. _OEBioisostere_OEBroodBuildOptions:

.. oe:class:: OEBroodBuildOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodBuildOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for building molecules
   with replaced fragments. These options are used both from 
   :ref:`OEBroodMolBuilder<OEBioisostere_OEBroodMolBuilder>` and
   :ref:`OEHitlistBuilder<OEBioisostere_OEHitlistBuilder>`.

   The :ref:`OEBroodBuildOptions <OEBioisostere_OEBroodBuildOptions>` class defines the following public methods:
    * :oe:meth:`GetBuildType<OEBioisostere::OEBroodBuildOptions::GetBuildType>` and
      :oe:meth:`SetBuildType<OEBioisostere::OEBroodBuildOptions::SetBuildType>`
    * :oe:meth:`GetNeutralPH<OEBioisostere::OEBroodBuildOptions::GetNeutralPH>` and
      :oe:meth:`SetNeutralPH<OEBioisostere::OEBroodBuildOptions::SetNeutralPH>`
    * :oe:meth:`GetTautomers<OEBioisostere::OEBroodBuildOptions::GetTautomers>` and
      :oe:meth:`SetTautomers<OEBioisostere::OEBroodBuildOptions::SetTautomers>`
    * :oe:meth:`GetCheckBond<OEBioisostere::OEBroodBuildOptions::GetCheckBond>` and
      :oe:meth:`SetCheckBond<OEBioisostere::OEBroodBuildOptions::SetCheckBond>`
    * :oe:meth:`GetMaxLocalStrain<OEBioisostere::OEBroodBuildOptions::GetMaxLocalStrain>` and
      :oe:meth:`SetMaxLocalStrain<OEBioisostere::OEBroodBuildOptions::SetMaxLocalStrain>`
    * :oe:meth:`GetDeltaLocalStrain<OEBioisostere::OEBroodBuildOptions::GetDeltaLocalStrain>` and
      :oe:meth:`SetDeltaLocalStrain<OEBioisostere::OEBroodBuildOptions::SetDeltaLocalStrain>`

   

   .. _OEBioisostere_OEBroodBuildOptions_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodBuildOptions()
            OEBroodBuildOptions(const OEBroodBuildOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodBuildOptions() -> OEBroodBuildOptions
            OEBroodBuildOptions(arg2: OEBroodBuildOptions) -> OEBroodBuildOptions

      Default and copy constructors.

   .. _OEBioisostere_OEBroodBuildOptions_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEBroodBuildOptions &operator=(const OEBroodBuildOptions &)

      Assignment operator.

   .. _OEBioisostere_OEBroodBuildOptions_GetBuildType:

   .. oe:method:: GetBuildType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetBuildType() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildType() -> int

      See :oe:meth:`SetBuildType<OEBioisostere::OEBroodBuildOptions::SetBuildType>` method.

   .. _OEBioisostere_OEBroodBuildOptions_GetNeutralPH:

   .. oe:method:: GetNeutralPH

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetNeutralPH() const

      .. oe:language:: python

         .. oe:api:: python

            GetNeutralPH() -> bool

      See :oe:meth:`SetNeutralPH<OEBioisostere::OEBroodBuildOptions::SetNeutralPH>` method.

   .. _OEBioisostere_OEBroodBuildOptions_GetTautomers:

   .. oe:method:: GetTautomers

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetTautomers() const

      .. oe:language:: python

         .. oe:api:: python

            GetTautomers() -> bool

      See :oe:meth:`SetTautomers<OEBioisostere::OEBroodBuildOptions::SetTautomers>` method.

   .. _OEBioisostere_OEBroodBuildOptions_GetCheckBond:

   .. oe:method:: GetCheckBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCheckBond() const

      .. oe:language:: python

         .. oe:api:: python

            GetCheckBond() -> bool

      See :oe:meth:`SetCheckBond<OEBioisostere::OEBroodBuildOptions::SetCheckBond>` method.

   .. _OEBioisostere_OEBroodBuildOptions_GetMaxLocalStrain:

   .. oe:method:: GetMaxLocalStrain

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMaxLocalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxLocalStrain() -> float

      See :oe:meth:`SetMaxLocalStrain<OEBioisostere::OEBroodBuildOptions::SetMaxLocalStrain>` method.

   .. _OEBioisostere_OEBroodBuildOptions_SetBuildType:

   .. oe:method:: SetBuildType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBuildType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetBuildType(value: int) -> bool

      Sets if **Build Type** to be applied in constructing the new analogs.
      Possible choices of methods are described in
      :ref:`OEBroodBuildType <OEBioisostere_OEBroodBuildType>`.
      Default: :ref:`Optimize3D <OEBioisostere_OEBroodBuildType_Optimize3D>`.

   .. _OEBioisostere_OEBroodBuildOptions_SetNeutralPH:

   .. oe:method:: SetNeutralPH

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNeutralPH(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetNeutralPH(value: bool) -> bool

      Sets if **Neutral pH model** to be applied on newly constructed analogs.
      **Default: True.**

   .. _OEBioisostere_OEBroodBuildOptions_SetTautomers:

   .. oe:method:: SetTautomers

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTautomers(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetTautomers(value: bool) -> bool

      Sets if **Reasonable tautomer model** to be applied on newly constructed analogs.
      **Default: False.**

   .. _OEBioisostere_OEBroodBuildOptions_SetCheckBond:

   .. oe:method:: SetCheckBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCheckBond(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetCheckBond(value: bool) -> bool

      Sets if **Bond stability should be checked** in generating hitlist.
      **Default: True.**

   .. _OEBioisostere_OEBroodBuildOptions_SetMaxLocalStrain:

   .. oe:method:: SetMaxLocalStrain

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxLocalStrain(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxLocalStrain(value: float) -> bool

      Sets the **Number allowable local strain** in the generated hits.
      **Default: 6.5.**

   .. _OEBioisostere_OEBroodBuildOptions_GetDeltaLocalStrain:

   .. oe:method:: GetDeltaLocalStrain

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetDeltaLocalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeltaLocalStrain() -> bool

      See :oe:meth:`SetDeltaLocalStrain<OEBioisostere::OEBroodBuildOptions::SetDeltaLocalStrain>` method.

   .. _OEBioisostere_OEBroodBuildOptions_SetDeltaLocalStrain:

   .. oe:method:: SetDeltaLocalStrain

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDeltaLocalStrain(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetDeltaLocalStrain(value: bool) -> bool

      Sets if **relative local strain** between the query fragment and the analog
      should be used as a measure of strain, rather than the absolute local strain
      of the analog alone.
      **Default: False.**


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodBuildResult, BroodBuildResult

.. _OEBioisostere_OEBroodBuildResult:

.. oe:class:: OEBroodBuildResult

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodBuildResult

   This class stores the outcome of building a candidate molecule from a scored
   replacement, build status, Tanimoto combo, local strain, and delta local strain etc, 
   used for downstream filtering and analysis. This works as a container of output
   from :ref:`OEBroodMolBuilder <OEBioisostere_OEBroodMolBuilder>`.

   The :ref:`OEBroodBuildResult <OEBioisostere_OEBroodBuildResult>` class defines the following public methods:
    * :oe:meth:`GetBuildStatus<OEBioisostere::OEBroodBuildResult::GetBuildStatus>`
    * :oe:meth:`GetDeltaLocalStrain<OEBioisostere::OEBroodBuildResult::GetDeltaLocalStrain>`
    * :oe:meth:`GetLocalStrain<OEBioisostere::OEBroodBuildResult::GetLocalStrain>`
    * :oe:meth:`GetMolTanimotoCombo<OEBioisostere::OEBroodBuildResult::GetMolTanimotoCombo>`

   .. _OEBioisostere_OEBroodBuildResult_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodBuildResult()
            OEBroodBuildResult(const OEBroodBuildResult&)
            OEBroodBuildResult& operator=(const OEBroodBuildResult&)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodBuildResult() -> OEBroodBuildResult
            OEBroodBuildResult(arg2: OEBroodBuildResult) -> OEBroodBuildResult

      Default constructors.

   .. _OEBioisostere_OEBroodBuildResult_GetBuildStatus:

   .. oe:method:: GetBuildStatus

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetBuildStatus() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildStatus() -> int

      This method returns the status code indicating the result of the build operation.
      See the :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>` for possible values.

   .. _OEBioisostere_OEBroodBuildResult_GetDeltaLocalStrain:

   .. oe:method:: GetDeltaLocalStrain

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDeltaLocalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeltaLocalStrain() -> float

      This method returns the change in local strain energy relative to the query fragment.

   .. _OEBioisostere_OEBroodBuildResult_GetLocalStrain:

   .. oe:method:: GetLocalStrain

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLocalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetLocalStrain() -> float

      This method returns the local strain value computed for the built molecule.

   .. _OEBioisostere_OEBroodBuildResult_GetMolTanimotoCombo:

   .. oe:method:: GetMolTanimotoCombo

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMolTanimotoCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolTanimotoCombo() -> float

      This method returns the combined Tanimoto score (shape and color) for the built molecule.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodCluster, BroodCluster

.. _OEBioisostere_OEBroodCluster:

.. oe:class:: OEBroodCluster

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodCluster

   This class represents a cluster of bioisosteric hits grouped by structural
   similarity. Each cluster has a head hit and optional member hits that are
   considered similar to that head under the clustering mode.

   The :ref:`OEBroodCluster <OEBioisostere_OEBroodCluster>` class defines the following public methods:
    * :oe:meth:`Count<OEBioisostere::OEBroodCluster::Count>`
    * :oe:meth:`GetHead<OEBioisostere::OEBroodCluster::GetHead>`
    * :oe:meth:`GetInterest<OEBioisostere::OEBroodCluster::GetInterest>`
    * :oe:meth:`GetMembers<OEBioisostere::OEBroodCluster::GetMembers>`
    * :oe:meth:`GetRank<OEBioisostere::OEBroodCluster::GetRank>`
    * :oe:meth:`operator<OEBioisostere::OEBroodCluster::operator>`

   .. _OEBioisostere_OEBroodCluster_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodCluster()
            OEBroodCluster(const OEBroodCluster&)
            OEBroodCluster& operator=(const OEBroodCluster&)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodCluster() -> OEBroodCluster
            OEBroodCluster(arg2: OEBroodCluster) -> OEBroodCluster

      Default and copy constructors.

   .. _OEBioisostere_OEBroodCluster_Count:
   .. oe:method:: Count

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Count() const

      .. oe:language:: python

         .. oe:api:: python

            Count() -> int

      This method returns the total number of hits in the cluster (head + members).

   .. _OEBioisostere_OEBroodCluster_GetHead:
   .. oe:method:: GetHead

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEBroodHit& GetHead() const

      .. oe:language:: python

         .. oe:api:: python

            GetHead() -> OEBroodHit

      This method returns the cluster head hit, which serves as the representative hit for
      the cluster.

   .. _OEBioisostere_OEBroodCluster_GetInterest:
   .. oe:method:: GetInterest

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetInterest() const

      .. oe:language:: python

         .. oe:api:: python

            GetInterest() -> float

      This method returns the computed interest score used to prioritize this cluster during
      ranking. Larger values indicate clusters that are more favorable for
      follow-up inspection.

   .. _OEBioisostere_OEBroodCluster_GetMembers:
   .. oe:method:: GetMembers

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<OEBroodHit>& GetMembers() const

      .. oe:language:: python

         .. oe:api:: python

            GetMembers() -> OEBroodHitVector

      This method returns a reference to the vector of member hits in the cluster.

   .. _OEBioisostere_OEBroodCluster_GetRank:
   .. oe:method:: GetRank

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetRank() const

      .. oe:language:: python

         .. oe:api:: python

            GetRank() -> int

      This method returns the rank assigned by
      :oe:meth:`Rank<OEBioisostere::OEBroodClusterBuilder::Rank>`.

   .. _OEBioisostere_OEBroodCluster_operator:
   .. oe:method:: operator

      .. oe:language:: c++

         .. oe:api::

            bool operator>(const OEBroodCluster& rhs) const

      This is a comparison operator for sorting clusters by interest score (higher
      interest ranks ahead of lower interest).



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodClusterBuilder, BroodClusterBuilder

.. _OEBioisostere_OEBroodClusterBuilder:

.. oe:class:: OEBroodClusterBuilder

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodClusterBuilder

   This class builds and organizes bioisosteric hits into clusters based on
   structural similarity and optionally ranks them by calculated interest scores.
   See the :ref:`cluster <section_examples_cluster>` example.

   The :ref:`OEBroodClusterBuilder <OEBioisostere_OEBroodClusterBuilder>` class defines the following public methods:
    * :oe:meth:`Add<OEBioisostere::OEBroodClusterBuilder::Add>`
    * :oe:meth:`GetClusters<OEBioisostere::OEBroodClusterBuilder::GetClusters>`
    * :oe:meth:`Rank<OEBioisostere::OEBroodClusterBuilder::Rank>`

   .. _OEBioisostere_OEBroodClusterBuilder_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodClusterBuilder(const OEChem::OEMolBase& molQuery,
                                  const bool fragment = false)
            OEBroodClusterBuilder(const OEBroodQuery& query)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodClusterBuilder(query: OEBroodQuery) -> OEBroodClusterBuilder
            OEBroodClusterBuilder(molQuery: Union[OEGraphMol,OEMol,OEQMol],
                                  fragment: bool = False) -> OEBroodClusterBuilder

      This method constructs an :ref:`OEBroodClusterBuilder <OEBioisostere_OEBroodClusterBuilder>`
      from either a query molecule or an :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>`.
      The ``fragment`` flag controls clustering mode: fragment-centric
      (``true``) or full-molecule-centric (``false``).

   .. _OEBioisostere_OEBroodClusterBuilder_Add:

   .. oe:method:: Add

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Add(const std::vector<OEBroodHit>& vecHits)

      .. oe:language:: python

         .. oe:api:: python

            Add(vecHits: OEBroodHitVector) -> bool

      This method adds one or more hits to the cluster builder. The builder groups similar hits
      into clusters as they are added.

   .. _OEBioisostere_OEBroodClusterBuilder_GetClusters:

   .. oe:method:: GetClusters

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<OEBroodCluster>& GetClusters() const

      .. oe:language:: python

         .. oe:api:: python

            GetClusters() -> OEBroodClusterVector

      This method returns a reference to the vector of clusters created by the builder.

   .. _OEBioisostere_OEBroodClusterBuilder_Rank:

   .. oe:method:: Rank

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Rank()

      .. oe:language:: python

         .. oe:api:: python

            Rank() -> bool

      This method computes cluster priority scores and assigns final cluster ranks.
      Call this method before consuming ranked output from
      :oe:meth:`GetClusters<OEBioisostere::OEBroodClusterBuilder::GetClusters>`.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodComboBuilder, BroodComboBuilder

.. _OEBioisostere_OEBroodComboBuilder:

.. oe:class:: OEBroodComboBuilder

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodComboBuilder

   This class enables multipoint bioisosteric exploration by combining
   overlaid fragments from different query replacements of the same molecule into a single
   composite hit. Given a primary :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` and
   its corresponding :ref:`OEBroodHit <OEBioisostere_OEBroodHit>`, a second query can be
   applied to the same molecule and the builder merges both fragment replacements into a
   combined result via its :ref:`Build <OEBioisostere_OEBroodComboBuilder_Build>` method.
   See the :ref:`combo_builder <section_examples_combo_builder>` example for a complete
   walkthrough.

   The :ref:`OEBroodComboBuilder <OEBioisostere_OEBroodComboBuilder>` class defines the following public method:
    * :oe:meth:`Build<OEBioisostere::OEBroodComboBuilder::Build>`

   .. _OEBioisostere_OEBroodComboBuilder_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodComboBuilder(const OEBroodQuery& query,
                                const OEBroodHit& hit,
                                const OEBroodGeneralOptions& genOpts = OEBroodGeneralOptions(),
                                const OEBroodBuildOptions& options = OEBroodBuildOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEBroodComboBuilder(query: OEBroodQuery, hit: OEBroodHit,
                                genOpts: OEBroodGeneralOptions = OEBroodGeneralOptions(),
                                options: OEBroodBuildOptions = OEBroodBuildOptions()) -> OEBroodComboBuilder

      This method constructs an :ref:`OEBroodComboBuilder <OEBioisostere_OEBroodComboBuilder>`
      from a secondary query and a previously built primary hit, together with
      general and build options used for the combination step.

   .. _OEBioisostere_OEBroodComboBuilder_Build:

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Build(const OEBroodScore& score, OEBroodHit& hit)

      .. oe:language:: python

         .. oe:api:: python

            Build(score: OEBroodScore, hit: OEBroodHit) -> int

      This method builds a combined hit by applying the replacement encoded in ``score`` to
      the current primary hit context and writing the resulting combined hit to
      ``hit``. It returns a status code from
      :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodDBFilter, BroodDBFilter

.. _OEBioisostere_OEBroodDBFilter:

.. oe:class:: OEBroodDBFilter

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodDBFilter

   This class defines objects that can be used to check if a 
   :ref:`database packet <OEBioisostere_OEBroodDBPacket>` contains
   fragments relevant to a certain :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>`.

   The :ref:`OEBroodDBFilter <OEBioisostere_OEBroodDBFilter>` class defines the following public methods:
    * :oe:meth:`Setup<OEBioisostere::OEBroodDBFilter::Setup>`

   .. _OEBioisostere_OEBroodDBFilter_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodDBFilter()
            OEBroodDBFilter(const OEBroodDBFilter &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodDBFilter() -> OEBroodDBFilter
            OEBroodDBFilter(arg2: OEBroodDBFilter) -> OEBroodDBFilter

      Default and copy constructors.

   .. _OEBioisostere_OEBroodDBFilter_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEBroodDBFilter &operator=(const OEBroodDBFilter &)

      Assignment operator.

   .. _OEBioisostere_OEBroodDBFilter_Setup:
   .. oe:method:: Setup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Setup(const OEBroodQuery& query,
                       const OEBroodGeneralOptions& scoreOpts = OEBroodGeneralOptions())
            bool Setup(OEChem::OEMCMolBase& mol,
                       const OEBroodGeneralOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            Setup(query: OEBroodQuery,
                  opts: OEBroodGeneralOptions = OEBroodGeneralOptions()) -> bool

      This method associates the filter with either a specific
      :ref:`OEBroodQuery<OEBioisostere_OEBroodQuery>` or a prepared
      :ref:`OEMCMolBase <OEChem_OEMCMolBase>`, along with
      :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>`,
      to initialize packet-level filtering constraints.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodDBPacket, BroodDBPacket

.. _OEBioisostere_OEBroodDBPacket:

.. oe:class:: OEBroodDBPacket

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodDBPacket

   This class defines objects that hold a chunk of fragment data from a Brood
   database. A packet contains additional metadata that can be used to check
   relevance for bioisosteric replacement of a specific
   :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>`.

   The :ref:`OEBroodDBPacket <OEBioisostere_OEBroodDBPacket>` class defines the following public methods:
    * :oe:meth:`GetIdx<OEBioisostere::OEBroodDBPacket::GetIdx>`
    * :oe:meth:`GetFragCount<OEBioisostere::OEBroodDBPacket::GetFragCount>`
    * :oe:meth:`GetFrags<OEBioisostere::OEBroodDBPacket::GetFrags>`
    * :oe:meth:`IsValid<OEBioisostere::OEBroodDBPacket::IsValid>`
    * :oe:meth:`Load<OEBioisostere::OEBroodDBPacket::Load>`
    * :oe:meth:`ToRecord <OEBioisostere::OEBroodDBPacket::ToRecord>`

   

   .. _OEBioisostere_OEBroodDBPacket_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodDBPacket()
            OEBroodDBPacket(const OEBroodDBPacket &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodDBPacket() -> OEBroodDBPacket
            OEBroodDBPacket(arg2: OEBroodDBPacket) -> OEBroodDBPacket

      Default and copy constructors.

   .. _OEBioisostere_OEBroodDBPacket_operator=:
   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBroodDBPacket &operator=(const OEBroodDBPacket &)

      Assignment operator.

   .. _OEBioisostere_OEBroodDBPacket_GetIdx:

   .. oe:method:: GetIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdx() -> int

      Returns the index corresponding to database storage.

   .. _OEBioisostere_OEBroodDBPacket_GetFragCount:

   .. oe:method:: GetFragCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetFragCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragCount() -> int

      Returns the number of fragments contained in the packet.

   .. _OEBioisostere_OEBroodDBPacket_GetFrags:

   .. oe:method:: GetFrags

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEMCMolBase>* GetFrags() const

      .. oe:language:: python

         .. oe:api:: python

            GetFrags() -> Iterable[OEMol]

      Returns fragments that are contained in the packet.

   .. _OEBioisostere_OEBroodDBPacket_IsValid:

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid(const OEBroodDBFilter& filter)

      .. oe:language:: python

         .. oe:api:: python

            IsValid(filter: OEBroodDBFilter) -> bool

      Returns whether packet contents are relevant for the
      :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` associated with the
      :ref:`OEBroodDBFilter <OEBioisostere_OEBroodDBFilter>`.

   .. _OEBioisostere_OEBroodDBPacket_Load:

   .. oe:method:: Load

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Load(const OEDataFlow::OERecord &)

      .. oe:language:: python

         .. oe:api:: python

            Load(arg2: OERecord) -> bool

      Loads packet contents from an :ref:`OERecord <OEDataFlow_OERecord>`.

   .. _OEBioisostere_OEBroodDBPacket_ToRecord:

   .. oe:method:: ToRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ToRecord(OEDataFlow::OERecord &) const

      .. oe:language:: python

         .. oe:api:: python

            ToRecord(arg2: OERecord) -> bool

      Saves packet contents into an :ref:`OERecord <OEDataFlow_OERecord>`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodFragPrep, BroodFragPrep

.. _OEBioisostere_OEBroodFragPrep:

.. oe:class:: OEBroodFragPrep

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodFragPrep

   This class provides facilities to prepare fragments for overlay calculations
   using :ref:`OEBroodOverlay <OEBioisostere_OEBroodOverlay>` or
   :ref:`OEFragOverlay <OEBioisostere_OEFragOverlay>`.

   The :ref:`OEBroodFragPrep <OEBioisostere_OEBroodFragPrep>` class defines the following public methods:
    * :oe:meth:`Prep<OEBioisostere::OEBroodFragPrep::Prep>`

   

   .. _OEBioisostere_OEBroodFragPrep_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodFragPrep()

      .. oe:language:: python

         .. oe:api:: python

            OEBroodFragPrep() -> OEBroodFragPrep

      Default constructor.

   .. _OEBioisostere_OEBroodFragPrep_Prep:
   .. oe:method:: Prep

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Prep(OEChem::OEMCMolBase& fragment)

      .. oe:language:: python

         .. oe:api:: python

            Prep(fragment: OEMol) -> bool

      Prepares the specified fragment for overlay optimization.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodGeneralOptions, BroodGeneralOptions

.. _OEBioisostere_OEBroodGeneralOptions:

.. oe:class:: OEBroodGeneralOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodGeneralOptions : public OESystem::OEOptions

   This class provides an interface to setup basic options related to 
   bioisosteric fragment replacement.

   The :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>` class defines the following public methods:
    * :oe:meth:`GetAttachScale<OEBioisostere::OEBroodGeneralOptions::GetAttachScale>` and
      :oe:meth:`SetAttachScale<OEBioisostere::OEBroodGeneralOptions::SetAttachScale>`
    * :oe:meth:`GetBumpRadius<OEBioisostere::OEBroodGeneralOptions::GetBumpRadius>` and
      :oe:meth:`SetBumpRadius<OEBioisostere::OEBroodGeneralOptions::SetBumpRadius>`
    * :oe:meth:`GetScoreType<OEBioisostere::OEBroodGeneralOptions::GetScoreType>` and
      :oe:meth:`SetScoreType<OEBioisostere::OEBroodGeneralOptions::SetScoreType>`
    * :oe:meth:`GetIgnoreProtein<OEBioisostere::OEBroodGeneralOptions::GetIgnoreProtein>` and
      :oe:meth:`SetIgnoreProtein<OEBioisostere::OEBroodGeneralOptions::SetIgnoreProtein>`
    * :oe:meth:`GetIgnoreSelectionProtein<OEBioisostere::OEBroodGeneralOptions::GetIgnoreSelectionProtein>` and
      :oe:meth:`SetIgnoreSelectionProtein<OEBioisostere::OEBroodGeneralOptions::SetIgnoreSelectionProtein>`
    * :oe:meth:`GetRangeSize<OEBioisostere::OEBroodGeneralOptions::GetRangeSize>` and
      :oe:meth:`SetRangeSize<OEBioisostere::OEBroodGeneralOptions::SetRangeSize>`
    * :oe:meth:`GetRangeOffset<OEBioisostere::OEBroodGeneralOptions::GetRangeOffset>` and
      :oe:meth:`SetRangeOffset<OEBioisostere::OEBroodGeneralOptions::SetRangeOffset>`
    * :oe:meth:`GetRingOnly<OEBioisostere::OEBroodGeneralOptions::GetRingOnly>` and
      :oe:meth:`SetRingOnly<OEBioisostere::OEBroodGeneralOptions::SetRingOnly>`

   

   .. _OEBioisostere_OEBroodGeneralOptions_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodGeneralOptions()
            OEBroodGeneralOptions(const OEBroodGeneralOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodGeneralOptions() -> OEBroodGeneralOptions
            OEBroodGeneralOptions(arg2: OEBroodGeneralOptions) -> OEBroodGeneralOptions

      Default and copy constructors.

   .. _OEBioisostere_OEBroodGeneralOptions_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEBroodGeneralOptions &operator=(const OEBroodGeneralOptions &)

      Assignment operator.

   .. _OEBioisostere_OEBroodGeneralOptions_GetAttachScale:
   .. oe:method:: GetAttachScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetAttachScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetAttachScale() -> float

      See :oe:meth:`SetAttachScale<OEBioisostere::OEBroodGeneralOptions::SetAttachScale>` method.

   .. _OEBioisostere_OEBroodGeneralOptions_GetBumpRadius:
   .. oe:method:: GetBumpRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBumpRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetBumpRadius() -> float

      See :oe:meth:`SetBumpRadius<OEBioisostere::OEBroodGeneralOptions::SetBumpRadius>` method.

   .. _OEBioisostere_OEBroodGeneralOptions_GetScoreType:
   .. oe:method:: GetScoreType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetScoreType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreType() -> int

      See :oe:meth:`SetScoreType<OEBioisostere::OEBroodGeneralOptions::SetScoreType>` method.

   .. _OEBioisostere_OEBroodGeneralOptions_SetAttachScale:
   .. oe:method:: SetAttachScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAttachScale(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetAttachScale(value: float) -> bool

      Sets the **scaling factor** for attachment point scores. This value determines the 
      balance between the chemical color score and the attachment point scores. Higher values 
      indicate more weighting for the attachment-point alignment.
      **Default: 1.5.**

   .. _OEBioisostere_OEBroodGeneralOptions_SetBumpRadius:
   .. oe:method:: SetBumpRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBumpRadius(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetBumpRadius(value: float) -> bool

      Sets the **minimum distance defining clash** between ligand heavy atoms and protein 
      heavy atoms. New analogs with atoms closer than this cutoff to the active-site protein 
      are marked as clashing, and eventually discarded from the hitlist.
      **Default: 2.25.**

   .. _OEBioisostere_OEBroodGeneralOptions_SetScoreType:
   .. oe:method:: SetScoreType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetScoreType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreType(value: int) -> bool

      Sets the **method** to be used for scoring overlap between the query fragment and the
      replacement fragment. Possible choices of methods are described in
      :ref:`OEBroodScoreType <OEBioisostere_OEBroodScoreType>`.
      Default: :ref:`ROCS <OEBioisostere_OEBroodScoreType_ROCS>`.

   .. oe:method:: GetIgnoreProtein

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetIgnoreProtein() const

      .. oe:language:: python

         .. oe:api:: python

            GetIgnoreProtein() -> bool

      See :oe:meth:`SetIgnoreProtein<OEBioisostere::OEBroodGeneralOptions::SetIgnoreProtein>` method.

   .. oe:method:: GetIgnoreSelectionProtein

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetIgnoreSelectionProtein() const

      .. oe:language:: python

         .. oe:api:: python

            GetIgnoreSelectionProtein() -> bool

      See :oe:meth:`SetIgnoreSelectionProtein<OEBioisostere::OEBroodGeneralOptions::SetIgnoreSelectionProtein>` method.

   .. oe:method:: GetRangeSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetRangeSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetRangeSize() -> int

      See :oe:meth:`SetRangeSize<OEBioisostere::OEBroodGeneralOptions::SetRangeSize>` method.

   .. oe:method:: GetRangeOffset

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetRangeOffset() const

      .. oe:language:: python

         .. oe:api:: python

            GetRangeOffset() -> int

      See :oe:meth:`SetRangeOffset<OEBioisostere::OEBroodGeneralOptions::SetRangeOffset>` method.

   .. oe:method:: GetRingOnly

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetRingOnly() const

      .. oe:language:: python

         .. oe:api:: python

            GetRingOnly() -> int

      See :oe:meth:`SetRingOnly<OEBioisostere::OEBroodGeneralOptions::SetRingOnly>` method.

   .. oe:method:: SetIgnoreProtein

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIgnoreProtein(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetIgnoreProtein(value: bool) -> bool

      Sets whether the **protein associated with the query** should be ignored during scoring.
      When true, receptor clash and protein-select checks are skipped even if a protein
      was provided to :oe:func:`OEBioisostere::OECreateBroodQuery`.
      **Default: False.**

   .. oe:method:: SetIgnoreSelectionProtein

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIgnoreSelectionProtein(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetIgnoreSelectionProtein(value: bool) -> bool

      Sets whether the **selectivity protein associated with the query** should be ignored
      during scoring. When true, protein-select scoring is skipped even if a selectivity
      protein was provided to :oe:func:`OEBioisostere::OECreateBroodQuery`.
      **Default: False.**

   .. _OEBioisostere_OEBroodGeneralOptions_SetRangeSize:

   .. oe:method:: SetRangeSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRangeSize(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetRangeSize(value: int) -> bool

      Sets the **range of heavy atom counts** around the query fragment heavy atom count
      to examine from the database. Fragments whose heavy atom count falls outside
      ``[queryHeavy - rangeOffset - rangeSize, queryHeavy - rangeOffset + rangeSize]``
      are skipped.
      **Default: 6.**

   .. _OEBioisostere_OEBroodGeneralOptions_SetRangeOffset:

   .. oe:method:: SetRangeOffset

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRangeOffset(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetRangeOffset(value: int) -> bool

      Sets a **bias toward smaller or larger fragments** relative to the query. A positive
      offset shifts the search window toward larger fragments; a negative offset toward
      smaller fragments. Works together with
      :oe:meth:`SetRangeSize<OEBioisostere::OEBroodGeneralOptions::SetRangeSize>`.
      **Default: 0.**

   .. oe:method:: SetRingOnly

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRingOnly(const int)

      .. oe:language:: python

         .. oe:api:: python

            SetRingOnly(value: int) -> bool

      Sets the **requirement for rings** in selecting a fragment.
      This flag has to do with a count of the number of ring atoms in the shortest path between
      attachment points in a fragment. In cases with more than 2 attachment points, all shortest
      paths are calculated and the number of ring atoms is summed.
      **Default: -2**


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodHit, BroodHit

.. _OEBioisostere_OEBroodHit:

.. oe:class:: OEBroodHit

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodHit

   This class defines objects that contain results corresponding to a
   generated **Brood** hit from bioisosteric replacement.

   The :ref:`OEBroodHit <OEBioisostere_OEBroodHit>` class defines the following public methods:
    * :oe:meth:`GetAbbottBioScore<OEBioisostere::OEBroodHit::GetAbbottBioScore>`
    * :oe:meth:`GetAromaticRingCount<OEBioisostere::OEBroodHit::GetAromaticRingCount>`
    * :oe:meth:`GetAttachScore<OEBioisostere::OEBroodHit::GetAttachScore>`
    * :oe:meth:`GetBeliefScore<OEBioisostere::OEBroodHit::GetBeliefScore>`
    * :oe:meth:`GetBuildRes<OEBioisostere::OEBroodHit::GetBuildRes>`
    * :oe:meth:`GetBuildStatus<OEBioisostere::OEBroodHit::GetBuildStatus>`
    * :oe:meth:`GetColorScore<OEBioisostere::OEBroodHit::GetColorScore>`
    * :oe:meth:`GetComboScore<OEBioisostere::OEBroodHit::GetComboScore>`
    * :oe:meth:`GetComplexity<OEBioisostere::OEBroodHit::GetComplexity>`
    * :oe:meth:`GetDeltaLocalStrain<OEBioisostere::OEBroodHit::GetDeltaLocalStrain>`
    * :oe:meth:`GetEgan<OEBioisostere::OEBroodHit::GetEgan>`
    * :oe:meth:`GetFragSmiles<OEBioisostere::OEBroodHit::GetFragSmiles>`
    * :oe:meth:`GetFrequency<OEBioisostere::OEBroodHit::GetFrequency>`
    * :oe:meth:`GetHeavyCount<OEBioisostere::OEBroodHit::GetHeavyCount>`
    * :oe:meth:`GetIdeaGroup<OEBioisostere::OEBroodHit::GetIdeaGroup>`
    * :oe:meth:`GetIdeaRank<OEBioisostere::OEBroodHit::GetIdeaRank>`
    * :oe:meth:`GetLipinskiAcc<OEBioisostere::OEBroodHit::GetLipinskiAcc>`
    * :oe:meth:`GetLipinskiDon<OEBioisostere::OEBroodHit::GetLipinskiDon>`
    * :oe:meth:`GetLipinskiFail<OEBioisostere::OEBroodHit::GetLipinskiFail>`
    * :oe:meth:`GetLocalStrain<OEBioisostere::OEBroodHit::GetLocalStrain>`
    * :oe:meth:`GetMol<OEBioisostere::OEBroodHit::GetMol>`
    * :oe:meth:`GetMolTanimotoCombo<OEBioisostere::OEBroodHit::GetMolTanimotoCombo>`
    * :oe:meth:`GetMolWt<OEBioisostere::OEBroodHit::GetMolWt>`
    * :oe:meth:`GetRingCount<OEBioisostere::OEBroodHit::GetRingCount>`
    * :oe:meth:`GetRingRatio<OEBioisostere::OEBroodHit::GetRingRatio>`
    * :oe:meth:`GetRotorCount<OEBioisostere::OEBroodHit::GetRotorCount>`
    * :oe:meth:`GetScores<OEBioisostere::OEBroodHit::GetScores>`
    * :oe:meth:`GetShapeScore<OEBioisostere::OEBroodHit::GetShapeScore>`
    * :oe:meth:`GetSourceMolLabel<OEBioisostere::OEBroodHit::GetSourceMolLabel>`
    * :oe:meth:`GetSourceMolSmiles<OEBioisostere::OEBroodHit::GetSourceMolSmiles>`
    * :oe:meth:`GetTPSA<OEBioisostere::OEBroodHit::GetTPSA>`
    * :oe:meth:`GetVeber<OEBioisostere::OEBroodHit::GetVeber>`
    * :oe:meth:`GetXLogP<OEBioisostere::OEBroodHit::GetXLogP>`
    * :oe:meth:`Getfsp3C<OEBioisostere::OEBroodHit::Getfsp3C>`
    * :oe:meth:`Load<OEBioisostere::OEBroodHit::Load>`
    * :oe:meth:`ToRecord<OEBioisostere::OEBroodHit::ToRecord>`

   

   .. _OEBioisostere_OEBroodHit_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodHit()
            OEBroodHit(const OEBroodHit &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodHit() -> OEBroodHit
            OEBroodHit(arg2: OEBroodHit) -> OEBroodHit

      Default and copy constructors.

   .. _OEBioisostere_OEBroodHit_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEBroodHit &operator=(const OEBroodHit &)

      Assignment operator.

   .. _OEBioisostere_OEBroodHit_GetAbbottBioScore: 

   .. oe:method:: GetAbbottBioScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetAbbottBioScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetAbbottBioScore() -> float

      This method returns the Abbott bioavailability score of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetAromaticRingCount: 

   .. oe:method:: GetAromaticRingCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAromaticRingCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetAromaticRingCount() -> int

      This method returns the number of aromatic rings in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetAttachScore: 

   .. oe:method:: GetAttachScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetAttachScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetAttachScore() -> float

      This method returns the attachment score corresponding to fragment matching.

   .. _OEBioisostere_OEBroodHit_GetBeliefScore: 

   .. oe:method:: GetBeliefScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBeliefScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetBeliefScore() -> float
            
      This method returns the belief score of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetBuildRes:

   .. oe:method:: GetBuildRes

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEBroodBuildResult& GetBuildRes() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildRes() -> OEBroodBuildResult

      This method returns a const reference to the :ref:`OEBroodBuildResult <OEBioisostere_OEBroodBuildResult>`
      object containing detailed build status and scoring information.

   .. _OEBioisostere_OEBroodHit_GetBuildStatus:

   .. oe:method:: GetBuildStatus

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetBuildStatus() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildStatus() -> int

      This method returns the status of the built hit. The method returns
      :oe:const:`OEBioisostere::OEBroodStatusCode::Success` if
      the build was successful, otherwise it returns an error code from the
      :oe:constns:`OEBioisostere::OEBroodStatusCode` namespace.

   .. _OEBioisostere_OEBroodHit_GetColorScore: 

   .. oe:method:: GetColorScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetColorScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorScore() -> float

      This method returns the color score corresponding to fragment matching.

   .. _OEBioisostere_OEBroodHit_GetComboScore: 
   
   .. oe:method:: GetComboScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetComboScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetComboScore() -> float

      This method returns the combo (shape+color) score corresponding to fragment matching.

   .. _OEBioisostere_OEBroodHit_GetComplexity: 
   
   .. oe:method:: GetComplexity

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetComplexity() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexity() -> float

      This method returns the complexity of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetDeltaLocalStrain: 

   .. oe:method:: GetDeltaLocalStrain

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDeltaLocalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeltaLocalStrain() -> float
            
      This method returns the calculated delta local strain (HitStrain - QueryStrain) of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetEgan:

   .. oe:method:: GetEgan

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetEgan() const

      .. oe:language:: python

         .. oe:api:: python

            GetEgan() -> int

      This method returns the Egan bioavailability score of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetFragSmiles: 

   .. oe:method:: GetFragSmiles

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetFragSmiles() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragSmiles() -> str

      This method returns the SMILES string corresponding to the replacement fragment.

   .. _OEBioisostere_OEBroodHit_GetFrequency: 
   
   .. oe:method:: GetFrequency

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetFrequency() const

      .. oe:language:: python

         .. oe:api:: python

            GetFrequency() -> int

      This method returns the frequency of the replacement fragment in the database.

   .. _OEBioisostere_OEBroodHit_GetHeavyCount: 

   .. oe:method:: GetHeavyCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetHeavyCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeavyCount() -> int

      This method returns the number of heavy atoms in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetIdeaGroup: 

   .. oe:method:: GetIdeaGroup

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetIdeaGroup() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdeaGroup() -> int

      This method returns the index of the idea group the generated molecule belongs to.

   .. _OEBioisostere_OEBroodHit_GetIdeaRank: 

   .. oe:method:: GetIdeaRank

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetIdeaRank() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdeaRank() -> int

      This method returns the rank of the generated molecule within the idea group it belongs to.

   .. _OEBioisostere_OEBroodHit_GetLipinskiAcc: 

   .. oe:method:: GetLipinskiAcc

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetLipinskiAcc() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipinskiAcc() -> int

      This method returns the number of Lipinski donors in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetLipinskiDon: 
   
   .. oe:method:: GetLipinskiDon

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetLipinskiDon() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipinskiDon() -> int

      This method returns the number of Lipinski acceptors in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetLipinskiFail: 

   .. oe:method:: GetLipinskiFail

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetLipinskiFail() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipinskiFail() -> int

      This method returns the number of Lipinski rule-of-five failures in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetLocalStrain: 

   .. oe:method:: GetLocalStrain

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLocalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetLocalStrain() -> float

      This method returns the calculated local strain in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetMol: 
   
   .. oe:method:: GetMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEGraphMol& GetMol() const

      .. oe:language:: python

         .. oe:api:: python

            GetMol() -> OEGraphMol

      This method returns the generated hit molecule.
   
   .. _OEBioisostere_OEBroodHit_GetMolTanimotoCombo: 

   .. oe:method:: GetMolTanimotoCombo

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMolTanimotoCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolTanimotoCombo() -> float

      This method returns the Tanimoto combo (shape+color) score of the molecule against the query molecule.

   .. _OEBioisostere_OEBroodHit_GetMolWt: 
   
   .. oe:method:: GetMolWt

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMolWt() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolWt() -> float

      This method returns the molecular weight of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetRingCount: 

   .. oe:method:: GetRingCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetRingCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetRingCount() -> int

      This method returns the number of rings in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetRingRatio: 

   .. oe:method:: GetRingRatio

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRingRatio() const

      .. oe:language:: python

         .. oe:api:: python

            GetRingRatio() -> float

      This method returns the ratio of ring atoms to heavy atoms in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetRotorCount: 
   
   .. oe:method:: GetRotorCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetRotorCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotorCount() -> int

      This method returns the number of rotors in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetScores:

   .. oe:method:: GetScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEBroodScore& GetScores() const

      .. oe:language:: python

         .. oe:api:: python

            GetScores() -> OEBroodScore

      This method returns a const reference to the :ref:`OEBroodScore <OEBioisostere_OEBroodScore>`
      object containing detailed scoring information for the hit.

   .. _OEBioisostere_OEBroodHit_GetShapeScore:

   .. oe:method:: GetShapeScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetShapeScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeScore() -> float

      This method returns the shape score corresponding to fragment matching.

   .. _OEBioisostere_OEBroodHit_GetSourceMolLabel: 

   .. oe:method:: GetSourceMolLabel

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetSourceMolLabel() const

      .. oe:language:: python

         .. oe:api:: python

            GetSourceMolLabel() -> str

      This method returns the labels of the source molecules associated with the replacement fragment.

   .. _OEBioisostere_OEBroodHit_GetSourceMolSmiles: 

   .. oe:method:: GetSourceMolSmiles

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetSourceMolSmiles() const

      .. oe:language:: python

         .. oe:api:: python

            GetSourceMolSmiles() -> str

      This method returns the SMILES of the source molecules associated with the replacement fragment.

   .. _OEBioisostere_OEBroodHit_GetTPSA: 
   
   .. oe:method:: GetTPSA

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTPSA() const

      .. oe:language:: python

         .. oe:api:: python

            GetTPSA() -> float

      This method returns the calculated topological polar surface area of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetVeber: 
   
   .. oe:method:: GetVeber

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetVeber() const

      .. oe:language:: python

         .. oe:api:: python

            GetVeber() -> int

      This method returns the Veber bioavailability score of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetXLogP: 
   
   .. oe:method:: GetXLogP

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetXLogP() const

      .. oe:language:: python

         .. oe:api:: python

            GetXLogP() -> float

      This method returns the calculated LogP of the generated molecule.

   .. _OEBioisostere_OEBroodHit_Getfsp3C: 
   
   .. oe:method:: Getfsp3C

      .. oe:language:: c++ java csharp

         .. oe:api::

            double Getfsp3C() const

      .. oe:language:: python

         .. oe:api:: python

            Getfsp3C() -> float

      This method returns the fraction of sp\ :sup:`3` hybridized carbon atoms in the generated molecule.

   .. _OEBioisostere_OEBroodHit_Load: 
   .. oe:method:: Load

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Load(const OEDataFlow::OERecord&)

      .. oe:language:: python

         .. oe:api:: python

            Load(arg2: OERecord) -> bool

      This method loads :ref:`OEBroodHit <OEBioisostere_OEBroodHit>` from the specified
      :ref:`OERecord <OEDataFlow_OERecord>`. It returns ``true`` if successful.

   .. _OEBioisostere_OEBroodHit_ToRecord: 
   .. oe:method:: ToRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ToRecord(OEDataFlow::OERecord&) const

      .. oe:language:: python

         .. oe:api:: python

            ToRecord(arg2: OERecord) -> bool

      This method saves :ref:`OEBroodHit <OEBioisostere_OEBroodHit>` into the specified
      :ref:`OERecord <OEDataFlow_OERecord>`. It returns ``true`` if successful.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodHitlist, BroodHitlist

.. _OEBioisostere_OEBroodHitlist:

.. oe:class:: OEBroodHitlist

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodHitlist: public OEHitlistBase

   This class manages curated, built
   :ref:`OEBroodHit <OEBioisostere_OEBroodHit>` objects and provides final
   hit list filtering behavior for molecule-level results.

   The :ref:`OEBroodHitlist <OEBioisostere_OEBroodHitlist>` class defines the following public methods:
    * :oe:meth:`AddHits<OEBioisostere::OEBroodHitlist::AddHits>`
    * :oe:meth:`Build<OEBioisostere::OEBroodHitlist::Build>`
    * :oe:meth:`GetHits<OEBioisostere::OEBroodHitlist::GetHits>`

   .. _OEBioisostere_OEBroodHitlist_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodHitlist()
            OEBroodHitlist(const OEChem::OEMolBase& mol,
                           const OEBroodHitlistOptions& options = OEBroodHitlistOptions())
            OEBroodHitlist(const OEBroodQuery& query,
                           const OEBroodHitlistOptions& options = OEBroodHitlistOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEBroodHitlist() -> OEBroodHitlist
            OEBroodHitlist(query: OEBroodQuery,
                           options: OEBroodHitlistOptions = OEBroodHitlistOptions()) -> OEBroodHitlist
            OEBroodHitlist(mol: Union[OEGraphMol,OEMol,OEQMol],
                           options: OEBroodHitlistOptions = OEBroodHitlistOptions()) -> OEBroodHitlist

      This method constructs an :ref:`OEBroodHitlist <OEBioisostere_OEBroodHitlist>` either
      with no arguments (default), with a query molecule and options, or with
      an :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` and options.

   .. _OEBioisostere_OEBroodHitlist_AddHits:

   .. oe:method:: AddHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddHits(const std::vector<OEBroodHit>&)

      .. oe:language:: python

         .. oe:api:: python

            AddHits(arg2: OEBroodHitVector) -> bool

      This method adds a batch of :ref:`OEBroodHit <OEBioisostere_OEBroodHit>` objects to
      the hit list.

   .. _OEBioisostere_OEBroodHitlist_Build:

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Build(const bool final = true) override

      .. oe:language:: python

         .. oe:api:: python

            Build(final: bool = True) -> bool

      This method builds the final hit list from all added hits, filtering duplicates
      and applying scored-based filtering if configured.

   .. _OEBioisostere_OEBroodHitlist_GetHits:

   .. oe:method:: GetHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<OEBroodHit>& GetHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetHits() -> OEBroodHitVector

      This method returns a reference to the vector of final :ref:`OEBroodHit <OEBioisostere_OEBroodHit>`
      objects after building and filtering.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodHitlistOptions, BroodHitlistOptions

.. _OEBioisostere_OEBroodHitlistOptions:

.. oe:class:: OEBroodHitlistOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodHitlistOptions : public OESystem::OEOptions

   This class provides an interface to set up options used when generating
   a hitlist in :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>`
   from a set of :ref:`Brood scores <OEBioisostere_OEBroodScore>`.

   The :ref:`OEBroodHitlistOptions <OEBioisostere_OEBroodHitlistOptions>` class defines the following public methods:
    * :oe:meth:`GetGenerateIdea<OEBioisostere::OEBroodHitlistOptions::GetGenerateIdea>` and
      :oe:meth:`SetGenerateIdea<OEBioisostere::OEBroodHitlistOptions::SetGenerateIdea>`
    * :oe:meth:`GetMaxHits<OEBioisostere::OEBroodHitlistOptions::GetMaxHits>` and
      :oe:meth:`SetMaxHits<OEBioisostere::OEBroodHitlistOptions::SetMaxHits>`

   

   .. _OEBioisostere_OEBroodHitlistOptions_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodHitlistOptions()
            OEBroodHitlistOptions(const OEBroodHitlistOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodHitlistOptions() -> OEBroodHitlistOptions
            OEBroodHitlistOptions(arg2: OEBroodHitlistOptions) -> OEBroodHitlistOptions

      Default and copy constructors.

   .. _OEBioisostere_OEBroodHitlistOptions_operator=:
   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBroodHitlistOptions &operator=(const OEBroodHitlistOptions &)

      Assignment operator.

   .. _OEBioisostere_OEBroodHitlistOptions_GetGenerateIdea:
   .. oe:method:: GetGenerateIdea

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetGenerateIdea() const

      .. oe:language:: python

         .. oe:api:: python

            GetGenerateIdea() -> bool

      See :oe:meth:`SetGenerateIdea<OEBioisostere::OEBroodHitlistOptions::SetGenerateIdea>` method.

   .. _OEBioisostere_OEBroodHitlistOptions_GetMaxHits:
   .. oe:method:: GetMaxHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHits() -> int

      See :oe:meth:`SetMaxHits<OEBioisostere::OEBroodHitlistOptions::SetMaxHits>` method.

   .. _OEBioisostere_OEBroodHitlistOptions_SetGenerateIdea:
   .. oe:method:: SetGenerateIdea

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetGenerateIdea(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetGenerateIdea(value: bool) -> bool

      Sets whether **cluster information** is generated for the created
      hitlist.
      **Default: True.**

   .. _OEBioisostere_OEBroodHitlistOptions_SetMaxHits:
   .. oe:method:: SetMaxHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxHits(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHits(value: int) -> bool

      Sets the **maximum number of hits** to generate.
      **Default: 1000.**


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodMolBuilder, BroodMolBuilder

.. _OEBioisostere_OEBroodMolBuilder:

.. oe:class:: OEBroodMolBuilder

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodMolBuilder

   This class defines the interface for building a fragment-replaced molecule
   with 3D coordinates from an :ref:`OEBroodScore<OEBioisostere_OEBroodScore>`.

   The :ref:`OEBroodMolBuilder <OEBioisostere_OEBroodMolBuilder>` class defines the following public method:
    * :oe:meth:`Build<OEBioisostere::OEBroodMolBuilder::Build>`

   

   .. _OEBioisostere_OEBroodMolBuilder_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodMolBuilder(const OEBroodQuery& query,
                              const OEBroodGeneralOptions& genOpts = OEBroodGeneralOptions(),
                              const OEBroodBuildOptions& options = OEBroodBuildOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEBroodMolBuilder(query: OEBroodQuery,
                              genOpts: OEBroodGeneralOptions = OEBroodGeneralOptions(),
                              options: OEBroodBuildOptions = OEBroodBuildOptions()) -> OEBroodMolBuilder

      Default and copy constructor.

   .. _OEBioisostere_OEBroodMolBuilder_Build:

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Build(const OEBroodScore& score, OEBroodHit& hit)
            unsigned Build(OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Build(score: OEBroodScore, hit: OEBroodHit) -> int
            Build(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      This method builds a fragment replaced 3D Molecule.  The first overload generates
      corresponding hit data from the specified :ref:`OEBroodScore<OEBioisostere_OEBroodScore>`.
      The second overload works directly with a fragment-replaced molecule.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodOverlay, BroodOverlay

.. _OEBioisostere_OEBroodOverlay:

.. oe:class:: OEBroodOverlay

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodOverlay: public OEBroodOverlayBase

   This class defines an interface for fragment overlay optimization
   against a :ref:`Brood query <OEBioisostere_OEBroodQuery>`.

   The :ref:`OEBroodOverlay <OEBioisostere_OEBroodOverlay>` class defines the following public methods:
    * :oe:meth:`Overlay<OEBioisostere::OEBroodOverlay::Overlay>`
    * :oe:meth:`SetupRef<OEBioisostere::OEBroodOverlay::SetupRef>`
    * :oe:meth:`Transform<OEBioisostere::OEBroodOverlay::Transform>`

   .. _OEBioisostere_OEBroodOverlay_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodOverlay(const OEBroodGeneralOptions& genOpts = OEBroodGeneralOptions(),
                           const OEBroodScoreOptions& scoreOpts = OEBroodScoreOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEBroodOverlay(genOpts: OEBroodGeneralOptions = OEBroodGeneralOptions(),
                           scoreOpts: OEBroodScoreOptions = OEBroodScoreOptions()) -> OEBroodOverlay

      Default constructor.

   .. _OEBioisostere_OEBroodOverlay_Overlay:

   .. oe:method:: Overlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<OEBroodScore> Overlay(const OEBroodDBPacket&)
            unsigned Overlay(std::vector<OEBroodScore>&, const OEBroodDBPacket&)
            unsigned Overlay(OEChem::OEMCMolBase& fragment, OEBroodScore& score)

      .. oe:language:: python

         .. oe:api:: python

            Overlay(packet: OEBroodDBPacket) -> OEBroodScoreVector
            Overlay(vecScores: OEBroodScoreVector, packet: OEBroodDBPacket) -> int
            Overlay(fragment: OEMol, match: OEBroodScore) -> int

      Performs overlay optimization against the specified fragments. The first
      two overloads optimize against all fragments in the provided
      :ref:`OEBroodDBPacket <OEBioisostere_OEBroodDBPacket>`, and return
      a vector of :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` values.
      The third overload performs optimization against the specified fragment
      and populates the specified
      :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` with optimization results.
      Both the second and third overloads return an optimization status from
      :oe:constns:`OEBioisostere::OEBroodStatusCode`.

   .. _OEBioisostere_OEBroodOverlay_SetupRef:

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned SetupRef(const OEBroodQuery& query)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(query: OEBroodQuery) -> int

      Sets up the overlay optimization with the desired 
      :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>`.  Method returns
      :oe:const:`OEBioisostere::OEBroodStatusCode::Success` if
      the initialization is successful, otherwise returns an error code from the
      :oe:constns:`OEBioisostere::OEBroodStatusCode` namespace.

   .. _OEBioisostere_OEBroodOverlay_Transform:

   .. oe:method:: Transform

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Transform(OEChem::OEMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            Transform(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Transforms the specified molecule to the optimized overlay position
      determined by a prior call to
      :oe:meth:`Overlay<OEBioisostere::OEBroodOverlay::Overlay>`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodOverlayBase, BroodOverlayBase

.. _OEBioisostere_OEBroodOverlayBase:

.. oe:class:: OEBroodOverlayBase

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodOverlayBase

   This is a base class for fragment overlay optimization.

   The :ref:`OEBroodOverlayBase <OEBioisostere_OEBroodOverlayBase>` class defines the following public methods:
    * :oe:meth:`Overlay<OEBioisostere::OEBroodOverlayBase::Overlay>`

   .. _OEBioisostere_OEBroodOverlayBase_Overlay:

   .. oe:method:: Overlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Overlay(OEChem::OEMCMolBase& fragment, OEBroodScore& score)

      .. oe:language:: python

         .. oe:api:: python

            Overlay(fragment: OEMol, match: OEBroodScore) -> int

      Performs overlay optimization of the specified fragment. Populates the
      provided :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` with optimization
      results. Returns the status of the optimization; see
      :oe:constns:`OEBioisostere::OEBroodStatusCode` for possible values.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodQuery, BroodQuery

.. _OEBioisostere_OEBroodQuery:

.. oe:class:: OEBroodQuery

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodQuery

   This class defines objects that represent a **Brood** query.

   The :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` class defines the following public methods:
    * :oe:meth:`GetAttachCount<OEBioisostere::OEBroodQuery::GetAttachCount>`
    * :oe:meth:`GetHeavyCount<OEBioisostere::OEBroodQuery::GetHeavyCount>`
    * :oe:meth:`GetQueryID<OEBioisostere::OEBroodQuery::GetQueryID>`
    * :oe:meth:`SetQueryID<OEBioisostere::OEBroodQuery::SetQueryID>`
    * :oe:meth:`HasProtein<OEBioisostere::OEBroodQuery::HasProtein>`
    * :oe:meth:`HasProteinSelect<OEBioisostere::OEBroodQuery::HasProteinSelect>`
    * :oe:meth:`Init<OEBioisostere::OEBroodQuery::Init>`

   

   .. _OEBioisostere_OEBroodQuery_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodQuery()
            OEBroodQuery(const OEBroodQuery &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodQuery() -> OEBroodQuery
            OEBroodQuery(arg2: OEBroodQuery) -> OEBroodQuery

      Default and copy constructors.

   .. _OEBioisostere_OEBroodQuery_operator=:
   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBroodQuery &operator=(const OEBroodQuery &)

      Assignment operator.

   .. _OEBioisostere_OEBroodQuery_GetAttachCount:    

   .. oe:method:: GetAttachCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAttachCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetAttachCount() -> int

      This method returns the number of attachment points in the query fragment.

   .. _OEBioisostere_OEBroodQuery_GetHeavyCount:   

   .. oe:method:: GetHeavyCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetHeavyCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeavyCount() -> int

      This method returns the number of heavy atoms in the query fragment.

   .. _OEBioisostere_OEBroodQuery_GetQueryID:

   .. oe:method:: GetQueryID

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetQueryID() const

      .. oe:language:: python

         .. oe:api:: python

            GetQueryID() -> str

      This method returns the identifier associated with the query. If no identifier has
      been assigned with :oe:meth:`SetQueryID<OEBioisostere::OEBroodQuery::SetQueryID>`, it
      returns the query's isomeric SMILES (the fragment representation) as a sensible
      default, so every query always has a non-empty, meaningful identifier.

   .. _OEBioisostere_OEBroodQuery_SetQueryID:

   .. oe:method:: SetQueryID

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetQueryID(const std::string& id)

      .. oe:language:: python

         .. oe:api:: python

            SetQueryID(id: str) -> None

      This method assigns a user-defined identifier to the query. The identifier is stored
      as string data on the query molecule, so it persists when the query is written and
      read with :oe:func:`OEWriteBroodQuery<OEBioisostere::OEWriteBroodQuery>` and
      :oe:func:`OEReadBroodQuery<OEBioisostere::OEReadBroodQuery>`, and it is carried onto
      every :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` produced from the query
      (see :oe:meth:`GetQueryIDs<OEBioisostere::OEBroodScore::GetQueryIDs>`). When no
      identifier is assigned, :oe:meth:`GetQueryID<OEBioisostere::OEBroodQuery::GetQueryID>`
      falls back to the query's isomeric SMILES.

      .. note::

         Assigning an identifier is optional: by default the identifier is the query's
         SMILES, which keeps queries apart during hit-list de-duplication. Assign a
         **unique** identifier when two *distinct* queries can share the same SMILES, so
         that their hits are not merged during de-duplication. In the combo-building
         process the identifier is also used to map each hit back to its originating query,
         so a unique identifier is recommended there. Two queries that share an identifier
         (for example, two distinct queries that share a SMILES and neither overrides the
         default) are treated as the same query.

   .. _OEBioisostere_OEBroodQuery_HasProtein:

   .. oe:method:: HasProtein

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasProtein() const

      .. oe:language:: python

         .. oe:api:: python

            HasProtein() -> bool

      This method returns *true* if the query contains an associated protein.

   .. _OEBioisostere_OEBroodQuery_HasProteinSelect:
   
   .. oe:method:: HasProteinSelect

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasProteinSelect() const

      .. oe:language:: python

         .. oe:api:: python

            HasProteinSelect() -> bool

      This method returns *true* if the query contains an associated selectivity protein.

   .. _OEBioisostere_OEBroodQuery_Init:

   .. oe:method:: Init

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Init(const OEChem::OEMCMolBase& queryMol)

      .. oe:language:: python

         .. oe:api:: python

            Init(queryMol: OEMol) -> int

      This method initializes the query from contents in the specified `query molecule`.
      A `query molecule` is an :ref:`OEMol <OEChem_OEMol>` containing a set
      of specific data tags. The method returns
      :oe:const:`OEBioisostere::OEBroodStatusCode::Success` if
      the initialization is successful, otherwise it returns an error code from the
      :oe:constns:`OEBioisostere::OEBroodStatusCode` namespace.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodScore, BroodScore

.. _OEBioisostere_OEBroodScore:

.. oe:class:: OEBroodScore

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodScore

   This class defines objects that contains results corresponding to a
   bioisosteric fragment overlap.

   The :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` class defines the following public methods:
    * :oe:meth:`Add<OEBioisostere::OEBroodScore::Add>`
    * :oe:meth:`GetAttachCount<OEBioisostere::OEBroodScore::GetAttachCount>`
    * :oe:meth:`GetAttachScore<OEBioisostere::OEBroodScore::GetAttachScore>`
    * :oe:meth:`GetColorScore<OEBioisostere::OEBroodScore::GetColorScore>`
    * :oe:meth:`GetComboScore<OEBioisostere::OEBroodScore::GetComboScore>`
    * :oe:meth:`GetEnergy<OEBioisostere::OEBroodScore::GetEnergy>`
    * :oe:meth:`GetFrag<OEBioisostere::OEBroodScore::GetFrag>`
    * :oe:meth:`GetFragMol<OEBioisostere::OEBroodScore::GetFragMol>`
    * :oe:meth:`GetQueryIDs<OEBioisostere::OEBroodScore::GetQueryIDs>`
    * :oe:meth:`GetScoreType<OEBioisostere::OEBroodScore::GetScoreType>`
    * :oe:meth:`GetShapeScore<OEBioisostere::OEBroodScore::GetShapeScore>`
    * :oe:meth:`GetStatus<OEBioisostere::OEBroodScore::GetStatus>`
    * :oe:meth:`Load<OEBioisostere::OEBroodScore::Load>`
    * :oe:meth:`ToRecord<OEBioisostere::OEBroodScore::ToRecord>`

   

   .. _OEBioisostere_OEBroodScore_Constructors:

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodScore()
            OEBroodScore(const OEBroodScore &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodScore() -> OEBroodScore
            OEBroodScore(arg2: OEBroodScore) -> OEBroodScore

      Default and copy constructors. The scoring type is determined by the
      :oe:meth:`OEBroodGeneralOptions::SetScoreType<OEBioisostere::OEBroodGeneralOptions::SetScoreType>`
      option and defaults to :oe:const:`OEBioisostere::OEBroodScoreType::ROCS`.

   .. _OEBioisostere_OEBroodScore_operator=:

   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

             OEBroodScore& operator=(const OEBroodScore&)

      Assignment operator.

   .. _OEBioisostere_OEBroodScore_Add:

   .. oe:method:: Add

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Add(const OEBroodScore& score)

      .. oe:language:: python

         .. oe:api:: python

            Add(score: OEBroodScore) -> bool

      This method merges another :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` into this
      score by appending query provenance and combining similarity components
      (attachment, shape, and color). The method returns ``true`` only when
      both score objects have successful status.

   .. _OEBioisostere_OEBroodScore_GetAttachCount:

   .. oe:method:: GetAttachCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAttachCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetAttachCount() -> int

      This method returns the number of attachment points in the fragment overlay.

   .. _OEBioisostere_OEBroodScore_GetAttachScore:

   .. oe:method:: GetAttachScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetAttachScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetAttachScore() -> float

      This method returns the attachment score corresponding to fragment overlay.

   .. _OEBioisostere_OEBroodScore_GetColorScore:

   .. oe:method:: GetColorScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetColorScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorScore() -> float

      This method returns the color score corresponding to fragment overlay.

   .. _OEBioisostere_OEBroodScore_GetComboScore:

   .. oe:method:: GetComboScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetComboScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetComboScore() -> float

      This method returns the combo (shape+color) score corresponding to fragment overlay.

   .. _OEBioisostere_OEBroodScore_GetEnergy:

   .. oe:method:: GetEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnergy() -> float

      This method returns the *energy* associated with the fragment. *Energy* refers to the entity that
      is used for ranking fragments in building the hit list using :ref:`OEBioisostere_OEScoreHitlist`.

   .. _OEBioisostere_OEBroodScore_GetFrag:

   .. oe:method:: GetFrag

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEMol& GetFrag() const

      .. oe:language:: python

         .. oe:api:: python

            GetFrag() -> OEMol

      This method returns a const reference to the generated molecule with fragment replacement.

   .. _OEBioisostere_OEBroodScore_GetFragMol:

   .. oe:method:: GetFragMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFragMol(OEChem::OEMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            GetFragMol(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This method copies the generated molecule with fragment replacement into the provided
      molecule parameter. It returns ``true`` if successful and ``false`` otherwise.

   .. _OEBioisostere_OEBroodScore_GetQueryIDs:

   .. oe:method:: GetQueryIDs

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<std::string>& GetQueryIDs() const

      .. oe:language:: python

         .. oe:api:: python

            GetQueryIDs() -> OEStringVector

      This method returns the query identifiers of the originating
      :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` objects. Each identifier is the one
      assigned with :oe:meth:`SetQueryID<OEBioisostere::OEBroodQuery::SetQueryID>`, or the
      originating query's isomeric SMILES when no identifier was assigned. In single-query
      workflows this is typically one entry; in combined (combo-built) workflows it can
      contain multiple entries, one per contributing query.

      .. note::

         A score can be associated with multiple query identifiers when multiple queries
         are used to build it. Assign a **unique** identifier to each distinct query with
         :oe:meth:`SetQueryID<OEBioisostere::OEBroodQuery::SetQueryID>` when distinct
         queries could otherwise share the same default (SMILES) identifier; this is what
         disambiguates scores from different queries during hit list deduplication and
         combo building. See the :ref:`combo_builder <section_examples_combo_builder>`
         example for more details.

   .. _OEBioisostere_OEBroodScore_GetScoreType:

   .. oe:method:: GetScoreType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetScoreType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreType() -> int

      This method returns the scoring mode associated with this result. The value is one
      of the constants from the :oe:constns:`OEBioisostere::OEBroodScoreType` namespace:

      * :oe:const:`OEBioisostere::OEBroodScoreType::ROCS` - shape and color based scoring.
      * :oe:const:`OEBioisostere::OEBroodScoreType::ET` - shape and electrostatics based scoring.
      * :oe:const:`OEBioisostere::OEBroodScoreType::LinkOnly` - attachment-only based scoring.

      The scoring type is set via
      :oe:meth:`OEBroodGeneralOptions::SetScoreType<OEBioisostere::OEBroodGeneralOptions::SetScoreType>`
      before running the overlay. The default is
      :oe:const:`OEBioisostere::OEBroodScoreType::ROCS`.

   .. _OEBioisostere_OEBroodScore_GetShapeScore:

   .. oe:method:: GetShapeScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetShapeScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeScore() -> float

      This method returns the shape score corresponding to fragment overlay.

   .. _OEBioisostere_OEBroodScore_GetStatus:

   .. oe:method:: GetStatus

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetStatus() const

      .. oe:language:: python

         .. oe:api:: python

            GetStatus() -> int

      This method returns the status of fragment overlay. The method returns
      :oe:const:`OEBioisostere::OEBroodStatusCode::Success` if
      the overlay was successful, otherwise it returns an error code from the
      :oe:constns:`OEBioisostere::OEBroodStatusCode` namespace.

   .. _OEBioisostere_OEBroodScore_Load:

   .. oe:method:: Load

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Load(const OEDataFlow::OERecord&)

      .. oe:language:: python

         .. oe:api:: python

            Load(arg2: OERecord) -> bool

      This method loads contents of :ref:`OEBroodScore <OEBioisostere_OEBroodScore>`
      from :ref:`OERecord <OEDataFlow_OERecord>`.
      It returns ``true`` if successful and ``false`` otherwise.

   .. _OEBioisostere_OEBroodScore_ToRecord:

   .. oe:method:: ToRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ToRecord(OEDataFlow::OERecord&) const

      .. oe:language:: python

         .. oe:api:: python

            ToRecord(arg2: OERecord) -> bool

      This method saves the contents of :ref:`OEBroodScore <OEBioisostere_OEBroodScore>`
      into an :ref:`OERecord <OEDataFlow_OERecord>`.
      It returns ``true`` if successful and ``false`` otherwise.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodScoreOptions, BroodScoreOptions

.. _OEBioisostere_OEBroodScoreOptions:

.. oe:class:: OEBroodScoreOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodScoreOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for finding bioisosteric 
   fragment replacement matches, used with scoring fragments while performing overlay 
   optimization with :ref:`OEBroodOverlay<OEBioisostere_OEBroodOverlay>`.

   The :ref:`OEBroodScoreOptions <OEBioisostere_OEBroodScoreOptions>` class defines the following public methods:
    * :oe:meth:`GetUseBondOrder<OEBioisostere::OEBroodScoreOptions::GetUseBondOrder>` and
      :oe:meth:`SetUseBondOrder<OEBioisostere::OEBroodScoreOptions::SetUseBondOrder>`
    * :oe:meth:`GetUseProperty<OEBioisostere::OEBroodScoreOptions::GetUseProperty>` and
      :oe:meth:`SetUseProperty<OEBioisostere::OEBroodScoreOptions::SetUseProperty>`
    * :oe:meth:`GetCheckGeometry<OEBioisostere::OEBroodScoreOptions::GetCheckGeometry>` and
      :oe:meth:`SetCheckGeometry<OEBioisostere::OEBroodScoreOptions::SetCheckGeometry>`
    * :oe:meth:`GetAttachCutoff<OEBioisostere::OEBroodScoreOptions::GetAttachCutoff>` and
      :oe:meth:`SetAttachCutoff<OEBioisostere::OEBroodScoreOptions::SetAttachCutoff>`
    * :oe:meth:`GetShapeCutoff<OEBioisostere::OEBroodScoreOptions::GetShapeCutoff>` and
      :oe:meth:`SetShapeCutoff<OEBioisostere::OEBroodScoreOptions::SetShapeCutoff>`
    * :oe:meth:`GetChargeType<OEBioisostere::OEBroodScoreOptions::GetChargeType>` and
      :oe:meth:`SetChargeType<OEBioisostere::OEBroodScoreOptions::SetChargeType>`
    * :oe:meth:`GetPropertyOptions<OEBioisostere::OEBroodScoreOptions::GetPropertyOptions>` and
      :oe:meth:`SetPropertyOptions<OEBioisostere::OEBroodScoreOptions::SetPropertyOptions>`

   
   .. _OEBioisostere_OEBroodScoreOptions_Constructors:

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodScoreOptions()
            OEBroodScoreOptions(const OEBroodScoreOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodScoreOptions() -> OEBroodScoreOptions
            OEBroodScoreOptions(arg2: OEBroodScoreOptions) -> OEBroodScoreOptions

      Default and copy constructors.

   .. _OEBioisostere_OEBroodScoreOptions_operator=:

   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEBroodScoreOptions &operator=(const OEBroodScoreOptions &)

      Assignment operator.

   .. _OEBioisostere_OEBroodScoreOptions_GetUseBondOrder:

   .. oe:method:: GetUseBondOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseBondOrder() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseBondOrder() -> bool

      See :oe:meth:`SetUseBondOrder<OEBioisostere::OEBroodScoreOptions::SetUseBondOrder>` method.

   .. _OEBioisostere_OEBroodScoreOptions_GetUseProperty:

   .. oe:method:: GetUseProperty

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseProperty() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseProperty() -> bool

      See :oe:meth:`SetUseProperty<OEBioisostere::OEBroodScoreOptions::SetUseProperty>` method.

   .. _OEBioisostere_OEBroodScoreOptions_GetCheckGeometry:

   .. oe:method:: GetCheckGeometry

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCheckGeometry() const

      .. oe:language:: python

         .. oe:api:: python

            GetCheckGeometry() -> bool

      See :oe:meth:`SetCheckGeometry<OEBioisostere::OEBroodScoreOptions::SetCheckGeometry>` method.

   .. _OEBioisostere_OEBroodScoreOptions_GetAttachCutoff:

   .. oe:method:: GetAttachCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetAttachCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetAttachCutoff() -> float

      See :oe:meth:`SetAttachCutoff<OEBioisostere::OEBroodScoreOptions::SetAttachCutoff>` method.

   .. _OEBioisostere_OEBroodScoreOptions_GetShapeCutoff:

   .. oe:method:: GetShapeCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetShapeCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeCutoff() -> float

      See :oe:meth:`SetShapeCutoff<OEBioisostere::OEBroodScoreOptions::SetShapeCutoff>` method.

   .. _OEBioisostere_OEBroodScoreOptions_GetChargeType:

   .. oe:method:: GetChargeType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetChargeType() const

      .. oe:language:: python

         .. oe:api:: python

            GetChargeType() -> int

      See :oe:meth:`SetChargeType<OEBioisostere::OEBroodScoreOptions::SetChargeType>` method.

   .. _OEBioisostere_OEBroodScoreOptions_GetPropertyOptions:

   .. oe:method:: GetPropertyOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolPropertyOptions& GetPropertyOptions()
            const OEMolPropertyOptions& GetPropertyOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetPropertyOptions() -> OEMolPropertyOptions

      See :oe:meth:`SetPropertyOptions<OEBioisostere::OEBroodScoreOptions::SetPropertyOptions>` method.

   .. _OEBioisostere_OEBroodScoreOptions_SetUseBondOrder:

   .. oe:method:: SetUseBondOrder

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseBondOrder(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseBondOrder(value: bool) -> bool

      Sets if **Same attachment bond order** should be required for a possible match.
      **Default: True.**

   .. _OEBioisostere_OEBroodScoreOptions_SetUseProperty:

   .. oe:method:: SetUseProperty

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseProperty(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseProperty(value: bool) -> bool

      Sets if **Fragment property should be checked** for a possible match.
      **Default: False.**

   .. _OEBioisostere_OEBroodScoreOptions_SetCheckGeometry:

   .. oe:method:: SetCheckGeometry

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCheckGeometry(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetCheckGeometry(value: bool) -> bool

      Sets if **Minimal geometric difference should be required** for a possible match.
      **Default: True.**

   .. _OEBioisostere_OEBroodScoreOptions_SetAttachCutoff:

   .. oe:method:: SetAttachCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAttachCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetAttachCutoff(value: float) -> bool

      Sets the **Minimum acceptable attachment tanimoto** for a possible match.
      **Default: 0.78.**

   .. _OEBioisostere_OEBroodScoreOptions_SetShapeCutoff:

   .. oe:method:: SetShapeCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetShapeCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeCutoff(value: float) -> bool

      Sets the **Minimum acceptable shape tanimoto** for a possible match.
      **Default: 0.6.**

   .. _OEBioisostere_OEBroodScoreOptions_SetPropertyOptions:

   .. oe:method:: SetPropertyOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPropertyOptions(const OEMolPropertyOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetPropertyOptions(opts: OEMolPropertyOptions) -> None

      Sets :oe:cls:`options <OEBioisostere::OEMolPropertyOptions>` related to required molecular property values.

   .. oe:method:: SetChargeType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetChargeType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetChargeType(value: int) -> bool

      Sets the **partial charge model** to use for electrostatic Tanimoto calculations
      when scoring with the :ref:`ET <OEBioisostere_OEBroodScoreType_ET>` score type.
      Legal values: :ref:`MMFF94 <OEProton_OECharges_MMFF94>` and
      :ref:`NoOp <OEProton_OECharges_NoOp>`. (NoOp means to  use charges already on the molecule, as with the BROOD
      option fileChrg.)
      **Default:** :ref:`MMFF94 <OEProton_OECharges_MMFF94>`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OECPDDatabase, CPDDatabase

.. _OEBioisostere_OECPDDatabase:

.. oe:class:: OECPDDatabase

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OECPDDatabase

   This class provides an interface to use an external compound database
   to identify similar compounds to a **Brood**-generated hitlist, as described in 
   :ref:`brood_compound_similarity`.

   The :ref:`OECPDDatabase <OEBioisostere_OECPDDatabase>` class defines the following public methods:
    * :oe:meth:`GetNumMolecules<OEBioisostere::OECPDDatabase::GetNumMolecules>`
    * :oe:meth:`GetSimilarMolecules<OEBioisostere::OECPDDatabase::GetSimilarMolecules>`  
    * :oe:meth:`HasNewFingerPrints<OEBioisostere::OECPDDatabase::HasNewFingerPrints>`
    * :oe:meth:`IsPrepared<OEBioisostere::OECPDDatabase::IsPrepared>`
    * :oe:meth:`Prep<OEBioisostere::OECPDDatabase::Prep>`
    * :oe:meth:`Write<OEBioisostere::OECPDDatabase::Write>` 

   

   .. _OEBioisostere_OECPDDatabase_Constructor:
   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECPDDatabase()

      .. oe:language:: python

         .. oe:api:: python

            OECPDDatabase() -> OECPDDatabase

      Default constructor.

   .. _OEBioisostere_OECPDDatabase_GetNumMolecules:

   .. oe:method:: GetNumMolecules

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetNumMolecules()

      .. oe:language:: python

         .. oe:api:: python

            GetNumMolecules() -> int

      Returns the number of molecules in the prepared external compound
      database that are ready for hitlist comparison.

      See also :oe:meth:`IsPrepared<OEBioisostere::OECPDDatabase::IsPrepared>` method.

   .. _OEBioisostere_OECPDDatabase_GetSimilarMolecules:

   .. oe:method:: GetSimilarMolecules

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSimilarMolecules(const OEChem::OEMolBase& hitMol,
                                     std::vector<std::string>& vecCpddbInfo)
            std::vector<std::string> GetSimilarMolecules(const OEChem::OEMolBase& hitMol)

      .. oe:language:: python

         .. oe:api:: python

            GetSimilarMolecules(hitMol: Union[OEGraphMol,OEMol,OEQMol]) -> OEStringVector

      Retrieves information (SMILES and labels) for molecules similar to the
      provided hit molecule from the external compound database. The ``bool``
      overload returns ``true`` when similar molecules are found.
      This method should be used after the compound database has been prepared
      using the :oe:meth:`Prep<OEBioisostere::OECPDDatabase::Prep>` method.

   .. _OEBioisostere_OECPDDatabase_HasNewFingerPrints:

   .. oe:method:: HasNewFingerPrints

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasNewFingerPrints()

      .. oe:language:: python

         .. oe:api:: python

            HasNewFingerPrints() -> bool

      Returns ``true`` if new fingerprints were generated during preparation.

      See also :oe:meth:`Prep<OEBioisostere::OECPDDatabase::Prep>` method.

   .. _OEBioisostere_OECPDDatabase_IsPrepared:

   .. oe:method:: IsPrepared

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsPrepared()

      .. oe:language:: python

         .. oe:api:: python

            IsPrepared() -> bool

      Returns whether the external compound database has been prepared.

   .. _OEBioisostere_OECPDDatabase_Prep:

   .. oe:method:: Prep

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Prep(OEChem::oemolistream& cpddbifs,
                          OESystem::OETracerBase& tracer = OESystem::OENoTracer)

      .. oe:language:: python

         .. oe:api:: python

            Prep(cpddbifs: oemolistream, tracer: OETracerBase = OENoTracer) -> int

      Prepares the input stream molecules by generating 2D fingerprints for each, if they do not already have one.
      The method returns an unsigned. The unsigned code number can be extracted using :oe:func:`OEBioisostere::OEGetBroodStatus`. 

   .. _OEBioisostere_OECPDDatabase_Write:

   .. oe:method:: Write

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Write(OEChem::oemolistream& cpddbifs,
                       OEChem::oemolostream& cpddbofs)

      .. oe:language:: python

         .. oe:api:: python

            Write(cpddbifs: oemolistream, cpddbofs: oemolostream) -> bool

      Writes newly generated fingerprints from ``cpddbifs`` into ``cpddbofs``
      for more efficient reuse in future runs.

      See also :oe:meth:`HasNewFingerPrints<OEBioisostere::OECPDDatabase::HasNewFingerPrints>` method.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEDBBuffer, DBBuffer

.. _OEBioisostere_OEDBBuffer:

.. oe:class:: OEDBBuffer

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEDBBuffer

   This class defines objects representing a Brood database held in memory.
   This is suitable for generating a database from a small set of molecules,
   to be used on-the-fly, without storing it on disk.

   The :ref:`OEDBBuffer <OEBioisostere_OEDBBuffer>` class defines the following public methods:
    * :oe:meth:`Add<OEBioisostere::OEDBBuffer::Add>`
    * :oe:meth:`Finalize<OEBioisostere::OEDBBuffer::Finalize>`
    * :oe:meth:`GetPackets<OEBioisostere::OEDBBuffer::GetPackets>`

   

   .. _OEBioisostere_OEDBBuffer_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDBBuffer()

      .. oe:language:: python

         .. oe:api:: python

            OEDBBuffer() -> OEDBBuffer

      Default constructor.

   .. _OEBioisostere_OEDBBuffer_Add:
   .. oe:method:: Add

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Add(OEChem::OEMCMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Add(mol: OEMol) -> bool

      Adds the specified fragment into the database.

   .. _OEBioisostere_OEDBBuffer_Finalize:
   .. oe:method:: Finalize

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Finalize()

      .. oe:language:: python

         .. oe:api:: python

            Finalize() -> bool

      Finalizes the database.  This method must be called before packets can be
      retrieved from the database.

   .. _OEBioisostere_OEDBBuffer_GetPackets:
   .. oe:method:: GetPackets

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<OEBroodDBPacket>& GetPackets() const

      .. oe:language:: python

         .. oe:api:: python

            GetPackets() -> OEBroodDBPacketVector

      Returns the data packets from the database.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEDBBuilder, DBBuilder

.. _OEBioisostere_OEDBBuilder:

.. oe:class:: OEDBBuilder

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEDBBuilder

   This class defines an interface for building a two-dimensional Brood
   fragment database.

   The :ref:`OEDBBuilder <OEBioisostere_OEDBBuilder>` class defines the following public methods:
    * :oe:meth:`Add<OEBioisostere::OEDBBuilder::Add>`
    * :oe:meth:`AddCSV<OEBioisostere::OEDBBuilder::AddCSV>`
    * :oe:meth:`Expand<OEBioisostere::OEDBBuilder::Expand>`
    * :oe:meth:`Filter<OEBioisostere::OEDBBuilder::Filter>`
    * :oe:meth:`Generate<OEBioisostere::OEDBBuilder::Generate>`
    * :oe:meth:`GetFrag<OEBioisostere::OEDBBuilder::GetFrag>`
    * :oe:meth:`GetFragSmiles<OEBioisostere::OEDBBuilder::GetFragSmiles>`
    * :oe:meth:`GetFragSmilesCSV<OEBioisostere::OEDBBuilder::GetFragSmilesCSV>`
    * :oe:meth:`GetFrags<OEBioisostere::OEDBBuilder::GetFrags>`
    * :oe:meth:`NumFrags<OEBioisostere::OEDBBuilder::NumFrags>`
    * :oe:meth:`Screen<OEBioisostere::OEDBBuilder::Screen>`

   

   .. _OEBioisostere_OEDBBuilder_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDBBuilder(const OEFragmentOptions& opts = OEFragmentOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEDBBuilder(opts: OEFragmentOptions = OEFragmentOptions()) -> OEDBBuilder

      Default constructor.

   .. _OEBioisostere_OEDBBuilder_Add:

   .. oe:method:: Add

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Add(OEChem::OEMCMolBase& frag)
            bool Add(OESystem::OEIter<OEChem::OEMCMolBase>& frag)
            bool Add(const std::string& smiles)
            bool Add(const std::vector<std::string>& vecSmiles)

      .. oe:language:: python

         .. oe:api:: python

            Add(frag: OEMol) -> bool
            Add(vecSmiles: OEStringVector) -> bool

      Adds the specified fragment(s) to the database. In the ``SMILES``-based
      overloads, fragment ``SMILES`` in the format obtained from
      :oe:meth:`GetFragSmiles<OEBioisostere::OEDBBuilder::GetFragSmiles>`
      are expected.

   .. _OEBioisostere_OEDBBuilder_AddCSV:

   .. oe:method:: AddCSV

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddCSV(const std::vector<std::string>& vecSmiles)

      .. oe:language:: python

         .. oe:api:: python

            AddCSV(vecSmiles: OEStringVector) -> bool

      Adds fragments from the specified ``CSV SMILES`` strings. ``SMILES`` as
      obtained from
      :oe:meth:`GetFragSmilesCSV<OEBioisostere::OEDBBuilder::GetFragSmilesCSV>`
      are expected.

   .. _OEBioisostere_OEDBBuilder_Expand:

   .. oe:method:: Expand

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Expand(const OEConfGen::OEFlipperOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            Expand(opts: OEFlipperOptions) -> bool

      Expands the database by stereo-enumerating currently contained fragments.

   .. _OEBioisostere_OEDBBuilder_Filter:

   .. oe:method:: Filter

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Filter(OEMolProp::OEFilter& filter)

      .. oe:language:: python

         .. oe:api:: python

            Filter(filter: OEFilter) -> bool

      Filters currently contained database fragments.

   .. _OEBioisostere_OEDBBuilder_Generate:

   .. oe:method:: Generate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Generate(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Generate(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Generates fragments from the specified molecule and adds the generated
      fragment(s) to the database.

   .. _OEBioisostere_OEDBBuilder_GetFrag:

   .. oe:method:: GetFrag

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFrag(OEChem::OEMCMolBase& mol, const std::string& smiles) const

      .. oe:language:: python

         .. oe:api:: python

            GetFrag(mol: OEMol, smiles: str) -> bool

      Obtains the fragment defined by the specified ``SMILES`` string. Returns
      ``false`` if a fragment with the specified ``SMILES`` does not exist.
      ``SMILES`` in the format obtained from
      :oe:meth:`GetFragSmiles<OEBioisostere::OEDBBuilder::GetFragSmiles>`
      is expected.

   .. _OEBioisostere_OEDBBuilder_GetFragSmiles:

   .. oe:method:: GetFragSmiles

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetFragSmiles() const
            bool GetFragSmiles(std::vector<std::string>&) const

      .. oe:language:: python

         .. oe:api:: python

            GetFragSmiles() -> OEStringVector

      Returns ``SMILES`` strings corresponding to the current database.

   .. _OEBioisostere_OEDBBuilder_GetFragSmilesCSV:

   .. oe:method:: GetFragSmilesCSV

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetFragSmilesCSV() const
            bool GetFragSmilesCSV(std::vector<std::string>&) const

      .. oe:language:: python

         .. oe:api:: python

            GetFragSmilesCSV() -> OEStringVector
            GetFragSmilesCSV(vecSmiles: OEStringVector) -> bool

      Returns ``CSV SMILES`` strings corresponding to the current database.
      ``CSV SMILES`` contains fragment ``SMILES`` in a special
      comma-separated string format.

   .. _OEBioisostere_OEDBBuilder_GetFrags:

   .. oe:method:: GetFrags

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEMCMolBase>* GetFrags() const

      .. oe:language:: python

         .. oe:api:: python

            GetFrags() -> Iterable[OEMol]

      Returns two-dimensional fragments corresponding to the current database.

   .. _OEBioisostere_OEDBBuilder_NumFrags:

   .. oe:method:: NumFrags

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned NumFrags() const

      .. oe:language:: python

         .. oe:api:: python

            NumFrags() -> int

      Returns the number of fragments corresponding to the current database.

   .. _OEBioisostere_OEDBBuilder_Screen:

   .. oe:method:: Screen

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Screen(const OEDBScreenOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            Screen(opts: OEDBScreenOptions) -> bool

      Screens the fragments in the current database.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEDBReader, DBReader

.. _OEBioisostere_OEDBReader:

.. oe:class:: OEDBReader

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEDBReader

   This class defines an interface for accessing a **Brood** fragment database
   from disk.

   The :ref:`OEDBReader <OEBioisostere_OEDBReader>` class defines the following public methods:
    * :oe:meth:`GetFragCount<OEBioisostere::OEDBReader::GetFragCount>`
    * :oe:meth:`GetIndices<OEBioisostere::OEDBReader::GetIndices>`
    * :oe:meth:`GetNextPacket<OEBioisostere::OEDBReader::GetNextPacket>`
    * :oe:meth:`Init<OEBioisostere::OEDBReader::Init>`

   

   .. _OEBioisostere_OEDBReader_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDBReader()

      .. oe:language:: python

         .. oe:api:: python

            OEDBReader() -> OEDBReader

      Default constructor.

   .. _OEBioisostere_OEDBReader_GetFragCount:
   .. oe:method:: GetFragCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetFragCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragCount() -> int

      Returns the number of fragments in the database currently associated with
      this reader.

   .. _OEBioisostere_OEDBReader_GetIndices:
   .. oe:method:: GetIndices

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<unsigned>& GetIndices() const

      .. oe:language:: python

         .. oe:api:: python

            GetIndices() -> OEUIntVector

      Returns the database indices currently associated with this reader.

   .. _OEBioisostere_OEDBReader_GetNextPacket:
   .. oe:method:: GetNextPacket

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetNextPacket(OEBroodDBPacket&)

      .. oe:language:: python

         .. oe:api:: python

            GetNextPacket(blob: OEBroodDBPacket) -> bool

      Retrieves the next available database packet.

   .. _OEBioisostere_OEDBReader_Init:   

   .. oe:method:: Init

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Init(const std::string& prefix, OEBroodQuery& query,
                          const OEBroodGeneralOptions& generalOpts = OEBroodGeneralOptions())
            unsigned Init(const std::string& prefix,
                          const std::vector<unsigned>& vecIdx = std::vector<unsigned>());

      .. oe:language:: python

         .. oe:api:: python

            Init(prefix: str, query: OEBroodQuery,
                 scoreOpts: OEBroodGeneralOptions = OEBroodGeneralOptions()) -> int
            Init(prefix: str, vecIdx: OEUIntVector = List[int]) -> int

      Initializes the reader using the database specified by ``prefix``.
      The first overload configures loading for packets from the specified
      database indices. The second overload determines relevant indices from
      the provided ``query`` and general options, then configures loading for
      those packets.
      Returns :oe:const:`OEBioisostere::OEBroodStatusCode::Success` if
      initialization is successful, otherwise an error code from
      :oe:constns:`OEBioisostere::OEBroodStatusCode`.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEDBScreenOptions, DBScreenOptions

.. _OEBioisostere_OEDBScreenOptions:

.. oe:class:: OEDBScreenOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

     class OEDBScreenOptions : public OESystem::OEOptions

   This class provides an interface to setup options related to 
   screening two-dimensional Brood databases in
   :ref:`OEDBBuilder <OEBioisostere_OEDBBuilder>`.

   The :ref:`OEDBScreenOptions <OEBioisostere_OEDBScreenOptions>` class defines the following public methods:
    * :oe:meth:`GetMinFreqHeavy<OEBioisostere::OEDBScreenOptions::GetMinFreqHeavy>` and
      :oe:meth:`SetMinFreqHeavy<OEBioisostere::OEDBScreenOptions::SetMinFreqHeavy>`
    * :oe:meth:`GetMinFrequency<OEBioisostere::OEDBScreenOptions::GetMinFrequency>` and
      :oe:meth:`SetMinFrequency<OEBioisostere::OEDBScreenOptions::SetMinFrequency>`

   

   .. _OEBioisostere_OEDBScreenOptions_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDBScreenOptions()
            OEDBScreenOptions(const OEDBScreenOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEDBScreenOptions() -> OEDBScreenOptions
            OEDBScreenOptions(arg2: OEDBScreenOptions) -> OEDBScreenOptions

      Default and copy constructors.

   .. _OEBioisostere_OEDBScreenOptions_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEDBScreenOptions &operator=(const OEDBScreenOptions&)

      Assignment operator.

   .. _OEBioisostere_OEDBScreenOptions_GetMinFreqHeavy:
   .. oe:method:: GetMinFreqHeavy

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMinFreqHeavy() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinFreqHeavy() -> int

      See :oe:meth:`SetMinFreqHeavy<OEBioisostere::OEDBScreenOptions::SetMinFreqHeavy>` method.

   .. _OEBioisostere_OEDBScreenOptions_GetMinFrequency:
   .. oe:method:: GetMinFrequency

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMinFrequency() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinFrequency() -> int

      See :oe:meth:`SetMinFrequency<OEBioisostere::OEDBScreenOptions::SetMinFrequency>` method.

   .. _OEBioisostere_OEDBScreenOptions_SetMinFreqHeavy:
   .. oe:method:: SetMinFreqHeavy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMinFreqHeavy(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMinFreqHeavy(value: int) -> bool

      Sets the **fragment size defined by the number of heavy atoms** affecting minimum frequency.
      The `minimum frequency` is only applicable to fragments larger this size defined here.
      **Default: 1.**

   .. _OEBioisostere_OEDBScreenOptions_SetMinFrequency:
   .. oe:method:: SetMinFrequency

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMinFrequency(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMinFrequency(value: int) -> bool

      Sets the **Minimum frequency** required for a fragment to be kept. The  ``Minimum frequency``
      is only applicable to fragments larger than size defined in
      :oe:meth:`SetMinFreqHeavy<OEBioisostere::OEDBScreenOptions::SetMinFreqHeavy>`.
      The ``frequency`` is the number of parent molecule a specific fragment belongs to,
      in a database.  A value of zero indicates that all fragments should be kept.
      **Default: 0.**


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEDBWriter, DBWriter

.. _OEBioisostere_OEDBWriter:

.. oe:class:: OEDBWriter

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEDBWriter

   This class defines an interface for writing a Brood database to disk.

   The :ref:`OEDBWriter <OEBioisostere_OEDBWriter>` class defines the following public methods:
    * :oe:meth:`Finish<OEBioisostere::OEDBWriter::Finish>`
    * :oe:meth:`Init<OEBioisostere::OEDBWriter::Init>`
    * :oe:meth:`Write<OEBioisostere::OEDBWriter::Write>`

   

   .. _OEBioisostere_OEDBWriter_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDBWriter()

      .. oe:language:: python

         .. oe:api:: python

            OEDBWriter() -> OEDBWriter

      Default constructor.

   .. _OEBioisostere_OEDBWriter_Finish:
   .. oe:method:: Finish

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Finish()

      .. oe:language:: python

         .. oe:api:: python

            Finish() -> bool

      Closes database files and finalizes the database. This method must be
      called to produce a valid database.

   .. _OEBioisostere_OEDBWriter_Init:
   .. oe:method:: Init

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(const std::string& prefix, unsigned max = 1000)

      .. oe:language:: python

         .. oe:api:: python

            Init(prefix: str, max: int = 1000) -> bool

      Initializes the database for writing. The ``prefix`` parameter specifies
      the database folder and file prefix, and ``maxBufferSize`` specifies the
      maximum in-memory buffer size before flushing to disk.

   .. _OEBioisostere_OEDBWriter_Write:
   .. oe:method:: Write

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Write(OEChem::OEMCMolBase& mol)
            Writes the specified fragment to the database.

      .. oe:language:: python

         .. oe:api:: python

            Write(mol: OEMol) -> bool


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEExtrinsicPropOptions, ExtrinsicPropOptions

.. _OEBioisostere_OEExtrinsicPropOptions:

.. oe:class:: OEExtrinsicPropOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEExtrinsicPropOptions : public OESystem::OEOptions

   This class provides an interface to setup options related to medicinal chemistry
   property limits during fragment replacement scoring.

   The :ref:`OEExtrinsicPropOptions <OEBioisostere_OEExtrinsicPropOptions>` class defines the following public methods:
    * :oe:meth:`GetComplexity<OEBioisostere::OEExtrinsicPropOptions::GetComplexity>` and
      :oe:meth:`SetComplexity<OEBioisostere::OEExtrinsicPropOptions::SetComplexity>`
    * :oe:meth:`GetFrequency<OEBioisostere::OEExtrinsicPropOptions::GetFrequency>` and
      :oe:meth:`SetFrequency<OEBioisostere::OEExtrinsicPropOptions::SetFrequency>`
    * :oe:meth:`GetLipinski<OEBioisostere::OEExtrinsicPropOptions::GetLipinski>` and
      :oe:meth:`SetLipinski<OEBioisostere::OEExtrinsicPropOptions::SetLipinski>`
    * :oe:meth:`GetLipinskiAcc<OEBioisostere::OEExtrinsicPropOptions::GetLipinskiAcc>` and
      :oe:meth:`SetLipinskiAcc<OEBioisostere::OEExtrinsicPropOptions::SetLipinskiAcc>`
    * :oe:meth:`GetLipinskiDon<OEBioisostere::OEExtrinsicPropOptions::GetLipinskiDon>` and
      :oe:meth:`SetLipinskiDon<OEBioisostere::OEExtrinsicPropOptions::SetLipinskiDon>`
    * :oe:meth:`GetLogP<OEBioisostere::OEExtrinsicPropOptions::GetLogP>` and
      :oe:meth:`SetLogP<OEBioisostere::OEExtrinsicPropOptions::SetLogP>`
    * :oe:meth:`GetMartin<OEBioisostere::OEExtrinsicPropOptions::GetMartin>` and
      :oe:meth:`SetMartin<OEBioisostere::OEExtrinsicPropOptions::SetMartin>`
   

   .. _OEBioisostere_OEExtrinsicPropOptions_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExtrinsicPropOptions(const unsigned type = OEBroodMolPropertyType::MIN)
            OEExtrinsicPropOptions(const OEExtrinsicPropOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEExtrinsicPropOptions(type: int) -> OEExtrinsicPropOptions
            OEExtrinsicPropOptions(arg2: OEExtrinsicPropOptions) -> OEExtrinsicPropOptions

      Default and copy constructors.

   .. _OEBioisostere_OEExtrinsicPropOptions_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEExtrinsicPropOptions &operator=(const OEExtrinsicPropOptions &)

      Assignment operator.

   .. _OEBioisostere_OEExtrinsicPropOptions_GetComplexity:
   .. oe:method:: GetComplexity

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetComplexity() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexity() -> float

      See :oe:meth:`SetComplexity<OEBioisostere::OEExtrinsicPropOptions::SetComplexity>` method.

   .. _OEBioisostere_OEExtrinsicPropOptions_GetFrequency:
   .. oe:method:: GetFrequency

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetFrequency() const

      .. oe:language:: python

         .. oe:api:: python

            GetFrequency() -> int

      See :oe:meth:`SetFrequency<OEBioisostere::OEExtrinsicPropOptions::SetFrequency>` method.

   .. _OEBioisostere_OEExtrinsicPropOptions_GetLipinski:
   .. oe:method:: GetLipinski

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetLipinski() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipinski() -> int

      See :oe:meth:`SetLipinski<OEBioisostere::OEExtrinsicPropOptions::SetLipinski>` method.

   .. _OEBioisostere_OEExtrinsicPropOptions_GetLipinskiAcc:
   .. oe:method:: GetLipinskiAcc

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetLipinskiAcc() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipinskiAcc() -> int

      See :oe:meth:`SetLipinskiAcc<OEBioisostere::OEExtrinsicPropOptions::SetLipinskiAcc>` method.

   .. _OEBioisostere_OEExtrinsicPropOptions_GetLipinskiDon:
   .. oe:method:: GetLipinskiDon

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetLipinskiDon() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipinskiDon() -> int

      See :oe:meth:`SetLipinskiDon<OEBioisostere::OEExtrinsicPropOptions::SetLipinskiDon>` method.

   .. _OEBioisostere_OEExtrinsicPropOptions_GetLogP:
   .. oe:method:: GetLogP

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLogP() const

      .. oe:language:: python

         .. oe:api:: python

            GetLogP() -> float

      See :oe:meth:`SetLogP<OEBioisostere::OEExtrinsicPropOptions::SetLogP>` method.

   .. _OEBioisostere_OEExtrinsicPropOptions_GetMartin:
   .. oe:method:: GetMartin

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMartin() const

      .. oe:language:: python

         .. oe:api:: python

            GetMartin() -> float

      See :oe:meth:`SetMartin<OEBioisostere::OEExtrinsicPropOptions::SetMartin>` method.

   .. _OEBioisostere_OEExtrinsicPropOptions_SetComplexity:
   .. oe:method:: SetComplexity

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetComplexity(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetComplexity(value: float) -> bool

      Sets the molecular complexity range for any selected analog.
      **Default: [Min: 0.0, Max: 1.0]**

   .. _OEBioisostere_OEExtrinsicPropOptions_SetFrequency:
   .. oe:method:: SetFrequency

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFrequency(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetFrequency(value: int) -> bool

      Sets the fragment frequency in the database for any selected analog.
      The frequency is a percentile number indicating the frequency of each fragment 
      normalized relative to the frequency of fragments in the database. Frequency as assessed 
      here is a measure of how common each fragment is among the source molecules. The most 
      commonly occurring fragment would be in the 99th percentile, while the least commonly 
      occurring fragments would be in the 1st percentile.
      **Default: [Min: 0, Max: 100]**

   .. _OEBioisostere_OEExtrinsicPropOptions_SetLipinski:
   .. oe:method:: SetLipinski

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLipinski(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetLipinski(value: int) -> bool

      Sets the allowed Lipinski violations for any selected analog.
      In order to segregate molecules that progressed
      through clinical trials, Lipinski determined that one violation was acceptable, but two were not [Lipinski-1997]_.
      **Default: [Min: 0  Max: 1]**

   .. _OEBioisostere_OEExtrinsicPropOptions_SetLipinskiAcc:
   .. oe:method:: SetLipinskiAcc

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLipinskiAcc(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetLipinskiAcc(value: int) -> bool

      Sets the required number of Lipinski hydrogen bond acceptors for any selected analog.
      For the purpose of this measure, H-bond acceptors are determined by the method of
      Lipinski [Lipinski-1997]_.
      **Default: [Min: 2, Max: 11]**

   .. _OEBioisostere_OEExtrinsicPropOptions_SetLipinskiDon:
   .. oe:method:: SetLipinskiDon

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLipinskiDon(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetLipinskiDon(value: int) -> bool

      Sets the required number of Lipinski hydrogen bond donors for any selected analog.
      For the purpose of this measure, H-bond donors are determined by the method of
      Lipinski [Lipinski-1997]_.
      **Default: [Min: 1, Max: 8]**

   .. _OEBioisostere_OEExtrinsicPropOptions_SetLogP:
   .. oe:method:: SetLogP

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLogP(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetLogP(value: float) -> bool

      Sets the required calculated LogP for any selected analog.
      **Default: [Min: -1.0, Max: 5.0]**

   .. _OEBioisostere_OEExtrinsicPropOptions_SetMartin:
   .. oe:method:: SetMartin

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMartin(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMartin(value: float) -> bool

      Sets the required Abbott Bioavailability Score (ABS) for any selected analog.
      This floating point ABS parameter (range 0.0-1.0) indicates the minimum allowable 
      probability that F will be >10% in rats according the QSAR model developed and 
      published by Yvonne Martin [Martin-2005]_. A value of 0.0 will allow all compounds to pass.
      **Default: [Min: 0.2, Max: 1.0]**


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEFragConfReader, FragConfReader

.. _OEBioisostere_OEFragConfReader:

.. oe:class:: OEFragConfReader

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEFragConfReader

   This class defines an interface to perform fragment conformer sampling from
   provided 3D molecular structures.

   The :ref:`OEFragConfReader <OEBioisostere_OEFragConfReader>` class defines the following public methods:
    * :oe:meth:`Init<OEBioisostere::OEFragConfReader::Init>`
    * :oe:meth:`NumMols<OEBioisostere::OEFragConfReader::NumMols>`
    * :oe:meth:`ReadConformers<OEBioisostere::OEFragConfReader::ReadConformers>`

   

   .. _OEBioisostere_OEFragConfReader_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFragConfReader()

      .. oe:language:: python

         .. oe:api:: python

            OEFragConfReader() -> OEFragConfReader

      Default constructor.

   .. _OEBioisostere_OEFragConfReader_Init:
   .. oe:method:: Init

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Init(OEChem::oemolistream& ifs)

      .. oe:language:: python

         .. oe:api:: python

            Init(ifs: oemolistream) -> bool

      Initializes the reader with 3D molecules from which to sample fragment conformers.

   .. _OEBioisostere_OEFragConfReader_NumMols:
   .. oe:method:: NumMols

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned NumMols() const

      .. oe:language:: python

         .. oe:api:: python

            NumMols() -> int

      Returns the number of molecules obtained during initialization.

   .. _OEBioisostere_OEFragConfReader_ReadConformers:
   .. oe:method:: ReadConformers

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ReadConformers(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            ReadConformers(mol: OEMol) -> bool

      Reads fragment conformers from initialized molecule structures and
      outputs conformers into the provided molecule.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEFragOverlay, FragOverlay

.. _OEBioisostere_OEFragOverlay:

.. oe:class:: OEFragOverlay

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEFragOverlay: public OEBroodOverlayBase

   This class defines an interface for fragment overlay optimization
   against another fragment.

   The :ref:`OEFragOverlay <OEBioisostere_OEFragOverlay>` class defines the following public methods:
    * :oe:meth:`GetRefFrag<OEBioisostere::OEFragOverlay::GetRefFrag>`
    * :oe:meth:`SetupRef<OEBioisostere::OEFragOverlay::SetupRef>`
    * :oe:meth:`Transform<OEBioisostere::OEFragOverlay::Transform>`

   The following methods are publicly inherited from :ref:`OEBroodOverlayBase <OEBioisostere_OEBroodOverlayBase>`:
    * :oe:meth:`Overlay<OEBioisostere::OEBroodOverlayBase::Overlay>`

   .. _OEBioisostere_OEFragOverlay_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFragOverlay(const OEBroodGeneralOptions& genOpts = OEBroodGeneralOptions(),
                          const OEBroodScoreOptions& scoreOpts = OEBroodScoreOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEFragOverlay(genOpts: OEBroodGeneralOptions = OEBroodGeneralOptions(),
                          scoreOpts: OEBroodScoreOptions = OEBroodScoreOptions()) -> OEFragOverlay

      Default constructor.

   .. _OEBioisostere_OEFragOverlay_GetRefFrag:

   .. oe:method:: GetRefFrag

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRefFrag(OEChem::OEMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            GetRefFrag(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Gets the reference fragment currently set to perform overlay.
      Method returns ``true`` if successful, ``false`` otherwise.

   .. _OEBioisostere_OEFragOverlay_SetupRef:

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned SetupRef(const OEChem::OEMolBase& fragment)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(queryFrag: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Sets up the overlay optimization with the desired fragment molecule.
      Method returns :oe:const:`OEBioisostere::OEBroodStatusCode::Success` if
      the initialization is successful, otherwise returns an error code from the
      :oe:constns:`OEBioisostere::OEBroodStatusCode` namespace.

   .. _OEBioisostere_OEFragOverlay_Transform:

   .. oe:method:: Transform

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Transform(OEChem::OEMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            Transform(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Transforms the specified molecule to the optimized overlay position
      determined by a prior call to
      :oe:meth:`Overlay<OEBioisostere::OEBroodOverlayBase::Overlay>`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEFragmentOptions, FragmentOptions

.. _OEBioisostere_OEFragmentOptions:

.. oe:class:: OEFragmentOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEFragmentOptions : public OESystem::OEOptions

   This class provides an interface to set up options for fragmenting
   molecules when building a bioisosteric fragment database. These options
   control fragment generation, size constraints, and structural properties.

   The :ref:`OEFragmentOptions <OEBioisostere_OEFragmentOptions>` class defines the following public methods:
    * :oe:meth:`GetMaxChiral<OEBioisostere::OEFragmentOptions::GetMaxChiral>` and
      :oe:meth:`SetMaxChiral<OEBioisostere::OEFragmentOptions::SetMaxChiral>`
    * :oe:meth:`GetMaxDegree<OEBioisostere::OEFragmentOptions::GetMaxDegree>` and
      :oe:meth:`SetMaxDegree<OEBioisostere::OEFragmentOptions::SetMaxDegree>`
    * :oe:meth:`GetMaxHeavy<OEBioisostere::OEFragmentOptions::GetMaxHeavy>` and
      :oe:meth:`SetMaxHeavy<OEBioisostere::OEFragmentOptions::SetMaxHeavy>`
    * :oe:meth:`GetMaxMolWt<OEBioisostere::OEFragmentOptions::GetMaxMolWt>` and
      :oe:meth:`SetMaxMolWt<OEBioisostere::OEFragmentOptions::SetMaxMolWt>`
    * :oe:meth:`GetMinDegree<OEBioisostere::OEFragmentOptions::GetMinDegree>` and
      :oe:meth:`SetMinDegree<OEBioisostere::OEFragmentOptions::SetMinDegree>`
    * :oe:meth:`GetMinHeavy<OEBioisostere::OEFragmentOptions::GetMinHeavy>` and
      :oe:meth:`SetMinHeavy<OEBioisostere::OEFragmentOptions::SetMinHeavy>`
    * :oe:meth:`GetSingleSourceMol<OEBioisostere::OEFragmentOptions::GetSingleSourceMol>` and
      :oe:meth:`SetSingleSourceMol<OEBioisostere::OEFragmentOptions::SetSingleSourceMol>`
    * :oe:meth:`GetSmarts<OEBioisostere::OEFragmentOptions::GetSmarts>` and
      :oe:meth:`SetSmarts<OEBioisostere::OEFragmentOptions::SetSmarts>`
    * :oe:meth:`SetSmartsFile<OEBioisostere::OEFragmentOptions::SetSmartsFile>`
   

   .. _OEBioisostere_OEFragmentOptions_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFragmentOptions()
            OEFragmentOptions(const OEFragmentOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEFragmentOptions() -> OEFragmentOptions
            OEFragmentOptions(arg2: OEFragmentOptions) -> OEFragmentOptions

      Default and copy constructors.

   .. _OEBioisostere_OEFragmentOptions_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEFragmentOptions &operator=(const OEFragmentOptions &)

      Assignment operator.

   .. _OEBioisostere_OEFragmentOptions_GetMaxChiral:

   .. oe:method:: GetMaxChiral

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxChiral() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxChiral() -> int

      See :oe:meth:`SetMaxChiral<OEBioisostere::OEFragmentOptions::SetMaxChiral>` method.

   .. _OEBioisostere_OEFragmentOptions_GetMaxDegree:

   .. oe:method:: GetMaxDegree

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxDegree() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxDegree() -> int

      See :oe:meth:`SetMaxDegree<OEBioisostere::OEFragmentOptions::SetMaxDegree>` method.

   .. _OEBioisostere_OEFragmentOptions_GetMaxHeavy:

   .. oe:method:: GetMaxHeavy

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxHeavy() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHeavy() -> int

      See :oe:meth:`SetMaxHeavy<OEBioisostere::OEFragmentOptions::SetMaxHeavy>` method.

   .. _OEBioisostere_OEFragmentOptions_GetMaxMolWt:

   .. oe:method:: GetMaxMolWt

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMaxMolWt() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMolWt() -> float

      See :oe:meth:`SetMaxMolWt<OEBioisostere::OEFragmentOptions::SetMaxMolWt>` method.

   .. _OEBioisostere_OEFragmentOptions_GetMinDegree:

   .. oe:method:: GetMinDegree

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMinDegree() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinDegree() -> int

      See :oe:meth:`SetMinDegree<OEBioisostere::OEFragmentOptions::SetMinDegree>` method.

   .. _OEBioisostere_OEFragmentOptions_GetMinHeavy:

   .. oe:method:: GetMinHeavy

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMinHeavy() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinHeavy() -> int

      See :oe:meth:`SetMinHeavy<OEBioisostere::OEFragmentOptions::SetMinHeavy>` method.

   .. _OEBioisostere_OEFragmentOptions_GetSingleSourceMol:

   .. oe:method:: GetSingleSourceMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSingleSourceMol() const

      .. oe:language:: python

         .. oe:api:: python

            GetSingleSourceMol() -> bool

      See :oe:meth:`SetSingleSourceMol<OEBioisostere::OEFragmentOptions::SetSingleSourceMol>` method.

   .. _OEBioisostere_OEFragmentOptions_GetSmarts:

   .. oe:method:: GetSmarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetSmarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetSmarts() -> str

      See :oe:meth:`SetSmarts<OEBioisostere::OEFragmentOptions::SetSmarts>` method.

   .. _OEBioisostere_OEFragmentOptions_SetMaxChiral:

   .. oe:method:: SetMaxChiral

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxChiral(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxChiral(value: int) -> bool

      Sets the maximum allowable number of chiral centers (atom and bond) in
      generated fragments.
      **Default: 3.**

   .. _OEBioisostere_OEFragmentOptions_SetMaxDegree:

   .. oe:method:: SetMaxDegree

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxDegree(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxDegree(value: int) -> bool

      Sets the maximum allowed attachment points in generated fragments.
      **Default: 3.**

   .. _OEBioisostere_OEFragmentOptions_SetMaxHeavy:

   .. oe:method:: SetMaxHeavy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxHeavy(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHeavy(value: int) -> bool

      Sets the maximum allowed heavy atoms in generated fragments.
      **Default: 15.**

   .. _OEBioisostere_OEFragmentOptions_SetMaxMolWt:

   .. oe:method:: SetMaxMolWt

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxMolWt(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxMolWt(value: float) -> bool

      Sets the maximum allowed molecular weight for generated fragments.
      **Default: 350.**

   .. _OEBioisostere_OEFragmentOptions_SetMinDegree:

   .. oe:method:: SetMinDegree

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMinDegree(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMinDegree(value: int) -> bool

      Sets the minimum required attachment points in generated fragments.
      **Default: 1.**

   .. _OEBioisostere_OEFragmentOptions_SetMinHeavy:

   .. oe:method:: SetMinHeavy

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMinHeavy(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMinHeavy(value: int) -> bool

      Sets the minimum required heavy atoms in generated fragments.
      **Default: 1.**

   .. _OEBioisostere_OEFragmentOptions_SetSingleSourceMol:

   .. oe:method:: SetSingleSourceMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSingleSourceMol(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetSingleSourceMol(value: bool) -> bool

      Sets whether to store only a *single source molecule* per fragment.
      When disabled (default), stores information for up to five source molecules.
      **Default: false**

   .. _OEBioisostere_OEFragmentOptions_SetSmarts:

   .. oe:method:: SetSmarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSmarts(const std::string value)

      .. oe:language:: python

         .. oe:api:: python

            SetSmarts(value: str) -> bool

      Sets the SMARTS pattern for bonds to break during fragmentation.
      Built-in options are ``recap``, ``rlf``, ``both`` (both rlf and recap),
      and ``all``.
      **Default: all**

   .. _OEBioisostere_OEFragmentOptions_SetSmartsFile:

   .. oe:method:: SetSmartsFile

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSmartsFile(const std::string&)
            bool SetSmartsFile(const OEPlatform::oeisstream value)

      .. oe:language:: python

         .. oe:api:: python

            SetSmartsFile(value: oeisstream) -> bool
            SetSmartsFile(filename: str) -> bool

      Sets SMARTS patterns for bonds to break from a file. The first overload
      accepts a ``filename`` and the second accepts an
      :ref:`oeisstream<OEPlatform_oeisstream>`. This method takes precedence over the
      :oe:meth:`SetSmarts<OEBioisostere::OEFragmentOptions::SetSmarts>` method.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEHitlistBase, HitlistBase

.. _OEBioisostere_OEHitlistBase:

.. oe:class:: OEHitlistBase

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHitlistBase

   This is an abstract base class for hit list management that defines the common
   interface for collecting and filtering bioisosteric hits. 

   The following classes have been derived from this class:
    * :ref:`OEScoreHitlist <OEBioisostere_OEScoreHitlist>`
    * :ref:`OEBroodHitlist <OEBioisostere_OEBroodHitlist>`

   The :ref:`OEHitlistBase <OEBioisostere_OEHitlistBase>` class defines the following public methods:

    * :oe:meth:`Build<OEBioisostere::OEHitlistBase::Build>`
    * :oe:meth:`GetAddCount<OEBioisostere::OEHitlistBase::GetAddCount>`
    * :oe:meth:`GetDuplicateCount<OEBioisostere::OEHitlistBase::GetDuplicateCount>`
    * :oe:meth:`GetHitCount<OEBioisostere::OEHitlistBase::GetHitCount>`

   .. _OEBioisostere_OEHitlistBase_Build:

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            virtual bool Build(const bool final = true) = 0

      .. oe:language:: python

         .. oe:api:: python

            Build(final: bool = True) -> bool

      This method builds and finalizes the hit list, performing duplicate filtering and
      hit list creation. The ``final`` parameter controls whether this is the final
      build (``true``) or an intermediate build (``false``).

   .. _OEBioisostere_OEHitlistBase_GetAddCount:

   .. oe:method:: GetAddCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAddCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddCount() -> int

      This method returns the total number of entries submitted to the hit list.

   .. _OEBioisostere_OEHitlistBase_GetDuplicateCount:

   .. oe:method:: GetDuplicateCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetDuplicateCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetDuplicateCount() -> int

      This method returns the number of entries recognized as duplicates.

   .. _OEBioisostere_OEHitlistBase_GetHitCount:

   .. oe:method:: GetHitCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetHitCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetHitCount() -> int

      This method returns the number of retained hits currently in the hit list.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEHitlistBuilder, HitlistBuilder

.. _OEBioisostere_OEHitlistBuilder:

.. oe:class:: OEHitlistBuilder

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHitlistBuilder

   This class defines an interface for generating a hit list from calculated
   :ref:`Brood scores <OEBioisostere_OEBroodScore>`.

   The :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>` class defines the following public methods:
    * :oe:meth:`AddScores<OEBioisostere::OEHitlistBuilder::AddScores>`
    * :oe:meth:`Build<OEBioisostere::OEHitlistBuilder::Build>`
    * :oe:meth:`GetAddCount<OEBioisostere::OEHitlistBuilder::GetAddCount>`
    * :oe:meth:`GetBumpCount<OEBioisostere::OEHitlistBuilder::GetBumpCount>`
    * :oe:meth:`GetDeleteCount<OEBioisostere::OEHitlistBuilder::GetDeleteCount>`
    * :oe:meth:`GetDuplicateCount<OEBioisostere::OEHitlistBuilder::GetDuplicateCount>`
    * :oe:meth:`GetFailedCount<OEBioisostere::OEHitlistBuilder::GetFailedCount>`
    * :oe:meth:`GetHitCount<OEBioisostere::OEHitlistBuilder::GetHitCount>`
    * :oe:meth:`GetHits<OEBioisostere::OEHitlistBuilder::GetHits>`
    * :oe:meth:`GetInitHitCount<OEBioisostere::OEHitlistBuilder::GetInitHitCount>`
    * :oe:meth:`GetMatchCount<OEBioisostere::OEHitlistBuilder::GetMatchCount>`
    * :oe:meth:`GetSelectCount<OEBioisostere::OEHitlistBuilder::GetSelectCount>`
    * :oe:meth:`GetSecDuplicateCount<OEBioisostere::OEHitlistBuilder::GetSecDuplicateCount>`
    * :oe:meth:`GetStrainCount<OEBioisostere::OEHitlistBuilder::GetStrainCount>`
    * :oe:meth:`GetUnstableCount<OEBioisostere::OEHitlistBuilder::GetUnstableCount>`

   .. _OEBioisostere_OEHitlistBuilder_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHitlistBuilder(const OEBroodQuery& query,
                             const OEHitlistBuilderOptions& options)
            OEHitlistBuilder(const OEBroodQuery& query,
                             const OEBroodGeneralOptions& genOpts = OEBroodGeneralOptions(),
                             const OEBroodHitlistOptions& options = OEBroodHitlistOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEHitlistBuilder(query: OEBroodQuery,
                             options: OEHitlistBuilderOptions) -> OEHitlistBuilder
            OEHitlistBuilder(query: OEBroodQuery,
                             genOpts: OEBroodGeneralOptions = OEBroodGeneralOptions(),
                             options: OEBroodHitlistOptions = OEBroodHitlistOptions()) -> OEHitlistBuilder

      Default and copy constructors.

   .. _OEBioisostere_OEHitlistBuilder_AddScores:

   .. oe:method:: AddScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddScores(const std::vector<OEBroodScore> &)

      .. oe:language:: python

         .. oe:api:: python

            AddScores(arg2: OEBroodScoreVector) -> bool

      This method adds the specified scores for building the hit list.

   .. _OEBioisostere_OEHitlistBuilder_Build:

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Build(OESystem::OETracerBase& tracer = OESystem::OENoTracer)

      .. oe:language:: python

         .. oe:api:: python

            Build(tracer: OETracerBase = OENoTracer) -> bool

      This method builds the hit list. This method should be called after all scores have
      been added
      via :oe:meth:`AddScores<OEBioisostere::OEHitlistBuilder::AddScores>`.

   .. _OEBioisostere_OEHitlistBuilder_GetAddCount:

   .. oe:method:: GetAddCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAddCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddCount() -> int

      This method returns the total number of scores added.

   .. _OEBioisostere_OEHitlistBuilder_GetBumpCount: 

   .. oe:method:: GetBumpCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetBumpCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetBumpCount() -> int

      This method returns the total number of matches that were rejected due to bumping with protein.

   .. _OEBioisostere_OEHitlistBuilder_GetDeleteCount: 

   .. oe:method:: GetDeleteCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetDeleteCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeleteCount() -> int

      This method returns the total number of matches that were deleted.

   .. _OEBioisostere_OEHitlistBuilder_GetDuplicateCount: 

   .. oe:method:: GetDuplicateCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetDuplicateCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetDuplicateCount() -> int

      This method returns the total number of matches that were marked as duplicates.

   .. _OEBioisostere_OEHitlistBuilder_GetFailedCount: 

   .. oe:method:: GetFailedCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetFailedCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetFailedCount() -> int

      This method returns the total number of matches that were failed due to reasons other than
      being duplicated or having excessive strain, an unstable bond, or a protein clash. 
      These are failed whether due to unsuccessful protonation, elongated bond, 
      or the inability to calculate or attach the medicinal chemistry data.

   .. _OEBioisostere_OEHitlistBuilder_GetHitCount: 

   .. oe:method:: GetHitCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetHitCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetHitCount() -> int

      This method returns the total number of generated hits in the hit list.

   .. _OEBioisostere_OEHitlistBuilder_GetHits: 

   .. oe:method:: GetHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<OEBroodHit>& GetHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetHits() -> OEBroodHitVector

      This method returns the generated hits.

   .. _OEBioisostere_OEHitlistBuilder_GetInitHitCount:
   
   .. oe:method:: GetInitHitCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetInitHitCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetInitHitCount() -> int

      This method returns the initial size of the hit list.

   .. _OEBioisostere_OEHitlistBuilder_GetMatchCount: 

   .. oe:method:: GetMatchCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMatchCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetMatchCount() -> int

      This method returns the total number of matches found.

   .. _OEBioisostere_OEHitlistBuilder_GetSelectCount:

   .. oe:method:: GetSelectCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetSelectCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetSelectCount() -> int

      This method returns the number of matches rejected with
      :oe:const:`OEBioisostere::OEBroodStatusCode::SelectFail` during build.

   .. _OEBioisostere_OEHitlistBuilder_GetSecDuplicateCount:

   .. oe:method:: GetSecDuplicateCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetSecDuplicateCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetSecDuplicateCount() -> int

      This method returns the number of secondary duplicates.

   .. _OEBioisostere_OEHitlistBuilder_GetStrainCount:

   .. oe:method:: GetStrainCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetStrainCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrainCount() -> int

      This method returns the number of matches rejected due to strain.

   .. _OEBioisostere_OEHitlistBuilder_GetUnstableCount:

   .. oe:method:: GetUnstableCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetUnstableCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnstableCount() -> int

      This method returns the number of matches rejected due to unstable bonds.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEHitlistBuilderOptions, HitlistBuilderOptions

.. _OEBioisostere_OEHitlistBuilderOptions:

.. oe:class:: OEHitlistBuilderOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHitlistBuilderOptions : public OESystem::OEOptions

   This class defines configuration options for the :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>`
   and consolidates options from general, hit list, and build option groups.

   The :ref:`OEHitlistBuilderOptions <OEBioisostere_OEHitlistBuilderOptions>` class defines the following public methods:
    * :oe:meth:`GetBuildOptions<OEBioisostere::OEHitlistBuilderOptions::GetBuildOptions>` and
      :oe:meth:`SetBuildOptions<OEBioisostere::OEHitlistBuilderOptions::SetBuildOptions>`
    * :oe:meth:`GetGeneralOptions<OEBioisostere::OEHitlistBuilderOptions::GetGeneralOptions>` and
      :oe:meth:`SetGeneralOptions<OEBioisostere::OEHitlistBuilderOptions::SetGeneralOptions>`
    * :oe:meth:`GetHitlistOptions<OEBioisostere::OEHitlistBuilderOptions::GetHitlistOptions>` and
      :oe:meth:`SetHitlistOptions<OEBioisostere::OEHitlistBuilderOptions::SetHitlistOptions>`

   .. _OEBioisostere_OEHitlistBuilderOptions_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHitlistBuilderOptions()
            OEHitlistBuilderOptions(const OEHitlistBuilderOptions&)
            OEHitlistBuilderOptions& operator=(const OEHitlistBuilderOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEHitlistBuilderOptions() -> OEHitlistBuilderOptions
            OEHitlistBuilderOptions(arg2: OEHitlistBuilderOptions) -> OEHitlistBuilderOptions

      Default and copy constructors.

   .. _OEBioisostere_OEHitlistBuilderOptions_GetBuildOptions:

   .. oe:method:: GetBuildOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEBroodBuildOptions& GetBuildOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildOptions() -> OEBroodBuildOptions

      This method returns the :ref:`OEBroodBuildOptions <OEBioisostere_OEBroodBuildOptions>` contained in this object.

      See the :oe:meth:`SetBuildOptions<OEBioisostere::OEHitlistBuilderOptions::SetBuildOptions>` method.

   .. _OEBioisostere_OEHitlistBuilderOptions_GetGeneralOptions:

   .. oe:method:: GetGeneralOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEBroodGeneralOptions& GetGeneralOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetGeneralOptions() -> OEBroodGeneralOptions

      This method returns the :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>` contained in this object.

      See the :oe:meth:`SetGeneralOptions<OEBioisostere::OEHitlistBuilderOptions::SetGeneralOptions>` method.

   .. _OEBioisostere_OEHitlistBuilderOptions_GetHitlistOptions:

   .. oe:method:: GetHitlistOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEBroodHitlistOptions& GetHitlistOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetHitlistOptions() -> OEBroodHitlistOptions

      This method returns the :ref:`OEBroodHitlistOptions <OEBioisostere_OEBroodHitlistOptions>` contained in this object.

      See the :oe:meth:`SetHitlistOptions<OEBioisostere::OEHitlistBuilderOptions::SetHitlistOptions>` method.

   .. _OEBioisostere_OEHitlistBuilderOptions_SetBuildOptions:

   .. oe:method:: SetBuildOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBuildOptions(const OEBroodBuildOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetBuildOptions(opts: OEBroodBuildOptions) -> None

      This method sets the :ref:`OEBroodBuildOptions <OEBioisostere_OEBroodBuildOptions>` to be used.

   .. _OEBioisostere_OEHitlistBuilderOptions_SetGeneralOptions:

   .. oe:method:: SetGeneralOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetGeneralOptions(const OEBroodGeneralOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetGeneralOptions(opts: OEBroodGeneralOptions) -> None

      This method sets the :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>` to be used.

   .. _OEBioisostere_OEHitlistBuilderOptions_SetHitlistOptions:

   .. oe:method:: SetHitlistOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHitlistOptions(const OEBroodHitlistOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetHitlistOptions(opts: OEBroodHitlistOptions) -> None

      This method sets the :ref:`OEBroodHitlistOptions <OEBioisostere_OEBroodHitlistOptions>` to be used.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEIntrinsicPropOptions, IntrinsicPropOptions

.. _OEBioisostere_OEIntrinsicPropOptions:

.. oe:class:: OEIntrinsicPropOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEIntrinsicPropOptions : public OESystem::OEOptions

   This class provides an interface to set up options related to medicinal chemistry
   property limits during fragment replacement scoring.

   The :ref:`OEIntrinsicPropOptions <OEBioisostere_OEIntrinsicPropOptions>` class defines the following public methods:
    * :oe:meth:`GetAromaticJCT<OEBioisostere::OEIntrinsicPropOptions::GetAromaticJCT>` and
      :oe:meth:`SetAromaticJCT<OEBioisostere::OEIntrinsicPropOptions::SetAromaticJCT>`
    * :oe:meth:`GetHeavyAtomCount<OEBioisostere::OEIntrinsicPropOptions::GetHeavyAtomCount>` and
      :oe:meth:`SetHeavyAtomCount<OEBioisostere::OEIntrinsicPropOptions::SetHeavyAtomCount>`
    * :oe:meth:`GetMolWt<OEBioisostere::OEIntrinsicPropOptions::GetMolWt>` and
      :oe:meth:`SetMolWt<OEBioisostere::OEIntrinsicPropOptions::SetMolWt>`
    * :oe:meth:`GetRotorCount<OEBioisostere::OEIntrinsicPropOptions::GetRotorCount>` and
      :oe:meth:`SetRotorCount<OEBioisostere::OEIntrinsicPropOptions::SetRotorCount>`
    * :oe:meth:`GetSp3CFrac<OEBioisostere::OEIntrinsicPropOptions::GetSp3CFrac>` and
      :oe:meth:`SetSp3CFrac<OEBioisostere::OEIntrinsicPropOptions::SetSp3CFrac>`
    * :oe:meth:`GetTPSA<OEBioisostere::OEIntrinsicPropOptions::GetTPSA>` and
      :oe:meth:`SetTPSA<OEBioisostere::OEIntrinsicPropOptions::SetTPSA>`

   .. _OEBioisostere_OEIntrinsicPropOptions_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIntrinsicPropOptions(const unsigned type = OEBroodMolPropertyType::MIN)
            OEIntrinsicPropOptions(const OEIntrinsicPropOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEIntrinsicPropOptions(type: int) -> OEIntrinsicPropOptions
            OEIntrinsicPropOptions(arg2: OEIntrinsicPropOptions) -> OEIntrinsicPropOptions

      Default and copy constructors.

   .. _OEBioisostere_OEIntrinsicPropOptions_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEIntrinsicPropOptions &operator=(const OEIntrinsicPropOptions &)

      Assignment operator.

   .. _OEBioisostere_OEIntrinsicPropOptions_GetAromaticJCT:
   .. oe:method:: GetAromaticJCT

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAromaticJCT() const

      .. oe:language:: python

         .. oe:api:: python

            GetAromaticJCT() -> int

      See :oe:meth:`SetAromaticJCT<OEBioisostere::OEIntrinsicPropOptions::SetAromaticJCT>` method.

   .. _OEBioisostere_OEIntrinsicPropOptions_GetHeavyAtomCount:
   .. oe:method:: GetHeavyAtomCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetHeavyAtomCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeavyAtomCount() -> int

      See :oe:meth:`SetHeavyAtomCount<OEBioisostere::OEIntrinsicPropOptions::SetHeavyAtomCount>` method.

   .. _OEBioisostere_OEIntrinsicPropOptions_GetMolWt:
   .. oe:method:: GetMolWt

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMolWt() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolWt() -> float

      See :oe:meth:`SetMolWt<OEBioisostere::OEIntrinsicPropOptions::SetMolWt>` method.

   .. _OEBioisostere_OEIntrinsicPropOptions_GetRotorCount:
   .. oe:method:: GetRotorCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetRotorCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotorCount() -> int

      See :oe:meth:`SetRotorCount<OEBioisostere::OEIntrinsicPropOptions::SetRotorCount>` method.

   .. _OEBioisostere_OEIntrinsicPropOptions_GetSp3CFrac:
   .. oe:method:: GetSp3CFrac

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSp3CFrac() const

      .. oe:language:: python

         .. oe:api:: python

            GetSp3CFrac() -> float

      See :oe:meth:`SetSp3CFrac<OEBioisostere::OEIntrinsicPropOptions::SetSp3CFrac>` method.

   .. _OEBioisostere_OEIntrinsicPropOptions_GetTPSA:
   .. oe:method:: GetTPSA

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetTPSA() const

      .. oe:language:: python

         .. oe:api:: python

            GetTPSA() -> int

      See :oe:meth:`SetTPSA<OEBioisostere::OEIntrinsicPropOptions::SetTPSA>` method.

   .. _OEBioisostere_OEIntrinsicPropOptions_SetAromaticJCT:
   .. oe:method:: SetAromaticJCT

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAromaticJCT(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetAromaticJCT(value: int) -> bool

      Sets the aromatic ring count for any selected analog. The number of aromatic rings
      is defined as the number of aromatic rings is #aromatic bonds - #aromatic atoms + 1
      **Default: [Min: 0, Max: 5]**

   .. _OEBioisostere_OEIntrinsicPropOptions_SetHeavyAtomCount:
   .. oe:method:: SetHeavyAtomCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetHeavyAtomCount(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetHeavyAtomCount(value: int) -> bool

      Sets the number of heavy atoms for any selected analog.
      **Default: [Min: 7, Max: 35]**

   .. _OEBioisostere_OEIntrinsicPropOptions_SetMolWt:
   .. oe:method:: SetMolWt

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMolWt(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMolWt(value: float) -> bool

      Sets the required molecular weight for any selected analog.
      **Default: [Min: 100, Max: 500]**

   .. _OEBioisostere_OEIntrinsicPropOptions_SetRotorCount:
   .. oe:method:: SetRotorCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRotorCount(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetRotorCount(value: int) -> bool

      Sets the required number of rotatable bonds for any selected analog.
      **Default: [Min: 0, Max: 13]**

   .. _OEBioisostere_OEIntrinsicPropOptions_SetSp3CFrac:
   .. oe:method:: SetSp3CFrac

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSp3CFrac(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetSp3CFrac(value: float) -> bool

      Sets the required fraction of carbons that are sp\ :sup:`3` for any selected analog.
      There is some evidence that increasing the fraction of carbons in a series that 
      are sp\ :sup:`3` (escaping from “Flatland”) improved success in clinical trials [Lovering-2009].
      **Default: [Min: 0.3, Max: 1.0]**

   .. _OEBioisostere_OEIntrinsicPropOptions_SetTPSA:
   .. oe:method:: SetTPSA

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTPSA(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetTPSA(value: int) -> bool

      Sets the required topological polar surface area (TPSA) for any selected analog.
      **Default: [Min: 60, Max: 150]**


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEMolCTBuilder, MolCTBuilder

.. _OEBioisostere_OEMolCTBuilder:

.. oe:class:: OEMolCTBuilder

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMolCTBuilder

   This class builds molecule from structural connection table during bioisosteric 
   fragment replacements, including validation of required chemical constraints.

   The :ref:`OEMolCTBuilder <OEBioisostere_OEMolCTBuilder>` class defines the following public method:
    * :oe:meth:`Build<OEBioisostere::OEMolCTBuilder::Build>`

   .. _OEBioisostere_OEMolCTBuilder_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolCTBuilder(const OEBroodQuery& query,
                           const OEBroodGeneralOptions& genOpts = OEBroodGeneralOptions(),
                           const OEBroodBuildOptions& options = OEBroodBuildOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEMolCTBuilder(query: OEBroodQuery,
                           genOpts: OEBroodGeneralOptions = OEBroodGeneralOptions(),
                           options: OEBroodBuildOptions = OEBroodBuildOptions()) -> OEMolCTBuilder

      This method constructs an :ref:`OEMolCTBuilder <OEBioisostere_OEMolCTBuilder>` with
      query and option settings that define the connection-table validation
      context.

   .. _OEBioisostere_OEMolCTBuilder_Build:

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Build(OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Build(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This method validates the connection table of the given molecule based on query
      constraints. It returns ``true`` if the molecule connection table is valid and
      ``false`` otherwise.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEMolPropertyOptions, MolPropertyOptions

.. _OEBioisostere_OEMolPropertyOptions:

.. oe:class:: OEMolPropertyOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMolPropertyOptions : public OESystem::OEOptions

   This class provides an interface to set up options related to medicinal chemistry
   property limits during fragment replacement scoring.

   The :ref:`OEMolPropertyOptions <OEBioisostere_OEMolPropertyOptions>` class defines the following public methods:
    * :oe:meth:`GetEganEgg<OEBioisostere::OEMolPropertyOptions::GetEganEgg>` and
      :oe:meth:`SetEganEgg<OEBioisostere::OEMolPropertyOptions::SetEganEgg>`
    * :oe:meth:`GetExtrinsicMaxOptions<OEBioisostere::OEMolPropertyOptions::GetExtrinsicMaxOptions>` and
      :oe:meth:`SetExtrinsicMaxOptions<OEBioisostere::OEMolPropertyOptions::SetExtrinsicMaxOptions>`
    * :oe:meth:`GetExtrinsicMinOptions<OEBioisostere::OEMolPropertyOptions::GetExtrinsicMinOptions>` and
      :oe:meth:`SetExtrinsicMinOptions<OEBioisostere::OEMolPropertyOptions::SetExtrinsicMinOptions>`
    * :oe:meth:`GetIntrinsicMaxOptions<OEBioisostere::OEMolPropertyOptions::GetIntrinsicMaxOptions>` and
      :oe:meth:`SetIntrinsicMaxOptions<OEBioisostere::OEMolPropertyOptions::SetIntrinsicMaxOptions>`
    * :oe:meth:`GetIntrinsicMinOptions<OEBioisostere::OEMolPropertyOptions::GetIntrinsicMinOptions>` and
      :oe:meth:`SetIntrinsicMinOptions<OEBioisostere::OEMolPropertyOptions::SetIntrinsicMinOptions>`
    * :oe:meth:`GetVeber<OEBioisostere::OEMolPropertyOptions::GetVeber>` and
      :oe:meth:`SetVeber<OEBioisostere::OEMolPropertyOptions::SetVeber>`

   .. _OEBioisostere_OEMolPropertyOptions_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolPropertyOptions()
            OEMolPropertyOptions(const OEMolPropertyOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEMolPropertyOptions() -> OEMolPropertyOptions
            OEMolPropertyOptions(arg2: OEMolPropertyOptions) -> OEMolPropertyOptions

      Default and copy constructors.

   .. _OEBioisostere_OEMolPropertyOptions_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEMolPropertyOptions &operator=(const OEMolPropertyOptions &)

      Assignment operator.

   .. _OEBioisostere_OEMolPropertyOptions_GetEganEgg:
   .. oe:method:: GetEganEgg

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEganEgg() const

      .. oe:language:: python

         .. oe:api:: python

            GetEganEgg() -> bool

      See :oe:meth:`SetEganEgg<OEBioisostere::OEMolPropertyOptions::SetEganEgg>` method.

   .. _OEBioisostere_OEMolPropertyOptions_GetExtrinsicMaxOptions:
   .. oe:method:: GetExtrinsicMaxOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExtrinsicPropOptions& GetExtrinsicMaxOptions()
            const OEExtrinsicPropOptions& GetExtrinsicMaxOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetExtrinsicMaxOptions() -> OEExtrinsicPropOptions

      See :oe:meth:`SetExtrinsicMaxOptions<OEBioisostere::OEMolPropertyOptions::SetExtrinsicMaxOptions>` method.

   .. _OEBioisostere_OEMolPropertyOptions_GetExtrinsicMinOptions:
   .. oe:method:: GetExtrinsicMinOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExtrinsicPropOptions& GetExtrinsicMinOptions()
            const OEExtrinsicPropOptions& GetExtrinsicMinOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetExtrinsicMinOptions() -> OEExtrinsicPropOptions

      See :oe:meth:`SetExtrinsicMinOptions<OEBioisostere::OEMolPropertyOptions::SetExtrinsicMinOptions>` method.

   .. _OEBioisostere_OEMolPropertyOptions_GetIntrinsicMaxOptions:
   .. oe:method:: GetIntrinsicMaxOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIntrinsicPropOptions& GetIntrinsicMaxOptions()
            const OEIntrinsicPropOptions& GetIntrinsicMaxOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetIntrinsicMaxOptions() -> OEIntrinsicPropOptions

      See :oe:meth:`SetIntrinsicMaxOptions<OEBioisostere::OEMolPropertyOptions::SetIntrinsicMaxOptions>` method.

   .. _OEBioisostere_OEMolPropertyOptions_GetIntrinsicMinOptions:
   .. oe:method:: GetIntrinsicMinOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIntrinsicPropOptions& GetIntrinsicMinOptions()
            const OEIntrinsicPropOptions& GetIntrinsicMinOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetIntrinsicMinOptions() -> OEIntrinsicPropOptions

      See :oe:meth:`SetIntrinsicMinOptions<OEBioisostere::OEMolPropertyOptions::SetIntrinsicMinOptions>` method.

   .. _OEBioisostere_OEMolPropertyOptions_GetVeber:
   .. oe:method:: GetVeber

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetVeber() const

      .. oe:language:: python

         .. oe:api:: python

            GetVeber() -> bool

      See :oe:meth:`SetVeber<OEBioisostere::OEMolPropertyOptions::SetVeber>` method.

   .. _OEBioisostere_OEMolPropertyOptions_SetEganEgg:
   .. oe:method:: SetEganEgg

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEganEgg(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEganEgg(value: bool) -> bool

      Sets the requirement to fulfill the “Egan egg” measure of bioavailability for
      any selected analog. This measure was published by Bill Egan while at Pharmacopia [Egan-2000]_
      and rejects compounds with a LogP > 5.88 or a PSA > 131.6. 
      **Default: true**

   .. _OEBioisostere_OEMolPropertyOptions_SetExtrinsicMaxOptions:
   .. oe:method:: SetExtrinsicMaxOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetExtrinsicMaxOptions(const OEExtrinsicPropOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetExtrinsicMaxOptions(opts: OEExtrinsicPropOptions) -> None

      Sets :oe:cls:`options <OEBioisostere::OEExtrinsicPropOptions>` related to maximum 
      values of the extrinsic molecule properties.

   .. _OEBioisostere_OEMolPropertyOptions_SetExtrinsicMinOptions:
   .. oe:method:: SetExtrinsicMinOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetExtrinsicMinOptions(const OEExtrinsicPropOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetExtrinsicMinOptions(opts: OEExtrinsicPropOptions) -> None

      Sets :oe:cls:`options <OEBioisostere::OEExtrinsicPropOptions>` related to minimum
      values of the extrinsic molecule properties.

   .. _OEBioisostere_OEMolPropertyOptions_SetIntrinsicMaxOptions:
   .. oe:method:: SetIntrinsicMaxOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetIntrinsicMaxOptions(const OEIntrinsicPropOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetIntrinsicMaxOptions(opts: OEIntrinsicPropOptions) -> None

      Sets :oe:cls:`options <OEBioisostere::OEIntrinsicPropOptions>` related to maximum 
      values of the intrinsic molecule properties.

   .. _OEBioisostere_OEMolPropertyOptions_SetIntrinsicMinOptions:
   .. oe:method:: SetIntrinsicMinOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetIntrinsicMinOptions(const OEIntrinsicPropOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetIntrinsicMinOptions(opts: OEIntrinsicPropOptions) -> None

      Sets :oe:cls:`options <OEBioisostere::OEIntrinsicPropOptions>` related to minimum
      values of the intrinsic molecule properties.

   .. _OEBioisostere_OEMolPropertyOptions_SetVeber:
   .. oe:method:: SetVeber

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetVeber(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetVeber(value: bool) -> bool

      Sets the requirement to fulfill the measure of Veber bioavailability for any
      selected analog. This eliminates compounds with a PSA > 140 or more than 10 rotatable bonds.
      Veber measured bioavailability during his time at GSK [Veber-2002]_.
      **Default: False**


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEScoreHitlist, ScoreHitlist

.. _OEBioisostere_OEScoreHitlist:

.. oe:class:: OEScoreHitlist

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEScoreHitlist: public OEHitlistBase

   This class collects and manages scores from overlay operations, filtering
   duplicates and creating a hit list of unique, high-scoring fragment matches.

   The :ref:`OEScoreHitlist <OEBioisostere_OEScoreHitlist>` class defines the following public methods:

    * :oe:meth:`AddScores<OEBioisostere::OEScoreHitlist::AddScores>`
    * :oe:meth:`Build<OEBioisostere::OEScoreHitlist::Build>`
    * :oe:meth:`GetHits<OEBioisostere::OEScoreHitlist::GetHits>`
    * :oe:meth:`GetMatchCount<OEBioisostere::OEScoreHitlist::GetMatchCount>`

   .. _OEBioisostere_OEScoreHitlist_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEScoreHitlist(const unsigned maxHits = 1000)

      .. oe:language:: python

         .. oe:api:: python

            OEScoreHitlist(maxHits: int = 1000) -> OEScoreHitlist

      This method constructs an :ref:`OEScoreHitlist <OEBioisostere_OEScoreHitlist>` with
      a specified maximum number of hits to retain.

   .. _OEBioisostere_OEScoreHitlist_AddScores:

   .. oe:method:: AddScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddScores(const std::vector<OEBroodScore>&)

      .. oe:language:: python

         .. oe:api:: python

            AddScores(arg2: OEBroodScoreVector) -> bool

      This method adds a batch of :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` objects
      for score-stage hit list curation.

   .. _OEBioisostere_OEScoreHitlist_Build:

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Build(const bool final = true) override

      .. oe:language:: python

         .. oe:api:: python

            Build(final: bool = True) -> bool

      This method builds the final hit list from all added scores, filtering duplicates
      and retaining the top-scoring unique fragments.

   .. _OEBioisostere_OEScoreHitlist_GetHits:

   .. oe:method:: GetHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<OEBroodScore>& GetHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetHits() -> OEBroodScoreVector

      This method returns curated score-level hits as
      :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` objects.

   .. _OEBioisostere_OEScoreHitlist_GetMatchCount:

   .. oe:method:: GetMatchCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMatchCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetMatchCount() -> int

      This method returns the number of unique score matches retained in the hit list.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OESimilarity, Similarity

.. _OEBioisostere_OESimilarity:

.. oe:class:: OESimilarity

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OESimilarity

   This class is a container for overlap-derived similarity components and
   derivative metrics. :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` consists of
   multiple instances of :ref:`OESimilarity <OEBioisostere_OESimilarity>` of
   various types.

   The :ref:`OESimilarity <OEBioisostere_OESimilarity>` class defines the following public methods:
    * :oe:meth:`Add<OEBioisostere::OESimilarity::Add>`
    * :oe:meth:`GetFitScore<OEBioisostere::OESimilarity::GetFitScore>`
    * :oe:meth:`GetOverlap<OEBioisostere::OESimilarity::GetOverlap>`
    * :oe:meth:`GetRefScore<OEBioisostere::OESimilarity::GetRefScore>`
    * :oe:meth:`GetScaledScore<OEBioisostere::OESimilarity::GetScaledScore>`
    * :oe:meth:`GetTanimoto<OEBioisostere::OESimilarity::GetTanimoto>`
    * :oe:meth:`Load<OEBioisostere::OESimilarity::Load>`
    * :oe:meth:`ToRecord<OEBioisostere::OESimilarity::ToRecord>`

   .. _OEBioisostere_OESimilarity_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESimilarity(const double refScore = 0.0,
                         const double fitScore = 0.0,
                         const double ovScore = 0.0,
                         const unsigned type = OEBroodScoreType::ROCS)
            OESimilarity(const OESimilarity&)

      .. oe:language:: python

         .. oe:api:: python

            OESimilarity(refScore: float = 0.0, fitScore: float = 0.0,
                         ovScore: float = 0.0, type: int) -> OESimilarity
            OESimilarity(arg2: OESimilarity) -> OESimilarity

      Default and copy constructors.

      The ``type`` argument selects the scoring mode used when deriving the
      Tanimoto and scaled metrics. It accepts one of the following values from
      the :oe:constns:`OEBioisostere::OEBroodScoreType` namespace:

       * :oe:const:`OEBioisostere::OEBroodScoreType::ROCS` - shape and color based scoring.
       * :oe:const:`OEBioisostere::OEBroodScoreType::ET` - shape and electrostatics based scoring.

      The default value is :oe:const:`OEBioisostere::OEBroodScoreType::ROCS`.

   .. _OEBioisostere_OESimilarity_operator=:

   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OESimilarity& operator=(const OESimilarity&)

      Assignment operator.

   .. _OEBioisostere_OESimilarity_Add:

   .. oe:method:: Add

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Add(const OESimilarity&)

      .. oe:language:: python

         .. oe:api:: python

            Add(arg2: OESimilarity) -> bool

      This method adds the scores from another :ref:`OESimilarity <OEBioisostere_OESimilarity>` object
      to this object and recalculates the combined Tanimoto score.

   .. _OEBioisostere_OESimilarity_GetFitScore:

   .. oe:method:: GetFitScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetFitScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitScore() -> float

      This method returns the fit score component of the similarity calculation.

   .. _OEBioisostere_OESimilarity_GetOverlap:

   .. oe:method:: GetOverlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlap() -> float

      This method returns the overlap score component of the similarity calculation.

   .. _OEBioisostere_OESimilarity_GetRefScore:

   .. oe:method:: GetRefScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRefScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefScore() -> float

      This method returns the reference score component of the similarity calculation.

   .. _OEBioisostere_OESimilarity_GetScaledScore:

   .. oe:method:: GetScaledScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetScaledScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetScaledScore() -> float

      This method returns the scaled score, calculated as the ratio of overlap to reference score.

   .. _OEBioisostere_OESimilarity_GetTanimoto:

   .. oe:method:: GetTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimoto() -> float

      This method returns the calculated Tanimoto coefficient based on the similarity scores.

   .. _OEBioisostere_OESimilarity_Load:

   .. oe:method:: Load

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Load(const OEDataFlow::OERecord&)

      .. oe:language:: python

         .. oe:api:: python

            Load(arg2: OERecord) -> bool

      This method loads the similarity scores from an :ref:`OERecord <OEDataFlow_OERecord>`.

   .. _OEBioisostere_OESimilarity_ToRecord:

   .. oe:method:: ToRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ToRecord(OEDataFlow::OERecord&) const

      .. oe:language:: python

         .. oe:api:: python

            ToRecord(arg2: OERecord) -> bool

      This method stores the similarity scores onto an :ref:`OERecord <OEDataFlow_OERecord>`.



.. _OEBioisostereConstants:

************************************
Preliminary OEBioisostere Constants
************************************

.. oe:namespace:: OEBioisostere

.. toctree::

   OEBroodBuildType
   OEBroodMolPropertyType
   OEBroodScoreType
   OEBroodStatusCode


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

..  _OEBioisostere_OEBroodBuildType:

.. oe:constnamespace:: OEBroodBuildType

   .. attention::

      |PRELIMINARY-API|

   This namespace contains constants.

   ..  _OEBioisostere_OEBroodBuildType_Optimize3D:

   .. oe:constant:: Optimize3D

      Build 3D molecule with replaced fragment, and optimize

   ..  _OEBioisostere_OEBroodBuildType_NoOpt3D:

   .. oe:constant:: NoOpt3D

      Build 3D molecule with replaced fragment, but skip optimization

   ..  _OEBioisostere_OEBroodBuildType_TwoD:

   .. oe:constant:: TwoD

      Build 2D molecule with replaced fragment


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodMolPropertyType

.. _OEBioisostere_OEBroodMolPropertyType:

.. oe:constnamespace:: OEBroodMolPropertyType

   .. attention::

      |PRELIMINARY-API|

   This namespace defines constants used to specify property comparison types
   when filtering molecules during bioisosteric replacement.

   .. oe:constant::  MIN

      Specifies minimum value comparison for molecular properties.

   ..  _OEBioisostere_OEBroodScoreType_OEBroodMolPropertyType_MIN:
      

   .. oe:constant::  MAX

      Specifies maximum value comparison for molecular properties.

   ..  _OEBioisostere_OEBroodScoreType_OEBroodMolPropertyType_MAX:
   



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

..  _OEBioisostere_OEBroodScoreType:

.. oe:constnamespace:: OEBroodScoreType

   .. attention::

      |PRELIMINARY-API|

   This namespace contains constants.

   ..  _OEBioisostere_OEBroodScoreType_ET:

   .. oe:constant:: ET

      Scoring based on shape and electrostatics

   ..  _OEBioisostere_OEBroodScoreType_LinkOnly:

   .. oe:constant:: LinkOnly

      Scoring based on attachments only

   ..  _OEBioisostere_OEBroodScoreType_ROCS:

   .. oe:constant:: ROCS

      Scoring based on shape and color


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

..  _OEBioisostere_OEBroodStatusCode:

.. oe:constnamespace:: OEBroodStatusCode

   .. attention::

      |PRELIMINARY-API|

   This namespace contains constants. The error code number can be extracted using :oe:func:`OEBioisostere::OEGetBroodStatus`.

   .. oe:constant:: BondOrderMismatch

      Mismatch attachment bond orders

   .. oe:constant:: DBSetupFailed

      Failed to setup database reader with query molecule

   .. oe:constant:: EmptyDatabase   

      Database is empty of fragments

   .. oe:constant:: ExcessStrain

      Excess strain  

   .. oe:constant:: Failed

      Failed

   .. oe:constant:: Failed2DConstr

      Failed to pass 2D constraint

   .. oe:constant:: FailedAttachCut

      Failed to pass attachment cutoff

   .. oe:constant:: FailedConstraints

      Failed to pass 3D constraints & receptor clash

   .. oe:constant:: FailedETAttach

      ET attach failure

   .. oe:constant:: FailedFragFilter

      Failed to initialize fragment filtering

   .. oe:constant:: FailedInit

      Failed to initialize database fragment

   .. oe:constant:: FailedInitAttach

      Failed to initialize attachment geometries

   .. oe:constant:: FailedPropFilter

      Failed to pass property filter

   .. oe:constant:: FailedProteinSelect

      Protein receptor/selection failure

   .. oe:constant:: FailedQueryInit

      Failed query initialization

   .. oe:constant:: FailedQueryMolRead

      Failed to read query molecule

   .. oe:constant:: FailedRMSCut

      Failed to pass rms Cutoff

   .. oe:constant:: FailedSetupOpt

      Failed to setup optimization

   .. oe:constant:: FailedShapeCut

      Failed to pass shape Cutoff

   .. oe:constant:: HasRingAtoms

      Has ring atoms

   .. oe:constant:: InsuffRingAtoms

      Insufficient ring atoms

   .. oe:constant:: InvalidOptions

      Invalid Options

   .. oe:constant:: InvalidScore

      Invalid Score

   .. oe:constant:: InvalidQuery3D

      Query molecule must have 3D coordinates

   .. oe:constant:: InvalidQueryAttach

      Query selection contains none or more than 3 attachments

   .. oe:constant:: InvalidQueryMol

      Invalid query molecule

   .. oe:constant:: InvalidQueryNoHeavyAtoms

      Query selection contains no heavy atoms

   .. oe:constant:: InvalidQueryProtein

      Invalid query protein

   .. oe:constant:: InvalidQueryRing

      Query selection contains invalid partial ring

   .. oe:constant:: InvalidQuerySel

      Query selection does not match molecule

   .. oe:constant:: InvalidQuerySelProt

      Invalid query selectivity protein

   
   .. oe:constant:: ManifestCheckFailed

      Manifest check failed to find a complete brood database

   .. oe:constant:: MissingQueryFrag

      Missing query fragment

   .. oe:constant:: NewFPGenerated

      New fingerprints generated

   .. oe:constant:: NoAttachPt

      No attachment points in database fragment

   .. oe:constant:: NoConformers

      No conformers available in DB fragment

   .. oe:constant:: NoCPDDBGenerated

      Unable to generate similarity database from cpddb

   .. oe:constant:: NoRingAtoms

      No ring atoms

   .. oe:constant:: NoSelectionClash

      No selection clash

   .. oe:constant:: PreGeneratedFPDetected

      Identified and using pre-generated fingerprints for cpddb similarity

   .. oe:constant:: ProteinBump

      Molecule clashes with protein

   .. oe:constant:: ReceptorClash

      Receptor clash

   .. oe:constant:: SelectFail

      Molecule not clashing with selection protein

    ..  _OEBioisostere_OEBroodStatusCode_Success:

   .. oe:constant:: Success

      Success

   .. oe:constant:: UnableToFindDatabase

      Unable to find brood database directory

   
   .. oe:constant:: UnableToOpenDatabase

      Unable to open database (corrupt or nonexistent file)

   .. oe:constant:: UnequalAttachPt

      Different number of attachments

   .. oe:constant:: UnstableBonds

      Unstable bonds


.. _OEBioisostereFunctions:

************************************
Preliminary OEBioisostere Functions
************************************

.. oe:namespace:: OEBioisostere

.. toctree::

   OEBioisostereGetArch
   OEBioisostereGetLicensee
   OEBioisostereGetPlatform
   OEBioisostereGetRelease
   OEBioisostereGetSite
   OEBioisostereGetVersion
   OEBioisostereIsLicensed
   OECreateBroodQuery
   OECreateFragFilter
   OECreateFlipperOptions
   OEGenerateConformers
   OEGetBroodStatus
   OEGetDBIndices
   OEIsFragment
   OEReadBroodQuery
   OEWriteBroodQuery


.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBioisostereGetArch

.. _OEBioisostere_OEBioisostereGetArch:

.. oe:function:: OEBioisostereGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEBioisostereGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEBioisostereGetArch() -> str

   Returns the architecture of the current version of Bioisostere
   TK. Examples include:

   * microsoft-win32-x86

   * redhat-RHEL9-x86_64


.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEShapeGetLicensee

.. _OEBioisostere_OEBioisostereGetLicensee:

.. oe:function:: OEBioisostereGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEBioisostereGetLicensee()
         bool OEBioisostereGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEBioisostereGetLicensee() -> str
         OEBioisostereGetLicensee(licensee: str) -> bool

   Returns the LICENSEE from the current valid Bioisostere TK license.


.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBioisostereGetPlatform

.. _OEBioisostere_OEBioisostereGetPlatform:

.. oe:function:: OEBioisostereGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEBioisostereGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEBioisostereGetPlatform() -> str

   Returns the platform, including compiler version, of the current
   version of Bioisostere TK. Examples include:

   * microsoft-win32-msvc9-MD-x86

   * redhat-RHEL9-g++11.11-x86_64


.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBioisostereGetRelease

.. _OEBioisostere_OEBioisostereGetRelease:

.. oe:function:: OEBioisostereGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEBioisostereGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEBioisostereGetRelease() -> str

   Returns the version of this toolkit release. For example: ``4.0.0``.


.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBioisostereGetSite

.. _OEBioisostere_OEBioisostereGetSite:

.. oe:function:: OEBioisostereGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEBioisostereGetSite()
         bool OEBioisostereGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEBioisostereGetSite() -> str
         OEBioisostereGetSite(site: str) -> bool

   Returns the SITE from the current valid Bioisostere TK license.

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBioisostereGetVersion

.. _OEBioisostere_OEBioisostereGetVersion:

.. oe:function:: OEBioisostereGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEBioisostereGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEBioisostereGetVersion() -> int

   Returns the build date of the toolkit as an unsigned int. For example: ``20240227``.


.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBioisostereIsLicensed

.. _OEBioisostere_OEBioisostereIsLicensed:

.. oe:function:: OEBioisostereIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBioisostereIsLicensed(const char* feature = 0,
                                      unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEBioisostereIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **Bioisostere TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **Bioisostere TK** along with the following features: 'python'.
   Pass ``nullptr`` (or ``0``) to check the default **Bioisostere TK** feature.

   The 'expdate' argument can be used to obtain the expiration date of
   the current **Bioisostere TK** license. If non-null, the expiration date
   is written as a ``YYYYMMDD`` integer. Pass ``nullptr`` to ignore.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. _OEBioisostere_OECreateBroodQuery:

.. oe:function:: OECreateBroodQuery

   **Query Creation without Protein**

   .. _api_brood_query_no_protein:

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& mol,
                                     const OEChem::OEMatchBase& selection)
         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& mol,
                                     const OEChem::OEAtomBondSet& selection)

   .. oe:language:: python

      .. oe:api:: python

         OECreateBroodQuery(query: OEBroodQuery, mol: OEMol,
                            selection: OEAtomBondSet) -> int
         OECreateBroodQuery(query: OEBroodQuery, mol: OEMol,
                            selection: OEMatchBase) -> int

   Creates a **BROOD** query. The function returns a status code from
   :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.

   *query*

      The :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` to be created.

   *mol*

     The input molecule from which a query is to be created by replacing a fragment
     of the molecule.  

   *selection*

      Criteria for selecting atoms and bonds of the molecule that becomes
      the fragment to be replaced.  The atoms and bonds must collectively
      become a single fragment.

   **Query Creation with Associated Protein**

   .. _api_brood_query_with_protein:

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& mol,
                                     const OEChem::OEMatchBase& selection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const bool passingProteinSelect = false)
         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& mol,
                                     const OEChem::OEAtomBondSet& selection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const bool passingProteinSelect = false)

   .. oe:language:: python

      .. oe:api:: python

         OECreateBroodQuery(query: OEBroodQuery, mol: OEMol,
                            selection: OEAtomBondSet, du: OEDesignUnit,
                            proteinMask: int,
                            passingProteinSelect: bool = False) -> int
         OECreateBroodQuery(query: OEBroodQuery, mol: OEMol,
                            selection: OEMatchBase, du: OEDesignUnit,
                            proteinMask: int,
                            passingProteinSelect: bool = False) -> int

   Creates a **BROOD** query. The function  returns a status code from
   :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.

   *du*

      The :ref:`OEDesignUnit <OEBio_OEDesignUnit>` corresponding to
      the protein target.

   *proteinMask*

      Mask to be applied with the :ref:`OEDesignUnit<OEBio_OEDesignUnit>`
      to determine the protein target.
   
   *passingProteinSelect*

      To create a **BROOD** query with a protein select, this boolean needs to be true.

   
   **Query Creation with Associated Protein and Protein Select**

   .. _api_brood_query_with_protein_and_protein_select:

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& mol,
                                     const OEChem::OEMatchBase& selection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const OEBio::OEDesignUnit& protSelectDu,
                                     const unsigned proteinSelectMask)
         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& mol,
                                     const OEChem::OEAtomBondSet& selection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const OEBio::OEDesignUnit& protSelectDu,
                                     const unsigned proteinSelectMask)

   .. oe:language:: python

      .. oe:api:: python

         OECreateBroodQuery(query: OEBroodQuery, mol: OEMol,
                            selection: OEAtomBondSet, protDu: OEDesignUnit,
                            proteinMask: int, protSelectDu: OEDesignUnit,
                            proteinSelectMask: int) -> int
         OECreateBroodQuery(query: OEBroodQuery, mol: OEMol,
                            selection: OEMatchBase, protDu: OEDesignUnit,
                            proteinMask: int, protSelectDu: OEDesignUnit,
                            proteinSelectMask: int) -> int

   Creates a **BROOD** query. The function returns a status code from
   :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.

   *protSelectDu*

      The :ref:`OEDesignUnit <OEBio_OEDesignUnit>` corresponding to
      the protein select target.

   *proteinSelectMask*

      Mask to be applied with the :ref:`OEDesignUnit<OEBio_OEDesignUnit>`
      to determine the protein select target.

   **Linker Query Creation with Two Molecules (Bridging) without Protein**

   .. _api_brood_linker_query_no_protein:

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& firstMol,
                                     const OEChem::OEMCMolBase& secondMol,
                                     const OEChem::OEMatchBase& firstMolSelection,
                                     const OEChem::OEMatchBase& secondMolSelection)
         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& firstMol,
                                     const OEChem::OEMCMolBase& secondMol,
                                     const OEChem::OEAtomBondSet& firstMolSelection,
                                     const OEChem::OEAtomBondSet& secondMolSelection)

   .. oe:language:: python

      .. oe:api:: python

         OECreateBroodQuery(query: OEBroodQuery, firstMol: OEMol,
                            secondMol: OEMol, firstMolSelection: OEMatchBase,
                            secondMolSelection: OEMatchBase) -> int
         OECreateBroodQuery(query: OEBroodQuery, firstMol: OEMol,
                            secondMol: OEMol, firstMolSelection: OEAtomBondSet,
                            secondMolSelection: OEAtomBondSet) -> int

   Creates a **BROOD** query. The function returns a status code from
   :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.

   *firstMol & secondMol*

     Input molecules from which a query is to be created by bridging a fragment
     between them. Molecules need to prepared in proper relative coordinates and
     should not be clashing for optimum results.

   *firstMolSelection and secondMolSelection*

      Criteria for selecting atoms and bonds of each molecule that becomes
      part of the bridge fragment to be replaced.  The atoms and bonds must collectively
      become a single fragment for each molecule.

   **Linker Query Creation with Two Molecules (Bridging) with Protein**

   .. _api_brood_linker_query_with_protein:

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& firstMol,
                                     const OEChem::OEMCMolBase& secondMol,
                                     const OEChem::OEMatchBase& firstMolSelection,
                                     const OEChem::OEMatchBase& secondMolSelection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const bool passingProteinSelect = false)
         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& firstMol,
                                     const OEChem::OEMCMolBase& secondMol,
                                     const OEChem::OEAtomBondSet& firstMolSelection,
                                     const OEChem::OEAtomBondSet& secondMolSelection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const bool passingProteinSelect = false)

   .. oe:language:: python

      .. oe:api:: python

         OECreateBroodQuery(query: OEBroodQuery, firstMol: OEMol,
                            secondMol: OEMol, firstMolSelection: OEMatchBase,
                            secondMolSelection: OEMatchBase, du: OEDesignUnit,
                            proteinMask: int,
                            passingProteinSelect: bool = False) -> int
         OECreateBroodQuery(query: OEBroodQuery, firstMol: OEMol,
                            secondMol: OEMol, firstMolSelection: OEAtomBondSet,
                            secondMolSelection: OEAtomBondSet,
                            du: OEDesignUnit, proteinMask: int,
                            passingProteinSelect: bool = False) -> int

   Creates a **BROOD** query. The function returns a status code from
   :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.

   **Linker Query Creation with Two Molecules (Bridging) with Protein and Protein Select**

   .. _api_brood_linker_query_with_protein_and_protein_select:

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& firstMol,
                                     const OEChem::OEMCMolBase& secondMol,
                                     const OEChem::OEMatchBase& firstMolSelection,
                                     const OEChem::OEMatchBase& secondMolSelection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const OEBio::OEDesignUnit& protSelectDu,
                                     const unsigned proteinSelectMask)
         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& firstMol,
                                     const OEChem::OEMCMolBase& secondMol,
                                     const OEChem::OEAtomBondSet& firstMolSelection,
                                     const OEChem::OEAtomBondSet& secondMolSelection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const OEBio::OEDesignUnit& protSelectDu,
                                     const unsigned proteinSelectMask)

   .. oe:language:: python

      .. oe:api:: python

         OECreateBroodQuery(query: OEBroodQuery, firstMol: OEMol,
                            secondMol: OEMol, firstMolSelection: OEMatchBase,
                            secondMolSelection: OEMatchBase,
                            protDu: OEDesignUnit, proteinMask: int,
                            protSelectDu: OEDesignUnit, proteinSelectMask: int) -> int
         OECreateBroodQuery(query: OEBroodQuery, firstMol: OEMol,
                            secondMol: OEMol, firstMolSelection: OEAtomBondSet,
                            secondMolSelection: OEAtomBondSet,
                            protDu: OEDesignUnit, proteinMask: int,
                            protSelectDu: OEDesignUnit, proteinSelectMask: int) -> int

   Creates a **BROOD** query. The function returns a status code from
   :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.

   


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OECreateFlipperOptions

.. _OEBioisostere_OECreateFlipperOptions:

.. oe:function:: OECreateFlipperOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEConfGen::OEFlipperOptions* OECreateFlipperOptions()

   .. oe:language:: python

      .. oe:api:: python

         OECreateFlipperOptions() -> OEFlipperOptions

   This function creates and returns a configured :ref:`OEFlipperOptions <OEConfGen_OEFlipperOptions>` object
   for use with conformer expansion during bioisosteric database building. The returned
   object should be deleted by the caller.

   This function is typically used in conjunction with :ref:`OEDBBuilder::Expand <OEBioisostere_OEDBBuilder_Expand>`
   to configure conditional conformer generation for rotatable bonds in fragments.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OECreateFragFilter

.. _OEBioisostere_OECreateFragFilter:

.. oe:function:: OECreateFragFilter

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEMolProp::OEFilter* OECreateFragFilter()

   .. oe:language:: python

      .. oe:api:: python

         OECreateFragFilter() -> OEFilter

   This function creates and returns a configured :ref:`OEFilter <OEMolProp_OEFilter>` object
   for use in filtering fragments by molecular properties during database construction.
   The returned object should be deleted by the caller.

   This function is typically used in conjunction with :ref:`OEDBBuilder::Filter <OEBioisostere_OEDBBuilder_Filter>`
   to apply property-based constraints to fragments during bioisosteric database building.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. _OEBioisostere_OEGenerateConformers:

.. oe:function:: OEGenerateConformers

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGenerateConformers(OEChem::OEMCMolBase& mol,
                                   bool rotorOffset = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGenerateConformers(mol: OEMol, rotorOffset: bool = False) -> bool

   Generates conformers for the specified fragment molecule.
   Method returns `true` if conformer generation was successful.

   The overload with the ``rotorOffset`` enables rotor offset compression
   during conformer generation, as described in
   :ref:`SetRotorOffset<OEConfGen_OETorDriveOptions_SetRotorOffset>`.
   For fragment conformer generation, this can only be turned on when
   generating conformers specifically for use with 
   :ref:`OEDBWriter<OEBioisostere_OEDBWriter>`. Due to subtleties
   with fragment conformer generation, rotor offset compression
   may otherwise lead to undesired behavior. ``rotorOffset`` is `false`
   by default.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. _OEBioisostere_OEGetBroodStatus:

.. oe:function:: OEGetBroodStatus

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetBroodStatus(const unsigned code)

   .. oe:language:: python

      .. oe:api:: python

         OEGetBroodStatus(code: int) -> str

   Returns the description string for the status `code` corresponding to constants
   defined in :oe:constns:`OEBioisostere::OEBroodStatusCode`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. _OEBioisostere_OEGetDBIndices:

.. oe:function:: OEGetDBIndices

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::vector<unsigned> OEGetDBIndices(OEBroodQuery& query,
                                              const OEBroodGeneralOptions& opts = OEBroodGeneralOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEGetDBIndices(query: OEBroodQuery,
                        opts: OEBroodGeneralOptions = OEBroodGeneralOptions()) -> OEUIntVector

   Method returns Brood database indices corresponding to the specified
   :ref:`OEBroodQuery<OEBioisostere_OEBroodQuery>`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEIsFragment

.. _OEBioisostere_OEIsFragment:

.. oe:function:: OEIsFragment

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsFragment(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEIsFragment(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   This function determines whether the given molecule satisfies the structural criteria to be
   considered a valid fragment for bioisosteric replacement. It returns ``true`` if
   the molecule is a valid fragment and ``false`` otherwise.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEBioisostere

.. _OEBioisostere_OEReadBroodQuery:

.. oe:function:: OEReadBroodQuery

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEReadBroodQuery(OEChem::oemolistream& ifs,
                                   OEBroodQuery& query)

   .. oe:language:: python

      .. oe:api:: python

         OEReadBroodQuery(ifs: oemolistream, query: OEBroodQuery) -> int

   Reads a :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` from
   the specified stream.  Method returns a status code from
   :oe:constns:`OEBioisostere::OEBroodStatusCode`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



..  _OEBioisostere_OEWriteBroodQuery:

.. oe:namespace:: OEBioisostere

.. oe:function:: OEWriteBroodQuery

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEWriteBroodQuery(OEChem::oemolostream& ofs,
                                    const OEBroodQuery& query)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteBroodQuery(ofs: oemolostream, query: OEBroodQuery) -> int

   Writes a :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` to
   the specified stream.  Method returns a status code from
   :oe:constns:`OEBioisostere::OEBroodStatusCode`.



.. _bioisostere_part_api:

******************************
Preliminary API
******************************

.. toctree::
   :maxdepth: 2

   OEBioisostereClasses/OEBioisostereClasses
   OEBioisostereConstants/OEBioisostereConstants
   OEBioisostereFunctions/OEBioisostereFunctions


.. _chapter_bioisostereexamples:
.. _bioisostere_part_examples:

********************************************************************************
Bioisostere Examples
********************************************************************************

The following table lists the currently available **Bioisostere TK** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`database<section_examples_database>`
        - Building Brood Database (CHOMP)

      * - :ref:`query<section_examples_query>`
        - Creating Brood Query

      * - :ref:`hitlist<section_examples_hitlist>`
        - Generating Brood Hits

      * - :ref:`matches<section_examples_matches>`
        - Generating Brood Matches
      
      * - :ref:`fragment_overlay<section_examples_fragment_overlay>`
        - Overlay between Fragments

      * - :ref:`replace_fragment<section_examples_replace_fragment>`
        - Replacing a Fragment in a Molecule

      * - :ref:`cpddb<section_examples_cpddb>`
        - Building and Using an External Compound Database

      * - :ref:`cluster<section_examples_cluster>`
        - Clustering Brood Hits

      * - :ref:`2molLinker_query<section_2_molecules_Linker_query>`
        - Creating a Brood Query by Linking Two Molecules (Bridging)

      * - :ref:`combo_builder<section_examples_combo_builder>`
        - Building Combined Hits from Different Queries of the Same Molecule

      * - :ref:`score_hitlist<section_examples_score_hitlist>`
        - Curating Scored Fragment Hits with OEScoreHitlist

      * - :ref:`connection_mol_builder<section_examples_connection_mol_builder>`
        - Comparing Connection and Molecule Building Outcomes

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`brood_database<section_examples_database>`
        - Building Brood Database (CHOMP)

      * - :ref:`brood_query<section_examples_query>`
        - Creating Brood Query

      * - :ref:`brood_hitlist<section_examples_hitlist>`
        - Generating Brood Hits

      * - :ref:`brood_matches<section_examples_matches>`
        - Generating Brood Matches

      * - :ref:`fragment_overlay<section_examples_fragment_overlay>`
        - Overlay between Fragments

      * - :ref:`replace_fragment<section_examples_replace_fragment>`
        - Replacing a Fragment in a Molecule

      * - :ref:`cpddb<section_examples_cpddb>`
        - Building and Using an External Compound Database

      * - :ref:`brood_cluster<section_examples_cluster>`
        - Clustering Brood Hits

      * - :ref:`2molLinker_query<section_2_molecules_Linker_query>`
        - Creating a Brood Query for Linking Two Molecules (Bridging)

      * - :ref:`brood_combo_builder<section_examples_combo_builder>`
        - Building Combined Hits from Different Queries of the Same Molecule

      * - :ref:`brood_score_hitlist<section_examples_score_hitlist>`
        - Curating Scored Fragment Hits with OEScoreHitlist

      * - :ref:`brood_connection_mol_builder<section_examples_connection_mol_builder>`
        - Comparing Connection and Molecule Building Outcomes

.. _section_examples_database:

Building Brood Database (CHOMP)
--------------------------------------------------------------------------------

The following code example shows how to build a **Brood** database from
a library of molecules.

This example demonstrates end-to-end fragment database construction, including
fragment generation, optional filtering, and writing the final Brood database.

.. seealso::

   * :ref:`OEFragmentOptions <OEBioisostere_OEFragmentOptions>` class
   * :ref:`OEDBScreenOptions <OEBioisostere_OEDBScreenOptions>` class
   * :ref:`OEDBBuilder <OEBioisostere_OEDBBuilder>` class
   * :ref:`OEDBWriter <OEBioisostere_OEDBWriter>` class
   * :ref:`OEGenerateConformers <OEBioisostere_OEGenerateConformers>` function

.. oe:source:: brood_database.cpp
   :language: c++
   :caption:  Building Brood Database (CHOMP)
   :refnum:   1

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_database.cpp <../../../../sublibs/tklibs/bioisostere/examples/brood_database.cpp>`

.. oe:source:: brood_database.py
   :language: python
   :caption:  Building Brood Database (CHOMP)
   :refnum:   1

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_database.py <../../../../wrappers/python/examples/bioisostere/brood_database.py>`

.. _section_examples_query:

Creating Brood Query
--------------------------------------------------------------------------------

The following code example shows how to create a **Brood** query from a molecule
that could be used for bioisosteric fragment replacements using **Brood**.

.. seealso::

   * :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` class
   * :ref:`OECreateBroodQuery <OEBioisostere_OECreateBroodQuery>` function

.. oe:source:: brood_query.cpp
   :language: c++
   :caption:  Creating Brood Query
   :refnum:   2

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_query.cpp <../../../../sublibs/tklibs/bioisostere/examples/brood_query.cpp>`

.. oe:source:: brood_query.py
   :language: python
   :caption:  Creating Brood Query
   :refnum:   2

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_query.py <../../../../wrappers/python/examples/bioisostere/brood_query.py>`

.. _section_examples_hitlist:

Generating Brood Hits
--------------------------------------------------------------------------------

The following code example shows how to perform bioisosteric fragment replacements
on a **Brood** query and generate a hit list.

.. seealso::

   * :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>` class
   * :ref:`OEBroodScoreOptions <OEBioisostere_OEBroodScoreOptions>` class
   * :ref:`OEBroodHitlistOptions <OEBioisostere_OEBroodHitlistOptions>` class
   * :ref:`OEBroodOverlay <OEBioisostere_OEBroodOverlay>` class
   * :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>` class

.. oe:source:: brood_hitlist.cpp
   :language: c++
   :caption:  Generating Brood Hits
   :refnum:   3

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_hitlist.cpp <../../../../sublibs/tklibs/bioisostere/examples/brood_hitlist.cpp>`

.. oe:source:: brood_hitlist.py
   :language: python
   :caption:  Generating Brood Hits
   :refnum:   3

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_hitlist.py <../../../../wrappers/python/examples/bioisostere/brood_hitlist.py>`

.. _section_examples_matches:

Generating Brood Matches
--------------------------------------------------------------------------------

The following code example shows how to perform bioisosteric fragment replacements
on a **Brood** query and generate all possible matches. This could be a use case when
generating all possible design ideas using **BROOD** and postprocessing them with
other tools.

.. seealso::

   * :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>` class
   * :ref:`OEBroodScoreOptions <OEBioisostere_OEBroodScoreOptions>` class
   * :ref:`OEBroodOverlay <OEBioisostere_OEBroodOverlay>` class
   * :ref:`OEBroodMolBuilder <OEBioisostere_OEBroodMolBuilder>` class

.. oe:source:: brood_matching.cpp
   :language: c++
   :caption:  Generating Brood Matches
   :refnum:   4

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_matching.cpp <../../../../sublibs/tklibs/bioisostere/examples/brood_matching.cpp>`

.. oe:source:: brood_matching.py
   :language: python
   :caption:  Generating Brood Matches
   :refnum:   4

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_matching.py <../../../../wrappers/python/examples/bioisostere/brood_matching.py>`

.. _section_examples_fragment_overlay:

Overlay between Fragments
--------------------------------------------------------------------------------

The following code example shows how to overlay a fragment against a query
fragment. This could be a use case when working with synthons and trying
to find similar synthons based on 3D similarity.

.. seealso::

   * :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>` class
   * :ref:`OEBroodScoreOptions <OEBioisostere_OEBroodScoreOptions>` class
   * :ref:`OEFragOverlay <OEBioisostere_OEFragOverlay>` class

.. oe:source:: fragment_overlay.cpp
   :language: c++
   :caption:  Overlay between Fragments
   :refnum:   5

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`fragment_overlay.cpp <../../../../sublibs/tklibs/bioisostere/examples/fragment_overlay.cpp>`

.. oe:source:: fragment_overlay.py
   :language: python
   :caption:  Overlay between Fragments
   :refnum:   5

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`fragment_overlay.py <../../../../wrappers/python/examples/bioisostere/fragment_overlay.py>`

.. _section_examples_replace_fragment:

Replacing a Fragment in a Molecule
--------------------------------------------------------------------------------

The following code example shows how to replace a fragment in a molecule
defined in the form of a **BROOD** query.

.. seealso::

   * :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>` class
   * :ref:`OEBroodScoreOptions <OEBioisostere_OEBroodScoreOptions>` class
   * :ref:`OEBroodOverlay <OEBioisostere_OEBroodOverlay>` class
   * :ref:`OEBroodMolBuilder <OEBioisostere_OEBroodMolBuilder>` class

.. oe:source:: replace_fragment.cpp
   :language: c++
   :caption:  Replacing a Fragment in a Molecule
   :refnum:   6

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`replace_fragment.cpp <../../../../sublibs/tklibs/bioisostere/examples/replace_fragment.cpp>`

.. oe:source:: replace_fragment.py
   :language: python
   :caption:  Replacing a Fragment in a Molecule
   :refnum:   6

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`replace_fragment.py <../../../../wrappers/python/examples/bioisostere/replace_fragment.py>`

.. _section_examples_cpddb:

Building and Using an External Compound Database
--------------------------------------------------------------------------------

The following code example shows how to build and use an external (in-house) compound database
to find similar 2D compounds to a generated hit list. It demonstrates optional analog lookup
against a user-provided compound database to annotate Brood hits with similar known molecules.

.. seealso::

   * :ref:`OECPDDatabase <OEBioisostere_OECPDDatabase>` class
   * :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>` class
   * :ref:`OEBroodScoreOptions <OEBioisostere_OEBroodScoreOptions>` class
   * :ref:`OEBroodOverlay <OEBioisostere_OEBroodOverlay>` class
   * :ref:`OEDBBuilder <OEBioisostere_OEDBBuilder>` class
   * :ref:`OEDBWriter <OEBioisostere_OEDBWriter>` class

.. oe:source:: brood_cpddb.cpp
   :language: c++
   :caption:  Building and using an external Compound Database
   :refnum:   7

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_cpddb.cpp <../../../../sublibs/tklibs/bioisostere/examples/brood_cpddb.cpp>`

.. oe:source:: brood_cpddb.py
   :language: python
   :caption:  Building and using an external compound database
   :refnum:   7

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_cpddb.py <../../../../wrappers/python/examples/bioisostere/brood_cpddb.py>`

.. _section_2_molecules_Linker_query:

Creating Brood Query by Linking Two Molecules (Bridging)
--------------------------------------------------------------------------------

The following code example shows how to create a **Brood** query from two molecules
to find a suitable linker between the two using bioisosteric fragment replacements using **Brood**.

.. seealso::

   * :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` class
   * :ref:`OECreateBroodQuery <OEBioisostere_OECreateBroodQuery>` function

.. oe:source:: brood_2molLinker_query.cpp
   :language: c++
   :caption:  Creating Brood Query by Linking Two Molecules (Bridging)
   :refnum:   8

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_2molLinker_query.cpp <../../../../sublibs/tklibs/bioisostere/examples/brood_2molLinker_query.cpp>`

.. oe:source:: brood_2molLinker_query.py
   :language: python
   :caption:  Creating Brood Query by Linking Two Molecules (Bridging)
   :refnum:   8

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_2molLinker_query.py <../../../../wrappers/python/examples/bioisostere/brood_2molLinker_query.py>`

.. _section_examples_cluster:

Clustering Brood Hits
--------------------------------------------------------------------------------

The following code example shows how to cluster a generated **Brood** hit list
using :ref:`OEBroodClusterBuilder <OEBioisostere_OEBroodClusterBuilder>` and
:ref:`OEBroodCluster <OEBioisostere_OEBroodCluster>`. It demonstrates
post-processing of hits into similarity clusters and cluster-level prioritization.

.. seealso::

   * :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>` class
   * :ref:`OEBroodScoreOptions <OEBioisostere_OEBroodScoreOptions>` class
   * :ref:`OEBroodHitlistOptions <OEBioisostere_OEBroodHitlistOptions>` class
   * :ref:`OEBroodOverlay <OEBioisostere_OEBroodOverlay>` class
   * :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>` class
   * :ref:`OEBroodClusterBuilder <OEBioisostere_OEBroodClusterBuilder>` class
   * :ref:`OEBroodCluster <OEBioisostere_OEBroodCluster>` class

.. oe:source:: brood_cluster.cpp
   :language: c++
   :caption:  Clustering Brood Hits
   :refnum:   9

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_cluster.cpp <../../../../sublibs/tklibs/bioisostere/examples/brood_cluster.cpp>`

.. oe:source:: brood_cluster.py
   :language: python
   :caption:  Clustering Brood Hits
   :refnum:   9

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_cluster.py <../../../../wrappers/python/examples/bioisostere/brood_cluster.py>`

.. _section_examples_combo_builder:

Building Combined Hits from Different Queries of the Same Molecule with OEBroodComboBuilder
---------------------------------------------------------------------------------------------

The following code example shows how to use two **Brood** queries for the same
molecule, where the first query is used to select a limited set of primary hits
(controlled by ``-primaryQueryMaxHits``) and the second query uses
:ref:`OEBroodComboBuilder <OEBioisostere_OEBroodComboBuilder>` to generate all
possible secondary (combo) hits from those selected primary hits. The second
stage is bounded by ``-secondaryQueryMaxHits``.

This example demonstrates a two-query combo workflow using ``-in`` and ``-in2``: it
builds primary hits from the first query, expands secondary combo hits from the
second query, then clusters and ranks the resulting combo hits before writing the
final output molecules.

.. seealso::

   * :ref:`OEDBReader <OEBioisostere_OEDBReader>` class
   * :ref:`OEBroodOverlay <OEBioisostere_OEBroodOverlay>` class
   * :ref:`OEBroodMolBuilder <OEBioisostere_OEBroodMolBuilder>` class
   * :ref:`OEBroodComboBuilder <OEBioisostere_OEBroodComboBuilder>` class
   * :ref:`OEBroodClusterBuilder <OEBioisostere_OEBroodClusterBuilder>` class
   * :ref:`OEBroodCluster <OEBioisostere_OEBroodCluster>` class

.. oe:source:: brood_combo_builder.cpp
   :language: c++
   :caption:  Building Combined Hits from Different Queries of the Same Molecule with OEBroodComboBuilder
   :refnum:   10

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_combo_builder.cpp <../../../../sublibs/tklibs/bioisostere/examples/brood_combo_builder.cpp>`

.. oe:source:: brood_combo_builder.py
   :language: python
   :caption:  Building Combined Hits from Different Queries of the Same Molecule with OEBroodComboBuilder
   :refnum:   10

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_combo_builder.py <../../../../wrappers/python/examples/bioisostere/brood_combo_builder.py>`

.. _section_examples_score_hitlist:

Curating Scored Fragment Hits with OEScoreHitlist
--------------------------------------------------------------------------------

The following code example shows how to collect scored fragment matches for a
query and curate them with :ref:`OEScoreHitlist <OEBioisostere_OEScoreHitlist>`.

This example demonstrates score-level deduplication and ranking prior to full
molecule building.

.. seealso::

   * :ref:`OEDBReader <OEBioisostere_OEDBReader>` class
   * :ref:`OEBroodOverlay <OEBioisostere_OEBroodOverlay>` class
   * :ref:`OEScoreHitlist <OEBioisostere_OEScoreHitlist>` class
   * :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` class

.. oe:source:: brood_score_hitlist.cpp
   :language: c++
   :caption:  Curating Scored Fragment Hits with OEScoreHitlist
   :refnum:   11

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_score_hitlist.cpp <../../../../sublibs/tklibs/bioisostere/examples/brood_score_hitlist.cpp>`

.. oe:source:: brood_score_hitlist.py
   :language: python
   :caption:  Curating Scored Fragment Hits with OEScoreHitlist
   :refnum:   11

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_score_hitlist.py <../../../../wrappers/python/examples/bioisostere/brood_score_hitlist.py>`

.. _section_examples_connection_mol_builder:

Comparing Connection and Molecule Building Outcomes
--------------------------------------------------------------------------------

The following code example shows how to compare connection-table construction
and full molecule-building outcomes from curated scored fragments.

This example demonstrates use of :ref:`OEMolCTBuilder <OEBioisostere_OEMolCTBuilder>`,
:ref:`OEBroodMolBuilder <OEBioisostere_OEBroodMolBuilder>`, and
:ref:`OEBroodBuildResult <OEBioisostere_OEBroodBuildResult>` for build diagnostics.

.. seealso::

   * :ref:`OEScoreHitlist <OEBioisostere_OEScoreHitlist>` class
   * :ref:`OEMolCTBuilder <OEBioisostere_OEMolCTBuilder>` class
   * :ref:`OEBroodMolBuilder <OEBioisostere_OEBroodMolBuilder>` class
   * :ref:`OEBroodBuildResult <OEBioisostere_OEBroodBuildResult>` class

.. oe:source:: brood_connection_mol_builder.cpp
   :language: c++
   :caption:  Comparing Connection and Molecule Building Outcomes
   :refnum:   12

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_connection_mol_builder.cpp <../../../../sublibs/tklibs/bioisostere/examples/brood_connection_mol_builder.cpp>`

.. oe:source:: brood_connection_mol_builder.py
   :language: python
   :caption:  Comparing Connection and Molecule Building Outcomes
   :refnum:   12

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`brood_connection_mol_builder.py <../../../../wrappers/python/examples/bioisostere/brood_connection_mol_builder.py>`


.. bioisosteretk toolkit documentation master file

###########################################
Bioisostere Toolkit |bioisostere_version|
###########################################

.. attention::

   **Bioisostere TK** is currently only available in C++ and Python.

.. toctree::
   :maxdepth: 3

   theory/theory
   examples
   api
   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _bioisostere_part_releasenotes:

.. _section_bioisosteretk_releasenotes_400:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version5_0_0
   version4_2_1
   version4_2_0
   version4_1_0
   version4_0_0
 


Bioisostere TK 4.0.0
================================================================================

This is the first commercial release of **Bioisostere TK**.

New features
--------------------------------------------------------------------------------

The following classes are available as preliminary API with the first
release of this toolkit.

  * :ref:`OEBroodBuildOptions <OEBioisostere_OEBroodBuildOptions>`
  * :ref:`OEBroodDBFilter <OEBioisostere_OEBroodDBFilter>`
  * :ref:`OEBroodDBPacket <OEBioisostere_OEBroodDBPacket>`
  * :ref:`OEBroodFragPrep <OEBioisostere_OEBroodFragPrep>`
  * :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>`
  * :ref:`OEBroodHit <OEBioisostere_OEBroodHit>`
  * :ref:`OEBroodHitlistOptions <OEBioisostere_OEBroodHitlistOptions>`
  * :ref:`OEBroodOverlay <OEBioisostere_OEBroodOverlay>`
  * :ref:`OEBroodOverlayBase <OEBioisostere_OEBroodOverlayBase>`
  * :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>`
  * :ref:`OEBroodScore <OEBioisostere_OEBroodScore>`
  * :ref:`OEBroodScoreOptions <OEBioisostere_OEBroodScoreOptions>`
  * :ref:`OEDBBuffer <OEBioisostere_OEDBBuffer>`
  * :ref:`OEDBBuilder <OEBioisostere_OEDBBuilder>`
  * :ref:`OEDBReader <OEBioisostere_OEDBReader>`
  * :ref:`OEDBScreenOptions <OEBioisostere_OEDBScreenOptions>`
  * :ref:`OEDBWriter <OEBioisostere_OEDBWriter>`
  * :ref:`OEFragConfReader <OEBioisostere_OEFragConfReader>`
  * :ref:`OEFragmentOptions <OEBioisostere_OEFragmentOptions>`
  * :ref:`OEFragOverlay <OEBioisostere_OEFragOverlay>`
  * :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>`
  * :ref:`OEMolPropertyOptions <OEBioisostere_OEMolPropertyOptions>`
  * :ref:`OEIntrinsicPropOptions <OEBioisostere_OEIntrinsicPropOptions>`
  * :ref:`OEExtrinsicPropOptions <OEBioisostere_OEExtrinsicPropOptions>`
   
The following functions are available as preliminary API with the first
release of this toolkit.

  * :ref:`OEBioisostereGetArch <OEBioisostere_OEBioisostereGetArch>`
  * :ref:`OEBioisostereGetLicensee <OEBioisostere_OEBioisostereGetLicensee>`
  * :ref:`OEBioisostereGetPlatform <OEBioisostere_OEBioisostereGetPlatform>`
  * :ref:`OEBioisostereGetRelease <OEBioisostere_OEBioisostereGetRelease>`
  * :ref:`OEBioisostereGetSite <OEBioisostere_OEBioisostereGetSite>`
  * :ref:`OEBioisostereGetVersion <OEBioisostere_OEBioisostereGetVersion>`
  * :ref:`OEBioisostereIsLicensed <OEBioisostere_OEBioisostereIsLicensed>`
  * :ref:`OECreateBroodQuery <OEBioisostere_OECreateBroodQuery>`
  * :ref:`OEGenerateConformers <OEBioisostere_OEGenerateConformers>`
  * :ref:`OEGetBroodStatus <OEBioisostere_OEGetBroodStatus>`
  * :ref:`OEGetDBIndices <OEBioisostere_OEGetDBIndices>`
  * :ref:`OEReadBroodQuery <OEBioisostere_OEReadBroodQuery>`
  * :ref:`OEWriteBroodQuery <OEBioisostere_OEWriteBroodQuery>`




Bioisostere TK 4.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new algorithm, based on :ref:`OEFlexiOverlay <OEShape_OEFlexiOverlay>`, has been
  adapted in :ref:`Build <OEBioisostere_OEBroodMolBuilder_Build>`
  for optimization of generated poses for molecules obtained from fragment replacement.
  The new algorithm is more robust for optimization of poses for all geometries,
  including cyclic peptides.

Major bug fixes
--------------------------------------------------------------------------------

* Query building algorithms in :ref:`OECreateBroodQuery <OEBioisostere_OECreateBroodQuery>`
  have been improved for robustness. The improved API automatically includes any associated 
  hydrogen atoms as part of the query fragment.  Behavior has also been improved
  to provide better error behavior against invalid selections.

* The new methods :ref:`SetSingleSourceMol<OEBioisostere_OEFragmentOptions_SetSingleSourceMol>`
  and :ref:`GetSingleSourceMol<OEBioisostere_OEFragmentOptions_GetSingleSourceMol>` have
  been added to :ref:`OEFragmentOptions <OEBioisostere_OEFragmentOptions>` to provide
  flexibility regarding source molecule storage during database building.

Minor bug fixes
--------------------------------------------------------------------------------

* Some memory management issues have been fixed in :ref:`Build<OEBioisostere_OEBroodMolBuilder_Build>`
  and :ref:`Generate<OEBioisostere_OEDBBuilder_Generate>`.



Bioisostere TK 4.2.0
================================================================================

New Features
--------------------------------------------------------------------------------
* The new class :ref:`OECPDDatabase <OEBioisostere_OECPDDatabase>` has been added as a
  preliminary API, which can be used to perform 2D similarity comparisons between a **Brood**
  hit list and an external compound database.

* Eight new overloads have been added to the existing 
  :ref:`OECreateBroodQuery <OEBioisostere_OECreateBroodQuery>` function.
  The new overloads extend the API for query generation in the presence of an active site
  protein and/or a selectivity protein. Additionally, there are new overloads to create 
  a bridging query between two molecules.

* The following new methods have been added to :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>`:
  
  * :ref:`GetRemovedHits<OEBioisostere_OEHitlistBuilder_GetRemovedHits>`
  * :ref:`GetFailedCount<OEBioisostere_OEHitlistBuilder_GetFailedCount>`

  .. two methods later removed:

  * TrimHitlist
  * GetTrimmedCount

* The :ref:`Build<OEBioisostere_OEHitlistBuilder_Build>` method in the 
  :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>` has been expanded to accept
  an :ref:`OETracerBase <OESystem_OETracerBase>` as an optional argument.

* The following new methods have been added to :ref:`OEBroodHit <OEBioisostere_OEBroodHit>`:

  * :ref:`GetBuildStatus<OEBioisostere_OEBroodHit_GetBuildStatus>`
  * :ref:`GetDeltaLocalStrain<OEBioisostere_OEBroodHit_GetDeltaLocalStrain>`

Minor Bug Fixes
--------------------------------------------------------------------------------

* Some memory management issues have been fixed in :ref:`AddScores<OEBioisostere_OEHitlistBuilder_AddScores>`
  of the :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>` class.

* The :ref:`OEBroodScore <OEBioisostere_OEBroodScore>` returned from the
  :ref:`Overlay <OEBioisostere_OEBroodOverlay_Overlay>` calculation now always contains the fragment,
  irrespective of whether the overlay was a success.

* The :ref:`GetFrags<OEBioisostere_OEBroodDBPacket_GetFrags>` method
  in the :ref:`OEBroodDBPacket <OEBioisostere_OEBroodDBPacket>` now properly returns an empty
  iterator if there are no fragments in a packet.

* The :ref:`SetupRef<OEBioisostere_OEFragOverlay_SetupRef>` method in
  :ref:`OEFragOverlay<OEBioisostere_OEFragOverlay>` is now substantially faster for
  subsequently initializing it with new reference fragments.

* The :ref:`Init<OEBioisostere_OEDBReader_Init>` method in 
  :ref:`OEDBReader <OEBioisostere_OEDBReader>` is now returning an unsigned int
  (instead of bool), reflecting the :ref:`OEBioisostere OEBroodStatusCode Success <OEBioisostere_OEBroodStatusCode_Success>`
  or other error codes for database initialization.





OEBioisostere TK 4.2.1
================================================================================

New Features
--------------------------------------------------------------------------------

* A new overload has been added to the :ref:`SetSmartsFile <OEBioisostere_OEFragmentOptions_SetSmartsFile>`
  method in :ref:`OEFragmentOptions<OEBioisostere_OEFragmentOptions>`, enabling the ability
  to pass in a file name directly.

* A new overload has been added to the :ref:`OEGenerateConformers<OEBioisostere_OEGenerateConformers>`,
  enabling the option for ``rotorOffset`` compression during conformer generation.
  The existing overload no longer performs ``rotorOffset`` compression.

* A new method, :ref:`HasProteinSelect<OEBioisostere_OEBroodQuery_HasProteinSelect>`, has been
  added to the :ref:`OEBroodQuery<OEBioisostere_OEBroodQuery>` class that can be called on a query to check
  whether it has a selectivity protein.

Minor Bug Fixes
--------------------------------------------------------------------------------

* Both :ref:`OEBroodOverlay<OEBioisostere_OEBroodOverlay>` and
  :ref:`OEFragOverlay<OEBioisostere_OEFragOverlay>` now transfer any residue
  information of query fragments into the overlaid fragments within the
  :ref:`Overlay<OEBioisostere_OEBroodOverlayBase_Overlay>` method.

* The :ref:`Build<OEBioisostere_OEHitlistBuilder_Build>` method in
  :ref:`OEHitlistBuilder<OEBioisostere_OEHitlistBuilder>` now properly
  updates the :ref:`tracer<OESystem_OETracerBase>` when provided.

* The :ref:`Init<OEBioisostere_OEBroodQuery_Init>` method in
  :ref:`OEBroodQuery<OEBioisostere_OEBroodQuery>` now properly
  adds the protein structures for a selectivity check to the query when provided.




Bioisostere TK 5.0.0
================================================================================

New Features
--------------------------------------------------------------------------------

* The following new classes have been added as preliminary API:
  
  * :ref:`OEBroodBuildResult <OEBioisostere_OEBroodBuildResult>`
  * :ref:`OEBroodCluster <OEBioisostere_OEBroodCluster>`
  * :ref:`OEBroodClusterBuilder <OEBioisostere_OEBroodClusterBuilder>`
  * :ref:`OEBroodComboBuilder <OEBioisostere_OEBroodComboBuilder>`
  * :ref:`OEHitlistBuilderOptions <OEBioisostere_OEHitlistBuilderOptions>`
  * :ref:`OEHitlistBase <OEBioisostere_OEHitlistBase>`
  * :ref:`OEScoreHitlist <OEBioisostere_OEScoreHitlist>`
  * :ref:`OEBroodHitlist <OEBioisostere_OEBroodHitlist>`
  * :ref:`OEMolCTBuilder <OEBioisostere_OEMolCTBuilder>`
  * :ref:`OESimilarity <OEBioisostere_OESimilarity>`

* The following new methods have been added to :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>`:

  * :ref:`GetQueryID <OEBioisostere_OEBroodQuery_GetQueryID>`
  * :ref:`SetQueryID <OEBioisostere_OEBroodQuery_SetQueryID>`

* A new constructor overload has been added to :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>`
  that takes a :ref:`OEHitlistBuilderOptions <OEBioisostere_OEHitlistBuilderOptions>` as an argument.

* A new overload of :ref:`Setup <OEBioisostere_OEBroodDBFilter_Setup>` has been added to
  :ref:`OEBroodDBFilter <OEBioisostere_OEBroodDBFilter>` that takes a molecule as argument.

* The following new methods have been added to :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>`:

  * :ref:`GetBuildRes <OEBioisostere_OEBroodHit_GetBuildRes>`
  * :ref:`GetScores <OEBioisostere_OEBroodHit_GetScores>`

* The following new methods have been added to :ref:`OEBroodScore <OEBioisostere_OEBroodScore>`:

  * :ref:`Add <OEBioisostere_OEBroodScore_Add>`
  * :ref:`GetQueryIDs <OEBioisostere_OEBroodScore_GetQueryIDs>`

* The following new functions have been added:

  * :ref:`OECreateFlipperOptions <OEBioisostere_OECreateFlipperOptions>`
  * :ref:`OECreateFragFilter <OEBioisostere_OECreateFragFilter>`
  * :ref:`OEIsFragment <OEBioisostere_OEIsFragment>`

* The following methods have been removed from the :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>`,
  as they are no longer relevant:

  * GetTrimmedCount
  * TrimHitlist
  * An overload of GetHits that took a vector of :ref:`OEBroodHit <OEBioisostere_OEBroodHit>` as an argument.
  * GetRemovedHits

Minor Bug Fixes
--------------------------------------------------------------------------------

* The :ref:`OECreateBroodQuery <OEBioisostere_OECreateBroodQuery>` method now
  keeps any incoming color atoms associated with the query selection, when available, and
  does not add any additional color atoms to the query.  The behavior is unchanged
  when no color atoms are present with the incoming selection.

* A bug in fragment property filtering has been resolved. Now by setting the
  :ref:`SetUseProperty <OEBioisostere_OEBroodScoreOptions_SetUseProperty>` option in
  :ref:`OEBroodScoreOptions <OEBioisostere_OEBroodScoreOptions>` to true, you can activate
  the fragment filtering based on the properties defined by
  :ref:`OEExtrinsicPropOptions <OEBioisostere_OEExtrinsicPropOptions>` and
  :ref:`OEIntrinsicPropOptions <OEBioisostere_OEIntrinsicPropOptions>`.
  Previously, the filter was not being applied correctly, which could lead to unexpected
  fragments being included in the results.

* An issue has been fixed related to proper usage of 
  :ref:`SetRangeSize<OEBioisostere_OEBroodGeneralOptions_SetRangeSize>` and
  :ref:`SetRangeOffset<OEBioisostere_OEBroodGeneralOptions_SetRangeOffset>` so that
  fragment retrieval from the database during the overlay step now properly respects
  the specified range boundaries.

* A bug has been fixed where the color score reported by
  :ref:`GetColorScore <OEBioisostere_OEBroodScore_GetColorScore>` could exceed its valid
  range in ROCS mode, causing the combined score to exceed its range as well. The color
  Tanimoto is now computed consistently from the scored conformer.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!




.. _chapter_brood_theory:

Theory
======

There is a long history to fragment and bioisosteric replacement (see [Chen-2003]_).  Most
medicinal chemists are well versed in standard sets of bioisosteric fragments.
Likewise, there is a long history of computational approaches to fragment replacement
(see [Verloop-1987]_ and [Lauri-1994]_).  There have been several attempts to examine
sets of known active compounds to empirically identify bioisosteric fragments
(see [Ujváry-2003]_ and [Sheridan-2002]_).  While this is an interesting exercise, it has
two drawbacks.  First, it can only identify bioisosteric fragment pairs that
are already known.  While these provide interesting study, they are often already
familiar to experienced medicinal chemists and modelers.  Second, it identifies
many incidental rather than meaningful fragment pairs.  These result from the
fact that simply because two molecules bind to the same site does not mean they
differ only by bioisosteric replacement.  For instance, chemists may analog a
compound by substituting an N-methyl group with an N-benzyl group in order to
identify new binding pockets.  However, just because both of these compounds
are bioactive does not mean that methyl and benzyl are similar fragments (though
they would be identified as such by some methods).  While one may apply various
heuristics, such as size, to avoid this problem, we hope to explore methods
that are more robust.

An alternative approach has been to use an algorithm that would predict whether
two fragments are similar in relevant ways.  Several groups including Bartlett, Verloop, and Willett
(see [Lauri-1994]_, [Verloop-1987]_, and [Watson-2001]_) have developed methods in
this area.  Here we seek to capitalize on and extend the ideas developed by
these workers.

=================================
3D Fragment similarity searching
=================================

**BROOD** allows users to enter a single query fragment and
search a very large database of known molecular fragments in order to identify
fragments that are similar.  Each database fragment is compared to the query
fragment in 3D with regard to shape, chemistry, electrostatics, and geometric
presentation of attachment vectors.  The fragments that are most similar to
the query fragment will appear in a hitlist.

All similar fragments in a **BROOD** hitlist are organized into clusters.  The
clusters are organized so that molecules with the same ring structures and core
framework (reduced-graph) are placed in the same cluster.  The first cluster in
**BROOD** hitlists is always the molecules that are similar to the query, sharing
the same core atomic framework.  While some of these analogs may be obvious,
they often include alternative interesting chemistries.  The remaining clusters
are each organized around a unique core atomic framework.  Each cluster is
represented by its best scoring member and the clusters themselves are ranked
by the score of their best member.

.. _clash_detection_selectivity:

=================================
Clash detection and selectivity
=================================

**BROOD** allows users to specify protein structures for the purpose of testing
whether newly constructed analogs fit into the active site.  When the **BROOD**
query ligand is based upon a crystallographic co-crystal structure, **BROOD**
builds the newly created analog molecules in the same shape and orientation as
the query.  If the crystallographic ligand was originally in an active site and
the protein is passed to **BROOD** as the bump protein, the new analogs will be
built in poses that are also in the bump protein's active site.  When a bump
protein is passed, **BROOD** checks for clashes between the bump protein and each
analog.  By default, if any ligand heavy atom is less than 2.25 Angstroms from
a protein heavy atom, the analog is removed from the hitlist.

Users can also specify another protein for selectivity testing (referred to
here as the selectivity protein).  In order for an analog to remain in the
final hitlist, it must clash with the selectivity protein.  The bump protein
and the selectivity protein should be aligned and the **BROOD** query should be
based on a molecule that fits within the bump protein active site.  In this
case, analogs in the final **BROOD** hitlist will also fit into the bump protein's
active site, while they will also have clashes with the selectivity protein.
This combination is a simple model for analogs that have a chance to be active
against the bump protein, but have a very low chance of being active against
the selectivity protein.  This model assumes the analog molecules bind to the
bump protein in a manner that is similar to the original ligand and that the
most favorable pose for the ligand class in the selectivity protein is similar
to that in the bump protein.

======================================
Strain energy
======================================

**BROOD**'s output includes newly constructed analog molecules that are intended
to have a similar 3D shape to the query molecule.  These new analogs are
constructed partially from the original molecule and partially from new
fragments.  When these new molecules are generated and built into a
conformation that has good shape and chemistry overlap with the query
molecules, some strain may be introduced.  To produce high-quality results, it
is essential that the analogs are optimized while maintaining the query shape
and that little strain is introduced in the process.

The **BROOD** search process guarantees that each of the molecular fragments alone
is in a low energy state.  After the fragments are joined, this may no longer be
true.  For every **BROOD** analog in the final hitlist, two optimizations are
carried out to determine the local strain introduced by maintaining a shape
similar to the original query.  In the first optimization, the ligand is
allowed to relax into a local minimum.  In the second optimization, the ligand
atoms are only allowed to move a fraction of an Angstrom, keeping the same
overall shape of the molecule.  In both calculations, the OEMMFF
[Halgren-I-1996]_, [Halgren-II-1996]_, [Halgren-III-1996]_, [Halgren-IV-1996]_,
[Halgren-V-1996]_, [Halgren-VI-1999]_, [Halgren-VII-1999]_ potential is used with
a Sheffield solvation function [Grant-2007]_.  The local strain energy is the
difference in ligand energy between the two calculations.  By default, the
maximum strain for any successful **BROOD** analog is limited to 6.5 kCal/M.

======================================
Fragment joining
======================================

One approach to lead identification and development is based on the
identification and expansion of physically very small molecule inhibitors that
are commonly termed "fragments" (see [Hajduk-2007]_).  Fragments in this sense
are molecules with few atoms and should not be confused with the term fragment
used elsewhere in this document that refers to part of a molecule.
Nevertheless, the fragment replacement algorithm in **BROOD** can be useful in the
modeling of fragment-based design.  In fragment-based design, one strategy is
to combine two non-overlapping inhibitory fragments to form a single molecule.
While this is sometimes empirically done with a series of flexible linear
linkers, the linkers can also be modeled.

======================================
Cyclization
======================================

One of the first applications of **BROOD** many users want to explore is the
replacement of a flexible portion of a molecule with a more rigid fragment that
fills the same space.  **BROOD** excels at this application.  This type of exercise
can be considered a local cyclization.  In some molecules, rather than a local
cyclization, some chemists prefer to design a bridge between two portions of a
molecule that do not have a local link.  This is another task where **BROOD** can
be quite useful.  Long-distance cyclization, like fragment joining, is about
finding a chemical fragment that can bridge to moieties given a particular 3D
orientation.

======================================
Molecular complexity
======================================

In the early 1980's, Bertz first published a measure of the complexity of
molecules and asserted that his calculated complexity could be related to synthetic
ease ([Bertz-1981]_, [Bertz-1982]_).  Bertz built complexity terms that are
similar to a Shannon entropy ([Shannon-1949]_) but with regard to the elements
in a molecule and the diversity of small fragments that make up the structure
of the molecule.  While the actual synthetic accessibility can be heavily
influenced by the availability of complex synthetic building blocks and
advances in stereo synthetic methods, molecular complexity remains a useful
tool for prioritizing which compounds chemists should look at first when
primary modeling methods don't readily distinguish between them.

In 2007, Boda and coworkers extended Bertz's idea and compared it to
experimental chemists' predictions of synthetic accessibility ([Boda-2007]_).

Boda made the significant advance of adding stereo complexity to Bertz's
elemental, graph, and ring complexity.  We noted in the paper that nearly all the
signal was generated by the molecular complexity and stereo complexity.  In
fact, each of these measures, without the linear fitting presented in the
paper, correlated with chemists' predictions of synthetic accessibility as well
as the chemists' predictions correlated with one another.  Thus, in **BROOD**, we
have implemented a molecular complexity that is a normalized sum of the graph
and size complexity, elemental complexity, and stereo complexity.  The
normalized complexity score starts at zero for the simplest, smallest molecule
and grows to values that generally don't exceed 1.0 for medicinally relevant
small molecules.

**BROOD** uses molecular complexity to sort analog molecules in the final hitlist
that have very similar shape and color scores.

==============================================
Aromatic fragment comparison
==============================================

This is an example of applying **BROOD** as a technology to explore fragment
similarity outside the direct context of a specific drug-discovery project. Tu
and coworkers at Pfizer explored the chemical space of aromatic ring systems
([Tu-2012]_).  In their work, they used **BROOD** at the core of the NEAT (Novel
and Electronically Equivalent Aromatic Templates) tool.  This tool uses a
combination of high-level QM-derived partial charges along with **BROOD**'s
electrostatic similarity calculation to explore potentially aromatic system
replacements.  It allows medicinal chemists to explore the large space of
complex aromatic ring systems for replacements that are both electronically and
sterically analogous.  We present this example as an illustration of the more
diverse applications of **BROOD**'s fragment-matching technology.

==============================================
Shape-based belief model
==============================================

It is a well-known concept in medicinal chemistry that compounds with greater
similarity have a higher probability of having shared properties.  It is by
this premise that project teams seek to explore chemical space around a lead
compound in order to discover new active molecules.  Based on this concept,
Muchmore and colleagues at Abbott attempted to quantify the relationship
between various measures of ligand similarity and binding activity
([Muchmore-2008]_).  A large number of ligands with activities measured across
a large number and wide variety of targets were used to generate the
probability that two molecules with a given similarity would have activity
within one log unit of one another (the p[active]).  Several well-regarded
ligand similarity techniques showed sigmoidal curves where, at very low
similarity, the probability of shared activity was related to the prevalence of
inhibitors in the underlying data; whereas, as two molecules approached very
high similarity, the probability of similar activity approached something like
35-55%.  While perhaps surprising at first, both of these results are sensible.
It is well known that while similar molecules are much more likely to have
shared activity than two random molecules, similarity is by no means a
guarantee of shared activity.

As reported in their paper, one of the similarity techniques with the highest
maximum probability was the combo score (shape + color score) from the OpenEye
tool ROCS.  The critical change from color score to color Tanimoto occurred in
ROCS since the publication of Muchmore's paper.  The change to color Tanimoto
resulted in an even higher maximum probability of 0.512 ([Brown-Muchmore-2008]_) for
shape + color Tanimoto.  The curve that was refit using the Abbott data is used
in **BROOD** to convert the overall shape + color Tanimoto similarity of the analog
molecule to the query molecule to generate a p(Active) value that indicates the
probability, according the Abbott's belief model, that the analog compound will
have activity within one log unit of the query compound.

==============================================
Abbott bioavailability score
==============================================

In 2005, Martin published a predictive model for the probability that a
compound will have bioavailability (f) > 10% in rats ([Martin-2005]_).
Despite attempts to identify a useful model using straightforward linear
combinations of simple parameters, such as logP, logD, donors, acceptors, PSA,
or flexibility, Martin noted that different predictive models were required for
different ionization states.  Anions require a bioavailability model that
depends strongly on PSA.  By contrast, neutral species, cations, and zwitterions
require a model based on the rule-of-five.  The combination of these models
provides a single model for bioavailability in rats.

.. _brood_compound_similarity:

==============================================
Similarity to available compounds
==============================================

Sometimes it may be desirable to check whether compounds similar to the analogs 
generated by **BROOD** already exist in commercial or internal databases, allowing a 
chemist to consider molecules available for purchase before undertaking the synthesis 
of a given analog. 

**BROOD** uses similarity searching between compounds, based on two-dimensional circular 
fingerprints, to access compound similarity. The cricular fingerprints encode the presence 
of molecular substructures based on atom neighborhoods. This similarity is 
quantified using the Tanimoto coefficient, which measures the ratio of the intersection to 
the union of the fingerprint bit vectors. A Tanimoto similarity threshold of 0.15 is used as the cutoff 
to determine whether two compounds are considered structurally similar.

==============================================
BROOD Database Generation (CHOMP)
==============================================
**BROOD**'s database generation program, **CHOMP**, fragments molecules by
identifying critical bonds that can be broken.  **CHOMP** includes three 
sets of bond-breaking patterns: :ref:`RLF (ring, linkers & functional groups)<chompRLF>`, RECAP
rules [Lewell-1998]_, and ALL (indicating breaking all non-ring, non-resonance
single bonds).  By default, **CHOMP** breaks all bonds identified using any of these
methods.  Users can also specify a SMARTS file of their own bond identifiers.
This file should include a series of SMARTS patterns (one per line) that each
define two atoms on opposite ends of the bond to be broken.  For example, a line
with the SMARTS "*-*" will cause all single bonds to be broken, while a line
with the SMARTS "[R]-[!R]" will cause all bonds between ring atoms and non-ring
atoms to be broken and "[#6]-!@[!#6!#1]" will cause CHOMP to break every single
non-ring bond between a carbon atom and a heteroatom.

.. _chompRLF:

The RLF chemical heuristics seek to break compounds into three types of
primary fragments; contiguous ring systems, functional groups, and linkers.
Contiguous ring systems include any set of atoms that are bonded together by
at least one ring bond.  Thus, fused rings and spiro rings are included as a
single ring system, but biphenyl is broken into two ring systems.  Functional
groups are defined as any collection of bonded atoms including one or more
heteroatoms or unsaturated carbons separated by at most a single
fully saturated carbon atom.  The linkers are the remaining saturated carbon
skeletons.  It should be noted that linkers, like functional groups and
ring systems, can be terminal (i.e., degree 1).

**CHOMP** systematically identifies all the molecular fragments that can be
generated by breaking one or more of the specified bonds.  **CHOMP** first
eliminates fragments that have more than 15 heavy atoms or that have more than
three attachment points.  **CHOMP** also filters the fragments based on commonly
used molecular filters, eliminating unstable, reactive, or toxic functional
groups.  As a final fragment generation step, for every fragment with two
attachment points, **CHOMP** generates two single attachment fragments; for
every fragment with three attachment points, **CHOMP** generates six fragments
with two attachment points and three fragments with single attachment points by
capping the open attachment valence with hydrogens.  **CHOMP** then eliminates any
duplicate fragments.

This first portion of the **CHOMP** algorithm involves only graph processing and
can proceed very quickly.  Please note, however, that when processing molecular
databases of more than a few million compounds, **CHOMP** will use significant
amounts of memory.  Memory usage is especially aggressive early in the
execution, when many new fragments are being identified, and slows somewhat as
the algorithm progresses.

The next stage of the **CHOMP** algorithm is to generate 3D conformers using a
specialized version of the **OMEGA** algorithm.
**CHOMP**'s version of **OMEGA** has a modified TORLIB in order to
sample more generously around the attachment points.  It also differs from
default **OMEGA** parameters in having tighter constraints for removal of RMSD
duplicates (as the measure is very sensitive to size) and for having scaled
MAXCONFS and EWINDOW parameters based on the size of the fragments.  Finally,
**CHOMP** writes the fragments into a **BROOD** database.  To accomplish this,
**CHOMP** carries out several precalculations, including generating
physical properties and adding color atoms.  CHOMP also segregates the fragment
conformers into groups that are likely to match the same types of queries.  All
these processes help **BROOD** search the databases more quickly.

==============================================
BROOD Database
==============================================

**BROOD** databases are currently in the format of a directory or folder that
contains many files.  The databases can be easily compressed and uncompressed 
with standard compression algorithms. They can also be moved, but not easily renamed.  
To rename the **BROOD** database, you must also rename all the files contained 
within it.  Consistency is required to prevent confusion between the name of the 
database and the files being searched under that name.

Of the files in the database directory,
only one is human-readable.  This is the :file:`.info` file.  If you open the
:file:`.info` file with a text reader, you will see some information about the
database, its version, and a manifest of the files that are supposed to be in
the database.  Whenever a database is read, the manifest is checked to ensure the 
database has not been corrupted.






********************************
Theory
********************************

.. toctree::
   :maxdepth: 3

   brood_theory
   


********************************************************************************
Python Cookbook Examples
********************************************************************************

There are large number of code examples available in
`OpenEye Python Cookbook <http://docs.eyesopen.com/python_modules/cookbook/index.html>`_
that use **OpenEye Toolkits** to solve a wide range of cheminformatics and molecular
modeling problems.

* `2D Depiction <http://docs.eyesopen.com/python_modules/cookbook/depiction/depiction.html>`_ chapter
  contains examples that illustrate how the **OEDepict TK** and **Grapheme TK** can be
  utilized to depict molecules and visualize properties calculated with other OpenEye toolkits.

* `Visualizing 3D Information <http://docs.eyesopen.com/python_modules/cookbook/visualization/visualization.html>`_
  chapter contains examples that illustrate how the **Grapheme TK** can be utilized to project
  complex 3D information into the 2D molecular graph.

* `Cheminformatics <https://docs.eyesopen.com/python_modules/cookbook/cheminfo/cheminfo.html>`_
  chapter contains examples that solve various cheminformatics problems such as similarity search,
  ring perception and manipulating molecular graphs.

* `Peptide Informatics <https://docs.eyesopen.com/python_modules/cookbook/peptideinfo/peptideinfo.html>`_
  chapter contains examples that solve various peptide informatics problems such as generating custom monomer sets,
  parsing and generating :term:`HELM` representations, and visualizing peptides.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEChargeFunc, ChargeFunc

.. _OEEon_OEChargeFunc:

.. oe:class:: OEChargeFunc

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEChargeFunc : public OEShape::OEColorFunc

The :ref:`OEChargeFunc <OEEon_OEChargeFunc>` abstract class defines the following public methods:
    * :oe:meth:`SetupRef<OEEon::OEChargeFunc::SetupRef>`
    * :oe:meth:`Setup<OEEon::OEChargeFunc::Setup>`
    * :oe:meth:`Overlap<OEEon::OEChargeFunc::Overlap>`
    * :oe:meth:`operator()<OEEon::OEChargeFunc::operator()>`

The link to the parent method shows public methods that are inherited from :ref:`OEShape::OEColorFunc <OEShape_OEColorFunc>`.

The following classes are derived from this class:   
    * :ref:`OEExactChargeFunc <OEEon_OEExactChargeFunc>`
    * :ref:`OEGridChargeFunc <OEEon_OEGridChargeFunc>`

   .. _OEEon_OEChargeFunc_SetupRef:

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEChargeFunc & operator=(const OEChargeFunc & argFunc)

      Assignment operator.

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEChem::OEMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(refMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This method defines the interface for setting up the reference system for the
      :ref:`OEChargeFunc <OEEon_OEChargeFunc>` derived instance with a molecule.
      The molecule must have 3D coordinates and partial charges assigned.

   .. _OEEon_OEChargeFunc_Setup:

   .. oe:method:: Setup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Setup(const OEChem::OEMolBase& fitMol)

      .. oe:language:: python

         .. oe:api:: python

            Setup(fitMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets up a database molecule for further electrostatic overlap calculations
      with its conformations. The molecule must have 3D coordinates and partial
      charges assigned.
  

   .. _OEEon_OEChargeFunc_Overlap:

   .. oe:method:: Overlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Overlap(const double* coords, OEEonOverlapScore& results)
            bool Overlap(const OEChem::OEMolBase& fitMol,
                         OEEonOverlapScore& results)

      .. oe:language:: python

         .. oe:api:: python

            Overlap(coords: OEDoubleArray, results: OEEonOverlapScore) -> bool
            Overlap(fitMol: Union[OEGraphMol,OEMol,OEQMol],
                    results: OEEonOverlapScore) -> bool

      These methods calculate the charge density overlap between the reference and
      the fit molecules. The reference molecule must be set using the
      :oe:meth:`SetupRef<OEEon::OEChargeFunc::SetupRef>` method. The
      first overload assumes that the fit molecule has been set using the
      :oe:meth:`Setup<OEEon::OEChargeFunc::Setup>` method and uses
      the specified coordinates for the fit molecule. The second overlap
      takes the specified fit molecule and its current coordinates.

   .. _OEEon_OEChargeFunc_operator:

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator()(const double*, double*)

      .. oe:language:: python

         .. oe:api:: python

            __call__(coords: OEDoubleArray, grads: OEDoubleArray = None) -> float

      This public method implements the function value and gradient of overlap as a function of database conformer/start coordinates.
      It is assumed that the reference has been already set via the :oe:meth:`SetupRef<OEEon::OEChargeFunc::SetupRef>` method. The database
      molecule has been set with :oe:meth:`Setup<OEEon::OEChargeFunc::Setup>`.


.. _OEEonClasses:

**************************
Preliminary OEEon Classes
**************************

.. oe:namespace:: OEEon

.. toctree::
   
   OEEonHitlistOptions
   OEEonPBOptions
   OEEonOverlapScore
   OEEonOverlayScore
   OEEonOverlayResults
   OEEonPBResults
   OEEonHit
   OEChargeFunc
   OEExactChargeFunc
   OEGridChargeFunc
   OEEonPBFunc
   OEEonOverlapFunc
   OEEonOverlay
   OEEonPBOverlay
   OEEonHitlistBuilder
   OEHighestShapeTanimoto
   OEHighestChargeTanimoto
   OEHighestShapeChargeTanimotoCombo

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonHit, EonHit

.. _OEEon_OEEonHit:

.. oe:class:: OEEonHit

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonHit : public OEEon::OEEonOverlapScore

   This class stores results of electrostatic overlay and the hit conformer. It can be used with :ref:`OEEon::OEEonHitlistBuilder <OEEon_OEEonHitlistBuilder>` to build a hitlist of results.

The :ref:`OEEonHit <OEEon_OEEonHit>` class defines the following public methods:
    * :oe:meth:`GetMol<OEEon::OEEonHit::GetMol>`
    * :oe:meth:`GetConformerIndex<OEEon::OEEonHit::GetConformerIndex>`
    * :oe:meth:`ToRecord<OEEon::OEEonHit::ToRecord>`
    * :oe:meth:`Load<OEEon::OEEonHit::Load>`

The link to the parent method shows public methods that are inherited from :ref:`OEEon::OEEonOverlapScore <OEEon_OEEonOverlapScore>`.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonHit(const OEEon::OEEonOverlayScore& score,
                     const OEChem::OEMCMolBase& mol)
            OEEonHit(const OEEon::OEEonOverlapScore& score,
                     const OEChem::OEMolBase& mol)
            OEEonHit()
            OEEonHit(const OEEon::OEEonHit&)

      .. oe:language:: python

         .. oe:api:: python

            OEEonHit(score: OEEonOverlayScore, mol: OEMol) -> OEEonHit
            OEEonHit() -> OEEonHit
            OEEonHit(arg2: OEEonHit) -> OEEonHit
            OEEonHit(score: OEEonOverlapScore,
                     mol: Union[OEGraphMol,OEMol,OEQMol]) -> OEEonHit

      Constructors.

   .. oe:method:: Destructor

      .. oe:api::

         ~OEEonHit()

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEEonHit& operator=(const OEEonHit&)

      Assignment operator.

The link to the parent method shows public methods that are inherited from :ref:`OEEon::OEEonOverlapScore <OEEon_OEEonOverlapScore>`.

   .. _OEEon_OEEonHit_GetMol:

   .. oe:method:: GetMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEGraphMol& GetMol() const

      .. oe:language:: python

         .. oe:api:: python

            GetMol() -> OEGraphMol

      This method returns the hit molecule object.

   .. _OEEon_OEEonHit_GetConformerIndex:

   .. oe:method:: GetConformerIndex

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetConformerIndex() const

      .. oe:language:: python

         .. oe:api:: python

            GetConformerIndex() -> int

      This method returns the integer index of the best conformer from shape and electrostatics overlay computation.
  

   .. _OEEon_OEEonHit_ToRecord:

   .. oe:method:: ToRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ToRecord(OEDataFlow::OERecord&) const

      .. oe:language:: python

         .. oe:api:: python

            ToRecord(arg2: OERecord) -> bool

      This method converts the **Eon** hit object into a record.

   .. oe:method:: Load

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Load(const OEDataFlow::OERecord&)

      .. oe:language:: python

         .. oe:api:: python

            Load(arg2: OERecord) -> bool

      This method converts a record created via :ref:`ToRecord<OEEon_OEEonHit_ToRecord>`
      method into internal variables of the :ref:`OEEon::OEEonHit <OEEon_OEEonHit>` class.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonHitlistBuilder, EonHitlistBuilder

.. _OEEon_OEEonHitlistBuilder:

.. oe:class:: OEEonHitlistBuilder

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonHitlistBuilder

   This class aggregates shape and electrostatic overlay scores into a ranked hit
   list. Use :oe:meth:`AddScore<OEEon::OEEonHitlistBuilder::AddScore>` or
   :oe:meth:`AddScores<OEEon::OEEonHitlistBuilder::AddScores>` to populate scores,
   then call :oe:meth:`Build<OEEon::OEEonHitlistBuilder::Build>` and retrieve the
   ranked results with :oe:meth:`GetHits<OEEon::OEEonHitlistBuilder::GetHits>`.

   The :ref:`OEEonHitlistBuilder <OEEon_OEEonHitlistBuilder>`  class defines the following public methods:
       * :oe:meth:`GetAddCount<OEEon::OEEonHitlistBuilder::GetAddCount>`
       * :oe:meth:`GetHitCount<OEEon::OEEonHitlistBuilder::GetHitCount>`
       * :oe:meth:`GetHits<OEEon::OEEonHitlistBuilder::GetHits>`
       * :oe:meth:`AddScore<OEEon::OEEonHitlistBuilder::AddScore>`
       * :oe:meth:`AddScores<OEEon::OEEonHitlistBuilder::AddScores>`
       * :oe:meth:`Build<OEEon::OEEonHitlistBuilder::Build>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonHitlistBuilder(const OEEonHitlistOptions& hitlistOptions = OEEonHitlistOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEEonHitlistBuilder(hitlistOptions: OEEonHitlistOptions = OEEonHitlistOptions()) -> OEEonHitlistBuilder

      Constructor. This class is not copyable.

   .. oe:method:: Destructor

      .. oe:api::

         ~OEEonHitlistBuilder()

.. _OEEon_OEEonHitlistBuilder_GetAddCount:

   .. oe:method:: GetAddCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAddCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddCount() -> int

      This method returns number of added entries to the hit list.

.. _OEEon_OEEonHitlistBuilder_GetHitCount:

   .. oe:method:: GetHitCount

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetHitCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetHitCount() -> int

      This method returns the number of hits stored currently in the hit list object.

.. _OEEon_OEEonHitlistBuilder_GetHits:

   .. oe:method:: GetHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<OEEonHit> GetHits() const
            bool GetHits(std::vector<OEEonHit>& vecHits) const

      .. oe:language:: python

         .. oe:api:: python

            GetHits() -> OEEonHitVector
            GetHits(vecHits: OEEonHitVector) -> bool

      This method returns the sorted hits.

.. _OEEon_OEEonHitlistBuilder_AddScores:

   .. oe:method:: AddScores
      
      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddScores(const std::vector<OEEon::OEEonHit>& hits)

      .. oe:language:: python

         .. oe:api:: python

            AddScores(hits: OEEonHitVector) -> bool

      This method adds a vector of hits to the hit list object.

.. _OEEon_OEEonHitlistBuilder_AddScore:

   .. oe:method:: AddScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddScore(const OEEonOverlayScore& score,
                          const OEChem::OEMCMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            AddScore(score: OEEonOverlayScore, mol: OEMol) -> bool

      This method adds an **Eon** hit to the hit list object.

.. _OEEon_OEEonHitlistBuilder_Build:

   .. oe:method:: Build

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Build()

      .. oe:language:: python

         .. oe:api:: python

            Build() -> bool

      This method builds internal variables to build a hit list once all scores have been added.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonHitlistOptions, EonHitlistOptions

.. _OEEon_OEEonHitlistOptions:

.. oe:class:: OEEonHitlistOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonHitlistOptions : public OESystem::OEOptions

   This class sets up options required for generating
   a hit list in :ref:`OEEonHitlistBuilder <OEEon_OEEonHitlistBuilder>`
   from a set of **Eon** hits :ref:`OEEonHit <OEEon_OEEonHit>`.

The :ref:`OEEonHitlistOptions <OEEon_OEEonHitlistOptions>` class defines the following public methods:
    * :oe:meth:`GetMaxHits<OEEon::OEEonHitlistOptions::GetMaxHits>`
    * :oe:meth:`SetMaxHits<OEEon::OEEonHitlistOptions::SetMaxHits>`
    * :oe:meth:`GetBestHits<OEEon::OEEonHitlistOptions::GetBestHits>`
    * :oe:meth:`SetBestHits<OEEon::OEEonHitlistOptions::SetBestHits>`
    * :oe:meth:`GetCutoff<OEEon::OEEonHitlistOptions::GetCutoff>`
    * :oe:meth:`SetCutoff<OEEon::OEEonHitlistOptions::SetCutoff>`
    * :oe:meth:`CreateCopy<OEEon::OEEonHitlistOptions::CreateCopy>`

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonHitlistOptions()
            OEEonHitlistOptions(const OEEonHitlistOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEEonHitlistOptions() -> OEEonHitlistOptions
            OEEonHitlistOptions(arg2: OEEonHitlistOptions) -> OEEonHitlistOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEEonHitlistOptions &operator=(const OEEonHitlistOptions &)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonHitlistOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEEonHitlistOptions

      Creates and returns a deep copy of this object.

   .. oe:method:: GetMaxHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHits() -> int

      Returns parameter for the maximum number of hits to be generated. See :oe:meth:`SetMaxHits<OEEon::OEEonHitlistOptions::SetMaxHits>` method.

   .. oe:method:: SetMaxHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxHits(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHits(value: int) -> bool

      Sets the maximum number of molecules to go over. When zero, all inputs to the hit list will be considered in the hit list.
      **Default: 0.**

   .. oe:method:: GetBestHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetBestHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetBestHits() -> int

      Returns parameter for the number of best hits to keep. See :oe:meth:`SetBestHits<OEEon::OEEonHitlistOptions::SetBestHits>` method.

   .. oe:method:: SetBestHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBestHits(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetBestHits(value: int) -> bool

      Sets the number of maximum hits to keep at the output of the hit list.
      **Default: 1000.**

   .. oe:method:: GetCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetCutoff() -> float

      Returns the score cutoff parameter. See :oe:meth:`SetCutoff<OEEon::OEEonHitlistOptions::SetCutoff>` method.

   .. oe:method:: SetCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetCutoff(value: float) -> bool

      Sets the cutoff parameter. When the combo score is below this value, the hits are ignored.
      **Default: -1.0**

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonOverlapFunc, EonOverlapFunc

.. _OEEon_OEEonOverlapFunc:

.. oe:class:: OEEonOverlapFunc

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonOverlapFunc : public OEShape::OEOverlapFunc

The :ref:`OEEonOverlapFunc <OEEon_OEEonOverlapFunc>` class inherits public methods from :ref:`OEShape::OEOverlapFunc <OEShape_OEOverlapFunc>`. The implementation has been adjusted to return shape and charge density similarity when operator calls are made.

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonOverlapFunc(const OEShape::OEShapeFunc& shape = OEShape::OEGridShapeFunc(),
                             const OEChargeFunc& charge = OEEon::OEGridChargeFunc())

      .. oe:language:: python

         .. oe:api:: python

            OEEonOverlapFunc(shape: OEShapeFunc = OEGridShapeFunc(),
                             charge: OEChargeFunc = OEGridChargeFunc()) -> OEEonOverlapFunc
            OEEonOverlapFunc(arg2: OEEonOverlapFunc) -> OEEonOverlapFunc

      Constructor. This class is not copyable.

      *shape*
         Shape function to use. Default: :oe:cls:`OEShape::OEGridShapeFunc`.

      *charge*
         Charge function to use. Default: :oe:cls:`OEEon::OEGridChargeFunc`.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEEonOverlapFunc & operator=(const OEEonOverlapFunc &)

      Assignment operator.

   .. oe:method:: Setup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Setup(const OEChem::OEMolBase& fitMol)

      .. oe:language:: python

         .. oe:api:: python

            Setup(fitMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets up the fit molecule for electrostatic overlap calculations.
      The molecule must have 3D coordinates and partial charges assigned.

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEChem::OEMolBase& refMol)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(refMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets up the reference molecule for electrostatic overlap calculations.
      The molecule must have 3D coordinates and partial charges assigned.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator()(const double* coords, double* grads = NULL)

      .. oe:language:: python

         .. oe:api:: python

            __call__(coords: OEDoubleArray, grads: OEDoubleArray = None) -> float

      Evaluates the combined shape and charge density overlap function at the
      given coordinates. If *grads* is non-null, the gradient is also computed.
      The reference and fit molecules must have been set via
      :oe:meth:`SetupRef<OEEon::OEEonOverlapFunc::SetupRef>` and
      :oe:meth:`Setup<OEEon::OEEonOverlapFunc::Setup>` respectively.

   .. oe:method:: Overlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Overlap(const OEChem::OEMolBase& fitMol,
                         OEEonOverlapScore& results)
            bool Overlap(const double* coords, OEEonOverlapScore& results)

      .. oe:language:: python

         .. oe:api:: python

            Overlap(fitMol: Union[OEGraphMol,OEMol,OEQMol],
                    results: OEEonOverlapScore) -> bool
            Overlap(coords: OEDoubleArray, results: OEEonOverlapScore) -> bool

      Calculates the combined shape and charge density overlap. The first
      overload takes a fit molecule directly. The second overload uses
      coordinates of a molecule previously set with
      :oe:meth:`Setup<OEEon::OEEonOverlapFunc::Setup>`.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonOverlapFunc* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEEonOverlapFunc

      Creates and returns a deep copy of this object.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonOverlapScore, EonOverlapScore

.. _OEEon_OEEonOverlapScore:

.. oe:class:: OEEonOverlapScore

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonOverlapScore : public OEShape::OEOverlapResults

   This class stores shape and electrostatics overlap results.

The :ref:`OEEonOverlapScore <OEEon_OEEonOverlapScore>` class defines the following public methods:
    * :ref:`GetTanimoto<OEEon_OEEonOverlapScore_GetTanimoto>`
    * :ref:`GetETTanimoto<OEEon_OEEonOverlapScore_GetETTanimoto>`
    * :ref:`GetTanimotoCombo<OEEon_OEEonOverlapScore_GetTanimotoCombo>`
    * :ref:`GetETOverlap<OEEon_OEEonOverlapScore_GetETOverlap>`
    * :ref:`GetRefSelfET<OEEon_OEEonOverlapScore_GetRefSelfET>`
    * :ref:`GetFitSelfET<OEEon_OEEonOverlapScore_GetFitSelfET>`

The following methods are publicly inherited from :ref:`OEOverlapResults <OEShape_OEOverlapResults>`.

   .. oe:method:: Constructors

      Default, constructor from parent class object, and copy constructors.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonOverlapScore()
            OEEonOverlapScore(const OEShape::OEOverlapResults &)
            OEEonOverlapScore(const OEEonOverlapScore &)

      .. oe:language:: python

         .. oe:api:: python

            OEEonOverlapScore() -> OEEonOverlapScore
            OEEonOverlapScore(arg2: OEOverlapResults) -> OEEonOverlapScore
            OEEonOverlapScore(arg2: OEEonOverlapScore) -> OEEonOverlapScore

   .. oe:method:: Destructor
      
      .. oe:api::

         ~OEEonOverlapScore()

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEEonOverlapScore& operator=(const OEEonOverlapScore&)

      Assignment operator.

   .. _OEEon_OEEonOverlapScore_GetTanimoto:

   .. oe:method:: GetTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimoto() -> float

      This method returns the shape Tanimoto.

   .. _OEEon_OEEonOverlapScore_GetETTanimoto:

   .. oe:method:: GetETTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetETTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetETTanimoto() -> float

      This method returns the electrostatic Tanimoto.

   .. _OEEon_OEEonOverlapScore_GetTanimotoCombo:

   .. oe:method:: GetTanimotoCombo

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTanimotoCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimotoCombo() -> float

      This method returns shape and electrostatics Tanimoto Combo.

   .. _OEEon_OEEonOverlapScore_GetETOverlap:

   .. oe:method:: GetETOverlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetETOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetETOverlap() -> float

      This method returns the electrostatic overlap.

   .. _OEEon_OEEonOverlapScore_GetRefSelfET:

   .. oe:method:: GetRefSelfET

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetRefSelfET() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefSelfET() -> float

      This method returns the electrostatic reference self overlap.

   .. _OEEon_OEEonOverlapScore_GetFitSelfET:

   .. oe:method:: GetFitSelfET

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetFitSelfET() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitSelfET() -> float

      This method returns the electrostatic fit self overlap.
 

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonOverlay, EonOverlay

.. _OEEon_OEEonOverlay:

.. oe:class:: OEEonOverlay

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonOverlay : public OEShape::OEOverlay

  This class calculates charge density overlay. It defines the following public methods that implement shape and charge overlays of molecules:
    * :oe:meth:`Overlay<OEEon::OEEonOverlay::Overlay>`
    * :oe:meth:`SortedOverlay<OEEon::OEEonOverlay::SortedOverlay>`
    * :oe:meth:`BestOverlay<OEEon::OEEonOverlay::BestOverlay>`

The following methods are publicly inherited from :ref:`OEShape::OEOverlay <OEShape_OEOverlay>`.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonOverlay(const OEShape::OEOverlayOptions& opts = OEShape::OEOverlayOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEEonOverlay(opts: OEOverlayOptions = OEOverlayOptions()) -> OEEonOverlay

      Constructor. This class is not copyable.

   .. oe:method:: Destructor
      
      .. oe:api::

         ~OEEonOverlay()

   .. oe:method:: Overlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEEonOverlayResults>* Overlay(const OEChem::OEMCMolBase& fitMol)

      .. oe:language:: python

         .. oe:api:: python

            Overlay(fitMol: OEMol) -> Iterable[OEEonOverlayResults]

      This method returns all shape and charge density overlays for a fit molecules with respect to a reference molecule.

   .. oe:method:: SortedOverlay

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEEonOverlayScore>* SortedOverlay(const OEChem::OEMCMolBase& fitmol,
                                                                   const unsigned maxHits,
                                                                   const OESystem::OEBinaryPredicate<OEShape::OEBestOverlayScore, OEShape::OEBestOverlayScore>& pred = OEHighestShapeChargeTanimotoCombo())

      .. oe:language:: python

         .. oe:api:: python

            SortedOverlay(fitmol: OEMol, maxHits: int,
                          pred: OEBestOverlayScoreSorterPred = OEHighestShapeChargeTanimotoCombo()) -> Iterable[OEEonOverlayScore]

      This method returns all sorted using sorting dictated by the predicate in use. By default, it is the shape and charge density Tanimoto combo.

   .. oe:method:: BestOverlay
      
      .. oe:language:: c++ java csharp

         .. oe:api::

            bool BestOverlay(OEEonOverlayScore& score,
                             const OEChem::OEMCMolBase& fitmol,
                             const OESystem::OEBinaryPredicate<OEShape::OEBestOverlayScore, OEShape::OEBestOverlayScore>& pred = OEHighestShapeChargeTanimotoCombo())

      .. oe:language:: python

         .. oe:api:: python

            BestOverlay(score: OEEonOverlayScore, fitmol: OEMol,
                        pred: OEBestOverlayScoreSorterPred = OEHighestShapeChargeTanimotoCombo()) -> bool

      This method returns the best overlay according to the respective predicate used. By default, it is the shape and charge density Tanimoto combo.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonOverlayResults, EonOverlayResults

.. _OEEon_OEEonOverlayResults:

.. oe:class:: OEEonOverlayResults

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonOverlayResults

   This class stores all shape and charge overlay results.

   The :ref:`OEEonOverlayResults <OEEon_OEEonOverlayResults>` class defines the following public methods:
       *  :oe:meth:`GetScores<OEEon::OEEonOverlayResults::GetScores>`
       *  :oe:meth:`AddScore<OEEon::OEEonOverlayResults::AddScore>`
       *  :oe:meth:`Clear<OEEon::OEEonOverlayResults::Clear>`

   .. oe:method:: Constructors
      
      Default, constructor from :ref:`OEBestOverlayResults <OEShape_OEBestOverlayResults>` class object, and a copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonOverlayResults()
            OEEonOverlayResults(const OEShape::OEBestOverlayResults&)
            OEEonOverlayResults(const OEEon::OEEonOverlayResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEEonOverlayResults() -> OEEonOverlayResults
            OEEonOverlayResults(rhs: OEEonOverlayResults) -> OEEonOverlayResults
            OEEonOverlayResults(rhs: OEBestOverlayResults) -> OEEonOverlayResults

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEEonOverlayResults& operator=(const OEEonOverlayResults&)

      Assignment operator.

   .. oe:method:: Destructor

      .. oe:api::

         ~OEEonOverlayResults()

   .. oe:method:: GetScores

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEEonOverlayScore>* GetScores()

      .. oe:language:: python

         .. oe:api:: python

            GetScores() -> Iterable[OEEonOverlayScore]

      This method returns all the scores currently stored.

   .. oe:method:: AddScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddScore(const OEEonOverlayScore& sc)

      .. oe:language:: python

         .. oe:api:: python

            AddScore(sc: OEEonOverlayScore) -> bool

      This method adds a score to the object. 

   
   .. oe:method:: Clear

      .. oe:api::

         bool Clear()

      This method clears the contents of the object to an empty state.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonOverlayScore, EonOverlayScore

.. _OEEon_OEEonOverlayScore:

.. oe:class:: OEEonOverlayScore

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonOverlayScore : public OEShape::OEBestOverlayScore

   This class stores results of the shape and electrostatics overlay computation.

   The :ref:`OEEonOverlayScore <OEEon_OEEonOverlayScore>` class defines the following public methods:
       * :oe:meth:`GetTanimoto<OEEon::OEEonOverlayScore::GetTanimoto>`
       * :oe:meth:`GetETTanimoto<OEEon::OEEonOverlayScore::GetETTanimoto>`
       * :oe:meth:`GetTanimotoCombo<OEEon::OEEonOverlayScore::GetTanimotoCombo>`
       * :oe:meth:`GetETOverlap<OEEon::OEEonOverlayScore::GetETOverlap>`
       * :oe:meth:`GetRefSelfET<OEEon::OEEonOverlayScore::GetRefSelfET>`
       * :oe:meth:`GetFitSelfET<OEEon::OEEonOverlayScore::GetFitSelfET>`

   Public methods inherited from the parent class can be found in the :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>`.

   .. oe:method:: Constructors

      Default, copy constructor, and the constructor from parent class object.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonOverlayScore()
            OEEonOverlayScore(const OEEonOverlayScore&)
            OEEonOverlayScore(const OEShape::OEBestOverlayScore&)

      .. oe:language:: python

         .. oe:api:: python

            OEEonOverlayScore() -> OEEonOverlayScore
            OEEonOverlayScore(arg2: OEEonOverlayScore) -> OEEonOverlayScore
            OEEonOverlayScore(arg2: OEBestOverlayScore) -> OEEonOverlayScore

   .. oe:method:: Destructor
      
      .. oe:api::

         ~OEEonOverlayScore()

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEEonOverlayScore& operator=(const OEEonOverlayScore&)

      Assignment operator.

   .. _OEEon_OEEonOverlayScore_GetTanimoto:

   .. oe:method:: GetTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimoto() -> float

      This method returns the shape Tanimoto.

   .. _OEEon_OEEonOverlayScore_GetETTanimoto:

   .. oe:method:: GetETTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetETTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetETTanimoto() -> float

      This method returns the electrostatic Tanimoto.

   .. _OEEon_OEEonOverlayScore_GetTanimotoCombo:

   .. oe:method:: GetTanimotoCombo

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTanimotoCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimotoCombo() -> float

      This method returns the shape and electrostatics Tanimoto Combo.

   .. _OEEon_OEEonOverlayScore_GetETOverlap:

   .. oe:method:: GetETOverlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetETOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetETOverlap() -> float

      This method returns the electrostatic overlap.

   .. _OEEon_OEEonOverlayScore_GetRefSelfET:

   .. oe:method:: GetRefSelfET

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetRefSelfET() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefSelfET() -> float

      This method returns the electrostatic reference self overlap.

   .. _OEEon_OEEonOverlayScore_GetFitSelfET:

   .. oe:method:: GetFitSelfET

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetFitSelfET() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitSelfET() -> float

      This method returns the electrostatic fit self overlap.
 



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonPBFunc, EonPBFunc

.. _OEEon_OEEonPBFunc:

.. oe:class:: OEEonPBFunc

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonPBFunc : public OEMolPotential::OEMolFunc0

   This class enables computation of electrostatic potential similarity. 

   The :ref:`OEEonPBFunc <OEEon_OEEonPBFunc>` defines the following public methods:
    
    * :ref:`Setup<OEEon_OEEonPBFunc_Setup>`
    * :ref:`SetupRef<OEEon_OEEonPBFunc_SetupRef>`
    * :ref:`NumVar<OEEon_OEEonPBFunc_NumVar>`
    * :ref:`GetFComponents<OEEon_OEEonPBFunc_GetFComponents>`
    * :ref:`operator()<OEEon_OEEonPBFunc_operator>`
    * :ref:`Overlap<OEEon_OEEonPBFunc_Overlap>`
    * :ref:`CreateCopy<OEEon_OEEonPBFunc_CreateCopy>`

   Public methods inherited from the parent class can be found in the :ref:`OEMolPotential::OEMolFunc0 <OEMolPotential_OEMolFunc0>`.

   .. oe:method:: Constructors

      Default, copy constructors:

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonPBFunc(const OEEonPBOptions& opts = OEEonPBOptions())
            OEEonPBFunc(const OEEonPBFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEEonPBFunc(opts: OEEonPBOptions = OEEonPBOptions()) -> OEEonPBFunc
            OEEonPBFunc(arg2: OEEonPBFunc) -> OEEonPBFunc

   .. oe:method:: Destructor
      
      .. oe:api::

         ~OEEonPBFunc()

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEEonPBFunc& operator=(const OEEonPBFunc&)

      Assignment operator.

   ..   _OEEon_OEEonPBFunc_Setup:

   .. oe:method:: Setup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Setup(const OEChem::OEMolBase& fitMol)

      .. oe:language:: python

         .. oe:api:: python

            Setup(fitMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets up the fit molecule for Poisson-Boltzmann overlap calculations.
      The molecule must have 3D coordinates and partial charges assigned.

   ..   _OEEon_OEEonPBFunc_SetupRef:

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEChem::OEMolBase& refMol)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(refMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets up the reference molecule for Poisson-Boltzmann overlap calculations.
      The molecule must have 3D coordinates and partial charges assigned.

   ..   _OEEon_OEEonPBFunc_NumVar:

   .. oe:method:: NumVar

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned NumVar() const

      .. oe:language:: python

         .. oe:api:: python

            NumVar() -> int

      Returns the number of variables (degrees of freedom) for the current fit molecule.

   ..   _OEEon_OEEonPBFunc_CreateCopy:

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonPBFunc* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEEonPBFunc

      Creates and returns a deep copy of this object.

   ..   _OEEon_OEEonPBFunc_GetFComponents:

   .. oe:method:: GetFComponents

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEOpt::OEFComponent>* GetFComponents(const double* coords)

      .. oe:language:: python

         .. oe:api:: python

            GetFComponents(coords: float) -> Iterable[OEFComponent]

      Returns an iterator over the force components at the given coordinates.
      The fit molecule must have been set up via
      :oe:meth:`Setup<OEEon::OEEonPBFunc::Setup>`.

   ..   _OEEon_OEEonPBFunc_operator:

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator()(const double* coords)

      .. oe:language:: python

         .. oe:api:: python

            __call__(coords: OEDoubleArray) -> float

      Evaluates the Poisson-Boltzmann potential overlap function at the given
      coordinates. The fit molecule must have been set up via
      :oe:meth:`Setup<OEEon::OEEonPBFunc::Setup>`.

   ..   _OEEon_OEEonPBFunc_Overlap:

   .. oe:method:: Overlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Overlap(const double* coords, OEEonPBResults& results)
            bool Overlap(const OEChem::OEMolBase& fitMol,
                         OEEonPBResults& results)

      .. oe:language:: python

         .. oe:api:: python

            Overlap(coords: OEDoubleArray, results: OEEonPBResults) -> bool
            Overlap(fitMol: Union[OEGraphMol,OEMol,OEQMol],
                    results: OEEonPBResults) -> bool

      These methods compute Poisson–Boltzmann (PB) potential overlap between reference and fit molecules. The first one assumes that the fit molecule has already been set up using Setup method. The second one directly inputs the fit molecule and does this setup internally.

  

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonPBOptions, EonPBOptions

.. _OEEon_OEEonPBOptions:

.. oe:class:: OEEonPBOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonPBOptions : public OESystem::OEOptions

   This class sets up options required for generating PB calculations with  :ref:`OEEonPBFunc<OEEon_OEEonPBFunc>`.

The :ref:`OEEonPBOptions <OEEon_OEEonPBOptions>` class defines the following public methods:
    * :oe:meth:`GetDielectric<OEEon::OEEonPBOptions::GetDielectric>` and
      :oe:meth:`SetDielectric<OEEon::OEEonPBOptions::SetDielectric>`
    * :oe:meth:`GetSaltConcentration<OEEon::OEEonPBOptions::GetSaltConcentration>` and
      :oe:meth:`SetSaltConcentration<OEEon::OEEonPBOptions::SetSaltConcentration>` 
    * :oe:meth:`GetInnerMask<OEEon::OEEonPBOptions::GetInnerMask>` and
      :oe:meth:`SetInnerMask<OEEon::OEEonPBOptions::SetInnerMask>`
    * :oe:meth:`GetJoinRef<OEEon::OEEonPBOptions::GetJoinRef>` and
      :oe:meth:`SetJoinRef<OEEon::OEEonPBOptions::SetJoinRef>` 
    * :oe:meth:`GetOuterMask<OEEon::OEEonPBOptions::GetOuterMask>` and
      :oe:meth:`SetOuterMask<OEEon::OEEonPBOptions::SetOuterMask>` 
    * :oe:meth:`GetGridSpacing<OEEon::OEEonPBOptions::GetGridSpacing>` and
      :oe:meth:`SetGridSpacing<OEEon::OEEonPBOptions::SetGridSpacing>` 
    * :oe:meth:`GetGridBuffer<OEEon::OEEonPBOptions::GetGridBuffer>` and
      :oe:meth:`SetGridBuffer<OEEon::OEEonPBOptions::SetGridBuffer>` 
    * :oe:meth:`CreateCopy<OEEon::OEEonPBOptions::CreateCopy>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonPBOptions()
            OEEonPBOptions(const OEEonPBOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEEonPBOptions() -> OEEonPBOptions
            OEEonPBOptions(arg2: OEEonPBOptions) -> OEEonPBOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEEonPBOptions &operator=(const OEEonPBOptions &)

      Assignment operator.

   .. oe:method:: GetDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetDielectric() -> float

      Returns dielectric constant used in PB computation. See :oe:meth:`SetDielectric<OEEon::OEEonPBOptions::SetDielectric>` method.

   .. oe:method:: SetDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDielectric(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetDielectric(value: float) -> bool

      Sets the dielectric constant in PB computation.
      **Default: 80.0.**

   .. oe:method:: GetSaltConcentration

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSaltConcentration() const

      .. oe:language:: python

         .. oe:api:: python

            GetSaltConcentration() -> float

      Returns salt concentration value in PB computation. See :oe:meth:`SetSaltConcentration<OEEon::OEEonPBOptions::SetSaltConcentration>` method.

   .. oe:method:: SetSaltConcentration

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSaltConcentration(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetSaltConcentration(value: float) -> bool

      Sets salt concentration value in PB computation.
      **Default: 0.04.**

   .. oe:method:: GetInnerMask

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetInnerMask() const

      .. oe:language:: python

         .. oe:api:: python

            GetInnerMask() -> float

      Returns inner mask in PB computation. See :oe:meth:`SetInnerMask<OEEon::OEEonPBOptions::SetInnerMask>` method.

   .. oe:method:: SetInnerMask

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetInnerMask(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetInnerMask(value: float) -> bool

      Sets the inner mask in PB computation.
      **Default: 0.05.**

   .. _OEEon_OEEonPBOptions_GetJoinRef:
   .. oe:method:: GetJoinRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetJoinRef() const

      .. oe:language:: python

         .. oe:api:: python

            GetJoinRef() -> bool

      See :oe:meth:`SetJoinRef<OEEon::OEEonPBOptions::SetJoinRef>` method.

   .. _OEEon_OEEonPBOptions_SetJoinRef:
   .. oe:method:: SetJoinRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetJoinRef(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetJoinRef(value: bool) -> bool

      Sets flag if molecule should be joint with the reference to form a complex.
      **Default: False**

   .. oe:method:: GetOuterMask

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetOuterMask() const

      .. oe:language:: python

         .. oe:api:: python

            GetOuterMask() -> float

      Returns the outer mask value in PB computation. See :oe:meth:`SetOuterMask<OEEon::OEEonPBOptions::SetOuterMask>` method.

   .. oe:method:: SetOuterMask

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOuterMask(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetOuterMask(value: float) -> bool

      Sets the outer mask in PB computation.
      **Default: 0.0005.**

   .. oe:method:: GetGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetGridSpacing() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridSpacing() -> float

      Returns grid spacing used internally in PB computation. See :oe:meth:`SetGridSpacing<OEEon::OEEonPBOptions::SetGridSpacing>` method.

   .. oe:method:: SetGridSpacing

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetGridSpacing(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetGridSpacing(value: float) -> bool

      Sets the grid spacing for PB computation.
      **Default: 0.75.**

   .. oe:method:: GetGridBuffer

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetGridBuffer() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridBuffer() -> float

      Grid buffer value used in PB computation. See :oe:meth:`SetGridBuffer<OEEon::OEEonPBOptions::SetGridBuffer>` method.

   .. oe:method:: SetGridBuffer

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetGridBuffer(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetGridBuffer(value: float) -> bool

      Sets the grid buffer value used in PB computation.
      **Default: 6.0.**

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonPBOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEEonPBOptions

      Creates and returns a deep copy of this object.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonPBOverlay, EonPBOverlay

.. _OEEon_OEEonPBOverlay:

.. oe:class:: OEEonPBOverlay

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonPBOverlay

  This class calculates shape potential similarity overlay. It defines the following public methods:
    * :oe:meth:`SetupRef<OEEon::OEEonPBOverlay::SetupRef>`
    * :oe:meth:`BestOverlay<OEEon::OEEonPBOverlay::BestOverlay>`

   .. oe:method:: Constructors

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonPBOverlay(const OEShape::OEOverlayOptions& opts = OEShape::OEOverlayOptions(),
                           const OEEon::OEEonPBOptions& pbOpts = OEEon::OEEonPBOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEEonPBOverlay(opts: OEOverlayOptions = OEOverlayOptions(),
                           pbOpts: OEEonPBOptions = OEEonPBOptions()) -> OEEonPBOverlay

   .. oe:method:: Destructor
      
      .. oe:api::

         ~OEEonPBOverlay()

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEChem::OEMol& query)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(query: OEMol) -> bool

      This method sets up the reference molecule.

   .. oe:method:: BestOverlay
      
      .. oe:language:: c++ java csharp

         .. oe:api::

            bool BestOverlay(OEEonOverlayScore& score,
                             const OEChem::OEMCMolBase& mol,
                             const unsigned numInitHits)

      .. oe:language:: python

         .. oe:api:: python

            BestOverlay(score: OEEonOverlayScore, mol: OEMol, numInitHits: int) -> bool

      This method returns the best shape and potential similarity pose. The numInitHits parameter is the number of top shape and charge overlay hits that are rescored with shape and potential single point calculations.

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonPBResults, EonPBResults

.. _OEEon_OEEonPBResults:

.. oe:class:: OEEonPBResults

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonPBResults

   This class stores results of electrostatics PB potential overlap computation between a reference and a fit molecule.

   The :ref:`OEEonPBResults <OEEon_OEEonPBResults>` class defines the following public methods:
       * :oe:meth:`GetTanimoto<OEEon::OEEonPBResults::GetTanimoto>`
       * :oe:meth:`GetOverlap<OEEon::OEEonPBResults::GetOverlap>`
       * :oe:meth:`GetRefSelfOverlap<OEEon::OEEonPBResults::GetRefSelfOverlap>`
       * :oe:meth:`GetFitSelfOverlap<OEEon::OEEonPBResults::GetFitSelfOverlap>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEEonPBResults()
            OEEonPBResults(const OEEon::OEEonPBResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEEonPBResults() -> OEEonPBResults
            OEEonPBResults(arg2: OEEonPBResults) -> OEEonPBResults

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEEonPBResults& operator=(const OEEonPBResults&)

      Assignment operator.

   .. oe:method:: Destructor

      .. oe:api::

         ~OEEonPBResults()

   .. oe:method:: GetTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimoto() -> float

      This method returns the electrostatics potential similarity Tanimoto.

   .. oe:method:: GetOverlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlap() -> float

      This method returns electrostatics potential overlap.
  

   .. oe:method:: GetRefSelfOverlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetRefSelfOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefSelfOverlap() -> float

      This method returns electrostatics potential reference molecule self overlap.

   .. oe:method:: GetFitSelfOverlap

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetFitSelfOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitSelfOverlap() -> float

      This method returns electrostatics potential fit molecule self overlap.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEExactChargeFunc, ExactChargeFunc

.. _OEEon_OEExactChargeFunc:

.. oe:class:: OEExactChargeFunc

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEExactChargeFunc : public OEChargeFunc

  This class calculates charge density overlap using all atoms on all atoms exact charge Gaussians.

The :ref:`OEExactChargeFunc <OEEon_OEExactChargeFunc>` class defines the following public methods:

   * Constructor
   * :oe:meth:`CreateCopy<OEEon::OEExactChargeFunc::CreateCopy>`

Public methods from :ref:`OEChargeFunc <OEEon_OEChargeFunc>` are also available.

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExactChargeFunc()
            OEExactChargeFunc(const OEExactChargeFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEExactChargeFunc() -> OEExactChargeFunc
            OEExactChargeFunc(arg2: OEExactChargeFunc) -> OEExactChargeFunc

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEExactChargeFunc & operator=(const OEExactChargeFunc &)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEExactChargeFunc* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEExactChargeFunc

      Creates and returns a deep copy of this object.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEGridChargeFunc, GridChargeFunc

.. _OEEon_OEGridChargeFunc:

.. oe:class:: OEGridChargeFunc

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEGridChargeFunc : public OEChargeFunc

  This class calculates charge density overlap using a Gaussian charge grid for the reference molecule and interpolating fit molecule atom charge overlaps.

The :ref:`OEGridChargeFunc <OEEon_OEGridChargeFunc>` class defines the following public methods:

   * Constructor
   * :oe:meth:`SetupRef<OEEon::OEGridChargeFunc::SetupRef>`
   * :oe:meth:`CreateCopy<OEEon::OEGridChargeFunc::CreateCopy>`

Public methods from :ref:`OEChargeFunc <OEEon_OEChargeFunc>` are also available.

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEGridChargeFunc()
            OEGridChargeFunc(const OEGridChargeFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEGridChargeFunc() -> OEGridChargeFunc
            OEGridChargeFunc(argFunc: OEGridChargeFunc) -> OEGridChargeFunc

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEGridChargeFunc & operator=(const OEGridChargeFunc & argFunc)

      Assignment operator.

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEChem::OEMolBase& refMol)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(argRefMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Overrides :oe:meth:`OEEon::OEChargeFunc::SetupRef` to set up the
      Gaussian charge grid for the reference molecule.
      The molecule must have 3D coordinates and partial charges assigned.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEGridChargeFunc* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEGridChargeFunc

      Creates and returns a deep copy of this object.



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEHighestChargeTanimoto, HighestChargeTanimoto

.. _OEEon_OEHighestChargeTanimoto:

.. oe:class:: OEHighestChargeTanimoto

   .. oe:api::

      struct OEHighestChargeTanimoto : public OEShape::OEHighestColorTanimoto{};

   This predicate compares two :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>`
   objects and returns ``true`` if *s1* scores better than *s2* based on
   electrostatic charge-density Tanimoto coefficient (range 0–1). Higher values
   indicate better charge-distribution overlap between molecules. Used to sort or
   select results from :ref:`OEEonOverlay <OEEon_OEEonOverlay>` calculations.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHighestChargeTanimoto



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEHighestShapeChargeTanimotoCombo, HighestShapeChargeTanimotoCombo

.. _OEEon_OEHighestShapeChargeTanimotoCombo:

.. oe:class:: OEHighestShapeChargeTanimotoCombo

   .. oe:api::

      struct OEHighestShapeChargeTanimotoCombo : public OEShape::OEHighestTanimotoCombo{};

   This predicate compares two :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>`
   objects and returns ``true`` if *s1* scores better than *s2* based on the
   combo score, which is the arithmetic mean of shape Tanimoto and charge
   Tanimoto: ``(ShapeTanimoto + ChargeTanimoto) / 2``. Higher combo scores
   indicate better overall shape and charge similarity.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHighestShapeChargeTanimotoCombo



.. oe:namespace:: OEEon

.. meta::
   :keywords: OEHighestShapeTanimoto, HighestShapeTanimoto

.. _OEEon_OEHighestShapeTanimoto:

.. oe:class:: OEHighestShapeTanimoto

   .. oe:api::

      struct OEHighestShapeTanimoto : public OEShape::OEHighestTanimoto{};

   This class represents `OEHighestShapeTanimoto`, predicate to compare 
   :ref:`OEBestOverlayScore<OEShape_OEBestOverlayScore>` based on shape tanimoto.

   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEBestOverlayScore& s1, const OEBestOverlayScore& s2) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(s1: OEBestOverlayScore, s2: OEBestOverlayScore) -> bool

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEBinaryFunction<OEBestOverlayScore , OEBestOverlayScore , bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHighestShapeTanimoto



.. _OEEonConstants:

****************************
Preliminary OEEon Constants
****************************

.. oe:namespace:: OEEon

.. toctree::

   OEEonStatusCode



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEEon

..  _OEEon_OEEonStatusCode:

.. oe:constnamespace:: OEEonStatusCode

   .. attention::

      |PRELIMINARY-API|

   This namespace contains constants indicating the status of Eon operations.

   ..  _OEEon_OEEonStatusCode_Success:

   .. oe:constant:: Success

      Indicates a successful operation. Value: ``0``.

   ..  _OEEon_OEEonStatusCode_Failed:

   .. oe:constant:: Failed

      Indicates a failed operation. Value: ``999``.

  

.. _OEEonFunctions:

****************************
Preliminary OEEon Functions
****************************

.. oe:namespace:: OEEon

..  toctree::

    OEEtGetArch
    OEEtGetLicensee
    OEEtGetPlatform
    OEEtGetRelease
    OEEtGetSite
    OEEtGetVersion
    OEEtIsLicensed


.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEtGetArch

.. _OEEon_OEEtGetArch:

.. oe:function:: OEEtGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEEtGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEEtGetArch() -> str

   Returns the architecture of the current version of **Eon TK**. Examples include:

   * microsoft-win32-x86

   * redhat-RHEL5-x86_64


.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEtGetLicensee

.. _OEEon_OEEtGetLicensee:

.. oe:function:: OEEtGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEEtGetLicensee()
         bool OEEtGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEEtGetLicensee() -> str
         OEEtGetLicensee(licensee: str) -> bool

   Returns the LICENSEE from the current valid **Eon TK** license.


.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEtGetPlatform

.. _OEEon_OEEtGetPlatform:

.. oe:function:: OEEtGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEEtGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEEtGetPlatform() -> str

   Returns the platform, including compiler version, of the current
   version of **Eon TK**. Examples include:

   * microsoft-win32-msvc9-MD-x86

   * redhat-RHEL5-g++4.1-x86_64


.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEtGetRelease

.. _OEEon_OEEtGetRelease:

.. oe:function:: OEEtGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEEtGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEEtGetRelease() -> str

   Returns the version of this toolkit release. For example: ``3.1.0``.


.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEtGetSite

.. _OEEon_OEEtGetSite:

.. oe:function:: OEEtGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEEtGetSite()
         bool OEEtGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEEtGetSite() -> str
         OEEtGetSite(site: str) -> bool

   Returns the SITE from the current valid *Eon TK** license.

.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEtGetVersion

.. _OEEon_OEEtGetVersion:

.. oe:function:: OEEtGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEEtGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEEtGetVersion() -> int

   Returns the build date of the toolkit as an unsigned int. For example: ``20240227``.


.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEtIsLicensed

.. _OEEon_OEEtIsLicensed:

.. oe:function:: OEEtIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEEtIsLicensed(const char* feature = 0, unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEEtIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **Eon TK** functionality.

   The feature argument can be used to check for a valid license to
   **Eon TK** along with the following features: python.

   The expdate argument can be used to obtain the expiration date of
   the current **Eon TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function



.. _eon_part_api:

******************************
Preliminary API
******************************

.. toctree::
   :maxdepth: 2

   OEEonClasses/OEEonClasses
   OEEonFunctions/OEEonFunctions
   OEEonConstants/OEEonConstants


.. _chapter_eonexamples:
.. _eon_part_examples:

********************************************************************************
Eon Examples
********************************************************************************

The following table lists the currently available **Eon TK** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`overlap<section_eon_overlap>`
        - Computing **Eon** overlap

      * - :ref:`simple overlay<section_eon_simple_overlay>`
        - Simple **Eon** (Shape and Charge Density) overlay

      * - :ref:`pb overlay<section_eon_pb_overlay>`
        - **Eon** PB (Shape and PB Potential) overlay

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`overlap<section_eon_overlap>`
        - Computing **Eon** Overlap

      * - :ref:`simple overlay<section_eon_simple_overlay>`
        - Simple **Eon** Overlay

      * - :ref:`pb overlay<section_eon_pb_overlay>`
        - **Eon** PB Overlay

.. _section_eon_overlap:

Computing Eon Overlap
--------------------------------------------------------------------------------
This example reads in a reference molecule and fit molecules and performs
static shape charge similarity calculations. Results are outputted to a file.

.. oe:source:: eon_overlap.cpp
   :language: c++
   :caption:  Computing Eon Overlap
   :refnum:   1

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`eon_overlap.cpp <../../../../sublibs/tklibs/et/examples/eon_overlap.cpp>`

.. oe:source:: eon_overlap.py
   :language: python
   :caption:  Computing Eon Overlap
   :refnum:   1

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`eon_overlap.py <../../../../wrappers/python/examples/eon/eon_overlap.py>`

.. _section_eon_simple_overlay:

Simple Eon Overlay
--------------------------------------------------------------------------------
This example reads in a reference molecule and fit molecules and overlays
them according to their shape and charge density similarity.

.. oe:source:: eon_simple_overlay.cpp
   :language: c++
   :caption:  Computing Simple Eon Overlay
   :refnum:   2

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`eon_simple_overlay.cpp <../../../../sublibs/tklibs/et/examples/eon_simple_overlay.cpp>`

.. oe:source:: eon_simple_overlay.py
   :language: python
   :caption:  Computing Simple Eon Overlay
   :refnum:   2

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`eon_simple_overlay.py <../../../../wrappers/python/examples/eon/eon_simple_overlay.py>`

.. _section_eon_pb_overlay:

Eon PB Overlay
--------------------------------------------------------------------------------
This example reads in a reference molecule and fit molecules and overlays
them according to their shape and potential similarity.

.. oe:source:: eon_pb_overlay.cpp
   :language: c++
   :caption:  Computing Eon PB Overlay
   :refnum:   3

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`eon_pb_overlay.cpp <../../../../sublibs/tklibs/et/examples/eon_pb_overlay.cpp>`

.. oe:source:: eon_pb_overlay.py
   :language: python
   :caption:  Computing Eon PB Overlay
   :refnum:   3

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`eon_pb_overlay.py <../../../../wrappers/python/examples/eon/eon_pb_overlay.py>`



.. eontk toolkit documentation master file

###########################################
Eon Toolkit |et_version|
###########################################

.. attention::

   **Eon TK** is currently only available in C++ and Python.

.. toctree::
   :maxdepth: 3

   introduction/introduction
   theory/theory
   examples
   api
   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _chapter_eon_introduction:

Welcome to the Eon Toolkit Documentation
========================================

The purpose of **Eon TK** is to provide a public API for enhancing the user's capabilities to create workflows
modeling the electrostatics of molecules. The following
types of calculations for molecules of interest are possible with the current version of **Eon TK**:

* Shape and charge density similarity.
* Shape and Poisson-Boltzmann (PB) potential similarity.
* Shape and charge overlay.
* Shape and PB potential overlay.

We refer the interested reader to the following resources for further details.

* :ref:`Theory section <eon_theory>` for the EON command line application.
* :ref:`Theory section <chapter_eon_theory>` for Eon TK.
* Eon Examples
	.. oe:language:: python

	   .. list-table::
	      :widths: 100 100
	      :header-rows: 1

	      * - Program
	        - Description

	      * - :ref:`overlap<section_eon_overlap>`
	        - Computing EON overlap

	      * - :ref:`simple overlay<section_eon_simple_overlay>`
	        - Simple EON overlay

	      * - :ref:`pb overlay<section_eon_pb_overlay>`
	        - EON PB overlay




************
Introduction
************

.. toctree::
   :maxdepth: 3

   eon_introduction


.. _eon_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version3_1_3
   version3_1_2
   version3_1_1
   version3_1_0
 


Eon TK 3.1.0
================================================================================

This is the first commercial release of **Eon TK**.

New features
--------------------------------------------------------------------------------

The following classes are available as preliminary API with the first
release of this toolkit.

  * :ref:`OEChargeFunc <OEEon_OEChargeFunc>`
  * :ref:`OEEonHit <OEEon_OEEonHit>`
  * :ref:`OEEonHitlistBuilder <OEEon_OEEonHitlistBuilder>`
  * :ref:`OEEonHitlistOptions <OEEon_OEEonHitlistOptions>`
  * :ref:`OEEonOverlapFunc <OEEon_OEEonOverlapFunc>`
  * :ref:`OEEonOverlapScore <OEEon_OEEonOverlapScore>`
  * :ref:`OEEonOverlay <OEEon_OEEonOverlay>`
  * :ref:`OEEonOverlayResults <OEEon_OEEonOverlayResults>`
  * :ref:`OEEonOverlayScore <OEEon_OEEonOverlayScore>`
  * :ref:`OEEonPBFunc <OEEon_OEEonPBFunc>`
  * :ref:`OEEonPBOptions <OEEon_OEEonPBOptions>`
  * :ref:`OEEonPBOverlay <OEEon_OEEonPBOverlay>`
  * :ref:`OEExactChargeFunc <OEEon_OEExactChargeFunc>`
  * :ref:`OEGridChargeFunc <OEEon_OEGridChargeFunc>`

The following functions are available as preliminary API with the first
release of this toolkit.

  * :ref:`OEEtGetArch <OEEon_OEEtGetArch>`
  * :ref:`OEEtGetLicensee <OEEon_OEEtGetLicensee>`
  * :ref:`OEEtGetPlatform <OEEon_OEEtGetPlatform>`
  * :ref:`OEEtGetRelease <OEEon_OEEtGetRelease>`
  * :ref:`OEEtGetSite <OEEon_OEEtGetSite>`
  * :ref:`OEEtGetVersion <OEEon_OEEtGetVersion>`
  * :ref:`OEEtIsLicensed <OEEon_OEEtIsLicensed>`
  


EON TK 3.1.1
================================================================================

Minor internal improvements have been made.




Eon TK 3.1.2
================================================================================

Minor internal improvements have been made.



EON TK 3.1.3
================================================================================

New Features
--------------------------------------------------------------------------------

* Two new methods, :ref:`GetJoinRef<OEEon_OEEonPBOptions_GetJoinRef>` and
  :ref:`SetJoinRef<OEEon_OEEonPBOptions_SetJoinRef>`, have been added to
  :ref:`OEEonPBOptions<OEEon_OEEonPBOptions>` to enable ``PB`` calculation
  on complexes in :ref:`OEEonPBFunc<OEEon_OEEonPBFunc>`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!




.. _chapter_eon_theory:

+++++++++++++++++++++
Theory
+++++++++++++++++++++

**Eon TK** is used to model the electrostatics of molecules via charge
density and via Poisson-Boltzmann (PB) potential.
Some key conceptual points for both of these approaches are discussed below.



Electrostatic Charge Gaussians
==============================

The charge density of a molecule is modeled via the sum of distributed Gaussians centered at the atom centers and with prefactors
proportional to partial charges:

.. math::

   \rho_{\text{charge}} = \sum_{i=1}^{N_{\text{A}} }\frac{C_i}{\left(\sqrt{2\pi}\sigma\right)^3} \, e^{-\left[(x-x_i)^2+(y-y_i)^2+(z-z_i)^2\right]^2/{2\sigma^2}}

where C\ :sub:`i` , x\ :sub:`i` , y\ :sub:`i` , and  z\ :sub:`i` are the charge coordinates of atom *i* and *sigma* is the
charge density Gaussian width. With this charge density, the charge density similarity and the shape and
charge density similarity combo can be computed, leveraging the Gaussian technology at the heart of **Shape TK**.


Electrostatic PB Potential
==========================

The potential similarity measurement uses **Zap TK** and the field-based Tanimoto, which
depends on partial charges on the
molecule as well as on the dielectric
properties of the medium. For the electrostatics PB overlay, the
molecules are aligned with shape and charge similarity first. A certain number of the
best hits (typically five) are kept, which are further rescored with shape and PB potential similarity
to find the best hit. This is a fast approach compared to rigid optimization of
the PB potential similarity. This approach has been explored in the literature ([Muchmore-2006]_; [Naylor-2009]_; [Boström-2013]_).




********************************
Theory
********************************

.. toctree::
   :maxdepth: 3

   eon_theory


:orphan:

*********************************
Informatics and Modeling Toolkits
*********************************

..  toctree::
    :maxdepth: 2

    OEChem TK<oechemtk/index>
    OEDepict TK<depicttk/index>
    OEDocking TK<dockingtk/index>
    Grapheme™ TK<graphemetk/index>
    GraphSim TK<graphsimtk/index-nogpu>
    Lexichem TK<lexichemtk/index>
    OEMedChem TK<medchemtk/index>
    MolProp TK<molproptk/index>
    Omega TK<omegatk/index-nogpu>
    Quacpac TK<quacpactk/index>
    Shape TK<shapetk/index>
    Spicoli TK<spicolitk/index>
    Szmap TK<szmaptk/index>
    Szybki Toolkit<szybkitk/index>
    Zap Toolkit<zaptk/index>

:orphan:

#################################
Informatics and Modeling Toolkits
#################################

..  toctree::
    :maxdepth: 2

    OEChem TK<oechemtk/index>
    Bioisostere TK<bioisosteretk/index>
    OEDepict TK<depicttk/index>
    OEDocking TK<dockingtk/index>
    Eon TK<eontk/index>
    FastROCS™ TK<fastrocstk/index>
    OEFF TK<oefftk/index>
    Grapheme™ TK<graphemetk/index>
    GraphSim TK<graphsimtk/index>
    Lexichem TK<lexichemtk/index>
    OEMedChem TK<medchemtk/index>
    MolProp TK<molproptk/index>
    Omega TK<omegatk/index>
    Quacpac TK<quacpactk/index>
    Saiph TK<saiphtk/index>
    Shape TK<shapetk/index>
    SiteHopper TK<sitehoppertk/index>
    Spicoli TK<spicolitk/index>
    Spruce TK<sprucetk/index>
    Szmap TK<szmaptk/index>
    Szybki TK<szybkitk/index>
    Zap TK<zaptk/index>


:orphan:

.. used only in the CPP toolkit

.. _lexichem_section_examples_cipstereo:

Perceive CIP stereo information
===============================

Perceives the CIP (Cahn-Ingold-Prelog) stereo information for molecules in an input file and displays that on the
command line.

Command Line Interface
----------------------

The program takes one argument, -in, which should be an OpenEye-supported molecule file format that contains one or more
molecules.

Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`cipstereo.cpp <../../../../sublibs/tklibs/iupac/examples/cipstereo.cpp>`

   .. only:: oepdf

      .. oe:source:: cipstereo.cpp
         :language: c++

.. _OEConstrClasses:

*******************
OEConstr Classes
*******************

.. oe:namespace:: OEConstr

.. toctree::

   OEDihedralQuadPenalty
   OEHarmonicPotential


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConstr

.. meta::
   :keywords: OEDihedralQuadPenalty, DihedralQuadPenalty

.. _OEConstr_OEDihedralQuadPenalty:

.. oe:class:: OEDihedralQuadPenalty

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEDihedralQuadPenalty : public OEMolPotential::OEMolFunc2

   The :ref:`OEDihedralQuadPenalty <OEConstr_OEDihedralQuadPenalty>` class defines harmonic restraints to dihedrals or torsions.
   The restraint is applied on the cosine of the angle, in the form of :math:`K*(cos(\alpha) - cos(\alpha_0))^2`.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`     
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`
    * :oe:meth:`SetupConf<OEMolPotential::OEMolFunc::SetupConf>`

   The :ref:`OEDihedralQuadPenalty <OEConstr_OEDihedralQuadPenalty>` class defines the following public methods:
    * :oe:meth:`GetPenaltyConstant<OEConstr::OEDihedralQuadPenalty::GetPenaltyConstant>`
    * :oe:meth:`GetSpecifiedAngle<OEConstr::OEDihedralQuadPenalty::GetSpecifiedAngle>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDihedralQuadPenalty(const OEChem::OEAtomBase& a1,
                                  const OEChem::OEAtomBase& a2,
                                  const OEChem::OEAtomBase& a3,
                                  const OEChem::OEAtomBase& a4, double alpha0,
                                  double fc = 1e4)
            const OEChem::OEAtomBase& a1, const OEChem::OEAtomBase& a2, const OEChem::OEAtomBase& a3, const OEChem::OEAtomBase& a4, double alpha0, double K)
            OEDihedralQuadPenalty(const OEDihedralQuadPenalty &)

      .. oe:language:: python

         .. oe:api:: python

            OEDihedralQuadPenalty(a1: OEAtomBase, a2: OEAtomBase,
                                  a3: OEAtomBase, a4: OEAtomBase,
                                  alpha0: float, fc: float = 1e4) -> OEDihedralQuadPenalty
            OEDihedralQuadPenalty(arg2: OEDihedralQuadPenalty) -> OEDihedralQuadPenalty

      Default and copy constructors.
      Arguments `a1-a4` correspond to the four atoms that define the dihedral to be restrained, `alpha0`
      corresponds to the specified angle, and `K` corresponds to the penalty force constant. 

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDihedralQuadPenalty &operator=(const OEDihedralQuadPenalty&)

      Assignment operator.

   .. oe:method:: GetPenaltyConstant

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPenaltyConstant() const

      .. oe:language:: python

         .. oe:api:: python

            GetPenaltyConstant() -> float

      Returns the current value of the penalty force constant.

   .. oe:method:: GetSpecifiedAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSpecifiedAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetSpecifiedAngle() -> float

      Returns the current value of the specified angle `alpha0`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEConstr

.. meta::
   :keywords: OEHarmonicPotential, HarmonicPotential

.. _OEConstr_OEHarmonicPotential:

.. oe:class:: OEHarmonicPotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEHarmonicPotential : public OEMolPotential::OEMolFunc1

   The :ref:`OEHarmonicPotential <OEConstr_OEHarmonicPotential>` class defines harmonic constraint interactions between atoms.

   .. _figure_OEHarmonicPotential_Hierarchy:

   .. figure:: oefftk/images/OEHarmonicPotential.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`     
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`
    * :oe:meth:`SetupConf<OEMolPotential::OEMolFunc::SetupConf>`

   The :ref:`OEHarmonicPotential <OEConstr_OEHarmonicPotential>` class defines the following public methods:
    * :oe:meth:`Get_dc<OEConstr::OEHarmonicPotential::Get_dc>`
    * :oe:meth:`Get_kc<OEConstr::OEHarmonicPotential::Get_kc>`
    * :oe:meth:`Set<OEConstr::OEHarmonicPotential::Set>`
    * :oe:meth:`Set_dc<OEConstr::OEHarmonicPotential::Set_dc>`
    * :oe:meth:`Set_kc<OEConstr::OEHarmonicPotential::Set_kc>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHarmonicPotential(double _kc, double _dc)
            OEHarmonicPotential(const OEHarmonicPotential &)

      .. oe:language:: python

         .. oe:api:: python

            OEHarmonicPotential(kc: float, dc: float) -> OEHarmonicPotential
            OEHarmonicPotential(arg2: OEHarmonicPotential) -> OEHarmonicPotential

      Default and copy constructors. Parameters passed in the first constructor correspond
      to k and d in the harmonic potential :math:`V = k(r-d)^2`.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHarmonicPotential &operator=(const OEHarmonicPotential&)

      Assignment operator.

   .. oe:method:: Get_dc

      .. oe:language:: c++ java csharp

         .. oe:api::

            double Get_dc() const

      .. oe:language:: python

         .. oe:api:: python

            Get_dc() -> float

      Returns the current value of parameter d (constraining distance) in constraining potential
      :math:`V = k(r-d)^2`.

   .. oe:method:: Get_kc

      .. oe:language:: c++ java csharp

         .. oe:api::

            double Get_kc() const

      .. oe:language:: python

         .. oe:api:: python

            Get_kc() -> float

      Returns the current value of parameter k (force constant) in constraining potential
      :math:`V = k(r-d)^2`. 

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>&,
                  unsigned int flag = OEFuncType::HarmonicPot);

      The Set function can be used to set the unary atomic predicate used for the selective 
      constraining of atoms. This function has to be used before Setup(const OEChem::OEMolBase&). 

   .. oe:method:: Set_dc

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Set_dc(double d)

      .. oe:language:: python

         .. oe:api:: python

            Set_dc(dc: float) -> None

      Sets d parameter in :math:`V = k(r-d)^2`.

   .. oe:method:: Set_kc

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Set_kc(double k)

      .. oe:language:: python

         .. oe:api:: python

            Set_kc(kc: float) -> None

      Sets k parameter in :math:`V = k(r-d)^2`.
 



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEComplexEnergies, ComplexEnergies

.. _OEFF_OEComplexEnergies:

.. oe:class:: OEComplexEnergies

   .. oe:api::

      class OEComplexEnergies

   This class provides energy components resulting from energy calculation for
   a protein-ligand complex.

   The :ref:`OEComplexEnergies <OEFF_OEComplexEnergies>` class defines the following public methods:
    * :oe:meth:`GetComplexSolvationEnergy<OEFF::OEComplexEnergies::GetComplexSolvationEnergy>`
    * :oe:meth:`GetDesolvationEnergy<OEFF::OEComplexEnergies::GetDesolvationEnergy>`
    * :oe:meth:`GetHostComponents<OEFF::OEComplexEnergies::GetHostComponents>`
    * :oe:meth:`GetHostEnergy<OEFF::OEComplexEnergies::GetHostEnergy>`
    * :oe:meth:`GetHostSolvationEnergy<OEFF::OEComplexEnergies::GetHostSolvationEnergy>`
    * :oe:meth:`GetInterComponents<OEFF::OEComplexEnergies::GetInterComponents>`
    * :oe:meth:`GetInterEnergy<OEFF::OEComplexEnergies::GetInterEnergy>`
    * :oe:meth:`GetLigandComponents<OEFF::OEComplexEnergies::GetLigandComponents>`
    * :oe:meth:`GetLigandEnergy<OEFF::OEComplexEnergies::GetLigandEnergy>`
    * :oe:meth:`GetLigandSolvationEnergy<OEFF::OEComplexEnergies::GetLigandSolvationEnergy>`
    * :oe:meth:`GetTotalEnergy<OEFF::OEComplexEnergies::GetTotalEnergy>`

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEComplexEnergies()
            OEComplexEnergies(const OEComplexEnergies&)

      .. oe:language:: python

         .. oe:api:: python

            OEComplexEnergies() -> OEComplexEnergies
            OEComplexEnergies(arg2: OEComplexEnergies) -> OEComplexEnergies

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEComplexEnergies &operator=(const OEComplexEnergies &)

      Assignment operator.

   .. oe:method:: GetComplexSolvationEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetComplexSolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexSolvationEnergy() -> float

      Returns the solvation energy of the protein-ligand complex.

   .. oe:method:: GetDesolvationEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDesolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetDesolvationEnergy() -> float

      Returns the desolvation energy.

   .. oe:method:: GetHostComponents

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEOpt::OEFComponent>* GetHostComponents() const

      .. oe:language:: python

         .. oe:api:: python

            GetHostComponents() -> Iterable[OEFComponent]

      Returns the intra-molecular energy components of the host (protein) molecule.

   .. oe:method:: GetHostEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHostEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetHostEnergy() -> float

      Returns the total intra-molecular energy of the host (protein) molecule.

   .. oe:method:: GetHostSolvationEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHostSolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetHostSolvationEnergy() -> float

      Returns the solvation energy of the host (protein) molecule.

   .. oe:method:: GetInterComponents

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEOpt::OEFComponent>* GetInterComponents() const

      .. oe:language:: python

         .. oe:api:: python

            GetInterComponents() -> Iterable[OEFComponent]

      Returns the inter-molecular energy components of the complex.

   .. oe:method:: GetInterEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetInterEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetInterEnergy() -> float

      Returns the total inter-molecular energy.

   .. oe:method:: GetLigandComponents

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEOpt::OEFComponent>* GetLigandComponents() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandComponents() -> Iterable[OEFComponent]

      Returns the intra-molecular energy components of the ligand molecule.

   .. oe:method:: GetLigandEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLigandEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandEnergy() -> float

      Returns the total intra-molecular energy of the ligand molecule.

   .. oe:method:: GetLigandSolvationEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLigandSolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandSolvationEnergy() -> float

      Returns the solvation energy of the ligand molecule.

   .. oe:method:: GetTotalEnergy

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTotalEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalEnergy() -> float

      Returns the total energy of the complex.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEComplexFF, ComplexFF

.. _OEFF_OEComplexFF:

.. oe:class:: OEComplexFF

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEComplexFF : public OEMolPotential::OEMolFunc2

   The :ref:`OEComplexFF <OEFF_OEComplexFF>` is a generic class for force-fields of complexes.  This
   class defines an interface for combining multiple :ref:`OEForceField <OEMolPotential_OEForceField>` to
   easily construct a force field for a host/guest or protein/ligand complex. The 
   :ref:`OEComplexFF <OEFF_OEComplexFF>` extends the :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>` class to allow
   this being a collection of multiple force fields.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The :ref:`OEComplexFF <OEFF_OEComplexFF>` class defines the following public methods:
    * :oe:meth:`AdaptHostCoords<OEFF::OEComplexFF::AdaptHostCoords>`
    * :oe:meth:`GetLigandFF<OEFF::OEComplexFF::GetLigandFF>`
    * :oe:meth:`GetVar<OEFF::OEComplexFF::GetVar>`
    * :oe:meth:`Set<OEFF::OEComplexFF::Set>`
    * :oe:meth:`SetHostFlex<OEFF::OEComplexFF::SetHostFlex>`
    * :oe:meth:`SetNonBondCutoff<OEFF::OEComplexFF::SetNonBondCutoff>`
    * :oe:meth:`SetupHost<OEFF::OEComplexFF::SetupHost>`

   The following classes derive from this class:
    * :ref:`OEMMFFComplex <OEFF_OEMMFFComplex>`
    * :ref:`OESmirnoffComplex <OEFF_OESmirnoffComplex>`
    * :ref:`OEMMFFAmberComplex <OEFF_OEMMFFAmberComplex>`
    * :ref:`OEFF14SBSmirnoffComplex <OEFF_OEFF14SBSmirnoffComplex>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEComplexFF(const OEMolPotential::OEForceField& ligandFF,
                        const OEMolPotential::OEForceField& hostFF,
                        const OEMolPotential::OEInterMolFunc2& interFF)
            OEComplexFF(const OEComplexFF&)

      .. oe:language:: python

         .. oe:api:: python

            OEComplexFF(ligandFF: OEForceField, hostFF: OEForceField,
                        interFF: OEInterMolFunc2) -> OEComplexFF
            OEComplexFF(arg2: OEComplexFF) -> OEComplexFF

      Default and copy constructors.

      Construction of a :ref:`OEComplexFF <OEFF_OEComplexFF>` requires a :ref:`OEForceField <OEMolPotential_OEForceField>`
      for the guest or the ligand molecule, a :ref:`OEForceField <OEMolPotential_OEForceField>`
      for the host or the protein molecule, and an :ref:`OEInterMolFunc2 <OEMolPotential_OEInterMolFunc2>` for the
      inter-molecular interactions.

   .. oe:method:: AdaptHostCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AdaptHostCoords(double* coords, const double* var) const

      .. oe:language:: python

         .. oe:api:: python

            AdaptHostCoords(coords: OEDoubleArray, var: OEDoubleArray) -> bool

      Takes a set of variables as the second argument and provides the corresponding host molecule 
      coordinates into the first argument. This method is used to obtain optimized coordinates for 
      the flexible host or protein molecule.

.. _OEFF_OEComplexFF_GetLigandFF:

   .. oe:method:: GetLigandFF

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMolPotential::OEForceField& GetLigandFF() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandFF() -> OEForceField

      Returns reference to the underlying forcefield used for small molecules.

   .. oe:method:: GetVar

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetVar(double* var, const double* coords)

      .. oe:language:: python

         .. oe:api:: python

            GetVar(var: OEDoubleArray, x: OEDoubleArray) -> None

      Takes reference coordinates of the molecule, and transforms them into the variable type or 
      coordinate system (``var``) that will be used during an optimization. The transfored variables
      here provides the combined host/guest coordinates, whenoptimization involves flexible host or 
      protein molecule.

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEBondBase> &pred,
                  unsigned int functype)
         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &pred,
                  unsigned int functype)
         bool Set(const OESystem::OEBinaryPredicate<OEChem::OEAtomBase,OEChem::OEAtomBase> &pred,
                  unsigned int functype)
         bool Set(const OESystem::OEBinaryPredicate<OEChem::OEBondBase,OEChem::OEBondBase> &pred,
                  unsigned int functype)

      These methods assigns interaction-control predicates, and only applies to the guest or the 
      ligand molecule. The first argument is the predicate type to be passed to the interaction component. 
      The second argument is a value or a set of binary OR'ed values taken from the 
      :oe:const:`OEMolPotential::OEFuncType` namespace which specifies the 
      intended target for the predicate assignment.

      The ``Set`` method passes on the interaction-control predicates to the appropriate force field components contained. Method returns ``false`` if predicate was not set to any of the components contained by the force field.

      :oe:meth:`Set<OEFF::OEComplexFF::Set>` must be called before the 
      :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.

.. _OEFF_OEComplexFF_SetHostFlex:

   .. oe:method:: SetHostFlex

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetHostFlex(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred)

      .. oe:language:: python

         .. oe:api:: python

            SetHostFlex(pred: OEUnaryAtomPred) -> bool

      Set predicate to define the flexible portion of the host or protein molecule.  If no predicate
      is set to define flexibility, the host or protein is considered rigid. 

      :oe:meth:`SetHostFlex<OEFF::OEComplexFF::SetHostFlex>` must be called before the 
      :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.

.. _OEFF_OEComplexFF_SetNonBondCutoff:

   .. oe:method:: SetNonBondCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNonBondCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetNonBondCutoff(arg2: float) -> bool

      Sets non-bonded interactions cutoff.
      Setting a value of ``0.0`` or less assumes that all interactions should be
      included without any cutoff.
      
   .. oe:method:: SetupHost

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupHost(const OEChem::OEMolBase& host)

      .. oe:language:: python

         .. oe:api:: python

            SetupHost(host: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This method defines the interface for initializing the host in the :ref:`OEComplexFF <OEFF_OEComplexFF>`.

      :oe:meth:`SetupHost<OEFF::OEComplexFF::SetupHost>` must be called before calling 
      :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` .



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEComplexFFParameter, ComplexFFParameter

.. _OEFF_OEComplexFFParameter:

.. oe:class:: OEComplexFFParameter

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEComplexFFParameter : public OESystem::OEMultiParameter<OEMolPotential::OEForceField>

   The :ref:`OEComplexFFParameter <OEFF_OEComplexFFParameter>` represents parameter that has a value of type
   :ref:`OEComplexFF <OEFF_OEComplexFF>`.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` andw
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OEMultiParameter <OESystem_OEMultiParameter>`:
    * :oe:meth:`AddLegalEntry<OESystem::OEMultiParameter::AddLegalEntry>` 
    * :oe:meth:`GetDefault<OESystem::OEMultiParameter::GetDefault>` and
      :oe:meth:`SetDefault<OESystem::OEMultiParameter::SetDefault>` 
    * :oe:meth:`GetSetting<OESystem::OEMultiParameter::GetSetting>`
    * :oe:meth:`GetValue<OESystem::OEMultiParameter::GetValue>` and
      :oe:meth:`SetValue<OESystem::OEMultiParameter::SetValue>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEComplexFFParameter()
            OEComplexFFParameter(const std::string& name,
                                 const bool customAllowed)
            OEComplexFFParameter(const OEComplexFFParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEComplexFFParameter(name: str, customAllowed: bool) -> OEComplexFFParameter
            OEComplexFFParameter() -> OEComplexFFParameter
            OEComplexFFParameter(arg2: OEComplexFFParameter) -> OEComplexFFParameter

      Default and copy constructors.

      Constructs an :ref:`OEComplexFFParameter <OEFF_OEComplexFFParameter>` instance using the specified set of parameters.
      The second argument in the second constructor represents if a custom force field can be used.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEComplexFFParameter &operator=(const OEComplexFFParameter &)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEFF14SBParsley, FF14SBParsley

.. _OEFF_OEFF14SBParsley:

.. oe:class:: OEFF14SBParsley

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFF14SBParsley : public OEFF14SBSmirnoff

   The :ref:`OEFF14SBParsley <OEFF_OEFF14SBParsley>` is a class for protein systems which might
   contain cofactors. It assumes that the iteraction are described with **OEFF14SBParsleyParams**.
   
 
   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEForceField <OEMolPotential_OEForceField>`:
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`

   The following methods are publicly inherited from :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF2::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF2::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF2::RemoveMolFunc>`

   The following methods are publicly inherited from :ref:`OEFF14SBSmirnoff <OEFF_OEFF14SBSmirnoff>`
    * :oe:meth:`PrepMol<OEFF::OEFF14SBSmirnoff::PrepMol>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFF14SBParsley(const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OEFF14SBParsley(const OEFF14SBParsley&)

      .. oe:language:: python

         .. oe:api:: python

            OEFF14SBParsley(opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OEFF14SBParsley
            OEFF14SBParsley(arg2: OEFF14SBParsley) -> OEFF14SBParsley

      Default and copy constructors. 

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFF14SBParsley& operator=(const OEFF14SBParsley&)

      The assignment operator.

      Assignment operator.

 



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEFF14SBParsleyComplex, FF14SBParsleyComplex

.. _OEFF_OEFF14SBParsleyComplex:

.. oe:class:: OEFF14SBParsleyComplex

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFF14SBParsleyComplex : public OEComplexFF

   The :ref:`OEFF14SBParsleyComplex <OEFF_OEFF14SBParsleyComplex>` represents a force field for a protein-ligand
   complex system, where the interactions are described with **OEFF14SBParsleyParams**.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEComplexFF <OEFF_OEComplexFF>`:
    * :oe:meth:`AdaptHostCoords<OEFF::OEComplexFF::AdaptHostCoords>`
    * :oe:meth:`GetVar<OEFF::OEComplexFF::GetVar>`
    * :oe:meth:`Set<OEFF::OEComplexFF::Set>`
    * :oe:meth:`SetHostFlex<OEFF::OEComplexFF::SetHostFlex>`
    * :oe:meth:`SetNonBondCutoff<OEFF::OEComplexFF::SetNonBondCutoff>`
    * :oe:meth:`SetupHost<OEFF::OEComplexFF::SetupHost>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFF14SBParsleyComplex(const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OEFF14SBParsleyComplex(const OEFF14SBParsleyComplex&)

      .. oe:language:: python

         .. oe:api:: python

            OEFF14SBParsleyComplex(opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OEFF14SBParsleyComplex
            OEFF14SBParsleyComplex(arg2: OEFF14SBParsleyComplex) -> OEFF14SBParsleyComplex

      Default and copy constructors.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. _OEFF_OEFF14SBParsleyParams:

.. oe:class:: OEFF14SBParsleyParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFF14SBParsleyParams : public public OEFF14SBSmirnoffParams

   The :ref:`OEFF14SBParsleyParams <OEFF_OEFF14SBParsleyParams>` class provides the ability to retrieve parameters
   necessary to perform energy and gradient calculations using the OEFF14SBParsley force field.  

   .. note::

      The inherited methods, :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`,
      :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>` and
      :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`,
      have no meaning in the Parsley force field and SHOULD NOT be used. 

   The following methods are publicly inherited from :ref:`OEFFParams <OEMolPotential_OEFFParams>`:
    * :oe:meth:`CreateCopy<OEMolPotential::OEFFParams::CreateCopy>`
    * :oe:meth:`GetCoulombParams<OEMolPotential::OEFFParams::GetCoulombParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`
    * :oe:meth:`GetEquilibriumAngle<OEMolPotential::OEFFParams::GetEquilibriumAngle>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>`
    * :oe:meth:`GetEquilibriumBondLength<OEMolPotential::OEFFParams::GetEquilibriumBondLength>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`GetVdwRadius<OEMolPotential::OEFFParams::GetVdwRadius>`
    * :oe:meth:`GetContactDistance<OEMolPotential::OEFFParams::GetContactDistance>`
    * :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`
    * :oe:meth:`PrepMol<OEMolPotential::OEFFParams::PrepMol>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`HasVdwParams<OEMolPotential::OEFFParams::HasVdwParams>`
    * :oe:meth:`HasStretchParams<OEMolPotential::OEFFParams::HasStretchParams>`
    * :oe:meth:`HasBendParams<OEMolPotential::OEFFParams::HasBendParams>`
    * :oe:meth:`HasTorsionParams<OEMolPotential::OEFFParams::HasTorsionParams>`
    * :oe:meth:`GetTitle<OEMolPotential::OEFFParams::GetTitle>`

   The following methods are publicly inherited from :ref:`OEFF14SBSmirnoffParams <OEFF_OEFF14SBSmirnoffParams>`:
    * :oe:meth:`Load<OEFF::OEFF14SBSmirnoffParams::Load>`
    

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFF14SBParsleyParams()
            OEFF14SBParsleyParams(const OEFF14SBParsleyParams&)

      .. oe:language:: python

         .. oe:api:: python

            OEFF14SBParsleyParams() -> OEFF14SBParsleyParams
            OEFF14SBParsleyParams(arg2: OEFF14SBParsleyParams) -> OEFF14SBParsleyParams

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFF14SBParsleyParams& operator=(const OEFF14SBParsleyParams&)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEFF14SBSage, FF14SBSage

.. _OEFF_OEFF14SBSage:

.. oe:class:: OEFF14SBSage

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFF14SBSage : public OEFF14SBSmirnoff

   The :ref:`OEFF14SBSage <OEFF_OEFF14SBSage>` is a class for protein systems which might
   contain cofactors. It assumes that the iteraction are described with **OEFF14SBSageParams**.
   
 
   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEForceField <OEMolPotential_OEForceField>`:
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`

   The following methods are publicly inherited from :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF2::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF2::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF2::RemoveMolFunc>`

   The following methods are publicly inherited from :ref:`OEFF14SBSmirnoff <OEFF_OEFF14SBSmirnoff>`
    * :oe:meth:`PrepMol<OEFF::OEFF14SBSmirnoff::PrepMol>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFF14SBSage(const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OEFF14SBSage(const OEFF14SBSage&)

      .. oe:language:: python

         .. oe:api:: python

            OEFF14SBSage(opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OEFF14SBSage
            OEFF14SBSage(arg2: OEFF14SBSage) -> OEFF14SBSage

      Default and copy constructors. 

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFF14SBSage& operator=(const OEFF14SBSage&)

      The assignment operator.

      Assignment operator.

 



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEFF14SBSageComplex, FF14SBSageComplex

.. _OEFF_OEFF14SBSageComplex:

.. oe:class:: OEFF14SBSageComplex

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFF14SBSageComplex : public OEComplexFF

   The :ref:`OEFF14SBSageComplex <OEFF_OEFF14SBSageComplex>` represents a force field for a protein-ligand
   complex system, where the interactions are described with **OEFF14SBSageParams**.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEComplexFF <OEFF_OEComplexFF>`:
    * :oe:meth:`AdaptHostCoords<OEFF::OEComplexFF::AdaptHostCoords>`
    * :oe:meth:`GetVar<OEFF::OEComplexFF::GetVar>`
    * :oe:meth:`Set<OEFF::OEComplexFF::Set>`
    * :oe:meth:`SetHostFlex<OEFF::OEComplexFF::SetHostFlex>`
    * :oe:meth:`SetNonBondCutoff<OEFF::OEComplexFF::SetNonBondCutoff>`
    * :oe:meth:`SetupHost<OEFF::OEComplexFF::SetupHost>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFF14SBSageComplex(const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OEFF14SBSageComplex(const OEFF14SBSageComplex&)

      .. oe:language:: python

         .. oe:api:: python

            OEFF14SBSageComplex(opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OEFF14SBSageComplex
            OEFF14SBSageComplex(arg2: OEFF14SBSageComplex) -> OEFF14SBSageComplex

      Default and copy constructors.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. _OEFF_OEFF14SBSageParams:

.. oe:class:: OEFF14SBSageParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFF14SBSageParams : public public OEFF14SBSmirnoffParams

   The :ref:`OEFF14SBSageParams <OEFF_OEFF14SBSageParams>` class provides the ability to retrieve parameters
   necessary to perform energy and gradient calculations using the OEFF14SBSage force field.  

   .. note::

      The inherited methods, :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`,
      :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>` and
      :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`,
      have no meaning in the Sage force field and SHOULD NOT be used. 

   The following methods are publicly inherited from :ref:`OEFFParams <OEMolPotential_OEFFParams>`:
    * :oe:meth:`CreateCopy<OEMolPotential::OEFFParams::CreateCopy>`
    * :oe:meth:`GetCoulombParams<OEMolPotential::OEFFParams::GetCoulombParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`
    * :oe:meth:`GetEquilibriumAngle<OEMolPotential::OEFFParams::GetEquilibriumAngle>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>`
    * :oe:meth:`GetEquilibriumBondLength<OEMolPotential::OEFFParams::GetEquilibriumBondLength>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`GetVdwRadius<OEMolPotential::OEFFParams::GetVdwRadius>`
    * :oe:meth:`GetContactDistance<OEMolPotential::OEFFParams::GetContactDistance>`
    * :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`
    * :oe:meth:`PrepMol<OEMolPotential::OEFFParams::PrepMol>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`HasVdwParams<OEMolPotential::OEFFParams::HasVdwParams>`
    * :oe:meth:`HasStretchParams<OEMolPotential::OEFFParams::HasStretchParams>`
    * :oe:meth:`HasBendParams<OEMolPotential::OEFFParams::HasBendParams>`
    * :oe:meth:`HasTorsionParams<OEMolPotential::OEFFParams::HasTorsionParams>`
    * :oe:meth:`GetTitle<OEMolPotential::OEFFParams::GetTitle>`

   The following methods are publicly inherited from :ref:`OEFF14SBSmirnoffParams <OEFF_OEFF14SBSmirnoffParams>`:
    * :oe:meth:`Load<OEFF::OEFF14SBSmirnoffParams::Load>`
    

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFF14SBSageParams()
            OEFF14SBSageParams(const OEFF14SBSageParams&)

      .. oe:language:: python

         .. oe:api:: python

            OEFF14SBSageParams() -> OEFF14SBSageParams
            OEFF14SBSageParams(arg2: OEFF14SBSageParams) -> OEFF14SBSageParams

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFF14SBSageParams& operator=(const OEFF14SBSageParams&)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEFF14SBSmirnoff, FF14SBSmirnoff

.. _OEFF_OEFF14SBSmirnoff:

.. oe:class:: OEFF14SBSmirnoff

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFF14SBSmirnoff : public OEGenericFF2

   The :ref:`OEFF14SBSmirnoff <OEFF_OEFF14SBSmirnoff>` is a generic class for protein systems which might
   contain cofactors. It assumes that the intetractions are descrined with **OEFF14SBSmirnoffParams**.
 
   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEForceField <OEMolPotential_OEForceField>`:
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`

   The following methods are publicly inherited from :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF2::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF2::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF2::RemoveMolFunc>`

   The following classes derive from this class:
    * :ref:`OEFF14SBParsley <OEFF_OEFF14SBParsley>`
    * :ref:`OEFF14SBSage <OEFF_OEFF14SBSage>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFF14SBSmirnoff(const OEFF14SBSmirnoffParams& params = OEFF14SBSmirnoffParams(),
                             const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OEFF14SBSmirnoff(const OEFF14SBSmirnoff&)

      .. oe:language:: python

         .. oe:api:: python

            OEFF14SBSmirnoff(params: OEFF14SBSmirnoffParams = OEFF14SBSmirnoffParams(),
                             opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OEFF14SBSmirnoff
            OEFF14SBSmirnoff(arg2: OEFF14SBSmirnoff) -> OEFF14SBSmirnoff

      Default and copy constructors. 

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFF14SBSmirnoff& operator=(const OEFF14SBSmirnoff&)

      The assignment operator.

      Assignment operator.

   .. oe:method:: PrepMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool PrepMol(OEChem::OEMolBase& mol, bool sweep = true,
                         bool warnOK = true) const

      .. oe:language:: python

         .. oe:api:: python

            PrepMol(mol: Union[OEGraphMol,OEMol,OEQMol], sweep: bool = True,
                    warnOK: bool = True) -> bool

      Prepares molecule to be handled with proper parameters
      
   
 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEFF14SBSmirnoffComplex, FF14SBSmirnoffComplex

.. _OEFF_OEFF14SBSmirnoffComplex:

.. oe:class:: OEFF14SBSmirnoffComplex

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFF14SBSmirnoffComplex : public OEComplexFF

   The :ref:`OEFF14SBSmirnoffComplex <OEFF_OEFF14SBSmirnoffComplex>` represents a force field for a protein-ligand
   complex system, where the interactions are described with **OEFF14SBSmirnoffParams**.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEComplexFF <OEFF_OEComplexFF>`:
    * :oe:meth:`AdaptHostCoords<OEFF::OEComplexFF::AdaptHostCoords>`
    * :oe:meth:`GetVar<OEFF::OEComplexFF::GetVar>`
    * :oe:meth:`Set<OEFF::OEComplexFF::Set>`
    * :oe:meth:`SetHostFlex<OEFF::OEComplexFF::SetHostFlex>`
    * :oe:meth:`SetNonBondCutoff<OEFF::OEComplexFF::SetNonBondCutoff>`
    * :oe:meth:`SetupHost<OEFF::OEComplexFF::SetupHost>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFF14SBSmirnoffComplex(const OEFF14SBSmirnoffParams& params = OEFF14SBSmirnoffParams(),
                                    const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OEFF14SBSmirnoffComplex(const OEFF14SBSmirnoffComplex&)

      .. oe:language:: python

         .. oe:api:: python

            OEFF14SBSmirnoffComplex(params: OEFF14SBSmirnoffParams = OEFF14SBSmirnoffParams(),
                                    opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OEFF14SBSmirnoffComplex
            OEFF14SBSmirnoffComplex(arg2: OEFF14SBSmirnoffComplex) -> OEFF14SBSmirnoffComplex

      Default and copy constructors.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. _OEFF_OEFF14SBSmirnoffParams:

.. oe:class:: OEFF14SBSmirnoffParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFF14SBSmirnoffParams : public OEMolPotential::OEFFParams

   The :ref:`OEFF14SBSmirnoffParams <OEFF_OEFF14SBSmirnoffParams>` class provides the ability to retrieve parameters
   necessary to perform energy and gradient calculations using OEFF14SBSmirnoff force field.  
   By default parameters for the ``Smirnoff99Frost`` force field are used to handle nonprotein
   part of the molecular system. 

   .. note::

      The inherited methods, :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`,
      :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>` and
      :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`,
      have no meaning in the SMIRNOFF force field and SHOULD NOT be used. 

   The following methods are publicly inherited from :ref:`OEFFParams <OEMolPotential_OEFFParams>`:
    * :oe:meth:`CreateCopy<OEMolPotential::OEFFParams::CreateCopy>`
    * :oe:meth:`GetCoulombParams<OEMolPotential::OEFFParams::GetCoulombParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`
    * :oe:meth:`GetEquilibriumAngle<OEMolPotential::OEFFParams::GetEquilibriumAngle>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>`
    * :oe:meth:`GetEquilibriumBondLength<OEMolPotential::OEFFParams::GetEquilibriumBondLength>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`GetVdwRadius<OEMolPotential::OEFFParams::GetVdwRadius>`
    * :oe:meth:`GetContactDistance<OEMolPotential::OEFFParams::GetContactDistance>`
    * :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`
    * :oe:meth:`PrepMol<OEMolPotential::OEFFParams::PrepMol>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`HasVdwParams<OEMolPotential::OEFFParams::HasVdwParams>`
    * :oe:meth:`HasStretchParams<OEMolPotential::OEFFParams::HasStretchParams>`
    * :oe:meth:`HasBendParams<OEMolPotential::OEFFParams::HasBendParams>`
    * :oe:meth:`HasTorsionParams<OEMolPotential::OEFFParams::HasTorsionParams>`
    * :oe:meth:`GetTitle<OEMolPotential::OEFFParams::GetTitle>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFF14SBSmirnoffParams()
            OEFF14SBSmirnoffParams(const OEFF14SBSmirnoffParams&)

      .. oe:language:: python

         .. oe:api:: python

            OEFF14SBSmirnoffParams() -> OEFF14SBSmirnoffParams
            OEFF14SBSmirnoffParams(arg2: OEFF14SBSmirnoffParams) -> OEFF14SBSmirnoffParams

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFF14SBSmirnoffParams& operator=(const OEFF14SBSmirnoffParams&)

      The assignment operator.

      Assignment operator.

   .. oe:method:: Load

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Load(const unsigned int fftype)
            bool Load(const OEPlatform::oeisstream& ifs)
            bool Load(const std::string& xmlFile)

      .. oe:language:: python

         .. oe:api:: python

            Load(fftype: int) -> bool
            Load(ifs: oeistream) -> bool
            Load(xmlFile: str) -> bool

      Methods which load force field parameters for the SMIRNOFF/Parsley part of the potential. 
      First method is used to load available build-in parameter set defined in the
      :oe:constns:`OEMolSmirnoff::OESmirnoffType` namespace.
      Second method takes the name of the parameter file in XML format. This file might contain user custom
      parameters. Third method takes a stream object :ref:`oeisstream <OEPlatform_oeisstream>` which contains Smirnoff
      parameters. It is a convenience method which might be used in user code when the parameters XML file is 
      converted to a stream.


.. _OEFFClasses:

*******************
OEFF Classes
*******************

.. oe:namespace:: OEFF

.. toctree::

   OEFF14SBParsley
   OEFF14SBParsleyComplex
   OEFF14SBParsleyParams
   OEFF14SBSage
   OEFF14SBSageComplex
   OEFF14SBSageParams
   OEFF14SBSmirnoff
   OEFF14SBSmirnoffComplex
   OEFF14SBSmirnoffParams
   OEComplexEnergies
   OEComplexFF
   OEComplexFFParameter
   OEForceFieldParameter
   OEMMFF_IEFF
   OEMMFFAmber
   OEMMFFAmberComplex
   OEMMFFAmberOptions
   OEMMFFComplex
   OEMMFFIEFFOptions
   OEMMFFSheffield
   OEMMFFSheffieldOptions
   OESmirnoffComplex


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEForceFieldParameter, ForceFieldParameter

.. _OEFF_OEForceFieldParameter:

.. oe:class:: OEForceFieldParameter

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEForceFieldParameter : public OESystem::OEMultiParameter<OEMolPotential::OEForceField>

   The :ref:`OEForceFieldParameter <OEFF_OEForceFieldParameter>` represents parameter that has a value of type
   :ref:`OEForceField <OEMolPotential_OEForceField>`.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OEMultiParameter <OESystem_OEMultiParameter>`:
    * :oe:meth:`AddLegalEntry<OESystem::OEMultiParameter::AddLegalEntry>` 
    * :oe:meth:`GetDefault<OESystem::OEMultiParameter::GetDefault>` and
      :oe:meth:`SetDefault<OESystem::OEMultiParameter::SetDefault>` 
    * :oe:meth:`GetSetting<OESystem::OEMultiParameter::GetSetting>`
    * :oe:meth:`GetValue<OESystem::OEMultiParameter::GetValue>` and
      :oe:meth:`SetValue<OESystem::OEMultiParameter::SetValue>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEForceFieldParameter()
            OEForceFieldParameter(const std::string& name,
                                  const bool customAllowed)
            OEForceFieldParameter(const OEForceFieldParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEForceFieldParameter(name: str, customAllowed: bool) -> OEForceFieldParameter
            OEForceFieldParameter() -> OEForceFieldParameter
            OEForceFieldParameter(arg2: OEForceFieldParameter) -> OEForceFieldParameter

      Default and copy constructors.

      Constructs an :ref:`OEForceFieldParameter <OEFF_OEForceFieldParameter>` instance using the specified set of parameters.
      The second argument in the second constructor represents if a custom forcefield can be used.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEForceFieldParameter &operator=(const OEForceFieldParameter &)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEMMFFAmber, MMFFAmber

.. _OEFF_OEMMFFAmber:

.. oe:class:: OEMMFFAmber

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFFAmber : public OEMolPotential::OEGenericFF2

   A hybrid force field that applies MMFF intramolecular terms to the ligand
   and Amber intramolecular terms to the host (protein), with Amber-based
   intermolecular interactions between them. This force field is intended for
   use in protein-ligand scoring and optimization workflows.

   The host molecule must have 3D coordinates assigned. The ligand must have
   3D coordinates and partial charges assigned (e.g. via
   :oe:func:`OEProton::OEAssignCharges`) before calling
   :oe:meth:`PrepMol<OEFF::OEMMFFAmber::PrepMol>`.

   .. seealso::

      * :ref:`OEMMFFAmberOptions <OEFF_OEMMFFAmberOptions>` class
      * :ref:`OEMMFFAmberComplex <OEFF_OEMMFFAmberComplex>` class

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEForceField <OEMolPotential_OEForceField>`:
    * :oe:meth:`PrepMol<OEMolPotential::OEForceField::PrepMol>`
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`

   The following methods are publicly inherited from :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF2::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF2::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF2::RemoveMolFunc>`

   The :ref:`OEMMFFAmber <OEFF_OEMMFFAmber>` class defines the following public methods:
    * :oe:meth:`PrepMol<OEFF::OEMMFFAmber::PrepMol>`
    * :oe:meth:`Setup<OEFF::OEMMFFAmber::Setup>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFAmber(const OEChem::OEMolBase& host)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFAmber(host: Union[OEGraphMol,OEMol,OEQMol]) -> OEMMFFAmber

      Constructs the force field using the given host molecule and default
      :ref:`OEMMFFAmberOptions <OEFF_OEMMFFAmberOptions>`.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFAmber(const OEChem::OEMolBase& host,
                        const OEMMFFAmberOptions& options)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFAmber(host: Union[OEGraphMol,OEMol,OEQMol],
                        argOptions: OEMMFFAmberOptions) -> OEMMFFAmber

      Constructs the force field using the given host molecule and the
      specified options.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMMFFAmber & operator=(const OEMMFFAmber &)

      Assignment operator.

   .. oe:method:: PrepMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool PrepMol(OEChem::OEMolBase& mol, bool sweep = true,
                         bool warnOK = true) const

      .. oe:language:: python

         .. oe:api:: python

            PrepMol(mol: Union[OEGraphMol,OEMol,OEQMol], sweep: bool = True,
                    warnOK: bool = True) -> bool

      Prepares a ligand molecule for use with this force field by assigning
      MMFF atom types and partial charges. Returns ``true`` on success.

      ``sweep``
         If ``true``, sweeps through charge models to find one that covers
         all atoms.

      ``warnOK``
         If ``true``, suppresses warnings for atoms that cannot be typed.

   .. oe:method:: Setup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Setup(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Setup(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets up the force field for the given ligand molecule. The molecule
      must have been prepared with :oe:meth:`PrepMol<OEFF::OEMMFFAmber::PrepMol>`
      before calling this method. Returns ``true`` on success.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEMMFFAmberComplex, MMFFAmberComplex

.. _OEFF_OEMMFFAmberComplex:

.. oe:class:: OEMMFFAmberComplex

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFFAmberComplex : public OEComplexFF

   The :ref:`OEMMFFAmberComplex <OEFF_OEMMFFAmberComplex>` represents a force field
   for a protein-ligand complex system, where both the
   protein and ligand intra-molecular interactions are described with
   :ref:`OEMMFFParams <OEMolMMFF_OEMMFFParams>` and the inter-molecular interactions
   are described with **Amber**.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEComplexFF <OEFF_OEComplexFF>`:
    * :oe:meth:`AdaptHostCoords<OEFF::OEComplexFF::AdaptHostCoords>`
    * :oe:meth:`GetVar<OEFF::OEComplexFF::GetVar>`
    * :oe:meth:`Set<OEFF::OEComplexFF::Set>`
    * :oe:meth:`SetHostFlex<OEFF::OEComplexFF::SetHostFlex>`
    * :oe:meth:`SetNonBondCutoff<OEFF::OEComplexFF::SetNonBondCutoff>`
    * :oe:meth:`SetupHost<OEFF::OEComplexFF::SetupHost>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFAmberComplex(const OEMolMMFF::OEMMFFParams& params = OEMolMMFF::OEMMFFParams(),
                               const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OEMMFFAmberComplex(const OEMMFFAmberComplex&)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFAmberComplex(mmffParams: OEMMFFParams = OEMolMMFF_OEMMFFParams(),
                               opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OEMMFFAmberComplex
            OEMMFFAmberComplex(arg2: OEMMFFAmberComplex) -> OEMMFFAmberComplex

      Default and copy constructors.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEMMFFAmberOptions, MMFFAmberOptions

.. _OEFF_OEMMFFAmberOptions:

.. oe:class:: OEMMFFAmberOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFFAmberOptions : public OESystem::OEOptions

   Encapsulates the options that control the initialization of
   :ref:`OEMMFFAmber <OEFF_OEMMFFAmber>`.

   .. seealso::

      * :ref:`OEMMFFAmber <OEFF_OEMMFFAmber>` class

   The :ref:`OEMMFFAmberOptions <OEFF_OEMMFFAmberOptions>` class defines the following public methods:
    * :oe:meth:`GetAmberTerms<OEFF::OEMMFFAmberOptions::GetAmberTerms>`
    * :oe:meth:`GetIntermolecularVdWCutoff<OEFF::OEMMFFAmberOptions::GetIntermolecularVdWCutoff>`
    * :oe:meth:`GetMMFFTerms<OEFF::OEMMFFAmberOptions::GetMMFFTerms>`
    * :oe:meth:`GetUseExternalCharges<OEFF::OEMMFFAmberOptions::GetUseExternalCharges>`
    * :oe:meth:`GetUseMMFF94s<OEFF::OEMMFFAmberOptions::GetUseMMFF94s>`
    * :oe:meth:`SetAmberTerms<OEFF::OEMMFFAmberOptions::SetAmberTerms>`
    * :oe:meth:`SetIntermolecularVdWCutoff<OEFF::OEMMFFAmberOptions::SetIntermolecularVdWCutoff>`
    * :oe:meth:`SetMMFFTerms<OEFF::OEMMFFAmberOptions::SetMMFFTerms>`
    * :oe:meth:`SetUseExternalCharges<OEFF::OEMMFFAmberOptions::SetUseExternalCharges>`
    * :oe:meth:`SetUseMMFF94s<OEFF::OEMMFFAmberOptions::SetUseMMFF94s>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFAmberOptions()
            OEMMFFAmberOptions(const OEMMFFAmberOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFAmberOptions() -> OEMMFFAmberOptions
            OEMMFFAmberOptions(arg2: OEMMFFAmberOptions) -> OEMMFFAmberOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMMFFAmberOptions &operator=(const OEMMFFAmberOptions&)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFAmberOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMMFFAmberOptions

      Returns a pointer to a copy of the options object.

   .. oe:method:: GetAmberTerms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAmberTerms() const

      .. oe:language:: python

         .. oe:api:: python

            GetAmberTerms() -> int

      Gets the constant defining which Amber force field terms to include.

   .. oe:method:: GetIntermolecularVdWCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetIntermolecularVdWCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetIntermolecularVdWCutoff() -> float

      Gets the cutoff distance (in Angstroms) used for intermolecular
      van der Waals interactions.

   .. oe:method:: GetMMFFTerms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMMFFTerms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMMFFTerms() -> int

      Gets the constant defining which MMFF force field terms to include.

   .. oe:method:: GetUseExternalCharges

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseExternalCharges() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseExternalCharges() -> bool

      Gets the flag that controls whether partial charges already present
      on the molecule are used instead of MMFF-derived charges.

   .. oe:method:: GetUseMMFF94s

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseMMFF94s() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseMMFF94s() -> bool

      Gets the flag that controls whether the MMFF94s variant of parameters
      is used.

   .. oe:method:: SetAmberTerms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAmberTerms(unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetAmberTerms(value: int) -> bool

      Sets the constant defining which Amber force field terms to include.

   .. oe:method:: SetIntermolecularVdWCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetIntermolecularVdWCutoff(double)

      .. oe:language:: python

         .. oe:api:: python

            SetIntermolecularVdWCutoff(value: float) -> bool

      Sets the cutoff distance (in Angstroms) used for intermolecular
      van der Waals interactions.

   .. oe:method:: SetMMFFTerms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMMFFTerms(unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMMFFTerms(value: int) -> bool

      Sets the constant defining which MMFF force field terms to include.

   .. oe:method:: SetUseExternalCharges

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetUseExternalCharges(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseExternalCharges(value: bool) -> bool

      Sets the flag that controls whether partial charges already present
      on the molecule are used instead of MMFF-derived charges.

   .. oe:method:: SetUseMMFF94s

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetUseMMFF94s(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseMMFF94s(value: bool) -> bool

      Sets the flag that controls whether the MMFF94s variant of parameters
      is used.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEMMFFComplex, MMFFComplex

.. _OEFF_OEMMFFComplex:

.. oe:class:: OEMMFFComplex

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFFComplex : public OEComplexFF

   The :ref:`OEMMFFComplex <OEFF_OEMMFFComplex>` provides a predefined interface to use :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
   for all interactions in a protein-ligand complex. 

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEComplexFF <OEFF_OEComplexFF>`:
    * :oe:meth:`AdaptHostCoords<OEFF::OEComplexFF::AdaptHostCoords>`
    * :oe:meth:`GetVar<OEFF::OEComplexFF::GetVar>`
    * :oe:meth:`Set<OEFF::OEComplexFF::Set>`
    * :oe:meth:`SetHostFlex<OEFF::OEComplexFF::SetHostFlex>`
    * :oe:meth:`SetNonBondCutoff<OEFF::OEComplexFF::SetNonBondCutoff>`
    * :oe:meth:`SetupHost<OEFF::OEComplexFF::SetupHost>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFComplex(const OEMolMMFF::OEMMFFParams& params = OEMolMMFF::OEMMFFParams(),
                          const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OEMMFFComplex(const OEMMFFComplex&)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFComplex(params: OEMMFFParams = OEMolMMFF_OEMMFFParams(),
                          opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OEMMFFComplex
            OEMMFFComplex(arg2: OEMMFFComplex) -> OEMMFFComplex

      Default and copy constructors.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEMMFFIEFFOptions, MMFFIEFFOptions

.. _OEFF_OEMMFFIEFFOptions:

.. oe:class:: OEMMFFIEFFOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFFIEFFOptions : public OESystem::OEOptions

   This class orovides interface to setup options required for :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`
   initialization.
   
   The :ref:`OEMMFFIEFFOptions <OEFF_OEMMFFIEFFOptions>` class defines the following public methods:
    * :oe:meth:`GetIEFFTerms<OEFF::OEMMFFIEFFOptions::GetIEFFTerms>`
    * :oe:meth:`GetMMFFTerms<OEFF::OEMMFFIEFFOptions::GetMMFFTerms>`
    * :oe:meth:`GetUseMMFF94s<OEFF::OEMMFFIEFFOptions::GetUseMMFF94s>`
    * :oe:meth:`SetIEFFTerms<OEFF::OEMMFFIEFFOptions::SetIEFFTerms>`
    * :oe:meth:`SetMMFFTerms<OEFF::OEMMFFIEFFOptions::SetMMFFTerms>`
    * :oe:meth:`SetUseMMFF94s<OEFF::OEMMFFIEFFOptions::SetUseMMFF94s>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFIEFFOptions()
            OEMMFFIEFFOptions(const OEMMFFIEFFOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFIEFFOptions() -> OEMMFFIEFFOptions
            OEMMFFIEFFOptions(arg2: OEMMFFIEFFOptions) -> OEMMFFIEFFOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMMFFIEFFOptions &operator=(const OEMMFFIEFFOptions&)

      Assignment operator.

   .. oe:method:: GetIEFFTerms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetIEFFTerms() const

      .. oe:language:: python

         .. oe:api:: python

            GetIEFFTerms() -> int

      Gets the constant defining what terms of the IEFF force field to be used.

   .. oe:method:: GetMMFFTerms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMMFFTerms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMMFFTerms() -> int

      Gets the constant defining what terms of the MMFF force field to be used.

   .. oe:method:: GetUseMMFF94s

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseMMFF94s() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseMMFF94s() -> bool

      Gets flag that defines if MMFF94s variation of parameters should be used.

   .. oe:method:: SetIEFFTerms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetIEFFTerms(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetIEFFTerms(value: int) -> bool

      Sets the constant defining what terms of the IEFF force field to be used.

   .. oe:method:: SetMMFFTerms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMMFFTerms(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMMFFTerms(value: int) -> bool

      Sets the constant defining what terms of the MMFF force field to be used.

   .. oe:method:: SetUseMMFF94s

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetUseMMFF94s(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseMMFF94s(value: bool) -> bool

      Sets flag that defines if MMFF94s variation of parameters should be used.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEMMFFSheffield, MMFFSheffield

.. _OEFF_OEMMFFSheffield:

.. oe:class:: OEMMFFSheffield

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFFSheffield : public OEMolPotential::OEGenericFF2

   The :ref:`OEMMFFSheffield <OEFF_OEMMFFSheffield>` is a hybrid force field that combines the
   :ref:`OEMMFF <OEMolMMFF_OEMMFF>` with the :ref:`OESheffield <OESheff_OESheffield>`. This force field
   is designed to be used exactly as that of :ref:`OEMMFF <OEMolMMFF_OEMMFF>` or a variation
   of it, such as a truncated-OEMMFF, OEMMFF without electrostatics, or :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
   with :ref:`OESheffield <OESheff_OESheffield>`.

   .. _figure_OEMMFFSheffield_Hierarchy:

   .. figure:: oefftk/images/OEMMFFSheffield.*
      :align:  center

   .. seealso::

     * :ref:`sub-section_MMFF-IEFF` section
     * :ref:`section_mmff` section

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEForceField <OEMolPotential_OEForceField>`:
    * :oe:meth:`PrepMol<OEMolPotential::OEForceField::PrepMol>`
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`

   The following methods are publicly inherited from :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF2::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF2::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF2::RemoveMolFunc>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFSheffield(const OEMMFFSheffieldOptions& argOpts = OEMMFFSheffieldOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFSheffield(argOpts: OEMMFFSheffieldOptions = OEMMFFSheffieldOptions()) -> OEMMFFSheffield
            OEMMFFSheffield(arg2: OEMMFFSheffield) -> OEMMFFSheffield

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFSheffield(const OEMMFFSheffieldOptions& argOpts = OEMMFFSheffieldOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFSheffield(argOpts: OEMMFFSheffieldOptions = OEMMFFSheffieldOptions()) -> OEMMFFSheffield
            OEMMFFSheffield(arg2: OEMMFFSheffield) -> OEMMFFSheffield

      Creates the force field with user specified options.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMMFFSheffield & operator=(const OEMMFFSheffield &)

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEMMFFSheffieldOptions, MMFFSheffieldOptions

.. _OEFF_OEMMFFSheffieldOptions:

.. oe:class:: OEMMFFSheffieldOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFFSheffieldOptions : public OESystem::OEOptions

   This class provides interface to setup options required for :ref:`OEMMFFSheffield <OEFF_OEMMFFSheffield>`
   initialization.
   
   The :ref:`OEMMFFSheffieldOptions <OEFF_OEMMFFSheffieldOptions>` class defines the following public methods:
    * :oe:meth:`GetDielectric<OEFF::OEMMFFSheffieldOptions::GetDielectric>` and
      :oe:meth:`SetDielectric<OEFF::OEMMFFSheffieldOptions::SetDielectric>`
    * :oe:meth:`GetExponent<OEFF::OEMMFFSheffieldOptions::GetExponent>` and
      :oe:meth:`SetExponent<OEFF::OEMMFFSheffieldOptions::SetExponent>`
    * :oe:meth:`GetForceFieldType<OEFF::OEMMFFSheffieldOptions::GetForceFieldType>` and
      :oe:meth:`SetForceFieldType<OEFF::OEMMFFSheffieldOptions::SetForceFieldType>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFSheffieldOptions()
            OEMMFFSheffieldOptions(const OEMMFFSheffieldOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFSheffieldOptions() -> OEMMFFSheffieldOptions
            OEMMFFSheffieldOptions(arg2: OEMMFFSheffieldOptions) -> OEMMFFSheffieldOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMMFFSheffieldOptions &operator=(const OEMMFFSheffieldOptions &)

      Assignment operator.

   .. oe:method:: GetDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetDielectric() -> float

      See :oe:meth:`SetDielectric<OEFF::OEMMFFSheffieldOptions::SetDielectric>` method.

   .. oe:method:: GetExponent

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetExponent() const

      .. oe:language:: python

         .. oe:api:: python

            GetExponent() -> float

      See :oe:meth:`SetExponent<OEFF::OEMMFFSheffieldOptions::SetExponent>` method.

   .. oe:method:: GetForceFieldType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceFieldType() -> int

      See :oe:meth:`SetForceFieldType<OEFF::OEMMFFSheffieldOptions::SetForceFieldType>` method.

   .. oe:method:: SetDielectric

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDielectric(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetDielectric(value: float) -> bool

      The **Dielectric** defines the solvent dielectric constant to be used for
      coulombic interactions with :ref:`OEMMFF <OEMolMMFF_OEMMFF>`.
      **Default: 1.0.**

   .. oe:method:: SetExponent

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetExponent(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetExponent(value: float) -> bool

      The **Exponent** defines the coulombic exponent term to be used for
      coulombic interactions with :ref:`OEMMFF <OEMolMMFF_OEMMFF>`.
      **Default: 1.0.**

   .. oe:method:: SetForceFieldType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceFieldType(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetForceFieldType(value: int) -> bool

      The **ForceFieldType** defines the variation of forcefield to be used. Options 
      are defined in the :oe:constns:`OEFF::OEMMFFSheffieldFFType` namespace.
      **Default:** :oe:const:`OEFF::OEMMFFSheffieldFFType::MMFF94Smod_NOESTAT`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OEMMFFIEFF, MMFFIEFF

.. _OEFF_OEMMFFIEFF:

.. oe:class:: OEMMFFIEFF

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFFIEFF : public OEMolPotential::OEGenericFF

   The :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>` class facilitates creation of an instance of a MMFFIEFF
   force field. The MMFFIEFF hybrid force field uses MMFF for intramolecular interactions and
   Amber for intermolecular interactions. In addition, a force field instance can be extended by 
   adding externally defined potential functions.

   .. _figure_OEMMFFIEFF_Hierarchy:

   .. figure:: oefftk/images/OEMMFFIEFF.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEForceField <OEMolPotential_OEForceField>`:
    * :oe:meth:`PrepMol<OEMolPotential::OEForceField::PrepMol>` 
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`

   The following methods are publicly inherited from :ref:`OEGenericFF <OEMolPotential_OEGenericFF>`:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF::RemoveMolFunc>`

   .. oe:method:: Constructors

      .. oe:api::

         OEMMFFIEFF(const OEChem::OEMolBase& host)
         OEMMFFIEFF(const OEChem::OEMolBase& host,
                    const OEMMFFIEFFOptions& options)

      Default and copy constructors.

   The first constructor creates the force field with default options. The second constructor 
   creates the force field with user specified options. The host refers to the host molecule for the interactions.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMMFFIEFF & operator=(const OEMMFFIEFF &)

      Assignment operator.

   



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEFF

.. meta::
   :keywords: OESmirnoffComplex, SmirnoffComplex

.. _OEFF_OESmirnoffComplex:

.. oe:class:: OESmirnoffComplex

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESmirnoffComplex : public OEComplexFF

   The :ref:`OESmirnoffComplex <OEFF_OESmirnoffComplex>` provides a predefined interface to use
   :ref:`OESmirnoff <OEMolSmirnoff_OESmirnoff>` for all interactions in a protein-ligand complex.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEComplexFF <OEFF_OEComplexFF>`:
    * :oe:meth:`AdaptHostCoords<OEFF::OEComplexFF::AdaptHostCoords>`
    * :oe:meth:`GetVar<OEFF::OEComplexFF::GetVar>`
    * :oe:meth:`Set<OEFF::OEComplexFF::Set>`
    * :oe:meth:`SetHostFlex<OEFF::OEComplexFF::SetHostFlex>`
    * :oe:meth:`SetNonBondCutoff<OEFF::OEComplexFF::SetNonBondCutoff>`
    * :oe:meth:`SetupHost<OEFF::OEComplexFF::SetupHost>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESmirnoffComplex(const OEMolSmirnoff::OESmirnoffParams& params = OEMolSmirnoff::OESmirnoffParams(),
                              const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OESmirnoffComplex(const OESmirnoffComplex&)

      .. oe:language:: python

         .. oe:api:: python

            OESmirnoffComplex(params: OESmirnoffParams = OEMolSmirnoff_OESmirnoffParams(),
                              opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OESmirnoffComplex
            OESmirnoffComplex(arg2: OESmirnoffComplex) -> OESmirnoffComplex

      Default and copy constructors.



.. oe:namespace:: OEFF

..  _OEFF_OELigandFFType:

.. oe:constnamespace:: OELigandFFType

   This namespace contains constants that define force fields type
   appropriate for working with ligands.

..  _OEFF_OELigandFFType_MMFF94:

   .. oe:constant:: MMFF94
   
      The Merck Molecular Force Field (MMFF). Name: mmff94

..  _OEFF_OELigandFFType_MMFF94S:

   .. oe:constant:: MMFF94S
   
      The 94s variation of the Merck Molecular Force Field (MMFF). Name: mmff94s

..  _OEFF_OELigandFFType_PARSLEY:

   .. oe:constant:: PARSLEY

      The latest version (1.3.1) of the Parsley series of force field from the OPENFF consortium. Name: parsley

..  _OEFF_OELigandFFType_SAGE:

   .. oe:constant:: SAGE

      The latest version (2.0.0) of the Sage series of force field from the OPENFF consortium. Name: sage


.. oe:namespace:: OEFF

..  _OEFF_OEMMFFSheffieldFFType:

.. oe:constnamespace:: OEMMFFSheffieldFFType

   This namespace contains constants that are used with
   :ref:`OEMMFFSheffieldOptions <OEFF_OEMMFFSheffieldOptions>` to define a specific
   :ref:`OEMMFFSheffield <OEFF_OEMMFFSheffield>` forcefield.

   ..  _OEFF_OEMMFFSheffieldFFType_MMFF:

   .. oe:constant:: MMFF
   
      The Merck Molecular Force Field (MMFF). Name: mmff

   ..  _OEFF_OEMMFFSheffieldFFType_MMFF_NOESTAT:

   .. oe:constant:: MMFF_NOESTAT

      The MMFF forcefield without electrostatics. Name: mmff_NoEstat

   ..  _OEFF_OEMMFFSheffieldFFType_MMFF_TRUNC:

   .. oe:constant:: MMFF_TRUNC

      The MMFF forcefield truncated at potential minimum. Name: mmff_Trunc

   ..  _OEFF_OEMMFFSheffieldFFType_MMFF_SHEFF:

   .. oe:constant:: MMFF_SHEFF

      The MMFF forcefield with Sheffield solvation. Name: mmff_Sheff

   ..  _OEFF_OEMMFFSheffieldFFType_MMFF94S:

   .. oe:constant:: MMFF94S
   
      The 94s variation of the Merck Molecular Force Field (MMFF). Name: mmff94s

   ..  _OEFF_OEMMFFSheffieldFFType_MMFF94S_NOESTAT:

   .. oe:constant:: MMFF94S_NOESTAT

      The MMFF94S forcefield without electrostatics. Name: mmff94s_NoEstat

   ..  _OEFF_OEMMFFSheffieldFFType_MMFF94S_TRUNC:

   .. oe:constant:: MMFF94S_TRUNC

      The MMFF94S forcefield truncated at potential minimum. Name: mmff94s_Trunc

   ..  _OEFF_OEMMFFSheffieldFFType_MMFF94S_SHEFF:

   .. oe:constant:: MMFF94S_SHEFF

      The MMFF94S forcefield with Sheffield solvation. Name: mmff94s_Sheff

   ..  _OEFF_OEMMFFSheffieldFFType_MMFF94Smod:

   .. oe:constant:: MMFF94Smod
   
      The modified 94s variation of the Merck Molecular Force Field (MMFF). Name: mmff94smod

   ..  _OEFF_OEMMFFSheffieldFFType_MMFF94Smod_NOESTAT:

   .. oe:constant:: MMFF94Smod_NOESTAT

      The modified MMFF94S forcefield without electrostatics. Name: mmff94smod_NoEstat

   ..  _OEFF_OEMMFFSheffieldFFType_MMFF94Smod_TRUNC:

   .. oe:constant:: MMFF94Smod_TRUNC

      The modified MMFF94S forcefield truncated at potential minimum. Name: mmff94smod_Trunc

   ..  _OEFF_OEMMFFSheffieldFFType_MMFF94Smod_SHEFF:

   .. oe:constant:: MMFF94Smod_SHEFF

      The modified MMFF94S forcefield with Sheffield solvation. Name: mmff94smod_Sheff

   ..  _OEFF_OEMMFFSheffieldFFType_Invalid:

   .. oe:constant:: Invalid
   
      Invalid force field type.



*******************************************************************************
OEFF Constants
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OELigandFFType
   OEMMFFSheffieldFFType


.. oe:namespace:: OEFF

.. meta::
   :keywords: OEClearForceFieldDummyAtom

.. oe:function:: OEClearForceFieldDummyAtom

   .. oe:api::

      void OEClearForceFieldDummyAtom(OEChem::OEAtomBase* atom)

   Clear any force field dummy atom information
   associated with the specified atom by
   :oe:func:`OEFF::OESetForceFieldDummyAtom`.

   .. seealso::

      * :oe:func:`OEFF::OESetForceFieldDummyAtom` function
      * :oe:func:`OEFF::OEIsForceFieldDummyAtom` function
      * :oe:func:`OEFF::OEClearForceFieldDummyAtoms` function

   .. note::

      This function is defined in the **OEChem TK**, but in the OEFF main namespace.


.. oe:namespace:: OEFF

.. meta::
   :keywords: OEClearForceFieldDummyAtoms

.. oe:function:: OEClearForceFieldDummyAtoms

   .. oe:api::

      void OEClearForceFieldDummyAtoms(OEChem::OEMolBase& mol)

   Clear any force field dummy atom information for all atoms
   in the molecule.

   .. seealso::

      * :oe:func:`OEFF::OESetForceFieldDummyAtom` function
      * :oe:func:`OEFF::OEIsForceFieldDummyAtom` function
      * :oe:func:`OEFF::OEClearForceFieldDummyAtom` function

   .. note::

      This function is defined in the **OEChem TK**, but in the OEFF main namespace.


.. oe:namespace:: OEFF

.. meta::
   :keywords: OEFFGetArch

.. oe:function:: OEFFGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEFFGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OEFFGetArch() -> str

   Returns the internal build string used by OpenEye, Cadence Molecular Sciences
   to identify the hardware architecture.  The format of these strings may
   change over time.


.. oe:namespace:: OEFF

.. meta::
   :keywords: OEFFGetLicensee

.. oe:function:: OEFFGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFFGetLicensee()
         bool OEFFGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OEFFGetLicensee() -> str
         OEFFGetLicensee(licensee: str) -> bool

   Returns the licensee name from the license file.


.. oe:namespace:: OEFF

.. meta::
   :keywords: OEFFGetPlatform

.. oe:function:: OEFFGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEFFGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OEFFGetPlatform() -> str

   Returns the internal build string used by OpenEye, Cadence Molecular Sciences
   to identify a platform.  The format of these strings may change over
   time, and future distributions may contain different values even when
   using the same operating system, compiler and processor.  For example,
   on a ``x86_64`` Red Hat Enterprise Linux box this would return
   ``redhat-RHEL7-g++4.1-x64``.


.. oe:namespace:: OEFF

.. meta::
   :keywords: OEFFGetRelease

.. oe:function:: OEFFGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OEFFGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OEFFGetRelease() -> str

   Returns the release name of the *OEFF* library being used.  This
   returns a value similar to ``2.0.0`` for production versions of the
   library, and ``2.0.0 debug`` for the checking version of the library.


.. oe:namespace:: OEFF

.. meta::
   :keywords: OEFFGetSite

.. oe:function:: OEFFGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEFFGetSite()
         bool OEFFGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OEFFGetSite() -> str
         OEFFGetSite(site: str) -> bool

   Returns the physical site location of the licensee as registered in the
   license file.


.. oe:namespace:: OEFF

.. meta::
   :keywords: OEFFGetVersion

.. oe:function:: OEFFGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEFFGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OEFFGetVersion() -> int

   Returns the version number of the library being used.  This is an
   unsigned integer value indicating the date on which the library was
   built, for example ``20141001``, for the 1st of October 2014.  This
   value should be used when reporting problems, and unlike the release
   string, may be used in comparisons if needed.


.. oe:namespace:: OEFF

.. meta::
   :keywords: OEFFIsLicensed

.. oe:function:: OEFFIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEFFIsLicensed(const char* feature = 0, unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OEFFIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **OEFF TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **OEFF TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current ***OEFF TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function


.. oe:namespace:: OEFF

.. meta::
   :keywords: OEGetMMFFSheffieldFFName

.. oe:function:: OEGetMMFFSheffieldFFName

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetMMFFSheffieldFFName(const unsigned int)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMMFFSheffieldFFName(argFF: int) -> str

   Get the :ref:`OEMMFFSheffield <OEFF_OEMMFFSheffield>` forcefield name, corresponding
   to the given type ID.  The valid type ID's are defined in the 
   :oe:constns:`OEFF::OEMMFFSheffieldFFType` namespace.

   .. seealso::

      * :oe:func:`OEFF::OEGetMMFFSheffieldFFType` function
      * :oe:func:`OEFF::OEIsValidMMFFSheffieldFF` function


.. oe:namespace:: OEFF

.. meta::
   :keywords: OEGetMMFFSheffieldFFType

.. oe:function:: OEGetMMFFSheffieldFFType

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OEGetMMFFSheffieldFFType(const std::string&)

   .. oe:language:: python

      .. oe:api:: python

         OEGetMMFFSheffieldFFType(argFF: str) -> int

   Get the :ref:`OEMMFFSheffield <OEFF_OEMMFFSheffield>` forcefield type ID, as defined
   in the :oe:constns:`OEFF::OEMMFFSheffieldFFType` namespace, corresponding
   to the given string.

   .. seealso::

      * :oe:func:`OEFF::OEGetMMFFSheffieldFFType` function
      * :oe:func:`OEFF::OEIsValidMMFFSheffieldFF` function


.. oe:namespace:: OEFF

.. meta::
   :keywords: OEIsForceFieldDummyAtom

.. oe:function:: OEIsForceFieldDummyAtom

   .. oe:api::

      bool OEIsForceFieldDummyAtom(const OEChem::OEAtomBase* atom)

   Returns whether :oe:func:`OEFF::OESetForceFieldDummyAtom`
   has been used on the atom to indicate it can be used as
   a force field dummy atom. The atom's atomic number does
   *not* have to be :oe:const:`OEChem::OEElemNo::Du` for the function
   to return ``true``.

   .. seealso::

      * :oe:func:`OEFF::OESetForceFieldDummyAtom` function
      * :oe:func:`OEFF::OEClearForceFieldDummyAtom` function
      * :oe:func:`OEFF::OEClearForceFieldDummyAtoms` function

   .. note::

      This function is defined in the **OEChem TK**, but in the OEFF main namespace.


.. oe:namespace:: OEFF

.. meta::
   :keywords: OEIsValidMMFFSheffieldFF

.. oe:function:: OEIsValidMMFFSheffieldFF

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsValidMMFFSheffieldFF(const std::string&)
         bool OEIsValidMMFFSheffieldFF(const unsigned int)

   .. oe:language:: python

      .. oe:api:: python

         OEIsValidMMFFSheffieldFF(argFF: str) -> bool
         OEIsValidMMFFSheffieldFF(argFF: int) -> bool

   Check if the specified value correspond to a valid :ref:`OEMMFFSheffield <OEFF_OEMMFFSheffield>` forcefield.

   .. seealso::

      * :oe:func:`OEFF::OEGetMMFFSheffieldFFName` function
      * :oe:func:`OEFF::OEGetMMFFSheffieldFFType` function


.. oe:namespace:: OEFF

.. meta::
   :keywords: OESetForceFieldDummyAtom

.. oe:function:: OESetForceFieldDummyAtom

   .. oe:api::

      void OESetForceFieldDummyAtom(OEChem::OEAtomBase* atom)

   Modify information associated with an atom to indicate that
   if the atom has atomic number :oe:const:`OEChem::OEElemNo::Du`
   it can be used for certain force field calculations
   where it would not normally be valid.

   .. note::

      Currently, only **MMFF** and **Amber** support support dummy atoms
      at all, and even then *only* for calculations involving non-bonded terms
      and when this special indication has been set.

   .. seealso::

      * :oe:func:`OEFF::OEIsForceFieldDummyAtom` function
      * :oe:func:`OEFF::OEClearForceFieldDummyAtom` function
      * :oe:func:`OEFF::OEClearForceFieldDummyAtoms` function

   .. note::

      This function is defined in the **OEChem TK**, but in the OEFF main namespace.


*******************************************************************************
OEFF Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEClearForceFieldDummyAtom.rst
   OEClearForceFieldDummyAtoms.rst
   OEGetMMFFSheffieldFFName.rst
   OEGetMMFFSheffieldFFType.rst
   OEIsForceFieldDummyAtom.rst
   OEIsValidMMFFSheffieldFF.rst
   OESetForceFieldDummyAtom.rst
   OEFFGetArch.rst
   OEFFGetLicensee.rst
   OEFFGetPlatform.rst
   OEFFGetRelease.rst
   OEFFGetSite.rst
   OEFFGetVersion.rst
   OEFFIsLicensed.rst


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolMMFF

.. meta::
   :keywords: OEMMFF, MMFF

.. _OEMolMMFF_OEMMFF:

.. oe:class:: OEMMFF

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFF : public OEMolPotential::OEGenericFF2

   The :ref:`OEMMFF <OEMolMMFF_OEMMFF>` class facilitates creation of an instance of a partial or
   full MMFF94 or MMFF94s force field. In addition, a force field instance can be extended by 
   adding externally defined potential functions.

   .. _figure_OEMMFF_Hierarchy:

   .. figure:: oefftk/images/OEMMFF.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEForceField <OEMolPotential_OEForceField>`:
    * :oe:meth:`GetTitle<OEMolPotential::OEForceField::GetTitle>` and
      :oe:meth:`SetTitle<OEMolPotential::OEForceField::SetTitle>`
    * :oe:meth:`HasCoulomb<OEMolPotential::OEForceField::HasCoulomb>`
    * :oe:meth:`HasInternalCharges<OEMolPotential::OEForceField::HasInternalCharges>`
    * :oe:meth:`PrepMol<OEMolPotential::OEForceField::PrepMol>`
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`
    * :oe:meth:`SetNonBondCutoff<OEMolPotential::OEForceField::SetNonBondCutoff>`

   The following methods are publicly inherited from :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF2::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF2::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF2::RemoveMolFunc>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFF(const OEMMFFParams& params,
                   const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OEMMFF(const OEMMFF&)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFF(params: OEMMFFParams,
                   opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OEMMFF
            OEMMFF(arg2: OEMMFF) -> OEMMFF
            OEMMFF(mmff94s: bool = False, terms: int) -> OEMMFF

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMMFF& operator=(const OEMMFF&)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolMMFF

.. meta::
   :keywords: OEMMFF94sParams, MMFF94sParams

.. _OEMolMMFF_OEMMFF94sParams:

.. oe:class:: OEMMFF94sParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFF94sParams : public OEMMFFParams

   The :ref:`OEMMFF94sParams <OEMolMMFF_OEMMFF94sParams>` class provides the ability to retrieve
   parameters necessary to perform energy and gradient calculations using the MMFF94s 
   variant of the MMFF94 force field.  
   Most force field terms are identical between MMFF94 and MMFF94s.  The torsion and
   improper-torsion components of the MMFF94s have a different set of parameters which 
   tend to planarize certain types of trigonal nitrogens.
   
   The following methods are publicly inherited from :ref:`OEFFParams <OEMolPotential_OEFFParams>`:
    * :oe:meth:`CreateCopy<OEMolPotential::OEFFParams::CreateCopy>`                             
    * :oe:meth:`GetCoulombParams<OEMolPotential::OEFFParams::GetCoulombParams>`                 
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`                 
    * :oe:meth:`GetEquilibriumAngle<OEMolPotential::OEFFParams::GetEquilibriumAngle>`           
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>`                   
    * :oe:meth:`GetEquilibriumBondLength<OEMolPotential::OEFFParams::GetEquilibriumBondLength>` 
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`                       
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`           
    * :oe:meth:`GetVdwRadius<OEMolPotential::OEFFParams::GetVdwRadius>`
    * :oe:meth:`GetContactDistance<OEMolPotential::OEFFParams::GetContactDistance>`             
    * :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`         
    * :oe:meth:`PrepMol<OEMolPotential::OEFFParams::PrepMol>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`HasVdwParams<OEMolPotential::OEFFParams::HasVdwParams>`
    * :oe:meth:`HasStretchParams<OEMolPotential::OEFFParams::HasStretchParams>`
    * :oe:meth:`HasBendParams<OEMolPotential::OEFFParams::HasBendParams>`
    * :oe:meth:`HasTorsionParams<OEMolPotential::OEFFParams::HasTorsionParams>`
    * :oe:meth:`GetTitle<OEMolPotential::OEFFParams::GetTitle>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFF94sParams()

      .. oe:language:: python

         .. oe:api:: python

            OEMMFF94sParams() -> OEMMFF94sParams
            OEMMFF94sParams(arg2: OEMMFF94sParams) -> OEMMFF94sParams

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMMFF94sParams & operator=(const OEMMFF94sParams &)

      Assignment operator.

   



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolMMFF

.. meta::
   :keywords: OEMMFFOutOfPlane, MMFFOutOfPlane

.. _OEMolMMFF_OEMMFFOutOfPlane:

.. oe:class:: OEMMFFOutOfPlane

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFFOutOfPlane : public OEMolPotential::OEMolFunc2

   The :ref:`OEMMFFOutOfPlane <OEMolMMFF_OEMMFFOutOfPlane>` class defines out-of-plane (improper torsion) interaction function using the functional forms used in MMFF94 force field. The function can be initialized with parameters defined in MMFF94 (:ref:`OEMMFFParams <OEMolMMFF_OEMMFFParams>`) or MMFF94s (:ref:`OEMMFF94sParams <OEMolMMFF_OEMMFF94sParams>`) force field, or a different set of user defined parameters (:ref:`OEFFParams <OEMolPotential_OEFFParams>`) during construction.

   .. _figure_OEMMFFOutOfPlane_Hierarchy:

   .. figure:: oefftk/images/OEMMFFOutOfPlane.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`     
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The :ref:`OEMMFFOutOfPlane <OEMolMMFF_OEMMFFOutOfPlane>` class defines the following public methods:
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFOutOfPlane(const OEMMFFOutOfPlane &)
            OEMMFFOutOfPlane(const OEMolPotential::OEFFParams &)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFOutOfPlane(arg2: OEFFParams) -> OEMMFFOutOfPlane
            OEMMFFOutOfPlane(arg2: OEMMFFOutOfPlane) -> OEMMFFOutOfPlane

      Default and copy constructors.

      Constructs an :ref:`OEMMFFOutOfPlane <OEMolMMFF_OEMMFFOutOfPlane>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMMFFOutOfPlane &operator=(const OEMMFFOutOfPlane &)

      The assignment operator.

      .. _OEMolMMFF_OEMMFFOutOfPlane_Set:

      Assignment operator.

      .. oe:method:: Set

         .. oe:language:: c++ java csharp

            .. oe:api::

               bool Set(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>&,
                        unsigned int flag = OEFuncType::OutOfPlane)

         .. oe:language:: python

            .. oe:api:: python

               Set(pred: OEUnaryAtomPred) -> bool

      This method allows interaction-level control of the out-of-plane term. The predicate passed is used to test all improper-torsions in the molecule. If the predicate returns ``true`` for all four atoms engaged in the improper-torsion interaction, then the interaction is included. Conversely, if the predicate test of any one of the four atoms of the improper-torsion returns ``false`` then the interaction will be excluded from calculation. The :oe:meth:`Set<OEMolMMFF::OEMMFFOutOfPlane::Set>` method must be called before the :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolMMFF

.. meta::
   :keywords: OEMMFFParams, MMFFParams

.. _OEMolMMFF_OEMMFFParams:

.. oe:class:: OEMMFFParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFFParams : public OEMolPotential::OEFFParams

   The :ref:`OEMMFFParams <OEMolMMFF_OEMMFFParams>` class provides the ability to retrieve parameters
   used in the MMFF94 force field.

   The following methods are publicly inherited from :ref:`OEFFParams <OEMolPotential_OEFFParams>`:
    * :oe:meth:`CreateCopy<OEMolPotential::OEFFParams::CreateCopy>`                             
    * :oe:meth:`GetCoulombParams<OEMolPotential::OEFFParams::GetCoulombParams>`                 
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`                 
    * :oe:meth:`GetEquilibriumAngle<OEMolPotential::OEFFParams::GetEquilibriumAngle>`           
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>`                   
    * :oe:meth:`GetEquilibriumBondLength<OEMolPotential::OEFFParams::GetEquilibriumBondLength>` 
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`                       
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`           
    * :oe:meth:`GetVdwRadius<OEMolPotential::OEFFParams::GetVdwRadius>`
    * :oe:meth:`GetContactDistance<OEMolPotential::OEFFParams::GetContactDistance>`             
    * :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`         
    * :oe:meth:`PrepMol<OEMolPotential::OEFFParams::PrepMol>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`HasVdwParams<OEMolPotential::OEFFParams::HasVdwParams>`
    * :oe:meth:`HasStretchParams<OEMolPotential::OEFFParams::HasStretchParams>`
    * :oe:meth:`HasBendParams<OEMolPotential::OEFFParams::HasBendParams>`
    * :oe:meth:`HasTorsionParams<OEMolPotential::OEFFParams::HasTorsionParams>`
    * :oe:meth:`GetTitle<OEMolPotential::OEFFParams::GetTitle>`

   The following classes derive from this class:  
    * :ref:`OEMMFF94sParams <OEMolMMFF_OEMMFF94sParams>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFParams()

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFParams() -> OEMMFFParams
            OEMMFFParams(arg2: OEMMFFParams) -> OEMMFFParams

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMMFFParams & operator=(const OEMMFFParams &)

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolMMFF

.. meta::
   :keywords: OEMMFFStretchBend, MMFFStretchBend

.. _OEMolMMFF_OEMMFFStretchBend:

.. oe:class:: OEMMFFStretchBend

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFFStretchBend : public OEMolPotential::OEMolFunc2

   The :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>` class defines stretch-bend interaction function using the functional forms used in MMFF94 force field. The function can be initialized with parameters defined in MMFF94 (:ref:`OEMMFFParams <OEMolMMFF_OEMMFFParams>`) or MMFF94s (:ref:`OEMMFF94sParams <OEMolMMFF_OEMMFF94sParams>`) force field, or a different set of user defined parameters (:ref:`OEFFParams <OEMolPotential_OEFFParams>`) during construction.

   .. _figure_OEMMFFStretchBend_Hierarchy:

   .. figure:: oefftk/images/OEMMFFStretchBend.*
      :align:  center
                         
   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`     
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>` class defines the following public methods:
    * :oe:meth:`Set<OEMolMMFF::OEMMFFStretchBend::Set>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMMFFStretchBend(const OEMMFFStretchBend &)
            OEMMFFStretchBend(const OEMolPotential::OEFFParams &)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFStretchBend(arg2: OEFFParams) -> OEMMFFStretchBend
            OEMMFFStretchBend(arg2: OEMMFFStretchBend) -> OEMMFFStretchBend

      Default and copy constructors.

      Constructs an :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMMFFStretchBend &operator=(const OEMMFFStretchBend &)

      The assignment operator. 

      Assignment operator.

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEBinaryPredicate<OEChem::OEBondBase, OEChem::OEBondBase>&,
                  unsigned int flag = OEFuncType::StretchBend)

      This method defines the set of stretch-bending interactions that should not be included during the :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`. :oe:meth:`Set<OEMolMMFF::OEMMFFStretchBend::Set>` must be called before the :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.



.. _OEMolMMFFClasses:

*******************
OEMolMMFF Classes
*******************

.. oe:namespace:: OEMolMMFF

.. toctree::

   OEMMFF
   OEMMFF94sParams
   OEMMFFOutOfPlane
   OEMMFFParams
   OEMMFFStretchBend


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolMMFF

.. meta::
   :keywords: OEIsValidMMFFMolecule

.. _OEMolMMFF_OEIsValidMMFFMolecule:

.. oe:function:: OEIsValidMMFFMolecule

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsValidMMFFMolecule(const OEChem::OEMolBase& mol,
                                    const OEMMFFParams& param = OEMMFF94sParams(),
                                    const bool ignoreCharges = false)

   .. oe:language:: python

      .. oe:api:: python

         OEIsValidMMFFMolecule(mol: Union[OEGraphMol,OEMol,OEQMol],
                               param: OEMMFFParams = OEMolMMFF_OEMMFF94sParams(),
                               ignoreCharges: bool = False) -> bool

   This free function checks if MMFF parameters are available for the specified molecule.
   If the optional argument ``param`` is provided, check is performed against that specific
   :ref:`OEMMFFParams<OEMolMMFF_OEMMFFParams>`, otherwise the :ref:`OEMMFF94sParams<OEMolMMFF_OEMMFF94sParams>`
   is used by default.  The second optional parameter ``ignoreCharges`` allows to ignore MMFF charge
   assigment while check is performed.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolMMFF

.. meta::
   :keywords: OEMMFFCalcVdw

.. oe:function:: OEMMFFCalcVdw

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         double OEMMFFCalcVdw(const OEChem::OEMolBase& mol,
                              const OEChem::OEAtomBase* patom,
                              const OEChem::OEAtomBase* latom,
                              bool coloumb = false, bool attract = false)

   .. oe:language:: python

      .. oe:api:: python

         OEMMFFCalcVdw(mol: Union[OEGraphMol,OEMol,OEQMol], patom: OEAtomBase,
                       latom: OEAtomBase, coloumb: bool = False,
                       attract: bool = False) -> float

   This free function calculates the VdW/Coulomb interaction energy between
   a pair of atoms passed to the function as the second and third arguments,
   belonging to a molecule ``mol``. Coulomb term is added to the result only
   when the fourth argument to the function is set ``true``. A regular (not
   modified) MMFF VdW potential is used when the value of the last argument
   is set to ``true``.


*******************************************************************************
OEMolMMFF Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEIsValidMMFFMolecule.rst
   OEMMFFCalcVdw.rst


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. _OEMolPotential_OEBendParams:

.. oe:class:: OEBendParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class  OEBendParams : public OEMolPotential::OEInteractParams

   The :ref:`OEBendParams <OEMolPotential_OEBendParams>` class defines generic angle-bend parameters
   used in any force field which has bond angle term.

   The following methods are publicly inherited from :ref:`OEInteractParams <OEMolPotential_OEInteractParams>`:
    * :oe:meth:`Clear<OEMolPotential::OEInteractParams::Clear>`
    * :oe:meth:`Get<OEMolPotential::OEInteractParams::Get>`
    * :oe:meth:`Set<OEMolPotential::OEInteractParams::Set>`

   The :ref:`OEBendParams <OEMolPotential_OEBendParams>` class defines the following public methods:
    * :oe:meth:`GetAtomIndex1<OEMolPotential::OEBendParams::GetAtomIndex1>`
    * :oe:meth:`GetAtomIndex2<OEMolPotential::OEBendParams::GetAtomIndex2>`
    * :oe:meth:`GetAtomIndex3<OEMolPotential::OEBendParams::GetAtomIndex3>`
    * :oe:meth:`IsValid<OEMolPotential::OEBendParams::IsValid>`
    * :oe:meth:`IsAngle<OEMolPotential::OEBendParams::IsAngle>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBendParams(const OEChem::OEBondBase* bond1,
                         const OEChem::OEBondBase* bond2,
                         const unsigned type = OEFormatType::AMBER)
            OEBendParams(const OEBendParams&)

      .. oe:language:: python

         .. oe:api:: python

            OEBendParams(bond1: OEBondBase, bond2: OEBondBase, type: int) -> OEBendParams
            OEBendParams(arg2: OEBendParams) -> OEBendParams

      Constructor and copy constructor.
      Constructs an :ref:`OEBendParams <OEMolPotential_OEBendParams>` object for two bonds which
      make the bond angle. 

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBendParams& operator=(const OEBendParams&)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetAtomIndex1

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex1() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex1() -> int

      Returns atom index of the first atom for bond angle for which the instance of
      :ref:`OEBendParams <OEMolPotential_OEBendParams>` was created.

   .. oe:method:: GetAtomIndex2

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex2() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex2() -> int

      Returns atom index of the second atom for bond angle for which the instance of
      :ref:`OEBendParams <OEMolPotential_OEBendParams>` was created.

   .. oe:method:: GetAtomIndex3

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex3() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex3() -> int

      Returns atom index of the third atom for bond angle for which the instance of
      :ref:`OEBendParams <OEMolPotential_OEBendParams>` was created.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const
            bool IsValid(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred) const
            bool IsValid(const OESystem::OEBinaryPredicate<OEChem::OEBondBase, OEChem::OEBondBase>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool
            IsValid(pred: OEUnaryAtomPred) -> bool
            IsValid(pred: OEBinaryBondPred) -> bool

      Methods which check if an instance of the :ref:`OEBendParams <OEMolPotential_OEBendParams>`
      class was created for the bond angle to be included in force field calculation.
      First method is checking if the above instance was correctly constructed, while
      two remaining methods provide predicates to test if atoms (second method) and
      two bonds which define bond angle belong to that instance.

   .. oe:method:: IsAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsAngle(const OEChem::OEAtomBase* atom1,
                         const OEChem::OEAtomBase* atom2,
                         const OEChem::OEAtomBase* atom3) const

      .. oe:language:: python

         .. oe:api:: python

            IsAngle(atom1: OEAtomBase, atom2: OEAtomBase, atom3: OEAtomBase) -> bool

      Used to check if 3 atom passed as an arguments belong to the current 
      :ref:`OEBendParams <OEMolPotential_OEBendParams>` instance.
       

 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEBendPotential, OEMolFunc2

.. _OEMolPotential_OEBendPotential:

.. oe:class:: OEBendPotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEBendPotential : public virtual OEMolPotential::OEFFPotential

   The :ref:`OEBendPotential <OEMolPotential_OEBendPotential>` defines an interface
   all angle bending force field interaction potentials.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`
    
   The :ref:`OEBendPotential <OEMolPotential_OEBendPotential>` implements the following methods:
    * :oe:meth:`Set<OEMolPotential::OEBendPotential::Set>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBendPotential(const OEFFParams&)
            OEBendPotential(const OEBendPotential&)

      .. oe:language:: python

         .. oe:api:: python

            OEBendPotential(fp: OEFFParams) -> OEBendPotential
            OEBendPotential(arg2: OEBendPotential) -> OEBendPotential

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OEBendPotential& operator=(const OEBendPotential&)

     Assignment operator.

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEBinaryPredicate<OEChem::OEBondBase, OEChem::OEBondBase>&,
                  unsigned int flag = OEFuncType::Bend) override

      This method allows interaction-level control of the angle-bend term. The predicate passed is used 
      to test the molecule’s bond angles. Only those bond angles which are reported as ``true`` are included 
      in the list of interactions to be calculated.  The :oe:meth:`Set<OEMolPotential::OEBendPotential::Set>` method must 
      be called before the :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OECoulombPotential, OEMolFunc2

.. _OEMolPotential_OECoulombPotential:

.. oe:class:: OECoulombPotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OECoulombPotential : public virtual OENonBondPotBase

   The :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>` class defines an interface
   for calculation of intra-molecular Coulomb force field 
   interaction potentials.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`
    
   The following methods are publicly inherited from :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`:
    * :oe:meth:`GetNonBondOptions<OEMolPotential::OENonBondPotBase::GetNonBondOptions>`
    * :oe:meth:`Set<OEMolPotential::OENonBondPotBase::Set>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECoulombPotential(const OEMolPotential::OEFFParams& fp,
                               const double rcut = 0.0);
            OECoulombPotential(const OECoulombPotential&)

      .. oe:language:: python

         .. oe:api:: python

            OECoulombPotential(fp: OEFFParams, rcut: float = 0.0) -> OECoulombPotential
            OECoulombPotential(arg2: OECoulombPotential) -> OECoulombPotential

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OECoulombPotential& operator=(const OECoulombPotential&)

     Assignment operator.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEFFParams, FFParams

.. _OEMolPotential_OEFFParams:

.. oe:class:: OEFFParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFFParams

   The :ref:`OEFFParams <OEMolPotential_OEFFParams>` is an abstract base class.  This class defines the interface
   to retrieve parameters defined by a force field. In addition, simple methods are included for facile
   extraction of idealized geometric information base on the force field.

   The :ref:`OEFFParams <OEMolPotential_OEFFParams>` class defines the following public methods:
    * :oe:meth:`CreateCopy<OEMolPotential::OEFFParams::CreateCopy>`
    * :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`
    * :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>`
    * :oe:meth:`GetContactDistance<OEMolPotential::OEFFParams::GetContactDistance>`
    * :oe:meth:`GetCoulombParams<OEMolPotential::OEFFParams::GetCoulombParams>`
    * :oe:meth:`GetEquilibriumAngle<OEMolPotential::OEFFParams::GetEquilibriumAngle>`
    * :oe:meth:`GetEquilibriumBondLength<OEMolPotential::OEFFParams::GetEquilibriumBondLength>`
    * :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`
    * :oe:meth:`GetVdwRadius<OEMolPotential::OEFFParams::GetVdwRadius>`
    * :oe:meth:`PrepMol<OEMolPotential::OEFFParams::PrepMol>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`HasVdwParams<OEMolPotential::OEFFParams::HasVdwParams>`
    * :oe:meth:`HasStretchParams<OEMolPotential::OEFFParams::HasStretchParams>`
    * :oe:meth:`HasBendParams<OEMolPotential::OEFFParams::HasBendParams>`
    * :oe:meth:`HasTorsionParams<OEMolPotential::OEFFParams::HasTorsionParams>`
    * :oe:meth:`GetTitle<OEMolPotential::OEFFParams::GetTitle>`

   The following classes derive from this class:
    * :ref:`OEMMFF94sParams <OEMolMMFF_OEMMFF94sParams>`
    * :ref:`OEMMFFParams <OEMolMMFF_OEMMFFParams>`
    * :ref:`OESmirnoffParams <OEMolSmirnoff_OESmirnoffParams>`

   .. oe:method:: Constructors

      .. oe:api::

         OEFFParams()
         OEFFParams(const OEFFParams&)

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OEFFParams& operator=(const OEFFParams&)

     Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFFParams* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEFFParams

      This method returns a deep copy of the :ref:`OEFFParams <OEMolPotential_OEFFParams>` derived
      object. The copy of the object returned is in memory owned by the user making the function call.
      The delete operator must be called for the returned pointer when the copy is no longer needed
      in order to avoid memory leaks.

   .. _OEMolPotential_GetAtomTypeIndex:

   .. oe:method:: GetAtomTypeIndex

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetAtomTypeIndex(unsigned int) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomTypeIndex(arg2: int) -> int

      Provides interface to get an atom type index for the atom identified by the force field type passed
      as an argument. The point is that a number of chemically different atom types in the force field
      can belong to a single type for which force field parameters are defined.

   .. _OEMolPotential_GetAtomTypeName:

   .. oe:method:: GetAtomTypeName

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetAtomTypeName(unsigned int) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomTypeName(arg2: int) -> str

      Provides interface to convert the integer force field atom type into a symbolic type.

   .. _OEMolPotential_GetContactDistance:

   .. oe:method:: GetContactDistance

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetContactDistance(double &, const OEChem::OEAtomBase *,
                                    const OEChem::OEAtomBase *) const

      .. oe:language:: python

         .. oe:api:: python

            GetContactDistance(arg2: float, arg3: OEAtomBase, arg4: OEAtomBase) -> bool

      Provides the interface for retrieving the distance between two atoms corresponding to the minimum
      on their VdW potential curve. The double precision floating point reference passed as the first
      argument to the method is assigned to the contact distance for the two atoms if it is defined by
      the force field. The method returns ``true`` only if a valid force field parameter for the
      interaction exists. :oe:meth:`OEMolPotential::OEFFParams::PrepMol` must be called for the molecule
      prior to using this method.

   .. _OEMolPotential_GetCoulombParams:

   .. oe:method:: GetCoulombParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCoulombParams(OEInteractParams &,
                                  const OEChem::OEAtomBase *,
                                  const OEChem::OEAtomBase *) const

      .. oe:language:: python

         .. oe:api:: python

            GetCoulombParams(arg2: OEInteractParams, arg3: OEAtomBase,
                             arg4: OEAtomBase) -> bool

      Defines the interface for retrieving the parameters used in calculating an electrostatic
      interaction for two atoms. Overriding methods return ``true`` only if valid parameters exist
      for the atoms passed as the second and third arguments, otherwise they return ``false``.
      :oe:meth:`OEMolPotential::OEFFParams::PrepMol` must be called for the molecule prior to using
      this method.

   .. _OEMolPotential_GetEquilibriumAngle:

   .. oe:method:: GetEquilibriumAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEquilibriumAngle(double &, const OEChem::OEAtomBase *,
                                     const OEChem::OEAtomBase *,
                                     const OEChem::OEAtomBase *) const

      .. oe:language:: python

         .. oe:api:: python

            GetEquilibriumAngle(arg2: float, arg3: OEAtomBase,
                                arg4: OEAtomBase, arg5: OEAtomBase) -> bool

      This method is used to retrieve the equilibrium bond angle for the three atoms passed to it.
      The second atom passed to the method (``atom2``) must be the central atom of the requested
      bond angle. The double precision floating point reference passed as the first argument to the
      method is assigned to the equilibrium bond angle if it is defined by the force field.
      The method returns ``true`` only if a valid force field parameter for the interaction exists.
      :oe:meth:`OEMolPotential::OEFFParams::PrepMol` must be called for the molecule prior to using
      this method.

   .. _OEMolPotential_GetEquilibriumBondLength:

   .. oe:method:: GetEquilibriumBondLength

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEquilibriumBondLength(double &, const OEChem::OEBondBase *) const

      .. oe:language:: python

         .. oe:api:: python

            GetEquilibriumBondLength(arg2: float, arg3: OEBondBase) -> bool

      This method is used to retrieve the equilibrium bond length for the bond passed as the second
      argument. The double precision floating point reference passed as the first argument to the
      method is assigned to the equilibrium bond length if it is defined by the force field.
      The method returns ``true`` only if a valid force field parameter for the bond exists.
      :oe:meth:`OEMolPotential::OEFFParams::PrepMol` must be called for the molecule prior to using
      this method.

   .. _OEMolPotential_GetStretchBendParams:

   .. oe:method:: GetStretchBendParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStretchBendParams(OEInteractParams &,
                                      const OEChem::OEAtomBase *,
                                      const OEChem::OEAtomBase *,
                                      const OEChem::OEAtomBase *) const

      .. oe:language:: python

         .. oe:api:: python

            GetStretchBendParams(arg2: OEInteractParams, arg3: OEAtomBase,
                                 arg4: OEAtomBase, arg5: OEAtomBase) -> bool

      Defines the interface for retrieving the parameters used in calculating a stretch-bend
      interaction. The central atom of the bond-angle must be passed as the third argument to the
      method. Overriding methods return ``true`` only if valid parameters exist for the atoms passed
      as arguments, otherwise they should return ``false``.
      :oe:meth:`OEMolPotential::OEFFParams::PrepMol` must be called for the molecule prior to using this
      method.

   .. _OEMolPotential_GetVdwRadius:

   .. oe:method:: GetVdwRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetVdwRadius(double &, const OEChem::OEAtomBase* atm) const

      .. oe:language:: python

         .. oe:api:: python

            GetVdwRadius(arg2: float, atm: OEAtomBase) -> bool

      Defines the interface for retrieving the VdW radius for an atom. Overriding methods return
      ``true`` only if a VdW radius can be calculated or retrieved for an atom, ``false``
      otherwise. :oe:meth:`OEMolPotential::OEFFParams::PrepMol` must be called for the molecule prior
      to using this method.

   .. _OEMolPotential_PrepMol:

   .. oe:method:: PrepMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool PrepMol(OEChem::OEMolBase& mol, bool sweep = true,
                         bool closestTypeAllowed = true) const

      .. oe:language:: python

         .. oe:api:: python

            PrepMol(mol: Union[OEGraphMol,OEMol,OEQMol], sweep: bool = True,
                    warnOK: bool = True) -> bool

      Defines the interface for preparing a molecule for force field parameter retrieval.
      Atom types, names, partial charges, and indices stored within the molecule may be
      modified by overriding methods. The second argument to the method specifies whether a
      call to :oe:meth:`OEChem::OEMolBase::Sweep` is allowed during the preparation.  By default,
      sweeping a molecule is allowed by the method. A return value of ``true`` indicates a successful
      preparation, however, if the method returns ``false`` calculations with the resultant
      modified molecule should not be attempted. The return value of this method should always be
      checked before use with its associated force field and components.

      *closestTypeAllowed*
        If `true` then the MMFF typing method will substitute close atom types if exact atom types
        do not exist.

      .. seealso::

         :oe:func:`OEChem::OEMMFFAtomType` function

   .. _OEMolPotential_GetVdwParams:

   .. oe:method:: GetVdwParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetVdwParams(OEMolPotential::OEInteractParams&,
                              const OEChem::OEAtomBase*,
                              const OEChem::OEAtomBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetVdwParams(arg2: OEInteractParams, arg3: OEAtomBase,
                         arg4: OEAtomBase) -> bool

      Fills the first argument, :ref:`OEInteractParams <OEMolPotential_OEInteractParams>`, with the Vdw parameters for the two non-bonded atoms specified by the second and the third arguments,
      :ref:`OEAtomBase <OEChem_OEAtomBase>`. If parameters were not found, it returns ``false``;
      otherwise, it returns ``true``.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMolPotential::OEVdwParams>*
            OESystem::OEIterBase<OEMolPotential::OEVdwParams>* GetVdwParams(const OEChem::OEMolBase& mol,
                                                                            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* pred = 0,
                                                                            const double rcut = 0.0) const

      .. oe:language:: python

         .. oe:api:: python

            GetVdwParams(mol: Union[OEGraphMol,OEMol,OEQMol],
                         pred: OEUnaryAtomPred = None) -> Iterable[OEVdwParams]

      Takes a molecule object, ``mol``, and returns an iterator to all
      :ref:`OEVdwParams <OEMolPotential_OEVdwParams>` objects created for that molecule. If the pointer
      to atom predicate is passed as the second argument, all atoms engaged in vdw non-bonded
      interactions will be tested against with that predicate. In this case, the returned
      iterator will contain parameters for only those pairs of atoms that pass the test.
      Similarly, all :ref:`OEVdwParams <OEMolPotential_OEVdwParams>` objects for pairs outside the cutoff
      radius, ``rcut``, will be eliminated. An ``rcut`` value of ``0.0`` or less assumes that all interactions 
      should be included without any cutoff.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMolPotential::OEVdwParams>*
            OESystem::OEIterBase<OEMolPotential::OEVdwParams>* GetVdwParams(const OEChem::OEMolBase& mol,
                                                                            const OEChem::OEMolBase& host,
                                                                            const double rcut = 0.0) const

      .. oe:language:: python

         .. oe:api:: python

            GetVdwParams(mol: Union[OEGraphMol,OEMol,OEQMol],
                         host: Union[OEGraphMol,OEMol,OEQMol]) -> Iterable[OEVdwParams]

      Returns an iterator to all :ref:`OEVdwParams <OEMolPotential_OEVdwParams>` objects created for
      host-ligand interactions specified by the ligand molecule, ``mol``, and the host molecule, ``host``.
      All :ref:`OEVdwParams <OEMolPotential_OEVdwParams>` objects for pairs outside the cutoff
      radius, ``rcut``, will be eliminated. An ``rcut`` value of ``0.0`` or less assumes that all interactions 
      should be included without any cutoff.

   .. _OEMolPotential_GetStretchParams:

   .. oe:method:: GetStretchParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStretchParams(OEMolPotential::OEInteractParams&,
                                  const OEChem::OEBondBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetStretchParams(arg2: OEInteractParams, arg3: OEBondBase) -> bool

      Fills the first argument, :ref:`OEInteractParams <OEMolPotential_OEInteractParams>`, with the bond stretch parameters for the bond, :oe:cls:`OEBondBase<OEChem::OEBondBase>`. If the parameters
      were not found, it returns ``false``; otherwise, it returns ``true``.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMolPotential::OEStretchParams>*
            OESystem::OEIterBase<OEMolPotential::OEStretchParams>* GetStretchParams(const OEChem::OEMolBase& mol,
                                                                                    const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* pred = 0) const

      .. oe:language:: python

         .. oe:api:: python

            GetStretchParams(mol: Union[OEGraphMol,OEMol,OEQMol],
                             pred: OEUnaryAtomPred = None) -> Iterable[OEStretchParams]

      Takes a molecule object, ``mol``, and returns an iterator to all
      :ref:`OEStretchParams <OEMolPotential_OEStretchParams>` objects created for that molecule. If the pointer
      to an atom predicate is passed as the second argument, all atoms making bonds will be tested
      against with that predicate. In this case, the returned iterator will contain parameters for
      only those bonds made between the atoms that pass the test.

   .. _OEMolPotential_GetBendParams:

   .. oe:method:: GetBendParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetBendParams(OEMolPotential::OEInteractParams&,
                               const OEChem::OEAtomBase*,
                               const OEChem::OEAtomBase*,
                               const OEChem::OEAtomBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetBendParams(arg2: OEInteractParams, arg3: OEAtomBase,
                          arg4: OEAtomBase, arg5: OEAtomBase) -> bool

      Fills the first argument, :ref:`OEInteractParams <OEMolPotential_OEInteractParams>`, with the bend
      parameters for a bond angle made by 3 atoms, :ref:`OEAtomBase <OEChem_OEAtomBase>`, passed as the second,
      third and the forth arguments. If the parameters were not found, it returns ``false``; otherwise, it returns ``true``.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMolPotential::OEBendParams>*
            OESystem::OEIterBase<OEMolPotential::OEBendParams>* GetBendParams(const OEChem::OEMolBase& mol,
                                                                              const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* pred = 0) const

      .. oe:language:: python

         .. oe:api:: python

            GetBendParams(mol: Union[OEGraphMol,OEMol,OEQMol],
                          pred: OEUnaryAtomPred = None) -> Iterable[OEBendParams]

      Takes a molecule object, ``mol``, and returns an iterator to all
      :ref:`OEBendParams <OEMolPotential_OEBendParams>` objects created for that molecule. If the pointer
      to an atom predicate is passed as the second argument, all atoms making bond angles will be
      tested against that with predicate and the returned iterator will contain parameters for only those
      bond angles whose atom members pass the test.

   .. _OEMolPotential_GetTorsionParams:

   .. oe:method:: GetTorsionParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetTorsionParams(OEMolPotential::OEInteractParams&,
                                  const OEChem::OEAtomBase*,
                                  const OEChem::OEAtomBase*,
                                  const OEChem::OEAtomBase*,
                                  const OEChem::OEAtomBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetTorsionParams(arg2: OEInteractParams, arg3: OEAtomBase,
                             arg4: OEAtomBase, arg5: OEAtomBase,
                             arg6: OEAtomBase) -> bool

      Fills the first argument, :ref:`OEInteractParams <OEMolPotential_OEInteractParams>`, with the
      torsion parameters for a torsion made by 4 atoms, :ref:`OEAtomBase <OEChem_OEAtomBase>`, passed as
      the second, third, forth and the fifth arguments. If the parameters were not found, it
      returns ``false``; otherwise, it returns ``true``.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMolPotential::OETorsionParams>*
            OESystem::OEIterBase<OEMolPotential::OETorsionParams>* GetTorsionParams(const OEChem::OEMolBase& mol,
                                                                                    const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* pred = 0) const

      .. oe:language:: python

         .. oe:api:: python

            GetTorsionParams(mol: Union[OEGraphMol,OEMol,OEQMol],
                             pred: OEUnaryAtomPred = None) -> Iterable[OETorsionParams]

      Takes a molecule object, ``mol``, and returns an iterator to all
      :ref:`OETorsionParams <OEMolPotential_OETorsionParams>` objects created for that molecule. If the pointer
      to an atom predicate is passed as the second argument, all atoms making torsions will be
      tested against with that predicate and the returned iterator will contain parameters for
      only those torsions whose atom members pass the test.

   .. _OEMolPotential_GetOutOfPlaneParams:

   .. oe:method:: GetOutOfPlaneParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetOutOfPlaneParams(OEMolPotential::OEInteractParams&,
                                     const OEChem::OEAtomBase*,
                                     const OEChem::OEAtomBase*,
                                     const OEChem::OEAtomBase*,
                                     const OEChem::OEAtomBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetOutOfPlaneParams(arg2: OEInteractParams, arg3: OEAtomBase,
                                arg4: OEAtomBase, arg5: OEAtomBase,
                                arg6: OEAtomBase) -> bool

      Fills the first argument, :ref:`OEInteractParams <OEMolPotential_OEInteractParams>`, with the
      improper torsion parameters for an improper torsion made by 4 atoms, :ref:`OEAtomBase <OEChem_OEAtomBase>`,
      passed as the second, third, forth and the fifth arguments. If the parameters were not found,
      it returns ``false``; otherwise, it returns ``true``.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEMolPotential::OEOutOfPlaneParams>* GetOutOfPlaneParams(const OEChem::OEMolBase& mol,
                                                                                          const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* pred = 0) const

      .. oe:language:: python

         .. oe:api:: python

            GetOutOfPlaneParams(mol: Union[OEGraphMol,OEMol,OEQMol],
                                pred: OEUnaryAtomPred = None) -> Iterable[OEOutOfPlaneParams]

      Takes a molecule object, ``mol``, and returns an iterator to all
      :ref:`OESmirnoffOutOfPlane <OEMolSmirnoff_OESmirnoffOutOfPlane>` objects created for that molecule. If the pointer
      to an atom predicate is passed as the second argument, all atoms making improper torsions will be
      tested against with that predicate and the returned iterator will contain parameters for only those
      improper torsions whose atom members pass the test.

   .. _OEMolPotential_HasVdwParams:

   .. oe:method:: HasVdwParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasVdwParams(const OEChem::OEMolBase& mol,
                              const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* pred = 0,
                              const double rcut = 0.0) const
            bool HasVdwParams(const OEChem::OEMolBase& mol,
                              const OEChem::OEMolBase& host,
                              const double rcut = 0.0) const

      .. oe:language:: python

         .. oe:api:: python

            HasVdwParams(mol: Union[OEGraphMol,OEMol,OEQMol],
                         pred: OEUnaryAtomPred = None, rcut: float = 0.0) -> bool
            HasVdwParams(mol: Union[OEGraphMol,OEMol,OEQMol],
                         host: Union[OEGraphMol,OEMol,OEQMol],
                         rcut: float = 0.0) -> bool

      Returns if the desired Vdw parameters exist for the specified molecule, ``mol``.
      See the :ref:`GetVdwParams <OEMolpotential_GetVdwParams>` method.

   .. _OEMolPotential_HasStretchParams:

   .. oe:method:: HasStretchParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasStretchParams(const OEChem::OEMolBase& mol,
                                  const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* pred = 0) const

      .. oe:language:: python

         .. oe:api:: python

            HasStretchParams(mol: Union[OEGraphMol,OEMol,OEQMol],
                             pred: OEUnaryAtomPred = None) -> bool

      Returns if the desired bond stretching parameters exist for the specified molecule, ``mol``.
      See the :ref:`GetStretchParams <OEMolPotential_GetStretchParams>` method.

   .. _OEMolPotential_HasBendParams:

   .. oe:method:: HasBendParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasBendParams(const OEChem::OEMolBase& mol,
                               const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* pred = 0) const

      .. oe:language:: python

         .. oe:api:: python

            HasBendParams(mol: Union[OEGraphMol,OEMol,OEQMol],
                          pred: OEUnaryAtomPred = None) -> bool

      Returns if the desired bend parameters exist for the specified molecule, ``mol``.
      See the :ref:`GetBendParams <OEMolPotential_GetBendParams>` method.

   .. _OEMolPotential_HasTorsionParams:

   .. oe:method:: HasTorsionParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasTorsionParams(const OEChem::OEMolBase& mol,
                                  const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* pred = 0) const

      .. oe:language:: python

         .. oe:api:: python

            HasTorsionParams(mol: Union[OEGraphMol,OEMol,OEQMol],
                             pred: OEUnaryAtomPred = None) -> bool

      Returns if the desired torison parameters exist for the specified molecule, ``mol``.
      See the :ref:`GetTorsionParams <OEMolPotential_GetTorsionParams>` method.

   .. _OEMolPotential_GetTitle:

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Returns name of the force field parameter.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEFFPotential, OEMolFunc2

.. _OEMolPotential_OEFFPotential:

.. oe:class:: OEFFPotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFFPotential : public virtual OEMolPotential::OEMolFunc2

   The :ref:`OEFFPotential <OEMolPotential_OEFFPotential>` is an abstract base class.  This class defines a common
   base class for all force field potential function implementations.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The :ref:`OEFFPotential <OEMolPotential_OEFFPotential>` implements the following methods:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`

   The following classes derive from this class:
    * :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`
    * :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`
    * :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>`
    * :ref:`OEBendPotential <OEMolPotential_OEBendPotential>`
    * :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>`
    * :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>`

   .. oe:method:: Constructors

      .. oe:api::

         OEFFPotential(const OEFFParams&)
         OEFFPotential(const OEFFPotential&)

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OEFFPotential& operator=(const OEFFPotential&)

     Assignment operator.

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>&,
                  unsigned flag = OEFuncType::All) override

      This method can be used for interaction-level control of the potential terms. Interactions between
      two atoms are only included if the :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>` test of all the atoms
      returns ``true``. The :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`
      methods must be called before the :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` to be effective.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEForceField, ForceField

.. _OEMolPotential_OEForceField:

.. oe:class:: OEForceField

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEForceField : public OEMolFunc1

   The :ref:`OEForceField <OEMolPotential_OEForceField>` is an abstract base class.  This class defines
   an interface for the collection of force field components. The :ref:`OEForceField <OEMolPotential_OEForceField>`
   extends the :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` class to allow this being a collection of multiple
   components. The collection of components into a force field needs to be done concomitant with one or
   more :ref:`OEFFParams <OEMolPotential_OEFFParams>` derived classes.

   .. _figure_OEForceField_Hierarchy:

   .. figure:: oefftk/images/OEForceField.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The :ref:`OEForceField <OEMolPotential_OEForceField>` class defines the following public methods:
    * :oe:meth:`GetTitle<OEMolPotential::OEForceField::GetTitle>` and
      :oe:meth:`SetTitle<OEMolPotential::OEForceField::SetTitle>`
    * :oe:meth:`HasCoulomb<OEMolPotential::OEForceField::HasCoulomb>`
    * :oe:meth:`HasInternalCharges<OEMolPotential::OEForceField::HasInternalCharges>`
    * :oe:meth:`PrepMol<OEMolPotential::OEForceField::PrepMol>`
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`
    * :oe:meth:`SetNonBondCutoff<OEMolPotential::OEForceField::SetNonBondCutoff>`

   The following classes derive from this class:
    * :ref:`OEGenericFF <OEMolPotential_OEGenericFF>`
    * :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`
    * :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
    * :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEForceField & operator=(const OEForceField &)

      Assignment operator.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      See :oe:meth:`SetTitle<OEMolPotential::OEForceField::SetTitle>`.

   .. _OEMolPotential_OEForceField_HasCoulomb:

   .. oe:method:: HasCoulomb

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasCoulomb() const

      .. oe:language:: python

         .. oe:api:: python

            HasCoulomb() -> bool

      Returns if coulombic interactions are currently turned on.

   .. _OEMolPotential_OEForceField_HasInternalCharges:

   .. oe:method:: HasInternalCharges

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasInternalCharges() const

      .. oe:language:: python

         .. oe:api:: python

            HasInternalCharges() -> bool

      Returns True if associated force field parameters has internal charges.

   .. oe:method:: PrepMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool PrepMol(OEChem::OEMolBase& mol, bool sweep = true,
                         bool warnOK = true) const

      .. oe:language:: python

         .. oe:api:: python

            PrepMol(mol: Union[OEGraphMol,OEMol,OEQMol], sweep: bool = True,
                    warnOK: bool = True) -> bool

      Defines the interface to prepare a molecule to be used for force field setup
      (:oe:meth:`OEMolPotential::OEMolFunc::Setup`). This method internally calls
      for all contained :ref:`OEFFParams <OEMolPotential_OEFFParams>` instances in the
      :ref:`OEForceField <OEMolPotential_OEForceField>` derived class to perform necessary preparation
      to enable using those parameters.

      The second argument to the method specifies
      whether a call to :oe:meth:`OEChem::OEMolBase::Sweep` is allowed during the preparation.
      By default, sweeping a molecule is allowed by the method. Methods that override
      :oe:meth:`OEMolPotential::OEFFParams::PrepMol` may alter the contents of the passed molecule.

      Method returns ``true`` if preparation is successful, and ``false`` otherwise.

      .. seealso::

         * :ref:`section_FFEnergy_example` example

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEBondBase> &pred,
                  unsigned int functype)
         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &pred,
                  unsigned int functype)
         bool Set(const OESystem::OEBinaryPredicate<OEChem::OEAtomBase,OEChem::OEAtomBase> &pred,
                  unsigned int functype)
         bool Set(const OESystem::OEBinaryPredicate<OEChem::OEBondBase,OEChem::OEBondBase> &pred,
                  unsigned int functype)

      These methods assigns interaction-control predicates. The first argument is the predicate type to
      be passed to the interaction component.
      The second argument is a value or a set of binary OR'ed values taken from the :oe:const:`OEMolPotential::OEFuncType`
      namespace which specifies the intended target for the predicate assignment.

      The set method passed on the interaction-control predicates to the appropriate force field components contained. Method returns ``false`` if predicate was not set to any of the components contained by the force field.

      :oe:meth:`Set<OEMolPotential::OEForceField::Set>` must be called before the :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.

   .. oe:method:: SetNonBondCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNonBondCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetNonBondCutoff(arg2: float) -> bool

      Sets the non-bonded interactions cutoff, in angstroms.

   .. oe:method:: SetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTitle(const std::string&)

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(argTitle: str) -> None

      Title for the force field.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEGenericFF, GenericFF

.. _OEMolPotential_OEGenericFF:

.. oe:class:: OEGenericFF

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEGenericFF : public OEMolPotential::OEForceField

   The :ref:`OEGenericFF <OEMolPotential_OEGenericFF>` class facilitates creation of a user defined
   force field. The force field instance can be extended by 
   adding internally or externally defined potential functions.

   .. _figure_OEGenericFF_Hierarchy:

   .. figure:: oefftk/images/OEGenericFF.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEForceField <OEMolPotential_OEForceField>`:
    * :oe:meth:`GetTitle<OEMolPotential::OEForceField::GetTitle>` and
      :oe:meth:`SetTitle<OEMolPotential::OEForceField::SetTitle>`
    * :oe:meth:`HasCoulomb<OEMolPotential::OEForceField::HasCoulomb>`
    * :oe:meth:`HasInternalCharges<OEMolPotential::OEForceField::HasInternalCharges>`
    * :oe:meth:`PrepMol<OEMolPotential::OEForceField::PrepMol>`
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`
    * :oe:meth:`SetNonBondCutoff<OEMolPotential::OEForceField::SetNonBondCutoff>`

   The :ref:`OEGenericFF <OEMolPotential_OEGenericFF>` class defines the following public methods:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF::RemoveMolFunc>`          

   The following classes derive from this class:
    * :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEGenericFF()

      .. oe:language:: python

         .. oe:api:: python

            OEGenericFF() -> OEGenericFF
            OEGenericFF(arg2: OEGenericFF) -> OEGenericFF
            OEGenericFF(arg2: OEGenericFF2) -> OEGenericFF

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEGenericFF & operator=(const OEGenericFF &)

      Assignment operator.

   

   .. oe:method:: AddMolFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddMolFunc(OEMolPotential::OEMolFunc1& f, bool own = false)

      .. oe:language:: python

         .. oe:api:: python

            AddMolFunc(f: OEMolFunc1, own: bool = False) -> bool

      This method defines the interface for adding externally declared functions 
      to an :ref:`OEGenericFF <OEMolPotential_OEGenericFF>` derived instance. The second argument denotes
      whether the :ref:`OEGenericFF <OEMolPotential_OEGenericFF>` derived instance is to take ownership of
      the memory occupied by the external function. If ownership is passed, then it would be 
      deleted during destruction of the :ref:`OEGenericFF <OEMolPotential_OEGenericFF>` derived class. Any object
      derived from the :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` may be added using this method. The method
      returns ``true`` if the object of :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` is successfully added. Only
      one copy of a :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` may be added to an :ref:`OEGenericFF <OEMolPotential_OEGenericFF>`
      instance. Subsequent attempts to add the same function object to already contained in a
      :ref:`OEGenericFF <OEMolPotential_OEGenericFF>` derived class will fail with a return value of ``false``.

   .. oe:method:: GetComponents

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<OEMolPotential::OEMolFunc1*> GetComponents() const

      .. oe:language:: python

         .. oe:api:: python

            GetComponents() -> OEMolFunc1Vector

      Method returns a vector of pointers to the currently contained :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` instances on this :ref:`OEGenericFF <OEMolPotential_OEGenericFF>`.

   .. oe:method:: RemoveMolFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RemoveMolFunc(OEMolPotential::OEMolFunc1&)

      .. oe:language:: python

         .. oe:api:: python

            RemoveMolFunc(f: OEMolFunc1) -> bool

      Defines an interface to remove a function previously added to an :ref:`OEGenericFF <OEMolPotential_OEGenericFF>`
      instance. If the function is not contained in the :ref:`OEGenericFF <OEMolPotential_OEGenericFF>` instance
      then the method will return ``false``. If the function is found and removed successfully, then the 
      method will return ``true``.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEGenericFF2, GenericFF

.. _OEMolPotential_OEGenericFF2:

.. oe:class:: OEGenericFF2

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEGenericFF2 : public OEMolPotential::OEForceField,  public OEMolPotential::OEMolFunc2

   The :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>` class facilitates creation of a user defined
   force field of type :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`. The force field instance can be
   extended by adding internally or externally defined potential functions.

   .. _figure_OEGenericFF2_Hierarchy:

   .. figure:: oefftk/images/OEGenericFF2.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEForceField <OEMolPotential_OEForceField>`:
    * :oe:meth:`GetTitle<OEMolPotential::OEForceField::GetTitle>` and
      :oe:meth:`SetTitle<OEMolPotential::OEForceField::SetTitle>`
    * :oe:meth:`HasCoulomb<OEMolPotential::OEForceField::HasCoulomb>`
    * :oe:meth:`HasInternalCharges<OEMolPotential::OEForceField::HasInternalCharges>`
    * :oe:meth:`PrepMol<OEMolPotential::OEForceField::PrepMol>`
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`
    * :oe:meth:`SetNonBondCutoff<OEMolPotential::OEForceField::SetNonBondCutoff>`

   The :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>` class defines the following public methods:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF2::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF2::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF2::RemoveMolFunc>`          

   The following classes derive from this class:
    * :ref:`OEMMFF <OEMolMMFF_OEMMFF>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEGenericFF2()

      .. oe:language:: python

         .. oe:api:: python

            OEGenericFF2() -> OEGenericFF2
            OEGenericFF2(arg2: OEGenericFF2) -> OEGenericFF2

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEGenericFF2 & operator=(const OEGenericFF2 &)

      Assignment operator.

   

   .. oe:method:: AddMolFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddMolFunc(OEMolPotential::OEMolFunc2& f, bool own = false)

      .. oe:language:: python

         .. oe:api:: python

            AddMolFunc(f: OEMolFunc2, own: bool = False) -> bool

      This method defines the interface for adding externally declared functions 
      to an :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>` derived instance. The second argument denotes
      whether the :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>` derived instance is to take ownership of
      the memory occupied by the external function. If ownership is passed, then it would be 
      deleted during destruction of the :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>` derived class. Any object
      derived from the :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>` may be added using this method. The method
      returns ``true`` if the object of :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>` is successfully added. Only
      one copy of a :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>` may be added to an :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`
      instance. Subsequent attempts to add the same function object to already contained in a
      :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>` derived class will fail with a return value of ``false``.

   .. oe:method:: GetComponents

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<OEMolPotential::OEMolFunc2*> GetComponents() const

      .. oe:language:: python

         .. oe:api:: python

            GetComponents() -> OEMolFunc2Vector

      Method returns a vector of pointers to the currently contained :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>` instances on this :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`.

   .. oe:method:: RemoveMolFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool RemoveMolFunc(OEMolPotential::OEMolFunc2&)

      .. oe:language:: python

         .. oe:api:: python

            RemoveMolFunc(f: OEMolFunc2) -> bool

      Defines an interface to remove a function previously added to an :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`
      instance. If the function is not contained in the :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>` instance
      then the method will return ``false``. If the function is found and removed successfully, then the 
      method will return ``true``.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEInterAdaptor, InterAdaptor

.. _OEMolPotential_OEInterAdaptor:

.. oe:class:: OEInterAdaptor

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEInterAdaptor : public OEMolAdaptor

   The :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>` class provides the ability to optimize a molecule
   or conformation with the use of internal coordinates (bond lengths, bond angle bonds and
   dihedral angles) defined by the internal Z-matrix.

   .. _figure_OEInterAdaptor_Hierarchy:

   .. figure:: oefftk/images/OEInterAdaptor.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEAdaptor <OEOpt_OEAdaptor>`:
    * :oe:meth:`AdaptVar<OEOpt::OEAdaptor::AdaptVar>` 
    * :oe:meth:`GetVar<OEOpt::OEAdaptor::GetVar>`

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`:
    * :oe:meth:`SetMolFunc<OEMolPotential::OEMolAdaptor::SetMolFunc>`

   The :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>` class defines the following public methods:
    * :oe:meth:`AdaptGrad<OEMolPotential::OEInterAdaptor::AdaptGrad>`
    * :oe:meth:`Set<OEMolPotential::OEInterAdaptor::Set>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInterAdaptor(OEMolFunc1 &, bool dihedrals = true,
                           bool own = false)

      .. oe:language:: python

         .. oe:api:: python

            OEInterAdaptor(arg2: OEMolFunc1, dihedrals: bool = True,
                           own: bool = False) -> OEInterAdaptor

      The molecule function used for function evaluation must be provided as the first argument to 
      the constructor. The second argument allows to fix all dihedral angles. By default all
      dihedral angles are optimized. The third argument specifies whether the 
      :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>` object takes ownership of the memory of the molecule
      function instance. By default the :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>` instance does not take
      ownership of the molecule function, so the :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>` destructor does
      not delete the molecule function instance. If ownership of the molecule function is transferred 
      to the :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>` instance, the molecule function's delete operator
      will be called in the :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>` destructor.

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEInterAdaptor & operator=(const OEInterAdaptor &)

      Assignment operator.

   

   .. oe:method:: AdaptGrad

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AdaptGrad(double* ga, const double* g) const

      .. oe:language:: python

         .. oe:api:: python

            AdaptGrad(ga: OEDoubleArray, g: OEDoubleArray) -> bool

      Transforms the set of Cartesian gradients passed as a second argument to the method, into
      a set of internal coordinates gradients and copies them into the array passed as a first
      argument.

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>&,
                  unsigned int functype = OEFuncType::InterAdapt)
         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>&,
                  unsigned int functype = OEFuncType::InterAdapt)

      Those two methods assign atom and bond predicates which are used to partially restrict molecules
      during optimization. First method specifies atoms which are to be held fixed in their starting
      positions. Second method is used to fix dihedral angles a1-a2-a3-a4 defined by a middle bond a2-a3.    
      Both methods :oe:meth:`Set<OEMolPotential::OEInterAdaptor::Set>` must be called before the method
      derived from :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`. 



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEInterCoulombPotential, OEFFPotential, OEInterMolFunc2

.. _OEMolPotential_OEInterCoulombPotential:

.. oe:class:: OEInterCoulombPotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEInterCoulombPotential : public OEInterNonBondBase

   The :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>` class defines an interface
   for calculation of inter-molecular Coulomb interaction potentials.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`

   The following methods are publicly inherited from :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>`:
    * :oe:meth:`AdaptHostCoords<OEMolPotential::OEInterMolFunc1::AdaptHostCoords>`
    * :oe:meth:`GetVar<OEMolPotential::OEInterMolFunc1::GetVar>`
    * :oe:meth:`SetHostFlex<OEMolPotential::OEInterMolFunc1::SetHostFlex>`
    * :oe:meth:`SetupHost<OEMolPotential::OEInterMolFunc1::SetupHost>`

   The following methods are publicly inherited from :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`:
    * :oe:meth:`Set<OEMolPotential::OEInterNonBondPotBase::Set>`
    * :oe:meth:`SetNonBondCutoff<OEMolPotential::OEInterNonBondPotBase::SetNonBondCutoff>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInterCoulombPotential(const OEMolPotential::OEFFParams& fp,
                                    const double rcut = 0.0)
            OEInterCoulombPotential(const OEInterCoulombPotential&)

      .. oe:language:: python

         .. oe:api:: python

            OEInterCoulombPotential(fp: OEFFParams, rcut: float = 0.0) -> OEInterCoulombPotential
            OEInterCoulombPotential(arg2: OEInterCoulombPotential) -> OEInterCoulombPotential

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OEInterCoulombPotential& operator=(const OEInterCoulombPotential&)

     Assignment operator.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEInterMolFunc1, MolFunc1

.. _OEMolPotential_OEInterMolFunc1:

.. oe:class:: OEInterMolFunc1

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEInterMolFunc1 : public OEMolFunc1

   The :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>` is an abstract base class. It extends
   :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` to the cases where a small molecule interacts
   with a macromolecule that is rigid or partially flexible.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Set<OEMolPotential::OEMolFunc::Set>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>` class defines the following public methods:
      * :oe:meth:`AdaptHostCoords<OEMolPotential::OEInterMolFunc1::AdaptHostCoords>`
      * :oe:meth:`GetVar<OEMolPotential::OEInterMolFunc1::GetVar>`
      * :oe:meth:`SetHostFlex<OEMolPotential::OEInterMolFunc1::SetHostFlex>`
      * :oe:meth:`SetupHost<OEMolPotential::OEInterMolFunc1::SetupHost>`

   The following classes derive from this class:   
    * :ref:`OEInterMolFunc2 <OEMolPotential_OEInterMolFunc2>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEInterMolFunc1 & operator=(const OEInterMolFunc1 &)

      Assignment operator.

  .. oe:method:: AdaptHostCoords

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AdaptHostCoords(double* coords, const double* var) const

      .. oe:language:: python

         .. oe:api:: python

            AdaptHostCoords(coords: OEDoubleArray, var: OEDoubleArray) -> bool

      Produces the complete host coordinates (``coords``) from a set of
      host coordinates representing the flexible part of the host (``var``).

  .. oe:method:: GetVar

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetVar(double* var, const double* x)

      .. oe:language:: python

         .. oe:api:: python

            GetVar(var: OEDoubleArray, x: OEDoubleArray) -> None

      Takes the complete set coordinates of the host-ligand system (``x``) and
      transforms them to a subset of coordinates to be optimized (``var``).

   .. oe:method:: SetHostFlex

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetHostFlex(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred)

      .. oe:language:: python

         .. oe:api:: python

            SetHostFlex(pred: OEUnaryAtomPred) -> bool

      Sets predicate (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`) that defines the flexible atoms
      of the host molecule (usually a macromolecule). Host atoms that pass
      the predicate (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`) will be subject to optimization
      along with the ligand atoms for which a :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`
      method is called.

   .. oe:method:: SetupHost

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupHost(const OEChem::OEMolBase& host)

      .. oe:language:: python

         .. oe:api:: python

            SetupHost(host: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets a macromolecule as host.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEInterMolFunc2, MolFunc2

.. _OEMolPotential_OEInterMolFunc2:

.. oe:class:: OEInterMolFunc2

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEInterMolFunc2 : public InterMolFunc1, public OEMolFunc2

   The :ref:`OEInterMolFunc2 <OEMolPotential_OEInterMolFunc2>` is an abstract base class. This
   class defines the interface for stateful functions which operate on
   molecules and conformers, compute a function value, gradients, and
   second derivatives. :ref:`OEInterMolFunc2 <OEMolPotential_OEInterMolFunc2>`
   combines :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>` with :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`
   interface.  Classes derived from :ref:`OEInterMolFunc2 <OEMolPotential_OEInterMolFunc2>`
   can be used with any optimizers.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Set<OEMolPotential::OEMolFunc::Set>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>`:
    * :oe:meth:`AdaptHostCoords<OEMolPotential::OEInterMolFunc1::AdaptHostCoords>`
    * :oe:meth:`GetVar<OEMolPotential::OEInterMolFunc1::GetVar>`
    * :oe:meth:`SetHostFlex<OEMolPotential::OEInterMolFunc1::SetHostFlex>`
    * :oe:meth:`SetupHost<OEMolPotential::OEInterMolFunc1::SetupHost>`

   The following classes derive from this class:
    * :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEInterMolFunc2 & operator=(const OEInterMolFunc2 &)

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEInterNonBondPotBase, OEFFPotential, OEInterMolFunc2

.. _OEMolPotential_OEInterNonBondPotBase:

.. oe:class:: OEInterNonBondPotBase

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEInterNonBondPotBase : public OEFFPotential, public OEMolPotential::OEInterMolFunc2

   The :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>` is an abstract base class.  This class defines a common
   base class for all inter-molecular non-bonded force field interaction potentials.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`

   The following methods are publicly inherited from :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>`:
    * :oe:meth:`AdaptHostCoords<OEMolPotential::OEInterMolFunc1::AdaptHostCoords>`
    * :oe:meth:`GetVar<OEMolPotential::OEInterMolFunc1::GetVar>`
    * :oe:meth:`SetHostFlex<OEMolPotential::OEInterMolFunc1::SetHostFlex>`
    * :oe:meth:`SetupHost<OEMolPotential::OEInterMolFunc1::SetupHost>`

   The :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>` implements the following methods:
    * :oe:meth:`Set<OEMolPotential::OEInterNonBondPotBase::Set>`
    * :oe:meth:`SetNonBondCutoff<OEMolPotential::OEInterNonBondPotBase::SetNonBondCutoff>`

   The following classes derive from this class:
    * :ref:`OEInterNonBondPotential <OEMolPotential_OEInterNonBondPotential>`
    * :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
    * :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`

   .. oe:method:: Constructors

      .. oe:api::

         OEInterNonBondPotBase(const OEMolPotential::OEFFParams& fp,
                               const OENonBondIntcsOptions& options = OENonBondIntcsOptions())
         OEInterNonBondPotBase(const OEInterNonBondPotBase&)

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OEInterNonBondPotBase& operator=(const OEInterNonBondPotBase&)

     Assignment operator.

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEBinaryPredicate<OEChem::OEAtomBase, OEChem::OEAtomBase>& pred,
                  unsigned int flag = OEFuncType::All)

      This method can be used for interaction-level control of the non-bonded terms. Interactions between two 
      atoms are only included if the test of the binary predicate with both atoms returns ``true``. 
      The :oe:meth:`Set<OEMolPotential::OENonBondPotBase::Set>` method must be called before the 
      :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.

   .. oe:method:: SetNonBondCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNonBondCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetNonBondCutoff(arg2: float) -> bool

      Sets non-bonded interactions cutoff.
      Setting a value of ``0.0`` or less assumes that all interactions should be
      included without any cutoff.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEInterNonBondPotential, OEFFPotential, OEInterMolFunc2

.. _OEMolPotential_OEInterNonBondPotential:

.. oe:class:: OEInterNonBondPotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEInterNonBondPotential : public OEInterNonBondBase

   The :ref:`OEInterNonBondPotential <OEMolPotential_OEInterNonBondPotential>` class defines an interface
   for calculation of inter-molecular non-bonded (both VdW and Coulomb) force field 
   interaction potentials..

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`

   The following methods are publicly inherited from :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>`:
    * :oe:meth:`AdaptHostCoords<OEMolPotential::OEInterMolFunc1::AdaptHostCoords>`
    * :oe:meth:`GetVar<OEMolPotential::OEInterMolFunc1::GetVar>`
    * :oe:meth:`SetHostFlex<OEMolPotential::OEInterMolFunc1::SetHostFlex>`
    * :oe:meth:`SetupHost<OEMolPotential::OEInterMolFunc1::SetupHost>`

   The following methods are publicly inherited from :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`:
    * :oe:meth:`Set<OEMolPotential::OEInterNonBondPotBase::Set>`
    * :oe:meth:`SetNonBondCutoff<OEMolPotential::OEInterNonBondPotBase::SetNonBondCutoff>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInterNonBondPotential(const OEMolPotential::OEFFParams& fp,
                                    const OENonBondIntcsOptions& options = OENonBondIntcsOptions())
            OEInterNonBondPotential(const OEInterNonBondPotential&)

      .. oe:language:: python

         .. oe:api:: python

            OEInterNonBondPotential(fp: OEFFParams,
                                    options: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OEInterNonBondPotential
            OEInterNonBondPotential(arg2: OEInterNonBondPotential) -> OEInterNonBondPotential

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OEInterNonBondPotential& operator=(const OEInterNonBondPotential&)

     Assignment operator.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEInterVdwPotential, OEFFPotential, OEInterMolFunc2

.. _OEMolPotential_OEInterVdwPotential:

.. oe:class:: OEInterVdwPotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEInterVdwPotential : public OEInterNonBondBase

   The :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>` class defines an interface
   for calculation of inter-molecular Vdw force field 
   interaction potentials.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`

   The following methods are publicly inherited from :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>`:
    * :oe:meth:`AdaptHostCoords<OEMolPotential::OEInterMolFunc1::AdaptHostCoords>`
    * :oe:meth:`GetVar<OEMolPotential::OEInterMolFunc1::GetVar>`
    * :oe:meth:`SetHostFlex<OEMolPotential::OEInterMolFunc1::SetHostFlex>`
    * :oe:meth:`SetupHost<OEMolPotential::OEInterMolFunc1::SetupHost>`

   The following methods are publicly inherited from :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`:
    * :oe:meth:`Set<OEMolPotential::OEInterNonBondPotBase::Set>`
    * :oe:meth:`SetNonBondCutoff<OEMolPotential::OEInterNonBondPotBase::SetNonBondCutoff>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInterVdwPotential(const OEMolPotential::OEFFParams& fp,
                                const double rcut = 0.0)
            OEInterVdwPotential(const OEInterVdwPotential&)

      .. oe:language:: python

         .. oe:api:: python

            OEInterVdwPotential(fp: OEFFParams, rcut: float = 0.0) -> OEInterVdwPotential
            OEInterVdwPotential(arg2: OEInterVdwPotential) -> OEInterVdwPotential

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OEInterVdwPotential& operator=(const OEInterVdwPotential&)

     Assignment operator.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEInteractParams, InteractParams

.. _OEMolPotential_OEInteractParams:

.. oe:class:: OEInteractParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEInteractParams

   The :ref:`OEInteractParams <OEMolPotential_OEInteractParams>` class provides a general mechanism for retrieving
   multiple parameters from methods defined in the :ref:`OEFFParams <OEMolPotential_OEFFParams>` class.
   The number and types of parameters required for calculating molecular interactions varies among 
   force fields. To keep the interface consistent among implementations of 
   :ref:`OEFFParams <OEMolPotential_OEFFParams>` for various force fields, parameters are stored in the
   :ref:`OEInteractParams <OEMolPotential_OEInteractParams>` class.  Once parameters have been assigned in an
   :ref:`OEInteractParams <OEMolPotential_OEInteractParams>` instance they may be retrieved using
   :oe:meth:`OEMolPotential::OEInteractParams::Get` method.  

   The :ref:`OEInteractParams <OEMolPotential_OEInteractParams>` class defines the following public methods:
    * :oe:meth:`Clear<OEMolPotential::OEInteractParams::Clear>`
    * :oe:meth:`Get<OEMolPotential::OEInteractParams::Get>`
    * :oe:meth:`GetList<OEMolPotential::OEInteractParams::GetList>`
    * :oe:meth:`Set<OEMolPotential::OEInteractParams::Set>`
    * :oe:meth:`SetList<OEMolPotential::OEInteractParams::SetList>`

   .. oe:method:: Constructors

       .. oe:language:: c++ java csharp

          .. oe:api::

             OEInteractParams()
             OEInteractParams(const OEInteractParams&)

       .. oe:language:: python

          .. oe:api:: python

             OEInteractParams() -> OEInteractParams
             OEInteractParams(arg2: OEInteractParams) -> OEInteractParams

      Constructor and copy constructor.

   .. oe:method:: Assignment operator

       .. oe:api::

          OEInteractParams& operator=(const OEInteractParams&)

       Thwe assignment operator

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Assigns all parameters to 0.0 in the :ref:`OEInteractParams <OEMolPotential_OEInteractParams>` instance.

   .. oe:method:: Get

      .. oe:language:: c++ java csharp

         .. oe:api::

            double Get(const unsigned int idx) const

      .. oe:language:: python

         .. oe:api:: python

            Get(idx: int) -> float

      Returns the parameter value associated with an integer taken from 
      :oe:const:`OEMolPotential::OEFFParam` namespace. The integer argument specifies the type of 
      parameter requested from the :ref:`OEInteractParams <OEMolPotential_OEInteractParams>` instance. The requested
      parameter type must match :ref:`OEFFParams <OEMolPotential_OEFFParams>` retrieval method to which the
      :ref:`OEInteractParams <OEMolPotential_OEInteractParams>` instance was passed.

   .. oe:method:: GetList

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<double> GetList(const unsigned idx) const

      .. oe:language:: python

         .. oe:api:: python

            GetList(idx: int) -> OEDoubleVector

      Returns a vector of parameters associated with an integer taken from
      :oe:const:`OEMolPotential::OEFFParam` namespace. The integer argument specifies the type of
      parameter vector requested from the :ref:`OEInteractParams <OEMolPotential_OEInteractParams>` instance.

   .. oe:method:: Set 

      .. oe:api::

         bool Set(const unsigned idx, const double value)

      Sets the value of a parameter associated with an integer taken from the
      :oe:const:`OEMolPotential::OEFFParam` namespace (first argument) in the 
      :oe:const:`OEMolPotential::OEFFParam` namespace instance.

   .. oe:method:: SetList

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetList(const unsigned idx, const std::vector<double>& values)

      .. oe:language:: python

         .. oe:api:: python

            SetList(idx: int, values: OEDoubleVector) -> bool

      Sets the values of a parameter vector in the 
      :oe:const:`OEMolPotential::OEFFParam` namespace instance.
      The integer argument specifies the type of parameter vector which will be set.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEInteraction, Interaction

.. _OEMolPotential_OEInteraction:

.. oe:class:: OEInteraction

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEInteraction

   The :ref:`OEInteraction <OEMolPotential_OEInteraction>` class provides a general mechanism to report individual
   interactions calculated within a function or force field component. For instance, pairwise atom 
   interactions in an intramolecular VdW component calculation can be obtained by the 
   :oe:meth:`OEMolPotential::OEMolFunc::GetInteractions` method that returns an iterator over 
   the :ref:`OEInteraction <OEMolPotential_OEInteraction>` instances.

   The :ref:`OEInteraction <OEMolPotential_OEInteraction>` class defines the following public methods:
    * :oe:meth:`GetAtoms<OEMolPotential::OEInteraction::GetAtoms>`
    * :oe:meth:`GetName<OEMolPotential::OEInteraction::GetName>`
    * :oe:meth:`GetValues<OEMolPotential::OEInteraction::GetValues>`
    * :oe:meth:`NumAtoms<OEMolPotential::OEInteraction::NumAtoms>`
    * :oe:meth:`NumValues<OEMolPotential::OEInteraction::NumValues>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEInteraction(OEInteractImpl &)
            OEInteraction(const OEInteraction &)

      .. oe:language:: python

         .. oe:api:: python

            OEInteraction(arg2: OEInteractImpl) -> OEInteraction
            OEInteraction(arg2: OEInteraction) -> OEInteraction

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEInteraction &operator=(const OEInteraction &)

      Assignment operator.

   .. oe:method:: GetAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEAtomBase>* GetAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> OEAtomIter

      Returns an iterator over the atoms involved in the calculated interaction.

   .. oe:method:: GetName

      .. oe:language:: c++ java csharp

         .. oe:api::

            const char* GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns a clear text human readable identifier for the type of interaction.

   .. oe:method:: GetValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetValues(double* grads = 0) const

      .. oe:language:: python

         .. oe:api:: python

            GetValues(grads: OEDoubleArray = None) -> float

      Returns the energy associated with the calculated interaction. The associated gradients may also 
      be obtained by passing in an array of the length returned by the 
      :oe:meth:`OEMolPotential::OEInteraction::NumValues` method. The derivatives correspond to the atom 
      ordering returned by the :oe:meth:`OEMolPotential::OEInteraction::GetAtoms` method.

   .. oe:method:: NumAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned NumAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            NumAtoms() -> int

      Returns the number of atoms involved in the calculated interactions. One-body interactions, 
      such as an atom in a field, will only have one atom involved in the interaction. VdW interactions 
      will consist of two atoms.  Torsions are composed of four interacting atoms.

   .. oe:method:: NumValues

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned NumValues() const

      .. oe:language:: python

         .. oe:api:: python

            NumValues() -> int

      Returns the number of gradients associated with the particular interaction. For interactions 
      calculated from Cartesian coordinates of atoms, this method will typically return three times 
      the number of atoms involved in the interaction as x, y, and z gradient values are calculated 
      for each atom.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEMolAdaptor, MolAdaptor

.. _OEMolPotential_OEMolAdaptor:

.. oe:class:: OEMolAdaptor

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMolAdaptor : public OEOpt::OEAdaptor, public OEMolPotential:: OEMolFunc1

   The :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>` class is a pure virtual base class which defines the interface for
   classes which adapt or transform molecular coordinates  and gradients during an optimization.
   Adaptors are useful in cases where energy and gradients evaluation for a molecule or conformation
   are performed in Cartesian coordinates, but the optimization is done in different coordinate
   system, for example in torsion space.

   .. _figure_OEMolAdaptor_Hierarchy:

   .. figure:: oefftk/images/OEMolAdaptor.*
      :align:  center     

   The following methods are publicly inherited from :ref:`OEAdaptor <OEOpt_OEAdaptor>`:
    * :oe:meth:`AdaptVar<OEOpt::OEAdaptor::AdaptVar>` 
    * :oe:meth:`GetVar<OEOpt::OEAdaptor::GetVar>`

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Set<OEMolPotential::OEMolFunc::Set>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>` class defines the following public methods:
    * :oe:meth:`SetMolFunc<OEMolPotential::OEMolAdaptor::SetMolFunc>`

   The following classes derive from this class:  
    * :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>`
    * :ref:`OEMolAdaptor2 <OEMolPotential_OEMolAdaptor2>`
    * :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>`
    * :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`
    * :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>`
    * :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>`

   .. oe:method:: SetMolFunc

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMolFunc(OEMolFunc1& molfunc, bool own)=0

      .. oe:language:: python

         .. oe:api:: python

            SetMolFunc(molfunc: OEMolFunc1, own: bool) -> bool

      Defines the interface for resetting the molecule function within a 
      :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>` derived instance. Any molecule functions which are
      "owned" at the time of calling this method will be deleted. If the value of a second argument 
      passed to the method is ``true``, the adaptor derived from :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`
      will take ownership of the memory of the molecule function, and will call the molecule function's 
      delete operator when either the destructor or the current method is called.  

 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEMolAdaptor2, MolAdaptor2

.. _OEMolPotential_OEMolAdaptor2:

.. oe:class:: OEMolAdaptor2

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMolAdaptor2 : public OEMolPotential:: OEMolAdaptor, public OEMolPotential:: OEMolFunc2

   The :ref:`OEMolAdaptor2 <OEMolPotential_OEMolAdaptor2>` class is a pure virtual base class which defines the interface for
   classes which adapt or transform molecular coordinates, gradients, and hessians of a given 
   :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>` during an optimization.
   Adaptors are useful in cases where energy, gradients and hessians evaluation for a molecule or conformation
   are performed in Cartesian coordinates, but the optimization is done in different coordinate
   system.

   .. _figure_OEMolAdaptor2_Hierarchy:

   .. figure:: oefftk/images/OEMolAdaptor2.*
      :align:  center     

   The following methods are publicly inherited from :ref:`OEAdaptor <OEOpt_OEAdaptor>`:
    * :oe:meth:`AdaptVar<OEOpt::OEAdaptor::AdaptVar>` 
    * :oe:meth:`GetVar<OEOpt::OEAdaptor::GetVar>`

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Set<OEMolPotential::OEMolFunc::Set>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`:
    * :oe:meth:`SetMolFunc<OEMolPotential::OEMolAdaptor::SetMolFunc>`

   The :ref:`OEMolAdaptor2 <OEMolPotential_OEMolAdaptor2>` class defines the following public methods:
    * :oe:meth:`SetMolFunc2<OEMolPotential::OEMolAdaptor2::SetMolFunc2>`

   The following classes derive from this class:  
    * :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`

   .. oe:method:: SetMolFunc2

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMolFunc2(OEMolFunc2& molfunc, bool own)=0

      .. oe:language:: python

         .. oe:api:: python

            SetMolFunc2(molfunc: OEMolFunc2, own: bool) -> bool

      Defines the interface for resetting the molecule function, :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`, within a
      :ref:`OEMolAdaptor2 <OEMolPotential_OEMolAdaptor2>` derived instance. Any molecule functions which are
      "owned" at the time of calling this method will be deleted. If the value of a second argument 
      passed to the method is ``true``, the adaptor derived from :ref:`OEMolAdaptor2 <OEMolPotential_OEMolAdaptor2>`
      will take ownership of the memory of the molecule function, and will call the molecule function's 
      delete operator when either the destructor or the current method is called.  

 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEMolFunc, MolFunc

.. _OEMolPotential_OEMolFunc:

.. oe:class:: OEMolFunc

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMolFunc

   The :ref:`OEMolFunc <OEMolPotential_OEMolFunc>` is an abstract base class. This class defines the
   interface for functions that require a molecule to compute the function value,
   and is often associated with a force field. When associated with a force field,
   this represents a forcefield component or a collection of components with each
   component being a collection of interactions (:ref:`OEInteraction <OEMolPotential_OEInteraction>`).
   Thus, classes derived from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>` can represent
   a part of or a complete force field. The force field components need to be done
   concomitant with one or more :ref:`OEFFParams <OEMolPotential_OEFFParams>` derived classes.

   .. _figure_OEMolFunc_Hierarchy:

   .. figure:: oefftk/images/OEMolFunc.*
      :align:  center

   The :ref:`OEMolFunc <OEMolPotential_OEMolFunc>` class defines the following public methods:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Set<OEMolPotential::OEMolFunc::Set>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`
    * :oe:meth:`SetupConf<OEMolPotential::OEMolFunc::SetupConf>`

   The following classes derive from this class:
    * :ref:`OEMolFunc0 <OEMolPotential_OEMolFunc0>`
    * :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>`
    * :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`
    * :ref:`OEForceField <OEMolPotential_OEForceField>`
    * :ref:`OEGenericFF <OEMolPotential_OEGenericFF>`
    * :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`
    * :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>`
    * :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`
    * :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>`
    * :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`
    * :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>`
    * :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>`
    * :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>`
    * :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>`
    * :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`
    * :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>`
    * :ref:`OEBendPotential <OEMolPotential_OEBendPotential>`
    * :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>`
    * :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>`
    * :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`
    * :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
    * :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`
    * :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>`
    * :ref:`OEInterMolFunc2 <OEMolPotential_OEInterMolFunc2>`
    * :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`
    * :ref:`OEInterNonBondPotential <OEMolPotential_OEInterNonBondPotential>`
    * :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
    * :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`
    * :ref:`OEHarmonicPotential <OEConstr_OEHarmonicPotential>`
    * :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
    * :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>`
    * :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`
    * :ref:`OESheffield <OESheff_OESheffield>`
    * :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
    * :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>`
    * :ref:`OEShapeFunc <OEShape_OEShapeFunc>`
    * :ref:`OEExactShapeFunc <OEShape_OEExactShapeFunc>`
    * :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>`
    * :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>`
    * :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>`
    * :ref:`OEColorFunc <OEShape_OEColorFunc>`
    * :ref:`OEExactColorFunc <OEShape_OEExactColorFunc>`
    * :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>`
    * :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>`

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Deletes all interactions contained in the :ref:`OEMolFunc <OEMolPotential_OEMolFunc>` derived instance.
      The interactions are created during setup (:oe:meth:`OEMolPotential::OEMolFunc::Setup`).

   .. oe:method:: ClearPredicates

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearPredicates()

      .. oe:language:: python

         .. oe:api:: python

            ClearPredicates() -> None

      Deletes all stored predicates set, previously created by using one of the overloaded
      :oe:meth:`OEMolPotential::OEMolFunc::Set` methods. Predicates control function behavior
      during setup (:oe:meth:`OEMolPotential::OEMolFunc::Setup`).

   .. oe:method:: GetInteractions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEInteraction>* GetInteractions(const OEChem::OEMolBase &,
                                                                 const double *,
                                                                 unsigned functype = 0) const

      .. oe:language:: python

         .. oe:api:: python

            GetInteractions(arg0: Union[OEGraphMol,OEMol,OEQMol], arg1: float,
                            functype: int = 0) -> Iterable[OEInteraction]

      This method defines the interface for retrieving interaction level information computed
      by the :ref:`OEMolFunc <OEMolPotential_OEMolFunc>` instance, given a molecule (first argument) and a
      set of coordinates (second argument). The method returns an iterator over the :ref:`OEInteraction <OEMolPotential_OEInteraction>`
      objects. See the section on :ref:`OEInteraction <OEMolPotential_OEInteraction>` for the details regarding
      interaction interrogation and reporting.

      If :ref:`OEMolFunc <OEMolPotential_OEMolFunc>` is a composition of multiple components,
      the last argument may be used to request the interactions of only a single component by passing a value from the :oe:const:`OEMolPotential::OEFuncType` namespace.

      Due to the unique construct of the return value from this method, it
      is not possible to implement this in a user derived class. Default implementation of this method
      return an iterator over an empty vector.

   .. oe:method:: Set

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Set(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& pred,
                     unsigned int functype)
            bool Set(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred,
                     unsigned int functype)
            bool Set(const OESystem::OEBinaryPredicate<OEChem::OEAtomBase, OEChem::OEAtomBase>& pred,
                     unsigned int functype)
            bool Set(const OESystem::OEBinaryPredicate<OEChem::OEBondBase, OEChem::OEBondBase>& pred,
                     unsigned int functype)

      .. oe:language:: python

         .. oe:api:: python

            Set(arg0: OEUnaryBondPred, arg1: int) -> bool
            Set(arg0: OEUnaryAtomPred, arg1: int) -> bool
            Set(arg0: OEBinaryAtomPred, arg1: int) -> bool
            Set(arg0: OEBinaryBondPred, arg1: int) -> bool

      These methods assigns interaction-control predicates to the :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`
      derived instance. The first argument is the predicate type to be passed to the interaction component.
      The second argument is a value or a set of binary OR'ed values taken from the :oe:const:`OEMolPotential::OEFuncType`
      namespace which specifies the intended target for the predicate assignment.

      Most derived classes can only use a handful of the four different kinds of predicates
      allowed in these overloads, thus only the specific overloads are overwritten by various derived class.
      The default implementation for all the overloads has trivial implementation and returns a ``false``.

   .. oe:method:: Setup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Setup(const OEChem::OEMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            Setup(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This method defines the interface for initializing a :ref:`OEMolFunc <OEMolPotential_OEMolFunc>` derived instance with a molecule. All classes derived from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>` implements this method.
      Typically the implementation of this method requires perception of the passed molecule for efficient energy evaluation.

      .. seealso::

         * :ref:`section_FFEnergy_example` example

   .. _OEMolPotential_OEMolFunc_SetupConf:

   .. oe:method:: SetupConf

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupConf(const double *)

      .. oe:language:: python

         .. oe:api:: python

            SetupConf(arg0: OEDoubleArray) -> bool

      This method defines the interface for initializing a :ref:`OEMolFunc <OEMolPotential_OEMolFunc>` derived 
      instance with coordinates of a new conformer, after it has already been initialized with the molecule by 
      calling :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`. Not all classes derived from 
      :ref:`OEMolFunc <OEMolPotential_OEMolFunc>` implements this method, but calling this should never
      cause any additional performance issue or failures.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEMolFunc0, MolFunc0

.. _OEMolPotential_OEMolFunc0:

.. oe:class:: OEMolFunc0

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMolFunc0 : public OEOpt::OEFunc0, public OEMolFunc

   The :ref:`OEMolFunc0 <OEMolPotential_OEMolFunc0>` is an abstract base class. This
   class defines the interface for stateful functions which operate on
   molecules and conformers, compute a function value, but have no defined
   analytical gradients. :ref:`OEMolFunc0 <OEMolPotential_OEMolFunc0>`
   combines :ref:`OEFunc0 <OEOpt_OEFunc0>` with :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`
   interface.  Classes derived from :ref:`OEMolFunc0 <OEMolPotential_OEMolFunc0>` are
   intended for use with optimizers which do not require gradients.

   .. _figure_OEMolFunc0_Hierarchy:

   .. figure:: oefftk/images/OEMolFunc0.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Set<OEMolPotential::OEMolFunc::Set>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following classes derive from this class:   
    * :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>`
    * :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`
    * :ref:`OEForceField <OEMolPotential_OEForceField>`
    * :ref:`OEGenericFF <OEMolPotential_OEGenericFF>`
    * :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`
    * :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>`
    * :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`
    * :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>`
    * :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`
    * :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>`
    * :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>`
    * :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>`
    * :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>`
    * :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`
    * :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>`
    * :ref:`OEBendPotential <OEMolPotential_OEBendPotential>`
    * :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>`
    * :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>`
    * :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`
    * :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
    * :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`
    * :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>`
    * :ref:`OEInterMolFunc2 <OEMolPotential_OEInterMolFunc2>`
    * :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`
    * :ref:`OEInterNonBondPotential <OEMolPotential_OEInterNonBondPotential>`
    * :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
    * :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`
    * :ref:`OEHarmonicPotential <OEConstr_OEHarmonicPotential>`
    * :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
    * :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>`
    * :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`
    * :ref:`OESheffield <OESheff_OESheffield>`
    * :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
    * :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>`
    * :ref:`OEShapeFunc <OEShape_OEShapeFunc>`
    * :ref:`OEExactShapeFunc <OEShape_OEExactShapeFunc>`
    * :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>`
    * :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>`
    * :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>`
    * :ref:`OEColorFunc <OEShape_OEColorFunc>`
    * :ref:`OEExactColorFunc <OEShape_OEExactColorFunc>`
    * :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>`
    * :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEMolFunc1, MolFunc1

.. _OEMolPotential_OEMolFunc1:

.. oe:class:: OEMolFunc1

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMolFunc1 : public OEOpt::OEFunc1, public OEMolFunc0

   The :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` is an abstract base class. This
   class defines the interface for stateful functions which operate on
   molecules and conformers, compute a function
   value, and has defined analytical gradients.
   :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` combines :ref:`OEFunc1 <OEOpt_OEFunc1>`
   with :ref:`OEMolFunc0 <OEMolPotential_OEMolFunc0>` interface.
   Classes derived from :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` are intended
   for use with optimizers which require gradients but do not require second
   derivatives.

   .. _figure_OEMolFunc1_Hierarchy:

   .. figure:: oefftk/images/OEMolFunc1.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Set<OEMolPotential::OEMolFunc::Set>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following classes derive from this class:   
    * :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`
    * :ref:`OEForceField <OEMolPotential_OEForceField>`
    * :ref:`OEGenericFF <OEMolPotential_OEGenericFF>`
    * :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`
    * :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>`
    * :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`
    * :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>`
    * :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`
    * :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>`
    * :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>`
    * :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>`
    * :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>`
    * :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`
    * :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>`
    * :ref:`OEBendPotential <OEMolPotential_OEBendPotential>`
    * :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>`
    * :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>`
    * :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`
    * :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
    * :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`
    * :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>`
    * :ref:`OEInterMolFunc2 <OEMolPotential_OEInterMolFunc2>`
    * :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`
    * :ref:`OEInterNonBondPotential <OEMolPotential_OEInterNonBondPotential>`
    * :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
    * :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`
    * :ref:`OEHarmonicPotential <OEConstr_OEHarmonicPotential>`
    * :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
    * :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>`
    * :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`
    * :ref:`OESheffield <OESheff_OESheffield>`
    * :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
    * :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>`
    * :ref:`OEShapeFunc <OEShape_OEShapeFunc>`
    * :ref:`OEExactShapeFunc <OEShape_OEExactShapeFunc>`
    * :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>`
    * :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>`
    * :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>`
    * :ref:`OEColorFunc <OEShape_OEColorFunc>`
    * :ref:`OEExactColorFunc <OEShape_OEExactColorFunc>`
    * :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>`
    * :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEMolFunc2, MolFunc2

.. _OEMolPotential_OEMolFunc2:

.. oe:class:: OEMolFunc2

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMolFunc2 : public OEOpt::OEFunc2, public OEMolFunc1

   The :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>` is an abstract base class. This
   class defines the interface for stateful functions which operate on
   molecules and conformers, compute a function value, gradients, and
   second derivatives. :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`
   combines :ref:`OEFunc2 <OEOpt_OEFunc2>` with :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`
   interface.  Classes derived from :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`
   can be used with any optimizers.

   .. _figure_OEMolFunc2_Hierarchy:

   .. figure:: oefftk/images/OEMolFunc2.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Set<OEMolPotential::OEMolFunc::Set>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following classes derive from this class:
    * :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`
    * :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`
    * :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>`
    * :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>`
    * :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`
    * :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>`
    * :ref:`OEBendPotential <OEMolPotential_OEBendPotential>`
    * :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>`
    * :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>`
    * :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`
    * :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
    * :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`
    * :ref:`OEInterMolFunc2 <OEMolPotential_OEInterMolFunc2>`
    * :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`
    * :ref:`OEInterNonBondPotential <OEMolPotential_OEInterNonBondPotential>`
    * :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
    * :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`
    * :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
    * :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>`
    * :ref:`OESheffield <OESheff_OESheffield>`
    * :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>`


.. _OEMolPotentialClasses:

********************************
OEMolPotential Classes
********************************

.. oe:namespace:: OEMolPotential

.. toctree::

   OEBendParams
   OEBendPotential
   OECoulombPotential
   OEFFParams
   OEFFPotential
   OEForceField
   OEGenericFF
   OEGenericFF2
   OEInteraction
   OEInteractParams
   OEInterAdaptor
   OEInterCoulombPotential
   OEInterMolFunc1
   OEInterMolFunc2
   OEInterNonBondPotBase
   OEInterNonBondPotential
   OEInterVdwPotential
   OEMolAdaptor
   OEMolAdaptor2
   OEMolFunc
   OEMolFunc0
   OEMolFunc1
   OEMolFunc2
   OENonBondPotBase
   OENonBondPotential
   OENonBondIntcsOptions
   OENumericMolFunc2
   OEOutOfPlaneParams
   OEOutOfPlanePotential
   OEQuatAdaptor
   OEScaledMolFunc
   OEStretchParams
   OEStretchPotential
   OESubsetAdaptor
   OETorAdaptor
   OETorQuatAdaptor
   OETorsionParams
   OETorsionPotential
   OEVdwParams
   OEVdwPotential


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OENonBondIntcsOptions, OEOptions

.. _OEMolPotential_OENonBondIntcsOptions:

.. oe:class:: OENonBondIntcsOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OENonBondIntcsOptions : public OESystem::OEOptions

   The :ref:`OENonBondIntcsOptions <OEMolPotential_OENonBondIntcsOptions>` is a class that defines common
   options for :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`.

   The :ref:`OENonBondIntcsOptions <OEMolPotential_OENonBondIntcsOptions>` class defines the following public methods:
    * :oe:meth:`CreateCopy<OEMolPotential::OENonBondIntcsOptions::CreateCopy>`
    * :oe:meth:`GetCoulombCutoff<OEMolPotential::OENonBondIntcsOptions::GetCutoff>`
    * :oe:meth:`GetUseCoulomb<OEMolPotential::OENonBondIntcsOptions::GetUseCoulomb>`
    * :oe:meth:`GetUseVdW<OEMolPotential::OENonBondIntcsOptions::GetUseVdW>`
    * :oe:meth:`GetVdWCutoff<OEMolPotential::OENonBondIntcsOptions::GetCutoff>`
    * :oe:meth:`SetUseCoulomb<OEMolPotential::OENonBondIntcsOptions::SetUseCoulomb>`
    * :oe:meth:`SetUseVdW<OEMolPotential::OENonBondIntcsOptions::SetUseVdW>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENonBondIntcsOptions()
            OENonBondIntcsOptions(const OENonBondIntcsOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OENonBondIntcsOptions() -> OENonBondIntcsOptions
            OENonBondIntcsOptions(arg2: OENonBondIntcsOptions) -> OENonBondIntcsOptions

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OENonBondIntcsOptions& operator=(const OENonBondIntcsOptions&)

     Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolPotential::OENonBondIntcsOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OENonBondIntcsOptions

      This method returns a pointer to a deep copy of the instance of :ref:`OENonBondIntcsOptions <OEMolPotential_OENonBondIntcsOptions>`.

   .. oe:method:: GetCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            float d = GetCutoff()

      .. oe:language:: python

         .. oe:api:: python

            GetCutoff() -> float

      See :oe:meth:`SetCutoff<OEMolPotential::OENonBondIntcsOptions::SetCutoff>` method.

   .. oe:method:: GetUseCoulomb

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseCoulomb() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseCoulomb() -> bool

      See :oe:meth:`SetUseCoulomb<OEMolPotential::OENonBondIntcsOptions::SetUseCoulomb>` method. 

   .. oe:method:: GetUseVdW

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseVdW() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseVdW() -> bool

      See :oe:meth:`SetUseVdW<OEMolPotential::OENonBondIntcsOptions::SetUseVdW>` method. 

   .. oe:method:: SetCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetCutoff(value: float) -> bool

      Sets the **cutoff** to be used for non-bonded interactions (van der Waals and coulombic potentials).
      A cutoff value of `0.0` implies that a cutoff value should not be used at all.
      **Default: 0.0**

   .. oe:method:: SetUseCoulomb

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseCoulomb(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseCoulomb(value: bool) -> bool

      Sets **flag specifying if coulombic interactions** should be included in calculation.
      **Default: True**

   .. oe:method:: SetUseVdW

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseVdW(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseVdW(value: bool) -> bool

      Sets **flag specifying if van der Waals interactions** should be included in calculation.
      **Default: True** 



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OENonBondPotBase, OEMolFunc2

.. _OEMolPotential_OENonBondPotBase:

.. oe:class:: OENonBondPotBase

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OENonBondPotBase : public virtual OEMolPotential::OEFFPotential

   The :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>` is an abstract base class.  This class defines a common
   base class for all intra-molecular non-bonded force field interaction potentials.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`
    
   The :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>` implements the following methods:
    * :oe:meth:`GetNonBondOptions<OEMolPotential::OENonBondPotBase::GetNonBondOptions>`
    * :oe:meth:`Set<OEMolPotential::OENonBondPotBase::Set>`

   The following classes derive from this class:
    * :ref:`OENonBondPotential <OEMolPotential_OENonBondPotential>`
    * :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
    * :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`

   .. oe:method:: Constructors

      .. oe:api::

         OENonBondPotBase(const OEMolPotential::OEFFParams& fp,
                          const OENonBondIntcsOptions& options = OENonBondIntcsOptions())
         OENonBondPotBase(const OENonBondPotBase&)

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OENonBondPotBase& operator=(const OENonBondPotBase&)

     Assignment operator.

   .. _OEMolPotential_OENonBondPotBase_GetNonBondOptions:

   .. oe:method:: GetNonBondOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENonBondIntcsOptions& GetNonBondOptions()
            const OENonBondIntcsOptions& GetNonBondOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetNonBondOptions() -> OENonBondIntcsOptions

      Returns :oe:cls:`options<OEMolPotential::OENonBondIntcsOptions>` related to non-bonded interactions.

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEBinaryPredicate<OEChem::OEAtomBase, OEChem::OEAtomBase>& pred,
                  unsigned int flag = OEFuncType::All)

      This method can be used for interaction-level control of the non-bonded terms. Interactions between two 
      atoms are only included if the test of the binary predicate with both atoms returns ``true``. 
      The :oe:meth:`Set<OEMolPotential::OENonBondPotBase::Set>` method must be called before the 
      :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OENonBondPotential, OEMolFunc2

.. _OEMolPotential_OENonBondPotential:

.. oe:class:: OENonBondPotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OENonBondPotential : public virtual OENonBondPotBase

   The :ref:`OENonBondPotential <OEMolPotential_OENonBondPotential>` class defines an interface
   for calculation of intra-molecular non-bonded (both VdW and Coulomb) force field 
   interaction potentials.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`
    
   The following methods are publicly inherited from :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`:
    * :oe:meth:`GetNonBondOptions<OEMolPotential::OENonBondPotBase::GetNonBondOptions>`
    * :oe:meth:`Set<OEMolPotential::OENonBondPotBase::Set>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENonBondPotential(const OEMolPotential::OEFFParams& fp,
                               const OENonBondIntcsOptions& options = OENonBondIntcsOptions())
            OENonBondPotential(const OENonBondPotential&)

      .. oe:language:: python

         .. oe:api:: python

            OENonBondPotential(fp: OEFFParams,
                               options: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OENonBondPotential
            OENonBondPotential(arg2: OENonBondPotential) -> OENonBondPotential

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OENonBondPotential& operator=(const OENonBondPotential&)

     Assignment operator.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OENumericMolFunc2, NumericMolFunc2

.. _OEMolPotential_OENumericMolFunc2:

.. oe:class:: OENumericMolFunc2

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OENumericMolFunc2 : public OEMolFunc2

   The :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>` class converts a :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>`
   into a :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>` by providing numeric hessians.

   .. _figure_OENumericMolFunc2_Hierarchy:

   .. figure:: oefftk/images/OENumericMolFunc2.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>` class defines the following public methods:
    * :oe:meth:`Set<OEMolPotential::OENumericMolFunc2::Set>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENumericMolFunc2(OEMolFunc1 &, bool own = false)

      .. oe:language:: python

         .. oe:api:: python

            OENumericMolFunc2(argFunc1: OEMolFunc1, argOwn: bool = False) -> OENumericMolFunc2

      Default and copy constructors.

      The molecule function used for function evaluation and to be converted must be provided as the first argument to
      the constructor. The second argument specifies the scaling factor. The third argument specifies whether the 
      :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>` object takes ownership of the memory of the molecule
      function instance. By default that does not happen, so the :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>`
      destructor does not delete the molecule function instance. If ownership of the molecule function 
      is transferred to the :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>` instance, the molecule function's
      delete operator will be called in the :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>` destructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OENumericMolFunc2 & operator=(const OENumericMolFunc2 &)

      Assignment operator.

   

   .. oe:method:: Set

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Set(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& pred,
                     unsigned int functype)
            bool Set(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred,
                     unsigned int functype)
            bool Set(const OESystem::OEBinaryPredicate<OEChem::OEAtomBase, OEChem::OEAtomBase>& pred,
                     unsigned int functype)
            bool Set(const OESystem::OEBinaryPredicate<OEChem::OEBondBase, OEChem::OEBondBase>& pred,
                     unsigned int functype)

      .. oe:language:: python

         .. oe:api:: python

            Set(pred: OEUnaryBondPred, functype: int) -> bool
            Set(pred: OEUnaryAtomPred, functype: int) -> bool
            Set(pred: OEBinaryAtomPred, functype: int) -> bool
            Set(pred: OEBinaryBondPred, functype: int) -> bool

      Predicates are passed directly to the molecule function that is to be scaled.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. _OEMolPotential_OEOutOfPlaneParams:

.. oe:class:: OEOutOfPlaneParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class  OEOutOfPlaneParams : public OEMolPotential::OEInteractParams

   The :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>` class defines generic parameters for out-of-plane
   term which might be used in any force field.

   The following methods are publicly inherited from :ref:`OEInteractParams <OEMolPotential_OEInteractParams>`:
    * :oe:meth:`Clear<OEMolPotential::OEInteractParams::Clear>`
    * :oe:meth:`Get<OEMolPotential::OEInteractParams::Get>`
    * :oe:meth:`Set<OEMolPotential::OEInteractParams::Set>`

   The :ref:`OETorsionParams <OEMolPotential_OETorsionParams>` class defines the following public methods:
    * :oe:meth:`GetAtomIndex1<OEMolPotential::OEOutOfPlaneParams::GetAtomIndex1>`
    * :oe:meth:`GetAtomIndex2<OEMolPotential::OEOutOfPlaneParams::GetAtomIndex2>`
    * :oe:meth:`GetAtomIndex3<OEMolPotential::OEOutOfPlaneParams::GetAtomIndex3>`
    * :oe:meth:`GetAtomIndex4<OEMolPotential::OEOutOfPlaneParams::GetAtomIndex4>`
    * :oe:meth:`IsValid<OEMolPotential::OEOutOfPlaneParams::IsValid>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOutOfPlaneParams(const OEChem::OEAtomBase* atom1,
                               const OEChem::OEAtomBase* atom2,
                               const OEChem::OEAtomBase* atom3,
                               const OEChem::OEAtomBase* atom4,
                               const unsigned type = OEFormatType::AMBER)
            OEOutOfPlaneParams(const OEOutOfPlaneParams&)

      .. oe:language:: python

         .. oe:api:: python

            OEOutOfPlaneParams(atom1: OEAtomBase, atom2: OEAtomBase,
                               atom3: OEAtomBase, atom4: OEAtomBase, type: int) -> OEOutOfPlaneParams
            OEOutOfPlaneParams(arg2: OEOutOfPlaneParams) -> OEOutOfPlaneParams

      Constructor and copy constructor.
      Constructs an :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>` object for for atoms
      defining improper torsion passed as arguments. Second atom (second argument) is
      an atom which might occure above or beyond the plane make by 3 remaining atoms.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOutOfPlaneParams& operator=(const OEOutOfPlaneParams&)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetAtomIndex1

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex1() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex1() -> int

      Returns atom index of the first atom for an improper torsion for which the instance of
      :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>` was created.

   .. oe:method:: GetAtomIndex2

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex2() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex2() -> int

      Returns atom index of the second atom for an improper torsion for which the instance of
      :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>` was created.

   .. oe:method:: GetAtomIndex3

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex3() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex3() -> int

      Returns atom index of the third atom for an improper torsion for which the instance of
      :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>` was created.

   .. oe:method:: GetAtomIndex4

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex4() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex4() -> int

      Returns atom index of the forth atom for an improper torsion for which the instance of
      :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>` was created.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(pred: OEUnaryAtomPred) -> bool

      Method which checks if an instance of the :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>`
      class was created for the improper torsion to be included in force field calculation.
      Method provides a predicate which should be used to test all 4 atoms used to make this 
      instance.
      

       

 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEOutOfPlanePotential, OEMolFunc2

.. _OEMolPotential_OEOutOfPlanePotential:

.. oe:class:: OEOutOfPlanePotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEOutOfPlanePotential : public virtual OEMolPotential::OEFFPotential

   The :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>` defines an interface for
   all out-of-plane force field interaction potentials.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOutOfPlanePotential(const OEFFParams&)
            OEOutOfPlanePotential(const OEOutOfPlanePotential&)

      .. oe:language:: python

         .. oe:api:: python

            OEOutOfPlanePotential(fp: OEFFParams) -> OEOutOfPlanePotential
            OEOutOfPlanePotential(arg2: OEOutOfPlanePotential) -> OEOutOfPlanePotential

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OEOutOfPlanePotential& operator=(const OEOutOfPlanePotential&)

     Assignment operator.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEQuatAdaptor, QuatAdaptor

.. _OEMolPotential_OEQuatAdaptor:

.. oe:class:: OEQuatAdaptor

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEQuatAdaptor : public OEMolAdaptor

   The :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>` class provides the ability to rotate and translate
   a molecule as single rigid unit or solid body in the presence of an external field. Rotations
   are represented with quaternion variables.

   .. _figure_OEQuatAdaptor_Hierarchy:

   .. figure:: oefftk/images/OEQuatAdaptor.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEAdaptor <OEOpt_OEAdaptor>`:
    * :oe:meth:`AdaptVar<OEOpt::OEAdaptor::AdaptVar>` 
    * :oe:meth:`GetVar<OEOpt::OEAdaptor::GetVar>`

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`:
    * :oe:meth:`SetMolFunc<OEMolPotential::OEMolAdaptor::SetMolFunc>`

   The :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>` class defines the following public methods:
    * :oe:meth:`AdaptGrad<OEMolPotential::OEQuatAdaptor::AdaptGrad>`
    * :oe:meth:`IsRedundant<OEMolPotential::OEQuatAdaptor::IsRedundant>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEQuatAdaptor(OEMolFunc1 &, bool own = false,
                          bool excludeInteract = true)

      .. oe:language:: python

         .. oe:api:: python

            OEQuatAdaptor(arg2: OEMolFunc1, own: bool = False,
                          excludeInteract: bool = True) -> OEQuatAdaptor

      Default and copy constructors.

      Constructs an :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>` instance. The molecule function used
      for function evaluation must be provided as the first argument to the constructor. The 
      second argument specifies whether the :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>` object takes
      ownership of the memory of the molecule function instance. By default that does not happen,
      so the :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>` destructor does not delete the molecule function
      instance. If ownership of the molecule function is transferred to the
      :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>` instance, the molecule function's delete operator will
      be called in the :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>` destructor. The third argument
      controls the inclusion of invariant molecule function interactions. By default, interactions 
      which remain constant during the solid-body optimization (all intramolecular interactions)
      are excluded from calculation. If the third calling argument is ``false`` then all
      interactions will be computed during every function evaluation.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEQuatAdaptor & operator=(const OEQuatAdaptor &)

      Assignment operator.

   .. oe:method:: AdaptGrad

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AdaptGrad(double* qg, const double* g, const double* quat,
                           const double* coords) const

      .. oe:language:: python

         .. oe:api:: python

            AdaptGrad(qg: OEDoubleArray, g: OEDoubleArray, quat: OEDoubleArray,
                      coords: OEDoubleArray) -> bool

      Transforms a set of the input Cartesian gradients (second argument) into rotation and translation 
      gradients which are copied to the first argument array. Third and fourth arguments are the arrays 
      of quaternion plus translation vector and Cartesian coordinates respectively, used for the
      transformation.

   .. oe:method:: IsRedundant

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsRedundant(const double* x, const double* y,
                             const double tolerance = 0.1) const

      .. oe:language:: python

         .. oe:api:: python

            IsRedundant(x: OEDoubleArray, y: OEDoubleArray,
                        tolerance: float = 0.1) -> bool

      Compares two sets of quaternions-translational vectors coordinates. If points ``x`` and
      ``y`` represent the same point in Cartesian space within given tolerance, method returns
      ``true``.  



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEScaledMolFunc, ScaledMolFunc

.. _OEMolPotential_OEScaledMolFunc:

.. oe:class:: OEScaledMolFunc

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEScaledMolFunc : public OEMolFunc2

   The :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>` class allows scaling energies, gradients and hessians of
   a molecule function, with a specified constant.

   .. _figure_OEScaledMolFunc_Hierarchy:

   .. figure:: oefftk/images/OEScaledMolFunc.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>` class defines the following public methods:
    * :oe:meth:`Set<OEMolPotential::OEScaledMolFunc::Set>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEScaledMolFunc(OEMolFunc1 &, const double factor, bool own = false)
            OEScaledMolFunc(OEMolFunc2 &, const double factor, bool own = false)

      .. oe:language:: python

         .. oe:api:: python

            OEScaledMolFunc(argFunc: OEMolFunc1, argFactor: float,
                            argOwn: bool = False) -> OEScaledMolFunc
            OEScaledMolFunc(argFunc: OEMolFunc2, argFactor: float,
                            argOwn: bool = False) -> OEScaledMolFunc

      Default and copy constructors.

      The molecule function used for function evaluation and to be scaled must be provided as the first argument to
      the constructor. The second argument specifies the scaling factor. The third argument specifies whether the 
      :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>` object takes ownership of the memory of the molecule
      function instance. By default that does not happen, so the :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>`
      destructor does not delete the molecule function instance. If ownership of the molecule function 
      is transferred to the :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>` instance, the molecule function's
      delete operator will be called in the :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>` destructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEScaledMolFunc & operator=(const OEScaledMolFunc &)

      Assignment operator.

   

   .. oe:method:: Set

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Set(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& pred,
                     unsigned int functype)
            bool Set(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred,
                     unsigned int functype)
            bool Set(const OESystem::OEBinaryPredicate<OEChem::OEAtomBase, OEChem::OEAtomBase>& pred,
                     unsigned int functype)
            bool Set(const OESystem::OEBinaryPredicate<OEChem::OEBondBase, OEChem::OEBondBase>& pred,
                     unsigned int functype)

      .. oe:language:: python

         .. oe:api:: python

            Set(pred: OEUnaryBondPred, functype: int) -> bool
            Set(pred: OEUnaryAtomPred, functype: int) -> bool
            Set(pred: OEBinaryAtomPred, functype: int) -> bool
            Set(pred: OEBinaryBondPred, functype: int) -> bool

      Predicates are passed directly to the molecule function that is to be scaled.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. _OEMolPotential_OEStretchParams:

.. oe:class:: OEStretchParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class  OEStretchParams : public OEMolPotential::OEInteractParams

   The :ref:`OEStretchParams <OEMolPotential_OEStretchParams>` class defines generic bond stretch parameters
   used in any force field which has bond stretch term.

   The following methods are publicly inherited from :ref:`OEInteractParams <OEMolPotential_OEInteractParams>`:
    * :oe:meth:`Clear<OEMolPotential::OEInteractParams::Clear>`
    * :oe:meth:`Get<OEMolPotential::OEInteractParams::Get>`
    * :oe:meth:`Set<OEMolPotential::OEInteractParams::Set>`

   The :ref:`OEStretchParams <OEMolPotential_OEStretchParams>` class defines the following public methods:
    * :oe:meth:`GetAtomIndex1<OEMolPotential::OEStretchParams::GetAtomIndex1>`
    * :oe:meth:`GetAtomIndex2<OEMolPotential::OEStretchParams::GetAtomIndex2>`
    * :oe:meth:`IsValid<OEMolPotential::OEStretchParams::IsValid>`
    * :oe:meth:`IsBond<OEMolPotential::OEStretchParams::IsBond>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEStretchParams(const OEChem::OEBondBase* bond,
                            const unsigned type = OEFormatType::AMBER)
            OEStretchParams(const OEStretchParams&)

      .. oe:language:: python

         .. oe:api:: python

            OEStretchParams(bond: OEBondBase, type: int) -> OEStretchParams
            OEStretchParams(arg2: OEStretchParams) -> OEStretchParams

      Constructor and copy constructor.
      Constructs an :ref:`OEStretchParams <OEMolPotential_OEStretchParams>` object for the bond passed as argument.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEStretchParams& operator=(const OEStretchParams&)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetAtomIndex1

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex1() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex1() -> int

      Returns atom index of the first atom making a bond for which the instance of
      :ref:`OEStretchParams <OEMolPotential_OEStretchParams>` was created.

   .. oe:method:: GetAtomIndex2

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex2() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex2() -> int

      Returns atom index of the second atom making a bond for which the instance of
      :ref:`OEStretchParams <OEMolPotential_OEStretchParams>` was created.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred) const
            bool IsValid(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(pred: OEUnaryAtomPred) -> bool
            IsValid(pred: OEUnaryBondPred) -> bool

      Methods which check if an instance of the :ref:`OEStretchParams <OEMolPotential_OEStretchParams>`
      class was created for a bond to be included in force field calculation. The first 
      method provides a predicate which tests each of the 2 atoms belonging to a bond
      for which the above instance was created, while the second method provides a 
      predicate which tests a particular bond. 

   .. oe:method:: IsBond

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsBond(const OEChem::OEBondBase* bond) const

      .. oe:language:: python

         .. oe:api:: python

            IsBond(bond: OEBondBase) -> bool

      Used to check if the bond passed as an argument belongs to the current 
      :ref:`OEStretchParams <OEMolPotential_OEStretchParams>` instance.
       

 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEStretchPotential, OEMolFunc2

.. _OEMolPotential_OEStretchPotential:

.. oe:class:: OEStretchPotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEStretchPotential : public virtual OEMolPotential::OEFFPotential

   The :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>` defines an interface
   all bond stretching force field interaction potentials.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`
    
   The :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>` implements the following methods:
    * :oe:meth:`Set<OEMolPotential::OEStretchPotential::Set>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEStretchPotential(const OEFFParams&)
            OEStretchPotential(const OEStretchPotential&)

      .. oe:language:: python

         .. oe:api:: python

            OEStretchPotential(fp: OEFFParams) -> OEStretchPotential
            OEStretchPotential(arg2: OEStretchPotential) -> OEStretchPotential

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OEStretchPotential& operator=(const OEStretchPotential&)

     Assignment operator.

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>&,
                  unsigned int flag = OEFuncType::Stretch) override

      This method can be used for interaction-level control of the bond stretching terms. Interactions between two 
      atoms are only included if the test of the unary bond predicate returns ``true``. 
      The :oe:meth:`Set<OEMolPotential::OEStretchPotential::Set>` method must be called before the 
      :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OESubsetAdaptor, SubsetAdaptor

.. _OEMolPotential_OESubsetAdaptor:

.. oe:class:: OESubsetAdaptor

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESubsetAdaptor : public OEMolAdaptor2

   The :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>` class allows optimization of Cartesian coordinates
   for a subset of atoms in a molecule, while the remaining atoms are fixed. This is accomplished
   by subsetting the coordinates and gradients into the subsets which correspond to atoms being
   optimized. Additional facilities are provided for excluding invariant molecule function interactions, 
   and controlling which subset of atoms are held fixed during an optimization.

   .. _figure_OESubsetAdaptor_Hierarchy:

   .. figure:: oefftk/images/OESubsetAdaptor.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEAdaptor <OEOpt_OEAdaptor>`:
    * :oe:meth:`AdaptVar<OEOpt::OEAdaptor::AdaptVar>` 
    * :oe:meth:`GetVar<OEOpt::OEAdaptor::GetVar>`

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`:
    * :oe:meth:`SetMolFunc<OEMolPotential::OEMolAdaptor::SetMolFunc>`

   The following methods are publicly inherited from :ref:`OEMolAdaptor2 <OEMolPotential_OEMolAdaptor2>`:
    * :oe:meth:`SetMolFunc<OEMolPotential::OEMolAdaptor2::SetMolFunc2>`

   The :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>` class defines the following public methods:
    * :oe:meth:`AdaptGrad<OEMolPotential::OESubsetAdaptor::AdaptGrad>`
    * :oe:meth:`AdaptHessian<OEMolPotential::OESubsetAdaptor::AdaptHessian>`
    * :oe:meth:`Set<OEMolPotential::OESubsetAdaptor::Set>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESubsetAdaptor(OEMolFunc1 &, bool own = false,
                            bool excludeInteract = true)
            OESubsetAdaptor(OEMolFunc2 &, bool own = false,
                            bool excludeInteract = true)

      .. oe:language:: python

         .. oe:api:: python

            OESubsetAdaptor(arg2: OEMolFunc1, own: bool = False,
                            excludeInteract: bool = True) -> OESubsetAdaptor
            OESubsetAdaptor(arg2: OEMolFunc2, own: bool = False,
                            excludeInteract: bool = True) -> OESubsetAdaptor

      Default and copy constructors.

      The molecule function used for function evaluation must be provided as the first argument to
      the constructor. The second argument specifies whether the 
      :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>` object takes ownership of the memory of the molecule
      function instance. By default that does not happen, so the :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`
      destructor does not delete the molecule function instance. If ownership of the molecule function 
      is transferred to the :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>` instance, the molecule function's
      delete operator will be called in the :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>` destructor.
      The third argument controls the inclusion of invariant molecule function interactions. By default, 
      interactions which remain constant during the optimization are excluded from calculation.  
      Interactions composed entirely of atoms held fixed during the optimization will not change during 
      the optimization. Excluding invariant interactions does not affect the optimization, however, 
      the total energy calculated for a set of coordinates will be altered by the exclusion.  If the 
      third calling argument is ``false`` then all interactions will be computed during every function 
      evaluation.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESubsetAdaptor & operator=(const OESubsetAdaptor &)

      Assignment operator.

   

   .. oe:method:: AdaptGrad

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AdaptGrad(double* ga, const double* g) const

      .. oe:language:: python

         .. oe:api:: python

            AdaptGrad(ga: OEDoubleArray, g: OEDoubleArray) -> bool

      Takes a set of gradients from a molecule function evaluation as the second argument, and subsets 
      the gradients into the array passed as the first argument.

   .. oe:method:: AdaptHessian

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AdaptHessian(double* ha, const double* h) const

      .. oe:language:: python

         .. oe:api:: python

            AdaptHessian(he: OEDoubleArray, h: OEDoubleArray) -> bool

      Takes a set of hessians from a molecule function evaluation as the second argument, and subsets 
      the hessians into the array passed as the first argument.

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>&,
                  unsigned int functype = OEFuncType::SubsetAdapt);)

      This method assigns an atom predicate which is used to specify atoms which are to be held fixed in their starting positions during an optimization. The :oe:meth:`Set<OEMolPotential::OESubsetAdaptor::Set>` method must be called before the :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OETorAdaptor, TorAdaptor

.. _OEMolPotential_OETorAdaptor:

.. oe:class:: OETorAdaptor

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OETorAdaptor : public OEMolAdaptor

   The :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>` class provides the ability to optimize torsion angles
   of a molecule while holding bond lengths and bond angles fixed. :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>`
   derived classes typically require Cartesian coordinates for function evaluation. 
   :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>` transforms a set of torsions into Cartesian coordinates,
   passes the resultant coordinates to the internally stored :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>`
   type function, and transforms the Cartesian gradients back into torsion gradients. Additional
   facilities are provided for excluding invariant molecule function interactions, controlling the 
   definition of a rotatable bond, and fixing atomic positions during coordinate transformation.

   .. _figure_OETorAdaptor_Hierarchy:

   .. figure:: oefftk/images/OETorAdaptor.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEAdaptor <OEOpt_OEAdaptor>`:
    * :oe:meth:`AdaptVar<OEOpt::OEAdaptor::AdaptVar>` 
    * :oe:meth:`GetVar<OEOpt::OEAdaptor::GetVar>`

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`:
    * :oe:meth:`SetMolFunc<OEMolPotential::OEMolAdaptor::SetMolFunc>`

   The :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>` class defines the following public methods:
    * :oe:meth:`AdaptGrad<OEMolPotential::OETorAdaptor::AdaptGrad>`
    * :oe:meth:`Set<OEMolPotential::OETorAdaptor::Set>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorAdaptor(OEMolFunc1 &, bool own = false,
                         bool excludeInteract = true)

      .. oe:language:: python

         .. oe:api:: python

            OETorAdaptor(arg2: OEMolFunc1, own: bool = False,
                         excludeInteract: bool = True) -> OETorAdaptor

      Default and copy constructors.

      Constructs an :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>` instance. The molecule function used
      for function evaluation must be provided as the first argument to the constructor. The second 
      argument specifies whether the :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>` object takes ownership
      of the memory of the molecule function instance. By default the 
      :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>` instance does not take ownership of the molecule function,
      so the :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>` destructor does not delete the molecule function
      instance. If ownership of the molecule function is transferred to the 
      :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>` instance, the molecule function's delete operator will
      be called in the :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>` destructor. The third argument
      controls the inclusion of invariant molecule function interactions. By default, interactions 
      which remain constant during the torsion minimization are excluded from calculation (for 
      example  bond stretch interactions). If the third calling argument is ``false`` then all
      interactions will be computed during every function evaluation.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETorAdaptor & operator=(const OETorAdaptor &)

      Assignment operator.

   

   .. oe:method:: AdaptGrad

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AdaptGrad(double* torGrad, const double* grads) const

      .. oe:language:: python

         .. oe:api:: python

            AdaptGrad(torGrad: OEDoubleArray, grads: OEDoubleArray) -> bool

      Takes a set of Cartesian gradients of a conformer (second argument), and transforms them into 
      angular torsion gradients (first  argument). 

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &p,
                  unsigned int functype = OEFuncType::TorAdapt)
         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEBondBase> &rot,
                  unsigned int functype = OEFuncType::TorAdapt)

      The first method assigns an atom predicate which is used to specify atoms which are to be held fixed in their starting positions during an optimization. The second method assigns a bond predicate which is used to determine which bonds of a molecule are to be rotated during an optimization. Both the :oe:meth:`Set<OEMolPotential::OETorAdaptor::Set>` methods must be called before the :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.     


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OETorQuatAdaptor, TorQuatAdaptor

.. _OEMolPotential_OETorQuatAdaptor:

.. oe:class:: OETorQuatAdaptor

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OETorQuatAdaptor : public OEMolAdaptor

   The :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>` class provides the ability to optimize a molecule
   in coordinate space by a combination of rotation, translation and torsion changes.
   This class combines the functionality of both :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>` and
   :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>` classes. Its main application is optimization of ligands
   in the potential generated by protein-receptor, in the case when ligand's bond lengths and 
   bond angles are chosen to be fixed.

   .. _figure_OETorQuatAdaptor_Hierarchy:

   .. figure:: oefftk/images/OETorQuatAdaptor.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEAdaptor <OEOpt_OEAdaptor>`:
    * :oe:meth:`AdaptVar<OEOpt::OEAdaptor::AdaptVar>` 
    * :oe:meth:`GetVar<OEOpt::OEAdaptor::GetVar>`

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`:
    * :oe:meth:`SetMolFunc<OEMolPotential::OEMolAdaptor::SetMolFunc>`

   The :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>` class defines the following public methods:
    * :oe:meth:`AdaptGrad<OEMolPotential::OETorQuatAdaptor::AdaptGrad>`
    * :oe:meth:`Set<OEMolPotential::OETorQuatAdaptor::Set>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorQuatAdaptor(OEMolFunc1 &, bool own = false,
                             bool excludeInteract = true)

      .. oe:language:: python

         .. oe:api:: python

            OETorQuatAdaptor(arg2: OEMolFunc1, own: bool = False,
                             excludeInteract: bool = True) -> OETorQuatAdaptor

      Default and copy constructors.

      The molecule function used for function evaluation must be provided as the first argument to the 
      constructor. The second argument specifies whether the :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>`
      object takes ownership of the memory of the molecule function instance. By default the
      :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>` instance does not take ownership of the molecule function,
      so the :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>` destructor does not delete the molecule function
      instance. If ownership of the molecule function is transferred to the
      :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>` instance, the molecule function's delete operator will
      be called in the :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>` destructor. The third argument
      controls the inclusion of invariant molecule function interactions. By default, interactions
      which remain constant during the torsion minimization are excluded from calculation (for
      example  bond stretch interactions). If the third calling argument is ``false`` then all
      interactions will be computed during every function evaluation.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETorQuatAdaptor & operator=(const OETorQuatAdaptor &)

      Assignment operator.

   

   .. oe:method:: AdaptGrad

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AdaptGrad(double *, const double *, const double *) const

      .. oe:language:: python

         .. oe:api:: python

            AdaptGrad(arg2: OEDoubleArray, arg3: OEDoubleArray,
                      arg4: OEDoubleArray) -> bool

      Transforms a set of the input Cartesian gradients passed to the method as a second argument,
      into torsional-rotational-translational gradients which are copied to the first argument array.
      The third argument to the method is an array of the current quaternion and translational vector. 

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &p,
                  unsigned int f = OEFuncType::TorAdapt)
         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEBondBase> &p,
                  unsigned int f = OEFuncType::TorAdapt)

      The first method assigns an atom predicate which is used to specify atoms which are to be held fixed in their starting positions during an optimization. The second method assigns a bond predicate which is used to determine which bonds of a molecule are to be rotated during an optimization. Both the :oe:meth:`Set<OEMolPotential::OETorQuatAdaptor::Set>` methods must be called before the :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. _OEMolPotential_OETorsionParams:

.. oe:class:: OETorsionParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class  OETorsionParams : public OEMolPotential::OEInteractParams

   The :ref:`OETorsionParams <OEMolPotential_OETorsionParams>` class defines generic torsion parameters
   used in any force field which has torsion term.

   The following methods are publicly inherited from :ref:`OEInteractParams <OEMolPotential_OEInteractParams>`:
    * :oe:meth:`Clear<OEMolPotential::OEInteractParams::Clear>`
    * :oe:meth:`Get<OEMolPotential::OEInteractParams::Get>`
    * :oe:meth:`Get<OEMolPotential::OEInteractParams::GetList>`
    * :oe:meth:`Set<OEMolPotential::OEInteractParams::Set>`
    * :oe:meth:`Set<OEMolPotential::OEInteractParams::SetList>`

   The :ref:`OETorsionParams <OEMolPotential_OETorsionParams>` class defines the following public methods:
    * :oe:meth:`GetAtomIndex1<OEMolPotential::OETorsionParams::GetAtomIndex1>`
    * :oe:meth:`GetAtomIndex2<OEMolPotential::OETorsionParams::GetAtomIndex2>`
    * :oe:meth:`GetAtomIndex3<OEMolPotential::OETorsionParams::GetAtomIndex3>`
    * :oe:meth:`GetAtomIndex4<OEMolPotential::OETorsionParams::GetAtomIndex4>`
    * :oe:meth:`IsValid<OEMolPotential::OETorsionParams::IsValid>`
    * :oe:meth:`IsTorsion<OEMolPotential::OETorsionParams::IsTorsion>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorsionParams(const OEChem::OEBondBase* bond, const OEChem::OEAtomBase* atom1,
            const OEChem::OEAtomBase* atom2, const unsigned type = OEFormatType::AMBER)
            OETorsionParams(const OETorsionParams&)

      .. oe:language:: python

         .. oe:api:: python

            OETorsionParams(bond: OEBondBase, atom1: OEAtomBase,
                            atom2: OEAtomBase, type: int) -> OETorsionParams
            OETorsionParams(arg2: OETorsionParams) -> OETorsionParams

      Constructor and copy constructor.
      Constructs an :ref:`OETorsionParams <OEMolPotential_OETorsionParams>` object for a middle bond
      passed as the first argument and two terminal atoms (second and third arguments).

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETorsionParams& operator=(const OETorsionParams&)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetAtomIndex1

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex1() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex1() -> int

      Returns atom index of the first atom for a torsion for which the instance of
      :ref:`OETorsionParams <OEMolPotential_OETorsionParams>` was created.

   .. oe:method:: GetAtomIndex2

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex2() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex2() -> int

      Returns atom index of the second atom for a torsion for which the instance of
      :ref:`OETorsionParams <OEMolPotential_OETorsionParams>` was created.

   .. oe:method:: GetAtomIndex3

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex3() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex3() -> int

      Returns atom index of the third atom for a torsion for which the instance of
      :ref:`OETorsionParams <OEMolPotential_OETorsionParams>` was created.

   .. oe:method:: GetAtomIndex4

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex4() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex4() -> int

      Returns atom index of the forth atom for a torsion for which the instance of
      :ref:`OETorsionParams <OEMolPotential_OETorsionParams>` was created.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const
            bool IsValid(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred) const
            bool IsValid(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool
            IsValid(pred: OEUnaryAtomPred) -> bool
            IsValid(pred: OEUnaryBondPred) -> bool

      Methods which check if an instance of the :ref:`OETorsionParams <OEMolPotential_OETorsionParams>`
      class was created for the torsion to be included in force field calculation.
      First method is checking if the above instance was correctly constructed, while
      two remaining methods provide predicates which test if atoms (second method) and
      a middle bond (third method) belong to that instance.
      
   .. oe:method:: IsTorsion

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsTorsion(const OEChem::OEAtomBase* atom1, const OEChem::OEAtomBase* atom2,
            const OEChem::OEAtomBase* atom3, const OEChem::OEAtomBase* atom4) const

      .. oe:language:: python

         .. oe:api:: python

            IsTorsion(atom1: OEAtomBase, atom2: OEAtomBase, atom3: OEAtomBase,
                      atom4: OEAtomBase) -> bool

      Used to check if 4 atoms passed as arguments belong to the current 
      :ref:`OETorsionParams <OEMolPotential_OETorsionParams>` instance.
       

 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OETorsionPotential, OEMolFunc2

.. _OEMolPotential_OETorsionPotential:

.. oe:class:: OETorsionPotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OETorsionPotential : public virtual OEMolPotential::OEFFPotential

   The :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>` defines an interface for
   all torsional force field interaction potentials.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`
    
   The :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>` implements the following methods:
    * :oe:meth:`Set<OEMolPotential::OETorsionPotential::Set>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETorsionPotential(const OEFFParams&)
            OETorsionPotential(const OETorsionPotential&)

      .. oe:language:: python

         .. oe:api:: python

            OETorsionPotential(fp: OEFFParams) -> OETorsionPotential
            OETorsionPotential(arg2: OETorsionPotential) -> OETorsionPotential

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OETorsionPotential& operator=(const OETorsionPotential&)

     Assignment operator.

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEBinaryPredicate<OEChem::OEBondBase, OEChem::OEBondBase>&)

      This method provides interaction-level control of the torsion terms. The method tests the central 
      bond of a torsion angle. If such a bond returns `true` from the predicate test then all torsions 
      that cross the bond are included in the list of interactions to be calculated. 
      The :oe:meth:`Set<OEMolPotential::OETorsionPotential::Set>` method must be called before 
      the :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. _OEMolPotential_OEVdwParams:

.. oe:class:: OEVdwParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class  OEVdwParams : public OEMolPotential::OEInteractParams

   The :ref:`OEVdwParams <OEMolPotential_OEVdwParams>` class defines generic vdw  parameters
   used in any force field which has Lennard-Jones 6-12 (or similar 7-14) non-bonded term.

   The following methods are publicly inherited from :ref:`OEInteractParams <OEMolPotential_OEInteractParams>`:
    * :oe:meth:`Clear<OEMolPotential::OEInteractParams::Clear>`
    * :oe:meth:`Get<OEMolPotential::OEInteractParams::Get>`
    * :oe:meth:`Set<OEMolPotential::OEInteractParams::Set>`

   The :ref:`OEVdwParams <OEMolPotential_OEVdwParams>` class defines the following public methods:
    * :oe:meth:`GetAtomIndex1<OEMolPotential::OEVdwParams::GetAtomIndex1>`
    * :oe:meth:`GetAtomIndex2<OEMolPotential::OEVdwParams::GetAtomIndex2>`
    * :oe:meth:`GetAtom1<OEMolPotential::OEVdwParams::GetAtom1>`
    * :oe:meth:`GetAtom2<OEMolPotential::OEVdwParams::GetAtom2>`
    * :oe:meth:`IsValid<OEMolPotential::OEVdwParams::IsValid>`
    * :oe:meth:`IsPair<OEMolPotential::OEVdwParams::IsPair>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEVdwParams(const OEChem::OEAtomBase* atom1,
                        const OEChem::OEAtomBase* atom2,
                        const unsigned type = OEFormatType::AMBER)
            OEVdwParams& operator=(const OEVdwParams&)

      .. oe:language:: python

         .. oe:api:: python

            OEVdwParams(atom1: OEAtomBase, atom2: OEAtomBase, type: int) -> OEVdwParams
            OEVdwParams(arg2: OEVdwParams) -> OEVdwParams

      Constructor and copy constructor.
      Constructs an :ref:`OEVdwParams <OEMolPotential_OEVdwParams>` object for a pair of atoms passed as
      arguments. 

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEVdwParams& operator=(const OEVdwParams&)

      The assignment operator.

      Assignment operator.

   .. oe:method:: GetAtomIndex1

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex1() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex1() -> int

      Returns atom index of the first atom from non-bonded interacting pair for which the instance of
      :ref:`OEVdwParams <OEMolPotential_OEVdwParams>` was created.

   .. oe:method:: GetAtomIndex2

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAtomIndex2() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex2() -> int

      Returns atom index of the second atom from non-bonded interacting pair for which the instance of
      :ref:`OEVdwParams <OEMolPotential_OEVdwParams>` was created.

   .. oe:method:: GetAtom1

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEAtomBase* GetAtom1() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtom1() -> OEAtomBase

      Returns the first atom from non-bonded interacting pair for which the instance of
      :ref:`OEVdwParams <OEMolPotential_OEVdwParams>` was created.

   .. oe:method:: GetAtom2

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OEAtomBase* GetAtom2() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtom2() -> OEAtomBase

      Returns the second atom from non-bonded interacting pair for which the instance of
      :ref:`OEVdwParams <OEMolPotential_OEVdwParams>` was created.

   .. oe:method:: IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred) const
            bool IsValid(const OESystem::OEBinaryPredicate<OEChem::OEAtomBase, OEChem::OEAtomBase>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(pred: OEUnaryAtomPred) -> bool
            IsValid(pred: OEBinaryAtomPred) -> bool

      Methods which check if an instance of the :ref:`OEVdwParams <OEMolPotential_OEVdwParams>`
      class was created for a pair of non-bonded atoms to be included in force field calculation. 
      The first method provides a predicate which is used to test individually each of the two atoms 
      from the non-boned pair, while the second method provides a predicate which tests a non-bonded 
      pair of atoms in a single test. 

   .. oe:method:: IsPair

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsPair(const OEChem::OEAtomBase* atom1,
                        const OEChem::OEAtomBase* atom2) const

      .. oe:language:: python

         .. oe:api:: python

            IsPair(atom1: OEAtomBase, atom2: OEAtomBase) -> bool

      Used to check if atoms passed as arguments belong to the current 
      :ref:`OEStretchParams <OEMolPotential_OEStretchParams>` instance.
       

 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEVdwPotential, OEMolFunc2

.. _OEMolPotential_OEVdwPotential:

.. oe:class:: OEVdwPotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEVdwPotential : public virtual OENonBondPotBase

   The :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>` class defines an interface
   for calculation of intra-molecular VdW force field 
   interaction potentials.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`
    
   The following methods are publicly inherited from :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`:
    * :oe:meth:`GetNonBondOptions<OEMolPotential::OENonBondPotBase::GetNonBondOptions>`
    * :oe:meth:`Set<OEMolPotential::OENonBondPotBase::Set>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEVdwPotential(const OEMolPotential::OEFFParams& fp,
                           const double rcut = 0.0)
            OEVdwPotential(const OEVdwPotential&)

      .. oe:language:: python

         .. oe:api:: python

            OEVdwPotential(fp: OEFFParams, rcut: float = 0.0) -> OEVdwPotential
            OEVdwPotential(arg2: OEVdwPotential) -> OEVdwPotential

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OEVdwPotential& operator=(const OEVdwPotential&)

     Assignment operator.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. oe:constnamespace:: OEFFParam

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants used to define integer constants,
   associated with :ref:`OEInteractParams <OEMolPotential_OEInteractParams>`,
   that are used to retrieve force field parameters.
   
   .. oe:constant:: r0
   
      Equilibrium bond length.

   .. oe:constant:: EqDist
   
      Equilibrium bond length.

   .. oe:constant:: EqDistance
   
      Equilibrium bond length.

   .. oe:constant:: StretchConst
   
      Bond stretching constant.

   .. oe:constant:: k
   
      Bond stretching constant.

   .. oe:constant:: rij
   
      Radius parameter in van der Waals potential.

   .. oe:constant:: rij

      Square of radius parameter in van der Waals potential.

   .. oe:constant:: ContactDist
   
      Radius parameter in van der Waals potential.

   .. oe:constant:: Epsilon
   
      Energy parameter in van der Waals potential.

   .. oe:constant:: eps
   
      Energy parameter in van der Waals potential.
  
   .. oe:constant:: a0
   
      Equilibrium bending angle.

   .. oe:constant:: EqAngle
   
      Equilibrium bending angle.

   .. oe:constant:: BendConst
   
      Angle bending constant.

   .. oe:constant:: ka
   
      Angle bending constant.

   .. oe:constant:: kb1
   
      First constant term in the stretch-bend potential.

   .. oe:constant:: StretchBendConst1
   
      First constant term in the stretch-bend potential.

   .. oe:constant:: StretchBendConst2
   
      Second constant term in the stretch-bend potential.

   .. oe:constant:: kb2
   
      Second constant term in the stretch-bend potential.

   .. oe:constant:: r1
   
      First distance term in the stretch-bend potential.

   .. oe:constant:: r2
   
      Second distance term in the stretch-bend potential.

   .. oe:constant:: OutOfPlaneConst
   
      Out-of-plane potential constant.

   .. oe:constant:: OOP
   
      Out-of-plane potential constant.

   .. oe:constant:: ko
   
      Out-of-plane potential constant.

   .. oe:constant:: V1
   
      First constant term in torsion potential.

   .. oe:constant:: V2
   
      Second constant term in torsion potential.

   .. oe:constant:: V3
   
      Third constant term in torsion potential.

   .. oe:constant:: v1
   
      First constant term in torsion potential.

   .. oe:constant:: v2
   
      Second constant term in torsion potential.

   .. oe:constant:: v3
   
      Third constant term in torsion potential.

   .. oe:constant:: p1

      Periodicity of improper torsion (used in SMIRNOFF)

   .. oe:constant:: ph1

      Phase of improper torsion (used in SMIRNOFF)

   .. oe:constant:: ntt

      Number of terms in torsion Fourier expansion

   .. oe:constant:: listKv

      Identifies vector which stores torsion barrier heights 

   .. oe:constant:: listDv

      Identifies vector which stores a set of torsion degeneracies

   .. oe:constant:: listPv

      Identifies vector which stores a set of torsion periodicities

   .. oe:constant:: listPhv

      Identifies vector which stores a set of torsion phases

   


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. oe:constnamespace:: OEFuncType

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants which define the type of force field potential components
   which might be used separately or in combination for the energy estimation of a molecular
   system. Constants defined below are passed to the methods 
   :oe:meth:`OEMolPotential::OEMolFunc::Set` as a second parameter.   

   .. oe:constant:: Undefined
   
      Undefined potential type. 

   .. oe:constant:: VdW
   
      Defines vdW potential type represented by the 
      :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>` class.

   .. oe:constant:: VdWRepel
   
      Same as above but without long range attractive forces. 

   .. oe:constant:: Coulomb
   
      Defines Coulomb potential type represented by the 
      :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>` class.

   .. oe:constant:: Bond

      Defines bond stretching potential type represented by the 
      :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>` class.

   .. oe:constant:: Stretch

      Same as above

   .. oe:constant:: Bend

      Defines angle bending potential type represented by the 
      :ref:`OEBendPotential <OEMolPotential_OEBendPotential>` class.

   .. oe:constant:: StretchBend

      Defines angle-stretch coupling potential type represented by the 
      :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>` class.

   .. oe:constant:: Torsion

      Defines torsion potential type represented by the 
      :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>` class.
 
   .. oe:constant:: ImproperTorsion

      Defines improper torsion potential type represented by the 
      :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>` class.

   .. oe:constant:: OutOfPlane

      Same as above.

   .. oe:constant:: All

      Defines a combination of all 7 above components.

   .. oe:constant:: AllRepel

      Same as above with a modified vdW component of the 
      :oe:const:`OEMolPotential::OEFuncType::VdWRepel` type.

   .. oe:constant:: InterMolVdW

      Defines intermolecular vdW potential type represented by the 
      :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>` class.

   .. oe:constant:: InterMolCoulomb

      Defines intermolecular Coulomb potential type represented by the 
      :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>` class.

   .. oe:constant:: TorAdapt

      Defines torsion adaptor potential type represented by the 
      :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>` class.

   .. oe:constant:: QuatAdapt

      Defines quaternion adaptor potential type represented by the
      :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>` class.

   .. oe:constant:: SubsetAdapt

      Defines subset adaptor potential type represented by the
      :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>` class.
 
   .. oe:constant:: SubsetAdaptor

      Same as above.

   .. oe:constant:: InterAdapt

      Defines internal coordinates adaptor potential type represented by the
      :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>` class.

   .. oe:constant:: HarmonicPot

      Defines harmonic potential type represented by the
      :ref:`OEHarmonicPotential <OEConstr_OEHarmonicPotential>` class.

   .. oe:constant:: Sheffield

      Defines Sheffield solvation potential type represented by the
      :ref:`OESheffield <OESheff_OESheffield>` class.
   

      
      

       


.. _OEMolPotentialConstants:

********************************
OEMolPotential Constants
********************************

.. oe:namespace:: OEMolPotential

.. toctree::

   OEFFParam
   OEVarType
   OEFuncType


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolPotential

.. oe:constnamespace:: OEVarType

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants which define the type of molecular coordinates
   to be optimized. 

   .. oe:constant:: SolidBody
   
      Defines 6 degrees of freedom: 3 translations and 3 rotations.
      Because rotations are represented with quaternions, the total number of variables
      is 7.

   .. oe:constant:: Torsions
   
      Torsional coordinates which are defined as hindered rotations around single bonds.
      Molecule has as many torsions as the number of rotatable bonds.

   .. oe:constant:: Cart
   
      3N Cartesian coordinates where N is the number of atoms in the molecule.

   .. oe:constant:: TranRotTor
   
      A combination of SolidBody and Torsions defined above, usually used for the 
      optimization of a ligand inside the protein binding site.



.. _OEMolSmirnoffClasses:

****************************************
OEMolSmirnoff Classes
****************************************

.. oe:namespace:: OEMolSmirnoff

.. toctree::

   OEParsley
   OEParsleyParams
   OESage
   OESageParams
   OESmirnoff
   OESmirnoffParams
   OESmirnoffData
   OESmirnoffStretchData
   OESmirnoffBendData
   OESmirnoffTorsionData
   OESmirnoffImproperData
   OESmirnoffVdWData

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolSmirnoff

.. _OEMolSmirnoff_OEParsley:

.. oe:class:: OEParsley

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEParsley : public OESmirnoff

   The :ref:`OEParsley <OEMolSmirnoff_OEParsley>` class facilitates creation of an instance of Parsley
   force field.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEForceField <OEMolPotential_OEForceField>`:
    * :oe:meth:`GetTitle<OEMolPotential::OEForceField::GetTitle>` and
      :oe:meth:`SetTitle<OEMolPotential::OEForceField::SetTitle>`
    * :oe:meth:`HasCoulomb<OEMolPotential::OEForceField::HasCoulomb>`
    * :oe:meth:`HasInternalCharges<OEMolPotential::OEForceField::HasInternalCharges>`
    * :oe:meth:`PrepMol<OEMolPotential::OEForceField::PrepMol>`
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`
    * :oe:meth:`SetNonBondCutoff<OEMolPotential::OEForceField::SetNonBondCutoff>`

   The following methods are publicly inherited from :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF2::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF2::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF2::RemoveMolFunc>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEParsley(const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OEParsley(const OEParsley&)

      .. oe:language:: python

         .. oe:api:: python

            OEParsley(opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OEParsley
            OEParsley(arg2: OEParsley) -> OEParsley

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEParsley& operator=(const OEParsley&)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolSmirnoff

.. _OEMolSmirnoff_OEParsleyParams:

.. oe:class:: OEParsleyParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEParsleyParams : public OESmirnoffParams

   The :ref:`OEParsleyParams <OEMolSmirnoff_OEParsleyParams>` class provides the ability to retrieve
   parameters necessary to perform energy and gradient calculations using the 
   :ref:`OEParsley <OEMolSmirnoff_OEParsley>` force field.

   The following methods are publicly inherited from :ref:`OEFFParams <OEMolPotential_OEFFParams>`:
    * :oe:meth:`CreateCopy<OEMolPotential::OEFFParams::CreateCopy>`
    * :oe:meth:`GetCoulombParams<OEMolPotential::OEFFParams::GetCoulombParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`
    * :oe:meth:`GetEquilibriumAngle<OEMolPotential::OEFFParams::GetEquilibriumAngle>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>`
    * :oe:meth:`GetEquilibriumBondLength<OEMolPotential::OEFFParams::GetEquilibriumBondLength>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`GetVdwRadius<OEMolPotential::OEFFParams::GetVdwRadius>`
    * :oe:meth:`GetContactDistance<OEMolPotential::OEFFParams::GetContactDistance>`
    * :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`
    * :oe:meth:`PrepMol<OEMolPotential::OEFFParams::PrepMol>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`HasVdwParams<OEMolPotential::OEFFParams::HasVdwParams>`
    * :oe:meth:`HasStretchParams<OEMolPotential::OEFFParams::HasStretchParams>`
    * :oe:meth:`HasBendParams<OEMolPotential::OEFFParams::HasBendParams>`
    * :oe:meth:`HasTorsionParams<OEMolPotential::OEFFParams::HasTorsionParams>`
    * :oe:meth:`GetTitle<OEMolPotential::OEFFParams::GetTitle>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEParsleyParams()
            OEParsleyParams(const OEParsleyParams&)

      .. oe:language:: python

         .. oe:api:: python

            OEParsleyParams() -> OEParsleyParams
            OEParsleyParams(arg2: OEParsleyParams) -> OEParsleyParams

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEParsleyParams& operator=(const OEParsleyParams&)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolSmirnoff

.. _OEMolSmirnoff_OESage:

.. oe:class:: OESage

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESage : public OESmirnoff

   The :ref:`OESage <OEMolSmirnoff_OESage>` class facilitates creation of an instance of Sage
   force field.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEForceField <OEMolPotential_OEForceField>`:
    * :oe:meth:`GetTitle<OEMolPotential::OEForceField::GetTitle>` and
      :oe:meth:`SetTitle<OEMolPotential::OEForceField::SetTitle>`
    * :oe:meth:`HasCoulomb<OEMolPotential::OEForceField::HasCoulomb>`
    * :oe:meth:`HasInternalCharges<OEMolPotential::OEForceField::HasInternalCharges>`
    * :oe:meth:`PrepMol<OEMolPotential::OEForceField::PrepMol>`
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`
    * :oe:meth:`SetNonBondCutoff<OEMolPotential::OEForceField::SetNonBondCutoff>`

   The following methods are publicly inherited from :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF2::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF2::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF2::RemoveMolFunc>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESage(const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OESage(const OESage&)

      .. oe:language:: python

         .. oe:api:: python

            OESage(opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OESage
            OESage(arg2: OESage) -> OESage

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESage& operator=(const OESage&)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolSmirnoff

.. _OEMolSmirnoff_OESageParams:

.. oe:class:: OESageParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESageParams : public OESmirnoffParams

   The :ref:`OESageParams <OEMolSmirnoff_OESageParams>` class provides the ability to retrieve
   parameters necessary to perform energy and gradient calculations using the 
   :ref:`OESage <OEMolSmirnoff_OESage>` force field.

   The following methods are publicly inherited from :ref:`OEFFParams <OEMolPotential_OEFFParams>`:
    * :oe:meth:`CreateCopy<OEMolPotential::OEFFParams::CreateCopy>`
    * :oe:meth:`GetCoulombParams<OEMolPotential::OEFFParams::GetCoulombParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`
    * :oe:meth:`GetEquilibriumAngle<OEMolPotential::OEFFParams::GetEquilibriumAngle>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>`
    * :oe:meth:`GetEquilibriumBondLength<OEMolPotential::OEFFParams::GetEquilibriumBondLength>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`GetVdwRadius<OEMolPotential::OEFFParams::GetVdwRadius>`
    * :oe:meth:`GetContactDistance<OEMolPotential::OEFFParams::GetContactDistance>`
    * :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`
    * :oe:meth:`PrepMol<OEMolPotential::OEFFParams::PrepMol>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`HasVdwParams<OEMolPotential::OEFFParams::HasVdwParams>`
    * :oe:meth:`HasStretchParams<OEMolPotential::OEFFParams::HasStretchParams>`
    * :oe:meth:`HasBendParams<OEMolPotential::OEFFParams::HasBendParams>`
    * :oe:meth:`HasTorsionParams<OEMolPotential::OEFFParams::HasTorsionParams>`
    * :oe:meth:`GetTitle<OEMolPotential::OEFFParams::GetTitle>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESageParams()
            OESageParams(const OESageParams&)

      .. oe:language:: python

         .. oe:api:: python

            OESageParams() -> OESageParams
            OESageParams(arg2: OESageParams) -> OESageParams

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESageParams& operator=(const OESageParams&)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolSmirnoff

.. _OEMolSmirnoff_OESmirnoff:

.. oe:class:: OESmirnoff

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESmirnoff : public OEMolPotential::OEGenericFF2

   The :ref:`OESmirnoff <OEMolSmirnoff_OESmirnoff>` class facilitates creation of an instance of SMIRNOFF
   force field (see :ref:`section_smirnoff`). In addition, a force field instance can be extended
   by adding externally defined potential functions.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEForceField <OEMolPotential_OEForceField>`:
    * :oe:meth:`GetTitle<OEMolPotential::OEForceField::GetTitle>` and
      :oe:meth:`SetTitle<OEMolPotential::OEForceField::SetTitle>`
    * :oe:meth:`HasCoulomb<OEMolPotential::OEForceField::HasCoulomb>`
    * :oe:meth:`HasInternalCharges<OEMolPotential::OEForceField::HasInternalCharges>`
    * :oe:meth:`PrepMol<OEMolPotential::OEForceField::PrepMol>`
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`
    * :oe:meth:`SetNonBondCutoff<OEMolPotential::OEForceField::SetNonBondCutoff>`

   The following methods are publicly inherited from :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF2::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF2::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF2::RemoveMolFunc>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESmirnoff(const OESmirnoffParams& params,
                       const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OESmirnoff(const OESmirnoff&)

      .. oe:language:: python

         .. oe:api:: python

            OESmirnoff(rcut_vdw: float = 0.0) -> OESmirnoff
            OESmirnoff(params: OESmirnoffParams,
                       opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OESmirnoff
            OESmirnoff(arg2: OESmirnoff) -> OESmirnoff

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESmirnoff& operator=(const OESmirnoff&)

      The assignment operator.

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolSmirnoff

.. _OEMolSmirnoff_OESmirnoffBendData:

.. oe:class:: OESmirnoffBendData

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESmirnoffBendData : public OEMolSmirnoff::OESmirnoffData

   The OESmirnoffBendData class provides the ability to add new parameters and modify existing
   angle bending parameters in the SMIRNOFF force field that has the functional
   form: :math:`V_a = k_a(\alpha - \alpha_0)^2` (see :ref:`section_smirnoff`).

   .. seealso::

      * :ref:`OESmirnoffData <OEMolSmirnoff_OESmirnoffData>` class

   The following methods are publicly inherited from :ref:`OESmirnoffData <OEMolSmirnoff_OESmirnoffData>` class:
    * :oe:meth:`GetID<OEMolSmirnoff::OESmirnoffData::GetID>`
    * :oe:meth:`GetSmarts<OEMolSmirnoff::OESmirnoffData::GetSmarts>`

   The class defines the following public methods:
    * :oe:meth:`GetEquilibriumAngle<OEMolSmirnoff::OESmirnoffBendData::GetEquilibriumAngle>`
    * :oe:meth:`GetEneConst<OEMolSmirnoff::OESmirnoffBendData::GetEneConst>`
    * :oe:meth:`SetParams<OEMolSmirnoff::OESmirnoffBendData::SetParams>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESmirnoffBendData()
            OESmirnoffBendData(const std::string& id, const std::string& smarts)
            OESmirnoffBendData(const OESmirnoffBendData&)

      .. oe:language:: python

         .. oe:api:: python

            OESmirnoffBendData() -> OESmirnoffBendData
            OESmirnoffBendData(id: str, smarts: str) -> OESmirnoffBendData
            OESmirnoffBendData(arg2: OESmirnoffBendData) -> OESmirnoffBendData

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESmirnoffBendData& operator=(const OESmirnoffBendData&)

      Assignment operator.

   .. oe:method:: GetEquilibriumAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEquilibriumAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetEquilibriumAngle() -> float

      Returns the equilibrium angle (:math:`\alpha_0`) in degrees associated with the parameter

   .. oe:method:: GetEneConst

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEneConst() const

      .. oe:language:: python

         .. oe:api:: python

            GetEneConst() -> float

      Returns the energy constant (:math:`k_a`) kcal/mol/radian associated with the parameter

   .. oe:method:: SetParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetParams(const double eneConst, const double angle)

      .. oe:language:: python

         .. oe:api:: python

            SetParams(eneConst: float, angle: float) -> bool

      Sets equilibrium angle (:math:`\alpha_0`) in degrees and energy constant (:math:`k_a`) kcal/mol/radian for the the parameter



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolSmirnoff

.. _OEMolSmirnoff_OESmirnoffData:

.. oe:class:: OESmirnoffData

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESmirnoffData

   The OESmirnoffData class provides an interface to the parameters in
   the SMIRNOFF force field (see :ref:`section_smirnoff`).

   .. seealso::

      * :ref:`OESmirnoffParams <OEMolSmirnoff_OESmirnoffParams>` class

   The class defines the following public methods:
    * :oe:meth:`GetID<OEMolSmirnoff::OESmirnoffData::GetID>`
    * :oe:meth:`GetSmarts<OEMolSmirnoff::OESmirnoffData::GetSmarts>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESmirnoffData & operator=(const OESmirnoffData &)

      Assignment operator.

   .. oe:method:: GetID

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetID() const

      .. oe:language:: python

         .. oe:api:: python

            GetID() -> str

      Returns the unique id for the parameter

   .. oe:method:: GetSmarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::string& GetSmarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetSmarts() -> str

      Returns the SMARTS pattern for the parameter


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolSmirnoff

.. _OEMolSmirnoff_OESmirnoffImproperData:

.. oe:class:: OESmirnoffImproperData

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESmirnoffImproperData : public OEMolSmirnoff::OESmirnoffData

   The OESmirnoffImproperData class provides the ability to add new parameters and modify existing
   improper torsion (out-of-plane bending) parameters in the SMIRNOFF force field that has the functional form: :math:`V_o = V(1+\cos{(p \theta - \gamma)})`
   (see :ref:`section_smirnoff`)

   .. seealso::

      * :ref:`OESmirnoffData <OEMolSmirnoff_OESmirnoffData>` class

   The following methods are publicly inherited from :ref:`OESmirnoffData <OEMolSmirnoff_OESmirnoffData>` class:

    * :oe:meth:`GetID<OEMolSmirnoff::OESmirnoffData::GetID>`
    * :oe:meth:`GetSmarts<OEMolSmirnoff::OESmirnoffData::GetSmarts>`

   The class defines the following public methods:

    * :oe:meth:`GetEneConst<OEMolSmirnoff::OESmirnoffImproperData::GetEneConst>`
    * :oe:meth:`GetPhaseAngle<OEMolSmirnoff::OESmirnoffImproperData::GetPhaseAngle>`
    * :oe:meth:`GetPeriodicity<OEMolSmirnoff::OESmirnoffImproperData::GetPeriodicity>`
    * :oe:meth:`SetParams<OEMolSmirnoff::OESmirnoffImproperData::SetParams>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESmirnoffImproperData()
            OESmirnoffImproperData(const std::string& id,
                                   const std::string& smarts)
            OESmirnoffImproperData(const OESmirnoffImproperData&)

      .. oe:language:: python

         .. oe:api:: python

            OESmirnoffImproperData() -> OESmirnoffImproperData
            OESmirnoffImproperData(id: str, smarts: str) -> OESmirnoffImproperData
            OESmirnoffImproperData(arg2: OESmirnoffImproperData) -> OESmirnoffImproperData

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESmirnoffImproperData& operator=(const OESmirnoffImproperData&)

      Assignment operator.

   .. _OEMolSmirnoff_GetEneConst:

   .. oe:method:: GetEneConst

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEneConst() const

      .. oe:language:: python

         .. oe:api:: python

            GetEneConst() -> float

      Returns the energy constant (:math:`{ V_n}`)  in kcal/mol for the term

   .. _OEMolSmirnoff_GetPhaseAngle:

   .. oe:method:: GetPhaseAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPhaseAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetPhaseAngle() -> float

      Returns the phase (:math:`{ \gamma_n}`) in degrees for the term

   .. _OEMolSmirnoff_GetPeriodicity:

   .. oe:method:: GetPeriodicity

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetPeriodicity() const

      .. oe:language:: python

         .. oe:api:: python

            GetPeriodicity() -> int

      Returns the periodicity (:math:`{ p_n}`) of the term

   .. _OEMolSmirnoff_SetParams:

   .. oe:method:: SetParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetParams(const double eneConst, const double phase,
                           const unsigned periodicity)

      .. oe:language:: python

         .. oe:api:: python

            SetParams(eneConst: float, phase: float, periodicity: int) -> bool

      Sets the energy constant (:math:`{ V_n}`) , phase (:math:`{ \gamma_n}`) and
      periodicity (:math:`{ p_n}`) of the improper torsion parameter.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolSmirnoff

.. _OEMolSmirnoff_OESmirnoffParams:

.. oe:class:: OESmirnoffParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESmirnoffParams : public OEMolPotential::OEFFParams

   The OESmirnoffParams class provides the ability to retrieve
   parameters necessary to perform energy and gradient calculations using the SMIRNOFF
   force field (see :ref:`section_smirnoff`).  By default OESmirnoffParams
   loads the ``Smirnoff99Frost`` force field.

   .. note::

      The inherited methods, :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`,
      :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>` and
      :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`,
      have no meaning in the SMIRNOFF force field and SHOULD NOT be used. When these methods
      are called, they return ``0``, ``none``, and ``false``, respectively.

   The following methods are publicly inherited from :ref:`OEFFParams <OEMolPotential_OEFFParams>`:
    * :oe:meth:`CreateCopy<OEMolPotential::OEFFParams::CreateCopy>`
    * :oe:meth:`GetCoulombParams<OEMolPotential::OEFFParams::GetCoulombParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`
    * :oe:meth:`GetEquilibriumAngle<OEMolPotential::OEFFParams::GetEquilibriumAngle>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>`
    * :oe:meth:`GetEquilibriumBondLength<OEMolPotential::OEFFParams::GetEquilibriumBondLength>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`GetVdwRadius<OEMolPotential::OEFFParams::GetVdwRadius>`
    * :oe:meth:`GetContactDistance<OEMolPotential::OEFFParams::GetContactDistance>`
    * :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`
    * :oe:meth:`PrepMol<OEMolPotential::OEFFParams::PrepMol>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`HasVdwParams<OEMolPotential::OEFFParams::HasVdwParams>`
    * :oe:meth:`HasStretchParams<OEMolPotential::OEFFParams::HasStretchParams>`
    * :oe:meth:`HasBendParams<OEMolPotential::OEFFParams::HasBendParams>`
    * :oe:meth:`HasTorsionParams<OEMolPotential::OEFFParams::HasTorsionParams>`
    * :oe:meth:`GetTitle<OEMolPotential::OEFFParams::GetTitle>`

   The :ref:`OESmirnoffParams <OEMolSmirnoff_OESmirnoffParams>` class contains the following methods:
    * :oe:meth:`AddBendData<OEMolSmirnoff::OESmirnoffParams::AddBendData>`
    * :oe:meth:`AddImproperData<OEMolSmirnoff::OESmirnoffParams::AddImproperData>`
    * :oe:meth:`AddStretchData<OEMolSmirnoff::OESmirnoffParams::AddStretchData>`
    * :oe:meth:`AddTorsionData<OEMolSmirnoff::OESmirnoffParams::AddTorsionData>`
    * :oe:meth:`AddVdWData<OEMolSmirnoff::OESmirnoffParams::AddVdWData>`
    * :oe:meth:`GetBendData<OEMolSmirnoff::OESmirnoffParams::GetBendData>`
    * :oe:meth:`GetImproperData<OEMolSmirnoff::OESmirnoffParams::GetImproperData>`
    * :oe:meth:`GetStretchData<OEMolSmirnoff::OESmirnoffParams::GetStretchData>`
    * :oe:meth:`GetTorsionData<OEMolSmirnoff::OESmirnoffParams::GetTorsionData>`
    * :oe:meth:`GetVdWData<OEMolSmirnoff::OESmirnoffParams::GetVdWData>`
    * :oe:meth:`Load<OEMolSmirnoff::OESmirnoffParams::Load>`
    * :oe:meth:`SetBendData<OEMolSmirnoff::OESmirnoffParams::SetBendData>`
    * :oe:meth:`SetImproperData<OEMolSmirnoff::OESmirnoffParams::SetImproperData>`
    * :oe:meth:`SetStretchData<OEMolSmirnoff::OESmirnoffParams::SetStretchData>`
    * :oe:meth:`SetTorsionData<OEMolSmirnoff::OESmirnoffParams::SetTorsionData>`
    * :oe:meth:`SetVdWData<OEMolSmirnoff::OESmirnoffParams::SetVdWData>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESmirnoffParams()
            OESmirnoffParams(const OESmirnoffParams&)

      .. oe:language:: python

         .. oe:api:: python

            OESmirnoffParams() -> OESmirnoffParams
            OESmirnoffParams(arg2: OESmirnoffParams) -> OESmirnoffParams

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESmirnoffParams& operator=(const OESmirnoffParams&)

      The assignment operator.

.. _OEMolSmirnoff_OESmirnoffParams_AddBendData:

      Assignment operator.

   .. oe:method:: AddBendData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddBendData(const OESmirnoffBendData& data)

      .. oe:language:: python

         .. oe:api:: python

            AddBendData(data: OESmirnoffBendData) -> bool

      Adds new bending parameters based on provided :ref:`OESmirnoffBendData <OEMolSmirnoff_OESmirnoffBendData>`.

.. _OEMolSmirnoff_OESmirnoffParams_AddImproperData:

   .. oe:method:: AddImproperData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddImproperData(const OESmirnoffImproperData& data)

      .. oe:language:: python

         .. oe:api:: python

            AddImproperData(data: OESmirnoffImproperData) -> bool

      Adds new improper torsion parameters based on provided :ref:`OESmirnoffImproperData <OEMolSmirnoff_OESmirnoffImproperData>`.

.. _OEMolSmirnoff_OESmirnoffParams_AddStretchData:

   .. oe:method:: AddStretchData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddStretchData(const OESmirnoffStretchData& data)

      .. oe:language:: python

         .. oe:api:: python

            AddStretchData(data: OESmirnoffStretchData) -> bool

      Adds new bond stretching parameters based on provided :ref:`OESmirnoffStretchData <OEMolSmirnoff_OESmirnoffStretchData>`.

.. _OEMolSmirnoff_OESmirnoffParams_AddTorsionData:

   .. oe:method:: AddTorsionData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddTorsionData(const OESmirnoffTorsionData& data)

      .. oe:language:: python

         .. oe:api:: python

            AddTorsionData(data: OESmirnoffTorsionData) -> bool

      Adds new torsion parameters based on provided :ref:`OESmirnoffTorsionData <OEMolSmirnoff_OESmirnoffTorsionData>`.

.. _OEMolSmirnoff_OESmirnoffParams_AddVdWData:

   .. oe:method:: AddVdWData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddVdWData(const OESmirnoffVdWData& data)

      .. oe:language:: python

         .. oe:api:: python

            AddVdWData(data: OESmirnoffVdWData) -> bool

      Adds new Van der Waals parameters based on provided :ref:`OESmirnoffVdWData <OEMolSmirnoff_OESmirnoffVdWData>`.

.. _OEMolSmirnoff_OESmirnoffParams_GetBendData:

   .. oe:method:: GetBendData

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<OESmirnoffBendData>& GetBendData() const
            bool GetBendData(OESmirnoffBendData& data,
                             const OEChem::OEAtomBase*,
                             const OEChem::OEAtomBase*,
                             const OEChem::OEAtomBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetBendData() -> SmirnoffBendDataVec
            GetBendData(data: OESmirnoffBendData, arg3: OEAtomBase,
                        arg4: OEAtomBase, arg5: OEAtomBase) -> bool

      The first overload provides all of the :ref:`OESmirnoffBendData <OEMolSmirnoff_OESmirnoffBendData>`
      corresponding to the bending parameters in the forcefield.  The second overload can be used to
      access parameters for the angle specified by the three atoms.

.. _OEMolSmirnoff_OESmirnoffParams_GetImproperData:

   .. oe:method:: GetImproperData

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<OESmirnoffImproperData>& GetImproperData() const
            bool GetImproperData(OESmirnoffImproperData& data,
                                 const OEChem::OEAtomBase*,
                                 const OEChem::OEAtomBase*,
                                 const OEChem::OEAtomBase*,
                                 const OEChem::OEAtomBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetImproperData() -> SmirnoffImpDataVec
            GetImproperData(data: OESmirnoffImproperData, arg3: OEAtomBase,
                            arg4: OEAtomBase, arg5: OEAtomBase,
                            arg6: OEAtomBase) -> bool

      The first overload provides all of the :ref:`OESmirnoffImproperData <OEMolSmirnoff_OESmirnoffImproperData>`
      corresponding to the improper torsion parameters in the forcefield.  The second overload can be used to
      access parameters for the plane specified by the four atoms.  The first atom must be the central atom
      of an improper torsion.

.. _OEMolSmirnoff_OESmirnoffParams_GetStretchData:

   .. oe:method:: GetStretchData

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<OESmirnoffStretchData>& GetStretchData() const
            bool GetStretchData(OESmirnoffStretchData& data,
                                const OEChem::OEBondBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetStretchData() -> SmirnoffStretchDataVec
            GetStretchData(data: OESmirnoffStretchData, arg3: OEBondBase) -> bool

      The first overload provides all of the :ref:`OESmirnoffStretchData <OEMolSmirnoff_OESmirnoffStretchData>`
      corresponding to the bond stretching parameters in the forcefield.  The second overload can be used to
      access parameters for the specified bond.

.. _OEMolSmirnoff_OESmirnoffParams_GetTorsionData:

   .. oe:method:: GetTorsionData

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<OESmirnoffTorsionData>& GetTorsionData() const
            bool GetTorsionData(OESmirnoffTorsionData& data,
                                const OEChem::OEAtomBase*,
                                const OEChem::OEAtomBase*,
                                const OEChem::OEAtomBase*,
                                const OEChem::OEAtomBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetTorsionData() -> SmirnoffTorDataVec
            GetTorsionData(data: OESmirnoffTorsionData, arg3: OEAtomBase,
                           arg4: OEAtomBase, arg5: OEAtomBase, arg6: OEAtomBase) -> bool

      The first overload provides all of the :ref:`OESmirnoffTorsionData <OEMolSmirnoff_OESmirnoffTorsionData>`
      corresponding to the torsion parameters in the forcefield.  The second overload can be used to
      access parameters for the torsion specified by the four atoms.

.. _OEMolSmirnoff_OESmirnoffParams_GetVdWData:

   .. oe:method:: GetVdWData

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<OESmirnoffVdWData>& GetVdWData() const
            bool GetVdWData(OESmirnoffVdWData& data, const OEChem::OEAtomBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetVdWData() -> SmirnoffVdWDataVec
            GetVdWData(data: OESmirnoffVdWData, arg3: OEAtomBase) -> bool

      The first overload provides all of the :ref:`OESmirnoffVdWData <OEMolSmirnoff_OESmirnoffVdWData>`
      corresponding to the VdW parameters in the forcefield.  The second overload can be used to
      access parameters for the specified atom.

.. _OEMolSmirnoff_OESmirnoffParams_Load:

   .. oe:method:: Load

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Load(const unsigned int fftype)
            bool Load(const std::string& xml_file_name)
            bool Load(const OEPlatform::oeisstream& ifs)

      .. oe:language:: python

         .. oe:api:: python

            Load(fftype: int) -> bool
            Load(xml_file_name: str) -> bool
            Load(ifs: oeistream) -> bool

      Methods which load force field parameters. The first method is used to load available build-in parameter set,
      defined in the :oe:constns:`OEMolSmirnoff::OESmirnoffType` namespace.
      The second method takes the name of the parameter file in XML format. This file might contain user custom
      parameters. The third method takes a stream object :oe:cls:`OEPlatform::oeisstream` which contains Smirnoff
      parameters. It is a convenience method which might be used in user code when the parameters XML file is 
      converted a stream.

.. _OEMolSmirnoff_OESmirnoffParams_SetBendData:

   .. oe:method:: SetBendData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBendData(const OESmirnoffBendData& data)

      .. oe:language:: python

         .. oe:api:: python

            SetBendData(data: OESmirnoffBendData) -> bool

      Sets the :ref:`OESmirnoffBendData <OEMolSmirnoff_OESmirnoffBendData>` replacing existing
      parameters with same ID and Smarts.

.. _OEMolSmirnoff_OESmirnoffParams_SetImproperData:

   .. oe:method:: SetImproperData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetImproperData(const OESmirnoffImproperData& data)

      .. oe:language:: python

         .. oe:api:: python

            SetImproperData(data: OESmirnoffImproperData) -> bool

      Sets the :ref:`OESmirnoffImproperData <OEMolSmirnoff_OESmirnoffImproperData>` replacing existing
      parameters with same ID and Smarts.

.. _OEMolSmirnoff_OESmirnoffParams_SetStretchData:

   .. oe:method:: SetStretchData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStretchData(const OESmirnoffStretchData& data)

      .. oe:language:: python

         .. oe:api:: python

            SetStretchData(data: OESmirnoffStretchData) -> bool

      Sets the :ref:`OESmirnoffStretchData <OEMolSmirnoff_OESmirnoffStretchData>` replacing existing
      parameters with same ID and Smarts.

.. _OEMolSmirnoff_OESmirnoffParams_SetTorsionData:

   .. oe:method:: SetTorsionData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTorsionData(const OESmirnoffTorsionData& data)

      .. oe:language:: python

         .. oe:api:: python

            SetTorsionData(data: OESmirnoffTorsionData) -> bool

      Sets the :ref:`OESmirnoffTorsionData <OEMolSmirnoff_OESmirnoffTorsionData>` replacing existing
      parameters with same ID and Smarts.

.. _OEMolSmirnoff_OESmirnoffParams_SetVdWData:

   .. oe:method:: SetVdWData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetVdWData(const OESmirnoffVdWData& data)

      .. oe:language:: python

         .. oe:api:: python

            SetVdWData(data: OESmirnoffVdWData) -> bool

      Sets the :ref:`OESmirnoffVdWData <OEMolSmirnoff_OESmirnoffVdWData>` replacing existing
      parameters with same ID and Smarts.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolSmirnoff

.. _OEMolSmirnoff_OESmirnoffStretchData:

.. oe:class:: OESmirnoffStretchData

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESmirnoffStretchData : public OEMolSmirnoff::OESmirnoffData

   The OESmirnoffStretchData class provides the ability to add new parameters and modify existing
   bond stretching parameters in the SMIRNOFF force field that has the functional
   form: :math:`V_b = k_b(r - r_0)^2` (see :ref:`section_smirnoff`).

   .. seealso::

      * :ref:`OESmirnoffData <OEMolSmirnoff_OESmirnoffData>` class

   The following methods are publicly inherited from :ref:`OESmirnoffData <OEMolSmirnoff_OESmirnoffData>` class:
    * :oe:meth:`GetID<OEMolSmirnoff::OESmirnoffData::GetID>`
    * :oe:meth:`GetSmarts<OEMolSmirnoff::OESmirnoffData::GetSmarts>`

   The class defines the following public methods:
    * :oe:meth:`GetEquilibriumBondLength<OEMolSmirnoff::OESmirnoffStretchData::GetEquilibriumBondLength>`
    * :oe:meth:`GetEneConst<OEMolSmirnoff::OESmirnoffStretchData::GetEneConst>`
    * :oe:meth:`SetParams<OEMolSmirnoff::OESmirnoffStretchData::SetParams>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESmirnoffStretchData()
            OESmirnoffStretchData(const std::string& id,
                                  const std::string& smarts)
            OESmirnoffStretchData(const OESmirnoffStretchData&)

      .. oe:language:: python

         .. oe:api:: python

            OESmirnoffStretchData() -> OESmirnoffStretchData
            OESmirnoffStretchData(id: str, smarts: str) -> OESmirnoffStretchData
            OESmirnoffStretchData(arg2: OESmirnoffStretchData) -> OESmirnoffStretchData

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESmirnoffStretchData& operator=(const OESmirnoffStretchData&)

      Assignment operator.

   .. oe:method:: GetEquilibriumBondLength

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEquilibriumBondLength() const

      .. oe:language:: python

         .. oe:api:: python

            GetEquilibriumBondLength() -> float

      Returns the equilibrium bond length (:math:`r_0`) in Angstrom associated with the parameter

   .. oe:method:: GetEneConst

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEneConst() const

      .. oe:language:: python

         .. oe:api:: python

            GetEneConst() -> float

      Returns the energy constant (:math:`k_b`) :math:`{kcal/mol/Angstrom^{2}}` associated with the parameter

   .. oe:method:: SetParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetParams(const double eneConst, const double bondLength)

      .. oe:language:: python

         .. oe:api:: python

            SetParams(eneConst: float, bondLength: float) -> bool

      Sets equilibrium bond length and energy constant for the the parameter



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolSmirnoff

.. _OEMolSmirnoff_OESmirnoffTorsionData:

.. oe:class:: OESmirnoffTorsionData

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESmirnoffTorsionData : public OEMolSmirnoff::OESmirnoffData

   The OESmirnoffTorsionData class provides the ability to add new parameters and modify existing
   proper torsion parameters in the SMIRNOFF force field that has the functional
   form: :math:`V_t = \sum_n{V_n/d_n(1+\cos{(p_n\theta - \gamma_n)})}` (see :ref:`section_smirnoff`).

   .. seealso::

      * :ref:`OESmirnoffData <OEMolSmirnoff_OESmirnoffData>` class

   The following methods are publicly inherited from :ref:`OESmirnoffData <OEMolSmirnoff_OESmirnoffData>` class:

    * :oe:meth:`GetID<OEMolSmirnoff::OESmirnoffData::GetID>`
    * :oe:meth:`GetSmarts<OEMolSmirnoff::OESmirnoffData::GetSmarts>`

   The class defines the following public methods:

    * :oe:meth:`NumTerms<OEMolSmirnoff::OESmirnoffTorsionData::NumTerms>`
    * :oe:meth:`GetDegeneracy<OEMolSmirnoff::OESmirnoffTorsionData::GetDegeneracy>`
    * :oe:meth:`GetPeriodicity<OEMolSmirnoff::OESmirnoffTorsionData::GetPeriodicity>`
    * :oe:meth:`GetEneConst<OEMolSmirnoff::OESmirnoffTorsionData::GetEneConst>`
    * :oe:meth:`GetPhaseAngle<OEMolSmirnoff::OESmirnoffTorsionData::GetPhaseAngle>`
    * :oe:meth:`AddData<OEMolSmirnoff::OESmirnoffTorsionData::AddData>`
    * :oe:meth:`ClearData<OEMolSmirnoff::OESmirnoffTorsionData::ClearData>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESmirnoffTorsionData()
            OESmirnoffTorsionData(const std::string& id,
                                  const std::string& smarts)
            OESmirnoffTorsionData(const OESmirnoffTorsionData&)

      .. oe:language:: python

         .. oe:api:: python

            OESmirnoffTorsionData() -> OESmirnoffTorsionData
            OESmirnoffTorsionData(id: str, smarts: str) -> OESmirnoffTorsionData
            OESmirnoffTorsionData(arg2: OESmirnoffTorsionData) -> OESmirnoffTorsionData

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESmirnoffTorsionData& operator=(const OESmirnoffTorsionData&)

      Assignment operator.
            OESmirnoffTorsionData(id: str, smarts: str) -> OESmirnoffTorsionData
            OESmirnoffTorsionData(arg2: OESmirnoffTorsionData) -> OESmirnoffTorsionData

   .. oe:method:: NumTerms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned NumTerms() const

      .. oe:language:: python

         .. oe:api:: python

            NumTerms() -> int

      Returns the total number of terms (:math:`n`)

   .. oe:method:: GetDegeneracy

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetDegeneracy(const unsigned index) const

      .. oe:language:: python

         .. oe:api:: python

            GetDegeneracy(index: int) -> int

      Returns the degeneracy (:math:`d_n`) of the OESmirnoffTorsionData term corresponding to the index

   .. oe:method:: GetPeriodicity

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetPeriodicity(const unsigned index) const

      .. oe:language:: python

         .. oe:api:: python

            GetPeriodicity(index: int) -> int

      Returns the periodicity of the cosine term (:math:`p_n`) of the OESmirnoffTorsionData term corresponding to the index

   .. oe:method:: GetEneConst

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEneConst(const unsigned index) const

      .. oe:language:: python

         .. oe:api:: python

            GetEneConst(index: int) -> float

      Returns the energy constant (:math:`V_n`) in kcal/mol multiplied to the cosine term of the OESmirnoffTorsionData term corresponding to the index

   .. oe:method:: GetPhaseAngle

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetPhaseAngle(const unsigned index) const

      .. oe:language:: python

         .. oe:api:: python

            GetPhaseAngle(index: int) -> float

      Returns the phase (:math:`\gamma_n`) in degrees of the cosine term of the OESmirnoffTorsionData term corresponding to the index

   .. oe:method:: AddData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddData(const unsigned degeneracy, const unsigned periodicity,
                         const double eneConst, const double phaseAngle)

      .. oe:language:: python

         .. oe:api:: python

            AddData(degeneracy: int, periodicity: int, eneConst: float,
                    phaseAngle: float) -> bool

      Used to add a OESmirnoffTorsionData term to a set of OESmirnoffParams

   .. oe:method:: ClearData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool ClearData()

      .. oe:language:: python

         .. oe:api:: python

            ClearData() -> bool

      Clears the degeneracy, periodicity, energy constant and phase from a OESmirnoffTorsionData.
      The ID and Smarts associated with the OESmirnoffTorsionData are not cleared.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEMolSmirnoff

.. _OEMolSmirnoff_OESmirnoffVdWData:

.. oe:class:: OESmirnoffVdWData

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESmirnoffVdWData : public OEMolSmirnoff::OESmirnoffData

   The OESmirnoffVdWData class provides the ability to add new parameters and modify existing
   proper torsion parameters in the SMIRNOFF force field that has the functional
   form: :math:`V_v = \epsilon_{ij}\left[\left(\frac{R_{ij}}{r_{ij}}\right)^{12}-2\left(\frac{R_{ij}}{r_{ij}}\right)^6\right]` (see :ref:`section_smirnoff`).

   .. seealso::

      * :ref:`OESmirnoffData <OEMolSmirnoff_OESmirnoffData>` class

   The following methods are publicly inherited from :ref:`OESmirnoffData <OEMolSmirnoff_OESmirnoffData>` class:
    * :oe:meth:`GetID<OEMolSmirnoff::OESmirnoffData::GetID>`
    * :oe:meth:`GetSmarts<OEMolSmirnoff::OESmirnoffData::GetSmarts>`

   The class defines the following public methods:
    * :oe:meth:`GetEpsilon<OEMolSmirnoff::OESmirnoffVdWData::GetEpsilon>`
    * :oe:meth:`GetRadius<OEMolSmirnoff::OESmirnoffVdWData::GetRadius>`
    * :oe:meth:`SetParams<OEMolSmirnoff::OESmirnoffVdWData::SetParams>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESmirnoffVdWData()
            OESmirnoffVdWData(const std::string& id, const std::string& smarts)
            OESmirnoffVdWData(const OESmirnoffVdWData&)

      .. oe:language:: python

         .. oe:api:: python

            OESmirnoffVdWData() -> OESmirnoffVdWData
            OESmirnoffVdWData(id: str, smarts: str) -> OESmirnoffVdWData
            OESmirnoffVdWData(arg2: OESmirnoffVdWData) -> OESmirnoffVdWData

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESmirnoffVdWData& operator=(const OESmirnoffVdWData&)

      Assignment operator.

   .. oe:method:: GetEpsilon

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetEpsilon() const

      .. oe:language:: python

         .. oe:api:: python

            GetEpsilon() -> float

      Returns the epsilon value (:math:`\epsilon_{ij}`) in kcal/mol for VdW term

   .. oe:method:: GetRadius

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetRadius() -> float

      Returns the radius in (:math:`R_{ij}`) Angstrom associated with VdW term

   .. oe:method:: SetParams

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetParams(const double eplison, const double radius)

      .. oe:language:: python

         .. oe:api:: python

            SetParams(eplison: float, radius: float) -> bool

      Sets the epsilon and radius of the VdW interaction term


.. oe:namespace:: OEMolSmirnoff

.. oe:constnamespace:: OESmirnoffType

   This namespace contains constants that are used in :oe:meth:`OEMolSmirnoff::OESmirnoffParams::Load`
   to define a specific build-in set of paramaters which might be used.

   .. oe:constant:: SMIRNOFF99FROSST

      SMIRNOFF99FROSST set of parameters

   .. oe:constant:: PARSLEY_OPENFF

      Parsley OpenFF1.3.1 set of parameters

   .. oe:constant:: SAGE_OPENFF
 
      Latest version of the Sage set of parameters


*******************************************************************************
OEMolSmirnoff Constants
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OESmirnoffType


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEAdaptor, Adaptor

.. _OEOpt_OEAdaptor:

.. oe:class:: OEAdaptor

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEAdaptor

   The :ref:`OEAdaptor <OEOpt_OEAdaptor>` class is a pure virtual base class which defines the interface for
   classes which adapt or transform variables and gradients during an optimization.
   Adaptors are useful in cases where function evaluations are performed in a different 
   coordinate system than the variables being optimized (for example polar coordinates
   are optimized but the function is evaluated in Cartesian coordinates).  

   .. _figure_OEAdaptor_Hierarchy:

   .. figure:: oefftk/images/OEAdaptor.*
      :align:  center

  The :ref:`OEAdaptor <OEOpt_OEAdaptor>` class defines the following public methods:
   * :oe:meth:`AdaptVar<OEOpt::OEAdaptor::AdaptVar>`         
   * :oe:meth:`GetVar<OEOpt::OEAdaptor::GetVar>`
   
  The following classes derive from this class:   
   * :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>`
   * :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`
   * :ref:`OEMolAdaptor2 <OEMolPotential_OEMolAdaptor2>`
   * :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>`
   * :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`
   * :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>`
   * :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>`

   .. oe:method:: AdaptVar

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AdaptVar(double* ca, const double *) const

      .. oe:language:: python

         .. oe:api:: python

            AdaptVar(ca: OEDoubleArray, arg3: OEDoubleArray) -> bool

      Takes a set of variables as the second argument and copies a set of transformed variables 
      into the first argument. This method is commonly used to transform optimized variables back into 
      the coordinate system of the original reference variables.

   .. oe:method:: GetVar

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetVar(double* var, const double* refVar)

      .. oe:language:: python

         .. oe:api:: python

            GetVar(var: OEDoubleArray, x: OEDoubleArray) -> None

      Takes reference variables as an argument (``refVar``), and transforms them into the variable type or 
      coordinate system (``var``) that will be used during an optimization. Reference variables normally 
      use the same coordinate system as the function evaluations that will be performed in an 
      optimization.  Many adaptors take Cartesian coordinates as the argument to the method, 
      and return an array of variables containing the initial adapted state, such as torsion angles
      or a quaternion.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEBFGSOpt, BFGSOpt

.. _OEOpt_OEBFGSOpt:

.. oe:class:: OEBFGSOpt

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEBFGSOpt : public OEOptimizer1

   The :ref:`OEBFGSOpt <OEOpt_OEBFGSOpt>` implements the quasi-Newton optimization method with
   updating Hessian according to the scheme of Broyden, Fletcher, Goldfarb and Shanno.
   The convergence criteria in based on  :math:`\sum_i {g_ig_i}`.

   The following methods are publicly inherited from :ref:`OEOptimizer1 <OEOpt_OEOptimizer1>`:
    * :oe:meth:`operator()<OEOpt::OEOptimizer1::operator()>`         
    * :oe:meth:`GetIterLimit<OEOpt::OEOptimizer1::GetIterLimit>` and
      :oe:meth:`SetIterLimit<OEOpt::OEOptimizer1::SetIterLimit>`
    * :oe:meth:`SetLineMinimize<OEOpt::OEOptimizer1::SetLineMinimize>`
    * :oe:meth:`GetTolerance<OEOpt::OEOptimizer1::GetTolerance>` and
      :oe:meth:`SetTolerance<OEOpt::OEOptimizer1::SetTolerance>`

   The :ref:`OEBFGSOpt <OEOpt_OEBFGSOpt>` class defines the following public methods:
    * :oe:meth:`GetHessianDimension<OEOpt::OEBFGSOpt::GetHessianDimension>`         
    * :oe:meth:`GetInverseHessian<OEOpt::OEBFGSOpt::GetInverseHessian>`
    * :oe:meth:`GetKeepHessian<OEOpt::OEBFGSOpt::GetKeepHessian>`
    * :oe:meth:`SetKeepHessian<OEOpt::OEBFGSOpt::SetKeepHessian>`
    * :oe:meth:`UseSavedHessian<OEOpt::OEBFGSOpt::UseSavedHessian>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBFGSOpt()
            OEBFGSOpt(const OEBFGSOpt &)

      .. oe:language:: python

         .. oe:api:: python

            OEBFGSOpt() -> OEBFGSOpt
            OEBFGSOpt(arg2: OEBFGSOpt) -> OEBFGSOpt

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBFGSOpt &operator=(const OEBFGSOpt &)

      Assignment operator.

   .. oe:method:: GetHessianDimension

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetHessianDimension() const

      .. oe:language:: python

         .. oe:api:: python

            GetHessianDimension() -> int

      Returns the dimension of the Hessian matrix.

   .. oe:method:: GetInverseHessian

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetInverseHessian(double* h, unsigned int nv) const

      .. oe:language:: python

         .. oe:api:: python

            GetInverseHessian(h: OEDoubleArray, nv: int) -> bool

      Copies the inverted Hessian matrix into the array ``h`` in the form of lower triangle of
      complete Hessian. This function is useful when the Hessian matrix generated during optimization 
      is needed. ``nv`` is the number of optimized variables. 

   .. oe:method:: GetKeepHessian

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetKeepHessian() const

      .. oe:language:: python

         .. oe:api:: python

            GetKeepHessian() -> bool

      Returns ``true`` if the :ref:`OEBFGSOpt <OEOpt_OEBFGSOpt>` object is set to keep its Hessian

   .. oe:method:: SetKeepHessian

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetKeepHessian(bool keep)

      .. oe:language:: python

         .. oe:api:: python

            SetKeepHessian(keep: bool) -> None

      If the value of the argument passed is ``true``, the :ref:`OEBFGSOpt <OEOpt_OEBFGSOpt>` object will
      keep its Hessian when the optimization is done.

   .. oe:method:: UseSavedHessian

      .. oe:language:: c++ java csharp

         .. oe:api::

            void UseSavedHessian(bool ini)

      .. oe:language:: python

         .. oe:api:: python

            UseSavedHessian(ini: bool) -> None

      By default, at the start of the optimization Hessian is initiated as unit matrix.
      In the case when optimization has to repeated, for example starting with different
      values of variables, one can use this method to initiate optimization with the 
      Hessian from the previous run. 



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OECGLineMinimize, CGLineMinimize

.. _OEOpt_OECGLineMinimize:

.. oe:class:: OECGLineMinimize

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OECGLineMinimize : public OELineMinimize

   The :ref:`OECGLineMinimize <OEOpt_OECGLineMinimize>` class implements line minimization used by the
   Conjugate Gradient optimizer :ref:`OEConjGradOpt <OEOpt_OEConjGradOpt>`

   The following methods are publicly inherited from :ref:`OELineMinimize <OEOpt_OELineMinimize>`:
    * :oe:meth:`operator()<OEOpt::OELineMinimize::operator()>` 
    * :oe:meth:`CreateCopy<OEOpt::OELineMinimize::CreateCopy>` 
    * :oe:meth:`SetMaxStep<OEOpt::OELineMinimize::SetMaxStep>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECGLineMinimize()

      .. oe:language:: python

         .. oe:api:: python

            OECGLineMinimize() -> OECGLineMinimize

      Default and copy constructors.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OECheckpoint0, Checkpoint0

.. _OEOpt_OECheckpoint0:

.. oe:class:: OECheckpoint0

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OECheckpoint0

   The :ref:`OECheckpoint0 <OEOpt_OECheckpoint0>` class is an abstract class which provides a "callback"
   facility to monitor the progress of an optimization. In addition, the checkpoint class can 
   also be used to control the termination of an optimization. This class is specifically for use 
   with optimizers which do not use gradients.

   The :ref:`OECheckpoint0 <OEOpt_OECheckpoint0>` class defines the following public methods:
    * :oe:meth:`operator()<OEOpt::OECheckpoint0::operator()>` 
   
   The following classes derive from this class:
    * :ref:`OECheckpoint1 <OEOpt_OECheckpoint1>`

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(unsigned int iteration, unsigned int nvar, double fval, const double* var = (double*)0, unsigned int state = 0) = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(iteration: int, nvar: int, fval: float,
                     var: OEDoubleArray = (OEDoubleArray), state: int = 0) -> bool

      This operator method is called by an optimizer at least once per iteration during 
      an optimization. The variables passed to the method from the optimizer reflect the 
      current state of an optimization.

      *iteration*
         The iteration number.

      *nvar*
         The number of variables.

      *fval* 
         The most recent function evaluation during the current iteration.

      *var* 
         Array containing current set of optimized variables.  If available, the array has a length of ``nvar``.

      *state*
         The current state of optimization.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OECheckpoint1, Checkpoint1

.. _OEOpt_OECheckpoint1:

.. oe:class:: OECheckpoint1

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OECheckpoint1 : public OECheckpoint0

   The :ref:`OECheckpoint1 <OEOpt_OECheckpoint1>` provides a "callback" facility to monitor the progress of
   an optimization. In addition, it can also be used to control the termination of an optimization.
   This class may be used with optimizers that do not use gradients as well as those that use 
   gradients

   The following methods are publicly inherited from
   :ref:`OECheckpoint0 <OEOpt_OECheckpoint0>`:

    * :oe:meth:`operator()<OEOpt::OECheckpoint0::operator()>` 

   The :ref:`OECheckpoint1 <OEOpt_OECheckpoint1>` class defines the following public
   methods:   

    * :oe:meth:`operator()<OEOpt::OECheckpoint1::operator()>` 
   
   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(unsigned int iteration, unsigned int nvar, double fval, double gnorm, const double* var = (double *) 0, const double* grad = (double *) 0, unsigned int state = 0)=0

      .. oe:language:: python

         .. oe:api:: python

            __call__(iteration: int, nvar: int, fval: float, gnorm: float,
                     var: OEDoubleArray = (OEDoubleArray),
                     grad: OEDoubleArray = (OEDoubleArray), state: int = 0) -> bool

      This operator method is called by an optimizer at least once per iteration during 
      an optimization. The variables passed to the method from the optimizer reflect the 
      current state of an optimization. 

      *iteration*
         The iteration number.

      *nvar*
         The number of variables.

      *fval* 
         The most recent function evaluation during the current iteration.

      *gnorm* 
         The most recent gradient norm evaluation during the current
         iteration. The gradient norm is defined as
         :math:`\sqrt{\sum_i {g_ig_i}}`

      *var* 
         Array containing current set of optimized variables.  If available, the array has a length of ``nvar``.

      *grad* 
         Array containing current set of optimized variables.  If available, the array has a length of ``nvar``.

      *state*
         The current state of optimization.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEConjGradOpt, ConjGradOpt

.. _OEOpt_OEConjGradOpt:

.. oe:class:: OEConjGradOpt

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEConjGradOpt : public OEOptimizer1

   The :ref:`OEConjGradOpt <OEOpt_OEConjGradOpt>` implements the conjugate gradient optimization
   method. The convergence criteria in based on  :math:`\sum_i {g_ig_i}`.

   The following methods are publicly inherited from :ref:`OEOptimizer1 <OEOpt_OEOptimizer1>`:
    * :oe:meth:`operator()<OEOpt::OEOptimizer1::operator()>`         
    * :oe:meth:`GetIterLimit<OEOpt::OEOptimizer1::GetIterLimit>` and
      :oe:meth:`SetIterLimit<OEOpt::OEOptimizer1::SetIterLimit>`
    * :oe:meth:`SetLineMinimize<OEOpt::OEOptimizer1::SetLineMinimize>`
    * :oe:meth:`GetTolerance<OEOpt::OEOptimizer1::GetTolerance>` and
      :oe:meth:`SetTolerance<OEOpt::OEOptimizer1::SetTolerance>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConjGradOpt()
            OEConjGradOpt(const OEConjGradOpt &)

      .. oe:language:: python

         .. oe:api:: python

            OEConjGradOpt() -> OEConjGradOpt
            OEConjGradOpt(arg2: OEConjGradOpt) -> OEConjGradOpt

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEConjGradOpt &operator=(const OEConjGradOpt &)

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEDFPOpt, DFPOpt

.. _OEOpt_OEDFPOpt:

.. oe:class:: OEDFPOpt

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEDFPOpt : public OEOptimizer1

   The :ref:`OEDFPOpt <OEOpt_OEDFPOpt>` implements the quasi-Newton optimization according
   to the Davidon-Fletcher-Powell method. The convergence criteria in based on  :math:`\sum_i {g_ig_i}`.

   The following methods are publicly inherited from :ref:`OEOptimizer1 <OEOpt_OEOptimizer1>`:
    * :oe:meth:`operator()<OEOpt::OEOptimizer1::operator()>`         
    * :oe:meth:`GetIterLimit<OEOpt::OEOptimizer1::GetIterLimit>` and
      :oe:meth:`SetIterLimit<OEOpt::OEOptimizer1::SetIterLimit>`
    * :oe:meth:`SetLineMinimize<OEOpt::OEOptimizer1::SetLineMinimize>`
    * :oe:meth:`GetTolerance<OEOpt::OEOptimizer1::GetTolerance>` and
      :oe:meth:`SetTolerance<OEOpt::OEOptimizer1::SetTolerance>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDFPOpt()
            OEDFPOpt(const OEDFPOpt &)

      .. oe:language:: python

         .. oe:api:: python

            OEDFPOpt() -> OEDFPOpt
            OEDFPOpt(arg2: OEDFPOpt) -> OEDFPOpt

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDFPOpt &operator=(const OEDFPOpt &)

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEFComponent, FComponent

.. _OEOpt_OEFComponent:

.. oe:class:: OEFComponent

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      struct OEFComponent

   The :ref:`OEFComponent <OEOpt_OEFComponent>` class associates interaction-component names
   with with computed energy values. Methods which override :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
   return an iterator over :ref:`OEFComponent <OEOpt_OEFComponent>` instances.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFComponent()
            OEFComponent(const char* n, double v)

      .. oe:language:: python

         .. oe:api:: python

            OEFComponent() -> OEFComponent
            OEFComponent(n: str, v: float) -> OEFComponent

      Default and copy constructors.

      Second constructor makes an instance of :ref:`OEFComponent <OEOpt_OEFComponent>` given a name and value for
      an interaction.

      



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEFletcherReevesOpt, FletcherReevesOpt

.. _OEOpt_OEFletcherReevesOpt:

.. oe:class:: OEFletcherReevesOpt

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFletcherReevesOpt : public OEOptimizer1

   The :ref:`OEFletcherReevesOpt <OEOpt_OEFletcherReevesOpt>` class implements the Fletcher-Reeves
   optimization method belonging to the family of conjugate gradient methods.
   The convergence criteria in based on  :math:`\sum_i {g_ig_i}`.

   The following methods are publicly inherited from :ref:`OEOptimizer1 <OEOpt_OEOptimizer1>`:
    * :oe:meth:`operator()<OEOpt::OEOptimizer1::operator()>`         
    * :oe:meth:`GetIterLimit<OEOpt::OEOptimizer1::GetIterLimit>` and
      :oe:meth:`SetIterLimit<OEOpt::OEOptimizer1::SetIterLimit>`
    * :oe:meth:`SetLineMinimize<OEOpt::OEOptimizer1::SetLineMinimize>`
    * :oe:meth:`GetTolerance<OEOpt::OEOptimizer1::GetTolerance>` and
      :oe:meth:`SetTolerance<OEOpt::OEOptimizer1::SetTolerance>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEFletcherReevesOpt()
            OEFletcherReevesOpt(const OEFletcherReevesOpt &)

      .. oe:language:: python

         .. oe:api:: python

            OEFletcherReevesOpt() -> OEFletcherReevesOpt
            OEFletcherReevesOpt(arg2: OEFletcherReevesOpt) -> OEFletcherReevesOpt

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFletcherReevesOpt &operator=(const OEFletcherReevesOpt &)

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEFunc0, Func0

.. _OEOpt_OEFunc0:

.. oe:class:: OEFunc0

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFunc0

   The :ref:`OEFunc0 <OEOpt_OEFunc0>` is an abstract base class. This class defines the interface
   for functions which take a set of variables and compute a function value, but have no 
   defined analytical gradients. Classes derived from :ref:`OEFunc0 <OEOpt_OEFunc0>` are intended
   for use with optimizers which do not require gradients.

   .. _figure_OEFunc0_Hierarchy:

   .. figure:: oefftk/images/OEFunc0.*
      :align:  center

   The :ref:`OEFunc0 <OEOpt_OEFunc0>` class defines the following public methods:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following classes derive from this class:
    * :ref:`OEFunc1 <OEOpt_OEFunc1>`
    * :ref:`OEFunc2 <OEOpt_OEFunc2>`
    * :ref:`OEMolFunc0 <OEMolPotential_OEMolFunc0>`
    * :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>`
    * :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`
    * :ref:`OEForceField <OEMolPotential_OEForceField>`
    * :ref:`OEGenericFF <OEMolPotential_OEGenericFF>`
    * :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`
    * :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>`
    * :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`
    * :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>`
    * :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`
    * :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>`
    * :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>`
    * :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>`
    * :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>`
    * :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`
    * :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>`
    * :ref:`OEBendPotential <OEMolPotential_OEBendPotential>`
    * :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>`
    * :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>`
    * :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`
    * :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
    * :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`
    * :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>`
    * :ref:`OEInterMolFunc2 <OEMolPotential_OEInterMolFunc2>`
    * :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`
    * :ref:`OEInterNonBondPotential <OEMolPotential_OEInterNonBondPotential>`
    * :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
    * :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`
    * :ref:`OEHarmonicPotential <OEConstr_OEHarmonicPotential>`
    * :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
    * :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>`
    * :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`
    * :ref:`OESheffield <OESheff_OESheffield>`
    * :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
    * :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>`
    * :ref:`OEShapeFunc <OEShape_OEShapeFunc>`
    * :ref:`OEExactShapeFunc <OEShape_OEExactShapeFunc>`
    * :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>`
    * :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>`
    * :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>`
    * :ref:`OEColorFunc <OEShape_OEColorFunc>`
    * :ref:`OEExactColorFunc <OEShape_OEExactColorFunc>`
    * :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>`
    * :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>`

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator()(const double*)

      .. oe:language:: python

         .. oe:api:: python

            __call__(x: OEDoubleArray) -> float

      This method defines the interface for function evaluation. 
      An array of variables is passed as an argument, and a function value is returned.
      All classes derived from :ref:`OEFunc0 <OEOpt_OEFunc0>` implements this method.

   .. oe:method:: GetFComponents

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEFComponent>* GetFComponents(const double *)

      .. oe:language:: python

         .. oe:api:: python

            GetFComponents(arg0: float) -> Iterable[OEFComponent]

      This method defines the interface for retrieving information 
      about function names and associated function values, given a set of variables. The 
      method takes an array of variables, and returns an iterator over the names and 
      component values (typically energies).

      All OE classes derived from :ref:`OEFunc0 <OEOpt_OEFunc0>`, implements this method.
      However, due to the unique construct of the return value from this method, it
      is not possible to implement this in a user derived class.  It is suggested to
      return a NULL for user derived classes and handle things accordingly.

   .. oe:method:: NumVar

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int NumVar() const

      .. oe:language:: python

         .. oe:api:: python

            NumVar() -> int

      This method defines the interface for returning the number of function variables.
      All classes derived from :ref:`OEFunc0 <OEOpt_OEFunc0>` implements this method.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEFunc1, Func1

.. _OEOpt_OEFunc1:

.. oe:class:: OEFunc1

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFunc1 : public OEFunc0

   The :ref:`OEFunc1 <OEOpt_OEFunc1>` is an abstract base class. This class defines the
   interface for functions which take a set of variables and compute a function value 
   and gradients. Classes derived from :ref:`OEFunc1 <OEOpt_OEFunc1>` are intended for use
   with optimizers which require gradients.

   .. _figure_OEFunc1_Hierarchy:

   .. figure:: oefftk/images/OEFunc1.*
      :align:  center

  The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
   * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
   * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
   * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

  The :ref:`OEFunc1 <OEOpt_OEFunc1>` class defines the following additional public methods:
   * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

  The following classes derive from this class:
    * :ref:`OEFunc2 <OEOpt_OEFunc2>`
    * :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>`
    * :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`
    * :ref:`OEForceField <OEMolPotential_OEForceField>`
    * :ref:`OEGenericFF <OEMolPotential_OEGenericFF>`
    * :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`
    * :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>`
    * :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`
    * :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>`
    * :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`
    * :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>`
    * :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>`
    * :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>`
    * :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>`
    * :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`
    * :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>`
    * :ref:`OEBendPotential <OEMolPotential_OEBendPotential>`
    * :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>`
    * :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>`
    * :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`
    * :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
    * :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`
    * :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>`
    * :ref:`OEInterMolFunc2 <OEMolPotential_OEInterMolFunc2>`
    * :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`
    * :ref:`OEInterNonBondPotential <OEMolPotential_OEInterNonBondPotential>`
    * :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
    * :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`
    * :ref:`OEHarmonicPotential <OEConstr_OEHarmonicPotential>`
    * :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
    * :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>`
    * :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`
    * :ref:`OESheffield <OESheff_OESheffield>`
    * :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
    * :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>`
    * :ref:`OEShapeFunc <OEShape_OEShapeFunc>`
    * :ref:`OEExactShapeFunc <OEShape_OEExactShapeFunc>`
    * :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>`
    * :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>`
    * :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>`
    * :ref:`OEColorFunc <OEShape_OEColorFunc>`
    * :ref:`OEExactColorFunc <OEShape_OEExactColorFunc>`
    * :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>`
    * :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>`

    
   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator()(const double* x, double* g)

      .. oe:language:: python

         .. oe:api:: python

            __call__(x: OEDoubleArray, g: OEDoubleArray) -> float

      This method defines the interface for function evaluation along with the gradients. 
      An array of variables is passed as an argument, and a function 
      value is returned. The corresponding gradients for the given
      set of variable is returned in the second argument. All classes derived 
      from :ref:`OEFunc1 <OEOpt_OEFunc1>` implements this method.

      There should be a one to one correspondence between the elements of the variable 
      and gradient arrays. Methods that override this operator method must not 
      initialize the gradient array, but rather assume the array has already been 
      initialized.

    


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEFunc2, Func2

.. _OEOpt_OEFunc2:

.. oe:class:: OEFunc2

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEFunc2 : public OEFunc1

   The :ref:`OEFunc2 <OEOpt_OEFunc2>` is an abstract base class. This class defines the
   interface for functions which take a set of variables and compute a function value, 
   gradients and second derivatives. 

   .. _figure_OEFunc2_Hierarchy:

   .. figure:: oefftk/images/OEFunc2.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>` 

   The :ref:`OEFunc2 <OEOpt_OEFunc2>` class defines the following additional public methods:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following classes derive from this class:
    * :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`
    * :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`
    * :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`
    * :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>`
    * :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>`
    * :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`
    * :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>`
    * :ref:`OEBendPotential <OEMolPotential_OEBendPotential>`
    * :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>`
    * :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>`
    * :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`
    * :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
    * :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`
    * :ref:`OEInterMolFunc2 <OEMolPotential_OEInterMolFunc2>`
    * :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`
    * :ref:`OEInterNonBondPotential <OEMolPotential_OEInterNonBondPotential>`
    * :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
    * :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`
    * :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
    * :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>`
    * :ref:`OESheffield <OESheff_OESheffield>`
    * :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>`

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const double* x, double* h, double* g)

      .. oe:language:: python

         .. oe:api:: python

            __call__(x: OEDoubleArray, h: OEDoubleArray, g: OEDoubleArray) -> bool

      This method defines the interface for function evaluation 
      along with gradients and second derivatives. The corresponding second derivatives 
      for the given set of variable is returned in the second argument, and the gradients 
      are returned in the third argument.

      There should be a one to one correspondence between the elements of the variable 
      and that second derivatives and gradients arrays. Methods that override this operator 
      method must not initialize the second derivatives and the gradient arrays, but rather 
      assume that the arrays has already been initialized. 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEHestenesStiefelOpt, HestenesStiefelOpt

.. _OEOpt_OEHestenesStiefelOpt:

.. oe:class:: OEHestenesStiefelOpt

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEHestenesStiefelOpt : public OEOptimizer1

   The :ref:`OEHestenesStiefelOpt <OEOpt_OEHestenesStiefelOpt>` class implements the Hestenes-Stiefel
   optimization method belonging to the family of conjugate gradient methods.
   The convergence criteria in based on  :math:`\sum_i {g_ig_i}`.
   

   The following methods are publicly inherited from :ref:`OEOptimizer1 <OEOpt_OEOptimizer1>`:
    * :oe:meth:`operator()<OEOpt::OEOptimizer1::operator()>`         
    * :oe:meth:`GetIterLimit<OEOpt::OEOptimizer1::GetIterLimit>` and
      :oe:meth:`SetIterLimit<OEOpt::OEOptimizer1::SetIterLimit>`
    * :oe:meth:`SetLineMinimize<OEOpt::OEOptimizer1::SetLineMinimize>`
    * :oe:meth:`GetTolerance<OEOpt::OEOptimizer1::GetTolerance>` and
      :oe:meth:`SetTolerance<OEOpt::OEOptimizer1::SetTolerance>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHestenesStiefelOpt()
            OEHestenesStiefelOpt(const OEHestenesStiefelOpt& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHestenesStiefelOpt() -> OEHestenesStiefelOpt
            OEHestenesStiefelOpt(rhs: OEHestenesStiefelOpt) -> OEHestenesStiefelOpt

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHestenesStiefelOpt &operator=(const OEHestenesStiefelOpt &rhs)

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OELineMinimize, LineMinimize

.. _OEOpt_OELineMinimize:

.. oe:class:: OELineMinimize

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OELineMinimize

   The :ref:`OELineMinimize <OEOpt_OELineMinimize>` class is a base class which defines the interface for
   line minimization used in different types of optimization. 

   The :ref:`OELineMinimize <OEOpt_OELineMinimize>` class defines the following public methods:
    * :oe:meth:`operator()<OEOpt::OELineMinimize::operator()>`           
    * :oe:meth:`CreateCopy<OEOpt::OELineMinimize::CreateCopy>`
    * :oe:meth:`SetMaxStep<OEOpt::OELineMinimize::SetMaxStep>`

   The following classes derive from this class:   
    * :ref:`OECGLineMinimize <OEOpt_OECGLineMinimize>`
    * :ref:`OEMaxStepLineMinimize <OEOpt_OEMaxStepLineMinimize>`
    * :ref:`OEQNLineMinimize <OEOpt_OEQNLineMinimize>`
    * :ref:`OENRLineSearch <OEOpt_OENRLineSearch>`
   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(unsigned int n, const double* p, double* d, double* g, double* k, double* gmin, double* alpha, OEFunc1& fun ) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(n: int, p: OEDoubleArray, d: OEDoubleArray,
                     g: OEDoubleArray, k: OEDoubleArray, gmin: OEDoubleArray,
                     alpha: OEDoubleArray, fun: OEFunc1) -> bool

      Defines the interface for finding the step size ``alpha`` for the current optimizer 
      iteration in the search direction determined by the vector ``d``. ``n`` is the number 
      of optimized variables, array ``p`` and ``g`` contain initial coordinates and gradients, 
      while array ``k`` returns gradients for the coordinates determined by the returned step 
      size ``alpha``. ``gmin`` contains the initial function value and returns its optimized 
      value, and ``fun`` is a reference to optimized function object. Operator returns ``true`` 
      when a value lower than the initial function value is found, ``false`` otherwise.

   .. oe:method:: SetMaxStep

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxStep(unsigned int , double *)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxStep(arg2: int, arg3: OEDoubleArray) -> bool

      Defines the interface for determination of the maximum step size. This method has a trivial 
      implementation in the base class, and provides a way to determine the maximum step if the 
      specific line optimization derived from :ref:`OELineMinimize <OEOpt_OELineMinimize>` needs it.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELineMinimize* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OELineMinimize

      Defines the interface for creating a copy of line minimization object.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEMaxStepLineMinimize, MaxStepLineMinimize

.. _OEOpt_OEMaxStepLineMinimize:

.. oe:class:: OEMaxStepLineMinimize

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMaxStepLineMinimize : public OELineMinimize

   The following methods are publicly inherited from :ref:`OELineMinimize <OEOpt_OELineMinimize>`:
    * :oe:meth:`operator()<OEOpt::OELineMinimize::operator()>` 
    * :oe:meth:`CreateCopy<OEOpt::OELineMinimize::CreateCopy>`
    * :oe:meth:`SetMaxStep<OEOpt::OELineMinimize::SetMaxStep>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMaxStepLineMinimize()
            OEMaxStepLineMinimize(double* maxStep, unsigned len)
            OEMaxStepLineMinimize(const OEMaxStepLineMinimize& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEMaxStepLineMinimize() -> OEMaxStepLineMinimize
            OEMaxStepLineMinimize(maxStep: OEDoubleArray, len: int) -> OEMaxStepLineMinimize
            OEMaxStepLineMinimize(rhs: OEMaxStepLineMinimize) -> OEMaxStepLineMinimize

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMaxStepLineMinimize &operator=(const OEMaxStepLineMinimize &rhs)

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OENRLineSearch, NRLineSearch

.. _OEOpt_OENRLineSearch:

.. oe:class:: OENRLineSearch

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OENRLineSearch : public OELineMinimize

   The :ref:`OENRLineSearch <OEOpt_OENRLineSearch>` class implements line minimization using
   backtracking line search method.

   The following methods are publicly inherited from :ref:`OELineMinimize <OEOpt_OELineMinimize>`:
    * :oe:meth:`operator()<OEOpt::OELineMinimize::operator()>`
    * :oe:meth:`SetMaxStep<OEOpt::OELineMinimize::SetMaxStep>` 
    * :oe:meth:`CreateCopy<OEOpt::OELineMinimize::CreateCopy>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENRLineSearch(unsigned int inistep = OENROpts::UseFullNewtonInitialStep)

      .. oe:language:: python

         .. oe:api:: python

            OENRLineSearch(inistep: int = UseFullNewtonInitialStep) -> OENRLineSearch

      Default and copy constructors.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OENewtonOpt, NewtonOpt

.. _OEOpt_OENewtonOpt:

.. oe:class:: OENewtonOpt

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OENewtonOpt : public OEOptimizer2

   The :ref:`OENewtonOpt <OEOpt_OENewtonOpt>` implements the Newton-Raphson optimization method using
   analytical Hessian and its Cholesky decomposition for determination of current search
   direction.

   The following methods are publicly inherited from :ref:`OEOptimizer2 <OEOpt_OEOptimizer2>`:
    * :oe:meth:`operator()<OEOpt::OEOptimizer2::operator()>`
    * :oe:meth:`GetIterLimit<OEOpt::OEOptimizer2::GetIterLimit>` and
      :oe:meth:`SetIterLimit<OEOpt::OEOptimizer2::SetIterLimit>`
    * :oe:meth:`GetTolerance<OEOpt::OEOptimizer2::GetTolerance>` and
      :oe:meth:`SetTolerance<OEOpt::OEOptimizer2::SetTolerance>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OENewtonOpt()
            OENewtonOpt(const OENewtonOpt &)

      .. oe:language:: python

         .. oe:api:: python

            OENewtonOpt() -> OENewtonOpt
            OENewtonOpt(arg2: OENewtonOpt) -> OENewtonOpt

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OENewtonOpt &operator=(const OENewtonOpt &)

   .. seealso::

      * :ref:`section_Func2Opt_example` example

      Assignment operator.



.. _OEOptClasses:

*******************
OEOpt Classes
*******************

.. oe:namespace:: OEOpt

.. toctree::

   OEAdaptor
   OEBFGSOpt
   OECGLineMinimize
   OECheckpoint0
   OECheckpoint1
   OEConjGradOpt
   OEDFPOpt
   OEFComponent
   OEFletcherReevesOpt
   OEFunc0
   OEFunc1
   OEFunc2
   OEHestenesStiefelOpt
   OELineMinimize
   OEMaxStepLineMinimize
   OENRLineSearch
   OEOptimizer0
   OEOptimizer1
   OEOptimizer2
   OEQNLineMinimize
   OERibierePolakOpt
   OESteepestDescentOpt
   OENewtonOpt


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEOptimizer0, Optimizer0

.. _OEOpt_OEOptimizer0:

.. oe:class:: OEOptimizer0

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEOptimizer0

   The :ref:`OEOptimizer0 <OEOpt_OEOptimizer0>` abstract class defines the interface for
   optimizing a set of variables for which a function can be evaluated. 
   Implementations of :ref:`OEOptimizer0 <OEOpt_OEOptimizer0>` use only function values during
   optimization, so it does not calculate gradients.

   The :ref:`OEOptimizer0 <OEOpt_OEOptimizer0>` class defines the following public methods:
    * :oe:meth:`operator()<OEOpt::OEOptimizer0::operator()>`         
    * :oe:meth:`GetIterLimit<OEOpt::OEOptimizer0::GetIterLimit>` and
      :oe:meth:`SetIterLimit<OEOpt::OEOptimizer0::SetIterLimit>`

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator()(OEFunc0& function, const double* var, double* opt_var)
            double operator()(OEFunc0& function, OECheckpoint0* check, const double* var, double* opt_var)

      .. oe:language:: python

         .. oe:api:: python

            __call__(function: OEFunc0, var: OEDoubleArray,
                     opt_var: OEDoubleArray) -> float
            __call__(function: OEFunc0, check: OECheckpoint0,
                     var: OEDoubleArray, opt_var: OEDoubleArray) -> float

      These methods define the interface for optimizing a set of variables 
      with the use of evaluated function values. The reference to the function object
      is passed as a first argument. Initial values of variables are passed in the 
      array ``var``. The optimized variables are returned in the array ``opt_var``.
      Both operators return the value of the corresponding optimized function value.
      The second operator takes a pointer to the :ref:`OECheckpoint0 <OEOpt_OECheckpoint0>` object
      that can be used to monitor the progress of an optimization.

   .. oe:method:: GetIterLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetIterLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetIterLimit() -> int

      See :oe:meth:`SetIterLimit<OEOpt::OEOptimizer0::SetIterLimit>`.

   .. oe:method:: SetIterLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetIterLimit(unsigned int itmax)

      .. oe:language:: python

         .. oe:api:: python

            SetIterLimit(itmax: int) -> None

      Defines the interface for setting the maximum number of iterations that an
      optimizer derived from the :ref:`OEOptimizer0 <OEOpt_OEOptimizer0>` will attempt while
      trying to identify a converged minimum function value. Optimization will cease if 
      the iteration limit is reached without finding a converged minimum.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEOptimizer1, Optimizer1

.. _OEOpt_OEOptimizer1:

.. oe:class:: OEOptimizer1

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEOptimizer1

   The :ref:`OEOptimizer1 <OEOpt_OEOptimizer1>` abstract class defines the interface for
   optimizing a set of variables for which a function and gradients can be
   evaluated. Implementations of :ref:`OEOptimizer1 <OEOpt_OEOptimizer1>` use both function
   values and gradients during optimization.

   The :ref:`OEOptimizer1 <OEOpt_OEOptimizer1>` class defines the following public methods:
    * :oe:meth:`operator()<OEOpt::OEOptimizer1::operator()>`         
    * :oe:meth:`GetIterLimit<OEOpt::OEOptimizer1::GetIterLimit>` and
      :oe:meth:`SetIterLimit<OEOpt::OEOptimizer1::SetIterLimit>`
    * :oe:meth:`SetLineMinimize<OEOpt::OEOptimizer1::SetLineMinimize>`
    * :oe:meth:`GetTolerance<OEOpt::OEOptimizer1::GetTolerance>` and
      :oe:meth:`SetTolerance<OEOpt::OEOptimizer1::SetTolerance>`

   The following classes derive from this class:   
    * :ref:`OEBFGSOpt <OEOpt_OEBFGSOpt>`
    * :ref:`OEConjGradOpt <OEOpt_OEConjGradOpt>`
    * :ref:`OEDFPOpt <OEOpt_OEDFPOpt>`
    * :ref:`OEFletcherReevesOpt <OEOpt_OEFletcherReevesOpt>`
    * :ref:`OEHestenesStiefelOpt <OEOpt_OEHestenesStiefelOpt>`
    * :ref:`OERibierePolakOpt <OEOpt_OERibierePolakOpt>`
    * :ref:`OESteepestDescentOpt <OEOpt_OESteepestDescentOpt>`
   

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator()(OEFunc1& function, const double* var, double* opt_var)
            double operator()(OEFunc1& function, OECheckpoint1* check, const double* var, double* opt_var)

      .. oe:language:: python

         .. oe:api:: python

            __call__(function: OEFunc1, var: OEDoubleArray,
                     opt_var: OEDoubleArray) -> float
            __call__(function: OEFunc1, check: OECheckpoint1,
                     var: OEDoubleArray, opt_var: OEDoubleArray) -> float

      These virtual methods define the interface for optimizing a set of variables
      with the use of evaluated function values. The reference to the function object
      is passed as a first argument. Initial values of variables are passed in the
      array ``var``. The optimized variables are returned in the array ``opt_var``.
      Both operators return the value of the corresponding optimized function value.
      The second operator takes a pointer to the :ref:`OECheckpoint1 <OEOpt_OECheckpoint1>` object
      that can be used to monitor the progress of an optimization.

   .. oe:method:: GetIterLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetIterLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetIterLimit() -> int

      See :oe:meth:`SetIterLimit<OEOpt::OEOptimizer1::SetIterLimit>`.

   .. oe:method:: GetTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTolerance() const

      .. oe:language:: python

         .. oe:api:: python

            GetTolerance() -> float

      See :oe:meth:`SetTolerance<OEOpt::OEOptimizer1::SetTolerance>`.

   .. oe:method:: SetIterLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetIterLimit(unsigned int itmax)

      .. oe:language:: python

         .. oe:api:: python

            SetIterLimit(itmax: int) -> None

      Defines the interface for setting the maximum number of iterations that an
      optimizer derived from the :ref:`OEOptimizer0 <OEOpt_OEOptimizer0>` will attempt while
      trying to identify a converged minimum function value. Optimization will cease if
      the iteration limit is reached without finding a converged minimum.

   .. oe:method:: SetLineMinimize

      .. oe:api::

         bool SetLineMinimize(const OELineMinimize &linmin)

      Allows selection of the line minimization object used by the optimizer.

   .. oe:method:: SetTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTolerance(double t)

      .. oe:language:: python

         .. oe:api:: python

            SetTolerance(t: float) -> None

      Defines the interface for setting the gradient convergence criteria. Depending
      on the implementation it might be the root mean square gradient, gradient norm
      or gradient dot product. Optimization will terminate normally if the convergence 
      criteria set by this method is achieved during an optimization.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEOptimizer2, Optimizer2

.. _OEOpt_OEOptimizer2:

.. oe:class:: OEOptimizer2

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEOptimizer2

   The :ref:`OEOptimizer2 <OEOpt_OEOptimizer2>` abstract class defines the interface for
   optimizing a set of variables for which a function, gradients and second
   derivatives (elements oh Hessian matrix) can be evaluated. Implementations of 
   :ref:`OEOptimizer2 <OEOpt_OEOptimizer2>` use function values, gradients and second
   derivatives of function during optimization.

   The :ref:`OEOptimizer2 <OEOpt_OEOptimizer2>` class defines the following public methods:
    * :oe:meth:`operator()<OEOpt::OEOptimizer2::operator()>`         
    * :oe:meth:`GetIterLimit<OEOpt::OEOptimizer2::GetIterLimit>` and
      :oe:meth:`SetIterLimit<OEOpt::OEOptimizer2::SetIterLimit>`
    * :oe:meth:`GetTolerance<OEOpt::OEOptimizer2::GetTolerance>` and
      :oe:meth:`SetTolerance<OEOpt::OEOptimizer2::SetTolerance>`

   The following classes derive from this class:  
    * :ref:`OENewtonOpt <OEOpt_OENewtonOpt>`

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            double operator()(OEFunc2& function, const double* var, double* opt_var)
            double operator()(OEFunc2& function, OECheckpoint1* check, const double* var, double* opt_var)

      .. oe:language:: python

         .. oe:api:: python

            __call__(function: OEFunc2, var: OEDoubleArray,
                     opt_var: OEDoubleArray) -> float
            __call__(function: OEFunc2, check: OECheckpoint1,
                     var: OEDoubleArray, opt_var: OEDoubleArray) -> float

      These virtual methods define the interface for optimizing a set of variables
      with the use of evaluated function values. The reference to the function object
      is passed as a first argument. Initial values of variables are passed in the
      array ``var``. The optimized variables are returned in the array ``opt_var``.
      Both operators return the value of the corresponding optimized function value.
      The second operator takes a pointer to the :ref:`OECheckpoint1 <OEOpt_OECheckpoint1>` object
      that can be used to monitor the progress of an optimization.

   .. oe:method:: GetIterLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetIterLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetIterLimit() -> int

      See :oe:meth:`SetIterLimit<OEOpt::OEOptimizer2::SetIterLimit>`.

   .. oe:method:: GetTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTolerance() const

      .. oe:language:: python

         .. oe:api:: python

            GetTolerance() -> float

      See :oe:meth:`SetTolerance<OEOpt::OEOptimizer2::SetTolerance>`.

   .. oe:method:: SetIterLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetIterLimit(unsigned int itmax)

      .. oe:language:: python

         .. oe:api:: python

            SetIterLimit(itmax: int) -> None

      Defines the interface for setting the maximum number of iterations that an
      optimizer derived from the :ref:`OEOptimizer2 <OEOpt_OEOptimizer2>` will attempt while
      trying to identify a converged minimum function value. Optimization will cease if
      the iteration limit is reached without finding a converged minimum.

   .. oe:method:: SetTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTolerance(double t)

      .. oe:language:: python

         .. oe:api:: python

            SetTolerance(t: float) -> None

      Defines the interface for setting the gradient convergence criteria. Depending
      on the implementation it might be the root mean square gradient, gradient norm
      or gradient dot product. Optimization will terminate normally if the convergence 
      criteria set by this method is achieved during an optimization.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OEQNLineMinimize, QNLineMinimize

.. _OEOpt_OEQNLineMinimize:

.. oe:class:: OEQNLineMinimize

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEQNLineMinimize : public OELineMinimize

   The :ref:`OEQNLineMinimize <OEOpt_OEQNLineMinimize>` class implements line minimization for the
   optional use in quasi-Newton optimization.

   The following methods are publicly inherited from :ref:`OELineMinimize <OEOpt_OELineMinimize>`:
    * :oe:meth:`operator()<OEOpt::OELineMinimize::operator()>` 
    * :oe:meth:`CreateCopy<OEOpt::OELineMinimize::CreateCopy>` 
    * :oe:meth:`SetMaxStep<OEOpt::OELineMinimize::SetMaxStep>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEQNLineMinimize(double alpha = 1e-4, double beta = 0.9,
                             double approxzero = 1e-10, unsigned int lmmax = 32)

      .. oe:language:: python

         .. oe:api:: python

            OEQNLineMinimize(alpha: float = 1e-4, beta: float = 0.9,
                             approxzero: float = 1e-10, lmmax: int = 32) -> OEQNLineMinimize

      Default and copy constructors.
        


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OERibierePolakOpt, RibierePolakOpt

.. _OEOpt_OERibierePolakOpt:

.. oe:class:: OERibierePolakOpt

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OERibierePolakOpt : public OEOptimizer1

   The :ref:`OERibierePolakOpt <OEOpt_OERibierePolakOpt>` class implements the Polak-Ribière
   optimization method belonging to the family of conjugate gradient methods.
   The convergence criteria in based on  :math:`\sum_i {g_ig_i}`.

   The following methods are publicly inherited from :ref:`OEOptimizer1 <OEOpt_OEOptimizer1>`:
    * :oe:meth:`operator()<OEOpt::OEOptimizer1::operator()>`         
    * :oe:meth:`GetIterLimit<OEOpt::OEOptimizer1::GetIterLimit>` and
      :oe:meth:`SetIterLimit<OEOpt::OEOptimizer1::SetIterLimit>`
    * :oe:meth:`SetLineMinimize<OEOpt::OEOptimizer1::SetLineMinimize>`
    * :oe:meth:`GetTolerance<OEOpt::OEOptimizer1::GetTolerance>` and
      :oe:meth:`SetTolerance<OEOpt::OEOptimizer1::SetTolerance>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERibierePolakOpt()
            OERibierePolakOpt(const OERibierePolakOpt& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OERibierePolakOpt() -> OERibierePolakOpt
            OERibierePolakOpt(rhs: OERibierePolakOpt) -> OERibierePolakOpt

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERibierePolakOpt &operator=(const OERibierePolakOpt &rhs)

      Assignment operator.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OEOpt

.. meta::
   :keywords: OESteepestDescentOpt, SteepestDescentOpt

.. _OEOpt_OESteepestDescentOpt:

.. oe:class:: OESteepestDescentOpt

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESteepestDescentOpt : public OEOptimizer1

   The :ref:`OESteepestDescentOpt <OEOpt_OESteepestDescentOpt>` class implements the steepest descent
   optimization method. The convergence criteria in based on  :math:`\sum_i {g_ig_i}`.

   The following methods are publicly inherited from :ref:`OEOptimizer1 <OEOpt_OEOptimizer1>`:
    * :oe:meth:`operator()<OEOpt::OEOptimizer1::operator()>`         
    * :oe:meth:`GetIterLimit<OEOpt::OEOptimizer1::GetIterLimit>` and
      :oe:meth:`SetIterLimit<OEOpt::OEOptimizer1::SetIterLimit>`
    * :oe:meth:`GetTolerance<OEOpt::OEOptimizer1::GetTolerance>` and
      :oe:meth:`SetTolerance<OEOpt::OEOptimizer1::SetTolerance>`

   The :ref:`OESteepestDescentOpt <OEOpt_OESteepestDescentOpt>` class defines the following public methods:
    * :oe:meth:`SetInitialStep<OEOpt::OESteepestDescentOpt::SetInitialStep>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESteepestDescentOpt()

      .. oe:language:: python

         .. oe:api:: python

            OESteepestDescentOpt() -> OESteepestDescentOpt

      Default and copy constructors.

   .. oe:method:: SetInitialStep

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetInitialStep(double step)

      .. oe:language:: python

         .. oe:api:: python

            SetInitialStep(step: float) -> None

      Sets the initial step. The default initial step is :math:`\sqrt(1.0/\sum_i{g_ig_i})`



.. _OESheffClasses:

*******************
OESheff Classes
*******************

.. oe:namespace:: OESheff

.. toctree::

   OESheffield
   OESheffieldOptions


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESheff

..  _OESheffield:

.. meta::
   :keywords: OESheffield, Sheffield

.. _OESheff_OESheffield:

.. oe:class:: OESheffield

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESheffield : public OEMolPotential::OEMolFunc2

   This class represents `OESheffield`.

   .. _figure_OESheffield_Hierarchy:

   .. figure:: oefftk/images/OESheffield.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`   
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`     
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The :ref:`OESheffield <OESheff_OESheffield>` class defines the following public methods:
    * :oe:meth:`GetDielectricDerivative<OESheff::OESheffield::GetDielectricDerivative>`  
    * :oe:meth:`Set<OESheff::OESheffield::Set>`
    * :oe:meth:`SetCharges<OESheff::OESheffield::SetCharges>`
    * :oe:meth:`SetRadii<OESheff::OESheffield::SetRadii>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESheffield(double aa = 1.553149, double bb = 0.735694)
            OESheffield(const OESheffieldOptions&)
            OESheffield(const OESheffield&)

      .. oe:language:: python

         .. oe:api:: python

            OESheffield(argOptions: OESheffieldOptions) -> OESheffield
            OESheffield(arg2: OESheffield) -> OESheffield
            OESheffield(aa: float = 1.553149, bb: float = 0.735694) -> OESheffield

      Default and copy constructors.

      The first constructor uses default options and the second uses the user specific options.
      The default Sheffield model parameters are set according to 
      Grant *et. al.* (\ [Grant-2007]_\).       

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESheffield &operator=(const OESheffield &)

      Assignment operator.

   .. oe:method:: GetDielectricDerivative

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDielectricDerivative(const double* x, double solv_diel) const

      .. oe:language:: python

         .. oe:api:: python

            GetDielectricDerivative(x: OEDoubleArray, solv_diel: float) -> float

      Returns the derivative of the solvation energy with respect to the solvent
      dielectric constant.

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>&,
                  unsigned int = OEFuncType::Sheffield)
         bool Set(const OESystem::OEBinaryPredicate<OEChem::OEAtomBase, OEChem::OEAtomBase>&,
                  unsigned int = OEFuncType::Sheffield)

      Sets the unary and binary
      predicates respectively which might be used to modify the results of the calculations.
      Unary predicate might be used to selectively exclude a subset of atoms from the 
      calculation of molecule "self" energy, while the binary predicate can include
      only selected pairs of atoms in the calculation of solvation energy. By default
      when no predicates are set, atomic pairs are included in the solvation energy of 
      a molecule.

   .. oe:method:: SetCharges

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCharges(float*)

      .. oe:language:: python

         .. oe:api:: python

            SetCharges(ch: OEFloatArray) -> None

      Atomic charges are taken from the provided external array.

   .. oe:method:: SetRadii

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRadii(float*)

      .. oe:language:: python

         .. oe:api:: python

            SetRadii(ra: OEFloatArray) -> None

      Atomic radii values are taken from the provided external array.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESheff

.. meta::
   :keywords: OESheffieldOptions, SheffieldOptions

.. _OESheff_OESheffieldOptions:

.. oe:class:: OESheffieldOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESheffieldOptions : public OESystem::OEOptions

   This class orovides interface to setup options required for :ref:`OESheffield <OESheff_OESheffield>`
   calculations.
   
   The :ref:`OESheffieldOptions <OESheff_OESheffieldOptions>` class defines the following public methods:
    * :oe:meth:`GetA<OESheff::OESheffieldOptions::GetA>`
    * :oe:meth:`GetB<OESheff::OESheffieldOptions::GetB>` 
    * :oe:meth:`GetC<OESheff::OESheffieldOptions::GetC>`
    * :oe:meth:`GetSoluteDielectricConstant<OESheff::OESheffieldOptions::GetSoluteDielectricConstant>`
    * :oe:meth:`GetSolventDielectricConstant<OESheff::OESheffieldOptions::GetSolventDielectricConstant>`
    * :oe:meth:`SetA<OESheff::OESheffieldOptions::SetA>`
    * :oe:meth:`SetB<OESheff::OESheffieldOptions::SetB>`
    * :oe:meth:`SetC<OESheff::OESheffieldOptions::SetC>` 
    * :oe:meth:`SetSoluteDielectricConstant<OESheff::OESheffieldOptions::SetSoluteDielectricConstant>`
    * :oe:meth:`SetSolventDielectricConstant<OESheff::OESheffieldOptions::SetSolventDielectricConstant>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESheffieldOptions(const unsigned type = OESheffieldParamType::SmallMol);
            OESheffieldOptions(const OESheffieldOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OESheffieldOptions(type: int) -> OESheffieldOptions
            OESheffieldOptions(arg2: OESheffieldOptions) -> OESheffieldOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESheffieldOptions &operator=(const OESheffieldOptions &)

      Assignment operator.

   .. oe:method:: GetA

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetA() const

      .. oe:language:: python

         .. oe:api:: python

            GetA() -> float

      Gets the first Sheffield parameter value.

   .. oe:method:: GetB

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetB() const

      .. oe:language:: python

         .. oe:api:: python

            GetB() -> float

      Gets the second Sheffield parameter value.

   .. oe:method:: GetC

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetC() const

      .. oe:language:: python

         .. oe:api:: python

            GetC() -> float

      Gets the third Sheffield parameter value.

   .. oe:method:: GetSoluteDielectricConstant

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSoluteDielectricConstant() const

      .. oe:language:: python

         .. oe:api:: python

            GetSoluteDielectricConstant() -> float

      Gets the dielectric constant of the solute.

   .. oe:method:: GetSolventDielectricConstant

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSolventDielectricConstant() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolventDielectricConstant() -> float

      Gets the dielectric constant of the solvent.

   .. oe:method:: SetA

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetA(const double a)

      .. oe:language:: python

         .. oe:api:: python

            SetA(value: float) -> bool

      Optionally changes the first Sheffield parameter to the passed value ``a``.

   .. oe:method:: SetB

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetB(const double b)

      .. oe:language:: python

         .. oe:api:: python

            SetB(value: float) -> bool

      Optionally changes the second Sheffield parameter to the passed value ``b``.

   .. oe:method:: SetC

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetC(const double c)

      .. oe:language:: python

         .. oe:api:: python

            SetC(value: float) -> bool

      Optionally changes the third Sheffield parameter to the passed value ``c``.

   .. oe:method:: SetSoluteDielectricConstant

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSoluteDielectricConstant(const double epsilon)

      .. oe:language:: python

         .. oe:api:: python

            SetSoluteDielectricConstant(value: float) -> bool

      Sets the dielectric constant for the solute.

   .. oe:method:: SetSolventDielectricConstant

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSolventDielectricConstant(const double eps)

      .. oe:language:: python

         .. oe:api:: python

            SetSolventDielectricConstant(value: float) -> bool

      Sets the dielectric constant for the solvent.



.. oe:namespace:: OESheff

.. oe:constnamespace:: OESheffieldParamType

   This namespace contains constants that defines which set of Sheffield
   parameters are to be loaded in construction of :ref:`OESheffieldOptions <OESheff_OESheffieldOptions>`.

   .. oe:constant:: SmallMol

      Classical Sheffield parameters suitable for small-molecules

   .. oe:constant:: Protein

      Modified Sheffield parameters suitable for proteins and complexes


*******************************************************************************
OESheff Constants
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OESheffieldParamType


========
OEFF API
========

.. _oeff_part_api:

.. toctree::
   :maxdepth: 2

   OEOptClasses/OEOptClasses
   OEMolPotentialClasses/OEMolPotentialClasses
   OEMolPotentialConstants/OEMolPotentialConstants
   OEConstrClasses/OEConstrClasses
   OEMolMMFFClasses/OEMolMMFFClasses
   OEMolMMFFFunctions/index
   OEMolSmirnoffClasses/OEMolSmirnoffClasses
   OEMolSmirnoffConstants/index
   OESheffClasses/OESheffClasses
   OESheffConstants/index
   OEFFClasses/OEFFClasses
   OEFFFunctions/index
   OEFFConstants/index


.. _chapter_oeff_examples:

.. _oeff_part_examples:

********************************************************************************
OEFF Examples
********************************************************************************

Simple Functions and Optimization
==================================

.. _section_Func2Opt_example:

Solving a simple equation
-------------------------

The following example illustrates how to define a simple objective function. By
deriving the objective function from :ref:`OEFunc2 <OEOpt_OEFunc2>`, we can find the
roots of the simple quadratic equation using :ref:`OENewtonOpt <OEOpt_OENewtonOpt>` optimizer.
A class derived from :ref:`OEFunc2 <OEOpt_OEFunc2>` must contain analytical gradients
and Hessians. This example expects a number as input for the initial guess to solve
the simple function.

.. oe:source:: Func2Opt.cpp
   :language: c++
   :caption:  Define a simple objective function
   :refnum:   1

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Func2Opt.cpp <../../../../sublibs/tklibs/ff/examples/Func2Opt.cpp>`

.. oe:source:: Func2Opt.py
   :language: python
   :caption:  Define a simple objective function
   :refnum:   1

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Func2Opt.py <../../../../wrappers/python/examples/ff/Func2Opt.py>`

.. _section_Func1Chk_example:

Using checkpoints for optimization monitoring
---------------------------------------------
The following example illustrates how to define checkpoints and use then along with
optimizers to monitor progress during optimization. For simplicity, a simple quadratic
equation is defined as objective function and derived from :ref:`OEFunc1 <OEOpt_OEFunc1>`.
The quadratic equation is solved using the :ref:`OEBFGSOpt <OEOpt_OEBFGSOpt>` optimizer.
A class derived from :ref:`OEFunc1 <OEOpt_OEFunc1>` must contain analytical gradients. This
examples expects a number as input for the initial guess to solve the simple function.

.. oe:source:: Func1Chk.cpp
   :language: c++
   :caption:  Define and use checkpoints
   :refnum:   2

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Func1Chk.cpp <../../../../sublibs/tklibs/ff/examples/Func1Chk.cpp>`

.. oe:source:: Func1Chk.py
   :language: python
   :caption:  Define and use checkpoints
   :refnum:   2

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Func1Chk.py <../../../../wrappers/python/examples/ff/Func1Chk.py>`

Molecule Functions
===================

.. _section_Molfunc1Opt_example:

User defined molecule function
------------------------------
The following example illustrates how to define an objective function within the context
of a molecule. Generally speaking, a molecule function (:ref:`OEMolFunc <OEMolPotential_OEMolFunc>`) defines
some sort of interaction involving a part or all of a molecule. For simplicity, a simple
energy function is defined that consists sum of square of distance of all the atoms in the molecule.
The molecule function is optimized using the :ref:`OEBFGSOpt <OEOpt_OEBFGSOpt>` optimizer.
A class derived from :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` must contain analytical gradients.

.. oe:source:: Molfunc1Opt.cpp
   :language: c++
   :caption:  Define an objective function within the context of a molecule
   :refnum:   3

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Molfunc1Opt.cpp <../../../../sublibs/tklibs/ff/examples/Molfunc1Opt.cpp>`

.. oe:source:: Molfunc1Opt.py
   :language: python
   :caption:  Define an objective function within the context of a molecule
   :refnum:   3

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Molfunc1Opt.py <../../../../wrappers/python/examples/ff/Molfunc1Opt.py>`

Small Molecule Force fields
============================

.. _section_FFOptimize_example:

Single ligand in vacuum
------------------------
The following example illustrates how to calculate energy and optimize a single
ligand in vacuum. The molecule needs to be prepared (:oe:meth:`OEMolPotential::OEForceField::PrepMol`),
followed by a call to :oe:meth:`OEMolPotential::OEMolFunc::Setup` to create the interactions. Optimization is carried out using the :ref:`OEBFGSOpt <OEOpt_OEBFGSOpt>` optimizer.

.. oe:source:: FFOptimize.cpp
   :language: c++
   :caption:  Calculate energy and optimize a single ligand in vacuum
   :refnum:   4

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFOptimize.cpp <../../../../sublibs/tklibs/ff/examples/FFOptimize.cpp>`

.. oe:source:: FFOptimize.py
   :language: python
   :caption:  Calculate energy and optimize a single ligand in vacuum
   :refnum:   4

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFOptimize.py <../../../../wrappers/python/examples/ff/FFOptimize.py>`

.. _section_FFEnergy_example:

Energy components of a single ligand in vacuum
-----------------------------------------------

The following example illustrates how to obtain various intermolecular energy
components of a single ligand in vacuum.

.. oe:source:: FFEnergy.cpp
   :language: c++
   :caption:  Obtain intermolecular energy components of a single ligand in vacuum
   :refnum:   5

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFEnergy.cpp <../../../../sublibs/tklibs/ff/examples/FFEnergy.cpp>`

.. oe:source:: FFEnergy.py
   :language: python
   :caption:  Obtain intermolecular energy components of a single ligand in vacuum
   :refnum:   5

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFEnergy.py <../../../../wrappers/python/examples/ff/FFEnergy.py>`

.. _section_FFInteractions_example:

MMFF interactions of a single ligand
--------------------------------------

The following example illustrates how to obtain various interactions of a single ligand
in the context of a force field.

.. oe:source:: FFInteractions.cpp
   :language: c++
   :caption:  Obtain interactions of a single ligand in the context of a force field
   :refnum:   6

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFInteractions.cpp <../../../../sublibs/tklibs/ff/examples/FFInteractions.cpp>`

.. oe:source:: FFInteractions.py
   :language: python
   :caption:  Obtain interactions of a single ligand in the context of a force field
   :refnum:   6

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFInteractions.py <../../../../wrappers/python/examples/ff/FFInteractions.py>`

Protein-Ligand Complexes
========================

.. _section_FFComplexOpt_example:

Protein-ligand optimization
----------------------------

The following example illustrates how to set up a ligand optimization within the
context of a protein contained in a design unit.

.. oe:source:: FFComplexOpt.cpp
   :language: c++
   :caption:  Set up a ligand optimization
   :refnum:   7

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFComplexOpt.cpp <../../../../sublibs/tklibs/ff/examples/FFComplexOpt.cpp>`

.. oe:source:: FFComplexOpt.py
   :language: python
   :caption:  Set up a ligand optimization
   :refnum:   7

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFComplexOpt.py <../../../../wrappers/python/examples/ff/FFComplexOpt.py>`

Using adaptors
==============

.. _section_FFSubset_example:

Optimizing a single ligand with fixed atoms
--------------------------------------------

The following example illustrates how to fix a subset of atoms using the :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>` during a single ligand optimization in vacuum. The adaptor is initialized with
the force field interactions of the ligand, and passed as the objective function to be optimized.
Methods of the adaptor are used to convert between the Cartesian coordinates of the ligand and the
adaptor variables.

.. oe:source:: FFSubset.cpp
   :language: c++
   :caption:  Fix a subset of atoms
   :refnum:   8

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFSubset.cpp <../../../../sublibs/tklibs/ff/examples/FFSubset.cpp>`

.. oe:source:: FFSubset.py
   :language: python
   :caption:  Fix a subset of atoms
   :refnum:   8

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFSubset.py <../../../../wrappers/python/examples/ff/FFSubset.py>`

.. _section_FFTorAdaptor_example:

Optimizing a single ligand torsions
---------------------------------------------

The following example illustrates how to optimize a set of torsion angles using the :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>`
for a single ligand in vacuum. The adaptor is initialized with
the force field interactions of the ligand, and passed as the objective function to be optimized.
Methods of the adaptor are used to convert between the Cartesian coordinates of the ligand and the
adaptor variables.

.. oe:source:: FFTorAdaptor.cpp
   :language: c++
   :caption:  Optimize a set of torsion angles
   :refnum:   9

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFTorAdaptor.cpp <../../../../sublibs/tklibs/ff/examples/FFTorAdaptor.cpp>`

.. oe:source:: FFTorAdaptor.py
   :language: python
   :caption:  Optimize a set of torsion angles
   :refnum:   9

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFTorAdaptor.py <../../../../wrappers/python/examples/ff/FFTorAdaptor.py>`

.. _section_FFComplexQuat_example:

Optimizing rigid ligand in protein
-----------------------------------

The following example illustrates how to perform rigid optimization of a ligand in the context of a protein using the :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>`. The adaptor is initialized with
the protein-ligand interactions, and passed as the objective function to be optimized.
Methods of the adaptor are used to convert between the Cartesian coordinates of the ligand and the
adaptor variables.

.. oe:source:: FFComplexQuat.cpp
   :language: c++
   :caption:  Perform rigid optimization of a ligand
   :refnum:   10

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFComplexQuat.cpp <../../../../sublibs/tklibs/ff/examples/FFComplexQuat.cpp>`

.. oe:source:: FFComplexQuat.py
   :language: python
   :caption:  Perform rigid optimization of a ligand
   :refnum:   10

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFComplexQuat.py <../../../../wrappers/python/examples/ff/FFComplexQuat.py>`

Custom Force Fields
==========================

.. _section_FFCustomSmirnoff_example:

Custom Smirnoff
------------------------
The following example illustrates how to load custom SMIRNOFF force field parameters from
an OFFXML file and use that to calculate energy and optimize a single ligand
in vacuum.

.. oe:source:: FFCustomSmirnoff.cpp
   :language: c++
   :caption:  Load custom SMIRNOFF force field parameters
   :refnum:   11

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFCustomSmirnoff.cpp <../../../../sublibs/tklibs/ff/examples/FFCustomSmirnoff.cpp>`

.. oe:source:: FFCustomSmirnoff.py
   :language: python
   :caption:  Load custom SMIRNOFF force field parameters
   :refnum:   11

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`FFCustomSmirnoff.py <../../../../wrappers/python/examples/ff/FFCustomSmirnoff.py>`



.. |A|         replace:: Å

.. _oeff_part_theory:

.. _chapter_fftheory:

**********************************
Theory
**********************************

Components
==========

.. _section_funcs:

Objective Functions
-------------------

At the core of the objective functions are pure virtual interfaces :ref:`OEFunc0 <OEOpt_OEFunc0>`,
:ref:`OEFunc1 <OEOpt_OEFunc1>` and :ref:`OEFunc2 <OEOpt_OEFunc2>`. A new objective function can be defined by providing appropriate expressions for these interface methods. The objective functions can be used along with the optimizers to find the minima of any function.

.. _section_molfuncs:

Molecule Objective Function
---------------------------

The molecule objective functions extend the objective function interfaces to define molecular interactions through :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`.  Similar to the objective functions, a new molecule objective function can also be defined by providing the appropriate expressions for the interface methods.  All of the force field components are defined as molecule objective functions to allow easy minimization of molecule systems.

.. _section_adaptors:

Adaptors
--------

Adaptors wrap molecule objective functions to allow working in different coordinate systems, instead of the default all atom Cartesian coordinates.  Adaptors can be powerful tool for selective energy evaluation and minimization of specific subdomains.  Methods to convert between the adaptor coordinates and the Cartesian coordinates are also provided through these interfaces.

.. _section_opts:

Optimizers
----------

A number of general purpose optimizers are provided that can be used to minimize any basic or extended objective functions. Optimizer interfaces are defined through :ref:`OEOptimizer1 <OEOpt_OEOptimizer1>` and :ref:`OEOptimizer2 <OEOpt_OEOptimizer2>`. Pros and cons of various optimizers are established in the literature, and one needs to use their understanding of the problem in choosing the appropriate optimizer.  Optimizers that can solve objective functions with known gradients but no Hessian (:ref:`OEOptimizer1 <OEOpt_OEOptimizer1>`) requires an additional line minimizer (:ref:`OELineMinimize <OEOpt_OELineMinimize>`).

.. _section_oeff_forceefield:

Force Field
===========

.. _section_mmff:

MMFF
----

The MMFF potential expression is:

.. math::

   V_{MMFF} = \sum_{b}V_{b} + \sum_{a}V_{a} + \sum_{s}V_{s} + \sum_{o}V_{o} + \sum_{t}V_{t} + \sum_{v}V_{v} + \sum_{c}V_{c}

where the seven terms respectively describe bond stretching (`b`),
angle bending (`a`), stretch-bending (`s`), out-of-plane bending
(`o`), torsion (`t`), Van der Waals (`v`) and electrostatic (`c`)
interactions. Their functional forms are given below.

Bond stretching
~~~~~~~~~~~~~~~

For a bond `b` between atoms `i` and `j` the stretching potential is:

.. math::

   V_b = 143.9325 \frac{k_{ij}}{2} \Delta r_{ij}^2(1 + c_s \Delta r_{ij} + 7/12c_{s}^2 \Delta r_{ij}^2)

where :math:`k_{ij}` is the force constant,
:math:`\Delta r_{ij}` is the difference between actual and reference
bond lengths, and :math:`c_s` is so called "cubic-stretch" constant
for which the value is -2 |A|:math:`^{-1}`.

Angle bending
~~~~~~~~~~~~~

The bending potential of a bond angle `a` made by the bonds between
atoms `i`, `j` and atoms `j`, `k` is given by:

.. math::

   V_a = 0.043844\frac{k_{ijk}}{2} \Delta \vartheta_{ijk}^{2}(1+c_b \Delta \vartheta_{ijk})

where :math:`k_{ijk}` is the force constant, :math:`\Delta
\vartheta_{ijk}` is the difference between actual and reference bond
angles, and :math:`c_b` is the so called "cubic-bend" constant for which
the value is :math:`-0.4 rad^{-1}`.

Stretch-bend interaction
~~~~~~~~~~~~~~~~~~~~~~~~

The coupling between the stretching potential of two bonds forming a
bond angle and bending that angle is described by:

.. math::

   V_s = 2.5121(k_{ijk} \Delta r_{ij} + k_{kji} \Delta r_{kj})\Delta \vartheta_{ijk}

where :math:`k_{ijk}` and :math:`k_{kji}` are force constants which
couple stretches of `i-j` and `k-j` to the `i-j-k` bend
respectively. :math:`\Delta r` and :math:`\Delta \vartheta` are defined above.

Out-of-plane bending
~~~~~~~~~~~~~~~~~~~~

For a trigonal center `j`, the potential of displacement for an atom
`l` bonded to atom `j` out of plane `i-j-k` is:

.. math::

   V_o = 0.043844\frac{k_{ijkl}}{2} \chi_{ijkl}^2

where :math:`k_{ijkl}` is the force constant and :math:`\chi_{ijkl}` is an
angle formed by the bond `j-l` and the plane `i-j-k`.

Torsion interactions
~~~~~~~~~~~~~~~~~~~~

For every four bonded atoms `i-j-k-l` the torsion interaction is
described by the term:

.. math::

   V_t = 0.5(V_1(1 + \cos\Phi) + V_2(1 - \cos2\Phi) +V_3(1+ \cos3\Phi)

where :math:`V_1`, :math:`V_2` and :math:`V_3` are constants depending on atoms `i`,
`j`, `k`, `l`, and :math:`\Phi` is the dihedral angle formed by bonds
`i-j` and `k-l`.

.. _sub-section_VdW:

Van der Waals interactions
~~~~~~~~~~~~~~~~~~~~~~~~~~

For a pair of atoms `i` and `j` separated by three or more bonds,
where the distance between them is :math:`r_{ij}`, MMFF adopts the
following Van der Waals potential:

.. math::

   V_v = \epsilon_{ij} \left(\frac{1.07R_{ij}}{r_{ij}+0.07R_{ij}} \right) ^7 \left( \frac{1.12R_{ij}^7}{r_{ij}^7+0.12R_{ij}} -2 \right)

where :math:`R_{ij}` and :math:`\epsilon_{ij}` are defined as follows:

.. math::

   R_{i} = A_i\alpha_i^{0.25}

.. math::

   R_{ij} = 0.5(R_i + R_j)(1+B(1-\exp(-12\gamma_{ij}^2)))

.. math::

   \gamma_{ij} = (R_i - R_j)/(R_i + R_j)

.. math::

   \epsilon_{ij} = \frac{181.16G_iG_j \alpha_i \alpha_j}{(\alpha_i/N_i)^{0.5} + (\alpha_j/N_j)^{0.5}} \frac{1}{R_{ij}^6}

where :math:`\alpha_i` is atomic polarizability of atom `i`, `B` is 0.2 or
0.0 if one of the atoms is polar hydrogen, :math:`N_i` and :math:`N_j` are the
Slater-Kirkwood effective numbers of valence electrons, :math:`G_i`, :math:`G_j`
and :math:`A_i` are scale factors.

.. _sub-section_electrostatic:

Electrostatic interactions
~~~~~~~~~~~~~~~~~~~~~~~~~~

The electrostatic interaction between two charged atoms `i` and `j`
separated by at least three bonds is calculated from the standard
Coulombic expression:

.. math::

   V_c = f\frac{332.0716q_iq_j}{D(r_{ij} + \delta)}

where `D` is the dielectric constant for which the default value is 1,
:math:`q_i` and :math:`q_j` are the MMFF partial charges on atoms `i` and `j`,
:math:`r_{ij}` is the interatomic distance, :math:`\delta` is the "electrostatic
buffering" constant of 0.05 |A|. Scaling factor `f` is 0.75 for 1,4
interactions, and 1.0 otherwise.

.. _section_ff14sb:

FF14SB
------

FF14SB is Amber primary force field for protein modeling. Its details are described
in the paper of Maier et al. ([Maier-2015]_) and in http://ambermd.org/AmberModels.php. 
The functional form of FF14SB  is described under the chapter "AMBER force field terms".  

.. _section_smirnoff:

SMIRNOFF
--------

SMIRNOFF (SMIRKS Natural Open Force Field) is a kind of small-molecule force field
springing from the Open Force Field Initiative (OFF Initiative or OFFI)
(https://openforcefield.org/). The key feature of this force field is its chemical
representation of parameters by using extended SMARTS patterns. "Extended"
here means that the SMARTS patterns also use atom assignment syntax from SMIRKS. For example,
``[*:2]~[*:1]~[#1]`` specifies three atoms, where the first is assigned to be atom 2,
the second atom is assigned to be atom 1, and the third atom is not assigned. This format
frees the force field from using atom types, instead it uses the direct chemical perception
of the extended SMARTS patterns ([Mobley-2018]_).
Compared to traditional atom typing approaches, this representation greatly reduces the
number of parameters needed to specify a general small-molecule force field and makes
each parameter more independent.

While it currently has a traditional "Amber" type functional form as specified below,
future versions expect to modify the functional form. The OFF Initiative will be releasing
periodic revisions of the parameters which will include changes to the chemical
specifications (i.e. the extended SMARTS patterns) as well as the numerical parameters.
The revision used by the API points will be given with the results.

Currently SMIRNOFF force field has 6 similar to those in AMBER force field and are given below.

.. _section_amber_type_terms:

AMBER force field terms
-----------------------

Amber force field functional form has 6 terms:

.. math::

   V_{AMBER} = \sum_{b}V_{b} + \sum_{a}V_{a} + \sum_{o}V_{o} + \sum_{t}V_{t} + \sum_{v}V_{v} + \sum_{c}V_{c}

describing respectively bond stretching (`b`), angle bending (`a`),
out-of-plane displacement (`o`), torsion (`t`), Van der Waals (`v`) and electrostatic (`c`)
interactions.

Bond stretching
~~~~~~~~~~~~~~~

For `a` bond `b` the stretching potential has a simple harmonic form:

.. math::

   V_b = k_b(r - r_0)^2

where :math:`k_b` is the force constant, :math:`r`, and :math:`r_0` are actual and
reference bond length, respectively.

Angle bending
~~~~~~~~~~~~~

For bond angle `a`, the angle bending potential form is:

.. math::

   V_a = k_a(\alpha - \alpha_0)^2

where :math:`k_a` is the force constant, :math:`\alpha`, and :math:`\alpha_0` are actual and
reference bond angle values, respectively.

Torsion interactions
~~~~~~~~~~~~~~~~~~~~

Every 4 bonded atoms defined a torsion whose energy is represented with 1 to 6
terms of a Fourier series:

.. math::

   V_t = \sum_n{V_n/d_n(1+\cos{(p_n\theta - \gamma_n)})}

where :math:`V_n`, :math:`d_n`, :math:`p_n` and :math:`\gamma_n` are barrier height, degeneracy,
periodicity and phase for the `n` component of a torsion whose dihedral angle is :math:`\theta`

Out-of-plane bending
~~~~~~~~~~~~~~~~~~~~

It is defined as potential of a displacement of the trigonal center atom `a` bonded to 3 other
out-of-plane atoms, `b`, `c` and `d`.
Its functional form is similar to a regular torsion with a single term. Sometimes it is also called
an `improper torsion`.

.. math::

   V_o = V(1+\cos{(p \theta - \gamma)})

While in FF14SB this term is used to preserved planarity of the sp2 configuration, any improper torsion
moving a central trigonal atom out of plane can be used, in SMIRNOFF this term has been redefined to
account for the fact that one can define 3 improper torsions of moving a trigonal atom `a` out of plane defined by
atoms `b`, `c` and `d`. The energy of such a displacement in SMIRNOFF is calculated as 1/3 of the sum of
those torsions. 

Van der Waals interactions
~~~~~~~~~~~~~~~~~~~~~~~~~~

For a pair of nonbonded atoms `i` and `j`, SMIRNOFF force field adopts Lennard-Jones
potential:

.. math::

   V_v = \epsilon_{ij}\left[\left(\frac{R_{ij}}{r_{ij}}\right)^{12}
               -2\left(\frac{R_{ij}}{r_{ij}}\right)^6\right]

where :math:`\epsilon_{ij}` is well depth, :math:`R_{ij}` and :math:`r_{ij}` are the
equilibrium and actual distance between atoms `i` and `j`, respectively.

Electrostatic interactions
~~~~~~~~~~~~~~~~~~~~~~~~~~

A simple Coulomb term:

.. math::

   V_c = \frac{q_iq_j}{4\pi\epsilon_0r_{ij}}

represents Coulomb interactions, where :math:`q_i` and :math:`q_j` are partial atomic charges,
:math:`\epsilon_0` is the vacuum permittivity, and :math:`r_{ij}` is the distance between atoms
`i` and `j`.

.. _section_mmff_amber:

MMFFAmber
---------

.. _sub-section_MMFF-AMBER:

Intermolecular Amber potential
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Intermolecular interaction can be described by the Amber force field instead
of MMFF potential:

.. math::

   V_{Amber} = \sum_{i,j} \left\{ \epsilon_{ij}\left[\left(\frac{R_{ij}}{r_{ij}}\right)^{12}
               -2\left(\frac{R_{ij}}{r_{ij}}\right)^6\right] +
               \frac{q_iq_j}{4\pi\epsilon_0r_{ij}}\right\}

where the summation is over protein-ligand atom pairs. :math:`r_{ij}` is the interatomic distance,
:math:`R_{ij}` is the VdW distance for a pair of atoms, :math:`q_i` and :math:`q_j` are the Amber
partial charges on atoms `i` and `j`, and :math:`\epsilon_0` is the vacuum permittivity.
VdW parameters :math:`R_{ij}` and :math:`\epsilon_{ij}` and partial charges are taken from work by Wang and coworkers
(\ [Wang-J-2000]_\).

MMFFIEFF
--------

.. _sub-section_MMFF-IEFF:

Intermolecular IEFF potential
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Intermolecular interaction can be described by the IEFF (Intermolecular Force Field) instead
of MMFF potential.

The IEFF is an ongoing development effort internally at **OpenEye** to obtain high accuracy
Intermolecular Force Field. The initial development of IEFF was done during 2010. The goal of
the initial development was to prove internally at OpenEye as well as to external collaborators
that point charge monopole approximation in the Coulomb terms are inadequate to capture
intermolecular Coulomb interactions within chemical accuracy (within about 1 kcal/mol) regardless
of the charge models used. The higher accuracy in the Coulomb terms is especially important and
vital in optimizing and ranking organic crystal structures. The initial IEFF development has had
some successful crystal predictions. It has also clearly shown, for the formamide dimer case,
that there is a 1D energy curve along a given torsion angle where all tested point charge models fails even qualitatively showing repulsive interactions while accurate ab-initio calculations and
IEFF with multipole based Coulomb interactions show a minimum along the torsion with great
agreement to each other.

The IEFF has not been improved significantly since those initial academic studies and cannot be
considered as a general purpose intermolecular force field due to lack of sufficient coverage.
However, major development effort is underway to make IEFF an industry quality general
intermolecular force field.

The currently available IEFF supports only a few selected elements that were the most important
ones for organic crystal predictions, including H, C, N, O, S, F, and Cl. The atomic multipoles
are obtained by an internal analysis program that obtains the SCF converged density matrices from
ab-initio (PSI4) calculations. The current IEFF does not use any atom types, all VdW parameters
are associated to each element types. This obviously introduces a very significant weakness
especially for hydrogens where both polar and apolar hydrogens share the same FF parameters but
it is also important deficiency for other elements as well. The new version of the IEFF that is
under development will try to address all of these deficiencies.

Sheffield  Model
=========================

.. _section_small_molecules:

Small molecules
---------------

The "Sheffield Solvation Model" \ [Grant-2007]_ \ is a simple two parameter model for calculating the 
electrostatic component of molecular solvation energy. The Sheffield model is robust and works well for
calculating solvation energies of small drug-like molecules with good accuracy, when compared against
the more accurate Poisson–Boltzmann calculations, and requires significantly low computational resource.
The model is represented by the following simple expression:

.. math::

   E_{Sheff} = -\frac{f_{\epsilon}}{4\pi\epsilon_{0}}\frac{1}{2}
   {\sum_{i,j}}\frac{Q_iQ_j}{\sqrt{A\sigma_i\sigma_j + BR_{ij}^{2}}}

where :math:`f_{\epsilon}` is

.. math::

   f_{\epsilon} = \frac{1}{\epsilon_{in}} - \frac{1}{\epsilon_{out}}

and :math:`\epsilon_{in}`, :math:`\epsilon_{out}` are he relative permittivities (dielectric constants)
in solute and solvent, respectively. :math:`Q_i` and :math:`Q_j` are charges on atoms i and j,
:math:`\sigma_i` and :math:`\sigma_j` are corresponding atomic radii, and :math:`R_{ij}` is an
interatomic distance between atoms i and j. :math:`A` and :math:`B` are parameters to the model.

This model works well in the situation where atoms in molecules are well exposed to the solvent.
In macromolecules like proteins, this condition is not met.

.. _section_proteins:

Proteins
--------

In order to apply Sheffield model for proteins and complexes a modification is required to correct 
the atomic radii according to their exposure to solvent. The correction to atomic radii is
applied by introduction of a third parameter to the original two parameter model.

.. math::

   \sigma_i = \sigma_{0,i} + C\left(1 - \sqrt\frac{S_i}{S_{0,i}} \right)

where :math:`S_i` and :math:`S_{0,i}` are atomic contributions to the solvent accessible surface of atom
:math:`i`  in the protein and in a residue to which it belongs which was isolated from the rest of the
protein. Initial atomic radii :math:`\sigma_{0,i}` was assumed to be of ZAP9 \ [Nicholls-2010]_\  type.


.. oefftk toolkit documentation master file

.. _oeff_part:

###############################
OEFF Toolkit |oeff_version|
###############################

.. attention::

   **OEFF TK** is currently only available in C++ and Python.

.. toctree::
   :maxdepth: 3

   fftheory
   examples
   api
   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _oeff_part_releasenotes:

********************************
Release History
********************************

.. toctree::
   :maxdepth: 1

   version2_9_2
   version2_9_1
   version2_9_0
   version2_8_0
   version2_7_1
   version2_7_0
   version2_5_2
   version2_5_1
   version2_5_0
   version2_4_0
   version2_3_1
   version2_3_0
   version2_2_0
   version2_1_0
   version2_0_4
   version2_0_3
   version2_0_2
   version2_0_1
   version2_0_0


OEFF TK 2.0.0
================================================================================

Licensing
--------------------------------------------------------------------------------

* **OEFF TK** is available to anyone with an **OESzybki TK** license.
  Visit https://www.eyesopen.com/contact if you need an **OESzybki TK** license.

OEFF functionality
--------------------------------------------------------------------------------

This is the first official release of **OEFF TK**.  The underlying
functionality was previously released in C++ as part of the
**OESzybki TK** advanced interface. This toolkit is currently available in
C++ and Python.  An overview of its capabilities is provided below.

**OEFF TK** provides access to powerful low-level functionality for
advanced users to develop molecular modeling applications.
With **OEFF TK**, users also have the ability to create variations
of molecular interaction classes for energy evaluation and optimization,
adding to the built-in interactions, if desired.  **OESzybki TK**
complements **OEFF TK** as the high-level API for molecular modeling
functionalities. 

Objective functions and molecular interactions
--------------------------------------------------------------------------------

All molecular interactions are objective functions with additional API
points for molecular definitions. A set of pure virtual classes
that can be used to define new interactions are provided for both generic
objective functions and molecule specific interaction functions.  The
following virtual base classes are available:

- :ref:`OEFunc0 <OEOpt_OEFunc0>`
- :ref:`OEFunc1 <OEOpt_OEFunc1>`
- :ref:`OEFunc2 <OEOpt_OEFunc2>`
- :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`
- :ref:`OEMolFunc0 <OEMolPotential_OEMolFunc0>`
- :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>`
- :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`

Force fields
--------------------------------------------------------------------------------

Force fields and components of force fields are defined as molecule objective
functions and are derived from the above-specified base classes.  The
following force fields and components are available:

- :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
- ``OEMolMMFF::OEMMFFBend``
- ``OEMolMMFF::OEMMFFStretch``
- :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>`
- ``OEMolMMFF::OEMMFFOutOfPlane``
- ``OEMolMMFF::OEMMFFTorsion``
- ``OEMolMMFF::OEMMFFVdw``
- ``OEMolMMFF::OEMMFFInterVdw``
- ``OEMolMMFF::OEMMFFInterVdwNN``
- ``OEMolMMFF::OEMMFFCoulomb``
- ``OEMolMMFF::OEMMFFInterCoulomb``
- ``OEFF::OEMMFFAmber``
- :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`
- :ref:`OESheffield <OESheff_OESheffield>`

Optimizers
--------------------------------------------------------------------------------

A powerful set of optimizers that can be used to optimize objective
functions is now available:

- :ref:`OEBFGSOpt <OEOpt_OEBFGSOpt>`
- :ref:`OEConjGradOpt <OEOpt_OEConjGradOpt>`
- :ref:`OEDFPOpt <OEOpt_OEDFPOpt>`
- :ref:`OEFletcherReevesOpt <OEOpt_OEFletcherReevesOpt>`
- :ref:`OENewtonOpt <OEOpt_OENewtonOpt>`
- :ref:`OERibierePolakOpt <OEOpt_OERibierePolakOpt>`
- :ref:`OESteepestDescentOpt <OEOpt_OESteepestDescentOpt>`

Adaptors
--------------------------------------------------------------------------------

Adaptors that can be used to optimize molecule objective functions in
transformed coordinate space are now available:

- :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>`
- :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>`
- :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`
- :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>`
- :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>`

New features
--------------------------------------------------------------------------------

* Two new intermolecular force fields, ``OEFF::OEMMFFAmber`` and
  :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`, have been added to the force field suites for
  molecular interactions.  Both force fields use :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
  for intermolecular interactions and more accurate components for
  intermolecular interactions.

* A new class, ``OEFF::OEMMFFAmberOptions``, has been added that sets
  all options of the ``OEFF::OEMMFFAmber`` object during its
  construction.

* A new class, :ref:`OEMMFFIEFFOptions <OEFF_OEMMFFIEFFOptions>`, has been added that sets
  all options of the :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>` object during its
  construction.

* A new class, :ref:`OESheffieldOptions <OESheff_OESheffieldOptions>`, has been added that
  sets all options of the :ref:`OESheffield <OESheff_OESheffield>` object during its
  construction.  All :ref:`OESheffield <OESheff_OESheffield>` methods with similar
  names as their :ref:`OESheffieldOptions <OESheff_OESheffieldOptions>` counterparts are now
  deprecated.

  The following table shows the older, deprecated functions and their
  new option replacements:

  =========================================================   ======================================================================== 
  Deprecated                                                  New option-based
  ---------------------------------------------------------   ------------------------------------------------------------------------ 
  ``OESheff::OESheffield::Set_A``                             :oe:meth:`OESheff::OESheffieldOptions::SetA`

  ``OESheff::OESheffield::Set_B``                             :oe:meth:`OESheff::OESheffieldOptions::SetB`

  ``OESheff::OESheffield::SetSoluteDielectricConstant``       :oe:meth:`OESheff::OESheffieldOptions::SetSoluteDielectricConstant`

  ``OESheff::OESheffield::SetSolventDielectricConstant``      :oe:meth:`OESheff::OESheffieldOptions::SetSolventDielectricConstant`

  ``OESheff::OESheffield::GetParameters``                     :oe:meth:`OESheff::OESheffieldOptions::GetA`  
                                                              :oe:meth:`OESheff::OESheffieldOptions::GetB`  
                                                              :oe:meth:`OESheff::OESheffieldOptions::GetSoluteDielectricConstant`  
                                                              :oe:meth:`OESheff::OESheffieldOptions::GetSolventDielectricConstant`

  =========================================================   ======================================================================== 


OEFF TK 2.0.1
================================================================================

New features
--------------------------------------------------------------------------------

* A set of classes that were previously derived from
  :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` are now derived from
  :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`.  With this change,
  all of these classes now provide analytical Hessians and can be optimized
  with :ref:`OENewtonOpt <OEOpt_OENewtonOpt>`.  The list of classes is as follows:

  * ``OEMolMMFF::OEMMFFBend``
  * ``OEMolMMFF::OEMMFFStretch``
  * ``OEMolMMFF::OEMMFFTorsion``
  * ``OEMolMMFF::OEMMFFCoulomb``
  * ``OEMolMMFF::OEMMFFOutOfPlane``
  * :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>`
  * ``OEMolMMFF::OEMMFFVdw``
  * :ref:`OESheffield <OESheff_OESheffield>`

* A new class, :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`, has been added that
  extends :ref:`OEForceField <OEMolPotential_OEForceField>` to be an
  :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>` and provide Hessians.

* Two of the :ref:`OEForceField <OEMolPotential_OEForceField>` classes,
  :ref:`OEMMFF <OEMolMMFF_OEMMFF>` and ``OEFF::OEMMFFAmber``, now derive from
  :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`.

* Two of the :ref:`OEForceField <OEMolPotential_OEForceField>` methods,
  ``OEMolPotential::OEForceField::Add`` and
  ``OEMolPotential::OEForceField::Remove``, have been deprecated and
  replaced by more user-friendly methods in the derived classes
  :ref:`OEGenericFF <OEMolPotential_OEGenericFF>` and
  :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`.

  The following table shows the older, deprecated functions and their
  replacements:

  ========================================   =======================================================
  Deprecated                                 New
  ----------------------------------------   -------------------------------------------------------
  ``OEMolPotential::OEForceField::Add``      :oe:meth:`OEMolPotential::OEGenericFF::AddMolFunc`
                                             :oe:meth:`OEMolPotential::OEGenericFF2::AddMolFunc`

  ``OEMolPotential::OEForceField::Remove``   :oe:meth:`OEMolPotential::OEGenericFF::RemoveMolFunc`
                                             :oe:meth:`OEMolPotential::OEGenericFF2::RemoveMolFunc`
  ========================================   =======================================================

* A new method, :oe:meth:`OEMolPotential::OEGenericFF::GetComponents`, has been
  added that gives access to the function components of the force field.

* A new class, :ref:`OEMolAdaptor2 <OEMolPotential_OEMolAdaptor2>`, has been added that
  extends the :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>` to be an
  :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>` and provide Hessians.

* The :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>` class now derives from
  :ref:`OEMolAdaptor2 <OEMolPotential_OEMolAdaptor2>`.

* A new class, :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>`, has been added that
  can be used to convert any :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` into an
  :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>` with numerical Hessians.

* A new class, :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>`, has been added that
  can be used to scale (up or down) any :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` or
  :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>` derived classes.

Minor Bug Fixes
--------------------------------------------------------------------------------

* The constructor for the OEMMFFCoulomb class previously
  had an unused :ref:`OEFFParams <OEMolPotential_OEFFParams>` parameter.  A new
  overload without this parameter has been added, and the older constructor
  has been deprecated.
  For updated information, see :ref:`Deprecated OEFF Classes <deprecated_OEFF_classes>`.



OEFF TK 2.0.2
================================================================================

* Minor internal improvements have been made.



OEFF TK 2.0.3
================================================================================

New features
--------------------------------------------------------------------------------

* A new :ref:`OEMMFFSheffield <OEFF_OEMMFFSheffield>` class and a new
  :oe:constns:`OEFF::OEMMFFSheffieldFFType` namespace have been added to
  the force field suites for molecular interactions.  This is a hybrid
  force field consisting of :ref:`OEMMFF <OEMolMMFF_OEMMFF>` and
  :ref:`OESheffield <OESheff_OESheffield>`.

* A new :ref:`OEMMFFSheffieldOptions <OEFF_OEMMFFSheffieldOptions>` class has been added to set
  all options of an :ref:`OEMMFFSheffield <OEFF_OEMMFFSheffield>` object during its
  construction.

* A new :oe:func:`OEFF::OEGetMMFFSheffieldFFName` function has been added to provide
  the force field name corresponding to a specific variation of a force field type.

* A new :oe:func:`OEFF::OEGetMMFFSheffieldFFType` function has been added to provide
  a specific variation of the force field type corresponding to a force field name.

* A new :oe:func:`OEFF::OEIsValidMMFFSheffieldFF` function has been added that can check
  if a type ID or name corresponds to a valid :ref:`OEMMFFSheffield <OEFF_OEMMFFSheffield>`
  force field type.

* New :oe:meth:`OEMolPotential::OEForceField::GetTitle` and
  :oe:meth:`OEMolPotential::OEForceField::SetTitle` methods have been
  added to set and return the title of the force field.

Minor bug fixes
--------------------------------------------------------------------------------

* Water is now treated as natural residue in the AMBER force field.

Documentation changes
--------------------------------------------------------------------------------

* A minor fix has been made in the example in the
  :ref:`section_FFInteractions_example` section.


OEFF TK 2.0.4
================================================================================

* Minor internal improvements have been made.


OEFF TK 2.1.0
================================================================================

New features
--------------------------------------------------------------------------------
* A new class, :ref:`OESmirnoff <OEMolSmirnoff_OESmirnoff>`, has been added that facilitates
  creating a SMIRNOFF force field (release 0.3), a small-molecule force field that
  uses extended SMARTS patterns for its chemical representation of parameters
  (https://openforcefield.org/). The following classes have also been added that
  define interaction functions using the functional forms in the SMIRNOFF force field:

   * :ref:`OESmirnoffParams <OEMolSmirnoff_OESmirnoffParams>`
   * ``OEMolSmirnoff::OESmirnoffStretch``
   * ``OEMolSmirnoff::OESmirnoffBend``
   * ``OEMolSmirnoff::OESmirnoffTorsion``
   * ``OEMolSmirnoff::OESmirnoffOutOfPlane``
   * ``OEMolSmirnoff::OESmirnoffVdw``
   * ``OEMolSmirnoff::OESmirnoffInterVdw``
   * ``OEMolSmirnoff::OESmirnoffCoulomb``

* The following classes, derived from the parent class :ref:`OEInteractParams <OEMolPotential_OEInteractParams>`,
  have been added to create a set of force field parameters for a given molecule:

   * :ref:`OEStretchParams <OEMolPotential_OEStretchParams>`
   * :ref:`OEBendParams <OEMolPotential_OEBendParams>`
   * :ref:`OETorsionParams <OEMolPotential_OETorsionParams>`
   * :ref:`OEVdwParams <OEMolPotential_OEVdwParams>`
   * :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>`

* The :oe:const:`OEMolPotential::OEFFParam` namespace has been expanded to
  support SMIRNOFF force field torsion potential.

* A new method, :oe:meth:`GetIterLimit<OEOpt::OEOptimizer0::GetIterLimit>`, has been
  added that allows assessing the state of an :ref:`OEOptimizer0 <OEOpt_OEOptimizer0>`.

* Two new methods, :oe:meth:`GetIterLimit<OEOpt::OEOptimizer1::GetIterLimit>` and
  :oe:meth:`GetTolerance<OEOpt::OEOptimizer1::GetTolerance>`, have been
  added that allow assessing the state of an :ref:`OEOptimizer1 <OEOpt_OEOptimizer1>`.

* Two new methods, :oe:meth:`GetIterLimit<OEOpt::OEOptimizer2::GetIterLimit>` and
  :oe:meth:`GetTolerance<OEOpt::OEOptimizer2::GetTolerance>`, have been
  added that allow assessing the state of an :ref:`OEOptimizer2 <OEOpt_OEOptimizer2>`.

Major bug fixes
--------------------------------------------------------------------------------

* A memory leak in :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>` has been fixed.

* A memory leak in :ref:`OEAM1 <OEMolAM1_OEAM1>` has been fixed.

Documentation changes
--------------------------------------------------------------------------------

* Theory documentation for SMIRNOFF has been added (see :ref:`section_smirnoff`).

* A new example program was written that demonstrated calculating
  energy and optimizing a single ligand in vacuum.

* The following example programs have been corrected:

  * ``section_mmff_example``
  * ``section_mmff_energy_example``
  * ``section_mmff_interactions_example``
  * ``section_mmff_complex_example``
  * ``section_mmff_amber_example``
  * ``section_mmff_subset_example``
  * ``section_mmff_tor_example``
  * ``section_mmff_amber_quat_example``




OEFF TK 2.2.0
================================================================================

New features
--------------------------------------------------------------------------------
* OpenFF parameters ``parsley_1.0.0`` and ``parsley_1.1.1`` are now built-in parameters and can be used
  in the construction of an :ref:`OESmirnoff <OEMolSmirnoff_OESmirnoff>` object.

* Beginning with this release, custom OpenFF parameters in XML file format can be used.
  This functionality is achieved by the overloaded method
  :oe:meth:`OEMolSmirnoff::OESmirnoffParams::Load`.

* A new set of preliminary api force field classes has been added to simplify working with the host-guest
  complex system:

  * :ref:`OEComplexFF <OEFF_OEComplexFF>`
  * :ref:`OEMMFFComplex <OEFF_OEMMFFComplex>`
  * :ref:`OESmirnoffComplex <OEFF_OESmirnoffComplex>`

* A new preliminary class, ``OEMolMMFF::OEMMFFNonBond``, that combines
  ``OEMolMMFF::OEMMFFVdw`` and ``OEMolMMFF::OEMMFFCoulomb`` has been added.

* A new preliminary class, ``OEMolMMFF::OEMMFFInterNonBond``, that combines
  ``OEMolMMFF::OEMMFFInterVdw`` and ``OEMolMMFF::OEMMFFInterCoulomb`` has been added.

* A new preliminary class, ``OEMolSmirnoff::OESmirnoffNonBond``, that combines
  ``OEMolSmirnoff::OESmirnoffVdw`` and ``OEMolSmirnoff::OESmirnoffCoulomb`` has been added.

* A new preliminary class, ``OEMolSmirnoff::OESmirnoffInterCoulomb``, has been added to use with
  the inter-molecular coulomb component in SMIRNOFF-based force fields.

* A new preliminary class, ``OEMolSmirnoff::OESmirnoffInterNonBond``, that combines
  ``OEMolMMFF::OESmirnoffInterVdw`` and ``OEMolSmirnoff::OESmirnoffInterCoulomb``
  has been added.

* A new preliminary class, :ref:`OENonBondIntcsOptions <OEMolPotential_OENonBondIntcsOptions>`,  has been added that provides
  consistency in setting non-bond interaction calculations in various force fields.

* New constructors for :ref:`OEMMFF <OEMolMMFF_OEMMFF>` and :ref:`OESmirnoff <OEMolSmirnoff_OESmirnoff>`
  have been added that provide consistency and use :ref:`OENonBondIntcsOptions <OEMolPotential_OENonBondIntcsOptions>`
  as arguments.

* Two new SMIRNOFF force fields from the Open Force Field Initiative,
  ``parsley_1.0.0`` and ``parsley_1.1.1``, have been added as built-in
  force fields. They are defined by types PARSLEY_OPENFF100
  and PARSLEY_OPENFF111, respectively.

* A new preliminary class, :ref:`OEForceFieldParameter <OEFF_OEForceFieldParameter>`, has been added as
  part of the extended set of :ref:`OEParameter <OESystem_OEParameter>` classes. The new parameter
  class works with predefined force fields and custom SMIRNOFF force fields, as well as user-defined
  :ref:`OEForceField <OEMolPotential_OEForceField>` force fields using :ref:`OEForceField <OEMolPotential_OEForceField>`
  for the same parameter object.

* Two new public methods have been added to :ref:`OEVdwParams <OEMolPotential_OEVdwParams>`:

  * :oe:meth:`GetAtom1<OEMolPotential::OEVdwParams::GetAtom1>`
  * :oe:meth:`GetAtom2<OEMolPotential::OEVdwParams::GetAtom2>`

* New public methods have been added to :ref:`OEFFParams <OEMolPotential_OEFFParams>`:

  * :oe:meth:`HasVdwParams<OEMolPotential::OEFFParams::HasVdwParams>`
  * :oe:meth:`HasStretchParams<OEMolPotential::OEFFParams::HasStretchParams>`
  * :oe:meth:`HasBendParams<OEMolPotential::OEFFParams::HasBendParams>`
  * :oe:meth:`HasTorsionParams<OEMolPotential::OEFFParams::HasTorsionParams>`
  * :oe:meth:`GetTitle<OEMolPotential::OEFFParams::GetTitle>`

Major bug fixes
--------------------------------------------------------------------------------

* Copy constructors and assignment operators in the classes OESmirnoffStretch,
  OESmirnoffBend, OESmirnoffTorsion, and
  OESmirnoffOutOfPlane had previously failed to copy their private member object of the
  :ref:`OESmirnoffParams <OEMolSmirnoff_OESmirnoffParams>` type. This has been fixed.

   For updated information, see :ref:`Deprecated OEFF Classes <deprecated_OEFF_classes>`.

Minor bug fixes
--------------------------------------------------------------------------------

* The following methods now return ``bool`` instead of a ``void``:

  * :oe:meth:`OEFF::OEMMFFSheffieldOptions::SetDielectric`
  * :oe:meth:`OEFF::OEMMFFSheffieldOptions::SetExponent`
  * :oe:meth:`OEFF::OEMMFFSheffieldOptions::SetForceFieldType`
  * :oe:meth:`OESheff::OESheffieldOptions::SetA`
  * :oe:meth:`OESheff::OESheffieldOptions::SetB`
  * :oe:meth:`OESheff::OESheffieldOptions::SetSoluteDielectricConstant`
  * :oe:meth:`OESheff::OESheffieldOptions::SetSolventDielectricConstant`

* The names of the potential components ``Smirnoff Angle`` and ``Smirnoff Imp Torsion`` were changed to
  ``Smirnoff Bend`` and ``Smirnoff Improper Torsion``, respectively, in order to be compatible
  with the same term
  names in the ``MMFF94`` force field.

* The numerical stability in the calculation of second derivatives in the
  OESmirnoffOutOfPlane class has been improved.




OEFF TK 2.3.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------
* A new generic set of force field potential classes has been added to simplify
  implementing new force fields in OEFF TK:

  * :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`
  * :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>`
  * :ref:`OEBendPotential <OEMolPotential_OEBendPotential>`
  * :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>`
  * :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>`
  * :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`
  * :ref:`OENonBondPotential <OEMolPotential_OENonBondPotential>`
  * :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
  * :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`
  * :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`
  * :ref:`OEInterNonBondPotential <OEMolPotential_OEInterNonBondPotential>`
  * :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
  * :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`

..  _deprecated_OEFF_classes:

.. _oemolsmirnoff_oesmirnoffoutofplane:

.. _oemolsmirnoff_oenonbondbase:

* With the introduction of the new generic force field potential classes in **OEFF TK**,
  several previously existing classes have been deprecated.  The following table
  shows the deprecated classes and their replacements:

  ========================================   =================================================
  Deprecated Class                           New Class
  ----------------------------------------   -------------------------------------------------
  ``OEMolPotential::OEStretchBase``          :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>`
  ``OEMolMMFF::OEMMFFStretch``
  ``OEMolSmirnoff::OESmirnoffStretch``

  ``OEMolMMFF::OEMMFFBend``                  :ref:`OEBendPotential <OEMolPotential_OEBendPotential>`
  ``OEMolSmirnoff::OESmirnoffBend``

  ``OEMolMMFF::OEMMFFTorsion``               :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>`
  ``OEMolSmirnoff::OESmirnoffTorsion``

  ``OEMolSmirnoff::OESmirnoffOutOfPlane``    :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>`

  ``OEMolPotential::OENonBondBase``          :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`

  ``OEMolMMFF::OEMMFFVdw``                   :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
  ``OEMolSmirnoff::OESmirnoffVdw``

  ``OEMolMMFF::OEMMFFCoulomb``               :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`
  ``OEMolSmirnoff::OESmirnoffCoulomb``

  ``OEMolMMFF::OEMMFFInterVdw``              :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
  ``OEMolMMFF::OEMMFFInterVdwNN``
  ``OEMolSmirnoff::OESmirnoffInterVdw``

  ``OEMolMMFF::OEMMFFInterCoulomb``          :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`
  ========================================   =================================================

* New OpenFF parameters ``parsley_1.2.1`` have been added as built-in parameters and can be used
  in the construction of an :ref:`OESmirnoff <OEMolSmirnoff_OESmirnoff>` object.

* Two new classes, :ref:`OEParsleyParams <OEMolSmirnoff_OEParsleyParams>` and :ref:`OEParsley <OEMolSmirnoff_OEParsley>`,
  have been added that work with the latest versions of available OpenFF Parsley force fields.

* New FF14SB ([Maier-2015]_) protein force field parameters have been implemented.  These
  parameters are accessible through the following parameter and force field classes.

  * :ref:`OEFF14SBSmirnoffParams <OEFF_OEFF14SBSmirnoffParams>`: an FF14SB for proteins with custom
    :ref:`OESmirnoffParams <OEMolSmirnoff_OESmirnoffParams>` for cofactor and/or ligand
  * :ref:`OEFF14SBParsleyParams <OEFF_OEFF14SBParsleyParams>`: an FF14SB for proteins with
    :ref:`OEParsleyParams <OEMolSmirnoff_OEParsleyParams>` for cofactor and/or ligand
  * :ref:`OEFF14SBSmirnoff <OEFF_OEFF14SBSmirnoff>`: a force field for proteins with :ref:`OEFF14SBSmirnoffParams <OEFF_OEFF14SBSmirnoffParams>`
  * :ref:`OEFF14SBParsley <OEFF_OEFF14SBParsley>`: a force field for proteins with :ref:`OEFF14SBParsleyParams <OEFF_OEFF14SBParsleyParams>`
  * :ref:`OEFF14SBSmirnoffComplex <OEFF_OEFF14SBSmirnoffComplex>`: a force field for protein-ligand complexes with
    :ref:`OEFF14SBSmirnoffParams <OEFF_OEFF14SBSmirnoffParams>`
  * :ref:`OEFF14SBParsleyComplex <OEFF_OEFF14SBParsleyComplex>`: a force field for protein-ligand complex with
    :ref:`OEFF14SBParsleyParams <OEFF_OEFF14SBParsleyParams>`

* A new class, :ref:`OEMMFFAmberComplex <OEFF_OEMMFFAmberComplex>`, has been added that allows protein-ligand
  optimization with protein flexibility.  Accordingly, ``OEFF::OEMMFFAmber`` has been
  deprecated.

* A new preliminary class, :ref:`OEComplexFFParameter <OEFF_OEComplexFFParameter>`, has been added as
  part of the extended set of :ref:`OEParameter <OESystem_OEParameter>` classes. The new parameter class works with
  predefined complex force fields using an :ref:`OEComplexFF <OEFF_OEComplexFF>`
  object.

* The methods ``OEFF::OEComplexFF::PrepMol`` and ``OEFF::OEComplexFF::PrepHost``
  have been removed from the preliminary API :ref:`OEComplexFF <OEFF_OEComplexFF>` as they are no longer required to
  setup an :ref:`OEComplexFF <OEFF_OEComplexFF>`.

* A new class, :ref:`OEComplexEnergies <OEFF_OEComplexEnergies>`, has been added that represents energy components of a
  protein-ligand complex.

* A new overload of :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` has been added that
  provides the energy components in the form of an :ref:`OEComplexEnergies <OEFF_OEComplexEnergies>`.

Documentation changes
--------------------------------------------------------------------------------

* All the **OEFF TK** examples have been reorganized to reflect the
  modified API behavior.



OEFF TK 2.3.1
================================================================================

*July 2021*

Minor internal improvements have been made.




OEFF TK 2.4.0
================================================================================

*Fall 2021*

New features
--------------------------------------------------------------------------------

* The following new classes have been added to provide support for the 
  OpenFF 2.0.0 Sage force field:
  
  * :ref:`OESageParams <OEMolSmirnoff_OESageParams>`
  * :ref:`OEFF14SBSageParams <OEFF_OEFF14SBSageParams>`
  * :ref:`OESage <OEMolSmirnoff_OESage>`
  * :ref:`OEFF14SBSage <OEFF_OEFF14SBSage>`
  * :ref:`OEFF14SBSageComplex <OEFF_OEFF14SBSageComplex>`

* :ref:`OEForceFieldParameter <OEFF_OEForceFieldParameter>` and :ref:`OEComplexFFParameter <OEFF_OEComplexFFParameter>`
  now accept case-insensitive string input values.

Minor bug fixes
--------------------------------------------------------------------------------

* A potential risk of vectors going out-of-bounds while working with
  :ref:`OESmirnoff <OEMolSmirnoff_OESmirnoff>` and related classes have been addressed.


OEFF TK 2.5.0
================================================================================

New features
--------------------------------------------------------------------------------

* Class :ref:`OESheffield <OESheff_OESheffield>` has been extended with a model which approximates
  solvation of proteins. This extension might be useful for evaluation of differences in
  solvation energies between protein conformations and in protein loop modeling.

* The following methods have been added to the :ref:`OEComplexEnergies <OEFF_OEComplexEnergies>`
  class:

    * :oe:meth:`GetComplexSolvationEnergy<OEFF::OEComplexEnergies::GetComplexSolvationEnergy>`
    * :oe:meth:`GetDesolvationEnergy<OEFF::OEComplexEnergies::GetDesolvationEnergy>`
    * :oe:meth:`GetHostSolvationEnergy<OEFF::OEComplexEnergies::GetHostSolvationEnergy>`
    * :oe:meth:`GetLigandSolvationEnergy<OEFF::OEComplexEnergies::GetLigandSolvationEnergy>`

* A new :oe:constns:`OEFF::OELigandFFType` namespace has been added that defines
  force fields suitable for working with ligands.

* A new :oe:constns:`OESheff::OESheffieldParamType` namespace has been added that defines
  different available Sheffield parameter types.

* Two new methods have been added to :ref:`OESheffieldOptions <OESheff_OESheffieldOptions>`:

  * :oe:meth:`GetC<OESheff::OESheffieldOptions::GetC>`
  * :oe:meth:`SetC<OESheff::OESheffieldOptions::SetC>`

Major bug fixes
--------------------------------------------------------------------------------

* An issue have been fixed where failure to assign atom vdw parameters were ignored
  resulting in calculations being performed with values of zero being assigned as
  the parameters. Effect of this fix could be observed in calculations performed 
  using the following force fields:

  * :ref:`OESmirnoff <OEMolSmirnoff_OESmirnoff>`
  * :ref:`OEParsley <OEMolSmirnoff_OEParsley>`
  * :ref:`OESage <OEMolSmirnoff_OESage>`
  * :ref:`OEFF14SBSmirnoff <OEFF_OEFF14SBSmirnoff>`
  * :ref:`OEFF14SBParsley <OEFF_OEFF14SBParsley>`
  * :ref:`OEFF14SBSage <OEFF_OEFF14SBSage>`

* Semiempirical AM1/PM3 calculations are not allowed for molecules in which atoms indexing is
  not compatible with the number of atoms. Until now passing molecules with that feature could
  caused segmentation fault.





OEFF TK 2.5.1
================================================================================

New features
--------------------------------------------------------------------------------

* Two new constants, :oe:const:`OEMolSmirnoff::OESmirnoffType::PARSLEY_OPENFF` and
  :oe:const:`OEMolSmirnoff::OESmirnoffType::SAGE_OPENFF`, have been added to 
  :oe:constns:`OEMolSmirnoff::OESmirnoffType` that define the latest versions
  of ``Parsley`` and ``Sage`` forcefields respectively.

Major bug fixes
--------------------------------------------------------------------------------
* An issue resulting in a crash when a combine force field ff14SB/OpenFF_Sage or
  ff14SB/OpenFF_Parsley was applied to a small molecule which was not a part
  of the protein-ligand complex has been fixed.

* VdW parameters for atoms which are not explicitly given in the Sage or Parsley
  versions of OpenFF and are not tabulated in ff14SB parameter sets are now taken 
  from the original AMBER parameter set. An example of such systems are proteins with
  metal cofactors. Until now such systems failed to be processed by instances of
  force field classes :oe:cls:`OEFF::OEFF14SBParsley` or :oe:cls:`OEFF::OEFF14SBSage`. 

Minor bug fixes
--------------------------------------------------------------------------------

* A missing improper torsion parameter in ff14SB force field for residue PTR, which is 
  defined by three carbon atoms from a benzene ring and oxygen from a phosphate group, has been added.




.. _section_oeff_releasenotes_2521:

OEFF TK 2.5.2.1
================================================================================

* Support for the latest released version of the force field from the
  Open Force Field Initiative (Sage 2.1.0) has been added. The constant 
  :oe:const:`OEMolSmirnoff::OESmirnoffType::SAGE_OPENFF` now refers to
  this latest version of Sage force field.

.. _section_oeff_releasenotes_2520:

OEFF TK 2.5.2.0
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

* The :ref:`OEComplexFF <OEFF_OEComplexFF>` class is now derived from
  :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>` and has limited support
  for second derivatives when the protein is fixed.





OEFF TK 2.7.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new method, :ref:`HasInternalCharges <OEMolPotential_OEForceField_HasInternalCharges>`, has been
  added to :ref:`OEForceField <OEMolPotential_OEForceField>` that returns a boolean indicating whether the
  parameters in the :ref:`OEForceField <OEMolPotential_OEForceField>` contain
  charges.

* A new method, :ref:`HasCoulomb <OEMolPotential_OEForceField_HasCoulomb>`, has been
  added to :ref:`OEForceField <OEMolPotential_OEForceField>` that returns a boolean indicating whether coulombic
  interactions are turned on.

* A new method, :ref:`GetNonBondOptions <OEMolPotential_OENonBondPotBase_GetNonBondOptions>`, has been
  added to :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>` that provides access
  to its internal :ref:`OENonBondIntcsOptions <OEMolPotential_OENonBondIntcsOptions>`. 

* A new method, :ref:`SetNonBondCutoff <OEFF_OEComplexFF_SetNonBondCutoff>`, has been
  added to :ref:`OEComplexFF <OEFF_OEComplexFF>` that provides a way to set nonbonded
  interactions cutoffs.

Major bug fixes
--------------------------------------------------------------------------------

* The internal algorithms for VdW parameter assignment with
  :ref:`OESmirnoffParams <OEMolSmirnoff_OESmirnoffParams>` have been modified
  to improve performance in working with large molecules.

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:meth:`GetTitle<OEMolPotential::OEForceField::GetTitle>`
  method for :ref:`OESmirnoff <OEMolSmirnoff_OESmirnoff>` now properly returns
  the user set title of the force field.




.. _section_oefftk_releasenotes_2713:

OEFF TK 2.7.1.3
================================================================================

* The constant :oe:const:`OEMolSmirnoff::OESmirnoffType::SAGE_OPENFF` now refers to the
  2.2.0 version of the Sage-OpenFF force field.

.. _section_oefftk_releasenotes_2710:

OEFF TK 2.7.1
================================================================================

New features
--------------------------------------------------------------------------------

* The following preliminary API classes have been made permanent.

  * :ref:`OENonBondIntcsOptions<OEMolPotential_OENonBondIntcsOptions>`
  * :ref:`OEComplexFF<OEFF_OEComplexFF>`
  * :ref:`OEComplexFFParameter<OEFF_OEComplexFFParameter>`
  * :ref:`OEFF14SBParsley<OEFF_OEFF14SBParsley>`
  * :ref:`OEFF14SBParsleyComplex<OEFF_OEFF14SBParsleyComplex>`
  * :ref:`OEFF14SBSage<OEFF_OEFF14SBSage>`
  * :ref:`OEFF14SBSageComplex<OEFF_OEFF14SBSageComplex>`
  * :ref:`OEFF14SBSmirnoff<OEFF_OEFF14SBSmirnoff>`
  * :ref:`OEFF14SBSmirnoffComplex<OEFF_OEFF14SBSmirnoffComplex>`
  * :ref:`OEForceFieldParameter<OEFF_OEForceFieldParameter>`
  * :ref:`OEMMFFAmberComplex<OEFF_OEMMFFAmberComplex>`
  * :ref:`OEMMFFComplex<OEFF_OEMMFFComplex>`
  * :ref:`OESmirnoffComplex<OEFF_OESmirnoffComplex>`

Minor bug fixes
--------------------------------------------------------------------------------

* The :oe:meth:`Get<OEMolPotential::OEInteractParams::GetList>` and
  :oe:meth:`Set<OEMolPotential::OEInteractParams::SetList>` methods in 
  :ref:`OEInteractParams<OEMolPotential_OEInteractParams>` are now
  exposed properly in Python.





OEFF TK 2.8.0
================================================================================

New features
--------------------------------------------------------------------------------

* The constant :oe:const:`OEMolSmirnoff::OESmirnoffType::SAGE_OPENFF` now refers to the
  2.2.1 version of the Sage OpenFF force field.

* Any SMIRNOFF set of parameters loaded using :ref:`OESmirnoffParams<OEMolSmirnoff_OESmirnoffParams>`,
  including the built-in :ref:`OESageParams<OEMolSmirnoff_OESageParams>` and
  :ref:`OEParsleyParams<OEMolSmirnoff_OEParsleyParams>`, are now supplemented with
  van der Waals parameters for many metals and counterions, as used with the
  ``OpenMM`` package.

* The :ref:`OEMMFF94sParams <OEMolMMFF_OEMMFF94sParams>` and :ref:`OEMMFFParams <OEMolMMFF_OEMMFFParams>`
  are now supplemented with a generic set of van der Waals parameters for many metals
  and counterions to improve robustness.

* A new function, :ref:`OEIsValidMMFFMolecule <OEMolMMFF_OEIsValidMMFFMolecule>`, has been
  added that can be used to check if :ref:`OEMMFFParams <OEMolMMFF_OEMMFFParams>` 
  are available for a molecule.

Minor Bug Fixes
--------------------------------------------------------------------------------

* Loading a SMIRNOFF set of parameters using :ref:`OESmirnoffParams<OEMolSmirnoff_OESmirnoffParams>`
  no longer picks up the library charges.



OEFF TK 2.9.0
================================================================================

New Features
--------------------------------------------------------------------------------

* The new method :ref:`GetLigandFF<OEFF_OEComplexFF_GetLigandFF>` has been added to
  :ref:`OEComplexFF<OEFF_OEComplexFF>` that enables access to the underlying ligand force field.

* The following new classes have been introduced to enable accessing data associated
  with any :ref:`OESmirnoffParams <OEMolSmirnoff_OESmirnoffParams>` parameters:

  * :ref:`OESmirnoffData <OEMolSmirnoff_OESmirnoffData>`
  * :ref:`OESmirnoffStretchData <OEMolSmirnoff_OESmirnoffStretchData>`
  * :ref:`OESmirnoffBendData <OEMolSmirnoff_OESmirnoffBendData>`
  * :ref:`OESmirnoffTorsionData <OEMolSmirnoff_OESmirnoffTorsionData>`
  * :ref:`OESmirnoffImproperData <OEMolSmirnoff_OESmirnoffImproperData>`
  * :ref:`OESmirnoffVdWData <OEMolSmirnoff_OESmirnoffVdWData>`

* The following new methods have been added to :ref:`OESmirnoffParams <OEMolSmirnoff_OESmirnoffParams>`
  to enable accessing data associated with various parameters:

  * :ref:`AddBendData <OEMolSmirnoff_OESmirnoffParams_AddBendData>`
  * :ref:`AddImproperData <OEMolSmirnoff_OESmirnoffParams_AddImproperData>`
  * :ref:`AddStretchData <OEMolSmirnoff_OESmirnoffParams_AddStretchData>`
  * :ref:`AddTorsionData <OEMolSmirnoff_OESmirnoffParams_AddTorsionData>`
  * :ref:`AddVdWData <OEMolSmirnoff_OESmirnoffParams_AddVdWData>`
  * :ref:`GetBendData <OEMolSmirnoff_OESmirnoffParams_GetBendData>`
  * :ref:`GetImproperData <OEMolSmirnoff_OESmirnoffParams_GetImproperData>`
  * :ref:`GetStretchData <OEMolSmirnoff_OESmirnoffParams_GetStretchData>`
  * :ref:`GetTorsionData <OEMolSmirnoff_OESmirnoffParams_GetTorsionData>`
  * :ref:`GetVdWData <OEMolSmirnoff_OESmirnoffParams_GetVdWData>`
  * :ref:`SetBendData <OEMolSmirnoff_OESmirnoffParams_SetBendData>`
  * :ref:`SetImproperData <OEMolSmirnoff_OESmirnoffParams_SetImproperData>`
  * :ref:`SetStretchData <OEMolSmirnoff_OESmirnoffParams_SetStretchData>`
  * :ref:`SetTorsionData <OEMolSmirnoff_OESmirnoffParams_SetTorsionData>`
  * :ref:`SetVdWData <OEMolSmirnoff_OESmirnoffParams_SetVdWData>`

* The function :ref:`OEIsValidMMFFMolecule<OEMolMMFF_OEIsValidMMFFMolecule>` has a new
  overload that allows it to ignore charges while checking if MMFF parameters are available
  for the specified molecule. 

Minor Bug Fixes
--------------------------------------------------------------------------------

* An issue that was causing an occasional segmentation fault in the
  :ref:`SetHostFlex<OEFF_OEComplexFF_SetHostFlex>` method in the
  :ref:`OEFF14SBSageComplex<OEFF_OEFF14SBSageComplex>` class has been fixed.

* The method :ref:`SetupConf <OEMolPotential_OEMolFunc_SetupConf>` in
  :ref:`OEMolFunc <OEMolPotential_OEMolFunc>` is now properly wrapped
  in Python.





OEFF TK 2.9.1
================================================================================

Minor internal improvements have been made.



OEFF TK 2.9.2
================================================================================

Minor Bug Fixes
--------------------------------------------------------------------------------

* The :ref:`OEQuatAdaptor<OEMolPotential_OEQuatAdaptor>` now passes the coordinates
  to the internal :ref:`OEMolFunc<OEMolPotential_OEMolFunc>` when appropriate.


.. omegatk toolkit documentation master file for no-gpu systems like C#

#############################
Omega Toolkit |omega_version|
#############################

.. toctree::
   :maxdepth: 3

   omegatheory
   omegaexamples
   api
   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt




###############################################
Appendix: Additional Examples in Python
###############################################

These are full listings of programming examples that are excerpted or offered for download elsewhere in this chapter.

For an overall guide to programming examples, see :ref:`the earlier material in the Omega chapter <chapter_omega_examples>`.

.. 	_listing-AddTorsionRule.py:

..  oe:source:: AddTorsionRule.py
    :language: python
    :caption:  Example of adding a new torsion rule.
    :refnum:   1

.. 	_listing-GPUOmega.py:

.. oe:source:: GPUOmega.py
   :language: python
   :refnum:   2
   :caption:  Example of turning off GPU-Omega and changing parameters.


.. _section_lib_dependencies:

****************************
Library Dependencies
****************************

Compiling a C++ program that includes OpenEye libraries require
that all the library API's that have been called in the code are
added as dependency in the `CMake` project file. Besides the
explicit set of libraries that are in use, libraries that the
explicit set depends on must also be added as dependency for the
compiling code.  In `Linux`, the list of all dependent libraries
also need to be in proper order of their dependencies.

A dependency diagram of all of the OpenEye C++ libraries are
provided below to help sort out dependencies for any derived
code.

.. figure:: quickstart-cplusplus/images/dependency-libs.*
   :align:  center
   :width:  400pt

   **Dependency between OpenEye libraries**

The `purple` boxes indicate libraries with direct API exposure,
the `blue` boxes indicate libraries with CUDA support and direct 
API exposure, and the `yellow` boxes indicate libraries that
have no direct API exposure.


:orphan:

.. needs to be tested before published 10/25/23

How to Develop with the OpenEye C++ Toolkit in Eclipse
========================================================

Eclipse is an integrated development environment (IDE) available from eclipse.org. It
is one of several IDEs available for C++ development and is used in this guide
because it is free and available on multiple platforms.

The essential step in using Eclipse and other IDEs for OpenEye toolkit development is
to specify the OpenEye toolkit as a resource to use during development.

Download Eclipse for C/C++ Developers from `eclipse.org <https://www.eclipse.org/downloads/packages/release/2023-03/r/eclipse-ide-cc-developers>`_.
URls may change from time to time, so just be sure you download the installer for C/C++
for your operating system.  There are versions for Windows, macOS, and Linux.

After you have installed Eclipse, proceed to create a new project.

Creating a New Project
----------------------

To create a new project, we choose from the File menu, 
File->New->C/C++ Project. This will bring up a dialog like
:ref:`New Eclipse Project 1<figure_eclipse_new_project1>`.
Type in a name for this project, like "OESample1", and then 
press the "Next" button.

.. _figure_eclipse_new_project1:

.. figure:: /_images/Eclipse-new-project1.PNG
   :align:  center
   
   **New Eclipse Project 1**

Next, we need to add the OpenEye JAR to our project. Click the "Libraries"
tab at the top of the dialog, then choose "Add External JARs...". Browse 
to the location where you expanded the distribution you downloaded above
and pick the appropriate "oejava-\*-jar" for your platform. See 
:ref:`New Eclipse Project 2<figure_eclipse_new_project2>`.

.. _figure_eclipse_new_project2:

.. figure:: /_images/Eclipse-new-project2.PNG
   :align:  center
   
   **New Eclipse Project 2**

You should then see something like:
:ref:`New Eclipse Project 3<figure_eclipse_new_project3>`.
Click the "Finish" button.

.. _figure_eclipse_new_project3:

.. figure:: /_images/Eclipse-new-project3.PNG
   :align:  center
   
   **New Eclipse Project 3**

Adding a Class to Our Project
-----------------------------

Next we need to add a Java class to hold our sample code. Click
File->New->Class to bring up the "New Class" dialog as in 
:ref:`Eclipse New Class<figure_eclipse_new_class>`.

.. _figure_eclipse_new_class:

.. figure:: /_images/Eclipse-New-Class.PNG
   :align:  center
   
   **Eclipse New Class**

There are several things we want to do on this dialog.

   * Choose a package name for this class. For example, "myoechemexamples".
   * Choose a name for the class: "OESample1".
   * Remove the default "Superclass" entry, since it is not required.
   * Check the box to add a "main" to our class. And uncheck the box
     for "Inherits abstract methods".
   * Then click the "Finish" button.

This will take you back to Eclipse and open the new class in the editor,
ready to add code.

Near the top of the file, add the import for oechem.

.. code-block:: java
   
   import openeye.oechem.*;

Then add our sample code inside the main method.

.. code-block:: java

   public static void main(String[] args) {
       OEGraphMol mol = new OEGraphMol();
       oechem.OEParseSmiles(mol, "c1ccccc1CCCBr");
       System.out.format("mol has %d atoms\n", mol.NumAtoms()); 
   }

When you are finished, your sample should look something like
:ref:`Editing in Eclipse<figure_eclipse_editing>`.

.. _figure_eclipse_editing:

.. figure:: /_images/Eclipse-Editing.PNG
   :align:  center
   
   **Editing in Eclipse**

Running Our Example inside Eclipse
----------------------------------

We can now test run our program in Eclipse. In the toolbar,
click the "Run" button as shown in 
:ref:`Running in Eclipse<figure_eclipse_run>`.

.. _figure_eclipse_run:

.. figure:: /_images/Eclipse-Run.PNG
   :align:  center
   
   **Running our example in Eclipse**

This should produce some output in the "Console" window like
:ref:`Console output<figure_eclipse_console_output>`.

.. _figure_eclipse_console_output:

.. figure:: /_images/Eclipse-Console-Output.PNG
   :align:  center
   
   **Console output from our example.**   

And now you've created your first OEChem Java sample. You can now
add code and continue to run inside Eclipse to try out more of the
OEChem API.

Creating an Executable JAR
--------------------------

At some point, you may want to run your example outside of Eclipse,
or you may want to deploy the application to another machine. An easy
tool for this purpose is an export option built into modern versions
of Eclipse.

To create a standalone JAR executable, right-click on the project
and select ``Export...``.

.. figure:: /_images/Eclipse-export-JAR.png
   :align:  center
   
   **Exporting a Runnable JAR**

Then in the next dialog:

   * Pick a name for your and destination for the new JAR
   * Make your choice about how libraries should be packaged.
   * Click "Finish".

.. _figure_eclipse_build_fatjar2:

.. figure:: /_images/Eclipse-export-JAR-options.png
   :align:  center
   
   **Set Options for the New JAR**

You should now be able to open a terminal in the location where you 
saved the JAR file and run it from the command-line.

.. code-block:: bash

   $> java -jar ./OESample1.jar
   mol has 10 atoms



########################
Legal Notices
########################

..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt




:orphan:

.. _section_cpp_getting_started:

********************************
Getting Started with OpenEye C++
********************************

.. toctree::
   :maxdepth: 2

   license
   install
   tkimport
   dependencies
   include-from-theme-in-tk



.. _cplusplus_prerequisites:

Prerequisites
=============

.. index:: CMake, tar, WinZip, compiler, make

1. For building on any platform, CMake 3.21 and above is required to follow the build instructions
   included in this document. 
   This tool provides the simplest method of building code that utilizes OpenEye C++ toolkits.
   CMake downloads can be found at `CMake <https://cmake.org/download/>`_

2. A platform dependent compression utility (e.g. WinZip for Windows or
   ``tar`` for Linux/macOS).

3. Linux requires the zlib and libcairo libraries be available.
   To ensure they are installed on Ubuntu run::

        sudo apt update -y
        sudo apt install -y zlib1g zlib1g-dev
        sudo apt install -y libcairo2 libcairo2-dev

  or on CentOS or RHEL::

     sudo yum update -y
     sudo yum install zlib-devel
     sudo yum install cairo-devel

4. The make program must be installed on the system.  Type::

    make --version

    If make is installed a version number is printed.  If not, you can install it with a command such as
    the RHEL command::

    sudo yum install make

5. The minimum recommended GNU `binutils <https://www.gnu.org/software/binutils/>`_
   version is 2.26 for the C++ single build Linux packages.

6. A compatible compiler must be installed to build any code that uses the
   libraries.  The following are lists of supported compilers and their minimum
   versions, on Windows, Linux, and macOS operating systems.

Windows
-------

The following platforms are supported with a single package:

* Visual Studio 2022 (x64)
  
.. note::

  * Examples should be built in a Visual Studio command window.

  * cmake.exe version 3.21 or higher should be in the system or user's PATH.

  * Visual Studio needs to be installed with the C++ compiler enabled, which is not the default. Select the ``Desktop development with C++`` option as depicted below when installing or re-installing Visual Studio.

Linux
-----

The following platforms and their default gcc versions are supported 

* RHEL8

  * gcc/g++ 8.2 (x64)

* RHEL9

  * gcc/g++ 11.3 (x64)

* Ubuntu 22.04 
    
  * gcc/g++ 11.4 

* Ubuntu 24.04 (x64)
    
  * gcc/g++ 13.3

macOS
------

The following platforms are supported with a single universal package:

* macOS 13-15

.. _cplusplus_gpu_prerequisites:

GPU Prerequisites
=================


GPU-Related Requirements
========================

The following features are required in order to use GPU-accelerated OpenEye toolkits and applications.


Supported Platforms
-------------------

CUDA-enabled OpenEye software is only available on supported Linux platforms.
For supported Linux platforms see the `Platform Support Page <https://www.eyesopen.com/supported-platforms>`_.


Supported GPUs
-------------------

An NVIDIA `Tesla <http://www.nvidia.com/object/tesla-supercomputing-solutions.html>`_,
`Quadro <http://www.nvidia.com/object/workstation-solutions.html>`_, or
`GeForce <http://www.nvidia.com/object/geforce_family.html>`_ GPU with a **compute capability of 3.5
or higher** is required on your system. For a comprehensive table of compute capability
categories for each GPU, please refer to the `CUDA <https://en.wikipedia.org/wiki/CUDA>`_ Wikipedia page.


NVIDIA Drivers
-------------------

* **Minimum NVIDIA Driver version: 450.x**.

* CUDA is **not** required to be installed.

We recommend driver `450.80.02 <https://www.nvidia.com/Download/driverResults.aspx/165294/en-us>`_, and
we strongly advise manually downloading and installing the appropriate NVIDIA driver
for your system as opposed to using a package manager.

To install, root privilege is required. Follow these steps:

  #. Download the driver to the machine you are installing it on.
  #. ``chmod +x`` the driver package to make it executable.
  #. Ensure you have disabled X-server by killing any running sessions.
     Reboot may be required if X-server is still running after this step.
     
     .. warning::

        Disabling X-server requires different processes to be killed depending on your Linux
        distribution.
        See the `NVIDIA installation guide
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_ for more details.

     .. warning::

        The NVIDIA kernel module can often conflict with the open source
        Nouveau display drivers, depending on your specific Linux
        distribution. The NVIDIA documentation is a much more complete
        and up-to-date source for information on how to work around this issue.
        See `Disabling Nouveau
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile-nouveau>`_ on the NVIDIA website.

  #. Install the driver by ``sudo ./NVIDIA-Linux-x86_64-450.80.02.run`` and follow the step-by-step installation instructions.

  For more details on driver installations, see the `CUDA Installation Guide
  <https://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_

.. note::

  The output of the ``nvidia-smi`` command is extremely useful when
  debugging GPU issues. Please include the output from
  ``nvidia-smi`` in any request to support@eyesopen.com.


Performance Tuning
-------------------

To get the most performance out of an NVIDIA graphics card, use the persistence daemon to switch persistence mode
across all cards on the system (root privilege required)::

  sudo nvidia-persistenced --user foo

This will automatically enable persistence mode after reboot.

For full instructions on the persistence daemon, see the `Persistence daemon section
<https://docs.nvidia.com/deploy/driver-persistence/index.html#persistence-daemon>`_ of the NVIDIA docs.

Download the OpenEye C++ distribution
=====================================

.. index:: downloading, CMake

Download a toolkit distribution for your target platform from
`OpenEye Applications & Toolkits Downloads <http://www.eyesopen.com/downloads>`_ and follow the directions on the form.

Installation
============

.. index:: installation, tar, WinZip, toolkit directory structure

To install the toolkits, you simply need to expand the downloaded distribution
file into the directory where you want the toolkits to reside on your machine.

For example, on a Linux or macOS command line, you can use the
following command:

``> tar -xzf <distribution name>.tar.gz``

On a Windows machine, you can double-click on the distribution file,
which will have a ``.zip`` extension, and extract the compressed contents
with the WinZip utility.

Extraction of the distribution file will create a directory called ``openeye``
with the following structure::

  openeye/
     toolkits/
        <VERSION>/
        examples/
        include/
        lib/

.. Note::

    Your installation will have a sub-directory named as a version
    number in the form, ``Year.Major#.Minor#``.

How to Build the Toolkit Examples
====================================

.. index:: toolkit examples

Several example code files are distributed with the toolkits to demonstrate how
the toolkits can be used. This section  guides you in building  the C++ example code distributed with
the OpenEye toolkits.

These files are meant to be buildable, runnable programs that can be compiled
on your target machine.

Building the Examples (Linux / macOS)
--------------------------------------

.. index:: configure, CMake, make, Makefile

Follow these steps to compile the examples on Linux/macOS:

.. code-block:: bash

   cd openeye/toolkits/examples
   ./configure
   make

.. Note::

    The ``configure`` script invokes the ``cmake`` tool to build a ``Makefile``
    for ``make``.

Once built, the example executables will be placed in the
``openeye/toolkits/examples/bin`` or ``openeye/toolkits/examples/bin/docs``
directories.

Building the Examples (Windows)
-------------------------------

.. index:: configure.bat, Visual Studio, OpenEye-Toolkits.sln

Follow these steps to compile the examples from a Visual Studio Developer Command Prompt:

    1. From the ``examples`` directory where you installed the toolkits,
    execute ``configure-VS<ver>x.bat``.

    2. Execute ``MSBuild OpenEye-Toolkits.sln  /p:Configuration=Release``.

    3. The compiled examples can then be found in ``examples/bin/docs/Release/``.

Alternatively, the following steps can be used to build without a command prompt:

    1. In a File Explorer window, navigate to the ``examples`` directory
    in the folder where you installed the toolkits.

    2. Double-click on the file ``configure.bat``.
    A Visual Studio solution file named ``OpenEye-Toolkits.sln`` will be created
    in the ``examples`` folder.

    3. Double-click on the file ``OpenEye-Toolkits.sln`` to open the generated
    solution with Visual Studio.

    5. In Visual Studio, select ``Release`` for the build type and select
    ``Build Solution`` from the ``Build`` drop down  menu.

Once built, the example executables can be found in  ``examples\bin\docs\Release``.

Running the Examples
--------------------

.. index:: running toolkit examples

To run an executable, go to the ``openeye/toolkits/examples/bin`` or
``openeye/toolkits/examples/bin/docs`` directory in a command line shell
and invoke the program with appropriate arguments.
All examples offer command line help to learn more about their command line
options.  For some of the examples, invoking the executable with the ``--help``
option will display this help documentation.
For others, invoking the executable with no arguments displays the help
documentation.

.. Note::

    Many of these programs require one or more input data files.
    These files are not distributed with the toolkit examples.

Building Toolkit Projects
=========================

.. index:: building toolkit projects

This chapter will guide you in building C++ code that makes use of the
OpenEye toolkits.

Building with CMake (Linux / macOS)
------------------------------------

.. index:: Linux, macOS, CMake, gcc, g++, configure

Using *CMake* as described in this section is the recommended method of building
a project with the OpenEye toolkits.  With *CMake*, a project can be quickly
tailored to match the compilation environment used to build the toolkit code.
In addition, *CMake* can be used to easily generate project files for the build
environment meant for your system (i.e., the system that the toolkit distribution
was built for).

#. Create a new directory for your project and copy or move your project files
   into the new directory.

#. Create a text file named ``CMakeLists.txt`` in your project's directory,
   copy the below text into that file, and modify the following example
   parameter values:

  * Change the value of ``OE_DIR`` to match the directory where the
    toolkits are installed on your machine. The below example assumes
    you've unpacked the distribution into the root of your source
    tree by using the ``${PROJECT_SOURCE_DIR}`` CMake variable.

  * Change the value of ``OE_LIBS`` to include the names of all OpenEye
    toolkit libraries that your project depends on (``oechem`` will always be
    included).  For other examples, see the example projects in
    ``openeye/toolkits/examples``.

  * Change ``SRCS`` to match the name of your application (the first argument)

.. code-block:: cmake

   cmake_minimum_required(VERSION 3.31)

   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++17")

   # specify where the OpenEye C++ distribution can be found
   set (OE_DIR "${PROJECT_SOURCE_DIR}/openeye/toolkits")

   # specify which OpenEye libraries to link against
   set (OE_LIBS
       oechem
       oemath
       oesystem
       oeplatform
   )

   # specify where CMake can find the OpenEye libraries
   include_directories ( ${OE_DIR}/include )
   link_directories ( ${OE_DIR}/lib )

   # tell CMake to build the text2hex utility for creating .itf files from .txt files
   set (CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin/)
   add_executable(text2hex ${OE_DIR}/examples/text2hex.cpp)

   # link all required OpenEye system libraries
   set (LIBS "${OMPLIBS};${OE_LIBS};${SYSRASTERLIBS};${SYSLIBS};${SYSZLIB}")

   # applications to build and their sources
   set (SRCS
       "my_app my_app.cpp my_app.itf"
   )

   # enables OpenMP compiler flags
   add_definitions("${OMPCFLAGS}")

   # include the OpenEye boilerplate CMake code
   include (${OE_DIR}/examples/ExamplesTemplate.cmake)

.. note::

   The ``text2hex`` CMake code is only required when a ``.itf`` file
   is specified as a source file to build from, otherwise it can be
   omitted. ``.itf`` files are an OpenEye specific file extension to
   specify that a ``.txt`` file of command line interface options
   should be automatically compiled into a ``.itf`` file. For more
   information on interface files, see the chapter on
   :ref:`chapter_oechem_interface` in the **OEChem TK** theory
   documentation.

3. From your project directory, run the ``openeye/toolkits/examples/configure`` script.

.. Note::

    If you are running on Linux, and your C and C++ compilers are not the
    defaults (i.e. ``/usr/bin/gcc`` and ``/usr/bin/g++``, respectively),
    then you will need to temporarily modify the ``CMAKE_C_COMPILER``
    and ``CMAKE_CXX_COMPILER`` options in the ``configure`` script.

.. Note::

    This warning can be safely ignored if you are not using the OEDepict
    toolkit:
    ``Manually-specified variables were not used by the project: SYSRASTERLIBS``

4. Run ``make`` within your project directory.

.. Note::

    This or a similar linker warning can be safely ignored:
    ``ld: warning: directory not found for option '-L<project path>/../lib'``

.. Note::

    To display all possible ``make`` targets, run ``make help`` in your
    project's directory.

.. _section_cpp_single_build:

Single-Build Distributions (Linux)
----------------------------------

The ``single-build`` Linux distribution contains libraries built to be
maximally-compatible with Linux-based systems.  It is built specifically to
take advantage of the Linux cross-version compatibility guarantees in such
a way that executables built using the ``single-build`` distribution will run
across many common Linux platforms without rebuilding.

This distribution is built on the *oldest* version of Linux we support.
This means that the libraries will only depend on older Linux system
functions (e.g. glibc).  Since Linux guarantees forwards compatibility, this
means that the distribution will work across most modern Linux distributions.

The distribution is built using a later g++ compiler toolchain.
This allows us to take advantage of optimizations and language features
only available in later g++ compiler versions (we're not tied to the
old g++ from the older Linux OS).  This does create a new dependency on
later versions of C++ runtime libraries (libstdc++.so, libgcc_s.so,
libgomp.so).  These three files are shipped with the ``single-build``
distribution and they, or later versions of them, must be available when
running programs built with the distribution.  This new dependency can
be satisfied in one of three ways:

  * The three files can be copied with the executables, and using a
    link-time option (-rpath) can be found by the executables at runtime

  * The three files can be put in a common location, and runtime environment
    variables such as LD_LIBRARY_PATH can be used to find the files

  * If the system already has a newer g++ installed on the system, the
    files in that toolchain will satisfy the dependency by default

The configure script and cmake files in the ``examples`` directory uses
the first strategy since it doesn't depend on any additional system
configuration.  The required operations are as follows:

  * Include the -rpath='\$ORIGIN' option in the link (ld) step when
    building executables.  This tells the linker that the executable should
    look in its own directory for any runtime libraries before looking in
    system locations.

  * Copy the three runtime files into the executable directory with the
    built executables.  At execution time the needed libraries will be found
    before any other system libraries.

Finally, be aware that if the executables are moved to other machines, the
three C++ system libraries should be copied with them.  Best practice is
to archive the entire ``bin`` directory and move it to the target platform(s).

The most common error seen when using programs built with the ``single-build``
distribution is a runtime error containing either ``GLIBCXX`` or ``CXXABI``,
as in the following examples::

   cansmi: /usr/lib/x86_64-linux-gnu/libstdc++.so.6: version 'GLIBCXX_3.4.21'
   not found (required by cansmi)

This message indicates that the program is using an older libstdc++.so file
rather than the one shipped with the ``single-build`` distribution.  It
could be that the libstdc++.so file is not in the directory with the
executable or that -rpath was not properly set.  Use the 'ldd' and 'readelf'
commands to isolate the problem.

Building with CMake (Windows)
-----------------------------

.. index:: building toolkit projects, configure.bat, Windows, Visual Studio, Project.sln

Using *CMake* as described in this section is the recommended method of building
a project with the OpenEye toolkits.  With *CMake*, a project can be quickly
tailored to match the compilation environment used to build the toolkit code.
In addition, *CMake* can be used to easily generate project files for the build
environment meant for your system (i.e. the system that the toolkit distribution
was built for).

#. Create a new directory for your project and copy or move your project files
   into the new directory.

#. Create a text file named ``CMakeLists.txt`` in your project's directory,
   copy the below text into that file, and modify the following example parameter
   values:

  * Change the value of ``OE_DIR`` to match the directory where the toolkits
    are installed on your machine.

  * Change the value of ``OE_LIBS`` to include the names of all OpenEye
    toolkit libraries that your project depends on (``oechem`` will always be
    included).  For other examples, see the example projects in
    ``openeye\toolkits\examples``.

  * Change ``SRCS`` to match the name of your application (the first argument)
    and include all the source files to be compiled.

.. code-block:: cmake

    cmake_minimum_required(VERSION 3.31)

    set (OE_DIR "C:/Users/<USERNAME>/Documents/openeye/toolkits")

    set (OE_LIBS
        oechem
    )

    include_directories ( ${OE_DIR}/include )
    link_directories ( ${OE_DIR}/lib )

    set (LIBS "${OE_LIBS};${SYSLIBS};${SYSZLIB}")

    set (SRCS
        "my_app main.cpp"
    )

    include (${OE_DIR}/examples/ExamplesTemplate.cmake)

3. From your project directory, run the ``configure.bat`` script that resides in the
``openeye\toolkits\examples`` directory.

.. Note::

    This warning can be safely ignored if you are not using the OEDepict toolkit:
    ``Manually-specified variables were not used by the project: SYSRASTERLIBS``

4. Open the generated project file ``Project.sln``
with the version of Visual Studio the toolkit distribution was created for,
and build the project within the Visual Studio application.

Building Directly with Other Build Tools
----------------------------------------

.. index:: building toolkit projects

If you are building your project directly with a build tool by hand
(i.e not relying on build files generated by a
``configure`` or ``configure.bat`` script),
you need to inform the tool about the locations of the ``include`` and ``lib``
folders of the toolkits distribution (i.e. ``openeye/toolkits/include`` and
``openeye/toolkits/libs``, respectively).
The compiler and compiler options for your C++ project should also match the
ones used to build the toolkit example programs.
Please reference ``openeye/toolkits/examples/configure`` for the compiler
used to build the toolkits, as well as the compiler options.


******************************
License for OpenEye Toolkits
******************************

.. |product_type| replace:: toolkit

A license file from OpenEye, Cadence Molecular Sciences is required to run any OpenEye
|product_type|. A license file can be requested/obtained by contacting OpenEye
(https://www.eyesopen.com/contact).

At startup, the |product_type| looks for a valid license in the following default
locations:

* In a file specified by the environment variable :envvar:`OE_LICENSE`.  Example commands to set
  the environment variable:

  * Linux/UNIX and MacOS:

    ``export OE_LICENSE=/home/USERNAME/oe_license.txt``

    This can be executed in a shell prompt, or added to the user's ``~/.bash_profile``.
    If running `zsh`,  add to the user's ``.bash_profile`` and then include ``.bash_profile``
    in the user's ``.zshrc``.

  * Microsoft Windows:

    ``setx OE_LICENSE C:\Users\USERNAME\oe_license.txt`` to set the environment variable permanently using Command Prompt, or
    ``SET OE_LICENSE=C:\Users\USERNAME\oe_license.txt`` to set for the duration of the session using Command Prompt.
    ``$env:OE_LICENSE="C:\Users\USERNAME\oe_license.txt"`` to set the environment variable using PowerShell.

* In a file named ``oe_license.txt`` in the directory specified by the
  environment variable :envvar:`OE_DIR`.

* In a file named ``oe_license.txt`` in the user's platform-specific local
  OpenEye application data directory. The location of this directory is
  detailed below:

  * Linux/UNIX:

    ``~USERNAME/.OpenEye``

  * MacOS:

    ``/Users/USERNAME/Library/OpenEye`` or ``~USERNAME``

  * Microsoft Windows:

    ``C:\Users\USERNAME\AppData\Local\OpenEye``

* In a file named ``oe_license.txt`` in the current working directory






.. _section_cpp_tk_import:

****************************
How to import the toolkits
****************************

To include OpenEye libraries in a C++ program the appropriate
header files must be included at compile time. All OpenEye
libraries require that the ``openeye.h`` header file is included
first. Then additional OpenEye libraries can be included, for
example, the *OEChem TK* library:

.. code-block:: c++

   include <openeye.h>
   include <oechem.h>

Every **OpenEye library** resides in its own C++ namespace. It is often
useful to use the following idiom to produce shorter, more readable
code:

.. code-block:: c++

   using namespace OEChem;

Since **OEChem TK**'s objects and functions have unique names, there is
little chance to have a name clash with this particular idiom.


########################
Legal Notices
########################

..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt




:orphan:

.. _section_csharp_getting_started:

*******************************
Getting Started with OpenEye C#
*******************************

.. toctree::
   :maxdepth: 2

   license
   install
   vs2022
   tkimport
   include-from-theme-in-tk



.. _installation:

*************
Installation
*************

.. _introduction:

Introduction
============

The C#/.Net version of the OpenEye Toolkits is a P/Invoke
wrapper created using SWIG. It is important to note that this is not a new
version of the toolkits written in C# nor is it a C# interpretation of the
toolkit API, but a rather faithful reproduction of the toolkit API in C#.
And while this manual is specific to C#, the version of the toolkits works
with all .Net languages include Visual Basic .Net, F# and IronPython.

A few of the idiomatic differences include:

* There are relatively few classes in OEChem and they have a rather
  shallow inheritance hierarchy.

* Most OEChem algorithms are in C++ free functions. These are
  mapped to static methods in the class `OEChem`.

* C# doesn't support all the operator overloading of C++, so some C++
  operators are   mapped to methods. For example, "operator bool()" is mapped to
  a member function called "IsValid()", "operator()" is mapped to "Call()".

.. _csharp_prerequisites:

Prerequisites
===============

In order to use the OpenEye toolkits with C#/.Net, you need a copy of
Visual Studio. We currently support VS2022 including the free "Express" version.

.. note::

   VS2022 requires the `.NET Framework 4.8 <https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48>`_.
   We do not yet support .NET Core.

GPU Prerequisites
=================

.. note::

  **GPU-Enabled OpenEye products** are not supported on Windows platforms or in the C# language.

Download the OpenEye .Net distribution
======================================

The distribution is obtained from http://www.eyesopen.com/downloads. There
is a 64-bit download for each supported version of Visual Studio.

Installation
=============

Each distribution is provided as ZIP file, that you can simply
extract.  Inside the ``C#-Examples`` folder, you will find a pair of
folders for each toolkit. One for the main examples and one for the
documentation examples. Each sub-folder contains a solution (.sln)
file appropriate for your chosen Visual Studio version.

.. _GAC:

The Global Assembly Cache
==========================

If you desire to install all the OpenEye assemblies into the Global
Assembly Cache, there is a convenience script included in the
``Scripts`` directory. Double-click on :program:`Install_to_GAC.bat`
to install all the assemblies.

If you need to uninstall the assemblies for some reason, simply
double-click on :program:`Uninstall_from_GAC.bat`.

.. note:: There is no requirement to install anything into the
  GAC. If you are not sure you need this, you probably don't.



******************************
License for OpenEye Toolkits
******************************

.. |product_type| replace:: toolkit

A license file from OpenEye, Cadence Molecular Sciences is required to run any OpenEye
|product_type|. A license file can be requested/obtained by contacting OpenEye
(https://www.eyesopen.com/contact).

At startup, the |product_type| looks for a valid license in the following default
locations:

* In a file specified by the environment variable :envvar:`OE_LICENSE`.  Example commands to set
  the environment variable:

  * Linux/UNIX and MacOS:

    ``export OE_LICENSE=/home/USERNAME/oe_license.txt``

    This can be executed in a shell prompt, or added to the user's ``~/.bash_profile``.
    If running `zsh`,  add to the user's ``.bash_profile`` and then include ``.bash_profile``
    in the user's ``.zshrc``.

  * Microsoft Windows:

    ``setx OE_LICENSE C:\Users\USERNAME\oe_license.txt`` to set the environment variable permanently using Command Prompt, or
    ``SET OE_LICENSE=C:\Users\USERNAME\oe_license.txt`` to set for the duration of the session using Command Prompt.
    ``$env:OE_LICENSE="C:\Users\USERNAME\oe_license.txt"`` to set the environment variable using PowerShell.

* In a file named ``oe_license.txt`` in the directory specified by the
  environment variable :envvar:`OE_DIR`.

* In a file named ``oe_license.txt`` in the user's platform-specific local
  OpenEye application data directory. The location of this directory is
  detailed below:

  * Linux/UNIX:

    ``~USERNAME/.OpenEye``

  * MacOS:

    ``/Users/USERNAME/Library/OpenEye`` or ``~USERNAME``

  * Microsoft Windows:

    ``C:\Users\USERNAME\AppData\Local\OpenEye``

* In a file named ``oe_license.txt`` in the current working directory






.. _section_csharp_tk_import:

****************************
How to import the toolkits
****************************

At the beginning of most C# programs, functionality that
resides in other files is imported with the ``using``
statement. Built-in namespaces are usually imported like the
following:

.. code-block:: csharp

   using System;

**OpenEye Toolkits** resides in the ``Openeye`` module. For example
**OEChem TK** can imported as:

.. code-block:: csharp

   using OpenEye.OEChem;


Using C# with VS2022
==============================

Creating a new project
-----------------------

To create a new project, choose :guilabel:`Create a New Project` from the VS2022 launch screen, or
:menuselection:`File --> New --> Project` from the file menu. This will bring up a dialog.

Select :guilabel:`Console App (.Net Framework)`

In the :guilabel:`Configure your  new project` dialog, enter your project name and select :guilabel:`Create`.

Adding references to the OpenEye assemblies
--------------------------------------------

Bring up the Reference Manager by selecting :menuselection:`Project --> Add Reference` 

In this dialog, we want to:

  * Click :guilabel:`Browse` on the left side
  * Click the :guilabel:`Browse...` button in the lower right.
  * Browse to the "Libs" directory under where you unzipped the OpenEye
    .NET libs. 
  * Select "OpenEye.OEChem.dll" and hit :guilabel:`Add`

Click :guilabel:`OK` to return to the project.

Additional toolkits can be chosen as you add more functionality to your program.
For this example, we are only using OEChem.

Changing the build target
-------------------------

By default, a new C# project is set up to target "AnyCPU", 
but since we are linking to native code, we need to change
the build target to "x64".

In the menu bar, you will see a pull-down menu that controls 
the Solution Configuration. 

Click on the drop down and choose "Configuration Manager..."

.. _figure_vs2015_anycpu:

.. figure:: /_images/AnyCPU.PNG
   :align: center
   :scale: 70%

   **Launching the Configuration Manager**

You should see a dialog like :ref:`The Configuration Manager<figure_vs2015_anycpu>`.

.. _figure_vs2015_config_manager:

.. figure:: /_images/VS2015_ConfigurationManager.PNG
   :align: center
   :scale: 70%

   **The Configuration Manager**

In the upper right corner of the Configuration Manager
Dialog, click on the "Active solution platform:" pulldown
and choose :guilabel:`<New...>`. 

.. _figure_vs2015_new_platform:

.. figure:: /_images/VS2015_CreateNewSolutionPlatform.PNG
   :align: center
   :scale: 70%

   **Creating new solution platform**

In the top pull-down, choose "x64" and leave the bottom 
pull-down ("Copy settings from"), set to "AnyCPU". Click "OK." 
See :ref:`Creating new solution platform<figure_vs2015_new_platform>`.

Click :guilabel:`Close`. Now it is time to add some code to our program.

Adding code to the project
---------------------------

In the project browser, double-click "Program.cs" to open it
in the editor, if it is not already open.

At the top of the file, we will add *using* statements for 
OEChem:

.. code-block:: csharp
   
    using OpenEye.OEChem;

and then inside the "Main", we add this code:

.. code-block:: csharp

    OEGraphMol mol = new OEGraphMol();
    OEChem.OESmilesToMol(mol, "c1ccccc1CCCBr");
    Console.WriteLine("mol has {0} atoms", mol.NumAtoms());

When you are finished, your sample should look something like
:ref:`Editing in VisualStudio<figure_vs2015_editing>`.

.. _figure_vs2015_editing:

.. figure:: /_images/VS2015_Editing.PNG
   :align: center

   **Editing in VisualStudio**

To test our example, we can run it from within VisualStudio by
hitting <Ctrl-F5>. If you don't have any syntax errors, you
should see a Console window appear with output that
looks like :ref:`Running the Example<figure_vs2015_running>`.

.. _figure_vs2015_running:

.. figure:: /_images/VS2013-Running.PNG
   :align: center
   :scale: 75%

   **Running the example in VisualStudio**

Deploying the program to another machine
----------------------------------------

Once you have a program to a state where you want to run it elsewhere
or share with someone else, you should first build in Release mode.

Go back to the pull-down menu in the toolbar and change :guilabel:`Debug`
to :guilabel:`Release`.

The choose :menuselection:`Build --> Build Solution`.

The process of building not only compiles your C# code into an
executable, it also copies the referenced OpenEye assemblies
(OpenEye.OEChem.dll in this case) into the output
directory. Additionally, all the DLLs that the OpenEye assembly
depends on will also be copied into the Release binary directory.



########################
Legal Notices
########################

..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt




:orphan:

.. _section_python_getting_started:

***********************************
Getting Started with OpenEye Python
***********************************

.. toctree::
   :maxdepth: 2

   license
   install
   pycharm
   tkimport
   include-from-theme-in-tk



.. _python_installation:

###############
Installation
###############

.. toctree::
   :maxdepth: 2

   prereq
   installpyosxlinux
   linuxosx
   windows
   uninstall


.. _install_python_osx_linux:

Installing Python on macOS and Linux
========================================================================

Python3 is not always preinstalled on macOS and may need to be installed
for your Linux system. For Linux, it is preferable to use your system's
default package manager, such as ``yum`` or ``apt``.  If you are planning
to use Anaconda (our recommendation), a system python is not required, because
Python is installed as part of the Anaconda environment.

Alternatively:

- You can download Anaconda from `anaconda.com <https://www.anaconda.com/download>`_
  and follow the given directions for installation.

- You can download the Python installer appropriate for your system
  from `Python.org <http://www.python.org/download/>`_, and follow the given
  directions for installation.


******************************
License for OpenEye Toolkits
******************************

.. |product_type| replace:: toolkit

A license file from OpenEye, Cadence Molecular Sciences is required to run any OpenEye
|product_type|. A license file can be requested/obtained by contacting OpenEye
(https://www.eyesopen.com/contact).

At startup, the |product_type| looks for a valid license in the following default
locations:

* In a file specified by the environment variable :envvar:`OE_LICENSE`.  Example commands to set
  the environment variable:

  * Linux/UNIX and MacOS:

    ``export OE_LICENSE=/home/USERNAME/oe_license.txt``

    This can be executed in a shell prompt, or added to the user's ``~/.bash_profile``.
    If running `zsh`,  add to the user's ``.bash_profile`` and then include ``.bash_profile``
    in the user's ``.zshrc``.

  * Microsoft Windows:

    ``setx OE_LICENSE C:\Users\USERNAME\oe_license.txt`` to set the environment variable permanently using Command Prompt, or
    ``SET OE_LICENSE=C:\Users\USERNAME\oe_license.txt`` to set for the duration of the session using Command Prompt.
    ``$env:OE_LICENSE="C:\Users\USERNAME\oe_license.txt"`` to set the environment variable using PowerShell.

* In a file named ``oe_license.txt`` in the directory specified by the
  environment variable :envvar:`OE_DIR`.

* In a file named ``oe_license.txt`` in the user's platform-specific local
  OpenEye application data directory. The location of this directory is
  detailed below:

  * Linux/UNIX:

    ``~USERNAME/.OpenEye``

  * MacOS:

    ``/Users/USERNAME/Library/OpenEye`` or ``~USERNAME``

  * Microsoft Windows:

    ``C:\Users\USERNAME\AppData\Local\OpenEye``

* In a file named ``oe_license.txt`` in the current working directory






************************************************************************
Linux & macOS
************************************************************************

Installing OpenEye Python Toolkits as a Conda Package
========================================================================

The simplest and recommended way to install the **OpenEye Python Toolkits** is as a
Conda package.

The Anaconda package can be downloaded from
https://www.anaconda.com/distribution/ for Windows, macOS and Linux
platforms. Follow the very simple instructions given there for
installation.

..  note::

   While Anaconda is available free of charge for personal use, you may need to purchase an Anaconda license if
   you are doing commercial development.
   Please check the `Anaconda license terms <https://www.anaconda.com/anaconda-commercial-edition>`_.

For first time users, we also recommend reading
`Getting started with conda <https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html>`_ and print out the
`Conda user cheat sheet <http://know.continuum.io/rs/387-XNW-688/images/conda-cheatsheet.pdf>`_
reference.

.. note::

   **OpenEye Python Toolkits** only supports Python3.

After downloading and installing Anaconda, the **OpenEye Python
Toolkit** package can be installed by the following steps:

1. First create a new conda environment with the **OpenEye Python Toolkit** package

   .. code-block::

      $ conda create -n oepython -c openeye openeye-toolkits

      Solving environment: done

      ## Package Plan ##

        environment location: /home/username/anaconda3/envs/oepython

        added / updated specs:
          - openeye-toolkits

        The following packages will be downloaded:

        ...

        The following NEW packages will be INSTALLED:

        ...
        openeye-toolkits: |pypkgversion| -py37_0        openeye
        ...

        Proceed ([y]/n)?

   After entering "y" to proceed, a new 'oepython' environment will be created
   with the **OpenEye Python Toolkit** package.

|

2. Activate the newly created 'oepython ' environment:

   .. code-block::

      $ conda activate oepython

3. Run the **OpenEye** example `oecheminfo.py` to verify the installation
   has completed successfully:

   .. code-block::

      (oepython) $ oecheminfo.py
      Installed OEChem version: |oechemversion| platform: linux-g++4.x-x64 built: |builddate|
      ...

Alternative Installation Strategies
========================================================================

* To install **OpenEye Python Toolkits** in existing environments:

  .. toctree::
     :maxdepth: 1

     linuxosx_anaconda
     linuxosx_virtualenv

  The above two ways are highly recommended since it is considered
  harmful to install packages into your global Python installation.

* To install **OpenEye Python Toolkits** across multiple Linux versions:

  .. toctree::
     :maxdepth: 1

     linuxosx_single

For assistance with unusual installation environments such as systems
without network access or heterogeneous clusters, please contact
support at support@eyesopen.com.

.. _section_python_test_linux:

Integration Testing
========================================================================

The **OpenEye Python Toolkits** ship with a simple set of integration
tests to make sure all the libraries function as intended. The test suite
is not as exhaustive as the test suite used internally, it is just meant to
ensure the **OpenEye Python Toolkits** infrastructure is working as intended.

.. warning::

   Running the integration test requires *scripttest* and *nose*
   Python packages. These packages will be installed on-the-fly, if
   necessary. Again using *conda* or *virtualenv* environments
   will ensure that these packages will not be installed into the global
   Python environment.

To run the integration test suite (after activating the environment
into which **OpenEye Python Toolkits** has been installed), execute the
following command::

   $ python -m openeye.examples.openeye_tests

A message like the following will be shown if all the tests were run
successfully::

   Requirement already satisfied: pytest
   Requirement already satisfied: py>=1.4.29
   Collecting scripttest
   Installing collected packages: scripttest
   Successfully installed scripttest-1.3
   Ran 42 tests in 95.877s

   OK

Tests are skipped when the license is invalid/expired/doesn't exist or
if functionally is not supported on the OS/platform.
For example, when using a license file that only contains an **OEChem TK**
license, a large number of tests will be skipped::

   SSSSSSSSSSSSSSS.......SSSSSSSSSSSSSSSSSSS
   ----------------------------------------------------------------------
   Ran 42 tests in 0.956s

   OK (SKIP=34)

Similarly, FastROCS, GPU-OMEGA, and GPU-GRAPHSIM tests are skipped on macOS, Windows, and Linux systems
without appropriate GPU hardware since their functionality is not available.


.. _section_python_anaconda:

================================
Anaconda with Conda Installation
================================

.. A couple of points about the above label and heading:
    1.  The DEFAULT link text for refs like ":ref:`section_python_anaconda` is "Anaconda with Conda Installation"
        However, I DO NOT recommend links that use defaults like that.  What if someone later puts a typo or something
        stupid in the title?  Then your link text will have the typo or stupidity.
        So, decide what link text you want, and put it in there.  See the :ref: call later in this document.

..  2.  The label name section_python_anaconda seems sufficiently unambiguous.
        It also starts with the word "section," which is good, because that may make it easier
        to find in some situations, like use of the msphinx tool.  I checked the log and was not warned of a duplicate
        although there were other label-related warnings in the build that I then went off to fix.

..  Not relevant to labels BUT:
    1. Every Sphinx document should/must start with a "title," which is nothing
    more or less than the first heading that appears in the file.  Here, the title is "Anaconda with Conda Installation."
    That title will be the entry in the HTML navigation, for example, in the left-hand nav bar or other
    displays of the navigation.
    2. Sphinx and RST do not have a hierarchy of labels like H1, H2, and so on.  Instead, the Sphinx builder
    for HTML or PDF or whatever figures out and assigns positions in the hierarchy, starting with this first one.
    3. The Sphinx builder uses the overlining/underlining characters in the titles to decide what is what
    in the hierarchy, so be consistent, within a file, the way you use them.
    4. There is a HIGHLY RECOMMENDED convention used by the Python documentation for new material written
    in Sphinx/RST: https://documentation-style-guide-sphinx.readthedocs.io/en/latest/style-guide.html#headings

The Anaconda package can be downloaded from
`the Anaconda Distribution page <https://www.anaconda.com/download>`_ for Windows, macOS and Linux
platforms. Follow the very simple instructions given there for
installation.
For first time users we also recommend reading
`Getting started with conda <https://docs.anaconda.com/anaconda/user-guide/getting-started/index.html>`_ and print out the
`Conda user cheat sheet <http://know.continuum.io/rs/387-XNW-688/images/conda-cheatsheet.pdf>`_
reference.

..  Notice that it is easy to put http links in a Sphinx document.  The first example here will just put
    it in using the URL as the link text.  The next two examples substitute the author's preferred
    link text.   You need to put in a bit of extra time and test http links.

..  Oops!  That first cross-ref to the Getting Started document for conda was broken.  Such is life
    with other peoples' documentation that is not (or probably not) built with Sphinx.  So I had to text
    and fix the URL.  I picked one that is 1) relevant and 2) an official Conda document.  Maybe the original
    author wanted some different document....

.. note::

   We recommend the installation of PYTHON 3 Anaconda packages.
   This version will default to Python 3 when creating new
   environments and building packages.

..  note::

   While Anaconda is available free of charge for personal use, users may need to purchase an Anaconda license if
   they are doing commercial development.
   Please check the `Anaconda license terms <https://www.anaconda.com/anaconda-commercial-edition>`_.

.. hint::

   We recommend using the Anaconda package, which is a complete suite
   containing hundreds of open source Python packages.
   If disk-space is limited, we recommend the mini version of Anaconda,
   namely, *Miniconda*. *Miniconda* includes conda, its dependencies and
   Python.

   The *Miniconda* package can be downloaded from
   `Anaconda's Miniconda page <http://conda.pydata.org/miniconda.html>`_ for Windows, macOS and Linux
   platforms.

..  There used to be a second link to a miniconda install page, but it was broken. The new first link
    has installation instructions right there.  So for the time being, we don't need more than that one.

..  You may be way ahead of me, but:  a best practice would be to limit external HTTP links to specific places
    and cross-reference those with intersphinx.  Then we have to test and fix broken links in only one place.

   All the instructions for installing the OpenEye Python Toolkit
   are identical whether using the  Anaconda or *Miniconda* packages.

After downloading and installing Anaconda, the OpenEye Python
Toolkit package can be installed by the following steps:

#. First create a new conda environment::

      $ conda create -n oepython python=3

      Collecting package metadata (current_repodata.json): done
      Solving environment: done

      ## Package Plan ##

        environment location: /anaconda3/envs/oepython

        added / updated specs:
          - python=3

      The following packages will be downloaded:

          package                    |            build
          ---------------------------|-----------------
          libffi-3.2.1               |       h0a44026_6          43 KB
          ncurses-6.2                |       h0a44026_1         749 KB
          ------------------------------------------------------------
                                                 Total:         792 KB

      The following NEW packages will be INSTALLED:

        ca-certificates    pkgs/main/osx-64::ca-certificates-2020.1.1-0
        certifi            pkgs/main/osx-64::certifi-2020.4.5.1-py38_0
        libcxx             pkgs/main/osx-64::libcxx-4.0.1-hcfea43d_1
        libcxxabi          pkgs/main/osx-64::libcxxabi-4.0.1-hcfea43d_1
        libedit            pkgs/main/osx-64::libedit-3.1.20181209-hb402a30_0
        libffi             pkgs/main/osx-64::libffi-3.2.1-h0a44026_6
        ncurses            pkgs/main/osx-64::ncurses-6.2-h0a44026_1
        openssl            pkgs/main/osx-64::openssl-1.1.1g-h1de35cc_0
        pip                pkgs/main/osx-64::pip-20.0.2-py38_1
        python             pkgs/main/osx-64::python-3.8.2-hc70fcce_0
        readline           pkgs/main/osx-64::readline-8.0-h1de35cc_0
        setuptools         pkgs/main/osx-64::setuptools-46.1.3-py38_0
        sqlite             pkgs/main/osx-64::sqlite-3.31.1-h5c1f38d_1
        tk                 pkgs/main/osx-64::tk-8.6.8-ha441bb4_0
        wheel              pkgs/main/osx-64::wheel-0.34.2-py38_0
        xz                 pkgs/main/osx-64::xz-5.2.5-h1de35cc_0
        zlib               pkgs/main/osx-64::zlib-1.2.11-h1de35cc_3

      Proceed ([y]/n)?

   After entering "y" to proceed, a new 'oepython' environment
   will be created with Python 3.8.

#. Activate the newly created 'oepython' environment::

      $ source activate oepython
      (oepython) $

   .. warning::

      It is very important to activate a work environment before performing
      any additional installations, otherwise packages will be installed
      into the global Python environment.

#. Install the OpenEye Python Toolkits into the new environment::

      (oepython) $ conda install -c openeye openeye-toolkits
      Solving environment: done
      ...

      The following NEW packages will be INSTALLED:

      attrs:            17.3.0-py35h20e33bf_0
      ca-certificates:  2017.08.26-h1d4fec5_0
      coverage:         4.4.2-py35h8fc71f1_0
      hypothesis:       3.38.5-py35h785bf34_0
      libgcc-ng:        7.2.0-h7cc24e2_2
      openeye-toolkits: 2018.2b2-py35_0       openeye
      pluggy:           0.6.0-py35hb428803_0
      py:               1.5.2-py35hfe8c5ce_0
      pympler:          0.5-py35hc09b5c8_0
      pytest:           3.3.2-py35_0
      six:              1.11.0-py35h423b573_1
      zope:             1.0-py35_0
      zope.interface:   4.4.3-py35h9cef842_0

      Proceed ([y]/n)? y

      ...

#. Run the OpenEye example `oecheminfo.py` to verify the installation
   has completed successfully::

      (oepython) $ oecheminfo.py
      Installed OEChem version: |oechemversion| platform: linux-g++4.x-x64 built: |builddate|
      ...

.. warning::

   Setting the environment variable ``PYTHONPATH`` will override the path
   to the Python modules installed in a conda environment.
   Make sure ``PYTHONPATH`` is **not** set when using a virtual environment.

.. seealso::

  See :ref:`Integration Testing <section_python_test_linux>` for post-installation testing of the
  OpenEye Python Toolkits.

..  I fixed the old markup, to put in explicit link text for the section labeled by "section_python_test."



.. _section_python_single_build:

Common Linux Single-Build Installation
-------------------------------------------

The default Linux package contains libraries built to be maximally-compatible
with Linux-based systems.  It is built specifically to take advantage of
the Linux cross-version compatibility guarantees in such a way that the
Python package will run on many common Linux platforms.

This distribution is built on the *oldest* version of Linux supported by
OpenEye.  This means that the libraries will only depend on older Linux system
functions (e.g. libc).  Since Linux guarantees forwards compatibility,
the distribution will work across many modern Linux systems.

The distribution is built using a later g++ compiler toolchain.
This allows us to take advantage of optimizations and language features
available in later g++ compiler versions (we're not tied to the g++ from
the oldest Linux OS).  This does create a new dependency on later versions
of C++ runtime libraries (libstdc++.so, libgcc_s.so, libgomp.so).

For a PIP installation on older RedHat versions, the default behavior is to install a
package built against an older gcc version.  This version is maximally
compatible with a default RedHat system.

One can control the behavior of the pip meta-package installer using the
``OE_PIP_ARCH`` environment variable before executing the ``pip install``
command. One can set the ``OE_PIP_ARCH`` value to the exact desired
distribution or to the special value ``old``, which will always download
a version built exactly on the current platform, if available.
On Linux the ``single-build`` distributions include the string ``linux-x64``
in the name, so a ``pip list`` can be used to identify whether a
single-build or platform-specific distribution has been installed.

.. note::

   In previous toolkits, ``OE_ARCH`` was used by the installer for both
   Python packages and applications.  This caused confusion since the
   platform names could be different for the applications and the
   Python packages on a platform.  Now ``OE_ARCH`` is used exclusively
   by the applications and ``OE_PIP_ARCH`` is used exclusively by the
   Python toolkits.



.. _section_python_virtualenv:

Virtual Environment Installation
------------------------------------------------------------------------

Assuming you have `virtualenv <http://www.virtualenv.org/en/latest/>`_ and
`virtualenvwrapper <http://virtualenvwrapper.readthedocs.org/en/latest/>`_,
the **OpenEye Python Toolkits** can be installed by the following steps:

#. First create a new virtual environment::

      $ mkvirtualenv oepython

#. Pip install **OpenEye Python Toolkits** into the new environment::

      (oepython) $ pip install -i https://pypi.anaconda.org/OpenEye/simple OpenEye-toolkits

Or you can also pip install from a tarball downloaded from `the OpenEye Product Downloads page <http://www.eyesopen.com/downloads>`_::

      (oepython) $ pip install OpenEye-toolkits-python3-linux-x64-|pypkgversion|.tar.gz

#. Run the **OpenEye** example `oecheminfo.py` to verify the
   **OpenEye Python Toolkits** have been successfully installed::

      (oepython) $ oecheminfo.py
      Installed OEChem version: |oechemversion| platform: linux-g++4.x-x64 built: |builddate|
      ...

.. warning::

   Setting the environment variable ``PYTHONPATH`` will override the path
   to the Python modules installed in a virtual environment.
   Make sure ``PYTHONPATH`` is **not** set when using a virtual environment.

.. seealso::

  :ref:`section_python_test_linux` section for post-installation testing of the
  **OpenEye Python Toolkits**

.. hint::

   When installing different versions of the toolkit (platform specific vs.
   single build) in different conda environments, ``pip`` might try to
   install the Python packages from the cache.  In order to avoid this
   problem, use the ``--no-cache-dir`` option.


.. _python_prerequisites:

Prerequisites
========================================================================

In order to use the **OpenEye** Python toolkits, a compatible version
of Python must be installed. Instructions on installing Python are
given in this document.

Linux installation also requires the zlib and libcairo libraries be available. These
are usually available on Desktop Linux installations by default, but
may not be available on Linux server installations.

Below are the different Python versions supported
for various platforms.

Linux
------------------------------------------------------------------------

The following Python versions and platforms are supported with one single build
Linux package:

3.[10-13]

  * RHEL8 (x64)
  * RHEL9 (x64)
  * Ubuntu 22.04 (x64 and arm64)
  * Ubuntu 24.04 (x64)

macOS
------------------------------------------------------------------------

The following Python versions and platforms are supported with one single build
macOS package:

  * 3.[10-13] on macOS 13-15

Windows
------------------------------------------------------------------------

On Windows, packages are built for specific Python versions.

* 3.10 (x64)
* 3.11 (x64)
* 3.12 (x64)
* 3.13 (x64)

.. note::

   VSRUNTIME140.dll and MSVCP140.dll are dependencies of OpenEye Windows dlls.
   The recommended Anaconda Python provides these.

.. _python_gpu_prerequisites:

..  _fastrocs_performance_tuning:

GPU Prerequisites
========================================================================


GPU-Related Requirements
========================

The following features are required in order to use GPU-accelerated OpenEye toolkits and applications.


Supported Platforms
-------------------

CUDA-enabled OpenEye software is only available on supported Linux platforms.
For supported Linux platforms see the `Platform Support Page <https://www.eyesopen.com/supported-platforms>`_.


Supported GPUs
-------------------

An NVIDIA `Tesla <http://www.nvidia.com/object/tesla-supercomputing-solutions.html>`_,
`Quadro <http://www.nvidia.com/object/workstation-solutions.html>`_, or
`GeForce <http://www.nvidia.com/object/geforce_family.html>`_ GPU with a **compute capability of 3.5
or higher** is required on your system. For a comprehensive table of compute capability
categories for each GPU, please refer to the `CUDA <https://en.wikipedia.org/wiki/CUDA>`_ Wikipedia page.


NVIDIA Drivers
-------------------

* **Minimum NVIDIA Driver version: 450.x**.

* CUDA is **not** required to be installed.

We recommend driver `450.80.02 <https://www.nvidia.com/Download/driverResults.aspx/165294/en-us>`_, and
we strongly advise manually downloading and installing the appropriate NVIDIA driver
for your system as opposed to using a package manager.

To install, root privilege is required. Follow these steps:

  #. Download the driver to the machine you are installing it on.
  #. ``chmod +x`` the driver package to make it executable.
  #. Ensure you have disabled X-server by killing any running sessions.
     Reboot may be required if X-server is still running after this step.
     
     .. warning::

        Disabling X-server requires different processes to be killed depending on your Linux
        distribution.
        See the `NVIDIA installation guide
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_ for more details.

     .. warning::

        The NVIDIA kernel module can often conflict with the open source
        Nouveau display drivers, depending on your specific Linux
        distribution. The NVIDIA documentation is a much more complete
        and up-to-date source for information on how to work around this issue.
        See `Disabling Nouveau
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile-nouveau>`_ on the NVIDIA website.

  #. Install the driver by ``sudo ./NVIDIA-Linux-x86_64-450.80.02.run`` and follow the step-by-step installation instructions.

  For more details on driver installations, see the `CUDA Installation Guide
  <https://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_

.. note::

  The output of the ``nvidia-smi`` command is extremely useful when
  debugging GPU issues. Please include the output from
  ``nvidia-smi`` in any request to support@eyesopen.com.


Performance Tuning
-------------------

To get the most performance out of an NVIDIA graphics card, use the persistence daemon to switch persistence mode
across all cards on the system (root privilege required)::

  sudo nvidia-persistenced --user foo

This will automatically enable persistence mode after reboot.

For full instructions on the persistence daemon, see the `Persistence daemon section
<https://docs.nvidia.com/deploy/driver-persistence/index.html#persistence-daemon>`_ of the NVIDIA docs.


********************************************************************************
How to Develop with the OpenEye Python Toolkit in PyCharm
********************************************************************************

PyCharm is a Python integrated development environment (IDE) by JetBrains, available from
http://www.jetbrains.com/pycharm.  It has a rich set of features for developing
and debugging Python programs, including programs using OpenEye Python
toolkits.  You can follow the how-to suggestions here, to set up a
project using our toolkits, and you should investigate the JetBrains site for
training and documentation on PyCharm.

This guide uses illustrations from PyCharm on macOS, but the procedures are almost identical
for the Linux version of PyCharm.  Just note that the preferences in the Linux product
are brought up with the ``File/Settings...`` command.

Create a New Project
================================================================================

After successful installation of PyCharm, a new project has to be
created. If not prompted when opening PyCharm, such as in
:ref:`figure_pycharm_launch`, a new project can be created via
**File** :math:`\rightarrow` **New Project...** in the main toolbar.

.. _figure_pycharm_launch:

.. figure:: /_images/pycharm_launch.png
   :align:  center
   :width: 400 pt

   **Opening PyCharm**

Give your project a name such as ``OESample``.   You can
pick a Python interpreter and create a development environment using either
`venv <https://docs.python.org/3/library/venv.html>`_ or
`Anaconda <https://www.anaconda.com/>`_.  This guide uses Anaconda, so
the examples assume you have already installed Anaconda from their site.

Optionally, pick the location to which to save the project.  The
dialog should look like :ref:`figure_pycharm_project`

.. _figure_pycharm_project:

.. figure:: /_images/pycharm-project.png
   :align:  center
   :width: 400 pt

   **PyCharm Project Dialog**

Here, the project ``OESample`` will be saved in PyCharm's default location.
A new environment, also called OESample, will be created using Conda
(Anaconda), and it will
be stored in the location set up during the Anaconda installation. Python
3.9 will be the interpreter used in that environment.  The OESample Conda environment
will be available to all projects, meaning it will be available for the
next project you create, in the drop-down under ``Previously configured interpreter``.

Adding the OpenEye Python Toolkit to Your Project as a Package
================================================================================

The next step is to add the OpenEye Python toolkit to this project.
Click the Python Packages button at the bottom of the PyCharm screen
to bring up the :ref:`figure_pycharm-package-window`.

.. _figure_pycharm-package-window:

.. figure:: /_images/pycharm-package-window.png
   :align:  center
   :width: 400 pt

   **PyCharm Package Window**

In the search bar, enter OpenEye, and note that the toolkits were located in the Python Package Index `(PyPI) <https://pypi.org/>`_.

.. _figure_pycharm-openeye-package:

.. figure:: /_images/pycharm-openeye-package.png
   :align:  center
   :width: 400 pt

   **Preparing to Install the Toolkit**

Click the ``Install package`` button at the right of the Python Packages window.

After a couple of seconds a message: ``Package Openeye-toolkits
installed`` will appear at the bottom. Going back to the
``Preferences`` dialog, it should look like
:ref:`figure_pycharm-openeye-in-pref.png`.

.. _figure_pycharm-openeye-in-pref.png:

.. figure:: /_images/pycharm-openeye-in-pref.png
   :align:  center
   :width: 400 pt

   **Successful Installation of OpenEye Package**

Adding a module to your project
================================================================================

With an OpenEye  project enabled, now an example can be written and
tested. First, change the view by selecting in the main toolbar **View**
:math:`\rightarrow` **Tool Windows** :math:`\rightarrow` **Project**.
Then a new Python module can be created by right clicking on
the *OESample* project (in the list on the left) and then
selecting **New** :math:`\rightarrow` **Python Package**.
After naming the project, in this case *oechemexamples*, a new Python file
can be added the newly created package by right clicking on
*oechemexamples* and then selecting **New**
:math:`\rightarrow` **Python File**.  In this case a new
example file is created with a name *oesample.py* and with the following
sample code:

::

    from openeye import oechem

    def main():
        mol = oechem.OEGraphMol()
        oechem.OEParseSmiles(mol, 'c1ccccc1CCCBr')
        print('mol has {0} atoms'.format(mol.NumAtoms()))

    if __name__ == "__main__":
        main()

This new example can be run by right clicking *oesample.py* and
selecting **Run 'oesample'** A run dialog will appear at the bottom of
the window with the single print statement and it should look like
:ref:`figure_pycharm_code`.

.. _figure_pycharm_code:

.. figure:: /_images/pycharm-code.png
   :align:  center
   :width: 500 pt

   **PyCharm Code and Run Output**


.. _section_python_tk_import:

****************************
How to Import the Toolkits
****************************

At the beginning of most Python programs, functionality that
resides in other files is imported with the ``import``
statement. Built-in modules are usually imported like the
following:

.. code-block:: python

   import os, sys

Then functionality from those modules can be called by prefixing
the method name with the module name as in ``sys.stdout.write()``
or ``os.exit(0)``.

**OpenEye toolkits** reside in the ``openeye`` module.
For example, **OEChem TK** can be imported as:

.. code-block:: python

   from openeye import oechem

This causes all methods and objects in the ``openeye.oechem`` namespace to
be  pulled directly into the current script's ``oechem`` namespace.
Once the package is imported, objects can be created and methods
can be called using the ``oechem`` prefix, (e.g. ``oechem.OEGraphMol()``).

..  note::

    **OEChem TK** should be imported before any other OpenEye toolkits.



********************************************************************************
Uninstallation
********************************************************************************

Uninstalling OpenEye Python Toolkits - Anaconda
===============================================

Uninstallation is straightforward::

   (oepython)$ conda uninstall openeye-toolkits

   The following packages will be REMOVED:

   openeye-toolkits: 2018.2-py34_0 openeye

   Proceed ([y]/n)?

Uninstalling OpenEye Python Toolkits - PIP
==========================================

Special care must be taken to uninstall everything when the
OpenEye toolkits were installed from OpenEye's `anaconda.org
repository <https://anaconda.org/OpenEye>`_. The following command will
actually install two packages, as can be seen with the following ``pip list``
command::

   (oepython) $ pip install -i https://pypi.anaconda.org/OpenEye/simple OpenEye-toolkits
   ...
   (oepython) $ pip list
   OpenEye-toolkits (|pypkgversion|)
   OpenEye-toolkits-python3-osx-x64 (|pypkgversion|)
   pip (9.0.1)
   setuptools (0.38.4)

The ``OpenEye-toolkits`` package is referred to as the "meta-package"
as its sole purpose is to do automatic platform detection for the
proper binary package, then install that package as well. The
``OpenEye-toolkits-python3-osx-x64`` package seen above is the
actual package that contains the ``openeye`` module. That means to
fully uninstall all OpenEye toolkit packages, both packages need to be
removed. Both packages can be removed by explicitly specifying both
like the following::

   (oepython) $ pip uninstall OpenEye-toolkits
   ...
   (oepython) $ pip uninstall OpenEye-toolkits-python3-osx-x64
   ...

For those wishing to only copy and paste a single command to uninstall
all OpenEye Python packages, the following Linux shell one liner will
do the trick::

   (oepython) $ pip uninstall \`pip list | grep 'OpenEye-toolkits' | awk '{print $1}' | xargs\`
   Uninstalling OpenEye-toolkits:
   ...
   Proceed (y/n)? y
   Successfully uninstalled OpenEye-toolkits
   Uninstalling OpenEye-toolkits-python3-osx-x64:
   ...
   Proceed (y/n)? y
   Successfully uninstalled OpenEye-toolkits-python3-osx-x64


.. _install_python_windows:

********
Windows
********

Installing Python on Windows
========================================================================

.. note::

   Python is not generally installed by default on Windows and may need to be installed, possibly in a virtual environment.  The toolkits can be used with Anaconda, virtualenv, and venv and can be both conda and pip installed.

   However python can be downloaded from http://www.python.org/download/ and installed on your system if desired.

Installing OpenEye Python Toolkits As A Conda package
========================================================================

The simplest way to install the **OpenEye Python Toolkits** is as a
Conda package.

The Anaconda package can be downloaded from
https://www.anaconda.com/download for Windows, macOS and Linux
platforms. Follow the very simple instructions given there for
installation.

..  note::

   While Anaconda is available free of charge for personal use, users may need to purchase an Anaconda license if
   they are doing commercial development.
   Please check the `Anaconda license terms <https://www.anaconda.com/anaconda-commercial-edition>`_.

For first time users we also recommend reading
`Getting started with conda <https/conda.pydata.org/docs/test-drive.html>`_ and print out the
`Conda user cheat sheet <http://know.continuum.io/rs/387-XNW-688/images/conda-cheatsheet.pdf>`_
reference.

.. note::

   **OpenEye Python Toolkits** only supports Python3.

After downloading and installing Anaconda, the **OpenEye Python
Toolkit** package can be installed by the following steps:

1. First create a new conda environment with the **OpenEye Python Toolkit** package

   .. code-block::

      $ conda create -n oepython -c openeye openeye-toolkits

      Solving environment: done

      ## Package Plan ##

        environment location: C:\Users\username\anaconda3\envs\oepython

        added / updated specs:
          - openeye-toolkits

        The following packages will be downloaded:

        ...

        The following NEW packages will be INSTALLED:

        ...
        openeye-toolkits: |pypkgversion| -py39_0        openeye
        ...

        Proceed ([y]/n)?

   After entering "y" to proceed, a new 'oepython' environment will be created
   be activated with the **OpenEye Python Toolkit** package.

|

2. Activate the newly created 'oepython' environment:

   .. code-block::

      $ conda activate oepython

3. Run the **OpenEye** example `oecheminfo.py` to verify the installation
   has completed successfully:

   .. code-block::

      (oepython) $ oecheminfo.py
      Installed OEChem version: |oechemversion| platform: microsoft-win64-msvc17-x64 built: |builddate|
      ...

Alternative Installation Strategies
========================================================================

* To install **OpenEye Python Toolkits** in existing environments:

  .. toctree::
     :maxdepth: 1

     windows_anaconda.rst
     windows_virtualenv.rst

  The above two ways are highly recommended since it is considered
  harmful to install packages into your global Python installation.

For assistance with unusual installation environments such as systems
without network access or heterogeneous clusters, please contact
support at support@eyesopen.com.

.. _section_python_test_windows:

Integration Testing
========================================================================

The **OpenEye Python Toolkits** ship with a simple set of integration
tests to make sure all the libraries function as intended. The test suite
is not as exhaustive as the test suite used internally, it is just meant to
ensure the **OpenEye Python Toolkits** infrastructure is working as intended.

.. warning::

   Running the integration test requires *scripttest* and *nose*
   Python packages. These packages will be installed on-the-fly, if
   necessary. Again using *conda* or *virtualenv* environments
   will ensure that these packages will not be installed into the global
   Python environment.

To run the integration test suite (after activating the environment
into which **OpenEye Python Toolkits** has been installed), execute the
following command::

   $ python -m openeye.examples.openeye_tests

A message like the following will be shown if all the tests were run
successfully::

   Requirement already satisfied: pytest
   Requirement already satisfied: py>=1.4.29
   Collecting scripttest
   Installing collected packages: scripttest
   Successfully installed scripttest-1.3
   Ran 42 tests in 95.877s

   OK

Tests are skipped when the license is invalid/expired/doesn't exist or
if functionally is not supported on the OS/platform.
For example, when using a license file that only contains an **OEChem TK**
license, a large number of tests will be skipped::

   SSSSSSSSSSSSSSS.......SSSSSSSSSSSSSSSSSSS
   ----------------------------------------------------------------------
   Ran 42 tests in 0.956s

   OK (SKIP=34)

Similarly, FastROCS, GPU-OMEGA, and GPU-GRAPHSIM tests are skipped on macOS, Windows, and Linux systems
without appropriate GPU hardware since their functionality is not available.



Installing Anaconda and OpenEye Python Toolkits
================================================================================

1. Install Anaconda from https://www.anaconda.com/download Please select the Python 3x version.

.. warning::

   If your Windows user name contains a space Anaconda will prompt with a warning. Continuing with installation **will** cause issues. Installation into C:\\Anaconda3 should work satisfactorily.

..  note::

    While Anaconda is available free of charge for personal use, users may need to purchase an Anaconda license if
    they are doing commercial development.
    Please check the `Anaconda license terms <https://www.anaconda.com/anaconda-commercial-edition>`_.xs

2. Launch the *Anaconda Navigator* application and navigate to the :ref:`figure_anaconda_environments` tab.

.. _figure_anaconda_environments:

.. figure:: /_images/anaconda_environments.png
   :align:  center
   :width: 400 pt

   **Anaconda Environments**

3. Click 'Create' at the bottom and a dialog appears. Provide a name for the new environment, e.g. oetoolkits
as in :ref:`figure_anaconda_create_environment` and click 'Create'.

.. note::

   On Windows, currently only Python 3.7, or 3.8 versions are supported.

.. _figure_anaconda_create_environment:

.. figure:: /_images/create_environment.png
   :align:  center
   :width: 400 pt

   **Create Environment**

4. When the new environment has finished initializing click 'Channels' which will bring up a dialog. Click 'Add' and enter https://conda.anaconda.org/openeye as in :ref:`figure_anaconda_add_channel`. Press enter. Then click 'Update channels'.

.. _figure_anaconda_add_channel:

.. figure:: /_images/add_channel.png
   :align:  center
   :width: 400 pt

   **Add OpenEye Channel**

5. The option 'Not installed' or 'All' should be selected, not 'Installed' as in :ref:`figure_anaconda_list`.

.. _figure_anaconda_list:

.. figure:: /_images/list_channels.png
   :align:  center
   :width: 400 pt

   **List Packages**

#. In the 'Search packages' box start to type openeye and you should see the openeye-toolkits listed. Tick the box to select them and then click 'Apply' as in :ref:`figure_anaconda_install_tks`

.. _figure_anaconda_install_tks:

.. figure:: /_images/install_tks.png
   :align:  center
   :width: 400 pt

   **Select OpenEye Toolkits**

6. A dialog will appear indicating openeye-toolkits and additional dependencies will be installed; click 'Apply'.

7. The toolkits have now been installed. To test this click on the green triangle next to the oetoolkits environment. Select :ref:`figure_anaconda_launch_terminal`.

.. _figure_anaconda_launch_terminal:

.. figure:: /_images/launch_terminal.png
   :align:  center
   :width: 400 pt

   **Open Terminal**

8. This will bring up the :ref:`figure_anaconda_prompt` with the oetoolkits environment loaded.

.. _figure_anaconda_prompt:

.. figure:: /_images/anaconda_prompt.png
   :align:  center
   :width: 400 pt

   **Anaconda Prompt**

9. To check the toolkits have been installed please download and run the oecheminfo.py script below::

      (C:\\Anaconda3\\envs\\oetoolkits) C:\\Users\\User Name> python oecheminfo.py
      Installed OEChem version: |oechemversion| platform: microsoft-win64-msvc14-x64 built: |builddate|
      ...

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`oecheminfo.py <../../../../wrappers/python/examples/oechem/oecheminfo.py>`

   .. only:: oepdf

      .. oe:source:: oecheminfo.py
         :language: python


.. _section_python_windows_virtualenv:

Virtual Environment Installation
------------------------------------------------------------------------

Assuming you have `virtualenv <http://www.virtualenv.org/en/latest/>`_ and
`virtualenvwrapper <http://virtualenvwrapper.readthedocs.org/en/latest/>`_,
the **OpenEye Python Toolkits** can be installed by the following steps:

#. First create a new virtual environment::

      $ mkvirtualenv oepython

#. Pip install **OpenEye Python Toolkits** into the new environment::

      (oepython) $ pip install -i https://pypi.anaconda.org/OpenEye/simple OpenEye-toolkits

Or you can also pip install from a tarball downloaded from http://www.eyesopen.com/downloads::

      (oepython) $ pip install OpenEye-toolkits-python3-linux-x64-|pypkgversion|.tar.gz

#. Run the **OpenEye** example `oecheminfo.py` to verify the
   **OpenEye Python Toolkits** have been successfully installed::

      (oepython) $ oecheminfo.py
      Installed OEChem version: |oechemversion| platform: linux-g++4.x-x64 built: |builddate|
      ...

.. warning::

   Setting the environment variable ``PYTHONPATH`` will override the path
   to the Python modules installed in a virtual environment.
   Make sure ``PYTHONPATH`` is **not** set when using a virtual environment.

.. seealso::

  :ref:`section_python_test_linux` section for post-installation testing of the
  **OpenEye Python Toolkits**

.. hint::

   When installing different versions of the toolkit (platform specific vs.
   single build) in different conda environments, ``pip`` might try to
   install the Python packages from the cache.  In order to avoid this
   problem, use the ``--no-cache-dir`` option.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: ArchiveConverter

.. _OESaiph_ArchiveConverter:

.. oe:class:: ArchiveConverter

   .. attention::

      |PRELIMINARY-API|
      |PYTHONONLY|

   .. oe:api::

      class ArchiveConverter

   :ref:`ArchiveConverter <OESaiph_ArchiveConverter>` is an iterator class which converts tarball or
   zip files into :ref:`OERecord <OEDataFlow_OERecord>`. This class provides the best-suited
   converter iterator for each file in the compressed file as it iterates. This provides the utility
   of combining multiple datasets with the same :ref:`OERecord <OEDataFlow_OERecord>` setup into one large
   :ref:`OERecord <OEDataFlow_OERecord>` or creating multiple :ref:`OERecord <OEDataFlow_OERecord>`
   for each file in the compressed file.
   
   .. oe:method:: Constructors

      .. oe:api::

         ArchiveConverter(path: str)

      .. code-block:: python
         :linenos:

         from openeye import oechem, oesaiph

         path = "path_to_file.zip"         
         for convs in ArchiveConverter(path):
            # provides the best-suited converter iterator

            for rec in convs:
               # iterates through each record in the file found in the compressed file

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OECSVConversionOptions, CSVConversionOptions

.. _OESaiph_OECSVConversionOptions:

.. oe:class:: OECSVConversionOptions

   .. attention::
   
      |PRELIMINARY-API|

   .. oe:api::

      class OECSVConversionOptions

   Stores the delimiter for the :ref:`OECSVFileConverter <OESaiph_OECSVFileConverter>`.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECSVConversionOptions()
            OECSVConversionOptions(OECSVConversionOptions &&)
            OECSVConversionOptions(const OECSVConversionOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OECSVConversionOptions() -> OECSVConversionOptions
            OECSVConversionOptions(arg2: OECSVConversionOptions) -> OECSVConversionOptions

      Default constructor that initializes an :ref:`OECSVConversionOptions <OESaiph_OECSVConversionOptions>`
      with the delimiter set to a comma.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECSVConversionOptions &operator=(OECSVConversionOptions &&)
         OECSVConversionOptions &operator=(const OECSVConversionOptions &)

      Assignment operator.

   .. oe:method:: GetDelimiter

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetDelimiter() const

      .. oe:language:: python

         .. oe:api:: python

            GetDelimiter() -> str

      Returns the delimiter utilized when parsing a row as a string.

   .. oe:method:: SetDelimiter

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDelimiter(const std::string delimiter)

      .. oe:language:: python

         .. oe:api:: python

            SetDelimiter(delimiter: str) -> None

      Sets the delimiter utilized to parse a row.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OECSVFileConverter, CSVFileConverter

.. _OESaiph_OECSVFileConverter:

.. oe:class:: OECSVFileConverter

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OECSVFileConverter

   The :ref:`OECSVFileConverter <OESaiph_OECSVFileConverter>` class extracts data from CSV and TSV
   files into :ref:`OERecord <OEDataFlow_OERecord>`. Custom data extraction based on delimiter type
   and OEField inclusion can be set up through the :ref:`OECSVConversionOptions <OESaiph_OECSVConversionOptions>`. 
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECSVFileConverter()
            OECSVFileConverter(const OECSVFileConverter &)

      .. oe:language:: python

         .. oe:api:: python

            OECSVFileConverter() -> OECSVFileConverter
            OECSVFileConverter(arg2: OECSVFileConverter) -> OECSVFileConverter

   .. oe:method:: Open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Open(const std::string& path,
                      const std::string& displayName = std::string()) override
            bool Open(const std::string& path,
                      const OECSVConversionOptions& options,
                      const std::string& displayName = std::string())

      .. oe:language:: python

         .. oe:api:: python

            Open(path: str, displayName: str = str()) -> bool
            Open(path: str, options: OECSVConversionOptions,
                 displayName: str = str()) -> bool

      Returns a boolean based on whether the file can be opened.
      :ref:`OECSVConversionOptions <OESaiph_OECSVConversionOptions>`
      is set at open.
      
   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECSVFileConverter &operator=(const OECSVFileConverter &)

      Assignment operator.

   .. oe:method:: Close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Close()

      .. oe:language:: python

         .. oe:api:: python

            Close() -> None

      Closes the stream.

   .. oe:method:: GetNextRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNextRecord(OEDataFlow::OEMolRecord& record) override

      .. oe:language:: python

         .. oe:api:: python

            GetNextRecord(record: OEMolRecord) -> int

      Steps through each row of the file adding to the :ref:`OEMolRecord <OEDataFlow_OEMolRecord>`
      passed into the function. The function returns constants based on each pass.
      Return codes: ``SaiphReturnCode::Success``, ``SaiphReturnCode::Fail``, ``SaiphReturnCode::EndOfFile``

   .. oe:method:: GetProgress

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetProgress()

      .. oe:language:: python

         .. oe:api:: python

            GetProgress() -> float

      Returns the percentage of the file that has been traversed.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OEConversionOptionsBase, ConversionOptionsBase

.. _OESaiph_OEConversionOptionsBase:

.. oe:class:: OEConversionOptionsBase

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEConversionOptionsBase

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConversionOptionsBase()
            OEConversionOptionsBase(OEConversionOptionsBase &&)
            OEConversionOptionsBase(const OEConversionOptionsBase &)

      .. oe:language:: python

         .. oe:api:: python

            OEConversionOptionsBase() -> OEConversionOptionsBase
            OEConversionOptionsBase(arg2: OEConversionOptionsBase) -> OEConversionOptionsBase

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEConversionOptionsBase &operator=(OEConversionOptionsBase &&)
         OEConversionOptionsBase &operator=(const OEConversionOptionsBase &)

      Assignment operator.

   .. oe:method:: GetErrorField

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetErrorField() const

      .. oe:language:: python

         .. oe:api:: python

            GetErrorField() -> str

   .. oe:method:: GetSamplePercent

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSamplePercent() const

      .. oe:language:: python

         .. oe:api:: python

            GetSamplePercent() -> float

   .. oe:method:: GetSchemaLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetSchemaLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetSchemaLimit() -> int

   .. oe:method:: GetSchemaRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEDataFlow::OERecord& GetSchemaRecord() const

      .. oe:language:: python

         .. oe:api:: python

            GetSchemaRecord() -> OERecord

   .. oe:method:: GetSmilesFieldName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetSmilesFieldName() const

      .. oe:language:: python

         .. oe:api:: python

            GetSmilesFieldName() -> str

   .. oe:method:: GetUniqueValuesLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetUniqueValuesLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetUniqueValuesLimit() -> int

   .. oe:method:: SetErrorField

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetErrorField(const std::string& fieldName)

      .. oe:language:: python

         .. oe:api:: python

            SetErrorField(fieldName: str) -> None

   .. oe:method:: SetSamplePercent

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSamplePercent(float limit)

      .. oe:language:: python

         .. oe:api:: python

            SetSamplePercent(limit: float) -> None

   .. oe:method:: SetSchemaLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSchemaLimit(unsigned int limit)

      .. oe:language:: python

         .. oe:api:: python

            SetSchemaLimit(limit: int) -> None

   .. oe:method:: SetSchemaRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSchemaRecord(const OEDataFlow::OERecord& record)

      .. oe:language:: python

         .. oe:api:: python

            SetSchemaRecord(record: OERecord) -> None

   .. oe:method:: SetSmilesFieldName

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSmilesFieldName(const std::string fieldName)

      .. oe:language:: python

         .. oe:api:: python

            SetSmilesFieldName(fieldName: str) -> None

   .. oe:method:: SetUniqueValuesLimit

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetUniqueValuesLimit(unsigned int limit)

      .. oe:language:: python

         .. oe:api:: python

            SetUniqueValuesLimit(limit: int) -> None



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OEDBFileConverter

.. _OESaiph_OEDBFileConverter:

.. oe:class:: OEDBFileConverter

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEDBFileConverter
      

   The :ref:`OEDBFileConverter <OESaiph_OEDBFileConverter>` class extracts data from OEDB
   files into :ref:`OERecord <OEDataFlow_OERecord>`.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDBFileConverter()
            OEDBFileConverter(const OEDBFileConverter &)

      .. oe:language:: python

         .. oe:api:: python

            OEDBFileConverter() -> OEDBFileConverter
            OEDBFileConverter(arg2: OEDBFileConverter) -> OEDBFileConverter

   .. oe:method:: Open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Open(const std::string& path,
                      const std::string& displayName = std::string())

      .. oe:language:: python

         .. oe:api:: python

            Open(path: str, displayName: str = str()) -> bool

      Returns a boolean based on whether the file can be opened.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDBFileConverter &operator=(const OEDBFileConverter &)

      Assignment operator.

   .. oe:method:: Close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Close()

      .. oe:language:: python

         .. oe:api:: python

            Close() -> None

      Closes the stream.

   .. oe:method:: GetNextRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNextRecord(OEDataFlow::OEMolRecord& record) override

      .. oe:language:: python

         .. oe:api:: python

            GetNextRecord(record: OEMolRecord) -> int

      Steps through each row of the file adding to the :ref:`OEMolRecord <OEDataFlow_OEMolRecord>`
      passed into the function. The function returns constants based on each pass.
      Return codes: ``SaiphReturnCode::Success``, ``SaiphReturnCode::Fail``, ``SaiphReturnCode::EndOfFile``

   .. oe:method:: GetProgress

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetProgress()

      .. oe:language:: python

         .. oe:api:: python

            GetProgress() -> float

      Returns the percentage of the file that has been traversed.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OEDUFileConverter, DUFileConverter

.. _OESaiph_OEDUFileConverter:

.. oe:class:: OEDUFileConverter

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEDUFileConverter
      
   The :ref:`OEDUFileConverter <OESaiph_OEDUFileConverter>` class extracts the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` 
   from an OEDU file into :ref:`OERecord <OEDataFlow_OERecord>`. The Iridium category is determined by each OERecord extracted.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDUFileConverter()
            OEDUFileConverter(const OEDUFileConverter &)

      .. oe:language:: python

         .. oe:api:: python

            OEDUFileConverter() -> OEDUFileConverter
            OEDUFileConverter(arg2: OEDUFileConverter) -> OEDUFileConverter

   .. oe:method:: Open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Open(const std::string& path,
                      const std::string& displayName = std::string()) override

      .. oe:language:: python

         .. oe:api:: python

            Open(path: str, displayName: str = str()) -> bool

      Returns a boolean based on whether the file can be opened.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDUFileConverter &operator=(const OEDUFileConverter &)

      Assignment operator.

   .. oe:method:: Close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Close()

      .. oe:language:: python

         .. oe:api:: python

            Close() -> None

      Closes the stream.

   .. oe:method:: GetNextRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNextRecord(OEDataFlow::OEMolRecord& record) override

      .. oe:language:: python

         .. oe:api:: python

            GetNextRecord(record: OEMolRecord) -> int

      Steps through each row of the file adding to the :ref:`OEMolRecord <OEDataFlow_OEMolRecord>`
      passed into the function. The function returns constants based on each pass.
      Return codes: ``SaiphReturnCode::Success``, ``SaiphReturnCode::Fail``, ``SaiphReturnCode::EndOfFile``

   .. oe:method:: GetProgress

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetProgress()

      .. oe:language:: python

         .. oe:api:: python

            GetProgress() -> float

      Returns the percentage of the file that has been traversed.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OEMolConversionOptions, MolConversionOptions

.. _OESaiph_OEMolConversionOptions:

.. oe:class:: OEMolConversionOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMolConversionOptions : public OEConversionOptionsBase

   Gives many factors to customize ETL for the :ref:`OEMolFileConverter <OESaiph_OEMolFileConverter>`. SD data
   can be cleared, conformer tests can be turned on, custom generic data can be extracted, and custom Mol Title
   fields are options provided by :ref:`OEMolConversionOptions <OESaiph_OEMolConversionOptions>`.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolConversionOptions()
            OEMolConversionOptions(OEMolConversionOptions &&)
            OEMolConversionOptions(const OEMolConversionOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEMolConversionOptions() -> OEMolConversionOptions
            OEMolConversionOptions(arg2: OEMolConversionOptions) -> OEMolConversionOptions

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolConversionOptions &operator=(OEMolConversionOptions &&)
         OEMolConversionOptions &operator=(const OEMolConversionOptions &)

      Default constructor that initializes :ref:`OEMolConversionOptions <OESaiph_OEMolConversionOptions>`,
      where clearing SD data is set to false and setting conformer tests is set to false.

      Assignment operator.

   .. oe:method:: GetClearMolData

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetClearMolData() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearMolData() -> bool

      Returns a boolean depending on whether the SD data of the :ref:`OERecord <OEDataFlow_OERecord>` will be cleared.

   .. oe:method:: GetConfTest

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetConfTest() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfTest() -> bool

      Returns a boolean depending on whether the conformer tests are set during extraction.

   .. oe:method:: GetGenericDataTags

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetGenericDataTags() const

      .. oe:language:: python

         .. oe:api:: python

            GetGenericDataTags() -> OEStringVector

      Returns a vector of a string of the generic data tags specified to be extracted from the file.

   .. oe:method:: GetMolTitleField

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetMolTitleField() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolTitleField() -> str

      Returns a string of the :ref:`OEField <OEDataFlow_OEField>` name for the Mol Title 
      :ref:`OEField <OEDataFlow_OEField>` that will be added. Only adds an :ref:`OEField <OEDataFlow_OEField>`
      if not left blank. 

   .. oe:method:: HasGenericDataTags

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasGenericDataTags() const

      .. oe:language:: python

         .. oe:api:: python

            HasGenericDataTags() -> bool

      Returns a boolean depending on whether any generic data tags are set.

   .. oe:method:: SetClearMolData

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetClearMolData(bool state)

      .. oe:language:: python

         .. oe:api:: python

            SetClearMolData(state: bool) -> None

      Boolean for clearing the SD data of the file.

   .. oe:method:: SetConfTest

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetConfTest(bool state)

      .. oe:language:: python

         .. oe:api:: python

            SetConfTest(state: bool) -> None

      Boolean for turning on conformer tests upon loading the file.

   .. oe:method:: SetGenericDataTags

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetGenericDataTags(const std::vector<std::string>& tags)

      .. oe:language:: python

         .. oe:api:: python

            SetGenericDataTags(tags: OEStringVector) -> None

      Sets the generic data tags extracted from the file.

   .. oe:method:: SetMolTitleField

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMolTitleField(const std::string fieldName)

      .. oe:language:: python

         .. oe:api:: python

            SetMolTitleField(fieldName: str) -> None

      Sets the name of the Mol Title :ref:`OEField <OEDataFlow_OEField>`. This
      :ref:`OEField <OEDataFlow_OEField>` is only added if the fieldName is not blank.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OEMolFileConverter, MolFileConverter

.. _OESaiph_OEMolFileConverter:

.. oe:class:: OEMolFileConverter

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMolFileConverter

   The :ref:`OEMolFileConverter <OESaiph_OEMolFileConverter>` class extracts data from any
   files that pass the :oe:func:`OEChem::OEIsReadable` check into OERecords. Custom data extraction based on
   :ref:`OEField <OEDataFlow_OEField>` inclusion (SD and generic data) and the addition of conformer
   tests can be set up through the :ref:`OEMolConversionOptions <OESaiph_OEMolConversionOptions>`.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMolFileConverter()
            OEMolFileConverter(const OEMolFileConverter &)

      .. oe:language:: python

         .. oe:api:: python

            OEMolFileConverter() -> OEMolFileConverter
            OEMolFileConverter(arg2: OEMolFileConverter) -> OEMolFileConverter

   .. oe:method:: Open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Open(const std::string& path,
                      const std::string& displayName = std::string()) override
            bool Open(const std::string& path,
                      const OEMolConversionOptions& options,
                      const std::string& displayName = std::string())

      .. oe:language:: python

         .. oe:api:: python

            Open(path: str, displayName: str = str()) -> bool
            Open(path: str, options: OEMolConversionOptions,
                 displayName: str = str()) -> bool

      Returns a boolean based on whether the file can be opened.
      :ref:`OEMolConversionOptions <OESaiph_OEMolConversionOptions>`
      is set at open.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMolFileConverter &operator=(const OEMolFileConverter &)

      Assignment operator.

   .. oe:method:: Close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Close()

      .. oe:language:: python

         .. oe:api:: python

            Close() -> None

      Closes the stream.

   .. oe:method:: GetNextRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNextRecord(OEDataFlow::OEMolRecord& record) override

      .. oe:language:: python

         .. oe:api:: python

            GetNextRecord(record: OEMolRecord) -> int

      Steps through each row of the file adding to the :ref:`OEMolRecord <OEDataFlow_OEMolRecord>`
      passed into the function. The function returns constants based on each pass.
      Return codes: ``SaiphReturnCode::Success``, ``SaiphReturnCode::Fail``, ``SaiphReturnCode::EndOfFile``

   .. oe:method:: GetProgress

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetProgress()

      .. oe:language:: python

         .. oe:api:: python

            GetProgress() -> float

      Returns the percentage of the file that has been traversed.

   .. oe:method:: GetSchemaRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDataFlow::OEMolRecord GetSchemaRecord() const

      .. oe:language:: python

         .. oe:api:: python

            GetSchemaRecord() -> OEMolRecord

      Returns an :ref:`OEMolRecord <OEDataFlow_OEMolRecord>` schema of the :ref:`OERecord <OEDataFlow_OERecord>` produced in each 
      :oe:meth:`OESaiph::OEMolFileConverter::GetNextRecord` iteration. If a schema record was not given to the
      :ref:`OEMolConversionOptions <OESaiph_OEMolConversionOptions>`, one is produced after running
      :oe:meth:`OESaiph::OEMolFileConverter::Open` with a valid file.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OERecordToCSV, RecordToCSV

.. _OESaiph_OERecordToCSV:

.. oe:class:: OERecordToCSV

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OERecordToCSV
      
   Converts an :oe:func:`OEChem::OEIsReadable` file into a CSV file. Modifications such as
   setting the delimiter type, ordering the :ref:`OEField <OEDataFlow_OEField>`, and including
   a molecule title can be set up through the :ref:`OERecordToCSVOptions <OESaiph_OERecordToCSVOptions>`.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERecordToCSV()

      .. oe:language:: python

         .. oe:api:: python

            OERecordToCSV() -> OERecordToCSV

   .. oe:method:: Open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Open(const std::string& path,
                      const OERecordToCSVOptions& opts = OERecordToCSVOptions())

      .. oe:language:: python

         .. oe:api:: python

            Open(path: str,
                 opts: OERecordToCSVOptions = OESaiph_OERecordToCSVOptions()) -> bool

      Returns a boolean based on whether the file can be opened.
      :ref:`OERecordToCSVOptions <OESaiph_OERecordToCSVOptions>`
      is set at open.

   .. oe:method:: Write

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Write(const std::string& path)
            bool Write(OEPlatform::oeostream& ofs)

      .. oe:language:: python

         .. oe:api:: python

            Write(path: str) -> bool
            Write(ofs: oeostream) -> bool

      Writes the CSV to a file path or into a stream.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OERecordToCSVOptions, RecordToCSVOptions

.. _OESaiph_OERecordToCSVOptions:

.. oe:class:: OERecordToCSVOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OERecordToCSVOptions

   Stores the delimiter, the order of the :ref:`OEFields <OEDataFlow_OEField>`, and
   whether a molecule title field is included for the :ref:`OERecordToCSV <OESaiph_OERecordToCSV>`.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OERecordToCSVOptions()
            OERecordToCSVOptions(OERecordToCSVOptions &&)
            OERecordToCSVOptions(const OERecordToCSVOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OERecordToCSVOptions() -> OERecordToCSVOptions
            OERecordToCSVOptions(arg2: OERecordToCSVOptions) -> OERecordToCSVOptions

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERecordToCSVOptions &operator=(const OERecordToCSVOptions &)

      Assignment operator.

   .. oe:method:: GetDelimiter

      .. oe:language:: c++ java csharp

         .. oe:api::

            char GetDelimiter() const

      .. oe:language:: python

         .. oe:api:: python

            GetDelimiter() -> str

      Returns the delimiter set for the CSV file.

   .. oe:method:: GetIncludeMolTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetIncludeMolTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetIncludeMolTitle() -> bool

      Returns a boolean based on whether a molecule title field will be added.

   .. oe:method:: GetOrderedFields

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetOrderedFields() const

      .. oe:language:: python

         .. oe:api:: python

            GetOrderedFields() -> OEStringVector

      Returns a vector of strings for how the :ref:`OEField <OEDataFlow_OEField>` are ordered.

   .. oe:method:: SetDelimiter

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDelimiter(char delimiter)

      .. oe:language:: python

         .. oe:api:: python

            SetDelimiter(delimiter: str) -> None

      Sets the delimiter for the CSV file.

   .. oe:method:: SetIncludeMolTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetIncludeMolTitle(bool state)

      .. oe:language:: python

         .. oe:api:: python

            SetIncludeMolTitle(state: bool) -> None

      Boolean for adding a Mol Title :ref:`OEField <OEDataFlow_OEField>` to the CSV.

   .. oe:method:: SetOrderedFields

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetOrderedFields(const std::vector<std::string>& orderedFields)

      .. oe:language:: python

         .. oe:api:: python

            SetOrderedFields(orderedFields: OEStringVector) -> None

      Sets the :ref:`OEField <OEDataFlow_OEField>` order of the CSV file.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OEShapeQueryConverter, OEShapeQueryConverter

.. _OESaiph_OEShapeQueryConverter:

.. oe:class:: OEShapeQueryConverter

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEShapeQueryConverter
      
   The :ref:`OEShapeQueryConverter <OESaiph_OEShapeQueryConverter>` class extracts the
   :ref:`OEShapeQuery <OEShape_OEShapeQuery>` from SQ files into :ref:`OERecord <OEDataFlow_OERecord>`.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEShapeQueryConverter()
            OEShapeQueryConverter(const OEShapeQueryConverter &)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryConverter() -> OEShapeQueryConverter
            OEShapeQueryConverter(arg2: OEShapeQueryConverter) -> OEShapeQueryConverter

   .. oe:method:: Open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Open(const std::string& path,
                      const std::string& displayName = std::string())

      .. oe:language:: python

         .. oe:api:: python

            Open(path: str, displayName: str = str()) -> bool

      Returns a boolean based on whether the file can be opened.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEShapeQueryConverter &operator=(const OEShapeQueryConverter &)

      Assignment operator.

   .. oe:method:: Close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Close()

      .. oe:language:: python

         .. oe:api:: python

            Close() -> None

      Closes the stream.

   .. oe:method:: GetNextRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNextRecord(OEDataFlow::OEMolRecord& record) override

      .. oe:language:: python

         .. oe:api:: python

            GetNextRecord(record: OEMolRecord) -> int

      Steps through each row of the file adding to the :ref:`OEMolRecord <OEDataFlow_OEMolRecord>`
      passed into the function. The function returns constants based on each pass.
      Return codes: ``SaiphReturnCode::Success``, ``SaiphReturnCode::Fail``, ``SaiphReturnCode::EndOfFile``

   .. oe:method:: GetProgress

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetProgress()

      .. oe:language:: python

         .. oe:api:: python

            GetProgress() -> float

      Returns the percentage of the file that has been traversed.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OESmilesFileConverter, SmilesFileConverter

.. _OESaiph_OESmilesFileConverter:

.. oe:class:: OESmilesFileConverter

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OESmilesFileConverter

   The :ref:`OESmilesFileConverter <OESaiph_OESmilesFileConverter>` class extracts data from SMI, ISM, CAN, CXSMILES, and
   USM files into :ref:`OERecord <OEDataFlow_OERecord>`. With the addition of an :ref:`OEMolConversionOptions <OESaiph_OEMolConversionOptions>`,
   a SMILES :ref:`OEField <OEDataFlow_OEField>` and a molecule title :ref:`OEField <OEDataFlow_OEField>` can be added to the
   :ref:`OERecord <OEDataFlow_OERecord>`.
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESmilesFileConverter()
            OESmilesFileConverter(const OESmilesFileConverter &)

      .. oe:language:: python

         .. oe:api:: python

            OESmilesFileConverter() -> OESmilesFileConverter
            OESmilesFileConverter(arg2: OESmilesFileConverter) -> OESmilesFileConverter

   .. oe:method:: Open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Open(const std::string& path,
                      const std::string& displayName = std::string()) override
            bool Open(const std::string& path,
                      const OEMolConversionOptions& options,
                      const std::string& displayName = std::string())

      .. oe:language:: python

         .. oe:api:: python

            Open(path: str, displayName: str = str()) -> bool
            Open(path: str, options: OEMolConversionOptions,
                 displayName: str = str()) -> bool

      Returns a boolean based on whether the file can be opened.
      :ref:`OEMolConversionOptions <OESaiph_OEMolConversionOptions>`
      is set at open.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESmilesFileConverter &operator=(const OESmilesFileConverter &)

      Assignment operator.

   .. oe:method:: Close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Close()

      .. oe:language:: python

         .. oe:api:: python

            Close() -> None

      Closes the stream.

   .. oe:method:: GetNextRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNextRecord(OEDataFlow::OEMolRecord& record) override

      .. oe:language:: python

         .. oe:api:: python

            GetNextRecord(record: OEMolRecord) -> int

      Steps through each row of the file adding to the :ref:`OEMolRecord <OEDataFlow_OEMolRecord>`
      passed into the function. The function returns constants based on each pass.
      Return codes: ``SaiphReturnCode::Success``, ``SaiphReturnCode::Fail``, ``SaiphReturnCode::EndOfFile``

   .. oe:method:: GetProgress

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetProgress()

      .. oe:language:: python

         .. oe:api:: python

            GetProgress() -> float

      Returns the percentage of the file that has been traversed.


.. _OESaiphClasses:

****************************
Preliminary OESaiph Classes
****************************

.. oe:namespace:: OESaiph

.. toctree::
   :maxdepth: 1

   OEMolFileConverter
   OEMolConversionOptions
   OESmilesFileConverter
   OECSVFileConverter
   OECSVConversionOptions
   OEDBFileConverter
   OEDUFileConverter
   OERecordToCSV
   OERecordToCSVOptions
   OEShapeQueryConverter
   OEConversionOptionsBase
   ArchiveConverter


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: GetConverter

.. oe:function:: GetConverter

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::shared_ptr<OEConverterBase>
         std::shared_ptr<OEConverterBase> GetConverter(const std::string& filename,
                                                       const std::string& displayName = std::string())

   .. oe:language:: python

      .. oe:api:: python

         GetConverter(filename: str, displayName: str = str()) -> OESaiph_OEConverterBase

   This function returns the best-suited converter to the file type given.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OEMolToRecord

.. oe:function:: OEMolToRecord

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         OEDataFlow::OERecord OEMolToRecord(const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEMolToRecord(mol: Union[OEGraphMol,OEMol,OEQMol]) -> OERecord

   Returns an :ref:`OERecord <OEDataFlow_OERecord>` object from an :ref:`OEMolBase <OEChem_OEMolBase>`
   object (mol). Other data in the :ref:`OEMolBase <OEChem_OEMolBase>` will be set as
   :ref:`OEField <OEDataFlow_OEField>` in the :ref:`OERecord <OEDataFlow_OERecord>`. This includes
   :ref:`OEScalarGrid <OESystem_OEScalarGrid>`, :ref:`OESkewGrid <OESystem_OESkewGrid>`,
   :ref:`OESurface <OESpicoli_OESurface>`, :ref:`OEDesignUnit <OEBio_OEDesignUnit>`,
   other :ref:`OEMol <OEChem_OEMol>`, :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`,
   :ref:`OEShapeQuery <OEShape_OEShapeQuery>`, OEBoL, and so on.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OERecordToDesignUnit

.. oe:function:: OERecordToDesignUnit

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OERecordToDesignUnit(OEDataFlow::OERecord& rec,
                                   OEBio::OEDesignUnit& du)

   .. oe:language:: python

      .. oe:api:: python

         OERecordToDesignUnit(rec: OERecord, du: OEDesignUnit) -> None

   Takes an existing :ref:`OERecord <OEDataFlow_OERecord>` object (rec) and generates
   a new :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object (DU) if an
   :ref:`OEDesignUnit <OEBio_OEDesignUnit>` :ref:`OEField <OEDataFlow_OEField>`
   is found in the :ref:`OERecord <OEDataFlow_OERecord>`.

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: OERecordToMol

.. oe:function:: OERecordToMol

   .. attention::

      |PRELIMINARY-API|

   .. oe:language:: c++ java csharp

      .. oe:api::

         void OERecordToMol(OEDataFlow::OERecord& rec, OEChem::OEMolBase& mol,
                            bool strict = false, bool fallback = false)

   .. oe:language:: python

      .. oe:api:: python

         OERecordToMol(rec: OERecord, mol: Union[OEGraphMol,OEMol,OEQMol],
                       strict: bool = False, fallback: bool = False) -> None

   Takes an existing :ref:`OERecord <OEDataFlow_OERecord>` object (rec) and generates a new
   :ref:`OEMolBase <OEChem_OEMolBase>` object (mol) with the data provided in the
   :ref:`OERecord <OEDataFlow_OERecord>` as data set to the OEMolBase. If `strict`
   is set to true, then an error will be thrown instead of a warning when data
   cannot be set to the :ref:`OEMolBase <OEChem_OEMolBase>`. When `fallback` is set true,
   the function will check the :ref:`OERecord <OEDataFlow_OERecord>` for any
   :ref:`OEMol <OEChem_OEMol>` object if no specific :ref:`OEMol <OEChem_OEMol>` 
   :ref:`OEField <OEDataFlow_OEField>` named *Molecule* is found.


.. oe:namespace:: OESaiph

.. meta::
   :keywords: OESaiphGetArch

.. _OESaiph_OESaiphGetArch:

.. oe:function:: OESaiphGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESaiphGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OESaiphGetArch() -> str

   This function returns the architecture of the current version of Saiph
   TK. Examples include:

   * microsoft-win32-x86

   * redhat-RHEL9-x86_64


.. oe:namespace:: OESaiph

.. meta::
   :keywords: OEShapeGetLicensee

.. _OESaiph_OESaiphGetLicensee:

.. oe:function:: OESaiphGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OESaiphGetLicensee()
         bool OESaiphGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OESaiphGetLicensee() -> str
         OESaiphGetLicensee(licensee: str) -> bool

   This function returns the LICENSEE from the current valid Saiph TK license.


.. oe:namespace:: OESaiph

.. meta::
   :keywords: OESaiphGetPlatform

.. _OESaiph_OESaiphGetPlatform:

.. oe:function:: OESaiphGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESaiphGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OESaiphGetPlatform() -> str

   This function returns the platform, including compiler version, of the current
   version of Saiph TK. Examples include:

   * microsoft-win32-msvc9-MD-x86

   * redhat-RHEL9-g++11.11-x86_64


.. oe:namespace:: OESaiph

.. meta::
   :keywords: OESaiphGetRelease

.. _OESaiph_OESaiphGetRelease:

.. oe:function:: OESaiphGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESaiphGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OESaiphGetRelease() -> str

   This function returns the version of this toolkit release. For example: ``1.0.0``.


.. oe:namespace:: OESaiph

.. meta::
   :keywords: OESaiphGetSite

.. _OESaiph_OESaiphGetSite:

.. oe:function:: OESaiphGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OESaiphGetSite()
         bool OESaiphGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OESaiphGetSite() -> str
         OESaiphGetSite(site: str) -> bool

   This function returns the SITE from the current valid Saiph TK license.


.. oe:namespace:: OESaiph

.. meta::
   :keywords: OESaiphGetVersion

.. _OESaiph_OESaiphGetVersion:

.. oe:function:: OESaiphGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OESaiphGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OESaiphGetVersion() -> int

   This function returns the build date of the toolkit as an unsigned int. For example: ``20240227``.


.. oe:namespace:: OESaiph

.. meta::
   :keywords: OESaiphIsLicensed

.. _OESaiph_OESaiphIsLicensed:

.. oe:function:: OESaiphIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESaiphIsLicensed(const char* feature = 0,
                                unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OESaiphIsLicensed(feature: str = None, expdate: int = None) -> bool

   This function determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **Saiph TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **Saiph TK** along with the following features: 'python'.
   Pass ``nullptr`` (or ``0``) to check the default **Saiph TK** feature.

   The 'expdate' argument can be used to obtain the expiration date of
   the current **Saiph TK** license. If non-null, the expiration date
   is written as a ``YYYYMMDD`` integer. Pass ``nullptr`` to ignore.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function


.. _OESaiphFunctions:

******************************
Preliminary OESaiph Functions
******************************

.. oe:namespace:: OESaiph

.. toctree::
   :maxdepth: 1

   GetConverter
   OEMolToRecord
   OERecordToDesignUnit
   OERecordToMol
   OESaiphGetArch
   OESaiphGetLicensee
   OESaiphGetPlatform
   OESaiphGetRelease
   OESaiphGetSite
   OESaiphGetVersion
   OESaiphIsLicensed
   read_record_file_to_dataframe


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESaiph

.. meta::
   :keywords: read_record_file_to_dataframe

.. oe:function:: read_record_file_to_dataframe

   .. attention::

      |PRELIMINARY-API|
      |PYTHONONLY|

   .. oe:api::

      def read_record_file_to_dataframe(path: str, serializable: bool = False,
                                        pandasCheck: bool = True) -> Union["Series", "DataFrame"]

   Creates a pandas DataFrame from any file that passes the :oe:func:`OEChem::OEIsReadable` check.
   The user is required to have pandas installed in their Python environment. If `serializable` is
   set true, then the DataFrame will contain all non-POD types as bytes.


.. _oesaiph_part_api:

********************************
Preliminary OESaiph API
********************************

.. toctree::
   :maxdepth: 2

   OESaiphClasses/index
   OESaiphFunctions/index


.. _saiph_part_examples:

******************************
Examples
******************************

.. toctree::
   :maxdepth: 3

   saiph_examples


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!


.. saiphtk toolkit documentation master file

.. _saiph-toolkit-intro:

#############################
Saiph Toolkit
#############################

.. attention::
   |TWOLANGUAGE|

Saiph TK provides the functionalities to easily  extract, transfer, and load (ETL) files. It
has six file-converting classes: :ref:`OEMolFileConverter <OESaiph_OEMolFileConverter>`,
:ref:`OESmilesFileConverter <OESaiph_OESmilesFileConverter>`,
:ref:`OECSVFileConverter <OESaiph_OECSVFileConverter>`,
:ref:`OEDUFileConverter <OESaiph_OEDUFileConverter>`,
:ref:`OEShapeQueryConverter <OESaiph_OEShapeQueryConverter>`,
and :ref:`OERecordToCSV <OESaiph_OERecordToCSV>`.
:ref:`OEMolFileConverter <OESaiph_OEMolFileConverter>` can be utilized on any
file that passes the :oe:func:`OEChem::OEIsReadable` check.
:ref:`OESmilesFileConverter <OESaiph_OESmilesFileConverter>` can be utilized on
SMI, ISM, CAN, CXSMILES, and USM files. The other converters are specific to their
file type. The Python version of the toolkit provides an :ref:`ArchiveConverter <OESaiph_ArchiveConverter>`,
which is an iterator class that converts tarball or zip files into :ref:`OERecord <OEDataFlow_OERecord>`
by returning the best-suited converter iterator for each file in the compressed file.

:ref:`OEMolFileConverter <OESaiph_OEMolFileConverter>` and
:ref:`OESmilesFileConverter <OESaiph_OESmilesFileConverter>` both
take in :ref:`OEMolConversionOptions <OESaiph_OEMolConversionOptions>`,
which provides options to clear SDData, set conformer tests, and set and get generic
data, as well as allowing the user to set a Mol Title Column.
:ref:`OECSVFileConverter <OESaiph_OECSVFileConverter>` takes in
:ref:`OECSVConversionOptions <OESaiph_OECSVConversionOptions>` for setting the delimiter.
The main five converters utilize Open() and GetNextRecord() methods to traverse through a file.
Open() is where the file name and converter options can be set. GetNextRecord() populates an
:ref:`OEMolRecord <OEDataFlow_OEMolRecord>` while stepping through the data of the file.
This function returns Saiph return codes: ``SaiphReturnCode::Success``, ``SaiphReturnCode::Fail``, and
``SaiphReturnCode::EndOfFile``.

:ref:`OERecordToCSV <OESaiph_OERecordToCSV>` directly converts a file into a CSV file.
It has :ref:`OERecordToCSVOptions <OESaiph_OERecordToCSVOptions>` for setting the delimiter.

Saiph TK also provides functions like :oe:func:`OESaiph::GetConverter`, :oe:func:`OESaiph::OEMolToRecord`,
:oe:func:`OESaiph::OERecordToMol`, and :oe:func:`OESaiph::OERecordToDesignUnit`. :oe:func:`OESaiph::GetConverter`
returns the best converter for the file, and the other functions convert between :ref:`OERecord <OEDataFlow_OERecord>`
and the respective class type. On the Python side, :oe:func:`OESaiph::read_record_file_to_dataframe` give the utility
of creating a Pandas DataFrame from any file that passes the :oe:func:`OEChem::OEIsReadable` check. The user is required
to have Pandas installed in their Python environment.

.. toctree::
   :maxdepth: 3

   examples
   api
   releasenotes/index


.. _oesaiph_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version1_0_1
   version1_0_0




Saiph TK 1.0.0
================================================================================

This is the first release of **Saiph TK** in C++ and Python.

New Features
--------------------------------------------------------------------------------
*  :ref:`OEMolFileConverter <OESaiph_OEMolFileConverter>`, :ref:`OESmilesFileConverter <OESaiph_OESmilesFileConverter>`, :ref:`OECSVFileConverter <OESaiph_OECSVFileConverter>`,
   :ref:`OEDUFileConverter <OESaiph_OEDUFileConverter>`, :ref:`OEShapeQueryConverter <OESaiph_OEShapeQueryConverter>`, :ref:`OERecordToCSV <OESaiph_OERecordToCSV>`, and
   :ref:`ArchiveConverter <OESaiph_ArchiveConverter>` were added to enhance efficient ETL with the OpenEye toolkits.
*  :ref:`OEMolConversionOptions <OESaiph_OEMolConversionOptions>` and :ref:`OECSVConversionOptions <OESaiph_OECSVConversionOptions>` are classes added to utilize
   :ref:`OEMolFileConverter <OESaiph_OEMolFileConverter>`, :ref:`OESmilesFileConverter <OESaiph_OESmilesFileConverter>`, and :ref:`OECSVFileConverter <OESaiph_OECSVFileConverter>`
   to help manage the ETL process.
*  The function :oe:func:`OESaiph::GetConverter` returns the converter best suited for a file type.
*  The function :oe:func:`OESaiph::OEMolToRecord` converts an :ref:`OEMolBase <OEChem_OEMolBase>` to an :ref:`OERecord <OEDataFlow_OERecord>`.
*  The function :oe:func:`OESaiph::OERecordToMol` converts an  :ref:`OERecord <OEDataFlow_OERecord>` to an :ref:`OEMolBase <OEChem_OEMolBase>`.
*  The function :oe:func:`OESaiph::OERecordToDesignUnit` converts an :ref:`OERecord <OEDataFlow_OERecord>` to an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.
*  The function :oe:func:`OESaiph::read_record_file_to_dataframe` converts any file that passes the :oe:func:`OEChem::OEIsReadable` check into a pandas DataFrame (User must have pandas installed).



Saiph TK 1.0.1
================================================================================

Python-Specific Changes
--------------------------------------------------------------------------------

* The following APIs are now properly wrapped in Python:

  * :ref:`OESaiphGetArch<OESaiph_OESaiphGetArch>`
  * :ref:`OESaiphGetLicensee<OESaiph_OESaiphGetLicensee>`
  * :ref:`OESaiphGetPlatform<OESaiph_OESaiphGetPlatform>`
  * :ref:`OESaiphGetRelease<OESaiph_OESaiphGetRelease>`
  * :ref:`OESaiphGetSite<OESaiph_OESaiphGetSite>`
  * :ref:`OESaiphGetVersion<OESaiph_OESaiphGetVersion>`
  * :ref:`OESaiphIsLicensed<OESaiph_OESaiphIsLicensed>`



.. _chapter_saiph_examples:

Traversing File with an OEMolFileConverter 
===========================================

This is an example of a :ref:`OEMolFileConverter <OESaiph_OEMolFileConverter>` creating a vector of an :ref:`OERecord <OEDataFlow_OERecord>`
from a string file input. 

..  oe:language:: c++

    .. oe:source:: basicFileTraversal.cpp
       :language: c++
       :caption:  Simple file traversal
       :refnum:   1

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`basicFileTraversal.cpp <../../../../sublibs/tklibs/saiph/examples/basicFileTraversal.cpp>`

..  oe:language:: python

    .. oe:source:: basicFileTraversal.py
       :language: python
       :caption: Simple file traversal
       :refnum: 1

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`basicFileTraversal.py <../../../../wrappers/python/examples/saiph/basicFileTraversal.py>`

Set Schema Record to Shape OERecord Extraction
==============================================

This example sets an :ref:`OERecord <OEDataFlow_OERecord>` as the schema to the :ref:`OEMolConversionOptions <OESaiph_OEMolConversionOptions>`,
giving the :ref:`OEMolFileConverter <OESaiph_OEMolFileConverter>` specific :ref:`OEField <OEDataFlow_OEField>` to extract from the file given. 

..  oe:language:: c++

    .. oe:source:: customSchemaETL.cpp
       :language: c++
       :caption:  Sets Schema Record for ETL
       :refnum:   1

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`customSchemaETL.cpp <../../../../sublibs/tklibs/saiph/examples/customSchemaETL.cpp>`

..  oe:language:: python

    .. oe:source:: customSchemaETL.py
       :language: python
       :caption: Sets Schema Record for ETL
       :refnum: 2

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`customSchemaETL.py <../../../../wrappers/python/examples/saiph/customSchemaETL.py>`

OERecord to OEMol 
=================

This example creates an :ref:`OEMol <OEChem_OEMol>` from the first :ref:`OERecord <OEDataFlow_OERecord>` produced by the input file. 

..  oe:language:: c++

    .. oe:source:: record2mol.cpp
       :language: c++
       :caption:  First OERecord to OEMol
       :refnum:   1

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`record2mol.cpp <../../../../sublibs/tklibs/saiph/examples/record2mol.cpp>`

..  oe:language:: python

    .. oe:source:: record2mol.py
       :language: python
       :caption: First OERecord to OEMol
       :refnum: 3

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`record2mol.py <../../../../wrappers/python/examples/saiph/record2mol.py>`

OEMol to OERecord 
=================

This example creates an :ref:`OERecord <OEDataFlow_OERecord>` from the :ref:`OEMol <OEChem_OEMol>` found in the input file. 

..  oe:language:: c++

    .. oe:source:: mol2record.cpp
       :language: c++
       :caption:  OEMol to OERecord
       :refnum:   1

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`mol2record.cpp <../../../../sublibs/tklibs/saiph/examples/mol2record.cpp>`

..  oe:language:: python

    .. oe:source:: mol2record.py
       :language: python
       :caption: OEMol to OERecord
       :refnum: 4

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`mol2record.py <../../../../wrappers/python/examples/saiph/mol2record.py>`

OERecord to OEDesignUnit 
========================

This example creates an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` from an :ref:`OERecord <OEDataFlow_OERecord>`.

..  oe:language:: c++

    .. oe:source:: record2designunit.cpp
       :language: c++
       :caption:  Sets Schema Record for ETL
       :refnum:   1

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`record2designunit.cpp <../../../../sublibs/tklibs/saiph/examples/record2designunit.cpp>`

..  oe:language:: python

    .. oe:source:: record2designunit.py
       :language: python
       :caption: Sets Schema Record for ETL
       :refnum: 5

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`record2designunit.py <../../../../wrappers/python/examples/saiph/record2designunit.py>`

File Records to Pandas DataFrame 
================================

This example takes in a file and creates a pandas DataFrame from the :ref:`OERecord <OEDataFlow_OERecord>`
produced. The user must have pandas installed in their Python environment to gain access to this function.

..  oe:language:: python

    .. oe:source:: recordToPandasDataFrame.py
       :language: python
       :caption: Creates a DataFrame from File
       :refnum: 6

    ..  only:: oehtml

        .. admonition:: Download code

         :download:`recordToPandasDataFrame.py <../../../../wrappers/python/examples/saiph/recordToPandasDataFrame.py>`



:orphan:

###############################################
Appendix: Selected Examples in Python
###############################################

These are full listings of programming examples that are excerpted or offered for download, elsewhere in this book.

.. touch examples to start TC

***********************
Depict Toolkit
***********************

These examples illustrate use of the Depict tools to create molecule depictions in a variety of graphical file formats.
See :ref:`a guide to available examples in the Depict chapter <oedepict_part_examples>`.

..  _listing-AccessAtomDisplay.py:

.. oe:source:: AccessAtomDisplay.py
   :language: python
   :refnum:   1
   :caption:  Example of access atom display.

..  _listing-AccessBondDisplay.py:

..  oe:source:: AccessBondDisplay.py
    :language: python
    :refnum:   2
    :caption:  Example of access bond display.

..  _listing-DepictMDLQuery.py:

.. oe:source:: DepictMDLQuery.py
   :language: python
   :refnum:   3
   :caption:  Example of MDL query depiction.

..  _listing-DepictMDLReaction.py:

..	oe:source:: DepictMDLReaction.py
    :language: python
    :refnum:   4
    :caption:  Example of reaction depiction.

..  _listing-DepictMDLReactionMapIdx.py:

.. oe:source:: DepictMDLReactionMapIdx.py
   :language: python
   :refnum:   5
   :caption:  Example of reaction depiction with map indices.

..	_listing-DrawLine.py:

..  oe:source:: DrawLine.py
    :language: python
    :refnum:   6
    :caption:  Example of line drawing.

..	_listing-DrawObjects.py:

..  oe:source:: DrawObjects.py
    :language: python
    :refnum:   7
    :caption:  Example of object drawing.

..	_listing-HighlightSimple.py:

.. oe:source:: HighlightSimple.py
   :language: python
   :refnum:   8
   :caption:  Example of using highlighting class.

..	_listing-HighlightStyle.py:

.. oe:source:: HighlightStyle.py
   :language: python
   :refnum:   9
   :caption:  Example of using highlighting classes that correspond to the highlighting styles.

..	_listing-HighlightMulti.py:

.. oe:source:: HighlightMulti.py
   :language: python
   :refnum:   10
   :caption:  Example of highlighting multiple matches one by one.

..	_listing-depict.py:

.. oe:source:: depict.py
   :language: python
   :refnum:   11
   :caption:  Generating 2D coordinates.

..	_listing-match2img.py:

.. oe:source:: match2img.py
   :language: python
   :refnum:   12
   :caption:  Depicting substructure search match.

..	_listing-mcsalign2D.py:

.. oe:source:: mcsalign2D.py
   :language: python
   :refnum:   13
   :caption:  Aligning Molecule Based on MCS.

..	_listing-mdlquery2img.py:

.. oe:source:: mdlquery2img.py
   :language: python
   :refnum:   14
   :caption:  Depicting MDL query.

..	_listing-mdlreaction2img.py:

.. oe:source:: mdlreaction2img.py
   :language: python
   :refnum:   15
   :caption:  Converting an MDL reaction into an image file.

..	_listing-mol2img.py:

.. oe:source:: mol2img.py
   :language: python
   :refnum:   16
   :caption:  Converting a single molecule into an image file.

..	_listing-mols2img.py:

.. oe:source:: mols2img.py
   :language: python
   :refnum:   17
   :caption:  Depicting molecules in a grid.

..	_listing-mols2pdf.py:

.. oe:source:: mols2pdf.py
   :language: python
   :refnum:   18
   :caption:  Convert molecular structures into a multipage :file:`PDF` image.

..	_listing-ringdict2pdf.py:

.. oe:source:: ringdict2pdf.py
   :language: python
   :refnum:   19
   :caption:  Generate a multipage PDF report of the 2D ring dictionary.

..	_listing-smartsalign2D.py:

.. oe:source:: smartsalign2D.py
   :language: python
   :refnum:   20
   :caption:  Aligning molecules based on substructure search.

..	_listing-viewmdlsearch.py:

.. oe:source:: viewmdlsearch.py
   :language: python
   :refnum:   21
   :caption:  Depicting MDL query substructure search hits.

***********************
Docking Toolkit
***********************

Docking examples illustrate use of the Docking tools for docking and
scoring molecules in the context of a protein active site.  See :ref:`the list in the Docking chapter <oedocking_part_examples>`
for the set of examples.

..	_listing-ReceptorIO.py:

..  oe:source:: ReceptorIO.py
    :language: python
    :caption: Using the string I/O functions.
    :refnum: 1

***********************
FastROCS Toolkit
***********************

FastROCS examples illustrate use of the FastROCS Toolkit to make extremely fast shape comparisons. See a
:ref:`full list of examples in the FastROCs chapter <fastrocs_part_examples>`.

..	_listing-CustomColorForceField_Snippet.py:

..  oe:source:: CustomColorForceField_Snippet.py
    :language:  python
    :refnum: 1
    :caption: Full listing of CustomColorForceField.py.

..	_listing-OEShapeDatabaseOptions_SetUserStarts.py:

..  oe:source:: OEShapeDatabaseOptions_SetUserStarts.py
    :language:  python
    :refnum: 2
    :caption: Full listing of OEShapeDatabaseOptions_SetUserStarts.py.

..	_listing-Tutorial1_InertialAtHeavyAtoms_Snippet.py:

..  oe:source:: Tutorial1_InertialAtHeavyAtoms_Snippet.py
    :language:  python
    :refnum: 3
    :caption: Full listing of Tutorial1_InertialAtHeavyAtoms_Snippet.py

..	_listing-ShapeDatabaseClientHistogram.py:

..  oe:source:: ShapeDatabaseClientHistogram.py
    :language:  python
    :refnum: 4
    :caption: Shape Database Client Histogram.

..	_listing-AsIsStartsExample.py:

..  oe:source:: AsIsStartsExample.py
    :language:  python
    :refnum: 6
    :caption: AsIs starts.

..	_listing-BestShapeOverlay.py:

..  oe:source:: BestShapeOverlay.py
    :language:  python
    :refnum: 7
    :caption: Database searching with queries.

..	_listing-BestShapeOverlayMultiConfQuery.py:

..  oe:source:: BestShapeOverlayMultiConfQuery.py
    :language:  python
    :refnum: 8
    :caption: Database searching with every conformer of every query.

..	_listing-BestTverskyShapeOverlay.py:

..  oe:source:: BestTverskyShapeOverlay.py
    :language:  python
    :refnum: 9
    :caption: Database searching with queries using Tversky similarity scoring.

..	_listing-ColorOptimizationExample.py:

..  oe:source:: ColorOptimizationExample.py
    :language:  python
    :refnum: 10
    :caption: Optimize over color overlap in addition to shape overlap.

..	_listing-CustomColorFFPrep.py:

..  oe:source:: CustomColorFFPrep.py
    :language:  python
    :refnum: 11
    :caption: Cache custom color atoms onto molecules.

..	_listing-ImplicitMillsDeanNoRingsExample.py:

..  oe:source:: ImplicitMillsDeanNoRingsExample.py
    :language:  python
    :refnum: 12
    :caption: Run FastROCS with the implicit Mills-Dean color force field, sans rings.

..	_listing-InertialAtHeavyAtomStartsExample.py:

..  oe:source:: InertialAtHeavyAtomStartsExample.py
    :language:  python
    :refnum: 13
    :caption: Database searching with queries using the inertial at heavy atoms starting orientation.

..	_listing-ROCSModeExample.py:

..  oe:source:: ROCSModeExample.py
    :language:  python
    :refnum: 14
    :caption: Turn on ROCS mode.

..	_listing-SphereExclusionClustering.py:

..  oe:source:: SphereExclusionClustering.py
    :language:  python
    :refnum: 15
    :caption: Cluster database into shape clusters.

..	_listing-ShapeDatabaseChunker.py:

..  oe:source:: ShapeDatabaseChunker.py
    :language:  python
    :refnum: 16
    :caption: Split database into chunks.

..	_listing-ShapeDatabaseClient.py:

..  oe:source:: ShapeDatabaseClient.py
    :language:  python
    :refnum: 17
    :caption: Send query to specified server.

..	_listing-ShapeDatabaseServer.py:

..  oe:source:: ShapeDatabaseServer.py
    :language:  python
    :refnum: 18
    :caption: Run the FastROCS server.

..	_listing-ShapeDatabaseIsLoaded.py:

..  oe:source:: ShapeDatabaseIsLoaded.py
    :language:  python
    :refnum: 19
    :caption: Returns whether the database has completed loading in server:port.

..	_listing-ShapeDatabaseOEThrowSetLevel.py:

..  oe:source:: ShapeDatabaseOEThrowSetLevel.py
    :language:  python
    :refnum: 20
    :caption: Adjust the verbosity of server running on server:port.

..	_listing-ShapeDatabasePrep.py:

..  oe:source:: ShapeDatabasePrep.py
    :language:  python
    :refnum: 21
    :caption: Prepare OEB file for faster load performance.

..	_listing-ShapeDatabaseProxy.py:

..  oe:source:: ShapeDatabaseProxy.py
    :language:  python
    :refnum: 22
    :caption: Tie multiple servers to appear as a single server.

..	_listing-ShapeDistanceMatrix.py:

..  oe:source:: ShapeDistanceMatrix.py
    :language:  python
    :refnum: 23
    :caption: Calculate distance between all molecules in database with themselves.

..	_listing-UserInertialStartsExample.py:

..  oe:source:: UserInertialStartsExample.py
    :language:  python
    :refnum: 24
    :caption: Database searching with queries using the user inertial starts orientation.

************************
Grapheme Toolkit
************************

The Grapheme examples illustrate
visualization of complex molecular interactions and properties in a clear
and coherent 2D format that is the most natural to chemists.
See :ref:`a full list of exaxmples in the Grapheme chapter. <oegrapheme_part_examples>`

..	_listing-ActiveSiteHighlight.py:

..  oe:source:: ActiveSiteHighlight.py
    :language: python
    :refnum:   1
    :caption: Full listing of ActiveSiteHighlight.py.

..	_listing-AnnotateAtomPredicate.py:

.. oe:source:: AnnotateAtomPredicate.py
   :language: python
   :refnum:   2
   :caption:  Example of using a built-in atom annotation style

..	_listing-AnnotateBondPredicate.py:

.. oe:source:: AnnotateBondPredicate.py
   :language: python
   :refnum:   3
   :caption:  Example of using a built-in bond annotation style

..	_listing-AnnotatePartialCharge.py:

.. oe:source:: AnnotatePartialCharge.py
   :language: python
   :refnum:   4
   :caption:  Example of user-defined annotation

..	_listing-bfactor2img.py:

..  oe:source:: bfactor2img.py
    :language: python
    :refnum:   5
    :caption: Full listing of bfactor2img.py.

..	_listing-complex2img.py:

..  oe:source:: complex2img.py
    :language: python
    :refnum:   6
    :caption: Full listing of complex2img.py.

..	_listing-Draw2DPropMapPartialCharge.py:

.. oe:source:: Draw2DPropMapPartialCharge.py
   :language: python
   :refnum:   7
   :caption:  Depicting partial charges using property map

..	_listing-Draw2DSurfaceUserDefined.py:

.. oe:source:: Draw2DSurfaceUserDefined.py
   :language: python
   :refnum:   8
   :caption:  Example of user-defined surface drawing

..	_listing-Draw2DSurfaceVariousRadii.py:

.. oe:source:: Draw2DSurfaceVariousRadii.py
   :language: python
   :refnum:   9
   :caption:  Example of drawing 2D surface with various radii

..	_listing-DrawActiveSiteLegend.py:

..  oe:source:: DrawActiveSiteLegend.py
    :language: python
    :refnum:   10
    :caption: Full listing of DrawActiveSiteLegend.py.

..	_listing-DrawColorForceFieldLegend.py:

..  oe:source:: DrawColorForceFieldLegend.py
    :language: python
    :refnum:   11
    :caption: Full listing of DrawColorForceFieldLegend.py.

..	_listing-DrawColorGradient.py:

..  oe:source:: DrawColorGradient.py
    :language: python
    :refnum:   12
    :caption: Full listing of DrawColorGradient.py.

..	_listing-DrawComplexSurface.py:

.. oe:source:: DrawComplexSurface.py
   :language: python
   :refnum:   13
   :caption:  Example of complex surface drawing

..	_listing-DrawComplexSurfaceUserDef.py:

.. oe:source:: DrawComplexSurfaceUserDef.py
   :language: python
   :noindent:
   :refnum:   14

..  _listing-DrawIridiumData.py:

..  oe:source:: DrawIridiumData.py
    :language: python
    :caption: Full listing of DrawIridium.py.
    :refnum:   15

..	_listing-DrawMultiple2DSurfaces.py:

.. oe:source:: DrawMultiple2DSurfaces.py
   :language: python
   :refnum:   16
   :caption:  Example of drawing multiple 2D surfaces

..	_listing-DrawPeptide.py:

..  oe:source:: DrawPeptide.py
    :language: python
    :refnum:   17
    :caption: Full listing of DrawPeptide.py.      :noindent:

..	_listing-DrawResidues.py:

..  oe:source:: DrawResidues.py
    :language: python
    :refnum:   18
    :caption: Full listing of DrawResidues.py.      :noindent:

..	_listing-DrawROCSScores.py:

..  oe:source:: DrawROCSScores.py
    :language: python
    :refnum:   19
    :caption: Full listing of DrawROCSScores.py.      :noindent:

..	_listing-OE2DPropMap_SetProperties.py:

..  oe:source:: OE2DPropMap_SetProperties.py
    :language: python
    :caption: Full listing of OE2DPropMap_SetProperties.py.
    :refnum:   20

..	_listing-OEColorGradientDispOpts.py:

..  oe:source:: OEColorGradientDispOpts.py
    :language: python
    :caption: Full listing of OEColorGradientDispOpts.py.
    :refnum:   21

..	_listing-OEPeptideDispOpts_SetOpts.py:

..  oe:source:: OEPeptideDispOpts_SetOpts.py
    :language: python
    :caption: Full listing of OEPeptideDispOpts_SetOpts.py.
    :refnum:   22

..	_listing-RenderBFactorMap.py:

..  oe:source:: RenderBFactorMap.py
    :language: python
    :caption: Full listing of RenderBFactorMap.py.
    :refnum:   23

..	_listing-shapeoverlap2pdf.py:

..  oe:source:: shapeoverlap2pdf.py
    :language: python
    :caption: Full listing of shapeoverlap2pdf.py.
    :refnum:   24

..	_listing-SVGMarkResidues.py:

..  oe:source:: SVGMarkResidues.py
    :language: python
    :caption: Full listing of SVGMarkResidues.py.
    :refnum:   25

***********************
Graphsim Toolkit
***********************

These examples illustrate use of the Graphsim Toolkit,
provides a facility for encoding 2D molecular
graph information into fingerprints.  For a full list of examples, see the
:ref:`Graphsim chapter <oegraphsim_part_examples>`.

..	_listing-DBSimCalcFromFile.py:

..  oe:source:: DBSimCalcFromFile.py
    :language: python
	:caption: Full listing of DBSimCalcFromFile.py.
    :refnum: 1

..	_listing-DBSimCalcFromOEB.py:

..  oe:source:: DBSimCalcFromOEB.py
    :language: python
	:caption: Full listing of DBSimCalcFromOEB.py.
    :refnum: 2

..	_listing-FP2OEB.py:

..  oe:source:: FP2OEB.py
    :language: python
    :caption: Full listing of FP2OEB.py.
    :refnum: 3

..	_listing-FP2SDF.py:

..  oe:source:: FP2SDF.py
    :language: python
    :caption: Full listing of FP2SDF.py.
    :refnum: 4

..	_listing-FPAtomTyping.py:

..  oe:source:: FPAtomTyping.py
    :language: python
    :caption: Full listing of FPAtomTyping.py.
    :refnum: 5

..	_listing-FPBitString.py:

..  oe:source:: FPBitString.py
    :language: python
    :caption: Full listing of FPBitString.py.
    :refnum: 6

..  _listing-FPCoverage.py:

..	oe:source:: FPCoverage.py
    :language: python
    :caption: Full listing of FPCoverage.py.
    :refnum: 7

..	_listing-FPData.py:

..  oe:source:: FPData.py
    :language: python
    :caption: Full listing of FPData.py.
    :refnum: 8

..	_listing-FPOverlap.py:

..  oe:source:: FPOverlap.py
    :language: python
    :caption: Full listing of FPOverlap.py.
    :refnum: 9

..  _listing-FPPathLength.py:

..	oe:source:: FPPathLength.py
    :language: python
    :caption: Full listing of FPPathLength.py.
    :refnum: 10

..	_listing-FPPattern.py:

..  oe:source:: FPPattern.py
    :language: python
    :caption: Full listing of FPPattern.py.
    :refnum: 11

..	_listing-FPTanimoto.py:

..  oe:source:: FPTanimoto.py
    :language: python
    :caption: Calculate Tanimoto similarity scores.
    :refnum: 12

..	_listing-MemSimSearch.py:

..  oe:source:: MemSimSearch.py
    :language: python
    :caption: Full listing of MemSimSearch.py.
    :refnum: 13

..	_listing-PathFPType.py:

..  oe:source:: PathFPType.py
    :language: python
    :caption: Full listing of PathFPType.py.
    :refnum: 14

..	_listing-SDF2FP.py:

..  oe:source:: SDF2FP.py
    :language: python
    :caption: Full listing of SDF2FP.py.
    :refnum: 15

..  _listing-SimCalcFromFile.py:

..	oe:source:: SimCalcFromFile.py
    :language: python
    :caption: Full listing of SimCalcFromFile.py.
    :refnum: 16

..	_listing-SimCalcFromOEB.py:

..  oe:source:: SimCalcFromOEB.py
    :language: python
    :caption: Full listing of SimCalcFromOEB.py.
    :refnum: 17

..	_listing-makefastfp.py:

..  oe:source:: makefastfp.py
    :language: python
    :caption: Generating fingerprint file for fast fingerprint search.
    :refnum: 18

..	_listing-searchfastfp.py:

..  oe:source:: searchfastfp.py
    :language: python
    :caption: Searching fast fingerprint database.
    :refnum: 19

..	_listing-searchfp.py:

..  oe:source:: searchfp.py
    :language: python
    :caption: Building and searching fingerprint database.
    :refnum: 20

..	_listing-getscores.py:

..  oe:source:: GetScores.py
    :language: python
    :caption: Calculate similarity scores.
    :refnum: 21

..	_listing-sortedsearch.py:

..  oe:source:: SortedSearch.py
    :language: python
    :caption: Perform multithreaded similarity calculation.
    :refnum: 22

..	_listing-circularfpdefaultparams.py:

..  oe:source:: CircularFPDefaultParams.py
    :language: python
    :caption: Print out string representation of a circular fingerprint.
    :refnum: 23

..	_listing-pathfpdefaultparams.py:

..  oe:source:: PathFPDefaultParams.py
    :language: python
    :caption: Print out string representation of a path fingerprint.
    :refnum: 24

..	_listing-treefpdefaultparams.py:

..  oe:source:: TreeFPDefaultParams.py
    :language: python
    :caption: Print out string representation of a tree fingerprint.
    :refnum: 25

..	_listing-simfunc.py:

..  oe:source:: SimFunc.py
    :language: python
    :caption: simfunc.py full listing.
    :refnum: 26

..	_listing-makemaccsfp.py:

..  oe:source:: MakeMaccsFP.py
    :language: python
    :caption: makemaccsfp.py full listing.
    :refnum: 27

..	_listing-makelingofp.py:

..  oe:source:: MakeLingoFP.py
    :language: python
    :caption: makelingofp.py full listing.
    :refnum: 28

..	_listing-makecircularfp.py:

..  oe:source:: MakeCircularFP.py
    :language: python
    :caption: MakeCircularFP.py full listing.
    :refnum: 29

..	_listing-makepathfp.py:

..  oe:source:: MakePathFP.py
    :language: python
    :caption: Make a path fingerprint.
    :refnum: 30

..	_listing-fptype.py:

..  oe:source:: FPType.py
    :language: python
    :caption: Fingerprint types.
    :refnum: 31

..	_listing-fpcompare.py:

..  oe:source:: FPCompare.py
    :language: python
    :caption: Compare fingerprint objects.
    :refnum: 32

..	_listing-fptypestring.py:

..  oe:source:: FPTypeString.py
    :language: python
    :caption: Return string representation of fingerprint type.
    :refnum: 33

..	_listing-fpyule.py:

..  oe:source:: FPYule.py
    :language: python
    :caption: Yule similarity measures.
    :refnum: 34

..	_listing-FPTypeParams.py:

.. oe:source:: FPTypeParams.py
   :language: python
   :refnum:   35
   :caption:  Fingerprint parameters.

**************************
MedChem Toolkit
**************************

These examples illustrate use of the MedChem toolkit, which provides facilities for
fragmentation-based analysis.  For a full list of examples, see
:ref:`the MedChem chapter <oemedchem_part_examples>`.

..  _listing-FragRingChain.py:

.. oe:source:: FragRingChain.py
   :language: python
   :refnum:   1
   :caption:  Example of molecule fragmentation.

..  _listing-OEGetBemisMurcko.py:

.. oe:source:: OEGetBemisMurcko.py
   :language: python
   :refnum:   2
   :caption:  Example of molecule fragmentation with annotations.

..  _listing-OEGetBemisMurckoCustomSubstituents.py:

.. oe:source:: OEGetBemisMurckoCustomSubstituents.py
   :language: python
   :refnum:   3
   :caption:  Example of custom molecule fragmentation.

..  _listing-OEGetBemisMurckoUnsatHeteroBonds.py:

.. oe:source:: OEGetBemisMurckoUnsatHeteroBonds.py
   :language: python
   :refnum:   4
   :caption:  Example of custom molecule fragmentation.

**************************
MolProp Toolkit
**************************

These examples illustrate use of the MolProp toolkit, which provides a customizable framework for
molecular property
calculation geared toward enabling rapid database filtering. For a full list of examples, see
:ref:`the MolProp chapter <molprop_part_examples>`.

..  _listing-PSAAtomContributions.py:

..  oe:source:: PSAAtomContributions.py
    :language: python
    :caption:  Example of retrieving individual atom contributions to PSA.
    :refnum:   1

..  _listing-XLogPAtomContributions.py:

..  oe:source:: XLogPAtomContributions.py
    :language: python
    :caption: Example of retrieving individual atom contributions to XLogP
    :refnum: 2

**************************
OEChem Toolkit
**************************

These selected examples illustrate use of the OEChem toolkit, which is a powerful
programming library for chemistry and cheminformatics.  For a full list of examples,
also see the :ref:`OEChem chapter <oechem_part_examples>`.

..	_listing-AltlocfactGroupsDoc.py:

.. oe:source:: AltlocfactGroupsDoc.py
   :language: python
   :refnum:   1
   :caption:  Alternate location factory groups

..	_listing-Aromaticity.py:

.. oe:source:: Aromaticity.py
   :language: python
   :refnum:   2
   :caption:  Aromaticity perception with various models

..	_listing-AtomMap.py:

.. oe:source:: AtomMap.py
   :language: python
   :refnum:   3
   :caption:  Substructure search with atom mappings

..	_listing-CompositionFunctorsAtom.py:

.. oe:source:: CompositionFunctorsAtom.py
   :language: python
   :refnum:   4
   :caption:  Combining predefined atom predicates

..	_listing-CompositionFunctorsBond.py:

.. oe:source:: CompositionFunctorsBond.py
   :language: python
   :refnum:   5
   :caption:  Combining predefined bond predicates

..	_listing-ClearAromaticity.py:

.. oe:source:: ClearAromaticity.py
   :language: python
   :refnum:   6
   :caption:  Clearing aromaticity

..	_listing-ResCountDoc.py:

.. oe:source:: ResCountDoc.py
   :language: python
   :refnum:   7
   :caption:  Looping over hierarchical components

..	_listing-DatabaseSubset.py:

.. oe:source:: DatabaseSubset.py
   :language: python
   :refnum:   10
   :caption:  Retrieving a subset of a file

..	_listing-DatabaseExtract.py:

.. oe:source:: DatabaseExtract.py
   :language: python
   :refnum:   11
   :caption:  Extract molecules by title

..	_listing-ManipulateSDData.py:

.. oe:source:: ManipulateSDData.py
   :language: python
   :refnum:   12
   :caption:  SD data manipulation

..	_listing-ThreadedMolFind.py:

.. oe:source:: ThreadedMolFind.py
   :language: python
   :refnum:   13
   :caption:  Using Threaded Input and Output

..	_listing-MultiCoreMolFind.py:

.. oe:source:: MultiCoreMolFind.py
   :language: python
   :refnum:   14
   :caption:  Using multiple threads to read and write to molthreads

..	_listing-PipelineMolFind.py:

.. oe:source:: PipelineMolFind.py
   :language: python
   :refnum:   15
   :caption:  Setting mutexed memory pool mode

..	_listing-ManipulatePDBData.py:

.. oe:source:: ManipulatePDBData.py
   :language: python
   :refnum:   16
   :caption:  PDB data manipulation

..	_listing-SubstructureSearch.py:

.. oe:source:: SubstructureSearch.py
   :language: python
   :refnum:   17
   :caption:  Simple substructure search example

..	_listing-MolFind.py:

.. oe:source:: MolFind.py
   :language: python
   :refnum:   18
   :caption:  Extracting molecules based upon a substructure

..	_listing-SubstructureSearchMatch.py:

.. oe:source:: SubstructureSearchMatch.py
   :language: python
   :refnum:   19
   :caption:  Substructures match for query molecule

..	_listing-Functors.py:

.. oe:source:: Functors.py
   :language: python
   :refnum:   20
   :caption:  Using functor callbacks

..	_listing-FunctorsAtom.py:

.. oe:source:: FunctorsAtom.py
   :language: python
   :refnum:   21
   :caption:  Using predefined atom functors

..	_listing-FunctorsBond.py:

.. oe:source:: FunctorsBond.py
   :language: python
   :refnum:   22
   :caption:  Using predefined bond functors

..	_listing-FunctorsOEMatch.py:

.. oe:source:: FunctorsOEMatch.py
   :language: python
   :refnum:   23
   :caption:  Functor substructure-based matching

..	_listing-FunctorsOEPartPred.py:

.. oe:source:: FunctorsOEPartPred.py
   :language: python
   :refnum:   24
   :caption:  Ring system extraction

..	_listing-FunctorsOESubsetMol.py:

.. oe:source:: FunctorsOESubsetMol.py
   :language: python
   :refnum:   25
   :caption:  Ring system extraction

..	_listing-GenericDataMol.py:

.. oe:source:: GenericDataMol.py
   :language: python
   :refnum:   26
   :caption:  Example of attaching a molecule as generic data

..	_listing-GenericDataMolWeight.py:

.. oe:source:: GenericDataMolWeight.py
   :language: python
   :refnum:   27
   :caption:  Example of using generic data

..	_listing-GenericDataToAtom.py:

.. oe:source:: GenericDataToAtom.py
   :language: python
   :refnum:   28
   :caption:  Example of attaching generic data to atoms

..	_listing-GettingStartedWithOEInterface.py:

.. oe:source:: GettingStartedWithOEInterface.py
   :language: python
   :refnum:   29
   :caption:  Getting started with OEInterface command line parsing

..	_listing-NthMolecule.py:

.. oe:source:: NthMolecule.py
   :language: python
   :refnum:   30
   :caption:  Retrieving the Nth molecule in a file

..	_listing-OEInterfaceMolParam.py:

.. oe:source:: OEInterfaceMolParam.py
   :language: python
   :refnum:   31
   :caption:  Example of using molecule parameter

..	_listing-PerceiveAromRingSystems.py:

.. oe:source:: PerceiveAromRingSystems.py
   :language: python
   :refnum:   32
   :caption:  Aromatic ring system identification

..	_listing-PrintAtomStereo.py:

.. oe:source:: PrintAtomStereo.py
   :language: python
   :refnum:   33
   :caption:  Accessing atom stereo information

..	_listing-PrintBondStereo.py:

.. oe:source:: PrintBondStereo.py
   :language: python
   :refnum:   34
   :caption:  Accessing bond stereo information

..	_listing-PrintCIPAtomStereo.py:

.. oe:source:: PrintCIPAtomStereo.py
   :language: python
   :refnum:   35
   :caption:  Perceiving CIP atom stereo information

..	_listing-PrintCIPBondStereo.py:

.. oe:source:: PrintCIPBondStereo.py
   :language: python
   :refnum:   36
   :caption:  Perceiving CIP bond stereo information

..	_listing-ScalarGridCtor.py:

.. oe:source:: ScalarGridCtor.py
   :language: python
   :refnum:   37
   :caption:  Constructing a scalar grid

..	_listing-SetAtomStereo.py:

.. oe:source:: SetAtomStereo.py
   :language: python
   :refnum:   38
   :caption:  Setting atom stereo information

..	_listing-SetBondStereo.py:

.. oe:source:: SetBondStereo.py
   :language: python
   :refnum:   39
   :caption:  Setting bond stereo information

..	_listing-SimpleResCountDoc.py:

.. oe:source:: SimpleResCountDoc.py
   :language: python
   :refnum:   40
   :caption:  Accessing OEResidue properties

..	_listing-UserPredAtom.py:

.. oe:source:: UserPredAtom.py
   :language: python
   :refnum:   41
   :caption:  User defined atom predicate

..	_listing-UserPredAtomArg.py:

.. oe:source:: UserPredAtomArg.py
   :language: python
   :refnum:   42
   :caption:  User defined atom predicate with state

..	_listing-UserPredBond.py:

.. oe:source:: UserPredBond.py
   :language: python
   :refnum:   43
   :caption:  User defined bond predicate

..	_listing-UsingOEInterfaceDefaults.py:

.. oe:source:: UsingOEInterfaceDefaults.py
   :language: python
   :refnum:   44
   :caption:  Setting a default value for a parameter

..	_listing-UsingOEInterfaceHas.py:

.. oe:source:: UsingOEInterfaceHas.py
   :language: python
   :refnum:   45
   :caption:  Testing for parameter existence with the Has method

..	_listing-UsingOEInterfaceHelp.py:

.. oe:source:: UsingOEInterfaceHelp.py
   :language: python
   :refnum:   46
   :caption:  A program to concatenate any number of molecules together

..	_listing-UsingOEInterfaceKeyless.py:

.. oe:source:: UsingOEInterfaceKeyless.py
   :language: python
   :refnum:   47
   :caption:  Specifying keyless input and output file parameters

..	_listing-UsingOEInterfaceList.py:

.. oe:source:: UsingOEInterfaceList.py
   :language: python
   :refnum:   48
   :caption:  Specifying that a parameter is a list of values

..	_listing-UsingOEInterfaceRequired.py:

.. oe:source:: UsingOEInterfaceRequired.py
   :language: python
   :refnum:   49
   :caption:  Requiring all parameters to be specified.

..	_listing-WriteCSV.py:

.. oe:source:: WriteCSV.py
   :language: python
   :refnum:   50
   :caption:  Writing out SD data as CSV

..	_listing-anisou.py:

..  oe:source:: anisou.py
    :language: python
    :refnum:   51
    :caption:  Print anisotropic B-factors.

..	_listing-appendringdict.py:

..  oe:source:: appendringdict.py
    :language: python
    :refnum:   52
    :caption:  Append 2D ring dictionary.

..	_listing-applytransform.py:

..  oe:source:: applytransform.py
    :language: python
    :refnum:   53
    :caption:  Use a SMIRKS specification to perform individual reaction transformations on single molecules.

..	_listing-applytransformiter.py:

..  oe:source:: applytransformiter.py
    :language: python
    :refnum:   54
    :caption:  Use a SMIRKS specification to perform individual reaction transformations on each input molecule.

..	_listing-basicStyle.py:

..  oe:source:: basicStyle.py
    :language: python
    :refnum:   55
    :caption:  Setting up an OE3DMolStyle on a molecule.

..	_listing-bFactorStyle.py:

..  oe:source:: bFactorStyle.py
    :language: python
    :refnum:   56
    :caption:  OE3DMolStyle focused on B-Factor styling.

..	_listing-cansmi.py:

..  oe:source:: cansmi.py
    :language: python
    :refnum:   57
    :caption:  Generate canonical SMILES.

..	_listing-catmols.py:

..  oe:source:: catmols.py
    :language: python
    :refnum:   58
    :caption:  Concatenating molecules.

..	_listing-cifdata.py:

..  oe:source:: cifdata.py
    :language: python
    :refnum:   59
    :caption:  Creating an OECIFData Object.

..	_listing-cliquealign.py:

..  oe:source:: cliquealign.py
    :language: python
    :refnum:   60
    :caption:  Align molecules by clique match.

..	_listing-convert.py:

..  oe:source:: convert.py
    :language: python
    :refnum:   61
    :caption:  Convert molecules.

..	_listing-createringdict.py:

..  oe:source:: createringdict.py
    :language: python
    :refnum:   62
    :caption:  Create 2D ring dictionary.

..	_listing-csv2sdf.py:

..  oe:source:: csv2sdf.py
    :language: python
    :refnum:   63
    :caption:  Adding CSV data as SD tags.

..	_listing-dots.py:

..  oe:source:: dots.py
    :language: python
    :refnum:   64
    :caption:  Print dots.

..	_listing-extractringtemplates.py:

..  oe:source:: extractringtemplates.py
    :language: python
    :refnum:   65
    :caption:  Extract 2D ring templates.

..	_listing-extractscaffold.py:

..  oe:source:: extractscaffold.py
    :language: python
    :refnum:   66
    :caption:  Extract molecule scaffolds.

..	_listing-generate2D.py:

..  oe:source:: generate2D.py
    :language: python
    :refnum:   67
    :caption:  Generate 2D coordinates with user-defined ring templates.

..	_listing-gettitles.py:

..  oe:source:: gettitles.py
    :language: python
    :refnum:   68
    :caption:  Get molecule titles.

..	_listing-libgen.py:

..  oe:source:: libgen.py
    :language: python
    :refnum:   69
    :caption:  Library generation.

..	_listing-makefastss.py:

..  oe:source:: makefastss.py
    :language: python
    :refnum:   70
    :caption:  Generate database for fast substructure search.

..	_listing-mcs3dalign.py:

..  oe:source:: mcs3dalign.py
    :language: python
    :refnum:   71
    :caption:  Align molecules by maximum common substructure.

..	_listing-minpath.py:

..  oe:source:: minpath.py
    :language: python
    :refnum:   72
    :caption:  Find minimum path in a molecule.

..	_listing-molchunk.py:

..  oe:source:: molchunk.py
    :language: python
    :caption: Split molecule file.
    :refnum: 73

..	_listing-molcount.py:

..  oe:source:: molcount.py
    :language: python
    :caption: Counting molecules.
    :refnum: 74

..	_listing-molextract.py:

..  oe:source:: molextract.py
    :language: python
    :caption: Extract molecules by title.
    :refnum: 75

..	_listing-molgrep.py:

..  oe:source:: molgrep.py
    :language: python
    :caption: Perform substructure searches.
    :refnum: 76

..	_listing-molstats.py:

..  oe:source:: molstats.py
    :language: python
    :caption: Print simple molecule information.
    :refnum: 77

..	_listing-oecheminfo.py:

..  oe:source:: oecheminfo.py
    :language: python
    :caption: Print OEChem and file format information.
    :refnum: 78

..	_listing-options.py:

..  oe:source:: options.py
    :language: python
    :caption: Define parameters.
    :refnum: 79

..	_listing-parts2mols.py:

..  oe:source:: parts2mols.py
    :language: python
    :caption: Splitting multicomponent molecules.
    :refnum: 80

..	_listing-printatomnames.py:

..  oe:source:: printatomnames.py
    :language: python
    :caption: Print molecule atom names.
    :refnum: 81

..	_listing-randomizeatoms.py:

..  oe:source:: randomizeatoms.py
    :language: python
    :caption: Randomize molecules of atom.
    :refnum: 82

..	_listing-randomsample.py:

..  oe:source:: randomsample.py
    :language: python
    :caption: Extract random molecule subset.
    :refnum: 83

..	_listing-ringsubset.py:

..  oe:source:: ringsubset.py
    :language: python
    :caption: Extract rings.
    :refnum: 84

..	_listing-rmsd.py:

..  oe:source:: rmsd.py
    :language: python
    :caption: Align multiconformer molecules.
    :refnum: 85

..	_listing-rotorcount.py:

..  oe:source:: rotorcount.py
    :language: python
    :caption: Print rotor count distribution.
    :refnum: 86

..	_listing-sdf2csv.py:

..  oe:source:: sdf2csv.py
    :language: python
    :caption: Exporting SD data to a CSV file.
    :refnum: 87

..	_listing-sdfilter.py:

..  oe:source:: sdfilter.py
    :language: python
    :caption: Filter molecules by SD data.
    :refnum: 88

..	_listing-sdfmodprops.py:

..  oe:source:: sdfmodprops.py
    :language: python
    :caption: Modifying SD tags.
    :refnum: 89

..	_listing-sdfrename.py:

..  oe:source:: sdfrename.py
    :language: python
    :caption: Renaming molecules by SD field.
    :refnum: 90

..	_listing-searchfastss.py:

..  oe:source:: searchfastss.py
    :language: python
    :caption: Perform SMARTS search on substructure database file.
    :refnum: 91

..	_listing-setchemcomp.py:

..  oe:source:: setchemcomp.py
    :language: python
    :caption: Setting mmCIF Chemical Component Header.
    :refnum: 92

..	_listing-sizefilter.py:

..  oe:source:: sizefilter.py
    :language: python
    :caption: Filter molecules by weight or heavy atom count.
    :refnum: 93

..	_listing-smartsalign.py:

..  oe:source:: smartsalign.py
    :language: python
    :caption: Align molecules by SMARTS match.
    :refnum: 94

..	_listing-stripsalts.py:

..  oe:source:: stripsalts.py
    :language: python
    :caption: Strip salts.
    :refnum: 95

..	_listing-styleHierarchy.py:

..  oe:source:: styleHierarchy.py
    :language: python
    :caption: OE3DMolStyle hierarchy between molecule, conformers, and atoms.
    :refnum: 96

..	_listing-unimolrxn.py:

..  oe:source:: unimolrxn.py
    :language: python
    :caption: Performing a reaction.
    :refnum: 97

..	_listing-uniqinchi.py:

..  oe:source:: uniqinchi.py
    :language: python
    :caption: Write out unique molecules (InChi).
    :refnum: 98

..	_listing-uniqmol.py:

..  oe:source:: uniqmol.py
    :language: python
    :caption: Write out unique molecules (canonical SMILES).
    :refnum: 99

***********************
Omega Toolkit
***********************

These selected examples illustrate use of the Omega toolkit, which generates conformations of
molecules.
For a guide to programming examples, see :ref:`the Omega chapter <chapter_omega_examples>`.

.. 	_listing-AddTorsionRule.py:

..  oe:source:: AddTorsionRule.py
    :language: python
    :caption:  Example of adding a new torsion rule.
    :refnum:   1

.. 	_listing-GPUOmega.py:

.. oe:source:: GPUOmega.py
   :language: python
   :refnum:   2
   :caption:  Example of turning off GPU-Omega and changing parameters.

.. there are other oemga examples already displayed as full listings.

**************************
Quacpac Toolkit
**************************

These selected examples illustrate use of the Quacpac toolkit, which includes pKa and
tautomer enumeration
in order to get correct protonation states, partial charges using multiple
models that cover a range of speed and accuracy, and electrostatic potential
map construction and storage.
For a guide to programming examples, see :ref:`the Quacpac chapter <quacpac_part_examples>`.

.. 	_listing-assigncharges.py:

..  oe:source:: assigncharges.py
    :language: python
    :caption:  Assigning partial charges.
    :refnum:   1

.. 	_listing-applycharges_oedu.py:

..  oe:source:: applycharges_oedu.py
    :language: python
    :caption:  Applying charges to an OpenEye design unit.
    :refnum:   2

.. 	_listing-enumerateionizationstatesatneutralph.py:

..  oe:source:: enumerateionizationstatesatneutralph.py
    :language: python
    :caption:  Applying charges to an OpenEye design unit.
    :refnum:   3

.. 	_listing-getreasonabletautomers.py:

..  oe:source:: getreasonabletautomers.py
    :language: python
    :caption:  A fast informatics technique using tautomer enumeration.
    :refnum:   4

.. 	_listing-neutralionization.py:

..  oe:source:: neutralionization.py
    :language: python
    :caption:  Set a single dominant ionization state of a molecule at pH 7.4.
    :refnum:   5

.. 	_listing-setreasonablechargestate.py:

..  oe:source:: setreasonablechargestate.py
    :language: python
    :caption:  Set a favorable ionization state assuming pH 7.4.
    :refnum:   6

.. 	_listing-wibergbondorders.py:

..  oe:source:: wibergbondorders.py
    :language: python
    :caption:  Obtain the Wiberg bond orders from an AM1 calculation.
    :refnum:   7

**************************
Saiph Toolkit
**************************

The Saiph toolkit provides facilities for converting data to different formats without changing the meaning of the data.
:ref:`See the Saiph chapter for a guide to programming examples. <saiph_part_examples>`

**************************
Shape Toolkit
**************************

The Shape toolkit facilitates the calculation of molecular descriptors for shape (steric multipoles), volume overlap
between molecules, and spatial similarity of chemical groups (color force field), as well as the optimization of the
latter two quantities. :ref:`See the Shape TK chapter for a guide to programming examples. <shape_part_examples>`

**************************
SiteHopper Toolkit
**************************

The Shape toolkit facilitates rapid comparison of protein binding sites.
:ref:`See the SiteHopper chapter for a guide to programming examples. <sitehopper_part_examples>`

**************************
Spicoli Toolkit
**************************

The Spicoli toolkit facilitates creating, manipulating,
and analyzing surfaces of many types.
Programming examples are presented and excerpted with specific features, for example,
:ref:`OEMakeConnectedSurfaceCliques. <make-connected-surface-cliques-example>`

..  _listing-CalculateTriangleAreas.py:

..  oe:source:: CalculateTriangleAreas.py
    :language: python
    :noindent:
    :caption: CalculateTriangleAreas.py full listing.
    :refnum: 1

..  _listing-MakeConnectedSurfaceCliques.py:

..  oe:source:: MakeConnectedSurfaceCliques.py
    :language: python
    :noindent:
    :caption: MakeConnectedSurfaceCliques.py full listing.
    :refnum: 2

..  _listing-AttachSurface.py:

..  oe:source:: AttachSurface.py
    :language: python
    :noindent:
    :caption: AttachSurface.py full listing.
    :refnum: 3

..  _listing-SurfaceDataAccess.py:

..  oe:source:: SurfaceDataAccess.py
    :language: python
    :noindent:
    :caption: SurfaceDataAccess.py full listing.
    :refnum: 4

**************************
Spruce Toolkit
**************************

The Spruce toolkit facilitates preparing biomolecules
(that is, proteins and nucleic acids) for modeling tasks.
:ref:`See the Spruce chapter for a guide to programming examples. <oespruce_part_examples>`
Examples listed here are provided for download in the Spruce chapter.

..  _listing-du2mmcif.py:

..  oe:source:: du2mmcif.py
    :language: python
    :noindent:
    :caption: du2mmcif.py full listing.
    :refnum: 1

..  _listing-add_receptor_obj_to_du.py:

..  oe:source:: add_receptor_obj_to_du.py
    :language: python
    :noindent:
    :caption: add_receptor_obj_to_du.py full listing.
    :refnum: 2

..  _listing-extract_biounits_ref.py:

..  oe:source:: extract_biounits_ref.py
    :language: python
    :noindent:
    :caption: extract_biounits_ref.py full listing.
    :refnum: 3

..  _listing-extract_biounits_remarks.py:

..  oe:source:: extract_biounits_remarks.py
    :language: python
    :noindent:
    :caption: extract_biounits_remarks.py full listing.
    :refnum: 4

..  _listing-findpockets.py:

..  oe:source:: findpockets.py
    :language: python
    :noindent:
    :caption: findpockets.py full listing.
    :refnum: 5

..  _listing-make_apo_design_units.py:

..  oe:source:: make_apo_design_units.py
    :language: python
    :noindent:
    :caption: make_apo_design_units.py full listing.
    :refnum: 6

..  _listing-make_design_unit_using_metadata.py:

..  oe:source:: make_design_unit_using_metadata.py
    :language: python
    :noindent:
    :caption: make_design_unit_using_metadata.py full listing.
    :refnum: 7

..  _listing-make_design_units.py:

..  oe:source:: make_design_units.py
    :language: python
    :noindent:
    :caption: make_design_units.py full listing.
    :refnum: 8

..  _listing-fasta_to_structmeta.py:

..  oe:source:: fasta_to_structmeta.py
    :language: python
    :noindent:
    :caption: fasta_to_structmeta.py full listing.
    :refnum: 9

..  _listing-superpose.py:

..  oe:source:: superpose.py
    :language: python
    :noindent:
    :caption: superpose.py full listing.
    :refnum: 10

..  _listing-validate_design_unit.py:

..  oe:source:: validate_design_unit.py
    :language: python
    :noindent:
    :caption: validate_design_unit.py full listing.
    :refnum: 11

***********************
Szmap Toolkit
***********************

The Szmap toolkit provides simple access to **SZMAP** functionality,
for calculating solvent thermodynamic properties near molecular surfaces.
For a guide to programming examples, :ref:`see the Szmap chapter <szmap_part_examples>`.

.. _listing-SzmapBestOrientations.py:

.. oe:source:: SzmapBestOrientations.py
   :language: python
   :refnum:   1
   :caption:  Generate Szmap points and probe orientations at ligand atoms.

.. _listing-SzmapCalcs.py:

.. oe:source:: SzmapCalcs.py
   :language: python
   :refnum:   2
   :caption:  Example of Szmap calculations.

.. _listing-SzmapEnergies.py:

.. oe:source:: SzmapEnergies.py
   :language: python
   :refnum:   3
   :caption:  Analyze binding site energies.

***********************
Szybki Toolkit
***********************

The Szybki toolkit provides facilities for force-field-based
optimization and thermodynamic property estimation of small molecule ligands or
protein-ligand complexes with small molecule ligands.
For a guide to programming examples, :ref:`see the Szybki chapter <szybki_part_examples>`.

.. _listing-simple_vacuum.py:

.. oe:source:: simple_vacuum.py
   :language: python
   :caption:  Simple Ligand in a Vacuum.
   :refnum:   1

.. _listing-simple_smirnoff.py:

.. oe:source:: simple_smirnoff.py
   :language: python
   :caption:  Simple Ligand in a Vacuum Using SMIRNOFF.
   :refnum:   2

.. _listing-ligand_multiple_options.py:

.. oe:source:: ligand_multiple_options.py
   :language: python
   :caption:  Optimization of a Set of Ligands.
   :refnum:   3

.. _listing-simple_newton.py:

.. oe:source:: simple_newton.py
   :language: python
   :caption:  Optimization of a Single Ligand with the Newton-Raphson Method.
   :refnum:   4

.. _listing-simple_conformer.py:

.. oe:source:: simple_conformer.py
   :language: python
   :caption:  Optimization of All Conformers of a Ligand.
   :refnum:   5

.. _listing-simple_protein.py:

.. oe:source:: simple_protein.py
   :language: python
   :caption:  Optimization of a Single Bound Ligand.
   :refnum:   6

.. _listing-protein_multiple_options.py:

.. oe:source:: protein_multiple_options.py
   :language: python
   :caption:  Optimization of a Set of Bound Ligands in a Rigid Receptor.
   :refnum:   7

.. _listing-flexible_protein.py:

.. oe:source:: flexible_protein.py
   :language: python
   :caption:  Optimization of a Set of Bound Ligands in a Partially Flexible Receptor.
   :refnum:   8

.. _listing-flex_residues.py:

.. oe:source:: flex_residues.py
   :language: python
   :caption:  Optimization of a Bound Ligand in a Partially Flexible Receptor.
   :refnum:   9

.. _listing-protein_ligand_PB.py:

.. oe:source:: protein_ligand_PB.py
   :language: python
   :caption:  Estimation of PB Binding for a Set of Ligands.
   :refnum:   10

.. _listing-ligand_flexprotein_newton.py:

.. oe:source:: ligand_flexprotein_newton.py
   :language: python
   :caption:  Optimization of a Bound Ligand Using Newton-Raphson Method.
   :refnum:   11

.. _listing-OptimizeLigandInDU.py:

.. oe:source:: OptimizeLigandInDU.py
   :language: python
   :caption:  Optimization of Ligand in a Rigid Active Site.
   :refnum:   12

.. _listing-OptimizeDU.py:

.. oe:source:: OptimizeDU.py
   :language: python
   :caption:  Optimization of Ligand in a Partially Flexible Active Site.
   :refnum:   13

.. _listing-ligand_entropy.py:

.. oe:source:: ligand_entropy.py
   :language: python
   :caption:  Ligand Entropy.
   :refnum:   14

.. _listing-bound_entropy.py:

.. oe:source:: bound_entropy.py
   :language: python
   :caption:  Estimation of Bound Ligand Entropy
   :refnum:   15

.. _listing-freeformsolv.py:

.. oe:source:: freeformsolv.py
   :language: python
   :caption:  Solvation Free Energy Estimation
   :refnum:   16

.. _listing-freeformconf.py:

.. oe:source:: freeformconf.py
   :language: python
   :caption:  Simple Free Energy Estimation
   :refnum:   17

.. _listing-freeformconfrstr.py:

.. oe:source:: freeformconfrstr.py
   :language: python
   :caption:  Simple Restriction Energy Estimation
   :refnum:   18

.. _listing-freeformconfadvanced.py:

.. oe:source:: freeformconfadvanced.py
   :language: python
   :caption:  Advanced Free Energy Estimation
   :refnum:   19

.. _listing-freeformconfadvrstr.py:

.. oe:source:: freeformconfadvrstr.py
   :language: python
   :caption:  Advanced Restriction Energy Estimation
   :refnum:   20

.. _listing-findsimilarconfs.py:

.. oe:source:: findsimilarconfs.py
   :language: python
   :caption:  Finding Similar Conformers
   :refnum:   21

.. _listing-TorsionScan.py:

.. oe:source:: TorsionScan.py
   :language: python
   :caption:  Perform torsion scan for all torsions in the input molecule
   :refnum:   22

***********************
Zap Toolkit
***********************

The Zap toolkit Zap TK produces Poisson-Boltzmann electrostatic potentials and, from them, biologically interesting
properties including solvent transfer energies, binding energies, pKa shifts, solvent forces, electrostatic descriptors,
surface potentials, and effective dielectric constants.  Programming examples are dispersed among the descriptions
of parts of the toolkits and in the overall chapter :ref:`The Way of Zap <chapter_thewayofzap>`.  Full listings are
provided here for examples that are presented as incomplete snippets in the Zap chapters.

..  _listing-OEBind.py:

..  oe:source:: OEBind.py
    :language: python
    :caption:  OEBind.py full listing.
    :refnum: 1

..  _listing-OEArea_GetArea.py:

..  oe:source:: OEArea_GetArea.py
    :language: python
    :caption:  OEArea_GetArea.py full listing.
    :refnum: 2

..  _listing-DelPhiFlavor.py:

.. oe:source:: DelPhiFlavor.py
   :language: python
   :caption:  DelPhiFlavor.py full listing.
   :refnum: 3



.. _OESiteHopperClasses:

********************
OESiteHopper Classes
********************

.. oe:namespace:: OESiteHopper

.. toctree::

   OESiteHopperDatabase
   OESiteHopperDatabaseOptions
   OESiteHopperPatchOptions
   OESiteHopperResults
   OESiteHopperScore
   OESiteHopperSearch
   OESiteHopperSearchBase
   OESiteHopperSearchOptions


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESiteHopper

.. attention::

      |TWOLANGUAGE|

.. _OESiteHopper_OESiteHopperDatabase:

.. oe:class:: OESiteHopperDatabase

   .. oe:api::

      class OESiteHopperDatabase : public OEShape::OESiteHopperDatabaseBase

  
   This class allows creation and searching of one or more OESiteHopper patches, built
   from OEDesignUnits. When adding data to the database, it can be opened in either
   Create or Append mode. For searching, open in Search (ReadOnly) mode for thread
   safety and to prevent accidentally changing the data.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESiteHopperDatabase()
            OESiteHopperDatabase(const OESiteHopperDatabase &)

      .. oe:language:: python

         .. oe:api:: python

            OESiteHopperDatabase() -> OESiteHopperDatabase
            OESiteHopperDatabase(arg2: OESiteHopperDatabase) -> OESiteHopperDatabase

      Default constructors.

   .. oe:method:: Open

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Open(const std::string& dbfile, const unsigned int mode,
                      const OESiteHopperDatabaseOptions& opts = OESiteHopperDatabaseOptions())

      .. oe:language:: python

         .. oe:api:: python

            Open(dbfile: str, mode: int,
                 opts: OESiteHopperDatabaseOptions = OESiteHopperDatabaseOptions()) -> bool

      Open a file as an OESiteHopperDatabase. 
      
      To create a new database, use the mode
      :oe:const:`OESiteHopper::OESiteHopperDatabaseMode::CREATE`. If the file
      already exists, it will be overwritten. The options used to create the 
      database can be changed by passing an new version of :ref:`OESiteHopperDatabaseOptions <OESiteHopper_OESiteHopperDatabaseOptions>`.

      To append to an existing database, use the mode
      :oe:const:`OESiteHopper::OESiteHopperDatabaseMode::APPEND`. If the file
      does not yet exists, it will be created like the Create mode. 

      To read or search a file, open using the mode
      :oe:const:`OESiteHopper::OESiteHopperDatabaseMode::SEARCH`. This opens the
      database in read-only mode and will not allow adding new entries.  

      .. note::

         OESiteHopperDatabaseOptions are only used in `CREATE` mode. Otherwise, options already stored in
         the database will be used.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

   .. oe:method:: Add

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int Add(const std::string& filename)
            unsigned int Add(const OEBio::OEDesignUnit& du)

      .. oe:language:: python

         .. oe:api:: python

            Add(filename: str) -> int
            Add(du: OEDesignUnit) -> int

      Add a single OEDesignUnit file or object to an open database. This method will fail if the
      database is not open or if not opened in Create or Append mode.

      Returns the index of the newly added OEDesignUnit or `UINT_MAX` on failure.

   .. oe:method:: AddDirectory

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddDirectory(const std::string& path, unsigned int ncpu = 0,
                              OESystem::OETracerBase& tracer = OESystem::OENoTracer)

      .. oe:language:: python

         .. oe:api:: python

            AddDirectory(path: str, ncpu: int = 0,
                         tracer: OETracerBase = OENoTracer) -> bool

      Add a directory of OEDesignUnit files to the database. This call will recurse the
      entire directory tree, looking for all available `.oedu` files.

      By default, this call will use all available CPUs to process this set of OEDesignUnits. 
      Setting `ncpu` can be used to reduce the number of CPUs used.

      If you want to see a progress bar during the process, use an `OEConsoleProgressTracer`
      instead of the default `OENoTracer`.

   .. oe:method:: Close

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Close()

      .. oe:language:: python

         .. oe:api:: python

            Close() -> None

      Close the database connection. Any operations (except another call to
      `Open`) after this will fail.

   .. oe:method:: GetDesignUnit

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetDesignUnit(OEBio::OEDesignUnit& du, unsigned int idx) const

      .. oe:language:: python

         .. oe:api:: python

            GetDesignUnit(du: OEDesignUnit, idx: int) -> bool

      Get a specific OEDesignUnit based on the database index.

   .. oe:method:: GetIDByTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<unsigned int> GetIDByTitle(const std::string& title) const

      .. oe:language:: python

         .. oe:api:: python

            GetIDByTitle(title: str) -> OEUIntVector

      Get a vector of indices based on a substring match of the passed in title to
      OEDesignUnit titles in the database. 

   .. oe:method:: GetMaxMolIdx

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxMolIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMolIdx() -> int

      Internal use: Get the maximum index in the database. Used by the GPU search.

   .. oe:method:: GetMolecule

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMolecule(OEChem::OEMolBase& mol, unsigned int idx) const

      .. oe:language:: python

         .. oe:api:: python

            GetMolecule(mol: Union[OEGraphMol,OEMol,OEQMol], idx: int) -> bool

      Internal use: Get the patch molecule for the given index.

   .. oe:method:: GetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESiteHopperDatabaseOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OESiteHopperDatabaseOptions

      Get the options used to create patches as they are added to the database.

   .. oe:method:: GetSequenceInfo

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSequenceInfo(std::vector<std::vector<std::string>>& seq,
                                 unsigned int idx) const

      .. oe:language:: python

         .. oe:api:: python

            GetSequenceInfo(seq: OEStringVectorVector, idx: int) -> bool

      Internal use: Get the sequence info for the given database index.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetTitle(std::string& title, unsigned int idx) const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle(idx: int) -> str

      Get the OEDesignUnit title for the given index.




.. oe:namespace:: OESiteHopper

.. _OESiteHopper_OESiteHopperDatabaseOptions:

.. oe:class:: OESiteHopperDatabaseOptions

   .. oe:api::

      class OESiteHopperDatabaseOptions : public OESystem::OEOptions

   This class provides a way to set up how the SiteHopper database will be built.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESiteHopperDatabaseOptions()
            OESiteHopperDatabaseOptions(const OESiteHopperDatabaseOptions &)
            OESiteHopperDatabaseOptions(OESiteHopperDatabaseOptions &&)

      .. oe:language:: python

         .. oe:api:: python

            OESiteHopperDatabaseOptions() -> OESiteHopperDatabaseOptions
            OESiteHopperDatabaseOptions(arg2: OESiteHopperDatabaseOptions) -> OESiteHopperDatabaseOptions

      Default and copy constructors.

   .. oe:method:: GetPatchOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESiteHopperPatchOptions& GetPatchOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetPatchOptions() -> OESiteHopperPatchOptions

      Returns a reference to the :ref:`OESiteHopperPatchOptions <OESiteHopper_OESiteHopperPatchOptions>`
      instance as currently set. This defines options for building patches as they
      are added to the database.

   .. oe:method:: SetPatchOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPatchOptions(const OESiteHopperPatchOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            SetPatchOptions(opts: OESiteHopperPatchOptions) -> None

      Update the internal OESiteHopperPatchOptions.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESiteHopperDatabaseOptions &operator=(const OESiteHopperDatabaseOptions &)
         OESiteHopperDatabaseOptions &operator=(OESiteHopperDatabaseOptions &&)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESiteHopperDatabaseOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESiteHopperDatabaseOptions



.. oe:namespace:: OESiteHopper

.. _OESiteHopper_OESiteHopperPatchOptions:

.. oe:class:: OESiteHopperPatchOptions

   .. oe:api::

      class OESiteHopperPatchOptions : public OESystem::OEOptions

   Options that affect how SiteHopper Patches are contructed.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESiteHopperPatchOptions()
            OESiteHopperPatchOptions(const OESiteHopperPatchOptions &)
            OESiteHopperPatchOptions(OESiteHopperPatchOptions &&)

      .. oe:language:: python

         .. oe:api:: python

            OESiteHopperPatchOptions() -> OESiteHopperPatchOptions
            OESiteHopperPatchOptions(arg2: OESiteHopperPatchOptions) -> OESiteHopperPatchOptions

      Default constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESiteHopperPatchOptions &operator=(const OESiteHopperPatchOptions &)
         OESiteHopperPatchOptions &operator=(OESiteHopperPatchOptions &&)

      Assignment operator.

   .. oe:method:: GetResidueCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetResidueCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidueCutoff() -> float

      Get distance (in Angstroms) from any ligand atom to any protein residue to consider that residue part of the patch.

      [default: 7.0]

   .. oe:method:: GetSiteSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSiteSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetSiteSize() -> float

      Get distance from any site residue to edge of patch surface to be created.
      A larger distance means a larger patch will be created.

      [default: 4.0]

   .. oe:method:: GetSurfaceCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSurfaceCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetSurfaceCutoff() -> float

      Get maximum distance a color atom can be from the surface to be included in the patch.
      
      [default: 2.5]

   .. oe:method:: GetScaleFactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetScaleFactor() const

      .. oe:language:: python

         .. oe:api:: python

            GetScaleFactor() -> int

      Get factor by which number of surface points are reduced to create the patch surface. 

      [default: 4]

   .. oe:method:: GetUserStartsScaleFactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetUserStartsScaleFactor() const

      .. oe:language:: python

         .. oe:api:: python

            GetUserStartsScaleFactor() -> int

      Get factor by which the number of surface points are reduced to create user starts
      for the optimization.

      [default: 14]

   .. oe:method:: SetResidueCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetResidueCutoff(float cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetResidueCutoff(value: float) -> bool

      Set distance (in Angstroms) from any ligand atom to any protein residue to consider that residue part of the patch.

      [default: 7.0]

   .. oe:method:: SetSiteSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSiteSize() const

      .. oe:language:: python

         .. oe:api:: python

            SetSiteSize(value: float) -> bool

      Set distance from any site residue to edge of patch surface to be created.
      A larger distance means a larger patch will be created.

      [default: 4.0]

   .. oe:method:: SetSurfaceCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSurfaceCutoff(const float value)

      .. oe:language:: python

         .. oe:api:: python

            SetSurfaceCutoff(value: float) -> bool

      Set maximum distance a color atom can be from the surface to be included
      in the patch. A larger value means more color atoms from the protein will
      be included.
      
      [default: 2.5]

   .. oe:method:: SetScaleFactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetScaleFactor(unsigned int factor)

      .. oe:language:: python

         .. oe:api:: python

            SetScaleFactor(value: int) -> bool

      Set factor by which number of surface points are reduced to create the patch surface. 
      A larger factor will result in fewer surface/shape point. Too few will result in a poor
      shape description of the patch.

      [default: 4]

   .. oe:method:: SetUserStartsScaleFactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUserStartsScaleFactor(unsigned int factor)

      .. oe:language:: python

         .. oe:api:: python

            SetUserStartsScaleFactor(value: int) -> bool

      Set factor by which the number of surface points are reduced to create user starts
      for the optimization.

      [default: 14]

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESiteHopperPatchOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESiteHopperPatchOptions

   .. oe:method:: GetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEShape::OEColorForceField& GetColorForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceField() -> OEColorForceField

      Get a reference to the OEColorForceField used for patch creation and scoring.


.. oe:namespace:: OESiteHopper

.. _OESiteHopper_OESiteHopperResults:

.. oe:class:: OESiteHopperResults

   .. oe:api::

      class OESiteHopperResults

   This is a class used inside the SiteHopper search. User results 
   user the :ref:`OESiteHopperScore <OESiteHopper_OESiteHopperScore>` class.

   
   The following classes derive from this class:
    * :ref:`OESiteHopperScore <OESiteHopper_OESiteHopperScore>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESiteHopperResults()
            OESiteHopperResults(OESiteHopperResults &&rhs)
            OESiteHopperResults(const OESiteHopperResults& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESiteHopperResults() -> OESiteHopperResults
            OESiteHopperResults(rhs: OESiteHopperResults) -> OESiteHopperResults

      Default constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESiteHopperResults &operator=(OESiteHopperResults &&rhs)
         OESiteHopperResults &operator=(const OESiteHopperResults &rhs)

      Assignment operator.

   .. oe:method:: GetColorScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetColorScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorScale() -> float

      Get scale factor applied to color Tanimoto to get PatchScore.

      [default: 3.0]

   .. oe:method:: GetColorTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetColorTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorTanimoto() -> float

      Get color Tanimoto from the patch overlay.

   .. oe:method:: GetPatchScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetPatchScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetPatchScore() -> float

      Get PatchScore from overlay. This score is Shape Tanimoto + ScaleFactor * Color Tanimoto.

   .. oe:method:: GetRank

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetRank() const

      .. oe:language:: python

         .. oe:api:: python

            GetRank() -> int

      Get the rank in the hitlist.

   .. oe:method:: GetSequenceSimilarity

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSequenceSimilarity() const

      .. oe:language:: python

         .. oe:api:: python

            GetSequenceSimilarity() -> float

      Get sequence similarity between referance patch protein and fit patch protein.

   .. oe:method:: GetShapeTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetShapeTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeTanimoto() -> float

      Get Shape Tanimoto from overlay.

   .. oe:method:: SetColorScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColorScale(float scale)

      .. oe:language:: python

         .. oe:api:: python

            SetColorScale(scale: float) -> None

      Set scale factor applied to color Tanimoto to get PatchScore.

      [default: 3.0]

   .. oe:method:: SetColorTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetColorTanimoto(float score)

      .. oe:language:: python

         .. oe:api:: python

            SetColorTanimoto(score: float) -> None

   .. oe:method:: SetRank

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRank(unsigned int rank)

      .. oe:language:: python

         .. oe:api:: python

            SetRank(rank: int) -> None

   .. oe:method:: SetSequenceSimilarity

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSequenceSimilarity(float similarity)

      .. oe:language:: python

         .. oe:api:: python

            SetSequenceSimilarity(similarity: float) -> None

   .. oe:method:: SetShapeTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetShapeTanimoto(float score)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeTanimoto(score: float) -> None



.. oe:namespace:: OESiteHopper

.. _OESiteHopper_OESiteHopperScore:

.. oe:class:: OESiteHopperScore

   .. oe:api::

      class OESiteHopperScore : public OESiteHopperResults

   This class is use to hold the score and results from a SiteHopper search.

   The following methods are publicly inherited from :ref:`OESiteHopperResults <OESiteHopper_OESiteHopperResults>`:
   
   ========================================================================================== ========================================================================================== ========================================================================================== 
   :oe:meth:`operator=<OESiteHopper::OESiteHopperResults::operator=>`                         :oe:meth:`GetRank<OESiteHopper::OESiteHopperResults::GetRank>`                             :oe:meth:`SetColorTanimoto<OESiteHopper::OESiteHopperResults::SetColorTanimoto>`
   :oe:meth:`GetColorScale<OESiteHopper::OESiteHopperResults::GetColorScale>`                 :oe:meth:`GetSequenceSimilarity<OESiteHopper::OESiteHopperResults::GetSequenceSimilarity>` :oe:meth:`SetRank<OESiteHopper::OESiteHopperResults::SetRank>`
   :oe:meth:`GetColorTanimoto<OESiteHopper::OESiteHopperResults::GetColorTanimoto>`           :oe:meth:`GetShapeTanimoto<OESiteHopper::OESiteHopperResults::GetShapeTanimoto>`           :oe:meth:`SetSequenceSimilarity<OESiteHopper::OESiteHopperResults::SetSequenceSimilarity>`
   :oe:meth:`GetPatchScore<OESiteHopper::OESiteHopperResults::GetPatchScore>`                 :oe:meth:`SetColorScale<OESiteHopper::OESiteHopperResults::SetColorScale>`                 :oe:meth:`SetShapeTanimoto<OESiteHopper::OESiteHopperResults::SetShapeTanimoto>`
   ========================================================================================== ========================================================================================== ========================================================================================== 
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESiteHopperScore()
            OESiteHopperScore(OESiteHopperScore &&)
            OESiteHopperScore(const OESiteHopperScore& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESiteHopperScore() -> OESiteHopperScore
            OESiteHopperScore(rhs: OESiteHopperScore) -> OESiteHopperScore

      Default constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESiteHopperScore &operator=(OESiteHopperScore &&rhs)
         OESiteHopperScore &operator=(const OESiteHopperScore &rhs)

      Assignment operator.

   .. oe:method:: GetDesignUnit

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBio::OEDesignUnit GetDesignUnit() const

      .. oe:language:: python

         .. oe:api:: python

            GetDesignUnit() -> OEDesignUnit

      Get output OEDesignUnit for this result. The transfrom from the overlay
      will already be applied.

   .. oe:method:: GetID

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetID() const

      .. oe:language:: python

         .. oe:api:: python

            GetID() -> int

      Get database index for this result.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Get title from OEDesignUnit.

   .. oe:method:: GetTransform

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEChem::OETrans& GetTransform() const

      .. oe:language:: python

         .. oe:api:: python

            GetTransform() -> OETrans

      Get the transform from the overlay. This allows applying the same transform to
      other objects to move them into the output frame of reference.

      .. note::

         When asking for the OEDesignUnit from this class, DO NOT apply this 
         transform as the OEDesignUnit will already be transformed.

   .. oe:method:: SetDesignUnit

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDesignUnit(const OEBio::OEDesignUnit& du)

      .. oe:language:: python

         .. oe:api:: python

            SetDesignUnit(du: OEDesignUnit) -> None

      Internal use: Set the OEDesignUnit.

   .. oe:method:: SetID

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetID(const unsigned int id)

      .. oe:language:: python

         .. oe:api:: python

            SetID(id: int) -> None

      Internal use: Set the database index.

   .. oe:method:: SetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTitle(const std::string& title)

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(title: str) -> None

      Internal use: Set the title.

   .. oe:method:: SetTransform

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTransform(const OEChem::OETrans& trans)

      .. oe:language:: python

         .. oe:api:: python

            SetTransform(trans: OETrans) -> None

      Internal use: Set the transform.


.. oe:namespace:: OESiteHopper

.. _OESiteHopper_OESiteHopperSearch:

.. oe:class:: OESiteHopperSearch

   .. oe:api::

      class OESiteHopperSearch : public OESiteHopperSearchBase

   Class to perform a search of an OESiteHopperDatabase.

   The following methods are publicly inherited from :ref:`OESiteHopperSearchBase <OESiteHopper_OESiteHopperSearchBase>`:
   
   =============== ==========  =============
   operator bool   operator=   Search
   =============== ==========  =============

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            explicit OESiteHopperSearch(OESiteHopperDatabase& shdb)

      .. oe:language:: python

         .. oe:api:: python

            OESiteHopperSearch(shdb: OESiteHopperDatabase) -> OESiteHopperSearch

      Construct a search object to perform searches of the passed in OESiteHopperDatabase.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Used to verify that the database is opened correctly and the object is ready for a search.

   .. oe:method:: Search

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESiteHopper::OESiteHopperScore>* Search(const OEBio::OEDesignUnit& query,
                                                                          const OESiteHopperSearchOptions& options = OESiteHopperSearchOptions(),
                                                                          OESystem::OETracerBase& tracer = OESystem::NullTracer)

      .. oe:language:: python

         .. oe:api:: python

            Search(query: OEDesignUnit,
                   options: OESiteHopperSearchOptions = OESiteHopperSearchOptions(),
                   tracer: OETracerBase = NullTracer) -> Iterable[OESiteHopperScore]

      Perform a search using a query OEDesignUnit. 

      If you want to see a progress bar during the process, use an `OEConsoleProgressTracer`
      instead of the default `OENoTracer`.


.. oe:namespace:: OESiteHopper

.. _OESiteHopper_OESiteHopperSearchBase:

.. oe:class:: OESiteHopperSearchBase

   .. oe:api::

      class OESiteHopperSearchBase

   Base class for OESiteHopperSearch.   

   The following classes derive from this class:
    * :ref:`OESiteHopperSearch <OESiteHopper_OESiteHopperSearch>`
   
   .. oe:method:: Constructors

      .. oe:api::

         OESiteHopperSearchBase()

      Constructors that need documenting.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

   .. oe:method:: Search

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OESiteHopperScore>* Search(const OEBio::OEDesignUnit& query,
                                                            const OESiteHopperSearchOptions& options = OESiteHopperSearchOptions(),
                                                            OESystem::OETracerBase& tracer = OESystem::NullTracer)=0

      .. oe:language:: python

         .. oe:api:: python

            Search(query: OEDesignUnit, arg2: OESiteHopperSearchOptions,
                   tracer: OETracerBase = NullTracer) -> Iterable[OESiteHopperScore]



.. oe:namespace:: OESiteHopper

.. _OESiteHopper_OESiteHopperSearchOptions:

.. oe:class:: OESiteHopperSearchOptions

   .. oe:api::

      class OESiteHopperSearchOptions : public OESystem::OEOptions

   Options to control the process in OESiteHopperSearch.

   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESiteHopperSearchOptions()
            OESiteHopperSearchOptions(OESiteHopperSearchOptions &&)
            OESiteHopperSearchOptions(const OESiteHopperSearchOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESiteHopperSearchOptions() -> OESiteHopperSearchOptions
            OESiteHopperSearchOptions(arg2: OESiteHopperSearchOptions) -> OESiteHopperSearchOptions

      Default constructors.

   .. oe:method:: GetMaxHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetMaxHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHits() -> int

      Get maximum number of hits to return from the search. Very large hitlists can use a large amount of RAM.

      [default: 200]

   .. oe:method:: GetNCPU

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetNCPU() const

      .. oe:language:: python

         .. oe:api:: python

            GetNCPU() -> int

      Get maximum number of CPUs to use for search. Zero (0) implies use all available.

      [default: 0]

   .. oe:method:: GetNormalizeAndRescore

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetNormalizeAndRescore() const

      .. oe:language:: python

         .. oe:api:: python

            GetNormalizeAndRescore() -> bool

      Flag to determine whether patches of hits will be normalized to the
      surface area of the query patch and then rescored for the final hitlist.

      [default: false]

   .. oe:method:: GetScoreCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetScoreCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreCutoff() -> float

      Minimum PatchScore for a hit to be considered part of the hitlist. 

      [default: 0.0]

   .. oe:method:: GetSequenceCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            float GetSequenceCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetSequenceCutoff() -> float

      Maximum protein sequence similarity for a hit to be considered part of the hitlist.
      
      [default: 100.0]

   .. oe:method:: GetUseGPU

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseGPU() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseGPU() -> bool

      Flag to determine whether to use a GPU for prescreen as part of the search. This reduce the search time,
      but requires Linux and a compatible Nvidia GPU. See :ref:`GPU Prerequisites <sitehopper_search_gpu>`

   .. oe:method:: SetMaxHits

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxHits(unsigned int maxHits)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHits(value: int) -> bool

      Set maximum number of hits to return from the search. Very large hitlists can use a large amount of RAM.

      [default: 200]

   .. oe:method:: SetNCPU

      .. oe:api:: c++ java csharp
      
         void SetNCPU(unsigned int n)

      .. oe:api:: python
      
         SetNCPU(value: int) -> None

      Set maximum number of CPUs to use for search. Zero (0) implies use all available.

      [default: 0]

   .. oe:method:: SetNormalizeAndRescore

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetNormalizeAndRescore(bool state)

      .. oe:language:: python

         .. oe:api:: python

            SetNormalizeAndRescore(value: bool) -> bool

      Flag to determine whether patches of hit OEDesignUnits will be normalized to the
      surface area of the query patch and then rescored for the final hitlist.

      [default: false]

   .. oe:method:: SetScoreCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetScoreCutoff(float cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreCutoff(value: float) -> bool

      Minimum PatchScore for a hit to be considered part of the hitlist. 

      [default: 0.0]

   .. oe:method:: SetSequenceCutoff

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSequenceCutoff(float cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetSequenceCutoff(value: float) -> bool

      Maximum protein sequence similarity for a hit to be considered part of the hitlist.
      
      [default: 100.0]

   .. oe:method:: SetUseGPU

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseGPU() const

      .. oe:language:: python

         .. oe:api:: python

            SetUseGPU(value: bool) -> bool

      Flag to set whether to use a GPU for prescreen as part of the search. This reduces the search time,
      but requires Linux and a compatible Nvidia GPU. See :ref:`GPU Prerequisites <sitehopper_search_gpu>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESiteHopperSearchOptions &operator=(OESiteHopperSearchOptions &&)
         OESiteHopperSearchOptions &operator=(const OESiteHopperSearchOptions &)

      Assignment operator.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESiteHopperSearchOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OESiteHopperSearchOptions



.. _OESiteHopperConstants:

**********************
OESiteHopper Constants
**********************

.. oe:namespace:: OESiteHopper

.. toctree::

   OESiteHopperDatabaseMode


.. oe:namespace:: OESiteHopper

.. oe:constnamespace:: OESiteHopperDatabaseMode

   Control the mode when opening an OESiteHopperDatabase.

   .. oe:constant:: APPEND

      Opening in APPEND mode allows adding more OEDesignUnits to an existing
      database. OESiteHopperDatabaseOptions that are already stored in the 
      database will be used to create new patches.

      If the requested database file does not yet exist, this mode works
      like CREATE.

   .. oe:constant:: CREATE

      Create a new OESiteHopperDatabase file. If the file already exists it
      will be overwritten.

   .. oe:constant:: MAX

      The largest value in the namespace. Useful for verifying that a 
      given mode is valid. This mode is not valid for opening an OESiteHopperDatabase.

   .. oe:constant:: READONLY

      Open a OESiteHopperDatabase file in read-only mode. This is equivalent to
      SEARCH.

   .. oe:constant:: SEARCH

      Open a OESiteHopperDatabase file for searching. This is equivalent to
      READONLY.

   .. oe:constant:: UNDEFINED

      The lowest value in the namespace. Useful for verifying that a 
      given mode is valid. This mode is not valid for opening an OESiteHopperDatabase.



.. oe:namespace:: OESiteHopper

:orphan:

.. This API is intentionally undocumented.


.. oe:namespace:: OESiteHopper

.. oe:function:: OEAddPatchSurface

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool OEAddPatchSurface(OEBio::OEDesignUnit& du,
                                 const OESiteHopperPatchOptions opts = OESiteHopperPatchOptions())

    .. oe:language:: python

       .. oe:api:: python

          OEAddPatchSurface(du: OEDesignUnit,
                            opts: OESiteHopperPatchOptions = OESiteHopperPatchOptions()) -> bool

    Create the patch surface (as created inside
    :oe:cls:`OESiteHopper::OESiteHopperDatabase::Add`) and attach it to
    *du*. The design unit must have valid 3D atomic coordinates and atom
    types assigned. This function is not needed for database creation or
    searching, but is useful for visualization.



.. oe:namespace:: OESiteHopper

..  _OESiteHopper_OEGetPatchSurface:

.. oe:function:: OEGetPatchSurface

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool OEGetPatchSurface(OESpicoli::OESurface &,
                                 const OEBio::OEDesignUnit& du)

    .. oe:language:: python

       .. oe:api:: python

          OEGetPatchSurface(arg1: OESurface, du: OEDesignUnit) -> bool

    Get the patch surface (if attached) that is created by :oe:meth:`OESiteHopper::OEAddPatchSurface`.

.. oe:namespace:: OESiteHopper

.. oe:function:: OEHasPatchSurface
    
   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHasPatchSurface(const OEBio::OEDesignUnit& du)

   .. oe:language:: python

      .. oe:api:: python

         OEHasPatchSurface(du: OEDesignUnit) -> bool

   Verify the OEDesignUnit has a patch surface attached.

.. oe:namespace:: OESiteHopper

.. oe:function:: OEMakePatchFromDesignUnit

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool OEMakePatchFromDesignUnit(OEChem::OEMolBase& patch,
                                         const OEBio::OEDesignUnit& du,
                                         const OESiteHopperPatchOptions& opts = OESiteHopperPatchOptions())
          bool OEMakePatchFromDesignUnit(OEChem::OEMolBase& patch,
                                         OESpicoli::OESurface& outSurface,
                                         const OEBio::OEDesignUnit& du,
                                         const OESiteHopperPatchOptions& opts = OESiteHopperPatchOptions())

    .. oe:language:: python

       .. oe:api:: python

          OEMakePatchFromDesignUnit(patch: Union[OEGraphMol,OEMol,OEQMol],
                                    du: OEDesignUnit,
                                    opts: OESiteHopperPatchOptions = OESiteHopperPatchOptions()) -> bool
          OEMakePatchFromDesignUnit(patch: Union[OEGraphMol,OEMol,OEQMol],
                                    outSurface: OESurface, du: OEDesignUnit,
                                    opts: OESiteHopperPatchOptions = OESiteHopperPatchOptions()) -> bool

    Create a new SiteHopper patch from *du*. The design unit must have valid
    3D atomic coordinates and atom types assigned (as produced by Spruce TK
    protein preparation). This function is not normally called directly — it is
    invoked internally during database creation and at search time.

    Two overloads are available:

    * The first overload writes only the patch into *patch*.
    * The second overload additionally writes the patch surface (the
      Connolly-style molecular surface used for shape comparison) into
      *outSurface*, which is useful for visualization.

    *patch*

       Output molecule that receives the SiteHopper patch representation.

    *outSurface*

       Output surface that receives the patch surface geometry (second
       overload only).

    *du*

       The design unit from which the patch is generated.

    *opts*

       Patch generation options. Defaults to
       :oe:cls:`OESiteHopper::OESiteHopperPatchOptions`.

    Returns true on success.



.. oe:namespace:: OESiteHopper

.. oe:function:: OESetPatchSurface

    .. oe:language:: c++ java csharp

       .. oe:api::

          bool OESetPatchSurface(OEBio::OEDesignUnit& du,
                                 const OESpicoli::OESurface& surface)

    .. oe:language:: python

       .. oe:api:: python

          OESetPatchSurface(du: OEDesignUnit, surface: OESurface) -> bool

    Used by :oe:meth:`OESiteHopper::OEAddPatchSurface` to attach the surface
    to the OEDesignUnit.



.. oe:namespace:: OESiteHopper

.. oe:function:: OESetProteinSDData

    .. oe:language:: c++ java csharp

       .. oe:api::

          void OESetProteinSDData(OEBio::OEDesignUnit& du,
                                  const OESiteHopperScore& score)

    .. oe:language:: python

       .. oe:api:: python

          OESetProteinSDData(du: OEDesignUnit, score: OESiteHopperScore) -> None

    Set score values from *score* as SD data on the protein molecule inside
    *du*, making them available in the VIDA spreadsheet view. The following
    fields are written: patch score, color Tanimoto, shape Tanimoto, sequence
    similarity, and rank.

    .. seealso::

       * :oe:cls:`OESiteHopper::OESiteHopperScore`
       * :oe:func:`OESiteHopper::OEMakePatchFromDesignUnit`



.. _OESiteHopperFunctions:

**********************
OESiteHopper Functions
**********************

.. oe:namespace:: OESiteHopper

.. toctree::

   OEAddPatchSurface
   OEGetPatchSurface
   OEHasPatchSurface
   OEMakePatchFromDesignUnit
   OESetPatchSurface
   OESetProteinSDData
   OESiteHopperGetArch
   OESiteHopperGetLicensee
   OESiteHopperGetPlatform
   OESiteHopperGetRelease
   OESiteHopperGetSite
   OESiteHopperGetVersion
   OESiteHopperIsGPUReady
   OESiteHopperIsLicensed


.. oe:namespace:: OESiteHopper

.. oe:function:: OESiteHopperGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const  char* OESiteHopperGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OESiteHopperGetArch() -> str

   Returns the architecture of the current version of the SiteHopper
   toolkit. Examples include:

      - **microsoft-win64-x64**
      - **linux-x64**


.. oe:namespace:: OESiteHopper

.. oe:function:: OESiteHopperGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OESiteHopperGetLicensee()
         bool OESiteHopperGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OESiteHopperGetLicensee() -> str
         OESiteHopperGetLicensee(licensee: str) -> bool

   Returns the LICENSEE from the current valid SiteHopper TK license.

.. oe:namespace:: OESiteHopper

.. oe:function:: OESiteHopperGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const  char* OESiteHopperGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OESiteHopperGetPlatform() -> str

   Returns the platform, including compiler version, of the current
   version of the SiteHopper toolkit. Examples include:

      - **microsoft-win64-msvc17-x64**
      - **linux-g++7.x-x64**


.. oe:namespace:: OESiteHopper

.. oe:function:: OESiteHopperGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const  char* OESiteHopperGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OESiteHopperGetRelease() -> str

   Returns the version of this toolkit release. For example: ``1.6.1``.

.. oe:namespace:: OESiteHopper

.. oe:function:: OESiteHopperGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OESiteHopperGetSite()
         bool OESiteHopperGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OESiteHopperGetSite() -> str
         OESiteHopperGetSite(site: str) -> bool

   Returns the SITE from the current valid SiteHopper TK license.

.. oe:namespace:: OESiteHopper

.. oe:function:: OESiteHopperGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OESiteHopperGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OESiteHopperGetVersion() -> int

   Returns the build date of the toolkit as an unsigned int. For example: ``20210527``.

.. oe:namespace:: OESiteHopper

..  _OESiteHopper_OESiteHopperIsGPUReady:

.. oe:function:: OESiteHopperIsGPUReady

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESiteHopperIsGPUReady()

   .. oe:language:: python

      .. oe:api:: python

         OESiteHopperIsGPUReady() -> bool

   Returns true if :oe:cls:`OESiteHopper::OESiteHopperSearch::Search` can
   successfully use the GPU for prescreen search. Useful for checking whether
   the machine has an accelerator properly setup. It is guaranteed that if this
   function returns 'true' that all subsequent
   :oe:cls:`OESiteHopper::OESiteHopperSearch::Search` method can successfully
   execute queries. That means that this function will effectively initialize an
   underlying context that is re-used by
   :ref:`OESiteHopperSearch <OESiteHopper_OESiteHopperSearch>` objects, possibly grabbing an
   "exclusive process" lock:
   http://docs.nvidia.com/cuda/cuda-c-programming-guide/#compute-modes


.. oe:namespace:: OESiteHopper

.. oe:function:: OESiteHopperIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESiteHopperIsLicensed(const char* feature = 0,
                                     unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OESiteHopperIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **SiteHopper TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **SiteHopper TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **SiteHopper TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function

.. _oesitehopper_part_api:

********************************
Preliminary OESiteHopper API
********************************

.. toctree::
   :maxdepth: 2

   OESiteHopperClasses/OESiteHopperClasses
   OESiteHopperConstants/OESiteHopperConstants
   OESiteHopperFunctions/OESiteHopperFunctions


.. _sitehopper_part_examples:

******************************
Examples
******************************

.. toctree::
   :maxdepth: 3

   sitehopper_examples

.. _sitehopper_search_gpu:

.. program:: sitehopper_search


GPU-Related Requirements
========================

The following features are required in order to use GPU-accelerated OpenEye toolkits and applications.


Supported Platforms
-------------------

CUDA-enabled OpenEye software is only available on supported Linux platforms.
For supported Linux platforms see the `Platform Support Page <https://www.eyesopen.com/supported-platforms>`_.


Supported GPUs
-------------------

An NVIDIA `Tesla <http://www.nvidia.com/object/tesla-supercomputing-solutions.html>`_,
`Quadro <http://www.nvidia.com/object/workstation-solutions.html>`_, or
`GeForce <http://www.nvidia.com/object/geforce_family.html>`_ GPU with a **compute capability of 3.5
or higher** is required on your system. For a comprehensive table of compute capability
categories for each GPU, please refer to the `CUDA <https://en.wikipedia.org/wiki/CUDA>`_ Wikipedia page.


NVIDIA Drivers
-------------------

* **Minimum NVIDIA Driver version: 450.x**.

* CUDA is **not** required to be installed.

We recommend driver `450.80.02 <https://www.nvidia.com/Download/driverResults.aspx/165294/en-us>`_, and
we strongly advise manually downloading and installing the appropriate NVIDIA driver
for your system as opposed to using a package manager.

To install, root privilege is required. Follow these steps:

  #. Download the driver to the machine you are installing it on.
  #. ``chmod +x`` the driver package to make it executable.
  #. Ensure you have disabled X-server by killing any running sessions.
     Reboot may be required if X-server is still running after this step.
     
     .. warning::

        Disabling X-server requires different processes to be killed depending on your Linux
        distribution.
        See the `NVIDIA installation guide
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_ for more details.

     .. warning::

        The NVIDIA kernel module can often conflict with the open source
        Nouveau display drivers, depending on your specific Linux
        distribution. The NVIDIA documentation is a much more complete
        and up-to-date source for information on how to work around this issue.
        See `Disabling Nouveau
        <http://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile-nouveau>`_ on the NVIDIA website.

  #. Install the driver by ``sudo ./NVIDIA-Linux-x86_64-450.80.02.run`` and follow the step-by-step installation instructions.

  For more details on driver installations, see the `CUDA Installation Guide
  <https://docs.nvidia.com/cuda/cuda-installation-guide-linux/#runfile>`_

.. note::

  The output of the ``nvidia-smi`` command is extremely useful when
  debugging GPU issues. Please include the output from
  ``nvidia-smi`` in any request to support@eyesopen.com.


Performance Tuning
-------------------

To get the most performance out of an NVIDIA graphics card, use the persistence daemon to switch persistence mode
across all cards on the system (root privilege required)::

  sudo nvidia-persistenced --user foo

This will automatically enable persistence mode after reboot.

For full instructions on the persistence daemon, see the `Persistence daemon section
<https://docs.nvidia.com/deploy/driver-persistence/index.html#persistence-daemon>`_ of the NVIDIA docs.



.. sitehopper toolkit documentation master file

.. _sitehopper-toolkit-intro:

#######################################
Sitehopper Toolkit |sitehopper_version|
#######################################

.. attention::

   **Sitehopper TK** is currently only available in C++ and Python.

.. toctree::
   :maxdepth: 3

   introduction
   gpu_prereq
   examples
   api
   releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _oesitehopper_chapter_intro:

********************************************************************************
Introduction
********************************************************************************

The **SiteHopper TK** uses technology from the OpenEye **Shape TK** to compare 
protein binding sites using Shape and Color similarity.

There are two main classes in the toolkit.
:ref:`OESiteHopperDatabase <OESiteHopper_OESiteHopperDatabase>` can be used to search and prepare a set of
:ref:`OEDesignUnit <OEBio_OEDesignUnit>` for search. For each :ref:`OEDesignUnit <OEBio_OEDesignUnit>`,
:ref:`OESiteHopperDatabase <OESiteHopper_OESiteHopperDatabase>` creates a "patch" molecule generated by placing shape atoms
on the molecular surface of the binding site and color atoms on protein atoms
near the binding site.

Once the database is created, the :ref:`OESiteHopperSearch <OESiteHopper_OESiteHopperSearch>` class
can take a query :ref:`OEDesignUnit <OEBio_OEDesignUnit>` and return a set of similar :ref:`OEDesignUnit <OEBio_OEDesignUnit>` objects, each transformed
based on the optimized overlap and scored using a combination of the Shape and Color
Tanimoto calculated via the **Shape TK**.

If running on a Linux machine with a supported Nvidia GPU, the Search can use the
GPU to do a fast pre-screen to speed up the search. See the :ref:`GPU Prerequisites <sitehopper_search_gpu>`
section for more info on GPU requirements.



.. _sitehopper_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version2_1_4
   version2_1_3
   version2_1_2
   version2_1_1
   version2_1_0
   version2_0_4
   version2_0_3
   version2_0_2
   version2_0_1
   version2_0_0



SiteHopper TK 2.0.0
================================================================================

*Fall 2021*

This is the initial release of the **SiteHopper TK**.





Sitehopper TK 2.0.1
================================================================================

Python-specific changes
--------------------------------------------------------------------------------

* An issue with :ref:`OEGetPatchSurface <OESiteHopper_OEGetPatchSurface>` wrapping to Python was fixed.



Sitehopper TK 2.0.2
=========================

Minor internal improvements have been made.




Sitehopper TK 2.0.3
================================================================================

Minor internal improvements have been made.



Sitehopper TK 2.0.4
================================================================================

Minor internal improvements have been made.


SiteHopper TK 2.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* GPU-based **SiteHopper** is no longer used to prescreen but is enabled as a
  stand-alone search method.



SiteHopper TK 2.1.1
================================================================================

Minor bug fixes
--------------------------------------------------------------------------------

* The :ref:`OESiteHopperIsGPUReady <OESiteHopper_OESiteHopperIsGPUReady>` function has been safeguarded from a rare crash.



SiteHopper TK 2.1.2
================================================================================

Minor internal improvements have been made.




Sitehopper TK 2.1.3
================================================================================

Minor internal improvements have been made.



SiteHopper TK 2.1.4
================================================================================

Minor internal improvements have been made.



.. _sitehopper_examples:

SiteHopper Search
====================

Search a SiteHopper Database
------------------------------

.. oe:source:: sitehoppersearch.cpp
   :language: c++
   :caption:  Simple example to search a SiteHopper database
   :refnum:   1

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sitehoppersearch.cpp <../../../../sublibs/tklibs/sitehopper/examples/sitehoppersearch.cpp>`

.. oe:source:: sitehopper_search_example.py
   :language: python
   :caption:  Simple example to search a SiteHopper database
   :refnum:   1

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sitehopper_search_example.py <../../../../wrappers/python/examples/sitehopper/sitehopper_search_example.py>`

SiteHopper Database
====================

Creating a new Database
-----------------------

.. oe:source:: sitehopperbuild.cpp
   :language: c++
   :caption:  Simple example to create new SiteHopper database
   :refnum:   2

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sitehopperbuild.cpp <../../../../sublibs/tklibs/sitehopper/examples/sitehopperbuild.cpp>`

.. oe:source:: sitehopper_build_example.py
   :language: python
   :caption:  Simple example to create new SiteHopper database
   :refnum:   2

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sitehopper_build_example.py <../../../../wrappers/python/examples/sitehopper/sitehopper_build_example.py>`

Query database info
-----------------------

.. oe:source:: sitehopper_database_info.py
   :language: python
   :caption:  Simple example to print info from a SiteHopper database
   :refnum:   3

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sitehopper_database_info.py <../../../../wrappers/python/examples/sitehopper/sitehopper_database_info.py>`

Get an OEDesignUnit from database
-----------------------------------

.. oe:source:: sitehopper_get_designunit.py
   :language: python
   :caption:  Simple example to extract one or more OEDesignUnits from a SiteHopper database.
   :refnum:   4

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`sitehopper_get_designunit.py <../../../../wrappers/python/examples/sitehopper/sitehopper_get_designunit.py>`



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. attention::

      |TWOLANGUAGE|

.. _OESpruce_OEBioUnitExtractionOptions:

.. oe:class:: OEBioUnitExtractionOptions

   .. oe:api::

      class OEBioUnitExtractionOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for biounit extraction for use in the
   :oe:func:`OESpruce::OEExtractBioUnits` function.

   .. admonition:: Code Example

      * :ref:`spruce_examples_extract_biounits_ref` example
      * :ref:`spruce_examples_extract_biounits_remarks` example

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBioUnitExtractionOptions()
            OEBioUnitExtractionOptions(const OEBioUnitExtractionOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEBioUnitExtractionOptions() -> OEBioUnitExtractionOptions
            OEBioUnitExtractionOptions(arg2: OEBioUnitExtractionOptions) -> OEBioUnitExtractionOptions

      Default and copy constructor that constructs a `OEBioUnitExtractionOptions` object.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBioUnitExtractionOptions &operator=(const OEBioUnitExtractionOptions &)

      Assignment operator.

   .. oe:method:: GetMaxAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxAtoms() -> int

      Returns the maximum number of atoms for the extracted biounit.

   .. oe:method:: GetMaxParts

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxParts() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxParts() -> int

      Returns the maximum number of parts for a given transformation required to generate a biounit.

   .. oe:method:: GetMinScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMinScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinScore() -> int

      Returns the minimum score required for the biounit extraction's sequence alignment.

   .. oe:method:: GetPreferAuthorRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPreferAuthorRecord() const

      .. oe:language:: python

         .. oe:api:: python

            GetPreferAuthorRecord() -> bool

      Returns the boolean whether or not to prefer the author or software record for biounit extraction.

   .. oe:method:: GetSuperpose

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSuperpose() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuperpose() -> bool

      Returns the boolean whether or not to superpose the output biounit to the input reference structure.

.. _OESpruce_OEBioUnitExtractionOptions_SetMaxAtoms:

   .. oe:method:: SetMaxAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxAtoms(unsigned maxAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxAtoms(value: int) -> bool

      Sets the maximum number of atoms allowed for the extracted biounit.

.. _OESpruce_OEBioUnitExtractionOptions_SetMaxParts:

   .. oe:method:: SetMaxParts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxParts(unsigned maxParts)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxParts(value: int) -> bool

      Sets the maximum number of parts allowed for a given transformation required to generate a biounit.

.. _OESpruce_OEBioUnitExtractionOptions_SetMinScore:

   .. oe:method:: SetMinScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMinScore(const unsigned value)

      .. oe:language:: python

         .. oe:api:: python

            SetMinScore(value: int) -> bool

      Sets the minimum score required for the biounit extraction's sequence alignment.

.. _OESpruce_OEBioUnitExtractionOptions_SetPreferAuthorRecord:

   .. oe:method:: SetPreferAuthorRecord

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPreferAuthorRecord(bool preferAuthor)

      .. oe:language:: python

         .. oe:api:: python

            SetPreferAuthorRecord(value: bool) -> bool

      Sets the boolean of whether or not to prefer the author or software record for biounit extraction.

.. _OESpruce_OEBioUnitExtractionOptions_SetSuperpose:

   .. oe:method:: SetSuperpose

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSuperpose(bool superpose)

      .. oe:language:: python

         .. oe:api:: python

            SetSuperpose(value: bool) -> bool

      Sets the boolean whether or not to superpose the output biounit to the input reference structure.

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OECapBuilderOptions:

.. oe:class:: OECapBuilderOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OECapBuilderOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for building caps in the :oe:func:`OESpruce::OECapTermini`,
   :oe:func:`OESpruce::OECapCTermini`, and :oe:func:`OESpruce::OECapNTermini` functions.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECapBuilderOptions()
            OECapBuilderOptions(const OECapBuilderOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OECapBuilderOptions() -> OECapBuilderOptions
            OECapBuilderOptions(arg2: OECapBuilderOptions) -> OECapBuilderOptions

      Default and copy constructor that constructs a `OECapBuilderOptions` object.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECapBuilderOptions &operator=(const OECapBuilderOptions &)

      Assignment operator.

   .. _OESpruce_OECapBuilderOptions_GetDeleteClashingSolvent:

   .. oe:method:: GetDeleteClashingSolvent

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetDeleteClashingSolvent() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeleteClashingSolvent() -> bool

      Returns the boolean whether or not to delete solvent waters that clash with other atoms.

   .. _OESpruce_OECapBuilderOptions_GetAllowTruncate:

   .. oe:method:: GetAllowTruncate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAllowTruncate() const

      .. oe:language:: python

         .. oe:api:: python

            GetAllowTruncate() -> bool

      Returns the boolean whether or not it is okay to make a terminal residue the cap if building one would
      result in a clash, or if the backbone of the residue itself is incomplete

   .. _OESpruce_OECapBuilderOptions_GetForceCapping:

   .. oe:method:: GetForceCapping

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetForceCapping() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceCapping() -> bool

      Returns the boolean of whether or not to force caping in the event the cap would clash with something in the system

   .. _OESpruce_OECapBuilderOptions_SetDeleteClashingSolvent:

   .. oe:method:: SetDeleteClashingSolvent

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDeleteClashingSolvent(bool deleteClashingSolvent)

      .. oe:language:: python

         .. oe:api:: python

            SetDeleteClashingSolvent(value: bool) -> bool

      Sets the boolean of whether or not to delete solvent waters that clash with other atoms.

   .. _OESpruce_OECapBuilderOptions_SetAllowTruncate:

   .. oe:method:: SetAllowTruncate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAllowTruncate(bool allowTruncate)

      .. oe:language:: python

         .. oe:api:: python

            SetAllowTruncate(value: bool) -> bool

      Sets the boolean of whether or not it is okay to make a terminal residue the cap if building one would
      result in a clash, or if the backbone of the residue itself is incomplete

   .. _OESpruce_OECapBuilderOptions_SetForceCapping:

   .. oe:method:: SetForceCapping

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetForceCapping(bool forceCapping)

      .. oe:language:: python

         .. oe:api:: python

            SetForceCapping(value: bool) -> bool

      Sets the boolean of whether or not to force capping in the event the cap would clash with something in the system.
      This setting supersedes the settings for :oe:meth:`OESpruce::OECapBuilderOptions::GetAllowTruncate` and
      :oe:meth:`OESpruce::OECapBuilderOptions::GetDeleteClashingSolvent`.

.. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>` class
      * :oe:func:`OESpruce::OECapTermini` function
      * :oe:func:`OESpruce::OECapCTermini` function
      * :oe:func:`OESpruce::OECapNTermini` functions


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEDesignUnitBuildOptions:

.. oe:class:: OEDesignUnitBuildOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEDesignUnitBuildOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for building the missing structural components of a design unit for use in the :oe:cls:`OESpruce::OEMakeDesignUnitOptions` class.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDesignUnitBuildOptions()
            OEDesignUnitBuildOptions(const OEDesignUnitBuildOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEDesignUnitBuildOptions() -> OEDesignUnitBuildOptions
            OEDesignUnitBuildOptions(arg2: OEDesignUnitBuildOptions) -> OEDesignUnitBuildOptions

      Default and copy constructor that constructs a `OEDesignUnitBuildOptions` object.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDesignUnitBuildOptions &operator=(const OEDesignUnitBuildOptions &)

      Assignment operator.

   .. oe:method:: GetBuildLoops

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetBuildLoops() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildLoops() -> bool

      Returns the boolean whether or not to build loops.

   .. oe:method:: GetBuildSidechains

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetBuildSidechains() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildSidechains() -> bool

      Returns the boolean whether or not to build side chains.

   .. oe:method:: GetCapCTermini

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCapCTermini() const

      .. oe:language:: python

         .. oe:api:: python

            GetCapCTermini() -> bool

      Returns the boolean whether or not to cap all C-termini in the system with NME.

   .. oe:method:: GetCapNTermini

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCapNTermini() const

      .. oe:language:: python

         .. oe:api:: python

            GetCapNTermini() -> bool

      Returns the boolean whether or not to cap all N-termini in the system with ACE.

   .. oe:method:: GetSidechainBuilderOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESidechainBuilderOptions& GetSidechainBuilderOptions()
            const OESidechainBuilderOptions& GetSidechainBuilderOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSidechainBuilderOptions() -> OESidechainBuilderOptions

      Returns a reference to the stored sidechain builder options (:ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>`) class.

   .. oe:method:: GetLoopBuilderOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELoopBuilderOptions& GetLoopBuilderOptions()
            const OELoopBuilderOptions& GetLoopBuilderOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetLoopBuilderOptions() -> OELoopBuilderOptions

      Returns a reference to the stored loop builder options (:ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>`) class.

   .. oe:method:: GetCapBuilderOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECapBuilderOptions& GetCapBuilderOptions()
            const OECapBuilderOptions& GetCapBuilderOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetCapBuilderOptions() -> OECapBuilderOptions

      Returns a reference to the stored cap builder options (:ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>`) class.

.. _OESpruce_OEDesignUnitBuildOptions_SetBuildLoops:

   .. oe:method:: SetBuildLoops

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBuildLoops(bool buildLoops)

      .. oe:language:: python

         .. oe:api:: python

            SetBuildLoops(value: bool) -> bool

      Sets the boolean of whether or not to build loops.

.. _OESpruce_OEDesignUnitBuildOptions_SetBuildSidechains:

   .. oe:method:: SetBuildSidechains

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBuildSidechains(bool buildSidechains)

      .. oe:language:: python

         .. oe:api:: python

            SetBuildSidechains(value: bool) -> bool

      Sets the boolean of whether or not to build side chains.

.. _OESpruce_OEDesignUnitBuildOptions_SetCapCTermini:

   .. oe:method:: SetCapCTermini

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCapCTermini(bool capCTermini)

      .. oe:language:: python

         .. oe:api:: python

            SetCapCTermini(value: bool) -> bool

      Sets the boolean of whether or not to cap all C-termini in the system with NME.

.. _OESpruce_OEDesignUnitBuildOptions_SetCapNTermini:

   .. oe:method:: SetCapNTermini

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCapNTermini(bool capNTermini)

      .. oe:language:: python

         .. oe:api:: python

            SetCapNTermini(value: bool) -> bool

      Sets the boolean of whether or not to cap all N-termini in the system with ACE.

   .. oe:method:: SetSidechainBuilderOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSidechainBuilderOptions(const OESidechainBuilderOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetSidechainBuilderOptions(opts: OESidechainBuilderOptions) -> None

      Set the sidechain builder options class (:ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>`).

   .. oe:method:: SetCapBuilderOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetCapBuilderOptions(const OECapBuilderOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetCapBuilderOptions(opts: OECapBuilderOptions) -> None

      Set the cap builder options class (:ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>`).

   .. oe:method:: SetLoopBuilderOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLoopBuilderOptions(const OELoopBuilderOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetLoopBuilderOptions(opts: OELoopBuilderOptions) -> None

      Set the loop builder options class (:ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>`).

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class
      * :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>` class
      * :ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEDesignUnitEnumerateSitesOptions:

.. oe:class:: OEDesignUnitEnumerateSitesOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEDesignUnitEnumerateSitesOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for design unit binding site enumeration for use in the :oe:func:`OESpruce::OEEnumerateSites` function.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDesignUnitEnumerateSitesOptions()
            OEDesignUnitEnumerateSitesOptions(const OEDesignUnitEnumerateSitesOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEDesignUnitEnumerateSitesOptions() -> OEDesignUnitEnumerateSitesOptions
            OEDesignUnitEnumerateSitesOptions(arg2: OEDesignUnitEnumerateSitesOptions) -> OEDesignUnitEnumerateSitesOptions

      Default and copy constructor that constructs a `OEDesignUnitEnumerateSitesOptions` object.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDesignUnitEnumerateSitesOptions &operator=(const OEDesignUnitEnumerateSitesOptions &)

      Assignment operator.

   .. oe:method:: GetAddInteractionHints

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAddInteractionHints() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddInteractionHints() -> bool

      Returns the boolean whether or not to add interaction hints.

   .. oe:method:: GetAddStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAddStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddStyle() -> bool

      Returns the boolean whether or not to add style.

   .. oe:method:: GetCollapseNonSiteAlts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetCollapseNonSiteAlts() const

      .. oe:language:: python

         .. oe:api:: python

            GetCollapseNonSiteAlts() -> bool

      Returns the boolean whether or not to collapse non site alternate locations.

   .. oe:method:: GetDuplicateRemoval

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetDuplicateRemoval() const

      .. oe:language:: python

         .. oe:api:: python

            GetDuplicateRemoval() -> bool

      Returns the boolean whether or not to remove duplicate sites.

   .. oe:method:: GetEnumerateCofactorSites

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetEnumerateCofactorSites() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumerateCofactorSites() -> bool

      Returns the boolean whether or not to enumerate cofactor sites.

   .. oe:method:: GetRestrictToRefSite

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRestrictToRefSite() const

      .. oe:language:: python

         .. oe:api:: python

            GetRestrictToRefSite() -> bool

      Returns the boolean whether or not to restrict enumeration to the site of the reference structure.

   .. oe:method:: GetSiteSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSiteSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetSiteSize() -> float

      Returns the size of the site.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetAddInteractionHints:

   .. oe:method:: SetAddInteractionHints

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAddInteractionHints(bool addInteractions)

      .. oe:language:: python

         .. oe:api:: python

            SetAddInteractionHints(value: bool) -> bool

      Sets the boolean whether or not to add interactions.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetAddStyle:

   .. oe:method:: SetAddStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAddStyle(bool addStyle)

      .. oe:language:: python

         .. oe:api:: python

            SetAddStyle(value: bool) -> bool

      Sets the boolean whether or not to add style.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetCollapseNonSiteAlts:

   .. oe:method:: SetCollapseNonSiteAlts

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCollapseNonSiteAlts(bool collapseNonSiteAlts)

      .. oe:language:: python

         .. oe:api:: python

            SetCollapseNonSiteAlts(value: bool) -> bool

      Sets the boolean whether or not to collapse non site alternate locations.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetDuplicateRemoval:

   .. oe:method:: SetDuplicateRemoval

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDuplicateRemoval(bool duplicateRemoval)

      .. oe:language:: python

         .. oe:api:: python

            SetDuplicateRemoval(value: bool) -> bool

      Sets the boolean whether or not to remove duplicate sites.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetEnumerateCofactorSites:

   .. oe:method:: SetEnumerateCofactorSites

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetEnumerateCofactorSites(bool enumCofactorSites)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumerateCofactorSites(value: bool) -> bool

      Sets the boolean whether or not to enumerate cofactor sites.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetRestrictToRefSite:

   .. oe:method:: SetRestrictToRefSite

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRestrictToRefSite(bool restrictToRefSite)

      .. oe:language:: python

         .. oe:api:: python

            SetRestrictToRefSite(value: bool) -> bool

      Sets the boolean whether or not to restrict enumeration to the reference site.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetSiteSize:

   .. oe:method:: SetSiteSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSiteSize(double siteSize)

      .. oe:language:: python

         .. oe:api:: python

            SetSiteSize(value: float) -> bool

      Sets the size of the site.

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEDesignUnitMutationOptions:

.. oe:class:: OEDesignUnitMutationOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEDesignUnitMutationOptions : public OESystem::OEOptions

   This class stores the optional parameter sets used in design unit mutation for use in the :oe:func:`OESpruce::OEMutateResidues` function.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDesignUnitMutationOptions()
            OEDesignUnitMutationOptions(const OEDesignUnitMutationOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEDesignUnitMutationOptions() -> OEDesignUnitMutationOptions
            OEDesignUnitMutationOptions(arg2: OEDesignUnitMutationOptions) -> OEDesignUnitMutationOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDesignUnitMutationOptions &operator=(const OEDesignUnitMutationOptions &)

      Assignment operator.

   .. oe:method:: AddMutation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddMutation(const OEChem::OEResidue mutationRes,
                             const unsigned targetIdx)

      .. oe:language:: python

         .. oe:api:: python

            AddMutation(mutationRes: OEResidue, targetIdx: int) -> None

      Adds a mutation to make based on an input :ref:`OEResidue <OEChem_OEResidue>` object, along with a constant representing the target component which is taken from the :oe:constns:`OEBio::OEDesignUnitComponents` namespace.

   .. oe:method:: ClearMutations

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearMutations()

      .. oe:language:: python

         .. oe:api:: python

            ClearMutations() -> None

      Clears all mutations.

   .. oe:method:: GetMutations

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::map<OEChem::OEResidue, unsigned> GetMutations() const

      .. oe:language:: python

         .. oe:api:: python

            GetMutations() -> mapOEResidueUnsigned

      Returns the stored `std::map` of mutations, which is keyed on an :ref:`OEResidue <OEChem_OEResidue>` object with a value of the target component which is taken from the :oe:constns:`OEBio::OEDesignUnitComponents` namespace.

   .. oe:method:: SetMutations

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMutations(const std::map<OEChem::OEResidue, unsigned>& mutations)

      .. oe:language:: python

         .. oe:api:: python

            SetMutations(mutations: mapOEResidueUnsigned) -> None

      Sets the stored `std::map` of mutations, which is keyed on an :ref:`OEResidue <OEChem_OEResidue>` object with a value of the target component which is taken from the :oe:constns:`OEBio::OEDesignUnitComponents` namespace.

   .. seealso::

      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEDesignUnitPrepOptions:

.. oe:class:: OEDesignUnitPrepOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEDesignUnitPrepOptions : public OESystem::OEOptions

   This class stores the optional parameter sets used in design unit preparation for use in the :oe:cls:`OESpruce::OEMakeDesignUnitOptions` class.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDesignUnitPrepOptions()
            OEDesignUnitPrepOptions(const OEDesignUnitPrepOptions &)
            OEDesignUnitPrepOptions(const OEDesignUnitBuildOptions& buildOpts,
                                    const OESpruce::OEProtonateDesignUnitOptions& protonateOpts,
                                    const OEDesignUnitEnumerateSitesOptions& enumOpts)

      .. oe:language:: python

         .. oe:api:: python

            OEDesignUnitPrepOptions() -> OEDesignUnitPrepOptions
            OEDesignUnitPrepOptions(buildOpts: OEDesignUnitBuildOptions,
                                    protonateOpts: OEProtonateDesignUnitOptions,
                                    enumOpts: OEDesignUnitEnumerateSitesOptions) -> OEDesignUnitPrepOptions
            OEDesignUnitPrepOptions(arg2: OEDesignUnitPrepOptions) -> OEDesignUnitPrepOptions

      Default, copy, and advanced constructor that constructs a `OEDesignUnitPrepOptions` object. The advanced constructor take three separate sub-options classes as arguments: an options class that controls prep (:ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>`), an options class that controls the building options (:ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>`), and an options class that controls alternate location handling (:ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>`).

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDesignUnitPrepOptions &operator=(const OEDesignUnitPrepOptions &)

      Assignment operator.

   .. oe:method:: GetAssignPartialChargesAndRadii

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAssignPartialChargesAndRadii() const

      .. oe:language:: python

         .. oe:api:: python

            GetAssignPartialChargesAndRadii() -> bool

      Returns the boolean whether or not to assign partial charges and radii.

   .. oe:method:: GetBuildOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDesignUnitBuildOptions& GetBuildOptions()
            const OEDesignUnitBuildOptions& GetBuildOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildOptions() -> OEDesignUnitBuildOptions

      Returns a reference to the stored build options (:ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>`) class.

   .. oe:method:: GetChargeEngine

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEProton::OEDesignUnitCharges& GetChargeEngine()

      .. oe:language:: python

         .. oe:api:: python

            GetChargeEngine() -> OEDesignUnitCharges

      Returns a reference to the stored charge engine (:ref:`OEDesignUnitCharges <OEProton_OEDesignUnitCharges>`) class.

   .. oe:method:: GetEnumerateSitesOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDesignUnitEnumerateSitesOptions& GetEnumerateSitesOptions()
            const OEDesignUnitEnumerateSitesOptions& GetEnumerateSitesOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumerateSitesOptions() -> OEDesignUnitEnumerateSitesOptions

      Returns a reference to the stored design unit site enumeration options (:ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>`) class.

   .. oe:method:: GetProtonate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetProtonate() const

      .. oe:language:: python

         .. oe:api:: python

            GetProtonate() -> bool

      Returns the boolean of whether or not to protonate the design unit.

   .. oe:method:: GetStrictProtonationMode

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStrictProtonationMode() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrictProtonationMode() -> bool

      Returns the boolean of whether to fail design unit preparation if the protonation stage fails

   .. oe:method:: GetProtonateOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESpruce::OEProtonateDesignUnitOptions& GetProtonateOptions()
            const OESpruce::OEProtonateDesignUnitOptions& GetProtonateOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetProtonateOptions() -> OEProtonateDesignUnitOptions

      Returns a reference to the stored design unit protonation options (:ref:`OEProtonateDesignUnitOptions <OESpruce_OEProtonateDesignUnitOptions>`) class.

.. _OESpruce_OEDesignUnitPrepOptions_SetAssignPartialChargesAndRadii:

   .. oe:method:: SetAssignPartialChargesAndRadii

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAssignPartialChargesAndRadii(bool assignPartialChargesAndRadii)

      .. oe:language:: python

         .. oe:api:: python

            SetAssignPartialChargesAndRadii(value: bool) -> bool

      Sets the boolean of whether or not to assign partial charges and radii.

   .. oe:method:: SetBuildOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBuildOptions(const OEDesignUnitBuildOptions& buildOpts)

      .. oe:language:: python

         .. oe:api:: python

            SetBuildOptions(opts: OEDesignUnitBuildOptions) -> None

      Sets the design unit building options class (:ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>`).

   .. oe:method:: SetChargeEngine

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetChargeEngine(OEProton::OEDesignUnitCharges chargeEngine)

      .. oe:language:: python

         .. oe:api:: python

            SetChargeEngine(chargeEngine: OEDesignUnitCharges) -> None

      Sets the charging engine when charges are added (:ref:`OEDesignUnitCharges <OEProton_OEDesignUnitCharges>`).

   .. oe:method:: SetEnumerateSitesOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetEnumerateSitesOptions(const OEDesignUnitEnumerateSitesOptions& enumOpts)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumerateSitesOptions(opts: OEDesignUnitEnumerateSitesOptions) -> None

      Sets the design unit site enumeration options class (:ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>`).

.. _OESpruce_OEDesignUnitPrepOptions_SetProtonate:

   .. oe:method:: SetProtonate

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetProtonate(const bool protonate)

      .. oe:language:: python

         .. oe:api:: python

            SetProtonate(value: bool) -> bool

      Sets the boolean of whether or not to protonate the design unit.

   .. oe:method:: SetStrictProtonationMode

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStrictProtonationMode(bool strictProtonate)

      .. oe:language:: python

         .. oe:api:: python

            SetStrictProtonationMode(value: bool) -> bool

      Sets the boolean of whether or not to fail design unit preparation if the protonation stage fails

   .. oe:method:: SetProtonateOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetProtonateOptions(const OESpruce::OEProtonateDesignUnitOptions& protonateOpts)

      .. oe:language:: python

         .. oe:api:: python

            SetProtonateOptions(opts: OEProtonateDesignUnitOptions) -> None

      Sets the design unit protonation options class (:ref:`OEProtonateDesignUnitOptions <OESpruce_OEProtonateDesignUnitOptions>`).

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEDesignUnitCharges <OEProton_OEDesignUnitCharges>` class
      * :ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>` class
      * :ref:`OEProtonateDesignUnitOptions <OESpruce_OEProtonateDesignUnitOptions>` class
      * :ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>` class
      * :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>` class
      * :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>` class
      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class
      * :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>` class
      * :ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEDesignUnitSplitOptions:

.. oe:class:: OEDesignUnitSplitOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEDesignUnitSplitOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for splitting a structure into design unit components for use in the :oe:cls:`OESpruce::OEMakeDesignUnitOptions` class.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDesignUnitSplitOptions()
            OEDesignUnitSplitOptions(const OEDesignUnitSplitOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEDesignUnitSplitOptions() -> OEDesignUnitSplitOptions
            OEDesignUnitSplitOptions(arg2: OEDesignUnitSplitOptions) -> OEDesignUnitSplitOptions

      Default and copy constructor that constructs a `OEDesignUnitSplitOptions` object.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEDesignUnitSplitOptions &operator=(const OEDesignUnitSplitOptions &)

      Assignment operator.

   .. _OESpruce_OEDesignUnitSplitOptions_AddCofactorCode:

   .. oe:method:: AddCofactorCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddCofactorCode(const std::string argValue)

      .. oe:language:: python

         .. oe:api:: python

            AddCofactorCode(addCode: str) -> None

      Explicitly sets the name of the molecule(s) to be considered a cofactor.

   .. _OESpruce_OEDesignUnitSplitOptions_AddExcipientCode:

   .. oe:method:: AddExcipientCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddExcipientCode(const std::string argValue)

      .. oe:language:: python

         .. oe:api:: python

            AddExcipientCode(addCode: str) -> None

      Explicitly sets the name of the molecule(s) to be considered an excipient.

   .. _OESpruce_OEDesignUnitSplitOptions_AddLipidCode:

   .. oe:method:: AddLipidCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddLipidCode(const std::string argValue)

      .. oe:language:: python

         .. oe:api:: python

            AddLipidCode(addCode: str) -> None

      Explicitly sets the name of the molecule(s) to be considered an lipid.

   .. _OESpruce_OEDesignUnitSplitOptions_ClearCofactorCodes:

   .. oe:method:: ClearCofactorCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearCofactorCodes()

      .. oe:language:: python

         .. oe:api:: python

            ClearCofactorCodes() -> None

      Removes the name(s) of the molecules considered to be cofactors.

   .. _OESpruce_OEDesignUnitSplitOptions_ClearExcipientCodes:

   .. oe:method:: ClearExcipientCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearExcipientCodes()

      .. oe:language:: python

         .. oe:api:: python

            ClearExcipientCodes() -> None

      Removes the name(s) of the molecules considered to be excipients.

   .. _OESpruce_OEDesignUnitSplitOptions_ClearLipidCodes:

   .. oe:method:: ClearLipidCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearLipidCodes()

      .. oe:language:: python

         .. oe:api:: python

            ClearLipidCodes() -> None

      Removes the name(s) of the molecules considered to be lipids.

   .. _OESpruce_OEDesignUnitSplitOptions_GetAlternateLocationHandling:

   .. oe:method:: GetAlternateLocationHandling

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetAlternateLocationHandling() const

      .. oe:language:: python

         .. oe:api:: python

            GetAlternateLocationHandling() -> int

      Returns the value of the alternate location handling mode, which is given by the :oe:constns:`OESpruce::OEAlternateLocationOption` namespace.

   .. _OESpruce_OEDesignUnitSplitOptions_GetCofactorCodes:

   .. oe:method:: GetCofactorCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetCofactorCodes() const

      .. oe:language:: python

         .. oe:api:: python

            GetCofactorCodes() -> OEStringVector

      Returns a reference to the vector of the name(s) of the molecule(s) considered to be cofactors.

   .. _OESpruce_OEDesignUnitSplitOptions_GetExcipientCodes:

   .. oe:method:: GetExcipientCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetExcipientCodes() const

      .. oe:language:: python

         .. oe:api:: python

            GetExcipientCodes() -> OEStringVector

      Returns a reference to the stored vector of strings representing names of molecules that should be considered excipients.

   .. _OESpruce_OEDesignUnitSplitOptions_GetLipidCodes:

   .. oe:method:: GetLipidCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetLipidCodes() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipidCodes() -> OEStringVector

      Returns a reference to the stored vector of strings representing names of molecules that should be considered lipids.

   .. _OESpruce_OEDesignUnitSplitOptions_GetMakePackingResidues:

   .. oe:method:: GetMakePackingResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMakePackingResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetMakePackingResidues() -> bool

      Returns the boolean whether or not to make packing residues.

   .. _OESpruce_OEDesignUnitSplitOptions_GetMaxLigAtoms:

   .. oe:method:: GetMaxLigAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxLigAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxLigAtoms() -> int

      Returns the maximum number of atoms for a molecule to still be considered a ligand.

   .. _OESpruce_OEDesignUnitSplitOptions_GetMaxLigResidues:

   .. oe:method:: GetMaxLigResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxLigResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxLigResidues() -> int

      Returns the maximum number of residues for a molecule to still be considered a ligand.

   .. _OESpruce_OEDesignUnitSplitOptions_GetMaxSystemAtoms:

   .. oe:method:: GetMaxSystemAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxSystemAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSystemAtoms() -> int

      Returns the maximum number of atoms for a system to be split.

   .. _OESpruce_OEDesignUnitSplitOptions_GetMinLigAtoms:

   .. oe:method:: GetMinLigAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMinLigAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinLigAtoms() -> int

      Returns the minimum number of atoms for a molecule to still be considered a ligand.

   .. _OESpruce_OEDesignUnitSplitOptions_GetTargetComponentID:

   .. oe:method:: GetTargetComponentID

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetTargetComponentID() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetComponentID() -> int

      Returns the constant of the target component, which is taken from the :oe:constns:`OEBio::OEDesignUnitComponents` namespace.

   .. _OESpruce_OEDesignUnitSplitOptions_SetAlternateLocationHandling:

   .. oe:method:: SetAlternateLocationHandling

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAlternateLocationHandling(unsigned altLocHandling)

      .. oe:language:: python

         .. oe:api:: python

            SetAlternateLocationHandling(value: int) -> bool

      Sets the constant that controls how alternate location enumeration will be handled, which is taken from the :oe:constns:`OESpruce::OEAlternateLocationOption` namespace.

   .. _OESpruce_OEDesignUnitSplitOptions_SetCofactorCodes:

   .. oe:method:: SetCofactorCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCofactorCodes(const std::vector<std::string>& argValue)

      .. oe:language:: python

         .. oe:api:: python

            SetCofactorCodes(value: OEStringVector) -> bool

      Sets the vector of strings representing names of molecules that should be considered cofactors.

   .. _OESpruce_OEDesignUnitSplitOptions_SetExcipientCodes:

   .. oe:method:: SetExcipientCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetExcipientCodes(const std::vector<std::string>& argValue)

      .. oe:language:: python

         .. oe:api:: python

            SetExcipientCodes(value: OEStringVector) -> bool

      Sets the vector of strings representing names of molecules that should be considered excipients.

   .. _OESpruce_OEDesignUnitSplitOptions_SetLipidCodes:

   .. oe:method:: SetLipidCodes

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLipidCodes(const std::vector<std::string>& argValue)

      .. oe:language:: python

         .. oe:api:: python

            SetLipidCodes(value: OEStringVector) -> bool

      Sets the vector of strings representing names of molecules that should be considered lipids.

   .. _OESpruce_OEDesignUnitSplitOptions_SetMakePackingResidues:

   .. oe:method:: SetMakePackingResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMakePackingResidues(bool makePackingResidues)

      .. oe:language:: python

         .. oe:api:: python

            SetMakePackingResidues(value: bool) -> bool

      Sets the boolean of whether or not to make a packing residue component.

   .. _OESpruce_OEDesignUnitSplitOptions_SetMaxLigAtoms:

   .. oe:method:: SetMaxLigAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxLigAtoms(unsigned maxLigAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxLigAtoms(value: int) -> bool

      Sets the maximum number of atoms for a molecule to be considered a ligand.

   .. _OESpruce_OEDesignUnitSplitOptions_SetMaxLigResidues:

   .. oe:method:: SetMaxLigResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxLigResidues(unsigned maxLigResidues)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxLigResidues(value: int) -> bool

      Sets the maximum number of residues for a molecule to be considered a ligand.

   .. _OESpruce_OEDesignUnitSplitOptions_SetMaxSystemAtoms:

   .. oe:method:: SetMaxSystemAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxSystemAtoms(unsigned maxSystemAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxSystemAtoms(value: int) -> bool

      Sets the maximum number of atoms for a system to be split.

   .. _OESpruce_OEDesignUnitSplitOptions_SetMinLigAtoms:

   .. oe:method:: SetMinLigAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMinLigAtoms(unsigned minLigAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetMinLigAtoms(value: int) -> bool

      Sets the minimum number of atoms for a molecule to be considered a ligand.

   .. _OESpruce_OEDesignUnitSplitOptions_SetTargetComponentID:

   .. oe:method:: SetTargetComponentID

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTargetComponentID(unsigned targetCompID)

      .. oe:language:: python

         .. oe:api:: python

            SetTargetComponentID(value: int) -> bool

      Sets the constant of the target component, which is taken from the :oe:constns:`OEBio::OEDesignUnitComponents` namespace.

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEHeterogenMetadata:

.. oe:class:: OEHeterogenMetadata

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEHeterogenMetadata

   This class stores metadata for a heterogen molecule, including its title, ID,
   SMILES representation, heterogen type (as defined in the
   :oe:constns:`OESpruce::OEHeterogenType` namespace), and any user-specified
   tautomers. A map of ``OEHeterogenMetadata`` objects keyed by SMILES can be
   passed to :oe:func:`OESpruce::OEProtonateDesignUnit` to guide protonation of
   specific heterogen components.
   
   The title is the string used to map to the name in the molecule file, 
   historically a 3-character string in PDB file format e.g. LIG, 5HA (from wwPDB 3TPP), 
   but can now be a 5 character string using the new mmCIF format 
   and updated wwPDB conventions.
   
   The ID is meant for users who want to then title the ligand molecule, the 
   ligand name in the design unit title and output design unit filenames with 
   an internal compound ID, e.g. "OE-000123".

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHeterogenMetadata()
            OEHeterogenMetadata(const OEHeterogenMetadata &)

      .. oe:language:: python

         .. oe:api:: python

            OEHeterogenMetadata() -> OEHeterogenMetadata
            OEHeterogenMetadata(arg2: OEHeterogenMetadata) -> OEHeterogenMetadata

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHeterogenMetadata &operator=(const OEHeterogenMetadata &)

      Assignment operator.

   .. oe:method:: AddTautomer

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddTautomer(const std::string& tautomer)

      .. oe:language:: python

         .. oe:api:: python

            AddTautomer(tautomer: str) -> None

      Add a tautomer using a Smiles string.

   .. oe:method:: AddTautomers

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddTautomers(const std::vector<std::string>& tautomers)

      .. oe:language:: python

         .. oe:api:: python

            AddTautomers(tautomers: OEStringVector) -> None

      Add a set of tautomers of the ligand using a `std::vector` of Smiles strings.

   .. oe:method:: ClearTautomers

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearTautomers()

      .. oe:language:: python

         .. oe:api:: python

            ClearTautomers() -> None

      Clears all tautomer strings.

   .. oe:method:: GetID

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetID() const

      .. oe:language:: python

         .. oe:api:: python

            GetID() -> str

      Returns the stored ID string for the ligand.

   .. oe:method:: GetSmiles

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetSmiles() const

      .. oe:language:: python

         .. oe:api:: python

            GetSmiles() -> str

      Returns the stored Smiles string for the ligand.

   .. oe:method:: GetTautomers

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string>& GetTautomers()
            const std::vector<std::string>& GetTautomers() const

      .. oe:language:: python

         .. oe:api:: python

            GetTautomers() -> OEStringVector

      Returns a reference of the set of stored tautomers for the ligand.

   .. oe:method:: GetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Returns the ligand's title.

   .. oe:method:: GetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetType() const

      .. oe:language:: python

         .. oe:api:: python

            GetType() -> int

      Returns the type of heterogen of the ligand as defined in the :oe:constns:`OESpruce::OEHeterogenType` namespace.

   .. oe:method:: SetID

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetID(const std::string id)

      .. oe:language:: python

         .. oe:api:: python

            SetID(id: str) -> None

      Sets a string of the ligand's ID.

   .. oe:method:: SetSmiles

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSmiles(const std::string smiles)

      .. oe:language:: python

         .. oe:api:: python

            SetSmiles(smiles: str) -> None

      Sets the Smiles string for the ligand.

   .. oe:method:: SetTitle

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetTitle(const std::string title)

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(title: str) -> None

      Sets the ligand's title.

   .. oe:method:: SetType

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetType(const unsigned type)

      .. oe:language:: python

         .. oe:api:: python

            SetType(type: int) -> None

      Sets the type of heterogen of the ligand as defined in the :oe:constns:`OESpruce::OEHeterogenType` namespace.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEIsModeledAtom:

.. oe:class:: OEIsModeledAtom

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEIsModeledAtom : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This predicate is used to identify atoms that have been built using
   **Spruce TK** either by capping terminal residues, building out
   partial residues, or by mutating a residue. Otherwise it returns ``false``.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsModeledAtom()

      .. oe:language:: python

         .. oe:api:: python

            OEIsModeledAtom() -> OEIsModeledAtom

      Default constructor.

   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``  if the atom has been built using
      **Spruce TK** either by capping terminal residues, building out
      partial residues, or by mutating a residue.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsModeledAtom

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsModeledAtom <OESpruce_OEIsModeledAtom>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. seealso::

      * :oe:func:`OESpruce::OECapTermini` function
      * :oe:func:`OESpruce::OECapCTermini` function
      * :oe:func:`OESpruce::OECapNTermini` function
      * :oe:func:`OESpruce::OEBuildSidechains` function
      * :oe:func:`OESpruce::OEMutateResidue` function



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OELoopBuilderOptions:

.. oe:class:: OELoopBuilderOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OELoopBuilderOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for building loops in the :oe:func:`OESpruce::OEBuildLoops` and
   :oe:func:`OESpruce::OEBuildSingleLoop` functions.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OELoopBuilderOptions()
            OELoopBuilderOptions(const OELoopBuilderOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OELoopBuilderOptions() -> OELoopBuilderOptions
            OELoopBuilderOptions(arg2: OELoopBuilderOptions) -> OELoopBuilderOptions

      Default and copy constructor that constructs a `OELoopBuilderOptions` object.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OELoopBuilderOptions &operator=(const OELoopBuilderOptions &)

      Assignment operator.

   .. _OESpruce_OELoopBuilderOptions_GetLoopDBFilename:

   .. oe:method:: GetLoopDBFilename

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetLoopDBFilename() const

      .. oe:language:: python

         .. oe:api:: python

            GetLoopDBFilename() -> str

      Returns the filename of the loop database used when searching for compatible loops.

   .. _OESpruce_OELoopBuilderOptions_GetUsePackingResidues:

   .. oe:method:: GetUsePackingResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUsePackingResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetUsePackingResidues() -> bool

      Returns the boolean whether or not to use crystal packing residues during loop modeling (if available).

   .. _OESpruce_OELoopBuilderOptions_GetCropLength:

   .. oe:method:: GetCropLength

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetCropLength() const

      .. oe:language:: python

         .. oe:api:: python

            GetCropLength() -> int

      Returns the number of residues on either side of a gap to remove, since these are known to sometimes be poorly resolved and
      therefore have configurations that make it difficult to build loops.

   .. _OESpruce_OELoopBuilderOptions_GetTransformThreshold:

   .. oe:method:: GetTransformThreshold

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetTransformThreshold() const

      .. oe:language:: python

         .. oe:api:: python

            GetTransformThreshold() -> int

      Returns the number of loops from the database to transform, meaning mutate from their database sequence to target sequence,
      if they are not 100% sequence matching. Structures with 100% sequence match are not affected by this threshold.

   .. _OESpruce_OELoopBuilderOptions_GetStrictProlineMatch:

   .. oe:method:: GetStrictProlineMatch

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStrictProlineMatch() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrictProlineMatch() -> bool

      Returns the boolean of whether or not fuzzy sequence matches have to have proline residues in the correct position. This
      can be relevant since they have a different backbone conformation than other amino acid residues.

   .. _OESpruce_OELoopBuilderOptions_GetConnectBufferDistance:

   .. oe:method:: GetConnectBufferDistance

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetConnectBufferDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetConnectBufferDistance() -> float

      Returns the buffer distance allowed between the anchor atoms (connection points) when searching for fuzzy sequence matches.

   .. _OESpruce_OELoopBuilderOptions_GetBackboneClashRejectThreshold:

   .. oe:method:: GetBackboneClashRejectThreshold

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBackboneClashRejectThreshold() const

      .. oe:language:: python

         .. oe:api:: python

            GetBackboneClashRejectThreshold() -> float

      Returns the threshold of clashing backbone atoms. If the clash level is above this threshold a loop from the database is rejected,
      and is not processed further.

   .. _OESpruce_OELoopBuilderOptions_GetDeleteExistingResidues:

   .. oe:method:: GetDeleteExistingResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetDeleteExistingResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeleteExistingResidues() -> bool

      Returns whether or not to delete residues already present at site where new loops needs to be built.

   .. _OESpruce_OELoopBuilderOptions_GetLoopClashRejectThreshold:

   .. oe:method:: GetLoopClashRejectThreshold

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLoopClashRejectThreshold() const

      .. oe:language:: python

         .. oe:api:: python

            GetLoopClashRejectThreshold() -> float

      Returns the threshold of clashing loops atoms. This threshold excludes already considered clashing backbone atoms. If the clash level is above this threshold a loop from the database is rejected,
      and is not processed further.

   .. _OESpruce_OELoopBuilderOptions_GetOptimizationShell:

   .. oe:method:: GetOptimizationShell

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetOptimizationShell() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationShell() -> float

      Returns the radius of atoms being considered when minimizing the loops in place. Since multiple loops are being optimized,
      it is the union of atoms inside the radius around each starting loop configuration that is considered. This allows comparison of
      the energies between each loop conformation as the systems are of identical size.

   .. _OESpruce_OELoopBuilderOptions_GetOptimizationTolerance:

   .. oe:method:: GetOptimizationTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetOptimizationTolerance() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationTolerance() -> float

      Returns the tolerance used by the optimizer.

   .. _OESpruce_OELoopBuilderOptions_GetOptimizationStage1IterMultiplier:

   .. oe:method:: GetOptimizationStage1IterMultiplier

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetOptimizationStage1IterMultiplier() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationStage1IterMultiplier() -> int

      Returns the multiplier of optimization steps per residue in the loop used during the initial steepest descent optimization.

  .. _OESpruce_OELoopBuilderOptions_GetOptimizationStage2IterMultiplier:

  .. oe:method:: GetOptimizationStage2IterMultiplier

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetOptimizationStage2IterMultiplier() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationStage2IterMultiplier() -> int

      Returns the multiplier of optimization steps per residue in the loop used during the secondary BFGS optimization.

  .. _OESpruce_OELoopBuilderOptions_GetOptimizationUseSolventModel:

  .. oe:method:: GetOptimizationUseSolventModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetOptimizationUseSolventModel() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationUseSolventModel() -> bool

      Returns whether or not to use a simplistic solvent model during the loop optimization.

  .. _OESpruce_OELoopBuilderOptions_GetOptimizationInclSurfaceAreaTerm:

  .. oe:method:: GetOptimizationInclSurfaceAreaTerm

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetOptimizationInclSurfaceAreaTerm() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationInclSurfaceAreaTerm() -> bool

      Returns whether or not to include the surface area term when scoring the loops after optimization.

  .. _OESpruce_OELoopBuilderOptions_GetOptimizationMaxLoops:

  .. oe:method:: GetOptimizationMaxLoops

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetOptimizationMaxLoops() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationMaxLoops() -> int

      Returns the number of loops to optimize, the higher the number the longer the calculation will take, but also includes more structural diversity.

  .. _OESpruce_OELoopBuilderOptions_GetAllowBuildDisulfideBridges:

  .. oe:method:: GetAllowBuildDisulfideBridges

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAllowBuildDisulfideBridges() const

      .. oe:language:: python

         .. oe:api:: python

            GetAllowBuildDisulfideBridges() -> bool

      Returns whether or not to allow building disulfide bridges between the loop and the protein if possible, requires cystine residues in proximity.

  .. _OESpruce_OELoopBuilderOptions_GetRejectClashingLoopsPostMinimization:

  .. oe:method:: GetRejectClashingLoopsPostMinimization

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRejectClashingLoopsPostMinimization() const

      .. oe:language:: python

         .. oe:api:: python

            GetRejectClashingLoopsPostMinimization() -> bool

      Returns whether or not to reject clashing loops post-minimization.

  .. _OESpruce_OELoopBuilderOptions_GetSeqAlignMethod:

  .. oe:method:: GetSeqAlignMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetSeqAlignMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetSeqAlignMethod() -> int

      Returns the sequence alignment method, from the :oe:const:`OEBio::OESeqAlignmentMethod` namespace, used to compare the provided sequence and the structure for gaps.

  .. _OESpruce_OELoopBuilderOptions_GetSeqAlignGapPenalty:

  .. oe:method:: GetSeqAlignGapPenalty

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetSeqAlignGapPenalty() const

      .. oe:language:: python

         .. oe:api:: python

            GetSeqAlignGapPenalty() -> int

      Returns the sequence alignment gap penalty, used to compare the provided sequence and the structure for gaps with the :oe:func:`OEBio::OEGetSimpleAlignment` function.

  .. _OESpruce_OELoopBuilderOptions_GetSeqAlignExtendPenalty:

  .. oe:method:: GetSeqAlignExtendPenalty

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetSeqAlignExtendPenalty() const

      .. oe:language:: python

         .. oe:api:: python

            GetSeqAlignExtendPenalty() -> int

      Returns the sequence alignment extend penalty, used to compare the provided sequence and the structure for gaps with the :oe:func:`OEBio::OEGetSimpleAlignment` function.

  .. _OESpruce_OELoopBuilderOptions_GetBuildTails:

  .. oe:method:: GetBuildTails

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetBuildTails() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildTails() -> bool

      Returns whether or not to allow building missing tails at the N and C termini.

  .. _OESpruce_OELoopBuilderOptions_SetLoopDBFilename:

  .. oe:method:: SetLoopDBFilename

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLoopDBFilename(std::string filename)

      .. oe:language:: python

         .. oe:api:: python

            SetLoopDBFilename(value: str) -> bool

      Sets the filename of the loop database to use when searching for compatible loops.

  .. _OESpruce_OELoopBuilderOptions_SetUsePackingResidues:

  .. oe:method:: SetUsePackingResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUsePackingResidues(bool usePackingResidues)

      .. oe:language:: python

         .. oe:api:: python

            SetUsePackingResidues(value: bool) -> bool

      Sets whether or not to use crystal packing residues during loop modeling (if available).

  .. _OESpruce_OELoopBuilderOptions_SetCropLength:

  .. oe:method:: SetCropLength

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetCropLength(unsigned cropLength)

      .. oe:language:: python

         .. oe:api:: python

            SetCropLength(value: int) -> bool

      Returns the number of residues on either side of a gap to remove, since these are known to sometimes be poorly resolved and
      therefore have configurations that make it difficult to build loops.

  .. _OESpruce_OELoopBuilderOptions_SetTransformThreshold:

  .. oe:method:: SetTransformThreshold

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetTransformThreshold(unsigned transformThreshold)

      .. oe:language:: python

         .. oe:api:: python

            SetTransformThreshold(value: int) -> bool

      Sets the number of loops from the database to transform, meaning mutate from their database sequence to target sequence,
      if they are not 100% sequence matching. Structures with 100% sequence match are not affected by this threshold.

  .. _OESpruce_OELoopBuilderOptions_SetStrictProlineMatch:

  .. oe:method:: SetStrictProlineMatch

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStrictProlineMatch(bool strictProline)

      .. oe:language:: python

         .. oe:api:: python

            SetStrictProlineMatch(value: bool) -> bool

      Sets whether or not fuzzy sequence matches have to have proline residues in the correct position. This
      can be relevant since they have a different backbone conformation than other amino acid residues.

  .. _OESpruce_OELoopBuilderOptions_SetConnectBufferDistance:

  .. oe:method:: SetConnectBufferDistance

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetConnectBufferDistance(double buffer)

      .. oe:language:: python

         .. oe:api:: python

            SetConnectBufferDistance(value: float) -> bool

      Sets the buffer distance allowed between the anchor atoms (connection points) when searching for fuzzy sequence matches.

  .. _OESpruce_OELoopBuilderOptions_SetBackboneClashRejectThreshold:

  .. oe:method:: SetBackboneClashRejectThreshold

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBackboneClashRejectThreshold(double bbClashThreshold)

      .. oe:language:: python

         .. oe:api:: python

            SetBackboneClashRejectThreshold(value: float) -> bool

      Sets the threshold of clashing backbone atoms. If the clash level is above this threshold a loop from the database is rejected,
      and is not processed further.

  .. _OESpruce_OELoopBuilderOptions_SetDeleteExistingResidues:

   .. oe:method:: SetDeleteExistingResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDeleteExistingResidues(bool deleteExistingResidues)

      .. oe:language:: python

         .. oe:api:: python

            SetDeleteExistingResidues(value: bool) -> bool

      Sets whether or not to delete residues already present at site where new loops needs to be built.
      See also :ref:`SetRejectClashingLoopsPostMinimization <OESpruce_OELoopBuilderOptions_SetRejectClashingLoopsPostMinimization>`.

  .. _OESpruce_OELoopBuilderOptions_SetLoopClashRejectThreshold:

  .. oe:method:: SetLoopClashRejectThreshold

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetLoopClashRejectThreshold(double loopClashThreshold)

      .. oe:language:: python

         .. oe:api:: python

            SetLoopClashRejectThreshold(value: float) -> bool

      Sets the threshold of clashing loops atoms. This threshold excludes already considered clashing backbone atoms. If the clash level is above this threshold a loop from the database is rejected,
      and is not processed further.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationShell:

  .. oe:method:: SetOptimizationShell

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptimizationShell(double optimizationShellRadius)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationShell(value: float) -> bool

      Set the radius of atoms being considered when minimizing the loops in place. Since multiple loops are being optimized,
      it is the union of atoms inside the radius around each starting loop configuration that is considered. This allows comparison of
      the energies between each loop conformation as the systems are of identical size.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationTolerance:

  .. oe:method:: SetOptimizationTolerance

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptimizationTolerance(double optimizationTolerance)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationTolerance(value: float) -> bool

      Sets the tolerance used by the optimizer.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationStage1IterMultiplier:

  .. oe:method:: SetOptimizationStage1IterMultiplier

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptimizationStage1IterMultiplier(unsigned stage1multiplier)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationStage1IterMultiplier(value: int) -> bool

      Sets the multiplier of optimization steps per residue in the loop used during the initial steepest descent optimization.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationStage2IterMultiplier:

  .. oe:method:: SetOptimizationStage2IterMultiplier

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptimizationStage2IterMultiplier(unsigned stage2multiplier)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationStage2IterMultiplier(value: int) -> bool

      Sets the multiplier of optimization steps per residue in the loop used during the secondary BFGS optimization.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationUseSolventModel:

  .. oe:method:: SetOptimizationUseSolventModel

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptimizationUseSolventModel(bool useSolventModel)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationUseSolventModel(value: bool) -> bool

      Sets whether or not to use a simplistic solvent model during the loop optimization.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationInclSurfaceAreaTerm:

  .. oe:method:: SetOptimizationInclSurfaceAreaTerm

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptimizationInclSurfaceAreaTerm(bool useSATerm)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationInclSurfaceAreaTerm(value: bool) -> bool

      Sets whether or not to include the surface area term when scoring the loops after optimization.

  .. _OESpruce_OELoopBuilderOptions_SetOptimizationMaxLoops:

  .. oe:method:: SetOptimizationMaxLoops

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptimizationMaxLoops(unsigned maxOptLoops)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationMaxLoops(value: int) -> bool

      Sets the number of loops to optimize, the higher the number the longer the calculation will take, but also includes more structural diversity.

  .. _OESpruce_OELoopBuilderOptions_SetAllowBuildDisulfideBridges:

  .. oe:method:: SetAllowBuildDisulfideBridges

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetAllowBuildDisulfideBridges(bool allowBuildDisulfideBridges)

      .. oe:language:: python

         .. oe:api:: python

            SetAllowBuildDisulfideBridges(value: bool) -> bool

      Sets whether or not to allow building disulfide bridges between the loop and the protein if possible, requires cystine residues in proximity.

  .. _OESpruce_OELoopBuilderOptions_SetRejectClashingLoopsPostMinimization:

  .. oe:method:: SetRejectClashingLoopsPostMinimization

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRejectClashingLoopsPostMinimization() const

      .. oe:language:: python

         .. oe:api:: python

            SetRejectClashingLoopsPostMinimization(value: bool) -> bool

      Set whether or not to reject clashing loops post-minimization. See also
      :ref:`SetDeleteExistingResidues <OESpruce_OELoopBuilderOptions_SetDeleteExistingResidues>`.

  .. _OESpruce_OELoopBuilderOptions_SetSeqAlignMethod:

  .. oe:method:: SetSeqAlignMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSeqAlignMethod(unsigned seqAlignMethod)

      .. oe:language:: python

         .. oe:api:: python

            SetSeqAlignMethod(value: int) -> bool

      Sets the sequence alignment method, from the :oe:const:`OEBio::OESeqAlignmentMethod` namespace, used to compare the provided sequence and the structure for gaps.

  .. _OESpruce_OELoopBuilderOptions_SetSeqAlignGapPenalty:

  .. oe:method:: SetSeqAlignGapPenalty

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSeqAlignGapPenalty(int gapPenalty)

      .. oe:language:: python

         .. oe:api:: python

            SetSeqAlignGapPenalty(value: int) -> bool

      Set the sequence alignment gap penalty, used to compare the provided sequence and the structure for gaps with the :oe:func:`OEBio::OEGetSimpleAlignment` function.

  .. _OESpruce_OELoopBuilderOptions_SetSeqAlignExtendPenalty:

  .. oe:method:: SetSeqAlignExtendPenalty

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSeqAlignExtendPenalty(int extendPenalty)

      .. oe:language:: python

         .. oe:api:: python

            SetSeqAlignExtendPenalty(value: int) -> bool

      Set the sequence alignment extend penalty, used to compare the provided sequence and the structure for gaps with the :oe:func:`OEBio::OEGetSimpleAlignment` function.

  .. _OESpruce_OELoopBuilderOptions_SetBuildTails:

  .. oe:method:: SetBuildTails

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBuildTails(bool BuildTails)

      .. oe:language:: python

         .. oe:api:: python

            SetBuildTails(value: bool) -> bool

      Sets whether or not to allow building missing tails at the C and N termini.

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>` class
      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class
      * :oe:func:`OESpruce::OEBuildLoops` function
      * :oe:func:`OESpruce::OEBuildSingleLoop` function
      * :oe:const:`OEBio::OESeqAlignmentMethod` namespace
      * :oe:func:`OEBio::OEGetSimpleAlignment` function
      * :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEMakeDesignUnitOptions:

.. oe:class:: OEMakeDesignUnitOptions

   .. attention::

      |TWOLANGUAGE|

   The :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class holds other options classes that are used during the structure preparation processes. The
   organization of those options classes is illustrated in the figure below. Default constructing this options class, constructs all the necessary
   options classes in the illustration, which can then be accessed and modified.
   This class stores the optional parameter sets for design unit construction for use in the :oe:func:`OESpruce::OEMakeDesignUnits` and
   :oe:func:`OESpruce::OEMakeDesignUnit` functions.

   .. _figure_OEMakeDesignUnitOptions_Organization:

   .. figure:: sprucetk/images/OEMakeDUOptionsOrg.*
      :align:  center

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMakeDesignUnitOptions()
            OEMakeDesignUnitOptions(const OEMakeDesignUnitOptions &)
            OEMakeDesignUnitOptions(const OEDesignUnitSplitOptions& splitOpts,
                                    const OEDesignUnitPrepOptions& prepOpts,
                                    const OEBioUnitExtractionOptions& buExtractOpts)

      .. oe:language:: python

         .. oe:api:: python

            OEMakeDesignUnitOptions() -> OEMakeDesignUnitOptions
            OEMakeDesignUnitOptions(splitOpts: OEDesignUnitSplitOptions,
                                    prepOpts: OEDesignUnitPrepOptions,
                                    buExtractOpts: OEBioUnitExtractionOptions) -> OEMakeDesignUnitOptions
            OEMakeDesignUnitOptions(arg2: OEMakeDesignUnitOptions) -> OEMakeDesignUnitOptions

      Default, copy, and advanced constructor that constructs a `OEMakeDesignUnitOptions` object. The advanced constructor take three separate sub-options classes as arguments: an options class that controls componentization of the system (:ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>`), an options class that controls prep (:ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>`), and an options class that controls biounit extraction (:ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>`).

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMakeDesignUnitOptions &operator=(const OEMakeDesignUnitOptions &)

      Assignment operator.

   .. _OESpruce_OEMakeDesignUnitOptions_GetBioUnitExtractionOptions:

   .. oe:method:: GetBioUnitExtractionOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBioUnitExtractionOptions& GetBioUnitExtractionOptions()
            const OEBioUnitExtractionOptions& GetBioUnitExtractionOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetBioUnitExtractionOptions() -> OEBioUnitExtractionOptions

      Returns a reference to the stored biounit extraction options (:ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>`) class.

   .. _OESpruce_OEMakeDesignUnitOptions_GetPrepOptions:

   .. oe:method:: GetPrepOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDesignUnitPrepOptions& GetPrepOptions()
            const OEDesignUnitPrepOptions& GetPrepOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetPrepOptions() -> OEDesignUnitPrepOptions

      Returns a reference to the stored design unit prep options (:ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>`) class.

   .. _OESpruce_OEMakeDesignUnitOptions_GetSplitOptions:

   .. oe:method:: GetSplitOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEDesignUnitSplitOptions& GetSplitOptions()
            const OEDesignUnitSplitOptions& GetSplitOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSplitOptions() -> OEDesignUnitSplitOptions

      Returns a reference to the stored options for splitting options (:ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>`) class.

   .. _OESpruce_OEMakeDesignUnitOptions_GetSuperpose:

   .. oe:method:: GetSuperpose

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetSuperpose() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuperpose() -> bool

      Returns the boolean whether or not to superpose the design units onto a common reference.

   .. _OESpruce_OEMakeDesignUnitOptions_GetSuperpositionMethod:

   .. oe:method:: GetSuperpositionMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetSuperpositionMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuperpositionMethod() -> int

      Returns the stored superposition method taken from the :oe:constns:`OESpruce::OESuperpositionType` namespace.

   .. _OESpruce_OEMakeDesignUnitOptions_SetBioUnitExtractionOptions:

   .. oe:method:: SetBioUnitExtractionOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetBioUnitExtractionOptions(const OESpruce::OEBioUnitExtractionOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetBioUnitExtractionOptions(opts: OEBioUnitExtractionOptions) -> None

      Sets the biounit extraction options class (:ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>`).

   .. _OESpruce_OEMakeDesignUnitOptions_SetPrepOptions:

   .. oe:method:: SetPrepOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPrepOptions(const OESpruce::OEDesignUnitPrepOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetPrepOptions(opts: OEDesignUnitPrepOptions) -> None

      Sets the design unit prep options class (:ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>`).

   .. _OESpruce_OEMakeDesignUnitOptions_SetSplitOptions:

   .. oe:method:: SetSplitOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSplitOptions(const OESpruce::OEDesignUnitSplitOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetSplitOptions(opts: OEDesignUnitSplitOptions) -> None

      Sets the system molecular componentization options class (:ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>`).

   .. _OESpruce_OEMakeDesignUnitOptions_SetSuperpose:

   .. oe:method:: SetSuperpose

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSuperpose(bool superpose)

      .. oe:language:: python

         .. oe:api:: python

            SetSuperpose(value: bool) -> bool

      Sets the boolean of whether or not to superpose design units to a common reference.

   .. _OESpruce_OEMakeDesignUnitOptions_SetSuperpositionMethod:

   .. oe:method:: SetSuperpositionMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSuperpositionMethod(unsigned superposeMethod)

      .. oe:language:: python

         .. oe:api:: python

            SetSuperpositionMethod(value: int) -> bool

      Sets the superposition method from a value in the :oe:constns:`OESpruce::OESuperpositionType` namespace.

   .. seealso::

      * :ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>` class
      * :ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEDesignUnitCharges <OEProton_OEDesignUnitCharges>` class
      * :ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>` class
      * :ref:`OEProtonateDesignUnitOptions <OESpruce_OEProtonateDesignUnitOptions>` class
      * :ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>` class
      * :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>` class
      * :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>` class
      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class
      * :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>` class
      * :ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEPocket:

.. oe:class:: OEPocket

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEPocket

   This class stores the pockets resulting from running :oe:func:`OESpruce::OEFindPockets` function.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPocket(const OESpicoli::OESurface& surf, OEChem::OEMolBase& mol)
            OEPocket(const OEPocket &)

      .. oe:language:: python

         .. oe:api:: python

            OEPocket(rhs: OEPocket) -> OEPocket
            OEPocket(arg2: OEPocket) -> OEPocket
            OEPocket(surf: OESurface, mol: Union[OEGraphMol,OEMol,OEQMol]) -> OEPocket

      Default and copy constructor that constructs a `OEPocket` object.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPocket& operator=(const OEPocket &)

      Assignment operator.

   .. oe:method:: GetSurfaceArea

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetSurfaceArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetSurfaceArea() -> float

      Returns the surface area for the pocket surface.

   .. oe:method:: GetLocalDensity

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetLocalDensity() const

      .. oe:language:: python

         .. oe:api:: python

            GetLocalDensity() -> float

      Returns the local density score for the pocket. A score > 50 is considered high quality.

   .. oe:method:: GetPocketPredicate

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& GetPocketPredicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetPocketPredicate() -> OEUnaryAtomPred

      Returns an atom predicate for the pocket. The pocket is residue based and can therefore be transferred
      to structures in the same target.

   .. oe:method:: GetPocketSurface

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OESpicoli::OESurface& GetPocketSurface() const
            OESpicoli::OESurface& GetPocketSurface()

      .. oe:language:: python

         .. oe:api:: python

            GetPocketSurface() -> OESurface

      Returns a reference to the surface of the pocket.

   .. oe:method:: GetAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEAtomBase>* GetAtoms()

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> OEAtomIter

      Returns an iterator of the atoms making up the pocket surface.

   .. oe:method:: GetResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEHierResidue>* GetResidues()

      .. oe:language:: python

         .. oe:api:: python

            GetResidues() -> OEResidueIter

      Returns an iterator of the OEResidues making up the pocket.

   .. seealso::

      * :oe:func:`OESpruce::OEFindPockets` function
      * :ref:`OEPocketOptions <OESpruce_OEPocketOptions>` class
      * :ref:`OEMakeDesignUnitFromPocket <OESpruce_OEMakeDesignUnitFromPocket>` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEPocketOptions:

.. oe:class:: OEPocketOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEPocketOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for pocket finding using
   :oe:func:`OESpruce::OEFindPockets` function.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPocketOptions()
            OEPocketOptions(const OEPocketOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEPocketOptions() -> OEPocketOptions
            OEPocketOptions(arg2: OEPocketOptions) -> OEPocketOptions

      Default and copy constructor that constructs a `OEPocketOptions` object.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPocketOptions &operator=(const OEPocketOptions &)

      Assignment operator.

   .. oe:method:: GetMinSurfaceArea

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMinSurfaceArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinSurfaceArea() -> float

      Returns the minimum surface area for a detected pocket surface.
      [Default: :math:`150 \, {Angstrom}^2`]

   .. oe:method:: GetMaxSurfaceArea

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMaxSurfaceArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSurfaceArea() -> float

      Returns the maximum surface area for a detected pocket surface.
      [Default: :math:`3000 \, {Angstrom}^2`]

   .. oe:method:: GetBurialFactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetBurialFactor() const

      .. oe:language:: python

         .. oe:api:: python

            GetBurialFactor() -> float

      Returns the factor used to distinguish pockets from the general surface.
      [Default: 1.4]

.. _OESpruce_OEPocketOptions_SetMinSurfaceArea:

   .. oe:method:: SetMinSurfaceArea

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMinSurfaceArea(const double value)

      .. oe:language:: python

         .. oe:api:: python

            SetMinSurfaceArea(value: float) -> bool

      Sets the minimum surface area for a detected pocket surface.

.. _OESpruce_OEPocketOptions_SetMaxSurfaceArea:

   .. oe:method:: SetMaxSurfaceArea

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxSurfaceArea(const double value)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxSurfaceArea(value: float) -> bool

      Sets the maximum surface area for a detected pocket surface.

.. _OESpruce_OEPocketOptions_SetBurialFactor:

   .. oe:method:: SetBurialFactor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetBurialFactor(const double value)

      .. oe:language:: python

         .. oe:api:: python

            SetBurialFactor(value: float) -> bool

      Sets the factor used to distinguish pockets from the general surface.

   .. seealso::

      * :oe:func:`OESpruce::OEFindPockets` function
      * :ref:`OEPocket <OESpruce_OEPocket>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEProtonateDesignUnitOptions:

.. oe:class:: OEProtonateDesignUnitOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEProtonateDesignUnitOptions : public OESystem::OEOptions

   This class stores the optional parameter sets used in design unit protonation for use in the :oe:func:`OESpruce::OEProtonateDesignUnit` function.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEProtonateDesignUnitOptions()
            OEProtonateDesignUnitOptions(const OEBio::OEPlaceHydrogensOptions& placeHOpts)
            OEProtonateDesignUnitOptions(const OEProtonateDesignUnitOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEProtonateDesignUnitOptions() -> OEProtonateDesignUnitOptions
            OEProtonateDesignUnitOptions(placeHOpts: OEPlaceHydrogensOptions) -> OEProtonateDesignUnitOptions
            OEProtonateDesignUnitOptions(rhs: OEProtonateDesignUnitOptions) -> OEProtonateDesignUnitOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEProtonateDesignUnitOptions &operator=(const OEProtonateDesignUnitOptions &rhs)

      Assignment operator.

   .. oe:method:: GetGenerateTautomers

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetGenerateTautomers() const

      .. oe:language:: python

         .. oe:api:: python

            GetGenerateTautomers() -> bool

      Returns the boolean whether or not to generate tautomers for the ligand and cofactors.

   .. oe:method:: GetHetGroupNbrDist

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetHetGroupNbrDist() const

      .. oe:language:: python

         .. oe:api:: python

            GetHetGroupNbrDist() -> float

      Returns the distance cutoff for two groups to be considered within the same cluster.

   .. oe:method:: GetOptimizeExpProtons

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetOptimizeExpProtons() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizeExpProtons() -> bool

      Returns the boolean whether or not to optimize the position of experimental protons.

   .. oe:method:: GetPlaceHydrogensOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBio::OEPlaceHydrogensOptions& GetPlaceHydrogensOptions()
            const OEBio::OEPlaceHydrogensOptions& GetPlaceHydrogensOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetPlaceHydrogensOptions() -> OEPlaceHydrogensOptions

      Returns a reference to the stored place hydrogen options (:ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>`) class.

.. _OESpruce_OEProtonateDesignUnitOptions_SetGenerateTautomers:

   .. oe:method:: SetGenerateTautomers

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetGenerateTautomers(const bool generateTautomers)

      .. oe:language:: python

         .. oe:api:: python

            SetGenerateTautomers(value: bool) -> bool

      Sets the boolean of whether or not to generate tautomers.

.. _OESpruce_OEProtonateDesignUnitOptions_SetHetGroupNbrDist:

   .. oe:method:: SetHetGroupNbrDist

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetHetGroupNbrDist(const double hetGroupNbrDist)

      .. oe:language:: python

         .. oe:api:: python

            SetHetGroupNbrDist(value: float) -> bool

      Sets the distance cutoff for two groups to be considered within the same cluster.

.. _OESpruce_OEProtonateDesignUnitOptions_SetOptimizeExpProtons:

   .. oe:method:: SetOptimizeExpProtons

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptimizeExpProtons(const bool optimizeExpProtons)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizeExpProtons(value: bool) -> bool

      Sets the boolean whether or not to optimize the position of experimental protons.

.. _OESpruce_OEProtonateDesignUnitOptions_SetPlaceHydrogensOptions:

   .. oe:method:: SetPlaceHydrogensOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetPlaceHydrogensOptions(const OEBio::OEPlaceHydrogensOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetPlaceHydrogensOptions(opts: OEPlaceHydrogensOptions) -> None

      Sets the place hydrogens options class (:ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>`).

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESecondaryStructureSuperposition, SecondaryStructure, SecondaryStructureSuperposition, Superposition

.. _OESpruce_OESecondaryStructureSuperposition:

.. oe:class:: OESecondaryStructureSuperposition

   .. warning::

      |DEPRECATED-API|
      Please use :ref:`OESuperpose <OESpruce_OESuperpose>` class instead. 

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESecondaryStructureSuperposition

   This class represents
   :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` that performs
   a structural superposition on fit protein to a reference using a
   shape-based alignment of the secondary structure elements.

   .. seealso::

      * :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` class
      * :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESecondaryStructureSuperposition(const OEChem::OEMolBase& refMol,
                                              const OEChem::OEMolBase& fitMol,
                                              const OESuperpositionOptions& argOpts = OESuperpositionOptions())

      .. oe:language:: python

         .. oe:api:: python

            OESecondaryStructureSuperposition(refMol: Union[OEGraphMol,OEMol,OEQMol],
                                              fitMol: Union[OEGraphMol,OEMol,OEQMol],
                                              argOpts: OESuperpositionOptions = OESuperpositionOptions()) -> OESecondaryStructureSuperposition

      Constructor that superimposes the ``fitMol`` to the ``refMol`` by using a shape-based
      alignment to the secondary structure elements.
      If no :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` are passed in as ``argOpts``,
      then the default behavior of using a superposition to all globally matched atoms will be used.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESecondaryStructureSuperposition(const OESecondaryStructureSuperposition& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESecondaryStructureSuperposition(rhs: OESecondaryStructureSuperposition) -> OESecondaryStructureSuperposition

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESecondaryStructureSuperposition &operator=(const OESecondaryStructureSuperposition &rhs)

      Assignment operator.

   ..   _OESpruce_OESecondaryStructureSuperposition_operator_bool:

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` object is
      valid.

   ..   _OESpruce_OESecondaryStructureSuperposition_GetFitChains:

   .. oe:method:: GetFitChains

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetFitChains() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitChains() -> OEStringVector

      Returns 1-letter code of all names of fit protein chains.

      .. seealso::

         * :ref:`GetRefChains <OESpruce_OESecondaryStructureSuperposition_GetRefChains>` method

   ..   _OESpruce_OESecondaryStructureSuperposition_GetRefChains:

   .. oe:method:: GetRefChains

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetRefChains() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefChains() -> OEStringVector

      Returns 1-letter code of all names of reference protein chains.

      .. seealso::

         * `GetFitChains <OESpruce_OESecondaryStructureSuperposition_GetFitChains>` method

   .. oe:method:: GetRotMatrix

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRotMatrix(double* rmat) const

      .. oe:language:: python

         .. oe:api:: python

            GetRotMatrix(rmat: OEDoubleArray)

      Returns by reference the rotation matrix of the superposition.

   .. oe:method:: GetTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimoto() -> float

      Returns the Tanimoto score for the structural superposition.

   .. oe:method:: GetTranslation

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetTranslation(double* trans) const

      .. oe:language:: python

         .. oe:api:: python

            GetTranslation(trans: OEDoubleArray)

      Returns by reference the translation vector of the superposition.

   ..   _OESpruce_OESecondaryStructureSuperposition_Transform:

   .. oe:method:: Transform

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Transform(OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Transform(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

      Transforms the input molecule using the stored rotation matrix and translation vector from the superposition.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OESequenceMetadata:

.. oe:class:: OESequenceMetadata

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESequenceMetadata

   This class stores the sequence data used in biomolecule rebuilding in the :oe:func:`OESpruce::OEMakeDesignUnits` function.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESequenceMetadata()
            OESequenceMetadata(const OESequenceMetadata &)

      .. oe:language:: python

         .. oe:api:: python

            OESequenceMetadata() -> OESequenceMetadata
            OESequenceMetadata(arg2: OESequenceMetadata) -> OESequenceMetadata

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESequenceMetadata &operator=(const OESequenceMetadata &)

      Assignment operator.

   .. oe:method:: GetChainID

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetChainID() const

      .. oe:language:: python

         .. oe:api:: python

            GetChainID() -> str

      Returns the string of the chain ID of the sequence.

   .. oe:method:: GetEndResidueInsertCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            char GetEndResidueInsertCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetEndResidueInsertCode() -> str

      Returns a char representing the insertion code of the last residue.

   .. oe:method:: GetEndResidueNumber

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetEndResidueNumber() const

      .. oe:language:: python

         .. oe:api:: python

            GetEndResidueNumber() -> int

      Returns the residue number.

   .. oe:method:: GetSequence

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetSequence() const

      .. oe:language:: python

         .. oe:api:: python

            GetSequence() -> str

      Returns the string sequence.

   .. oe:method:: GetStartResidueInsertCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            char GetStartResidueInsertCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetStartResidueInsertCode() -> str

      Returns a char representing the insertion code of the first residue.

   .. oe:method:: GetStartResidueNumber

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetStartResidueNumber() const

      .. oe:language:: python

         .. oe:api:: python

            GetStartResidueNumber() -> int

      Returns the residue number (`int`) of the first residue.

   .. oe:method:: SetChainID

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetChainID(const std::string& cid)

      .. oe:language:: python

         .. oe:api:: python

            SetChainID(cid: str) -> None

      Sets the string of the chain ID of the sequence.

   .. oe:method:: SetEndResidueInsertCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetEndResidueInsertCode(const char endInsCode)

      .. oe:language:: python

         .. oe:api:: python

            SetEndResidueInsertCode(endInsCode: str) -> None

      Sets the char representing the insertion code of the last residue.

   .. oe:method:: SetEndResidueNumber

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetEndResidueNumber(const int endResNum)

      .. oe:language:: python

         .. oe:api:: python

            SetEndResidueNumber(endResNum: int) -> None

      Sets the residue number (`int`) of the last residue.

   .. oe:method:: SetSequence

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSequence(const std::string& seq)

      .. oe:language:: python

         .. oe:api:: python

            SetSequence(seq: str) -> None

      Sets the string of the sequence. The format should be a three letter code per residue separated by spaces.

   .. oe:method:: SetStartResidueInsertCode

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStartResidueInsertCode(const char startInsCode)

      .. oe:language:: python

         .. oe:api:: python

            SetStartResidueInsertCode(startInsCode: str) -> None

      Sets the char representing the insertion code of the first residue.

   .. oe:method:: SetStartResidueNumber

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStartResidueNumber(const int startResNum)

      .. oe:language:: python

         .. oe:api:: python

            SetStartResidueNumber(startResNum: int) -> None

      Sets the residue number (`int`) of the first residue.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OESidechainBuilderOptions:

.. oe:class:: OESidechainBuilderOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESidechainBuilderOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for building sidechains in the :oe:func:`OESpruce::OEBuildSidechains`,
   :oe:func:`OESpruce::OEMutateResidue`, :oe:func:`OESpruce::OEMutateResidues`, :oe:func:`OESpruce::OEBuildLoops`,
   :oe:func:`OESpruce::OEBuildSingleLoop` functions.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESidechainBuilderOptions()
            OESidechainBuilderOptions(const OESidechainBuilderOptions &)
            OESidechainBuilderOptions(bool minimizeSidechainsShell)

      .. oe:language:: python

         .. oe:api:: python

            OESidechainBuilderOptions() -> OESidechainBuilderOptions
            OESidechainBuilderOptions(arg2: OESidechainBuilderOptions) -> OESidechainBuilderOptions
            OESidechainBuilderOptions(minimizeSidechainsShell: bool) -> OESidechainBuilderOptions

      Default, copy, and parameterized constructors for the `OESidechainBuilderOptions` object.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESidechainBuilderOptions &operator=(const OESidechainBuilderOptions &)

      Assignment operator.

   .. _OESpruce_OESidechainBuilderOptions_GetDeleteClashingSolvent:

   .. oe:method:: GetDeleteClashingSolvent

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetDeleteClashingSolvent() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeleteClashingSolvent() -> bool

      Returns the boolean whether or not to delete solvent waters that clash with other atoms.
   
   .. _OESpruce_OESidechainBuilderOptions_GetMaxClusterSize:

   .. oe:method:: GetMaxClusterSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxClusterSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxClusterSize() -> int

      Returns the maximum number of partial residues allowed in a cluster. Clusters are made based on proximity of partial residues to each other.

   .. _OESpruce_OESidechainBuilderOptions_GetMinimizeSidechains:

   .. oe:method:: GetMinimizeSidechains

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMinimizeSidechains() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinimizeSidechains() -> bool

      Returns the boolean whether or not to minimize the sidechains of the target residues.

   .. _OESpruce_OESidechainBuilderOptions_GetMinimizeSidechainsShell:

   .. oe:method:: GetMinimizeSidechainsShell

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetMinimizeSidechainsShell() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinimizeSidechainsShell() -> bool

      Returns the boolean whether or not to minimize the sidechains of the residues around the target residues.

   .. _OESpruce_OESidechainBuilderOptions_GetRotamerLibrary:

   .. oe:method:: GetRotamerLibrary

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetRotamerLibrary() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotamerLibrary() -> int

      Returns the rotamer library used for side chain rebuilding.

   .. _OESpruce_OESidechainBuilderOptions_GetStrictMode:

   .. oe:method:: GetStrictMode

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetStrictMode() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrictMode() -> bool

      Returns the boolean whether or not to fail early if any of the partial or missings sidechain could not be built
   

   .. _OESpruce_OESidechainBuilderOptions_SetRotamerCoverage:

   .. oe:method:: SetRotamerCoverage

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRotamerCoverage(double rotamerCoverage)

      .. oe:language:: python

         .. oe:api:: python

            SetRotamerCoverage(value: float) -> bool

      Sets the value for the rotamer coverage percentage to be used for side chain rebuilding.

   .. _OESpruce_OESidechainBuilderOptions_SetRotamerLibrary:

   .. oe:method:: SetRotamerLibrary

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetRotamerLibrary(unsigned rotamerLibrary)

      .. oe:language:: python

         .. oe:api:: python

            SetRotamerLibrary(value: int) -> bool

      Sets the boolean of the rotamer library.

   .. _OESpruce_OESidechainBuilderOptions_SetDeleteClashingSolvent:

   .. oe:method:: SetDeleteClashingSolvent

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDeleteClashingSolvent(bool deleteClashingSolvent)

      .. oe:language:: python

         .. oe:api:: python

            SetDeleteClashingSolvent(value: bool) -> bool

      Sets the boolean of whether or not to delete solvent waters that clash with other atoms.
   
   .. _OESpruce_OESidechainBuilderOptions_SetMaxClusterSize:

   .. oe:method:: SetMaxClusterSize

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxClusterSize(unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxClusterSize(value: int) -> bool

      Sets the maximum number of partial residues allowed in a cluster. Clusters are made based on proximity of partial residues to each other.

   .. _OESpruce_OESidechainBuilderOptions_SetMinimizeSidechains:

   .. oe:method:: SetMinimizeSidechains

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMinimizeSidechains(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetMinimizeSidechains(value: bool) -> bool

      Sets the boolean whether or not to minimize the sidechains of the target residues.

   .. _OESpruce_OESidechainBuilderOptions_SetMinimizeSidechainsShell:

   .. oe:method:: SetMinimizeSidechainsShell

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMinimizeSidechainsShell(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetMinimizeSidechainsShell(value: bool) -> bool

      Sets the boolean whether or not to minimize the sidechains of the residues around the target residues.

   .. _OESpruce_OESidechainBuilderOptions_SetStrictMode:

   .. oe:method:: SetStrictMode

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetStrictMode(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetStrictMode(value: bool) -> bool

      Sets the boolean whether or not to fail early if any of the partial or missings sidechain could not be built
   

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>` class
      * :oe:func:`OESpruce::OEBuildSidechains` function
      * :oe:func:`OESpruce::OEMutateResidue` function
      * :oe:func:`OESpruce::OEMutateResidues` function
      * :oe:func:`OESpruce::OEBuildLoops` function
      * :oe:func:`OESpruce::OEBuildSingleLoop` function


.. _OESpruceClasses:

*******************
OESpruce Classes
*******************

.. oe:namespace:: OESpruce

.. toctree::

   OEBioUnitExtractionOptions
   OECapBuilderOptions
   OEDesignUnitBuildOptions
   OEDesignUnitEnumerateSitesOptions
   OEDesignUnitMutationOptions
   OEDesignUnitPrepOptions
   OEDesignUnitSplitOptions
   OEHeterogenMetadata
   OEIsModeledAtom
   OELoopBuilderOptions
   OEMakeDesignUnitOptions
   OEPocket
   OEPocketOptions
   OEProtonateDesignUnitOptions
   OESidechainBuilderOptions
   OESequenceMetadata
   OEStructureMetadata
   OESecondaryStructureSuperposition
   OESpruceFilter
   OESpruceFilterOptions
   OEStructuralSuperposition
   OESuperpositionOptions
   OESuperpose
   OESuperposeOptions
   OESuperposeResults
   OEValidateDesignUnit


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESpruceFilter, SpruceFilter, filter, StructuralFilter

.. _chapter_sprucetk_sprucefilter:

.. _OESpruce_OESpruceFilter:

.. oe:class:: OESpruceFilter

   .. attention::

      |TWOLANGUAGE|

   .. note::

      Note: We strongly recommend running :ref:`OESpruceFilter <OESpruce_OESpruceFilter>` for standardization and filtering prior to running the design unit preparation.

   .. oe:api::

      class OESpruceFilter

   This class performs standardization and quality filtering on a biomolecular
   structure prior to design unit preparation with
   :oe:func:`OESpruce::OEMakeDesignUnit` or
   :oe:func:`OESpruce::OEMakeDesignUnits`. Checks include residue name validity,
   residue states, covalent bonds to metals, and crystal symmetry.

   .. seealso::

      * :ref:`OESpruceFilterOptions <OESpruce_OESpruceFilterOptions>` class.
      * :ref:`OEMakeDesignUnit <OESpruce_OEMakeDesignUnit>` function.
      * :ref:`OEMakeBioDesignUnit <OESpruce_OEMakeBioDesignUnits>` function.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESpruceFilter()
            OESpruceFilter(const OESpruceFilterOptions&,
                           const OEMakeDesignUnitOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OESpruceFilter() -> OESpruceFilter
            OESpruceFilter(fOpts: OESpruceFilterOptions,
                           makeOpts: OEMakeDesignUnitOptions) -> OESpruceFilter

      Constructor for spruce filter given the specified options class.
      If no :ref:`OESpruceFilterOptions <OESpruce_OESpruceFilterOptions>` and :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` are passed in as ``fopts`` and ``DUOpts``,
      then the default options class will be passed into the constructor.

      .. seealso::

         * :ref:`OESpruceFilterOptions <OESpruce_OESpruceFilterOptions>` class
         * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESpruceFilter(const OESpruceFilter& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESpruceFilter(rhs: OESpruceFilter) -> OESpruceFilter

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESpruceFilter& operator=(const OESpruceFilter& rhs)

      Assignment operator.

.. _OESpruce_OESpruceFilter_StandardizeAndFilter:

   .. oe:method:: StandardizeAndFilter

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned StandardizeAndFilter(OEChem::OEMolBase& mol,
                                          const OESystem::OESkewGrid& eDensGrid,
                                          const OEStructureMetadata& mdata = OEStructureMetadata())

      .. oe:language:: python

         .. oe:api:: python

            StandardizeAndFilter(mol: Union[OEGraphMol,OEMol,OEQMol],
                                 eDensGrid: OESkewGrid,
                                 mdata: OEStructureMetadata = OEStructureMetadata()) -> int

      Returns a code which indicates the issues that are detected for this structure

.. _OESpruce_OESpruceFilter_GetMessage:

   .. oe:method:: GetMessages

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetMessages(const unsigned errorTypes = OESpruceFilterIssueCodes::ALL)

      .. oe:language:: python

         .. oe:api:: python

            GetMessages(errorTypes: int) -> str

      Returns the error message according to the provided error code

.. _OESpruce_OESpruceFilter_GetAtoms:

   .. oe:method:: GetAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEAtomBase>* GetAtoms(const unsigned errorTypes = OESpruceFilterIssueCodes::ALL)

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms(errorTypes: int) -> OEAtomIter

      Returns the problematic atoms that have the issues indicated by the input error code
      
 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OESpruceFilterOptions:

.. oe:class:: OESpruceFilterOptions

   .. attention::

      |TWOLANGUAGE|

   The :ref:`OESpruceFilterOptions <OESpruce_OESpruceFilterOptions>` class holds options classes that are used for structural checks. Default constructing this options class, constructs all the necessary
   options classes, which can then be accessed and modified.
   This class stores the optional parameter sets for use in the :oe:func:`OESpruce::OEMakeDesignUnits` and
   :oe:func:`OESpruce::OEMakeDesignUnit` functions.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESpruceFilterOptions()
            OESpruceFilterOptions(const OESpruceFilterOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESpruceFilterOptions() -> OESpruceFilterOptions
            OESpruceFilterOptions(arg2: OESpruceFilterOptions) -> OESpruceFilterOptions

      Default, copy, and advanced constructor that constructs a `OESpruceFilterOptions` object. 

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESpruceFilterOptions &operator=(const OESpruceFilterOptions &)

      Assignment operator.

   .. oe:method:: GetDeleteFloatingRes

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetDeleteFloatingRes() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeleteFloatingRes() -> bool

      Returns the boolean whether or not to delete floating residues

   .. oe:method:: GetFixBackboneAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFixBackboneAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixBackboneAtoms() -> bool

      Returns the boolean whether or not to fix incorrect backbone atoms. If FixBackboneAtoms is set to true, spruce filter will delete incorrect partial backbone atoms.

   .. oe:method:: GetFixBondsToMetals

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFixBondsToMetals() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixBondsToMetals() -> bool

      Returns the boolean whether or not to fix covalent bonds to metals. If FixBondsToMetals option is set to true, spruce filter function will set bond order of the incorrect covalent bonds to metals to 0.

   .. oe:method:: GetFixChainIDs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFixChainIDs() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixChainIDs() -> bool

      Returns the boolean whether or not to fix chain IDs. If FixChainIDs is set to true, spruce filter will assign incorrect chain IDs based on structural context.

   .. oe:method:: GetFixInvalidCovalentBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFixInvalidCovalentBonds() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixInvalidCovalentBonds() -> bool

      Returns the boolean of whether or not to fix covalent bond structure. If FixInvalidCovalentBonds option is set to true, bonds deemed invalid will be deleted or flagged, depending on whether structural modifications are allowed.

   .. oe:method:: GetFixNames

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFixNames() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixNames() -> bool

      Returns the boolean whether or not to fix incorrect names for all components. If FixNames is set to true, spruce filter function will rename ligands named "UNL" to "LIG" and residues named "NMA" will change to "NME" with CA atoms renamed to "CH3".
      Spruce filter will fail if residue has name "UNK".

   .. oe:method:: GetFixResStates

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFixResStates() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixResStates() -> bool

      Returns the boolean of whether or not to fix protein residue states

.. _OESpruce_OESpruceFilterOptions_SetDeleteFloatingRes:

   .. oe:method:: SetDeleteFloatingRes

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetDeleteFloatingRes(bool DeleteFloatingRes)

      .. oe:language:: python

         .. oe:api:: python

            SetDeleteFloatingRes(value: bool) -> bool

      Sets the boolean of whether or not to delete floating residues

.. _OESpruce_OESpruceFilterOptions_SetFixBackboneAtoms:

   .. oe:method:: SetFixBackboneAtoms

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixBackboneAtoms(bool FixBackboneAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetFixBackboneAtoms(value: bool) -> bool

      Sets the boolean of whether or not to fix incorrect backbone atoms

.. _OESpruce_OESpruceFilterOptions_SetFixBondsToMetals:

   .. oe:method:: SetFixBondsToMetals

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixBondsToMetals(bool FixBondOrder)

      .. oe:language:: python

         .. oe:api:: python

            SetFixBondsToMetals(value: bool) -> bool

      Sets the boolean of whether or not to fix covalent bonds to metals

.. _OESpruce_OESpruceFilterOptions_SetFixChainIDs:

   .. oe:method:: SetFixChainIDs

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixChainIDs(bool FixChainIDs)

      .. oe:language:: python

         .. oe:api:: python

            SetFixChainIDs(value: bool) -> bool

      Sets the boolean of whether or not to fix fix chainIDs

.. _OESpruce_OESpruceFilterOptions_SetFixInvalidCovalentBonds:

   .. oe:method:: SetFixInvalidCovalentBonds

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixInvalidCovalentBonds(bool FixInvalidCovalentBonds)

      .. oe:language:: python

         .. oe:api:: python

            SetFixInvalidCovalentBonds(value: bool) -> bool

      Returns the boolean of whether or not to fix covalent bond structure

.. _OESpruce_OESpruceFilterOptions_SetFixNames:

   .. oe:method:: SetFixNames

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetFixNames(bool FixNames)

      .. oe:language:: python

         .. oe:api:: python

            SetFixNames(value: bool) -> bool

      Sets the boolean of whether or not to fix incorrect names for all components.

.. _OESpruce_OESpruceFilterOptions_SetFixResStates:

   .. oe:method:: SetFixResStates

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetFixResStates() const

      .. oe:language:: python

         .. oe:api:: python

            SetFixResStates(value: bool) -> bool

      Sets the boolean of whether or not to fix protein residue states



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OEStructuralSuperposition, StructuralSuperposition, Superposition

.. _OESpruce_OEStructuralSuperposition:

.. oe:class:: OEStructuralSuperposition

   .. warning::

      |DEPRECATED-API|
      Please use :ref:`OESuperpose <OESpruce_OESuperpose>` class instead. 

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEStructuralSuperposition

   This class represents :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>`
   that performs a structural superposition on fit protein to a
   reference protein, using a superposition method given as an
   optional parameter.

   .. seealso::

      * :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` class
      * :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEStructuralSuperposition(const OEChem::OEMolBase& argRefMol,
                                      const OEChem::OEMolBase& argFitMol,
                                      const OESuperpositionOptions& argOpts = OESuperpositionOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEStructuralSuperposition(argRefMol: Union[OEGraphMol,OEMol,OEQMol],
                                      argFitMol: Union[OEGraphMol,OEMol,OEQMol],
                                      argOpts: OESuperpositionOptions = OESuperpositionOptions()) -> OEStructuralSuperposition

      Constructor that superimposes the ``argFitMol`` to the ``argRefMol``.
      If no :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` are passed in as ``argOpts``,
      then the default behavior of using a superposition to all globally matched atoms will be used.

      Both ``argRefMol`` and ``argFitMol`` must have 3D coordinates assigned.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEStructuralSuperposition(const OEStructuralSuperposition& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEStructuralSuperposition(rhs: OEStructuralSuperposition) -> OEStructuralSuperposition

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEStructuralSuperposition &operator=(const OEStructuralSuperposition &rhs)

      Assignment operator.

   ..   _OESpruce_OEStructuralSuperposition_operator_bool:

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool()

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>` object is
      valid.

   ..   _OESpruce_OEStructuralSuperposition_ConstraintsMet:

   .. oe:method:: ConstraintsMet

       .. oe:language:: c++ java csharp

          .. oe:api::

             bool ConstraintsMet() const

       .. oe:language:: python

          .. oe:api:: python

             ConstraintsMet() -> bool

      Returns whether or not the constraints were met.

   ..   _OESpruce_OEStructuralSuperposition_GetFitChains:

   .. oe:method:: GetFitChains

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetFitChains() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitChains() -> OEStringVector

      Returns 1-letter code of all names of fit protein chains.

      .. seealso::

         * :oe:meth:`OESpruce::OEStructuralSuperposition::GetRefChains` method

   ..   _OESpruce_OEStructuralSuperposition_GetRMSD:

   .. oe:method:: GetRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetRMSD() -> float

      Returns the RMSD of the structural superposition.

   ..   _OESpruce_OEStructuralSuperposition_GetRefChains:

   .. oe:method:: GetRefChains

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetRefChains() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefChains() -> OEStringVector

      Returns 1-letter code of all names of reference protein chains.

      .. seealso::

         * :oe:meth:`OESpruce::OEStructuralSuperposition::GetFitChains` method

   ..   _OESpruce_OEStructuralSuperposition_GetRegion:

   .. oe:method:: GetRegion

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<int> GetRegion() const

      .. oe:language:: python

         .. oe:api:: python

            GetRegion() -> OEIntVector

      Returns the index of all residues involved in the alignment.

   ..   _OESpruce_OEStructuralSuperposition_GetRotMatrix:

   .. oe:method:: GetRotMatrix

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetRotMatrix(double* rmat) const

      .. oe:language:: python

         .. oe:api:: python

            GetRotMatrix(rmat: OEDoubleArray) -> None

      Returns by reference the rotation matrix of the superposition.

   ..   _OESpruce_OEStructuralSuperposition_GetScore:

   .. oe:method:: GetScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetScore() -> int

      Returns the sequence alignment score for the structural superposition.

   ..   _OESpruce_OEStructuralSuperposition_GetTranslation:

   .. oe:method:: GetTranslation

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetTranslation(double* trans) const

      .. oe:language:: python

         .. oe:api:: python

            GetTranslation(trans: OEDoubleArray) -> None

      Returns by reference the translation vector of the superposition.

   ..   _OESpruce_OEStructuralSuperposition_Transform:

   .. oe:method:: Transform

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Transform(OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Transform(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

      Transforms the input molecule using the stored rotation matrix and translation vector from the superposition.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEStructureMetadata:

.. oe:class:: OEStructureMetadata

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEStructureMetadata

   This class stores structural information used in design unit preparation within the :oe:func:`OESpruce::OEMakeDesignUnits` function.

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEStructureMetadata()
            OEStructureMetadata(const OEStructureMetadata &)
            OEStructureMetadata(const std::vector<OEHeterogenMetadata>& hetData)
            OEStructureMetadata(const std::vector<OEHeterogenMetadata>& hetData,
                                const std::vector<OESequenceMetadata>& seqData)

      .. oe:language:: python

         .. oe:api:: python

            OEStructureMetadata() -> OEStructureMetadata
            OEStructureMetadata(hetData: OEHeterogenMetadataVector) -> OEStructureMetadata
            OEStructureMetadata(hetData: OEHeterogenMetadataVector,
                                seqData: OESequenceMetadataVector) -> OEStructureMetadata
            OEStructureMetadata(arg2: OEStructureMetadata) -> OEStructureMetadata

      Default, copy, and advanced constructor that constructs an `OEStructureMetadata` object. The advanced constructor takes a combination of two separate data classes as arguments: a class that stores the structural metadata (:ref:`OEStructureMetadata <OESpruce_OEStructureMetadata>`), and a class that stores the heterogen metadata (:ref:`OEHeterogenMetadata <OESpruce_OEHeterogenMetadata>`). A separate overload that takes a `std::vector` of each of those data classes is also available.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEStructureMetadata &operator=(const OEStructureMetadata &)

      Assignment operator.

   .. oe:method:: AddHeterogenMetadata

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddHeterogenMetadata(const OEHeterogenMetadata& hetData)
            void AddHeterogenMetadata(const std::vector<OEHeterogenMetadata>& hetData)

      .. oe:language:: python

         .. oe:api:: python

            AddHeterogenMetadata(hetData: OEHeterogenMetadataVector) -> None
            AddHeterogenMetadata(hetData: OEHeterogenMetadata) -> None

      Adds the heterogen metadata (:ref:`OEHeterogenMetadata <OESpruce_OEHeterogenMetadata>`) as a single object or as a `std::vector` of objects.

   .. oe:method:: AddKeyword

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddKeyword(const std::string& keyword)

      .. oe:language:: python

         .. oe:api:: python

            AddKeyword(keyword: str) -> None

      Adds a string keyword.

   .. oe:method:: AddKeywords

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddKeywords(const std::vector<std::string>& keywords)

      .. oe:language:: python

         .. oe:api:: python

            AddKeywords(keywords: OEStringVector) -> None

      Adds a `std::vector` of string keywords.

   .. oe:method:: AddSequenceMetadata

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddSequenceMetadata(const OESequenceMetadata& seqData)
            void AddSequenceMetadata(const std::vector<OESequenceMetadata>& seqData)

      .. oe:language:: python

         .. oe:api:: python

            AddSequenceMetadata(seqData: OESequenceMetadataVector) -> None
            AddSequenceMetadata(seqData: OESequenceMetadata) -> None

      Adds the sequence metadata (:ref:`OESequenceMetadata <OESpruce_OESequenceMetadata>`) as a single object or as a `std::vector` of objects.

   .. oe:method:: ClearHeterogenMetadata

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearHeterogenMetadata()

      .. oe:language:: python

         .. oe:api:: python

            ClearHeterogenMetadata() -> None

      Clears all heterogen metadata.

   .. oe:method:: ClearKeywords

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearKeywords()

      .. oe:language:: python

         .. oe:api:: python

            ClearKeywords() -> None

      Clears all keywords.

   .. oe:method:: ClearSequenceMetadata

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearSequenceMetadata()

      .. oe:language:: python

         .. oe:api:: python

            ClearSequenceMetadata() -> None

      Clears all sequence metadata.

   .. oe:method:: GetAuthor

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetAuthor() const

      .. oe:language:: python

         .. oe:api:: python

            GetAuthor() -> str

      Returns the name of the author.

   .. oe:method:: GetExperimentDate

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetExperimentDate() const

      .. oe:language:: python

         .. oe:api:: python

            GetExperimentDate() -> str

      Returns the string version of the experiment date.

   .. oe:method:: GetExperimentType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetExperimentType() const

      .. oe:language:: python

         .. oe:api:: python

            GetExperimentType() -> int

      Returns the experiment type as defined by the :oe:constns:`OESpruce::OEExperimentType` namespace.

   .. oe:method:: GetHeterogenMetadata

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<OEHeterogenMetadata>& GetHeterogenMetadata()
            const std::vector<OEHeterogenMetadata>& GetHeterogenMetadata() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeterogenMetadata() -> OEHeterogenMetadataVector

      Returns a reference to the `std::vector` of stored heterogen metadata (:ref:`OEHeterogenMetadata <OESpruce_OEHeterogenMetadata>`) objects.

   .. oe:method:: GetIridiumData

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBio::OEIridiumData& GetIridiumData()
            const OEBio::OEIridiumData& GetIridiumData() const

      .. oe:language:: python

         .. oe:api:: python

            GetIridiumData() -> OEIridiumData

      Returns a reference to the Iridium data (:ref:`OEIridiumData <OEBio_OEIridiumData>`) object.

   .. oe:method:: GetKeywords

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string>& GetKeywords()
            const std::vector<std::string>& GetKeywords() const

      .. oe:language:: python

         .. oe:api:: python

            GetKeywords() -> OEStringVector

      Returns a reference to the vector of keyword strings.

   .. oe:method:: GetRevision

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetRevision() const

      .. oe:language:: python

         .. oe:api:: python

            GetRevision() -> str

      Returns the revision.

   .. oe:method:: GetRevisionDate

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetRevisionDate() const

      .. oe:language:: python

         .. oe:api:: python

            GetRevisionDate() -> str

      Returns the string version of the revision date.

   .. oe:method:: GetSequenceMetadata

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<OESequenceMetadata>& GetSequenceMetadata()
            const std::vector<OESequenceMetadata>& GetSequenceMetadata() const

      .. oe:language:: python

         .. oe:api:: python

            GetSequenceMetadata() -> OESequenceMetadataVector

   .. oe:method:: GetStructureID

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetStructureID() const

      .. oe:language:: python

         .. oe:api:: python

            GetStructureID() -> str

      Returns the structure's ID.

   .. oe:method:: SetAuthor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAuthor(const std::string& author)

      .. oe:language:: python

         .. oe:api:: python

            SetAuthor(author: str) -> None

      Sets the author's name.

   .. oe:method:: SetExperimentDate

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetExperimentDate(const std::string& exptDate)

      .. oe:language:: python

         .. oe:api:: python

            SetExperimentDate(exptDate: str) -> None

      Sets the string version of the experiment date.

   .. oe:method:: SetExperimentType

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetExperimentType(unsigned exprType)

      .. oe:language:: python

         .. oe:api:: python

            SetExperimentType(exprType: int) -> None

      Sets the experiment type as defined by the :oe:constns:`OESpruce::OEExperimentType` namespace.

   .. oe:method:: SetIridiumData

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetIridiumData(const OEBio::OEIridiumData& iridData)

      .. oe:language:: python

         .. oe:api:: python

            SetIridiumData(iridData: OEIridiumData) -> None

      Sets the Iridium data from an :ref:`OEIridiumData <OEBio_OEIridiumData>` object.

   .. oe:method:: SetRevision

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRevision(const std::string& revVersion)

      .. oe:language:: python

         .. oe:api:: python

            SetRevision(revVersion: str) -> None

      Sets the revision.

   .. oe:method:: SetRevisionDate

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRevisionDate(const std::string& revDate)

      .. oe:language:: python

         .. oe:api:: python

            SetRevisionDate(revDate: str) -> None

      Sets the string version of the revision date.

   .. oe:method:: SetStructureID

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStructureID(const std::string& structureID)

      .. oe:language:: python

         .. oe:api:: python

            SetStructureID(structureID: str) -> None

      Sets the string version of the structure's ID.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESuperpose, Superpose, Superposition, StructuralSuperposition, SecondaryStructureSuperposition

.. _chapter_sprucetk_superposition:

.. _OESpruce_OESuperpose:

.. oe:class:: OESuperpose

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESuperpose

   This class performs a structural superposition of a fit protein onto a
   reference protein. The superposition method (see
   :oe:constns:`OESpruce::OESuperposeMethod`) and other options are controlled
   through the :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` class.
   Results including RMSD and TM-score are returned via
   :ref:`OESuperposeResults <OESpruce_OESuperposeResults>`.

   .. seealso::

      * :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` class
      * :ref:`OESuperposeResults <OESpruce_OESuperposeResults>` class

   .. admonition:: Code Example

      * :ref:`Spruce_examples_superposition` example

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESuperpose(const OESuperposeOptions& opts = OESuperposeOptions(OESuperposeMethod::Default))

      .. oe:language:: python

         .. oe:api:: python

            OESuperpose(opts: OESuperposeOptions = OESuperposeOptions(OESuperposeMethod_Default)) -> OESuperpose

      Constructor for superposing molecules given the specified method and other options.
      If no :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` are passed in as ``opts``,
      then the default behavior of using a superposition to all globally matched atoms will be used.

      .. seealso:

         :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` class
         :oe:constns:`OESpruce::OESuperposeMethod` namespace

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESuperpose(const OESuperpose& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESuperpose(rhs: OESuperpose) -> OESuperpose

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESuperpose& operator=(const OESuperpose& rhs)

      Assignment operator.

   .. _OESpruce_OESuperPose_HasRef:

   .. oe:method:: HasRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasRef() const

      .. oe:language:: python

         .. oe:api:: python

            HasRef() -> bool

      Returns whether or not the reference is set.

   .. _OESpruce_OESuperPose_HasConstraintMol:

   .. oe:method:: HasConstraintMol

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasConstraintMol() const

      .. oe:language:: python

         .. oe:api:: python

            HasConstraintMol() -> bool

      Returns whether or not the constraint molecule is set.

   .. _OESpruce_OESuperPose_Clear:

   .. oe:method:: Clear

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Clears the reference and the constraint molecule.
      
   .. _OESpruce_OESuperPose_SetOptions:

   .. oe:method:: SetOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetOptions(const OESuperposeOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(opts: OESuperposeOptions) -> bool

      Sets the options for the superposition.

      .. seealso:

         :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` class

   .. _OESpruce_OESuperPose_SetupRef:

   .. oe:method:: SetupRef

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEBio::OEDesignUnit& refDU,
                          const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& refPred = OEChem::OEIsTrueAtom())
            bool SetupRef(const OEChem::OEMolBase& refMol,
                          const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& refPred = OEChem::OEIsTrueAtom())
            bool SetupRef(const OEChem::OEMolBase& refMol,
                          const OEChem::OEMolBase& refConstraintMol,
                          const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& refPred = OEChem::OEIsTrueAtom())
            bool SetupRef(const OEChem::OEMolBase& refMol,
                          const std::vector<std::string>& siteResidues,
                          const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& refPred = OEChem::OEIsTrueAtom())
            bool SetupRef(const OEChem::OEMolBase& refMol,
                          const OEChem::OEMolBase& refConstraintMol,
                          const std::vector<std::string>& siteResidues,
                          const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& refPred = OEChem::OEIsTrueAtom())

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(refDU: OEDesignUnit,
                     refPred: OEUnaryAtomPred = OEIsTrueAtom()) -> bool
            SetupRef(refMol: Union[OEGraphMol,OEMol,OEQMol],
                     refPred: OEUnaryAtomPred = OEIsTrueAtom()) -> bool
            SetupRef(refMol: Union[OEGraphMol,OEMol,OEQMol],
                     refConstraintMol: Union[OEGraphMol,OEMol,OEQMol],
                     refPred: OEUnaryAtomPred = OEIsTrueAtom()) -> bool
            SetupRef(refMol: Union[OEGraphMol,OEMol,OEQMol],
                     siteResidues: OEStringVector,
                     refPred: OEUnaryAtomPred = OEIsTrueAtom()) -> bool
            SetupRef(refMol: Union[OEGraphMol,OEMol,OEQMol],
                     refConstraintMol: Union[OEGraphMol,OEMol,OEQMol],
                     siteResidues: OEStringVector,
                     refPred: OEUnaryAtomPred = OEIsTrueAtom()) -> bool

      Sets up the reference molecule, constraint molecule, or site residues if given. A predicate (``refPred``) can be 
      passed to subset the reference. If the reference is given as an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object, then the
      constraint molecule (ligand) and the site residues will be set if such information is available in the design unit. 
      The function returns true if the setup is successful.

      The ``refMol`` argument must have 3D coordinates assigned.

 .. _OESpruce_OESuperPose_SetMethod:

 .. oe:method:: SetMethod

      .. oe:api::

         bool SetMethod(unsigned value)

      Sets the type of superposition to be performed. Types are taken from the
      constants given in :oe:constns:`OESpruce::OESuperposeMethod`.

      .. note::

         This switches the method used during superposition, but not the default, user defined, valid RMSD,
         seqScore, or Tanimoto values.
         This  means switching between a shape and sequence based method requires the user to explicitly set proper
         values for these or, alternatively, reconstruct the class with a new method.

   .. _OESpruce_OESuperPose_Superpose:

   .. oe:method:: Superpose

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Superpose(OESuperposeResults& results,
                           const OEChem::OEMolBase& fitMol,
                           const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& fitPred = OEChem::OEIsTrueAtom()) const
            bool Superpose(OESuperposeResults& results,
                           const OEChem::OEMolBase& fitMol,
                           const OEChem::OEMolBase& fitConstraintMol,
                           const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& fitPred = OEChem::OEIsTrueAtom()) const
            bool Superpose(OESuperposeResults& results,
                           const OEBio::OEDesignUnit& fitDU,
                           const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& fitPred = OEChem::OEIsTrueAtom()) const

      .. oe:language:: python

         .. oe:api:: python

            Superpose(results: OESuperposeResults,
                      fitMol: Union[OEGraphMol,OEMol,OEQMol],
                      fitPred: OEUnaryAtomPred = OEIsTrueAtom()) -> bool
            Superpose(results: OESuperposeResults,
                      fitMol: Union[OEGraphMol,OEMol,OEQMol],
                      fitConstraintMol: Union[OEGraphMol,OEMol,OEQMol],
                      fitPred: OEUnaryAtomPred = OEIsTrueAtom()) -> bool
            Superpose(results: OESuperposeResults, fitDU: OEDesignUnit,
                      fitPred: OEUnaryAtomPred = OEIsTrueAtom()) -> bool

      Superimposes the fit molecule onto the reference. A predicate (``fitPred``) can be passed to subset the reference. 
      The results for the superposition will be stored in ``results``. The function returns ``results.IsValid()``.

      .. seealso:

         :ref:`OESuperposeResults <OESpruce_OESuperposeResults>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESuperposeOptions, SuperposeOptions, OESuperpose

.. _OESpruce_OESuperposeOptions:

.. oe:class:: OESuperposeOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESuperposeOptions

   This class represents :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` that sets
   the optional parameters for structural superposition using the :ref:`OESuperpose <OESpruce_OESuperpose>` class.

   .. seealso::
      
      * :ref:`OESuperpose <OESpruce_OESuperpose>` class
      * :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>` class
      * :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class

   .. admonition:: Code Example

      * :ref:`spruce_examples_superposition` example

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESuperposeOptions(const unsigned method = OESuperposeMethod::Default)

      .. oe:language:: python

         .. oe:api:: python

            OESuperposeOptions(method: int) -> OESuperposeOptions

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESuperposeOptions(const OESuperposeOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESuperposeOptions(arg2: OESuperposeOptions) -> OESuperposeOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESuperposeOptions &operator=(const OESuperposeOptions &argOpts)

      Assignment operator.

.. _OESpruce_OESuperposeOptions_GetMethod:

   .. oe:method:: GetMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetMethod() -> int

      Returns the type of superposition to be performed. Types are given from the constants
      given in :ref:`OESuperposeMethod <OESpruce_OESuperposeMethod>`.
      The default type is :ref:`Default <OESpruce_OESuperposeMethod_Default>`.

.. _OESpruce_OESuperposeOptions_SetMethod:

   .. oe:method:: SetMethod

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMethod(unsigned value)

      .. oe:language:: python

         .. oe:api:: python

            SetMethod(value: int) -> bool

      Sets the type of superposition to be performed. Types are taken from the
      constants given in :ref:`OESuperposeMethod <OESpruce_OESuperposeMethod>`.

.. _OESpruce_OESuperposeOptions_GetUseConstraints:

   .. oe:method:: GetUseConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseConstraints() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseConstraints() -> bool

      Returns whether or not ligand or site-residue constraints should be used to validate the superposition.

      .. seealso::

         * :ref:`SetUseConstraints <OESpruce_OESuperposeOptions_SetUseConstraints>` method
         * :ref:`SetupRef <OESpruce_OESuperpose_SetupRef>` method
         * :ref:`Superpose <OESpruce_OESuperpose_Superpose>` method

.. _OESpruce_OESuperposeOptions_SetUseConstraints:

   .. oe:method:: SetUseConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseConstraints(bool value)

      .. oe:language:: python

         .. oe:api:: python

            SetUseConstraints(value: bool) -> bool

      Sets whether or not ligand or site-residue constraints should be used to validate the superposition.

      .. seealso::

         * :ref:`GetUseConstraints <OESpruce_OESuperposeOptions_GetUseConstraints>` method
         * :ref:`SetupRef <OESpruce_OESuperpose_SetupRef>` method
         * :ref:`Superpose <OESpruce_OESuperpose_Superpose>` method

.. _OESpruce_OESuperposeOptions_GetValidRMSD:

   .. oe:method:: GetValidRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetValidRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetValidRMSD() -> float

      Returns the RMSD threshold for validating the superposition of the reference and fit molecules. 
      :oe:meth:`OESpruce::OESuperposeResults::IsValid` returns false if the RMSD of the superposed molecules exceeds this threshold. 
      The default value is 10.0 Angstroms for sequence-based methods and -1.0 for shape-based methods (RMSD calculation is only 
      applicable to sequence-based methods).

      .. seealso::
         
         * :ref:`SetValidRMSD <OESpruce_OESuperposeOptions_SetValidRMSD>` method
         * :ref:`IsValid <OESpruce_OESuperposeResults_IsValid>` method
         * :ref:`GetRMSD <OESpruce_OESuperposeResults_GetRMSD>` method

.. _OESpruce_OESuperposeOptions_SetValidRMSD:

   .. oe:method:: SetValidRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetValidRMSD(double value)

      .. oe:language:: python

         .. oe:api:: python

            SetValidRMSD(value: float) -> bool

      Sets the RMSD threshold for validating the superposition of the reference and fit molecules. 

      .. warning::

         RMSD calculation is only applicable to sequence-based methods. Please avoid using this function when running shape-based superposition.
      
      .. seealso::

         * :ref:`SetValidRMSD <OESpruce_OESuperposeOptions_GetValidRMSD>` method

.. _OESpruce_OESuperposeOptions_GetValidTanimoto:

   .. oe:method:: GetValidTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetValidTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetValidTanimoto() -> float

      Returns the Tanimoto threshold for validating the superposition of the reference and fit molecules. 
      :oe:meth:`OESpruce::OESuperposeResults::IsValid` returns false if the Tanimoto of the superposed molecules is smaller than this 
      threshold. The default value is 0.0 for shape-based methods and -1.0 for sequence-based methods (Tanimoto calculation 
      is only applicable to shape-based methods).

      .. seealso::
         
         * :ref:`SetValidTanimoto <OESpruce_OESuperposeOptions_SetValidTanimoto>` method
         * :ref:`IsValid <OESpruce_OESuperposeResults_IsValid>` method
         * :ref:`GetTanimoto <OESpruce_OESuperposeResults_GetTanimoto>` method

.. _OESpruce_OESuperposeOptions_SetValidTanimoto:

   .. oe:method:: SetValidTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetValidTanimoto(double value)

      .. oe:language:: python

         .. oe:api:: python

            SetValidTanimoto(value: float) -> bool

      Sets the Tanimoto threshold for validating the superposition of the reference and fit molecules. 

      .. warning::

         Tanimoto calculation is only applicable to shape-based methods. Please avoid using this function when running sequence-based superposition.

      .. seealso::

         * :ref:`GetValidRMSD <OESpruce_OESuperposeOptions_GetValidRMSD>` method

.. _OESpruce_OESuperposeOptions_GetValidSeqScore:

   .. oe:method:: GetValidSeqScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetValidSeqScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetValidSeqScore() -> int

      Returns the sequence alignment score threshold for validating the superposition of the reference and fit molecules. 
      :oe:meth:`OESpruce::OESuperposeResults::IsValid` returns false if the sequence alignment score of the superposed molecules is smaller 
      than this threshold. The default value is 200 for sequence-based methods and -1000 for shape-based methods (sequence alignment score  
      is only applicable to sequence-based methods).

      .. seealso::
         
         * :ref:`SetValidSeqScore <OESpruce_OESuperposeOptions_SetValidSeqScore>` method
         * :ref:`IsValid <OESpruce_OESuperposeResults_IsValid>` method
         * :ref:`GetSeqScore <OESpruce_OESuperposeResults_GetSeqScore>` method

.. _OESpruce_OESuperposeOptions_SetValidSeqScore:

   .. oe:method:: SetValidSeqScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetValidSeqScore(int value)

      .. oe:language:: python

         .. oe:api:: python

            SetValidSeqScore(value: int) -> bool

      Sets the sequence alignment score threshold for validating the superposition of the reference and fit molecules. 

      .. warning::

         sequence alignment score is only applicable to sequence-based methods. Please avoid using this function when running shape-based superposition.

      .. seealso::

         * :ref:`GetValidRMSD <OESpruce_OESuperposeOptions_GetValidRMSD>` method

.. _OESpruce_OESuperposeOptions_GetUseSeqScoreChainMatching:

   .. oe:method:: GetUseSeqScoreChainMatching

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseSeqScoreChainMatching() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseSeqScoreChainMatching() -> bool

      Returns whether or not combined sequence alignment score should be used to match chains for multi-chain complexes.

      .. seealso::

         * :ref:`SetUseSeqScoreChainMatching <OESpruce_OESuperposeOptions_SetUseSeqScoreChainMatching>` method

.. _OESpruce_OESuperposeOptions_SetUseSeqScoreChainMatching:

   .. oe:method:: SetUseSeqScoreChainMatching

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetUseSeqScoreChainMatching(bool value)

      .. oe:language:: python

         .. oe:api:: python

            SetUseSeqScoreChainMatching(value: bool) -> bool

      Sets whether or not combined sequence alignment score should be used to match chains for multi-chain complexes.

      .. seealso::

         * :ref:`GetUseSeqScoreChainMatching <OESpruce_OESuperposeOptions_GetUseSeqScoreChainMatching>` method


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESuperposeResults, SuperposeResults, Superpose, superposition

.. _OESpruce_OESuperposeResults:

.. oe:class:: OESuperposeResults

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESuperposeResults

   This class stores superposition results generated by :ref:`OESuperpose <OESpruce_OESuperpose>`.

   .. seealso::

      * :ref:`OESuperpose <OESpruce_OESuperpose>` class

   .. admonition:: Code Example

      * :ref:`spruce_examples_superposition` example

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESuperposeResults()

      .. oe:language:: python

         .. oe:api:: python

            OESuperposeResults() -> OESuperposeResults

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESuperposeResults(const OESuperposeResults& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESuperposeResults(rhs: OESuperposeResults) -> OESuperposeResults
            OESuperposeResults(arg2: OESuperposeResults) -> OESuperposeResults

      Copy constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESuperposeResults(OESuperposeResults&&)

      Move constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESuperposeResults& operator=(const OESuperposeResults& rhs)

      Assignment operator.

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns true if the superposition is valid and false if not, which can be also obtained by calling 
      :ref:`IsValid <OESpruce_OESuperposeResults_IsValid>`.

      .. seealso::

         * :ref:`IsValid <OESpruce_OESuperposeResults_IsValid>` method

   .. _OESpruce_OESuperposeResults_IsValid:

   .. oe:method::  IsValid

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns true if the superposition is valid and false if not. The superposition is valid if the scores (RMSD, Tanimoto, and sequence alignment score) 
      satisfy the thresholds set in the :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` class.

      .. seealso::

         * :ref:`GetValidRMSD <OESpruce_OESuperposeOptions_GetValidRMSD>` method
         * :ref:`GetValidTanimoto <OESpruce_OESuperposeOptions_GetValidTanimoto>` method
         * :ref:`GetValidSeqScore <OESpruce_OESuperposeOptions_GetValidSeqScore>` method

   .. _OESpruce_OESuperposeResults_Transform:

   .. oe:method::  Transform

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Transform(OEChem::OEMolBase& mol) const
            bool Transform(OEBio::OEDesignUnit& du) const

      .. oe:language:: python

         .. oe:api:: python

            Transform(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            Transform(du: OEDesignUnit) -> bool

      Returns true and transforms the input molecule using the stored transform from the superposition if they are valid. 
      Otherwise, the function does nothing and returns false.

      .. seealso::

         * :ref:`OETrans <OEChem_OETrans>` class
         * :ref:`GetTransform <OESpruce_OESuperposeResults_GetTransform>` method

   .. _OESpruce_OESuperposeResults_GetTransform:

   .. oe:method::  GetTransform

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEChem::OETrans& GetTransform() const

      .. oe:language:: python

         .. oe:api:: python

            GetTransform() -> OETrans

      Returns the :ref:`OETrans <OEChem_OETrans>` object that stores the rotation matrix and translation vector from the superposition.

      .. seealso::

         * :ref:`OETrans <OEChem_OETrans>` class
         * :ref:`Transform <OESpruce_OESuperposeResults_Transform>` method
         * :ref:`GetRotMatrix <OESpruce_OESuperposeResults_GetRotMatrix>` method
         * :ref:`GetTranslation <OESpruce_OESuperposeResults_GetTranslation>` method

   .. _OESpruce_OESuperposeResults_GetRotMatrix:

   .. oe:method::  GetRotMatrix

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetRotMatrix(double* rmat) const

      .. oe:language:: python

         .. oe:api:: python

            GetRotMatrix(rmat: OEDoubleArray) -> bool

      Returns by reference the rotation matrix of the superposition.

   .. _OESpruce_OESuperposeResults_GetTranslation:

   .. oe:method::  GetTranslation

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetTranslation(double* trans) const

      .. oe:language:: python

         .. oe:api:: python

            GetTranslation(trans: OEDoubleArray) -> bool

      Returns by reference the translation vector of the superposition.

   .. _OESpruce_OESuperposeResults_HasRMSD:

   .. oe:method::  HasRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            HasRMSD() -> bool

      Returns whether RMSD was calculated for the superposed molecules. RMSD is only applicable to sequence-based methods, such as 
      :ref:`Global <OESpruce_OESuperposeMethod_Global>`, :ref:`Site <OESpruce_OESuperposeMethod_Site>`, :ref:`DDM <OESpruce_OESuperposeMethod_DDM>`, 
      and :ref:`Weighted <OESpruce_OESuperposeMethod_Weighted>`.

   .. _OESpruce_OESuperposeResults_HasTanimoto:

   .. oe:method::  HasTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            HasTanimoto() -> bool

      Returns whether Tanimoto was calculated for the superposed molecules. Tanimoto is only applicable to shape-based methods, such as 
      :ref:`SSE <OESpruce_OESuperposeMethod_SSE>`.

   .. _OESpruce_OESuperposeResults_HasSeqScore:

   .. oe:method::  HasSeqScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasSeqScore() const

      .. oe:language:: python

         .. oe:api:: python

            HasSeqScore() -> bool

      Returns whether sequence alignment score was calculated for the superposed molecules. sequence alignment score is only applicable to sequence-based methods, such as 
      :ref:`Global <OESpruce_OESuperposeMethod_Global>`, :ref:`Site <OESpruce_OESuperposeMethod_Site>`, :ref:`DDM <OESpruce_OESuperposeMethod_DDM>`,
      and :ref:`Weighted <OESpruce_OESuperposeMethod_Weighted>`.

   .. _OESpruce_OESuperposeResults_GetRMSD:

   .. oe:method::  GetRMSD

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetRMSD() -> float

      Returns the RMSD of the structural superposition.

   .. _OESpruce_OESuperposeResults_GetTanimoto:

   .. oe:method::  GetTanimoto

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimoto() -> float

      Returns the Tanimoto of the structural superposition.

   .. _OESpruce_OESuperposeResults_GetSeqScore:

   .. oe:method::  GetSeqScore

      .. oe:language:: c++ java csharp

         .. oe:api::

            int GetSeqScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetSeqScore() -> int

      Returns the sequence alignment score of the structural superposition. The score is calculated by 
      summing the similarity scores of matched residues and gap penalties.
      
   .. _OESpruce_OESuperposeResults_GetRefChains:

   .. oe:method::  GetRefChains

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<std::string>& GetRefChains() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefChains() -> OEStringVector

      Returns 1-letter code of all names of reference protein chains.

      .. seealso::

         * :ref:`GetFitChains <OESpruce_OESuperposeResults_GetFitChains>` method

   .. _OESpruce_OESuperposeResults_GetFitChains:

   .. oe:method::  GetFitChains

      .. oe:language:: c++ java csharp

         .. oe:api::

            const std::vector<std::string>& GetFitChains() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitChains() -> OEStringVector

      Returns 1-letter code of all names of fit protein chains.

      .. seealso::

         * :ref:`GetRefChains <OESpruce_OESuperposeResults_GetRefChains>` method


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESuperpositionOptions, SuperpositionOptions, OEStructuralSuperposition

.. _OESpruce_OESuperpositionOptions:

.. oe:class:: OESuperpositionOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESuperpositionOptions

   This class represents :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` that sets
   the optional parameters for structural superposition using the :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>` class.

   .. seealso::

      * :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>` class
      * :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESuperpositionOptions()

      .. oe:language:: python

         .. oe:api:: python

            OESuperpositionOptions() -> OESuperpositionOptions

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESuperpositionOptions(const OESuperpositionOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESuperpositionOptions(rhs: OESuperpositionOptions) -> OESuperpositionOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESuperpositionOptions &operator=(const OESuperpositionOptions &argOpts)

      Assignment operator.

   .. oe:method:: AddSiteResidue

      .. oe:language:: c++ java csharp

         .. oe:api::

            void AddSiteResidue(const std::string& argSiteResidue)

      .. oe:language:: python

         .. oe:api:: python

            AddSiteResidue(argSiteResidue: str) -> None

      Add a single site residue for :oe:const:`OESpruce::OESuperpositionType::Site` -based
      superpositions based on a site-specific string that takes the form:
      ``<residue name>:<residue number>:<insertion code>:<chain id>``.

      .. seealso::

         * :oe:meth:`OESpruce::OESuperpositionOptions::SetSiteResidues` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::GetSiteResidues` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::ClearSiteResidues` method

   .. oe:method:: ClearLigandConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearLigandConstraints()

      .. oe:language:: python

         .. oe:api:: python

            ClearLigandConstraints() -> None

      Clear the stored ligand constraints, if they exist.

      .. seealso::

         * :oe:meth:`OESpruce::OESuperpositionOptions::SetLigandConstraints` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::GetLigandConstraints` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::HasLigandConstraints` method

   .. oe:method:: ClearSiteResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearSiteResidues()

      .. oe:language:: python

         .. oe:api:: python

            ClearSiteResidues() -> None

      Remove any existing site residues from the :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` object
      that would be used in the :oe:const:`OESpruce::OESuperpositionType::Site` -based superposition calculations.

      .. seealso::

         * :oe:meth:`OESpruce::OESuperpositionOptions::AddSiteResidue` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::SetSiteResidues` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::GetSiteResidues` method

   .. oe:method:: GetDist

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetDist() const

      .. oe:language:: python

         .. oe:api:: python

            GetDist() -> float

      Get the cutoff distance used in the nearest neighbors calculation for the site residue
      constraints (default = ``5.0 Angstroms``\ ) for
      :oe:const:`OESpruce::OESuperpositionType::Site` -based superpositions.

   .. oe:method:: GetLigandConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetLigandConstraints(OEChem::OEMolBase& refLig,
                                      OEChem::OEMolBase& fitLig) const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandConstraints(refLig: Union[OEGraphMol,OEMol,OEQMol],
                                 fitLig: Union[OEGraphMol,OEMol,OEQMol]) -> None

      Returns by reference the reference and fit ligand constraints that are stored.

      .. seealso::

         * :oe:meth:`OESpruce::OESuperpositionOptions::SetLigandConstraints` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::HasLigandConstraints` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::ClearLigandConstraints` method

   .. oe:method:: GetSiteResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<std::string> GetSiteResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetSiteResidues() -> OEStringVector

      Get the site residues used in the :oe:const:`OESpruce::OESuperpositionType::Site` -based
      calculation.

   .. oe:method:: GetSuperpositionType

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetSuperpositionType() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuperpositionType() -> int

      Get the type of superposition to be performed. Types are given from the constants
      given in :oe:constns:`OESpruce::OESuperpositionType`.
      The default type is :oe:const:`OESpruce::OESuperpositionType::Default`.

   .. oe:method:: HasLigandConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool HasLigandConstraints() const

      .. oe:language:: python

         .. oe:api:: python

            HasLigandConstraints() -> bool

      Returns whether or not ligand constraints have been set.

      .. seealso::

         * :oe:meth:`OESpruce::OESuperpositionOptions::SetLigandConstraints` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::GetLigandConstraints` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::ClearLigandConstraints` method

   .. oe:method:: SetDist

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetDist(double argDist)

      .. oe:language:: python

         .. oe:api:: python

            SetDist(argDist: float) -> None

      Set the cutoff distance used in the nearest neighbors calculation for the site residue
      constraints for :oe:const:`OESpruce::OESuperpositionType::Site` -based superpositions.

   .. oe:method:: SetLigandConstraints

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetLigandConstraints(const OEChem::OEMolBase& refLig,
                                      const OEChem::OEMolBase& fitLig)

      .. oe:language:: python

         .. oe:api:: python

            SetLigandConstraints(refLig: Union[OEGraphMol,OEMol,OEQMol],
                                 fitLig: Union[OEGraphMol,OEMol,OEQMol]) -> None

      Sets the ligand constraints that will be used for the superposition.

      .. seealso::

         * :oe:meth:`OESpruce::OESuperpositionOptions::GetLigandConstraints` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::HasLigandConstraints` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::ClearLigandConstraints` method

   .. oe:method:: SetSiteResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetSiteResidues(const std::vector<std::string>& argSiteResidues)

      .. oe:language:: python

         .. oe:api:: python

            SetSiteResidues(argSiteResidues: OEStringVector) -> None

      Set all site residues at once for :oe:const:`OESpruce::OESuperpositionType::Site` -based
      superpositions using a string vector, where each string takes the
      form ``<residue name>:<residue number>:<insertion code>:<chain id>``.

      .. seealso::

         * :oe:meth:`OESpruce::OESuperpositionOptions::AddSiteResidue` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::GetSiteResidues` method
         * :oe:meth:`OESpruce::OESuperpositionOptions::ClearSiteResidues` method

   .. oe:method:: SetSuperpositionType

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetSuperpositionType(unsigned type)

      .. oe:language:: python

         .. oe:api:: python

            SetSuperpositionType(type: int) -> bool

      Set the type of superposition to be performed. Types are taken from the
      constants given in :oe:constns:`OESpruce::OESuperpositionType`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _chapter-sprucetk-validate-design-unit:

.. oe:namespace:: OESpruce

.. meta::
   :keywords: OEValidateDesignUnit, ValidateDesignUnit, ValidateDU

.. _OESpruce_OEValidateDesignUnit:

.. oe:class:: OEValidateDesignUnit

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEValidateDesignUnit

   This class performs a structural check after running Spruce preparation.

   It looks for:
    * Partial side chains
    * Partial charges
    * Implicit hydrogens
    * Incorrect terminal residues
    * Heavy atom overlap
    * Broken chains

   :ref:`OEDesignUnitIssueCodes <OESpruce_OEDesignUnitIssueCodes>` shows the type of issue codes.

   .. admonition:: Code Example

      * :ref:`spruce_examples_validate_design_unit`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEValidateDesignUnit()
            OEValidateDesignUnit(const OEValidateDesignUnit& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEValidateDesignUnit() -> OEValidateDesignUnit
            OEValidateDesignUnit(rhs: OEValidateDesignUnit) -> OEValidateDesignUnit

      Default and copy constructors for the OEValidateDesignUnit class.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEValidateDesignUnit& operator=(const OEValidateDesignUnit& rhs)

      Assignment operator.

   .. oe:method:: Validate

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned Validate(OEBio::OEDesignUnit& du,
                              const OESpruce::OEStructureMetadata& mdata = OESpruce::OEStructureMetadata())

      .. oe:language:: python

         .. oe:api:: python

            Validate(du: OEDesignUnit,
                     mdata: OEStructureMetadata = OEStructureMetadata()) -> int

      Returns a code which indicates the issues that are detected for this structure.

   .. oe:method:: GetMessages

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetMessages(const unsigned errorTypes = OEDesignUnitIssueCodes::ALL)

      .. oe:language:: python

         .. oe:api:: python

            GetMessages(errorTypes: int) -> str

      Returns the error message according to the provided error code.

   .. oe:method:: GetProblematicResidues

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::vector<OEChem::OEResidue> GetProblematicResidues(const unsigned errorTypes = OEDesignUnitIssueCodes::ALL)

      .. oe:language:: python

         .. oe:api:: python

            GetProblematicResidues(errorTypes: int) -> OEResidueVector

      Returns the problematic residues that have the issues indicated by the input error code.
      
 


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. oe:constnamespace:: OEAlternateLocationOption

   .. attention::

      |TWOLANGUAGE|

   This namespace contains methods to enumerate the alternate locations of a biomolecular structure.

   .. oe:constant:: Combinatorial

      Make all possible combinations of enumerated alternate locations.

   .. oe:constant:: Default

      Enumerate is the default option.

   .. oe:constant:: Enumerate

      Enumerate through all possible alternate locations.

   .. oe:constant:: Primary

      Use only the primary (highest occupancy) alternate location.

   .. oe:constant:: Unknown

      The alternate location method has not been set.

   .. oe:constant:: Max


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OEDesignUnitIssueCodes, DesignUnitIssueCodes

..  _OESpruce_OEDesignUnitIssueCodes:

.. oe:constnamespace:: OEDesignUnitIssueCodes

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants for design unit validation issue codes,
   used by the :ref:`OEValidateDesignUnit <OESpruce_OEValidateDesignUnit>` class.

   .. seealso::

      * The :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class.

..  _OESpruce_OEDesignUnitIssueCodes_Success:

   .. oe:constant:: Success

      This issue code indicates that the design unit does not have errors.

..  _OESpruce_OEDesignUnitIssueCodes_PartialSideChain:

   .. oe:constant:: PartialSideChain

      This issue code indicates that the design unit contains partial side chains.

..  _OESpruce_OEDesignUnitIssueCodes_MissingLoop:

   .. oe:constant:: MissingLoop

      This issue code indicates that the input design unit contains missing loops.

..  _OESpruce_OEDesignUnitIssueCodes_ImplicitH:

   .. oe:constant:: ImplicitH

      This issue code indicates that the input design unit contains implicit hydrogens.

..  _OESpruce_OEDesignUnitIssueCodes_TerminiNotCapped:

   .. oe:constant:: TerminiNotCapped

      This issue code indicates that the input design unit contains incorrect terminal residues.

..  _OESpruce_OEDesignUnitIssueCodes_HeavyAtomsOverlap:

   .. oe:constant:: HeavyAtomsOverlap

      This issue code indicates that the design unit has heavy atoms overlapping with each other.

..  _OESpruce_OEDesignUnitIssueCodes_BrokenChains:

   .. oe:constant:: BrokenChains

      This issue code indicates the design unit contains broken chains.

..  _OESpruce_OEDesignUnitIssueCodes_All:

   .. oe:constant:: All

      This issue code indicates that the design unit contains all the issues listed above.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. oe:constnamespace:: OEExperimentType

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants that describe the type of experiment from which the 3-D structure was determined.

   .. oe:constant:: ElectronCrystallography

      The structure was determined by electron crystallography.

   .. oe:constant:: ElectronMicroscopy

      The structure was determined by electron cryo-microscopy.

   .. oe:constant:: FiberDiffraction

      The structure was determined by fiber diffraction using either X-rays, electrons, or neutrons.

   .. .. oe:constant:: Max

   ..    The structure was determined by

   .. oe:constant:: NeutronDiffraction

      The structure was determined by elastic neutron scattering.

   .. oe:constant:: PowderDiffraction

      The structure was determined by powder diffraction using either X-rays, electrons, or neutrons.

   .. oe:constant:: SolidStateNMR

      The structure was determined by NMR methods in the solid state.

   .. oe:constant:: SolutionNMR

      The structure was determined by NMR methods in the liquid state.

   .. oe:constant:: SolutionScattering

      The structure was determined by small angle X-ray scattering (SAXS) in solution.

   .. oe:constant:: TheoreticalModel

      The structure was predicted/computed using a theoretical/computational model.

   .. oe:constant:: Unknown

      The experiment type is not known.

   .. oe:constant:: XRayDiffraction

      The structure was determined using X-ray diffraction.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. oe:constnamespace:: OEHeterogenType

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants that define the heterogen molecule type used in the :ref:`OEHeterogenMetadata <OESpruce_OEHeterogenMetadata>` class.

   .. oe:constant:: Cofactors

      The heterogen type are cofactors.

   .. oe:constant:: CounterIons

      The heterogen type are counter ions.

   .. oe:constant:: Excipients

      The heterogen type are excipients.

   .. oe:constant:: Ligand

      The heterogen type is a ligand.

   .. oe:constant:: Lipids

      The heterogen types are lipids.

   .. oe:constant:: Metals

      The heterogen type are metals.

   .. oe:constant:: Polymers

      The heterogen type are polymeric molecules.

   .. oe:constant:: Solvent

      The heterogen type are solvent molecules.

   .. oe:constant:: Sugars

      The heterogen type are sugars.

   .. oe:constant:: Unknown

      The heterogen type are not known.


.. _OESpruceConstants:

*******************************
OESpruce Constants
*******************************

.. oe:namespace:: OESpruce

.. toctree::

   OEAlternateLocationOption
   OEDesignUnitIssueCodes
   OEExperimentType
   OEHeterogenType
   OESuperpositionType
   OESpruceFilterIssueCodes
   OESuperposeMethod


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESpruceFilterIssueCodes, SpruceFilterIssueCodes

.. oe:constnamespace:: OESpruceFilterIssueCodes

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants for Spruce filter issue codes.

   .. seealso::

      * :ref:`OESpruceFilterOptions <OESpruce_OESpruceFilterOptions>` class

   .. oe:constant:: Success

      This issue code indicates that the input structure does not have errors and passes the spruce filter

   .. oe:constant:: InvalidNames

      This issue code indicates that the input structure contains invalid names.

   .. oe:constant:: InvalidResidueStates

      This issue code indicates that the input structure contains residues at invalid state.

   .. oe:constant:: InvalidMetalBond

      This issue code indicates that the input structure contains invalid covalent bonds to metals.

   .. oe:constant:: InvalidCRYST1

      This issue code indicates that the input structure does not have a valid CRYST1 header.

   .. oe:constant:: InvalidElectronDensityOverlap

      This issue code indicates that the provided electron density map does not overlap with the input structure

   .. oe:constant:: InvalidSeqAlign

      This issue code indicates that the sequence does not align with the input structure.
    
   .. oe:constant:: All

      This issue code indicates that the structure contains all the issues listed above.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESuperposeMethod, SuperposeMethod

..  _OESpruce_OESuperposeMethod:

.. oe:constnamespace:: OESuperposeMethod

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants for superpositioning methods.

   .. seealso::

      * :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` class

   .. admonition:: Code Example

      * :ref:`spruce_examples_superposition` example

..  _OESpruce_OESuperposeMethod_Default:

   .. oe:constant:: Default

      The default superpositioning method is
      GlobalCarbonAlpha.

..  _OESpruce_OESuperposeMethod_GlobalCarbonAlpha:

   .. oe:constant:: GlobalCarbonAlpha

      Calculate superposition using the all matched alpha carbon atoms.

..  _OESpruce_OESuperposeMethod_Global:

   .. oe:constant:: Global

      Alias for :oe:const:`OESpruce::OESuperposeMethod::GlobalCarbonAlpha`.

..  _OESpruce_OESuperposeMethod_SiteSequence:

   .. oe:constant:: SiteSequence

      Calculate superposition using the input site residues. Site residues must be set with the
      :oe:meth:`OESpruce::OESuperpose::SetupRef` member function of the :ref:`OESuperpose <OESpruce_OESuperpose>` class.

..  _OESpruce_OESuperposeMethod_Site:

   .. oe:constant:: Site

      Alias for SiteSequence.

..  _OESpruce_OESuperposeMethod_DifferenceDistanceMatrix:

   .. oe:constant:: DifferenceDistanceMatrix

      Calculate superposition using the **D**\ istance **D**\ ifference **M**\ atrix method. See
      :ref:`Protein Superposition <spruce_superposition_section>` for more information.

..  _OESpruce_OESuperposeMethod_DDM:

   .. oe:constant:: DDM

      Alias for DifferenceDistanceMatrix.

..  _OESpruce_OESuperposeMethod_WeightedDifferenceDistanceMatrix:

   .. oe:constant:: WeightedDifferenceDistanceMatrix

      Calculate a weighted superposition using weights taken from the Difference Distance Matrix. See
      :ref:`Protein Superposition <spruce_superposition_section>` for more information.

..  _OESpruce_OESuperposeMethod_Weighted:

   .. oe:constant:: Weighted

      Alias for  WeightedDifferenceDistanceMatrix.

..  _OESpruce_OESuperposeMethod_SecondaryStructureElements:

   .. oe:constant:: SecondaryStructureElements

      Calculate superposition using an overlap of **S**\ econdary **S**\ tructure **E**\ lements.

      .. seealso::

         * :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class

..  _OESpruce_OESuperposeMethod_SSE:

   .. oe:constant:: SSE

      Alias for  SecondaryStructureElements.

..  _OESpruce_OESuperposeMethod_SiteHopper:

   .. oe:constant:: SiteHopper

      Calculates the superposition using SiteHopper

      .. seealso::

         * :ref:`oesitehopper_chapter_intro`

..  _OESpruce_OESuperposeMethod_Undefined:

   .. oe:constant:: Undefined

      Superposition method is undefined. No superposition will take place.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESuperpositionType, SuperpositionType

.. oe:constnamespace:: OESuperpositionType

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants for superpositioning methods.

   .. seealso::

      * :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` class

   .. oe:constant:: Default

      The default superpositioning method is
      :oe:const:`OESpruce::OESuperpositionType::Global`.

   .. oe:constant:: DDM

      Calculate superposition using the **D**\ istance **D**\ ifference **M**\ atrix method.

   .. oe:constant:: Global

      Calculate superposition using the all matched atoms.

   .. oe:constant:: Site

      Calculate superposition using the input site residues. Site residues must be set with the
      :oe:meth:`OESpruce::OESuperpositionOptions::SetSiteResidues` member function of the :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` class.

   .. oe:constant:: SSE

      Calculate superposition using an overlap of **S**\ econdary **S**\ tructure **E**\ lements.

      .. seealso::

         * :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class

   .. oe:constant:: Undefined

      Superposition method is undefined. No superposition will take place.

   .. oe:constant:: Weighted

      Calculate a weighted superposition using weights taken from the Difference Distance Matrix.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OEBuildLoops

..  _OESpruce_OEBuildLoops:

.. oe:function:: OEBuildLoops

   .. attention::

      |TWOLANGUAGE|

   These functions build missing loops and tails in protein structures. They return false if any of the loops or tails cannot be built, but it
   will return with as many built loops and tails as possible.
   The functions require a loop database be provided in the options class. Using the **loopdb_builder** application it
   is possible to build your own database for a given target family, or a set of proprietary structure. OpenEye provides
   a database built of the structures in the entire PDB repository at the time of toolkit release. The datastamps are noted in
   the info table and logged during loop building. It is possible to append local/proprietary structures to this database if desired,
   again using the desktop application.
   The options class allows different behaviors for the loop builder.

   .. note::

      Explicit hydrogens are not added to the structure during the build processes, therefore no partial charges are assigned.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBuildLoops(OEChem::OEMolBase& mol,
                           const OESidechainBuilderOptions& scOpts = OESidechainBuilderOptions(),
                           const OELoopBuilderOptions& lOpts = OELoopBuilderOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEBuildLoops(du: OEDesignUnit,
                      scOpts: OESidechainBuilderOptions = OESidechainBuilderOptions(),
                      lOpts: OELoopBuilderOptions = OELoopBuilderOptions()) -> bool
         OEBuildLoops(mol: Union[OEGraphMol,OEMol,OEQMol],
                      scOpts: OESidechainBuilderOptions = OESidechainBuilderOptions(),
                      lOpts: OELoopBuilderOptions = OELoopBuilderOptions()) -> bool

   This function takes a molecule and builds any missing loops that can be detected based on the information
   in the PDB header metadata. The function also takes options classes for the loop building, but also for the side-chain re-building,
   in case the loop in the database is not a 100% identity match. The function calls OEOmega to generate possible conformations for tails.

   .. oe:api: IGNORE

      bool OEBuildLoops(OEBio::OEDesignUnit& du,
                             const OESidechainBuilderOptions& scOpts=OESidechainBuilderOptions(),
                             const OELoopBuilderOptions& lOpts=OELoopBuilderOptions())

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBuildLoops(OEChem::OEMolBase& mol,
                           const OEStructureMetadata& data,
                           const OESidechainBuilderOptions& scOpts = OESidechainBuilderOptions(),
                           const OELoopBuilderOptions& lOpts = OELoopBuilderOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEBuildLoops(du: OEDesignUnit, data: OEStructureMetadata,
                      scOpts: OESidechainBuilderOptions = OESidechainBuilderOptions(),
                      lOpts: OELoopBuilderOptions = OELoopBuilderOptions()) -> bool
         OEBuildLoops(mol: Union[OEGraphMol,OEMol,OEQMol],
                      data: OEStructureMetadata,
                      scOpts: OESidechainBuilderOptions = OESidechainBuilderOptions(),
                      lOpts: OELoopBuilderOptions = OELoopBuilderOptions()) -> bool

   This function works identically to the above function, only metadata is explicitly provided containing information
   about the sequence, so gaps can be detected.

   .. oe:api: IGNORE

      bool OEBuildLoops(OEBio::OEDesignUnit& du,
                             const OEStructureMetadata& data,
                             const OESidechainBuilderOptions& scOpts=OESidechainBuilderOptions(),
                             const OELoopBuilderOptions& lOpts=OELoopBuilderOptions())

   The input ``mol`` must have 3D coordinates assigned.

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>` class
      * :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>` class
      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class
      * :oe:constns:`OEBio::OERotamerLibrary` namespace
      * :ref:`OEStructureMetadata <OESpruce_OEStructureMetadata>` class
      * :oe:func:`OESpruce::OEBuildSingleLoop` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OEBuildSidechains:

.. oe:function:: OEBuildSidechains

   .. attention::

      |TWOLANGUAGE|

   These functions build out partial sidechains using a rotamer library. The rotamer chosen is the one with the best interaction energy
   with the surrounding environment without taking solvent effects into account. If multiple sidechains are built
   that interact with one another, the energy chosen is the best collective interaction energy. The functions will
   return false if a sidechain can not be built due to clashes, but will still return a structure with all the ones it could build.

   .. note::

      Explicit hydrogens are not added to the structure during the build processes, therefore no partial charges are assigned. 

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBuildSidechains(OEChem::OEMolBase& mol,
                                const OESpruce::OESidechainBuilderOptions& opts = OESpruce::OESidechainBuilderOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEBuildSidechains(du: OEDesignUnit,
                           opts: OESidechainBuilderOptions = OESidechainBuilderOptions()) -> bool
         OEBuildSidechains(mol: Union[OEGraphMol,OEMol,OEQMol],
                           opts: OESidechainBuilderOptions = OESidechainBuilderOptions()) -> bool

   This function takes a molecule and builds any partial sidechain of standard protein residues determined using the
   :oe:func:`OESpruce::OEGetPartialResidues` function. An options class defining a rotamer library from the
   :oe:constns:`OEBio::OERotamerLibrary` namespace can be set, otherwise the default library from that namespace is chosen.
   Additionally, in the options the number of rotamers used can be reduced by picking a rotamer coverage below the default 100%.
   The percentage is calculated cumulatively, so the most probably rotamer is tested first,
   up to the rotamer that takes it above the percentage limit. The options class also defines the behavior of removing water molecules
   that clash with the built sidechain.

   .. oe:api: IGNORE

      bool OEBuildSidechains(OEBio::OEDesignUnit &du,
                             const OESpruce::OESidechainBuilderOptions& opts=OESpruce::OESidechainBuilderOptions())
   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBuildSidechains(OEChem::OEMolBase& mol,
                                const std::vector<OEChem::OEResidue>& residues,
                                const OESpruce::OESidechainBuilderOptions& opts = OESpruce::OESidechainBuilderOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEBuildSidechains(du: OEDesignUnit, residues: OEResidueVector,
                           opts: OESidechainBuilderOptions = OESidechainBuilderOptions()) -> bool
         OEBuildSidechains(mol: Union[OEGraphMol,OEMol,OEQMol],
                           residues: OEResidueVector,
                           opts: OESidechainBuilderOptions = OESidechainBuilderOptions()) -> bool

   This function works identically to the above function, but only builds the residues identified in the
   vector residues.

   .. oe:api: IGNORE

      bool OEBuildSidechains(OEBio::OEDesignUnit &du,
                             const std::vector<OEChem::OEResidue>& residues,
                             const OESpruce::OESidechainBuilderOptions& opts=OESpruce::OESidechainBuilderOptions())

   The input ``mol`` must have 3D coordinates assigned.

   .. seealso::

      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class
      * :oe:constns:`OEBio::OERotamerLibrary` namespace
      * :oe:func:`OESpruce::OEGetPartialResidues` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OEBuildSingleLoop

..  _OESpruce_OEBuildSingleLoop:

.. oe:function:: OEBuildSingleLoop

   .. attention::

      |TWOLANGUAGE|

   This function builds a specified missing loop or tail in a protein structures. The function returns false if the loop or tail cannot be built.
   The function requires a loop database be provided in the options class. Using the **loopdb_builder** application it
   is possible to build your own database for a given target family, or a set of proprietary structure. OpenEye provides
   a database built of the structures in the entire PDB repository at the time of toolkit release. The datastamps are noted in
   the info table and logged during loop building. It is possible to append local/proprietary structures to this database if desired,
   again using the desktop application.
   The options classes allows different behaviors for the loop builder.

   .. note::

      Explicit hydrogens are not added to the structure during the build processes, therefore no partial charges are assigned. 

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEBuildSingleLoop(OEChem::OEMCMolBase& outputMol,
                                const OEChem::OEMolBase& inputMol,
                                const std::string fasta,
                                const OEChem::OEResidue& cTerminalAttachment,
                                const OEChem::OEResidue& nTerminalAttachment,
                                const OESidechainBuilderOptions& scOpts = OESidechainBuilderOptions(),
                                const OELoopBuilderOptions& lOpts = OELoopBuilderOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEBuildSingleLoop(outputMol: OEMol,
                           inputMol: Union[OEGraphMol,OEMol,OEQMol],
                           fasta: str, cTerminalAttachment: OEResidue,
                           nTerminalAttachment: OEResidue,
                           scOpts: OESidechainBuilderOptions = OESidechainBuilderOptions(),
                           lOpts: OELoopBuilderOptions = OELoopBuilderOptions()) -> bool

   The function takes an empty multi-conformer molecule which will contain the protein with the loop built if the function is successful.
   Multiple conformers of the loop will be returned based on the passed options, the results are sorted by a force field energy score.
   The remaining arguments are, the molecule with the gap, the loop protein sequence in 1-letter codes as a string (e.g. "PVHTAL"), and
   the c- and n-terminal attachment (or anchor) residues. The function also takes options classes for the loop building,
   and side-chain re-building, in case the loop in the database is not a 100% identity match. The function calls OEOmega to generate possible conformations for tails.

   The input ``inputMol`` must have 3D coordinates assigned.

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>` class
      * :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>` class
      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class
      * :oe:constns:`OEBio::OERotamerLibrary` namespace
      * :ref:`OEStructureMetadata <OESpruce_OEStructureMetadata>` class
      * :oe:func:`OESpruce::OEBuildLoops` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OECapCTermini:

.. oe:function:: OECapCTermini

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECapCTermini(OEChem::OEMolBase& mol,
                            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& exclude = OEChem::OEIsFalseAtom(),
                            const OESpruce::OECapBuilderOptions& = OESpruce::OECapBuilderOptions())

   .. oe:language:: python

      .. oe:api:: python

         OECapCTermini(mol: Union[OEGraphMol,OEMol,OEQMol],
                       exclude: OEUnaryAtomPred = OEIsFalseAtom(),
                       arg3: OECapBuilderOptions = OECapBuilderOptions()) -> bool

   This function caps all the C-termini in a protein with an N-methyl (:oe:const:`OEChem::OEResidueIndex::NME`) group.
   The N-methyl is built assuming ideal backbone geometry.

   A predicate can be passed to exclude certain termini from being capped, such as the true biological C-terminal residue
   since this should be charged to match the biophysical experiments.

   The function takes an options class, where behavior can be controlled if building the cap results in a clash, and
   depending on the type of class what actions can be taken, e.g. a solvent molecule blocking the protein backbone
   is not very realistic and the solvent molecule is likely placed to account for density that should have belonged
   to the residue not resolved in the crystal structure.

   The cap will be numbered identically to the residue number of the terminal residue, but the insertion code will be incremented.
   The reason for this is to avoid residue number clashes with heterogens following the protein chain in the PDB file.

   .. note::

      If the backbone of the residue being capped is incomplete, or a cap can not be built because of a clash,
      the residue being capped can be turned into the cap by removing atoms in the residue. A clash can either be
      into a non-solvent or into a solvent with the `deleteClashingSolvent` option set to false.

   .. oe:api: IGNORE

       bool OECapCTermini(OEBio::OEDesignUnit &du,
                         const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &exclude=OEChem::OEIsFalseAtom(),
                         const OESpruce::OECapBuilderOptions& = OESpruce::OECapBuilderOptions())

   The input ``mol`` must have 3D coordinates assigned.

   .. seealso::

      * :ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>` class
      * :oe:func:`OESpruce::OECapTermini` function
      * :oe:func:`OESpruce::OECapNTermini` function
      * :ref:`OEIsCTerminalAtom <OEBio_OEIsCTerminalAtom>` predicate


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OECapNTermini:

.. oe:function:: OECapNTermini

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECapNTermini(OEChem::OEMolBase& mol,
                            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& exclude = OEChem::OEIsFalseAtom(),
                            const OESpruce::OECapBuilderOptions& = OESpruce::OECapBuilderOptions())

   .. oe:language:: python

      .. oe:api:: python

         OECapNTermini(mol: Union[OEGraphMol,OEMol,OEQMol],
                       exclude: OEUnaryAtomPred = OEIsFalseAtom(),
                       arg3: OECapBuilderOptions = OECapBuilderOptions()) -> bool

   This function caps all the N-termini in a protein with an acetyl (:oe:const:`OEChem::OEResidueIndex::ACE`) group.
   The acetyl is built assuming ideal backbone geometry, the :math:`\phi` value of the residue being capped is set to
   match the :math:`\phi` value of the previous residue (if it's a single residue in space, a value of :math:`-90.0^{\circ}` degrees, is set
   which is in the allowed range for both an alpha helix and beta sheet secondary structure).

   A predicate can be passed to exclude certain termini from being capped, such as the true biological N-terminal residue
   since this should be charged to match the biophysical experiments.

   The function takes an options class, where behavior can be controlled if building the cap results in a clash, and
   depending on the type of class what actions can be taken, e.g. a solvent molecule blocking the protein backbone
   is not very realistic and the solvent molecule is likely placed to account for density that should have belonged
   to the residue not resolved in the crystal structure.

   The cap will be numbered with -1 from the residue number of the terminal residue.

   .. note::

      If the backbone of the residue being capped is incomplete, or a cap can not be built because of a clash,
      the residue being capped can be turned into the cap by removing atoms in the residue. A clash can either be
      into a non-solvent or into a solvent with the `deleteClashingSolvent` option set to false.

   .. oe:api: IGNORE

      bool OECapNTermini(OEBio::OEDesignUnit &du,
                         const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &exclude=OEChem::OEIsFalseAtom(),
                         const OESpruce::OECapBuilderOptions& = OESpruce::OECapBuilderOptions())

   The input ``mol`` must have 3D coordinates assigned.

   .. seealso::

      * :ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>` class
      * :oe:func:`OESpruce::OECapTermini` function
      * :oe:func:`OESpruce::OECapCTermini` function
      * :ref:`OEIsNTerminalAtom <OEBio_OEIsNTerminalAtom>` predicate


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OECapTermini:

.. oe:function:: OECapTermini

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OECapTermini(OEChem::OEMolBase& mol,
                           const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& exclude = OEChem::OEIsFalseAtom(),
                           const OESpruce::OECapBuilderOptions& = OESpruce::OECapBuilderOptions())

   .. oe:language:: python

      .. oe:api:: python

         OECapTermini(mol: Union[OEGraphMol,OEMol,OEQMol],
                      exclude: OEUnaryAtomPred = OEIsFalseAtom(),
                      arg3: OECapBuilderOptions = OECapBuilderOptions()) -> bool

   This function caps all the N- and C-termini in a protein with acetyl (:oe:const:`OEChem::OEResidueIndex::ACE`) and
   N-methyl (:oe:const:`OEChem::OEResidueIndex::NME`) groups, respectively.

   A predicate can be passed to exclude certain termini from being capped, such as the true biological terminal residues
   since these should be charged to match the biophysical experiments.

   The function takes an options class, where behavior can be controlled if building the cap results in a clash, and
   depending on the type of class what actions can be taken, e.g. a solvent molecule blocking the protein backbone
   is not very realistic and the solvent molecule is likely placed to account for density that should have belonged
   to the residue not resolved in the crystal structure.

   .. note::

      Explicit hydrogens are not added to the structure during the build processes.

   .. oe:api: IGNORE

      bool OECapTermini(OEBio::OEDesignUnit &du,
                        const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &exclude=OEChem::OEIsFalseAtom(),
                        const OESpruce::OECapBuilderOptions& = OESpruce::OECapBuilderOptions())

   The input ``mol`` must have 3D coordinates assigned.

   .. seealso::

      * :ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>` class
      * :oe:func:`OESpruce::OECapCTermini` function
      * :oe:func:`OESpruce::OECapNTermini` function
      * :ref:`OEIsNTerminalAtom <OEBio_OEIsNTerminalAtom>` predicate
      * :ref:`OEIsCTerminalAtom <OEBio_OEIsCTerminalAtom>` predicate


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. oe:function:: OEEnumerateSites

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEBio::OEDesignUnit>* OEEnumerateSites(const OEBio::OEDesignUnit& bioDesignUnit,
                                                                     const OEDesignUnitEnumerateSitesOptions& opts = OEDesignUnitEnumerateSitesOptions(),
                                                                     const std::string siteResidue = "")
         OESystem::OEIterBase<OEBio::OEDesignUnit>* OEEnumerateSites(const OEBio::OEDesignUnit& bioDesignUnit,
                                                                     const OESystem::OESkewGrid& electronDensity,
                                                                     const OESpruce::OEDesignUnitEnumerateSitesOptions& opts = OESpruce::OEDesignUnitEnumerateSitesOptions(),
                                                                     const std::string siteResidue = "")
         OESystem::OEIterBase<OEBio::OEDesignUnit>* OEEnumerateSites(const OEBio::OEDesignUnit& bioDesignUnit,
                                                                     const OEBio::OEDesignUnit& designUnitReference,
                                                                     const OESpruce::OEDesignUnitEnumerateSitesOptions& opts = OESpruce::OEDesignUnitEnumerateSitesOptions())
         OESystem::OEIterBase<OEBio::OEDesignUnit>* OEEnumerateSites(const OEBio::OEDesignUnit& bioDesignUnit,
                                                                     const OEBio::OEDesignUnit& designUnitReference,
                                                                     const OESystem::OESkewGrid& electronDensity,
                                                                     const OESpruce::OEDesignUnitEnumerateSitesOptions& opts = OESpruce::OEDesignUnitEnumerateSitesOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEEnumerateSites(bioDesignUnit: OEDesignUnit,
                          opts: OEDesignUnitEnumerateSitesOptions = OEDesignUnitEnumerateSitesOptions(),
                          const: str) -> Iterable[OEDesignUnit]
         OEEnumerateSites(bioDesignUnit: OEDesignUnit, arg2: OESkewGrid,
                          opts: OEDesignUnitEnumerateSitesOptions = OEDesignUnitEnumerateSitesOptions(),
                          siteResidue: str = "") -> Iterable[OEDesignUnit]
         OEEnumerateSites(bioDesignUnit: OEDesignUnit,
                          designUnitReference: OEDesignUnit,
                          opts: OEDesignUnitEnumerateSitesOptions = OEDesignUnitEnumerateSitesOptions()) -> Iterable[OEDesignUnit]
         OEEnumerateSites(bioDesignUnit: OEDesignUnit,
                          designUnitReference: OEDesignUnit, arg3: OESkewGrid,
                          opts: OEDesignUnitEnumerateSitesOptions = OEDesignUnitEnumerateSitesOptions()) -> Iterable[OEDesignUnit]

   Return an iterator over all :ref:`OEDesignUnit <OEBio_OEDesignUnit>` objects enumerated from the input `bioDesignUnit` argument based on the componentization of the internal heterogen molecules. The `bioDesignUnit` input argument should be taken from the iterator output of :oe:func:`OESpruce::OEMakeBioDesignUnits`.

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OEExtractBioUnits

..  _OESpruce_OEExtractBioUnits:

.. oe:function:: OEExtractBioUnits

  .. attention::

      |TWOLANGUAGE|

  .. oe:language:: c++ java csharp

     .. oe:api::

        OESystem::OEIterBase<OEChem::OEMolBase>*OEExtractBioUnits(const OEChem::OEMolBase& extractProtein,
                                                                  const OEChem::OEMolBase& refProtein,
                                                                  const OEBioUnitExtractionOptions& opts = OEBioUnitExtractionOptions())
        OESystem::OEIterBase<OEChem::OEMolBase>*OEExtractBioUnits(const OEChem::OEMolBase& extractProtein,
                                                                  const OEBioUnitExtractionOptions& opts = OEBioUnitExtractionOptions())

  .. oe:language:: python

     .. oe:api:: python

        OEExtractBioUnits(extractProtein: Union[OEGraphMol,OEMol,OEQMol],
                          refProtein: Union[OEGraphMol,OEMol,OEQMol],
                          opts: OEBioUnitExtractionOptions = OEBioUnitExtractionOptions()) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]
        OEExtractBioUnits(extractProtein: Union[OEGraphMol,OEMol,OEQMol],
                          opts: OEBioUnitExtractionOptions = OEBioUnitExtractionOptions()) -> Iterable[Union[OEGraphMol, OEMol, OEQMol]]

  Extracts BUs using either the PDB remarks when a single :ref:`OEMolBase <OEChem_OEMolBase>` is
  provided, or a sequence alignment to a reference if two :oe:cls:`OEMolBases <OEChem::OEMolBase>`
  are provided.
  The :oe:func:`OESpruce::OEExtractBioUnits` is overloaded with to take an :ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>` options class.
  This function returns an iterator of :ref:`OEMolBase <OEChem_OEMolBase>` objects, one for each
  of the BUs.

  .. note::

     If atoms are on the symmetry axis causing them to be duplicated by symmetry expansion, they are handled
     specially to avoid clashes in the output. If the duplication results in atoms of a molecule that are perfectly
     overlapping, e.g. a water molecule oxygen, then the duplicated water is deleted. If the overlap is not complete,
     but instead creates partially overlapping molecules, then the BU is enumerated into multiple BUs. The nearly identical
     BUs are tagged in generic data with an index number used by Spruce.

  **Parameters :**

  *extractProtein*
     The protein from which the BUs will be extracted.
  *refProtein*
     The reference protein that will be used for sequence alignment.
  *OEBioUnitExtractionOptions*
     :ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>` options class defining biological unit extraction options.

  The ``extractProtein`` structure must have crystal symmetry set (e.g. loaded from a CRYST1 record) for biounit extraction to succeed.

  .. admonition:: Code Example

      * :ref:`spruce_examples_extract_biounits_ref` example
      * :ref:`spruce_examples_extract_biounits_remarks` example


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OEFindPockets:

.. oe:function:: OEFindPockets

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OESpruce::OEPocket>* OEFindPockets(OEBio::OEDesignUnit& designUnit,
                                                                 const unsigned componentMask = OEBio::OEDesignUnitComponents::MacroMolComponents,
                                                                 const OEPocketOptions& opts = OESpruce::OEPocketOptions(),
                                                                 const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& restrictPred = OESystem::OEIsTrue<OEChem::OEAtomBase>())
         OESystem::OEIterBase<OESpruce::OEPocket>* OEFindPockets(OEChem::OEMolBase& mol,
                                                                 const OEPocketOptions& opts = OESpruce::OEPocketOptions(),
                                                                 const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& restrictPred = OESystem::OEIsTrue<OEChem::OEAtomBase>())

   .. oe:language:: python

      .. oe:api:: python

         OEFindPockets(designUnit: OEDesignUnit, componentMask: int,
                       opts: OEPocketOptions = OEPocketOptions(),
                       restrictPred: OEUnaryAtomPred = OEIsTrueAtom()) -> Iterable[OEPocket]
         OEFindPockets(mol: Union[OEGraphMol,OEMol,OEQMol],
                       opts: OEPocketOptions = OEPocketOptions(),
                       restrictPred: OEUnaryAtomPred = OEIsTrueAtom()) -> Iterable[OEPocket]

   Return an iterator over all :ref:`OEPocket <OESpruce_OEPocket>` objects
   that can be found from the input :ref:`OEMolBase <OEChem_OEMolBase>` or :ref:`OEDesignUnit <OEBio_OEDesignUnit>` input structure. For design units, a mask can be supplied to determine,
   which of the internal components should be used for the pocket detection.
   The options input defines some parameters of the output pockets.
   If a specific pocket is required an atom based predicate can be supplied, the requirement is then that the one of the atom(s) in the predicate, is associated with
   the surface of the discovered pocket.

The input structure must have 3D coordinates assigned.

.. seealso::

  * :ref:`OEPocketOptions <OESpruce_OEPocketOptions>` class
  * :ref:`OEPocket <OESpruce_OEPocket>` class
  * :ref:`OEMakeDesignUnitFromPocket <OESpruce_OEMakeDesignUnitFromPocket>` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. meta::
   :keywords: OEFixBackbone

..  _OESpruce_OEFixBackbone:

.. oe:function:: OEFixBackbone

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEFixBackbone(OEBio::OEDesignUnit& du)

   .. oe:language:: python

      .. oe:api:: python

         OEFixBackbone(du: OEDesignUnit) -> bool

  The function attempts to correct missing oxygen atoms on the protein backbone,
  O and OXT, as well as correct the charge and valence state. If any of the core
  backbone atoms, N, CA, or C are missing it removes the residue. The proper
  residue can be modeled in later using :oe:func:`OESpruce::OEBuildLoops`.



.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. oe:function:: OEGetAlternateLocationOptionID

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEGetAlternateLocationOptionID(std::string optionName)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAlternateLocationOptionID(optionName: str) -> int

   Returns the unsigned integer version of the string option name from the
   :oe:constns:`OESpruce::OEAlternateLocationOption` namespace.

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. oe:function:: OEGetAlternateLocationOptionName

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetAlternateLocationOptionName(unsigned option)

   .. oe:language:: python

      .. oe:api:: python

         OEGetAlternateLocationOptionName(option: int) -> str

   Returns the string version of the option name from the
   :oe:constns:`OESpruce::OEAlternateLocationOption` namespace.

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. oe:function:: OEGetExperimentTypeID

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEGetExperimentTypeID(const std::string& expTypeName)

   .. oe:language:: python

      .. oe:api:: python

         OEGetExperimentTypeID(expTypeName: str) -> int

   This function returns an unsigned integer version of the experiment type from the string argument `expTypeName`. The experiment types are contained in the :oe:constns:`OESpruce::OEExperimentType` namespace.

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. oe:function:: OEGetExperimentTypeName

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetExperimentTypeName(unsigned expTypeID)

   .. oe:language:: python

      .. oe:api:: python

         OEGetExperimentTypeName(expTypeID: int) -> str

   This function returns a string version of the experiment type from the unsigned integer argument `expTypeID`. The experiment types are contained in the :oe:constns:`OESpruce::OEExperimentType` namespace. 

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. oe:function:: OEGetHeterogenTypeID

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEGetHeterogenTypeID(const std::string& typeName)

   .. oe:language:: python

      .. oe:api:: python

         OEGetHeterogenTypeID(typeName: str) -> int

   This function returns an unsigned integer version of the heterogen type from the string argument `typeName`. The heterogen types are contained in the :oe:constns:`OESpruce::OEHeterogenType` namespace.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. oe:function:: OEGetHeterogenTypeName

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetHeterogenTypeName(unsigned typeID)

   .. oe:language:: python

      .. oe:api:: python

         OEGetHeterogenTypeName(typeID: int) -> str

   This function returns a string version of the heterogen type from the unsigned integer argument `typeID`. The heterogen types are contained in the :oe:constns:`OESpruce::OEHeterogenType` namespace.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. oe:function:: OEGetPartialResidues

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEGetPartialResidues(std::vector<OEChem::OEResidue>& partialResidues,
                                   const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

         OEGetPartialResidues(du: OEDesignUnit) -> OEResidueVector
         OEGetPartialResidues(mol: Union[OEGraphMol,OEMol,OEQMol]) -> OEResidueVector

   This function looks through the molecule and generates a list of standard protein residues with partial
   sidechains, which can then be passed to :oe:func:`OESpruce::OEBuildSidechains`

   .. oe:api: IGNORE

      bool OEGetPartialResidues(std::vector<OEChem::OEResidue> &partialResidues,
                                const OEBio::OEDesignUnit &du)

   .. seealso::

      * :oe:func:`OESpruce::OEBuildSidechains` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEGetSuperposeMethodFromName:

.. oe:function:: OEGetSuperposeMethodFromName

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OEGetSuperposeMethodFromName(const std::string& name)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSuperposeMethodFromName(name: str) -> int

   Returns the corresponding constant defined in the :oe:constns:`OESpruce::OESuperposeMethod` namespace for the given superposition method name.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEGetSuperposeMethodName:

.. oe:function:: OEGetSuperposeMethodName

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEGetSuperposeMethodName(const unsigned method)

   .. oe:language:: python

      .. oe:api:: python

         OEGetSuperposeMethodName(method: int) -> str

   Returns the name of the superposition method as a string.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OEHeterogenMetadataFromJson:

.. oe:function:: OEHeterogenMetadataFromJson

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEHeterogenMetadataFromJson(OEHeterogenMetadata& metadata,
                                          const std::string& json)

   .. oe:language:: python

      .. oe:api:: python

         OEHeterogenMetadataFromJson(metadata: OEHeterogenMetadata, json: str) -> bool

   Populates an :oe:cls:`OESpruce::OEHeterogenMetadata` object from a JSON-formatted string.
   The function recognizes the following fields in the JSON object:

   .. list-table::
      :header-rows: 1
      :widths: 20 15 65

      * - Field
        - Type
        - Description
      * - ``Title``
        - string
        - Human-readable title of the heterogen.
      * - ``Id``
        - string
        - Identifier for the heterogen (e.g. PDB ligand code).
      * - ``Smiles``
        - string
        - SMILES representation of the heterogen.
      * - ``Type``
        - string
        - Heterogen component type name, resolved via :oe:func:`OESpruce::OEGetHeterogenTypeID`.
      * - ``Tautomers``
        - array of strings
        - SMILES strings of known tautomeric forms of the heterogen.

   Unrecognized or missing fields are silently ignored. Returns ``true`` if the JSON string was
   successfully parsed as an object; returns ``false`` if the string is not valid JSON or does
   not represent a JSON object.

.. seealso::

   * :oe:func:`OESpruce::OEHeterogenMetadataToJson` function
   * :oe:cls:`OESpruce::OEHeterogenMetadata` class
   * :oe:func:`OESpruce::OEGetHeterogenTypeID` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OEHeterogenMetadataToJson:

.. oe:function:: OEHeterogenMetadataToJson

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEHeterogenMetadataToJson(const OEHeterogenMetadata& metadata,
                                               const bool prettyPrint = true)

   .. oe:language:: python

      .. oe:api:: python

         OEHeterogenMetadataToJson(metadata: OEHeterogenMetadata,
                                   prettyPrint: bool = True) -> str

   Serializes an :oe:cls:`OESpruce::OEHeterogenMetadata` object to a JSON-formatted string.
   The resulting JSON object contains the following fields:

   .. list-table::
      :header-rows: 1
      :widths: 20 15 65

      * - Field
        - Type
        - Description
      * - ``Title``
        - string
        - Human-readable title of the heterogen.
      * - ``Id``
        - string
        - Identifier for the heterogen (e.g. PDB ligand code).
      * - ``Smiles``
        - string
        - SMILES representation of the heterogen.
      * - ``Type``
        - string
        - Heterogen component type name, as returned by :oe:func:`OESpruce::OEGetHeterogenTypeName`.
      * - ``Tautomers``
        - array of strings
        - SMILES strings of known tautomeric forms of the heterogen.

   The `prettyPrint` argument controls formatting: when ``true`` (the default) the JSON is
   indented for readability; when ``false`` a compact single-line representation is produced.

.. seealso::

   * :oe:func:`OESpruce::OEHeterogenMetadataFromJson` function
   * :oe:cls:`OESpruce::OEHeterogenMetadata` class
   * :oe:func:`OESpruce::OEGetHeterogenTypeName` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OEIsRedundantDesignUnit:

.. oe:function:: OEIsRedundantDesignUnit

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsRedundantDesignUnit(const std::vector<OEBio::OEDesignUnit*>& dus,
                                      const OEBio::OEDesignUnit& du,
                                      const OESpruce::OEDesignUnitEnumerateSitesOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEIsRedundantDesignUnit(dus: OEDesignUnitVector, du: OEDesignUnit,
                                 opts: OEDesignUnitEnumerateSitesOptions) -> bool

   Returns ``true`` if the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` ``du`` is
   considered redundant with respect to the existing set of design units ``dus``,
   using the criteria defined by the supplied
   :ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>`
   ``opts``. A design unit is redundant when duplicate-removal logic (controlled
   by :oe:meth:`OESpruce::OEDesignUnitEnumerateSitesOptions::SetDuplicateRemoval`)
   identifies it as equivalent to one already present in ``dus``.

   The input ``du`` must have 3D coordinates assigned.

   .. seealso::

      * :oe:func:`OESpruce::OEEnumerateSites` function
      * :oe:func:`OESpruce::OEMakeDesignUnits` function
      * :ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OEMakeBioDesignUnits:

.. oe:function:: OEMakeBioDesignUnits

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEBio::OEDesignUnit>* OEMakeBioDesignUnits(const OEChem::OEMolBase& structure,
                                                                         const OESpruce::OEStructureMetadata& metadata = OESpruce::OEStructureMetadata(),
                                                                         const OESpruce::OEMakeDesignUnitOptions& opts = OESpruce::OEMakeDesignUnitOptions())
         OESystem::OEIterBase<OEBio::OEDesignUnit>* OEMakeBioDesignUnits(const OEChem::OEMolBase& structure,
                                                                         const OEBio::OEDesignUnit& designUnitReference,
                                                                         const OESpruce::OEStructureMetadata& metadata = OESpruce::OEStructureMetadata(),
                                                                         const OESpruce::OEMakeDesignUnitOptions& opts = OESpruce::OEMakeDesignUnitOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEMakeBioDesignUnits(structure: Union[OEGraphMol,OEMol,OEQMol],
                              metadata: OEStructureMetadata = OEStructureMetadata(),
                              opts: OEMakeDesignUnitOptions = OEMakeDesignUnitOptions()) -> Iterable[OEDesignUnit]
         OEMakeBioDesignUnits(structure: Union[OEGraphMol,OEMol,OEQMol],
                              designUnitReference: OEDesignUnit,
                              metadata: OEStructureMetadata = OEStructureMetadata(),
                              opts: OEMakeDesignUnitOptions = OEMakeDesignUnitOptions()) -> Iterable[OEDesignUnit]

   Return an iterator over all :ref:`OEDesignUnit <OEBio_OEDesignUnit>` objects that can be produced from the input :ref:`OEMolBase <OEChem_OEMolBase>`
   structure. A reference structure to be used for biounit extraction and structural superposition can be passed in through
   the `designUnitReference` argument, while information regarding the experimental data as well as basic options for
   constructing the design units themselves can be provided through the `metadata` and `opts` arguments, respectively.

   .. note::

      We strongly recommend running :ref:`OESpruceFilter <OESpruce_OESpruceFilter>` for standardization and filtering prior to running the design unit preparation

The input ``structure`` must have 3D coordinates assigned.

.. seealso::

  * :ref:`OEMakeDesignUnit <OESpruce_OEMakeDesignUnit>`, and :ref:`OESpruceFilter <OESpruce_OESpruceFilter>`

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_oemakedesignunit:

.. oe:function:: OEMakeDesignUnit

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeDesignUnit(OEBio::OEDesignUnit& du,
                               const OEChem::OEMolBase& nonLigandComplex,
                               const OEChem::OEMolBase& ligand,
                               const OESpruce::OEMakeDesignUnitOptions& opts = OESpruce::OEMakeDesignUnitOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEMakeDesignUnit(du: OEDesignUnit,
                          nonLigandComplex: Union[OEGraphMol,OEMol,OEQMol],
                          ligand: Union[OEGraphMol,OEMol,OEQMol],
                          opts: OEMakeDesignUnitOptions = OEMakeDesignUnitOptions()) -> bool

   Constructs and populates an input :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object (`du`) from the
   input, a `nonLigandComplex` (typically a protein or DNA) and a `ligand`. An options
   :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` object can be passed in to control the
   behavior during design unit preparation.

   .. note::

      We strongly recommend running :ref:`OESpruceFilter <OESpruce_OESpruceFilter>` for standardization and filtering prior to running the design unit preparation.

   .. note::

      The function will construct an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` (`du`), where the system's
      molecules have been binned into categories given by the
      :oe:constns:`OEBio::OEDesignUnitComponents` namespace. Although an
      :oe:constns:`OEBio::OEDesignUnitComponents::Metals` category exists, depending on the proximity of the metal to
      the design unit's binding site, the metal may be contained in either the
      :oe:constns:`OEBio::OEDesignUnitComponents::Cofactors` category if it falls within a cutoff to the binding site,
      or in the :oe:constns:`OEBio::OEDesignUnitComponents::Metals` category if not.

   .. admonition:: Code Example

      * :ref:`spruce_examples_make_design_units` example

.. seealso::

  * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>`, :ref:`OEMakeBioDesignUnits <OESpruce_OEMakeBioDesignUnits>`, and :ref:`OESpruceFilter <OESpruce_OESpruceFilter>`


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_oemakedesignunitfrompocket:

.. oe:function:: OEMakeDesignUnitFromPocket

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeDesignUnitFromPocket(OEBio::OEDesignUnit& du,
                                         const OEBio::OEDesignUnit& designUnit,
                                         const OESpruce::OEPocket& pocket)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeDesignUnitFromPocket(du: OEDesignUnit, designUnit: OEDesignUnit,
                                    pocket: OEPocket) -> bool

   Takes an existing :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object (`designunit`) and
   generates a new :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object (`du`), based on the input pocket.
   If the input designunit has a binding site defined, it will be reset in the output designunit (du)
   and switched to the site specified by the pocket.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeDesignUnitFromPocket(OEBio::OEDesignUnit& du,
                                         const OEChem::OEMolBase& mol,
                                         const OESpruce::OEPocket& pocket)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeDesignUnitFromPocket(du: OEDesignUnit,
                                    mol: Union[OEGraphMol,OEMol,OEQMol],
                                    pocket: OEPocket) -> bool

   Takes an existing :ref:`OEMolBase <OEChem_OEMolBase>` object (`mol`) and
   generates a new :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object (`du`), based on the input pocket. The molecule
   is not split into components but is placed as the 'protein' component of the design unit.

.. note::

  This method is intended to be used for un-liganded pockets on a design unit.

.. seealso::

  * :ref:`OEPocket <OESpruce_OEPocket>` class
  * :oe:func:`OESpruce::OEFindPockets` function
  * :oe:func:`OESpruce::OEMakeDesignUnits` function
  * :oe:func:`OESpruce::OEMakeBioDesignUnits` function
  * :oe:func:`OESpruce::OEMakeDesignUnit` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OEMakeDesignUnits:

.. oe:function:: OEMakeDesignUnits

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         OESystem::OEIterBase<OEBio::OEDesignUnit>* OEMakeDesignUnits(const OEChem::OEMolBase& structure,
                                                                      const OESpruce::OEStructureMetadata& metadata = OESpruce::OEStructureMetadata(),
                                                                      const OESpruce::OEMakeDesignUnitOptions& opts = OESpruce::OEMakeDesignUnitOptions(),
                                                                      const std::string siteResidue = "")
         OESystem::OEIterBase<OEBio::OEDesignUnit>* OEMakeDesignUnits(const OEChem::OEMolBase& structure,
                                                                      const OESystem::OESkewGrid& electronDensity,
                                                                      const OESpruce::OEStructureMetadata& metadata = OESpruce::OEStructureMetadata(),
                                                                      const OESpruce::OEMakeDesignUnitOptions& opts = OESpruce::OEMakeDesignUnitOptions(),
                                                                      const std::string siteResidue = "")
         OESystem::OEIterBase<OEBio::OEDesignUnit>* OEMakeDesignUnits(const OEChem::OEMolBase& structure,
                                                                      const OEBio::OEDesignUnit& designUnitReference,
                                                                      const OESpruce::OEStructureMetadata& metadata = OESpruce::OEStructureMetadata(),
                                                                      const OESpruce::OEMakeDesignUnitOptions& opts = OESpruce::OEMakeDesignUnitOptions(),
                                                                      const std::string siteResidue = "")
         OESystem::OEIterBase<OEBio::OEDesignUnit>* OEMakeDesignUnits(const OEChem::OEMolBase& structure,
                                                                      const OESystem::OESkewGrid& electronDensity,
                                                                      const OEBio::OEDesignUnit& designUnitReference,
                                                                      const OESpruce::OEStructureMetadata& metadata = OESpruce::OEStructureMetadata(),
                                                                      const OESpruce::OEMakeDesignUnitOptions& opts = OESpruce::OEMakeDesignUnitOptions(),
                                                                      const std::string siteResidue = "")

   .. oe:language:: python

      .. oe:api:: python

         OEMakeDesignUnits(structure: Union[OEGraphMol,OEMol,OEQMol],
                           metadata: OEStructureMetadata = OEStructureMetadata(),
                           opts: OEMakeDesignUnitOptions = OEMakeDesignUnitOptions(),
                           siteResidue: str = "") -> Iterable[OEDesignUnit]
         OEMakeDesignUnits(structure: Union[OEGraphMol,OEMol,OEQMol],
                           designUnitReference: OEDesignUnit,
                           metadata: OEStructureMetadata = OEStructureMetadata(),
                           opts: OEMakeDesignUnitOptions = OEMakeDesignUnitOptions(),
                           siteResidue: str = "") -> Iterable[OEDesignUnit]

   Return an iterator over all :ref:`OEDesignUnit <OEBio_OEDesignUnit>` objects
   that can be produced from the input :ref:`OEMolBase <OEChem_OEMolBase>`
   structure. A reference structure to be used for biounit extraction
   and structural superposition can be passed in through the
   `designUnitReference` argument, while information regarding the
   experimental data as well as basic options for constructing the
   design units themselves can be provided through the
   :ref:`OEStructureMetadata <OESpruce_OEStructureMetadata>` (`metadata`), :ref:`OESkewGrid <OESystem_OESkewGrid>` (`electronDensity`) and
   :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` (`opts`) arguments,
   respectively. The input option of providing a electron density map can be used to calculate Iridium score. For more information about the Iridium score, see :ref:`Iridium chapter of that toolkit <chapter_sprucetk_iridium>`. The :ref:`OEStructureMetadata <OESpruce_OEStructureMetadata>` class stores constants for use with OEFieldMeta. These attributes (e.g. symmetry) are used to construct DUs. There is an input option to specify a binding site using a single residue specification
   if apo (or holo). The format is "name:num:insert code:chainid", e.g. "ASP:25: :A" indicating Aspartic
   acid 25 in chain A. Note: A blank/whitespace character is used for the insert code, which is a typical use case.

   .. note::

      This function will return an iterator over
      :ref:`OEDesignUnit <OEBio_OEDesignUnit>` pointers, where the system's
      molecules have been binned into categories given by the
      :oe:constns:`OEBio::OEDesignUnitComponents` namespace. Although
      an :oe:constns:`OEBio::OEDesignUnitComponents::Metals` category exists, depending
      on the proximity of the metal to the design unit's binding site, the metal may be contained in either the
      :oe:constns:`OEBio::OEDesignUnitComponents::Cofactors` category if it falls within
      a cutoff to the binding site, or in the
      :oe:constns:`OEBio::OEDesignUnitComponents::Metals` category if not.

   .. admonition:: Code Example

      * :ref:`spruce_examples_make_design_units` example

The input ``structure`` must have 3D coordinates assigned.

.. seealso::

  * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OEMutateResidue:

.. oe:function:: OEMutateResidue

   .. attention::

      |TWOLANGUAGE|

   This function mutates a single standard protein residue in the molecule to another standard amino acid residue
   specified by the 3 letter residue name, it currently only supports the 20 standard amino acids.
   The function works by deleting the residue sidechain and rebuilds the new residue using the :oe:func:`OESpruce::OEBuildSidechains`
   function, but only building the mutated sidechain. The sidechain re-building
   can be controlled using the :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` options class argument `opts`.

   .. note::

      Explicit hydrogens are not added to the structure during the build processes, therefore no partial charges are assigned. 

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMutateResidue(OEChem::OEMolBase& mol,
                              const OEChem::OEResidue& res,
                              const std::string newResName,
                              const OESpruce::OESidechainBuilderOptions& opts = OESpruce::OESidechainBuilderOptions(true))

   .. oe:language:: python

      .. oe:api:: python

         OEMutateResidue(mol: Union[OEGraphMol,OEMol,OEQMol], res: OEResidue,
                         newResName: str,
                         opts: OESidechainBuilderOptions = OESidechainBuilderOptions(true)) -> bool

   .. oe:api: IGNORE

       bool OEMutateResidue(OEBio::OEDesignUnit& du,
                            const OEChem::OEResidue& res,
                            const std::string newResName,
                            const OESpruce::OESidechainBuilderOptions& opts=OESpruce::OESidechainBuilderOptions(true))

   .. seealso::

      * :oe:func:`OESpruce::OEBuildSidechains` function
      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OEMutateResidues:

.. oe:function:: OEMutateResidues

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMutateResidues(OEChem::OEMolBase& mol,
                               const std::map<OEChem::OEResidue, std::string>& mutationMap,
                               const OESpruce::OESidechainBuilderOptions& opts = OESpruce::OESidechainBuilderOptions(true))

   .. oe:language:: python

      .. oe:api:: python

         OEMutateResidues(mol: Union[OEGraphMol,OEMol,OEQMol],
                          mutationMap: mapOEResidueString,
                          opts: OESidechainBuilderOptions = OESidechainBuilderOptions(true)) -> bool

   This function takes an input :ref:`OEMolBase <OEChem_OEMolBase>` (`mol`) and it mutates residues in the provided map. The sidechain re-building
   can be controlled using the :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` options class argument `opts`.

   .. oe:api: IGNORE

      bool OEMutateResidues(OEBio::OEDesignUnit& mol,
                             const std::map<OEChem::OEResidue, std::string>& mutationMap,
                             const OESpruce::OESidechainBuilderOptions& opts=OESpruce::OESidechainBuilderOptions(true));

   .. seealso::

      * :oe:func:`OESpruce::OEBuildSidechains` function
      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEProtonateDesignUnit:

.. oe:function:: OEProtonateDesignUnit

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEProtonateDesignUnit(OEBio::OEDesignUnit& du,
                                    const OESpruce::OEProtonateDesignUnitOptions& opts = OEProtonateDesignUnitOptions())
         bool OEProtonateDesignUnit(OEBio::OEDesignUnit& du,
                                    const std::map<std::string, OEHeterogenMetadata>& metadata,
                                    const OESpruce::OEProtonateDesignUnitOptions& opts = OEProtonateDesignUnitOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEProtonateDesignUnit(du: OEDesignUnit,
                               opts: OEProtonateDesignUnitOptions = OEProtonateDesignUnitOptions()) -> bool
         OEProtonateDesignUnit(du: OEDesignUnit,
                               metadata: StringHeterogenMetadataMap,
                               opts: OEProtonateDesignUnitOptions = OEProtonateDesignUnitOptions()) -> bool

   This function takes an input :ref:`OEDesignUnit <OEBio_OEDesignUnit>` (`du`) and it intelligently places
   hydrogens across all internal molecular components. Optionally, one may pass in a
   :ref:`OEHeterogenMetadata <OESpruce_OEHeterogenMetadata>` map keyed on the SMILES string for a given heterogen, as
   well as a set of general protonation options through the
   :ref:`OEProtonateDesignUnitOptions <OESpruce_OEProtonateDesignUnitOptions>` argument, `opts`.


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OESequenceMetadataFromJson:

.. oe:function:: OESequenceMetadataFromJson

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESequenceMetadataFromJson(OESequenceMetadata& metadata,
                                         const std::string& json)

   .. oe:language:: python

      .. oe:api:: python

         OESequenceMetadataFromJson(metadata: OESequenceMetadata, json: str) -> bool

   Populates an :oe:cls:`OESpruce::OESequenceMetadata` object from a JSON-formatted string.
   The function recognizes the following fields in the JSON object:

   .. list-table::
      :header-rows: 1
      :widths: 25 15 60

      * - Field
        - Type
        - Description
      * - ``ChainID``
        - string
        - Chain identifier for this sequence segment.
      * - ``StartResNum``
        - integer
        - Residue number of the first residue in the sequence segment.
      * - ``StartResInsCode``
        - string (single character)
        - Insertion code of the first residue in the sequence segment.
      * - ``EndResNum``
        - integer
        - Residue number of the last residue in the sequence segment.
      * - ``EndResInsCode``
        - string (single character)
        - Insertion code of the last residue in the sequence segment.
      * - ``Sequence``
        - string
        - One-letter amino acid sequence for this segment.

   Unrecognized or missing fields are silently ignored. Returns ``true`` if the JSON string was
   successfully parsed as an object; returns ``false`` if the string is not valid JSON or does
   not represent a JSON object.

.. seealso::

   * :oe:func:`OESpruce::OESequenceMetadataToJson` function
   * :oe:cls:`OESpruce::OESequenceMetadata` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OESequenceMetadataToJson:

.. oe:function:: OESequenceMetadataToJson

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OESequenceMetadataToJson(const OESequenceMetadata& metadata,
                                              const bool prettyPrint = true)

   .. oe:language:: python

      .. oe:api:: python

         OESequenceMetadataToJson(metadata: OESequenceMetadata,
                                  prettyPrint: bool = True) -> str

   Serializes an :oe:cls:`OESpruce::OESequenceMetadata` object to a JSON-formatted string.
   The resulting JSON object contains the following fields:

   .. list-table::
      :header-rows: 1
      :widths: 25 15 60

      * - Field
        - Type
        - Description
      * - ``ChainID``
        - string
        - Chain identifier for this sequence segment.
      * - ``StartResNum``
        - integer
        - Residue number of the first residue in the sequence segment.
      * - ``StartResInsCode``
        - string (single character)
        - Insertion code of the first residue in the sequence segment.
      * - ``EndResNum``
        - integer
        - Residue number of the last residue in the sequence segment.
      * - ``EndResInsCode``
        - string (single character)
        - Insertion code of the last residue in the sequence segment.
      * - ``Sequence``
        - string
        - One-letter amino acid sequence for this segment.

   The `prettyPrint` argument controls formatting: when ``true`` (the default) the JSON is
   indented for readability; when ``false`` a compact single-line representation is produced.

.. seealso::

   * :oe:func:`OESpruce::OESequenceMetadataFromJson` function
   * :oe:cls:`OESpruce::OESequenceMetadata` class


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OESplitBioUnitToComponents:

.. oe:function:: OESplitBioUnitToComponents

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESplitBioUnitToComponents(OEBio::OEDesignUnit& du,
                                         const OEChem::OEMolBase& bioUnit,
                                         OEChem::OEMolBase& packingMol,
                                         const OESpruce::OEDesignUnitSplitOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OESplitBioUnitToComponents(du: OEDesignUnit,
                                    bioUnit: Union[OEGraphMol,OEMol,OEQMol],
                                    packingMol: Union[OEGraphMol,OEMol,OEQMol],
                                    opts: OEDesignUnitSplitOptions) -> bool

   Splits the biological unit molecule ``bioUnit`` into the component categories
   of a :ref:`OEDesignUnit <OEBio_OEDesignUnit>` (protein, ligand, solvent, metals,
   etc.) using the splitting criteria defined in
   :ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>` ``opts``.
   The resulting components are stored in ``du``, and any packing residues are
   placed in ``packingMol``. Returns ``true`` on success.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESplitBioUnitToComponents(OEBio::OEDesignUnit& du,
                                         const OEChem::OEMolBase& bioUnit,
                                         OEChem::OEMolBase& packingMol,
                                         const OESpruce::OEDesignUnitSplitOptions& opts,
                                         const std::vector<std::string>& ligandNames)

   .. oe:language:: python

      .. oe:api:: python

         OESplitBioUnitToComponents(du: OEDesignUnit,
                                    bioUnit: Union[OEGraphMol,OEMol,OEQMol],
                                    packingMol: Union[OEGraphMol,OEMol,OEQMol],
                                    opts: OEDesignUnitSplitOptions,
                                    ligandNames: OEStringVector) -> bool

   As the first overload, but restricts ligand detection to residues whose
   three-letter codes appear in ``ligandNames``. This allows explicit control
   over which heterogens are classified as ligands rather than cofactors or
   excipients.

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESplitBioUnitToComponents(OEBio::OEDesignUnit& du,
                                         const OEChem::OEMolBase& bioUnit,
                                         OEChem::OEMolBase& packingMol,
                                         const OESpruce::OEDesignUnitSplitOptions& opts,
                                         const std::map<unsigned, std::vector<std::string>>& componentNames)

   .. oe:language:: python

      .. oe:api:: python

         OESplitBioUnitToComponents(du: OEDesignUnit,
                                    bioUnit: Union[OEGraphMol,OEMol,OEQMol],
                                    packingMol: Union[OEGraphMol,OEMol,OEQMol],
                                    opts: OEDesignUnitSplitOptions) -> bool
         OESplitBioUnitToComponents(du: OEDesignUnit,
                                    bioUnit: Union[OEGraphMol,OEMol,OEQMol],
                                    packingMol: Union[OEGraphMol,OEMol,OEQMol],
                                    opts: OEDesignUnitSplitOptions,
                                    ligandNames: OEStringVector) -> bool

   As the first overload, but accepts a map of
   :oe:constns:`OEBio::OEDesignUnitComponents` component IDs to lists of
   three-letter residue codes, giving fine-grained control over which residues
   are assigned to each component category.

   The input ``bioUnit`` must have 3D coordinates assigned.

   .. seealso::

      * :ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>` class
      * :oe:func:`OESpruce::OEMakeDesignUnits` function
      * :oe:func:`OESpruce::OEMakeBioDesignUnits` function
      * :oe:constns:`OEBio::OEDesignUnitComponents` namespace


.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESpruceGetArch

.. oe:function:: OESpruceGetArch

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESpruceGetArch()

   .. oe:language:: python

      .. oe:api:: python

         OESpruceGetArch() -> str

   Returns the architecture of the current version of the Spruce
   toolkit. Examples include:

   * microsoft-win32-x86

   * Ubuntu-16.04-x64


.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESpruceGetLicensee

.. oe:function:: OESpruceGetLicensee

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESpruceGetLicensee(std::string& licensee)

   .. oe:language:: python

      .. oe:api:: python

         OESpruceGetLicensee(licensee: str) -> bool

   Returns the LICENSEE from the current valid **Spruce TK** license.


.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESpruceGetPlatform

.. oe:function:: OESpruceGetPlatform

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESpruceGetPlatform()

   .. oe:language:: python

      .. oe:api:: python

         OESpruceGetPlatform() -> str

   Returns the platform, including compiler version, of the current
   version of the Spruce toolkit. Examples include:

   * microsoft-win32-msvc9-MD-x86

   * Ubuntu-16.04-x64


.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESpruceGetRelease

.. oe:function:: OESpruceGetRelease

   .. oe:language:: c++ java csharp

      .. oe:api::

         const char* OESpruceGetRelease()

   .. oe:language:: python

      .. oe:api:: python

         OESpruceGetRelease() -> str

   Returns the version of this toolkit release. For example: ``0.9.0``.


.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESpruceGetSite

.. oe:function:: OESpruceGetSite

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESpruceGetSite(std::string& site)

   .. oe:language:: python

      .. oe:api:: python

         OESpruceGetSite(site: str) -> bool

   Returns the SITE from the current valid **Spruce TK** license.


.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESpruceGetVersion

.. oe:function:: OESpruceGetVersion

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned int OESpruceGetVersion()

   .. oe:language:: python

      .. oe:api:: python

         OESpruceGetVersion() -> int

   Returns the build date of the toolkit as an unsigned int. For example: ``20180126``.


.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESpruceIsLicensed

.. oe:function:: OESpruceIsLicensed

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESpruceIsLicensed(const char* feature = 0,
                                 unsigned int* expdate = 0)

   .. oe:language:: python

      .. oe:api:: python

         OESpruceIsLicensed(feature: str = None, expdate: int = None) -> bool

   Determines whether a valid license file is present.  This function may
   be called without a legitimate run-time license to determine whether
   it is safe to call any **Spruce TK** functionality.

   The 'feature' argument can be used to check for a valid license to
   **Spruce TK** along with the following features: 'python', 'java', or
   'clr' (for CSharp).

   The 'expdate' argument can be used to obtain the expiration date of
   the current **Spruce TK** license.

   .. seealso::

      * :oe:func:`OEChem::OEChemIsLicensed` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

..  _OESpruce_OEStructureMetadataFromJson:

.. oe:function:: OEStructureMetadataFromJson

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEStructureMetadataFromJson(OEStructureMetadata& metadata,
                                          const std::string& json)

   .. oe:language:: python

      .. oe:api:: python

         OEStructureMetadataFromJson(metadata: OEStructureMetadata, json: str) -> bool

   Populates an :oe:cls:`OESpruce::OEStructureMetadata` object from a JSON-formatted string.
   The function recognizes the following top-level fields in the JSON object:

   .. list-table::
      :header-rows: 1
      :widths: 25 15 60

      * - Field
        - Type
        - Description
      * - ``StructureID``
        - string
        - Identifier for the structure (e.g. PDB accession code).
      * - ``Author``
        - string
        - Name of the structure's depositing author.
      * - ``Keywords``
        - array of strings
        - Keywords describing the structure.
      * - ``RevisionDate``
        - string
        - Date of the most recent revision.
      * - ``Revision``
        - string
        - Revision version label.
      * - ``ExperimentDate``
        - string
        - Date the experiment was performed.
      * - ``ExperimentType``
        - string
        - Experiment method name, resolved via :oe:func:`OESpruce::OEGetExperimentTypeID`.
      * - ``IridiumData``
        - object
        - Nested object containing Iridium quality assessment data.
      * - ``SequenceMetadata``
        - array of objects
        - Array of sequence segment objects, each parsed according to the fields documented in :oe:func:`OESpruce::OESequenceMetadataFromJson`.
      * - ``HeterogenMetadata``
        - array of objects
        - Array of heterogen objects, each parsed according to the fields documented in :oe:func:`OESpruce::OEHeterogenMetadataFromJson`.

   Unrecognized or missing fields are silently ignored. Returns ``true`` if the JSON string was
   successfully parsed as an object; returns ``false`` if the string is not valid JSON or does
   not represent a JSON object.

   .. admonition:: Code Example

      * :ref:`spruce_examples_make_design_units_using_metadata` example

.. seealso::

   * :oe:func:`OESpruce::OEStructureMetadataToJson` function
   * :oe:func:`OESpruce::OESequenceMetadataFromJson` function
   * :oe:func:`OESpruce::OEHeterogenMetadataFromJson` function
   * :oe:cls:`OESpruce::OEStructureMetadata` class
   * :oe:func:`OESpruce::OEGetExperimentTypeID` function


.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. oe:namespace:: OESpruce

.. _OESpruce_OEStructureMetadataToJson:

.. oe:function:: OEStructureMetadataToJson

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         std::string OEStructureMetadataToJson(const OEStructureMetadata& metadata,
                                               const bool prettyPrint = true)

   .. oe:language:: python

      .. oe:api:: python

         OEStructureMetadataToJson(metadata: OEStructureMetadata,
                                   prettyPrint: bool = True) -> str

   Serializes an :oe:cls:`OESpruce::OEStructureMetadata` object to a JSON-formatted string.
   The resulting JSON object contains the following top-level fields:

   .. list-table::
      :header-rows: 1
      :widths: 25 15 60

      * - Field
        - Type
        - Description
      * - ``StructureID``
        - string
        - Identifier for the structure (e.g. PDB accession code).
      * - ``Author``
        - string
        - Name of the structure's depositing author.
      * - ``Keywords``
        - array of strings
        - Keywords describing the structure.
      * - ``RevisionDate``
        - string
        - Date of the most recent revision.
      * - ``Revision``
        - string
        - Revision version label.
      * - ``ExperimentDate``
        - string
        - Date the experiment was performed.
      * - ``ExperimentType``
        - string
        - Experiment method name, as returned by :oe:func:`OESpruce::OEGetExperimentTypeName`.
      * - ``IridiumData``
        - object
        - Nested object containing Iridium quality assessment data.
      * - ``SequenceMetadata``
        - array of objects
        - Array of sequence segment objects, each with the fields documented in :oe:func:`OESpruce::OESequenceMetadataToJson`.
      * - ``HeterogenMetadata``
        - array of objects
        - Array of heterogen objects, each with the fields documented in :oe:func:`OESpruce::OEHeterogenMetadataToJson`.

   The `prettyPrint` argument controls formatting: when ``true`` (the default) the JSON is
   indented for readability; when ``false`` a compact single-line representation is produced.

   .. admonition:: Code Example

      * :ref:`spruce_examples_make_design_units_using_metadata` example

.. seealso::

   * :oe:func:`OESpruce::OEStructureMetadataFromJson` function
   * :oe:func:`OESpruce::OESequenceMetadataToJson` function
   * :oe:func:`OESpruce::OEHeterogenMetadataToJson` function
   * :oe:cls:`OESpruce::OEStructureMetadata` class
   * :oe:func:`OESpruce::OEGetExperimentTypeName` function


*******************************************************************************
OESpruce Functions
*******************************************************************************

.. toctree::
   :maxdepth: 1

   OEBuildLoops.rst
   OEBuildSidechains.rst
   OEBuildSingleLoop.rst
   OECapCTermini.rst
   OECapNTermini.rst
   OECapTermini.rst
   OEEnumerateSites.rst
   OEExtractBioUnits.rst
   OEFindPockets.rst
   OEFixBackbone.rst
   OEGetAlternateLocationOptionID.rst
   OEGetAlternateLocationOptionName.rst
   OEGetExperimentTypeID.rst
   OEGetExperimentTypeName.rst
   OEGetHeterogenTypeID.rst
   OEGetHeterogenTypeName.rst
   OEGetPartialResidues.rst
   OEHeterogenMetadataFromJson.rst
   OEHeterogenMetadataToJson.rst
   OEIsRedundantDesignUnit.rst
   OEMakeBioDesignUnits.rst
   OEMakeDesignUnit.rst
   OEMakeDesignUnits.rst
   OEMakeDesignUnitFromPocket.rst
   OEMutateResidue.rst
   OEMutateResidues.rst
   OEProtonateDesignUnit.rst
   OESplitBioUnitToComponents.rst
   OESpruceGetArch.rst
   OESpruceGetLicensee.rst
   OESpruceGetPlatform.rst
   OESpruceGetRelease.rst
   OESpruceGetSite.rst
   OESpruceGetVersion.rst
   OESpruceIsLicensed.rst
   OESequenceMetadataFromJson.rst
   OESequenceMetadataToJson.rst
   OEStructureMetadataFromJson.rst
   OEStructureMetadataToJson.rst
   OEGetSuperposeMethodFromName.rst
   OEGetSuperposeMethodName.rst


.. _oespruce_part_api:

********************************
OESpruce API
********************************

.. toctree::
   :maxdepth: 2

   OESpruceClasses/OESpruceClasses
   OESpruceConstants/OESpruceConstants
   OESpruceFunctions/index



.. _oespruce_part_examples:

*********************************
Examples
*********************************

.. toctree::
   :maxdepth: 2

   spruce_examples


.. _spruce_examples_add_receptor_to_du:

Add Receptor Grid to Design Unit
==================================

This example adds a receptor grid to the design unit. Providing the pred and mask arguments
allows the user to control which component of the design unit is going to be treated as the receptor.

.. seealso::
  * :ref:`OEMakeReceptor <OEDocking_OEMakeReceptor>` function

Example
--------------------------------------------------------------------------------

.. oe:language:: python

    .. code-block:: console

        prompt> add_receptor_obj_to_du.py -du <oedu> -out <output oedu> -mask <OEDesignUnitComponents> -pred <predicate string>

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`add_receptor_obj_to_du.py <../../../../wrappers/python/examples/spruce/add_receptor_obj_to_du.py>`

   .. :ref:`Full listing. <listing-add_receptor_obj_to_du.py>`

   ..  literalinclude:: ../../../wrappers/python/examples/spruce/add_receptor_obj_to_du.py

   .. only:: oepdf

      .. oe:source:: add_receptor_obj_to_du.py
         :language: python

.. _spruce_examples_du2mmcif:

Creating mmcif file from an input DU
======================================

This example shows how to write an output mmcif file from a spruce generated design unit.

Command Line Interface
----------------------

This example uses an input design unit (oedu) file, and will output a mmcif file from it to a temporary
directory (see :oe:func:`OESpruce::OEMakeDesignUnits` for details on the API).

.. code-block:: console

   prompt> du2mmcif <input design unit> 

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`du2mmcif.py <../../../../wrappers/python/examples/spruce/du2mmcif.py>`
         and both the
         :download:`1TQN_A__DU__HEM_A-508.oedu <../../../../wrappers/test_data/OESpruceTests/1TQN_A__DU__HEM_A-508.oedu>`
         (the input design unit),

   ..   literalinclude:: ../../../wrappers/python/examples/spruce/du2mmcif.py

   .. only:: oepdf

      .. oe:source:: du2mmcif.py
         :language: python

Example
--------------------------------------------------------------------------------

.. oe:language:: python

   .. code-block:: console

      prompt> du2mmcif.py 1TQN_A__DU__HEM_A-508.oedu

.. seealso::

   * :oe:func:`OESpruce::OEMakeDesignUnits` function
   * :oe:func:`OEBio::OEReadDesignUnit` and :oe:func:`OEBio::OEWriteDesignUnit` functions in the **OEChem TK** manual
   * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class in the **OEChem TK** manual


.. _spruce_examples_extract_biounits_ref:

Extracting Biounits by aligning to a reference protein
=======================================================

Biounit (BU) extraction is one of the more basic functionalities offered through the
**Spruce TK**.  This example shows how to extract BUs using a sequence alignment to a reference protein.

Command Line Interface
----------------------

This example takes in an extraction PDB file, a reference PDB file, and optionally the minimum score for the alignment to the reference as well as a boolean flag to instruct the code to superimpose the output BU to the input reference protein (see :oe:func:`OESpruce::OEExtractBioUnits` for details on the API).

.. code-block:: console

   prompt> extract_biounits_ref <extract protein PDB> <reference protein PDB> [min score] [superpose]

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`extract_biounits_ref.py <../../../../wrappers/python/examples/spruce/extract_biounits_ref.py>`
         and both
         :download:`4OBD.pdb <../../../../sublibs/tklibs/spruce/tests/data/4OBD.pdb>`
         (the extraction PDB file)
         and
         :download:`2UPJ.pdb <../../../../sublibs/tklibs/spruce/tests/data/2UPJ.pdb>`
         (the reference PDB file)

   .. :ref:`Full listing. <listing-extract_biounits_ref.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/spruce/extract_biounits_ref.py

   .. only:: oepdf

      .. oe:source:: extract_biounits_ref.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`extract_biounits_ref.cpp <../../../../sublibs/tklibs/spruce/examples/extract_biounits_ref.cpp>`
         and both
         :download:`4OBD.pdb <../../../../sublibs/tklibs/spruce/tests/data/4OBD.pdb>`
         (the extraction PDB file)
         and
         :download:`2UPJ.pdb <../../../../sublibs/tklibs/spruce/tests/data/2UPJ.pdb>`
         (the reference PDB file)

   .. only:: oepdf

      .. oe:source:: extract_biounits_ref.cpp
         :language: c++

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> extract_biounits_ref 4OBD.pdb 2UPJ.pdb

.. oe:language:: python

   .. code-block:: console

      prompt> extract_biounits_ref.py 4OBD.pdb 2UPJ.pdb

will generate the following output:

::

   Writing biounit 0 to 4OBD_BU_0.oeb.gz
   Writing biounit 1 to 4OBD_BU_1.oeb.gz

.. seealso::

   * :oe:func:`OESpruce::OEExtractBioUnits` function
   * :ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>` class


.. _spruce_examples_extract_biounits_remarks:

Extracting Biounits from PDB header remarks
============================================

Biounit (BU) extraction is one of the more basic functionalities offered through the
**Spruce TK**.  This example shows how to extract BUs using the PDB header remarks.

Command Line Interface
----------------------

This example takes in a PDB file, and optionally the maximum number of atoms to be
considered a BU as well as a boolean flag to instruct the code to prefer author or
software generated headers (see :oe:func:`OESpruce::OEExtractBioUnits` for details on the API).

.. code-block:: console

   prompt> extract_biounits_remarks <extract protein PDB> [max atoms] [prefer author]

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`extract_biounits_remarks.py <../../../../wrappers/python/examples/spruce/extract_biounits_remarks.py>`
         and
         :download:`4re6.pdb <../../../../sublibs/tklibs/spruce/tests/data/4re6.pdb>`
         (the extraction PDB file)

   .. :ref:`Full listing. <listing-extract_biounits_remarks.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/spruce/extract_biounits_remarks.py

   .. only:: oepdf

      .. oe:source:: extract_biounits_remarks.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`extract_biounits_remarks.cpp <../../../../sublibs/tklibs/spruce/examples/extract_biounits_remarks.cpp>`
         and
         :download:`4re6.pdb <../../../../sublibs/tklibs/spruce/tests/data/4re6.pdb>`
         (the extraction PDB file)

   .. only:: oepdf

      .. oe:source:: extract_biounits_remarks.cpp
         :language: c++

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> extract_biounits_remarks 4re6.pdb

.. oe:language:: python

   .. code-block:: console

      prompt> extract_biounits_remarks.py 4re6.pdb

will generate the following output:

::

   Writing biounit 0 to 4re6_BU_0.oeb.gz
   Writing biounit 1 to 4re6_BU_1.oeb.gz

.. seealso::

   * :oe:func:`OESpruce::OEExtractBioUnits` function
   * :ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>` class


.. _spruce_examples_find_pockets:

Finding pockets and their properties (like, Surface Area) from a PDB file
=========================================================================

This example shows how to find pockets in an input PDB file using the 
:oe:func:`OESpruce::OEFindPockets` function. OEDesignUnit file 
(:ref:`OEDesignUnit <OEBio_OEDesignUnit>`) can also be used as input to find the pockets.

Command Line Interface
----------------------

This example uses an input PDB file, and will print surface area and list of residues 
for each found pocket in given PDB file.

.. code-block:: console

   prompt> findpockets <input protein molecule or DesignUnit file> 

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`findpockets.py <../../../../wrappers/python/examples/spruce/findpockets.py>`
         and the
         :download:`7mhf.pdb <../../../../wrappers/test_data/OESpruceTests/7mhf.pdb>`
         (the input PDB file),

   .. :ref:`Full listing. <listing-findpockets.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/spruce/findpockets.py

   .. only:: oepdf

      .. oe:source:: findpockets.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`findpockets.cpp <../../../../sublibs/tklibs/spruce/examples/findpockets.cpp>`
         and the
         :download:`7mhf.pdb <../../../../wrappers/test_data/OESpruceTests/7mhf.pdb>`
         (the input PDB file),

   .. only:: oepdf

      .. oe:source:: findpockets.cpp
         :language: c++

Example
--------------------------------------------------------------------------------

.. oe:language:: python

   .. code-block:: console

      prompt> findpockets.py 7mhf.pdb

   will generate the following output:

   ::

      pockets count: 1
      pocket_1 Residues count:  22
      pocket_1 Residues: 
      HOH 623   A 2  
      GLY 143   A 1  
      ASN 142   A 1  
      HOH 502   A 2  
      DMS 404   A 2  
      MET 165   A 1 A
      HOH 624   A 2  
      ASP 187   A 1  
      HOH 671   A 2  
      HOH 655   A 2  
      HOH 589   A 2  
      MET 49   A 1  
      HOH 782   A 2  
      ARG 188   A 1  
      THR 25   A 1  
      HIS 41   A 1  
      GLN 189   A 1  
      CYS 44   A 1  
      HOH 750   A 2  
      HOH 548   A 2  
      THR 45   A 1  
      SER 46   A 1  
      pocket_1 Surface Area:  211.0912322998047

.. oe:language:: c++

   .. code-block:: console

      prompt> findpockets 7mhf.pdb

   will generate the following output:

   ::

      pockets count: 1
      pocket_1Residues count: 22
      pocket_1Residues: 
      HOH 623
      GLY 143
      ASN 142
      HOH 502
      DMS 404
      MET 165
      HOH 624
      ASP 187
      HOH 671
      HOH 655
      HOH 589
      MET 49
      HOH 782
      ARG 188
      THR 25
      HIS 41
      GLN 189
      CYS 44
      HOH 750
      HOH 548
      THR 45
      SER 46
      pocket_1 Surface Area: 211.091

.. seealso::

   * :ref:`OEPocketOptions <OESpruce_OEPocketOptions>` class


.. _spruce_examples_make_apo_design_units:

Creating apo OEDesignUnits from a PDB file
==========================================

Preparation of a biological structure file (PDB, mmCIF) to a fully charged,
hydrogenated, molecular componentized object (design unit; DU; :ref:`OEDesignUnit <OEBio_OEDesignUnit>`)
is one of the more advanced functionalities offered through **Spruce TK**.
This example shows how to construct apo DUs using an input PDB file and the
:oe:func:`OESpruce::OEMakeDesignUnits` function.

Command Line Interface
----------------------

This example uses an input PDB file, and will output a set of DUs from it to a temporary
directory (see :oe:func:`OESpruce::OEMakeDesignUnits` for details on the API).

.. code-block:: console

   make_apo_design_units <input biomolecular PDB> <site_residue> [<electron density mtz>] <LoopModelingTemplateDB>]

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`make_apo_design_units.py <../../../../wrappers/python/examples/spruce/make_apo_design_units.py>`
         and both the
         :download:`1w50.pdb <../../../../wrappers/test_data/OESpruceTests/1w50.pdb>`
         (the input PDB file),
         :download:`1w50.mtz <../../../../wrappers/test_data/OESpruceTests/1w50.mtz>`
         (the input MTZ file), and
         :download:`spruce_bace.loop_db <../../../../wrappers/test_data/OESpruceTests/spruce_bace.loop_db>`
         (the input loopDB file)

   .. :ref:`Full listing. <listing-make_apo_design_units.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/spruce/make_apo_design_units.py

   .. only:: oepdf

      .. oe:source:: make_apo_design_units.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`make_apo_design_units.cpp <../../../../sublibs/tklibs/spruce/examples/make_apo_design_units.cpp>`
         and both the
         :download:`1w50.pdb <../../../../wrappers/test_data/OESpruceTests/1w50.pdb>`
         (the input PDB file),
         :download:`1w50.mtz <../../../../wrappers/test_data/OESpruceTests/1w50.mtz>`
         (the input MTZ file), and
         :download:`spruce_bace.loop_db <../../../../wrappers/test_data/OESpruceTests/spruce_bace.loop_db>`
         (the input loopDB file)

Example
--------------------------------------------------------------------------------

.. oe:language:: python

   .. code-block:: console

      make_apo_design_units.py 1w50.pdb "ASP:228: :A" 1w50.mtz  spruce_bace.loop_db

.. oe:language:: c++

   .. code-block:: console

      make_apo_design_units 1w50.pdb "ASP:228: :A" 1w50.mtz  spruce_bace.loop_db

will generate the following output (failing to add partial charges to iodine):

::

   DPI: 0.13, RFree: 0.28, Resolution: 1.75
   Processing BU # 0 with title: BETA-SECRETASE 1, chains A
   Found gap between ALA 157   A 1   and ALA 168   A 1  , with sequence GFPLNQSEVL
   Opened database spruce_bace.loop_db
   LoopDatabase Info:
       276 loops from RSCB last synced on 03-19-2020, were added to LoopTemplateDatabase on 03-19-2020 using Spruce Toolkit 1.0.0.a
       The loop database was built with a max loop length of 22, a termini crop length of 2, and excluding regular secondary structures
   Warning: Failed to charge miscellaneous components
   Warning: Unable to add partial charges and radii to DesignUnit: BETA-SECRETASE 1(A)__DU__biounit
   Iridium Category: NA, DPI: 0.13, RFree: 0.28, Resolution: 1.75

.. seealso::

   * :oe:func:`OESpruce::OEMakeDesignUnits` function
   * :oe:func:`OEBio::OEReadDesignUnit` and :oe:func:`OEBio::OEWriteDesignUnit` functions in the **OEChem TK** manual
   * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class in the **OEChem TK** manual


.. _spruce_examples_make_design_units_using_metadata:

Creating OEDesignUnits Using Provided Metadata
===============================================

Preparation of a biological structure file (PDB, mmCIF) to a fully charged,
hydrogenated, molecular componentized object (design unit, or DU; :ref:`OEDesignUnit <OEBio_OEDesignUnit>`)
is one of the more advanced functionalities offered through **Spruce TK**. Metadata can be provided to **Spruce TK**
to identify the target ligand, the desired ligand tautomeric state, and the DU title. In the case where
SEQRES data is not present for the structure, the sequence specified in the metadata can be used to build missing gaps and identify
natural termini versus termini that need to be capped.

Metadata can be provided in the form of a JSON. The example below shows a template for it. It was generated by 
exporting an :oe:cls:`OESpruce::OEStructureMetadata` class.

.. code-block::
   
   {
      "StructureID": "",
      "Author": "",
      "Keywords": [],
      "RevisionDate": "",
      "Revision": "",
      "ExperimentDate": "",
      "ExperimentType": "UNKNOWN",
      "IridiumData": {
         "Category": "NA",
         "LaD": 0.0,
         "ASaD": 0.0,
         "POL": false,
         "POAS": false,
         "AltConfs": false,
         "PackRes": false,
         "Excp": false,
         "IrrRFree": false,
         "PossCov": false,
         "DPI": 20.0,
         "RFree": 0.0,
         "Resolution": 0.0,
         "HasMTZ": false
      },
      "SequenceMetadata": [],
      "HeterogenMetadata": []
   }

This example shows how to construct DUs with a specific ligand tautomer by providing ligand metadata.

Command Line Interface
----------------------

This example uses an input PDB/mmCIF file and a metadata JSON file, and will output a set of DUs with the specified
ligand tautomers. Setting the -generate_tautomers option to false ensures that only the tautomers specified in the metadata
file are considered. Setting the -opt_expt_protons option to true ensures that experimental protons are optimized and thus
the tautomeric state can be changed based on the provided metadata. The provided script can be used with a modified metadata
file to accomplish the other mentioned examples as well.

.. code-block:: console

     prompt> make_design_unit_using_metadata.py -in <PDB/mmCIF file> -loop_db <loop database> -metadata <metadata JSON> -generate_tautomers false -opt_expt_protons true

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`make_design_unit_using_metadata.py <../../../../wrappers/python/examples/spruce/make_design_unit_using_metadata.py>`
         and both the
         :download:`5CDO.cif <../../../../wrappers/test_data/OESpruceTests/5CDO.cif>`
         (the input mmCIF file),
         :download:`53M_ligand.json <../../../../wrappers/test_data/OESpruceTests/53M_ligand.json>`
         (the input metadata file), and
         :download:`spruce_bace.loop_db <../../../../wrappers/test_data/OESpruceTests/spruce_bace.loop_db>`
         (the input loopDB file)

   .. :ref:`Full listing. <listing-make_design_unit_using_metadata.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/spruce/make_design_unit_using_metadata.py

.. only:: oepdf

      .. oe:source:: make_design_unit_using_metadata.py
         :language: python

.. seealso::

   * :oe:func:`OESpruce::OEMakeDesignUnits` function
   * :oe:func:`OEBio::OEReadDesignUnit` and :oe:func:`OEBio::OEWriteDesignUnit` functions in the **OEChem TK** manual
   * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class in the **OEChem TK** manual
   * :oe:cls:`OESpruce::OEStructureMetadata` class


.. _spruce_examples_make_design_units:

Creating OEDesignUnits from a PDB file
======================================

Preparation of a biological structure file (PDB, mmCIF) to a fully charged,
hydrogenated, molecular componentized object (design unit; DU; :ref:`OEDesignUnit <OEBio_OEDesignUnit>`)
is one of the more advanced functionalities offered through **Spruce TK**.
This example shows how to construct DUs using an input PDB file and the
:oe:func:`OESpruce::OEMakeDesignUnits` function.

Command Line Interface
----------------------

This example uses an input PDB file, and will output a set of DUs from it to a temporary
directory (see :oe:func:`OESpruce::OEMakeDesignUnits` for details on the API).

.. code-block:: console

   make_design_units <input biomolecular PDB> [<electron density mtz>] [<LoopModelingTemplateDB>]

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`make_design_units.py <../../../../wrappers/python/examples/spruce/make_design_units.py>`
         and both the
         :download:`3tpp.pdb <../../../../wrappers/test_data/OESpruceTests/3tpp.pdb>`
         (the input PDB file),
         :download:`3tpp.mtz <../../../../wrappers/test_data/OESpruceTests/3tpp.mtz>`
         (the input MTZ file), and
         :download:`spruce_bace.loop_db <../../../../wrappers/test_data/OESpruceTests/spruce_bace.loop_db>`
         (the input loopDB file)

   .. :ref:`Full listing. <listing-make_design_units.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/spruce/make_design_units.py

   .. only:: oepdf

      .. oe:source:: make_design_units.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`make_design_units.cpp <../../../../sublibs/tklibs/spruce/examples/make_design_units.cpp>`
         and both the
         :download:`3tpp.pdb <../../../../wrappers/test_data/OESpruceTests/3tpp.pdb>`
         (the input PDB file),
         :download:`3tpp.mtz <../../../../wrappers/test_data/OESpruceTests/3tpp.mtz>`
         (the input MTZ file), and
         :download:`spruce_bace.loop_db <../../../../wrappers/test_data/OESpruceTests/spruce_bace.loop_db>`
         (the input loopDB file)

   .. only:: oepdf

      .. oe:source:: make_design_units.cpp
         :language: c++

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      make_design_units 3tpp.pdb 3tpp.mtz spruce_bace.loop_db

.. oe:language:: python

   .. code-block:: console

      make_design_units.py 3tpp.pdb 3tpp.mtz spruce_bace.loop_db

will generate the following output:

::

   DPI: 0.06, RFree: 0.18, Resolution: 1.60
   Processing BU # 0 with title: BETA-SECRETASE 1, chains A, alt: A
   Warning: For residue ARG -4   A 1   removing clashing solvent molecule HOH 597   A 2
   Warning: For residue ARG -4   A 1   removing clashing solvent molecule HOH 487 A A 1
   Warning: For residue ARG 7   A 1   removing clashing solvent molecule HOH 498   A 2
   Warning: For residue ARG 7   A 1   removing clashing solvent molecule HOH 730   A 2
   Warning: For residue ARG 7   A 1   removing clashing solvent molecule HOH 653   A 2
   Warning: For residue ARG 128   A 1   removing clashing solvent molecule HOH 523   A 2
   Warning: For residue ARG 128   A 1   removing clashing solvent molecule HOH 654   A 2
   Warning: For residue LYS 142   A 1   removing clashing solvent molecule HOH 550   A 2
   Warning: For residue LYS 142   A 1   removing clashing solvent molecule HOH 691   A 2
   Warning: For residue ARG 205   A 1   removing clashing solvent molecule HOH 423   A 2
   Warning: For residue ARG 205   A 1   removing clashing solvent molecule HOH 703   A 2
   Warning: For residue LYS 256   A 1   removing clashing solvent molecule HOH 604   A 2
   Found gap between ALA 157   A 1   and VAL 170   A 1  , with sequence GFPLNQSEVLAS
   Found gap between GLU 310   A 1   and THR 314   A 1  , with sequence DVA
   Opened database spruce_bace.loop_db
   LoopDatabase Info:
       276 loops from RSCB last synced on 03-19-2020, were added to LoopTemplateDatabase on 03-19-2020 using Spruce Toolkit 1.0.0.a
       The loop database was built with a max loop length of 22, a termini crop length of 2, and excluding regular secondary structures
   Opened database spruce_bace.loop_db
   LoopDatabase Info:
       276 loops from RSCB last synced on 03-19-2020, were added to LoopTemplateDatabase on 03-19-2020 using Spruce Toolkit 1.0.0.a
       The loop database was built with a max loop length of 22, a termini crop length of 2, and excluding regular secondary structures
   Processing BU # 1 with title: BETA-SECRETASE 1, chains A, alt: B
   Warning: For residue ARG -4   A 1   removing clashing solvent molecule HOH 597   A 2
   Warning: For residue ARG -4   A 1   removing clashing solvent molecule HOH 487 A A 1
   Warning: For residue LYS 9   A 1   removing clashing solvent molecule HOH 675   A 2
   Warning: For residue ARG 128   A 1   removing clashing solvent molecule HOH 523   A 2
   Warning: For residue ARG 128   A 1   removing clashing solvent molecule HOH 654   A 2
   Warning: For residue LYS 142   A 1   removing clashing solvent molecule HOH 448   A 2
   Warning: For residue LYS 142   A 1   removing clashing solvent molecule HOH 735   A 2
   Warning: For residue ARG 205   A 1   removing clashing solvent molecule HOH 423   A 2
   Warning: For residue ARG 205   A 1   removing clashing solvent molecule HOH 703   A 2
   Warning: For residue LYS 256   A 1   removing clashing solvent molecule HOH 604   A 2
   Found gap between ALA 157   A 1   and VAL 170   A 1  , with sequence GFPLNQSEVLAS
   Found gap between GLU 310   A 1   and THR 314   A 1  , with sequence DVA
   Opened database spruce_bace.loop_db
   LoopDatabase Info:
       276 loops from RSCB last synced on 03-19-2020, were added to LoopTemplateDatabase on 03-19-2020 using Spruce Toolkit 1.0.0.a
       The loop database was built with a max loop length of 22, a termini crop length of 2, and excluding regular secondary structures
   Opened database spruce_bace.loop_db
   LoopDatabase Info:
       276 loops from RSCB last synced on 03-19-2020, were added to LoopTemplateDatabase on 03-19-2020 using Spruce Toolkit 1.0.0.a
       The loop database was built with a max loop length of 22, a termini crop length of 2, and excluding regular secondary structures
   DU: BETA-SECRETASE 1(A)altA > 5HA(A-999), Iridium Category: HT, LaD: 1.00, ASaD: 1.00, DPI: 0.06, POL: false, POAS: false, AltConfs: false, PackRes: false, Excp: false, IrrRFree: false, PossCov: false
   DU: BETA-SECRETASE 1(A)altB > 5HA(A-999), Iridium Category: HT, LaD: 1.00, ASaD: 1.00, DPI: 0.06, POL: false, POAS: false, AltConfs: false, PackRes: false, Excp: false, IrrRFree: false, PossCov: false
   Skipping redundant DU with alts outside the site of interest, renaming existing to collapse alts
   Discarding redundant alt DU with title BETA-SECRETASE 1(A)altB > 5HA(A-999)

.. seealso::

   * :oe:func:`OESpruce::OEMakeDesignUnits` function
   * :oe:func:`OEBio::OEReadDesignUnit` and :oe:func:`OEBio::OEWriteDesignUnit` functions in the **OEChem TK** manual
   * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class in the **OEChem TK** manual


.. _spruce_examples_metadata:

Write a metadata JSON file from a FASTA file
================================================================================

This example shows how to read in a FASTA to structure metadata and write to a JSON file.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

    .. code-block:: console

        prompt> fasta_to_structmeta seq.fasta chainIDs output.JSON

.. oe:language:: python
    
   .. code-block:: console

      prompt> fasta_to_structmeta.py seq.fasta chainIDs output.JSON

Code
--------------------------------------------------------------------------------

.. oe:language:: c++

    .. only:: oehtml

        .. admonition:: Download code

           :download:`fasta_to_structmeta.cpp <../../../../sublibs/tklibs/spruce/examples/fasta_to_structmeta.cpp>`

    .. only:: oepdf

        .. oe:source:: fasta_to_structmeta.cpp
            :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`fasta_to_structmeta.py <../../../../wrappers/python/examples/spruce/fasta_to_structmeta.py>`
.. wrappers/python/examples/spruce/fasta_to_structmeta.py
.. rstdocs/toolkits/sprucetk/examples_metadata.rst

.. :ref:`Full listing. <listing-fasta_to_structmeta.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/spruce/fasta_to_structmeta.py

   .. only:: oepdf

      .. oe:source:: fasta_to_structmeta.py
         :language: python

.. _spruce_examples_superposition:

Calculating superposition
=================================

The superposition calculation is a functionality offered through the
**Spruce TK**.  This example shows how to calculate structural superposition using
either the global, DDM, weighted-DDM, site sequence, or SSE methods.

Command Line Interface
----------------------

This example takes in a reference and a fit protein (from either a PDB or OEDU file) and aligns them with one of the supported methods 
(see :oe:constns:`OESpruce::OESuperposeMethod` for methods and descriptions).

.. code-block:: console

   prompt> superpose <reference protein PDB> <fit protein PDB> [global|ddm|weighted|sse|site] [site-residue file]

Code
----------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`superpose.py <../../../../wrappers/python/examples/spruce/superpose.py>`
         and both
         :download:`1A29.pdb <../../../../sublibs/tklibs/spruce/tests/data/1A29.pdb>`
         (the reference PDB file)
         and
         :download:`1CLL.pdb <../../../../sublibs/tklibs/spruce/tests/data/1CLL.pdb>`
         (the fit PDB file)

   .. :ref:`Full listing. <listing-superpose.py>`

   .. literalinclude:: ../../../wrappers/python/examples/spruce/superpose.py

   .. only:: oepdf

      .. oe:source:: superpose.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`superpose.cpp <../../../../sublibs/tklibs/spruce/examples/superpose.cpp>`
         and both
         :download:`1A29.pdb <../../../../sublibs/tklibs/spruce/tests/data/1A29.pdb>`
         (the reference PDB file)
         and
         :download:`1CLL.pdb <../../../../sublibs/tklibs/spruce/tests/data/1CLL.pdb>`
         (the fit PDB file)

   .. only:: oepdf

      .. oe:source:: superpose.cpp
         :language: c++

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> superpose 1A29.pdb 1CLL.pdb ddm

.. oe:language:: python

   .. code-block:: console

      prompt> superpose.py 1A29.pdb 1CLL.pdb ddm

will generate the following output:

::

   Superposing 1CLL.pdb to 1A29.pdb using ddm
   Writing superimposed fit protein to 1CLL_sp.oeb.gz
   RMSD: 0.596203 Angstroms
   SeqScore: 642

.. seealso::

   * :ref:`OESuperpose <OESpruce_OESuperpose>` class
   * :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` class
   * :ref:`OESuperposeResults <OESpruce_OESuperposeResults>` class
   * :oe:constns:`OESpruce::OESuperposeMethod` namespace


.. _spruce_examples_validate_design_unit:

Validate Structure of the Design Unit
================================================================================

This example validates the structure of the design unit.

.. seealso::
  * :ref:`OEValidateDesignUnit <OESpruce_OEValidateDesignUnit>` class
  * :ref:`OEDesignUnitIssueCodes <OESpruce_OEDesignUnitIssueCodes>` namespace

Example
--------------------------------------------------------------------------------

.. oe:language:: python

    .. code-block:: console

        prompt> validate_design_unit.py <input design unit>

Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`validate_design_unit.py <../../../../wrappers/python/examples/spruce/validate_design_unit.py>`

   .. :ref:`Full listing. <listing-validate_design_unit.py>`

   ..   literalinclude:: ../../../wrappers/python/examples/spruce/validate_design_unit.py

.. wrappers/python/examples/spruce/validate_design_unit.py
.. rstdocs/toolkits/sprucetk/examples_validate_design_unit.rst

   .. only:: oepdf

      .. oe:source:: validate_design_unit.py
         :language: python

.. spruce toolkit documentation master file

.. _spruce-toolkit-intro:

###################################
Spruce Toolkit |spruce_version|
###################################

.. attention::

   **Spruce TK** is currently only available in C++ and Python.

..  oe:language:: python

    .. toctree::
       :maxdepth: 3

       introduction
       theory
       examples
       selected_examples_python
       api
       releasenotes/index

..  oe:language:: c++ csharp java

    .. toctree::
       :maxdepth: 3

       introduction
       theory
       examples
       api
       releasenotes/index

..  only:: not html

    ..  include:: <isonum.txt>

=========================
Copyright and Trademarks
=========================

.. do not put explicit line breaks in this section

|copy| 1997-2024 Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. All rights reserved.

OpenEye, Lexichem, ROCS, Grapheme, and Orion are registered trademarks of Cadence Design Systems, Inc.

This material contains proprietary information of Cadence Design Systems, Inc.  Use of copyright notice is precautionary only and does not imply publication or disclosure.

The information supplied in this document is believed to be true, but no liability is assumed for its use or the infringement of the rights of others resulting from its use.  Information in this document is subject to change without notice and does not represent a commitment on the part of Cadence Design Systems, Inc.

This package is sold/licensed/distributed subject to the condition that it shall not, by way of trade or otherwise, be lent, re-sold, hired out, or otherwise circulated without Cadence Design Systems' prior consent, in any form of packaging or cover other than that in which it was produced.  No part of this manual or accompanying documentation, may be reproduced, stored in a retrieval system on optical or magnetic disk, tape, CD, DVD or other medium, or transmitted in any form or by any means, electronic, mechanical, photocopying recording, or otherwise for any purpose other than for the purchaser's personal use without a legal agreement or other written permission granted by Cadence.

This product should not be used in the planning, construction, maintenance, operation or use of any nuclear facility nor the flight, navigation, or communication of aircraft or ground support equipment. Cadence Design Systems, Inc., shall not be liable, in whole or in part, for any claims arising from such use, including death, bankruptcy or outbreak of war.

Windows is a registered trademark of Microsoft Corporation.  Apple, OS X, macOS, and Macintosh are registered trademarks of Apple Inc. UNIX is a registered trademark of the Open Group.  Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. SUSE, SLED, and SLES are registered trademarks of Novell, Inc. Ubuntu is a registered trademark of Canonical Ltd.

SYBYL is a registered trademark of Certara, L.P. MDL, BIOVIA and ISIS are registered trademarks of Dassault Systemes and/or its affiliates. SMARTS and SMIRKS are registered trademarks of Daylight Chemical Information Systems, Inc. MacroModel is a registered trademark of Schrodinger, LLC.

Python is a registered trademark of the Python Software Foundation. Django is a registered trademark of the Django Software Foundation. Java is a registered trademark of Oracle and/or its affiliates.

Other products and software packages referenced in this document are trademarks and registered trademarks of their respective vendors or manufacturers.


    ================
Sample Code
================

For all of the code examples and samples within
documents published by OpenEye, Cadence Molecular Sciences,
the following terms of use apply.

TERMS FOR USE OF SAMPLE CODE

The software below ("Sample Code") is
provided to current licensees or subscribers of Cadence products or
SaaS offerings (each a "Customer"). Customer is hereby permitted to use,
copy, and modify the Sample Code,
subject to these terms. Cadence claims no rights to Customer's
modifications. Modification of Sample Code is at Customer's sole and
exclusive risk. Sample Code may require Customer to have a then
current license or subscription to the applicable Cadence offering.

THE SAMPLE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED.  CADENCE DISCLAIMS ALL WARRANTIES, INCLUDING, BUT
NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. In no event shall Cadence be
liable for any damages or liability in connection with the Sample Code
or its use.

    ===========
Citation
===========

Please follow the guidelines in this document to cite use of our products in research publications and other documents.

For more information, please contact `OpenEye Support <mailto:support@openeye.com>`_.

Orion\ :sup:`®`
=====================

To cite use of Orion, please use the following::

    Orion <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Orion 2025.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The version number for Orion appears in the product's release notes, for example,
https://docs.eyesopen.com/orion-user-interface/releasenotes/index.html.

Orion Floes
=====================

To cite use of an Orion-based floe package, please use the following::

    OpenEye <package-name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Large-Scale Floes 4.2.3. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.


The version number for a floe package is displayed on the first page of the package's release notes.  For
example: https://docs.eyesopen.com/floe/modules/large_scale_floes/docs/source/releasenotes_2025_1.html.

Toolkits and Applications
==========================

To cite OpenEye toolkits or applications used in your work, please use the following::

    OpenEye Toolkits [or Applications] <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    OpenEye Toolkits 2024.2.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.



..  explicit URL used below because labels are too complicated to maintain across releases

The Applications and Toolkits are released as a package, multiple times per year.  The first
part of the version number designates the calendar year.  `The version number appears on the summary
document for the package <https://docs.eyesopen.com/applications/index.html>`_.


If you want to cite an individual application or toolkit, you can use the syntax::

    <product name> <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

where *<product name>* is:

* Bioisostere TK
* OEChem TK
* OEDepict TK
* OEDocking TK
* OEFF TK
* Eon TK
* FastROCS TK
* Grapheme TK
* GraphSim TK
* Lexichem TK
* OEMedChem TK
* MolProp TK
* Omega TK
* Quacpac TK
* Shape TK
* Spicoli TK
* Spruce TK
* Szmap TK
* Szybki TK
* Zap TK

*   AFITT Application
*   BROOD Application
*   OEDocking Application
*   EON Application
*   OMEGA Application
*   PICTO Application
*   pKa-Prospector Application
*   QUACPAC Application
*   ROCS Application
*   SiteHopper Application
*   SPRUCE Application
*   SZMAP Application
*   SZYBKI Application
*   VIDA Application

You can use the version number of the individual Application or Toolkit.   For example::

    SZYBKI Application 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

    Szybki TK 2.8.0.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

The first documentation pages give the product names and version numbers, as in https://docs.eyesopen.com/applications/szybki/index.html and
https://docs.eyesopen.com/toolkits/python/szybkitk/index.html.

Publications for Bibliographies
=================================

Please also cite these publications if the corresponding product was used in your research.

Orion
-----------

Sørensen, J., Bannan, C.C., Calabrò, G., Jain, V., Ovanesyan, G., Smith, A.,
Zhang, S., Bayly, C.I., Darden, T.A., Geballe, M.T., LeBard, D.N.,
McGann, M., Moon, J.B., Muddana, H.S., Shewmaker, A., LaFon, J.,
Tolbert, R.W., Skillman, A.G., Nicholls, A.
Orion\ ® A Cloud-Native Molecular Design Platform.
In *Computational Drug Discovery*. V. Poongavanam and V. Ramaswamy, Eds. Wiley-VCH, 2024; pp. 579–615.
DOI: 10.1002/9783527840748.ch24

AFITT and FLYNN Applications
----------------------------------

Wlodek, S.; Skillman, A.G.; Nicholls, A. Automated Ligand Placement and Refinement with a Combined Force Field and Shape Potential.
*Acta Crystallogr., Sect. D: Struct. Biol.* **2006**, *62* (7), 741–749.
DOI: 10.1107/s0907444906016076

OEDocking Application and Toolkit
------------------------------------

Kelley, B.P.; Brown, S.P.; Warren, G.L.; Muchmore, S.W. POSIT: Flexible Shape-Guided Docking For Pose Prediction. *J. Chem. Inf. Model.* **2015**, *55* (8), 1771-1780. DOI: 10.1021/acs.jcim.5b00142

McGann, M. FRED Pose Prediction and Virtual Screening Accuracy. *J. Chem. Inf. Model.* **2011**, *51* (3), 578-596. DOI: 10.1021/ci100436p

McGann, M. FRED and HYBRID Docking Performance on Standardized Datasets. *J. Comput.-Aided Mol. Des.* **2012**, *26* (8), 897-906. DOI: 10.1007/s10822-012-9584-8

OMEGA Application and Toolkit
---------------------------------

If you are using OMEGA in torsion driving mode, please cite the following two publications.

Hawkins, P.C.D.; Skillman, A.G.; Warren, G.L.; Ellingson, B.A.; Stahl, M.T. Conformer
Generation with OMEGA: Algorithm and Validation Using High Quality Structures from the
Protein Databank and the Cambridge Structural
Database. *J. Chem. Inf. Model.* **2010**, *50* (4), 572-584. DOI: 10.1021/ci100031x

Hawkins, P.C.D. and Nicholls, A.  Conformer
Generation with OMEGA: Learning from the Data Set and the Analysis of Failures.
*J. Chem. Inf. Model.* **2012**, *52* (11), 2919–2936. DOI: /10.1021/ci300314k

If you are using OMEGA in macrocyle mode, please cite the following.

Hawkins, P.C.D. and Wlodek, S. Decisions with Confidence: Application to the Conformation Sampling of
Molecules in the Solid State. *J. Chem. Inf. Model.* **2020**, *60* (7), 3518–3533.
DOI: /10.1021/acs.jcim.0c00358


ROCS Application
------------------

Hawkins, P.C.D.; Skillman, A.G.; Nicholls, A. Comparison of Shape-Matching and Docking
as Virtual Screening Tools. *J. Med. Chem.* **2007**, *50* (1), 74-82. DOI: 10.1021/jm0603365



OpenEye MMDS Web Service
============================

To cite use of the Macromolecular Data Service (MMDS) web service, please use the syntax::

    Macromolecular Data Service <version-number>. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

For example::

    Macromolecular Data Service 1.1. OpenEye, Cadence Molecular Sciences, Santa Fe, NM. http://www.eyesopen.com.

`The MMDS version number appears on the web service's release notes <https://docs.eyesopen.com/webservices/mmds/releasenotes/index.html>`_.


    ======================
Technology Licensing
======================

OpenEye products use the following technology under license.

Some of the open source technologies we use are licensed under the GNU Public License (GPL)
version 2 or 3. In all instances, these technologies are communicated with using the
"at arms length" principle, using pipes and command line arguments.

While the software is in some instances assembled into a container,
that assembly does not invoke the GPL copyleft scope. For each Floe package where these are
used, the environment log clearly details the installed programs and their version numbers.
With the links below for each technology, the source for each of those programs is available.

..  csv-table:: Licensed Technology
    :header-rows: 1
    :widths: auto
    :file: 3rd_party_license_attribution.csv

    GCC
================================================================================

On the Linux platform, The OpenEye toolkits are linked with the GCC libraries
using an eligible compilation process under the terms of the
GCC RUNTIME LIBRARY EXCEPTION (see below).

The OpenEye toolkits are NOT open source software and are NOT governed by GPL
or other open source licenses. Your right to use the toolkits are governed by
the OpenEye license which is binding to You.

For certain Linux distributions, GCC library components are included as object
files.  Your rights to use GCC library components (libstdc++, libgcc, and
libgomp) included with these distributions are governed by the GPLv3 license as
follows:

The components libstdc++, libgcc, and libgomp are part of GCC.

* GCC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

* GCC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC (see below).  If not, see `Licenses GNU Project  <http://www.gnu.org/licenses/>`_ .

Per GPLv3, section 6d, the source for GCC is available for download from the
following location: `GNU  <http://gcc.gnu.org>`_.  The GCC library components
included here are from version gcc-4.9.3 and are built using the standard
instructions at `Installing GCC <http://gcc.gnu.org/install/>`_.



GCC RUNTIME LIBRARY EXCEPTION
---------------------------------

:: 

   Version 3.1, 31 March 2009

   Copyright © 2009 Free Software Foundation, Inc. http://fsf.org/

   Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

   This GCC Runtime Library Exception ("Exception") is an additional permission under section 7 of the GNU General Public License, 
   version 3 ("GPLv3"). It applies to a given file (the "Runtime Library") that bears a notice placed by the copyright holder 
   of the file stating that the file is governed by GPLv3 along with this Exception.

   When you use GCC to compile a program, GCC may combine portions of certain GCC header files and runtime libraries with 
   the compiled program. The purpose of this Exception is to allow compilation of non-GPL (including proprietary) programs 
   to use, in this way, the header files and runtime libraries covered by this Exception.

   0. Definitions.

   A file is an "Independent Module" if it either requires the Runtime Library for execution after a Compilation Process, 
   or makes use of an interface provided by the Runtime Library, but is not otherwise based on the Runtime Library.

   "GCC" means a version of the GNU Compiler Collection, with or without modifications, governed by version 3 (or a specified 
   later version) of the GNU General Public License (GPL) with the option of using any subsequent versions published by the FSF.

   "GPL-compatible Software" is software whose conditions of propagation, modification and use would permit combination with 
   GCC in accord with the license of GCC.

   "Target Code" refers to output from any compiler for a real or virtual target processor architecture, in executable 
   form or suitable for input to an assembler, loader, linker and/or execution phase. Notwithstanding that, Target Code 
   does not include data in any format that is used as a compiler intermediate representation, or used for producing a 
   compiler intermediate representation.

   The "Compilation Process" transforms code entirely represented in non-intermediate languages designed for human-written 
   code, and/or in Java Virtual Machine byte code, into Target Code. Thus, for example, use of source code generators and 
   preprocessors need not be considered part of the Compilation Process, since the Compilation Process can be understood 
   as starting with the output of the generators or preprocessors.

   A Compilation Process is "Eligible" if it is done using GCC, alone or with other GPL-compatible software, or if it is 
   done without using any work based on GCC. For example, using non-GPL-compatible Software to optimize any GCC intermediate 
   representations would not qualify as an Eligible Compilation Process.

   1. Grant of Additional Permission.

   You have permission to propagate a work of Target Code formed by combining the Runtime Library with Independent Modules, 
   even if such propagation would otherwise violate the terms of GPLv3, provided that all Target Code was generated by 
   Eligible Compilation Processes. You may then convey such a combination under terms of your choice, consistent with the 
   licensing of the Independent Modules.

   2. No Weakening of GCC Copyleft.

   The availability of this Exception does not imply any general presumption that third-party software is unaffected by 
   the copyleft requirements of the license of GCC.

.. seealso::

   * http://www.gnu.org/licenses/gcc-exception.html



GNU GENERAL PUBLIC LICENSE
----------------------------


::

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

   Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
   Everyone is permitted to copy and distribute verbatim copies
   of this license document, but changing it is not allowed.

                            Preamble

   The GNU General Public License is a free, copyleft license for
   software and other kinds of works.

     The licenses for most software and other practical works are designed
   to take away your freedom to share and change the works.  By contrast,
   the GNU General Public License is intended to guarantee your freedom to
   share and change all versions of a program--to make sure it remains free
   software for all its users.  We, the Free Software Foundation, use the
   GNU General Public License for most of our software; it applies also to
   any other work released this way by its authors.  You can apply it to
   your programs, too.

     When we speak of free software, we are referring to freedom, not
   price.  Our General Public Licenses are designed to make sure that you
   have the freedom to distribute copies of free software (and charge for
   them if you wish), that you receive source code or can get it if you
   want it, that you can change the software or use pieces of it in new
   free programs, and that you know you can do these things.

     To protect your rights, we need to prevent others from denying you
   these rights or asking you to surrender the rights.  Therefore, you have
   certain responsibilities if you distribute copies of the software, or if
   you modify it: responsibilities to respect the freedom of others.

     For example, if you distribute copies of such a program, whether
   gratis or for a fee, you must pass on to the recipients the same
   freedoms that you received.  You must make sure that they, too, receive
   or can get the source code.  And you must show them these terms so they
   know their rights.

     Developers that use the GNU GPL protect your rights with two steps:
   (1) assert copyright on the software, and (2) offer you this License
   giving you legal permission to copy, distribute and/or modify it.

     For the developers' and authors' protection, the GPL clearly explains
   that there is no warranty for this free software.  For both users' and
   authors' sake, the GPL requires that modified versions be marked as
   changed, so that their problems will not be attributed erroneously to
   authors of previous versions.

     Some devices are designed to deny users access to install or run
   modified versions of the software inside them, although the manufacturer
   can do so.  This is fundamentally incompatible with the aim of
   protecting users' freedom to change the software.  The systematic
   pattern of such abuse occurs in the area of products for individuals to
   use, which is precisely where it is most unacceptable.  Therefore, we
   have designed this version of the GPL to prohibit the practice for those
   products.  If such problems arise substantially in other domains, we
   stand ready to extend this provision to those domains in future versions
   of the GPL, as needed to protect the freedom of users.

     Finally, every program is threatened constantly by software patents.
   States should not allow patents to restrict development and use of
   software on general-purpose computers, but in those that do, we wish to
   avoid the special danger that patents applied to a free program could
   make it effectively proprietary.  To prevent this, the GPL assures that
   patents cannot be used to render the program non-free.

     The precise terms and conditions for copying, distribution and
   modification follow.

                       TERMS AND CONDITIONS

     0. Definitions.

     "This License" refers to version 3 of the GNU General Public License.

     "Copyright" also means copyright-like laws that apply to other kinds of
   works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
   License.  Each licensee is addressed as "you".  "Licensees" and
   "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the work
   in a fashion requiring copyright permission, other than the making of an
   exact copy.  The resulting work is called a "modified version" of the
   earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work based
   on the Program.

     To "propagate" a work means to do anything with it that, without
   permission, would make you directly or secondarily liable for
   infringement under applicable copyright law, except executing it on a
   computer or modifying a private copy.  Propagation includes copying,
   distribution (with or without modification), making available to the
   public, and in some countries other activities as well.

     To "convey" a work means any kind of propagation that enables other
   parties to make or receive copies.  Mere interaction with a user through
   a computer network, with no transfer of a copy, is not conveying.

     An interactive user interface displays "Appropriate Legal Notices"
   to the extent that it includes a convenient and prominently visible
   feature that (1) displays an appropriate copyright notice, and (2)
   tells the user that there is no warranty for the work (except to the
   extent that warranties are provided), that licensees may convey the
   work under this License, and how to view a copy of this License.  If
   the interface presents a list of user commands or options, such as a
   menu, a prominent item in the list meets this criterion.

     1. Source Code.

     The "source code" for a work means the preferred form of the work
   for making modifications to it.  "Object code" means any non-source
   form of a work.

     A "Standard Interface" means an interface that either is an official
   standard defined by a recognized standards body, or, in the case of
   interfaces specified for a particular programming language, one that
   is widely used among developers working in that language.

     The "System Libraries" of an executable work include anything, other
   than the work as a whole, that (a) is included in the normal form of
   packaging a Major Component, but which is not part of that Major
   Component, and (b) serves only to enable use of the work with that
   Major Component, or to implement a Standard Interface for which an
   implementation is available to the public in source code form.  A
   "Major Component", in this context, means a major essential component
   (kernel, window system, and so on) of the specific operating system
   (if any) on which the executable work runs, or a compiler used to
   produce the work, or an object code interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
   the source code needed to generate, install, and (for an executable
   work) run the object code and to modify the work, including scripts to
   control those activities.  However, it does not include the work's
   System Libraries, or general-purpose tools or generally available free
   programs which are used unmodified in performing those activities but
   which are not part of the work.  For example, Corresponding Source
   includes interface definition files associated with source files for
   the work, and the source code for shared libraries and dynamically
   linked subprograms that the work is specifically designed to require,
   such as by intimate data communication or control flow between those
   subprograms and other parts of the work.

     The Corresponding Source need not include anything that users
   can regenerate automatically from other parts of the Corresponding
   Source.

     The Corresponding Source for a work in source code form is that
   same work.

     2. Basic Permissions.

     All rights granted under this License are granted for the term of
   copyright on the Program, and are irrevocable provided the stated
   conditions are met.  This License explicitly affirms your unlimited
   permission to run the unmodified Program.  The output from running a
   covered work is covered by this License only if the output, given its
   content, constitutes a covered work.  This License acknowledges your
   rights of fair use or other equivalent, as provided by copyright law.

     You may make, run and propagate covered works that you do not
   convey, without conditions so long as your license otherwise remains
   in force.  You may convey covered works to others for the sole purpose
   of having them make modifications exclusively for you, or provide you
   with facilities for running those works, provided that you comply with
   the terms of this License in conveying all material for which you do
   not control copyright.  Those thus making or running the covered works
   for you must do so exclusively on your behalf, under your direction
   and control, on terms that prohibit them from making any copies of
   your copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
   the conditions stated below.  Sublicensing is not allowed; section 10
   makes it unnecessary.

     3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
   measure under any applicable law fulfilling obligations under article
   11 of the WIPO copyright treaty adopted on 20 December 1996, or
   similar laws prohibiting or restricting circumvention of such
   measures.

     When you convey a covered work, you waive any legal power to forbid
   circumvention of technological measures to the extent such circumvention
   is effected by exercising rights under this License with respect to
   the covered work, and you disclaim any intention to limit operation or
   modification of the work as a means of enforcing, against the work's
   users, your or third parties' legal rights to forbid circumvention of
   technological measures.

     4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
   receive it, in any medium, provided that you conspicuously and
   appropriately publish on each copy an appropriate copyright notice;
   keep intact all notices stating that this License and any
   non-permissive terms added in accord with section 7 apply to the code;
   keep intact all notices of the absence of any warranty; and give all
   recipients a copy of this License along with the Program.


     You may charge any price or no price for each copy that you convey,
   and you may offer support or warranty protection for a fee.

     5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
   produce it from the Program, in the form of source code under the
   terms of section 4, provided that you also meet all of these conditions:

      a) The work must carry prominent notices stating that you modified
      it, and giving a relevant date.

      b) The work must carry prominent notices stating that it is
      released under this License and any conditions added under section
      7.  This requirement modifies the requirement in section 4 to
      "keep intact all notices".

      c) You must license the entire work, as a whole, under this
      License to anyone who comes into possession of a copy.  This
      License will therefore apply, along with any applicable section 7
      additional terms, to the whole of the work, and all its parts,
      regardless of how they are packaged.  This License gives no
      permission to license the work in any other way, but it does not
      invalidate such permission if you have separately received it.

      d) If the work has interactive user interfaces, each must display
      Appropriate Legal Notices; however, if the Program has interactive
      interfaces that do not display Appropriate Legal Notices, your
      work need not make them do so.

     A compilation of a covered work with other separate and independent
   works, which are not by their nature extensions of the covered work,
   and which are not combined with it such as to form a larger program,
   in or on a volume of a storage or distribution medium, is called an
   "aggregate" if the compilation and its resulting copyright are not
   used to limit the access or legal rights of the compilation's users
   beyond what the individual works permit.  Inclusion of a covered work
   in an aggregate does not cause this License to apply to the other
   parts of the aggregate.

     6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
   of sections 4 and 5, provided that you also convey the
   machine-readable Corresponding Source under the terms of this License,
   in one of these ways:

     a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.

     b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
     model, to give anyone who possesses the object code either (1) a
     copy of the Corresponding Source for all the software in the
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
     conveying of source, or (2) access to copy the
     Corresponding Source from a network server at no charge.

     c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source.  This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.

     d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge.  You need not require recipients to copy the
     Corresponding Source along with the object code.  If the place to
     copy the object code is a network server, the Corresponding Source
     may be on a different server (operated by you or a third party)
     that supports equivalent copying facilities, provided you maintain
     clear directions next to the object code saying where to find the
     Corresponding Source.  Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.

     e) Convey the object code using peer-to-peer transmission, provided
     you inform other peers where the object code and Corresponding
     Source of the work are being offered to the general public at no
     charge under subsection 6d.

    A separable portion of the object code, whose source code is excluded
  from the Corresponding Source as a System Library, need not be
  included in conveying the object code work.

    A "User Product" is either (1) a "consumer product", which means any
  tangible personal property which is normally used for personal, family,
  or household purposes, or (2) anything designed or sold for incorporation
  into a dwelling.  In determining whether a product is a consumer product,
  doubtful cases shall be resolved in favor of coverage.  For a particular
  product received by a particular user, "normally used" refers to a
  typical or common use of that class of product, regardless of the status
  of the particular user or of the way in which the particular user
  actually uses, or expects or is expected to use, the product.  A product
  is a consumer product regardless of whether the product has substantial
  commercial, industrial or non-consumer uses, unless such uses represent
  the only significant mode of use of the product.

    "Installation Information" for a User Product means any methods,
  procedures, authorization keys, or other information required to install
  and execute modified versions of a covered work in that User Product from
  a modified version of its Corresponding Source.  The information must
  suffice to ensure that the continued functioning of the modified object
  code is in no case prevented or interfered with solely because
  modification has been made.

    If you convey an object code work under this section in, or with, or
  specifically for use in, a User Product, and the conveying occurs as
  part of a transaction in which the right of possession and use of the
  User Product is transferred to the recipient in perpetuity or for a
  fixed term (regardless of how the transaction is characterized), the
  Corresponding Source conveyed under this section must be accompanied
  by the Installation Information.  But this requirement does not apply
  if neither you nor any third party retains the ability to install
  modified object code on the User Product (for example, the work has
  been installed in ROM).

    The requirement to provide Installation Information does not include a
  requirement to continue to provide support service, warranty, or updates
  for a work that has been modified or installed by the recipient, or for
  the User Product in which it has been modified or installed.  Access to a
  network may be denied when the modification itself materially and
  adversely affects the operation of the network or violates the rules and
  protocols for communication across the network.

    Corresponding Source conveyed, and Installation Information provided,
  in accord with this section must be in a format that is publicly
  documented (and with an implementation available to the public in
  source code form), and must require no special password or key for
  unpacking, reading or copying.

    7. Additional Terms.

    "Additional permissions" are terms that supplement the terms of this
  License by making exceptions from one or more of its conditions.
  Additional permissions that are applicable to the entire Program shall
  be treated as though they were included in this License, to the extent
  that they are valid under applicable law.  If additional permissions
  apply only to part of the Program, that part may be used separately
  under those permissions, but the entire Program remains governed by
  this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option
  remove any additional permissions from that copy, or from any part of
  it.  (Additional permissions may be written to require their own
  removal in certain cases when you modify the work.)  You may place
  additional permissions on material, added by you to a covered work,
  for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you
  add to a covered work, you may (if authorized by the copyright holders of
  that material) supplement the terms of this License with terms:

      a) Disclaiming warranty or limiting liability differently from the
      terms of sections 15 and 16 of this License; or

      b) Requiring preservation of specified reasonable legal notices or
      author attributions in that material or in the Appropriate Legal
      Notices displayed by works containing it; or

      c) Prohibiting misrepresentation of the origin of that material, or
      requiring that modified versions of such material be marked in
      reasonable ways as different from the original version; or

      d) Limiting the use for publicity purposes of names of licensors or
      authors of the material; or

      e) Declining to grant rights under trademark law for use of some
      trade names, trademarks, or service marks; or

      f) Requiring indemnification of licensors and authors of that
      material by anyone who conveys the material (or modified versions of
      it) with contractual assumptions of liability to the recipient, for
      any liability that these contractual assumptions directly impose on
      those licensors and authors.

     All other non-permissive additional terms are considered "further
   restrictions" within the meaning of section 10.  If the Program as you
   received it, or any part of it, contains a notice stating that it is
   governed by this License along with a term that is a further
   restriction, you may remove that term.  If a license document contains
   a further restriction but permits relicensing or conveying under this
   License, you may add to a covered work material governed by the terms
   of that license document, provided that the further restriction does
   not survive such relicensing or conveying.

     If you add terms to a covered work in accord with this section, you
   must place, in the relevant source files, a statement of the
   additional terms that apply to those files, or a notice indicating
   where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in the
   form of a separately written license, or stated as exceptions;
   the above requirements apply either way.

     8. Termination.

     You may not propagate or modify a covered work except as expressly
   provided under this License.  Any attempt otherwise to propagate or
   modify it is void, and will automatically terminate your rights under
   this License (including any patent licenses granted under the third
   paragraph of section 11).

     However, if you cease all violation of this License, then your
   license from a particular copyright holder is reinstated (a)
   provisionally, unless and until the copyright holder explicitly and
   finally terminates your license, and (b) permanently, if the copyright
   holder fails to notify you of the violation by some reasonable means
   prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
   reinstated permanently if the copyright holder notifies you of the
   violation by some reasonable means, this is the first time you have
   received notice of violation of this License (for any work) from that
   copyright holder, and you cure the violation prior to 30 days after
   your receipt of the notice.

     Termination of your rights under this section does not terminate the
   licenses of parties who have received copies or rights from you under
   this License.  If your rights have been terminated and not permanently
   reinstated, you do not qualify to receive new licenses for the same
   material under section 10.

     9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
   run a copy of the Program.  Ancillary propagation of a covered work
   occurring solely as a consequence of using peer-to-peer transmission
   to receive a copy likewise does not require acceptance.  However,
   nothing other than this License grants you permission to propagate or
   modify any covered work.  These actions infringe copyright if you do
   not accept this License.  Therefore, by modifying or propagating a
   covered work, you indicate your acceptance of this License to do so.

     10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
   receives a license from the original licensors, to run, modify and
   propagate that work, subject to this License.  You are not responsible
   for enforcing compliance by third parties with this License.

     An "entity transaction" is a transaction transferring control of an
   organization, or substantially all assets of one, or subdividing an
   organization, or merging organizations.  If propagation of a covered
   work results from an entity transaction, each party to that
   transaction who receives a copy of the work also receives whatever
   licenses to the work the party's predecessor in interest had or could
   give under the previous paragraph, plus a right to possession of the
   Corresponding Source of the work from the predecessor in interest, if
   the predecessor has it or can get it with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
   rights granted or affirmed under this License.  For example, you may
   not impose a license fee, royalty, or other charge for exercise of
   rights granted under this License, and you may not initiate litigation
   (including a cross-claim or counterclaim in a lawsuit) alleging that
   any patent claim is infringed by making, using, selling, offering for
   sale, or importing the Program or any portion of it.

     11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
   License of the Program or a work on which the Program is based.  The
   work thus licensed is called the contributor's "contributor version".

     A contributor's "essential patent claims" are all patent claims
   owned or controlled by the contributor, whether already acquired or
   hereafter acquired, that would be infringed by some manner, permitted
   by this License, of making, using, or selling its contributor version,
   but do not include claims that would be infringed only as a
   consequence of further modification of the contributor version.  For
   purposes of this definition, "control" includes the right to grant
   patent sublicenses in a manner consistent with the requirements of
   this License.

     Each contributor grants you a non-exclusive, worldwide, royalty-free
   patent license under the contributor's essential patent claims, to
   make, use, sell, offer for sale, import and otherwise run, modify and
   propagate the contents of its contributor version.

     In the following three paragraphs, a "patent license" is any express
   agreement or commitment, however denominated, not to enforce a patent
   (such as an express permission to practice a patent or covenant not to
   sue for patent infringement).  To "grant" such a patent license to a
   party means to make such an agreement or commitment not to enforce a
   patent against the party.

     If you convey a covered work, knowingly relying on a patent license,
   and the Corresponding Source of the work is not available for anyone
   to copy, free of charge and under the terms of this License, through a
   publicly available network server or other readily accessible means,
   then you must either (1) cause the Corresponding Source to be so
   available, or (2) arrange to deprive yourself of the benefit of the
   patent license for this particular work, or (3) arrange, in a manner
   consistent with the requirements of this License, to extend the patent
   license to downstream recipients.  "Knowingly relying" means you have
   actual knowledge that, but for the patent license, your conveying the
   covered work in a country, or your recipient's use of the covered work
   in a country, would infringe one or more identifiable patents in that
   country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
   arrangement, you convey, or propagate by procuring conveyance of, a
   covered work, and grant a patent license to some of the parties
   receiving the covered work authorizing them to use, propagate, modify
   or convey a specific copy of the covered work, then the patent license
   you grant is automatically extended to all recipients of the covered
   work and works based on it.

     A patent license is "discriminatory" if it does not include within
   the scope of its coverage, prohibits the exercise of, or is
   conditioned on the non-exercise of one or more of the rights that are
   specifically granted under this License.  You may not convey a covered
   work if you are a party to an arrangement with a third party that is
   in the business of distributing software, under which you make payment
   to the third party based on the extent of your activity of conveying
   the work, and under which the third party grants, to any of the
   parties who would receive the covered work from you, a discriminatory
   patent license (a) in connection with copies of the covered work
   conveyed by you (or copies made from those copies), or (b) primarily
   for and in connection with specific products or compilations that
   contain the covered work, unless you entered into that arrangement,
   or that patent license was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
   any implied license or other defenses to infringement that may
   otherwise be available to you under applicable patent law.

     12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order, agreement or
   otherwise) that contradict the conditions of this License, they do not
   excuse you from the conditions of this License.  If you cannot convey a
   covered work so as to satisfy simultaneously your obligations under this
   License and any other pertinent obligations, then as a consequence you may
   not convey it at all.  For example, if you agree to terms that obligate you
   to collect a royalty for further conveying from those to whom you convey
   the Program, the only way you could satisfy both those terms and this
   License would be to refrain entirely from conveying the Program.

     13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
   permission to link or combine any covered work with a work licensed
   under version 3 of the GNU Affero General Public License into a single
   combined work, and to convey the resulting work.  The terms of this
   License will continue to apply to the part which is the covered work,
   but the special requirements of the GNU Affero General Public License,
   section 13, concerning interaction through a network will apply to the
   combination as such.

     14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new versions of
   the GNU General Public License from time to time.  Such new versions will
   be similar in spirit to the present version, but may differ in detail to
   address new problems or concerns.

     Each version is given a distinguishing version number.  If the
   Program specifies that a certain numbered version of the GNU General
   Public License "or any later version" applies to it, you have the
   option of following the terms and conditions either of that numbered
   version or of any later version published by the Free Software
   Foundation.  If the Program does not specify a version number of the
   GNU General Public License, you may choose any version ever published
   by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
   versions of the GNU General Public License can be used, that proxy's
   public statement of acceptance of a version permanently authorizes you
   to choose that version for the Program.

     Later license versions may give you additional or different
   permissions.  However, no additional obligations are imposed on any
   author or copyright holder as a result of your choosing to follow a
   later version.

     15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
   HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
   OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
   ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

     16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
   THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
   GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
   USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
   DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
   PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
   EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

     17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
   above cannot be given local legal effect according to their terms,
   reviewing courts shall apply local law that most closely approximates
   an absolute waiver of all civil liability in connection with the
   Program, unless a warranty or assumption of liability accompanies a
   copy of the Program in return for a fee.

			END OF TERMS AND CONDITIONS

	       How to Apply These Terms to Your New Programs

     If you develop a new program, and you want it to be of the greatest
   possible use to the public, the best way to achieve this is to make it
   free software which everyone can redistribute and change under these terms.

     To do so, attach the following notices to the program.  It is safest
   to attach them to the start of each source file to most effectively
   state the exclusion of warranty; and each file should have at least
   the "copyright" line and a pointer to where the full notice is found.

       <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>

       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Also add information on how to contact you by electronic and paper mail.

     If the program does terminal interaction, make it output a short
   notice like this when it starts in an interactive mode:

       <program>  Copyright (C) <year>  <name of author>
       This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
       This is free software, and you are welcome to redistribute it
       under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the appropriate
   parts of the General Public License.  Of course, your program's commands
   might be different; for a GUI interface, you would use an "about box".

     You should also get your employer (if you work as a programmer) or school,
   if any, to sign a "copyright disclaimer" for the program, if necessary.
   For more information on this, and how to apply and follow the GNU GPL, see
   <http://www.gnu.org/licenses/>.

     The GNU General Public License does not permit incorporating your program
   into proprietary programs.  If your program is a subroutine library, you
   may consider it more useful to permit linking proprietary applications with
   the library.  If this is what you want to do, use the GNU Lesser General
   Public License instead of this License.  But first, please read
   <http://www.gnu.org/philosophy/why-not-lgpl.html>.


.. seealso::

   * http://www.gnu.org/licenses/gpl.txt





.. _oespruce_chapter_intro:

********************************************************************************
Introduction
********************************************************************************

**OESpruce TK** provides functionalities to prepare biomolecules
(that is, proteins and nucleic acids) for modeling tasks.



.. _oespruce_part_releasenotes:

*****************************
Release History
*****************************

.. toctree::
   :maxdepth: 1

   version1_9_0
   version1_8_0
   version1_7_0
   version1_6_1
   version1_6_0
   version1_5_3
   version1_5_2
   version1_5_1
   version1_5_0
   version1_4_0
   version1_3_0
   version1_2_0
   version1_1_0
   version1_0_0
   version0_9_2
   version0_9_1
   version0_9_0



Spruce TK 0.9.0
================================================================================

New features
--------------------------------------------------------------------------------

**Spruce TK** has a limited API that is in a preliminary state until the
2018.Oct release.  The currently available classes in the API are
:ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>`,
:ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>`, and
:ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>`.  The currently available
functions are
``OEExtractBioUnitsFromRef`` and
``OEExtractBioUnitsFromPDBRemarks``.


Spruce TK 0.9.1
================================================================================

New features
--------------------------------------------------------------------------------

.. note::

   **Spruce TK** now requires a specific license. For information on **Spruce TK**
   licensing, please visit https://www.eyesopen.com/contact.

* The :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class can
  now use ligand constraints initialized in the
  :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` option class when handled by
  the following new methods:

  * :oe:meth:`OESpruce::OESuperpositionOptions::SetLigandConstraints`
  * :oe:meth:`OESpruce::OESuperpositionOptions::HasLigandConstraints`
  * :oe:meth:`OESpruce::OESuperpositionOptions::GetLigandConstraints`
  * :oe:meth:`OESpruce::OESuperpositionOptions::ClearLigandConstraints`

* New :oe:func:`OESpruce::OEExtractBioUnits` high-level functions have been added to
  extract biological assemblies, replacing the ``OEExtractBioUnitsFromRef``  and
  ``OEExtractBioUnitsFromPDBRemarks`` functions.

* The :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class now can be
  initialized with the :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` option class.

* The :oe:constns:`OESpruce::OESuperpositionType` namespace now contains an
  entry for the :oe:const:`SSE <OESpruce::OESuperpositionType::SSE>`
  superposition method. The default superpositioning method is now
  :oe:const:`OESpruce::OESuperpositionType::Global`.

* New :ref:`OESStructural Superposition Transform <OESpruce_OEStructuralSuperposition_Transform>`  and
  :ref:`OESecondaryStructureSuperposition Transform <OESpruce_OESecondaryStructureSuperposition_Transform>` methods
  have been added to transform a molecule based on superpositioning.

* New :ref:`OESStructural Superposition operator bool <OESpruce_OEStructuralSuperposition_Transform>`  and
  :ref:`OESecondaryStructureSuperposition operator bool <OESpruce_OESecondaryStructureSuperposition_operator_bool>` methods
  have been added to validate objects.

API changes
--------------------------------------------------------------------------------

* The constructor of the :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>` class
  has been changed.

* The low-level ``OEExtractBioUnitsFromRef`` and ``OEExtractBioUnitsFromPDBRemarks``
  functions have been removed.

Major bug fixes
--------------------------------------------------------------------------------

* A bug that caused an issue with extracting biological assemblies has been fixed
  in the low-level biological assembly factory class.

* Biological assembly extraction for large proteins has been improved for
  memory and CPU usage.

Minor bug fixes
--------------------------------------------------------------------------------

* Superposition methods for using :ref:`OETrans <OEChem_OETrans>` instead of
  raw double pointers for rotation matrices and translation vectors have been
  improved.

* A bug that caused an issue with extracting biological assemblies if they had a
  blank REMARK line in the PDB file has been fixed.


Spruce TK 0.9.2
================================================================================

* The product name in the license file for **Spruce TK** has been changed
  from ``spruce`` to ``sprucetk``.  This change does not impact the validity
  of current licenses, which will continue to work with this new version
  of the toolkit.  For more information on **Spruce TK** licensing,
  please visit https://www.eyesopen.com/contact.

* **Spruce TK** is still preliminary.

New features
--------------------------------------------------------------------------------

* A new predicate,  :ref:`OEIsModeledAtom <OESpruce_OEIsModeledAtom>`, has been added that identifies atoms built
  by the **Spruce TK** functions.
* A new function, :oe:func:`OESpruce::OEBuildSidechains`, has been added to build partial or
  missing sidechains of standard amino acid residues in a protein.
* A new method, :oe:func:`OESpruce::OECapCTermini`, has been added to cap the C-termini of a protein.
* A new method, :oe:func:`OESpruce::OECapNTermini`, has been added to cap the N-termini of a protein.
* A new method, :oe:func:`OESpruce::OECapTermini`,  has been added to cap both the N- and C-termini
  of a protein.
* A new method, :oe:func:`OESpruce::OEGetPartialResidues`, has been added to return a list of partial
  residues in a protein.
* A new method, :oe:func:`OESpruce::OEMutateResidue`, has been added to mutate a single residue in a protein.

Major bug fixes
--------------------------------------------------------------------------------

* A memory leak in the :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class
  has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* :oe:func:`OESpruce::OEExtractBioUnits` has been updated to better handle atoms
  placed on a symmetry axis.
* :oe:func:`OESpruce::OEExtractBioUnits` now more reliably assigns components to a
  biological unit (BU) even when they are far away.


.. _section_oespruce_releasenotes_100:

Spruce TK 1.0.0
================================================================================

New features
--------------------------------------------------------------------------------

* The :oe:func:`OESpruce::OEExtractBioUnits` function has become a stable API.
  The final implementation includes an options class, :ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>`,
  to control its behavior.

* A new function, :oe:func:`OESpruce::OEMakeDesignUnits`, has been added that generates
  :ref:`OEDesignUnit <OEBio_OEDesignUnit>` from structures read from PDB or mmCIF files.
  The function takes a number of options to control its behavior; therefore, the
  following options classes have been defined:

  * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>`: a high-level options class that
    holds the options classes below.

  * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>`: a high-level options class that
    holds other options classes, determining how a design unit is prepped.

  * :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>`: a low-level class that sets whether to build caps and
    missing sidechains.

  * :ref:`OEProtonateDesignUnitOptions <OESpruce_OEProtonateDesignUnitOptions>`: a low-level class that sets whether and how to
    protonate the design unit, including whether to generate tautomers.

  * :ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>`: a low-level class that determines how to handle
    alternate locations, how a system is split, locating the ligand, etc.

  The :oe:func:`OESpruce::OEMakeDesignUnits` function also takes the
  :ref:`OEStructureMetadata <OESpruce_OEStructureMetadata>` class as input. The
  :ref:`OEStructureMetadata <OESpruce_OEStructureMetadata>` class holds experimental data if known
  and can be used to indicate which is the ligand, what the sequence of the protein
  is, and other relevant pieces of information.

* The function :oe:func:`OESpruce::OEMakeDesignUnits` is a high-level function
  that works on the two intermediate functions, :oe:func:`OESpruce::OEMakeBioDesignUnits`
  and :oe:func:`OESpruce::OEEnumerateSites`, which can be run separately if intermediate
  results are desired. The high-level :oe:func:`OESpruce::OEMakeDesignUnits` function
  has a deduplication step built in; this function is highly recommended.

* A new function, :oe:func:`OESpruce::OEMakeDesignUnit`, has been added that creates an
  :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.

* A new function, :oe:func:`OESpruce::OEProtonateDesignUnit`, has been added that ensures that
  protons in an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` are optimized. The high-level function
  :oe:func:`OESpruce::OEMakeDesignUnits` calls this by default unless it is turned off in options.

* The :oe:func:`OESpruce::OEBuildSidechains` function has been updated to allow building
  all possible clusters even if one fails due to clashes.
  The function still returns ``false`` in this case.

Major bug fixes
--------------------------------------------------------------------------------

* An issue in the :oe:func:`OESpruce::OEExtractBioUnits` function that caused a segfault due
  to an improper PDB header format has been fixed.

* An issue in the alternate location expansion that left atoms on top
  of each other due to unconventional location definitions has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue with :oe:func:`OESpruce::OECapTermini` preventing caps from being
  built in some very specific instances has been fixed.

* :oe:func:`OESpruce::OEBuildSidechains` no longer
  builds sidechains on packing residues.

Documentation changes
--------------------------------------------------------------------------------

* A new example, :ref:`spruce_examples_make_design_units`, has been added that
  illustrates the usage of the high-level :oe:func:`OESpruce::OEMakeDesignUnits`
  function for biomolecular structure preparation. This example takes a PDB file
  as input and outputs a set of fully prepared :ref:`OEDesignUnit <OEBio_OEDesignUnit>` objects
  to a temporary file.

.. _section_oespruce_releasenotes_110:

Spruce TK 1.1.0
================================================================================

New features
--------------------------------------------------------------------------------

* Two new APIs,
  :oe:func:`OESpruce::OEBuildSingleLoop` and :oe:func:`OESpruce::OEBuildLoops`, have been added
  that provide loop modeling capability.
  This capability relies on either the SEQRES in the PDB header (or equivalent for
  MMCIF files) or the user passing metadata about the sequences. The functions
  take an options class, :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>`, as an argument
  to specify the file name of the required loop template database.
  This database is available for
  `download <http://www.eyesopen.com/db-downloads>`_
  in a platform-independent format.

* A new parameter, ``siteResidue``,  has been added to the
  :oe:func:`OESpruce::OEMakeDesignUnits` function. This allows users to specify a single
  residue in the binding site for APO structures when using the
  :oe:func:`OESpruce::OEEnumerateSites` function. The function checks whether the detected
  site has a large enough volume and whether there is anything in the binding site that the
  splitter failed to identify as a potential ligand.

* The options class :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>` has been updated to
  hold options classes for the different builder options available. This also changes
  the options class structure for :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>`.

* A new low level class, :ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>`, that determines behavior
  when building caps on proteins, has been added to replace passing different parameters to the functions :oe:func:`OESpruce::OECapTermini`,
  :oe:func:`OESpruce::OECapNTermini`, and :oe:func:`OESpruce::OECapCTermini`.

* :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>`, a low level class that determines
  the behavior when building sidechains on proteins, replaces passing different
  parameters to the function :oe:func:`OESpruce::OEBuildSidechains`.

* The preliminary API options class ``OEDesignUnitMutationOptions`` has been removed.
  :oe:func:`OESpruce::OEMutateResidues` has been added to take a map of mutations, along with
  :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` to control the behavior when building
  the mutated residue sidechain.

* A new function, :oe:func:`OESpruce::OEFixBackbone`, has been added that builds =O
  and/or OXT, if necessary, and ensures that all formal charges and valence states are
  correct on all backbone atoms. The function removes a residue completely if
  the primary backbone atoms, N, CA, and C, are missing. The residues can be built
  correctly later with :oe:func:`OESpruce::OEBuildLoops`.

* A strict protonation mode has been added to :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>`,
  enforcing that when an error occurs during addition and optimization of hydrogens to the system,
  the preparation processes now stop and fail.

* A new options class, :ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>`, has been added to
  :ref:`OEProtonateDesignUnitOptions <OESpruce_OEProtonateDesignUnitOptions>`.  This option allows users more control
  over the protonation processes; for example, by passing a bypass or no-flip predicate that
  will prevent the protonation process from altering the residues in the predicate.

* The design units produced by :oe:func:`OESpruce::OEMakeDesignUnits` are now ordered
  by the quality of the Iridium classification data.

Major bug fixes
--------------------------------------------------------------------------------

* A bug in :oe:func:`OESpruce::OEExtractBioUnits` that occurred when using a reference
  has been fixed. Previously, it resulted in incorrect biological units being produced
  under certain conditions. The algorithm has also been improved to more often produce
  the correct biological unit based on symmetry expansion.

Minor bug fixes
--------------------------------------------------------------------------------

* Metal co-factors previously had not been properly identified in the binding site during design
  unit generation due to the distance threshold from a ligand that was too strict. This has been fixed.

* Ligands with an incorrect alternate location assignment but that were in the same location
  were previously not correctly identified and were assigned alternate locations. This was due
  to the threshold being too strict and has been fixed.

* In cases where a residue is itself converted to a cap and where building a cap would
  result in the cap strongly clashing, the cap number no longer adds an insert code or
  alters the residue number. In addition, valence states resulting from the residue
  conversion are being more thoroughly validated and fixed, if necessary.

* Some instances of functions changing the location of the ``OEThrow`` output and their levels
  have been fixed.

* An issue in :oe:func:`OESpruce::OEExtractBioUnits` had previously occurred when structures
  with the historical convention of putting waters and metals into specific chain IDs
  (i.e., W and S, respectively) caused the molecules, after symmetry expansion, to
  have identical residue information.  This has been fixed.

* An issue with the side-chain builder miscounting side-chain atoms when involving a residue
  in cross-linking has been fixed.

* An issue that occurred when a single ligand atom (per design) was not properly detected as a
  ligand has been fixed.

Documentation changes
--------------------------------------------------------------------------------

* Documentation and examples have been modified to omit the step where alternate locations are
  collapsed. The function :oe:func:`OESpruce::OEMakeDesignUnits` handles alternate
  location collapse or enumeration and should provide all available data.

* Examples in C++ and Python have been enhanced to include passing electron
  density maps, and a new example has been added for making APO design units using
  a site residue or reference structure. The examples also illustrate how to enable
  **Spruce TK** to build missing loops.



Spruce TK 1.2.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------
* New methods have been added to :ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>`
  (:ref:`AddLipidCode  <OESpruce_OEDesignUnitSplitOptions_AddLipidCode>`,
  :ref:`SetLipidCodes  <OESpruce_OEDesignUnitSplitOptions_SetLipidCodes>`,
  :ref:`ClearLipidCodes  <OESpruce_OEDesignUnitSplitOptions_ClearLipidCodes>`, and
  :ref:`GetLipidCodes  <OESpruce_OEDesignUnitSplitOptions_GetLipidCodes>`).
  They allow users to specify the names of molecules to be
  considered as lipids.

* Support has been added for HEME and related cofactors in :ref:`OEMakeDesignUnits  <OESpruce_OEMakeDesignUnits>`. The state of HEME,
  contains two negatively charged nitrogens to balance the +2 Fe formal charge. The nitrogens coordinating
  the iron atom are indicated by zero-order bonds.

* A new function, :ref:`OEFindPockets <OESpruce_OEFindPockets>`, has been added that finds cavities in protein or nucleic acid complexes. The parameters
  for the search can be tuned with :ref:`OEPocketOptions <OESpruce_OEPocketOptions>`. The pockets are output as :ref:`OEPocket <OESpruce_OEPocket>` objects in an iterator.
  The function can take a predicate that will control only outputting pockets with a given set of residues or atoms in it. This function is also used in
  :ref:`OEMakeDesignUnits  <OESpruce_OEMakeDesignUnits>` when a site residue is provided.

* A new function, :ref:`OEMakeDesignUnitFromPocket  <OESpruce_OEMakeDesignUnitFromPocket>`, has been added that takes a prepared biological unit from
  an :ref:`OEMakeDesignUnit  <OESpruce_OEMakeDesignUnit>` and an :ref:`OEPocket <OESpruce_OEPocket>` and coverts it into an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
  does with a reference structure.

* New methods have been added in :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>`,
  :ref:`SetSeqAlignMethod  <OESpruce_OELoopBuilderOptions_SetSeqAlignMethod>`,
  :ref:`SetSeqAlignGapPenalty  <OESpruce_OELoopBuilderOptions_SetSeqAlignGapPenalty>`,
  :ref:`SetSeqAlignExtendPenalty  <OESpruce_OELoopBuilderOptions_SetSeqAlignExtendPenalty>`,
  :ref:`GetSeqAlignMethod  <OESpruce_OELoopBuilderOptions_GetSeqAlignMethod>`,
  :ref:`GetSeqAlignGapPenalty  <OESpruce_OELoopBuilderOptions_GetSeqAlignGapPenalty>`, and
  :ref:`GetSeqAlignExtendPenalty  <OESpruce_OELoopBuilderOptions_GetSeqAlignExtendPenalty>`
  that allow users to control the sequence alignment done to find gaps
  in protein structures related to loop modeling.

Major bug fixes
--------------------------------------------------------------------------------

* A bug that caused some modeled loops to be missing the backbone NH hydrogen where the modeled loops were attached has been fixed.

* Fragment numbers for build loops have been fixed to be consistent with the anchor residues where the loops are inserted.

* A bug in :ref:`OEFixBackbone  <OESpruce_OEFixBackbone>` has been fixed to ensure that OXT atoms are always built on C-terminal residues.

* An issue with atom order for built pieces like loops or caps has been fixed to ensure that these are sequential with the location they are built.

* A bug in :ref:`OEBuildLoops  <OESpruce_OEBuildLoops>` that in specific situations caused incorrect detection of gaps in protein
  structures has been fixed. Additionally, options have been exposed in :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>` to allows users
  to control the underlying sequence alignment in the event of a failure.

Minor bug fixes
--------------------------------------------------------------------------------
* Improvements have been made to standard amino acid residue perception when
  preparing structures.

* Site residues in :ref:`OEMakeDesignUnits  <OESpruce_OEMakeDesignUnits>` are now being checked against all
  the biological units so one can serve as a reference for the rest.

* A bug in loop modeling that caused the function to create residues with identical residue numbers
  has been fixed. The function now properly builds using insertion codes.

* A bug in loop modeling that caused problems for the underlying sequence alignment code and incorrect
  loops when a single residue was floating in space between two gaps has been fixed.

* The chemical component dictionary used internally in :ref:`OEMakeDesignUnits  <OESpruce_OEMakeDesignUnits>` has been updated with the
  latest changes from the RCSB, including some fixes for incorrect entries in the source data based on
  rules and literature searches.




Spruce TK 1.3.0
================================================================================

*July 2021*

New features
--------------------------------------------------------------------------------

* A molecule-based API for :ref:`OEMakeDesignUnitFromPocket <OESpruce_OEMakeDesignUnitFromPocket>` has been added.

* New high-level superposition APIs were added that unify the sequence-based
  (:ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>`) and shape-based
  (:ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>`) APIs. This includes a new
  :ref:`OESuperpose <OESpruce_OESuperpose>` class that can calculate different types of structural
  superposition, a new :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` class that allows the users
  to control various behaviors of the superposition calculation, such as the superposition 
  method, and a new :ref:`OESuperposeResults <OESpruce_OESuperposeResults>` class that holds the transformation
  and scores of the superposition. More detailed changes are as follows:

  * The new :ref:`OESuperpose <OESpruce_OESuperpose>` class can take either :ref:`OEMol <OEChem_OEMol>` or
    :ref:`OEDesignUnit <OEBio_OEDesignUnit>` as the reference for the fit molecule. The reference molecule can be
    set by using the :ref:`SetupRef <OESpruce_OESuperPose_SetupRef>` method, and the superposition can be
    calculated via :ref:`OESuperpose <OESpruce_OESuperpose_Superpose>` with the fit molecule
    supplied as one of its arguments.

  * A new :ref:`OESuperposeMethod <OESpruce_OESuperposeMethod>` namespace was added that contains the constants
    for different superposition methods. Functions :ref:`OEGetSuperposeMethodName <OESpruce_OEGetSuperposeMethodName>`
    and :ref:`OEGetSuperposeMethodFromName <OESpruce_OEGetSuperposeMethodFromName>` were added to obtain the superposition
    method's name (as a string literal) from its designated constant and vice versa.

  * Methods
    :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions_SetValidRMSD>`,
    :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions_SetValidSeqScore>`, and
    :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions_SetValidTanimoto>`
    have been added.  These methods can be used to set score thresholds for validating
    superposition results in the new
    :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` class. The validity of the superposition result can be obtained
    by :ref:`OESuperposeResults <OESpruce_OESuperposeResults_IsValid>` from the new :ref:`OESuperposeResults <OESpruce_OESuperposeResults>`
    class.

  * The new :ref:`OESuperpose <OESpruce_OESuperpose>` API returns an :ref:`OESuperposeResults <OESpruce_OESuperposeResults>` object
    that can be used to transform the fit molecule to its superposed position with its 
    :ref:`Transform <OESpruce_OESuperposeResults_Transform>` method. Alternatively, the users can use
    :ref:`GetRotMatrix <OESpruce_OESuperposeResults_GetRotMatrix>` and :ref:`GetTranslation <OESpruce_OESuperposeResults_GetTranslation>`
    to obtain the rotation matrix and translation vector, respectively, for their analyses. The RMSD and 
    sequence alignment score after the superposition can be obtained using :ref:`OESuperposeResults <OESpruce_OESuperposeResults>`'s
    :ref:`GetRMSD <OESpruce_OESuperposeResults_GetRMSD>` and :ref:`GetSeqScore <OESpruce_OESuperposeResults_GetSeqScore>` methods
    for sequence-based superpositions, and the Tanimoto score can be obtained using 
    :ref:`GetTanimoto <OESpruce_OESuperposeResults_GetTanimoto>`.

  Please refer to the documentation for more information on these new superposition APIs.

Minor bug fixes
--------------------------------------------------------------------------------

* A bug that caused the loop modeling algorithm to crash in rare instances has been fixed.

* Examples have been modified to use appropriate command-line arguments.

* An issue that caused style on :ref:`OEDesignUnit <OEBio_OEDesignUnit>` objects to disappear when
  calling :ref:`OEProtonateDesignUnit <OESpruce_OEProtonateDesignUnit>` has been fixed.

* An issue with the return value of superposition when two structures cannot be superposed has been fixed.
  It now properly returns a -1.00 RMSD.

* An issue in :ref:`OEMakeDesignUnitFromPocket <OESpruce_OEMakeDesignUnitFromPocket>` that caused style
  to remain on both the previous binding site and the one defined from the pocket
  has been fixed.

* A bug in superposition that resulted in a crash when using site residues
  that were not present on a design unit has been fixed.

* A bug that kept the insert code from its anchor residue when there was an N-terminal cap
  has been fixed.

Documentation changes
--------------------------------------------------------------------------------

* Documentation has been added for the Iridium classification. :ref:`Iridium. <chapter_sprucetk_iridium>`

* Documentation has been added for the new superposition APIs. Superposition 
  related APIs are now fully supported. :ref:`Superposition. <chapter_sprucetk_superposition>`


Spruce TK 1.4.0
================================================================================

*Fall 2021*

New features
--------------------------------------------------------------------------------

* A new method, :ref:`SetForceCapping <OESpruce_OECapBuilderOptions_SetForceCapping>`, has been added
  to enable capping even if it will result in a clash.

* Two new methods, :ref:`SetBuildTails <OESpruce_OELoopBuilderOptions_SetBuildTails>` and
  :ref:`GetBuildTails <OESpruce_OELoopBuilderOptions_GetBuildTails>`, have been added
  to set and get an option that
  controls whether to build tails when there is missing residues at the N- and C- termini.

* :ref:`SiteHopper <OESpruce_OESuperposeMethod_SiteHopper>` is now a supported superposition method in
  :ref:`OESuperpose <OESpruce_OESuperpose>`, and can be set using the SetMethod method of :ref:`OESuperpose <OESpruce_OESuperpose>`.

* All Options classes have been modified to derive from :ref:`OEOptions <OESystem_OEOptions>`. This affects classes:

  * :ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>`
  * :ref:`OEProtonateDesignUnitOptions <OESpruce_OEProtonateDesignUnitOptions>`
  * :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>`
  * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>`
  * :ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>`
  * :ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>`
  * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>`
  * :ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>`

Major bug fixes
--------------------------------------------------------------------------------

* An issue causing capping a nonstandard residue to fail has been fixed.

* An issue causing covalent ligands to have their covalent bond broken when
  there were alternate locations in the structure, has been fixed.

* An issue causing side-chains to either not be built or being built in
  non-optimal configurations has been fixed.

* An issue with pockets identifying liganded sites in
  :ref:`OEMakeDesignUnitFromPocket <OESpruce_oemakedesignunitfrompocket>` not generating a proper
  design unit with a ligand bound in the identified site has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue causing the warning message 'Truncated cap due to clash' to appear when
  :ref:`SetAllowTruncate <OESpruce_OECapBuilderOptions_SetAllowTruncate>` is `False` has been fixed.

* An issue caused by Heuristic score offset being added before comparing to original 
  structure therefore unable to pick the more energy favorable conformation has been fixed.

* An issue causing the gap finding code to mis-identify gaps in the protein 
  structure due to residues with missing backbone atoms has been fixed.
  The function now removes these residues prior to gap detection inside 
  :ref:`OEBuildLoops <OESpruce_OEBuildLoops>`.

* An issue caused by malformed ``PDB`` Header data, specifically with regards to
  REMARK 300 sections, has been fixed.





Spruce TK 1.5.0
================================================================================

New features
--------------------------------------------------------------------------------

* The new :ref:`OESpruceFilter <OESpruce_OESpruceFilter>` class has been added to provide checks and corrections on input to **Spruce**.
  For input it can take an :ref:`OEMolBase <OEChem_OEMolBase>`, :ref:`OEStructureMetadata <OESpruce_OEStructureMetadata>`,
  or an options class, :ref:`OESpruceFilterOptions <OESpruce_OESpruceFilterOptions>`, that holds the options to turn on each of the fixing options.

* The new :ref:`OEValidateDesignUnit <OESpruce_OEValidateDesignUnit>` class has been added for validation of **Spruce** produced design units.
  For input it can take an :ref:`OEDesignUnit <OEBio_OEDesignUnit>` or
  :ref:`OEStructureMetadata <OESpruce_OEStructureMetadata>`.

Major bug fixes
--------------------------------------------------------------------------------

* A bug that caused memory leaks in  **OEBio TK** has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue was fixed in :ref:`OEBuildLoops <OESpruce_OEBuildLoops>` to allow better
  sequence alignment for peptides. 
  
* An issue was fixed in :ref:`OEBuildLoops <OESpruce_OEBuildLoops>` where free amino acids,
  as co-factors or ligands, were incorrectly included in sequence alignments and
  causing mismatched alignments to the SEQRES.

* An issue was fixed in :ref:`OEExtractBioUnits <OESpruce_OEExtractBioUnits>` to be able to lower
  the minimum sequence alignment score threshold.





Spruce TK 1.5.1
================================================================================

New features
--------------------------------------------------------------------------------

* If a site residue is provided to :ref:`OEMakeDesignUnits <OESpruce_OEMakeDesignUnits>`, the
  output design unit title now includes the site residue in the title for apo structures.
  Previously, the residue in the title was the residue closest to the center of the binding site.

* Standardization using :ref:`Spruce Filter <OESpruce_OESpruceFilter>` now checks for metal chelation 
  before forming disulfide bridges.

Major bug fixes
--------------------------------------------------------------------------------
* An issue causing accumulation of generic data on the molecule components stored in
  the design unit object during prep has been fixed. This accumulation led to large memory consumption,
  slow preparation, and larger file size.




Spruce TK 1.5.2
================================================================================

New features
--------------------------------------------------------------------------------
* :ref:`OESpruceFilterOptions <OESpruce_OESpruceFilterOptions>` has an option 
  to automatically assign chain IDs (default is true) when they are missing 
  either completely or partially in the structure for a structure processed 
  by :ref:`OESpruceFilter <OESpruce_OESpruceFilter>`.

* The built-in heterogen database has been updated with the latest structures
  from the ligand-expo at the RCSB.

Major bug fixes
--------------------------------------------------------------------------------

* An issue where tautomers passed using metadata were not respected has been fixed.

* An issue has been fixed where, in a small fraction of cases, an OXT atom was
  not correctly built out when needed at the protein C-terminals.

* An issue has been fixed where the option to fix the state of backbone atoms and bonds
  in :ref:`OESpruceFilterOptions <OESpruce_OESpruceFilterOptions>` was sometimes not respected
  in :ref:`OESpruceFilter <OESpruce_OESpruceFilter>`, which led to issues such as OXT
  atoms being built even if the option was disabled.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue was fixed in filter options to not accept the disallowed
  residue names UNL and UNK. Instead, they are renamed to LIG, which is a change
  filter that applies in the structure upon standardization.

* An issue where the maximum number of atoms in the biological unit
  was not being respected has been fixed.

Documentation changes
--------------------------------------------------------------------------------

* Minor documentation and example improvements have been fixed.


Spruce TK 1.5.3
================================================================================

New features
--------------------------------------------------------------------------------

* The chemical components dictionary was updated with latest data from the RCSB.

Major bug fixes
--------------------------------------------------------------------------------

* An issue that caused :ref:`OESpruceFilter <OESpruce_OESpruceFilter>` to segfault has been fixed and safeguarded.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue  has been fixed that caused incorrectly built loops when the protein structure contains
  nonstandard amino acids, particularly in the gap needing to be built or anchoring to it.

* An issue with sequence mutation for cysteine residues, where an explicit hydrogen was left
  over after the mutation, has been fixed.




Spruce TK 1.6.0
================================================================================

New features
--------------------------------------------------------------------------------

* The chemical components dictionary has been updated with latest structures from
  the wwPDB.

* A feature has been added to :ref:`OEProtonateDesignUnit <OESpruce_OEProtonateDesignUnit>` to detect
  acceptor–acceptor clashes, modify the protonation state of one of the moieties,
  and reoptimize the hydrogen bond network.

* The following preliminary API classes have been made permanent.

  * :ref:`OECapBuilderOptions<OESpruce_OECapBuilderOptions>`
  * :ref:`OELoopBuilderOptions<OESpruce_OELoopBuilderOptions>`
  * :ref:`OEPocket<OESpruce_OEPocket>`
  * :ref:`OEPocketOptions<OESpruce_OEPocketOptions>`
  * :ref:`OESidechainBuilderOptions<OESpruce_OESidechainBuilderOptions>`
  * :ref:`OESpruceFilter<OESpruce_OESpruceFilter>`
  * :ref:`OESpruceFilterOptions<OESpruce_OESpruceFilterOptions>`
  * :ref:`OEValidateDesignUnit<OESpruce_OEValidateDesignUnit>`

* The following preliminary API functions have been made permanent.

  * :ref:`OEBuildLoops<OESpruce_OEBuildLoops>`
  * :ref:`OEBuildSingleLoop<OESpruce_OEBuildSingleLoop>`
  * :ref:`OEFindPockets<OESpruce_OEFindPockets>`
  * :ref:`OEMakeDesignUnitFromPocket<OESpruce_OEMakeDesignUnitFromPocket>`

Major bug fixes
--------------------------------------------------------------------------------

* A crash in :ref:`OESpruceFilter <OESpruce_OESpruceFilter>` has been fixed in relation
  to atoms that were cleaned up during the standardization process.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue has been fixed that ensures radii are assigned to all atoms in a design unit.

Documentation changes
--------------------------------------------------------------------------------

* An example has been added showing how to convert FASTA files to structure metadata
  for structures missing the SEQRES information in the PDB metadata and MMCIF equivalent.


..  _section_sprucetk_releasenotes_1611:

Spruce TK 1.6.1.1
================================================================================

Major bug fixes
--------------------------------------------------------------------------------

*   An issue has been fixed where :ref:`OEExtractBioUnits <OESpruce_OEExtractBioUnits>` function
    would fail if there was a mismatch in author assigned chain names and PDB assigned chain names
    in the case where a molecule was extracted from an mmCIF file.

*   An issue was fixed in :ref:`OEProtonateDesignUnit <OESpruce_OEProtonateDesignUnit>` where a rule to flip clashing
    in-plane hydrogens on double bonded nitrogens was triggering incorrectly in specific instances.
    

Spruce TK 1.6.1
================================================================================

New features
--------------------------------------------------------------------------------

*   :ref:`OEBuildSidechains <OESpruce_OEBuildSideChains>` now minimizes target side chains by default. Minimization can
    be controlled by setting :ref:`minimizeSidechains <OESpruce_OESidechainBuilderOptions_SetMinimizeSidechains>` and
    :ref:`minimizeSidechainsShell <OESpruce_OESidechainBuilderOptions_SetMinimizeSidechainsShell>`
    options in the :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class.

*   A feature has been added to support a next generation mmCIF feature, such that when an mmCIF
    file provides a connectivity record for the heterogens, **Spruce** will no longer look
    up the heterogen in the Chemical Component Dictionary but trust the input provided.

*   A feature has been added that allows in-plane flipping of a single hydrogen on a double bonded nitrogen,
    when a clash is detected as part of hydrogen bond network optimization.

Major bug fixes
--------------------------------------------------------------------------------

*   An issue has been fixed related to using the :ref:`OEHeterogenMetadata <OESpruce_OEHeterogenMetadata>` class, where
    the provided SMILES string was
    not respected for tautomer generation; when tautomers were not provided; and when the title (residue name)
    collided with existing residue names in the stored Chemical Component Dictionary.

*   An issue has been fixed related to covalently bound ligands, where the pre-reaction input SMILES and related tautomers
    were not adjusted properly when accounting for the formed covalent bond.

*   An issue has been fixed where the **Spruce** filter deleted single (disconnected) amino acid residues
    when they were marked HETATMs and were not real "floating" residues in part of the regular protein sequence.

Minor bug fixes
--------------------------------------------------------------------------------

*   :ref:`OEMutateResidues <OESpruce_OEMutateResidues>`,
    :ref:`OEMutateResidue <OESpruce_OEMutateResidue>`,
    and :ref:`OEBuildSidechains <OESpruce_OEBuildSideChains>` now reduce failures arising from
    clashes by using shell minimization by default.

*   An issue has been fixed that caused HEME-like molecules to be excluded from
    the stored chemical component database.

Documentation changes
--------------------------------------------------------------------------------

*   Information has been added about setting and getting minimizeSidechains and minimizeSidechainsShell
    options in the :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class.



Spruce TK 1.7.0
================================================================================

New Features
--------------------------------------------------------------------------------

*  The functions :ref:`OEMakeDesignUnit <OESpruce_OEMakeDesignUnit>` and :ref:`OEMakeBioDesignUnits <OESpruce_OEMakeBioDesignUnits>` will now use provided
   `OEHeterogenMetadata` in `OEStructureMetadata` as information for the splitting 
   of a structure into a design unit, including such details as which parts should be considered cofactors.

Major Bug Fixes
--------------------------------------------------------------------------------

*  An issue has been fixed that caused charge and radii assignment to not happen, in paths
   where **Spruce** was also not allowed to protonate the structure.

*  An issue has been fixed that caused radii to not be properly assigned to all atoms in the design unit.

Minor Bug Fixes
--------------------------------------------------------------------------------

*  An issue has been fixed which caused some mmCIF files to not be able to be
   prepared due to lack of missing metadata.

*  An issue has been fixed where :ref:`OEMutateResidues <OESpruce_OEMutateResidues>` would crash if the structure contained
   the N-terminal capping group `NME`.



Spruce TK 1.8.0
================================================================================

New Features
--------------------------------------------------------------------------------

*  The function :ref:`OEBuildSingleLoop <OESpruce_OEBuildSingleLoop>` now checks for
   loop clashes after minimization. The option can be set using
   :ref:`SetRejectClashingLoopsPostMinimization <OESpruce_OELoopBuilderOptions_SetRejectClashingLoopsPostMinimization>`.

*  The function :ref:`OEBuildSingleLoop <OESpruce_OEBuildSingleLoop>` can now delete
   residues already present at sites where a new loop needs to be built. The option can be set using
   :ref:`SetDeleteExistingResidues <OESpruce_OELoopBuilderOptions_SetDeleteExistingResidues>`.

*  The function :ref:`OEBuildSidechains <OESpruce_OEBuildSidechains>` can now partially
   build target residues in the event that some targets fail.

*  Improved loop modeling has been added involving disulfide bridge creation by adding a bond length check.

*  When running with :ref:`SetFixResStates <OESpruce_OESpruceFilterOptions_SetFixResStates>` set to True, if the input molecule contains
   CIF header data, the filter will utilize the chemical component header section to inform
   a residue's bond order and subsequent formal charge.

*  A new method, :ref:`SetUseSeqScoreChainMatching <OESpruce_OESuperposeOptions_SetUseSeqScoreChainMatching>`, has been
   added to :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` which, when enabled, optimizes the sequence score over the
   overall RMSD when matching on multiple protein chains.

Major Bug Fixes
--------------------------------------------------------------------------------

*  An issue has been fixed where gaps in the protein structure were misidentified due to
   unconventional insert code usage.

Minor Bug Fixes
--------------------------------------------------------------------------------

*  Loop modeling results have been improved by setting
   :ref:`OELoopBuilderOptions StrictProlineMatch <OESpruce_OELoopBuilderOptions_GetStrictProlineMatch>`
   to ``False`` by default. The updated default is due to an improved side chain building routine
   in a prior toolkit release.

*  An issue has been fixed to ensure loops extracted from the loop database had the desired structural properties.

*  When truncating a residue or converting a residue to a capping group,
   if that residue had a crosslink bond, the residue opposite would retain an atom in a bad valence state.
   That issue has been fixed.

*  An issue has been fixed in the routine to reassign ambiguous water and metals
   from packing residues to the protein chain of interest. The issue caused HEME-analogs and connected amino acids
   to be soaked into a given chain ID.

*  An issue has been fixed causing loop-relevant information with insert codes in an mmCIF header to be incorrectly read.

*  The :ref:`OECapCTermini <OESpruce_OECapCTermini>`, :ref:`OECapNTermini <OESpruce_OECapNTermini>`,
   and :ref:`OECapTermini <OESpruce_OECapTermini>`
   functions address an issue that could result in an incorrectly labeled cap residue SequenceID.

*  Several improvements were made to address performance issues in the :ref:`OESpruceFilter <OESpruce_OESpruceFilter>`.

Documentation Changes
--------------------------------------------------------------------------------

* Several examples have been added, and the advanced protein preparation tutorial has been expanded.



Spruce TK 1.9.0
================================================================================

New Features
--------------------------------------------------------------------------------
* The maximum cluster size for partial residues built using :ref:`OEBuildSidechains <OESpruce_OEBuildSidechains>` can 
  now be set in :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>`
  using :ref:`SetMaxClusterSize <OESpruce_OESidechainBuilderOptions_SetMaxClusterSize>`.

* The chemical component dictionary has been updated. However, if using mmCIF, the metadata will
  be used as primary information and the dictionary only engages if metadata is unavailable.

Minor Bug Fixes
--------------------------------------------------------------------------------

* An issue has been fixed in the routine to reassign ambiguous water and metals
  from packing residues to the protein chain of interest. The issue caused HEME analogs and connected amino acids
  to be soaked into a given chain ID.

* An issue has been fixed to allow :oe:cls:`OESpruce::OEHeterogenMetadata` to inform
  the component splitter during design unit generation and preparation. This also fixes an
  issue where the splitter would not allow reclassification of a metal ion to an excipient.

* An issue has been fixed that caused the option to collapse redundant alternate locations
  to improperly engage if there were multiple binding sites in a protein.

* An issue has been fixed that caused the option to collapse redundant alternate locations
  to improperly engage for different ligands in the same binding site.

* An issue has been fixed that caused :oe:func:`OESpruce::OEMutateResidues` to incorrectly
  leave the backbone nitrogen of a residue in a bad valence state when mutating from Proline.

* An issue has been fixed in :oe:func:`OESpruce::OEBuildSidechains` with the shell mutation option turned
  on that would leave side chains clashing with water molecules. The water molecules are now removed
  if the option to allow for removal of clashing waters is set to ``True``.


###############################################
Appendix: Additional Examples in Python
###############################################

These are full listings of programming examples that are offered for download, elsewhere in this chapter.
:ref:`See the guide to programming examples earlier in this chapter<oespruce_part_examples>`

..  _listing-du2mmcif.py:

..  oe:source:: du2mmcif.py
    :language: python
    :noindent:
    :caption: du2mmcif.py full listing.
    :refnum: 1

..  _listing-add_receptor_obj_to_du.py:

..  oe:source:: add_receptor_obj_to_du.py
    :language: python
    :noindent:
    :caption: add_receptor_obj_to_du.py full listing.
    :refnum: 2

..  _listing-extract_biounits_ref.py:

..  oe:source:: extract_biounits_ref.py
    :language: python
    :noindent:
    :caption: extract_biounits_ref.py full listing.
    :refnum: 3

..  _listing-extract_biounits_remarks.py:

..  oe:source:: extract_biounits_remarks.py
    :language: python
    :noindent:
    :caption: extract_biounits_remarks.py full listing.
    :refnum: 4

..  _listing-findpockets.py:

..  oe:source:: findpockets.py
    :language: python
    :noindent:
    :caption: findpockets.py full listing.
    :refnum: 5

..  _listing-make_apo_design_units.py:

..  oe:source:: make_apo_design_units.py
    :language: python
    :noindent:
    :caption: make_apo_design_units.py full listing.
    :refnum: 6

..  _listing-make_design_unit_using_metadata.py:

..  oe:source:: make_design_unit_using_metadata.py
    :language: python
    :noindent:
    :caption: make_design_unit_using_metadata.py full listing.
    :refnum: 7

..  _listing-make_design_units.py:

..  oe:source:: make_design_units.py
    :language: python
    :noindent:
    :caption: make_design_units.py full listing.
    :refnum: 8

..  _listing-fasta_to_structmeta.py:

..  oe:source:: fasta_to_structmeta.py
    :language: python
    :noindent:
    :caption: fasta_to_structmeta.py full listing.
    :refnum: 9

..  _listing-superpose.py:

..  oe:source:: superpose.py
    :language: python
    :noindent:
    :caption: superpose.py full listing.
    :refnum: 10

..  _listing-validate_design_unit.py:

..  oe:source:: validate_design_unit.py
    :language: python
    :noindent:
    :caption: validate_design_unit.py full listing.
    :refnum: 11



.. _spruce_chapter_examples:

*************************
Spruce TK Examples
*************************

The following table lists the currently available **Spruce TK** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`make_design_units<spruce_examples_make_design_units>`
        - Constructing design units from a PDB (due to loop modeling, this example takes ~10 min)
      * - :ref:`make_apo_design_units<spruce_examples_make_apo_design_units>`
        - Constructing apo design units from a PDB using a site residue input (due to loop modeling, this example takes ~10 min)
      * - :ref:`superposition<spruce_examples_superposition>`
        - Superposition of two proteins
      * - :ref:`extract_biounits_remarks<spruce_examples_extract_biounits_remarks>`
        - Extract biounits from PDB header remarks
      * - :ref:`extract_biounits_ref<spruce_examples_extract_biounits_ref>`
        - Extract biounits from a sequence alignment to a reference protein
      * - :ref:`findpockets<spruce_examples_find_pockets>`
        - Find pockets and some of their properties from a protein or uesign unit
      * - :ref:`convert_du_to_mmcif<spruce_examples_du2mmcif>`
        - Writing DU to MMCIF file
      * - :ref:`write_metadata_json_file<spruce_examples_metadata>`
        - Writing a metadata JSON file from a FASTA file
        

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`make_design_units.py<spruce_examples_make_design_units>`
        - Constructing design units from a PDB (due to loop modeling, this example takes ~10 min)
      * - :ref:`make_apo_design_units<spruce_examples_make_apo_design_units>`
        - Constructing apo design units from a PDB using a site residue input (due to loop modeling, this example takes ~10 min)
      * - :ref:`du2mmcif.py <spruce_examples_du2mmcif>`
        - Write an output MMCIF file from a Spruce generated design unit
      * - :ref:`superpose.py<spruce_examples_superposition>`
        - Superposition of two proteins
      * - :ref:`extract_biounits_remarks.py<spruce_examples_extract_biounits_remarks>`
        - Extract biounits from PDB header remarks
      * - :ref:`extract_biounits_ref.py<spruce_examples_extract_biounits_ref>`
        - Extract biounits from a sequence alignment to a reference protein
      * - :ref:`findpockets.py<spruce_examples_find_pockets>`
        - Find pockets and some of its properties from a protein or design unit
      * - :ref:`convert_du_to_mmcif<spruce_examples_du2mmcif>`
        - Writing DU to MMCIF file
      * - :ref:`write_metadata_json_file<spruce_examples_metadata>`
        - Writing a metadata JSON file from a FASTA file
      * - :ref:`validate_design_unit<spruce_examples_validate_design_unit>`
        - Validate structure of the design unit
      * - :ref:`add_receptor_obj_to_du<spruce_examples_add_receptor_to_du>`
        - Add receptor grid to design unit
      * - :ref:`make_design_unit_using_metadata<spruce_examples_make_design_units_using_metadata>`
        - Constructing design units from a PDB using metadata to specify ligand and tautomer state

**Examples:**

.. toctree::
   :maxdepth: 1

   examples_make_design_units
   examples_make_apo_design_units
   examples_du2mmcif
   examples_superposition
   examples_extract_biounits_remarks
   examples_extract_biounits_ref
   examples_find_pockets
   examples_metadata
   examples_validate_design_unit
   examples_add_receptor_to_du
   examples_make_design_unit_with_metadata

.. |Angstrom|  replace:: Ångström

.. |Angstroms| replace:: Ångströms

.. |A|         replace:: Å

.. |Huckel|    replace:: Hückel

.. |Kekule|    replace:: Kekulé

.. |OpenEye|   replace:: *OpenEye, Cadence Molecular Sciences*

.. |PRELIMINARY-API| replace:: This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

.. |PRELIMINARY-CONSTANTS| replace:: These constants are preliminary and may be improved based on user feedback.

.. |TWOLANGUAGE| replace:: This API is currently available in C++ and Python.

.. |CPPONLY| replace:: This functionality is only available in the C++ toolkits. For other languages, we recommend using language-specific functionality instead.

.. |PYTHONONLY| replace:: This functionality is only available in the Python toolkits.

.. |NOPDFIMAGE| replace:: *There is no image available for the PDF version of this book.*

.. |DEPRECATED-API| replace:: This is a deprecated API.

.. |SUBWORKING| replace:: Substitutions are working!



.. _oespruce_part_theory:

.. toctree::
   :maxdepth: 2

   theory/theory
   theory/iridium
   theory/advanced_prep_example


.. _sprucetk_prep_advanced_example:

################################################
Advanced Macromolecular Preparation Workflow
################################################

This example provides a walk-through of the steps taken by **SPRUCE** to go from an asymmetric unit of an X-ray crystallography experiment
to a model-ready design unit.
The system being prepared is a structure of the DNA gyrase using the PDB code: `5CDO <https://www.rcsb.org/structure/5cdo>`_.

An example script to create a :ref:`OEDesignUnit <OEBio_OEDesignUnit>` can be found at

.. admonition:: Code Example

   * :ref:`spruce_examples_make_design_units`

.. seealso::

   * :ref:`Spruce Theory <sprucetk_theory>` documentation

=======================================
Inputs
=======================================

The data required for **Spruce** to prepare a macromolecular system is:

* A structure file: preferably MMCIF but PDB is also supported.

   * We recommend reading the files using the SpruceDefault read flavors for these file formats.
     See more in this example: :ref:`How to Correctly Read a PDB File <spruce_read_pdb_section>`.

   * SSBOND and LINK records are read. If the bonds that are read pass some sanity checks, they are
     applied to the structure if not automatically perceived by the molecule reader.

* Metadata about the sequence and any bound small molecules (heterogens).
  This can be provided in the metadata/header sections of PDB or MMCIF files.
  Alternatively, the information can be provided using :oe:cls:`OESpruce::OEStructureMetadata`
  for applications and floes, the content of which can be stored in a JSON file format.
  The metadata required is:

   * Experimental and space group information
      * CRYST1
      * EXPDAT

   * Title information
      * HEADER

   * Revision information
      * REVDAT
   
   * Biological unit information
      * REMARK 300
      * REMARK 350

   * Sequence information (using the PDB metadata notation; equivalent keys in MMCIF are also considered)
      * SEQRES
      * SEQADV
      * DBREF, DBREF1/DBREF2
      * MODRES

   * Refinement information to be used for Iridium classification
      * EXPDTA
      * REMARK 3 (if available)

In the example walk-through here, all of the metadata is contained in the PDB file.
However, we will use a custom metadata file for the heterogen to
augment the bond order and valence states of one of the heterogens.
Heterogen information can be provided using the :oe:cls:`OESpruce::OEHeterogenMetadata` class
within the :oe:cls:`OESpruce::OEStructureMetadata` class.

   * Heterogen information
      * Title/residue name, such as ATP
      * Optionally a corporate ID, such as OE123456
      * SMILES, used for automated tautomer generation with OEQuacpac :oe:func:`OEProton::OEGetReasonableTautomers` function
      * A list of tautomers if the user wants to provide externally generated tautomers.

=======================================
Filtering and Standardization
=======================================

:oe:func:`OESpruce::OESpruceFilter` performs a standardization and a filter check before preparing this structure (:ref:`OESpruce_OESpruceFilterOptions`), which includes:

* Fixing backbone atom states :oe:func:`OESpruce::OEFixBackbone`
* Fixing bonds to metal
* Checking electron density overlap
* Checking sequence alignment
* Reordering the atoms into PDB order :oe:func:`OEChem::OEPDBOrderAtoms`
* Including standard residue perception for PDB files and Chem Comp residue perception for CIF files
* Fixing invalid covalent bonds
* Fixing problematic residue namespace
* Fixing chain IDs

Preparation for 5CDO builds missing OXT atoms when fixing the backbone:

.. code-block::

    Debug: Built missing OXT atom in backbone of terminal residue LEU 490   A 1
    Debug: Built missing OXT atom in backbone of terminal residue LEU 490   C 3
    Debug: Built missing OXT atom in backbone of terminal residue LEU 490   R 7
    Debug: Built missing OXT atom in backbone of terminal residue LEU 490   T 9

    Debug: Built missing OXT atom in backbone of terminal residue VAL 638   B 2
    Debug: Built missing OXT atom in backbone of terminal residue VAL 638   D 4
    Debug: Built missing OXT atom in backbone of terminal residue VAL 638   S 8

    Debug: Built missing OXT atom in backbone of terminal residue ARG 252   R 7
    Debug: Built missing OXT atom in backbone of terminal residue ALA 637   U 10

========================================
Generating the Biological Unit
========================================

Generation of biological units from asymmetric units is done by reading the 
_pdbx_struct_assembly, _pdbx_struct_assembly_gen, and _pdbx_struct_oper_list
categories in the MMCIF file.

The asymmetric unit contains two biological units as noted in the MMCIF header:

.. code-block::
  :caption: MMCIF format

  loop_
  _pdbx_struct_assembly.id 
  _pdbx_struct_assembly.details 
  _pdbx_struct_assembly.method_details 
  _pdbx_struct_assembly.oligomeric_details 
  _pdbx_struct_assembly.oligomeric_count 
  1 author_defined_assembly ? hexameric 6 
  2 author_defined_assembly ? hexameric 6 

In the case of the PDB file, generation of biological units from asymmetric units
is done by reading the REMARK 300 and 350 in the header.

.. code-block:: 
  :caption: PDB format

  REMARK 300 BIOMOLECULE: 1, 2                                                    
  REMARK 300 SEE REMARK 350 FOR THE AUTHOR PROVIDED AND/OR PROGRAM                
  REMARK 300 GENERATED ASSEMBLY INFORMATION FOR THE STRUCTURE IN                  
  REMARK 300 THIS ENTRY. THE REMARK MAY ALSO PROVIDE INFORMATION ON               
  REMARK 300 BURIED SURFACE AREA.  
                        

By default, **Spruce** uses the author-generated remarks and prefers them over the software-generated remarks.
Generating the biological unit from the asymmetric unit can take various forms,
including symmetry operations to generate the correct biological form specified.

In the event the end user knows the biological unit of interest, and it is different from the
author- or software-provided one, a reference structure can be provided that will
be used along with the space group information to generate the desired biological unit(s). 

Read more in the :ref:`Biological Unit <spruce_bio_unit_section>` section and the toolkit API :oe:func:`OESpruce::OEExtractBioUnits`.

In this specific case, the biological units are generated by splitting the asymmetric unit.

.. code-block::
  :caption: MMCIF format

  loop_
  _pdbx_struct_assembly_gen.assembly_id 
  _pdbx_struct_assembly_gen.oper_expression 
  _pdbx_struct_assembly_gen.asym_id_list 
  1 1 A,B,C,D,E,F,M,N,O,P,Q,R,S,T,U,V,W,HA,IA,JA,KA,LA,MA      
  2 1 G,H,I,J,K,L,X,Y,Z,AA,BA,CA,DA,EA,FA,GA,NA,OA,PA,QA,RA,SA 
  # 
  _pdbx_struct_oper_list.id                   1 
  _pdbx_struct_oper_list.type                 'identity operation' 
  _pdbx_struct_oper_list.name                 1_555 
  _pdbx_struct_oper_list.symmetry_operation   x,y,z 
  _pdbx_struct_oper_list.matrix[1][1]         1.0000000000 
  _pdbx_struct_oper_list.matrix[1][2]         0.0000000000 
  _pdbx_struct_oper_list.matrix[1][3]         0.0000000000 
  _pdbx_struct_oper_list.vector[1]            0.0000000000 
  _pdbx_struct_oper_list.matrix[2][1]         0.0000000000 
  _pdbx_struct_oper_list.matrix[2][2]         1.0000000000 
  _pdbx_struct_oper_list.matrix[2][3]         0.0000000000 
  _pdbx_struct_oper_list.vector[2]            0.0000000000 
  _pdbx_struct_oper_list.matrix[3][1]         0.0000000000 
  _pdbx_struct_oper_list.matrix[3][2]         0.0000000000 
  _pdbx_struct_oper_list.matrix[3][3]         1.0000000000 
  _pdbx_struct_oper_list.vector[3]            0.0000000000 

.. code-block::
  :caption: PDB format

  REMARK 350 COORDINATES FOR A COMPLETE MULTIMER REPRESENTING THE KNOWN           
  REMARK 350 BIOLOGICALLY SIGNIFICANT OLIGOMERIZATION STATE OF THE                
  REMARK 350 MOLECULE CAN BE GENERATED BY APPLYING BIOMT TRANSFORMATIONS          
  REMARK 350 GIVEN BELOW.  BOTH NONCRYSTALLOGRAPHIC AND
  REMARK 350 CRYSTALLOGRAPHIC OPERATIONS ARE GIVEN.                               
  REMARK 350                                                                      
  REMARK 350 BIOMOLECULE: 1                                                       
  REMARK 350 AUTHOR DETERMINED BIOLOGICAL UNIT: HEXAMERIC                         
  REMARK 350 APPLY THE FOLLOWING TO CHAINS: A, B, C, D, E, F                      
  REMARK 350   BIOMT1   1  1.000000  0.000000  0.000000        0.00000            
  REMARK 350   BIOMT2   1  0.000000  1.000000  0.000000        0.00000            
  REMARK 350   BIOMT3   1  0.000000  0.000000  1.000000        0.00000            
  REMARK 350                                                                      
  REMARK 350 BIOMOLECULE: 2                                                       
  REMARK 350 AUTHOR DETERMINED BIOLOGICAL UNIT: HEXAMERIC                         
  REMARK 350 APPLY THE FOLLOWING TO CHAINS: R, S, T, U, V, W                      
  REMARK 350   BIOMT1   1  1.000000  0.000000  0.000000        0.00000            
  REMARK 350   BIOMT2   1  0.000000  1.000000  0.000000        0.00000            
  REMARK 350   BIOMT3   1  0.000000  0.000000  1.000000        0.00000            

Now we have two biological units one with chains A, B, C, D, E, F, and the other with chains R, S, T, U, V, W.

========================================
Generating Packing Residues
========================================

Packing residues are by default generated by using the crystallographic information to build the crystal lattice 
around each biological unit and extracting the potentially relevant pieces close to the biological unit.
The packing residues are included in the :oe:cls:`OEBio::OEDesignUnit` object for visualization, and they 
are also used in determination of the :ref:`Iridium category <chapter_sprucetk_iridium>` for a given biological unit.

========================================
Enumerating Alternate Locations
========================================

By default, **SPRUCE** enumerates all alternate locations.
It has two behaviors, one pairing all A locations together, all B locations together, and so on, and another where
it picks the primary alternate location based on occupancy and mixes and matches in each alternate location cluster. See
the :oe:cls:`OEBio::OEAltLocationFactory` class.

In this specific case, there are three residues with alternate locations, two in chain A and one in chain R. Since each of
these chains are in separate biological units, an A and a B form are generated for each of the biological units.

.. code-block::
  :caption: MMCIF format
  
  ATOM   1302  N  N      A ARG A  1  84  ? 39.022  -34.720 51.558  0.50 28.55  ? 92   ARG A N      1 
  ATOM   1303  N  N      B ARG A  1  84  ? 39.030  -34.712 51.565  0.50 28.56  ? 92   ARG A N      1 
  ...
  ATOM   4046  N  N      A ARG A  1  264 ? 34.135  -51.092 43.755  0.50 46.45  ? 272  ARG A N      1 
  ATOM   4047  N  N      B ARG A  1  264 ? 34.162  -51.078 43.762  0.50 46.44  ? 272  ARG A N      1 
  ...
  ATOM   23895 N  N      A ARG G  1  114 ? 70.262  -22.784 -8.389  0.50 30.89  ? 122  ARG R N      1 
  ATOM   23896 N  N      B ARG G  1  114 ? 70.284  -22.755 -8.432  0.50 30.91  ? 122  ARG R N      1
  ...

.. code-block::
  :caption: PDB format

  ATOM   1302  N  AARG A  92      39.022 -34.720  51.558  0.50 28.55           N  
  ATOM   1303  N  BARG A  92      39.030 -34.712  51.565  0.50 28.56           N  
  ...
  ATOM   4046  N  AARG A 272      34.135 -51.092  43.755  0.50 46.45           N  
  ATOM   4047  N  BARG A 272      34.162 -51.078  43.762  0.50 46.44           N  
  ...
  ATOM  23901  N  AARG R 122      70.262 -22.784  -8.389  0.50 30.89           N  
  ATOM  23902  N  BARG R 122      70.284 -22.755  -8.432  0.50 30.91           N  
  ...

.. figure:: ../images/AlternateLocations.png
   :width: 65%
   :align: center
   :alt: *Alternate Locations*

   **Figure 1.** Alternate locations A and B of Arg 92 and 272 in chain A.

========================================
Componentizing the System
========================================

**Spruce** next splits the system into components. It does so for various reasons, but mainly to make it easier
for end users and downstream applications to extract the relevant parts for modeling. An example
would be to exclude excipients when doing subsequent modeling.

The available list of components can be found in the :oe:constns:`OEBio::OEDesignUnitComponents` namespace.

There are several control parameters for ligand detection. The default parameters generally
work very well, but sometimes will need user intervention.

In this specific instance, we focus on the biological unit composed of chains A, B, C, D, E, F.
The components being filled are:

* protein
* nucleic
* solvent
* metals
* counter_ions
* packing_residues
* excipients
* other_ligands

.. figure:: /_images/BioComponentization.png
   :width: 65%
   :align: center
   :alt: *Biological Unit Components*

   **Figure 2.** Initial componentization of the biological unit.

The A and B forms of the alternate location enumeration are componentized identically.
The unit comprised of chains R, S, T, U, V, W is componentized similarly, but that is not always the case. 

.. note::
  There are no binding sites, ligands, or cofactors assigned at this stage. That is done at a later stage when
  sites in the system are enumerated (:ref:`spruce_enumerate_sites_pockets`). The potential ligands and cofactors are stored in the
  other_ligands and metals components for the time being; there can also be an other_cofactors component,
  depending on the nature of the cofactors.

========================================
Building Missing Pieces
========================================

**Spruce** will attempt to build missing pieces that were not observed in the experimental record.

.. note::
   
  Built residues are styled with a specific color scheme, making built items easy to see in 3D.

--------------------------------------------
Building Missing Side Chains
--------------------------------------------

For the biological unit comprising of chains A, B, C, D, E, F, there were 31 residues that were missing side chains.
**Spruce** builds these using built-in rotamer libraries :oe:constns:`OEBio::OERotamerLibrary` and :oe:func:`OESpruce::OEBuildSidechains`.

.. code-block::

  Debug:    Residue: ILE 9   A 1   
  Debug:    Residue: GLU 11   A 1   
  Debug:    Residue: ARG 231   A 1   
  Debug:    Residue: ARG 258   A 1   
  Debug:    Residue: LYS 284   A 1   
  Debug:    Residue: ARG 299   A 1   
  Debug:    Residue: LYS 310   A 1   
  Debug:    Residue: ASP 311   A 1   
  Debug:    Residue: LYS 405   A 1   
  Debug:    Residue: GLN 413   A 1   
  Debug:    Residue: LYS 416   A 1   
  Debug:    Residue: LEU 490   A 1   
  Debug:    Residue: LYS 417   B 2   
  Debug:    Residue: LYS 424   B 2   
  Debug:    Residue: ARG 450   B 2   
  Debug:    Residue: LYS 581   B 2   
  Debug:    Residue: LYS 607   B 2   
  Debug:    Residue: ARG 12   C 3   
  Debug:    Residue: ASP 311   C 3   
  Debug:    Residue: LYS 405   C 3   
  Debug:    Residue: GLN 413   C 3   
  Debug:    Residue: LYS 416   C 3   
  Debug:    Residue: GLU 447   C 3   
  Debug:    Residue: GLU 475   C 3   
  Debug:    Residue: LYS 424   D 4   
  Debug:    Residue: ARG 450   D 4   
  Debug:    Residue: LYS 497   D 4   
  Debug:    Residue: GLU 585   D 4   
  Debug:    Residue: ASN 587   D 4   
  Debug:    Residue: GLU 593   D 4   
  Debug:    Residue: LYS 607   D 4   

Every built side chain is optimized after being built; in cases where multiple side chains need to
be built near each other, they are optimized as a cluster. By default, **Spruce** will delete water molecules
clashing with built side chains, because it is believed that the water positions are likely not correct but an
artifact of missing the side chain during crystallographic refinement.

..  code-block::

    Warning: No rotamer of residue: LYS 497   D 4   passed a clash test. Will check again after minimization

For the Lysine residue 497 in chain D, no known rotamer would fit the local environment, but **Spruce** is able to find
a proper configuration using minimization. In this case, the backbone configuration is not ideal, but a configuration
is found that works. It is expected that some backbone rearrangement would happen during a whole system minimization
and molecular dynamics simulation.

.. figure:: /_images/BuiltLys497D.png
   :width: 65%
   :align: center
   :alt: *Lys 497 in chain D*

   **Figure 3.** Built side chain of LYS 497 in chain D.

.. seealso::
  * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class

--------------------------------------------
Building Missing Loops and Tails
--------------------------------------------
**Spruce** uses a knowledge-based loop database to fill in missing gaps; see :ref:`the LoopDBBuilder overview <loopdb_builder_overview>` for more information.
It uses the SEQRES or sequence data provided using :oe:cls:`OESpruce::OEStructureMetadata` to
compare the structure to the known sequence.
The knowledge-based database currently allows building of loops up to 20 residues in length.
For example, in chain R:

.. code-block::

   Debug: Gap detection sequence alignment:
   chainR  -NERNITSEMRESFLDYAMSVIVARALPDVRDGLKPVHRRILYGLNEQGM 49
           |||||||||||||||||||||||||||||||||||||||||||||||||
   chain   INERNITSEMRESFLDYAMSVIVARALPDVRDGLKPVHRRILYGLNEQGM 50

   chainR  TPDKSYKKSARIVGDVMGKYHPHGDSSIYEAMVRMAQDFSYRYPLVDGQG 99
           ||||||||||||||||||||||||||||||||||||||||||||||||||
   chain   TPDKSYKKSARIVGDVMGKYHPHGDSSIYEAMVRMAQDFSYRYPLVDGQG 100

   chainR  NFGSMDGDGAAAMRXTEARMTKITLELLRDINKDTIDFIDNYDGNEREPS 149
           ||||||||||||||||||||||||||||||||||||||||||||||||||
   chain   NFGSMDGDGAAAMRXTEARMTKITLELLRDINKDTIDFIDNYDGNEREPS 150

   chainR  VLPARFPNLLANGASGIAVGMATNIPPHNLTELINGVLSLSKNPDISIAE 199
           ||||||||||||||||||||||||||||||||||||||||||||||||||
   chain   VLPARFPNLLANGASGIAVGMATNIPPHNLTELINGVLSLSKNPDISIAE 200

   chainR  LMEDIEGPDFPTAGLILGKSGIRRAYETGRGSIQMRSRAVIEER----QR 245
           ||||||||||||||||||||||||||||||||||||||||||||    ||
   chain   LMEDIEGPDFPTAGLILGKSGIRRAYETGRGSIQMRSRAVIEERGGGRQR 250

   chainR  IVVTEIPFQVNKARMIEKIAELVRDKKIDGITDLRDETSLRTGVRVVIDV 295
           ||||||||||||||||||||||||||||||||||||||||||||||||||
   chain   IVVTEIPFQVNKARMIEKIAELVRDKKIDGITDLRDETSLRTGVRVVIDV 300

   chainR  RKDANASVILNNLYKQTPLQTSFGVNMIALVNGRPKLINLKEALVHYLEH 345
           ||||||||||||||||||||||||||||||||||||||||||||||||||
   chain   RKDANASVILNNLYKQTPLQTSFGVNMIALVNGRPKLINLKEALVHYLEH 350

   chainR  QKTVVRRRTQYNLRKAKDRAHILEGLRIALDHIDEIISTIRESDTDKVAM 395
           ||||||||||||||||||||||||||||||||||||||||||||||||||
   chain   QKTVVRRRTQYNLRKAKDRAHILEGLRIALDHIDEIISTIRESDTDKVAM 400

   chainR  ESLQQRFKLSEKQAQAILDMRLRRLTGLERDKIEAEYNELLNYISELETI 445
           ||||||||||||||||||||||||||||||||||||||||||||||||||
   chain   ESLQQRFKLSEKQAQAILDMRLRRLTGLERDKIEAEYNELLNYISELETI 450

   chainR  LADEEVLLQLVRDELTEIRDRFGDDRRTEIQL 477
           ||||||||||||||||||||||||||||||||
   chain   LADEEVLLQLVRDELTEIRDRFGDDRRTEIQL 482

   Found unresolved N-terminal with 1 residues before ASN 10   R 7  , with sequence 'I'
   Found 4 residue gap between ARG 252   R 7   and GLN 257   R 7  , with sequence 'GGGR'

As the log summarizes for chain R, a residue was missing at the N-terminal of the protein, and
a 4-residue gap was found with the sequence GGGR between residues 252 and 257.

Terminal residues or "tails" are not built by default, partly because the build
time for long tails can be significant as the problem is less constrained than a missing gap in the middle of the protein.

When multiple loops need to be built in a structure, **Spruce** builds the shortest ones first, as they are more
geometrically constrained, to avoid a scenario where a loop cannot be built due to the construction of another.

When building a loop, **Spruce** crops a piece of the existing protein (by default, one residue on either side of the gap)
and builds a slightly longer loop. This is in part to avoid the scenario where the anchoring residues are 
in a bad configuration as a result of crystallographic refinement with missing residues.

.. figure:: /_images/BuiltGGGRLoop.png
   :width: 65%
   :align: center
   :alt: *Built loop between Arg 252 nd Gln 257 in chain R*

   **Figure 4.** Built loop between Arg 252 and Gln 257 in chain R.

.. seealso::
  * :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>` class
  * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class
  * :oe:constns:`OEBio::OERotamerLibrary` namespace
  * :ref:`OEStructureMetadata <OESpruce_OEStructureMetadata>` class

--------------------------------------------
Building Capping Groups
--------------------------------------------

If, for some reason, a missing loop/gap could not be built, **Spruce** adds acetyl (ACE) and N-methyl (NME)
capping groups to the terminal residues to avoid having artificial formal charges on the structure.
It will, however, not add capping groups to the true biological termini as they are expected to be charged
at neutral pH. The information about the true terminals is derived from the SEQRES or provided sequence metadata,
similar to the loop.

When building a cap, if the capping group for any reason clashes with other parts of the system (not waters),
the residue being capped is instead converted into a capping group. This is to avoid building a system with
clashes. The behavior can be modified if desired.

.. note::

  An N-terminal capping group (ACE) is numbered with N-1 to the residue it is capping.

  A C-terminal capping group (NME) retains the residue number of the residue it is capping, but an insert code is indented.
  This is to avoid capping groups and ligands or other features having the same residue number, as it is standard practice to
  number heterogens following the protein chain using the same chain ID. 

.. seealso::

  * :oe:func:`OESpruce::OECapTermini`
  * :ref:`OEStructureMetadata <OESpruce_OEStructureMetadata>` class

========================================
Optimizing the Hydrogen Bond Network
========================================

**Spruce** optimizes the hydrogen bond network by adding explicit hydrogens and resolving clashes particularly around
the binding site. The process considers the protonation and tautomer states of the components to produce
an optimized protein–ligand complex. A specific tautomer state can be provided as part of metadata if it needs to
be enforced.

.. figure:: /_images/ligandWithTautomer.png
   :width: 65%
   :align: center
   :alt: *Tautomer Metadata*

   **Figure 5.** Ligand tautomer state without specified tautomer state (*left*) and with a specified tautomer (C[C@@H]1C[N@@]2c3ccc(cc3CC4([C@H]2[C@@H](O1)C)C(=NC(=O)N=C4O)O)N(=O)=O, *right*).

.. seealso::
  * :ref:`spruce_examples_make_design_units_using_metadata`
  * :ref:`section_place_hydrogens`
  * :oe:func:`OEBio::OEPlaceHydrogens`
  * :oe:func:`OESpruce::OEProtonateDesignUnit`

========================================
Assignment on Radii and Partial Charges
========================================

For more information about the assignment of partial charges to the entire system, please see :ref:`OEDesignUnitCharges <OEProton_OEDesignUnitCharges>`.
By default, charges are assigned as follows:

* Standard protein residues: :ref:`OEAmberFF94Charges <OEProton_OEAmberFF94Charges>`
* Nonstandard protein residues: :ref:`OEAM1BCCCharges <OEProton_OEAM1BCCCharges>`
* Nucleic acids: :ref:`OEMMFF94Charges <OEProton_OEMMFF94Charges>`
* Ligands and or any other heterogens in the system (e.g., cofactors): :ref:`OEAM1BCCCharges <OEProton_OEAM1BCCCharges>`
* Solvent: uses the **SZMAP** water model
* Excipients: :ref:`OEMMFF94Charges <OEProton_OEMMFF94Charges>`

========================================
Prepared Biological Units (BioDUs)
========================================

The above-mentioned stages transformed an asymmetric unit to a biological unit, which was
then componentized to generate a prepared biological unit (BioDU).

.. _spruce_enumerate_sites_pockets:

==============================================
Enumerating Sites / Pockets
==============================================

This is the final stage of creating a design unit from a prepared biological unit.

As was noted in the earlier section, there were two potential ligands found and componentized into the other_ligands category.
When ligands are detected, **Spruce** will take the prepared biological unit and generate a design unit for each binding site.

The design unit will now have a binding site defined, and specific styling will be applied to the system.
As part of the process, the ligand bound in that binding site will be promoted from the other_ligand category
to the ligand category, and cofactors, either from other_cofactors or metals, will be moved to the cofactors category.
If a ligand is present, interaction hints are also encoded and stored in the design unit. For more information, see :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>`.

In the case here, there were two biological units. In the biological units with:

* chains A, B, C, D, E, and F, there were two ligands 53L and 53M.
* chains R, S, T, U, V, and W, there were two ligands 50M and 53M.

Therefore, for each biological unit, two design units were generated.
Note that since there were both an A and a B alternate location form of each biological unit,
there are really eight design units in the end.

#. 5CDO(ABCDEF)altA > 53L(F-2101)
#. 5CDO(ABCDEF)altB > 53L(F-2101)
#. 5CDO(ABCDEF)altA > 53M(E-2101)
#. 5CDO(ABCDEF)altB > 53M(E-2101)
#. 5CDO(RSTUVW)altA > 50M(S-6002)
#. 5CDO(RSTUVW)altB > 50M(S-6002)
#. 5CDO(RSTUVW)altA > 53M(W-2101)
#. 5CDO(RSTUVW)altB > 53M(W-2101)

If a ligand was not present, the :oe:cls:`OESpruce::OEFindPockets` algorithm will be employed to attempt to detect potential
binding sites. If multiple sites are found, the BioDU will be enumerated into a DU for each detected site.

========================================
Assigning an Iridium Category
========================================

The Iridium [Warren-2012]_ categorization process itself is well explained in the :ref:`Iridium section <chapter_sprucetk_iridium>`,
but in short, the Iridium categorization can be used to select between different protein structures if multiple are available
for a given target, and also in the event that multiple design units are generated from a single experimental structure.
The Iridium category and derived information is stored in :ref:`OEIridiumData <OEBio_OEIridiumData>`.

In the case here, the enumeration from a single structure file to eight design units gives a little perspective on why
this filtering step can be necessary.

There are design units for three different ligands here: 50M, 53M, 53L.

.. code-block::

   5CDO(ABCDEF)altA > 53L(F-2101), Iridium Category: MT, LaD: 0.85, ASaD: 0.88, DPI: 0.47, POL: false, POAS: false, AltConfs: false, PackRes: false, Excp: false, IrrRFree: false, PossCov: false
   5CDO(ABCDEF)altB > 53L(F-2101), Iridium Category: MT, LaD: 0.85, ASaD: 0.88, DPI: 0.47, POL: false, POAS: false, AltConfs: false, PackRes: false, Excp: false, IrrRFree: false, PossCov: false

   5CDO(RSTUVW)altA > 50M(S-6002), Iridium Category: MT, LaD: 0.85, ASaD: 0.86, DPI: 0.47, POL: false, POAS: false, AltConfs: false, PackRes: false, Excp: false, IrrRFree: false, PossCov: false
   5CDO(RSTUVW)altB > 50M(S-6002), Iridium Category: MT, LaD: 0.85, ASaD: 0.86, DPI: 0.47, POL: false, POAS: false, AltConfs: false, PackRes: false, Excp: false, IrrRFree: false, PossCov: false

For 50M and 53L, there are two forms due to alternate locations for each. 
The scores are identical and in this case either form is likely okay to use.

.. code-block::

   5CDO(ABCDEF)altA > 53M(E-2101), Iridium Category: MT, LaD: 0.81, ASaD: 0.85, DPI: 0.47, POL: false, POAS: false, AltConfs: false, PackRes: false, Excp: false, IrrRFree: false, PossCov: false
   5CDO(ABCDEF)altB > 53M(E-2101), Iridium Category: MT, LaD: 0.81, ASaD: 0.85, DPI: 0.47, POL: false, POAS: false, AltConfs: false, PackRes: false, Excp: false, IrrRFree: false, PossCov: false
   5CDO(RSTUVW)altA > 53M(W-2101), Iridium Category: MT, LaD: 0.74, ASaD: 0.88, DPI: 0.47, POL: false, POAS: false, AltConfs: false, PackRes: false, Excp: false, IrrRFree: false, PossCov: false
   5CDO(RSTUVW)altB > 53M(W-2101), Iridium Category: MT, LaD: 0.74, ASaD: 0.88, DPI: 0.47, POL: false, POAS: false, AltConfs: false, PackRes: false, Excp: false, IrrRFree: false, PossCov: false

For 53M, there are four forms: two resulting from different biological units (chains),
and two of each of those resulting from alternate locations. The alternate locations forms
have identical scores and do not differentiate the forms.
However, for the two biological units, the Iridium information is very different even if their
overall scores are both MT. In particular, the fraction of ligand atoms covered by the experimental density
is 0.81 versus 0.74, and the fraction of active site residue atoms covered by density
is 0.85 versus 0.88. In this case, it will likely take a modeler or crystallographer
to decide which is the better pose, and in some cases, both should be used for proper modeling.

.. figure:: /_images/ligandDensityFigure.png
   :width: 65%
   :align: center
   :alt: *Ligand Density Difference*

   **Figure 6.** Experimental density and ligand overlap for the two biological units.

========================================
Generating a Docking Receptor
========================================

The toolkit does not automatically generate a docking receptor, but the **SPRUCE** application and floe both generate a
docking grid using default settings with the :oe:func:`OEDocking::OEMakeReceptor` function.
The receptor can later be modified or regenerated with the toolkit or the **Make Receptor** application if a more custom
approach is desired.

==============================================
Superposition to a Common Frame of Reference
==============================================

**Spruce** is able to superpose molecules and design units onto a common reference
frame using :oe:cls:`OESpruce::OESuperpose`.
If a common reference structure is provided, all generated design units will be superposed to that reference structure.
If a common reference structure is not provided, but each design unit generated is similar to each other (same protein, same binding site),
**Spruce** will superpose those similar units onto each other.

=======================
Design Unit Validation
=======================

**Spruce** validates the design unit using :oe:func:`OESpruce::OEValidateDesignUnit`. It looks for partial side chains, partial charges,
implicit hydrogens, incorrect terminal residues, heavy atom overlap, and broken chains.

.. _chapter_sprucetk_iridium:

############
Iridium
############

Iridium [Warren-2012]_ is a metric used to estimate the model quality of a structure resulting from an X-ray crystallography
experiment. The metric evaluates what we deem essential considerations for using protein–ligand structures
in drug discovery, particularly virtual screening.

The metric was developed by aggregating previously published docking validation sets, evaluating each of them by eye, and even re-refining
some of the data. The high quality structures were then deposited into a new dataset called Iridium HT [Warren-2012]_.

The metric takes a number of parameters into account and categorizes structures into four different categories,
grading their trustworthiness to use in modeling.

* HT - Highly Trustworthy
* MT - Mildly Trustworthy
* NT - Not Trustworthy
* NA - Not Applicable

The fourth category is used when no electron density data is available, or when the structure being evaluated
is not coming from an X-ray crystallography experiment. Electron density data is available for at least 85% of the public
PDB data and is required for all new depositions. Historical data is also being recovered, so that percentage is
only expected to increase.

.. note::

   Regarding applicability:

   * Iridium is not currently an appropriate metric for electron microscopy (EM) experiments, in part because the contour level,
     which we use as 1 sigma in X-ray experiments, is determined on a per experiment basis, and also in part due to different
     diffraction behavior of heavy atoms compared to the X-ray.

   * Iridium is not currently an appropriate metric for neutron diffraction experiments, due to the
     different diffraction behavior for heavy atoms (e.g., sulfur and phosphorus are largely invisible in neutron diffraction data).

   * Iridium relies on a bound ligand and is therefore not appropriate for apo structures.

.. _section_sprucetk_iridium_categorization:

Categorization
----------------

The initial Iridium categorization was done by eye. The rules developed were then formalized to be able to rigorously assess
the Iridium category on every X-ray structure. In some cases, the original publication is not explicit about threshold values,
but the metric below follows the paper in spirit and is approved by the original authors. The outcome of formalizing the rules
resulted in minor category discrepancies on the published dataset and is likely due to the more stringent adherence to the rules.

The criteria to consider include both global and local quality metrics and are as follows (the acronyms in parentheses are used
when **Spruce** logs the Iridium details):

* DPI - The diffraction-component precision index or global precision estimate [Cruickshank-1999]_
* Rfree value
* Crystallographic resolution
* Density coverage of the ligand heavy atoms (LaD)
* Density coverage of the active site residue heavy atoms (including cofactors) (ASaD)
* Occupancy of ligand heavy atoms (POL)
* Occupancy of active site heavy atoms (POAS)
* Alternate locations of the ligand (AltConfs)
* Alternate locations of the active site residues  (AltConfs)
* Presence of crystal packing residues near binding site (PackRes)
* Presence of excipients near binding site (Excp)
* Whether ligand is potentially covalently bound, but the covalent bond is not properly perceived (PossCov)

First, the initial consideration is based on the density coverage of the ligand and the active site residues.

.. list-table::
   :widths: 100 100 100 100

   * -
     - HT
     - MT
     - NT

   * - Ligand
     - > 0.90
     - < 0.90 and > 0.50
     - < 0.50

   * - Active Site
     - > 0.95
     - < 0.95 and > 0.50
     - < 0.50

Subsequently, a structure can be demoted from HT to MT if any of the conditions below are true:

* DPI > 0.50
* Presence of alternate locations of the ligand or the active site residues
* Any ligand heavy atoms with an occupancy < 0.90
* Any active site heavy atoms with an occupancy < 0.50
* Perception of interactions between packing residues and the ligand using :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` with default settings.
* Perception of interactions between any excipient and the ligand using :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` with default settings.
* Perception of unperceived covalent interactions of the ligand in the active site using :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` with default settings.

Furthermore, any structure will be demoted to NT if the Rfree value is larger than 0.45 and the resolution is below 3.5A,
as we consider that an irrational Rfree value (IrrRFree).

.. note::

   Not all structures report a DPI, and in such cases it is calculated using :oe:func:`OEBio::OECalculateDPI`.

.. seealso::

   * :ref:`OEIridiumData <OEBio_OEIridiumData>` class
   * :oe:func:`OEBio::OECalculateDPI` class
   * :oe:func:`OEGrapheme::OEDrawIridiumData` function in **Grapheme TK** to visualize :ref:`OEIridiumData <OEBio_OEIridiumData>`


.. _sprucetk_theory:

############
Theory
############

**Spruce TK** is used to process PDB or mmCIF files containing the macromolecular structures, resulting from
X-ray crystallography, Nuclear Magnetic Resonance (NMR) spectroscopy, or electron microscopy (EM) experiments
into molecules usable for molecular modeling. Due to the nature of the experiments and data, some processing
is required before use in modeling, such as adding explicit hydrogens and building pieces that were unobserved
in the experimental data, yet required to properly simulate the system.

**Spruce TK** provides a complete preparation workflow to prepare macrocomolecular structures for modeling.
Various options are available to control for desired behaviors. Additional metadata can be provided, along with
the structural data to improve perception of small molecule (heterogen) *bondage and valence* states, as well 
as protein sequence information (if it is not in the structure file already).

.. _spruce_definitions_section:

********************
Brief Definitions
********************

In order to fully interpret **Spruce TK**, it is important to first identify some terms. Very brief definitions are
provided in this section, followed by more detailed explanations below.

#. :ref:`Asymmetric Unit (ASU) <spruce_asym_unit_section>`: The contents of a PDB or mmCIF file from X-ray crystallography
   containing an asymmetric unit as the output of the experiment. 

#. :ref:`Biological Unit (BU) <spruce_bio_unit_section>`: Also know as a biological assembly, this is the biologically relevant
   unit for a protein to use in modeling. For example, the BU is a monomer in Trypsin, but in HIV Protease
   it is a homo-dimer. 

#. :ref:`Bio Design Unit (BioDU) <spruce_bio_design_unit_section>`: This is a prepared biological unit. This is the 
   result of the **Spruce** preparation from the extracted BU. It is a fully prepared macromolecular system, but a ligand
   and associated binding site have not yet been identified. A Bio Design Unit (:ref:`BioDU <OESpruce_oemakebiodesignunits>`)
   is considered an intermediate work product of the final design unit. 

#. :ref:`Design Unit (DU) <spruce_design_unit_section>`: As the name indicates, this is an object used for structure-based drug
   design. It is a specific instance of a BioDU, where a binding site has 
   been identified. If a ligand is present in that binding site, it has been moved into the ligand component; similarly, the cofactor
   component has been filled in if any are present in the binding site. This data structure can also have an OEReceptor stored on it
   for the purposes of docking calculations. 
   Most OpenEye tools use DUs rather than BioDUs, as they utilize the binding site and bound ligand information.

#. **Alternate locations (alt locs)**: X-ray experiments often contain results
   with atoms occupying more than one configuration (alt location). Crystallographers denote this with
   a measure of the amount of time an atom occupies a given set of coordinates.
   A well-resolved atom will have an occupancy of 1.0, meaning that 100% of the time
   it is in that location. Sometimes, however, the atom exists in two positions—alternate
   locations—and these appear in the input file with single letter designations and
   with occupancy < 1.0. Alternate locations are by default enumerated (but only primary
   can be selected). When these are enumerated, the generated design units will be checked to see
   if there are alternate locations in the binding site; if not, they are deduplicated at the end of the preparation
   workflow (this behavior can be turned off). This is to reduce the number of design units generated for a single input file.

.. note::

   For more information about these, there are two worked examples: 
   :ref:`the simple example <spruce_examples_make_design_units>`
   and a more :ref:`advanced example <sprucetk_prep_advanced_example>`.

.. _spruce_asym_unit_section:

*******************************
Asymmetric Unit
*******************************

The asymmetric unit (ASU) is the smallest piece of a crystal structure to which symmetry operations can be applied in order
to generate a complete unit cell (the crystal repeating unit). It contains the unique part of a crystal structure [Zardecki-2022]_.
The ASU may be equivalent to the BU, but often requires manipulation to create a correct BU. **Spruce TK** can be used to
expand the AU to the BU. The data structure is stored in an :oe:cls:`OEChem::OEMolBase`.

.. _spruce_bio_unit_section:

*****************
Biological Unit
*****************

In short, the biological unit (BU) is an object that contains the biologically relevant parts of an
ASU that have not been split into various molecular components and are not yet prepped for modeling.
It is the quaternary structure of a protein that is believed to be the main
functional form of the molecule. It can be a single chain or a collection of multiple chains.
The BU may include more than one functional form if it can change under different conditions.
The data structure is stored in an :oe:cls:`OEChem::OEMolBase`.

For a more detailed explanation of BUs, refer to the `Introduction to Biological Assemblies and the PDB Archive <https://pdb101.rcsb.org/learn/guide-to-understanding-pdb-data/biological-assemblies>`_.

A BU can be constructed from a single macromolecular structure file, from the metadata, or by using a sequence
alignment to an input reference structure. To extract a BU or set of BUs from an asymmetric unit, one should use the helper
function in **Spruce TK** called :oe:func:`OESpruce::OEExtractBioUnits`. The following example shows
how to extract BUs from the metadata.

.. oe:source:: extract_biounits_remarks.cpp
   :language: c++
   :frag:     SNIPPET-OEExtractBioUnits-REMARKS

.. oe:source:: extract_biounits_remarks.py
   :language: python
   :frag:     SNIPPET-OEExtractBioUnits-REMARKS

Using the same function, one can also extract BUs from an asymmetric unit using an input reference protein. The following example shows
how to use :oe:func:`OESpruce::OEExtractBioUnits` to extract BUs from a given reference.

.. oe:source:: extract_biounits_ref.cpp
   :language: c++
   :frag:     SNIPPET-OEExtractBioUnits-REF

.. oe:source:: extract_biounits_ref.py
   :language: python
   :frag:     SNIPPET-OEExtractBioUnits-REF

.. _spruce_bio_design_unit_section:

**********************************
Biological Design Unit (BioDU)
**********************************

**Spruce** extracts and prepares parts of a single BU to create BioDUs. A biological design unit (:ref:`BioDU <OESpruce_oemakebiodesignunits>`)
is a fully prepared macromolecular system considered ready for modeling (generally considered Molecular Dynamics ready). Heterogen components
are componentized into other_ligands, other_cofactors, counter_ions, metals, and so on. Thus, it has all the information required to generate a
design unit, but is not yet focused on a specific binding site and as such does not contain receptor grids required for docking or other actions.
The BioDU has limited usage, as most OpenEye tools require binding sites and their related information.
The data structure is stored in an :oe:cls:`OEBio::OEDesignUnit`.

BioDUs are only applicable when a user does not need or want a binding site. The primary uses are:

*  :ref:`Cryptic Pocket Detection Floes Package <cryptic_documentation>`
*  :ref:`Plain Molecular Dynamics Floe <floe_PlainMolecularDynamics[MDRun]>`
*  :ref:`Solvate and Run MD Floe <floe_SolvateandRunMD[MDPrep][MDRun]>`

.. _spruce_design_unit_section:

*****************
Design Unit
*****************

Design unit (DU) is an idea first discussed by Pfizer [Gehlhaar-2022]_. The :oe:cls:`OEBio::OEDesignUnit` class is a technical term
for a specific data structure created to capture all the information in a macromolecular system and is unique to OpenEye. 
An OEDesignUnit file format is an oedu.

A DU is a specific instance of a BioDU. It is binding site focused. One BioDU may yield several DUs if there are multiple
binding sites. If there are multiple ligands in a BioDU, each will include its own information related to the binding site.

A DU includes among other components:

#. A protein and/or nucleic acid
#. Site residues
#. A bound ligand in the binding site (if present, otherwise apo)
#. Cofactors in the binding site
#. Packing residues (if any exist near the site)
#. Excipients (if any exist near the site)

One can interact with each part of the DU through APIs, which are listed under :oe:cls:`OEBio::OEDesignUnit`.

*******************************
Spruce TK Preparation Workflow
*******************************

**Spruce TK** provides an end-to-end preparation workflow using the :oe:func:`OESpruce::OEMakeDesignUnits` API.
Options (see :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` and associated options classes) are available to
control for the desired behavior. Metadata (see :ref:`OEStructureMetadata <OESpruce_OEStructureMetadata>`) can be supplied
to infuse experimental data, like the proper variant sequence, and also to fix common problems reading
from PDB files (e.g., bond order perception). **Spruce** has a built-in Chemical Components Dictionary matching residue codes to
SMILES, derived from the corresponding entry at the RCSB, but curated to fix improper molecule forms.
The workflow automatically runs through the following steps to produce :ref:`OEDesignUnit <OEBio_OEDesignUnit>` objects.

#. Biological unit extraction (see :oe:func:`OESpruce::OEExtractBioUnits`).

#. Generation of packing residues for visualization of crystal contacts (if the structure is from X-ray).

#. Assignment or enumeration of alternate locations (see the :oe:constns:`OESpruce::OEAlternateLocationOption` namespace).

#. Separation of the system into components, such as identifying ligands, cofactors, and excipients.

#. Construction of missing side chains, modeling loops, and capping chain breaks (see :oe:func:`OESpruce::OEBuildSidechains`,
   :oe:func:`OESpruce::OEBuildLoops`, and :oe:func:`OESpruce::OECapTermini`).

#. Hydrogen placement and optimization, including searching ligand tautomer states (see :oe:func:`OESpruce::OEProtonateDesignUnit`).

#. Assignment of partial charges to the entire system (see :ref:`OEDesignUnitCharges <OEProton_OEDesignUnitCharges>`).

#. Superposition to a common reference frame (see :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>`
   and :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>`).

#. Visualization and more of an encoded :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>`.

#. Estimation of the model quality using Iridium [Warren-2012]_, stored in
   :ref:`OEIridiumData <OEBio_OEIridiumData>`.

.. note::

   Multiple design units are often produced. This results from multiple biological units generated during step 1,
   and further expands that set when enumerating the alternate locations in step 3.
   The Iridium categorization (see :ref:`section_sprucetk_iridium_categorization`) should be helpful in choosing
   which (if not all) of the produced units to use in downstream modeling tasks. We find that the Iridium categories
   are also helpful for managing modeling expectations, having a quality measure of the input data for modeling.

.. note::

   Included with **Spruce TK** is a large database of loop templates generated by parsing the structures in the public
   PDB repository pulled from the RCSB. This database is available from `db-downloads <http://www.eyesopen.com/db-downloads>`_
   in a platform-independent format. The **SPRUCE** loop database is large (~13G) and will take time to download with a good internet connection.
   When the download is complete, move the file to a convenient location; a network drive is not recommended for performance.

   To use it during preparation (OEMakeDesignUnits), set the path in SetLoopDBFilename method on the :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>`
   class.

   The database can be appended to (or updated) using the **LoopDB_Builder** utility program that ships with the **SPRUCE** application.
   This would be in the event that the user has a collection of internal or proprietary structures, or if specific structures
   are released to the public PDB between OpenEye updates of the database that are crucial for a given target that is less
   well described by the existing templates.

.. _spruce_protonation_section:

**************************************
Proton Placement and Optimization
**************************************

Traditionally, most biomolecular structures have been generated with either no
explicit hydrogens or only polar hydrogens. However, having all atoms explicitly 
represented and positioned to make appropriate hydrogen bonds is sometimes necessary.
The function :oe:func:`OEBio::OEPlaceHydrogens` does this by adding and
placing hydrogens and by "flipping" certain functional groups
(e.g., side chain amides and imidazoles) as required for an optimal hydrogen bonding network.
**Spruce TK** leverages this functionality, but builds on top of this by taking the 
ligand protomer and tautomer states into account in the :oe:func:`OESpruce::OEProtonateDesignUnit`
function. The function identifies the heterogens (ligands, cofactors, etc.) in the structure and 
enumerates their states using the :oe:func:`OEProton::OEGetReasonableTautomers` function or
by using user supplied states.
The hydrogen bonding network of the biomolecule is then optimized in the presence of each state 
independently, and the most favorable state of the complex is chosen based on interaction energies.
If a binding site holds two heterogens, such as a ligand and a cofactor, and each have multiple tautomer
states, the combinatorial number of states are optimized and evaluated. To do this efficiently,
only the binding site(s) are initially optimized. After selecting the appropriate states of each of
the binding sites, the remaining parts of the system are optimized, keeping these states fixed.

.. _spruce_sidechain_section:

**************************************
Protein Side Chain Modeling
**************************************

Amino acid side chains are sometimes missing in protein structures due to low or
missing density from X-ray diffraction crystallography experiments. This can be due 
to high flexibility making the assignment of a specific location of the atoms difficult.
However, most molecule simulation software requires a position of these atoms, and the 
lack of them can cause incorrect results. Partial side chains are identified with :oe:func:`OESpruce::OEGetPartialResidues`.
Using :oe:func:`OESpruce::OEBuildSidechains`, these residues are then divided into groups based
on proximity and side chain orientation. The groups are independently optimized taking into account their local
environment. In each group, the side chains are built and a standard rotamer library from the
:oe:constns:`OEBio::OERotamerLibrary` namespace is used. For each side chain, the set of rotamers
is evaluated based on an interaction energy with the nearest environment and the most favorable state is
chosen. In the case where multiple residues are being built in a group, an iterative procedure attempts to 
find the optimal energy for the entire set of residues. In the event a side chain cannot be built because
poor input geometry causes clashes, the entire cluster is skipped. Water locations that block
side chain rotamers result in those water molecules being deleted (optionally) since their placement is most likely an artifact.

.. _spruce_loop_section:

**************************************
Protein Loop Modeling
**************************************

Similar to missing side chains above, there are sometimes gaps in protein structures, where the position
of the entire amino acid residues cannot be resolved based on the experimental data.
The function  :oe:func:`OESpruce::OEBuildLoops` is able to build missing gaps (loops). The workflow is illustrated
in the figure below. The function identifies missing loops by comparing the SEQRES section of the
PDB header with the structure using a sequence alignment. The user can optionally input their 
own sequence using :ref:`OESequenceMetadata <OESpruce_OESequenceMetadata>` if the SEQRES in the header is incorrect or missing.
With the gaps identified, the function loops for templates matching the gap, filters them based on the
ability to fit the gap without clashing, and eventually does an optimization of the top candidates 
in the local environment before picking the most favorable conformation.
If multiple results are desired, these can be retrieved using :oe:func:`OESpruce::OEBuildSingleLoop`.

.. _figure_OEBuildLoops_Workflow:

.. figure:: /_images/OEBuildLoopsWorkflow.png
   :width: 70%
   :align: center
   :alt: *OEBuildLoops* Workflow

   **Figure 1.** OEBuildLoops: Gaps are searched, filtered, inserted, and evaluated for the best fit.

The loop template database is built using all the structures in the PDB downloaded from the `RCSB <https://www.rcsb.org>`_ and
can be downloaded from `db-downloads <http://www.eyesopen.com/db-downloads>`_.

.. _figure_OEBuildLoops_Database:

.. figure:: /_images/LoopTemplateDatabase.png
   :width: 65%
   :align: center
   :alt: *OEBuildLoops* Database Construction

   **Figure 2.** Loop template database. Loops are extracted from the RCSB PDB, deduplicated, compressed, and indexed for easy retrieval.

.. _spruce_superposition_section:

**************************************
Protein Superposition
**************************************

A protein can be structurally superimposed onto a reference protein structure using
**Spruce TK**.
Proteins can be superimposed with either atomic coordinates in the
:ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>` class, or with secondary structure elements
using the :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class.

The :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>` class can superimpose proteins using any of the following four methods:

#. The global method (default for :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>`). This method uses all matching heavy
   atoms from the reference and fit proteins as the region for performing the superposition calculation
   (see :oe:const:`OESpruce::OESuperpositionType::Global`).
#. The **D**\ ifference **D**\ istance **M**\ atrix method. This method calculates the pairwise distance matrix
   of C-alpha atoms for both the reference and fit proteins, then takes the difference of these two matrices
   to find the difference distance matrix (DDM).
   
   For a given conformation a, the elements of the distance matrix :math:`D_{ij}^a` are the distances between atoms *i* and *j* in a molecule,

   .. math::

      D_{ij}^a = |r_i - r_j|

   where :math:`r_i` and :math:`r_j` are the Cartesian coordinate vectors of atoms *i* and *j*. The elements :math:`\Delta_{ij}^{ab}` of the difference-distance matrix for two conformations *a* and *b* are

   .. math::

      \Delta_{ij}^{ab} = D_{ij}^a - D_{ij}^b

   If :math:`\Delta_{ij}^{ab}` is positive, the interatomic vector between between *i* and *j* in conformation *b* is contracted
   with respect to *a*. Conversely, negative elements of the DDM indicate an expansion of the interatomic vector.
   The longest contiguous region of the resulting difference distance matrix (DDM) is used for the structural
   superposition calculation (see :oe:const:`OESpruce::OESuperpositionType::DDM`).
#. The weighted-DDM method. This method uses the DDM matrix and calculates Gaussian weighting factors for
   all matching C-alpha atoms. These Gaussian weights are used as a weighting function in the superposition
   calculation (see :oe:const:`OESpruce::OESuperpositionType::Weighted`).
#. The site residue method. This method uses a set of site residues (given as a set of unique residue strings)
   as a constraint on the protein superposition. Site residues must be set with the
   :oe:cls:`OESpruce::OESuperpositionOptions::SetSiteResidues` member function of the
   :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` class (see :oe:const:`OESpruce::OESuperpositionType::Site`).

The :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class can superimpose proteins using:

#. The secondary structure superposition method. This method takes two proteins and performs a structural superposition
   on them based on the shape overlap of the secondary structure elements of the two proteins.

.. note::

   All structural superposition methods in the :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>`
   class  have a corresponding score from the sequence alignment that was used to find the
   matching atoms of both proteins.
   This score comes from the output of the :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` class,
   where a larger score indicates a better sequence alignment, and scores below a small threshold
   (around 200) should be considered a bad alignment.

.. note::

   All structural superposition methods in the :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>`
   class have a corresponding RMSD value for superposition that can be loosely associated
   with the quality of the superposition. The :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>`
   class does not have an RMSD value, but instead uses the Tanimoto score from the
   underlying shape overlap calculation.

.. _spruce_read_pdb_section:

**********************************************************************
How to Correctly Read a Macromolecular File Format (mmCIF/PDB)
**********************************************************************

Reading a PDB file correctly for use in subsequent modeling tasks can be challenging.
To correctly read a PDB, one must be aware that PDB header information as well as
information about alternate location codes within the PDB file will be lost unless
a specific combination of PDB-centric :oe:const:`OEChem::OEIFlavor`s are used.
Furthermore, the protein itself must be processed by
:oe:cls:`OEAltLocationFactory<OEBio::OEAltLocationFactory>` in order to create a
molecule with all alternate location atoms retained. **Spruce** handles this for the user,
so they are not handled by this reader. However, for uses other than **Spruce**, the user
needs to either enumerate the different alternate locations or pick a specific location.
With that in mind, we recommend reading PDB files for use in **Spruce TK** using
the following pattern as shown in **ReadMacromolecule** below:

.. oe:source:: superpose.cpp
   :language: c++
   :frag:     SNIPPET-READPDB-CORRECTLY

.. oe:source:: superpose.py
   :language: python
   :frag:     SNIPPET-READPDB-CORRECTLY


###############################################
Appendix: Additional Examples in Python
###############################################

These are full listings of programming examples that are offered for download, elsewhere in this chapter.
For an guide to programming examples, :ref:`see the list elsewhere in this chapter <szmap_part_examples>`.

.. _listing-SzmapBestOrientations.py:

.. oe:source:: SzmapBestOrientations.py
   :language: python
   :refnum:   1
   :caption:  Generate Szmap points and probe orientations at ligand atoms.

.. _listing-SzmapCalcs.py:

.. oe:source:: SzmapCalcs.py
   :language: python
   :refnum:   2
   :caption:  Example of Szmap calculations.

.. _listing-SzmapEnergies.py:

.. oe:source:: SzmapEnergies.py
   :language: python
   :refnum:   3
   :caption:  Analyze binding site energies.


